blob: 427d0d7250100f9b1e58e7cac90c11246a24be4a [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 Tarreau588297f2014-06-16 15:16:40 +020055/* maximum quoted string length (truncated above) */
56#define QSTR_SIZE 200
57#define NB_QSTR 10
58
Willy Tarreaubaaee002006-06-26 02:48:02 +020059/****** string-specific macros and functions ******/
60/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
61#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
62
63/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
64#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
65
66/* returns 1 only if only zero or one bit is set in X, which means that X is a
67 * power of 2, and 0 otherwise */
68#define POWEROF2(x) (((x) & ((x)-1)) == 0)
69
Willy Tarreau5b180202010-07-18 10:40:48 +020070/* operators to compare values. They're ordered that way so that the lowest bit
71 * serves as a negation for the test and contains all tests that are not equal.
72 */
73enum {
74 STD_OP_LE = 0, STD_OP_GT = 1,
75 STD_OP_EQ = 2, STD_OP_NE = 3,
76 STD_OP_GE = 4, STD_OP_LT = 5,
77};
78
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010079enum http_scheme {
80 SCH_HTTP,
81 SCH_HTTPS,
82};
83
84struct split_url {
85 enum http_scheme scheme;
86 const char *host;
87 int host_len;
88};
89
Willy Tarreau56adcf22012-12-23 18:00:29 +010090extern int itoa_idx; /* index of next itoa_str to use */
91
Willy Tarreau7d58a632007-01-13 23:06:06 +010092/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020093 * copies at most <size-1> chars from <src> to <dst>. Last char is always
94 * set to 0, unless <size> is 0. The number of chars copied is returned
95 * (excluding the terminating zero).
96 * This code has been optimized for size and speed : on x86, it's 45 bytes
97 * long, uses only registers, and consumes only 4 cycles per char.
98 */
99extern int strlcpy2(char *dst, const char *src, int size);
100
101/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200102 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200103 * the ascii representation for number 'n' in decimal.
104 */
Willy Tarreaue7239b52009-03-29 13:41:58 +0200105extern char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100106extern char *ultoa_r(unsigned long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200107extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200108static inline const char *ultoa(unsigned long n)
109{
110 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
111}
112
William Lallemande7340ec2012-01-24 11:15:39 +0100113/*
114 * unsigned long long ASCII representation
115 *
116 * return the last char '\0' or NULL if no enough
117 * space in dst
118 */
119char *ulltoa(unsigned long long n, char *dst, size_t size);
120
121
122/*
123 * unsigned long ASCII representation
124 *
125 * return the last char '\0' or NULL if no enough
126 * space in dst
127 */
128char *ultoa_o(unsigned long n, char *dst, size_t size);
129
130/*
131 * signed long ASCII representation
132 *
133 * return the last char '\0' or NULL if no enough
134 * space in dst
135 */
136char *ltoa_o(long int n, char *dst, size_t size);
137
138/*
139 * signed long long ASCII representation
140 *
141 * return the last char '\0' or NULL if no enough
142 * space in dst
143 */
144char *lltoa(long long n, char *dst, size_t size);
145
146/*
147 * write a ascii representation of a unsigned into dst,
148 * return a pointer to the last character
149 * Pad the ascii representation with '0', using size.
150 */
151char *utoa_pad(unsigned int n, char *dst, size_t size);
152
Willy Tarreaubaaee002006-06-26 02:48:02 +0200153/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200154 * This function simply returns a locally allocated string containing the ascii
155 * representation for number 'n' in decimal, unless n is 0 in which case it
156 * returns the alternate string (or an empty string if the alternate string is
157 * NULL). It use is intended for limits reported in reports, where it's
158 * desirable not to display anything if there is no limit. Warning! it shares
159 * the same vector as ultoa_r().
160 */
161extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
162
Willy Tarreau56adcf22012-12-23 18:00:29 +0100163/* returns a locally allocated string containing the ASCII representation of
164 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
165 * function call (eg: printf), shared with the other similar functions making
166 * use of itoa_str[].
167 */
168static inline const char *U2A(unsigned long n)
169{
170 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
171 if (++itoa_idx >= NB_ITOA_STR)
172 itoa_idx = 0;
173 return ret;
174}
175
176/* returns a locally allocated string containing the HTML representation of
177 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
178 * function call (eg: printf), shared with the other similar functions making
179 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200180 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100181static inline const char *U2H(unsigned long long n)
182{
183 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
184 if (++itoa_idx >= NB_ITOA_STR)
185 itoa_idx = 0;
186 return ret;
187}
188
189/* returns a locally allocated string containing the HTML representation of
190 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
191 * function call (eg: printf), shared with the other similar functions making
192 * use of itoa_str[].
193 */
194static inline const char *LIM2A(unsigned long n, const char *alt)
195{
196 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
197 if (++itoa_idx >= NB_ITOA_STR)
198 itoa_idx = 0;
199 return ret;
200}
Willy Tarreau91092e52007-10-25 16:58:42 +0200201
Willy Tarreau588297f2014-06-16 15:16:40 +0200202/* returns a locally allocated string containing the quoted encoding of the
203 * input string. The output may be truncated to QSTR_SIZE chars, but it is
204 * guaranteed that the string will always be properly terminated. Quotes are
205 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
206 * always be at least 4 chars.
207 */
208const char *qstr(const char *str);
209
210/* returns <str> or its quote-encoded equivalent if it contains at least one
211 * quote or a comma. This is aimed at build CSV-compatible strings.
212 */
213static inline const char *cstr(const char *str)
214{
215 const char *p = str;
216
217 while (*p) {
218 if (*p == ',' || *p == '"')
219 return qstr(str);
220 p++;
221 }
222 return str;
223}
224
Willy Tarreau91092e52007-10-25 16:58:42 +0200225/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200226 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
227 */
228extern int ishex(char s);
229
230/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100231 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200232 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100233 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200234static inline int hex2i(int c)
235{
Willy Tarreau0161d622013-04-02 01:26:55 +0200236 if (unlikely((unsigned char)(c -= '0') > 9)) {
237 if (likely((unsigned char)(c -= 'A' - '0') > 5 &&
238 (unsigned char)(c -= 'a' - 'A') > 5))
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200239 c = -11;
240 c += 10;
241 }
242 return c;
243}
244
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100245/* rounds <i> down to the closest value having max 2 digits */
246unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100247
248/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100249 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
250 * invalid character is found, a pointer to it is returned. If everything is
251 * fine, NULL is returned.
252 */
253extern const char *invalid_char(const char *name);
254
255/*
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200256 * Checks <domainname> for invalid characters. Valid chars are [A-Za-z0-9_.-].
257 * If an invalid character is found, a pointer to it is returned.
258 * If everything is fine, NULL is returned.
259 */
260extern const char *invalid_domainchar(const char *name);
261
262/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100263 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200264 * port range consisting in two integers. The low and high end are always set
265 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100266 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200267 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100268 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
269 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
270 * address wants to ignore port, it must be terminated by a trailing colon (':').
271 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
272 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100273 * If <pfx> is non-null, it is used as a string prefix before any path-based
274 * address (typically the path to a unix socket).
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200275 */
Willy Tarreaud393a622013-03-04 18:22:00 +0100276struct sockaddr_storage *str2sa_range(const char *str, int *low, int *high, char **err, const char *pfx);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200277
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100278/* converts <str> to a struct in_addr containing a network mask. It can be
279 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
280 * if the conversion succeeds otherwise non-zero.
281 */
282int str2mask(const char *str, struct in_addr *mask);
283
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100284/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
285 * succeeds otherwise non-zero.
286 */
287int cidr2dotted(int cidr, struct in_addr *mask);
288
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200289/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200290 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200291 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
292 * is optionnal and either in the dotted or CIDR notation.
293 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
294 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100295int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200296
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100297/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200298 * converts <str> to two struct in6_addr* which must be pre-allocated.
299 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
300 * is an optionnal number of bits (128 being the default).
301 * Returns 1 if OK, 0 if error.
302 */
303int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
304
305/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200306 * Parse IP address found in url.
307 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100308int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200309
310/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100311 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100312 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100313int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100314
Willy Tarreau631f01c2011-09-05 00:36:48 +0200315/* Tries to convert a sockaddr_storage address to text form. Upon success, the
316 * address family is returned so that it's easy for the caller to adapt to the
317 * output format. Zero is returned if the address family is not supported. -1
318 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
319 * supported.
320 */
321int addr_to_str(struct sockaddr_storage *addr, char *str, int size);
322
Simon Horman75ab8bd2014-06-16 09:39:41 +0900323/* Tries to convert a sockaddr_storage port to text form. Upon success, the
324 * address family is returned so that it's easy for the caller to adapt to the
325 * output format. Zero is returned if the address family is not supported. -1
326 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
327 * supported.
328 */
329int port_to_str(struct sockaddr_storage *addr, char *str, int size);
330
Willy Tarreaubaaee002006-06-26 02:48:02 +0200331/* will try to encode the string <string> replacing all characters tagged in
332 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
333 * prefixed by <escape>, and will store the result between <start> (included)
334 * and <stop> (excluded), and will always terminate the string with a '\0'
335 * before <stop>. The position of the '\0' is returned if the conversion
336 * completes. If bytes are missing between <start> and <stop>, then the
337 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
338 * cannot even be stored so we return <start> without writing the 0.
339 * The input string must also be zero-terminated.
340 */
341extern const char hextab[];
342char *encode_string(char *start, char *stop,
343 const char escape, const fd_set *map,
344 const char *string);
345
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100346/*
347 * Same behavior, except that it encodes chunk <chunk> instead of a string.
348 */
349char *encode_chunk(char *start, char *stop,
350 const char escape, const fd_set *map,
351 const struct chunk *chunk);
352
353
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200354/* Decode an URL-encoded string in-place. The resulting string might
355 * be shorter. If some forbidden characters are found, the conversion is
356 * aborted, the string is truncated before the issue and non-zero is returned,
357 * otherwise the operation returns non-zero indicating success.
358 */
359int url_decode(char *string);
360
Willy Tarreau6911fa42007-03-04 18:06:08 +0100361/* This one is 6 times faster than strtoul() on athlon, but does
362 * no check at all.
363 */
364static inline unsigned int __str2ui(const char *s)
365{
366 unsigned int i = 0;
367 while (*s) {
368 i = i * 10 - '0';
369 i += (unsigned char)*s++;
370 }
371 return i;
372}
373
374/* This one is 5 times faster than strtoul() on athlon with checks.
375 * It returns the value of the number composed of all valid digits read.
376 */
377static inline unsigned int __str2uic(const char *s)
378{
379 unsigned int i = 0;
380 unsigned int j;
381 while (1) {
382 j = (*s++) - '0';
383 if (j > 9)
384 break;
385 i *= 10;
386 i += j;
387 }
388 return i;
389}
390
391/* This one is 28 times faster than strtoul() on athlon, but does
392 * no check at all!
393 */
394static inline unsigned int __strl2ui(const char *s, int len)
395{
396 unsigned int i = 0;
397 while (len-- > 0) {
398 i = i * 10 - '0';
399 i += (unsigned char)*s++;
400 }
401 return i;
402}
403
404/* This one is 7 times faster than strtoul() on athlon with checks.
405 * It returns the value of the number composed of all valid digits read.
406 */
407static inline unsigned int __strl2uic(const char *s, int len)
408{
409 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200410 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100411
412 while (len-- > 0) {
413 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200414 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100415 if (j > 9)
416 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200417 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100418 }
419 return i;
420}
421
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200422/* This function reads an unsigned integer from the string pointed to by <s>
423 * and returns it. The <s> pointer is adjusted to point to the first unread
424 * char. The function automatically stops at <end>.
425 */
426static inline unsigned int __read_uint(const char **s, const char *end)
427{
428 const char *ptr = *s;
429 unsigned int i = 0;
430 unsigned int j, k;
431
432 while (ptr < end) {
433 j = *ptr - '0';
434 k = i * 10;
435 if (j > 9)
436 break;
437 i = k + j;
438 ptr++;
439 }
440 *s = ptr;
441 return i;
442}
443
Willy Tarreau6911fa42007-03-04 18:06:08 +0100444extern unsigned int str2ui(const char *s);
445extern unsigned int str2uic(const char *s);
446extern unsigned int strl2ui(const char *s, int len);
447extern unsigned int strl2uic(const char *s, int len);
448extern int strl2ic(const char *s, int len);
449extern int strl2irc(const char *s, int len, int *ret);
450extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100451extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200452extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200453unsigned int inetaddr_host(const char *text);
454unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200455unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100456
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200457static inline char *cut_crlf(char *s) {
458
Simon Horman5269cfb2013-02-13 17:48:00 +0900459 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200460 char *p = s++;
461
462 if (!*p)
463 return p;
464 }
465
Simon Horman5269cfb2013-02-13 17:48:00 +0900466 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200467
468 return s;
469}
470
471static inline char *ltrim(char *s, char c) {
472
473 if (c)
474 while (*s == c)
475 s++;
476
477 return s;
478}
479
480static inline char *rtrim(char *s, char c) {
481
482 char *p = s + strlen(s);
483
484 while (p-- > s)
485 if (*p == c)
486 *p = '\0';
487 else
488 break;
489
490 return s;
491}
492
493static inline char *alltrim(char *s, char c) {
494
495 rtrim(s, c);
496
497 return ltrim(s, c);
498}
499
Willy Tarreaufe944602007-10-25 10:34:16 +0200500/* This function converts the time_t value <now> into a broken out struct tm
501 * which must be allocated by the caller. It is highly recommended to use this
502 * function intead of localtime() because that one requires a time_t* which
503 * is not always compatible with tv_sec depending on OS/hardware combinations.
504 */
505static inline void get_localtime(const time_t now, struct tm *tm)
506{
507 localtime_r(&now, tm);
508}
509
Emeric Brun3a058f32009-06-30 18:26:00 +0200510/* This function converts the time_t value <now> into a broken out struct tm
511 * which must be allocated by the caller. It is highly recommended to use this
512 * function intead of gmtime() because that one requires a time_t* which
513 * is not always compatible with tv_sec depending on OS/hardware combinations.
514 */
515static inline void get_gmtime(const time_t now, struct tm *tm)
516{
517 gmtime_r(&now, tm);
518}
519
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100520/* This function parses a time value optionally followed by a unit suffix among
521 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
522 * expected by the caller. The computation does its best to avoid overflows.
523 * The value is returned in <ret> if everything is fine, and a NULL is returned
524 * by the function. In case of error, a pointer to the error is returned and
525 * <ret> is left untouched.
526 */
527extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100528extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100529
530/* unit flags to pass to parse_time_err */
531#define TIME_UNIT_US 0x0000
532#define TIME_UNIT_MS 0x0001
533#define TIME_UNIT_S 0x0002
534#define TIME_UNIT_MIN 0x0003
535#define TIME_UNIT_HOUR 0x0004
536#define TIME_UNIT_DAY 0x0005
537#define TIME_UNIT_MASK 0x0007
538
William Lallemand421f5b52012-02-06 18:15:57 +0100539#define SEC 1
540#define MINUTE (60 * SEC)
541#define HOUR (60 * MINUTE)
542#define DAY (24 * HOUR)
543
Willy Tarreau7f062c42009-03-05 18:43:00 +0100544/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
545 * This is used to compute fixed ratios by setting one of the operands to
546 * (2^32*ratio).
547 */
548static inline unsigned int mul32hi(unsigned int a, unsigned int b)
549{
550 return ((unsigned long long)a * b) >> 32;
551}
552
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200553/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
554 * function when you know for sure that the result fits in 32 bits, because
555 * it is optimal on x86 and on 64bit processors.
556 */
557static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
558{
559 unsigned int result;
560#ifdef __i386__
561 asm("divl %2"
562 : "=a" (result)
563 : "A"(o1), "rm"(o2));
564#else
565 result = o1 / o2;
566#endif
567 return result;
568}
569
Willy Tarreau37994f02012-11-19 12:11:07 +0100570/* Simple popcount implementation. It returns the number of ones in a word */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100571static inline unsigned int popcount(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100572{
573 unsigned int cnt;
574 for (cnt = 0; a; a >>= 1) {
575 if (a & 1)
576 cnt++;
577 }
578 return cnt;
579}
580
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100581/* Build a word with the <bits> lower bits set (reverse of popcount) */
582static inline unsigned long nbits(int bits)
583{
584 if (--bits < 0)
585 return 0;
586 else
587 return (2UL << bits) - 1;
588}
589
Willy Tarreau126d4062013-12-03 17:50:47 +0100590/*
591 * Parse binary string written in hexadecimal (source) and store the decoded
592 * result into binstr and set binstrlen to the lengh of binstr. Memory for
593 * binstr is allocated by the function. In case of error, returns 0 with an
594 * error message in err.
595 */
596int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
597
Willy Tarreau946ba592009-05-10 15:41:18 +0200598/* copies at most <n> characters from <src> and always terminates with '\0' */
599char *my_strndup(const char *src, int n);
600
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200601/*
602 * search needle in haystack
603 * returns the pointer if found, returns NULL otherwise
604 */
605const void *my_memmem(const void *, size_t, const void *, size_t);
606
Willy Tarreau482b00d2009-10-04 22:48:42 +0200607/* This function returns the first unused key greater than or equal to <key> in
608 * ID tree <root>. Zero is returned if no place is found.
609 */
610unsigned int get_next_id(struct eb_root *root, unsigned int key);
611
Willy Tarreau348238b2010-01-18 15:05:57 +0100612/* This function compares a sample word possibly followed by blanks to another
613 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
614 * otherwise zero. This intends to be used when checking HTTP headers for some
615 * values.
616 */
617int word_match(const char *sample, int slen, const char *word, int wlen);
618
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200619/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
620 * or the number of chars read in case of success.
621 */
622int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +0100623int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200624
Willy Tarreauacf95772010-06-14 19:09:21 +0200625/* To be used to quote config arg positions. Returns the string at <ptr>
626 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
627 * if ptr is NULL or empty. The string is locally allocated.
628 */
629const char *quote_arg(const char *ptr);
630
Willy Tarreau5b180202010-07-18 10:40:48 +0200631/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
632int get_std_op(const char *str);
633
Willy Tarreau4c14eaa2010-11-24 14:01:45 +0100634/* hash a 32-bit integer to another 32-bit integer */
635extern unsigned int full_hash(unsigned int a);
636static inline unsigned int __full_hash(unsigned int a)
637{
638 /* This function is one of Bob Jenkins' full avalanche hashing
639 * functions, which when provides quite a good distribution for little
640 * input variations. The result is quite suited to fit over a 32-bit
641 * space with enough variations so that a randomly picked number falls
642 * equally before any server position.
643 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
644 */
645 a = (a+0x7ed55d16) + (a<<12);
646 a = (a^0xc761c23c) ^ (a>>19);
647 a = (a+0x165667b1) + (a<<5);
648 a = (a+0xd3a2646c) ^ (a<<9);
649 a = (a+0xfd7046c5) + (a<<3);
650 a = (a^0xb55a4f09) ^ (a>>16);
651
652 /* ensure values are better spread all around the tree by multiplying
653 * by a large prime close to 3/4 of the tree.
654 */
655 return a * 3221225473U;
656}
657
Willy Tarreau422a0a52012-10-26 19:47:23 +0200658/* sets the address family to AF_UNSPEC so that is_addr() does not match */
659static inline void clear_addr(struct sockaddr_storage *addr)
660{
661 addr->ss_family = AF_UNSPEC;
662}
663
David du Colombier6f5ccb12011-03-10 22:26:24 +0100664/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
665 * otherwise zero.
666 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200667static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +0100668{
669 int i;
670
671 switch (addr->ss_family) {
672 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +0100673 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100674 case AF_INET6:
675 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
676 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
677 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
678 }
679 return 0;
680}
681
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200682/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
683 * or is a unix address, otherwise returns zero.
684 */
685static inline int is_addr(const struct sockaddr_storage *addr)
686{
687 if (addr->ss_family == AF_UNIX)
688 return 1;
689 else
690 return is_inet_addr(addr);
691}
692
David du Colombier11bcb6c2011-03-24 12:23:00 +0100693/* returns port in network byte order */
694static inline int get_net_port(struct sockaddr_storage *addr)
695{
696 switch (addr->ss_family) {
697 case AF_INET:
698 return ((struct sockaddr_in *)addr)->sin_port;
699 case AF_INET6:
700 return ((struct sockaddr_in6 *)addr)->sin6_port;
701 }
702 return 0;
703}
704
705/* returns port in host byte order */
706static inline int get_host_port(struct sockaddr_storage *addr)
707{
708 switch (addr->ss_family) {
709 case AF_INET:
710 return ntohs(((struct sockaddr_in *)addr)->sin_port);
711 case AF_INET6:
712 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
713 }
714 return 0;
715}
716
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +0200717/* returns address len for <addr>'s family, 0 for unknown families */
718static inline int get_addr_len(const struct sockaddr_storage *addr)
719{
720 switch (addr->ss_family) {
721 case AF_INET:
722 return sizeof(struct sockaddr_in);
723 case AF_INET6:
724 return sizeof(struct sockaddr_in6);
725 case AF_UNIX:
726 return sizeof(struct sockaddr_un);
727 }
728 return 0;
729}
730
David du Colombier11bcb6c2011-03-24 12:23:00 +0100731/* set port in host byte order */
732static inline int set_net_port(struct sockaddr_storage *addr, int port)
733{
734 switch (addr->ss_family) {
735 case AF_INET:
736 ((struct sockaddr_in *)addr)->sin_port = port;
737 case AF_INET6:
738 ((struct sockaddr_in6 *)addr)->sin6_port = port;
739 }
740 return 0;
741}
742
743/* set port in network byte order */
744static inline int set_host_port(struct sockaddr_storage *addr, int port)
745{
746 switch (addr->ss_family) {
747 case AF_INET:
748 ((struct sockaddr_in *)addr)->sin_port = htons(port);
749 case AF_INET6:
750 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
751 }
752 return 0;
753}
754
David du Colombier4f92d322011-03-24 11:09:31 +0100755/* Return true if IPv4 address is part of the network */
756extern int in_net_ipv4(struct in_addr *addr, struct in_addr *mask, struct in_addr *net);
757
758/* Return true if IPv6 address is part of the network */
759extern int in_net_ipv6(struct in6_addr *addr, struct in6_addr *mask, struct in6_addr *net);
760
761/* Map IPv4 adress on IPv6 address, as specified in RFC 3513. */
762extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
763
764/* Map IPv6 adress on IPv4 address, as specified in RFC 3513.
765 * Return true if conversion is possible and false otherwise.
766 */
767extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
768
William Lallemand421f5b52012-02-06 18:15:57 +0100769char *human_time(int t, short hz_div);
770
771extern const char *monthname[];
772
Yuxans Yao4e25b012012-10-19 10:36:09 +0800773/* numeric timezone (that is, the hour and minute offset from UTC) */
774char localtimezone[6];
775
William Lallemand421f5b52012-02-06 18:15:57 +0100776/* date2str_log: write a date in the format :
777 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
778 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
779 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
780 *
781 * without using sprintf. return a pointer to the last char written (\0) or
782 * NULL if there isn't enough space.
783 */
784char *date2str_log(char *dest, struct tm *tm, struct timeval *date, size_t size);
785
786/* gmt2str_log: write a date in the format :
787 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
788 * return a pointer to the last char written (\0) or
789 * NULL if there isn't enough space.
790 */
791char *gmt2str_log(char *dst, struct tm *tm, size_t size);
792
Yuxans Yao4e25b012012-10-19 10:36:09 +0800793/* localdate2str_log: write a date in the format :
794 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
795 * return a pointer to the last char written (\0) or
796 * NULL if there isn't enough space.
797 */
798char *localdate2str_log(char *dst, struct tm *tm, size_t size);
799
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200800/* Dynamically allocates a string of the proper length to hold the formatted
801 * output. NULL is returned on error. The caller is responsible for freeing the
802 * memory area using free(). The resulting string is returned in <out> if the
803 * pointer is not NULL. A previous version of <out> might be used to build the
804 * new string, and it will be freed before returning if it is not NULL, which
805 * makes it possible to build complex strings from iterative calls without
806 * having to care about freeing intermediate values, as in the example below :
807 *
808 * memprintf(&err, "invalid argument: '%s'", arg);
809 * ...
810 * memprintf(&err, "parser said : <%s>\n", *err);
811 * ...
812 * free(*err);
813 *
814 * This means that <err> must be initialized to NULL before first invocation.
815 * The return value also holds the allocated string, which eases error checking
816 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200817 * passed instead and it will be ignored. The returned message will then also
818 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +0200819 *
820 * It is also convenient to use it without any free except the last one :
821 * err = NULL;
822 * if (!fct1(err)) report(*err);
823 * if (!fct2(err)) report(*err);
824 * if (!fct3(err)) report(*err);
825 * free(*err);
826 */
827char *memprintf(char **out, const char *format, ...)
828 __attribute__ ((format(printf, 2, 3)));
829
Willy Tarreau21c705b2012-09-14 11:40:36 +0200830/* Used to add <level> spaces before each line of <out>, unless there is only one line.
831 * The input argument is automatically freed and reassigned. The result will have to be
832 * freed by the caller.
833 * Example of use :
834 * parse(cmd, &err); (callee: memprintf(&err, ...))
835 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
836 * free(err);
837 */
838char *indent_msg(char **out, int level);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200839
Willy Tarreaudad36a32013-03-11 01:20:04 +0100840/* Convert occurrences of environment variables in the input string to their
841 * corresponding value. A variable is identified as a series of alphanumeric
842 * characters or underscores following a '$' sign. The <in> string must be
843 * free()able. NULL returns NULL. The resulting string might be reallocated if
844 * some expansion is made.
845 */
846char *env_expand(char *in);
847
Willy Tarreau3d2f16f2012-05-13 00:21:17 +0200848/* debugging macro to emit messages using write() on fd #-1 so that strace sees
849 * them.
850 */
851#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
852
Willy Tarreau89efaed2013-12-13 15:14:55 +0100853/* used from everywhere just to drain results we don't want to read and which
854 * recent versions of gcc increasingly and annoyingly complain about.
855 */
856extern int shut_your_big_mouth_gcc_int;
857
858/* used from everywhere just to drain results we don't want to read and which
859 * recent versions of gcc increasingly and annoyingly complain about.
860 */
861static inline void shut_your_big_mouth_gcc(int r)
862{
863 shut_your_big_mouth_gcc_int = r;
864}
865
de Lafond Guillaume88c278f2013-04-15 19:27:10 +0200866/* same as strstr() but case-insensitive */
867const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
868
Willy Tarreaubb519c72014-01-28 23:04:39 +0100869
870/************************* Composite address manipulation *********************
871 * Composite addresses are simply unsigned long data in which the higher bits
872 * represent a pointer, and the two lower bits are flags. There are several
873 * places where we just want to associate one or two flags to a pointer (eg,
874 * to type it), and these functions permit this. The pointer is necessarily a
875 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
876 * with the flags.
877 *****************************************************************************/
878
879/* Masks the two lower bits of a composite address and converts it to a
880 * pointer. This is used to mix some bits with some aligned pointers to
881 * structs and to retrieve the original (32-bit aligned) pointer.
882 */
883static inline void *caddr_to_ptr(unsigned long caddr)
884{
885 return (void *)(caddr & ~3UL);
886}
887
888/* Only retrieves the two lower bits of a composite address. This is used to mix
889 * some bits with some aligned pointers to structs and to retrieve the original
890 * data (2 bits).
891 */
892static inline unsigned int caddr_to_data(unsigned long caddr)
893{
894 return (caddr & 3UL);
895}
896
897/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
898 * from <data> to form a composite address. This is used to mix some bits with
899 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
900 * pointer.
901 */
902static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
903{
904 return (((unsigned long)ptr) & ~3UL) + (data & 3);
905}
906
907/* sets the 2 bits of <data> in the <caddr> composite address */
908static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
909{
910 return caddr | (data & 3);
911}
912
913/* clears the 2 bits of <data> in the <caddr> composite address */
914static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
915{
916 return caddr & ~(unsigned long)(data & 3);
917}
918
Thierry FOURNIER317e1c42014-08-12 10:20:47 +0200919/* UTF-8 decoder status */
920#define UTF8_CODE_OK 0x00
921#define UTF8_CODE_OVERLONG 0x10
922#define UTF8_CODE_INVRANGE 0x20
923#define UTF8_CODE_BADSEQ 0x40
924
925unsigned char utf8_next(const char *s, int len, unsigned int *c);
926
927static inline unsigned char utf8_return_code(unsigned int code)
928{
929 return code & 0xf0;
930}
931
932static inline unsigned char utf8_return_length(unsigned char code)
933{
934 return code & 0x0f;
935}
936
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200937#endif /* _COMMON_STANDARD_H */