src/basic/parse-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include "forward.h"
   5
   6 typedef unsigned long loadavg_t;
   7
   8 int parse_boolean(const char *v) _pure_;
   9 int parse_tristate_full(const char *v, const char *third, int *ret);
  10 static inline int parse_tristate(const char *v, int *ret) {
  11         return parse_tristate_full(v, NULL, ret);
  12 }
  13 int parse_pid(const char *s, pid_t* ret_pid);
  14 int parse_mode(const char *s, mode_t *ret);
  15 int parse_ifindex(const char *s);
  16 int parse_mtu(int family, const char *s, uint32_t *ret);
  17
  18 int parse_size(const char *t, uint64_t base, uint64_t *size);
  19 int parse_sector_size(const char *t, uint64_t *ret);
  20 int parse_range(const char *t, unsigned *lower, unsigned *upper);
  21 int parse_errno(const char *t);
  22 int parse_fd(const char *t);
  23
  24 #define SAFE_ATO_REFUSE_PLUS_MINUS (1U << 30)
  25 #define SAFE_ATO_REFUSE_LEADING_ZERO (1U << 29)
  26 #define SAFE_ATO_REFUSE_LEADING_WHITESPACE (1U << 28)
  27 #define SAFE_ATO_ALL_FLAGS (SAFE_ATO_REFUSE_PLUS_MINUS|SAFE_ATO_REFUSE_LEADING_ZERO|SAFE_ATO_REFUSE_LEADING_WHITESPACE)
  28 #define SAFE_ATO_MASK_FLAGS(base) ((base) & ~SAFE_ATO_ALL_FLAGS)
  29
  30 int safe_atou_full(const char *s, unsigned base, unsigned *ret_u);
  31 static inline int safe_atou(const char *s, unsigned *ret_u) {
  32         return safe_atou_full(s, 0, ret_u);
  33 }
  34
  35 int safe_atou_bounded(const char *s, unsigned min, unsigned max, unsigned *ret);
  36
  37 int safe_atoi(const char *s, int *ret_i);
  38 int safe_atolli(const char *s, long long *ret_i);
  39
  40 int safe_atou8_full(const char *s, unsigned base, uint8_t *ret);
  41
  42 static inline int safe_atou8(const char *s, uint8_t *ret) {
  43         return safe_atou8_full(s, 0, ret);
  44 }
  45
  46 int safe_atou16_full(const char *s, unsigned base, uint16_t *ret);
  47
  48 static inline int safe_atou16(const char *s, uint16_t *ret) {
  49         return safe_atou16_full(s, 0, ret);
  50 }
  51
  52 static inline int safe_atoux16(const char *s, uint16_t *ret) {
  53         return safe_atou16_full(s, 16, ret);
  54 }
  55
  56 int safe_atoi16(const char *s, int16_t *ret);
  57
  58 static inline int safe_atou32_full(const char *s, unsigned base, uint32_t *ret_u) {
  59         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
  60         return safe_atou_full(s, base, (unsigned*) ret_u);
  61 }
  62
  63 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
  64         return safe_atou32_full(s, 0, (unsigned*) ret_u);
  65 }
  66
  67 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
  68         assert_cc(sizeof(int32_t) == sizeof(int));
  69         return safe_atoi(s, (int*) ret_i);
  70 }
  71
  72 int safe_atollu_full(const char *s, unsigned base, unsigned long long *ret_llu);
  73
  74 static inline int safe_atollu(const char *s, unsigned long long *ret_llu) {
  75         return safe_atollu_full(s, 0, ret_llu);
  76 }
  77
  78 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
  79         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
  80         return safe_atollu(s, (unsigned long long*) ret_u);
  81 }
  82
  83 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
  84         assert_cc(sizeof(int64_t) == sizeof(long long));
  85         return safe_atolli(s, (long long*) ret_i);
  86 }
  87
  88 static inline int safe_atoux64(const char *s, uint64_t *ret) {
  89         assert_cc(sizeof(int64_t) == sizeof(unsigned long long));
  90         return safe_atollu_full(s, 16, (unsigned long long*) ret);
  91 }
  92
  93 #if LONG_MAX == INT_MAX
  94 static inline int safe_atolu_full(const char *s, unsigned base, unsigned long *ret_u) {
  95         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
  96         return safe_atou_full(s, base, (unsigned*) ret_u);
  97 }
  98 static inline int safe_atoli(const char *s, long *ret_u) {
  99         assert_cc(sizeof(long) == sizeof(int));
 100         return safe_atoi(s, (int*) ret_u);
 101 }
 102 #else
 103 static inline int safe_atolu_full(const char *s, unsigned base, unsigned long *ret_u) {
 104         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 105         return safe_atollu_full(s, base, (unsigned long long*) ret_u);
 106 }
 107 static inline int safe_atoli(const char *s, long *ret_u) {
 108         assert_cc(sizeof(long) == sizeof(long long));
 109         return safe_atolli(s, (long long*) ret_u);
 110 }
 111 #endif
 112
 113 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 114         return safe_atolu_full(s, 0, ret_u);
 115 }
 116
 117 #if SIZE_MAX == UINT_MAX
 118 static inline int safe_atozu(const char *s, size_t *ret_u) {
 119         assert_cc(sizeof(size_t) == sizeof(unsigned));
 120         return safe_atou(s, (unsigned *) ret_u);
 121 }
 122 #else
 123 static inline int safe_atozu(const char *s, size_t *ret_u) {
 124         assert_cc(sizeof(size_t) == sizeof(unsigned long));
 125         return safe_atolu(s, ret_u);
 126 }
 127 #endif
 128
 129 int safe_atod(const char *s, double *ret_d);
 130
 131 int parse_fractional_part_u(const char **s, size_t digits, unsigned *res);
 132
 133 int parse_nice(const char *p, int *ret);
 134
 135 int parse_ip_port(const char *s, uint16_t *ret);
 136 int parse_ip_port_range(const char *s, uint16_t *low, uint16_t *high, bool allow_zero);
 137
 138 int parse_oom_score_adjust(const char *s, int *ret);
 139
 140 /* Implement floating point using fixed integers, to improve performance when
 141  * calculating load averages. These macros can be used to extract the integer
 142  * and decimal parts of a value. */
 143 #define LOADAVG_PRECISION_BITS  11
 144 #define LOADAVG_FIXED_POINT_1_0 (1 << LOADAVG_PRECISION_BITS)
 145 #define LOADAVG_INT_SIDE(x)     ((x) >> LOADAVG_PRECISION_BITS)
 146 #define LOADAVG_DECIMAL_SIDE(x) LOADAVG_INT_SIDE(((x) & (LOADAVG_FIXED_POINT_1_0 - 1)) * 100)
 147
 148 /* Given a Linux load average (e.g. decimal number 34.89 where 34 is passed as i and 89 is passed as f), convert it
 149  * to a loadavg_t. */
 150 int store_loadavg_fixed_point(unsigned long i, unsigned long f, loadavg_t *ret);
 151 int parse_loadavg_fixed_point(const char *s, loadavg_t *ret);
 152
 153 bool nft_identifier_valid(const char *id);