src/core/ngx_file.h - nginx-1.7.10

Data types defined

Macros defined

Source code


  1. /*
  2. * Copyright (C) Igor Sysoev
  3. * Copyright (C) Nginx, Inc.
  4. */


  5. #ifndef _NGX_FILE_H_INCLUDED_
  6. #define _NGX_FILE_H_INCLUDED_


  7. #include <ngx_config.h>
  8. #include <ngx_core.h>


  9. struct ngx_file_s {
  10.     ngx_fd_t                   fd;
  11.     ngx_str_t                  name;
  12.     ngx_file_info_t            info;

  13.     off_t                      offset;
  14.     off_t                      sys_offset;

  15.     ngx_log_t                 *log;

  16. #if (NGX_HAVE_FILE_AIO)
  17.     ngx_event_aio_t           *aio;
  18. #endif

  19.     unsigned                   valid_info:1;
  20.     unsigned                   directio:1;
  21. };


  22. #define NGX_MAX_PATH_LEVEL  3


  23. typedef time_t (*ngx_path_manager_pt) (void *data);
  24. typedef void (*ngx_path_loader_pt) (void *data);


  25. typedef struct {
  26.     ngx_str_t                  name;
  27.     size_t                     len;
  28.     size_t                     level[3];

  29.     ngx_path_manager_pt        manager;
  30.     ngx_path_loader_pt         loader;
  31.     void                      *data;

  32.     u_char                    *conf_file;
  33.     ngx_uint_t                 line;
  34. } ngx_path_t;


  35. typedef struct {
  36.     ngx_str_t                  name;
  37.     size_t                     level[3];
  38. } ngx_path_init_t;


  39. typedef struct {
  40.     ngx_file_t                 file;
  41.     off_t                      offset;
  42.     ngx_path_t                *path;
  43.     ngx_pool_t                *pool;
  44.     char                      *warn;

  45.     ngx_uint_t                 access;

  46.     unsigned                   log_level:8;
  47.     unsigned                   persistent:1;
  48.     unsigned                   clean:1;
  49. } ngx_temp_file_t;


  50. typedef struct {
  51.     ngx_uint_t                 access;
  52.     ngx_uint_t                 path_access;
  53.     time_t                     time;
  54.     ngx_fd_t                   fd;

  55.     unsigned                   create_path:1;
  56.     unsigned                   delete_file:1;

  57.     ngx_log_t                 *log;
  58. } ngx_ext_rename_file_t;


  59. typedef struct {
  60.     off_t                      size;
  61.     size_t                     buf_size;

  62.     ngx_uint_t                 access;
  63.     time_t                     time;

  64.     ngx_log_t                 *log;
  65. } ngx_copy_file_t;


  66. typedef struct ngx_tree_ctx_s  ngx_tree_ctx_t;

  67. typedef ngx_int_t (*ngx_tree_init_handler_pt) (void *ctx, void *prev);
  68. typedef ngx_int_t (*ngx_tree_handler_pt) (ngx_tree_ctx_t *ctx, ngx_str_t *name);

  69. struct ngx_tree_ctx_s {
  70.     off_t                      size;
  71.     off_t                      fs_size;
  72.     ngx_uint_t                 access;
  73.     time_t                     mtime;

  74.     ngx_tree_init_handler_pt   init_handler;
  75.     ngx_tree_handler_pt        file_handler;
  76.     ngx_tree_handler_pt        pre_tree_handler;
  77.     ngx_tree_handler_pt        post_tree_handler;
  78.     ngx_tree_handler_pt        spec_handler;

  79.     void                      *data;
  80.     size_t                     alloc;

  81.     ngx_log_t                 *log;
  82. };


  83. ngx_int_t ngx_get_full_name(ngx_pool_t *pool, ngx_str_t *prefix,
  84.     ngx_str_t *name);

  85. ssize_t ngx_write_chain_to_temp_file(ngx_temp_file_t *tf, ngx_chain_t *chain);
  86. ngx_int_t ngx_create_temp_file(ngx_file_t *file, ngx_path_t *path,
  87.     ngx_pool_t *pool, ngx_uint_t persistent, ngx_uint_t clean,
  88.     ngx_uint_t access);
  89. void ngx_create_hashed_filename(ngx_path_t *path, u_char *file, size_t len);
  90. ngx_int_t ngx_create_path(ngx_file_t *file, ngx_path_t *path);
  91. ngx_err_t ngx_create_full_path(u_char *dir, ngx_uint_t access);
  92. ngx_int_t ngx_add_path(ngx_conf_t *cf, ngx_path_t **slot);
  93. ngx_int_t ngx_create_paths(ngx_cycle_t *cycle, ngx_uid_t user);
  94. ngx_int_t ngx_ext_rename_file(ngx_str_t *src, ngx_str_t *to,
  95.     ngx_ext_rename_file_t *ext);
  96. ngx_int_t ngx_copy_file(u_char *from, u_char *to, ngx_copy_file_t *cf);
  97. ngx_int_t ngx_walk_tree(ngx_tree_ctx_t *ctx, ngx_str_t *tree);

  98. ngx_atomic_uint_t ngx_next_temp_number(ngx_uint_t collision);

  99. char *ngx_conf_set_path_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  100. char *ngx_conf_merge_path_value(ngx_conf_t *cf, ngx_path_t **path,
  101.     ngx_path_t *prev, ngx_path_init_t *init);
  102. char *ngx_conf_set_access_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);


  103. extern ngx_atomic_t      *ngx_temp_number;
  104. extern ngx_atomic_int_t   ngx_random_number;


  105. #endif /* _NGX_FILE_H_INCLUDED_ */