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