annotate src/http/ngx_http_cache.h @ 502:89dc5654117c NGINX_0_7_63

nginx 0.7.63 *) Security: now "/../" are disabled in "Destination" request header line. *) Change: minimum supported OpenSSL version is 0.9.7. *) Change: the "ask" parameter of the "ssl_verify_client" directive was changed to the "optional" parameter and now it checks a client certificate if it was offered. Thanks to Brice Figureau. *) Feature: now the "-V" switch shows TLS SNI support. *) Feature: the $ssl_client_verify variable. Thanks to Brice Figureau. *) Feature: the "ssl_crl" directive. Thanks to Brice Figureau. *) Bugfix: the $ssl_client_cert variable usage corrupted memory; the bug had appeared in 0.7.7. Thanks to Sergey Zhuravlev. *) Feature: now the start cache loader runs in a separate process; this should improve large caches handling. *) Feature: now temporary files and permanent storage area may reside at different file systems. *) Bugfix: nginx counted incorrectly disk cache size. *) Change: now directive "gzip_disable msie6" does not disable gzipping for MSIE 6.0 SV1. *) Bugfix: nginx always added "Vary: Accept-Encoding" response header line, if both "gzip_static" and "gzip_vary" were on. *) Feature: the "proxy" parameter of the "geo" directive. *) Feature: the ngx_http_geoip_module. *) Feature: the "limit_rate_after" directive. Thanks to Ivan Debnar. *) Feature: the "limit_req_log_level" and "limit_conn_log_level" directives. *) Bugfix: now "limit_req" directive conforms to the leaky bucket algorithm. Thanks to Maxim Dounin. *) Bugfix: in ngx_http_limit_req_module. Thanks to Maxim Dounin. *) Bugfix: now nginx allows underscores in a request method. *) Bugfix: "proxy_pass_header" and "fastcgi_pass_header" directives did not pass to a client the "X-Accel-Redirect", "X-Accel-Limit-Rate", "X-Accel-Buffering", and "X-Accel-Charset" lines from backend response header. Thanks to Maxim Dounin. *) Bugfix: in handling "Last-Modified" and "Accept-Ranges" backend response header lines; the bug had appeared in 0.7.44. Thanks to Maxim Dounin. *) Feature: the "image_filter_transparency" directive. *) Feature: the "image_filter" directive supports variables for setting size. *) Bugfix: in PNG alpha-channel support in the ngx_http_image_filter_module. *) Bugfix: in transparency support in the ngx_http_image_filter_module. *) Feature: now several "perl_modules" directives may be used. *) Bugfix: ngx_http_perl_module responses did not work in subrequests. *) Bugfix: nginx sent '\0' in a "Location" response header line on MKCOL request. Thanks to Xie Zhenye. *) Bugfix: an "error_page" directive did not redirect a 413 error; the bug had appeared in 0.6.10. *) Bugfix: in memory allocation error handling. Thanks to Maxim Dounin and Kirill A. Korinskiy.
author Igor Sysoev <http://sysoev.ru>
date Mon, 26 Oct 2009 00:00:00 +0300
parents ed3d382670c7
children 68c0ae0a4959
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
1
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
2 /*
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
3 * Copyright (C) Igor Sysoev
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
4 */
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
5
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
6
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
7 #ifndef _NGX_HTTP_CACHE_H_INCLUDED_
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
8 #define _NGX_HTTP_CACHE_H_INCLUDED_
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
9
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
10
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
11 #include <ngx_config.h>
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
12 #include <ngx_core.h>
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
13 #include <ngx_http.h>
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
14
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
15
500
ed3d382670c7 nginx 0.7.62
Igor Sysoev <http://sysoev.ru>
parents: 496
diff changeset
16 #define NGX_HTTP_CACHE_MISS 1
ed3d382670c7 nginx 0.7.62
Igor Sysoev <http://sysoev.ru>
parents: 496
diff changeset
17 #define NGX_HTTP_CACHE_EXPIRED 2
ed3d382670c7 nginx 0.7.62
Igor Sysoev <http://sysoev.ru>
parents: 496
diff changeset
18 #define NGX_HTTP_CACHE_STALE 3
ed3d382670c7 nginx 0.7.62
Igor Sysoev <http://sysoev.ru>
parents: 496
diff changeset
19 #define NGX_HTTP_CACHE_UPDATING 4
ed3d382670c7 nginx 0.7.62
Igor Sysoev <http://sysoev.ru>
parents: 496
diff changeset
20 #define NGX_HTTP_CACHE_HIT 5
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
21
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
22 #define NGX_HTTP_CACHE_KEY_LEN 16
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
23
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
24
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
25 typedef struct {
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
26 ngx_uint_t status;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
27 time_t valid;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
28 } ngx_http_cache_valid_t;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
29
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
30
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
31 typedef struct {
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
32 ngx_rbtree_node_t node;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
33 ngx_queue_t queue;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
34
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
35 u_char key[NGX_HTTP_CACHE_KEY_LEN
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
36 - sizeof(ngx_rbtree_key_t)];
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
37
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
38 unsigned count:20;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
39 unsigned uses:10;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
40 unsigned valid_msec:10;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
41 unsigned error:10;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
42 unsigned exists:1;
496
116d5de7cbb6 nginx 0.7.60
Igor Sysoev <http://sysoev.ru>
parents: 480
diff changeset
43 unsigned updating:1;
116d5de7cbb6 nginx 0.7.60
Igor Sysoev <http://sysoev.ru>
parents: 480
diff changeset
44 /* 12 unused bits */
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
45
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
46 ngx_file_uniq_t uniq;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
47 time_t expire;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
48 time_t valid_sec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
49 size_t body_start;
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
50 off_t length;
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
51 } ngx_http_file_cache_node_t;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
52
18
6f8b0dc0f8dd nginx 0.1.9
Igor Sysoev <http://sysoev.ru>
parents: 0
diff changeset
53
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
54 struct ngx_http_cache_s {
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
55 ngx_file_t file;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
56 ngx_array_t keys;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
57 uint32_t crc32;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
58 u_char key[NGX_HTTP_CACHE_KEY_LEN];
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
59
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
60 ngx_file_uniq_t uniq;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
61 time_t valid_sec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
62 time_t last_modified;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
63 time_t date;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
64
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
65 size_t header_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
66 size_t body_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
67 off_t length;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
68
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
69 ngx_uint_t min_uses;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
70 ngx_uint_t error;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
71 ngx_uint_t valid_msec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
72
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
73 ngx_buf_t *buf;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
74
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
75 ngx_http_file_cache_t *file_cache;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
76 ngx_http_file_cache_node_t *node;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
77
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
78 unsigned updated:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
79 unsigned exists:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
80 unsigned temp_file:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
81 };
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
82
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
83
22
8b6db3bda591 nginx 0.1.11
Igor Sysoev <http://sysoev.ru>
parents: 18
diff changeset
84 typedef struct {
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
85 time_t valid_sec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
86 time_t last_modified;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
87 time_t date;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
88 uint32_t crc32;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
89 u_short valid_msec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
90 u_short header_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
91 u_short body_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
92 } ngx_http_file_cache_header_t;
26
45fe5b98a9de nginx 0.1.13
Igor Sysoev <http://sysoev.ru>
parents: 22
diff changeset
93
45fe5b98a9de nginx 0.1.13
Igor Sysoev <http://sysoev.ru>
parents: 22
diff changeset
94
480
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
95 typedef struct {
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
96 ngx_rbtree_t rbtree;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
97 ngx_rbtree_node_t sentinel;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
98 ngx_queue_t queue;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
99 ngx_atomic_t cold;
502
89dc5654117c nginx 0.7.63
Igor Sysoev <http://sysoev.ru>
parents: 500
diff changeset
100 ngx_atomic_t loading;
480
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
101 off_t size;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
102 } ngx_http_file_cache_sh_t;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
103
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
104
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
105 struct ngx_http_file_cache_s {
480
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
106 ngx_http_file_cache_sh_t *sh;
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
107 ngx_slab_pool_t *shpool;
18
6f8b0dc0f8dd nginx 0.1.9
Igor Sysoev <http://sysoev.ru>
parents: 0
diff changeset
108
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
109 ngx_path_t *path;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
110
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
111 off_t max_size;
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
112 size_t bsize;
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
113
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
114 time_t inactive;
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
115
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
116 ngx_msec_t last;
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
117 ngx_uint_t files;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
118
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
119 ngx_shm_zone_t *shm_zone;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
120 };
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
121
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
122
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
123 void ngx_http_file_cache_create_key(ngx_http_request_t *r);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
124 ngx_int_t ngx_http_file_cache_open(ngx_http_request_t *r);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
125 void ngx_http_file_cache_set_header(ngx_http_request_t *r, u_char *buf);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
126 void ngx_http_file_cache_update(ngx_http_request_t *r, ngx_temp_file_t *tf);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
127 ngx_int_t ngx_http_cache_send(ngx_http_request_t *);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
128 void ngx_http_file_cache_free(ngx_http_request_t *r, ngx_temp_file_t *tf);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
129 time_t ngx_http_file_cache_valid(ngx_array_t *cache_valid, ngx_uint_t status);
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
130
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
131 char *ngx_http_file_cache_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
132 void *conf);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
133 char *ngx_http_file_cache_valid_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
134 void *conf);
18
6f8b0dc0f8dd nginx 0.1.9
Igor Sysoev <http://sysoev.ru>
parents: 0
diff changeset
135
500
ed3d382670c7 nginx 0.7.62
Igor Sysoev <http://sysoev.ru>
parents: 496
diff changeset
136 extern ngx_str_t ngx_http_cache_status[];
ed3d382670c7 nginx 0.7.62
Igor Sysoev <http://sysoev.ru>
parents: 496
diff changeset
137
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
138
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
139 #endif /* _NGX_HTTP_CACHE_H_INCLUDED_ */