]> git.proxmox.com Git - mirror_iproute2.git/blame - include/libnetlink.h
ip neigh: Convert do_show_or_flush to use rtnl_neighdump_req
[mirror_iproute2.git] / include / libnetlink.h
CommitLineData
6054c1eb 1/* SPDX-License-Identifier: GPL-2.0 */
aba5acdf
SH
2#ifndef __LIBNETLINK_H__
3#define __LIBNETLINK_H__ 1
4
5bd9dd49 5#include <stdio.h>
f5b830dc 6#include <string.h>
aba5acdf
SH
7#include <asm/types.h>
8#include <linux/netlink.h>
9#include <linux/rtnetlink.h>
ead2ba70
SH
10#include <linux/if_link.h>
11#include <linux/if_addr.h>
12#include <linux/neighbour.h>
9d0efc10 13#include <linux/netconf.h>
aab0f610 14#include <arpa/inet.h>
aba5acdf 15
e9e9365b 16struct rtnl_handle {
aba5acdf
SH
17 int fd;
18 struct sockaddr_nl local;
19 struct sockaddr_nl peer;
20 __u32 seq;
21 __u32 dump;
8a4025f6 22 int proto;
486ccd99 23 FILE *dump_fp;
449b824a 24#define RTNL_HANDLE_F_LISTEN_ALL_NSID 0x01
3ad6d176 25#define RTNL_HANDLE_F_SUPPRESS_NLERR 0x02
449b824a 26 int flags;
aba5acdf
SH
27};
28
4ad87594
DA
29struct nlmsg_list {
30 struct nlmsg_list *next;
31 struct nlmsghdr h;
32};
33
34struct nlmsg_chain {
35 struct nlmsg_list *head;
36 struct nlmsg_list *tail;
37};
38
7f03191f
PM
39extern int rcvbuf;
40
e9e9365b 41int rtnl_open(struct rtnl_handle *rth, unsigned int subscriptions)
d2468da0
SH
42 __attribute__((warn_unused_result));
43
e9e9365b 44int rtnl_open_byproto(struct rtnl_handle *rth, unsigned int subscriptions,
d2468da0
SH
45 int protocol)
46 __attribute__((warn_unused_result));
47
892e2124 48void rtnl_close(struct rtnl_handle *rth);
aea41afc 49void rtnl_set_strict_dump(struct rtnl_handle *rth);
46917d08 50
43fd93ae
DA
51typedef int (*req_filter_fn_t)(struct nlmsghdr *nlh, int reqlen);
52
88470978
DA
53int rtnl_addrdump_req(struct rtnl_handle *rth, int family,
54 req_filter_fn_t filter_fn)
46917d08 55 __attribute__((warn_unused_result));
39360023
DA
56int rtnl_addrlbldump_req(struct rtnl_handle *rth, int family)
57 __attribute__((warn_unused_result));
43fd93ae
DA
58int rtnl_routedump_req(struct rtnl_handle *rth, int family,
59 req_filter_fn_t filter_fn)
bfb27dfa 60 __attribute__((warn_unused_result));
b05d9a3d
DA
61int rtnl_ruledump_req(struct rtnl_handle *rth, int family)
62 __attribute__((warn_unused_result));
f255ab12
DA
63int rtnl_neighdump_req(struct rtnl_handle *rth, int family,
64 req_filter_fn_t filter_fn)
9e0ab19c 65 __attribute__((warn_unused_result));
ff41db8a
DA
66int rtnl_neightbldump_req(struct rtnl_handle *rth, int family)
67 __attribute__((warn_unused_result));
9dbe6df4
DA
68int rtnl_mdbdump_req(struct rtnl_handle *rth, int family)
69 __attribute__((warn_unused_result));
ddee16bc
DA
70int rtnl_netconfdump_req(struct rtnl_handle *rth, int family)
71 __attribute__((warn_unused_result));
efb0b383
DA
72int rtnl_nsiddump_req(struct rtnl_handle *rth, int family)
73 __attribute__((warn_unused_result));
46917d08 74
31ae2912 75int rtnl_linkdump_req(struct rtnl_handle *rth, int fam)
d2468da0 76 __attribute__((warn_unused_result));
31ae2912 77int rtnl_linkdump_req_filter(struct rtnl_handle *rth, int fam, __u32 filt_mask)
d2468da0 78 __attribute__((warn_unused_result));
b0a4ce62 79
31ae2912 80int rtnl_linkdump_req_filter_fn(struct rtnl_handle *rth, int fam,
b0a4ce62
DA
81 req_filter_fn_t fn)
82 __attribute__((warn_unused_result));
56eeeda9 83int rtnl_statsdump_req_filter(struct rtnl_handle *rth, int fam, __u32 filt_mask)
7abf5de6 84 __attribute__((warn_unused_result));
892e2124 85int rtnl_dump_request(struct rtnl_handle *rth, int type, void *req,
d2468da0
SH
86 int len)
87 __attribute__((warn_unused_result));
0d238ca2
DA
88int rtnl_dump_request_n(struct rtnl_handle *rth, struct nlmsghdr *n)
89 __attribute__((warn_unused_result));
6dc9f016 90
0628cddd 91struct rtnl_ctrl_data {
449b824a 92 int nsid;
0628cddd
ND
93};
94
cd554f2c 95typedef int (*rtnl_filter_t)(struct nlmsghdr *n, void *);
b49240ec 96
cd554f2c 97typedef int (*rtnl_listen_filter_t)(struct rtnl_ctrl_data *,
0628cddd
ND
98 struct nlmsghdr *n, void *);
99
b6432e68
SH
100typedef int (*nl_ext_ack_fn_t)(const char *errmsg, uint32_t off,
101 const struct nlmsghdr *inner_nlh);
102
e9e9365b 103struct rtnl_dump_filter_arg {
b49240ec
SH
104 rtnl_filter_t filter;
105 void *arg1;
8e72880f 106 __u16 nc_flags;
b49240ec
SH
107};
108
8e72880f
PS
109int rtnl_dump_filter_nc(struct rtnl_handle *rth,
110 rtnl_filter_t filter,
111 void *arg, __u16 nc_flags);
112#define rtnl_dump_filter(rth, filter, arg) \
113 rtnl_dump_filter_nc(rth, filter, arg, 0)
892e2124 114int rtnl_talk(struct rtnl_handle *rtnl, struct nlmsghdr *n,
86bf43c7 115 struct nlmsghdr **answer)
d2468da0 116 __attribute__((warn_unused_result));
72a2ff39
CM
117int rtnl_talk_iov(struct rtnl_handle *rtnl, struct iovec *iovec, size_t iovlen,
118 struct nlmsghdr **answer)
119 __attribute__((warn_unused_result));
463d9efa 120int rtnl_talk_suppress_rtnl_errmsg(struct rtnl_handle *rtnl, struct nlmsghdr *n,
86bf43c7 121 struct nlmsghdr **answer)
463d9efa 122 __attribute__((warn_unused_result));
892e2124 123int rtnl_send(struct rtnl_handle *rth, const void *buf, int)
d2468da0 124 __attribute__((warn_unused_result));
892e2124 125int rtnl_send_check(struct rtnl_handle *rth, const void *buf, int)
d2468da0 126 __attribute__((warn_unused_result));
049c5853 127int nl_dump_ext_ack(const struct nlmsghdr *nlh, nl_ext_ack_fn_t errfn);
aba5acdf 128
892e2124
SH
129int addattr(struct nlmsghdr *n, int maxlen, int type);
130int addattr8(struct nlmsghdr *n, int maxlen, int type, __u8 data);
131int addattr16(struct nlmsghdr *n, int maxlen, int type, __u16 data);
132int addattr32(struct nlmsghdr *n, int maxlen, int type, __u32 data);
133int addattr64(struct nlmsghdr *n, int maxlen, int type, __u64 data);
134int addattrstrz(struct nlmsghdr *n, int maxlen, int type, const char *data);
135
136int addattr_l(struct nlmsghdr *n, int maxlen, int type,
137 const void *data, int alen);
138int addraw_l(struct nlmsghdr *n, int maxlen, const void *data, int len);
139struct rtattr *addattr_nest(struct nlmsghdr *n, int maxlen, int type);
140int addattr_nest_end(struct nlmsghdr *n, struct rtattr *nest);
141struct rtattr *addattr_nest_compat(struct nlmsghdr *n, int maxlen, int type,
142 const void *data, int len);
143int addattr_nest_compat_end(struct nlmsghdr *n, struct rtattr *nest);
303cc9cb
RP
144int rta_addattr8(struct rtattr *rta, int maxlen, int type, __u8 data);
145int rta_addattr16(struct rtattr *rta, int maxlen, int type, __u16 data);
892e2124 146int rta_addattr32(struct rtattr *rta, int maxlen, int type, __u32 data);
303cc9cb 147int rta_addattr64(struct rtattr *rta, int maxlen, int type, __u64 data);
892e2124
SH
148int rta_addattr_l(struct rtattr *rta, int maxlen, int type,
149 const void *data, int alen);
150
151int parse_rtattr(struct rtattr *tb[], int max, struct rtattr *rta, int len);
152int parse_rtattr_flags(struct rtattr *tb[], int max, struct rtattr *rta,
b1b7ce0f 153 int len, unsigned short flags);
892e2124
SH
154struct rtattr *parse_rtattr_one(int type, struct rtattr *rta, int len);
155int __parse_rtattr_nested_compat(struct rtattr *tb[], int max, struct rtattr *rta, int len);
aba5acdf 156
303cc9cb
RP
157struct rtattr *rta_nest(struct rtattr *rta, int maxlen, int type);
158int rta_nest_end(struct rtattr *rta, struct rtattr *nest);
159
160#define RTA_TAIL(rta) \
161 ((struct rtattr *) (((void *) (rta)) + \
162 RTA_ALIGN((rta)->rta_len)))
163
753fca4f 164#define parse_rtattr_nested(tb, max, rta) \
165 (parse_rtattr((tb), (max), RTA_DATA(rta), RTA_PAYLOAD(rta)))
166
decbb437
JP
167#define parse_rtattr_one_nested(type, rta) \
168 (parse_rtattr_one(type, RTA_DATA(rta), RTA_PAYLOAD(rta)))
169
2f90c9c0 170#define parse_rtattr_nested_compat(tb, max, rta, data, len) \
cd70f3f5
SH
171 ({ data = RTA_PAYLOAD(rta) >= len ? RTA_DATA(rta) : NULL; \
172 __parse_rtattr_nested_compat(tb, max, rta, len); })
2f90c9c0 173
7dd03712
SH
174static inline __u8 rta_getattr_u8(const struct rtattr *rta)
175{
176 return *(__u8 *)RTA_DATA(rta);
177}
46c5d64d
SH
178static inline __u16 rta_getattr_u16(const struct rtattr *rta)
179{
180 return *(__u16 *)RTA_DATA(rta);
181}
aab0f610
AV
182static inline __be16 rta_getattr_be16(const struct rtattr *rta)
183{
184 return ntohs(rta_getattr_u16(rta));
185}
7dd03712 186static inline __u32 rta_getattr_u32(const struct rtattr *rta)
46c5d64d
SH
187{
188 return *(__u32 *)RTA_DATA(rta);
189}
aab0f610
AV
190static inline __be32 rta_getattr_be32(const struct rtattr *rta)
191{
192 return ntohl(rta_getattr_u32(rta));
193}
46c5d64d
SH
194static inline __u64 rta_getattr_u64(const struct rtattr *rta)
195{
196 __u64 tmp;
e9e9365b 197
46c5d64d
SH
198 memcpy(&tmp, RTA_DATA(rta), sizeof(__u64));
199 return tmp;
200}
d791f3ad
JSP
201static inline __s32 rta_getattr_s32(const struct rtattr *rta)
202{
203 return *(__s32 *)RTA_DATA(rta);
204}
de63cd90
VCG
205static inline __s64 rta_getattr_s64(const struct rtattr *rta)
206{
207 __s64 tmp;
208
209 memcpy(&tmp, RTA_DATA(rta), sizeof(tmp));
210 return tmp;
211}
46c5d64d
SH
212static inline const char *rta_getattr_str(const struct rtattr *rta)
213{
cfd2cbd1 214 return (const char *)RTA_DATA(rta);
46c5d64d
SH
215}
216
892e2124
SH
217int rtnl_listen_all_nsid(struct rtnl_handle *);
218int rtnl_listen(struct rtnl_handle *, rtnl_listen_filter_t handler,
219 void *jarg);
220int rtnl_from_file(FILE *, rtnl_listen_filter_t handler,
221 void *jarg);
aba5acdf 222
370d67ba 223#define NLMSG_TAIL(nmsg) \
224 ((struct rtattr *) (((void *) (nmsg)) + NLMSG_ALIGN((nmsg)->nlmsg_len)))
225
ead2ba70
SH
226#ifndef IFA_RTA
227#define IFA_RTA(r) \
e9e9365b 228 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ifaddrmsg))))
ead2ba70
SH
229#endif
230#ifndef IFA_PAYLOAD
e9e9365b 231#define IFA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ifaddrmsg))
ead2ba70
SH
232#endif
233
234#ifndef IFLA_RTA
235#define IFLA_RTA(r) \
e9e9365b 236 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ifinfomsg))))
ead2ba70
SH
237#endif
238#ifndef IFLA_PAYLOAD
e9e9365b 239#define IFLA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ifinfomsg))
ead2ba70
SH
240#endif
241
242#ifndef NDA_RTA
243#define NDA_RTA(r) \
e9e9365b 244 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ndmsg))))
ead2ba70
SH
245#endif
246#ifndef NDA_PAYLOAD
e9e9365b 247#define NDA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ndmsg))
ead2ba70
SH
248#endif
249
250#ifndef NDTA_RTA
251#define NDTA_RTA(r) \
e9e9365b 252 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ndtmsg))))
ead2ba70
SH
253#endif
254#ifndef NDTA_PAYLOAD
e9e9365b 255#define NDTA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ndtmsg))
ead2ba70
SH
256#endif
257
d182ee13
ND
258#ifndef NETNS_RTA
259#define NETNS_RTA(r) \
e9e9365b 260 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct rtgenmsg))))
d182ee13
ND
261#endif
262#ifndef NETNS_PAYLOAD
e9e9365b 263#define NETNS_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct rtgenmsg))
d182ee13
ND
264#endif
265
7abf5de6
NA
266#ifndef IFLA_STATS_RTA
267#define IFLA_STATS_RTA(r) \
268 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct if_stats_msg))))
269#endif
270
27b14f2e
VK
271/* User defined nlmsg_type which is used mostly for logging netlink
272 * messages from dump file */
273#define NLMSG_TSTAMP 15
274
aba5acdf 275#endif /* __LIBNETLINK_H__ */