blob: 1f6c2b99dc2a15b1d60656a0e3e18dee118ada09 [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
2 * General purpose functions.
3 *
Willy Tarreau348238b2010-01-18 15:05:57 +01004 * Copyright 2000-2010 Willy Tarreau <w@1wt.eu>
Willy Tarreaubaaee002006-06-26 02:48:02 +02005 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Baruch Siache1651b22020-07-24 07:52:20 +030013#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +010014#define _GNU_SOURCE
15#include <dlfcn.h>
16#include <link.h>
17#endif
18
Willy Tarreau2e74c3f2007-12-02 18:45:09 +010019#include <ctype.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020020#include <errno.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020021#include <netdb.h>
Willy Tarreau9a7bea52012-04-27 11:16:50 +020022#include <stdarg.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020023#include <stdio.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020024#include <stdlib.h>
25#include <string.h>
Thierry Fournier93127942016-01-20 18:49:45 +010026#include <time.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020027#include <unistd.h>
Willy Tarreau127f9662007-12-06 00:53:51 +010028#include <sys/socket.h>
Willy Tarreau37101052019-05-20 16:48:20 +020029#include <sys/stat.h>
30#include <sys/types.h>
Willy Tarreau127f9662007-12-06 00:53:51 +010031#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020032#include <netinet/in.h>
33#include <arpa/inet.h>
34
Willy Tarreau30053062020-08-20 16:39:14 +020035#if (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
36#include <sys/auxv.h>
37#endif
38
Willy Tarreau48fbcae2020-06-03 18:09:46 +020039#include <import/eb32sctree.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020040#include <import/eb32tree.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020041
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020042#include <haproxy/api.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020043#include <haproxy/chunk.h>
Willy Tarreau7c18b542020-06-11 09:23:02 +020044#include <haproxy/dgram.h>
Willy Tarreaueb92deb2020-06-04 10:53:16 +020045#include <haproxy/dns.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020046#include <haproxy/global.h>
Willy Tarreau86416052020-06-04 09:20:54 +020047#include <haproxy/hlua.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020048#include <haproxy/listener.h>
Willy Tarreau7a00efb2020-06-02 17:02:59 +020049#include <haproxy/namespace.h>
Willy Tarreau5fc93282020-09-16 18:25:03 +020050#include <haproxy/protocol.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020051#include <haproxy/ssl_sock.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020052#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020053#include <haproxy/task.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020054#include <haproxy/tools.h>
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +010055
Thierry Fournier93127942016-01-20 18:49:45 +010056/* This macro returns false if the test __x is false. Many
57 * of the following parsing function must be abort the processing
58 * if it returns 0, so this macro is useful for writing light code.
59 */
60#define RET0_UNLESS(__x) do { if (!(__x)) return 0; } while (0)
61
Willy Tarreau56adcf22012-12-23 18:00:29 +010062/* enough to store NB_ITOA_STR integers of :
Willy Tarreau72d759c2007-10-25 12:14:10 +020063 * 2^64-1 = 18446744073709551615 or
64 * -2^63 = -9223372036854775808
Willy Tarreaue7239b52009-03-29 13:41:58 +020065 *
66 * The HTML version needs room for adding the 25 characters
67 * '<span class="rls"></span>' around digits at positions 3N+1 in order
68 * to add spacing at up to 6 positions : 18 446 744 073 709 551 615
Willy Tarreau72d759c2007-10-25 12:14:10 +020069 */
Christopher Faulet99bca652017-11-14 16:47:26 +010070THREAD_LOCAL char itoa_str[NB_ITOA_STR][171];
71THREAD_LOCAL int itoa_idx = 0; /* index of next itoa_str to use */
Willy Tarreaubaaee002006-06-26 02:48:02 +020072
Willy Tarreau588297f2014-06-16 15:16:40 +020073/* sometimes we'll need to quote strings (eg: in stats), and we don't expect
74 * to quote strings larger than a max configuration line.
75 */
Christopher Faulet99bca652017-11-14 16:47:26 +010076THREAD_LOCAL char quoted_str[NB_QSTR][QSTR_SIZE + 1];
77THREAD_LOCAL int quoted_idx = 0;
Willy Tarreau588297f2014-06-16 15:16:40 +020078
Willy Tarreaubaaee002006-06-26 02:48:02 +020079/*
William Lallemande7340ec2012-01-24 11:15:39 +010080 * unsigned long long ASCII representation
81 *
82 * return the last char '\0' or NULL if no enough
83 * space in dst
84 */
85char *ulltoa(unsigned long long n, char *dst, size_t size)
86{
87 int i = 0;
88 char *res;
89
90 switch(n) {
91 case 1ULL ... 9ULL:
92 i = 0;
93 break;
94
95 case 10ULL ... 99ULL:
96 i = 1;
97 break;
98
99 case 100ULL ... 999ULL:
100 i = 2;
101 break;
102
103 case 1000ULL ... 9999ULL:
104 i = 3;
105 break;
106
107 case 10000ULL ... 99999ULL:
108 i = 4;
109 break;
110
111 case 100000ULL ... 999999ULL:
112 i = 5;
113 break;
114
115 case 1000000ULL ... 9999999ULL:
116 i = 6;
117 break;
118
119 case 10000000ULL ... 99999999ULL:
120 i = 7;
121 break;
122
123 case 100000000ULL ... 999999999ULL:
124 i = 8;
125 break;
126
127 case 1000000000ULL ... 9999999999ULL:
128 i = 9;
129 break;
130
131 case 10000000000ULL ... 99999999999ULL:
132 i = 10;
133 break;
134
135 case 100000000000ULL ... 999999999999ULL:
136 i = 11;
137 break;
138
139 case 1000000000000ULL ... 9999999999999ULL:
140 i = 12;
141 break;
142
143 case 10000000000000ULL ... 99999999999999ULL:
144 i = 13;
145 break;
146
147 case 100000000000000ULL ... 999999999999999ULL:
148 i = 14;
149 break;
150
151 case 1000000000000000ULL ... 9999999999999999ULL:
152 i = 15;
153 break;
154
155 case 10000000000000000ULL ... 99999999999999999ULL:
156 i = 16;
157 break;
158
159 case 100000000000000000ULL ... 999999999999999999ULL:
160 i = 17;
161 break;
162
163 case 1000000000000000000ULL ... 9999999999999999999ULL:
164 i = 18;
165 break;
166
167 case 10000000000000000000ULL ... ULLONG_MAX:
168 i = 19;
169 break;
170 }
171 if (i + 2 > size) // (i + 1) + '\0'
172 return NULL; // too long
173 res = dst + i + 1;
174 *res = '\0';
175 for (; i >= 0; i--) {
176 dst[i] = n % 10ULL + '0';
177 n /= 10ULL;
178 }
179 return res;
180}
181
182/*
183 * unsigned long ASCII representation
184 *
185 * return the last char '\0' or NULL if no enough
186 * space in dst
187 */
188char *ultoa_o(unsigned long n, char *dst, size_t size)
189{
190 int i = 0;
191 char *res;
192
193 switch (n) {
194 case 0U ... 9UL:
195 i = 0;
196 break;
197
198 case 10U ... 99UL:
199 i = 1;
200 break;
201
202 case 100U ... 999UL:
203 i = 2;
204 break;
205
206 case 1000U ... 9999UL:
207 i = 3;
208 break;
209
210 case 10000U ... 99999UL:
211 i = 4;
212 break;
213
214 case 100000U ... 999999UL:
215 i = 5;
216 break;
217
218 case 1000000U ... 9999999UL:
219 i = 6;
220 break;
221
222 case 10000000U ... 99999999UL:
223 i = 7;
224 break;
225
226 case 100000000U ... 999999999UL:
227 i = 8;
228 break;
229#if __WORDSIZE == 32
230
231 case 1000000000ULL ... ULONG_MAX:
232 i = 9;
233 break;
234
235#elif __WORDSIZE == 64
236
237 case 1000000000ULL ... 9999999999UL:
238 i = 9;
239 break;
240
241 case 10000000000ULL ... 99999999999UL:
242 i = 10;
243 break;
244
245 case 100000000000ULL ... 999999999999UL:
246 i = 11;
247 break;
248
249 case 1000000000000ULL ... 9999999999999UL:
250 i = 12;
251 break;
252
253 case 10000000000000ULL ... 99999999999999UL:
254 i = 13;
255 break;
256
257 case 100000000000000ULL ... 999999999999999UL:
258 i = 14;
259 break;
260
261 case 1000000000000000ULL ... 9999999999999999UL:
262 i = 15;
263 break;
264
265 case 10000000000000000ULL ... 99999999999999999UL:
266 i = 16;
267 break;
268
269 case 100000000000000000ULL ... 999999999999999999UL:
270 i = 17;
271 break;
272
273 case 1000000000000000000ULL ... 9999999999999999999UL:
274 i = 18;
275 break;
276
277 case 10000000000000000000ULL ... ULONG_MAX:
278 i = 19;
279 break;
280
281#endif
282 }
283 if (i + 2 > size) // (i + 1) + '\0'
284 return NULL; // too long
285 res = dst + i + 1;
286 *res = '\0';
287 for (; i >= 0; i--) {
288 dst[i] = n % 10U + '0';
289 n /= 10U;
290 }
291 return res;
292}
293
294/*
295 * signed long ASCII representation
296 *
297 * return the last char '\0' or NULL if no enough
298 * space in dst
299 */
300char *ltoa_o(long int n, char *dst, size_t size)
301{
302 char *pos = dst;
303
304 if (n < 0) {
305 if (size < 3)
306 return NULL; // min size is '-' + digit + '\0' but another test in ultoa
307 *pos = '-';
308 pos++;
309 dst = ultoa_o(-n, pos, size - 1);
310 } else {
311 dst = ultoa_o(n, dst, size);
312 }
313 return dst;
314}
315
316/*
317 * signed long long ASCII representation
318 *
319 * return the last char '\0' or NULL if no enough
320 * space in dst
321 */
322char *lltoa(long long n, char *dst, size_t size)
323{
324 char *pos = dst;
325
326 if (n < 0) {
327 if (size < 3)
328 return NULL; // min size is '-' + digit + '\0' but another test in ulltoa
329 *pos = '-';
330 pos++;
331 dst = ulltoa(-n, pos, size - 1);
332 } else {
333 dst = ulltoa(n, dst, size);
334 }
335 return dst;
336}
337
338/*
339 * write a ascii representation of a unsigned into dst,
340 * return a pointer to the last character
341 * Pad the ascii representation with '0', using size.
342 */
343char *utoa_pad(unsigned int n, char *dst, size_t size)
344{
345 int i = 0;
346 char *ret;
347
348 switch(n) {
349 case 0U ... 9U:
350 i = 0;
351 break;
352
353 case 10U ... 99U:
354 i = 1;
355 break;
356
357 case 100U ... 999U:
358 i = 2;
359 break;
360
361 case 1000U ... 9999U:
362 i = 3;
363 break;
364
365 case 10000U ... 99999U:
366 i = 4;
367 break;
368
369 case 100000U ... 999999U:
370 i = 5;
371 break;
372
373 case 1000000U ... 9999999U:
374 i = 6;
375 break;
376
377 case 10000000U ... 99999999U:
378 i = 7;
379 break;
380
381 case 100000000U ... 999999999U:
382 i = 8;
383 break;
384
385 case 1000000000U ... 4294967295U:
386 i = 9;
387 break;
388 }
389 if (i + 2 > size) // (i + 1) + '\0'
390 return NULL; // too long
391 if (i < size)
392 i = size - 2; // padding - '\0'
393
394 ret = dst + i + 1;
395 *ret = '\0';
396 for (; i >= 0; i--) {
397 dst[i] = n % 10U + '0';
398 n /= 10U;
399 }
400 return ret;
401}
402
403/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200404 * copies at most <size-1> chars from <src> to <dst>. Last char is always
405 * set to 0, unless <size> is 0. The number of chars copied is returned
406 * (excluding the terminating zero).
407 * This code has been optimized for size and speed : on x86, it's 45 bytes
408 * long, uses only registers, and consumes only 4 cycles per char.
409 */
410int strlcpy2(char *dst, const char *src, int size)
411{
412 char *orig = dst;
413 if (size) {
414 while (--size && (*dst = *src)) {
415 src++; dst++;
416 }
417 *dst = 0;
418 }
419 return dst - orig;
420}
421
422/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200423 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200424 * the ascii representation for number 'n' in decimal.
425 */
Emeric Brun3a7fce52010-01-04 14:54:38 +0100426char *ultoa_r(unsigned long n, char *buffer, int size)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200427{
428 char *pos;
429
Willy Tarreau72d759c2007-10-25 12:14:10 +0200430 pos = buffer + size - 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200431 *pos-- = '\0';
432
433 do {
434 *pos-- = '0' + n % 10;
435 n /= 10;
Willy Tarreau72d759c2007-10-25 12:14:10 +0200436 } while (n && pos >= buffer);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200437 return pos + 1;
438}
439
Willy Tarreau91092e52007-10-25 16:58:42 +0200440/*
Willy Tarreaue7239b52009-03-29 13:41:58 +0200441 * This function simply returns a locally allocated string containing
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200442 * the ascii representation for number 'n' in decimal.
443 */
444char *lltoa_r(long long int in, char *buffer, int size)
445{
446 char *pos;
447 int neg = 0;
448 unsigned long long int n;
449
450 pos = buffer + size - 1;
451 *pos-- = '\0';
452
453 if (in < 0) {
454 neg = 1;
455 n = -in;
456 }
457 else
458 n = in;
459
460 do {
461 *pos-- = '0' + n % 10;
462 n /= 10;
463 } while (n && pos >= buffer);
464 if (neg && pos > buffer)
465 *pos-- = '-';
466 return pos + 1;
467}
468
469/*
470 * This function simply returns a locally allocated string containing
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200471 * the ascii representation for signed number 'n' in decimal.
472 */
473char *sltoa_r(long n, char *buffer, int size)
474{
475 char *pos;
476
477 if (n >= 0)
478 return ultoa_r(n, buffer, size);
479
480 pos = ultoa_r(-n, buffer + 1, size - 1) - 1;
481 *pos = '-';
482 return pos;
483}
484
485/*
486 * This function simply returns a locally allocated string containing
Willy Tarreaue7239b52009-03-29 13:41:58 +0200487 * the ascii representation for number 'n' in decimal, formatted for
488 * HTML output with tags to create visual grouping by 3 digits. The
489 * output needs to support at least 171 characters.
490 */
491const char *ulltoh_r(unsigned long long n, char *buffer, int size)
492{
493 char *start;
494 int digit = 0;
495
496 start = buffer + size;
497 *--start = '\0';
498
499 do {
500 if (digit == 3 && start >= buffer + 7)
501 memcpy(start -= 7, "</span>", 7);
502
503 if (start >= buffer + 1) {
504 *--start = '0' + n % 10;
505 n /= 10;
506 }
507
508 if (digit == 3 && start >= buffer + 18)
509 memcpy(start -= 18, "<span class=\"rls\">", 18);
510
511 if (digit++ == 3)
512 digit = 1;
513 } while (n && start > buffer);
514 return start;
515}
516
517/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200518 * This function simply returns a locally allocated string containing the ascii
519 * representation for number 'n' in decimal, unless n is 0 in which case it
520 * returns the alternate string (or an empty string if the alternate string is
521 * NULL). It use is intended for limits reported in reports, where it's
522 * desirable not to display anything if there is no limit. Warning! it shares
523 * the same vector as ultoa_r().
524 */
525const char *limit_r(unsigned long n, char *buffer, int size, const char *alt)
526{
527 return (n) ? ultoa_r(n, buffer, size) : (alt ? alt : "");
528}
529
Willy Tarreau588297f2014-06-16 15:16:40 +0200530/* returns a locally allocated string containing the quoted encoding of the
531 * input string. The output may be truncated to QSTR_SIZE chars, but it is
532 * guaranteed that the string will always be properly terminated. Quotes are
533 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
534 * always be at least 4 chars.
535 */
536const char *qstr(const char *str)
537{
538 char *ret = quoted_str[quoted_idx];
539 char *p, *end;
540
541 if (++quoted_idx >= NB_QSTR)
542 quoted_idx = 0;
543
544 p = ret;
545 end = ret + QSTR_SIZE;
546
547 *p++ = '"';
548
549 /* always keep 3 chars to support passing "" and the ending " */
550 while (*str && p < end - 3) {
551 if (*str == '"') {
552 *p++ = '"';
553 *p++ = '"';
554 }
555 else
556 *p++ = *str;
557 str++;
558 }
559 *p++ = '"';
560 return ret;
561}
562
Robert Tsai81ae1952007-12-05 10:47:29 +0100563/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200564 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
565 *
566 * It looks like this one would be a good candidate for inlining, but this is
567 * not interesting because it around 35 bytes long and often called multiple
568 * times within the same function.
569 */
570int ishex(char s)
571{
572 s -= '0';
573 if ((unsigned char)s <= 9)
574 return 1;
575 s -= 'A' - '0';
576 if ((unsigned char)s <= 5)
577 return 1;
578 s -= 'a' - 'A';
579 if ((unsigned char)s <= 5)
580 return 1;
581 return 0;
582}
583
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100584/* rounds <i> down to the closest value having max 2 digits */
585unsigned int round_2dig(unsigned int i)
586{
587 unsigned int mul = 1;
588
589 while (i >= 100) {
590 i /= 10;
591 mul *= 10;
592 }
593 return i * mul;
594}
595
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100596/*
597 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
598 * invalid character is found, a pointer to it is returned. If everything is
599 * fine, NULL is returned.
600 */
601const char *invalid_char(const char *name)
602{
603 if (!*name)
604 return name;
605
606 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100607 if (!isalnum((unsigned char)*name) && *name != '.' && *name != ':' &&
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100608 *name != '_' && *name != '-')
609 return name;
610 name++;
611 }
612 return NULL;
613}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200614
615/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200616 * Checks <name> for invalid characters. Valid chars are [_.-] and those
617 * accepted by <f> function.
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200618 * If an invalid character is found, a pointer to it is returned.
619 * If everything is fine, NULL is returned.
620 */
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200621static inline const char *__invalid_char(const char *name, int (*f)(int)) {
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200622
623 if (!*name)
624 return name;
625
626 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100627 if (!f((unsigned char)*name) && *name != '.' &&
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200628 *name != '_' && *name != '-')
629 return name;
630
631 name++;
632 }
633
634 return NULL;
635}
636
637/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200638 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
639 * If an invalid character is found, a pointer to it is returned.
640 * If everything is fine, NULL is returned.
641 */
642const char *invalid_domainchar(const char *name) {
643 return __invalid_char(name, isalnum);
644}
645
646/*
647 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
648 * If an invalid character is found, a pointer to it is returned.
649 * If everything is fine, NULL is returned.
650 */
651const char *invalid_prefix_char(const char *name) {
Thierry Fournierf7b7c3e2018-03-26 11:54:39 +0200652 return __invalid_char(name, isalnum);
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200653}
654
655/*
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100656 * converts <str> to a struct sockaddr_storage* provided by the caller. The
Willy Tarreau24709282013-03-10 21:32:12 +0100657 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
658 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
659 * the function tries to guess the address family from the syntax. If the
660 * family is forced and the format doesn't match, an error is returned. The
Willy Tarreaufab5a432011-03-04 15:31:53 +0100661 * string is assumed to contain only an address, no port. The address can be a
662 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
663 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
664 * The return address will only have the address family and the address set,
665 * all other fields remain zero. The string is not supposed to be modified.
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100666 * The IPv6 '::' address is IN6ADDR_ANY. If <resolve> is non-zero, the hostname
667 * is resolved, otherwise only IP addresses are resolved, and anything else
Willy Tarreauecde7df2016-11-02 22:37:03 +0100668 * returns NULL. If the address contains a port, this one is preserved.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200669 */
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100670struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200671{
Willy Tarreaufab5a432011-03-04 15:31:53 +0100672 struct hostent *he;
mildisff5d5102015-10-26 18:50:08 +0100673 /* max IPv6 length, including brackets and terminating NULL */
674 char tmpip[48];
Willy Tarreauecde7df2016-11-02 22:37:03 +0100675 int port = get_host_port(sa);
mildisff5d5102015-10-26 18:50:08 +0100676
677 /* check IPv6 with square brackets */
678 if (str[0] == '[') {
679 size_t iplength = strlen(str);
680
681 if (iplength < 4) {
682 /* minimal size is 4 when using brackets "[::]" */
683 goto fail;
684 }
685 else if (iplength >= sizeof(tmpip)) {
686 /* IPv6 literal can not be larger than tmpip */
687 goto fail;
688 }
689 else {
690 if (str[iplength - 1] != ']') {
691 /* if address started with bracket, it should end with bracket */
692 goto fail;
693 }
694 else {
695 memcpy(tmpip, str + 1, iplength - 2);
696 tmpip[iplength - 2] = '\0';
697 str = tmpip;
698 }
699 }
700 }
Willy Tarreaufab5a432011-03-04 15:31:53 +0100701
Willy Tarreaufab5a432011-03-04 15:31:53 +0100702 /* Any IPv6 address */
703 if (str[0] == ':' && str[1] == ':' && !str[2]) {
Willy Tarreau24709282013-03-10 21:32:12 +0100704 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
705 sa->ss_family = AF_INET6;
706 else if (sa->ss_family != AF_INET6)
707 goto fail;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100708 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100709 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100710 }
711
Willy Tarreau24709282013-03-10 21:32:12 +0100712 /* Any address for the family, defaults to IPv4 */
Willy Tarreaufab5a432011-03-04 15:31:53 +0100713 if (!str[0] || (str[0] == '*' && !str[1])) {
Willy Tarreau24709282013-03-10 21:32:12 +0100714 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
715 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100716 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100717 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100718 }
719
720 /* check for IPv6 first */
Willy Tarreau24709282013-03-10 21:32:12 +0100721 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET6) &&
722 inet_pton(AF_INET6, str, &((struct sockaddr_in6 *)sa)->sin6_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100723 sa->ss_family = AF_INET6;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100724 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100725 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100726 }
727
728 /* then check for IPv4 */
Willy Tarreau24709282013-03-10 21:32:12 +0100729 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET) &&
730 inet_pton(AF_INET, str, &((struct sockaddr_in *)sa)->sin_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100731 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100732 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100733 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100734 }
735
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100736 if (!resolve)
737 return NULL;
738
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200739 if (!dns_hostname_validation(str, NULL))
740 return NULL;
741
David du Colombierd5f43282011-03-17 10:40:16 +0100742#ifdef USE_GETADDRINFO
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200743 if (global.tune.options & GTUNE_USE_GAI) {
David du Colombierd5f43282011-03-17 10:40:16 +0100744 struct addrinfo hints, *result;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100745 int success = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100746
747 memset(&result, 0, sizeof(result));
748 memset(&hints, 0, sizeof(hints));
Willy Tarreau24709282013-03-10 21:32:12 +0100749 hints.ai_family = sa->ss_family ? sa->ss_family : AF_UNSPEC;
David du Colombierd5f43282011-03-17 10:40:16 +0100750 hints.ai_socktype = SOCK_DGRAM;
Dmitry Sivachenkoeab7f392015-10-02 01:01:58 +0200751 hints.ai_flags = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100752 hints.ai_protocol = 0;
753
754 if (getaddrinfo(str, NULL, &hints, &result) == 0) {
Willy Tarreau24709282013-03-10 21:32:12 +0100755 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
756 sa->ss_family = result->ai_family;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100757 else if (sa->ss_family != result->ai_family) {
758 freeaddrinfo(result);
Willy Tarreau24709282013-03-10 21:32:12 +0100759 goto fail;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100760 }
Willy Tarreau24709282013-03-10 21:32:12 +0100761
David du Colombierd5f43282011-03-17 10:40:16 +0100762 switch (result->ai_family) {
763 case AF_INET:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100764 memcpy((struct sockaddr_in *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100765 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100766 success = 1;
767 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100768 case AF_INET6:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100769 memcpy((struct sockaddr_in6 *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100770 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100771 success = 1;
772 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100773 }
774 }
775
Sean Carey58ea0392013-02-15 23:39:18 +0100776 if (result)
777 freeaddrinfo(result);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100778
779 if (success)
780 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100781 }
David du Colombierd5f43282011-03-17 10:40:16 +0100782#endif
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200783 /* try to resolve an IPv4/IPv6 hostname */
784 he = gethostbyname(str);
785 if (he) {
786 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
787 sa->ss_family = he->h_addrtype;
788 else if (sa->ss_family != he->h_addrtype)
789 goto fail;
790
791 switch (sa->ss_family) {
792 case AF_INET:
793 ((struct sockaddr_in *)sa)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100794 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200795 return sa;
796 case AF_INET6:
797 ((struct sockaddr_in6 *)sa)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100798 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200799 return sa;
800 }
801 }
802
David du Colombierd5f43282011-03-17 10:40:16 +0100803 /* unsupported address family */
Willy Tarreau24709282013-03-10 21:32:12 +0100804 fail:
Willy Tarreaufab5a432011-03-04 15:31:53 +0100805 return NULL;
806}
807
808/*
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100809 * Converts <str> to a locally allocated struct sockaddr_storage *, and a port
810 * range or offset consisting in two integers that the caller will have to
811 * check to find the relevant input format. The following format are supported :
812 *
813 * String format | address | port | low | high
814 * addr | <addr> | 0 | 0 | 0
815 * addr: | <addr> | 0 | 0 | 0
816 * addr:port | <addr> | <port> | <port> | <port>
817 * addr:pl-ph | <addr> | <pl> | <pl> | <ph>
818 * addr:+port | <addr> | <port> | 0 | <port>
819 * addr:-port | <addr> |-<port> | <port> | 0
820 *
821 * The detection of a port range or increment by the caller is made by
822 * comparing <low> and <high>. If both are equal, then port 0 means no port
823 * was specified. The caller may pass NULL for <low> and <high> if it is not
824 * interested in retrieving port ranges.
825 *
826 * Note that <addr> above may also be :
827 * - empty ("") => family will be AF_INET and address will be INADDR_ANY
828 * - "*" => family will be AF_INET and address will be INADDR_ANY
829 * - "::" => family will be AF_INET6 and address will be IN6ADDR_ANY
830 * - a host name => family and address will depend on host name resolving.
831 *
Willy Tarreau24709282013-03-10 21:32:12 +0100832 * A prefix may be passed in before the address above to force the family :
833 * - "ipv4@" => force address to resolve as IPv4 and fail if not possible.
834 * - "ipv6@" => force address to resolve as IPv6 and fail if not possible.
835 * - "unix@" => force address to be a path to a UNIX socket even if the
836 * path does not start with a '/'
Willy Tarreauccfccef2014-05-10 01:49:15 +0200837 * - 'abns@' -> force address to belong to the abstract namespace (Linux
838 * only). These sockets are just like Unix sockets but without
839 * the need for an underlying file system. The address is a
840 * string. Technically it's like a Unix socket with a zero in
841 * the first byte of the address.
Willy Tarreau40aa0702013-03-10 23:51:38 +0100842 * - "fd@" => an integer must follow, and is a file descriptor number.
Willy Tarreau24709282013-03-10 21:32:12 +0100843 *
mildisff5d5102015-10-26 18:50:08 +0100844 * IPv6 addresses can be declared with or without square brackets. When using
845 * square brackets for IPv6 addresses, the port separator (colon) is optional.
846 * If not using square brackets, and in order to avoid any ambiguity with
847 * IPv6 addresses, the last colon ':' is mandatory even when no port is specified.
848 * NULL is returned if the address cannot be parsed. The <low> and <high> ports
849 * are always initialized if non-null, even for non-IP families.
Willy Tarreaud393a622013-03-04 18:22:00 +0100850 *
851 * If <pfx> is non-null, it is used as a string prefix before any path-based
852 * address (typically the path to a unix socket).
Willy Tarreau40aa0702013-03-10 23:51:38 +0100853 *
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200854 * if <fqdn> is non-null, it will be filled with :
855 * - a pointer to the FQDN of the server name to resolve if there's one, and
856 * that the caller will have to free(),
857 * - NULL if there was an explicit address that doesn't require resolution.
858 *
Willy Tarreaucd3a55912020-09-04 15:30:46 +0200859 * Hostnames are only resolved if <opts> has PA_O_RESOLVE. Otherwise <fqdn> is
860 * still honored so it is possible for the caller to know whether a resolution
861 * failed by clearing this flag and checking if <fqdn> was filled, indicating
862 * the need for a resolution.
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200863 *
Willy Tarreau40aa0702013-03-10 23:51:38 +0100864 * When a file descriptor is passed, its value is put into the s_addr part of
Willy Tarreaua5b325f2020-09-04 16:44:20 +0200865 * the address when cast to sockaddr_in and the address family is
866 * AF_CUST_EXISTING_FD.
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200867 *
Willy Tarreau5fc93282020-09-16 18:25:03 +0200868 * The matching protocol will be set into <proto> if non-null.
869 *
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200870 * Any known file descriptor is also assigned to <fd> if non-null, otherwise it
871 * is forced to -1.
Willy Tarreaufab5a432011-03-04 15:31:53 +0100872 */
Willy Tarreau5fc93282020-09-16 18:25:03 +0200873struct sockaddr_storage *str2sa_range(const char *str, int *port, int *low, int *high, int *fd,
874 struct protocol **proto, char **err,
875 const char *pfx, char **fqdn, unsigned int opts)
Willy Tarreaufab5a432011-03-04 15:31:53 +0100876{
Christopher Faulet1bc04c72017-10-29 20:14:08 +0100877 static THREAD_LOCAL struct sockaddr_storage ss;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100878 struct sockaddr_storage *ret = NULL;
Willy Tarreau5fc93282020-09-16 18:25:03 +0200879 struct protocol *new_proto = NULL;
Willy Tarreau24709282013-03-10 21:32:12 +0100880 char *back, *str2;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100881 char *port1, *port2;
882 int portl, porth, porta;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200883 int abstract = 0;
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200884 int new_fd = -1;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200885 int sock_type, ctrl_type;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100886
887 portl = porth = porta = 0;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200888 if (fqdn)
889 *fqdn = NULL;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200890
Willy Tarreaudad36a32013-03-11 01:20:04 +0100891 str2 = back = env_expand(strdup(str));
Willy Tarreaudf350f12013-03-01 20:22:54 +0100892 if (str2 == NULL) {
893 memprintf(err, "out of memory in '%s'\n", __FUNCTION__);
Willy Tarreaud5191e72010-02-09 20:50:45 +0100894 goto out;
Willy Tarreaudf350f12013-03-01 20:22:54 +0100895 }
Willy Tarreaubaaee002006-06-26 02:48:02 +0200896
Willy Tarreau9f69f462015-09-08 16:01:25 +0200897 if (!*str2) {
898 memprintf(err, "'%s' resolves to an empty address (environment variable missing?)\n", str);
899 goto out;
900 }
901
Willy Tarreau24709282013-03-10 21:32:12 +0100902 memset(&ss, 0, sizeof(ss));
903
Willy Tarreaue835bd82020-09-16 11:35:47 +0200904 /* prepare the default socket types */
905 if ((opts & (PA_O_STREAM|PA_O_DGRAM)) == PA_O_DGRAM)
906 sock_type = ctrl_type = SOCK_DGRAM;
907 else
908 sock_type = ctrl_type = SOCK_STREAM;
909
910 if (strncmp(str2, "stream+", 7) == 0) {
911 str2 += 7;
912 sock_type = ctrl_type = SOCK_STREAM;
913 }
914 else if (strncmp(str2, "dgram+", 6) == 0) {
915 str2 += 6;
916 sock_type = ctrl_type = SOCK_DGRAM;
917 }
918
Willy Tarreau24709282013-03-10 21:32:12 +0100919 if (strncmp(str2, "unix@", 5) == 0) {
920 str2 += 5;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200921 abstract = 0;
Willy Tarreau24709282013-03-10 21:32:12 +0100922 ss.ss_family = AF_UNIX;
923 }
Willy Tarreauccfccef2014-05-10 01:49:15 +0200924 else if (strncmp(str2, "abns@", 5) == 0) {
925 str2 += 5;
926 abstract = 1;
927 ss.ss_family = AF_UNIX;
928 }
Willy Tarreau24709282013-03-10 21:32:12 +0100929 else if (strncmp(str2, "ipv4@", 5) == 0) {
930 str2 += 5;
931 ss.ss_family = AF_INET;
932 }
933 else if (strncmp(str2, "ipv6@", 5) == 0) {
934 str2 += 5;
935 ss.ss_family = AF_INET6;
936 }
Emeric Brun3835c0d2020-07-07 09:46:09 +0200937 else if (strncmp(str2, "udp4@", 5) == 0) {
938 str2 += 5;
939 ss.ss_family = AF_INET;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200940 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +0200941 }
942 else if (strncmp(str2, "udp6@", 5) == 0) {
943 str2 += 5;
944 ss.ss_family = AF_INET6;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200945 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +0200946 }
947 else if (strncmp(str2, "udp@", 4) == 0) {
948 str2 += 4;
949 ss.ss_family = AF_UNSPEC;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200950 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +0200951 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +0200952 else if (strncmp(str2, "fd@", 3) == 0) {
953 str2 += 3;
954 ss.ss_family = AF_CUST_EXISTING_FD;
955 }
956 else if (strncmp(str2, "sockpair@", 9) == 0) {
957 str2 += 9;
958 ss.ss_family = AF_CUST_SOCKPAIR;
959 }
Willy Tarreau24709282013-03-10 21:32:12 +0100960 else if (*str2 == '/') {
961 ss.ss_family = AF_UNIX;
962 }
963 else
964 ss.ss_family = AF_UNSPEC;
965
Willy Tarreau5a7beed2020-09-04 16:54:05 +0200966 if (ss.ss_family == AF_CUST_SOCKPAIR) {
Willy Tarreaua215be22020-09-16 10:14:16 +0200967 struct sockaddr_storage ss2;
968 socklen_t addr_len;
William Lallemand2fe7dd02018-09-11 16:51:29 +0200969 char *endptr;
970
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200971 new_fd = strtol(str2, &endptr, 10);
972 if (!*str2 || new_fd < 0 || *endptr) {
William Lallemand2fe7dd02018-09-11 16:51:29 +0200973 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
974 goto out;
975 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200976
Willy Tarreaua215be22020-09-16 10:14:16 +0200977 /* just verify that it's a socket */
978 addr_len = sizeof(ss2);
979 if (getsockname(new_fd, (struct sockaddr *)&ss2, &addr_len) == -1) {
980 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
981 goto out;
982 }
983
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200984 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
985 ((struct sockaddr_in *)&ss)->sin_port = 0;
William Lallemand2fe7dd02018-09-11 16:51:29 +0200986 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +0200987 else if (ss.ss_family == AF_CUST_EXISTING_FD) {
Willy Tarreau40aa0702013-03-10 23:51:38 +0100988 char *endptr;
989
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200990 new_fd = strtol(str2, &endptr, 10);
991 if (!*str2 || new_fd < 0 || *endptr) {
Willy Tarreaudad36a32013-03-11 01:20:04 +0100992 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
Willy Tarreau40aa0702013-03-10 23:51:38 +0100993 goto out;
994 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200995
Willy Tarreau6edc7222020-09-15 17:41:56 +0200996 if (opts & PA_O_SOCKET_FD) {
997 socklen_t addr_len;
998 int type;
999
1000 addr_len = sizeof(ss);
1001 if (getsockname(new_fd, (struct sockaddr *)&ss, &addr_len) == -1) {
1002 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1003 goto out;
1004 }
1005
1006 addr_len = sizeof(type);
1007 if (getsockopt(new_fd, SOL_SOCKET, SO_TYPE, &type, &addr_len) != 0 ||
Willy Tarreaue835bd82020-09-16 11:35:47 +02001008 (type == SOCK_STREAM) != (sock_type == SOCK_STREAM)) {
Willy Tarreau6edc7222020-09-15 17:41:56 +02001009 memprintf(err, "socket on file descriptor '%d' is of the wrong type.\n", new_fd);
1010 goto out;
1011 }
1012
1013 porta = portl = porth = get_host_port(&ss);
1014 } else if (opts & PA_O_RAW_FD) {
1015 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1016 ((struct sockaddr_in *)&ss)->sin_port = 0;
1017 } else {
1018 memprintf(err, "a file descriptor is not acceptable here in '%s'\n", str);
1019 goto out;
1020 }
Willy Tarreau40aa0702013-03-10 23:51:38 +01001021 }
1022 else if (ss.ss_family == AF_UNIX) {
Willy Tarreau8daa9202019-06-16 18:16:33 +02001023 struct sockaddr_un *un = (struct sockaddr_un *)&ss;
Willy Tarreau15586382013-03-04 19:48:14 +01001024 int prefix_path_len;
1025 int max_path_len;
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001026 int adr_len;
Willy Tarreau15586382013-03-04 19:48:14 +01001027
1028 /* complete unix socket path name during startup or soft-restart is
1029 * <unix_bind_prefix><path>.<pid>.<bak|tmp>
1030 */
Willy Tarreauccfccef2014-05-10 01:49:15 +02001031 prefix_path_len = (pfx && !abstract) ? strlen(pfx) : 0;
Willy Tarreau8daa9202019-06-16 18:16:33 +02001032 max_path_len = (sizeof(un->sun_path) - 1) -
Willy Tarreau327ea5a2020-02-11 06:43:37 +01001033 (abstract ? 0 : prefix_path_len + 1 + 5 + 1 + 3);
Willy Tarreau15586382013-03-04 19:48:14 +01001034
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001035 adr_len = strlen(str2);
1036 if (adr_len > max_path_len) {
Willy Tarreau15586382013-03-04 19:48:14 +01001037 memprintf(err, "socket path '%s' too long (max %d)\n", str, max_path_len);
1038 goto out;
1039 }
1040
Willy Tarreauccfccef2014-05-10 01:49:15 +02001041 /* when abstract==1, we skip the first zero and copy all bytes except the trailing zero */
Willy Tarreau8daa9202019-06-16 18:16:33 +02001042 memset(un->sun_path, 0, sizeof(un->sun_path));
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001043 if (prefix_path_len)
Willy Tarreau8daa9202019-06-16 18:16:33 +02001044 memcpy(un->sun_path, pfx, prefix_path_len);
1045 memcpy(un->sun_path + prefix_path_len + abstract, str2, adr_len + 1 - abstract);
Willy Tarreau15586382013-03-04 19:48:14 +01001046 }
Willy Tarreau24709282013-03-10 21:32:12 +01001047 else { /* IPv4 and IPv6 */
mildisff5d5102015-10-26 18:50:08 +01001048 char *end = str2 + strlen(str2);
1049 char *chr;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001050
mildisff5d5102015-10-26 18:50:08 +01001051 /* search for : or ] whatever comes first */
1052 for (chr = end-1; chr > str2; chr--) {
1053 if (*chr == ']' || *chr == ':')
1054 break;
1055 }
1056
1057 if (*chr == ':') {
1058 /* Found a colon before a closing-bracket, must be a port separator.
1059 * This guarantee backward compatibility.
1060 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001061 if (!(opts & PA_O_PORT_OK)) {
1062 memprintf(err, "port specification not permitted here in '%s'", str);
1063 goto out;
1064 }
mildisff5d5102015-10-26 18:50:08 +01001065 *chr++ = '\0';
1066 port1 = chr;
1067 }
1068 else {
1069 /* Either no colon and no closing-bracket
1070 * or directly ending with a closing-bracket.
1071 * However, no port.
1072 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001073 if (opts & PA_O_PORT_MAND) {
1074 memprintf(err, "missing port specification in '%s'", str);
1075 goto out;
1076 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001077 port1 = "";
mildisff5d5102015-10-26 18:50:08 +01001078 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001079
Willy Tarreau90807112020-02-25 08:16:33 +01001080 if (isdigit((unsigned char)*port1)) { /* single port or range */
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001081 port2 = strchr(port1, '-');
Willy Tarreau7f96a842020-09-15 11:12:44 +02001082 if (port2) {
1083 if (!(opts & PA_O_PORT_RANGE)) {
1084 memprintf(err, "port range not permitted here in '%s'", str);
1085 goto out;
1086 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001087 *port2++ = '\0';
Willy Tarreau7f96a842020-09-15 11:12:44 +02001088 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001089 else
1090 port2 = port1;
1091 portl = atoi(port1);
1092 porth = atoi(port2);
Willy Tarreau7f96a842020-09-15 11:12:44 +02001093
1094 if (portl < !!(opts & PA_O_PORT_MAND) || portl > 65535) {
1095 memprintf(err, "invalid port '%s'", port1);
1096 goto out;
1097 }
1098
1099 if (porth < !!(opts & PA_O_PORT_MAND) || porth > 65535) {
1100 memprintf(err, "invalid port '%s'", port2);
1101 goto out;
1102 }
1103
1104 if (portl > porth) {
1105 memprintf(err, "invalid port range '%d-%d'", portl, porth);
1106 goto out;
1107 }
1108
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001109 porta = portl;
1110 }
1111 else if (*port1 == '-') { /* negative offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001112 if (!(opts & PA_O_PORT_OFS)) {
1113 memprintf(err, "port offset not permitted here in '%s'", str);
1114 goto out;
1115 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001116 portl = atoi(port1 + 1);
1117 porta = -portl;
1118 }
1119 else if (*port1 == '+') { /* positive offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001120 if (!(opts & PA_O_PORT_OFS)) {
1121 memprintf(err, "port offset not permitted here in '%s'", str);
1122 goto out;
1123 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001124 porth = atoi(port1 + 1);
1125 porta = porth;
1126 }
1127 else if (*port1) { /* other any unexpected char */
Willy Tarreaudad36a32013-03-11 01:20:04 +01001128 memprintf(err, "invalid character '%c' in port number '%s' in '%s'\n", *port1, port1, str);
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001129 goto out;
1130 }
Willy Tarreau7f96a842020-09-15 11:12:44 +02001131 else if (opts & PA_O_PORT_MAND) {
1132 memprintf(err, "missing port specification in '%s'", str);
1133 goto out;
1134 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001135
1136 /* first try to parse the IP without resolving. If it fails, it
1137 * tells us we need to keep a copy of the FQDN to resolve later
1138 * and to enable DNS. In this case we can proceed if <fqdn> is
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001139 * set or if PA_O_RESOLVE is set, otherwise it's an error.
Willy Tarreauceccdd72016-11-02 22:27:10 +01001140 */
1141 if (str2ip2(str2, &ss, 0) == NULL) {
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001142 if ((!(opts & PA_O_RESOLVE) && !fqdn) ||
1143 ((opts & PA_O_RESOLVE) && str2ip2(str2, &ss, 1) == NULL)) {
Willy Tarreauceccdd72016-11-02 22:27:10 +01001144 memprintf(err, "invalid address: '%s' in '%s'\n", str2, str);
1145 goto out;
1146 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001147
Willy Tarreauceccdd72016-11-02 22:27:10 +01001148 if (fqdn) {
1149 if (str2 != back)
1150 memmove(back, str2, strlen(str2) + 1);
1151 *fqdn = back;
1152 back = NULL;
1153 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001154 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001155 set_host_port(&ss, porta);
Willy Tarreaue4c58c82013-03-06 15:28:17 +01001156 }
Willy Tarreaufab5a432011-03-04 15:31:53 +01001157
Willy Tarreaue835bd82020-09-16 11:35:47 +02001158 if (ctrl_type == SOCK_STREAM && !(opts & PA_O_STREAM)) {
1159 memprintf(err, "stream-type socket not acceptable in '%s'\n", str);
1160 goto out;
1161 }
1162 else if (ctrl_type == SOCK_DGRAM && !(opts & PA_O_DGRAM)) {
1163 memprintf(err, "dgram-type socket not acceptable in '%s'\n", str);
1164 goto out;
1165 }
1166
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001167 if (proto || (opts & PA_O_CONNECT)) {
Willy Tarreau5fc93282020-09-16 18:25:03 +02001168 /* Note: if the caller asks for a proto, we must find one,
1169 * except if we return with an fqdn that will resolve later,
1170 * in which case the address is not known yet (this is only
1171 * for servers actually).
1172 */
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001173 new_proto = protocol_lookup(ss.ss_family,
Willy Tarreauaf9609b2020-09-16 22:04:46 +02001174 sock_type == SOCK_DGRAM,
1175 ctrl_type == SOCK_DGRAM);
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001176
Willy Tarreau5fc93282020-09-16 18:25:03 +02001177 if (!new_proto && (!fqdn || !*fqdn)) {
1178 memprintf(err, "unsupported protocol family %d for address '%s'", ss.ss_family, str);
1179 goto out;
1180 }
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001181
1182 if ((opts & PA_O_CONNECT) && new_proto && !new_proto->connect) {
1183 memprintf(err, "connect() not supported for this protocol family %d used by address '%s'", ss.ss_family, str);
1184 goto out;
1185 }
Willy Tarreau5fc93282020-09-16 18:25:03 +02001186 }
1187
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001188 ret = &ss;
Willy Tarreaud5191e72010-02-09 20:50:45 +01001189 out:
Willy Tarreau48ef4c92017-01-06 18:32:38 +01001190 if (port)
1191 *port = porta;
Willy Tarreaud4448bc2013-02-20 15:55:15 +01001192 if (low)
1193 *low = portl;
1194 if (high)
1195 *high = porth;
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001196 if (fd)
1197 *fd = new_fd;
Willy Tarreau5fc93282020-09-16 18:25:03 +02001198 if (proto)
1199 *proto = new_proto;
Willy Tarreau24709282013-03-10 21:32:12 +01001200 free(back);
Willy Tarreaud5191e72010-02-09 20:50:45 +01001201 return ret;
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001202}
1203
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001204/* converts <str> to a struct in_addr containing a network mask. It can be
1205 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +03001206 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001207 */
1208int str2mask(const char *str, struct in_addr *mask)
1209{
1210 if (strchr(str, '.') != NULL) { /* dotted notation */
1211 if (!inet_pton(AF_INET, str, mask))
1212 return 0;
1213 }
1214 else { /* mask length */
1215 char *err;
1216 unsigned long len = strtol(str, &err, 10);
1217
1218 if (!*str || (err && *err) || (unsigned)len > 32)
1219 return 0;
Tim Duesterhus8575f722018-01-25 16:24:48 +01001220
1221 len2mask4(len, mask);
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001222 }
1223 return 1;
1224}
1225
Tim Duesterhus47185172018-01-25 16:24:49 +01001226/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +01001227 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +01001228 * if the conversion succeeds otherwise zero.
1229 */
1230int str2mask6(const char *str, struct in6_addr *mask)
1231{
1232 if (strchr(str, ':') != NULL) { /* quadruplet notation */
1233 if (!inet_pton(AF_INET6, str, mask))
1234 return 0;
1235 }
1236 else { /* mask length */
1237 char *err;
1238 unsigned long len = strtol(str, &err, 10);
1239
1240 if (!*str || (err && *err) || (unsigned)len > 128)
1241 return 0;
1242
1243 len2mask6(len, mask);
1244 }
1245 return 1;
1246}
1247
Thierry FOURNIERb0504632013-12-14 15:39:02 +01001248/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
1249 * succeeds otherwise zero.
1250 */
1251int cidr2dotted(int cidr, struct in_addr *mask) {
1252
1253 if (cidr < 0 || cidr > 32)
1254 return 0;
1255
1256 mask->s_addr = cidr ? htonl(~0UL << (32 - cidr)) : 0;
1257 return 1;
1258}
1259
Thierry Fournier70473a52016-02-17 17:12:14 +01001260/* Convert mask from bit length form to in_addr form.
1261 * This function never fails.
1262 */
1263void len2mask4(int len, struct in_addr *addr)
1264{
1265 if (len >= 32) {
1266 addr->s_addr = 0xffffffff;
1267 return;
1268 }
1269 if (len <= 0) {
1270 addr->s_addr = 0x00000000;
1271 return;
1272 }
1273 addr->s_addr = 0xffffffff << (32 - len);
1274 addr->s_addr = htonl(addr->s_addr);
1275}
1276
1277/* Convert mask from bit length form to in6_addr form.
1278 * This function never fails.
1279 */
1280void len2mask6(int len, struct in6_addr *addr)
1281{
1282 len2mask4(len, (struct in_addr *)&addr->s6_addr[0]); /* msb */
1283 len -= 32;
1284 len2mask4(len, (struct in_addr *)&addr->s6_addr[4]);
1285 len -= 32;
1286 len2mask4(len, (struct in_addr *)&addr->s6_addr[8]);
1287 len -= 32;
1288 len2mask4(len, (struct in_addr *)&addr->s6_addr[12]); /* lsb */
1289}
1290
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001291/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +02001292 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001293 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001294 * is optional and either in the dotted or CIDR notation.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001295 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
1296 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001297int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001298{
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001299 __label__ out_free, out_err;
1300 char *c, *s;
1301 int ret_val;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001302
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001303 s = strdup(str);
1304 if (!s)
1305 return 0;
1306
Willy Tarreaubaaee002006-06-26 02:48:02 +02001307 memset(mask, 0, sizeof(*mask));
1308 memset(addr, 0, sizeof(*addr));
Willy Tarreaubaaee002006-06-26 02:48:02 +02001309
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001310 if ((c = strrchr(s, '/')) != NULL) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001311 *c++ = '\0';
1312 /* c points to the mask */
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001313 if (!str2mask(c, mask))
1314 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001315 }
1316 else {
Willy Tarreauebd61602006-12-30 11:54:15 +01001317 mask->s_addr = ~0U;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001318 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001319 if (!inet_pton(AF_INET, s, addr)) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001320 struct hostent *he;
1321
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001322 if (!resolve)
1323 goto out_err;
1324
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001325 if ((he = gethostbyname(s)) == NULL) {
1326 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001327 }
1328 else
1329 *addr = *(struct in_addr *) *(he->h_addr_list);
1330 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001331
1332 ret_val = 1;
1333 out_free:
1334 free(s);
1335 return ret_val;
1336 out_err:
1337 ret_val = 0;
1338 goto out_free;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001339}
1340
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001341
1342/*
Willy Tarreau6d20e282012-04-27 22:49:47 +02001343 * converts <str> to two struct in6_addr* which must be pre-allocated.
1344 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001345 * is an optional number of bits (128 being the default).
Willy Tarreau6d20e282012-04-27 22:49:47 +02001346 * Returns 1 if OK, 0 if error.
1347 */
1348int str62net(const char *str, struct in6_addr *addr, unsigned char *mask)
1349{
1350 char *c, *s;
1351 int ret_val = 0;
1352 char *err;
1353 unsigned long len = 128;
1354
1355 s = strdup(str);
1356 if (!s)
1357 return 0;
1358
1359 memset(mask, 0, sizeof(*mask));
1360 memset(addr, 0, sizeof(*addr));
1361
1362 if ((c = strrchr(s, '/')) != NULL) {
1363 *c++ = '\0'; /* c points to the mask */
1364 if (!*c)
1365 goto out_free;
1366
1367 len = strtoul(c, &err, 10);
1368 if ((err && *err) || (unsigned)len > 128)
1369 goto out_free;
1370 }
1371 *mask = len; /* OK we have a valid mask in <len> */
1372
1373 if (!inet_pton(AF_INET6, s, addr))
1374 goto out_free;
1375
1376 ret_val = 1;
1377 out_free:
1378 free(s);
1379 return ret_val;
1380}
1381
1382
1383/*
David du Colombier6f5ccb12011-03-10 22:26:24 +01001384 * Parse IPv4 address found in url.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001385 */
David du Colombier6f5ccb12011-03-10 22:26:24 +01001386int url2ipv4(const char *addr, struct in_addr *dst)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001387{
1388 int saw_digit, octets, ch;
1389 u_char tmp[4], *tp;
1390 const char *cp = addr;
1391
1392 saw_digit = 0;
1393 octets = 0;
1394 *(tp = tmp) = 0;
1395
1396 while (*addr) {
1397 unsigned char digit = (ch = *addr++) - '0';
1398 if (digit > 9 && ch != '.')
1399 break;
1400 if (digit <= 9) {
1401 u_int new = *tp * 10 + digit;
1402 if (new > 255)
1403 return 0;
1404 *tp = new;
1405 if (!saw_digit) {
1406 if (++octets > 4)
1407 return 0;
1408 saw_digit = 1;
1409 }
1410 } else if (ch == '.' && saw_digit) {
1411 if (octets == 4)
1412 return 0;
1413 *++tp = 0;
1414 saw_digit = 0;
1415 } else
1416 return 0;
1417 }
1418
1419 if (octets < 4)
1420 return 0;
1421
1422 memcpy(&dst->s_addr, tmp, 4);
1423 return addr-cp-1;
1424}
1425
1426/*
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001427 * Resolve destination server from URL. Convert <str> to a sockaddr_storage.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001428 * <out> contain the code of the detected scheme, the start and length of
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001429 * the hostname. Actually only http and https are supported. <out> can be NULL.
1430 * This function returns the consumed length. It is useful if you parse complete
1431 * url like http://host:port/path, because the consumed length corresponds to
1432 * the first character of the path. If the conversion fails, it returns -1.
1433 *
1434 * This function tries to resolve the DNS name if haproxy is in starting mode.
1435 * So, this function may be used during the configuration parsing.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001436 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001437int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001438{
1439 const char *curr = url, *cp = url;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001440 const char *end;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001441 int ret, url_code = 0;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001442 unsigned long long int http_code = 0;
1443 int default_port;
1444 struct hostent *he;
1445 char *p;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001446
1447 /* Firstly, try to find :// pattern */
1448 while (curr < url+ulen && url_code != 0x3a2f2f) {
1449 url_code = ((url_code & 0xffff) << 8);
1450 url_code += (unsigned char)*curr++;
1451 }
1452
1453 /* Secondly, if :// pattern is found, verify parsed stuff
1454 * before pattern is matching our http pattern.
1455 * If so parse ip address and port in uri.
1456 *
1457 * WARNING: Current code doesn't support dynamic async dns resolver.
1458 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001459 if (url_code != 0x3a2f2f)
1460 return -1;
1461
1462 /* Copy scheme, and utrn to lower case. */
1463 while (cp < curr - 3)
1464 http_code = (http_code << 8) + *cp++;
1465 http_code |= 0x2020202020202020ULL; /* Turn everything to lower case */
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001466
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001467 /* HTTP or HTTPS url matching */
1468 if (http_code == 0x2020202068747470ULL) {
1469 default_port = 80;
1470 if (out)
1471 out->scheme = SCH_HTTP;
1472 }
1473 else if (http_code == 0x2020206874747073ULL) {
1474 default_port = 443;
1475 if (out)
1476 out->scheme = SCH_HTTPS;
1477 }
1478 else
1479 return -1;
1480
1481 /* If the next char is '[', the host address is IPv6. */
1482 if (*curr == '[') {
1483 curr++;
1484
1485 /* Check trash size */
1486 if (trash.size < ulen)
1487 return -1;
1488
1489 /* Look for ']' and copy the address in a trash buffer. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001490 p = trash.area;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001491 for (end = curr;
1492 end < url + ulen && *end != ']';
1493 end++, p++)
1494 *p = *end;
1495 if (*end != ']')
1496 return -1;
1497 *p = '\0';
1498
1499 /* Update out. */
1500 if (out) {
1501 out->host = curr;
1502 out->host_len = end - curr;
1503 }
1504
1505 /* Try IPv6 decoding. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001506 if (!inet_pton(AF_INET6, trash.area, &((struct sockaddr_in6 *)addr)->sin6_addr))
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001507 return -1;
1508 end++;
1509
1510 /* Decode port. */
1511 if (*end == ':') {
1512 end++;
1513 default_port = read_uint(&end, url + ulen);
1514 }
1515 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1516 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1517 return end - url;
1518 }
1519 else {
1520 /* We are looking for IP address. If you want to parse and
1521 * resolve hostname found in url, you can use str2sa_range(), but
1522 * be warned this can slow down global daemon performances
1523 * while handling lagging dns responses.
1524 */
1525 ret = url2ipv4(curr, &((struct sockaddr_in *)addr)->sin_addr);
1526 if (ret) {
1527 /* Update out. */
1528 if (out) {
1529 out->host = curr;
1530 out->host_len = ret;
1531 }
1532
1533 curr += ret;
1534
1535 /* Decode port. */
1536 if (*curr == ':') {
1537 curr++;
1538 default_port = read_uint(&curr, url + ulen);
1539 }
1540 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1541
1542 /* Set family. */
1543 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1544 return curr - url;
1545 }
1546 else if (global.mode & MODE_STARTING) {
1547 /* The IPv4 and IPv6 decoding fails, maybe the url contain name. Try to execute
1548 * synchronous DNS request only if HAProxy is in the start state.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001549 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001550
1551 /* look for : or / or end */
1552 for (end = curr;
1553 end < url + ulen && *end != '/' && *end != ':';
1554 end++);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001555 memcpy(trash.area, curr, end - curr);
1556 trash.area[end - curr] = '\0';
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001557
1558 /* try to resolve an IPv4/IPv6 hostname */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001559 he = gethostbyname(trash.area);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001560 if (!he)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001561 return -1;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001562
1563 /* Update out. */
1564 if (out) {
1565 out->host = curr;
1566 out->host_len = end - curr;
1567 }
1568
1569 /* Decode port. */
1570 if (*end == ':') {
1571 end++;
1572 default_port = read_uint(&end, url + ulen);
1573 }
1574
1575 /* Copy IP address, set port and family. */
1576 switch (he->h_addrtype) {
1577 case AF_INET:
1578 ((struct sockaddr_in *)addr)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
1579 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1580 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1581 return end - url;
1582
1583 case AF_INET6:
1584 ((struct sockaddr_in6 *)addr)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
1585 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1586 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1587 return end - url;
1588 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001589 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001590 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001591 return -1;
1592}
1593
Willy Tarreau631f01c2011-09-05 00:36:48 +02001594/* Tries to convert a sockaddr_storage address to text form. Upon success, the
1595 * address family is returned so that it's easy for the caller to adapt to the
1596 * output format. Zero is returned if the address family is not supported. -1
1597 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1598 * supported.
1599 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001600int addr_to_str(const struct sockaddr_storage *addr, char *str, int size)
Willy Tarreau631f01c2011-09-05 00:36:48 +02001601{
1602
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001603 const void *ptr;
Willy Tarreau631f01c2011-09-05 00:36:48 +02001604
1605 if (size < 5)
1606 return 0;
1607 *str = '\0';
1608
1609 switch (addr->ss_family) {
1610 case AF_INET:
1611 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1612 break;
1613 case AF_INET6:
1614 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1615 break;
1616 case AF_UNIX:
1617 memcpy(str, "unix", 5);
1618 return addr->ss_family;
1619 default:
1620 return 0;
1621 }
1622
1623 if (inet_ntop(addr->ss_family, ptr, str, size))
1624 return addr->ss_family;
1625
1626 /* failed */
1627 return -1;
1628}
1629
Simon Horman75ab8bd2014-06-16 09:39:41 +09001630/* Tries to convert a sockaddr_storage port to text form. Upon success, the
1631 * address family is returned so that it's easy for the caller to adapt to the
1632 * output format. Zero is returned if the address family is not supported. -1
1633 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1634 * supported.
1635 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001636int port_to_str(const struct sockaddr_storage *addr, char *str, int size)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001637{
1638
1639 uint16_t port;
1640
1641
Willy Tarreaud7dad1b2017-01-06 16:46:22 +01001642 if (size < 6)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001643 return 0;
1644 *str = '\0';
1645
1646 switch (addr->ss_family) {
1647 case AF_INET:
1648 port = ((struct sockaddr_in *)addr)->sin_port;
1649 break;
1650 case AF_INET6:
1651 port = ((struct sockaddr_in6 *)addr)->sin6_port;
1652 break;
1653 case AF_UNIX:
1654 memcpy(str, "unix", 5);
1655 return addr->ss_family;
1656 default:
1657 return 0;
1658 }
1659
1660 snprintf(str, size, "%u", ntohs(port));
1661 return addr->ss_family;
1662}
1663
Willy Tarreau16e01562016-08-09 16:46:18 +02001664/* check if the given address is local to the system or not. It will return
1665 * -1 when it's not possible to know, 0 when the address is not local, 1 when
1666 * it is. We don't want to iterate over all interfaces for this (and it is not
1667 * portable). So instead we try to bind in UDP to this address on a free non
1668 * privileged port and to connect to the same address, port 0 (connect doesn't
1669 * care). If it succeeds, we own the address. Note that non-inet addresses are
1670 * considered local since they're most likely AF_UNIX.
1671 */
1672int addr_is_local(const struct netns_entry *ns,
1673 const struct sockaddr_storage *orig)
1674{
1675 struct sockaddr_storage addr;
1676 int result;
1677 int fd;
1678
1679 if (!is_inet_addr(orig))
1680 return 1;
1681
1682 memcpy(&addr, orig, sizeof(addr));
1683 set_host_port(&addr, 0);
1684
1685 fd = my_socketat(ns, addr.ss_family, SOCK_DGRAM, IPPROTO_UDP);
1686 if (fd < 0)
1687 return -1;
1688
1689 result = -1;
1690 if (bind(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == 0) {
1691 if (connect(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == -1)
1692 result = 0; // fail, non-local address
1693 else
1694 result = 1; // success, local address
1695 }
1696 else {
1697 if (errno == EADDRNOTAVAIL)
1698 result = 0; // definitely not local :-)
1699 }
1700 close(fd);
1701
1702 return result;
1703}
1704
Willy Tarreaubaaee002006-06-26 02:48:02 +02001705/* will try to encode the string <string> replacing all characters tagged in
1706 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
1707 * prefixed by <escape>, and will store the result between <start> (included)
1708 * and <stop> (excluded), and will always terminate the string with a '\0'
1709 * before <stop>. The position of the '\0' is returned if the conversion
1710 * completes. If bytes are missing between <start> and <stop>, then the
1711 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
1712 * cannot even be stored so we return <start> without writing the 0.
1713 * The input string must also be zero-terminated.
1714 */
1715const char hextab[16] = "0123456789ABCDEF";
1716char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001717 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +02001718 const char *string)
1719{
1720 if (start < stop) {
1721 stop--; /* reserve one byte for the final '\0' */
1722 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001723 if (!ha_bit_test((unsigned char)(*string), map))
Willy Tarreaubaaee002006-06-26 02:48:02 +02001724 *start++ = *string;
1725 else {
1726 if (start + 3 >= stop)
1727 break;
1728 *start++ = escape;
1729 *start++ = hextab[(*string >> 4) & 15];
1730 *start++ = hextab[*string & 15];
1731 }
1732 string++;
1733 }
1734 *start = '\0';
1735 }
1736 return start;
1737}
1738
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001739/*
1740 * Same behavior as encode_string() above, except that it encodes chunk
1741 * <chunk> instead of a string.
1742 */
1743char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001744 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001745 const struct buffer *chunk)
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001746{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001747 char *str = chunk->area;
1748 char *end = chunk->area + chunk->data;
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001749
1750 if (start < stop) {
1751 stop--; /* reserve one byte for the final '\0' */
1752 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001753 if (!ha_bit_test((unsigned char)(*str), map))
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001754 *start++ = *str;
1755 else {
1756 if (start + 3 >= stop)
1757 break;
1758 *start++ = escape;
1759 *start++ = hextab[(*str >> 4) & 15];
1760 *start++ = hextab[*str & 15];
1761 }
1762 str++;
1763 }
1764 *start = '\0';
1765 }
1766 return start;
1767}
1768
Dragan Dosen0edd1092016-02-12 13:23:02 +01001769/*
1770 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001771 * character. The input <string> must be zero-terminated. The result will
1772 * be stored between <start> (included) and <stop> (excluded). This
1773 * function will always try to terminate the resulting string with a '\0'
1774 * before <stop>, and will return its position if the conversion
1775 * completes.
1776 */
1777char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001778 const char escape, const long *map,
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001779 const char *string)
1780{
1781 if (start < stop) {
1782 stop--; /* reserve one byte for the final '\0' */
1783 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001784 if (!ha_bit_test((unsigned char)(*string), map))
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001785 *start++ = *string;
1786 else {
1787 if (start + 2 >= stop)
1788 break;
1789 *start++ = escape;
1790 *start++ = *string;
1791 }
1792 string++;
1793 }
1794 *start = '\0';
1795 }
1796 return start;
1797}
1798
1799/*
1800 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +01001801 * character. <chunk> contains the input to be escaped. The result will be
1802 * stored between <start> (included) and <stop> (excluded). The function
1803 * will always try to terminate the resulting string with a '\0' before
1804 * <stop>, and will return its position if the conversion completes.
1805 */
1806char *escape_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001807 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001808 const struct buffer *chunk)
Dragan Dosen0edd1092016-02-12 13:23:02 +01001809{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001810 char *str = chunk->area;
1811 char *end = chunk->area + chunk->data;
Dragan Dosen0edd1092016-02-12 13:23:02 +01001812
1813 if (start < stop) {
1814 stop--; /* reserve one byte for the final '\0' */
1815 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001816 if (!ha_bit_test((unsigned char)(*str), map))
Dragan Dosen0edd1092016-02-12 13:23:02 +01001817 *start++ = *str;
1818 else {
1819 if (start + 2 >= stop)
1820 break;
1821 *start++ = escape;
1822 *start++ = *str;
1823 }
1824 str++;
1825 }
1826 *start = '\0';
1827 }
1828 return start;
1829}
1830
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001831/* Check a string for using it in a CSV output format. If the string contains
1832 * one of the following four char <">, <,>, CR or LF, the string is
1833 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
1834 * <str> is the input string to be escaped. The function assumes that
1835 * the input string is null-terminated.
1836 *
1837 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +01001838 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001839 * format.
1840 *
Willy Tarreau898529b2016-01-06 18:07:04 +01001841 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001842 *
Willy Tarreaub631c292016-01-08 10:04:08 +01001843 * If <quote> is 1, the converter puts the quotes only if any reserved character
1844 * is present. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001845 *
Willy Tarreau83061a82018-07-13 11:56:34 +02001846 * <output> is a struct buffer used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001847 *
Willy Tarreau898529b2016-01-06 18:07:04 +01001848 * The function returns the converted string on its output. If an error
1849 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001850 * for using the function directly as printf() argument.
1851 *
1852 * If the output buffer is too short to contain the input string, the result
1853 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +01001854 *
Willy Tarreaub631c292016-01-08 10:04:08 +01001855 * This function appends the encoding to the existing output chunk, and it
1856 * guarantees that it starts immediately at the first available character of
1857 * the chunk. Please use csv_enc() instead if you want to replace the output
1858 * chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001859 */
Willy Tarreau83061a82018-07-13 11:56:34 +02001860const char *csv_enc_append(const char *str, int quote, struct buffer *output)
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001861{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001862 char *end = output->area + output->size;
1863 char *out = output->area + output->data;
Willy Tarreau898529b2016-01-06 18:07:04 +01001864 char *ptr = out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001865
Willy Tarreaub631c292016-01-08 10:04:08 +01001866 if (quote == 1) {
1867 /* automatic quoting: first verify if we'll have to quote the string */
1868 if (!strpbrk(str, "\n\r,\""))
1869 quote = 0;
1870 }
1871
1872 if (quote)
1873 *ptr++ = '"';
1874
Willy Tarreau898529b2016-01-06 18:07:04 +01001875 while (*str && ptr < end - 2) { /* -2 for reserving space for <"> and \0. */
1876 *ptr = *str;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001877 if (*str == '"') {
Willy Tarreau898529b2016-01-06 18:07:04 +01001878 ptr++;
1879 if (ptr >= end - 2) {
1880 ptr--;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001881 break;
1882 }
Willy Tarreau898529b2016-01-06 18:07:04 +01001883 *ptr = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001884 }
Willy Tarreau898529b2016-01-06 18:07:04 +01001885 ptr++;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001886 str++;
1887 }
1888
Willy Tarreaub631c292016-01-08 10:04:08 +01001889 if (quote)
1890 *ptr++ = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001891
Willy Tarreau898529b2016-01-06 18:07:04 +01001892 *ptr = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001893 output->data = ptr - output->area;
Willy Tarreau898529b2016-01-06 18:07:04 +01001894 return out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001895}
1896
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001897/* Decode an URL-encoded string in-place. The resulting string might
1898 * be shorter. If some forbidden characters are found, the conversion is
Thierry FOURNIER5068d962013-10-04 16:27:27 +02001899 * aborted, the string is truncated before the issue and a negative value is
1900 * returned, otherwise the operation returns the length of the decoded string.
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001901 * If the 'in_form' argument is non-nul the string is assumed to be part of
1902 * an "application/x-www-form-urlencoded" encoded string, and the '+' will be
1903 * turned to a space. If it's zero, this will only be done after a question
1904 * mark ('?').
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001905 */
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001906int url_decode(char *string, int in_form)
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001907{
1908 char *in, *out;
Thierry FOURNIER5068d962013-10-04 16:27:27 +02001909 int ret = -1;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001910
1911 in = string;
1912 out = string;
1913 while (*in) {
1914 switch (*in) {
1915 case '+' :
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001916 *out++ = in_form ? ' ' : *in;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001917 break;
1918 case '%' :
1919 if (!ishex(in[1]) || !ishex(in[2]))
1920 goto end;
1921 *out++ = (hex2i(in[1]) << 4) + hex2i(in[2]);
1922 in += 2;
1923 break;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001924 case '?':
1925 in_form = 1;
1926 /* fall through */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001927 default:
1928 *out++ = *in;
1929 break;
1930 }
1931 in++;
1932 }
Thierry FOURNIER5068d962013-10-04 16:27:27 +02001933 ret = out - string; /* success */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001934 end:
1935 *out = 0;
1936 return ret;
1937}
Willy Tarreaubaaee002006-06-26 02:48:02 +02001938
Willy Tarreau6911fa42007-03-04 18:06:08 +01001939unsigned int str2ui(const char *s)
1940{
1941 return __str2ui(s);
1942}
1943
1944unsigned int str2uic(const char *s)
1945{
1946 return __str2uic(s);
1947}
1948
1949unsigned int strl2ui(const char *s, int len)
1950{
1951 return __strl2ui(s, len);
1952}
1953
1954unsigned int strl2uic(const char *s, int len)
1955{
1956 return __strl2uic(s, len);
1957}
1958
Willy Tarreau4ec83cd2010-10-15 23:19:55 +02001959unsigned int read_uint(const char **s, const char *end)
1960{
1961 return __read_uint(s, end);
1962}
1963
Thierry FOURNIER763a5d82015-07-06 23:09:52 +02001964/* This function reads an unsigned integer from the string pointed to by <s> and
1965 * returns it. The <s> pointer is adjusted to point to the first unread char. The
1966 * function automatically stops at <end>. If the number overflows, the 2^64-1
1967 * value is returned.
1968 */
1969unsigned long long int read_uint64(const char **s, const char *end)
1970{
1971 const char *ptr = *s;
1972 unsigned long long int i = 0, tmp;
1973 unsigned int j;
1974
1975 while (ptr < end) {
1976
1977 /* read next char */
1978 j = *ptr - '0';
1979 if (j > 9)
1980 goto read_uint64_end;
1981
1982 /* add char to the number and check overflow. */
1983 tmp = i * 10;
1984 if (tmp / 10 != i) {
1985 i = ULLONG_MAX;
1986 goto read_uint64_eat;
1987 }
1988 if (ULLONG_MAX - tmp < j) {
1989 i = ULLONG_MAX;
1990 goto read_uint64_eat;
1991 }
1992 i = tmp + j;
1993 ptr++;
1994 }
1995read_uint64_eat:
1996 /* eat each numeric char */
1997 while (ptr < end) {
1998 if ((unsigned int)(*ptr - '0') > 9)
1999 break;
2000 ptr++;
2001 }
2002read_uint64_end:
2003 *s = ptr;
2004 return i;
2005}
2006
2007/* This function reads an integer from the string pointed to by <s> and returns
2008 * it. The <s> pointer is adjusted to point to the first unread char. The function
2009 * automatically stops at <end>. Il the number is bigger than 2^63-2, the 2^63-1
2010 * value is returned. If the number is lowest than -2^63-1, the -2^63 value is
2011 * returned.
2012 */
2013long long int read_int64(const char **s, const char *end)
2014{
2015 unsigned long long int i = 0;
2016 int neg = 0;
2017
2018 /* Look for minus char. */
2019 if (**s == '-') {
2020 neg = 1;
2021 (*s)++;
2022 }
2023 else if (**s == '+')
2024 (*s)++;
2025
2026 /* convert as positive number. */
2027 i = read_uint64(s, end);
2028
2029 if (neg) {
2030 if (i > 0x8000000000000000ULL)
2031 return LLONG_MIN;
2032 return -i;
2033 }
2034 if (i > 0x7fffffffffffffffULL)
2035 return LLONG_MAX;
2036 return i;
2037}
2038
Willy Tarreau6911fa42007-03-04 18:06:08 +01002039/* This one is 7 times faster than strtol() on athlon with checks.
2040 * It returns the value of the number composed of all valid digits read,
2041 * and can process negative numbers too.
2042 */
2043int strl2ic(const char *s, int len)
2044{
2045 int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002046 int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002047
2048 if (len > 0) {
2049 if (*s != '-') {
2050 /* positive number */
2051 while (len-- > 0) {
2052 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002053 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002054 if (j > 9)
2055 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002056 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002057 }
2058 } else {
2059 /* negative number */
2060 s++;
2061 while (--len > 0) {
2062 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002063 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002064 if (j > 9)
2065 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002066 i = k - j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002067 }
2068 }
2069 }
2070 return i;
2071}
2072
2073
2074/* This function reads exactly <len> chars from <s> and converts them to a
2075 * signed integer which it stores into <ret>. It accurately detects any error
2076 * (truncated string, invalid chars, overflows). It is meant to be used in
2077 * applications designed for hostile environments. It returns zero when the
2078 * number has successfully been converted, non-zero otherwise. When an error
2079 * is returned, the <ret> value is left untouched. It is yet 5 to 40 times
2080 * faster than strtol().
2081 */
2082int strl2irc(const char *s, int len, int *ret)
2083{
2084 int i = 0;
2085 int j;
2086
2087 if (!len)
2088 return 1;
2089
2090 if (*s != '-') {
2091 /* positive number */
2092 while (len-- > 0) {
2093 j = (*s++) - '0';
2094 if (j > 9) return 1; /* invalid char */
2095 if (i > INT_MAX / 10) return 1; /* check for multiply overflow */
2096 i = i * 10;
2097 if (i + j < i) return 1; /* check for addition overflow */
2098 i = i + j;
2099 }
2100 } else {
2101 /* negative number */
2102 s++;
2103 while (--len > 0) {
2104 j = (*s++) - '0';
2105 if (j > 9) return 1; /* invalid char */
2106 if (i < INT_MIN / 10) return 1; /* check for multiply overflow */
2107 i = i * 10;
2108 if (i - j > i) return 1; /* check for subtract overflow */
2109 i = i - j;
2110 }
2111 }
2112 *ret = i;
2113 return 0;
2114}
2115
2116
2117/* This function reads exactly <len> chars from <s> and converts them to a
2118 * signed integer which it stores into <ret>. It accurately detects any error
2119 * (truncated string, invalid chars, overflows). It is meant to be used in
2120 * applications designed for hostile environments. It returns zero when the
2121 * number has successfully been converted, non-zero otherwise. When an error
2122 * is returned, the <ret> value is left untouched. It is about 3 times slower
2123 * than str2irc().
2124 */
Willy Tarreau6911fa42007-03-04 18:06:08 +01002125
2126int strl2llrc(const char *s, int len, long long *ret)
2127{
2128 long long i = 0;
2129 int j;
2130
2131 if (!len)
2132 return 1;
2133
2134 if (*s != '-') {
2135 /* positive number */
2136 while (len-- > 0) {
2137 j = (*s++) - '0';
2138 if (j > 9) return 1; /* invalid char */
2139 if (i > LLONG_MAX / 10LL) return 1; /* check for multiply overflow */
2140 i = i * 10LL;
2141 if (i + j < i) return 1; /* check for addition overflow */
2142 i = i + j;
2143 }
2144 } else {
2145 /* negative number */
2146 s++;
2147 while (--len > 0) {
2148 j = (*s++) - '0';
2149 if (j > 9) return 1; /* invalid char */
2150 if (i < LLONG_MIN / 10LL) return 1; /* check for multiply overflow */
2151 i = i * 10LL;
2152 if (i - j > i) return 1; /* check for subtract overflow */
2153 i = i - j;
2154 }
2155 }
2156 *ret = i;
2157 return 0;
2158}
2159
Thierry FOURNIER511e9472014-01-23 17:40:34 +01002160/* This function is used with pat_parse_dotted_ver(). It converts a string
2161 * composed by two number separated by a dot. Each part must contain in 16 bits
2162 * because internally they will be represented as a 32-bit quantity stored in
2163 * a 64-bit integer. It returns zero when the number has successfully been
2164 * converted, non-zero otherwise. When an error is returned, the <ret> value
2165 * is left untouched.
2166 *
2167 * "1.3" -> 0x0000000000010003
2168 * "65535.65535" -> 0x00000000ffffffff
2169 */
2170int strl2llrc_dotted(const char *text, int len, long long *ret)
2171{
2172 const char *end = &text[len];
2173 const char *p;
2174 long long major, minor;
2175
2176 /* Look for dot. */
2177 for (p = text; p < end; p++)
2178 if (*p == '.')
2179 break;
2180
2181 /* Convert major. */
2182 if (strl2llrc(text, p - text, &major) != 0)
2183 return 1;
2184
2185 /* Check major. */
2186 if (major >= 65536)
2187 return 1;
2188
2189 /* Convert minor. */
2190 minor = 0;
2191 if (p < end)
2192 if (strl2llrc(p + 1, end - (p + 1), &minor) != 0)
2193 return 1;
2194
2195 /* Check minor. */
2196 if (minor >= 65536)
2197 return 1;
2198
2199 /* Compose value. */
2200 *ret = (major << 16) | (minor & 0xffff);
2201 return 0;
2202}
2203
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002204/* This function parses a time value optionally followed by a unit suffix among
2205 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
2206 * expected by the caller. The computation does its best to avoid overflows.
2207 * The value is returned in <ret> if everything is fine, and a NULL is returned
2208 * by the function. In case of error, a pointer to the error is returned and
2209 * <ret> is left untouched. Values are automatically rounded up when needed.
Willy Tarreau9faebe32019-06-07 19:00:37 +02002210 * Values resulting in values larger than or equal to 2^31 after conversion are
2211 * reported as an overflow as value PARSE_TIME_OVER. Non-null values resulting
2212 * in an underflow are reported as an underflow as value PARSE_TIME_UNDER.
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002213 */
2214const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags)
2215{
Willy Tarreau9faebe32019-06-07 19:00:37 +02002216 unsigned long long imult, idiv;
2217 unsigned long long omult, odiv;
2218 unsigned long long value, result;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002219
2220 omult = odiv = 1;
2221
2222 switch (unit_flags & TIME_UNIT_MASK) {
2223 case TIME_UNIT_US: omult = 1000000; break;
2224 case TIME_UNIT_MS: omult = 1000; break;
2225 case TIME_UNIT_S: break;
2226 case TIME_UNIT_MIN: odiv = 60; break;
2227 case TIME_UNIT_HOUR: odiv = 3600; break;
2228 case TIME_UNIT_DAY: odiv = 86400; break;
2229 default: break;
2230 }
2231
2232 value = 0;
2233
2234 while (1) {
2235 unsigned int j;
2236
2237 j = *text - '0';
2238 if (j > 9)
2239 break;
2240 text++;
2241 value *= 10;
2242 value += j;
2243 }
2244
2245 imult = idiv = 1;
2246 switch (*text) {
2247 case '\0': /* no unit = default unit */
2248 imult = omult = idiv = odiv = 1;
2249 break;
2250 case 's': /* second = unscaled unit */
2251 break;
2252 case 'u': /* microsecond : "us" */
2253 if (text[1] == 's') {
2254 idiv = 1000000;
2255 text++;
2256 }
2257 break;
2258 case 'm': /* millisecond : "ms" or minute: "m" */
2259 if (text[1] == 's') {
2260 idiv = 1000;
2261 text++;
2262 } else
2263 imult = 60;
2264 break;
2265 case 'h': /* hour : "h" */
2266 imult = 3600;
2267 break;
2268 case 'd': /* day : "d" */
2269 imult = 86400;
2270 break;
2271 default:
2272 return text;
2273 break;
2274 }
2275
2276 if (omult % idiv == 0) { omult /= idiv; idiv = 1; }
2277 if (idiv % omult == 0) { idiv /= omult; omult = 1; }
2278 if (imult % odiv == 0) { imult /= odiv; odiv = 1; }
2279 if (odiv % imult == 0) { odiv /= imult; imult = 1; }
2280
Willy Tarreau9faebe32019-06-07 19:00:37 +02002281 result = (value * (imult * omult) + (idiv * odiv - 1)) / (idiv * odiv);
2282 if (result >= 0x80000000)
2283 return PARSE_TIME_OVER;
2284 if (!result && value)
2285 return PARSE_TIME_UNDER;
2286 *ret = result;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002287 return NULL;
2288}
Willy Tarreau6911fa42007-03-04 18:06:08 +01002289
Emeric Brun39132b22010-01-04 14:57:24 +01002290/* this function converts the string starting at <text> to an unsigned int
2291 * stored in <ret>. If an error is detected, the pointer to the unexpected
Joseph Herlant32b83272018-11-15 11:58:28 -08002292 * character is returned. If the conversion is successful, NULL is returned.
Emeric Brun39132b22010-01-04 14:57:24 +01002293 */
2294const char *parse_size_err(const char *text, unsigned *ret) {
2295 unsigned value = 0;
2296
2297 while (1) {
2298 unsigned int j;
2299
2300 j = *text - '0';
2301 if (j > 9)
2302 break;
2303 if (value > ~0U / 10)
2304 return text;
2305 value *= 10;
2306 if (value > (value + j))
2307 return text;
2308 value += j;
2309 text++;
2310 }
2311
2312 switch (*text) {
2313 case '\0':
2314 break;
2315 case 'K':
2316 case 'k':
2317 if (value > ~0U >> 10)
2318 return text;
2319 value = value << 10;
2320 break;
2321 case 'M':
2322 case 'm':
2323 if (value > ~0U >> 20)
2324 return text;
2325 value = value << 20;
2326 break;
2327 case 'G':
2328 case 'g':
2329 if (value > ~0U >> 30)
2330 return text;
2331 value = value << 30;
2332 break;
2333 default:
2334 return text;
2335 }
2336
Godbach58048a22015-01-28 17:36:16 +08002337 if (*text != '\0' && *++text != '\0')
2338 return text;
2339
Emeric Brun39132b22010-01-04 14:57:24 +01002340 *ret = value;
2341 return NULL;
2342}
2343
Willy Tarreau126d4062013-12-03 17:50:47 +01002344/*
2345 * Parse binary string written in hexadecimal (source) and store the decoded
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002346 * result into binstr and set binstrlen to the length of binstr. Memory for
Willy Tarreau126d4062013-12-03 17:50:47 +01002347 * binstr is allocated by the function. In case of error, returns 0 with an
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002348 * error message in err. In success case, it returns the consumed length.
Willy Tarreau126d4062013-12-03 17:50:47 +01002349 */
2350int parse_binary(const char *source, char **binstr, int *binstrlen, char **err)
2351{
2352 int len;
2353 const char *p = source;
2354 int i,j;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002355 int alloc;
Willy Tarreau126d4062013-12-03 17:50:47 +01002356
2357 len = strlen(source);
2358 if (len % 2) {
2359 memprintf(err, "an even number of hex digit is expected");
2360 return 0;
2361 }
2362
2363 len = len >> 1;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002364
Willy Tarreau126d4062013-12-03 17:50:47 +01002365 if (!*binstr) {
Tim Duesterhuse52b6e52020-09-12 20:26:43 +02002366 *binstr = calloc(len, sizeof(**binstr));
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002367 if (!*binstr) {
2368 memprintf(err, "out of memory while loading string pattern");
2369 return 0;
2370 }
2371 alloc = 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002372 }
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002373 else {
2374 if (*binstrlen < len) {
Joseph Herlant76dbe782018-11-15 12:01:22 -08002375 memprintf(err, "no space available in the buffer. expect %d, provides %d",
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002376 len, *binstrlen);
2377 return 0;
2378 }
2379 alloc = 0;
2380 }
2381 *binstrlen = len;
Willy Tarreau126d4062013-12-03 17:50:47 +01002382
2383 i = j = 0;
2384 while (j < len) {
2385 if (!ishex(p[i++]))
2386 goto bad_input;
2387 if (!ishex(p[i++]))
2388 goto bad_input;
2389 (*binstr)[j++] = (hex2i(p[i-2]) << 4) + hex2i(p[i-1]);
2390 }
Thierry FOURNIERee330af2014-01-21 11:36:14 +01002391 return len << 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002392
2393bad_input:
2394 memprintf(err, "an hex digit is expected (found '%c')", p[i-1]);
Andreas Seltenreich93f91c32016-03-03 20:40:37 +01002395 if (alloc) {
2396 free(*binstr);
2397 *binstr = NULL;
2398 }
Willy Tarreau126d4062013-12-03 17:50:47 +01002399 return 0;
2400}
2401
Willy Tarreau946ba592009-05-10 15:41:18 +02002402/* copies at most <n> characters from <src> and always terminates with '\0' */
2403char *my_strndup(const char *src, int n)
2404{
2405 int len = 0;
2406 char *ret;
2407
2408 while (len < n && src[len])
2409 len++;
2410
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02002411 ret = malloc(len + 1);
Willy Tarreau946ba592009-05-10 15:41:18 +02002412 if (!ret)
2413 return ret;
2414 memcpy(ret, src, len);
2415 ret[len] = '\0';
2416 return ret;
2417}
2418
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +02002419/*
2420 * search needle in haystack
2421 * returns the pointer if found, returns NULL otherwise
2422 */
2423const void *my_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen)
2424{
2425 const void *c = NULL;
2426 unsigned char f;
2427
2428 if ((haystack == NULL) || (needle == NULL) || (haystacklen < needlelen))
2429 return NULL;
2430
2431 f = *(char *)needle;
2432 c = haystack;
2433 while ((c = memchr(c, f, haystacklen - (c - haystack))) != NULL) {
2434 if ((haystacklen - (c - haystack)) < needlelen)
2435 return NULL;
2436
2437 if (memcmp(c, needle, needlelen) == 0)
2438 return c;
2439 ++c;
2440 }
2441 return NULL;
2442}
2443
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002444/* get length of the initial segment consisting entirely of bytes in <accept> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002445size_t my_memspn(const void *str, size_t len, const void *accept, size_t acceptlen)
2446{
2447 size_t ret = 0;
2448
2449 while (ret < len && memchr(accept, *((int *)str), acceptlen)) {
2450 str++;
2451 ret++;
2452 }
2453 return ret;
2454}
2455
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002456/* get length of the initial segment consisting entirely of bytes not in <rejcet> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002457size_t my_memcspn(const void *str, size_t len, const void *reject, size_t rejectlen)
2458{
2459 size_t ret = 0;
2460
2461 while (ret < len) {
2462 if(memchr(reject, *((int *)str), rejectlen))
2463 return ret;
2464 str++;
2465 ret++;
2466 }
2467 return ret;
2468}
2469
Willy Tarreau482b00d2009-10-04 22:48:42 +02002470/* This function returns the first unused key greater than or equal to <key> in
2471 * ID tree <root>. Zero is returned if no place is found.
2472 */
2473unsigned int get_next_id(struct eb_root *root, unsigned int key)
2474{
2475 struct eb32_node *used;
2476
2477 do {
2478 used = eb32_lookup_ge(root, key);
2479 if (!used || used->key > key)
2480 return key; /* key is available */
2481 key++;
2482 } while (key);
2483 return key;
2484}
2485
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002486/* dump the full tree to <file> in DOT format for debugging purposes. Will
2487 * optionally highlight node <subj> if found, depending on operation <op> :
2488 * 0 : nothing
2489 * >0 : insertion, node/leaf are surrounded in red
2490 * <0 : removal, node/leaf are dashed with no background
2491 * Will optionally add "desc" as a label on the graph if set and non-null.
2492 */
2493void eb32sc_to_file(FILE *file, struct eb_root *root, const struct eb32sc_node *subj, int op, const char *desc)
Willy Tarreaued3cda02017-11-15 15:04:05 +01002494{
2495 struct eb32sc_node *node;
2496 unsigned long scope = -1;
2497
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002498 fprintf(file, "digraph ebtree {\n");
2499
2500 if (desc && *desc) {
2501 fprintf(file,
2502 " fontname=\"fixed\";\n"
2503 " fontsize=8;\n"
2504 " label=\"%s\";\n", desc);
2505 }
2506
Willy Tarreaued3cda02017-11-15 15:04:05 +01002507 fprintf(file,
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002508 " node [fontname=\"fixed\" fontsize=8 shape=\"box\" style=\"filled\" color=\"black\" fillcolor=\"white\"];\n"
2509 " edge [fontname=\"fixed\" fontsize=8 style=\"solid\" color=\"magenta\" dir=\"forward\"];\n"
Willy Tarreaued3cda02017-11-15 15:04:05 +01002510 " \"%lx_n\" [label=\"root\\n%lx\"]\n", (long)eb_root_to_node(root), (long)root
2511 );
2512
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002513 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002514 (long)eb_root_to_node(root),
2515 (long)eb_root_to_node(eb_clrtag(root->b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002516 eb_gettag(root->b[0]) == EB_LEAF ? 'l' : 'n');
2517
2518 node = eb32sc_first(root, scope);
2519 while (node) {
2520 if (node->node.node_p) {
2521 /* node part is used */
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002522 fprintf(file, " \"%lx_n\" [label=\"%lx\\nkey=%u\\nscope=%lx\\nbit=%d\" fillcolor=\"lightskyblue1\" %s];\n",
2523 (long)node, (long)node, node->key, node->node_s, node->node.bit,
2524 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002525
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002526 fprintf(file, " \"%lx_n\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002527 (long)node,
2528 (long)eb_root_to_node(eb_clrtag(node->node.node_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002529 eb_gettag(node->node.node_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002530
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002531 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002532 (long)node,
2533 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002534 eb_gettag(node->node.branches.b[0]) == EB_LEAF ? 'l' : 'n');
2535
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002536 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"R\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002537 (long)node,
2538 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[1])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002539 eb_gettag(node->node.branches.b[1]) == EB_LEAF ? 'l' : 'n');
2540 }
2541
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002542 fprintf(file, " \"%lx_l\" [label=\"%lx\\nkey=%u\\nscope=%lx\\npfx=%u\" fillcolor=\"yellow\" %s];\n",
2543 (long)node, (long)node, node->key, node->leaf_s, node->node.pfx,
2544 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002545
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002546 fprintf(file, " \"%lx_l\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002547 (long)node,
2548 (long)eb_root_to_node(eb_clrtag(node->node.leaf_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002549 eb_gettag(node->node.leaf_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002550 node = eb32sc_next(node, scope);
2551 }
2552 fprintf(file, "}\n");
2553}
2554
Willy Tarreau348238b2010-01-18 15:05:57 +01002555/* This function compares a sample word possibly followed by blanks to another
2556 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
2557 * otherwise zero. This intends to be used when checking HTTP headers for some
2558 * values. Note that it validates a word followed only by blanks but does not
2559 * validate a word followed by blanks then other chars.
2560 */
2561int word_match(const char *sample, int slen, const char *word, int wlen)
2562{
2563 if (slen < wlen)
2564 return 0;
2565
2566 while (wlen) {
2567 char c = *sample ^ *word;
2568 if (c && c != ('A' ^ 'a'))
2569 return 0;
2570 sample++;
2571 word++;
2572 slen--;
2573 wlen--;
2574 }
2575
2576 while (slen) {
2577 if (*sample != ' ' && *sample != '\t')
2578 return 0;
2579 sample++;
2580 slen--;
2581 }
2582 return 1;
2583}
Willy Tarreau482b00d2009-10-04 22:48:42 +02002584
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002585/* Converts any text-formatted IPv4 address to a host-order IPv4 address. It
2586 * is particularly fast because it avoids expensive operations such as
2587 * multiplies, which are optimized away at the end. It requires a properly
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002588 * formatted address though (3 points).
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002589 */
2590unsigned int inetaddr_host(const char *text)
2591{
2592 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2593 register unsigned int dig100, dig10, dig1;
2594 int s;
2595 const char *p, *d;
2596
2597 dig1 = dig10 = dig100 = ascii_zero;
2598 s = 24;
2599
2600 p = text;
2601 while (1) {
2602 if (((unsigned)(*p - '0')) <= 9) {
2603 p++;
2604 continue;
2605 }
2606
2607 /* here, we have a complete byte between <text> and <p> (exclusive) */
2608 if (p == text)
2609 goto end;
2610
2611 d = p - 1;
2612 dig1 |= (unsigned int)(*d << s);
2613 if (d == text)
2614 goto end;
2615
2616 d--;
2617 dig10 |= (unsigned int)(*d << s);
2618 if (d == text)
2619 goto end;
2620
2621 d--;
2622 dig100 |= (unsigned int)(*d << s);
2623 end:
2624 if (!s || *p != '.')
2625 break;
2626
2627 s -= 8;
2628 text = ++p;
2629 }
2630
2631 dig100 -= ascii_zero;
2632 dig10 -= ascii_zero;
2633 dig1 -= ascii_zero;
2634 return ((dig100 * 10) + dig10) * 10 + dig1;
2635}
2636
2637/*
2638 * Idem except the first unparsed character has to be passed in <stop>.
2639 */
2640unsigned int inetaddr_host_lim(const char *text, const char *stop)
2641{
2642 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2643 register unsigned int dig100, dig10, dig1;
2644 int s;
2645 const char *p, *d;
2646
2647 dig1 = dig10 = dig100 = ascii_zero;
2648 s = 24;
2649
2650 p = text;
2651 while (1) {
2652 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2653 p++;
2654 continue;
2655 }
2656
2657 /* here, we have a complete byte between <text> and <p> (exclusive) */
2658 if (p == text)
2659 goto end;
2660
2661 d = p - 1;
2662 dig1 |= (unsigned int)(*d << s);
2663 if (d == text)
2664 goto end;
2665
2666 d--;
2667 dig10 |= (unsigned int)(*d << s);
2668 if (d == text)
2669 goto end;
2670
2671 d--;
2672 dig100 |= (unsigned int)(*d << s);
2673 end:
2674 if (!s || p == stop || *p != '.')
2675 break;
2676
2677 s -= 8;
2678 text = ++p;
2679 }
2680
2681 dig100 -= ascii_zero;
2682 dig10 -= ascii_zero;
2683 dig1 -= ascii_zero;
2684 return ((dig100 * 10) + dig10) * 10 + dig1;
2685}
2686
2687/*
2688 * Idem except the pointer to first unparsed byte is returned into <ret> which
2689 * must not be NULL.
2690 */
Willy Tarreau74172752010-10-15 23:21:42 +02002691unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret)
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002692{
2693 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2694 register unsigned int dig100, dig10, dig1;
2695 int s;
Willy Tarreau74172752010-10-15 23:21:42 +02002696 char *p, *d;
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002697
2698 dig1 = dig10 = dig100 = ascii_zero;
2699 s = 24;
2700
2701 p = text;
2702 while (1) {
2703 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2704 p++;
2705 continue;
2706 }
2707
2708 /* here, we have a complete byte between <text> and <p> (exclusive) */
2709 if (p == text)
2710 goto end;
2711
2712 d = p - 1;
2713 dig1 |= (unsigned int)(*d << s);
2714 if (d == text)
2715 goto end;
2716
2717 d--;
2718 dig10 |= (unsigned int)(*d << s);
2719 if (d == text)
2720 goto end;
2721
2722 d--;
2723 dig100 |= (unsigned int)(*d << s);
2724 end:
2725 if (!s || p == stop || *p != '.')
2726 break;
2727
2728 s -= 8;
2729 text = ++p;
2730 }
2731
2732 *ret = p;
2733 dig100 -= ascii_zero;
2734 dig10 -= ascii_zero;
2735 dig1 -= ascii_zero;
2736 return ((dig100 * 10) + dig10) * 10 + dig1;
2737}
2738
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002739/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
2740 * or the number of chars read in case of success. Maybe this could be replaced
2741 * by one of the functions above. Also, apparently this function does not support
2742 * hosts above 255 and requires exactly 4 octets.
Willy Tarreau075415a2013-12-12 11:29:39 +01002743 * The destination is only modified on success.
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002744 */
2745int buf2ip(const char *buf, size_t len, struct in_addr *dst)
2746{
2747 const char *addr;
2748 int saw_digit, octets, ch;
2749 u_char tmp[4], *tp;
2750 const char *cp = buf;
2751
2752 saw_digit = 0;
2753 octets = 0;
2754 *(tp = tmp) = 0;
2755
2756 for (addr = buf; addr - buf < len; addr++) {
2757 unsigned char digit = (ch = *addr) - '0';
2758
2759 if (digit > 9 && ch != '.')
2760 break;
2761
2762 if (digit <= 9) {
2763 u_int new = *tp * 10 + digit;
2764
2765 if (new > 255)
2766 return 0;
2767
2768 *tp = new;
2769
2770 if (!saw_digit) {
2771 if (++octets > 4)
2772 return 0;
2773 saw_digit = 1;
2774 }
2775 } else if (ch == '.' && saw_digit) {
2776 if (octets == 4)
2777 return 0;
2778
2779 *++tp = 0;
2780 saw_digit = 0;
2781 } else
2782 return 0;
2783 }
2784
2785 if (octets < 4)
2786 return 0;
2787
2788 memcpy(&dst->s_addr, tmp, 4);
2789 return addr - cp;
2790}
2791
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002792/* This function converts the string in <buf> of the len <len> to
2793 * struct in6_addr <dst> which must be allocated by the caller.
2794 * This function returns 1 in success case, otherwise zero.
Willy Tarreau075415a2013-12-12 11:29:39 +01002795 * The destination is only modified on success.
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002796 */
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002797int buf2ip6(const char *buf, size_t len, struct in6_addr *dst)
2798{
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002799 char null_term_ip6[INET6_ADDRSTRLEN + 1];
Willy Tarreau075415a2013-12-12 11:29:39 +01002800 struct in6_addr out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002801
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002802 if (len > INET6_ADDRSTRLEN)
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002803 return 0;
2804
2805 memcpy(null_term_ip6, buf, len);
2806 null_term_ip6[len] = '\0';
2807
Willy Tarreau075415a2013-12-12 11:29:39 +01002808 if (!inet_pton(AF_INET6, null_term_ip6, &out))
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002809 return 0;
2810
Willy Tarreau075415a2013-12-12 11:29:39 +01002811 *dst = out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002812 return 1;
2813}
2814
Willy Tarreauacf95772010-06-14 19:09:21 +02002815/* To be used to quote config arg positions. Returns the short string at <ptr>
2816 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
2817 * if ptr is NULL or empty. The string is locally allocated.
2818 */
2819const char *quote_arg(const char *ptr)
2820{
Christopher Faulet1bc04c72017-10-29 20:14:08 +01002821 static THREAD_LOCAL char val[32];
Willy Tarreauacf95772010-06-14 19:09:21 +02002822 int i;
2823
2824 if (!ptr || !*ptr)
2825 return "end of line";
2826 val[0] = '\'';
Willy Tarreaude2dd6b2013-01-24 02:14:42 +01002827 for (i = 1; i < sizeof(val) - 2 && *ptr; i++)
Willy Tarreauacf95772010-06-14 19:09:21 +02002828 val[i] = *ptr++;
2829 val[i++] = '\'';
2830 val[i] = '\0';
2831 return val;
2832}
2833
Willy Tarreau5b180202010-07-18 10:40:48 +02002834/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
2835int get_std_op(const char *str)
2836{
2837 int ret = -1;
2838
2839 if (*str == 'e' && str[1] == 'q')
2840 ret = STD_OP_EQ;
2841 else if (*str == 'n' && str[1] == 'e')
2842 ret = STD_OP_NE;
2843 else if (*str == 'l') {
2844 if (str[1] == 'e') ret = STD_OP_LE;
2845 else if (str[1] == 't') ret = STD_OP_LT;
2846 }
2847 else if (*str == 'g') {
2848 if (str[1] == 'e') ret = STD_OP_GE;
2849 else if (str[1] == 't') ret = STD_OP_GT;
2850 }
2851
2852 if (ret == -1 || str[2] != '\0')
2853 return -1;
2854 return ret;
2855}
2856
Willy Tarreau4c14eaa2010-11-24 14:01:45 +01002857/* hash a 32-bit integer to another 32-bit integer */
2858unsigned int full_hash(unsigned int a)
2859{
2860 return __full_hash(a);
2861}
2862
Willy Tarreauf3241112019-02-26 09:56:22 +01002863/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
2864 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
2865 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
2866 * a popcount variant and is described here :
2867 * https://graphics.stanford.edu/~seander/bithacks.html
2868 */
2869unsigned int mask_find_rank_bit(unsigned int r, unsigned long m)
2870{
2871 unsigned long a, b, c, d;
2872 unsigned int s;
2873 unsigned int t;
2874
2875 a = m - ((m >> 1) & ~0UL/3);
2876 b = (a & ~0UL/5) + ((a >> 2) & ~0UL/5);
2877 c = (b + (b >> 4)) & ~0UL/0x11;
2878 d = (c + (c >> 8)) & ~0UL/0x101;
2879
2880 r++; // make r be 1..64
2881
2882 t = 0;
2883 s = LONGBITS;
2884 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01002885 unsigned long d2 = (d >> 16) >> 16;
2886 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01002887 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
2888 }
2889
2890 t = (d >> (s - 16)) & 0xff;
2891 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
2892 t = (c >> (s - 8)) & 0xf;
2893 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
2894 t = (b >> (s - 4)) & 0x7;
2895 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
2896 t = (a >> (s - 2)) & 0x3;
2897 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
2898 t = (m >> (s - 1)) & 0x1;
2899 s -= ((t - r) & 256) >> 8;
2900
2901 return s - 1;
2902}
2903
2904/* Same as mask_find_rank_bit() above but makes use of pre-computed bitmaps
2905 * based on <m>, in <a..d>. These ones must be updated whenever <m> changes
2906 * using mask_prep_rank_map() below.
2907 */
2908unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
2909 unsigned long a, unsigned long b,
2910 unsigned long c, unsigned long d)
2911{
2912 unsigned int s;
2913 unsigned int t;
2914
2915 r++; // make r be 1..64
2916
2917 t = 0;
2918 s = LONGBITS;
2919 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01002920 unsigned long d2 = (d >> 16) >> 16;
2921 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01002922 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
2923 }
2924
2925 t = (d >> (s - 16)) & 0xff;
2926 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
2927 t = (c >> (s - 8)) & 0xf;
2928 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
2929 t = (b >> (s - 4)) & 0x7;
2930 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
2931 t = (a >> (s - 2)) & 0x3;
2932 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
2933 t = (m >> (s - 1)) & 0x1;
2934 s -= ((t - r) & 256) >> 8;
2935
2936 return s - 1;
2937}
2938
2939/* Prepare the bitmaps used by the fast implementation of the find_rank_bit()
2940 * above.
2941 */
2942void mask_prep_rank_map(unsigned long m,
2943 unsigned long *a, unsigned long *b,
2944 unsigned long *c, unsigned long *d)
2945{
2946 *a = m - ((m >> 1) & ~0UL/3);
2947 *b = (*a & ~0UL/5) + ((*a >> 2) & ~0UL/5);
2948 *c = (*b + (*b >> 4)) & ~0UL/0x11;
2949 *d = (*c + (*c >> 8)) & ~0UL/0x101;
2950}
2951
David du Colombier4f92d322011-03-24 11:09:31 +01002952/* Return non-zero if IPv4 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02002953 * otherwise zero. Note that <addr> may not necessarily be aligned
2954 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01002955 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02002956int in_net_ipv4(const void *addr, const struct in_addr *mask, const struct in_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01002957{
Willy Tarreaueec1d382016-07-13 11:59:39 +02002958 struct in_addr addr_copy;
2959
2960 memcpy(&addr_copy, addr, sizeof(addr_copy));
2961 return((addr_copy.s_addr & mask->s_addr) == (net->s_addr & mask->s_addr));
David du Colombier4f92d322011-03-24 11:09:31 +01002962}
2963
2964/* Return non-zero if IPv6 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02002965 * otherwise zero. Note that <addr> may not necessarily be aligned
2966 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01002967 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02002968int in_net_ipv6(const void *addr, const struct in6_addr *mask, const struct in6_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01002969{
2970 int i;
Willy Tarreaueec1d382016-07-13 11:59:39 +02002971 struct in6_addr addr_copy;
David du Colombier4f92d322011-03-24 11:09:31 +01002972
Willy Tarreaueec1d382016-07-13 11:59:39 +02002973 memcpy(&addr_copy, addr, sizeof(addr_copy));
David du Colombier4f92d322011-03-24 11:09:31 +01002974 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
Willy Tarreaueec1d382016-07-13 11:59:39 +02002975 if (((((int *)&addr_copy)[i] & ((int *)mask)[i])) !=
David du Colombier4f92d322011-03-24 11:09:31 +01002976 (((int *)net)[i] & ((int *)mask)[i]))
2977 return 0;
2978 return 1;
2979}
2980
2981/* RFC 4291 prefix */
2982const char rfc4291_pfx[] = { 0x00, 0x00, 0x00, 0x00,
2983 0x00, 0x00, 0x00, 0x00,
2984 0x00, 0x00, 0xFF, 0xFF };
2985
Joseph Herlant32b83272018-11-15 11:58:28 -08002986/* Map IPv4 address on IPv6 address, as specified in RFC 3513.
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01002987 * Input and output may overlap.
2988 */
David du Colombier4f92d322011-03-24 11:09:31 +01002989void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr)
2990{
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01002991 struct in_addr tmp_addr;
2992
2993 tmp_addr.s_addr = sin_addr->s_addr;
David du Colombier4f92d322011-03-24 11:09:31 +01002994 memcpy(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx));
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01002995 memcpy(sin6_addr->s6_addr+12, &tmp_addr.s_addr, 4);
David du Colombier4f92d322011-03-24 11:09:31 +01002996}
2997
Joseph Herlant32b83272018-11-15 11:58:28 -08002998/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01002999 * Return true if conversion is possible and false otherwise.
3000 */
3001int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr)
3002{
3003 if (memcmp(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx)) == 0) {
3004 memcpy(&(sin_addr->s_addr), &(sin6_addr->s6_addr[12]),
3005 sizeof(struct in_addr));
3006 return 1;
3007 }
3008
3009 return 0;
3010}
3011
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003012/* compare two struct sockaddr_storage and return:
3013 * 0 (true) if the addr is the same in both
3014 * 1 (false) if the addr is not the same in both
3015 * -1 (unable) if one of the addr is not AF_INET*
3016 */
3017int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2)
3018{
3019 if ((ss1->ss_family != AF_INET) && (ss1->ss_family != AF_INET6))
3020 return -1;
3021
3022 if ((ss2->ss_family != AF_INET) && (ss2->ss_family != AF_INET6))
3023 return -1;
3024
3025 if (ss1->ss_family != ss2->ss_family)
3026 return 1;
3027
3028 switch (ss1->ss_family) {
3029 case AF_INET:
3030 return memcmp(&((struct sockaddr_in *)ss1)->sin_addr,
3031 &((struct sockaddr_in *)ss2)->sin_addr,
3032 sizeof(struct in_addr)) != 0;
3033 case AF_INET6:
3034 return memcmp(&((struct sockaddr_in6 *)ss1)->sin6_addr,
3035 &((struct sockaddr_in6 *)ss2)->sin6_addr,
3036 sizeof(struct in6_addr)) != 0;
3037 }
3038
3039 return 1;
3040}
3041
Baptiste Assmann08396c82016-01-31 00:27:17 +01003042/* copy IP address from <source> into <dest>
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003043 * The caller must allocate and clear <dest> before calling.
3044 * The source must be in either AF_INET or AF_INET6 family, or the destination
3045 * address will be undefined. If the destination address used to hold a port,
3046 * it is preserved, so that this function can be used to switch to another
3047 * address family with no risk. Returns a pointer to the destination.
Baptiste Assmann08396c82016-01-31 00:27:17 +01003048 */
3049struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest)
3050{
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003051 int prev_port;
3052
3053 prev_port = get_net_port(dest);
3054 memset(dest, 0, sizeof(*dest));
Baptiste Assmann08396c82016-01-31 00:27:17 +01003055 dest->ss_family = source->ss_family;
3056
3057 /* copy new addr and apply it */
3058 switch (source->ss_family) {
3059 case AF_INET:
3060 ((struct sockaddr_in *)dest)->sin_addr.s_addr = ((struct sockaddr_in *)source)->sin_addr.s_addr;
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003061 ((struct sockaddr_in *)dest)->sin_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003062 break;
3063 case AF_INET6:
3064 memcpy(((struct sockaddr_in6 *)dest)->sin6_addr.s6_addr, ((struct sockaddr_in6 *)source)->sin6_addr.s6_addr, sizeof(struct in6_addr));
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003065 ((struct sockaddr_in6 *)dest)->sin6_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003066 break;
3067 }
3068
3069 return dest;
3070}
3071
William Lallemand421f5b52012-02-06 18:15:57 +01003072char *human_time(int t, short hz_div) {
3073 static char rv[sizeof("24855d23h")+1]; // longest of "23h59m" and "59m59s"
3074 char *p = rv;
Willy Tarreau761b3d52014-04-14 14:53:06 +02003075 char *end = rv + sizeof(rv);
William Lallemand421f5b52012-02-06 18:15:57 +01003076 int cnt=2; // print two numbers
3077
3078 if (unlikely(t < 0 || hz_div <= 0)) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003079 snprintf(p, end - p, "?");
William Lallemand421f5b52012-02-06 18:15:57 +01003080 return rv;
3081 }
3082
3083 if (unlikely(hz_div > 1))
3084 t /= hz_div;
3085
3086 if (t >= DAY) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003087 p += snprintf(p, end - p, "%dd", t / DAY);
William Lallemand421f5b52012-02-06 18:15:57 +01003088 cnt--;
3089 }
3090
3091 if (cnt && t % DAY / HOUR) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003092 p += snprintf(p, end - p, "%dh", t % DAY / HOUR);
William Lallemand421f5b52012-02-06 18:15:57 +01003093 cnt--;
3094 }
3095
3096 if (cnt && t % HOUR / MINUTE) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003097 p += snprintf(p, end - p, "%dm", t % HOUR / MINUTE);
William Lallemand421f5b52012-02-06 18:15:57 +01003098 cnt--;
3099 }
3100
3101 if ((cnt && t % MINUTE) || !t) // also display '0s'
Willy Tarreau761b3d52014-04-14 14:53:06 +02003102 p += snprintf(p, end - p, "%ds", t % MINUTE / SEC);
William Lallemand421f5b52012-02-06 18:15:57 +01003103
3104 return rv;
3105}
3106
3107const char *monthname[12] = {
3108 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
3109 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
3110};
3111
3112/* date2str_log: write a date in the format :
3113 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
3114 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3115 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
3116 *
3117 * without using sprintf. return a pointer to the last char written (\0) or
3118 * NULL if there isn't enough space.
3119 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02003120char *date2str_log(char *dst, const struct tm *tm, const struct timeval *date, size_t size)
William Lallemand421f5b52012-02-06 18:15:57 +01003121{
3122
3123 if (size < 25) /* the size is fixed: 24 chars + \0 */
3124 return NULL;
3125
3126 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003127 if (!dst)
3128 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003129 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003130
William Lallemand421f5b52012-02-06 18:15:57 +01003131 memcpy(dst, monthname[tm->tm_mon], 3); // month
3132 dst += 3;
3133 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003134
William Lallemand421f5b52012-02-06 18:15:57 +01003135 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003136 if (!dst)
3137 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003138 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003139
William Lallemand421f5b52012-02-06 18:15:57 +01003140 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003141 if (!dst)
3142 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003143 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003144
William Lallemand421f5b52012-02-06 18:15:57 +01003145 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003146 if (!dst)
3147 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003148 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003149
William Lallemand421f5b52012-02-06 18:15:57 +01003150 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003151 if (!dst)
3152 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003153 *dst++ = '.';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003154
Willy Tarreau7d9421d2020-02-29 09:08:02 +01003155 dst = utoa_pad((unsigned int)(date->tv_usec/1000)%1000, dst, 4); // milliseconds
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003156 if (!dst)
3157 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003158 *dst = '\0';
3159
3160 return dst;
3161}
3162
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003163/* Base year used to compute leap years */
3164#define TM_YEAR_BASE 1900
3165
3166/* Return the difference in seconds between two times (leap seconds are ignored).
3167 * Retrieved from glibc 2.18 source code.
3168 */
3169static int my_tm_diff(const struct tm *a, const struct tm *b)
3170{
3171 /* Compute intervening leap days correctly even if year is negative.
3172 * Take care to avoid int overflow in leap day calculations,
3173 * but it's OK to assume that A and B are close to each other.
3174 */
3175 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
3176 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
3177 int a100 = a4 / 25 - (a4 % 25 < 0);
3178 int b100 = b4 / 25 - (b4 % 25 < 0);
3179 int a400 = a100 >> 2;
3180 int b400 = b100 >> 2;
3181 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
3182 int years = a->tm_year - b->tm_year;
3183 int days = (365 * years + intervening_leap_days
3184 + (a->tm_yday - b->tm_yday));
3185 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
3186 + (a->tm_min - b->tm_min))
3187 + (a->tm_sec - b->tm_sec));
3188}
3189
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003190/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003191 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003192 * The string returned has the same format as returned by strftime(... "%z", tm).
3193 * Offsets are kept in an internal cache for better performances.
3194 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003195const char *get_gmt_offset(time_t t, struct tm *tm)
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003196{
3197 /* Cache offsets from GMT (depending on whether DST is active or not) */
Christopher Faulet1bc04c72017-10-29 20:14:08 +01003198 static THREAD_LOCAL char gmt_offsets[2][5+1] = { "", "" };
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003199
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003200 char *gmt_offset;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003201 struct tm tm_gmt;
3202 int diff;
3203 int isdst = tm->tm_isdst;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003204
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003205 /* Pretend DST not active if its status is unknown */
3206 if (isdst < 0)
3207 isdst = 0;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003208
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003209 /* Fetch the offset and initialize it if needed */
3210 gmt_offset = gmt_offsets[isdst & 0x01];
3211 if (unlikely(!*gmt_offset)) {
3212 get_gmtime(t, &tm_gmt);
3213 diff = my_tm_diff(tm, &tm_gmt);
3214 if (diff < 0) {
3215 diff = -diff;
3216 *gmt_offset = '-';
3217 } else {
3218 *gmt_offset = '+';
3219 }
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003220 diff %= 86400U;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003221 diff /= 60; /* Convert to minutes */
3222 snprintf(gmt_offset+1, 4+1, "%02d%02d", diff/60, diff%60);
3223 }
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003224
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003225 return gmt_offset;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003226}
3227
William Lallemand421f5b52012-02-06 18:15:57 +01003228/* gmt2str_log: write a date in the format :
3229 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
3230 * return a pointer to the last char written (\0) or
3231 * NULL if there isn't enough space.
3232 */
3233char *gmt2str_log(char *dst, struct tm *tm, size_t size)
3234{
Yuxans Yao4e25b012012-10-19 10:36:09 +08003235 if (size < 27) /* the size is fixed: 26 chars + \0 */
William Lallemand421f5b52012-02-06 18:15:57 +01003236 return NULL;
3237
3238 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003239 if (!dst)
3240 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003241 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003242
William Lallemand421f5b52012-02-06 18:15:57 +01003243 memcpy(dst, monthname[tm->tm_mon], 3); // month
3244 dst += 3;
3245 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003246
William Lallemand421f5b52012-02-06 18:15:57 +01003247 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003248 if (!dst)
3249 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003250 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003251
William Lallemand421f5b52012-02-06 18:15:57 +01003252 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003253 if (!dst)
3254 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003255 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003256
William Lallemand421f5b52012-02-06 18:15:57 +01003257 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003258 if (!dst)
3259 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003260 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003261
William Lallemand421f5b52012-02-06 18:15:57 +01003262 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003263 if (!dst)
3264 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003265 *dst++ = ' ';
3266 *dst++ = '+';
3267 *dst++ = '0';
3268 *dst++ = '0';
3269 *dst++ = '0';
3270 *dst++ = '0';
3271 *dst = '\0';
3272
3273 return dst;
3274}
3275
Yuxans Yao4e25b012012-10-19 10:36:09 +08003276/* localdate2str_log: write a date in the format :
3277 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003278 * Both t and tm must represent the same time.
3279 * return a pointer to the last char written (\0) or
3280 * NULL if there isn't enough space.
Yuxans Yao4e25b012012-10-19 10:36:09 +08003281 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003282char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size)
Yuxans Yao4e25b012012-10-19 10:36:09 +08003283{
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003284 const char *gmt_offset;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003285 if (size < 27) /* the size is fixed: 26 chars + \0 */
3286 return NULL;
3287
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003288 gmt_offset = get_gmt_offset(t, tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003289
Yuxans Yao4e25b012012-10-19 10:36:09 +08003290 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003291 if (!dst)
3292 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003293 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003294
Yuxans Yao4e25b012012-10-19 10:36:09 +08003295 memcpy(dst, monthname[tm->tm_mon], 3); // month
3296 dst += 3;
3297 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003298
Yuxans Yao4e25b012012-10-19 10:36:09 +08003299 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003300 if (!dst)
3301 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003302 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003303
Yuxans Yao4e25b012012-10-19 10:36:09 +08003304 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003305 if (!dst)
3306 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003307 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003308
Yuxans Yao4e25b012012-10-19 10:36:09 +08003309 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003310 if (!dst)
3311 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003312 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003313
Yuxans Yao4e25b012012-10-19 10:36:09 +08003314 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003315 if (!dst)
3316 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003317 *dst++ = ' ';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003318
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003319 memcpy(dst, gmt_offset, 5); // Offset from local time to GMT
Yuxans Yao4e25b012012-10-19 10:36:09 +08003320 dst += 5;
3321 *dst = '\0';
3322
3323 return dst;
3324}
3325
Willy Tarreaucb1949b2017-07-19 19:05:29 +02003326/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
3327 * It is meant as a portable replacement for timegm() for use with valid inputs.
3328 * Returns undefined results for invalid dates (eg: months out of range 0..11).
3329 */
3330time_t my_timegm(const struct tm *tm)
3331{
3332 /* Each month has 28, 29, 30 or 31 days, or 28+N. The date in the year
3333 * is thus (current month - 1)*28 + cumulated_N[month] to count the
3334 * sum of the extra N days for elapsed months. The sum of all these N
3335 * days doesn't exceed 30 for a complete year (366-12*28) so it fits
3336 * in a 5-bit word. This means that with 60 bits we can represent a
3337 * matrix of all these values at once, which is fast and efficient to
3338 * access. The extra February day for leap years is not counted here.
3339 *
3340 * Jan : none = 0 (0)
3341 * Feb : Jan = 3 (3)
3342 * Mar : Jan..Feb = 3 (3 + 0)
3343 * Apr : Jan..Mar = 6 (3 + 0 + 3)
3344 * May : Jan..Apr = 8 (3 + 0 + 3 + 2)
3345 * Jun : Jan..May = 11 (3 + 0 + 3 + 2 + 3)
3346 * Jul : Jan..Jun = 13 (3 + 0 + 3 + 2 + 3 + 2)
3347 * Aug : Jan..Jul = 16 (3 + 0 + 3 + 2 + 3 + 2 + 3)
3348 * Sep : Jan..Aug = 19 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3)
3349 * Oct : Jan..Sep = 21 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2)
3350 * Nov : Jan..Oct = 24 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3)
3351 * Dec : Jan..Nov = 26 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3 + 2)
3352 */
3353 uint64_t extra =
3354 ( 0ULL << 0*5) + ( 3ULL << 1*5) + ( 3ULL << 2*5) + /* Jan, Feb, Mar, */
3355 ( 6ULL << 3*5) + ( 8ULL << 4*5) + (11ULL << 5*5) + /* Apr, May, Jun, */
3356 (13ULL << 6*5) + (16ULL << 7*5) + (19ULL << 8*5) + /* Jul, Aug, Sep, */
3357 (21ULL << 9*5) + (24ULL << 10*5) + (26ULL << 11*5); /* Oct, Nov, Dec, */
3358
3359 unsigned int y = tm->tm_year + 1900;
3360 unsigned int m = tm->tm_mon;
3361 unsigned long days = 0;
3362
3363 /* days since 1/1/1970 for full years */
3364 days += days_since_zero(y) - days_since_zero(1970);
3365
3366 /* days for full months in the current year */
3367 days += 28 * m + ((extra >> (m * 5)) & 0x1f);
3368
3369 /* count + 1 after March for leap years. A leap year is a year multiple
3370 * of 4, unless it's multiple of 100 without being multiple of 400. 2000
3371 * is leap, 1900 isn't, 1904 is.
3372 */
3373 if ((m > 1) && !(y & 3) && ((y % 100) || !(y % 400)))
3374 days++;
3375
3376 days += tm->tm_mday - 1;
3377 return days * 86400ULL + tm->tm_hour * 3600 + tm->tm_min * 60 + tm->tm_sec;
3378}
3379
Thierry Fournier93127942016-01-20 18:49:45 +01003380/* This function check a char. It returns true and updates
3381 * <date> and <len> pointer to the new position if the
3382 * character is found.
3383 */
3384static inline int parse_expect_char(const char **date, int *len, char c)
3385{
3386 if (*len < 1 || **date != c)
3387 return 0;
3388 (*len)--;
3389 (*date)++;
3390 return 1;
3391}
3392
3393/* This function expects a string <str> of len <l>. It return true and updates.
3394 * <date> and <len> if the string matches, otherwise, it returns false.
3395 */
3396static inline int parse_strcmp(const char **date, int *len, char *str, int l)
3397{
3398 if (*len < l || strncmp(*date, str, l) != 0)
3399 return 0;
3400 (*len) -= l;
3401 (*date) += l;
3402 return 1;
3403}
3404
3405/* This macro converts 3 chars name in integer. */
3406#define STR2I3(__a, __b, __c) ((__a) * 65536 + (__b) * 256 + (__c))
3407
3408/* day-name = %x4D.6F.6E ; "Mon", case-sensitive
3409 * / %x54.75.65 ; "Tue", case-sensitive
3410 * / %x57.65.64 ; "Wed", case-sensitive
3411 * / %x54.68.75 ; "Thu", case-sensitive
3412 * / %x46.72.69 ; "Fri", case-sensitive
3413 * / %x53.61.74 ; "Sat", case-sensitive
3414 * / %x53.75.6E ; "Sun", case-sensitive
3415 *
3416 * This array must be alphabetically sorted
3417 */
3418static inline int parse_http_dayname(const char **date, int *len, struct tm *tm)
3419{
3420 if (*len < 3)
3421 return 0;
3422 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3423 case STR2I3('M','o','n'): tm->tm_wday = 1; break;
3424 case STR2I3('T','u','e'): tm->tm_wday = 2; break;
3425 case STR2I3('W','e','d'): tm->tm_wday = 3; break;
3426 case STR2I3('T','h','u'): tm->tm_wday = 4; break;
3427 case STR2I3('F','r','i'): tm->tm_wday = 5; break;
3428 case STR2I3('S','a','t'): tm->tm_wday = 6; break;
3429 case STR2I3('S','u','n'): tm->tm_wday = 7; break;
3430 default: return 0;
3431 }
3432 *len -= 3;
3433 *date += 3;
3434 return 1;
3435}
3436
3437/* month = %x4A.61.6E ; "Jan", case-sensitive
3438 * / %x46.65.62 ; "Feb", case-sensitive
3439 * / %x4D.61.72 ; "Mar", case-sensitive
3440 * / %x41.70.72 ; "Apr", case-sensitive
3441 * / %x4D.61.79 ; "May", case-sensitive
3442 * / %x4A.75.6E ; "Jun", case-sensitive
3443 * / %x4A.75.6C ; "Jul", case-sensitive
3444 * / %x41.75.67 ; "Aug", case-sensitive
3445 * / %x53.65.70 ; "Sep", case-sensitive
3446 * / %x4F.63.74 ; "Oct", case-sensitive
3447 * / %x4E.6F.76 ; "Nov", case-sensitive
3448 * / %x44.65.63 ; "Dec", case-sensitive
3449 *
3450 * This array must be alphabetically sorted
3451 */
3452static inline int parse_http_monthname(const char **date, int *len, struct tm *tm)
3453{
3454 if (*len < 3)
3455 return 0;
3456 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3457 case STR2I3('J','a','n'): tm->tm_mon = 0; break;
3458 case STR2I3('F','e','b'): tm->tm_mon = 1; break;
3459 case STR2I3('M','a','r'): tm->tm_mon = 2; break;
3460 case STR2I3('A','p','r'): tm->tm_mon = 3; break;
3461 case STR2I3('M','a','y'): tm->tm_mon = 4; break;
3462 case STR2I3('J','u','n'): tm->tm_mon = 5; break;
3463 case STR2I3('J','u','l'): tm->tm_mon = 6; break;
3464 case STR2I3('A','u','g'): tm->tm_mon = 7; break;
3465 case STR2I3('S','e','p'): tm->tm_mon = 8; break;
3466 case STR2I3('O','c','t'): tm->tm_mon = 9; break;
3467 case STR2I3('N','o','v'): tm->tm_mon = 10; break;
3468 case STR2I3('D','e','c'): tm->tm_mon = 11; break;
3469 default: return 0;
3470 }
3471 *len -= 3;
3472 *date += 3;
3473 return 1;
3474}
3475
3476/* day-name-l = %x4D.6F.6E.64.61.79 ; "Monday", case-sensitive
3477 * / %x54.75.65.73.64.61.79 ; "Tuesday", case-sensitive
3478 * / %x57.65.64.6E.65.73.64.61.79 ; "Wednesday", case-sensitive
3479 * / %x54.68.75.72.73.64.61.79 ; "Thursday", case-sensitive
3480 * / %x46.72.69.64.61.79 ; "Friday", case-sensitive
3481 * / %x53.61.74.75.72.64.61.79 ; "Saturday", case-sensitive
3482 * / %x53.75.6E.64.61.79 ; "Sunday", case-sensitive
3483 *
3484 * This array must be alphabetically sorted
3485 */
3486static inline int parse_http_ldayname(const char **date, int *len, struct tm *tm)
3487{
3488 if (*len < 6) /* Minimum length. */
3489 return 0;
3490 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3491 case STR2I3('M','o','n'):
3492 RET0_UNLESS(parse_strcmp(date, len, "Monday", 6));
3493 tm->tm_wday = 1;
3494 return 1;
3495 case STR2I3('T','u','e'):
3496 RET0_UNLESS(parse_strcmp(date, len, "Tuesday", 7));
3497 tm->tm_wday = 2;
3498 return 1;
3499 case STR2I3('W','e','d'):
3500 RET0_UNLESS(parse_strcmp(date, len, "Wednesday", 9));
3501 tm->tm_wday = 3;
3502 return 1;
3503 case STR2I3('T','h','u'):
3504 RET0_UNLESS(parse_strcmp(date, len, "Thursday", 8));
3505 tm->tm_wday = 4;
3506 return 1;
3507 case STR2I3('F','r','i'):
3508 RET0_UNLESS(parse_strcmp(date, len, "Friday", 6));
3509 tm->tm_wday = 5;
3510 return 1;
3511 case STR2I3('S','a','t'):
3512 RET0_UNLESS(parse_strcmp(date, len, "Saturday", 8));
3513 tm->tm_wday = 6;
3514 return 1;
3515 case STR2I3('S','u','n'):
3516 RET0_UNLESS(parse_strcmp(date, len, "Sunday", 6));
3517 tm->tm_wday = 7;
3518 return 1;
3519 }
3520 return 0;
3521}
3522
3523/* This function parses exactly 1 digit and returns the numeric value in "digit". */
3524static inline int parse_digit(const char **date, int *len, int *digit)
3525{
3526 if (*len < 1 || **date < '0' || **date > '9')
3527 return 0;
3528 *digit = (**date - '0');
3529 (*date)++;
3530 (*len)--;
3531 return 1;
3532}
3533
3534/* This function parses exactly 2 digits and returns the numeric value in "digit". */
3535static inline int parse_2digit(const char **date, int *len, int *digit)
3536{
3537 int value;
3538
3539 RET0_UNLESS(parse_digit(date, len, &value));
3540 (*digit) = value * 10;
3541 RET0_UNLESS(parse_digit(date, len, &value));
3542 (*digit) += value;
3543
3544 return 1;
3545}
3546
3547/* This function parses exactly 4 digits and returns the numeric value in "digit". */
3548static inline int parse_4digit(const char **date, int *len, int *digit)
3549{
3550 int value;
3551
3552 RET0_UNLESS(parse_digit(date, len, &value));
3553 (*digit) = value * 1000;
3554
3555 RET0_UNLESS(parse_digit(date, len, &value));
3556 (*digit) += value * 100;
3557
3558 RET0_UNLESS(parse_digit(date, len, &value));
3559 (*digit) += value * 10;
3560
3561 RET0_UNLESS(parse_digit(date, len, &value));
3562 (*digit) += value;
3563
3564 return 1;
3565}
3566
3567/* time-of-day = hour ":" minute ":" second
3568 * ; 00:00:00 - 23:59:60 (leap second)
3569 *
3570 * hour = 2DIGIT
3571 * minute = 2DIGIT
3572 * second = 2DIGIT
3573 */
3574static inline int parse_http_time(const char **date, int *len, struct tm *tm)
3575{
3576 RET0_UNLESS(parse_2digit(date, len, &tm->tm_hour)); /* hour 2DIGIT */
3577 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3578 RET0_UNLESS(parse_2digit(date, len, &tm->tm_min)); /* min 2DIGIT */
3579 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3580 RET0_UNLESS(parse_2digit(date, len, &tm->tm_sec)); /* sec 2DIGIT */
3581 return 1;
3582}
3583
3584/* From RFC7231
3585 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3586 *
3587 * IMF-fixdate = day-name "," SP date1 SP time-of-day SP GMT
3588 * ; fixed length/zone/capitalization subset of the format
3589 * ; see Section 3.3 of [RFC5322]
3590 *
3591 *
3592 * date1 = day SP month SP year
3593 * ; e.g., 02 Jun 1982
3594 *
3595 * day = 2DIGIT
3596 * year = 4DIGIT
3597 *
3598 * GMT = %x47.4D.54 ; "GMT", case-sensitive
3599 *
3600 * time-of-day = hour ":" minute ":" second
3601 * ; 00:00:00 - 23:59:60 (leap second)
3602 *
3603 * hour = 2DIGIT
3604 * minute = 2DIGIT
3605 * second = 2DIGIT
3606 *
3607 * DIGIT = decimal 0-9
3608 */
3609int parse_imf_date(const char *date, int len, struct tm *tm)
3610{
David Carlier327298c2016-11-20 10:42:38 +00003611 /* tm_gmtoff, if present, ought to be zero'ed */
3612 memset(tm, 0, sizeof(*tm));
3613
Thierry Fournier93127942016-01-20 18:49:45 +01003614 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3615 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3616 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3617 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3618 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3619 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3620 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3621 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3622 tm->tm_year -= 1900;
3623 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3624 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3625 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3626 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3627 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003628 return 1;
3629}
3630
3631/* From RFC7231
3632 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3633 *
3634 * rfc850-date = day-name-l "," SP date2 SP time-of-day SP GMT
3635 * date2 = day "-" month "-" 2DIGIT
3636 * ; e.g., 02-Jun-82
3637 *
3638 * day = 2DIGIT
3639 */
3640int parse_rfc850_date(const char *date, int len, struct tm *tm)
3641{
3642 int year;
3643
David Carlier327298c2016-11-20 10:42:38 +00003644 /* tm_gmtoff, if present, ought to be zero'ed */
3645 memset(tm, 0, sizeof(*tm));
3646
Thierry Fournier93127942016-01-20 18:49:45 +01003647 RET0_UNLESS(parse_http_ldayname(&date, &len, tm)); /* Read the day name */
3648 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3649 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3650 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3651 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3652 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3653 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3654
3655 /* year = 2DIGIT
3656 *
3657 * Recipients of a timestamp value in rfc850-(*date) format, which uses a
3658 * two-digit year, MUST interpret a timestamp that appears to be more
3659 * than 50 years in the future as representing the most recent year in
3660 * the past that had the same last two digits.
3661 */
3662 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_year));
3663
3664 /* expect SP */
3665 if (!parse_expect_char(&date, &len, ' ')) {
3666 /* Maybe we have the date with 4 digits. */
3667 RET0_UNLESS(parse_2digit(&date, &len, &year));
3668 tm->tm_year = (tm->tm_year * 100 + year) - 1900;
3669 /* expect SP */
3670 RET0_UNLESS(parse_expect_char(&date, &len, ' '));
3671 } else {
3672 /* I fix 60 as pivot: >60: +1900, <60: +2000. Note that the
3673 * tm_year is the number of year since 1900, so for +1900, we
3674 * do nothing, and for +2000, we add 100.
3675 */
3676 if (tm->tm_year <= 60)
3677 tm->tm_year += 100;
3678 }
3679
3680 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3681 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3682 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3683 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003684
3685 return 1;
3686}
3687
3688/* From RFC7231
3689 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3690 *
3691 * asctime-date = day-name SP date3 SP time-of-day SP year
3692 * date3 = month SP ( 2DIGIT / ( SP 1DIGIT ))
3693 * ; e.g., Jun 2
3694 *
3695 * HTTP-date is case sensitive. A sender MUST NOT generate additional
3696 * whitespace in an HTTP-date beyond that specifically included as SP in
3697 * the grammar.
3698 */
3699int parse_asctime_date(const char *date, int len, struct tm *tm)
3700{
David Carlier327298c2016-11-20 10:42:38 +00003701 /* tm_gmtoff, if present, ought to be zero'ed */
3702 memset(tm, 0, sizeof(*tm));
3703
Thierry Fournier93127942016-01-20 18:49:45 +01003704 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3705 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3706 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* expect month */
3707 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3708
3709 /* expect SP and 1DIGIT or 2DIGIT */
3710 if (parse_expect_char(&date, &len, ' '))
3711 RET0_UNLESS(parse_digit(&date, &len, &tm->tm_mday));
3712 else
3713 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday));
3714
3715 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3716 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3717 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3718 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3719 tm->tm_year -= 1900;
3720 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003721 return 1;
3722}
3723
3724/* From RFC7231
3725 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3726 *
3727 * HTTP-date = IMF-fixdate / obs-date
3728 * obs-date = rfc850-date / asctime-date
3729 *
3730 * parses an HTTP date in the RFC format and is accepted
3731 * alternatives. <date> is the strinf containing the date,
3732 * len is the len of the string. <tm> is filled with the
3733 * parsed time. We must considers this time as GMT.
3734 */
3735int parse_http_date(const char *date, int len, struct tm *tm)
3736{
3737 if (parse_imf_date(date, len, tm))
3738 return 1;
3739
3740 if (parse_rfc850_date(date, len, tm))
3741 return 1;
3742
3743 if (parse_asctime_date(date, len, tm))
3744 return 1;
3745
3746 return 0;
3747}
3748
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003749/* Dynamically allocates a string of the proper length to hold the formatted
3750 * output. NULL is returned on error. The caller is responsible for freeing the
3751 * memory area using free(). The resulting string is returned in <out> if the
3752 * pointer is not NULL. A previous version of <out> might be used to build the
3753 * new string, and it will be freed before returning if it is not NULL, which
3754 * makes it possible to build complex strings from iterative calls without
3755 * having to care about freeing intermediate values, as in the example below :
3756 *
3757 * memprintf(&err, "invalid argument: '%s'", arg);
3758 * ...
3759 * memprintf(&err, "parser said : <%s>\n", *err);
3760 * ...
3761 * free(*err);
3762 *
3763 * This means that <err> must be initialized to NULL before first invocation.
3764 * The return value also holds the allocated string, which eases error checking
3765 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02003766 * passed instead and it will be ignored. The returned message will then also
3767 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003768 *
3769 * It is also convenient to use it without any free except the last one :
3770 * err = NULL;
3771 * if (!fct1(err)) report(*err);
3772 * if (!fct2(err)) report(*err);
3773 * if (!fct3(err)) report(*err);
3774 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02003775 *
3776 * memprintf relies on memvprintf. This last version can be called from any
3777 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003778 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02003779char *memvprintf(char **out, const char *format, va_list orig_args)
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003780{
3781 va_list args;
3782 char *ret = NULL;
3783 int allocated = 0;
3784 int needed = 0;
3785
Willy Tarreaueb6cead2012-09-20 19:43:14 +02003786 if (!out)
3787 return NULL;
3788
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003789 do {
Willy Tarreaue0609f52019-03-29 19:13:23 +01003790 char buf1;
3791
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003792 /* vsnprintf() will return the required length even when the
3793 * target buffer is NULL. We do this in a loop just in case
3794 * intermediate evaluations get wrong.
3795 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02003796 va_copy(args, orig_args);
Willy Tarreaue0609f52019-03-29 19:13:23 +01003797 needed = vsnprintf(ret ? ret : &buf1, allocated, format, args);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003798 va_end(args);
Willy Tarreau1b2fed62013-04-01 22:48:54 +02003799 if (needed < allocated) {
3800 /* Note: on Solaris 8, the first iteration always
3801 * returns -1 if allocated is zero, so we force a
3802 * retry.
3803 */
3804 if (!allocated)
3805 needed = 0;
3806 else
3807 break;
3808 }
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003809
Willy Tarreau1b2fed62013-04-01 22:48:54 +02003810 allocated = needed + 1;
Hubert Verstraete831962e2016-06-28 22:44:26 +02003811 ret = my_realloc2(ret, allocated);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003812 } while (ret);
3813
3814 if (needed < 0) {
3815 /* an error was encountered */
3816 free(ret);
3817 ret = NULL;
3818 }
3819
3820 if (out) {
3821 free(*out);
3822 *out = ret;
3823 }
3824
3825 return ret;
3826}
William Lallemand421f5b52012-02-06 18:15:57 +01003827
Christopher Faulet93a518f2017-10-24 11:25:33 +02003828char *memprintf(char **out, const char *format, ...)
3829{
3830 va_list args;
3831 char *ret = NULL;
3832
3833 va_start(args, format);
3834 ret = memvprintf(out, format, args);
3835 va_end(args);
3836
3837 return ret;
3838}
3839
Willy Tarreau21c705b2012-09-14 11:40:36 +02003840/* Used to add <level> spaces before each line of <out>, unless there is only one line.
3841 * The input argument is automatically freed and reassigned. The result will have to be
Willy Tarreau70eec382012-10-10 08:56:47 +02003842 * freed by the caller. It also supports being passed a NULL which results in the same
3843 * output.
Willy Tarreau21c705b2012-09-14 11:40:36 +02003844 * Example of use :
3845 * parse(cmd, &err); (callee: memprintf(&err, ...))
3846 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
3847 * free(err);
3848 */
3849char *indent_msg(char **out, int level)
3850{
3851 char *ret, *in, *p;
3852 int needed = 0;
3853 int lf = 0;
3854 int lastlf = 0;
3855 int len;
3856
Willy Tarreau70eec382012-10-10 08:56:47 +02003857 if (!out || !*out)
3858 return NULL;
3859
Willy Tarreau21c705b2012-09-14 11:40:36 +02003860 in = *out - 1;
3861 while ((in = strchr(in + 1, '\n')) != NULL) {
3862 lastlf = in - *out;
3863 lf++;
3864 }
3865
3866 if (!lf) /* single line, no LF, return it as-is */
3867 return *out;
3868
3869 len = strlen(*out);
3870
3871 if (lf == 1 && lastlf == len - 1) {
3872 /* single line, LF at end, strip it and return as-is */
3873 (*out)[lastlf] = 0;
3874 return *out;
3875 }
3876
3877 /* OK now we have at least one LF, we need to process the whole string
3878 * as a multi-line string. What we'll do :
3879 * - prefix with an LF if there is none
3880 * - add <level> spaces before each line
3881 * This means at most ( 1 + level + (len-lf) + lf*<1+level) ) =
3882 * 1 + level + len + lf * level = 1 + level * (lf + 1) + len.
3883 */
3884
3885 needed = 1 + level * (lf + 1) + len + 1;
3886 p = ret = malloc(needed);
3887 in = *out;
3888
3889 /* skip initial LFs */
3890 while (*in == '\n')
3891 in++;
3892
3893 /* copy each line, prefixed with LF and <level> spaces, and without the trailing LF */
3894 while (*in) {
3895 *p++ = '\n';
3896 memset(p, ' ', level);
3897 p += level;
3898 do {
3899 *p++ = *in++;
3900 } while (*in && *in != '\n');
3901 if (*in)
3902 in++;
3903 }
3904 *p = 0;
3905
3906 free(*out);
3907 *out = ret;
3908
3909 return ret;
3910}
3911
Willy Tarreaua2c99112019-08-21 13:17:37 +02003912/* makes a copy of message <in> into <out>, with each line prefixed with <pfx>
3913 * and end of lines replaced with <eol> if not 0. The first line to indent has
3914 * to be indicated in <first> (starts at zero), so that it is possible to skip
3915 * indenting the first line if it has to be appended after an existing message.
3916 * Empty strings are never indented, and NULL strings are considered empty both
3917 * for <in> and <pfx>. It returns non-zero if an EOL was appended as the last
3918 * character, non-zero otherwise.
3919 */
3920int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first)
3921{
3922 int bol, lf;
3923 int pfxlen = pfx ? strlen(pfx) : 0;
3924
3925 if (!in)
3926 return 0;
3927
3928 bol = 1;
3929 lf = 0;
3930 while (*in) {
3931 if (bol && pfxlen) {
3932 if (first > 0)
3933 first--;
3934 else
3935 b_putblk(out, pfx, pfxlen);
3936 bol = 0;
3937 }
3938
3939 lf = (*in == '\n');
3940 bol |= lf;
3941 b_putchr(out, (lf && eol) ? eol : *in);
3942 in++;
3943 }
3944 return lf;
3945}
3946
Willy Tarreau9d22e562019-03-29 18:49:09 +01003947/* removes environment variable <name> from the environment as found in
3948 * environ. This is only provided as an alternative for systems without
3949 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05003950 * The principle is to scan environ for each occurrence of variable name
Willy Tarreau9d22e562019-03-29 18:49:09 +01003951 * <name> and to replace the matching pointers with the last pointer of
3952 * the array (since variables are not ordered).
3953 * It always returns 0 (success).
3954 */
3955int my_unsetenv(const char *name)
3956{
3957 extern char **environ;
3958 char **p = environ;
3959 int vars;
3960 int next;
3961 int len;
3962
3963 len = strlen(name);
3964 for (vars = 0; p[vars]; vars++)
3965 ;
3966 next = 0;
3967 while (next < vars) {
3968 if (strncmp(p[next], name, len) != 0 || p[next][len] != '=') {
3969 next++;
3970 continue;
3971 }
3972 if (next < vars - 1)
3973 p[next] = p[vars - 1];
3974 p[--vars] = NULL;
3975 }
3976 return 0;
3977}
3978
Willy Tarreaudad36a32013-03-11 01:20:04 +01003979/* Convert occurrences of environment variables in the input string to their
3980 * corresponding value. A variable is identified as a series of alphanumeric
3981 * characters or underscores following a '$' sign. The <in> string must be
3982 * free()able. NULL returns NULL. The resulting string might be reallocated if
3983 * some expansion is made. Variable names may also be enclosed into braces if
3984 * needed (eg: to concatenate alphanum characters).
3985 */
3986char *env_expand(char *in)
3987{
3988 char *txt_beg;
3989 char *out;
3990 char *txt_end;
3991 char *var_beg;
3992 char *var_end;
3993 char *value;
3994 char *next;
3995 int out_len;
3996 int val_len;
3997
3998 if (!in)
3999 return in;
4000
4001 value = out = NULL;
4002 out_len = 0;
4003
4004 txt_beg = in;
4005 do {
4006 /* look for next '$' sign in <in> */
4007 for (txt_end = txt_beg; *txt_end && *txt_end != '$'; txt_end++);
4008
4009 if (!*txt_end && !out) /* end and no expansion performed */
4010 return in;
4011
4012 val_len = 0;
4013 next = txt_end;
4014 if (*txt_end == '$') {
4015 char save;
4016
4017 var_beg = txt_end + 1;
4018 if (*var_beg == '{')
4019 var_beg++;
4020
4021 var_end = var_beg;
Willy Tarreau90807112020-02-25 08:16:33 +01004022 while (isalnum((unsigned char)*var_end) || *var_end == '_') {
Willy Tarreaudad36a32013-03-11 01:20:04 +01004023 var_end++;
4024 }
4025
4026 next = var_end;
4027 if (*var_end == '}' && (var_beg > txt_end + 1))
4028 next++;
4029
4030 /* get value of the variable name at this location */
4031 save = *var_end;
4032 *var_end = '\0';
4033 value = getenv(var_beg);
4034 *var_end = save;
4035 val_len = value ? strlen(value) : 0;
4036 }
4037
Hubert Verstraete831962e2016-06-28 22:44:26 +02004038 out = my_realloc2(out, out_len + (txt_end - txt_beg) + val_len + 1);
Willy Tarreaudad36a32013-03-11 01:20:04 +01004039 if (txt_end > txt_beg) {
4040 memcpy(out + out_len, txt_beg, txt_end - txt_beg);
4041 out_len += txt_end - txt_beg;
4042 }
4043 if (val_len) {
4044 memcpy(out + out_len, value, val_len);
4045 out_len += val_len;
4046 }
4047 out[out_len] = 0;
4048 txt_beg = next;
4049 } while (*txt_beg);
4050
4051 /* here we know that <out> was allocated and that we don't need <in> anymore */
4052 free(in);
4053 return out;
4054}
4055
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004056
4057/* same as strstr() but case-insensitive and with limit length */
4058const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2)
4059{
4060 char *pptr, *sptr, *start;
Willy Tarreauc8746532014-05-28 23:05:07 +02004061 unsigned int slen, plen;
4062 unsigned int tmp1, tmp2;
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004063
4064 if (str1 == NULL || len_str1 == 0) // search pattern into an empty string => search is not found
4065 return NULL;
4066
4067 if (str2 == NULL || len_str2 == 0) // pattern is empty => every str1 match
4068 return str1;
4069
4070 if (len_str1 < len_str2) // pattern is longer than string => search is not found
4071 return NULL;
4072
4073 for (tmp1 = 0, start = (char *)str1, pptr = (char *)str2, slen = len_str1, plen = len_str2; slen >= plen; start++, slen--) {
Willy Tarreauf278eec2020-07-05 21:46:32 +02004074 while (toupper((unsigned char)*start) != toupper((unsigned char)*str2)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004075 start++;
4076 slen--;
4077 tmp1++;
4078
4079 if (tmp1 >= len_str1)
4080 return NULL;
4081
4082 /* if pattern longer than string */
4083 if (slen < plen)
4084 return NULL;
4085 }
4086
4087 sptr = start;
4088 pptr = (char *)str2;
4089
4090 tmp2 = 0;
Willy Tarreauf278eec2020-07-05 21:46:32 +02004091 while (toupper((unsigned char)*sptr) == toupper((unsigned char)*pptr)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004092 sptr++;
4093 pptr++;
4094 tmp2++;
4095
4096 if (*pptr == '\0' || tmp2 == len_str2) /* end of pattern found */
4097 return start;
4098 if (*sptr == '\0' || tmp2 == len_str1) /* end of string found and the pattern is not fully found */
4099 return NULL;
4100 }
4101 }
4102 return NULL;
4103}
4104
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004105/* This function read the next valid utf8 char.
4106 * <s> is the byte srray to be decode, <len> is its length.
4107 * The function returns decoded char encoded like this:
4108 * The 4 msb are the return code (UTF8_CODE_*), the 4 lsb
4109 * are the length read. The decoded character is stored in <c>.
4110 */
4111unsigned char utf8_next(const char *s, int len, unsigned int *c)
4112{
4113 const unsigned char *p = (unsigned char *)s;
4114 int dec;
4115 unsigned char code = UTF8_CODE_OK;
4116
4117 if (len < 1)
4118 return UTF8_CODE_OK;
4119
4120 /* Check the type of UTF8 sequence
4121 *
4122 * 0... .... 0x00 <= x <= 0x7f : 1 byte: ascii char
4123 * 10.. .... 0x80 <= x <= 0xbf : invalid sequence
4124 * 110. .... 0xc0 <= x <= 0xdf : 2 bytes
4125 * 1110 .... 0xe0 <= x <= 0xef : 3 bytes
4126 * 1111 0... 0xf0 <= x <= 0xf7 : 4 bytes
4127 * 1111 10.. 0xf8 <= x <= 0xfb : 5 bytes
4128 * 1111 110. 0xfc <= x <= 0xfd : 6 bytes
4129 * 1111 111. 0xfe <= x <= 0xff : invalid sequence
4130 */
4131 switch (*p) {
4132 case 0x00 ... 0x7f:
4133 *c = *p;
4134 return UTF8_CODE_OK | 1;
4135
4136 case 0x80 ... 0xbf:
4137 *c = *p;
4138 return UTF8_CODE_BADSEQ | 1;
4139
4140 case 0xc0 ... 0xdf:
4141 if (len < 2) {
4142 *c = *p;
4143 return UTF8_CODE_BADSEQ | 1;
4144 }
4145 *c = *p & 0x1f;
4146 dec = 1;
4147 break;
4148
4149 case 0xe0 ... 0xef:
4150 if (len < 3) {
4151 *c = *p;
4152 return UTF8_CODE_BADSEQ | 1;
4153 }
4154 *c = *p & 0x0f;
4155 dec = 2;
4156 break;
4157
4158 case 0xf0 ... 0xf7:
4159 if (len < 4) {
4160 *c = *p;
4161 return UTF8_CODE_BADSEQ | 1;
4162 }
4163 *c = *p & 0x07;
4164 dec = 3;
4165 break;
4166
4167 case 0xf8 ... 0xfb:
4168 if (len < 5) {
4169 *c = *p;
4170 return UTF8_CODE_BADSEQ | 1;
4171 }
4172 *c = *p & 0x03;
4173 dec = 4;
4174 break;
4175
4176 case 0xfc ... 0xfd:
4177 if (len < 6) {
4178 *c = *p;
4179 return UTF8_CODE_BADSEQ | 1;
4180 }
4181 *c = *p & 0x01;
4182 dec = 5;
4183 break;
4184
4185 case 0xfe ... 0xff:
4186 default:
4187 *c = *p;
4188 return UTF8_CODE_BADSEQ | 1;
4189 }
4190
4191 p++;
4192
4193 while (dec > 0) {
4194
4195 /* need 0x10 for the 2 first bits */
4196 if ( ( *p & 0xc0 ) != 0x80 )
4197 return UTF8_CODE_BADSEQ | ((p-(unsigned char *)s)&0xffff);
4198
4199 /* add data at char */
4200 *c = ( *c << 6 ) | ( *p & 0x3f );
4201
4202 dec--;
4203 p++;
4204 }
4205
4206 /* Check ovelong encoding.
4207 * 1 byte : 5 + 6 : 11 : 0x80 ... 0x7ff
4208 * 2 bytes : 4 + 6 + 6 : 16 : 0x800 ... 0xffff
4209 * 3 bytes : 3 + 6 + 6 + 6 : 21 : 0x10000 ... 0x1fffff
4210 */
Thierry FOURNIER9e7ec082015-03-12 19:32:38 +01004211 if (( *c <= 0x7f && (p-(unsigned char *)s) > 1) ||
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004212 (*c >= 0x80 && *c <= 0x7ff && (p-(unsigned char *)s) > 2) ||
4213 (*c >= 0x800 && *c <= 0xffff && (p-(unsigned char *)s) > 3) ||
4214 (*c >= 0x10000 && *c <= 0x1fffff && (p-(unsigned char *)s) > 4))
4215 code |= UTF8_CODE_OVERLONG;
4216
4217 /* Check invalid UTF8 range. */
4218 if ((*c >= 0xd800 && *c <= 0xdfff) ||
4219 (*c >= 0xfffe && *c <= 0xffff))
4220 code |= UTF8_CODE_INVRANGE;
4221
4222 return code | ((p-(unsigned char *)s)&0x0f);
4223}
4224
Maxime de Roucydc887852016-05-13 23:52:54 +02004225/* append a copy of string <str> (in a wordlist) at the end of the list <li>
4226 * On failure : return 0 and <err> filled with an error message.
4227 * The caller is responsible for freeing the <err> and <str> copy
4228 * memory area using free()
4229 */
4230int list_append_word(struct list *li, const char *str, char **err)
4231{
4232 struct wordlist *wl;
4233
4234 wl = calloc(1, sizeof(*wl));
4235 if (!wl) {
4236 memprintf(err, "out of memory");
4237 goto fail_wl;
4238 }
4239
4240 wl->s = strdup(str);
4241 if (!wl->s) {
4242 memprintf(err, "out of memory");
4243 goto fail_wl_s;
4244 }
4245
4246 LIST_ADDQ(li, &wl->list);
4247
4248 return 1;
4249
4250fail_wl_s:
4251 free(wl->s);
4252fail_wl:
4253 free(wl);
4254 return 0;
4255}
4256
Willy Tarreau37101052019-05-20 16:48:20 +02004257/* indicates if a memory location may safely be read or not. The trick consists
4258 * in performing a harmless syscall using this location as an input and letting
4259 * the operating system report whether it's OK or not. For this we have the
4260 * stat() syscall, which will return EFAULT when the memory location supposed
4261 * to contain the file name is not readable. If it is readable it will then
4262 * either return 0 if the area contains an existing file name, or -1 with
4263 * another code. This must not be abused, and some audit systems might detect
4264 * this as abnormal activity. It's used only for unsafe dumps.
4265 */
4266int may_access(const void *ptr)
4267{
4268 struct stat buf;
4269
4270 if (stat(ptr, &buf) == 0)
4271 return 1;
4272 if (errno == EFAULT)
4273 return 0;
4274 return 1;
4275}
4276
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004277/* print a string of text buffer to <out>. The format is :
4278 * Non-printable chars \t, \n, \r and \e are * encoded in C format.
4279 * Other non-printable chars are encoded "\xHH". Space, '\', and '=' are also escaped.
4280 * Print stopped if null char or <bsize> is reached, or if no more place in the chunk.
4281 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004282int dump_text(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004283{
4284 unsigned char c;
4285 int ptr = 0;
4286
4287 while (buf[ptr] && ptr < bsize) {
4288 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004289 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\' && c != ' ' && c != '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004290 if (out->data > out->size - 1)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004291 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004292 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004293 }
4294 else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\' || c == ' ' || c == '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004295 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004296 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004297 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004298 switch (c) {
4299 case ' ': c = ' '; break;
4300 case '\t': c = 't'; break;
4301 case '\n': c = 'n'; break;
4302 case '\r': c = 'r'; break;
4303 case '\e': c = 'e'; break;
4304 case '\\': c = '\\'; break;
4305 case '=': c = '='; break;
4306 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004307 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004308 }
4309 else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004310 if (out->data > out->size - 4)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004311 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004312 out->area[out->data++] = '\\';
4313 out->area[out->data++] = 'x';
4314 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4315 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004316 }
4317 ptr++;
4318 }
4319
4320 return ptr;
4321}
4322
4323/* print a buffer in hexa.
4324 * Print stopped if <bsize> is reached, or if no more place in the chunk.
4325 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004326int dump_binary(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004327{
4328 unsigned char c;
4329 int ptr = 0;
4330
4331 while (ptr < bsize) {
4332 c = buf[ptr];
4333
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004334 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004335 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004336 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4337 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004338
4339 ptr++;
4340 }
4341 return ptr;
4342}
4343
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004344/* Appends into buffer <out> a hex dump of memory area <buf> for <len> bytes,
4345 * prepending each line with prefix <pfx>. The output is *not* initialized.
4346 * The output will not wrap pas the buffer's end so it is more optimal if the
4347 * caller makes sure the buffer is aligned first. A trailing zero will always
4348 * be appended (and not counted) if there is room for it. The caller must make
Willy Tarreau37101052019-05-20 16:48:20 +02004349 * sure that the area is dumpable first. If <unsafe> is non-null, the memory
4350 * locations are checked first for being readable.
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004351 */
Willy Tarreau37101052019-05-20 16:48:20 +02004352void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe)
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004353{
4354 const unsigned char *d = buf;
4355 int i, j, start;
4356
4357 d = (const unsigned char *)(((unsigned long)buf) & -16);
4358 start = ((unsigned long)buf) & 15;
4359
4360 for (i = 0; i < start + len; i += 16) {
4361 chunk_appendf(out, (sizeof(void *) == 4) ? "%s%8p: " : "%s%16p: ", pfx, d + i);
4362
Willy Tarreau37101052019-05-20 16:48:20 +02004363 // 0: unchecked, 1: checked safe, 2: danger
4364 unsafe = !!unsafe;
4365 if (unsafe && !may_access(d + i))
4366 unsafe = 2;
4367
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004368 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004369 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004370 chunk_strcat(out, "'' ");
Willy Tarreau37101052019-05-20 16:48:20 +02004371 else if (unsafe > 1)
4372 chunk_strcat(out, "** ");
4373 else
4374 chunk_appendf(out, "%02x ", d[i + j]);
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004375
4376 if (j == 7)
4377 chunk_strcat(out, "- ");
4378 }
4379 chunk_strcat(out, " ");
4380 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004381 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004382 chunk_strcat(out, "'");
Willy Tarreau37101052019-05-20 16:48:20 +02004383 else if (unsafe > 1)
4384 chunk_strcat(out, "*");
Willy Tarreau90807112020-02-25 08:16:33 +01004385 else if (isprint((unsigned char)d[i + j]))
Willy Tarreau37101052019-05-20 16:48:20 +02004386 chunk_appendf(out, "%c", d[i + j]);
4387 else
4388 chunk_strcat(out, ".");
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004389 }
4390 chunk_strcat(out, "\n");
4391 }
4392}
4393
Willy Tarreau762fb3e2020-03-03 15:57:10 +01004394/* dumps <pfx> followed by <n> bytes from <addr> in hex form into buffer <buf>
4395 * enclosed in brackets after the address itself, formatted on 14 chars
4396 * including the "0x" prefix. This is meant to be used as a prefix for code
4397 * areas. For example:
4398 * "0x7f10b6557690 [48 c7 c0 0f 00 00 00 0f]"
4399 * It relies on may_access() to know if the bytes are dumpable, otherwise "--"
4400 * is emitted. A NULL <pfx> will be considered empty.
4401 */
4402void dump_addr_and_bytes(struct buffer *buf, const char *pfx, const void *addr, int n)
4403{
4404 int ok = 0;
4405 int i;
4406
4407 chunk_appendf(buf, "%s%#14lx [", pfx ? pfx : "", (long)addr);
4408
4409 for (i = 0; i < n; i++) {
4410 if (i == 0 || (((long)(addr + i) ^ (long)(addr)) & 4096))
4411 ok = may_access(addr + i);
4412 if (ok)
4413 chunk_appendf(buf, "%02x%s", ((uint8_t*)addr)[i], (i<n-1) ? " " : "]");
4414 else
4415 chunk_appendf(buf, "--%s", (i<n-1) ? " " : "]");
4416 }
4417}
4418
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004419/* print a line of text buffer (limited to 70 bytes) to <out>. The format is :
4420 * <2 spaces> <offset=5 digits> <space or plus> <space> <70 chars max> <\n>
4421 * which is 60 chars per line. Non-printable chars \t, \n, \r and \e are
4422 * encoded in C format. Other non-printable chars are encoded "\xHH". Original
4423 * lines are respected within the limit of 70 output chars. Lines that are
4424 * continuation of a previous truncated line begin with "+" instead of " "
4425 * after the offset. The new pointer is returned.
4426 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004427int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004428 int *line, int ptr)
4429{
4430 int end;
4431 unsigned char c;
4432
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004433 end = out->data + 80;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004434 if (end > out->size)
4435 return ptr;
4436
4437 chunk_appendf(out, " %05d%c ", ptr, (ptr == *line) ? ' ' : '+');
4438
4439 while (ptr < len && ptr < bsize) {
4440 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004441 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004442 if (out->data > end - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004443 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004444 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004445 } else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004446 if (out->data > end - 3)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004447 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004448 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004449 switch (c) {
4450 case '\t': c = 't'; break;
4451 case '\n': c = 'n'; break;
4452 case '\r': c = 'r'; break;
4453 case '\e': c = 'e'; break;
4454 case '\\': c = '\\'; break;
4455 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004456 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004457 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004458 if (out->data > end - 5)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004459 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004460 out->area[out->data++] = '\\';
4461 out->area[out->data++] = 'x';
4462 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4463 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004464 }
4465 if (buf[ptr++] == '\n') {
4466 /* we had a line break, let's return now */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004467 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004468 *line = ptr;
4469 return ptr;
4470 }
4471 }
4472 /* we have an incomplete line, we return it as-is */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004473 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004474 return ptr;
4475}
4476
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004477/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02004478 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
4479 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004480 */
Willy Tarreaued936c52017-04-27 18:03:20 +02004481void debug_hexdump(FILE *out, const char *pfx, const char *buf,
4482 unsigned int baseaddr, int len)
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004483{
Willy Tarreau73459792017-04-11 07:58:08 +02004484 unsigned int i;
4485 int b, j;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004486
4487 for (i = 0; i < (len + (baseaddr & 15)); i += 16) {
4488 b = i - (baseaddr & 15);
Willy Tarreaued936c52017-04-27 18:03:20 +02004489 fprintf(out, "%s%08x: ", pfx ? pfx : "", i + (baseaddr & ~15));
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004490 for (j = 0; j < 8; j++) {
4491 if (b + j >= 0 && b + j < len)
4492 fprintf(out, "%02x ", (unsigned char)buf[b + j]);
4493 else
4494 fprintf(out, " ");
4495 }
4496
4497 if (b + j >= 0 && b + j < len)
4498 fputc('-', out);
4499 else
4500 fputc(' ', out);
4501
4502 for (j = 8; j < 16; j++) {
4503 if (b + j >= 0 && b + j < len)
4504 fprintf(out, " %02x", (unsigned char)buf[b + j]);
4505 else
4506 fprintf(out, " ");
4507 }
4508
4509 fprintf(out, " ");
4510 for (j = 0; j < 16; j++) {
4511 if (b + j >= 0 && b + j < len) {
4512 if (isprint((unsigned char)buf[b + j]))
4513 fputc((unsigned char)buf[b + j], out);
4514 else
4515 fputc('.', out);
4516 }
4517 else
4518 fputc(' ', out);
4519 }
4520 fputc('\n', out);
4521 }
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004522}
4523
Willy Tarreaubb869862020-04-16 10:52:41 +02004524/* Tries to report the executable path name on platforms supporting this. If
4525 * not found or not possible, returns NULL.
4526 */
4527const char *get_exec_path()
4528{
4529 const char *ret = NULL;
4530
4531#if (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
4532 long execfn = getauxval(AT_EXECFN);
4533
4534 if (execfn && execfn != ENOENT)
4535 ret = (const char *)execfn;
4536#endif
4537 return ret;
4538}
4539
Baruch Siache1651b22020-07-24 07:52:20 +03004540#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreau9133e482020-03-04 10:19:36 +01004541/* calls dladdr() or dladdr1() on <addr> and <dli>. If dladdr1 is available,
4542 * also returns the symbol size in <size>, otherwise returns 0 there.
4543 */
4544static int dladdr_and_size(const void *addr, Dl_info *dli, size_t *size)
4545{
4546 int ret;
Willy Tarreau62af9c82020-03-10 07:51:48 +01004547#if (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 3)) // most detailed one
Willy Tarreau9133e482020-03-04 10:19:36 +01004548 const ElfW(Sym) *sym;
4549
4550 ret = dladdr1(addr, dli, (void **)&sym, RTLD_DL_SYMENT);
4551 if (ret)
4552 *size = sym ? sym->st_size : 0;
4553#else
4554 ret = dladdr(addr, dli);
4555 *size = 0;
4556#endif
4557 return ret;
4558}
4559#endif
4560
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004561/* Tries to append to buffer <buf> some indications about the symbol at address
4562 * <addr> using the following form:
4563 * lib:+0xoffset (unresolvable address from lib's base)
4564 * main+0xoffset (unresolvable address from main (+/-))
4565 * lib:main+0xoffset (unresolvable lib address from main (+/-))
4566 * name (resolved exact exec address)
4567 * lib:name (resolved exact lib address)
4568 * name+0xoffset/0xsize (resolved address within exec symbol)
4569 * lib:name+0xoffset/0xsize (resolved address within lib symbol)
4570 *
4571 * The file name (lib or executable) is limited to what lies between the last
4572 * '/' and the first following '.'. An optional prefix <pfx> is prepended before
4573 * the output if not null. The file is not dumped when it's the same as the one
Baruch Siache1651b22020-07-24 07:52:20 +03004574 * that contains the "main" symbol, or when __ELF__ && USE_DL are not set.
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004575 *
4576 * The symbol's base address is returned, or NULL when unresolved, in order to
4577 * allow the caller to match it against known ones.
4578 */
Willy Tarreau0c439d82020-07-05 20:26:04 +02004579const void *resolve_sym_name(struct buffer *buf, const char *pfx, void *addr)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004580{
4581 const struct {
4582 const void *func;
4583 const char *name;
4584 } fcts[] = {
4585 { .func = process_stream, .name = "process_stream" },
4586 { .func = task_run_applet, .name = "task_run_applet" },
4587 { .func = si_cs_io_cb, .name = "si_cs_io_cb" },
4588 { .func = conn_fd_handler, .name = "conn_fd_handler" },
4589 { .func = dgram_fd_handler, .name = "dgram_fd_handler" },
4590 { .func = listener_accept, .name = "listener_accept" },
4591 { .func = poller_pipe_io_handler, .name = "poller_pipe_io_handler" },
4592 { .func = mworker_accept_wrapper, .name = "mworker_accept_wrapper" },
4593#ifdef USE_LUA
4594 { .func = hlua_process_task, .name = "hlua_process_task" },
4595#endif
Ilya Shipitsinbdec3ba2020-11-14 01:56:34 +05004596#ifdef SSL_MODE_ASYNC
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004597 { .func = ssl_async_fd_free, .name = "ssl_async_fd_free" },
4598 { .func = ssl_async_fd_handler, .name = "ssl_async_fd_handler" },
4599#endif
4600 };
4601
Baruch Siache1651b22020-07-24 07:52:20 +03004602#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004603 Dl_info dli, dli_main;
Willy Tarreau9133e482020-03-04 10:19:36 +01004604 size_t size;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004605 const char *fname, *p;
4606#endif
4607 int i;
4608
4609 if (pfx)
4610 chunk_appendf(buf, "%s", pfx);
4611
4612 for (i = 0; i < sizeof(fcts) / sizeof(fcts[0]); i++) {
4613 if (addr == fcts[i].func) {
4614 chunk_appendf(buf, "%s", fcts[i].name);
4615 return addr;
4616 }
4617 }
4618
Baruch Siache1651b22020-07-24 07:52:20 +03004619#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004620 /* Now let's try to be smarter */
Willy Tarreau9133e482020-03-04 10:19:36 +01004621 if (!dladdr_and_size(addr, &dli, &size))
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004622 goto unknown;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004623
4624 /* 1. prefix the library name if it's not the same object as the one
4625 * that contains the main function. The name is picked between last '/'
4626 * and first following '.'.
4627 */
4628 if (!dladdr(main, &dli_main))
4629 dli_main.dli_fbase = NULL;
4630
4631 if (dli_main.dli_fbase != dli.dli_fbase) {
4632 fname = dli.dli_fname;
4633 p = strrchr(fname, '/');
4634 if (p++)
4635 fname = p;
4636 p = strchr(fname, '.');
4637 if (!p)
4638 p = fname + strlen(fname);
4639
4640 chunk_appendf(buf, "%.*s:", (int)(long)(p - fname), fname);
4641 }
4642
4643 /* 2. symbol name */
4644 if (dli.dli_sname) {
4645 /* known, dump it and return symbol's address (exact or relative) */
4646 chunk_appendf(buf, "%s", dli.dli_sname);
4647 if (addr != dli.dli_saddr) {
4648 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_saddr));
Willy Tarreau9133e482020-03-04 10:19:36 +01004649 if (size)
4650 chunk_appendf(buf, "/%#lx", (long)size);
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004651 }
4652 return dli.dli_saddr;
4653 }
4654 else if (dli_main.dli_fbase != dli.dli_fbase) {
4655 /* unresolved symbol from a known library, report relative offset */
4656 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_fbase));
4657 return NULL;
4658 }
Baruch Siache1651b22020-07-24 07:52:20 +03004659#endif /* __ELF__ && !__linux__ || USE_DL */
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004660 unknown:
4661 /* unresolved symbol from the main file, report relative offset to main */
4662 if ((void*)addr < (void*)main)
4663 chunk_appendf(buf, "main-%#lx", (long)((void*)main - addr));
4664 else
4665 chunk_appendf(buf, "main+%#lx", (long)(addr - (void*)main));
4666 return NULL;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004667}
4668
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004669/*
4670 * Allocate an array of unsigned int with <nums> as address from <str> string
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05004671 * made of integer separated by dot characters.
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004672 *
4673 * First, initializes the value with <sz> as address to 0 and initializes the
4674 * array with <nums> as address to NULL. Then allocates the array with <nums> as
4675 * address updating <sz> pointed value to the size of this array.
4676 *
4677 * Returns 1 if succeeded, 0 if not.
4678 */
4679int parse_dotted_uints(const char *str, unsigned int **nums, size_t *sz)
4680{
4681 unsigned int *n;
4682 const char *s, *end;
4683
4684 s = str;
4685 *sz = 0;
4686 end = str + strlen(str);
4687 *nums = n = NULL;
4688
4689 while (1) {
4690 unsigned int r;
4691
4692 if (s >= end)
4693 break;
4694
4695 r = read_uint(&s, end);
4696 /* Expected characters after having read an uint: '\0' or '.',
4697 * if '.', must not be terminal.
4698 */
4699 if (*s != '\0'&& (*s++ != '.' || s == end))
4700 return 0;
4701
Frédéric Lécaille12a71842019-02-26 18:19:48 +01004702 n = my_realloc2(n, (*sz + 1) * sizeof *n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004703 if (!n)
4704 return 0;
4705
4706 n[(*sz)++] = r;
4707 }
4708 *nums = n;
4709
4710 return 1;
4711}
4712
Willy Tarreau4d589e72019-08-23 19:02:26 +02004713
4714/* returns the number of bytes needed to encode <v> as a varint. An inline
4715 * version exists for use with constants (__varint_bytes()).
4716 */
4717int varint_bytes(uint64_t v)
4718{
4719 int len = 1;
4720
4721 if (v >= 240) {
4722 v = (v - 240) >> 4;
4723 while (1) {
4724 len++;
4725 if (v < 128)
4726 break;
4727 v = (v - 128) >> 7;
4728 }
4729 }
4730 return len;
4731}
4732
Willy Tarreau52bf8392020-03-08 00:42:37 +01004733
4734/* Random number generator state, see below */
Willy Tarreau1544c142020-03-12 00:31:18 +01004735static uint64_t ha_random_state[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01004736
4737/* This is a thread-safe implementation of xoroshiro128** described below:
4738 * http://prng.di.unimi.it/
4739 * It features a 2^128 long sequence, returns 64 high-quality bits on each call,
4740 * supports fast jumps and passes all common quality tests. It is thread-safe,
4741 * uses a double-cas on 64-bit architectures supporting it, and falls back to a
4742 * local lock on other ones.
4743 */
4744uint64_t ha_random64()
4745{
4746 uint64_t result;
Willy Tarreau1544c142020-03-12 00:31:18 +01004747 uint64_t old[2] ALIGNED(2*sizeof(uint64_t));
4748 uint64_t new[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01004749
4750#if defined(USE_THREAD) && (!defined(HA_CAS_IS_8B) || !defined(HA_HAVE_CAS_DW))
4751 static HA_SPINLOCK_T rand_lock;
4752
4753 HA_SPIN_LOCK(OTHER_LOCK, &rand_lock);
4754#endif
4755
4756 old[0] = ha_random_state[0];
4757 old[1] = ha_random_state[1];
4758
4759#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
4760 do {
4761#endif
4762 result = rotl64(old[0] * 5, 7) * 9;
4763 new[1] = old[0] ^ old[1];
4764 new[0] = rotl64(old[0], 24) ^ new[1] ^ (new[1] << 16); // a, b
4765 new[1] = rotl64(new[1], 37); // c
4766
4767#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
4768 } while (unlikely(!_HA_ATOMIC_DWCAS(ha_random_state, old, new)));
4769#else
4770 ha_random_state[0] = new[0];
4771 ha_random_state[1] = new[1];
4772#if defined(USE_THREAD)
4773 HA_SPIN_UNLOCK(OTHER_LOCK, &rand_lock);
4774#endif
4775#endif
4776 return result;
4777}
4778
4779/* seeds the random state using up to <len> bytes from <seed>, starting with
4780 * the first non-zero byte.
4781 */
4782void ha_random_seed(const unsigned char *seed, size_t len)
4783{
4784 size_t pos;
4785
4786 /* the seed must not be all zeroes, so we pre-fill it with alternating
4787 * bits and overwrite part of them with the block starting at the first
4788 * non-zero byte from the seed.
4789 */
4790 memset(ha_random_state, 0x55, sizeof(ha_random_state));
4791
4792 for (pos = 0; pos < len; pos++)
4793 if (seed[pos] != 0)
4794 break;
4795
4796 if (pos == len)
4797 return;
4798
4799 seed += pos;
4800 len -= pos;
4801
4802 if (len > sizeof(ha_random_state))
4803 len = sizeof(ha_random_state);
4804
4805 memcpy(ha_random_state, seed, len);
4806}
4807
4808/* This causes a jump to (dist * 2^96) places in the pseudo-random sequence,
4809 * and is equivalent to calling ha_random64() as many times. It is used to
4810 * provide non-overlapping sequences of 2^96 numbers (~7*10^28) to up to 2^32
4811 * different generators (i.e. different processes after a fork). The <dist>
4812 * argument is the distance to jump to and is used in a loop so it rather not
4813 * be too large if the processing time is a concern.
4814 *
4815 * BEWARE: this function is NOT thread-safe and must not be called during
4816 * concurrent accesses to ha_random64().
4817 */
4818void ha_random_jump96(uint32_t dist)
4819{
4820 while (dist--) {
4821 uint64_t s0 = 0;
4822 uint64_t s1 = 0;
4823 int b;
4824
4825 for (b = 0; b < 64; b++) {
4826 if ((0xd2a98b26625eee7bULL >> b) & 1) {
4827 s0 ^= ha_random_state[0];
4828 s1 ^= ha_random_state[1];
4829 }
4830 ha_random64();
4831 }
4832
4833 for (b = 0; b < 64; b++) {
4834 if ((0xdddf9b1090aa7ac1ULL >> b) & 1) {
4835 s0 ^= ha_random_state[0];
4836 s1 ^= ha_random_state[1];
4837 }
4838 ha_random64();
4839 }
4840 ha_random_state[0] = s0;
4841 ha_random_state[1] = s1;
4842 }
4843}
4844
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01004845/* Generates an RFC4122 UUID into chunk <output> which must be at least 37
4846 * bytes large.
4847 */
4848void ha_generate_uuid(struct buffer *output)
4849{
4850 uint32_t rnd[4];
4851 uint64_t last;
4852
4853 last = ha_random64();
4854 rnd[0] = last;
4855 rnd[1] = last >> 32;
4856
4857 last = ha_random64();
4858 rnd[2] = last;
4859 rnd[3] = last >> 32;
4860
4861 chunk_printf(output, "%8.8x-%4.4x-%4.4x-%4.4x-%12.12llx",
4862 rnd[0],
4863 rnd[1] & 0xFFFF,
4864 ((rnd[1] >> 16u) & 0xFFF) | 0x4000, // highest 4 bits indicate the uuid version
4865 (rnd[2] & 0x3FFF) | 0x8000, // the highest 2 bits indicate the UUID variant (10),
4866 (long long)((rnd[2] >> 14u) | ((uint64_t) rnd[3] << 18u)) & 0xFFFFFFFFFFFFull);
4867}
4868
4869
Willy Tarreauc8d167b2020-06-16 16:27:26 +02004870/* only used by parse_line() below. It supports writing in place provided that
4871 * <in> is updated to the next location before calling it. In that case, the
4872 * char at <in> may be overwritten.
4873 */
4874#define EMIT_CHAR(x) \
4875 do { \
4876 char __c = (char)(x); \
4877 if ((opts & PARSE_OPT_INPLACE) && out+outpos > in) \
4878 err |= PARSE_ERR_OVERLAP; \
4879 if (outpos >= outmax) \
4880 err |= PARSE_ERR_TOOLARGE; \
4881 if (!err) \
4882 out[outpos] = __c; \
4883 outpos++; \
4884 } while (0)
4885
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05004886/* Parse <in>, copy it into <out> split into isolated words whose pointers
Willy Tarreauc8d167b2020-06-16 16:27:26 +02004887 * are put in <args>. If more than <outlen> bytes have to be emitted, the
4888 * extraneous ones are not emitted but <outlen> is updated so that the caller
4889 * knows how much to realloc. Similarly, <args> are not updated beyond <nbargs>
4890 * but the returned <nbargs> indicates how many were found. All trailing args
Willy Tarreau61dd44b2020-06-25 07:35:42 +02004891 * up to <nbargs> point to the trailing zero, and as long as <nbargs> is > 0,
4892 * it is guaranteed that at least one arg will point to the zero. It is safe
4893 * to call it with a NULL <args> if <nbargs> is 0.
Willy Tarreauc8d167b2020-06-16 16:27:26 +02004894 *
4895 * <out> may overlap with <in> provided that it never goes further, in which
4896 * case the parser will accept to perform in-place parsing and unquoting/
4897 * unescaping but only if environment variables do not lead to expansion that
4898 * causes overlapping, otherwise the input string being destroyed, the error
4899 * will not be recoverable. Note that even during out-of-place <in> will
4900 * experience temporary modifications in-place for variable resolution and must
4901 * be writable, and will also receive zeroes to delimit words when using
4902 * in-place copy. Parsing options <opts> taken from PARSE_OPT_*. Return value
4903 * is zero on success otherwise a bitwise-or of PARSE_ERR_*. Upon error, the
4904 * starting point of the first invalid character sequence or unmatched
4905 * quote/brace is reported in <errptr> if not NULL. When using in-place parsing
4906 * error reporting might be difficult since zeroes will have been inserted into
4907 * the string. One solution for the caller may consist in replacing all args
4908 * delimiters with spaces in this case.
4909 */
4910uint32_t parse_line(char *in, char *out, size_t *outlen, char **args, int *nbargs, uint32_t opts, char **errptr)
4911{
4912 char *quote = NULL;
4913 char *brace = NULL;
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02004914 char *word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02004915 unsigned char hex1, hex2;
4916 size_t outmax = *outlen;
Willy Tarreau61dd44b2020-06-25 07:35:42 +02004917 int argsmax = *nbargs - 1;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02004918 size_t outpos = 0;
4919 int squote = 0;
4920 int dquote = 0;
4921 int arg = 0;
4922 uint32_t err = 0;
4923
4924 *nbargs = 0;
4925 *outlen = 0;
4926
Willy Tarreau61dd44b2020-06-25 07:35:42 +02004927 /* argsmax may be -1 here, protecting args[] from any write */
4928 if (arg < argsmax)
4929 args[arg] = out;
4930
Willy Tarreauc8d167b2020-06-16 16:27:26 +02004931 while (1) {
4932 if (*in >= '-' && *in != '\\') {
4933 /* speedup: directly send all regular chars starting
4934 * with '-', '.', '/', alnum etc...
4935 */
4936 EMIT_CHAR(*in++);
4937 continue;
4938 }
4939 else if (*in == '\0' || *in == '\n' || *in == '\r') {
4940 /* end of line */
4941 break;
4942 }
4943 else if (*in == '#' && (opts & PARSE_OPT_SHARP) && !squote && !dquote) {
4944 /* comment */
4945 break;
4946 }
4947 else if (*in == '"' && !squote && (opts & PARSE_OPT_DQUOTE)) { /* double quote outside single quotes */
4948 if (dquote) {
4949 dquote = 0;
4950 quote = NULL;
4951 }
4952 else {
4953 dquote = 1;
4954 quote = in;
4955 }
4956 in++;
4957 continue;
4958 }
4959 else if (*in == '\'' && !dquote && (opts & PARSE_OPT_SQUOTE)) { /* single quote outside double quotes */
4960 if (squote) {
4961 squote = 0;
4962 quote = NULL;
4963 }
4964 else {
4965 squote = 1;
4966 quote = in;
4967 }
4968 in++;
4969 continue;
4970 }
4971 else if (*in == '\\' && !squote && (opts & PARSE_OPT_BKSLASH)) {
4972 /* first, we'll replace \\, \<space>, \#, \r, \n, \t, \xXX with their
4973 * C equivalent value but only when they have a special meaning and within
4974 * double quotes for some of them. Other combinations left unchanged (eg: \1).
4975 */
4976 char tosend = *in;
4977
4978 switch (in[1]) {
4979 case ' ':
4980 case '\\':
4981 tosend = in[1];
4982 in++;
4983 break;
4984
4985 case 't':
4986 tosend = '\t';
4987 in++;
4988 break;
4989
4990 case 'n':
4991 tosend = '\n';
4992 in++;
4993 break;
4994
4995 case 'r':
4996 tosend = '\r';
4997 in++;
4998 break;
4999
5000 case '#':
5001 /* escaping of "#" only if comments are supported */
5002 if (opts & PARSE_OPT_SHARP)
5003 in++;
5004 tosend = *in;
5005 break;
5006
5007 case '\'':
5008 /* escaping of "'" only outside single quotes and only if single quotes are supported */
5009 if (opts & PARSE_OPT_SQUOTE && !squote)
5010 in++;
5011 tosend = *in;
5012 break;
5013
5014 case '"':
5015 /* escaping of '"' only outside single quotes and only if double quotes are supported */
5016 if (opts & PARSE_OPT_DQUOTE && !squote)
5017 in++;
5018 tosend = *in;
5019 break;
5020
5021 case '$':
5022 /* escaping of '$' only inside double quotes and only if env supported */
5023 if (opts & PARSE_OPT_ENV && dquote)
5024 in++;
5025 tosend = *in;
5026 break;
5027
5028 case 'x':
5029 if (!ishex(in[2]) || !ishex(in[3])) {
5030 /* invalid or incomplete hex sequence */
5031 err |= PARSE_ERR_HEX;
5032 if (errptr)
5033 *errptr = in;
5034 goto leave;
5035 }
Willy Tarreauf278eec2020-07-05 21:46:32 +02005036 hex1 = toupper((unsigned char)in[2]) - '0';
5037 hex2 = toupper((unsigned char)in[3]) - '0';
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005038 if (hex1 > 9) hex1 -= 'A' - '9' - 1;
5039 if (hex2 > 9) hex2 -= 'A' - '9' - 1;
5040 tosend = (hex1 << 4) + hex2;
5041 in += 3;
5042 break;
5043
5044 default:
5045 /* other combinations are not escape sequences */
5046 break;
5047 }
5048
5049 in++;
5050 EMIT_CHAR(tosend);
5051 }
5052 else if (isspace((unsigned char)*in) && !squote && !dquote) {
5053 /* a non-escaped space is an argument separator */
5054 while (isspace((unsigned char)*in))
5055 in++;
5056 EMIT_CHAR(0);
5057 arg++;
5058 if (arg < argsmax)
5059 args[arg] = out + outpos;
5060 else
5061 err |= PARSE_ERR_TOOMANY;
5062 }
5063 else if (*in == '$' && (opts & PARSE_OPT_ENV) && (dquote || !(opts & PARSE_OPT_DQUOTE))) {
5064 /* environment variables are evaluated anywhere, or only
5065 * inside double quotes if they are supported.
5066 */
5067 char *var_name;
5068 char save_char;
5069 char *value;
5070
5071 in++;
5072
5073 if (*in == '{')
5074 brace = in++;
5075
5076 if (!isalpha((unsigned char)*in) && *in != '_') {
5077 /* unacceptable character in variable name */
5078 err |= PARSE_ERR_VARNAME;
5079 if (errptr)
5080 *errptr = in;
5081 goto leave;
5082 }
5083
5084 var_name = in;
5085 while (isalnum((unsigned char)*in) || *in == '_')
5086 in++;
5087
5088 save_char = *in;
5089 *in = '\0';
5090 value = getenv(var_name);
5091 *in = save_char;
5092
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005093 /* support for '[*]' sequence to force word expansion,
5094 * only available inside braces */
5095 if (*in == '[' && brace && (opts & PARSE_OPT_WORD_EXPAND)) {
5096 word_expand = in++;
5097
5098 if (*in++ != '*' || *in++ != ']') {
5099 err |= PARSE_ERR_WRONG_EXPAND;
5100 if (errptr)
5101 *errptr = word_expand;
5102 goto leave;
5103 }
5104 }
5105
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005106 if (brace) {
5107 if (*in != '}') {
5108 /* unmatched brace */
5109 err |= PARSE_ERR_BRACE;
5110 if (errptr)
5111 *errptr = brace;
5112 goto leave;
5113 }
5114 in++;
5115 brace = NULL;
5116 }
5117
5118 if (value) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005119 while (*value) {
5120 /* expand as individual parameters on a space character */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005121 if (word_expand && isspace((unsigned char)*value)) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005122 EMIT_CHAR(0);
5123 ++arg;
5124 if (arg < argsmax)
5125 args[arg] = out + outpos;
5126 else
5127 err |= PARSE_ERR_TOOMANY;
5128
5129 /* skip consecutive spaces */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005130 while (isspace((unsigned char)*++value))
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005131 ;
5132 } else {
5133 EMIT_CHAR(*value++);
5134 }
5135 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005136 }
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005137 word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005138 }
5139 else {
5140 /* any other regular char */
5141 EMIT_CHAR(*in++);
5142 }
5143 }
5144
5145 /* end of output string */
5146 EMIT_CHAR(0);
5147 arg++;
5148
5149 if (quote) {
5150 /* unmatched quote */
5151 err |= PARSE_ERR_QUOTE;
5152 if (errptr)
5153 *errptr = quote;
5154 goto leave;
5155 }
5156 leave:
5157 *nbargs = arg;
5158 *outlen = outpos;
5159
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005160 /* empty all trailing args by making them point to the trailing zero,
5161 * at least the last one in any case.
5162 */
5163 if (arg > argsmax)
5164 arg = argsmax;
5165
5166 while (arg >= 0 && arg <= argsmax)
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005167 args[arg++] = out + outpos - 1;
5168
5169 return err;
5170}
5171#undef EMIT_CHAR
5172
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005173/* This is used to sanitize an input line that's about to be used for error reporting.
5174 * It will adjust <line> to print approximately <width> chars around <pos>, trying to
5175 * preserve the beginning, with leading or trailing "..." when the line is truncated.
5176 * If non-printable chars are present in the output. It returns the new offset <pos>
5177 * in the modified line. Non-printable characters are replaced with '?'. <width> must
5178 * be at least 6 to support two "..." otherwise the result is undefined. The line
5179 * itself must have at least 7 chars allocated for the same reason.
5180 */
5181size_t sanitize_for_printing(char *line, size_t pos, size_t width)
5182{
5183 size_t shift = 0;
5184 char *out = line;
5185 char *in = line;
5186 char *end = line + width;
5187
5188 if (pos >= width) {
5189 /* if we have to shift, we'll be out of context, so let's
5190 * try to put <pos> at the center of width.
5191 */
5192 shift = pos - width / 2;
5193 in += shift + 3;
5194 end = out + width - 3;
5195 out[0] = out[1] = out[2] = '.';
5196 out += 3;
5197 }
5198
5199 while (out < end && *in) {
5200 if (isspace((unsigned char)*in))
5201 *out++ = ' ';
5202 else if (isprint((unsigned char)*in))
5203 *out++ = *in;
5204 else
5205 *out++ = '?';
5206 in++;
5207 }
5208
5209 if (end < line + width) {
5210 out[0] = out[1] = out[2] = '.';
5211 out += 3;
5212 }
5213
5214 *out++ = 0;
5215 return pos - shift;
5216}
5217
Willy Tarreaubaaee002006-06-26 02:48:02 +02005218/*
5219 * Local variables:
5220 * c-indent-level: 8
5221 * c-basic-offset: 8
5222 * End:
5223 */