blob: 032c9801e0a1299665e6fd524ac6aed92ee3af15 [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>
Christopher Faulet54a8d5a2018-12-07 12:21:11 +010025#include <proto/http_htx.h>
William Lallemand41db4602017-10-30 11:15:51 +010026#include <proto/filters.h>
Willy Tarreau61c112a2018-10-02 16:43:32 +020027#include <proto/http_rules.h>
William Lallemand41db4602017-10-30 11:15:51 +010028#include <proto/proto_http.h>
29#include <proto/log.h>
30#include <proto/stream.h>
31#include <proto/stream_interface.h>
32#include <proto/shctx.h>
33
William Lallemand41db4602017-10-30 11:15:51 +010034
35#include <common/cfgparse.h>
36#include <common/hash.h>
Willy Tarreaub96b77e2018-12-11 10:22:41 +010037#include <common/htx.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010038#include <common/initcall.h>
William Lallemand41db4602017-10-30 11:15:51 +010039
Christopher Faulet27d93c32018-12-15 22:32:02 +010040#define CACHE_FLT_F_IMPLICIT_DECL 0x00000001 /* The cache filtre was implicitly declared (ie without
Christopher Faulet99a17a22018-12-11 09:18:27 +010041 * the filter keyword) */
Christopher Fauletafd819c2018-12-11 08:57:45 +010042
Christopher Fauletf4a4ef72018-12-07 17:39:53 +010043const char *cache_store_flt_id = "cache store filter";
William Lallemand41db4602017-10-30 11:15:51 +010044
Willy Tarreau2231b632019-03-29 18:26:52 +010045extern struct applet http_cache_applet;
William Lallemand41db4602017-10-30 11:15:51 +010046
47struct flt_ops cache_ops;
48
49struct cache {
Willy Tarreaufd5efb52017-11-26 08:54:31 +010050 struct list list; /* cache linked list */
William Lallemand41db4602017-10-30 11:15:51 +010051 struct eb_root entries; /* head of cache entries based on keys */
Willy Tarreaufd5efb52017-11-26 08:54:31 +010052 unsigned int maxage; /* max-age */
53 unsigned int maxblocks;
Frédéric Lécaille4eba5442018-10-25 20:29:31 +020054 unsigned int maxobjsz; /* max-object-size (in bytes) */
Willy Tarreaufd5efb52017-11-26 08:54:31 +010055 char id[33]; /* cache name */
William Lallemand41db4602017-10-30 11:15:51 +010056};
57
Christopher Faulet95220e22018-12-07 17:34:39 +010058/* cache config for filters */
59struct cache_flt_conf {
60 union {
61 struct cache *cache; /* cache used by the filter */
62 char *name; /* cache name used during conf parsing */
63 } c;
64 unsigned int flags; /* CACHE_FLT_F_* */
65};
66
William Lallemand41db4602017-10-30 11:15:51 +010067/*
68 * cache ctx for filters
69 */
70struct cache_st {
William Lallemand41db4602017-10-30 11:15:51 +010071 struct shared_block *first_block;
72};
73
74struct cache_entry {
75 unsigned int latest_validation; /* latest validation date */
76 unsigned int expire; /* expiration date */
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +020077 unsigned int age; /* Origin server "Age" header value */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +010078
William Lallemand41db4602017-10-30 11:15:51 +010079 struct eb32_node eb; /* ebtree node used to hold the cache object */
William Lallemandf528fff2017-11-23 19:43:17 +010080 char hash[20];
William Lallemand41db4602017-10-30 11:15:51 +010081 unsigned char data[0];
82};
83
84#define CACHE_BLOCKSIZE 1024
Willy Tarreau96062a12018-11-11 14:00:28 +010085#define CACHE_ENTRY_MAX_AGE 2147483648U
William Lallemand41db4602017-10-30 11:15:51 +010086
87static struct list caches = LIST_HEAD_INIT(caches);
88static struct cache *tmp_cache_config = NULL;
89
Willy Tarreau8ceae722018-11-26 11:58:30 +010090DECLARE_STATIC_POOL(pool_head_cache_st, "cache_st", sizeof(struct cache_st));
91
William Lallemandf528fff2017-11-23 19:43:17 +010092struct cache_entry *entry_exist(struct cache *cache, char *hash)
William Lallemand4da3f8a2017-10-31 14:33:34 +010093{
94 struct eb32_node *node;
95 struct cache_entry *entry;
96
William Lallemandf528fff2017-11-23 19:43:17 +010097 node = eb32_lookup(&cache->entries, (*(unsigned int *)hash));
William Lallemand4da3f8a2017-10-31 14:33:34 +010098 if (!node)
99 return NULL;
100
101 entry = eb32_entry(node, struct cache_entry, eb);
William Lallemandf528fff2017-11-23 19:43:17 +0100102
103 /* if that's not the right node */
104 if (memcmp(entry->hash, hash, sizeof(entry->hash)))
105 return NULL;
106
William Lallemand08727662017-11-21 20:01:27 +0100107 if (entry->expire > now.tv_sec) {
William Lallemand4da3f8a2017-10-31 14:33:34 +0100108 return entry;
William Lallemand08727662017-11-21 20:01:27 +0100109 } else {
William Lallemand4da3f8a2017-10-31 14:33:34 +0100110 eb32_delete(node);
William Lallemand08727662017-11-21 20:01:27 +0100111 entry->eb.key = 0;
112 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100113 return NULL;
114
115}
116
117static inline struct shared_context *shctx_ptr(struct cache *cache)
118{
119 return (struct shared_context *)((unsigned char *)cache - ((struct shared_context *)NULL)->data);
120}
121
William Lallemand77c11972017-10-31 20:43:01 +0100122static inline struct shared_block *block_ptr(struct cache_entry *entry)
123{
124 return (struct shared_block *)((unsigned char *)entry - ((struct shared_block *)NULL)->data);
125}
126
127
128
William Lallemand41db4602017-10-30 11:15:51 +0100129static int
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100130cache_store_init(struct proxy *px, struct flt_conf *fconf)
William Lallemand41db4602017-10-30 11:15:51 +0100131{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100132 fconf->flags |= FLT_CFG_FL_HTX;
William Lallemand41db4602017-10-30 11:15:51 +0100133 return 0;
134}
135
Christopher Faulet95220e22018-12-07 17:34:39 +0100136static void
137cache_store_deinit(struct proxy *px, struct flt_conf *fconf)
138{
139 struct cache_flt_conf *cconf = fconf->conf;
140
141 free(cconf);
142}
143
William Lallemand4da3f8a2017-10-31 14:33:34 +0100144static int
Christopher Faulet95220e22018-12-07 17:34:39 +0100145cache_store_check(struct proxy *px, struct flt_conf *fconf)
146{
147 struct cache_flt_conf *cconf = fconf->conf;
Christopher Fauletafd819c2018-12-11 08:57:45 +0100148 struct flt_conf *f;
Christopher Faulet95220e22018-12-07 17:34:39 +0100149 struct cache *cache;
Christopher Faulet27d93c32018-12-15 22:32:02 +0100150 int comp = 0;
Christopher Faulet95220e22018-12-07 17:34:39 +0100151
152 /* resolve the cache name to a ptr in the filter config */
153 list_for_each_entry(cache, &caches, list) {
154 if (!strcmp(cache->id, cconf->c.name)) {
Christopher Faulet95220e22018-12-07 17:34:39 +0100155 free(cconf->c.name);
156 cconf->c.cache = cache;
157 goto found;
158 }
159 }
160
161 ha_alert("config: %s '%s': unable to find the cache '%s' referenced by the filter 'cache'.\n",
162 proxy_type_str(px), px->id, (char *)cconf->c.name);
163 return 1;
164
165 found:
Christopher Fauletafd819c2018-12-11 08:57:45 +0100166 /* Here <cache> points on the cache the filter must use and <cconf>
167 * points on the cache filter configuration. */
168
169 /* Check all filters for proxy <px> to know if the compression is
Christopher Faulet27d93c32018-12-15 22:32:02 +0100170 * enabled and if it is after the cache. When the compression is before
171 * the cache, an error is returned. Also check if the cache filter must
172 * be explicitly declaired or not. */
Christopher Fauletafd819c2018-12-11 08:57:45 +0100173 list_for_each_entry(f, &px->filter_configs, list) {
174 if (f == fconf) {
Christopher Faulet27d93c32018-12-15 22:32:02 +0100175 /* The compression filter must be evaluated after the cache. */
176 if (comp) {
177 ha_alert("config: %s '%s': unable to enable the compression filter before "
178 "the cache '%s'.\n", proxy_type_str(px), px->id, cache->id);
179 return 1;
180 }
Christopher Faulet99a17a22018-12-11 09:18:27 +0100181 }
Christopher Faulet8f7fe1c2019-07-15 15:08:25 +0200182 else if (f->id == http_comp_flt_id)
Christopher Faulet27d93c32018-12-15 22:32:02 +0100183 comp = 1;
Christopher Faulet27d93c32018-12-15 22:32:02 +0100184 else if ((f->id != fconf->id) && (cconf->flags & CACHE_FLT_F_IMPLICIT_DECL)) {
185 /* Implicit declaration is only allowed with the
186 * compression. For other filters, an implicit
187 * declaration is required. */
188 ha_alert("config: %s '%s': require an explicit filter declaration "
189 "to use the cache '%s'.\n", proxy_type_str(px), px->id, cache->id);
190 return 1;
191 }
192
Christopher Fauletafd819c2018-12-11 08:57:45 +0100193 }
Christopher Faulet95220e22018-12-07 17:34:39 +0100194 return 0;
195}
196
197static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100198cache_store_chn_start_analyze(struct stream *s, struct filter *filter, struct channel *chn)
199{
200 if (!(chn->flags & CF_ISRESP))
201 return 1;
202
203 if (filter->ctx == NULL) {
204 struct cache_st *st;
205
Willy Tarreaubafbe012017-11-24 17:34:44 +0100206 st = pool_alloc_dirty(pool_head_cache_st);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100207 if (st == NULL)
208 return -1;
209
William Lallemand4da3f8a2017-10-31 14:33:34 +0100210 st->first_block = NULL;
211 filter->ctx = st;
Christopher Faulet839791a2019-01-07 16:12:07 +0100212
213 /* Register post-analyzer on AN_RES_WAIT_HTTP */
214 filter->post_analyzers |= AN_RES_WAIT_HTTP;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100215 }
216
William Lallemand4da3f8a2017-10-31 14:33:34 +0100217 return 1;
218}
219
220static int
William Lallemand49dc0482017-11-24 14:33:54 +0100221cache_store_chn_end_analyze(struct stream *s, struct filter *filter, struct channel *chn)
222{
223 struct cache_st *st = filter->ctx;
Christopher Faulet95220e22018-12-07 17:34:39 +0100224 struct cache_flt_conf *cconf = FLT_CONF(filter);
225 struct cache *cache = cconf->c.cache;
William Lallemand49dc0482017-11-24 14:33:54 +0100226 struct shared_context *shctx = shctx_ptr(cache);
227
228 if (!(chn->flags & CF_ISRESP))
229 return 1;
230
231 /* Everything should be released in the http_end filter, but we need to do it
232 * there too, in case of errors */
233
234 if (st && st->first_block) {
235
236 shctx_lock(shctx);
237 shctx_row_dec_hot(shctx, st->first_block);
238 shctx_unlock(shctx);
239
240 }
241 if (st) {
Willy Tarreaubafbe012017-11-24 17:34:44 +0100242 pool_free(pool_head_cache_st, st);
William Lallemand49dc0482017-11-24 14:33:54 +0100243 filter->ctx = NULL;
244 }
245
246 return 1;
247}
248
Christopher Faulet839791a2019-01-07 16:12:07 +0100249static int
250cache_store_post_analyze(struct stream *s, struct filter *filter, struct channel *chn,
251 unsigned an_bit)
252{
253 struct http_txn *txn = s->txn;
254 struct http_msg *msg = &txn->rsp;
255 struct cache_st *st = filter->ctx;
256
257 if (an_bit != AN_RES_WAIT_HTTP)
258 goto end;
259
260 /* Here we need to check if any compression filter precedes the cache
261 * filter. This is only possible when the compression is configured in
262 * the frontend while the cache filter is configured on the
263 * backend. This case cannot be detected during HAProxy startup. So in
264 * such cases, the cache is disabled.
265 */
266 if (st && (msg->flags & HTTP_MSGF_COMPRESSING)) {
267 pool_free(pool_head_cache_st, st);
268 filter->ctx = NULL;
269 }
270
271 end:
272 return 1;
273}
William Lallemand49dc0482017-11-24 14:33:54 +0100274
275static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100276cache_store_http_headers(struct stream *s, struct filter *filter, struct http_msg *msg)
277{
278 struct cache_st *st = filter->ctx;
279
William Lallemand4da3f8a2017-10-31 14:33:34 +0100280 if (!(msg->chn->flags & CF_ISRESP) || !st)
281 return 1;
282
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200283 if (st->first_block)
Christopher Faulet67658c92018-12-06 21:59:39 +0100284 register_data_filter(s, msg->chn, filter);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100285 return 1;
286}
287
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200288static inline void disable_cache_entry(struct cache_st *st,
289 struct filter *filter, struct shared_context *shctx)
290{
291 struct cache_entry *object;
292
293 object = (struct cache_entry *)st->first_block->data;
294 filter->ctx = NULL; /* disable cache */
295 shctx_lock(shctx);
296 shctx_row_dec_hot(shctx, st->first_block);
297 object->eb.key = 0;
298 shctx_unlock(shctx);
299 pool_free(pool_head_cache_st, st);
300}
301
William Lallemand4da3f8a2017-10-31 14:33:34 +0100302static int
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100303cache_store_http_payload(struct stream *s, struct filter *filter, struct http_msg *msg,
304 unsigned int offset, unsigned int len)
305{
Christopher Faulet95220e22018-12-07 17:34:39 +0100306 struct cache_flt_conf *cconf = FLT_CONF(filter);
307 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100308 struct cache_st *st = filter->ctx;
309 struct htx *htx = htxbuf(&msg->chn->buf);
310 struct htx_blk *blk;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200311 struct shared_block *fb;
312 unsigned int orig_len, to_forward;
313 int ret;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100314
315 if (!len)
316 return len;
317
318 if (!st->first_block) {
319 unregister_data_filter(s, msg->chn, filter);
320 return len;
321 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100322
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200323 chunk_reset(&trash);
324 orig_len = len;
325 to_forward = 0;
Christopher Fauletee847d42019-05-23 11:55:33 +0200326 for (blk = htx_get_first_blk(htx); blk && len; blk = htx_get_next_blk(htx, blk)) {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100327 enum htx_blk_type type = htx_get_blk_type(blk);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200328 uint32_t info, sz = htx_get_blksz(blk);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100329 struct ist v;
330
Christopher Fauletee847d42019-05-23 11:55:33 +0200331 if (offset >= sz) {
332 offset -= sz;
333 continue;
334 }
335
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100336 switch (type) {
337 case HTX_BLK_UNUSED:
338 break;
339
340 case HTX_BLK_DATA:
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100341 v = htx_get_blk_value(htx, blk);
342 v.ptr += offset;
343 v.len -= offset;
344 if (v.len > len)
345 v.len = len;
346
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200347 info = (type << 28) + v.len;
348 chunk_memcat(&trash, (char *)&info, sizeof(info));
349 chunk_memcat(&trash, v.ptr, v.len);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100350 to_forward += v.len;
351 len -= v.len;
352 break;
353
354 default:
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200355 /* Here offset must always be 0 because only
356 * DATA blocks can be partially transferred. */
357 if (offset)
358 goto no_cache;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100359 if (sz > len)
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200360 goto end;
361
362 chunk_memcat(&trash, (char *)&blk->info, sizeof(blk->info));
363 chunk_memcat(&trash, htx_get_blk_ptr(htx, blk), sz);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100364 to_forward += sz;
365 len -= sz;
366 break;
367 }
368
369 offset = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100370 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200371
372 end:
373 shctx_lock(shctx);
374 fb = shctx_row_reserve_hot(shctx, st->first_block, trash.data);
375 if (!fb) {
376 shctx_unlock(shctx);
377 goto no_cache;
378 }
379 shctx_unlock(shctx);
380
381 ret = shctx_row_data_append(shctx, st->first_block, st->first_block->last_append,
382 (unsigned char *)b_head(&trash), b_data(&trash));
383 if (ret < 0)
384 goto no_cache;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100385
386 return to_forward;
387
388 no_cache:
389 disable_cache_entry(st, filter, shctx);
390 unregister_data_filter(s, msg->chn, filter);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200391 return orig_len;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100392}
393
394static int
William Lallemand4da3f8a2017-10-31 14:33:34 +0100395cache_store_http_end(struct stream *s, struct filter *filter,
396 struct http_msg *msg)
397{
398 struct cache_st *st = filter->ctx;
Christopher Faulet95220e22018-12-07 17:34:39 +0100399 struct cache_flt_conf *cconf = FLT_CONF(filter);
400 struct cache *cache = cconf->c.cache;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100401 struct shared_context *shctx = shctx_ptr(cache);
402 struct cache_entry *object;
403
404 if (!(msg->chn->flags & CF_ISRESP))
405 return 1;
406
407 if (st && st->first_block) {
408
409 object = (struct cache_entry *)st->first_block->data;
410
411 /* does not need to test if the insertion worked, if it
412 * doesn't, the blocks will be reused anyway */
413
414 shctx_lock(shctx);
William Lallemand08727662017-11-21 20:01:27 +0100415 if (eb32_insert(&cache->entries, &object->eb) != &object->eb) {
416 object->eb.key = 0;
417 }
William Lallemand4da3f8a2017-10-31 14:33:34 +0100418 /* remove from the hotlist */
William Lallemand4da3f8a2017-10-31 14:33:34 +0100419 shctx_row_dec_hot(shctx, st->first_block);
420 shctx_unlock(shctx);
421
422 }
423 if (st) {
Willy Tarreaubafbe012017-11-24 17:34:44 +0100424 pool_free(pool_head_cache_st, st);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100425 filter->ctx = NULL;
426 }
427
428 return 1;
429}
430
431 /*
432 * This intends to be used when checking HTTP headers for some
433 * word=value directive. Return a pointer to the first character of value, if
434 * the word was not found or if there wasn't any value assigned ot it return NULL
435 */
436char *directive_value(const char *sample, int slen, const char *word, int wlen)
437{
438 int st = 0;
439
440 if (slen < wlen)
441 return 0;
442
443 while (wlen) {
444 char c = *sample ^ *word;
445 if (c && c != ('A' ^ 'a'))
446 return NULL;
447 sample++;
448 word++;
449 slen--;
450 wlen--;
451 }
452
453 while (slen) {
454 if (st == 0) {
455 if (*sample != '=')
456 return NULL;
457 sample++;
458 slen--;
459 st = 1;
460 continue;
461 } else {
462 return (char *)sample;
463 }
464 }
465
466 return NULL;
467}
468
469/*
470 * Return the maxage in seconds of an HTTP response.
471 * Compute the maxage using either:
472 * - the assigned max-age of the cache
473 * - the s-maxage directive
474 * - the max-age directive
475 * - (Expires - Data) headers
476 * - the default-max-age of the cache
477 *
478 */
William Lallemand49b44532017-11-24 18:53:43 +0100479int http_calc_maxage(struct stream *s, struct cache *cache)
William Lallemand4da3f8a2017-10-31 14:33:34 +0100480{
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200481 struct htx *htx = htxbuf(&s->res.buf);
482 struct http_hdr_ctx ctx = { .blk = NULL };
William Lallemand4da3f8a2017-10-31 14:33:34 +0100483 int smaxage = -1;
484 int maxage = -1;
485
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200486 while (http_find_header(htx, ist("cache-control"), &ctx, 0)) {
487 char *value;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100488
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200489 value = directive_value(ctx.value.ptr, ctx.value.len, "s-maxage", 8);
490 if (value) {
491 struct buffer *chk = get_trash_chunk();
William Lallemand4da3f8a2017-10-31 14:33:34 +0100492
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200493 chunk_strncat(chk, value, ctx.value.len - 8 + 1);
494 chunk_strncat(chk, "", 1);
495 maxage = atoi(chk->area);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100496 }
497
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200498 value = directive_value(ctx.value.ptr, ctx.value.len, "max-age", 7);
499 if (value) {
500 struct buffer *chk = get_trash_chunk();
Christopher Faulet5f2c49f2019-07-15 20:49:46 +0200501
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200502 chunk_strncat(chk, value, ctx.value.len - 7 + 1);
503 chunk_strncat(chk, "", 1);
504 smaxage = atoi(chk->area);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100505 }
506 }
507
508 /* TODO: Expires - Data */
509
510
511 if (smaxage > 0)
William Lallemand49b44532017-11-24 18:53:43 +0100512 return MIN(smaxage, cache->maxage);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100513
514 if (maxage > 0)
William Lallemand49b44532017-11-24 18:53:43 +0100515 return MIN(maxage, cache->maxage);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100516
William Lallemand49b44532017-11-24 18:53:43 +0100517 return cache->maxage;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100518
519}
520
521
William Lallemanda400a3a2017-11-20 19:13:12 +0100522static void cache_free_blocks(struct shared_block *first, struct shared_block *block)
523{
Willy Tarreau5bd37fa2018-04-04 20:17:03 +0200524 struct cache_entry *object = (struct cache_entry *)block->data;
525
526 if (first == block && object->eb.key)
527 eb32_delete(&object->eb);
528 object->eb.key = 0;
William Lallemanda400a3a2017-11-20 19:13:12 +0100529}
530
William Lallemand41db4602017-10-30 11:15:51 +0100531/*
532 * This fonction will store the headers of the response in a buffer and then
533 * register a filter to store the data
534 */
535enum act_return http_action_store_cache(struct act_rule *rule, struct proxy *px,
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200536 struct session *sess, struct stream *s, int flags)
William Lallemand41db4602017-10-30 11:15:51 +0100537{
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200538 unsigned int age;
539 long long hdr_age;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100540 struct http_txn *txn = s->txn;
541 struct http_msg *msg = &txn->rsp;
542 struct filter *filter;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100543 struct shared_block *first = NULL;
Christopher Faulet95220e22018-12-07 17:34:39 +0100544 struct cache_flt_conf *cconf = rule->arg.act.p[0];
545 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet839791a2019-01-07 16:12:07 +0100546 struct cache_st *cache_ctx = NULL;
547 struct cache_entry *object, *old;
Willy Tarreauc9036c02019-01-11 19:38:25 +0100548 unsigned int key = *(unsigned int *)txn->cache_hash;
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200549 struct htx *htx;
550 struct http_hdr_ctx ctx;
551 int32_t pos;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100552
William Lallemand4da3f8a2017-10-31 14:33:34 +0100553 /* Don't cache if the response came from a cache */
554 if ((obj_type(s->target) == OBJ_TYPE_APPLET) &&
555 s->target == &http_cache_applet.obj_type) {
556 goto out;
557 }
558
559 /* cache only HTTP/1.1 */
560 if (!(txn->req.flags & HTTP_MSGF_VER_11))
561 goto out;
562
563 /* cache only GET method */
564 if (txn->meth != HTTP_METH_GET)
565 goto out;
566
Willy Tarreauc9036c02019-01-11 19:38:25 +0100567 /* cache key was not computed */
568 if (!key)
569 goto out;
570
William Lallemand4da3f8a2017-10-31 14:33:34 +0100571 /* cache only 200 status code */
572 if (txn->status != 200)
573 goto out;
574
Christopher Faulet839791a2019-01-07 16:12:07 +0100575 /* Find the corresponding filter instance for the current stream */
576 list_for_each_entry(filter, &s->strm_flt.filters, list) {
577 if (FLT_ID(filter) == cache_store_flt_id && FLT_CONF(filter) == cconf) {
578 /* No filter ctx, don't cache anything */
579 if (!filter->ctx)
580 goto out;
581 cache_ctx = filter->ctx;
582 break;
583 }
584 }
585
586 /* from there, cache_ctx is always defined */
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200587 htx = htxbuf(&s->res.buf);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100588
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200589 /* Do not cache too big objects. */
590 if ((msg->flags & HTTP_MSGF_CNT_LEN) && shctx->max_obj_size > 0 &&
591 htx->data + htx->extra > shctx->max_obj_size)
592 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100593
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200594 /* Does not manage Vary at the moment. We will need a secondary key later for that */
595 ctx.blk = NULL;
596 if (http_find_header(htx, ist("Vary"), &ctx, 0))
597 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100598
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200599 htx_check_response_for_cacheability(s, &s->res);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100600
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200601 if (!(txn->flags & TX_CACHEABLE) || !(txn->flags & TX_CACHE_COOK))
602 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100603
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200604 age = 0;
605 ctx.blk = NULL;
606 if (http_find_header(htx, ist("Age"), &ctx, 0)) {
607 if (!strl2llrc(ctx.value.ptr, ctx.value.len, &hdr_age) && hdr_age > 0) {
608 if (unlikely(hdr_age > CACHE_ENTRY_MAX_AGE))
609 hdr_age = CACHE_ENTRY_MAX_AGE;
610 age = hdr_age;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100611 }
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200612 http_remove_header(htx, &ctx);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100613 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100614
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200615 chunk_reset(&trash);
616 for (pos = htx_get_first(htx); pos != -1; pos = htx_get_next(htx, pos)) {
617 struct htx_blk *blk = htx_get_blk(htx, pos);
618 enum htx_blk_type type = htx_get_blk_type(blk);
619 uint32_t sz = htx_get_blksz(blk);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100620
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200621 chunk_memcat(&trash, (char *)&blk->info, sizeof(blk->info));
622 chunk_memcat(&trash, htx_get_blk_ptr(htx, blk), sz);
623 if (type == HTX_BLK_EOH)
624 break;
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200625 }
626
William Lallemand4da3f8a2017-10-31 14:33:34 +0100627 shctx_lock(shctx);
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200628 first = shctx_row_reserve_hot(shctx, NULL, sizeof(struct cache_entry) + trash.data);
William Lallemand4da3f8a2017-10-31 14:33:34 +0100629 if (!first) {
630 shctx_unlock(shctx);
631 goto out;
632 }
633 shctx_unlock(shctx);
634
Willy Tarreau1093a452018-04-06 19:02:25 +0200635 /* the received memory is not initialized, we need at least to mark
636 * the object as not indexed yet.
637 */
638 object = (struct cache_entry *)first->data;
639 object->eb.node.leaf_p = NULL;
640 object->eb.key = 0;
Frédéric Lécaillee7a770c2018-10-26 14:29:22 +0200641 object->age = age;
Willy Tarreau1093a452018-04-06 19:02:25 +0200642
William Lallemand4da3f8a2017-10-31 14:33:34 +0100643 /* reserve space for the cache_entry structure */
644 first->len = sizeof(struct cache_entry);
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +0200645 first->last_append = NULL;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100646 /* cache the headers in a http action because it allows to chose what
647 * to cache, for example you might want to cache a response before
648 * modifying some HTTP headers, or on the contrary after modifying
649 * those headers.
650 */
651
652 /* does not need to be locked because it's in the "hot" list,
653 * copy the headers */
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200654 if (shctx_row_data_append(shctx, first, NULL, (unsigned char *)trash.area, trash.data) < 0)
655 goto out;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100656
657 /* register the buffer in the filter ctx for filling it with data*/
Christopher Faulet839791a2019-01-07 16:12:07 +0100658 if (cache_ctx) {
659 cache_ctx->first_block = first;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100660
Willy Tarreauc9036c02019-01-11 19:38:25 +0100661 object->eb.key = key;
662
Christopher Faulet839791a2019-01-07 16:12:07 +0100663 memcpy(object->hash, txn->cache_hash, sizeof(object->hash));
664 /* Insert the node later on caching success */
William Lallemand4da3f8a2017-10-31 14:33:34 +0100665
Christopher Faulet839791a2019-01-07 16:12:07 +0100666 shctx_lock(shctx);
Christopher Faulet95220e22018-12-07 17:34:39 +0100667
Christopher Faulet839791a2019-01-07 16:12:07 +0100668 old = entry_exist(cconf->c.cache, txn->cache_hash);
669 if (old) {
670 eb32_delete(&old->eb);
671 old->eb.key = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100672 }
Christopher Faulet839791a2019-01-07 16:12:07 +0100673 shctx_unlock(shctx);
674
675 /* store latest value and expiration time */
676 object->latest_validation = now.tv_sec;
677 object->expire = now.tv_sec + http_calc_maxage(s, cconf->c.cache);
678 return ACT_RET_CONT;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100679 }
680
681out:
682 /* if does not cache */
683 if (first) {
684 shctx_lock(shctx);
William Lallemand08727662017-11-21 20:01:27 +0100685 first->len = 0;
686 object->eb.key = 0;
William Lallemand4da3f8a2017-10-31 14:33:34 +0100687 shctx_row_dec_hot(shctx, first);
688 shctx_unlock(shctx);
689 }
690
William Lallemand41db4602017-10-30 11:15:51 +0100691 return ACT_RET_CONT;
692}
693
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100694#define HTX_CACHE_INIT 0 /* Initial state. */
695#define HTX_CACHE_HEADER 1 /* Cache entry headers forwarding */
696#define HTX_CACHE_DATA 2 /* Cache entry data forwarding */
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200697#define HTX_CACHE_EOM 3 /* Cache entry completely forwarded. Finish the HTX message */
698#define HTX_CACHE_END 4 /* Cache entry treatment terminated */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100699
William Lallemandecb73b12017-11-24 14:33:55 +0100700static void http_cache_applet_release(struct appctx *appctx)
701{
Christopher Faulet95220e22018-12-07 17:34:39 +0100702 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
William Lallemandecb73b12017-11-24 14:33:55 +0100703 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
Christopher Faulet95220e22018-12-07 17:34:39 +0100704 struct cache *cache = cconf->c.cache;
William Lallemandecb73b12017-11-24 14:33:55 +0100705 struct shared_block *first = block_ptr(cache_ptr);
706
707 shctx_lock(shctx_ptr(cache));
708 shctx_row_dec_hot(shctx_ptr(cache), first);
709 shctx_unlock(shctx_ptr(cache));
710}
711
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200712
713static unsigned int htx_cache_dump_blk(struct appctx *appctx, struct htx *htx, enum htx_blk_type type,
714 uint32_t info, struct shared_block *shblk, unsigned int offset)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100715{
Christopher Faulet95220e22018-12-07 17:34:39 +0100716 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
717 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200718 struct htx_blk *blk;
719 unsigned int max, total;
720 uint32_t blksz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100721
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200722 max = htx_get_max_blksz(htx, channel_htx_recv_max(si_ic(appctx->owner), htx));
723 if (!max)
724 return 0;
Christopher Faulet2d7c5392019-06-03 10:41:26 +0200725 blksz = ((type == HTX_BLK_HDR || type == HTX_BLK_TLR)
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200726 ? (info & 0xff) + ((info >> 8) & 0xfffff)
727 : info & 0xfffffff);
728 if (blksz > max)
729 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100730
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200731 blk = htx_add_blk(htx, type, blksz);
732 if (!blk)
733 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100734
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200735 blk->info = info;
736 total = 4;
737 while (blksz) {
738 max = MIN(blksz, shctx->block_size - offset);
739 memcpy(htx_get_blk_ptr(htx, blk), (const char *)shblk->data + offset, max);
740 offset += max;
741 blksz -= max;
742 total += max;
743 if (blksz || offset == shctx->block_size) {
744 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
745 offset = 0;
746 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100747 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200748 appctx->ctx.cache.offset = offset;
749 appctx->ctx.cache.next = shblk;
750 appctx->ctx.cache.sent += total;
751 return total;
752}
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100753
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200754static unsigned int htx_cache_dump_data_blk(struct appctx *appctx, struct htx *htx,
755 uint32_t info, struct shared_block *shblk, unsigned int offset)
756{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100757
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200758 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
759 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
760 unsigned int max, total, rem_data;
761 uint32_t blksz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100762
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200763 max = htx_get_max_blksz(htx, channel_htx_recv_max(si_ic(appctx->owner), htx));
764 if (!max)
765 return 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100766
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200767 rem_data = 0;
Christopher Fauletbda83972019-06-11 09:58:09 +0200768 if (appctx->ctx.cache.rem_data) {
769 blksz = appctx->ctx.cache.rem_data;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200770 total = 0;
Christopher Fauletbda83972019-06-11 09:58:09 +0200771 }
772 else {
773 blksz = (info & 0xfffffff);
774 total = 4;
775 }
776 if (blksz > max) {
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200777 rem_data = blksz - max;
778 blksz = max;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100779 }
780
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200781 while (blksz) {
782 size_t sz;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100783
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200784 max = MIN(blksz, shctx->block_size - offset);
785 sz = htx_add_data(htx, ist2(shblk->data + offset, max));
786 offset += sz;
787 blksz -= sz;
788 total += sz;
789 if (sz < max)
790 break;
791 if (blksz || offset == shctx->block_size) {
792 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
793 offset = 0;
794 }
795 }
796
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200797 appctx->ctx.cache.offset = offset;
798 appctx->ctx.cache.next = shblk;
799 appctx->ctx.cache.sent += total;
800 appctx->ctx.cache.rem_data = rem_data + blksz;
801 return total;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100802}
803
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200804static size_t htx_cache_dump_msg(struct appctx *appctx, struct htx *htx, unsigned int len,
805 enum htx_blk_type mark)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100806{
Christopher Faulet95220e22018-12-07 17:34:39 +0100807 struct cache_flt_conf *cconf = appctx->rule->arg.act.p[0];
808 struct shared_context *shctx = shctx_ptr(cconf->c.cache);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200809 struct shared_block *shblk;
810 unsigned int offset, sz;
811 unsigned int ret, total = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100812
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200813 while (len) {
814 enum htx_blk_type type;
815 uint32_t info;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100816
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200817 shblk = appctx->ctx.cache.next;
818 offset = appctx->ctx.cache.offset;
819 if (appctx->ctx.cache.rem_data) {
820 type = HTX_BLK_DATA;
821 info = 0;
822 goto add_data_blk;
823 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100824
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200825 /* Get info of the next HTX block. May be splitted on 2 shblk */
826 sz = MIN(4, shctx->block_size - offset);
827 memcpy((char *)&info, (const char *)shblk->data + offset, sz);
828 offset += sz;
829 if (sz < 4) {
830 shblk = LIST_NEXT(&shblk->list, typeof(shblk), list);
831 memcpy(((char *)&info)+sz, (const char *)shblk->data, 4 - sz);
832 offset = (4 - sz);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100833 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200834
835 /* Get payload of the next HTX block and insert it. */
836 type = (info >> 28);
837 if (type != HTX_BLK_DATA)
838 ret = htx_cache_dump_blk(appctx, htx, type, info, shblk, offset);
839 else {
840 add_data_blk:
841 ret = htx_cache_dump_data_blk(appctx, htx, info, shblk, offset);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100842 }
843
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200844 if (!ret)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100845 break;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200846 total += ret;
847 len -= ret;
848
849 if (appctx->ctx.cache.rem_data || type == mark)
850 break;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100851 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100852
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100853 return total;
854}
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200855
856static int htx_cache_add_age_hdr(struct appctx *appctx, struct htx *htx)
857{
858 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
859 unsigned int age;
860 char *end;
861
862 chunk_reset(&trash);
863 age = MAX(0, (int)(now.tv_sec - cache_ptr->latest_validation)) + cache_ptr->age;
864 if (unlikely(age > CACHE_ENTRY_MAX_AGE))
865 age = CACHE_ENTRY_MAX_AGE;
866 end = ultoa_o(age, b_head(&trash), b_size(&trash));
867 b_set_data(&trash, end - b_head(&trash));
868 if (!http_add_header(htx, ist("Age"), ist2(b_head(&trash), b_data(&trash))))
869 return 0;
870 return 1;
871}
872
Christopher Faulet95e7ea32019-07-15 21:01:29 +0200873static void http_cache_io_handler(struct appctx *appctx)
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100874{
875 struct cache_entry *cache_ptr = appctx->ctx.cache.entry;
876 struct shared_block *first = block_ptr(cache_ptr);
877 struct stream_interface *si = appctx->owner;
878 struct channel *req = si_oc(si);
879 struct channel *res = si_ic(si);
880 struct htx *req_htx, *res_htx;
881 struct buffer *errmsg;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200882 unsigned int len;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100883 size_t ret, total = 0;
884
885 res_htx = htxbuf(&res->buf);
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200886 total = res_htx->data;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100887
888 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
889 goto out;
890
891 /* Check if the input buffer is avalaible. */
892 if (!b_size(&res->buf)) {
893 si_rx_room_blk(si);
894 goto out;
895 }
896
Willy Tarreauefef3232018-12-16 00:37:45 +0100897 if (res->flags & (CF_SHUTW|CF_SHUTR|CF_SHUTW_NOW))
Willy Tarreau273e9642018-12-16 00:35:15 +0100898 appctx->st0 = HTX_CACHE_END;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100899
900 if (appctx->st0 == HTX_CACHE_INIT) {
901 appctx->ctx.cache.next = block_ptr(cache_ptr);
902 appctx->ctx.cache.offset = sizeof(*cache_ptr);
903 appctx->ctx.cache.sent = 0;
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200904 appctx->ctx.cache.rem_data = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100905 appctx->st0 = HTX_CACHE_HEADER;
906 }
907
908 if (appctx->st0 == HTX_CACHE_HEADER) {
909 /* Headers must be dump at once. Otherwise it is an error */
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200910 len = first->len - sizeof(*cache_ptr) - appctx->ctx.cache.sent;
911 ret = htx_cache_dump_msg(appctx, res_htx, len, HTX_BLK_EOH);
912 if (!ret || (htx_get_tail_type(res_htx) != HTX_BLK_EOH) ||
913 !htx_cache_add_age_hdr(appctx, res_htx))
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100914 goto error;
915
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200916 /* Skip response body for HEAD requests */
917 if (si_strm(si)->txn->meth == HTTP_METH_HEAD)
Christopher Fauletf0dd0372019-02-25 11:08:34 +0100918 appctx->st0 = HTX_CACHE_EOM;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100919 else
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200920 appctx->st0 = HTX_CACHE_DATA;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100921 }
922
923 if (appctx->st0 == HTX_CACHE_DATA) {
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200924 len = first->len - sizeof(*cache_ptr) - appctx->ctx.cache.sent;
925 if (len) {
926 ret = htx_cache_dump_msg(appctx, res_htx, len, HTX_BLK_EOM);
927 if (ret < len) {
928 si_rx_room_blk(si);
929 goto out;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100930 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100931 }
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200932 appctx->st0 = HTX_CACHE_END;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100933 }
934
935 if (appctx->st0 == HTX_CACHE_EOM) {
936 if (!htx_add_endof(res_htx, HTX_BLK_EOM)) {
937 si_rx_room_blk(si);
938 goto out;
939 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100940 appctx->st0 = HTX_CACHE_END;
941 }
942
943 end:
Christopher Fauletadb36312019-02-25 11:40:49 +0100944 if (!(res->flags & CF_SHUTR) && appctx->st0 == HTX_CACHE_END) {
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100945 res->flags |= CF_READ_NULL;
946 si_shutr(si);
947 }
948
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100949 out:
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200950 total = res_htx->data - total;
Christopher Faulet61123912019-01-02 14:10:01 +0100951 if (total)
952 channel_add_input(res, total);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100953 htx_to_buf(res_htx, &res->buf);
Christopher Fauletadb36312019-02-25 11:40:49 +0100954
955 /* eat the whole request */
956 if (co_data(req)) {
957 req_htx = htx_from_buf(&req->buf);
958 co_htx_skip(req, req_htx, co_data(req));
959 htx_to_buf(req_htx, &req->buf);
960 }
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100961 return;
962
963 error:
964 /* Sent and HTTP error 500 */
965 b_reset(&res->buf);
966 errmsg = &htx_err_chunks[HTTP_ERR_500];
967 res->buf.data = b_data(errmsg);
968 memcpy(res->buf.area, b_head(errmsg), b_data(errmsg));
969 res_htx = htx_from_buf(&res->buf);
970
Christopher Faulet8f3c2562019-06-03 22:19:18 +0200971 total = 0;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +0100972 appctx->st0 = HTX_CACHE_END;
973 goto end;
974}
975
976
Christopher Faulet95220e22018-12-07 17:34:39 +0100977static int parse_cache_rule(struct proxy *proxy, const char *name, struct act_rule *rule, char **err)
William Lallemand41db4602017-10-30 11:15:51 +0100978{
979 struct flt_conf *fconf;
Christopher Faulet95220e22018-12-07 17:34:39 +0100980 struct cache_flt_conf *cconf = NULL;
William Lallemand41db4602017-10-30 11:15:51 +0100981
Christopher Faulet95220e22018-12-07 17:34:39 +0100982 if (!*name || strcmp(name, "if") == 0 || strcmp(name, "unless") == 0) {
William Lallemand41db4602017-10-30 11:15:51 +0100983 memprintf(err, "expects a cache name");
Christopher Faulet95220e22018-12-07 17:34:39 +0100984 goto err;
William Lallemand41db4602017-10-30 11:15:51 +0100985 }
986
987 /* check if a cache filter was already registered with this cache
988 * name, if that's the case, must use it. */
989 list_for_each_entry(fconf, &proxy->filter_configs, list) {
Christopher Faulet95220e22018-12-07 17:34:39 +0100990 if (fconf->id == cache_store_flt_id) {
991 cconf = fconf->conf;
992 if (cconf && !strcmp((char *)cconf->c.name, name)) {
993 rule->arg.act.p[0] = cconf;
994 return 1;
995 }
William Lallemand41db4602017-10-30 11:15:51 +0100996 }
997 }
998
Christopher Faulet95220e22018-12-07 17:34:39 +0100999 /* Create the filter cache config */
1000 cconf = calloc(1, sizeof(*cconf));
1001 if (!cconf) {
1002 memprintf(err, "out of memory\n");
1003 goto err;
1004 }
Christopher Faulet99a17a22018-12-11 09:18:27 +01001005 cconf->flags = CACHE_FLT_F_IMPLICIT_DECL;
Christopher Faulet95220e22018-12-07 17:34:39 +01001006 cconf->c.name = strdup(name);
1007 if (!cconf->c.name) {
1008 memprintf(err, "out of memory\n");
William Lallemand41db4602017-10-30 11:15:51 +01001009 goto err;
1010 }
Christopher Faulet95220e22018-12-07 17:34:39 +01001011
William Lallemand41db4602017-10-30 11:15:51 +01001012 /* register a filter to fill the cache buffer */
1013 fconf = calloc(1, sizeof(*fconf));
1014 if (!fconf) {
Christopher Faulet95220e22018-12-07 17:34:39 +01001015 memprintf(err, "out of memory\n");
William Lallemand41db4602017-10-30 11:15:51 +01001016 goto err;
1017 }
Christopher Faulet95220e22018-12-07 17:34:39 +01001018 fconf->id = cache_store_flt_id;
1019 fconf->conf = cconf;
William Lallemand41db4602017-10-30 11:15:51 +01001020 fconf->ops = &cache_ops;
1021 LIST_ADDQ(&proxy->filter_configs, &fconf->list);
1022
Christopher Faulet95220e22018-12-07 17:34:39 +01001023 rule->arg.act.p[0] = cconf;
1024 return 1;
William Lallemand41db4602017-10-30 11:15:51 +01001025
Christopher Faulet95220e22018-12-07 17:34:39 +01001026 err:
1027 free(cconf);
1028 return 0;
1029}
1030
1031enum act_parse_ret parse_cache_store(const char **args, int *orig_arg, struct proxy *proxy,
1032 struct act_rule *rule, char **err)
1033{
1034 rule->action = ACT_CUSTOM;
1035 rule->action_ptr = http_action_store_cache;
1036
1037 if (!parse_cache_rule(proxy, args[*orig_arg], rule, err))
1038 return ACT_RET_PRS_ERR;
William Lallemand41db4602017-10-30 11:15:51 +01001039
Christopher Faulet95220e22018-12-07 17:34:39 +01001040 (*orig_arg)++;
1041 return ACT_RET_PRS_OK;
William Lallemand41db4602017-10-30 11:15:51 +01001042}
1043
William Lallemandf528fff2017-11-23 19:43:17 +01001044/* This produces a sha1 hash of the concatenation of the first
1045 * occurrence of the Host header followed by the path component if it
1046 * begins with a slash ('/'). */
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001047int sha1_hosturi(struct stream *s)
William Lallemandf528fff2017-11-23 19:43:17 +01001048{
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001049 struct http_txn *txn = s->txn;
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001050 struct htx *htx = htxbuf(&s->req.buf);
1051 struct htx_sl *sl;
1052 struct http_hdr_ctx ctx;
1053 struct ist path;
William Lallemandf528fff2017-11-23 19:43:17 +01001054 blk_SHA_CTX sha1_ctx;
Willy Tarreau83061a82018-07-13 11:56:34 +02001055 struct buffer *trash;
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001056
William Lallemandf528fff2017-11-23 19:43:17 +01001057 trash = get_trash_chunk();
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001058 ctx.blk = NULL;
1059 if (!http_find_header(htx, ist("Host"), &ctx, 0))
1060 return 0;
1061 chunk_memcat(trash, ctx.value.ptr, ctx.value.len);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001062
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001063 sl = http_get_stline(htx);
1064 path = http_get_path(htx_sl_req_uri(sl));
1065 if (!path.ptr)
1066 return 0;
1067 chunk_memcat(trash, path.ptr, path.len);
William Lallemandf528fff2017-11-23 19:43:17 +01001068
1069 /* hash everything */
1070 blk_SHA1_Init(&sha1_ctx);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001071 blk_SHA1_Update(&sha1_ctx, trash->area, trash->data);
William Lallemandf528fff2017-11-23 19:43:17 +01001072 blk_SHA1_Final((unsigned char *)txn->cache_hash, &sha1_ctx);
1073
1074 return 1;
1075}
1076
William Lallemand41db4602017-10-30 11:15:51 +01001077enum act_return http_action_req_cache_use(struct act_rule *rule, struct proxy *px,
1078 struct session *sess, struct stream *s, int flags)
1079{
William Lallemand77c11972017-10-31 20:43:01 +01001080
Christopher Fauletb3d4bca2019-02-25 10:59:33 +01001081 struct http_txn *txn = s->txn;
William Lallemand77c11972017-10-31 20:43:01 +01001082 struct cache_entry *res;
Christopher Faulet95220e22018-12-07 17:34:39 +01001083 struct cache_flt_conf *cconf = rule->arg.act.p[0];
1084 struct cache *cache = cconf->c.cache;
William Lallemand77c11972017-10-31 20:43:01 +01001085
Christopher Fauletb3d4bca2019-02-25 10:59:33 +01001086 /* Ignore cache for HTTP/1.0 requests and for requests other than GET
1087 * and HEAD */
1088 if (!(txn->req.flags & HTTP_MSGF_VER_11) ||
1089 (txn->meth != HTTP_METH_GET && txn->meth != HTTP_METH_HEAD))
1090 txn->flags |= TX_CACHE_IGNORE;
1091
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001092 htx_check_request_for_cacheability(s, &s->req);
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001093
Willy Tarreau504455c2017-12-22 17:47:35 +01001094 if ((s->txn->flags & (TX_CACHE_IGNORE|TX_CACHEABLE)) == TX_CACHE_IGNORE)
1095 return ACT_RET_CONT;
1096
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001097 if (!sha1_hosturi(s))
Willy Tarreau7704b1e2017-12-22 16:32:43 +01001098 return ACT_RET_CONT;
William Lallemandf528fff2017-11-23 19:43:17 +01001099
Willy Tarreau504455c2017-12-22 17:47:35 +01001100 if (s->txn->flags & TX_CACHE_IGNORE)
1101 return ACT_RET_CONT;
1102
Willy Tarreaua1214a52018-12-14 14:00:25 +01001103 if (px == strm_fe(s))
Olivier Houchardaa090d42019-03-08 18:49:24 +01001104 _HA_ATOMIC_ADD(&px->fe_counters.p.http.cache_lookups, 1);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001105 else
Olivier Houchardaa090d42019-03-08 18:49:24 +01001106 _HA_ATOMIC_ADD(&px->be_counters.p.http.cache_lookups, 1);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001107
William Lallemanda400a3a2017-11-20 19:13:12 +01001108 shctx_lock(shctx_ptr(cache));
William Lallemandf528fff2017-11-23 19:43:17 +01001109 res = entry_exist(cache, s->txn->cache_hash);
William Lallemand77c11972017-10-31 20:43:01 +01001110 if (res) {
1111 struct appctx *appctx;
William Lallemanda400a3a2017-11-20 19:13:12 +01001112 shctx_row_inc_hot(shctx_ptr(cache), block_ptr(res));
1113 shctx_unlock(shctx_ptr(cache));
William Lallemand77c11972017-10-31 20:43:01 +01001114 s->target = &http_cache_applet.obj_type;
Willy Tarreau14bfe9a2018-12-19 15:19:27 +01001115 if ((appctx = si_register_handler(&s->si[1], objt_applet(s->target)))) {
Christopher Faulet95e7ea32019-07-15 21:01:29 +02001116 appctx->st0 = HTX_CACHE_INIT;
William Lallemand77c11972017-10-31 20:43:01 +01001117 appctx->rule = rule;
1118 appctx->ctx.cache.entry = res;
Frédéric Lécaille8df65ae2018-10-22 18:01:48 +02001119 appctx->ctx.cache.next = NULL;
1120 appctx->ctx.cache.sent = 0;
Willy Tarreaua1214a52018-12-14 14:00:25 +01001121
1122 if (px == strm_fe(s))
Olivier Houchardaa090d42019-03-08 18:49:24 +01001123 _HA_ATOMIC_ADD(&px->fe_counters.p.http.cache_hits, 1);
Willy Tarreaua1214a52018-12-14 14:00:25 +01001124 else
Olivier Houchardaa090d42019-03-08 18:49:24 +01001125 _HA_ATOMIC_ADD(&px->be_counters.p.http.cache_hits, 1);
Olivier Houchardfccf8402017-11-01 14:04:02 +01001126 return ACT_RET_CONT;
William Lallemand77c11972017-10-31 20:43:01 +01001127 } else {
William Lallemand55e76742017-11-21 20:01:28 +01001128 shctx_lock(shctx_ptr(cache));
1129 shctx_row_dec_hot(shctx_ptr(cache), block_ptr(res));
1130 shctx_unlock(shctx_ptr(cache));
Olivier Houchardfccf8402017-11-01 14:04:02 +01001131 return ACT_RET_YIELD;
William Lallemand77c11972017-10-31 20:43:01 +01001132 }
1133 }
William Lallemanda400a3a2017-11-20 19:13:12 +01001134 shctx_unlock(shctx_ptr(cache));
Olivier Houchardfccf8402017-11-01 14:04:02 +01001135 return ACT_RET_CONT;
William Lallemand41db4602017-10-30 11:15:51 +01001136}
1137
1138
1139enum act_parse_ret parse_cache_use(const char **args, int *orig_arg, struct proxy *proxy,
1140 struct act_rule *rule, char **err)
1141{
William Lallemand41db4602017-10-30 11:15:51 +01001142 rule->action = ACT_CUSTOM;
1143 rule->action_ptr = http_action_req_cache_use;
1144
Christopher Faulet95220e22018-12-07 17:34:39 +01001145 if (!parse_cache_rule(proxy, args[*orig_arg], rule, err))
William Lallemand41db4602017-10-30 11:15:51 +01001146 return ACT_RET_PRS_ERR;
William Lallemand41db4602017-10-30 11:15:51 +01001147
1148 (*orig_arg)++;
1149 return ACT_RET_PRS_OK;
William Lallemand41db4602017-10-30 11:15:51 +01001150}
1151
1152int cfg_parse_cache(const char *file, int linenum, char **args, int kwm)
1153{
1154 int err_code = 0;
1155
1156 if (strcmp(args[0], "cache") == 0) { /* new cache section */
1157
1158 if (!*args[1]) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001159 ha_alert("parsing [%s:%d] : '%s' expects an <id> argument\n",
1160 file, linenum, args[0]);
William Lallemand41db4602017-10-30 11:15:51 +01001161 err_code |= ERR_ALERT | ERR_ABORT;
1162 goto out;
1163 }
1164
1165 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1166 err_code |= ERR_ABORT;
1167 goto out;
1168 }
1169
1170 if (tmp_cache_config == NULL) {
1171 tmp_cache_config = calloc(1, sizeof(*tmp_cache_config));
1172 if (!tmp_cache_config) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001173 ha_alert("parsing [%s:%d]: out of memory.\n", file, linenum);
William Lallemand41db4602017-10-30 11:15:51 +01001174 err_code |= ERR_ALERT | ERR_ABORT;
1175 goto out;
1176 }
1177
1178 strlcpy2(tmp_cache_config->id, args[1], 33);
1179 if (strlen(args[1]) > 32) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001180 ha_warning("parsing [%s:%d]: cache id is limited to 32 characters, truncate to '%s'.\n",
1181 file, linenum, tmp_cache_config->id);
William Lallemand41db4602017-10-30 11:15:51 +01001182 err_code |= ERR_WARN;
1183 }
William Lallemand49b44532017-11-24 18:53:43 +01001184 tmp_cache_config->maxage = 60;
William Lallemand41db4602017-10-30 11:15:51 +01001185 tmp_cache_config->maxblocks = 0;
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001186 tmp_cache_config->maxobjsz = 0;
William Lallemand41db4602017-10-30 11:15:51 +01001187 }
1188 } else if (strcmp(args[0], "total-max-size") == 0) {
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001189 unsigned long int maxsize;
1190 char *err;
William Lallemand41db4602017-10-30 11:15:51 +01001191
1192 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1193 err_code |= ERR_ABORT;
1194 goto out;
1195 }
1196
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001197 maxsize = strtoul(args[1], &err, 10);
1198 if (err == args[1] || *err != '\0') {
1199 ha_warning("parsing [%s:%d]: total-max-size wrong value '%s'\n",
1200 file, linenum, args[1]);
1201 err_code |= ERR_ABORT;
1202 goto out;
1203 }
1204
1205 if (maxsize > (UINT_MAX >> 20)) {
1206 ha_warning("parsing [%s:%d]: \"total-max-size\" (%s) must not be greater than %u\n",
1207 file, linenum, args[1], UINT_MAX >> 20);
1208 err_code |= ERR_ABORT;
1209 goto out;
1210 }
1211
William Lallemand41db4602017-10-30 11:15:51 +01001212 /* size in megabytes */
Frédéric Lécailleb9b8b6b2018-10-25 20:17:45 +02001213 maxsize *= 1024 * 1024 / CACHE_BLOCKSIZE;
William Lallemand41db4602017-10-30 11:15:51 +01001214 tmp_cache_config->maxblocks = maxsize;
William Lallemand49b44532017-11-24 18:53:43 +01001215 } else if (strcmp(args[0], "max-age") == 0) {
1216 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1217 err_code |= ERR_ABORT;
1218 goto out;
1219 }
1220
1221 if (!*args[1]) {
1222 ha_warning("parsing [%s:%d]: '%s' expects an age parameter in seconds.\n",
1223 file, linenum, args[0]);
1224 err_code |= ERR_WARN;
1225 }
1226
1227 tmp_cache_config->maxage = atoi(args[1]);
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001228 } else if (strcmp(args[0], "max-object-size") == 0) {
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001229 unsigned int maxobjsz;
1230 char *err;
1231
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001232 if (alertif_too_many_args(1, file, linenum, args, &err_code)) {
1233 err_code |= ERR_ABORT;
1234 goto out;
1235 }
1236
1237 if (!*args[1]) {
1238 ha_warning("parsing [%s:%d]: '%s' expects a maximum file size parameter in bytes.\n",
1239 file, linenum, args[0]);
1240 err_code |= ERR_WARN;
1241 }
1242
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001243 maxobjsz = strtoul(args[1], &err, 10);
1244 if (err == args[1] || *err != '\0') {
1245 ha_warning("parsing [%s:%d]: max-object-size wrong value '%s'\n",
1246 file, linenum, args[1]);
1247 err_code |= ERR_ABORT;
1248 goto out;
1249 }
1250 tmp_cache_config->maxobjsz = maxobjsz;
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001251 }
1252 else if (*args[0] != 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001253 ha_alert("parsing [%s:%d] : unknown keyword '%s' in 'cache' section\n", file, linenum, args[0]);
William Lallemand41db4602017-10-30 11:15:51 +01001254 err_code |= ERR_ALERT | ERR_FATAL;
1255 goto out;
1256 }
1257out:
1258 return err_code;
1259}
1260
1261/* once the cache section is parsed */
1262
1263int cfg_post_parse_section_cache()
1264{
1265 struct shared_context *shctx;
1266 int err_code = 0;
1267 int ret_shctx;
1268
1269 if (tmp_cache_config) {
1270 struct cache *cache;
1271
1272 if (tmp_cache_config->maxblocks <= 0) {
Christopher Faulet767a84b2017-11-24 16:50:31 +01001273 ha_alert("Size not specified for cache '%s'\n", tmp_cache_config->id);
William Lallemand41db4602017-10-30 11:15:51 +01001274 err_code |= ERR_FATAL | ERR_ALERT;
1275 goto out;
1276 }
1277
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001278 if (!tmp_cache_config->maxobjsz) {
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001279 /* Default max. file size is a 256th of the cache size. */
1280 tmp_cache_config->maxobjsz =
1281 (tmp_cache_config->maxblocks * CACHE_BLOCKSIZE) >> 8;
Frédéric Lécaille4eba5442018-10-25 20:29:31 +02001282 }
1283 else if (tmp_cache_config->maxobjsz > tmp_cache_config->maxblocks * CACHE_BLOCKSIZE / 2) {
1284 ha_alert("\"max-object-size\" is limited to an half of \"total-max-size\" => %u\n", tmp_cache_config->maxblocks * CACHE_BLOCKSIZE / 2);
1285 err_code |= ERR_FATAL | ERR_ALERT;
1286 goto out;
1287 }
Frédéric Lécaillea2219f52018-10-22 16:59:13 +02001288
1289 ret_shctx = shctx_init(&shctx, tmp_cache_config->maxblocks, CACHE_BLOCKSIZE,
1290 tmp_cache_config->maxobjsz, sizeof(struct cache), 1);
William Lallemand4da3f8a2017-10-31 14:33:34 +01001291
Frédéric Lécaillebc584492018-10-25 20:18:59 +02001292 if (ret_shctx <= 0) {
William Lallemand41db4602017-10-30 11:15:51 +01001293 if (ret_shctx == SHCTX_E_INIT_LOCK)
Christopher Faulet767a84b2017-11-24 16:50:31 +01001294 ha_alert("Unable to initialize the lock for the cache.\n");
William Lallemand41db4602017-10-30 11:15:51 +01001295 else
Christopher Faulet767a84b2017-11-24 16:50:31 +01001296 ha_alert("Unable to allocate cache.\n");
William Lallemand41db4602017-10-30 11:15:51 +01001297
1298 err_code |= ERR_FATAL | ERR_ALERT;
1299 goto out;
1300 }
William Lallemanda400a3a2017-11-20 19:13:12 +01001301 shctx->free_block = cache_free_blocks;
William Lallemand41db4602017-10-30 11:15:51 +01001302 memcpy(shctx->data, tmp_cache_config, sizeof(struct cache));
1303 cache = (struct cache *)shctx->data;
1304 cache->entries = EB_ROOT_UNIQUE;
William Lallemand41db4602017-10-30 11:15:51 +01001305 LIST_ADDQ(&caches, &cache->list);
1306 }
1307out:
1308 free(tmp_cache_config);
1309 tmp_cache_config = NULL;
1310 return err_code;
1311
William Lallemand41db4602017-10-30 11:15:51 +01001312}
1313
William Lallemand41db4602017-10-30 11:15:51 +01001314struct flt_ops cache_ops = {
1315 .init = cache_store_init,
Christopher Faulet95220e22018-12-07 17:34:39 +01001316 .check = cache_store_check,
1317 .deinit = cache_store_deinit,
William Lallemand41db4602017-10-30 11:15:51 +01001318
William Lallemand4da3f8a2017-10-31 14:33:34 +01001319 /* Handle channels activity */
1320 .channel_start_analyze = cache_store_chn_start_analyze,
William Lallemand49dc0482017-11-24 14:33:54 +01001321 .channel_end_analyze = cache_store_chn_end_analyze,
Christopher Faulet839791a2019-01-07 16:12:07 +01001322 .channel_post_analyze = cache_store_post_analyze,
William Lallemand4da3f8a2017-10-31 14:33:34 +01001323
1324 /* Filter HTTP requests and responses */
1325 .http_headers = cache_store_http_headers,
Christopher Faulet54a8d5a2018-12-07 12:21:11 +01001326 .http_payload = cache_store_http_payload,
William Lallemand4da3f8a2017-10-31 14:33:34 +01001327 .http_end = cache_store_http_end,
William Lallemand41db4602017-10-30 11:15:51 +01001328};
1329
Christopher Faulet99a17a22018-12-11 09:18:27 +01001330
1331
1332static int
1333parse_cache_flt(char **args, int *cur_arg, struct proxy *px,
1334 struct flt_conf *fconf, char **err, void *private)
1335{
1336 struct flt_conf *f, *back;
Willy Tarreaua73da1e2018-12-14 10:19:28 +01001337 struct cache_flt_conf *cconf = NULL;
Christopher Faulet99a17a22018-12-11 09:18:27 +01001338 char *name = NULL;
1339 int pos = *cur_arg;
1340
1341 /* Get the cache filter name*/
1342 if (!strcmp(args[pos], "cache")) {
1343 if (!*args[pos + 1]) {
1344 memprintf(err, "%s : expects an <id> argument", args[pos]);
1345 goto error;
1346 }
1347 name = strdup(args[pos + 1]);
1348 if (!name) {
1349 memprintf(err, "%s '%s' : out of memory", args[pos], args[pos + 1]);
1350 goto error;
1351 }
1352 pos += 2;
1353 }
1354
1355 /* Check if an implicit filter with the same name already exists. If so,
1356 * we remove the implicit filter to use the explicit one. */
1357 list_for_each_entry_safe(f, back, &px->filter_configs, list) {
1358 if (f->id != cache_store_flt_id)
1359 continue;
1360
1361 cconf = f->conf;
1362 if (strcmp(name, cconf->c.name)) {
1363 cconf = NULL;
1364 continue;
1365 }
1366
1367 if (!(cconf->flags & CACHE_FLT_F_IMPLICIT_DECL)) {
1368 cconf = NULL;
1369 memprintf(err, "%s: multiple explicit declarations of the cache filter '%s'",
1370 px->id, name);
1371 return -1;
1372 }
1373
1374 /* Remove the implicit filter. <cconf> is kept for the explicit one */
1375 LIST_DEL(&f->list);
1376 free(f);
1377 free(name);
1378 break;
1379 }
1380
1381 /* No implicit cache filter found, create configuration for the explicit one */
1382 if (!cconf) {
1383 cconf = calloc(1, sizeof(*cconf));
1384 if (!cconf) {
1385 memprintf(err, "%s: out of memory", args[*cur_arg]);
1386 goto error;
1387 }
1388 cconf->c.name = name;
1389 }
1390
1391 cconf->flags = 0;
1392 fconf->id = cache_store_flt_id;
1393 fconf->conf = cconf;
1394 fconf->ops = &cache_ops;
1395
1396 *cur_arg = pos;
1397 return 0;
1398
1399 error:
1400 free(name);
1401 free(cconf);
1402 return -1;
1403}
1404
Aurélien Nephtaliabbf6072018-04-18 13:26:46 +02001405static int cli_parse_show_cache(char **args, char *payload, struct appctx *appctx, void *private)
William Lallemand1f49a362017-11-21 20:01:26 +01001406{
1407 if (!cli_has_level(appctx, ACCESS_LVL_ADMIN))
1408 return 1;
1409
1410 return 0;
1411}
1412
1413static int cli_io_handler_show_cache(struct appctx *appctx)
1414{
1415 struct cache* cache = appctx->ctx.cli.p0;
1416 struct stream_interface *si = appctx->owner;
1417
William Lallemand1f49a362017-11-21 20:01:26 +01001418 if (cache == NULL) {
1419 cache = LIST_ELEM((caches).n, typeof(struct cache *), list);
1420 }
1421
1422 list_for_each_entry_from(cache, &caches, list) {
1423 struct eb32_node *node = NULL;
1424 unsigned int next_key;
1425 struct cache_entry *entry;
1426
William Lallemand1f49a362017-11-21 20:01:26 +01001427 next_key = appctx->ctx.cli.i0;
Willy Tarreauafe1de52018-04-04 11:56:43 +02001428 if (!next_key) {
1429 chunk_printf(&trash, "%p: %s (shctx:%p, available blocks:%d)\n", cache, cache->id, shctx_ptr(cache), shctx_ptr(cache)->nbav);
1430 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001431 si_rx_room_blk(si);
Willy Tarreauafe1de52018-04-04 11:56:43 +02001432 return 0;
1433 }
1434 }
William Lallemand1f49a362017-11-21 20:01:26 +01001435
1436 appctx->ctx.cli.p0 = cache;
1437
1438 while (1) {
1439
1440 shctx_lock(shctx_ptr(cache));
1441 node = eb32_lookup_ge(&cache->entries, next_key);
1442 if (!node) {
1443 shctx_unlock(shctx_ptr(cache));
Willy Tarreauafe1de52018-04-04 11:56:43 +02001444 appctx->ctx.cli.i0 = 0;
William Lallemand1f49a362017-11-21 20:01:26 +01001445 break;
1446 }
1447
1448 entry = container_of(node, struct cache_entry, eb);
Willy Tarreauafe1de52018-04-04 11:56:43 +02001449 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 +01001450
1451 next_key = node->key + 1;
1452 appctx->ctx.cli.i0 = next_key;
1453
1454 shctx_unlock(shctx_ptr(cache));
1455
1456 if (ci_putchk(si_ic(si), &trash) == -1) {
Willy Tarreaudb398432018-11-15 11:08:52 +01001457 si_rx_room_blk(si);
William Lallemand1f49a362017-11-21 20:01:26 +01001458 return 0;
1459 }
1460 }
1461
1462 }
1463
1464 return 1;
1465
1466}
1467
Christopher Faulet99a17a22018-12-11 09:18:27 +01001468/* Declare the filter parser for "cache" keyword */
1469static struct flt_kw_list filter_kws = { "CACHE", { }, {
1470 { "cache", parse_cache_flt, NULL },
1471 { NULL, NULL, NULL },
1472 }
1473};
1474
1475INITCALL1(STG_REGISTER, flt_register_keywords, &filter_kws);
1476
William Lallemand1f49a362017-11-21 20:01:26 +01001477static struct cli_kw_list cli_kws = {{},{
William Lallemande899af82017-11-22 16:41:26 +01001478 { { "show", "cache", NULL }, "show cache : show cache status", cli_parse_show_cache, cli_io_handler_show_cache, NULL, NULL },
1479 {{},}
William Lallemand1f49a362017-11-21 20:01:26 +01001480}};
1481
Willy Tarreau0108d902018-11-25 19:14:37 +01001482INITCALL1(STG_REGISTER, cli_register_kw, &cli_kws);
William Lallemand1f49a362017-11-21 20:01:26 +01001483
William Lallemand41db4602017-10-30 11:15:51 +01001484static struct action_kw_list http_res_actions = {
1485 .kw = {
1486 { "cache-store", parse_cache_store },
1487 { NULL, NULL }
1488 }
1489};
1490
Willy Tarreau0108d902018-11-25 19:14:37 +01001491INITCALL1(STG_REGISTER, http_res_keywords_register, &http_res_actions);
1492
William Lallemand41db4602017-10-30 11:15:51 +01001493static struct action_kw_list http_req_actions = {
1494 .kw = {
1495 { "cache-use", parse_cache_use },
1496 { NULL, NULL }
1497 }
1498};
1499
Willy Tarreau0108d902018-11-25 19:14:37 +01001500INITCALL1(STG_REGISTER, http_req_keywords_register, &http_req_actions);
1501
Willy Tarreau2231b632019-03-29 18:26:52 +01001502struct applet http_cache_applet = {
William Lallemand41db4602017-10-30 11:15:51 +01001503 .obj_type = OBJ_TYPE_APPLET,
1504 .name = "<CACHE>", /* used for logging */
William Lallemand77c11972017-10-31 20:43:01 +01001505 .fct = http_cache_io_handler,
William Lallemandecb73b12017-11-24 14:33:55 +01001506 .release = http_cache_applet_release,
William Lallemand41db4602017-10-30 11:15:51 +01001507};
1508
Willy Tarreaue6552512018-11-26 11:33:13 +01001509/* config parsers for this section */
1510REGISTER_CONFIG_SECTION("cache", cfg_parse_cache, cfg_post_parse_section_cache);