1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Linux ethernet bridge
10 #include <linux/kernel.h>
11 #include <linux/netdevice.h>
12 #include <linux/netpoll.h>
13 #include <linux/etherdevice.h>
14 #include <linux/ethtool.h>
15 #include <linux/list.h>
16 #include <linux/netfilter_bridge.h>
18 #include <linux/uaccess.h>
19 #include "br_private.h"
21 #define COMMON_FEATURES (NETIF_F_SG | NETIF_F_FRAGLIST | NETIF_F_HIGHDMA | \
22 NETIF_F_GSO_MASK | NETIF_F_HW_CSUM)
24 const struct nf_br_ops __rcu *nf_br_ops __read_mostly;
25 EXPORT_SYMBOL_GPL(nf_br_ops);
27 /* net device transmit always called with BH disabled */
28 netdev_tx_t br_dev_xmit(struct sk_buff *skb, struct net_device *dev)
30 struct net_bridge *br = netdev_priv(dev);
31 struct net_bridge_fdb_entry *dst;
32 struct net_bridge_mdb_entry *mdst;
33 struct pcpu_sw_netstats *brstats = this_cpu_ptr(br->stats);
34 const struct nf_br_ops *nf_ops;
35 const unsigned char *dest;
40 nf_ops = rcu_dereference(nf_br_ops);
41 if (nf_ops && nf_ops->br_dev_xmit_hook(skb)) {
46 u64_stats_update_begin(&brstats->syncp);
47 brstats->tx_packets++;
48 brstats->tx_bytes += skb->len;
49 u64_stats_update_end(&brstats->syncp);
51 br_switchdev_frame_unmark(skb);
52 BR_INPUT_SKB_CB(skb)->brdev = dev;
53 BR_INPUT_SKB_CB(skb)->frag_max_size = 0;
55 skb_reset_mac_header(skb);
57 skb_pull(skb, ETH_HLEN);
59 if (!br_allowed_ingress(br, br_vlan_group_rcu(br), skb, &vid))
62 if (IS_ENABLED(CONFIG_INET) &&
63 (eth->h_proto == htons(ETH_P_ARP) ||
64 eth->h_proto == htons(ETH_P_RARP)) &&
65 br_opt_get(br, BROPT_NEIGH_SUPPRESS_ENABLED)) {
66 br_do_proxy_suppress_arp(skb, br, vid, NULL);
67 } else if (IS_ENABLED(CONFIG_IPV6) &&
68 skb->protocol == htons(ETH_P_IPV6) &&
69 br_opt_get(br, BROPT_NEIGH_SUPPRESS_ENABLED) &&
70 pskb_may_pull(skb, sizeof(struct ipv6hdr) +
71 sizeof(struct nd_msg)) &&
72 ipv6_hdr(skb)->nexthdr == IPPROTO_ICMPV6) {
73 struct nd_msg *msg, _msg;
75 msg = br_is_nd_neigh_msg(skb, &_msg);
77 br_do_suppress_nd(skb, br, vid, NULL, msg);
80 dest = eth_hdr(skb)->h_dest;
81 if (is_broadcast_ether_addr(dest)) {
82 br_flood(br, skb, BR_PKT_BROADCAST, false, true);
83 } else if (is_multicast_ether_addr(dest)) {
84 if (unlikely(netpoll_tx_running(dev))) {
85 br_flood(br, skb, BR_PKT_MULTICAST, false, true);
88 if (br_multicast_rcv(br, NULL, skb, vid)) {
93 mdst = br_mdb_get(br, skb, vid);
94 if ((mdst || BR_INPUT_SKB_CB_MROUTERS_ONLY(skb)) &&
95 br_multicast_querier_exists(br, eth_hdr(skb)))
96 br_multicast_flood(mdst, skb, false, true);
98 br_flood(br, skb, BR_PKT_MULTICAST, false, true);
99 } else if ((dst = br_fdb_find_rcu(br, dest, vid)) != NULL) {
100 br_forward(dst->dst, skb, false, true);
102 br_flood(br, skb, BR_PKT_UNICAST, false, true);
109 static int br_dev_init(struct net_device *dev)
111 struct net_bridge *br = netdev_priv(dev);
114 br->stats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
118 err = br_fdb_hash_init(br);
120 free_percpu(br->stats);
124 err = br_mdb_hash_init(br);
126 free_percpu(br->stats);
127 br_fdb_hash_fini(br);
131 err = br_vlan_init(br);
133 free_percpu(br->stats);
134 br_mdb_hash_fini(br);
135 br_fdb_hash_fini(br);
139 err = br_multicast_init_stats(br);
141 free_percpu(br->stats);
143 br_mdb_hash_fini(br);
144 br_fdb_hash_fini(br);
150 static void br_dev_uninit(struct net_device *dev)
152 struct net_bridge *br = netdev_priv(dev);
154 br_multicast_dev_del(br);
155 br_multicast_uninit_stats(br);
157 br_mdb_hash_fini(br);
158 br_fdb_hash_fini(br);
159 free_percpu(br->stats);
162 static int br_dev_open(struct net_device *dev)
164 struct net_bridge *br = netdev_priv(dev);
166 netdev_update_features(dev);
167 netif_start_queue(dev);
168 br_stp_enable_bridge(br);
169 br_multicast_open(br);
174 static void br_dev_set_multicast_list(struct net_device *dev)
178 static void br_dev_change_rx_flags(struct net_device *dev, int change)
180 if (change & IFF_PROMISC)
181 br_manage_promisc(netdev_priv(dev));
184 static int br_dev_stop(struct net_device *dev)
186 struct net_bridge *br = netdev_priv(dev);
188 br_stp_disable_bridge(br);
189 br_multicast_stop(br);
191 netif_stop_queue(dev);
196 static void br_get_stats64(struct net_device *dev,
197 struct rtnl_link_stats64 *stats)
199 struct net_bridge *br = netdev_priv(dev);
200 struct pcpu_sw_netstats tmp, sum = { 0 };
203 for_each_possible_cpu(cpu) {
205 const struct pcpu_sw_netstats *bstats
206 = per_cpu_ptr(br->stats, cpu);
208 start = u64_stats_fetch_begin_irq(&bstats->syncp);
209 memcpy(&tmp, bstats, sizeof(tmp));
210 } while (u64_stats_fetch_retry_irq(&bstats->syncp, start));
211 sum.tx_bytes += tmp.tx_bytes;
212 sum.tx_packets += tmp.tx_packets;
213 sum.rx_bytes += tmp.rx_bytes;
214 sum.rx_packets += tmp.rx_packets;
217 stats->tx_bytes = sum.tx_bytes;
218 stats->tx_packets = sum.tx_packets;
219 stats->rx_bytes = sum.rx_bytes;
220 stats->rx_packets = sum.rx_packets;
223 static int br_change_mtu(struct net_device *dev, int new_mtu)
225 struct net_bridge *br = netdev_priv(dev);
229 /* this flag will be cleared if the MTU was automatically adjusted */
230 br_opt_toggle(br, BROPT_MTU_SET_BY_USER, true);
231 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
232 /* remember the MTU in the rtable for PMTU */
233 dst_metric_set(&br->fake_rtable.dst, RTAX_MTU, new_mtu);
239 /* Allow setting mac address to any valid ethernet address. */
240 static int br_set_mac_address(struct net_device *dev, void *p)
242 struct net_bridge *br = netdev_priv(dev);
243 struct sockaddr *addr = p;
245 if (!is_valid_ether_addr(addr->sa_data))
246 return -EADDRNOTAVAIL;
248 spin_lock_bh(&br->lock);
249 if (!ether_addr_equal(dev->dev_addr, addr->sa_data)) {
250 /* Mac address will be changed in br_stp_change_bridge_id(). */
251 br_stp_change_bridge_id(br, addr->sa_data);
253 spin_unlock_bh(&br->lock);
258 static void br_getinfo(struct net_device *dev, struct ethtool_drvinfo *info)
260 strlcpy(info->driver, "bridge", sizeof(info->driver));
261 strlcpy(info->version, BR_VERSION, sizeof(info->version));
262 strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
263 strlcpy(info->bus_info, "N/A", sizeof(info->bus_info));
266 static int br_get_link_ksettings(struct net_device *dev,
267 struct ethtool_link_ksettings *cmd)
269 struct net_bridge *br = netdev_priv(dev);
270 struct net_bridge_port *p;
272 cmd->base.duplex = DUPLEX_UNKNOWN;
273 cmd->base.port = PORT_OTHER;
274 cmd->base.speed = SPEED_UNKNOWN;
276 list_for_each_entry(p, &br->port_list, list) {
277 struct ethtool_link_ksettings ecmd;
278 struct net_device *pdev = p->dev;
280 if (!netif_running(pdev) || !netif_oper_up(pdev))
283 if (__ethtool_get_link_ksettings(pdev, &ecmd))
286 if (ecmd.base.speed == (__u32)SPEED_UNKNOWN)
289 if (cmd->base.speed == (__u32)SPEED_UNKNOWN ||
290 cmd->base.speed < ecmd.base.speed)
291 cmd->base.speed = ecmd.base.speed;
297 static netdev_features_t br_fix_features(struct net_device *dev,
298 netdev_features_t features)
300 struct net_bridge *br = netdev_priv(dev);
302 return br_features_recompute(br, features);
305 #ifdef CONFIG_NET_POLL_CONTROLLER
306 static void br_poll_controller(struct net_device *br_dev)
310 static void br_netpoll_cleanup(struct net_device *dev)
312 struct net_bridge *br = netdev_priv(dev);
313 struct net_bridge_port *p;
315 list_for_each_entry(p, &br->port_list, list)
316 br_netpoll_disable(p);
319 static int __br_netpoll_enable(struct net_bridge_port *p)
324 np = kzalloc(sizeof(*p->np), GFP_KERNEL);
328 err = __netpoll_setup(np, p->dev);
338 int br_netpoll_enable(struct net_bridge_port *p)
340 if (!p->br->dev->npinfo)
343 return __br_netpoll_enable(p);
346 static int br_netpoll_setup(struct net_device *dev, struct netpoll_info *ni)
348 struct net_bridge *br = netdev_priv(dev);
349 struct net_bridge_port *p;
352 list_for_each_entry(p, &br->port_list, list) {
355 err = __br_netpoll_enable(p);
364 br_netpoll_cleanup(dev);
368 void br_netpoll_disable(struct net_bridge_port *p)
370 struct netpoll *np = p->np;
382 static int br_add_slave(struct net_device *dev, struct net_device *slave_dev,
383 struct netlink_ext_ack *extack)
386 struct net_bridge *br = netdev_priv(dev);
388 return br_add_if(br, slave_dev, extack);
391 static int br_del_slave(struct net_device *dev, struct net_device *slave_dev)
393 struct net_bridge *br = netdev_priv(dev);
395 return br_del_if(br, slave_dev);
398 static const struct ethtool_ops br_ethtool_ops = {
399 .get_drvinfo = br_getinfo,
400 .get_link = ethtool_op_get_link,
401 .get_link_ksettings = br_get_link_ksettings,
404 static const struct net_device_ops br_netdev_ops = {
405 .ndo_open = br_dev_open,
406 .ndo_stop = br_dev_stop,
407 .ndo_init = br_dev_init,
408 .ndo_uninit = br_dev_uninit,
409 .ndo_start_xmit = br_dev_xmit,
410 .ndo_get_stats64 = br_get_stats64,
411 .ndo_set_mac_address = br_set_mac_address,
412 .ndo_set_rx_mode = br_dev_set_multicast_list,
413 .ndo_change_rx_flags = br_dev_change_rx_flags,
414 .ndo_change_mtu = br_change_mtu,
415 .ndo_do_ioctl = br_dev_ioctl,
416 #ifdef CONFIG_NET_POLL_CONTROLLER
417 .ndo_netpoll_setup = br_netpoll_setup,
418 .ndo_netpoll_cleanup = br_netpoll_cleanup,
419 .ndo_poll_controller = br_poll_controller,
421 .ndo_add_slave = br_add_slave,
422 .ndo_del_slave = br_del_slave,
423 .ndo_fix_features = br_fix_features,
424 .ndo_fdb_add = br_fdb_add,
425 .ndo_fdb_del = br_fdb_delete,
426 .ndo_fdb_dump = br_fdb_dump,
427 .ndo_fdb_get = br_fdb_get,
428 .ndo_bridge_getlink = br_getlink,
429 .ndo_bridge_setlink = br_setlink,
430 .ndo_bridge_dellink = br_dellink,
431 .ndo_features_check = passthru_features_check,
434 static struct device_type br_type = {
438 void br_dev_setup(struct net_device *dev)
440 struct net_bridge *br = netdev_priv(dev);
442 eth_hw_addr_random(dev);
445 dev->netdev_ops = &br_netdev_ops;
446 dev->needs_free_netdev = true;
447 dev->ethtool_ops = &br_ethtool_ops;
448 SET_NETDEV_DEVTYPE(dev, &br_type);
449 dev->priv_flags = IFF_EBRIDGE | IFF_NO_QUEUE;
451 dev->features = COMMON_FEATURES | NETIF_F_LLTX | NETIF_F_NETNS_LOCAL |
452 NETIF_F_HW_VLAN_CTAG_TX | NETIF_F_HW_VLAN_STAG_TX;
453 dev->hw_features = COMMON_FEATURES | NETIF_F_HW_VLAN_CTAG_TX |
454 NETIF_F_HW_VLAN_STAG_TX;
455 dev->vlan_features = COMMON_FEATURES;
458 spin_lock_init(&br->lock);
459 INIT_LIST_HEAD(&br->port_list);
460 INIT_HLIST_HEAD(&br->fdb_list);
461 spin_lock_init(&br->hash_lock);
463 br->bridge_id.prio[0] = 0x80;
464 br->bridge_id.prio[1] = 0x00;
466 ether_addr_copy(br->group_addr, eth_stp_addr);
468 br->stp_enabled = BR_NO_STP;
469 br->group_fwd_mask = BR_GROUPFWD_DEFAULT;
470 br->group_fwd_mask_required = BR_GROUPFWD_DEFAULT;
472 br->designated_root = br->bridge_id;
473 br->bridge_max_age = br->max_age = 20 * HZ;
474 br->bridge_hello_time = br->hello_time = 2 * HZ;
475 br->bridge_forward_delay = br->forward_delay = 15 * HZ;
476 br->bridge_ageing_time = br->ageing_time = BR_DEFAULT_AGEING_TIME;
477 dev->max_mtu = ETH_MAX_MTU;
479 br_netfilter_rtable_init(br);
480 br_stp_timer_init(br);
481 br_multicast_init(br);
482 INIT_DELAYED_WORK(&br->gc_work, br_fdb_cleanup);