blob: 3f3460d3eaeb1f7aad7f0d4288d9b3ec9462f19c [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 Tarreauf268ee82020-06-04 17:05:57 +020045#include <haproxy/global.h>
Willy Tarreau86416052020-06-04 09:20:54 +020046#include <haproxy/hlua.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020047#include <haproxy/listener.h>
Willy Tarreau7a00efb2020-06-02 17:02:59 +020048#include <haproxy/namespace.h>
Christopher Faulet9553de72021-02-26 09:12:50 +010049#include <haproxy/net_helper.h>
Willy Tarreau5fc93282020-09-16 18:25:03 +020050#include <haproxy/protocol.h>
Emeric Brunc9437992021-02-12 19:42:55 +010051#include <haproxy/resolvers.h>
Willy Tarreau586f71b2020-12-11 15:54:36 +010052#include <haproxy/sock.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020053#include <haproxy/ssl_sock.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020054#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020055#include <haproxy/task.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020056#include <haproxy/tools.h>
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +010057
Thierry Fournier93127942016-01-20 18:49:45 +010058/* This macro returns false if the test __x is false. Many
59 * of the following parsing function must be abort the processing
60 * if it returns 0, so this macro is useful for writing light code.
61 */
62#define RET0_UNLESS(__x) do { if (!(__x)) return 0; } while (0)
63
Willy Tarreau56adcf22012-12-23 18:00:29 +010064/* enough to store NB_ITOA_STR integers of :
Willy Tarreau72d759c2007-10-25 12:14:10 +020065 * 2^64-1 = 18446744073709551615 or
66 * -2^63 = -9223372036854775808
Willy Tarreaue7239b52009-03-29 13:41:58 +020067 *
68 * The HTML version needs room for adding the 25 characters
69 * '<span class="rls"></span>' around digits at positions 3N+1 in order
70 * to add spacing at up to 6 positions : 18 446 744 073 709 551 615
Willy Tarreau72d759c2007-10-25 12:14:10 +020071 */
Christopher Faulet99bca652017-11-14 16:47:26 +010072THREAD_LOCAL char itoa_str[NB_ITOA_STR][171];
73THREAD_LOCAL int itoa_idx = 0; /* index of next itoa_str to use */
Willy Tarreaubaaee002006-06-26 02:48:02 +020074
Willy Tarreau588297f2014-06-16 15:16:40 +020075/* sometimes we'll need to quote strings (eg: in stats), and we don't expect
76 * to quote strings larger than a max configuration line.
77 */
Christopher Faulet99bca652017-11-14 16:47:26 +010078THREAD_LOCAL char quoted_str[NB_QSTR][QSTR_SIZE + 1];
79THREAD_LOCAL int quoted_idx = 0;
Willy Tarreau588297f2014-06-16 15:16:40 +020080
Willy Tarreau06e69b52021-03-02 14:01:35 +010081/* thread-local PRNG state. It's modified to start from a different sequence
82 * on all threads upon startup. It must not be used or anything beyond getting
83 * statistical values as it's 100% predictable.
84 */
85THREAD_LOCAL unsigned int statistical_prng_state = 2463534242U;
86
Willy Tarreaubaaee002006-06-26 02:48:02 +020087/*
William Lallemande7340ec2012-01-24 11:15:39 +010088 * unsigned long long ASCII representation
89 *
90 * return the last char '\0' or NULL if no enough
91 * space in dst
92 */
93char *ulltoa(unsigned long long n, char *dst, size_t size)
94{
95 int i = 0;
96 char *res;
97
98 switch(n) {
99 case 1ULL ... 9ULL:
100 i = 0;
101 break;
102
103 case 10ULL ... 99ULL:
104 i = 1;
105 break;
106
107 case 100ULL ... 999ULL:
108 i = 2;
109 break;
110
111 case 1000ULL ... 9999ULL:
112 i = 3;
113 break;
114
115 case 10000ULL ... 99999ULL:
116 i = 4;
117 break;
118
119 case 100000ULL ... 999999ULL:
120 i = 5;
121 break;
122
123 case 1000000ULL ... 9999999ULL:
124 i = 6;
125 break;
126
127 case 10000000ULL ... 99999999ULL:
128 i = 7;
129 break;
130
131 case 100000000ULL ... 999999999ULL:
132 i = 8;
133 break;
134
135 case 1000000000ULL ... 9999999999ULL:
136 i = 9;
137 break;
138
139 case 10000000000ULL ... 99999999999ULL:
140 i = 10;
141 break;
142
143 case 100000000000ULL ... 999999999999ULL:
144 i = 11;
145 break;
146
147 case 1000000000000ULL ... 9999999999999ULL:
148 i = 12;
149 break;
150
151 case 10000000000000ULL ... 99999999999999ULL:
152 i = 13;
153 break;
154
155 case 100000000000000ULL ... 999999999999999ULL:
156 i = 14;
157 break;
158
159 case 1000000000000000ULL ... 9999999999999999ULL:
160 i = 15;
161 break;
162
163 case 10000000000000000ULL ... 99999999999999999ULL:
164 i = 16;
165 break;
166
167 case 100000000000000000ULL ... 999999999999999999ULL:
168 i = 17;
169 break;
170
171 case 1000000000000000000ULL ... 9999999999999999999ULL:
172 i = 18;
173 break;
174
175 case 10000000000000000000ULL ... ULLONG_MAX:
176 i = 19;
177 break;
178 }
179 if (i + 2 > size) // (i + 1) + '\0'
180 return NULL; // too long
181 res = dst + i + 1;
182 *res = '\0';
183 for (; i >= 0; i--) {
184 dst[i] = n % 10ULL + '0';
185 n /= 10ULL;
186 }
187 return res;
188}
189
190/*
191 * unsigned long ASCII representation
192 *
193 * return the last char '\0' or NULL if no enough
194 * space in dst
195 */
196char *ultoa_o(unsigned long n, char *dst, size_t size)
197{
198 int i = 0;
199 char *res;
200
201 switch (n) {
202 case 0U ... 9UL:
203 i = 0;
204 break;
205
206 case 10U ... 99UL:
207 i = 1;
208 break;
209
210 case 100U ... 999UL:
211 i = 2;
212 break;
213
214 case 1000U ... 9999UL:
215 i = 3;
216 break;
217
218 case 10000U ... 99999UL:
219 i = 4;
220 break;
221
222 case 100000U ... 999999UL:
223 i = 5;
224 break;
225
226 case 1000000U ... 9999999UL:
227 i = 6;
228 break;
229
230 case 10000000U ... 99999999UL:
231 i = 7;
232 break;
233
234 case 100000000U ... 999999999UL:
235 i = 8;
236 break;
237#if __WORDSIZE == 32
238
239 case 1000000000ULL ... ULONG_MAX:
240 i = 9;
241 break;
242
243#elif __WORDSIZE == 64
244
245 case 1000000000ULL ... 9999999999UL:
246 i = 9;
247 break;
248
249 case 10000000000ULL ... 99999999999UL:
250 i = 10;
251 break;
252
253 case 100000000000ULL ... 999999999999UL:
254 i = 11;
255 break;
256
257 case 1000000000000ULL ... 9999999999999UL:
258 i = 12;
259 break;
260
261 case 10000000000000ULL ... 99999999999999UL:
262 i = 13;
263 break;
264
265 case 100000000000000ULL ... 999999999999999UL:
266 i = 14;
267 break;
268
269 case 1000000000000000ULL ... 9999999999999999UL:
270 i = 15;
271 break;
272
273 case 10000000000000000ULL ... 99999999999999999UL:
274 i = 16;
275 break;
276
277 case 100000000000000000ULL ... 999999999999999999UL:
278 i = 17;
279 break;
280
281 case 1000000000000000000ULL ... 9999999999999999999UL:
282 i = 18;
283 break;
284
285 case 10000000000000000000ULL ... ULONG_MAX:
286 i = 19;
287 break;
288
289#endif
290 }
291 if (i + 2 > size) // (i + 1) + '\0'
292 return NULL; // too long
293 res = dst + i + 1;
294 *res = '\0';
295 for (; i >= 0; i--) {
296 dst[i] = n % 10U + '0';
297 n /= 10U;
298 }
299 return res;
300}
301
302/*
303 * signed long ASCII representation
304 *
305 * return the last char '\0' or NULL if no enough
306 * space in dst
307 */
308char *ltoa_o(long int n, char *dst, size_t size)
309{
310 char *pos = dst;
311
312 if (n < 0) {
313 if (size < 3)
314 return NULL; // min size is '-' + digit + '\0' but another test in ultoa
315 *pos = '-';
316 pos++;
317 dst = ultoa_o(-n, pos, size - 1);
318 } else {
319 dst = ultoa_o(n, dst, size);
320 }
321 return dst;
322}
323
324/*
325 * signed long long ASCII representation
326 *
327 * return the last char '\0' or NULL if no enough
328 * space in dst
329 */
330char *lltoa(long long n, char *dst, size_t size)
331{
332 char *pos = dst;
333
334 if (n < 0) {
335 if (size < 3)
336 return NULL; // min size is '-' + digit + '\0' but another test in ulltoa
337 *pos = '-';
338 pos++;
339 dst = ulltoa(-n, pos, size - 1);
340 } else {
341 dst = ulltoa(n, dst, size);
342 }
343 return dst;
344}
345
346/*
347 * write a ascii representation of a unsigned into dst,
348 * return a pointer to the last character
349 * Pad the ascii representation with '0', using size.
350 */
351char *utoa_pad(unsigned int n, char *dst, size_t size)
352{
353 int i = 0;
354 char *ret;
355
356 switch(n) {
357 case 0U ... 9U:
358 i = 0;
359 break;
360
361 case 10U ... 99U:
362 i = 1;
363 break;
364
365 case 100U ... 999U:
366 i = 2;
367 break;
368
369 case 1000U ... 9999U:
370 i = 3;
371 break;
372
373 case 10000U ... 99999U:
374 i = 4;
375 break;
376
377 case 100000U ... 999999U:
378 i = 5;
379 break;
380
381 case 1000000U ... 9999999U:
382 i = 6;
383 break;
384
385 case 10000000U ... 99999999U:
386 i = 7;
387 break;
388
389 case 100000000U ... 999999999U:
390 i = 8;
391 break;
392
393 case 1000000000U ... 4294967295U:
394 i = 9;
395 break;
396 }
397 if (i + 2 > size) // (i + 1) + '\0'
398 return NULL; // too long
399 if (i < size)
400 i = size - 2; // padding - '\0'
401
402 ret = dst + i + 1;
403 *ret = '\0';
404 for (; i >= 0; i--) {
405 dst[i] = n % 10U + '0';
406 n /= 10U;
407 }
408 return ret;
409}
410
411/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200412 * copies at most <size-1> chars from <src> to <dst>. Last char is always
413 * set to 0, unless <size> is 0. The number of chars copied is returned
414 * (excluding the terminating zero).
415 * This code has been optimized for size and speed : on x86, it's 45 bytes
416 * long, uses only registers, and consumes only 4 cycles per char.
417 */
418int strlcpy2(char *dst, const char *src, int size)
419{
420 char *orig = dst;
421 if (size) {
422 while (--size && (*dst = *src)) {
423 src++; dst++;
424 }
425 *dst = 0;
426 }
427 return dst - orig;
428}
429
430/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200431 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200432 * the ascii representation for number 'n' in decimal.
433 */
Emeric Brun3a7fce52010-01-04 14:54:38 +0100434char *ultoa_r(unsigned long n, char *buffer, int size)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200435{
436 char *pos;
437
Willy Tarreau72d759c2007-10-25 12:14:10 +0200438 pos = buffer + size - 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200439 *pos-- = '\0';
440
441 do {
442 *pos-- = '0' + n % 10;
443 n /= 10;
Willy Tarreau72d759c2007-10-25 12:14:10 +0200444 } while (n && pos >= buffer);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200445 return pos + 1;
446}
447
Willy Tarreau91092e52007-10-25 16:58:42 +0200448/*
Willy Tarreaue7239b52009-03-29 13:41:58 +0200449 * This function simply returns a locally allocated string containing
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200450 * the ascii representation for number 'n' in decimal.
451 */
452char *lltoa_r(long long int in, char *buffer, int size)
453{
454 char *pos;
455 int neg = 0;
456 unsigned long long int n;
457
458 pos = buffer + size - 1;
459 *pos-- = '\0';
460
461 if (in < 0) {
462 neg = 1;
463 n = -in;
464 }
465 else
466 n = in;
467
468 do {
469 *pos-- = '0' + n % 10;
470 n /= 10;
471 } while (n && pos >= buffer);
472 if (neg && pos > buffer)
473 *pos-- = '-';
474 return pos + 1;
475}
476
477/*
478 * This function simply returns a locally allocated string containing
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200479 * the ascii representation for signed number 'n' in decimal.
480 */
481char *sltoa_r(long n, char *buffer, int size)
482{
483 char *pos;
484
485 if (n >= 0)
486 return ultoa_r(n, buffer, size);
487
488 pos = ultoa_r(-n, buffer + 1, size - 1) - 1;
489 *pos = '-';
490 return pos;
491}
492
493/*
494 * This function simply returns a locally allocated string containing
Willy Tarreaue7239b52009-03-29 13:41:58 +0200495 * the ascii representation for number 'n' in decimal, formatted for
496 * HTML output with tags to create visual grouping by 3 digits. The
497 * output needs to support at least 171 characters.
498 */
499const char *ulltoh_r(unsigned long long n, char *buffer, int size)
500{
501 char *start;
502 int digit = 0;
503
504 start = buffer + size;
505 *--start = '\0';
506
507 do {
508 if (digit == 3 && start >= buffer + 7)
509 memcpy(start -= 7, "</span>", 7);
510
511 if (start >= buffer + 1) {
512 *--start = '0' + n % 10;
513 n /= 10;
514 }
515
516 if (digit == 3 && start >= buffer + 18)
517 memcpy(start -= 18, "<span class=\"rls\">", 18);
518
519 if (digit++ == 3)
520 digit = 1;
521 } while (n && start > buffer);
522 return start;
523}
524
525/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200526 * This function simply returns a locally allocated string containing the ascii
527 * representation for number 'n' in decimal, unless n is 0 in which case it
528 * returns the alternate string (or an empty string if the alternate string is
529 * NULL). It use is intended for limits reported in reports, where it's
530 * desirable not to display anything if there is no limit. Warning! it shares
531 * the same vector as ultoa_r().
532 */
533const char *limit_r(unsigned long n, char *buffer, int size, const char *alt)
534{
535 return (n) ? ultoa_r(n, buffer, size) : (alt ? alt : "");
536}
537
Willy Tarreau588297f2014-06-16 15:16:40 +0200538/* returns a locally allocated string containing the quoted encoding of the
539 * input string. The output may be truncated to QSTR_SIZE chars, but it is
540 * guaranteed that the string will always be properly terminated. Quotes are
541 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
542 * always be at least 4 chars.
543 */
544const char *qstr(const char *str)
545{
546 char *ret = quoted_str[quoted_idx];
547 char *p, *end;
548
549 if (++quoted_idx >= NB_QSTR)
550 quoted_idx = 0;
551
552 p = ret;
553 end = ret + QSTR_SIZE;
554
555 *p++ = '"';
556
557 /* always keep 3 chars to support passing "" and the ending " */
558 while (*str && p < end - 3) {
559 if (*str == '"') {
560 *p++ = '"';
561 *p++ = '"';
562 }
563 else
564 *p++ = *str;
565 str++;
566 }
567 *p++ = '"';
568 return ret;
569}
570
Robert Tsai81ae1952007-12-05 10:47:29 +0100571/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200572 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
573 *
574 * It looks like this one would be a good candidate for inlining, but this is
575 * not interesting because it around 35 bytes long and often called multiple
576 * times within the same function.
577 */
578int ishex(char s)
579{
580 s -= '0';
581 if ((unsigned char)s <= 9)
582 return 1;
583 s -= 'A' - '0';
584 if ((unsigned char)s <= 5)
585 return 1;
586 s -= 'a' - 'A';
587 if ((unsigned char)s <= 5)
588 return 1;
589 return 0;
590}
591
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100592/* rounds <i> down to the closest value having max 2 digits */
593unsigned int round_2dig(unsigned int i)
594{
595 unsigned int mul = 1;
596
597 while (i >= 100) {
598 i /= 10;
599 mul *= 10;
600 }
601 return i * mul;
602}
603
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100604/*
605 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
606 * invalid character is found, a pointer to it is returned. If everything is
607 * fine, NULL is returned.
608 */
609const char *invalid_char(const char *name)
610{
611 if (!*name)
612 return name;
613
614 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100615 if (!isalnum((unsigned char)*name) && *name != '.' && *name != ':' &&
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100616 *name != '_' && *name != '-')
617 return name;
618 name++;
619 }
620 return NULL;
621}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200622
623/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200624 * Checks <name> for invalid characters. Valid chars are [_.-] and those
625 * accepted by <f> function.
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200626 * If an invalid character is found, a pointer to it is returned.
627 * If everything is fine, NULL is returned.
628 */
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200629static inline const char *__invalid_char(const char *name, int (*f)(int)) {
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200630
631 if (!*name)
632 return name;
633
634 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100635 if (!f((unsigned char)*name) && *name != '.' &&
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200636 *name != '_' && *name != '-')
637 return name;
638
639 name++;
640 }
641
642 return NULL;
643}
644
645/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200646 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
647 * If an invalid character is found, a pointer to it is returned.
648 * If everything is fine, NULL is returned.
649 */
650const char *invalid_domainchar(const char *name) {
651 return __invalid_char(name, isalnum);
652}
653
654/*
655 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
656 * If an invalid character is found, a pointer to it is returned.
657 * If everything is fine, NULL is returned.
658 */
659const char *invalid_prefix_char(const char *name) {
Thierry Fournierf7b7c3e2018-03-26 11:54:39 +0200660 return __invalid_char(name, isalnum);
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200661}
662
663/*
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100664 * converts <str> to a struct sockaddr_storage* provided by the caller. The
Willy Tarreau24709282013-03-10 21:32:12 +0100665 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
666 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
667 * the function tries to guess the address family from the syntax. If the
668 * family is forced and the format doesn't match, an error is returned. The
Willy Tarreaufab5a432011-03-04 15:31:53 +0100669 * string is assumed to contain only an address, no port. The address can be a
670 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
671 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
672 * The return address will only have the address family and the address set,
673 * all other fields remain zero. The string is not supposed to be modified.
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100674 * The IPv6 '::' address is IN6ADDR_ANY. If <resolve> is non-zero, the hostname
675 * is resolved, otherwise only IP addresses are resolved, and anything else
Willy Tarreauecde7df2016-11-02 22:37:03 +0100676 * returns NULL. If the address contains a port, this one is preserved.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200677 */
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100678struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200679{
Willy Tarreaufab5a432011-03-04 15:31:53 +0100680 struct hostent *he;
mildisff5d5102015-10-26 18:50:08 +0100681 /* max IPv6 length, including brackets and terminating NULL */
682 char tmpip[48];
Willy Tarreauecde7df2016-11-02 22:37:03 +0100683 int port = get_host_port(sa);
mildisff5d5102015-10-26 18:50:08 +0100684
685 /* check IPv6 with square brackets */
686 if (str[0] == '[') {
687 size_t iplength = strlen(str);
688
689 if (iplength < 4) {
690 /* minimal size is 4 when using brackets "[::]" */
691 goto fail;
692 }
693 else if (iplength >= sizeof(tmpip)) {
694 /* IPv6 literal can not be larger than tmpip */
695 goto fail;
696 }
697 else {
698 if (str[iplength - 1] != ']') {
699 /* if address started with bracket, it should end with bracket */
700 goto fail;
701 }
702 else {
703 memcpy(tmpip, str + 1, iplength - 2);
704 tmpip[iplength - 2] = '\0';
705 str = tmpip;
706 }
707 }
708 }
Willy Tarreaufab5a432011-03-04 15:31:53 +0100709
Willy Tarreaufab5a432011-03-04 15:31:53 +0100710 /* Any IPv6 address */
711 if (str[0] == ':' && str[1] == ':' && !str[2]) {
Willy Tarreau24709282013-03-10 21:32:12 +0100712 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
713 sa->ss_family = AF_INET6;
714 else if (sa->ss_family != AF_INET6)
715 goto fail;
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
Willy Tarreau24709282013-03-10 21:32:12 +0100720 /* Any address for the family, defaults to IPv4 */
Willy Tarreaufab5a432011-03-04 15:31:53 +0100721 if (!str[0] || (str[0] == '*' && !str[1])) {
Willy Tarreau24709282013-03-10 21:32:12 +0100722 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
723 sa->ss_family = AF_INET;
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 /* check for IPv6 first */
Willy Tarreau24709282013-03-10 21:32:12 +0100729 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET6) &&
730 inet_pton(AF_INET6, str, &((struct sockaddr_in6 *)sa)->sin6_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100731 sa->ss_family = AF_INET6;
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
736 /* then check for IPv4 */
Willy Tarreau24709282013-03-10 21:32:12 +0100737 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET) &&
738 inet_pton(AF_INET, str, &((struct sockaddr_in *)sa)->sin_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100739 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100740 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100741 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100742 }
743
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100744 if (!resolve)
745 return NULL;
746
Emeric Brund30e9a12020-12-23 18:49:16 +0100747 if (!resolv_hostname_validation(str, NULL))
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200748 return NULL;
749
David du Colombierd5f43282011-03-17 10:40:16 +0100750#ifdef USE_GETADDRINFO
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200751 if (global.tune.options & GTUNE_USE_GAI) {
David du Colombierd5f43282011-03-17 10:40:16 +0100752 struct addrinfo hints, *result;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100753 int success = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100754
755 memset(&result, 0, sizeof(result));
756 memset(&hints, 0, sizeof(hints));
Willy Tarreau24709282013-03-10 21:32:12 +0100757 hints.ai_family = sa->ss_family ? sa->ss_family : AF_UNSPEC;
David du Colombierd5f43282011-03-17 10:40:16 +0100758 hints.ai_socktype = SOCK_DGRAM;
Dmitry Sivachenkoeab7f392015-10-02 01:01:58 +0200759 hints.ai_flags = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100760 hints.ai_protocol = 0;
761
762 if (getaddrinfo(str, NULL, &hints, &result) == 0) {
Willy Tarreau24709282013-03-10 21:32:12 +0100763 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
764 sa->ss_family = result->ai_family;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100765 else if (sa->ss_family != result->ai_family) {
766 freeaddrinfo(result);
Willy Tarreau24709282013-03-10 21:32:12 +0100767 goto fail;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100768 }
Willy Tarreau24709282013-03-10 21:32:12 +0100769
David du Colombierd5f43282011-03-17 10:40:16 +0100770 switch (result->ai_family) {
771 case AF_INET:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100772 memcpy((struct sockaddr_in *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100773 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100774 success = 1;
775 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100776 case AF_INET6:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100777 memcpy((struct sockaddr_in6 *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100778 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100779 success = 1;
780 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100781 }
782 }
783
Sean Carey58ea0392013-02-15 23:39:18 +0100784 if (result)
785 freeaddrinfo(result);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100786
787 if (success)
788 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100789 }
David du Colombierd5f43282011-03-17 10:40:16 +0100790#endif
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200791 /* try to resolve an IPv4/IPv6 hostname */
792 he = gethostbyname(str);
793 if (he) {
794 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
795 sa->ss_family = he->h_addrtype;
796 else if (sa->ss_family != he->h_addrtype)
797 goto fail;
798
799 switch (sa->ss_family) {
800 case AF_INET:
801 ((struct sockaddr_in *)sa)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100802 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200803 return sa;
804 case AF_INET6:
805 ((struct sockaddr_in6 *)sa)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100806 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200807 return sa;
808 }
809 }
810
David du Colombierd5f43282011-03-17 10:40:16 +0100811 /* unsupported address family */
Willy Tarreau24709282013-03-10 21:32:12 +0100812 fail:
Willy Tarreaufab5a432011-03-04 15:31:53 +0100813 return NULL;
814}
815
816/*
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100817 * Converts <str> to a locally allocated struct sockaddr_storage *, and a port
818 * range or offset consisting in two integers that the caller will have to
819 * check to find the relevant input format. The following format are supported :
820 *
821 * String format | address | port | low | high
822 * addr | <addr> | 0 | 0 | 0
823 * addr: | <addr> | 0 | 0 | 0
824 * addr:port | <addr> | <port> | <port> | <port>
825 * addr:pl-ph | <addr> | <pl> | <pl> | <ph>
826 * addr:+port | <addr> | <port> | 0 | <port>
827 * addr:-port | <addr> |-<port> | <port> | 0
828 *
829 * The detection of a port range or increment by the caller is made by
830 * comparing <low> and <high>. If both are equal, then port 0 means no port
831 * was specified. The caller may pass NULL for <low> and <high> if it is not
832 * interested in retrieving port ranges.
833 *
834 * Note that <addr> above may also be :
835 * - empty ("") => family will be AF_INET and address will be INADDR_ANY
836 * - "*" => family will be AF_INET and address will be INADDR_ANY
837 * - "::" => family will be AF_INET6 and address will be IN6ADDR_ANY
838 * - a host name => family and address will depend on host name resolving.
839 *
Willy Tarreau24709282013-03-10 21:32:12 +0100840 * A prefix may be passed in before the address above to force the family :
841 * - "ipv4@" => force address to resolve as IPv4 and fail if not possible.
842 * - "ipv6@" => force address to resolve as IPv6 and fail if not possible.
843 * - "unix@" => force address to be a path to a UNIX socket even if the
844 * path does not start with a '/'
Willy Tarreauccfccef2014-05-10 01:49:15 +0200845 * - 'abns@' -> force address to belong to the abstract namespace (Linux
846 * only). These sockets are just like Unix sockets but without
847 * the need for an underlying file system. The address is a
848 * string. Technically it's like a Unix socket with a zero in
849 * the first byte of the address.
Willy Tarreau40aa0702013-03-10 23:51:38 +0100850 * - "fd@" => an integer must follow, and is a file descriptor number.
Willy Tarreau24709282013-03-10 21:32:12 +0100851 *
mildisff5d5102015-10-26 18:50:08 +0100852 * IPv6 addresses can be declared with or without square brackets. When using
853 * square brackets for IPv6 addresses, the port separator (colon) is optional.
854 * If not using square brackets, and in order to avoid any ambiguity with
855 * IPv6 addresses, the last colon ':' is mandatory even when no port is specified.
856 * NULL is returned if the address cannot be parsed. The <low> and <high> ports
857 * are always initialized if non-null, even for non-IP families.
Willy Tarreaud393a622013-03-04 18:22:00 +0100858 *
859 * If <pfx> is non-null, it is used as a string prefix before any path-based
860 * address (typically the path to a unix socket).
Willy Tarreau40aa0702013-03-10 23:51:38 +0100861 *
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200862 * if <fqdn> is non-null, it will be filled with :
863 * - a pointer to the FQDN of the server name to resolve if there's one, and
864 * that the caller will have to free(),
865 * - NULL if there was an explicit address that doesn't require resolution.
866 *
Willy Tarreaucd3a55912020-09-04 15:30:46 +0200867 * Hostnames are only resolved if <opts> has PA_O_RESOLVE. Otherwise <fqdn> is
868 * still honored so it is possible for the caller to know whether a resolution
869 * failed by clearing this flag and checking if <fqdn> was filled, indicating
870 * the need for a resolution.
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200871 *
Willy Tarreau40aa0702013-03-10 23:51:38 +0100872 * When a file descriptor is passed, its value is put into the s_addr part of
Willy Tarreaua5b325f2020-09-04 16:44:20 +0200873 * the address when cast to sockaddr_in and the address family is
874 * AF_CUST_EXISTING_FD.
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200875 *
Willy Tarreau5fc93282020-09-16 18:25:03 +0200876 * The matching protocol will be set into <proto> if non-null.
877 *
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200878 * Any known file descriptor is also assigned to <fd> if non-null, otherwise it
879 * is forced to -1.
Willy Tarreaufab5a432011-03-04 15:31:53 +0100880 */
Willy Tarreau5fc93282020-09-16 18:25:03 +0200881struct sockaddr_storage *str2sa_range(const char *str, int *port, int *low, int *high, int *fd,
882 struct protocol **proto, char **err,
883 const char *pfx, char **fqdn, unsigned int opts)
Willy Tarreaufab5a432011-03-04 15:31:53 +0100884{
Christopher Faulet1bc04c72017-10-29 20:14:08 +0100885 static THREAD_LOCAL struct sockaddr_storage ss;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100886 struct sockaddr_storage *ret = NULL;
Willy Tarreau5fc93282020-09-16 18:25:03 +0200887 struct protocol *new_proto = NULL;
Willy Tarreau24709282013-03-10 21:32:12 +0100888 char *back, *str2;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100889 char *port1, *port2;
890 int portl, porth, porta;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200891 int abstract = 0;
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200892 int new_fd = -1;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200893 int sock_type, ctrl_type;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100894
895 portl = porth = porta = 0;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200896 if (fqdn)
897 *fqdn = NULL;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200898
Willy Tarreaudad36a32013-03-11 01:20:04 +0100899 str2 = back = env_expand(strdup(str));
Willy Tarreaudf350f12013-03-01 20:22:54 +0100900 if (str2 == NULL) {
901 memprintf(err, "out of memory in '%s'\n", __FUNCTION__);
Willy Tarreaud5191e72010-02-09 20:50:45 +0100902 goto out;
Willy Tarreaudf350f12013-03-01 20:22:54 +0100903 }
Willy Tarreaubaaee002006-06-26 02:48:02 +0200904
Willy Tarreau9f69f462015-09-08 16:01:25 +0200905 if (!*str2) {
906 memprintf(err, "'%s' resolves to an empty address (environment variable missing?)\n", str);
907 goto out;
908 }
909
Willy Tarreau24709282013-03-10 21:32:12 +0100910 memset(&ss, 0, sizeof(ss));
911
Willy Tarreaue835bd82020-09-16 11:35:47 +0200912 /* prepare the default socket types */
Emeric Brun69ba3512021-03-22 17:17:34 +0100913 if (((opts & (PA_O_STREAM|PA_O_DGRAM)) == PA_O_DGRAM))
914 || (((opts & (PA_O_STREAM|PA_O_DGRAM)) == (PA_O_DGRAM|PA_O_STREAM))
915 && (opts & PA_O_DEFAULT_DGRAM))
Willy Tarreaue835bd82020-09-16 11:35:47 +0200916 sock_type = ctrl_type = SOCK_DGRAM;
917 else
918 sock_type = ctrl_type = SOCK_STREAM;
919
920 if (strncmp(str2, "stream+", 7) == 0) {
921 str2 += 7;
922 sock_type = ctrl_type = SOCK_STREAM;
923 }
924 else if (strncmp(str2, "dgram+", 6) == 0) {
925 str2 += 6;
926 sock_type = ctrl_type = SOCK_DGRAM;
927 }
928
Willy Tarreau24709282013-03-10 21:32:12 +0100929 if (strncmp(str2, "unix@", 5) == 0) {
930 str2 += 5;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200931 abstract = 0;
Willy Tarreau24709282013-03-10 21:32:12 +0100932 ss.ss_family = AF_UNIX;
933 }
Willy Tarreauccfccef2014-05-10 01:49:15 +0200934 else if (strncmp(str2, "abns@", 5) == 0) {
935 str2 += 5;
936 abstract = 1;
937 ss.ss_family = AF_UNIX;
938 }
Willy Tarreau24709282013-03-10 21:32:12 +0100939 else if (strncmp(str2, "ipv4@", 5) == 0) {
940 str2 += 5;
941 ss.ss_family = AF_INET;
942 }
943 else if (strncmp(str2, "ipv6@", 5) == 0) {
944 str2 += 5;
945 ss.ss_family = AF_INET6;
946 }
Emeric Brun3835c0d2020-07-07 09:46:09 +0200947 else if (strncmp(str2, "udp4@", 5) == 0) {
948 str2 += 5;
949 ss.ss_family = AF_INET;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200950 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +0200951 }
952 else if (strncmp(str2, "udp6@", 5) == 0) {
953 str2 += 5;
954 ss.ss_family = AF_INET6;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200955 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +0200956 }
957 else if (strncmp(str2, "udp@", 4) == 0) {
958 str2 += 4;
959 ss.ss_family = AF_UNSPEC;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200960 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +0200961 }
Frédéric Lécaille10caf652020-11-23 11:36:57 +0100962 else if (strncmp(str2, "quic4@", 6) == 0) {
963 str2 += 6;
964 ss.ss_family = AF_INET;
965 sock_type = SOCK_DGRAM;
966 ctrl_type = SOCK_STREAM;
967 }
968 else if (strncmp(str2, "quic6@", 6) == 0) {
969 str2 += 6;
970 ss.ss_family = AF_INET6;
971 sock_type = SOCK_DGRAM;
972 ctrl_type = SOCK_STREAM;
973 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +0200974 else if (strncmp(str2, "fd@", 3) == 0) {
975 str2 += 3;
976 ss.ss_family = AF_CUST_EXISTING_FD;
977 }
978 else if (strncmp(str2, "sockpair@", 9) == 0) {
979 str2 += 9;
980 ss.ss_family = AF_CUST_SOCKPAIR;
981 }
Willy Tarreau24709282013-03-10 21:32:12 +0100982 else if (*str2 == '/') {
983 ss.ss_family = AF_UNIX;
984 }
985 else
986 ss.ss_family = AF_UNSPEC;
987
Willy Tarreau5a7beed2020-09-04 16:54:05 +0200988 if (ss.ss_family == AF_CUST_SOCKPAIR) {
Willy Tarreaua215be22020-09-16 10:14:16 +0200989 struct sockaddr_storage ss2;
990 socklen_t addr_len;
William Lallemand2fe7dd02018-09-11 16:51:29 +0200991 char *endptr;
992
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200993 new_fd = strtol(str2, &endptr, 10);
994 if (!*str2 || new_fd < 0 || *endptr) {
William Lallemand2fe7dd02018-09-11 16:51:29 +0200995 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
996 goto out;
997 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200998
Willy Tarreaua215be22020-09-16 10:14:16 +0200999 /* just verify that it's a socket */
1000 addr_len = sizeof(ss2);
1001 if (getsockname(new_fd, (struct sockaddr *)&ss2, &addr_len) == -1) {
1002 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1003 goto out;
1004 }
1005
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001006 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1007 ((struct sockaddr_in *)&ss)->sin_port = 0;
William Lallemand2fe7dd02018-09-11 16:51:29 +02001008 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001009 else if (ss.ss_family == AF_CUST_EXISTING_FD) {
Willy Tarreau40aa0702013-03-10 23:51:38 +01001010 char *endptr;
1011
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001012 new_fd = strtol(str2, &endptr, 10);
1013 if (!*str2 || new_fd < 0 || *endptr) {
Willy Tarreaudad36a32013-03-11 01:20:04 +01001014 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
Willy Tarreau40aa0702013-03-10 23:51:38 +01001015 goto out;
1016 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001017
Willy Tarreau6edc7222020-09-15 17:41:56 +02001018 if (opts & PA_O_SOCKET_FD) {
1019 socklen_t addr_len;
1020 int type;
1021
1022 addr_len = sizeof(ss);
1023 if (getsockname(new_fd, (struct sockaddr *)&ss, &addr_len) == -1) {
1024 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1025 goto out;
1026 }
1027
1028 addr_len = sizeof(type);
1029 if (getsockopt(new_fd, SOL_SOCKET, SO_TYPE, &type, &addr_len) != 0 ||
Willy Tarreaue835bd82020-09-16 11:35:47 +02001030 (type == SOCK_STREAM) != (sock_type == SOCK_STREAM)) {
Willy Tarreau6edc7222020-09-15 17:41:56 +02001031 memprintf(err, "socket on file descriptor '%d' is of the wrong type.\n", new_fd);
1032 goto out;
1033 }
1034
1035 porta = portl = porth = get_host_port(&ss);
1036 } else if (opts & PA_O_RAW_FD) {
1037 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1038 ((struct sockaddr_in *)&ss)->sin_port = 0;
1039 } else {
1040 memprintf(err, "a file descriptor is not acceptable here in '%s'\n", str);
1041 goto out;
1042 }
Willy Tarreau40aa0702013-03-10 23:51:38 +01001043 }
1044 else if (ss.ss_family == AF_UNIX) {
Willy Tarreau8daa9202019-06-16 18:16:33 +02001045 struct sockaddr_un *un = (struct sockaddr_un *)&ss;
Willy Tarreau15586382013-03-04 19:48:14 +01001046 int prefix_path_len;
1047 int max_path_len;
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001048 int adr_len;
Willy Tarreau15586382013-03-04 19:48:14 +01001049
1050 /* complete unix socket path name during startup or soft-restart is
1051 * <unix_bind_prefix><path>.<pid>.<bak|tmp>
1052 */
Willy Tarreauccfccef2014-05-10 01:49:15 +02001053 prefix_path_len = (pfx && !abstract) ? strlen(pfx) : 0;
Willy Tarreau8daa9202019-06-16 18:16:33 +02001054 max_path_len = (sizeof(un->sun_path) - 1) -
Willy Tarreau327ea5a2020-02-11 06:43:37 +01001055 (abstract ? 0 : prefix_path_len + 1 + 5 + 1 + 3);
Willy Tarreau15586382013-03-04 19:48:14 +01001056
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001057 adr_len = strlen(str2);
1058 if (adr_len > max_path_len) {
Willy Tarreau15586382013-03-04 19:48:14 +01001059 memprintf(err, "socket path '%s' too long (max %d)\n", str, max_path_len);
1060 goto out;
1061 }
1062
Willy Tarreauccfccef2014-05-10 01:49:15 +02001063 /* when abstract==1, we skip the first zero and copy all bytes except the trailing zero */
Willy Tarreau8daa9202019-06-16 18:16:33 +02001064 memset(un->sun_path, 0, sizeof(un->sun_path));
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001065 if (prefix_path_len)
Willy Tarreau8daa9202019-06-16 18:16:33 +02001066 memcpy(un->sun_path, pfx, prefix_path_len);
1067 memcpy(un->sun_path + prefix_path_len + abstract, str2, adr_len + 1 - abstract);
Willy Tarreau15586382013-03-04 19:48:14 +01001068 }
Willy Tarreau24709282013-03-10 21:32:12 +01001069 else { /* IPv4 and IPv6 */
mildisff5d5102015-10-26 18:50:08 +01001070 char *end = str2 + strlen(str2);
1071 char *chr;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001072
mildisff5d5102015-10-26 18:50:08 +01001073 /* search for : or ] whatever comes first */
1074 for (chr = end-1; chr > str2; chr--) {
1075 if (*chr == ']' || *chr == ':')
1076 break;
1077 }
1078
1079 if (*chr == ':') {
1080 /* Found a colon before a closing-bracket, must be a port separator.
1081 * This guarantee backward compatibility.
1082 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001083 if (!(opts & PA_O_PORT_OK)) {
1084 memprintf(err, "port specification not permitted here in '%s'", str);
1085 goto out;
1086 }
mildisff5d5102015-10-26 18:50:08 +01001087 *chr++ = '\0';
1088 port1 = chr;
1089 }
1090 else {
1091 /* Either no colon and no closing-bracket
1092 * or directly ending with a closing-bracket.
1093 * However, no port.
1094 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001095 if (opts & PA_O_PORT_MAND) {
1096 memprintf(err, "missing port specification in '%s'", str);
1097 goto out;
1098 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001099 port1 = "";
mildisff5d5102015-10-26 18:50:08 +01001100 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001101
Willy Tarreau90807112020-02-25 08:16:33 +01001102 if (isdigit((unsigned char)*port1)) { /* single port or range */
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001103 port2 = strchr(port1, '-');
Willy Tarreau7f96a842020-09-15 11:12:44 +02001104 if (port2) {
1105 if (!(opts & PA_O_PORT_RANGE)) {
1106 memprintf(err, "port range not permitted here in '%s'", str);
1107 goto out;
1108 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001109 *port2++ = '\0';
Willy Tarreau7f96a842020-09-15 11:12:44 +02001110 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001111 else
1112 port2 = port1;
1113 portl = atoi(port1);
1114 porth = atoi(port2);
Willy Tarreau7f96a842020-09-15 11:12:44 +02001115
1116 if (portl < !!(opts & PA_O_PORT_MAND) || portl > 65535) {
1117 memprintf(err, "invalid port '%s'", port1);
1118 goto out;
1119 }
1120
1121 if (porth < !!(opts & PA_O_PORT_MAND) || porth > 65535) {
1122 memprintf(err, "invalid port '%s'", port2);
1123 goto out;
1124 }
1125
1126 if (portl > porth) {
1127 memprintf(err, "invalid port range '%d-%d'", portl, porth);
1128 goto out;
1129 }
1130
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001131 porta = portl;
1132 }
1133 else if (*port1 == '-') { /* negative offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001134 if (!(opts & PA_O_PORT_OFS)) {
1135 memprintf(err, "port offset not permitted here in '%s'", str);
1136 goto out;
1137 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001138 portl = atoi(port1 + 1);
1139 porta = -portl;
1140 }
1141 else if (*port1 == '+') { /* positive offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001142 if (!(opts & PA_O_PORT_OFS)) {
1143 memprintf(err, "port offset not permitted here in '%s'", str);
1144 goto out;
1145 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001146 porth = atoi(port1 + 1);
1147 porta = porth;
1148 }
1149 else if (*port1) { /* other any unexpected char */
Willy Tarreaudad36a32013-03-11 01:20:04 +01001150 memprintf(err, "invalid character '%c' in port number '%s' in '%s'\n", *port1, port1, str);
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001151 goto out;
1152 }
Willy Tarreau7f96a842020-09-15 11:12:44 +02001153 else if (opts & PA_O_PORT_MAND) {
1154 memprintf(err, "missing port specification in '%s'", str);
1155 goto out;
1156 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001157
1158 /* first try to parse the IP without resolving. If it fails, it
1159 * tells us we need to keep a copy of the FQDN to resolve later
1160 * and to enable DNS. In this case we can proceed if <fqdn> is
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001161 * set or if PA_O_RESOLVE is set, otherwise it's an error.
Willy Tarreauceccdd72016-11-02 22:27:10 +01001162 */
1163 if (str2ip2(str2, &ss, 0) == NULL) {
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001164 if ((!(opts & PA_O_RESOLVE) && !fqdn) ||
1165 ((opts & PA_O_RESOLVE) && str2ip2(str2, &ss, 1) == NULL)) {
Willy Tarreauceccdd72016-11-02 22:27:10 +01001166 memprintf(err, "invalid address: '%s' in '%s'\n", str2, str);
1167 goto out;
1168 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001169
Willy Tarreauceccdd72016-11-02 22:27:10 +01001170 if (fqdn) {
1171 if (str2 != back)
1172 memmove(back, str2, strlen(str2) + 1);
1173 *fqdn = back;
1174 back = NULL;
1175 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001176 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001177 set_host_port(&ss, porta);
Willy Tarreaue4c58c82013-03-06 15:28:17 +01001178 }
Willy Tarreaufab5a432011-03-04 15:31:53 +01001179
Willy Tarreaue835bd82020-09-16 11:35:47 +02001180 if (ctrl_type == SOCK_STREAM && !(opts & PA_O_STREAM)) {
1181 memprintf(err, "stream-type socket not acceptable in '%s'\n", str);
1182 goto out;
1183 }
1184 else if (ctrl_type == SOCK_DGRAM && !(opts & PA_O_DGRAM)) {
1185 memprintf(err, "dgram-type socket not acceptable in '%s'\n", str);
1186 goto out;
1187 }
1188
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001189 if (proto || (opts & PA_O_CONNECT)) {
Willy Tarreau5fc93282020-09-16 18:25:03 +02001190 /* Note: if the caller asks for a proto, we must find one,
1191 * except if we return with an fqdn that will resolve later,
1192 * in which case the address is not known yet (this is only
1193 * for servers actually).
1194 */
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001195 new_proto = protocol_lookup(ss.ss_family,
Willy Tarreauaf9609b2020-09-16 22:04:46 +02001196 sock_type == SOCK_DGRAM,
1197 ctrl_type == SOCK_DGRAM);
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001198
Willy Tarreau5fc93282020-09-16 18:25:03 +02001199 if (!new_proto && (!fqdn || !*fqdn)) {
1200 memprintf(err, "unsupported protocol family %d for address '%s'", ss.ss_family, str);
1201 goto out;
1202 }
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001203
1204 if ((opts & PA_O_CONNECT) && new_proto && !new_proto->connect) {
1205 memprintf(err, "connect() not supported for this protocol family %d used by address '%s'", ss.ss_family, str);
1206 goto out;
1207 }
Willy Tarreau5fc93282020-09-16 18:25:03 +02001208 }
1209
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001210 ret = &ss;
Willy Tarreaud5191e72010-02-09 20:50:45 +01001211 out:
Willy Tarreau48ef4c92017-01-06 18:32:38 +01001212 if (port)
1213 *port = porta;
Willy Tarreaud4448bc2013-02-20 15:55:15 +01001214 if (low)
1215 *low = portl;
1216 if (high)
1217 *high = porth;
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001218 if (fd)
1219 *fd = new_fd;
Willy Tarreau5fc93282020-09-16 18:25:03 +02001220 if (proto)
1221 *proto = new_proto;
Willy Tarreau24709282013-03-10 21:32:12 +01001222 free(back);
Willy Tarreaud5191e72010-02-09 20:50:45 +01001223 return ret;
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001224}
1225
Thayne McCombs92149f92020-11-20 01:28:26 -07001226/* converts <addr> and <port> into a string representation of the address and port. This is sort
1227 * of an inverse of str2sa_range, with some restrictions. The supported families are AF_INET,
1228 * AF_INET6, AF_UNIX, and AF_CUST_SOCKPAIR. If the family is unsopported NULL is returned.
1229 * If map_ports is true, then the sign of the port is included in the output, to indicate it is
1230 * relative to the incoming port. AF_INET and AF_INET6 will be in the form "<addr>:<port>".
1231 * AF_UNIX will either be just the path (if using a pathname) or "abns@<path>" if it is abstract.
1232 * AF_CUST_SOCKPAIR will be of the form "sockpair@<fd>".
1233 *
1234 * The returned char* is allocated, and it is the responsibility of the caller to free it.
1235 */
1236char * sa2str(const struct sockaddr_storage *addr, int port, int map_ports)
1237{
1238 char buffer[INET6_ADDRSTRLEN];
1239 char *out = NULL;
1240 const void *ptr;
1241 const char *path;
1242
1243 switch (addr->ss_family) {
1244 case AF_INET:
1245 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1246 break;
1247 case AF_INET6:
1248 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1249 break;
1250 case AF_UNIX:
1251 path = ((struct sockaddr_un *)addr)->sun_path;
1252 if (path[0] == '\0') {
1253 const int max_length = sizeof(struct sockaddr_un) - offsetof(struct sockaddr_un, sun_path) - 1;
1254 return memprintf(&out, "abns@%.*s", max_length, path+1);
1255 } else {
1256 return strdup(path);
1257 }
1258 case AF_CUST_SOCKPAIR:
1259 return memprintf(&out, "sockpair@%d", ((struct sockaddr_in *)addr)->sin_addr.s_addr);
1260 default:
1261 return NULL;
1262 }
1263 inet_ntop(addr->ss_family, ptr, buffer, get_addr_len(addr));
1264 if (map_ports)
1265 return memprintf(&out, "%s:%+d", buffer, port);
1266 else
1267 return memprintf(&out, "%s:%d", buffer, port);
1268}
1269
1270
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001271/* converts <str> to a struct in_addr containing a network mask. It can be
1272 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +03001273 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001274 */
1275int str2mask(const char *str, struct in_addr *mask)
1276{
1277 if (strchr(str, '.') != NULL) { /* dotted notation */
1278 if (!inet_pton(AF_INET, str, mask))
1279 return 0;
1280 }
1281 else { /* mask length */
1282 char *err;
1283 unsigned long len = strtol(str, &err, 10);
1284
1285 if (!*str || (err && *err) || (unsigned)len > 32)
1286 return 0;
Tim Duesterhus8575f722018-01-25 16:24:48 +01001287
1288 len2mask4(len, mask);
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001289 }
1290 return 1;
1291}
1292
Tim Duesterhus47185172018-01-25 16:24:49 +01001293/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +01001294 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +01001295 * if the conversion succeeds otherwise zero.
1296 */
1297int str2mask6(const char *str, struct in6_addr *mask)
1298{
1299 if (strchr(str, ':') != NULL) { /* quadruplet notation */
1300 if (!inet_pton(AF_INET6, str, mask))
1301 return 0;
1302 }
1303 else { /* mask length */
1304 char *err;
1305 unsigned long len = strtol(str, &err, 10);
1306
1307 if (!*str || (err && *err) || (unsigned)len > 128)
1308 return 0;
1309
1310 len2mask6(len, mask);
1311 }
1312 return 1;
1313}
1314
Thierry FOURNIERb0504632013-12-14 15:39:02 +01001315/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
1316 * succeeds otherwise zero.
1317 */
1318int cidr2dotted(int cidr, struct in_addr *mask) {
1319
1320 if (cidr < 0 || cidr > 32)
1321 return 0;
1322
1323 mask->s_addr = cidr ? htonl(~0UL << (32 - cidr)) : 0;
1324 return 1;
1325}
1326
Thierry Fournier70473a52016-02-17 17:12:14 +01001327/* Convert mask from bit length form to in_addr form.
1328 * This function never fails.
1329 */
1330void len2mask4(int len, struct in_addr *addr)
1331{
1332 if (len >= 32) {
1333 addr->s_addr = 0xffffffff;
1334 return;
1335 }
1336 if (len <= 0) {
1337 addr->s_addr = 0x00000000;
1338 return;
1339 }
1340 addr->s_addr = 0xffffffff << (32 - len);
1341 addr->s_addr = htonl(addr->s_addr);
1342}
1343
1344/* Convert mask from bit length form to in6_addr form.
1345 * This function never fails.
1346 */
1347void len2mask6(int len, struct in6_addr *addr)
1348{
1349 len2mask4(len, (struct in_addr *)&addr->s6_addr[0]); /* msb */
1350 len -= 32;
1351 len2mask4(len, (struct in_addr *)&addr->s6_addr[4]);
1352 len -= 32;
1353 len2mask4(len, (struct in_addr *)&addr->s6_addr[8]);
1354 len -= 32;
1355 len2mask4(len, (struct in_addr *)&addr->s6_addr[12]); /* lsb */
1356}
1357
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001358/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +02001359 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001360 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001361 * is optional and either in the dotted or CIDR notation.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001362 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
1363 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001364int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001365{
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001366 __label__ out_free, out_err;
1367 char *c, *s;
1368 int ret_val;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001369
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001370 s = strdup(str);
1371 if (!s)
1372 return 0;
1373
Willy Tarreaubaaee002006-06-26 02:48:02 +02001374 memset(mask, 0, sizeof(*mask));
1375 memset(addr, 0, sizeof(*addr));
Willy Tarreaubaaee002006-06-26 02:48:02 +02001376
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001377 if ((c = strrchr(s, '/')) != NULL) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001378 *c++ = '\0';
1379 /* c points to the mask */
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001380 if (!str2mask(c, mask))
1381 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001382 }
1383 else {
Willy Tarreauebd61602006-12-30 11:54:15 +01001384 mask->s_addr = ~0U;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001385 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001386 if (!inet_pton(AF_INET, s, addr)) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001387 struct hostent *he;
1388
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001389 if (!resolve)
1390 goto out_err;
1391
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001392 if ((he = gethostbyname(s)) == NULL) {
1393 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001394 }
1395 else
1396 *addr = *(struct in_addr *) *(he->h_addr_list);
1397 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001398
1399 ret_val = 1;
1400 out_free:
1401 free(s);
1402 return ret_val;
1403 out_err:
1404 ret_val = 0;
1405 goto out_free;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001406}
1407
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001408
1409/*
Willy Tarreau6d20e282012-04-27 22:49:47 +02001410 * converts <str> to two struct in6_addr* which must be pre-allocated.
1411 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001412 * is an optional number of bits (128 being the default).
Willy Tarreau6d20e282012-04-27 22:49:47 +02001413 * Returns 1 if OK, 0 if error.
1414 */
1415int str62net(const char *str, struct in6_addr *addr, unsigned char *mask)
1416{
1417 char *c, *s;
1418 int ret_val = 0;
1419 char *err;
1420 unsigned long len = 128;
1421
1422 s = strdup(str);
1423 if (!s)
1424 return 0;
1425
1426 memset(mask, 0, sizeof(*mask));
1427 memset(addr, 0, sizeof(*addr));
1428
1429 if ((c = strrchr(s, '/')) != NULL) {
1430 *c++ = '\0'; /* c points to the mask */
1431 if (!*c)
1432 goto out_free;
1433
1434 len = strtoul(c, &err, 10);
1435 if ((err && *err) || (unsigned)len > 128)
1436 goto out_free;
1437 }
1438 *mask = len; /* OK we have a valid mask in <len> */
1439
1440 if (!inet_pton(AF_INET6, s, addr))
1441 goto out_free;
1442
1443 ret_val = 1;
1444 out_free:
1445 free(s);
1446 return ret_val;
1447}
1448
1449
1450/*
David du Colombier6f5ccb12011-03-10 22:26:24 +01001451 * Parse IPv4 address found in url.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001452 */
David du Colombier6f5ccb12011-03-10 22:26:24 +01001453int url2ipv4(const char *addr, struct in_addr *dst)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001454{
1455 int saw_digit, octets, ch;
1456 u_char tmp[4], *tp;
1457 const char *cp = addr;
1458
1459 saw_digit = 0;
1460 octets = 0;
1461 *(tp = tmp) = 0;
1462
1463 while (*addr) {
1464 unsigned char digit = (ch = *addr++) - '0';
1465 if (digit > 9 && ch != '.')
1466 break;
1467 if (digit <= 9) {
1468 u_int new = *tp * 10 + digit;
1469 if (new > 255)
1470 return 0;
1471 *tp = new;
1472 if (!saw_digit) {
1473 if (++octets > 4)
1474 return 0;
1475 saw_digit = 1;
1476 }
1477 } else if (ch == '.' && saw_digit) {
1478 if (octets == 4)
1479 return 0;
1480 *++tp = 0;
1481 saw_digit = 0;
1482 } else
1483 return 0;
1484 }
1485
1486 if (octets < 4)
1487 return 0;
1488
1489 memcpy(&dst->s_addr, tmp, 4);
1490 return addr-cp-1;
1491}
1492
1493/*
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001494 * Resolve destination server from URL. Convert <str> to a sockaddr_storage.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001495 * <out> contain the code of the detected scheme, the start and length of
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001496 * the hostname. Actually only http and https are supported. <out> can be NULL.
1497 * This function returns the consumed length. It is useful if you parse complete
1498 * url like http://host:port/path, because the consumed length corresponds to
1499 * the first character of the path. If the conversion fails, it returns -1.
1500 *
1501 * This function tries to resolve the DNS name if haproxy is in starting mode.
1502 * So, this function may be used during the configuration parsing.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001503 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001504int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001505{
1506 const char *curr = url, *cp = url;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001507 const char *end;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001508 int ret, url_code = 0;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001509 unsigned long long int http_code = 0;
1510 int default_port;
1511 struct hostent *he;
1512 char *p;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001513
1514 /* Firstly, try to find :// pattern */
1515 while (curr < url+ulen && url_code != 0x3a2f2f) {
1516 url_code = ((url_code & 0xffff) << 8);
1517 url_code += (unsigned char)*curr++;
1518 }
1519
1520 /* Secondly, if :// pattern is found, verify parsed stuff
1521 * before pattern is matching our http pattern.
1522 * If so parse ip address and port in uri.
1523 *
1524 * WARNING: Current code doesn't support dynamic async dns resolver.
1525 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001526 if (url_code != 0x3a2f2f)
1527 return -1;
1528
1529 /* Copy scheme, and utrn to lower case. */
1530 while (cp < curr - 3)
1531 http_code = (http_code << 8) + *cp++;
1532 http_code |= 0x2020202020202020ULL; /* Turn everything to lower case */
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001533
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001534 /* HTTP or HTTPS url matching */
1535 if (http_code == 0x2020202068747470ULL) {
1536 default_port = 80;
1537 if (out)
1538 out->scheme = SCH_HTTP;
1539 }
1540 else if (http_code == 0x2020206874747073ULL) {
1541 default_port = 443;
1542 if (out)
1543 out->scheme = SCH_HTTPS;
1544 }
1545 else
1546 return -1;
1547
1548 /* If the next char is '[', the host address is IPv6. */
1549 if (*curr == '[') {
1550 curr++;
1551
1552 /* Check trash size */
1553 if (trash.size < ulen)
1554 return -1;
1555
1556 /* Look for ']' and copy the address in a trash buffer. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001557 p = trash.area;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001558 for (end = curr;
1559 end < url + ulen && *end != ']';
1560 end++, p++)
1561 *p = *end;
1562 if (*end != ']')
1563 return -1;
1564 *p = '\0';
1565
1566 /* Update out. */
1567 if (out) {
1568 out->host = curr;
1569 out->host_len = end - curr;
1570 }
1571
1572 /* Try IPv6 decoding. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001573 if (!inet_pton(AF_INET6, trash.area, &((struct sockaddr_in6 *)addr)->sin6_addr))
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001574 return -1;
1575 end++;
1576
1577 /* Decode port. */
1578 if (*end == ':') {
1579 end++;
1580 default_port = read_uint(&end, url + ulen);
1581 }
1582 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1583 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1584 return end - url;
1585 }
1586 else {
1587 /* We are looking for IP address. If you want to parse and
1588 * resolve hostname found in url, you can use str2sa_range(), but
1589 * be warned this can slow down global daemon performances
1590 * while handling lagging dns responses.
1591 */
1592 ret = url2ipv4(curr, &((struct sockaddr_in *)addr)->sin_addr);
1593 if (ret) {
1594 /* Update out. */
1595 if (out) {
1596 out->host = curr;
1597 out->host_len = ret;
1598 }
1599
1600 curr += ret;
1601
1602 /* Decode port. */
1603 if (*curr == ':') {
1604 curr++;
1605 default_port = read_uint(&curr, url + ulen);
1606 }
1607 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1608
1609 /* Set family. */
1610 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1611 return curr - url;
1612 }
1613 else if (global.mode & MODE_STARTING) {
1614 /* The IPv4 and IPv6 decoding fails, maybe the url contain name. Try to execute
1615 * synchronous DNS request only if HAProxy is in the start state.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001616 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001617
1618 /* look for : or / or end */
1619 for (end = curr;
1620 end < url + ulen && *end != '/' && *end != ':';
1621 end++);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001622 memcpy(trash.area, curr, end - curr);
1623 trash.area[end - curr] = '\0';
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001624
1625 /* try to resolve an IPv4/IPv6 hostname */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001626 he = gethostbyname(trash.area);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001627 if (!he)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001628 return -1;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001629
1630 /* Update out. */
1631 if (out) {
1632 out->host = curr;
1633 out->host_len = end - curr;
1634 }
1635
1636 /* Decode port. */
1637 if (*end == ':') {
1638 end++;
1639 default_port = read_uint(&end, url + ulen);
1640 }
1641
1642 /* Copy IP address, set port and family. */
1643 switch (he->h_addrtype) {
1644 case AF_INET:
1645 ((struct sockaddr_in *)addr)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
1646 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1647 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1648 return end - url;
1649
1650 case AF_INET6:
1651 ((struct sockaddr_in6 *)addr)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
1652 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1653 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1654 return end - url;
1655 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001656 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001657 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001658 return -1;
1659}
1660
Willy Tarreau631f01c2011-09-05 00:36:48 +02001661/* Tries to convert a sockaddr_storage address to text form. Upon success, the
1662 * address family is returned so that it's easy for the caller to adapt to the
1663 * output format. Zero is returned if the address family is not supported. -1
1664 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1665 * supported.
1666 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001667int addr_to_str(const struct sockaddr_storage *addr, char *str, int size)
Willy Tarreau631f01c2011-09-05 00:36:48 +02001668{
1669
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001670 const void *ptr;
Willy Tarreau631f01c2011-09-05 00:36:48 +02001671
1672 if (size < 5)
1673 return 0;
1674 *str = '\0';
1675
1676 switch (addr->ss_family) {
1677 case AF_INET:
1678 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1679 break;
1680 case AF_INET6:
1681 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1682 break;
1683 case AF_UNIX:
1684 memcpy(str, "unix", 5);
1685 return addr->ss_family;
1686 default:
1687 return 0;
1688 }
1689
1690 if (inet_ntop(addr->ss_family, ptr, str, size))
1691 return addr->ss_family;
1692
1693 /* failed */
1694 return -1;
1695}
1696
Simon Horman75ab8bd2014-06-16 09:39:41 +09001697/* Tries to convert a sockaddr_storage port to text form. Upon success, the
1698 * address family is returned so that it's easy for the caller to adapt to the
1699 * output format. Zero is returned if the address family is not supported. -1
1700 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1701 * supported.
1702 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001703int port_to_str(const struct sockaddr_storage *addr, char *str, int size)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001704{
1705
1706 uint16_t port;
1707
1708
Willy Tarreaud7dad1b2017-01-06 16:46:22 +01001709 if (size < 6)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001710 return 0;
1711 *str = '\0';
1712
1713 switch (addr->ss_family) {
1714 case AF_INET:
1715 port = ((struct sockaddr_in *)addr)->sin_port;
1716 break;
1717 case AF_INET6:
1718 port = ((struct sockaddr_in6 *)addr)->sin6_port;
1719 break;
1720 case AF_UNIX:
1721 memcpy(str, "unix", 5);
1722 return addr->ss_family;
1723 default:
1724 return 0;
1725 }
1726
1727 snprintf(str, size, "%u", ntohs(port));
1728 return addr->ss_family;
1729}
1730
Willy Tarreau16e01562016-08-09 16:46:18 +02001731/* check if the given address is local to the system or not. It will return
1732 * -1 when it's not possible to know, 0 when the address is not local, 1 when
1733 * it is. We don't want to iterate over all interfaces for this (and it is not
1734 * portable). So instead we try to bind in UDP to this address on a free non
1735 * privileged port and to connect to the same address, port 0 (connect doesn't
1736 * care). If it succeeds, we own the address. Note that non-inet addresses are
1737 * considered local since they're most likely AF_UNIX.
1738 */
1739int addr_is_local(const struct netns_entry *ns,
1740 const struct sockaddr_storage *orig)
1741{
1742 struct sockaddr_storage addr;
1743 int result;
1744 int fd;
1745
1746 if (!is_inet_addr(orig))
1747 return 1;
1748
1749 memcpy(&addr, orig, sizeof(addr));
1750 set_host_port(&addr, 0);
1751
1752 fd = my_socketat(ns, addr.ss_family, SOCK_DGRAM, IPPROTO_UDP);
1753 if (fd < 0)
1754 return -1;
1755
1756 result = -1;
1757 if (bind(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == 0) {
1758 if (connect(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == -1)
1759 result = 0; // fail, non-local address
1760 else
1761 result = 1; // success, local address
1762 }
1763 else {
1764 if (errno == EADDRNOTAVAIL)
1765 result = 0; // definitely not local :-)
1766 }
1767 close(fd);
1768
1769 return result;
1770}
1771
Willy Tarreaubaaee002006-06-26 02:48:02 +02001772/* will try to encode the string <string> replacing all characters tagged in
1773 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
1774 * prefixed by <escape>, and will store the result between <start> (included)
1775 * and <stop> (excluded), and will always terminate the string with a '\0'
1776 * before <stop>. The position of the '\0' is returned if the conversion
1777 * completes. If bytes are missing between <start> and <stop>, then the
1778 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
1779 * cannot even be stored so we return <start> without writing the 0.
1780 * The input string must also be zero-terminated.
1781 */
1782const char hextab[16] = "0123456789ABCDEF";
1783char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001784 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +02001785 const char *string)
1786{
1787 if (start < stop) {
1788 stop--; /* reserve one byte for the final '\0' */
1789 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001790 if (!ha_bit_test((unsigned char)(*string), map))
Willy Tarreaubaaee002006-06-26 02:48:02 +02001791 *start++ = *string;
1792 else {
1793 if (start + 3 >= stop)
1794 break;
1795 *start++ = escape;
1796 *start++ = hextab[(*string >> 4) & 15];
1797 *start++ = hextab[*string & 15];
1798 }
1799 string++;
1800 }
1801 *start = '\0';
1802 }
1803 return start;
1804}
1805
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001806/*
1807 * Same behavior as encode_string() above, except that it encodes chunk
1808 * <chunk> instead of a string.
1809 */
1810char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001811 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001812 const struct buffer *chunk)
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001813{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001814 char *str = chunk->area;
1815 char *end = chunk->area + chunk->data;
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001816
1817 if (start < stop) {
1818 stop--; /* reserve one byte for the final '\0' */
1819 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001820 if (!ha_bit_test((unsigned char)(*str), map))
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001821 *start++ = *str;
1822 else {
1823 if (start + 3 >= stop)
1824 break;
1825 *start++ = escape;
1826 *start++ = hextab[(*str >> 4) & 15];
1827 *start++ = hextab[*str & 15];
1828 }
1829 str++;
1830 }
1831 *start = '\0';
1832 }
1833 return start;
1834}
1835
Dragan Dosen0edd1092016-02-12 13:23:02 +01001836/*
1837 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001838 * character. The input <string> must be zero-terminated. The result will
1839 * be stored between <start> (included) and <stop> (excluded). This
1840 * function will always try to terminate the resulting string with a '\0'
1841 * before <stop>, and will return its position if the conversion
1842 * completes.
1843 */
1844char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001845 const char escape, const long *map,
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001846 const char *string)
1847{
1848 if (start < stop) {
1849 stop--; /* reserve one byte for the final '\0' */
1850 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001851 if (!ha_bit_test((unsigned char)(*string), map))
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001852 *start++ = *string;
1853 else {
1854 if (start + 2 >= stop)
1855 break;
1856 *start++ = escape;
1857 *start++ = *string;
1858 }
1859 string++;
1860 }
1861 *start = '\0';
1862 }
1863 return start;
1864}
1865
1866/*
1867 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +01001868 * character. <chunk> contains the input to be escaped. The result will be
1869 * stored between <start> (included) and <stop> (excluded). The function
1870 * will always try to terminate the resulting string with a '\0' before
1871 * <stop>, and will return its position if the conversion completes.
1872 */
1873char *escape_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001874 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001875 const struct buffer *chunk)
Dragan Dosen0edd1092016-02-12 13:23:02 +01001876{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001877 char *str = chunk->area;
1878 char *end = chunk->area + chunk->data;
Dragan Dosen0edd1092016-02-12 13:23:02 +01001879
1880 if (start < stop) {
1881 stop--; /* reserve one byte for the final '\0' */
1882 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001883 if (!ha_bit_test((unsigned char)(*str), map))
Dragan Dosen0edd1092016-02-12 13:23:02 +01001884 *start++ = *str;
1885 else {
1886 if (start + 2 >= stop)
1887 break;
1888 *start++ = escape;
1889 *start++ = *str;
1890 }
1891 str++;
1892 }
1893 *start = '\0';
1894 }
1895 return start;
1896}
1897
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001898/* Check a string for using it in a CSV output format. If the string contains
1899 * one of the following four char <">, <,>, CR or LF, the string is
1900 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
1901 * <str> is the input string to be escaped. The function assumes that
1902 * the input string is null-terminated.
1903 *
1904 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +01001905 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001906 * format.
1907 *
Willy Tarreau898529b2016-01-06 18:07:04 +01001908 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001909 *
Willy Tarreaub631c292016-01-08 10:04:08 +01001910 * If <quote> is 1, the converter puts the quotes only if any reserved character
1911 * is present. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001912 *
Willy Tarreau83061a82018-07-13 11:56:34 +02001913 * <output> is a struct buffer used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001914 *
Willy Tarreau898529b2016-01-06 18:07:04 +01001915 * The function returns the converted string on its output. If an error
1916 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001917 * for using the function directly as printf() argument.
1918 *
1919 * If the output buffer is too short to contain the input string, the result
1920 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +01001921 *
Willy Tarreaub631c292016-01-08 10:04:08 +01001922 * This function appends the encoding to the existing output chunk, and it
1923 * guarantees that it starts immediately at the first available character of
1924 * the chunk. Please use csv_enc() instead if you want to replace the output
1925 * chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001926 */
Willy Tarreau83061a82018-07-13 11:56:34 +02001927const char *csv_enc_append(const char *str, int quote, struct buffer *output)
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001928{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001929 char *end = output->area + output->size;
1930 char *out = output->area + output->data;
Willy Tarreau898529b2016-01-06 18:07:04 +01001931 char *ptr = out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001932
Willy Tarreaub631c292016-01-08 10:04:08 +01001933 if (quote == 1) {
1934 /* automatic quoting: first verify if we'll have to quote the string */
1935 if (!strpbrk(str, "\n\r,\""))
1936 quote = 0;
1937 }
1938
1939 if (quote)
1940 *ptr++ = '"';
1941
Willy Tarreau898529b2016-01-06 18:07:04 +01001942 while (*str && ptr < end - 2) { /* -2 for reserving space for <"> and \0. */
1943 *ptr = *str;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001944 if (*str == '"') {
Willy Tarreau898529b2016-01-06 18:07:04 +01001945 ptr++;
1946 if (ptr >= end - 2) {
1947 ptr--;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001948 break;
1949 }
Willy Tarreau898529b2016-01-06 18:07:04 +01001950 *ptr = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001951 }
Willy Tarreau898529b2016-01-06 18:07:04 +01001952 ptr++;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001953 str++;
1954 }
1955
Willy Tarreaub631c292016-01-08 10:04:08 +01001956 if (quote)
1957 *ptr++ = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001958
Willy Tarreau898529b2016-01-06 18:07:04 +01001959 *ptr = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001960 output->data = ptr - output->area;
Willy Tarreau898529b2016-01-06 18:07:04 +01001961 return out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001962}
1963
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001964/* Decode an URL-encoded string in-place. The resulting string might
1965 * be shorter. If some forbidden characters are found, the conversion is
Thierry FOURNIER5068d962013-10-04 16:27:27 +02001966 * aborted, the string is truncated before the issue and a negative value is
1967 * returned, otherwise the operation returns the length of the decoded string.
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001968 * If the 'in_form' argument is non-nul the string is assumed to be part of
1969 * an "application/x-www-form-urlencoded" encoded string, and the '+' will be
1970 * turned to a space. If it's zero, this will only be done after a question
1971 * mark ('?').
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001972 */
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001973int url_decode(char *string, int in_form)
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001974{
1975 char *in, *out;
Thierry FOURNIER5068d962013-10-04 16:27:27 +02001976 int ret = -1;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001977
1978 in = string;
1979 out = string;
1980 while (*in) {
1981 switch (*in) {
1982 case '+' :
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001983 *out++ = in_form ? ' ' : *in;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001984 break;
1985 case '%' :
1986 if (!ishex(in[1]) || !ishex(in[2]))
1987 goto end;
1988 *out++ = (hex2i(in[1]) << 4) + hex2i(in[2]);
1989 in += 2;
1990 break;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001991 case '?':
1992 in_form = 1;
1993 /* fall through */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02001994 default:
1995 *out++ = *in;
1996 break;
1997 }
1998 in++;
1999 }
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002000 ret = out - string; /* success */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002001 end:
2002 *out = 0;
2003 return ret;
2004}
Willy Tarreaubaaee002006-06-26 02:48:02 +02002005
Willy Tarreau6911fa42007-03-04 18:06:08 +01002006unsigned int str2ui(const char *s)
2007{
2008 return __str2ui(s);
2009}
2010
2011unsigned int str2uic(const char *s)
2012{
2013 return __str2uic(s);
2014}
2015
2016unsigned int strl2ui(const char *s, int len)
2017{
2018 return __strl2ui(s, len);
2019}
2020
2021unsigned int strl2uic(const char *s, int len)
2022{
2023 return __strl2uic(s, len);
2024}
2025
Willy Tarreau4ec83cd2010-10-15 23:19:55 +02002026unsigned int read_uint(const char **s, const char *end)
2027{
2028 return __read_uint(s, end);
2029}
2030
Thierry FOURNIER763a5d82015-07-06 23:09:52 +02002031/* This function reads an unsigned integer from the string pointed to by <s> and
2032 * returns it. The <s> pointer is adjusted to point to the first unread char. The
2033 * function automatically stops at <end>. If the number overflows, the 2^64-1
2034 * value is returned.
2035 */
2036unsigned long long int read_uint64(const char **s, const char *end)
2037{
2038 const char *ptr = *s;
2039 unsigned long long int i = 0, tmp;
2040 unsigned int j;
2041
2042 while (ptr < end) {
2043
2044 /* read next char */
2045 j = *ptr - '0';
2046 if (j > 9)
2047 goto read_uint64_end;
2048
2049 /* add char to the number and check overflow. */
2050 tmp = i * 10;
2051 if (tmp / 10 != i) {
2052 i = ULLONG_MAX;
2053 goto read_uint64_eat;
2054 }
2055 if (ULLONG_MAX - tmp < j) {
2056 i = ULLONG_MAX;
2057 goto read_uint64_eat;
2058 }
2059 i = tmp + j;
2060 ptr++;
2061 }
2062read_uint64_eat:
2063 /* eat each numeric char */
2064 while (ptr < end) {
2065 if ((unsigned int)(*ptr - '0') > 9)
2066 break;
2067 ptr++;
2068 }
2069read_uint64_end:
2070 *s = ptr;
2071 return i;
2072}
2073
2074/* This function reads an integer from the string pointed to by <s> and returns
2075 * it. The <s> pointer is adjusted to point to the first unread char. The function
2076 * automatically stops at <end>. Il the number is bigger than 2^63-2, the 2^63-1
2077 * value is returned. If the number is lowest than -2^63-1, the -2^63 value is
2078 * returned.
2079 */
2080long long int read_int64(const char **s, const char *end)
2081{
2082 unsigned long long int i = 0;
2083 int neg = 0;
2084
2085 /* Look for minus char. */
2086 if (**s == '-') {
2087 neg = 1;
2088 (*s)++;
2089 }
2090 else if (**s == '+')
2091 (*s)++;
2092
2093 /* convert as positive number. */
2094 i = read_uint64(s, end);
2095
2096 if (neg) {
2097 if (i > 0x8000000000000000ULL)
2098 return LLONG_MIN;
2099 return -i;
2100 }
2101 if (i > 0x7fffffffffffffffULL)
2102 return LLONG_MAX;
2103 return i;
2104}
2105
Willy Tarreau6911fa42007-03-04 18:06:08 +01002106/* This one is 7 times faster than strtol() on athlon with checks.
2107 * It returns the value of the number composed of all valid digits read,
2108 * and can process negative numbers too.
2109 */
2110int strl2ic(const char *s, int len)
2111{
2112 int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002113 int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002114
2115 if (len > 0) {
2116 if (*s != '-') {
2117 /* positive number */
2118 while (len-- > 0) {
2119 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002120 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002121 if (j > 9)
2122 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002123 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002124 }
2125 } else {
2126 /* negative number */
2127 s++;
2128 while (--len > 0) {
2129 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002130 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002131 if (j > 9)
2132 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002133 i = k - j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002134 }
2135 }
2136 }
2137 return i;
2138}
2139
2140
2141/* This function reads exactly <len> chars from <s> and converts them to a
2142 * signed integer which it stores into <ret>. It accurately detects any error
2143 * (truncated string, invalid chars, overflows). It is meant to be used in
2144 * applications designed for hostile environments. It returns zero when the
2145 * number has successfully been converted, non-zero otherwise. When an error
2146 * is returned, the <ret> value is left untouched. It is yet 5 to 40 times
2147 * faster than strtol().
2148 */
2149int strl2irc(const char *s, int len, int *ret)
2150{
2151 int i = 0;
2152 int j;
2153
2154 if (!len)
2155 return 1;
2156
2157 if (*s != '-') {
2158 /* positive number */
2159 while (len-- > 0) {
2160 j = (*s++) - '0';
2161 if (j > 9) return 1; /* invalid char */
2162 if (i > INT_MAX / 10) return 1; /* check for multiply overflow */
2163 i = i * 10;
2164 if (i + j < i) return 1; /* check for addition overflow */
2165 i = i + j;
2166 }
2167 } else {
2168 /* negative number */
2169 s++;
2170 while (--len > 0) {
2171 j = (*s++) - '0';
2172 if (j > 9) return 1; /* invalid char */
2173 if (i < INT_MIN / 10) return 1; /* check for multiply overflow */
2174 i = i * 10;
2175 if (i - j > i) return 1; /* check for subtract overflow */
2176 i = i - j;
2177 }
2178 }
2179 *ret = i;
2180 return 0;
2181}
2182
2183
2184/* This function reads exactly <len> chars from <s> and converts them to a
2185 * signed integer which it stores into <ret>. It accurately detects any error
2186 * (truncated string, invalid chars, overflows). It is meant to be used in
2187 * applications designed for hostile environments. It returns zero when the
2188 * number has successfully been converted, non-zero otherwise. When an error
2189 * is returned, the <ret> value is left untouched. It is about 3 times slower
William Dauchy060ffc82021-02-06 20:47:51 +01002190 * than strl2irc().
Willy Tarreau6911fa42007-03-04 18:06:08 +01002191 */
Willy Tarreau6911fa42007-03-04 18:06:08 +01002192
2193int strl2llrc(const char *s, int len, long long *ret)
2194{
2195 long long i = 0;
2196 int j;
2197
2198 if (!len)
2199 return 1;
2200
2201 if (*s != '-') {
2202 /* positive number */
2203 while (len-- > 0) {
2204 j = (*s++) - '0';
2205 if (j > 9) return 1; /* invalid char */
2206 if (i > LLONG_MAX / 10LL) return 1; /* check for multiply overflow */
2207 i = i * 10LL;
2208 if (i + j < i) return 1; /* check for addition overflow */
2209 i = i + j;
2210 }
2211 } else {
2212 /* negative number */
2213 s++;
2214 while (--len > 0) {
2215 j = (*s++) - '0';
2216 if (j > 9) return 1; /* invalid char */
2217 if (i < LLONG_MIN / 10LL) return 1; /* check for multiply overflow */
2218 i = i * 10LL;
2219 if (i - j > i) return 1; /* check for subtract overflow */
2220 i = i - j;
2221 }
2222 }
2223 *ret = i;
2224 return 0;
2225}
2226
Thierry FOURNIER511e9472014-01-23 17:40:34 +01002227/* This function is used with pat_parse_dotted_ver(). It converts a string
2228 * composed by two number separated by a dot. Each part must contain in 16 bits
2229 * because internally they will be represented as a 32-bit quantity stored in
2230 * a 64-bit integer. It returns zero when the number has successfully been
2231 * converted, non-zero otherwise. When an error is returned, the <ret> value
2232 * is left untouched.
2233 *
2234 * "1.3" -> 0x0000000000010003
2235 * "65535.65535" -> 0x00000000ffffffff
2236 */
2237int strl2llrc_dotted(const char *text, int len, long long *ret)
2238{
2239 const char *end = &text[len];
2240 const char *p;
2241 long long major, minor;
2242
2243 /* Look for dot. */
2244 for (p = text; p < end; p++)
2245 if (*p == '.')
2246 break;
2247
2248 /* Convert major. */
2249 if (strl2llrc(text, p - text, &major) != 0)
2250 return 1;
2251
2252 /* Check major. */
2253 if (major >= 65536)
2254 return 1;
2255
2256 /* Convert minor. */
2257 minor = 0;
2258 if (p < end)
2259 if (strl2llrc(p + 1, end - (p + 1), &minor) != 0)
2260 return 1;
2261
2262 /* Check minor. */
2263 if (minor >= 65536)
2264 return 1;
2265
2266 /* Compose value. */
2267 *ret = (major << 16) | (minor & 0xffff);
2268 return 0;
2269}
2270
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002271/* This function parses a time value optionally followed by a unit suffix among
2272 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
2273 * expected by the caller. The computation does its best to avoid overflows.
2274 * The value is returned in <ret> if everything is fine, and a NULL is returned
2275 * by the function. In case of error, a pointer to the error is returned and
2276 * <ret> is left untouched. Values are automatically rounded up when needed.
Willy Tarreau9faebe32019-06-07 19:00:37 +02002277 * Values resulting in values larger than or equal to 2^31 after conversion are
2278 * reported as an overflow as value PARSE_TIME_OVER. Non-null values resulting
2279 * in an underflow are reported as an underflow as value PARSE_TIME_UNDER.
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002280 */
2281const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags)
2282{
Willy Tarreau9faebe32019-06-07 19:00:37 +02002283 unsigned long long imult, idiv;
2284 unsigned long long omult, odiv;
2285 unsigned long long value, result;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002286 const char *str = text;
2287
2288 if (!isdigit((unsigned char)*text))
2289 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002290
2291 omult = odiv = 1;
2292
2293 switch (unit_flags & TIME_UNIT_MASK) {
2294 case TIME_UNIT_US: omult = 1000000; break;
2295 case TIME_UNIT_MS: omult = 1000; break;
2296 case TIME_UNIT_S: break;
2297 case TIME_UNIT_MIN: odiv = 60; break;
2298 case TIME_UNIT_HOUR: odiv = 3600; break;
2299 case TIME_UNIT_DAY: odiv = 86400; break;
2300 default: break;
2301 }
2302
2303 value = 0;
2304
2305 while (1) {
2306 unsigned int j;
2307
2308 j = *text - '0';
2309 if (j > 9)
2310 break;
2311 text++;
2312 value *= 10;
2313 value += j;
2314 }
2315
2316 imult = idiv = 1;
2317 switch (*text) {
2318 case '\0': /* no unit = default unit */
2319 imult = omult = idiv = odiv = 1;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002320 goto end;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002321 case 's': /* second = unscaled unit */
2322 break;
2323 case 'u': /* microsecond : "us" */
2324 if (text[1] == 's') {
2325 idiv = 1000000;
2326 text++;
2327 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002328 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002329 case 'm': /* millisecond : "ms" or minute: "m" */
2330 if (text[1] == 's') {
2331 idiv = 1000;
2332 text++;
2333 } else
2334 imult = 60;
2335 break;
2336 case 'h': /* hour : "h" */
2337 imult = 3600;
2338 break;
2339 case 'd': /* day : "d" */
2340 imult = 86400;
2341 break;
2342 default:
2343 return text;
2344 break;
2345 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002346 if (*(++text) != '\0') {
2347 ha_warning("unexpected character '%c' after the timer value '%s', only "
2348 "(us=microseconds,ms=milliseconds,s=seconds,m=minutes,h=hours,d=days) are supported."
2349 " This will be reported as an error in next versions.\n", *text, str);
2350 }
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002351
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002352 end:
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002353 if (omult % idiv == 0) { omult /= idiv; idiv = 1; }
2354 if (idiv % omult == 0) { idiv /= omult; omult = 1; }
2355 if (imult % odiv == 0) { imult /= odiv; odiv = 1; }
2356 if (odiv % imult == 0) { odiv /= imult; imult = 1; }
2357
Willy Tarreau9faebe32019-06-07 19:00:37 +02002358 result = (value * (imult * omult) + (idiv * odiv - 1)) / (idiv * odiv);
2359 if (result >= 0x80000000)
2360 return PARSE_TIME_OVER;
2361 if (!result && value)
2362 return PARSE_TIME_UNDER;
2363 *ret = result;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002364 return NULL;
2365}
Willy Tarreau6911fa42007-03-04 18:06:08 +01002366
Emeric Brun39132b22010-01-04 14:57:24 +01002367/* this function converts the string starting at <text> to an unsigned int
2368 * stored in <ret>. If an error is detected, the pointer to the unexpected
Joseph Herlant32b83272018-11-15 11:58:28 -08002369 * character is returned. If the conversion is successful, NULL is returned.
Emeric Brun39132b22010-01-04 14:57:24 +01002370 */
2371const char *parse_size_err(const char *text, unsigned *ret) {
2372 unsigned value = 0;
2373
Christopher Faulet82635a02020-12-11 09:30:45 +01002374 if (!isdigit((unsigned char)*text))
2375 return text;
2376
Emeric Brun39132b22010-01-04 14:57:24 +01002377 while (1) {
2378 unsigned int j;
2379
2380 j = *text - '0';
2381 if (j > 9)
2382 break;
2383 if (value > ~0U / 10)
2384 return text;
2385 value *= 10;
2386 if (value > (value + j))
2387 return text;
2388 value += j;
2389 text++;
2390 }
2391
2392 switch (*text) {
2393 case '\0':
2394 break;
2395 case 'K':
2396 case 'k':
2397 if (value > ~0U >> 10)
2398 return text;
2399 value = value << 10;
2400 break;
2401 case 'M':
2402 case 'm':
2403 if (value > ~0U >> 20)
2404 return text;
2405 value = value << 20;
2406 break;
2407 case 'G':
2408 case 'g':
2409 if (value > ~0U >> 30)
2410 return text;
2411 value = value << 30;
2412 break;
2413 default:
2414 return text;
2415 }
2416
Godbach58048a22015-01-28 17:36:16 +08002417 if (*text != '\0' && *++text != '\0')
2418 return text;
2419
Emeric Brun39132b22010-01-04 14:57:24 +01002420 *ret = value;
2421 return NULL;
2422}
2423
Willy Tarreau126d4062013-12-03 17:50:47 +01002424/*
2425 * Parse binary string written in hexadecimal (source) and store the decoded
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002426 * result into binstr and set binstrlen to the length of binstr. Memory for
Willy Tarreau126d4062013-12-03 17:50:47 +01002427 * binstr is allocated by the function. In case of error, returns 0 with an
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002428 * error message in err. In success case, it returns the consumed length.
Willy Tarreau126d4062013-12-03 17:50:47 +01002429 */
2430int parse_binary(const char *source, char **binstr, int *binstrlen, char **err)
2431{
2432 int len;
2433 const char *p = source;
2434 int i,j;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002435 int alloc;
Willy Tarreau126d4062013-12-03 17:50:47 +01002436
2437 len = strlen(source);
2438 if (len % 2) {
2439 memprintf(err, "an even number of hex digit is expected");
2440 return 0;
2441 }
2442
2443 len = len >> 1;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002444
Willy Tarreau126d4062013-12-03 17:50:47 +01002445 if (!*binstr) {
Tim Duesterhuse52b6e52020-09-12 20:26:43 +02002446 *binstr = calloc(len, sizeof(**binstr));
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002447 if (!*binstr) {
2448 memprintf(err, "out of memory while loading string pattern");
2449 return 0;
2450 }
2451 alloc = 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002452 }
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002453 else {
2454 if (*binstrlen < len) {
Joseph Herlant76dbe782018-11-15 12:01:22 -08002455 memprintf(err, "no space available in the buffer. expect %d, provides %d",
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002456 len, *binstrlen);
2457 return 0;
2458 }
2459 alloc = 0;
2460 }
2461 *binstrlen = len;
Willy Tarreau126d4062013-12-03 17:50:47 +01002462
2463 i = j = 0;
2464 while (j < len) {
2465 if (!ishex(p[i++]))
2466 goto bad_input;
2467 if (!ishex(p[i++]))
2468 goto bad_input;
2469 (*binstr)[j++] = (hex2i(p[i-2]) << 4) + hex2i(p[i-1]);
2470 }
Thierry FOURNIERee330af2014-01-21 11:36:14 +01002471 return len << 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002472
2473bad_input:
2474 memprintf(err, "an hex digit is expected (found '%c')", p[i-1]);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002475 if (alloc)
2476 ha_free(binstr);
Willy Tarreau126d4062013-12-03 17:50:47 +01002477 return 0;
2478}
2479
Willy Tarreau946ba592009-05-10 15:41:18 +02002480/* copies at most <n> characters from <src> and always terminates with '\0' */
2481char *my_strndup(const char *src, int n)
2482{
2483 int len = 0;
2484 char *ret;
2485
2486 while (len < n && src[len])
2487 len++;
2488
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02002489 ret = malloc(len + 1);
Willy Tarreau946ba592009-05-10 15:41:18 +02002490 if (!ret)
2491 return ret;
2492 memcpy(ret, src, len);
2493 ret[len] = '\0';
2494 return ret;
2495}
2496
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +02002497/*
2498 * search needle in haystack
2499 * returns the pointer if found, returns NULL otherwise
2500 */
2501const void *my_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen)
2502{
2503 const void *c = NULL;
2504 unsigned char f;
2505
2506 if ((haystack == NULL) || (needle == NULL) || (haystacklen < needlelen))
2507 return NULL;
2508
2509 f = *(char *)needle;
2510 c = haystack;
2511 while ((c = memchr(c, f, haystacklen - (c - haystack))) != NULL) {
2512 if ((haystacklen - (c - haystack)) < needlelen)
2513 return NULL;
2514
2515 if (memcmp(c, needle, needlelen) == 0)
2516 return c;
2517 ++c;
2518 }
2519 return NULL;
2520}
2521
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002522/* get length of the initial segment consisting entirely of bytes in <accept> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002523size_t my_memspn(const void *str, size_t len, const void *accept, size_t acceptlen)
2524{
2525 size_t ret = 0;
2526
2527 while (ret < len && memchr(accept, *((int *)str), acceptlen)) {
2528 str++;
2529 ret++;
2530 }
2531 return ret;
2532}
2533
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002534/* get length of the initial segment consisting entirely of bytes not in <rejcet> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002535size_t my_memcspn(const void *str, size_t len, const void *reject, size_t rejectlen)
2536{
2537 size_t ret = 0;
2538
2539 while (ret < len) {
2540 if(memchr(reject, *((int *)str), rejectlen))
2541 return ret;
2542 str++;
2543 ret++;
2544 }
2545 return ret;
2546}
2547
Willy Tarreau482b00d2009-10-04 22:48:42 +02002548/* This function returns the first unused key greater than or equal to <key> in
2549 * ID tree <root>. Zero is returned if no place is found.
2550 */
2551unsigned int get_next_id(struct eb_root *root, unsigned int key)
2552{
2553 struct eb32_node *used;
2554
2555 do {
2556 used = eb32_lookup_ge(root, key);
2557 if (!used || used->key > key)
2558 return key; /* key is available */
2559 key++;
2560 } while (key);
2561 return key;
2562}
2563
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002564/* dump the full tree to <file> in DOT format for debugging purposes. Will
2565 * optionally highlight node <subj> if found, depending on operation <op> :
2566 * 0 : nothing
2567 * >0 : insertion, node/leaf are surrounded in red
2568 * <0 : removal, node/leaf are dashed with no background
2569 * Will optionally add "desc" as a label on the graph if set and non-null.
2570 */
2571void 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 +01002572{
2573 struct eb32sc_node *node;
2574 unsigned long scope = -1;
2575
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002576 fprintf(file, "digraph ebtree {\n");
2577
2578 if (desc && *desc) {
2579 fprintf(file,
2580 " fontname=\"fixed\";\n"
2581 " fontsize=8;\n"
2582 " label=\"%s\";\n", desc);
2583 }
2584
Willy Tarreaued3cda02017-11-15 15:04:05 +01002585 fprintf(file,
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002586 " node [fontname=\"fixed\" fontsize=8 shape=\"box\" style=\"filled\" color=\"black\" fillcolor=\"white\"];\n"
2587 " edge [fontname=\"fixed\" fontsize=8 style=\"solid\" color=\"magenta\" dir=\"forward\"];\n"
Willy Tarreaued3cda02017-11-15 15:04:05 +01002588 " \"%lx_n\" [label=\"root\\n%lx\"]\n", (long)eb_root_to_node(root), (long)root
2589 );
2590
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002591 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002592 (long)eb_root_to_node(root),
2593 (long)eb_root_to_node(eb_clrtag(root->b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002594 eb_gettag(root->b[0]) == EB_LEAF ? 'l' : 'n');
2595
2596 node = eb32sc_first(root, scope);
2597 while (node) {
2598 if (node->node.node_p) {
2599 /* node part is used */
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002600 fprintf(file, " \"%lx_n\" [label=\"%lx\\nkey=%u\\nscope=%lx\\nbit=%d\" fillcolor=\"lightskyblue1\" %s];\n",
2601 (long)node, (long)node, node->key, node->node_s, node->node.bit,
2602 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002603
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002604 fprintf(file, " \"%lx_n\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002605 (long)node,
2606 (long)eb_root_to_node(eb_clrtag(node->node.node_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002607 eb_gettag(node->node.node_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002608
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002609 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002610 (long)node,
2611 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002612 eb_gettag(node->node.branches.b[0]) == EB_LEAF ? 'l' : 'n');
2613
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002614 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"R\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002615 (long)node,
2616 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[1])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002617 eb_gettag(node->node.branches.b[1]) == EB_LEAF ? 'l' : 'n');
2618 }
2619
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002620 fprintf(file, " \"%lx_l\" [label=\"%lx\\nkey=%u\\nscope=%lx\\npfx=%u\" fillcolor=\"yellow\" %s];\n",
2621 (long)node, (long)node, node->key, node->leaf_s, node->node.pfx,
2622 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002623
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002624 fprintf(file, " \"%lx_l\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002625 (long)node,
2626 (long)eb_root_to_node(eb_clrtag(node->node.leaf_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002627 eb_gettag(node->node.leaf_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002628 node = eb32sc_next(node, scope);
2629 }
2630 fprintf(file, "}\n");
2631}
2632
Willy Tarreau348238b2010-01-18 15:05:57 +01002633/* This function compares a sample word possibly followed by blanks to another
2634 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
2635 * otherwise zero. This intends to be used when checking HTTP headers for some
2636 * values. Note that it validates a word followed only by blanks but does not
2637 * validate a word followed by blanks then other chars.
2638 */
2639int word_match(const char *sample, int slen, const char *word, int wlen)
2640{
2641 if (slen < wlen)
2642 return 0;
2643
2644 while (wlen) {
2645 char c = *sample ^ *word;
2646 if (c && c != ('A' ^ 'a'))
2647 return 0;
2648 sample++;
2649 word++;
2650 slen--;
2651 wlen--;
2652 }
2653
2654 while (slen) {
2655 if (*sample != ' ' && *sample != '\t')
2656 return 0;
2657 sample++;
2658 slen--;
2659 }
2660 return 1;
2661}
Willy Tarreau482b00d2009-10-04 22:48:42 +02002662
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002663/* Converts any text-formatted IPv4 address to a host-order IPv4 address. It
2664 * is particularly fast because it avoids expensive operations such as
2665 * multiplies, which are optimized away at the end. It requires a properly
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002666 * formatted address though (3 points).
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002667 */
2668unsigned int inetaddr_host(const char *text)
2669{
2670 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2671 register unsigned int dig100, dig10, dig1;
2672 int s;
2673 const char *p, *d;
2674
2675 dig1 = dig10 = dig100 = ascii_zero;
2676 s = 24;
2677
2678 p = text;
2679 while (1) {
2680 if (((unsigned)(*p - '0')) <= 9) {
2681 p++;
2682 continue;
2683 }
2684
2685 /* here, we have a complete byte between <text> and <p> (exclusive) */
2686 if (p == text)
2687 goto end;
2688
2689 d = p - 1;
2690 dig1 |= (unsigned int)(*d << s);
2691 if (d == text)
2692 goto end;
2693
2694 d--;
2695 dig10 |= (unsigned int)(*d << s);
2696 if (d == text)
2697 goto end;
2698
2699 d--;
2700 dig100 |= (unsigned int)(*d << s);
2701 end:
2702 if (!s || *p != '.')
2703 break;
2704
2705 s -= 8;
2706 text = ++p;
2707 }
2708
2709 dig100 -= ascii_zero;
2710 dig10 -= ascii_zero;
2711 dig1 -= ascii_zero;
2712 return ((dig100 * 10) + dig10) * 10 + dig1;
2713}
2714
2715/*
2716 * Idem except the first unparsed character has to be passed in <stop>.
2717 */
2718unsigned int inetaddr_host_lim(const char *text, const char *stop)
2719{
2720 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2721 register unsigned int dig100, dig10, dig1;
2722 int s;
2723 const char *p, *d;
2724
2725 dig1 = dig10 = dig100 = ascii_zero;
2726 s = 24;
2727
2728 p = text;
2729 while (1) {
2730 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2731 p++;
2732 continue;
2733 }
2734
2735 /* here, we have a complete byte between <text> and <p> (exclusive) */
2736 if (p == text)
2737 goto end;
2738
2739 d = p - 1;
2740 dig1 |= (unsigned int)(*d << s);
2741 if (d == text)
2742 goto end;
2743
2744 d--;
2745 dig10 |= (unsigned int)(*d << s);
2746 if (d == text)
2747 goto end;
2748
2749 d--;
2750 dig100 |= (unsigned int)(*d << s);
2751 end:
2752 if (!s || p == stop || *p != '.')
2753 break;
2754
2755 s -= 8;
2756 text = ++p;
2757 }
2758
2759 dig100 -= ascii_zero;
2760 dig10 -= ascii_zero;
2761 dig1 -= ascii_zero;
2762 return ((dig100 * 10) + dig10) * 10 + dig1;
2763}
2764
2765/*
2766 * Idem except the pointer to first unparsed byte is returned into <ret> which
2767 * must not be NULL.
2768 */
Willy Tarreau74172752010-10-15 23:21:42 +02002769unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret)
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002770{
2771 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2772 register unsigned int dig100, dig10, dig1;
2773 int s;
Willy Tarreau74172752010-10-15 23:21:42 +02002774 char *p, *d;
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002775
2776 dig1 = dig10 = dig100 = ascii_zero;
2777 s = 24;
2778
2779 p = text;
2780 while (1) {
2781 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2782 p++;
2783 continue;
2784 }
2785
2786 /* here, we have a complete byte between <text> and <p> (exclusive) */
2787 if (p == text)
2788 goto end;
2789
2790 d = p - 1;
2791 dig1 |= (unsigned int)(*d << s);
2792 if (d == text)
2793 goto end;
2794
2795 d--;
2796 dig10 |= (unsigned int)(*d << s);
2797 if (d == text)
2798 goto end;
2799
2800 d--;
2801 dig100 |= (unsigned int)(*d << s);
2802 end:
2803 if (!s || p == stop || *p != '.')
2804 break;
2805
2806 s -= 8;
2807 text = ++p;
2808 }
2809
2810 *ret = p;
2811 dig100 -= ascii_zero;
2812 dig10 -= ascii_zero;
2813 dig1 -= ascii_zero;
2814 return ((dig100 * 10) + dig10) * 10 + dig1;
2815}
2816
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002817/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
2818 * or the number of chars read in case of success. Maybe this could be replaced
2819 * by one of the functions above. Also, apparently this function does not support
2820 * hosts above 255 and requires exactly 4 octets.
Willy Tarreau075415a2013-12-12 11:29:39 +01002821 * The destination is only modified on success.
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002822 */
2823int buf2ip(const char *buf, size_t len, struct in_addr *dst)
2824{
2825 const char *addr;
2826 int saw_digit, octets, ch;
2827 u_char tmp[4], *tp;
2828 const char *cp = buf;
2829
2830 saw_digit = 0;
2831 octets = 0;
2832 *(tp = tmp) = 0;
2833
2834 for (addr = buf; addr - buf < len; addr++) {
2835 unsigned char digit = (ch = *addr) - '0';
2836
2837 if (digit > 9 && ch != '.')
2838 break;
2839
2840 if (digit <= 9) {
2841 u_int new = *tp * 10 + digit;
2842
2843 if (new > 255)
2844 return 0;
2845
2846 *tp = new;
2847
2848 if (!saw_digit) {
2849 if (++octets > 4)
2850 return 0;
2851 saw_digit = 1;
2852 }
2853 } else if (ch == '.' && saw_digit) {
2854 if (octets == 4)
2855 return 0;
2856
2857 *++tp = 0;
2858 saw_digit = 0;
2859 } else
2860 return 0;
2861 }
2862
2863 if (octets < 4)
2864 return 0;
2865
2866 memcpy(&dst->s_addr, tmp, 4);
2867 return addr - cp;
2868}
2869
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002870/* This function converts the string in <buf> of the len <len> to
2871 * struct in6_addr <dst> which must be allocated by the caller.
2872 * This function returns 1 in success case, otherwise zero.
Willy Tarreau075415a2013-12-12 11:29:39 +01002873 * The destination is only modified on success.
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002874 */
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002875int buf2ip6(const char *buf, size_t len, struct in6_addr *dst)
2876{
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002877 char null_term_ip6[INET6_ADDRSTRLEN + 1];
Willy Tarreau075415a2013-12-12 11:29:39 +01002878 struct in6_addr out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002879
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002880 if (len > INET6_ADDRSTRLEN)
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002881 return 0;
2882
2883 memcpy(null_term_ip6, buf, len);
2884 null_term_ip6[len] = '\0';
2885
Willy Tarreau075415a2013-12-12 11:29:39 +01002886 if (!inet_pton(AF_INET6, null_term_ip6, &out))
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002887 return 0;
2888
Willy Tarreau075415a2013-12-12 11:29:39 +01002889 *dst = out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002890 return 1;
2891}
2892
Willy Tarreauacf95772010-06-14 19:09:21 +02002893/* To be used to quote config arg positions. Returns the short string at <ptr>
2894 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
2895 * if ptr is NULL or empty. The string is locally allocated.
2896 */
2897const char *quote_arg(const char *ptr)
2898{
Christopher Faulet1bc04c72017-10-29 20:14:08 +01002899 static THREAD_LOCAL char val[32];
Willy Tarreauacf95772010-06-14 19:09:21 +02002900 int i;
2901
2902 if (!ptr || !*ptr)
2903 return "end of line";
2904 val[0] = '\'';
Willy Tarreaude2dd6b2013-01-24 02:14:42 +01002905 for (i = 1; i < sizeof(val) - 2 && *ptr; i++)
Willy Tarreauacf95772010-06-14 19:09:21 +02002906 val[i] = *ptr++;
2907 val[i++] = '\'';
2908 val[i] = '\0';
2909 return val;
2910}
2911
Willy Tarreau5b180202010-07-18 10:40:48 +02002912/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
2913int get_std_op(const char *str)
2914{
2915 int ret = -1;
2916
2917 if (*str == 'e' && str[1] == 'q')
2918 ret = STD_OP_EQ;
2919 else if (*str == 'n' && str[1] == 'e')
2920 ret = STD_OP_NE;
2921 else if (*str == 'l') {
2922 if (str[1] == 'e') ret = STD_OP_LE;
2923 else if (str[1] == 't') ret = STD_OP_LT;
2924 }
2925 else if (*str == 'g') {
2926 if (str[1] == 'e') ret = STD_OP_GE;
2927 else if (str[1] == 't') ret = STD_OP_GT;
2928 }
2929
2930 if (ret == -1 || str[2] != '\0')
2931 return -1;
2932 return ret;
2933}
2934
Willy Tarreau4c14eaa2010-11-24 14:01:45 +01002935/* hash a 32-bit integer to another 32-bit integer */
2936unsigned int full_hash(unsigned int a)
2937{
2938 return __full_hash(a);
2939}
2940
Willy Tarreauf3241112019-02-26 09:56:22 +01002941/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
2942 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
2943 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
2944 * a popcount variant and is described here :
2945 * https://graphics.stanford.edu/~seander/bithacks.html
2946 */
2947unsigned int mask_find_rank_bit(unsigned int r, unsigned long m)
2948{
2949 unsigned long a, b, c, d;
2950 unsigned int s;
2951 unsigned int t;
2952
2953 a = m - ((m >> 1) & ~0UL/3);
2954 b = (a & ~0UL/5) + ((a >> 2) & ~0UL/5);
2955 c = (b + (b >> 4)) & ~0UL/0x11;
2956 d = (c + (c >> 8)) & ~0UL/0x101;
2957
2958 r++; // make r be 1..64
2959
2960 t = 0;
2961 s = LONGBITS;
2962 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01002963 unsigned long d2 = (d >> 16) >> 16;
2964 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01002965 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
2966 }
2967
2968 t = (d >> (s - 16)) & 0xff;
2969 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
2970 t = (c >> (s - 8)) & 0xf;
2971 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
2972 t = (b >> (s - 4)) & 0x7;
2973 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
2974 t = (a >> (s - 2)) & 0x3;
2975 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
2976 t = (m >> (s - 1)) & 0x1;
2977 s -= ((t - r) & 256) >> 8;
2978
2979 return s - 1;
2980}
2981
2982/* Same as mask_find_rank_bit() above but makes use of pre-computed bitmaps
2983 * based on <m>, in <a..d>. These ones must be updated whenever <m> changes
2984 * using mask_prep_rank_map() below.
2985 */
2986unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
2987 unsigned long a, unsigned long b,
2988 unsigned long c, unsigned long d)
2989{
2990 unsigned int s;
2991 unsigned int t;
2992
2993 r++; // make r be 1..64
2994
2995 t = 0;
2996 s = LONGBITS;
2997 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01002998 unsigned long d2 = (d >> 16) >> 16;
2999 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01003000 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
3001 }
3002
3003 t = (d >> (s - 16)) & 0xff;
3004 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
3005 t = (c >> (s - 8)) & 0xf;
3006 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
3007 t = (b >> (s - 4)) & 0x7;
3008 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
3009 t = (a >> (s - 2)) & 0x3;
3010 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
3011 t = (m >> (s - 1)) & 0x1;
3012 s -= ((t - r) & 256) >> 8;
3013
3014 return s - 1;
3015}
3016
3017/* Prepare the bitmaps used by the fast implementation of the find_rank_bit()
3018 * above.
3019 */
3020void mask_prep_rank_map(unsigned long m,
3021 unsigned long *a, unsigned long *b,
3022 unsigned long *c, unsigned long *d)
3023{
3024 *a = m - ((m >> 1) & ~0UL/3);
3025 *b = (*a & ~0UL/5) + ((*a >> 2) & ~0UL/5);
3026 *c = (*b + (*b >> 4)) & ~0UL/0x11;
3027 *d = (*c + (*c >> 8)) & ~0UL/0x101;
3028}
3029
David du Colombier4f92d322011-03-24 11:09:31 +01003030/* Return non-zero if IPv4 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003031 * otherwise zero. Note that <addr> may not necessarily be aligned
3032 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003033 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003034int in_net_ipv4(const void *addr, const struct in_addr *mask, const struct in_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003035{
Willy Tarreaueec1d382016-07-13 11:59:39 +02003036 struct in_addr addr_copy;
3037
3038 memcpy(&addr_copy, addr, sizeof(addr_copy));
3039 return((addr_copy.s_addr & mask->s_addr) == (net->s_addr & mask->s_addr));
David du Colombier4f92d322011-03-24 11:09:31 +01003040}
3041
3042/* Return non-zero if IPv6 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003043 * otherwise zero. Note that <addr> may not necessarily be aligned
3044 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003045 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003046int in_net_ipv6(const void *addr, const struct in6_addr *mask, const struct in6_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003047{
3048 int i;
Willy Tarreaueec1d382016-07-13 11:59:39 +02003049 struct in6_addr addr_copy;
David du Colombier4f92d322011-03-24 11:09:31 +01003050
Willy Tarreaueec1d382016-07-13 11:59:39 +02003051 memcpy(&addr_copy, addr, sizeof(addr_copy));
David du Colombier4f92d322011-03-24 11:09:31 +01003052 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
Willy Tarreaueec1d382016-07-13 11:59:39 +02003053 if (((((int *)&addr_copy)[i] & ((int *)mask)[i])) !=
David du Colombier4f92d322011-03-24 11:09:31 +01003054 (((int *)net)[i] & ((int *)mask)[i]))
3055 return 0;
3056 return 1;
3057}
3058
3059/* RFC 4291 prefix */
3060const char rfc4291_pfx[] = { 0x00, 0x00, 0x00, 0x00,
3061 0x00, 0x00, 0x00, 0x00,
3062 0x00, 0x00, 0xFF, 0xFF };
3063
Joseph Herlant32b83272018-11-15 11:58:28 -08003064/* Map IPv4 address on IPv6 address, as specified in RFC 3513.
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003065 * Input and output may overlap.
3066 */
David du Colombier4f92d322011-03-24 11:09:31 +01003067void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr)
3068{
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003069 struct in_addr tmp_addr;
3070
3071 tmp_addr.s_addr = sin_addr->s_addr;
David du Colombier4f92d322011-03-24 11:09:31 +01003072 memcpy(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx));
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003073 memcpy(sin6_addr->s6_addr+12, &tmp_addr.s_addr, 4);
David du Colombier4f92d322011-03-24 11:09:31 +01003074}
3075
Joseph Herlant32b83272018-11-15 11:58:28 -08003076/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01003077 * Return true if conversion is possible and false otherwise.
3078 */
3079int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr)
3080{
3081 if (memcmp(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx)) == 0) {
3082 memcpy(&(sin_addr->s_addr), &(sin6_addr->s6_addr[12]),
3083 sizeof(struct in_addr));
3084 return 1;
3085 }
3086
3087 return 0;
3088}
3089
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003090/* compare two struct sockaddr_storage and return:
3091 * 0 (true) if the addr is the same in both
3092 * 1 (false) if the addr is not the same in both
3093 * -1 (unable) if one of the addr is not AF_INET*
3094 */
3095int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2)
3096{
3097 if ((ss1->ss_family != AF_INET) && (ss1->ss_family != AF_INET6))
3098 return -1;
3099
3100 if ((ss2->ss_family != AF_INET) && (ss2->ss_family != AF_INET6))
3101 return -1;
3102
3103 if (ss1->ss_family != ss2->ss_family)
3104 return 1;
3105
3106 switch (ss1->ss_family) {
3107 case AF_INET:
3108 return memcmp(&((struct sockaddr_in *)ss1)->sin_addr,
3109 &((struct sockaddr_in *)ss2)->sin_addr,
3110 sizeof(struct in_addr)) != 0;
3111 case AF_INET6:
3112 return memcmp(&((struct sockaddr_in6 *)ss1)->sin6_addr,
3113 &((struct sockaddr_in6 *)ss2)->sin6_addr,
3114 sizeof(struct in6_addr)) != 0;
3115 }
3116
3117 return 1;
3118}
3119
Christopher Faulet9553de72021-02-26 09:12:50 +01003120/* compare a struct sockaddr_storage to a struct net_addr and return :
3121 * 0 (true) if <addr> is matching <net>
3122 * 1 (false) if <addr> is not matching <net>
3123 * -1 (unable) if <addr> or <net> is not AF_INET*
3124 */
3125int ipcmp2net(const struct sockaddr_storage *addr, const struct net_addr *net)
3126{
3127 if ((addr->ss_family != AF_INET) && (addr->ss_family != AF_INET6))
3128 return -1;
3129
3130 if ((net->family != AF_INET) && (net->family != AF_INET6))
3131 return -1;
3132
3133 if (addr->ss_family != net->family)
3134 return 1;
3135
3136 if (addr->ss_family == AF_INET &&
3137 (((struct sockaddr_in *)addr)->sin_addr.s_addr & net->addr.v4.mask.s_addr) == net->addr.v4.ip.s_addr)
3138 return 0;
3139 else {
3140 const struct in6_addr *addr6 = &(((const struct sockaddr_in6*)addr)->sin6_addr);
3141 const struct in6_addr *nip6 = &net->addr.v6.ip;
3142 const struct in6_addr *nmask6 = &net->addr.v6.mask;
3143
3144 if ((read_u32(&addr6->s6_addr[0]) & read_u32(&nmask6->s6_addr[0])) == read_u32(&nip6->s6_addr[0]) &&
3145 (read_u32(&addr6->s6_addr[4]) & read_u32(&nmask6->s6_addr[4])) == read_u32(&nip6->s6_addr[4]) &&
3146 (read_u32(&addr6->s6_addr[8]) & read_u32(&nmask6->s6_addr[8])) == read_u32(&nip6->s6_addr[8]) &&
3147 (read_u32(&addr6->s6_addr[12]) & read_u32(&nmask6->s6_addr[12])) == read_u32(&nip6->s6_addr[12]))
3148 return 0;
3149 }
3150
3151 return 1;
3152}
3153
Baptiste Assmann08396c82016-01-31 00:27:17 +01003154/* copy IP address from <source> into <dest>
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003155 * The caller must allocate and clear <dest> before calling.
3156 * The source must be in either AF_INET or AF_INET6 family, or the destination
3157 * address will be undefined. If the destination address used to hold a port,
3158 * it is preserved, so that this function can be used to switch to another
3159 * address family with no risk. Returns a pointer to the destination.
Baptiste Assmann08396c82016-01-31 00:27:17 +01003160 */
3161struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest)
3162{
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003163 int prev_port;
3164
3165 prev_port = get_net_port(dest);
3166 memset(dest, 0, sizeof(*dest));
Baptiste Assmann08396c82016-01-31 00:27:17 +01003167 dest->ss_family = source->ss_family;
3168
3169 /* copy new addr and apply it */
3170 switch (source->ss_family) {
3171 case AF_INET:
3172 ((struct sockaddr_in *)dest)->sin_addr.s_addr = ((struct sockaddr_in *)source)->sin_addr.s_addr;
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003173 ((struct sockaddr_in *)dest)->sin_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003174 break;
3175 case AF_INET6:
3176 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 +01003177 ((struct sockaddr_in6 *)dest)->sin6_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003178 break;
3179 }
3180
3181 return dest;
3182}
3183
William Lallemand421f5b52012-02-06 18:15:57 +01003184char *human_time(int t, short hz_div) {
3185 static char rv[sizeof("24855d23h")+1]; // longest of "23h59m" and "59m59s"
3186 char *p = rv;
Willy Tarreau761b3d52014-04-14 14:53:06 +02003187 char *end = rv + sizeof(rv);
William Lallemand421f5b52012-02-06 18:15:57 +01003188 int cnt=2; // print two numbers
3189
3190 if (unlikely(t < 0 || hz_div <= 0)) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003191 snprintf(p, end - p, "?");
William Lallemand421f5b52012-02-06 18:15:57 +01003192 return rv;
3193 }
3194
3195 if (unlikely(hz_div > 1))
3196 t /= hz_div;
3197
3198 if (t >= DAY) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003199 p += snprintf(p, end - p, "%dd", t / DAY);
William Lallemand421f5b52012-02-06 18:15:57 +01003200 cnt--;
3201 }
3202
3203 if (cnt && t % DAY / HOUR) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003204 p += snprintf(p, end - p, "%dh", t % DAY / HOUR);
William Lallemand421f5b52012-02-06 18:15:57 +01003205 cnt--;
3206 }
3207
3208 if (cnt && t % HOUR / MINUTE) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003209 p += snprintf(p, end - p, "%dm", t % HOUR / MINUTE);
William Lallemand421f5b52012-02-06 18:15:57 +01003210 cnt--;
3211 }
3212
3213 if ((cnt && t % MINUTE) || !t) // also display '0s'
Willy Tarreau761b3d52014-04-14 14:53:06 +02003214 p += snprintf(p, end - p, "%ds", t % MINUTE / SEC);
William Lallemand421f5b52012-02-06 18:15:57 +01003215
3216 return rv;
3217}
3218
3219const char *monthname[12] = {
3220 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
3221 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
3222};
3223
3224/* date2str_log: write a date in the format :
3225 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
3226 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3227 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
3228 *
3229 * without using sprintf. return a pointer to the last char written (\0) or
3230 * NULL if there isn't enough space.
3231 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02003232char *date2str_log(char *dst, const struct tm *tm, const struct timeval *date, size_t size)
William Lallemand421f5b52012-02-06 18:15:57 +01003233{
3234
3235 if (size < 25) /* the size is fixed: 24 chars + \0 */
3236 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++ = '.';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003266
Willy Tarreau7d9421d2020-02-29 09:08:02 +01003267 dst = utoa_pad((unsigned int)(date->tv_usec/1000)%1000, dst, 4); // milliseconds
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003268 if (!dst)
3269 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003270 *dst = '\0';
3271
3272 return dst;
3273}
3274
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003275/* Base year used to compute leap years */
3276#define TM_YEAR_BASE 1900
3277
3278/* Return the difference in seconds between two times (leap seconds are ignored).
3279 * Retrieved from glibc 2.18 source code.
3280 */
3281static int my_tm_diff(const struct tm *a, const struct tm *b)
3282{
3283 /* Compute intervening leap days correctly even if year is negative.
3284 * Take care to avoid int overflow in leap day calculations,
3285 * but it's OK to assume that A and B are close to each other.
3286 */
3287 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
3288 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
3289 int a100 = a4 / 25 - (a4 % 25 < 0);
3290 int b100 = b4 / 25 - (b4 % 25 < 0);
3291 int a400 = a100 >> 2;
3292 int b400 = b100 >> 2;
3293 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
3294 int years = a->tm_year - b->tm_year;
3295 int days = (365 * years + intervening_leap_days
3296 + (a->tm_yday - b->tm_yday));
3297 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
3298 + (a->tm_min - b->tm_min))
3299 + (a->tm_sec - b->tm_sec));
3300}
3301
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003302/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003303 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003304 * The string returned has the same format as returned by strftime(... "%z", tm).
3305 * Offsets are kept in an internal cache for better performances.
3306 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003307const char *get_gmt_offset(time_t t, struct tm *tm)
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003308{
3309 /* Cache offsets from GMT (depending on whether DST is active or not) */
Christopher Faulet1bc04c72017-10-29 20:14:08 +01003310 static THREAD_LOCAL char gmt_offsets[2][5+1] = { "", "" };
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003311
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003312 char *gmt_offset;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003313 struct tm tm_gmt;
3314 int diff;
3315 int isdst = tm->tm_isdst;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003316
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003317 /* Pretend DST not active if its status is unknown */
3318 if (isdst < 0)
3319 isdst = 0;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003320
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003321 /* Fetch the offset and initialize it if needed */
3322 gmt_offset = gmt_offsets[isdst & 0x01];
3323 if (unlikely(!*gmt_offset)) {
3324 get_gmtime(t, &tm_gmt);
3325 diff = my_tm_diff(tm, &tm_gmt);
3326 if (diff < 0) {
3327 diff = -diff;
3328 *gmt_offset = '-';
3329 } else {
3330 *gmt_offset = '+';
3331 }
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003332 diff %= 86400U;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003333 diff /= 60; /* Convert to minutes */
3334 snprintf(gmt_offset+1, 4+1, "%02d%02d", diff/60, diff%60);
3335 }
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003336
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003337 return gmt_offset;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003338}
3339
William Lallemand421f5b52012-02-06 18:15:57 +01003340/* gmt2str_log: write a date in the format :
3341 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
3342 * return a pointer to the last char written (\0) or
3343 * NULL if there isn't enough space.
3344 */
3345char *gmt2str_log(char *dst, struct tm *tm, size_t size)
3346{
Yuxans Yao4e25b012012-10-19 10:36:09 +08003347 if (size < 27) /* the size is fixed: 26 chars + \0 */
William Lallemand421f5b52012-02-06 18:15:57 +01003348 return NULL;
3349
3350 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003351 if (!dst)
3352 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003353 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003354
William Lallemand421f5b52012-02-06 18:15:57 +01003355 memcpy(dst, monthname[tm->tm_mon], 3); // month
3356 dst += 3;
3357 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003358
William Lallemand421f5b52012-02-06 18:15:57 +01003359 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003360 if (!dst)
3361 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003362 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003363
William Lallemand421f5b52012-02-06 18:15:57 +01003364 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003365 if (!dst)
3366 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003367 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003368
William Lallemand421f5b52012-02-06 18:15:57 +01003369 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003370 if (!dst)
3371 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003372 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003373
William Lallemand421f5b52012-02-06 18:15:57 +01003374 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003375 if (!dst)
3376 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003377 *dst++ = ' ';
3378 *dst++ = '+';
3379 *dst++ = '0';
3380 *dst++ = '0';
3381 *dst++ = '0';
3382 *dst++ = '0';
3383 *dst = '\0';
3384
3385 return dst;
3386}
3387
Yuxans Yao4e25b012012-10-19 10:36:09 +08003388/* localdate2str_log: write a date in the format :
3389 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003390 * Both t and tm must represent the same time.
3391 * return a pointer to the last char written (\0) or
3392 * NULL if there isn't enough space.
Yuxans Yao4e25b012012-10-19 10:36:09 +08003393 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003394char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size)
Yuxans Yao4e25b012012-10-19 10:36:09 +08003395{
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003396 const char *gmt_offset;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003397 if (size < 27) /* the size is fixed: 26 chars + \0 */
3398 return NULL;
3399
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003400 gmt_offset = get_gmt_offset(t, tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003401
Yuxans Yao4e25b012012-10-19 10:36:09 +08003402 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003403 if (!dst)
3404 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003405 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003406
Yuxans Yao4e25b012012-10-19 10:36:09 +08003407 memcpy(dst, monthname[tm->tm_mon], 3); // month
3408 dst += 3;
3409 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003410
Yuxans Yao4e25b012012-10-19 10:36:09 +08003411 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003412 if (!dst)
3413 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003414 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003415
Yuxans Yao4e25b012012-10-19 10:36:09 +08003416 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003417 if (!dst)
3418 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003419 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003420
Yuxans Yao4e25b012012-10-19 10:36:09 +08003421 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003422 if (!dst)
3423 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003424 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003425
Yuxans Yao4e25b012012-10-19 10:36:09 +08003426 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003427 if (!dst)
3428 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003429 *dst++ = ' ';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003430
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003431 memcpy(dst, gmt_offset, 5); // Offset from local time to GMT
Yuxans Yao4e25b012012-10-19 10:36:09 +08003432 dst += 5;
3433 *dst = '\0';
3434
3435 return dst;
3436}
3437
Willy Tarreaucb1949b2017-07-19 19:05:29 +02003438/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
3439 * It is meant as a portable replacement for timegm() for use with valid inputs.
3440 * Returns undefined results for invalid dates (eg: months out of range 0..11).
3441 */
3442time_t my_timegm(const struct tm *tm)
3443{
3444 /* Each month has 28, 29, 30 or 31 days, or 28+N. The date in the year
3445 * is thus (current month - 1)*28 + cumulated_N[month] to count the
3446 * sum of the extra N days for elapsed months. The sum of all these N
3447 * days doesn't exceed 30 for a complete year (366-12*28) so it fits
3448 * in a 5-bit word. This means that with 60 bits we can represent a
3449 * matrix of all these values at once, which is fast and efficient to
3450 * access. The extra February day for leap years is not counted here.
3451 *
3452 * Jan : none = 0 (0)
3453 * Feb : Jan = 3 (3)
3454 * Mar : Jan..Feb = 3 (3 + 0)
3455 * Apr : Jan..Mar = 6 (3 + 0 + 3)
3456 * May : Jan..Apr = 8 (3 + 0 + 3 + 2)
3457 * Jun : Jan..May = 11 (3 + 0 + 3 + 2 + 3)
3458 * Jul : Jan..Jun = 13 (3 + 0 + 3 + 2 + 3 + 2)
3459 * Aug : Jan..Jul = 16 (3 + 0 + 3 + 2 + 3 + 2 + 3)
3460 * Sep : Jan..Aug = 19 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3)
3461 * Oct : Jan..Sep = 21 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2)
3462 * Nov : Jan..Oct = 24 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3)
3463 * Dec : Jan..Nov = 26 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3 + 2)
3464 */
3465 uint64_t extra =
3466 ( 0ULL << 0*5) + ( 3ULL << 1*5) + ( 3ULL << 2*5) + /* Jan, Feb, Mar, */
3467 ( 6ULL << 3*5) + ( 8ULL << 4*5) + (11ULL << 5*5) + /* Apr, May, Jun, */
3468 (13ULL << 6*5) + (16ULL << 7*5) + (19ULL << 8*5) + /* Jul, Aug, Sep, */
3469 (21ULL << 9*5) + (24ULL << 10*5) + (26ULL << 11*5); /* Oct, Nov, Dec, */
3470
3471 unsigned int y = tm->tm_year + 1900;
3472 unsigned int m = tm->tm_mon;
3473 unsigned long days = 0;
3474
3475 /* days since 1/1/1970 for full years */
3476 days += days_since_zero(y) - days_since_zero(1970);
3477
3478 /* days for full months in the current year */
3479 days += 28 * m + ((extra >> (m * 5)) & 0x1f);
3480
3481 /* count + 1 after March for leap years. A leap year is a year multiple
3482 * of 4, unless it's multiple of 100 without being multiple of 400. 2000
3483 * is leap, 1900 isn't, 1904 is.
3484 */
3485 if ((m > 1) && !(y & 3) && ((y % 100) || !(y % 400)))
3486 days++;
3487
3488 days += tm->tm_mday - 1;
3489 return days * 86400ULL + tm->tm_hour * 3600 + tm->tm_min * 60 + tm->tm_sec;
3490}
3491
Thierry Fournier93127942016-01-20 18:49:45 +01003492/* This function check a char. It returns true and updates
3493 * <date> and <len> pointer to the new position if the
3494 * character is found.
3495 */
3496static inline int parse_expect_char(const char **date, int *len, char c)
3497{
3498 if (*len < 1 || **date != c)
3499 return 0;
3500 (*len)--;
3501 (*date)++;
3502 return 1;
3503}
3504
3505/* This function expects a string <str> of len <l>. It return true and updates.
3506 * <date> and <len> if the string matches, otherwise, it returns false.
3507 */
3508static inline int parse_strcmp(const char **date, int *len, char *str, int l)
3509{
3510 if (*len < l || strncmp(*date, str, l) != 0)
3511 return 0;
3512 (*len) -= l;
3513 (*date) += l;
3514 return 1;
3515}
3516
3517/* This macro converts 3 chars name in integer. */
3518#define STR2I3(__a, __b, __c) ((__a) * 65536 + (__b) * 256 + (__c))
3519
3520/* day-name = %x4D.6F.6E ; "Mon", case-sensitive
3521 * / %x54.75.65 ; "Tue", case-sensitive
3522 * / %x57.65.64 ; "Wed", case-sensitive
3523 * / %x54.68.75 ; "Thu", case-sensitive
3524 * / %x46.72.69 ; "Fri", case-sensitive
3525 * / %x53.61.74 ; "Sat", case-sensitive
3526 * / %x53.75.6E ; "Sun", case-sensitive
3527 *
3528 * This array must be alphabetically sorted
3529 */
3530static inline int parse_http_dayname(const char **date, int *len, struct tm *tm)
3531{
3532 if (*len < 3)
3533 return 0;
3534 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3535 case STR2I3('M','o','n'): tm->tm_wday = 1; break;
3536 case STR2I3('T','u','e'): tm->tm_wday = 2; break;
3537 case STR2I3('W','e','d'): tm->tm_wday = 3; break;
3538 case STR2I3('T','h','u'): tm->tm_wday = 4; break;
3539 case STR2I3('F','r','i'): tm->tm_wday = 5; break;
3540 case STR2I3('S','a','t'): tm->tm_wday = 6; break;
3541 case STR2I3('S','u','n'): tm->tm_wday = 7; break;
3542 default: return 0;
3543 }
3544 *len -= 3;
3545 *date += 3;
3546 return 1;
3547}
3548
3549/* month = %x4A.61.6E ; "Jan", case-sensitive
3550 * / %x46.65.62 ; "Feb", case-sensitive
3551 * / %x4D.61.72 ; "Mar", case-sensitive
3552 * / %x41.70.72 ; "Apr", case-sensitive
3553 * / %x4D.61.79 ; "May", case-sensitive
3554 * / %x4A.75.6E ; "Jun", case-sensitive
3555 * / %x4A.75.6C ; "Jul", case-sensitive
3556 * / %x41.75.67 ; "Aug", case-sensitive
3557 * / %x53.65.70 ; "Sep", case-sensitive
3558 * / %x4F.63.74 ; "Oct", case-sensitive
3559 * / %x4E.6F.76 ; "Nov", case-sensitive
3560 * / %x44.65.63 ; "Dec", case-sensitive
3561 *
3562 * This array must be alphabetically sorted
3563 */
3564static inline int parse_http_monthname(const char **date, int *len, struct tm *tm)
3565{
3566 if (*len < 3)
3567 return 0;
3568 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3569 case STR2I3('J','a','n'): tm->tm_mon = 0; break;
3570 case STR2I3('F','e','b'): tm->tm_mon = 1; break;
3571 case STR2I3('M','a','r'): tm->tm_mon = 2; break;
3572 case STR2I3('A','p','r'): tm->tm_mon = 3; break;
3573 case STR2I3('M','a','y'): tm->tm_mon = 4; break;
3574 case STR2I3('J','u','n'): tm->tm_mon = 5; break;
3575 case STR2I3('J','u','l'): tm->tm_mon = 6; break;
3576 case STR2I3('A','u','g'): tm->tm_mon = 7; break;
3577 case STR2I3('S','e','p'): tm->tm_mon = 8; break;
3578 case STR2I3('O','c','t'): tm->tm_mon = 9; break;
3579 case STR2I3('N','o','v'): tm->tm_mon = 10; break;
3580 case STR2I3('D','e','c'): tm->tm_mon = 11; break;
3581 default: return 0;
3582 }
3583 *len -= 3;
3584 *date += 3;
3585 return 1;
3586}
3587
3588/* day-name-l = %x4D.6F.6E.64.61.79 ; "Monday", case-sensitive
3589 * / %x54.75.65.73.64.61.79 ; "Tuesday", case-sensitive
3590 * / %x57.65.64.6E.65.73.64.61.79 ; "Wednesday", case-sensitive
3591 * / %x54.68.75.72.73.64.61.79 ; "Thursday", case-sensitive
3592 * / %x46.72.69.64.61.79 ; "Friday", case-sensitive
3593 * / %x53.61.74.75.72.64.61.79 ; "Saturday", case-sensitive
3594 * / %x53.75.6E.64.61.79 ; "Sunday", case-sensitive
3595 *
3596 * This array must be alphabetically sorted
3597 */
3598static inline int parse_http_ldayname(const char **date, int *len, struct tm *tm)
3599{
3600 if (*len < 6) /* Minimum length. */
3601 return 0;
3602 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3603 case STR2I3('M','o','n'):
3604 RET0_UNLESS(parse_strcmp(date, len, "Monday", 6));
3605 tm->tm_wday = 1;
3606 return 1;
3607 case STR2I3('T','u','e'):
3608 RET0_UNLESS(parse_strcmp(date, len, "Tuesday", 7));
3609 tm->tm_wday = 2;
3610 return 1;
3611 case STR2I3('W','e','d'):
3612 RET0_UNLESS(parse_strcmp(date, len, "Wednesday", 9));
3613 tm->tm_wday = 3;
3614 return 1;
3615 case STR2I3('T','h','u'):
3616 RET0_UNLESS(parse_strcmp(date, len, "Thursday", 8));
3617 tm->tm_wday = 4;
3618 return 1;
3619 case STR2I3('F','r','i'):
3620 RET0_UNLESS(parse_strcmp(date, len, "Friday", 6));
3621 tm->tm_wday = 5;
3622 return 1;
3623 case STR2I3('S','a','t'):
3624 RET0_UNLESS(parse_strcmp(date, len, "Saturday", 8));
3625 tm->tm_wday = 6;
3626 return 1;
3627 case STR2I3('S','u','n'):
3628 RET0_UNLESS(parse_strcmp(date, len, "Sunday", 6));
3629 tm->tm_wday = 7;
3630 return 1;
3631 }
3632 return 0;
3633}
3634
3635/* This function parses exactly 1 digit and returns the numeric value in "digit". */
3636static inline int parse_digit(const char **date, int *len, int *digit)
3637{
3638 if (*len < 1 || **date < '0' || **date > '9')
3639 return 0;
3640 *digit = (**date - '0');
3641 (*date)++;
3642 (*len)--;
3643 return 1;
3644}
3645
3646/* This function parses exactly 2 digits and returns the numeric value in "digit". */
3647static inline int parse_2digit(const char **date, int *len, int *digit)
3648{
3649 int value;
3650
3651 RET0_UNLESS(parse_digit(date, len, &value));
3652 (*digit) = value * 10;
3653 RET0_UNLESS(parse_digit(date, len, &value));
3654 (*digit) += value;
3655
3656 return 1;
3657}
3658
3659/* This function parses exactly 4 digits and returns the numeric value in "digit". */
3660static inline int parse_4digit(const char **date, int *len, int *digit)
3661{
3662 int value;
3663
3664 RET0_UNLESS(parse_digit(date, len, &value));
3665 (*digit) = value * 1000;
3666
3667 RET0_UNLESS(parse_digit(date, len, &value));
3668 (*digit) += value * 100;
3669
3670 RET0_UNLESS(parse_digit(date, len, &value));
3671 (*digit) += value * 10;
3672
3673 RET0_UNLESS(parse_digit(date, len, &value));
3674 (*digit) += value;
3675
3676 return 1;
3677}
3678
3679/* time-of-day = hour ":" minute ":" second
3680 * ; 00:00:00 - 23:59:60 (leap second)
3681 *
3682 * hour = 2DIGIT
3683 * minute = 2DIGIT
3684 * second = 2DIGIT
3685 */
3686static inline int parse_http_time(const char **date, int *len, struct tm *tm)
3687{
3688 RET0_UNLESS(parse_2digit(date, len, &tm->tm_hour)); /* hour 2DIGIT */
3689 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3690 RET0_UNLESS(parse_2digit(date, len, &tm->tm_min)); /* min 2DIGIT */
3691 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3692 RET0_UNLESS(parse_2digit(date, len, &tm->tm_sec)); /* sec 2DIGIT */
3693 return 1;
3694}
3695
3696/* From RFC7231
3697 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3698 *
3699 * IMF-fixdate = day-name "," SP date1 SP time-of-day SP GMT
3700 * ; fixed length/zone/capitalization subset of the format
3701 * ; see Section 3.3 of [RFC5322]
3702 *
3703 *
3704 * date1 = day SP month SP year
3705 * ; e.g., 02 Jun 1982
3706 *
3707 * day = 2DIGIT
3708 * year = 4DIGIT
3709 *
3710 * GMT = %x47.4D.54 ; "GMT", case-sensitive
3711 *
3712 * time-of-day = hour ":" minute ":" second
3713 * ; 00:00:00 - 23:59:60 (leap second)
3714 *
3715 * hour = 2DIGIT
3716 * minute = 2DIGIT
3717 * second = 2DIGIT
3718 *
3719 * DIGIT = decimal 0-9
3720 */
3721int parse_imf_date(const char *date, int len, struct tm *tm)
3722{
David Carlier327298c2016-11-20 10:42:38 +00003723 /* tm_gmtoff, if present, ought to be zero'ed */
3724 memset(tm, 0, sizeof(*tm));
3725
Thierry Fournier93127942016-01-20 18:49:45 +01003726 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3727 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3728 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3729 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3730 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3731 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3732 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3733 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3734 tm->tm_year -= 1900;
3735 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3736 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3737 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3738 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3739 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003740 return 1;
3741}
3742
3743/* From RFC7231
3744 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3745 *
3746 * rfc850-date = day-name-l "," SP date2 SP time-of-day SP GMT
3747 * date2 = day "-" month "-" 2DIGIT
3748 * ; e.g., 02-Jun-82
3749 *
3750 * day = 2DIGIT
3751 */
3752int parse_rfc850_date(const char *date, int len, struct tm *tm)
3753{
3754 int year;
3755
David Carlier327298c2016-11-20 10:42:38 +00003756 /* tm_gmtoff, if present, ought to be zero'ed */
3757 memset(tm, 0, sizeof(*tm));
3758
Thierry Fournier93127942016-01-20 18:49:45 +01003759 RET0_UNLESS(parse_http_ldayname(&date, &len, tm)); /* Read the day name */
3760 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3761 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3762 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3763 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3764 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3765 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3766
3767 /* year = 2DIGIT
3768 *
3769 * Recipients of a timestamp value in rfc850-(*date) format, which uses a
3770 * two-digit year, MUST interpret a timestamp that appears to be more
3771 * than 50 years in the future as representing the most recent year in
3772 * the past that had the same last two digits.
3773 */
3774 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_year));
3775
3776 /* expect SP */
3777 if (!parse_expect_char(&date, &len, ' ')) {
3778 /* Maybe we have the date with 4 digits. */
3779 RET0_UNLESS(parse_2digit(&date, &len, &year));
3780 tm->tm_year = (tm->tm_year * 100 + year) - 1900;
3781 /* expect SP */
3782 RET0_UNLESS(parse_expect_char(&date, &len, ' '));
3783 } else {
3784 /* I fix 60 as pivot: >60: +1900, <60: +2000. Note that the
3785 * tm_year is the number of year since 1900, so for +1900, we
3786 * do nothing, and for +2000, we add 100.
3787 */
3788 if (tm->tm_year <= 60)
3789 tm->tm_year += 100;
3790 }
3791
3792 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3793 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3794 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3795 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003796
3797 return 1;
3798}
3799
3800/* From RFC7231
3801 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3802 *
3803 * asctime-date = day-name SP date3 SP time-of-day SP year
3804 * date3 = month SP ( 2DIGIT / ( SP 1DIGIT ))
3805 * ; e.g., Jun 2
3806 *
3807 * HTTP-date is case sensitive. A sender MUST NOT generate additional
3808 * whitespace in an HTTP-date beyond that specifically included as SP in
3809 * the grammar.
3810 */
3811int parse_asctime_date(const char *date, int len, struct tm *tm)
3812{
David Carlier327298c2016-11-20 10:42:38 +00003813 /* tm_gmtoff, if present, ought to be zero'ed */
3814 memset(tm, 0, sizeof(*tm));
3815
Thierry Fournier93127942016-01-20 18:49:45 +01003816 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3817 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3818 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* expect month */
3819 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3820
3821 /* expect SP and 1DIGIT or 2DIGIT */
3822 if (parse_expect_char(&date, &len, ' '))
3823 RET0_UNLESS(parse_digit(&date, &len, &tm->tm_mday));
3824 else
3825 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday));
3826
3827 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3828 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3829 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3830 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3831 tm->tm_year -= 1900;
3832 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003833 return 1;
3834}
3835
3836/* From RFC7231
3837 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3838 *
3839 * HTTP-date = IMF-fixdate / obs-date
3840 * obs-date = rfc850-date / asctime-date
3841 *
3842 * parses an HTTP date in the RFC format and is accepted
3843 * alternatives. <date> is the strinf containing the date,
3844 * len is the len of the string. <tm> is filled with the
3845 * parsed time. We must considers this time as GMT.
3846 */
3847int parse_http_date(const char *date, int len, struct tm *tm)
3848{
3849 if (parse_imf_date(date, len, tm))
3850 return 1;
3851
3852 if (parse_rfc850_date(date, len, tm))
3853 return 1;
3854
3855 if (parse_asctime_date(date, len, tm))
3856 return 1;
3857
3858 return 0;
3859}
3860
Willy Tarreau4deeb102021-01-29 10:47:52 +01003861/* print the time <ns> in a short form (exactly 7 chars) at the end of buffer
3862 * <out>. "-" is printed if the value is zero, "inf" if larger than 1000 years.
3863 * It returns the new buffer length, or 0 if it doesn't fit. The value will be
3864 * surrounded by <pfx> and <sfx> respectively if not NULL.
3865 */
3866int print_time_short(struct buffer *out, const char *pfx, uint64_t ns, const char *sfx)
3867{
3868 double val = ns; // 52 bits of mantissa keep ns accuracy over 52 days
3869 const char *unit;
3870
3871 if (!pfx)
3872 pfx = "";
3873 if (!sfx)
3874 sfx = "";
3875
3876 do {
3877 unit = " - "; if (val <= 0.0) break;
3878 unit = "ns"; if (val < 1000.0) break;
3879 unit = "us"; val /= 1000.0; if (val < 1000.0) break;
3880 unit = "ms"; val /= 1000.0; if (val < 1000.0) break;
3881 unit = "s "; val /= 1000.0; if (val < 60.0) break;
3882 unit = "m "; val /= 60.0; if (val < 60.0) break;
3883 unit = "h "; val /= 60.0; if (val < 24.0) break;
3884 unit = "d "; val /= 24.0; if (val < 365.0) break;
3885 unit = "yr"; val /= 365.0; if (val < 1000.0) break;
3886 unit = " inf "; val = 0.0; break;
3887 } while (0);
3888
3889 if (val <= 0.0)
3890 return chunk_appendf(out, "%s%7s%s", pfx, unit, sfx);
3891 else if (val < 10.0)
3892 return chunk_appendf(out, "%s%1.3f%s%s", pfx, val, unit, sfx);
3893 else if (val < 100.0)
3894 return chunk_appendf(out, "%s%2.2f%s%s", pfx, val, unit, sfx);
3895 else
3896 return chunk_appendf(out, "%s%3.1f%s%s", pfx, val, unit, sfx);
3897}
3898
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003899/* Dynamically allocates a string of the proper length to hold the formatted
3900 * output. NULL is returned on error. The caller is responsible for freeing the
3901 * memory area using free(). The resulting string is returned in <out> if the
3902 * pointer is not NULL. A previous version of <out> might be used to build the
3903 * new string, and it will be freed before returning if it is not NULL, which
3904 * makes it possible to build complex strings from iterative calls without
3905 * having to care about freeing intermediate values, as in the example below :
3906 *
3907 * memprintf(&err, "invalid argument: '%s'", arg);
3908 * ...
3909 * memprintf(&err, "parser said : <%s>\n", *err);
3910 * ...
3911 * free(*err);
3912 *
3913 * This means that <err> must be initialized to NULL before first invocation.
3914 * The return value also holds the allocated string, which eases error checking
3915 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02003916 * passed instead and it will be ignored. The returned message will then also
3917 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003918 *
3919 * It is also convenient to use it without any free except the last one :
3920 * err = NULL;
3921 * if (!fct1(err)) report(*err);
3922 * if (!fct2(err)) report(*err);
3923 * if (!fct3(err)) report(*err);
3924 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02003925 *
3926 * memprintf relies on memvprintf. This last version can be called from any
3927 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003928 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02003929char *memvprintf(char **out, const char *format, va_list orig_args)
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003930{
3931 va_list args;
3932 char *ret = NULL;
3933 int allocated = 0;
3934 int needed = 0;
3935
Willy Tarreaueb6cead2012-09-20 19:43:14 +02003936 if (!out)
3937 return NULL;
3938
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003939 do {
Willy Tarreaue0609f52019-03-29 19:13:23 +01003940 char buf1;
3941
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003942 /* vsnprintf() will return the required length even when the
3943 * target buffer is NULL. We do this in a loop just in case
3944 * intermediate evaluations get wrong.
3945 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02003946 va_copy(args, orig_args);
Willy Tarreaue0609f52019-03-29 19:13:23 +01003947 needed = vsnprintf(ret ? ret : &buf1, allocated, format, args);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003948 va_end(args);
Willy Tarreau1b2fed62013-04-01 22:48:54 +02003949 if (needed < allocated) {
3950 /* Note: on Solaris 8, the first iteration always
3951 * returns -1 if allocated is zero, so we force a
3952 * retry.
3953 */
3954 if (!allocated)
3955 needed = 0;
3956 else
3957 break;
3958 }
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003959
Willy Tarreau1b2fed62013-04-01 22:48:54 +02003960 allocated = needed + 1;
Hubert Verstraete831962e2016-06-28 22:44:26 +02003961 ret = my_realloc2(ret, allocated);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003962 } while (ret);
3963
3964 if (needed < 0) {
3965 /* an error was encountered */
Willy Tarreau61cfdf42021-02-20 10:46:51 +01003966 ha_free(&ret);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003967 }
3968
3969 if (out) {
3970 free(*out);
3971 *out = ret;
3972 }
3973
3974 return ret;
3975}
William Lallemand421f5b52012-02-06 18:15:57 +01003976
Christopher Faulet93a518f2017-10-24 11:25:33 +02003977char *memprintf(char **out, const char *format, ...)
3978{
3979 va_list args;
3980 char *ret = NULL;
3981
3982 va_start(args, format);
3983 ret = memvprintf(out, format, args);
3984 va_end(args);
3985
3986 return ret;
3987}
3988
Willy Tarreau21c705b2012-09-14 11:40:36 +02003989/* Used to add <level> spaces before each line of <out>, unless there is only one line.
3990 * The input argument is automatically freed and reassigned. The result will have to be
Willy Tarreau70eec382012-10-10 08:56:47 +02003991 * freed by the caller. It also supports being passed a NULL which results in the same
3992 * output.
Willy Tarreau21c705b2012-09-14 11:40:36 +02003993 * Example of use :
3994 * parse(cmd, &err); (callee: memprintf(&err, ...))
3995 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
3996 * free(err);
3997 */
3998char *indent_msg(char **out, int level)
3999{
4000 char *ret, *in, *p;
4001 int needed = 0;
4002 int lf = 0;
4003 int lastlf = 0;
4004 int len;
4005
Willy Tarreau70eec382012-10-10 08:56:47 +02004006 if (!out || !*out)
4007 return NULL;
4008
Willy Tarreau21c705b2012-09-14 11:40:36 +02004009 in = *out - 1;
4010 while ((in = strchr(in + 1, '\n')) != NULL) {
4011 lastlf = in - *out;
4012 lf++;
4013 }
4014
4015 if (!lf) /* single line, no LF, return it as-is */
4016 return *out;
4017
4018 len = strlen(*out);
4019
4020 if (lf == 1 && lastlf == len - 1) {
4021 /* single line, LF at end, strip it and return as-is */
4022 (*out)[lastlf] = 0;
4023 return *out;
4024 }
4025
4026 /* OK now we have at least one LF, we need to process the whole string
4027 * as a multi-line string. What we'll do :
4028 * - prefix with an LF if there is none
4029 * - add <level> spaces before each line
4030 * This means at most ( 1 + level + (len-lf) + lf*<1+level) ) =
4031 * 1 + level + len + lf * level = 1 + level * (lf + 1) + len.
4032 */
4033
4034 needed = 1 + level * (lf + 1) + len + 1;
4035 p = ret = malloc(needed);
4036 in = *out;
4037
4038 /* skip initial LFs */
4039 while (*in == '\n')
4040 in++;
4041
4042 /* copy each line, prefixed with LF and <level> spaces, and without the trailing LF */
4043 while (*in) {
4044 *p++ = '\n';
4045 memset(p, ' ', level);
4046 p += level;
4047 do {
4048 *p++ = *in++;
4049 } while (*in && *in != '\n');
4050 if (*in)
4051 in++;
4052 }
4053 *p = 0;
4054
4055 free(*out);
4056 *out = ret;
4057
4058 return ret;
4059}
4060
Willy Tarreaua2c99112019-08-21 13:17:37 +02004061/* makes a copy of message <in> into <out>, with each line prefixed with <pfx>
4062 * and end of lines replaced with <eol> if not 0. The first line to indent has
4063 * to be indicated in <first> (starts at zero), so that it is possible to skip
4064 * indenting the first line if it has to be appended after an existing message.
4065 * Empty strings are never indented, and NULL strings are considered empty both
4066 * for <in> and <pfx>. It returns non-zero if an EOL was appended as the last
4067 * character, non-zero otherwise.
4068 */
4069int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first)
4070{
4071 int bol, lf;
4072 int pfxlen = pfx ? strlen(pfx) : 0;
4073
4074 if (!in)
4075 return 0;
4076
4077 bol = 1;
4078 lf = 0;
4079 while (*in) {
4080 if (bol && pfxlen) {
4081 if (first > 0)
4082 first--;
4083 else
4084 b_putblk(out, pfx, pfxlen);
4085 bol = 0;
4086 }
4087
4088 lf = (*in == '\n');
4089 bol |= lf;
4090 b_putchr(out, (lf && eol) ? eol : *in);
4091 in++;
4092 }
4093 return lf;
4094}
4095
Willy Tarreau9d22e562019-03-29 18:49:09 +01004096/* removes environment variable <name> from the environment as found in
4097 * environ. This is only provided as an alternative for systems without
4098 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05004099 * The principle is to scan environ for each occurrence of variable name
Willy Tarreau9d22e562019-03-29 18:49:09 +01004100 * <name> and to replace the matching pointers with the last pointer of
4101 * the array (since variables are not ordered).
4102 * It always returns 0 (success).
4103 */
4104int my_unsetenv(const char *name)
4105{
4106 extern char **environ;
4107 char **p = environ;
4108 int vars;
4109 int next;
4110 int len;
4111
4112 len = strlen(name);
4113 for (vars = 0; p[vars]; vars++)
4114 ;
4115 next = 0;
4116 while (next < vars) {
4117 if (strncmp(p[next], name, len) != 0 || p[next][len] != '=') {
4118 next++;
4119 continue;
4120 }
4121 if (next < vars - 1)
4122 p[next] = p[vars - 1];
4123 p[--vars] = NULL;
4124 }
4125 return 0;
4126}
4127
Willy Tarreaudad36a32013-03-11 01:20:04 +01004128/* Convert occurrences of environment variables in the input string to their
4129 * corresponding value. A variable is identified as a series of alphanumeric
4130 * characters or underscores following a '$' sign. The <in> string must be
4131 * free()able. NULL returns NULL. The resulting string might be reallocated if
4132 * some expansion is made. Variable names may also be enclosed into braces if
4133 * needed (eg: to concatenate alphanum characters).
4134 */
4135char *env_expand(char *in)
4136{
4137 char *txt_beg;
4138 char *out;
4139 char *txt_end;
4140 char *var_beg;
4141 char *var_end;
4142 char *value;
4143 char *next;
4144 int out_len;
4145 int val_len;
4146
4147 if (!in)
4148 return in;
4149
4150 value = out = NULL;
4151 out_len = 0;
4152
4153 txt_beg = in;
4154 do {
4155 /* look for next '$' sign in <in> */
4156 for (txt_end = txt_beg; *txt_end && *txt_end != '$'; txt_end++);
4157
4158 if (!*txt_end && !out) /* end and no expansion performed */
4159 return in;
4160
4161 val_len = 0;
4162 next = txt_end;
4163 if (*txt_end == '$') {
4164 char save;
4165
4166 var_beg = txt_end + 1;
4167 if (*var_beg == '{')
4168 var_beg++;
4169
4170 var_end = var_beg;
Willy Tarreau90807112020-02-25 08:16:33 +01004171 while (isalnum((unsigned char)*var_end) || *var_end == '_') {
Willy Tarreaudad36a32013-03-11 01:20:04 +01004172 var_end++;
4173 }
4174
4175 next = var_end;
4176 if (*var_end == '}' && (var_beg > txt_end + 1))
4177 next++;
4178
4179 /* get value of the variable name at this location */
4180 save = *var_end;
4181 *var_end = '\0';
4182 value = getenv(var_beg);
4183 *var_end = save;
4184 val_len = value ? strlen(value) : 0;
4185 }
4186
Hubert Verstraete831962e2016-06-28 22:44:26 +02004187 out = my_realloc2(out, out_len + (txt_end - txt_beg) + val_len + 1);
Willy Tarreaudad36a32013-03-11 01:20:04 +01004188 if (txt_end > txt_beg) {
4189 memcpy(out + out_len, txt_beg, txt_end - txt_beg);
4190 out_len += txt_end - txt_beg;
4191 }
4192 if (val_len) {
4193 memcpy(out + out_len, value, val_len);
4194 out_len += val_len;
4195 }
4196 out[out_len] = 0;
4197 txt_beg = next;
4198 } while (*txt_beg);
4199
4200 /* here we know that <out> was allocated and that we don't need <in> anymore */
4201 free(in);
4202 return out;
4203}
4204
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004205
4206/* same as strstr() but case-insensitive and with limit length */
4207const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2)
4208{
4209 char *pptr, *sptr, *start;
Willy Tarreauc8746532014-05-28 23:05:07 +02004210 unsigned int slen, plen;
4211 unsigned int tmp1, tmp2;
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004212
4213 if (str1 == NULL || len_str1 == 0) // search pattern into an empty string => search is not found
4214 return NULL;
4215
4216 if (str2 == NULL || len_str2 == 0) // pattern is empty => every str1 match
4217 return str1;
4218
4219 if (len_str1 < len_str2) // pattern is longer than string => search is not found
4220 return NULL;
4221
4222 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 +02004223 while (toupper((unsigned char)*start) != toupper((unsigned char)*str2)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004224 start++;
4225 slen--;
4226 tmp1++;
4227
4228 if (tmp1 >= len_str1)
4229 return NULL;
4230
4231 /* if pattern longer than string */
4232 if (slen < plen)
4233 return NULL;
4234 }
4235
4236 sptr = start;
4237 pptr = (char *)str2;
4238
4239 tmp2 = 0;
Willy Tarreauf278eec2020-07-05 21:46:32 +02004240 while (toupper((unsigned char)*sptr) == toupper((unsigned char)*pptr)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004241 sptr++;
4242 pptr++;
4243 tmp2++;
4244
4245 if (*pptr == '\0' || tmp2 == len_str2) /* end of pattern found */
4246 return start;
4247 if (*sptr == '\0' || tmp2 == len_str1) /* end of string found and the pattern is not fully found */
4248 return NULL;
4249 }
4250 }
4251 return NULL;
4252}
4253
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004254/* This function read the next valid utf8 char.
4255 * <s> is the byte srray to be decode, <len> is its length.
4256 * The function returns decoded char encoded like this:
4257 * The 4 msb are the return code (UTF8_CODE_*), the 4 lsb
4258 * are the length read. The decoded character is stored in <c>.
4259 */
4260unsigned char utf8_next(const char *s, int len, unsigned int *c)
4261{
4262 const unsigned char *p = (unsigned char *)s;
4263 int dec;
4264 unsigned char code = UTF8_CODE_OK;
4265
4266 if (len < 1)
4267 return UTF8_CODE_OK;
4268
4269 /* Check the type of UTF8 sequence
4270 *
4271 * 0... .... 0x00 <= x <= 0x7f : 1 byte: ascii char
4272 * 10.. .... 0x80 <= x <= 0xbf : invalid sequence
4273 * 110. .... 0xc0 <= x <= 0xdf : 2 bytes
4274 * 1110 .... 0xe0 <= x <= 0xef : 3 bytes
4275 * 1111 0... 0xf0 <= x <= 0xf7 : 4 bytes
4276 * 1111 10.. 0xf8 <= x <= 0xfb : 5 bytes
4277 * 1111 110. 0xfc <= x <= 0xfd : 6 bytes
4278 * 1111 111. 0xfe <= x <= 0xff : invalid sequence
4279 */
4280 switch (*p) {
4281 case 0x00 ... 0x7f:
4282 *c = *p;
4283 return UTF8_CODE_OK | 1;
4284
4285 case 0x80 ... 0xbf:
4286 *c = *p;
4287 return UTF8_CODE_BADSEQ | 1;
4288
4289 case 0xc0 ... 0xdf:
4290 if (len < 2) {
4291 *c = *p;
4292 return UTF8_CODE_BADSEQ | 1;
4293 }
4294 *c = *p & 0x1f;
4295 dec = 1;
4296 break;
4297
4298 case 0xe0 ... 0xef:
4299 if (len < 3) {
4300 *c = *p;
4301 return UTF8_CODE_BADSEQ | 1;
4302 }
4303 *c = *p & 0x0f;
4304 dec = 2;
4305 break;
4306
4307 case 0xf0 ... 0xf7:
4308 if (len < 4) {
4309 *c = *p;
4310 return UTF8_CODE_BADSEQ | 1;
4311 }
4312 *c = *p & 0x07;
4313 dec = 3;
4314 break;
4315
4316 case 0xf8 ... 0xfb:
4317 if (len < 5) {
4318 *c = *p;
4319 return UTF8_CODE_BADSEQ | 1;
4320 }
4321 *c = *p & 0x03;
4322 dec = 4;
4323 break;
4324
4325 case 0xfc ... 0xfd:
4326 if (len < 6) {
4327 *c = *p;
4328 return UTF8_CODE_BADSEQ | 1;
4329 }
4330 *c = *p & 0x01;
4331 dec = 5;
4332 break;
4333
4334 case 0xfe ... 0xff:
4335 default:
4336 *c = *p;
4337 return UTF8_CODE_BADSEQ | 1;
4338 }
4339
4340 p++;
4341
4342 while (dec > 0) {
4343
4344 /* need 0x10 for the 2 first bits */
4345 if ( ( *p & 0xc0 ) != 0x80 )
4346 return UTF8_CODE_BADSEQ | ((p-(unsigned char *)s)&0xffff);
4347
4348 /* add data at char */
4349 *c = ( *c << 6 ) | ( *p & 0x3f );
4350
4351 dec--;
4352 p++;
4353 }
4354
4355 /* Check ovelong encoding.
4356 * 1 byte : 5 + 6 : 11 : 0x80 ... 0x7ff
4357 * 2 bytes : 4 + 6 + 6 : 16 : 0x800 ... 0xffff
4358 * 3 bytes : 3 + 6 + 6 + 6 : 21 : 0x10000 ... 0x1fffff
4359 */
Thierry FOURNIER9e7ec082015-03-12 19:32:38 +01004360 if (( *c <= 0x7f && (p-(unsigned char *)s) > 1) ||
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004361 (*c >= 0x80 && *c <= 0x7ff && (p-(unsigned char *)s) > 2) ||
4362 (*c >= 0x800 && *c <= 0xffff && (p-(unsigned char *)s) > 3) ||
4363 (*c >= 0x10000 && *c <= 0x1fffff && (p-(unsigned char *)s) > 4))
4364 code |= UTF8_CODE_OVERLONG;
4365
4366 /* Check invalid UTF8 range. */
4367 if ((*c >= 0xd800 && *c <= 0xdfff) ||
4368 (*c >= 0xfffe && *c <= 0xffff))
4369 code |= UTF8_CODE_INVRANGE;
4370
4371 return code | ((p-(unsigned char *)s)&0x0f);
4372}
4373
Maxime de Roucydc887852016-05-13 23:52:54 +02004374/* append a copy of string <str> (in a wordlist) at the end of the list <li>
4375 * On failure : return 0 and <err> filled with an error message.
4376 * The caller is responsible for freeing the <err> and <str> copy
4377 * memory area using free()
4378 */
4379int list_append_word(struct list *li, const char *str, char **err)
4380{
4381 struct wordlist *wl;
4382
4383 wl = calloc(1, sizeof(*wl));
4384 if (!wl) {
4385 memprintf(err, "out of memory");
4386 goto fail_wl;
4387 }
4388
4389 wl->s = strdup(str);
4390 if (!wl->s) {
4391 memprintf(err, "out of memory");
4392 goto fail_wl_s;
4393 }
4394
4395 LIST_ADDQ(li, &wl->list);
4396
4397 return 1;
4398
4399fail_wl_s:
4400 free(wl->s);
4401fail_wl:
4402 free(wl);
4403 return 0;
4404}
4405
Willy Tarreau37101052019-05-20 16:48:20 +02004406/* indicates if a memory location may safely be read or not. The trick consists
4407 * in performing a harmless syscall using this location as an input and letting
4408 * the operating system report whether it's OK or not. For this we have the
4409 * stat() syscall, which will return EFAULT when the memory location supposed
4410 * to contain the file name is not readable. If it is readable it will then
4411 * either return 0 if the area contains an existing file name, or -1 with
4412 * another code. This must not be abused, and some audit systems might detect
4413 * this as abnormal activity. It's used only for unsafe dumps.
4414 */
4415int may_access(const void *ptr)
4416{
4417 struct stat buf;
4418
4419 if (stat(ptr, &buf) == 0)
4420 return 1;
4421 if (errno == EFAULT)
4422 return 0;
4423 return 1;
4424}
4425
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004426/* print a string of text buffer to <out>. The format is :
4427 * Non-printable chars \t, \n, \r and \e are * encoded in C format.
4428 * Other non-printable chars are encoded "\xHH". Space, '\', and '=' are also escaped.
4429 * Print stopped if null char or <bsize> is reached, or if no more place in the chunk.
4430 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004431int dump_text(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004432{
4433 unsigned char c;
4434 int ptr = 0;
4435
4436 while (buf[ptr] && ptr < bsize) {
4437 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004438 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\' && c != ' ' && c != '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004439 if (out->data > out->size - 1)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004440 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004441 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004442 }
4443 else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\' || c == ' ' || c == '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004444 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004445 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004446 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004447 switch (c) {
4448 case ' ': c = ' '; break;
4449 case '\t': c = 't'; break;
4450 case '\n': c = 'n'; break;
4451 case '\r': c = 'r'; break;
4452 case '\e': c = 'e'; break;
4453 case '\\': c = '\\'; 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 }
4458 else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004459 if (out->data > out->size - 4)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004460 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004461 out->area[out->data++] = '\\';
4462 out->area[out->data++] = 'x';
4463 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4464 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004465 }
4466 ptr++;
4467 }
4468
4469 return ptr;
4470}
4471
4472/* print a buffer in hexa.
4473 * Print stopped if <bsize> is reached, or if no more place in the chunk.
4474 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004475int dump_binary(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004476{
4477 unsigned char c;
4478 int ptr = 0;
4479
4480 while (ptr < bsize) {
4481 c = buf[ptr];
4482
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004483 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004484 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004485 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4486 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004487
4488 ptr++;
4489 }
4490 return ptr;
4491}
4492
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004493/* Appends into buffer <out> a hex dump of memory area <buf> for <len> bytes,
4494 * prepending each line with prefix <pfx>. The output is *not* initialized.
4495 * The output will not wrap pas the buffer's end so it is more optimal if the
4496 * caller makes sure the buffer is aligned first. A trailing zero will always
4497 * be appended (and not counted) if there is room for it. The caller must make
Willy Tarreau37101052019-05-20 16:48:20 +02004498 * sure that the area is dumpable first. If <unsafe> is non-null, the memory
4499 * locations are checked first for being readable.
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004500 */
Willy Tarreau37101052019-05-20 16:48:20 +02004501void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe)
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004502{
4503 const unsigned char *d = buf;
4504 int i, j, start;
4505
4506 d = (const unsigned char *)(((unsigned long)buf) & -16);
4507 start = ((unsigned long)buf) & 15;
4508
4509 for (i = 0; i < start + len; i += 16) {
4510 chunk_appendf(out, (sizeof(void *) == 4) ? "%s%8p: " : "%s%16p: ", pfx, d + i);
4511
Willy Tarreau37101052019-05-20 16:48:20 +02004512 // 0: unchecked, 1: checked safe, 2: danger
4513 unsafe = !!unsafe;
4514 if (unsafe && !may_access(d + i))
4515 unsafe = 2;
4516
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004517 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004518 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004519 chunk_strcat(out, "'' ");
Willy Tarreau37101052019-05-20 16:48:20 +02004520 else if (unsafe > 1)
4521 chunk_strcat(out, "** ");
4522 else
4523 chunk_appendf(out, "%02x ", d[i + j]);
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004524
4525 if (j == 7)
4526 chunk_strcat(out, "- ");
4527 }
4528 chunk_strcat(out, " ");
4529 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004530 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004531 chunk_strcat(out, "'");
Willy Tarreau37101052019-05-20 16:48:20 +02004532 else if (unsafe > 1)
4533 chunk_strcat(out, "*");
Willy Tarreau90807112020-02-25 08:16:33 +01004534 else if (isprint((unsigned char)d[i + j]))
Willy Tarreau37101052019-05-20 16:48:20 +02004535 chunk_appendf(out, "%c", d[i + j]);
4536 else
4537 chunk_strcat(out, ".");
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004538 }
4539 chunk_strcat(out, "\n");
4540 }
4541}
4542
Willy Tarreau762fb3e2020-03-03 15:57:10 +01004543/* dumps <pfx> followed by <n> bytes from <addr> in hex form into buffer <buf>
4544 * enclosed in brackets after the address itself, formatted on 14 chars
4545 * including the "0x" prefix. This is meant to be used as a prefix for code
4546 * areas. For example:
4547 * "0x7f10b6557690 [48 c7 c0 0f 00 00 00 0f]"
4548 * It relies on may_access() to know if the bytes are dumpable, otherwise "--"
4549 * is emitted. A NULL <pfx> will be considered empty.
4550 */
4551void dump_addr_and_bytes(struct buffer *buf, const char *pfx, const void *addr, int n)
4552{
4553 int ok = 0;
4554 int i;
4555
4556 chunk_appendf(buf, "%s%#14lx [", pfx ? pfx : "", (long)addr);
4557
4558 for (i = 0; i < n; i++) {
4559 if (i == 0 || (((long)(addr + i) ^ (long)(addr)) & 4096))
4560 ok = may_access(addr + i);
4561 if (ok)
4562 chunk_appendf(buf, "%02x%s", ((uint8_t*)addr)[i], (i<n-1) ? " " : "]");
4563 else
4564 chunk_appendf(buf, "--%s", (i<n-1) ? " " : "]");
4565 }
4566}
4567
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004568/* print a line of text buffer (limited to 70 bytes) to <out>. The format is :
4569 * <2 spaces> <offset=5 digits> <space or plus> <space> <70 chars max> <\n>
4570 * which is 60 chars per line. Non-printable chars \t, \n, \r and \e are
4571 * encoded in C format. Other non-printable chars are encoded "\xHH". Original
4572 * lines are respected within the limit of 70 output chars. Lines that are
4573 * continuation of a previous truncated line begin with "+" instead of " "
4574 * after the offset. The new pointer is returned.
4575 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004576int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004577 int *line, int ptr)
4578{
4579 int end;
4580 unsigned char c;
4581
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004582 end = out->data + 80;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004583 if (end > out->size)
4584 return ptr;
4585
4586 chunk_appendf(out, " %05d%c ", ptr, (ptr == *line) ? ' ' : '+');
4587
4588 while (ptr < len && ptr < bsize) {
4589 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004590 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004591 if (out->data > end - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004592 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004593 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004594 } else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004595 if (out->data > end - 3)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004596 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004597 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004598 switch (c) {
4599 case '\t': c = 't'; break;
4600 case '\n': c = 'n'; break;
4601 case '\r': c = 'r'; break;
4602 case '\e': c = 'e'; break;
4603 case '\\': c = '\\'; break;
4604 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004605 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004606 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004607 if (out->data > end - 5)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004608 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004609 out->area[out->data++] = '\\';
4610 out->area[out->data++] = 'x';
4611 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4612 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004613 }
4614 if (buf[ptr++] == '\n') {
4615 /* we had a line break, let's return now */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004616 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004617 *line = ptr;
4618 return ptr;
4619 }
4620 }
4621 /* we have an incomplete line, we return it as-is */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004622 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004623 return ptr;
4624}
4625
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004626/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02004627 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
4628 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004629 */
Willy Tarreaued936c52017-04-27 18:03:20 +02004630void debug_hexdump(FILE *out, const char *pfx, const char *buf,
4631 unsigned int baseaddr, int len)
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004632{
Willy Tarreau73459792017-04-11 07:58:08 +02004633 unsigned int i;
4634 int b, j;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004635
4636 for (i = 0; i < (len + (baseaddr & 15)); i += 16) {
4637 b = i - (baseaddr & 15);
Willy Tarreaued936c52017-04-27 18:03:20 +02004638 fprintf(out, "%s%08x: ", pfx ? pfx : "", i + (baseaddr & ~15));
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004639 for (j = 0; j < 8; j++) {
4640 if (b + j >= 0 && b + j < len)
4641 fprintf(out, "%02x ", (unsigned char)buf[b + j]);
4642 else
4643 fprintf(out, " ");
4644 }
4645
4646 if (b + j >= 0 && b + j < len)
4647 fputc('-', out);
4648 else
4649 fputc(' ', out);
4650
4651 for (j = 8; j < 16; j++) {
4652 if (b + j >= 0 && b + j < len)
4653 fprintf(out, " %02x", (unsigned char)buf[b + j]);
4654 else
4655 fprintf(out, " ");
4656 }
4657
4658 fprintf(out, " ");
4659 for (j = 0; j < 16; j++) {
4660 if (b + j >= 0 && b + j < len) {
4661 if (isprint((unsigned char)buf[b + j]))
4662 fputc((unsigned char)buf[b + j], out);
4663 else
4664 fputc('.', out);
4665 }
4666 else
4667 fputc(' ', out);
4668 }
4669 fputc('\n', out);
4670 }
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004671}
4672
Willy Tarreaubb869862020-04-16 10:52:41 +02004673/* Tries to report the executable path name on platforms supporting this. If
4674 * not found or not possible, returns NULL.
4675 */
4676const char *get_exec_path()
4677{
4678 const char *ret = NULL;
4679
4680#if (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
4681 long execfn = getauxval(AT_EXECFN);
4682
4683 if (execfn && execfn != ENOENT)
4684 ret = (const char *)execfn;
4685#endif
4686 return ret;
4687}
4688
Baruch Siache1651b22020-07-24 07:52:20 +03004689#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreau9133e482020-03-04 10:19:36 +01004690/* calls dladdr() or dladdr1() on <addr> and <dli>. If dladdr1 is available,
4691 * also returns the symbol size in <size>, otherwise returns 0 there.
4692 */
4693static int dladdr_and_size(const void *addr, Dl_info *dli, size_t *size)
4694{
4695 int ret;
Willy Tarreau62af9c82020-03-10 07:51:48 +01004696#if (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 3)) // most detailed one
Willy Tarreau9133e482020-03-04 10:19:36 +01004697 const ElfW(Sym) *sym;
4698
4699 ret = dladdr1(addr, dli, (void **)&sym, RTLD_DL_SYMENT);
4700 if (ret)
4701 *size = sym ? sym->st_size : 0;
4702#else
4703 ret = dladdr(addr, dli);
4704 *size = 0;
4705#endif
4706 return ret;
4707}
4708#endif
4709
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004710/* Tries to append to buffer <buf> some indications about the symbol at address
4711 * <addr> using the following form:
4712 * lib:+0xoffset (unresolvable address from lib's base)
4713 * main+0xoffset (unresolvable address from main (+/-))
4714 * lib:main+0xoffset (unresolvable lib address from main (+/-))
4715 * name (resolved exact exec address)
4716 * lib:name (resolved exact lib address)
4717 * name+0xoffset/0xsize (resolved address within exec symbol)
4718 * lib:name+0xoffset/0xsize (resolved address within lib symbol)
4719 *
4720 * The file name (lib or executable) is limited to what lies between the last
4721 * '/' and the first following '.'. An optional prefix <pfx> is prepended before
4722 * 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 +03004723 * that contains the "main" symbol, or when __ELF__ && USE_DL are not set.
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004724 *
4725 * The symbol's base address is returned, or NULL when unresolved, in order to
4726 * allow the caller to match it against known ones.
4727 */
Willy Tarreau45fd1032021-01-20 14:37:59 +01004728const void *resolve_sym_name(struct buffer *buf, const char *pfx, const void *addr)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004729{
4730 const struct {
4731 const void *func;
4732 const char *name;
4733 } fcts[] = {
4734 { .func = process_stream, .name = "process_stream" },
4735 { .func = task_run_applet, .name = "task_run_applet" },
4736 { .func = si_cs_io_cb, .name = "si_cs_io_cb" },
Willy Tarreau586f71b2020-12-11 15:54:36 +01004737 { .func = sock_conn_iocb, .name = "sock_conn_iocb" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004738 { .func = dgram_fd_handler, .name = "dgram_fd_handler" },
4739 { .func = listener_accept, .name = "listener_accept" },
Willy Tarreaud597ec22021-01-29 14:29:06 +01004740 { .func = manage_global_listener_queue, .name = "manage_global_listener_queue" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004741 { .func = poller_pipe_io_handler, .name = "poller_pipe_io_handler" },
4742 { .func = mworker_accept_wrapper, .name = "mworker_accept_wrapper" },
Willy Tarreau02922e12021-01-29 12:27:57 +01004743 { .func = session_expire_embryonic, .name = "session_expire_embryonic" },
Willy Tarreaufb5401f2021-01-29 12:25:23 +01004744#ifdef USE_THREAD
4745 { .func = accept_queue_process, .name = "accept_queue_process" },
4746#endif
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004747#ifdef USE_LUA
4748 { .func = hlua_process_task, .name = "hlua_process_task" },
4749#endif
Ilya Shipitsinbdec3ba2020-11-14 01:56:34 +05004750#ifdef SSL_MODE_ASYNC
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004751 { .func = ssl_async_fd_free, .name = "ssl_async_fd_free" },
4752 { .func = ssl_async_fd_handler, .name = "ssl_async_fd_handler" },
4753#endif
4754 };
4755
Baruch Siache1651b22020-07-24 07:52:20 +03004756#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004757 Dl_info dli, dli_main;
Willy Tarreau9133e482020-03-04 10:19:36 +01004758 size_t size;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004759 const char *fname, *p;
4760#endif
4761 int i;
4762
4763 if (pfx)
4764 chunk_appendf(buf, "%s", pfx);
4765
4766 for (i = 0; i < sizeof(fcts) / sizeof(fcts[0]); i++) {
4767 if (addr == fcts[i].func) {
4768 chunk_appendf(buf, "%s", fcts[i].name);
4769 return addr;
4770 }
4771 }
4772
Baruch Siache1651b22020-07-24 07:52:20 +03004773#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004774 /* Now let's try to be smarter */
Willy Tarreau9133e482020-03-04 10:19:36 +01004775 if (!dladdr_and_size(addr, &dli, &size))
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004776 goto unknown;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004777
4778 /* 1. prefix the library name if it's not the same object as the one
4779 * that contains the main function. The name is picked between last '/'
4780 * and first following '.'.
4781 */
4782 if (!dladdr(main, &dli_main))
4783 dli_main.dli_fbase = NULL;
4784
4785 if (dli_main.dli_fbase != dli.dli_fbase) {
4786 fname = dli.dli_fname;
4787 p = strrchr(fname, '/');
4788 if (p++)
4789 fname = p;
4790 p = strchr(fname, '.');
4791 if (!p)
4792 p = fname + strlen(fname);
4793
4794 chunk_appendf(buf, "%.*s:", (int)(long)(p - fname), fname);
4795 }
4796
4797 /* 2. symbol name */
4798 if (dli.dli_sname) {
4799 /* known, dump it and return symbol's address (exact or relative) */
4800 chunk_appendf(buf, "%s", dli.dli_sname);
4801 if (addr != dli.dli_saddr) {
4802 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_saddr));
Willy Tarreau9133e482020-03-04 10:19:36 +01004803 if (size)
4804 chunk_appendf(buf, "/%#lx", (long)size);
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004805 }
4806 return dli.dli_saddr;
4807 }
4808 else if (dli_main.dli_fbase != dli.dli_fbase) {
4809 /* unresolved symbol from a known library, report relative offset */
4810 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_fbase));
4811 return NULL;
4812 }
Baruch Siache1651b22020-07-24 07:52:20 +03004813#endif /* __ELF__ && !__linux__ || USE_DL */
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004814 unknown:
4815 /* unresolved symbol from the main file, report relative offset to main */
4816 if ((void*)addr < (void*)main)
4817 chunk_appendf(buf, "main-%#lx", (long)((void*)main - addr));
4818 else
4819 chunk_appendf(buf, "main+%#lx", (long)(addr - (void*)main));
4820 return NULL;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004821}
4822
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004823/*
4824 * Allocate an array of unsigned int with <nums> as address from <str> string
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05004825 * made of integer separated by dot characters.
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004826 *
4827 * First, initializes the value with <sz> as address to 0 and initializes the
4828 * array with <nums> as address to NULL. Then allocates the array with <nums> as
4829 * address updating <sz> pointed value to the size of this array.
4830 *
4831 * Returns 1 if succeeded, 0 if not.
4832 */
4833int parse_dotted_uints(const char *str, unsigned int **nums, size_t *sz)
4834{
4835 unsigned int *n;
4836 const char *s, *end;
4837
4838 s = str;
4839 *sz = 0;
4840 end = str + strlen(str);
4841 *nums = n = NULL;
4842
4843 while (1) {
4844 unsigned int r;
4845
4846 if (s >= end)
4847 break;
4848
4849 r = read_uint(&s, end);
4850 /* Expected characters after having read an uint: '\0' or '.',
4851 * if '.', must not be terminal.
4852 */
Christopher Faulet4b524122021-02-11 10:42:41 +01004853 if (*s != '\0'&& (*s++ != '.' || s == end)) {
4854 free(n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004855 return 0;
Christopher Faulet4b524122021-02-11 10:42:41 +01004856 }
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004857
Frédéric Lécaille12a71842019-02-26 18:19:48 +01004858 n = my_realloc2(n, (*sz + 1) * sizeof *n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01004859 if (!n)
4860 return 0;
4861
4862 n[(*sz)++] = r;
4863 }
4864 *nums = n;
4865
4866 return 1;
4867}
4868
Willy Tarreau4d589e72019-08-23 19:02:26 +02004869
4870/* returns the number of bytes needed to encode <v> as a varint. An inline
4871 * version exists for use with constants (__varint_bytes()).
4872 */
4873int varint_bytes(uint64_t v)
4874{
4875 int len = 1;
4876
4877 if (v >= 240) {
4878 v = (v - 240) >> 4;
4879 while (1) {
4880 len++;
4881 if (v < 128)
4882 break;
4883 v = (v - 128) >> 7;
4884 }
4885 }
4886 return len;
4887}
4888
Willy Tarreau52bf8392020-03-08 00:42:37 +01004889
4890/* Random number generator state, see below */
Willy Tarreau1544c142020-03-12 00:31:18 +01004891static uint64_t ha_random_state[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01004892
4893/* This is a thread-safe implementation of xoroshiro128** described below:
4894 * http://prng.di.unimi.it/
4895 * It features a 2^128 long sequence, returns 64 high-quality bits on each call,
4896 * supports fast jumps and passes all common quality tests. It is thread-safe,
4897 * uses a double-cas on 64-bit architectures supporting it, and falls back to a
4898 * local lock on other ones.
4899 */
4900uint64_t ha_random64()
4901{
4902 uint64_t result;
Willy Tarreau1544c142020-03-12 00:31:18 +01004903 uint64_t old[2] ALIGNED(2*sizeof(uint64_t));
4904 uint64_t new[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01004905
4906#if defined(USE_THREAD) && (!defined(HA_CAS_IS_8B) || !defined(HA_HAVE_CAS_DW))
4907 static HA_SPINLOCK_T rand_lock;
4908
4909 HA_SPIN_LOCK(OTHER_LOCK, &rand_lock);
4910#endif
4911
4912 old[0] = ha_random_state[0];
4913 old[1] = ha_random_state[1];
4914
4915#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
4916 do {
4917#endif
4918 result = rotl64(old[0] * 5, 7) * 9;
4919 new[1] = old[0] ^ old[1];
4920 new[0] = rotl64(old[0], 24) ^ new[1] ^ (new[1] << 16); // a, b
4921 new[1] = rotl64(new[1], 37); // c
4922
4923#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
4924 } while (unlikely(!_HA_ATOMIC_DWCAS(ha_random_state, old, new)));
4925#else
4926 ha_random_state[0] = new[0];
4927 ha_random_state[1] = new[1];
4928#if defined(USE_THREAD)
4929 HA_SPIN_UNLOCK(OTHER_LOCK, &rand_lock);
4930#endif
4931#endif
4932 return result;
4933}
4934
4935/* seeds the random state using up to <len> bytes from <seed>, starting with
4936 * the first non-zero byte.
4937 */
4938void ha_random_seed(const unsigned char *seed, size_t len)
4939{
4940 size_t pos;
4941
4942 /* the seed must not be all zeroes, so we pre-fill it with alternating
4943 * bits and overwrite part of them with the block starting at the first
4944 * non-zero byte from the seed.
4945 */
4946 memset(ha_random_state, 0x55, sizeof(ha_random_state));
4947
4948 for (pos = 0; pos < len; pos++)
4949 if (seed[pos] != 0)
4950 break;
4951
4952 if (pos == len)
4953 return;
4954
4955 seed += pos;
4956 len -= pos;
4957
4958 if (len > sizeof(ha_random_state))
4959 len = sizeof(ha_random_state);
4960
4961 memcpy(ha_random_state, seed, len);
4962}
4963
4964/* This causes a jump to (dist * 2^96) places in the pseudo-random sequence,
4965 * and is equivalent to calling ha_random64() as many times. It is used to
4966 * provide non-overlapping sequences of 2^96 numbers (~7*10^28) to up to 2^32
4967 * different generators (i.e. different processes after a fork). The <dist>
4968 * argument is the distance to jump to and is used in a loop so it rather not
4969 * be too large if the processing time is a concern.
4970 *
4971 * BEWARE: this function is NOT thread-safe and must not be called during
4972 * concurrent accesses to ha_random64().
4973 */
4974void ha_random_jump96(uint32_t dist)
4975{
4976 while (dist--) {
4977 uint64_t s0 = 0;
4978 uint64_t s1 = 0;
4979 int b;
4980
4981 for (b = 0; b < 64; b++) {
4982 if ((0xd2a98b26625eee7bULL >> b) & 1) {
4983 s0 ^= ha_random_state[0];
4984 s1 ^= ha_random_state[1];
4985 }
4986 ha_random64();
4987 }
4988
4989 for (b = 0; b < 64; b++) {
4990 if ((0xdddf9b1090aa7ac1ULL >> b) & 1) {
4991 s0 ^= ha_random_state[0];
4992 s1 ^= ha_random_state[1];
4993 }
4994 ha_random64();
4995 }
4996 ha_random_state[0] = s0;
4997 ha_random_state[1] = s1;
4998 }
4999}
5000
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01005001/* Generates an RFC4122 UUID into chunk <output> which must be at least 37
5002 * bytes large.
5003 */
5004void ha_generate_uuid(struct buffer *output)
5005{
5006 uint32_t rnd[4];
5007 uint64_t last;
5008
5009 last = ha_random64();
5010 rnd[0] = last;
5011 rnd[1] = last >> 32;
5012
5013 last = ha_random64();
5014 rnd[2] = last;
5015 rnd[3] = last >> 32;
5016
5017 chunk_printf(output, "%8.8x-%4.4x-%4.4x-%4.4x-%12.12llx",
5018 rnd[0],
5019 rnd[1] & 0xFFFF,
5020 ((rnd[1] >> 16u) & 0xFFF) | 0x4000, // highest 4 bits indicate the uuid version
5021 (rnd[2] & 0x3FFF) | 0x8000, // the highest 2 bits indicate the UUID variant (10),
5022 (long long)((rnd[2] >> 14u) | ((uint64_t) rnd[3] << 18u)) & 0xFFFFFFFFFFFFull);
5023}
5024
5025
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005026/* only used by parse_line() below. It supports writing in place provided that
5027 * <in> is updated to the next location before calling it. In that case, the
5028 * char at <in> may be overwritten.
5029 */
5030#define EMIT_CHAR(x) \
5031 do { \
5032 char __c = (char)(x); \
5033 if ((opts & PARSE_OPT_INPLACE) && out+outpos > in) \
5034 err |= PARSE_ERR_OVERLAP; \
5035 if (outpos >= outmax) \
5036 err |= PARSE_ERR_TOOLARGE; \
5037 if (!err) \
5038 out[outpos] = __c; \
5039 outpos++; \
5040 } while (0)
5041
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05005042/* Parse <in>, copy it into <out> split into isolated words whose pointers
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005043 * are put in <args>. If more than <outlen> bytes have to be emitted, the
5044 * extraneous ones are not emitted but <outlen> is updated so that the caller
5045 * knows how much to realloc. Similarly, <args> are not updated beyond <nbargs>
5046 * but the returned <nbargs> indicates how many were found. All trailing args
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005047 * up to <nbargs> point to the trailing zero, and as long as <nbargs> is > 0,
5048 * it is guaranteed that at least one arg will point to the zero. It is safe
5049 * to call it with a NULL <args> if <nbargs> is 0.
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005050 *
5051 * <out> may overlap with <in> provided that it never goes further, in which
5052 * case the parser will accept to perform in-place parsing and unquoting/
5053 * unescaping but only if environment variables do not lead to expansion that
5054 * causes overlapping, otherwise the input string being destroyed, the error
5055 * will not be recoverable. Note that even during out-of-place <in> will
5056 * experience temporary modifications in-place for variable resolution and must
5057 * be writable, and will also receive zeroes to delimit words when using
5058 * in-place copy. Parsing options <opts> taken from PARSE_OPT_*. Return value
5059 * is zero on success otherwise a bitwise-or of PARSE_ERR_*. Upon error, the
5060 * starting point of the first invalid character sequence or unmatched
5061 * quote/brace is reported in <errptr> if not NULL. When using in-place parsing
5062 * error reporting might be difficult since zeroes will have been inserted into
5063 * the string. One solution for the caller may consist in replacing all args
5064 * delimiters with spaces in this case.
5065 */
5066uint32_t parse_line(char *in, char *out, size_t *outlen, char **args, int *nbargs, uint32_t opts, char **errptr)
5067{
5068 char *quote = NULL;
5069 char *brace = NULL;
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005070 char *word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005071 unsigned char hex1, hex2;
5072 size_t outmax = *outlen;
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005073 int argsmax = *nbargs - 1;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005074 size_t outpos = 0;
5075 int squote = 0;
5076 int dquote = 0;
5077 int arg = 0;
5078 uint32_t err = 0;
5079
5080 *nbargs = 0;
5081 *outlen = 0;
5082
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005083 /* argsmax may be -1 here, protecting args[] from any write */
5084 if (arg < argsmax)
5085 args[arg] = out;
5086
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005087 while (1) {
5088 if (*in >= '-' && *in != '\\') {
5089 /* speedup: directly send all regular chars starting
5090 * with '-', '.', '/', alnum etc...
5091 */
5092 EMIT_CHAR(*in++);
5093 continue;
5094 }
5095 else if (*in == '\0' || *in == '\n' || *in == '\r') {
5096 /* end of line */
5097 break;
5098 }
5099 else if (*in == '#' && (opts & PARSE_OPT_SHARP) && !squote && !dquote) {
5100 /* comment */
5101 break;
5102 }
5103 else if (*in == '"' && !squote && (opts & PARSE_OPT_DQUOTE)) { /* double quote outside single quotes */
5104 if (dquote) {
5105 dquote = 0;
5106 quote = NULL;
5107 }
5108 else {
5109 dquote = 1;
5110 quote = in;
5111 }
5112 in++;
5113 continue;
5114 }
5115 else if (*in == '\'' && !dquote && (opts & PARSE_OPT_SQUOTE)) { /* single quote outside double quotes */
5116 if (squote) {
5117 squote = 0;
5118 quote = NULL;
5119 }
5120 else {
5121 squote = 1;
5122 quote = in;
5123 }
5124 in++;
5125 continue;
5126 }
5127 else if (*in == '\\' && !squote && (opts & PARSE_OPT_BKSLASH)) {
5128 /* first, we'll replace \\, \<space>, \#, \r, \n, \t, \xXX with their
5129 * C equivalent value but only when they have a special meaning and within
5130 * double quotes for some of them. Other combinations left unchanged (eg: \1).
5131 */
5132 char tosend = *in;
5133
5134 switch (in[1]) {
5135 case ' ':
5136 case '\\':
5137 tosend = in[1];
5138 in++;
5139 break;
5140
5141 case 't':
5142 tosend = '\t';
5143 in++;
5144 break;
5145
5146 case 'n':
5147 tosend = '\n';
5148 in++;
5149 break;
5150
5151 case 'r':
5152 tosend = '\r';
5153 in++;
5154 break;
5155
5156 case '#':
5157 /* escaping of "#" only if comments are supported */
5158 if (opts & PARSE_OPT_SHARP)
5159 in++;
5160 tosend = *in;
5161 break;
5162
5163 case '\'':
5164 /* escaping of "'" only outside single quotes and only if single quotes are supported */
5165 if (opts & PARSE_OPT_SQUOTE && !squote)
5166 in++;
5167 tosend = *in;
5168 break;
5169
5170 case '"':
5171 /* escaping of '"' only outside single quotes and only if double quotes are supported */
5172 if (opts & PARSE_OPT_DQUOTE && !squote)
5173 in++;
5174 tosend = *in;
5175 break;
5176
5177 case '$':
5178 /* escaping of '$' only inside double quotes and only if env supported */
5179 if (opts & PARSE_OPT_ENV && dquote)
5180 in++;
5181 tosend = *in;
5182 break;
5183
5184 case 'x':
5185 if (!ishex(in[2]) || !ishex(in[3])) {
5186 /* invalid or incomplete hex sequence */
5187 err |= PARSE_ERR_HEX;
5188 if (errptr)
5189 *errptr = in;
5190 goto leave;
5191 }
Willy Tarreauf278eec2020-07-05 21:46:32 +02005192 hex1 = toupper((unsigned char)in[2]) - '0';
5193 hex2 = toupper((unsigned char)in[3]) - '0';
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005194 if (hex1 > 9) hex1 -= 'A' - '9' - 1;
5195 if (hex2 > 9) hex2 -= 'A' - '9' - 1;
5196 tosend = (hex1 << 4) + hex2;
5197 in += 3;
5198 break;
5199
5200 default:
5201 /* other combinations are not escape sequences */
5202 break;
5203 }
5204
5205 in++;
5206 EMIT_CHAR(tosend);
5207 }
5208 else if (isspace((unsigned char)*in) && !squote && !dquote) {
5209 /* a non-escaped space is an argument separator */
5210 while (isspace((unsigned char)*in))
5211 in++;
5212 EMIT_CHAR(0);
5213 arg++;
5214 if (arg < argsmax)
5215 args[arg] = out + outpos;
5216 else
5217 err |= PARSE_ERR_TOOMANY;
5218 }
5219 else if (*in == '$' && (opts & PARSE_OPT_ENV) && (dquote || !(opts & PARSE_OPT_DQUOTE))) {
5220 /* environment variables are evaluated anywhere, or only
5221 * inside double quotes if they are supported.
5222 */
5223 char *var_name;
5224 char save_char;
5225 char *value;
5226
5227 in++;
5228
5229 if (*in == '{')
5230 brace = in++;
5231
5232 if (!isalpha((unsigned char)*in) && *in != '_') {
5233 /* unacceptable character in variable name */
5234 err |= PARSE_ERR_VARNAME;
5235 if (errptr)
5236 *errptr = in;
5237 goto leave;
5238 }
5239
5240 var_name = in;
5241 while (isalnum((unsigned char)*in) || *in == '_')
5242 in++;
5243
5244 save_char = *in;
5245 *in = '\0';
5246 value = getenv(var_name);
5247 *in = save_char;
5248
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005249 /* support for '[*]' sequence to force word expansion,
5250 * only available inside braces */
5251 if (*in == '[' && brace && (opts & PARSE_OPT_WORD_EXPAND)) {
5252 word_expand = in++;
5253
5254 if (*in++ != '*' || *in++ != ']') {
5255 err |= PARSE_ERR_WRONG_EXPAND;
5256 if (errptr)
5257 *errptr = word_expand;
5258 goto leave;
5259 }
5260 }
5261
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005262 if (brace) {
5263 if (*in != '}') {
5264 /* unmatched brace */
5265 err |= PARSE_ERR_BRACE;
5266 if (errptr)
5267 *errptr = brace;
5268 goto leave;
5269 }
5270 in++;
5271 brace = NULL;
5272 }
5273
5274 if (value) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005275 while (*value) {
5276 /* expand as individual parameters on a space character */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005277 if (word_expand && isspace((unsigned char)*value)) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005278 EMIT_CHAR(0);
5279 ++arg;
5280 if (arg < argsmax)
5281 args[arg] = out + outpos;
5282 else
5283 err |= PARSE_ERR_TOOMANY;
5284
5285 /* skip consecutive spaces */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005286 while (isspace((unsigned char)*++value))
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005287 ;
5288 } else {
5289 EMIT_CHAR(*value++);
5290 }
5291 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005292 }
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005293 word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005294 }
5295 else {
5296 /* any other regular char */
5297 EMIT_CHAR(*in++);
5298 }
5299 }
5300
5301 /* end of output string */
5302 EMIT_CHAR(0);
5303 arg++;
5304
5305 if (quote) {
5306 /* unmatched quote */
5307 err |= PARSE_ERR_QUOTE;
5308 if (errptr)
5309 *errptr = quote;
5310 goto leave;
5311 }
5312 leave:
5313 *nbargs = arg;
5314 *outlen = outpos;
5315
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005316 /* empty all trailing args by making them point to the trailing zero,
5317 * at least the last one in any case.
5318 */
5319 if (arg > argsmax)
5320 arg = argsmax;
5321
5322 while (arg >= 0 && arg <= argsmax)
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005323 args[arg++] = out + outpos - 1;
5324
5325 return err;
5326}
5327#undef EMIT_CHAR
5328
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005329/* This is used to sanitize an input line that's about to be used for error reporting.
5330 * It will adjust <line> to print approximately <width> chars around <pos>, trying to
5331 * preserve the beginning, with leading or trailing "..." when the line is truncated.
5332 * If non-printable chars are present in the output. It returns the new offset <pos>
5333 * in the modified line. Non-printable characters are replaced with '?'. <width> must
5334 * be at least 6 to support two "..." otherwise the result is undefined. The line
5335 * itself must have at least 7 chars allocated for the same reason.
5336 */
5337size_t sanitize_for_printing(char *line, size_t pos, size_t width)
5338{
5339 size_t shift = 0;
5340 char *out = line;
5341 char *in = line;
5342 char *end = line + width;
5343
5344 if (pos >= width) {
5345 /* if we have to shift, we'll be out of context, so let's
5346 * try to put <pos> at the center of width.
5347 */
5348 shift = pos - width / 2;
5349 in += shift + 3;
5350 end = out + width - 3;
5351 out[0] = out[1] = out[2] = '.';
5352 out += 3;
5353 }
5354
5355 while (out < end && *in) {
5356 if (isspace((unsigned char)*in))
5357 *out++ = ' ';
5358 else if (isprint((unsigned char)*in))
5359 *out++ = *in;
5360 else
5361 *out++ = '?';
5362 in++;
5363 }
5364
5365 if (end < line + width) {
5366 out[0] = out[1] = out[2] = '.';
5367 out += 3;
5368 }
5369
5370 *out++ = 0;
5371 return pos - shift;
5372}
Willy Tarreau06e69b52021-03-02 14:01:35 +01005373
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005374/* Update array <fp> with the fingerprint of word <word> by counting the
Willy Tarreauba2c4452021-03-12 09:01:52 +01005375 * transitions between characters. <fp> is a 1024-entries array indexed as
5376 * 32*from+to. Positions for 'from' and 'to' are:
Willy Tarreau9294e882021-03-15 09:34:27 +01005377 * 1..26=letter, 27=digit, 28=other/begin/end.
5378 * Row "from=0" is used to mark the character's presence. Others unused.
Willy Tarreauba2c4452021-03-12 09:01:52 +01005379 */
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005380void update_word_fingerprint(uint8_t *fp, const char *word)
Willy Tarreauba2c4452021-03-12 09:01:52 +01005381{
5382 const char *p;
5383 int from, to;
5384 int c;
5385
Willy Tarreauba2c4452021-03-12 09:01:52 +01005386 from = 28; // begin
5387 for (p = word; *p; p++) {
5388 c = tolower(*p);
5389 switch(c) {
Willy Tarreau9294e882021-03-15 09:34:27 +01005390 case 'a'...'z': to = c - 'a' + 1; break;
5391 case 'A'...'Z': to = tolower(c) - 'a' + 1; break;
5392 case '0'...'9': to = 27; break;
5393 default: to = 28; break;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005394 }
Willy Tarreau9294e882021-03-15 09:34:27 +01005395 fp[to] = 1;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005396 fp[32 * from + to]++;
5397 from = to;
5398 }
5399 to = 28; // end
5400 fp[32 * from + to]++;
5401}
5402
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005403/* Initialize array <fp> with the fingerprint of word <word> by counting the
5404 * transitions between characters. <fp> is a 1024-entries array indexed as
5405 * 32*from+to. Positions for 'from' and 'to' are:
5406 * 0..25=letter, 26=digit, 27=other, 28=begin, 29=end, others unused.
5407 */
5408void make_word_fingerprint(uint8_t *fp, const char *word)
5409{
5410 memset(fp, 0, 1024);
5411 update_word_fingerprint(fp, word);
5412}
5413
Willy Tarreauba2c4452021-03-12 09:01:52 +01005414/* Return the distance between two word fingerprints created by function
5415 * make_word_fingerprint(). It's a positive integer calculated as the sum of
Willy Tarreau714c4c12021-03-15 09:44:53 +01005416 * the differences between each location.
Willy Tarreauba2c4452021-03-12 09:01:52 +01005417 */
5418int word_fingerprint_distance(const uint8_t *fp1, const uint8_t *fp2)
5419{
5420 int i, k, dist = 0;
5421
5422 for (i = 0; i < 1024; i++) {
5423 k = (int)fp1[i] - (int)fp2[i];
Willy Tarreau714c4c12021-03-15 09:44:53 +01005424 dist += abs(k);
Willy Tarreauba2c4452021-03-12 09:01:52 +01005425 }
5426 return dist;
5427}
5428
Willy Tarreau06e69b52021-03-02 14:01:35 +01005429static int init_tools_per_thread()
5430{
5431 /* Let's make each thread start from a different position */
5432 statistical_prng_state += tid * MAX_THREADS;
5433 if (!statistical_prng_state)
5434 statistical_prng_state++;
5435 return 1;
5436}
5437REGISTER_PER_THREAD_INIT(init_tools_per_thread);
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005438
Willy Tarreaubaaee002006-06-26 02:48:02 +02005439/*
5440 * Local variables:
5441 * c-indent-level: 8
5442 * c-basic-offset: 8
5443 * End:
5444 */