2 * Bridge netlink control interface
5 * Stephen Hemminger <shemminger@osdl.org>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
13 #include <linux/kernel.h>
14 #include <linux/slab.h>
15 #include <linux/etherdevice.h>
16 #include <net/rtnetlink.h>
17 #include <net/net_namespace.h>
19 #include <net/switchdev.h>
20 #include <uapi/linux/if_bridge.h>
22 #include "br_private.h"
23 #include "br_private_stp.h"
25 static inline size_t br_port_info_size(void)
27 return nla_total_size(1) /* IFLA_BRPORT_STATE */
28 + nla_total_size(2) /* IFLA_BRPORT_PRIORITY */
29 + nla_total_size(4) /* IFLA_BRPORT_COST */
30 + nla_total_size(1) /* IFLA_BRPORT_MODE */
31 + nla_total_size(1) /* IFLA_BRPORT_GUARD */
32 + nla_total_size(1) /* IFLA_BRPORT_PROTECT */
33 + nla_total_size(1) /* IFLA_BRPORT_FAST_LEAVE */
34 + nla_total_size(1) /* IFLA_BRPORT_LEARNING */
35 + nla_total_size(1) /* IFLA_BRPORT_UNICAST_FLOOD */
39 static inline size_t br_nlmsg_size(void)
41 return NLMSG_ALIGN(sizeof(struct ifinfomsg))
42 + nla_total_size(IFNAMSIZ) /* IFLA_IFNAME */
43 + nla_total_size(MAX_ADDR_LEN) /* IFLA_ADDRESS */
44 + nla_total_size(4) /* IFLA_MASTER */
45 + nla_total_size(4) /* IFLA_MTU */
46 + nla_total_size(4) /* IFLA_LINK */
47 + nla_total_size(1) /* IFLA_OPERSTATE */
48 + nla_total_size(br_port_info_size()); /* IFLA_PROTINFO */
51 static int br_port_fill_attrs(struct sk_buff *skb,
52 const struct net_bridge_port *p)
54 u8 mode = !!(p->flags & BR_HAIRPIN_MODE);
56 if (nla_put_u8(skb, IFLA_BRPORT_STATE, p->state) ||
57 nla_put_u16(skb, IFLA_BRPORT_PRIORITY, p->priority) ||
58 nla_put_u32(skb, IFLA_BRPORT_COST, p->path_cost) ||
59 nla_put_u8(skb, IFLA_BRPORT_MODE, mode) ||
60 nla_put_u8(skb, IFLA_BRPORT_GUARD, !!(p->flags & BR_BPDU_GUARD)) ||
61 nla_put_u8(skb, IFLA_BRPORT_PROTECT, !!(p->flags & BR_ROOT_BLOCK)) ||
62 nla_put_u8(skb, IFLA_BRPORT_FAST_LEAVE, !!(p->flags & BR_MULTICAST_FAST_LEAVE)) ||
63 nla_put_u8(skb, IFLA_BRPORT_LEARNING, !!(p->flags & BR_LEARNING)) ||
64 nla_put_u8(skb, IFLA_BRPORT_UNICAST_FLOOD, !!(p->flags & BR_FLOOD)) ||
65 nla_put_u8(skb, IFLA_BRPORT_PROXYARP, !!(p->flags & BR_PROXYARP)))
71 static int br_fill_ifvlaninfo_range(struct sk_buff *skb, u16 vid_start,
72 u16 vid_end, u16 flags)
74 struct bridge_vlan_info vinfo;
76 if ((vid_end - vid_start) > 0) {
77 /* add range to skb */
78 vinfo.vid = vid_start;
79 vinfo.flags = flags | BRIDGE_VLAN_INFO_RANGE_BEGIN;
80 if (nla_put(skb, IFLA_BRIDGE_VLAN_INFO,
81 sizeof(vinfo), &vinfo))
84 vinfo.flags &= ~BRIDGE_VLAN_INFO_RANGE_BEGIN;
87 vinfo.flags = flags | BRIDGE_VLAN_INFO_RANGE_END;
88 if (nla_put(skb, IFLA_BRIDGE_VLAN_INFO,
89 sizeof(vinfo), &vinfo))
92 vinfo.vid = vid_start;
94 if (nla_put(skb, IFLA_BRIDGE_VLAN_INFO,
95 sizeof(vinfo), &vinfo))
105 static int br_fill_ifvlaninfo_compressed(struct sk_buff *skb,
106 const struct net_port_vlans *pv)
108 u16 vid_range_start = 0, vid_range_end = 0;
109 u16 vid_range_flags = 0;
110 u16 pvid, vid, flags;
113 /* Pack IFLA_BRIDGE_VLAN_INFO's for every vlan
114 * and mark vlan info with begin and end flags
115 * if vlaninfo represents a range
117 pvid = br_get_pvid(pv);
118 for_each_set_bit(vid, pv->vlan_bitmap, VLAN_N_VID) {
121 flags |= BRIDGE_VLAN_INFO_PVID;
123 if (test_bit(vid, pv->untagged_bitmap))
124 flags |= BRIDGE_VLAN_INFO_UNTAGGED;
126 if (vid_range_start == 0) {
128 } else if ((vid - vid_range_end) == 1 &&
129 flags == vid_range_flags) {
133 err = br_fill_ifvlaninfo_range(skb, vid_range_start,
141 vid_range_start = vid;
143 vid_range_flags = flags;
146 if (vid_range_start != 0) {
147 /* Call it once more to send any left over vlans */
148 err = br_fill_ifvlaninfo_range(skb, vid_range_start,
158 static int br_fill_ifvlaninfo(struct sk_buff *skb,
159 const struct net_port_vlans *pv)
161 struct bridge_vlan_info vinfo;
164 pvid = br_get_pvid(pv);
165 for_each_set_bit(vid, pv->vlan_bitmap, VLAN_N_VID) {
169 vinfo.flags |= BRIDGE_VLAN_INFO_PVID;
171 if (test_bit(vid, pv->untagged_bitmap))
172 vinfo.flags |= BRIDGE_VLAN_INFO_UNTAGGED;
174 if (nla_put(skb, IFLA_BRIDGE_VLAN_INFO,
175 sizeof(vinfo), &vinfo))
176 goto nla_put_failure;
186 * Create one netlink message for one interface
187 * Contains port and master info as well as carrier and bridge state.
189 static int br_fill_ifinfo(struct sk_buff *skb,
190 const struct net_bridge_port *port,
191 u32 pid, u32 seq, int event, unsigned int flags,
192 u32 filter_mask, const struct net_device *dev)
194 const struct net_bridge *br;
195 struct ifinfomsg *hdr;
196 struct nlmsghdr *nlh;
197 u8 operstate = netif_running(dev) ? dev->operstate : IF_OPER_DOWN;
202 br = netdev_priv(dev);
204 br_debug(br, "br_fill_info event %d port %s master %s\n",
205 event, dev->name, br->dev->name);
207 nlh = nlmsg_put(skb, pid, seq, event, sizeof(*hdr), flags);
211 hdr = nlmsg_data(nlh);
212 hdr->ifi_family = AF_BRIDGE;
214 hdr->ifi_type = dev->type;
215 hdr->ifi_index = dev->ifindex;
216 hdr->ifi_flags = dev_get_flags(dev);
219 if (nla_put_string(skb, IFLA_IFNAME, dev->name) ||
220 nla_put_u32(skb, IFLA_MASTER, br->dev->ifindex) ||
221 nla_put_u32(skb, IFLA_MTU, dev->mtu) ||
222 nla_put_u8(skb, IFLA_OPERSTATE, operstate) ||
224 nla_put(skb, IFLA_ADDRESS, dev->addr_len, dev->dev_addr)) ||
225 (dev->ifindex != dev->iflink &&
226 nla_put_u32(skb, IFLA_LINK, dev->iflink)))
227 goto nla_put_failure;
229 if (event == RTM_NEWLINK && port) {
231 = nla_nest_start(skb, IFLA_PROTINFO | NLA_F_NESTED);
233 if (nest == NULL || br_port_fill_attrs(skb, port) < 0)
234 goto nla_put_failure;
235 nla_nest_end(skb, nest);
238 /* Check if the VID information is requested */
239 if ((filter_mask & RTEXT_FILTER_BRVLAN) ||
240 (filter_mask & RTEXT_FILTER_BRVLAN_COMPRESSED)) {
241 const struct net_port_vlans *pv;
246 pv = nbp_get_vlan_info(port);
248 pv = br_get_vlan_info(br);
250 if (!pv || bitmap_empty(pv->vlan_bitmap, VLAN_N_VID))
253 af = nla_nest_start(skb, IFLA_AF_SPEC);
255 goto nla_put_failure;
257 if (filter_mask & RTEXT_FILTER_BRVLAN_COMPRESSED)
258 err = br_fill_ifvlaninfo_compressed(skb, pv);
260 err = br_fill_ifvlaninfo(skb, pv);
262 goto nla_put_failure;
263 nla_nest_end(skb, af);
271 nlmsg_cancel(skb, nlh);
276 * Notify listeners of a change in port information
278 void br_ifinfo_notify(int event, struct net_bridge_port *port)
287 net = dev_net(port->dev);
288 br_debug(port->br, "port %u(%s) event %d\n",
289 (unsigned int)port->port_no, port->dev->name, event);
291 skb = nlmsg_new(br_nlmsg_size(), GFP_ATOMIC);
295 err = br_fill_ifinfo(skb, port, 0, 0, event, 0, 0, port->dev);
297 /* -EMSGSIZE implies BUG in br_nlmsg_size() */
298 WARN_ON(err == -EMSGSIZE);
302 rtnl_notify(skb, net, 0, RTNLGRP_LINK, NULL, GFP_ATOMIC);
305 rtnl_set_sk_err(net, RTNLGRP_LINK, err);
310 * Dump information about all ports, in response to GETLINK
312 int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
313 struct net_device *dev, u32 filter_mask)
315 struct net_bridge_port *port = br_port_get_rtnl(dev);
317 if (!port && !(filter_mask & RTEXT_FILTER_BRVLAN) &&
318 !(filter_mask & RTEXT_FILTER_BRVLAN_COMPRESSED))
321 return br_fill_ifinfo(skb, port, pid, seq, RTM_NEWLINK, NLM_F_MULTI,
325 static int br_vlan_info(struct net_bridge *br, struct net_bridge_port *p,
326 int cmd, struct bridge_vlan_info *vinfo)
333 err = nbp_vlan_add(p, vinfo->vid, vinfo->flags);
337 if (vinfo->flags & BRIDGE_VLAN_INFO_MASTER)
338 err = br_vlan_add(p->br, vinfo->vid,
341 err = br_vlan_add(br, vinfo->vid, vinfo->flags);
347 nbp_vlan_delete(p, vinfo->vid);
348 if (vinfo->flags & BRIDGE_VLAN_INFO_MASTER)
349 br_vlan_delete(p->br, vinfo->vid);
351 br_vlan_delete(br, vinfo->vid);
359 static int br_afspec(struct net_bridge *br,
360 struct net_bridge_port *p,
361 struct nlattr *af_spec,
364 struct bridge_vlan_info *vinfo_start = NULL;
365 struct bridge_vlan_info *vinfo = NULL;
370 nla_for_each_nested(attr, af_spec, rem) {
371 if (nla_type(attr) != IFLA_BRIDGE_VLAN_INFO)
373 if (nla_len(attr) != sizeof(struct bridge_vlan_info))
375 vinfo = nla_data(attr);
376 if (vinfo->flags & BRIDGE_VLAN_INFO_RANGE_BEGIN) {
384 struct bridge_vlan_info tmp_vinfo;
387 if (!(vinfo->flags & BRIDGE_VLAN_INFO_RANGE_END))
390 if (vinfo->vid <= vinfo_start->vid)
393 memcpy(&tmp_vinfo, vinfo_start,
394 sizeof(struct bridge_vlan_info));
396 for (v = vinfo_start->vid; v <= vinfo->vid; v++) {
398 err = br_vlan_info(br, p, cmd, &tmp_vinfo);
404 err = br_vlan_info(br, p, cmd, vinfo);
413 static const struct nla_policy br_port_policy[IFLA_BRPORT_MAX + 1] = {
414 [IFLA_BRPORT_STATE] = { .type = NLA_U8 },
415 [IFLA_BRPORT_COST] = { .type = NLA_U32 },
416 [IFLA_BRPORT_PRIORITY] = { .type = NLA_U16 },
417 [IFLA_BRPORT_MODE] = { .type = NLA_U8 },
418 [IFLA_BRPORT_GUARD] = { .type = NLA_U8 },
419 [IFLA_BRPORT_PROTECT] = { .type = NLA_U8 },
420 [IFLA_BRPORT_FAST_LEAVE]= { .type = NLA_U8 },
421 [IFLA_BRPORT_LEARNING] = { .type = NLA_U8 },
422 [IFLA_BRPORT_UNICAST_FLOOD] = { .type = NLA_U8 },
425 /* Change the state of the port and notify spanning tree */
426 static int br_set_port_state(struct net_bridge_port *p, u8 state)
428 if (state > BR_STATE_BLOCKING)
431 /* if kernel STP is running, don't allow changes */
432 if (p->br->stp_enabled == BR_KERNEL_STP)
435 /* if device is not up, change is not allowed
436 * if link is not present, only allowable state is disabled
438 if (!netif_running(p->dev) ||
439 (!netif_oper_up(p->dev) && state != BR_STATE_DISABLED))
442 br_set_state(p, state);
444 br_port_state_selection(p->br);
448 /* Set/clear or port flags based on attribute */
449 static void br_set_port_flag(struct net_bridge_port *p, struct nlattr *tb[],
450 int attrtype, unsigned long mask)
453 u8 flag = nla_get_u8(tb[attrtype]);
461 /* Process bridge protocol info on port */
462 static int br_setport(struct net_bridge_port *p, struct nlattr *tb[])
465 unsigned long old_flags = p->flags;
467 br_set_port_flag(p, tb, IFLA_BRPORT_MODE, BR_HAIRPIN_MODE);
468 br_set_port_flag(p, tb, IFLA_BRPORT_GUARD, BR_BPDU_GUARD);
469 br_set_port_flag(p, tb, IFLA_BRPORT_FAST_LEAVE, BR_MULTICAST_FAST_LEAVE);
470 br_set_port_flag(p, tb, IFLA_BRPORT_PROTECT, BR_ROOT_BLOCK);
471 br_set_port_flag(p, tb, IFLA_BRPORT_LEARNING, BR_LEARNING);
472 br_set_port_flag(p, tb, IFLA_BRPORT_UNICAST_FLOOD, BR_FLOOD);
473 br_set_port_flag(p, tb, IFLA_BRPORT_PROXYARP, BR_PROXYARP);
475 if (tb[IFLA_BRPORT_COST]) {
476 err = br_stp_set_path_cost(p, nla_get_u32(tb[IFLA_BRPORT_COST]));
481 if (tb[IFLA_BRPORT_PRIORITY]) {
482 err = br_stp_set_port_priority(p, nla_get_u16(tb[IFLA_BRPORT_PRIORITY]));
487 if (tb[IFLA_BRPORT_STATE]) {
488 err = br_set_port_state(p, nla_get_u8(tb[IFLA_BRPORT_STATE]));
493 br_port_flags_change(p, old_flags ^ p->flags);
497 /* Change state and parameters on port. */
498 int br_setlink(struct net_device *dev, struct nlmsghdr *nlh, u16 flags)
500 struct nlattr *protinfo;
501 struct nlattr *afspec;
502 struct net_bridge_port *p;
503 struct nlattr *tb[IFLA_BRPORT_MAX + 1];
504 int err = 0, ret_offload = 0;
506 protinfo = nlmsg_find_attr(nlh, sizeof(struct ifinfomsg), IFLA_PROTINFO);
507 afspec = nlmsg_find_attr(nlh, sizeof(struct ifinfomsg), IFLA_AF_SPEC);
508 if (!protinfo && !afspec)
511 p = br_port_get_rtnl(dev);
512 /* We want to accept dev as bridge itself if the AF_SPEC
513 * is set to see if someone is setting vlan info on the bridge
519 if (protinfo->nla_type & NLA_F_NESTED) {
520 err = nla_parse_nested(tb, IFLA_BRPORT_MAX,
521 protinfo, br_port_policy);
525 spin_lock_bh(&p->br->lock);
526 err = br_setport(p, tb);
527 spin_unlock_bh(&p->br->lock);
529 /* Binary compatibility with old RSTP */
530 if (nla_len(protinfo) < sizeof(u8))
533 spin_lock_bh(&p->br->lock);
534 err = br_set_port_state(p, nla_get_u8(protinfo));
535 spin_unlock_bh(&p->br->lock);
542 err = br_afspec((struct net_bridge *)netdev_priv(dev), p,
543 afspec, RTM_SETLINK);
546 if (p && !(flags & BRIDGE_FLAGS_SELF)) {
547 /* set bridge attributes in hardware if supported
549 ret_offload = netdev_switch_port_bridge_setlink(dev, nlh,
551 if (ret_offload && ret_offload != -EOPNOTSUPP)
552 br_warn(p->br, "error setting attrs on port %u(%s)\n",
553 (unsigned int)p->port_no, p->dev->name);
557 br_ifinfo_notify(RTM_NEWLINK, p);
562 /* Delete port information */
563 int br_dellink(struct net_device *dev, struct nlmsghdr *nlh, u16 flags)
565 struct nlattr *afspec;
566 struct net_bridge_port *p;
567 int err = 0, ret_offload = 0;
569 afspec = nlmsg_find_attr(nlh, sizeof(struct ifinfomsg), IFLA_AF_SPEC);
573 p = br_port_get_rtnl(dev);
574 /* We want to accept dev as bridge itself as well */
575 if (!p && !(dev->priv_flags & IFF_EBRIDGE))
578 err = br_afspec((struct net_bridge *)netdev_priv(dev), p,
579 afspec, RTM_DELLINK);
581 /* Send RTM_NEWLINK because userspace
582 * expects RTM_NEWLINK for vlan dels
584 br_ifinfo_notify(RTM_NEWLINK, p);
586 if (p && !(flags & BRIDGE_FLAGS_SELF)) {
587 /* del bridge attributes in hardware
589 ret_offload = netdev_switch_port_bridge_dellink(dev, nlh,
591 if (ret_offload && ret_offload != -EOPNOTSUPP)
592 br_warn(p->br, "error deleting attrs on port %u (%s)\n",
593 (unsigned int)p->port_no, p->dev->name);
598 static int br_validate(struct nlattr *tb[], struct nlattr *data[])
600 if (tb[IFLA_ADDRESS]) {
601 if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
603 if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
604 return -EADDRNOTAVAIL;
610 static int br_dev_newlink(struct net *src_net, struct net_device *dev,
611 struct nlattr *tb[], struct nlattr *data[])
613 struct net_bridge *br = netdev_priv(dev);
615 if (tb[IFLA_ADDRESS]) {
616 spin_lock_bh(&br->lock);
617 br_stp_change_bridge_id(br, nla_data(tb[IFLA_ADDRESS]));
618 spin_unlock_bh(&br->lock);
621 return register_netdevice(dev);
624 static int br_port_slave_changelink(struct net_device *brdev,
625 struct net_device *dev,
627 struct nlattr *data[])
631 return br_setport(br_port_get_rtnl(dev), data);
634 static int br_port_fill_slave_info(struct sk_buff *skb,
635 const struct net_device *brdev,
636 const struct net_device *dev)
638 return br_port_fill_attrs(skb, br_port_get_rtnl(dev));
641 static size_t br_port_get_slave_size(const struct net_device *brdev,
642 const struct net_device *dev)
644 return br_port_info_size();
647 static const struct nla_policy br_policy[IFLA_BR_MAX + 1] = {
648 [IFLA_BR_FORWARD_DELAY] = { .type = NLA_U32 },
649 [IFLA_BR_HELLO_TIME] = { .type = NLA_U32 },
650 [IFLA_BR_MAX_AGE] = { .type = NLA_U32 },
653 static int br_changelink(struct net_device *brdev, struct nlattr *tb[],
654 struct nlattr *data[])
656 struct net_bridge *br = netdev_priv(brdev);
662 if (data[IFLA_BR_FORWARD_DELAY]) {
663 err = br_set_forward_delay(br, nla_get_u32(data[IFLA_BR_FORWARD_DELAY]));
668 if (data[IFLA_BR_HELLO_TIME]) {
669 err = br_set_hello_time(br, nla_get_u32(data[IFLA_BR_HELLO_TIME]));
674 if (data[IFLA_BR_MAX_AGE]) {
675 err = br_set_max_age(br, nla_get_u32(data[IFLA_BR_MAX_AGE]));
683 static size_t br_get_size(const struct net_device *brdev)
685 return nla_total_size(sizeof(u32)) + /* IFLA_BR_FORWARD_DELAY */
686 nla_total_size(sizeof(u32)) + /* IFLA_BR_HELLO_TIME */
687 nla_total_size(sizeof(u32)) + /* IFLA_BR_MAX_AGE */
691 static int br_fill_info(struct sk_buff *skb, const struct net_device *brdev)
693 struct net_bridge *br = netdev_priv(brdev);
694 u32 forward_delay = jiffies_to_clock_t(br->forward_delay);
695 u32 hello_time = jiffies_to_clock_t(br->hello_time);
696 u32 age_time = jiffies_to_clock_t(br->max_age);
698 if (nla_put_u32(skb, IFLA_BR_FORWARD_DELAY, forward_delay) ||
699 nla_put_u32(skb, IFLA_BR_HELLO_TIME, hello_time) ||
700 nla_put_u32(skb, IFLA_BR_MAX_AGE, age_time))
706 static size_t br_get_link_af_size(const struct net_device *dev)
708 struct net_port_vlans *pv;
710 if (br_port_exists(dev))
711 pv = nbp_get_vlan_info(br_port_get_rtnl(dev));
712 else if (dev->priv_flags & IFF_EBRIDGE)
713 pv = br_get_vlan_info((struct net_bridge *)netdev_priv(dev));
720 /* Each VLAN is returned in bridge_vlan_info along with flags */
721 return pv->num_vlans * nla_total_size(sizeof(struct bridge_vlan_info));
724 static struct rtnl_af_ops br_af_ops __read_mostly = {
726 .get_link_af_size = br_get_link_af_size,
729 struct rtnl_link_ops br_link_ops __read_mostly = {
731 .priv_size = sizeof(struct net_bridge),
732 .setup = br_dev_setup,
733 .maxtype = IFLA_BRPORT_MAX,
735 .validate = br_validate,
736 .newlink = br_dev_newlink,
737 .changelink = br_changelink,
738 .dellink = br_dev_delete,
739 .get_size = br_get_size,
740 .fill_info = br_fill_info,
742 .slave_maxtype = IFLA_BRPORT_MAX,
743 .slave_policy = br_port_policy,
744 .slave_changelink = br_port_slave_changelink,
745 .get_slave_size = br_port_get_slave_size,
746 .fill_slave_info = br_port_fill_slave_info,
749 int __init br_netlink_init(void)
754 rtnl_af_register(&br_af_ops);
756 err = rtnl_link_register(&br_link_ops);
763 rtnl_af_unregister(&br_af_ops);
768 void br_netlink_fini(void)
771 rtnl_af_unregister(&br_af_ops);
772 rtnl_link_unregister(&br_link_ops);