|
0
|
1
|
|
|
2 /*
|
|
|
3 * Copyright (C) Igor Sysoev
|
|
|
4 */
|
|
|
5
|
|
|
6
|
|
|
7 #ifndef _NGX_FILES_H_INCLUDED_
|
|
|
8 #define _NGX_FILES_H_INCLUDED_
|
|
|
9
|
|
|
10
|
|
|
11 #include <ngx_config.h>
|
|
|
12 #include <ngx_core.h>
|
|
|
13
|
|
|
14
|
|
406
|
15 typedef int ngx_fd_t;
|
|
|
16 typedef struct stat ngx_file_info_t;
|
|
|
17 typedef ino_t ngx_file_uniq_t;
|
|
|
18
|
|
|
19
|
|
|
20 typedef struct {
|
|
582
|
21 u_char *name;
|
|
|
22 size_t size;
|
|
|
23 void *addr;
|
|
|
24 ngx_fd_t fd;
|
|
|
25 ngx_log_t *log;
|
|
|
26 } ngx_file_mapping_t;
|
|
|
27
|
|
|
28
|
|
|
29 typedef struct {
|
|
500
|
30 DIR *dir;
|
|
|
31 struct dirent *de;
|
|
|
32 struct stat info;
|
|
406
|
33
|
|
500
|
34 unsigned type:8;
|
|
|
35 unsigned valid_info:1;
|
|
406
|
36 } ngx_dir_t;
|
|
|
37
|
|
|
38
|
|
|
39 typedef struct {
|
|
|
40 size_t n;
|
|
|
41 glob_t pglob;
|
|
|
42 u_char *pattern;
|
|
|
43 ngx_log_t *log;
|
|
|
44 ngx_uint_t test;
|
|
|
45 } ngx_glob_t;
|
|
|
46
|
|
|
47
|
|
0
|
48 #define NGX_INVALID_FILE -1
|
|
|
49 #define NGX_FILE_ERROR -1
|
|
|
50
|
|
|
51
|
|
|
52
|
|
372
|
53 #ifdef __CYGWIN__
|
|
|
54
|
|
390
|
55 #define NGX_HAVE_CASELESS_FILESYSTEM 1
|
|
|
56
|
|
372
|
57 #define ngx_open_file(name, mode, create, access) \
|
|
|
58 open((const char *) name, mode|create|O_BINARY, access)
|
|
|
59
|
|
|
60 #else
|
|
|
61
|
|
276
|
62 #define ngx_open_file(name, mode, create, access) \
|
|
|
63 open((const char *) name, mode|create, access)
|
|
372
|
64
|
|
|
65 #endif
|
|
|
66
|
|
0
|
67 #define ngx_open_file_n "open()"
|
|
|
68
|
|
|
69 #define NGX_FILE_RDONLY O_RDONLY
|
|
276
|
70 #define NGX_FILE_WRONLY O_WRONLY
|
|
0
|
71 #define NGX_FILE_RDWR O_RDWR
|
|
|
72 #define NGX_FILE_CREATE_OR_OPEN O_CREAT
|
|
|
73 #define NGX_FILE_OPEN 0
|
|
478
|
74 #define NGX_FILE_TRUNCATE O_CREAT|O_TRUNC
|
|
470
|
75 #define NGX_FILE_APPEND O_WRONLY|O_APPEND
|
|
568
|
76 #define NGX_FILE_NONBLOCK O_NONBLOCK
|
|
0
|
77
|
|
276
|
78 #define NGX_FILE_DEFAULT_ACCESS 0644
|
|
464
|
79 #define NGX_FILE_OWNER_ACCESS 0600
|
|
276
|
80
|
|
0
|
81
|
|
|
82 #define ngx_close_file close
|
|
|
83 #define ngx_close_file_n "close()"
|
|
|
84
|
|
|
85
|
|
|
86 #define ngx_delete_file(name) unlink((const char *) name)
|
|
|
87 #define ngx_delete_file_n "unlink()"
|
|
|
88
|
|
|
89
|
|
182
|
90 ngx_fd_t ngx_open_tempfile(u_char *name, ngx_uint_t persistent,
|
|
276
|
91 ngx_uint_t access);
|
|
0
|
92 #define ngx_open_tempfile_n "open()"
|
|
|
93
|
|
|
94
|
|
|
95 ssize_t ngx_read_file(ngx_file_t *file, u_char *buf, size_t size, off_t offset);
|
|
398
|
96 #if (NGX_HAVE_PREAD)
|
|
|
97 #define ngx_read_file_n "pread()"
|
|
|
98 #else
|
|
0
|
99 #define ngx_read_file_n "read()"
|
|
398
|
100 #endif
|
|
0
|
101
|
|
|
102 ssize_t ngx_write_file(ngx_file_t *file, u_char *buf, size_t size,
|
|
46
|
103 off_t offset);
|
|
0
|
104
|
|
|
105 ssize_t ngx_write_chain_to_file(ngx_file_t *file, ngx_chain_t *ce,
|
|
46
|
106 off_t offset, ngx_pool_t *pool);
|
|
0
|
107
|
|
|
108
|
|
276
|
109 #define ngx_read_fd read
|
|
|
110 #define ngx_read_fd_n "read()"
|
|
|
111
|
|
418
|
112 /*
|
|
|
113 * we use inlined function instead of simple #define
|
|
|
114 * because glibc 2.3 sets warn_unused_result attribute for write()
|
|
|
115 * and in this case gcc 4.3 ignores (void) cast
|
|
|
116 */
|
|
|
117 static ngx_inline ssize_t
|
|
|
118 ngx_write_fd(ngx_fd_t fd, void *buf, size_t n)
|
|
|
119 {
|
|
|
120 return write(fd, buf, n);
|
|
|
121 }
|
|
|
122
|
|
276
|
123 #define ngx_write_fd_n "write()"
|
|
|
124
|
|
484
|
125
|
|
|
126 #define ngx_write_console ngx_write_fd
|
|
|
127
|
|
|
128
|
|
120
|
129 #define ngx_linefeed(p) *p++ = LF;
|
|
|
130 #define NGX_LINEFEED_SIZE 1
|
|
|
131
|
|
|
132
|
|
182
|
133 #define ngx_rename_file(o, n) rename((const char *) o, (const char *) n)
|
|
230
|
134 #define ngx_rename_file_n "rename()"
|
|
0
|
135
|
|
|
136
|
|
218
|
137 #define ngx_change_file_access(n, a) chmod((const char *) n, a)
|
|
230
|
138 #define ngx_change_file_access_n "chmod()"
|
|
|
139
|
|
|
140
|
|
|
141 ngx_int_t ngx_set_file_time(u_char *name, ngx_fd_t fd, time_t s);
|
|
|
142 #define ngx_set_file_time_n "utimes()"
|
|
218
|
143
|
|
|
144
|
|
0
|
145 #define ngx_file_info(file, sb) stat((const char *) file, sb)
|
|
|
146 #define ngx_file_info_n "stat()"
|
|
|
147
|
|
|
148 #define ngx_fd_info(fd, sb) fstat(fd, sb)
|
|
|
149 #define ngx_fd_info_n "fstat()"
|
|
|
150
|
|
568
|
151 #define ngx_link_info(file, sb) lstat((const char *) file, sb)
|
|
|
152 #define ngx_link_info_n "lstat()"
|
|
|
153
|
|
0
|
154 #define ngx_is_dir(sb) (S_ISDIR((sb)->st_mode))
|
|
|
155 #define ngx_is_file(sb) (S_ISREG((sb)->st_mode))
|
|
218
|
156 #define ngx_is_link(sb) (S_ISLNK((sb)->st_mode))
|
|
540
|
157 #define ngx_is_exec(sb) (((sb)->st_mode & S_IXUSR) == S_IXUSR)
|
|
276
|
158 #define ngx_file_access(sb) ((sb)->st_mode & 0777)
|
|
0
|
159 #define ngx_file_size(sb) (sb)->st_size
|
|
622
|
160 #define ngx_file_fs_size(sb) ((sb)->st_blocks * 512)
|
|
0
|
161 #define ngx_file_mtime(sb) (sb)->st_mtime
|
|
|
162 #define ngx_file_uniq(sb) (sb)->st_ino
|
|
|
163
|
|
|
164
|
|
582
|
165 ngx_int_t ngx_create_file_mapping(ngx_file_mapping_t *fm);
|
|
|
166 void ngx_close_file_mapping(ngx_file_mapping_t *fm);
|
|
|
167
|
|
|
168
|
|
390
|
169 #if (NGX_HAVE_CASELESS_FILESYSTEM)
|
|
|
170
|
|
|
171 #define ngx_filename_cmp(s1, s2, n) strncasecmp((char *) s1, (char *) s2, n)
|
|
|
172
|
|
|
173 #else
|
|
|
174
|
|
|
175 #define ngx_filename_cmp ngx_memcmp
|
|
|
176
|
|
|
177 #endif
|
|
|
178
|
|
0
|
179
|
|
412
|
180 #define ngx_realpath(p, r) realpath((char *) p, (char *) r)
|
|
|
181 #define ngx_realpath_n "realpath()"
|
|
482
|
182 #define ngx_getcwd(buf, size) (getcwd((char *) buf, size) != NULL)
|
|
0
|
183 #define ngx_getcwd_n "getcwd()"
|
|
482
|
184 #define ngx_path_separator(c) ((c) == '/')
|
|
|
185
|
|
0
|
186 #define NGX_MAX_PATH PATH_MAX
|
|
|
187
|
|
|
188 #define NGX_DIR_MASK_LEN 0
|
|
|
189
|
|
|
190
|
|
16
|
191 ngx_int_t ngx_open_dir(ngx_str_t *name, ngx_dir_t *dir);
|
|
0
|
192 #define ngx_open_dir_n "opendir()"
|
|
|
193
|
|
|
194
|
|
|
195 #define ngx_close_dir(d) closedir((d)->dir)
|
|
|
196 #define ngx_close_dir_n "closedir()"
|
|
|
197
|
|
|
198
|
|
406
|
199 ngx_int_t ngx_read_dir(ngx_dir_t *dir);
|
|
0
|
200 #define ngx_read_dir_n "readdir()"
|
|
|
201
|
|
|
202
|
|
218
|
203 #define ngx_create_dir(name, access) mkdir((const char *) name, access)
|
|
0
|
204 #define ngx_create_dir_n "mkdir()"
|
|
|
205
|
|
|
206
|
|
|
207 #define ngx_delete_dir(name) rmdir((const char *) name)
|
|
|
208 #define ngx_delete_dir_n "rmdir()"
|
|
|
209
|
|
|
210
|
|
282
|
211 #define ngx_dir_access(a) (a | (a & 0444) >> 2)
|
|
|
212
|
|
|
213
|
|
6
|
214 #define ngx_de_name(dir) ((u_char *) (dir)->de->d_name)
|
|
406
|
215 #if (NGX_HAVE_D_NAMLEN)
|
|
0
|
216 #define ngx_de_namelen(dir) (dir)->de->d_namlen
|
|
|
217 #else
|
|
|
218 #define ngx_de_namelen(dir) ngx_strlen((dir)->de->d_name)
|
|
|
219 #endif
|
|
536
|
220
|
|
|
221 static ngx_inline ngx_int_t
|
|
|
222 ngx_de_info(u_char *name, ngx_dir_t *dir)
|
|
|
223 {
|
|
|
224 dir->type = 0;
|
|
|
225 return stat((const char *) name, &dir->info);
|
|
|
226 }
|
|
|
227
|
|
0
|
228 #define ngx_de_info_n "stat()"
|
|
46
|
229 #define ngx_de_link_info(name, dir) lstat((const char *) name, &(dir)->info)
|
|
|
230 #define ngx_de_link_info_n "lstat()"
|
|
406
|
231
|
|
|
232 #if (NGX_HAVE_D_TYPE)
|
|
|
233
|
|
536
|
234 /*
|
|
|
235 * some file systems (e.g. XFS on Linux and CD9660 on FreeBSD)
|
|
|
236 * do not set dirent.d_type
|
|
|
237 */
|
|
456
|
238
|
|
|
239 #define ngx_de_is_dir(dir) \
|
|
|
240 (((dir)->type) ? ((dir)->type == DT_DIR) : (S_ISDIR((dir)->info.st_mode)))
|
|
|
241 #define ngx_de_is_file(dir) \
|
|
|
242 (((dir)->type) ? ((dir)->type == DT_REG) : (S_ISREG((dir)->info.st_mode)))
|
|
|
243 #define ngx_de_is_link(dir) \
|
|
536
|
244 (((dir)->type) ? ((dir)->type == DT_LNK) : (S_ISLNK((dir)->info.st_mode)))
|
|
456
|
245
|
|
406
|
246 #else
|
|
|
247
|
|
0
|
248 #define ngx_de_is_dir(dir) (S_ISDIR((dir)->info.st_mode))
|
|
|
249 #define ngx_de_is_file(dir) (S_ISREG((dir)->info.st_mode))
|
|
46
|
250 #define ngx_de_is_link(dir) (S_ISLNK((dir)->info.st_mode))
|
|
406
|
251
|
|
|
252 #endif
|
|
|
253
|
|
276
|
254 #define ngx_de_access(dir) (((dir)->info.st_mode) & 0777)
|
|
0
|
255 #define ngx_de_size(dir) (dir)->info.st_size
|
|
632
|
256 #define ngx_de_fs_size(dir) ((dir)->info.st_blocks * 512)
|
|
0
|
257 #define ngx_de_mtime(dir) (dir)->info.st_mtime
|
|
|
258
|
|
|
259
|
|
238
|
260 ngx_int_t ngx_open_glob(ngx_glob_t *gl);
|
|
|
261 #define ngx_open_glob_n "glob()"
|
|
|
262 ngx_int_t ngx_read_glob(ngx_glob_t *gl, ngx_str_t *name);
|
|
|
263 void ngx_close_glob(ngx_glob_t *gl);
|
|
|
264
|
|
|
265
|
|
160
|
266 ngx_err_t ngx_trylock_fd(ngx_fd_t fd);
|
|
|
267 ngx_err_t ngx_lock_fd(ngx_fd_t fd);
|
|
|
268 ngx_err_t ngx_unlock_fd(ngx_fd_t fd);
|
|
|
269
|
|
|
270 #define ngx_trylock_fd_n "fcntl(F_SETLK, F_WRLCK)"
|
|
|
271 #define ngx_lock_fd_n "fcntl(F_SETLKW, F_WRLCK)"
|
|
|
272 #define ngx_unlock_fd_n "fcntl(F_SETLK, F_UNLCK)"
|
|
|
273
|
|
|
274
|
|
532
|
275 #if (NGX_HAVE_F_READAHEAD)
|
|
|
276
|
|
|
277 #define NGX_HAVE_READ_AHEAD 1
|
|
|
278
|
|
|
279 #define ngx_read_ahead(fd, n) fcntl(fd, F_READAHEAD, (int) n)
|
|
|
280 #define ngx_read_ahead_n "fcntl(fd, F_READAHEAD)"
|
|
|
281
|
|
|
282 #elif (NGX_HAVE_POSIX_FADVISE)
|
|
|
283
|
|
|
284 #define NGX_HAVE_READ_AHEAD 1
|
|
|
285
|
|
546
|
286 ngx_int_t ngx_read_ahead(ngx_fd_t fd, size_t n);
|
|
532
|
287 #define ngx_read_ahead_n "posix_fadvise(POSIX_FADV_SEQUENTIAL)"
|
|
|
288
|
|
|
289 #else
|
|
|
290
|
|
|
291 #define ngx_read_ahead(fd, n) 0
|
|
|
292 #define ngx_read_ahead_n "ngx_read_ahead_n"
|
|
|
293
|
|
|
294 #endif
|
|
|
295
|
|
|
296
|
|
390
|
297 #if (NGX_HAVE_O_DIRECT)
|
|
|
298
|
|
410
|
299 ngx_int_t ngx_directio_on(ngx_fd_t fd);
|
|
|
300 #define ngx_directio_on_n "fcntl(O_DIRECT)"
|
|
|
301
|
|
|
302 ngx_int_t ngx_directio_off(ngx_fd_t fd);
|
|
|
303 #define ngx_directio_off_n "fcntl(!O_DIRECT)"
|
|
390
|
304
|
|
|
305 #elif (NGX_HAVE_F_NOCACHE)
|
|
|
306
|
|
410
|
307 #define ngx_directio_on(fd) fcntl(fd, F_NOCACHE, 1)
|
|
|
308 #define ngx_directio_on_n "fcntl(F_NOCACHE, 1)"
|
|
390
|
309
|
|
392
|
310 #elif (NGX_HAVE_DIRECTIO)
|
|
|
311
|
|
410
|
312 #define ngx_directio_on(fd) directio(fd, DIRECTIO_ON)
|
|
|
313 #define ngx_directio_on_n "directio(DIRECTIO_ON)"
|
|
392
|
314
|
|
390
|
315 #else
|
|
|
316
|
|
410
|
317 #define ngx_directio_on(fd) 0
|
|
|
318 #define ngx_directio_on_n "ngx_directio_on_n"
|
|
390
|
319
|
|
|
320 #endif
|
|
|
321
|
|
468
|
322 size_t ngx_fs_bsize(u_char *name);
|
|
|
323
|
|
|
324
|
|
482
|
325 #define ngx_stderr STDERR_FILENO
|
|
|
326 #define ngx_set_stderr(fd) dup2(fd, STDERR_FILENO)
|
|
|
327 #define ngx_set_stderr_n "dup2(STDERR_FILENO)"
|
|
|
328
|
|
|
329
|
|
518
|
330 #if (NGX_HAVE_FILE_AIO)
|
|
|
331
|
|
|
332 ssize_t ngx_file_aio_read(ngx_file_t *file, u_char *buf, size_t size,
|
|
|
333 off_t offset, ngx_pool_t *pool);
|
|
|
334
|
|
542
|
335 extern ngx_uint_t ngx_file_aio;
|
|
|
336
|
|
518
|
337 #endif
|
|
|
338
|
|
|
339
|
|
0
|
340 #endif /* _NGX_FILES_H_INCLUDED_ */
|
