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