blob: 5afaad20fb0a8cd41846cce002a4897bf1a508f6 [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 Tarreaufe944602007-10-25 10:34:16 +020027#include <time.h>
Willy Tarreaue6e49cf2015-04-29 17:13:35 +020028#include <sys/time.h>
Willy Tarreau938b3032007-05-10 06:39:03 +020029#include <sys/types.h>
Willy Tarreaud50265a2012-09-04 14:18:33 +020030#include <sys/socket.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020031#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020032#include <netinet/in.h>
Willy Tarreau5b4dd682015-07-21 23:47:18 +020033#include <arpa/inet.h>
Thierry FOURNIERe059ec92014-03-17 12:01:13 +010034#include <common/chunk.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020035#include <common/config.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020036#include <common/namespace.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010037#include <eb32tree.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020038
William Lallemande7340ec2012-01-24 11:15:39 +010039#ifndef LLONG_MAX
40# define LLONG_MAX 9223372036854775807LL
41# define LLONG_MIN (-LLONG_MAX - 1LL)
42#endif
43
44#ifndef ULLONG_MAX
45# define ULLONG_MAX (LLONG_MAX * 2ULL + 1)
46#endif
47
Willy Tarreaua9db57e2013-01-18 11:29:29 +010048#ifndef LONGBITS
49#define LONGBITS ((unsigned int)sizeof(long) * 8)
50#endif
51
Thierry FOURNIER511e9472014-01-23 17:40:34 +010052/* size used for max length of decimal representation of long long int. */
53#define NB_LLMAX_STR (sizeof("-9223372036854775807")-1)
54
Willy Tarreau56adcf22012-12-23 18:00:29 +010055/* number of itoa_str entries */
56#define NB_ITOA_STR 10
William Lallemande7340ec2012-01-24 11:15:39 +010057
Willy Tarreau588297f2014-06-16 15:16:40 +020058/* maximum quoted string length (truncated above) */
59#define QSTR_SIZE 200
60#define NB_QSTR 10
61
Willy Tarreaubaaee002006-06-26 02:48:02 +020062/****** string-specific macros and functions ******/
63/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
64#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
65
66/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
67#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
68
69/* returns 1 only if only zero or one bit is set in X, which means that X is a
70 * power of 2, and 0 otherwise */
71#define POWEROF2(x) (((x) & ((x)-1)) == 0)
72
Willy Tarreau5b180202010-07-18 10:40:48 +020073/* operators to compare values. They're ordered that way so that the lowest bit
74 * serves as a negation for the test and contains all tests that are not equal.
75 */
76enum {
77 STD_OP_LE = 0, STD_OP_GT = 1,
78 STD_OP_EQ = 2, STD_OP_NE = 3,
79 STD_OP_GE = 4, STD_OP_LT = 5,
80};
81
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010082enum http_scheme {
83 SCH_HTTP,
84 SCH_HTTPS,
85};
86
87struct split_url {
88 enum http_scheme scheme;
89 const char *host;
90 int host_len;
91};
92
Willy Tarreau56adcf22012-12-23 18:00:29 +010093extern int itoa_idx; /* index of next itoa_str to use */
94
Willy Tarreau7d58a632007-01-13 23:06:06 +010095/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020096 * copies at most <size-1> chars from <src> to <dst>. Last char is always
97 * set to 0, unless <size> is 0. The number of chars copied is returned
98 * (excluding the terminating zero).
99 * This code has been optimized for size and speed : on x86, it's 45 bytes
100 * long, uses only registers, and consumes only 4 cycles per char.
101 */
102extern int strlcpy2(char *dst, const char *src, int size);
103
104/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200105 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200106 * the ascii representation for number 'n' in decimal.
107 */
Willy Tarreaue7239b52009-03-29 13:41:58 +0200108extern char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100109extern char *ultoa_r(unsigned long n, char *buffer, int size);
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200110extern char *lltoa_r(long long int n, char *buffer, int size);
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200111extern char *sltoa_r(long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200112extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200113static inline const char *ultoa(unsigned long n)
114{
115 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
116}
117
William Lallemande7340ec2012-01-24 11:15:39 +0100118/*
119 * unsigned long long ASCII representation
120 *
121 * return the last char '\0' or NULL if no enough
122 * space in dst
123 */
124char *ulltoa(unsigned long long n, char *dst, size_t size);
125
126
127/*
128 * unsigned long ASCII representation
129 *
130 * return the last char '\0' or NULL if no enough
131 * space in dst
132 */
133char *ultoa_o(unsigned long n, char *dst, size_t size);
134
135/*
136 * signed long ASCII representation
137 *
138 * return the last char '\0' or NULL if no enough
139 * space in dst
140 */
141char *ltoa_o(long int n, char *dst, size_t size);
142
143/*
144 * signed long long ASCII representation
145 *
146 * return the last char '\0' or NULL if no enough
147 * space in dst
148 */
149char *lltoa(long long n, char *dst, size_t size);
150
151/*
152 * write a ascii representation of a unsigned into dst,
153 * return a pointer to the last character
154 * Pad the ascii representation with '0', using size.
155 */
156char *utoa_pad(unsigned int n, char *dst, size_t size);
157
Willy Tarreaubaaee002006-06-26 02:48:02 +0200158/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200159 * This function simply returns a locally allocated string containing the ascii
160 * representation for number 'n' in decimal, unless n is 0 in which case it
161 * returns the alternate string (or an empty string if the alternate string is
162 * NULL). It use is intended for limits reported in reports, where it's
163 * desirable not to display anything if there is no limit. Warning! it shares
164 * the same vector as ultoa_r().
165 */
166extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
167
Willy Tarreau56adcf22012-12-23 18:00:29 +0100168/* returns a locally allocated string containing the ASCII representation of
169 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
170 * function call (eg: printf), shared with the other similar functions making
171 * use of itoa_str[].
172 */
173static inline const char *U2A(unsigned long n)
174{
175 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
176 if (++itoa_idx >= NB_ITOA_STR)
177 itoa_idx = 0;
178 return ret;
179}
180
181/* returns a locally allocated string containing the HTML representation of
182 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
183 * function call (eg: printf), shared with the other similar functions making
184 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200185 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100186static inline const char *U2H(unsigned long long n)
187{
188 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
189 if (++itoa_idx >= NB_ITOA_STR)
190 itoa_idx = 0;
191 return ret;
192}
193
194/* returns a locally allocated string containing the HTML representation of
195 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
196 * function call (eg: printf), shared with the other similar functions making
197 * use of itoa_str[].
198 */
199static inline const char *LIM2A(unsigned long n, const char *alt)
200{
201 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
202 if (++itoa_idx >= NB_ITOA_STR)
203 itoa_idx = 0;
204 return ret;
205}
Willy Tarreau91092e52007-10-25 16:58:42 +0200206
Willy Tarreau588297f2014-06-16 15:16:40 +0200207/* returns a locally allocated string containing the quoted encoding of the
208 * input string. The output may be truncated to QSTR_SIZE chars, but it is
209 * guaranteed that the string will always be properly terminated. Quotes are
210 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
211 * always be at least 4 chars.
212 */
213const char *qstr(const char *str);
214
215/* returns <str> or its quote-encoded equivalent if it contains at least one
216 * quote or a comma. This is aimed at build CSV-compatible strings.
217 */
218static inline const char *cstr(const char *str)
219{
220 const char *p = str;
221
222 while (*p) {
223 if (*p == ',' || *p == '"')
224 return qstr(str);
225 p++;
226 }
227 return str;
228}
229
Willy Tarreau91092e52007-10-25 16:58:42 +0200230/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200231 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
232 */
233extern int ishex(char s);
234
235/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100236 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200237 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100238 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200239static inline int hex2i(int c)
240{
Willy Tarreau0161d622013-04-02 01:26:55 +0200241 if (unlikely((unsigned char)(c -= '0') > 9)) {
242 if (likely((unsigned char)(c -= 'A' - '0') > 5 &&
243 (unsigned char)(c -= 'a' - 'A') > 5))
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200244 c = -11;
245 c += 10;
246 }
247 return c;
248}
249
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100250/* rounds <i> down to the closest value having max 2 digits */
251unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100252
253/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100254 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
255 * invalid character is found, a pointer to it is returned. If everything is
256 * fine, NULL is returned.
257 */
258extern const char *invalid_char(const char *name);
259
260/*
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200261 * Checks <domainname> for invalid characters. Valid chars are [A-Za-z0-9_.-].
262 * If an invalid character is found, a pointer to it is returned.
263 * If everything is fine, NULL is returned.
264 */
265extern const char *invalid_domainchar(const char *name);
266
267/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100268 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200269 * port range consisting in two integers. The low and high end are always set
270 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100271 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200272 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100273 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
274 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
275 * address wants to ignore port, it must be terminated by a trailing colon (':').
276 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
277 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100278 * If <pfx> is non-null, it is used as a string prefix before any path-based
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200279 * address (typically the path to a unix socket). If use_dns is not true,
280 * the funtion cannot accept the DNS resolution.
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200281 */
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200282struct sockaddr_storage *str2sa_range(const char *str, int *low, int *high, char **err, const char *pfx, char **fqdn, int use_dns);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200283
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100284/* converts <str> to a struct in_addr containing a network mask. It can be
285 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
286 * if the conversion succeeds otherwise non-zero.
287 */
288int str2mask(const char *str, struct in_addr *mask);
289
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100290/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
291 * succeeds otherwise non-zero.
292 */
293int cidr2dotted(int cidr, struct in_addr *mask);
294
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200295/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200296 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200297 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
298 * is optionnal and either in the dotted or CIDR notation.
299 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
300 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100301int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200302
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100303/* str2ip and str2ip2:
304 *
305 * converts <str> to a struct sockaddr_storage* provided by the caller. The
306 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
307 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
308 * the function tries to guess the address family from the syntax. If the
309 * family is forced and the format doesn't match, an error is returned. The
310 * string is assumed to contain only an address, no port. The address can be a
311 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
312 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
313 * The return address will only have the address family and the address set,
314 * all other fields remain zero. The string is not supposed to be modified.
315 * The IPv6 '::' address is IN6ADDR_ANY.
316 *
317 * str2ip2:
318 *
319 * If <resolve> is set, this function try to resolve DNS, otherwise, it returns
320 * NULL result.
321 */
322struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve);
323static inline struct sockaddr_storage *str2ip(const char *str, struct sockaddr_storage *sa)
324{
325 return str2ip2(str, sa, 1);
326}
327
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100328/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200329 * converts <str> to two struct in6_addr* which must be pre-allocated.
330 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
331 * is an optionnal number of bits (128 being the default).
332 * Returns 1 if OK, 0 if error.
333 */
334int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
335
336/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200337 * Parse IP address found in url.
338 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100339int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200340
341/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100342 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100343 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100344int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100345
Willy Tarreau631f01c2011-09-05 00:36:48 +0200346/* Tries to convert a sockaddr_storage address to text form. Upon success, the
347 * address family is returned so that it's easy for the caller to adapt to the
348 * output format. Zero is returned if the address family is not supported. -1
349 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
350 * supported.
351 */
352int addr_to_str(struct sockaddr_storage *addr, char *str, int size);
353
Simon Horman75ab8bd2014-06-16 09:39:41 +0900354/* Tries to convert a sockaddr_storage port to text form. Upon success, the
355 * address family is returned so that it's easy for the caller to adapt to the
356 * output format. Zero is returned if the address family is not supported. -1
357 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
358 * supported.
359 */
360int port_to_str(struct sockaddr_storage *addr, char *str, int size);
361
Willy Tarreau16e01562016-08-09 16:46:18 +0200362/* check if the given address is local to the system or not. It will return
363 * -1 when it's not possible to know, 0 when the address is not local, 1 when
364 * it is. We don't want to iterate over all interfaces for this (and it is not
365 * portable). So instead we try to bind in UDP to this address on a free non
366 * privileged port and to connect to the same address, port 0 (connect doesn't
367 * care). If it succeeds, we own the address. Note that non-inet addresses are
368 * considered local since they're most likely AF_UNIX.
369 */
370int addr_is_local(const struct netns_entry *ns,
371 const struct sockaddr_storage *orig);
372
Willy Tarreaubaaee002006-06-26 02:48:02 +0200373/* will try to encode the string <string> replacing all characters tagged in
374 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
375 * prefixed by <escape>, and will store the result between <start> (included)
376 * and <stop> (excluded), and will always terminate the string with a '\0'
377 * before <stop>. The position of the '\0' is returned if the conversion
378 * completes. If bytes are missing between <start> and <stop>, then the
379 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
380 * cannot even be stored so we return <start> without writing the 0.
381 * The input string must also be zero-terminated.
382 */
383extern const char hextab[];
384char *encode_string(char *start, char *stop,
385 const char escape, const fd_set *map,
386 const char *string);
387
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100388/*
389 * Same behavior, except that it encodes chunk <chunk> instead of a string.
390 */
391char *encode_chunk(char *start, char *stop,
392 const char escape, const fd_set *map,
393 const struct chunk *chunk);
394
Dragan Dosen0edd1092016-02-12 13:23:02 +0100395/*
396 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200397 * character. The input <string> must be zero-terminated. The result will
398 * be stored between <start> (included) and <stop> (excluded). This
399 * function will always try to terminate the resulting string with a '\0'
400 * before <stop>, and will return its position if the conversion
401 * completes.
402 */
403char *escape_string(char *start, char *stop,
404 const char escape, const fd_set *map,
405 const char *string);
406
407/*
408 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +0100409 * character. <chunk> contains the input to be escaped. The result will be
410 * stored between <start> (included) and <stop> (excluded). The function
411 * will always try to terminate the resulting string with a '\0' before
412 * <stop>, and will return its position if the conversion completes.
413 */
414char *escape_chunk(char *start, char *stop,
415 const char escape, const fd_set *map,
416 const struct chunk *chunk);
417
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100418
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200419/* Check a string for using it in a CSV output format. If the string contains
420 * one of the following four char <">, <,>, CR or LF, the string is
421 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
422 * <str> is the input string to be escaped. The function assumes that
423 * the input string is null-terminated.
424 *
425 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +0100426 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200427 * format.
428 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100429 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200430 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100431 * If <quote> is 1, the converter puts the quotes only if any character is
432 * escaped. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200433 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100434 * <output> is a struct chunk used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200435 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100436 * The function returns the converted string on its output. If an error
437 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200438 * for using the function directly as printf() argument.
439 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100440 * If the output buffer is too short to contain the input string, the result
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200441 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +0100442 *
443 * This function appends the encoding to the existing output chunk. Please
444 * use csv_enc() instead if you want to replace the output chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200445 */
Willy Tarreau898529b2016-01-06 18:07:04 +0100446const char *csv_enc_append(const char *str, int quote, struct chunk *output);
447
448/* same as above but the output chunk is reset first */
449static inline const char *csv_enc(const char *str, int quote, struct chunk *output)
450{
451 chunk_reset(output);
452 return csv_enc_append(str, quote, output);
453}
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200454
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200455/* Decode an URL-encoded string in-place. The resulting string might
456 * be shorter. If some forbidden characters are found, the conversion is
457 * aborted, the string is truncated before the issue and non-zero is returned,
458 * otherwise the operation returns non-zero indicating success.
459 */
460int url_decode(char *string);
461
Willy Tarreau6911fa42007-03-04 18:06:08 +0100462/* This one is 6 times faster than strtoul() on athlon, but does
463 * no check at all.
464 */
465static inline unsigned int __str2ui(const char *s)
466{
467 unsigned int i = 0;
468 while (*s) {
469 i = i * 10 - '0';
470 i += (unsigned char)*s++;
471 }
472 return i;
473}
474
475/* This one is 5 times faster than strtoul() on athlon with checks.
476 * It returns the value of the number composed of all valid digits read.
477 */
478static inline unsigned int __str2uic(const char *s)
479{
480 unsigned int i = 0;
481 unsigned int j;
482 while (1) {
483 j = (*s++) - '0';
484 if (j > 9)
485 break;
486 i *= 10;
487 i += j;
488 }
489 return i;
490}
491
492/* This one is 28 times faster than strtoul() on athlon, but does
493 * no check at all!
494 */
495static inline unsigned int __strl2ui(const char *s, int len)
496{
497 unsigned int i = 0;
498 while (len-- > 0) {
499 i = i * 10 - '0';
500 i += (unsigned char)*s++;
501 }
502 return i;
503}
504
505/* This one is 7 times faster than strtoul() on athlon with checks.
506 * It returns the value of the number composed of all valid digits read.
507 */
508static inline unsigned int __strl2uic(const char *s, int len)
509{
510 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200511 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100512
513 while (len-- > 0) {
514 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200515 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100516 if (j > 9)
517 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200518 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100519 }
520 return i;
521}
522
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200523/* This function reads an unsigned integer from the string pointed to by <s>
524 * and returns it. The <s> pointer is adjusted to point to the first unread
525 * char. The function automatically stops at <end>.
526 */
527static inline unsigned int __read_uint(const char **s, const char *end)
528{
529 const char *ptr = *s;
530 unsigned int i = 0;
531 unsigned int j, k;
532
533 while (ptr < end) {
534 j = *ptr - '0';
535 k = i * 10;
536 if (j > 9)
537 break;
538 i = k + j;
539 ptr++;
540 }
541 *s = ptr;
542 return i;
543}
544
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200545unsigned long long int read_uint64(const char **s, const char *end);
546long long int read_int64(const char **s, const char *end);
547
Willy Tarreau6911fa42007-03-04 18:06:08 +0100548extern unsigned int str2ui(const char *s);
549extern unsigned int str2uic(const char *s);
550extern unsigned int strl2ui(const char *s, int len);
551extern unsigned int strl2uic(const char *s, int len);
552extern int strl2ic(const char *s, int len);
553extern int strl2irc(const char *s, int len, int *ret);
554extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100555extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200556extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200557unsigned int inetaddr_host(const char *text);
558unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200559unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100560
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200561static inline char *cut_crlf(char *s) {
562
Simon Horman5269cfb2013-02-13 17:48:00 +0900563 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200564 char *p = s++;
565
566 if (!*p)
567 return p;
568 }
569
Simon Horman5269cfb2013-02-13 17:48:00 +0900570 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200571
572 return s;
573}
574
575static inline char *ltrim(char *s, char c) {
576
577 if (c)
578 while (*s == c)
579 s++;
580
581 return s;
582}
583
584static inline char *rtrim(char *s, char c) {
585
586 char *p = s + strlen(s);
587
588 while (p-- > s)
589 if (*p == c)
590 *p = '\0';
591 else
592 break;
593
594 return s;
595}
596
597static inline char *alltrim(char *s, char c) {
598
599 rtrim(s, c);
600
601 return ltrim(s, c);
602}
603
Willy Tarreaufe944602007-10-25 10:34:16 +0200604/* This function converts the time_t value <now> into a broken out struct tm
605 * which must be allocated by the caller. It is highly recommended to use this
606 * function intead of localtime() because that one requires a time_t* which
607 * is not always compatible with tv_sec depending on OS/hardware combinations.
608 */
609static inline void get_localtime(const time_t now, struct tm *tm)
610{
611 localtime_r(&now, tm);
612}
613
Emeric Brun3a058f32009-06-30 18:26:00 +0200614/* This function converts the time_t value <now> into a broken out struct tm
615 * which must be allocated by the caller. It is highly recommended to use this
616 * function intead of gmtime() because that one requires a time_t* which
617 * is not always compatible with tv_sec depending on OS/hardware combinations.
618 */
619static inline void get_gmtime(const time_t now, struct tm *tm)
620{
621 gmtime_r(&now, tm);
622}
623
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100624/* This function parses a time value optionally followed by a unit suffix among
625 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
626 * expected by the caller. The computation does its best to avoid overflows.
627 * The value is returned in <ret> if everything is fine, and a NULL is returned
628 * by the function. In case of error, a pointer to the error is returned and
629 * <ret> is left untouched.
630 */
631extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100632extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100633
634/* unit flags to pass to parse_time_err */
635#define TIME_UNIT_US 0x0000
636#define TIME_UNIT_MS 0x0001
637#define TIME_UNIT_S 0x0002
638#define TIME_UNIT_MIN 0x0003
639#define TIME_UNIT_HOUR 0x0004
640#define TIME_UNIT_DAY 0x0005
641#define TIME_UNIT_MASK 0x0007
642
William Lallemand421f5b52012-02-06 18:15:57 +0100643#define SEC 1
644#define MINUTE (60 * SEC)
645#define HOUR (60 * MINUTE)
646#define DAY (24 * HOUR)
647
Willy Tarreau7f062c42009-03-05 18:43:00 +0100648/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
649 * This is used to compute fixed ratios by setting one of the operands to
650 * (2^32*ratio).
651 */
652static inline unsigned int mul32hi(unsigned int a, unsigned int b)
653{
654 return ((unsigned long long)a * b) >> 32;
655}
656
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200657/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
658 * function when you know for sure that the result fits in 32 bits, because
659 * it is optimal on x86 and on 64bit processors.
660 */
661static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
662{
663 unsigned int result;
664#ifdef __i386__
665 asm("divl %2"
666 : "=a" (result)
667 : "A"(o1), "rm"(o2));
668#else
669 result = o1 / o2;
670#endif
671 return result;
672}
673
David Carliere6c39412015-07-02 07:00:17 +0000674/* Simple popcountl implementation. It returns the number of ones in a word */
675static inline unsigned int my_popcountl(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100676{
677 unsigned int cnt;
678 for (cnt = 0; a; a >>= 1) {
679 if (a & 1)
680 cnt++;
681 }
682 return cnt;
683}
684
David Carliere6c39412015-07-02 07:00:17 +0000685/* Build a word with the <bits> lower bits set (reverse of my_popcountl) */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100686static inline unsigned long nbits(int bits)
687{
688 if (--bits < 0)
689 return 0;
690 else
691 return (2UL << bits) - 1;
692}
693
Willy Tarreau126d4062013-12-03 17:50:47 +0100694/*
695 * Parse binary string written in hexadecimal (source) and store the decoded
696 * result into binstr and set binstrlen to the lengh of binstr. Memory for
697 * binstr is allocated by the function. In case of error, returns 0 with an
698 * error message in err.
699 */
700int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
701
Willy Tarreau946ba592009-05-10 15:41:18 +0200702/* copies at most <n> characters from <src> and always terminates with '\0' */
703char *my_strndup(const char *src, int n);
704
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200705/*
706 * search needle in haystack
707 * returns the pointer if found, returns NULL otherwise
708 */
709const void *my_memmem(const void *, size_t, const void *, size_t);
710
Willy Tarreau482b00d2009-10-04 22:48:42 +0200711/* This function returns the first unused key greater than or equal to <key> in
712 * ID tree <root>. Zero is returned if no place is found.
713 */
714unsigned int get_next_id(struct eb_root *root, unsigned int key);
715
Willy Tarreau348238b2010-01-18 15:05:57 +0100716/* This function compares a sample word possibly followed by blanks to another
717 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
718 * otherwise zero. This intends to be used when checking HTTP headers for some
719 * values.
720 */
721int word_match(const char *sample, int slen, const char *word, int wlen);
722
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200723/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
724 * or the number of chars read in case of success.
725 */
726int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +0100727int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200728
Willy Tarreauacf95772010-06-14 19:09:21 +0200729/* To be used to quote config arg positions. Returns the string at <ptr>
730 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
731 * if ptr is NULL or empty. The string is locally allocated.
732 */
733const char *quote_arg(const char *ptr);
734
Willy Tarreau5b180202010-07-18 10:40:48 +0200735/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
736int get_std_op(const char *str);
737
Willy Tarreau4c14eaa2010-11-24 14:01:45 +0100738/* hash a 32-bit integer to another 32-bit integer */
739extern unsigned int full_hash(unsigned int a);
740static inline unsigned int __full_hash(unsigned int a)
741{
742 /* This function is one of Bob Jenkins' full avalanche hashing
743 * functions, which when provides quite a good distribution for little
744 * input variations. The result is quite suited to fit over a 32-bit
745 * space with enough variations so that a randomly picked number falls
746 * equally before any server position.
747 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
748 */
749 a = (a+0x7ed55d16) + (a<<12);
750 a = (a^0xc761c23c) ^ (a>>19);
751 a = (a+0x165667b1) + (a<<5);
752 a = (a+0xd3a2646c) ^ (a<<9);
753 a = (a+0xfd7046c5) + (a<<3);
754 a = (a^0xb55a4f09) ^ (a>>16);
755
756 /* ensure values are better spread all around the tree by multiplying
757 * by a large prime close to 3/4 of the tree.
758 */
759 return a * 3221225473U;
760}
761
Willy Tarreau422a0a52012-10-26 19:47:23 +0200762/* sets the address family to AF_UNSPEC so that is_addr() does not match */
763static inline void clear_addr(struct sockaddr_storage *addr)
764{
765 addr->ss_family = AF_UNSPEC;
766}
767
David du Colombier6f5ccb12011-03-10 22:26:24 +0100768/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
769 * otherwise zero.
770 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200771static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +0100772{
773 int i;
774
775 switch (addr->ss_family) {
776 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +0100777 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100778 case AF_INET6:
779 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
780 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
781 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
782 }
783 return 0;
784}
785
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200786/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
787 * or is a unix address, otherwise returns zero.
788 */
789static inline int is_addr(const struct sockaddr_storage *addr)
790{
791 if (addr->ss_family == AF_UNIX)
792 return 1;
793 else
794 return is_inet_addr(addr);
795}
796
David du Colombier11bcb6c2011-03-24 12:23:00 +0100797/* returns port in network byte order */
798static inline int get_net_port(struct sockaddr_storage *addr)
799{
800 switch (addr->ss_family) {
801 case AF_INET:
802 return ((struct sockaddr_in *)addr)->sin_port;
803 case AF_INET6:
804 return ((struct sockaddr_in6 *)addr)->sin6_port;
805 }
806 return 0;
807}
808
809/* returns port in host byte order */
810static inline int get_host_port(struct sockaddr_storage *addr)
811{
812 switch (addr->ss_family) {
813 case AF_INET:
814 return ntohs(((struct sockaddr_in *)addr)->sin_port);
815 case AF_INET6:
816 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
817 }
818 return 0;
819}
820
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +0200821/* returns address len for <addr>'s family, 0 for unknown families */
822static inline int get_addr_len(const struct sockaddr_storage *addr)
823{
824 switch (addr->ss_family) {
825 case AF_INET:
826 return sizeof(struct sockaddr_in);
827 case AF_INET6:
828 return sizeof(struct sockaddr_in6);
829 case AF_UNIX:
830 return sizeof(struct sockaddr_un);
831 }
832 return 0;
833}
834
David du Colombier11bcb6c2011-03-24 12:23:00 +0100835/* set port in host byte order */
836static inline int set_net_port(struct sockaddr_storage *addr, int port)
837{
838 switch (addr->ss_family) {
839 case AF_INET:
840 ((struct sockaddr_in *)addr)->sin_port = port;
841 case AF_INET6:
842 ((struct sockaddr_in6 *)addr)->sin6_port = port;
843 }
844 return 0;
845}
846
847/* set port in network byte order */
848static inline int set_host_port(struct sockaddr_storage *addr, int port)
849{
850 switch (addr->ss_family) {
851 case AF_INET:
852 ((struct sockaddr_in *)addr)->sin_port = htons(port);
853 case AF_INET6:
854 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
855 }
856 return 0;
857}
858
Thierry Fournier70473a52016-02-17 17:12:14 +0100859/* Convert mask from bit length form to in_addr form.
860 * This function never fails.
861 */
862void len2mask4(int len, struct in_addr *addr);
863
864/* Convert mask from bit length form to in6_addr form.
865 * This function never fails.
866 */
867void len2mask6(int len, struct in6_addr *addr);
868
David du Colombier4f92d322011-03-24 11:09:31 +0100869/* Return true if IPv4 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +0200870extern 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 +0100871
872/* Return true if IPv6 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +0200873extern 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 +0100874
875/* Map IPv4 adress on IPv6 address, as specified in RFC 3513. */
876extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
877
878/* Map IPv6 adress on IPv4 address, as specified in RFC 3513.
879 * Return true if conversion is possible and false otherwise.
880 */
881extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
882
William Lallemand421f5b52012-02-06 18:15:57 +0100883char *human_time(int t, short hz_div);
884
885extern const char *monthname[];
886
887/* date2str_log: write a date in the format :
888 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
889 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
890 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
891 *
892 * without using sprintf. return a pointer to the last char written (\0) or
893 * NULL if there isn't enough space.
894 */
895char *date2str_log(char *dest, struct tm *tm, struct timeval *date, size_t size);
896
Benoit GARNIERb413c2a2016-03-27 11:08:03 +0200897/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +0200898 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +0200899 * The string returned has the same format as returned by strftime(... "%z", tm).
900 * Offsets are kept in an internal cache for better performances.
901 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +0200902const char *get_gmt_offset(time_t t, struct tm *tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +0200903
William Lallemand421f5b52012-02-06 18:15:57 +0100904/* gmt2str_log: write a date in the format :
905 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
906 * return a pointer to the last char written (\0) or
907 * NULL if there isn't enough space.
908 */
909char *gmt2str_log(char *dst, struct tm *tm, size_t size);
910
Yuxans Yao4e25b012012-10-19 10:36:09 +0800911/* localdate2str_log: write a date in the format :
912 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +0200913 * Both t and tm must represent the same time.
Yuxans Yao4e25b012012-10-19 10:36:09 +0800914 * return a pointer to the last char written (\0) or
915 * NULL if there isn't enough space.
916 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +0200917char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size);
Yuxans Yao4e25b012012-10-19 10:36:09 +0800918
Thierry Fournier93127942016-01-20 18:49:45 +0100919/* These 3 functions parses date string and fills the
920 * corresponding broken-down time in <tm>. In succes case,
921 * it returns 1, otherwise, it returns 0.
922 */
923int parse_http_date(const char *date, int len, struct tm *tm);
924int parse_imf_date(const char *date, int len, struct tm *tm);
925int parse_rfc850_date(const char *date, int len, struct tm *tm);
926int parse_asctime_date(const char *date, int len, struct tm *tm);
927
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200928/* Dynamically allocates a string of the proper length to hold the formatted
929 * output. NULL is returned on error. The caller is responsible for freeing the
930 * memory area using free(). The resulting string is returned in <out> if the
931 * pointer is not NULL. A previous version of <out> might be used to build the
932 * new string, and it will be freed before returning if it is not NULL, which
933 * makes it possible to build complex strings from iterative calls without
934 * having to care about freeing intermediate values, as in the example below :
935 *
936 * memprintf(&err, "invalid argument: '%s'", arg);
937 * ...
938 * memprintf(&err, "parser said : <%s>\n", *err);
939 * ...
940 * free(*err);
941 *
942 * This means that <err> must be initialized to NULL before first invocation.
943 * The return value also holds the allocated string, which eases error checking
944 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200945 * passed instead and it will be ignored. The returned message will then also
946 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200947 *
948 * It is also convenient to use it without any free except the last one :
949 * err = NULL;
950 * if (!fct1(err)) report(*err);
951 * if (!fct2(err)) report(*err);
952 * if (!fct3(err)) report(*err);
953 * free(*err);
954 */
955char *memprintf(char **out, const char *format, ...)
956 __attribute__ ((format(printf, 2, 3)));
957
Willy Tarreau21c705b2012-09-14 11:40:36 +0200958/* Used to add <level> spaces before each line of <out>, unless there is only one line.
959 * The input argument is automatically freed and reassigned. The result will have to be
960 * freed by the caller.
961 * Example of use :
962 * parse(cmd, &err); (callee: memprintf(&err, ...))
963 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
964 * free(err);
965 */
966char *indent_msg(char **out, int level);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200967
Willy Tarreaudad36a32013-03-11 01:20:04 +0100968/* Convert occurrences of environment variables in the input string to their
969 * corresponding value. A variable is identified as a series of alphanumeric
970 * characters or underscores following a '$' sign. The <in> string must be
971 * free()able. NULL returns NULL. The resulting string might be reallocated if
972 * some expansion is made.
973 */
974char *env_expand(char *in);
975
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200976/* debugging macro to emit messages using write() on fd #-1 so that strace sees
977 * them.
978 */
979#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
980
Willy Tarreau89efaed2013-12-13 15:14:55 +0100981/* used from everywhere just to drain results we don't want to read and which
982 * recent versions of gcc increasingly and annoyingly complain about.
983 */
984extern int shut_your_big_mouth_gcc_int;
985
986/* used from everywhere just to drain results we don't want to read and which
987 * recent versions of gcc increasingly and annoyingly complain about.
988 */
989static inline void shut_your_big_mouth_gcc(int r)
990{
991 shut_your_big_mouth_gcc_int = r;
992}
993
de Lafond Guillaume88c278f2013-04-15 19:27:10 +0200994/* same as strstr() but case-insensitive */
995const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
996
Willy Tarreaubb519c72014-01-28 23:04:39 +0100997
998/************************* Composite address manipulation *********************
999 * Composite addresses are simply unsigned long data in which the higher bits
1000 * represent a pointer, and the two lower bits are flags. There are several
1001 * places where we just want to associate one or two flags to a pointer (eg,
1002 * to type it), and these functions permit this. The pointer is necessarily a
1003 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
1004 * with the flags.
1005 *****************************************************************************/
1006
1007/* Masks the two lower bits of a composite address and converts it to a
1008 * pointer. This is used to mix some bits with some aligned pointers to
1009 * structs and to retrieve the original (32-bit aligned) pointer.
1010 */
1011static inline void *caddr_to_ptr(unsigned long caddr)
1012{
1013 return (void *)(caddr & ~3UL);
1014}
1015
1016/* Only retrieves the two lower bits of a composite address. This is used to mix
1017 * some bits with some aligned pointers to structs and to retrieve the original
1018 * data (2 bits).
1019 */
1020static inline unsigned int caddr_to_data(unsigned long caddr)
1021{
1022 return (caddr & 3UL);
1023}
1024
1025/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
1026 * from <data> to form a composite address. This is used to mix some bits with
1027 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
1028 * pointer.
1029 */
1030static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
1031{
1032 return (((unsigned long)ptr) & ~3UL) + (data & 3);
1033}
1034
1035/* sets the 2 bits of <data> in the <caddr> composite address */
1036static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
1037{
1038 return caddr | (data & 3);
1039}
1040
1041/* clears the 2 bits of <data> in the <caddr> composite address */
1042static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
1043{
1044 return caddr & ~(unsigned long)(data & 3);
1045}
1046
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02001047/* UTF-8 decoder status */
1048#define UTF8_CODE_OK 0x00
1049#define UTF8_CODE_OVERLONG 0x10
1050#define UTF8_CODE_INVRANGE 0x20
1051#define UTF8_CODE_BADSEQ 0x40
1052
1053unsigned char utf8_next(const char *s, int len, unsigned int *c);
1054
1055static inline unsigned char utf8_return_code(unsigned int code)
1056{
1057 return code & 0xf0;
1058}
1059
1060static inline unsigned char utf8_return_length(unsigned char code)
1061{
1062 return code & 0x0f;
1063}
1064
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001065/* Turns 64-bit value <a> from host byte order to network byte order.
1066 * The principle consists in letting the compiler detect we're playing
1067 * with a union and simplify most or all operations. The asm-optimized
1068 * htonl() version involving bswap (x86) / rev (arm) / other is a single
1069 * operation on little endian, or a NOP on big-endian. In both cases,
1070 * this lets the compiler "see" that we're rebuilding a 64-bit word from
1071 * two 32-bit quantities that fit into a 32-bit register. In big endian,
1072 * the whole code is optimized out. In little endian, with a decent compiler,
1073 * a few bswap and 2 shifts are left, which is the minimum acceptable.
1074 */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001075static inline unsigned long long my_htonll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001076{
1077 union {
1078 struct {
1079 unsigned int w1;
1080 unsigned int w2;
1081 } by32;
1082 unsigned long long by64;
1083 } w = { .by64 = a };
1084 return ((unsigned long long)htonl(w.by32.w1) << 32) | htonl(w.by32.w2);
1085}
1086
1087/* Turns 64-bit value <a> from network byte order to host byte order. */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001088static inline unsigned long long my_ntohll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001089{
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001090 return my_htonll(a);
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001091}
1092
Willy Tarreaue6e49cf2015-04-29 17:13:35 +02001093/* returns a 64-bit a timestamp with the finest resolution available. The
1094 * unit is intentionally not specified. It's mostly used to compare dates.
1095 */
1096#if defined(__i386__) || defined(__x86_64__)
1097static inline unsigned long long rdtsc()
1098{
1099 unsigned int a, d;
1100 asm volatile("rdtsc" : "=a" (a), "=d" (d));
1101 return a + ((unsigned long long)d << 32);
1102}
1103#else
1104static inline unsigned long long rdtsc()
1105{
1106 struct timeval tv;
1107 gettimeofday(&tv, NULL);
1108 return tv.tv_sec * 1000000 + tv.tv_usec;
1109}
1110#endif
1111
Maxime de Roucydc887852016-05-13 23:52:54 +02001112/* append a copy of string <str> (in a wordlist) at the end of the list <li>
1113 * On failure : return 0 and <err> filled with an error message.
1114 * The caller is responsible for freeing the <err> and <str> copy
1115 * memory area using free()
1116 */
1117struct list;
1118int list_append_word(struct list *li, const char *str, char **err);
1119
Hubert Verstraete2eae3a02016-06-28 22:41:00 +02001120/* same as realloc() except that ptr is also freed upon failure */
1121static inline void *my_realloc2(void *ptr, size_t size)
1122{
1123 void *ret;
1124
1125 ret = realloc(ptr, size);
1126 if (!ret && size)
1127 free(ptr);
1128 return ret;
1129}
1130
Willy Tarreau2dd0d472006-06-29 17:53:05 +02001131#endif /* _COMMON_STANDARD_H */