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