2 * net/switchdev/switchdev.c - Switch device API
3 * Copyright (c) 2014 Jiri Pirko <jiri@resnulli.us>
4 * Copyright (c) 2014-2015 Scott Feldman <sfeldma@gmail.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
12 #include <linux/kernel.h>
13 #include <linux/types.h>
14 #include <linux/init.h>
15 #include <linux/mutex.h>
16 #include <linux/notifier.h>
17 #include <linux/netdevice.h>
18 #include <linux/if_bridge.h>
19 #include <net/ip_fib.h>
20 #include <net/switchdev.h>
23 * switchdev_port_attr_get - Get port attribute
26 * @attr: attribute to get
28 int switchdev_port_attr_get(struct net_device *dev, struct switchdev_attr *attr)
30 const struct switchdev_ops *ops = dev->switchdev_ops;
31 struct net_device *lower_dev;
32 struct list_head *iter;
33 struct switchdev_attr first = {
34 .id = SWITCHDEV_ATTR_UNDEFINED
36 int err = -EOPNOTSUPP;
38 if (ops && ops->switchdev_port_attr_get)
39 return ops->switchdev_port_attr_get(dev, attr);
41 if (attr->flags & SWITCHDEV_F_NO_RECURSE)
44 /* Switch device port(s) may be stacked under
45 * bond/team/vlan dev, so recurse down to get attr on
46 * each port. Return -ENODATA if attr values don't
47 * compare across ports.
50 netdev_for_each_lower_dev(dev, lower_dev, iter) {
51 err = switchdev_port_attr_get(lower_dev, attr);
54 if (first.id == SWITCHDEV_ATTR_UNDEFINED)
56 else if (memcmp(&first, attr, sizeof(*attr)))
62 EXPORT_SYMBOL_GPL(switchdev_port_attr_get);
64 static int __switchdev_port_attr_set(struct net_device *dev,
65 struct switchdev_attr *attr)
67 const struct switchdev_ops *ops = dev->switchdev_ops;
68 struct net_device *lower_dev;
69 struct list_head *iter;
70 int err = -EOPNOTSUPP;
72 if (ops && ops->switchdev_port_attr_set)
73 return ops->switchdev_port_attr_set(dev, attr);
75 if (attr->flags & SWITCHDEV_F_NO_RECURSE)
78 /* Switch device port(s) may be stacked under
79 * bond/team/vlan dev, so recurse down to set attr on
83 netdev_for_each_lower_dev(dev, lower_dev, iter) {
84 err = __switchdev_port_attr_set(lower_dev, attr);
92 struct switchdev_attr_set_work {
93 struct work_struct work;
94 struct net_device *dev;
95 struct switchdev_attr attr;
98 static void switchdev_port_attr_set_work(struct work_struct *work)
100 struct switchdev_attr_set_work *asw =
101 container_of(work, struct switchdev_attr_set_work, work);
105 err = switchdev_port_attr_set(asw->dev, &asw->attr);
113 static int switchdev_port_attr_set_defer(struct net_device *dev,
114 struct switchdev_attr *attr)
116 struct switchdev_attr_set_work *asw;
118 asw = kmalloc(sizeof(*asw), GFP_ATOMIC);
122 INIT_WORK(&asw->work, switchdev_port_attr_set_work);
126 memcpy(&asw->attr, attr, sizeof(asw->attr));
128 schedule_work(&asw->work);
134 * switchdev_port_attr_set - Set port attribute
137 * @attr: attribute to set
139 * Use a 2-phase prepare-commit transaction model to ensure
140 * system is not left in a partially updated state due to
141 * failure from driver/device.
143 int switchdev_port_attr_set(struct net_device *dev, struct switchdev_attr *attr)
147 if (!rtnl_is_locked()) {
148 /* Running prepare-commit transaction across stacked
149 * devices requires nothing moves, so if rtnl_lock is
150 * not held, schedule a worker thread to hold rtnl_lock
151 * while setting attr.
154 return switchdev_port_attr_set_defer(dev, attr);
157 /* Phase I: prepare for attr set. Driver/device should fail
158 * here if there are going to be issues in the commit phase,
159 * such as lack of resources or support. The driver/device
160 * should reserve resources needed for the commit phase here,
161 * but should not commit the attr.
164 attr->trans = SWITCHDEV_TRANS_PREPARE;
165 err = __switchdev_port_attr_set(dev, attr);
167 /* Prepare phase failed: abort the transaction. Any
168 * resources reserved in the prepare phase are
172 attr->trans = SWITCHDEV_TRANS_ABORT;
173 __switchdev_port_attr_set(dev, attr);
178 /* Phase II: commit attr set. This cannot fail as a fault
179 * of driver/device. If it does, it's a bug in the driver/device
180 * because the driver said everythings was OK in phase I.
183 attr->trans = SWITCHDEV_TRANS_COMMIT;
184 err = __switchdev_port_attr_set(dev, attr);
189 EXPORT_SYMBOL_GPL(switchdev_port_attr_set);
191 static int __switchdev_port_obj_add(struct net_device *dev,
192 struct switchdev_obj *obj)
194 const struct switchdev_ops *ops = dev->switchdev_ops;
195 struct net_device *lower_dev;
196 struct list_head *iter;
197 int err = -EOPNOTSUPP;
199 if (ops && ops->switchdev_port_obj_add)
200 return ops->switchdev_port_obj_add(dev, obj);
202 /* Switch device port(s) may be stacked under
203 * bond/team/vlan dev, so recurse down to add object on
207 netdev_for_each_lower_dev(dev, lower_dev, iter) {
208 err = __switchdev_port_obj_add(lower_dev, obj);
217 * switchdev_port_obj_add - Add port object
220 * @obj: object to add
222 * Use a 2-phase prepare-commit transaction model to ensure
223 * system is not left in a partially updated state due to
224 * failure from driver/device.
226 * rtnl_lock must be held.
228 int switchdev_port_obj_add(struct net_device *dev, struct switchdev_obj *obj)
234 /* Phase I: prepare for obj add. Driver/device should fail
235 * here if there are going to be issues in the commit phase,
236 * such as lack of resources or support. The driver/device
237 * should reserve resources needed for the commit phase here,
238 * but should not commit the obj.
241 obj->trans = SWITCHDEV_TRANS_PREPARE;
242 err = __switchdev_port_obj_add(dev, obj);
244 /* Prepare phase failed: abort the transaction. Any
245 * resources reserved in the prepare phase are
249 obj->trans = SWITCHDEV_TRANS_ABORT;
250 __switchdev_port_obj_add(dev, obj);
255 /* Phase II: commit obj add. This cannot fail as a fault
256 * of driver/device. If it does, it's a bug in the driver/device
257 * because the driver said everythings was OK in phase I.
260 obj->trans = SWITCHDEV_TRANS_COMMIT;
261 err = __switchdev_port_obj_add(dev, obj);
262 WARN(err, "%s: Commit of object (id=%d) failed.\n", dev->name, obj->id);
266 EXPORT_SYMBOL_GPL(switchdev_port_obj_add);
269 * switchdev_port_obj_del - Delete port object
272 * @obj: object to delete
274 int switchdev_port_obj_del(struct net_device *dev, struct switchdev_obj *obj)
276 const struct switchdev_ops *ops = dev->switchdev_ops;
277 struct net_device *lower_dev;
278 struct list_head *iter;
279 int err = -EOPNOTSUPP;
281 if (ops && ops->switchdev_port_obj_del)
282 return ops->switchdev_port_obj_del(dev, obj);
284 /* Switch device port(s) may be stacked under
285 * bond/team/vlan dev, so recurse down to delete object on
289 netdev_for_each_lower_dev(dev, lower_dev, iter) {
290 err = switchdev_port_obj_del(lower_dev, obj);
297 EXPORT_SYMBOL_GPL(switchdev_port_obj_del);
299 static DEFINE_MUTEX(switchdev_mutex);
300 static RAW_NOTIFIER_HEAD(switchdev_notif_chain);
303 * register_switchdev_notifier - Register notifier
304 * @nb: notifier_block
306 * Register switch device notifier. This should be used by code
307 * which needs to monitor events happening in particular device.
308 * Return values are same as for atomic_notifier_chain_register().
310 int register_switchdev_notifier(struct notifier_block *nb)
314 mutex_lock(&switchdev_mutex);
315 err = raw_notifier_chain_register(&switchdev_notif_chain, nb);
316 mutex_unlock(&switchdev_mutex);
319 EXPORT_SYMBOL_GPL(register_switchdev_notifier);
322 * unregister_switchdev_notifier - Unregister notifier
323 * @nb: notifier_block
325 * Unregister switch device notifier.
326 * Return values are same as for atomic_notifier_chain_unregister().
328 int unregister_switchdev_notifier(struct notifier_block *nb)
332 mutex_lock(&switchdev_mutex);
333 err = raw_notifier_chain_unregister(&switchdev_notif_chain, nb);
334 mutex_unlock(&switchdev_mutex);
337 EXPORT_SYMBOL_GPL(unregister_switchdev_notifier);
340 * call_switchdev_notifiers - Call notifiers
341 * @val: value passed unmodified to notifier function
343 * @info: notifier information data
345 * Call all network notifier blocks. This should be called by driver
346 * when it needs to propagate hardware event.
347 * Return values are same as for atomic_notifier_call_chain().
349 int call_switchdev_notifiers(unsigned long val, struct net_device *dev,
350 struct switchdev_notifier_info *info)
355 mutex_lock(&switchdev_mutex);
356 err = raw_notifier_call_chain(&switchdev_notif_chain, val, info);
357 mutex_unlock(&switchdev_mutex);
360 EXPORT_SYMBOL_GPL(call_switchdev_notifiers);
363 * switchdev_port_bridge_getlink - Get bridge port attributes
367 * Called for SELF on rtnl_bridge_getlink to get bridge port
370 int switchdev_port_bridge_getlink(struct sk_buff *skb, u32 pid, u32 seq,
371 struct net_device *dev, u32 filter_mask,
374 struct switchdev_attr attr = {
375 .id = SWITCHDEV_ATTR_PORT_BRIDGE_FLAGS,
377 u16 mode = BRIDGE_MODE_UNDEF;
378 u32 mask = BR_LEARNING | BR_LEARNING_SYNC;
381 err = switchdev_port_attr_get(dev, &attr);
385 return ndo_dflt_bridge_getlink(skb, pid, seq, dev, mode,
386 attr.brport_flags, mask, nlflags);
388 EXPORT_SYMBOL_GPL(switchdev_port_bridge_getlink);
390 static int switchdev_port_br_setflag(struct net_device *dev,
391 struct nlattr *nlattr,
392 unsigned long brport_flag)
394 struct switchdev_attr attr = {
395 .id = SWITCHDEV_ATTR_PORT_BRIDGE_FLAGS,
397 u8 flag = nla_get_u8(nlattr);
400 err = switchdev_port_attr_get(dev, &attr);
405 attr.brport_flags |= brport_flag;
407 attr.brport_flags &= ~brport_flag;
409 return switchdev_port_attr_set(dev, &attr);
412 static const struct nla_policy
413 switchdev_port_bridge_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_LEARNING_SYNC] = { .type = NLA_U8 },
423 [IFLA_BRPORT_UNICAST_FLOOD] = { .type = NLA_U8 },
426 static int switchdev_port_br_setlink_protinfo(struct net_device *dev,
427 struct nlattr *protinfo)
433 err = nla_validate_nested(protinfo, IFLA_BRPORT_MAX,
434 switchdev_port_bridge_policy);
438 nla_for_each_nested(attr, protinfo, rem) {
439 switch (nla_type(attr)) {
440 case IFLA_BRPORT_LEARNING:
441 err = switchdev_port_br_setflag(dev, attr,
444 case IFLA_BRPORT_LEARNING_SYNC:
445 err = switchdev_port_br_setflag(dev, attr,
459 static int switchdev_port_br_afspec(struct net_device *dev,
460 struct nlattr *afspec,
461 int (*f)(struct net_device *dev,
462 struct switchdev_obj *obj))
465 struct bridge_vlan_info *vinfo;
466 struct switchdev_obj obj = {
467 .id = SWITCHDEV_OBJ_PORT_VLAN,
472 nla_for_each_nested(attr, afspec, rem) {
473 if (nla_type(attr) != IFLA_BRIDGE_VLAN_INFO)
475 if (nla_len(attr) != sizeof(struct bridge_vlan_info))
477 vinfo = nla_data(attr);
478 obj.vlan.flags = vinfo->flags;
479 if (vinfo->flags & BRIDGE_VLAN_INFO_RANGE_BEGIN) {
480 if (obj.vlan.vid_start)
482 obj.vlan.vid_start = vinfo->vid;
483 } else if (vinfo->flags & BRIDGE_VLAN_INFO_RANGE_END) {
484 if (!obj.vlan.vid_start)
486 obj.vlan.vid_end = vinfo->vid;
487 if (obj.vlan.vid_end <= obj.vlan.vid_start)
492 memset(&obj.vlan, 0, sizeof(obj.vlan));
494 if (obj.vlan.vid_start)
496 obj.vlan.vid_start = vinfo->vid;
497 obj.vlan.vid_end = vinfo->vid;
501 memset(&obj.vlan, 0, sizeof(obj.vlan));
509 * switchdev_port_bridge_setlink - Set bridge port attributes
512 * @nlh: netlink header
513 * @flags: netlink flags
515 * Called for SELF on rtnl_bridge_setlink to set bridge port
518 int switchdev_port_bridge_setlink(struct net_device *dev,
519 struct nlmsghdr *nlh, u16 flags)
521 struct nlattr *protinfo;
522 struct nlattr *afspec;
525 protinfo = nlmsg_find_attr(nlh, sizeof(struct ifinfomsg),
528 err = switchdev_port_br_setlink_protinfo(dev, protinfo);
533 afspec = nlmsg_find_attr(nlh, sizeof(struct ifinfomsg),
536 err = switchdev_port_br_afspec(dev, afspec,
537 switchdev_port_obj_add);
541 EXPORT_SYMBOL_GPL(switchdev_port_bridge_setlink);
544 * switchdev_port_bridge_dellink - Set bridge port attributes
547 * @nlh: netlink header
548 * @flags: netlink flags
550 * Called for SELF on rtnl_bridge_dellink to set bridge port
553 int switchdev_port_bridge_dellink(struct net_device *dev,
554 struct nlmsghdr *nlh, u16 flags)
556 struct nlattr *afspec;
558 afspec = nlmsg_find_attr(nlh, sizeof(struct ifinfomsg),
561 return switchdev_port_br_afspec(dev, afspec,
562 switchdev_port_obj_del);
566 EXPORT_SYMBOL_GPL(switchdev_port_bridge_dellink);
568 static struct net_device *switchdev_get_lowest_dev(struct net_device *dev)
570 const struct switchdev_ops *ops = dev->switchdev_ops;
571 struct net_device *lower_dev;
572 struct net_device *port_dev;
573 struct list_head *iter;
575 /* Recusively search down until we find a sw port dev.
576 * (A sw port dev supports switchdev_port_attr_get).
579 if (ops && ops->switchdev_port_attr_get)
582 netdev_for_each_lower_dev(dev, lower_dev, iter) {
583 port_dev = switchdev_get_lowest_dev(lower_dev);
591 static struct net_device *switchdev_get_dev_by_nhs(struct fib_info *fi)
593 struct switchdev_attr attr = {
594 .id = SWITCHDEV_ATTR_PORT_PARENT_ID,
596 struct switchdev_attr prev_attr;
597 struct net_device *dev = NULL;
600 /* For this route, all nexthop devs must be on the same switch. */
602 for (nhsel = 0; nhsel < fi->fib_nhs; nhsel++) {
603 const struct fib_nh *nh = &fi->fib_nh[nhsel];
608 dev = switchdev_get_lowest_dev(nh->nh_dev);
612 if (switchdev_port_attr_get(dev, &attr))
616 if (prev_attr.ppid.id_len != attr.ppid.id_len)
618 if (memcmp(prev_attr.ppid.id, attr.ppid.id,
630 * switchdev_fib_ipv4_add - Add IPv4 route entry to switch
632 * @dst: route's IPv4 destination address
633 * @dst_len: destination address length (prefix length)
634 * @fi: route FIB info structure
637 * @nlflags: netlink flags passed in (NLM_F_*)
638 * @tb_id: route table ID
640 * Add IPv4 route entry to switch device.
642 int switchdev_fib_ipv4_add(u32 dst, int dst_len, struct fib_info *fi,
643 u8 tos, u8 type, u32 nlflags, u32 tb_id)
645 struct switchdev_obj fib_obj = {
646 .id = SWITCHDEV_OBJ_IPV4_FIB,
657 struct net_device *dev;
660 /* Don't offload route if using custom ip rules or if
661 * IPv4 FIB offloading has been disabled completely.
664 #ifdef CONFIG_IP_MULTIPLE_TABLES
665 if (fi->fib_net->ipv4.fib_has_custom_rules)
669 if (fi->fib_net->ipv4.fib_offload_disabled)
672 dev = switchdev_get_dev_by_nhs(fi);
676 err = switchdev_port_obj_add(dev, &fib_obj);
678 fi->fib_flags |= RTNH_F_EXTERNAL;
682 EXPORT_SYMBOL_GPL(switchdev_fib_ipv4_add);
685 * switchdev_fib_ipv4_del - Delete IPv4 route entry from switch
687 * @dst: route's IPv4 destination address
688 * @dst_len: destination address length (prefix length)
689 * @fi: route FIB info structure
692 * @tb_id: route table ID
694 * Delete IPv4 route entry from switch device.
696 int switchdev_fib_ipv4_del(u32 dst, int dst_len, struct fib_info *fi,
697 u8 tos, u8 type, u32 tb_id)
699 struct switchdev_obj fib_obj = {
700 .id = SWITCHDEV_OBJ_IPV4_FIB,
711 struct net_device *dev;
714 if (!(fi->fib_flags & RTNH_F_EXTERNAL))
717 dev = switchdev_get_dev_by_nhs(fi);
721 err = switchdev_port_obj_del(dev, &fib_obj);
723 fi->fib_flags &= ~RTNH_F_EXTERNAL;
727 EXPORT_SYMBOL_GPL(switchdev_fib_ipv4_del);
730 * switchdev_fib_ipv4_abort - Abort an IPv4 FIB operation
732 * @fi: route FIB info structure
734 void switchdev_fib_ipv4_abort(struct fib_info *fi)
736 /* There was a problem installing this route to the offload
737 * device. For now, until we come up with more refined
738 * policy handling, abruptly end IPv4 fib offloading for
739 * for entire net by flushing offload device(s) of all
740 * IPv4 routes, and mark IPv4 fib offloading broken from
741 * this point forward.
744 fib_flush_external(fi->fib_net);
745 fi->fib_net->ipv4.fib_offload_disabled = true;
747 EXPORT_SYMBOL_GPL(switchdev_fib_ipv4_abort);