blob: f62032b9c19de97dbeccee56296197f58b3f7c97 [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.comc4e52322021-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 Carlierbd2cced2021-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
David Carlier43a56852022-03-04 15:50:48 +000046#if defined(__linux__) && 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>
William Lallemand3aeb3f92021-08-21 23:59:56 +020065#include <haproxy/ssl_utils.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020066#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020067#include <haproxy/task.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020068#include <haproxy/tools.h>
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +010069
Thierry Fournier93127942016-01-20 18:49:45 +010070/* This macro returns false if the test __x is false. Many
71 * of the following parsing function must be abort the processing
72 * if it returns 0, so this macro is useful for writing light code.
73 */
74#define RET0_UNLESS(__x) do { if (!(__x)) return 0; } while (0)
75
Willy Tarreau56adcf22012-12-23 18:00:29 +010076/* enough to store NB_ITOA_STR integers of :
Willy Tarreau72d759c2007-10-25 12:14:10 +020077 * 2^64-1 = 18446744073709551615 or
78 * -2^63 = -9223372036854775808
Willy Tarreaue7239b52009-03-29 13:41:58 +020079 *
80 * The HTML version needs room for adding the 25 characters
81 * '<span class="rls"></span>' around digits at positions 3N+1 in order
82 * to add spacing at up to 6 positions : 18 446 744 073 709 551 615
Willy Tarreau72d759c2007-10-25 12:14:10 +020083 */
Christopher Faulet99bca652017-11-14 16:47:26 +010084THREAD_LOCAL char itoa_str[NB_ITOA_STR][171];
85THREAD_LOCAL int itoa_idx = 0; /* index of next itoa_str to use */
Willy Tarreaubaaee002006-06-26 02:48:02 +020086
Willy Tarreau588297f2014-06-16 15:16:40 +020087/* sometimes we'll need to quote strings (eg: in stats), and we don't expect
88 * to quote strings larger than a max configuration line.
89 */
Christopher Faulet99bca652017-11-14 16:47:26 +010090THREAD_LOCAL char quoted_str[NB_QSTR][QSTR_SIZE + 1];
91THREAD_LOCAL int quoted_idx = 0;
Willy Tarreau588297f2014-06-16 15:16:40 +020092
Willy Tarreau06e69b52021-03-02 14:01:35 +010093/* thread-local PRNG state. It's modified to start from a different sequence
94 * on all threads upon startup. It must not be used or anything beyond getting
95 * statistical values as it's 100% predictable.
96 */
97THREAD_LOCAL unsigned int statistical_prng_state = 2463534242U;
98
Willy Tarreaubaaee002006-06-26 02:48:02 +020099/*
William Lallemande7340ec2012-01-24 11:15:39 +0100100 * unsigned long long ASCII representation
101 *
102 * return the last char '\0' or NULL if no enough
103 * space in dst
104 */
105char *ulltoa(unsigned long long n, char *dst, size_t size)
106{
107 int i = 0;
108 char *res;
109
110 switch(n) {
111 case 1ULL ... 9ULL:
112 i = 0;
113 break;
114
115 case 10ULL ... 99ULL:
116 i = 1;
117 break;
118
119 case 100ULL ... 999ULL:
120 i = 2;
121 break;
122
123 case 1000ULL ... 9999ULL:
124 i = 3;
125 break;
126
127 case 10000ULL ... 99999ULL:
128 i = 4;
129 break;
130
131 case 100000ULL ... 999999ULL:
132 i = 5;
133 break;
134
135 case 1000000ULL ... 9999999ULL:
136 i = 6;
137 break;
138
139 case 10000000ULL ... 99999999ULL:
140 i = 7;
141 break;
142
143 case 100000000ULL ... 999999999ULL:
144 i = 8;
145 break;
146
147 case 1000000000ULL ... 9999999999ULL:
148 i = 9;
149 break;
150
151 case 10000000000ULL ... 99999999999ULL:
152 i = 10;
153 break;
154
155 case 100000000000ULL ... 999999999999ULL:
156 i = 11;
157 break;
158
159 case 1000000000000ULL ... 9999999999999ULL:
160 i = 12;
161 break;
162
163 case 10000000000000ULL ... 99999999999999ULL:
164 i = 13;
165 break;
166
167 case 100000000000000ULL ... 999999999999999ULL:
168 i = 14;
169 break;
170
171 case 1000000000000000ULL ... 9999999999999999ULL:
172 i = 15;
173 break;
174
175 case 10000000000000000ULL ... 99999999999999999ULL:
176 i = 16;
177 break;
178
179 case 100000000000000000ULL ... 999999999999999999ULL:
180 i = 17;
181 break;
182
183 case 1000000000000000000ULL ... 9999999999999999999ULL:
184 i = 18;
185 break;
186
187 case 10000000000000000000ULL ... ULLONG_MAX:
188 i = 19;
189 break;
190 }
191 if (i + 2 > size) // (i + 1) + '\0'
192 return NULL; // too long
193 res = dst + i + 1;
194 *res = '\0';
195 for (; i >= 0; i--) {
196 dst[i] = n % 10ULL + '0';
197 n /= 10ULL;
198 }
199 return res;
200}
201
202/*
203 * unsigned long ASCII representation
204 *
205 * return the last char '\0' or NULL if no enough
206 * space in dst
207 */
208char *ultoa_o(unsigned long n, char *dst, size_t size)
209{
210 int i = 0;
211 char *res;
212
213 switch (n) {
214 case 0U ... 9UL:
215 i = 0;
216 break;
217
218 case 10U ... 99UL:
219 i = 1;
220 break;
221
222 case 100U ... 999UL:
223 i = 2;
224 break;
225
226 case 1000U ... 9999UL:
227 i = 3;
228 break;
229
230 case 10000U ... 99999UL:
231 i = 4;
232 break;
233
234 case 100000U ... 999999UL:
235 i = 5;
236 break;
237
238 case 1000000U ... 9999999UL:
239 i = 6;
240 break;
241
242 case 10000000U ... 99999999UL:
243 i = 7;
244 break;
245
246 case 100000000U ... 999999999UL:
247 i = 8;
248 break;
249#if __WORDSIZE == 32
250
251 case 1000000000ULL ... ULONG_MAX:
252 i = 9;
253 break;
254
255#elif __WORDSIZE == 64
256
257 case 1000000000ULL ... 9999999999UL:
258 i = 9;
259 break;
260
261 case 10000000000ULL ... 99999999999UL:
262 i = 10;
263 break;
264
265 case 100000000000ULL ... 999999999999UL:
266 i = 11;
267 break;
268
269 case 1000000000000ULL ... 9999999999999UL:
270 i = 12;
271 break;
272
273 case 10000000000000ULL ... 99999999999999UL:
274 i = 13;
275 break;
276
277 case 100000000000000ULL ... 999999999999999UL:
278 i = 14;
279 break;
280
281 case 1000000000000000ULL ... 9999999999999999UL:
282 i = 15;
283 break;
284
285 case 10000000000000000ULL ... 99999999999999999UL:
286 i = 16;
287 break;
288
289 case 100000000000000000ULL ... 999999999999999999UL:
290 i = 17;
291 break;
292
293 case 1000000000000000000ULL ... 9999999999999999999UL:
294 i = 18;
295 break;
296
297 case 10000000000000000000ULL ... ULONG_MAX:
298 i = 19;
299 break;
300
301#endif
302 }
303 if (i + 2 > size) // (i + 1) + '\0'
304 return NULL; // too long
305 res = dst + i + 1;
306 *res = '\0';
307 for (; i >= 0; i--) {
308 dst[i] = n % 10U + '0';
309 n /= 10U;
310 }
311 return res;
312}
313
314/*
315 * signed long ASCII representation
316 *
317 * return the last char '\0' or NULL if no enough
318 * space in dst
319 */
320char *ltoa_o(long int n, char *dst, size_t size)
321{
322 char *pos = dst;
323
324 if (n < 0) {
325 if (size < 3)
326 return NULL; // min size is '-' + digit + '\0' but another test in ultoa
327 *pos = '-';
328 pos++;
329 dst = ultoa_o(-n, pos, size - 1);
330 } else {
331 dst = ultoa_o(n, dst, size);
332 }
333 return dst;
334}
335
336/*
337 * signed long long ASCII representation
338 *
339 * return the last char '\0' or NULL if no enough
340 * space in dst
341 */
342char *lltoa(long long n, char *dst, size_t size)
343{
344 char *pos = dst;
345
346 if (n < 0) {
347 if (size < 3)
348 return NULL; // min size is '-' + digit + '\0' but another test in ulltoa
349 *pos = '-';
350 pos++;
351 dst = ulltoa(-n, pos, size - 1);
352 } else {
353 dst = ulltoa(n, dst, size);
354 }
355 return dst;
356}
357
358/*
359 * write a ascii representation of a unsigned into dst,
360 * return a pointer to the last character
361 * Pad the ascii representation with '0', using size.
362 */
363char *utoa_pad(unsigned int n, char *dst, size_t size)
364{
365 int i = 0;
366 char *ret;
367
368 switch(n) {
369 case 0U ... 9U:
370 i = 0;
371 break;
372
373 case 10U ... 99U:
374 i = 1;
375 break;
376
377 case 100U ... 999U:
378 i = 2;
379 break;
380
381 case 1000U ... 9999U:
382 i = 3;
383 break;
384
385 case 10000U ... 99999U:
386 i = 4;
387 break;
388
389 case 100000U ... 999999U:
390 i = 5;
391 break;
392
393 case 1000000U ... 9999999U:
394 i = 6;
395 break;
396
397 case 10000000U ... 99999999U:
398 i = 7;
399 break;
400
401 case 100000000U ... 999999999U:
402 i = 8;
403 break;
404
405 case 1000000000U ... 4294967295U:
406 i = 9;
407 break;
408 }
409 if (i + 2 > size) // (i + 1) + '\0'
410 return NULL; // too long
411 if (i < size)
412 i = size - 2; // padding - '\0'
413
414 ret = dst + i + 1;
415 *ret = '\0';
416 for (; i >= 0; i--) {
417 dst[i] = n % 10U + '0';
418 n /= 10U;
419 }
420 return ret;
421}
422
423/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200424 * copies at most <size-1> chars from <src> to <dst>. Last char is always
425 * set to 0, unless <size> is 0. The number of chars copied is returned
426 * (excluding the terminating zero).
427 * This code has been optimized for size and speed : on x86, it's 45 bytes
428 * long, uses only registers, and consumes only 4 cycles per char.
429 */
430int strlcpy2(char *dst, const char *src, int size)
431{
432 char *orig = dst;
433 if (size) {
434 while (--size && (*dst = *src)) {
435 src++; dst++;
436 }
437 *dst = 0;
438 }
439 return dst - orig;
440}
441
442/*
Willy Tarreau72d759c2007-10-25 12:14:10 +0200443 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +0200444 * the ascii representation for number 'n' in decimal.
445 */
Emeric Brun3a7fce52010-01-04 14:54:38 +0100446char *ultoa_r(unsigned long n, char *buffer, int size)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200447{
448 char *pos;
449
Willy Tarreau72d759c2007-10-25 12:14:10 +0200450 pos = buffer + size - 1;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200451 *pos-- = '\0';
452
453 do {
454 *pos-- = '0' + n % 10;
455 n /= 10;
Willy Tarreau72d759c2007-10-25 12:14:10 +0200456 } while (n && pos >= buffer);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200457 return pos + 1;
458}
459
Willy Tarreau91092e52007-10-25 16:58:42 +0200460/*
Willy Tarreaue7239b52009-03-29 13:41:58 +0200461 * This function simply returns a locally allocated string containing
Thierry FOURNIER763a5d82015-07-06 23:09:52 +0200462 * the ascii representation for number 'n' in decimal.
463 */
464char *lltoa_r(long long int in, char *buffer, int size)
465{
466 char *pos;
467 int neg = 0;
468 unsigned long long int n;
469
470 pos = buffer + size - 1;
471 *pos-- = '\0';
472
473 if (in < 0) {
474 neg = 1;
475 n = -in;
476 }
477 else
478 n = in;
479
480 do {
481 *pos-- = '0' + n % 10;
482 n /= 10;
483 } while (n && pos >= buffer);
484 if (neg && pos > buffer)
485 *pos-- = '-';
486 return pos + 1;
487}
488
489/*
490 * This function simply returns a locally allocated string containing
Thierry FOURNIER1480bd82015-06-06 19:14:59 +0200491 * the ascii representation for signed number 'n' in decimal.
492 */
493char *sltoa_r(long n, char *buffer, int size)
494{
495 char *pos;
496
497 if (n >= 0)
498 return ultoa_r(n, buffer, size);
499
500 pos = ultoa_r(-n, buffer + 1, size - 1) - 1;
501 *pos = '-';
502 return pos;
503}
504
505/*
506 * This function simply returns a locally allocated string containing
Willy Tarreaue7239b52009-03-29 13:41:58 +0200507 * the ascii representation for number 'n' in decimal, formatted for
508 * HTML output with tags to create visual grouping by 3 digits. The
509 * output needs to support at least 171 characters.
510 */
511const char *ulltoh_r(unsigned long long n, char *buffer, int size)
512{
513 char *start;
514 int digit = 0;
515
516 start = buffer + size;
517 *--start = '\0';
518
519 do {
520 if (digit == 3 && start >= buffer + 7)
521 memcpy(start -= 7, "</span>", 7);
522
523 if (start >= buffer + 1) {
524 *--start = '0' + n % 10;
525 n /= 10;
526 }
527
528 if (digit == 3 && start >= buffer + 18)
529 memcpy(start -= 18, "<span class=\"rls\">", 18);
530
531 if (digit++ == 3)
532 digit = 1;
533 } while (n && start > buffer);
534 return start;
535}
536
537/*
Willy Tarreau91092e52007-10-25 16:58:42 +0200538 * This function simply returns a locally allocated string containing the ascii
539 * representation for number 'n' in decimal, unless n is 0 in which case it
540 * returns the alternate string (or an empty string if the alternate string is
541 * NULL). It use is intended for limits reported in reports, where it's
542 * desirable not to display anything if there is no limit. Warning! it shares
543 * the same vector as ultoa_r().
544 */
545const char *limit_r(unsigned long n, char *buffer, int size, const char *alt)
546{
547 return (n) ? ultoa_r(n, buffer, size) : (alt ? alt : "");
548}
549
Willy Tarreau56d1d8d2021-05-08 10:28:53 +0200550/* Trims the first "%f" float in a string to its minimum number of digits after
551 * the decimal point by trimming trailing zeroes, even dropping the decimal
552 * point if not needed. The string is in <buffer> of length <len>, and the
553 * number is expected to start at or after position <num_start> (the first
554 * point appearing there is considered). A NUL character is always placed at
555 * the end if some trimming occurs. The new buffer length is returned.
556 */
557size_t flt_trim(char *buffer, size_t num_start, size_t len)
558{
559 char *end = buffer + len;
560 char *p = buffer + num_start;
561 char *trim;
562
563 do {
564 if (p >= end)
565 return len;
566 trim = p++;
567 } while (*trim != '.');
568
569 /* For now <trim> is on the decimal point. Let's look for any other
570 * meaningful digit after it.
571 */
572 while (p < end) {
573 if (*p++ != '0')
574 trim = p;
575 }
576
577 if (trim < end)
578 *trim = 0;
579
580 return trim - buffer;
581}
582
Willy Tarreauae03d262021-05-08 07:35:00 +0200583/*
584 * This function simply returns a locally allocated string containing
585 * the ascii representation for number 'n' in decimal with useless trailing
586 * zeroes trimmed.
587 */
588char *ftoa_r(double n, char *buffer, int size)
589{
590 flt_trim(buffer, 0, snprintf(buffer, size, "%f", n));
591 return buffer;
592}
593
Willy Tarreau588297f2014-06-16 15:16:40 +0200594/* returns a locally allocated string containing the quoted encoding of the
595 * input string. The output may be truncated to QSTR_SIZE chars, but it is
596 * guaranteed that the string will always be properly terminated. Quotes are
597 * encoded by doubling them as is commonly done in CSV files. QSTR_SIZE must
598 * always be at least 4 chars.
599 */
600const char *qstr(const char *str)
601{
602 char *ret = quoted_str[quoted_idx];
603 char *p, *end;
604
605 if (++quoted_idx >= NB_QSTR)
606 quoted_idx = 0;
607
608 p = ret;
609 end = ret + QSTR_SIZE;
610
611 *p++ = '"';
612
613 /* always keep 3 chars to support passing "" and the ending " */
614 while (*str && p < end - 3) {
615 if (*str == '"') {
616 *p++ = '"';
617 *p++ = '"';
618 }
619 else
620 *p++ = *str;
621 str++;
622 }
623 *p++ = '"';
624 return ret;
625}
626
Robert Tsai81ae1952007-12-05 10:47:29 +0100627/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200628 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
629 *
630 * It looks like this one would be a good candidate for inlining, but this is
631 * not interesting because it around 35 bytes long and often called multiple
632 * times within the same function.
633 */
634int ishex(char s)
635{
636 s -= '0';
637 if ((unsigned char)s <= 9)
638 return 1;
639 s -= 'A' - '0';
640 if ((unsigned char)s <= 5)
641 return 1;
642 s -= 'a' - 'A';
643 if ((unsigned char)s <= 5)
644 return 1;
645 return 0;
646}
647
Willy Tarreau3ca1a882015-01-15 18:43:49 +0100648/* rounds <i> down to the closest value having max 2 digits */
649unsigned int round_2dig(unsigned int i)
650{
651 unsigned int mul = 1;
652
653 while (i >= 100) {
654 i /= 10;
655 mul *= 10;
656 }
657 return i * mul;
658}
659
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100660/*
661 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
662 * invalid character is found, a pointer to it is returned. If everything is
663 * fine, NULL is returned.
664 */
665const char *invalid_char(const char *name)
666{
667 if (!*name)
668 return name;
669
670 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100671 if (!isalnum((unsigned char)*name) && *name != '.' && *name != ':' &&
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100672 *name != '_' && *name != '-')
673 return name;
674 name++;
675 }
676 return NULL;
677}
Willy Tarreaubaaee002006-06-26 02:48:02 +0200678
679/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200680 * Checks <name> for invalid characters. Valid chars are [_.-] and those
681 * accepted by <f> function.
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200682 * If an invalid character is found, a pointer to it is returned.
683 * If everything is fine, NULL is returned.
684 */
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200685static inline const char *__invalid_char(const char *name, int (*f)(int)) {
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200686
687 if (!*name)
688 return name;
689
690 while (*name) {
Willy Tarreau90807112020-02-25 08:16:33 +0100691 if (!f((unsigned char)*name) && *name != '.' &&
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200692 *name != '_' && *name != '-')
693 return name;
694
695 name++;
696 }
697
698 return NULL;
699}
700
701/*
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200702 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_.-].
703 * If an invalid character is found, a pointer to it is returned.
704 * If everything is fine, NULL is returned.
705 */
706const char *invalid_domainchar(const char *name) {
707 return __invalid_char(name, isalnum);
708}
709
710/*
711 * Checks <name> for invalid characters. Valid chars are [A-Za-z_.-].
712 * If an invalid character is found, a pointer to it is returned.
713 * If everything is fine, NULL is returned.
714 */
715const char *invalid_prefix_char(const char *name) {
Thierry Fournierf7b7c3e2018-03-26 11:54:39 +0200716 return __invalid_char(name, isalnum);
Frédéric Lécailleb82f7422017-04-13 18:24:23 +0200717}
718
719/*
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100720 * converts <str> to a struct sockaddr_storage* provided by the caller. The
Willy Tarreau24709282013-03-10 21:32:12 +0100721 * caller must have zeroed <sa> first, and may have set sa->ss_family to force
722 * parse a specific address format. If the ss_family is 0 or AF_UNSPEC, then
723 * the function tries to guess the address family from the syntax. If the
724 * family is forced and the format doesn't match, an error is returned. The
Willy Tarreaufab5a432011-03-04 15:31:53 +0100725 * string is assumed to contain only an address, no port. The address can be a
726 * dotted IPv4 address, an IPv6 address, a host name, or empty or "*" to
727 * indicate INADDR_ANY. NULL is returned if the host part cannot be resolved.
728 * The return address will only have the address family and the address set,
729 * all other fields remain zero. The string is not supposed to be modified.
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100730 * The IPv6 '::' address is IN6ADDR_ANY. If <resolve> is non-zero, the hostname
731 * is resolved, otherwise only IP addresses are resolved, and anything else
Willy Tarreauecde7df2016-11-02 22:37:03 +0100732 * returns NULL. If the address contains a port, this one is preserved.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200733 */
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100734struct sockaddr_storage *str2ip2(const char *str, struct sockaddr_storage *sa, int resolve)
Willy Tarreaubaaee002006-06-26 02:48:02 +0200735{
Willy Tarreaufab5a432011-03-04 15:31:53 +0100736 struct hostent *he;
mildisff5d5102015-10-26 18:50:08 +0100737 /* max IPv6 length, including brackets and terminating NULL */
738 char tmpip[48];
Willy Tarreauecde7df2016-11-02 22:37:03 +0100739 int port = get_host_port(sa);
mildisff5d5102015-10-26 18:50:08 +0100740
741 /* check IPv6 with square brackets */
742 if (str[0] == '[') {
743 size_t iplength = strlen(str);
744
745 if (iplength < 4) {
746 /* minimal size is 4 when using brackets "[::]" */
747 goto fail;
748 }
749 else if (iplength >= sizeof(tmpip)) {
750 /* IPv6 literal can not be larger than tmpip */
751 goto fail;
752 }
753 else {
754 if (str[iplength - 1] != ']') {
755 /* if address started with bracket, it should end with bracket */
756 goto fail;
757 }
758 else {
759 memcpy(tmpip, str + 1, iplength - 2);
760 tmpip[iplength - 2] = '\0';
761 str = tmpip;
762 }
763 }
764 }
Willy Tarreaufab5a432011-03-04 15:31:53 +0100765
Willy Tarreaufab5a432011-03-04 15:31:53 +0100766 /* Any IPv6 address */
767 if (str[0] == ':' && str[1] == ':' && !str[2]) {
Willy Tarreau24709282013-03-10 21:32:12 +0100768 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
769 sa->ss_family = AF_INET6;
770 else if (sa->ss_family != AF_INET6)
771 goto fail;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100772 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100773 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100774 }
775
Willy Tarreau24709282013-03-10 21:32:12 +0100776 /* Any address for the family, defaults to IPv4 */
Willy Tarreaufab5a432011-03-04 15:31:53 +0100777 if (!str[0] || (str[0] == '*' && !str[1])) {
Willy Tarreau24709282013-03-10 21:32:12 +0100778 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
779 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100780 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100781 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100782 }
783
784 /* check for IPv6 first */
Willy Tarreau24709282013-03-10 21:32:12 +0100785 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET6) &&
786 inet_pton(AF_INET6, str, &((struct sockaddr_in6 *)sa)->sin6_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100787 sa->ss_family = AF_INET6;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100788 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100789 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100790 }
791
792 /* then check for IPv4 */
Willy Tarreau24709282013-03-10 21:32:12 +0100793 if ((!sa->ss_family || sa->ss_family == AF_UNSPEC || sa->ss_family == AF_INET) &&
794 inet_pton(AF_INET, str, &((struct sockaddr_in *)sa)->sin_addr)) {
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100795 sa->ss_family = AF_INET;
Willy Tarreauecde7df2016-11-02 22:37:03 +0100796 set_host_port(sa, port);
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100797 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100798 }
799
Thierry FOURNIER58639a02014-11-25 12:02:25 +0100800 if (!resolve)
801 return NULL;
802
Emeric Brund30e9a12020-12-23 18:49:16 +0100803 if (!resolv_hostname_validation(str, NULL))
Baptiste Assmanna68ca962015-04-14 01:15:08 +0200804 return NULL;
805
David du Colombierd5f43282011-03-17 10:40:16 +0100806#ifdef USE_GETADDRINFO
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200807 if (global.tune.options & GTUNE_USE_GAI) {
David du Colombierd5f43282011-03-17 10:40:16 +0100808 struct addrinfo hints, *result;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100809 int success = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100810
811 memset(&result, 0, sizeof(result));
812 memset(&hints, 0, sizeof(hints));
Willy Tarreau24709282013-03-10 21:32:12 +0100813 hints.ai_family = sa->ss_family ? sa->ss_family : AF_UNSPEC;
David du Colombierd5f43282011-03-17 10:40:16 +0100814 hints.ai_socktype = SOCK_DGRAM;
Dmitry Sivachenkoeab7f392015-10-02 01:01:58 +0200815 hints.ai_flags = 0;
David du Colombierd5f43282011-03-17 10:40:16 +0100816 hints.ai_protocol = 0;
817
818 if (getaddrinfo(str, NULL, &hints, &result) == 0) {
Willy Tarreau24709282013-03-10 21:32:12 +0100819 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
820 sa->ss_family = result->ai_family;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100821 else if (sa->ss_family != result->ai_family) {
822 freeaddrinfo(result);
Willy Tarreau24709282013-03-10 21:32:12 +0100823 goto fail;
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100824 }
Willy Tarreau24709282013-03-10 21:32:12 +0100825
David du Colombierd5f43282011-03-17 10:40:16 +0100826 switch (result->ai_family) {
827 case AF_INET:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100828 memcpy((struct sockaddr_in *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100829 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100830 success = 1;
831 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100832 case AF_INET6:
Willy Tarreauc120c8d2013-03-10 19:27:44 +0100833 memcpy((struct sockaddr_in6 *)sa, result->ai_addr, result->ai_addrlen);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100834 set_host_port(sa, port);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100835 success = 1;
836 break;
David du Colombierd5f43282011-03-17 10:40:16 +0100837 }
838 }
839
Sean Carey58ea0392013-02-15 23:39:18 +0100840 if (result)
841 freeaddrinfo(result);
Tim Duesterhus7d58b4d2018-01-21 22:11:17 +0100842
843 if (success)
844 return sa;
Willy Tarreaufab5a432011-03-04 15:31:53 +0100845 }
David du Colombierd5f43282011-03-17 10:40:16 +0100846#endif
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200847 /* try to resolve an IPv4/IPv6 hostname */
848 he = gethostbyname(str);
849 if (he) {
850 if (!sa->ss_family || sa->ss_family == AF_UNSPEC)
851 sa->ss_family = he->h_addrtype;
852 else if (sa->ss_family != he->h_addrtype)
853 goto fail;
854
855 switch (sa->ss_family) {
856 case AF_INET:
857 ((struct sockaddr_in *)sa)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100858 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200859 return sa;
860 case AF_INET6:
861 ((struct sockaddr_in6 *)sa)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
Willy Tarreauecde7df2016-11-02 22:37:03 +0100862 set_host_port(sa, port);
Nenad Merdanovic88afe032014-04-14 15:56:58 +0200863 return sa;
864 }
865 }
866
David du Colombierd5f43282011-03-17 10:40:16 +0100867 /* unsupported address family */
Willy Tarreau24709282013-03-10 21:32:12 +0100868 fail:
Willy Tarreaufab5a432011-03-04 15:31:53 +0100869 return NULL;
870}
871
872/*
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100873 * Converts <str> to a locally allocated struct sockaddr_storage *, and a port
874 * range or offset consisting in two integers that the caller will have to
875 * check to find the relevant input format. The following format are supported :
876 *
877 * String format | address | port | low | high
878 * addr | <addr> | 0 | 0 | 0
879 * addr: | <addr> | 0 | 0 | 0
880 * addr:port | <addr> | <port> | <port> | <port>
881 * addr:pl-ph | <addr> | <pl> | <pl> | <ph>
882 * addr:+port | <addr> | <port> | 0 | <port>
883 * addr:-port | <addr> |-<port> | <port> | 0
884 *
885 * The detection of a port range or increment by the caller is made by
886 * comparing <low> and <high>. If both are equal, then port 0 means no port
887 * was specified. The caller may pass NULL for <low> and <high> if it is not
888 * interested in retrieving port ranges.
889 *
890 * Note that <addr> above may also be :
891 * - empty ("") => family will be AF_INET and address will be INADDR_ANY
892 * - "*" => family will be AF_INET and address will be INADDR_ANY
893 * - "::" => family will be AF_INET6 and address will be IN6ADDR_ANY
894 * - a host name => family and address will depend on host name resolving.
895 *
Willy Tarreau24709282013-03-10 21:32:12 +0100896 * A prefix may be passed in before the address above to force the family :
897 * - "ipv4@" => force address to resolve as IPv4 and fail if not possible.
898 * - "ipv6@" => force address to resolve as IPv6 and fail if not possible.
899 * - "unix@" => force address to be a path to a UNIX socket even if the
900 * path does not start with a '/'
Willy Tarreauccfccef2014-05-10 01:49:15 +0200901 * - 'abns@' -> force address to belong to the abstract namespace (Linux
902 * only). These sockets are just like Unix sockets but without
903 * the need for an underlying file system. The address is a
904 * string. Technically it's like a Unix socket with a zero in
905 * the first byte of the address.
Willy Tarreau40aa0702013-03-10 23:51:38 +0100906 * - "fd@" => an integer must follow, and is a file descriptor number.
Willy Tarreau24709282013-03-10 21:32:12 +0100907 *
mildisff5d5102015-10-26 18:50:08 +0100908 * IPv6 addresses can be declared with or without square brackets. When using
909 * square brackets for IPv6 addresses, the port separator (colon) is optional.
910 * If not using square brackets, and in order to avoid any ambiguity with
911 * IPv6 addresses, the last colon ':' is mandatory even when no port is specified.
912 * NULL is returned if the address cannot be parsed. The <low> and <high> ports
913 * are always initialized if non-null, even for non-IP families.
Willy Tarreaud393a622013-03-04 18:22:00 +0100914 *
915 * If <pfx> is non-null, it is used as a string prefix before any path-based
916 * address (typically the path to a unix socket).
Willy Tarreau40aa0702013-03-10 23:51:38 +0100917 *
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200918 * if <fqdn> is non-null, it will be filled with :
919 * - a pointer to the FQDN of the server name to resolve if there's one, and
920 * that the caller will have to free(),
921 * - NULL if there was an explicit address that doesn't require resolution.
922 *
Willy Tarreaucd3a55912020-09-04 15:30:46 +0200923 * Hostnames are only resolved if <opts> has PA_O_RESOLVE. Otherwise <fqdn> is
924 * still honored so it is possible for the caller to know whether a resolution
925 * failed by clearing this flag and checking if <fqdn> was filled, indicating
926 * the need for a resolution.
Thierry FOURNIER7fe3be72015-09-26 20:03:36 +0200927 *
Willy Tarreau40aa0702013-03-10 23:51:38 +0100928 * When a file descriptor is passed, its value is put into the s_addr part of
Willy Tarreaua5b325f2020-09-04 16:44:20 +0200929 * the address when cast to sockaddr_in and the address family is
930 * AF_CUST_EXISTING_FD.
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200931 *
Willy Tarreau5fc93282020-09-16 18:25:03 +0200932 * The matching protocol will be set into <proto> if non-null.
933 *
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200934 * Any known file descriptor is also assigned to <fd> if non-null, otherwise it
935 * is forced to -1.
Willy Tarreaufab5a432011-03-04 15:31:53 +0100936 */
Willy Tarreau5fc93282020-09-16 18:25:03 +0200937struct sockaddr_storage *str2sa_range(const char *str, int *port, int *low, int *high, int *fd,
938 struct protocol **proto, char **err,
939 const char *pfx, char **fqdn, unsigned int opts)
Willy Tarreaufab5a432011-03-04 15:31:53 +0100940{
Christopher Faulet1bc04c72017-10-29 20:14:08 +0100941 static THREAD_LOCAL struct sockaddr_storage ss;
David du Colombier6f5ccb12011-03-10 22:26:24 +0100942 struct sockaddr_storage *ret = NULL;
Willy Tarreau5fc93282020-09-16 18:25:03 +0200943 struct protocol *new_proto = NULL;
Willy Tarreau24709282013-03-10 21:32:12 +0100944 char *back, *str2;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100945 char *port1, *port2;
946 int portl, porth, porta;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200947 int abstract = 0;
Willy Tarreaua93e5c72020-09-15 14:01:16 +0200948 int new_fd = -1;
Willy Tarreaue3b45182021-10-27 17:28:55 +0200949 enum proto_type proto_type;
950 int ctrl_type;
Willy Tarreaud4448bc2013-02-20 15:55:15 +0100951
952 portl = porth = porta = 0;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +0200953 if (fqdn)
954 *fqdn = NULL;
Willy Tarreaubaaee002006-06-26 02:48:02 +0200955
Willy Tarreaudad36a32013-03-11 01:20:04 +0100956 str2 = back = env_expand(strdup(str));
Willy Tarreaudf350f12013-03-01 20:22:54 +0100957 if (str2 == NULL) {
958 memprintf(err, "out of memory in '%s'\n", __FUNCTION__);
Willy Tarreaud5191e72010-02-09 20:50:45 +0100959 goto out;
Willy Tarreaudf350f12013-03-01 20:22:54 +0100960 }
Willy Tarreaubaaee002006-06-26 02:48:02 +0200961
Willy Tarreau9f69f462015-09-08 16:01:25 +0200962 if (!*str2) {
963 memprintf(err, "'%s' resolves to an empty address (environment variable missing?)\n", str);
964 goto out;
965 }
966
Willy Tarreau24709282013-03-10 21:32:12 +0100967 memset(&ss, 0, sizeof(ss));
968
Willy Tarreaue835bd82020-09-16 11:35:47 +0200969 /* prepare the default socket types */
Willy Tarreauf23b1bc2021-03-23 18:36:37 +0100970 if ((opts & (PA_O_STREAM|PA_O_DGRAM)) == PA_O_DGRAM ||
Willy Tarreaue3b45182021-10-27 17:28:55 +0200971 ((opts & (PA_O_STREAM|PA_O_DGRAM)) == (PA_O_DGRAM|PA_O_STREAM) && (opts & PA_O_DEFAULT_DGRAM))) {
972 proto_type = PROTO_TYPE_DGRAM;
973 ctrl_type = SOCK_DGRAM;
974 } else {
975 proto_type = PROTO_TYPE_STREAM;
976 ctrl_type = SOCK_STREAM;
977 }
Willy Tarreaue835bd82020-09-16 11:35:47 +0200978
979 if (strncmp(str2, "stream+", 7) == 0) {
980 str2 += 7;
Willy Tarreaue3b45182021-10-27 17:28:55 +0200981 proto_type = PROTO_TYPE_STREAM;
982 ctrl_type = SOCK_STREAM;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200983 }
984 else if (strncmp(str2, "dgram+", 6) == 0) {
985 str2 += 6;
Willy Tarreaue3b45182021-10-27 17:28:55 +0200986 proto_type = PROTO_TYPE_DGRAM;
987 ctrl_type = SOCK_DGRAM;
Willy Tarreaue835bd82020-09-16 11:35:47 +0200988 }
989
Willy Tarreau24709282013-03-10 21:32:12 +0100990 if (strncmp(str2, "unix@", 5) == 0) {
991 str2 += 5;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200992 abstract = 0;
Willy Tarreau24709282013-03-10 21:32:12 +0100993 ss.ss_family = AF_UNIX;
994 }
Emeric Brunce325c42021-04-02 17:05:09 +0200995 else if (strncmp(str2, "uxdg@", 5) == 0) {
996 str2 += 5;
997 abstract = 0;
998 ss.ss_family = AF_UNIX;
Willy Tarreaue3b45182021-10-27 17:28:55 +0200999 proto_type = PROTO_TYPE_DGRAM;
1000 ctrl_type = SOCK_DGRAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001001 }
1002 else if (strncmp(str2, "uxst@", 5) == 0) {
1003 str2 += 5;
1004 abstract = 0;
1005 ss.ss_family = AF_UNIX;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001006 proto_type = PROTO_TYPE_STREAM;
1007 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001008 }
Willy Tarreauccfccef2014-05-10 01:49:15 +02001009 else if (strncmp(str2, "abns@", 5) == 0) {
1010 str2 += 5;
1011 abstract = 1;
1012 ss.ss_family = AF_UNIX;
1013 }
Emeric Brunce325c42021-04-02 17:05:09 +02001014 else if (strncmp(str2, "ip@", 3) == 0) {
1015 str2 += 3;
1016 ss.ss_family = AF_UNSPEC;
1017 }
Willy Tarreau24709282013-03-10 21:32:12 +01001018 else if (strncmp(str2, "ipv4@", 5) == 0) {
1019 str2 += 5;
1020 ss.ss_family = AF_INET;
1021 }
1022 else if (strncmp(str2, "ipv6@", 5) == 0) {
1023 str2 += 5;
1024 ss.ss_family = AF_INET6;
1025 }
Emeric Brunce325c42021-04-02 17:05:09 +02001026 else if (strncmp(str2, "tcp4@", 5) == 0) {
1027 str2 += 5;
1028 ss.ss_family = AF_INET;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001029 proto_type = PROTO_TYPE_STREAM;
1030 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001031 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001032 else if (strncmp(str2, "udp4@", 5) == 0) {
1033 str2 += 5;
1034 ss.ss_family = AF_INET;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001035 proto_type = PROTO_TYPE_DGRAM;
1036 ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001037 }
Emeric Brunce325c42021-04-02 17:05:09 +02001038 else if (strncmp(str2, "tcp6@", 5) == 0) {
1039 str2 += 5;
1040 ss.ss_family = AF_INET6;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001041 proto_type = PROTO_TYPE_STREAM;
1042 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001043 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001044 else if (strncmp(str2, "udp6@", 5) == 0) {
1045 str2 += 5;
1046 ss.ss_family = AF_INET6;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001047 proto_type = PROTO_TYPE_DGRAM;
1048 ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001049 }
Emeric Brunce325c42021-04-02 17:05:09 +02001050 else if (strncmp(str2, "tcp@", 4) == 0) {
1051 str2 += 4;
1052 ss.ss_family = AF_UNSPEC;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001053 proto_type = PROTO_TYPE_STREAM;
1054 ctrl_type = SOCK_STREAM;
Emeric Brunce325c42021-04-02 17:05:09 +02001055 }
Emeric Brun3835c0d2020-07-07 09:46:09 +02001056 else if (strncmp(str2, "udp@", 4) == 0) {
1057 str2 += 4;
1058 ss.ss_family = AF_UNSPEC;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001059 proto_type = PROTO_TYPE_DGRAM;
1060 ctrl_type = SOCK_DGRAM;
Emeric Brun3835c0d2020-07-07 09:46:09 +02001061 }
Frédéric Lécaille10caf652020-11-23 11:36:57 +01001062 else if (strncmp(str2, "quic4@", 6) == 0) {
1063 str2 += 6;
1064 ss.ss_family = AF_INET;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001065 proto_type = PROTO_TYPE_DGRAM;
Frédéric Lécaille10caf652020-11-23 11:36:57 +01001066 ctrl_type = SOCK_STREAM;
1067 }
1068 else if (strncmp(str2, "quic6@", 6) == 0) {
1069 str2 += 6;
1070 ss.ss_family = AF_INET6;
Willy Tarreaue3b45182021-10-27 17:28:55 +02001071 proto_type = PROTO_TYPE_DGRAM;
Frédéric Lécaille10caf652020-11-23 11:36:57 +01001072 ctrl_type = SOCK_STREAM;
1073 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001074 else if (strncmp(str2, "fd@", 3) == 0) {
1075 str2 += 3;
1076 ss.ss_family = AF_CUST_EXISTING_FD;
1077 }
1078 else if (strncmp(str2, "sockpair@", 9) == 0) {
1079 str2 += 9;
1080 ss.ss_family = AF_CUST_SOCKPAIR;
1081 }
Willy Tarreau24709282013-03-10 21:32:12 +01001082 else if (*str2 == '/') {
1083 ss.ss_family = AF_UNIX;
1084 }
1085 else
1086 ss.ss_family = AF_UNSPEC;
1087
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001088 if (ss.ss_family == AF_CUST_SOCKPAIR) {
Willy Tarreaua215be22020-09-16 10:14:16 +02001089 struct sockaddr_storage ss2;
1090 socklen_t addr_len;
William Lallemand2fe7dd02018-09-11 16:51:29 +02001091 char *endptr;
1092
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001093 new_fd = strtol(str2, &endptr, 10);
1094 if (!*str2 || new_fd < 0 || *endptr) {
William Lallemand2fe7dd02018-09-11 16:51:29 +02001095 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
1096 goto out;
1097 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001098
Willy Tarreaua215be22020-09-16 10:14:16 +02001099 /* just verify that it's a socket */
1100 addr_len = sizeof(ss2);
1101 if (getsockname(new_fd, (struct sockaddr *)&ss2, &addr_len) == -1) {
1102 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1103 goto out;
1104 }
1105
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001106 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1107 ((struct sockaddr_in *)&ss)->sin_port = 0;
William Lallemand2fe7dd02018-09-11 16:51:29 +02001108 }
Willy Tarreau5a7beed2020-09-04 16:54:05 +02001109 else if (ss.ss_family == AF_CUST_EXISTING_FD) {
Willy Tarreau40aa0702013-03-10 23:51:38 +01001110 char *endptr;
1111
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001112 new_fd = strtol(str2, &endptr, 10);
1113 if (!*str2 || new_fd < 0 || *endptr) {
Willy Tarreaudad36a32013-03-11 01:20:04 +01001114 memprintf(err, "file descriptor '%s' is not a valid integer in '%s'\n", str2, str);
Willy Tarreau40aa0702013-03-10 23:51:38 +01001115 goto out;
1116 }
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001117
Willy Tarreau6edc7222020-09-15 17:41:56 +02001118 if (opts & PA_O_SOCKET_FD) {
1119 socklen_t addr_len;
1120 int type;
1121
1122 addr_len = sizeof(ss);
1123 if (getsockname(new_fd, (struct sockaddr *)&ss, &addr_len) == -1) {
1124 memprintf(err, "cannot use file descriptor '%d' : %s.\n", new_fd, strerror(errno));
1125 goto out;
1126 }
1127
1128 addr_len = sizeof(type);
1129 if (getsockopt(new_fd, SOL_SOCKET, SO_TYPE, &type, &addr_len) != 0 ||
Willy Tarreaue3b45182021-10-27 17:28:55 +02001130 (type == SOCK_STREAM) != (proto_type == PROTO_TYPE_STREAM)) {
Willy Tarreau6edc7222020-09-15 17:41:56 +02001131 memprintf(err, "socket on file descriptor '%d' is of the wrong type.\n", new_fd);
1132 goto out;
1133 }
1134
1135 porta = portl = porth = get_host_port(&ss);
1136 } else if (opts & PA_O_RAW_FD) {
1137 ((struct sockaddr_in *)&ss)->sin_addr.s_addr = new_fd;
1138 ((struct sockaddr_in *)&ss)->sin_port = 0;
1139 } else {
1140 memprintf(err, "a file descriptor is not acceptable here in '%s'\n", str);
1141 goto out;
1142 }
Willy Tarreau40aa0702013-03-10 23:51:38 +01001143 }
1144 else if (ss.ss_family == AF_UNIX) {
Willy Tarreau8daa9202019-06-16 18:16:33 +02001145 struct sockaddr_un *un = (struct sockaddr_un *)&ss;
Willy Tarreau15586382013-03-04 19:48:14 +01001146 int prefix_path_len;
1147 int max_path_len;
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001148 int adr_len;
Willy Tarreau15586382013-03-04 19:48:14 +01001149
1150 /* complete unix socket path name during startup or soft-restart is
1151 * <unix_bind_prefix><path>.<pid>.<bak|tmp>
1152 */
Willy Tarreauccfccef2014-05-10 01:49:15 +02001153 prefix_path_len = (pfx && !abstract) ? strlen(pfx) : 0;
Willy Tarreau8daa9202019-06-16 18:16:33 +02001154 max_path_len = (sizeof(un->sun_path) - 1) -
Willy Tarreau327ea5a2020-02-11 06:43:37 +01001155 (abstract ? 0 : prefix_path_len + 1 + 5 + 1 + 3);
Willy Tarreau15586382013-03-04 19:48:14 +01001156
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001157 adr_len = strlen(str2);
1158 if (adr_len > max_path_len) {
Willy Tarreau15586382013-03-04 19:48:14 +01001159 memprintf(err, "socket path '%s' too long (max %d)\n", str, max_path_len);
1160 goto out;
1161 }
1162
Willy Tarreauccfccef2014-05-10 01:49:15 +02001163 /* when abstract==1, we skip the first zero and copy all bytes except the trailing zero */
Willy Tarreau8daa9202019-06-16 18:16:33 +02001164 memset(un->sun_path, 0, sizeof(un->sun_path));
Willy Tarreau94ef3f32014-04-14 14:49:00 +02001165 if (prefix_path_len)
Willy Tarreau8daa9202019-06-16 18:16:33 +02001166 memcpy(un->sun_path, pfx, prefix_path_len);
1167 memcpy(un->sun_path + prefix_path_len + abstract, str2, adr_len + 1 - abstract);
Willy Tarreau15586382013-03-04 19:48:14 +01001168 }
Willy Tarreau24709282013-03-10 21:32:12 +01001169 else { /* IPv4 and IPv6 */
mildisff5d5102015-10-26 18:50:08 +01001170 char *end = str2 + strlen(str2);
1171 char *chr;
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001172
mildisff5d5102015-10-26 18:50:08 +01001173 /* search for : or ] whatever comes first */
1174 for (chr = end-1; chr > str2; chr--) {
1175 if (*chr == ']' || *chr == ':')
1176 break;
1177 }
1178
1179 if (*chr == ':') {
1180 /* Found a colon before a closing-bracket, must be a port separator.
1181 * This guarantee backward compatibility.
1182 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001183 if (!(opts & PA_O_PORT_OK)) {
1184 memprintf(err, "port specification not permitted here in '%s'", str);
1185 goto out;
1186 }
mildisff5d5102015-10-26 18:50:08 +01001187 *chr++ = '\0';
1188 port1 = chr;
1189 }
1190 else {
1191 /* Either no colon and no closing-bracket
1192 * or directly ending with a closing-bracket.
1193 * However, no port.
1194 */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001195 if (opts & PA_O_PORT_MAND) {
1196 memprintf(err, "missing port specification in '%s'", str);
1197 goto out;
1198 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001199 port1 = "";
mildisff5d5102015-10-26 18:50:08 +01001200 }
Willy Tarreaubaaee002006-06-26 02:48:02 +02001201
Willy Tarreau90807112020-02-25 08:16:33 +01001202 if (isdigit((unsigned char)*port1)) { /* single port or range */
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001203 port2 = strchr(port1, '-');
Willy Tarreau7f96a842020-09-15 11:12:44 +02001204 if (port2) {
1205 if (!(opts & PA_O_PORT_RANGE)) {
1206 memprintf(err, "port range not permitted here in '%s'", str);
1207 goto out;
1208 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001209 *port2++ = '\0';
Willy Tarreau7f96a842020-09-15 11:12:44 +02001210 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001211 else
1212 port2 = port1;
1213 portl = atoi(port1);
1214 porth = atoi(port2);
Willy Tarreau7f96a842020-09-15 11:12:44 +02001215
1216 if (portl < !!(opts & PA_O_PORT_MAND) || portl > 65535) {
1217 memprintf(err, "invalid port '%s'", port1);
1218 goto out;
1219 }
1220
1221 if (porth < !!(opts & PA_O_PORT_MAND) || porth > 65535) {
1222 memprintf(err, "invalid port '%s'", port2);
1223 goto out;
1224 }
1225
1226 if (portl > porth) {
1227 memprintf(err, "invalid port range '%d-%d'", portl, porth);
1228 goto out;
1229 }
1230
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001231 porta = portl;
1232 }
1233 else if (*port1 == '-') { /* negative offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001234 if (!(opts & PA_O_PORT_OFS)) {
1235 memprintf(err, "port offset not permitted here in '%s'", str);
1236 goto out;
1237 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001238 portl = atoi(port1 + 1);
1239 porta = -portl;
1240 }
1241 else if (*port1 == '+') { /* positive offset */
Willy Tarreau7f96a842020-09-15 11:12:44 +02001242 if (!(opts & PA_O_PORT_OFS)) {
1243 memprintf(err, "port offset not permitted here in '%s'", str);
1244 goto out;
1245 }
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001246 porth = atoi(port1 + 1);
1247 porta = porth;
1248 }
1249 else if (*port1) { /* other any unexpected char */
Willy Tarreaudad36a32013-03-11 01:20:04 +01001250 memprintf(err, "invalid character '%c' in port number '%s' in '%s'\n", *port1, port1, str);
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001251 goto out;
1252 }
Willy Tarreau7f96a842020-09-15 11:12:44 +02001253 else if (opts & PA_O_PORT_MAND) {
1254 memprintf(err, "missing port specification in '%s'", str);
1255 goto out;
1256 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001257
1258 /* first try to parse the IP without resolving. If it fails, it
1259 * tells us we need to keep a copy of the FQDN to resolve later
1260 * and to enable DNS. In this case we can proceed if <fqdn> is
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001261 * set or if PA_O_RESOLVE is set, otherwise it's an error.
Willy Tarreauceccdd72016-11-02 22:27:10 +01001262 */
1263 if (str2ip2(str2, &ss, 0) == NULL) {
Willy Tarreaucd3a55912020-09-04 15:30:46 +02001264 if ((!(opts & PA_O_RESOLVE) && !fqdn) ||
1265 ((opts & PA_O_RESOLVE) && str2ip2(str2, &ss, 1) == NULL)) {
Willy Tarreauceccdd72016-11-02 22:27:10 +01001266 memprintf(err, "invalid address: '%s' in '%s'\n", str2, str);
1267 goto out;
1268 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001269
Willy Tarreauceccdd72016-11-02 22:27:10 +01001270 if (fqdn) {
1271 if (str2 != back)
1272 memmove(back, str2, strlen(str2) + 1);
1273 *fqdn = back;
1274 back = NULL;
1275 }
Willy Tarreau72b8c1f2015-09-08 15:50:19 +02001276 }
Willy Tarreauceccdd72016-11-02 22:27:10 +01001277 set_host_port(&ss, porta);
Willy Tarreaue4c58c82013-03-06 15:28:17 +01001278 }
Willy Tarreaufab5a432011-03-04 15:31:53 +01001279
Willy Tarreaue835bd82020-09-16 11:35:47 +02001280 if (ctrl_type == SOCK_STREAM && !(opts & PA_O_STREAM)) {
1281 memprintf(err, "stream-type socket not acceptable in '%s'\n", str);
1282 goto out;
1283 }
1284 else if (ctrl_type == SOCK_DGRAM && !(opts & PA_O_DGRAM)) {
1285 memprintf(err, "dgram-type socket not acceptable in '%s'\n", str);
1286 goto out;
1287 }
1288
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001289 if (proto || (opts & PA_O_CONNECT)) {
Willy Tarreau5fc93282020-09-16 18:25:03 +02001290 /* Note: if the caller asks for a proto, we must find one,
Emeric Brun26754902021-04-07 14:26:44 +02001291 * except if we inherit from a raw FD (family == AF_CUST_EXISTING_FD)
1292 * orif we return with an fqdn that will resolve later,
Willy Tarreau5fc93282020-09-16 18:25:03 +02001293 * in which case the address is not known yet (this is only
1294 * for servers actually).
1295 */
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001296 new_proto = protocol_lookup(ss.ss_family,
Willy Tarreaue3b45182021-10-27 17:28:55 +02001297 proto_type,
Willy Tarreauaf9609b2020-09-16 22:04:46 +02001298 ctrl_type == SOCK_DGRAM);
Willy Tarreaub2ffc992020-09-16 21:37:31 +02001299
Emeric Brun26754902021-04-07 14:26:44 +02001300 if (!new_proto && (!fqdn || !*fqdn) && (ss.ss_family != AF_CUST_EXISTING_FD)) {
Willy Tarreau5fc93282020-09-16 18:25:03 +02001301 memprintf(err, "unsupported protocol family %d for address '%s'", ss.ss_family, str);
1302 goto out;
1303 }
Willy Tarreau65ec4e32020-09-16 19:17:08 +02001304
1305 if ((opts & PA_O_CONNECT) && new_proto && !new_proto->connect) {
1306 memprintf(err, "connect() not supported for this protocol family %d used by address '%s'", ss.ss_family, str);
1307 goto out;
1308 }
Willy Tarreau5fc93282020-09-16 18:25:03 +02001309 }
1310
Willy Tarreauc120c8d2013-03-10 19:27:44 +01001311 ret = &ss;
Willy Tarreaud5191e72010-02-09 20:50:45 +01001312 out:
Willy Tarreau48ef4c92017-01-06 18:32:38 +01001313 if (port)
1314 *port = porta;
Willy Tarreaud4448bc2013-02-20 15:55:15 +01001315 if (low)
1316 *low = portl;
1317 if (high)
1318 *high = porth;
Willy Tarreaua93e5c72020-09-15 14:01:16 +02001319 if (fd)
1320 *fd = new_fd;
Willy Tarreau5fc93282020-09-16 18:25:03 +02001321 if (proto)
1322 *proto = new_proto;
Willy Tarreau24709282013-03-10 21:32:12 +01001323 free(back);
Willy Tarreaud5191e72010-02-09 20:50:45 +01001324 return ret;
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001325}
1326
Thayne McCombs92149f92020-11-20 01:28:26 -07001327/* converts <addr> and <port> into a string representation of the address and port. This is sort
1328 * of an inverse of str2sa_range, with some restrictions. The supported families are AF_INET,
1329 * AF_INET6, AF_UNIX, and AF_CUST_SOCKPAIR. If the family is unsopported NULL is returned.
1330 * If map_ports is true, then the sign of the port is included in the output, to indicate it is
1331 * relative to the incoming port. AF_INET and AF_INET6 will be in the form "<addr>:<port>".
1332 * AF_UNIX will either be just the path (if using a pathname) or "abns@<path>" if it is abstract.
1333 * AF_CUST_SOCKPAIR will be of the form "sockpair@<fd>".
1334 *
1335 * The returned char* is allocated, and it is the responsibility of the caller to free it.
1336 */
1337char * sa2str(const struct sockaddr_storage *addr, int port, int map_ports)
1338{
1339 char buffer[INET6_ADDRSTRLEN];
1340 char *out = NULL;
1341 const void *ptr;
1342 const char *path;
1343
1344 switch (addr->ss_family) {
1345 case AF_INET:
1346 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1347 break;
1348 case AF_INET6:
1349 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1350 break;
1351 case AF_UNIX:
1352 path = ((struct sockaddr_un *)addr)->sun_path;
1353 if (path[0] == '\0') {
1354 const int max_length = sizeof(struct sockaddr_un) - offsetof(struct sockaddr_un, sun_path) - 1;
1355 return memprintf(&out, "abns@%.*s", max_length, path+1);
1356 } else {
1357 return strdup(path);
1358 }
1359 case AF_CUST_SOCKPAIR:
1360 return memprintf(&out, "sockpair@%d", ((struct sockaddr_in *)addr)->sin_addr.s_addr);
1361 default:
1362 return NULL;
1363 }
1364 inet_ntop(addr->ss_family, ptr, buffer, get_addr_len(addr));
1365 if (map_ports)
1366 return memprintf(&out, "%s:%+d", buffer, port);
1367 else
1368 return memprintf(&out, "%s:%d", buffer, port);
1369}
1370
1371
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001372/* converts <str> to a struct in_addr containing a network mask. It can be
1373 * passed in dotted form (255.255.255.0) or in CIDR form (24). It returns 1
Jarno Huuskonen577d5ac2017-05-21 17:32:21 +03001374 * if the conversion succeeds otherwise zero.
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001375 */
1376int str2mask(const char *str, struct in_addr *mask)
1377{
1378 if (strchr(str, '.') != NULL) { /* dotted notation */
1379 if (!inet_pton(AF_INET, str, mask))
1380 return 0;
1381 }
1382 else { /* mask length */
1383 char *err;
1384 unsigned long len = strtol(str, &err, 10);
1385
1386 if (!*str || (err && *err) || (unsigned)len > 32)
1387 return 0;
Tim Duesterhus8575f722018-01-25 16:24:48 +01001388
1389 len2mask4(len, mask);
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001390 }
1391 return 1;
1392}
1393
Tim Duesterhus47185172018-01-25 16:24:49 +01001394/* converts <str> to a struct in6_addr containing a network mask. It can be
Tim Duesterhus5e642862018-02-20 17:02:18 +01001395 * passed in quadruplet form (ffff:ffff::) or in CIDR form (64). It returns 1
Tim Duesterhus47185172018-01-25 16:24:49 +01001396 * if the conversion succeeds otherwise zero.
1397 */
1398int str2mask6(const char *str, struct in6_addr *mask)
1399{
1400 if (strchr(str, ':') != NULL) { /* quadruplet notation */
1401 if (!inet_pton(AF_INET6, str, mask))
1402 return 0;
1403 }
1404 else { /* mask length */
1405 char *err;
1406 unsigned long len = strtol(str, &err, 10);
1407
1408 if (!*str || (err && *err) || (unsigned)len > 128)
1409 return 0;
1410
1411 len2mask6(len, mask);
1412 }
1413 return 1;
1414}
1415
Thierry FOURNIERb0504632013-12-14 15:39:02 +01001416/* convert <cidr> to struct in_addr <mask>. It returns 1 if the conversion
1417 * succeeds otherwise zero.
1418 */
1419int cidr2dotted(int cidr, struct in_addr *mask) {
1420
1421 if (cidr < 0 || cidr > 32)
1422 return 0;
1423
1424 mask->s_addr = cidr ? htonl(~0UL << (32 - cidr)) : 0;
1425 return 1;
1426}
1427
Thierry Fournier70473a52016-02-17 17:12:14 +01001428/* Convert mask from bit length form to in_addr form.
1429 * This function never fails.
1430 */
1431void len2mask4(int len, struct in_addr *addr)
1432{
1433 if (len >= 32) {
1434 addr->s_addr = 0xffffffff;
1435 return;
1436 }
1437 if (len <= 0) {
1438 addr->s_addr = 0x00000000;
1439 return;
1440 }
1441 addr->s_addr = 0xffffffff << (32 - len);
1442 addr->s_addr = htonl(addr->s_addr);
1443}
1444
1445/* Convert mask from bit length form to in6_addr form.
1446 * This function never fails.
1447 */
1448void len2mask6(int len, struct in6_addr *addr)
1449{
1450 len2mask4(len, (struct in_addr *)&addr->s6_addr[0]); /* msb */
1451 len -= 32;
1452 len2mask4(len, (struct in_addr *)&addr->s6_addr[4]);
1453 len -= 32;
1454 len2mask4(len, (struct in_addr *)&addr->s6_addr[8]);
1455 len -= 32;
1456 len2mask4(len, (struct in_addr *)&addr->s6_addr[12]); /* lsb */
1457}
1458
Willy Tarreauc6f4ce82009-06-10 11:09:37 +02001459/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +02001460 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001461 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001462 * is optional and either in the dotted or CIDR notation.
Willy Tarreaubaaee002006-06-26 02:48:02 +02001463 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
1464 */
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001465int str2net(const char *str, int resolve, struct in_addr *addr, struct in_addr *mask)
Willy Tarreaubaaee002006-06-26 02:48:02 +02001466{
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001467 __label__ out_free, out_err;
1468 char *c, *s;
1469 int ret_val;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001470
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001471 s = strdup(str);
1472 if (!s)
1473 return 0;
1474
Willy Tarreaubaaee002006-06-26 02:48:02 +02001475 memset(mask, 0, sizeof(*mask));
1476 memset(addr, 0, sizeof(*addr));
Willy Tarreaubaaee002006-06-26 02:48:02 +02001477
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001478 if ((c = strrchr(s, '/')) != NULL) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001479 *c++ = '\0';
1480 /* c points to the mask */
Willy Tarreau2937c0d2010-01-26 17:36:17 +01001481 if (!str2mask(c, mask))
1482 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001483 }
1484 else {
Willy Tarreauebd61602006-12-30 11:54:15 +01001485 mask->s_addr = ~0U;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001486 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001487 if (!inet_pton(AF_INET, s, addr)) {
Willy Tarreaubaaee002006-06-26 02:48:02 +02001488 struct hostent *he;
1489
Thierry FOURNIERfc7ac7b2014-02-11 15:23:04 +01001490 if (!resolve)
1491 goto out_err;
1492
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001493 if ((he = gethostbyname(s)) == NULL) {
1494 goto out_err;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001495 }
1496 else
1497 *addr = *(struct in_addr *) *(he->h_addr_list);
1498 }
Willy Tarreau8aeae4a2007-06-17 11:42:08 +02001499
1500 ret_val = 1;
1501 out_free:
1502 free(s);
1503 return ret_val;
1504 out_err:
1505 ret_val = 0;
1506 goto out_free;
Willy Tarreaubaaee002006-06-26 02:48:02 +02001507}
1508
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001509
1510/*
Willy Tarreau6d20e282012-04-27 22:49:47 +02001511 * converts <str> to two struct in6_addr* which must be pre-allocated.
1512 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001513 * is an optional number of bits (128 being the default).
Willy Tarreau6d20e282012-04-27 22:49:47 +02001514 * Returns 1 if OK, 0 if error.
1515 */
1516int str62net(const char *str, struct in6_addr *addr, unsigned char *mask)
1517{
1518 char *c, *s;
1519 int ret_val = 0;
1520 char *err;
1521 unsigned long len = 128;
1522
1523 s = strdup(str);
1524 if (!s)
1525 return 0;
1526
1527 memset(mask, 0, sizeof(*mask));
1528 memset(addr, 0, sizeof(*addr));
1529
1530 if ((c = strrchr(s, '/')) != NULL) {
1531 *c++ = '\0'; /* c points to the mask */
1532 if (!*c)
1533 goto out_free;
1534
1535 len = strtoul(c, &err, 10);
1536 if ((err && *err) || (unsigned)len > 128)
1537 goto out_free;
1538 }
1539 *mask = len; /* OK we have a valid mask in <len> */
1540
1541 if (!inet_pton(AF_INET6, s, addr))
1542 goto out_free;
1543
1544 ret_val = 1;
1545 out_free:
1546 free(s);
1547 return ret_val;
1548}
1549
1550
1551/*
Willy Tarreau12e10272021-03-25 11:34:40 +01001552 * Parse IPv4 address found in url. Return the number of bytes parsed. It
1553 * expects exactly 4 numbers between 0 and 255 delimited by dots, and returns
1554 * zero in case of mismatch.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001555 */
David du Colombier6f5ccb12011-03-10 22:26:24 +01001556int url2ipv4(const char *addr, struct in_addr *dst)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001557{
1558 int saw_digit, octets, ch;
1559 u_char tmp[4], *tp;
1560 const char *cp = addr;
1561
1562 saw_digit = 0;
1563 octets = 0;
1564 *(tp = tmp) = 0;
1565
1566 while (*addr) {
Willy Tarreau12e10272021-03-25 11:34:40 +01001567 unsigned char digit = (ch = *addr) - '0';
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001568 if (digit > 9 && ch != '.')
1569 break;
Willy Tarreau12e10272021-03-25 11:34:40 +01001570 addr++;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001571 if (digit <= 9) {
1572 u_int new = *tp * 10 + digit;
1573 if (new > 255)
1574 return 0;
1575 *tp = new;
1576 if (!saw_digit) {
1577 if (++octets > 4)
1578 return 0;
1579 saw_digit = 1;
1580 }
1581 } else if (ch == '.' && saw_digit) {
1582 if (octets == 4)
1583 return 0;
1584 *++tp = 0;
1585 saw_digit = 0;
1586 } else
1587 return 0;
1588 }
1589
1590 if (octets < 4)
1591 return 0;
1592
1593 memcpy(&dst->s_addr, tmp, 4);
Willy Tarreau12e10272021-03-25 11:34:40 +01001594 return addr - cp;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001595}
1596
1597/*
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001598 * Resolve destination server from URL. Convert <str> to a sockaddr_storage.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05001599 * <out> contain the code of the detected scheme, the start and length of
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001600 * the hostname. Actually only http and https are supported. <out> can be NULL.
1601 * This function returns the consumed length. It is useful if you parse complete
1602 * url like http://host:port/path, because the consumed length corresponds to
1603 * the first character of the path. If the conversion fails, it returns -1.
1604 *
1605 * This function tries to resolve the DNS name if haproxy is in starting mode.
1606 * So, this function may be used during the configuration parsing.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001607 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001608int url2sa(const char *url, int ulen, struct sockaddr_storage *addr, struct split_url *out)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001609{
1610 const char *curr = url, *cp = url;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001611 const char *end;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001612 int ret, url_code = 0;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001613 unsigned long long int http_code = 0;
1614 int default_port;
1615 struct hostent *he;
1616 char *p;
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001617
1618 /* Firstly, try to find :// pattern */
1619 while (curr < url+ulen && url_code != 0x3a2f2f) {
1620 url_code = ((url_code & 0xffff) << 8);
1621 url_code += (unsigned char)*curr++;
1622 }
1623
1624 /* Secondly, if :// pattern is found, verify parsed stuff
1625 * before pattern is matching our http pattern.
1626 * If so parse ip address and port in uri.
1627 *
1628 * WARNING: Current code doesn't support dynamic async dns resolver.
1629 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001630 if (url_code != 0x3a2f2f)
1631 return -1;
1632
1633 /* Copy scheme, and utrn to lower case. */
1634 while (cp < curr - 3)
1635 http_code = (http_code << 8) + *cp++;
1636 http_code |= 0x2020202020202020ULL; /* Turn everything to lower case */
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001637
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001638 /* HTTP or HTTPS url matching */
1639 if (http_code == 0x2020202068747470ULL) {
1640 default_port = 80;
1641 if (out)
1642 out->scheme = SCH_HTTP;
1643 }
1644 else if (http_code == 0x2020206874747073ULL) {
1645 default_port = 443;
1646 if (out)
1647 out->scheme = SCH_HTTPS;
1648 }
1649 else
1650 return -1;
1651
1652 /* If the next char is '[', the host address is IPv6. */
1653 if (*curr == '[') {
1654 curr++;
1655
1656 /* Check trash size */
1657 if (trash.size < ulen)
1658 return -1;
1659
1660 /* Look for ']' and copy the address in a trash buffer. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001661 p = trash.area;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001662 for (end = curr;
1663 end < url + ulen && *end != ']';
1664 end++, p++)
1665 *p = *end;
1666 if (*end != ']')
1667 return -1;
1668 *p = '\0';
1669
1670 /* Update out. */
1671 if (out) {
1672 out->host = curr;
1673 out->host_len = end - curr;
1674 }
1675
1676 /* Try IPv6 decoding. */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001677 if (!inet_pton(AF_INET6, trash.area, &((struct sockaddr_in6 *)addr)->sin6_addr))
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001678 return -1;
1679 end++;
1680
1681 /* Decode port. */
1682 if (*end == ':') {
1683 end++;
1684 default_port = read_uint(&end, url + ulen);
1685 }
1686 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1687 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1688 return end - url;
1689 }
1690 else {
William Lallemand8a913742022-02-18 16:13:12 +01001691 /* we need to copy the string into the trash because url2ipv4
1692 * needs a \0 at the end of the string */
1693 if (trash.size < ulen)
1694 return -1;
1695
1696 memcpy(trash.area, curr, ulen - (curr - url));
1697 trash.area[ulen - (curr - url)] = '\0';
1698
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001699 /* We are looking for IP address. If you want to parse and
1700 * resolve hostname found in url, you can use str2sa_range(), but
1701 * be warned this can slow down global daemon performances
1702 * while handling lagging dns responses.
1703 */
William Lallemand8a913742022-02-18 16:13:12 +01001704 ret = url2ipv4(trash.area, &((struct sockaddr_in *)addr)->sin_addr);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001705 if (ret) {
1706 /* Update out. */
1707 if (out) {
1708 out->host = curr;
1709 out->host_len = ret;
1710 }
1711
William Lallemand8a913742022-02-18 16:13:12 +01001712 /* we need to assign again curr and end from the trash */
1713 url = trash.area;
1714 curr = trash.area + ret;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001715
1716 /* Decode port. */
1717 if (*curr == ':') {
1718 curr++;
1719 default_port = read_uint(&curr, url + ulen);
1720 }
1721 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1722
1723 /* Set family. */
1724 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1725 return curr - url;
1726 }
1727 else if (global.mode & MODE_STARTING) {
1728 /* The IPv4 and IPv6 decoding fails, maybe the url contain name. Try to execute
1729 * synchronous DNS request only if HAProxy is in the start state.
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001730 */
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001731
1732 /* look for : or / or end */
1733 for (end = curr;
1734 end < url + ulen && *end != '/' && *end != ':';
1735 end++);
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001736 memcpy(trash.area, curr, end - curr);
1737 trash.area[end - curr] = '\0';
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001738
1739 /* try to resolve an IPv4/IPv6 hostname */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001740 he = gethostbyname(trash.area);
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001741 if (!he)
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001742 return -1;
Thierry FOURNIER9f95e402014-03-21 14:51:46 +01001743
1744 /* Update out. */
1745 if (out) {
1746 out->host = curr;
1747 out->host_len = end - curr;
1748 }
1749
1750 /* Decode port. */
1751 if (*end == ':') {
1752 end++;
1753 default_port = read_uint(&end, url + ulen);
1754 }
1755
1756 /* Copy IP address, set port and family. */
1757 switch (he->h_addrtype) {
1758 case AF_INET:
1759 ((struct sockaddr_in *)addr)->sin_addr = *(struct in_addr *) *(he->h_addr_list);
1760 ((struct sockaddr_in *)addr)->sin_port = htons(default_port);
1761 ((struct sockaddr_in *)addr)->sin_family = AF_INET;
1762 return end - url;
1763
1764 case AF_INET6:
1765 ((struct sockaddr_in6 *)addr)->sin6_addr = *(struct in6_addr *) *(he->h_addr_list);
1766 ((struct sockaddr_in6 *)addr)->sin6_port = htons(default_port);
1767 ((struct sockaddr_in6 *)addr)->sin6_family = AF_INET6;
1768 return end - url;
1769 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001770 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001771 }
Alexandre Cassen5eb1a902007-11-29 15:43:32 +01001772 return -1;
1773}
1774
Willy Tarreau631f01c2011-09-05 00:36:48 +02001775/* Tries to convert a sockaddr_storage address to text form. Upon success, the
1776 * address family is returned so that it's easy for the caller to adapt to the
1777 * output format. Zero is returned if the address family is not supported. -1
1778 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1779 * supported.
1780 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001781int addr_to_str(const struct sockaddr_storage *addr, char *str, int size)
Willy Tarreau631f01c2011-09-05 00:36:48 +02001782{
1783
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001784 const void *ptr;
Willy Tarreau631f01c2011-09-05 00:36:48 +02001785
1786 if (size < 5)
1787 return 0;
1788 *str = '\0';
1789
1790 switch (addr->ss_family) {
1791 case AF_INET:
1792 ptr = &((struct sockaddr_in *)addr)->sin_addr;
1793 break;
1794 case AF_INET6:
1795 ptr = &((struct sockaddr_in6 *)addr)->sin6_addr;
1796 break;
1797 case AF_UNIX:
1798 memcpy(str, "unix", 5);
1799 return addr->ss_family;
1800 default:
1801 return 0;
1802 }
1803
1804 if (inet_ntop(addr->ss_family, ptr, str, size))
1805 return addr->ss_family;
1806
1807 /* failed */
1808 return -1;
1809}
1810
Simon Horman75ab8bd2014-06-16 09:39:41 +09001811/* Tries to convert a sockaddr_storage port to text form. Upon success, the
1812 * address family is returned so that it's easy for the caller to adapt to the
1813 * output format. Zero is returned if the address family is not supported. -1
1814 * is returned upon error, with errno set. AF_INET, AF_INET6 and AF_UNIX are
1815 * supported.
1816 */
Willy Tarreaud5ec4bf2019-04-25 17:48:16 +02001817int port_to_str(const struct sockaddr_storage *addr, char *str, int size)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001818{
1819
1820 uint16_t port;
1821
1822
Willy Tarreaud7dad1b2017-01-06 16:46:22 +01001823 if (size < 6)
Simon Horman75ab8bd2014-06-16 09:39:41 +09001824 return 0;
1825 *str = '\0';
1826
1827 switch (addr->ss_family) {
1828 case AF_INET:
1829 port = ((struct sockaddr_in *)addr)->sin_port;
1830 break;
1831 case AF_INET6:
1832 port = ((struct sockaddr_in6 *)addr)->sin6_port;
1833 break;
1834 case AF_UNIX:
1835 memcpy(str, "unix", 5);
1836 return addr->ss_family;
1837 default:
1838 return 0;
1839 }
1840
1841 snprintf(str, size, "%u", ntohs(port));
1842 return addr->ss_family;
1843}
1844
Willy Tarreau16e01562016-08-09 16:46:18 +02001845/* check if the given address is local to the system or not. It will return
1846 * -1 when it's not possible to know, 0 when the address is not local, 1 when
1847 * it is. We don't want to iterate over all interfaces for this (and it is not
1848 * portable). So instead we try to bind in UDP to this address on a free non
1849 * privileged port and to connect to the same address, port 0 (connect doesn't
1850 * care). If it succeeds, we own the address. Note that non-inet addresses are
1851 * considered local since they're most likely AF_UNIX.
1852 */
1853int addr_is_local(const struct netns_entry *ns,
1854 const struct sockaddr_storage *orig)
1855{
1856 struct sockaddr_storage addr;
1857 int result;
1858 int fd;
1859
1860 if (!is_inet_addr(orig))
1861 return 1;
1862
1863 memcpy(&addr, orig, sizeof(addr));
1864 set_host_port(&addr, 0);
1865
1866 fd = my_socketat(ns, addr.ss_family, SOCK_DGRAM, IPPROTO_UDP);
1867 if (fd < 0)
1868 return -1;
1869
1870 result = -1;
1871 if (bind(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == 0) {
1872 if (connect(fd, (struct sockaddr *)&addr, get_addr_len(&addr)) == -1)
1873 result = 0; // fail, non-local address
1874 else
1875 result = 1; // success, local address
1876 }
1877 else {
1878 if (errno == EADDRNOTAVAIL)
1879 result = 0; // definitely not local :-)
1880 }
1881 close(fd);
1882
1883 return result;
1884}
1885
Willy Tarreaubaaee002006-06-26 02:48:02 +02001886/* will try to encode the string <string> replacing all characters tagged in
1887 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
1888 * prefixed by <escape>, and will store the result between <start> (included)
1889 * and <stop> (excluded), and will always terminate the string with a '\0'
1890 * before <stop>. The position of the '\0' is returned if the conversion
1891 * completes. If bytes are missing between <start> and <stop>, then the
1892 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
1893 * cannot even be stored so we return <start> without writing the 0.
1894 * The input string must also be zero-terminated.
1895 */
1896const char hextab[16] = "0123456789ABCDEF";
1897char *encode_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001898 const char escape, const long *map,
Willy Tarreaubaaee002006-06-26 02:48:02 +02001899 const char *string)
1900{
1901 if (start < stop) {
1902 stop--; /* reserve one byte for the final '\0' */
1903 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001904 if (!ha_bit_test((unsigned char)(*string), map))
Willy Tarreaubaaee002006-06-26 02:48:02 +02001905 *start++ = *string;
1906 else {
1907 if (start + 3 >= stop)
1908 break;
1909 *start++ = escape;
1910 *start++ = hextab[(*string >> 4) & 15];
1911 *start++ = hextab[*string & 15];
1912 }
1913 string++;
1914 }
1915 *start = '\0';
1916 }
1917 return start;
1918}
1919
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001920/*
1921 * Same behavior as encode_string() above, except that it encodes chunk
1922 * <chunk> instead of a string.
1923 */
1924char *encode_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001925 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001926 const struct buffer *chunk)
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001927{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001928 char *str = chunk->area;
1929 char *end = chunk->area + chunk->data;
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001930
1931 if (start < stop) {
1932 stop--; /* reserve one byte for the final '\0' */
1933 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001934 if (!ha_bit_test((unsigned char)(*str), map))
Thierry FOURNIERe059ec92014-03-17 12:01:13 +01001935 *start++ = *str;
1936 else {
1937 if (start + 3 >= stop)
1938 break;
1939 *start++ = escape;
1940 *start++ = hextab[(*str >> 4) & 15];
1941 *start++ = hextab[*str & 15];
1942 }
1943 str++;
1944 }
1945 *start = '\0';
1946 }
1947 return start;
1948}
1949
Dragan Dosen0edd1092016-02-12 13:23:02 +01001950/*
1951 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001952 * character. The input <string> must be zero-terminated. The result will
1953 * be stored between <start> (included) and <stop> (excluded). This
1954 * function will always try to terminate the resulting string with a '\0'
1955 * before <stop>, and will return its position if the conversion
1956 * completes.
1957 */
1958char *escape_string(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001959 const char escape, const long *map,
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001960 const char *string)
1961{
1962 if (start < stop) {
1963 stop--; /* reserve one byte for the final '\0' */
1964 while (start < stop && *string != '\0') {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001965 if (!ha_bit_test((unsigned char)(*string), map))
Dragan Dosen1a5d0602016-07-22 16:00:31 +02001966 *start++ = *string;
1967 else {
1968 if (start + 2 >= stop)
1969 break;
1970 *start++ = escape;
1971 *start++ = *string;
1972 }
1973 string++;
1974 }
1975 *start = '\0';
1976 }
1977 return start;
1978}
1979
1980/*
1981 * Tries to prefix characters tagged in the <map> with the <escape>
Dragan Dosen0edd1092016-02-12 13:23:02 +01001982 * character. <chunk> contains the input to be escaped. The result will be
1983 * stored between <start> (included) and <stop> (excluded). The function
1984 * will always try to terminate the resulting string with a '\0' before
1985 * <stop>, and will return its position if the conversion completes.
1986 */
1987char *escape_chunk(char *start, char *stop,
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001988 const char escape, const long *map,
Willy Tarreau83061a82018-07-13 11:56:34 +02001989 const struct buffer *chunk)
Dragan Dosen0edd1092016-02-12 13:23:02 +01001990{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001991 char *str = chunk->area;
1992 char *end = chunk->area + chunk->data;
Dragan Dosen0edd1092016-02-12 13:23:02 +01001993
1994 if (start < stop) {
1995 stop--; /* reserve one byte for the final '\0' */
1996 while (start < stop && str < end) {
Willy Tarreau1bfd6022019-06-07 11:10:07 +02001997 if (!ha_bit_test((unsigned char)(*str), map))
Dragan Dosen0edd1092016-02-12 13:23:02 +01001998 *start++ = *str;
1999 else {
2000 if (start + 2 >= stop)
2001 break;
2002 *start++ = escape;
2003 *start++ = *str;
2004 }
2005 str++;
2006 }
2007 *start = '\0';
2008 }
2009 return start;
2010}
2011
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002012/* Check a string for using it in a CSV output format. If the string contains
2013 * one of the following four char <">, <,>, CR or LF, the string is
2014 * encapsulated between <"> and the <"> are escaped by a <""> sequence.
2015 * <str> is the input string to be escaped. The function assumes that
2016 * the input string is null-terminated.
2017 *
2018 * If <quote> is 0, the result is returned escaped but without double quote.
Willy Tarreau898529b2016-01-06 18:07:04 +01002019 * It is useful if the escaped string is used between double quotes in the
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002020 * format.
2021 *
Willy Tarreau898529b2016-01-06 18:07:04 +01002022 * printf("..., \"%s\", ...\r\n", csv_enc(str, 0, &trash));
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002023 *
Willy Tarreaub631c292016-01-08 10:04:08 +01002024 * If <quote> is 1, the converter puts the quotes only if any reserved character
2025 * is present. If <quote> is 2, the converter always puts the quotes.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002026 *
Willy Tarreau83061a82018-07-13 11:56:34 +02002027 * <output> is a struct buffer used for storing the output string.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002028 *
Willy Tarreau898529b2016-01-06 18:07:04 +01002029 * The function returns the converted string on its output. If an error
2030 * occurs, the function returns an empty string. This type of output is useful
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002031 * for using the function directly as printf() argument.
2032 *
2033 * If the output buffer is too short to contain the input string, the result
2034 * is truncated.
Willy Tarreau898529b2016-01-06 18:07:04 +01002035 *
Willy Tarreaub631c292016-01-08 10:04:08 +01002036 * This function appends the encoding to the existing output chunk, and it
2037 * guarantees that it starts immediately at the first available character of
2038 * the chunk. Please use csv_enc() instead if you want to replace the output
2039 * chunk.
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002040 */
Willy Tarreau83061a82018-07-13 11:56:34 +02002041const char *csv_enc_append(const char *str, int quote, struct buffer *output)
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002042{
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002043 char *end = output->area + output->size;
2044 char *out = output->area + output->data;
Willy Tarreau898529b2016-01-06 18:07:04 +01002045 char *ptr = out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002046
Willy Tarreaub631c292016-01-08 10:04:08 +01002047 if (quote == 1) {
2048 /* automatic quoting: first verify if we'll have to quote the string */
2049 if (!strpbrk(str, "\n\r,\""))
2050 quote = 0;
2051 }
2052
2053 if (quote)
2054 *ptr++ = '"';
2055
Willy Tarreau898529b2016-01-06 18:07:04 +01002056 while (*str && ptr < end - 2) { /* -2 for reserving space for <"> and \0. */
2057 *ptr = *str;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002058 if (*str == '"') {
Willy Tarreau898529b2016-01-06 18:07:04 +01002059 ptr++;
2060 if (ptr >= end - 2) {
2061 ptr--;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002062 break;
2063 }
Willy Tarreau898529b2016-01-06 18:07:04 +01002064 *ptr = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002065 }
Willy Tarreau898529b2016-01-06 18:07:04 +01002066 ptr++;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002067 str++;
2068 }
2069
Willy Tarreaub631c292016-01-08 10:04:08 +01002070 if (quote)
2071 *ptr++ = '"';
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002072
Willy Tarreau898529b2016-01-06 18:07:04 +01002073 *ptr = '\0';
Willy Tarreau843b7cb2018-07-13 10:54:26 +02002074 output->data = ptr - output->area;
Willy Tarreau898529b2016-01-06 18:07:04 +01002075 return out;
Thierry FOURNIERddea6262015-05-28 16:00:28 +02002076}
2077
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002078/* Decode an URL-encoded string in-place. The resulting string might
2079 * be shorter. If some forbidden characters are found, the conversion is
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002080 * aborted, the string is truncated before the issue and a negative value is
2081 * returned, otherwise the operation returns the length of the decoded string.
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002082 * If the 'in_form' argument is non-nul the string is assumed to be part of
2083 * an "application/x-www-form-urlencoded" encoded string, and the '+' will be
2084 * turned to a space. If it's zero, this will only be done after a question
2085 * mark ('?').
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002086 */
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002087int url_decode(char *string, int in_form)
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002088{
2089 char *in, *out;
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002090 int ret = -1;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002091
2092 in = string;
2093 out = string;
2094 while (*in) {
2095 switch (*in) {
2096 case '+' :
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002097 *out++ = in_form ? ' ' : *in;
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002098 break;
2099 case '%' :
2100 if (!ishex(in[1]) || !ishex(in[2]))
2101 goto end;
2102 *out++ = (hex2i(in[1]) << 4) + hex2i(in[2]);
2103 in += 2;
2104 break;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02002105 case '?':
2106 in_form = 1;
2107 /* fall through */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002108 default:
2109 *out++ = *in;
2110 break;
2111 }
2112 in++;
2113 }
Thierry FOURNIER5068d962013-10-04 16:27:27 +02002114 ret = out - string; /* success */
Willy Tarreaubf9c2fc2011-05-31 18:06:18 +02002115 end:
2116 *out = 0;
2117 return ret;
2118}
Willy Tarreaubaaee002006-06-26 02:48:02 +02002119
Willy Tarreau6911fa42007-03-04 18:06:08 +01002120unsigned int str2ui(const char *s)
2121{
2122 return __str2ui(s);
2123}
2124
2125unsigned int str2uic(const char *s)
2126{
2127 return __str2uic(s);
2128}
2129
2130unsigned int strl2ui(const char *s, int len)
2131{
2132 return __strl2ui(s, len);
2133}
2134
2135unsigned int strl2uic(const char *s, int len)
2136{
2137 return __strl2uic(s, len);
2138}
2139
Willy Tarreau4ec83cd2010-10-15 23:19:55 +02002140unsigned int read_uint(const char **s, const char *end)
2141{
2142 return __read_uint(s, end);
2143}
2144
Thierry FOURNIER763a5d82015-07-06 23:09:52 +02002145/* This function reads an unsigned integer from the string pointed to by <s> and
2146 * returns it. The <s> pointer is adjusted to point to the first unread char. The
2147 * function automatically stops at <end>. If the number overflows, the 2^64-1
2148 * value is returned.
2149 */
2150unsigned long long int read_uint64(const char **s, const char *end)
2151{
2152 const char *ptr = *s;
2153 unsigned long long int i = 0, tmp;
2154 unsigned int j;
2155
2156 while (ptr < end) {
2157
2158 /* read next char */
2159 j = *ptr - '0';
2160 if (j > 9)
2161 goto read_uint64_end;
2162
2163 /* add char to the number and check overflow. */
2164 tmp = i * 10;
2165 if (tmp / 10 != i) {
2166 i = ULLONG_MAX;
2167 goto read_uint64_eat;
2168 }
2169 if (ULLONG_MAX - tmp < j) {
2170 i = ULLONG_MAX;
2171 goto read_uint64_eat;
2172 }
2173 i = tmp + j;
2174 ptr++;
2175 }
2176read_uint64_eat:
2177 /* eat each numeric char */
2178 while (ptr < end) {
2179 if ((unsigned int)(*ptr - '0') > 9)
2180 break;
2181 ptr++;
2182 }
2183read_uint64_end:
2184 *s = ptr;
2185 return i;
2186}
2187
2188/* This function reads an integer from the string pointed to by <s> and returns
2189 * it. The <s> pointer is adjusted to point to the first unread char. The function
2190 * automatically stops at <end>. Il the number is bigger than 2^63-2, the 2^63-1
2191 * value is returned. If the number is lowest than -2^63-1, the -2^63 value is
2192 * returned.
2193 */
2194long long int read_int64(const char **s, const char *end)
2195{
2196 unsigned long long int i = 0;
2197 int neg = 0;
2198
2199 /* Look for minus char. */
2200 if (**s == '-') {
2201 neg = 1;
2202 (*s)++;
2203 }
2204 else if (**s == '+')
2205 (*s)++;
2206
2207 /* convert as positive number. */
2208 i = read_uint64(s, end);
2209
2210 if (neg) {
2211 if (i > 0x8000000000000000ULL)
2212 return LLONG_MIN;
2213 return -i;
2214 }
2215 if (i > 0x7fffffffffffffffULL)
2216 return LLONG_MAX;
2217 return i;
2218}
2219
Willy Tarreau6911fa42007-03-04 18:06:08 +01002220/* This one is 7 times faster than strtol() on athlon with checks.
2221 * It returns the value of the number composed of all valid digits read,
2222 * and can process negative numbers too.
2223 */
2224int strl2ic(const char *s, int len)
2225{
2226 int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002227 int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002228
2229 if (len > 0) {
2230 if (*s != '-') {
2231 /* positive number */
2232 while (len-- > 0) {
2233 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002234 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002235 if (j > 9)
2236 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002237 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002238 }
2239 } else {
2240 /* negative number */
2241 s++;
2242 while (--len > 0) {
2243 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002244 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002245 if (j > 9)
2246 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +02002247 i = k - j;
Willy Tarreau6911fa42007-03-04 18:06:08 +01002248 }
2249 }
2250 }
2251 return i;
2252}
2253
2254
2255/* This function reads exactly <len> chars from <s> and converts them to a
2256 * signed integer which it stores into <ret>. It accurately detects any error
2257 * (truncated string, invalid chars, overflows). It is meant to be used in
2258 * applications designed for hostile environments. It returns zero when the
2259 * number has successfully been converted, non-zero otherwise. When an error
2260 * is returned, the <ret> value is left untouched. It is yet 5 to 40 times
2261 * faster than strtol().
2262 */
2263int strl2irc(const char *s, int len, int *ret)
2264{
2265 int i = 0;
2266 int j;
2267
2268 if (!len)
2269 return 1;
2270
2271 if (*s != '-') {
2272 /* positive number */
2273 while (len-- > 0) {
2274 j = (*s++) - '0';
2275 if (j > 9) return 1; /* invalid char */
2276 if (i > INT_MAX / 10) return 1; /* check for multiply overflow */
2277 i = i * 10;
2278 if (i + j < i) return 1; /* check for addition overflow */
2279 i = i + j;
2280 }
2281 } else {
2282 /* negative number */
2283 s++;
2284 while (--len > 0) {
2285 j = (*s++) - '0';
2286 if (j > 9) return 1; /* invalid char */
2287 if (i < INT_MIN / 10) return 1; /* check for multiply overflow */
2288 i = i * 10;
2289 if (i - j > i) return 1; /* check for subtract overflow */
2290 i = i - j;
2291 }
2292 }
2293 *ret = i;
2294 return 0;
2295}
2296
2297
2298/* This function reads exactly <len> chars from <s> and converts them to a
2299 * signed integer which it stores into <ret>. It accurately detects any error
2300 * (truncated string, invalid chars, overflows). It is meant to be used in
2301 * applications designed for hostile environments. It returns zero when the
2302 * number has successfully been converted, non-zero otherwise. When an error
2303 * is returned, the <ret> value is left untouched. It is about 3 times slower
William Dauchy060ffc82021-02-06 20:47:51 +01002304 * than strl2irc().
Willy Tarreau6911fa42007-03-04 18:06:08 +01002305 */
Willy Tarreau6911fa42007-03-04 18:06:08 +01002306
2307int strl2llrc(const char *s, int len, long long *ret)
2308{
2309 long long i = 0;
2310 int j;
2311
2312 if (!len)
2313 return 1;
2314
2315 if (*s != '-') {
2316 /* positive number */
2317 while (len-- > 0) {
2318 j = (*s++) - '0';
2319 if (j > 9) return 1; /* invalid char */
2320 if (i > LLONG_MAX / 10LL) return 1; /* check for multiply overflow */
2321 i = i * 10LL;
2322 if (i + j < i) return 1; /* check for addition overflow */
2323 i = i + j;
2324 }
2325 } else {
2326 /* negative number */
2327 s++;
2328 while (--len > 0) {
2329 j = (*s++) - '0';
2330 if (j > 9) return 1; /* invalid char */
2331 if (i < LLONG_MIN / 10LL) return 1; /* check for multiply overflow */
2332 i = i * 10LL;
2333 if (i - j > i) return 1; /* check for subtract overflow */
2334 i = i - j;
2335 }
2336 }
2337 *ret = i;
2338 return 0;
2339}
2340
Thierry FOURNIER511e9472014-01-23 17:40:34 +01002341/* This function is used with pat_parse_dotted_ver(). It converts a string
2342 * composed by two number separated by a dot. Each part must contain in 16 bits
2343 * because internally they will be represented as a 32-bit quantity stored in
2344 * a 64-bit integer. It returns zero when the number has successfully been
2345 * converted, non-zero otherwise. When an error is returned, the <ret> value
2346 * is left untouched.
2347 *
2348 * "1.3" -> 0x0000000000010003
2349 * "65535.65535" -> 0x00000000ffffffff
2350 */
2351int strl2llrc_dotted(const char *text, int len, long long *ret)
2352{
2353 const char *end = &text[len];
2354 const char *p;
2355 long long major, minor;
2356
2357 /* Look for dot. */
2358 for (p = text; p < end; p++)
2359 if (*p == '.')
2360 break;
2361
2362 /* Convert major. */
2363 if (strl2llrc(text, p - text, &major) != 0)
2364 return 1;
2365
2366 /* Check major. */
2367 if (major >= 65536)
2368 return 1;
2369
2370 /* Convert minor. */
2371 minor = 0;
2372 if (p < end)
2373 if (strl2llrc(p + 1, end - (p + 1), &minor) != 0)
2374 return 1;
2375
2376 /* Check minor. */
2377 if (minor >= 65536)
2378 return 1;
2379
2380 /* Compose value. */
2381 *ret = (major << 16) | (minor & 0xffff);
2382 return 0;
2383}
2384
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002385/* This function parses a time value optionally followed by a unit suffix among
2386 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
2387 * expected by the caller. The computation does its best to avoid overflows.
2388 * The value is returned in <ret> if everything is fine, and a NULL is returned
2389 * by the function. In case of error, a pointer to the error is returned and
2390 * <ret> is left untouched. Values are automatically rounded up when needed.
Willy Tarreau9faebe32019-06-07 19:00:37 +02002391 * Values resulting in values larger than or equal to 2^31 after conversion are
2392 * reported as an overflow as value PARSE_TIME_OVER. Non-null values resulting
2393 * in an underflow are reported as an underflow as value PARSE_TIME_UNDER.
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002394 */
2395const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags)
2396{
Willy Tarreau9faebe32019-06-07 19:00:37 +02002397 unsigned long long imult, idiv;
2398 unsigned long long omult, odiv;
2399 unsigned long long value, result;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002400 const char *str = text;
2401
2402 if (!isdigit((unsigned char)*text))
2403 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002404
2405 omult = odiv = 1;
2406
2407 switch (unit_flags & TIME_UNIT_MASK) {
2408 case TIME_UNIT_US: omult = 1000000; break;
2409 case TIME_UNIT_MS: omult = 1000; break;
2410 case TIME_UNIT_S: break;
2411 case TIME_UNIT_MIN: odiv = 60; break;
2412 case TIME_UNIT_HOUR: odiv = 3600; break;
2413 case TIME_UNIT_DAY: odiv = 86400; break;
2414 default: break;
2415 }
2416
2417 value = 0;
2418
2419 while (1) {
2420 unsigned int j;
2421
2422 j = *text - '0';
2423 if (j > 9)
2424 break;
2425 text++;
2426 value *= 10;
2427 value += j;
2428 }
2429
2430 imult = idiv = 1;
2431 switch (*text) {
2432 case '\0': /* no unit = default unit */
2433 imult = omult = idiv = odiv = 1;
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002434 goto end;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002435 case 's': /* second = unscaled unit */
2436 break;
2437 case 'u': /* microsecond : "us" */
2438 if (text[1] == 's') {
2439 idiv = 1000000;
2440 text++;
Thayne McCombsa6838052021-04-02 14:12:43 -06002441 break;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002442 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002443 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002444 case 'm': /* millisecond : "ms" or minute: "m" */
2445 if (text[1] == 's') {
2446 idiv = 1000;
2447 text++;
2448 } else
2449 imult = 60;
2450 break;
2451 case 'h': /* hour : "h" */
2452 imult = 3600;
2453 break;
2454 case 'd': /* day : "d" */
2455 imult = 86400;
2456 break;
2457 default:
2458 return text;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002459 }
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002460 if (*(++text) != '\0') {
2461 ha_warning("unexpected character '%c' after the timer value '%s', only "
2462 "(us=microseconds,ms=milliseconds,s=seconds,m=minutes,h=hours,d=days) are supported."
2463 " This will be reported as an error in next versions.\n", *text, str);
2464 }
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002465
Christopher Fauletc20ad0d2020-12-11 09:23:07 +01002466 end:
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002467 if (omult % idiv == 0) { omult /= idiv; idiv = 1; }
2468 if (idiv % omult == 0) { idiv /= omult; omult = 1; }
2469 if (imult % odiv == 0) { imult /= odiv; odiv = 1; }
2470 if (odiv % imult == 0) { odiv /= imult; imult = 1; }
2471
Willy Tarreau9faebe32019-06-07 19:00:37 +02002472 result = (value * (imult * omult) + (idiv * odiv - 1)) / (idiv * odiv);
2473 if (result >= 0x80000000)
2474 return PARSE_TIME_OVER;
2475 if (!result && value)
2476 return PARSE_TIME_UNDER;
2477 *ret = result;
Willy Tarreaua0d37b62007-12-02 22:00:35 +01002478 return NULL;
2479}
Willy Tarreau6911fa42007-03-04 18:06:08 +01002480
Emeric Brun39132b22010-01-04 14:57:24 +01002481/* this function converts the string starting at <text> to an unsigned int
2482 * stored in <ret>. If an error is detected, the pointer to the unexpected
Joseph Herlant32b83272018-11-15 11:58:28 -08002483 * character is returned. If the conversion is successful, NULL is returned.
Emeric Brun39132b22010-01-04 14:57:24 +01002484 */
2485const char *parse_size_err(const char *text, unsigned *ret) {
2486 unsigned value = 0;
2487
Christopher Faulet82635a02020-12-11 09:30:45 +01002488 if (!isdigit((unsigned char)*text))
2489 return text;
2490
Emeric Brun39132b22010-01-04 14:57:24 +01002491 while (1) {
2492 unsigned int j;
2493
2494 j = *text - '0';
2495 if (j > 9)
2496 break;
2497 if (value > ~0U / 10)
2498 return text;
2499 value *= 10;
2500 if (value > (value + j))
2501 return text;
2502 value += j;
2503 text++;
2504 }
2505
2506 switch (*text) {
2507 case '\0':
2508 break;
2509 case 'K':
2510 case 'k':
2511 if (value > ~0U >> 10)
2512 return text;
2513 value = value << 10;
2514 break;
2515 case 'M':
2516 case 'm':
2517 if (value > ~0U >> 20)
2518 return text;
2519 value = value << 20;
2520 break;
2521 case 'G':
2522 case 'g':
2523 if (value > ~0U >> 30)
2524 return text;
2525 value = value << 30;
2526 break;
2527 default:
2528 return text;
2529 }
2530
Godbach58048a22015-01-28 17:36:16 +08002531 if (*text != '\0' && *++text != '\0')
2532 return text;
2533
Emeric Brun39132b22010-01-04 14:57:24 +01002534 *ret = value;
2535 return NULL;
2536}
2537
Willy Tarreau126d4062013-12-03 17:50:47 +01002538/*
2539 * Parse binary string written in hexadecimal (source) and store the decoded
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002540 * result into binstr and set binstrlen to the length of binstr. Memory for
Willy Tarreau126d4062013-12-03 17:50:47 +01002541 * binstr is allocated by the function. In case of error, returns 0 with an
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002542 * error message in err. In success case, it returns the consumed length.
Willy Tarreau126d4062013-12-03 17:50:47 +01002543 */
2544int parse_binary(const char *source, char **binstr, int *binstrlen, char **err)
2545{
2546 int len;
2547 const char *p = source;
2548 int i,j;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002549 int alloc;
Willy Tarreau126d4062013-12-03 17:50:47 +01002550
2551 len = strlen(source);
2552 if (len % 2) {
2553 memprintf(err, "an even number of hex digit is expected");
2554 return 0;
2555 }
2556
2557 len = len >> 1;
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002558
Willy Tarreau126d4062013-12-03 17:50:47 +01002559 if (!*binstr) {
Tim Duesterhuse52b6e52020-09-12 20:26:43 +02002560 *binstr = calloc(len, sizeof(**binstr));
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002561 if (!*binstr) {
2562 memprintf(err, "out of memory while loading string pattern");
2563 return 0;
2564 }
2565 alloc = 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002566 }
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002567 else {
2568 if (*binstrlen < len) {
Joseph Herlant76dbe782018-11-15 12:01:22 -08002569 memprintf(err, "no space available in the buffer. expect %d, provides %d",
Thierry FOURNIER9645d422013-12-06 19:59:28 +01002570 len, *binstrlen);
2571 return 0;
2572 }
2573 alloc = 0;
2574 }
2575 *binstrlen = len;
Willy Tarreau126d4062013-12-03 17:50:47 +01002576
2577 i = j = 0;
2578 while (j < len) {
2579 if (!ishex(p[i++]))
2580 goto bad_input;
2581 if (!ishex(p[i++]))
2582 goto bad_input;
2583 (*binstr)[j++] = (hex2i(p[i-2]) << 4) + hex2i(p[i-1]);
2584 }
Thierry FOURNIERee330af2014-01-21 11:36:14 +01002585 return len << 1;
Willy Tarreau126d4062013-12-03 17:50:47 +01002586
2587bad_input:
2588 memprintf(err, "an hex digit is expected (found '%c')", p[i-1]);
Willy Tarreau61cfdf42021-02-20 10:46:51 +01002589 if (alloc)
2590 ha_free(binstr);
Willy Tarreau126d4062013-12-03 17:50:47 +01002591 return 0;
2592}
2593
Willy Tarreau946ba592009-05-10 15:41:18 +02002594/* copies at most <n> characters from <src> and always terminates with '\0' */
2595char *my_strndup(const char *src, int n)
2596{
2597 int len = 0;
2598 char *ret;
2599
2600 while (len < n && src[len])
2601 len++;
2602
Vincent Bernat3c2f2f22016-04-03 13:48:42 +02002603 ret = malloc(len + 1);
Willy Tarreau946ba592009-05-10 15:41:18 +02002604 if (!ret)
2605 return ret;
2606 memcpy(ret, src, len);
2607 ret[len] = '\0';
2608 return ret;
2609}
2610
Baptiste Assmannbb77c8e2013-10-06 23:24:13 +02002611/*
2612 * search needle in haystack
2613 * returns the pointer if found, returns NULL otherwise
2614 */
2615const void *my_memmem(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen)
2616{
2617 const void *c = NULL;
2618 unsigned char f;
2619
2620 if ((haystack == NULL) || (needle == NULL) || (haystacklen < needlelen))
2621 return NULL;
2622
2623 f = *(char *)needle;
2624 c = haystack;
2625 while ((c = memchr(c, f, haystacklen - (c - haystack))) != NULL) {
2626 if ((haystacklen - (c - haystack)) < needlelen)
2627 return NULL;
2628
2629 if (memcmp(c, needle, needlelen) == 0)
2630 return c;
2631 ++c;
2632 }
2633 return NULL;
2634}
2635
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002636/* get length of the initial segment consisting entirely of bytes in <accept> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002637size_t my_memspn(const void *str, size_t len, const void *accept, size_t acceptlen)
2638{
2639 size_t ret = 0;
2640
2641 while (ret < len && memchr(accept, *((int *)str), acceptlen)) {
2642 str++;
2643 ret++;
2644 }
2645 return ret;
2646}
2647
Ilya Shipitsinc02a23f2020-05-06 00:53:22 +05002648/* get length of the initial segment consisting entirely of bytes not in <rejcet> */
Christopher Faulet5eb96cb2020-04-15 10:23:01 +02002649size_t my_memcspn(const void *str, size_t len, const void *reject, size_t rejectlen)
2650{
2651 size_t ret = 0;
2652
2653 while (ret < len) {
2654 if(memchr(reject, *((int *)str), rejectlen))
2655 return ret;
2656 str++;
2657 ret++;
2658 }
2659 return ret;
2660}
2661
Willy Tarreau482b00d2009-10-04 22:48:42 +02002662/* This function returns the first unused key greater than or equal to <key> in
2663 * ID tree <root>. Zero is returned if no place is found.
2664 */
2665unsigned int get_next_id(struct eb_root *root, unsigned int key)
2666{
2667 struct eb32_node *used;
2668
2669 do {
2670 used = eb32_lookup_ge(root, key);
2671 if (!used || used->key > key)
2672 return key; /* key is available */
2673 key++;
2674 } while (key);
2675 return key;
2676}
2677
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002678/* dump the full tree to <file> in DOT format for debugging purposes. Will
2679 * optionally highlight node <subj> if found, depending on operation <op> :
2680 * 0 : nothing
2681 * >0 : insertion, node/leaf are surrounded in red
2682 * <0 : removal, node/leaf are dashed with no background
2683 * Will optionally add "desc" as a label on the graph if set and non-null.
2684 */
2685void 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 +01002686{
2687 struct eb32sc_node *node;
2688 unsigned long scope = -1;
2689
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002690 fprintf(file, "digraph ebtree {\n");
2691
2692 if (desc && *desc) {
2693 fprintf(file,
2694 " fontname=\"fixed\";\n"
2695 " fontsize=8;\n"
2696 " label=\"%s\";\n", desc);
2697 }
2698
Willy Tarreaued3cda02017-11-15 15:04:05 +01002699 fprintf(file,
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002700 " node [fontname=\"fixed\" fontsize=8 shape=\"box\" style=\"filled\" color=\"black\" fillcolor=\"white\"];\n"
2701 " edge [fontname=\"fixed\" fontsize=8 style=\"solid\" color=\"magenta\" dir=\"forward\"];\n"
Willy Tarreaued3cda02017-11-15 15:04:05 +01002702 " \"%lx_n\" [label=\"root\\n%lx\"]\n", (long)eb_root_to_node(root), (long)root
2703 );
2704
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002705 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002706 (long)eb_root_to_node(root),
2707 (long)eb_root_to_node(eb_clrtag(root->b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002708 eb_gettag(root->b[0]) == EB_LEAF ? 'l' : 'n');
2709
2710 node = eb32sc_first(root, scope);
2711 while (node) {
2712 if (node->node.node_p) {
2713 /* node part is used */
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002714 fprintf(file, " \"%lx_n\" [label=\"%lx\\nkey=%u\\nscope=%lx\\nbit=%d\" fillcolor=\"lightskyblue1\" %s];\n",
2715 (long)node, (long)node, node->key, node->node_s, node->node.bit,
2716 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002717
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002718 fprintf(file, " \"%lx_n\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002719 (long)node,
2720 (long)eb_root_to_node(eb_clrtag(node->node.node_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002721 eb_gettag(node->node.node_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002722
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002723 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"L\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002724 (long)node,
2725 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[0])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002726 eb_gettag(node->node.branches.b[0]) == EB_LEAF ? 'l' : 'n');
2727
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002728 fprintf(file, " \"%lx_n\" -> \"%lx_%c\" [taillabel=\"R\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002729 (long)node,
2730 (long)eb_root_to_node(eb_clrtag(node->node.branches.b[1])),
Willy Tarreaued3cda02017-11-15 15:04:05 +01002731 eb_gettag(node->node.branches.b[1]) == EB_LEAF ? 'l' : 'n');
2732 }
2733
Willy Tarreau9c1e15d2017-11-15 18:51:29 +01002734 fprintf(file, " \"%lx_l\" [label=\"%lx\\nkey=%u\\nscope=%lx\\npfx=%u\" fillcolor=\"yellow\" %s];\n",
2735 (long)node, (long)node, node->key, node->leaf_s, node->node.pfx,
2736 (node == subj) ? (op < 0 ? "color=\"red\" style=\"dashed\"" : op > 0 ? "color=\"red\"" : "") : "");
Willy Tarreaued3cda02017-11-15 15:04:05 +01002737
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002738 fprintf(file, " \"%lx_l\" -> \"%lx_n\" [taillabel=\"%c\"];\n",
Willy Tarreaued3cda02017-11-15 15:04:05 +01002739 (long)node,
2740 (long)eb_root_to_node(eb_clrtag(node->node.leaf_p)),
Willy Tarreau6c7f4de2017-11-15 17:49:54 +01002741 eb_gettag(node->node.leaf_p) ? 'R' : 'L');
Willy Tarreaued3cda02017-11-15 15:04:05 +01002742 node = eb32sc_next(node, scope);
2743 }
2744 fprintf(file, "}\n");
2745}
2746
Willy Tarreau348238b2010-01-18 15:05:57 +01002747/* This function compares a sample word possibly followed by blanks to another
2748 * clean word. The compare is case-insensitive. 1 is returned if both are equal,
2749 * otherwise zero. This intends to be used when checking HTTP headers for some
2750 * values. Note that it validates a word followed only by blanks but does not
2751 * validate a word followed by blanks then other chars.
2752 */
2753int word_match(const char *sample, int slen, const char *word, int wlen)
2754{
2755 if (slen < wlen)
2756 return 0;
2757
2758 while (wlen) {
2759 char c = *sample ^ *word;
2760 if (c && c != ('A' ^ 'a'))
2761 return 0;
2762 sample++;
2763 word++;
2764 slen--;
2765 wlen--;
2766 }
2767
2768 while (slen) {
2769 if (*sample != ' ' && *sample != '\t')
2770 return 0;
2771 sample++;
2772 slen--;
2773 }
2774 return 1;
2775}
Willy Tarreau482b00d2009-10-04 22:48:42 +02002776
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002777/* Converts any text-formatted IPv4 address to a host-order IPv4 address. It
2778 * is particularly fast because it avoids expensive operations such as
2779 * multiplies, which are optimized away at the end. It requires a properly
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05002780 * formatted address though (3 points).
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002781 */
2782unsigned int inetaddr_host(const char *text)
2783{
2784 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2785 register unsigned int dig100, dig10, dig1;
2786 int s;
2787 const char *p, *d;
2788
2789 dig1 = dig10 = dig100 = ascii_zero;
2790 s = 24;
2791
2792 p = text;
2793 while (1) {
2794 if (((unsigned)(*p - '0')) <= 9) {
2795 p++;
2796 continue;
2797 }
2798
2799 /* here, we have a complete byte between <text> and <p> (exclusive) */
2800 if (p == text)
2801 goto end;
2802
2803 d = p - 1;
2804 dig1 |= (unsigned int)(*d << s);
2805 if (d == text)
2806 goto end;
2807
2808 d--;
2809 dig10 |= (unsigned int)(*d << s);
2810 if (d == text)
2811 goto end;
2812
2813 d--;
2814 dig100 |= (unsigned int)(*d << s);
2815 end:
2816 if (!s || *p != '.')
2817 break;
2818
2819 s -= 8;
2820 text = ++p;
2821 }
2822
2823 dig100 -= ascii_zero;
2824 dig10 -= ascii_zero;
2825 dig1 -= ascii_zero;
2826 return ((dig100 * 10) + dig10) * 10 + dig1;
2827}
2828
2829/*
2830 * Idem except the first unparsed character has to be passed in <stop>.
2831 */
2832unsigned int inetaddr_host_lim(const char *text, const char *stop)
2833{
2834 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2835 register unsigned int dig100, dig10, dig1;
2836 int s;
2837 const char *p, *d;
2838
2839 dig1 = dig10 = dig100 = ascii_zero;
2840 s = 24;
2841
2842 p = text;
2843 while (1) {
2844 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2845 p++;
2846 continue;
2847 }
2848
2849 /* here, we have a complete byte between <text> and <p> (exclusive) */
2850 if (p == text)
2851 goto end;
2852
2853 d = p - 1;
2854 dig1 |= (unsigned int)(*d << s);
2855 if (d == text)
2856 goto end;
2857
2858 d--;
2859 dig10 |= (unsigned int)(*d << s);
2860 if (d == text)
2861 goto end;
2862
2863 d--;
2864 dig100 |= (unsigned int)(*d << s);
2865 end:
2866 if (!s || p == stop || *p != '.')
2867 break;
2868
2869 s -= 8;
2870 text = ++p;
2871 }
2872
2873 dig100 -= ascii_zero;
2874 dig10 -= ascii_zero;
2875 dig1 -= ascii_zero;
2876 return ((dig100 * 10) + dig10) * 10 + dig1;
2877}
2878
2879/*
2880 * Idem except the pointer to first unparsed byte is returned into <ret> which
2881 * must not be NULL.
2882 */
Willy Tarreau74172752010-10-15 23:21:42 +02002883unsigned int inetaddr_host_lim_ret(char *text, char *stop, char **ret)
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002884{
2885 const unsigned int ascii_zero = ('0' << 24) | ('0' << 16) | ('0' << 8) | '0';
2886 register unsigned int dig100, dig10, dig1;
2887 int s;
Willy Tarreau74172752010-10-15 23:21:42 +02002888 char *p, *d;
Willy Tarreaud54bbdc2009-09-07 11:00:31 +02002889
2890 dig1 = dig10 = dig100 = ascii_zero;
2891 s = 24;
2892
2893 p = text;
2894 while (1) {
2895 if (((unsigned)(*p - '0')) <= 9 && p < stop) {
2896 p++;
2897 continue;
2898 }
2899
2900 /* here, we have a complete byte between <text> and <p> (exclusive) */
2901 if (p == text)
2902 goto end;
2903
2904 d = p - 1;
2905 dig1 |= (unsigned int)(*d << s);
2906 if (d == text)
2907 goto end;
2908
2909 d--;
2910 dig10 |= (unsigned int)(*d << s);
2911 if (d == text)
2912 goto end;
2913
2914 d--;
2915 dig100 |= (unsigned int)(*d << s);
2916 end:
2917 if (!s || p == stop || *p != '.')
2918 break;
2919
2920 s -= 8;
2921 text = ++p;
2922 }
2923
2924 *ret = p;
2925 dig100 -= ascii_zero;
2926 dig10 -= ascii_zero;
2927 dig1 -= ascii_zero;
2928 return ((dig100 * 10) + dig10) * 10 + dig1;
2929}
2930
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002931/* Convert a fixed-length string to an IP address. Returns 0 in case of error,
2932 * or the number of chars read in case of success. Maybe this could be replaced
2933 * by one of the functions above. Also, apparently this function does not support
2934 * hosts above 255 and requires exactly 4 octets.
Willy Tarreau075415a2013-12-12 11:29:39 +01002935 * The destination is only modified on success.
Willy Tarreauf0b38bf2010-06-06 13:22:23 +02002936 */
2937int buf2ip(const char *buf, size_t len, struct in_addr *dst)
2938{
2939 const char *addr;
2940 int saw_digit, octets, ch;
2941 u_char tmp[4], *tp;
2942 const char *cp = buf;
2943
2944 saw_digit = 0;
2945 octets = 0;
2946 *(tp = tmp) = 0;
2947
2948 for (addr = buf; addr - buf < len; addr++) {
2949 unsigned char digit = (ch = *addr) - '0';
2950
2951 if (digit > 9 && ch != '.')
2952 break;
2953
2954 if (digit <= 9) {
2955 u_int new = *tp * 10 + digit;
2956
2957 if (new > 255)
2958 return 0;
2959
2960 *tp = new;
2961
2962 if (!saw_digit) {
2963 if (++octets > 4)
2964 return 0;
2965 saw_digit = 1;
2966 }
2967 } else if (ch == '.' && saw_digit) {
2968 if (octets == 4)
2969 return 0;
2970
2971 *++tp = 0;
2972 saw_digit = 0;
2973 } else
2974 return 0;
2975 }
2976
2977 if (octets < 4)
2978 return 0;
2979
2980 memcpy(&dst->s_addr, tmp, 4);
2981 return addr - cp;
2982}
2983
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002984/* This function converts the string in <buf> of the len <len> to
2985 * struct in6_addr <dst> which must be allocated by the caller.
2986 * This function returns 1 in success case, otherwise zero.
Willy Tarreau075415a2013-12-12 11:29:39 +01002987 * The destination is only modified on success.
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002988 */
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002989int buf2ip6(const char *buf, size_t len, struct in6_addr *dst)
2990{
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002991 char null_term_ip6[INET6_ADDRSTRLEN + 1];
Willy Tarreau075415a2013-12-12 11:29:39 +01002992 struct in6_addr out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002993
Thierry FOURNIERcd659912013-12-11 12:33:54 +01002994 if (len > INET6_ADDRSTRLEN)
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01002995 return 0;
2996
2997 memcpy(null_term_ip6, buf, len);
2998 null_term_ip6[len] = '\0';
2999
Willy Tarreau075415a2013-12-12 11:29:39 +01003000 if (!inet_pton(AF_INET6, null_term_ip6, &out))
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003001 return 0;
3002
Willy Tarreau075415a2013-12-12 11:29:39 +01003003 *dst = out;
Thierry FOURNIERd559dd82013-11-22 16:16:59 +01003004 return 1;
3005}
3006
Willy Tarreauacf95772010-06-14 19:09:21 +02003007/* To be used to quote config arg positions. Returns the short string at <ptr>
3008 * surrounded by simple quotes if <ptr> is valid and non-empty, or "end of line"
3009 * if ptr is NULL or empty. The string is locally allocated.
3010 */
3011const char *quote_arg(const char *ptr)
3012{
Christopher Faulet1bc04c72017-10-29 20:14:08 +01003013 static THREAD_LOCAL char val[32];
Willy Tarreauacf95772010-06-14 19:09:21 +02003014 int i;
3015
3016 if (!ptr || !*ptr)
3017 return "end of line";
3018 val[0] = '\'';
Willy Tarreaude2dd6b2013-01-24 02:14:42 +01003019 for (i = 1; i < sizeof(val) - 2 && *ptr; i++)
Willy Tarreauacf95772010-06-14 19:09:21 +02003020 val[i] = *ptr++;
3021 val[i++] = '\'';
3022 val[i] = '\0';
3023 return val;
3024}
3025
Willy Tarreau5b180202010-07-18 10:40:48 +02003026/* returns an operator among STD_OP_* for string <str> or < 0 if unknown */
3027int get_std_op(const char *str)
3028{
3029 int ret = -1;
3030
3031 if (*str == 'e' && str[1] == 'q')
3032 ret = STD_OP_EQ;
3033 else if (*str == 'n' && str[1] == 'e')
3034 ret = STD_OP_NE;
3035 else if (*str == 'l') {
3036 if (str[1] == 'e') ret = STD_OP_LE;
3037 else if (str[1] == 't') ret = STD_OP_LT;
3038 }
3039 else if (*str == 'g') {
3040 if (str[1] == 'e') ret = STD_OP_GE;
3041 else if (str[1] == 't') ret = STD_OP_GT;
3042 }
3043
3044 if (ret == -1 || str[2] != '\0')
3045 return -1;
3046 return ret;
3047}
3048
Willy Tarreau4c14eaa2010-11-24 14:01:45 +01003049/* hash a 32-bit integer to another 32-bit integer */
3050unsigned int full_hash(unsigned int a)
3051{
3052 return __full_hash(a);
3053}
3054
Willy Tarreauf3241112019-02-26 09:56:22 +01003055/* Return the bit position in mask <m> of the nth bit set of rank <r>, between
3056 * 0 and LONGBITS-1 included, starting from the left. For example ranks 0,1,2,3
3057 * for mask 0x55 will be 6, 4, 2 and 0 respectively. This algorithm is based on
3058 * a popcount variant and is described here :
3059 * https://graphics.stanford.edu/~seander/bithacks.html
3060 */
3061unsigned int mask_find_rank_bit(unsigned int r, unsigned long m)
3062{
3063 unsigned long a, b, c, d;
3064 unsigned int s;
3065 unsigned int t;
3066
3067 a = m - ((m >> 1) & ~0UL/3);
3068 b = (a & ~0UL/5) + ((a >> 2) & ~0UL/5);
3069 c = (b + (b >> 4)) & ~0UL/0x11;
3070 d = (c + (c >> 8)) & ~0UL/0x101;
3071
3072 r++; // make r be 1..64
3073
3074 t = 0;
3075 s = LONGBITS;
3076 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01003077 unsigned long d2 = (d >> 16) >> 16;
3078 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01003079 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
3080 }
3081
3082 t = (d >> (s - 16)) & 0xff;
3083 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
3084 t = (c >> (s - 8)) & 0xf;
3085 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
3086 t = (b >> (s - 4)) & 0x7;
3087 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
3088 t = (a >> (s - 2)) & 0x3;
3089 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
3090 t = (m >> (s - 1)) & 0x1;
3091 s -= ((t - r) & 256) >> 8;
3092
3093 return s - 1;
3094}
3095
3096/* Same as mask_find_rank_bit() above but makes use of pre-computed bitmaps
3097 * based on <m>, in <a..d>. These ones must be updated whenever <m> changes
3098 * using mask_prep_rank_map() below.
3099 */
3100unsigned int mask_find_rank_bit_fast(unsigned int r, unsigned long m,
3101 unsigned long a, unsigned long b,
3102 unsigned long c, unsigned long d)
3103{
3104 unsigned int s;
3105 unsigned int t;
3106
3107 r++; // make r be 1..64
3108
3109 t = 0;
3110 s = LONGBITS;
3111 if (s > 32) {
Willy Tarreau9b6be3b2019-03-18 16:31:18 +01003112 unsigned long d2 = (d >> 16) >> 16;
3113 t = d2 + (d2 >> 16);
Willy Tarreauf3241112019-02-26 09:56:22 +01003114 s -= ((t - r) & 256) >> 3; r -= (t & ((t - r) >> 8));
3115 }
3116
3117 t = (d >> (s - 16)) & 0xff;
3118 s -= ((t - r) & 256) >> 4; r -= (t & ((t - r) >> 8));
3119 t = (c >> (s - 8)) & 0xf;
3120 s -= ((t - r) & 256) >> 5; r -= (t & ((t - r) >> 8));
3121 t = (b >> (s - 4)) & 0x7;
3122 s -= ((t - r) & 256) >> 6; r -= (t & ((t - r) >> 8));
3123 t = (a >> (s - 2)) & 0x3;
3124 s -= ((t - r) & 256) >> 7; r -= (t & ((t - r) >> 8));
3125 t = (m >> (s - 1)) & 0x1;
3126 s -= ((t - r) & 256) >> 8;
3127
3128 return s - 1;
3129}
3130
3131/* Prepare the bitmaps used by the fast implementation of the find_rank_bit()
3132 * above.
3133 */
3134void mask_prep_rank_map(unsigned long m,
3135 unsigned long *a, unsigned long *b,
3136 unsigned long *c, unsigned long *d)
3137{
3138 *a = m - ((m >> 1) & ~0UL/3);
3139 *b = (*a & ~0UL/5) + ((*a >> 2) & ~0UL/5);
3140 *c = (*b + (*b >> 4)) & ~0UL/0x11;
3141 *d = (*c + (*c >> 8)) & ~0UL/0x101;
3142}
3143
David du Colombier4f92d322011-03-24 11:09:31 +01003144/* Return non-zero if IPv4 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003145 * otherwise zero. Note that <addr> may not necessarily be aligned
3146 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003147 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003148int in_net_ipv4(const void *addr, const struct in_addr *mask, const struct in_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003149{
Willy Tarreaueec1d382016-07-13 11:59:39 +02003150 struct in_addr addr_copy;
3151
3152 memcpy(&addr_copy, addr, sizeof(addr_copy));
3153 return((addr_copy.s_addr & mask->s_addr) == (net->s_addr & mask->s_addr));
David du Colombier4f92d322011-03-24 11:09:31 +01003154}
3155
3156/* Return non-zero if IPv6 address is part of the network,
Willy Tarreaueec1d382016-07-13 11:59:39 +02003157 * otherwise zero. Note that <addr> may not necessarily be aligned
3158 * while the two other ones must.
David du Colombier4f92d322011-03-24 11:09:31 +01003159 */
Willy Tarreaueec1d382016-07-13 11:59:39 +02003160int in_net_ipv6(const void *addr, const struct in6_addr *mask, const struct in6_addr *net)
David du Colombier4f92d322011-03-24 11:09:31 +01003161{
3162 int i;
Willy Tarreaueec1d382016-07-13 11:59:39 +02003163 struct in6_addr addr_copy;
David du Colombier4f92d322011-03-24 11:09:31 +01003164
Willy Tarreaueec1d382016-07-13 11:59:39 +02003165 memcpy(&addr_copy, addr, sizeof(addr_copy));
David du Colombier4f92d322011-03-24 11:09:31 +01003166 for (i = 0; i < sizeof(struct in6_addr) / sizeof(int); i++)
Willy Tarreaueec1d382016-07-13 11:59:39 +02003167 if (((((int *)&addr_copy)[i] & ((int *)mask)[i])) !=
David du Colombier4f92d322011-03-24 11:09:31 +01003168 (((int *)net)[i] & ((int *)mask)[i]))
3169 return 0;
3170 return 1;
3171}
3172
3173/* RFC 4291 prefix */
3174const char rfc4291_pfx[] = { 0x00, 0x00, 0x00, 0x00,
3175 0x00, 0x00, 0x00, 0x00,
3176 0x00, 0x00, 0xFF, 0xFF };
3177
Joseph Herlant32b83272018-11-15 11:58:28 -08003178/* Map IPv4 address on IPv6 address, as specified in RFC 3513.
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003179 * Input and output may overlap.
3180 */
David du Colombier4f92d322011-03-24 11:09:31 +01003181void v4tov6(struct in6_addr *sin6_addr, struct in_addr *sin_addr)
3182{
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003183 struct in_addr tmp_addr;
3184
3185 tmp_addr.s_addr = sin_addr->s_addr;
David du Colombier4f92d322011-03-24 11:09:31 +01003186 memcpy(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx));
Thierry FOURNIER4a04dc32013-11-28 16:33:15 +01003187 memcpy(sin6_addr->s6_addr+12, &tmp_addr.s_addr, 4);
David du Colombier4f92d322011-03-24 11:09:31 +01003188}
3189
Joseph Herlant32b83272018-11-15 11:58:28 -08003190/* Map IPv6 address on IPv4 address, as specified in RFC 3513.
David du Colombier4f92d322011-03-24 11:09:31 +01003191 * Return true if conversion is possible and false otherwise.
3192 */
3193int v6tov4(struct in_addr *sin_addr, struct in6_addr *sin6_addr)
3194{
3195 if (memcmp(sin6_addr->s6_addr, rfc4291_pfx, sizeof(rfc4291_pfx)) == 0) {
3196 memcpy(&(sin_addr->s_addr), &(sin6_addr->s6_addr[12]),
3197 sizeof(struct in_addr));
3198 return 1;
3199 }
3200
3201 return 0;
3202}
3203
Baptiste Assmann08b24cf2016-01-23 23:39:12 +01003204/* compare two struct sockaddr_storage and return:
3205 * 0 (true) if the addr is the same in both
3206 * 1 (false) if the addr is not the same in both
3207 * -1 (unable) if one of the addr is not AF_INET*
3208 */
3209int ipcmp(struct sockaddr_storage *ss1, struct sockaddr_storage *ss2)
3210{
3211 if ((ss1->ss_family != AF_INET) && (ss1->ss_family != AF_INET6))
3212 return -1;
3213
3214 if ((ss2->ss_family != AF_INET) && (ss2->ss_family != AF_INET6))
3215 return -1;
3216
3217 if (ss1->ss_family != ss2->ss_family)
3218 return 1;
3219
3220 switch (ss1->ss_family) {
3221 case AF_INET:
3222 return memcmp(&((struct sockaddr_in *)ss1)->sin_addr,
3223 &((struct sockaddr_in *)ss2)->sin_addr,
3224 sizeof(struct in_addr)) != 0;
3225 case AF_INET6:
3226 return memcmp(&((struct sockaddr_in6 *)ss1)->sin6_addr,
3227 &((struct sockaddr_in6 *)ss2)->sin6_addr,
3228 sizeof(struct in6_addr)) != 0;
3229 }
3230
3231 return 1;
3232}
3233
Christopher Faulet9553de72021-02-26 09:12:50 +01003234/* compare a struct sockaddr_storage to a struct net_addr and return :
3235 * 0 (true) if <addr> is matching <net>
3236 * 1 (false) if <addr> is not matching <net>
3237 * -1 (unable) if <addr> or <net> is not AF_INET*
3238 */
3239int ipcmp2net(const struct sockaddr_storage *addr, const struct net_addr *net)
3240{
3241 if ((addr->ss_family != AF_INET) && (addr->ss_family != AF_INET6))
3242 return -1;
3243
3244 if ((net->family != AF_INET) && (net->family != AF_INET6))
3245 return -1;
3246
3247 if (addr->ss_family != net->family)
3248 return 1;
3249
3250 if (addr->ss_family == AF_INET &&
3251 (((struct sockaddr_in *)addr)->sin_addr.s_addr & net->addr.v4.mask.s_addr) == net->addr.v4.ip.s_addr)
3252 return 0;
3253 else {
3254 const struct in6_addr *addr6 = &(((const struct sockaddr_in6*)addr)->sin6_addr);
3255 const struct in6_addr *nip6 = &net->addr.v6.ip;
3256 const struct in6_addr *nmask6 = &net->addr.v6.mask;
3257
3258 if ((read_u32(&addr6->s6_addr[0]) & read_u32(&nmask6->s6_addr[0])) == read_u32(&nip6->s6_addr[0]) &&
3259 (read_u32(&addr6->s6_addr[4]) & read_u32(&nmask6->s6_addr[4])) == read_u32(&nip6->s6_addr[4]) &&
3260 (read_u32(&addr6->s6_addr[8]) & read_u32(&nmask6->s6_addr[8])) == read_u32(&nip6->s6_addr[8]) &&
3261 (read_u32(&addr6->s6_addr[12]) & read_u32(&nmask6->s6_addr[12])) == read_u32(&nip6->s6_addr[12]))
3262 return 0;
3263 }
3264
3265 return 1;
3266}
3267
Baptiste Assmann08396c82016-01-31 00:27:17 +01003268/* copy IP address from <source> into <dest>
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003269 * The caller must allocate and clear <dest> before calling.
3270 * The source must be in either AF_INET or AF_INET6 family, or the destination
3271 * address will be undefined. If the destination address used to hold a port,
3272 * it is preserved, so that this function can be used to switch to another
3273 * address family with no risk. Returns a pointer to the destination.
Baptiste Assmann08396c82016-01-31 00:27:17 +01003274 */
3275struct sockaddr_storage *ipcpy(struct sockaddr_storage *source, struct sockaddr_storage *dest)
3276{
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003277 int prev_port;
3278
3279 prev_port = get_net_port(dest);
3280 memset(dest, 0, sizeof(*dest));
Baptiste Assmann08396c82016-01-31 00:27:17 +01003281 dest->ss_family = source->ss_family;
3282
3283 /* copy new addr and apply it */
3284 switch (source->ss_family) {
3285 case AF_INET:
3286 ((struct sockaddr_in *)dest)->sin_addr.s_addr = ((struct sockaddr_in *)source)->sin_addr.s_addr;
Willy Tarreaudc3a9e82016-11-04 18:47:01 +01003287 ((struct sockaddr_in *)dest)->sin_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003288 break;
3289 case AF_INET6:
3290 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 +01003291 ((struct sockaddr_in6 *)dest)->sin6_port = prev_port;
Baptiste Assmann08396c82016-01-31 00:27:17 +01003292 break;
3293 }
3294
3295 return dest;
3296}
3297
William Lallemand421f5b52012-02-06 18:15:57 +01003298char *human_time(int t, short hz_div) {
3299 static char rv[sizeof("24855d23h")+1]; // longest of "23h59m" and "59m59s"
3300 char *p = rv;
Willy Tarreau761b3d52014-04-14 14:53:06 +02003301 char *end = rv + sizeof(rv);
William Lallemand421f5b52012-02-06 18:15:57 +01003302 int cnt=2; // print two numbers
3303
3304 if (unlikely(t < 0 || hz_div <= 0)) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003305 snprintf(p, end - p, "?");
William Lallemand421f5b52012-02-06 18:15:57 +01003306 return rv;
3307 }
3308
3309 if (unlikely(hz_div > 1))
3310 t /= hz_div;
3311
3312 if (t >= DAY) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003313 p += snprintf(p, end - p, "%dd", t / DAY);
William Lallemand421f5b52012-02-06 18:15:57 +01003314 cnt--;
3315 }
3316
3317 if (cnt && t % DAY / HOUR) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003318 p += snprintf(p, end - p, "%dh", t % DAY / HOUR);
William Lallemand421f5b52012-02-06 18:15:57 +01003319 cnt--;
3320 }
3321
3322 if (cnt && t % HOUR / MINUTE) {
Willy Tarreau761b3d52014-04-14 14:53:06 +02003323 p += snprintf(p, end - p, "%dm", t % HOUR / MINUTE);
William Lallemand421f5b52012-02-06 18:15:57 +01003324 cnt--;
3325 }
3326
3327 if ((cnt && t % MINUTE) || !t) // also display '0s'
Willy Tarreau761b3d52014-04-14 14:53:06 +02003328 p += snprintf(p, end - p, "%ds", t % MINUTE / SEC);
William Lallemand421f5b52012-02-06 18:15:57 +01003329
3330 return rv;
3331}
3332
3333const char *monthname[12] = {
3334 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
3335 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
3336};
3337
3338/* date2str_log: write a date in the format :
3339 * sprintf(str, "%02d/%s/%04d:%02d:%02d:%02d.%03d",
3340 * tm.tm_mday, monthname[tm.tm_mon], tm.tm_year+1900,
3341 * tm.tm_hour, tm.tm_min, tm.tm_sec, (int)date.tv_usec/1000);
3342 *
3343 * without using sprintf. return a pointer to the last char written (\0) or
3344 * NULL if there isn't enough space.
3345 */
Willy Tarreauf16cb412018-09-04 19:08:48 +02003346char *date2str_log(char *dst, const struct tm *tm, const struct timeval *date, size_t size)
William Lallemand421f5b52012-02-06 18:15:57 +01003347{
3348
3349 if (size < 25) /* the size is fixed: 24 chars + \0 */
3350 return NULL;
3351
3352 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003353 if (!dst)
3354 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003355 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003356
William Lallemand421f5b52012-02-06 18:15:57 +01003357 memcpy(dst, monthname[tm->tm_mon], 3); // month
3358 dst += 3;
3359 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003360
William Lallemand421f5b52012-02-06 18:15:57 +01003361 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003362 if (!dst)
3363 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003364 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003365
William Lallemand421f5b52012-02-06 18:15:57 +01003366 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003367 if (!dst)
3368 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003369 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003370
William Lallemand421f5b52012-02-06 18:15:57 +01003371 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003372 if (!dst)
3373 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003374 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003375
William Lallemand421f5b52012-02-06 18:15:57 +01003376 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003377 if (!dst)
3378 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003379 *dst++ = '.';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003380
Willy Tarreau7d9421d2020-02-29 09:08:02 +01003381 dst = utoa_pad((unsigned int)(date->tv_usec/1000)%1000, dst, 4); // milliseconds
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003382 if (!dst)
3383 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003384 *dst = '\0';
3385
3386 return dst;
3387}
3388
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003389/* Base year used to compute leap years */
3390#define TM_YEAR_BASE 1900
3391
3392/* Return the difference in seconds between two times (leap seconds are ignored).
3393 * Retrieved from glibc 2.18 source code.
3394 */
3395static int my_tm_diff(const struct tm *a, const struct tm *b)
3396{
3397 /* Compute intervening leap days correctly even if year is negative.
3398 * Take care to avoid int overflow in leap day calculations,
3399 * but it's OK to assume that A and B are close to each other.
3400 */
3401 int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
3402 int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
3403 int a100 = a4 / 25 - (a4 % 25 < 0);
3404 int b100 = b4 / 25 - (b4 % 25 < 0);
3405 int a400 = a100 >> 2;
3406 int b400 = b100 >> 2;
3407 int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
3408 int years = a->tm_year - b->tm_year;
3409 int days = (365 * years + intervening_leap_days
3410 + (a->tm_yday - b->tm_yday));
3411 return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
3412 + (a->tm_min - b->tm_min))
3413 + (a->tm_sec - b->tm_sec));
3414}
3415
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003416/* Return the GMT offset for a specific local time.
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003417 * Both t and tm must represent the same time.
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003418 * The string returned has the same format as returned by strftime(... "%z", tm).
3419 * Offsets are kept in an internal cache for better performances.
3420 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003421const char *get_gmt_offset(time_t t, struct tm *tm)
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003422{
3423 /* Cache offsets from GMT (depending on whether DST is active or not) */
Christopher Faulet1bc04c72017-10-29 20:14:08 +01003424 static THREAD_LOCAL char gmt_offsets[2][5+1] = { "", "" };
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003425
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003426 char *gmt_offset;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003427 struct tm tm_gmt;
3428 int diff;
3429 int isdst = tm->tm_isdst;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003430
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003431 /* Pretend DST not active if its status is unknown */
3432 if (isdst < 0)
3433 isdst = 0;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003434
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003435 /* Fetch the offset and initialize it if needed */
3436 gmt_offset = gmt_offsets[isdst & 0x01];
3437 if (unlikely(!*gmt_offset)) {
3438 get_gmtime(t, &tm_gmt);
3439 diff = my_tm_diff(tm, &tm_gmt);
3440 if (diff < 0) {
3441 diff = -diff;
3442 *gmt_offset = '-';
3443 } else {
3444 *gmt_offset = '+';
3445 }
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003446 diff %= 86400U;
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003447 diff /= 60; /* Convert to minutes */
3448 snprintf(gmt_offset+1, 4+1, "%02d%02d", diff/60, diff%60);
3449 }
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003450
Willy Tarreaue112c8a2019-10-29 10:16:11 +01003451 return gmt_offset;
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003452}
3453
William Lallemand421f5b52012-02-06 18:15:57 +01003454/* gmt2str_log: write a date in the format :
3455 * "%02d/%s/%04d:%02d:%02d:%02d +0000" without using snprintf
3456 * return a pointer to the last char written (\0) or
3457 * NULL if there isn't enough space.
3458 */
3459char *gmt2str_log(char *dst, struct tm *tm, size_t size)
3460{
Yuxans Yao4e25b012012-10-19 10:36:09 +08003461 if (size < 27) /* the size is fixed: 26 chars + \0 */
William Lallemand421f5b52012-02-06 18:15:57 +01003462 return NULL;
3463
3464 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003465 if (!dst)
3466 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003467 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003468
William Lallemand421f5b52012-02-06 18:15:57 +01003469 memcpy(dst, monthname[tm->tm_mon], 3); // month
3470 dst += 3;
3471 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003472
William Lallemand421f5b52012-02-06 18:15:57 +01003473 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003474 if (!dst)
3475 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003476 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003477
William Lallemand421f5b52012-02-06 18:15:57 +01003478 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003479 if (!dst)
3480 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003481 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003482
William Lallemand421f5b52012-02-06 18:15:57 +01003483 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003484 if (!dst)
3485 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003486 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003487
William Lallemand421f5b52012-02-06 18:15:57 +01003488 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003489 if (!dst)
3490 return NULL;
William Lallemand421f5b52012-02-06 18:15:57 +01003491 *dst++ = ' ';
3492 *dst++ = '+';
3493 *dst++ = '0';
3494 *dst++ = '0';
3495 *dst++ = '0';
3496 *dst++ = '0';
3497 *dst = '\0';
3498
3499 return dst;
3500}
3501
Yuxans Yao4e25b012012-10-19 10:36:09 +08003502/* localdate2str_log: write a date in the format :
3503 * "%02d/%s/%04d:%02d:%02d:%02d +0000(local timezone)" without using snprintf
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003504 * Both t and tm must represent the same time.
3505 * return a pointer to the last char written (\0) or
3506 * NULL if there isn't enough space.
Yuxans Yao4e25b012012-10-19 10:36:09 +08003507 */
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003508char *localdate2str_log(char *dst, time_t t, struct tm *tm, size_t size)
Yuxans Yao4e25b012012-10-19 10:36:09 +08003509{
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003510 const char *gmt_offset;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003511 if (size < 27) /* the size is fixed: 26 chars + \0 */
3512 return NULL;
3513
Benoit GARNIERe2e5bde2016-03-27 03:04:16 +02003514 gmt_offset = get_gmt_offset(t, tm);
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003515
Yuxans Yao4e25b012012-10-19 10:36:09 +08003516 dst = utoa_pad((unsigned int)tm->tm_mday, dst, 3); // day
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003517 if (!dst)
3518 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003519 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003520
Yuxans Yao4e25b012012-10-19 10:36:09 +08003521 memcpy(dst, monthname[tm->tm_mon], 3); // month
3522 dst += 3;
3523 *dst++ = '/';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003524
Yuxans Yao4e25b012012-10-19 10:36:09 +08003525 dst = utoa_pad((unsigned int)tm->tm_year+1900, dst, 5); // year
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003526 if (!dst)
3527 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003528 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003529
Yuxans Yao4e25b012012-10-19 10:36:09 +08003530 dst = utoa_pad((unsigned int)tm->tm_hour, dst, 3); // hour
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003531 if (!dst)
3532 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003533 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003534
Yuxans Yao4e25b012012-10-19 10:36:09 +08003535 dst = utoa_pad((unsigned int)tm->tm_min, dst, 3); // minutes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003536 if (!dst)
3537 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003538 *dst++ = ':';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003539
Yuxans Yao4e25b012012-10-19 10:36:09 +08003540 dst = utoa_pad((unsigned int)tm->tm_sec, dst, 3); // secondes
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003541 if (!dst)
3542 return NULL;
Yuxans Yao4e25b012012-10-19 10:36:09 +08003543 *dst++ = ' ';
Willy Tarreau4eee38a2019-02-12 11:26:29 +01003544
Benoit GARNIERb413c2a2016-03-27 11:08:03 +02003545 memcpy(dst, gmt_offset, 5); // Offset from local time to GMT
Yuxans Yao4e25b012012-10-19 10:36:09 +08003546 dst += 5;
3547 *dst = '\0';
3548
3549 return dst;
3550}
3551
Willy Tarreaucb1949b2017-07-19 19:05:29 +02003552/* Returns the number of seconds since 01/01/1970 0:0:0 GMT for GMT date <tm>.
3553 * It is meant as a portable replacement for timegm() for use with valid inputs.
3554 * Returns undefined results for invalid dates (eg: months out of range 0..11).
3555 */
3556time_t my_timegm(const struct tm *tm)
3557{
3558 /* Each month has 28, 29, 30 or 31 days, or 28+N. The date in the year
3559 * is thus (current month - 1)*28 + cumulated_N[month] to count the
3560 * sum of the extra N days for elapsed months. The sum of all these N
3561 * days doesn't exceed 30 for a complete year (366-12*28) so it fits
3562 * in a 5-bit word. This means that with 60 bits we can represent a
3563 * matrix of all these values at once, which is fast and efficient to
3564 * access. The extra February day for leap years is not counted here.
3565 *
3566 * Jan : none = 0 (0)
3567 * Feb : Jan = 3 (3)
3568 * Mar : Jan..Feb = 3 (3 + 0)
3569 * Apr : Jan..Mar = 6 (3 + 0 + 3)
3570 * May : Jan..Apr = 8 (3 + 0 + 3 + 2)
3571 * Jun : Jan..May = 11 (3 + 0 + 3 + 2 + 3)
3572 * Jul : Jan..Jun = 13 (3 + 0 + 3 + 2 + 3 + 2)
3573 * Aug : Jan..Jul = 16 (3 + 0 + 3 + 2 + 3 + 2 + 3)
3574 * Sep : Jan..Aug = 19 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3)
3575 * Oct : Jan..Sep = 21 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2)
3576 * Nov : Jan..Oct = 24 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3)
3577 * Dec : Jan..Nov = 26 (3 + 0 + 3 + 2 + 3 + 2 + 3 + 3 + 2 + 3 + 2)
3578 */
3579 uint64_t extra =
3580 ( 0ULL << 0*5) + ( 3ULL << 1*5) + ( 3ULL << 2*5) + /* Jan, Feb, Mar, */
3581 ( 6ULL << 3*5) + ( 8ULL << 4*5) + (11ULL << 5*5) + /* Apr, May, Jun, */
3582 (13ULL << 6*5) + (16ULL << 7*5) + (19ULL << 8*5) + /* Jul, Aug, Sep, */
3583 (21ULL << 9*5) + (24ULL << 10*5) + (26ULL << 11*5); /* Oct, Nov, Dec, */
3584
3585 unsigned int y = tm->tm_year + 1900;
3586 unsigned int m = tm->tm_mon;
3587 unsigned long days = 0;
3588
3589 /* days since 1/1/1970 for full years */
3590 days += days_since_zero(y) - days_since_zero(1970);
3591
3592 /* days for full months in the current year */
3593 days += 28 * m + ((extra >> (m * 5)) & 0x1f);
3594
3595 /* count + 1 after March for leap years. A leap year is a year multiple
3596 * of 4, unless it's multiple of 100 without being multiple of 400. 2000
3597 * is leap, 1900 isn't, 1904 is.
3598 */
3599 if ((m > 1) && !(y & 3) && ((y % 100) || !(y % 400)))
3600 days++;
3601
3602 days += tm->tm_mday - 1;
3603 return days * 86400ULL + tm->tm_hour * 3600 + tm->tm_min * 60 + tm->tm_sec;
3604}
3605
Thierry Fournier93127942016-01-20 18:49:45 +01003606/* This function check a char. It returns true and updates
3607 * <date> and <len> pointer to the new position if the
3608 * character is found.
3609 */
3610static inline int parse_expect_char(const char **date, int *len, char c)
3611{
3612 if (*len < 1 || **date != c)
3613 return 0;
3614 (*len)--;
3615 (*date)++;
3616 return 1;
3617}
3618
3619/* This function expects a string <str> of len <l>. It return true and updates.
3620 * <date> and <len> if the string matches, otherwise, it returns false.
3621 */
3622static inline int parse_strcmp(const char **date, int *len, char *str, int l)
3623{
3624 if (*len < l || strncmp(*date, str, l) != 0)
3625 return 0;
3626 (*len) -= l;
3627 (*date) += l;
3628 return 1;
3629}
3630
3631/* This macro converts 3 chars name in integer. */
3632#define STR2I3(__a, __b, __c) ((__a) * 65536 + (__b) * 256 + (__c))
3633
3634/* day-name = %x4D.6F.6E ; "Mon", case-sensitive
3635 * / %x54.75.65 ; "Tue", case-sensitive
3636 * / %x57.65.64 ; "Wed", case-sensitive
3637 * / %x54.68.75 ; "Thu", case-sensitive
3638 * / %x46.72.69 ; "Fri", case-sensitive
3639 * / %x53.61.74 ; "Sat", case-sensitive
3640 * / %x53.75.6E ; "Sun", case-sensitive
3641 *
3642 * This array must be alphabetically sorted
3643 */
3644static inline int parse_http_dayname(const char **date, int *len, struct tm *tm)
3645{
3646 if (*len < 3)
3647 return 0;
3648 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3649 case STR2I3('M','o','n'): tm->tm_wday = 1; break;
3650 case STR2I3('T','u','e'): tm->tm_wday = 2; break;
3651 case STR2I3('W','e','d'): tm->tm_wday = 3; break;
3652 case STR2I3('T','h','u'): tm->tm_wday = 4; break;
3653 case STR2I3('F','r','i'): tm->tm_wday = 5; break;
3654 case STR2I3('S','a','t'): tm->tm_wday = 6; break;
3655 case STR2I3('S','u','n'): tm->tm_wday = 7; break;
3656 default: return 0;
3657 }
3658 *len -= 3;
3659 *date += 3;
3660 return 1;
3661}
3662
3663/* month = %x4A.61.6E ; "Jan", case-sensitive
3664 * / %x46.65.62 ; "Feb", case-sensitive
3665 * / %x4D.61.72 ; "Mar", case-sensitive
3666 * / %x41.70.72 ; "Apr", case-sensitive
3667 * / %x4D.61.79 ; "May", case-sensitive
3668 * / %x4A.75.6E ; "Jun", case-sensitive
3669 * / %x4A.75.6C ; "Jul", case-sensitive
3670 * / %x41.75.67 ; "Aug", case-sensitive
3671 * / %x53.65.70 ; "Sep", case-sensitive
3672 * / %x4F.63.74 ; "Oct", case-sensitive
3673 * / %x4E.6F.76 ; "Nov", case-sensitive
3674 * / %x44.65.63 ; "Dec", case-sensitive
3675 *
3676 * This array must be alphabetically sorted
3677 */
3678static inline int parse_http_monthname(const char **date, int *len, struct tm *tm)
3679{
3680 if (*len < 3)
3681 return 0;
3682 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3683 case STR2I3('J','a','n'): tm->tm_mon = 0; break;
3684 case STR2I3('F','e','b'): tm->tm_mon = 1; break;
3685 case STR2I3('M','a','r'): tm->tm_mon = 2; break;
3686 case STR2I3('A','p','r'): tm->tm_mon = 3; break;
3687 case STR2I3('M','a','y'): tm->tm_mon = 4; break;
3688 case STR2I3('J','u','n'): tm->tm_mon = 5; break;
3689 case STR2I3('J','u','l'): tm->tm_mon = 6; break;
3690 case STR2I3('A','u','g'): tm->tm_mon = 7; break;
3691 case STR2I3('S','e','p'): tm->tm_mon = 8; break;
3692 case STR2I3('O','c','t'): tm->tm_mon = 9; break;
3693 case STR2I3('N','o','v'): tm->tm_mon = 10; break;
3694 case STR2I3('D','e','c'): tm->tm_mon = 11; break;
3695 default: return 0;
3696 }
3697 *len -= 3;
3698 *date += 3;
3699 return 1;
3700}
3701
3702/* day-name-l = %x4D.6F.6E.64.61.79 ; "Monday", case-sensitive
3703 * / %x54.75.65.73.64.61.79 ; "Tuesday", case-sensitive
3704 * / %x57.65.64.6E.65.73.64.61.79 ; "Wednesday", case-sensitive
3705 * / %x54.68.75.72.73.64.61.79 ; "Thursday", case-sensitive
3706 * / %x46.72.69.64.61.79 ; "Friday", case-sensitive
3707 * / %x53.61.74.75.72.64.61.79 ; "Saturday", case-sensitive
3708 * / %x53.75.6E.64.61.79 ; "Sunday", case-sensitive
3709 *
3710 * This array must be alphabetically sorted
3711 */
3712static inline int parse_http_ldayname(const char **date, int *len, struct tm *tm)
3713{
3714 if (*len < 6) /* Minimum length. */
3715 return 0;
3716 switch (STR2I3((*date)[0], (*date)[1], (*date)[2])) {
3717 case STR2I3('M','o','n'):
3718 RET0_UNLESS(parse_strcmp(date, len, "Monday", 6));
3719 tm->tm_wday = 1;
3720 return 1;
3721 case STR2I3('T','u','e'):
3722 RET0_UNLESS(parse_strcmp(date, len, "Tuesday", 7));
3723 tm->tm_wday = 2;
3724 return 1;
3725 case STR2I3('W','e','d'):
3726 RET0_UNLESS(parse_strcmp(date, len, "Wednesday", 9));
3727 tm->tm_wday = 3;
3728 return 1;
3729 case STR2I3('T','h','u'):
3730 RET0_UNLESS(parse_strcmp(date, len, "Thursday", 8));
3731 tm->tm_wday = 4;
3732 return 1;
3733 case STR2I3('F','r','i'):
3734 RET0_UNLESS(parse_strcmp(date, len, "Friday", 6));
3735 tm->tm_wday = 5;
3736 return 1;
3737 case STR2I3('S','a','t'):
3738 RET0_UNLESS(parse_strcmp(date, len, "Saturday", 8));
3739 tm->tm_wday = 6;
3740 return 1;
3741 case STR2I3('S','u','n'):
3742 RET0_UNLESS(parse_strcmp(date, len, "Sunday", 6));
3743 tm->tm_wday = 7;
3744 return 1;
3745 }
3746 return 0;
3747}
3748
3749/* This function parses exactly 1 digit and returns the numeric value in "digit". */
3750static inline int parse_digit(const char **date, int *len, int *digit)
3751{
3752 if (*len < 1 || **date < '0' || **date > '9')
3753 return 0;
3754 *digit = (**date - '0');
3755 (*date)++;
3756 (*len)--;
3757 return 1;
3758}
3759
3760/* This function parses exactly 2 digits and returns the numeric value in "digit". */
3761static inline int parse_2digit(const char **date, int *len, int *digit)
3762{
3763 int value;
3764
3765 RET0_UNLESS(parse_digit(date, len, &value));
3766 (*digit) = value * 10;
3767 RET0_UNLESS(parse_digit(date, len, &value));
3768 (*digit) += value;
3769
3770 return 1;
3771}
3772
3773/* This function parses exactly 4 digits and returns the numeric value in "digit". */
3774static inline int parse_4digit(const char **date, int *len, int *digit)
3775{
3776 int value;
3777
3778 RET0_UNLESS(parse_digit(date, len, &value));
3779 (*digit) = value * 1000;
3780
3781 RET0_UNLESS(parse_digit(date, len, &value));
3782 (*digit) += value * 100;
3783
3784 RET0_UNLESS(parse_digit(date, len, &value));
3785 (*digit) += value * 10;
3786
3787 RET0_UNLESS(parse_digit(date, len, &value));
3788 (*digit) += value;
3789
3790 return 1;
3791}
3792
3793/* time-of-day = hour ":" minute ":" second
3794 * ; 00:00:00 - 23:59:60 (leap second)
3795 *
3796 * hour = 2DIGIT
3797 * minute = 2DIGIT
3798 * second = 2DIGIT
3799 */
3800static inline int parse_http_time(const char **date, int *len, struct tm *tm)
3801{
3802 RET0_UNLESS(parse_2digit(date, len, &tm->tm_hour)); /* hour 2DIGIT */
3803 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3804 RET0_UNLESS(parse_2digit(date, len, &tm->tm_min)); /* min 2DIGIT */
3805 RET0_UNLESS(parse_expect_char(date, len, ':')); /* expect ":" */
3806 RET0_UNLESS(parse_2digit(date, len, &tm->tm_sec)); /* sec 2DIGIT */
3807 return 1;
3808}
3809
3810/* From RFC7231
3811 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3812 *
3813 * IMF-fixdate = day-name "," SP date1 SP time-of-day SP GMT
3814 * ; fixed length/zone/capitalization subset of the format
3815 * ; see Section 3.3 of [RFC5322]
3816 *
3817 *
3818 * date1 = day SP month SP year
3819 * ; e.g., 02 Jun 1982
3820 *
3821 * day = 2DIGIT
3822 * year = 4DIGIT
3823 *
3824 * GMT = %x47.4D.54 ; "GMT", case-sensitive
3825 *
3826 * time-of-day = hour ":" minute ":" second
3827 * ; 00:00:00 - 23:59:60 (leap second)
3828 *
3829 * hour = 2DIGIT
3830 * minute = 2DIGIT
3831 * second = 2DIGIT
3832 *
3833 * DIGIT = decimal 0-9
3834 */
3835int parse_imf_date(const char *date, int len, struct tm *tm)
3836{
David Carlier327298c2016-11-20 10:42:38 +00003837 /* tm_gmtoff, if present, ought to be zero'ed */
3838 memset(tm, 0, sizeof(*tm));
3839
Thierry Fournier93127942016-01-20 18:49:45 +01003840 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3841 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3842 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3843 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3844 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3845 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3846 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3847 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3848 tm->tm_year -= 1900;
3849 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3850 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3851 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3852 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3853 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003854 return 1;
3855}
3856
3857/* From RFC7231
3858 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3859 *
3860 * rfc850-date = day-name-l "," SP date2 SP time-of-day SP GMT
3861 * date2 = day "-" month "-" 2DIGIT
3862 * ; e.g., 02-Jun-82
3863 *
3864 * day = 2DIGIT
3865 */
3866int parse_rfc850_date(const char *date, int len, struct tm *tm)
3867{
3868 int year;
3869
David Carlier327298c2016-11-20 10:42:38 +00003870 /* tm_gmtoff, if present, ought to be zero'ed */
3871 memset(tm, 0, sizeof(*tm));
3872
Thierry Fournier93127942016-01-20 18:49:45 +01003873 RET0_UNLESS(parse_http_ldayname(&date, &len, tm)); /* Read the day name */
3874 RET0_UNLESS(parse_expect_char(&date, &len, ',')); /* expect "," */
3875 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3876 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday)); /* day 2DIGIT */
3877 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3878 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* Month */
3879 RET0_UNLESS(parse_expect_char(&date, &len, '-')); /* expect "-" */
3880
3881 /* year = 2DIGIT
3882 *
3883 * Recipients of a timestamp value in rfc850-(*date) format, which uses a
3884 * two-digit year, MUST interpret a timestamp that appears to be more
3885 * than 50 years in the future as representing the most recent year in
3886 * the past that had the same last two digits.
3887 */
3888 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_year));
3889
3890 /* expect SP */
3891 if (!parse_expect_char(&date, &len, ' ')) {
3892 /* Maybe we have the date with 4 digits. */
3893 RET0_UNLESS(parse_2digit(&date, &len, &year));
3894 tm->tm_year = (tm->tm_year * 100 + year) - 1900;
3895 /* expect SP */
3896 RET0_UNLESS(parse_expect_char(&date, &len, ' '));
3897 } else {
3898 /* I fix 60 as pivot: >60: +1900, <60: +2000. Note that the
3899 * tm_year is the number of year since 1900, so for +1900, we
3900 * do nothing, and for +2000, we add 100.
3901 */
3902 if (tm->tm_year <= 60)
3903 tm->tm_year += 100;
3904 }
3905
3906 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3907 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3908 RET0_UNLESS(parse_strcmp(&date, &len, "GMT", 3)); /* GMT = %x47.4D.54 ; "GMT", case-sensitive */
3909 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003910
3911 return 1;
3912}
3913
3914/* From RFC7231
3915 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3916 *
3917 * asctime-date = day-name SP date3 SP time-of-day SP year
3918 * date3 = month SP ( 2DIGIT / ( SP 1DIGIT ))
3919 * ; e.g., Jun 2
3920 *
3921 * HTTP-date is case sensitive. A sender MUST NOT generate additional
3922 * whitespace in an HTTP-date beyond that specifically included as SP in
3923 * the grammar.
3924 */
3925int parse_asctime_date(const char *date, int len, struct tm *tm)
3926{
David Carlier327298c2016-11-20 10:42:38 +00003927 /* tm_gmtoff, if present, ought to be zero'ed */
3928 memset(tm, 0, sizeof(*tm));
3929
Thierry Fournier93127942016-01-20 18:49:45 +01003930 RET0_UNLESS(parse_http_dayname(&date, &len, tm)); /* day-name */
3931 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3932 RET0_UNLESS(parse_http_monthname(&date, &len, tm)); /* expect month */
3933 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3934
3935 /* expect SP and 1DIGIT or 2DIGIT */
3936 if (parse_expect_char(&date, &len, ' '))
3937 RET0_UNLESS(parse_digit(&date, &len, &tm->tm_mday));
3938 else
3939 RET0_UNLESS(parse_2digit(&date, &len, &tm->tm_mday));
3940
3941 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3942 RET0_UNLESS(parse_http_time(&date, &len, tm)); /* Parse time. */
3943 RET0_UNLESS(parse_expect_char(&date, &len, ' ')); /* expect SP */
3944 RET0_UNLESS(parse_4digit(&date, &len, &tm->tm_year)); /* year = 4DIGIT */
3945 tm->tm_year -= 1900;
3946 tm->tm_isdst = -1;
Thierry Fournier93127942016-01-20 18:49:45 +01003947 return 1;
3948}
3949
3950/* From RFC7231
3951 * https://tools.ietf.org/html/rfc7231#section-7.1.1.1
3952 *
3953 * HTTP-date = IMF-fixdate / obs-date
3954 * obs-date = rfc850-date / asctime-date
3955 *
3956 * parses an HTTP date in the RFC format and is accepted
3957 * alternatives. <date> is the strinf containing the date,
3958 * len is the len of the string. <tm> is filled with the
3959 * parsed time. We must considers this time as GMT.
3960 */
3961int parse_http_date(const char *date, int len, struct tm *tm)
3962{
3963 if (parse_imf_date(date, len, tm))
3964 return 1;
3965
3966 if (parse_rfc850_date(date, len, tm))
3967 return 1;
3968
3969 if (parse_asctime_date(date, len, tm))
3970 return 1;
3971
3972 return 0;
3973}
3974
Willy Tarreau4deeb102021-01-29 10:47:52 +01003975/* print the time <ns> in a short form (exactly 7 chars) at the end of buffer
3976 * <out>. "-" is printed if the value is zero, "inf" if larger than 1000 years.
3977 * It returns the new buffer length, or 0 if it doesn't fit. The value will be
3978 * surrounded by <pfx> and <sfx> respectively if not NULL.
3979 */
3980int print_time_short(struct buffer *out, const char *pfx, uint64_t ns, const char *sfx)
3981{
3982 double val = ns; // 52 bits of mantissa keep ns accuracy over 52 days
3983 const char *unit;
3984
3985 if (!pfx)
3986 pfx = "";
3987 if (!sfx)
3988 sfx = "";
3989
3990 do {
3991 unit = " - "; if (val <= 0.0) break;
3992 unit = "ns"; if (val < 1000.0) break;
3993 unit = "us"; val /= 1000.0; if (val < 1000.0) break;
3994 unit = "ms"; val /= 1000.0; if (val < 1000.0) break;
3995 unit = "s "; val /= 1000.0; if (val < 60.0) break;
3996 unit = "m "; val /= 60.0; if (val < 60.0) break;
3997 unit = "h "; val /= 60.0; if (val < 24.0) break;
3998 unit = "d "; val /= 24.0; if (val < 365.0) break;
3999 unit = "yr"; val /= 365.0; if (val < 1000.0) break;
4000 unit = " inf "; val = 0.0; break;
4001 } while (0);
4002
4003 if (val <= 0.0)
4004 return chunk_appendf(out, "%s%7s%s", pfx, unit, sfx);
4005 else if (val < 10.0)
4006 return chunk_appendf(out, "%s%1.3f%s%s", pfx, val, unit, sfx);
4007 else if (val < 100.0)
4008 return chunk_appendf(out, "%s%2.2f%s%s", pfx, val, unit, sfx);
4009 else
4010 return chunk_appendf(out, "%s%3.1f%s%s", pfx, val, unit, sfx);
4011}
4012
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004013/* Dynamically allocates a string of the proper length to hold the formatted
4014 * output. NULL is returned on error. The caller is responsible for freeing the
4015 * memory area using free(). The resulting string is returned in <out> if the
4016 * pointer is not NULL. A previous version of <out> might be used to build the
4017 * new string, and it will be freed before returning if it is not NULL, which
4018 * makes it possible to build complex strings from iterative calls without
4019 * having to care about freeing intermediate values, as in the example below :
4020 *
4021 * memprintf(&err, "invalid argument: '%s'", arg);
4022 * ...
4023 * memprintf(&err, "parser said : <%s>\n", *err);
4024 * ...
4025 * free(*err);
4026 *
4027 * This means that <err> must be initialized to NULL before first invocation.
4028 * The return value also holds the allocated string, which eases error checking
4029 * and immediate consumption. If the output pointer is not used, NULL must be
Willy Tarreaueb6cead2012-09-20 19:43:14 +02004030 * passed instead and it will be ignored. The returned message will then also
4031 * be NULL so that the caller does not have to bother with freeing anything.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004032 *
4033 * It is also convenient to use it without any free except the last one :
4034 * err = NULL;
4035 * if (!fct1(err)) report(*err);
4036 * if (!fct2(err)) report(*err);
4037 * if (!fct3(err)) report(*err);
4038 * free(*err);
Christopher Faulet93a518f2017-10-24 11:25:33 +02004039 *
4040 * memprintf relies on memvprintf. This last version can be called from any
4041 * function with variadic arguments.
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004042 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02004043char *memvprintf(char **out, const char *format, va_list orig_args)
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004044{
4045 va_list args;
4046 char *ret = NULL;
4047 int allocated = 0;
4048 int needed = 0;
4049
Willy Tarreaueb6cead2012-09-20 19:43:14 +02004050 if (!out)
4051 return NULL;
4052
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004053 do {
Willy Tarreaue0609f52019-03-29 19:13:23 +01004054 char buf1;
4055
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004056 /* vsnprintf() will return the required length even when the
4057 * target buffer is NULL. We do this in a loop just in case
4058 * intermediate evaluations get wrong.
4059 */
Christopher Faulet93a518f2017-10-24 11:25:33 +02004060 va_copy(args, orig_args);
Willy Tarreaue0609f52019-03-29 19:13:23 +01004061 needed = vsnprintf(ret ? ret : &buf1, allocated, format, args);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004062 va_end(args);
Willy Tarreau1b2fed62013-04-01 22:48:54 +02004063 if (needed < allocated) {
4064 /* Note: on Solaris 8, the first iteration always
4065 * returns -1 if allocated is zero, so we force a
4066 * retry.
4067 */
4068 if (!allocated)
4069 needed = 0;
4070 else
4071 break;
4072 }
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004073
Willy Tarreau1b2fed62013-04-01 22:48:54 +02004074 allocated = needed + 1;
Hubert Verstraete831962e2016-06-28 22:44:26 +02004075 ret = my_realloc2(ret, allocated);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004076 } while (ret);
4077
4078 if (needed < 0) {
4079 /* an error was encountered */
Willy Tarreau61cfdf42021-02-20 10:46:51 +01004080 ha_free(&ret);
Willy Tarreau9a7bea52012-04-27 11:16:50 +02004081 }
4082
4083 if (out) {
4084 free(*out);
4085 *out = ret;
4086 }
4087
4088 return ret;
4089}
William Lallemand421f5b52012-02-06 18:15:57 +01004090
Christopher Faulet93a518f2017-10-24 11:25:33 +02004091char *memprintf(char **out, const char *format, ...)
4092{
4093 va_list args;
4094 char *ret = NULL;
4095
4096 va_start(args, format);
4097 ret = memvprintf(out, format, args);
4098 va_end(args);
4099
4100 return ret;
4101}
4102
Willy Tarreau21c705b2012-09-14 11:40:36 +02004103/* Used to add <level> spaces before each line of <out>, unless there is only one line.
4104 * The input argument is automatically freed and reassigned. The result will have to be
Willy Tarreau70eec382012-10-10 08:56:47 +02004105 * freed by the caller. It also supports being passed a NULL which results in the same
4106 * output.
Willy Tarreau21c705b2012-09-14 11:40:36 +02004107 * Example of use :
4108 * parse(cmd, &err); (callee: memprintf(&err, ...))
4109 * fprintf(stderr, "Parser said: %s\n", indent_error(&err));
4110 * free(err);
4111 */
4112char *indent_msg(char **out, int level)
4113{
4114 char *ret, *in, *p;
4115 int needed = 0;
4116 int lf = 0;
4117 int lastlf = 0;
4118 int len;
4119
Willy Tarreau70eec382012-10-10 08:56:47 +02004120 if (!out || !*out)
4121 return NULL;
4122
Willy Tarreau21c705b2012-09-14 11:40:36 +02004123 in = *out - 1;
4124 while ((in = strchr(in + 1, '\n')) != NULL) {
4125 lastlf = in - *out;
4126 lf++;
4127 }
4128
4129 if (!lf) /* single line, no LF, return it as-is */
4130 return *out;
4131
4132 len = strlen(*out);
4133
4134 if (lf == 1 && lastlf == len - 1) {
4135 /* single line, LF at end, strip it and return as-is */
4136 (*out)[lastlf] = 0;
4137 return *out;
4138 }
4139
4140 /* OK now we have at least one LF, we need to process the whole string
4141 * as a multi-line string. What we'll do :
4142 * - prefix with an LF if there is none
4143 * - add <level> spaces before each line
4144 * This means at most ( 1 + level + (len-lf) + lf*<1+level) ) =
4145 * 1 + level + len + lf * level = 1 + level * (lf + 1) + len.
4146 */
4147
4148 needed = 1 + level * (lf + 1) + len + 1;
4149 p = ret = malloc(needed);
4150 in = *out;
4151
4152 /* skip initial LFs */
4153 while (*in == '\n')
4154 in++;
4155
4156 /* copy each line, prefixed with LF and <level> spaces, and without the trailing LF */
4157 while (*in) {
4158 *p++ = '\n';
4159 memset(p, ' ', level);
4160 p += level;
4161 do {
4162 *p++ = *in++;
4163 } while (*in && *in != '\n');
4164 if (*in)
4165 in++;
4166 }
4167 *p = 0;
4168
4169 free(*out);
4170 *out = ret;
4171
4172 return ret;
4173}
4174
Willy Tarreaua2c99112019-08-21 13:17:37 +02004175/* makes a copy of message <in> into <out>, with each line prefixed with <pfx>
4176 * and end of lines replaced with <eol> if not 0. The first line to indent has
4177 * to be indicated in <first> (starts at zero), so that it is possible to skip
4178 * indenting the first line if it has to be appended after an existing message.
4179 * Empty strings are never indented, and NULL strings are considered empty both
4180 * for <in> and <pfx>. It returns non-zero if an EOL was appended as the last
4181 * character, non-zero otherwise.
4182 */
4183int append_prefixed_str(struct buffer *out, const char *in, const char *pfx, char eol, int first)
4184{
4185 int bol, lf;
4186 int pfxlen = pfx ? strlen(pfx) : 0;
4187
4188 if (!in)
4189 return 0;
4190
4191 bol = 1;
4192 lf = 0;
4193 while (*in) {
4194 if (bol && pfxlen) {
4195 if (first > 0)
4196 first--;
4197 else
4198 b_putblk(out, pfx, pfxlen);
4199 bol = 0;
4200 }
4201
4202 lf = (*in == '\n');
4203 bol |= lf;
4204 b_putchr(out, (lf && eol) ? eol : *in);
4205 in++;
4206 }
4207 return lf;
4208}
4209
Willy Tarreau9d22e562019-03-29 18:49:09 +01004210/* removes environment variable <name> from the environment as found in
4211 * environ. This is only provided as an alternative for systems without
4212 * unsetenv() (old Solaris and AIX versions). THIS IS NOT THREAD SAFE.
Ilya Shipitsin856aabc2020-04-16 23:51:34 +05004213 * The principle is to scan environ for each occurrence of variable name
Willy Tarreau9d22e562019-03-29 18:49:09 +01004214 * <name> and to replace the matching pointers with the last pointer of
4215 * the array (since variables are not ordered).
4216 * It always returns 0 (success).
4217 */
4218int my_unsetenv(const char *name)
4219{
4220 extern char **environ;
4221 char **p = environ;
4222 int vars;
4223 int next;
4224 int len;
4225
4226 len = strlen(name);
4227 for (vars = 0; p[vars]; vars++)
4228 ;
4229 next = 0;
4230 while (next < vars) {
4231 if (strncmp(p[next], name, len) != 0 || p[next][len] != '=') {
4232 next++;
4233 continue;
4234 }
4235 if (next < vars - 1)
4236 p[next] = p[vars - 1];
4237 p[--vars] = NULL;
4238 }
4239 return 0;
4240}
4241
Willy Tarreaudad36a32013-03-11 01:20:04 +01004242/* Convert occurrences of environment variables in the input string to their
4243 * corresponding value. A variable is identified as a series of alphanumeric
4244 * characters or underscores following a '$' sign. The <in> string must be
4245 * free()able. NULL returns NULL. The resulting string might be reallocated if
4246 * some expansion is made. Variable names may also be enclosed into braces if
4247 * needed (eg: to concatenate alphanum characters).
4248 */
4249char *env_expand(char *in)
4250{
4251 char *txt_beg;
4252 char *out;
4253 char *txt_end;
4254 char *var_beg;
4255 char *var_end;
4256 char *value;
4257 char *next;
4258 int out_len;
4259 int val_len;
4260
4261 if (!in)
4262 return in;
4263
4264 value = out = NULL;
4265 out_len = 0;
4266
4267 txt_beg = in;
4268 do {
4269 /* look for next '$' sign in <in> */
4270 for (txt_end = txt_beg; *txt_end && *txt_end != '$'; txt_end++);
4271
4272 if (!*txt_end && !out) /* end and no expansion performed */
4273 return in;
4274
4275 val_len = 0;
4276 next = txt_end;
4277 if (*txt_end == '$') {
4278 char save;
4279
4280 var_beg = txt_end + 1;
4281 if (*var_beg == '{')
4282 var_beg++;
4283
4284 var_end = var_beg;
Willy Tarreau90807112020-02-25 08:16:33 +01004285 while (isalnum((unsigned char)*var_end) || *var_end == '_') {
Willy Tarreaudad36a32013-03-11 01:20:04 +01004286 var_end++;
4287 }
4288
4289 next = var_end;
4290 if (*var_end == '}' && (var_beg > txt_end + 1))
4291 next++;
4292
4293 /* get value of the variable name at this location */
4294 save = *var_end;
4295 *var_end = '\0';
4296 value = getenv(var_beg);
4297 *var_end = save;
4298 val_len = value ? strlen(value) : 0;
4299 }
4300
Hubert Verstraete831962e2016-06-28 22:44:26 +02004301 out = my_realloc2(out, out_len + (txt_end - txt_beg) + val_len + 1);
Willy Tarreaudad36a32013-03-11 01:20:04 +01004302 if (txt_end > txt_beg) {
4303 memcpy(out + out_len, txt_beg, txt_end - txt_beg);
4304 out_len += txt_end - txt_beg;
4305 }
4306 if (val_len) {
4307 memcpy(out + out_len, value, val_len);
4308 out_len += val_len;
4309 }
4310 out[out_len] = 0;
4311 txt_beg = next;
4312 } while (*txt_beg);
4313
4314 /* here we know that <out> was allocated and that we don't need <in> anymore */
4315 free(in);
4316 return out;
4317}
4318
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004319
4320/* same as strstr() but case-insensitive and with limit length */
4321const char *strnistr(const char *str1, int len_str1, const char *str2, int len_str2)
4322{
4323 char *pptr, *sptr, *start;
Willy Tarreauc8746532014-05-28 23:05:07 +02004324 unsigned int slen, plen;
4325 unsigned int tmp1, tmp2;
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004326
4327 if (str1 == NULL || len_str1 == 0) // search pattern into an empty string => search is not found
4328 return NULL;
4329
4330 if (str2 == NULL || len_str2 == 0) // pattern is empty => every str1 match
4331 return str1;
4332
4333 if (len_str1 < len_str2) // pattern is longer than string => search is not found
4334 return NULL;
4335
4336 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 +02004337 while (toupper((unsigned char)*start) != toupper((unsigned char)*str2)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004338 start++;
4339 slen--;
4340 tmp1++;
4341
4342 if (tmp1 >= len_str1)
4343 return NULL;
4344
4345 /* if pattern longer than string */
4346 if (slen < plen)
4347 return NULL;
4348 }
4349
4350 sptr = start;
4351 pptr = (char *)str2;
4352
4353 tmp2 = 0;
Willy Tarreauf278eec2020-07-05 21:46:32 +02004354 while (toupper((unsigned char)*sptr) == toupper((unsigned char)*pptr)) {
de Lafond Guillaume88c278f2013-04-15 19:27:10 +02004355 sptr++;
4356 pptr++;
4357 tmp2++;
4358
4359 if (*pptr == '\0' || tmp2 == len_str2) /* end of pattern found */
4360 return start;
4361 if (*sptr == '\0' || tmp2 == len_str1) /* end of string found and the pattern is not fully found */
4362 return NULL;
4363 }
4364 }
4365 return NULL;
4366}
4367
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004368/* This function read the next valid utf8 char.
4369 * <s> is the byte srray to be decode, <len> is its length.
4370 * The function returns decoded char encoded like this:
4371 * The 4 msb are the return code (UTF8_CODE_*), the 4 lsb
4372 * are the length read. The decoded character is stored in <c>.
4373 */
4374unsigned char utf8_next(const char *s, int len, unsigned int *c)
4375{
4376 const unsigned char *p = (unsigned char *)s;
4377 int dec;
4378 unsigned char code = UTF8_CODE_OK;
4379
4380 if (len < 1)
4381 return UTF8_CODE_OK;
4382
4383 /* Check the type of UTF8 sequence
4384 *
4385 * 0... .... 0x00 <= x <= 0x7f : 1 byte: ascii char
4386 * 10.. .... 0x80 <= x <= 0xbf : invalid sequence
4387 * 110. .... 0xc0 <= x <= 0xdf : 2 bytes
4388 * 1110 .... 0xe0 <= x <= 0xef : 3 bytes
4389 * 1111 0... 0xf0 <= x <= 0xf7 : 4 bytes
4390 * 1111 10.. 0xf8 <= x <= 0xfb : 5 bytes
4391 * 1111 110. 0xfc <= x <= 0xfd : 6 bytes
4392 * 1111 111. 0xfe <= x <= 0xff : invalid sequence
4393 */
4394 switch (*p) {
4395 case 0x00 ... 0x7f:
4396 *c = *p;
4397 return UTF8_CODE_OK | 1;
4398
4399 case 0x80 ... 0xbf:
4400 *c = *p;
4401 return UTF8_CODE_BADSEQ | 1;
4402
4403 case 0xc0 ... 0xdf:
4404 if (len < 2) {
4405 *c = *p;
4406 return UTF8_CODE_BADSEQ | 1;
4407 }
4408 *c = *p & 0x1f;
4409 dec = 1;
4410 break;
4411
4412 case 0xe0 ... 0xef:
4413 if (len < 3) {
4414 *c = *p;
4415 return UTF8_CODE_BADSEQ | 1;
4416 }
4417 *c = *p & 0x0f;
4418 dec = 2;
4419 break;
4420
4421 case 0xf0 ... 0xf7:
4422 if (len < 4) {
4423 *c = *p;
4424 return UTF8_CODE_BADSEQ | 1;
4425 }
4426 *c = *p & 0x07;
4427 dec = 3;
4428 break;
4429
4430 case 0xf8 ... 0xfb:
4431 if (len < 5) {
4432 *c = *p;
4433 return UTF8_CODE_BADSEQ | 1;
4434 }
4435 *c = *p & 0x03;
4436 dec = 4;
4437 break;
4438
4439 case 0xfc ... 0xfd:
4440 if (len < 6) {
4441 *c = *p;
4442 return UTF8_CODE_BADSEQ | 1;
4443 }
4444 *c = *p & 0x01;
4445 dec = 5;
4446 break;
4447
4448 case 0xfe ... 0xff:
4449 default:
4450 *c = *p;
4451 return UTF8_CODE_BADSEQ | 1;
4452 }
4453
4454 p++;
4455
4456 while (dec > 0) {
4457
4458 /* need 0x10 for the 2 first bits */
4459 if ( ( *p & 0xc0 ) != 0x80 )
4460 return UTF8_CODE_BADSEQ | ((p-(unsigned char *)s)&0xffff);
4461
4462 /* add data at char */
4463 *c = ( *c << 6 ) | ( *p & 0x3f );
4464
4465 dec--;
4466 p++;
4467 }
4468
4469 /* Check ovelong encoding.
4470 * 1 byte : 5 + 6 : 11 : 0x80 ... 0x7ff
4471 * 2 bytes : 4 + 6 + 6 : 16 : 0x800 ... 0xffff
4472 * 3 bytes : 3 + 6 + 6 + 6 : 21 : 0x10000 ... 0x1fffff
4473 */
Thierry FOURNIER9e7ec082015-03-12 19:32:38 +01004474 if (( *c <= 0x7f && (p-(unsigned char *)s) > 1) ||
Thierry FOURNIER317e1c42014-08-12 10:20:47 +02004475 (*c >= 0x80 && *c <= 0x7ff && (p-(unsigned char *)s) > 2) ||
4476 (*c >= 0x800 && *c <= 0xffff && (p-(unsigned char *)s) > 3) ||
4477 (*c >= 0x10000 && *c <= 0x1fffff && (p-(unsigned char *)s) > 4))
4478 code |= UTF8_CODE_OVERLONG;
4479
4480 /* Check invalid UTF8 range. */
4481 if ((*c >= 0xd800 && *c <= 0xdfff) ||
4482 (*c >= 0xfffe && *c <= 0xffff))
4483 code |= UTF8_CODE_INVRANGE;
4484
4485 return code | ((p-(unsigned char *)s)&0x0f);
4486}
4487
Maxime de Roucydc887852016-05-13 23:52:54 +02004488/* append a copy of string <str> (in a wordlist) at the end of the list <li>
4489 * On failure : return 0 and <err> filled with an error message.
4490 * The caller is responsible for freeing the <err> and <str> copy
4491 * memory area using free()
4492 */
4493int list_append_word(struct list *li, const char *str, char **err)
4494{
4495 struct wordlist *wl;
4496
4497 wl = calloc(1, sizeof(*wl));
4498 if (!wl) {
4499 memprintf(err, "out of memory");
4500 goto fail_wl;
4501 }
4502
4503 wl->s = strdup(str);
4504 if (!wl->s) {
4505 memprintf(err, "out of memory");
4506 goto fail_wl_s;
4507 }
4508
Willy Tarreau2b718102021-04-21 07:32:39 +02004509 LIST_APPEND(li, &wl->list);
Maxime de Roucydc887852016-05-13 23:52:54 +02004510
4511 return 1;
4512
4513fail_wl_s:
4514 free(wl->s);
4515fail_wl:
4516 free(wl);
4517 return 0;
4518}
4519
Willy Tarreau37101052019-05-20 16:48:20 +02004520/* indicates if a memory location may safely be read or not. The trick consists
4521 * in performing a harmless syscall using this location as an input and letting
4522 * the operating system report whether it's OK or not. For this we have the
4523 * stat() syscall, which will return EFAULT when the memory location supposed
4524 * to contain the file name is not readable. If it is readable it will then
4525 * either return 0 if the area contains an existing file name, or -1 with
4526 * another code. This must not be abused, and some audit systems might detect
4527 * this as abnormal activity. It's used only for unsafe dumps.
4528 */
4529int may_access(const void *ptr)
4530{
4531 struct stat buf;
4532
4533 if (stat(ptr, &buf) == 0)
4534 return 1;
4535 if (errno == EFAULT)
4536 return 0;
4537 return 1;
4538}
4539
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004540/* print a string of text buffer to <out>. The format is :
4541 * Non-printable chars \t, \n, \r and \e are * encoded in C format.
4542 * Other non-printable chars are encoded "\xHH". Space, '\', and '=' are also escaped.
4543 * Print stopped if null char or <bsize> is reached, or if no more place in the chunk.
4544 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004545int dump_text(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004546{
4547 unsigned char c;
Tim Duesterhus18795d42021-08-29 00:58:22 +02004548 size_t ptr = 0;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004549
Tim Duesterhus18795d42021-08-29 00:58:22 +02004550 while (ptr < bsize && buf[ptr]) {
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004551 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004552 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\' && c != ' ' && c != '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004553 if (out->data > out->size - 1)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004554 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004555 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004556 }
4557 else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\' || c == ' ' || c == '=') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004558 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004559 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004560 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004561 switch (c) {
4562 case ' ': c = ' '; break;
4563 case '\t': c = 't'; break;
4564 case '\n': c = 'n'; break;
4565 case '\r': c = 'r'; break;
4566 case '\e': c = 'e'; break;
4567 case '\\': c = '\\'; break;
4568 case '=': c = '='; break;
4569 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004570 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004571 }
4572 else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004573 if (out->data > out->size - 4)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004574 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004575 out->area[out->data++] = '\\';
4576 out->area[out->data++] = 'x';
4577 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4578 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004579 }
4580 ptr++;
4581 }
4582
4583 return ptr;
4584}
4585
4586/* print a buffer in hexa.
4587 * Print stopped if <bsize> is reached, or if no more place in the chunk.
4588 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004589int dump_binary(struct buffer *out, const char *buf, int bsize)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004590{
4591 unsigned char c;
4592 int ptr = 0;
4593
4594 while (ptr < bsize) {
4595 c = buf[ptr];
4596
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004597 if (out->data > out->size - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004598 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004599 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4600 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004601
4602 ptr++;
4603 }
4604 return ptr;
4605}
4606
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004607/* Appends into buffer <out> a hex dump of memory area <buf> for <len> bytes,
4608 * prepending each line with prefix <pfx>. The output is *not* initialized.
4609 * The output will not wrap pas the buffer's end so it is more optimal if the
4610 * caller makes sure the buffer is aligned first. A trailing zero will always
4611 * be appended (and not counted) if there is room for it. The caller must make
Willy Tarreau37101052019-05-20 16:48:20 +02004612 * sure that the area is dumpable first. If <unsafe> is non-null, the memory
4613 * locations are checked first for being readable.
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004614 */
Willy Tarreau37101052019-05-20 16:48:20 +02004615void dump_hex(struct buffer *out, const char *pfx, const void *buf, int len, int unsafe)
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004616{
4617 const unsigned char *d = buf;
4618 int i, j, start;
4619
4620 d = (const unsigned char *)(((unsigned long)buf) & -16);
4621 start = ((unsigned long)buf) & 15;
4622
4623 for (i = 0; i < start + len; i += 16) {
4624 chunk_appendf(out, (sizeof(void *) == 4) ? "%s%8p: " : "%s%16p: ", pfx, d + i);
4625
Willy Tarreau37101052019-05-20 16:48:20 +02004626 // 0: unchecked, 1: checked safe, 2: danger
4627 unsafe = !!unsafe;
4628 if (unsafe && !may_access(d + i))
4629 unsafe = 2;
4630
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004631 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004632 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004633 chunk_strcat(out, "'' ");
Willy Tarreau37101052019-05-20 16:48:20 +02004634 else if (unsafe > 1)
4635 chunk_strcat(out, "** ");
4636 else
4637 chunk_appendf(out, "%02x ", d[i + j]);
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004638
4639 if (j == 7)
4640 chunk_strcat(out, "- ");
4641 }
4642 chunk_strcat(out, " ");
4643 for (j = 0; j < 16; j++) {
Willy Tarreau37101052019-05-20 16:48:20 +02004644 if ((i + j < start) || (i + j >= start + len))
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004645 chunk_strcat(out, "'");
Willy Tarreau37101052019-05-20 16:48:20 +02004646 else if (unsafe > 1)
4647 chunk_strcat(out, "*");
Willy Tarreau90807112020-02-25 08:16:33 +01004648 else if (isprint((unsigned char)d[i + j]))
Willy Tarreau37101052019-05-20 16:48:20 +02004649 chunk_appendf(out, "%c", d[i + j]);
4650 else
4651 chunk_strcat(out, ".");
Willy Tarreau9fc5dcb2019-05-20 16:13:40 +02004652 }
4653 chunk_strcat(out, "\n");
4654 }
4655}
4656
Willy Tarreau762fb3e2020-03-03 15:57:10 +01004657/* dumps <pfx> followed by <n> bytes from <addr> in hex form into buffer <buf>
4658 * enclosed in brackets after the address itself, formatted on 14 chars
4659 * including the "0x" prefix. This is meant to be used as a prefix for code
4660 * areas. For example:
4661 * "0x7f10b6557690 [48 c7 c0 0f 00 00 00 0f]"
4662 * It relies on may_access() to know if the bytes are dumpable, otherwise "--"
4663 * is emitted. A NULL <pfx> will be considered empty.
4664 */
4665void dump_addr_and_bytes(struct buffer *buf, const char *pfx, const void *addr, int n)
4666{
4667 int ok = 0;
4668 int i;
4669
4670 chunk_appendf(buf, "%s%#14lx [", pfx ? pfx : "", (long)addr);
4671
4672 for (i = 0; i < n; i++) {
4673 if (i == 0 || (((long)(addr + i) ^ (long)(addr)) & 4096))
4674 ok = may_access(addr + i);
4675 if (ok)
4676 chunk_appendf(buf, "%02x%s", ((uint8_t*)addr)[i], (i<n-1) ? " " : "]");
4677 else
4678 chunk_appendf(buf, "--%s", (i<n-1) ? " " : "]");
4679 }
4680}
4681
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004682/* print a line of text buffer (limited to 70 bytes) to <out>. The format is :
4683 * <2 spaces> <offset=5 digits> <space or plus> <space> <70 chars max> <\n>
4684 * which is 60 chars per line. Non-printable chars \t, \n, \r and \e are
4685 * encoded in C format. Other non-printable chars are encoded "\xHH". Original
4686 * lines are respected within the limit of 70 output chars. Lines that are
4687 * continuation of a previous truncated line begin with "+" instead of " "
4688 * after the offset. The new pointer is returned.
4689 */
Willy Tarreau83061a82018-07-13 11:56:34 +02004690int dump_text_line(struct buffer *out, const char *buf, int bsize, int len,
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004691 int *line, int ptr)
4692{
4693 int end;
4694 unsigned char c;
4695
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004696 end = out->data + 80;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004697 if (end > out->size)
4698 return ptr;
4699
4700 chunk_appendf(out, " %05d%c ", ptr, (ptr == *line) ? ' ' : '+');
4701
4702 while (ptr < len && ptr < bsize) {
4703 c = buf[ptr];
Willy Tarreau90807112020-02-25 08:16:33 +01004704 if (isprint((unsigned char)c) && isascii((unsigned char)c) && c != '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004705 if (out->data > end - 2)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004706 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004707 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004708 } else if (c == '\t' || c == '\n' || c == '\r' || c == '\e' || c == '\\') {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004709 if (out->data > end - 3)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004710 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004711 out->area[out->data++] = '\\';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004712 switch (c) {
4713 case '\t': c = 't'; break;
4714 case '\n': c = 'n'; break;
4715 case '\r': c = 'r'; break;
4716 case '\e': c = 'e'; break;
4717 case '\\': c = '\\'; break;
4718 }
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004719 out->area[out->data++] = c;
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004720 } else {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004721 if (out->data > end - 5)
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004722 break;
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004723 out->area[out->data++] = '\\';
4724 out->area[out->data++] = 'x';
4725 out->area[out->data++] = hextab[(c >> 4) & 0xF];
4726 out->area[out->data++] = hextab[c & 0xF];
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004727 }
4728 if (buf[ptr++] == '\n') {
4729 /* we had a line break, let's return now */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004730 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004731 *line = ptr;
4732 return ptr;
4733 }
4734 }
4735 /* we have an incomplete line, we return it as-is */
Willy Tarreau843b7cb2018-07-13 10:54:26 +02004736 out->area[out->data++] = '\n';
Willy Tarreau97c2ae12016-11-22 18:00:20 +01004737 return ptr;
4738}
4739
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004740/* displays a <len> long memory block at <buf>, assuming first byte of <buf>
Willy Tarreaued936c52017-04-27 18:03:20 +02004741 * has address <baseaddr>. String <pfx> may be placed as a prefix in front of
4742 * each line. It may be NULL if unused. The output is emitted to file <out>.
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004743 */
Willy Tarreaued936c52017-04-27 18:03:20 +02004744void debug_hexdump(FILE *out, const char *pfx, const char *buf,
4745 unsigned int baseaddr, int len)
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004746{
Willy Tarreau73459792017-04-11 07:58:08 +02004747 unsigned int i;
4748 int b, j;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004749
4750 for (i = 0; i < (len + (baseaddr & 15)); i += 16) {
4751 b = i - (baseaddr & 15);
Willy Tarreaued936c52017-04-27 18:03:20 +02004752 fprintf(out, "%s%08x: ", pfx ? pfx : "", i + (baseaddr & ~15));
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004753 for (j = 0; j < 8; j++) {
4754 if (b + j >= 0 && b + j < len)
4755 fprintf(out, "%02x ", (unsigned char)buf[b + j]);
4756 else
4757 fprintf(out, " ");
4758 }
4759
4760 if (b + j >= 0 && b + j < len)
4761 fputc('-', out);
4762 else
4763 fputc(' ', out);
4764
4765 for (j = 8; j < 16; j++) {
4766 if (b + j >= 0 && b + j < len)
4767 fprintf(out, " %02x", (unsigned char)buf[b + j]);
4768 else
4769 fprintf(out, " ");
4770 }
4771
4772 fprintf(out, " ");
4773 for (j = 0; j < 16; j++) {
4774 if (b + j >= 0 && b + j < len) {
4775 if (isprint((unsigned char)buf[b + j]))
4776 fputc((unsigned char)buf[b + j], out);
4777 else
4778 fputc('.', out);
4779 }
4780 else
4781 fputc(' ', out);
4782 }
4783 fputc('\n', out);
4784 }
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004785}
4786
Willy Tarreaubb869862020-04-16 10:52:41 +02004787/* Tries to report the executable path name on platforms supporting this. If
4788 * not found or not possible, returns NULL.
4789 */
4790const char *get_exec_path()
4791{
4792 const char *ret = NULL;
4793
David Carlier43a56852022-03-04 15:50:48 +00004794#if defined(__linux__) && defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 16))
Willy Tarreaubb869862020-04-16 10:52:41 +02004795 long execfn = getauxval(AT_EXECFN);
4796
4797 if (execfn && execfn != ENOENT)
4798 ret = (const char *)execfn;
devnexen@gmail.comc4e52322021-08-17 12:55:49 +01004799#elif defined(__FreeBSD__)
4800 Elf_Auxinfo *auxv;
4801 for (auxv = __elf_aux_vector; auxv->a_type != AT_NULL; ++auxv) {
4802 if (auxv->a_type == AT_EXECPATH) {
4803 ret = (const char *)auxv->a_un.a_ptr;
4804 break;
4805 }
4806 }
David Carlierbd2cced2021-08-17 08:44:25 +01004807#elif defined(__NetBSD__)
4808 AuxInfo *auxv;
4809 for (auxv = _dlauxinfo(); auxv->a_type != AT_NULL; ++auxv) {
4810 if (auxv->a_type == AT_SUN_EXECNAME) {
4811 ret = (const char *)auxv->a_v;
4812 break;
4813 }
4814 }
Willy Tarreaubb869862020-04-16 10:52:41 +02004815#endif
4816 return ret;
4817}
4818
Baruch Siache1651b22020-07-24 07:52:20 +03004819#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreau9133e482020-03-04 10:19:36 +01004820/* calls dladdr() or dladdr1() on <addr> and <dli>. If dladdr1 is available,
4821 * also returns the symbol size in <size>, otherwise returns 0 there.
4822 */
4823static int dladdr_and_size(const void *addr, Dl_info *dli, size_t *size)
4824{
4825 int ret;
Willy Tarreau7b2108c2021-08-30 10:15:35 +02004826#if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 3)) // most detailed one
Willy Tarreauf3d5c4b2022-01-28 09:42:29 +01004827 const ElfW(Sym) *sym __attribute__((may_alias));
Willy Tarreau9133e482020-03-04 10:19:36 +01004828
4829 ret = dladdr1(addr, dli, (void **)&sym, RTLD_DL_SYMENT);
4830 if (ret)
4831 *size = sym ? sym->st_size : 0;
4832#else
David Carlierae5c42f2021-12-31 08:15:29 +00004833#if defined(__sun)
4834 ret = dladdr((void *)addr, dli);
4835#else
Willy Tarreau9133e482020-03-04 10:19:36 +01004836 ret = dladdr(addr, dli);
David Carlierae5c42f2021-12-31 08:15:29 +00004837#endif
Willy Tarreau9133e482020-03-04 10:19:36 +01004838 *size = 0;
4839#endif
4840 return ret;
4841}
Willy Tarreau64192392021-05-05 09:06:21 +02004842
4843/* Tries to retrieve the address of the first occurrence symbol <name>.
4844 * Note that NULL in return is not always an error as a symbol may have that
4845 * address in special situations.
4846 */
4847void *get_sym_curr_addr(const char *name)
4848{
4849 void *ptr = NULL;
4850
4851#ifdef RTLD_DEFAULT
4852 ptr = dlsym(RTLD_DEFAULT, name);
4853#endif
4854 return ptr;
4855}
4856
4857
4858/* Tries to retrieve the address of the next occurrence of symbol <name>
4859 * Note that NULL in return is not always an error as a symbol may have that
4860 * address in special situations.
4861 */
4862void *get_sym_next_addr(const char *name)
4863{
4864 void *ptr = NULL;
4865
4866#ifdef RTLD_NEXT
4867 ptr = dlsym(RTLD_NEXT, name);
Willy Tarreau9133e482020-03-04 10:19:36 +01004868#endif
Willy Tarreau64192392021-05-05 09:06:21 +02004869 return ptr;
4870}
4871
4872#else /* elf & linux & dl */
4873
4874/* no possible resolving on other platforms at the moment */
4875void *get_sym_curr_addr(const char *name)
4876{
4877 return NULL;
4878}
4879
4880void *get_sym_next_addr(const char *name)
4881{
4882 return NULL;
4883}
4884
4885#endif /* elf & linux & dl */
Willy Tarreau9133e482020-03-04 10:19:36 +01004886
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004887/* Tries to append to buffer <buf> some indications about the symbol at address
4888 * <addr> using the following form:
4889 * lib:+0xoffset (unresolvable address from lib's base)
4890 * main+0xoffset (unresolvable address from main (+/-))
4891 * lib:main+0xoffset (unresolvable lib address from main (+/-))
4892 * name (resolved exact exec address)
4893 * lib:name (resolved exact lib address)
4894 * name+0xoffset/0xsize (resolved address within exec symbol)
4895 * lib:name+0xoffset/0xsize (resolved address within lib symbol)
4896 *
4897 * The file name (lib or executable) is limited to what lies between the last
4898 * '/' and the first following '.'. An optional prefix <pfx> is prepended before
4899 * 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 +03004900 * that contains the "main" symbol, or when __ELF__ && USE_DL are not set.
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004901 *
4902 * The symbol's base address is returned, or NULL when unresolved, in order to
4903 * allow the caller to match it against known ones.
4904 */
Willy Tarreau45fd1032021-01-20 14:37:59 +01004905const void *resolve_sym_name(struct buffer *buf, const char *pfx, const void *addr)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004906{
4907 const struct {
4908 const void *func;
4909 const char *name;
4910 } fcts[] = {
4911 { .func = process_stream, .name = "process_stream" },
4912 { .func = task_run_applet, .name = "task_run_applet" },
4913 { .func = si_cs_io_cb, .name = "si_cs_io_cb" },
Willy Tarreau586f71b2020-12-11 15:54:36 +01004914 { .func = sock_conn_iocb, .name = "sock_conn_iocb" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004915 { .func = dgram_fd_handler, .name = "dgram_fd_handler" },
4916 { .func = listener_accept, .name = "listener_accept" },
Willy Tarreaud597ec22021-01-29 14:29:06 +01004917 { .func = manage_global_listener_queue, .name = "manage_global_listener_queue" },
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004918 { .func = poller_pipe_io_handler, .name = "poller_pipe_io_handler" },
4919 { .func = mworker_accept_wrapper, .name = "mworker_accept_wrapper" },
Willy Tarreau02922e12021-01-29 12:27:57 +01004920 { .func = session_expire_embryonic, .name = "session_expire_embryonic" },
Willy Tarreaufb5401f2021-01-29 12:25:23 +01004921#ifdef USE_THREAD
4922 { .func = accept_queue_process, .name = "accept_queue_process" },
4923#endif
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004924#ifdef USE_LUA
4925 { .func = hlua_process_task, .name = "hlua_process_task" },
4926#endif
Ilya Shipitsinbdec3ba2020-11-14 01:56:34 +05004927#ifdef SSL_MODE_ASYNC
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004928 { .func = ssl_async_fd_free, .name = "ssl_async_fd_free" },
4929 { .func = ssl_async_fd_handler, .name = "ssl_async_fd_handler" },
4930#endif
4931 };
4932
Baruch Siache1651b22020-07-24 07:52:20 +03004933#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004934 Dl_info dli, dli_main;
Willy Tarreau9133e482020-03-04 10:19:36 +01004935 size_t size;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004936 const char *fname, *p;
4937#endif
4938 int i;
4939
4940 if (pfx)
4941 chunk_appendf(buf, "%s", pfx);
4942
4943 for (i = 0; i < sizeof(fcts) / sizeof(fcts[0]); i++) {
4944 if (addr == fcts[i].func) {
4945 chunk_appendf(buf, "%s", fcts[i].name);
4946 return addr;
4947 }
4948 }
4949
Baruch Siache1651b22020-07-24 07:52:20 +03004950#if (defined(__ELF__) && !defined(__linux__)) || defined(USE_DL)
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004951 /* Now let's try to be smarter */
Willy Tarreau9133e482020-03-04 10:19:36 +01004952 if (!dladdr_and_size(addr, &dli, &size))
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004953 goto unknown;
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004954
4955 /* 1. prefix the library name if it's not the same object as the one
4956 * that contains the main function. The name is picked between last '/'
4957 * and first following '.'.
4958 */
4959 if (!dladdr(main, &dli_main))
4960 dli_main.dli_fbase = NULL;
4961
4962 if (dli_main.dli_fbase != dli.dli_fbase) {
4963 fname = dli.dli_fname;
4964 p = strrchr(fname, '/');
4965 if (p++)
4966 fname = p;
4967 p = strchr(fname, '.');
4968 if (!p)
4969 p = fname + strlen(fname);
4970
4971 chunk_appendf(buf, "%.*s:", (int)(long)(p - fname), fname);
4972 }
4973
4974 /* 2. symbol name */
4975 if (dli.dli_sname) {
4976 /* known, dump it and return symbol's address (exact or relative) */
4977 chunk_appendf(buf, "%s", dli.dli_sname);
4978 if (addr != dli.dli_saddr) {
4979 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_saddr));
Willy Tarreau9133e482020-03-04 10:19:36 +01004980 if (size)
4981 chunk_appendf(buf, "/%#lx", (long)size);
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004982 }
4983 return dli.dli_saddr;
4984 }
4985 else if (dli_main.dli_fbase != dli.dli_fbase) {
4986 /* unresolved symbol from a known library, report relative offset */
4987 chunk_appendf(buf, "+%#lx", (long)(addr - dli.dli_fbase));
4988 return NULL;
4989 }
Baruch Siache1651b22020-07-24 07:52:20 +03004990#endif /* __ELF__ && !__linux__ || USE_DL */
Willy Tarreaueb8b1ca2020-03-03 17:09:08 +01004991 unknown:
4992 /* unresolved symbol from the main file, report relative offset to main */
4993 if ((void*)addr < (void*)main)
4994 chunk_appendf(buf, "main-%#lx", (long)((void*)main - addr));
4995 else
4996 chunk_appendf(buf, "main+%#lx", (long)(addr - (void*)main));
4997 return NULL;
Willy Tarreau0ebb5112016-12-05 00:10:57 +01004998}
4999
Willy Tarreau6ab7b212021-12-28 09:57:10 +01005000/* On systems where this is supported, let's provide a possibility to enumerate
5001 * the list of object files. The output is appended to a buffer initialized by
5002 * the caller, with one name per line. A trailing zero is always emitted if data
5003 * are written. Only real objects are dumped (executable and .so libs). The
5004 * function returns non-zero if it dumps anything. These functions do not make
5005 * use of the trash so that it is possible for the caller to call them with the
5006 * trash on input. The output format may be platform-specific but at least one
5007 * version must emit raw object file names when argument is zero.
5008 */
5009#if defined(HA_HAVE_DUMP_LIBS)
5010# if defined(HA_HAVE_DL_ITERATE_PHDR)
5011/* the private <data> we pass below is a dump context initialized like this */
5012struct dl_dump_ctx {
5013 struct buffer *buf;
5014 int with_addr;
5015};
5016
5017static int dl_dump_libs_cb(struct dl_phdr_info *info, size_t size, void *data)
5018{
5019 struct dl_dump_ctx *ctx = data;
5020 const char *fname;
5021 size_t p1, p2, beg, end;
5022 int idx;
5023
5024 if (!info || !info->dlpi_name)
5025 goto leave;
5026
5027 if (!*info->dlpi_name)
5028 fname = get_exec_path();
5029 else if (strchr(info->dlpi_name, '/'))
5030 fname = info->dlpi_name;
5031 else
5032 /* else it's a VDSO or similar and we're not interested */
5033 goto leave;
5034
5035 if (!ctx->with_addr)
5036 goto dump_name;
5037
5038 /* virtual addresses are relative to the load address and are per
5039 * pseudo-header, so we have to scan them all to find the furthest
5040 * one from the beginning. In this case we only dump entries if
5041 * they have at least one section.
5042 */
5043 beg = ~0; end = 0;
5044 for (idx = 0; idx < info->dlpi_phnum; idx++) {
5045 if (!info->dlpi_phdr[idx].p_memsz)
5046 continue;
5047 p1 = info->dlpi_phdr[idx].p_vaddr;
5048 if (p1 < beg)
5049 beg = p1;
5050 p2 = p1 + info->dlpi_phdr[idx].p_memsz - 1;
5051 if (p2 > end)
5052 end = p2;
5053 }
5054
5055 if (!idx)
5056 goto leave;
5057
5058 chunk_appendf(ctx->buf, "0x%012llx-0x%012llx (0x%07llx) ",
5059 (ullong)info->dlpi_addr + beg,
5060 (ullong)info->dlpi_addr + end,
5061 (ullong)(end - beg + 1));
5062 dump_name:
5063 chunk_appendf(ctx->buf, "%s\n", fname);
5064 leave:
5065 return 0;
5066}
5067
5068/* dumps lib names and optionally address ranges */
5069int dump_libs(struct buffer *output, int with_addr)
5070{
5071 struct dl_dump_ctx ctx = { .buf = output, .with_addr = with_addr };
5072 size_t old_data = output->data;
5073
5074 dl_iterate_phdr(dl_dump_libs_cb, &ctx);
5075 return output->data != old_data;
5076}
5077# else // no DL_ITERATE_PHDR
5078# error "No dump_libs() function for this platform"
5079# endif
5080#else // no HA_HAVE_DUMP_LIBS
5081
5082/* unsupported platform: do not dump anything */
5083int dump_libs(struct buffer *output, int with_addr)
5084{
5085 return 0;
5086}
5087
5088#endif // HA_HAVE_DUMP_LIBS
5089
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005090/*
5091 * Allocate an array of unsigned int with <nums> as address from <str> string
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05005092 * made of integer separated by dot characters.
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005093 *
5094 * First, initializes the value with <sz> as address to 0 and initializes the
5095 * array with <nums> as address to NULL. Then allocates the array with <nums> as
5096 * address updating <sz> pointed value to the size of this array.
5097 *
5098 * Returns 1 if succeeded, 0 if not.
5099 */
5100int parse_dotted_uints(const char *str, unsigned int **nums, size_t *sz)
5101{
5102 unsigned int *n;
5103 const char *s, *end;
5104
5105 s = str;
5106 *sz = 0;
5107 end = str + strlen(str);
5108 *nums = n = NULL;
5109
5110 while (1) {
5111 unsigned int r;
5112
5113 if (s >= end)
5114 break;
5115
5116 r = read_uint(&s, end);
5117 /* Expected characters after having read an uint: '\0' or '.',
5118 * if '.', must not be terminal.
5119 */
Christopher Faulet4b524122021-02-11 10:42:41 +01005120 if (*s != '\0'&& (*s++ != '.' || s == end)) {
5121 free(n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005122 return 0;
Christopher Faulet4b524122021-02-11 10:42:41 +01005123 }
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005124
Frédéric Lécaille12a71842019-02-26 18:19:48 +01005125 n = my_realloc2(n, (*sz + 1) * sizeof *n);
Frédéric Lécaille3b717162019-02-25 15:04:22 +01005126 if (!n)
5127 return 0;
5128
5129 n[(*sz)++] = r;
5130 }
5131 *nums = n;
5132
5133 return 1;
5134}
5135
Willy Tarreau4d589e72019-08-23 19:02:26 +02005136
5137/* returns the number of bytes needed to encode <v> as a varint. An inline
5138 * version exists for use with constants (__varint_bytes()).
5139 */
5140int varint_bytes(uint64_t v)
5141{
5142 int len = 1;
5143
5144 if (v >= 240) {
5145 v = (v - 240) >> 4;
5146 while (1) {
5147 len++;
5148 if (v < 128)
5149 break;
5150 v = (v - 128) >> 7;
5151 }
5152 }
5153 return len;
5154}
5155
Willy Tarreau52bf8392020-03-08 00:42:37 +01005156
5157/* Random number generator state, see below */
Willy Tarreau1544c142020-03-12 00:31:18 +01005158static uint64_t ha_random_state[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01005159
5160/* This is a thread-safe implementation of xoroshiro128** described below:
5161 * http://prng.di.unimi.it/
5162 * It features a 2^128 long sequence, returns 64 high-quality bits on each call,
5163 * supports fast jumps and passes all common quality tests. It is thread-safe,
5164 * uses a double-cas on 64-bit architectures supporting it, and falls back to a
5165 * local lock on other ones.
5166 */
5167uint64_t ha_random64()
5168{
Willy Tarreau1544c142020-03-12 00:31:18 +01005169 uint64_t old[2] ALIGNED(2*sizeof(uint64_t));
5170 uint64_t new[2] ALIGNED(2*sizeof(uint64_t));
Willy Tarreau52bf8392020-03-08 00:42:37 +01005171
5172#if defined(USE_THREAD) && (!defined(HA_CAS_IS_8B) || !defined(HA_HAVE_CAS_DW))
5173 static HA_SPINLOCK_T rand_lock;
5174
5175 HA_SPIN_LOCK(OTHER_LOCK, &rand_lock);
5176#endif
5177
5178 old[0] = ha_random_state[0];
5179 old[1] = ha_random_state[1];
5180
5181#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
5182 do {
5183#endif
Willy Tarreau52bf8392020-03-08 00:42:37 +01005184 new[1] = old[0] ^ old[1];
5185 new[0] = rotl64(old[0], 24) ^ new[1] ^ (new[1] << 16); // a, b
5186 new[1] = rotl64(new[1], 37); // c
5187
5188#if defined(USE_THREAD) && defined(HA_CAS_IS_8B) && defined(HA_HAVE_CAS_DW)
5189 } while (unlikely(!_HA_ATOMIC_DWCAS(ha_random_state, old, new)));
5190#else
5191 ha_random_state[0] = new[0];
5192 ha_random_state[1] = new[1];
5193#if defined(USE_THREAD)
5194 HA_SPIN_UNLOCK(OTHER_LOCK, &rand_lock);
5195#endif
5196#endif
Willy Tarreaub2475a12021-05-09 10:26:14 +02005197 return rotl64(old[0] * 5, 7) * 9;
Willy Tarreau52bf8392020-03-08 00:42:37 +01005198}
5199
5200/* seeds the random state using up to <len> bytes from <seed>, starting with
5201 * the first non-zero byte.
5202 */
5203void ha_random_seed(const unsigned char *seed, size_t len)
5204{
5205 size_t pos;
5206
5207 /* the seed must not be all zeroes, so we pre-fill it with alternating
5208 * bits and overwrite part of them with the block starting at the first
5209 * non-zero byte from the seed.
5210 */
5211 memset(ha_random_state, 0x55, sizeof(ha_random_state));
5212
5213 for (pos = 0; pos < len; pos++)
5214 if (seed[pos] != 0)
5215 break;
5216
5217 if (pos == len)
5218 return;
5219
5220 seed += pos;
5221 len -= pos;
5222
5223 if (len > sizeof(ha_random_state))
5224 len = sizeof(ha_random_state);
5225
5226 memcpy(ha_random_state, seed, len);
5227}
5228
5229/* This causes a jump to (dist * 2^96) places in the pseudo-random sequence,
5230 * and is equivalent to calling ha_random64() as many times. It is used to
5231 * provide non-overlapping sequences of 2^96 numbers (~7*10^28) to up to 2^32
5232 * different generators (i.e. different processes after a fork). The <dist>
5233 * argument is the distance to jump to and is used in a loop so it rather not
5234 * be too large if the processing time is a concern.
5235 *
5236 * BEWARE: this function is NOT thread-safe and must not be called during
5237 * concurrent accesses to ha_random64().
5238 */
5239void ha_random_jump96(uint32_t dist)
5240{
5241 while (dist--) {
5242 uint64_t s0 = 0;
5243 uint64_t s1 = 0;
5244 int b;
5245
5246 for (b = 0; b < 64; b++) {
5247 if ((0xd2a98b26625eee7bULL >> b) & 1) {
5248 s0 ^= ha_random_state[0];
5249 s1 ^= ha_random_state[1];
5250 }
5251 ha_random64();
5252 }
5253
5254 for (b = 0; b < 64; b++) {
5255 if ((0xdddf9b1090aa7ac1ULL >> b) & 1) {
5256 s0 ^= ha_random_state[0];
5257 s1 ^= ha_random_state[1];
5258 }
5259 ha_random64();
5260 }
5261 ha_random_state[0] = s0;
5262 ha_random_state[1] = s1;
5263 }
5264}
5265
Willy Tarreauee3bcdd2020-03-08 17:48:17 +01005266/* Generates an RFC4122 UUID into chunk <output> which must be at least 37
5267 * bytes large.
5268 */
5269void ha_generate_uuid(struct buffer *output)
5270{
5271 uint32_t rnd[4];
5272 uint64_t last;
5273
5274 last = ha_random64();
5275 rnd[0] = last;
5276 rnd[1] = last >> 32;
5277
5278 last = ha_random64();
5279 rnd[2] = last;
5280 rnd[3] = last >> 32;
5281
5282 chunk_printf(output, "%8.8x-%4.4x-%4.4x-%4.4x-%12.12llx",
5283 rnd[0],
5284 rnd[1] & 0xFFFF,
5285 ((rnd[1] >> 16u) & 0xFFF) | 0x4000, // highest 4 bits indicate the uuid version
5286 (rnd[2] & 0x3FFF) | 0x8000, // the highest 2 bits indicate the UUID variant (10),
5287 (long long)((rnd[2] >> 14u) | ((uint64_t) rnd[3] << 18u)) & 0xFFFFFFFFFFFFull);
5288}
5289
5290
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005291/* only used by parse_line() below. It supports writing in place provided that
5292 * <in> is updated to the next location before calling it. In that case, the
5293 * char at <in> may be overwritten.
5294 */
5295#define EMIT_CHAR(x) \
5296 do { \
5297 char __c = (char)(x); \
5298 if ((opts & PARSE_OPT_INPLACE) && out+outpos > in) \
5299 err |= PARSE_ERR_OVERLAP; \
5300 if (outpos >= outmax) \
5301 err |= PARSE_ERR_TOOLARGE; \
5302 if (!err) \
5303 out[outpos] = __c; \
5304 outpos++; \
5305 } while (0)
5306
Ilya Shipitsin46a030c2020-07-05 16:36:08 +05005307/* Parse <in>, copy it into <out> split into isolated words whose pointers
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005308 * are put in <args>. If more than <outlen> bytes have to be emitted, the
5309 * extraneous ones are not emitted but <outlen> is updated so that the caller
5310 * knows how much to realloc. Similarly, <args> are not updated beyond <nbargs>
5311 * but the returned <nbargs> indicates how many were found. All trailing args
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005312 * up to <nbargs> point to the trailing zero, and as long as <nbargs> is > 0,
5313 * it is guaranteed that at least one arg will point to the zero. It is safe
5314 * to call it with a NULL <args> if <nbargs> is 0.
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005315 *
5316 * <out> may overlap with <in> provided that it never goes further, in which
5317 * case the parser will accept to perform in-place parsing and unquoting/
5318 * unescaping but only if environment variables do not lead to expansion that
5319 * causes overlapping, otherwise the input string being destroyed, the error
5320 * will not be recoverable. Note that even during out-of-place <in> will
5321 * experience temporary modifications in-place for variable resolution and must
5322 * be writable, and will also receive zeroes to delimit words when using
5323 * in-place copy. Parsing options <opts> taken from PARSE_OPT_*. Return value
5324 * is zero on success otherwise a bitwise-or of PARSE_ERR_*. Upon error, the
5325 * starting point of the first invalid character sequence or unmatched
5326 * quote/brace is reported in <errptr> if not NULL. When using in-place parsing
5327 * error reporting might be difficult since zeroes will have been inserted into
5328 * the string. One solution for the caller may consist in replacing all args
5329 * delimiters with spaces in this case.
5330 */
Maximilian Mader29c6cd72021-06-06 00:50:21 +02005331uint32_t parse_line(char *in, char *out, size_t *outlen, char **args, int *nbargs, uint32_t opts, const char **errptr)
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005332{
5333 char *quote = NULL;
5334 char *brace = NULL;
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005335 char *word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005336 unsigned char hex1, hex2;
5337 size_t outmax = *outlen;
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005338 int argsmax = *nbargs - 1;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005339 size_t outpos = 0;
5340 int squote = 0;
5341 int dquote = 0;
5342 int arg = 0;
5343 uint32_t err = 0;
5344
5345 *nbargs = 0;
5346 *outlen = 0;
5347
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005348 /* argsmax may be -1 here, protecting args[] from any write */
5349 if (arg < argsmax)
5350 args[arg] = out;
5351
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005352 while (1) {
5353 if (*in >= '-' && *in != '\\') {
5354 /* speedup: directly send all regular chars starting
5355 * with '-', '.', '/', alnum etc...
5356 */
5357 EMIT_CHAR(*in++);
5358 continue;
5359 }
5360 else if (*in == '\0' || *in == '\n' || *in == '\r') {
5361 /* end of line */
5362 break;
5363 }
5364 else if (*in == '#' && (opts & PARSE_OPT_SHARP) && !squote && !dquote) {
5365 /* comment */
5366 break;
5367 }
5368 else if (*in == '"' && !squote && (opts & PARSE_OPT_DQUOTE)) { /* double quote outside single quotes */
5369 if (dquote) {
5370 dquote = 0;
5371 quote = NULL;
5372 }
5373 else {
5374 dquote = 1;
5375 quote = in;
5376 }
5377 in++;
5378 continue;
5379 }
5380 else if (*in == '\'' && !dquote && (opts & PARSE_OPT_SQUOTE)) { /* single quote outside double quotes */
5381 if (squote) {
5382 squote = 0;
5383 quote = NULL;
5384 }
5385 else {
5386 squote = 1;
5387 quote = in;
5388 }
5389 in++;
5390 continue;
5391 }
5392 else if (*in == '\\' && !squote && (opts & PARSE_OPT_BKSLASH)) {
5393 /* first, we'll replace \\, \<space>, \#, \r, \n, \t, \xXX with their
5394 * C equivalent value but only when they have a special meaning and within
5395 * double quotes for some of them. Other combinations left unchanged (eg: \1).
5396 */
5397 char tosend = *in;
5398
5399 switch (in[1]) {
5400 case ' ':
5401 case '\\':
5402 tosend = in[1];
5403 in++;
5404 break;
5405
5406 case 't':
5407 tosend = '\t';
5408 in++;
5409 break;
5410
5411 case 'n':
5412 tosend = '\n';
5413 in++;
5414 break;
5415
5416 case 'r':
5417 tosend = '\r';
5418 in++;
5419 break;
5420
5421 case '#':
5422 /* escaping of "#" only if comments are supported */
5423 if (opts & PARSE_OPT_SHARP)
5424 in++;
5425 tosend = *in;
5426 break;
5427
5428 case '\'':
5429 /* escaping of "'" only outside single quotes and only if single quotes are supported */
5430 if (opts & PARSE_OPT_SQUOTE && !squote)
5431 in++;
5432 tosend = *in;
5433 break;
5434
5435 case '"':
5436 /* escaping of '"' only outside single quotes and only if double quotes are supported */
5437 if (opts & PARSE_OPT_DQUOTE && !squote)
5438 in++;
5439 tosend = *in;
5440 break;
5441
5442 case '$':
5443 /* escaping of '$' only inside double quotes and only if env supported */
5444 if (opts & PARSE_OPT_ENV && dquote)
5445 in++;
5446 tosend = *in;
5447 break;
5448
5449 case 'x':
5450 if (!ishex(in[2]) || !ishex(in[3])) {
5451 /* invalid or incomplete hex sequence */
5452 err |= PARSE_ERR_HEX;
5453 if (errptr)
5454 *errptr = in;
5455 goto leave;
5456 }
Willy Tarreauf278eec2020-07-05 21:46:32 +02005457 hex1 = toupper((unsigned char)in[2]) - '0';
5458 hex2 = toupper((unsigned char)in[3]) - '0';
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005459 if (hex1 > 9) hex1 -= 'A' - '9' - 1;
5460 if (hex2 > 9) hex2 -= 'A' - '9' - 1;
5461 tosend = (hex1 << 4) + hex2;
5462 in += 3;
5463 break;
5464
5465 default:
5466 /* other combinations are not escape sequences */
5467 break;
5468 }
5469
5470 in++;
5471 EMIT_CHAR(tosend);
5472 }
5473 else if (isspace((unsigned char)*in) && !squote && !dquote) {
5474 /* a non-escaped space is an argument separator */
5475 while (isspace((unsigned char)*in))
5476 in++;
5477 EMIT_CHAR(0);
5478 arg++;
5479 if (arg < argsmax)
5480 args[arg] = out + outpos;
5481 else
5482 err |= PARSE_ERR_TOOMANY;
5483 }
5484 else if (*in == '$' && (opts & PARSE_OPT_ENV) && (dquote || !(opts & PARSE_OPT_DQUOTE))) {
5485 /* environment variables are evaluated anywhere, or only
5486 * inside double quotes if they are supported.
5487 */
5488 char *var_name;
5489 char save_char;
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005490 const char *value;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005491
5492 in++;
5493
5494 if (*in == '{')
5495 brace = in++;
5496
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005497 if (!isalpha((unsigned char)*in) && *in != '_' && *in != '.') {
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005498 /* unacceptable character in variable name */
5499 err |= PARSE_ERR_VARNAME;
5500 if (errptr)
5501 *errptr = in;
5502 goto leave;
5503 }
5504
5505 var_name = in;
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005506 if (*in == '.')
5507 in++;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005508 while (isalnum((unsigned char)*in) || *in == '_')
5509 in++;
5510
5511 save_char = *in;
5512 *in = '\0';
Willy Tarreaua46f1af2021-05-06 10:25:11 +02005513 if (unlikely(*var_name == '.')) {
5514 /* internal pseudo-variables */
5515 if (strcmp(var_name, ".LINE") == 0)
5516 value = ultoa(global.cfg_curr_line);
5517 else if (strcmp(var_name, ".FILE") == 0)
5518 value = global.cfg_curr_file;
5519 else if (strcmp(var_name, ".SECTION") == 0)
5520 value = global.cfg_curr_section;
5521 else {
5522 /* unsupported internal variable name */
5523 err |= PARSE_ERR_VARNAME;
5524 if (errptr)
5525 *errptr = var_name;
5526 goto leave;
5527 }
5528 } else {
5529 value = getenv(var_name);
5530 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005531 *in = save_char;
5532
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005533 /* support for '[*]' sequence to force word expansion,
5534 * only available inside braces */
5535 if (*in == '[' && brace && (opts & PARSE_OPT_WORD_EXPAND)) {
5536 word_expand = in++;
5537
5538 if (*in++ != '*' || *in++ != ']') {
5539 err |= PARSE_ERR_WRONG_EXPAND;
5540 if (errptr)
5541 *errptr = word_expand;
5542 goto leave;
5543 }
5544 }
5545
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005546 if (brace) {
Willy Tarreauec347b12021-11-18 17:42:50 +01005547 if (*in == '-') {
5548 /* default value starts just after the '-' */
5549 if (!value)
5550 value = in + 1;
5551
5552 while (*in && *in != '}')
5553 in++;
5554 if (!*in)
5555 goto no_brace;
5556 *in = 0; // terminate the default value
5557 }
5558 else if (*in != '}') {
5559 no_brace:
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005560 /* unmatched brace */
5561 err |= PARSE_ERR_BRACE;
5562 if (errptr)
5563 *errptr = brace;
5564 goto leave;
5565 }
Willy Tarreauec347b12021-11-18 17:42:50 +01005566
5567 /* brace found, skip it */
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005568 in++;
5569 brace = NULL;
5570 }
5571
5572 if (value) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005573 while (*value) {
5574 /* expand as individual parameters on a space character */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005575 if (word_expand && isspace((unsigned char)*value)) {
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005576 EMIT_CHAR(0);
5577 ++arg;
5578 if (arg < argsmax)
5579 args[arg] = out + outpos;
5580 else
5581 err |= PARSE_ERR_TOOMANY;
5582
5583 /* skip consecutive spaces */
Willy Tarreaufe2cc412020-10-01 18:04:40 +02005584 while (isspace((unsigned char)*++value))
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005585 ;
5586 } else {
5587 EMIT_CHAR(*value++);
5588 }
5589 }
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005590 }
Amaury Denoyellefa41cb62020-10-01 14:32:35 +02005591 word_expand = NULL;
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005592 }
5593 else {
5594 /* any other regular char */
5595 EMIT_CHAR(*in++);
5596 }
5597 }
5598
5599 /* end of output string */
5600 EMIT_CHAR(0);
5601 arg++;
5602
5603 if (quote) {
5604 /* unmatched quote */
5605 err |= PARSE_ERR_QUOTE;
5606 if (errptr)
5607 *errptr = quote;
5608 goto leave;
5609 }
5610 leave:
5611 *nbargs = arg;
5612 *outlen = outpos;
5613
Willy Tarreau61dd44b2020-06-25 07:35:42 +02005614 /* empty all trailing args by making them point to the trailing zero,
5615 * at least the last one in any case.
5616 */
5617 if (arg > argsmax)
5618 arg = argsmax;
5619
5620 while (arg >= 0 && arg <= argsmax)
Willy Tarreauc8d167b2020-06-16 16:27:26 +02005621 args[arg++] = out + outpos - 1;
5622
5623 return err;
5624}
5625#undef EMIT_CHAR
5626
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005627/* This is used to sanitize an input line that's about to be used for error reporting.
5628 * It will adjust <line> to print approximately <width> chars around <pos>, trying to
5629 * preserve the beginning, with leading or trailing "..." when the line is truncated.
5630 * If non-printable chars are present in the output. It returns the new offset <pos>
5631 * in the modified line. Non-printable characters are replaced with '?'. <width> must
5632 * be at least 6 to support two "..." otherwise the result is undefined. The line
5633 * itself must have at least 7 chars allocated for the same reason.
5634 */
5635size_t sanitize_for_printing(char *line, size_t pos, size_t width)
5636{
5637 size_t shift = 0;
5638 char *out = line;
5639 char *in = line;
5640 char *end = line + width;
5641
5642 if (pos >= width) {
5643 /* if we have to shift, we'll be out of context, so let's
5644 * try to put <pos> at the center of width.
5645 */
5646 shift = pos - width / 2;
5647 in += shift + 3;
5648 end = out + width - 3;
5649 out[0] = out[1] = out[2] = '.';
5650 out += 3;
5651 }
5652
5653 while (out < end && *in) {
5654 if (isspace((unsigned char)*in))
5655 *out++ = ' ';
5656 else if (isprint((unsigned char)*in))
5657 *out++ = *in;
5658 else
5659 *out++ = '?';
5660 in++;
5661 }
5662
5663 if (end < line + width) {
5664 out[0] = out[1] = out[2] = '.';
5665 out += 3;
5666 }
5667
5668 *out++ = 0;
5669 return pos - shift;
5670}
Willy Tarreau06e69b52021-03-02 14:01:35 +01005671
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005672/* Update array <fp> with the fingerprint of word <word> by counting the
Willy Tarreauba2c4452021-03-12 09:01:52 +01005673 * transitions between characters. <fp> is a 1024-entries array indexed as
5674 * 32*from+to. Positions for 'from' and 'to' are:
Willy Tarreau9294e882021-03-15 09:34:27 +01005675 * 1..26=letter, 27=digit, 28=other/begin/end.
5676 * Row "from=0" is used to mark the character's presence. Others unused.
Willy Tarreauba2c4452021-03-12 09:01:52 +01005677 */
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005678void update_word_fingerprint(uint8_t *fp, const char *word)
Willy Tarreauba2c4452021-03-12 09:01:52 +01005679{
5680 const char *p;
5681 int from, to;
5682 int c;
5683
Willy Tarreauba2c4452021-03-12 09:01:52 +01005684 from = 28; // begin
5685 for (p = word; *p; p++) {
5686 c = tolower(*p);
5687 switch(c) {
Willy Tarreau9294e882021-03-15 09:34:27 +01005688 case 'a'...'z': to = c - 'a' + 1; break;
5689 case 'A'...'Z': to = tolower(c) - 'a' + 1; break;
5690 case '0'...'9': to = 27; break;
5691 default: to = 28; break;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005692 }
Willy Tarreau9294e882021-03-15 09:34:27 +01005693 fp[to] = 1;
Willy Tarreauba2c4452021-03-12 09:01:52 +01005694 fp[32 * from + to]++;
5695 from = to;
5696 }
5697 to = 28; // end
5698 fp[32 * from + to]++;
5699}
5700
Willy Tarreaue33c4b32021-03-12 18:59:31 +01005701/* Initialize array <fp> with the fingerprint of word <word> by counting the
5702 * transitions between characters. <fp> is a 1024-entries array indexed as
5703 * 32*from+to. Positions for 'from' and 'to' are:
5704 * 0..25=letter, 26=digit, 27=other, 28=begin, 29=end, others unused.
5705 */
5706void make_word_fingerprint(uint8_t *fp, const char *word)
5707{
5708 memset(fp, 0, 1024);
5709 update_word_fingerprint(fp, word);
5710}
5711
Willy Tarreauba2c4452021-03-12 09:01:52 +01005712/* Return the distance between two word fingerprints created by function
5713 * make_word_fingerprint(). It's a positive integer calculated as the sum of
Willy Tarreau714c4c12021-03-15 09:44:53 +01005714 * the differences between each location.
Willy Tarreauba2c4452021-03-12 09:01:52 +01005715 */
5716int word_fingerprint_distance(const uint8_t *fp1, const uint8_t *fp2)
5717{
5718 int i, k, dist = 0;
5719
5720 for (i = 0; i < 1024; i++) {
5721 k = (int)fp1[i] - (int)fp2[i];
Willy Tarreau714c4c12021-03-15 09:44:53 +01005722 dist += abs(k);
Willy Tarreauba2c4452021-03-12 09:01:52 +01005723 }
5724 return dist;
5725}
5726
William Lallemand3aeb3f92021-08-21 23:59:56 +02005727/*
5728 * This function compares the loaded openssl version with a string <version>
5729 * This function use the same return code as compare_current_version:
5730 *
5731 * -1 : the version in argument is older than the current openssl version
5732 * 0 : the version in argument is the same as the current openssl version
5733 * 1 : the version in argument is newer than the current openssl version
5734 *
5735 * Or some errors:
5736 * -2 : openssl is not available on this process
5737 * -3 : the version in argument is not parsable
5738 */
5739int openssl_compare_current_version(const char *version)
5740{
5741#ifdef USE_OPENSSL
5742 int numversion;
5743
5744 numversion = openssl_version_parser(version);
5745 if (numversion == 0)
5746 return -3;
5747
5748 if (numversion < OPENSSL_VERSION_NUMBER)
5749 return -1;
5750 else if (numversion > OPENSSL_VERSION_NUMBER)
5751 return 1;
5752 else
5753 return 0;
5754#else
5755 return -2;
5756#endif
5757}
5758
Remi Tricot-Le Bretonb01179a2021-10-11 15:34:12 +02005759/*
5760 * This function compares the loaded openssl name with a string <name>
5761 * This function returns 0 if the OpenSSL name starts like the passed parameter,
5762 * 1 otherwise.
5763 */
5764int openssl_compare_current_name(const char *name)
5765{
5766#ifdef USE_OPENSSL
5767 int name_len = 0;
5768 const char *openssl_version = OpenSSL_version(OPENSSL_VERSION);
5769
5770 if (name) {
5771 name_len = strlen(name);
5772 if (strlen(name) <= strlen(openssl_version))
5773 return strncmp(openssl_version, name, name_len);
5774 }
5775#endif
5776 return 1;
5777}
5778
Willy Tarreau06e69b52021-03-02 14:01:35 +01005779static int init_tools_per_thread()
5780{
5781 /* Let's make each thread start from a different position */
5782 statistical_prng_state += tid * MAX_THREADS;
5783 if (!statistical_prng_state)
5784 statistical_prng_state++;
5785 return 1;
5786}
5787REGISTER_PER_THREAD_INIT(init_tools_per_thread);
Willy Tarreauc54e5ad2020-06-25 09:15:40 +02005788
Willy Tarreaubaaee002006-06-26 02:48:02 +02005789/*
5790 * Local variables:
5791 * c-indent-level: 8
5792 * c-basic-offset: 8
5793 * End:
5794 */