src/core/ngx_file.h

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