blob: 6d2432f991b590b9b24f0d8fd3570b34a7256b5b [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
Thierry FOURNIER511e9472014-01-23 17:40:34 +010043/* size used for max length of decimal representation of long long int. */
44#define NB_LLMAX_STR (sizeof("-9223372036854775807")-1)
45
Willy Tarreau56adcf22012-12-23 18:00:29 +010046/* number of itoa_str entries */
Willy Tarreau59caa3b2018-12-14 13:59:42 +010047#define NB_ITOA_STR 16
William Lallemande7340ec2012-01-24 11:15:39 +010048
Willy Tarreau588297f2014-06-16 15:16:40 +020049/* maximum quoted string length (truncated above) */
50#define QSTR_SIZE 200
51#define NB_QSTR 10
52
Willy Tarreaubaaee002006-06-26 02:48:02 +020053/****** string-specific macros and functions ******/
54/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
55#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
56
57/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
58#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
59
60/* returns 1 only if only zero or one bit is set in X, which means that X is a
61 * power of 2, and 0 otherwise */
62#define POWEROF2(x) (((x) & ((x)-1)) == 0)
63
Willy Tarreau32c24552019-08-19 17:39:33 +020064/* DEFNULL() returns either the argument as-is, or NULL if absent. This is for
65 * use in macros arguments.
66 */
67#define DEFNULL(...) _FIRST_ARG(NULL, ##__VA_ARGS__, NULL)
68#define _FIRST_ARG(a, b, ...) b
69
Willy Tarreau5b180202010-07-18 10:40:48 +020070/* operators to compare values. They're ordered that way so that the lowest bit
71 * serves as a negation for the test and contains all tests that are not equal.
72 */
73enum {
74 STD_OP_LE = 0, STD_OP_GT = 1,
75 STD_OP_EQ = 2, STD_OP_NE = 3,
76 STD_OP_GE = 4, STD_OP_LT = 5,
77};
78
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010079enum http_scheme {
80 SCH_HTTP,
81 SCH_HTTPS,
82};
83
84struct split_url {
85 enum http_scheme scheme;
86 const char *host;
87 int host_len;
88};
89
Willy Tarreaufb4ba912019-08-29 09:32:21 +020090/* generic structure associating a name and a value, for use in arrays */
91struct name_desc {
92 const char *name;
93 const char *desc;
94};
95
Christopher Faulet99bca652017-11-14 16:47:26 +010096extern THREAD_LOCAL int itoa_idx; /* index of next itoa_str to use */
Willy Tarreau56adcf22012-12-23 18:00:29 +010097
Willy Tarreau7d58a632007-01-13 23:06:06 +010098/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020099 * copies at most <size-1> chars from <src> to <dst>. Last char is always
100 * set to 0, unless <size> is 0. The number of chars copied is returned
101 * (excluding the terminating zero).
102 * This code has been optimized for size and speed : on x86, it's 45 bytes
103 * long, uses only registers, and consumes only 4 cycles per char.
104 */
105extern int strlcpy2(char *dst, const char *src, int size);
106
107/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200108 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200109 * the ascii representation for number 'n' in decimal.
110 */
Christopher Faulet99bca652017-11-14 16:47:26 +0100111extern THREAD_LOCAL char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100112extern char *ultoa_r(unsigned long n, char *buffer, int size);
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200113extern char *lltoa_r(long long int n, char *buffer, int size);
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200114extern char *sltoa_r(long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200115extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200116static inline const char *ultoa(unsigned long n)
117{
118 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
119}
120
William Lallemande7340ec2012-01-24 11:15:39 +0100121/*
122 * unsigned long long ASCII representation
123 *
124 * return the last char '\0' or NULL if no enough
125 * space in dst
126 */
127char *ulltoa(unsigned long long n, char *dst, size_t size);
128
129
130/*
131 * unsigned long ASCII representation
132 *
133 * return the last char '\0' or NULL if no enough
134 * space in dst
135 */
136char *ultoa_o(unsigned long n, char *dst, size_t size);
137
138/*
139 * signed long ASCII representation
140 *
141 * return the last char '\0' or NULL if no enough
142 * space in dst
143 */
144char *ltoa_o(long int n, char *dst, size_t size);
145
146/*
147 * signed long long ASCII representation
148 *
149 * return the last char '\0' or NULL if no enough
150 * space in dst
151 */
152char *lltoa(long long n, char *dst, size_t size);
153
154/*
155 * write a ascii representation of a unsigned into dst,
156 * return a pointer to the last character
157 * Pad the ascii representation with '0', using size.
158 */
159char *utoa_pad(unsigned int n, char *dst, size_t size);
160
Willy Tarreaubaaee002006-06-26 02:48:02 +0200161/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200162 * This function simply returns a locally allocated string containing the ascii
163 * representation for number 'n' in decimal, unless n is 0 in which case it
164 * returns the alternate string (or an empty string if the alternate string is
165 * NULL). It use is intended for limits reported in reports, where it's
166 * desirable not to display anything if there is no limit. Warning! it shares
167 * the same vector as ultoa_r().
168 */
169extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
170
Willy Tarreau56adcf22012-12-23 18:00:29 +0100171/* returns a locally allocated string containing the ASCII representation of
172 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
173 * function call (eg: printf), shared with the other similar functions making
174 * use of itoa_str[].
175 */
176static inline const char *U2A(unsigned long n)
177{
178 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
179 if (++itoa_idx >= NB_ITOA_STR)
180 itoa_idx = 0;
181 return ret;
182}
183
184/* returns a locally allocated string containing the HTML representation of
185 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
186 * function call (eg: printf), shared with the other similar functions making
187 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200188 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100189static inline const char *U2H(unsigned long long n)
190{
191 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
192 if (++itoa_idx >= NB_ITOA_STR)
193 itoa_idx = 0;
194 return ret;
195}
196
Ioannis Cherouvim1ff76332018-10-24 10:05:19 +0300197/* returns a locally allocated string containing the ASCII representation of
Willy Tarreau56adcf22012-12-23 18:00:29 +0100198 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
199 * function call (eg: printf), shared with the other similar functions making
200 * use of itoa_str[].
201 */
202static inline const char *LIM2A(unsigned long n, const char *alt)
203{
204 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
205 if (++itoa_idx >= NB_ITOA_STR)
206 itoa_idx = 0;
207 return ret;
208}
Willy Tarreau91092e52007-10-25 16:58:42 +0200209
Willy Tarreau4d589e72019-08-23 19:02:26 +0200210/* returns the number of bytes needed to encode <v> as a varint. Be careful, use
211 * it only with constants as it generates a large code (typ. 180 bytes). Use the
212 * varint_bytes() version instead in case of doubt.
213 */
214int varint_bytes(uint64_t v);
215static inline int __varint_bytes(uint64_t v)
216{
217 switch (v) {
218 case 0x0000000000000000 ... 0x00000000000000ef: return 1;
219 case 0x00000000000000f0 ... 0x00000000000008ef: return 2;
220 case 0x00000000000008f0 ... 0x00000000000408ef: return 3;
221 case 0x00000000000408f0 ... 0x00000000020408ef: return 4;
222 case 0x00000000020408f0 ... 0x00000001020408ef: return 5;
223 case 0x00000001020408f0 ... 0x00000081020408ef: return 6;
224 case 0x00000081020408f0 ... 0x00004081020408ef: return 7;
225 case 0x00004081020408f0 ... 0x00204081020408ef: return 8;
226 case 0x00204081020408f0 ... 0x10204081020408ef: return 9;
227 default: return 10;
228 }
229}
230
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200231/* Encode the integer <i> into a varint (variable-length integer). The encoded
232 * value is copied in <*buf>. Here is the encoding format:
233 *
234 * 0 <= X < 240 : 1 byte (7.875 bits) [ XXXX XXXX ]
235 * 240 <= X < 2288 : 2 bytes (11 bits) [ 1111 XXXX ] [ 0XXX XXXX ]
236 * 2288 <= X < 264432 : 3 bytes (18 bits) [ 1111 XXXX ] [ 1XXX XXXX ] [ 0XXX XXXX ]
237 * 264432 <= X < 33818864 : 4 bytes (25 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*2 [ 0XXX XXXX ]
238 * 33818864 <= X < 4328786160 : 5 bytes (32 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*3 [ 0XXX XXXX ]
239 * ...
240 *
241 * On success, it returns the number of written bytes and <*buf> is moved after
242 * the encoded value. Otherwise, it returns -1. */
243static inline int
244encode_varint(uint64_t i, char **buf, char *end)
245{
246 unsigned char *p = (unsigned char *)*buf;
247 int r;
248
249 if (p >= (unsigned char *)end)
250 return -1;
251
252 if (i < 240) {
253 *p++ = i;
254 *buf = (char *)p;
255 return 1;
256 }
257
258 *p++ = (unsigned char)i | 240;
259 i = (i - 240) >> 4;
260 while (i >= 128) {
261 if (p >= (unsigned char *)end)
262 return -1;
263 *p++ = (unsigned char)i | 128;
264 i = (i - 128) >> 7;
265 }
266
267 if (p >= (unsigned char *)end)
268 return -1;
269 *p++ = (unsigned char)i;
270
271 r = ((char *)p - *buf);
272 *buf = (char *)p;
273 return r;
274}
275
276/* Decode a varint from <*buf> and save the decoded value in <*i>. See
277 * 'spoe_encode_varint' for details about varint.
278 * On success, it returns the number of read bytes and <*buf> is moved after the
279 * varint. Otherwise, it returns -1. */
280static inline int
281decode_varint(char **buf, char *end, uint64_t *i)
282{
283 unsigned char *p = (unsigned char *)*buf;
284 int r;
285
286 if (p >= (unsigned char *)end)
287 return -1;
288
289 *i = *p++;
290 if (*i < 240) {
291 *buf = (char *)p;
292 return 1;
293 }
294
295 r = 4;
296 do {
297 if (p >= (unsigned char *)end)
298 return -1;
299 *i += (uint64_t)*p << r;
300 r += 7;
301 } while (*p++ >= 128);
302
303 r = ((char *)p - *buf);
304 *buf = (char *)p;
305 return r;
306}
307
Willy Tarreau588297f2014-06-16 15:16:40 +0200308/* returns a locally allocated string containing the quoted encoding of the
309 * input string. The output may be truncated to QSTR_SIZE chars, but it is
310 * guaranteed that the string will always be properly terminated. Quotes are
311 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
312 * always be at least 4 chars.
313 */
314const char *qstr(const char *str);
315
316/* returns <str> or its quote-encoded equivalent if it contains at least one
317 * quote or a comma. This is aimed at build CSV-compatible strings.
318 */
319static inline const char *cstr(const char *str)
320{
321 const char *p = str;
322
323 while (*p) {
324 if (*p == ',' || *p == '"')
325 return qstr(str);
326 p++;
327 }
328 return str;
329}
330
Willy Tarreau91092e52007-10-25 16:58:42 +0200331/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200332 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
333 */
334extern int ishex(char s);
335
336/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100337 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200338 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100339 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200340static inline int hex2i(int c)
341{
Willy Tarreauaa398602017-11-10 11:19:54 +0100342 if ((unsigned char)(c -= '0') > 9) {
343 if ((unsigned char)(c -= 'A' - '0') > 5 &&
344 (unsigned char)(c -= 'a' - 'A') > 5)
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200345 c = -11;
346 c += 10;
347 }
348 return c;
349}
350
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100351/* rounds <i> down to the closest value having max 2 digits */
352unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100353
354/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100355 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
356 * invalid character is found, a pointer to it is returned. If everything is
357 * fine, NULL is returned.
358 */
359extern const char *invalid_char(const char *name);
360
361/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200362 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200363 * If an invalid character is found, a pointer to it is returned.
364 * If everything is fine, NULL is returned.
365 */
366extern const char *invalid_domainchar(const char *name);
367
368/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200369 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
370 * If an invalid character is found, a pointer to it is returned.
371 * If everything is fine, NULL is returned.
372 */
373extern const char *invalid_prefix_char(const char *name);
374
Willy Tarreau36f586b2020-02-14 18:25:17 +0100375/* returns true if <c> is an identifier character, that is, a digit, a letter,
Willy Tarreaua71667c2020-02-17 06:34:11 +0100376 * or '-', '+', '_', ':' or '.'. This is usable for proxy names, server names,
377 * ACL names, sample fetch names, and converter names.
Willy Tarreau36f586b2020-02-14 18:25:17 +0100378 */
379static inline int is_idchar(char c)
380{
381 return isalnum((int)(unsigned char)c) ||
Willy Tarreaua71667c2020-02-17 06:34:11 +0100382 c == '.' || c == '_' || c == '-' || c == '+' || c == ':';
Willy Tarreau36f586b2020-02-14 18:25:17 +0100383}
384
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200385/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100386 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200387 * port range consisting in two integers. The low and high end are always set
388 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100389 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200390 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100391 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
392 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
393 * address wants to ignore port, it must be terminated by a trailing colon (':').
394 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
395 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100396 * If <pfx> is non-null, it is used as a string prefix before any path-based
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200397 * address (typically the path to a unix socket). If use_dns is not true,
Joseph Herlant32b83272018-11-15 11:58:28 -0800398 * the function cannot accept the DNS resolution.
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200399 */
Willy Tarreau48ef4c92017-01-06 18:32:38 +0100400struct sockaddr_storage *str2sa_range(const char *str,
401 int *port, int *low, int *high,
402 char **err, const char *pfx,
403 char **fqdn, int resolve);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200404
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100405/* converts <str> to a struct in_addr containing a network mask. It can be
406 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +0300407 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100408 */
409int str2mask(const char *str, struct in_addr *mask);
410
Tim Duesterhus47185172018-01-25 16:24:49 +0100411/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +0100412 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +0100413 * if the conversion succeeds otherwise zero.
414 */
415int str2mask6(const char *str, struct in6_addr *mask);
416
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100417/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
418 * succeeds otherwise non-zero.
419 */
420int cidr2dotted(int cidr, struct in_addr *mask);
421
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200422/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200423 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200424 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
425 * is optionnal and either in the dotted or CIDR notation.
426 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
427 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100428int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200429
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100430/* str2ip and str2ip2:
431 *
432 * converts <str> to a struct sockaddr_storage* provided by the caller. The
433 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
434 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
435 * the function tries to guess the address family from the syntax. If the
436 * family is forced and the format doesn't match, an error is returned. The
437 * string is assumed to contain only an address, no port. The address can be a
438 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
439 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
440 * The return address will only have the address family and the address set,
441 * all other fields remain zero. The string is not supposed to be modified.
442 * The IPv6 '::' address is IN6ADDR_ANY.
443 *
444 * str2ip2:
445 *
446 * If <resolve> is set, this function try to resolve DNS, otherwise, it returns
447 * NULL result.
448 */
449struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve);
450static inline struct sockaddr_storage *str2ip(const char *str, struct sockaddr_storage *sa)
451{
452 return str2ip2(str, sa, 1);
453}
454
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100455/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200456 * converts <str> to two struct in6_addr* which must be pre-allocated.
457 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
458 * is an optionnal number of bits (128 being the default).
459 * Returns 1 if OK, 0 if error.
460 */
461int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
462
463/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200464 * Parse IP address found in url.
465 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100466int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200467
468/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100469 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100470 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100471int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100472
Willy Tarreau631f01c2011-09-05 00:36:48 +0200473/* Tries to convert a sockaddr_storage address to text form. Upon success, the
474 * address family is returned so that it's easy for the caller to adapt to the
475 * output format. Zero is returned if the address family is not supported. -1
476 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
477 * supported.
478 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +0200479int addr_to_str(const struct sockaddr_storage *addr, char *str, int size);
Willy Tarreau631f01c2011-09-05 00:36:48 +0200480
Simon Horman75ab8bd2014-06-16 09:39:41 +0900481/* Tries to convert a sockaddr_storage port to text form. Upon success, the
482 * address family is returned so that it's easy for the caller to adapt to the
483 * output format. Zero is returned if the address family is not supported. -1
484 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
485 * supported.
486 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +0200487int port_to_str(const struct sockaddr_storage *addr, char *str, int size);
Simon Horman75ab8bd2014-06-16 09:39:41 +0900488
Willy Tarreau16e01562016-08-09 16:46:18 +0200489/* check if the given address is local to the system or not. It will return
490 * -1 when it's not possible to know, 0 when the address is not local, 1 when
491 * it is. We don't want to iterate over all interfaces for this (and it is not
492 * portable). So instead we try to bind in UDP to this address on a free non
493 * privileged port and to connect to the same address, port 0 (connect doesn't
494 * care). If it succeeds, we own the address. Note that non-inet addresses are
495 * considered local since they're most likely AF_UNIX.
496 */
497int addr_is_local(const struct netns_entry *ns,
498 const struct sockaddr_storage *orig);
499
Willy Tarreaubaaee002006-06-26 02:48:02 +0200500/* will try to encode the string <string> replacing all characters tagged in
501 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
502 * prefixed by <escape>, and will store the result between <start> (included)
503 * and <stop> (excluded), and will always terminate the string with a '\0'
504 * before <stop>. The position of the '\0' is returned if the conversion
505 * completes. If bytes are missing between <start> and <stop>, then the
506 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
507 * cannot even be stored so we return <start> without writing the 0.
508 * The input string must also be zero-terminated.
509 */
510extern const char hextab[];
511char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200512 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +0200513 const char *string);
514
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100515/*
516 * Same behavior, except that it encodes chunk <chunk> instead of a string.
517 */
518char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200519 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +0200520 const struct buffer *chunk);
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100521
Dragan Dosen0edd1092016-02-12 13:23:02 +0100522/*
523 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200524 * character. The input <string> must be zero-terminated. The result will
525 * be stored between <start> (included) and <stop> (excluded). This
526 * function will always try to terminate the resulting string with a '\0'
527 * before <stop>, and will return its position if the conversion
528 * completes.
529 */
530char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200531 const char escape, const long *map,
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200532 const char *string);
533
534/*
535 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +0100536 * character. <chunk> contains the input to be escaped. The result will be
537 * stored between <start> (included) and <stop> (excluded). The function
538 * will always try to terminate the resulting string with a '\0' before
539 * <stop>, and will return its position if the conversion completes.
540 */
541char *escape_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200542 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +0200543 const struct buffer *chunk);
Dragan Dosen0edd1092016-02-12 13:23:02 +0100544
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100545
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200546/* Check a string for using it in a CSV output format. If the string contains
547 * one of the following four char <">, <,>, CR or LF, the string is
548 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
549 * <str> is the input string to be escaped. The function assumes that
550 * the input string is null-terminated.
551 *
552 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +0100553 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200554 * format.
555 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100556 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200557 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100558 * If <quote> is 1, the converter puts the quotes only if any character is
559 * escaped. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200560 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100561 * <output> is a struct chunk used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200562 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100563 * The function returns the converted string on its output. If an error
564 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200565 * for using the function directly as printf() argument.
566 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100567 * If the output buffer is too short to contain the input string, the result
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200568 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +0100569 *
570 * This function appends the encoding to the existing output chunk. Please
571 * use csv_enc() instead if you want to replace the output chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200572 */
Willy Tarreau83061a82018-07-13 11:56:34 +0200573const char *csv_enc_append(const char *str, int quote, struct buffer *output);
Willy Tarreau898529b2016-01-06 18:07:04 +0100574
575/* same as above but the output chunk is reset first */
Willy Tarreau83061a82018-07-13 11:56:34 +0200576static inline const char *csv_enc(const char *str, int quote,
577 struct buffer *output)
Willy Tarreau898529b2016-01-06 18:07:04 +0100578{
579 chunk_reset(output);
580 return csv_enc_append(str, quote, output);
581}
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200582
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200583/* Decode an URL-encoded string in-place. The resulting string might
584 * be shorter. If some forbidden characters are found, the conversion is
585 * aborted, the string is truncated before the issue and non-zero is returned,
586 * otherwise the operation returns non-zero indicating success.
587 */
588int url_decode(char *string);
589
Willy Tarreau6911fa42007-03-04 18:06:08 +0100590/* This one is 6 times faster than strtoul() on athlon, but does
591 * no check at all.
592 */
593static inline unsigned int __str2ui(const char *s)
594{
595 unsigned int i = 0;
596 while (*s) {
597 i = i * 10 - '0';
598 i += (unsigned char)*s++;
599 }
600 return i;
601}
602
603/* This one is 5 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 __str2uic(const char *s)
607{
608 unsigned int i = 0;
609 unsigned int j;
610 while (1) {
611 j = (*s++) - '0';
612 if (j > 9)
613 break;
614 i *= 10;
615 i += j;
616 }
617 return i;
618}
619
620/* This one is 28 times faster than strtoul() on athlon, but does
621 * no check at all!
622 */
623static inline unsigned int __strl2ui(const char *s, int len)
624{
625 unsigned int i = 0;
626 while (len-- > 0) {
627 i = i * 10 - '0';
628 i += (unsigned char)*s++;
629 }
630 return i;
631}
632
633/* This one is 7 times faster than strtoul() on athlon with checks.
634 * It returns the value of the number composed of all valid digits read.
635 */
636static inline unsigned int __strl2uic(const char *s, int len)
637{
638 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200639 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100640
641 while (len-- > 0) {
642 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200643 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100644 if (j > 9)
645 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200646 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100647 }
648 return i;
649}
650
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200651/* This function reads an unsigned integer from the string pointed to by <s>
652 * and returns it. The <s> pointer is adjusted to point to the first unread
653 * char. The function automatically stops at <end>.
654 */
655static inline unsigned int __read_uint(const char **s, const char *end)
656{
657 const char *ptr = *s;
658 unsigned int i = 0;
659 unsigned int j, k;
660
661 while (ptr < end) {
662 j = *ptr - '0';
663 k = i * 10;
664 if (j > 9)
665 break;
666 i = k + j;
667 ptr++;
668 }
669 *s = ptr;
670 return i;
671}
672
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200673unsigned long long int read_uint64(const char **s, const char *end);
674long long int read_int64(const char **s, const char *end);
675
Willy Tarreau6911fa42007-03-04 18:06:08 +0100676extern unsigned int str2ui(const char *s);
677extern unsigned int str2uic(const char *s);
678extern unsigned int strl2ui(const char *s, int len);
679extern unsigned int strl2uic(const char *s, int len);
680extern int strl2ic(const char *s, int len);
681extern int strl2irc(const char *s, int len, int *ret);
682extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100683extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200684extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200685unsigned int inetaddr_host(const char *text);
686unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200687unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100688
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200689static inline char *cut_crlf(char *s) {
690
Simon Horman5269cfb2013-02-13 17:48:00 +0900691 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200692 char *p = s++;
693
694 if (!*p)
695 return p;
696 }
697
Simon Horman5269cfb2013-02-13 17:48:00 +0900698 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200699
700 return s;
701}
702
703static inline char *ltrim(char *s, char c) {
704
705 if (c)
706 while (*s == c)
707 s++;
708
709 return s;
710}
711
712static inline char *rtrim(char *s, char c) {
713
714 char *p = s + strlen(s);
715
716 while (p-- > s)
717 if (*p == c)
718 *p = '\0';
719 else
720 break;
721
722 return s;
723}
724
725static inline char *alltrim(char *s, char c) {
726
727 rtrim(s, c);
728
729 return ltrim(s, c);
730}
731
Willy Tarreaufe944602007-10-25 10:34:16 +0200732/* This function converts the time_t value <now> into a broken out struct tm
733 * which must be allocated by the caller. It is highly recommended to use this
734 * function intead of localtime() because that one requires a time_t* which
735 * is not always compatible with tv_sec depending on OS/hardware combinations.
736 */
737static inline void get_localtime(const time_t now, struct tm *tm)
738{
739 localtime_r(&now, tm);
740}
741
Emeric Brun3a058f32009-06-30 18:26:00 +0200742/* This function converts the time_t value <now> into a broken out struct tm
743 * which must be allocated by the caller. It is highly recommended to use this
744 * function intead of gmtime() because that one requires a time_t* which
745 * is not always compatible with tv_sec depending on OS/hardware combinations.
746 */
747static inline void get_gmtime(const time_t now, struct tm *tm)
748{
749 gmtime_r(&now, tm);
750}
751
Willy Tarreaucb1949b2017-07-19 19:05:29 +0200752/* Counts a number of elapsed days since 01/01/0000 based solely on elapsed
753 * years and assuming the regular rule for leap years applies. It's fake but
754 * serves as a temporary origin. It's worth remembering that it's the first
755 * year of each period that is leap and not the last one, so for instance year
756 * 1 sees 366 days since year 0 was leap. For this reason we have to apply
757 * modular arithmetics which is why we offset the year by 399 before
758 * subtracting the excess at the end. No overflow here before ~11.7 million
759 * years.
760 */
761static inline unsigned int days_since_zero(unsigned int y)
762{
763 return y * 365 + (y + 399) / 4 - (y + 399) / 100 + (y + 399) / 400
764 - 399 / 4 + 399 / 100;
765}
766
767/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
768 * It is meant as a portable replacement for timegm() for use with valid inputs.
769 * Returns undefined results for invalid dates (eg: months out of range 0..11).
770 */
771extern time_t my_timegm(const struct tm *tm);
772
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100773/* This function parses a time value optionally followed by a unit suffix among
774 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
775 * expected by the caller. The computation does its best to avoid overflows.
776 * The value is returned in <ret> if everything is fine, and a NULL is returned
777 * by the function. In case of error, a pointer to the error is returned and
778 * <ret> is left untouched.
779 */
780extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100781extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100782
Willy Tarreau9faebe32019-06-07 19:00:37 +0200783/* special return values for the time parser */
784#define PARSE_TIME_UNDER ((char *)1)
785#define PARSE_TIME_OVER ((char *)2)
786
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100787/* unit flags to pass to parse_time_err */
788#define TIME_UNIT_US 0x0000
789#define TIME_UNIT_MS 0x0001
790#define TIME_UNIT_S 0x0002
791#define TIME_UNIT_MIN 0x0003
792#define TIME_UNIT_HOUR 0x0004
793#define TIME_UNIT_DAY 0x0005
794#define TIME_UNIT_MASK 0x0007
795
William Lallemand421f5b52012-02-06 18:15:57 +0100796#define SEC 1
797#define MINUTE (60 * SEC)
798#define HOUR (60 * MINUTE)
799#define DAY (24 * HOUR)
800
Willy Tarreau7f062c42009-03-05 18:43:00 +0100801/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
802 * This is used to compute fixed ratios by setting one of the operands to
803 * (2^32*ratio).
804 */
805static inline unsigned int mul32hi(unsigned int a, unsigned int b)
806{
807 return ((unsigned long long)a * b) >> 32;
808}
809
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200810/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
811 * function when you know for sure that the result fits in 32 bits, because
812 * it is optimal on x86 and on 64bit processors.
813 */
814static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
815{
816 unsigned int result;
817#ifdef __i386__
818 asm("divl %2"
819 : "=a" (result)
820 : "A"(o1), "rm"(o2));
821#else
822 result = o1 / o2;
823#endif
824 return result;
825}
826
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100827/* Simple popcountl implementation. It returns the number of ones in a word.
828 * Described here : https://graphics.stanford.edu/~seander/bithacks.html
829 */
David Carliere6c39412015-07-02 07:00:17 +0000830static inline unsigned int my_popcountl(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100831{
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100832 a = a - ((a >> 1) & ~0UL/3);
833 a = (a & ~0UL/15*3) + ((a >> 2) & ~0UL/15*3);
834 a = (a + (a >> 4)) & ~0UL/255*15;
835 return (unsigned long)(a * (~0UL/255)) >> (sizeof(unsigned long) - 1) * 8;
Willy Tarreau37994f02012-11-19 12:11:07 +0100836}
837
Willy Tarreau98d334b2018-10-15 09:33:41 +0200838/* returns non-zero if <a> has at least 2 bits set */
839static inline unsigned long atleast2(unsigned long a)
840{
841 return a & (a - 1);
842}
843
Christopher Fauletff813182017-11-22 15:00:13 +0100844/* Simple ffs implementation. It returns the position of the lowest bit set to
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100845 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
Willy Tarreau27346b02018-10-10 19:05:56 +0200846 */
Christopher Fauletff813182017-11-22 15:00:13 +0100847static inline unsigned int my_ffsl(unsigned long a)
848{
Willy Tarreau27346b02018-10-10 19:05:56 +0200849 unsigned long cnt;
Christopher Fauletff813182017-11-22 15:00:13 +0100850
Willy Tarreau27346b02018-10-10 19:05:56 +0200851#if defined(__x86_64__)
Willy Tarreauce487aa2018-10-29 16:09:57 +0100852 __asm__("bsf %1,%0\n" : "=r" (cnt) : "rm" (a));
Willy Tarreau27346b02018-10-10 19:05:56 +0200853 cnt++;
854#else
Christopher Fauletff813182017-11-22 15:00:13 +0100855
856 cnt = 1;
857#if LONG_MAX > 0x7FFFFFFFL /* 64bits */
858 if (!(a & 0xFFFFFFFFUL)) {
859 a >>= 32;
860 cnt += 32;
861 }
862#endif
863 if (!(a & 0XFFFFU)) {
864 a >>= 16;
865 cnt += 16;
866 }
867 if (!(a & 0XFF)) {
868 a >>= 8;
869 cnt += 8;
870 }
871 if (!(a & 0xf)) {
872 a >>= 4;
873 cnt += 4;
874 }
875 if (!(a & 0x3)) {
876 a >>= 2;
877 cnt += 2;
878 }
879 if (!(a & 0x1)) {
880 a >>= 1;
881 cnt += 1;
882 }
Willy Tarreau27346b02018-10-10 19:05:56 +0200883#endif /* x86_64 */
Christopher Fauletff813182017-11-22 15:00:13 +0100884
885 return cnt;
886}
887
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100888/* Simple fls implementation. It returns the position of the highest bit set to
889 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
890 */
891static inline unsigned int my_flsl(unsigned long a)
892{
893 unsigned long cnt;
894
895#if defined(__x86_64__)
896 __asm__("bsr %1,%0\n" : "=r" (cnt) : "rm" (a));
897 cnt++;
898#else
899
900 cnt = 1;
901#if LONG_MAX > 0x7FFFFFFFUL /* 64bits */
902 if (a & 0xFFFFFFFF00000000UL) {
903 a >>= 32;
904 cnt += 32;
905 }
906#endif
907 if (a & 0XFFFF0000U) {
908 a >>= 16;
909 cnt += 16;
910 }
911 if (a & 0XFF00) {
912 a >>= 8;
913 cnt += 8;
914 }
915 if (a & 0xf0) {
916 a >>= 4;
917 cnt += 4;
918 }
919 if (a & 0xc) {
920 a >>= 2;
921 cnt += 2;
922 }
923 if (a & 0x2) {
924 a >>= 1;
925 cnt += 1;
926 }
927#endif /* x86_64 */
928
929 return cnt;
930}
931
David Carliere6c39412015-07-02 07:00:17 +0000932/* Build a word with the <bits> lower bits set (reverse of my_popcountl) */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100933static inline unsigned long nbits(int bits)
934{
935 if (--bits < 0)
936 return 0;
937 else
938 return (2UL << bits) - 1;
939}
940
Willy Tarreau7355b042019-06-07 10:42:43 +0200941/* sets bit <bit> into map <map>, which must be long-aligned */
942static inline void ha_bit_set(unsigned long bit, long *map)
943{
944 map[bit / (8 * sizeof(*map))] |= 1UL << (bit & (8 * sizeof(*map) - 1));
945}
946
947/* clears bit <bit> from map <map>, which must be long-aligned */
948static inline void ha_bit_clr(unsigned long bit, long *map)
949{
950 map[bit / (8 * sizeof(*map))] &= ~(1UL << (bit & (8 * sizeof(*map) - 1)));
951}
952
953/* flips bit <bit> from map <map>, which must be long-aligned */
954static inline void ha_bit_flip(unsigned long bit, long *map)
955{
956 map[bit / (8 * sizeof(*map))] ^= 1UL << (bit & (8 * sizeof(*map) - 1));
957}
958
959/* returns non-zero if bit <bit> from map <map> is set, otherwise 0 */
960static inline int ha_bit_test(unsigned long bit, const long *map)
961{
962 return !!(map[bit / (8 * sizeof(*map))] & 1UL << (bit & (8 * sizeof(*map) - 1)));
963}
964
Willy Tarreau126d4062013-12-03 17:50:47 +0100965/*
966 * Parse binary string written in hexadecimal (source) and store the decoded
967 * result into binstr and set binstrlen to the lengh of binstr. Memory for
968 * binstr is allocated by the function. In case of error, returns 0 with an
969 * error message in err.
970 */
971int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
972
Willy Tarreau946ba592009-05-10 15:41:18 +0200973/* copies at most <n> characters from <src> and always terminates with '\0' */
974char *my_strndup(const char *src, int n);
975
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200976/*
977 * search needle in haystack
978 * returns the pointer if found, returns NULL otherwise
979 */
980const void *my_memmem(const void *, size_t, const void *, size_t);
981
Willy Tarreau482b00d2009-10-04 22:48:42 +0200982/* This function returns the first unused key greater than or equal to <key> in
983 * ID tree <root>. Zero is returned if no place is found.
984 */
985unsigned int get_next_id(struct eb_root *root, unsigned int key);
986
Willy Tarreau9c1e15d2017-11-15 18:51:29 +0100987/* dump the full tree to <file> in DOT format for debugging purposes. Will
988 * optionally highlight node <subj> if found, depending on operation <op> :
989 * 0 : nothing
990 * >0 : insertion, node/leaf are surrounded in red
991 * <0 : removal, node/leaf are dashed with no background
992 * Will optionally add "desc" as a label on the graph if set and non-null.
993 */
994void eb32sc_to_file(FILE *file, struct eb_root *root, const struct eb32sc_node *subj,
995 int op, const char *desc);
Willy Tarreaued3cda02017-11-15 15:04:05 +0100996
Willy Tarreau348238b2010-01-18 15:05:57 +0100997/* This function compares a sample word possibly followed by blanks to another
998 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
999 * otherwise zero. This intends to be used when checking HTTP headers for some
1000 * values.
1001 */
1002int word_match(const char *sample, int slen, const char *word, int wlen);
1003
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02001004/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
1005 * or the number of chars read in case of success.
1006 */
1007int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01001008int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02001009
Willy Tarreauacf95772010-06-14 19:09:21 +02001010/* To be used to quote config arg positions. Returns the string at <ptr>
1011 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
1012 * if ptr is NULL or empty. The string is locally allocated.
1013 */
1014const char *quote_arg(const char *ptr);
1015
Willy Tarreau5b180202010-07-18 10:40:48 +02001016/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
1017int get_std_op(const char *str);
1018
Willy Tarreau4c14eaa2010-11-24 14:01:45 +01001019/* hash a 32-bit integer to another 32-bit integer */
1020extern unsigned int full_hash(unsigned int a);
1021static inline unsigned int __full_hash(unsigned int a)
1022{
1023 /* This function is one of Bob Jenkins' full avalanche hashing
1024 * functions, which when provides quite a good distribution for little
1025 * input variations. The result is quite suited to fit over a 32-bit
1026 * space with enough variations so that a randomly picked number falls
1027 * equally before any server position.
1028 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
1029 */
1030 a = (a+0x7ed55d16) + (a<<12);
1031 a = (a^0xc761c23c) ^ (a>>19);
1032 a = (a+0x165667b1) + (a<<5);
1033 a = (a+0xd3a2646c) ^ (a<<9);
1034 a = (a+0xfd7046c5) + (a<<3);
1035 a = (a^0xb55a4f09) ^ (a>>16);
1036
1037 /* ensure values are better spread all around the tree by multiplying
1038 * by a large prime close to 3/4 of the tree.
1039 */
1040 return a * 3221225473U;
1041}
1042
Willy Tarreauf3241112019-02-26 09:56:22 +01001043/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
1044 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
1045 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
1046 * a popcount variant and is described here :
1047 * https://graphics.stanford.edu/~seander/bithacks.html
1048 */
1049unsigned int mask_find_rank_bit(unsigned int r, unsigned long m);
1050unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
1051 unsigned long a, unsigned long b,
1052 unsigned long c, unsigned long d);
1053void mask_prep_rank_map(unsigned long m,
1054 unsigned long *a, unsigned long *b,
1055 unsigned long *c, unsigned long *d);
1056
Willy Tarreau422a0a52012-10-26 19:47:23 +02001057/* sets the address family to AF_UNSPEC so that is_addr() does not match */
1058static inline void clear_addr(struct sockaddr_storage *addr)
1059{
1060 addr->ss_family = AF_UNSPEC;
1061}
1062
David du Colombier6f5ccb12011-03-10 22:26:24 +01001063/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1064 * otherwise zero.
1065 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001066static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +01001067{
1068 int i;
1069
1070 switch (addr->ss_family) {
1071 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +01001072 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +01001073 case AF_INET6:
1074 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
1075 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
1076 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
1077 }
1078 return 0;
1079}
1080
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001081/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1082 * or is a unix address, otherwise returns zero.
1083 */
1084static inline int is_addr(const struct sockaddr_storage *addr)
1085{
William Lallemand2fe7dd02018-09-11 16:51:29 +02001086 if (addr->ss_family == AF_UNIX || addr->ss_family == AF_CUST_SOCKPAIR)
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001087 return 1;
1088 else
1089 return is_inet_addr(addr);
1090}
1091
David du Colombier11bcb6c2011-03-24 12:23:00 +01001092/* returns port in network byte order */
1093static inline int get_net_port(struct sockaddr_storage *addr)
1094{
1095 switch (addr->ss_family) {
1096 case AF_INET:
1097 return ((struct sockaddr_in *)addr)->sin_port;
1098 case AF_INET6:
1099 return ((struct sockaddr_in6 *)addr)->sin6_port;
1100 }
1101 return 0;
1102}
1103
1104/* returns port in host byte order */
1105static inline int get_host_port(struct sockaddr_storage *addr)
1106{
1107 switch (addr->ss_family) {
1108 case AF_INET:
1109 return ntohs(((struct sockaddr_in *)addr)->sin_port);
1110 case AF_INET6:
1111 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
1112 }
1113 return 0;
1114}
1115
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +02001116/* returns address len for <addr>'s family, 0 for unknown families */
1117static inline int get_addr_len(const struct sockaddr_storage *addr)
1118{
1119 switch (addr->ss_family) {
1120 case AF_INET:
1121 return sizeof(struct sockaddr_in);
1122 case AF_INET6:
1123 return sizeof(struct sockaddr_in6);
1124 case AF_UNIX:
1125 return sizeof(struct sockaddr_un);
1126 }
1127 return 0;
1128}
1129
David du Colombier11bcb6c2011-03-24 12:23:00 +01001130/* set port in host byte order */
1131static inline int set_net_port(struct sockaddr_storage *addr, int port)
1132{
1133 switch (addr->ss_family) {
1134 case AF_INET:
1135 ((struct sockaddr_in *)addr)->sin_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001136 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001137 case AF_INET6:
1138 ((struct sockaddr_in6 *)addr)->sin6_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001139 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001140 }
1141 return 0;
1142}
1143
1144/* set port in network byte order */
1145static inline int set_host_port(struct sockaddr_storage *addr, int port)
1146{
1147 switch (addr->ss_family) {
1148 case AF_INET:
1149 ((struct sockaddr_in *)addr)->sin_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001150 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001151 case AF_INET6:
1152 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001153 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001154 }
1155 return 0;
1156}
1157
Thierry Fournier70473a52016-02-17 17:12:14 +01001158/* Convert mask from bit length form to in_addr form.
1159 * This function never fails.
1160 */
1161void len2mask4(int len, struct in_addr *addr);
1162
1163/* Convert mask from bit length form to in6_addr form.
1164 * This function never fails.
1165 */
1166void len2mask6(int len, struct in6_addr *addr);
1167
David du Colombier4f92d322011-03-24 11:09:31 +01001168/* Return true if IPv4 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001169extern 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 +01001170
1171/* Return true if IPv6 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001172extern 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 +01001173
Joseph Herlant32b83272018-11-15 11:58:28 -08001174/* Map IPv4 address on IPv6 address, as specified in RFC 3513. */
David du Colombier4f92d322011-03-24 11:09:31 +01001175extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
1176
Joseph Herlant32b83272018-11-15 11:58:28 -08001177/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01001178 * Return true if conversion is possible and false otherwise.
1179 */
1180extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
1181
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01001182/* compare two struct sockaddr_storage and return:
1183 * 0 (true) if the addr is the same in both
1184 * 1 (false) if the addr is not the same in both
1185 */
1186int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2);
1187
Baptiste Assmann08396c82016-01-31 00:27:17 +01001188/* copy ip from <source> into <dest>
1189 * the caller must clear <dest> before calling.
1190 * Returns a pointer to the destination
1191 */
1192struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest);
1193
William Lallemand421f5b52012-02-06 18:15:57 +01001194char *human_time(int t, short hz_div);
1195
1196extern const char *monthname[];
1197
1198/* date2str_log: write a date in the format :
1199 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
1200 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
1201 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
1202 *
1203 * without using sprintf. return a pointer to the last char written (\0) or
1204 * NULL if there isn't enough space.
1205 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02001206char *date2str_log(char *dest, const struct tm *tm, const struct timeval *date, size_t size);
William Lallemand421f5b52012-02-06 18:15:57 +01001207
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001208/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001209 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001210 * The string returned has the same format as returned by strftime(... "%z", tm).
1211 * Offsets are kept in an internal cache for better performances.
1212 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001213const char *get_gmt_offset(time_t t, struct tm *tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001214
William Lallemand421f5b52012-02-06 18:15:57 +01001215/* gmt2str_log: write a date in the format :
1216 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
1217 * return a pointer to the last char written (\0) or
1218 * NULL if there isn't enough space.
1219 */
1220char *gmt2str_log(char *dst, struct tm *tm, size_t size);
1221
Yuxans Yao4e25b012012-10-19 10:36:09 +08001222/* localdate2str_log: write a date in the format :
1223 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001224 * Both t and tm must represent the same time.
Yuxans Yao4e25b012012-10-19 10:36:09 +08001225 * return a pointer to the last char written (\0) or
1226 * NULL if there isn't enough space.
1227 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001228char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size);
Yuxans Yao4e25b012012-10-19 10:36:09 +08001229
Thierry Fournier93127942016-01-20 18:49:45 +01001230/* These 3 functions parses date string and fills the
1231 * corresponding broken-down time in <tm>. In succes case,
1232 * it returns 1, otherwise, it returns 0.
1233 */
1234int parse_http_date(const char *date, int len, struct tm *tm);
1235int parse_imf_date(const char *date, int len, struct tm *tm);
1236int parse_rfc850_date(const char *date, int len, struct tm *tm);
1237int parse_asctime_date(const char *date, int len, struct tm *tm);
1238
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001239/* Dynamically allocates a string of the proper length to hold the formatted
1240 * output. NULL is returned on error. The caller is responsible for freeing the
1241 * memory area using free(). The resulting string is returned in <out> if the
1242 * pointer is not NULL. A previous version of <out> might be used to build the
1243 * new string, and it will be freed before returning if it is not NULL, which
1244 * makes it possible to build complex strings from iterative calls without
1245 * having to care about freeing intermediate values, as in the example below :
1246 *
1247 * memprintf(&err, "invalid argument: '%s'", arg);
1248 * ...
1249 * memprintf(&err, "parser said : <%s>\n", *err);
1250 * ...
1251 * free(*err);
1252 *
1253 * This means that <err> must be initialized to NULL before first invocation.
1254 * The return value also holds the allocated string, which eases error checking
1255 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001256 * passed instead and it will be ignored. The returned message will then also
1257 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001258 *
1259 * It is also convenient to use it without any free except the last one :
1260 * err = NULL;
1261 * if (!fct1(err)) report(*err);
1262 * if (!fct2(err)) report(*err);
1263 * if (!fct3(err)) report(*err);
1264 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02001265 *
1266 * memprintf relies on memvprintf. This last version can be called from any
1267 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001268 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02001269char *memvprintf(char **out, const char *format, va_list args)
1270 __attribute__ ((format(printf, 2, 0)));
1271
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001272char *memprintf(char **out, const char *format, ...)
1273 __attribute__ ((format(printf, 2, 3)));
1274
Willy Tarreau21c705b2012-09-14 11:40:36 +02001275/* Used to add <level> spaces before each line of <out>, unless there is only one line.
1276 * The input argument is automatically freed and reassigned. The result will have to be
1277 * freed by the caller.
1278 * Example of use :
1279 * parse(cmd, &err); (callee: memprintf(&err, ...))
1280 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
1281 * free(err);
1282 */
1283char *indent_msg(char **out, int level);
Willy Tarreaua2c99112019-08-21 13:17:37 +02001284int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001285
Willy Tarreau9d22e562019-03-29 18:49:09 +01001286/* removes environment variable <name> from the environment as found in
1287 * environ. This is only provided as an alternative for systems without
1288 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
1289 * The principle is to scan environ for each occurence of variable name
1290 * <name> and to replace the matching pointers with the last pointer of
1291 * the array (since variables are not ordered).
1292 * It always returns 0 (success).
1293 */
1294int my_unsetenv(const char *name);
1295
Willy Tarreaudad36a32013-03-11 01:20:04 +01001296/* Convert occurrences of environment variables in the input string to their
1297 * corresponding value. A variable is identified as a series of alphanumeric
1298 * characters or underscores following a '$' sign. The <in> string must be
1299 * free()able. NULL returns NULL. The resulting string might be reallocated if
1300 * some expansion is made.
1301 */
1302char *env_expand(char *in);
1303
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001304/* debugging macro to emit messages using write() on fd #-1 so that strace sees
1305 * them.
1306 */
1307#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
1308
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001309/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02001310 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
1311 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001312 */
Willy Tarreaued936c52017-04-27 18:03:20 +02001313void debug_hexdump(FILE *out, const char *pfx, const char *buf, unsigned int baseaddr, int len);
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001314
Willy Tarreau9eebd8a2019-08-08 16:53:40 +02001315/* this is used to emit call traces when building with TRACE=1 */
Willy Tarreau12963822017-10-24 10:54:08 +02001316__attribute__((format(printf, 1, 2)))
Willy Tarreau9eebd8a2019-08-08 16:53:40 +02001317void calltrace(char *fmt, ...);
Willy Tarreau12963822017-10-24 10:54:08 +02001318
Willy Tarreau89efaed2013-12-13 15:14:55 +01001319/* used from everywhere just to drain results we don't want to read and which
1320 * recent versions of gcc increasingly and annoyingly complain about.
1321 */
1322extern int shut_your_big_mouth_gcc_int;
1323
1324/* used from everywhere just to drain results we don't want to read and which
1325 * recent versions of gcc increasingly and annoyingly complain about.
1326 */
1327static inline void shut_your_big_mouth_gcc(int r)
1328{
1329 shut_your_big_mouth_gcc_int = r;
1330}
1331
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02001332/* same as strstr() but case-insensitive */
1333const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
1334
Willy Tarreauab813a42018-09-10 18:41:28 +02001335/* after increasing a pointer value, it can exceed the first buffer
1336 * size. This function transform the value of <ptr> according with
1337 * the expected position. <chunks> is an array of the one or two
Joseph Herlant32b83272018-11-15 11:58:28 -08001338 * available chunks. The first value is the start of the first chunk,
Willy Tarreauab813a42018-09-10 18:41:28 +02001339 * the second value if the end+1 of the first chunks. The third value
1340 * is NULL or the start of the second chunk and the fourth value is
1341 * the end+1 of the second chunk. The function returns 1 if does a
1342 * wrap, else returns 0.
1343 */
1344static inline int fix_pointer_if_wrap(const char **chunks, const char **ptr)
1345{
1346 if (*ptr < chunks[1])
1347 return 0;
1348 if (!chunks[2])
1349 return 0;
1350 *ptr = chunks[2] + ( *ptr - chunks[1] );
1351 return 1;
1352}
Willy Tarreaubb519c72014-01-28 23:04:39 +01001353
1354/************************* Composite address manipulation *********************
1355 * Composite addresses are simply unsigned long data in which the higher bits
1356 * represent a pointer, and the two lower bits are flags. There are several
1357 * places where we just want to associate one or two flags to a pointer (eg,
1358 * to type it), and these functions permit this. The pointer is necessarily a
1359 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
1360 * with the flags.
1361 *****************************************************************************/
1362
1363/* Masks the two lower bits of a composite address and converts it to a
1364 * pointer. This is used to mix some bits with some aligned pointers to
1365 * structs and to retrieve the original (32-bit aligned) pointer.
1366 */
1367static inline void *caddr_to_ptr(unsigned long caddr)
1368{
1369 return (void *)(caddr & ~3UL);
1370}
1371
1372/* Only retrieves the two lower bits of a composite address. This is used to mix
1373 * some bits with some aligned pointers to structs and to retrieve the original
1374 * data (2 bits).
1375 */
1376static inline unsigned int caddr_to_data(unsigned long caddr)
1377{
1378 return (caddr & 3UL);
1379}
1380
1381/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
1382 * from <data> to form a composite address. This is used to mix some bits with
1383 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
1384 * pointer.
1385 */
1386static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
1387{
1388 return (((unsigned long)ptr) & ~3UL) + (data & 3);
1389}
1390
1391/* sets the 2 bits of <data> in the <caddr> composite address */
1392static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
1393{
1394 return caddr | (data & 3);
1395}
1396
1397/* clears the 2 bits of <data> in the <caddr> composite address */
1398static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
1399{
1400 return caddr & ~(unsigned long)(data & 3);
1401}
1402
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02001403/* UTF-8 decoder status */
1404#define UTF8_CODE_OK 0x00
1405#define UTF8_CODE_OVERLONG 0x10
1406#define UTF8_CODE_INVRANGE 0x20
1407#define UTF8_CODE_BADSEQ 0x40
1408
1409unsigned char utf8_next(const char *s, int len, unsigned int *c);
1410
1411static inline unsigned char utf8_return_code(unsigned int code)
1412{
1413 return code & 0xf0;
1414}
1415
1416static inline unsigned char utf8_return_length(unsigned char code)
1417{
1418 return code & 0x0f;
1419}
1420
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001421/* Turns 64-bit value <a> from host byte order to network byte order.
1422 * The principle consists in letting the compiler detect we're playing
1423 * with a union and simplify most or all operations. The asm-optimized
1424 * htonl() version involving bswap (x86) / rev (arm) / other is a single
1425 * operation on little endian, or a NOP on big-endian. In both cases,
1426 * this lets the compiler "see" that we're rebuilding a 64-bit word from
1427 * two 32-bit quantities that fit into a 32-bit register. In big endian,
1428 * the whole code is optimized out. In little endian, with a decent compiler,
1429 * a few bswap and 2 shifts are left, which is the minimum acceptable.
1430 */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001431static inline unsigned long long my_htonll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001432{
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001433#if defined(__x86_64__)
Willy Tarreaudea7c5c2017-10-18 11:39:33 +02001434 __asm__ volatile("bswap %0" : "=r"(a) : "0"(a));
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001435 return a;
1436#else
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001437 union {
1438 struct {
1439 unsigned int w1;
1440 unsigned int w2;
1441 } by32;
1442 unsigned long long by64;
1443 } w = { .by64 = a };
1444 return ((unsigned long long)htonl(w.by32.w1) << 32) | htonl(w.by32.w2);
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001445#endif
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001446}
1447
1448/* Turns 64-bit value <a> from network byte order to host byte order. */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001449static inline unsigned long long my_ntohll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001450{
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001451 return my_htonll(a);
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001452}
1453
Willy Tarreaue6e49cf2015-04-29 17:13:35 +02001454/* returns a 64-bit a timestamp with the finest resolution available. The
1455 * unit is intentionally not specified. It's mostly used to compare dates.
1456 */
1457#if defined(__i386__) || defined(__x86_64__)
1458static inline unsigned long long rdtsc()
1459{
1460 unsigned int a, d;
1461 asm volatile("rdtsc" : "=a" (a), "=d" (d));
1462 return a + ((unsigned long long)d << 32);
1463}
1464#else
1465static inline unsigned long long rdtsc()
1466{
1467 struct timeval tv;
1468 gettimeofday(&tv, NULL);
1469 return tv.tv_sec * 1000000 + tv.tv_usec;
1470}
1471#endif
1472
Maxime de Roucydc887852016-05-13 23:52:54 +02001473/* append a copy of string <str> (in a wordlist) at the end of the list <li>
1474 * On failure : return 0 and <err> filled with an error message.
1475 * The caller is responsible for freeing the <err> and <str> copy
1476 * memory area using free()
1477 */
1478struct list;
1479int list_append_word(struct list *li, const char *str, char **err);
1480
Willy Tarreau83061a82018-07-13 11:56:34 +02001481int dump_text(struct buffer *out, const char *buf, int bsize);
1482int dump_binary(struct buffer *out, const char *buf, int bsize);
1483int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001484 int *line, int ptr);
Willy Tarreau37101052019-05-20 16:48:20 +02001485void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe);
1486int may_access(const void *ptr);
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001487
Hubert Verstraete2eae3a02016-06-28 22:41:00 +02001488/* same as realloc() except that ptr is also freed upon failure */
1489static inline void *my_realloc2(void *ptr, size_t size)
1490{
1491 void *ret;
1492
1493 ret = realloc(ptr, size);
1494 if (!ret && size)
1495 free(ptr);
1496 return ret;
1497}
1498
Frédéric Lécaille3b717162019-02-25 15:04:22 +01001499int parse_dotted_uints(const char *s, unsigned int **nums, size_t *sz);
1500
Lukas Tribusdcbc5c52016-09-12 21:42:07 +00001501/* HAP_STRING() makes a string from a literal while HAP_XSTRING() first
1502 * evaluates the argument and is suited to pass macros.
1503 *
1504 * They allow macros like PCRE_MAJOR to be defined without quotes, which
1505 * is convenient for applications that want to test its value.
1506 */
1507#define HAP_STRING(...) #__VA_ARGS__
1508#define HAP_XSTRING(...) HAP_STRING(__VA_ARGS__)
1509
Willy Tarreau2dd0d472006-06-29 17:53:05 +02001510#endif /* _COMMON_STANDARD_H */