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#include <stdint.h>
  12
  13#ifdef HAVE_LIBBSD
  14#include <bsd/string.h>
  15#endif
  16
  17#include "libnetlink.h"
  18#include "ll_map.h"
  19#include "rtm_map.h"
  20#include "json_print.h"
  21
  22extern int preferred_family;
  23extern int human_readable;
  24extern int show_stats;
  25extern int show_details;
  26extern int show_raw;
  27extern int resolve_hosts;
  28extern int oneline;
  29extern int brief;
  30extern int json;
  31extern int pretty;
  32extern int timestamp;
  33extern int timestamp_short;
  34extern const char * _SL_;
  35extern int max_flush_loops;
  36extern int batch_mode;
  37extern int numeric;
  38extern bool do_all;
  39
  40#ifndef CONFDIR
  41#define CONFDIR         "/etc/iproute2"
  42#endif
  43
  44#define SPRINT_BSIZE 64
  45#define SPRINT_BUF(x)   char x[SPRINT_BSIZE]
  46
  47void incomplete_command(void) __attribute__((noreturn));
  48
  49#define NEXT_ARG() do { argv++; if (--argc <= 0) incomplete_command(); } while(0)
  50#define NEXT_ARG_OK() (argc - 1 > 0)
  51#define NEXT_ARG_FWD() do { argv++; argc--; } while(0)
  52#define PREV_ARG() do { argv--; argc++; } while(0)
  53
  54/* Upper limit for batch mode */
  55#define MAX_ARGS 512
  56
  57#define TIME_UNITS_PER_SEC      1000000
  58#define NSEC_PER_USEC 1000
  59#define NSEC_PER_MSEC 1000000
  60#define NSEC_PER_SEC 1000000000LL
  61
  62typedef struct
  63{
  64        __u16 flags;
  65        __u16 bytelen;
  66        __s16 bitlen;
  67        /* These next two fields match rtvia */
  68        __u16 family;
  69        __u32 data[64];
  70} inet_prefix;
  71
  72enum {
  73        PREFIXLEN_SPECIFIED     = (1 << 0),
  74        ADDRTYPE_INET           = (1 << 1),
  75        ADDRTYPE_UNSPEC         = (1 << 2),
  76        ADDRTYPE_MULTI          = (1 << 3),
  77
  78        ADDRTYPE_INET_UNSPEC    = ADDRTYPE_INET | ADDRTYPE_UNSPEC,
  79        ADDRTYPE_INET_MULTI     = ADDRTYPE_INET | ADDRTYPE_MULTI
  80};
  81
  82static inline void inet_prefix_reset(inet_prefix *p)
  83{
  84        p->flags = 0;
  85}
  86
  87static inline bool is_addrtype_inet(const inet_prefix *p)
  88{
  89        return p->flags & ADDRTYPE_INET;
  90}
  91
  92static inline bool is_addrtype_inet_unspec(const inet_prefix *p)
  93{
  94        return (p->flags & ADDRTYPE_INET_UNSPEC) == ADDRTYPE_INET_UNSPEC;
  95}
  96
  97static inline bool is_addrtype_inet_multi(const inet_prefix *p)
  98{
  99        return (p->flags & ADDRTYPE_INET_MULTI) == ADDRTYPE_INET_MULTI;
 100}
 101
 102static inline bool is_addrtype_inet_not_unspec(const inet_prefix *p)
 103{
 104        return (p->flags & ADDRTYPE_INET_UNSPEC) == ADDRTYPE_INET;
 105}
 106
 107static inline bool is_addrtype_inet_not_multi(const inet_prefix *p)
 108{
 109        return (p->flags & ADDRTYPE_INET_MULTI) == ADDRTYPE_INET;
 110}
 111
 112#ifndef AF_MPLS
 113# define AF_MPLS 28
 114#endif
 115#ifndef IPPROTO_MPLS
 116#define IPPROTO_MPLS    137
 117#endif
 118
 119#ifndef CLOCK_TAI
 120# define CLOCK_TAI 11
 121#endif
 122
 123#ifndef AF_XDP
 124# define AF_XDP 44
 125# if AF_MAX < 45
 126#  undef AF_MAX
 127#  define AF_MAX 45
 128# endif
 129#endif
 130
 131__u32 get_addr32(const char *name);
 132int get_addr_1(inet_prefix *dst, const char *arg, int family);
 133int get_prefix_1(inet_prefix *dst, char *arg, int family);
 134int get_addr(inet_prefix *dst, const char *arg, int family);
 135int get_prefix(inet_prefix *dst, char *arg, int family);
 136int mask2bits(__u32 netmask);
 137int get_addr_rta(inet_prefix *dst, const struct rtattr *rta, int family);
 138int get_addr_ila(__u64 *val, const char *arg);
 139
 140int read_prop(const char *dev, char *prop, long *value);
 141int get_hex(char c);
 142int get_integer(int *val, const char *arg, int base);
 143int get_unsigned(unsigned *val, const char *arg, int base);
 144int get_time_rtt(unsigned *val, const char *arg, int *raw);
 145#define get_byte get_u8
 146#define get_ushort get_u16
 147#define get_short get_s16
 148int get_s64(__s64 *val, const char *arg, int base);
 149int get_u64(__u64 *val, const char *arg, int base);
 150int get_u32(__u32 *val, const char *arg, int base);
 151int get_s32(__s32 *val, const char *arg, int base);
 152int get_u16(__u16 *val, const char *arg, int base);
 153int get_u8(__u8 *val, const char *arg, int base);
 154int get_be64(__be64 *val, const char *arg, int base);
 155int get_be32(__be32 *val, const char *arg, int base);
 156int get_be16(__be16 *val, const char *arg, int base);
 157int get_addr64(__u64 *ap, const char *cp);
 158int get_rate(unsigned int *rate, const char *str);
 159int get_rate64(__u64 *rate, const char *str);
 160int get_size(unsigned int *size, const char *str);
 161
 162int hex2mem(const char *buf, uint8_t *mem, int count);
 163char *hexstring_n2a(const __u8 *str, int len, char *buf, int blen);
 164__u8 *hexstring_a2n(const char *str, __u8 *buf, int blen, unsigned int *len);
 165#define ADDR64_BUF_SIZE sizeof("xxxx:xxxx:xxxx:xxxx")
 166int addr64_n2a(__u64 addr, char *buff, size_t len);
 167
 168int af_bit_len(int af);
 169
 170const char *format_host_r(int af, int len, const void *addr,
 171                               char *buf, int buflen);
 172#define format_host_rta_r(af, rta, buf, buflen) \
 173        format_host_r(af, RTA_PAYLOAD(rta), RTA_DATA(rta), \
 174                      buf, buflen)
 175
 176const char *format_host(int af, int lne, const void *addr);
 177#define format_host_rta(af, rta) \
 178        format_host(af, RTA_PAYLOAD(rta), RTA_DATA(rta))
 179const char *rt_addr_n2a_r(int af, int len, const void *addr,
 180                               char *buf, int buflen);
 181const char *rt_addr_n2a(int af, int len, const void *addr);
 182#define rt_addr_n2a_rta(af, rta) \
 183        rt_addr_n2a(af, RTA_PAYLOAD(rta), RTA_DATA(rta))
 184
 185int read_family(const char *name);
 186const char *family_name(int family);
 187
 188void missarg(const char *) __attribute__((noreturn));
 189void invarg(const char *, const char *) __attribute__((noreturn));
 190void duparg(const char *, const char *) __attribute__((noreturn));
 191void duparg2(const char *, const char *) __attribute__((noreturn));
 192int nodev(const char *dev);
 193int check_ifname(const char *);
 194int check_altifname(const char *name);
 195int get_ifname(char *, const char *);
 196const char *get_ifname_rta(int ifindex, const struct rtattr *rta);
 197bool matches(const char *prefix, const char *string);
 198int inet_addr_match(const inet_prefix *a, const inet_prefix *b, int bits);
 199int inet_addr_match_rta(const inet_prefix *m, const struct rtattr *rta);
 200
 201const char *ax25_ntop(int af, const void *addr, char *str, socklen_t len);
 202
 203const char *rose_ntop(int af, const void *addr, char *buf, socklen_t buflen);
 204
 205const char *mpls_ntop(int af, const void *addr, char *str, size_t len);
 206int mpls_pton(int af, const char *src, void *addr, size_t alen);
 207
 208const char *netrom_ntop(int af, const void *addr, char *str, socklen_t len);
 209
 210extern int __iproute2_hz_internal;
 211int __get_hz(void);
 212
 213static __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
 220extern int __iproute2_user_hz_internal;
 221int __get_user_hz(void);
 222
 223static __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
 230static 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 */
 240static 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
 249static 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
 258void print_escape_buf(const __u8 *buf, size_t len, const char *escape);
 259
 260int print_timestamp(FILE *fp);
 261void print_nlmsg_timestamp(FILE *fp, const struct nlmsghdr *n);
 262
 263unsigned int print_name_and_link(const char *fmt,
 264                                 const char *name, struct rtattr *tb[]);
 265
 266#define BIT(nr)                 (UINT64_C(1) << (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
 295extern int cmdlineno;
 296ssize_t getcmdline(char **line, size_t *len, FILE *in);
 297int makeargs(char *line, char *argv[], int maxargs);
 298
 299char *int_to_str(int val, char *buf);
 300int get_guid(__u64 *guid, const char *arg);
 301int get_real_family(int rtm_type, int rtm_family);
 302
 303int cmd_exec(const char *cmd, char **argv, bool do_fork,
 304             int (*setup)(void *), void *arg);
 305int make_path(const char *path, mode_t mode);
 306char *find_cgroup2_mount(bool do_mount);
 307__u64 get_cgroup2_id(const char *path);
 308char *get_cgroup2_path(__u64 id, bool full);
 309int get_command_name(const char *pid, char *comm, size_t len);
 310char *get_task_name(pid_t pid);
 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_num_all(__u32 *keyp, const char *key);
 335int parse_mapping_gen(int *argcp, char ***argvp,
 336                      int (*key_cb)(__u32 *keyp, const char *key),
 337                      int (*mapping_cb)(__u32 key, char *value, void *data),
 338                      void *mapping_cb_data);
 339int parse_mapping(int *argcp, char ***argvp, bool allow_all,
 340                  int (*mapping_cb)(__u32 key, char *value, void *data),
 341                  void *mapping_cb_data);
 342
 343struct str_num_map {
 344        const char *str;
 345        unsigned int num;
 346};
 347
 348int str_map_lookup_str(const struct str_num_map *map, const char *needle);
 349const char *str_map_lookup_uint(const struct str_num_map *map,
 350                                unsigned int val);
 351const char *str_map_lookup_u16(const struct str_num_map *map, uint16_t val);
 352const char *str_map_lookup_u8(const struct str_num_map *map, uint8_t val);
 353
 354unsigned int get_str_char_count(const char *str, int match);
 355int str_split_by_char(char *str, char **before, char **after, int match);
 356
 357#define INDENT_STR_MAXLEN 32
 358
 359struct indent_mem {
 360        int indent_level;
 361        char indent_str[INDENT_STR_MAXLEN + 1];
 362};
 363
 364struct indent_mem *alloc_indent_mem(void);
 365void free_indent_mem(struct indent_mem *mem);
 366void inc_indent(struct indent_mem *mem);
 367void dec_indent(struct indent_mem *mem);
 368void print_indent(struct indent_mem *mem);
 369
 370#endif /* __UTILS_H__ */
 371