1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
6 #include <linux/types.h>
8 #include <libmnl/libmnl.h>
9 #include <linux/genetlink.h>
13 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof(*arr))
15 #define __yerr_msg(yse, _msg...) \
17 struct ynl_error *_yse = (yse); \
20 snprintf(_yse->msg, sizeof(_yse->msg) - 1, _msg); \
21 _yse->msg[sizeof(_yse->msg) - 1] = 0; \
25 #define __yerr_code(yse, _code...) \
27 struct ynl_error *_yse = (yse); \
34 #define __yerr(yse, _code, _msg...) \
36 __yerr_msg(yse, _msg); \
37 __yerr_code(yse, _code); \
40 #define __perr(yse, _msg) __yerr(yse, errno, _msg)
42 #define yerr_msg(_ys, _msg...) __yerr_msg(&(_ys)->err, _msg)
43 #define yerr(_ys, _code, _msg...) __yerr(&(_ys)->err, _code, _msg)
44 #define perr(_ys, _msg) __yerr(&(_ys)->err, errno, _msg)
46 /* -- Netlink boiler plate */
48 ynl_err_walk_report_one(struct ynl_policy_nest *policy, unsigned int type,
49 char *str, int str_sz, int *n)
53 *n += snprintf(str, str_sz, "!policy");
57 if (type > policy->max_attr) {
59 *n += snprintf(str, str_sz, "!oob");
63 if (!policy->table[type].name) {
65 *n += snprintf(str, str_sz, "!name");
70 *n += snprintf(str, str_sz - *n,
71 ".%s", policy->table[type].name);
76 ynl_err_walk(struct ynl_sock *ys, void *start, void *end, unsigned int off,
77 struct ynl_policy_nest *policy, char *str, int str_sz,
78 struct ynl_policy_nest **nest_pol)
80 unsigned int astart_off, aend_off;
81 const struct nlattr *attr;
82 unsigned int data_len;
89 n += snprintf(str, str_sz, "!policy");
93 data_len = end - start;
95 mnl_attr_for_each_payload(start, data_len) {
96 astart_off = (char *)attr - (char *)start;
97 aend_off = astart_off + mnl_attr_get_payload_len(attr);
109 type = mnl_attr_get_type(attr);
111 if (ynl_err_walk_report_one(policy, type, str, str_sz, &n))
116 *nest_pol = policy->table[type].nest;
120 if (!policy->table[type].nest) {
122 n += snprintf(str, str_sz, "!nest");
126 off -= sizeof(struct nlattr);
127 start = mnl_attr_get_payload(attr);
128 end = start + mnl_attr_get_payload_len(attr);
130 return n + ynl_err_walk(ys, start, end, off, policy->table[type].nest,
131 &str[n], str_sz - n, nest_pol);
134 #define NLMSGERR_ATTR_MISS_TYPE (NLMSGERR_ATTR_POLICY + 1)
135 #define NLMSGERR_ATTR_MISS_NEST (NLMSGERR_ATTR_POLICY + 2)
136 #define NLMSGERR_ATTR_MAX (NLMSGERR_ATTR_MAX + 2)
139 ynl_ext_ack_check(struct ynl_sock *ys, const struct nlmsghdr *nlh,
142 const struct nlattr *tb[NLMSGERR_ATTR_MAX + 1] = {};
143 char miss_attr[sizeof(ys->err.msg)];
144 char bad_attr[sizeof(ys->err.msg)];
145 const struct nlattr *attr;
146 const char *str = NULL;
148 if (!(nlh->nlmsg_flags & NLM_F_ACK_TLVS)) {
149 yerr_msg(ys, "%s", strerror(ys->err.code));
153 mnl_attr_for_each(attr, nlh, hlen) {
154 unsigned int len, type;
156 len = mnl_attr_get_payload_len(attr);
157 type = mnl_attr_get_type(attr);
159 if (type > NLMSGERR_ATTR_MAX)
165 case NLMSGERR_ATTR_OFFS:
166 case NLMSGERR_ATTR_MISS_TYPE:
167 case NLMSGERR_ATTR_MISS_NEST:
168 if (len != sizeof(__u32))
171 case NLMSGERR_ATTR_MSG:
172 str = mnl_attr_get_payload(attr);
184 if (tb[NLMSGERR_ATTR_OFFS]) {
188 ys->err.attr_offs = mnl_attr_get_u32(tb[NLMSGERR_ATTR_OFFS]);
190 n = snprintf(bad_attr, sizeof(bad_attr), "%sbad attribute: ",
193 start = mnl_nlmsg_get_payload_offset(ys->nlh,
194 ys->family->hdr_len);
195 end = mnl_nlmsg_get_payload_tail(ys->nlh);
197 off = ys->err.attr_offs;
198 off -= sizeof(struct nlmsghdr);
199 off -= ys->family->hdr_len;
201 n += ynl_err_walk(ys, start, end, off, ys->req_policy,
202 &bad_attr[n], sizeof(bad_attr) - n, NULL);
204 if (n >= sizeof(bad_attr))
205 n = sizeof(bad_attr) - 1;
208 if (tb[NLMSGERR_ATTR_MISS_TYPE]) {
209 struct ynl_policy_nest *nest_pol = NULL;
210 unsigned int n, off, type;
214 type = mnl_attr_get_u32(tb[NLMSGERR_ATTR_MISS_TYPE]);
216 n = snprintf(miss_attr, sizeof(miss_attr), "%smissing attribute: ",
217 bad_attr[0] ? ", " : (str ? " (" : ""));
219 start = mnl_nlmsg_get_payload_offset(ys->nlh,
220 ys->family->hdr_len);
221 end = mnl_nlmsg_get_payload_tail(ys->nlh);
223 nest_pol = ys->req_policy;
224 if (tb[NLMSGERR_ATTR_MISS_NEST]) {
225 off = mnl_attr_get_u32(tb[NLMSGERR_ATTR_MISS_NEST]);
226 off -= sizeof(struct nlmsghdr);
227 off -= ys->family->hdr_len;
229 n += ynl_err_walk(ys, start, end, off, ys->req_policy,
230 &miss_attr[n], sizeof(miss_attr) - n,
235 ynl_err_walk_report_one(nest_pol, type, &miss_attr[n],
236 sizeof(miss_attr) - n, &n2);
239 if (n >= sizeof(miss_attr))
240 n = sizeof(miss_attr) - 1;
244 /* Implicitly depend on ys->err.code already set */
246 yerr_msg(ys, "Kernel %s: '%s'%s%s%s",
247 ys->err.code ? "error" : "warning",
248 str, bad_attr, miss_attr,
249 bad_attr[0] || miss_attr[0] ? ")" : "");
250 else if (bad_attr[0] || miss_attr[0])
251 yerr_msg(ys, "Kernel %s: %s%s",
252 ys->err.code ? "error" : "warning",
253 bad_attr, miss_attr);
255 yerr_msg(ys, "%s", strerror(ys->err.code));
260 static int ynl_cb_error(const struct nlmsghdr *nlh, void *data)
262 const struct nlmsgerr *err = mnl_nlmsg_get_payload(nlh);
263 struct ynl_parse_arg *yarg = data;
267 code = err->error >= 0 ? err->error : -err->error;
268 yarg->ys->err.code = code;
272 if (!(nlh->nlmsg_flags & NLM_F_CAPPED))
273 hlen += mnl_nlmsg_get_payload_len(&err->msg);
275 ynl_ext_ack_check(yarg->ys, nlh, hlen);
277 return code ? MNL_CB_ERROR : MNL_CB_STOP;
280 static int ynl_cb_done(const struct nlmsghdr *nlh, void *data)
282 struct ynl_parse_arg *yarg = data;
285 err = *(int *)NLMSG_DATA(nlh);
287 yarg->ys->err.code = -err;
290 ynl_ext_ack_check(yarg->ys, nlh, sizeof(int));
297 static int ynl_cb_noop(const struct nlmsghdr *nlh, void *data)
302 mnl_cb_t ynl_cb_array[NLMSG_MIN_TYPE] = {
303 [NLMSG_NOOP] = ynl_cb_noop,
304 [NLMSG_ERROR] = ynl_cb_error,
305 [NLMSG_DONE] = ynl_cb_done,
306 [NLMSG_OVERRUN] = ynl_cb_noop,
309 /* Attribute validation */
311 int ynl_attr_validate(struct ynl_parse_arg *yarg, const struct nlattr *attr)
313 struct ynl_policy_attr *policy;
314 unsigned int type, len;
317 data = mnl_attr_get_payload(attr);
318 len = mnl_attr_get_payload_len(attr);
319 type = mnl_attr_get_type(attr);
320 if (type > yarg->rsp_policy->max_attr) {
321 yerr(yarg->ys, YNL_ERROR_INTERNAL,
322 "Internal error, validating unknown attribute");
326 policy = &yarg->rsp_policy->table[type];
328 switch (policy->type) {
330 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
331 "Rejected attribute (%s)", policy->name);
336 if (len == sizeof(__u8))
338 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
339 "Invalid attribute (u8 %s)", policy->name);
342 if (len == sizeof(__u16))
344 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
345 "Invalid attribute (u16 %s)", policy->name);
348 if (len == sizeof(__u32))
350 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
351 "Invalid attribute (u32 %s)", policy->name);
354 if (len == sizeof(__u64))
356 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
357 "Invalid attribute (u64 %s)", policy->name);
360 if (len == sizeof(__u32) || len == sizeof(__u64))
362 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
363 "Invalid attribute (uint %s)", policy->name);
366 /* Let flags grow into real attrs, why not.. */
369 if (!len || len >= sizeof(*attr))
371 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
372 "Invalid attribute (nest %s)", policy->name);
375 if (!policy->len || len == policy->len)
377 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
378 "Invalid attribute (binary %s)", policy->name);
381 if ((!policy->len || len <= policy->len) && !data[len - 1])
383 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
384 "Invalid attribute (string %s)", policy->name);
386 case YNL_PT_BITFIELD32:
387 if (len == sizeof(struct nla_bitfield32))
389 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
390 "Invalid attribute (bitfield32 %s)", policy->name);
393 yerr(yarg->ys, YNL_ERROR_ATTR_INVALID,
394 "Invalid attribute (unknown %s)", policy->name);
403 static void ynl_err_reset(struct ynl_sock *ys)
406 ys->err.attr_offs = 0;
410 struct nlmsghdr *ynl_msg_start(struct ynl_sock *ys, __u32 id, __u16 flags)
412 struct nlmsghdr *nlh;
416 nlh = ys->nlh = mnl_nlmsg_put_header(ys->tx_buf);
417 nlh->nlmsg_type = id;
418 nlh->nlmsg_flags = flags;
419 nlh->nlmsg_seq = ++ys->seq;
425 ynl_gemsg_start(struct ynl_sock *ys, __u32 id, __u16 flags,
426 __u8 cmd, __u8 version)
428 struct genlmsghdr gehdr;
429 struct nlmsghdr *nlh;
432 nlh = ynl_msg_start(ys, id, flags);
434 memset(&gehdr, 0, sizeof(gehdr));
436 gehdr.version = version;
438 data = mnl_nlmsg_put_extra_header(nlh, sizeof(gehdr));
439 memcpy(data, &gehdr, sizeof(gehdr));
444 void ynl_msg_start_req(struct ynl_sock *ys, __u32 id)
446 ynl_msg_start(ys, id, NLM_F_REQUEST | NLM_F_ACK);
449 void ynl_msg_start_dump(struct ynl_sock *ys, __u32 id)
451 ynl_msg_start(ys, id, NLM_F_REQUEST | NLM_F_ACK | NLM_F_DUMP);
455 ynl_gemsg_start_req(struct ynl_sock *ys, __u32 id, __u8 cmd, __u8 version)
457 return ynl_gemsg_start(ys, id, NLM_F_REQUEST | NLM_F_ACK, cmd, version);
461 ynl_gemsg_start_dump(struct ynl_sock *ys, __u32 id, __u8 cmd, __u8 version)
463 return ynl_gemsg_start(ys, id, NLM_F_REQUEST | NLM_F_ACK | NLM_F_DUMP,
467 int ynl_recv_ack(struct ynl_sock *ys, int ret)
469 struct ynl_parse_arg yarg = { .ys = ys, };
472 yerr(ys, YNL_ERROR_EXPECT_ACK,
473 "Expecting an ACK but nothing received");
477 ret = mnl_socket_recvfrom(ys->sock, ys->rx_buf, MNL_SOCKET_BUFFER_SIZE);
479 perr(ys, "Socket receive failed");
482 return mnl_cb_run(ys->rx_buf, ret, ys->seq, ys->portid,
486 int ynl_cb_null(const struct nlmsghdr *nlh, void *data)
488 struct ynl_parse_arg *yarg = data;
490 yerr(yarg->ys, YNL_ERROR_UNEXPECT_MSG,
491 "Received a message when none were expected");
496 /* Init/fini and genetlink boiler plate */
498 ynl_get_family_info_mcast(struct ynl_sock *ys, const struct nlattr *mcasts)
500 const struct nlattr *entry, *attr;
503 mnl_attr_for_each_nested(attr, mcasts)
504 ys->n_mcast_groups++;
506 if (!ys->n_mcast_groups)
509 ys->mcast_groups = calloc(ys->n_mcast_groups,
510 sizeof(*ys->mcast_groups));
511 if (!ys->mcast_groups)
515 mnl_attr_for_each_nested(entry, mcasts) {
516 mnl_attr_for_each_nested(attr, entry) {
517 if (mnl_attr_get_type(attr) == CTRL_ATTR_MCAST_GRP_ID)
518 ys->mcast_groups[i].id = mnl_attr_get_u32(attr);
519 if (mnl_attr_get_type(attr) == CTRL_ATTR_MCAST_GRP_NAME) {
520 strncpy(ys->mcast_groups[i].name,
521 mnl_attr_get_str(attr),
523 ys->mcast_groups[i].name[GENL_NAMSIZ - 1] = 0;
532 static int ynl_get_family_info_cb(const struct nlmsghdr *nlh, void *data)
534 struct ynl_parse_arg *yarg = data;
535 struct ynl_sock *ys = yarg->ys;
536 const struct nlattr *attr;
537 bool found_id = true;
539 mnl_attr_for_each(attr, nlh, sizeof(struct genlmsghdr)) {
540 if (mnl_attr_get_type(attr) == CTRL_ATTR_MCAST_GROUPS)
541 if (ynl_get_family_info_mcast(ys, attr))
544 if (mnl_attr_get_type(attr) != CTRL_ATTR_FAMILY_ID)
547 if (mnl_attr_get_payload_len(attr) != sizeof(__u16)) {
548 yerr(ys, YNL_ERROR_ATTR_INVALID, "Invalid family ID");
552 ys->family_id = mnl_attr_get_u16(attr);
557 yerr(ys, YNL_ERROR_ATTR_MISSING, "Family ID missing");
563 static int ynl_sock_read_family(struct ynl_sock *ys, const char *family_name)
565 struct ynl_parse_arg yarg = { .ys = ys, };
566 struct nlmsghdr *nlh;
569 nlh = ynl_gemsg_start_req(ys, GENL_ID_CTRL, CTRL_CMD_GETFAMILY, 1);
570 mnl_attr_put_strz(nlh, CTRL_ATTR_FAMILY_NAME, family_name);
572 err = mnl_socket_sendto(ys->sock, nlh, nlh->nlmsg_len);
574 perr(ys, "failed to request socket family info");
578 err = mnl_socket_recvfrom(ys->sock, ys->rx_buf, MNL_SOCKET_BUFFER_SIZE);
580 perr(ys, "failed to receive the socket family info");
583 err = mnl_cb_run2(ys->rx_buf, err, ys->seq, ys->portid,
584 ynl_get_family_info_cb, &yarg,
585 ynl_cb_array, ARRAY_SIZE(ynl_cb_array));
587 free(ys->mcast_groups);
588 perr(ys, "failed to receive the socket family info - no such family?");
592 err = ynl_recv_ack(ys, err);
594 free(ys->mcast_groups);
602 ynl_sock_create(const struct ynl_family *yf, struct ynl_error *yse)
607 ys = malloc(sizeof(*ys) + 2 * MNL_SOCKET_BUFFER_SIZE);
610 memset(ys, 0, sizeof(*ys));
613 ys->tx_buf = &ys->raw_buf[0];
614 ys->rx_buf = &ys->raw_buf[MNL_SOCKET_BUFFER_SIZE];
615 ys->ntf_last_next = &ys->ntf_first;
617 ys->sock = mnl_socket_open(NETLINK_GENERIC);
619 __perr(yse, "failed to create a netlink socket");
623 if (mnl_socket_setsockopt(ys->sock, NETLINK_CAP_ACK,
624 &one, sizeof(one))) {
625 __perr(yse, "failed to enable netlink ACK");
628 if (mnl_socket_setsockopt(ys->sock, NETLINK_EXT_ACK,
629 &one, sizeof(one))) {
630 __perr(yse, "failed to enable netlink ext ACK");
635 ys->portid = mnl_socket_get_portid(ys->sock);
637 if (ynl_sock_read_family(ys, yf->name)) {
639 memcpy(yse, &ys->err, sizeof(*yse));
646 mnl_socket_close(ys->sock);
652 void ynl_sock_destroy(struct ynl_sock *ys)
654 struct ynl_ntf_base_type *ntf;
656 mnl_socket_close(ys->sock);
657 while ((ntf = ynl_ntf_dequeue(ys)))
659 free(ys->mcast_groups);
663 /* YNL multicast handling */
665 void ynl_ntf_free(struct ynl_ntf_base_type *ntf)
670 int ynl_subscribe(struct ynl_sock *ys, const char *grp_name)
675 for (i = 0; i < ys->n_mcast_groups; i++)
676 if (!strcmp(ys->mcast_groups[i].name, grp_name))
678 if (i == ys->n_mcast_groups) {
679 yerr(ys, ENOENT, "Multicast group '%s' not found", grp_name);
683 err = mnl_socket_setsockopt(ys->sock, NETLINK_ADD_MEMBERSHIP,
684 &ys->mcast_groups[i].id,
685 sizeof(ys->mcast_groups[i].id));
687 perr(ys, "Subscribing to multicast group failed");
694 int ynl_socket_get_fd(struct ynl_sock *ys)
696 return mnl_socket_get_fd(ys->sock);
699 struct ynl_ntf_base_type *ynl_ntf_dequeue(struct ynl_sock *ys)
701 struct ynl_ntf_base_type *ntf;
703 if (!ynl_has_ntf(ys))
707 ys->ntf_first = ntf->next;
708 if (ys->ntf_last_next == &ntf->next)
709 ys->ntf_last_next = &ys->ntf_first;
714 static int ynl_ntf_parse(struct ynl_sock *ys, const struct nlmsghdr *nlh)
716 struct ynl_parse_arg yarg = { .ys = ys, };
717 const struct ynl_ntf_info *info;
718 struct ynl_ntf_base_type *rsp;
719 struct genlmsghdr *gehdr;
722 gehdr = mnl_nlmsg_get_payload(nlh);
723 if (gehdr->cmd >= ys->family->ntf_info_size)
725 info = &ys->family->ntf_info[gehdr->cmd];
729 rsp = calloc(1, info->alloc_sz);
730 rsp->free = info->free;
731 yarg.data = rsp->data;
732 yarg.rsp_policy = info->policy;
734 ret = info->cb(nlh, &yarg);
735 if (ret <= MNL_CB_STOP)
738 rsp->family = nlh->nlmsg_type;
739 rsp->cmd = gehdr->cmd;
741 *ys->ntf_last_next = rsp;
742 ys->ntf_last_next = &rsp->next;
751 static int ynl_ntf_trampoline(const struct nlmsghdr *nlh, void *data)
753 struct ynl_parse_arg *yarg = data;
755 return ynl_ntf_parse(yarg->ys, nlh);
758 int ynl_ntf_check(struct ynl_sock *ys)
760 struct ynl_parse_arg yarg = { .ys = ys, };
765 /* libmnl doesn't let us pass flags to the recv to make
766 * it non-blocking so we need to poll() or peek() :|
768 struct pollfd pfd = { };
770 pfd.fd = mnl_socket_get_fd(ys->sock);
772 err = poll(&pfd, 1, 1);
776 len = mnl_socket_recvfrom(ys->sock, ys->rx_buf,
777 MNL_SOCKET_BUFFER_SIZE);
781 err = mnl_cb_run2(ys->rx_buf, len, ys->seq, ys->portid,
782 ynl_ntf_trampoline, &yarg,
783 ynl_cb_array, NLMSG_MIN_TYPE);
791 /* YNL specific helpers used by the auto-generated code */
793 struct ynl_dump_list_type *YNL_LIST_END = (void *)(0xb4d123);
795 void ynl_error_unknown_notification(struct ynl_sock *ys, __u8 cmd)
797 yerr(ys, YNL_ERROR_UNKNOWN_NTF,
798 "Unknown notification message type '%d'", cmd);
801 int ynl_error_parse(struct ynl_parse_arg *yarg, const char *msg)
803 yerr(yarg->ys, YNL_ERROR_INV_RESP, "Error parsing response: %s", msg);
808 ynl_check_alien(struct ynl_sock *ys, const struct nlmsghdr *nlh, __u32 rsp_cmd)
810 struct genlmsghdr *gehdr;
812 if (mnl_nlmsg_get_payload_len(nlh) < sizeof(*gehdr)) {
813 yerr(ys, YNL_ERROR_INV_RESP,
814 "Kernel responded with truncated message");
818 gehdr = mnl_nlmsg_get_payload(nlh);
819 if (gehdr->cmd != rsp_cmd)
820 return ynl_ntf_parse(ys, nlh);
825 static int ynl_req_trampoline(const struct nlmsghdr *nlh, void *data)
827 struct ynl_req_state *yrs = data;
830 ret = ynl_check_alien(yrs->yarg.ys, nlh, yrs->rsp_cmd);
832 return ret < 0 ? MNL_CB_ERROR : MNL_CB_OK;
834 return yrs->cb(nlh, &yrs->yarg);
837 int ynl_exec(struct ynl_sock *ys, struct nlmsghdr *req_nlh,
838 struct ynl_req_state *yrs)
843 err = mnl_socket_sendto(ys->sock, req_nlh, req_nlh->nlmsg_len);
848 len = mnl_socket_recvfrom(ys->sock, ys->rx_buf,
849 MNL_SOCKET_BUFFER_SIZE);
853 err = mnl_cb_run2(ys->rx_buf, len, ys->seq, ys->portid,
854 ynl_req_trampoline, yrs,
855 ynl_cb_array, NLMSG_MIN_TYPE);
863 static int ynl_dump_trampoline(const struct nlmsghdr *nlh, void *data)
865 struct ynl_dump_state *ds = data;
866 struct ynl_dump_list_type *obj;
867 struct ynl_parse_arg yarg = {};
870 ret = ynl_check_alien(ds->ys, nlh, ds->rsp_cmd);
872 return ret < 0 ? MNL_CB_ERROR : MNL_CB_OK;
874 obj = calloc(1, ds->alloc_sz);
881 ds->last->next = obj;
885 yarg.rsp_policy = ds->rsp_policy;
886 yarg.data = &obj->data;
888 return ds->cb(nlh, &yarg);
891 static void *ynl_dump_end(struct ynl_dump_state *ds)
896 ds->last->next = YNL_LIST_END;
900 int ynl_exec_dump(struct ynl_sock *ys, struct nlmsghdr *req_nlh,
901 struct ynl_dump_state *yds)
906 err = mnl_socket_sendto(ys->sock, req_nlh, req_nlh->nlmsg_len);
911 len = mnl_socket_recvfrom(ys->sock, ys->rx_buf,
912 MNL_SOCKET_BUFFER_SIZE);
916 err = mnl_cb_run2(ys->rx_buf, len, ys->seq, ys->portid,
917 ynl_dump_trampoline, yds,
918 ynl_cb_array, NLMSG_MIN_TYPE);
923 yds->first = ynl_dump_end(yds);
927 yds->first = ynl_dump_end(yds);