annotate src/http/ngx_http_cache.h @ 596:6c96fdd2dfc3 NGINX_0_8_50

nginx 0.8.50 *) Feature: the "secure_link", "secure_link_md5", and "secure_link_expires" directives of the ngx_http_secure_link_module. *) Feature: the -q switch. Thanks to Gena Makhomed. *) Bugfix: worker processes may got caught in an endless loop during reconfiguration, if a caching was used; the bug had appeared in 0.8.48. *) Bugfix: in the "gzip_disable" directive. Thanks to Derrick Petzold. *) Bugfix: nginx/Windows could not send stop, quit, reopen, and reload signals to a process run in other session.
author Igor Sysoev <http://sysoev.ru>
date Thu, 02 Sep 2010 00:00:00 +0400
parents cde3626b2d0d
children 8dc007eddbcf
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
502
f0cac61857ae nginx 0.8.3
Igor Sysoev <http://sysoev.ru>
parents: 498
diff changeset
16 #define NGX_HTTP_CACHE_MISS 1
588
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
17 #define NGX_HTTP_CACHE_BYPASS 2
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
18 #define NGX_HTTP_CACHE_EXPIRED 3
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
19 #define NGX_HTTP_CACHE_STALE 4
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
20 #define NGX_HTTP_CACHE_UPDATING 5
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
21 #define NGX_HTTP_CACHE_HIT 6
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
22 #define NGX_HTTP_CACHE_SCARCE 7
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
23
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
24 #define NGX_HTTP_CACHE_KEY_LEN 16
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
25
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
26
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
27 typedef struct {
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
28 ngx_uint_t status;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
29 time_t valid;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
30 } ngx_http_cache_valid_t;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
31
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
32
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
33 typedef struct {
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
34 ngx_rbtree_node_t node;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
35 ngx_queue_t queue;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
36
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
37 u_char key[NGX_HTTP_CACHE_KEY_LEN
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
38 - sizeof(ngx_rbtree_key_t)];
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
39
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
40 unsigned count:20;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
41 unsigned uses:10;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
42 unsigned valid_msec:10;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
43 unsigned error:10;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
44 unsigned exists:1;
498
207ae3ff0444 nginx 0.8.1
Igor Sysoev <http://sysoev.ru>
parents: 480
diff changeset
45 unsigned updating:1;
596
6c96fdd2dfc3 nginx 0.8.50
Igor Sysoev <http://sysoev.ru>
parents: 590
diff changeset
46 unsigned deleting:1;
6c96fdd2dfc3 nginx 0.8.50
Igor Sysoev <http://sysoev.ru>
parents: 590
diff changeset
47 /* 11 unused bits */
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
48
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
49 ngx_file_uniq_t uniq;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
50 time_t expire;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
51 time_t valid_sec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
52 size_t body_start;
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
53 off_t length;
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
54 } ngx_http_file_cache_node_t;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
55
18
6f8b0dc0f8dd nginx 0.1.9
Igor Sysoev <http://sysoev.ru>
parents: 0
diff changeset
56
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
57 struct ngx_http_cache_s {
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
58 ngx_file_t file;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
59 ngx_array_t keys;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
60 uint32_t crc32;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
61 u_char key[NGX_HTTP_CACHE_KEY_LEN];
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
62
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
63 ngx_file_uniq_t uniq;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
64 time_t valid_sec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
65 time_t last_modified;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
66 time_t date;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
67
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
68 size_t header_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
69 size_t body_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
70 off_t length;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
71
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
72 ngx_uint_t min_uses;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
73 ngx_uint_t error;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
74 ngx_uint_t valid_msec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
75
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
76 ngx_buf_t *buf;
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 ngx_http_file_cache_t *file_cache;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
79 ngx_http_file_cache_node_t *node;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
80
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
81 unsigned updated:1;
590
cde3626b2d0d nginx 0.8.47
Igor Sysoev <http://sysoev.ru>
parents: 588
diff changeset
82 unsigned updating:1;
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
83 unsigned exists:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
84 unsigned temp_file:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
85 };
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
86
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
87
22
8b6db3bda591 nginx 0.1.11
Igor Sysoev <http://sysoev.ru>
parents: 18
diff changeset
88 typedef struct {
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
89 time_t valid_sec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
90 time_t last_modified;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
91 time_t date;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
92 uint32_t crc32;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
93 u_short valid_msec;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
94 u_short header_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
95 u_short body_start;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
96 } ngx_http_file_cache_header_t;
26
45fe5b98a9de nginx 0.1.13
Igor Sysoev <http://sysoev.ru>
parents: 22
diff changeset
97
45fe5b98a9de nginx 0.1.13
Igor Sysoev <http://sysoev.ru>
parents: 22
diff changeset
98
480
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
99 typedef struct {
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
100 ngx_rbtree_t rbtree;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
101 ngx_rbtree_node_t sentinel;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
102 ngx_queue_t queue;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
103 ngx_atomic_t cold;
514
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 502
diff changeset
104 ngx_atomic_t loading;
480
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
105 off_t size;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
106 } ngx_http_file_cache_sh_t;
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
107
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
108
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
109 struct ngx_http_file_cache_s {
480
549994537f15 nginx 0.7.52
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
110 ngx_http_file_cache_sh_t *sh;
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
111 ngx_slab_pool_t *shpool;
18
6f8b0dc0f8dd nginx 0.1.9
Igor Sysoev <http://sysoev.ru>
parents: 0
diff changeset
112
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
113 ngx_path_t *path;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
114
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
115 off_t max_size;
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
116 size_t bsize;
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
117
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
118 time_t inactive;
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
119
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
120 ngx_msec_t last;
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
121 ngx_uint_t files;
0
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 ngx_shm_zone_t *shm_zone;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
124 };
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
125
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
126
588
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
127 ngx_int_t ngx_http_file_cache_new(ngx_http_request_t *r);
b6a5942a4e6a nginx 0.8.46
Igor Sysoev <http://sysoev.ru>
parents: 572
diff changeset
128 ngx_int_t ngx_http_file_cache_create(ngx_http_request_t *r);
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
129 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
130 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
131 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
132 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
133 ngx_int_t ngx_http_cache_send(ngx_http_request_t *);
590
cde3626b2d0d nginx 0.8.47
Igor Sysoev <http://sysoev.ru>
parents: 588
diff changeset
134 void ngx_http_file_cache_free(ngx_http_cache_t *c, ngx_temp_file_t *tf);
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
135 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
136
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
137 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
138 void *conf);
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 26
diff changeset
139 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
140 void *conf);
18
6f8b0dc0f8dd nginx 0.1.9
Igor Sysoev <http://sysoev.ru>
parents: 0
diff changeset
141
572
ff463db0be31 nginx 0.8.38
Igor Sysoev <http://sysoev.ru>
parents: 518
diff changeset
142
502
f0cac61857ae nginx 0.8.3
Igor Sysoev <http://sysoev.ru>
parents: 498
diff changeset
143 extern ngx_str_t ngx_http_cache_status[];
f0cac61857ae nginx 0.8.3
Igor Sysoev <http://sysoev.ru>
parents: 498
diff changeset
144
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
145
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
146 #endif /* _NGX_HTTP_CACHE_H_INCLUDED_ */