src/http/ngx_http_cache.h

   1
   2 /*
   3  * Copyright (C) Igor Sysoev
   4  */
   5
   6
   7 #ifndef _NGX_HTTP_CACHE_H_INCLUDED_
   8 #define _NGX_HTTP_CACHE_H_INCLUDED_
   9
  10
  11 #include <ngx_config.h>
  12 #include <ngx_core.h>
  13 #include <ngx_http.h>
  14
  15
  16 #define NGX_HTTP_CACHE_MISS          1
  17 #define NGX_HTTP_CACHE_EXPIRED       2
  18 #define NGX_HTTP_CACHE_STALE         3
  19 #define NGX_HTTP_CACHE_UPDATING      4
  20 #define NGX_HTTP_CACHE_HIT           5
  21
  22 #define NGX_HTTP_CACHE_KEY_LEN       16
  23
  24
  25 typedef struct {
  26     ngx_uint_t                       status;
  27     time_t                           valid;
  28 } ngx_http_cache_valid_t;
  29
  30
  31 typedef struct {
  32     ngx_rbtree_node_t                node;
  33     ngx_queue_t                      queue;
  34
  35     u_char                           key[NGX_HTTP_CACHE_KEY_LEN
  36                                          - sizeof(ngx_rbtree_key_t)];
  37
  38     unsigned                         count:20;
  39     unsigned                         uses:10;
  40     unsigned                         valid_msec:10;
  41     unsigned                         error:10;
  42     unsigned                         exists:1;
  43     unsigned                         updating:1;
  44                                      /* 12 unused bits */
  45
  46     ngx_file_uniq_t                  uniq;
  47     time_t                           expire;
  48     time_t                           valid_sec;
  49     size_t                           body_start;
  50     off_t                            length;
  51 } ngx_http_file_cache_node_t;
  52
  53
  54 struct ngx_http_cache_s {
  55     ngx_file_t                       file;
  56     ngx_array_t                      keys;
  57     uint32_t                         crc32;
  58     u_char                           key[NGX_HTTP_CACHE_KEY_LEN];
  59
  60     ngx_file_uniq_t                  uniq;
  61     time_t                           valid_sec;
  62     time_t                           last_modified;
  63     time_t                           date;
  64
  65     size_t                           header_start;
  66     size_t                           body_start;
  67     off_t                            length;
  68
  69     ngx_uint_t                       min_uses;
  70     ngx_uint_t                       error;
  71     ngx_uint_t                       valid_msec;
  72
  73     ngx_buf_t                       *buf;
  74
  75     ngx_http_file_cache_t           *file_cache;
  76     ngx_http_file_cache_node_t      *node;
  77
  78     unsigned                         updated:1;
  79     unsigned                         exists:1;
  80     unsigned                         temp_file:1;
  81 };
  82
  83
  84 typedef struct {
  85     time_t                           valid_sec;
  86     time_t                           last_modified;
  87     time_t                           date;
  88     uint32_t                         crc32;
  89     u_short                          valid_msec;
  90     u_short                          header_start;
  91     u_short                          body_start;
  92 } ngx_http_file_cache_header_t;
  93
  94
  95 typedef struct {
  96     ngx_rbtree_t                     rbtree;
  97     ngx_rbtree_node_t                sentinel;
  98     ngx_queue_t                      queue;
  99     ngx_atomic_t                     cold;
 100     ngx_atomic_t                     loading;
 101     off_t                            size;
 102 } ngx_http_file_cache_sh_t;
 103
 104
 105 struct ngx_http_file_cache_s {
 106     ngx_http_file_cache_sh_t        *sh;
 107     ngx_slab_pool_t                 *shpool;
 108
 109     ngx_path_t                      *path;
 110
 111     off_t                            max_size;
 112     size_t                           bsize;
 113
 114     time_t                           inactive;
 115
 116     ngx_msec_t                       last;
 117     ngx_uint_t                       files;
 118
 119     ngx_shm_zone_t                  *shm_zone;
 120 };
 121
 122
 123 void ngx_http_file_cache_create_key(ngx_http_request_t *r);
 124 ngx_int_t ngx_http_file_cache_open(ngx_http_request_t *r);
 125 void ngx_http_file_cache_set_header(ngx_http_request_t *r, u_char *buf);
 126 void ngx_http_file_cache_update(ngx_http_request_t *r, ngx_temp_file_t *tf);
 127 ngx_int_t ngx_http_cache_send(ngx_http_request_t *);
 128 void ngx_http_file_cache_free(ngx_http_request_t *r, ngx_temp_file_t *tf);
 129 time_t ngx_http_file_cache_valid(ngx_array_t *cache_valid, ngx_uint_t status);
 130
 131 char *ngx_http_file_cache_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
 132     void *conf);
 133 char *ngx_http_file_cache_valid_set_slot(ngx_conf_t *cf, ngx_command_t *cmd,
 134     void *conf);
 135
 136 extern ngx_str_t  ngx_http_cache_status[];
 137
 138
 139 #endif /* _NGX_HTTP_CACHE_H_INCLUDED_ */