One Level Up Top Level

src/http/ngx_http_cache.h - nginx-1.7.10

Data types defined

Macros defined

Source code


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


  8. #ifndef _NGX_HTTP_CACHE_H_INCLUDED_
  9. ‌#define _NGX_HTTP_CACHE_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>
  14. #include <ngx_http.h>


  17. ‌#define NGX_HTTP_CACHE_MISS          1
  18. ‌#define NGX_HTTP_CACHE_BYPASS        2
  19. ‌#define NGX_HTTP_CACHE_EXPIRED       3
  20. ‌#define NGX_HTTP_CACHE_STALE         4
  21. ‌#define NGX_HTTP_CACHE_UPDATING      5
  22. ‌#define NGX_HTTP_CACHE_REVALIDATED   6
  23. ‌#define NGX_HTTP_CACHE_HIT           7
  24. ‌#define NGX_HTTP_CACHE_SCARCE        8

  26. ‌#define NGX_HTTP_CACHE_KEY_LEN       16
  27. ‌#define NGX_HTTP_CACHE_ETAG_LEN      42
  28. ‌#define NGX_HTTP_CACHE_VARY_LEN      42

  30. ‌#define NGX_HTTP_CACHE_VERSION       3


  33. typedef struct {
  34.     ngx_uint_t                       status;
  35.     time_t                           valid;
  36. ‌} ngx_http_cache_valid_t;


  39. typedef struct {
  40.     ngx_rbtree_node_t                node;
  41.     ngx_queue_t                      queue;

  43.     u_char                           key[NGX_HTTP_CACHE_KEY_LEN
  44.                                          - sizeof(ngx_rbtree_key_t)];

  46.     unsigned                         count:20;
  47.     unsigned                         uses:10;
  48.     unsigned                         valid_msec:10;
  49.     unsigned                         error:10;
  50.     unsigned                         exists:1;
  51.     unsigned                         updating:1;
  52.     unsigned                         deleting:1;
  53.                                      /* 11 unused bits */

  55.     ngx_file_uniq_t                  uniq;
  56.     time_t                           expire;
  57.     time_t                           valid_sec;
  58.     size_t                           body_start;
  59.     off_t                            fs_size;
  60.     ngx_msec_t                       lock_time;
  61. ‌} ngx_http_file_cache_node_t;


  64. ‌struct ngx_http_cache_s {
  65.     ngx_file_t                       file;
  66.     ngx_array_t                      keys;
  67.     uint32_t                         crc32;
  68.     u_char                           key[NGX_HTTP_CACHE_KEY_LEN];
  69.     u_char                           main[NGX_HTTP_CACHE_KEY_LEN];

  71.     ngx_file_uniq_t                  uniq;
  72.     time_t                           valid_sec;
  73.     time_t                           last_modified;
  74.     time_t                           date;

  76.     ngx_str_t                        etag;
  77.     ngx_str_t                        vary;
  78.     u_char                           variant[NGX_HTTP_CACHE_KEY_LEN];

  80.     size_t                           header_start;
  81.     size_t                           body_start;
  82.     off_t                            length;
  83.     off_t                            fs_size;

  85.     ngx_uint_t                       min_uses;
  86.     ngx_uint_t                       error;
  87.     ngx_uint_t                       valid_msec;

  89.     ngx_buf_t                       *buf;

  91.     ngx_http_file_cache_t           *file_cache;
  92.     ngx_http_file_cache_node_t      *node;

  94.     ngx_msec_t                       lock_timeout;
  95.     ngx_msec_t                       lock_age;
  96.     ngx_msec_t                       lock_time;
  97.     ngx_msec_t                       wait_time;

  99.     ngx_event_t                      wait_event;

  101.     unsigned                         lock:1;
  102.     unsigned                         waiting:1;

  104.     unsigned                         updated:1;
  105.     unsigned                         updating:1;
  106.     unsigned                         exists:1;
  107.     unsigned                         temp_file:1;
  108.     unsigned                         reading:1;
  109.     unsigned                         secondary:1;
  110. };


  113. typedef struct {
  114.     ngx_uint_t                       version;
  115.     time_t                           valid_sec;
  116.     time_t                           last_modified;
  117.     time_t                           date;
  118.     uint32_t                         crc32;
  119.     u_short                          valid_msec;
  120.     u_short                          header_start;
  121.     u_short                          body_start;
  122.     u_char                           etag_len;
  123.     u_char                           etag[NGX_HTTP_CACHE_ETAG_LEN];
  124.     u_char                           vary_len;
  125.     u_char                           vary[NGX_HTTP_CACHE_VARY_LEN];
  126.     u_char                           variant[NGX_HTTP_CACHE_KEY_LEN];
  127. ‌} ngx_http_file_cache_header_t;


  130. typedef struct {
  131.     ngx_rbtree_t                     rbtree;
  132.     ngx_rbtree_node_t                sentinel;
  133.     ngx_queue_t                      queue;
  134.     ngx_atomic_t                     cold;
  135.     ngx_atomic_t                     loading;
  136.     off_t                            size;
  137. ‌} ngx_http_file_cache_sh_t;


  140. ‌struct ngx_http_file_cache_s {
  141.     ngx_http_file_cache_sh_t        *sh;
  142.     ngx_slab_pool_t                 *shpool;

  144.     ngx_path_t                      *path;
  145.     ngx_path_t                      *temp_path;

  147.     off_t                            max_size;
  148.     size_t                           bsize;

  150.     time_t                           inactive;

  152.     ngx_uint_t                       files;
  153.     ngx_uint_t                       loader_files;
  154.     ngx_msec_t                       last;
  155.     ngx_msec_t                       loader_sleep;
  156.     ngx_msec_t                       loader_threshold;

  158.     ngx_shm_zone_t                  *shm_zone;
  159. };


  162. ngx_int_t ngx_http_file_cache_new(ngx_http_request_t *r);
  163. ngx_int_t ngx_http_file_cache_create(ngx_http_request_t *r);
  164. void ngx_http_file_cache_create_key(ngx_http_request_t *r);
  165. ngx_int_t ngx_http_file_cache_open(ngx_http_request_t *r);
  166. ngx_int_t ngx_http_file_cache_set_header(ngx_http_request_t *r, u_char *buf);
  167. void ngx_http_file_cache_update(ngx_http_request_t *r, ngx_temp_file_t *tf);
  168. void ngx_http_file_cache_update_header(ngx_http_request_t *r);
  169. ngx_int_t ngx_http_cache_send(ngx_http_request_t *);
  170. void ngx_http_file_cache_free(ngx_http_cache_t *c, ngx_temp_file_t *tf);
  171. time_t ngx_http_file_cache_valid(ngx_array_t *cache_valid, ngx_uint_t status);

  173. char *ngx_http_file_cache_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  174.     void *conf);
  175. char *ngx_http_file_cache_valid_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  176.     void *conf);


  179. extern ngx_str_t  ngx_http_cache_status[];


  182. #endif /* _NGX_HTTP_CACHE_H_INCLUDED_ */

One Level Up Top Level