blob: cf8f1f0469935fe328e00147de071270f2752be4 [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 Tarreau13faf162020-03-04 07:44:06 +010025#ifdef USE_BACKTRACE
26#define _GNU_SOURCE
27#include <execinfo.h>
28#endif
29
Willy Tarreau167d8b52007-04-09 22:16:12 +020030#include <limits.h>
Willy Tarreau050737f2010-01-14 11:40:12 +010031#include <string.h>
Willy Tarreau0ebb5112016-12-05 00:10:57 +010032#include <stdio.h>
Willy Tarreaufe944602007-10-25 10:34:16 +020033#include <time.h>
David Carlier5222d8e2017-11-03 12:00:26 +000034#include <stdarg.h>
Willy Tarreaue6e49cf2015-04-29 17:13:35 +020035#include <sys/time.h>
Willy Tarreau938b3032007-05-10 06:39:03 +020036#include <sys/types.h>
Willy Tarreaud50265a2012-09-04 14:18:33 +020037#include <sys/socket.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020038#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020039#include <netinet/in.h>
Willy Tarreau5b4dd682015-07-21 23:47:18 +020040#include <arpa/inet.h>
Thierry FOURNIERe059ec92014-03-17 12:01:13 +010041#include <common/chunk.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020042#include <common/config.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020043#include <common/namespace.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010044#include <eb32tree.h>
Willy Tarreau9c1e15d2017-11-15 18:51:29 +010045#include <eb32sctree.h>
William Lallemand2fe7dd02018-09-11 16:51:29 +020046#include <types/protocol.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020047
Thierry FOURNIER511e9472014-01-23 17:40:34 +010048/* size used for max length of decimal representation of long long int. */
49#define NB_LLMAX_STR (sizeof("-9223372036854775807")-1)
50
Willy Tarreau56adcf22012-12-23 18:00:29 +010051/* number of itoa_str entries */
Willy Tarreau59caa3b2018-12-14 13:59:42 +010052#define NB_ITOA_STR 16
William Lallemande7340ec2012-01-24 11:15:39 +010053
Willy Tarreau588297f2014-06-16 15:16:40 +020054/* maximum quoted string length (truncated above) */
55#define QSTR_SIZE 200
56#define NB_QSTR 10
57
Willy Tarreaubaaee002006-06-26 02:48:02 +020058/****** string-specific macros and functions ******/
59/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
60#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
61
62/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
63#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
64
65/* returns 1 only if only zero or one bit is set in X, which means that X is a
66 * power of 2, and 0 otherwise */
67#define POWEROF2(x) (((x) & ((x)-1)) == 0)
68
Willy Tarreau7a409092020-03-08 00:41:00 +010069/* rotate left a 64-bit integer by <bits:[0-5]> bits */
70static inline uint64_t rotl64(uint64_t v, uint8_t bits)
71{
72#if !defined(__ARM_ARCH_8A) && !defined(__x86_64__)
73 bits &= 63;
74#endif
75 v = (v << bits) | (v >> (-bits & 63));
76 return v;
77}
78
79/* rotate right a 64-bit integer by <bits:[0-5]> bits */
80static inline uint64_t rotr64(uint64_t v, uint8_t bits)
81{
82#if !defined(__ARM_ARCH_8A) && !defined(__x86_64__)
83 bits &= 63;
84#endif
85 v = (v >> bits) | (v << (-bits & 63));
86 return v;
87}
88
Willy Tarreau32c24552019-08-19 17:39:33 +020089/* DEFNULL() returns either the argument as-is, or NULL if absent. This is for
90 * use in macros arguments.
91 */
92#define DEFNULL(...) _FIRST_ARG(NULL, ##__VA_ARGS__, NULL)
93#define _FIRST_ARG(a, b, ...) b
94
Willy Tarreau5b180202010-07-18 10:40:48 +020095/* operators to compare values. They're ordered that way so that the lowest bit
96 * serves as a negation for the test and contains all tests that are not equal.
97 */
98enum {
99 STD_OP_LE = 0, STD_OP_GT = 1,
100 STD_OP_EQ = 2, STD_OP_NE = 3,
101 STD_OP_GE = 4, STD_OP_LT = 5,
102};
103
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100104enum http_scheme {
105 SCH_HTTP,
106 SCH_HTTPS,
107};
108
109struct split_url {
110 enum http_scheme scheme;
111 const char *host;
112 int host_len;
113};
114
Willy Tarreaufb4ba912019-08-29 09:32:21 +0200115/* generic structure associating a name and a value, for use in arrays */
116struct name_desc {
117 const char *name;
118 const char *desc;
119};
120
Christopher Faulet99bca652017-11-14 16:47:26 +0100121extern THREAD_LOCAL int itoa_idx; /* index of next itoa_str to use */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100122
Willy Tarreau7d58a632007-01-13 23:06:06 +0100123/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200124 * copies at most <size-1> chars from <src> to <dst>. Last char is always
125 * set to 0, unless <size> is 0. The number of chars copied is returned
126 * (excluding the terminating zero).
127 * This code has been optimized for size and speed : on x86, it's 45 bytes
128 * long, uses only registers, and consumes only 4 cycles per char.
129 */
130extern int strlcpy2(char *dst, const char *src, int size);
131
132/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200133 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200134 * the ascii representation for number 'n' in decimal.
135 */
Christopher Faulet99bca652017-11-14 16:47:26 +0100136extern THREAD_LOCAL char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100137extern char *ultoa_r(unsigned long n, char *buffer, int size);
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200138extern char *lltoa_r(long long int n, char *buffer, int size);
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200139extern char *sltoa_r(long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200140extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200141static inline const char *ultoa(unsigned long n)
142{
143 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
144}
145
William Lallemande7340ec2012-01-24 11:15:39 +0100146/*
147 * unsigned long long ASCII representation
148 *
149 * return the last char '\0' or NULL if no enough
150 * space in dst
151 */
152char *ulltoa(unsigned long long n, char *dst, size_t size);
153
154
155/*
156 * unsigned long ASCII representation
157 *
158 * return the last char '\0' or NULL if no enough
159 * space in dst
160 */
161char *ultoa_o(unsigned long n, char *dst, size_t size);
162
163/*
164 * signed long ASCII representation
165 *
166 * return the last char '\0' or NULL if no enough
167 * space in dst
168 */
169char *ltoa_o(long int n, char *dst, size_t size);
170
171/*
172 * signed long long ASCII representation
173 *
174 * return the last char '\0' or NULL if no enough
175 * space in dst
176 */
177char *lltoa(long long n, char *dst, size_t size);
178
179/*
180 * write a ascii representation of a unsigned into dst,
181 * return a pointer to the last character
182 * Pad the ascii representation with '0', using size.
183 */
184char *utoa_pad(unsigned int n, char *dst, size_t size);
185
Willy Tarreaubaaee002006-06-26 02:48:02 +0200186/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200187 * This function simply returns a locally allocated string containing the ascii
188 * representation for number 'n' in decimal, unless n is 0 in which case it
189 * returns the alternate string (or an empty string if the alternate string is
190 * NULL). It use is intended for limits reported in reports, where it's
191 * desirable not to display anything if there is no limit. Warning! it shares
192 * the same vector as ultoa_r().
193 */
194extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
195
Willy Tarreau56adcf22012-12-23 18:00:29 +0100196/* returns a locally allocated string containing the ASCII representation of
197 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
198 * function call (eg: printf), shared with the other similar functions making
199 * use of itoa_str[].
200 */
201static inline const char *U2A(unsigned long n)
202{
203 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
204 if (++itoa_idx >= NB_ITOA_STR)
205 itoa_idx = 0;
206 return ret;
207}
208
209/* returns a locally allocated string containing the HTML representation of
210 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
211 * function call (eg: printf), shared with the other similar functions making
212 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200213 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100214static inline const char *U2H(unsigned long long n)
215{
216 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
217 if (++itoa_idx >= NB_ITOA_STR)
218 itoa_idx = 0;
219 return ret;
220}
221
Ioannis Cherouvim1ff76332018-10-24 10:05:19 +0300222/* returns a locally allocated string containing the ASCII representation of
Willy Tarreau56adcf22012-12-23 18:00:29 +0100223 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
224 * function call (eg: printf), shared with the other similar functions making
225 * use of itoa_str[].
226 */
227static inline const char *LIM2A(unsigned long n, const char *alt)
228{
229 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
230 if (++itoa_idx >= NB_ITOA_STR)
231 itoa_idx = 0;
232 return ret;
233}
Willy Tarreau91092e52007-10-25 16:58:42 +0200234
Willy Tarreau4d589e72019-08-23 19:02:26 +0200235/* returns the number of bytes needed to encode <v> as a varint. Be careful, use
236 * it only with constants as it generates a large code (typ. 180 bytes). Use the
237 * varint_bytes() version instead in case of doubt.
238 */
239int varint_bytes(uint64_t v);
240static inline int __varint_bytes(uint64_t v)
241{
242 switch (v) {
243 case 0x0000000000000000 ... 0x00000000000000ef: return 1;
244 case 0x00000000000000f0 ... 0x00000000000008ef: return 2;
245 case 0x00000000000008f0 ... 0x00000000000408ef: return 3;
246 case 0x00000000000408f0 ... 0x00000000020408ef: return 4;
247 case 0x00000000020408f0 ... 0x00000001020408ef: return 5;
248 case 0x00000001020408f0 ... 0x00000081020408ef: return 6;
249 case 0x00000081020408f0 ... 0x00004081020408ef: return 7;
250 case 0x00004081020408f0 ... 0x00204081020408ef: return 8;
251 case 0x00204081020408f0 ... 0x10204081020408ef: return 9;
252 default: return 10;
253 }
254}
255
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200256/* Encode the integer <i> into a varint (variable-length integer). The encoded
257 * value is copied in <*buf>. Here is the encoding format:
258 *
259 * 0 <= X < 240 : 1 byte (7.875 bits) [ XXXX XXXX ]
260 * 240 <= X < 2288 : 2 bytes (11 bits) [ 1111 XXXX ] [ 0XXX XXXX ]
261 * 2288 <= X < 264432 : 3 bytes (18 bits) [ 1111 XXXX ] [ 1XXX XXXX ] [ 0XXX XXXX ]
262 * 264432 <= X < 33818864 : 4 bytes (25 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*2 [ 0XXX XXXX ]
263 * 33818864 <= X < 4328786160 : 5 bytes (32 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*3 [ 0XXX XXXX ]
264 * ...
265 *
266 * On success, it returns the number of written bytes and <*buf> is moved after
267 * the encoded value. Otherwise, it returns -1. */
268static inline int
269encode_varint(uint64_t i, char **buf, char *end)
270{
271 unsigned char *p = (unsigned char *)*buf;
272 int r;
273
274 if (p >= (unsigned char *)end)
275 return -1;
276
277 if (i < 240) {
278 *p++ = i;
279 *buf = (char *)p;
280 return 1;
281 }
282
283 *p++ = (unsigned char)i | 240;
284 i = (i - 240) >> 4;
285 while (i >= 128) {
286 if (p >= (unsigned char *)end)
287 return -1;
288 *p++ = (unsigned char)i | 128;
289 i = (i - 128) >> 7;
290 }
291
292 if (p >= (unsigned char *)end)
293 return -1;
294 *p++ = (unsigned char)i;
295
296 r = ((char *)p - *buf);
297 *buf = (char *)p;
298 return r;
299}
300
301/* Decode a varint from <*buf> and save the decoded value in <*i>. See
302 * 'spoe_encode_varint' for details about varint.
303 * On success, it returns the number of read bytes and <*buf> is moved after the
304 * varint. Otherwise, it returns -1. */
305static inline int
306decode_varint(char **buf, char *end, uint64_t *i)
307{
308 unsigned char *p = (unsigned char *)*buf;
309 int r;
310
311 if (p >= (unsigned char *)end)
312 return -1;
313
314 *i = *p++;
315 if (*i < 240) {
316 *buf = (char *)p;
317 return 1;
318 }
319
320 r = 4;
321 do {
322 if (p >= (unsigned char *)end)
323 return -1;
324 *i += (uint64_t)*p << r;
325 r += 7;
326 } while (*p++ >= 128);
327
328 r = ((char *)p - *buf);
329 *buf = (char *)p;
330 return r;
331}
332
Willy Tarreau588297f2014-06-16 15:16:40 +0200333/* returns a locally allocated string containing the quoted encoding of the
334 * input string. The output may be truncated to QSTR_SIZE chars, but it is
335 * guaranteed that the string will always be properly terminated. Quotes are
336 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
337 * always be at least 4 chars.
338 */
339const char *qstr(const char *str);
340
341/* returns <str> or its quote-encoded equivalent if it contains at least one
342 * quote or a comma. This is aimed at build CSV-compatible strings.
343 */
344static inline const char *cstr(const char *str)
345{
346 const char *p = str;
347
348 while (*p) {
349 if (*p == ',' || *p == '"')
350 return qstr(str);
351 p++;
352 }
353 return str;
354}
355
Willy Tarreau91092e52007-10-25 16:58:42 +0200356/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200357 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
358 */
359extern int ishex(char s);
360
361/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100362 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200363 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100364 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200365static inline int hex2i(int c)
366{
Willy Tarreauaa398602017-11-10 11:19:54 +0100367 if ((unsigned char)(c -= '0') > 9) {
368 if ((unsigned char)(c -= 'A' - '0') > 5 &&
369 (unsigned char)(c -= 'a' - 'A') > 5)
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200370 c = -11;
371 c += 10;
372 }
373 return c;
374}
375
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100376/* rounds <i> down to the closest value having max 2 digits */
377unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100378
379/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100380 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
381 * invalid character is found, a pointer to it is returned. If everything is
382 * fine, NULL is returned.
383 */
384extern const char *invalid_char(const char *name);
385
386/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200387 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200388 * If an invalid character is found, a pointer to it is returned.
389 * If everything is fine, NULL is returned.
390 */
391extern const char *invalid_domainchar(const char *name);
392
393/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200394 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
395 * If an invalid character is found, a pointer to it is returned.
396 * If everything is fine, NULL is returned.
397 */
398extern const char *invalid_prefix_char(const char *name);
399
Willy Tarreau36f586b2020-02-14 18:25:17 +0100400/* returns true if <c> is an identifier character, that is, a digit, a letter,
Willy Tarreaua71667c2020-02-17 06:34:11 +0100401 * or '-', '+', '_', ':' or '.'. This is usable for proxy names, server names,
402 * ACL names, sample fetch names, and converter names.
Willy Tarreau36f586b2020-02-14 18:25:17 +0100403 */
404static inline int is_idchar(char c)
405{
Willy Tarreau90807112020-02-25 08:16:33 +0100406 return isalnum((unsigned char)c) ||
Willy Tarreaua71667c2020-02-17 06:34:11 +0100407 c == '.' || c == '_' || c == '-' || c == '+' || c == ':';
Willy Tarreau36f586b2020-02-14 18:25:17 +0100408}
409
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200410/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100411 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200412 * port range consisting in two integers. The low and high end are always set
413 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100414 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200415 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100416 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
417 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
418 * address wants to ignore port, it must be terminated by a trailing colon (':').
419 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
420 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100421 * If <pfx> is non-null, it is used as a string prefix before any path-based
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200422 * address (typically the path to a unix socket). If use_dns is not true,
Joseph Herlant32b83272018-11-15 11:58:28 -0800423 * the function cannot accept the DNS resolution.
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200424 */
Willy Tarreau48ef4c92017-01-06 18:32:38 +0100425struct sockaddr_storage *str2sa_range(const char *str,
426 int *port, int *low, int *high,
427 char **err, const char *pfx,
428 char **fqdn, int resolve);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200429
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100430/* converts <str> to a struct in_addr containing a network mask. It can be
431 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +0300432 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100433 */
434int str2mask(const char *str, struct in_addr *mask);
435
Tim Duesterhus47185172018-01-25 16:24:49 +0100436/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +0100437 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +0100438 * if the conversion succeeds otherwise zero.
439 */
440int str2mask6(const char *str, struct in6_addr *mask);
441
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100442/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
443 * succeeds otherwise non-zero.
444 */
445int cidr2dotted(int cidr, struct in_addr *mask);
446
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200447/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200448 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200449 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +0500450 * is optional and either in the dotted or CIDR notation.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200451 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
452 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100453int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200454
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100455/* str2ip and str2ip2:
456 *
457 * converts <str> to a struct sockaddr_storage* provided by the caller. The
458 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
459 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
460 * the function tries to guess the address family from the syntax. If the
461 * family is forced and the format doesn't match, an error is returned. The
462 * string is assumed to contain only an address, no port. The address can be a
463 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
464 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
465 * The return address will only have the address family and the address set,
466 * all other fields remain zero. The string is not supposed to be modified.
467 * The IPv6 '::' address is IN6ADDR_ANY.
468 *
469 * str2ip2:
470 *
471 * If <resolve> is set, this function try to resolve DNS, otherwise, it returns
472 * NULL result.
473 */
474struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve);
475static inline struct sockaddr_storage *str2ip(const char *str, struct sockaddr_storage *sa)
476{
477 return str2ip2(str, sa, 1);
478}
479
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100480/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200481 * converts <str> to two struct in6_addr* which must be pre-allocated.
482 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +0500483 * is an optional number of bits (128 being the default).
Willy Tarreau6d20e282012-04-27 22:49:47 +0200484 * Returns 1 if OK, 0 if error.
485 */
486int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
487
488/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200489 * Parse IP address found in url.
490 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100491int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200492
493/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100494 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100495 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100496int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100497
Willy Tarreau631f01c2011-09-05 00:36:48 +0200498/* Tries to convert a sockaddr_storage address to text form. Upon success, the
499 * address family is returned so that it's easy for the caller to adapt to the
500 * output format. Zero is returned if the address family is not supported. -1
501 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
502 * supported.
503 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +0200504int addr_to_str(const struct sockaddr_storage *addr, char *str, int size);
Willy Tarreau631f01c2011-09-05 00:36:48 +0200505
Simon Horman75ab8bd2014-06-16 09:39:41 +0900506/* Tries to convert a sockaddr_storage port to text form. Upon success, the
507 * address family is returned so that it's easy for the caller to adapt to the
508 * output format. Zero is returned if the address family is not supported. -1
509 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
510 * supported.
511 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +0200512int port_to_str(const struct sockaddr_storage *addr, char *str, int size);
Simon Horman75ab8bd2014-06-16 09:39:41 +0900513
Willy Tarreau16e01562016-08-09 16:46:18 +0200514/* check if the given address is local to the system or not. It will return
515 * -1 when it's not possible to know, 0 when the address is not local, 1 when
516 * it is. We don't want to iterate over all interfaces for this (and it is not
517 * portable). So instead we try to bind in UDP to this address on a free non
518 * privileged port and to connect to the same address, port 0 (connect doesn't
519 * care). If it succeeds, we own the address. Note that non-inet addresses are
520 * considered local since they're most likely AF_UNIX.
521 */
522int addr_is_local(const struct netns_entry *ns,
523 const struct sockaddr_storage *orig);
524
Willy Tarreaubaaee002006-06-26 02:48:02 +0200525/* will try to encode the string <string> replacing all characters tagged in
526 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
527 * prefixed by <escape>, and will store the result between <start> (included)
528 * and <stop> (excluded), and will always terminate the string with a '\0'
529 * before <stop>. The position of the '\0' is returned if the conversion
530 * completes. If bytes are missing between <start> and <stop>, then the
531 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
532 * cannot even be stored so we return <start> without writing the 0.
533 * The input string must also be zero-terminated.
534 */
535extern const char hextab[];
536char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200537 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +0200538 const char *string);
539
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100540/*
541 * Same behavior, except that it encodes chunk <chunk> instead of a string.
542 */
543char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200544 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +0200545 const struct buffer *chunk);
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100546
Dragan Dosen0edd1092016-02-12 13:23:02 +0100547/*
548 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200549 * character. The input <string> must be zero-terminated. The result will
550 * be stored between <start> (included) and <stop> (excluded). This
551 * function will always try to terminate the resulting string with a '\0'
552 * before <stop>, and will return its position if the conversion
553 * completes.
554 */
555char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200556 const char escape, const long *map,
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200557 const char *string);
558
559/*
560 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +0100561 * character. <chunk> contains the input to be escaped. The result will be
562 * stored between <start> (included) and <stop> (excluded). The function
563 * will always try to terminate the resulting string with a '\0' before
564 * <stop>, and will return its position if the conversion completes.
565 */
566char *escape_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200567 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +0200568 const struct buffer *chunk);
Dragan Dosen0edd1092016-02-12 13:23:02 +0100569
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100570
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200571/* Check a string for using it in a CSV output format. If the string contains
572 * one of the following four char <">, <,>, CR or LF, the string is
573 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
574 * <str> is the input string to be escaped. The function assumes that
575 * the input string is null-terminated.
576 *
577 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +0100578 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200579 * format.
580 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100581 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200582 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100583 * If <quote> is 1, the converter puts the quotes only if any character is
584 * escaped. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200585 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100586 * <output> is a struct chunk used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200587 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100588 * The function returns the converted string on its output. If an error
589 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200590 * for using the function directly as printf() argument.
591 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100592 * If the output buffer is too short to contain the input string, the result
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200593 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +0100594 *
595 * This function appends the encoding to the existing output chunk. Please
596 * use csv_enc() instead if you want to replace the output chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200597 */
Willy Tarreau83061a82018-07-13 11:56:34 +0200598const char *csv_enc_append(const char *str, int quote, struct buffer *output);
Willy Tarreau898529b2016-01-06 18:07:04 +0100599
600/* same as above but the output chunk is reset first */
Willy Tarreau83061a82018-07-13 11:56:34 +0200601static inline const char *csv_enc(const char *str, int quote,
602 struct buffer *output)
Willy Tarreau898529b2016-01-06 18:07:04 +0100603{
604 chunk_reset(output);
605 return csv_enc_append(str, quote, output);
606}
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200607
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200608/* Decode an URL-encoded string in-place. The resulting string might
609 * be shorter. If some forbidden characters are found, the conversion is
610 * aborted, the string is truncated before the issue and non-zero is returned,
611 * otherwise the operation returns non-zero indicating success.
612 */
613int url_decode(char *string);
614
Willy Tarreau6911fa42007-03-04 18:06:08 +0100615/* This one is 6 times faster than strtoul() on athlon, but does
616 * no check at all.
617 */
618static inline unsigned int __str2ui(const char *s)
619{
620 unsigned int i = 0;
621 while (*s) {
622 i = i * 10 - '0';
623 i += (unsigned char)*s++;
624 }
625 return i;
626}
627
628/* This one is 5 times faster than strtoul() on athlon with checks.
629 * It returns the value of the number composed of all valid digits read.
630 */
631static inline unsigned int __str2uic(const char *s)
632{
633 unsigned int i = 0;
634 unsigned int j;
635 while (1) {
636 j = (*s++) - '0';
637 if (j > 9)
638 break;
639 i *= 10;
640 i += j;
641 }
642 return i;
643}
644
645/* This one is 28 times faster than strtoul() on athlon, but does
646 * no check at all!
647 */
648static inline unsigned int __strl2ui(const char *s, int len)
649{
650 unsigned int i = 0;
651 while (len-- > 0) {
652 i = i * 10 - '0';
653 i += (unsigned char)*s++;
654 }
655 return i;
656}
657
658/* This one is 7 times faster than strtoul() on athlon with checks.
659 * It returns the value of the number composed of all valid digits read.
660 */
661static inline unsigned int __strl2uic(const char *s, int len)
662{
663 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200664 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100665
666 while (len-- > 0) {
667 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200668 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100669 if (j > 9)
670 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200671 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100672 }
673 return i;
674}
675
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200676/* This function reads an unsigned integer from the string pointed to by <s>
677 * and returns it. The <s> pointer is adjusted to point to the first unread
678 * char. The function automatically stops at <end>.
679 */
680static inline unsigned int __read_uint(const char **s, const char *end)
681{
682 const char *ptr = *s;
683 unsigned int i = 0;
684 unsigned int j, k;
685
686 while (ptr < end) {
687 j = *ptr - '0';
688 k = i * 10;
689 if (j > 9)
690 break;
691 i = k + j;
692 ptr++;
693 }
694 *s = ptr;
695 return i;
696}
697
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200698unsigned long long int read_uint64(const char **s, const char *end);
699long long int read_int64(const char **s, const char *end);
700
Willy Tarreau6911fa42007-03-04 18:06:08 +0100701extern unsigned int str2ui(const char *s);
702extern unsigned int str2uic(const char *s);
703extern unsigned int strl2ui(const char *s, int len);
704extern unsigned int strl2uic(const char *s, int len);
705extern int strl2ic(const char *s, int len);
706extern int strl2irc(const char *s, int len, int *ret);
707extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100708extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200709extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200710unsigned int inetaddr_host(const char *text);
711unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200712unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100713
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200714static inline char *cut_crlf(char *s) {
715
Simon Horman5269cfb2013-02-13 17:48:00 +0900716 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200717 char *p = s++;
718
719 if (!*p)
720 return p;
721 }
722
Simon Horman5269cfb2013-02-13 17:48:00 +0900723 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200724
725 return s;
726}
727
728static inline char *ltrim(char *s, char c) {
729
730 if (c)
731 while (*s == c)
732 s++;
733
734 return s;
735}
736
737static inline char *rtrim(char *s, char c) {
738
739 char *p = s + strlen(s);
740
741 while (p-- > s)
742 if (*p == c)
743 *p = '\0';
744 else
745 break;
746
747 return s;
748}
749
750static inline char *alltrim(char *s, char c) {
751
752 rtrim(s, c);
753
754 return ltrim(s, c);
755}
756
Willy Tarreaufe944602007-10-25 10:34:16 +0200757/* This function converts the time_t value <now> into a broken out struct tm
758 * which must be allocated by the caller. It is highly recommended to use this
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +0500759 * function instead of localtime() because that one requires a time_t* which
Willy Tarreaufe944602007-10-25 10:34:16 +0200760 * is not always compatible with tv_sec depending on OS/hardware combinations.
761 */
762static inline void get_localtime(const time_t now, struct tm *tm)
763{
764 localtime_r(&now, tm);
765}
766
Emeric Brun3a058f32009-06-30 18:26:00 +0200767/* This function converts the time_t value <now> into a broken out struct tm
768 * which must be allocated by the caller. It is highly recommended to use this
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +0500769 * function instead of gmtime() because that one requires a time_t* which
Emeric Brun3a058f32009-06-30 18:26:00 +0200770 * is not always compatible with tv_sec depending on OS/hardware combinations.
771 */
772static inline void get_gmtime(const time_t now, struct tm *tm)
773{
774 gmtime_r(&now, tm);
775}
776
Willy Tarreaucb1949b2017-07-19 19:05:29 +0200777/* Counts a number of elapsed days since 01/01/0000 based solely on elapsed
778 * years and assuming the regular rule for leap years applies. It's fake but
779 * serves as a temporary origin. It's worth remembering that it's the first
780 * year of each period that is leap and not the last one, so for instance year
781 * 1 sees 366 days since year 0 was leap. For this reason we have to apply
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +0500782 * modular arithmetic which is why we offset the year by 399 before
Willy Tarreaucb1949b2017-07-19 19:05:29 +0200783 * subtracting the excess at the end. No overflow here before ~11.7 million
784 * years.
785 */
786static inline unsigned int days_since_zero(unsigned int y)
787{
788 return y * 365 + (y + 399) / 4 - (y + 399) / 100 + (y + 399) / 400
789 - 399 / 4 + 399 / 100;
790}
791
792/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
793 * It is meant as a portable replacement for timegm() for use with valid inputs.
794 * Returns undefined results for invalid dates (eg: months out of range 0..11).
795 */
796extern time_t my_timegm(const struct tm *tm);
797
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100798/* This function parses a time value optionally followed by a unit suffix among
799 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
800 * expected by the caller. The computation does its best to avoid overflows.
801 * The value is returned in <ret> if everything is fine, and a NULL is returned
802 * by the function. In case of error, a pointer to the error is returned and
803 * <ret> is left untouched.
804 */
805extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100806extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100807
Willy Tarreau9faebe32019-06-07 19:00:37 +0200808/* special return values for the time parser */
809#define PARSE_TIME_UNDER ((char *)1)
810#define PARSE_TIME_OVER ((char *)2)
811
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100812/* unit flags to pass to parse_time_err */
813#define TIME_UNIT_US 0x0000
814#define TIME_UNIT_MS 0x0001
815#define TIME_UNIT_S 0x0002
816#define TIME_UNIT_MIN 0x0003
817#define TIME_UNIT_HOUR 0x0004
818#define TIME_UNIT_DAY 0x0005
819#define TIME_UNIT_MASK 0x0007
820
William Lallemand421f5b52012-02-06 18:15:57 +0100821#define SEC 1
822#define MINUTE (60 * SEC)
823#define HOUR (60 * MINUTE)
824#define DAY (24 * HOUR)
825
Willy Tarreau7f062c42009-03-05 18:43:00 +0100826/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
827 * This is used to compute fixed ratios by setting one of the operands to
828 * (2^32*ratio).
829 */
830static inline unsigned int mul32hi(unsigned int a, unsigned int b)
831{
832 return ((unsigned long long)a * b) >> 32;
833}
834
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200835/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
836 * function when you know for sure that the result fits in 32 bits, because
837 * it is optimal on x86 and on 64bit processors.
838 */
839static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
840{
841 unsigned int result;
842#ifdef __i386__
843 asm("divl %2"
844 : "=a" (result)
845 : "A"(o1), "rm"(o2));
846#else
847 result = o1 / o2;
848#endif
849 return result;
850}
851
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100852/* Simple popcountl implementation. It returns the number of ones in a word.
853 * Described here : https://graphics.stanford.edu/~seander/bithacks.html
854 */
David Carliere6c39412015-07-02 07:00:17 +0000855static inline unsigned int my_popcountl(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100856{
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100857 a = a - ((a >> 1) & ~0UL/3);
858 a = (a & ~0UL/15*3) + ((a >> 2) & ~0UL/15*3);
859 a = (a + (a >> 4)) & ~0UL/255*15;
860 return (unsigned long)(a * (~0UL/255)) >> (sizeof(unsigned long) - 1) * 8;
Willy Tarreau37994f02012-11-19 12:11:07 +0100861}
862
Willy Tarreau98d334b2018-10-15 09:33:41 +0200863/* returns non-zero if <a> has at least 2 bits set */
864static inline unsigned long atleast2(unsigned long a)
865{
866 return a & (a - 1);
867}
868
Christopher Fauletff813182017-11-22 15:00:13 +0100869/* Simple ffs implementation. It returns the position of the lowest bit set to
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100870 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
Willy Tarreau27346b02018-10-10 19:05:56 +0200871 */
Christopher Fauletff813182017-11-22 15:00:13 +0100872static inline unsigned int my_ffsl(unsigned long a)
873{
Willy Tarreau27346b02018-10-10 19:05:56 +0200874 unsigned long cnt;
Christopher Fauletff813182017-11-22 15:00:13 +0100875
Willy Tarreau27346b02018-10-10 19:05:56 +0200876#if defined(__x86_64__)
Willy Tarreauce487aa2018-10-29 16:09:57 +0100877 __asm__("bsf %1,%0\n" : "=r" (cnt) : "rm" (a));
Willy Tarreau27346b02018-10-10 19:05:56 +0200878 cnt++;
879#else
Christopher Fauletff813182017-11-22 15:00:13 +0100880
881 cnt = 1;
882#if LONG_MAX > 0x7FFFFFFFL /* 64bits */
883 if (!(a & 0xFFFFFFFFUL)) {
884 a >>= 32;
885 cnt += 32;
886 }
887#endif
888 if (!(a & 0XFFFFU)) {
889 a >>= 16;
890 cnt += 16;
891 }
892 if (!(a & 0XFF)) {
893 a >>= 8;
894 cnt += 8;
895 }
896 if (!(a & 0xf)) {
897 a >>= 4;
898 cnt += 4;
899 }
900 if (!(a & 0x3)) {
901 a >>= 2;
902 cnt += 2;
903 }
904 if (!(a & 0x1)) {
Christopher Fauletff813182017-11-22 15:00:13 +0100905 cnt += 1;
906 }
Willy Tarreau27346b02018-10-10 19:05:56 +0200907#endif /* x86_64 */
Christopher Fauletff813182017-11-22 15:00:13 +0100908
909 return cnt;
910}
911
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100912/* Simple fls implementation. It returns the position of the highest bit set to
913 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
914 */
915static inline unsigned int my_flsl(unsigned long a)
916{
917 unsigned long cnt;
918
919#if defined(__x86_64__)
920 __asm__("bsr %1,%0\n" : "=r" (cnt) : "rm" (a));
921 cnt++;
922#else
923
924 cnt = 1;
925#if LONG_MAX > 0x7FFFFFFFUL /* 64bits */
926 if (a & 0xFFFFFFFF00000000UL) {
927 a >>= 32;
928 cnt += 32;
929 }
930#endif
931 if (a & 0XFFFF0000U) {
932 a >>= 16;
933 cnt += 16;
934 }
935 if (a & 0XFF00) {
936 a >>= 8;
937 cnt += 8;
938 }
939 if (a & 0xf0) {
940 a >>= 4;
941 cnt += 4;
942 }
943 if (a & 0xc) {
944 a >>= 2;
945 cnt += 2;
946 }
947 if (a & 0x2) {
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100948 cnt += 1;
949 }
950#endif /* x86_64 */
951
952 return cnt;
953}
954
David Carliere6c39412015-07-02 07:00:17 +0000955/* Build a word with the <bits> lower bits set (reverse of my_popcountl) */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100956static inline unsigned long nbits(int bits)
957{
958 if (--bits < 0)
959 return 0;
960 else
961 return (2UL << bits) - 1;
962}
963
Willy Tarreau7355b042019-06-07 10:42:43 +0200964/* sets bit <bit> into map <map>, which must be long-aligned */
965static inline void ha_bit_set(unsigned long bit, long *map)
966{
967 map[bit / (8 * sizeof(*map))] |= 1UL << (bit & (8 * sizeof(*map) - 1));
968}
969
970/* clears bit <bit> from map <map>, which must be long-aligned */
971static inline void ha_bit_clr(unsigned long bit, long *map)
972{
973 map[bit / (8 * sizeof(*map))] &= ~(1UL << (bit & (8 * sizeof(*map) - 1)));
974}
975
976/* flips bit <bit> from map <map>, which must be long-aligned */
977static inline void ha_bit_flip(unsigned long bit, long *map)
978{
979 map[bit / (8 * sizeof(*map))] ^= 1UL << (bit & (8 * sizeof(*map) - 1));
980}
981
982/* returns non-zero if bit <bit> from map <map> is set, otherwise 0 */
983static inline int ha_bit_test(unsigned long bit, const long *map)
984{
985 return !!(map[bit / (8 * sizeof(*map))] & 1UL << (bit & (8 * sizeof(*map) - 1)));
986}
987
Willy Tarreau126d4062013-12-03 17:50:47 +0100988/*
989 * Parse binary string written in hexadecimal (source) and store the decoded
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +0500990 * result into binstr and set binstrlen to the length of binstr. Memory for
Willy Tarreau126d4062013-12-03 17:50:47 +0100991 * binstr is allocated by the function. In case of error, returns 0 with an
992 * error message in err.
993 */
994int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
995
Willy Tarreau946ba592009-05-10 15:41:18 +0200996/* copies at most <n> characters from <src> and always terminates with '\0' */
997char *my_strndup(const char *src, int n);
998
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200999/*
1000 * search needle in haystack
1001 * returns the pointer if found, returns NULL otherwise
1002 */
1003const void *my_memmem(const void *, size_t, const void *, size_t);
1004
Willy Tarreau482b00d2009-10-04 22:48:42 +02001005/* This function returns the first unused key greater than or equal to <key> in
1006 * ID tree <root>. Zero is returned if no place is found.
1007 */
1008unsigned int get_next_id(struct eb_root *root, unsigned int key);
1009
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01001010/* dump the full tree to <file> in DOT format for debugging purposes. Will
1011 * optionally highlight node <subj> if found, depending on operation <op> :
1012 * 0 : nothing
1013 * >0 : insertion, node/leaf are surrounded in red
1014 * <0 : removal, node/leaf are dashed with no background
1015 * Will optionally add "desc" as a label on the graph if set and non-null.
1016 */
1017void eb32sc_to_file(FILE *file, struct eb_root *root, const struct eb32sc_node *subj,
1018 int op, const char *desc);
Willy Tarreaued3cda02017-11-15 15:04:05 +01001019
Willy Tarreau348238b2010-01-18 15:05:57 +01001020/* This function compares a sample word possibly followed by blanks to another
1021 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
1022 * otherwise zero. This intends to be used when checking HTTP headers for some
1023 * values.
1024 */
1025int word_match(const char *sample, int slen, const char *word, int wlen);
1026
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02001027/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
1028 * or the number of chars read in case of success.
1029 */
1030int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01001031int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02001032
Willy Tarreauacf95772010-06-14 19:09:21 +02001033/* To be used to quote config arg positions. Returns the string at <ptr>
1034 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
1035 * if ptr is NULL or empty. The string is locally allocated.
1036 */
1037const char *quote_arg(const char *ptr);
1038
Willy Tarreau5b180202010-07-18 10:40:48 +02001039/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
1040int get_std_op(const char *str);
1041
Willy Tarreau4c14eaa2010-11-24 14:01:45 +01001042/* hash a 32-bit integer to another 32-bit integer */
1043extern unsigned int full_hash(unsigned int a);
1044static inline unsigned int __full_hash(unsigned int a)
1045{
1046 /* This function is one of Bob Jenkins' full avalanche hashing
1047 * functions, which when provides quite a good distribution for little
1048 * input variations. The result is quite suited to fit over a 32-bit
1049 * space with enough variations so that a randomly picked number falls
1050 * equally before any server position.
1051 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
1052 */
1053 a = (a+0x7ed55d16) + (a<<12);
1054 a = (a^0xc761c23c) ^ (a>>19);
1055 a = (a+0x165667b1) + (a<<5);
1056 a = (a+0xd3a2646c) ^ (a<<9);
1057 a = (a+0xfd7046c5) + (a<<3);
1058 a = (a^0xb55a4f09) ^ (a>>16);
1059
1060 /* ensure values are better spread all around the tree by multiplying
1061 * by a large prime close to 3/4 of the tree.
1062 */
1063 return a * 3221225473U;
1064}
1065
Willy Tarreauf3241112019-02-26 09:56:22 +01001066/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
1067 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
1068 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
1069 * a popcount variant and is described here :
1070 * https://graphics.stanford.edu/~seander/bithacks.html
1071 */
1072unsigned int mask_find_rank_bit(unsigned int r, unsigned long m);
1073unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
1074 unsigned long a, unsigned long b,
1075 unsigned long c, unsigned long d);
1076void mask_prep_rank_map(unsigned long m,
1077 unsigned long *a, unsigned long *b,
1078 unsigned long *c, unsigned long *d);
1079
Willy Tarreau422a0a52012-10-26 19:47:23 +02001080/* sets the address family to AF_UNSPEC so that is_addr() does not match */
1081static inline void clear_addr(struct sockaddr_storage *addr)
1082{
1083 addr->ss_family = AF_UNSPEC;
1084}
1085
David du Colombier6f5ccb12011-03-10 22:26:24 +01001086/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1087 * otherwise zero.
1088 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001089static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +01001090{
1091 int i;
1092
1093 switch (addr->ss_family) {
1094 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +01001095 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +01001096 case AF_INET6:
1097 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
1098 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
1099 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
1100 }
1101 return 0;
1102}
1103
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001104/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1105 * or is a unix address, otherwise returns zero.
1106 */
1107static inline int is_addr(const struct sockaddr_storage *addr)
1108{
William Lallemand2fe7dd02018-09-11 16:51:29 +02001109 if (addr->ss_family == AF_UNIX || addr->ss_family == AF_CUST_SOCKPAIR)
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001110 return 1;
1111 else
1112 return is_inet_addr(addr);
1113}
1114
David du Colombier11bcb6c2011-03-24 12:23:00 +01001115/* returns port in network byte order */
1116static inline int get_net_port(struct sockaddr_storage *addr)
1117{
1118 switch (addr->ss_family) {
1119 case AF_INET:
1120 return ((struct sockaddr_in *)addr)->sin_port;
1121 case AF_INET6:
1122 return ((struct sockaddr_in6 *)addr)->sin6_port;
1123 }
1124 return 0;
1125}
1126
1127/* returns port in host byte order */
1128static inline int get_host_port(struct sockaddr_storage *addr)
1129{
1130 switch (addr->ss_family) {
1131 case AF_INET:
1132 return ntohs(((struct sockaddr_in *)addr)->sin_port);
1133 case AF_INET6:
1134 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
1135 }
1136 return 0;
1137}
1138
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +02001139/* returns address len for <addr>'s family, 0 for unknown families */
1140static inline int get_addr_len(const struct sockaddr_storage *addr)
1141{
1142 switch (addr->ss_family) {
1143 case AF_INET:
1144 return sizeof(struct sockaddr_in);
1145 case AF_INET6:
1146 return sizeof(struct sockaddr_in6);
1147 case AF_UNIX:
1148 return sizeof(struct sockaddr_un);
1149 }
1150 return 0;
1151}
1152
David du Colombier11bcb6c2011-03-24 12:23:00 +01001153/* set port in host byte order */
1154static inline int set_net_port(struct sockaddr_storage *addr, int port)
1155{
1156 switch (addr->ss_family) {
1157 case AF_INET:
1158 ((struct sockaddr_in *)addr)->sin_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001159 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001160 case AF_INET6:
1161 ((struct sockaddr_in6 *)addr)->sin6_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001162 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001163 }
1164 return 0;
1165}
1166
1167/* set port in network byte order */
1168static inline int set_host_port(struct sockaddr_storage *addr, int port)
1169{
1170 switch (addr->ss_family) {
1171 case AF_INET:
1172 ((struct sockaddr_in *)addr)->sin_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001173 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001174 case AF_INET6:
1175 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001176 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001177 }
1178 return 0;
1179}
1180
Thierry Fournier70473a52016-02-17 17:12:14 +01001181/* Convert mask from bit length form to in_addr form.
1182 * This function never fails.
1183 */
1184void len2mask4(int len, struct in_addr *addr);
1185
1186/* Convert mask from bit length form to in6_addr form.
1187 * This function never fails.
1188 */
1189void len2mask6(int len, struct in6_addr *addr);
1190
David du Colombier4f92d322011-03-24 11:09:31 +01001191/* Return true if IPv4 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001192extern 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 +01001193
1194/* Return true if IPv6 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001195extern 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 +01001196
Joseph Herlant32b83272018-11-15 11:58:28 -08001197/* Map IPv4 address on IPv6 address, as specified in RFC 3513. */
David du Colombier4f92d322011-03-24 11:09:31 +01001198extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
1199
Joseph Herlant32b83272018-11-15 11:58:28 -08001200/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01001201 * Return true if conversion is possible and false otherwise.
1202 */
1203extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
1204
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01001205/* compare two struct sockaddr_storage and return:
1206 * 0 (true) if the addr is the same in both
1207 * 1 (false) if the addr is not the same in both
1208 */
1209int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2);
1210
Baptiste Assmann08396c82016-01-31 00:27:17 +01001211/* copy ip from <source> into <dest>
1212 * the caller must clear <dest> before calling.
1213 * Returns a pointer to the destination
1214 */
1215struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest);
1216
William Lallemand421f5b52012-02-06 18:15:57 +01001217char *human_time(int t, short hz_div);
1218
1219extern const char *monthname[];
1220
1221/* date2str_log: write a date in the format :
1222 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
1223 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
1224 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
1225 *
1226 * without using sprintf. return a pointer to the last char written (\0) or
1227 * NULL if there isn't enough space.
1228 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02001229char *date2str_log(char *dest, const struct tm *tm, const struct timeval *date, size_t size);
William Lallemand421f5b52012-02-06 18:15:57 +01001230
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001231/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001232 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001233 * The string returned has the same format as returned by strftime(... "%z", tm).
1234 * Offsets are kept in an internal cache for better performances.
1235 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001236const char *get_gmt_offset(time_t t, struct tm *tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001237
William Lallemand421f5b52012-02-06 18:15:57 +01001238/* gmt2str_log: write a date in the format :
1239 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
1240 * return a pointer to the last char written (\0) or
1241 * NULL if there isn't enough space.
1242 */
1243char *gmt2str_log(char *dst, struct tm *tm, size_t size);
1244
Yuxans Yao4e25b012012-10-19 10:36:09 +08001245/* localdate2str_log: write a date in the format :
1246 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001247 * Both t and tm must represent the same time.
Yuxans Yao4e25b012012-10-19 10:36:09 +08001248 * return a pointer to the last char written (\0) or
1249 * NULL if there isn't enough space.
1250 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001251char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size);
Yuxans Yao4e25b012012-10-19 10:36:09 +08001252
Thierry Fournier93127942016-01-20 18:49:45 +01001253/* These 3 functions parses date string and fills the
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +05001254 * corresponding broken-down time in <tm>. In success case,
Thierry Fournier93127942016-01-20 18:49:45 +01001255 * it returns 1, otherwise, it returns 0.
1256 */
1257int parse_http_date(const char *date, int len, struct tm *tm);
1258int parse_imf_date(const char *date, int len, struct tm *tm);
1259int parse_rfc850_date(const char *date, int len, struct tm *tm);
1260int parse_asctime_date(const char *date, int len, struct tm *tm);
1261
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001262/* Dynamically allocates a string of the proper length to hold the formatted
1263 * output. NULL is returned on error. The caller is responsible for freeing the
1264 * memory area using free(). The resulting string is returned in <out> if the
1265 * pointer is not NULL. A previous version of <out> might be used to build the
1266 * new string, and it will be freed before returning if it is not NULL, which
1267 * makes it possible to build complex strings from iterative calls without
1268 * having to care about freeing intermediate values, as in the example below :
1269 *
1270 * memprintf(&err, "invalid argument: '%s'", arg);
1271 * ...
1272 * memprintf(&err, "parser said : <%s>\n", *err);
1273 * ...
1274 * free(*err);
1275 *
1276 * This means that <err> must be initialized to NULL before first invocation.
1277 * The return value also holds the allocated string, which eases error checking
1278 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001279 * passed instead and it will be ignored. The returned message will then also
1280 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001281 *
1282 * It is also convenient to use it without any free except the last one :
1283 * err = NULL;
1284 * if (!fct1(err)) report(*err);
1285 * if (!fct2(err)) report(*err);
1286 * if (!fct3(err)) report(*err);
1287 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02001288 *
1289 * memprintf relies on memvprintf. This last version can be called from any
1290 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001291 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02001292char *memvprintf(char **out, const char *format, va_list args)
1293 __attribute__ ((format(printf, 2, 0)));
1294
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001295char *memprintf(char **out, const char *format, ...)
1296 __attribute__ ((format(printf, 2, 3)));
1297
Willy Tarreau21c705b2012-09-14 11:40:36 +02001298/* Used to add <level> spaces before each line of <out>, unless there is only one line.
1299 * The input argument is automatically freed and reassigned. The result will have to be
1300 * freed by the caller.
1301 * Example of use :
1302 * parse(cmd, &err); (callee: memprintf(&err, ...))
1303 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
1304 * free(err);
1305 */
1306char *indent_msg(char **out, int level);
Willy Tarreaua2c99112019-08-21 13:17:37 +02001307int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001308
Willy Tarreau9d22e562019-03-29 18:49:09 +01001309/* removes environment variable <name> from the environment as found in
1310 * environ. This is only provided as an alternative for systems without
1311 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
Ilya Shipitsin77e3b4a2020-03-10 12:06:11 +05001312 * The principle is to scan environ for each occurrence of variable name
Willy Tarreau9d22e562019-03-29 18:49:09 +01001313 * <name> and to replace the matching pointers with the last pointer of
1314 * the array (since variables are not ordered).
1315 * It always returns 0 (success).
1316 */
1317int my_unsetenv(const char *name);
1318
Willy Tarreaudad36a32013-03-11 01:20:04 +01001319/* Convert occurrences of environment variables in the input string to their
1320 * corresponding value. A variable is identified as a series of alphanumeric
1321 * characters or underscores following a '$' sign. The <in> string must be
1322 * free()able. NULL returns NULL. The resulting string might be reallocated if
1323 * some expansion is made.
1324 */
1325char *env_expand(char *in);
1326
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001327/* debugging macro to emit messages using write() on fd #-1 so that strace sees
1328 * them.
1329 */
1330#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
1331
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001332/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02001333 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
1334 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001335 */
Willy Tarreaued936c52017-04-27 18:03:20 +02001336void debug_hexdump(FILE *out, const char *pfx, const char *buf, unsigned int baseaddr, int len);
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001337
Willy Tarreau9eebd8a2019-08-08 16:53:40 +02001338/* this is used to emit call traces when building with TRACE=1 */
Willy Tarreau12963822017-10-24 10:54:08 +02001339__attribute__((format(printf, 1, 2)))
Willy Tarreau9eebd8a2019-08-08 16:53:40 +02001340void calltrace(char *fmt, ...);
Willy Tarreau12963822017-10-24 10:54:08 +02001341
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02001342/* same as strstr() but case-insensitive */
1343const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
1344
Willy Tarreauab813a42018-09-10 18:41:28 +02001345/* after increasing a pointer value, it can exceed the first buffer
1346 * size. This function transform the value of <ptr> according with
1347 * the expected position. <chunks> is an array of the one or two
Joseph Herlant32b83272018-11-15 11:58:28 -08001348 * available chunks. The first value is the start of the first chunk,
Willy Tarreauab813a42018-09-10 18:41:28 +02001349 * the second value if the end+1 of the first chunks. The third value
1350 * is NULL or the start of the second chunk and the fourth value is
1351 * the end+1 of the second chunk. The function returns 1 if does a
1352 * wrap, else returns 0.
1353 */
1354static inline int fix_pointer_if_wrap(const char **chunks, const char **ptr)
1355{
1356 if (*ptr < chunks[1])
1357 return 0;
1358 if (!chunks[2])
1359 return 0;
1360 *ptr = chunks[2] + ( *ptr - chunks[1] );
1361 return 1;
1362}
Willy Tarreaubb519c72014-01-28 23:04:39 +01001363
1364/************************* Composite address manipulation *********************
1365 * Composite addresses are simply unsigned long data in which the higher bits
1366 * represent a pointer, and the two lower bits are flags. There are several
1367 * places where we just want to associate one or two flags to a pointer (eg,
1368 * to type it), and these functions permit this. The pointer is necessarily a
1369 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
1370 * with the flags.
1371 *****************************************************************************/
1372
1373/* Masks the two lower bits of a composite address and converts it to a
1374 * pointer. This is used to mix some bits with some aligned pointers to
1375 * structs and to retrieve the original (32-bit aligned) pointer.
1376 */
1377static inline void *caddr_to_ptr(unsigned long caddr)
1378{
1379 return (void *)(caddr & ~3UL);
1380}
1381
1382/* Only retrieves the two lower bits of a composite address. This is used to mix
1383 * some bits with some aligned pointers to structs and to retrieve the original
1384 * data (2 bits).
1385 */
1386static inline unsigned int caddr_to_data(unsigned long caddr)
1387{
1388 return (caddr & 3UL);
1389}
1390
1391/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
1392 * from <data> to form a composite address. This is used to mix some bits with
1393 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
1394 * pointer.
1395 */
1396static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
1397{
1398 return (((unsigned long)ptr) & ~3UL) + (data & 3);
1399}
1400
1401/* sets the 2 bits of <data> in the <caddr> composite address */
1402static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
1403{
1404 return caddr | (data & 3);
1405}
1406
1407/* clears the 2 bits of <data> in the <caddr> composite address */
1408static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
1409{
1410 return caddr & ~(unsigned long)(data & 3);
1411}
1412
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02001413/* UTF-8 decoder status */
1414#define UTF8_CODE_OK 0x00
1415#define UTF8_CODE_OVERLONG 0x10
1416#define UTF8_CODE_INVRANGE 0x20
1417#define UTF8_CODE_BADSEQ 0x40
1418
1419unsigned char utf8_next(const char *s, int len, unsigned int *c);
1420
1421static inline unsigned char utf8_return_code(unsigned int code)
1422{
1423 return code & 0xf0;
1424}
1425
1426static inline unsigned char utf8_return_length(unsigned char code)
1427{
1428 return code & 0x0f;
1429}
1430
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001431/* Turns 64-bit value <a> from host byte order to network byte order.
1432 * The principle consists in letting the compiler detect we're playing
1433 * with a union and simplify most or all operations. The asm-optimized
1434 * htonl() version involving bswap (x86) / rev (arm) / other is a single
1435 * operation on little endian, or a NOP on big-endian. In both cases,
1436 * this lets the compiler "see" that we're rebuilding a 64-bit word from
1437 * two 32-bit quantities that fit into a 32-bit register. In big endian,
1438 * the whole code is optimized out. In little endian, with a decent compiler,
1439 * a few bswap and 2 shifts are left, which is the minimum acceptable.
1440 */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001441static inline unsigned long long my_htonll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001442{
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001443#if defined(__x86_64__)
Willy Tarreaudea7c5c2017-10-18 11:39:33 +02001444 __asm__ volatile("bswap %0" : "=r"(a) : "0"(a));
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001445 return a;
1446#else
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001447 union {
1448 struct {
1449 unsigned int w1;
1450 unsigned int w2;
1451 } by32;
1452 unsigned long long by64;
1453 } w = { .by64 = a };
1454 return ((unsigned long long)htonl(w.by32.w1) << 32) | htonl(w.by32.w2);
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001455#endif
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001456}
1457
1458/* Turns 64-bit value <a> from network byte order to host byte order. */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001459static inline unsigned long long my_ntohll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001460{
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001461 return my_htonll(a);
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001462}
1463
Willy Tarreaue6e49cf2015-04-29 17:13:35 +02001464/* returns a 64-bit a timestamp with the finest resolution available. The
1465 * unit is intentionally not specified. It's mostly used to compare dates.
1466 */
1467#if defined(__i386__) || defined(__x86_64__)
1468static inline unsigned long long rdtsc()
1469{
1470 unsigned int a, d;
1471 asm volatile("rdtsc" : "=a" (a), "=d" (d));
1472 return a + ((unsigned long long)d << 32);
1473}
1474#else
1475static inline unsigned long long rdtsc()
1476{
1477 struct timeval tv;
1478 gettimeofday(&tv, NULL);
1479 return tv.tv_sec * 1000000 + tv.tv_usec;
1480}
1481#endif
1482
Maxime de Roucydc887852016-05-13 23:52:54 +02001483/* append a copy of string <str> (in a wordlist) at the end of the list <li>
1484 * On failure : return 0 and <err> filled with an error message.
1485 * The caller is responsible for freeing the <err> and <str> copy
1486 * memory area using free()
1487 */
1488struct list;
1489int list_append_word(struct list *li, const char *str, char **err);
1490
Willy Tarreau83061a82018-07-13 11:56:34 +02001491int dump_text(struct buffer *out, const char *buf, int bsize);
1492int dump_binary(struct buffer *out, const char *buf, int bsize);
1493int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001494 int *line, int ptr);
Willy Tarreau762fb3e2020-03-03 15:57:10 +01001495void dump_addr_and_bytes(struct buffer *buf, const char *pfx, const void *addr, int n);
Willy Tarreau37101052019-05-20 16:48:20 +02001496void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe);
1497int may_access(const void *ptr);
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01001498void *resolve_sym_name(struct buffer *buf, const char *pfx, void *addr);
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001499
Willy Tarreau13faf162020-03-04 07:44:06 +01001500#if defined(USE_BACKTRACE)
1501/* Note that this may result in opening libgcc() on first call, so it may need
1502 * to have been called once before chrooting.
1503 */
1504static forceinline int my_backtrace(void **buffer, int max)
1505{
1506#ifdef HA_HAVE_WORKING_BACKTRACE
1507 return backtrace(buffer, max);
1508#else
1509 const struct frame {
1510 const struct frame *next;
1511 void *ra;
1512 } *frame;
1513 int count;
1514
1515 frame = __builtin_frame_address(0);
1516 for (count = 0; count < max && may_access(frame) && may_access(frame->ra);) {
1517 buffer[count++] = frame->ra;
1518 frame = frame->next;
1519 }
1520 return count;
1521#endif
1522}
1523#endif
1524
Hubert Verstraete2eae3a02016-06-28 22:41:00 +02001525/* same as realloc() except that ptr is also freed upon failure */
1526static inline void *my_realloc2(void *ptr, size_t size)
1527{
1528 void *ret;
1529
1530 ret = realloc(ptr, size);
1531 if (!ret && size)
1532 free(ptr);
1533 return ret;
1534}
1535
Frédéric Lécaille3b717162019-02-25 15:04:22 +01001536int parse_dotted_uints(const char *s, unsigned int **nums, size_t *sz);
1537
Willy Tarreau52bf8392020-03-08 00:42:37 +01001538/* PRNG */
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01001539void ha_generate_uuid(struct buffer *output);
Willy Tarreau52bf8392020-03-08 00:42:37 +01001540void ha_random_seed(const unsigned char *seed, size_t len);
1541void ha_random_jump96(uint32_t dist);
1542uint64_t ha_random64();
1543
1544static inline uint32_t ha_random32()
1545{
1546 return ha_random64() >> 32;
1547}
1548
1549static inline int32_t ha_random()
1550{
1551 return ha_random32() >> 1;
1552}
1553
Lukas Tribusdcbc5c52016-09-12 21:42:07 +00001554/* HAP_STRING() makes a string from a literal while HAP_XSTRING() first
1555 * evaluates the argument and is suited to pass macros.
1556 *
1557 * They allow macros like PCRE_MAJOR to be defined without quotes, which
1558 * is convenient for applications that want to test its value.
1559 */
1560#define HAP_STRING(...) #__VA_ARGS__
1561#define HAP_XSTRING(...) HAP_STRING(__VA_ARGS__)
1562
Willy Tarreau2dd0d472006-06-29 17:53:05 +02001563#endif /* _COMMON_STANDARD_H */