1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Igor Sysoev
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#ifndef _NGX_FILE_H_INCLUDED_
9e18a033bSKonstantin Ananyev#define _NGX_FILE_H_INCLUDED_
10e18a033bSKonstantin Ananyev
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev#include <ngx_config.h>
13e18a033bSKonstantin Ananyev#include <ngx_core.h>
14e18a033bSKonstantin Ananyev
15e18a033bSKonstantin Ananyev
16e18a033bSKonstantin Ananyevstruct ngx_file_s {
17e18a033bSKonstantin Ananyev    ngx_fd_t                   fd;
18e18a033bSKonstantin Ananyev    ngx_str_t                  name;
19e18a033bSKonstantin Ananyev    ngx_file_info_t            info;
20e18a033bSKonstantin Ananyev
21e18a033bSKonstantin Ananyev    off_t                      offset;
22e18a033bSKonstantin Ananyev    off_t                      sys_offset;
23e18a033bSKonstantin Ananyev
24e18a033bSKonstantin Ananyev    ngx_log_t                 *log;
25e18a033bSKonstantin Ananyev
26e18a033bSKonstantin Ananyev#if (NGX_THREADS || NGX_COMPAT)
27e18a033bSKonstantin Ananyev    ngx_int_t                (*thread_handler)(ngx_thread_task_t *task,
28e18a033bSKonstantin Ananyev                                               ngx_file_t *file);
29e18a033bSKonstantin Ananyev    void                      *thread_ctx;
30e18a033bSKonstantin Ananyev    ngx_thread_task_t         *thread_task;
31e18a033bSKonstantin Ananyev#endif
32e18a033bSKonstantin Ananyev
33e18a033bSKonstantin Ananyev#if (NGX_HAVE_FILE_AIO || NGX_COMPAT)
34e18a033bSKonstantin Ananyev    ngx_event_aio_t           *aio;
35e18a033bSKonstantin Ananyev#endif
36e18a033bSKonstantin Ananyev
37e18a033bSKonstantin Ananyev    unsigned                   valid_info:1;
38e18a033bSKonstantin Ananyev    unsigned                   directio:1;
39e18a033bSKonstantin Ananyev};
40e18a033bSKonstantin Ananyev
41e18a033bSKonstantin Ananyev
42e18a033bSKonstantin Ananyev#define NGX_MAX_PATH_LEVEL  3
43e18a033bSKonstantin Ananyev
44e18a033bSKonstantin Ananyev
45e18a033bSKonstantin Ananyevtypedef ngx_msec_t (*ngx_path_manager_pt) (void *data);
46e18a033bSKonstantin Ananyevtypedef ngx_msec_t (*ngx_path_purger_pt) (void *data);
47e18a033bSKonstantin Ananyevtypedef void (*ngx_path_loader_pt) (void *data);
48e18a033bSKonstantin Ananyev
49e18a033bSKonstantin Ananyev
50e18a033bSKonstantin Ananyevtypedef struct {
51e18a033bSKonstantin Ananyev    ngx_str_t                  name;
52e18a033bSKonstantin Ananyev    size_t                     len;
53e18a033bSKonstantin Ananyev    size_t                     level[NGX_MAX_PATH_LEVEL];
54e18a033bSKonstantin Ananyev
55e18a033bSKonstantin Ananyev    ngx_path_manager_pt        manager;
56e18a033bSKonstantin Ananyev    ngx_path_purger_pt         purger;
57e18a033bSKonstantin Ananyev    ngx_path_loader_pt         loader;
58e18a033bSKonstantin Ananyev    void                      *data;
59e18a033bSKonstantin Ananyev
60e18a033bSKonstantin Ananyev    u_char                    *conf_file;
61e18a033bSKonstantin Ananyev    ngx_uint_t                 line;
62e18a033bSKonstantin Ananyev} ngx_path_t;
63e18a033bSKonstantin Ananyev
64e18a033bSKonstantin Ananyev
65e18a033bSKonstantin Ananyevtypedef struct {
66e18a033bSKonstantin Ananyev    ngx_str_t                  name;
67e18a033bSKonstantin Ananyev    size_t                     level[NGX_MAX_PATH_LEVEL];
68e18a033bSKonstantin Ananyev} ngx_path_init_t;
69e18a033bSKonstantin Ananyev
70e18a033bSKonstantin Ananyev
71e18a033bSKonstantin Ananyevtypedef struct {
72e18a033bSKonstantin Ananyev    ngx_file_t                 file;
73e18a033bSKonstantin Ananyev    off_t                      offset;
74e18a033bSKonstantin Ananyev    ngx_path_t                *path;
75e18a033bSKonstantin Ananyev    ngx_pool_t                *pool;
76e18a033bSKonstantin Ananyev    char                      *warn;
77e18a033bSKonstantin Ananyev
78e18a033bSKonstantin Ananyev    ngx_uint_t                 access;
79e18a033bSKonstantin Ananyev
80e18a033bSKonstantin Ananyev    unsigned                   log_level:8;
81e18a033bSKonstantin Ananyev    unsigned                   persistent:1;
82e18a033bSKonstantin Ananyev    unsigned                   clean:1;
83e18a033bSKonstantin Ananyev    unsigned                   thread_write:1;
84e18a033bSKonstantin Ananyev} ngx_temp_file_t;
85e18a033bSKonstantin Ananyev
86e18a033bSKonstantin Ananyev
87e18a033bSKonstantin Ananyevtypedef struct {
88e18a033bSKonstantin Ananyev    ngx_uint_t                 access;
89e18a033bSKonstantin Ananyev    ngx_uint_t                 path_access;
90e18a033bSKonstantin Ananyev    time_t                     time;
91e18a033bSKonstantin Ananyev    ngx_fd_t                   fd;
92e18a033bSKonstantin Ananyev
93e18a033bSKonstantin Ananyev    unsigned                   create_path:1;
94e18a033bSKonstantin Ananyev    unsigned                   delete_file:1;
95e18a033bSKonstantin Ananyev
96e18a033bSKonstantin Ananyev    ngx_log_t                 *log;
97e18a033bSKonstantin Ananyev} ngx_ext_rename_file_t;
98e18a033bSKonstantin Ananyev
99e18a033bSKonstantin Ananyev
100e18a033bSKonstantin Ananyevtypedef struct {
101e18a033bSKonstantin Ananyev    off_t                      size;
102e18a033bSKonstantin Ananyev    size_t                     buf_size;
103e18a033bSKonstantin Ananyev
104e18a033bSKonstantin Ananyev    ngx_uint_t                 access;
105e18a033bSKonstantin Ananyev    time_t                     time;
106e18a033bSKonstantin Ananyev
107e18a033bSKonstantin Ananyev    ngx_log_t                 *log;
108e18a033bSKonstantin Ananyev} ngx_copy_file_t;
109e18a033bSKonstantin Ananyev
110e18a033bSKonstantin Ananyev
111e18a033bSKonstantin Ananyevtypedef struct ngx_tree_ctx_s  ngx_tree_ctx_t;
112e18a033bSKonstantin Ananyev
113e18a033bSKonstantin Ananyevtypedef ngx_int_t (*ngx_tree_init_handler_pt) (void *ctx, void *prev);
114e18a033bSKonstantin Ananyevtypedef ngx_int_t (*ngx_tree_handler_pt) (ngx_tree_ctx_t *ctx, ngx_str_t *name);
115e18a033bSKonstantin Ananyev
116e18a033bSKonstantin Ananyevstruct ngx_tree_ctx_s {
117e18a033bSKonstantin Ananyev    off_t                      size;
118e18a033bSKonstantin Ananyev    off_t                      fs_size;
119e18a033bSKonstantin Ananyev    ngx_uint_t                 access;
120e18a033bSKonstantin Ananyev    time_t                     mtime;
121e18a033bSKonstantin Ananyev
122e18a033bSKonstantin Ananyev    ngx_tree_init_handler_pt   init_handler;
123e18a033bSKonstantin Ananyev    ngx_tree_handler_pt        file_handler;
124e18a033bSKonstantin Ananyev    ngx_tree_handler_pt        pre_tree_handler;
125e18a033bSKonstantin Ananyev    ngx_tree_handler_pt        post_tree_handler;
126e18a033bSKonstantin Ananyev    ngx_tree_handler_pt        spec_handler;
127e18a033bSKonstantin Ananyev
128e18a033bSKonstantin Ananyev    void                      *data;
129e18a033bSKonstantin Ananyev    size_t                     alloc;
130e18a033bSKonstantin Ananyev
131e18a033bSKonstantin Ananyev    ngx_log_t                 *log;
132e18a033bSKonstantin Ananyev};
133e18a033bSKonstantin Ananyev
134e18a033bSKonstantin Ananyev
135e18a033bSKonstantin Ananyevngx_int_t ngx_get_full_name(ngx_pool_t *pool, ngx_str_t *prefix,
136e18a033bSKonstantin Ananyev    ngx_str_t *name);
137e18a033bSKonstantin Ananyev
138e18a033bSKonstantin Ananyevssize_t ngx_write_chain_to_temp_file(ngx_temp_file_t *tf, ngx_chain_t *chain);
139e18a033bSKonstantin Ananyevngx_int_t ngx_create_temp_file(ngx_file_t *file, ngx_path_t *path,
140e18a033bSKonstantin Ananyev    ngx_pool_t *pool, ngx_uint_t persistent, ngx_uint_t clean,
141e18a033bSKonstantin Ananyev    ngx_uint_t access);
142e18a033bSKonstantin Ananyevvoid ngx_create_hashed_filename(ngx_path_t *path, u_char *file, size_t len);
143e18a033bSKonstantin Ananyevngx_int_t ngx_create_path(ngx_file_t *file, ngx_path_t *path);
144e18a033bSKonstantin Ananyevngx_err_t ngx_create_full_path(u_char *dir, ngx_uint_t access);
145e18a033bSKonstantin Ananyevngx_int_t ngx_add_path(ngx_conf_t *cf, ngx_path_t **slot);
146e18a033bSKonstantin Ananyevngx_int_t ngx_create_paths(ngx_cycle_t *cycle, ngx_uid_t user);
147e18a033bSKonstantin Ananyevngx_int_t ngx_ext_rename_file(ngx_str_t *src, ngx_str_t *to,
148e18a033bSKonstantin Ananyev    ngx_ext_rename_file_t *ext);
149e18a033bSKonstantin Ananyevngx_int_t ngx_copy_file(u_char *from, u_char *to, ngx_copy_file_t *cf);
150e18a033bSKonstantin Ananyevngx_int_t ngx_walk_tree(ngx_tree_ctx_t *ctx, ngx_str_t *tree);
151e18a033bSKonstantin Ananyev
152e18a033bSKonstantin Ananyevngx_atomic_uint_t ngx_next_temp_number(ngx_uint_t collision);
153e18a033bSKonstantin Ananyev
154e18a033bSKonstantin Ananyevchar *ngx_conf_set_path_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
155e18a033bSKonstantin Ananyevchar *ngx_conf_merge_path_value(ngx_conf_t *cf, ngx_path_t **path,
156e18a033bSKonstantin Ananyev    ngx_path_t *prev, ngx_path_init_t *init);
157e18a033bSKonstantin Ananyevchar *ngx_conf_set_access_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
158e18a033bSKonstantin Ananyev
159e18a033bSKonstantin Ananyev
160e18a033bSKonstantin Ananyevextern ngx_atomic_t      *ngx_temp_number;
161e18a033bSKonstantin Ananyevextern ngx_atomic_int_t   ngx_random_number;
162e18a033bSKonstantin Ananyev
163e18a033bSKonstantin Ananyev
164e18a033bSKonstantin Ananyev#endif /* _NGX_FILE_H_INCLUDED_ */
165