annotate src/core/ngx_file.h @ 406:79c5df00501e NGINX_0_7_15

nginx 0.7.15 *) Feature: the ngx_http_random_index_module. *) Feature: the "directio" directive has been optimized for file requests starting from arbitrary position. *) Feature: the "directio" directive turns off sendfile if it is necessary. *) Feature: now nginx allows underscores in a client request header line names.
author Igor Sysoev <http://sysoev.ru>
date Mon, 08 Sep 2008 00:00:00 +0400
parents babd3d9efb62
children dac47e9ef0d5
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_FILE_H_INCLUDED_
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
8 #define _NGX_FILE_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
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
14 typedef struct ngx_path_s ngx_path_t;
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
15
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
16 #include <ngx_garbage_collector.h>
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
17
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
18
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
19 struct ngx_file_s {
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
20 ngx_fd_t fd;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
21 ngx_str_t name;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
22 ngx_file_info_t info;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
23
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
24 off_t offset;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
25 off_t sys_offset;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
26
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
27 ngx_log_t *log;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
28
406
79c5df00501e nginx 0.7.15
Igor Sysoev <http://sysoev.ru>
parents: 366
diff changeset
29 unsigned valid_info:1;
79c5df00501e nginx 0.7.15
Igor Sysoev <http://sysoev.ru>
parents: 366
diff changeset
30 unsigned directio:1;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
31 };
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
32
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
33 #define NGX_MAX_PATH_LEVEL 3
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
34
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
35 struct ngx_path_s {
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
36 ngx_str_t name;
66
818201e5a553 nginx 0.1.33
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
37 size_t len;
818201e5a553 nginx 0.1.33
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
38 size_t level[3];
28
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
39 ngx_gc_handler_pt cleaner;
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
40
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
41 u_char *conf_file;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
42 ngx_uint_t line;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
43 };
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
44
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
45
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
46 typedef struct {
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
47 ngx_file_t file;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
48 off_t offset;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
49 ngx_path_t *path;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
50 ngx_pool_t *pool;
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
51 char *warn;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
52
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
53 ngx_uint_t access;
182
13710a1813ad nginx 0.3.38
Igor Sysoev <http://sysoev.ru>
parents: 110
diff changeset
54
186
54aabf2b0bc6 nginx 0.3.40
Igor Sysoev <http://sysoev.ru>
parents: 182
diff changeset
55 unsigned log_level:8;
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
56 unsigned persistent:1;
278
704622b2528a nginx 0.5.9
Igor Sysoev <http://sysoev.ru>
parents: 276
diff changeset
57 unsigned clean:1;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
58 } ngx_temp_file_t;
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
59
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
60
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
61 typedef struct {
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
62 ngx_uint_t access;
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
63 time_t time;
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
64 ngx_fd_t fd;
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
65
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
66 unsigned create_path:1;
366
babd3d9efb62 nginx 0.6.27
Igor Sysoev <http://sysoev.ru>
parents: 362
diff changeset
67 unsigned delete_file:1;
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
68
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
69 ngx_log_t *log;
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
70 } ngx_ext_rename_file_t;
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
71
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
72
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
73 typedef struct ngx_tree_ctx_s ngx_tree_ctx_t;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
74
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
75 typedef ngx_int_t (*ngx_tree_init_handler_pt) (void *ctx, void *prev);
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
76 typedef ngx_int_t (*ngx_tree_handler_pt) (ngx_tree_ctx_t *ctx, ngx_str_t *name);
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
77
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
78 struct ngx_tree_ctx_s {
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
79 off_t size;
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
80 ngx_uint_t access;
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
81 time_t mtime;
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
82
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
83 ngx_tree_init_handler_pt init_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
84 ngx_tree_handler_pt file_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
85 ngx_tree_handler_pt pre_tree_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
86 ngx_tree_handler_pt post_tree_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
87 ngx_tree_handler_pt spec_handler;
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
88
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
89 void *data;
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
90 size_t alloc;
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
91
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
92 ngx_log_t *log;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
93 };
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
94
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
95
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
96 ssize_t ngx_write_chain_to_temp_file(ngx_temp_file_t *tf, ngx_chain_t *chain);
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
97 ngx_int_t ngx_create_temp_file(ngx_file_t *file, ngx_path_t *path,
278
704622b2528a nginx 0.5.9
Igor Sysoev <http://sysoev.ru>
parents: 276
diff changeset
98 ngx_pool_t *pool, ngx_uint_t persistent, ngx_uint_t clean,
704622b2528a nginx 0.5.9
Igor Sysoev <http://sysoev.ru>
parents: 276
diff changeset
99 ngx_uint_t access);
356
b743d290eb3b nginx 0.6.22
Igor Sysoev <http://sysoev.ru>
parents: 324
diff changeset
100 void ngx_create_hashed_filename(ngx_path_t *path, u_char *file, size_t len);
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
101 ngx_int_t ngx_create_path(ngx_file_t *file, ngx_path_t *path);
218
1bf60f8c5c9e nginx 0.3.56
Igor Sysoev <http://sysoev.ru>
parents: 186
diff changeset
102 ngx_err_t ngx_create_full_path(u_char *dir, ngx_uint_t access);
28
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
103 ngx_int_t ngx_add_path(ngx_conf_t *cf, ngx_path_t **slot);
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
104 ngx_int_t ngx_create_pathes(ngx_cycle_t *cycle, ngx_uid_t user);
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
105 ngx_int_t ngx_ext_rename_file(ngx_str_t *src, ngx_str_t *to,
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
106 ngx_ext_rename_file_t *ext);
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
107 ngx_int_t ngx_walk_tree(ngx_tree_ctx_t *ctx, ngx_str_t *tree);
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
108
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents: 44
diff changeset
109 void ngx_init_temp_number(void);
44
4989c3d25945 nginx 0.1.22
Igor Sysoev <http://sysoev.ru>
parents: 42
diff changeset
110 ngx_atomic_uint_t ngx_next_temp_number(ngx_uint_t collision);
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
111
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
112 char *ngx_conf_set_path_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
318
fc223117327f nginx 0.6.3
Igor Sysoev <http://sysoev.ru>
parents: 278
diff changeset
113 char *ngx_conf_set_access_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
114
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
115
28
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
116 #define ngx_conf_merge_path_value(curr, prev, path, l1, l2, l3, clean, cf) \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
117 if (curr == NULL) { \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
118 if (prev == NULL) { \
50
72eb30262aac nginx 0.1.25
Igor Sysoev <http://sysoev.ru>
parents: 48
diff changeset
119 curr = ngx_palloc(cf->pool, sizeof(ngx_path_t)); \
72eb30262aac nginx 0.1.25
Igor Sysoev <http://sysoev.ru>
parents: 48
diff changeset
120 if (curr == NULL) { \
28
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
121 return NGX_CONF_ERROR; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
122 } \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
123 \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
124 curr->name.len = sizeof(path) - 1; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
125 curr->name.data = (u_char *) path; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
126 \
324
f7cd062ee035 nginx 0.6.6
Igor Sysoev <http://sysoev.ru>
parents: 318
diff changeset
127 if (ngx_conf_full_name(cf->cycle, &curr->name, 0) == NGX_ERROR) { \
28
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
128 return NGX_CONF_ERROR; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
129 } \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
130 \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
131 curr->level[0] = l1; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
132 curr->level[1] = l2; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
133 curr->level[2] = l3; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
134 curr->len = l1 + l2 + l3 + (l1 ? 1:0) + (l2 ? 1:0) + (l3 ? 1:0); \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
135 curr->cleaner = clean; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
136 curr->conf_file = NULL; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
137 \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
138 if (ngx_add_path(cf, &curr) == NGX_ERROR) { \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
139 return NGX_CONF_ERROR; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
140 } \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
141 \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
142 } else { \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
diff changeset
143 curr = prev; \
7ca9bdc82b3f nginx 0.1.14
Igor Sysoev <http://sysoev.ru>
parents: 16
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
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
147
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
148
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
149 #endif /* _NGX_FILE_H_INCLUDED_ */