utils.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
 
#include <osmocom/core/backtrace.h>
#include <osmocom/core/talloc.h>
#include <osmocom/core/panic.h>
#include <osmocom/core/defs.h>
 
#ifndef ARRAY_SIZE
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
#endif
#define OSMO_MAX(a, b) ((a) >= (b) ? (a) : (b))
#define OSMO_MIN(a, b) ((a) >= (b) ? (b) : (a))
#define OSMO_CMP(a, b) ((a) < (b)? -1 : ((a) > (b)? 1 : 0))
#define OSMO_STRINGIFY(x) #x
#define OSMO_STRINGIFY_VAL(x) OSMO_STRINGIFY(x)
#define OSMO_VALUE_STRING(x) { x, #x }
#define OSMO_BYTES_FOR_BITS(BITS) (((BITS) + 7) / 8)
 
#define OSMO_STRLCPY_ARRAY(array, src) osmo_strlcpy(array, src, sizeof(array))
 
#if defined(__GNUC__)
#define OSMO_LIKELY(exp) __builtin_expect(!!(exp), 1)
#define OSMO_UNLIKELY(exp) __builtin_expect(!!(exp), 0)
#else
#define OSMO_LIKELY(exp) exp
#define OSMO_UNLIKELY(exp) exp
#endif
 
struct value_string {
        uint32_t value;         
        const char *str;        
};
 
const char *get_value_string(const struct value_string *vs, uint32_t val);
const char *get_value_string_or_null(const struct value_string *vs,
                                     uint32_t val);
 
int get_string_value(const struct value_string *vs, const char *str);
 
char osmo_bcd2char(uint8_t bcd);
/* only works for numbers in ASCII */
uint8_t osmo_char2bcd(char c);
 
int osmo_bcd2str(char *dst, size_t dst_size, const uint8_t *bcd, int start_nibble, int end_nibble, bool allow_hex);
int osmo_str2bcd(uint8_t *dst, size_t dst_size, const char *digits, int start_nibble, int end_nibble, bool allow_hex);
 
int osmo_hexparse(const char *str, uint8_t *b, unsigned int max_len);
 
char *osmo_ubit_dump_buf(char *buf, size_t buf_len, const uint8_t *bits, unsigned int len);
char *osmo_ubit_dump(const uint8_t *bits, unsigned int len);
char *osmo_hexdump(const unsigned char *buf, int len);
char *osmo_hexdump_c(const void *ctx, const unsigned char *buf, int len);
char *osmo_hexdump_nospc(const unsigned char *buf, int len);
char *osmo_hexdump_nospc_c(const void *ctx, const unsigned char *buf, int len);
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);
 
char *osmo_osmo_hexdump_nospc(const unsigned char *buf, int len) __attribute__((__deprecated__));
 
#define osmo_static_assert(exp, name) typedef int dummy##name [(exp) ? 1 : -1] __attribute__((__unused__));
 
void osmo_str2lower(char *out, const char *in)
        OSMO_DEPRECATED("Use osmo_str_tolower() or osmo_str_tolower_buf() instead,"
                        " to properly check target memory bounds");
void osmo_str2upper(char *out, const char *in)
        OSMO_DEPRECATED("Use osmo_str_toupper() or osmo_str_toupper_buf() instead,"
                        " to properly check target memory bounds");
 
size_t osmo_str_tolower_buf(char *dest, size_t dest_len, const char *src);
const char *osmo_str_tolower(const char *src);
char *osmo_str_tolower_c(const void *ctx, const char *src);
 
size_t osmo_str_toupper_buf(char *dest, size_t dest_len, const char *src);
const char *osmo_str_toupper(const char *src);
char *osmo_str_toupper_c(const void *ctx, const char *src);
 
#define OSMO_SNPRINTF_RET(ret, rem, offset, len)                \
do {                                                            \
        len += ret;                                             \
        if (ret > rem)                                          \
                ret = rem;                                      \
        offset += ret;                                          \
        rem -= ret;                                             \
} while (0)
 
