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