annotate src/core/ngx_file.h @ 688:f31b19fe7f48 NGINX_1_3_7

nginx 1.3.7 *) Feature: OCSP stapling support. Thanks to Comodo, DigiCert and GlobalSign for sponsoring this work. *) Feature: the "ssl_trusted_certificate" directive. *) Feature: resolver now randomly rotates addresses returned from cache. Thanks to Anton Jouline. *) Bugfix: OpenSSL 0.9.7 compatibility.
author Igor Sysoev <http://sysoev.ru>
date Tue, 02 Oct 2012 00:00:00 +0400
parents d0f7a625f27c
children
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
660
d0f7a625f27c nginx 1.1.14
Igor Sysoev <http://sysoev.ru>
parents: 632
diff changeset
4 * Copyright (C) Nginx, Inc.
0
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
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
8 #ifndef _NGX_FILE_H_INCLUDED_
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
9 #define _NGX_FILE_H_INCLUDED_
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
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
12 #include <ngx_config.h>
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
13 #include <ngx_core.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
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
16 struct ngx_file_s {
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
17 ngx_fd_t fd;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
18 ngx_str_t name;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
19 ngx_file_info_t info;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
20
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
21 off_t offset;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
22 off_t sys_offset;
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: 430
diff changeset
24 ngx_log_t *log;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
25
518
86dad910eeb6 nginx 0.8.11
Igor Sysoev <http://sysoev.ru>
parents: 516
diff changeset
26 #if (NGX_HAVE_FILE_AIO)
86dad910eeb6 nginx 0.8.11
Igor Sysoev <http://sysoev.ru>
parents: 516
diff changeset
27 ngx_event_aio_t *aio;
86dad910eeb6 nginx 0.8.11
Igor Sysoev <http://sysoev.ru>
parents: 516
diff changeset
28 #endif
86dad910eeb6 nginx 0.8.11
Igor Sysoev <http://sysoev.ru>
parents: 516
diff changeset
29
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
30 unsigned valid_info:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
31 unsigned directio:1;
0
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
518
86dad910eeb6 nginx 0.8.11
Igor Sysoev <http://sysoev.ru>
parents: 516
diff changeset
34
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
35 #define NGX_MAX_PATH_LEVEL 3
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
36
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
37
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
38 typedef time_t (*ngx_path_manager_pt) (void *data);
514
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
39 typedef void (*ngx_path_loader_pt) (void *data);
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
40
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
41
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
42 typedef struct {
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
43 ngx_str_t name;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
44 size_t len;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
45 size_t level[3];
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
46
468
56baf312c1b5 nginx 0.7.46
Igor Sysoev <http://sysoev.ru>
parents: 464
diff changeset
47 ngx_path_manager_pt manager;
514
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
48 ngx_path_loader_pt loader;
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
49 void *data;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
50
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
51 u_char *conf_file;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
52 ngx_uint_t line;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
53 } ngx_path_t;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
54
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
55
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
56 typedef struct {
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
57 ngx_str_t name;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
58 size_t level[3];
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
59 } ngx_path_init_t;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
60
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
61
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
62 typedef struct {
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
63 ngx_file_t file;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
64 off_t offset;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
65 ngx_path_t *path;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
66 ngx_pool_t *pool;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
67 char *warn;
182
13710a1813ad nginx 0.3.38
Igor Sysoev <http://sysoev.ru>
parents: 110
diff changeset
68
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
69 ngx_uint_t access;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
70
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
71 unsigned log_level:8;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
72 unsigned persistent:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
73 unsigned clean:1;
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
74 } ngx_temp_file_t;
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
75
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
76
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
77 typedef struct {
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
78 ngx_uint_t access;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
79 ngx_uint_t path_access;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
80 time_t time;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
81 ngx_fd_t fd;
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
82
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
83 unsigned create_path:1;
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
84 unsigned delete_file:1;
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
85
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
86 ngx_log_t *log;
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
87 } ngx_ext_rename_file_t;
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
88
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
89
514
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
90 typedef struct {
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
91 off_t size;
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
92 size_t buf_size;
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
93
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
94 ngx_uint_t access;
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
95 time_t time;
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
96
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
97 ngx_log_t *log;
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
98 } ngx_copy_file_t;
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
99
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
100
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
101 typedef struct ngx_tree_ctx_s ngx_tree_ctx_t;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
102
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
103 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
104 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
105
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
106 struct ngx_tree_ctx_s {
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
107 off_t size;
632
5b73504dd4ba nginx 1.1.0
Igor Sysoev <http://sysoev.ru>
parents: 518
diff changeset
108 off_t fs_size;
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
109 ngx_uint_t access;
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
110 time_t mtime;
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
111
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
112 ngx_tree_init_handler_pt init_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
113 ngx_tree_handler_pt file_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
114 ngx_tree_handler_pt pre_tree_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
115 ngx_tree_handler_pt post_tree_handler;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
116 ngx_tree_handler_pt spec_handler;
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
117
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
118 void *data;
276
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
119 size_t alloc;
c5c2b2883984 nginx 0.5.8
Igor Sysoev <http://sysoev.ru>
parents: 272
diff changeset
120
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
121 ngx_log_t *log;
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
122 };
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
123
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
124
16
74b1868dd3cd nginx 0.1.8
Igor Sysoev <http://sysoev.ru>
parents: 6
diff changeset
125 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
126 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
127 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
128 ngx_uint_t access);
356
b743d290eb3b nginx 0.6.22
Igor Sysoev <http://sysoev.ru>
parents: 324
diff changeset
129 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
130 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
131 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
132 ngx_int_t ngx_add_path(ngx_conf_t *cf, ngx_path_t **slot);
688
f31b19fe7f48 nginx 1.3.7
Igor Sysoev <http://sysoev.ru>
parents: 660
diff changeset
133 ngx_int_t ngx_create_paths(ngx_cycle_t *cycle, ngx_uid_t user);
362
54fad6c4b555 nginx 0.6.25
Igor Sysoev <http://sysoev.ru>
parents: 356
diff changeset
134 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
135 ngx_ext_rename_file_t *ext);
514
43cc6f0b77ce nginx 0.8.9
Igor Sysoev <http://sysoev.ru>
parents: 468
diff changeset
136 ngx_int_t ngx_copy_file(u_char *from, u_char *to, ngx_copy_file_t *cf);
272
29a6403156b0 nginx 0.5.6
Igor Sysoev <http://sysoev.ru>
parents: 218
diff changeset
137 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
138
44
4989c3d25945 nginx 0.1.22
Igor Sysoev <http://sysoev.ru>
parents: 42
diff changeset
139 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
140
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
141 char *ngx_conf_set_path_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
464
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
142 char *ngx_conf_merge_path_value(ngx_conf_t *cf, ngx_path_t **path,
c8cfb6c462ef nginx 0.7.44
Igor Sysoev <http://sysoev.ru>
parents: 430
diff changeset
143 ngx_path_t *prev, ngx_path_init_t *init);
318
fc223117327f nginx 0.6.3
Igor Sysoev <http://sysoev.ru>
parents: 278
diff changeset
144 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
145
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
146
516
7efcdb937752 nginx 0.8.10
Igor Sysoev <http://sysoev.ru>
parents: 514
diff changeset
147 extern ngx_atomic_t *ngx_temp_number;
7efcdb937752 nginx 0.8.10
Igor Sysoev <http://sysoev.ru>
parents: 514
diff changeset
148 extern ngx_atomic_int_t ngx_random_number;
7efcdb937752 nginx 0.8.10
Igor Sysoev <http://sysoev.ru>
parents: 514
diff changeset
149
7efcdb937752 nginx 0.8.10
Igor Sysoev <http://sysoev.ru>
parents: 514
diff changeset
150
0
f0b350454894 nginx 0.1.0
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
151 #endif /* _NGX_FILE_H_INCLUDED_ */