annotate src/core/ngx_queue.h @ 9300:5be23505292b

SSI: fixed incorrect or duplicate stub output. Following 3518:eb3aaf8bd2a9 (0.8.37), r->request_output is only set if there are data in the first buffer sent in the subrequest. As a result, following the change mentioned this flag cannot be used to prevent duplicate ngx_http_ssi_stub_output() calls, since it is not set if there was already some output, but the first buffer was empty. Still, when there are multiple subrequests, even an empty subrequest response might be delayed by the postpone filter, leading to a second call of ngx_http_ssi_stub_output() during finalization from ngx_http_writer() the subreqest buffers are released by the postpone filter. Since r->request_output is not set after the first call, this resulted in duplicate stub output. Additionally, checking only the first buffer might be wrong in some unusual cases. For example, the first buffer might be empty if $r->flush() is called before printing any data in the embedded Perl module. Depending on the postpone_output value and corresponding sizes, this issue can result in either duplicate or unexpected stub output, or "zero size buf in writer" alerts. Following 8124:f5515e727656 (1.23.4), it became slightly easier to reproduce the issue, as empty static files and empty cache items now result in a response with an empty buffer. Before the change, an empty proxied response can be used to reproduce the issue. Fix is check all buffers and set r->request_output if any non-empty buffers are sent. This ensures that all unusual cases of non-empty responses are covered, and also that r->request_output will be set after the first stub output, preventing duplicate output. Reported by Jan Gassen.
author Maxim Dounin <mdounin@mdounin.ru>
date Thu, 04 Jul 2024 17:41:28 +0300
parents 3038bd4d7816
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1646
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
1
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
2 /*
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
3 * Copyright (C) Igor Sysoev
4412
d620f497c50f Copyright updated.
Maxim Konovalov <maxim@nginx.com>
parents: 2026
diff changeset
4 * Copyright (C) Nginx, Inc.
1646
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
5 */
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
6
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
7
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
8 #include <ngx_config.h>
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
9 #include <ngx_core.h>
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
10
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
11
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
12 #ifndef _NGX_QUEUE_H_INCLUDED_
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
13 #define _NGX_QUEUE_H_INCLUDED_
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
14
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
15
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
16 typedef struct ngx_queue_s ngx_queue_t;
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
17
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
18 struct ngx_queue_s {
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
19 ngx_queue_t *prev;
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
20 ngx_queue_t *next;
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
21 };
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
22
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
23
1684
d95dea42c33f ngx_queue_init()
Igor Sysoev <igor@sysoev.ru>
parents: 1646
diff changeset
24 #define ngx_queue_init(q) \
d95dea42c33f ngx_queue_init()
Igor Sysoev <igor@sysoev.ru>
parents: 1646
diff changeset
25 (q)->prev = q; \
1763
1043c21be8d2 style fix
Igor Sysoev <igor@sysoev.ru>
parents: 1684
diff changeset
26 (q)->next = q
1684
d95dea42c33f ngx_queue_init()
Igor Sysoev <igor@sysoev.ru>
parents: 1646
diff changeset
27
d95dea42c33f ngx_queue_init()
Igor Sysoev <igor@sysoev.ru>
parents: 1646
diff changeset
28
1646
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
29 #define ngx_queue_empty(h) \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
30 (h == (h)->prev)
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
31
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
32
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
33 #define ngx_queue_insert_head(h, x) \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
34 (x)->next = (h)->next; \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
35 (x)->next->prev = x; \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
36 (x)->prev = h; \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
37 (h)->next = x
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
38
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
39
2026
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
40 #define ngx_queue_insert_after ngx_queue_insert_head
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
41
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
42
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
43 #define ngx_queue_insert_tail(h, x) \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
44 (x)->prev = (h)->prev; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
45 (x)->prev->next = x; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
46 (x)->next = h; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
47 (h)->prev = x
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
48
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
49
9167
3038bd4d7816 Core: changed ngx_queue_sort() to use merge sort.
Maxim Dounin <mdounin@mdounin.ru>
parents: 4412
diff changeset
50 #define ngx_queue_insert_before ngx_queue_insert_tail
3038bd4d7816 Core: changed ngx_queue_sort() to use merge sort.
Maxim Dounin <mdounin@mdounin.ru>
parents: 4412
diff changeset
51
3038bd4d7816 Core: changed ngx_queue_sort() to use merge sort.
Maxim Dounin <mdounin@mdounin.ru>
parents: 4412
diff changeset
52
1646
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
53 #define ngx_queue_head(h) \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
54 (h)->next
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
55
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
56
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
57 #define ngx_queue_last(h) \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
58 (h)->prev
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
59
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
60
2026
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
61 #define ngx_queue_sentinel(h) \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
62 (h)
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
63
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
64
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
65 #define ngx_queue_next(q) \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
66 (q)->next
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
67
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
68
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
69 #define ngx_queue_prev(q) \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
70 (q)->prev
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
71
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
72
1646
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
73 #if (NGX_DEBUG)
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
74
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
75 #define ngx_queue_remove(x) \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
76 (x)->next->prev = (x)->prev; \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
77 (x)->prev->next = (x)->next; \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
78 (x)->prev = NULL; \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
79 (x)->next = NULL
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
80
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
81 #else
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
82
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
83 #define ngx_queue_remove(x) \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
84 (x)->next->prev = (x)->prev; \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
85 (x)->prev->next = (x)->next
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
86
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
87 #endif
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
88
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
89
2026
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
90 #define ngx_queue_split(h, q, n) \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
91 (n)->prev = (h)->prev; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
92 (n)->prev->next = n; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
93 (n)->next = q; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
94 (h)->prev = (q)->prev; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
95 (h)->prev->next = h; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
96 (q)->prev = n;
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
97
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
98
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
99 #define ngx_queue_add(h, n) \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
100 (h)->prev->next = (n)->next; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
101 (n)->next->prev = (h)->prev; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
102 (h)->prev = (n)->prev; \
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
103 (h)->prev->next = h;
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
104
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
105
1646
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
106 #define ngx_queue_data(q, type, link) \
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
107 (type *) ((u_char *) q - offsetof(type, link))
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
108
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
109
2026
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
110 ngx_queue_t *ngx_queue_middle(ngx_queue_t *queue);
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
111 void ngx_queue_sort(ngx_queue_t *queue,
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
112 ngx_int_t (*cmp)(const ngx_queue_t *, const ngx_queue_t *));
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
113
72db8932f782 new ngx_queue functions
Igor Sysoev <igor@sysoev.ru>
parents: 1763
diff changeset
114
1646
9638a809d3cd ngx_queue.h
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
115 #endif /* _NGX_QUEUE_H_INCLUDED_ */