1 /*
2 * include/proto/sample.h
3 * Functions for samples management.
4 *
5 * Copyright (C) 2009-2010 EXCELIANCE, Emeric Brun <ebrun@exceliance.fr>
6 * Copyright (C) 2012 Willy Tarreau <w@1wt.eu>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation, version 2.1
11 * exclusively.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23 #ifndef _PROTO_SAMPLE_H
24 #define _PROTO_SAMPLE_H
25
26 #include <types/sample.h>
27 #include <types/stick_table.h>
28
29 extern const char *smp_to_type[SMP_TYPES];
30
31 struct sample_expr *sample_parse_expr(char **str, int *idx, const char *file, int line, char **err, struct arg_list *al);
32 struct sample_conv *find_sample_conv(const char *kw, int len);
33 struct sample *sample_process(struct proxy *px, struct session *sess,
34 struct stream *strm, unsigned int opt,
35 struct sample_expr *expr, struct sample *p);
36 struct sample *sample_fetch_as_type(struct proxy *px, struct session *sess,
37 struct stream *strm, unsigned int opt,
38 struct sample_expr *expr, int smp_type);
39 void release_sample_expr(struct sample_expr *expr);
40 void sample_register_fetches(struct sample_fetch_kw_list *psl);
41 void sample_register_convs(struct sample_conv_kw_list *psl);
42 const char *sample_src_names(unsigned int use);
43 const char *sample_ckp_names(unsigned int use);
44 struct sample_fetch *find_sample_fetch(const char *kw, int len);
45 struct sample_fetch *sample_fetch_getnext(struct sample_fetch *current, int *idx);
46 struct sample_conv *sample_conv_getnext(struct sample_conv *current, int *idx);
47 int smp_resolve_args(struct proxy *p);
48 int smp_expr_output_type(struct sample_expr *expr);
49 int c_none(struct sample *smp);
50 int smp_dup(struct sample *smp);
51
52 /*
53 * This function just apply a cast on sample. It returns 0 if the cast is not
54 * avalaible or if the cast fails, otherwise returns 1. It does not modify the
55 * input sample on failure.
56 */
57 static inline
sample_convert(struct sample * sample,int req_type)58 int sample_convert(struct sample *sample, int req_type)
59 {
60 if (!sample_casts[sample->data.type][req_type])
61 return 0;
62 if (sample_casts[sample->data.type][req_type] == c_none)
63 return 1;
64 return sample_casts[sample->data.type][req_type](sample);
65 }
66
67 static inline
smp_set_owner(struct sample * smp,struct proxy * px,struct session * sess,struct stream * strm,int opt)68 struct sample *smp_set_owner(struct sample *smp, struct proxy *px,
69 struct session *sess, struct stream *strm, int opt)
70 {
71 smp->px = px;
72 smp->sess = sess;
73 smp->strm = strm;
74 smp->opt = opt;
75 return smp;
76 }
77
78
79 /* Returns 1 if a sample may be safely used. It performs a few checks on the
80 * string length versus size, same for the binary version, and ensures that
81 * strings are properly terminated by a zero. If this last point is not granted
82 * but the string is not const, then the \0 is appended. Otherwise it returns 0,
83 * meaning the caller may need to call smp_dup() before going further.
84 */
85 static inline
smp_is_safe(struct sample * smp)86 int smp_is_safe(struct sample *smp)
87 {
88 switch (smp->data.type) {
89 case SMP_T_METH:
90 if (smp->data.u.meth.meth != HTTP_METH_OTHER)
91 return 1;
92 /* Fall through */
93
94 case SMP_T_STR:
95 if ((smp->data.u.str.len < 0) ||
96 (!smp->data.u.str.size || smp->data.u.str.len >= smp->data.u.str.size))
97 return 0;
98
99 if (smp->data.u.str.str[smp->data.u.str.len] == 0)
100 return 1;
101
102 if (smp->flags & SMP_F_CONST)
103 return 0;
104
105 smp->data.u.str.str[smp->data.u.str.len] = 0;
106 return 1;
107
108 case SMP_T_BIN:
109 return (smp->data.u.str.len >= 0) &&
110 (!smp->data.u.str.size || smp->data.u.str.len <= smp->data.u.str.size);
111
112 default:
113 return 1;
114 }
115 }
116
117 /* checks that a sample may freely be used, or duplicates it to normalize it.
118 * Returns 1 on success, 0 if the sample must not be used. The function also
119 * checks for NULL to simplify the calling code.
120 */
121 static inline
smp_make_safe(struct sample * smp)122 int smp_make_safe(struct sample *smp)
123 {
124 return smp && (smp_is_safe(smp) || smp_dup(smp));
125 }
126
127 /* Returns 1 if a sample may be safely modified in place. It performs a few
128 * checks on the string length versus size, same for the binary version, and
129 * ensures that strings are properly terminated by a zero, and of course that
130 * the size is allocate and that the SMP_F_CONST flag is not set. If only the
131 * trailing zero is missing, it is appended. Otherwise it returns 0, meaning
132 * the caller may need to call smp_dup() before going further.
133 */
134 static inline
smp_is_rw(struct sample * smp)135 int smp_is_rw(struct sample *smp)
136 {
137 if (smp->flags & SMP_F_CONST)
138 return 0;
139
140 switch (smp->data.type) {
141 case SMP_T_METH:
142 if (smp->data.u.meth.meth != HTTP_METH_OTHER)
143 return 1;
144 /* Fall through */
145
146 case SMP_T_STR:
147 if (!smp->data.u.str.size ||
148 smp->data.u.str.len < 0 ||
149 smp->data.u.str.len >= smp->data.u.str.size)
150 return 0;
151
152 if (smp->data.u.str.str[smp->data.u.str.len] != 0)
153 smp->data.u.str.str[smp->data.u.str.len] = 0;
154 return 1;
155
156 case SMP_T_BIN:
157 return smp->data.u.str.size &&
158 smp->data.u.str.len >= 0 &&
159 smp->data.u.str.len <= smp->data.u.str.size;
160
161 default:
162 return 1;
163 }
164 }
165
166 /* checks that a sample may freely be modified, or duplicates it to normalize
167 * it and make it R/W. Returns 1 on success, 0 if the sample must not be used.
168 * The function also checks for NULL to simplify the calling code.
169 */
170 static inline
smp_make_rw(struct sample * smp)171 int smp_make_rw(struct sample *smp)
172 {
173 return smp && (smp_is_rw(smp) || smp_dup(smp));
174 }
175
176 #endif /* _PROTO_SAMPLE_H */
177