iproute2/include/utils.h
<<
>>
Prefs
   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
  21extern int preferred_family;
  22extern int human_readable;
  23extern int show_stats;
  24extern int show_details;
  25extern int show_raw;
  26extern int resolve_hosts;
  27extern int oneline;
  28extern int brief;
  29extern int json;
  30extern int pretty;
  31extern int timestamp;
  32extern int timestamp_short;
  33extern const char * _SL_;
  34extern int max_flush_loops;
  35extern int batch_mode;
  36extern int numeric;
  37extern 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
  46void 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
  58typedef 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
  68enum {
  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
  78static inline void inet_prefix_reset(inet_prefix *p)
  79{
  80        p->flags = 0;
  81}
  82
  83static inline bool is_addrtype_inet(const inet_prefix *p)
  84{
  85        return p->flags & ADDRTYPE_INET;
  86}
  87
  88static inline bool is_addrtype_inet_unspec(const inet_prefix *p)
  89{
  90        return (p->flags & ADDRTYPE_INET_UNSPEC) == ADDRTYPE_INET_UNSPEC;
  91}
  92
  93static inline bool is_addrtype_inet_multi(const inet_prefix *p)
  94{
  95        return (p->flags & ADDRTYPE_INET_MULTI) == ADDRTYPE_INET_MULTI;
  96}
  97
  98static inline bool is_addrtype_inet_not_unspec(const inet_prefix *p)
  99{
 100        return (p->flags & ADDRTYPE_INET_UNSPEC) == ADDRTYPE_INET;
 101}
 102
 103static 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
 113struct 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);
 139int get_addr_1(inet_prefix *dst, const char *arg, int family);
 140int get_prefix_1(inet_prefix *dst, char *arg, int family);
 141int get_addr(inet_prefix *dst, const char *arg, int family);
 142int get_prefix(inet_prefix *dst, char *arg, int family);
 143int mask2bits(__u32 netmask);
 144int get_addr_rta(inet_prefix *dst, const struct rtattr *rta, int family);
 145int get_addr_ila(__u64 *val, const char *arg);
 146
 147int read_prop(const char *dev, char *prop, long *value);
 148int get_hex(char c);
 149int get_integer(int *val, const char *arg, int base);
 150int get_unsigned(unsigned *val, const char *arg, int base);
 151int 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
 155int get_s64(__s64 *val, const char *arg, int base);
 156int get_u64(__u64 *val, const char *arg, int base);
 157int get_u32(__u32 *val, const char *arg, int base);
 158int get_s32(__s32 *val, const char *arg, int base);
 159int get_u16(__u16 *val, const char *arg, int base);
 160int get_u8(__u8 *val, const char *arg, int base);
 161int get_be64(__be64 *val, const char *arg, int base);
 162int get_be32(__be32 *val, const char *arg, int base);
 163int get_be16(__be16 *val, const char *arg, int base);
 164int get_addr64(__u64 *ap, const char *cp);
 165int get_rate(unsigned int *rate, const char *str);
 166int get_rate64(__u64 *rate, const char *str);
 167int get_size(unsigned int *size, const char *str);
 168
 169int hex2mem(const char *buf, uint8_t *mem, int count);
 170char *hexstring_n2a(const __u8 *str, int len, char *buf, int blen);
 171__u8 *hexstring_a2n(const char *str, __u8 *buf, int blen, unsigned int *len);
 172#define ADDR64_BUF_SIZE sizeof("xxxx:xxxx:xxxx:xxxx")
 173int addr64_n2a(__u64 addr, char *buff, size_t len);
 174
 175int af_bit_len(int af);
 176
 177const char *format_host_r(int af, int len, const void *addr,
 178                               char *buf, int buflen);
 179#define format_host_rta_r(af, rta, buf, buflen) \
 180        format_host_r(af, RTA_PAYLOAD(rta), RTA_DATA(rta), \
 181                      buf, buflen)
 182
 183const char *format_host(int af, int lne, const void *addr);
 184#define format_host_rta(af, rta) \
 185        format_host(af, RTA_PAYLOAD(rta), RTA_DATA(rta))
 186const char *rt_addr_n2a_r(int af, int len, const void *addr,
 187                               char *buf, int buflen);
 188const char *rt_addr_n2a(int af, int len, const void *addr);
 189#define rt_addr_n2a_rta(af, rta) \
 190        rt_addr_n2a(af, RTA_PAYLOAD(rta), RTA_DATA(rta))
 191
 192int read_family(const char *name);
 193const char *family_name(int family);
 194
 195void missarg(const char *) __attribute__((noreturn));
 196void invarg(const char *, const char *) __attribute__((noreturn));
 197void duparg(const char *, const char *) __attribute__((noreturn));
 198void duparg2(const char *, const char *) __attribute__((noreturn));
 199int nodev(const char *dev);
 200int check_ifname(const char *);
 201int check_altifname(const char *name);
 202int get_ifname(char *, const char *);
 203const char *get_ifname_rta(int ifindex, const struct rtattr *rta);
 204bool matches(const char *prefix, const char *string);
 205int inet_addr_match(const inet_prefix *a, const inet_prefix *b, int bits);
 206int inet_addr_match_rta(const inet_prefix *m, const struct rtattr *rta);
 207
 208const char *mpls_ntop(int af, const void *addr, char *str, size_t len);
 209int mpls_pton(int af, const char *src, void *addr, size_t alen);
 210
 211extern int __iproute2_hz_internal;
 212int __get_hz(void);
 213
 214static __inline__ int get_hz(void)
 215{
 216        if (__iproute2_hz_internal == 0)
 217                __iproute2_hz_internal = __get_hz();
 218        return __iproute2_hz_internal;
 219}
 220
 221extern int __iproute2_user_hz_internal;
 222int __get_user_hz(void);
 223
 224static __inline__ int get_user_hz(void)
 225{
 226        if (__iproute2_user_hz_internal == 0)
 227                __iproute2_user_hz_internal = __get_user_hz();
 228        return __iproute2_user_hz_internal;
 229}
 230
 231static inline __u32 nl_mgrp(__u32 group)
 232{
 233        if (group > 31 ) {
 234                fprintf(stderr, "Use setsockopt for this group %d\n", group);
 235                exit(-1);
 236        }
 237        return group ? (1 << (group - 1)) : 0;
 238}
 239
 240/* courtesy of bridge-utils */
 241static inline unsigned long __tv_to_jiffies(const struct timeval *tv)
 242{
 243        unsigned long long jif;
 244
 245        jif = 1000000ULL * tv->tv_sec + tv->tv_usec;
 246
 247        return jif/10000;
 248}
 249
 250static inline void __jiffies_to_tv(struct timeval *tv, unsigned long jiffies)
 251{
 252        unsigned long long tvusec;
 253
 254        tvusec = 10000ULL*jiffies;
 255        tv->tv_sec = tvusec/1000000;
 256        tv->tv_usec = tvusec - 1000000 * tv->tv_sec;
 257}
 258
 259void print_escape_buf(const __u8 *buf, size_t len, const char *escape);
 260
 261int print_timestamp(FILE *fp);
 262void print_nlmsg_timestamp(FILE *fp, const struct nlmsghdr *n);
 263
 264unsigned int print_name_and_link(const char *fmt,
 265                                 const char *name, struct rtattr *tb[]);
 266
 267#define BIT(nr)                 (1UL << (nr))
 268
 269#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 270
 271#define BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
 272
 273#ifndef offsetof
 274# define offsetof(type, member) ((size_t) &((type *)0)->member)
 275#endif
 276
 277#ifndef min
 278# define min(x, y) ({                   \
 279        typeof(x) _min1 = (x);          \
 280        typeof(y) _min2 = (y);          \
 281        (void) (&_min1 == &_min2);      \
 282        _min1 < _min2 ? _min1 : _min2; })
 283#endif
 284
 285#ifndef __check_format_string
 286# define __check_format_string(pos_str, pos_args) \
 287        __attribute__ ((format (printf, (pos_str), (pos_args))))
 288#endif
 289
 290#define _textify(x)     #x
 291#define textify(x)      _textify(x)
 292
 293#define htonll(x) ((1==htonl(1)) ? (x) : ((uint64_t)htonl((x) & 0xFFFFFFFF) << 32) | htonl((x) >> 32))
 294#define ntohll(x) ((1==ntohl(1)) ? (x) : ((uint64_t)ntohl((x) & 0xFFFFFFFF) << 32) | ntohl((x) >> 32))
 295
 296extern int cmdlineno;
 297ssize_t getcmdline(char **line, size_t *len, FILE *in);
 298int makeargs(char *line, char *argv[], int maxargs);
 299
 300char *int_to_str(int val, char *buf);
 301int get_guid(__u64 *guid, const char *arg);
 302int get_real_family(int rtm_type, int rtm_family);
 303
 304int cmd_exec(const char *cmd, char **argv, bool do_fork,
 305             int (*setup)(void *), void *arg);
 306int make_path(const char *path, mode_t mode);
 307char *find_cgroup2_mount(bool do_mount);
 308__u64 get_cgroup2_id(const char *path);
 309char *get_cgroup2_path(__u64 id, bool full);
 310int get_command_name(const char *pid, char *comm, size_t len);
 311
 312int get_rtnl_link_stats_rta(struct rtnl_link_stats64 *stats64,
 313                            struct rtattr *tb[]);
 314
 315#ifdef NEED_STRLCPY
 316size_t strlcpy(char *dst, const char *src, size_t size);
 317size_t strlcat(char *dst, const char *src, size_t size);
 318#endif
 319
 320void drop_cap(void);
 321
 322int get_time(unsigned int *time, const char *str);
 323int get_time64(__s64 *time, const char *str);
 324char *sprint_time(__u32 time, char *buf);
 325char *sprint_time64(__s64 time, char *buf);
 326
 327int do_batch(const char *name, bool force,
 328             int (*cmd)(int argc, char *argv[], void *user), void *user);
 329
 330int parse_one_of(const char *msg, const char *realval, const char * const *list,
 331                 size_t len, int *p_err);
 332bool parse_on_off(const char *msg, const char *realval, int *p_err);
 333
 334int parse_mapping(int *argcp, char ***argvp, bool allow_all,
 335                  int (*mapping_cb)(__u32 key, char *value, void *data),
 336                  void *mapping_cb_data);
 337
 338#endif /* __UTILS_H__ */
 339