varnish-cache/lib/libvcc/vcc_storage.c
0 
/*-
1 
 * Copyright (c) 2010-2015 Varnish Software AS
2 
 * All rights reserved.
3 
 *
4 
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
5 
 *
6 
 * SPDX-License-Identifier: BSD-2-Clause
7 
 *
8 
 * Redistribution and use in source and binary forms, with or without
9 
 * modification, are permitted provided that the following conditions
10 
 * are met:
11 
 * 1. Redistributions of source code must retain the above copyright
12 
 *    notice, this list of conditions and the following disclaimer.
13 
 * 2. Redistributions in binary form must reproduce the above copyright
14 
 *    notice, this list of conditions and the following disclaimer in the
15 
 *    documentation and/or other materials provided with the distribution.
16 
 *
17 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21 
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 
 * SUCH DAMAGE.
28 
 *
29 
 * All stuff related to the storage.* part of the namespace.
30 
 *
31 
 * "All" is actually only a wildcard function, which instantiates variables
32 
 * on demand under the storage.* tree of the namespace.
33 
 *
34 
 * About the syntax:
35 
 * -----------------
36 
 *
37 
 * One of our long term goals is to have dynamic storage configuration, such
38 
 * as the ability to add or remove a stevedore on the fly, without restarting
39 
 * the worker process.
40 
 *
41 
 * Even though this goal is far out in the future, it influences the syntax
42 
 * design of storage selection from VCL.
43 
 *
44 
 * In difference from backends, where we know the possible set of backends at
45 
 * compile time, we will not in the future know the identity of the stevedores
46 
 * available at compile time, so we have to rely on VRT name resolution.
47 
 *
48 
 * This indicates a namespace on the form storage.<stevedore>.<property>
49 
 *
50 
 * For each property, we must define a default value if the named stevedore
51 
 * does not exists, such that for instance stevedore.forgetit.freespace
52 
 * returns zero etc.
53 
 *
54 
 */
55 





56
  
  
#include "config.h"





57
  
  





58
  
  
#include <stdlib.h>





59
  
  
#include <string.h>





60
  
  





61
  
  
#include "vcc_compile.h"





62
  
  





63
  
  
void





64
  120040
  
vcc_stevedore(struct vcc *vcc, const char *stv_name)





65
  
  
{





66
  
  
        struct symbol *sym;





67
  
  
        char buf[1024];





68
  
  





69
  120040
  
        CHECK_OBJ_NOTNULL(vcc, VCC_MAGIC);





70
  120040
  
        bprintf(buf, "storage.%s", stv_name);





71
  120040
  
        sym = VCC_MkSym(vcc, buf, SYM_MAIN, SYM_VAR, VCL_LOW, VCL_41);





72
  120040
  
        AN(sym);





73
  120040
  
        sym->type = STEVEDORE;





74
  120040
  
        sym->eval = vcc_Eval_Var;





75
  120040
  
        bprintf(buf, "VRT_stevedore(\"%s\")", stv_name);





76
  120040
  
        sym->rname = TlDup(vcc, buf);





77
  120040
  
        sym->r_methods = ~0;





78
  120040
  
}