Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 1 | #pragma once |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 2 | |
Neels Hofmeyr | 4335bad | 2017-10-07 04:39:14 +0200 | [diff] [blame] | 3 | #include <stdbool.h> |
Vadim Yanitskiy | 5594430 | 2018-09-05 02:58:03 +0700 | [diff] [blame] | 4 | #include <stdint.h> |
| 5 | #include <stdio.h> |
Neels Hofmeyr | 4335bad | 2017-10-07 04:39:14 +0200 | [diff] [blame] | 6 | |
Harald Welte | b8add36 | 2013-07-06 23:49:41 +0200 | [diff] [blame] | 7 | #include <osmocom/core/backtrace.h> |
Harald Welte | f3c7e85 | 2014-08-20 22:50:47 +0200 | [diff] [blame] | 8 | #include <osmocom/core/talloc.h> |
Harald Welte | 459a180 | 2018-06-28 09:24:17 +0200 | [diff] [blame] | 9 | #include <osmocom/core/panic.h> |
Neels Hofmeyr | 7c74989 | 2018-09-07 03:01:38 +0200 | [diff] [blame] | 10 | #include <osmocom/core/defs.h> |
Harald Welte | b8add36 | 2013-07-06 23:49:41 +0200 | [diff] [blame] | 11 | |
Harald Welte | 8598f18 | 2011-08-17 14:19:27 +0200 | [diff] [blame] | 12 | /*! \defgroup utils General-purpose utility functions |
| 13 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 14 | * \file utils.h */ |
Harald Welte | 8598f18 | 2011-08-17 14:19:27 +0200 | [diff] [blame] | 15 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 16 | /*! Determine number of elements in an array of static size */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 17 | #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 18 | /*! Return the maximum of two specified values */ |
Holger Hans Peter Freyther | 08b2862 | 2012-08-15 17:02:59 +0200 | [diff] [blame] | 19 | #define OSMO_MAX(a, b) ((a) >= (b) ? (a) : (b)) |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 20 | /*! Return the minimum of two specified values */ |
Holger Hans Peter Freyther | 08b2862 | 2012-08-15 17:02:59 +0200 | [diff] [blame] | 21 | #define OSMO_MIN(a, b) ((a) >= (b) ? (b) : (a)) |
Neels Hofmeyr | dc75b11 | 2017-12-09 05:51:42 +0100 | [diff] [blame] | 22 | /*! Stringify the name of a macro x, e.g. an FSM event name. |
| 23 | * Note: if nested within another preprocessor macro, this will |
| 24 | * stringify the value of x instead of its name. */ |
Neels Hofmeyr | 1808096 | 2016-12-16 13:43:54 +0100 | [diff] [blame] | 25 | #define OSMO_STRINGIFY(x) #x |
Neels Hofmeyr | 84ea2e0 | 2017-12-09 05:53:18 +0100 | [diff] [blame] | 26 | /*! Stringify the value of a macro x, e.g. a port number. */ |
| 27 | #define OSMO_STRINGIFY_VAL(x) OSMO_STRINGIFY(x) |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 28 | /*! Make a value_string entry from an enum value name */ |
Neels Hofmeyr | 8a5d60b | 2017-03-09 23:01:37 +0100 | [diff] [blame] | 29 | #define OSMO_VALUE_STRING(x) { x, #x } |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 30 | /*! Number of bytes necessary to store given BITS */ |
Max | dd75bac | 2017-06-13 15:07:01 +0200 | [diff] [blame] | 31 | #define OSMO_BYTES_FOR_BITS(BITS) ((BITS + 8 - 1) / 8) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 32 | |
Max | 18c014d | 2018-01-30 14:33:01 +0100 | [diff] [blame] | 33 | /*! Copy a C-string into a sized buffer using sizeof to detect buffer's size */ |
| 34 | #define OSMO_STRLCPY_ARRAY(array, src) osmo_strlcpy(array, src, sizeof(array)) |
| 35 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 36 | /*! A mapping between human-readable string and numeric value */ |
Harald Welte | d284cd9 | 2010-03-01 21:58:31 +0100 | [diff] [blame] | 37 | struct value_string { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 38 | unsigned int value; /*!< numeric value */ |
| 39 | const char *str; /*!< human-readable string */ |
Harald Welte | d284cd9 | 2010-03-01 21:58:31 +0100 | [diff] [blame] | 40 | }; |
| 41 | |
| 42 | const char *get_value_string(const struct value_string *vs, uint32_t val); |
Neels Hofmeyr | 8d6dcd9 | 2016-06-06 18:05:23 +0200 | [diff] [blame] | 43 | const char *get_value_string_or_null(const struct value_string *vs, |
| 44 | uint32_t val); |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 45 | |
Harald Welte | d284cd9 | 2010-03-01 21:58:31 +0100 | [diff] [blame] | 46 | int get_string_value(const struct value_string *vs, const char *str); |
| 47 | |
Pablo Neira Ayuso | 87f7b25 | 2011-05-07 12:43:08 +0200 | [diff] [blame] | 48 | char osmo_bcd2char(uint8_t bcd); |
Harald Welte | a73e2f9 | 2010-03-04 10:50:32 +0100 | [diff] [blame] | 49 | /* only works for numbers in ascci */ |
Pablo Neira Ayuso | 87f7b25 | 2011-05-07 12:43:08 +0200 | [diff] [blame] | 50 | uint8_t osmo_char2bcd(char c); |
Harald Welte | d284cd9 | 2010-03-01 21:58:31 +0100 | [diff] [blame] | 51 | |
Neels Hofmeyr | 7079e69 | 2018-12-05 21:02:36 +0100 | [diff] [blame] | 52 | int osmo_bcd2str(char *dst, size_t dst_size, const uint8_t *bcd, int start_nibble, int end_nibble, bool allow_hex); |
| 53 | |
Pablo Neira Ayuso | 87f7b25 | 2011-05-07 12:43:08 +0200 | [diff] [blame] | 54 | int osmo_hexparse(const char *str, uint8_t *b, int max_len); |
Harald Welte | bd598e3 | 2011-08-16 23:26:52 +0200 | [diff] [blame] | 55 | |
Pablo Neira Ayuso | 87f7b25 | 2011-05-07 12:43:08 +0200 | [diff] [blame] | 56 | char *osmo_ubit_dump(const uint8_t *bits, unsigned int len); |
Harald Welte | 8598f18 | 2011-08-17 14:19:27 +0200 | [diff] [blame] | 57 | char *osmo_hexdump(const unsigned char *buf, int len); |
Sylvain Munaut | ff23d24 | 2011-11-10 23:03:18 +0100 | [diff] [blame] | 58 | char *osmo_hexdump_nospc(const unsigned char *buf, int len); |
Neels Hofmeyr | 0423b61 | 2019-01-14 23:32:53 +0100 | [diff] [blame] | 59 | const char *osmo_hexdump_buf(char *out_buf, size_t out_buf_size, const unsigned char *buf, int len, const char *delim, |
| 60 | bool delim_after_last); |
| 61 | |
Sylvain Munaut | 4cfbae8 | 2011-11-13 23:04:00 +0100 | [diff] [blame] | 62 | char *osmo_osmo_hexdump_nospc(const unsigned char *buf, int len) __attribute__((__deprecated__)); |
Harald Welte | 3eba991 | 2010-07-30 10:37:29 +0200 | [diff] [blame] | 63 | |
Holger Hans Peter Freyther | 0f40ae1 | 2015-04-13 09:21:05 +0200 | [diff] [blame] | 64 | #define osmo_static_assert(exp, name) typedef int dummy##name [(exp) ? 1 : -1] __attribute__((__unused__)); |
Holger Hans Peter Freyther | 52c07ca | 2011-01-16 17:37:27 +0100 | [diff] [blame] | 65 | |
Neels Hofmeyr | 7c74989 | 2018-09-07 03:01:38 +0200 | [diff] [blame] | 66 | void osmo_str2lower(char *out, const char *in) |
| 67 | OSMO_DEPRECATED("Use osmo_str_tolower() or osmo_str_tolower_buf() instead," |
| 68 | " to properly check target memory bounds"); |
| 69 | void osmo_str2upper(char *out, const char *in) |
| 70 | OSMO_DEPRECATED("Use osmo_str_toupper() or osmo_str_toupper_buf() instead," |
| 71 | " to properly check target memory bounds"); |
| 72 | |
| 73 | size_t osmo_str_tolower_buf(char *dest, size_t dest_len, const char *src); |
| 74 | const char *osmo_str_tolower(const char *src); |
| 75 | |
| 76 | size_t osmo_str_toupper_buf(char *dest, size_t dest_len, const char *src); |
| 77 | const char *osmo_str_toupper(const char *src); |
Harald Welte | 2822296 | 2011-02-18 20:37:04 +0100 | [diff] [blame] | 78 | |
Pablo Neira Ayuso | 3abad6a | 2011-03-28 19:24:22 +0200 | [diff] [blame] | 79 | #define OSMO_SNPRINTF_RET(ret, rem, offset, len) \ |
| 80 | do { \ |
| 81 | len += ret; \ |
| 82 | if (ret > rem) \ |
| 83 | ret = rem; \ |
| 84 | offset += ret; \ |
| 85 | rem -= ret; \ |
| 86 | } while (0) |
| 87 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 88 | /*! Helper macro to terminate when an assertion failes |
| 89 | * \param[in] exp Predicate to verify |
| 90 | * This function will generate a backtrace and terminate the program if |
| 91 | * the predicate evaluates to false (0). |
| 92 | */ |
Katerina Barone-Adesi | 008e53b | 2013-03-03 10:36:52 +0000 | [diff] [blame] | 93 | #define OSMO_ASSERT(exp) \ |
| 94 | if (!(exp)) { \ |
Neels Hofmeyr | 983dcb9 | 2018-08-20 12:33:22 +0200 | [diff] [blame] | 95 | osmo_panic("Assert failed %s %s:%d\n", #exp, __FILE__, __LINE__); \ |
Katerina Barone-Adesi | 008e53b | 2013-03-03 10:36:52 +0000 | [diff] [blame] | 96 | } |
| 97 | |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 98 | /*! duplicate a string using talloc and release its prior content (if any) |
| 99 | * \param[in] ctx Talloc context to use for allocation |
| 100 | * \param[out] dst pointer to string, will be updated with ptr to new string |
| 101 | * \param[in] newstr String that will be copieed to newly allocated string */ |
Harald Welte | 881dcaf | 2016-07-28 08:02:48 +0200 | [diff] [blame] | 102 | static inline void osmo_talloc_replace_string(void *ctx, char **dst, const char *newstr) |
Harald Welte | f3c7e85 | 2014-08-20 22:50:47 +0200 | [diff] [blame] | 103 | { |
| 104 | if (*dst) |
| 105 | talloc_free(*dst); |
| 106 | *dst = talloc_strdup(ctx, newstr); |
| 107 | } |
Katerina Barone-Adesi | 008e53b | 2013-03-03 10:36:52 +0000 | [diff] [blame] | 108 | |
Neels Hofmeyr | abdd7a2 | 2017-10-19 02:40:01 +0200 | [diff] [blame] | 109 | /*! Append to a string and re-/allocate if necessary. |
| 110 | * \param[in] ctx Talloc context to use for initial allocation. |
| 111 | * \param[in,out] dest char* to re-/allocate and append to. |
| 112 | * \param[in] fmt printf-like string format. |
| 113 | * \param[in] args Arguments for fmt. |
| 114 | * |
| 115 | * \a dest may be passed in NULL, or a string previously allocated by talloc. |
| 116 | * If an existing string is passed in, it will remain associated with whichever |
| 117 | * ctx it was allocated before, regardless whether it matches \a ctx or not. |
| 118 | */ |
| 119 | #define osmo_talloc_asprintf(ctx, dest, fmt, args ...) \ |
| 120 | do { \ |
| 121 | if (!dest) \ |
| 122 | dest = talloc_asprintf(ctx, fmt, ## args); \ |
| 123 | else \ |
| 124 | dest = talloc_asprintf_append((char*)dest, fmt, ## args); \ |
| 125 | } while (0) |
| 126 | |
Harald Welte | 9709b2e | 2016-04-25 18:47:53 +0200 | [diff] [blame] | 127 | int osmo_constant_time_cmp(const uint8_t *exp, const uint8_t *rel, const int count); |
| 128 | uint64_t osmo_decode_big_endian(const uint8_t *data, size_t data_len); |
| 129 | uint8_t *osmo_encode_big_endian(uint64_t value, size_t data_len); |
| 130 | |
Harald Welte | aeecc48 | 2016-11-26 10:41:40 +0100 | [diff] [blame] | 131 | size_t osmo_strlcpy(char *dst, const char *src, size_t siz); |
| 132 | |
Neels Hofmeyr | 4335bad | 2017-10-07 04:39:14 +0200 | [diff] [blame] | 133 | bool osmo_is_hexstr(const char *str, int min_digits, int max_digits, |
| 134 | bool require_even); |
| 135 | |
Harald Welte | febe83c | 2017-10-03 17:41:59 +0800 | [diff] [blame] | 136 | bool osmo_identifier_valid(const char *str); |
Neels Hofmeyr | 937ddea | 2017-12-16 00:46:50 +0100 | [diff] [blame] | 137 | bool osmo_separated_identifiers_valid(const char *str, const char *sep_chars); |
Harald Welte | febe83c | 2017-10-03 17:41:59 +0800 | [diff] [blame] | 138 | |
Neels Hofmeyr | 9910bbc | 2017-12-16 00:54:52 +0100 | [diff] [blame] | 139 | const char *osmo_escape_str(const char *str, int len); |
| 140 | const char *osmo_escape_str_buf(const char *str, int in_len, char *buf, size_t bufsize); |
Neels Hofmeyr | 04eb56f | 2018-04-09 00:41:28 +0200 | [diff] [blame] | 141 | const char *osmo_quote_str(const char *str, int in_len); |
| 142 | const char *osmo_quote_str_buf(const char *str, int in_len, char *buf, size_t bufsize); |
Neels Hofmeyr | 9910bbc | 2017-12-16 00:54:52 +0100 | [diff] [blame] | 143 | |
Harald Welte | 15a5f8d | 2018-06-06 16:58:17 +0200 | [diff] [blame] | 144 | uint32_t osmo_isqrt32(uint32_t x); |
| 145 | |
Oliver Smith | 894be2d | 2019-01-11 13:13:37 +0100 | [diff] [blame] | 146 | const char osmo_luhn(const char* in, int in_len); |
| 147 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 148 | /*! @} */ |