include/utils.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __UTILS_H__
   3 #define __UTILS_H__ 1
   4
   5 #include <sys/types.h>
   6 #include <asm/types.h>
   7 #include <resolv.h>
   8 #include <stdlib.h>
   9 #include <stdbool.h>
  10 #include <time.h>
  11
  12 #ifdef HAVE_LIBBSD
  13 #include <bsd/string.h>
  14 #endif
  15
  16 #include "libnetlink.h"
  17 #include "ll_map.h"
  18 #include "rtm_map.h"
  19 #include "json_print.h"
  20
  21 extern int preferred_family;
  22 extern int human_readable;
  23 extern int show_stats;
  24 extern int show_details;
  25 extern int show_raw;
  26 extern int resolve_hosts;
  27 extern int oneline;
  28 extern int brief;
  29 extern int json;
  30 extern int pretty;
  31 extern int timestamp;
  32 extern int timestamp_short;
  33 extern const char * _SL_;
  34 extern int max_flush_loops;
  35 extern int batch_mode;
  36 extern int numeric;
  37 extern bool do_all;
  38
  39 #ifndef CONFDIR
  40 #define CONFDIR         "/etc/iproute2"
  41 #endif
  42
  43 #define SPRINT_BSIZE 64
  44 #define SPRINT_BUF(x)   char x[SPRINT_BSIZE]
  45
  46 void incomplete_command(void) __attribute__((noreturn));
  47
  48 #define NEXT_ARG() do { argv++; if (--argc <= 0) incomplete_command(); } while(0)
  49 #define NEXT_ARG_OK() (argc - 1 > 0)
  50 #define NEXT_ARG_FWD() do { argv++; argc--; } while(0)
  51 #define PREV_ARG() do { argv--; argc++; } while(0)
  52
  53 #define TIME_UNITS_PER_SEC      1000000
  54 #define NSEC_PER_USEC 1000
  55 #define NSEC_PER_MSEC 1000000
  56 #define NSEC_PER_SEC 1000000000LL
  57
  58 typedef struct
  59 {
  60         __u16 flags;
  61         __u16 bytelen;
  62         __s16 bitlen;
  63         /* These next two fields match rtvia */
  64         __u16 family;
  65         __u32 data[64];
  66 } inet_prefix;
  67
  68 enum {
  69         PREFIXLEN_SPECIFIED     = (1 << 0),
  70         ADDRTYPE_INET           = (1 << 1),
  71         ADDRTYPE_UNSPEC         = (1 << 2),
  72         ADDRTYPE_MULTI          = (1 << 3),
  73
  74         ADDRTYPE_INET_UNSPEC    = ADDRTYPE_INET | ADDRTYPE_UNSPEC,
  75         ADDRTYPE_INET_MULTI     = ADDRTYPE_INET | ADDRTYPE_MULTI
  76 };
  77
  78 static inline void inet_prefix_reset(inet_prefix *p)
  79 {
  80         p->flags = 0;
  81 }
  82
  83 static inline bool is_addrtype_inet(const inet_prefix *p)
  84 {
  85         return p->flags & ADDRTYPE_INET;
  86 }
  87
  88 static inline bool is_addrtype_inet_unspec(const inet_prefix *p)
  89 {
  90         return (p->flags & ADDRTYPE_INET_UNSPEC) == ADDRTYPE_INET_UNSPEC;
  91 }
  92
  93 static inline bool is_addrtype_inet_multi(const inet_prefix *p)
  94 {
  95         return (p->flags & ADDRTYPE_INET_MULTI) == ADDRTYPE_INET_MULTI;
  96 }
  97
  98 static inline bool is_addrtype_inet_not_unspec(const inet_prefix *p)
  99 {
 100         return (p->flags & ADDRTYPE_INET_UNSPEC) == ADDRTYPE_INET;
 101 }
 102
 103 static inline bool is_addrtype_inet_not_multi(const inet_prefix *p)
 104 {
 105         return (p->flags & ADDRTYPE_INET_MULTI) == ADDRTYPE_INET;
 106 }
 107
 108 #define DN_MAXADDL 20
 109 #ifndef AF_DECnet
 110 #define AF_DECnet 12
 111 #endif
 112
 113 struct dn_naddr
 114 {
 115         unsigned short          a_len;
 116         unsigned char a_addr[DN_MAXADDL];
 117 };
 118
 119 #ifndef AF_MPLS
 120 # define AF_MPLS 28
 121 #endif
 122 #ifndef IPPROTO_MPLS
 123 #define IPPROTO_MPLS    137
 124 #endif
 125
 126 #ifndef CLOCK_TAI
 127 # define CLOCK_TAI 11
 128 #endif
 129
 130 #ifndef AF_XDP
 131 # define AF_XDP 44
 132 # if AF_MAX < 45
 133 #  undef AF_MAX
 134 #  define AF_MAX 45
 135 # endif
 136 #endif
 137
 138 __u32 get_addr32(const char *name);
 139 int get_addr_1(inet_prefix *dst, const char *arg, int family);
 140 int get_prefix_1(inet_prefix *dst, char *arg, int family);
 141 int get_addr(inet_prefix *dst, const char *arg, int family);
 142 int get_prefix(inet_prefix *dst, char *arg, int family);
 143 int mask2bits(__u32 netmask);
 144 int get_addr_rta(inet_prefix *dst, const struct rtattr *rta, int family);
 145 int get_addr_ila(__u64 *val, const char *arg);
 146
 147 int read_prop(const char *dev, char *prop, long *value);
 148 int get_hex(char c);
 149 int get_integer(int *val, const char *arg, int base);
 150 int get_unsigned(unsigned *val, const char *arg, int base);
 151 int get_time_rtt(unsigned *val, const char *arg, int *raw);
 152 #define get_byte get_u8
 153 #define get_ushort get_u16
 154 #define get_short get_s16
 155 int get_s64(__s64 *val, const char *arg, int base);
 156 int get_u64(__u64 *val, const char *arg, int base);
 157 int get_u32(__u32 *val, const char *arg, int base);
 158 int get_s32(__s32 *val, const char *arg, int base);
 159 int get_u16(__u16 *val, const char *arg, int base);
 160 int get_u8(__u8 *val, const char *arg, int base);
 161 int get_be64(__be64 *val, const char *arg, int base);
 162 int get_be32(__be32 *val, const char *arg, int base);
 163 int get_be16(__be16 *val, const char *arg, int base);
 164 int get_addr64(__u64 *ap, const char *cp);
 165 int get_rate(unsigned int *rate, const char *str);
 166 int get_rate64(__u64 *rate, const char *str);
 167
 168 int hex2mem(const char *buf, uint8_t *mem, int count);
 169 char *hexstring_n2a(const __u8 *str, int len, char *buf, int blen);
 170 __u8 *hexstring_a2n(const char *str, __u8 *buf, int blen, unsigned int *len);
 171 #define ADDR64_BUF_SIZE sizeof("xxxx:xxxx:xxxx:xxxx")
 172 int addr64_n2a(__u64 addr, char *buff, size_t len);
 173
 174 int af_bit_len(int af);
 175
 176 const char *format_host_r(int af, int len, const void *addr,
 177                                char *buf, int buflen);
 178 #define format_host_rta_r(af, rta, buf, buflen) \
 179         format_host_r(af, RTA_PAYLOAD(rta), RTA_DATA(rta), \
 180                       buf, buflen)
 181
 182 const char *format_host(int af, int lne, const void *addr);
 183 #define format_host_rta(af, rta) \
 184         format_host(af, RTA_PAYLOAD(rta), RTA_DATA(rta))
 185 const char *rt_addr_n2a_r(int af, int len, const void *addr,
 186                                char *buf, int buflen);
 187 const char *rt_addr_n2a(int af, int len, const void *addr);
 188 #define rt_addr_n2a_rta(af, rta) \
 189         rt_addr_n2a(af, RTA_PAYLOAD(rta), RTA_DATA(rta))
 190
 191 int read_family(const char *name);
 192 const char *family_name(int family);
 193
 194 void missarg(const char *) __attribute__((noreturn));
 195 void invarg(const char *, const char *) __attribute__((noreturn));
 196 void duparg(const char *, const char *) __attribute__((noreturn));
 197 void duparg2(const char *, const char *) __attribute__((noreturn));
 198 int nodev(const char *dev);
 199 int check_ifname(const char *);
 200 int check_altifname(const char *name);
 201 int get_ifname(char *, const char *);
 202 const char *get_ifname_rta(int ifindex, const struct rtattr *rta);
 203 bool matches(const char *prefix, const char *string);
 204 int inet_addr_match(const inet_prefix *a, const inet_prefix *b, int bits);
 205 int inet_addr_match_rta(const inet_prefix *m, const struct rtattr *rta);
 206
 207 const char *mpls_ntop(int af, const void *addr, char *str, size_t len);
 208 int mpls_pton(int af, const char *src, void *addr, size_t alen);
 209
 210 extern int __iproute2_hz_internal;
 211 int __get_hz(void);
 212
 213 static __inline__ int get_hz(void)
 214 {
 215         if (__iproute2_hz_internal == 0)
 216                 __iproute2_hz_internal = __get_hz();
 217         return __iproute2_hz_internal;
 218 }
 219
 220 extern int __iproute2_user_hz_internal;
 221 int __get_user_hz(void);
 222
 223 static __inline__ int get_user_hz(void)
 224 {
 225         if (__iproute2_user_hz_internal == 0)
 226                 __iproute2_user_hz_internal = __get_user_hz();
 227         return __iproute2_user_hz_internal;
 228 }
 229
 230 static inline __u32 nl_mgrp(__u32 group)
 231 {
 232         if (group > 31 ) {
 233                 fprintf(stderr, "Use setsockopt for this group %d\n", group);
 234                 exit(-1);
 235         }
 236         return group ? (1 << (group - 1)) : 0;
 237 }
 238
 239 /* courtesy of bridge-utils */
 240 static inline unsigned long __tv_to_jiffies(const struct timeval *tv)
 241 {
 242         unsigned long long jif;
 243
 244         jif = 1000000ULL * tv->tv_sec + tv->tv_usec;
 245
 246         return jif/10000;
 247 }
 248
 249 static inline void __jiffies_to_tv(struct timeval *tv, unsigned long jiffies)
 250 {
 251         unsigned long long tvusec;
 252
 253         tvusec = 10000ULL*jiffies;
 254         tv->tv_sec = tvusec/1000000;
 255         tv->tv_usec = tvusec - 1000000 * tv->tv_sec;
 256 }
 257
 258 void print_escape_buf(const __u8 *buf, size_t len, const char *escape);
 259
 260 int print_timestamp(FILE *fp);
 261 void print_nlmsg_timestamp(FILE *fp, const struct nlmsghdr *n);
 262
 263 unsigned int print_name_and_link(const char *fmt,
 264                                  const char *name, struct rtattr *tb[]);
 265
 266 #define BIT(nr)                 (1UL << (nr))
 267
 268 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 269
 270 #define BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
 271
 272 #ifndef offsetof
 273 # define offsetof(type, member) ((size_t) &((type *)0)->member)
 274 #endif
 275
 276 #ifndef min
 277 # define min(x, y) ({                   \
 278         typeof(x) _min1 = (x);          \
 279         typeof(y) _min2 = (y);          \
 280         (void) (&_min1 == &_min2);      \
 281         _min1 < _min2 ? _min1 : _min2; })
 282 #endif
 283
 284 #ifndef __check_format_string
 285 # define __check_format_string(pos_str, pos_args) \
 286         __attribute__ ((format (printf, (pos_str), (pos_args))))
 287 #endif
 288
 289 #define _textify(x)     #x
 290 #define textify(x)      _textify(x)
 291
 292 #define htonll(x) ((1==htonl(1)) ? (x) : ((uint64_t)htonl((x) & 0xFFFFFFFF) << 32) | htonl((x) >> 32))
 293 #define ntohll(x) ((1==ntohl(1)) ? (x) : ((uint64_t)ntohl((x) & 0xFFFFFFFF) << 32) | ntohl((x) >> 32))
 294
 295 extern int cmdlineno;
 296 ssize_t getcmdline(char **line, size_t *len, FILE *in);
 297 int makeargs(char *line, char *argv[], int maxargs);
 298
 299 char *int_to_str(int val, char *buf);
 300 int get_guid(__u64 *guid, const char *arg);
 301 int get_real_family(int rtm_type, int rtm_family);
 302
 303 int cmd_exec(const char *cmd, char **argv, bool do_fork,
 304              int (*setup)(void *), void *arg);
 305 int make_path(const char *path, mode_t mode);
 306 char *find_cgroup2_mount(bool do_mount);
 307 __u64 get_cgroup2_id(const char *path);
 308 char *get_cgroup2_path(__u64 id, bool full);
 309 int get_command_name(const char *pid, char *comm, size_t len);
 310
 311 int get_rtnl_link_stats_rta(struct rtnl_link_stats64 *stats64,
 312                             struct rtattr *tb[]);
 313
 314 #ifdef NEED_STRLCPY
 315 size_t strlcpy(char *dst, const char *src, size_t size);
 316 size_t strlcat(char *dst, const char *src, size_t size);
 317 #endif
 318
 319 void drop_cap(void);
 320
 321 int get_time(unsigned int *time, const char *str);
 322 int get_time64(__s64 *time, const char *str);
 323 char *sprint_time(__u32 time, char *buf);
 324 char *sprint_time64(__s64 time, char *buf);
 325
 326 int do_batch(const char *name, bool force,
 327              int (*cmd)(int argc, char *argv[], void *user), void *user);
 328
 329 int parse_one_of(const char *msg, const char *realval, const char * const *list,
 330                  size_t len, int *p_err);
 331 bool parse_on_off(const char *msg, const char *realval, int *p_err);
 332
 333 int parse_mapping(int *argcp, char ***argvp, bool allow_all,
 334                   int (*mapping_cb)(__u32 key, char *value, void *data),
 335                   void *mapping_cb_data);
 336
 337 #endif /* __UTILS_H__ */