blob: 18d90566d14ba2ccec2442f95902c98751972c3c [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreaucc05fba2009-10-27 21:40:18 +01002 * include/common/standard.h
3 * This files contains some general purpose functions and macros.
4 *
Willy Tarreau348238b2010-01-18 15:05:57 +01005 * Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu
Willy Tarreaucc05fba2009-10-27 21:40:18 +01006 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020021
Willy Tarreau2dd0d472006-06-29 17:53:05 +020022#ifndef _COMMON_STANDARD_H
23#define _COMMON_STANDARD_H
Willy Tarreaubaaee002006-06-26 02:48:02 +020024
Willy Tarreau167d8b52007-04-09 22:16:12 +020025#include <limits.h>
Willy Tarreau050737f2010-01-14 11:40:12 +010026#include <string.h>
Willy Tarreau0ebb5112016-12-05 00:10:57 +010027#include <stdio.h>
Willy Tarreaufe944602007-10-25 10:34:16 +020028#include <time.h>
Willy Tarreaue6e49cf2015-04-29 17:13:35 +020029#include <sys/time.h>
Willy Tarreau938b3032007-05-10 06:39:03 +020030#include <sys/types.h>
Willy Tarreaud50265a2012-09-04 14:18:33 +020031#include <sys/socket.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020032#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020033#include <netinet/in.h>
Willy Tarreau5b4dd682015-07-21 23:47:18 +020034#include <arpa/inet.h>
Thierry FOURNIERe059ec92014-03-17 12:01:13 +010035#include <common/chunk.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020036#include <common/config.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020037#include <common/namespace.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010038#include <eb32tree.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020039
William Lallemande7340ec2012-01-24 11:15:39 +010040#ifndef LLONG_MAX
41# define LLONG_MAX 9223372036854775807LL
42# define LLONG_MIN (-LLONG_MAX - 1LL)
43#endif
44
45#ifndef ULLONG_MAX
46# define ULLONG_MAX (LLONG_MAX * 2ULL + 1)
47#endif
48
Willy Tarreaua9db57e2013-01-18 11:29:29 +010049#ifndef LONGBITS
50#define LONGBITS ((unsigned int)sizeof(long) * 8)
51#endif
52
Thierry FOURNIER511e9472014-01-23 17:40:34 +010053/* size used for max length of decimal representation of long long int. */
54#define NB_LLMAX_STR (sizeof("-9223372036854775807")-1)
55
Willy Tarreau56adcf22012-12-23 18:00:29 +010056/* number of itoa_str entries */
57#define NB_ITOA_STR 10
William Lallemande7340ec2012-01-24 11:15:39 +010058
Willy Tarreau588297f2014-06-16 15:16:40 +020059/* maximum quoted string length (truncated above) */
60#define QSTR_SIZE 200
61#define NB_QSTR 10
62
Willy Tarreaubaaee002006-06-26 02:48:02 +020063/****** string-specific macros and functions ******/
64/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
65#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
66
67/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
68#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
69
70/* returns 1 only if only zero or one bit is set in X, which means that X is a
71 * power of 2, and 0 otherwise */
72#define POWEROF2(x) (((x) & ((x)-1)) == 0)
73
Willy Tarreau5b180202010-07-18 10:40:48 +020074/* operators to compare values. They're ordered that way so that the lowest bit
75 * serves as a negation for the test and contains all tests that are not equal.
76 */
77enum {
78 STD_OP_LE = 0, STD_OP_GT = 1,
79 STD_OP_EQ = 2, STD_OP_NE = 3,
80 STD_OP_GE = 4, STD_OP_LT = 5,
81};
82
Thierry FOURNIER9f95e402014-03-21 14:51:46 +010083enum http_scheme {
84 SCH_HTTP,
85 SCH_HTTPS,
86};
87
88struct split_url {
89 enum http_scheme scheme;
90 const char *host;
91 int host_len;
92};
93
Willy Tarreau56adcf22012-12-23 18:00:29 +010094extern int itoa_idx; /* index of next itoa_str to use */
95
Willy Tarreau7d58a632007-01-13 23:06:06 +010096/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020097 * copies at most <size-1> chars from <src> to <dst>. Last char is always
98 * set to 0, unless <size> is 0. The number of chars copied is returned
99 * (excluding the terminating zero).
100 * This code has been optimized for size and speed : on x86, it's 45 bytes
101 * long, uses only registers, and consumes only 4 cycles per char.
102 */
103extern int strlcpy2(char *dst, const char *src, int size);
104
105/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200106 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200107 * the ascii representation for number 'n' in decimal.
108 */
Willy Tarreaue7239b52009-03-29 13:41:58 +0200109extern char itoa_str[][171];
Emeric Brun3a7fce52010-01-04 14:54:38 +0100110extern char *ultoa_r(unsigned long n, char *buffer, int size);
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200111extern char *lltoa_r(long long int n, char *buffer, int size);
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200112extern char *sltoa_r(long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +0200113extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +0200114static inline const char *ultoa(unsigned long n)
115{
116 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
117}
118
William Lallemande7340ec2012-01-24 11:15:39 +0100119/*
120 * unsigned long long ASCII representation
121 *
122 * return the last char '\0' or NULL if no enough
123 * space in dst
124 */
125char *ulltoa(unsigned long long n, char *dst, size_t size);
126
127
128/*
129 * unsigned long ASCII representation
130 *
131 * return the last char '\0' or NULL if no enough
132 * space in dst
133 */
134char *ultoa_o(unsigned long n, char *dst, size_t size);
135
136/*
137 * signed long ASCII representation
138 *
139 * return the last char '\0' or NULL if no enough
140 * space in dst
141 */
142char *ltoa_o(long int n, char *dst, size_t size);
143
144/*
145 * signed long long ASCII representation
146 *
147 * return the last char '\0' or NULL if no enough
148 * space in dst
149 */
150char *lltoa(long long n, char *dst, size_t size);
151
152/*
153 * write a ascii representation of a unsigned into dst,
154 * return a pointer to the last character
155 * Pad the ascii representation with '0', using size.
156 */
157char *utoa_pad(unsigned int n, char *dst, size_t size);
158
Willy Tarreaubaaee002006-06-26 02:48:02 +0200159/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200160 * This function simply returns a locally allocated string containing the ascii
161 * representation for number 'n' in decimal, unless n is 0 in which case it
162 * returns the alternate string (or an empty string if the alternate string is
163 * NULL). It use is intended for limits reported in reports, where it's
164 * desirable not to display anything if there is no limit. Warning! it shares
165 * the same vector as ultoa_r().
166 */
167extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
168
Willy Tarreau56adcf22012-12-23 18:00:29 +0100169/* returns a locally allocated string containing the ASCII representation of
170 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
171 * function call (eg: printf), shared with the other similar functions making
172 * use of itoa_str[].
173 */
174static inline const char *U2A(unsigned long n)
175{
176 const char *ret = ultoa_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
177 if (++itoa_idx >= NB_ITOA_STR)
178 itoa_idx = 0;
179 return ret;
180}
181
182/* returns a locally allocated string containing the HTML representation of
183 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
184 * function call (eg: printf), shared with the other similar functions making
185 * use of itoa_str[].
Willy Tarreau91092e52007-10-25 16:58:42 +0200186 */
Willy Tarreau56adcf22012-12-23 18:00:29 +0100187static inline const char *U2H(unsigned long long n)
188{
189 const char *ret = ulltoh_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]));
190 if (++itoa_idx >= NB_ITOA_STR)
191 itoa_idx = 0;
192 return ret;
193}
194
195/* returns a locally allocated string containing the HTML representation of
196 * the number 'n' in decimal. Up to NB_ITOA_STR calls may be used in the same
197 * function call (eg: printf), shared with the other similar functions making
198 * use of itoa_str[].
199 */
200static inline const char *LIM2A(unsigned long n, const char *alt)
201{
202 const char *ret = limit_r(n, itoa_str[itoa_idx], sizeof(itoa_str[0]), alt);
203 if (++itoa_idx >= NB_ITOA_STR)
204 itoa_idx = 0;
205 return ret;
206}
Willy Tarreau91092e52007-10-25 16:58:42 +0200207
Thierry FOURNIER6ab2bae2017-04-19 11:49:44 +0200208/* Encode the integer <i> into a varint (variable-length integer). The encoded
209 * value is copied in <*buf>. Here is the encoding format:
210 *
211 * 0 <= X < 240 : 1 byte (7.875 bits) [ XXXX XXXX ]
212 * 240 <= X < 2288 : 2 bytes (11 bits) [ 1111 XXXX ] [ 0XXX XXXX ]
213 * 2288 <= X < 264432 : 3 bytes (18 bits) [ 1111 XXXX ] [ 1XXX XXXX ] [ 0XXX XXXX ]
214 * 264432 <= X < 33818864 : 4 bytes (25 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*2 [ 0XXX XXXX ]
215 * 33818864 <= X < 4328786160 : 5 bytes (32 bits) [ 1111 XXXX ] [ 1XXX XXXX ]*3 [ 0XXX XXXX ]
216 * ...
217 *
218 * On success, it returns the number of written bytes and <*buf> is moved after
219 * the encoded value. Otherwise, it returns -1. */
220static inline int
221encode_varint(uint64_t i, char **buf, char *end)
222{
223 unsigned char *p = (unsigned char *)*buf;
224 int r;
225
226 if (p >= (unsigned char *)end)
227 return -1;
228
229 if (i < 240) {
230 *p++ = i;
231 *buf = (char *)p;
232 return 1;
233 }
234
235 *p++ = (unsigned char)i | 240;
236 i = (i - 240) >> 4;
237 while (i >= 128) {
238 if (p >= (unsigned char *)end)
239 return -1;
240 *p++ = (unsigned char)i | 128;
241 i = (i - 128) >> 7;
242 }
243
244 if (p >= (unsigned char *)end)
245 return -1;
246 *p++ = (unsigned char)i;
247
248 r = ((char *)p - *buf);
249 *buf = (char *)p;
250 return r;
251}
252
253/* Decode a varint from <*buf> and save the decoded value in <*i>. See
254 * 'spoe_encode_varint' for details about varint.
255 * On success, it returns the number of read bytes and <*buf> is moved after the
256 * varint. Otherwise, it returns -1. */
257static inline int
258decode_varint(char **buf, char *end, uint64_t *i)
259{
260 unsigned char *p = (unsigned char *)*buf;
261 int r;
262
263 if (p >= (unsigned char *)end)
264 return -1;
265
266 *i = *p++;
267 if (*i < 240) {
268 *buf = (char *)p;
269 return 1;
270 }
271
272 r = 4;
273 do {
274 if (p >= (unsigned char *)end)
275 return -1;
276 *i += (uint64_t)*p << r;
277 r += 7;
278 } while (*p++ >= 128);
279
280 r = ((char *)p - *buf);
281 *buf = (char *)p;
282 return r;
283}
284
Willy Tarreau588297f2014-06-16 15:16:40 +0200285/* returns a locally allocated string containing the quoted encoding of the
286 * input string. The output may be truncated to QSTR_SIZE chars, but it is
287 * guaranteed that the string will always be properly terminated. Quotes are
288 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
289 * always be at least 4 chars.
290 */
291const char *qstr(const char *str);
292
293/* returns <str> or its quote-encoded equivalent if it contains at least one
294 * quote or a comma. This is aimed at build CSV-compatible strings.
295 */
296static inline const char *cstr(const char *str)
297{
298 const char *p = str;
299
300 while (*p) {
301 if (*p == ',' || *p == '"')
302 return qstr(str);
303 p++;
304 }
305 return str;
306}
307
Willy Tarreau91092e52007-10-25 16:58:42 +0200308/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200309 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
310 */
311extern int ishex(char s);
312
313/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100314 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200315 * otherwise -1. This compact form helps gcc produce efficient code.
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100316 */
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200317static inline int hex2i(int c)
318{
Willy Tarreau0161d622013-04-02 01:26:55 +0200319 if (unlikely((unsigned char)(c -= '0') > 9)) {
320 if (likely((unsigned char)(c -= 'A' - '0') > 5 &&
321 (unsigned char)(c -= 'a' - 'A') > 5))
Willy Tarreau3dd0c4e2012-10-26 00:58:22 +0200322 c = -11;
323 c += 10;
324 }
325 return c;
326}
327
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100328/* rounds <i> down to the closest value having max 2 digits */
329unsigned int round_2dig(unsigned int i);
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100330
331/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100332 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
333 * invalid character is found, a pointer to it is returned. If everything is
334 * fine, NULL is returned.
335 */
336extern const char *invalid_char(const char *name);
337
338/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200339 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200340 * If an invalid character is found, a pointer to it is returned.
341 * If everything is fine, NULL is returned.
342 */
343extern const char *invalid_domainchar(const char *name);
344
345/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200346 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
347 * If an invalid character is found, a pointer to it is returned.
348 * If everything is fine, NULL is returned.
349 */
350extern const char *invalid_prefix_char(const char *name);
351
352/*
Willy Tarreaufab5a432011-03-04 15:31:53 +0100353 * converts <str> to a locally allocated struct sockaddr_storage *, and a
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200354 * port range consisting in two integers. The low and high end are always set
355 * even if the port is unspecified, in which case (0,0) is returned. The low
Willy Tarreaufab5a432011-03-04 15:31:53 +0100356 * port is set in the sockaddr. Thus, it is enough to check the size of the
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200357 * returned range to know if an array must be allocated or not. The format is
Willy Tarreaufab5a432011-03-04 15:31:53 +0100358 * "addr[:[port[-port]]]", where "addr" can be a dotted IPv4 address, an IPv6
359 * address, a host name, or empty or "*" to indicate INADDR_ANY. If an IPv6
360 * address wants to ignore port, it must be terminated by a trailing colon (':').
361 * The IPv6 '::' address is IN6ADDR_ANY, so in order to bind to a given port on
362 * IPv6, use ":::port". NULL is returned if the host part cannot be resolved.
Willy Tarreaud393a622013-03-04 18:22:00 +0100363 * If <pfx> is non-null, it is used as a string prefix before any path-based
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200364 * address (typically the path to a unix socket). If use_dns is not true,
365 * the funtion cannot accept the DNS resolution.
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200366 */
Willy Tarreau48ef4c92017-01-06 18:32:38 +0100367struct sockaddr_storage *str2sa_range(const char *str,
368 int *port, int *low, int *high,
369 char **err, const char *pfx,
370 char **fqdn, int resolve);
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200371
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100372/* converts <str> to a struct in_addr containing a network mask. It can be
373 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +0300374 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +0100375 */
376int str2mask(const char *str, struct in_addr *mask);
377
Thierry FOURNIERb0504632013-12-14 15:39:02 +0100378/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
379 * succeeds otherwise non-zero.
380 */
381int cidr2dotted(int cidr, struct in_addr *mask);
382
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200383/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200384 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200385 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
386 * is optionnal and either in the dotted or CIDR notation.
387 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
388 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +0100389int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200390
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100391/* str2ip and str2ip2:
392 *
393 * converts <str> to a struct sockaddr_storage* provided by the caller. The
394 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
395 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
396 * the function tries to guess the address family from the syntax. If the
397 * family is forced and the format doesn't match, an error is returned. The
398 * string is assumed to contain only an address, no port. The address can be a
399 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
400 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
401 * The return address will only have the address family and the address set,
402 * all other fields remain zero. The string is not supposed to be modified.
403 * The IPv6 '::' address is IN6ADDR_ANY.
404 *
405 * str2ip2:
406 *
407 * If <resolve> is set, this function try to resolve DNS, otherwise, it returns
408 * NULL result.
409 */
410struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve);
411static inline struct sockaddr_storage *str2ip(const char *str, struct sockaddr_storage *sa)
412{
413 return str2ip2(str, sa, 1);
414}
415
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100416/*
Willy Tarreau6d20e282012-04-27 22:49:47 +0200417 * converts <str> to two struct in6_addr* which must be pre-allocated.
418 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
419 * is an optionnal number of bits (128 being the default).
420 * Returns 1 if OK, 0 if error.
421 */
422int str62net(const char *str, struct in6_addr *addr, unsigned char *mask);
423
424/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200425 * Parse IP address found in url.
426 */
David du Colombier6f5ccb12011-03-10 22:26:24 +0100427int url2ipv4(const char *addr, struct in_addr *dst);
Willy Tarreau106f9792009-09-19 07:54:16 +0200428
429/*
David du Colombier6f5ccb12011-03-10 22:26:24 +0100430 * Resolve destination server from URL. Convert <str> to a sockaddr_storage*.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100431 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +0100432int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out);
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100433
Willy Tarreau631f01c2011-09-05 00:36:48 +0200434/* Tries to convert a sockaddr_storage address to text form. Upon success, the
435 * address family is returned so that it's easy for the caller to adapt to the
436 * output format. Zero is returned if the address family is not supported. -1
437 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
438 * supported.
439 */
440int addr_to_str(struct sockaddr_storage *addr, char *str, int size);
441
Simon Horman75ab8bd2014-06-16 09:39:41 +0900442/* Tries to convert a sockaddr_storage port to text form. Upon success, the
443 * address family is returned so that it's easy for the caller to adapt to the
444 * output format. Zero is returned if the address family is not supported. -1
445 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
446 * supported.
447 */
448int port_to_str(struct sockaddr_storage *addr, char *str, int size);
449
Willy Tarreau16e01562016-08-09 16:46:18 +0200450/* check if the given address is local to the system or not. It will return
451 * -1 when it's not possible to know, 0 when the address is not local, 1 when
452 * it is. We don't want to iterate over all interfaces for this (and it is not
453 * portable). So instead we try to bind in UDP to this address on a free non
454 * privileged port and to connect to the same address, port 0 (connect doesn't
455 * care). If it succeeds, we own the address. Note that non-inet addresses are
456 * considered local since they're most likely AF_UNIX.
457 */
458int addr_is_local(const struct netns_entry *ns,
459 const struct sockaddr_storage *orig);
460
Willy Tarreaubaaee002006-06-26 02:48:02 +0200461/* will try to encode the string <string> replacing all characters tagged in
462 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
463 * prefixed by <escape>, and will store the result between <start> (included)
464 * and <stop> (excluded), and will always terminate the string with a '\0'
465 * before <stop>. The position of the '\0' is returned if the conversion
466 * completes. If bytes are missing between <start> and <stop>, then the
467 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
468 * cannot even be stored so we return <start> without writing the 0.
469 * The input string must also be zero-terminated.
470 */
471extern const char hextab[];
472char *encode_string(char *start, char *stop,
473 const char escape, const fd_set *map,
474 const char *string);
475
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100476/*
477 * Same behavior, except that it encodes chunk <chunk> instead of a string.
478 */
479char *encode_chunk(char *start, char *stop,
480 const char escape, const fd_set *map,
481 const struct chunk *chunk);
482
Dragan Dosen0edd1092016-02-12 13:23:02 +0100483/*
484 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +0200485 * character. The input <string> must be zero-terminated. The result will
486 * be stored between <start> (included) and <stop> (excluded). This
487 * function will always try to terminate the resulting string with a '\0'
488 * before <stop>, and will return its position if the conversion
489 * completes.
490 */
491char *escape_string(char *start, char *stop,
492 const char escape, const fd_set *map,
493 const char *string);
494
495/*
496 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +0100497 * character. <chunk> contains the input to be escaped. The result will be
498 * stored between <start> (included) and <stop> (excluded). The function
499 * will always try to terminate the resulting string with a '\0' before
500 * <stop>, and will return its position if the conversion completes.
501 */
502char *escape_chunk(char *start, char *stop,
503 const char escape, const fd_set *map,
504 const struct chunk *chunk);
505
Thierry FOURNIERe059ec92014-03-17 12:01:13 +0100506
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200507/* Check a string for using it in a CSV output format. If the string contains
508 * one of the following four char <">, <,>, CR or LF, the string is
509 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
510 * <str> is the input string to be escaped. The function assumes that
511 * the input string is null-terminated.
512 *
513 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +0100514 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200515 * format.
516 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100517 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200518 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100519 * If <quote> is 1, the converter puts the quotes only if any character is
520 * escaped. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200521 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100522 * <output> is a struct chunk used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200523 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100524 * The function returns the converted string on its output. If an error
525 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200526 * for using the function directly as printf() argument.
527 *
Willy Tarreau898529b2016-01-06 18:07:04 +0100528 * If the output buffer is too short to contain the input string, the result
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200529 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +0100530 *
531 * This function appends the encoding to the existing output chunk. Please
532 * use csv_enc() instead if you want to replace the output chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200533 */
Willy Tarreau898529b2016-01-06 18:07:04 +0100534const char *csv_enc_append(const char *str, int quote, struct chunk *output);
535
536/* same as above but the output chunk is reset first */
537static inline const char *csv_enc(const char *str, int quote, struct chunk *output)
538{
539 chunk_reset(output);
540 return csv_enc_append(str, quote, output);
541}
Thierry FOURNIERddea6262015-05-28 16:00:28 +0200542
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +0200543/* Decode an URL-encoded string in-place. The resulting string might
544 * be shorter. If some forbidden characters are found, the conversion is
545 * aborted, the string is truncated before the issue and non-zero is returned,
546 * otherwise the operation returns non-zero indicating success.
547 */
548int url_decode(char *string);
549
Willy Tarreau6911fa42007-03-04 18:06:08 +0100550/* This one is 6 times faster than strtoul() on athlon, but does
551 * no check at all.
552 */
553static inline unsigned int __str2ui(const char *s)
554{
555 unsigned int i = 0;
556 while (*s) {
557 i = i * 10 - '0';
558 i += (unsigned char)*s++;
559 }
560 return i;
561}
562
563/* This one is 5 times faster than strtoul() on athlon with checks.
564 * It returns the value of the number composed of all valid digits read.
565 */
566static inline unsigned int __str2uic(const char *s)
567{
568 unsigned int i = 0;
569 unsigned int j;
570 while (1) {
571 j = (*s++) - '0';
572 if (j > 9)
573 break;
574 i *= 10;
575 i += j;
576 }
577 return i;
578}
579
580/* This one is 28 times faster than strtoul() on athlon, but does
581 * no check at all!
582 */
583static inline unsigned int __strl2ui(const char *s, int len)
584{
585 unsigned int i = 0;
586 while (len-- > 0) {
587 i = i * 10 - '0';
588 i += (unsigned char)*s++;
589 }
590 return i;
591}
592
593/* This one is 7 times faster than strtoul() on athlon with checks.
594 * It returns the value of the number composed of all valid digits read.
595 */
596static inline unsigned int __strl2uic(const char *s, int len)
597{
598 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200599 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100600
601 while (len-- > 0) {
602 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200603 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100604 if (j > 9)
605 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200606 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100607 }
608 return i;
609}
610
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200611/* This function reads an unsigned integer from the string pointed to by <s>
612 * and returns it. The <s> pointer is adjusted to point to the first unread
613 * char. The function automatically stops at <end>.
614 */
615static inline unsigned int __read_uint(const char **s, const char *end)
616{
617 const char *ptr = *s;
618 unsigned int i = 0;
619 unsigned int j, k;
620
621 while (ptr < end) {
622 j = *ptr - '0';
623 k = i * 10;
624 if (j > 9)
625 break;
626 i = k + j;
627 ptr++;
628 }
629 *s = ptr;
630 return i;
631}
632
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200633unsigned long long int read_uint64(const char **s, const char *end);
634long long int read_int64(const char **s, const char *end);
635
Willy Tarreau6911fa42007-03-04 18:06:08 +0100636extern unsigned int str2ui(const char *s);
637extern unsigned int str2uic(const char *s);
638extern unsigned int strl2ui(const char *s, int len);
639extern unsigned int strl2uic(const char *s, int len);
640extern int strl2ic(const char *s, int len);
641extern int strl2irc(const char *s, int len, int *ret);
642extern int strl2llrc(const char *s, int len, long long *ret);
Thierry FOURNIER511e9472014-01-23 17:40:34 +0100643extern int strl2llrc_dotted(const char *text, int len, long long *ret);
Willy Tarreau4ec83cd2010-10-15 23:19:55 +0200644extern unsigned int read_uint(const char **s, const char *end);
Willy Tarreaud54bbdc2009-09-07 11:00:31 +0200645unsigned int inetaddr_host(const char *text);
646unsigned int inetaddr_host_lim(const char *text, const char *stop);
Willy Tarreau74172752010-10-15 23:21:42 +0200647unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret);
Willy Tarreau6911fa42007-03-04 18:06:08 +0100648
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200649static inline char *cut_crlf(char *s) {
650
Simon Horman5269cfb2013-02-13 17:48:00 +0900651 while (*s != '\r' && *s != '\n') {
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200652 char *p = s++;
653
654 if (!*p)
655 return p;
656 }
657
Simon Horman5269cfb2013-02-13 17:48:00 +0900658 *s++ = '\0';
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200659
660 return s;
661}
662
663static inline char *ltrim(char *s, char c) {
664
665 if (c)
666 while (*s == c)
667 s++;
668
669 return s;
670}
671
672static inline char *rtrim(char *s, char c) {
673
674 char *p = s + strlen(s);
675
676 while (p-- > s)
677 if (*p == c)
678 *p = '\0';
679 else
680 break;
681
682 return s;
683}
684
685static inline char *alltrim(char *s, char c) {
686
687 rtrim(s, c);
688
689 return ltrim(s, c);
690}
691
Willy Tarreaufe944602007-10-25 10:34:16 +0200692/* This function converts the time_t value <now> into a broken out struct tm
693 * which must be allocated by the caller. It is highly recommended to use this
694 * function intead of localtime() because that one requires a time_t* which
695 * is not always compatible with tv_sec depending on OS/hardware combinations.
696 */
697static inline void get_localtime(const time_t now, struct tm *tm)
698{
699 localtime_r(&now, tm);
700}
701
Emeric Brun3a058f32009-06-30 18:26:00 +0200702/* This function converts the time_t value <now> into a broken out struct tm
703 * which must be allocated by the caller. It is highly recommended to use this
704 * function intead of gmtime() because that one requires a time_t* which
705 * is not always compatible with tv_sec depending on OS/hardware combinations.
706 */
707static inline void get_gmtime(const time_t now, struct tm *tm)
708{
709 gmtime_r(&now, tm);
710}
711
Willy Tarreaucb1949b2017-07-19 19:05:29 +0200712/* Counts a number of elapsed days since 01/01/0000 based solely on elapsed
713 * years and assuming the regular rule for leap years applies. It's fake but
714 * serves as a temporary origin. It's worth remembering that it's the first
715 * year of each period that is leap and not the last one, so for instance year
716 * 1 sees 366 days since year 0 was leap. For this reason we have to apply
717 * modular arithmetics which is why we offset the year by 399 before
718 * subtracting the excess at the end. No overflow here before ~11.7 million
719 * years.
720 */
721static inline unsigned int days_since_zero(unsigned int y)
722{
723 return y * 365 + (y + 399) / 4 - (y + 399) / 100 + (y + 399) / 400
724 - 399 / 4 + 399 / 100;
725}
726
727/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
728 * It is meant as a portable replacement for timegm() for use with valid inputs.
729 * Returns undefined results for invalid dates (eg: months out of range 0..11).
730 */
731extern time_t my_timegm(const struct tm *tm);
732
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100733/* This function parses a time value optionally followed by a unit suffix among
734 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
735 * expected by the caller. The computation does its best to avoid overflows.
736 * The value is returned in <ret> if everything is fine, and a NULL is returned
737 * by the function. In case of error, a pointer to the error is returned and
738 * <ret> is left untouched.
739 */
740extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
Emeric Brun39132b22010-01-04 14:57:24 +0100741extern const char *parse_size_err(const char *text, unsigned *ret);
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100742
743/* unit flags to pass to parse_time_err */
744#define TIME_UNIT_US 0x0000
745#define TIME_UNIT_MS 0x0001
746#define TIME_UNIT_S 0x0002
747#define TIME_UNIT_MIN 0x0003
748#define TIME_UNIT_HOUR 0x0004
749#define TIME_UNIT_DAY 0x0005
750#define TIME_UNIT_MASK 0x0007
751
William Lallemand421f5b52012-02-06 18:15:57 +0100752#define SEC 1
753#define MINUTE (60 * SEC)
754#define HOUR (60 * MINUTE)
755#define DAY (24 * HOUR)
756
Willy Tarreau7f062c42009-03-05 18:43:00 +0100757/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
758 * This is used to compute fixed ratios by setting one of the operands to
759 * (2^32*ratio).
760 */
761static inline unsigned int mul32hi(unsigned int a, unsigned int b)
762{
763 return ((unsigned long long)a * b) >> 32;
764}
765
Willy Tarreauf0d9eec2010-06-20 07:12:37 +0200766/* gcc does not know when it can safely divide 64 bits by 32 bits. Use this
767 * function when you know for sure that the result fits in 32 bits, because
768 * it is optimal on x86 and on 64bit processors.
769 */
770static inline unsigned int div64_32(unsigned long long o1, unsigned int o2)
771{
772 unsigned int result;
773#ifdef __i386__
774 asm("divl %2"
775 : "=a" (result)
776 : "A"(o1), "rm"(o2));
777#else
778 result = o1 / o2;
779#endif
780 return result;
781}
782
David Carliere6c39412015-07-02 07:00:17 +0000783/* Simple popcountl implementation. It returns the number of ones in a word */
784static inline unsigned int my_popcountl(unsigned long a)
Willy Tarreau37994f02012-11-19 12:11:07 +0100785{
786 unsigned int cnt;
787 for (cnt = 0; a; a >>= 1) {
788 if (a & 1)
789 cnt++;
790 }
791 return cnt;
792}
793
David Carliere6c39412015-07-02 07:00:17 +0000794/* Build a word with the <bits> lower bits set (reverse of my_popcountl) */
Willy Tarreaua9db57e2013-01-18 11:29:29 +0100795static inline unsigned long nbits(int bits)
796{
797 if (--bits < 0)
798 return 0;
799 else
800 return (2UL << bits) - 1;
801}
802
Willy Tarreau126d4062013-12-03 17:50:47 +0100803/*
804 * Parse binary string written in hexadecimal (source) and store the decoded
805 * result into binstr and set binstrlen to the lengh of binstr. Memory for
806 * binstr is allocated by the function. In case of error, returns 0 with an
807 * error message in err.
808 */
809int parse_binary(const char *source, char **binstr, int *binstrlen, char **err);
810
Willy Tarreau946ba592009-05-10 15:41:18 +0200811/* copies at most <n> characters from <src> and always terminates with '\0' */
812char *my_strndup(const char *src, int n);
813
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +0200814/*
815 * search needle in haystack
816 * returns the pointer if found, returns NULL otherwise
817 */
818const void *my_memmem(const void *, size_t, const void *, size_t);
819
Willy Tarreau482b00d2009-10-04 22:48:42 +0200820/* This function returns the first unused key greater than or equal to <key> in
821 * ID tree <root>. Zero is returned if no place is found.
822 */
823unsigned int get_next_id(struct eb_root *root, unsigned int key);
824
Willy Tarreau348238b2010-01-18 15:05:57 +0100825/* This function compares a sample word possibly followed by blanks to another
826 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
827 * otherwise zero. This intends to be used when checking HTTP headers for some
828 * values.
829 */
830int word_match(const char *sample, int slen, const char *word, int wlen);
831
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200832/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
833 * or the number of chars read in case of success.
834 */
835int buf2ip(const char *buf, size_t len, struct in_addr *dst);
Thierry FOURNIERd559dd82013-11-22 16:16:59 +0100836int buf2ip6(const char *buf, size_t len, struct in6_addr *dst);
Willy Tarreauf0b38bf2010-06-06 13:22:23 +0200837
Willy Tarreauacf95772010-06-14 19:09:21 +0200838/* To be used to quote config arg positions. Returns the string at <ptr>
839 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
840 * if ptr is NULL or empty. The string is locally allocated.
841 */
842const char *quote_arg(const char *ptr);
843
Willy Tarreau5b180202010-07-18 10:40:48 +0200844/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
845int get_std_op(const char *str);
846
Willy Tarreau4c14eaa2010-11-24 14:01:45 +0100847/* hash a 32-bit integer to another 32-bit integer */
848extern unsigned int full_hash(unsigned int a);
849static inline unsigned int __full_hash(unsigned int a)
850{
851 /* This function is one of Bob Jenkins' full avalanche hashing
852 * functions, which when provides quite a good distribution for little
853 * input variations. The result is quite suited to fit over a 32-bit
854 * space with enough variations so that a randomly picked number falls
855 * equally before any server position.
856 * Check http://burtleburtle.net/bob/hash/integer.html for more info.
857 */
858 a = (a+0x7ed55d16) + (a<<12);
859 a = (a^0xc761c23c) ^ (a>>19);
860 a = (a+0x165667b1) + (a<<5);
861 a = (a+0xd3a2646c) ^ (a<<9);
862 a = (a+0xfd7046c5) + (a<<3);
863 a = (a^0xb55a4f09) ^ (a>>16);
864
865 /* ensure values are better spread all around the tree by multiplying
866 * by a large prime close to 3/4 of the tree.
867 */
868 return a * 3221225473U;
869}
870
Willy Tarreau422a0a52012-10-26 19:47:23 +0200871/* sets the address family to AF_UNSPEC so that is_addr() does not match */
872static inline void clear_addr(struct sockaddr_storage *addr)
873{
874 addr->ss_family = AF_UNSPEC;
875}
876
David du Colombier6f5ccb12011-03-10 22:26:24 +0100877/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
878 * otherwise zero.
879 */
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200880static inline int is_inet_addr(const struct sockaddr_storage *addr)
David du Colombier6f5ccb12011-03-10 22:26:24 +0100881{
882 int i;
883
884 switch (addr->ss_family) {
885 case AF_INET:
David du Colombier64e9c902011-03-22 11:39:41 +0100886 return *(int *)&((struct sockaddr_in *)addr)->sin_addr;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100887 case AF_INET6:
888 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
889 if (((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i] != 0)
890 return ((int *)&((struct sockaddr_in6 *)addr)->sin6_addr)[i];
891 }
892 return 0;
893}
894
Willy Tarreau18ca2d42014-05-09 22:40:55 +0200895/* returns non-zero if addr has a valid and non-null IPv4 or IPv6 address,
896 * or is a unix address, otherwise returns zero.
897 */
898static inline int is_addr(const struct sockaddr_storage *addr)
899{
900 if (addr->ss_family == AF_UNIX)
901 return 1;
902 else
903 return is_inet_addr(addr);
904}
905
David du Colombier11bcb6c2011-03-24 12:23:00 +0100906/* returns port in network byte order */
907static inline int get_net_port(struct sockaddr_storage *addr)
908{
909 switch (addr->ss_family) {
910 case AF_INET:
911 return ((struct sockaddr_in *)addr)->sin_port;
912 case AF_INET6:
913 return ((struct sockaddr_in6 *)addr)->sin6_port;
914 }
915 return 0;
916}
917
918/* returns port in host byte order */
919static inline int get_host_port(struct sockaddr_storage *addr)
920{
921 switch (addr->ss_family) {
922 case AF_INET:
923 return ntohs(((struct sockaddr_in *)addr)->sin_port);
924 case AF_INET6:
925 return ntohs(((struct sockaddr_in6 *)addr)->sin6_port);
926 }
927 return 0;
928}
929
Willy Tarreau1b4b7ce2011-04-05 16:56:50 +0200930/* returns address len for <addr>'s family, 0 for unknown families */
931static inline int get_addr_len(const struct sockaddr_storage *addr)
932{
933 switch (addr->ss_family) {
934 case AF_INET:
935 return sizeof(struct sockaddr_in);
936 case AF_INET6:
937 return sizeof(struct sockaddr_in6);
938 case AF_UNIX:
939 return sizeof(struct sockaddr_un);
940 }
941 return 0;
942}
943
David du Colombier11bcb6c2011-03-24 12:23:00 +0100944/* set port in host byte order */
945static inline int set_net_port(struct sockaddr_storage *addr, int port)
946{
947 switch (addr->ss_family) {
948 case AF_INET:
949 ((struct sockaddr_in *)addr)->sin_port = port;
950 case AF_INET6:
951 ((struct sockaddr_in6 *)addr)->sin6_port = port;
952 }
953 return 0;
954}
955
956/* set port in network byte order */
957static inline int set_host_port(struct sockaddr_storage *addr, int port)
958{
959 switch (addr->ss_family) {
960 case AF_INET:
961 ((struct sockaddr_in *)addr)->sin_port = htons(port);
962 case AF_INET6:
963 ((struct sockaddr_in6 *)addr)->sin6_port = htons(port);
964 }
965 return 0;
966}
967
Thierry Fournier70473a52016-02-17 17:12:14 +0100968/* Convert mask from bit length form to in_addr form.
969 * This function never fails.
970 */
971void len2mask4(int len, struct in_addr *addr);
972
973/* Convert mask from bit length form to in6_addr form.
974 * This function never fails.
975 */
976void len2mask6(int len, struct in6_addr *addr);
977
David du Colombier4f92d322011-03-24 11:09:31 +0100978/* Return true if IPv4 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +0200979extern int in_net_ipv4(const void *addr, const struct in_addr *mask, const struct in_addr *net);
David du Colombier4f92d322011-03-24 11:09:31 +0100980
981/* Return true if IPv6 address is part of the network */
Willy Tarreaueec1d382016-07-13 11:59:39 +0200982extern int in_net_ipv6(const void *addr, const struct in6_addr *mask, const struct in6_addr *net);
David du Colombier4f92d322011-03-24 11:09:31 +0100983
984/* Map IPv4 adress on IPv6 address, as specified in RFC 3513. */
985extern void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr);
986
987/* Map IPv6 adress on IPv4 address, as specified in RFC 3513.
988 * Return true if conversion is possible and false otherwise.
989 */
990extern int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr);
991
Baptiste Assmann08b24cf2016-01-23 23:39:12 +0100992/* compare two struct sockaddr_storage and return:
993 * 0 (true) if the addr is the same in both
994 * 1 (false) if the addr is not the same in both
995 */
996int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2);
997
Baptiste Assmann08396c82016-01-31 00:27:17 +0100998/* copy ip from <source> into <dest>
999 * the caller must clear <dest> before calling.
1000 * Returns a pointer to the destination
1001 */
1002struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest);
1003
William Lallemand421f5b52012-02-06 18:15:57 +01001004char *human_time(int t, short hz_div);
1005
1006extern const char *monthname[];
1007
1008/* date2str_log: write a date in the format :
1009 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
1010 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
1011 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
1012 *
1013 * without using sprintf. return a pointer to the last char written (\0) or
1014 * NULL if there isn't enough space.
1015 */
1016char *date2str_log(char *dest, struct tm *tm, struct timeval *date, size_t size);
1017
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001018/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001019 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001020 * The string returned has the same format as returned by strftime(... "%z", tm).
1021 * Offsets are kept in an internal cache for better performances.
1022 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001023const char *get_gmt_offset(time_t t, struct tm *tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02001024
William Lallemand421f5b52012-02-06 18:15:57 +01001025/* gmt2str_log: write a date in the format :
1026 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
1027 * return a pointer to the last char written (\0) or
1028 * NULL if there isn't enough space.
1029 */
1030char *gmt2str_log(char *dst, struct tm *tm, size_t size);
1031
Yuxans Yao4e25b012012-10-19 10:36:09 +08001032/* localdate2str_log: write a date in the format :
1033 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001034 * Both t and tm must represent the same time.
Yuxans Yao4e25b012012-10-19 10:36:09 +08001035 * return a pointer to the last char written (\0) or
1036 * NULL if there isn't enough space.
1037 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02001038char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size);
Yuxans Yao4e25b012012-10-19 10:36:09 +08001039
Thierry Fournier93127942016-01-20 18:49:45 +01001040/* These 3 functions parses date string and fills the
1041 * corresponding broken-down time in <tm>. In succes case,
1042 * it returns 1, otherwise, it returns 0.
1043 */
1044int parse_http_date(const char *date, int len, struct tm *tm);
1045int parse_imf_date(const char *date, int len, struct tm *tm);
1046int parse_rfc850_date(const char *date, int len, struct tm *tm);
1047int parse_asctime_date(const char *date, int len, struct tm *tm);
1048
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001049/* Dynamically allocates a string of the proper length to hold the formatted
1050 * output. NULL is returned on error. The caller is responsible for freeing the
1051 * memory area using free(). The resulting string is returned in <out> if the
1052 * pointer is not NULL. A previous version of <out> might be used to build the
1053 * new string, and it will be freed before returning if it is not NULL, which
1054 * makes it possible to build complex strings from iterative calls without
1055 * having to care about freeing intermediate values, as in the example below :
1056 *
1057 * memprintf(&err, "invalid argument: '%s'", arg);
1058 * ...
1059 * memprintf(&err, "parser said : <%s>\n", *err);
1060 * ...
1061 * free(*err);
1062 *
1063 * This means that <err> must be initialized to NULL before first invocation.
1064 * The return value also holds the allocated string, which eases error checking
1065 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02001066 * passed instead and it will be ignored. The returned message will then also
1067 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02001068 *
1069 * It is also convenient to use it without any free except the last one :
1070 * err = NULL;
1071 * if (!fct1(err)) report(*err);
1072 * if (!fct2(err)) report(*err);
1073 * if (!fct3(err)) report(*err);
1074 * free(*err);
1075 */
1076char *memprintf(char **out, const char *format, ...)
1077 __attribute__ ((format(printf, 2, 3)));
1078
Willy Tarreau21c705b2012-09-14 11:40:36 +02001079/* Used to add <level> spaces before each line of <out>, unless there is only one line.
1080 * The input argument is automatically freed and reassigned. The result will have to be
1081 * freed by the caller.
1082 * Example of use :
1083 * parse(cmd, &err); (callee: memprintf(&err, ...))
1084 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
1085 * free(err);
1086 */
1087char *indent_msg(char **out, int level);
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001088
Willy Tarreaudad36a32013-03-11 01:20:04 +01001089/* Convert occurrences of environment variables in the input string to their
1090 * corresponding value. A variable is identified as a series of alphanumeric
1091 * characters or underscores following a '$' sign. The <in> string must be
1092 * free()able. NULL returns NULL. The resulting string might be reallocated if
1093 * some expansion is made.
1094 */
1095char *env_expand(char *in);
1096
Willy Tarreau3d2f16f2012-05-13 00:21:17 +02001097/* debugging macro to emit messages using write() on fd #-1 so that strace sees
1098 * them.
1099 */
1100#define fddebug(msg...) do { char *_m = NULL; memprintf(&_m, ##msg); if (_m) write(-1, _m, strlen(_m)); free(_m); } while (0)
1101
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001102/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02001103 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
1104 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001105 */
Willy Tarreaued936c52017-04-27 18:03:20 +02001106void debug_hexdump(FILE *out, const char *pfx, const char *buf, unsigned int baseaddr, int len);
Willy Tarreau0ebb5112016-12-05 00:10:57 +01001107
Willy Tarreau12963822017-10-24 10:54:08 +02001108/* this is used to emit traces when building with TRACE=1 */
1109__attribute__((format(printf, 1, 2)))
1110void trace(char *fmt, ...);
1111
Willy Tarreau89efaed2013-12-13 15:14:55 +01001112/* used from everywhere just to drain results we don't want to read and which
1113 * recent versions of gcc increasingly and annoyingly complain about.
1114 */
1115extern int shut_your_big_mouth_gcc_int;
1116
1117/* used from everywhere just to drain results we don't want to read and which
1118 * recent versions of gcc increasingly and annoyingly complain about.
1119 */
1120static inline void shut_your_big_mouth_gcc(int r)
1121{
1122 shut_your_big_mouth_gcc_int = r;
1123}
1124
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02001125/* same as strstr() but case-insensitive */
1126const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2);
1127
Willy Tarreaubb519c72014-01-28 23:04:39 +01001128
1129/************************* Composite address manipulation *********************
1130 * Composite addresses are simply unsigned long data in which the higher bits
1131 * represent a pointer, and the two lower bits are flags. There are several
1132 * places where we just want to associate one or two flags to a pointer (eg,
1133 * to type it), and these functions permit this. The pointer is necessarily a
1134 * 32-bit aligned pointer, as its two lower bits will be cleared and replaced
1135 * with the flags.
1136 *****************************************************************************/
1137
1138/* Masks the two lower bits of a composite address and converts it to a
1139 * pointer. This is used to mix some bits with some aligned pointers to
1140 * structs and to retrieve the original (32-bit aligned) pointer.
1141 */
1142static inline void *caddr_to_ptr(unsigned long caddr)
1143{
1144 return (void *)(caddr & ~3UL);
1145}
1146
1147/* Only retrieves the two lower bits of a composite address. This is used to mix
1148 * some bits with some aligned pointers to structs and to retrieve the original
1149 * data (2 bits).
1150 */
1151static inline unsigned int caddr_to_data(unsigned long caddr)
1152{
1153 return (caddr & 3UL);
1154}
1155
1156/* Combines the aligned pointer whose 2 lower bits will be masked with the bits
1157 * from <data> to form a composite address. This is used to mix some bits with
1158 * some aligned pointers to structs and to retrieve the original (32-bit aligned)
1159 * pointer.
1160 */
1161static inline unsigned long caddr_from_ptr(void *ptr, unsigned int data)
1162{
1163 return (((unsigned long)ptr) & ~3UL) + (data & 3);
1164}
1165
1166/* sets the 2 bits of <data> in the <caddr> composite address */
1167static inline unsigned long caddr_set_flags(unsigned long caddr, unsigned int data)
1168{
1169 return caddr | (data & 3);
1170}
1171
1172/* clears the 2 bits of <data> in the <caddr> composite address */
1173static inline unsigned long caddr_clr_flags(unsigned long caddr, unsigned int data)
1174{
1175 return caddr & ~(unsigned long)(data & 3);
1176}
1177
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02001178/* UTF-8 decoder status */
1179#define UTF8_CODE_OK 0x00
1180#define UTF8_CODE_OVERLONG 0x10
1181#define UTF8_CODE_INVRANGE 0x20
1182#define UTF8_CODE_BADSEQ 0x40
1183
1184unsigned char utf8_next(const char *s, int len, unsigned int *c);
1185
1186static inline unsigned char utf8_return_code(unsigned int code)
1187{
1188 return code & 0xf0;
1189}
1190
1191static inline unsigned char utf8_return_length(unsigned char code)
1192{
1193 return code & 0x0f;
1194}
1195
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001196/* Turns 64-bit value <a> from host byte order to network byte order.
1197 * The principle consists in letting the compiler detect we're playing
1198 * with a union and simplify most or all operations. The asm-optimized
1199 * htonl() version involving bswap (x86) / rev (arm) / other is a single
1200 * operation on little endian, or a NOP on big-endian. In both cases,
1201 * this lets the compiler "see" that we're rebuilding a 64-bit word from
1202 * two 32-bit quantities that fit into a 32-bit register. In big endian,
1203 * the whole code is optimized out. In little endian, with a decent compiler,
1204 * a few bswap and 2 shifts are left, which is the minimum acceptable.
1205 */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001206static inline unsigned long long my_htonll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001207{
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001208#if defined(__x86_64__)
Willy Tarreaudea7c5c2017-10-18 11:39:33 +02001209 __asm__ volatile("bswap %0" : "=r"(a) : "0"(a));
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001210 return a;
1211#else
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001212 union {
1213 struct {
1214 unsigned int w1;
1215 unsigned int w2;
1216 } by32;
1217 unsigned long long by64;
1218 } w = { .by64 = a };
1219 return ((unsigned long long)htonl(w.by32.w1) << 32) | htonl(w.by32.w2);
Willy Tarreau36eb3a32017-09-20 08:18:49 +02001220#endif
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001221}
1222
1223/* Turns 64-bit value <a> from network byte order to host byte order. */
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001224static inline unsigned long long my_ntohll(unsigned long long a)
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001225{
Willy Tarreau5f6e9052016-05-20 06:29:59 +02001226 return my_htonll(a);
Willy Tarreau5b4dd682015-07-21 23:47:18 +02001227}
1228
Willy Tarreaue6e49cf2015-04-29 17:13:35 +02001229/* returns a 64-bit a timestamp with the finest resolution available. The
1230 * unit is intentionally not specified. It's mostly used to compare dates.
1231 */
1232#if defined(__i386__) || defined(__x86_64__)
1233static inline unsigned long long rdtsc()
1234{
1235 unsigned int a, d;
1236 asm volatile("rdtsc" : "=a" (a), "=d" (d));
1237 return a + ((unsigned long long)d << 32);
1238}
1239#else
1240static inline unsigned long long rdtsc()
1241{
1242 struct timeval tv;
1243 gettimeofday(&tv, NULL);
1244 return tv.tv_sec * 1000000 + tv.tv_usec;
1245}
1246#endif
1247
Maxime de Roucydc887852016-05-13 23:52:54 +02001248/* append a copy of string <str> (in a wordlist) at the end of the list <li>
1249 * On failure : return 0 and <err> filled with an error message.
1250 * The caller is responsible for freeing the <err> and <str> copy
1251 * memory area using free()
1252 */
1253struct list;
1254int list_append_word(struct list *li, const char *str, char **err);
1255
Willy Tarreau97c2ae12016-11-22 18:00:20 +01001256int dump_text(struct chunk *out, const char *buf, int bsize);
1257int dump_binary(struct chunk *out, const char *buf, int bsize);
1258int dump_text_line(struct chunk *out, const char *buf, int bsize, int len,
1259 int *line, int ptr);
1260
Hubert Verstraete2eae3a02016-06-28 22:41:00 +02001261/* same as realloc() except that ptr is also freed upon failure */
1262static inline void *my_realloc2(void *ptr, size_t size)
1263{
1264 void *ret;
1265
1266 ret = realloc(ptr, size);
1267 if (!ret && size)
1268 free(ptr);
1269 return ret;
1270}
1271
Lukas Tribusdcbc5c52016-09-12 21:42:07 +00001272/* HAP_STRING() makes a string from a literal while HAP_XSTRING() first
1273 * evaluates the argument and is suited to pass macros.
1274 *
1275 * They allow macros like PCRE_MAJOR to be defined without quotes, which
1276 * is convenient for applications that want to test its value.
1277 */
1278#define HAP_STRING(...) #__VA_ARGS__
1279#define HAP_XSTRING(...) HAP_STRING(__VA_ARGS__)
1280
Willy Tarreau2dd0d472006-06-29 17:53:05 +02001281#endif /* _COMMON_STANDARD_H */