]> git.proxmox.com Git - mirror_iproute2.git/blame - include/libnetlink.h
libnetlink: Convert GETNEIGH dumps 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);
46917d08
DA
49
50int rtnl_addrdump_req(struct rtnl_handle *rth, int family)
51 __attribute__((warn_unused_result));
39360023
DA
52int rtnl_addrlbldump_req(struct rtnl_handle *rth, int family)
53 __attribute__((warn_unused_result));
bfb27dfa
DA
54int rtnl_routedump_req(struct rtnl_handle *rth, int family)
55 __attribute__((warn_unused_result));
b05d9a3d
DA
56int rtnl_ruledump_req(struct rtnl_handle *rth, int family)
57 __attribute__((warn_unused_result));
9e0ab19c
DA
58int rtnl_neighdump_req(struct rtnl_handle *rth, int family)
59 __attribute__((warn_unused_result));
9dbe6df4
DA
60int rtnl_mdbdump_req(struct rtnl_handle *rth, int family)
61 __attribute__((warn_unused_result));
ddee16bc
DA
62int rtnl_netconfdump_req(struct rtnl_handle *rth, int family)
63 __attribute__((warn_unused_result));
46917d08 64
892e2124 65int rtnl_wilddump_request(struct rtnl_handle *rth, int fam, int type)
d2468da0 66 __attribute__((warn_unused_result));
892e2124 67int rtnl_wilddump_req_filter(struct rtnl_handle *rth, int fam, int type,
d2468da0
SH
68 __u32 filt_mask)
69 __attribute__((warn_unused_result));
b0a4ce62
DA
70
71typedef int (*req_filter_fn_t)(struct nlmsghdr *nlh, int reqlen);
72
73int rtnl_wilddump_req_filter_fn(struct rtnl_handle *rth, int fam, int type,
74 req_filter_fn_t fn)
75 __attribute__((warn_unused_result));
7abf5de6
NA
76int rtnl_wilddump_stats_req_filter(struct rtnl_handle *rth, int fam, int type,
77 __u32 filt_mask)
78 __attribute__((warn_unused_result));
892e2124 79int rtnl_dump_request(struct rtnl_handle *rth, int type, void *req,
d2468da0
SH
80 int len)
81 __attribute__((warn_unused_result));
0d238ca2
DA
82int rtnl_dump_request_n(struct rtnl_handle *rth, struct nlmsghdr *n)
83 __attribute__((warn_unused_result));
6dc9f016 84
0628cddd 85struct rtnl_ctrl_data {
449b824a 86 int nsid;
0628cddd
ND
87};
88
ae665a52 89typedef int (*rtnl_filter_t)(const struct sockaddr_nl *,
50772dc5 90 struct nlmsghdr *n, void *);
b49240ec 91
0628cddd
ND
92typedef int (*rtnl_listen_filter_t)(const struct sockaddr_nl *,
93 struct rtnl_ctrl_data *,
94 struct nlmsghdr *n, void *);
95
b6432e68
SH
96typedef int (*nl_ext_ack_fn_t)(const char *errmsg, uint32_t off,
97 const struct nlmsghdr *inner_nlh);
98
e9e9365b 99struct rtnl_dump_filter_arg {
b49240ec
SH
100 rtnl_filter_t filter;
101 void *arg1;
8e72880f 102 __u16 nc_flags;
b49240ec
SH
103};
104
892e2124 105int rtnl_dump_filter_l(struct rtnl_handle *rth,
b49240ec 106 const struct rtnl_dump_filter_arg *arg);
8e72880f
PS
107int rtnl_dump_filter_nc(struct rtnl_handle *rth,
108 rtnl_filter_t filter,
109 void *arg, __u16 nc_flags);
110#define rtnl_dump_filter(rth, filter, arg) \
111 rtnl_dump_filter_nc(rth, filter, arg, 0)
892e2124 112int rtnl_talk(struct rtnl_handle *rtnl, struct nlmsghdr *n,
86bf43c7 113 struct nlmsghdr **answer)
d2468da0 114 __attribute__((warn_unused_result));
72a2ff39
CM
115int rtnl_talk_iov(struct rtnl_handle *rtnl, struct iovec *iovec, size_t iovlen,
116 struct nlmsghdr **answer)
117 __attribute__((warn_unused_result));
b6432e68 118int rtnl_talk_extack(struct rtnl_handle *rtnl, struct nlmsghdr *n,
86bf43c7 119 struct nlmsghdr **answer, nl_ext_ack_fn_t errfn)
b6432e68 120 __attribute__((warn_unused_result));
463d9efa 121int rtnl_talk_suppress_rtnl_errmsg(struct rtnl_handle *rtnl, struct nlmsghdr *n,
86bf43c7 122 struct nlmsghdr **answer)
463d9efa 123 __attribute__((warn_unused_result));
892e2124 124int rtnl_send(struct rtnl_handle *rth, const void *buf, int)
d2468da0 125 __attribute__((warn_unused_result));
892e2124 126int rtnl_send_check(struct rtnl_handle *rth, const void *buf, int)
d2468da0 127 __attribute__((warn_unused_result));
049c5853 128int nl_dump_ext_ack(const struct nlmsghdr *nlh, nl_ext_ack_fn_t errfn);
aba5acdf 129
892e2124
SH
130int addattr(struct nlmsghdr *n, int maxlen, int type);
131int addattr8(struct nlmsghdr *n, int maxlen, int type, __u8 data);
132int addattr16(struct nlmsghdr *n, int maxlen, int type, __u16 data);
133int addattr32(struct nlmsghdr *n, int maxlen, int type, __u32 data);
134int addattr64(struct nlmsghdr *n, int maxlen, int type, __u64 data);
135int addattrstrz(struct nlmsghdr *n, int maxlen, int type, const char *data);
136
137int addattr_l(struct nlmsghdr *n, int maxlen, int type,
138 const void *data, int alen);
139int addraw_l(struct nlmsghdr *n, int maxlen, const void *data, int len);
140struct rtattr *addattr_nest(struct nlmsghdr *n, int maxlen, int type);
141int addattr_nest_end(struct nlmsghdr *n, struct rtattr *nest);
142struct rtattr *addattr_nest_compat(struct nlmsghdr *n, int maxlen, int type,
143 const void *data, int len);
144int addattr_nest_compat_end(struct nlmsghdr *n, struct rtattr *nest);
303cc9cb
RP
145int rta_addattr8(struct rtattr *rta, int maxlen, int type, __u8 data);
146int rta_addattr16(struct rtattr *rta, int maxlen, int type, __u16 data);
892e2124 147int rta_addattr32(struct rtattr *rta, int maxlen, int type, __u32 data);
303cc9cb 148int rta_addattr64(struct rtattr *rta, int maxlen, int type, __u64 data);
892e2124
SH
149int rta_addattr_l(struct rtattr *rta, int maxlen, int type,
150 const void *data, int alen);
151
152int parse_rtattr(struct rtattr *tb[], int max, struct rtattr *rta, int len);
153int parse_rtattr_flags(struct rtattr *tb[], int max, struct rtattr *rta,
b1b7ce0f 154 int len, unsigned short flags);
892e2124
SH
155int parse_rtattr_byindex(struct rtattr *tb[], int max,
156 struct rtattr *rta, int len);
157struct rtattr *parse_rtattr_one(int type, struct rtattr *rta, int len);
158int __parse_rtattr_nested_compat(struct rtattr *tb[], int max, struct rtattr *rta, int len);
aba5acdf 159
303cc9cb
RP
160struct rtattr *rta_nest(struct rtattr *rta, int maxlen, int type);
161int rta_nest_end(struct rtattr *rta, struct rtattr *nest);
162
163#define RTA_TAIL(rta) \
164 ((struct rtattr *) (((void *) (rta)) + \
165 RTA_ALIGN((rta)->rta_len)))
166
753fca4f 167#define parse_rtattr_nested(tb, max, rta) \
168 (parse_rtattr((tb), (max), RTA_DATA(rta), RTA_PAYLOAD(rta)))
169
decbb437
JP
170#define parse_rtattr_one_nested(type, rta) \
171 (parse_rtattr_one(type, RTA_DATA(rta), RTA_PAYLOAD(rta)))
172
2f90c9c0 173#define parse_rtattr_nested_compat(tb, max, rta, data, len) \
cd70f3f5
SH
174 ({ data = RTA_PAYLOAD(rta) >= len ? RTA_DATA(rta) : NULL; \
175 __parse_rtattr_nested_compat(tb, max, rta, len); })
2f90c9c0 176
7dd03712
SH
177static inline __u8 rta_getattr_u8(const struct rtattr *rta)
178{
179 return *(__u8 *)RTA_DATA(rta);
180}
46c5d64d
SH
181static inline __u16 rta_getattr_u16(const struct rtattr *rta)
182{
183 return *(__u16 *)RTA_DATA(rta);
184}
aab0f610
AV
185static inline __be16 rta_getattr_be16(const struct rtattr *rta)
186{
187 return ntohs(rta_getattr_u16(rta));
188}
7dd03712 189static inline __u32 rta_getattr_u32(const struct rtattr *rta)
46c5d64d
SH
190{
191 return *(__u32 *)RTA_DATA(rta);
192}
aab0f610
AV
193static inline __be32 rta_getattr_be32(const struct rtattr *rta)
194{
195 return ntohl(rta_getattr_u32(rta));
196}
46c5d64d
SH
197static inline __u64 rta_getattr_u64(const struct rtattr *rta)
198{
199 __u64 tmp;
e9e9365b 200
46c5d64d
SH
201 memcpy(&tmp, RTA_DATA(rta), sizeof(__u64));
202 return tmp;
203}
204static inline const char *rta_getattr_str(const struct rtattr *rta)
205{
cfd2cbd1 206 return (const char *)RTA_DATA(rta);
46c5d64d
SH
207}
208
892e2124
SH
209int rtnl_listen_all_nsid(struct rtnl_handle *);
210int rtnl_listen(struct rtnl_handle *, rtnl_listen_filter_t handler,
211 void *jarg);
212int rtnl_from_file(FILE *, rtnl_listen_filter_t handler,
213 void *jarg);
aba5acdf 214
370d67ba 215#define NLMSG_TAIL(nmsg) \
216 ((struct rtattr *) (((void *) (nmsg)) + NLMSG_ALIGN((nmsg)->nlmsg_len)))
217
ead2ba70
SH
218#ifndef IFA_RTA
219#define IFA_RTA(r) \
e9e9365b 220 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ifaddrmsg))))
ead2ba70
SH
221#endif
222#ifndef IFA_PAYLOAD
e9e9365b 223#define IFA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ifaddrmsg))
ead2ba70
SH
224#endif
225
226#ifndef IFLA_RTA
227#define IFLA_RTA(r) \
e9e9365b 228 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ifinfomsg))))
ead2ba70
SH
229#endif
230#ifndef IFLA_PAYLOAD
e9e9365b 231#define IFLA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ifinfomsg))
ead2ba70
SH
232#endif
233
234#ifndef NDA_RTA
235#define NDA_RTA(r) \
e9e9365b 236 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ndmsg))))
ead2ba70
SH
237#endif
238#ifndef NDA_PAYLOAD
e9e9365b 239#define NDA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ndmsg))
ead2ba70
SH
240#endif
241
242#ifndef NDTA_RTA
243#define NDTA_RTA(r) \
e9e9365b 244 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct ndtmsg))))
ead2ba70
SH
245#endif
246#ifndef NDTA_PAYLOAD
e9e9365b 247#define NDTA_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct ndtmsg))
ead2ba70
SH
248#endif
249
d182ee13
ND
250#ifndef NETNS_RTA
251#define NETNS_RTA(r) \
e9e9365b 252 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct rtgenmsg))))
d182ee13
ND
253#endif
254#ifndef NETNS_PAYLOAD
e9e9365b 255#define NETNS_PAYLOAD(n) NLMSG_PAYLOAD(n, sizeof(struct rtgenmsg))
d182ee13
ND
256#endif
257
7abf5de6
NA
258#ifndef IFLA_STATS_RTA
259#define IFLA_STATS_RTA(r) \
260 ((struct rtattr *)(((char *)(r)) + NLMSG_ALIGN(sizeof(struct if_stats_msg))))
261#endif
262
27b14f2e
VK
263/* User defined nlmsg_type which is used mostly for logging netlink
264 * messages from dump file */
265#define NLMSG_TSTAMP 15
266
aba5acdf 267#endif /* __LIBNETLINK_H__ */