blob: e2d51349e2b44e69f12ac26a6b35259bcadcf91b [file] [log] [blame]
Sylvain Munaut12ba7782014-06-16 10:13:40 +02001#pragma once
Harald Welteec8b4502010-02-20 20:34:29 +01002
Neels Hofmeyr4335bad2017-10-07 04:39:14 +02003#include <stdbool.h>
4
Harald Welteb8add362013-07-06 23:49:41 +02005#include <osmocom/core/backtrace.h>
Harald Weltef3c7e852014-08-20 22:50:47 +02006#include <osmocom/core/talloc.h>
Harald Welte459a1802018-06-28 09:24:17 +02007#include <osmocom/core/panic.h>
Harald Welteb8add362013-07-06 23:49:41 +02008
Harald Welte8598f182011-08-17 14:19:27 +02009/*! \defgroup utils General-purpose utility functions
10 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020011 * \file utils.h */
Harald Welte8598f182011-08-17 14:19:27 +020012
Neels Hofmeyr87e45502017-06-20 00:17:59 +020013/*! Determine number of elements in an array of static size */
Harald Welteec8b4502010-02-20 20:34:29 +010014#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
Neels Hofmeyr87e45502017-06-20 00:17:59 +020015/*! Return the maximum of two specified values */
Holger Hans Peter Freyther08b28622012-08-15 17:02:59 +020016#define OSMO_MAX(a, b) ((a) >= (b) ? (a) : (b))
Neels Hofmeyr87e45502017-06-20 00:17:59 +020017/*! Return the minimum of two specified values */
Holger Hans Peter Freyther08b28622012-08-15 17:02:59 +020018#define OSMO_MIN(a, b) ((a) >= (b) ? (b) : (a))
Neels Hofmeyrdc75b112017-12-09 05:51:42 +010019/*! Stringify the name of a macro x, e.g. an FSM event name.
20 * Note: if nested within another preprocessor macro, this will
21 * stringify the value of x instead of its name. */
Neels Hofmeyr18080962016-12-16 13:43:54 +010022#define OSMO_STRINGIFY(x) #x
Neels Hofmeyr84ea2e02017-12-09 05:53:18 +010023/*! Stringify the value of a macro x, e.g. a port number. */
24#define OSMO_STRINGIFY_VAL(x) OSMO_STRINGIFY(x)
Neels Hofmeyr87e45502017-06-20 00:17:59 +020025/*! Make a value_string entry from an enum value name */
Neels Hofmeyr8a5d60b2017-03-09 23:01:37 +010026#define OSMO_VALUE_STRING(x) { x, #x }
Neels Hofmeyr87e45502017-06-20 00:17:59 +020027/*! Number of bytes necessary to store given BITS */
Maxdd75bac2017-06-13 15:07:01 +020028#define OSMO_BYTES_FOR_BITS(BITS) ((BITS + 8 - 1) / 8)
Harald Welteec8b4502010-02-20 20:34:29 +010029
Max18c014d2018-01-30 14:33:01 +010030/*! Copy a C-string into a sized buffer using sizeof to detect buffer's size */
31#define OSMO_STRLCPY_ARRAY(array, src) osmo_strlcpy(array, src, sizeof(array))
32
Harald Weltefebe83c2017-10-03 17:41:59 +080033#include <stdbool.h>
Harald Welted284cd92010-03-01 21:58:31 +010034#include <stdint.h>
Harald Welte75c0e2f2017-01-15 17:59:21 +010035#include <stdio.h>
Harald Welted284cd92010-03-01 21:58:31 +010036
Neels Hofmeyr87e45502017-06-20 00:17:59 +020037/*! A mapping between human-readable string and numeric value */
Harald Welted284cd92010-03-01 21:58:31 +010038struct value_string {
Neels Hofmeyr87e45502017-06-20 00:17:59 +020039 unsigned int value; /*!< numeric value */
40 const char *str; /*!< human-readable string */
Harald Welted284cd92010-03-01 21:58:31 +010041};
42
43const char *get_value_string(const struct value_string *vs, uint32_t val);
Neels Hofmeyr8d6dcd92016-06-06 18:05:23 +020044const char *get_value_string_or_null(const struct value_string *vs,
45 uint32_t val);
Harald Weltebd598e32011-08-16 23:26:52 +020046
Harald Welted284cd92010-03-01 21:58:31 +010047int get_string_value(const struct value_string *vs, const char *str);
48
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +020049char osmo_bcd2char(uint8_t bcd);
Harald Weltea73e2f92010-03-04 10:50:32 +010050/* only works for numbers in ascci */
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +020051uint8_t osmo_char2bcd(char c);
Harald Welted284cd92010-03-01 21:58:31 +010052
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +020053int osmo_hexparse(const char *str, uint8_t *b, int max_len);
Harald Weltebd598e32011-08-16 23:26:52 +020054
Pablo Neira Ayuso87f7b252011-05-07 12:43:08 +020055char *osmo_ubit_dump(const uint8_t *bits, unsigned int len);
Harald Welte8598f182011-08-17 14:19:27 +020056char *osmo_hexdump(const unsigned char *buf, int len);
Sylvain Munautff23d242011-11-10 23:03:18 +010057char *osmo_hexdump_nospc(const unsigned char *buf, int len);
Sylvain Munaut4cfbae82011-11-13 23:04:00 +010058char *osmo_osmo_hexdump_nospc(const unsigned char *buf, int len) __attribute__((__deprecated__));
Harald Welte3eba9912010-07-30 10:37:29 +020059
Holger Hans Peter Freyther0f40ae12015-04-13 09:21:05 +020060#define osmo_static_assert(exp, name) typedef int dummy##name [(exp) ? 1 : -1] __attribute__((__unused__));
Holger Hans Peter Freyther52c07ca2011-01-16 17:37:27 +010061
Harald Welte28222962011-02-18 20:37:04 +010062void osmo_str2lower(char *out, const char *in);
63void osmo_str2upper(char *out, const char *in);
64
Pablo Neira Ayuso3abad6a2011-03-28 19:24:22 +020065#define OSMO_SNPRINTF_RET(ret, rem, offset, len) \
66do { \
67 len += ret; \
68 if (ret > rem) \
69 ret = rem; \
70 offset += ret; \
71 rem -= ret; \
72} while (0)
73
Harald Welte2d2e2cc2016-04-25 12:11:20 +020074/*! Helper macro to terminate when an assertion failes
75 * \param[in] exp Predicate to verify
76 * This function will generate a backtrace and terminate the program if
77 * the predicate evaluates to false (0).
78 */
Katerina Barone-Adesi008e53b2013-03-03 10:36:52 +000079#define OSMO_ASSERT(exp) \
80 if (!(exp)) { \
Neels Hofmeyr983dcb92018-08-20 12:33:22 +020081 osmo_panic("Assert failed %s %s:%d\n", #exp, __FILE__, __LINE__); \
Katerina Barone-Adesi008e53b2013-03-03 10:36:52 +000082 }
83
Harald Welte2d2e2cc2016-04-25 12:11:20 +020084/*! duplicate a string using talloc and release its prior content (if any)
85 * \param[in] ctx Talloc context to use for allocation
86 * \param[out] dst pointer to string, will be updated with ptr to new string
87 * \param[in] newstr String that will be copieed to newly allocated string */
Harald Welte881dcaf2016-07-28 08:02:48 +020088static inline void osmo_talloc_replace_string(void *ctx, char **dst, const char *newstr)
Harald Weltef3c7e852014-08-20 22:50:47 +020089{
90 if (*dst)
91 talloc_free(*dst);
92 *dst = talloc_strdup(ctx, newstr);
93}
Katerina Barone-Adesi008e53b2013-03-03 10:36:52 +000094
Neels Hofmeyrabdd7a22017-10-19 02:40:01 +020095/*! Append to a string and re-/allocate if necessary.
96 * \param[in] ctx Talloc context to use for initial allocation.
97 * \param[in,out] dest char* to re-/allocate and append to.
98 * \param[in] fmt printf-like string format.
99 * \param[in] args Arguments for fmt.
100 *
101 * \a dest may be passed in NULL, or a string previously allocated by talloc.
102 * If an existing string is passed in, it will remain associated with whichever
103 * ctx it was allocated before, regardless whether it matches \a ctx or not.
104 */
105#define osmo_talloc_asprintf(ctx, dest, fmt, args ...) \
106 do { \
107 if (!dest) \
108 dest = talloc_asprintf(ctx, fmt, ## args); \
109 else \
110 dest = talloc_asprintf_append((char*)dest, fmt, ## args); \
111 } while (0)
112
Harald Welte9709b2e2016-04-25 18:47:53 +0200113int osmo_constant_time_cmp(const uint8_t *exp, const uint8_t *rel, const int count);
114uint64_t osmo_decode_big_endian(const uint8_t *data, size_t data_len);
115uint8_t *osmo_encode_big_endian(uint64_t value, size_t data_len);
116
Harald Welteaeecc482016-11-26 10:41:40 +0100117size_t osmo_strlcpy(char *dst, const char *src, size_t siz);
118
Neels Hofmeyr4335bad2017-10-07 04:39:14 +0200119bool osmo_is_hexstr(const char *str, int min_digits, int max_digits,
120 bool require_even);
121
Harald Weltefebe83c2017-10-03 17:41:59 +0800122bool osmo_identifier_valid(const char *str);
Neels Hofmeyr937ddea2017-12-16 00:46:50 +0100123bool osmo_separated_identifiers_valid(const char *str, const char *sep_chars);
Harald Weltefebe83c2017-10-03 17:41:59 +0800124
Neels Hofmeyr9910bbc2017-12-16 00:54:52 +0100125const char *osmo_escape_str(const char *str, int len);
126const char *osmo_escape_str_buf(const char *str, int in_len, char *buf, size_t bufsize);
Neels Hofmeyr04eb56f2018-04-09 00:41:28 +0200127const char *osmo_quote_str(const char *str, int in_len);
128const char *osmo_quote_str_buf(const char *str, int in_len, char *buf, size_t bufsize);
Neels Hofmeyr9910bbc2017-12-16 00:54:52 +0100129
Harald Welte15a5f8d2018-06-06 16:58:17 +0200130uint32_t osmo_isqrt32(uint32_t x);
131
Sylvain Munautdca7d2c2012-04-18 21:53:23 +0200132/*! @} */