xref: /lighttpd1.4/src/reqpool.c (revision b598bb53)
1 /*
2  * reqpool - request objects
3  *
4  * Copyright(c) 2020 Glenn Strauss gstrauss()gluelogic.com  All rights reserved
5  * License: BSD 3-clause (same as lighttpd)
6  */
7 #include "first.h"
8 #include "reqpool.h"
9 
10 #include <stdlib.h>
11 
12 #include "base.h"
13 #include "buffer.h"
14 #include "chunk.h"
15 #include "plugin.h"
16 #include "plugin_config.h"
17 #include "request.h"
18 #include "response.h"
19 
20 
21 void
22 request_init_data (request_st * const r, connection * const con, server * const srv)
23 {
24     chunkqueue_init(&r->write_queue);
25     chunkqueue_init(&r->read_queue);
26     chunkqueue_init(&r->reqbody_queue);
27 
28     r->http_method = HTTP_METHOD_UNSET;
29     r->http_version = HTTP_VERSION_UNSET;
30     r->resp_header_len = 0;
31     r->loops_per_request = 0;
32     r->con = con;
33     r->tmp_buf = srv->tmp_buf;
34     r->resp_body_scratchpad = -1;
35 
36     /* init plugin-specific per-request structures */
37     r->plugin_ctx = calloc(1, (srv->plugins.used + 1) * sizeof(void *));
38     force_assert(NULL != r->plugin_ctx);
39 
40     r->cond_cache = calloc(srv->config_context->used, sizeof(cond_cache_t));
41     force_assert(NULL != r->cond_cache);
42 
43   #ifdef HAVE_PCRE_H
44     if (srv->config_context->used > 1) {/*(save 128b per con if no conditions)*/
45         r->cond_match =
46           calloc(srv->config_context->used, sizeof(cond_match_t));
47         force_assert(NULL != r->cond_match);
48     }
49   #endif
50 }
51 
52 
53 void
54 request_reset (request_st * const r)
55 {
56     plugins_call_handle_request_reset(r);
57 
58     http_response_reset(r);
59 
60     r->loops_per_request = 0;
61 
62     r->h2state = 0; /* H2_STATE_IDLE */
63     r->h2id = 0;
64     r->http_method = HTTP_METHOD_UNSET;
65     r->http_version = HTTP_VERSION_UNSET;
66 
67     /*con->proto_default_port = 80;*//*set to default in connection_accepted()*/
68 
69     r->http_host = NULL;
70     r->reqbody_length = 0;
71     r->te_chunked = 0;
72     r->resp_body_scratchpad = -1;
73     r->rqst_htags = 0;
74 
75     r->async_callback = 0;
76     r->error_handler_saved_status = 0;
77     /*r->error_handler_saved_method = HTTP_METHOD_UNSET;*/
78     /*(error_handler_saved_method value is not valid
79      * unless error_handler_saved_status is set)*/
80 
81     buffer_clear(&r->uri.scheme);
82 
83     if (r->rqst_header_len <= BUFFER_MAX_REUSE_SIZE) {
84         r->rqst_headers.used = 0;
85         /* (Note: total header size not recalculated on HANDLER_COMEBACK
86          *  even if other request headers changed during processing)
87          * (While this might delay release of larger buffers, it is not
88          *  expected to be the general case.  For those systems where it
89          *  is a typical case, the larger buffers are likely to be reused) */
90         buffer_clear(&r->target);
91         buffer_clear(&r->pathinfo);
92         /*buffer_clear(&r->target_orig);*/  /* reset later; used by mod_status*/
93         /*buffer_clear(&r->uri.path);*/     /* reset later; used by mod_status*/
94         /*buffer_clear(&r->uri.query);*/    /* reset later; used by mod_status*/
95         /*buffer_clear(&r->uri.authority);*//* reset later; used by mod_status*/
96         /*buffer_clear(&r->server_name_buf);*//* reset when used */
97     }
98     else {
99         buffer_reset(&r->target);
100         buffer_reset(&r->pathinfo);
101         /*buffer_reset(&r->target_orig);*/  /* reset later; used by mod_status*/
102         /*buffer_reset(&r->uri.path);*/     /* reset later; used by mod_status*/
103         /*buffer_reset(&r->uri.query);*/    /* reset later; used by mod_status*/
104         /*buffer_clear(&r->uri.authority);*//* reset later; used by mod_status*/
105         /*buffer_clear(&r->server_name_buf);*//* reset when used */
106         array_reset_data_strings(&r->rqst_headers);
107     }
108     r->rqst_header_len = 0;
109     if (0 != r->env.used)
110         array_reset_data_strings(&r->env);
111 
112     chunkqueue_reset(&r->reqbody_queue);
113     /* r->read_queue, r->write_queue are shared with con for HTTP/1.1
114      * but are different than con->read_queue, con->write_queue for HTTP/2
115      * For HTTP/1.1, when &r->read_queue == con->read_queue, r->read_queue
116      * is not cleared between requests since it might contain subsequent
117      * requests.  (see also request_release()) */
118 
119     /* The cond_cache gets reset in response.c */
120     /* config_cond_cache_reset(r); */
121 }
122 
123 
124 #if 0 /* DEBUG_DEV */
125 __attribute_cold__
126 static void request_plugin_ctx_check(request_st * const r, server * const srv) {
127     /* plugins should have cleaned themselves up */
128     for (uint32_t i = 0, used = srv->plugins.used; i < used; ++i) {
129         plugin *p = ((plugin **)(srv->plugins.ptr))[i];
130         plugin_data_base *pd = p->data;
131         if (!pd) continue;
132         if (NULL == r->plugin_ctx[pd->id]
133             && NULL == r->con->plugin_ctx[pd->id]) continue;
134         log_error(r->conf.errh, __FILE__, __LINE__,
135           "missing cleanup in %s", p->name);
136         r->plugin_ctx[pd->id] = NULL;
137         r->con->plugin_ctx[pd->id] = NULL;
138     }
139 }
140 #endif
141 
142 
143 void
144 request_reset_ex (request_st * const r)
145 {
146   #if 0 /* DEBUG_DEV */
147     /* plugins should have cleaned themselves up (id range: [1,used]) */
148     connection * const con = r->con;
149     server * const srv = con->srv;
150     for (uint32_t i = 1; i <= srv->plugins.used; ++i) {
151         if (NULL != r->plugin_ctx[i] || NULL != con->plugin_ctx[i]) {
152             request_plugin_ctx_check(r, srv);
153             break;
154         }
155     }
156   #endif
157 
158     buffer_clear(&r->uri.authority);
159     buffer_reset(&r->uri.path);
160     buffer_reset(&r->uri.query);
161     buffer_reset(&r->target_orig);
162     buffer_reset(&r->target);       /*(see comments in request_reset())*/
163     buffer_reset(&r->pathinfo);     /*(see comments in request_reset())*/
164 
165     /* preserve; callers must handle changes */
166     /*r->state = CON_STATE_CONNECT;*/
167 }
168 
169 
170 void
171 request_free_data (request_st * const r)
172 {
173     chunkqueue_reset(&r->reqbody_queue);
174     chunkqueue_reset(&r->write_queue);
175     chunkqueue_reset(&r->read_queue);
176     array_free_data(&r->rqst_headers);
177     array_free_data(&r->resp_headers);
178     array_free_data(&r->env);
179 
180     free(r->target.ptr);
181     free(r->target_orig.ptr);
182 
183     free(r->uri.scheme.ptr);
184     free(r->uri.authority.ptr);
185     free(r->uri.path.ptr);
186     free(r->uri.query.ptr);
187 
188     free(r->physical.doc_root.ptr);
189     free(r->physical.path.ptr);
190     free(r->physical.basedir.ptr);
191     free(r->physical.etag.ptr);
192     free(r->physical.rel_path.ptr);
193 
194     free(r->pathinfo.ptr);
195     free(r->server_name_buf.ptr);
196 
197     free(r->plugin_ctx);
198     free(r->cond_cache);
199     free(r->cond_match);
200 
201     /* note: r is not zeroed here and r is not freed here */
202 }
203 
204 
205 /* linked list of (request_st *) cached for reuse */
206 static request_st *reqpool;
207 /* max num of (request_st *) to cache */
208 static uint32_t reqspace;
209 
210 
211 void
212 request_pool_init (uint32_t sz)
213 {
214     reqspace = sz;
215 }
216 
217 
218 void
219 request_pool_free (void)
220 {
221     while (reqpool) {
222         request_st * const r = reqpool;
223         reqpool = (request_st *)r->con; /*(reuse r->con as next ptr)*/
224         request_free_data(r);
225         free(r);
226         ++reqspace;
227     }
228 }
229 
230 
231 void
232 request_release (request_st * const r)
233 {
234     /* (For HTTP/1.1, r == &con->request, and so request_release() not called)
235      * r->read_queue, r->write_queue are shared with con for HTTP/1.1
236      * but are different than con->read_queue, con->write_queue for HTTP/2
237      * For HTTP/1.1, when &r->read_queue == con->read_queue, r->read_queue
238      * is not cleared between requests since it might contain subsequent
239      * requests.  (see also request_reset()) */
240     chunkqueue_reset(&r->read_queue);
241 
242     /*(r->cond_cache and r->cond_match are re-init in h2_init_stream())*/
243 
244     request_reset(r);
245     request_reset_ex(r);
246     r->state = CON_STATE_CONNECT;
247 
248     if (reqspace) {
249         --reqspace;
250         r->con = (connection *)reqpool; /*(reuse r->con as next ptr)*/
251         reqpool = r;
252     }
253     else {
254         request_free_data(r);
255         free(r);
256     }
257 }
258 
259 
260 request_st *
261 request_acquire (connection * const con)
262 {
263     request_st *r = reqpool;
264     if (r) {
265         reqpool = (request_st *)r->con; /*(reuse r->con as next ptr)*/
266         ++reqspace;
267     }
268     else {
269         r = calloc(1, sizeof(request_st));
270         force_assert(r);
271         request_init_data(r, con, con->srv);
272     }
273 
274     r->con = con;
275     r->tmp_buf = con->srv->tmp_buf;
276     return r;
277 }
278