libosmocore
1.5.1
Osmocom core library
|
Go to the documentation of this file.
19 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
22 #define OSMO_MAX(a, b) ((a) >= (b) ? (a) : (b))
24 #define OSMO_MIN(a, b) ((a) >= (b) ? (b) : (a))
26 #define OSMO_CMP(a, b) ((a) < (b)? -1 : ((a) > (b)? 1 : 0))
30 #define OSMO_STRINGIFY(x) #x
32 #define OSMO_STRINGIFY_VAL(x) OSMO_STRINGIFY(x)
34 #define OSMO_VALUE_STRING(x) { x, #x }
36 #define OSMO_BYTES_FOR_BITS(BITS) ((BITS + 8 - 1) / 8)
39 #define OSMO_STRLCPY_ARRAY(array, src) osmo_strlcpy(array, src, sizeof(array))
57 int osmo_bcd2str(
char *dst,
size_t dst_size,
const uint8_t *bcd,
int start_nibble,
int end_nibble,
bool allow_hex);
58 int osmo_str2bcd(uint8_t *dst,
size_t dst_size,
const char *digits,
int start_nibble,
int end_nibble,
bool allow_hex);
68 const char *
osmo_hexdump_buf(
char *out_buf,
size_t out_buf_size,
const unsigned char *buf,
int len,
const char *delim,
69 bool delim_after_last);
73 #define osmo_static_assert(exp, name) typedef int dummy##name [(exp) ? 1 : -1] __attribute__((__unused__));
76 OSMO_DEPRECATED(
"Use osmo_str_tolower() or osmo_str_tolower_buf() instead,"
77 " to properly check target memory bounds");
79 OSMO_DEPRECATED(
"Use osmo_str_toupper() or osmo_str_toupper_buf() instead,"
80 " to properly check target memory bounds");
90 #define OSMO_SNPRINTF_RET(ret, rem, offset, len) \
104 #define OSMO_ASSERT(exp) \
106 osmo_panic("Assert failed %s %s:%d\n", #exp, __FILE__, __LINE__); \
117 *dst = talloc_strdup(ctx, newstr);
130 #define osmo_talloc_asprintf(ctx, dest, fmt, args ...) \
133 dest = talloc_asprintf(ctx, fmt, ## args); \
135 dest = talloc_asprintf_append((char*)dest, fmt, ## args); \
142 size_t osmo_strlcpy(
char *dst,
const char *src,
size_t siz);
143 const char *
osmo_strnchr(
const char *str,
size_t str_size,
char c);
145 bool osmo_is_hexstr(
const char *str,
int min_digits,
int max_digits,
163 const char *
osmo_quote_str_buf(
const char *str,
int in_len,
char *buf,
size_t bufsize);
166 int osmo_print_n(
char *buf,
size_t bufsize,
const char *str,
size_t n);
170 char osmo_luhn(
const char* in,
int in_len);
222 #define OSMO_STRBUF_APPEND(STRBUF, func, args...) do { \
224 (STRBUF).pos = (STRBUF).buf; \
225 size_t _sb_remain = (STRBUF).buf ? (STRBUF).len - ((STRBUF).pos - (STRBUF).buf) : 0; \
226 int _sb_l = func((STRBUF).pos, _sb_remain, ##args); \
227 if (_sb_l < 0 || _sb_l > _sb_remain) \
228 (STRBUF).pos = (STRBUF).buf + (STRBUF).len; \
229 else if ((STRBUF).pos) \
230 (STRBUF).pos += _sb_l; \
232 (STRBUF).chars_needed += _sb_l; \
254 #define OSMO_STRBUF_PRINTF(STRBUF, fmt, args...) \
255 OSMO_STRBUF_APPEND(STRBUF, snprintf, fmt, ##args)
265 #define OSMO_STRBUF_APPEND_NOLEN(STRBUF, func, args...) do { \
267 (STRBUF).pos = (STRBUF).buf; \
268 size_t _sb_remain = (STRBUF).buf ? (STRBUF).len - ((STRBUF).pos - (STRBUF).buf) : 0; \
270 func((STRBUF).pos, _sb_remain, ##args); \
272 size_t _sb_l = (STRBUF).pos ? strnlen((STRBUF).pos, _sb_remain) : 0; \
273 if (_sb_l > _sb_remain) \
274 (STRBUF).pos = (STRBUF).buf + (STRBUF).len; \
275 else if ((STRBUF).pos) \
276 (STRBUF).pos += _sb_l; \
277 (STRBUF).chars_needed += _sb_l; \
310 #define OSMO_NAME_C_IMPL(CTX, INITIAL_BUFSIZE, ON_ERROR, FUNC_BUF, FUNC_BUF_ARGS...) \
311 size_t _len = INITIAL_BUFSIZE; \
314 if ((INITIAL_BUFSIZE) > 0) { \
315 _str = (char*)talloc_named_const(CTX, _len, __func__); \
318 _needed = FUNC_BUF(_str, _len, ## FUNC_BUF_ARGS); \
320 goto OSMO_NAME_C_on_error; \
321 if (_needed < _len) \
323 _len = _needed + 1; \
326 _str = (char*)talloc_named_const(CTX, _len, __func__); \
328 _needed = FUNC_BUF(_str, _len, ## FUNC_BUF_ARGS); \
330 goto OSMO_NAME_C_on_error; \
332 OSMO_NAME_C_on_error: \
338 _str = talloc_strdup(CTX, ON_ERROR); \
340 talloc_set_name_const(_str, __func__); \
bool osmo_is_hexstr(const char *str, int min_digits, int max_digits, bool require_even)
Validate that a given string is a hex string within given size limits.
Definition: utils.c:621
uint8_t osmo_char2bcd(char c)
Convert number in ASCII to BCD value.
Definition: utils.c:126
void osmo_str2lower(char *out, const char *in) OSMO_DEPRECATED("Use osmo_str_tolower() or osmo_str_tolower_buf() instead
Convert an entire string to lower case.
Definition: utils.c:479
char * osmo_ubit_dump_buf(char *buf, size_t buf_len, const uint8_t *bits, unsigned int len)
Convert a sequence of unpacked bits to ASCII string, in user-supplied buffer.
Definition: utils.c:345
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
const char * get_value_string(const struct value_string *vs, uint32_t val)
get human-readable string for given value
Definition: utils.c:58
size_t osmo_quote_cstr_buf(char *buf, size_t bufsize, const char *str, int in_len)
Like osmo_escape_str_buf2(), but returns double-quotes around a string, or "NULL" for a NULL string.
Definition: utils.c:992
static size_t len(const char *str)
write Write running configuration to or terminal n Write configuration to the copy running config startup Copy configuration n Copy running config to n Copy running config to startup write Write running configuration to or terminal n Write to terminal n
char * osmo_quote_str_buf2(char *buf, size_t bufsize, const char *str, int in_len)
Like osmo_escape_str_buf2(), but returns double-quotes around a string, or "NULL" for a NULL string.
Definition: utils.c:905
void osmo_identifier_sanitize_buf(char *str, const char *sep_chars, char replace_with)
Replace characters in the given string buffer so that it is guaranteed to pass osmo_separated_identif...
Definition: utils.c:693
size_t osmo_escape_cstr_buf(char *buf, size_t bufsize, const char *str, int in_len)
Return the string with all non-printable characters escaped.
Definition: utils.c:962
const char * osmo_escape_str(const char *str, int len)
Return the string with all non-printable characters escaped.
Definition: utils.c:853
uint64_t osmo_decode_big_endian(const uint8_t *data, size_t data_len)
Generic retrieval of 1..8 bytes as big-endian uint64_t.
Definition: utils.c:534
struct gsm48_classmark3 __attribute__
fls64 - find last set bit in a 64-bit word @x: the word to search
Definition: log2.h:61
bool osmo_separated_identifiers_valid(const char *str, const char *sep_chars)
Determine if a given identifier is valid, i.e.
Definition: utils.c:651
int get_string_value(const struct value_string *vs, const char *str)
get numeric value for given human-readable string
Definition: utils.c:97
static void osmo_talloc_replace_string(void *ctx, char **dst, const char *newstr)
duplicate a string using talloc and release its prior content (if any)
Definition: utils.h:113
char * osmo_str_tolower_c(const void *ctx, const char *src)
Convert a string to lowercase, dynamically allocating the output from given talloc context See also o...
Definition: utils.c:1099
const char * get_value_string_or_null(const struct value_string *vs, uint32_t val)
get human-readable string or NULL for given value
Definition: utils.c:74
char * osmo_escape_cstr_c(void *ctx, const char *str, int in_len)
Return the string with all non-printable characters escaped, in dynamically-allocated buffer.
Definition: utils.c:974
size_t osmo_strlcpy(char *dst, const char *src, size_t siz)
Copy a C-string into a sized buffer.
Definition: utils.c:575
const char * osmo_quote_str(const char *str, int in_len)
Like osmo_quote_str_buf() but returns the result in a static buffer.
Definition: utils.c:935
size_t chars_needed
After all OSMO_STRBUF_APPEND operations, reflects the total number of characters that would be writte...
Definition: utils.h:183
const char * osmo_escape_str_buf(const char *str, int in_len, char *buf, size_t bufsize)
Like osmo_escape_str_buf2, but with unusual ordering of arguments, and may sometimes return string co...
Definition: utils.c:716
char * osmo_hexdump_c(const void *ctx, const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:414
char * osmo_ubit_dump(const uint8_t *bits, unsigned int len)
Convert a sequence of unpacked bits to ASCII string, in static buffer.
Definition: utils.c:380
const char * str
human-readable string
Definition: utils.h:44
int value
numeric value
Definition: utils.h:43
char * pos
Current writing position in buf (end of the string written so far).
Definition: utils.h:179
size_t osmo_str_tolower_buf(char *dest, size_t dest_len, const char *src)
Convert a string to lowercase, while checking buffer size boundaries.
Definition: utils.c:1061
int osmo_int_to_float_str_buf(char *buf, size_t buflen, int64_t val, unsigned int precision)
Convert an integer to a floating point string using a decimal quotient (fixed-point precision).
Definition: utils.c:1349
char * osmo_int_to_float_str_c(void *ctx, int64_t val, unsigned int precision)
Convert an integer with a factor of a million to a floating point string.
Definition: utils.c:1403
int osmo_bcd2str(char *dst, size_t dst_size, const uint8_t *bcd, int start_nibble, int end_nibble, bool allow_hex)
Convert BCD to string.
Definition: utils.c:152
const char * osmo_hexdump_buf(char *out_buf, size_t out_buf_size, const unsigned char *buf, int len, const char *delim, bool delim_after_last)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:303
int osmo_float_str_to_int(int64_t *val, const char *str, unsigned int precision)
Convert a string of a floating point number to a signed int, with a decimal factor (fixed-point preci...
Definition: utils.c:1224
const char * osmo_quote_str_buf(const char *str, int in_len, char *buf, size_t bufsize)
Like osmo_quote_str_buf2, but with unusual ordering of arguments, and may sometimes return string con...
Definition: utils.c:919
int osmo_print_n(char *buf, size_t bufsize, const char *str, size_t n)
Copy N characters to a buffer with a function signature useful for OSMO_STRBUF_APPEND().
Definition: utils.c:733
bool osmo_identifier_valid(const char *str)
Determine if a given identifier is valid, i.e.
Definition: utils.c:681
char osmo_bcd2char(uint8_t bcd)
Convert BCD-encoded digit into printable character.
Definition: utils.c:114
int osmo_hexparse(const char *str, uint8_t *b, int max_len)
Parse a string containing hexadecimal digits.
Definition: utils.c:244
uint32_t osmo_isqrt32(uint32_t x)
perform an integer square root operation on unsigned 32bit integer.
Definition: utils.c:1014
const char * osmo_str_toupper(const char *src)
Convert a string to uppercase, using a static buffer.
Definition: utils.c:1145
uint8_t * osmo_encode_big_endian(uint64_t value, size_t data_len)
Generic big-endian encoding of big endian number up to 64bit.
Definition: utils.c:555
char * buf
Point to the start of a string buffer.
Definition: utils.h:175
A mapping between human-readable string and numeric value.
Definition: utils.h:42
const char * osmo_str_tolower(const char *src)
Convert a string to lowercase, using a static buffer.
Definition: utils.c:1087
char osmo_luhn(const char *in, int in_len)
Calculate the Luhn checksum (as used for IMEIs).
Definition: utils.c:1172
bool osmo_str_startswith(const char *str, const char *startswith_str)
Compare start of a string.
Definition: utils.c:1203
char * osmo_escape_str_buf2(char *buf, size_t bufsize, const char *str, int in_len)
Return the string with all non-printable characters escaped.
Definition: utils.c:841
char * osmo_quote_str_c(const void *ctx, const char *str, int in_len)
Like osmo_quote_str_buf() but returns the result in a dynamically-allocated buffer.
Definition: utils.c:946
State for OSMO_STRBUF_APPEND() and OSMO_STRBUF_PRINTF().
Definition: utils.h:173
char * osmo_quote_cstr_c(void *ctx, const char *str, int in_len)
Return the string quoted and with all non-printable characters escaped, in dynamically-allocated buff...
Definition: utils.c:1004
const char * osmo_strnchr(const char *str, size_t str_size, char c)
Find first occurence of a char in a size limited string.
Definition: utils.c:595
char * osmo_hexdump_nospc_c(const void *ctx, const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:453
size_t len
Total sizeof() the buffer buf points at.
Definition: utils.h:177
size_t osmo_str_toupper_buf(char *dest, size_t dest_len, const char *src)
Convert a string to uppercase, while checking buffer size boundaries.
Definition: utils.c:1119
char * osmo_osmo_hexdump_nospc(const unsigned char *buf, int len) __attribute__((__deprecated__))
char * osmo_hexdump_nospc(const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:435
char * osmo_hexdump(const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:396
char * osmo_str_toupper_c(const void *ctx, const char *src)
Convert a string to uppercase, dynamically allocating the output from given talloc context See also o...
Definition: utils.c:1157
int osmo_str2bcd(uint8_t *dst, size_t dst_size, const char *digits, int start_nibble, int end_nibble, bool allow_hex)
Convert string to BCD.
Definition: utils.c:195
char * osmo_escape_str_c(const void *ctx, const char *str, int in_len)
Return the string with all non-printable characters escaped, in dynamically-allocated buffer.
Definition: utils.c:863
int osmo_constant_time_cmp(const uint8_t *exp, const uint8_t *rel, const int count)
Wishful thinking to generate a constant time compare.
Definition: utils.c:512
void osmo_str2upper(char *out, const char *in) OSMO_DEPRECATED("Use osmo_str_toupper() or osmo_str_toupper_buf() instead
Convert an entire string to upper case.
Definition: utils.c:492