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