blob: 7536a6491d6def62963c5ae5f9710b73334b8998 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreaucc05fba2009-10-27 21:40:18 +01002 * include/common/standard.h
3 * This files contains some general purpose functions and macros.
4 *
Willy Tarreau348238b2010-01-18 15:05:57 +01005 * Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu
Willy Tarreaucc05fba2009-10-27 21:40:18 +01006 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020021
Willy Tarreau2dd0d472006-06-29 17:53:05 +020022#ifndef _COMMON_STANDARD_H
23#define _COMMON_STANDARD_H
Willy Tarreaubaaee002006-06-26 02:48:02 +020024
Willy Tarreau167d8b52007-04-09 22:16:12 +020025#include <limits.h>
Willy Tarreau050737f2010-01-14 11:40:12 +010026#include <string.h>
Willy Tarreau0ebb5112016-12-05 00:10:57 +010027#include <stdio.h>
Willy Tarreaufe944602007-10-25 10:34:16 +020028#include <time.h>
David Carlier5222d8e2017-11-03 12:00:26 +000029#include <stdarg.h>
Willy Tarreaue6e49cf2015-04-29 17:13:35 +020030#include <sys/time.h>
Willy Tarreau938b3032007-05-10 06:39:03 +020031#include <sys/types.h>
Willy Tarreaud50265a2012-09-04 14:18:33 +020032#include <sys/socket.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020033#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020034#include <netinet/in.h>
Willy Tarreau5b4dd682015-07-21 23:47:18 +020035#include <arpa/inet.h>
Thierry FOURNIERe059ec92014-03-17 12:01:13 +010036#include <common/chunk.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020037#include <common/config.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020038#include <common/namespace.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010039#include <eb32tree.h>
Willy Tarreau9c1e15d2017-11-15 18:51:29 +010040#include <eb32sctree.h>
William Lallemand2fe7dd02018-09-11 16:51:29 +020041#include <types/protocol.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020042
William Lallemande7340ec2012-01-24 11:15:39 +010043#ifndef LLONG_MAX
44# define LLONG_MAX 9223372036854775807LL
45# define LLONG_MIN (-LLONG_MAX - 1LL)
46#endif
47
48#ifndef ULLONG_MAX
49# define ULLONG_MAX (LLONG_MAX * 2ULL + 1)
50#endif
51
Willy Tarreaua9db57e2013-01-18 11:29:29 +010052#ifndef LONGBITS
53#define LONGBITS ((unsigned int)sizeof(long) * 8)
54#endif
55
Thierry FOURNIER511e9472014-01-23 17:40:34 +010056/* size used for max length of decimal representation of long long int. */
57#define NB_LLMAX_STR (sizeof("-9223372036854775807")-1)
58
Willy Tarreau56adcf22012-12-23 18:00:29 +010059/* number of itoa_str entries */
Willy Tarreau59caa3b2018-12-14 13:59:42 +010060#define NB_ITOA_STR 16
William Lallemande7340ec2012-01-24 11:15:39 +010061
Willy Tarreau588297f2014-06-16 15:16:40 +020062/* maximum quoted string length (truncated above) */
63#define QSTR_SIZE 200
64#define NB_QSTR 10
65
Willy Tarreaubaaee002006-06-26 02:48:02 +020066/****** string-specific macros and functions ******/
67/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
68#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
69
70/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
71#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
72
73/* returns 1 only if only zero or one bit is set in X, which means that X is a
74 * power of 2, and 0 otherwise */
75#define POWEROF2(x) (((x) & ((x)-1)) == 0)
76
Willy Tarreau5b180202010-07-18 10:40:48 +020077/* operators to compare values. They're ordered that way so that the lowest bit
78 * serves as a negation for the test and contains all tests that are not equal.
79 */
80enum {
81 STD_OP_LE = 0, STD_OP_GT = 1,
82 STD_OP_EQ = 2, STD_OP_NE = 3,
83 STD_OP_GE = 4, STD_OP_LT = 5,
84};
85
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010086enum http_scheme {
87 SCH_HTTP,
88 SCH_HTTPS,
89};
90
91struct split_url {
92 enum http_scheme scheme;
93 const char *host;
94 int host_len;
95};
96
Christopher Faulet99bca652017-11-14 16:47:26 +010097extern THREAD_LOCAL int itoa_idx; /* index of next itoa_str to use */
Willy Tarreau56adcf22012-12-23 18:00:29 +010098
Willy Tarreau7d58a632007-01-13 23:06:06 +010099/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200100 * copies at most <size-1> chars from <src> to <dst>. Last char is always
101 * set to 0, unless <size> is 0. The number of chars copied is returned
102 * (excluding the terminating zero).
103 * This code has been optimized for size and speed : on x86, it's 45 bytes
104 * long, uses only registers, and consumes only 4 cycles per char.
105 */
106extern int strlcpy2(char *dst, const char *src, int size);
107
108/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200109 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200110 * the ascii representation for number 'n' in decimal.
111 */
Christopher Faulet99bca652017-11-14 16:47:26 +0100112extern THREAD_LOCAL char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100113extern char *ultoa_r(unsigned long n, char *buffer, int size);
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200114extern char *lltoa_r(long long int n, char *buffer, int size);
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200115extern char *sltoa_r(long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200116extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200117static inline const char *ultoa(unsigned long n)
118{
119 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
120}
121
William Lallemande7340ec2012-01-24 11:15:39 +0100122/*
123 * unsigned long long ASCII representation
124 *
125 * return the last char '\0' or NULL if no enough
126 * space in dst
127 */
128char *ulltoa(unsigned long long n, char *dst, size_t size);
129
130
131/*
132 * unsigned long ASCII representation
133 *
134 * return the last char '\0' or NULL if no enough
135 * space in dst
136 */
137char *ultoa_o(unsigned long n, char *dst, size_t size);
138
139/*
140 * signed long ASCII representation
141 *
142 * return the last char '\0' or NULL if no enough
143 * space in dst
144 */
145char *ltoa_o(long int n, char *dst, size_t size);
146
147/*
148 * signed long long ASCII representation
149 *
150 * return the last char '\0' or NULL if no enough
151 * space in dst
152 */
153char *lltoa(long long n, char *dst, size_t size);
154
155/*
156 * write a ascii representation of a unsigned into dst,
157 * return a pointer to the last character
158 * Pad the ascii representation with '0', using size.
159 */
160char *utoa_pad(unsigned int n, char *dst, size_t size);
161
Willy Tarreaubaaee002006-06-26 02:48:02 +0200162/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200163 * This function simply returns a locally allocated string containing the ascii
164 * representation for number 'n' in decimal, unless n is 0 in which case it
165 * returns the alternate string (or an empty string if the alternate string is
166 * NULL). It use is intended for limits reported in reports, where it's
167 * desirable not to display anything if there is no limit. Warning! it shares
168 * the same vector as ultoa_r().
169 */
170extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
171
Willy Tarreau56adcf22012-12-23 18:00:29 +0100172/* returns a locally allocated string containing the ASCII representation of
173 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
174 * function call (eg: printf), shared with the other similar functions making
175 * use of itoa_str[].
176 */
177static inline const char *U2A(unsigned long n)
178{
179 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
180 if (++itoa_idx >= NB_ITOA_STR)
181 itoa_idx = 0;
182 return ret;
183}
184
185/* returns a locally allocated string containing the HTML representation of
186 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
187 * function call (eg: printf), shared with the other similar functions making
188 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200189 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100190static inline const char *U2H(unsigned long long n)
191{
192 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
193 if (++itoa_idx >= NB_ITOA_STR)
194 itoa_idx = 0;
195 return ret;
196}
197
Ioannis Cherouvim1ff76332018-10-24 10:05:19 +0300198/* returns a locally allocated string containing the ASCII representation of
Willy Tarreau56adcf22012-12-23 18:00:29 +0100199 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
200 * function call (eg: printf), shared with the other similar functions making
201 * use of itoa_str[].
202 */
203static inline const char *LIM2A(unsigned long n, const char *alt)
204{
205 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
206 if (++itoa_idx >= NB_ITOA_STR)
207 itoa_idx = 0;
208 return ret;
209}
Willy Tarreau91092e52007-10-25 16:58:42 +0200210
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200211/* Encode the integer <i> into a varint (variable-length integer). The encoded
212 * value is copied in <*buf>. Here is the encoding format:
213 *
214 * 0 <= X < 240 : 1 byte (7.875 bits) [ XXXX XXXX ]
215 * 240 <= X < 2288 : 2 bytes (11 bits) [ 1111 XXXX ] [ 0XXX XXXX ]
216 * 2288 <= X < 264432 : 3 bytes (18 bits) [ 1111 XXXX ] [ 1XXX XXXX ] [ 0XXX XXXX ]
217 * 264432 <= X < 33818864 : 4 bytes (25 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*2 [ 0XXX XXXX ]
218 * 33818864 <= X < 4328786160 : 5 bytes (32 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*3 [ 0XXX XXXX ]
219 * ...
220 *
221 * On success, it returns the number of written bytes and <*buf> is moved after
222 * the encoded value. Otherwise, it returns -1. */
223static inline int
224encode_varint(uint64_t i, char **buf, char *end)
225{
226 unsigned char *p = (unsigned char *)*buf;
227 int r;
228
229 if (p >= (unsigned char *)end)
230 return -1;
231
232 if (i < 240) {
233 *p++ = i;
234 *buf = (char *)p;
235 return 1;
236 }
237
238 *p++ = (unsigned char)i | 240;
239 i = (i - 240) >> 4;
240 while (i >= 128) {
241 if (p >= (unsigned char *)end)
242 return -1;
243 *p++ = (unsigned char)i | 128;
244 i = (i - 128) >> 7;
245 }
246
247 if (p >= (unsigned char *)end)
248 return -1;
249 *p++ = (unsigned char)i;
250
251 r = ((char *)p - *buf);
252 *buf = (char *)p;
253 return r;
254}
255
256/* Decode a varint from <*buf> and save the decoded value in <*i>. See
257 * 'spoe_encode_varint' for details about varint.
258 * On success, it returns the number of read bytes and <*buf> is moved after the
259 * varint. Otherwise, it returns -1. */
260static inline int
261decode_varint(char **buf, char *end, uint64_t *i)
262{
263 unsigned char *p = (unsigned char *)*buf;
264 int r;
265
266 if (p >= (unsigned char *)end)
267 return -1;
268
269 *i = *p++;
270 if (*i < 240) {
271 *buf = (char *)p;
272 return 1;
273 }
274
275 r = 4;
276 do {
277 if (p >= (unsigned char *)end)
278 return -1;
279 *i += (uint64_t)*p << r;
280 r += 7;
281 } while (*p++ >= 128);
282
283 r = ((char *)p - *buf);
284 *buf = (char *)p;
285 return r;
286}
287
Willy Tarreau588297f2014-06-16 15:16:40 +0200288/* returns a locally allocated string containing the quoted encoding of the
289 * input string. The output may be truncated to QSTR_SIZE chars, but it is
290 * guaranteed that the string will always be properly terminated. Quotes are
291 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
292 * always be at least 4 chars.
293 */
294const char *qstr(const char *str);
295
296/* returns <str> or its quote-encoded equivalent if it contains at least one
297 * quote or a comma. This is aimed at build CSV-compatible strings.
298 */
299static inline const char *cstr(const char *str)
300{
301 const char *p = str;
302
303 while (*p) {
304 if (*p == ',' || *p == '"')
305 return qstr(str);
306 p++;
307 }
308 return str;
309}
310
Willy Tarreau91092e52007-10-25 16:58:42 +0200311/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200312 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
313 */
314extern int ishex(char s);
315
316/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100317 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200318 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100319 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200320static inline int hex2i(int c)
321{
Willy Tarreauaa398602017-11-10 11:19:54 +0100322 if ((unsigned char)(c -= '0') > 9) {
323 if ((unsigned char)(c -= 'A' - '0') > 5 &&
324 (unsigned char)(c -= 'a' - 'A') > 5)
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200325 c = -11;
326 c += 10;
327 }
328 return c;
329}
330
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100331/* rounds <i> down to the closest value having max 2 digits */
332unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100333
334/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100335 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
336 * invalid character is found, a pointer to it is returned. If everything is
337 * fine, NULL is returned.
338 */
339extern const char *invalid_char(const char *name);
340
341/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200342 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200343 * If an invalid character is found, a pointer to it is returned.
344 * If everything is fine, NULL is returned.
345 */
346extern const char *invalid_domainchar(const char *name);
347
348/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200349 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
350 * If an invalid character is found, a pointer to it is returned.
351 * If everything is fine, NULL is returned.
352 */
353extern const char *invalid_prefix_char(const char *name);
354
355/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100356 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200357 * port range consisting in two integers. The low and high end are always set
358 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100359 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200360 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100361 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
362 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
363 * address wants to ignore port, it must be terminated by a trailing colon (':').
364 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
365 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100366 * If <pfx> is non-null, it is used as a string prefix before any path-based
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200367 * address (typically the path to a unix socket). If use_dns is not true,
Joseph Herlant32b83272018-11-15 11:58:28 -0800368 * the function cannot accept the DNS resolution.
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200369 */
Willy Tarreau48ef4c92017-01-06 18:32:38 +0100370struct sockaddr_storage *str2sa_range(const char *str,
371 int *port, int *low, int *high,
372 char **err, const char *pfx,
373 char **fqdn, int resolve);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200374
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100375/* converts <str> to a struct in_addr containing a network mask. It can be
376 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +0300377 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100378 */
379int str2mask(const char *str, struct in_addr *mask);
380
Tim Duesterhus47185172018-01-25 16:24:49 +0100381/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +0100382 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +0100383 * if the conversion succeeds otherwise zero.
384 */
385int str2mask6(const char *str, struct in6_addr *mask);
386
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100387/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
388 * succeeds otherwise non-zero.
389 */
390int cidr2dotted(int cidr, struct in_addr *mask);
391
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200392/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200393 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200394 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
395 * is optionnal and either in the dotted or CIDR notation.
396 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
397 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100398int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200399
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100400/* str2ip and str2ip2:
401 *
402 * converts <str> to a struct sockaddr_storage* provided by the caller. The
403 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
404 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
405 * the function tries to guess the address family from the syntax. If the
406 * family is forced and the format doesn't match, an error is returned. The
407 * string is assumed to contain only an address, no port. The address can be a
408 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
409 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
410 * The return address will only have the address family and the address set,
411 * all other fields remain zero. The string is not supposed to be modified.
412 * The IPv6 '::' address is IN6ADDR_ANY.
413 *
414 * str2ip2:
415 *
416 * If <resolve> is set, this function try to resolve DNS, otherwise, it returns
417 * NULL result.
418 */
419struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve);
420static inline struct sockaddr_storage *str2ip(const char *str, struct sockaddr_storage *sa)
421{
422 return str2ip2(str, sa, 1);
423}
424
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100425/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200426 * converts <str> to two struct in6_addr* which must be pre-allocated.
427 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
428 * is an optionnal number of bits (128 being the default).
429 * Returns 1 if OK, 0 if error.
430 */
431int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
432
433/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200434 * Parse IP address found in url.
435 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100436int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200437
438/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100439 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100440 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100441int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100442
Willy Tarreau631f01c2011-09-05 00:36:48 +0200443/* Tries to convert a sockaddr_storage address to text form. Upon success, the
444 * address family is returned so that it's easy for the caller to adapt to the
445 * output format. Zero is returned if the address family is not supported. -1
446 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
447 * supported.
448 */
449int addr_to_str(struct sockaddr_storage *addr, char *str, int size);
450
Simon Horman75ab8bd2014-06-16 09:39:41 +0900451/* Tries to convert a sockaddr_storage port to text form. Upon success, the
452 * address family is returned so that it's easy for the caller to adapt to the
453 * output format. Zero is returned if the address family is not supported. -1
454 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
455 * supported.
456 */
457int port_to_str(struct sockaddr_storage *addr, char *str, int size);
458
Willy Tarreau16e01562016-08-09 16:46:18 +0200459/* check if the given address is local to the system or not. It will return
460 * -1 when it's not possible to know, 0 when the address is not local, 1 when
461 * it is. We don't want to iterate over all interfaces for this (and it is not
462 * portable). So instead we try to bind in UDP to this address on a free non
463 * privileged port and to connect to the same address, port 0 (connect doesn't
464 * care). If it succeeds, we own the address. Note that non-inet addresses are
465 * considered local since they're most likely AF_UNIX.
466 */
467int addr_is_local(const struct netns_entry *ns,
468 const struct sockaddr_storage *orig);
469
Willy Tarreaubaaee002006-06-26 02:48:02 +0200470/* will try to encode the string <string> replacing all characters tagged in
471 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
472 * prefixed by <escape>, and will store the result between <start> (included)
473 * and <stop> (excluded), and will always terminate the string with a '\0'
474 * before <stop>. The position of the '\0' is returned if the conversion
475 * completes. If bytes are missing between <start> and <stop>, then the
476 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
477 * cannot even be stored so we return <start> without writing the 0.
478 * The input string must also be zero-terminated.
479 */
480extern const char hextab[];
481char *encode_string(char *start, char *stop,
482 const char escape, const fd_set *map,
483 const char *string);
484
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100485/*
486 * Same behavior, except that it encodes chunk <chunk> instead of a string.
487 */
488char *encode_chunk(char *start, char *stop,
489 const char escape, const fd_set *map,
Willy Tarreau83061a82018-07-13 11:56:34 +0200490 const struct buffer *chunk);
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100491
Dragan Dosen0edd1092016-02-12 13:23:02 +0100492/*
493 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200494 * character. The input <string> must be zero-terminated. The result will
495 * be stored between <start> (included) and <stop> (excluded). This
496 * function will always try to terminate the resulting string with a '\0'
497 * before <stop>, and will return its position if the conversion
498 * completes.
499 */
500char *escape_string(char *start, char *stop,
501 const char escape, const fd_set *map,
502 const char *string);
503
504/*
505 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +0100506 * character. <chunk> contains the input to be escaped. The result will be
507 * stored between <start> (included) and <stop> (excluded). The function
508 * will always try to terminate the resulting string with a '\0' before
509 * <stop>, and will return its position if the conversion completes.
510 */
511char *escape_chunk(char *start, char *stop,
512 const char escape, const fd_set *map,
Willy Tarreau83061a82018-07-13 11:56:34 +0200513 const struct buffer *chunk);
Dragan Dosen0edd1092016-02-12 13:23:02 +0100514
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100515
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200516/* Check a string for using it in a CSV output format. If the string contains
517 * one of the following four char <">, <,>, CR or LF, the string is
518 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
519 * <str> is the input string to be escaped. The function assumes that
520 * the input string is null-terminated.
521 *
522 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +0100523 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200524 * format.
525 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100526 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200527 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100528 * If <quote> is 1, the converter puts the quotes only if any character is
529 * escaped. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200530 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100531 * <output> is a struct chunk used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200532 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100533 * The function returns the converted string on its output. If an error
534 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200535 * for using the function directly as printf() argument.
536 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100537 * If the output buffer is too short to contain the input string, the result
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200538 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +0100539 *
540 * This function appends the encoding to the existing output chunk. Please
541 * use csv_enc() instead if you want to replace the output chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200542 */
Willy Tarreau83061a82018-07-13 11:56:34 +0200543const char *csv_enc_append(const char *str, int quote, struct buffer *output);
Willy Tarreau898529b2016-01-06 18:07:04 +0100544
545/* same as above but the output chunk is reset first */
Willy Tarreau83061a82018-07-13 11:56:34 +0200546static inline const char *csv_enc(const char *str, int quote,
547 struct buffer *output)
Willy Tarreau898529b2016-01-06 18:07:04 +0100548{
549 chunk_reset(output);
550 return csv_enc_append(str, quote, output);
551}
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200552
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200553/* Decode an URL-encoded string in-place. The resulting string might
554 * be shorter. If some forbidden characters are found, the conversion is
555 * aborted, the string is truncated before the issue and non-zero is returned,
556 * otherwise the operation returns non-zero indicating success.
557 */
558int url_decode(char *string);
559
Willy Tarreau6911fa42007-03-04 18:06:08 +0100560/* This one is 6 times faster than strtoul() on athlon, but does
561 * no check at all.
562 */
563static inline unsigned int __str2ui(const char *s)
564{
565 unsigned int i = 0;
566 while (*s) {
567 i = i * 10 - '0';
568 i += (unsigned char)*s++;
569 }
570 return i;
571}
572
573/* This one is 5 times faster than strtoul() on athlon with checks.
574 * It returns the value of the number composed of all valid digits read.
575 */
576static inline unsigned int __str2uic(const char *s)
577{
578 unsigned int i = 0;
579 unsigned int j;
580 while (1) {
581 j = (*s++) - '0';
582 if (j > 9)
583 break;
584 i *= 10;
585 i += j;
586 }
587 return i;
588}
589
590/* This one is 28 times faster than strtoul() on athlon, but does
591 * no check at all!
592 */
593static inline unsigned int __strl2ui(const char *s, int len)
594{
595 unsigned int i = 0;
596 while (len-- > 0) {
597 i = i * 10 - '0';
598 i += (unsigned char)*s++;
599 }
600 return i;
601}
602
603/* This one is 7 times faster than strtoul() on athlon with checks.
604 * It returns the value of the number composed of all valid digits read.
605 */
606static inline unsigned int __strl2uic(const char *s, int len)
607{
608 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200609 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100610
611 while (len-- > 0) {
612 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200613 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100614 if (j > 9)
615 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200616 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100617 }
618 return i;
619}
620
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200621/* This function reads an unsigned integer from the string pointed to by <s>
622 * and returns it. The <s> pointer is adjusted to point to the first unread
623 * char. The function automatically stops at <end>.
624 */
625static inline unsigned int __read_uint(const char **s, const char *end)
626{
627 const char *ptr = *s;
628 unsigned int i = 0;
629 unsigned int j, k;
630
631 while (ptr < end) {
632 j = *ptr - '0';
633 k = i * 10;
634 if (j > 9)
635 break;
636 i = k + j;
637 ptr++;
638 }
639 *s = ptr;
640 return i;
641}
642
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200643unsigned long long int read_uint64(const char **s, const char *end);
644long long int read_int64(const char **s, const char *end);
645
Willy Tarreau6911fa42007-03-04 18:06:08 +0100646extern unsigned int str2ui(const char *s);
647extern unsigned int str2uic(const char *s);
648extern unsigned int strl2ui(const char *s, int len);
649extern unsigned int strl2uic(const char *s, int len);
650extern int strl2ic(const char *s, int len);
651extern int strl2irc(const char *s, int len, int *ret);
652extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100653extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200654extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200655unsigned int inetaddr_host(const char *text);
656unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200657unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100658
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200659static inline char *cut_crlf(char *s) {
660
Simon Horman5269cfb2013-02-13 17:48:00 +0900661 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200662 char *p = s++;
663
664 if (!*p)
665 return p;
666 }
667
Simon Horman5269cfb2013-02-13 17:48:00 +0900668 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200669
670 return s;
671}
672
673static inline char *ltrim(char *s, char c) {
674
675 if (c)
676 while (*s == c)
677 s++;
678
679 return s;
680}
681
682static inline char *rtrim(char *s, char c) {
683
684 char *p = s + strlen(s);
685
686 while (p-- > s)
687 if (*p == c)
688 *p = '\0';
689 else
690 break;
691
692 return s;
693}
694
695static inline char *alltrim(char *s, char c) {
696
697 rtrim(s, c);
698
699 return ltrim(s, c);
700}
701
Willy Tarreaufe944602007-10-25 10:34:16 +0200702/* This function converts the time_t value <now> into a broken out struct tm
703 * which must be allocated by the caller. It is highly recommended to use this
704 * function intead of localtime() because that one requires a time_t* which
705 * is not always compatible with tv_sec depending on OS/hardware combinations.
706 */
707static inline void get_localtime(const time_t now, struct tm *tm)
708{
709 localtime_r(&now, tm);
710}
711
Emeric Brun3a058f32009-06-30 18:26:00 +0200712/* This function converts the time_t value <now> into a broken out struct tm
713 * which must be allocated by the caller. It is highly recommended to use this
714 * function intead of gmtime() because that one requires a time_t* which
715 * is not always compatible with tv_sec depending on OS/hardware combinations.
716 */
717static inline void get_gmtime(const time_t now, struct tm *tm)
718{
719 gmtime_r(&now, tm);
720}
721
Willy Tarreaucb1949b2017-07-19 19:05:29 +0200722/* Counts a number of elapsed days since 01/01/0000 based solely on elapsed
723 * years and assuming the regular rule for leap years applies. It's fake but
724 * serves as a temporary origin. It's worth remembering that it's the first
725 * year of each period that is leap and not the last one, so for instance year
726 * 1 sees 366 days since year 0 was leap. For this reason we have to apply
727 * modular arithmetics which is why we offset the year by 399 before
728 * subtracting the excess at the end. No overflow here before ~11.7 million
729 * years.
730 */
731static inline unsigned int days_since_zero(unsigned int y)
732{
733 return y * 365 + (y + 399) / 4 - (y + 399) / 100 + (y + 399) / 400
734 - 399 / 4 + 399 / 100;
735}
736
737/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
738 * It is meant as a portable replacement for timegm() for use with valid inputs.
739 * Returns undefined results for invalid dates (eg: months out of range 0..11).
740 */
741extern time_t my_timegm(const struct tm *tm);
742
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100743/* This function parses a time value optionally followed by a unit suffix among
744 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
745 * expected by the caller. The computation does its best to avoid overflows.
746 * The value is returned in <ret> if everything is fine, and a NULL is returned
747 * by the function. In case of error, a pointer to the error is returned and
748 * <ret> is left untouched.
749 */
750extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100751extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100752
753/* unit flags to pass to parse_time_err */
754#define TIME_UNIT_US 0x0000
755#define TIME_UNIT_MS 0x0001
756#define TIME_UNIT_S 0x0002
757#define TIME_UNIT_MIN 0x0003
758#define TIME_UNIT_HOUR 0x0004
759#define TIME_UNIT_DAY 0x0005
760#define TIME_UNIT_MASK 0x0007
761
William Lallemand421f5b52012-02-06 18:15:57 +0100762#define SEC 1
763#define MINUTE (60 * SEC)
764#define HOUR (60 * MINUTE)
765#define DAY (24 * HOUR)
766
Willy Tarreau7f062c42009-03-05 18:43:00 +0100767/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
768 * This is used to compute fixed ratios by setting one of the operands to
769 * (2^32*ratio).
770 */
771static inline unsigned int mul32hi(unsigned int a, unsigned int b)
772{
773 return ((unsigned long long)a * b) >> 32;
774}
775
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200776/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
777 * function when you know for sure that the result fits in 32 bits, because
778 * it is optimal on x86 and on 64bit processors.
779 */
780static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
781{
782 unsigned int result;
783#ifdef __i386__
784 asm("divl %2"
785 : "=a" (result)
786 : "A"(o1), "rm"(o2));
787#else
788 result = o1 / o2;
789#endif
790 return result;
791}
792
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100793/* Simple popcountl implementation. It returns the number of ones in a word.
794 * Described here : https://graphics.stanford.edu/~seander/bithacks.html
795 */
David Carliere6c39412015-07-02 07:00:17 +0000796static inline unsigned int my_popcountl(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100797{
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100798 a = a - ((a >> 1) & ~0UL/3);
799 a = (a & ~0UL/15*3) + ((a >> 2) & ~0UL/15*3);
800 a = (a + (a >> 4)) & ~0UL/255*15;
801 return (unsigned long)(a * (~0UL/255)) >> (sizeof(unsigned long) - 1) * 8;
Willy Tarreau37994f02012-11-19 12:11:07 +0100802}
803
Willy Tarreau98d334b2018-10-15 09:33:41 +0200804/* returns non-zero if <a> has at least 2 bits set */
805static inline unsigned long atleast2(unsigned long a)
806{
807 return a & (a - 1);
808}
809
Christopher Fauletff813182017-11-22 15:00:13 +0100810/* Simple ffs implementation. It returns the position of the lowest bit set to
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100811 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
Willy Tarreau27346b02018-10-10 19:05:56 +0200812 */
Christopher Fauletff813182017-11-22 15:00:13 +0100813static inline unsigned int my_ffsl(unsigned long a)
814{
Willy Tarreau27346b02018-10-10 19:05:56 +0200815 unsigned long cnt;
Christopher Fauletff813182017-11-22 15:00:13 +0100816
Willy Tarreau27346b02018-10-10 19:05:56 +0200817#if defined(__x86_64__)
Willy Tarreauce487aa2018-10-29 16:09:57 +0100818 __asm__("bsf %1,%0\n" : "=r" (cnt) : "rm" (a));
Willy Tarreau27346b02018-10-10 19:05:56 +0200819 cnt++;
820#else
Christopher Fauletff813182017-11-22 15:00:13 +0100821
822 cnt = 1;
823#if LONG_MAX > 0x7FFFFFFFL /* 64bits */
824 if (!(a & 0xFFFFFFFFUL)) {
825 a >>= 32;
826 cnt += 32;
827 }
828#endif
829 if (!(a & 0XFFFFU)) {
830 a >>= 16;
831 cnt += 16;
832 }
833 if (!(a & 0XFF)) {
834 a >>= 8;
835 cnt += 8;
836 }
837 if (!(a & 0xf)) {
838 a >>= 4;
839 cnt += 4;
840 }
841 if (!(a & 0x3)) {
842 a >>= 2;
843 cnt += 2;
844 }
845 if (!(a & 0x1)) {
846 a >>= 1;
847 cnt += 1;
848 }
Willy Tarreau27346b02018-10-10 19:05:56 +0200849#endif /* x86_64 */
Christopher Fauletff813182017-11-22 15:00:13 +0100850
851 return cnt;
852}
853
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100854/* Simple fls implementation. It returns the position of the highest bit set to
855 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
856 */
857static inline unsigned int my_flsl(unsigned long a)
858{
859 unsigned long cnt;
860
861#if defined(__x86_64__)
862 __asm__("bsr %1,%0\n" : "=r" (cnt) : "rm" (a));
863 cnt++;
864#else
865
866 cnt = 1;
867#if LONG_MAX > 0x7FFFFFFFUL /* 64bits */
868 if (a & 0xFFFFFFFF00000000UL) {
869 a >>= 32;
870 cnt += 32;
871 }
872#endif
873 if (a & 0XFFFF0000U) {
874 a >>= 16;
875 cnt += 16;
876 }
877 if (a & 0XFF00) {
878 a >>= 8;
879 cnt += 8;
880 }
881 if (a & 0xf0) {
882 a >>= 4;
883 cnt += 4;
884 }
885 if (a & 0xc) {
886 a >>= 2;
887 cnt += 2;
888 }
889 if (a & 0x2) {
890 a >>= 1;
891 cnt += 1;
892 }
893#endif /* x86_64 */
894
895 return cnt;
896}
897
David Carliere6c39412015-07-02 07:00:17 +0000898/* Build a word with the <bits> lower bits set (reverse of my_popcountl) */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100899static inline unsigned long nbits(int bits)
900{
901 if (--bits < 0)
902 return 0;
903 else
904 return (2UL << bits) - 1;
905}
906
Willy Tarreau126d4062013-12-03 17:50:47 +0100907/*
908 * Parse binary string written in hexadecimal (source) and store the decoded
909 * result into binstr and set binstrlen to the lengh of binstr. Memory for
910 * binstr is allocated by the function. In case of error, returns 0 with an
911 * error message in err.
912 */
913int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
914
Willy Tarreau946ba592009-05-10 15:41:18 +0200915/* copies at most <n> characters from <src> and always terminates with '\0' */
916char *my_strndup(const char *src, int n);
917
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200918/*
919 * search needle in haystack
920 * returns the pointer if found, returns NULL otherwise
921 */
922const void *my_memmem(const void *, size_t, const void *, size_t);
923
Willy Tarreau482b00d2009-10-04 22:48:42 +0200924/* This function returns the first unused key greater than or equal to <key> in
925 * ID tree <root>. Zero is returned if no place is found.
926 */
927unsigned int get_next_id(struct eb_root *root, unsigned int key);
928
Willy Tarreau9c1e15d2017-11-15 18:51:29 +0100929/* dump the full tree to <file> in DOT format for debugging purposes. Will
930 * optionally highlight node <subj> if found, depending on operation <op> :
931 * 0 : nothing
932 * >0 : insertion, node/leaf are surrounded in red
933 * <0 : removal, node/leaf are dashed with no background
934 * Will optionally add "desc" as a label on the graph if set and non-null.
935 */
936void eb32sc_to_file(FILE *file, struct eb_root *root, const struct eb32sc_node *subj,
937 int op, const char *desc);
Willy Tarreaued3cda02017-11-15 15:04:05 +0100938
Willy Tarreau348238b2010-01-18 15:05:57 +0100939/* This function compares a sample word possibly followed by blanks to another
940 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
941 * otherwise zero. This intends to be used when checking HTTP headers for some
942 * values.
943 */
944int word_match(const char *sample, int slen, const char *word, int wlen);
945
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200946/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
947 * or the number of chars read in case of success.
948 */
949int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +0100950int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200951
Willy Tarreauacf95772010-06-14 19:09:21 +0200952/* To be used to quote config arg positions. Returns the string at <ptr>
953 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
954 * if ptr is NULL or empty. The string is locally allocated.
955 */
956const char *quote_arg(const char *ptr);
957
Willy Tarreau5b180202010-07-18 10:40:48 +0200958/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
959int get_std_op(const char *str);
960
Willy Tarreau4c14eaa2010-11-24 14:01:45 +0100961/* hash a 32-bit integer to another 32-bit integer */
962extern unsigned int full_hash(unsigned int a);
963static inline unsigned int __full_hash(unsigned int a)
964{
965 /* This function is one of Bob Jenkins' full avalanche hashing
966 * functions, which when provides quite a good distribution for little
967 * input variations. The result is quite suited to fit over a 32-bit
968 * space with enough variations so that a randomly picked number falls
969 * equally before any server position.
970 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
971 */
972 a = (a+0x7ed55d16) + (a<<12);
973 a = (a^0xc761c23c) ^ (a>>19);
974 a = (a+0x165667b1) + (a<<5);
975 a = (a+0xd3a2646c) ^ (a<<9);
976 a = (a+0xfd7046c5) + (a<<3);
977 a = (a^0xb55a4f09) ^ (a>>16);
978
979 /* ensure values are better spread all around the tree by multiplying
980 * by a large prime close to 3/4 of the tree.
981 */
982 return a * 3221225473U;
983}
984
Willy Tarreauf3241112019-02-26 09:56:22 +0100985/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
986 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
987 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
988 * a popcount variant and is described here :
989 * https://graphics.stanford.edu/~seander/bithacks.html
990 */
991unsigned int mask_find_rank_bit(unsigned int r, unsigned long m);
992unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
993 unsigned long a, unsigned long b,
994 unsigned long c, unsigned long d);
995void mask_prep_rank_map(unsigned long m,
996 unsigned long *a, unsigned long *b,
997 unsigned long *c, unsigned long *d);
998
Willy Tarreau422a0a52012-10-26 19:47:23 +0200999/* sets the address family to AF_UNSPEC so that is_addr() does not match */
1000static inline void clear_addr(struct sockaddr_storage *addr)
1001{
1002 addr->ss_family = AF_UNSPEC;
1003}
1004
David du Colombier6f5ccb12011-03-10 22:26:24 +01001005/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1006 * otherwise zero.
1007 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001008static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +01001009{
1010 int i;
1011
1012 switch (addr->ss_family) {
1013 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +01001014 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +01001015 case AF_INET6:
1016 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
1017 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
1018 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
1019 }
1020 return 0;
1021}
1022
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001023/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1024 * or is a unix address, otherwise returns zero.
1025 */
1026static inline int is_addr(const struct sockaddr_storage *addr)
1027{
William Lallemand2fe7dd02018-09-11 16:51:29 +02001028 if (addr->ss_family == AF_UNIX || addr->ss_family == AF_CUST_SOCKPAIR)
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001029 return 1;
1030 else
1031 return is_inet_addr(addr);
1032}
1033
David du Colombier11bcb6c2011-03-24 12:23:00 +01001034/* returns port in network byte order */
1035static inline int get_net_port(struct sockaddr_storage *addr)
1036{
1037 switch (addr->ss_family) {
1038 case AF_INET:
1039 return ((struct sockaddr_in *)addr)->sin_port;
1040 case AF_INET6:
1041 return ((struct sockaddr_in6 *)addr)->sin6_port;
1042 }
1043 return 0;
1044}
1045
1046/* returns port in host byte order */
1047static inline int get_host_port(struct sockaddr_storage *addr)
1048{
1049 switch (addr->ss_family) {
1050 case AF_INET:
1051 return ntohs(((struct sockaddr_in *)addr)->sin_port);
1052 case AF_INET6:
1053 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
1054 }
1055 return 0;
1056}
1057
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +02001058/* returns address len for <addr>'s family, 0 for unknown families */
1059static inline int get_addr_len(const struct sockaddr_storage *addr)
1060{
1061 switch (addr->ss_family) {
1062 case AF_INET:
1063 return sizeof(struct sockaddr_in);
1064 case AF_INET6:
1065 return sizeof(struct sockaddr_in6);
1066 case AF_UNIX:
1067 return sizeof(struct sockaddr_un);
1068 }
1069 return 0;
1070}
1071
David du Colombier11bcb6c2011-03-24 12:23:00 +01001072/* set port in host byte order */
1073static inline int set_net_port(struct sockaddr_storage *addr, int port)
1074{
1075 switch (addr->ss_family) {
1076 case AF_INET:
1077 ((struct sockaddr_in *)addr)->sin_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001078 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001079 case AF_INET6:
1080 ((struct sockaddr_in6 *)addr)->sin6_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001081 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001082 }
1083 return 0;
1084}
1085
1086/* set port in network byte order */
1087static inline int set_host_port(struct sockaddr_storage *addr, int port)
1088{
1089 switch (addr->ss_family) {
1090 case AF_INET:
1091 ((struct sockaddr_in *)addr)->sin_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001092 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001093 case AF_INET6:
1094 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001095 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001096 }
1097 return 0;
1098}
1099
Thierry Fournier70473a52016-02-17 17:12:14 +01001100/* Convert mask from bit length form to in_addr form.
1101 * This function never fails.
1102 */
1103void len2mask4(int len, struct in_addr *addr);
1104
1105/* Convert mask from bit length form to in6_addr form.
1106 * This function never fails.
1107 */
1108void len2mask6(int len, struct in6_addr *addr);
1109
David du Colombier4f92d322011-03-24 11:09:31 +01001110/* Return true if IPv4 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001111extern int in_net_ipv4(const void *addr, const struct in_addr *mask, const struct in_addr *net);
David du Colombier4f92d322011-03-24 11:09:31 +01001112
1113/* Return true if IPv6 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001114extern int in_net_ipv6(const void *addr, const struct in6_addr *mask, const struct in6_addr *net);
David du Colombier4f92d322011-03-24 11:09:31 +01001115
Joseph Herlant32b83272018-11-15 11:58:28 -08001116/* Map IPv4 address on IPv6 address, as specified in RFC 3513. */
David du Colombier4f92d322011-03-24 11:09:31 +01001117extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
1118
Joseph Herlant32b83272018-11-15 11:58:28 -08001119/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01001120 * Return true if conversion is possible and false otherwise.
1121 */
1122extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
1123
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01001124/* compare two struct sockaddr_storage and return:
1125 * 0 (true) if the addr is the same in both
1126 * 1 (false) if the addr is not the same in both
1127 */
1128int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2);
1129
Baptiste Assmann08396c82016-01-31 00:27:17 +01001130/* copy ip from <source> into <dest>
1131 * the caller must clear <dest> before calling.
1132 * Returns a pointer to the destination
1133 */
1134struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest);
1135
William Lallemand421f5b52012-02-06 18:15:57 +01001136char *human_time(int t, short hz_div);
1137
1138extern const char *monthname[];
1139
1140/* date2str_log: write a date in the format :
1141 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
1142 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
1143 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
1144 *
1145 * without using sprintf. return a pointer to the last char written (\0) or
1146 * NULL if there isn't enough space.
1147 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02001148char *date2str_log(char *dest, const struct tm *tm, const struct timeval *date, size_t size);
William Lallemand421f5b52012-02-06 18:15:57 +01001149
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001150/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001151 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001152 * The string returned has the same format as returned by strftime(... "%z", tm).
1153 * Offsets are kept in an internal cache for better performances.
1154 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001155const char *get_gmt_offset(time_t t, struct tm *tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001156
William Lallemand421f5b52012-02-06 18:15:57 +01001157/* gmt2str_log: write a date in the format :
1158 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
1159 * return a pointer to the last char written (\0) or
1160 * NULL if there isn't enough space.
1161 */
1162char *gmt2str_log(char *dst, struct tm *tm, size_t size);
1163
Yuxans Yao4e25b012012-10-19 10:36:09 +08001164/* localdate2str_log: write a date in the format :
1165 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001166 * Both t and tm must represent the same time.
Yuxans Yao4e25b012012-10-19 10:36:09 +08001167 * return a pointer to the last char written (\0) or
1168 * NULL if there isn't enough space.
1169 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001170char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size);
Yuxans Yao4e25b012012-10-19 10:36:09 +08001171
Thierry Fournier93127942016-01-20 18:49:45 +01001172/* These 3 functions parses date string and fills the
1173 * corresponding broken-down time in <tm>. In succes case,
1174 * it returns 1, otherwise, it returns 0.
1175 */
1176int parse_http_date(const char *date, int len, struct tm *tm);
1177int parse_imf_date(const char *date, int len, struct tm *tm);
1178int parse_rfc850_date(const char *date, int len, struct tm *tm);
1179int parse_asctime_date(const char *date, int len, struct tm *tm);
1180
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001181/* Dynamically allocates a string of the proper length to hold the formatted
1182 * output. NULL is returned on error. The caller is responsible for freeing the
1183 * memory area using free(). The resulting string is returned in <out> if the
1184 * pointer is not NULL. A previous version of <out> might be used to build the
1185 * new string, and it will be freed before returning if it is not NULL, which
1186 * makes it possible to build complex strings from iterative calls without
1187 * having to care about freeing intermediate values, as in the example below :
1188 *
1189 * memprintf(&err, "invalid argument: '%s'", arg);
1190 * ...
1191 * memprintf(&err, "parser said : <%s>\n", *err);
1192 * ...
1193 * free(*err);
1194 *
1195 * This means that <err> must be initialized to NULL before first invocation.
1196 * The return value also holds the allocated string, which eases error checking
1197 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001198 * passed instead and it will be ignored. The returned message will then also
1199 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001200 *
1201 * It is also convenient to use it without any free except the last one :
1202 * err = NULL;
1203 * if (!fct1(err)) report(*err);
1204 * if (!fct2(err)) report(*err);
1205 * if (!fct3(err)) report(*err);
1206 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02001207 *
1208 * memprintf relies on memvprintf. This last version can be called from any
1209 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001210 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02001211char *memvprintf(char **out, const char *format, va_list args)
1212 __attribute__ ((format(printf, 2, 0)));
1213
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001214char *memprintf(char **out, const char *format, ...)
1215 __attribute__ ((format(printf, 2, 3)));
1216
Willy Tarreau21c705b2012-09-14 11:40:36 +02001217/* Used to add <level> spaces before each line of <out>, unless there is only one line.
1218 * The input argument is automatically freed and reassigned. The result will have to be
1219 * freed by the caller.
1220 * Example of use :
1221 * parse(cmd, &err); (callee: memprintf(&err, ...))
1222 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
1223 * free(err);
1224 */
1225char *indent_msg(char **out, int level);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001226
Willy Tarreaudad36a32013-03-11 01:20:04 +01001227/* Convert occurrences of environment variables in the input string to their
1228 * corresponding value. A variable is identified as a series of alphanumeric
1229 * characters or underscores following a '$' sign. The <in> string must be
1230 * free()able. NULL returns NULL. The resulting string might be reallocated if
1231 * some expansion is made.
1232 */
1233char *env_expand(char *in);
1234
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001235/* debugging macro to emit messages using write() on fd #-1 so that strace sees
1236 * them.
1237 */
1238#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
1239
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001240/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02001241 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
1242 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001243 */
Willy Tarreaued936c52017-04-27 18:03:20 +02001244void debug_hexdump(FILE *out, const char *pfx, const char *buf, unsigned int baseaddr, int len);
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001245
Willy Tarreau12963822017-10-24 10:54:08 +02001246/* this is used to emit traces when building with TRACE=1 */
1247__attribute__((format(printf, 1, 2)))
1248void trace(char *fmt, ...);
1249
Willy Tarreau89efaed2013-12-13 15:14:55 +01001250/* used from everywhere just to drain results we don't want to read and which
1251 * recent versions of gcc increasingly and annoyingly complain about.
1252 */
1253extern int shut_your_big_mouth_gcc_int;
1254
1255/* used from everywhere just to drain results we don't want to read and which
1256 * recent versions of gcc increasingly and annoyingly complain about.
1257 */
1258static inline void shut_your_big_mouth_gcc(int r)
1259{
1260 shut_your_big_mouth_gcc_int = r;
1261}
1262
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02001263/* same as strstr() but case-insensitive */
1264const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
1265
Willy Tarreauab813a42018-09-10 18:41:28 +02001266/* after increasing a pointer value, it can exceed the first buffer
1267 * size. This function transform the value of <ptr> according with
1268 * the expected position. <chunks> is an array of the one or two
Joseph Herlant32b83272018-11-15 11:58:28 -08001269 * available chunks. The first value is the start of the first chunk,
Willy Tarreauab813a42018-09-10 18:41:28 +02001270 * the second value if the end+1 of the first chunks. The third value
1271 * is NULL or the start of the second chunk and the fourth value is
1272 * the end+1 of the second chunk. The function returns 1 if does a
1273 * wrap, else returns 0.
1274 */
1275static inline int fix_pointer_if_wrap(const char **chunks, const char **ptr)
1276{
1277 if (*ptr < chunks[1])
1278 return 0;
1279 if (!chunks[2])
1280 return 0;
1281 *ptr = chunks[2] + ( *ptr - chunks[1] );
1282 return 1;
1283}
Willy Tarreaubb519c72014-01-28 23:04:39 +01001284
1285/************************* Composite address manipulation *********************
1286 * Composite addresses are simply unsigned long data in which the higher bits
1287 * represent a pointer, and the two lower bits are flags. There are several
1288 * places where we just want to associate one or two flags to a pointer (eg,
1289 * to type it), and these functions permit this. The pointer is necessarily a
1290 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
1291 * with the flags.
1292 *****************************************************************************/
1293
1294/* Masks the two lower bits of a composite address and converts it to a
1295 * pointer. This is used to mix some bits with some aligned pointers to
1296 * structs and to retrieve the original (32-bit aligned) pointer.
1297 */
1298static inline void *caddr_to_ptr(unsigned long caddr)
1299{
1300 return (void *)(caddr & ~3UL);
1301}
1302
1303/* Only retrieves the two lower bits of a composite address. This is used to mix
1304 * some bits with some aligned pointers to structs and to retrieve the original
1305 * data (2 bits).
1306 */
1307static inline unsigned int caddr_to_data(unsigned long caddr)
1308{
1309 return (caddr & 3UL);
1310}
1311
1312/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
1313 * from <data> to form a composite address. This is used to mix some bits with
1314 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
1315 * pointer.
1316 */
1317static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
1318{
1319 return (((unsigned long)ptr) & ~3UL) + (data & 3);
1320}
1321
1322/* sets the 2 bits of <data> in the <caddr> composite address */
1323static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
1324{
1325 return caddr | (data & 3);
1326}
1327
1328/* clears the 2 bits of <data> in the <caddr> composite address */
1329static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
1330{
1331 return caddr & ~(unsigned long)(data & 3);
1332}
1333
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02001334/* UTF-8 decoder status */
1335#define UTF8_CODE_OK 0x00
1336#define UTF8_CODE_OVERLONG 0x10
1337#define UTF8_CODE_INVRANGE 0x20
1338#define UTF8_CODE_BADSEQ 0x40
1339
1340unsigned char utf8_next(const char *s, int len, unsigned int *c);
1341
1342static inline unsigned char utf8_return_code(unsigned int code)
1343{
1344 return code & 0xf0;
1345}
1346
1347static inline unsigned char utf8_return_length(unsigned char code)
1348{
1349 return code & 0x0f;
1350}
1351
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001352/* Turns 64-bit value <a> from host byte order to network byte order.
1353 * The principle consists in letting the compiler detect we're playing
1354 * with a union and simplify most or all operations. The asm-optimized
1355 * htonl() version involving bswap (x86) / rev (arm) / other is a single
1356 * operation on little endian, or a NOP on big-endian. In both cases,
1357 * this lets the compiler "see" that we're rebuilding a 64-bit word from
1358 * two 32-bit quantities that fit into a 32-bit register. In big endian,
1359 * the whole code is optimized out. In little endian, with a decent compiler,
1360 * a few bswap and 2 shifts are left, which is the minimum acceptable.
1361 */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001362static inline unsigned long long my_htonll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001363{
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001364#if defined(__x86_64__)
Willy Tarreaudea7c5c2017-10-18 11:39:33 +02001365 __asm__ volatile("bswap %0" : "=r"(a) : "0"(a));
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001366 return a;
1367#else
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001368 union {
1369 struct {
1370 unsigned int w1;
1371 unsigned int w2;
1372 } by32;
1373 unsigned long long by64;
1374 } w = { .by64 = a };
1375 return ((unsigned long long)htonl(w.by32.w1) << 32) | htonl(w.by32.w2);
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001376#endif
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001377}
1378
1379/* Turns 64-bit value <a> from network byte order to host byte order. */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001380static inline unsigned long long my_ntohll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001381{
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001382 return my_htonll(a);
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001383}
1384
Willy Tarreaue6e49cf2015-04-29 17:13:35 +02001385/* returns a 64-bit a timestamp with the finest resolution available. The
1386 * unit is intentionally not specified. It's mostly used to compare dates.
1387 */
1388#if defined(__i386__) || defined(__x86_64__)
1389static inline unsigned long long rdtsc()
1390{
1391 unsigned int a, d;
1392 asm volatile("rdtsc" : "=a" (a), "=d" (d));
1393 return a + ((unsigned long long)d << 32);
1394}
1395#else
1396static inline unsigned long long rdtsc()
1397{
1398 struct timeval tv;
1399 gettimeofday(&tv, NULL);
1400 return tv.tv_sec * 1000000 + tv.tv_usec;
1401}
1402#endif
1403
Maxime de Roucydc887852016-05-13 23:52:54 +02001404/* append a copy of string <str> (in a wordlist) at the end of the list <li>
1405 * On failure : return 0 and <err> filled with an error message.
1406 * The caller is responsible for freeing the <err> and <str> copy
1407 * memory area using free()
1408 */
1409struct list;
1410int list_append_word(struct list *li, const char *str, char **err);
1411
Willy Tarreau83061a82018-07-13 11:56:34 +02001412int dump_text(struct buffer *out, const char *buf, int bsize);
1413int dump_binary(struct buffer *out, const char *buf, int bsize);
1414int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001415 int *line, int ptr);
1416
Hubert Verstraete2eae3a02016-06-28 22:41:00 +02001417/* same as realloc() except that ptr is also freed upon failure */
1418static inline void *my_realloc2(void *ptr, size_t size)
1419{
1420 void *ret;
1421
1422 ret = realloc(ptr, size);
1423 if (!ret && size)
1424 free(ptr);
1425 return ret;
1426}
1427
Frédéric Lécaille3b717162019-02-25 15:04:22 +01001428int parse_dotted_uints(const char *s, unsigned int **nums, size_t *sz);
1429
Lukas Tribusdcbc5c52016-09-12 21:42:07 +00001430/* HAP_STRING() makes a string from a literal while HAP_XSTRING() first
1431 * evaluates the argument and is suited to pass macros.
1432 *
1433 * They allow macros like PCRE_MAJOR to be defined without quotes, which
1434 * is convenient for applications that want to test its value.
1435 */
1436#define HAP_STRING(...) #__VA_ARGS__
1437#define HAP_XSTRING(...) HAP_STRING(__VA_ARGS__)
1438
Willy Tarreau2dd0d472006-06-29 17:53:05 +02001439#endif /* _COMMON_STANDARD_H */