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