#define OSMO_ASSERT(exp)    \
do { \
        if (OSMO_UNLIKELY(!(exp))) { \
                osmo_panic("Assert failed %s %s:%d\n", #exp, __FILE__, __LINE__); \
        } \
} while (0); /* some code invokes OSMO_ASSERT() without the semicolon */
 
static inline void osmo_talloc_replace_string(void *ctx, char **dst, const char *newstr)
{
        if (*dst)
                talloc_free(*dst);
        *dst = talloc_strdup(ctx, newstr);
}
 
void osmo_talloc_replace_string_fmt(void *ctx, char **dst, const char *fmt, ...);
 
#define osmo_talloc_asprintf(ctx, dest, fmt, args ...) \
        do { \
                if (!dest) \
                        dest = talloc_asprintf(ctx, fmt, ## args); \
                else \
                        dest = talloc_asprintf_append((char*)dest, fmt, ## args); \
        } while (0)
 
int osmo_constant_time_cmp(const uint8_t *exp, const uint8_t *rel, const int count);
uint64_t osmo_decode_big_endian(const uint8_t *data, size_t data_len);
uint8_t *osmo_encode_big_endian(uint64_t value, size_t data_len);
 
size_t osmo_strlcpy(char *dst, const char *src, size_t siz);
const char *osmo_strnchr(const char *str, size_t str_size, char c);
 
bool osmo_is_hexstr(const char *str, int min_digits, int max_digits,
                    bool require_even);
 
bool osmo_identifier_valid(const char *str);
bool osmo_separated_identifiers_valid(const char *str, const char *sep_chars);
void osmo_identifier_sanitize_buf(char *str, const char *sep_chars, char replace_with);
 
size_t osmo_escape_cstr_buf(char *buf, size_t bufsize, const char *str, int in_len);
char *osmo_escape_cstr_c(void *ctx, const char *str, int in_len);
size_t osmo_quote_cstr_buf(char *buf, size_t bufsize, const char *str, int in_len);
char *osmo_quote_cstr_c(void *ctx, const char *str, int in_len);
 
const char *osmo_escape_str(const char *str, int len);
int osmo_escape_str_buf3(char *buf, size_t bufsize, const char *str, int in_len);
char *osmo_escape_str_buf2(char *buf, size_t bufsize, const char *str, int in_len);
const char *osmo_escape_str_buf(const char *str, int in_len, char *buf, size_t bufsize);
char *osmo_escape_str_c(const void *ctx, const char *str, int in_len);
const char *osmo_quote_str(const char *str, int in_len);
int osmo_quote_str_buf3(char *buf, size_t bufsize, const char *str, int in_len);
char *osmo_quote_str_buf2(char *buf, size_t bufsize, const char *str, int in_len);
const char *osmo_quote_str_buf(const char *str, int in_len, char *buf, size_t bufsize);
char *osmo_quote_str_c(const void *ctx, const char *str, int in_len);
 
int osmo_print_n(char *buf, size_t bufsize, const char *str, size_t n);
 
uint32_t osmo_isqrt32(uint32_t x);
 
#define OSMO_MOD_FLR(x, y) (((x) > 0 && (y) < 0) || ((x) < 0 && (y) > 0) ? (x) % (y) + (y) : (x) % (y))
 
#define OSMO_MOD_EUC(x, y) ((x) % (y) < 0 ? (y) > 0 ? (x) % (y) + (y) : (x) % (y) - (y) : (x) % (y))
 
char osmo_luhn(const char* in, int in_len);
 
struct osmo_strbuf {
        char *buf;
        size_t len;
        char *pos;
        size_t chars_needed;
};
 
#define OSMO_STRBUF_APPEND(STRBUF, func, args...) do { \
                if (!(STRBUF).pos) \
                        (STRBUF).pos = (STRBUF).buf; \
                size_t _sb_remain = OSMO_STRBUF_REMAIN(STRBUF); \
                int _sb_l = func((STRBUF).pos, _sb_remain, ##args); \
                if (_sb_l < 0 || (size_t)_sb_l > _sb_remain) \
                        (STRBUF).pos = (STRBUF).buf + (STRBUF).len; \
                else if ((STRBUF).pos) \
                        (STRBUF).pos += _sb_l; \
                if (_sb_l > 0) \
                        (STRBUF).chars_needed += _sb_l; \
        } while(0)
 
#define OSMO_STRBUF_PRINTF(STRBUF, fmt, args...) \
        OSMO_STRBUF_APPEND(STRBUF, snprintf, fmt, ##args)
 
static inline size_t _osmo_strbuf_remain(const struct osmo_strbuf *sb)
{
        if (OSMO_UNLIKELY(sb == NULL || sb->buf == NULL))
                return 0;
        if (sb->pos == NULL)
                return sb->len;
        return sb->len - (sb->pos - sb->buf);
}
 
#define OSMO_STRBUF_REMAIN(STRBUF) \
        _osmo_strbuf_remain(&(STRBUF))
 
static inline size_t _osmo_strbuf_char_count(const struct osmo_strbuf *sb)
{
        if (OSMO_UNLIKELY(sb == NULL || sb->buf == NULL))
                return 0;
        if (sb->pos == NULL || sb->pos <= sb->buf)
                return 0;
        return OSMO_MIN((size_t)(sb->pos - sb->buf), sb->len - 1);
}
 
#define OSMO_STRBUF_CHAR_COUNT(STRBUF) \
        _osmo_strbuf_char_count(&(STRBUF))
 
#define OSMO_STRBUF_APPEND_NOLEN(STRBUF, func, args...) do { \
                if (!(STRBUF).pos) \
                        (STRBUF).pos = (STRBUF).buf; \
                size_t _sb_remain = OSMO_STRBUF_REMAIN(STRBUF); \
                if (_sb_remain) { \
                        func((STRBUF).pos, _sb_remain, ##args); \
                } \
                size_t _sb_l = (STRBUF).pos ? strnlen((STRBUF).pos, _sb_remain) : 0; \
                if (_sb_l > _sb_remain) \
                        (STRBUF).pos = (STRBUF).buf + (STRBUF).len; \
                else if ((STRBUF).pos) \
                        (STRBUF).pos += _sb_l; \
                (STRBUF).chars_needed += _sb_l; \
        } while(0)
 
void osmo_strbuf_drop_tail(struct osmo_strbuf *sb, size_t n_chars);
/* Convenience macro. struct osmo_strbuf are typically static to a function scope. Avoid having to type '&', same as
 * with all the other OSMO_STRBUF_* API. */
#define OSMO_STRBUF_DROP_TAIL(STRBUF, N_CHARS) osmo_strbuf_drop_tail(&(STRBUF), N_CHARS)
 
void osmo_strbuf_added_tail(struct osmo_strbuf *sb, size_t n_chars);
/* Convenience macro. struct osmo_strbuf are typically static to a function scope. Avoid having to type '&', same as
 * with all the other OSMO_STRBUF_* API. */
#define OSMO_STRBUF_ADDED_TAIL(STRBUF, N_CHARS) osmo_strbuf_added_tail(&(STRBUF), N_CHARS)
 
bool osmo_str_startswith(const char *str, const char *startswith_str);
 
int osmo_float_str_to_int(int64_t *val, const char *str, unsigned int precision);
int osmo_int_to_float_str_buf(char *buf, size_t buflen, int64_t val, unsigned int precision);
char *osmo_int_to_float_str_c(void *ctx, int64_t val, unsigned int precision);
 
int osmo_str_to_int64(int64_t *result, const char *str, int base, int64_t min_val, int64_t max_val);
int osmo_str_to_int(int *result, const char *str, int base, int min_val, int max_val);
 
#define OSMO_NAME_C_IMPL(CTX, INITIAL_BUFSIZE, ON_ERROR, FUNC_BUF, FUNC_BUF_ARGS...) \
        size_t _len = INITIAL_BUFSIZE; \
        int _needed; \
        char *_str = NULL; \
        if ((INITIAL_BUFSIZE) > 0) { \
                _str = (char*)talloc_named_const(CTX, _len, __func__); \
                OSMO_ASSERT(_str); \
        } \
        _needed = FUNC_BUF(_str, _len, ## FUNC_BUF_ARGS); \
        if (_needed < 0) \
                goto OSMO_NAME_C_on_error; \
        if ((unsigned int) _needed < _len) \
                return _str; \
        _len = _needed + 1; \
        if (_str) \
                talloc_free(_str); \
        _str = (char*)talloc_named_const(CTX, _len, __func__); \
        OSMO_ASSERT(_str); \
        _needed = FUNC_BUF(_str, _len, ## FUNC_BUF_ARGS); \
        if (_needed < 0) \
                goto OSMO_NAME_C_on_error; \
        return _str; \
OSMO_NAME_C_on_error: \
        /* Re-using and re-sizing above allocated buf ends up in very complex code. Just free and strdup. */ \
        if (_str) \
                talloc_free(_str); \
        if (!(ON_ERROR)) \
                return NULL; \
        _str = talloc_strdup(CTX, ON_ERROR); \
        OSMO_ASSERT(_str); \
        talloc_set_name_const(_str, __func__); \
        return _str;