blob: 759d0a11ca68d47b6a608773d2affec1beb95897 [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>
Thierry FOURNIERe059ec92014-03-17 12:01:13 +010033#include <common/chunk.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020034#include <common/config.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010035#include <eb32tree.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020036
William Lallemande7340ec2012-01-24 11:15:39 +010037#ifndef LLONG_MAX
38# define LLONG_MAX 9223372036854775807LL
39# define LLONG_MIN (-LLONG_MAX - 1LL)
40#endif
41
42#ifndef ULLONG_MAX
43# define ULLONG_MAX (LLONG_MAX * 2ULL + 1)
44#endif
45
Willy Tarreaua9db57e2013-01-18 11:29:29 +010046#ifndef LONGBITS
47#define LONGBITS ((unsigned int)sizeof(long) * 8)
48#endif
49
Thierry FOURNIER511e9472014-01-23 17:40:34 +010050/* size used for max length of decimal representation of long long int. */
51#define NB_LLMAX_STR (sizeof("-9223372036854775807")-1)
52
Willy Tarreau56adcf22012-12-23 18:00:29 +010053/* number of itoa_str entries */
54#define NB_ITOA_STR 10
William Lallemande7340ec2012-01-24 11:15:39 +010055
Willy Tarreau588297f2014-06-16 15:16:40 +020056/* maximum quoted string length (truncated above) */
57#define QSTR_SIZE 200
58#define NB_QSTR 10
59
Willy Tarreaubaaee002006-06-26 02:48:02 +020060/****** string-specific macros and functions ******/
61/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
62#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
63
64/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
65#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
66
67/* returns 1 only if only zero or one bit is set in X, which means that X is a
68 * power of 2, and 0 otherwise */
69#define POWEROF2(x) (((x) & ((x)-1)) == 0)
70
Willy Tarreau5b180202010-07-18 10:40:48 +020071/* operators to compare values. They're ordered that way so that the lowest bit
72 * serves as a negation for the test and contains all tests that are not equal.
73 */
74enum {
75 STD_OP_LE = 0, STD_OP_GT = 1,
76 STD_OP_EQ = 2, STD_OP_NE = 3,
77 STD_OP_GE = 4, STD_OP_LT = 5,
78};
79
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010080enum http_scheme {
81 SCH_HTTP,
82 SCH_HTTPS,
83};
84
85struct split_url {
86 enum http_scheme scheme;
87 const char *host;
88 int host_len;
89};
90
Willy Tarreau56adcf22012-12-23 18:00:29 +010091extern int itoa_idx; /* index of next itoa_str to use */
92
Willy Tarreau7d58a632007-01-13 23:06:06 +010093/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020094 * copies at most <size-1> chars from <src> to <dst>. Last char is always
95 * set to 0, unless <size> is 0. The number of chars copied is returned
96 * (excluding the terminating zero).
97 * This code has been optimized for size and speed : on x86, it's 45 bytes
98 * long, uses only registers, and consumes only 4 cycles per char.
99 */
100extern int strlcpy2(char *dst, const char *src, int size);
101
102/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200103 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200104 * the ascii representation for number 'n' in decimal.
105 */
Willy Tarreaue7239b52009-03-29 13:41:58 +0200106extern char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100107extern char *ultoa_r(unsigned long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200108extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200109static inline const char *ultoa(unsigned long n)
110{
111 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
112}
113
William Lallemande7340ec2012-01-24 11:15:39 +0100114/*
115 * unsigned long long ASCII representation
116 *
117 * return the last char '\0' or NULL if no enough
118 * space in dst
119 */
120char *ulltoa(unsigned long long n, char *dst, size_t size);
121
122
123/*
124 * unsigned long ASCII representation
125 *
126 * return the last char '\0' or NULL if no enough
127 * space in dst
128 */
129char *ultoa_o(unsigned long n, char *dst, size_t size);
130
131/*
132 * signed long ASCII representation
133 *
134 * return the last char '\0' or NULL if no enough
135 * space in dst
136 */
137char *ltoa_o(long int n, char *dst, size_t size);
138
139/*
140 * signed long long ASCII representation
141 *
142 * return the last char '\0' or NULL if no enough
143 * space in dst
144 */
145char *lltoa(long long n, char *dst, size_t size);
146
147/*
148 * write a ascii representation of a unsigned into dst,
149 * return a pointer to the last character
150 * Pad the ascii representation with '0', using size.
151 */
152char *utoa_pad(unsigned int n, char *dst, size_t size);
153
Willy Tarreaubaaee002006-06-26 02:48:02 +0200154/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200155 * This function simply returns a locally allocated string containing the ascii
156 * representation for number 'n' in decimal, unless n is 0 in which case it
157 * returns the alternate string (or an empty string if the alternate string is
158 * NULL). It use is intended for limits reported in reports, where it's
159 * desirable not to display anything if there is no limit. Warning! it shares
160 * the same vector as ultoa_r().
161 */
162extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
163
Willy Tarreau56adcf22012-12-23 18:00:29 +0100164/* returns a locally allocated string containing the ASCII representation of
165 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
166 * function call (eg: printf), shared with the other similar functions making
167 * use of itoa_str[].
168 */
169static inline const char *U2A(unsigned long n)
170{
171 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
172 if (++itoa_idx >= NB_ITOA_STR)
173 itoa_idx = 0;
174 return ret;
175}
176
177/* returns a locally allocated string containing the HTML representation of
178 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
179 * function call (eg: printf), shared with the other similar functions making
180 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200181 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100182static inline const char *U2H(unsigned long long n)
183{
184 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
185 if (++itoa_idx >= NB_ITOA_STR)
186 itoa_idx = 0;
187 return ret;
188}
189
190/* returns a locally allocated string containing the HTML representation of
191 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
192 * function call (eg: printf), shared with the other similar functions making
193 * use of itoa_str[].
194 */
195static inline const char *LIM2A(unsigned long n, const char *alt)
196{
197 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
198 if (++itoa_idx >= NB_ITOA_STR)
199 itoa_idx = 0;
200 return ret;
201}
Willy Tarreau91092e52007-10-25 16:58:42 +0200202
Willy Tarreau588297f2014-06-16 15:16:40 +0200203/* returns a locally allocated string containing the quoted encoding of the
204 * input string. The output may be truncated to QSTR_SIZE chars, but it is
205 * guaranteed that the string will always be properly terminated. Quotes are
206 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
207 * always be at least 4 chars.
208 */
209const char *qstr(const char *str);
210
211/* returns <str> or its quote-encoded equivalent if it contains at least one
212 * quote or a comma. This is aimed at build CSV-compatible strings.
213 */
214static inline const char *cstr(const char *str)
215{
216 const char *p = str;
217
218 while (*p) {
219 if (*p == ',' || *p == '"')
220 return qstr(str);
221 p++;
222 }
223 return str;
224}
225
Willy Tarreau91092e52007-10-25 16:58:42 +0200226/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200227 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
228 */
229extern int ishex(char s);
230
231/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100232 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200233 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100234 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200235static inline int hex2i(int c)
236{
Willy Tarreau0161d622013-04-02 01:26:55 +0200237 if (unlikely((unsigned char)(c -= '0') > 9)) {
238 if (likely((unsigned char)(c -= 'A' - '0') > 5 &&
239 (unsigned char)(c -= 'a' - 'A') > 5))
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200240 c = -11;
241 c += 10;
242 }
243 return c;
244}
245
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100246/* rounds <i> down to the closest value having max 2 digits */
247unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100248
249/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100250 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
251 * invalid character is found, a pointer to it is returned. If everything is
252 * fine, NULL is returned.
253 */
254extern const char *invalid_char(const char *name);
255
256/*
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200257 * Checks <domainname> for invalid characters. Valid chars are [A-Za-z0-9_.-].
258 * If an invalid character is found, a pointer to it is returned.
259 * If everything is fine, NULL is returned.
260 */
261extern const char *invalid_domainchar(const char *name);
262
263/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100264 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200265 * port range consisting in two integers. The low and high end are always set
266 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100267 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200268 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100269 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
270 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
271 * address wants to ignore port, it must be terminated by a trailing colon (':').
272 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
273 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100274 * If <pfx> is non-null, it is used as a string prefix before any path-based
275 * address (typically the path to a unix socket).
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200276 */
Willy Tarreaud393a622013-03-04 18:22:00 +0100277struct sockaddr_storage *str2sa_range(const char *str, int *low, int *high, char **err, const char *pfx);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200278
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100279/* converts <str> to a struct in_addr containing a network mask. It can be
280 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
281 * if the conversion succeeds otherwise non-zero.
282 */
283int str2mask(const char *str, struct in_addr *mask);
284
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100285/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
286 * succeeds otherwise non-zero.
287 */
288int cidr2dotted(int cidr, struct in_addr *mask);
289
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200290/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200291 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200292 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
293 * is optionnal and either in the dotted or CIDR notation.
294 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
295 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100296int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200297
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100298/* str2ip and str2ip2:
299 *
300 * converts <str> to a struct sockaddr_storage* provided by the caller. The
301 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
302 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
303 * the function tries to guess the address family from the syntax. If the
304 * family is forced and the format doesn't match, an error is returned. The
305 * string is assumed to contain only an address, no port. The address can be a
306 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
307 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
308 * The return address will only have the address family and the address set,
309 * all other fields remain zero. The string is not supposed to be modified.
310 * The IPv6 '::' address is IN6ADDR_ANY.
311 *
312 * str2ip2:
313 *
314 * If <resolve> is set, this function try to resolve DNS, otherwise, it returns
315 * NULL result.
316 */
317struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve);
318static inline struct sockaddr_storage *str2ip(const char *str, struct sockaddr_storage *sa)
319{
320 return str2ip2(str, sa, 1);
321}
322
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100323/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200324 * converts <str> to two struct in6_addr* which must be pre-allocated.
325 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
326 * is an optionnal number of bits (128 being the default).
327 * Returns 1 if OK, 0 if error.
328 */
329int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
330
331/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200332 * Parse IP address found in url.
333 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100334int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200335
336/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100337 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100338 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100339int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100340
Willy Tarreau631f01c2011-09-05 00:36:48 +0200341/* Tries to convert a sockaddr_storage address to text form. Upon success, the
342 * address family is returned so that it's easy for the caller to adapt to the
343 * output format. Zero is returned if the address family is not supported. -1
344 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
345 * supported.
346 */
347int addr_to_str(struct sockaddr_storage *addr, char *str, int size);
348
Simon Horman75ab8bd2014-06-16 09:39:41 +0900349/* Tries to convert a sockaddr_storage port to text form. Upon success, the
350 * address family is returned so that it's easy for the caller to adapt to the
351 * output format. Zero is returned if the address family is not supported. -1
352 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
353 * supported.
354 */
355int port_to_str(struct sockaddr_storage *addr, char *str, int size);
356
Willy Tarreaubaaee002006-06-26 02:48:02 +0200357/* will try to encode the string <string> replacing all characters tagged in
358 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
359 * prefixed by <escape>, and will store the result between <start> (included)
360 * and <stop> (excluded), and will always terminate the string with a '\0'
361 * before <stop>. The position of the '\0' is returned if the conversion
362 * completes. If bytes are missing between <start> and <stop>, then the
363 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
364 * cannot even be stored so we return <start> without writing the 0.
365 * The input string must also be zero-terminated.
366 */
367extern const char hextab[];
368char *encode_string(char *start, char *stop,
369 const char escape, const fd_set *map,
370 const char *string);
371
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100372/*
373 * Same behavior, except that it encodes chunk <chunk> instead of a string.
374 */
375char *encode_chunk(char *start, char *stop,
376 const char escape, const fd_set *map,
377 const struct chunk *chunk);
378
379
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200380/* Check a string for using it in a CSV output format. If the string contains
381 * one of the following four char <">, <,>, CR or LF, the string is
382 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
383 * <str> is the input string to be escaped. The function assumes that
384 * the input string is null-terminated.
385 *
386 * If <quote> is 0, the result is returned escaped but without double quote.
387 * Is it useful if the escaped string is used between double quotes in the
388 * format.
389 *
390 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0));
391 *
392 * If the <quote> is 1, the converter put the quotes only if any character is
393 * escaped. If the <quote> is 2, the converter put always the quotes.
394 *
395 * <output> is a struct chunk used for storing the output string if any
396 * change will be done.
397 *
398 * The function returns the converted string on this output. If an error
399 * occurs, the function return an empty string. This type of output is useful
400 * for using the function directly as printf() argument.
401 *
402 * If the output buffer is too short to conatin the input string, the result
403 * is truncated.
404 */
405const char *csv_enc(const char *str, int quote, struct chunk *output);
406
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200407/* Decode an URL-encoded string in-place. The resulting string might
408 * be shorter. If some forbidden characters are found, the conversion is
409 * aborted, the string is truncated before the issue and non-zero is returned,
410 * otherwise the operation returns non-zero indicating success.
411 */
412int url_decode(char *string);
413
Willy Tarreau6911fa42007-03-04 18:06:08 +0100414/* This one is 6 times faster than strtoul() on athlon, but does
415 * no check at all.
416 */
417static inline unsigned int __str2ui(const char *s)
418{
419 unsigned int i = 0;
420 while (*s) {
421 i = i * 10 - '0';
422 i += (unsigned char)*s++;
423 }
424 return i;
425}
426
427/* This one is 5 times faster than strtoul() on athlon with checks.
428 * It returns the value of the number composed of all valid digits read.
429 */
430static inline unsigned int __str2uic(const char *s)
431{
432 unsigned int i = 0;
433 unsigned int j;
434 while (1) {
435 j = (*s++) - '0';
436 if (j > 9)
437 break;
438 i *= 10;
439 i += j;
440 }
441 return i;
442}
443
444/* This one is 28 times faster than strtoul() on athlon, but does
445 * no check at all!
446 */
447static inline unsigned int __strl2ui(const char *s, int len)
448{
449 unsigned int i = 0;
450 while (len-- > 0) {
451 i = i * 10 - '0';
452 i += (unsigned char)*s++;
453 }
454 return i;
455}
456
457/* This one is 7 times faster than strtoul() on athlon with checks.
458 * It returns the value of the number composed of all valid digits read.
459 */
460static inline unsigned int __strl2uic(const char *s, int len)
461{
462 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200463 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100464
465 while (len-- > 0) {
466 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200467 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100468 if (j > 9)
469 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200470 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100471 }
472 return i;
473}
474
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200475/* This function reads an unsigned integer from the string pointed to by <s>
476 * and returns it. The <s> pointer is adjusted to point to the first unread
477 * char. The function automatically stops at <end>.
478 */
479static inline unsigned int __read_uint(const char **s, const char *end)
480{
481 const char *ptr = *s;
482 unsigned int i = 0;
483 unsigned int j, k;
484
485 while (ptr < end) {
486 j = *ptr - '0';
487 k = i * 10;
488 if (j > 9)
489 break;
490 i = k + j;
491 ptr++;
492 }
493 *s = ptr;
494 return i;
495}
496
Willy Tarreau6911fa42007-03-04 18:06:08 +0100497extern unsigned int str2ui(const char *s);
498extern unsigned int str2uic(const char *s);
499extern unsigned int strl2ui(const char *s, int len);
500extern unsigned int strl2uic(const char *s, int len);
501extern int strl2ic(const char *s, int len);
502extern int strl2irc(const char *s, int len, int *ret);
503extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100504extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200505extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200506unsigned int inetaddr_host(const char *text);
507unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200508unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100509
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200510static inline char *cut_crlf(char *s) {
511
Simon Horman5269cfb2013-02-13 17:48:00 +0900512 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200513 char *p = s++;
514
515 if (!*p)
516 return p;
517 }
518
Simon Horman5269cfb2013-02-13 17:48:00 +0900519 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200520
521 return s;
522}
523
524static inline char *ltrim(char *s, char c) {
525
526 if (c)
527 while (*s == c)
528 s++;
529
530 return s;
531}
532
533static inline char *rtrim(char *s, char c) {
534
535 char *p = s + strlen(s);
536
537 while (p-- > s)
538 if (*p == c)
539 *p = '\0';
540 else
541 break;
542
543 return s;
544}
545
546static inline char *alltrim(char *s, char c) {
547
548 rtrim(s, c);
549
550 return ltrim(s, c);
551}
552
Willy Tarreaufe944602007-10-25 10:34:16 +0200553/* This function converts the time_t value <now> into a broken out struct tm
554 * which must be allocated by the caller. It is highly recommended to use this
555 * function intead of localtime() because that one requires a time_t* which
556 * is not always compatible with tv_sec depending on OS/hardware combinations.
557 */
558static inline void get_localtime(const time_t now, struct tm *tm)
559{
560 localtime_r(&now, tm);
561}
562
Emeric Brun3a058f32009-06-30 18:26:00 +0200563/* This function converts the time_t value <now> into a broken out struct tm
564 * which must be allocated by the caller. It is highly recommended to use this
565 * function intead of gmtime() because that one requires a time_t* which
566 * is not always compatible with tv_sec depending on OS/hardware combinations.
567 */
568static inline void get_gmtime(const time_t now, struct tm *tm)
569{
570 gmtime_r(&now, tm);
571}
572
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100573/* This function parses a time value optionally followed by a unit suffix among
574 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
575 * expected by the caller. The computation does its best to avoid overflows.
576 * The value is returned in <ret> if everything is fine, and a NULL is returned
577 * by the function. In case of error, a pointer to the error is returned and
578 * <ret> is left untouched.
579 */
580extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100581extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100582
583/* unit flags to pass to parse_time_err */
584#define TIME_UNIT_US 0x0000
585#define TIME_UNIT_MS 0x0001
586#define TIME_UNIT_S 0x0002
587#define TIME_UNIT_MIN 0x0003
588#define TIME_UNIT_HOUR 0x0004
589#define TIME_UNIT_DAY 0x0005
590#define TIME_UNIT_MASK 0x0007
591
William Lallemand421f5b52012-02-06 18:15:57 +0100592#define SEC 1
593#define MINUTE (60 * SEC)
594#define HOUR (60 * MINUTE)
595#define DAY (24 * HOUR)
596
Willy Tarreau7f062c42009-03-05 18:43:00 +0100597/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
598 * This is used to compute fixed ratios by setting one of the operands to
599 * (2^32*ratio).
600 */
601static inline unsigned int mul32hi(unsigned int a, unsigned int b)
602{
603 return ((unsigned long long)a * b) >> 32;
604}
605
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200606/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
607 * function when you know for sure that the result fits in 32 bits, because
608 * it is optimal on x86 and on 64bit processors.
609 */
610static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
611{
612 unsigned int result;
613#ifdef __i386__
614 asm("divl %2"
615 : "=a" (result)
616 : "A"(o1), "rm"(o2));
617#else
618 result = o1 / o2;
619#endif
620 return result;
621}
622
Willy Tarreau37994f02012-11-19 12:11:07 +0100623/* Simple popcount implementation. It returns the number of ones in a word */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100624static inline unsigned int popcount(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100625{
626 unsigned int cnt;
627 for (cnt = 0; a; a >>= 1) {
628 if (a & 1)
629 cnt++;
630 }
631 return cnt;
632}
633
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100634/* Build a word with the <bits> lower bits set (reverse of popcount) */
635static inline unsigned long nbits(int bits)
636{
637 if (--bits < 0)
638 return 0;
639 else
640 return (2UL << bits) - 1;
641}
642
Willy Tarreau126d4062013-12-03 17:50:47 +0100643/*
644 * Parse binary string written in hexadecimal (source) and store the decoded
645 * result into binstr and set binstrlen to the lengh of binstr. Memory for
646 * binstr is allocated by the function. In case of error, returns 0 with an
647 * error message in err.
648 */
649int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
650
Willy Tarreau946ba592009-05-10 15:41:18 +0200651/* copies at most <n> characters from <src> and always terminates with '\0' */
652char *my_strndup(const char *src, int n);
653
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200654/*
655 * search needle in haystack
656 * returns the pointer if found, returns NULL otherwise
657 */
658const void *my_memmem(const void *, size_t, const void *, size_t);
659
Willy Tarreau482b00d2009-10-04 22:48:42 +0200660/* This function returns the first unused key greater than or equal to <key> in
661 * ID tree <root>. Zero is returned if no place is found.
662 */
663unsigned int get_next_id(struct eb_root *root, unsigned int key);
664
Willy Tarreau348238b2010-01-18 15:05:57 +0100665/* This function compares a sample word possibly followed by blanks to another
666 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
667 * otherwise zero. This intends to be used when checking HTTP headers for some
668 * values.
669 */
670int word_match(const char *sample, int slen, const char *word, int wlen);
671
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200672/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
673 * or the number of chars read in case of success.
674 */
675int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +0100676int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200677
Willy Tarreauacf95772010-06-14 19:09:21 +0200678/* To be used to quote config arg positions. Returns the string at <ptr>
679 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
680 * if ptr is NULL or empty. The string is locally allocated.
681 */
682const char *quote_arg(const char *ptr);
683
Willy Tarreau5b180202010-07-18 10:40:48 +0200684/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
685int get_std_op(const char *str);
686
Willy Tarreau4c14eaa2010-11-24 14:01:45 +0100687/* hash a 32-bit integer to another 32-bit integer */
688extern unsigned int full_hash(unsigned int a);
689static inline unsigned int __full_hash(unsigned int a)
690{
691 /* This function is one of Bob Jenkins' full avalanche hashing
692 * functions, which when provides quite a good distribution for little
693 * input variations. The result is quite suited to fit over a 32-bit
694 * space with enough variations so that a randomly picked number falls
695 * equally before any server position.
696 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
697 */
698 a = (a+0x7ed55d16) + (a<<12);
699 a = (a^0xc761c23c) ^ (a>>19);
700 a = (a+0x165667b1) + (a<<5);
701 a = (a+0xd3a2646c) ^ (a<<9);
702 a = (a+0xfd7046c5) + (a<<3);
703 a = (a^0xb55a4f09) ^ (a>>16);
704
705 /* ensure values are better spread all around the tree by multiplying
706 * by a large prime close to 3/4 of the tree.
707 */
708 return a * 3221225473U;
709}
710
Willy Tarreau422a0a52012-10-26 19:47:23 +0200711/* sets the address family to AF_UNSPEC so that is_addr() does not match */
712static inline void clear_addr(struct sockaddr_storage *addr)
713{
714 addr->ss_family = AF_UNSPEC;
715}
716
David du Colombier6f5ccb12011-03-10 22:26:24 +0100717/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
718 * otherwise zero.
719 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200720static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +0100721{
722 int i;
723
724 switch (addr->ss_family) {
725 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +0100726 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100727 case AF_INET6:
728 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
729 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
730 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
731 }
732 return 0;
733}
734
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200735/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
736 * or is a unix address, otherwise returns zero.
737 */
738static inline int is_addr(const struct sockaddr_storage *addr)
739{
740 if (addr->ss_family == AF_UNIX)
741 return 1;
742 else
743 return is_inet_addr(addr);
744}
745
David du Colombier11bcb6c2011-03-24 12:23:00 +0100746/* returns port in network byte order */
747static inline int get_net_port(struct sockaddr_storage *addr)
748{
749 switch (addr->ss_family) {
750 case AF_INET:
751 return ((struct sockaddr_in *)addr)->sin_port;
752 case AF_INET6:
753 return ((struct sockaddr_in6 *)addr)->sin6_port;
754 }
755 return 0;
756}
757
758/* returns port in host byte order */
759static inline int get_host_port(struct sockaddr_storage *addr)
760{
761 switch (addr->ss_family) {
762 case AF_INET:
763 return ntohs(((struct sockaddr_in *)addr)->sin_port);
764 case AF_INET6:
765 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
766 }
767 return 0;
768}
769
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +0200770/* returns address len for <addr>'s family, 0 for unknown families */
771static inline int get_addr_len(const struct sockaddr_storage *addr)
772{
773 switch (addr->ss_family) {
774 case AF_INET:
775 return sizeof(struct sockaddr_in);
776 case AF_INET6:
777 return sizeof(struct sockaddr_in6);
778 case AF_UNIX:
779 return sizeof(struct sockaddr_un);
780 }
781 return 0;
782}
783
David du Colombier11bcb6c2011-03-24 12:23:00 +0100784/* set port in host byte order */
785static inline int set_net_port(struct sockaddr_storage *addr, int port)
786{
787 switch (addr->ss_family) {
788 case AF_INET:
789 ((struct sockaddr_in *)addr)->sin_port = port;
790 case AF_INET6:
791 ((struct sockaddr_in6 *)addr)->sin6_port = port;
792 }
793 return 0;
794}
795
796/* set port in network byte order */
797static inline int set_host_port(struct sockaddr_storage *addr, int port)
798{
799 switch (addr->ss_family) {
800 case AF_INET:
801 ((struct sockaddr_in *)addr)->sin_port = htons(port);
802 case AF_INET6:
803 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
804 }
805 return 0;
806}
807
David du Colombier4f92d322011-03-24 11:09:31 +0100808/* Return true if IPv4 address is part of the network */
809extern int in_net_ipv4(struct in_addr *addr, struct in_addr *mask, struct in_addr *net);
810
811/* Return true if IPv6 address is part of the network */
812extern int in_net_ipv6(struct in6_addr *addr, struct in6_addr *mask, struct in6_addr *net);
813
814/* Map IPv4 adress on IPv6 address, as specified in RFC 3513. */
815extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
816
817/* Map IPv6 adress on IPv4 address, as specified in RFC 3513.
818 * Return true if conversion is possible and false otherwise.
819 */
820extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
821
William Lallemand421f5b52012-02-06 18:15:57 +0100822char *human_time(int t, short hz_div);
823
824extern const char *monthname[];
825
Yuxans Yao4e25b012012-10-19 10:36:09 +0800826/* numeric timezone (that is, the hour and minute offset from UTC) */
827char localtimezone[6];
828
William Lallemand421f5b52012-02-06 18:15:57 +0100829/* date2str_log: write a date in the format :
830 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
831 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
832 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
833 *
834 * without using sprintf. return a pointer to the last char written (\0) or
835 * NULL if there isn't enough space.
836 */
837char *date2str_log(char *dest, struct tm *tm, struct timeval *date, size_t size);
838
839/* gmt2str_log: write a date in the format :
840 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
841 * return a pointer to the last char written (\0) or
842 * NULL if there isn't enough space.
843 */
844char *gmt2str_log(char *dst, struct tm *tm, size_t size);
845
Yuxans Yao4e25b012012-10-19 10:36:09 +0800846/* localdate2str_log: write a date in the format :
847 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
848 * return a pointer to the last char written (\0) or
849 * NULL if there isn't enough space.
850 */
851char *localdate2str_log(char *dst, struct tm *tm, size_t size);
852
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200853/* Dynamically allocates a string of the proper length to hold the formatted
854 * output. NULL is returned on error. The caller is responsible for freeing the
855 * memory area using free(). The resulting string is returned in <out> if the
856 * pointer is not NULL. A previous version of <out> might be used to build the
857 * new string, and it will be freed before returning if it is not NULL, which
858 * makes it possible to build complex strings from iterative calls without
859 * having to care about freeing intermediate values, as in the example below :
860 *
861 * memprintf(&err, "invalid argument: '%s'", arg);
862 * ...
863 * memprintf(&err, "parser said : <%s>\n", *err);
864 * ...
865 * free(*err);
866 *
867 * This means that <err> must be initialized to NULL before first invocation.
868 * The return value also holds the allocated string, which eases error checking
869 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200870 * passed instead and it will be ignored. The returned message will then also
871 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200872 *
873 * It is also convenient to use it without any free except the last one :
874 * err = NULL;
875 * if (!fct1(err)) report(*err);
876 * if (!fct2(err)) report(*err);
877 * if (!fct3(err)) report(*err);
878 * free(*err);
879 */
880char *memprintf(char **out, const char *format, ...)
881 __attribute__ ((format(printf, 2, 3)));
882
Willy Tarreau21c705b2012-09-14 11:40:36 +0200883/* Used to add <level> spaces before each line of <out>, unless there is only one line.
884 * The input argument is automatically freed and reassigned. The result will have to be
885 * freed by the caller.
886 * Example of use :
887 * parse(cmd, &err); (callee: memprintf(&err, ...))
888 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
889 * free(err);
890 */
891char *indent_msg(char **out, int level);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200892
Willy Tarreaudad36a32013-03-11 01:20:04 +0100893/* Convert occurrences of environment variables in the input string to their
894 * corresponding value. A variable is identified as a series of alphanumeric
895 * characters or underscores following a '$' sign. The <in> string must be
896 * free()able. NULL returns NULL. The resulting string might be reallocated if
897 * some expansion is made.
898 */
899char *env_expand(char *in);
900
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200901/* debugging macro to emit messages using write() on fd #-1 so that strace sees
902 * them.
903 */
904#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
905
Willy Tarreau89efaed2013-12-13 15:14:55 +0100906/* used from everywhere just to drain results we don't want to read and which
907 * recent versions of gcc increasingly and annoyingly complain about.
908 */
909extern int shut_your_big_mouth_gcc_int;
910
911/* used from everywhere just to drain results we don't want to read and which
912 * recent versions of gcc increasingly and annoyingly complain about.
913 */
914static inline void shut_your_big_mouth_gcc(int r)
915{
916 shut_your_big_mouth_gcc_int = r;
917}
918
de Lafond Guillaume88c278f2013-04-15 19:27:10 +0200919/* same as strstr() but case-insensitive */
920const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
921
Willy Tarreaubb519c72014-01-28 23:04:39 +0100922
923/************************* Composite address manipulation *********************
924 * Composite addresses are simply unsigned long data in which the higher bits
925 * represent a pointer, and the two lower bits are flags. There are several
926 * places where we just want to associate one or two flags to a pointer (eg,
927 * to type it), and these functions permit this. The pointer is necessarily a
928 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
929 * with the flags.
930 *****************************************************************************/
931
932/* Masks the two lower bits of a composite address and converts it to a
933 * pointer. This is used to mix some bits with some aligned pointers to
934 * structs and to retrieve the original (32-bit aligned) pointer.
935 */
936static inline void *caddr_to_ptr(unsigned long caddr)
937{
938 return (void *)(caddr & ~3UL);
939}
940
941/* Only retrieves the two lower bits of a composite address. This is used to mix
942 * some bits with some aligned pointers to structs and to retrieve the original
943 * data (2 bits).
944 */
945static inline unsigned int caddr_to_data(unsigned long caddr)
946{
947 return (caddr & 3UL);
948}
949
950/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
951 * from <data> to form a composite address. This is used to mix some bits with
952 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
953 * pointer.
954 */
955static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
956{
957 return (((unsigned long)ptr) & ~3UL) + (data & 3);
958}
959
960/* sets the 2 bits of <data> in the <caddr> composite address */
961static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
962{
963 return caddr | (data & 3);
964}
965
966/* clears the 2 bits of <data> in the <caddr> composite address */
967static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
968{
969 return caddr & ~(unsigned long)(data & 3);
970}
971
Thierry FOURNIER317e1c42014-08-12 10:20:47 +0200972/* UTF-8 decoder status */
973#define UTF8_CODE_OK 0x00
974#define UTF8_CODE_OVERLONG 0x10
975#define UTF8_CODE_INVRANGE 0x20
976#define UTF8_CODE_BADSEQ 0x40
977
978unsigned char utf8_next(const char *s, int len, unsigned int *c);
979
980static inline unsigned char utf8_return_code(unsigned int code)
981{
982 return code & 0xf0;
983}
984
985static inline unsigned char utf8_return_length(unsigned char code)
986{
987 return code & 0x0f;
988}
989
Willy Tarreaue6e49cf2015-04-29 17:13:35 +0200990/* returns a 64-bit a timestamp with the finest resolution available. The
991 * unit is intentionally not specified. It's mostly used to compare dates.
992 */
993#if defined(__i386__) || defined(__x86_64__)
994static inline unsigned long long rdtsc()
995{
996 unsigned int a, d;
997 asm volatile("rdtsc" : "=a" (a), "=d" (d));
998 return a + ((unsigned long long)d << 32);
999}
1000#else
1001static inline unsigned long long rdtsc()
1002{
1003 struct timeval tv;
1004 gettimeofday(&tv, NULL);
1005 return tv.tv_sec * 1000000 + tv.tv_usec;
1006}
1007#endif
1008
Willy Tarreau2dd0d472006-06-29 17:53:05 +02001009#endif /* _COMMON_STANDARD_H */