src/core/ngx_open_file_cache.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. #include <ngx_config.h>
  6. #include <ngx_core.h>


  7. #ifndef _NGX_OPEN_FILE_CACHE_H_INCLUDED_
  8. #define _NGX_OPEN_FILE_CACHE_H_INCLUDED_


  9. #define NGX_OPEN_FILE_DIRECTIO_OFF  NGX_MAX_OFF_T_VALUE


  10. typedef struct {
  11.     ngx_fd_t                 fd;
  12.     ngx_file_uniq_t          uniq;
  13.     time_t                   mtime;
  14.     off_t                    size;
  15.     off_t                    fs_size;
  16.     off_t                    directio;
  17.     size_t                   read_ahead;

  18.     ngx_err_t                err;
  19.     char                    *failed;

  20.     time_t                   valid;

  21.     ngx_uint_t               min_uses;

  22. #if (NGX_HAVE_OPENAT)
  23.     size_t                   disable_symlinks_from;
  24.     unsigned                 disable_symlinks:2;
  25. #endif

  26.     unsigned                 test_dir:1;
  27.     unsigned                 test_only:1;
  28.     unsigned                 log:1;
  29.     unsigned                 errors:1;
  30.     unsigned                 events:1;

  31.     unsigned                 is_dir:1;
  32.     unsigned                 is_file:1;
  33.     unsigned                 is_link:1;
  34.     unsigned                 is_exec:1;
  35.     unsigned                 is_directio:1;
  36. } ngx_open_file_info_t;


  37. typedef struct ngx_cached_open_file_s  ngx_cached_open_file_t;

  38. struct ngx_cached_open_file_s {
  39.     ngx_rbtree_node_t        node;
  40.     ngx_queue_t              queue;

  41.     u_char                  *name;
  42.     time_t                   created;
  43.     time_t                   accessed;

  44.     ngx_fd_t                 fd;
  45.     ngx_file_uniq_t          uniq;
  46.     time_t                   mtime;
  47.     off_t                    size;
  48.     ngx_err_t                err;

  49.     uint32_t                 uses;

  50. #if (NGX_HAVE_OPENAT)
  51.     size_t                   disable_symlinks_from;
  52.     unsigned                 disable_symlinks:2;
  53. #endif

  54.     unsigned                 count:24;
  55.     unsigned                 close:1;
  56.     unsigned                 use_event:1;

  57.     unsigned                 is_dir:1;
  58.     unsigned                 is_file:1;
  59.     unsigned                 is_link:1;
  60.     unsigned                 is_exec:1;
  61.     unsigned                 is_directio:1;

  62.     ngx_event_t             *event;
  63. };


  64. typedef struct {
  65.     ngx_rbtree_t             rbtree;
  66.     ngx_rbtree_node_t        sentinel;
  67.     ngx_queue_t              expire_queue;

  68.     ngx_uint_t               current;
  69.     ngx_uint_t               max;
  70.     time_t                   inactive;
  71. } ngx_open_file_cache_t;


  72. typedef struct {
  73.     ngx_open_file_cache_t   *cache;
  74.     ngx_cached_open_file_t  *file;
  75.     ngx_uint_t               min_uses;
  76.     ngx_log_t               *log;
  77. } ngx_open_file_cache_cleanup_t;


  78. typedef struct {

  79.     /* ngx_connection_t stub to allow use c->fd as event ident */
  80.     void                    *data;
  81.     ngx_event_t             *read;
  82.     ngx_event_t             *write;
  83.     ngx_fd_t                 fd;

  84.     ngx_cached_open_file_t  *file;
  85.     ngx_open_file_cache_t   *cache;
  86. } ngx_open_file_cache_event_t;


  87. ngx_open_file_cache_t *ngx_open_file_cache_init(ngx_pool_t *pool,
  88.     ngx_uint_t max, time_t inactive);
  89. ngx_int_t ngx_open_cached_file(ngx_open_file_cache_t *cache, ngx_str_t *name,
  90.     ngx_open_file_info_t *of, ngx_pool_t *pool);


  91. #endif /* _NGX_OPEN_FILE_CACHE_H_INCLUDED_ */