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