blob: ce3c6b85b0c96e90799c8821472f4284180faa7c [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreaucc05fba2009-10-27 21:40:18 +01002 * include/common/standard.h
3 * This files contains some general purpose functions and macros.
4 *
5 * Copyright (C) 2000-2009 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020021
Willy Tarreau2dd0d472006-06-29 17:53:05 +020022#ifndef _COMMON_STANDARD_H
23#define _COMMON_STANDARD_H
Willy Tarreaubaaee002006-06-26 02:48:02 +020024
Willy Tarreau167d8b52007-04-09 22:16:12 +020025#include <limits.h>
Willy Tarreaufe944602007-10-25 10:34:16 +020026#include <time.h>
Willy Tarreau938b3032007-05-10 06:39:03 +020027#include <sys/types.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020028#include <netinet/in.h>
Willy Tarreaue3ba5f02006-06-29 18:54:54 +020029#include <common/config.h>
Willy Tarreau45cb4fb2009-10-26 21:10:04 +010030#include <eb32tree.h>
Willy Tarreauca28d1e2007-01-24 18:20:50 +010031#include <proto/fd.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020032
33/****** string-specific macros and functions ******/
34/* if a > max, then bound <a> to <max>. The macro returns the new <a> */
35#define UBOUND(a, max) ({ typeof(a) b = (max); if ((a) > b) (a) = b; (a); })
36
37/* if a < min, then bound <a> to <min>. The macro returns the new <a> */
38#define LBOUND(a, min) ({ typeof(a) b = (min); if ((a) < b) (a) = b; (a); })
39
40/* returns 1 only if only zero or one bit is set in X, which means that X is a
41 * power of 2, and 0 otherwise */
42#define POWEROF2(x) (((x) & ((x)-1)) == 0)
43
Willy Tarreau7d58a632007-01-13 23:06:06 +010044/*
Willy Tarreaubaaee002006-06-26 02:48:02 +020045 * copies at most <size-1> chars from <src> to <dst>. Last char is always
46 * set to 0, unless <size> is 0. The number of chars copied is returned
47 * (excluding the terminating zero).
48 * This code has been optimized for size and speed : on x86, it's 45 bytes
49 * long, uses only registers, and consumes only 4 cycles per char.
50 */
51extern int strlcpy2(char *dst, const char *src, int size);
52
53/*
Willy Tarreau72d759c2007-10-25 12:14:10 +020054 * This function simply returns a locally allocated string containing
Willy Tarreaubaaee002006-06-26 02:48:02 +020055 * the ascii representation for number 'n' in decimal.
56 */
Willy Tarreaue7239b52009-03-29 13:41:58 +020057extern char itoa_str[][171];
Willy Tarreau72d759c2007-10-25 12:14:10 +020058extern const char *ultoa_r(unsigned long n, char *buffer, int size);
Willy Tarreaue7239b52009-03-29 13:41:58 +020059extern const char *ulltoh_r(unsigned long long n, char *buffer, int size);
Willy Tarreau72d759c2007-10-25 12:14:10 +020060static inline const char *ultoa(unsigned long n)
61{
62 return ultoa_r(n, itoa_str[0], sizeof(itoa_str[0]));
63}
64
65/* Fast macros to convert up to 10 different parameters inside a same call of
66 * expression.
67 */
68#define U2A0(n) ({ ultoa_r((n), itoa_str[0], sizeof(itoa_str[0])); })
69#define U2A1(n) ({ ultoa_r((n), itoa_str[1], sizeof(itoa_str[1])); })
70#define U2A2(n) ({ ultoa_r((n), itoa_str[2], sizeof(itoa_str[2])); })
71#define U2A3(n) ({ ultoa_r((n), itoa_str[3], sizeof(itoa_str[3])); })
72#define U2A4(n) ({ ultoa_r((n), itoa_str[4], sizeof(itoa_str[4])); })
73#define U2A5(n) ({ ultoa_r((n), itoa_str[5], sizeof(itoa_str[5])); })
74#define U2A6(n) ({ ultoa_r((n), itoa_str[6], sizeof(itoa_str[6])); })
75#define U2A7(n) ({ ultoa_r((n), itoa_str[7], sizeof(itoa_str[7])); })
76#define U2A8(n) ({ ultoa_r((n), itoa_str[8], sizeof(itoa_str[8])); })
77#define U2A9(n) ({ ultoa_r((n), itoa_str[9], sizeof(itoa_str[9])); })
Willy Tarreaubaaee002006-06-26 02:48:02 +020078
Willy Tarreaue7239b52009-03-29 13:41:58 +020079/* The same macros provide HTML encoding of numbers */
80#define U2H0(n) ({ ulltoh_r((n), itoa_str[0], sizeof(itoa_str[0])); })
81#define U2H1(n) ({ ulltoh_r((n), itoa_str[1], sizeof(itoa_str[1])); })
82#define U2H2(n) ({ ulltoh_r((n), itoa_str[2], sizeof(itoa_str[2])); })
83#define U2H3(n) ({ ulltoh_r((n), itoa_str[3], sizeof(itoa_str[3])); })
84#define U2H4(n) ({ ulltoh_r((n), itoa_str[4], sizeof(itoa_str[4])); })
85#define U2H5(n) ({ ulltoh_r((n), itoa_str[5], sizeof(itoa_str[5])); })
86#define U2H6(n) ({ ulltoh_r((n), itoa_str[6], sizeof(itoa_str[6])); })
87#define U2H7(n) ({ ulltoh_r((n), itoa_str[7], sizeof(itoa_str[7])); })
88#define U2H8(n) ({ ulltoh_r((n), itoa_str[8], sizeof(itoa_str[8])); })
89#define U2H9(n) ({ ulltoh_r((n), itoa_str[9], sizeof(itoa_str[9])); })
90
Willy Tarreaubaaee002006-06-26 02:48:02 +020091/*
Willy Tarreau91092e52007-10-25 16:58:42 +020092 * This function simply returns a locally allocated string containing the ascii
93 * representation for number 'n' in decimal, unless n is 0 in which case it
94 * returns the alternate string (or an empty string if the alternate string is
95 * NULL). It use is intended for limits reported in reports, where it's
96 * desirable not to display anything if there is no limit. Warning! it shares
97 * the same vector as ultoa_r().
98 */
99extern const char *limit_r(unsigned long n, char *buffer, int size, const char *alt);
100
101/* Fast macros to convert up to 10 different parameters inside a same call of
102 * expression. Warning! they share the same vectors as U2A*!
103 */
104#define LIM2A0(n, alt) ({ limit_r((n), itoa_str[0], sizeof(itoa_str[0]), (alt)); })
105#define LIM2A1(n, alt) ({ limit_r((n), itoa_str[1], sizeof(itoa_str[1]), (alt)); })
106#define LIM2A2(n, alt) ({ limit_r((n), itoa_str[2], sizeof(itoa_str[2]), (alt)); })
107#define LIM2A3(n, alt) ({ limit_r((n), itoa_str[3], sizeof(itoa_str[3]), (alt)); })
108#define LIM2A4(n, alt) ({ limit_r((n), itoa_str[4], sizeof(itoa_str[4]), (alt)); })
109#define LIM2A5(n, alt) ({ limit_r((n), itoa_str[5], sizeof(itoa_str[5]), (alt)); })
110#define LIM2A6(n, alt) ({ limit_r((n), itoa_str[6], sizeof(itoa_str[6]), (alt)); })
111#define LIM2A7(n, alt) ({ limit_r((n), itoa_str[7], sizeof(itoa_str[7]), (alt)); })
112#define LIM2A8(n, alt) ({ limit_r((n), itoa_str[8], sizeof(itoa_str[8]), (alt)); })
113#define LIM2A9(n, alt) ({ limit_r((n), itoa_str[9], sizeof(itoa_str[9]), (alt)); })
114
115/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200116 * Returns non-zero if character <s> is a hex digit (0-9, a-f, A-F), else zero.
117 */
118extern int ishex(char s);
119
120/*
Willy Tarreauda3b7c32009-11-02 20:12:52 +0100121 * Return integer equivalent of character <c> for a hex digit (0-9, a-f, A-F),
122 * otherwise -1.
123 */
124extern int hex2i(int c);
125
126/*
Willy Tarreau2e74c3f2007-12-02 18:45:09 +0100127 * Checks <name> for invalid characters. Valid chars are [A-Za-z0-9_:.-]. If an
128 * invalid character is found, a pointer to it is returned. If everything is
129 * fine, NULL is returned.
130 */
131extern const char *invalid_char(const char *name);
132
133/*
Krzysztof Piotr Oledzkiefe3b6f2008-05-23 23:49:32 +0200134 * Checks <domainname> for invalid characters. Valid chars are [A-Za-z0-9_.-].
135 * If an invalid character is found, a pointer to it is returned.
136 * If everything is fine, NULL is returned.
137 */
138extern const char *invalid_domainchar(const char *name);
139
140/*
Robert Tsai81ae1952007-12-05 10:47:29 +0100141 * converts <str> to a struct sockaddr_un* which is locally allocated.
142 * The format is "/path", where "/path" is a path to a UNIX domain socket.
143 */
Willy Tarreaucaf720d2008-03-07 10:07:04 +0100144struct sockaddr_un *str2sun(const char *str);
Robert Tsai81ae1952007-12-05 10:47:29 +0100145
146/*
Willy Tarreaubaaee002006-06-26 02:48:02 +0200147 * converts <str> to a struct sockaddr_in* which is locally allocated.
148 * The format is "addr:port", where "addr" can be a dotted IPv4 address,
149 * a host name, or empty or "*" to indicate INADDR_ANY.
150 */
151struct sockaddr_in *str2sa(char *str);
152
153/*
Willy Tarreauc6f4ce82009-06-10 11:09:37 +0200154 * converts <str> to a struct sockaddr_in* which is locally allocated, and a
155 * port range consisting in two integers. The low and high end are always set
156 * even if the port is unspecified, in which case (0,0) is returned. The low
157 * port is set in the sockaddr_in. Thus, it is enough to check the size of the
158 * returned range to know if an array must be allocated or not. The format is
159 * "addr[:port[-port]]", where "addr" can be a dotted IPv4 address, a host
160 * name, or empty or "*" to indicate INADDR_ANY.
161 */
162struct sockaddr_in *str2sa_range(char *str, int *low, int *high);
163
164/*
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200165 * converts <str> to two struct in_addr* which must be pre-allocated.
Willy Tarreaubaaee002006-06-26 02:48:02 +0200166 * The format is "addr[/mask]", where "addr" cannot be empty, and mask
167 * is optionnal and either in the dotted or CIDR notation.
168 * Note: "addr" can also be a hostname. Returns 1 if OK, 0 if error.
169 */
Willy Tarreaud077a8e2007-05-08 18:28:09 +0200170int str2net(const char *str, struct in_addr *addr, struct in_addr *mask);
Willy Tarreaubaaee002006-06-26 02:48:02 +0200171
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100172/*
Willy Tarreau106f9792009-09-19 07:54:16 +0200173 * Parse IP address found in url.
174 */
175int url2ip(const char *addr, struct in_addr *dst);
176
177/*
Alexandre Cassen5eb1a902007-11-29 15:43:32 +0100178 * Resolve destination server from URL. Convert <str> to a sockaddr_in*.
179 */
180int url2sa(const char *url, int ulen, struct sockaddr_in *addr);
181
Willy Tarreaubaaee002006-06-26 02:48:02 +0200182/* will try to encode the string <string> replacing all characters tagged in
183 * <map> with the hexadecimal representation of their ASCII-code (2 digits)
184 * prefixed by <escape>, and will store the result between <start> (included)
185 * and <stop> (excluded), and will always terminate the string with a '\0'
186 * before <stop>. The position of the '\0' is returned if the conversion
187 * completes. If bytes are missing between <start> and <stop>, then the
188 * conversion will be incomplete and truncated. If <stop> <= <start>, the '\0'
189 * cannot even be stored so we return <start> without writing the 0.
190 * The input string must also be zero-terminated.
191 */
192extern const char hextab[];
193char *encode_string(char *start, char *stop,
194 const char escape, const fd_set *map,
195 const char *string);
196
Willy Tarreau6911fa42007-03-04 18:06:08 +0100197/* This one is 6 times faster than strtoul() on athlon, but does
198 * no check at all.
199 */
200static inline unsigned int __str2ui(const char *s)
201{
202 unsigned int i = 0;
203 while (*s) {
204 i = i * 10 - '0';
205 i += (unsigned char)*s++;
206 }
207 return i;
208}
209
210/* This one is 5 times faster than strtoul() on athlon with checks.
211 * It returns the value of the number composed of all valid digits read.
212 */
213static inline unsigned int __str2uic(const char *s)
214{
215 unsigned int i = 0;
216 unsigned int j;
217 while (1) {
218 j = (*s++) - '0';
219 if (j > 9)
220 break;
221 i *= 10;
222 i += j;
223 }
224 return i;
225}
226
227/* This one is 28 times faster than strtoul() on athlon, but does
228 * no check at all!
229 */
230static inline unsigned int __strl2ui(const char *s, int len)
231{
232 unsigned int i = 0;
233 while (len-- > 0) {
234 i = i * 10 - '0';
235 i += (unsigned char)*s++;
236 }
237 return i;
238}
239
240/* This one is 7 times faster than strtoul() on athlon with checks.
241 * It returns the value of the number composed of all valid digits read.
242 */
243static inline unsigned int __strl2uic(const char *s, int len)
244{
245 unsigned int i = 0;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200246 unsigned int j, k;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100247
248 while (len-- > 0) {
249 j = (*s++) - '0';
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200250 k = i * 10;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100251 if (j > 9)
252 break;
Willy Tarreau3f0c9762007-10-25 09:42:24 +0200253 i = k + j;
Willy Tarreau6911fa42007-03-04 18:06:08 +0100254 }
255 return i;
256}
257
258extern unsigned int str2ui(const char *s);
259extern unsigned int str2uic(const char *s);
260extern unsigned int strl2ui(const char *s, int len);
261extern unsigned int strl2uic(const char *s, int len);
262extern int strl2ic(const char *s, int len);
263extern int strl2irc(const char *s, int len, int *ret);
264extern int strl2llrc(const char *s, int len, long long *ret);
265
Krzysztof Piotr Oledzki3d5562b2009-10-10 20:11:17 +0200266static inline char *cut_crlf(char *s) {
267
268 while (*s != '\r' || *s == '\n') {
269 char *p = s++;
270
271 if (!*p)
272 return p;
273 }
274
275 *s++ = 0;
276
277 return s;
278}
279
280static inline char *ltrim(char *s, char c) {
281
282 if (c)
283 while (*s == c)
284 s++;
285
286 return s;
287}
288
289static inline char *rtrim(char *s, char c) {
290
291 char *p = s + strlen(s);
292
293 while (p-- > s)
294 if (*p == c)
295 *p = '\0';
296 else
297 break;
298
299 return s;
300}
301
302static inline char *alltrim(char *s, char c) {
303
304 rtrim(s, c);
305
306 return ltrim(s, c);
307}
308
Willy Tarreaufe944602007-10-25 10:34:16 +0200309/* This function converts the time_t value <now> into a broken out struct tm
310 * which must be allocated by the caller. It is highly recommended to use this
311 * function intead of localtime() because that one requires a time_t* which
312 * is not always compatible with tv_sec depending on OS/hardware combinations.
313 */
314static inline void get_localtime(const time_t now, struct tm *tm)
315{
316 localtime_r(&now, tm);
317}
318
Emeric Brun3a058f32009-06-30 18:26:00 +0200319/* This function converts the time_t value <now> into a broken out struct tm
320 * which must be allocated by the caller. It is highly recommended to use this
321 * function intead of gmtime() because that one requires a time_t* which
322 * is not always compatible with tv_sec depending on OS/hardware combinations.
323 */
324static inline void get_gmtime(const time_t now, struct tm *tm)
325{
326 gmtime_r(&now, tm);
327}
328
Willy Tarreaua0d37b62007-12-02 22:00:35 +0100329/* This function parses a time value optionally followed by a unit suffix among
330 * "d", "h", "m", "s", "ms" or "us". It converts the value into the unit
331 * expected by the caller. The computation does its best to avoid overflows.
332 * The value is returned in <ret> if everything is fine, and a NULL is returned
333 * by the function. In case of error, a pointer to the error is returned and
334 * <ret> is left untouched.
335 */
336extern const char *parse_time_err(const char *text, unsigned *ret, unsigned unit_flags);
337
338/* unit flags to pass to parse_time_err */
339#define TIME_UNIT_US 0x0000
340#define TIME_UNIT_MS 0x0001
341#define TIME_UNIT_S 0x0002
342#define TIME_UNIT_MIN 0x0003
343#define TIME_UNIT_HOUR 0x0004
344#define TIME_UNIT_DAY 0x0005
345#define TIME_UNIT_MASK 0x0007
346
Willy Tarreau7f062c42009-03-05 18:43:00 +0100347/* Multiply the two 32-bit operands and shift the 64-bit result right 32 bits.
348 * This is used to compute fixed ratios by setting one of the operands to
349 * (2^32*ratio).
350 */
351static inline unsigned int mul32hi(unsigned int a, unsigned int b)
352{
353 return ((unsigned long long)a * b) >> 32;
354}
355
Willy Tarreau946ba592009-05-10 15:41:18 +0200356/* copies at most <n> characters from <src> and always terminates with '\0' */
357char *my_strndup(const char *src, int n);
358
Willy Tarreau482b00d2009-10-04 22:48:42 +0200359/* This function returns the first unused key greater than or equal to <key> in
360 * ID tree <root>. Zero is returned if no place is found.
361 */
362unsigned int get_next_id(struct eb_root *root, unsigned int key);
363
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200364#endif /* _COMMON_STANDARD_H */