blob: aaed6be176742ad8e7dd20d9f3f6385655c705c5 [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 Tarreaued7ee6f2020-03-08 00:41:00 +010064/* rotate left a 64-bit integer by <bits:[0-5]> bits */
65static inline uint64_t rotl64(uint64_t v, uint8_t bits)
66{
67#if !defined(__ARM_ARCH_8A) && !defined(__x86_64__)
68 bits &= 63;
69#endif
70 v = (v << bits) | (v >> (-bits & 63));
71 return v;
72}
73
74/* rotate right a 64-bit integer by <bits:[0-5]> bits */
75static inline uint64_t rotr64(uint64_t v, uint8_t bits)
76{
77#if !defined(__ARM_ARCH_8A) && !defined(__x86_64__)
78 bits &= 63;
79#endif
80 v = (v >> bits) | (v << (-bits & 63));
81 return v;
82}
83
Willy Tarreau5b180202010-07-18 10:40:48 +020084/* operators to compare values. They're ordered that way so that the lowest bit
85 * serves as a negation for the test and contains all tests that are not equal.
86 */
87enum {
88 STD_OP_LE = 0, STD_OP_GT = 1,
89 STD_OP_EQ = 2, STD_OP_NE = 3,
90 STD_OP_GE = 4, STD_OP_LT = 5,
91};
92
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010093enum http_scheme {
94 SCH_HTTP,
95 SCH_HTTPS,
96};
97
98struct split_url {
99 enum http_scheme scheme;
100 const char *host;
101 int host_len;
102};
103
Christopher Faulet99bca652017-11-14 16:47:26 +0100104extern THREAD_LOCAL int itoa_idx; /* index of next itoa_str to use */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100105
Willy Tarreau7d58a632007-01-13 23:06:06 +0100106/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200107 * copies at most <size-1> chars from <src> to <dst>. Last char is always
108 * set to 0, unless <size> is 0. The number of chars copied is returned
109 * (excluding the terminating zero).
110 * This code has been optimized for size and speed : on x86, it's 45 bytes
111 * long, uses only registers, and consumes only 4 cycles per char.
112 */
113extern int strlcpy2(char *dst, const char *src, int size);
114
115/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200116 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200117 * the ascii representation for number 'n' in decimal.
118 */
Christopher Faulet99bca652017-11-14 16:47:26 +0100119extern THREAD_LOCAL char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100120extern char *ultoa_r(unsigned long n, char *buffer, int size);
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200121extern char *lltoa_r(long long int n, char *buffer, int size);
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200122extern char *sltoa_r(long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200123extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200124static inline const char *ultoa(unsigned long n)
125{
126 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
127}
128
William Lallemande7340ec2012-01-24 11:15:39 +0100129/*
130 * unsigned long long ASCII representation
131 *
132 * return the last char '\0' or NULL if no enough
133 * space in dst
134 */
135char *ulltoa(unsigned long long n, char *dst, size_t size);
136
137
138/*
139 * unsigned long ASCII representation
140 *
141 * return the last char '\0' or NULL if no enough
142 * space in dst
143 */
144char *ultoa_o(unsigned long n, char *dst, size_t size);
145
146/*
147 * signed long ASCII representation
148 *
149 * return the last char '\0' or NULL if no enough
150 * space in dst
151 */
152char *ltoa_o(long int n, char *dst, size_t size);
153
154/*
155 * signed long long ASCII representation
156 *
157 * return the last char '\0' or NULL if no enough
158 * space in dst
159 */
160char *lltoa(long long n, char *dst, size_t size);
161
162/*
163 * write a ascii representation of a unsigned into dst,
164 * return a pointer to the last character
165 * Pad the ascii representation with '0', using size.
166 */
167char *utoa_pad(unsigned int n, char *dst, size_t size);
168
Willy Tarreaubaaee002006-06-26 02:48:02 +0200169/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200170 * This function simply returns a locally allocated string containing the ascii
171 * representation for number 'n' in decimal, unless n is 0 in which case it
172 * returns the alternate string (or an empty string if the alternate string is
173 * NULL). It use is intended for limits reported in reports, where it's
174 * desirable not to display anything if there is no limit. Warning! it shares
175 * the same vector as ultoa_r().
176 */
177extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
178
Willy Tarreau56adcf22012-12-23 18:00:29 +0100179/* returns a locally allocated string containing the ASCII representation of
180 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
181 * function call (eg: printf), shared with the other similar functions making
182 * use of itoa_str[].
183 */
184static inline const char *U2A(unsigned long n)
185{
186 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
187 if (++itoa_idx >= NB_ITOA_STR)
188 itoa_idx = 0;
189 return ret;
190}
191
192/* returns a locally allocated string containing the HTML representation of
193 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
194 * function call (eg: printf), shared with the other similar functions making
195 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200196 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100197static inline const char *U2H(unsigned long long n)
198{
199 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
200 if (++itoa_idx >= NB_ITOA_STR)
201 itoa_idx = 0;
202 return ret;
203}
204
Ioannis Cherouvim1ff76332018-10-24 10:05:19 +0300205/* returns a locally allocated string containing the ASCII representation of
Willy Tarreau56adcf22012-12-23 18:00:29 +0100206 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
207 * function call (eg: printf), shared with the other similar functions making
208 * use of itoa_str[].
209 */
210static inline const char *LIM2A(unsigned long n, const char *alt)
211{
212 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
213 if (++itoa_idx >= NB_ITOA_STR)
214 itoa_idx = 0;
215 return ret;
216}
Willy Tarreau91092e52007-10-25 16:58:42 +0200217
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200218/* Encode the integer <i> into a varint (variable-length integer). The encoded
219 * value is copied in <*buf>. Here is the encoding format:
220 *
221 * 0 <= X < 240 : 1 byte (7.875 bits) [ XXXX XXXX ]
222 * 240 <= X < 2288 : 2 bytes (11 bits) [ 1111 XXXX ] [ 0XXX XXXX ]
223 * 2288 <= X < 264432 : 3 bytes (18 bits) [ 1111 XXXX ] [ 1XXX XXXX ] [ 0XXX XXXX ]
224 * 264432 <= X < 33818864 : 4 bytes (25 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*2 [ 0XXX XXXX ]
225 * 33818864 <= X < 4328786160 : 5 bytes (32 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*3 [ 0XXX XXXX ]
226 * ...
227 *
228 * On success, it returns the number of written bytes and <*buf> is moved after
229 * the encoded value. Otherwise, it returns -1. */
230static inline int
231encode_varint(uint64_t i, char **buf, char *end)
232{
233 unsigned char *p = (unsigned char *)*buf;
234 int r;
235
236 if (p >= (unsigned char *)end)
237 return -1;
238
239 if (i < 240) {
240 *p++ = i;
241 *buf = (char *)p;
242 return 1;
243 }
244
245 *p++ = (unsigned char)i | 240;
246 i = (i - 240) >> 4;
247 while (i >= 128) {
248 if (p >= (unsigned char *)end)
249 return -1;
250 *p++ = (unsigned char)i | 128;
251 i = (i - 128) >> 7;
252 }
253
254 if (p >= (unsigned char *)end)
255 return -1;
256 *p++ = (unsigned char)i;
257
258 r = ((char *)p - *buf);
259 *buf = (char *)p;
260 return r;
261}
262
263/* Decode a varint from <*buf> and save the decoded value in <*i>. See
264 * 'spoe_encode_varint' for details about varint.
265 * On success, it returns the number of read bytes and <*buf> is moved after the
266 * varint. Otherwise, it returns -1. */
267static inline int
268decode_varint(char **buf, char *end, uint64_t *i)
269{
270 unsigned char *p = (unsigned char *)*buf;
271 int r;
272
273 if (p >= (unsigned char *)end)
274 return -1;
275
276 *i = *p++;
277 if (*i < 240) {
278 *buf = (char *)p;
279 return 1;
280 }
281
282 r = 4;
283 do {
284 if (p >= (unsigned char *)end)
285 return -1;
286 *i += (uint64_t)*p << r;
287 r += 7;
288 } while (*p++ >= 128);
289
290 r = ((char *)p - *buf);
291 *buf = (char *)p;
292 return r;
293}
294
Willy Tarreau588297f2014-06-16 15:16:40 +0200295/* returns a locally allocated string containing the quoted encoding of the
296 * input string. The output may be truncated to QSTR_SIZE chars, but it is
297 * guaranteed that the string will always be properly terminated. Quotes are
298 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
299 * always be at least 4 chars.
300 */
301const char *qstr(const char *str);
302
303/* returns <str> or its quote-encoded equivalent if it contains at least one
304 * quote or a comma. This is aimed at build CSV-compatible strings.
305 */
306static inline const char *cstr(const char *str)
307{
308 const char *p = str;
309
310 while (*p) {
311 if (*p == ',' || *p == '"')
312 return qstr(str);
313 p++;
314 }
315 return str;
316}
317
Willy Tarreau91092e52007-10-25 16:58:42 +0200318/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200319 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
320 */
321extern int ishex(char s);
322
323/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100324 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200325 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100326 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200327static inline int hex2i(int c)
328{
Willy Tarreauaa398602017-11-10 11:19:54 +0100329 if ((unsigned char)(c -= '0') > 9) {
330 if ((unsigned char)(c -= 'A' - '0') > 5 &&
331 (unsigned char)(c -= 'a' - 'A') > 5)
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200332 c = -11;
333 c += 10;
334 }
335 return c;
336}
337
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100338/* rounds <i> down to the closest value having max 2 digits */
339unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100340
341/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100342 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
343 * invalid character is found, a pointer to it is returned. If everything is
344 * fine, NULL is returned.
345 */
346extern const char *invalid_char(const char *name);
347
348/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200349 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200350 * If an invalid character is found, a pointer to it is returned.
351 * If everything is fine, NULL is returned.
352 */
353extern const char *invalid_domainchar(const char *name);
354
355/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200356 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
357 * If an invalid character is found, a pointer to it is returned.
358 * If everything is fine, NULL is returned.
359 */
360extern const char *invalid_prefix_char(const char *name);
361
362/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100363 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200364 * port range consisting in two integers. The low and high end are always set
365 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100366 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200367 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100368 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
369 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
370 * address wants to ignore port, it must be terminated by a trailing colon (':').
371 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
372 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100373 * If <pfx> is non-null, it is used as a string prefix before any path-based
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200374 * address (typically the path to a unix socket). If use_dns is not true,
Joseph Herlant32b83272018-11-15 11:58:28 -0800375 * the function cannot accept the DNS resolution.
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200376 */
Willy Tarreau48ef4c92017-01-06 18:32:38 +0100377struct sockaddr_storage *str2sa_range(const char *str,
378 int *port, int *low, int *high,
379 char **err, const char *pfx,
380 char **fqdn, int resolve);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200381
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100382/* converts <str> to a struct in_addr containing a network mask. It can be
383 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +0300384 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100385 */
386int str2mask(const char *str, struct in_addr *mask);
387
Tim Duesterhus47185172018-01-25 16:24:49 +0100388/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +0100389 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +0100390 * if the conversion succeeds otherwise zero.
391 */
392int str2mask6(const char *str, struct in6_addr *mask);
393
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100394/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
395 * succeeds otherwise non-zero.
396 */
397int cidr2dotted(int cidr, struct in_addr *mask);
398
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200399/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200400 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200401 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
402 * is optionnal and either in the dotted or CIDR notation.
403 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
404 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100405int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200406
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100407/* str2ip and str2ip2:
408 *
409 * converts <str> to a struct sockaddr_storage* provided by the caller. The
410 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
411 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
412 * the function tries to guess the address family from the syntax. If the
413 * family is forced and the format doesn't match, an error is returned. The
414 * string is assumed to contain only an address, no port. The address can be a
415 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
416 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
417 * The return address will only have the address family and the address set,
418 * all other fields remain zero. The string is not supposed to be modified.
419 * The IPv6 '::' address is IN6ADDR_ANY.
420 *
421 * str2ip2:
422 *
423 * If <resolve> is set, this function try to resolve DNS, otherwise, it returns
424 * NULL result.
425 */
426struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve);
427static inline struct sockaddr_storage *str2ip(const char *str, struct sockaddr_storage *sa)
428{
429 return str2ip2(str, sa, 1);
430}
431
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100432/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200433 * converts <str> to two struct in6_addr* which must be pre-allocated.
434 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
435 * is an optionnal number of bits (128 being the default).
436 * Returns 1 if OK, 0 if error.
437 */
438int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
439
440/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200441 * Parse IP address found in url.
442 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100443int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200444
445/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100446 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100447 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100448int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100449
Willy Tarreau631f01c2011-09-05 00:36:48 +0200450/* Tries to convert a sockaddr_storage address to text form. Upon success, the
451 * address family is returned so that it's easy for the caller to adapt to the
452 * output format. Zero is returned if the address family is not supported. -1
453 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
454 * supported.
455 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +0200456int addr_to_str(const struct sockaddr_storage *addr, char *str, int size);
Willy Tarreau631f01c2011-09-05 00:36:48 +0200457
Simon Horman75ab8bd2014-06-16 09:39:41 +0900458/* Tries to convert a sockaddr_storage port to text form. Upon success, the
459 * address family is returned so that it's easy for the caller to adapt to the
460 * output format. Zero is returned if the address family is not supported. -1
461 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
462 * supported.
463 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +0200464int port_to_str(const struct sockaddr_storage *addr, char *str, int size);
Simon Horman75ab8bd2014-06-16 09:39:41 +0900465
Willy Tarreau16e01562016-08-09 16:46:18 +0200466/* check if the given address is local to the system or not. It will return
467 * -1 when it's not possible to know, 0 when the address is not local, 1 when
468 * it is. We don't want to iterate over all interfaces for this (and it is not
469 * portable). So instead we try to bind in UDP to this address on a free non
470 * privileged port and to connect to the same address, port 0 (connect doesn't
471 * care). If it succeeds, we own the address. Note that non-inet addresses are
472 * considered local since they're most likely AF_UNIX.
473 */
474int addr_is_local(const struct netns_entry *ns,
475 const struct sockaddr_storage *orig);
476
Willy Tarreaubaaee002006-06-26 02:48:02 +0200477/* will try to encode the string <string> replacing all characters tagged in
478 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
479 * prefixed by <escape>, and will store the result between <start> (included)
480 * and <stop> (excluded), and will always terminate the string with a '\0'
481 * before <stop>. The position of the '\0' is returned if the conversion
482 * completes. If bytes are missing between <start> and <stop>, then the
483 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
484 * cannot even be stored so we return <start> without writing the 0.
485 * The input string must also be zero-terminated.
486 */
487extern const char hextab[];
488char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200489 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +0200490 const char *string);
491
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100492/*
493 * Same behavior, except that it encodes chunk <chunk> instead of a string.
494 */
495char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200496 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +0200497 const struct buffer *chunk);
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100498
Dragan Dosen0edd1092016-02-12 13:23:02 +0100499/*
500 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200501 * character. The input <string> must be zero-terminated. The result will
502 * be stored between <start> (included) and <stop> (excluded). This
503 * function will always try to terminate the resulting string with a '\0'
504 * before <stop>, and will return its position if the conversion
505 * completes.
506 */
507char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +0200508 const char escape, const long *map,
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200509 const char *string);
510
511/*
512 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +0100513 * character. <chunk> contains the input to be escaped. The result will be
514 * stored between <start> (included) and <stop> (excluded). The function
515 * will always try to terminate the resulting string with a '\0' before
516 * <stop>, and will return its position if the conversion completes.
517 */
518char *escape_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);
Dragan Dosen0edd1092016-02-12 13:23:02 +0100521
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100522
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200523/* Check a string for using it in a CSV output format. If the string contains
524 * one of the following four char <">, <,>, CR or LF, the string is
525 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
526 * <str> is the input string to be escaped. The function assumes that
527 * the input string is null-terminated.
528 *
529 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +0100530 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200531 * format.
532 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100533 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200534 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100535 * If <quote> is 1, the converter puts the quotes only if any character is
536 * escaped. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200537 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100538 * <output> is a struct chunk used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200539 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100540 * The function returns the converted string on its output. If an error
541 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200542 * for using the function directly as printf() argument.
543 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100544 * If the output buffer is too short to contain the input string, the result
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200545 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +0100546 *
547 * This function appends the encoding to the existing output chunk. Please
548 * use csv_enc() instead if you want to replace the output chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200549 */
Willy Tarreau83061a82018-07-13 11:56:34 +0200550const char *csv_enc_append(const char *str, int quote, struct buffer *output);
Willy Tarreau898529b2016-01-06 18:07:04 +0100551
552/* same as above but the output chunk is reset first */
Willy Tarreau83061a82018-07-13 11:56:34 +0200553static inline const char *csv_enc(const char *str, int quote,
554 struct buffer *output)
Willy Tarreau898529b2016-01-06 18:07:04 +0100555{
556 chunk_reset(output);
557 return csv_enc_append(str, quote, output);
558}
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200559
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200560/* Decode an URL-encoded string in-place. The resulting string might
561 * be shorter. If some forbidden characters are found, the conversion is
562 * aborted, the string is truncated before the issue and non-zero is returned,
563 * otherwise the operation returns non-zero indicating success.
564 */
565int url_decode(char *string);
566
Willy Tarreau6911fa42007-03-04 18:06:08 +0100567/* This one is 6 times faster than strtoul() on athlon, but does
568 * no check at all.
569 */
570static inline unsigned int __str2ui(const char *s)
571{
572 unsigned int i = 0;
573 while (*s) {
574 i = i * 10 - '0';
575 i += (unsigned char)*s++;
576 }
577 return i;
578}
579
580/* This one is 5 times faster than strtoul() on athlon with checks.
581 * It returns the value of the number composed of all valid digits read.
582 */
583static inline unsigned int __str2uic(const char *s)
584{
585 unsigned int i = 0;
586 unsigned int j;
587 while (1) {
588 j = (*s++) - '0';
589 if (j > 9)
590 break;
591 i *= 10;
592 i += j;
593 }
594 return i;
595}
596
597/* This one is 28 times faster than strtoul() on athlon, but does
598 * no check at all!
599 */
600static inline unsigned int __strl2ui(const char *s, int len)
601{
602 unsigned int i = 0;
603 while (len-- > 0) {
604 i = i * 10 - '0';
605 i += (unsigned char)*s++;
606 }
607 return i;
608}
609
610/* This one is 7 times faster than strtoul() on athlon with checks.
611 * It returns the value of the number composed of all valid digits read.
612 */
613static inline unsigned int __strl2uic(const char *s, int len)
614{
615 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200616 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100617
618 while (len-- > 0) {
619 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200620 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100621 if (j > 9)
622 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200623 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100624 }
625 return i;
626}
627
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200628/* This function reads an unsigned integer from the string pointed to by <s>
629 * and returns it. The <s> pointer is adjusted to point to the first unread
630 * char. The function automatically stops at <end>.
631 */
632static inline unsigned int __read_uint(const char **s, const char *end)
633{
634 const char *ptr = *s;
635 unsigned int i = 0;
636 unsigned int j, k;
637
638 while (ptr < end) {
639 j = *ptr - '0';
640 k = i * 10;
641 if (j > 9)
642 break;
643 i = k + j;
644 ptr++;
645 }
646 *s = ptr;
647 return i;
648}
649
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200650unsigned long long int read_uint64(const char **s, const char *end);
651long long int read_int64(const char **s, const char *end);
652
Willy Tarreau6911fa42007-03-04 18:06:08 +0100653extern unsigned int str2ui(const char *s);
654extern unsigned int str2uic(const char *s);
655extern unsigned int strl2ui(const char *s, int len);
656extern unsigned int strl2uic(const char *s, int len);
657extern int strl2ic(const char *s, int len);
658extern int strl2irc(const char *s, int len, int *ret);
659extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100660extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200661extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200662unsigned int inetaddr_host(const char *text);
663unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200664unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100665
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200666static inline char *cut_crlf(char *s) {
667
Simon Horman5269cfb2013-02-13 17:48:00 +0900668 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200669 char *p = s++;
670
671 if (!*p)
672 return p;
673 }
674
Simon Horman5269cfb2013-02-13 17:48:00 +0900675 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200676
677 return s;
678}
679
680static inline char *ltrim(char *s, char c) {
681
682 if (c)
683 while (*s == c)
684 s++;
685
686 return s;
687}
688
689static inline char *rtrim(char *s, char c) {
690
691 char *p = s + strlen(s);
692
693 while (p-- > s)
694 if (*p == c)
695 *p = '\0';
696 else
697 break;
698
699 return s;
700}
701
702static inline char *alltrim(char *s, char c) {
703
704 rtrim(s, c);
705
706 return ltrim(s, c);
707}
708
Willy Tarreaufe944602007-10-25 10:34:16 +0200709/* This function converts the time_t value <now> into a broken out struct tm
710 * which must be allocated by the caller. It is highly recommended to use this
711 * function intead of localtime() because that one requires a time_t* which
712 * is not always compatible with tv_sec depending on OS/hardware combinations.
713 */
714static inline void get_localtime(const time_t now, struct tm *tm)
715{
716 localtime_r(&now, tm);
717}
718
Emeric Brun3a058f32009-06-30 18:26:00 +0200719/* This function converts the time_t value <now> into a broken out struct tm
720 * which must be allocated by the caller. It is highly recommended to use this
721 * function intead of gmtime() because that one requires a time_t* which
722 * is not always compatible with tv_sec depending on OS/hardware combinations.
723 */
724static inline void get_gmtime(const time_t now, struct tm *tm)
725{
726 gmtime_r(&now, tm);
727}
728
Willy Tarreaucb1949b2017-07-19 19:05:29 +0200729/* Counts a number of elapsed days since 01/01/0000 based solely on elapsed
730 * years and assuming the regular rule for leap years applies. It's fake but
731 * serves as a temporary origin. It's worth remembering that it's the first
732 * year of each period that is leap and not the last one, so for instance year
733 * 1 sees 366 days since year 0 was leap. For this reason we have to apply
734 * modular arithmetics which is why we offset the year by 399 before
735 * subtracting the excess at the end. No overflow here before ~11.7 million
736 * years.
737 */
738static inline unsigned int days_since_zero(unsigned int y)
739{
740 return y * 365 + (y + 399) / 4 - (y + 399) / 100 + (y + 399) / 400
741 - 399 / 4 + 399 / 100;
742}
743
744/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
745 * It is meant as a portable replacement for timegm() for use with valid inputs.
746 * Returns undefined results for invalid dates (eg: months out of range 0..11).
747 */
748extern time_t my_timegm(const struct tm *tm);
749
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100750/* This function parses a time value optionally followed by a unit suffix among
751 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
752 * expected by the caller. The computation does its best to avoid overflows.
753 * The value is returned in <ret> if everything is fine, and a NULL is returned
754 * by the function. In case of error, a pointer to the error is returned and
755 * <ret> is left untouched.
756 */
757extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100758extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100759
Willy Tarreau9faebe32019-06-07 19:00:37 +0200760/* special return values for the time parser */
761#define PARSE_TIME_UNDER ((char *)1)
762#define PARSE_TIME_OVER ((char *)2)
763
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100764/* unit flags to pass to parse_time_err */
765#define TIME_UNIT_US 0x0000
766#define TIME_UNIT_MS 0x0001
767#define TIME_UNIT_S 0x0002
768#define TIME_UNIT_MIN 0x0003
769#define TIME_UNIT_HOUR 0x0004
770#define TIME_UNIT_DAY 0x0005
771#define TIME_UNIT_MASK 0x0007
772
William Lallemand421f5b52012-02-06 18:15:57 +0100773#define SEC 1
774#define MINUTE (60 * SEC)
775#define HOUR (60 * MINUTE)
776#define DAY (24 * HOUR)
777
Willy Tarreau7f062c42009-03-05 18:43:00 +0100778/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
779 * This is used to compute fixed ratios by setting one of the operands to
780 * (2^32*ratio).
781 */
782static inline unsigned int mul32hi(unsigned int a, unsigned int b)
783{
784 return ((unsigned long long)a * b) >> 32;
785}
786
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200787/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
788 * function when you know for sure that the result fits in 32 bits, because
789 * it is optimal on x86 and on 64bit processors.
790 */
791static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
792{
793 unsigned int result;
794#ifdef __i386__
795 asm("divl %2"
796 : "=a" (result)
797 : "A"(o1), "rm"(o2));
798#else
799 result = o1 / o2;
800#endif
801 return result;
802}
803
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100804/* Simple popcountl implementation. It returns the number of ones in a word.
805 * Described here : https://graphics.stanford.edu/~seander/bithacks.html
806 */
David Carliere6c39412015-07-02 07:00:17 +0000807static inline unsigned int my_popcountl(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100808{
Willy Tarreaucafa56e2019-02-02 20:17:31 +0100809 a = a - ((a >> 1) & ~0UL/3);
810 a = (a & ~0UL/15*3) + ((a >> 2) & ~0UL/15*3);
811 a = (a + (a >> 4)) & ~0UL/255*15;
812 return (unsigned long)(a * (~0UL/255)) >> (sizeof(unsigned long) - 1) * 8;
Willy Tarreau37994f02012-11-19 12:11:07 +0100813}
814
Willy Tarreau98d334b2018-10-15 09:33:41 +0200815/* returns non-zero if <a> has at least 2 bits set */
816static inline unsigned long atleast2(unsigned long a)
817{
818 return a & (a - 1);
819}
820
Christopher Fauletff813182017-11-22 15:00:13 +0100821/* Simple ffs implementation. It returns the position of the lowest bit set to
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100822 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
Willy Tarreau27346b02018-10-10 19:05:56 +0200823 */
Christopher Fauletff813182017-11-22 15:00:13 +0100824static inline unsigned int my_ffsl(unsigned long a)
825{
Willy Tarreau27346b02018-10-10 19:05:56 +0200826 unsigned long cnt;
Christopher Fauletff813182017-11-22 15:00:13 +0100827
Willy Tarreau27346b02018-10-10 19:05:56 +0200828#if defined(__x86_64__)
Willy Tarreauce487aa2018-10-29 16:09:57 +0100829 __asm__("bsf %1,%0\n" : "=r" (cnt) : "rm" (a));
Willy Tarreau27346b02018-10-10 19:05:56 +0200830 cnt++;
831#else
Christopher Fauletff813182017-11-22 15:00:13 +0100832
833 cnt = 1;
834#if LONG_MAX > 0x7FFFFFFFL /* 64bits */
835 if (!(a & 0xFFFFFFFFUL)) {
836 a >>= 32;
837 cnt += 32;
838 }
839#endif
840 if (!(a & 0XFFFFU)) {
841 a >>= 16;
842 cnt += 16;
843 }
844 if (!(a & 0XFF)) {
845 a >>= 8;
846 cnt += 8;
847 }
848 if (!(a & 0xf)) {
849 a >>= 4;
850 cnt += 4;
851 }
852 if (!(a & 0x3)) {
853 a >>= 2;
854 cnt += 2;
855 }
856 if (!(a & 0x1)) {
857 a >>= 1;
858 cnt += 1;
859 }
Willy Tarreau27346b02018-10-10 19:05:56 +0200860#endif /* x86_64 */
Christopher Fauletff813182017-11-22 15:00:13 +0100861
862 return cnt;
863}
864
Willy Tarreaud87a67f2019-03-05 12:04:55 +0100865/* Simple fls implementation. It returns the position of the highest bit set to
866 * one, starting at 1. It is illegal to call it with a==0 (undefined result).
867 */
868static inline unsigned int my_flsl(unsigned long a)
869{
870 unsigned long cnt;
871
872#if defined(__x86_64__)
873 __asm__("bsr %1,%0\n" : "=r" (cnt) : "rm" (a));
874 cnt++;
875#else
876
877 cnt = 1;
878#if LONG_MAX > 0x7FFFFFFFUL /* 64bits */
879 if (a & 0xFFFFFFFF00000000UL) {
880 a >>= 32;
881 cnt += 32;
882 }
883#endif
884 if (a & 0XFFFF0000U) {
885 a >>= 16;
886 cnt += 16;
887 }
888 if (a & 0XFF00) {
889 a >>= 8;
890 cnt += 8;
891 }
892 if (a & 0xf0) {
893 a >>= 4;
894 cnt += 4;
895 }
896 if (a & 0xc) {
897 a >>= 2;
898 cnt += 2;
899 }
900 if (a & 0x2) {
901 a >>= 1;
902 cnt += 1;
903 }
904#endif /* x86_64 */
905
906 return cnt;
907}
908
David Carliere6c39412015-07-02 07:00:17 +0000909/* Build a word with the <bits> lower bits set (reverse of my_popcountl) */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100910static inline unsigned long nbits(int bits)
911{
912 if (--bits < 0)
913 return 0;
914 else
915 return (2UL << bits) - 1;
916}
917
Willy Tarreau7355b042019-06-07 10:42:43 +0200918/* sets bit <bit> into map <map>, which must be long-aligned */
919static inline void ha_bit_set(unsigned long bit, long *map)
920{
921 map[bit / (8 * sizeof(*map))] |= 1UL << (bit & (8 * sizeof(*map) - 1));
922}
923
924/* clears bit <bit> from map <map>, which must be long-aligned */
925static inline void ha_bit_clr(unsigned long bit, long *map)
926{
927 map[bit / (8 * sizeof(*map))] &= ~(1UL << (bit & (8 * sizeof(*map) - 1)));
928}
929
930/* flips bit <bit> from map <map>, which must be long-aligned */
931static inline void ha_bit_flip(unsigned long bit, long *map)
932{
933 map[bit / (8 * sizeof(*map))] ^= 1UL << (bit & (8 * sizeof(*map) - 1));
934}
935
936/* returns non-zero if bit <bit> from map <map> is set, otherwise 0 */
937static inline int ha_bit_test(unsigned long bit, const long *map)
938{
939 return !!(map[bit / (8 * sizeof(*map))] & 1UL << (bit & (8 * sizeof(*map) - 1)));
940}
941
Willy Tarreau126d4062013-12-03 17:50:47 +0100942/*
943 * Parse binary string written in hexadecimal (source) and store the decoded
944 * result into binstr and set binstrlen to the lengh of binstr. Memory for
945 * binstr is allocated by the function. In case of error, returns 0 with an
946 * error message in err.
947 */
948int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
949
Willy Tarreau946ba592009-05-10 15:41:18 +0200950/* copies at most <n> characters from <src> and always terminates with '\0' */
951char *my_strndup(const char *src, int n);
952
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200953/*
954 * search needle in haystack
955 * returns the pointer if found, returns NULL otherwise
956 */
957const void *my_memmem(const void *, size_t, const void *, size_t);
958
Willy Tarreau482b00d2009-10-04 22:48:42 +0200959/* This function returns the first unused key greater than or equal to <key> in
960 * ID tree <root>. Zero is returned if no place is found.
961 */
962unsigned int get_next_id(struct eb_root *root, unsigned int key);
963
Willy Tarreau9c1e15d2017-11-15 18:51:29 +0100964/* dump the full tree to <file> in DOT format for debugging purposes. Will
965 * optionally highlight node <subj> if found, depending on operation <op> :
966 * 0 : nothing
967 * >0 : insertion, node/leaf are surrounded in red
968 * <0 : removal, node/leaf are dashed with no background
969 * Will optionally add "desc" as a label on the graph if set and non-null.
970 */
971void eb32sc_to_file(FILE *file, struct eb_root *root, const struct eb32sc_node *subj,
972 int op, const char *desc);
Willy Tarreaued3cda02017-11-15 15:04:05 +0100973
Willy Tarreau348238b2010-01-18 15:05:57 +0100974/* This function compares a sample word possibly followed by blanks to another
975 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
976 * otherwise zero. This intends to be used when checking HTTP headers for some
977 * values.
978 */
979int word_match(const char *sample, int slen, const char *word, int wlen);
980
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200981/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
982 * or the number of chars read in case of success.
983 */
984int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +0100985int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200986
Willy Tarreauacf95772010-06-14 19:09:21 +0200987/* To be used to quote config arg positions. Returns the string at <ptr>
988 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
989 * if ptr is NULL or empty. The string is locally allocated.
990 */
991const char *quote_arg(const char *ptr);
992
Willy Tarreau5b180202010-07-18 10:40:48 +0200993/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
994int get_std_op(const char *str);
995
Willy Tarreau4c14eaa2010-11-24 14:01:45 +0100996/* hash a 32-bit integer to another 32-bit integer */
997extern unsigned int full_hash(unsigned int a);
998static inline unsigned int __full_hash(unsigned int a)
999{
1000 /* This function is one of Bob Jenkins' full avalanche hashing
1001 * functions, which when provides quite a good distribution for little
1002 * input variations. The result is quite suited to fit over a 32-bit
1003 * space with enough variations so that a randomly picked number falls
1004 * equally before any server position.
1005 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
1006 */
1007 a = (a+0x7ed55d16) + (a<<12);
1008 a = (a^0xc761c23c) ^ (a>>19);
1009 a = (a+0x165667b1) + (a<<5);
1010 a = (a+0xd3a2646c) ^ (a<<9);
1011 a = (a+0xfd7046c5) + (a<<3);
1012 a = (a^0xb55a4f09) ^ (a>>16);
1013
1014 /* ensure values are better spread all around the tree by multiplying
1015 * by a large prime close to 3/4 of the tree.
1016 */
1017 return a * 3221225473U;
1018}
1019
Willy Tarreauf3241112019-02-26 09:56:22 +01001020/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
1021 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
1022 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
1023 * a popcount variant and is described here :
1024 * https://graphics.stanford.edu/~seander/bithacks.html
1025 */
1026unsigned int mask_find_rank_bit(unsigned int r, unsigned long m);
1027unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
1028 unsigned long a, unsigned long b,
1029 unsigned long c, unsigned long d);
1030void mask_prep_rank_map(unsigned long m,
1031 unsigned long *a, unsigned long *b,
1032 unsigned long *c, unsigned long *d);
1033
Willy Tarreau422a0a52012-10-26 19:47:23 +02001034/* sets the address family to AF_UNSPEC so that is_addr() does not match */
1035static inline void clear_addr(struct sockaddr_storage *addr)
1036{
1037 addr->ss_family = AF_UNSPEC;
1038}
1039
David du Colombier6f5ccb12011-03-10 22:26:24 +01001040/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1041 * otherwise zero.
1042 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001043static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +01001044{
1045 int i;
1046
1047 switch (addr->ss_family) {
1048 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +01001049 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +01001050 case AF_INET6:
1051 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
1052 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
1053 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
1054 }
1055 return 0;
1056}
1057
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001058/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
1059 * or is a unix address, otherwise returns zero.
1060 */
1061static inline int is_addr(const struct sockaddr_storage *addr)
1062{
William Lallemand2fe7dd02018-09-11 16:51:29 +02001063 if (addr->ss_family == AF_UNIX || addr->ss_family == AF_CUST_SOCKPAIR)
Willy Tarreau18ca2d42014-05-09 22:40:55 +02001064 return 1;
1065 else
1066 return is_inet_addr(addr);
1067}
1068
David du Colombier11bcb6c2011-03-24 12:23:00 +01001069/* returns port in network byte order */
1070static inline int get_net_port(struct sockaddr_storage *addr)
1071{
1072 switch (addr->ss_family) {
1073 case AF_INET:
1074 return ((struct sockaddr_in *)addr)->sin_port;
1075 case AF_INET6:
1076 return ((struct sockaddr_in6 *)addr)->sin6_port;
1077 }
1078 return 0;
1079}
1080
1081/* returns port in host byte order */
1082static inline int get_host_port(struct sockaddr_storage *addr)
1083{
1084 switch (addr->ss_family) {
1085 case AF_INET:
1086 return ntohs(((struct sockaddr_in *)addr)->sin_port);
1087 case AF_INET6:
1088 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
1089 }
1090 return 0;
1091}
1092
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +02001093/* returns address len for <addr>'s family, 0 for unknown families */
1094static inline int get_addr_len(const struct sockaddr_storage *addr)
1095{
1096 switch (addr->ss_family) {
1097 case AF_INET:
1098 return sizeof(struct sockaddr_in);
1099 case AF_INET6:
1100 return sizeof(struct sockaddr_in6);
1101 case AF_UNIX:
1102 return sizeof(struct sockaddr_un);
1103 }
1104 return 0;
1105}
1106
David du Colombier11bcb6c2011-03-24 12:23:00 +01001107/* set port in host byte order */
1108static inline int set_net_port(struct sockaddr_storage *addr, int port)
1109{
1110 switch (addr->ss_family) {
1111 case AF_INET:
1112 ((struct sockaddr_in *)addr)->sin_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001113 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001114 case AF_INET6:
1115 ((struct sockaddr_in6 *)addr)->sin6_port = port;
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001116 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001117 }
1118 return 0;
1119}
1120
1121/* set port in network byte order */
1122static inline int set_host_port(struct sockaddr_storage *addr, int port)
1123{
1124 switch (addr->ss_family) {
1125 case AF_INET:
1126 ((struct sockaddr_in *)addr)->sin_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001127 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001128 case AF_INET6:
1129 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
Willy Tarreau4c0fcc22018-09-20 10:48:35 +02001130 break;
David du Colombier11bcb6c2011-03-24 12:23:00 +01001131 }
1132 return 0;
1133}
1134
Thierry Fournier70473a52016-02-17 17:12:14 +01001135/* Convert mask from bit length form to in_addr form.
1136 * This function never fails.
1137 */
1138void len2mask4(int len, struct in_addr *addr);
1139
1140/* Convert mask from bit length form to in6_addr form.
1141 * This function never fails.
1142 */
1143void len2mask6(int len, struct in6_addr *addr);
1144
David du Colombier4f92d322011-03-24 11:09:31 +01001145/* Return true if IPv4 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001146extern 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 +01001147
1148/* Return true if IPv6 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +02001149extern 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 +01001150
Joseph Herlant32b83272018-11-15 11:58:28 -08001151/* Map IPv4 address on IPv6 address, as specified in RFC 3513. */
David du Colombier4f92d322011-03-24 11:09:31 +01001152extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
1153
Joseph Herlant32b83272018-11-15 11:58:28 -08001154/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01001155 * Return true if conversion is possible and false otherwise.
1156 */
1157extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
1158
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01001159/* compare two struct sockaddr_storage and return:
1160 * 0 (true) if the addr is the same in both
1161 * 1 (false) if the addr is not the same in both
1162 */
1163int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2);
1164
Baptiste Assmann08396c82016-01-31 00:27:17 +01001165/* copy ip from <source> into <dest>
1166 * the caller must clear <dest> before calling.
1167 * Returns a pointer to the destination
1168 */
1169struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest);
1170
William Lallemand421f5b52012-02-06 18:15:57 +01001171char *human_time(int t, short hz_div);
1172
1173extern const char *monthname[];
1174
1175/* date2str_log: write a date in the format :
1176 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
1177 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
1178 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
1179 *
1180 * without using sprintf. return a pointer to the last char written (\0) or
1181 * NULL if there isn't enough space.
1182 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02001183char *date2str_log(char *dest, const struct tm *tm, const struct timeval *date, size_t size);
William Lallemand421f5b52012-02-06 18:15:57 +01001184
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001185/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001186 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001187 * The string returned has the same format as returned by strftime(... "%z", tm).
1188 * Offsets are kept in an internal cache for better performances.
1189 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001190const char *get_gmt_offset(time_t t, struct tm *tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001191
William Lallemand421f5b52012-02-06 18:15:57 +01001192/* gmt2str_log: write a date in the format :
1193 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
1194 * return a pointer to the last char written (\0) or
1195 * NULL if there isn't enough space.
1196 */
1197char *gmt2str_log(char *dst, struct tm *tm, size_t size);
1198
Yuxans Yao4e25b012012-10-19 10:36:09 +08001199/* localdate2str_log: write a date in the format :
1200 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001201 * Both t and tm must represent the same time.
Yuxans Yao4e25b012012-10-19 10:36:09 +08001202 * return a pointer to the last char written (\0) or
1203 * NULL if there isn't enough space.
1204 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001205char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size);
Yuxans Yao4e25b012012-10-19 10:36:09 +08001206
Thierry Fournier93127942016-01-20 18:49:45 +01001207/* These 3 functions parses date string and fills the
1208 * corresponding broken-down time in <tm>. In succes case,
1209 * it returns 1, otherwise, it returns 0.
1210 */
1211int parse_http_date(const char *date, int len, struct tm *tm);
1212int parse_imf_date(const char *date, int len, struct tm *tm);
1213int parse_rfc850_date(const char *date, int len, struct tm *tm);
1214int parse_asctime_date(const char *date, int len, struct tm *tm);
1215
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001216/* Dynamically allocates a string of the proper length to hold the formatted
1217 * output. NULL is returned on error. The caller is responsible for freeing the
1218 * memory area using free(). The resulting string is returned in <out> if the
1219 * pointer is not NULL. A previous version of <out> might be used to build the
1220 * new string, and it will be freed before returning if it is not NULL, which
1221 * makes it possible to build complex strings from iterative calls without
1222 * having to care about freeing intermediate values, as in the example below :
1223 *
1224 * memprintf(&err, "invalid argument: '%s'", arg);
1225 * ...
1226 * memprintf(&err, "parser said : <%s>\n", *err);
1227 * ...
1228 * free(*err);
1229 *
1230 * This means that <err> must be initialized to NULL before first invocation.
1231 * The return value also holds the allocated string, which eases error checking
1232 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001233 * passed instead and it will be ignored. The returned message will then also
1234 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001235 *
1236 * It is also convenient to use it without any free except the last one :
1237 * err = NULL;
1238 * if (!fct1(err)) report(*err);
1239 * if (!fct2(err)) report(*err);
1240 * if (!fct3(err)) report(*err);
1241 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02001242 *
1243 * memprintf relies on memvprintf. This last version can be called from any
1244 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001245 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02001246char *memvprintf(char **out, const char *format, va_list args)
1247 __attribute__ ((format(printf, 2, 0)));
1248
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001249char *memprintf(char **out, const char *format, ...)
1250 __attribute__ ((format(printf, 2, 3)));
1251
Willy Tarreau21c705b2012-09-14 11:40:36 +02001252/* Used to add <level> spaces before each line of <out>, unless there is only one line.
1253 * The input argument is automatically freed and reassigned. The result will have to be
1254 * freed by the caller.
1255 * Example of use :
1256 * parse(cmd, &err); (callee: memprintf(&err, ...))
1257 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
1258 * free(err);
1259 */
1260char *indent_msg(char **out, int level);
Willy Tarreaufe575b52019-08-21 13:17:37 +02001261int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001262
Willy Tarreau9d22e562019-03-29 18:49:09 +01001263/* removes environment variable <name> from the environment as found in
1264 * environ. This is only provided as an alternative for systems without
1265 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
1266 * The principle is to scan environ for each occurence of variable name
1267 * <name> and to replace the matching pointers with the last pointer of
1268 * the array (since variables are not ordered).
1269 * It always returns 0 (success).
1270 */
1271int my_unsetenv(const char *name);
1272
Willy Tarreaudad36a32013-03-11 01:20:04 +01001273/* Convert occurrences of environment variables in the input string to their
1274 * corresponding value. A variable is identified as a series of alphanumeric
1275 * characters or underscores following a '$' sign. The <in> string must be
1276 * free()able. NULL returns NULL. The resulting string might be reallocated if
1277 * some expansion is made.
1278 */
1279char *env_expand(char *in);
1280
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001281/* debugging macro to emit messages using write() on fd #-1 so that strace sees
1282 * them.
1283 */
1284#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
1285
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001286/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02001287 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
1288 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001289 */
Willy Tarreaued936c52017-04-27 18:03:20 +02001290void debug_hexdump(FILE *out, const char *pfx, const char *buf, unsigned int baseaddr, int len);
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001291
Willy Tarreau12963822017-10-24 10:54:08 +02001292/* this is used to emit traces when building with TRACE=1 */
1293__attribute__((format(printf, 1, 2)))
1294void trace(char *fmt, ...);
1295
Willy Tarreau89efaed2013-12-13 15:14:55 +01001296/* used from everywhere just to drain results we don't want to read and which
1297 * recent versions of gcc increasingly and annoyingly complain about.
1298 */
1299extern int shut_your_big_mouth_gcc_int;
1300
1301/* used from everywhere just to drain results we don't want to read and which
1302 * recent versions of gcc increasingly and annoyingly complain about.
1303 */
1304static inline void shut_your_big_mouth_gcc(int r)
1305{
1306 shut_your_big_mouth_gcc_int = r;
1307}
1308
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02001309/* same as strstr() but case-insensitive */
1310const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
1311
Willy Tarreauab813a42018-09-10 18:41:28 +02001312/* after increasing a pointer value, it can exceed the first buffer
1313 * size. This function transform the value of <ptr> according with
1314 * the expected position. <chunks> is an array of the one or two
Joseph Herlant32b83272018-11-15 11:58:28 -08001315 * available chunks. The first value is the start of the first chunk,
Willy Tarreauab813a42018-09-10 18:41:28 +02001316 * the second value if the end+1 of the first chunks. The third value
1317 * is NULL or the start of the second chunk and the fourth value is
1318 * the end+1 of the second chunk. The function returns 1 if does a
1319 * wrap, else returns 0.
1320 */
1321static inline int fix_pointer_if_wrap(const char **chunks, const char **ptr)
1322{
1323 if (*ptr < chunks[1])
1324 return 0;
1325 if (!chunks[2])
1326 return 0;
1327 *ptr = chunks[2] + ( *ptr - chunks[1] );
1328 return 1;
1329}
Willy Tarreaubb519c72014-01-28 23:04:39 +01001330
1331/************************* Composite address manipulation *********************
1332 * Composite addresses are simply unsigned long data in which the higher bits
1333 * represent a pointer, and the two lower bits are flags. There are several
1334 * places where we just want to associate one or two flags to a pointer (eg,
1335 * to type it), and these functions permit this. The pointer is necessarily a
1336 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
1337 * with the flags.
1338 *****************************************************************************/
1339
1340/* Masks the two lower bits of a composite address and converts it to a
1341 * pointer. This is used to mix some bits with some aligned pointers to
1342 * structs and to retrieve the original (32-bit aligned) pointer.
1343 */
1344static inline void *caddr_to_ptr(unsigned long caddr)
1345{
1346 return (void *)(caddr & ~3UL);
1347}
1348
1349/* Only retrieves the two lower bits of a composite address. This is used to mix
1350 * some bits with some aligned pointers to structs and to retrieve the original
1351 * data (2 bits).
1352 */
1353static inline unsigned int caddr_to_data(unsigned long caddr)
1354{
1355 return (caddr & 3UL);
1356}
1357
1358/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
1359 * from <data> to form a composite address. This is used to mix some bits with
1360 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
1361 * pointer.
1362 */
1363static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
1364{
1365 return (((unsigned long)ptr) & ~3UL) + (data & 3);
1366}
1367
1368/* sets the 2 bits of <data> in the <caddr> composite address */
1369static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
1370{
1371 return caddr | (data & 3);
1372}
1373
1374/* clears the 2 bits of <data> in the <caddr> composite address */
1375static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
1376{
1377 return caddr & ~(unsigned long)(data & 3);
1378}
1379
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02001380/* UTF-8 decoder status */
1381#define UTF8_CODE_OK 0x00
1382#define UTF8_CODE_OVERLONG 0x10
1383#define UTF8_CODE_INVRANGE 0x20
1384#define UTF8_CODE_BADSEQ 0x40
1385
1386unsigned char utf8_next(const char *s, int len, unsigned int *c);
1387
1388static inline unsigned char utf8_return_code(unsigned int code)
1389{
1390 return code & 0xf0;
1391}
1392
1393static inline unsigned char utf8_return_length(unsigned char code)
1394{
1395 return code & 0x0f;
1396}
1397
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001398/* Turns 64-bit value <a> from host byte order to network byte order.
1399 * The principle consists in letting the compiler detect we're playing
1400 * with a union and simplify most or all operations. The asm-optimized
1401 * htonl() version involving bswap (x86) / rev (arm) / other is a single
1402 * operation on little endian, or a NOP on big-endian. In both cases,
1403 * this lets the compiler "see" that we're rebuilding a 64-bit word from
1404 * two 32-bit quantities that fit into a 32-bit register. In big endian,
1405 * the whole code is optimized out. In little endian, with a decent compiler,
1406 * a few bswap and 2 shifts are left, which is the minimum acceptable.
1407 */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001408static inline unsigned long long my_htonll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001409{
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001410#if defined(__x86_64__)
Willy Tarreaudea7c5c2017-10-18 11:39:33 +02001411 __asm__ volatile("bswap %0" : "=r"(a) : "0"(a));
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001412 return a;
1413#else
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001414 union {
1415 struct {
1416 unsigned int w1;
1417 unsigned int w2;
1418 } by32;
1419 unsigned long long by64;
1420 } w = { .by64 = a };
1421 return ((unsigned long long)htonl(w.by32.w1) << 32) | htonl(w.by32.w2);
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001422#endif
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001423}
1424
1425/* Turns 64-bit value <a> from network byte order to host byte order. */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001426static inline unsigned long long my_ntohll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001427{
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001428 return my_htonll(a);
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001429}
1430
Willy Tarreaue6e49cf2015-04-29 17:13:35 +02001431/* returns a 64-bit a timestamp with the finest resolution available. The
1432 * unit is intentionally not specified. It's mostly used to compare dates.
1433 */
1434#if defined(__i386__) || defined(__x86_64__)
1435static inline unsigned long long rdtsc()
1436{
1437 unsigned int a, d;
1438 asm volatile("rdtsc" : "=a" (a), "=d" (d));
1439 return a + ((unsigned long long)d << 32);
1440}
1441#else
1442static inline unsigned long long rdtsc()
1443{
1444 struct timeval tv;
1445 gettimeofday(&tv, NULL);
1446 return tv.tv_sec * 1000000 + tv.tv_usec;
1447}
1448#endif
1449
Maxime de Roucydc887852016-05-13 23:52:54 +02001450/* append a copy of string <str> (in a wordlist) at the end of the list <li>
1451 * On failure : return 0 and <err> filled with an error message.
1452 * The caller is responsible for freeing the <err> and <str> copy
1453 * memory area using free()
1454 */
1455struct list;
1456int list_append_word(struct list *li, const char *str, char **err);
1457
Willy Tarreau83061a82018-07-13 11:56:34 +02001458int dump_text(struct buffer *out, const char *buf, int bsize);
1459int dump_binary(struct buffer *out, const char *buf, int bsize);
1460int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001461 int *line, int ptr);
Willy Tarreau37101052019-05-20 16:48:20 +02001462void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe);
1463int may_access(const void *ptr);
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001464
Hubert Verstraete2eae3a02016-06-28 22:41:00 +02001465/* same as realloc() except that ptr is also freed upon failure */
1466static inline void *my_realloc2(void *ptr, size_t size)
1467{
1468 void *ret;
1469
1470 ret = realloc(ptr, size);
1471 if (!ret && size)
1472 free(ptr);
1473 return ret;
1474}
1475
Frédéric Lécaille3b717162019-02-25 15:04:22 +01001476int parse_dotted_uints(const char *s, unsigned int **nums, size_t *sz);
1477
Willy Tarreau861c4ef2020-03-08 00:42:37 +01001478/* PRNG */
1479void ha_random_seed(const unsigned char *seed, size_t len);
1480void ha_random_jump96(uint32_t dist);
1481uint64_t ha_random64();
1482
1483static inline uint32_t ha_random32()
1484{
1485 return ha_random64() >> 32;
1486}
1487
1488static inline int32_t ha_random()
1489{
1490 return ha_random32() >> 1;
1491}
1492
Lukas Tribusdcbc5c52016-09-12 21:42:07 +00001493/* HAP_STRING() makes a string from a literal while HAP_XSTRING() first
1494 * evaluates the argument and is suited to pass macros.
1495 *
1496 * They allow macros like PCRE_MAJOR to be defined without quotes, which
1497 * is convenient for applications that want to test its value.
1498 */
1499#define HAP_STRING(...) #__VA_ARGS__
1500#define HAP_XSTRING(...) HAP_STRING(__VA_ARGS__)
1501
Willy Tarreau2dd0d472006-06-29 17:53:05 +02001502#endif /* _COMMON_STANDARD_H */