libosmocore  0.9.6-12.20170220git32ee5af8.fc32
Osmocom core library
utils.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <osmocom/core/backtrace.h>
4 #include <osmocom/core/talloc.h>
5 
13 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
14 
15 #define OSMO_MAX(a, b) ((a) >= (b) ? (a) : (b))
16 
17 #define OSMO_MIN(a, b) ((a) >= (b) ? (b) : (a))
18 
19 #define OSMO_STRINGIFY(x) #x
20 
21 #define OSMO_VALUE_STRING(x) { x, OSMO_STRINGIFY(x) }
22 
23 #include <stdint.h>
24 #include <stdio.h>
25 
27 struct value_string {
28  unsigned int value;
29  const char *str;
30 };
31 
32 const char *get_value_string(const struct value_string *vs, uint32_t val);
33 const char *get_value_string_or_null(const struct value_string *vs,
34  uint32_t val);
35 
36 int get_string_value(const struct value_string *vs, const char *str);
37 
38 char osmo_bcd2char(uint8_t bcd);
39 /* only works for numbers in ascci */
40 uint8_t osmo_char2bcd(char c);
41 
42 int osmo_hexparse(const char *str, uint8_t *b, int max_len);
43 
44 char *osmo_ubit_dump(const uint8_t *bits, unsigned int len);
45 char *osmo_hexdump(const unsigned char *buf, int len);
46 char *osmo_hexdump_nospc(const unsigned char *buf, int len);
47 char *osmo_osmo_hexdump_nospc(const unsigned char *buf, int len) __attribute__((__deprecated__));
48 
49 #define osmo_static_assert(exp, name) typedef int dummy##name [(exp) ? 1 : -1] __attribute__((__unused__));
50 
51 void osmo_str2lower(char *out, const char *in);
52 void osmo_str2upper(char *out, const char *in);
53 
54 #define OSMO_SNPRINTF_RET(ret, rem, offset, len) \
55 do { \
56  len += ret; \
57  if (ret > rem) \
58  ret = rem; \
59  offset += ret; \
60  rem -= ret; \
61 } while (0)
62 
68 #define OSMO_ASSERT(exp) \
69  if (!(exp)) { \
70  fprintf(stderr, "Assert failed %s %s:%d\n", #exp, __BASE_FILE__, __LINE__); \
71  osmo_generate_backtrace(); \
72  abort(); \
73  }
74 
79 static inline void osmo_talloc_replace_string(void *ctx, char **dst, const char *newstr)
80 {
81  if (*dst)
82  talloc_free(*dst);
83  *dst = talloc_strdup(ctx, newstr);
84 }
85 
86 int osmo_constant_time_cmp(const uint8_t *exp, const uint8_t *rel, const int count);
87 uint64_t osmo_decode_big_endian(const uint8_t *data, size_t data_len);
88 uint8_t *osmo_encode_big_endian(uint64_t value, size_t data_len);
89 
90 size_t osmo_strlcpy(char *dst, const char *src, size_t siz);
91 
osmo_char2bcd
uint8_t osmo_char2bcd(char c)
Convert number in ASCII to BCD value.
Definition: utils.c:116
osmo_str2lower
void osmo_str2lower(char *out, const char *in)
Convert an entire string to lower case.
Definition: utils.c:271
get_value_string
const char * get_value_string(const struct value_string *vs, uint32_t val)
get human-readable string for given value
Definition: utils.c:51
osmo_decode_big_endian
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:326
get_string_value
int get_string_value(const struct value_string *vs, const char *str)
get numeric value for given human-readable string
Definition: utils.c:87
osmo_talloc_replace_string
static void osmo_talloc_replace_string(void *ctx, char **dst, const char *newstr)
Definition: utils.h:79
get_value_string_or_null
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:67
osmo_strlcpy
size_t osmo_strlcpy(char *dst, const char *src, size_t siz)
Copy a C-string into a sized buffer.
Definition: utils.c:365
value_string::value
unsigned int value
numeric value
Definition: utils.h:28
osmo_ubit_dump
char * osmo_ubit_dump(const uint8_t *bits, unsigned int len)
Convert a sequence of unpacked bits to ASCII string.
Definition: utils.c:200
value_string::str
const char * str
human-readable string
Definition: utils.h:29
osmo_bcd2char
char osmo_bcd2char(uint8_t bcd)
Convert BCD-encoded digit into printable character.
Definition: utils.c:104
osmo_hexparse
int osmo_hexparse(const char *str, uint8_t *b, int max_len)
Parse a string containing hexadecimal digits.
Definition: utils.c:127
osmo_encode_big_endian
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:347
value_string
A mapping between human-readable string and numeric value.
Definition: utils.h:27
osmo_hexdump_nospc
char * osmo_hexdump_nospc(const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:251
osmo_hexdump
char * osmo_hexdump(const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:238
osmo_constant_time_cmp
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:304
osmo_str2upper
void osmo_str2upper(char *out, const char *in)
Convert an entire string to upper case.
Definition: utils.c:284