blob: d46a8bb34e59282cc7d75d54c5b60cd8ebedbf0f [file] [log] [blame]
William Lallemand41db4602017-10-30 11:15:51 +01001/*
2 * Cache management
3 *
4 * Copyright 2017 HAProxy Technologies
5 * William Lallemand <wlallemand@haproxy.com>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 */
12
William Lallemand41db4602017-10-30 11:15:51 +010013#include <eb32tree.h>
William Lallemandf528fff2017-11-23 19:43:17 +010014#include <import/sha1.h>
William Lallemand41db4602017-10-30 11:15:51 +010015
William Lallemand75d93292017-11-21 20:01:24 +010016#include <types/action.h>
William Lallemand1f49a362017-11-21 20:01:26 +010017#include <types/cli.h>
William Lallemand75d93292017-11-21 20:01:24 +010018#include <types/filters.h>
19#include <types/proxy.h>
20#include <types/shctx.h>
21
William Lallemand41db4602017-10-30 11:15:51 +010022#include <proto/channel.h>
William Lallemand1f49a362017-11-21 20:01:26 +010023#include <proto/cli.h>
William Lallemand41db4602017-10-30 11:15:51 +010024#include <proto/proxy.h>
25#include <proto/hdr_idx.h>
Christopher Faulet54a8d5a2018-12-07 12:21:11 +010026#include <proto/http_htx.h>
William Lallemand41db4602017-10-30 11:15:51 +010027#include <proto/filters.h>
Willy Tarreau61c112a2018-10-02 16:43:32 +020028#include <proto/http_rules.h>
William Lallemand41db4602017-10-30 11:15:51 +010029#include <proto/proto_http.h>
30#include <proto/log.h>
31#include <proto/stream.h>
32#include <proto/stream_interface.h>
33#include <proto/shctx.h>
34
William Lallemand41db4602017-10-30 11:15:51 +010035
36#include <common/cfgparse.h>
37#include <common/hash.h>
Willy Tarreaub96b77e2018-12-11 10:22:41 +010038#include <common/htx.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010039#include <common/initcall.h>
William Lallemand41db4602017-10-30 11:15:51 +010040
41/* flt_cache_store */
Christopher Faulet1f672c52018-12-03 14:30:41 +010042#define CACHE_F_LEGACY_HTTP 0x00000001 /* The cache is used to store raw HTTP
43 * messages (legacy implementation) */
44#define CACHE_F_HTX 0x00000002 /* The cache is used to store HTX messages */
William Lallemand41db4602017-10-30 11:15:51 +010045
Christopher Faulet27d93c32018-12-15 22:32:02 +010046#define CACHE_FLT_F_IMPLICIT_DECL 0x00000001 /* The cache filtre was implicitly declared (ie without
Christopher Faulet99a17a22018-12-11 09:18:27 +010047 * the filter keyword) */
Christopher Fauletafd819c2018-12-11 08:57:45 +010048
Christopher Fauletf4a4ef72018-12-07 17:39:53 +010049const char *cache_store_flt_id = "cache store filter";
William Lallemand41db4602017-10-30 11:15:51 +010050
Willy Tarreau2231b632019-03-29 18:26:52 +010051extern struct applet http_cache_applet;
William Lallemand41db4602017-10-30 11:15:51 +010052
53struct flt_ops cache_ops;
54
55struct cache {
Willy Tarreaufd5efb52017-11-26 08:54:31 +010056 struct list list; /* cache linked list */
William Lallemand41db4602017-10-30 11:15:51 +010057 struct eb_root entries; /* head of cache entries based on keys */
Willy Tarreaufd5efb52017-11-26 08:54:31 +010058 unsigned int maxage; /* max-age */
59 unsigned int maxblocks;
Frédéric Lécaille4eba5442018-10-25 20:29:31 +020060 unsigned int maxobjsz; /* max-object-size (in bytes) */
Willy Tarreaufd5efb52017-11-26 08:54:31 +010061 char id[33]; /* cache name */
Christopher Faulet1f672c52018-12-03 14:30:41 +010062 unsigned int flags; /* CACHE_F_* */
William Lallemand41db4602017-10-30 11:15:51 +010063};
64
Christopher Faulet95220e22018-12-07 17:34:39 +010065/* cache config for filters */
66struct cache_flt_conf {
67 union {
68 struct cache *cache; /* cache used by the filter */
69 char *name; /* cache name used during conf parsing */
70 } c;
71 unsigned int flags; /* CACHE_FLT_F_* */
72};
73
William Lallemand41db4602017-10-30 11:15:51 +010074/*
75 * cache ctx for filters
76 */
77struct cache_st {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +010078 int hdrs_len; // field used in legacy mode only
William Lallemand41db4602017-10-30 11:15:51 +010079 struct shared_block *first_block;
80};
81
82struct cache_entry {
83 unsigned int latest_validation; /* latest validation date */
84 unsigned int expire; /* expiration date */
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +020085 unsigned int age; /* Origin server "Age" header value */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +010086 unsigned int eoh; /* Origin server end of headers offset. */ // field used in legacy mode only
87
William Lallemand41db4602017-10-30 11:15:51 +010088 struct eb32_node eb; /* ebtree node used to hold the cache object */
William Lallemandf528fff2017-11-23 19:43:17 +010089 char hash[20];
William Lallemand41db4602017-10-30 11:15:51 +010090 unsigned char data[0];
91};
92
93#define CACHE_BLOCKSIZE 1024
Willy Tarreau96062a12018-11-11 14:00:28 +010094#define CACHE_ENTRY_MAX_AGE 2147483648U
William Lallemand41db4602017-10-30 11:15:51 +010095
96static struct list caches = LIST_HEAD_INIT(caches);
97static struct cache *tmp_cache_config = NULL;
98
Willy Tarreau8ceae722018-11-26 11:58:30 +010099DECLARE_STATIC_POOL(pool_head_cache_st, "cache_st", sizeof(struct cache_st));
100
William Lallemandf528fff2017-11-23 19:43:17 +0100101struct cache_entry *entry_exist(struct cache *cache, char *hash)
William Lallemand4da3f8a2017-10-31 14:33:34 +0100102{
103 struct eb32_node *node;
104 struct cache_entry *entry;
105
William Lallemandf528fff2017-11-23 19:43:17 +0100106 node = eb32_lookup(&cache->entries, (*(unsigned int *)hash));
William Lallemand4da3f8a2017-10-31 14:33:34 +0100107 if (!node)
108 return NULL;
109
110 entry = eb32_entry(node, struct cache_entry, eb);
William Lallemandf528fff2017-11-23 19:43:17 +0100111
112 /* if that's not the right node */
113 if (memcmp(entry->hash, hash, sizeof(entry->hash)))
114 return NULL;
115
William Lallemand08727662017-11-21 20:01:27 +0100116 if (entry->expire > now.tv_sec) {
William Lallemand4da3f8a2017-10-31 14:33:34 +0100117 return entry;
William Lallemand08727662017-11-21 20:01:27 +0100118 } else {
William Lallemand4da3f8a2017-10-31 14:33:34 +0100119 eb32_delete(node);
William Lallemand08727662017-11-21 20:01:27 +0100120 entry->eb.key = 0;
121 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100122 return NULL;
123
124}
125
126static inline struct shared_context *shctx_ptr(struct cache *cache)
127{
128 return (struct shared_context *)((unsigned char *)cache - ((struct shared_context *)NULL)->data);
129}
130
William Lallemand77c11972017-10-31 20:43:01 +0100131static inline struct shared_block *block_ptr(struct cache_entry *entry)
132{
133 return (struct shared_block *)((unsigned char *)entry - ((struct shared_block *)NULL)->data);
134}
135
136
137
William Lallemand41db4602017-10-30 11:15:51 +0100138static int
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100139cache_store_init(struct proxy *px, struct flt_conf *fconf)
William Lallemand41db4602017-10-30 11:15:51 +0100140{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100141 fconf->flags |= FLT_CFG_FL_HTX;
William Lallemand41db4602017-10-30 11:15:51 +0100142 return 0;
143}
144
Christopher Faulet95220e22018-12-07 17:34:39 +0100145static void
146cache_store_deinit(struct proxy *px, struct flt_conf *fconf)
147{
148 struct cache_flt_conf *cconf = fconf->conf;
149
150 free(cconf);
151}
152
William Lallemand4da3f8a2017-10-31 14:33:34 +0100153static int
Christopher Faulet95220e22018-12-07 17:34:39 +0100154cache_store_check(struct proxy *px, struct flt_conf *fconf)
155{
156 struct cache_flt_conf *cconf = fconf->conf;
Christopher Fauletafd819c2018-12-11 08:57:45 +0100157 struct flt_conf *f;
Christopher Faulet95220e22018-12-07 17:34:39 +0100158 struct cache *cache;
Christopher Faulet27d93c32018-12-15 22:32:02 +0100159 int comp = 0;
Christopher Faulet95220e22018-12-07 17:34:39 +0100160
161 /* resolve the cache name to a ptr in the filter config */
162 list_for_each_entry(cache, &caches, list) {
163 if (!strcmp(cache->id, cconf->c.name)) {
164 /* there can be only one filter per cache, so we free it there */
165 cache->flags |= ((px->options2 & PR_O2_USE_HTX)
166 ? CACHE_F_HTX
167 : CACHE_F_LEGACY_HTTP);
168
169 free(cconf->c.name);
170 cconf->c.cache = cache;
171 goto found;
172 }
173 }
174
175 ha_alert("config: %s '%s': unable to find the cache '%s' referenced by the filter 'cache'.\n",
176 proxy_type_str(px), px->id, (char *)cconf->c.name);
177 return 1;
178
179 found:
Christopher Fauletafd819c2018-12-11 08:57:45 +0100180 /* Here <cache> points on the cache the filter must use and <cconf>
181 * points on the cache filter configuration. */
182
183 /* Check all filters for proxy <px> to know if the compression is
Christopher Faulet27d93c32018-12-15 22:32:02 +0100184 * enabled and if it is after the cache. When the compression is before
185 * the cache, an error is returned. Also check if the cache filter must
186 * be explicitly declaired or not. */
Christopher Fauletafd819c2018-12-11 08:57:45 +0100187 list_for_each_entry(f, &px->filter_configs, list) {
188 if (f == fconf) {
Christopher Faulet27d93c32018-12-15 22:32:02 +0100189 /* The compression filter must be evaluated after the cache. */
190 if (comp) {
191 ha_alert("config: %s '%s': unable to enable the compression filter before "
192 "the cache '%s'.\n", proxy_type_str(px), px->id, cache->id);
193 return 1;
194 }
Christopher Faulet99a17a22018-12-11 09:18:27 +0100195 }
Christopher Faulet27d93c32018-12-15 22:32:02 +0100196 else if (f->id == http_comp_flt_id) {
Christopher Fauletafd819c2018-12-11 08:57:45 +0100197 if (!(px->options2 & PR_O2_USE_HTX)) {
198 ha_alert("config: %s '%s' : compression and cache filters cannot be "
199 "both enabled on non HTX proxy.\n",
200 proxy_type_str(px), px->id);
201 return 1;
202 }
Christopher Faulet27d93c32018-12-15 22:32:02 +0100203 comp = 1;
Christopher Fauletafd819c2018-12-11 08:57:45 +0100204 }
Christopher Faulet27d93c32018-12-15 22:32:02 +0100205 else if ((f->id != fconf->id) && (cconf->flags & CACHE_FLT_F_IMPLICIT_DECL)) {
206 /* Implicit declaration is only allowed with the
207 * compression. For other filters, an implicit
208 * declaration is required. */
209 ha_alert("config: %s '%s': require an explicit filter declaration "
210 "to use the cache '%s'.\n", proxy_type_str(px), px->id, cache->id);
211 return 1;
212 }
213
Christopher Fauletafd819c2018-12-11 08:57:45 +0100214 }
Christopher Faulet95220e22018-12-07 17:34:39 +0100215 return 0;
216}
217
218static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100219cache_store_chn_start_analyze(struct stream *s, struct filter *filter, struct channel *chn)
220{
221 if (!(chn->flags & CF_ISRESP))
222 return 1;
223
224 if (filter->ctx == NULL) {
225 struct cache_st *st;
226
Willy Tarreaubafbe012017-11-24 17:34:44 +0100227 st = pool_alloc_dirty(pool_head_cache_st);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100228 if (st == NULL)
229 return -1;
230
231 st->hdrs_len = 0;
232 st->first_block = NULL;
233 filter->ctx = st;
Christopher Faulet839791a2019-01-07 16:12:07 +0100234
235 /* Register post-analyzer on AN_RES_WAIT_HTTP */
236 filter->post_analyzers |= AN_RES_WAIT_HTTP;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100237 }
238
William Lallemand4da3f8a2017-10-31 14:33:34 +0100239 return 1;
240}
241
242static int
William Lallemand49dc0482017-11-24 14:33:54 +0100243cache_store_chn_end_analyze(struct stream *s, struct filter *filter, struct channel *chn)
244{
245 struct cache_st *st = filter->ctx;
Christopher Faulet95220e22018-12-07 17:34:39 +0100246 struct cache_flt_conf *cconf = FLT_CONF(filter);
247 struct cache *cache = cconf->c.cache;
William Lallemand49dc0482017-11-24 14:33:54 +0100248 struct shared_context *shctx = shctx_ptr(cache);
249
250 if (!(chn->flags & CF_ISRESP))
251 return 1;
252
253 /* Everything should be released in the http_end filter, but we need to do it
254 * there too, in case of errors */
255
256 if (st && st->first_block) {
257
258 shctx_lock(shctx);
259 shctx_row_dec_hot(shctx, st->first_block);
260 shctx_unlock(shctx);
261
262 }
263 if (st) {
Willy Tarreaubafbe012017-11-24 17:34:44 +0100264 pool_free(pool_head_cache_st, st);
William Lallemand49dc0482017-11-24 14:33:54 +0100265 filter->ctx = NULL;
266 }
267
268 return 1;
269}
270
Christopher Faulet839791a2019-01-07 16:12:07 +0100271static int
272cache_store_post_analyze(struct stream *s, struct filter *filter, struct channel *chn,
273 unsigned an_bit)
274{
275 struct http_txn *txn = s->txn;
276 struct http_msg *msg = &txn->rsp;
277 struct cache_st *st = filter->ctx;
278
279 if (an_bit != AN_RES_WAIT_HTTP)
280 goto end;
281
282 /* Here we need to check if any compression filter precedes the cache
283 * filter. This is only possible when the compression is configured in
284 * the frontend while the cache filter is configured on the
285 * backend. This case cannot be detected during HAProxy startup. So in
286 * such cases, the cache is disabled.
287 */
288 if (st && (msg->flags & HTTP_MSGF_COMPRESSING)) {
289 pool_free(pool_head_cache_st, st);
290 filter->ctx = NULL;
291 }
292
293 end:
294 return 1;
295}
William Lallemand49dc0482017-11-24 14:33:54 +0100296
297static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100298cache_store_http_headers(struct stream *s, struct filter *filter, struct http_msg *msg)
299{
300 struct cache_st *st = filter->ctx;
301
William Lallemand4da3f8a2017-10-31 14:33:34 +0100302 if (!(msg->chn->flags & CF_ISRESP) || !st)
303 return 1;
304
Christopher Faulet67658c92018-12-06 21:59:39 +0100305 if (st->first_block) {
306 register_data_filter(s, msg->chn, filter);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100307 if (!IS_HTX_STRM(s))
308 st->hdrs_len = msg->sov;
Christopher Faulet67658c92018-12-06 21:59:39 +0100309 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100310 return 1;
311}
312
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200313static inline void disable_cache_entry(struct cache_st *st,
314 struct filter *filter, struct shared_context *shctx)
315{
316 struct cache_entry *object;
317
318 object = (struct cache_entry *)st->first_block->data;
319 filter->ctx = NULL; /* disable cache */
320 shctx_lock(shctx);
321 shctx_row_dec_hot(shctx, st->first_block);
322 object->eb.key = 0;
323 shctx_unlock(shctx);
324 pool_free(pool_head_cache_st, st);
325}
326
William Lallemand4da3f8a2017-10-31 14:33:34 +0100327static int
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100328cache_store_http_payload(struct stream *s, struct filter *filter, struct http_msg *msg,
329 unsigned int offset, unsigned int len)
330{
Christopher Faulet95220e22018-12-07 17:34:39 +0100331 struct cache_flt_conf *cconf = FLT_CONF(filter);
332 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100333 struct cache_st *st = filter->ctx;
334 struct htx *htx = htxbuf(&msg->chn->buf);
335 struct htx_blk *blk;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200336 struct shared_block *fb;
337 unsigned int orig_len, to_forward;
338 int ret;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100339
340 if (!len)
341 return len;
342
343 if (!st->first_block) {
344 unregister_data_filter(s, msg->chn, filter);
345 return len;
346 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100347
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200348 chunk_reset(&trash);
349 orig_len = len;
350 to_forward = 0;
Christopher Fauletee847d42019-05-23 11:55:33 +0200351 for (blk = htx_get_first_blk(htx); blk && len; blk = htx_get_next_blk(htx, blk)) {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100352 enum htx_blk_type type = htx_get_blk_type(blk);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200353 uint32_t info, sz = htx_get_blksz(blk);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100354 struct ist v;
355
Christopher Fauletee847d42019-05-23 11:55:33 +0200356 if (offset >= sz) {
357 offset -= sz;
358 continue;
359 }
360
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100361 switch (type) {
362 case HTX_BLK_UNUSED:
363 break;
364
365 case HTX_BLK_DATA:
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100366 v = htx_get_blk_value(htx, blk);
367 v.ptr += offset;
368 v.len -= offset;
369 if (v.len > len)
370 v.len = len;
371
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200372 info = (type << 28) + v.len;
373 chunk_memcat(&trash, (char *)&info, sizeof(info));
374 chunk_memcat(&trash, v.ptr, v.len);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100375 to_forward += v.len;
376 len -= v.len;
377 break;
378
379 default:
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200380 /* Here offset must always be 0 because only
381 * DATA blocks can be partially transferred. */
382 if (offset)
383 goto no_cache;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100384 if (sz > len)
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200385 goto end;
386
387 chunk_memcat(&trash, (char *)&blk->info, sizeof(blk->info));
388 chunk_memcat(&trash, htx_get_blk_ptr(htx, blk), sz);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100389 to_forward += sz;
390 len -= sz;
391 break;
392 }
393
394 offset = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100395 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200396
397 end:
398 shctx_lock(shctx);
399 fb = shctx_row_reserve_hot(shctx, st->first_block, trash.data);
400 if (!fb) {
401 shctx_unlock(shctx);
402 goto no_cache;
403 }
404 shctx_unlock(shctx);
405
406 ret = shctx_row_data_append(shctx, st->first_block, st->first_block->last_append,
407 (unsigned char *)b_head(&trash), b_data(&trash));
408 if (ret < 0)
409 goto no_cache;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100410
411 return to_forward;
412
413 no_cache:
414 disable_cache_entry(st, filter, shctx);
415 unregister_data_filter(s, msg->chn, filter);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200416 return orig_len;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100417}
418
419static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100420cache_store_http_forward_data(struct stream *s, struct filter *filter,
421 struct http_msg *msg, unsigned int len)
422{
423 struct cache_st *st = filter->ctx;
Christopher Faulet95220e22018-12-07 17:34:39 +0100424 struct cache_flt_conf *cconf = FLT_CONF(filter);
425 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100426 int ret;
427
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200428 ret = 0;
429
William Lallemand4da3f8a2017-10-31 14:33:34 +0100430 /*
431 * We need to skip the HTTP headers first, because we saved them in the
432 * http-response action.
433 */
Christopher Faulet67658c92018-12-06 21:59:39 +0100434 if (!(msg->chn->flags & CF_ISRESP) || !st) {
435 /* should never happen */
436 unregister_data_filter(s, msg->chn, filter);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100437 return len;
Christopher Faulet67658c92018-12-06 21:59:39 +0100438 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100439
440 if (!len) {
Joseph Herlant8dae5b32018-11-15 14:07:53 -0800441 /* Nothing to forward */
William Lallemand4da3f8a2017-10-31 14:33:34 +0100442 ret = len;
443 }
William Lallemand10935bc2017-11-14 14:39:23 +0100444 else if (st->hdrs_len >= len) {
William Lallemand4da3f8a2017-10-31 14:33:34 +0100445 /* Forward part of headers */
446 ret = len;
447 st->hdrs_len -= len;
448 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100449 else {
William Lallemand10935bc2017-11-14 14:39:23 +0100450 /* Forward data */
Christopher Faulet67658c92018-12-06 21:59:39 +0100451 if (st->first_block) {
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200452 int to_append, append;
453 struct shared_block *fb;
454
455 to_append = MIN(ci_contig_data(msg->chn), len - st->hdrs_len);
456
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200457 shctx_lock(shctx);
458 fb = shctx_row_reserve_hot(shctx, st->first_block, to_append);
459 if (!fb) {
Olivier Houchardcd2867a2017-11-01 13:58:21 +0100460 shctx_unlock(shctx);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200461 disable_cache_entry(st, filter, shctx);
Christopher Faulet67658c92018-12-06 21:59:39 +0100462 unregister_data_filter(s, msg->chn, filter);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200463 return len;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100464 }
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200465 shctx_unlock(shctx);
466
Frédéric Lécaillea2219f52018-10-22 16:59:13 +0200467 /* Skip remaining headers to fill the cache */
468 c_adv(msg->chn, st->hdrs_len);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200469 append = shctx_row_data_append(shctx, st->first_block, st->first_block->last_append,
470 (unsigned char *)ci_head(msg->chn), to_append);
471 ret = st->hdrs_len + to_append - append;
472 /* Rewind the buffer to forward all data */
473 c_rew(msg->chn, st->hdrs_len);
474 st->hdrs_len = 0;
Christopher Faulet67658c92018-12-06 21:59:39 +0100475 if (ret < 0) {
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200476 disable_cache_entry(st, filter, shctx);
Christopher Faulet67658c92018-12-06 21:59:39 +0100477 unregister_data_filter(s, msg->chn, filter);
478 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100479 }
Christopher Faulet67658c92018-12-06 21:59:39 +0100480 else {
481 /* should never happen */
482 unregister_data_filter(s, msg->chn, filter);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200483 ret = len;
Christopher Faulet67658c92018-12-06 21:59:39 +0100484 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100485 }
486
487 if ((ret != len) ||
488 (FLT_NXT(filter, msg->chn) != FLT_FWD(filter, msg->chn) + ret))
489 task_wakeup(s->task, TASK_WOKEN_MSG);
490
491 return ret;
492}
493
494static int
495cache_store_http_end(struct stream *s, struct filter *filter,
496 struct http_msg *msg)
497{
498 struct cache_st *st = filter->ctx;
Christopher Faulet95220e22018-12-07 17:34:39 +0100499 struct cache_flt_conf *cconf = FLT_CONF(filter);
500 struct cache *cache = cconf->c.cache;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100501 struct shared_context *shctx = shctx_ptr(cache);
502 struct cache_entry *object;
503
504 if (!(msg->chn->flags & CF_ISRESP))
505 return 1;
506
507 if (st && st->first_block) {
508
509 object = (struct cache_entry *)st->first_block->data;
510
511 /* does not need to test if the insertion worked, if it
512 * doesn't, the blocks will be reused anyway */
513
514 shctx_lock(shctx);
William Lallemand08727662017-11-21 20:01:27 +0100515 if (eb32_insert(&cache->entries, &object->eb) != &object->eb) {
516 object->eb.key = 0;
517 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100518 /* remove from the hotlist */
William Lallemand4da3f8a2017-10-31 14:33:34 +0100519 shctx_row_dec_hot(shctx, st->first_block);
520 shctx_unlock(shctx);
521
522 }
523 if (st) {
Willy Tarreaubafbe012017-11-24 17:34:44 +0100524 pool_free(pool_head_cache_st, st);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100525 filter->ctx = NULL;
526 }
527
528 return 1;
529}
530
531 /*
532 * This intends to be used when checking HTTP headers for some
533 * word=value directive. Return a pointer to the first character of value, if
534 * the word was not found or if there wasn't any value assigned ot it return NULL
535 */
536char *directive_value(const char *sample, int slen, const char *word, int wlen)
537{
538 int st = 0;
539
540 if (slen < wlen)
541 return 0;
542
543 while (wlen) {
544 char c = *sample ^ *word;
545 if (c && c != ('A' ^ 'a'))
546 return NULL;
547 sample++;
548 word++;
549 slen--;
550 wlen--;
551 }
552
553 while (slen) {
554 if (st == 0) {
555 if (*sample != '=')
556 return NULL;
557 sample++;
558 slen--;
559 st = 1;
560 continue;
561 } else {
562 return (char *)sample;
563 }
564 }
565
566 return NULL;
567}
568
569/*
570 * Return the maxage in seconds of an HTTP response.
571 * Compute the maxage using either:
572 * - the assigned max-age of the cache
573 * - the s-maxage directive
574 * - the max-age directive
575 * - (Expires - Data) headers
576 * - the default-max-age of the cache
577 *
578 */
William Lallemand49b44532017-11-24 18:53:43 +0100579int http_calc_maxage(struct stream *s, struct cache *cache)
William Lallemand4da3f8a2017-10-31 14:33:34 +0100580{
William Lallemand4da3f8a2017-10-31 14:33:34 +0100581 int smaxage = -1;
582 int maxage = -1;
583
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200584
585 if (IS_HTX_STRM(s)) {
586 /* HTX mode */
587 struct htx *htx = htxbuf(&s->res.buf);
588 struct http_hdr_ctx ctx = { .blk = NULL };
William Lallemand4da3f8a2017-10-31 14:33:34 +0100589
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200590 while (http_find_header(htx, ist("cache-control"), &ctx, 0)) {
591 char *value;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100592
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200593 value = directive_value(ctx.value.ptr, ctx.value.len, "s-maxage", 8);
594 if (value) {
595 struct buffer *chk = get_trash_chunk();
William Lallemand4da3f8a2017-10-31 14:33:34 +0100596
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200597 chunk_strncat(chk, value, ctx.value.len - 8 + 1);
598 chunk_strncat(chk, "", 1);
599 maxage = atoi(chk->area);
600 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100601
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200602 value = directive_value(ctx.value.ptr, ctx.value.len, "max-age", 7);
603 if (value) {
604 struct buffer *chk = get_trash_chunk();
605
606 chunk_strncat(chk, value, ctx.value.len - 7 + 1);
607 chunk_strncat(chk, "", 1);
608 smaxage = atoi(chk->area);
609 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100610 }
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200611 }
612 else {
613 /* Legacy mode */
614 struct http_txn *txn = s->txn;
615 struct hdr_ctx ctx;
616
617 ctx.idx = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100618
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200619 /* loop on the Cache-Control values */
620 while (http_find_header2("Cache-Control", 13, ci_head(&s->res), &txn->hdr_idx, &ctx)) {
621 char *directive = ctx.line + ctx.val;
622 char *value;
623
624 value = directive_value(directive, ctx.vlen, "s-maxage", 8);
625 if (value) {
626 struct buffer *chk = get_trash_chunk();
627
628 chunk_strncat(chk, value, ctx.vlen - 8 + 1);
629 chunk_strncat(chk, "", 1);
630 maxage = atoi(chk->area);
631 }
632
633 value = directive_value(ctx.line + ctx.val, ctx.vlen, "max-age", 7);
634 if (value) {
635 struct buffer *chk = get_trash_chunk();
William Lallemand4da3f8a2017-10-31 14:33:34 +0100636
Christopher Fauleta63ae1e2019-07-15 20:49:46 +0200637 chunk_strncat(chk, value, ctx.vlen - 7 + 1);
638 chunk_strncat(chk, "", 1);
639 smaxage = atoi(chk->area);
640 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100641 }
642 }
643
644 /* TODO: Expires - Data */
645
646
647 if (smaxage > 0)
William Lallemand49b44532017-11-24 18:53:43 +0100648 return MIN(smaxage, cache->maxage);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100649
650 if (maxage > 0)
William Lallemand49b44532017-11-24 18:53:43 +0100651 return MIN(maxage, cache->maxage);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100652
William Lallemand49b44532017-11-24 18:53:43 +0100653 return cache->maxage;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100654
655}
656
657
William Lallemanda400a3a2017-11-20 19:13:12 +0100658static void cache_free_blocks(struct shared_block *first, struct shared_block *block)
659{
Willy Tarreau5bd37fa2018-04-04 20:17:03 +0200660 struct cache_entry *object = (struct cache_entry *)block->data;
661
662 if (first == block && object->eb.key)
663 eb32_delete(&object->eb);
664 object->eb.key = 0;
William Lallemanda400a3a2017-11-20 19:13:12 +0100665}
666
William Lallemand41db4602017-10-30 11:15:51 +0100667/*
668 * This fonction will store the headers of the response in a buffer and then
669 * register a filter to store the data
670 */
671enum act_return http_action_store_cache(struct act_rule *rule, struct proxy *px,
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200672 struct session *sess, struct stream *s, int flags)
William Lallemand41db4602017-10-30 11:15:51 +0100673{
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200674 unsigned int age;
675 long long hdr_age;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100676 struct http_txn *txn = s->txn;
677 struct http_msg *msg = &txn->rsp;
678 struct filter *filter;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100679 struct shared_block *first = NULL;
Christopher Faulet95220e22018-12-07 17:34:39 +0100680 struct cache_flt_conf *cconf = rule->arg.act.p[0];
681 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet839791a2019-01-07 16:12:07 +0100682 struct cache_st *cache_ctx = NULL;
683 struct cache_entry *object, *old;
Willy Tarreauc9036c02019-01-11 19:38:25 +0100684 unsigned int key = *(unsigned int *)txn->cache_hash;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100685
William Lallemand4da3f8a2017-10-31 14:33:34 +0100686 /* Don't cache if the response came from a cache */
687 if ((obj_type(s->target) == OBJ_TYPE_APPLET) &&
688 s->target == &http_cache_applet.obj_type) {
689 goto out;
690 }
691
692 /* cache only HTTP/1.1 */
693 if (!(txn->req.flags & HTTP_MSGF_VER_11))
694 goto out;
695
696 /* cache only GET method */
697 if (txn->meth != HTTP_METH_GET)
698 goto out;
699
Willy Tarreauc9036c02019-01-11 19:38:25 +0100700 /* cache key was not computed */
701 if (!key)
702 goto out;
703
William Lallemand4da3f8a2017-10-31 14:33:34 +0100704 /* cache only 200 status code */
705 if (txn->status != 200)
706 goto out;
707
Christopher Faulet839791a2019-01-07 16:12:07 +0100708 /* Find the corresponding filter instance for the current stream */
709 list_for_each_entry(filter, &s->strm_flt.filters, list) {
710 if (FLT_ID(filter) == cache_store_flt_id && FLT_CONF(filter) == cconf) {
711 /* No filter ctx, don't cache anything */
712 if (!filter->ctx)
713 goto out;
714 cache_ctx = filter->ctx;
715 break;
716 }
717 }
718
719 /* from there, cache_ctx is always defined */
720
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100721 if (IS_HTX_STRM(s)) {
722 struct htx *htx = htxbuf(&s->res.buf);
723 struct http_hdr_ctx ctx;
724 int32_t pos;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100725
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100726 /* Do not cache too big objects. */
727 if ((msg->flags & HTTP_MSGF_CNT_LEN) && shctx->max_obj_size > 0 &&
728 htx->data + htx->extra > shctx->max_obj_size)
729 goto out;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100730
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100731 /* Does not manage Vary at the moment. We will need a secondary key later for that */
732 ctx.blk = NULL;
733 if (http_find_header(htx, ist("Vary"), &ctx, 0))
734 goto out;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100735
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100736 htx_check_response_for_cacheability(s, &s->res);
737
738 if (!(txn->flags & TX_CACHEABLE) || !(txn->flags & TX_CACHE_COOK))
739 goto out;
740
741 age = 0;
742 ctx.blk = NULL;
743 if (http_find_header(htx, ist("Age"), &ctx, 0)) {
744 if (!strl2llrc(ctx.value.ptr, ctx.value.len, &hdr_age) && hdr_age > 0) {
745 if (unlikely(hdr_age > CACHE_ENTRY_MAX_AGE))
746 hdr_age = CACHE_ENTRY_MAX_AGE;
747 age = hdr_age;
748 }
749 http_remove_header(htx, &ctx);
750 }
751
752 chunk_reset(&trash);
Christopher Fauleta3f15502019-05-13 15:27:23 +0200753 for (pos = htx_get_first(htx); pos != -1; pos = htx_get_next(htx, pos)) {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100754 struct htx_blk *blk = htx_get_blk(htx, pos);
Christopher Fauletafd819c2018-12-11 08:57:45 +0100755 enum htx_blk_type type = htx_get_blk_type(blk);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100756 uint32_t sz = htx_get_blksz(blk);
757
758 chunk_memcat(&trash, (char *)&blk->info, sizeof(blk->info));
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200759 chunk_memcat(&trash, htx_get_blk_ptr(htx, blk), sz);
Christopher Fauletafd819c2018-12-11 08:57:45 +0100760 if (type == HTX_BLK_EOH)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100761 break;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100762 }
763 }
764 else {
765 struct hdr_ctx ctx;
766
767 /* Do not cache too big objects. */
768 if ((msg->flags & HTTP_MSGF_CNT_LEN) && shctx->max_obj_size > 0 &&
769 msg->sov + msg->body_len > shctx->max_obj_size)
770 goto out;
771
772 /* Does not manage Vary at the moment. We will need a secondary key later for that */
773 ctx.idx = 0;
774 if (http_find_header2("Vary", 4, ci_head(txn->rsp.chn), &txn->hdr_idx, &ctx))
775 goto out;
776
777 check_response_for_cacheability(s, &s->res);
778
779 if (!(txn->flags & TX_CACHEABLE) || !(txn->flags & TX_CACHE_COOK))
780 goto out;
781
782 age = 0;
783 ctx.idx = 0;
784 if (http_find_header2("Age", 3, ci_head(txn->rsp.chn), &txn->hdr_idx, &ctx)) {
785 if (!strl2llrc(ctx.line + ctx.val, ctx.vlen, &hdr_age) && hdr_age > 0) {
786 if (unlikely(hdr_age > CACHE_ENTRY_MAX_AGE))
787 hdr_age = CACHE_ENTRY_MAX_AGE;
788 age = hdr_age;
789 }
790 http_remove_header2(msg, &txn->hdr_idx, &ctx);
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200791 }
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200792 }
793
William Lallemand4da3f8a2017-10-31 14:33:34 +0100794 shctx_lock(shctx);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100795 if (IS_HTX_STRM(s))
796 first = shctx_row_reserve_hot(shctx, NULL, sizeof(struct cache_entry) + trash.data);
797 else
798 first = shctx_row_reserve_hot(shctx, NULL, sizeof(struct cache_entry) + msg->sov);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100799 if (!first) {
800 shctx_unlock(shctx);
801 goto out;
802 }
803 shctx_unlock(shctx);
804
Willy Tarreau1093a452018-04-06 19:02:25 +0200805 /* the received memory is not initialized, we need at least to mark
806 * the object as not indexed yet.
807 */
808 object = (struct cache_entry *)first->data;
809 object->eb.node.leaf_p = NULL;
810 object->eb.key = 0;
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200811 object->age = age;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200812 if (!IS_HTX_STRM(s))
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100813 object->eoh = msg->eoh;
Willy Tarreau1093a452018-04-06 19:02:25 +0200814
William Lallemand4da3f8a2017-10-31 14:33:34 +0100815 /* reserve space for the cache_entry structure */
816 first->len = sizeof(struct cache_entry);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200817 first->last_append = NULL;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100818 /* cache the headers in a http action because it allows to chose what
819 * to cache, for example you might want to cache a response before
820 * modifying some HTTP headers, or on the contrary after modifying
821 * those headers.
822 */
823
824 /* does not need to be locked because it's in the "hot" list,
825 * copy the headers */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100826 if (IS_HTX_STRM(s)) {
827 if (shctx_row_data_append(shctx, first, NULL, (unsigned char *)trash.area, trash.data) < 0)
828 goto out;
829 }
830 else {
831 if (shctx_row_data_append(shctx, first, NULL, (unsigned char *)ci_head(&s->res), msg->sov) < 0)
832 goto out;
833 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100834
835 /* register the buffer in the filter ctx for filling it with data*/
Christopher Faulet839791a2019-01-07 16:12:07 +0100836 if (cache_ctx) {
837 cache_ctx->first_block = first;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100838
Willy Tarreauc9036c02019-01-11 19:38:25 +0100839 object->eb.key = key;
840
Christopher Faulet839791a2019-01-07 16:12:07 +0100841 memcpy(object->hash, txn->cache_hash, sizeof(object->hash));
842 /* Insert the node later on caching success */
William Lallemand4da3f8a2017-10-31 14:33:34 +0100843
Christopher Faulet839791a2019-01-07 16:12:07 +0100844 shctx_lock(shctx);
Christopher Faulet95220e22018-12-07 17:34:39 +0100845
Christopher Faulet839791a2019-01-07 16:12:07 +0100846 old = entry_exist(cconf->c.cache, txn->cache_hash);
847 if (old) {
848 eb32_delete(&old->eb);
849 old->eb.key = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100850 }
Christopher Faulet839791a2019-01-07 16:12:07 +0100851 shctx_unlock(shctx);
852
853 /* store latest value and expiration time */
854 object->latest_validation = now.tv_sec;
855 object->expire = now.tv_sec + http_calc_maxage(s, cconf->c.cache);
856 return ACT_RET_CONT;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100857 }
858
859out:
860 /* if does not cache */
861 if (first) {
862 shctx_lock(shctx);
William Lallemand08727662017-11-21 20:01:27 +0100863 first->len = 0;
864 object->eb.key = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100865 shctx_row_dec_hot(shctx, first);
866 shctx_unlock(shctx);
867 }
868
William Lallemand41db4602017-10-30 11:15:51 +0100869 return ACT_RET_CONT;
870}
871
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200872#define HTTP_CACHE_INIT 0 /* Initial state. */
873#define HTTP_CACHE_HEADER 1 /* Cache entry headers forwarded. */
874#define HTTP_CACHE_FWD 2 /* Cache entry completely forwarded. */
875#define HTTP_CACHE_END 3 /* Cache entry treatment terminated. */
William Lallemand77c11972017-10-31 20:43:01 +0100876
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100877#define HTX_CACHE_INIT 0 /* Initial state. */
878#define HTX_CACHE_HEADER 1 /* Cache entry headers forwarding */
879#define HTX_CACHE_DATA 2 /* Cache entry data forwarding */
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200880#define HTX_CACHE_EOM 3 /* Cache entry completely forwarded. Finish the HTX message */
881#define HTX_CACHE_END 4 /* Cache entry treatment terminated */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100882
William Lallemandecb73b12017-11-24 14:33:55 +0100883static void http_cache_applet_release(struct appctx *appctx)
884{
Christopher Faulet95220e22018-12-07 17:34:39 +0100885 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
William Lallemandecb73b12017-11-24 14:33:55 +0100886 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
Christopher Faulet95220e22018-12-07 17:34:39 +0100887 struct cache *cache = cconf->c.cache;
William Lallemandecb73b12017-11-24 14:33:55 +0100888 struct shared_block *first = block_ptr(cache_ptr);
889
890 shctx_lock(shctx_ptr(cache));
891 shctx_row_dec_hot(shctx_ptr(cache), first);
892 shctx_unlock(shctx_ptr(cache));
893}
894
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200895
896static unsigned int htx_cache_dump_blk(struct appctx *appctx, struct htx *htx, enum htx_blk_type type,
897 uint32_t info, struct shared_block *shblk, unsigned int offset)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100898{
Christopher Faulet95220e22018-12-07 17:34:39 +0100899 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
900 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200901 struct htx_blk *blk;
902 unsigned int max, total;
903 uint32_t blksz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100904
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200905 max = htx_get_max_blksz(htx, channel_htx_recv_max(si_ic(appctx->owner), htx));
906 if (!max)
907 return 0;
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200908 blksz = ((type == HTX_BLK_HDR || type == HTX_BLK_TLR)
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200909 ? (info & 0xff) + ((info >> 8) & 0xfffff)
910 : info & 0xfffffff);
911 if (blksz > max)
912 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100913
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200914 blk = htx_add_blk(htx, type, blksz);
915 if (!blk)
916 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100917
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200918 blk->info = info;
919 total = 4;
920 while (blksz) {
921 max = MIN(blksz, shctx->block_size - offset);
922 memcpy(htx_get_blk_ptr(htx, blk), (const char *)shblk->data + offset, max);
923 offset += max;
924 blksz -= max;
925 total += max;
926 if (blksz || offset == shctx->block_size) {
927 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
928 offset = 0;
929 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100930 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200931 appctx->ctx.cache.offset = offset;
932 appctx->ctx.cache.next = shblk;
933 appctx->ctx.cache.sent += total;
934 return total;
935}
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100936
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200937static unsigned int htx_cache_dump_data_blk(struct appctx *appctx, struct htx *htx,
938 uint32_t info, struct shared_block *shblk, unsigned int offset)
939{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100940
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200941 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
942 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
943 unsigned int max, total, rem_data;
944 uint32_t blksz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100945
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200946 max = htx_get_max_blksz(htx, channel_htx_recv_max(si_ic(appctx->owner), htx));
947 if (!max)
948 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100949
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200950 rem_data = 0;
Christopher Fauletbda83972019-06-11 09:58:09 +0200951 if (appctx->ctx.cache.rem_data) {
952 blksz = appctx->ctx.cache.rem_data;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200953 total = 0;
Christopher Fauletbda83972019-06-11 09:58:09 +0200954 }
955 else {
956 blksz = (info & 0xfffffff);
957 total = 4;
958 }
959 if (blksz > max) {
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200960 rem_data = blksz - max;
961 blksz = max;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100962 }
963
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200964 while (blksz) {
965 size_t sz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100966
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200967 max = MIN(blksz, shctx->block_size - offset);
968 sz = htx_add_data(htx, ist2(shblk->data + offset, max));
969 offset += sz;
970 blksz -= sz;
971 total += sz;
972 if (sz < max)
973 break;
974 if (blksz || offset == shctx->block_size) {
975 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
976 offset = 0;
977 }
978 }
979
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200980 appctx->ctx.cache.offset = offset;
981 appctx->ctx.cache.next = shblk;
982 appctx->ctx.cache.sent += total;
983 appctx->ctx.cache.rem_data = rem_data + blksz;
984 return total;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100985}
986
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200987static size_t htx_cache_dump_msg(struct appctx *appctx, struct htx *htx, unsigned int len,
988 enum htx_blk_type mark)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100989{
Christopher Faulet95220e22018-12-07 17:34:39 +0100990 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
991 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200992 struct shared_block *shblk;
993 unsigned int offset, sz;
994 unsigned int ret, total = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100995
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200996 while (len) {
997 enum htx_blk_type type;
998 uint32_t info;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100999
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001000 shblk = appctx->ctx.cache.next;
1001 offset = appctx->ctx.cache.offset;
1002 if (appctx->ctx.cache.rem_data) {
1003 type = HTX_BLK_DATA;
1004 info = 0;
1005 goto add_data_blk;
1006 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001007
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001008 /* Get info of the next HTX block. May be splitted on 2 shblk */
1009 sz = MIN(4, shctx->block_size - offset);
1010 memcpy((char *)&info, (const char *)shblk->data + offset, sz);
1011 offset += sz;
1012 if (sz < 4) {
1013 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
1014 memcpy(((char *)&info)+sz, (const char *)shblk->data, 4 - sz);
1015 offset = (4 - sz);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001016 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001017
1018 /* Get payload of the next HTX block and insert it. */
1019 type = (info >> 28);
1020 if (type != HTX_BLK_DATA)
1021 ret = htx_cache_dump_blk(appctx, htx, type, info, shblk, offset);
1022 else {
1023 add_data_blk:
1024 ret = htx_cache_dump_data_blk(appctx, htx, info, shblk, offset);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001025 }
1026
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001027 if (!ret)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001028 break;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001029 total += ret;
1030 len -= ret;
1031
1032 if (appctx->ctx.cache.rem_data || type == mark)
1033 break;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001034 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001035
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001036 return total;
1037}
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001038
1039static int htx_cache_add_age_hdr(struct appctx *appctx, struct htx *htx)
1040{
1041 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
1042 unsigned int age;
1043 char *end;
1044
1045 chunk_reset(&trash);
1046 age = MAX(0, (int)(now.tv_sec - cache_ptr->latest_validation)) + cache_ptr->age;
1047 if (unlikely(age > CACHE_ENTRY_MAX_AGE))
1048 age = CACHE_ENTRY_MAX_AGE;
1049 end = ultoa_o(age, b_head(&trash), b_size(&trash));
1050 b_set_data(&trash, end - b_head(&trash));
1051 if (!http_add_header(htx, ist("Age"), ist2(b_head(&trash), b_data(&trash))))
1052 return 0;
1053 return 1;
1054}
1055
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001056static void htx_cache_io_handler(struct appctx *appctx)
1057{
1058 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
1059 struct shared_block *first = block_ptr(cache_ptr);
1060 struct stream_interface *si = appctx->owner;
1061 struct channel *req = si_oc(si);
1062 struct channel *res = si_ic(si);
1063 struct htx *req_htx, *res_htx;
1064 struct buffer *errmsg;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001065 unsigned int len;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001066 size_t ret, total = 0;
1067
1068 res_htx = htxbuf(&res->buf);
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001069 total = res_htx->data;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001070
1071 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1072 goto out;
1073
1074 /* Check if the input buffer is avalaible. */
1075 if (!b_size(&res->buf)) {
1076 si_rx_room_blk(si);
1077 goto out;
1078 }
1079
Willy Tarreauefef3232018-12-16 00:37:45 +01001080 if (res->flags & (CF_SHUTW|CF_SHUTR|CF_SHUTW_NOW))
Willy Tarreau273e9642018-12-16 00:35:15 +01001081 appctx->st0 = HTX_CACHE_END;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001082
1083 if (appctx->st0 == HTX_CACHE_INIT) {
1084 appctx->ctx.cache.next = block_ptr(cache_ptr);
1085 appctx->ctx.cache.offset = sizeof(*cache_ptr);
1086 appctx->ctx.cache.sent = 0;
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001087 appctx->ctx.cache.rem_data = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001088 appctx->st0 = HTX_CACHE_HEADER;
1089 }
1090
1091 if (appctx->st0 == HTX_CACHE_HEADER) {
1092 /* Headers must be dump at once. Otherwise it is an error */
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001093 len = first->len - sizeof(*cache_ptr) - appctx->ctx.cache.sent;
1094 ret = htx_cache_dump_msg(appctx, res_htx, len, HTX_BLK_EOH);
1095 if (!ret || (htx_get_tail_type(res_htx) != HTX_BLK_EOH) ||
1096 !htx_cache_add_age_hdr(appctx, res_htx))
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001097 goto error;
1098
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001099 /* Skip response body for HEAD requests */
1100 if (si_strm(si)->txn->meth == HTTP_METH_HEAD)
Christopher Fauletf0dd0372019-02-25 11:08:34 +01001101 appctx->st0 = HTX_CACHE_EOM;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001102 else
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001103 appctx->st0 = HTX_CACHE_DATA;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001104 }
1105
1106 if (appctx->st0 == HTX_CACHE_DATA) {
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001107 len = first->len - sizeof(*cache_ptr) - appctx->ctx.cache.sent;
1108 if (len) {
1109 ret = htx_cache_dump_msg(appctx, res_htx, len, HTX_BLK_EOM);
1110 if (ret < len) {
1111 si_rx_room_blk(si);
1112 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001113 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001114 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001115 appctx->st0 = HTX_CACHE_END;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001116 }
1117
1118 if (appctx->st0 == HTX_CACHE_EOM) {
1119 if (!htx_add_endof(res_htx, HTX_BLK_EOM)) {
1120 si_rx_room_blk(si);
1121 goto out;
1122 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001123 appctx->st0 = HTX_CACHE_END;
1124 }
1125
1126 end:
Christopher Fauletadb36312019-02-25 11:40:49 +01001127 if (!(res->flags & CF_SHUTR) && appctx->st0 == HTX_CACHE_END) {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001128 res->flags |= CF_READ_NULL;
1129 si_shutr(si);
1130 }
1131
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001132 out:
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001133 total = res_htx->data - total;
Christopher Faulet61123912019-01-02 14:10:01 +01001134 if (total)
1135 channel_add_input(res, total);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001136 htx_to_buf(res_htx, &res->buf);
Christopher Fauletadb36312019-02-25 11:40:49 +01001137
1138 /* eat the whole request */
1139 if (co_data(req)) {
1140 req_htx = htx_from_buf(&req->buf);
1141 co_htx_skip(req, req_htx, co_data(req));
1142 htx_to_buf(req_htx, &req->buf);
1143 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001144 return;
1145
1146 error:
1147 /* Sent and HTTP error 500 */
1148 b_reset(&res->buf);
1149 errmsg = &htx_err_chunks[HTTP_ERR_500];
1150 res->buf.data = b_data(errmsg);
1151 memcpy(res->buf.area, b_head(errmsg), b_data(errmsg));
1152 res_htx = htx_from_buf(&res->buf);
1153
Christopher Faulet8f3c2562019-06-03 22:19:18 +02001154 total = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001155 appctx->st0 = HTX_CACHE_END;
1156 goto end;
1157}
1158
1159
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +02001160/*
1161 * Append an "Age" header into <chn> channel for this <ce> cache entry.
Joseph Herlant8dae5b32018-11-15 14:07:53 -08001162 * This is the responsibility of the caller to insure there is enough
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +02001163 * data in the channel.
1164 *
1165 * Returns the number of bytes inserted if succeeded, 0 if failed.
1166 */
1167static int cache_channel_append_age_header(struct cache_entry *ce, struct channel *chn)
1168{
1169 unsigned int age;
1170
1171 age = MAX(0, (int)(now.tv_sec - ce->latest_validation)) + ce->age;
1172 if (unlikely(age > CACHE_ENTRY_MAX_AGE))
1173 age = CACHE_ENTRY_MAX_AGE;
1174
1175 chunk_reset(&trash);
1176 chunk_printf(&trash, "Age: %u", age);
1177
1178 return ci_insert_line2(chn, ce->eoh, trash.area, trash.data);
1179}
1180
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001181static int cache_channel_row_data_get(struct appctx *appctx, int len)
William Lallemand77c11972017-10-31 20:43:01 +01001182{
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001183 int ret, total;
William Lallemand77c11972017-10-31 20:43:01 +01001184 struct stream_interface *si = appctx->owner;
1185 struct channel *res = si_ic(si);
Christopher Faulet95220e22018-12-07 17:34:39 +01001186 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
1187 struct cache *cache = cconf->c.cache;
William Lallemand77c11972017-10-31 20:43:01 +01001188 struct shared_context *shctx = shctx_ptr(cache);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001189 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
1190 struct shared_block *blk, *next = appctx->ctx.cache.next;
1191 int offset;
1192
1193 total = 0;
1194 offset = 0;
1195
1196 if (!next) {
1197 offset = sizeof(struct cache_entry);
1198 next = block_ptr(cache_ptr);
1199 }
1200
1201 blk = next;
1202 list_for_each_entry_from(blk, &shctx->hot, list) {
1203 int sz;
1204
1205 if (len <= 0)
1206 break;
1207
1208 sz = MIN(len, shctx->block_size - offset);
1209
1210 ret = ci_putblk(res, (const char *)blk->data + offset, sz);
1211 if (unlikely(offset))
1212 offset = 0;
1213 if (ret <= 0) {
1214 if (ret == -3 || ret == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001215 si_rx_room_blk(si);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001216 break;
1217 }
1218 return -1;
1219 }
1220
1221 total += sz;
1222 len -= sz;
1223 }
1224 appctx->ctx.cache.next = blk;
1225
1226 return total;
1227}
1228
1229static void http_cache_io_handler(struct appctx *appctx)
1230{
1231 struct stream_interface *si = appctx->owner;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001232 struct stream *s = si_strm(si);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001233 struct channel *res = si_ic(si);
1234 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
William Lallemand77c11972017-10-31 20:43:01 +01001235 struct shared_block *first = block_ptr(cache_ptr);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001236 unsigned int *sent = &appctx->ctx.cache.sent;
1237
1238 if (IS_HTX_STRM(s))
1239 return htx_cache_io_handler(appctx);
William Lallemand77c11972017-10-31 20:43:01 +01001240
1241 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1242 goto out;
1243
Joseph Herlant8dae5b32018-11-15 14:07:53 -08001244 /* Check if the input buffer is available. */
Willy Tarreauc9fa0482018-07-10 17:43:27 +02001245 if (res->buf.size == 0) {
Willy Tarreau4b962a42018-11-15 11:03:21 +01001246 /* buf.size==0 means we failed to get a buffer and were
1247 * already subscribed to a wait list to get a buffer.
1248 */
William Lallemand77c11972017-10-31 20:43:01 +01001249 goto out;
1250 }
1251
Willy Tarreauefef3232018-12-16 00:37:45 +01001252 if (res->flags & (CF_SHUTW|CF_SHUTW_NOW|CF_SHUTR))
William Lallemand77c11972017-10-31 20:43:01 +01001253 appctx->st0 = HTTP_CACHE_END;
1254
1255 /* buffer are aligned there, should be fine */
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +02001256 if (appctx->st0 == HTTP_CACHE_HEADER || appctx->st0 == HTTP_CACHE_INIT) {
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001257 int len = first->len - *sent - sizeof(struct cache_entry);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001258 if (len > 0) {
1259 int ret;
1260
1261 ret = cache_channel_row_data_get(appctx, len);
1262 if (ret == -1)
1263 appctx->st0 = HTTP_CACHE_END;
1264 else
1265 *sent += ret;
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +02001266 if (appctx->st0 == HTTP_CACHE_INIT && *sent > cache_ptr->eoh &&
1267 cache_channel_append_age_header(cache_ptr, res))
1268 appctx->st0 = HTTP_CACHE_HEADER;
Christopher Faulet61123912019-01-02 14:10:01 +01001269 else if (ret == len) {
1270 *sent = 0;
1271 appctx->st0 = HTTP_CACHE_FWD;
1272 }
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001273 }
1274 else {
1275 *sent = 0;
1276 appctx->st0 = HTTP_CACHE_FWD;
William Lallemand77c11972017-10-31 20:43:01 +01001277 }
William Lallemand77c11972017-10-31 20:43:01 +01001278 }
1279
Christopher Fauletadb36312019-02-25 11:40:49 +01001280 if (appctx->st0 == HTTP_CACHE_FWD)
1281 appctx->st0 = HTTP_CACHE_END;
1282
1283 if (!(res->flags & CF_SHUTR) && appctx->st0 == HTTP_CACHE_END) {
William Lallemand77c11972017-10-31 20:43:01 +01001284 res->flags |= CF_READ_NULL;
1285 si_shutr(si);
1286 }
William Lallemand77c11972017-10-31 20:43:01 +01001287out:
Christopher Fauletadb36312019-02-25 11:40:49 +01001288 /* eat the whole request */
1289 if (co_data(si_oc(si)))
1290 co_skip(si_oc(si), co_data(si_oc(si)));
William Lallemand77c11972017-10-31 20:43:01 +01001291}
1292
Christopher Faulet95220e22018-12-07 17:34:39 +01001293static int parse_cache_rule(struct proxy *proxy, const char *name, struct act_rule *rule, char **err)
William Lallemand41db4602017-10-30 11:15:51 +01001294{
1295 struct flt_conf *fconf;
Christopher Faulet95220e22018-12-07 17:34:39 +01001296 struct cache_flt_conf *cconf = NULL;
William Lallemand41db4602017-10-30 11:15:51 +01001297
Christopher Faulet95220e22018-12-07 17:34:39 +01001298 if (!*name || strcmp(name, "if") == 0 || strcmp(name, "unless") == 0) {
William Lallemand41db4602017-10-30 11:15:51 +01001299 memprintf(err, "expects a cache name");
Christopher Faulet95220e22018-12-07 17:34:39 +01001300 goto err;
William Lallemand41db4602017-10-30 11:15:51 +01001301 }
1302
1303 /* check if a cache filter was already registered with this cache
1304 * name, if that's the case, must use it. */
1305 list_for_each_entry(fconf, &proxy->filter_configs, list) {
Christopher Faulet95220e22018-12-07 17:34:39 +01001306 if (fconf->id == cache_store_flt_id) {
1307 cconf = fconf->conf;
1308 if (cconf && !strcmp((char *)cconf->c.name, name)) {
1309 rule->arg.act.p[0] = cconf;
1310 return 1;
1311 }
William Lallemand41db4602017-10-30 11:15:51 +01001312 }
1313 }
1314
Christopher Faulet95220e22018-12-07 17:34:39 +01001315 /* Create the filter cache config */
1316 cconf = calloc(1, sizeof(*cconf));
1317 if (!cconf) {
1318 memprintf(err, "out of memory\n");
1319 goto err;
1320 }
Christopher Faulet99a17a22018-12-11 09:18:27 +01001321 cconf->flags = CACHE_FLT_F_IMPLICIT_DECL;
Christopher Faulet95220e22018-12-07 17:34:39 +01001322 cconf->c.name = strdup(name);
1323 if (!cconf->c.name) {
1324 memprintf(err, "out of memory\n");
William Lallemand41db4602017-10-30 11:15:51 +01001325 goto err;
1326 }
Christopher Faulet95220e22018-12-07 17:34:39 +01001327
William Lallemand41db4602017-10-30 11:15:51 +01001328 /* register a filter to fill the cache buffer */
1329 fconf = calloc(1, sizeof(*fconf));
1330 if (!fconf) {
Christopher Faulet95220e22018-12-07 17:34:39 +01001331 memprintf(err, "out of memory\n");
William Lallemand41db4602017-10-30 11:15:51 +01001332 goto err;
1333 }
Christopher Faulet95220e22018-12-07 17:34:39 +01001334 fconf->id = cache_store_flt_id;
1335 fconf->conf = cconf;
William Lallemand41db4602017-10-30 11:15:51 +01001336 fconf->ops = &cache_ops;
1337 LIST_ADDQ(&proxy->filter_configs, &fconf->list);
1338
Christopher Faulet95220e22018-12-07 17:34:39 +01001339 rule->arg.act.p[0] = cconf;
1340 return 1;
William Lallemand41db4602017-10-30 11:15:51 +01001341
Christopher Faulet95220e22018-12-07 17:34:39 +01001342 err:
1343 free(cconf);
1344 return 0;
1345}
1346
1347enum act_parse_ret parse_cache_store(const char **args, int *orig_arg, struct proxy *proxy,
1348 struct act_rule *rule, char **err)
1349{
1350 rule->action = ACT_CUSTOM;
1351 rule->action_ptr = http_action_store_cache;
1352
1353 if (!parse_cache_rule(proxy, args[*orig_arg], rule, err))
1354 return ACT_RET_PRS_ERR;
William Lallemand41db4602017-10-30 11:15:51 +01001355
Christopher Faulet95220e22018-12-07 17:34:39 +01001356 (*orig_arg)++;
1357 return ACT_RET_PRS_OK;
William Lallemand41db4602017-10-30 11:15:51 +01001358}
1359
William Lallemandf528fff2017-11-23 19:43:17 +01001360/* This produces a sha1 hash of the concatenation of the first
1361 * occurrence of the Host header followed by the path component if it
1362 * begins with a slash ('/'). */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001363int sha1_hosturi(struct stream *s)
William Lallemandf528fff2017-11-23 19:43:17 +01001364{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001365 struct http_txn *txn = s->txn;
William Lallemandf528fff2017-11-23 19:43:17 +01001366 blk_SHA_CTX sha1_ctx;
Willy Tarreau83061a82018-07-13 11:56:34 +02001367 struct buffer *trash;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001368
William Lallemandf528fff2017-11-23 19:43:17 +01001369 trash = get_trash_chunk();
1370
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001371 if (IS_HTX_STRM(s)) {
1372 struct htx *htx = htxbuf(&s->req.buf);
1373 struct htx_sl *sl;
1374 struct http_hdr_ctx ctx;
1375 struct ist path;
William Lallemandf528fff2017-11-23 19:43:17 +01001376
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001377 ctx.blk = NULL;
1378 if (!http_find_header(htx, ist("Host"), &ctx, 0))
1379 return 0;
1380 chunk_memcat(trash, ctx.value.ptr, ctx.value.len);
1381
Christopher Faulet297fbb42019-05-13 14:41:27 +02001382 sl = http_get_stline(htx);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001383 path = http_get_path(htx_sl_req_uri(sl));
1384 if (!path.ptr)
1385 return 0;
1386 chunk_memcat(trash, path.ptr, path.len);
1387 }
1388 else {
1389 struct hdr_ctx ctx;
1390 char *path;
1391 char *end;
1392
1393 /* retrive the host */
1394 ctx.idx = 0;
1395 if (!http_find_header2("Host", 4, ci_head(txn->req.chn), &txn->hdr_idx, &ctx))
1396 return 0;
1397 chunk_strncat(trash, ctx.line + ctx.val, ctx.vlen);
1398
1399 /* now retrieve the path */
1400 end = ci_head(txn->req.chn) + txn->req.sl.rq.u + txn->req.sl.rq.u_l;
1401 path = http_txn_get_path(txn);
1402 if (!path)
1403 return 0;
1404 chunk_strncat(trash, path, end - path);
1405 }
William Lallemandf528fff2017-11-23 19:43:17 +01001406
1407 /* hash everything */
1408 blk_SHA1_Init(&sha1_ctx);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001409 blk_SHA1_Update(&sha1_ctx, trash->area, trash->data);
William Lallemandf528fff2017-11-23 19:43:17 +01001410 blk_SHA1_Final((unsigned char *)txn->cache_hash, &sha1_ctx);
1411
1412 return 1;
1413}
1414
William Lallemand41db4602017-10-30 11:15:51 +01001415enum act_return http_action_req_cache_use(struct act_rule *rule, struct proxy *px,
1416 struct session *sess, struct stream *s, int flags)
1417{
William Lallemand77c11972017-10-31 20:43:01 +01001418
Christopher Fauletb3d4bca2019-02-25 10:59:33 +01001419 struct http_txn *txn = s->txn;
William Lallemand77c11972017-10-31 20:43:01 +01001420 struct cache_entry *res;
Christopher Faulet95220e22018-12-07 17:34:39 +01001421 struct cache_flt_conf *cconf = rule->arg.act.p[0];
1422 struct cache *cache = cconf->c.cache;
William Lallemand77c11972017-10-31 20:43:01 +01001423
Christopher Fauletb3d4bca2019-02-25 10:59:33 +01001424 /* Ignore cache for HTTP/1.0 requests and for requests other than GET
1425 * and HEAD */
1426 if (!(txn->req.flags & HTTP_MSGF_VER_11) ||
1427 (txn->meth != HTTP_METH_GET && txn->meth != HTTP_METH_HEAD))
1428 txn->flags |= TX_CACHE_IGNORE;
1429
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001430 if (IS_HTX_STRM(s))
1431 htx_check_request_for_cacheability(s, &s->req);
1432 else
1433 check_request_for_cacheability(s, &s->req);
1434
Willy Tarreau504455c2017-12-22 17:47:35 +01001435 if ((s->txn->flags & (TX_CACHE_IGNORE|TX_CACHEABLE)) == TX_CACHE_IGNORE)
1436 return ACT_RET_CONT;
1437
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001438 if (!sha1_hosturi(s))
Willy Tarreau7704b1e2017-12-22 16:32:43 +01001439 return ACT_RET_CONT;
William Lallemandf528fff2017-11-23 19:43:17 +01001440
Willy Tarreau504455c2017-12-22 17:47:35 +01001441 if (s->txn->flags & TX_CACHE_IGNORE)
1442 return ACT_RET_CONT;
1443
Willy Tarreaua1214a52018-12-14 14:00:25 +01001444 if (px == strm_fe(s))
Olivier Houchardaa090d42019-03-08 18:49:24 +01001445 _HA_ATOMIC_ADD(&px->fe_counters.p.http.cache_lookups, 1);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001446 else
Olivier Houchardaa090d42019-03-08 18:49:24 +01001447 _HA_ATOMIC_ADD(&px->be_counters.p.http.cache_lookups, 1);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001448
William Lallemanda400a3a2017-11-20 19:13:12 +01001449 shctx_lock(shctx_ptr(cache));
William Lallemandf528fff2017-11-23 19:43:17 +01001450 res = entry_exist(cache, s->txn->cache_hash);
William Lallemand77c11972017-10-31 20:43:01 +01001451 if (res) {
1452 struct appctx *appctx;
William Lallemanda400a3a2017-11-20 19:13:12 +01001453 shctx_row_inc_hot(shctx_ptr(cache), block_ptr(res));
1454 shctx_unlock(shctx_ptr(cache));
William Lallemand77c11972017-10-31 20:43:01 +01001455 s->target = &http_cache_applet.obj_type;
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001456 if ((appctx = si_register_handler(&s->si[1], objt_applet(s->target)))) {
William Lallemand77c11972017-10-31 20:43:01 +01001457 appctx->st0 = HTTP_CACHE_INIT;
1458 appctx->rule = rule;
1459 appctx->ctx.cache.entry = res;
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001460 appctx->ctx.cache.next = NULL;
1461 appctx->ctx.cache.sent = 0;
Willy Tarreaua1214a52018-12-14 14:00:25 +01001462
1463 if (px == strm_fe(s))
Olivier Houchardaa090d42019-03-08 18:49:24 +01001464 _HA_ATOMIC_ADD(&px->fe_counters.p.http.cache_hits, 1);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001465 else
Olivier Houchardaa090d42019-03-08 18:49:24 +01001466 _HA_ATOMIC_ADD(&px->be_counters.p.http.cache_hits, 1);
Olivier Houchardfccf8402017-11-01 14:04:02 +01001467 return ACT_RET_CONT;
William Lallemand77c11972017-10-31 20:43:01 +01001468 } else {
William Lallemand55e76742017-11-21 20:01:28 +01001469 shctx_lock(shctx_ptr(cache));
1470 shctx_row_dec_hot(shctx_ptr(cache), block_ptr(res));
1471 shctx_unlock(shctx_ptr(cache));
Olivier Houchardfccf8402017-11-01 14:04:02 +01001472 return ACT_RET_YIELD;
William Lallemand77c11972017-10-31 20:43:01 +01001473 }
1474 }
William Lallemanda400a3a2017-11-20 19:13:12 +01001475 shctx_unlock(shctx_ptr(cache));
Olivier Houchardfccf8402017-11-01 14:04:02 +01001476 return ACT_RET_CONT;
William Lallemand41db4602017-10-30 11:15:51 +01001477}
1478
1479
1480enum act_parse_ret parse_cache_use(const char **args, int *orig_arg, struct proxy *proxy,
1481 struct act_rule *rule, char **err)
1482{
William Lallemand41db4602017-10-30 11:15:51 +01001483 rule->action = ACT_CUSTOM;
1484 rule->action_ptr = http_action_req_cache_use;
1485
Christopher Faulet95220e22018-12-07 17:34:39 +01001486 if (!parse_cache_rule(proxy, args[*orig_arg], rule, err))
William Lallemand41db4602017-10-30 11:15:51 +01001487 return ACT_RET_PRS_ERR;
William Lallemand41db4602017-10-30 11:15:51 +01001488
1489 (*orig_arg)++;
1490 return ACT_RET_PRS_OK;
William Lallemand41db4602017-10-30 11:15:51 +01001491}
1492
1493int cfg_parse_cache(const char *file, int linenum, char **args, int kwm)
1494{
1495 int err_code = 0;
1496
1497 if (strcmp(args[0], "cache") == 0) { /* new cache section */
1498
1499 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001500 ha_alert("parsing [%s:%d] : '%s' expects an <id> argument\n",
1501 file, linenum, args[0]);
William Lallemand41db4602017-10-30 11:15:51 +01001502 err_code |= ERR_ALERT | ERR_ABORT;
1503 goto out;
1504 }
1505
1506 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1507 err_code |= ERR_ABORT;
1508 goto out;
1509 }
1510
1511 if (tmp_cache_config == NULL) {
1512 tmp_cache_config = calloc(1, sizeof(*tmp_cache_config));
1513 if (!tmp_cache_config) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001514 ha_alert("parsing [%s:%d]: out of memory.\n", file, linenum);
William Lallemand41db4602017-10-30 11:15:51 +01001515 err_code |= ERR_ALERT | ERR_ABORT;
1516 goto out;
1517 }
1518
1519 strlcpy2(tmp_cache_config->id, args[1], 33);
1520 if (strlen(args[1]) > 32) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001521 ha_warning("parsing [%s:%d]: cache id is limited to 32 characters, truncate to '%s'.\n",
1522 file, linenum, tmp_cache_config->id);
William Lallemand41db4602017-10-30 11:15:51 +01001523 err_code |= ERR_WARN;
1524 }
William Lallemand49b44532017-11-24 18:53:43 +01001525 tmp_cache_config->maxage = 60;
William Lallemand41db4602017-10-30 11:15:51 +01001526 tmp_cache_config->maxblocks = 0;
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001527 tmp_cache_config->maxobjsz = 0;
Christopher Faulet1f672c52018-12-03 14:30:41 +01001528 tmp_cache_config->flags = 0;
William Lallemand41db4602017-10-30 11:15:51 +01001529 }
1530 } else if (strcmp(args[0], "total-max-size") == 0) {
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001531 unsigned long int maxsize;
1532 char *err;
William Lallemand41db4602017-10-30 11:15:51 +01001533
1534 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1535 err_code |= ERR_ABORT;
1536 goto out;
1537 }
1538
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001539 maxsize = strtoul(args[1], &err, 10);
1540 if (err == args[1] || *err != '\0') {
1541 ha_warning("parsing [%s:%d]: total-max-size wrong value '%s'\n",
1542 file, linenum, args[1]);
1543 err_code |= ERR_ABORT;
1544 goto out;
1545 }
1546
1547 if (maxsize > (UINT_MAX >> 20)) {
1548 ha_warning("parsing [%s:%d]: \"total-max-size\" (%s) must not be greater than %u\n",
1549 file, linenum, args[1], UINT_MAX >> 20);
1550 err_code |= ERR_ABORT;
1551 goto out;
1552 }
1553
William Lallemand41db4602017-10-30 11:15:51 +01001554 /* size in megabytes */
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001555 maxsize *= 1024 * 1024 / CACHE_BLOCKSIZE;
William Lallemand41db4602017-10-30 11:15:51 +01001556 tmp_cache_config->maxblocks = maxsize;
William Lallemand49b44532017-11-24 18:53:43 +01001557 } else if (strcmp(args[0], "max-age") == 0) {
1558 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1559 err_code |= ERR_ABORT;
1560 goto out;
1561 }
1562
1563 if (!*args[1]) {
1564 ha_warning("parsing [%s:%d]: '%s' expects an age parameter in seconds.\n",
1565 file, linenum, args[0]);
1566 err_code |= ERR_WARN;
1567 }
1568
1569 tmp_cache_config->maxage = atoi(args[1]);
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001570 } else if (strcmp(args[0], "max-object-size") == 0) {
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001571 unsigned int maxobjsz;
1572 char *err;
1573
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001574 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1575 err_code |= ERR_ABORT;
1576 goto out;
1577 }
1578
1579 if (!*args[1]) {
1580 ha_warning("parsing [%s:%d]: '%s' expects a maximum file size parameter in bytes.\n",
1581 file, linenum, args[0]);
1582 err_code |= ERR_WARN;
1583 }
1584
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001585 maxobjsz = strtoul(args[1], &err, 10);
1586 if (err == args[1] || *err != '\0') {
1587 ha_warning("parsing [%s:%d]: max-object-size wrong value '%s'\n",
1588 file, linenum, args[1]);
1589 err_code |= ERR_ABORT;
1590 goto out;
1591 }
1592 tmp_cache_config->maxobjsz = maxobjsz;
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001593 }
1594 else if (*args[0] != 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001595 ha_alert("parsing [%s:%d] : unknown keyword '%s' in 'cache' section\n", file, linenum, args[0]);
William Lallemand41db4602017-10-30 11:15:51 +01001596 err_code |= ERR_ALERT | ERR_FATAL;
1597 goto out;
1598 }
1599out:
1600 return err_code;
1601}
1602
1603/* once the cache section is parsed */
1604
1605int cfg_post_parse_section_cache()
1606{
1607 struct shared_context *shctx;
1608 int err_code = 0;
1609 int ret_shctx;
1610
1611 if (tmp_cache_config) {
1612 struct cache *cache;
1613
1614 if (tmp_cache_config->maxblocks <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001615 ha_alert("Size not specified for cache '%s'\n", tmp_cache_config->id);
William Lallemand41db4602017-10-30 11:15:51 +01001616 err_code |= ERR_FATAL | ERR_ALERT;
1617 goto out;
1618 }
1619
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001620 if (!tmp_cache_config->maxobjsz) {
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001621 /* Default max. file size is a 256th of the cache size. */
1622 tmp_cache_config->maxobjsz =
1623 (tmp_cache_config->maxblocks * CACHE_BLOCKSIZE) >> 8;
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001624 }
1625 else if (tmp_cache_config->maxobjsz > tmp_cache_config->maxblocks * CACHE_BLOCKSIZE / 2) {
1626 ha_alert("\"max-object-size\" is limited to an half of \"total-max-size\" => %u\n", tmp_cache_config->maxblocks * CACHE_BLOCKSIZE / 2);
1627 err_code |= ERR_FATAL | ERR_ALERT;
1628 goto out;
1629 }
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001630
1631 ret_shctx = shctx_init(&shctx, tmp_cache_config->maxblocks, CACHE_BLOCKSIZE,
1632 tmp_cache_config->maxobjsz, sizeof(struct cache), 1);
William Lallemand4da3f8a2017-10-31 14:33:34 +01001633
Frédéric Lécaillebc584492018-10-25 20:18:59 +02001634 if (ret_shctx <= 0) {
William Lallemand41db4602017-10-30 11:15:51 +01001635 if (ret_shctx == SHCTX_E_INIT_LOCK)
Christopher Faulet767a84b2017-11-24 16:50:31 +01001636 ha_alert("Unable to initialize the lock for the cache.\n");
William Lallemand41db4602017-10-30 11:15:51 +01001637 else
Christopher Faulet767a84b2017-11-24 16:50:31 +01001638 ha_alert("Unable to allocate cache.\n");
William Lallemand41db4602017-10-30 11:15:51 +01001639
1640 err_code |= ERR_FATAL | ERR_ALERT;
1641 goto out;
1642 }
William Lallemanda400a3a2017-11-20 19:13:12 +01001643 shctx->free_block = cache_free_blocks;
William Lallemand41db4602017-10-30 11:15:51 +01001644 memcpy(shctx->data, tmp_cache_config, sizeof(struct cache));
1645 cache = (struct cache *)shctx->data;
1646 cache->entries = EB_ROOT_UNIQUE;
William Lallemand41db4602017-10-30 11:15:51 +01001647 LIST_ADDQ(&caches, &cache->list);
1648 }
1649out:
1650 free(tmp_cache_config);
1651 tmp_cache_config = NULL;
1652 return err_code;
1653
1654}
1655
1656/*
1657 * Resolve the cache name to a pointer once the file is completely read.
1658 */
1659int cfg_cache_postparser()
1660{
William Lallemand41db4602017-10-30 11:15:51 +01001661 struct cache *cache;
William Lallemand41db4602017-10-30 11:15:51 +01001662 int err = 0;
Christopher Faulet1f672c52018-12-03 14:30:41 +01001663
1664 /* Check if the cache is used by HTX and legacy HTTP proxies in same
1665 * time
1666 */
1667 list_for_each_entry(cache, &caches, list) {
1668 if ((cache->flags & (CACHE_F_HTX|CACHE_F_LEGACY_HTTP)) == (CACHE_F_HTX|CACHE_F_LEGACY_HTTP)) {
1669 ha_alert("Cache '%s': cannot be used by HTX and legacy HTTP proxies in same time.\n",
1670 cache->id);
1671 err++;
1672 }
1673 }
1674
William Lallemand41db4602017-10-30 11:15:51 +01001675 return err;
1676}
1677
1678
1679struct flt_ops cache_ops = {
1680 .init = cache_store_init,
Christopher Faulet95220e22018-12-07 17:34:39 +01001681 .check = cache_store_check,
1682 .deinit = cache_store_deinit,
William Lallemand41db4602017-10-30 11:15:51 +01001683
William Lallemand4da3f8a2017-10-31 14:33:34 +01001684 /* Handle channels activity */
1685 .channel_start_analyze = cache_store_chn_start_analyze,
William Lallemand49dc0482017-11-24 14:33:54 +01001686 .channel_end_analyze = cache_store_chn_end_analyze,
Christopher Faulet839791a2019-01-07 16:12:07 +01001687 .channel_post_analyze = cache_store_post_analyze,
William Lallemand4da3f8a2017-10-31 14:33:34 +01001688
1689 /* Filter HTTP requests and responses */
1690 .http_headers = cache_store_http_headers,
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001691 .http_payload = cache_store_http_payload,
William Lallemand4da3f8a2017-10-31 14:33:34 +01001692 .http_end = cache_store_http_end,
1693
1694 .http_forward_data = cache_store_http_forward_data,
1695
William Lallemand41db4602017-10-30 11:15:51 +01001696};
1697
Christopher Faulet99a17a22018-12-11 09:18:27 +01001698
1699
1700static int
1701parse_cache_flt(char **args, int *cur_arg, struct proxy *px,
1702 struct flt_conf *fconf, char **err, void *private)
1703{
1704 struct flt_conf *f, *back;
Willy Tarreaua73da1e2018-12-14 10:19:28 +01001705 struct cache_flt_conf *cconf = NULL;
Christopher Faulet99a17a22018-12-11 09:18:27 +01001706 char *name = NULL;
1707 int pos = *cur_arg;
1708
1709 /* Get the cache filter name*/
1710 if (!strcmp(args[pos], "cache")) {
1711 if (!*args[pos + 1]) {
1712 memprintf(err, "%s : expects an <id> argument", args[pos]);
1713 goto error;
1714 }
1715 name = strdup(args[pos + 1]);
1716 if (!name) {
1717 memprintf(err, "%s '%s' : out of memory", args[pos], args[pos + 1]);
1718 goto error;
1719 }
1720 pos += 2;
1721 }
1722
1723 /* Check if an implicit filter with the same name already exists. If so,
1724 * we remove the implicit filter to use the explicit one. */
1725 list_for_each_entry_safe(f, back, &px->filter_configs, list) {
1726 if (f->id != cache_store_flt_id)
1727 continue;
1728
1729 cconf = f->conf;
1730 if (strcmp(name, cconf->c.name)) {
1731 cconf = NULL;
1732 continue;
1733 }
1734
1735 if (!(cconf->flags & CACHE_FLT_F_IMPLICIT_DECL)) {
1736 cconf = NULL;
1737 memprintf(err, "%s: multiple explicit declarations of the cache filter '%s'",
1738 px->id, name);
1739 return -1;
1740 }
1741
1742 /* Remove the implicit filter. <cconf> is kept for the explicit one */
1743 LIST_DEL(&f->list);
1744 free(f);
1745 free(name);
1746 break;
1747 }
1748
1749 /* No implicit cache filter found, create configuration for the explicit one */
1750 if (!cconf) {
1751 cconf = calloc(1, sizeof(*cconf));
1752 if (!cconf) {
1753 memprintf(err, "%s: out of memory", args[*cur_arg]);
1754 goto error;
1755 }
1756 cconf->c.name = name;
1757 }
1758
1759 cconf->flags = 0;
1760 fconf->id = cache_store_flt_id;
1761 fconf->conf = cconf;
1762 fconf->ops = &cache_ops;
1763
1764 *cur_arg = pos;
1765 return 0;
1766
1767 error:
1768 free(name);
1769 free(cconf);
1770 return -1;
1771}
1772
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001773static int cli_parse_show_cache(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemand1f49a362017-11-21 20:01:26 +01001774{
1775 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1776 return 1;
1777
1778 return 0;
1779}
1780
1781static int cli_io_handler_show_cache(struct appctx *appctx)
1782{
1783 struct cache* cache = appctx->ctx.cli.p0;
1784 struct stream_interface *si = appctx->owner;
1785
William Lallemand1f49a362017-11-21 20:01:26 +01001786 if (cache == NULL) {
1787 cache = LIST_ELEM((caches).n, typeof(struct cache *), list);
1788 }
1789
1790 list_for_each_entry_from(cache, &caches, list) {
1791 struct eb32_node *node = NULL;
1792 unsigned int next_key;
1793 struct cache_entry *entry;
1794
William Lallemand1f49a362017-11-21 20:01:26 +01001795 next_key = appctx->ctx.cli.i0;
Willy Tarreauafe1de52018-04-04 11:56:43 +02001796 if (!next_key) {
1797 chunk_printf(&trash, "%p: %s (shctx:%p, available blocks:%d)\n", cache, cache->id, shctx_ptr(cache), shctx_ptr(cache)->nbav);
1798 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001799 si_rx_room_blk(si);
Willy Tarreauafe1de52018-04-04 11:56:43 +02001800 return 0;
1801 }
1802 }
William Lallemand1f49a362017-11-21 20:01:26 +01001803
1804 appctx->ctx.cli.p0 = cache;
1805
1806 while (1) {
1807
1808 shctx_lock(shctx_ptr(cache));
1809 node = eb32_lookup_ge(&cache->entries, next_key);
1810 if (!node) {
1811 shctx_unlock(shctx_ptr(cache));
Willy Tarreauafe1de52018-04-04 11:56:43 +02001812 appctx->ctx.cli.i0 = 0;
William Lallemand1f49a362017-11-21 20:01:26 +01001813 break;
1814 }
1815
1816 entry = container_of(node, struct cache_entry, eb);
Willy Tarreauafe1de52018-04-04 11:56:43 +02001817 chunk_printf(&trash, "%p hash:%u size:%u (%u blocks), refcount:%u, expire:%d\n", entry, (*(unsigned int *)entry->hash), block_ptr(entry)->len, block_ptr(entry)->block_count, block_ptr(entry)->refcount, entry->expire - (int)now.tv_sec);
William Lallemand1f49a362017-11-21 20:01:26 +01001818
1819 next_key = node->key + 1;
1820 appctx->ctx.cli.i0 = next_key;
1821
1822 shctx_unlock(shctx_ptr(cache));
1823
1824 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001825 si_rx_room_blk(si);
William Lallemand1f49a362017-11-21 20:01:26 +01001826 return 0;
1827 }
1828 }
1829
1830 }
1831
1832 return 1;
1833
1834}
1835
Christopher Faulet99a17a22018-12-11 09:18:27 +01001836/* Declare the filter parser for "cache" keyword */
1837static struct flt_kw_list filter_kws = { "CACHE", { }, {
1838 { "cache", parse_cache_flt, NULL },
1839 { NULL, NULL, NULL },
1840 }
1841};
1842
1843INITCALL1(STG_REGISTER, flt_register_keywords, &filter_kws);
1844
William Lallemand1f49a362017-11-21 20:01:26 +01001845static struct cli_kw_list cli_kws = {{},{
William Lallemande899af82017-11-22 16:41:26 +01001846 { { "show", "cache", NULL }, "show cache : show cache status", cli_parse_show_cache, cli_io_handler_show_cache, NULL, NULL },
1847 {{},}
William Lallemand1f49a362017-11-21 20:01:26 +01001848}};
1849
Willy Tarreau0108d902018-11-25 19:14:37 +01001850INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
William Lallemand1f49a362017-11-21 20:01:26 +01001851
William Lallemand41db4602017-10-30 11:15:51 +01001852static struct action_kw_list http_res_actions = {
1853 .kw = {
1854 { "cache-store", parse_cache_store },
1855 { NULL, NULL }
1856 }
1857};
1858
Willy Tarreau0108d902018-11-25 19:14:37 +01001859INITCALL1(STG_REGISTER, http_res_keywords_register, &http_res_actions);
1860
William Lallemand41db4602017-10-30 11:15:51 +01001861static struct action_kw_list http_req_actions = {
1862 .kw = {
1863 { "cache-use", parse_cache_use },
1864 { NULL, NULL }
1865 }
1866};
1867
Willy Tarreau0108d902018-11-25 19:14:37 +01001868INITCALL1(STG_REGISTER, http_req_keywords_register, &http_req_actions);
1869
Willy Tarreau2231b632019-03-29 18:26:52 +01001870struct applet http_cache_applet = {
William Lallemand41db4602017-10-30 11:15:51 +01001871 .obj_type = OBJ_TYPE_APPLET,
1872 .name = "<CACHE>", /* used for logging */
William Lallemand77c11972017-10-31 20:43:01 +01001873 .fct = http_cache_io_handler,
William Lallemandecb73b12017-11-24 14:33:55 +01001874 .release = http_cache_applet_release,
William Lallemand41db4602017-10-30 11:15:51 +01001875};
1876
Willy Tarreaue6552512018-11-26 11:33:13 +01001877/* config parsers for this section */
1878REGISTER_CONFIG_SECTION("cache", cfg_parse_cache, cfg_post_parse_section_cache);
1879REGISTER_CONFIG_POSTPARSER("cache", cfg_cache_postparser);