src/basic/parse-util.h

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