blob: 8acd2778ea8d93f2803a7083f0cd7f5bdcbabe02 [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 Tarreau938b3032007-05-10 06:39:03 +020028#include <sys/types.h>
Willy Tarreaud50265a2012-09-04 14:18:33 +020029#include <sys/socket.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020030#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020031#include <netinet/in.h>
Thierry FOURNIERe059ec92014-03-17 12:01:13 +010032#include <common/chunk.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020033#include <common/config.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010034#include <eb32tree.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020035
William Lallemande7340ec2012-01-24 11:15:39 +010036#ifndef LLONG_MAX
37# define LLONG_MAX 9223372036854775807LL
38# define LLONG_MIN (-LLONG_MAX - 1LL)
39#endif
40
41#ifndef ULLONG_MAX
42# define ULLONG_MAX (LLONG_MAX * 2ULL + 1)
43#endif
44
Willy Tarreaua9db57e2013-01-18 11:29:29 +010045#ifndef LONGBITS
46#define LONGBITS ((unsigned int)sizeof(long) * 8)
47#endif
48
Thierry FOURNIER511e9472014-01-23 17:40:34 +010049/* size used for max length of decimal representation of long long int. */
50#define NB_LLMAX_STR (sizeof("-9223372036854775807")-1)
51
Willy Tarreau56adcf22012-12-23 18:00:29 +010052/* number of itoa_str entries */
53#define NB_ITOA_STR 10
William Lallemande7340ec2012-01-24 11:15:39 +010054
Willy Tarreaubaaee002006-06-26 02:48:02 +020055/****** string-specific macros and functions ******/
56/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
57#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
58
59/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
60#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
61
62/* returns 1 only if only zero or one bit is set in X, which means that X is a
63 * power of 2, and 0 otherwise */
64#define POWEROF2(x) (((x) & ((x)-1)) == 0)
65
Willy Tarreau5b180202010-07-18 10:40:48 +020066/* operators to compare values. They're ordered that way so that the lowest bit
67 * serves as a negation for the test and contains all tests that are not equal.
68 */
69enum {
70 STD_OP_LE = 0, STD_OP_GT = 1,
71 STD_OP_EQ = 2, STD_OP_NE = 3,
72 STD_OP_GE = 4, STD_OP_LT = 5,
73};
74
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010075enum http_scheme {
76 SCH_HTTP,
77 SCH_HTTPS,
78};
79
80struct split_url {
81 enum http_scheme scheme;
82 const char *host;
83 int host_len;
84};
85
Willy Tarreau56adcf22012-12-23 18:00:29 +010086extern int itoa_idx; /* index of next itoa_str to use */
87
Willy Tarreau7d58a632007-01-13 23:06:06 +010088/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020089 * copies at most <size-1> chars from <src> to <dst>. Last char is always
90 * set to 0, unless <size> is 0. The number of chars copied is returned
91 * (excluding the terminating zero).
92 * This code has been optimized for size and speed : on x86, it's 45 bytes
93 * long, uses only registers, and consumes only 4 cycles per char.
94 */
95extern int strlcpy2(char *dst, const char *src, int size);
96
97/*
Willy Tarreau72d759c2007-10-25 12:14:10 +020098 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +020099 * the ascii representation for number 'n' in decimal.
100 */
Willy Tarreaue7239b52009-03-29 13:41:58 +0200101extern char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100102extern char *ultoa_r(unsigned long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200103extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200104static inline const char *ultoa(unsigned long n)
105{
106 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
107}
108
William Lallemande7340ec2012-01-24 11:15:39 +0100109/*
110 * unsigned long long ASCII representation
111 *
112 * return the last char '\0' or NULL if no enough
113 * space in dst
114 */
115char *ulltoa(unsigned long long n, char *dst, size_t size);
116
117
118/*
119 * unsigned long ASCII representation
120 *
121 * return the last char '\0' or NULL if no enough
122 * space in dst
123 */
124char *ultoa_o(unsigned long n, char *dst, size_t size);
125
126/*
127 * signed long ASCII representation
128 *
129 * return the last char '\0' or NULL if no enough
130 * space in dst
131 */
132char *ltoa_o(long int n, char *dst, size_t size);
133
134/*
135 * signed long long ASCII representation
136 *
137 * return the last char '\0' or NULL if no enough
138 * space in dst
139 */
140char *lltoa(long long n, char *dst, size_t size);
141
142/*
143 * write a ascii representation of a unsigned into dst,
144 * return a pointer to the last character
145 * Pad the ascii representation with '0', using size.
146 */
147char *utoa_pad(unsigned int n, char *dst, size_t size);
148
Willy Tarreaubaaee002006-06-26 02:48:02 +0200149/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200150 * This function simply returns a locally allocated string containing the ascii
151 * representation for number 'n' in decimal, unless n is 0 in which case it
152 * returns the alternate string (or an empty string if the alternate string is
153 * NULL). It use is intended for limits reported in reports, where it's
154 * desirable not to display anything if there is no limit. Warning! it shares
155 * the same vector as ultoa_r().
156 */
157extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
158
Willy Tarreau56adcf22012-12-23 18:00:29 +0100159/* returns a locally allocated string containing the ASCII representation of
160 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
161 * function call (eg: printf), shared with the other similar functions making
162 * use of itoa_str[].
163 */
164static inline const char *U2A(unsigned long n)
165{
166 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
167 if (++itoa_idx >= NB_ITOA_STR)
168 itoa_idx = 0;
169 return ret;
170}
171
172/* returns a locally allocated string containing the HTML representation of
173 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
174 * function call (eg: printf), shared with the other similar functions making
175 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200176 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100177static inline const char *U2H(unsigned long long n)
178{
179 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
180 if (++itoa_idx >= NB_ITOA_STR)
181 itoa_idx = 0;
182 return ret;
183}
184
185/* returns a locally allocated string containing the HTML representation of
186 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
187 * function call (eg: printf), shared with the other similar functions making
188 * use of itoa_str[].
189 */
190static inline const char *LIM2A(unsigned long n, const char *alt)
191{
192 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
193 if (++itoa_idx >= NB_ITOA_STR)
194 itoa_idx = 0;
195 return ret;
196}
Willy Tarreau91092e52007-10-25 16:58:42 +0200197
198/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200199 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
200 */
201extern int ishex(char s);
202
203/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100204 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200205 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100206 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200207static inline int hex2i(int c)
208{
Willy Tarreau0161d622013-04-02 01:26:55 +0200209 if (unlikely((unsigned char)(c -= '0') > 9)) {
210 if (likely((unsigned char)(c -= 'A' - '0') > 5 &&
211 (unsigned char)(c -= 'a' - 'A') > 5))
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200212 c = -11;
213 c += 10;
214 }
215 return c;
216}
217
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100218
219/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100220 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
221 * invalid character is found, a pointer to it is returned. If everything is
222 * fine, NULL is returned.
223 */
224extern const char *invalid_char(const char *name);
225
226/*
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200227 * Checks <domainname> for invalid characters. Valid chars are [A-Za-z0-9_.-].
228 * If an invalid character is found, a pointer to it is returned.
229 * If everything is fine, NULL is returned.
230 */
231extern const char *invalid_domainchar(const char *name);
232
233/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100234 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200235 * port range consisting in two integers. The low and high end are always set
236 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100237 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200238 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100239 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
240 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
241 * address wants to ignore port, it must be terminated by a trailing colon (':').
242 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
243 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100244 * If <pfx> is non-null, it is used as a string prefix before any path-based
245 * address (typically the path to a unix socket).
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200246 */
Willy Tarreaud393a622013-03-04 18:22:00 +0100247struct sockaddr_storage *str2sa_range(const char *str, int *low, int *high, char **err, const char *pfx);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200248
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100249/* converts <str> to a struct in_addr containing a network mask. It can be
250 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
251 * if the conversion succeeds otherwise non-zero.
252 */
253int str2mask(const char *str, struct in_addr *mask);
254
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100255/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
256 * succeeds otherwise non-zero.
257 */
258int cidr2dotted(int cidr, struct in_addr *mask);
259
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200260/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200261 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200262 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
263 * is optionnal and either in the dotted or CIDR notation.
264 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
265 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100266int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200267
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100268/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200269 * converts <str> to two struct in6_addr* which must be pre-allocated.
270 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
271 * is an optionnal number of bits (128 being the default).
272 * Returns 1 if OK, 0 if error.
273 */
274int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
275
276/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200277 * Parse IP address found in url.
278 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100279int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200280
281/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100282 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100283 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100284int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100285
Willy Tarreau631f01c2011-09-05 00:36:48 +0200286/* Tries to convert a sockaddr_storage address to text form. Upon success, the
287 * address family is returned so that it's easy for the caller to adapt to the
288 * output format. Zero is returned if the address family is not supported. -1
289 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
290 * supported.
291 */
292int addr_to_str(struct sockaddr_storage *addr, char *str, int size);
293
Willy Tarreaubaaee002006-06-26 02:48:02 +0200294/* will try to encode the string <string> replacing all characters tagged in
295 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
296 * prefixed by <escape>, and will store the result between <start> (included)
297 * and <stop> (excluded), and will always terminate the string with a '\0'
298 * before <stop>. The position of the '\0' is returned if the conversion
299 * completes. If bytes are missing between <start> and <stop>, then the
300 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
301 * cannot even be stored so we return <start> without writing the 0.
302 * The input string must also be zero-terminated.
303 */
304extern const char hextab[];
305char *encode_string(char *start, char *stop,
306 const char escape, const fd_set *map,
307 const char *string);
308
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100309/*
310 * Same behavior, except that it encodes chunk <chunk> instead of a string.
311 */
312char *encode_chunk(char *start, char *stop,
313 const char escape, const fd_set *map,
314 const struct chunk *chunk);
315
316
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200317/* Decode an URL-encoded string in-place. The resulting string might
318 * be shorter. If some forbidden characters are found, the conversion is
319 * aborted, the string is truncated before the issue and non-zero is returned,
320 * otherwise the operation returns non-zero indicating success.
321 */
322int url_decode(char *string);
323
Willy Tarreau6911fa42007-03-04 18:06:08 +0100324/* This one is 6 times faster than strtoul() on athlon, but does
325 * no check at all.
326 */
327static inline unsigned int __str2ui(const char *s)
328{
329 unsigned int i = 0;
330 while (*s) {
331 i = i * 10 - '0';
332 i += (unsigned char)*s++;
333 }
334 return i;
335}
336
337/* This one is 5 times faster than strtoul() on athlon with checks.
338 * It returns the value of the number composed of all valid digits read.
339 */
340static inline unsigned int __str2uic(const char *s)
341{
342 unsigned int i = 0;
343 unsigned int j;
344 while (1) {
345 j = (*s++) - '0';
346 if (j > 9)
347 break;
348 i *= 10;
349 i += j;
350 }
351 return i;
352}
353
354/* This one is 28 times faster than strtoul() on athlon, but does
355 * no check at all!
356 */
357static inline unsigned int __strl2ui(const char *s, int len)
358{
359 unsigned int i = 0;
360 while (len-- > 0) {
361 i = i * 10 - '0';
362 i += (unsigned char)*s++;
363 }
364 return i;
365}
366
367/* This one is 7 times faster than strtoul() on athlon with checks.
368 * It returns the value of the number composed of all valid digits read.
369 */
370static inline unsigned int __strl2uic(const char *s, int len)
371{
372 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200373 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100374
375 while (len-- > 0) {
376 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200377 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100378 if (j > 9)
379 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200380 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100381 }
382 return i;
383}
384
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200385/* This function reads an unsigned integer from the string pointed to by <s>
386 * and returns it. The <s> pointer is adjusted to point to the first unread
387 * char. The function automatically stops at <end>.
388 */
389static inline unsigned int __read_uint(const char **s, const char *end)
390{
391 const char *ptr = *s;
392 unsigned int i = 0;
393 unsigned int j, k;
394
395 while (ptr < end) {
396 j = *ptr - '0';
397 k = i * 10;
398 if (j > 9)
399 break;
400 i = k + j;
401 ptr++;
402 }
403 *s = ptr;
404 return i;
405}
406
Willy Tarreau6911fa42007-03-04 18:06:08 +0100407extern unsigned int str2ui(const char *s);
408extern unsigned int str2uic(const char *s);
409extern unsigned int strl2ui(const char *s, int len);
410extern unsigned int strl2uic(const char *s, int len);
411extern int strl2ic(const char *s, int len);
412extern int strl2irc(const char *s, int len, int *ret);
413extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100414extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200415extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200416unsigned int inetaddr_host(const char *text);
417unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200418unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100419
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200420static inline char *cut_crlf(char *s) {
421
Simon Horman5269cfb2013-02-13 17:48:00 +0900422 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200423 char *p = s++;
424
425 if (!*p)
426 return p;
427 }
428
Simon Horman5269cfb2013-02-13 17:48:00 +0900429 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200430
431 return s;
432}
433
434static inline char *ltrim(char *s, char c) {
435
436 if (c)
437 while (*s == c)
438 s++;
439
440 return s;
441}
442
443static inline char *rtrim(char *s, char c) {
444
445 char *p = s + strlen(s);
446
447 while (p-- > s)
448 if (*p == c)
449 *p = '\0';
450 else
451 break;
452
453 return s;
454}
455
456static inline char *alltrim(char *s, char c) {
457
458 rtrim(s, c);
459
460 return ltrim(s, c);
461}
462
Willy Tarreaufe944602007-10-25 10:34:16 +0200463/* This function converts the time_t value <now> into a broken out struct tm
464 * which must be allocated by the caller. It is highly recommended to use this
465 * function intead of localtime() because that one requires a time_t* which
466 * is not always compatible with tv_sec depending on OS/hardware combinations.
467 */
468static inline void get_localtime(const time_t now, struct tm *tm)
469{
470 localtime_r(&now, tm);
471}
472
Emeric Brun3a058f32009-06-30 18:26:00 +0200473/* This function converts the time_t value <now> into a broken out struct tm
474 * which must be allocated by the caller. It is highly recommended to use this
475 * function intead of gmtime() because that one requires a time_t* which
476 * is not always compatible with tv_sec depending on OS/hardware combinations.
477 */
478static inline void get_gmtime(const time_t now, struct tm *tm)
479{
480 gmtime_r(&now, tm);
481}
482
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100483/* This function parses a time value optionally followed by a unit suffix among
484 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
485 * expected by the caller. The computation does its best to avoid overflows.
486 * The value is returned in <ret> if everything is fine, and a NULL is returned
487 * by the function. In case of error, a pointer to the error is returned and
488 * <ret> is left untouched.
489 */
490extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100491extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100492
493/* unit flags to pass to parse_time_err */
494#define TIME_UNIT_US 0x0000
495#define TIME_UNIT_MS 0x0001
496#define TIME_UNIT_S 0x0002
497#define TIME_UNIT_MIN 0x0003
498#define TIME_UNIT_HOUR 0x0004
499#define TIME_UNIT_DAY 0x0005
500#define TIME_UNIT_MASK 0x0007
501
William Lallemand421f5b52012-02-06 18:15:57 +0100502#define SEC 1
503#define MINUTE (60 * SEC)
504#define HOUR (60 * MINUTE)
505#define DAY (24 * HOUR)
506
Willy Tarreau7f062c42009-03-05 18:43:00 +0100507/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
508 * This is used to compute fixed ratios by setting one of the operands to
509 * (2^32*ratio).
510 */
511static inline unsigned int mul32hi(unsigned int a, unsigned int b)
512{
513 return ((unsigned long long)a * b) >> 32;
514}
515
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200516/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
517 * function when you know for sure that the result fits in 32 bits, because
518 * it is optimal on x86 and on 64bit processors.
519 */
520static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
521{
522 unsigned int result;
523#ifdef __i386__
524 asm("divl %2"
525 : "=a" (result)
526 : "A"(o1), "rm"(o2));
527#else
528 result = o1 / o2;
529#endif
530 return result;
531}
532
Willy Tarreau37994f02012-11-19 12:11:07 +0100533/* Simple popcount implementation. It returns the number of ones in a word */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100534static inline unsigned int popcount(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100535{
536 unsigned int cnt;
537 for (cnt = 0; a; a >>= 1) {
538 if (a & 1)
539 cnt++;
540 }
541 return cnt;
542}
543
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100544/* Build a word with the <bits> lower bits set (reverse of popcount) */
545static inline unsigned long nbits(int bits)
546{
547 if (--bits < 0)
548 return 0;
549 else
550 return (2UL << bits) - 1;
551}
552
Willy Tarreau126d4062013-12-03 17:50:47 +0100553/*
554 * Parse binary string written in hexadecimal (source) and store the decoded
555 * result into binstr and set binstrlen to the lengh of binstr. Memory for
556 * binstr is allocated by the function. In case of error, returns 0 with an
557 * error message in err.
558 */
559int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
560
Willy Tarreau946ba592009-05-10 15:41:18 +0200561/* copies at most <n> characters from <src> and always terminates with '\0' */
562char *my_strndup(const char *src, int n);
563
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200564/*
565 * search needle in haystack
566 * returns the pointer if found, returns NULL otherwise
567 */
568const void *my_memmem(const void *, size_t, const void *, size_t);
569
Willy Tarreau482b00d2009-10-04 22:48:42 +0200570/* This function returns the first unused key greater than or equal to <key> in
571 * ID tree <root>. Zero is returned if no place is found.
572 */
573unsigned int get_next_id(struct eb_root *root, unsigned int key);
574
Willy Tarreau348238b2010-01-18 15:05:57 +0100575/* This function compares a sample word possibly followed by blanks to another
576 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
577 * otherwise zero. This intends to be used when checking HTTP headers for some
578 * values.
579 */
580int word_match(const char *sample, int slen, const char *word, int wlen);
581
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200582/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
583 * or the number of chars read in case of success.
584 */
585int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +0100586int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200587
Willy Tarreauacf95772010-06-14 19:09:21 +0200588/* To be used to quote config arg positions. Returns the string at <ptr>
589 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
590 * if ptr is NULL or empty. The string is locally allocated.
591 */
592const char *quote_arg(const char *ptr);
593
Willy Tarreau5b180202010-07-18 10:40:48 +0200594/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
595int get_std_op(const char *str);
596
Willy Tarreau4c14eaa2010-11-24 14:01:45 +0100597/* hash a 32-bit integer to another 32-bit integer */
598extern unsigned int full_hash(unsigned int a);
599static inline unsigned int __full_hash(unsigned int a)
600{
601 /* This function is one of Bob Jenkins' full avalanche hashing
602 * functions, which when provides quite a good distribution for little
603 * input variations. The result is quite suited to fit over a 32-bit
604 * space with enough variations so that a randomly picked number falls
605 * equally before any server position.
606 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
607 */
608 a = (a+0x7ed55d16) + (a<<12);
609 a = (a^0xc761c23c) ^ (a>>19);
610 a = (a+0x165667b1) + (a<<5);
611 a = (a+0xd3a2646c) ^ (a<<9);
612 a = (a+0xfd7046c5) + (a<<3);
613 a = (a^0xb55a4f09) ^ (a>>16);
614
615 /* ensure values are better spread all around the tree by multiplying
616 * by a large prime close to 3/4 of the tree.
617 */
618 return a * 3221225473U;
619}
620
Willy Tarreau422a0a52012-10-26 19:47:23 +0200621/* sets the address family to AF_UNSPEC so that is_addr() does not match */
622static inline void clear_addr(struct sockaddr_storage *addr)
623{
624 addr->ss_family = AF_UNSPEC;
625}
626
David du Colombier6f5ccb12011-03-10 22:26:24 +0100627/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
628 * otherwise zero.
629 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200630static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +0100631{
632 int i;
633
634 switch (addr->ss_family) {
635 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +0100636 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100637 case AF_INET6:
638 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
639 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
640 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
641 }
642 return 0;
643}
644
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200645/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
646 * or is a unix address, otherwise returns zero.
647 */
648static inline int is_addr(const struct sockaddr_storage *addr)
649{
650 if (addr->ss_family == AF_UNIX)
651 return 1;
652 else
653 return is_inet_addr(addr);
654}
655
David du Colombier11bcb6c2011-03-24 12:23:00 +0100656/* returns port in network byte order */
657static inline int get_net_port(struct sockaddr_storage *addr)
658{
659 switch (addr->ss_family) {
660 case AF_INET:
661 return ((struct sockaddr_in *)addr)->sin_port;
662 case AF_INET6:
663 return ((struct sockaddr_in6 *)addr)->sin6_port;
664 }
665 return 0;
666}
667
668/* returns port in host byte order */
669static inline int get_host_port(struct sockaddr_storage *addr)
670{
671 switch (addr->ss_family) {
672 case AF_INET:
673 return ntohs(((struct sockaddr_in *)addr)->sin_port);
674 case AF_INET6:
675 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
676 }
677 return 0;
678}
679
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +0200680/* returns address len for <addr>'s family, 0 for unknown families */
681static inline int get_addr_len(const struct sockaddr_storage *addr)
682{
683 switch (addr->ss_family) {
684 case AF_INET:
685 return sizeof(struct sockaddr_in);
686 case AF_INET6:
687 return sizeof(struct sockaddr_in6);
688 case AF_UNIX:
689 return sizeof(struct sockaddr_un);
690 }
691 return 0;
692}
693
David du Colombier11bcb6c2011-03-24 12:23:00 +0100694/* set port in host byte order */
695static inline int set_net_port(struct sockaddr_storage *addr, int port)
696{
697 switch (addr->ss_family) {
698 case AF_INET:
699 ((struct sockaddr_in *)addr)->sin_port = port;
700 case AF_INET6:
701 ((struct sockaddr_in6 *)addr)->sin6_port = port;
702 }
703 return 0;
704}
705
706/* set port in network byte order */
707static inline int set_host_port(struct sockaddr_storage *addr, int port)
708{
709 switch (addr->ss_family) {
710 case AF_INET:
711 ((struct sockaddr_in *)addr)->sin_port = htons(port);
712 case AF_INET6:
713 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
714 }
715 return 0;
716}
717
David du Colombier4f92d322011-03-24 11:09:31 +0100718/* Return true if IPv4 address is part of the network */
719extern int in_net_ipv4(struct in_addr *addr, struct in_addr *mask, struct in_addr *net);
720
721/* Return true if IPv6 address is part of the network */
722extern int in_net_ipv6(struct in6_addr *addr, struct in6_addr *mask, struct in6_addr *net);
723
724/* Map IPv4 adress on IPv6 address, as specified in RFC 3513. */
725extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
726
727/* Map IPv6 adress on IPv4 address, as specified in RFC 3513.
728 * Return true if conversion is possible and false otherwise.
729 */
730extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
731
William Lallemand421f5b52012-02-06 18:15:57 +0100732char *human_time(int t, short hz_div);
733
734extern const char *monthname[];
735
Yuxans Yao4e25b012012-10-19 10:36:09 +0800736/* numeric timezone (that is, the hour and minute offset from UTC) */
737char localtimezone[6];
738
William Lallemand421f5b52012-02-06 18:15:57 +0100739/* date2str_log: write a date in the format :
740 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
741 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
742 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
743 *
744 * without using sprintf. return a pointer to the last char written (\0) or
745 * NULL if there isn't enough space.
746 */
747char *date2str_log(char *dest, struct tm *tm, struct timeval *date, size_t size);
748
749/* gmt2str_log: write a date in the format :
750 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
751 * return a pointer to the last char written (\0) or
752 * NULL if there isn't enough space.
753 */
754char *gmt2str_log(char *dst, struct tm *tm, size_t size);
755
Yuxans Yao4e25b012012-10-19 10:36:09 +0800756/* localdate2str_log: write a date in the format :
757 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
758 * return a pointer to the last char written (\0) or
759 * NULL if there isn't enough space.
760 */
761char *localdate2str_log(char *dst, struct tm *tm, size_t size);
762
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200763/* Dynamically allocates a string of the proper length to hold the formatted
764 * output. NULL is returned on error. The caller is responsible for freeing the
765 * memory area using free(). The resulting string is returned in <out> if the
766 * pointer is not NULL. A previous version of <out> might be used to build the
767 * new string, and it will be freed before returning if it is not NULL, which
768 * makes it possible to build complex strings from iterative calls without
769 * having to care about freeing intermediate values, as in the example below :
770 *
771 * memprintf(&err, "invalid argument: '%s'", arg);
772 * ...
773 * memprintf(&err, "parser said : <%s>\n", *err);
774 * ...
775 * free(*err);
776 *
777 * This means that <err> must be initialized to NULL before first invocation.
778 * The return value also holds the allocated string, which eases error checking
779 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200780 * passed instead and it will be ignored. The returned message will then also
781 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200782 *
783 * It is also convenient to use it without any free except the last one :
784 * err = NULL;
785 * if (!fct1(err)) report(*err);
786 * if (!fct2(err)) report(*err);
787 * if (!fct3(err)) report(*err);
788 * free(*err);
789 */
790char *memprintf(char **out, const char *format, ...)
791 __attribute__ ((format(printf, 2, 3)));
792
Willy Tarreau21c705b2012-09-14 11:40:36 +0200793/* Used to add <level> spaces before each line of <out>, unless there is only one line.
794 * The input argument is automatically freed and reassigned. The result will have to be
795 * freed by the caller.
796 * Example of use :
797 * parse(cmd, &err); (callee: memprintf(&err, ...))
798 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
799 * free(err);
800 */
801char *indent_msg(char **out, int level);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200802
Willy Tarreaudad36a32013-03-11 01:20:04 +0100803/* Convert occurrences of environment variables in the input string to their
804 * corresponding value. A variable is identified as a series of alphanumeric
805 * characters or underscores following a '$' sign. The <in> string must be
806 * free()able. NULL returns NULL. The resulting string might be reallocated if
807 * some expansion is made.
808 */
809char *env_expand(char *in);
810
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200811/* debugging macro to emit messages using write() on fd #-1 so that strace sees
812 * them.
813 */
814#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
815
Willy Tarreau89efaed2013-12-13 15:14:55 +0100816/* used from everywhere just to drain results we don't want to read and which
817 * recent versions of gcc increasingly and annoyingly complain about.
818 */
819extern int shut_your_big_mouth_gcc_int;
820
821/* used from everywhere just to drain results we don't want to read and which
822 * recent versions of gcc increasingly and annoyingly complain about.
823 */
824static inline void shut_your_big_mouth_gcc(int r)
825{
826 shut_your_big_mouth_gcc_int = r;
827}
828
de Lafond Guillaume88c278f2013-04-15 19:27:10 +0200829/* same as strstr() but case-insensitive */
830const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
831
Willy Tarreaubb519c72014-01-28 23:04:39 +0100832
833/************************* Composite address manipulation *********************
834 * Composite addresses are simply unsigned long data in which the higher bits
835 * represent a pointer, and the two lower bits are flags. There are several
836 * places where we just want to associate one or two flags to a pointer (eg,
837 * to type it), and these functions permit this. The pointer is necessarily a
838 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
839 * with the flags.
840 *****************************************************************************/
841
842/* Masks the two lower bits of a composite address and converts it to a
843 * pointer. This is used to mix some bits with some aligned pointers to
844 * structs and to retrieve the original (32-bit aligned) pointer.
845 */
846static inline void *caddr_to_ptr(unsigned long caddr)
847{
848 return (void *)(caddr & ~3UL);
849}
850
851/* Only retrieves the two lower bits of a composite address. This is used to mix
852 * some bits with some aligned pointers to structs and to retrieve the original
853 * data (2 bits).
854 */
855static inline unsigned int caddr_to_data(unsigned long caddr)
856{
857 return (caddr & 3UL);
858}
859
860/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
861 * from <data> to form a composite address. This is used to mix some bits with
862 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
863 * pointer.
864 */
865static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
866{
867 return (((unsigned long)ptr) & ~3UL) + (data & 3);
868}
869
870/* sets the 2 bits of <data> in the <caddr> composite address */
871static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
872{
873 return caddr | (data & 3);
874}
875
876/* clears the 2 bits of <data> in the <caddr> composite address */
877static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
878{
879 return caddr & ~(unsigned long)(data & 3);
880}
881
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200882#endif /* _COMMON_STANDARD_H */