xref: /freebsd/tests/sys/netlink/test_snl.c (revision 65eaf726201cd81ecbc17b266786a042bccdf473)
1f2c8381fSAlexander V. Chernikov #include <stdio.h>
2f2c8381fSAlexander V. Chernikov #include <string.h>
3f2c8381fSAlexander V. Chernikov #include <stdlib.h>
4f2c8381fSAlexander V. Chernikov 
5f2c8381fSAlexander V. Chernikov #include <sys/param.h>
6f2c8381fSAlexander V. Chernikov #include <sys/module.h>
7f2c8381fSAlexander V. Chernikov 
8f2c8381fSAlexander V. Chernikov #include <netlink/netlink.h>
9f2c8381fSAlexander V. Chernikov #include <netlink/netlink_route.h>
10f2c8381fSAlexander V. Chernikov #include "netlink/netlink_snl.h"
11f2c8381fSAlexander V. Chernikov #include "netlink/netlink_snl_route.h"
12595d23f7SAlexander V. Chernikov #include "netlink/netlink_snl_route_parsers.h"
13f2c8381fSAlexander V. Chernikov 
14f2c8381fSAlexander V. Chernikov #include <atf-c.h>
15f2c8381fSAlexander V. Chernikov 
16*65eaf726SJohn Baldwin static const struct snl_hdr_parser *snl_all_core_parsers[] = {
17*65eaf726SJohn Baldwin 	&snl_errmsg_parser, &snl_donemsg_parser,
18*65eaf726SJohn Baldwin 	&_nla_bit_parser, &_nla_bitset_parser,
19*65eaf726SJohn Baldwin };
20*65eaf726SJohn Baldwin 
21*65eaf726SJohn Baldwin static const struct snl_hdr_parser *snl_all_route_parsers[] = {
22*65eaf726SJohn Baldwin 	&_metrics_mp_nh_parser, &_mpath_nh_parser, &_metrics_parser, &snl_rtm_route_parser,
23*65eaf726SJohn Baldwin 	&_link_fbsd_parser, &snl_rtm_link_parser, &snl_rtm_link_parser_simple,
24*65eaf726SJohn Baldwin 	&_neigh_fbsd_parser, &snl_rtm_neigh_parser,
25*65eaf726SJohn Baldwin 	&_addr_fbsd_parser, &snl_rtm_addr_parser, &_nh_fbsd_parser, &snl_nhmsg_parser,
26*65eaf726SJohn Baldwin };
27*65eaf726SJohn Baldwin 
28f2c8381fSAlexander V. Chernikov static void
require_netlink(void)29f2c8381fSAlexander V. Chernikov require_netlink(void)
30f2c8381fSAlexander V. Chernikov {
31f2c8381fSAlexander V. Chernikov 	if (modfind("netlink") == -1)
32f2c8381fSAlexander V. Chernikov 		atf_tc_skip("netlink module not loaded");
33f2c8381fSAlexander V. Chernikov }
34f2c8381fSAlexander V. Chernikov 
3573ae25c1SAlexander V. Chernikov ATF_TC(snl_verify_core_parsers);
ATF_TC_HEAD(snl_verify_core_parsers,tc)3673ae25c1SAlexander V. Chernikov ATF_TC_HEAD(snl_verify_core_parsers, tc)
37595d23f7SAlexander V. Chernikov {
3873ae25c1SAlexander V. Chernikov 	atf_tc_set_md_var(tc, "descr", "Tests snl(3) core nlmsg parsers are correct");
39595d23f7SAlexander V. Chernikov }
40595d23f7SAlexander V. Chernikov 
ATF_TC_BODY(snl_verify_core_parsers,tc)4173ae25c1SAlexander V. Chernikov ATF_TC_BODY(snl_verify_core_parsers, tc)
4273ae25c1SAlexander V. Chernikov {
4373ae25c1SAlexander V. Chernikov 	SNL_VERIFY_PARSERS(snl_all_core_parsers);
4473ae25c1SAlexander V. Chernikov 
4573ae25c1SAlexander V. Chernikov }
4673ae25c1SAlexander V. Chernikov 
4773ae25c1SAlexander V. Chernikov ATF_TC(snl_verify_route_parsers);
ATF_TC_HEAD(snl_verify_route_parsers,tc)4873ae25c1SAlexander V. Chernikov ATF_TC_HEAD(snl_verify_route_parsers, tc)
4973ae25c1SAlexander V. Chernikov {
5073ae25c1SAlexander V. Chernikov 	atf_tc_set_md_var(tc, "descr", "Tests snl(3) route parsers are correct");
5173ae25c1SAlexander V. Chernikov }
5273ae25c1SAlexander V. Chernikov 
ATF_TC_BODY(snl_verify_route_parsers,tc)5373ae25c1SAlexander V. Chernikov ATF_TC_BODY(snl_verify_route_parsers, tc)
54595d23f7SAlexander V. Chernikov {
55595d23f7SAlexander V. Chernikov 	SNL_VERIFY_PARSERS(snl_all_route_parsers);
56595d23f7SAlexander V. Chernikov 
57595d23f7SAlexander V. Chernikov }
58f2c8381fSAlexander V. Chernikov 
59568a645bSAlexander V. Chernikov ATF_TC(snl_parse_errmsg_capped);
ATF_TC_HEAD(snl_parse_errmsg_capped,tc)60568a645bSAlexander V. Chernikov ATF_TC_HEAD(snl_parse_errmsg_capped, tc)
61568a645bSAlexander V. Chernikov {
62568a645bSAlexander V. Chernikov 	atf_tc_set_md_var(tc, "descr", "Tests snl(3) correctly parsing capped errors");
63568a645bSAlexander V. Chernikov }
64568a645bSAlexander V. Chernikov 
ATF_TC_BODY(snl_parse_errmsg_capped,tc)65568a645bSAlexander V. Chernikov ATF_TC_BODY(snl_parse_errmsg_capped, tc)
66568a645bSAlexander V. Chernikov {
67568a645bSAlexander V. Chernikov 	struct snl_state ss;
68568a645bSAlexander V. Chernikov 	struct snl_writer nw;
69568a645bSAlexander V. Chernikov 
70568a645bSAlexander V. Chernikov 	require_netlink();
71568a645bSAlexander V. Chernikov 
72568a645bSAlexander V. Chernikov 	if (!snl_init(&ss, NETLINK_ROUTE))
73568a645bSAlexander V. Chernikov 		atf_tc_fail("snl_init() failed");
74568a645bSAlexander V. Chernikov 
7504dacd56SAlexander V. Chernikov 	atf_tc_skip("does not work");
7604dacd56SAlexander V. Chernikov 
77568a645bSAlexander V. Chernikov 	int optval = 1;
78568a645bSAlexander V. Chernikov 	ATF_CHECK(setsockopt(ss.fd, SOL_NETLINK, NETLINK_CAP_ACK, &optval, sizeof(optval)) == 0);
79568a645bSAlexander V. Chernikov 
80568a645bSAlexander V. Chernikov 	snl_init_writer(&ss, &nw);
81568a645bSAlexander V. Chernikov 
82568a645bSAlexander V. Chernikov 	struct nlmsghdr *hdr = snl_create_msg_request(&nw, 255);
83568a645bSAlexander V. Chernikov 	ATF_CHECK(hdr != NULL);
84568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_reserve_msg_object(&nw, struct ifinfomsg) != NULL);
85568a645bSAlexander V. Chernikov 	snl_add_msg_attr_string(&nw, 143, "some random string");
86568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_finalize_msg(&nw) != NULL);
87568a645bSAlexander V. Chernikov 
88568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_send_message(&ss, hdr));
89568a645bSAlexander V. Chernikov 
90568a645bSAlexander V. Chernikov 	struct nlmsghdr *rx_hdr = snl_read_reply(&ss, hdr->nlmsg_seq);
91568a645bSAlexander V. Chernikov 	ATF_CHECK(rx_hdr != NULL);
92568a645bSAlexander V. Chernikov 	ATF_CHECK(rx_hdr->nlmsg_type == NLMSG_ERROR);
93568a645bSAlexander V. Chernikov 
94568a645bSAlexander V. Chernikov 	struct snl_errmsg_data e = {};
95568a645bSAlexander V. Chernikov 	ATF_CHECK(rx_hdr->nlmsg_len == sizeof(struct nlmsghdr) + sizeof(struct nlmsgerr));
96568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_parse_errmsg(&ss, rx_hdr, &e));
97568a645bSAlexander V. Chernikov 	ATF_CHECK(e.error != 0);
98568a645bSAlexander V. Chernikov 	ATF_CHECK(!memcmp(hdr, e.orig_hdr, sizeof(struct nlmsghdr)));
99568a645bSAlexander V. Chernikov }
100568a645bSAlexander V. Chernikov 
101568a645bSAlexander V. Chernikov ATF_TC(snl_parse_errmsg_capped_extack);
ATF_TC_HEAD(snl_parse_errmsg_capped_extack,tc)102568a645bSAlexander V. Chernikov ATF_TC_HEAD(snl_parse_errmsg_capped_extack, tc)
103568a645bSAlexander V. Chernikov {
104568a645bSAlexander V. Chernikov 	atf_tc_set_md_var(tc, "descr", "Tests snl(3) correctly parsing capped errors with extack");
105568a645bSAlexander V. Chernikov }
106568a645bSAlexander V. Chernikov 
ATF_TC_BODY(snl_parse_errmsg_capped_extack,tc)107568a645bSAlexander V. Chernikov ATF_TC_BODY(snl_parse_errmsg_capped_extack, tc)
108568a645bSAlexander V. Chernikov {
109568a645bSAlexander V. Chernikov 	struct snl_state ss;
110568a645bSAlexander V. Chernikov 	struct snl_writer nw;
111568a645bSAlexander V. Chernikov 
112568a645bSAlexander V. Chernikov 	require_netlink();
113568a645bSAlexander V. Chernikov 
114568a645bSAlexander V. Chernikov 	if (!snl_init(&ss, NETLINK_ROUTE))
115568a645bSAlexander V. Chernikov 		atf_tc_fail("snl_init() failed");
116568a645bSAlexander V. Chernikov 
117568a645bSAlexander V. Chernikov 	int optval = 1;
118568a645bSAlexander V. Chernikov 	ATF_CHECK(setsockopt(ss.fd, SOL_NETLINK, NETLINK_CAP_ACK, &optval, sizeof(optval)) == 0);
119568a645bSAlexander V. Chernikov 	optval = 1;
120568a645bSAlexander V. Chernikov 	ATF_CHECK(setsockopt(ss.fd, SOL_NETLINK, NETLINK_EXT_ACK, &optval, sizeof(optval)) == 0);
121568a645bSAlexander V. Chernikov 
122568a645bSAlexander V. Chernikov 	snl_init_writer(&ss, &nw);
123568a645bSAlexander V. Chernikov 
124568a645bSAlexander V. Chernikov 	struct nlmsghdr *hdr = snl_create_msg_request(&nw, 255);
125568a645bSAlexander V. Chernikov 	ATF_CHECK(hdr != NULL);
126568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_reserve_msg_object(&nw, struct ifinfomsg) != NULL);
127568a645bSAlexander V. Chernikov 	snl_add_msg_attr_string(&nw, 143, "some random string");
128568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_finalize_msg(&nw) != NULL);
129568a645bSAlexander V. Chernikov 
130568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_send_message(&ss, hdr));
131568a645bSAlexander V. Chernikov 
132568a645bSAlexander V. Chernikov 	struct nlmsghdr *rx_hdr = snl_read_reply(&ss, hdr->nlmsg_seq);
133568a645bSAlexander V. Chernikov 	ATF_CHECK(rx_hdr != NULL);
134568a645bSAlexander V. Chernikov 	ATF_CHECK(rx_hdr->nlmsg_type == NLMSG_ERROR);
135568a645bSAlexander V. Chernikov 
136568a645bSAlexander V. Chernikov 	struct snl_errmsg_data e = {};
137568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_parse_errmsg(&ss, rx_hdr, &e));
138568a645bSAlexander V. Chernikov 	ATF_CHECK(e.error != 0);
139568a645bSAlexander V. Chernikov 	ATF_CHECK(!memcmp(hdr, e.orig_hdr, sizeof(struct nlmsghdr)));
140568a645bSAlexander V. Chernikov 
141568a645bSAlexander V. Chernikov 	ATF_CHECK(e.error_str != NULL);
142568a645bSAlexander V. Chernikov }
143568a645bSAlexander V. Chernikov 
144568a645bSAlexander V. Chernikov ATF_TC(snl_parse_errmsg_uncapped_extack);
ATF_TC_HEAD(snl_parse_errmsg_uncapped_extack,tc)145568a645bSAlexander V. Chernikov ATF_TC_HEAD(snl_parse_errmsg_uncapped_extack, tc)
146568a645bSAlexander V. Chernikov {
147568a645bSAlexander V. Chernikov 	atf_tc_set_md_var(tc, "descr", "Tests snl(3) correctly parsing errors with extack");
148568a645bSAlexander V. Chernikov }
149568a645bSAlexander V. Chernikov 
ATF_TC_BODY(snl_parse_errmsg_uncapped_extack,tc)150568a645bSAlexander V. Chernikov ATF_TC_BODY(snl_parse_errmsg_uncapped_extack, tc)
151568a645bSAlexander V. Chernikov {
152568a645bSAlexander V. Chernikov 	struct snl_state ss;
153568a645bSAlexander V. Chernikov 	struct snl_writer nw;
154568a645bSAlexander V. Chernikov 
155568a645bSAlexander V. Chernikov 	require_netlink();
156568a645bSAlexander V. Chernikov 
157568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_init(&ss, NETLINK_ROUTE));
158568a645bSAlexander V. Chernikov 
159568a645bSAlexander V. Chernikov 	int optval = 1;
160568a645bSAlexander V. Chernikov 	ATF_CHECK(setsockopt(ss.fd, SOL_NETLINK, NETLINK_EXT_ACK, &optval, sizeof(optval)) == 0);
161568a645bSAlexander V. Chernikov 
162568a645bSAlexander V. Chernikov 	snl_init_writer(&ss, &nw);
163568a645bSAlexander V. Chernikov 
164568a645bSAlexander V. Chernikov 	struct nlmsghdr *hdr = snl_create_msg_request(&nw, 255);
165568a645bSAlexander V. Chernikov 	ATF_CHECK(hdr != NULL);
166568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_reserve_msg_object(&nw, struct ifinfomsg) != NULL);
167568a645bSAlexander V. Chernikov 	snl_add_msg_attr_string(&nw, 143, "some random string");
168568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_finalize_msg(&nw) != NULL);
169568a645bSAlexander V. Chernikov 
170568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_send_message(&ss, hdr));
171568a645bSAlexander V. Chernikov 
172568a645bSAlexander V. Chernikov 	struct nlmsghdr *rx_hdr = snl_read_reply(&ss, hdr->nlmsg_seq);
173568a645bSAlexander V. Chernikov 	ATF_CHECK(rx_hdr != NULL);
174568a645bSAlexander V. Chernikov 	ATF_CHECK(rx_hdr->nlmsg_type == NLMSG_ERROR);
175568a645bSAlexander V. Chernikov 
176568a645bSAlexander V. Chernikov 	struct snl_errmsg_data e = {};
177568a645bSAlexander V. Chernikov 	ATF_CHECK(snl_parse_errmsg(&ss, rx_hdr, &e));
178568a645bSAlexander V. Chernikov 	ATF_CHECK(e.error != 0);
179568a645bSAlexander V. Chernikov 	ATF_CHECK(!memcmp(hdr, e.orig_hdr, hdr->nlmsg_len));
180568a645bSAlexander V. Chernikov 
181568a645bSAlexander V. Chernikov 	ATF_CHECK(e.error_str != NULL);
182568a645bSAlexander V. Chernikov }
183568a645bSAlexander V. Chernikov 
184f2c8381fSAlexander V. Chernikov ATF_TC(snl_list_ifaces);
ATF_TC_HEAD(snl_list_ifaces,tc)185f2c8381fSAlexander V. Chernikov ATF_TC_HEAD(snl_list_ifaces, tc)
186f2c8381fSAlexander V. Chernikov {
187f2c8381fSAlexander V. Chernikov 	atf_tc_set_md_var(tc, "descr", "Tests snl(3) listing interfaces");
188f2c8381fSAlexander V. Chernikov }
189f2c8381fSAlexander V. Chernikov 
190f2c8381fSAlexander V. Chernikov struct nl_parsed_link {
191f2c8381fSAlexander V. Chernikov 	uint32_t		ifi_index;
192f2c8381fSAlexander V. Chernikov 	uint32_t		ifla_mtu;
193f2c8381fSAlexander V. Chernikov 	char			*ifla_ifname;
194f2c8381fSAlexander V. Chernikov };
195f2c8381fSAlexander V. Chernikov 
196f2c8381fSAlexander V. Chernikov #define	_IN(_field)	offsetof(struct ifinfomsg, _field)
197f2c8381fSAlexander V. Chernikov #define	_OUT(_field)	offsetof(struct nl_parsed_link, _field)
198f2c8381fSAlexander V. Chernikov static struct snl_attr_parser ap_link[] = {
199f2c8381fSAlexander V. Chernikov 	{ .type = IFLA_IFNAME, .off = _OUT(ifla_ifname), .cb = snl_attr_get_string },
200f2c8381fSAlexander V. Chernikov 	{ .type = IFLA_MTU, .off = _OUT(ifla_mtu), .cb = snl_attr_get_uint32 },
201f2c8381fSAlexander V. Chernikov };
202f2c8381fSAlexander V. Chernikov static struct snl_field_parser fp_link[] = {
203f2c8381fSAlexander V. Chernikov 	{.off_in = _IN(ifi_index), .off_out = _OUT(ifi_index), .cb = snl_field_get_uint32 },
204f2c8381fSAlexander V. Chernikov };
205f2c8381fSAlexander V. Chernikov #undef _IN
206f2c8381fSAlexander V. Chernikov #undef _OUT
207f2c8381fSAlexander V. Chernikov SNL_DECLARE_PARSER(link_parser, struct ifinfomsg, fp_link, ap_link);
208f2c8381fSAlexander V. Chernikov 
209f2c8381fSAlexander V. Chernikov 
ATF_TC_BODY(snl_list_ifaces,tc)210f2c8381fSAlexander V. Chernikov ATF_TC_BODY(snl_list_ifaces, tc)
211f2c8381fSAlexander V. Chernikov {
212f2c8381fSAlexander V. Chernikov 	struct snl_state ss;
21373ae25c1SAlexander V. Chernikov 	struct snl_writer nw;
214f2c8381fSAlexander V. Chernikov 
215f2c8381fSAlexander V. Chernikov 	require_netlink();
216f2c8381fSAlexander V. Chernikov 
217f2c8381fSAlexander V. Chernikov 	if (!snl_init(&ss, NETLINK_ROUTE))
218f2c8381fSAlexander V. Chernikov 		atf_tc_fail("snl_init() failed");
219f2c8381fSAlexander V. Chernikov 
22073ae25c1SAlexander V. Chernikov 	snl_init_writer(&ss, &nw);
221f2c8381fSAlexander V. Chernikov 
22273ae25c1SAlexander V. Chernikov 	struct nlmsghdr *hdr = snl_create_msg_request(&nw, RTM_GETLINK);
22373ae25c1SAlexander V. Chernikov 	ATF_CHECK(hdr != NULL);
22473ae25c1SAlexander V. Chernikov 	ATF_CHECK(snl_reserve_msg_object(&nw, struct ifinfomsg) != NULL);
22573ae25c1SAlexander V. Chernikov 	ATF_CHECK(snl_finalize_msg(&nw) != NULL);
22673ae25c1SAlexander V. Chernikov 	uint32_t seq_id = hdr->nlmsg_seq;
227f2c8381fSAlexander V. Chernikov 
22873ae25c1SAlexander V. Chernikov 	ATF_CHECK(snl_send_message(&ss, hdr));
22973ae25c1SAlexander V. Chernikov 
23073ae25c1SAlexander V. Chernikov 	struct snl_errmsg_data e = {};
231f2c8381fSAlexander V. Chernikov 	int count = 0;
232f2c8381fSAlexander V. Chernikov 
23373ae25c1SAlexander V. Chernikov 	while ((hdr = snl_read_reply_multi(&ss, seq_id, &e)) != NULL) {
234f2c8381fSAlexander V. Chernikov 		count++;
235f2c8381fSAlexander V. Chernikov 	}
23673ae25c1SAlexander V. Chernikov 	ATF_REQUIRE(e.error == 0);
23773ae25c1SAlexander V. Chernikov 
238f2c8381fSAlexander V. Chernikov 	ATF_REQUIRE_MSG(count > 0, "Empty interface list");
239f2c8381fSAlexander V. Chernikov }
240f2c8381fSAlexander V. Chernikov 
ATF_TP_ADD_TCS(tp)241f2c8381fSAlexander V. Chernikov ATF_TP_ADD_TCS(tp)
242f2c8381fSAlexander V. Chernikov {
24373ae25c1SAlexander V. Chernikov 	ATF_TP_ADD_TC(tp, snl_verify_core_parsers);
24473ae25c1SAlexander V. Chernikov 	ATF_TP_ADD_TC(tp, snl_verify_route_parsers);
245568a645bSAlexander V. Chernikov 	ATF_TP_ADD_TC(tp, snl_parse_errmsg_capped);
246568a645bSAlexander V. Chernikov 	ATF_TP_ADD_TC(tp, snl_parse_errmsg_capped_extack);
247568a645bSAlexander V. Chernikov 	ATF_TP_ADD_TC(tp, snl_parse_errmsg_uncapped_extack);
248f2c8381fSAlexander V. Chernikov 	ATF_TP_ADD_TC(tp, snl_list_ifaces);
249f2c8381fSAlexander V. Chernikov 
250f2c8381fSAlexander V. Chernikov 	return (atf_no_error());
251f2c8381fSAlexander V. Chernikov }
252