blob: bbd6a76a142b2ae8d579fd68d74169cdbd27e13b [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
devnexen@gmail.com49a32282021-08-17 12:55:49 +010019#if defined(__FreeBSD__)
20#include <elf.h>
21#include <dlfcn.h>
22extern void *__elf_aux_vector;
23#endif
24
David Carlier1b9d57d2021-08-17 08:44:25 +010025#if defined(__NetBSD__)
26#include <sys/exec_elf.h>
27#include <dlfcn.h>
28#endif
29
Willy Tarreau2e74c3f2007-12-02 18:45:09 +010030#include <ctype.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020031#include <errno.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020032#include <netdb.h>
Willy Tarreau9a7bea52012-04-27 11:16:50 +020033#include <stdarg.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020034#include <stdio.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020035#include <stdlib.h>
36#include <string.h>
Thierry Fournier93127942016-01-20 18:49:45 +010037#include <time.h>
Willy Tarreau16e01562016-08-09 16:46:18 +020038#include <unistd.h>
Willy Tarreau127f9662007-12-06 00:53:51 +010039#include <sys/socket.h>
Willy Tarreau37101052019-05-20 16:48:20 +020040#include <sys/stat.h>
41#include <sys/types.h>
Willy Tarreau127f9662007-12-06 00:53:51 +010042#include <sys/un.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020043#include <netinet/in.h>
44#include <arpa/inet.h>
45
Willy Tarreau1ee71dd2021-08-30 10:15:35 +020046#if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
Willy Tarreau30053062020-08-20 16:39:14 +020047#include <sys/auxv.h>
48#endif
49
Willy Tarreau48fbcae2020-06-03 18:09:46 +020050#include <import/eb32sctree.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020051#include <import/eb32tree.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020052
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020053#include <haproxy/api.h>
Willy Tarreauc13ed532020-06-02 10:22:45 +020054#include <haproxy/chunk.h>
Willy Tarreau7c18b542020-06-11 09:23:02 +020055#include <haproxy/dgram.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020056#include <haproxy/global.h>
Willy Tarreau86416052020-06-04 09:20:54 +020057#include <haproxy/hlua.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020058#include <haproxy/listener.h>
Willy Tarreau7a00efb2020-06-02 17:02:59 +020059#include <haproxy/namespace.h>
Christopher Faulet9553de72021-02-26 09:12:50 +010060#include <haproxy/net_helper.h>
Willy Tarreau5fc93282020-09-16 18:25:03 +020061#include <haproxy/protocol.h>
Emeric Brunc9437992021-02-12 19:42:55 +010062#include <haproxy/resolvers.h>
Willy Tarreau586f71b2020-12-11 15:54:36 +010063#include <haproxy/sock.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020064#include <haproxy/ssl_sock.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020065#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020066#include <haproxy/task.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020067#include <haproxy/tools.h>
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +010068
Thierry Fournier93127942016-01-20 18:49:45 +010069/* This macro returns false if the test __x is false. Many
70 * of the following parsing function must be abort the processing
71 * if it returns 0, so this macro is useful for writing light code.
72 */
73#define RET0_UNLESS(__x) do { if (!(__x)) return 0; } while (0)
74
Willy Tarreau56adcf22012-12-23 18:00:29 +010075/* enough to store NB_ITOA_STR integers of :
Willy Tarreau72d759c2007-10-25 12:14:10 +020076 * 2^64-1 = 18446744073709551615 or
77 * -2^63 = -9223372036854775808
Willy Tarreaue7239b52009-03-29 13:41:58 +020078 *
79 * The HTML version needs room for adding the 25 characters
80 * '<span class="rls"></span>' around digits at positions 3N+1 in order
81 * to add spacing at up to 6 positions : 18 446 744 073 709 551 615
Willy Tarreau72d759c2007-10-25 12:14:10 +020082 */
Christopher Faulet99bca652017-11-14 16:47:26 +010083THREAD_LOCAL char itoa_str[NB_ITOA_STR][171];
84THREAD_LOCAL int itoa_idx = 0; /* index of next itoa_str to use */
Willy Tarreaubaaee002006-06-26 02:48:02 +020085
Willy Tarreau588297f2014-06-16 15:16:40 +020086/* sometimes we'll need to quote strings (eg: in stats), and we don't expect
87 * to quote strings larger than a max configuration line.
88 */
Christopher Faulet99bca652017-11-14 16:47:26 +010089THREAD_LOCAL char quoted_str[NB_QSTR][QSTR_SIZE + 1];
90THREAD_LOCAL int quoted_idx = 0;
Willy Tarreau588297f2014-06-16 15:16:40 +020091
Willy Tarreau06e69b52021-03-02 14:01:35 +010092/* thread-local PRNG state. It's modified to start from a different sequence
93 * on all threads upon startup. It must not be used or anything beyond getting
94 * statistical values as it's 100% predictable.
95 */
96THREAD_LOCAL unsigned int statistical_prng_state = 2463534242U;
97
Willy Tarreaubaaee002006-06-26 02:48:02 +020098/*
William Lallemande7340ec2012-01-24 11:15:39 +010099 * unsigned long long ASCII representation
100 *
101 * return the last char '\0' or NULL if no enough
102 * space in dst
103 */
104char *ulltoa(unsigned long long n, char *dst, size_t size)
105{
106 int i = 0;
107 char *res;
108
109 switch(n) {
110 case 1ULL ... 9ULL:
111 i = 0;
112 break;
113
114 case 10ULL ... 99ULL:
115 i = 1;
116 break;
117
118 case 100ULL ... 999ULL:
119 i = 2;
120 break;
121
122 case 1000ULL ... 9999ULL:
123 i = 3;
124 break;
125
126 case 10000ULL ... 99999ULL:
127 i = 4;
128 break;
129
130 case 100000ULL ... 999999ULL:
131 i = 5;
132 break;
133
134 case 1000000ULL ... 9999999ULL:
135 i = 6;
136 break;
137
138 case 10000000ULL ... 99999999ULL:
139 i = 7;
140 break;
141
142 case 100000000ULL ... 999999999ULL:
143 i = 8;
144 break;
145
146 case 1000000000ULL ... 9999999999ULL:
147 i = 9;
148 break;
149
150 case 10000000000ULL ... 99999999999ULL:
151 i = 10;
152 break;
153
154 case 100000000000ULL ... 999999999999ULL:
155 i = 11;
156 break;
157
158 case 1000000000000ULL ... 9999999999999ULL:
159 i = 12;
160 break;
161
162 case 10000000000000ULL ... 99999999999999ULL:
163 i = 13;
164 break;
165
166 case 100000000000000ULL ... 999999999999999ULL:
167 i = 14;
168 break;
169
170 case 1000000000000000ULL ... 9999999999999999ULL:
171 i = 15;
172 break;
173
174 case 10000000000000000ULL ... 99999999999999999ULL:
175 i = 16;
176 break;
177
178 case 100000000000000000ULL ... 999999999999999999ULL:
179 i = 17;
180 break;
181
182 case 1000000000000000000ULL ... 9999999999999999999ULL:
183 i = 18;
184 break;
185
186 case 10000000000000000000ULL ... ULLONG_MAX:
187 i = 19;
188 break;
189 }
190 if (i + 2 > size) // (i + 1) + '\0'
191 return NULL; // too long
192 res = dst + i + 1;
193 *res = '\0';
194 for (; i >= 0; i--) {
195 dst[i] = n % 10ULL + '0';
196 n /= 10ULL;
197 }
198 return res;
199}
200
201/*
202 * unsigned long ASCII representation
203 *
204 * return the last char '\0' or NULL if no enough
205 * space in dst
206 */
207char *ultoa_o(unsigned long n, char *dst, size_t size)
208{
209 int i = 0;
210 char *res;
211
212 switch (n) {
213 case 0U ... 9UL:
214 i = 0;
215 break;
216
217 case 10U ... 99UL:
218 i = 1;
219 break;
220
221 case 100U ... 999UL:
222 i = 2;
223 break;
224
225 case 1000U ... 9999UL:
226 i = 3;
227 break;
228
229 case 10000U ... 99999UL:
230 i = 4;
231 break;
232
233 case 100000U ... 999999UL:
234 i = 5;
235 break;
236
237 case 1000000U ... 9999999UL:
238 i = 6;
239 break;
240
241 case 10000000U ... 99999999UL:
242 i = 7;
243 break;
244
245 case 100000000U ... 999999999UL:
246 i = 8;
247 break;
248#if __WORDSIZE == 32
249
250 case 1000000000ULL ... ULONG_MAX:
251 i = 9;
252 break;
253
254#elif __WORDSIZE == 64
255
256 case 1000000000ULL ... 9999999999UL:
257 i = 9;
258 break;
259
260 case 10000000000ULL ... 99999999999UL:
261 i = 10;
262 break;
263
264 case 100000000000ULL ... 999999999999UL:
265 i = 11;
266 break;
267
268 case 1000000000000ULL ... 9999999999999UL:
269 i = 12;
270 break;
271
272 case 10000000000000ULL ... 99999999999999UL:
273 i = 13;
274 break;
275
276 case 100000000000000ULL ... 999999999999999UL:
277 i = 14;
278 break;
279
280 case 1000000000000000ULL ... 9999999999999999UL:
281 i = 15;
282 break;
283
284 case 10000000000000000ULL ... 99999999999999999UL:
285 i = 16;
286 break;
287
288 case 100000000000000000ULL ... 999999999999999999UL:
289 i = 17;
290 break;
291
292 case 1000000000000000000ULL ... 9999999999999999999UL:
293 i = 18;
294 break;
295
296 case 10000000000000000000ULL ... ULONG_MAX:
297 i = 19;
298 break;
299
300#endif
301 }
302 if (i + 2 > size) // (i + 1) + '\0'
303 return NULL; // too long
304 res = dst + i + 1;
305 *res = '\0';
306 for (; i >= 0; i--) {
307 dst[i] = n % 10U + '0';
308 n /= 10U;
309 }
310 return res;
311}
312
313/*
314 * signed long ASCII representation
315 *
316 * return the last char '\0' or NULL if no enough
317 * space in dst
318 */
319char *ltoa_o(long int n, char *dst, size_t size)
320{
321 char *pos = dst;
322
323 if (n < 0) {
324 if (size < 3)
325 return NULL; // min size is '-' + digit + '\0' but another test in ultoa
326 *pos = '-';
327 pos++;
328 dst = ultoa_o(-n, pos, size - 1);
329 } else {
330 dst = ultoa_o(n, dst, size);
331 }
332 return dst;
333}
334
335/*
336 * signed long long ASCII representation
337 *
338 * return the last char '\0' or NULL if no enough
339 * space in dst
340 */
341char *lltoa(long long n, char *dst, size_t size)
342{
343 char *pos = dst;
344
345 if (n < 0) {
346 if (size < 3)
347 return NULL; // min size is '-' + digit + '\0' but another test in ulltoa
348 *pos = '-';
349 pos++;
350 dst = ulltoa(-n, pos, size - 1);
351 } else {
352 dst = ulltoa(n, dst, size);
353 }
354 return dst;
355}
356
357/*
358 * write a ascii representation of a unsigned into dst,
359 * return a pointer to the last character
360 * Pad the ascii representation with '0', using size.
361 */
362char *utoa_pad(unsigned int n, char *dst, size_t size)
363{
364 int i = 0;
365 char *ret;
366
367 switch(n) {
368 case 0U ... 9U:
369 i = 0;
370 break;
371
372 case 10U ... 99U:
373 i = 1;
374 break;
375
376 case 100U ... 999U:
377 i = 2;
378 break;
379
380 case 1000U ... 9999U:
381 i = 3;
382 break;
383
384 case 10000U ... 99999U:
385 i = 4;
386 break;
387
388 case 100000U ... 999999U:
389 i = 5;
390 break;
391
392 case 1000000U ... 9999999U:
393 i = 6;
394 break;
395
396 case 10000000U ... 99999999U:
397 i = 7;
398 break;
399
400 case 100000000U ... 999999999U:
401 i = 8;
402 break;
403
404 case 1000000000U ... 4294967295U:
405 i = 9;
406 break;
407 }
408 if (i + 2 > size) // (i + 1) + '\0'
409 return NULL; // too long
410 if (i < size)
411 i = size - 2; // padding - '\0'
412
413 ret = dst + i + 1;
414 *ret = '\0';
415 for (; i >= 0; i--) {
416 dst[i] = n % 10U + '0';
417 n /= 10U;
418 }
419 return ret;
420}
421
422/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200423 * copies at most <size-1> chars from <src> to <dst>. Last char is always
424 * set to 0, unless <size> is 0. The number of chars copied is returned
425 * (excluding the terminating zero).
426 * This code has been optimized for size and speed : on x86, it's 45 bytes
427 * long, uses only registers, and consumes only 4 cycles per char.
428 */
429int strlcpy2(char *dst, const char *src, int size)
430{
431 char *orig = dst;
432 if (size) {
433 while (--size && (*dst = *src)) {
434 src++; dst++;
435 }
436 *dst = 0;
437 }
438 return dst - orig;
439}
440
441/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200442 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200443 * the ascii representation for number 'n' in decimal.
444 */
Emeric Brun3a7fce52010-01-04 14:54:38 +0100445char *ultoa_r(unsigned long n, char *buffer, int size)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200446{
447 char *pos;
448
Willy Tarreau72d759c2007-10-25 12:14:10 +0200449 pos = buffer + size - 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200450 *pos-- = '\0';
451
452 do {
453 *pos-- = '0' + n % 10;
454 n /= 10;
Willy Tarreau72d759c2007-10-25 12:14:10 +0200455 } while (n && pos >= buffer);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200456 return pos + 1;
457}
458
Willy Tarreau91092e52007-10-25 16:58:42 +0200459/*
Willy Tarreaue7239b52009-03-29 13:41:58 +0200460 * This function simply returns a locally allocated string containing
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200461 * the ascii representation for number 'n' in decimal.
462 */
463char *lltoa_r(long long int in, char *buffer, int size)
464{
465 char *pos;
466 int neg = 0;
467 unsigned long long int n;
468
469 pos = buffer + size - 1;
470 *pos-- = '\0';
471
472 if (in < 0) {
473 neg = 1;
474 n = -in;
475 }
476 else
477 n = in;
478
479 do {
480 *pos-- = '0' + n % 10;
481 n /= 10;
482 } while (n && pos >= buffer);
483 if (neg && pos > buffer)
484 *pos-- = '-';
485 return pos + 1;
486}
487
488/*
489 * This function simply returns a locally allocated string containing
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200490 * the ascii representation for signed number 'n' in decimal.
491 */
492char *sltoa_r(long n, char *buffer, int size)
493{
494 char *pos;
495
496 if (n >= 0)
497 return ultoa_r(n, buffer, size);
498
499 pos = ultoa_r(-n, buffer + 1, size - 1) - 1;
500 *pos = '-';
501 return pos;
502}
503
504/*
505 * This function simply returns a locally allocated string containing
Willy Tarreaue7239b52009-03-29 13:41:58 +0200506 * the ascii representation for number 'n' in decimal, formatted for
507 * HTML output with tags to create visual grouping by 3 digits. The
508 * output needs to support at least 171 characters.
509 */
510const char *ulltoh_r(unsigned long long n, char *buffer, int size)
511{
512 char *start;
513 int digit = 0;
514
515 start = buffer + size;
516 *--start = '\0';
517
518 do {
519 if (digit == 3 && start >= buffer + 7)
520 memcpy(start -= 7, "</span>", 7);
521
522 if (start >= buffer + 1) {
523 *--start = '0' + n % 10;
524 n /= 10;
525 }
526
527 if (digit == 3 && start >= buffer + 18)
528 memcpy(start -= 18, "<span class=\"rls\">", 18);
529
530 if (digit++ == 3)
531 digit = 1;
532 } while (n && start > buffer);
533 return start;
534}
535
536/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200537 * This function simply returns a locally allocated string containing the ascii
538 * representation for number 'n' in decimal, unless n is 0 in which case it
539 * returns the alternate string (or an empty string if the alternate string is
540 * NULL). It use is intended for limits reported in reports, where it's
541 * desirable not to display anything if there is no limit. Warning! it shares
542 * the same vector as ultoa_r().
543 */
544const char *limit_r(unsigned long n, char *buffer, int size, const char *alt)
545{
546 return (n) ? ultoa_r(n, buffer, size) : (alt ? alt : "");
547}
548
Willy Tarreau56d1d8d2021-05-08 10:28:53 +0200549/* Trims the first "%f" float in a string to its minimum number of digits after
550 * the decimal point by trimming trailing zeroes, even dropping the decimal
551 * point if not needed. The string is in <buffer> of length <len>, and the
552 * number is expected to start at or after position <num_start> (the first
553 * point appearing there is considered). A NUL character is always placed at
554 * the end if some trimming occurs. The new buffer length is returned.
555 */
556size_t flt_trim(char *buffer, size_t num_start, size_t len)
557{
558 char *end = buffer + len;
559 char *p = buffer + num_start;
560 char *trim;
561
562 do {
563 if (p >= end)
564 return len;
565 trim = p++;
566 } while (*trim != '.');
567
568 /* For now <trim> is on the decimal point. Let's look for any other
569 * meaningful digit after it.
570 */
571 while (p < end) {
572 if (*p++ != '0')
573 trim = p;
574 }
575
576 if (trim < end)
577 *trim = 0;
578
579 return trim - buffer;
580}
581
Willy Tarreauae03d262021-05-08 07:35:00 +0200582/*
583 * This function simply returns a locally allocated string containing
584 * the ascii representation for number 'n' in decimal with useless trailing
585 * zeroes trimmed.
586 */
587char *ftoa_r(double n, char *buffer, int size)
588{
589 flt_trim(buffer, 0, snprintf(buffer, size, "%f", n));
590 return buffer;
591}
592
Willy Tarreau588297f2014-06-16 15:16:40 +0200593/* returns a locally allocated string containing the quoted encoding of the
594 * input string. The output may be truncated to QSTR_SIZE chars, but it is
595 * guaranteed that the string will always be properly terminated. Quotes are
596 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
597 * always be at least 4 chars.
598 */
599const char *qstr(const char *str)
600{
601 char *ret = quoted_str[quoted_idx];
602 char *p, *end;
603
604 if (++quoted_idx >= NB_QSTR)
605 quoted_idx = 0;
606
607 p = ret;
608 end = ret + QSTR_SIZE;
609
610 *p++ = '"';
611
612 /* always keep 3 chars to support passing "" and the ending " */
613 while (*str && p < end - 3) {
614 if (*str == '"') {
615 *p++ = '"';
616 *p++ = '"';
617 }
618 else
619 *p++ = *str;
620 str++;
621 }
622 *p++ = '"';
623 return ret;
624}
625
Robert Tsai81ae1952007-12-05 10:47:29 +0100626/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200627 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
628 *
629 * It looks like this one would be a good candidate for inlining, but this is
630 * not interesting because it around 35 bytes long and often called multiple
631 * times within the same function.
632 */
633int ishex(char s)
634{
635 s -= '0';
636 if ((unsigned char)s <= 9)
637 return 1;
638 s -= 'A' - '0';
639 if ((unsigned char)s <= 5)
640 return 1;
641 s -= 'a' - 'A';
642 if ((unsigned char)s <= 5)
643 return 1;
644 return 0;
645}
646
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100647/* rounds <i> down to the closest value having max 2 digits */
648unsigned int round_2dig(unsigned int i)
649{
650 unsigned int mul = 1;
651
652 while (i >= 100) {
653 i /= 10;
654 mul *= 10;
655 }
656 return i * mul;
657}
658
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100659/*
660 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
661 * invalid character is found, a pointer to it is returned. If everything is
662 * fine, NULL is returned.
663 */
664const char *invalid_char(const char *name)
665{
666 if (!*name)
667 return name;
668
669 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100670 if (!isalnum((unsigned char)*name) && *name != '.' && *name != ':' &&
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100671 *name != '_' && *name != '-')
672 return name;
673 name++;
674 }
675 return NULL;
676}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200677
678/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200679 * Checks <name> for invalid characters. Valid chars are [_.-] and those
680 * accepted by <f> function.
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200681 * If an invalid character is found, a pointer to it is returned.
682 * If everything is fine, NULL is returned.
683 */
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200684static inline const char *__invalid_char(const char *name, int (*f)(int)) {
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200685
686 if (!*name)
687 return name;
688
689 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100690 if (!f((unsigned char)*name) && *name != '.' &&
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200691 *name != '_' && *name != '-')
692 return name;
693
694 name++;
695 }
696
697 return NULL;
698}
699
700/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200701 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
702 * If an invalid character is found, a pointer to it is returned.
703 * If everything is fine, NULL is returned.
704 */
705const char *invalid_domainchar(const char *name) {
706 return __invalid_char(name, isalnum);
707}
708
709/*
710 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
711 * If an invalid character is found, a pointer to it is returned.
712 * If everything is fine, NULL is returned.
713 */
714const char *invalid_prefix_char(const char *name) {
Thierry Fournierf7b7c3e2018-03-26 11:54:39 +0200715 return __invalid_char(name, isalnum);
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200716}
717
718/*
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100719 * converts <str> to a struct sockaddr_storage* provided by the caller. The
Willy Tarreau24709282013-03-10 21:32:12 +0100720 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
721 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
722 * the function tries to guess the address family from the syntax. If the
723 * family is forced and the format doesn't match, an error is returned. The
Willy Tarreaufab5a432011-03-04 15:31:53 +0100724 * string is assumed to contain only an address, no port. The address can be a
725 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
726 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
727 * The return address will only have the address family and the address set,
728 * all other fields remain zero. The string is not supposed to be modified.
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100729 * The IPv6 '::' address is IN6ADDR_ANY. If <resolve> is non-zero, the hostname
730 * is resolved, otherwise only IP addresses are resolved, and anything else
Willy Tarreauecde7df2016-11-02 22:37:03 +0100731 * returns NULL. If the address contains a port, this one is preserved.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200732 */
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100733struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200734{
Willy Tarreaufab5a432011-03-04 15:31:53 +0100735 struct hostent *he;
mildisff5d5102015-10-26 18:50:08 +0100736 /* max IPv6 length, including brackets and terminating NULL */
737 char tmpip[48];
Willy Tarreauecde7df2016-11-02 22:37:03 +0100738 int port = get_host_port(sa);
mildisff5d5102015-10-26 18:50:08 +0100739
740 /* check IPv6 with square brackets */
741 if (str[0] == '[') {
742 size_t iplength = strlen(str);
743
744 if (iplength < 4) {
745 /* minimal size is 4 when using brackets "[::]" */
746 goto fail;
747 }
748 else if (iplength >= sizeof(tmpip)) {
749 /* IPv6 literal can not be larger than tmpip */
750 goto fail;
751 }
752 else {
753 if (str[iplength - 1] != ']') {
754 /* if address started with bracket, it should end with bracket */
755 goto fail;
756 }
757 else {
758 memcpy(tmpip, str + 1, iplength - 2);
759 tmpip[iplength - 2] = '\0';
760 str = tmpip;
761 }
762 }
763 }
Willy Tarreaufab5a432011-03-04 15:31:53 +0100764
Willy Tarreaufab5a432011-03-04 15:31:53 +0100765 /* Any IPv6 address */
766 if (str[0] == ':' && str[1] == ':' && !str[2]) {
Willy Tarreau24709282013-03-10 21:32:12 +0100767 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
768 sa->ss_family = AF_INET6;
769 else if (sa->ss_family != AF_INET6)
770 goto fail;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100771 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100772 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100773 }
774
Willy Tarreau24709282013-03-10 21:32:12 +0100775 /* Any address for the family, defaults to IPv4 */
Willy Tarreaufab5a432011-03-04 15:31:53 +0100776 if (!str[0] || (str[0] == '*' && !str[1])) {
Willy Tarreau24709282013-03-10 21:32:12 +0100777 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
778 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100779 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100780 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100781 }
782
783 /* check for IPv6 first */
Willy Tarreau24709282013-03-10 21:32:12 +0100784 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET6) &&
785 inet_pton(AF_INET6, str, &((struct sockaddr_in6 *)sa)->sin6_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100786 sa->ss_family = AF_INET6;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100787 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100788 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100789 }
790
791 /* then check for IPv4 */
Willy Tarreau24709282013-03-10 21:32:12 +0100792 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET) &&
793 inet_pton(AF_INET, str, &((struct sockaddr_in *)sa)->sin_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100794 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100795 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100796 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100797 }
798
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100799 if (!resolve)
800 return NULL;
801
Emeric Brund30e9a12020-12-23 18:49:16 +0100802 if (!resolv_hostname_validation(str, NULL))
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200803 return NULL;
804
David du Colombierd5f43282011-03-17 10:40:16 +0100805#ifdef USE_GETADDRINFO
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200806 if (global.tune.options & GTUNE_USE_GAI) {
David du Colombierd5f43282011-03-17 10:40:16 +0100807 struct addrinfo hints, *result;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100808 int success = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100809
810 memset(&result, 0, sizeof(result));
811 memset(&hints, 0, sizeof(hints));
Willy Tarreau24709282013-03-10 21:32:12 +0100812 hints.ai_family = sa->ss_family ? sa->ss_family : AF_UNSPEC;
David du Colombierd5f43282011-03-17 10:40:16 +0100813 hints.ai_socktype = SOCK_DGRAM;
Dmitry Sivachenkoeab7f392015-10-02 01:01:58 +0200814 hints.ai_flags = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100815 hints.ai_protocol = 0;
816
817 if (getaddrinfo(str, NULL, &hints, &result) == 0) {
Willy Tarreau24709282013-03-10 21:32:12 +0100818 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
819 sa->ss_family = result->ai_family;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100820 else if (sa->ss_family != result->ai_family) {
821 freeaddrinfo(result);
Willy Tarreau24709282013-03-10 21:32:12 +0100822 goto fail;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100823 }
Willy Tarreau24709282013-03-10 21:32:12 +0100824
David du Colombierd5f43282011-03-17 10:40:16 +0100825 switch (result->ai_family) {
826 case AF_INET:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100827 memcpy((struct sockaddr_in *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100828 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100829 success = 1;
830 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100831 case AF_INET6:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100832 memcpy((struct sockaddr_in6 *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100833 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100834 success = 1;
835 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100836 }
837 }
838
Sean Carey58ea0392013-02-15 23:39:18 +0100839 if (result)
840 freeaddrinfo(result);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100841
842 if (success)
843 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100844 }
David du Colombierd5f43282011-03-17 10:40:16 +0100845#endif
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200846 /* try to resolve an IPv4/IPv6 hostname */
847 he = gethostbyname(str);
848 if (he) {
849 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
850 sa->ss_family = he->h_addrtype;
851 else if (sa->ss_family != he->h_addrtype)
852 goto fail;
853
854 switch (sa->ss_family) {
855 case AF_INET:
856 ((struct sockaddr_in *)sa)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100857 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200858 return sa;
859 case AF_INET6:
860 ((struct sockaddr_in6 *)sa)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100861 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200862 return sa;
863 }
864 }
865
David du Colombierd5f43282011-03-17 10:40:16 +0100866 /* unsupported address family */
Willy Tarreau24709282013-03-10 21:32:12 +0100867 fail:
Willy Tarreaufab5a432011-03-04 15:31:53 +0100868 return NULL;
869}
870
871/*
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100872 * Converts <str> to a locally allocated struct sockaddr_storage *, and a port
873 * range or offset consisting in two integers that the caller will have to
874 * check to find the relevant input format. The following format are supported :
875 *
876 * String format | address | port | low | high
877 * addr | <addr> | 0 | 0 | 0
878 * addr: | <addr> | 0 | 0 | 0
879 * addr:port | <addr> | <port> | <port> | <port>
880 * addr:pl-ph | <addr> | <pl> | <pl> | <ph>
881 * addr:+port | <addr> | <port> | 0 | <port>
882 * addr:-port | <addr> |-<port> | <port> | 0
883 *
884 * The detection of a port range or increment by the caller is made by
885 * comparing <low> and <high>. If both are equal, then port 0 means no port
886 * was specified. The caller may pass NULL for <low> and <high> if it is not
887 * interested in retrieving port ranges.
888 *
889 * Note that <addr> above may also be :
890 * - empty ("") => family will be AF_INET and address will be INADDR_ANY
891 * - "*" => family will be AF_INET and address will be INADDR_ANY
892 * - "::" => family will be AF_INET6 and address will be IN6ADDR_ANY
893 * - a host name => family and address will depend on host name resolving.
894 *
Willy Tarreau24709282013-03-10 21:32:12 +0100895 * A prefix may be passed in before the address above to force the family :
896 * - "ipv4@" => force address to resolve as IPv4 and fail if not possible.
897 * - "ipv6@" => force address to resolve as IPv6 and fail if not possible.
898 * - "unix@" => force address to be a path to a UNIX socket even if the
899 * path does not start with a '/'
Willy Tarreauccfccef2014-05-10 01:49:15 +0200900 * - 'abns@' -> force address to belong to the abstract namespace (Linux
901 * only). These sockets are just like Unix sockets but without
902 * the need for an underlying file system. The address is a
903 * string. Technically it's like a Unix socket with a zero in
904 * the first byte of the address.
Willy Tarreau40aa0702013-03-10 23:51:38 +0100905 * - "fd@" => an integer must follow, and is a file descriptor number.
Willy Tarreau24709282013-03-10 21:32:12 +0100906 *
mildisff5d5102015-10-26 18:50:08 +0100907 * IPv6 addresses can be declared with or without square brackets. When using
908 * square brackets for IPv6 addresses, the port separator (colon) is optional.
909 * If not using square brackets, and in order to avoid any ambiguity with
910 * IPv6 addresses, the last colon ':' is mandatory even when no port is specified.
911 * NULL is returned if the address cannot be parsed. The <low> and <high> ports
912 * are always initialized if non-null, even for non-IP families.
Willy Tarreaud393a622013-03-04 18:22:00 +0100913 *
914 * If <pfx> is non-null, it is used as a string prefix before any path-based
915 * address (typically the path to a unix socket).
Willy Tarreau40aa0702013-03-10 23:51:38 +0100916 *
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200917 * if <fqdn> is non-null, it will be filled with :
918 * - a pointer to the FQDN of the server name to resolve if there's one, and
919 * that the caller will have to free(),
920 * - NULL if there was an explicit address that doesn't require resolution.
921 *
Willy Tarreaucd3a55912020-09-04 15:30:46 +0200922 * Hostnames are only resolved if <opts> has PA_O_RESOLVE. Otherwise <fqdn> is
923 * still honored so it is possible for the caller to know whether a resolution
924 * failed by clearing this flag and checking if <fqdn> was filled, indicating
925 * the need for a resolution.
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200926 *
Willy Tarreau40aa0702013-03-10 23:51:38 +0100927 * When a file descriptor is passed, its value is put into the s_addr part of
Willy Tarreaua5b325f2020-09-04 16:44:20 +0200928 * the address when cast to sockaddr_in and the address family is
929 * AF_CUST_EXISTING_FD.
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200930 *
Willy Tarreau5fc93282020-09-16 18:25:03 +0200931 * The matching protocol will be set into <proto> if non-null.
932 *
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200933 * Any known file descriptor is also assigned to <fd> if non-null, otherwise it
934 * is forced to -1.
Willy Tarreaufab5a432011-03-04 15:31:53 +0100935 */
Willy Tarreau5fc93282020-09-16 18:25:03 +0200936struct sockaddr_storage *str2sa_range(const char *str, int *port, int *low, int *high, int *fd,
937 struct protocol **proto, char **err,
938 const char *pfx, char **fqdn, unsigned int opts)
Willy Tarreaufab5a432011-03-04 15:31:53 +0100939{
Christopher Faulet1bc04c72017-10-29 20:14:08 +0100940 static THREAD_LOCAL struct sockaddr_storage ss;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100941 struct sockaddr_storage *ret = NULL;
Willy Tarreau5fc93282020-09-16 18:25:03 +0200942 struct protocol *new_proto = NULL;
Willy Tarreau24709282013-03-10 21:32:12 +0100943 char *back, *str2;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100944 char *port1, *port2;
945 int portl, porth, porta;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200946 int abstract = 0;
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200947 int new_fd = -1;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200948 int sock_type, ctrl_type;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100949
950 portl = porth = porta = 0;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200951 if (fqdn)
952 *fqdn = NULL;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200953
Willy Tarreaudad36a32013-03-11 01:20:04 +0100954 str2 = back = env_expand(strdup(str));
Willy Tarreaudf350f12013-03-01 20:22:54 +0100955 if (str2 == NULL) {
956 memprintf(err, "out of memory in '%s'\n", __FUNCTION__);
Willy Tarreaud5191e72010-02-09 20:50:45 +0100957 goto out;
Willy Tarreaudf350f12013-03-01 20:22:54 +0100958 }
Willy Tarreaubaaee002006-06-26 02:48:02 +0200959
Willy Tarreau9f69f462015-09-08 16:01:25 +0200960 if (!*str2) {
961 memprintf(err, "'%s' resolves to an empty address (environment variable missing?)\n", str);
962 goto out;
963 }
964
Willy Tarreau24709282013-03-10 21:32:12 +0100965 memset(&ss, 0, sizeof(ss));
966
Willy Tarreaue835bd82020-09-16 11:35:47 +0200967 /* prepare the default socket types */
Willy Tarreauf23b1bc2021-03-23 18:36:37 +0100968 if ((opts & (PA_O_STREAM|PA_O_DGRAM)) == PA_O_DGRAM ||
969 ((opts & (PA_O_STREAM|PA_O_DGRAM)) == (PA_O_DGRAM|PA_O_STREAM) && (opts & PA_O_DEFAULT_DGRAM)))
Willy Tarreaue835bd82020-09-16 11:35:47 +0200970 sock_type = ctrl_type = SOCK_DGRAM;
971 else
972 sock_type = ctrl_type = SOCK_STREAM;
973
974 if (strncmp(str2, "stream+", 7) == 0) {
975 str2 += 7;
976 sock_type = ctrl_type = SOCK_STREAM;
977 }
978 else if (strncmp(str2, "dgram+", 6) == 0) {
979 str2 += 6;
980 sock_type = ctrl_type = SOCK_DGRAM;
981 }
982
Willy Tarreau24709282013-03-10 21:32:12 +0100983 if (strncmp(str2, "unix@", 5) == 0) {
984 str2 += 5;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200985 abstract = 0;
Willy Tarreau24709282013-03-10 21:32:12 +0100986 ss.ss_family = AF_UNIX;
987 }
Emeric Brunce325c42021-04-02 17:05:09 +0200988 else if (strncmp(str2, "uxdg@", 5) == 0) {
989 str2 += 5;
990 abstract = 0;
991 ss.ss_family = AF_UNIX;
992 sock_type = ctrl_type = SOCK_DGRAM;
993 }
994 else if (strncmp(str2, "uxst@", 5) == 0) {
995 str2 += 5;
996 abstract = 0;
997 ss.ss_family = AF_UNIX;
998 sock_type = ctrl_type = SOCK_STREAM;
999 }
Willy Tarreauccfccef2014-05-10 01:49:15 +02001000 else if (strncmp(str2, "abns@", 5) == 0) {
1001 str2 += 5;
1002 abstract = 1;
1003 ss.ss_family = AF_UNIX;
1004 }
Emeric Brunce325c42021-04-02 17:05:09 +02001005 else if (strncmp(str2, "ip@", 3) == 0) {
1006 str2 += 3;
1007 ss.ss_family = AF_UNSPEC;
1008 }
Willy Tarreau24709282013-03-10 21:32:12 +01001009 else if (strncmp(str2, "ipv4@", 5) == 0) {
1010 str2 += 5;
1011 ss.ss_family = AF_INET;
1012 }
1013 else if (strncmp(str2, "ipv6@", 5) == 0) {
1014 str2 += 5;
1015 ss.ss_family = AF_INET6;
1016 }
Emeric Brunce325c42021-04-02 17:05:09 +02001017 else if (strncmp(str2, "tcp4@", 5) == 0) {
1018 str2 += 5;
1019 ss.ss_family = AF_INET;
1020 sock_type = ctrl_type = SOCK_STREAM;
1021 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001022 else if (strncmp(str2, "udp4@", 5) == 0) {
1023 str2 += 5;
1024 ss.ss_family = AF_INET;
Willy Tarreaue835bd82020-09-16 11:35:47 +02001025 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001026 }
Emeric Brunce325c42021-04-02 17:05:09 +02001027 else if (strncmp(str2, "tcp6@", 5) == 0) {
1028 str2 += 5;
1029 ss.ss_family = AF_INET6;
1030 sock_type = ctrl_type = SOCK_STREAM;
1031 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001032 else if (strncmp(str2, "udp6@", 5) == 0) {
1033 str2 += 5;
1034 ss.ss_family = AF_INET6;
Willy Tarreaue835bd82020-09-16 11:35:47 +02001035 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001036 }
Emeric Brunce325c42021-04-02 17:05:09 +02001037 else if (strncmp(str2, "tcp@", 4) == 0) {
1038 str2 += 4;
1039 ss.ss_family = AF_UNSPEC;
1040 sock_type = ctrl_type = SOCK_STREAM;
1041 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001042 else if (strncmp(str2, "udp@", 4) == 0) {
1043 str2 += 4;
1044 ss.ss_family = AF_UNSPEC;
Willy Tarreaue835bd82020-09-16 11:35:47 +02001045 sock_type = ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001046 }
Frédéric Lécaille10caf652020-11-23 11:36:57 +01001047 else if (strncmp(str2, "quic4@", 6) == 0) {
1048 str2 += 6;
1049 ss.ss_family = AF_INET;
1050 sock_type = SOCK_DGRAM;
1051 ctrl_type = SOCK_STREAM;
1052 }
1053 else if (strncmp(str2, "quic6@", 6) == 0) {
1054 str2 += 6;
1055 ss.ss_family = AF_INET6;
1056 sock_type = SOCK_DGRAM;
1057 ctrl_type = SOCK_STREAM;
1058 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001059 else if (strncmp(str2, "fd@", 3) == 0) {
1060 str2 += 3;
1061 ss.ss_family = AF_CUST_EXISTING_FD;
1062 }
1063 else if (strncmp(str2, "sockpair@", 9) == 0) {
1064 str2 += 9;
1065 ss.ss_family = AF_CUST_SOCKPAIR;
1066 }
Willy Tarreau24709282013-03-10 21:32:12 +01001067 else if (*str2 == '/') {
1068 ss.ss_family = AF_UNIX;
1069 }
1070 else
1071 ss.ss_family = AF_UNSPEC;
1072
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001073 if (ss.ss_family == AF_CUST_SOCKPAIR) {
Willy Tarreaua215be22020-09-16 10:14:16 +02001074 struct sockaddr_storage ss2;
1075 socklen_t addr_len;
William Lallemand2fe7dd02018-09-11 16:51:29 +02001076 char *endptr;
1077
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001078 new_fd = strtol(str2, &endptr, 10);
1079 if (!*str2 || new_fd < 0 || *endptr) {
William Lallemand2fe7dd02018-09-11 16:51:29 +02001080 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
1081 goto out;
1082 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001083
Willy Tarreaua215be22020-09-16 10:14:16 +02001084 /* just verify that it's a socket */
1085 addr_len = sizeof(ss2);
1086 if (getsockname(new_fd, (struct sockaddr *)&ss2, &addr_len) == -1) {
1087 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1088 goto out;
1089 }
1090
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001091 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1092 ((struct sockaddr_in *)&ss)->sin_port = 0;
William Lallemand2fe7dd02018-09-11 16:51:29 +02001093 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001094 else if (ss.ss_family == AF_CUST_EXISTING_FD) {
Willy Tarreau40aa0702013-03-10 23:51:38 +01001095 char *endptr;
1096
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001097 new_fd = strtol(str2, &endptr, 10);
1098 if (!*str2 || new_fd < 0 || *endptr) {
Willy Tarreaudad36a32013-03-11 01:20:04 +01001099 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
Willy Tarreau40aa0702013-03-10 23:51:38 +01001100 goto out;
1101 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001102
Willy Tarreau6edc7222020-09-15 17:41:56 +02001103 if (opts & PA_O_SOCKET_FD) {
1104 socklen_t addr_len;
1105 int type;
1106
1107 addr_len = sizeof(ss);
1108 if (getsockname(new_fd, (struct sockaddr *)&ss, &addr_len) == -1) {
1109 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1110 goto out;
1111 }
1112
1113 addr_len = sizeof(type);
1114 if (getsockopt(new_fd, SOL_SOCKET, SO_TYPE, &type, &addr_len) != 0 ||
Willy Tarreaue835bd82020-09-16 11:35:47 +02001115 (type == SOCK_STREAM) != (sock_type == SOCK_STREAM)) {
Willy Tarreau6edc7222020-09-15 17:41:56 +02001116 memprintf(err, "socket on file descriptor '%d' is of the wrong type.\n", new_fd);
1117 goto out;
1118 }
1119
1120 porta = portl = porth = get_host_port(&ss);
1121 } else if (opts & PA_O_RAW_FD) {
1122 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1123 ((struct sockaddr_in *)&ss)->sin_port = 0;
1124 } else {
1125 memprintf(err, "a file descriptor is not acceptable here in '%s'\n", str);
1126 goto out;
1127 }
Willy Tarreau40aa0702013-03-10 23:51:38 +01001128 }
1129 else if (ss.ss_family == AF_UNIX) {
Willy Tarreau8daa9202019-06-16 18:16:33 +02001130 struct sockaddr_un *un = (struct sockaddr_un *)&ss;
Willy Tarreau15586382013-03-04 19:48:14 +01001131 int prefix_path_len;
1132 int max_path_len;
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001133 int adr_len;
Willy Tarreau15586382013-03-04 19:48:14 +01001134
1135 /* complete unix socket path name during startup or soft-restart is
1136 * <unix_bind_prefix><path>.<pid>.<bak|tmp>
1137 */
Willy Tarreauccfccef2014-05-10 01:49:15 +02001138 prefix_path_len = (pfx && !abstract) ? strlen(pfx) : 0;
Willy Tarreau8daa9202019-06-16 18:16:33 +02001139 max_path_len = (sizeof(un->sun_path) - 1) -
Willy Tarreau327ea5a2020-02-11 06:43:37 +01001140 (abstract ? 0 : prefix_path_len + 1 + 5 + 1 + 3);
Willy Tarreau15586382013-03-04 19:48:14 +01001141
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001142 adr_len = strlen(str2);
1143 if (adr_len > max_path_len) {
Willy Tarreau15586382013-03-04 19:48:14 +01001144 memprintf(err, "socket path '%s' too long (max %d)\n", str, max_path_len);
1145 goto out;
1146 }
1147
Willy Tarreauccfccef2014-05-10 01:49:15 +02001148 /* when abstract==1, we skip the first zero and copy all bytes except the trailing zero */
Willy Tarreau8daa9202019-06-16 18:16:33 +02001149 memset(un->sun_path, 0, sizeof(un->sun_path));
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001150 if (prefix_path_len)
Willy Tarreau8daa9202019-06-16 18:16:33 +02001151 memcpy(un->sun_path, pfx, prefix_path_len);
1152 memcpy(un->sun_path + prefix_path_len + abstract, str2, adr_len + 1 - abstract);
Willy Tarreau15586382013-03-04 19:48:14 +01001153 }
Willy Tarreau24709282013-03-10 21:32:12 +01001154 else { /* IPv4 and IPv6 */
mildisff5d5102015-10-26 18:50:08 +01001155 char *end = str2 + strlen(str2);
1156 char *chr;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001157
mildisff5d5102015-10-26 18:50:08 +01001158 /* search for : or ] whatever comes first */
1159 for (chr = end-1; chr > str2; chr--) {
1160 if (*chr == ']' || *chr == ':')
1161 break;
1162 }
1163
1164 if (*chr == ':') {
1165 /* Found a colon before a closing-bracket, must be a port separator.
1166 * This guarantee backward compatibility.
1167 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001168 if (!(opts & PA_O_PORT_OK)) {
1169 memprintf(err, "port specification not permitted here in '%s'", str);
1170 goto out;
1171 }
mildisff5d5102015-10-26 18:50:08 +01001172 *chr++ = '\0';
1173 port1 = chr;
1174 }
1175 else {
1176 /* Either no colon and no closing-bracket
1177 * or directly ending with a closing-bracket.
1178 * However, no port.
1179 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001180 if (opts & PA_O_PORT_MAND) {
1181 memprintf(err, "missing port specification in '%s'", str);
1182 goto out;
1183 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001184 port1 = "";
mildisff5d5102015-10-26 18:50:08 +01001185 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001186
Willy Tarreau90807112020-02-25 08:16:33 +01001187 if (isdigit((unsigned char)*port1)) { /* single port or range */
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001188 port2 = strchr(port1, '-');
Willy Tarreau7f96a842020-09-15 11:12:44 +02001189 if (port2) {
1190 if (!(opts & PA_O_PORT_RANGE)) {
1191 memprintf(err, "port range not permitted here in '%s'", str);
1192 goto out;
1193 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001194 *port2++ = '\0';
Willy Tarreau7f96a842020-09-15 11:12:44 +02001195 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001196 else
1197 port2 = port1;
1198 portl = atoi(port1);
1199 porth = atoi(port2);
Willy Tarreau7f96a842020-09-15 11:12:44 +02001200
1201 if (portl < !!(opts & PA_O_PORT_MAND) || portl > 65535) {
1202 memprintf(err, "invalid port '%s'", port1);
1203 goto out;
1204 }
1205
1206 if (porth < !!(opts & PA_O_PORT_MAND) || porth > 65535) {
1207 memprintf(err, "invalid port '%s'", port2);
1208 goto out;
1209 }
1210
1211 if (portl > porth) {
1212 memprintf(err, "invalid port range '%d-%d'", portl, porth);
1213 goto out;
1214 }
1215
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001216 porta = portl;
1217 }
1218 else if (*port1 == '-') { /* negative offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001219 if (!(opts & PA_O_PORT_OFS)) {
1220 memprintf(err, "port offset not permitted here in '%s'", str);
1221 goto out;
1222 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001223 portl = atoi(port1 + 1);
1224 porta = -portl;
1225 }
1226 else if (*port1 == '+') { /* positive offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001227 if (!(opts & PA_O_PORT_OFS)) {
1228 memprintf(err, "port offset not permitted here in '%s'", str);
1229 goto out;
1230 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001231 porth = atoi(port1 + 1);
1232 porta = porth;
1233 }
1234 else if (*port1) { /* other any unexpected char */
Willy Tarreaudad36a32013-03-11 01:20:04 +01001235 memprintf(err, "invalid character '%c' in port number '%s' in '%s'\n", *port1, port1, str);
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001236 goto out;
1237 }
Willy Tarreau7f96a842020-09-15 11:12:44 +02001238 else if (opts & PA_O_PORT_MAND) {
1239 memprintf(err, "missing port specification in '%s'", str);
1240 goto out;
1241 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001242
1243 /* first try to parse the IP without resolving. If it fails, it
1244 * tells us we need to keep a copy of the FQDN to resolve later
1245 * and to enable DNS. In this case we can proceed if <fqdn> is
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001246 * set or if PA_O_RESOLVE is set, otherwise it's an error.
Willy Tarreauceccdd72016-11-02 22:27:10 +01001247 */
1248 if (str2ip2(str2, &ss, 0) == NULL) {
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001249 if ((!(opts & PA_O_RESOLVE) && !fqdn) ||
1250 ((opts & PA_O_RESOLVE) && str2ip2(str2, &ss, 1) == NULL)) {
Willy Tarreauceccdd72016-11-02 22:27:10 +01001251 memprintf(err, "invalid address: '%s' in '%s'\n", str2, str);
1252 goto out;
1253 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001254
Willy Tarreauceccdd72016-11-02 22:27:10 +01001255 if (fqdn) {
1256 if (str2 != back)
1257 memmove(back, str2, strlen(str2) + 1);
1258 *fqdn = back;
1259 back = NULL;
1260 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001261 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001262 set_host_port(&ss, porta);
Willy Tarreaue4c58c82013-03-06 15:28:17 +01001263 }
Willy Tarreaufab5a432011-03-04 15:31:53 +01001264
Willy Tarreaue835bd82020-09-16 11:35:47 +02001265 if (ctrl_type == SOCK_STREAM && !(opts & PA_O_STREAM)) {
1266 memprintf(err, "stream-type socket not acceptable in '%s'\n", str);
1267 goto out;
1268 }
1269 else if (ctrl_type == SOCK_DGRAM && !(opts & PA_O_DGRAM)) {
1270 memprintf(err, "dgram-type socket not acceptable in '%s'\n", str);
1271 goto out;
1272 }
1273
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001274 if (proto || (opts & PA_O_CONNECT)) {
Willy Tarreau5fc93282020-09-16 18:25:03 +02001275 /* Note: if the caller asks for a proto, we must find one,
Emeric Brun26754902021-04-07 14:26:44 +02001276 * except if we inherit from a raw FD (family == AF_CUST_EXISTING_FD)
1277 * orif we return with an fqdn that will resolve later,
Willy Tarreau5fc93282020-09-16 18:25:03 +02001278 * in which case the address is not known yet (this is only
1279 * for servers actually).
1280 */
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001281 new_proto = protocol_lookup(ss.ss_family,
Willy Tarreauaf9609b2020-09-16 22:04:46 +02001282 sock_type == SOCK_DGRAM,
1283 ctrl_type == SOCK_DGRAM);
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001284
Emeric Brun26754902021-04-07 14:26:44 +02001285 if (!new_proto && (!fqdn || !*fqdn) && (ss.ss_family != AF_CUST_EXISTING_FD)) {
Willy Tarreau5fc93282020-09-16 18:25:03 +02001286 memprintf(err, "unsupported protocol family %d for address '%s'", ss.ss_family, str);
1287 goto out;
1288 }
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001289
1290 if ((opts & PA_O_CONNECT) && new_proto && !new_proto->connect) {
1291 memprintf(err, "connect() not supported for this protocol family %d used by address '%s'", ss.ss_family, str);
1292 goto out;
1293 }
Willy Tarreau5fc93282020-09-16 18:25:03 +02001294 }
1295
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001296 ret = &ss;
Willy Tarreaud5191e72010-02-09 20:50:45 +01001297 out:
Willy Tarreau48ef4c92017-01-06 18:32:38 +01001298 if (port)
1299 *port = porta;
Willy Tarreaud4448bc2013-02-20 15:55:15 +01001300 if (low)
1301 *low = portl;
1302 if (high)
1303 *high = porth;
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001304 if (fd)
1305 *fd = new_fd;
Willy Tarreau5fc93282020-09-16 18:25:03 +02001306 if (proto)
1307 *proto = new_proto;
Willy Tarreau24709282013-03-10 21:32:12 +01001308 free(back);
Willy Tarreaud5191e72010-02-09 20:50:45 +01001309 return ret;
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001310}
1311
Thayne McCombs92149f92020-11-20 01:28:26 -07001312/* converts <addr> and <port> into a string representation of the address and port. This is sort
1313 * of an inverse of str2sa_range, with some restrictions. The supported families are AF_INET,
1314 * AF_INET6, AF_UNIX, and AF_CUST_SOCKPAIR. If the family is unsopported NULL is returned.
1315 * If map_ports is true, then the sign of the port is included in the output, to indicate it is
1316 * relative to the incoming port. AF_INET and AF_INET6 will be in the form "<addr>:<port>".
1317 * AF_UNIX will either be just the path (if using a pathname) or "abns@<path>" if it is abstract.
1318 * AF_CUST_SOCKPAIR will be of the form "sockpair@<fd>".
1319 *
1320 * The returned char* is allocated, and it is the responsibility of the caller to free it.
1321 */
1322char * sa2str(const struct sockaddr_storage *addr, int port, int map_ports)
1323{
1324 char buffer[INET6_ADDRSTRLEN];
1325 char *out = NULL;
1326 const void *ptr;
1327 const char *path;
1328
1329 switch (addr->ss_family) {
1330 case AF_INET:
1331 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1332 break;
1333 case AF_INET6:
1334 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1335 break;
1336 case AF_UNIX:
1337 path = ((struct sockaddr_un *)addr)->sun_path;
1338 if (path[0] == '\0') {
1339 const int max_length = sizeof(struct sockaddr_un) - offsetof(struct sockaddr_un, sun_path) - 1;
1340 return memprintf(&out, "abns@%.*s", max_length, path+1);
1341 } else {
1342 return strdup(path);
1343 }
1344 case AF_CUST_SOCKPAIR:
1345 return memprintf(&out, "sockpair@%d", ((struct sockaddr_in *)addr)->sin_addr.s_addr);
1346 default:
1347 return NULL;
1348 }
1349 inet_ntop(addr->ss_family, ptr, buffer, get_addr_len(addr));
1350 if (map_ports)
1351 return memprintf(&out, "%s:%+d", buffer, port);
1352 else
1353 return memprintf(&out, "%s:%d", buffer, port);
1354}
1355
1356
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001357/* converts <str> to a struct in_addr containing a network mask. It can be
1358 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +03001359 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001360 */
1361int str2mask(const char *str, struct in_addr *mask)
1362{
1363 if (strchr(str, '.') != NULL) { /* dotted notation */
1364 if (!inet_pton(AF_INET, str, mask))
1365 return 0;
1366 }
1367 else { /* mask length */
1368 char *err;
1369 unsigned long len = strtol(str, &err, 10);
1370
1371 if (!*str || (err && *err) || (unsigned)len > 32)
1372 return 0;
Tim Duesterhus8575f722018-01-25 16:24:48 +01001373
1374 len2mask4(len, mask);
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001375 }
1376 return 1;
1377}
1378
Tim Duesterhus47185172018-01-25 16:24:49 +01001379/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +01001380 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +01001381 * if the conversion succeeds otherwise zero.
1382 */
1383int str2mask6(const char *str, struct in6_addr *mask)
1384{
1385 if (strchr(str, ':') != NULL) { /* quadruplet notation */
1386 if (!inet_pton(AF_INET6, str, mask))
1387 return 0;
1388 }
1389 else { /* mask length */
1390 char *err;
1391 unsigned long len = strtol(str, &err, 10);
1392
1393 if (!*str || (err && *err) || (unsigned)len > 128)
1394 return 0;
1395
1396 len2mask6(len, mask);
1397 }
1398 return 1;
1399}
1400
Thierry FOURNIERb0504632013-12-14 15:39:02 +01001401/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
1402 * succeeds otherwise zero.
1403 */
1404int cidr2dotted(int cidr, struct in_addr *mask) {
1405
1406 if (cidr < 0 || cidr > 32)
1407 return 0;
1408
1409 mask->s_addr = cidr ? htonl(~0UL << (32 - cidr)) : 0;
1410 return 1;
1411}
1412
Thierry Fournier70473a52016-02-17 17:12:14 +01001413/* Convert mask from bit length form to in_addr form.
1414 * This function never fails.
1415 */
1416void len2mask4(int len, struct in_addr *addr)
1417{
1418 if (len >= 32) {
1419 addr->s_addr = 0xffffffff;
1420 return;
1421 }
1422 if (len <= 0) {
1423 addr->s_addr = 0x00000000;
1424 return;
1425 }
1426 addr->s_addr = 0xffffffff << (32 - len);
1427 addr->s_addr = htonl(addr->s_addr);
1428}
1429
1430/* Convert mask from bit length form to in6_addr form.
1431 * This function never fails.
1432 */
1433void len2mask6(int len, struct in6_addr *addr)
1434{
1435 len2mask4(len, (struct in_addr *)&addr->s6_addr[0]); /* msb */
1436 len -= 32;
1437 len2mask4(len, (struct in_addr *)&addr->s6_addr[4]);
1438 len -= 32;
1439 len2mask4(len, (struct in_addr *)&addr->s6_addr[8]);
1440 len -= 32;
1441 len2mask4(len, (struct in_addr *)&addr->s6_addr[12]); /* lsb */
1442}
1443
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001444/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +02001445 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001446 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001447 * is optional and either in the dotted or CIDR notation.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001448 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
1449 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001450int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001451{
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001452 __label__ out_free, out_err;
1453 char *c, *s;
1454 int ret_val;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001455
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001456 s = strdup(str);
1457 if (!s)
1458 return 0;
1459
Willy Tarreaubaaee002006-06-26 02:48:02 +02001460 memset(mask, 0, sizeof(*mask));
1461 memset(addr, 0, sizeof(*addr));
Willy Tarreaubaaee002006-06-26 02:48:02 +02001462
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001463 if ((c = strrchr(s, '/')) != NULL) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001464 *c++ = '\0';
1465 /* c points to the mask */
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001466 if (!str2mask(c, mask))
1467 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001468 }
1469 else {
Willy Tarreauebd61602006-12-30 11:54:15 +01001470 mask->s_addr = ~0U;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001471 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001472 if (!inet_pton(AF_INET, s, addr)) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001473 struct hostent *he;
1474
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001475 if (!resolve)
1476 goto out_err;
1477
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001478 if ((he = gethostbyname(s)) == NULL) {
1479 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001480 }
1481 else
1482 *addr = *(struct in_addr *) *(he->h_addr_list);
1483 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001484
1485 ret_val = 1;
1486 out_free:
1487 free(s);
1488 return ret_val;
1489 out_err:
1490 ret_val = 0;
1491 goto out_free;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001492}
1493
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001494
1495/*
Willy Tarreau6d20e282012-04-27 22:49:47 +02001496 * converts <str> to two struct in6_addr* which must be pre-allocated.
1497 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001498 * is an optional number of bits (128 being the default).
Willy Tarreau6d20e282012-04-27 22:49:47 +02001499 * Returns 1 if OK, 0 if error.
1500 */
1501int str62net(const char *str, struct in6_addr *addr, unsigned char *mask)
1502{
1503 char *c, *s;
1504 int ret_val = 0;
1505 char *err;
1506 unsigned long len = 128;
1507
1508 s = strdup(str);
1509 if (!s)
1510 return 0;
1511
1512 memset(mask, 0, sizeof(*mask));
1513 memset(addr, 0, sizeof(*addr));
1514
1515 if ((c = strrchr(s, '/')) != NULL) {
1516 *c++ = '\0'; /* c points to the mask */
1517 if (!*c)
1518 goto out_free;
1519
1520 len = strtoul(c, &err, 10);
1521 if ((err && *err) || (unsigned)len > 128)
1522 goto out_free;
1523 }
1524 *mask = len; /* OK we have a valid mask in <len> */
1525
1526 if (!inet_pton(AF_INET6, s, addr))
1527 goto out_free;
1528
1529 ret_val = 1;
1530 out_free:
1531 free(s);
1532 return ret_val;
1533}
1534
1535
1536/*
Willy Tarreau12e10272021-03-25 11:34:40 +01001537 * Parse IPv4 address found in url. Return the number of bytes parsed. It
1538 * expects exactly 4 numbers between 0 and 255 delimited by dots, and returns
1539 * zero in case of mismatch.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001540 */
David du Colombier6f5ccb12011-03-10 22:26:24 +01001541int url2ipv4(const char *addr, struct in_addr *dst)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001542{
1543 int saw_digit, octets, ch;
1544 u_char tmp[4], *tp;
1545 const char *cp = addr;
1546
1547 saw_digit = 0;
1548 octets = 0;
1549 *(tp = tmp) = 0;
1550
1551 while (*addr) {
Willy Tarreau12e10272021-03-25 11:34:40 +01001552 unsigned char digit = (ch = *addr) - '0';
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001553 if (digit > 9 && ch != '.')
1554 break;
Willy Tarreau12e10272021-03-25 11:34:40 +01001555 addr++;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001556 if (digit <= 9) {
1557 u_int new = *tp * 10 + digit;
1558 if (new > 255)
1559 return 0;
1560 *tp = new;
1561 if (!saw_digit) {
1562 if (++octets > 4)
1563 return 0;
1564 saw_digit = 1;
1565 }
1566 } else if (ch == '.' && saw_digit) {
1567 if (octets == 4)
1568 return 0;
1569 *++tp = 0;
1570 saw_digit = 0;
1571 } else
1572 return 0;
1573 }
1574
1575 if (octets < 4)
1576 return 0;
1577
1578 memcpy(&dst->s_addr, tmp, 4);
Willy Tarreau12e10272021-03-25 11:34:40 +01001579 return addr - cp;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001580}
1581
1582/*
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001583 * Resolve destination server from URL. Convert <str> to a sockaddr_storage.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001584 * <out> contain the code of the detected scheme, the start and length of
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001585 * the hostname. Actually only http and https are supported. <out> can be NULL.
1586 * This function returns the consumed length. It is useful if you parse complete
1587 * url like http://host:port/path, because the consumed length corresponds to
1588 * the first character of the path. If the conversion fails, it returns -1.
1589 *
1590 * This function tries to resolve the DNS name if haproxy is in starting mode.
1591 * So, this function may be used during the configuration parsing.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001592 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001593int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001594{
1595 const char *curr = url, *cp = url;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001596 const char *end;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001597 int ret, url_code = 0;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001598 unsigned long long int http_code = 0;
1599 int default_port;
1600 struct hostent *he;
1601 char *p;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001602
1603 /* Firstly, try to find :// pattern */
1604 while (curr < url+ulen && url_code != 0x3a2f2f) {
1605 url_code = ((url_code & 0xffff) << 8);
1606 url_code += (unsigned char)*curr++;
1607 }
1608
1609 /* Secondly, if :// pattern is found, verify parsed stuff
1610 * before pattern is matching our http pattern.
1611 * If so parse ip address and port in uri.
1612 *
1613 * WARNING: Current code doesn't support dynamic async dns resolver.
1614 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001615 if (url_code != 0x3a2f2f)
1616 return -1;
1617
1618 /* Copy scheme, and utrn to lower case. */
1619 while (cp < curr - 3)
1620 http_code = (http_code << 8) + *cp++;
1621 http_code |= 0x2020202020202020ULL; /* Turn everything to lower case */
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001622
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001623 /* HTTP or HTTPS url matching */
1624 if (http_code == 0x2020202068747470ULL) {
1625 default_port = 80;
1626 if (out)
1627 out->scheme = SCH_HTTP;
1628 }
1629 else if (http_code == 0x2020206874747073ULL) {
1630 default_port = 443;
1631 if (out)
1632 out->scheme = SCH_HTTPS;
1633 }
1634 else
1635 return -1;
1636
1637 /* If the next char is '[', the host address is IPv6. */
1638 if (*curr == '[') {
1639 curr++;
1640
1641 /* Check trash size */
1642 if (trash.size < ulen)
1643 return -1;
1644
1645 /* Look for ']' and copy the address in a trash buffer. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001646 p = trash.area;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001647 for (end = curr;
1648 end < url + ulen && *end != ']';
1649 end++, p++)
1650 *p = *end;
1651 if (*end != ']')
1652 return -1;
1653 *p = '\0';
1654
1655 /* Update out. */
1656 if (out) {
1657 out->host = curr;
1658 out->host_len = end - curr;
1659 }
1660
1661 /* Try IPv6 decoding. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001662 if (!inet_pton(AF_INET6, trash.area, &((struct sockaddr_in6 *)addr)->sin6_addr))
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001663 return -1;
1664 end++;
1665
1666 /* Decode port. */
William Lallemande2e6cd92022-03-25 17:37:51 +01001667 if (end < url + ulen && *end == ':') {
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001668 end++;
1669 default_port = read_uint(&end, url + ulen);
1670 }
1671 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1672 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1673 return end - url;
1674 }
1675 else {
William Lallemand12e3b252022-02-18 16:13:12 +01001676 /* we need to copy the string into the trash because url2ipv4
1677 * needs a \0 at the end of the string */
1678 if (trash.size < ulen)
1679 return -1;
1680
1681 memcpy(trash.area, curr, ulen - (curr - url));
1682 trash.area[ulen - (curr - url)] = '\0';
1683
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001684 /* We are looking for IP address. If you want to parse and
1685 * resolve hostname found in url, you can use str2sa_range(), but
1686 * be warned this can slow down global daemon performances
1687 * while handling lagging dns responses.
1688 */
William Lallemand12e3b252022-02-18 16:13:12 +01001689 ret = url2ipv4(trash.area, &((struct sockaddr_in *)addr)->sin_addr);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001690 if (ret) {
1691 /* Update out. */
1692 if (out) {
1693 out->host = curr;
1694 out->host_len = ret;
1695 }
1696
William Lallemand086323a2022-03-24 21:59:03 +01001697 curr += ret;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001698
1699 /* Decode port. */
William Lallemande2e6cd92022-03-25 17:37:51 +01001700 if (curr < url + ulen && *curr == ':') {
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001701 curr++;
1702 default_port = read_uint(&curr, url + ulen);
1703 }
1704 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1705
1706 /* Set family. */
1707 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1708 return curr - url;
1709 }
1710 else if (global.mode & MODE_STARTING) {
1711 /* The IPv4 and IPv6 decoding fails, maybe the url contain name. Try to execute
1712 * synchronous DNS request only if HAProxy is in the start state.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001713 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001714
1715 /* look for : or / or end */
1716 for (end = curr;
1717 end < url + ulen && *end != '/' && *end != ':';
1718 end++);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001719 memcpy(trash.area, curr, end - curr);
1720 trash.area[end - curr] = '\0';
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001721
1722 /* try to resolve an IPv4/IPv6 hostname */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001723 he = gethostbyname(trash.area);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001724 if (!he)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001725 return -1;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001726
1727 /* Update out. */
1728 if (out) {
1729 out->host = curr;
1730 out->host_len = end - curr;
1731 }
1732
1733 /* Decode port. */
William Lallemande2e6cd92022-03-25 17:37:51 +01001734 if (end < url + ulen && *end == ':') {
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001735 end++;
1736 default_port = read_uint(&end, url + ulen);
1737 }
1738
1739 /* Copy IP address, set port and family. */
1740 switch (he->h_addrtype) {
1741 case AF_INET:
1742 ((struct sockaddr_in *)addr)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
1743 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1744 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1745 return end - url;
1746
1747 case AF_INET6:
1748 ((struct sockaddr_in6 *)addr)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
1749 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1750 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1751 return end - url;
1752 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001753 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001754 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001755 return -1;
1756}
1757
Willy Tarreau631f01c2011-09-05 00:36:48 +02001758/* Tries to convert a sockaddr_storage address to text form. Upon success, the
1759 * address family is returned so that it's easy for the caller to adapt to the
1760 * output format. Zero is returned if the address family is not supported. -1
1761 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1762 * supported.
1763 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001764int addr_to_str(const struct sockaddr_storage *addr, char *str, int size)
Willy Tarreau631f01c2011-09-05 00:36:48 +02001765{
1766
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001767 const void *ptr;
Willy Tarreau631f01c2011-09-05 00:36:48 +02001768
1769 if (size < 5)
1770 return 0;
1771 *str = '\0';
1772
1773 switch (addr->ss_family) {
1774 case AF_INET:
1775 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1776 break;
1777 case AF_INET6:
1778 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1779 break;
1780 case AF_UNIX:
1781 memcpy(str, "unix", 5);
1782 return addr->ss_family;
1783 default:
1784 return 0;
1785 }
1786
1787 if (inet_ntop(addr->ss_family, ptr, str, size))
1788 return addr->ss_family;
1789
1790 /* failed */
1791 return -1;
1792}
1793
Simon Horman75ab8bd2014-06-16 09:39:41 +09001794/* Tries to convert a sockaddr_storage port to text form. Upon success, the
1795 * address family is returned so that it's easy for the caller to adapt to the
1796 * output format. Zero is returned if the address family is not supported. -1
1797 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1798 * supported.
1799 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001800int port_to_str(const struct sockaddr_storage *addr, char *str, int size)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001801{
1802
1803 uint16_t port;
1804
1805
Willy Tarreaud7dad1b2017-01-06 16:46:22 +01001806 if (size < 6)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001807 return 0;
1808 *str = '\0';
1809
1810 switch (addr->ss_family) {
1811 case AF_INET:
1812 port = ((struct sockaddr_in *)addr)->sin_port;
1813 break;
1814 case AF_INET6:
1815 port = ((struct sockaddr_in6 *)addr)->sin6_port;
1816 break;
1817 case AF_UNIX:
1818 memcpy(str, "unix", 5);
1819 return addr->ss_family;
1820 default:
1821 return 0;
1822 }
1823
1824 snprintf(str, size, "%u", ntohs(port));
1825 return addr->ss_family;
1826}
1827
Willy Tarreau16e01562016-08-09 16:46:18 +02001828/* check if the given address is local to the system or not. It will return
1829 * -1 when it's not possible to know, 0 when the address is not local, 1 when
1830 * it is. We don't want to iterate over all interfaces for this (and it is not
1831 * portable). So instead we try to bind in UDP to this address on a free non
1832 * privileged port and to connect to the same address, port 0 (connect doesn't
1833 * care). If it succeeds, we own the address. Note that non-inet addresses are
1834 * considered local since they're most likely AF_UNIX.
1835 */
1836int addr_is_local(const struct netns_entry *ns,
1837 const struct sockaddr_storage *orig)
1838{
1839 struct sockaddr_storage addr;
1840 int result;
1841 int fd;
1842
1843 if (!is_inet_addr(orig))
1844 return 1;
1845
1846 memcpy(&addr, orig, sizeof(addr));
1847 set_host_port(&addr, 0);
1848
1849 fd = my_socketat(ns, addr.ss_family, SOCK_DGRAM, IPPROTO_UDP);
1850 if (fd < 0)
1851 return -1;
1852
1853 result = -1;
1854 if (bind(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == 0) {
1855 if (connect(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == -1)
1856 result = 0; // fail, non-local address
1857 else
1858 result = 1; // success, local address
1859 }
1860 else {
1861 if (errno == EADDRNOTAVAIL)
1862 result = 0; // definitely not local :-)
1863 }
1864 close(fd);
1865
1866 return result;
1867}
1868
Willy Tarreaubaaee002006-06-26 02:48:02 +02001869/* will try to encode the string <string> replacing all characters tagged in
1870 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
1871 * prefixed by <escape>, and will store the result between <start> (included)
1872 * and <stop> (excluded), and will always terminate the string with a '\0'
1873 * before <stop>. The position of the '\0' is returned if the conversion
1874 * completes. If bytes are missing between <start> and <stop>, then the
1875 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
1876 * cannot even be stored so we return <start> without writing the 0.
1877 * The input string must also be zero-terminated.
1878 */
1879const char hextab[16] = "0123456789ABCDEF";
1880char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001881 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +02001882 const char *string)
1883{
1884 if (start < stop) {
1885 stop--; /* reserve one byte for the final '\0' */
1886 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001887 if (!ha_bit_test((unsigned char)(*string), map))
Willy Tarreaubaaee002006-06-26 02:48:02 +02001888 *start++ = *string;
1889 else {
1890 if (start + 3 >= stop)
1891 break;
1892 *start++ = escape;
1893 *start++ = hextab[(*string >> 4) & 15];
1894 *start++ = hextab[*string & 15];
1895 }
1896 string++;
1897 }
1898 *start = '\0';
1899 }
1900 return start;
1901}
1902
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001903/*
1904 * Same behavior as encode_string() above, except that it encodes chunk
1905 * <chunk> instead of a string.
1906 */
1907char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001908 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001909 const struct buffer *chunk)
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001910{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001911 char *str = chunk->area;
1912 char *end = chunk->area + chunk->data;
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001913
1914 if (start < stop) {
1915 stop--; /* reserve one byte for the final '\0' */
1916 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001917 if (!ha_bit_test((unsigned char)(*str), map))
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001918 *start++ = *str;
1919 else {
1920 if (start + 3 >= stop)
1921 break;
1922 *start++ = escape;
1923 *start++ = hextab[(*str >> 4) & 15];
1924 *start++ = hextab[*str & 15];
1925 }
1926 str++;
1927 }
1928 *start = '\0';
1929 }
1930 return start;
1931}
1932
Dragan Dosen0edd1092016-02-12 13:23:02 +01001933/*
1934 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001935 * character. The input <string> must be zero-terminated. The result will
1936 * be stored between <start> (included) and <stop> (excluded). This
1937 * function will always try to terminate the resulting string with a '\0'
1938 * before <stop>, and will return its position if the conversion
1939 * completes.
1940 */
1941char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001942 const char escape, const long *map,
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001943 const char *string)
1944{
1945 if (start < stop) {
1946 stop--; /* reserve one byte for the final '\0' */
1947 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001948 if (!ha_bit_test((unsigned char)(*string), map))
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001949 *start++ = *string;
1950 else {
1951 if (start + 2 >= stop)
1952 break;
1953 *start++ = escape;
1954 *start++ = *string;
1955 }
1956 string++;
1957 }
1958 *start = '\0';
1959 }
1960 return start;
1961}
1962
1963/*
1964 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +01001965 * character. <chunk> contains the input to be escaped. The result will be
1966 * stored between <start> (included) and <stop> (excluded). The function
1967 * will always try to terminate the resulting string with a '\0' before
1968 * <stop>, and will return its position if the conversion completes.
1969 */
1970char *escape_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001971 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001972 const struct buffer *chunk)
Dragan Dosen0edd1092016-02-12 13:23:02 +01001973{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001974 char *str = chunk->area;
1975 char *end = chunk->area + chunk->data;
Dragan Dosen0edd1092016-02-12 13:23:02 +01001976
1977 if (start < stop) {
1978 stop--; /* reserve one byte for the final '\0' */
1979 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001980 if (!ha_bit_test((unsigned char)(*str), map))
Dragan Dosen0edd1092016-02-12 13:23:02 +01001981 *start++ = *str;
1982 else {
1983 if (start + 2 >= stop)
1984 break;
1985 *start++ = escape;
1986 *start++ = *str;
1987 }
1988 str++;
1989 }
1990 *start = '\0';
1991 }
1992 return start;
1993}
1994
Thierry FOURNIERddea6262015-05-28 16:00:28 +02001995/* Check a string for using it in a CSV output format. If the string contains
1996 * one of the following four char <">, <,>, CR or LF, the string is
1997 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
1998 * <str> is the input string to be escaped. The function assumes that
1999 * the input string is null-terminated.
2000 *
2001 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +01002002 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002003 * format.
2004 *
Willy Tarreau898529b2016-01-06 18:07:04 +01002005 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002006 *
Willy Tarreaub631c292016-01-08 10:04:08 +01002007 * If <quote> is 1, the converter puts the quotes only if any reserved character
2008 * is present. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002009 *
Willy Tarreau83061a82018-07-13 11:56:34 +02002010 * <output> is a struct buffer used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002011 *
Willy Tarreau898529b2016-01-06 18:07:04 +01002012 * The function returns the converted string on its output. If an error
2013 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002014 * for using the function directly as printf() argument.
2015 *
2016 * If the output buffer is too short to contain the input string, the result
2017 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +01002018 *
Willy Tarreaub631c292016-01-08 10:04:08 +01002019 * This function appends the encoding to the existing output chunk, and it
2020 * guarantees that it starts immediately at the first available character of
2021 * the chunk. Please use csv_enc() instead if you want to replace the output
2022 * chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002023 */
Willy Tarreau83061a82018-07-13 11:56:34 +02002024const char *csv_enc_append(const char *str, int quote, struct buffer *output)
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002025{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002026 char *end = output->area + output->size;
2027 char *out = output->area + output->data;
Willy Tarreau898529b2016-01-06 18:07:04 +01002028 char *ptr = out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002029
Willy Tarreaub631c292016-01-08 10:04:08 +01002030 if (quote == 1) {
2031 /* automatic quoting: first verify if we'll have to quote the string */
2032 if (!strpbrk(str, "\n\r,\""))
2033 quote = 0;
2034 }
2035
2036 if (quote)
2037 *ptr++ = '"';
2038
Willy Tarreau898529b2016-01-06 18:07:04 +01002039 while (*str && ptr < end - 2) { /* -2 for reserving space for <"> and \0. */
2040 *ptr = *str;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002041 if (*str == '"') {
Willy Tarreau898529b2016-01-06 18:07:04 +01002042 ptr++;
2043 if (ptr >= end - 2) {
2044 ptr--;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002045 break;
2046 }
Willy Tarreau898529b2016-01-06 18:07:04 +01002047 *ptr = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002048 }
Willy Tarreau898529b2016-01-06 18:07:04 +01002049 ptr++;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002050 str++;
2051 }
2052
Willy Tarreaub631c292016-01-08 10:04:08 +01002053 if (quote)
2054 *ptr++ = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002055
Willy Tarreau898529b2016-01-06 18:07:04 +01002056 *ptr = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002057 output->data = ptr - output->area;
Willy Tarreau898529b2016-01-06 18:07:04 +01002058 return out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002059}
2060
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002061/* Decode an URL-encoded string in-place. The resulting string might
2062 * be shorter. If some forbidden characters are found, the conversion is
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002063 * aborted, the string is truncated before the issue and a negative value is
2064 * returned, otherwise the operation returns the length of the decoded string.
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002065 * If the 'in_form' argument is non-nul the string is assumed to be part of
2066 * an "application/x-www-form-urlencoded" encoded string, and the '+' will be
2067 * turned to a space. If it's zero, this will only be done after a question
2068 * mark ('?').
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002069 */
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002070int url_decode(char *string, int in_form)
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002071{
2072 char *in, *out;
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002073 int ret = -1;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002074
2075 in = string;
2076 out = string;
2077 while (*in) {
2078 switch (*in) {
2079 case '+' :
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002080 *out++ = in_form ? ' ' : *in;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002081 break;
2082 case '%' :
2083 if (!ishex(in[1]) || !ishex(in[2]))
2084 goto end;
2085 *out++ = (hex2i(in[1]) << 4) + hex2i(in[2]);
2086 in += 2;
2087 break;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002088 case '?':
2089 in_form = 1;
2090 /* fall through */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002091 default:
2092 *out++ = *in;
2093 break;
2094 }
2095 in++;
2096 }
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002097 ret = out - string; /* success */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002098 end:
2099 *out = 0;
2100 return ret;
2101}
Willy Tarreaubaaee002006-06-26 02:48:02 +02002102
Willy Tarreau6911fa42007-03-04 18:06:08 +01002103unsigned int str2ui(const char *s)
2104{
2105 return __str2ui(s);
2106}
2107
2108unsigned int str2uic(const char *s)
2109{
2110 return __str2uic(s);
2111}
2112
2113unsigned int strl2ui(const char *s, int len)
2114{
2115 return __strl2ui(s, len);
2116}
2117
2118unsigned int strl2uic(const char *s, int len)
2119{
2120 return __strl2uic(s, len);
2121}
2122
Willy Tarreau4ec83cd2010-10-15 23:19:55 +02002123unsigned int read_uint(const char **s, const char *end)
2124{
2125 return __read_uint(s, end);
2126}
2127
Thierry FOURNIER763a5d82015-07-06 23:09:52 +02002128/* This function reads an unsigned integer from the string pointed to by <s> and
2129 * returns it. The <s> pointer is adjusted to point to the first unread char. The
2130 * function automatically stops at <end>. If the number overflows, the 2^64-1
2131 * value is returned.
2132 */
2133unsigned long long int read_uint64(const char **s, const char *end)
2134{
2135 const char *ptr = *s;
2136 unsigned long long int i = 0, tmp;
2137 unsigned int j;
2138
2139 while (ptr < end) {
2140
2141 /* read next char */
2142 j = *ptr - '0';
2143 if (j > 9)
2144 goto read_uint64_end;
2145
2146 /* add char to the number and check overflow. */
2147 tmp = i * 10;
2148 if (tmp / 10 != i) {
2149 i = ULLONG_MAX;
2150 goto read_uint64_eat;
2151 }
2152 if (ULLONG_MAX - tmp < j) {
2153 i = ULLONG_MAX;
2154 goto read_uint64_eat;
2155 }
2156 i = tmp + j;
2157 ptr++;
2158 }
2159read_uint64_eat:
2160 /* eat each numeric char */
2161 while (ptr < end) {
2162 if ((unsigned int)(*ptr - '0') > 9)
2163 break;
2164 ptr++;
2165 }
2166read_uint64_end:
2167 *s = ptr;
2168 return i;
2169}
2170
2171/* This function reads an integer from the string pointed to by <s> and returns
2172 * it. The <s> pointer is adjusted to point to the first unread char. The function
2173 * automatically stops at <end>. Il the number is bigger than 2^63-2, the 2^63-1
2174 * value is returned. If the number is lowest than -2^63-1, the -2^63 value is
2175 * returned.
2176 */
2177long long int read_int64(const char **s, const char *end)
2178{
2179 unsigned long long int i = 0;
2180 int neg = 0;
2181
2182 /* Look for minus char. */
2183 if (**s == '-') {
2184 neg = 1;
2185 (*s)++;
2186 }
2187 else if (**s == '+')
2188 (*s)++;
2189
2190 /* convert as positive number. */
2191 i = read_uint64(s, end);
2192
2193 if (neg) {
2194 if (i > 0x8000000000000000ULL)
2195 return LLONG_MIN;
2196 return -i;
2197 }
2198 if (i > 0x7fffffffffffffffULL)
2199 return LLONG_MAX;
2200 return i;
2201}
2202
Willy Tarreau6911fa42007-03-04 18:06:08 +01002203/* This one is 7 times faster than strtol() on athlon with checks.
2204 * It returns the value of the number composed of all valid digits read,
2205 * and can process negative numbers too.
2206 */
2207int strl2ic(const char *s, int len)
2208{
2209 int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002210 int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002211
2212 if (len > 0) {
2213 if (*s != '-') {
2214 /* positive number */
2215 while (len-- > 0) {
2216 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002217 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002218 if (j > 9)
2219 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002220 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002221 }
2222 } else {
2223 /* negative number */
2224 s++;
2225 while (--len > 0) {
2226 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002227 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002228 if (j > 9)
2229 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002230 i = k - j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002231 }
2232 }
2233 }
2234 return i;
2235}
2236
2237
2238/* This function reads exactly <len> chars from <s> and converts them to a
2239 * signed integer which it stores into <ret>. It accurately detects any error
2240 * (truncated string, invalid chars, overflows). It is meant to be used in
2241 * applications designed for hostile environments. It returns zero when the
2242 * number has successfully been converted, non-zero otherwise. When an error
2243 * is returned, the <ret> value is left untouched. It is yet 5 to 40 times
2244 * faster than strtol().
2245 */
2246int strl2irc(const char *s, int len, int *ret)
2247{
2248 int i = 0;
2249 int j;
2250
2251 if (!len)
2252 return 1;
2253
2254 if (*s != '-') {
2255 /* positive number */
2256 while (len-- > 0) {
2257 j = (*s++) - '0';
2258 if (j > 9) return 1; /* invalid char */
2259 if (i > INT_MAX / 10) return 1; /* check for multiply overflow */
2260 i = i * 10;
2261 if (i + j < i) return 1; /* check for addition overflow */
2262 i = i + j;
2263 }
2264 } else {
2265 /* negative number */
2266 s++;
2267 while (--len > 0) {
2268 j = (*s++) - '0';
2269 if (j > 9) return 1; /* invalid char */
2270 if (i < INT_MIN / 10) return 1; /* check for multiply overflow */
2271 i = i * 10;
2272 if (i - j > i) return 1; /* check for subtract overflow */
2273 i = i - j;
2274 }
2275 }
2276 *ret = i;
2277 return 0;
2278}
2279
2280
2281/* This function reads exactly <len> chars from <s> and converts them to a
2282 * signed integer which it stores into <ret>. It accurately detects any error
2283 * (truncated string, invalid chars, overflows). It is meant to be used in
2284 * applications designed for hostile environments. It returns zero when the
2285 * number has successfully been converted, non-zero otherwise. When an error
2286 * is returned, the <ret> value is left untouched. It is about 3 times slower
William Dauchy060ffc82021-02-06 20:47:51 +01002287 * than strl2irc().
Willy Tarreau6911fa42007-03-04 18:06:08 +01002288 */
Willy Tarreau6911fa42007-03-04 18:06:08 +01002289
2290int strl2llrc(const char *s, int len, long long *ret)
2291{
2292 long long i = 0;
2293 int j;
2294
2295 if (!len)
2296 return 1;
2297
2298 if (*s != '-') {
2299 /* positive number */
2300 while (len-- > 0) {
2301 j = (*s++) - '0';
2302 if (j > 9) return 1; /* invalid char */
2303 if (i > LLONG_MAX / 10LL) return 1; /* check for multiply overflow */
2304 i = i * 10LL;
2305 if (i + j < i) return 1; /* check for addition overflow */
2306 i = i + j;
2307 }
2308 } else {
2309 /* negative number */
2310 s++;
2311 while (--len > 0) {
2312 j = (*s++) - '0';
2313 if (j > 9) return 1; /* invalid char */
2314 if (i < LLONG_MIN / 10LL) return 1; /* check for multiply overflow */
2315 i = i * 10LL;
2316 if (i - j > i) return 1; /* check for subtract overflow */
2317 i = i - j;
2318 }
2319 }
2320 *ret = i;
2321 return 0;
2322}
2323
Thierry FOURNIER511e9472014-01-23 17:40:34 +01002324/* This function is used with pat_parse_dotted_ver(). It converts a string
2325 * composed by two number separated by a dot. Each part must contain in 16 bits
2326 * because internally they will be represented as a 32-bit quantity stored in
2327 * a 64-bit integer. It returns zero when the number has successfully been
2328 * converted, non-zero otherwise. When an error is returned, the <ret> value
2329 * is left untouched.
2330 *
2331 * "1.3" -> 0x0000000000010003
2332 * "65535.65535" -> 0x00000000ffffffff
2333 */
2334int strl2llrc_dotted(const char *text, int len, long long *ret)
2335{
2336 const char *end = &text[len];
2337 const char *p;
2338 long long major, minor;
2339
2340 /* Look for dot. */
2341 for (p = text; p < end; p++)
2342 if (*p == '.')
2343 break;
2344
2345 /* Convert major. */
2346 if (strl2llrc(text, p - text, &major) != 0)
2347 return 1;
2348
2349 /* Check major. */
2350 if (major >= 65536)
2351 return 1;
2352
2353 /* Convert minor. */
2354 minor = 0;
2355 if (p < end)
2356 if (strl2llrc(p + 1, end - (p + 1), &minor) != 0)
2357 return 1;
2358
2359 /* Check minor. */
2360 if (minor >= 65536)
2361 return 1;
2362
2363 /* Compose value. */
2364 *ret = (major << 16) | (minor & 0xffff);
2365 return 0;
2366}
2367
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002368/* This function parses a time value optionally followed by a unit suffix among
2369 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
2370 * expected by the caller. The computation does its best to avoid overflows.
2371 * The value is returned in <ret> if everything is fine, and a NULL is returned
2372 * by the function. In case of error, a pointer to the error is returned and
2373 * <ret> is left untouched. Values are automatically rounded up when needed.
Willy Tarreau9faebe32019-06-07 19:00:37 +02002374 * Values resulting in values larger than or equal to 2^31 after conversion are
2375 * reported as an overflow as value PARSE_TIME_OVER. Non-null values resulting
2376 * in an underflow are reported as an underflow as value PARSE_TIME_UNDER.
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002377 */
2378const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags)
2379{
Willy Tarreau9faebe32019-06-07 19:00:37 +02002380 unsigned long long imult, idiv;
2381 unsigned long long omult, odiv;
2382 unsigned long long value, result;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002383 const char *str = text;
2384
2385 if (!isdigit((unsigned char)*text))
2386 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002387
2388 omult = odiv = 1;
2389
2390 switch (unit_flags & TIME_UNIT_MASK) {
2391 case TIME_UNIT_US: omult = 1000000; break;
2392 case TIME_UNIT_MS: omult = 1000; break;
2393 case TIME_UNIT_S: break;
2394 case TIME_UNIT_MIN: odiv = 60; break;
2395 case TIME_UNIT_HOUR: odiv = 3600; break;
2396 case TIME_UNIT_DAY: odiv = 86400; break;
2397 default: break;
2398 }
2399
2400 value = 0;
2401
2402 while (1) {
2403 unsigned int j;
2404
2405 j = *text - '0';
2406 if (j > 9)
2407 break;
2408 text++;
2409 value *= 10;
2410 value += j;
2411 }
2412
2413 imult = idiv = 1;
2414 switch (*text) {
2415 case '\0': /* no unit = default unit */
2416 imult = omult = idiv = odiv = 1;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002417 goto end;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002418 case 's': /* second = unscaled unit */
2419 break;
2420 case 'u': /* microsecond : "us" */
2421 if (text[1] == 's') {
2422 idiv = 1000000;
2423 text++;
Thayne McCombsa6838052021-04-02 14:12:43 -06002424 break;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002425 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002426 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002427 case 'm': /* millisecond : "ms" or minute: "m" */
2428 if (text[1] == 's') {
2429 idiv = 1000;
2430 text++;
2431 } else
2432 imult = 60;
2433 break;
2434 case 'h': /* hour : "h" */
2435 imult = 3600;
2436 break;
2437 case 'd': /* day : "d" */
2438 imult = 86400;
2439 break;
2440 default:
2441 return text;
2442 break;
2443 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002444 if (*(++text) != '\0') {
2445 ha_warning("unexpected character '%c' after the timer value '%s', only "
2446 "(us=microseconds,ms=milliseconds,s=seconds,m=minutes,h=hours,d=days) are supported."
2447 " This will be reported as an error in next versions.\n", *text, str);
2448 }
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002449
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002450 end:
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002451 if (omult % idiv == 0) { omult /= idiv; idiv = 1; }
2452 if (idiv % omult == 0) { idiv /= omult; omult = 1; }
2453 if (imult % odiv == 0) { imult /= odiv; odiv = 1; }
2454 if (odiv % imult == 0) { odiv /= imult; imult = 1; }
2455
Willy Tarreau9faebe32019-06-07 19:00:37 +02002456 result = (value * (imult * omult) + (idiv * odiv - 1)) / (idiv * odiv);
2457 if (result >= 0x80000000)
2458 return PARSE_TIME_OVER;
2459 if (!result && value)
2460 return PARSE_TIME_UNDER;
2461 *ret = result;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002462 return NULL;
2463}
Willy Tarreau6911fa42007-03-04 18:06:08 +01002464
Emeric Brun39132b22010-01-04 14:57:24 +01002465/* this function converts the string starting at <text> to an unsigned int
2466 * stored in <ret>. If an error is detected, the pointer to the unexpected
Joseph Herlant32b83272018-11-15 11:58:28 -08002467 * character is returned. If the conversion is successful, NULL is returned.
Emeric Brun39132b22010-01-04 14:57:24 +01002468 */
2469const char *parse_size_err(const char *text, unsigned *ret) {
2470 unsigned value = 0;
2471
Christopher Faulet82635a02020-12-11 09:30:45 +01002472 if (!isdigit((unsigned char)*text))
2473 return text;
2474
Emeric Brun39132b22010-01-04 14:57:24 +01002475 while (1) {
2476 unsigned int j;
2477
2478 j = *text - '0';
2479 if (j > 9)
2480 break;
2481 if (value > ~0U / 10)
2482 return text;
2483 value *= 10;
2484 if (value > (value + j))
2485 return text;
2486 value += j;
2487 text++;
2488 }
2489
2490 switch (*text) {
2491 case '\0':
2492 break;
2493 case 'K':
2494 case 'k':
2495 if (value > ~0U >> 10)
2496 return text;
2497 value = value << 10;
2498 break;
2499 case 'M':
2500 case 'm':
2501 if (value > ~0U >> 20)
2502 return text;
2503 value = value << 20;
2504 break;
2505 case 'G':
2506 case 'g':
2507 if (value > ~0U >> 30)
2508 return text;
2509 value = value << 30;
2510 break;
2511 default:
2512 return text;
2513 }
2514
Godbach58048a22015-01-28 17:36:16 +08002515 if (*text != '\0' && *++text != '\0')
2516 return text;
2517
Emeric Brun39132b22010-01-04 14:57:24 +01002518 *ret = value;
2519 return NULL;
2520}
2521
Willy Tarreau126d4062013-12-03 17:50:47 +01002522/*
2523 * Parse binary string written in hexadecimal (source) and store the decoded
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002524 * result into binstr and set binstrlen to the length of binstr. Memory for
Willy Tarreau126d4062013-12-03 17:50:47 +01002525 * binstr is allocated by the function. In case of error, returns 0 with an
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002526 * error message in err. In success case, it returns the consumed length.
Willy Tarreau126d4062013-12-03 17:50:47 +01002527 */
2528int parse_binary(const char *source, char **binstr, int *binstrlen, char **err)
2529{
2530 int len;
2531 const char *p = source;
2532 int i,j;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002533 int alloc;
Willy Tarreau126d4062013-12-03 17:50:47 +01002534
2535 len = strlen(source);
2536 if (len % 2) {
2537 memprintf(err, "an even number of hex digit is expected");
2538 return 0;
2539 }
2540
2541 len = len >> 1;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002542
Willy Tarreau126d4062013-12-03 17:50:47 +01002543 if (!*binstr) {
Tim Duesterhuse52b6e52020-09-12 20:26:43 +02002544 *binstr = calloc(len, sizeof(**binstr));
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002545 if (!*binstr) {
2546 memprintf(err, "out of memory while loading string pattern");
2547 return 0;
2548 }
2549 alloc = 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002550 }
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002551 else {
2552 if (*binstrlen < len) {
Joseph Herlant76dbe782018-11-15 12:01:22 -08002553 memprintf(err, "no space available in the buffer. expect %d, provides %d",
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002554 len, *binstrlen);
2555 return 0;
2556 }
2557 alloc = 0;
2558 }
2559 *binstrlen = len;
Willy Tarreau126d4062013-12-03 17:50:47 +01002560
2561 i = j = 0;
2562 while (j < len) {
2563 if (!ishex(p[i++]))
2564 goto bad_input;
2565 if (!ishex(p[i++]))
2566 goto bad_input;
2567 (*binstr)[j++] = (hex2i(p[i-2]) << 4) + hex2i(p[i-1]);
2568 }
Thierry FOURNIERee330af2014-01-21 11:36:14 +01002569 return len << 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002570
2571bad_input:
2572 memprintf(err, "an hex digit is expected (found '%c')", p[i-1]);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002573 if (alloc)
2574 ha_free(binstr);
Willy Tarreau126d4062013-12-03 17:50:47 +01002575 return 0;
2576}
2577
Willy Tarreau946ba592009-05-10 15:41:18 +02002578/* copies at most <n> characters from <src> and always terminates with '\0' */
2579char *my_strndup(const char *src, int n)
2580{
2581 int len = 0;
2582 char *ret;
2583
2584 while (len < n && src[len])
2585 len++;
2586
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02002587 ret = malloc(len + 1);
Willy Tarreau946ba592009-05-10 15:41:18 +02002588 if (!ret)
2589 return ret;
2590 memcpy(ret, src, len);
2591 ret[len] = '\0';
2592 return ret;
2593}
2594
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +02002595/*
2596 * search needle in haystack
2597 * returns the pointer if found, returns NULL otherwise
2598 */
2599const void *my_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen)
2600{
2601 const void *c = NULL;
2602 unsigned char f;
2603
2604 if ((haystack == NULL) || (needle == NULL) || (haystacklen < needlelen))
2605 return NULL;
2606
2607 f = *(char *)needle;
2608 c = haystack;
2609 while ((c = memchr(c, f, haystacklen - (c - haystack))) != NULL) {
2610 if ((haystacklen - (c - haystack)) < needlelen)
2611 return NULL;
2612
2613 if (memcmp(c, needle, needlelen) == 0)
2614 return c;
2615 ++c;
2616 }
2617 return NULL;
2618}
2619
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002620/* get length of the initial segment consisting entirely of bytes in <accept> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002621size_t my_memspn(const void *str, size_t len, const void *accept, size_t acceptlen)
2622{
2623 size_t ret = 0;
2624
2625 while (ret < len && memchr(accept, *((int *)str), acceptlen)) {
2626 str++;
2627 ret++;
2628 }
2629 return ret;
2630}
2631
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002632/* get length of the initial segment consisting entirely of bytes not in <rejcet> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002633size_t my_memcspn(const void *str, size_t len, const void *reject, size_t rejectlen)
2634{
2635 size_t ret = 0;
2636
2637 while (ret < len) {
2638 if(memchr(reject, *((int *)str), rejectlen))
2639 return ret;
2640 str++;
2641 ret++;
2642 }
2643 return ret;
2644}
2645
Willy Tarreau482b00d2009-10-04 22:48:42 +02002646/* This function returns the first unused key greater than or equal to <key> in
2647 * ID tree <root>. Zero is returned if no place is found.
2648 */
2649unsigned int get_next_id(struct eb_root *root, unsigned int key)
2650{
2651 struct eb32_node *used;
2652
2653 do {
2654 used = eb32_lookup_ge(root, key);
2655 if (!used || used->key > key)
2656 return key; /* key is available */
2657 key++;
2658 } while (key);
2659 return key;
2660}
2661
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002662/* dump the full tree to <file> in DOT format for debugging purposes. Will
2663 * optionally highlight node <subj> if found, depending on operation <op> :
2664 * 0 : nothing
2665 * >0 : insertion, node/leaf are surrounded in red
2666 * <0 : removal, node/leaf are dashed with no background
2667 * Will optionally add "desc" as a label on the graph if set and non-null.
2668 */
2669void 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 +01002670{
2671 struct eb32sc_node *node;
2672 unsigned long scope = -1;
2673
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002674 fprintf(file, "digraph ebtree {\n");
2675
2676 if (desc && *desc) {
2677 fprintf(file,
2678 " fontname=\"fixed\";\n"
2679 " fontsize=8;\n"
2680 " label=\"%s\";\n", desc);
2681 }
2682
Willy Tarreaued3cda02017-11-15 15:04:05 +01002683 fprintf(file,
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002684 " node [fontname=\"fixed\" fontsize=8 shape=\"box\" style=\"filled\" color=\"black\" fillcolor=\"white\"];\n"
2685 " edge [fontname=\"fixed\" fontsize=8 style=\"solid\" color=\"magenta\" dir=\"forward\"];\n"
Willy Tarreaued3cda02017-11-15 15:04:05 +01002686 " \"%lx_n\" [label=\"root\\n%lx\"]\n", (long)eb_root_to_node(root), (long)root
2687 );
2688
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002689 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002690 (long)eb_root_to_node(root),
2691 (long)eb_root_to_node(eb_clrtag(root->b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002692 eb_gettag(root->b[0]) == EB_LEAF ? 'l' : 'n');
2693
2694 node = eb32sc_first(root, scope);
2695 while (node) {
2696 if (node->node.node_p) {
2697 /* node part is used */
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002698 fprintf(file, " \"%lx_n\" [label=\"%lx\\nkey=%u\\nscope=%lx\\nbit=%d\" fillcolor=\"lightskyblue1\" %s];\n",
2699 (long)node, (long)node, node->key, node->node_s, node->node.bit,
2700 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002701
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002702 fprintf(file, " \"%lx_n\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002703 (long)node,
2704 (long)eb_root_to_node(eb_clrtag(node->node.node_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002705 eb_gettag(node->node.node_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002706
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002707 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002708 (long)node,
2709 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002710 eb_gettag(node->node.branches.b[0]) == EB_LEAF ? 'l' : 'n');
2711
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002712 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"R\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002713 (long)node,
2714 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[1])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002715 eb_gettag(node->node.branches.b[1]) == EB_LEAF ? 'l' : 'n');
2716 }
2717
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002718 fprintf(file, " \"%lx_l\" [label=\"%lx\\nkey=%u\\nscope=%lx\\npfx=%u\" fillcolor=\"yellow\" %s];\n",
2719 (long)node, (long)node, node->key, node->leaf_s, node->node.pfx,
2720 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002721
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002722 fprintf(file, " \"%lx_l\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002723 (long)node,
2724 (long)eb_root_to_node(eb_clrtag(node->node.leaf_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002725 eb_gettag(node->node.leaf_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002726 node = eb32sc_next(node, scope);
2727 }
2728 fprintf(file, "}\n");
2729}
2730
Willy Tarreau348238b2010-01-18 15:05:57 +01002731/* This function compares a sample word possibly followed by blanks to another
2732 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
2733 * otherwise zero. This intends to be used when checking HTTP headers for some
2734 * values. Note that it validates a word followed only by blanks but does not
2735 * validate a word followed by blanks then other chars.
2736 */
2737int word_match(const char *sample, int slen, const char *word, int wlen)
2738{
2739 if (slen < wlen)
2740 return 0;
2741
2742 while (wlen) {
2743 char c = *sample ^ *word;
2744 if (c && c != ('A' ^ 'a'))
2745 return 0;
2746 sample++;
2747 word++;
2748 slen--;
2749 wlen--;
2750 }
2751
2752 while (slen) {
2753 if (*sample != ' ' && *sample != '\t')
2754 return 0;
2755 sample++;
2756 slen--;
2757 }
2758 return 1;
2759}
Willy Tarreau482b00d2009-10-04 22:48:42 +02002760
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002761/* Converts any text-formatted IPv4 address to a host-order IPv4 address. It
2762 * is particularly fast because it avoids expensive operations such as
2763 * multiplies, which are optimized away at the end. It requires a properly
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002764 * formatted address though (3 points).
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002765 */
2766unsigned int inetaddr_host(const char *text)
2767{
2768 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2769 register unsigned int dig100, dig10, dig1;
2770 int s;
2771 const char *p, *d;
2772
2773 dig1 = dig10 = dig100 = ascii_zero;
2774 s = 24;
2775
2776 p = text;
2777 while (1) {
2778 if (((unsigned)(*p - '0')) <= 9) {
2779 p++;
2780 continue;
2781 }
2782
2783 /* here, we have a complete byte between <text> and <p> (exclusive) */
2784 if (p == text)
2785 goto end;
2786
2787 d = p - 1;
2788 dig1 |= (unsigned int)(*d << s);
2789 if (d == text)
2790 goto end;
2791
2792 d--;
2793 dig10 |= (unsigned int)(*d << s);
2794 if (d == text)
2795 goto end;
2796
2797 d--;
2798 dig100 |= (unsigned int)(*d << s);
2799 end:
2800 if (!s || *p != '.')
2801 break;
2802
2803 s -= 8;
2804 text = ++p;
2805 }
2806
2807 dig100 -= ascii_zero;
2808 dig10 -= ascii_zero;
2809 dig1 -= ascii_zero;
2810 return ((dig100 * 10) + dig10) * 10 + dig1;
2811}
2812
2813/*
2814 * Idem except the first unparsed character has to be passed in <stop>.
2815 */
2816unsigned int inetaddr_host_lim(const char *text, const char *stop)
2817{
2818 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2819 register unsigned int dig100, dig10, dig1;
2820 int s;
2821 const char *p, *d;
2822
2823 dig1 = dig10 = dig100 = ascii_zero;
2824 s = 24;
2825
2826 p = text;
2827 while (1) {
2828 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2829 p++;
2830 continue;
2831 }
2832
2833 /* here, we have a complete byte between <text> and <p> (exclusive) */
2834 if (p == text)
2835 goto end;
2836
2837 d = p - 1;
2838 dig1 |= (unsigned int)(*d << s);
2839 if (d == text)
2840 goto end;
2841
2842 d--;
2843 dig10 |= (unsigned int)(*d << s);
2844 if (d == text)
2845 goto end;
2846
2847 d--;
2848 dig100 |= (unsigned int)(*d << s);
2849 end:
2850 if (!s || p == stop || *p != '.')
2851 break;
2852
2853 s -= 8;
2854 text = ++p;
2855 }
2856
2857 dig100 -= ascii_zero;
2858 dig10 -= ascii_zero;
2859 dig1 -= ascii_zero;
2860 return ((dig100 * 10) + dig10) * 10 + dig1;
2861}
2862
2863/*
2864 * Idem except the pointer to first unparsed byte is returned into <ret> which
2865 * must not be NULL.
2866 */
Willy Tarreau74172752010-10-15 23:21:42 +02002867unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret)
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002868{
2869 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2870 register unsigned int dig100, dig10, dig1;
2871 int s;
Willy Tarreau74172752010-10-15 23:21:42 +02002872 char *p, *d;
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002873
2874 dig1 = dig10 = dig100 = ascii_zero;
2875 s = 24;
2876
2877 p = text;
2878 while (1) {
2879 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2880 p++;
2881 continue;
2882 }
2883
2884 /* here, we have a complete byte between <text> and <p> (exclusive) */
2885 if (p == text)
2886 goto end;
2887
2888 d = p - 1;
2889 dig1 |= (unsigned int)(*d << s);
2890 if (d == text)
2891 goto end;
2892
2893 d--;
2894 dig10 |= (unsigned int)(*d << s);
2895 if (d == text)
2896 goto end;
2897
2898 d--;
2899 dig100 |= (unsigned int)(*d << s);
2900 end:
2901 if (!s || p == stop || *p != '.')
2902 break;
2903
2904 s -= 8;
2905 text = ++p;
2906 }
2907
2908 *ret = p;
2909 dig100 -= ascii_zero;
2910 dig10 -= ascii_zero;
2911 dig1 -= ascii_zero;
2912 return ((dig100 * 10) + dig10) * 10 + dig1;
2913}
2914
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002915/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
2916 * or the number of chars read in case of success. Maybe this could be replaced
2917 * by one of the functions above. Also, apparently this function does not support
2918 * hosts above 255 and requires exactly 4 octets.
Willy Tarreau075415a2013-12-12 11:29:39 +01002919 * The destination is only modified on success.
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002920 */
2921int buf2ip(const char *buf, size_t len, struct in_addr *dst)
2922{
2923 const char *addr;
2924 int saw_digit, octets, ch;
2925 u_char tmp[4], *tp;
2926 const char *cp = buf;
2927
2928 saw_digit = 0;
2929 octets = 0;
2930 *(tp = tmp) = 0;
2931
2932 for (addr = buf; addr - buf < len; addr++) {
2933 unsigned char digit = (ch = *addr) - '0';
2934
2935 if (digit > 9 && ch != '.')
2936 break;
2937
2938 if (digit <= 9) {
2939 u_int new = *tp * 10 + digit;
2940
2941 if (new > 255)
2942 return 0;
2943
2944 *tp = new;
2945
2946 if (!saw_digit) {
2947 if (++octets > 4)
2948 return 0;
2949 saw_digit = 1;
2950 }
2951 } else if (ch == '.' && saw_digit) {
2952 if (octets == 4)
2953 return 0;
2954
2955 *++tp = 0;
2956 saw_digit = 0;
2957 } else
2958 return 0;
2959 }
2960
2961 if (octets < 4)
2962 return 0;
2963
2964 memcpy(&dst->s_addr, tmp, 4);
2965 return addr - cp;
2966}
2967
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002968/* This function converts the string in <buf> of the len <len> to
2969 * struct in6_addr <dst> which must be allocated by the caller.
2970 * This function returns 1 in success case, otherwise zero.
Willy Tarreau075415a2013-12-12 11:29:39 +01002971 * The destination is only modified on success.
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002972 */
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002973int buf2ip6(const char *buf, size_t len, struct in6_addr *dst)
2974{
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002975 char null_term_ip6[INET6_ADDRSTRLEN + 1];
Willy Tarreau075415a2013-12-12 11:29:39 +01002976 struct in6_addr out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002977
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002978 if (len > INET6_ADDRSTRLEN)
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002979 return 0;
2980
2981 memcpy(null_term_ip6, buf, len);
2982 null_term_ip6[len] = '\0';
2983
Willy Tarreau075415a2013-12-12 11:29:39 +01002984 if (!inet_pton(AF_INET6, null_term_ip6, &out))
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002985 return 0;
2986
Willy Tarreau075415a2013-12-12 11:29:39 +01002987 *dst = out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002988 return 1;
2989}
2990
Willy Tarreauacf95772010-06-14 19:09:21 +02002991/* To be used to quote config arg positions. Returns the short string at <ptr>
2992 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
2993 * if ptr is NULL or empty. The string is locally allocated.
2994 */
2995const char *quote_arg(const char *ptr)
2996{
Christopher Faulet1bc04c72017-10-29 20:14:08 +01002997 static THREAD_LOCAL char val[32];
Willy Tarreauacf95772010-06-14 19:09:21 +02002998 int i;
2999
3000 if (!ptr || !*ptr)
3001 return "end of line";
3002 val[0] = '\'';
Willy Tarreaude2dd6b2013-01-24 02:14:42 +01003003 for (i = 1; i < sizeof(val) - 2 && *ptr; i++)
Willy Tarreauacf95772010-06-14 19:09:21 +02003004 val[i] = *ptr++;
3005 val[i++] = '\'';
3006 val[i] = '\0';
3007 return val;
3008}
3009
Willy Tarreau5b180202010-07-18 10:40:48 +02003010/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
3011int get_std_op(const char *str)
3012{
3013 int ret = -1;
3014
3015 if (*str == 'e' && str[1] == 'q')
3016 ret = STD_OP_EQ;
3017 else if (*str == 'n' && str[1] == 'e')
3018 ret = STD_OP_NE;
3019 else if (*str == 'l') {
3020 if (str[1] == 'e') ret = STD_OP_LE;
3021 else if (str[1] == 't') ret = STD_OP_LT;
3022 }
3023 else if (*str == 'g') {
3024 if (str[1] == 'e') ret = STD_OP_GE;
3025 else if (str[1] == 't') ret = STD_OP_GT;
3026 }
3027
3028 if (ret == -1 || str[2] != '\0')
3029 return -1;
3030 return ret;
3031}
3032
Willy Tarreau4c14eaa2010-11-24 14:01:45 +01003033/* hash a 32-bit integer to another 32-bit integer */
3034unsigned int full_hash(unsigned int a)
3035{
3036 return __full_hash(a);
3037}
3038
Willy Tarreauf3241112019-02-26 09:56:22 +01003039/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
3040 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
3041 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
3042 * a popcount variant and is described here :
3043 * https://graphics.stanford.edu/~seander/bithacks.html
3044 */
3045unsigned int mask_find_rank_bit(unsigned int r, unsigned long m)
3046{
3047 unsigned long a, b, c, d;
3048 unsigned int s;
3049 unsigned int t;
3050
3051 a = m - ((m >> 1) & ~0UL/3);
3052 b = (a & ~0UL/5) + ((a >> 2) & ~0UL/5);
3053 c = (b + (b >> 4)) & ~0UL/0x11;
3054 d = (c + (c >> 8)) & ~0UL/0x101;
3055
3056 r++; // make r be 1..64
3057
3058 t = 0;
3059 s = LONGBITS;
3060 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01003061 unsigned long d2 = (d >> 16) >> 16;
3062 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01003063 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
3064 }
3065
3066 t = (d >> (s - 16)) & 0xff;
3067 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
3068 t = (c >> (s - 8)) & 0xf;
3069 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
3070 t = (b >> (s - 4)) & 0x7;
3071 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
3072 t = (a >> (s - 2)) & 0x3;
3073 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
3074 t = (m >> (s - 1)) & 0x1;
3075 s -= ((t - r) & 256) >> 8;
3076
3077 return s - 1;
3078}
3079
3080/* Same as mask_find_rank_bit() above but makes use of pre-computed bitmaps
3081 * based on <m>, in <a..d>. These ones must be updated whenever <m> changes
3082 * using mask_prep_rank_map() below.
3083 */
3084unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
3085 unsigned long a, unsigned long b,
3086 unsigned long c, unsigned long d)
3087{
3088 unsigned int s;
3089 unsigned int t;
3090
3091 r++; // make r be 1..64
3092
3093 t = 0;
3094 s = LONGBITS;
3095 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01003096 unsigned long d2 = (d >> 16) >> 16;
3097 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01003098 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
3099 }
3100
3101 t = (d >> (s - 16)) & 0xff;
3102 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
3103 t = (c >> (s - 8)) & 0xf;
3104 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
3105 t = (b >> (s - 4)) & 0x7;
3106 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
3107 t = (a >> (s - 2)) & 0x3;
3108 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
3109 t = (m >> (s - 1)) & 0x1;
3110 s -= ((t - r) & 256) >> 8;
3111
3112 return s - 1;
3113}
3114
3115/* Prepare the bitmaps used by the fast implementation of the find_rank_bit()
3116 * above.
3117 */
3118void mask_prep_rank_map(unsigned long m,
3119 unsigned long *a, unsigned long *b,
3120 unsigned long *c, unsigned long *d)
3121{
3122 *a = m - ((m >> 1) & ~0UL/3);
3123 *b = (*a & ~0UL/5) + ((*a >> 2) & ~0UL/5);
3124 *c = (*b + (*b >> 4)) & ~0UL/0x11;
3125 *d = (*c + (*c >> 8)) & ~0UL/0x101;
3126}
3127
David du Colombier4f92d322011-03-24 11:09:31 +01003128/* Return non-zero if IPv4 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003129 * otherwise zero. Note that <addr> may not necessarily be aligned
3130 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003131 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003132int in_net_ipv4(const void *addr, const struct in_addr *mask, const struct in_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003133{
Willy Tarreaueec1d382016-07-13 11:59:39 +02003134 struct in_addr addr_copy;
3135
3136 memcpy(&addr_copy, addr, sizeof(addr_copy));
3137 return((addr_copy.s_addr & mask->s_addr) == (net->s_addr & mask->s_addr));
David du Colombier4f92d322011-03-24 11:09:31 +01003138}
3139
3140/* Return non-zero if IPv6 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003141 * otherwise zero. Note that <addr> may not necessarily be aligned
3142 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003143 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003144int in_net_ipv6(const void *addr, const struct in6_addr *mask, const struct in6_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003145{
3146 int i;
Willy Tarreaueec1d382016-07-13 11:59:39 +02003147 struct in6_addr addr_copy;
David du Colombier4f92d322011-03-24 11:09:31 +01003148
Willy Tarreaueec1d382016-07-13 11:59:39 +02003149 memcpy(&addr_copy, addr, sizeof(addr_copy));
David du Colombier4f92d322011-03-24 11:09:31 +01003150 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
Willy Tarreaueec1d382016-07-13 11:59:39 +02003151 if (((((int *)&addr_copy)[i] & ((int *)mask)[i])) !=
David du Colombier4f92d322011-03-24 11:09:31 +01003152 (((int *)net)[i] & ((int *)mask)[i]))
3153 return 0;
3154 return 1;
3155}
3156
3157/* RFC 4291 prefix */
3158const char rfc4291_pfx[] = { 0x00, 0x00, 0x00, 0x00,
3159 0x00, 0x00, 0x00, 0x00,
3160 0x00, 0x00, 0xFF, 0xFF };
3161
Joseph Herlant32b83272018-11-15 11:58:28 -08003162/* Map IPv4 address on IPv6 address, as specified in RFC 3513.
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003163 * Input and output may overlap.
3164 */
David du Colombier4f92d322011-03-24 11:09:31 +01003165void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr)
3166{
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003167 struct in_addr tmp_addr;
3168
3169 tmp_addr.s_addr = sin_addr->s_addr;
David du Colombier4f92d322011-03-24 11:09:31 +01003170 memcpy(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx));
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003171 memcpy(sin6_addr->s6_addr+12, &tmp_addr.s_addr, 4);
David du Colombier4f92d322011-03-24 11:09:31 +01003172}
3173
Joseph Herlant32b83272018-11-15 11:58:28 -08003174/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01003175 * Return true if conversion is possible and false otherwise.
3176 */
3177int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr)
3178{
3179 if (memcmp(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx)) == 0) {
3180 memcpy(&(sin_addr->s_addr), &(sin6_addr->s6_addr[12]),
3181 sizeof(struct in_addr));
3182 return 1;
3183 }
3184
3185 return 0;
3186}
3187
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003188/* compare two struct sockaddr_storage and return:
3189 * 0 (true) if the addr is the same in both
3190 * 1 (false) if the addr is not the same in both
3191 * -1 (unable) if one of the addr is not AF_INET*
3192 */
3193int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2)
3194{
3195 if ((ss1->ss_family != AF_INET) && (ss1->ss_family != AF_INET6))
3196 return -1;
3197
3198 if ((ss2->ss_family != AF_INET) && (ss2->ss_family != AF_INET6))
3199 return -1;
3200
3201 if (ss1->ss_family != ss2->ss_family)
3202 return 1;
3203
3204 switch (ss1->ss_family) {
3205 case AF_INET:
3206 return memcmp(&((struct sockaddr_in *)ss1)->sin_addr,
3207 &((struct sockaddr_in *)ss2)->sin_addr,
3208 sizeof(struct in_addr)) != 0;
3209 case AF_INET6:
3210 return memcmp(&((struct sockaddr_in6 *)ss1)->sin6_addr,
3211 &((struct sockaddr_in6 *)ss2)->sin6_addr,
3212 sizeof(struct in6_addr)) != 0;
3213 }
3214
3215 return 1;
3216}
3217
Christopher Faulet9553de72021-02-26 09:12:50 +01003218/* compare a struct sockaddr_storage to a struct net_addr and return :
3219 * 0 (true) if <addr> is matching <net>
3220 * 1 (false) if <addr> is not matching <net>
3221 * -1 (unable) if <addr> or <net> is not AF_INET*
3222 */
3223int ipcmp2net(const struct sockaddr_storage *addr, const struct net_addr *net)
3224{
3225 if ((addr->ss_family != AF_INET) && (addr->ss_family != AF_INET6))
3226 return -1;
3227
3228 if ((net->family != AF_INET) && (net->family != AF_INET6))
3229 return -1;
3230
3231 if (addr->ss_family != net->family)
3232 return 1;
3233
3234 if (addr->ss_family == AF_INET &&
3235 (((struct sockaddr_in *)addr)->sin_addr.s_addr & net->addr.v4.mask.s_addr) == net->addr.v4.ip.s_addr)
3236 return 0;
3237 else {
3238 const struct in6_addr *addr6 = &(((const struct sockaddr_in6*)addr)->sin6_addr);
3239 const struct in6_addr *nip6 = &net->addr.v6.ip;
3240 const struct in6_addr *nmask6 = &net->addr.v6.mask;
3241
3242 if ((read_u32(&addr6->s6_addr[0]) & read_u32(&nmask6->s6_addr[0])) == read_u32(&nip6->s6_addr[0]) &&
3243 (read_u32(&addr6->s6_addr[4]) & read_u32(&nmask6->s6_addr[4])) == read_u32(&nip6->s6_addr[4]) &&
3244 (read_u32(&addr6->s6_addr[8]) & read_u32(&nmask6->s6_addr[8])) == read_u32(&nip6->s6_addr[8]) &&
3245 (read_u32(&addr6->s6_addr[12]) & read_u32(&nmask6->s6_addr[12])) == read_u32(&nip6->s6_addr[12]))
3246 return 0;
3247 }
3248
3249 return 1;
3250}
3251
Baptiste Assmann08396c82016-01-31 00:27:17 +01003252/* copy IP address from <source> into <dest>
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003253 * The caller must allocate and clear <dest> before calling.
3254 * The source must be in either AF_INET or AF_INET6 family, or the destination
3255 * address will be undefined. If the destination address used to hold a port,
3256 * it is preserved, so that this function can be used to switch to another
3257 * address family with no risk. Returns a pointer to the destination.
Baptiste Assmann08396c82016-01-31 00:27:17 +01003258 */
3259struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest)
3260{
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003261 int prev_port;
3262
3263 prev_port = get_net_port(dest);
3264 memset(dest, 0, sizeof(*dest));
Baptiste Assmann08396c82016-01-31 00:27:17 +01003265 dest->ss_family = source->ss_family;
3266
3267 /* copy new addr and apply it */
3268 switch (source->ss_family) {
3269 case AF_INET:
3270 ((struct sockaddr_in *)dest)->sin_addr.s_addr = ((struct sockaddr_in *)source)->sin_addr.s_addr;
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003271 ((struct sockaddr_in *)dest)->sin_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003272 break;
3273 case AF_INET6:
3274 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 +01003275 ((struct sockaddr_in6 *)dest)->sin6_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003276 break;
3277 }
3278
3279 return dest;
3280}
3281
William Lallemand421f5b52012-02-06 18:15:57 +01003282char *human_time(int t, short hz_div) {
3283 static char rv[sizeof("24855d23h")+1]; // longest of "23h59m" and "59m59s"
3284 char *p = rv;
Willy Tarreau761b3d52014-04-14 14:53:06 +02003285 char *end = rv + sizeof(rv);
William Lallemand421f5b52012-02-06 18:15:57 +01003286 int cnt=2; // print two numbers
3287
3288 if (unlikely(t < 0 || hz_div <= 0)) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003289 snprintf(p, end - p, "?");
William Lallemand421f5b52012-02-06 18:15:57 +01003290 return rv;
3291 }
3292
3293 if (unlikely(hz_div > 1))
3294 t /= hz_div;
3295
3296 if (t >= DAY) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003297 p += snprintf(p, end - p, "%dd", t / DAY);
William Lallemand421f5b52012-02-06 18:15:57 +01003298 cnt--;
3299 }
3300
3301 if (cnt && t % DAY / HOUR) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003302 p += snprintf(p, end - p, "%dh", t % DAY / HOUR);
William Lallemand421f5b52012-02-06 18:15:57 +01003303 cnt--;
3304 }
3305
3306 if (cnt && t % HOUR / MINUTE) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003307 p += snprintf(p, end - p, "%dm", t % HOUR / MINUTE);
William Lallemand421f5b52012-02-06 18:15:57 +01003308 cnt--;
3309 }
3310
3311 if ((cnt && t % MINUTE) || !t) // also display '0s'
Willy Tarreau761b3d52014-04-14 14:53:06 +02003312 p += snprintf(p, end - p, "%ds", t % MINUTE / SEC);
William Lallemand421f5b52012-02-06 18:15:57 +01003313
3314 return rv;
3315}
3316
3317const char *monthname[12] = {
3318 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
3319 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
3320};
3321
3322/* date2str_log: write a date in the format :
3323 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
3324 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3325 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
3326 *
3327 * without using sprintf. return a pointer to the last char written (\0) or
3328 * NULL if there isn't enough space.
3329 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02003330char *date2str_log(char *dst, const struct tm *tm, const struct timeval *date, size_t size)
William Lallemand421f5b52012-02-06 18:15:57 +01003331{
3332
3333 if (size < 25) /* the size is fixed: 24 chars + \0 */
3334 return NULL;
3335
3336 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003337 if (!dst)
3338 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003339 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003340
William Lallemand421f5b52012-02-06 18:15:57 +01003341 memcpy(dst, monthname[tm->tm_mon], 3); // month
3342 dst += 3;
3343 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003344
William Lallemand421f5b52012-02-06 18:15:57 +01003345 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003346 if (!dst)
3347 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003348 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003349
William Lallemand421f5b52012-02-06 18:15:57 +01003350 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
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 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003356 if (!dst)
3357 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003358 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003359
William Lallemand421f5b52012-02-06 18:15:57 +01003360 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003361 if (!dst)
3362 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003363 *dst++ = '.';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003364
Willy Tarreau7d9421d2020-02-29 09:08:02 +01003365 dst = utoa_pad((unsigned int)(date->tv_usec/1000)%1000, dst, 4); // milliseconds
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003366 if (!dst)
3367 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003368 *dst = '\0';
3369
3370 return dst;
3371}
3372
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003373/* Base year used to compute leap years */
3374#define TM_YEAR_BASE 1900
3375
3376/* Return the difference in seconds between two times (leap seconds are ignored).
3377 * Retrieved from glibc 2.18 source code.
3378 */
3379static int my_tm_diff(const struct tm *a, const struct tm *b)
3380{
3381 /* Compute intervening leap days correctly even if year is negative.
3382 * Take care to avoid int overflow in leap day calculations,
3383 * but it's OK to assume that A and B are close to each other.
3384 */
3385 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
3386 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
3387 int a100 = a4 / 25 - (a4 % 25 < 0);
3388 int b100 = b4 / 25 - (b4 % 25 < 0);
3389 int a400 = a100 >> 2;
3390 int b400 = b100 >> 2;
3391 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
3392 int years = a->tm_year - b->tm_year;
3393 int days = (365 * years + intervening_leap_days
3394 + (a->tm_yday - b->tm_yday));
3395 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
3396 + (a->tm_min - b->tm_min))
3397 + (a->tm_sec - b->tm_sec));
3398}
3399
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003400/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003401 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003402 * The string returned has the same format as returned by strftime(... "%z", tm).
3403 * Offsets are kept in an internal cache for better performances.
3404 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003405const char *get_gmt_offset(time_t t, struct tm *tm)
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003406{
3407 /* Cache offsets from GMT (depending on whether DST is active or not) */
Christopher Faulet1bc04c72017-10-29 20:14:08 +01003408 static THREAD_LOCAL char gmt_offsets[2][5+1] = { "", "" };
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003409
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003410 char *gmt_offset;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003411 struct tm tm_gmt;
3412 int diff;
3413 int isdst = tm->tm_isdst;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003414
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003415 /* Pretend DST not active if its status is unknown */
3416 if (isdst < 0)
3417 isdst = 0;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003418
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003419 /* Fetch the offset and initialize it if needed */
3420 gmt_offset = gmt_offsets[isdst & 0x01];
3421 if (unlikely(!*gmt_offset)) {
3422 get_gmtime(t, &tm_gmt);
3423 diff = my_tm_diff(tm, &tm_gmt);
3424 if (diff < 0) {
3425 diff = -diff;
3426 *gmt_offset = '-';
3427 } else {
3428 *gmt_offset = '+';
3429 }
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003430 diff %= 86400U;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003431 diff /= 60; /* Convert to minutes */
3432 snprintf(gmt_offset+1, 4+1, "%02d%02d", diff/60, diff%60);
3433 }
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003434
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003435 return gmt_offset;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003436}
3437
William Lallemand421f5b52012-02-06 18:15:57 +01003438/* gmt2str_log: write a date in the format :
3439 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
3440 * return a pointer to the last char written (\0) or
3441 * NULL if there isn't enough space.
3442 */
3443char *gmt2str_log(char *dst, struct tm *tm, size_t size)
3444{
Yuxans Yao4e25b012012-10-19 10:36:09 +08003445 if (size < 27) /* the size is fixed: 26 chars + \0 */
William Lallemand421f5b52012-02-06 18:15:57 +01003446 return NULL;
3447
3448 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003449 if (!dst)
3450 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003451 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003452
William Lallemand421f5b52012-02-06 18:15:57 +01003453 memcpy(dst, monthname[tm->tm_mon], 3); // month
3454 dst += 3;
3455 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003456
William Lallemand421f5b52012-02-06 18:15:57 +01003457 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003458 if (!dst)
3459 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003460 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003461
William Lallemand421f5b52012-02-06 18:15:57 +01003462 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003463 if (!dst)
3464 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003465 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003466
William Lallemand421f5b52012-02-06 18:15:57 +01003467 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003468 if (!dst)
3469 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003470 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003471
William Lallemand421f5b52012-02-06 18:15:57 +01003472 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003473 if (!dst)
3474 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003475 *dst++ = ' ';
3476 *dst++ = '+';
3477 *dst++ = '0';
3478 *dst++ = '0';
3479 *dst++ = '0';
3480 *dst++ = '0';
3481 *dst = '\0';
3482
3483 return dst;
3484}
3485
Yuxans Yao4e25b012012-10-19 10:36:09 +08003486/* localdate2str_log: write a date in the format :
3487 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003488 * Both t and tm must represent the same time.
3489 * return a pointer to the last char written (\0) or
3490 * NULL if there isn't enough space.
Yuxans Yao4e25b012012-10-19 10:36:09 +08003491 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003492char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size)
Yuxans Yao4e25b012012-10-19 10:36:09 +08003493{
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003494 const char *gmt_offset;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003495 if (size < 27) /* the size is fixed: 26 chars + \0 */
3496 return NULL;
3497
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003498 gmt_offset = get_gmt_offset(t, tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003499
Yuxans Yao4e25b012012-10-19 10:36:09 +08003500 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003501 if (!dst)
3502 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003503 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003504
Yuxans Yao4e25b012012-10-19 10:36:09 +08003505 memcpy(dst, monthname[tm->tm_mon], 3); // month
3506 dst += 3;
3507 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003508
Yuxans Yao4e25b012012-10-19 10:36:09 +08003509 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003510 if (!dst)
3511 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003512 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003513
Yuxans Yao4e25b012012-10-19 10:36:09 +08003514 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003515 if (!dst)
3516 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003517 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003518
Yuxans Yao4e25b012012-10-19 10:36:09 +08003519 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003520 if (!dst)
3521 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003522 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003523
Yuxans Yao4e25b012012-10-19 10:36:09 +08003524 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003525 if (!dst)
3526 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003527 *dst++ = ' ';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003528
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003529 memcpy(dst, gmt_offset, 5); // Offset from local time to GMT
Yuxans Yao4e25b012012-10-19 10:36:09 +08003530 dst += 5;
3531 *dst = '\0';
3532
3533 return dst;
3534}
3535
Willy Tarreaucb1949b2017-07-19 19:05:29 +02003536/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
3537 * It is meant as a portable replacement for timegm() for use with valid inputs.
3538 * Returns undefined results for invalid dates (eg: months out of range 0..11).
3539 */
3540time_t my_timegm(const struct tm *tm)
3541{
3542 /* Each month has 28, 29, 30 or 31 days, or 28+N. The date in the year
3543 * is thus (current month - 1)*28 + cumulated_N[month] to count the
3544 * sum of the extra N days for elapsed months. The sum of all these N
3545 * days doesn't exceed 30 for a complete year (366-12*28) so it fits
3546 * in a 5-bit word. This means that with 60 bits we can represent a
3547 * matrix of all these values at once, which is fast and efficient to
3548 * access. The extra February day for leap years is not counted here.
3549 *
3550 * Jan : none = 0 (0)
3551 * Feb : Jan = 3 (3)
3552 * Mar : Jan..Feb = 3 (3 + 0)
3553 * Apr : Jan..Mar = 6 (3 + 0 + 3)
3554 * May : Jan..Apr = 8 (3 + 0 + 3 + 2)
3555 * Jun : Jan..May = 11 (3 + 0 + 3 + 2 + 3)
3556 * Jul : Jan..Jun = 13 (3 + 0 + 3 + 2 + 3 + 2)
3557 * Aug : Jan..Jul = 16 (3 + 0 + 3 + 2 + 3 + 2 + 3)
3558 * Sep : Jan..Aug = 19 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3)
3559 * Oct : Jan..Sep = 21 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2)
3560 * Nov : Jan..Oct = 24 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3)
3561 * Dec : Jan..Nov = 26 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3 + 2)
3562 */
3563 uint64_t extra =
3564 ( 0ULL << 0*5) + ( 3ULL << 1*5) + ( 3ULL << 2*5) + /* Jan, Feb, Mar, */
3565 ( 6ULL << 3*5) + ( 8ULL << 4*5) + (11ULL << 5*5) + /* Apr, May, Jun, */
3566 (13ULL << 6*5) + (16ULL << 7*5) + (19ULL << 8*5) + /* Jul, Aug, Sep, */
3567 (21ULL << 9*5) + (24ULL << 10*5) + (26ULL << 11*5); /* Oct, Nov, Dec, */
3568
3569 unsigned int y = tm->tm_year + 1900;
3570 unsigned int m = tm->tm_mon;
3571 unsigned long days = 0;
3572
3573 /* days since 1/1/1970 for full years */
3574 days += days_since_zero(y) - days_since_zero(1970);
3575
3576 /* days for full months in the current year */
3577 days += 28 * m + ((extra >> (m * 5)) & 0x1f);
3578
3579 /* count + 1 after March for leap years. A leap year is a year multiple
3580 * of 4, unless it's multiple of 100 without being multiple of 400. 2000
3581 * is leap, 1900 isn't, 1904 is.
3582 */
3583 if ((m > 1) && !(y & 3) && ((y % 100) || !(y % 400)))
3584 days++;
3585
3586 days += tm->tm_mday - 1;
3587 return days * 86400ULL + tm->tm_hour * 3600 + tm->tm_min * 60 + tm->tm_sec;
3588}
3589
Thierry Fournier93127942016-01-20 18:49:45 +01003590/* This function check a char. It returns true and updates
3591 * <date> and <len> pointer to the new position if the
3592 * character is found.
3593 */
3594static inline int parse_expect_char(const char **date, int *len, char c)
3595{
3596 if (*len < 1 || **date != c)
3597 return 0;
3598 (*len)--;
3599 (*date)++;
3600 return 1;
3601}
3602
3603/* This function expects a string <str> of len <l>. It return true and updates.
3604 * <date> and <len> if the string matches, otherwise, it returns false.
3605 */
3606static inline int parse_strcmp(const char **date, int *len, char *str, int l)
3607{
3608 if (*len < l || strncmp(*date, str, l) != 0)
3609 return 0;
3610 (*len) -= l;
3611 (*date) += l;
3612 return 1;
3613}
3614
3615/* This macro converts 3 chars name in integer. */
3616#define STR2I3(__a, __b, __c) ((__a) * 65536 + (__b) * 256 + (__c))
3617
3618/* day-name = %x4D.6F.6E ; "Mon", case-sensitive
3619 * / %x54.75.65 ; "Tue", case-sensitive
3620 * / %x57.65.64 ; "Wed", case-sensitive
3621 * / %x54.68.75 ; "Thu", case-sensitive
3622 * / %x46.72.69 ; "Fri", case-sensitive
3623 * / %x53.61.74 ; "Sat", case-sensitive
3624 * / %x53.75.6E ; "Sun", case-sensitive
3625 *
3626 * This array must be alphabetically sorted
3627 */
3628static inline int parse_http_dayname(const char **date, int *len, struct tm *tm)
3629{
3630 if (*len < 3)
3631 return 0;
3632 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3633 case STR2I3('M','o','n'): tm->tm_wday = 1; break;
3634 case STR2I3('T','u','e'): tm->tm_wday = 2; break;
3635 case STR2I3('W','e','d'): tm->tm_wday = 3; break;
3636 case STR2I3('T','h','u'): tm->tm_wday = 4; break;
3637 case STR2I3('F','r','i'): tm->tm_wday = 5; break;
3638 case STR2I3('S','a','t'): tm->tm_wday = 6; break;
3639 case STR2I3('S','u','n'): tm->tm_wday = 7; break;
3640 default: return 0;
3641 }
3642 *len -= 3;
3643 *date += 3;
3644 return 1;
3645}
3646
3647/* month = %x4A.61.6E ; "Jan", case-sensitive
3648 * / %x46.65.62 ; "Feb", case-sensitive
3649 * / %x4D.61.72 ; "Mar", case-sensitive
3650 * / %x41.70.72 ; "Apr", case-sensitive
3651 * / %x4D.61.79 ; "May", case-sensitive
3652 * / %x4A.75.6E ; "Jun", case-sensitive
3653 * / %x4A.75.6C ; "Jul", case-sensitive
3654 * / %x41.75.67 ; "Aug", case-sensitive
3655 * / %x53.65.70 ; "Sep", case-sensitive
3656 * / %x4F.63.74 ; "Oct", case-sensitive
3657 * / %x4E.6F.76 ; "Nov", case-sensitive
3658 * / %x44.65.63 ; "Dec", case-sensitive
3659 *
3660 * This array must be alphabetically sorted
3661 */
3662static inline int parse_http_monthname(const char **date, int *len, struct tm *tm)
3663{
3664 if (*len < 3)
3665 return 0;
3666 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3667 case STR2I3('J','a','n'): tm->tm_mon = 0; break;
3668 case STR2I3('F','e','b'): tm->tm_mon = 1; break;
3669 case STR2I3('M','a','r'): tm->tm_mon = 2; break;
3670 case STR2I3('A','p','r'): tm->tm_mon = 3; break;
3671 case STR2I3('M','a','y'): tm->tm_mon = 4; break;
3672 case STR2I3('J','u','n'): tm->tm_mon = 5; break;
3673 case STR2I3('J','u','l'): tm->tm_mon = 6; break;
3674 case STR2I3('A','u','g'): tm->tm_mon = 7; break;
3675 case STR2I3('S','e','p'): tm->tm_mon = 8; break;
3676 case STR2I3('O','c','t'): tm->tm_mon = 9; break;
3677 case STR2I3('N','o','v'): tm->tm_mon = 10; break;
3678 case STR2I3('D','e','c'): tm->tm_mon = 11; break;
3679 default: return 0;
3680 }
3681 *len -= 3;
3682 *date += 3;
3683 return 1;
3684}
3685
3686/* day-name-l = %x4D.6F.6E.64.61.79 ; "Monday", case-sensitive
3687 * / %x54.75.65.73.64.61.79 ; "Tuesday", case-sensitive
3688 * / %x57.65.64.6E.65.73.64.61.79 ; "Wednesday", case-sensitive
3689 * / %x54.68.75.72.73.64.61.79 ; "Thursday", case-sensitive
3690 * / %x46.72.69.64.61.79 ; "Friday", case-sensitive
3691 * / %x53.61.74.75.72.64.61.79 ; "Saturday", case-sensitive
3692 * / %x53.75.6E.64.61.79 ; "Sunday", case-sensitive
3693 *
3694 * This array must be alphabetically sorted
3695 */
3696static inline int parse_http_ldayname(const char **date, int *len, struct tm *tm)
3697{
3698 if (*len < 6) /* Minimum length. */
3699 return 0;
3700 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3701 case STR2I3('M','o','n'):
3702 RET0_UNLESS(parse_strcmp(date, len, "Monday", 6));
3703 tm->tm_wday = 1;
3704 return 1;
3705 case STR2I3('T','u','e'):
3706 RET0_UNLESS(parse_strcmp(date, len, "Tuesday", 7));
3707 tm->tm_wday = 2;
3708 return 1;
3709 case STR2I3('W','e','d'):
3710 RET0_UNLESS(parse_strcmp(date, len, "Wednesday", 9));
3711 tm->tm_wday = 3;
3712 return 1;
3713 case STR2I3('T','h','u'):
3714 RET0_UNLESS(parse_strcmp(date, len, "Thursday", 8));
3715 tm->tm_wday = 4;
3716 return 1;
3717 case STR2I3('F','r','i'):
3718 RET0_UNLESS(parse_strcmp(date, len, "Friday", 6));
3719 tm->tm_wday = 5;
3720 return 1;
3721 case STR2I3('S','a','t'):
3722 RET0_UNLESS(parse_strcmp(date, len, "Saturday", 8));
3723 tm->tm_wday = 6;
3724 return 1;
3725 case STR2I3('S','u','n'):
3726 RET0_UNLESS(parse_strcmp(date, len, "Sunday", 6));
3727 tm->tm_wday = 7;
3728 return 1;
3729 }
3730 return 0;
3731}
3732
3733/* This function parses exactly 1 digit and returns the numeric value in "digit". */
3734static inline int parse_digit(const char **date, int *len, int *digit)
3735{
3736 if (*len < 1 || **date < '0' || **date > '9')
3737 return 0;
3738 *digit = (**date - '0');
3739 (*date)++;
3740 (*len)--;
3741 return 1;
3742}
3743
3744/* This function parses exactly 2 digits and returns the numeric value in "digit". */
3745static inline int parse_2digit(const char **date, int *len, int *digit)
3746{
3747 int value;
3748
3749 RET0_UNLESS(parse_digit(date, len, &value));
3750 (*digit) = value * 10;
3751 RET0_UNLESS(parse_digit(date, len, &value));
3752 (*digit) += value;
3753
3754 return 1;
3755}
3756
3757/* This function parses exactly 4 digits and returns the numeric value in "digit". */
3758static inline int parse_4digit(const char **date, int *len, int *digit)
3759{
3760 int value;
3761
3762 RET0_UNLESS(parse_digit(date, len, &value));
3763 (*digit) = value * 1000;
3764
3765 RET0_UNLESS(parse_digit(date, len, &value));
3766 (*digit) += value * 100;
3767
3768 RET0_UNLESS(parse_digit(date, len, &value));
3769 (*digit) += value * 10;
3770
3771 RET0_UNLESS(parse_digit(date, len, &value));
3772 (*digit) += value;
3773
3774 return 1;
3775}
3776
3777/* time-of-day = hour ":" minute ":" second
3778 * ; 00:00:00 - 23:59:60 (leap second)
3779 *
3780 * hour = 2DIGIT
3781 * minute = 2DIGIT
3782 * second = 2DIGIT
3783 */
3784static inline int parse_http_time(const char **date, int *len, struct tm *tm)
3785{
3786 RET0_UNLESS(parse_2digit(date, len, &tm->tm_hour)); /* hour 2DIGIT */
3787 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3788 RET0_UNLESS(parse_2digit(date, len, &tm->tm_min)); /* min 2DIGIT */
3789 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3790 RET0_UNLESS(parse_2digit(date, len, &tm->tm_sec)); /* sec 2DIGIT */
3791 return 1;
3792}
3793
3794/* From RFC7231
3795 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3796 *
3797 * IMF-fixdate = day-name "," SP date1 SP time-of-day SP GMT
3798 * ; fixed length/zone/capitalization subset of the format
3799 * ; see Section 3.3 of [RFC5322]
3800 *
3801 *
3802 * date1 = day SP month SP year
3803 * ; e.g., 02 Jun 1982
3804 *
3805 * day = 2DIGIT
3806 * year = 4DIGIT
3807 *
3808 * GMT = %x47.4D.54 ; "GMT", case-sensitive
3809 *
3810 * time-of-day = hour ":" minute ":" second
3811 * ; 00:00:00 - 23:59:60 (leap second)
3812 *
3813 * hour = 2DIGIT
3814 * minute = 2DIGIT
3815 * second = 2DIGIT
3816 *
3817 * DIGIT = decimal 0-9
3818 */
3819int parse_imf_date(const char *date, int len, struct tm *tm)
3820{
David Carlier327298c2016-11-20 10:42:38 +00003821 /* tm_gmtoff, if present, ought to be zero'ed */
3822 memset(tm, 0, sizeof(*tm));
3823
Thierry Fournier93127942016-01-20 18:49:45 +01003824 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3825 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3826 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3827 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3828 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3829 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3830 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3831 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3832 tm->tm_year -= 1900;
3833 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3834 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3835 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3836 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3837 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003838 return 1;
3839}
3840
3841/* From RFC7231
3842 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3843 *
3844 * rfc850-date = day-name-l "," SP date2 SP time-of-day SP GMT
3845 * date2 = day "-" month "-" 2DIGIT
3846 * ; e.g., 02-Jun-82
3847 *
3848 * day = 2DIGIT
3849 */
3850int parse_rfc850_date(const char *date, int len, struct tm *tm)
3851{
3852 int year;
3853
David Carlier327298c2016-11-20 10:42:38 +00003854 /* tm_gmtoff, if present, ought to be zero'ed */
3855 memset(tm, 0, sizeof(*tm));
3856
Thierry Fournier93127942016-01-20 18:49:45 +01003857 RET0_UNLESS(parse_http_ldayname(&date, &len, tm)); /* Read the day name */
3858 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3859 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3860 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3861 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3862 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3863 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3864
3865 /* year = 2DIGIT
3866 *
3867 * Recipients of a timestamp value in rfc850-(*date) format, which uses a
3868 * two-digit year, MUST interpret a timestamp that appears to be more
3869 * than 50 years in the future as representing the most recent year in
3870 * the past that had the same last two digits.
3871 */
3872 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_year));
3873
3874 /* expect SP */
3875 if (!parse_expect_char(&date, &len, ' ')) {
3876 /* Maybe we have the date with 4 digits. */
3877 RET0_UNLESS(parse_2digit(&date, &len, &year));
3878 tm->tm_year = (tm->tm_year * 100 + year) - 1900;
3879 /* expect SP */
3880 RET0_UNLESS(parse_expect_char(&date, &len, ' '));
3881 } else {
3882 /* I fix 60 as pivot: >60: +1900, <60: +2000. Note that the
3883 * tm_year is the number of year since 1900, so for +1900, we
3884 * do nothing, and for +2000, we add 100.
3885 */
3886 if (tm->tm_year <= 60)
3887 tm->tm_year += 100;
3888 }
3889
3890 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3891 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3892 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3893 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003894
3895 return 1;
3896}
3897
3898/* From RFC7231
3899 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3900 *
3901 * asctime-date = day-name SP date3 SP time-of-day SP year
3902 * date3 = month SP ( 2DIGIT / ( SP 1DIGIT ))
3903 * ; e.g., Jun 2
3904 *
3905 * HTTP-date is case sensitive. A sender MUST NOT generate additional
3906 * whitespace in an HTTP-date beyond that specifically included as SP in
3907 * the grammar.
3908 */
3909int parse_asctime_date(const char *date, int len, struct tm *tm)
3910{
David Carlier327298c2016-11-20 10:42:38 +00003911 /* tm_gmtoff, if present, ought to be zero'ed */
3912 memset(tm, 0, sizeof(*tm));
3913
Thierry Fournier93127942016-01-20 18:49:45 +01003914 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3915 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3916 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* expect month */
3917 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3918
3919 /* expect SP and 1DIGIT or 2DIGIT */
3920 if (parse_expect_char(&date, &len, ' '))
3921 RET0_UNLESS(parse_digit(&date, &len, &tm->tm_mday));
3922 else
3923 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday));
3924
3925 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3926 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3927 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3928 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3929 tm->tm_year -= 1900;
3930 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003931 return 1;
3932}
3933
3934/* From RFC7231
3935 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3936 *
3937 * HTTP-date = IMF-fixdate / obs-date
3938 * obs-date = rfc850-date / asctime-date
3939 *
3940 * parses an HTTP date in the RFC format and is accepted
3941 * alternatives. <date> is the strinf containing the date,
3942 * len is the len of the string. <tm> is filled with the
3943 * parsed time. We must considers this time as GMT.
3944 */
3945int parse_http_date(const char *date, int len, struct tm *tm)
3946{
3947 if (parse_imf_date(date, len, tm))
3948 return 1;
3949
3950 if (parse_rfc850_date(date, len, tm))
3951 return 1;
3952
3953 if (parse_asctime_date(date, len, tm))
3954 return 1;
3955
3956 return 0;
3957}
3958
Willy Tarreau4deeb102021-01-29 10:47:52 +01003959/* print the time <ns> in a short form (exactly 7 chars) at the end of buffer
3960 * <out>. "-" is printed if the value is zero, "inf" if larger than 1000 years.
3961 * It returns the new buffer length, or 0 if it doesn't fit. The value will be
3962 * surrounded by <pfx> and <sfx> respectively if not NULL.
3963 */
3964int print_time_short(struct buffer *out, const char *pfx, uint64_t ns, const char *sfx)
3965{
3966 double val = ns; // 52 bits of mantissa keep ns accuracy over 52 days
3967 const char *unit;
3968
3969 if (!pfx)
3970 pfx = "";
3971 if (!sfx)
3972 sfx = "";
3973
3974 do {
3975 unit = " - "; if (val <= 0.0) break;
3976 unit = "ns"; if (val < 1000.0) break;
3977 unit = "us"; val /= 1000.0; if (val < 1000.0) break;
3978 unit = "ms"; val /= 1000.0; if (val < 1000.0) break;
3979 unit = "s "; val /= 1000.0; if (val < 60.0) break;
3980 unit = "m "; val /= 60.0; if (val < 60.0) break;
3981 unit = "h "; val /= 60.0; if (val < 24.0) break;
3982 unit = "d "; val /= 24.0; if (val < 365.0) break;
3983 unit = "yr"; val /= 365.0; if (val < 1000.0) break;
3984 unit = " inf "; val = 0.0; break;
3985 } while (0);
3986
3987 if (val <= 0.0)
3988 return chunk_appendf(out, "%s%7s%s", pfx, unit, sfx);
3989 else if (val < 10.0)
3990 return chunk_appendf(out, "%s%1.3f%s%s", pfx, val, unit, sfx);
3991 else if (val < 100.0)
3992 return chunk_appendf(out, "%s%2.2f%s%s", pfx, val, unit, sfx);
3993 else
3994 return chunk_appendf(out, "%s%3.1f%s%s", pfx, val, unit, sfx);
3995}
3996
Willy Tarreau9a7bea52012-04-27 11:16:50 +02003997/* Dynamically allocates a string of the proper length to hold the formatted
3998 * output. NULL is returned on error. The caller is responsible for freeing the
3999 * memory area using free(). The resulting string is returned in <out> if the
4000 * pointer is not NULL. A previous version of <out> might be used to build the
4001 * new string, and it will be freed before returning if it is not NULL, which
4002 * makes it possible to build complex strings from iterative calls without
4003 * having to care about freeing intermediate values, as in the example below :
4004 *
4005 * memprintf(&err, "invalid argument: '%s'", arg);
4006 * ...
4007 * memprintf(&err, "parser said : <%s>\n", *err);
4008 * ...
4009 * free(*err);
4010 *
4011 * This means that <err> must be initialized to NULL before first invocation.
4012 * The return value also holds the allocated string, which eases error checking
4013 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02004014 * passed instead and it will be ignored. The returned message will then also
4015 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004016 *
4017 * It is also convenient to use it without any free except the last one :
4018 * err = NULL;
4019 * if (!fct1(err)) report(*err);
4020 * if (!fct2(err)) report(*err);
4021 * if (!fct3(err)) report(*err);
4022 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02004023 *
4024 * memprintf relies on memvprintf. This last version can be called from any
4025 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004026 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02004027char *memvprintf(char **out, const char *format, va_list orig_args)
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004028{
4029 va_list args;
4030 char *ret = NULL;
4031 int allocated = 0;
4032 int needed = 0;
4033
Willy Tarreaueb6cead2012-09-20 19:43:14 +02004034 if (!out)
4035 return NULL;
4036
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004037 do {
Willy Tarreaue0609f52019-03-29 19:13:23 +01004038 char buf1;
4039
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004040 /* vsnprintf() will return the required length even when the
4041 * target buffer is NULL. We do this in a loop just in case
4042 * intermediate evaluations get wrong.
4043 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02004044 va_copy(args, orig_args);
Willy Tarreaue0609f52019-03-29 19:13:23 +01004045 needed = vsnprintf(ret ? ret : &buf1, allocated, format, args);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004046 va_end(args);
Willy Tarreau1b2fed62013-04-01 22:48:54 +02004047 if (needed < allocated) {
4048 /* Note: on Solaris 8, the first iteration always
4049 * returns -1 if allocated is zero, so we force a
4050 * retry.
4051 */
4052 if (!allocated)
4053 needed = 0;
4054 else
4055 break;
4056 }
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004057
Willy Tarreau1b2fed62013-04-01 22:48:54 +02004058 allocated = needed + 1;
Hubert Verstraete831962e2016-06-28 22:44:26 +02004059 ret = my_realloc2(ret, allocated);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004060 } while (ret);
4061
4062 if (needed < 0) {
4063 /* an error was encountered */
Willy Tarreau61cfdf42021-02-20 10:46:51 +01004064 ha_free(&ret);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004065 }
4066
4067 if (out) {
4068 free(*out);
4069 *out = ret;
4070 }
4071
4072 return ret;
4073}
William Lallemand421f5b52012-02-06 18:15:57 +01004074
Christopher Faulet93a518f2017-10-24 11:25:33 +02004075char *memprintf(char **out, const char *format, ...)
4076{
4077 va_list args;
4078 char *ret = NULL;
4079
4080 va_start(args, format);
4081 ret = memvprintf(out, format, args);
4082 va_end(args);
4083
4084 return ret;
4085}
4086
Willy Tarreau21c705b2012-09-14 11:40:36 +02004087/* Used to add <level> spaces before each line of <out>, unless there is only one line.
4088 * The input argument is automatically freed and reassigned. The result will have to be
Willy Tarreau70eec382012-10-10 08:56:47 +02004089 * freed by the caller. It also supports being passed a NULL which results in the same
4090 * output.
Willy Tarreau21c705b2012-09-14 11:40:36 +02004091 * Example of use :
4092 * parse(cmd, &err); (callee: memprintf(&err, ...))
4093 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
4094 * free(err);
4095 */
4096char *indent_msg(char **out, int level)
4097{
4098 char *ret, *in, *p;
4099 int needed = 0;
4100 int lf = 0;
4101 int lastlf = 0;
4102 int len;
4103
Willy Tarreau70eec382012-10-10 08:56:47 +02004104 if (!out || !*out)
4105 return NULL;
4106
Willy Tarreau21c705b2012-09-14 11:40:36 +02004107 in = *out - 1;
4108 while ((in = strchr(in + 1, '\n')) != NULL) {
4109 lastlf = in - *out;
4110 lf++;
4111 }
4112
4113 if (!lf) /* single line, no LF, return it as-is */
4114 return *out;
4115
4116 len = strlen(*out);
4117
4118 if (lf == 1 && lastlf == len - 1) {
4119 /* single line, LF at end, strip it and return as-is */
4120 (*out)[lastlf] = 0;
4121 return *out;
4122 }
4123
4124 /* OK now we have at least one LF, we need to process the whole string
4125 * as a multi-line string. What we'll do :
4126 * - prefix with an LF if there is none
4127 * - add <level> spaces before each line
4128 * This means at most ( 1 + level + (len-lf) + lf*<1+level) ) =
4129 * 1 + level + len + lf * level = 1 + level * (lf + 1) + len.
4130 */
4131
4132 needed = 1 + level * (lf + 1) + len + 1;
4133 p = ret = malloc(needed);
4134 in = *out;
4135
4136 /* skip initial LFs */
4137 while (*in == '\n')
4138 in++;
4139
4140 /* copy each line, prefixed with LF and <level> spaces, and without the trailing LF */
4141 while (*in) {
4142 *p++ = '\n';
4143 memset(p, ' ', level);
4144 p += level;
4145 do {
4146 *p++ = *in++;
4147 } while (*in && *in != '\n');
4148 if (*in)
4149 in++;
4150 }
4151 *p = 0;
4152
4153 free(*out);
4154 *out = ret;
4155
4156 return ret;
4157}
4158
Willy Tarreaua2c99112019-08-21 13:17:37 +02004159/* makes a copy of message <in> into <out>, with each line prefixed with <pfx>
4160 * and end of lines replaced with <eol> if not 0. The first line to indent has
4161 * to be indicated in <first> (starts at zero), so that it is possible to skip
4162 * indenting the first line if it has to be appended after an existing message.
4163 * Empty strings are never indented, and NULL strings are considered empty both
4164 * for <in> and <pfx>. It returns non-zero if an EOL was appended as the last
4165 * character, non-zero otherwise.
4166 */
4167int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first)
4168{
4169 int bol, lf;
4170 int pfxlen = pfx ? strlen(pfx) : 0;
4171
4172 if (!in)
4173 return 0;
4174
4175 bol = 1;
4176 lf = 0;
4177 while (*in) {
4178 if (bol && pfxlen) {
4179 if (first > 0)
4180 first--;
4181 else
4182 b_putblk(out, pfx, pfxlen);
4183 bol = 0;
4184 }
4185
4186 lf = (*in == '\n');
4187 bol |= lf;
4188 b_putchr(out, (lf && eol) ? eol : *in);
4189 in++;
4190 }
4191 return lf;
4192}
4193
Willy Tarreau9d22e562019-03-29 18:49:09 +01004194/* removes environment variable <name> from the environment as found in
4195 * environ. This is only provided as an alternative for systems without
4196 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05004197 * The principle is to scan environ for each occurrence of variable name
Willy Tarreau9d22e562019-03-29 18:49:09 +01004198 * <name> and to replace the matching pointers with the last pointer of
4199 * the array (since variables are not ordered).
4200 * It always returns 0 (success).
4201 */
4202int my_unsetenv(const char *name)
4203{
4204 extern char **environ;
4205 char **p = environ;
4206 int vars;
4207 int next;
4208 int len;
4209
4210 len = strlen(name);
4211 for (vars = 0; p[vars]; vars++)
4212 ;
4213 next = 0;
4214 while (next < vars) {
4215 if (strncmp(p[next], name, len) != 0 || p[next][len] != '=') {
4216 next++;
4217 continue;
4218 }
4219 if (next < vars - 1)
4220 p[next] = p[vars - 1];
4221 p[--vars] = NULL;
4222 }
4223 return 0;
4224}
4225
Willy Tarreaudad36a32013-03-11 01:20:04 +01004226/* Convert occurrences of environment variables in the input string to their
4227 * corresponding value. A variable is identified as a series of alphanumeric
4228 * characters or underscores following a '$' sign. The <in> string must be
4229 * free()able. NULL returns NULL. The resulting string might be reallocated if
4230 * some expansion is made. Variable names may also be enclosed into braces if
4231 * needed (eg: to concatenate alphanum characters).
4232 */
4233char *env_expand(char *in)
4234{
4235 char *txt_beg;
4236 char *out;
4237 char *txt_end;
4238 char *var_beg;
4239 char *var_end;
4240 char *value;
4241 char *next;
4242 int out_len;
4243 int val_len;
4244
4245 if (!in)
4246 return in;
4247
4248 value = out = NULL;
4249 out_len = 0;
4250
4251 txt_beg = in;
4252 do {
4253 /* look for next '$' sign in <in> */
4254 for (txt_end = txt_beg; *txt_end && *txt_end != '$'; txt_end++);
4255
4256 if (!*txt_end && !out) /* end and no expansion performed */
4257 return in;
4258
4259 val_len = 0;
4260 next = txt_end;
4261 if (*txt_end == '$') {
4262 char save;
4263
4264 var_beg = txt_end + 1;
4265 if (*var_beg == '{')
4266 var_beg++;
4267
4268 var_end = var_beg;
Willy Tarreau90807112020-02-25 08:16:33 +01004269 while (isalnum((unsigned char)*var_end) || *var_end == '_') {
Willy Tarreaudad36a32013-03-11 01:20:04 +01004270 var_end++;
4271 }
4272
4273 next = var_end;
4274 if (*var_end == '}' && (var_beg > txt_end + 1))
4275 next++;
4276
4277 /* get value of the variable name at this location */
4278 save = *var_end;
4279 *var_end = '\0';
4280 value = getenv(var_beg);
4281 *var_end = save;
4282 val_len = value ? strlen(value) : 0;
4283 }
4284
Hubert Verstraete831962e2016-06-28 22:44:26 +02004285 out = my_realloc2(out, out_len + (txt_end - txt_beg) + val_len + 1);
Willy Tarreaudad36a32013-03-11 01:20:04 +01004286 if (txt_end > txt_beg) {
4287 memcpy(out + out_len, txt_beg, txt_end - txt_beg);
4288 out_len += txt_end - txt_beg;
4289 }
4290 if (val_len) {
4291 memcpy(out + out_len, value, val_len);
4292 out_len += val_len;
4293 }
4294 out[out_len] = 0;
4295 txt_beg = next;
4296 } while (*txt_beg);
4297
4298 /* here we know that <out> was allocated and that we don't need <in> anymore */
4299 free(in);
4300 return out;
4301}
4302
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004303
4304/* same as strstr() but case-insensitive and with limit length */
4305const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2)
4306{
4307 char *pptr, *sptr, *start;
Willy Tarreauc8746532014-05-28 23:05:07 +02004308 unsigned int slen, plen;
4309 unsigned int tmp1, tmp2;
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004310
4311 if (str1 == NULL || len_str1 == 0) // search pattern into an empty string => search is not found
4312 return NULL;
4313
4314 if (str2 == NULL || len_str2 == 0) // pattern is empty => every str1 match
4315 return str1;
4316
4317 if (len_str1 < len_str2) // pattern is longer than string => search is not found
4318 return NULL;
4319
4320 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 +02004321 while (toupper((unsigned char)*start) != toupper((unsigned char)*str2)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004322 start++;
4323 slen--;
4324 tmp1++;
4325
4326 if (tmp1 >= len_str1)
4327 return NULL;
4328
4329 /* if pattern longer than string */
4330 if (slen < plen)
4331 return NULL;
4332 }
4333
4334 sptr = start;
4335 pptr = (char *)str2;
4336
4337 tmp2 = 0;
Willy Tarreauf278eec2020-07-05 21:46:32 +02004338 while (toupper((unsigned char)*sptr) == toupper((unsigned char)*pptr)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004339 sptr++;
4340 pptr++;
4341 tmp2++;
4342
4343 if (*pptr == '\0' || tmp2 == len_str2) /* end of pattern found */
4344 return start;
4345 if (*sptr == '\0' || tmp2 == len_str1) /* end of string found and the pattern is not fully found */
4346 return NULL;
4347 }
4348 }
4349 return NULL;
4350}
4351
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004352/* This function read the next valid utf8 char.
4353 * <s> is the byte srray to be decode, <len> is its length.
4354 * The function returns decoded char encoded like this:
4355 * The 4 msb are the return code (UTF8_CODE_*), the 4 lsb
4356 * are the length read. The decoded character is stored in <c>.
4357 */
4358unsigned char utf8_next(const char *s, int len, unsigned int *c)
4359{
4360 const unsigned char *p = (unsigned char *)s;
4361 int dec;
4362 unsigned char code = UTF8_CODE_OK;
4363
4364 if (len < 1)
4365 return UTF8_CODE_OK;
4366
4367 /* Check the type of UTF8 sequence
4368 *
4369 * 0... .... 0x00 <= x <= 0x7f : 1 byte: ascii char
4370 * 10.. .... 0x80 <= x <= 0xbf : invalid sequence
4371 * 110. .... 0xc0 <= x <= 0xdf : 2 bytes
4372 * 1110 .... 0xe0 <= x <= 0xef : 3 bytes
4373 * 1111 0... 0xf0 <= x <= 0xf7 : 4 bytes
4374 * 1111 10.. 0xf8 <= x <= 0xfb : 5 bytes
4375 * 1111 110. 0xfc <= x <= 0xfd : 6 bytes
4376 * 1111 111. 0xfe <= x <= 0xff : invalid sequence
4377 */
4378 switch (*p) {
4379 case 0x00 ... 0x7f:
4380 *c = *p;
4381 return UTF8_CODE_OK | 1;
4382
4383 case 0x80 ... 0xbf:
4384 *c = *p;
4385 return UTF8_CODE_BADSEQ | 1;
4386
4387 case 0xc0 ... 0xdf:
4388 if (len < 2) {
4389 *c = *p;
4390 return UTF8_CODE_BADSEQ | 1;
4391 }
4392 *c = *p & 0x1f;
4393 dec = 1;
4394 break;
4395
4396 case 0xe0 ... 0xef:
4397 if (len < 3) {
4398 *c = *p;
4399 return UTF8_CODE_BADSEQ | 1;
4400 }
4401 *c = *p & 0x0f;
4402 dec = 2;
4403 break;
4404
4405 case 0xf0 ... 0xf7:
4406 if (len < 4) {
4407 *c = *p;
4408 return UTF8_CODE_BADSEQ | 1;
4409 }
4410 *c = *p & 0x07;
4411 dec = 3;
4412 break;
4413
4414 case 0xf8 ... 0xfb:
4415 if (len < 5) {
4416 *c = *p;
4417 return UTF8_CODE_BADSEQ | 1;
4418 }
4419 *c = *p & 0x03;
4420 dec = 4;
4421 break;
4422
4423 case 0xfc ... 0xfd:
4424 if (len < 6) {
4425 *c = *p;
4426 return UTF8_CODE_BADSEQ | 1;
4427 }
4428 *c = *p & 0x01;
4429 dec = 5;
4430 break;
4431
4432 case 0xfe ... 0xff:
4433 default:
4434 *c = *p;
4435 return UTF8_CODE_BADSEQ | 1;
4436 }
4437
4438 p++;
4439
4440 while (dec > 0) {
4441
4442 /* need 0x10 for the 2 first bits */
4443 if ( ( *p & 0xc0 ) != 0x80 )
4444 return UTF8_CODE_BADSEQ | ((p-(unsigned char *)s)&0xffff);
4445
4446 /* add data at char */
4447 *c = ( *c << 6 ) | ( *p & 0x3f );
4448
4449 dec--;
4450 p++;
4451 }
4452
4453 /* Check ovelong encoding.
4454 * 1 byte : 5 + 6 : 11 : 0x80 ... 0x7ff
4455 * 2 bytes : 4 + 6 + 6 : 16 : 0x800 ... 0xffff
4456 * 3 bytes : 3 + 6 + 6 + 6 : 21 : 0x10000 ... 0x1fffff
4457 */
Thierry FOURNIER9e7ec082015-03-12 19:32:38 +01004458 if (( *c <= 0x7f && (p-(unsigned char *)s) > 1) ||
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004459 (*c >= 0x80 && *c <= 0x7ff && (p-(unsigned char *)s) > 2) ||
4460 (*c >= 0x800 && *c <= 0xffff && (p-(unsigned char *)s) > 3) ||
4461 (*c >= 0x10000 && *c <= 0x1fffff && (p-(unsigned char *)s) > 4))
4462 code |= UTF8_CODE_OVERLONG;
4463
4464 /* Check invalid UTF8 range. */
4465 if ((*c >= 0xd800 && *c <= 0xdfff) ||
4466 (*c >= 0xfffe && *c <= 0xffff))
4467 code |= UTF8_CODE_INVRANGE;
4468
4469 return code | ((p-(unsigned char *)s)&0x0f);
4470}
4471
Maxime de Roucydc887852016-05-13 23:52:54 +02004472/* append a copy of string <str> (in a wordlist) at the end of the list <li>
4473 * On failure : return 0 and <err> filled with an error message.
4474 * The caller is responsible for freeing the <err> and <str> copy
4475 * memory area using free()
4476 */
4477int list_append_word(struct list *li, const char *str, char **err)
4478{
4479 struct wordlist *wl;
4480
4481 wl = calloc(1, sizeof(*wl));
4482 if (!wl) {
4483 memprintf(err, "out of memory");
4484 goto fail_wl;
4485 }
4486
4487 wl->s = strdup(str);
4488 if (!wl->s) {
4489 memprintf(err, "out of memory");
4490 goto fail_wl_s;
4491 }
4492
Willy Tarreau2b718102021-04-21 07:32:39 +02004493 LIST_APPEND(li, &wl->list);
Maxime de Roucydc887852016-05-13 23:52:54 +02004494
4495 return 1;
4496
4497fail_wl_s:
4498 free(wl->s);
4499fail_wl:
4500 free(wl);
4501 return 0;
4502}
4503
Willy Tarreau37101052019-05-20 16:48:20 +02004504/* indicates if a memory location may safely be read or not. The trick consists
4505 * in performing a harmless syscall using this location as an input and letting
4506 * the operating system report whether it's OK or not. For this we have the
4507 * stat() syscall, which will return EFAULT when the memory location supposed
4508 * to contain the file name is not readable. If it is readable it will then
4509 * either return 0 if the area contains an existing file name, or -1 with
4510 * another code. This must not be abused, and some audit systems might detect
4511 * this as abnormal activity. It's used only for unsafe dumps.
4512 */
4513int may_access(const void *ptr)
4514{
4515 struct stat buf;
4516
4517 if (stat(ptr, &buf) == 0)
4518 return 1;
4519 if (errno == EFAULT)
4520 return 0;
4521 return 1;
4522}
4523
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004524/* print a string of text buffer to <out>. The format is :
4525 * Non-printable chars \t, \n, \r and \e are * encoded in C format.
4526 * Other non-printable chars are encoded "\xHH". Space, '\', and '=' are also escaped.
4527 * Print stopped if null char or <bsize> is reached, or if no more place in the chunk.
4528 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004529int dump_text(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004530{
4531 unsigned char c;
Tim Duesterhuscd5521e2021-08-29 00:58:22 +02004532 size_t ptr = 0;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004533
Tim Duesterhuscd5521e2021-08-29 00:58:22 +02004534 while (ptr < bsize && buf[ptr]) {
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004535 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004536 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\' && c != ' ' && c != '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004537 if (out->data > out->size - 1)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004538 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004539 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004540 }
4541 else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\' || c == ' ' || c == '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004542 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004543 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004544 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004545 switch (c) {
4546 case ' ': c = ' '; break;
4547 case '\t': c = 't'; break;
4548 case '\n': c = 'n'; break;
4549 case '\r': c = 'r'; break;
4550 case '\e': c = 'e'; break;
4551 case '\\': c = '\\'; break;
4552 case '=': c = '='; break;
4553 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004554 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004555 }
4556 else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004557 if (out->data > out->size - 4)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004558 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004559 out->area[out->data++] = '\\';
4560 out->area[out->data++] = 'x';
4561 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4562 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004563 }
4564 ptr++;
4565 }
4566
4567 return ptr;
4568}
4569
4570/* print a buffer in hexa.
4571 * Print stopped if <bsize> is reached, or if no more place in the chunk.
4572 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004573int dump_binary(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004574{
4575 unsigned char c;
4576 int ptr = 0;
4577
4578 while (ptr < bsize) {
4579 c = buf[ptr];
4580
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004581 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004582 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004583 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4584 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004585
4586 ptr++;
4587 }
4588 return ptr;
4589}
4590
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004591/* Appends into buffer <out> a hex dump of memory area <buf> for <len> bytes,
4592 * prepending each line with prefix <pfx>. The output is *not* initialized.
4593 * The output will not wrap pas the buffer's end so it is more optimal if the
4594 * caller makes sure the buffer is aligned first. A trailing zero will always
4595 * be appended (and not counted) if there is room for it. The caller must make
Willy Tarreau37101052019-05-20 16:48:20 +02004596 * sure that the area is dumpable first. If <unsafe> is non-null, the memory
4597 * locations are checked first for being readable.
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004598 */
Willy Tarreau37101052019-05-20 16:48:20 +02004599void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe)
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004600{
4601 const unsigned char *d = buf;
4602 int i, j, start;
4603
4604 d = (const unsigned char *)(((unsigned long)buf) & -16);
4605 start = ((unsigned long)buf) & 15;
4606
4607 for (i = 0; i < start + len; i += 16) {
4608 chunk_appendf(out, (sizeof(void *) == 4) ? "%s%8p: " : "%s%16p: ", pfx, d + i);
4609
Willy Tarreau37101052019-05-20 16:48:20 +02004610 // 0: unchecked, 1: checked safe, 2: danger
4611 unsafe = !!unsafe;
4612 if (unsafe && !may_access(d + i))
4613 unsafe = 2;
4614
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004615 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004616 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004617 chunk_strcat(out, "'' ");
Willy Tarreau37101052019-05-20 16:48:20 +02004618 else if (unsafe > 1)
4619 chunk_strcat(out, "** ");
4620 else
4621 chunk_appendf(out, "%02x ", d[i + j]);
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004622
4623 if (j == 7)
4624 chunk_strcat(out, "- ");
4625 }
4626 chunk_strcat(out, " ");
4627 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004628 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004629 chunk_strcat(out, "'");
Willy Tarreau37101052019-05-20 16:48:20 +02004630 else if (unsafe > 1)
4631 chunk_strcat(out, "*");
Willy Tarreau90807112020-02-25 08:16:33 +01004632 else if (isprint((unsigned char)d[i + j]))
Willy Tarreau37101052019-05-20 16:48:20 +02004633 chunk_appendf(out, "%c", d[i + j]);
4634 else
4635 chunk_strcat(out, ".");
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004636 }
4637 chunk_strcat(out, "\n");
4638 }
4639}
4640
Willy Tarreau762fb3e2020-03-03 15:57:10 +01004641/* dumps <pfx> followed by <n> bytes from <addr> in hex form into buffer <buf>
4642 * enclosed in brackets after the address itself, formatted on 14 chars
4643 * including the "0x" prefix. This is meant to be used as a prefix for code
4644 * areas. For example:
4645 * "0x7f10b6557690 [48 c7 c0 0f 00 00 00 0f]"
4646 * It relies on may_access() to know if the bytes are dumpable, otherwise "--"
4647 * is emitted. A NULL <pfx> will be considered empty.
4648 */
4649void dump_addr_and_bytes(struct buffer *buf, const char *pfx, const void *addr, int n)
4650{
4651 int ok = 0;
4652 int i;
4653
4654 chunk_appendf(buf, "%s%#14lx [", pfx ? pfx : "", (long)addr);
4655
4656 for (i = 0; i < n; i++) {
4657 if (i == 0 || (((long)(addr + i) ^ (long)(addr)) & 4096))
4658 ok = may_access(addr + i);
4659 if (ok)
4660 chunk_appendf(buf, "%02x%s", ((uint8_t*)addr)[i], (i<n-1) ? " " : "]");
4661 else
4662 chunk_appendf(buf, "--%s", (i<n-1) ? " " : "]");
4663 }
4664}
4665
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004666/* print a line of text buffer (limited to 70 bytes) to <out>. The format is :
4667 * <2 spaces> <offset=5 digits> <space or plus> <space> <70 chars max> <\n>
4668 * which is 60 chars per line. Non-printable chars \t, \n, \r and \e are
4669 * encoded in C format. Other non-printable chars are encoded "\xHH". Original
4670 * lines are respected within the limit of 70 output chars. Lines that are
4671 * continuation of a previous truncated line begin with "+" instead of " "
4672 * after the offset. The new pointer is returned.
4673 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004674int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004675 int *line, int ptr)
4676{
4677 int end;
4678 unsigned char c;
4679
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004680 end = out->data + 80;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004681 if (end > out->size)
4682 return ptr;
4683
4684 chunk_appendf(out, " %05d%c ", ptr, (ptr == *line) ? ' ' : '+');
4685
4686 while (ptr < len && ptr < bsize) {
4687 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004688 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004689 if (out->data > end - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004690 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004691 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004692 } else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004693 if (out->data > end - 3)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004694 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004695 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004696 switch (c) {
4697 case '\t': c = 't'; break;
4698 case '\n': c = 'n'; break;
4699 case '\r': c = 'r'; break;
4700 case '\e': c = 'e'; break;
4701 case '\\': c = '\\'; break;
4702 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004703 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004704 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004705 if (out->data > end - 5)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004706 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004707 out->area[out->data++] = '\\';
4708 out->area[out->data++] = 'x';
4709 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4710 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004711 }
4712 if (buf[ptr++] == '\n') {
4713 /* we had a line break, let's return now */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004714 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004715 *line = ptr;
4716 return ptr;
4717 }
4718 }
4719 /* we have an incomplete line, we return it as-is */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004720 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004721 return ptr;
4722}
4723
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004724/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02004725 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
4726 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004727 */
Willy Tarreaued936c52017-04-27 18:03:20 +02004728void debug_hexdump(FILE *out, const char *pfx, const char *buf,
4729 unsigned int baseaddr, int len)
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004730{
Willy Tarreau73459792017-04-11 07:58:08 +02004731 unsigned int i;
4732 int b, j;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004733
4734 for (i = 0; i < (len + (baseaddr & 15)); i += 16) {
4735 b = i - (baseaddr & 15);
Willy Tarreaued936c52017-04-27 18:03:20 +02004736 fprintf(out, "%s%08x: ", pfx ? pfx : "", i + (baseaddr & ~15));
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004737 for (j = 0; j < 8; j++) {
4738 if (b + j >= 0 && b + j < len)
4739 fprintf(out, "%02x ", (unsigned char)buf[b + j]);
4740 else
4741 fprintf(out, " ");
4742 }
4743
4744 if (b + j >= 0 && b + j < len)
4745 fputc('-', out);
4746 else
4747 fputc(' ', out);
4748
4749 for (j = 8; j < 16; j++) {
4750 if (b + j >= 0 && b + j < len)
4751 fprintf(out, " %02x", (unsigned char)buf[b + j]);
4752 else
4753 fprintf(out, " ");
4754 }
4755
4756 fprintf(out, " ");
4757 for (j = 0; j < 16; j++) {
4758 if (b + j >= 0 && b + j < len) {
4759 if (isprint((unsigned char)buf[b + j]))
4760 fputc((unsigned char)buf[b + j], out);
4761 else
4762 fputc('.', out);
4763 }
4764 else
4765 fputc(' ', out);
4766 }
4767 fputc('\n', out);
4768 }
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004769}
4770
Willy Tarreaubb869862020-04-16 10:52:41 +02004771/* Tries to report the executable path name on platforms supporting this. If
4772 * not found or not possible, returns NULL.
4773 */
4774const char *get_exec_path()
4775{
4776 const char *ret = NULL;
4777
Willy Tarreau1ee71dd2021-08-30 10:15:35 +02004778#if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
Willy Tarreaubb869862020-04-16 10:52:41 +02004779 long execfn = getauxval(AT_EXECFN);
4780
4781 if (execfn && execfn != ENOENT)
4782 ret = (const char *)execfn;
devnexen@gmail.com49a32282021-08-17 12:55:49 +01004783#elif defined(__FreeBSD__)
4784 Elf_Auxinfo *auxv;
4785 for (auxv = __elf_aux_vector; auxv->a_type != AT_NULL; ++auxv) {
4786 if (auxv->a_type == AT_EXECPATH) {
4787 ret = (const char *)auxv->a_un.a_ptr;
4788 break;
4789 }
4790 }
David Carlier1b9d57d2021-08-17 08:44:25 +01004791#elif defined(__NetBSD__)
4792 AuxInfo *auxv;
4793 for (auxv = _dlauxinfo(); auxv->a_type != AT_NULL; ++auxv) {
4794 if (auxv->a_type == AT_SUN_EXECNAME) {
4795 ret = (const char *)auxv->a_v;
4796 break;
4797 }
4798 }
Willy Tarreaubb869862020-04-16 10:52:41 +02004799#endif
4800 return ret;
4801}
4802
Baruch Siache1651b22020-07-24 07:52:20 +03004803#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreau9133e482020-03-04 10:19:36 +01004804/* calls dladdr() or dladdr1() on <addr> and <dli>. If dladdr1 is available,
4805 * also returns the symbol size in <size>, otherwise returns 0 there.
4806 */
4807static int dladdr_and_size(const void *addr, Dl_info *dli, size_t *size)
4808{
4809 int ret;
Willy Tarreau1ee71dd2021-08-30 10:15:35 +02004810#if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 3)) // most detailed one
Willy Tarreau9133e482020-03-04 10:19:36 +01004811 const ElfW(Sym) *sym;
4812
4813 ret = dladdr1(addr, dli, (void **)&sym, RTLD_DL_SYMENT);
4814 if (ret)
4815 *size = sym ? sym->st_size : 0;
4816#else
David Carlier7b6de262021-12-31 08:15:29 +00004817#if defined(__sun)
4818 ret = dladdr((void *)addr, dli);
4819#else
Willy Tarreau9133e482020-03-04 10:19:36 +01004820 ret = dladdr(addr, dli);
David Carlier7b6de262021-12-31 08:15:29 +00004821#endif
Willy Tarreau9133e482020-03-04 10:19:36 +01004822 *size = 0;
4823#endif
4824 return ret;
4825}
Willy Tarreau64192392021-05-05 09:06:21 +02004826
4827/* Tries to retrieve the address of the first occurrence symbol <name>.
4828 * Note that NULL in return is not always an error as a symbol may have that
4829 * address in special situations.
4830 */
4831void *get_sym_curr_addr(const char *name)
4832{
4833 void *ptr = NULL;
4834
4835#ifdef RTLD_DEFAULT
4836 ptr = dlsym(RTLD_DEFAULT, name);
4837#endif
4838 return ptr;
4839}
4840
4841
4842/* Tries to retrieve the address of the next occurrence of symbol <name>
4843 * Note that NULL in return is not always an error as a symbol may have that
4844 * address in special situations.
4845 */
4846void *get_sym_next_addr(const char *name)
4847{
4848 void *ptr = NULL;
4849
4850#ifdef RTLD_NEXT
4851 ptr = dlsym(RTLD_NEXT, name);
Willy Tarreau9133e482020-03-04 10:19:36 +01004852#endif
Willy Tarreau64192392021-05-05 09:06:21 +02004853 return ptr;
4854}
4855
4856#else /* elf & linux & dl */
4857
4858/* no possible resolving on other platforms at the moment */
4859void *get_sym_curr_addr(const char *name)
4860{
4861 return NULL;
4862}
4863
4864void *get_sym_next_addr(const char *name)
4865{
4866 return NULL;
4867}
4868
4869#endif /* elf & linux & dl */
Willy Tarreau9133e482020-03-04 10:19:36 +01004870
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004871/* Tries to append to buffer <buf> some indications about the symbol at address
4872 * <addr> using the following form:
4873 * lib:+0xoffset (unresolvable address from lib's base)
4874 * main+0xoffset (unresolvable address from main (+/-))
4875 * lib:main+0xoffset (unresolvable lib address from main (+/-))
4876 * name (resolved exact exec address)
4877 * lib:name (resolved exact lib address)
4878 * name+0xoffset/0xsize (resolved address within exec symbol)
4879 * lib:name+0xoffset/0xsize (resolved address within lib symbol)
4880 *
4881 * The file name (lib or executable) is limited to what lies between the last
4882 * '/' and the first following '.'. An optional prefix <pfx> is prepended before
4883 * 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 +03004884 * that contains the "main" symbol, or when __ELF__ && USE_DL are not set.
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004885 *
4886 * The symbol's base address is returned, or NULL when unresolved, in order to
4887 * allow the caller to match it against known ones.
4888 */
Willy Tarreau45fd1032021-01-20 14:37:59 +01004889const void *resolve_sym_name(struct buffer *buf, const char *pfx, const void *addr)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004890{
4891 const struct {
4892 const void *func;
4893 const char *name;
4894 } fcts[] = {
4895 { .func = process_stream, .name = "process_stream" },
4896 { .func = task_run_applet, .name = "task_run_applet" },
4897 { .func = si_cs_io_cb, .name = "si_cs_io_cb" },
Willy Tarreau586f71b2020-12-11 15:54:36 +01004898 { .func = sock_conn_iocb, .name = "sock_conn_iocb" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004899 { .func = dgram_fd_handler, .name = "dgram_fd_handler" },
4900 { .func = listener_accept, .name = "listener_accept" },
Willy Tarreaud597ec22021-01-29 14:29:06 +01004901 { .func = manage_global_listener_queue, .name = "manage_global_listener_queue" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004902 { .func = poller_pipe_io_handler, .name = "poller_pipe_io_handler" },
4903 { .func = mworker_accept_wrapper, .name = "mworker_accept_wrapper" },
Willy Tarreau02922e12021-01-29 12:27:57 +01004904 { .func = session_expire_embryonic, .name = "session_expire_embryonic" },
Willy Tarreaufb5401f2021-01-29 12:25:23 +01004905#ifdef USE_THREAD
4906 { .func = accept_queue_process, .name = "accept_queue_process" },
4907#endif
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004908#ifdef USE_LUA
4909 { .func = hlua_process_task, .name = "hlua_process_task" },
4910#endif
Ilya Shipitsinbdec3ba2020-11-14 01:56:34 +05004911#ifdef SSL_MODE_ASYNC
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004912 { .func = ssl_async_fd_free, .name = "ssl_async_fd_free" },
4913 { .func = ssl_async_fd_handler, .name = "ssl_async_fd_handler" },
4914#endif
4915 };
4916
Baruch Siache1651b22020-07-24 07:52:20 +03004917#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004918 Dl_info dli, dli_main;
Willy Tarreau9133e482020-03-04 10:19:36 +01004919 size_t size;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004920 const char *fname, *p;
4921#endif
4922 int i;
4923
4924 if (pfx)
4925 chunk_appendf(buf, "%s", pfx);
4926
4927 for (i = 0; i < sizeof(fcts) / sizeof(fcts[0]); i++) {
4928 if (addr == fcts[i].func) {
4929 chunk_appendf(buf, "%s", fcts[i].name);
4930 return addr;
4931 }
4932 }
4933
Baruch Siache1651b22020-07-24 07:52:20 +03004934#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004935 /* Now let's try to be smarter */
Willy Tarreau9133e482020-03-04 10:19:36 +01004936 if (!dladdr_and_size(addr, &dli, &size))
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004937 goto unknown;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004938
4939 /* 1. prefix the library name if it's not the same object as the one
4940 * that contains the main function. The name is picked between last '/'
4941 * and first following '.'.
4942 */
4943 if (!dladdr(main, &dli_main))
4944 dli_main.dli_fbase = NULL;
4945
4946 if (dli_main.dli_fbase != dli.dli_fbase) {
4947 fname = dli.dli_fname;
4948 p = strrchr(fname, '/');
4949 if (p++)
4950 fname = p;
4951 p = strchr(fname, '.');
4952 if (!p)
4953 p = fname + strlen(fname);
4954
4955 chunk_appendf(buf, "%.*s:", (int)(long)(p - fname), fname);
4956 }
4957
4958 /* 2. symbol name */
4959 if (dli.dli_sname) {
4960 /* known, dump it and return symbol's address (exact or relative) */
4961 chunk_appendf(buf, "%s", dli.dli_sname);
4962 if (addr != dli.dli_saddr) {
4963 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_saddr));
Willy Tarreau9133e482020-03-04 10:19:36 +01004964 if (size)
4965 chunk_appendf(buf, "/%#lx", (long)size);
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004966 }
4967 return dli.dli_saddr;
4968 }
4969 else if (dli_main.dli_fbase != dli.dli_fbase) {
4970 /* unresolved symbol from a known library, report relative offset */
4971 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_fbase));
4972 return NULL;
4973 }
Baruch Siache1651b22020-07-24 07:52:20 +03004974#endif /* __ELF__ && !__linux__ || USE_DL */
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004975 unknown:
4976 /* unresolved symbol from the main file, report relative offset to main */
4977 if ((void*)addr < (void*)main)
4978 chunk_appendf(buf, "main-%#lx", (long)((void*)main - addr));
4979 else
4980 chunk_appendf(buf, "main+%#lx", (long)(addr - (void*)main));
4981 return NULL;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004982}
4983
Willy Tarreau37857332021-12-28 09:57:10 +01004984/* On systems where this is supported, let's provide a possibility to enumerate
4985 * the list of object files. The output is appended to a buffer initialized by
4986 * the caller, with one name per line. A trailing zero is always emitted if data
4987 * are written. Only real objects are dumped (executable and .so libs). The
4988 * function returns non-zero if it dumps anything. These functions do not make
4989 * use of the trash so that it is possible for the caller to call them with the
4990 * trash on input. The output format may be platform-specific but at least one
4991 * version must emit raw object file names when argument is zero.
4992 */
4993#if defined(HA_HAVE_DUMP_LIBS)
4994# if defined(HA_HAVE_DL_ITERATE_PHDR)
4995/* the private <data> we pass below is a dump context initialized like this */
4996struct dl_dump_ctx {
4997 struct buffer *buf;
4998 int with_addr;
4999};
5000
5001static int dl_dump_libs_cb(struct dl_phdr_info *info, size_t size, void *data)
5002{
5003 struct dl_dump_ctx *ctx = data;
5004 const char *fname;
5005 size_t p1, p2, beg, end;
5006 int idx;
5007
5008 if (!info || !info->dlpi_name)
5009 goto leave;
5010
5011 if (!*info->dlpi_name)
5012 fname = get_exec_path();
5013 else if (strchr(info->dlpi_name, '/'))
5014 fname = info->dlpi_name;
5015 else
5016 /* else it's a VDSO or similar and we're not interested */
5017 goto leave;
5018
5019 if (!ctx->with_addr)
5020 goto dump_name;
5021
5022 /* virtual addresses are relative to the load address and are per
5023 * pseudo-header, so we have to scan them all to find the furthest
5024 * one from the beginning. In this case we only dump entries if
5025 * they have at least one section.
5026 */
5027 beg = ~0; end = 0;
5028 for (idx = 0; idx < info->dlpi_phnum; idx++) {
5029 if (!info->dlpi_phdr[idx].p_memsz)
5030 continue;
5031 p1 = info->dlpi_phdr[idx].p_vaddr;
5032 if (p1 < beg)
5033 beg = p1;
5034 p2 = p1 + info->dlpi_phdr[idx].p_memsz - 1;
5035 if (p2 > end)
5036 end = p2;
5037 }
5038
5039 if (!idx)
5040 goto leave;
5041
5042 chunk_appendf(ctx->buf, "0x%012llx-0x%012llx (0x%07llx) ",
5043 (ullong)info->dlpi_addr + beg,
5044 (ullong)info->dlpi_addr + end,
5045 (ullong)(end - beg + 1));
5046 dump_name:
5047 chunk_appendf(ctx->buf, "%s\n", fname);
5048 leave:
5049 return 0;
5050}
5051
5052/* dumps lib names and optionally address ranges */
5053int dump_libs(struct buffer *output, int with_addr)
5054{
5055 struct dl_dump_ctx ctx = { .buf = output, .with_addr = with_addr };
5056 size_t old_data = output->data;
5057
5058 dl_iterate_phdr(dl_dump_libs_cb, &ctx);
5059 return output->data != old_data;
5060}
5061# else // no DL_ITERATE_PHDR
5062# error "No dump_libs() function for this platform"
5063# endif
5064#else // no HA_HAVE_DUMP_LIBS
5065
5066/* unsupported platform: do not dump anything */
5067int dump_libs(struct buffer *output, int with_addr)
5068{
5069 return 0;
5070}
5071
5072#endif // HA_HAVE_DUMP_LIBS
5073
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005074/*
5075 * Allocate an array of unsigned int with <nums> as address from <str> string
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05005076 * made of integer separated by dot characters.
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005077 *
5078 * First, initializes the value with <sz> as address to 0 and initializes the
5079 * array with <nums> as address to NULL. Then allocates the array with <nums> as
5080 * address updating <sz> pointed value to the size of this array.
5081 *
5082 * Returns 1 if succeeded, 0 if not.
5083 */
5084int parse_dotted_uints(const char *str, unsigned int **nums, size_t *sz)
5085{
5086 unsigned int *n;
5087 const char *s, *end;
5088
5089 s = str;
5090 *sz = 0;
5091 end = str + strlen(str);
5092 *nums = n = NULL;
5093
5094 while (1) {
5095 unsigned int r;
5096
5097 if (s >= end)
5098 break;
5099
5100 r = read_uint(&s, end);
5101 /* Expected characters after having read an uint: '\0' or '.',
5102 * if '.', must not be terminal.
5103 */
Christopher Faulet4b524122021-02-11 10:42:41 +01005104 if (*s != '\0'&& (*s++ != '.' || s == end)) {
5105 free(n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005106 return 0;
Christopher Faulet4b524122021-02-11 10:42:41 +01005107 }
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005108
Frédéric Lécaille12a71842019-02-26 18:19:48 +01005109 n = my_realloc2(n, (*sz + 1) * sizeof *n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005110 if (!n)
5111 return 0;
5112
5113 n[(*sz)++] = r;
5114 }
5115 *nums = n;
5116
5117 return 1;
5118}
5119
Willy Tarreau4d589e72019-08-23 19:02:26 +02005120
5121/* returns the number of bytes needed to encode <v> as a varint. An inline
5122 * version exists for use with constants (__varint_bytes()).
5123 */
5124int varint_bytes(uint64_t v)
5125{
5126 int len = 1;
5127
5128 if (v >= 240) {
5129 v = (v - 240) >> 4;
5130 while (1) {
5131 len++;
5132 if (v < 128)
5133 break;
5134 v = (v - 128) >> 7;
5135 }
5136 }
5137 return len;
5138}
5139
Willy Tarreau52bf8392020-03-08 00:42:37 +01005140
5141/* Random number generator state, see below */
Willy Tarreau1544c142020-03-12 00:31:18 +01005142static uint64_t ha_random_state[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01005143
5144/* This is a thread-safe implementation of xoroshiro128** described below:
5145 * http://prng.di.unimi.it/
5146 * It features a 2^128 long sequence, returns 64 high-quality bits on each call,
5147 * supports fast jumps and passes all common quality tests. It is thread-safe,
5148 * uses a double-cas on 64-bit architectures supporting it, and falls back to a
5149 * local lock on other ones.
5150 */
5151uint64_t ha_random64()
5152{
Willy Tarreau1544c142020-03-12 00:31:18 +01005153 uint64_t old[2] ALIGNED(2*sizeof(uint64_t));
5154 uint64_t new[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01005155
5156#if defined(USE_THREAD) && (!defined(HA_CAS_IS_8B) || !defined(HA_HAVE_CAS_DW))
5157 static HA_SPINLOCK_T rand_lock;
5158
5159 HA_SPIN_LOCK(OTHER_LOCK, &rand_lock);
5160#endif
5161
5162 old[0] = ha_random_state[0];
5163 old[1] = ha_random_state[1];
5164
5165#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
5166 do {
5167#endif
Willy Tarreau52bf8392020-03-08 00:42:37 +01005168 new[1] = old[0] ^ old[1];
5169 new[0] = rotl64(old[0], 24) ^ new[1] ^ (new[1] << 16); // a, b
5170 new[1] = rotl64(new[1], 37); // c
5171
5172#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
5173 } while (unlikely(!_HA_ATOMIC_DWCAS(ha_random_state, old, new)));
5174#else
5175 ha_random_state[0] = new[0];
5176 ha_random_state[1] = new[1];
5177#if defined(USE_THREAD)
5178 HA_SPIN_UNLOCK(OTHER_LOCK, &rand_lock);
5179#endif
5180#endif
Willy Tarreaub2475a12021-05-09 10:26:14 +02005181 return rotl64(old[0] * 5, 7) * 9;
Willy Tarreau52bf8392020-03-08 00:42:37 +01005182}
5183
5184/* seeds the random state using up to <len> bytes from <seed>, starting with
5185 * the first non-zero byte.
5186 */
5187void ha_random_seed(const unsigned char *seed, size_t len)
5188{
5189 size_t pos;
5190
5191 /* the seed must not be all zeroes, so we pre-fill it with alternating
5192 * bits and overwrite part of them with the block starting at the first
5193 * non-zero byte from the seed.
5194 */
5195 memset(ha_random_state, 0x55, sizeof(ha_random_state));
5196
5197 for (pos = 0; pos < len; pos++)
5198 if (seed[pos] != 0)
5199 break;
5200
5201 if (pos == len)
5202 return;
5203
5204 seed += pos;
5205 len -= pos;
5206
5207 if (len > sizeof(ha_random_state))
5208 len = sizeof(ha_random_state);
5209
5210 memcpy(ha_random_state, seed, len);
5211}
5212
5213/* This causes a jump to (dist * 2^96) places in the pseudo-random sequence,
5214 * and is equivalent to calling ha_random64() as many times. It is used to
5215 * provide non-overlapping sequences of 2^96 numbers (~7*10^28) to up to 2^32
5216 * different generators (i.e. different processes after a fork). The <dist>
5217 * argument is the distance to jump to and is used in a loop so it rather not
5218 * be too large if the processing time is a concern.
5219 *
5220 * BEWARE: this function is NOT thread-safe and must not be called during
5221 * concurrent accesses to ha_random64().
5222 */
5223void ha_random_jump96(uint32_t dist)
5224{
5225 while (dist--) {
5226 uint64_t s0 = 0;
5227 uint64_t s1 = 0;
5228 int b;
5229
5230 for (b = 0; b < 64; b++) {
5231 if ((0xd2a98b26625eee7bULL >> b) & 1) {
5232 s0 ^= ha_random_state[0];
5233 s1 ^= ha_random_state[1];
5234 }
5235 ha_random64();
5236 }
5237
5238 for (b = 0; b < 64; b++) {
5239 if ((0xdddf9b1090aa7ac1ULL >> b) & 1) {
5240 s0 ^= ha_random_state[0];
5241 s1 ^= ha_random_state[1];
5242 }
5243 ha_random64();
5244 }
5245 ha_random_state[0] = s0;
5246 ha_random_state[1] = s1;
5247 }
5248}
5249
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01005250/* Generates an RFC4122 UUID into chunk <output> which must be at least 37
5251 * bytes large.
5252 */
5253void ha_generate_uuid(struct buffer *output)
5254{
5255 uint32_t rnd[4];
5256 uint64_t last;
5257
5258 last = ha_random64();
5259 rnd[0] = last;
5260 rnd[1] = last >> 32;
5261
5262 last = ha_random64();
5263 rnd[2] = last;
5264 rnd[3] = last >> 32;
5265
5266 chunk_printf(output, "%8.8x-%4.4x-%4.4x-%4.4x-%12.12llx",
5267 rnd[0],
5268 rnd[1] & 0xFFFF,
5269 ((rnd[1] >> 16u) & 0xFFF) | 0x4000, // highest 4 bits indicate the uuid version
5270 (rnd[2] & 0x3FFF) | 0x8000, // the highest 2 bits indicate the UUID variant (10),
5271 (long long)((rnd[2] >> 14u) | ((uint64_t) rnd[3] << 18u)) & 0xFFFFFFFFFFFFull);
5272}
5273
5274
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005275/* only used by parse_line() below. It supports writing in place provided that
5276 * <in> is updated to the next location before calling it. In that case, the
5277 * char at <in> may be overwritten.
5278 */
5279#define EMIT_CHAR(x) \
5280 do { \
5281 char __c = (char)(x); \
5282 if ((opts & PARSE_OPT_INPLACE) && out+outpos > in) \
5283 err |= PARSE_ERR_OVERLAP; \
5284 if (outpos >= outmax) \
5285 err |= PARSE_ERR_TOOLARGE; \
5286 if (!err) \
5287 out[outpos] = __c; \
5288 outpos++; \
5289 } while (0)
5290
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05005291/* Parse <in>, copy it into <out> split into isolated words whose pointers
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005292 * are put in <args>. If more than <outlen> bytes have to be emitted, the
5293 * extraneous ones are not emitted but <outlen> is updated so that the caller
5294 * knows how much to realloc. Similarly, <args> are not updated beyond <nbargs>
5295 * but the returned <nbargs> indicates how many were found. All trailing args
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005296 * up to <nbargs> point to the trailing zero, and as long as <nbargs> is > 0,
5297 * it is guaranteed that at least one arg will point to the zero. It is safe
5298 * to call it with a NULL <args> if <nbargs> is 0.
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005299 *
5300 * <out> may overlap with <in> provided that it never goes further, in which
5301 * case the parser will accept to perform in-place parsing and unquoting/
5302 * unescaping but only if environment variables do not lead to expansion that
5303 * causes overlapping, otherwise the input string being destroyed, the error
5304 * will not be recoverable. Note that even during out-of-place <in> will
5305 * experience temporary modifications in-place for variable resolution and must
5306 * be writable, and will also receive zeroes to delimit words when using
5307 * in-place copy. Parsing options <opts> taken from PARSE_OPT_*. Return value
5308 * is zero on success otherwise a bitwise-or of PARSE_ERR_*. Upon error, the
5309 * starting point of the first invalid character sequence or unmatched
5310 * quote/brace is reported in <errptr> if not NULL. When using in-place parsing
5311 * error reporting might be difficult since zeroes will have been inserted into
5312 * the string. One solution for the caller may consist in replacing all args
5313 * delimiters with spaces in this case.
5314 */
5315uint32_t parse_line(char *in, char *out, size_t *outlen, char **args, int *nbargs, uint32_t opts, char **errptr)
5316{
5317 char *quote = NULL;
5318 char *brace = NULL;
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005319 char *word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005320 unsigned char hex1, hex2;
5321 size_t outmax = *outlen;
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005322 int argsmax = *nbargs - 1;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005323 size_t outpos = 0;
5324 int squote = 0;
5325 int dquote = 0;
5326 int arg = 0;
5327 uint32_t err = 0;
5328
5329 *nbargs = 0;
5330 *outlen = 0;
5331
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005332 /* argsmax may be -1 here, protecting args[] from any write */
5333 if (arg < argsmax)
5334 args[arg] = out;
5335
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005336 while (1) {
5337 if (*in >= '-' && *in != '\\') {
5338 /* speedup: directly send all regular chars starting
5339 * with '-', '.', '/', alnum etc...
5340 */
5341 EMIT_CHAR(*in++);
5342 continue;
5343 }
5344 else if (*in == '\0' || *in == '\n' || *in == '\r') {
5345 /* end of line */
5346 break;
5347 }
5348 else if (*in == '#' && (opts & PARSE_OPT_SHARP) && !squote && !dquote) {
5349 /* comment */
5350 break;
5351 }
5352 else if (*in == '"' && !squote && (opts & PARSE_OPT_DQUOTE)) { /* double quote outside single quotes */
5353 if (dquote) {
5354 dquote = 0;
5355 quote = NULL;
5356 }
5357 else {
5358 dquote = 1;
5359 quote = in;
5360 }
5361 in++;
5362 continue;
5363 }
5364 else if (*in == '\'' && !dquote && (opts & PARSE_OPT_SQUOTE)) { /* single quote outside double quotes */
5365 if (squote) {
5366 squote = 0;
5367 quote = NULL;
5368 }
5369 else {
5370 squote = 1;
5371 quote = in;
5372 }
5373 in++;
5374 continue;
5375 }
5376 else if (*in == '\\' && !squote && (opts & PARSE_OPT_BKSLASH)) {
5377 /* first, we'll replace \\, \<space>, \#, \r, \n, \t, \xXX with their
5378 * C equivalent value but only when they have a special meaning and within
5379 * double quotes for some of them. Other combinations left unchanged (eg: \1).
5380 */
5381 char tosend = *in;
5382
5383 switch (in[1]) {
5384 case ' ':
5385 case '\\':
5386 tosend = in[1];
5387 in++;
5388 break;
5389
5390 case 't':
5391 tosend = '\t';
5392 in++;
5393 break;
5394
5395 case 'n':
5396 tosend = '\n';
5397 in++;
5398 break;
5399
5400 case 'r':
5401 tosend = '\r';
5402 in++;
5403 break;
5404
5405 case '#':
5406 /* escaping of "#" only if comments are supported */
5407 if (opts & PARSE_OPT_SHARP)
5408 in++;
5409 tosend = *in;
5410 break;
5411
5412 case '\'':
5413 /* escaping of "'" only outside single quotes and only if single quotes are supported */
5414 if (opts & PARSE_OPT_SQUOTE && !squote)
5415 in++;
5416 tosend = *in;
5417 break;
5418
5419 case '"':
5420 /* escaping of '"' only outside single quotes and only if double quotes are supported */
5421 if (opts & PARSE_OPT_DQUOTE && !squote)
5422 in++;
5423 tosend = *in;
5424 break;
5425
5426 case '$':
5427 /* escaping of '$' only inside double quotes and only if env supported */
5428 if (opts & PARSE_OPT_ENV && dquote)
5429 in++;
5430 tosend = *in;
5431 break;
5432
5433 case 'x':
5434 if (!ishex(in[2]) || !ishex(in[3])) {
5435 /* invalid or incomplete hex sequence */
5436 err |= PARSE_ERR_HEX;
5437 if (errptr)
5438 *errptr = in;
5439 goto leave;
5440 }
Willy Tarreauf278eec2020-07-05 21:46:32 +02005441 hex1 = toupper((unsigned char)in[2]) - '0';
5442 hex2 = toupper((unsigned char)in[3]) - '0';
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005443 if (hex1 > 9) hex1 -= 'A' - '9' - 1;
5444 if (hex2 > 9) hex2 -= 'A' - '9' - 1;
5445 tosend = (hex1 << 4) + hex2;
5446 in += 3;
5447 break;
5448
5449 default:
5450 /* other combinations are not escape sequences */
5451 break;
5452 }
5453
5454 in++;
5455 EMIT_CHAR(tosend);
5456 }
5457 else if (isspace((unsigned char)*in) && !squote && !dquote) {
5458 /* a non-escaped space is an argument separator */
5459 while (isspace((unsigned char)*in))
5460 in++;
5461 EMIT_CHAR(0);
5462 arg++;
5463 if (arg < argsmax)
5464 args[arg] = out + outpos;
5465 else
5466 err |= PARSE_ERR_TOOMANY;
5467 }
5468 else if (*in == '$' && (opts & PARSE_OPT_ENV) && (dquote || !(opts & PARSE_OPT_DQUOTE))) {
5469 /* environment variables are evaluated anywhere, or only
5470 * inside double quotes if they are supported.
5471 */
5472 char *var_name;
5473 char save_char;
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005474 const char *value;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005475
5476 in++;
5477
5478 if (*in == '{')
5479 brace = in++;
5480
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005481 if (!isalpha((unsigned char)*in) && *in != '_' && *in != '.') {
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005482 /* unacceptable character in variable name */
5483 err |= PARSE_ERR_VARNAME;
5484 if (errptr)
5485 *errptr = in;
5486 goto leave;
5487 }
5488
5489 var_name = in;
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005490 if (*in == '.')
5491 in++;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005492 while (isalnum((unsigned char)*in) || *in == '_')
5493 in++;
5494
5495 save_char = *in;
5496 *in = '\0';
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005497 if (unlikely(*var_name == '.')) {
5498 /* internal pseudo-variables */
5499 if (strcmp(var_name, ".LINE") == 0)
5500 value = ultoa(global.cfg_curr_line);
5501 else if (strcmp(var_name, ".FILE") == 0)
5502 value = global.cfg_curr_file;
5503 else if (strcmp(var_name, ".SECTION") == 0)
5504 value = global.cfg_curr_section;
5505 else {
5506 /* unsupported internal variable name */
5507 err |= PARSE_ERR_VARNAME;
5508 if (errptr)
5509 *errptr = var_name;
5510 goto leave;
5511 }
5512 } else {
5513 value = getenv(var_name);
5514 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005515 *in = save_char;
5516
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005517 /* support for '[*]' sequence to force word expansion,
5518 * only available inside braces */
5519 if (*in == '[' && brace && (opts & PARSE_OPT_WORD_EXPAND)) {
5520 word_expand = in++;
5521
5522 if (*in++ != '*' || *in++ != ']') {
5523 err |= PARSE_ERR_WRONG_EXPAND;
5524 if (errptr)
5525 *errptr = word_expand;
5526 goto leave;
5527 }
5528 }
5529
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005530 if (brace) {
5531 if (*in != '}') {
5532 /* unmatched brace */
5533 err |= PARSE_ERR_BRACE;
5534 if (errptr)
5535 *errptr = brace;
5536 goto leave;
5537 }
5538 in++;
5539 brace = NULL;
5540 }
5541
5542 if (value) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005543 while (*value) {
5544 /* expand as individual parameters on a space character */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005545 if (word_expand && isspace((unsigned char)*value)) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005546 EMIT_CHAR(0);
5547 ++arg;
5548 if (arg < argsmax)
5549 args[arg] = out + outpos;
5550 else
5551 err |= PARSE_ERR_TOOMANY;
5552
5553 /* skip consecutive spaces */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005554 while (isspace((unsigned char)*++value))
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005555 ;
5556 } else {
5557 EMIT_CHAR(*value++);
5558 }
5559 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005560 }
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005561 word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005562 }
5563 else {
5564 /* any other regular char */
5565 EMIT_CHAR(*in++);
5566 }
5567 }
5568
5569 /* end of output string */
5570 EMIT_CHAR(0);
5571 arg++;
5572
5573 if (quote) {
5574 /* unmatched quote */
5575 err |= PARSE_ERR_QUOTE;
5576 if (errptr)
5577 *errptr = quote;
5578 goto leave;
5579 }
5580 leave:
5581 *nbargs = arg;
5582 *outlen = outpos;
5583
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005584 /* empty all trailing args by making them point to the trailing zero,
5585 * at least the last one in any case.
5586 */
5587 if (arg > argsmax)
5588 arg = argsmax;
5589
5590 while (arg >= 0 && arg <= argsmax)
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005591 args[arg++] = out + outpos - 1;
5592
5593 return err;
5594}
5595#undef EMIT_CHAR
5596
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005597/* This is used to sanitize an input line that's about to be used for error reporting.
5598 * It will adjust <line> to print approximately <width> chars around <pos>, trying to
5599 * preserve the beginning, with leading or trailing "..." when the line is truncated.
5600 * If non-printable chars are present in the output. It returns the new offset <pos>
5601 * in the modified line. Non-printable characters are replaced with '?'. <width> must
5602 * be at least 6 to support two "..." otherwise the result is undefined. The line
5603 * itself must have at least 7 chars allocated for the same reason.
5604 */
5605size_t sanitize_for_printing(char *line, size_t pos, size_t width)
5606{
5607 size_t shift = 0;
5608 char *out = line;
5609 char *in = line;
5610 char *end = line + width;
5611
5612 if (pos >= width) {
5613 /* if we have to shift, we'll be out of context, so let's
5614 * try to put <pos> at the center of width.
5615 */
5616 shift = pos - width / 2;
5617 in += shift + 3;
5618 end = out + width - 3;
5619 out[0] = out[1] = out[2] = '.';
5620 out += 3;
5621 }
5622
5623 while (out < end && *in) {
5624 if (isspace((unsigned char)*in))
5625 *out++ = ' ';
5626 else if (isprint((unsigned char)*in))
5627 *out++ = *in;
5628 else
5629 *out++ = '?';
5630 in++;
5631 }
5632
5633 if (end < line + width) {
5634 out[0] = out[1] = out[2] = '.';
5635 out += 3;
5636 }
5637
5638 *out++ = 0;
5639 return pos - shift;
5640}
Willy Tarreau06e69b52021-03-02 14:01:35 +01005641
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005642/* Update array <fp> with the fingerprint of word <word> by counting the
Willy Tarreauba2c4452021-03-12 09:01:52 +01005643 * transitions between characters. <fp> is a 1024-entries array indexed as
5644 * 32*from+to. Positions for 'from' and 'to' are:
Willy Tarreau9294e882021-03-15 09:34:27 +01005645 * 1..26=letter, 27=digit, 28=other/begin/end.
5646 * Row "from=0" is used to mark the character's presence. Others unused.
Willy Tarreauba2c4452021-03-12 09:01:52 +01005647 */
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005648void update_word_fingerprint(uint8_t *fp, const char *word)
Willy Tarreauba2c4452021-03-12 09:01:52 +01005649{
5650 const char *p;
5651 int from, to;
5652 int c;
5653
Willy Tarreauba2c4452021-03-12 09:01:52 +01005654 from = 28; // begin
5655 for (p = word; *p; p++) {
5656 c = tolower(*p);
5657 switch(c) {
Willy Tarreau9294e882021-03-15 09:34:27 +01005658 case 'a'...'z': to = c - 'a' + 1; break;
5659 case 'A'...'Z': to = tolower(c) - 'a' + 1; break;
5660 case '0'...'9': to = 27; break;
5661 default: to = 28; break;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005662 }
Willy Tarreau9294e882021-03-15 09:34:27 +01005663 fp[to] = 1;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005664 fp[32 * from + to]++;
5665 from = to;
5666 }
5667 to = 28; // end
5668 fp[32 * from + to]++;
5669}
5670
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005671/* Initialize array <fp> with the fingerprint of word <word> by counting the
5672 * transitions between characters. <fp> is a 1024-entries array indexed as
5673 * 32*from+to. Positions for 'from' and 'to' are:
5674 * 0..25=letter, 26=digit, 27=other, 28=begin, 29=end, others unused.
5675 */
5676void make_word_fingerprint(uint8_t *fp, const char *word)
5677{
5678 memset(fp, 0, 1024);
5679 update_word_fingerprint(fp, word);
5680}
5681
Willy Tarreauba2c4452021-03-12 09:01:52 +01005682/* Return the distance between two word fingerprints created by function
5683 * make_word_fingerprint(). It's a positive integer calculated as the sum of
Willy Tarreau714c4c12021-03-15 09:44:53 +01005684 * the differences between each location.
Willy Tarreauba2c4452021-03-12 09:01:52 +01005685 */
5686int word_fingerprint_distance(const uint8_t *fp1, const uint8_t *fp2)
5687{
5688 int i, k, dist = 0;
5689
5690 for (i = 0; i < 1024; i++) {
5691 k = (int)fp1[i] - (int)fp2[i];
Willy Tarreau714c4c12021-03-15 09:44:53 +01005692 dist += abs(k);
Willy Tarreauba2c4452021-03-12 09:01:52 +01005693 }
5694 return dist;
5695}
5696
Willy Tarreau06e69b52021-03-02 14:01:35 +01005697static int init_tools_per_thread()
5698{
5699 /* Let's make each thread start from a different position */
5700 statistical_prng_state += tid * MAX_THREADS;
5701 if (!statistical_prng_state)
5702 statistical_prng_state++;
5703 return 1;
5704}
5705REGISTER_PER_THREAD_INIT(init_tools_per_thread);
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005706
Willy Tarreaubaaee002006-06-26 02:48:02 +02005707/*
5708 * Local variables:
5709 * c-indent-level: 8
5710 * c-basic-offset: 8
5711 * End:
5712 */