blob: fedd9d2472e5b2eb450770ab1a85e59ea4171602 [file] [log] [blame]
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +01001/*
2 * MAP management functions.
3 *
4 * Copyright 2000-2013 Willy Tarreau <w@1wt.eu>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
13#include <limits.h>
14#include <stdio.h>
15
16#include <common/standard.h>
17
18#include <types/global.h>
19#include <types/map.h>
Thierry FOURNIER1e00d382014-02-11 11:31:40 +010020#include <types/pattern.h>
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010021
22#include <proto/arg.h>
Thierry FOURNIERb0c0a0f2013-12-10 15:05:34 +010023#include <proto/map.h>
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010024#include <proto/pattern.h>
25#include <proto/sample.h>
26
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010027/* Parse an IPv4 address and store it into the sample.
28 * The output type is IPV4.
29 */
Thierry FOURNIERb0c0a0f2013-12-10 15:05:34 +010030int map_parse_ip(const char *text, struct sample_storage *smp)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010031{
32 if (!buf2ip(text, strlen(text), &smp->data.ipv4))
33 return 0;
34 smp->type = SMP_T_IPV4;
35 return 1;
36}
37
38/* Parse an IPv6 address and store it into the sample.
39 * The output type is IPV6.
40 */
Thierry FOURNIERb0c0a0f2013-12-10 15:05:34 +010041int map_parse_ip6(const char *text, struct sample_storage *smp)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010042{
43 if (!buf2ip6(text, strlen(text), &smp->data.ipv6))
44 return 0;
45 smp->type = SMP_T_IPV6;
46 return 1;
47}
48
49/* Parse a string and store a pointer to it into the sample. The original
50 * string must be left in memory because we return a direct memory reference.
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +010051 * The output type is SMP_T_STR. There is no risk that the data will be
52 * overwritten because sample_conv_map() makes a const sample with this
53 * output.
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010054 */
Thierry FOURNIERb0c0a0f2013-12-10 15:05:34 +010055int map_parse_str(const char *text, struct sample_storage *smp)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010056{
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010057 smp->data.str.str = (char *)text;
58 smp->data.str.len = strlen(text);
59 smp->data.str.size = smp->data.str.len + 1;
Thierry FOURNIER7654c9f2013-12-17 00:20:33 +010060 smp->type = SMP_T_STR;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010061 return 1;
62}
63
64/* Parse an integer and convert it to a sample. The output type is SINT if the
65 * number is negative, or UINT if it is positive or null. The function returns
66 * zero (error) if the number is too large.
67 */
Thierry FOURNIERb0c0a0f2013-12-10 15:05:34 +010068int map_parse_int(const char *text, struct sample_storage *smp)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010069{
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +020070 smp->type = SMP_T_SINT;
71 smp->data.sint = read_int64(&text, text + strlen(text));
72 if (*text != '\0')
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010073 return 0;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010074 return 1;
75}
76
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010077/* This crete and initialize map descriptor.
78 * Return NULL if out of memory error
79 */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +010080static struct map_descriptor *map_create_descriptor(struct sample_conv *conv)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010081{
82 struct map_descriptor *desc;
83
84 desc = calloc(1, sizeof(*desc));
85 if (!desc)
86 return NULL;
87
88 desc->conv = conv;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010089
90 return desc;
91}
92
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +010093/* This function load the map file according with data type declared into
94 * the "struct sample_conv".
95 *
96 * This function choose the indexation type (ebtree or list) according with
97 * the type of match needed.
98 */
Thierry FOURNIER3def3932015-04-07 11:27:54 +020099int sample_load_map(struct arg *arg, struct sample_conv *conv,
100 const char *file, int line, char **err)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100101{
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100102 struct map_descriptor *desc;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100103
104 /* create new map descriptor */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100105 desc = map_create_descriptor(conv);
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100106 if (!desc) {
107 memprintf(err, "out of memory");
108 return 0;
109 }
110
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100111 /* Initialize pattern */
112 pattern_init_head(&desc->pat);
113
114 /* This is original pattern, must free */
115 desc->do_free = 1;
116
117 /* Set the match method. */
Thierry FOURNIER1edc9712014-12-15 16:18:39 +0100118 desc->pat.match = pat_match_fcts[(long)conv->private];
119 desc->pat.parse = pat_parse_fcts[(long)conv->private];
120 desc->pat.index = pat_index_fcts[(long)conv->private];
121 desc->pat.delete = pat_delete_fcts[(long)conv->private];
122 desc->pat.prune = pat_prune_fcts[(long)conv->private];
123 desc->pat.expect_type = pat_match_types[(long)conv->private];
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100124
125 /* Set the output parse method. */
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100126 switch (desc->conv->out_type) {
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100127 case SMP_T_STR: desc->pat.parse_smp = map_parse_str; break;
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200128 case SMP_T_SINT: desc->pat.parse_smp = map_parse_int; break;
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100129 case SMP_T_IPV4: desc->pat.parse_smp = map_parse_ip; break;
130 case SMP_T_IPV6: desc->pat.parse_smp = map_parse_ip6; break;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100131 default:
132 memprintf(err, "map: internal haproxy error: no default parse case for the input type <%d>.",
133 conv->out_type);
134 return 0;
135 }
136
Thierry FOURNIER39bef452014-01-29 13:29:45 +0100137 /* Load map. */
Thierry FOURNIERe47e4e22014-04-28 11:18:57 +0200138 if (!pattern_read_from_file(&desc->pat, PAT_REF_MAP, arg[0].data.str.str, PAT_MF_NO_DNS,
Thierry FOURNIER94580c92014-02-11 14:36:45 +0100139 1, err, file, line))
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100140 return 0;
Thierry FOURNIER0ffe78c2013-12-05 14:40:25 +0100141
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100142 /* replace the first argument by this definition */
143 arg[0].type = ARGT_MAP;
144 arg[0].data.map = desc;
145
146 return 1;
147}
148
Thierry FOURNIER0a9a2b82015-05-11 15:20:49 +0200149static int sample_conv_map(const struct arg *arg_p, struct sample *smp, void *private)
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100150{
151 struct map_descriptor *desc;
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100152 struct pattern *pat;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100153
154 /* get config */
155 desc = arg_p[0].data.map;
156
157 /* Execute the match function. */
Thierry FOURNIER1e00d382014-02-11 11:31:40 +0100158 pat = pattern_exec_match(&desc->pat, smp, 1);
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100159
160 /* Match case. */
161 if (pat) {
162 /* Copy sample. */
163 if (pat->smp) {
164 smp->type = pat->smp->type;
165 smp->flags |= SMP_F_CONST;
166 memcpy(&smp->data, &pat->smp->data, sizeof(smp->data));
167 return 1;
168 }
169
170 /* Return just int sample containing 1. */
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200171 smp->type = SMP_T_SINT;
172 smp->data.sint = 1;
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100173 return 1;
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100174 }
175
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100176 /* If no default value avalaible, the converter fails. */
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100177 if (arg_p[1].type == ARGT_STOP)
Thierry FOURNIER1794fdf2014-01-17 15:25:13 +0100178 return 0;
179
180 /* Return the default value. */
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100181 switch (desc->conv->out_type) {
182
183 case SMP_T_STR:
184 smp->type = SMP_T_STR;
185 smp->flags |= SMP_F_CONST;
186 smp->data.str = arg_p[1].data.str;
187 break;
188
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200189 case SMP_T_SINT:
190 smp->type = SMP_T_SINT;
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +0200191 smp->data.sint = arg_p[1].data.sint;
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100192 break;
193
194 case SMP_T_IPV4:
195 smp->type = SMP_T_IPV4;
196 smp->data.ipv4 = arg_p[1].data.ipv4;
197 break;
198
199 case SMP_T_IPV6:
200 smp->type = SMP_T_IPV6;
201 smp->data.ipv6 = arg_p[1].data.ipv6;
202 break;
203 }
204
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100205 return 1;
206}
207
208/* Note: must not be declared <const> as its list will be overwritten
209 *
210 * For the map_*_int keywords, the output is declared as SMP_T_UINT, but the converter function
211 * can provide SMP_T_UINT, SMP_T_SINT or SMP_T_BOOL depending on how the patterns found in the
212 * file can be parsed.
213 *
214 * For the map_*_ip keyword, the output is declared as SMP_T_IPV4, but the converter function
215 * can provide SMP_T_IPV4 or SMP_T_IPV6 depending on the patterns found in the file.
216 *
217 * The map_* keywords only emit strings.
218 *
219 * The output type is only used during the configuration parsing. It is used for detecting
220 * compatibility problems.
221 *
222 * The arguments are: <file>[,<default value>]
223 */
224static struct sample_conv_kw_list sample_conv_kws = {ILH, {
Thierry FOURNIER1edc9712014-12-15 16:18:39 +0100225 { "map", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_STR },
226 { "map_str", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_STR },
227 { "map_beg", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_BEG },
228 { "map_sub", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_SUB },
229 { "map_dir", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_DIR },
230 { "map_dom", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_DOM },
231 { "map_end", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_END },
232 { "map_reg", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_STR, SMP_T_STR, (void *)PAT_MATCH_REG },
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200233 { "map_int", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_SINT, SMP_T_STR, (void *)PAT_MATCH_INT },
Thierry FOURNIER1edc9712014-12-15 16:18:39 +0100234 { "map_ip", sample_conv_map, ARG2(1,STR,STR), sample_load_map, SMP_T_ADDR, SMP_T_STR, (void *)PAT_MATCH_IP },
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100235
Thierry FOURNIERbf65cd42015-07-20 17:45:02 +0200236 { "map_str_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_STR },
237 { "map_beg_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_BEG },
238 { "map_sub_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_SUB },
239 { "map_dir_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_DIR },
240 { "map_dom_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_DOM },
241 { "map_end_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_END },
242 { "map_reg_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_STR, SMP_T_SINT, (void *)PAT_MATCH_REG },
243 { "map_int_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_SINT, SMP_T_SINT, (void *)PAT_MATCH_INT },
244 { "map_ip_int", sample_conv_map, ARG2(1,STR,SINT), sample_load_map, SMP_T_ADDR, SMP_T_SINT, (void *)PAT_MATCH_IP },
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100245
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100246 { "map_str_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_STR, SMP_T_IPV4, (void *)PAT_MATCH_STR },
247 { "map_beg_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_STR, SMP_T_IPV4, (void *)PAT_MATCH_BEG },
248 { "map_sub_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_STR, SMP_T_IPV4, (void *)PAT_MATCH_SUB },
249 { "map_dir_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_STR, SMP_T_IPV4, (void *)PAT_MATCH_DIR },
250 { "map_dom_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_STR, SMP_T_IPV4, (void *)PAT_MATCH_DOM },
251 { "map_end_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_STR, SMP_T_IPV4, (void *)PAT_MATCH_END },
252 { "map_reg_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_STR, SMP_T_IPV4, (void *)PAT_MATCH_REG },
Thierry FOURNIER07ee64e2015-07-06 23:43:03 +0200253 { "map_int_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_SINT, SMP_T_IPV4, (void *)PAT_MATCH_INT },
Thierry FOURNIER933e5de2015-03-13 00:10:16 +0100254 { "map_ip_ip", sample_conv_map, ARG2(1,STR,IPV4), sample_load_map, SMP_T_ADDR, SMP_T_IPV4, (void *)PAT_MATCH_IP },
Thierry FOURNIERd5f624d2013-11-26 11:52:33 +0100255
256 { /* END */ },
257}};
258
259__attribute__((constructor))
260static void __map_init(void)
261{
262 /* register format conversion keywords */
263 sample_register_convs(&sample_conv_kws);
264}