1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Igor Sysoev
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#include <ngx_config.h>
9e18a033bSKonstantin Ananyev#include <ngx_core.h>
10e18a033bSKonstantin Ananyev#include <ngx_http.h>
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev
13e18a033bSKonstantin Ananyevstatic ngx_int_t ngx_http_write_filter_init(ngx_conf_t *cf);
14e18a033bSKonstantin Ananyev
15e18a033bSKonstantin Ananyev
16e18a033bSKonstantin Ananyevstatic ngx_http_module_t  ngx_http_write_filter_module_ctx = {
17e18a033bSKonstantin Ananyev    NULL,                                  /* preconfiguration */
18e18a033bSKonstantin Ananyev    ngx_http_write_filter_init,            /* postconfiguration */
19e18a033bSKonstantin Ananyev
20e18a033bSKonstantin Ananyev    NULL,                                  /* create main configuration */
21e18a033bSKonstantin Ananyev    NULL,                                  /* init main configuration */
22e18a033bSKonstantin Ananyev
23e18a033bSKonstantin Ananyev    NULL,                                  /* create server configuration */
24e18a033bSKonstantin Ananyev    NULL,                                  /* merge server configuration */
25e18a033bSKonstantin Ananyev
26e18a033bSKonstantin Ananyev    NULL,                                  /* create location configuration */
27e18a033bSKonstantin Ananyev    NULL,                                  /* merge location configuration */
28e18a033bSKonstantin Ananyev};
29e18a033bSKonstantin Ananyev
30e18a033bSKonstantin Ananyev
31e18a033bSKonstantin Ananyevngx_module_t  ngx_http_write_filter_module = {
32e18a033bSKonstantin Ananyev    NGX_MODULE_V1,
33e18a033bSKonstantin Ananyev    &ngx_http_write_filter_module_ctx,     /* module context */
34e18a033bSKonstantin Ananyev    NULL,                                  /* module directives */
35e18a033bSKonstantin Ananyev    NGX_HTTP_MODULE,                       /* module type */
36e18a033bSKonstantin Ananyev    NULL,                                  /* init master */
37e18a033bSKonstantin Ananyev    NULL,                                  /* init module */
38e18a033bSKonstantin Ananyev    NULL,                                  /* init process */
39e18a033bSKonstantin Ananyev    NULL,                                  /* init thread */
40e18a033bSKonstantin Ananyev    NULL,                                  /* exit thread */
41e18a033bSKonstantin Ananyev    NULL,                                  /* exit process */
42e18a033bSKonstantin Ananyev    NULL,                                  /* exit master */
43e18a033bSKonstantin Ananyev    NGX_MODULE_V1_PADDING
44e18a033bSKonstantin Ananyev};
45e18a033bSKonstantin Ananyev
46e18a033bSKonstantin Ananyev
47e18a033bSKonstantin Ananyevngx_int_t
48e18a033bSKonstantin Ananyevngx_http_write_filter(ngx_http_request_t *r, ngx_chain_t *in)
49e18a033bSKonstantin Ananyev{
50e18a033bSKonstantin Ananyev    off_t                      size, sent, nsent, limit;
51e18a033bSKonstantin Ananyev    ngx_uint_t                 last, flush, sync;
52e18a033bSKonstantin Ananyev    ngx_msec_t                 delay;
53e18a033bSKonstantin Ananyev    ngx_chain_t               *cl, *ln, **ll, *chain;
54e18a033bSKonstantin Ananyev    ngx_connection_t          *c;
55e18a033bSKonstantin Ananyev    ngx_http_core_loc_conf_t  *clcf;
56e18a033bSKonstantin Ananyev
57e18a033bSKonstantin Ananyev    c = r->connection;
58e18a033bSKonstantin Ananyev
59e18a033bSKonstantin Ananyev    if (c->error) {
60e18a033bSKonstantin Ananyev        return NGX_ERROR;
61e18a033bSKonstantin Ananyev    }
62e18a033bSKonstantin Ananyev
63e18a033bSKonstantin Ananyev    size = 0;
64e18a033bSKonstantin Ananyev    flush = 0;
65e18a033bSKonstantin Ananyev    sync = 0;
66e18a033bSKonstantin Ananyev    last = 0;
67e18a033bSKonstantin Ananyev    ll = &r->out;
68e18a033bSKonstantin Ananyev
69e18a033bSKonstantin Ananyev    /* find the size, the flush point and the last link of the saved chain */
70e18a033bSKonstantin Ananyev
71e18a033bSKonstantin Ananyev    for (cl = r->out; cl; cl = cl->next) {
72e18a033bSKonstantin Ananyev        ll = &cl->next;
73e18a033bSKonstantin Ananyev
74e18a033bSKonstantin Ananyev        ngx_log_debug7(NGX_LOG_DEBUG_EVENT, c->log, 0,
75e18a033bSKonstantin Ananyev                       "write old buf t:%d f:%d %p, pos %p, size: %z "
76e18a033bSKonstantin Ananyev                       "file: %O, size: %O",
77e18a033bSKonstantin Ananyev                       cl->buf->temporary, cl->buf->in_file,
78e18a033bSKonstantin Ananyev                       cl->buf->start, cl->buf->pos,
79e18a033bSKonstantin Ananyev                       cl->buf->last - cl->buf->pos,
80e18a033bSKonstantin Ananyev                       cl->buf->file_pos,
81e18a033bSKonstantin Ananyev                       cl->buf->file_last - cl->buf->file_pos);
82e18a033bSKonstantin Ananyev
83e18a033bSKonstantin Ananyev#if 1
84e18a033bSKonstantin Ananyev        if (ngx_buf_size(cl->buf) == 0 && !ngx_buf_special(cl->buf)) {
85e18a033bSKonstantin Ananyev            ngx_log_error(NGX_LOG_ALERT, c->log, 0,
86e18a033bSKonstantin Ananyev                          "zero size buf in writer "
87e18a033bSKonstantin Ananyev                          "t:%d r:%d f:%d %p %p-%p %p %O-%O",
88e18a033bSKonstantin Ananyev                          cl->buf->temporary,
89e18a033bSKonstantin Ananyev                          cl->buf->recycled,
90e18a033bSKonstantin Ananyev                          cl->buf->in_file,
91e18a033bSKonstantin Ananyev                          cl->buf->start,
92e18a033bSKonstantin Ananyev                          cl->buf->pos,
93e18a033bSKonstantin Ananyev                          cl->buf->last,
94e18a033bSKonstantin Ananyev                          cl->buf->file,
95e18a033bSKonstantin Ananyev                          cl->buf->file_pos,
96e18a033bSKonstantin Ananyev                          cl->buf->file_last);
97e18a033bSKonstantin Ananyev
98e18a033bSKonstantin Ananyev            ngx_debug_point();
99e18a033bSKonstantin Ananyev            return NGX_ERROR;
100e18a033bSKonstantin Ananyev        }
101e18a033bSKonstantin Ananyev#endif
102e18a033bSKonstantin Ananyev
103e18a033bSKonstantin Ananyev        size += ngx_buf_size(cl->buf);
104e18a033bSKonstantin Ananyev
105e18a033bSKonstantin Ananyev        if (cl->buf->flush || cl->buf->recycled) {
106e18a033bSKonstantin Ananyev            flush = 1;
107e18a033bSKonstantin Ananyev        }
108e18a033bSKonstantin Ananyev
109e18a033bSKonstantin Ananyev        if (cl->buf->sync) {
110e18a033bSKonstantin Ananyev            sync = 1;
111e18a033bSKonstantin Ananyev        }
112e18a033bSKonstantin Ananyev
113e18a033bSKonstantin Ananyev        if (cl->buf->last_buf) {
114e18a033bSKonstantin Ananyev            last = 1;
115e18a033bSKonstantin Ananyev        }
116e18a033bSKonstantin Ananyev    }
117e18a033bSKonstantin Ananyev
118e18a033bSKonstantin Ananyev    /* add the new chain to the existent one */
119e18a033bSKonstantin Ananyev
120e18a033bSKonstantin Ananyev    for (ln = in; ln; ln = ln->next) {
121e18a033bSKonstantin Ananyev        cl = ngx_alloc_chain_link(r->pool);
122e18a033bSKonstantin Ananyev        if (cl == NULL) {
123e18a033bSKonstantin Ananyev            return NGX_ERROR;
124e18a033bSKonstantin Ananyev        }
125e18a033bSKonstantin Ananyev
126e18a033bSKonstantin Ananyev        cl->buf = ln->buf;
127e18a033bSKonstantin Ananyev        *ll = cl;
128e18a033bSKonstantin Ananyev        ll = &cl->next;
129e18a033bSKonstantin Ananyev
130e18a033bSKonstantin Ananyev        ngx_log_debug7(NGX_LOG_DEBUG_EVENT, c->log, 0,
131e18a033bSKonstantin Ananyev                       "write new buf t:%d f:%d %p, pos %p, size: %z "
132e18a033bSKonstantin Ananyev                       "file: %O, size: %O",
133e18a033bSKonstantin Ananyev                       cl->buf->temporary, cl->buf->in_file,
134e18a033bSKonstantin Ananyev                       cl->buf->start, cl->buf->pos,
135e18a033bSKonstantin Ananyev                       cl->buf->last - cl->buf->pos,
136e18a033bSKonstantin Ananyev                       cl->buf->file_pos,
137e18a033bSKonstantin Ananyev                       cl->buf->file_last - cl->buf->file_pos);
138e18a033bSKonstantin Ananyev
139e18a033bSKonstantin Ananyev#if 1
140e18a033bSKonstantin Ananyev        if (ngx_buf_size(cl->buf) == 0 && !ngx_buf_special(cl->buf)) {
141e18a033bSKonstantin Ananyev            ngx_log_error(NGX_LOG_ALERT, c->log, 0,
142e18a033bSKonstantin Ananyev                          "zero size buf in writer "
143e18a033bSKonstantin Ananyev                          "t:%d r:%d f:%d %p %p-%p %p %O-%O",
144e18a033bSKonstantin Ananyev                          cl->buf->temporary,
145e18a033bSKonstantin Ananyev                          cl->buf->recycled,
146e18a033bSKonstantin Ananyev                          cl->buf->in_file,
147e18a033bSKonstantin Ananyev                          cl->buf->start,
148e18a033bSKonstantin Ananyev                          cl->buf->pos,
149e18a033bSKonstantin Ananyev                          cl->buf->last,
150e18a033bSKonstantin Ananyev                          cl->buf->file,
151e18a033bSKonstantin Ananyev                          cl->buf->file_pos,
152e18a033bSKonstantin Ananyev                          cl->buf->file_last);
153e18a033bSKonstantin Ananyev
154e18a033bSKonstantin Ananyev            ngx_debug_point();
155e18a033bSKonstantin Ananyev            return NGX_ERROR;
156e18a033bSKonstantin Ananyev        }
157e18a033bSKonstantin Ananyev#endif
158e18a033bSKonstantin Ananyev
159e18a033bSKonstantin Ananyev        size += ngx_buf_size(cl->buf);
160e18a033bSKonstantin Ananyev
161e18a033bSKonstantin Ananyev        if (cl->buf->flush || cl->buf->recycled) {
162e18a033bSKonstantin Ananyev            flush = 1;
163e18a033bSKonstantin Ananyev        }
164e18a033bSKonstantin Ananyev
165e18a033bSKonstantin Ananyev        if (cl->buf->sync) {
166e18a033bSKonstantin Ananyev            sync = 1;
167e18a033bSKonstantin Ananyev        }
168e18a033bSKonstantin Ananyev
169e18a033bSKonstantin Ananyev        if (cl->buf->last_buf) {
170e18a033bSKonstantin Ananyev            last = 1;
171e18a033bSKonstantin Ananyev        }
172e18a033bSKonstantin Ananyev    }
173e18a033bSKonstantin Ananyev
174e18a033bSKonstantin Ananyev    *ll = NULL;
175e18a033bSKonstantin Ananyev
176e18a033bSKonstantin Ananyev    ngx_log_debug3(NGX_LOG_DEBUG_HTTP, c->log, 0,
177e18a033bSKonstantin Ananyev                   "http write filter: l:%ui f:%ui s:%O", last, flush, size);
178e18a033bSKonstantin Ananyev
179e18a033bSKonstantin Ananyev    clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
180e18a033bSKonstantin Ananyev
181e18a033bSKonstantin Ananyev    /*
182e18a033bSKonstantin Ananyev     * avoid the output if there are no last buf, no flush point,
183e18a033bSKonstantin Ananyev     * there are the incoming bufs and the size of all bufs
184e18a033bSKonstantin Ananyev     * is smaller than "postpone_output" directive
185e18a033bSKonstantin Ananyev     */
186e18a033bSKonstantin Ananyev
187e18a033bSKonstantin Ananyev    if (!last && !flush && in && size < (off_t) clcf->postpone_output) {
188e18a033bSKonstantin Ananyev        return NGX_OK;
189e18a033bSKonstantin Ananyev    }
190e18a033bSKonstantin Ananyev
191e18a033bSKonstantin Ananyev    if (c->write->delayed) {
192e18a033bSKonstantin Ananyev        c->buffered |= NGX_HTTP_WRITE_BUFFERED;
193e18a033bSKonstantin Ananyev        return NGX_AGAIN;
194e18a033bSKonstantin Ananyev    }
195e18a033bSKonstantin Ananyev
196e18a033bSKonstantin Ananyev    if (size == 0
197e18a033bSKonstantin Ananyev        && !(c->buffered & NGX_LOWLEVEL_BUFFERED)
198e18a033bSKonstantin Ananyev        && !(last && c->need_last_buf))
199e18a033bSKonstantin Ananyev    {
200e18a033bSKonstantin Ananyev        if (last || flush || sync) {
201e18a033bSKonstantin Ananyev            for (cl = r->out; cl; /* void */) {
202e18a033bSKonstantin Ananyev                ln = cl;
203e18a033bSKonstantin Ananyev                cl = cl->next;
204e18a033bSKonstantin Ananyev                ngx_free_chain(r->pool, ln);
205e18a033bSKonstantin Ananyev            }
206e18a033bSKonstantin Ananyev
207e18a033bSKonstantin Ananyev            r->out = NULL;
208e18a033bSKonstantin Ananyev            c->buffered &= ~NGX_HTTP_WRITE_BUFFERED;
209e18a033bSKonstantin Ananyev
210e18a033bSKonstantin Ananyev            return NGX_OK;
211e18a033bSKonstantin Ananyev        }
212e18a033bSKonstantin Ananyev
213e18a033bSKonstantin Ananyev        ngx_log_error(NGX_LOG_ALERT, c->log, 0,
214e18a033bSKonstantin Ananyev                      "the http output chain is empty");
215e18a033bSKonstantin Ananyev
216e18a033bSKonstantin Ananyev        ngx_debug_point();
217e18a033bSKonstantin Ananyev
218e18a033bSKonstantin Ananyev        return NGX_ERROR;
219e18a033bSKonstantin Ananyev    }
220e18a033bSKonstantin Ananyev
221e18a033bSKonstantin Ananyev    if (r->limit_rate) {
222e18a033bSKonstantin Ananyev        if (r->limit_rate_after == 0) {
223e18a033bSKonstantin Ananyev            r->limit_rate_after = clcf->limit_rate_after;
224e18a033bSKonstantin Ananyev        }
225e18a033bSKonstantin Ananyev
226e18a033bSKonstantin Ananyev        limit = (off_t) r->limit_rate * (ngx_time() - r->start_sec + 1)
227e18a033bSKonstantin Ananyev                - (c->sent - r->limit_rate_after);
228e18a033bSKonstantin Ananyev
229e18a033bSKonstantin Ananyev        if (limit <= 0) {
230e18a033bSKonstantin Ananyev            c->write->delayed = 1;
231e18a033bSKonstantin Ananyev            delay = (ngx_msec_t) (- limit * 1000 / r->limit_rate + 1);
232e18a033bSKonstantin Ananyev            ngx_add_timer(c->write, delay);
233e18a033bSKonstantin Ananyev
234e18a033bSKonstantin Ananyev            c->buffered |= NGX_HTTP_WRITE_BUFFERED;
235e18a033bSKonstantin Ananyev
236e18a033bSKonstantin Ananyev            return NGX_AGAIN;
237e18a033bSKonstantin Ananyev        }
238e18a033bSKonstantin Ananyev
239e18a033bSKonstantin Ananyev        if (clcf->sendfile_max_chunk
240e18a033bSKonstantin Ananyev            && (off_t) clcf->sendfile_max_chunk < limit)
241e18a033bSKonstantin Ananyev        {
242e18a033bSKonstantin Ananyev            limit = clcf->sendfile_max_chunk;
243e18a033bSKonstantin Ananyev        }
244e18a033bSKonstantin Ananyev
245e18a033bSKonstantin Ananyev    } else {
246e18a033bSKonstantin Ananyev        limit = clcf->sendfile_max_chunk;
247e18a033bSKonstantin Ananyev    }
248e18a033bSKonstantin Ananyev
249e18a033bSKonstantin Ananyev    sent = c->sent;
250e18a033bSKonstantin Ananyev
251e18a033bSKonstantin Ananyev    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, c->log, 0,
252e18a033bSKonstantin Ananyev                   "http write filter limit %O", limit);
253e18a033bSKonstantin Ananyev
254e18a033bSKonstantin Ananyev    chain = c->send_chain(c, r->out, limit);
255e18a033bSKonstantin Ananyev
256e18a033bSKonstantin Ananyev    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, c->log, 0,
257e18a033bSKonstantin Ananyev                   "http write filter %p", chain);
258e18a033bSKonstantin Ananyev
259e18a033bSKonstantin Ananyev    if (chain == NGX_CHAIN_ERROR) {
260e18a033bSKonstantin Ananyev        c->error = 1;
261e18a033bSKonstantin Ananyev        return NGX_ERROR;
262e18a033bSKonstantin Ananyev    }
263e18a033bSKonstantin Ananyev
264e18a033bSKonstantin Ananyev    if (r->limit_rate) {
265e18a033bSKonstantin Ananyev
266e18a033bSKonstantin Ananyev        nsent = c->sent;
267e18a033bSKonstantin Ananyev
268e18a033bSKonstantin Ananyev        if (r->limit_rate_after) {
269e18a033bSKonstantin Ananyev
270e18a033bSKonstantin Ananyev            sent -= r->limit_rate_after;
271e18a033bSKonstantin Ananyev            if (sent < 0) {
272e18a033bSKonstantin Ananyev                sent = 0;
273e18a033bSKonstantin Ananyev            }
274e18a033bSKonstantin Ananyev
275e18a033bSKonstantin Ananyev            nsent -= r->limit_rate_after;
276e18a033bSKonstantin Ananyev            if (nsent < 0) {
277e18a033bSKonstantin Ananyev                nsent = 0;
278e18a033bSKonstantin Ananyev            }
279e18a033bSKonstantin Ananyev        }
280e18a033bSKonstantin Ananyev
281e18a033bSKonstantin Ananyev        delay = (ngx_msec_t) ((nsent - sent) * 1000 / r->limit_rate);
282e18a033bSKonstantin Ananyev
283e18a033bSKonstantin Ananyev        if (delay > 0) {
284e18a033bSKonstantin Ananyev            limit = 0;
285e18a033bSKonstantin Ananyev            c->write->delayed = 1;
286e18a033bSKonstantin Ananyev            ngx_add_timer(c->write, delay);
287e18a033bSKonstantin Ananyev        }
288e18a033bSKonstantin Ananyev    }
289e18a033bSKonstantin Ananyev
290e18a033bSKonstantin Ananyev    if (limit
291e18a033bSKonstantin Ananyev        && c->write->ready
292e18a033bSKonstantin Ananyev        && c->sent - sent >= limit - (off_t) (2 * ngx_pagesize))
293e18a033bSKonstantin Ananyev    {
294e18a033bSKonstantin Ananyev        c->write->delayed = 1;
295e18a033bSKonstantin Ananyev        ngx_add_timer(c->write, 1);
296e18a033bSKonstantin Ananyev    }
297e18a033bSKonstantin Ananyev
298e18a033bSKonstantin Ananyev    for (cl = r->out; cl && cl != chain; /* void */) {
299e18a033bSKonstantin Ananyev        ln = cl;
300e18a033bSKonstantin Ananyev        cl = cl->next;
301e18a033bSKonstantin Ananyev        ngx_free_chain(r->pool, ln);
302e18a033bSKonstantin Ananyev    }
303e18a033bSKonstantin Ananyev
304e18a033bSKonstantin Ananyev    r->out = chain;
305e18a033bSKonstantin Ananyev
306e18a033bSKonstantin Ananyev    if (chain) {
307e18a033bSKonstantin Ananyev        c->buffered |= NGX_HTTP_WRITE_BUFFERED;
308e18a033bSKonstantin Ananyev        return NGX_AGAIN;
309e18a033bSKonstantin Ananyev    }
310e18a033bSKonstantin Ananyev
311e18a033bSKonstantin Ananyev    c->buffered &= ~NGX_HTTP_WRITE_BUFFERED;
312e18a033bSKonstantin Ananyev
313e18a033bSKonstantin Ananyev    if ((c->buffered & NGX_LOWLEVEL_BUFFERED) && r->postponed == NULL) {
314e18a033bSKonstantin Ananyev        return NGX_AGAIN;
315e18a033bSKonstantin Ananyev    }
316e18a033bSKonstantin Ananyev
317e18a033bSKonstantin Ananyev    return NGX_OK;
318e18a033bSKonstantin Ananyev}
319e18a033bSKonstantin Ananyev
320e18a033bSKonstantin Ananyev
321e18a033bSKonstantin Ananyevstatic ngx_int_t
322e18a033bSKonstantin Ananyevngx_http_write_filter_init(ngx_conf_t *cf)
323e18a033bSKonstantin Ananyev{
324e18a033bSKonstantin Ananyev    ngx_http_top_body_filter = ngx_http_write_filter;
325e18a033bSKonstantin Ananyev
326e18a033bSKonstantin Ananyev    return NGX_OK;
327e18a033bSKonstantin Ananyev}
328