libosmocore  1.0.1
Osmocom core library
utils.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <stdbool.h>
4 #include <stdint.h>
5 #include <stdio.h>
6 
8 #include <osmocom/core/talloc.h>
9 #include <osmocom/core/panic.h>
10 #include <osmocom/core/defs.h>
11 
17 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
18 
19 #define OSMO_MAX(a, b) ((a) >= (b) ? (a) : (b))
20 
21 #define OSMO_MIN(a, b) ((a) >= (b) ? (b) : (a))
22 
25 #define OSMO_STRINGIFY(x) #x
26 
27 #define OSMO_STRINGIFY_VAL(x) OSMO_STRINGIFY(x)
28 
29 #define OSMO_VALUE_STRING(x) { x, #x }
30 
31 #define OSMO_BYTES_FOR_BITS(BITS) ((BITS + 8 - 1) / 8)
32 
34 #define OSMO_STRLCPY_ARRAY(array, src) osmo_strlcpy(array, src, sizeof(array))
35 
37 struct value_string {
38  unsigned int value;
39  const char *str;
40 };
41 
42 const char *get_value_string(const struct value_string *vs, uint32_t val);
43 const char *get_value_string_or_null(const struct value_string *vs,
44  uint32_t val);
45 
46 int get_string_value(const struct value_string *vs, const char *str);
47 
48 char osmo_bcd2char(uint8_t bcd);
49 /* only works for numbers in ascci */
50 uint8_t osmo_char2bcd(char c);
51 
52 int osmo_bcd2str(char *dst, size_t dst_size, const uint8_t *bcd, int start_nibble, int end_nibble, bool allow_hex);
53 
54 int osmo_hexparse(const char *str, uint8_t *b, int max_len);
55 
56 char *osmo_ubit_dump(const uint8_t *bits, unsigned int len);
57 char *osmo_hexdump(const unsigned char *buf, int len);
58 char *osmo_hexdump_nospc(const unsigned char *buf, int len);
59 char *osmo_osmo_hexdump_nospc(const unsigned char *buf, int len) __attribute__((__deprecated__));
60 
61 #define osmo_static_assert(exp, name) typedef int dummy##name [(exp) ? 1 : -1] __attribute__((__unused__));
62 
63 void osmo_str2lower(char *out, const char *in)
64  OSMO_DEPRECATED("Use osmo_str_tolower() or osmo_str_tolower_buf() instead,"
65  " to properly check target memory bounds");
66 void osmo_str2upper(char *out, const char *in)
67  OSMO_DEPRECATED("Use osmo_str_toupper() or osmo_str_toupper_buf() instead,"
68  " to properly check target memory bounds");
69 
70 size_t osmo_str_tolower_buf(char *dest, size_t dest_len, const char *src);
71 const char *osmo_str_tolower(const char *src);
72 
73 size_t osmo_str_toupper_buf(char *dest, size_t dest_len, const char *src);
74 const char *osmo_str_toupper(const char *src);
75 
76 #define OSMO_SNPRINTF_RET(ret, rem, offset, len) \
77 do { \
78  len += ret; \
79  if (ret > rem) \
80  ret = rem; \
81  offset += ret; \
82  rem -= ret; \
83 } while (0)
84 
90 #define OSMO_ASSERT(exp) \
91  if (!(exp)) { \
92  osmo_panic("Assert failed %s %s:%d\n", #exp, __FILE__, __LINE__); \
93  }
94 
99 static inline void osmo_talloc_replace_string(void *ctx, char **dst, const char *newstr)
100 {
101  if (*dst)
102  talloc_free(*dst);
103  *dst = talloc_strdup(ctx, newstr);
104 }
105 
116 #define osmo_talloc_asprintf(ctx, dest, fmt, args ...) \
117  do { \
118  if (!dest) \
119  dest = talloc_asprintf(ctx, fmt, ## args); \
120  else \
121  dest = talloc_asprintf_append((char*)dest, fmt, ## args); \
122  } while (0)
123 
124 int osmo_constant_time_cmp(const uint8_t *exp, const uint8_t *rel, const int count);
125 uint64_t osmo_decode_big_endian(const uint8_t *data, size_t data_len);
126 uint8_t *osmo_encode_big_endian(uint64_t value, size_t data_len);
127 
128 size_t osmo_strlcpy(char *dst, const char *src, size_t siz);
129 
130 bool osmo_is_hexstr(const char *str, int min_digits, int max_digits,
131  bool require_even);
132 
133 bool osmo_identifier_valid(const char *str);
134 bool osmo_separated_identifiers_valid(const char *str, const char *sep_chars);
135 
136 const char *osmo_escape_str(const char *str, int len);
137 const char *osmo_escape_str_buf(const char *str, int in_len, char *buf, size_t bufsize);
138 const char *osmo_quote_str(const char *str, int in_len);
139 const char *osmo_quote_str_buf(const char *str, int in_len, char *buf, size_t bufsize);
140 
141 uint32_t osmo_isqrt32(uint32_t x);
142 
143 const char osmo_luhn(const char* in, int in_len);
144 
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:447
#define OSMO_DEPRECATED(text)
Set the deprecated attribute with a message.
Definition: defs.h:41
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:329
int get_string_value(const struct value_string *vs, const char *str)
get numeric value for given human-readable string
Definition: utils.c:91
const char * get_value_string(const struct value_string *vs, uint32_t val)
get human-readable string for given value
Definition: utils.c:55
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:71
struct rb_root __attribute__
Definition: conv_acc_generic.c:140
const char * osmo_escape_str(const char *str, int len)
Return the string with all non-printable characters escaped.
Definition: utils.c:593
unsigned int value
numeric value
Definition: utils.h:38
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:384
uint8_t osmo_char2bcd(char c)
Convert number in ASCII to BCD value.
Definition: utils.c:120
A mapping between human-readable string and numeric value.
Definition: utils.h:37
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:99
General definitions that are meant to be included from header files.
size_t osmo_strlcpy(char *dst, const char *src, size_t siz)
Copy a C-string into a sized buffer.
Definition: utils.c:423
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:637
bool osmo_separated_identifiers_valid(const char *str, const char *sep_chars)
Determine if a given identifier is valid, i.e.
Definition: utils.c:475
Convenience wrapper.
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:692
const char * str
human-readable string
Definition: utils.h:39
const char * osmo_quote_str_buf(const char *str, int in_len, char *buf, size_t bufsize)
Like osmo_escape_str(), but returns double-quotes around a string, or "NULL" for a NULL string...
Definition: utils.c:604
char * osmo_ubit_dump(const uint8_t *bits, unsigned int len)
Convert a sequence of unpacked bits to ASCII string.
Definition: utils.c:252
const char * osmo_str_toupper(const char *src)
Convert a string to uppercase, using a static buffer.
Definition: utils.c:761
const char * osmo_escape_str_buf(const char *str, int in_len, char *buf, size_t bufsize)
Return the string with all non-printable characters escaped.
Definition: utils.c:518
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:146
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:405
bool osmo_identifier_valid(const char *str)
Determine if a given identifier is valid, i.e.
Definition: utils.c:506
char osmo_bcd2char(uint8_t bcd)
Convert BCD-encoded digit into printable character.
Definition: utils.c:108
int osmo_hexparse(const char *str, uint8_t *b, int max_len)
Parse a string containing hexadecimal digits.
Definition: utils.c:179
const char * osmo_str_tolower(const char *src)
Convert a string to lowercase, using a static buffer.
Definition: utils.c:718
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:735
uint32_t osmo_isqrt32(uint32_t x)
perform an integer square root operation on unsigned 32bit integer.
Definition: utils.c:645
const char osmo_luhn(const char *in, int in_len)
Calculate the Luhn checksum (as used for IMEIs).
Definition: utils.c:773
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:309
char * osmo_hexdump(const unsigned char *buf, int len)
Convert binary sequence to hexadecimal ASCII string.
Definition: utils.c:293
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:342
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:362