1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * net-sysfs.c - network device class and attributes
5 * Copyright (c) 2003 Stephen Hemminger <shemminger@osdl.org>
8 #include <linux/capability.h>
9 #include <linux/kernel.h>
10 #include <linux/netdevice.h>
11 #include <linux/if_arp.h>
12 #include <linux/slab.h>
13 #include <linux/sched/signal.h>
14 #include <linux/sched/isolation.h>
15 #include <linux/nsproxy.h>
17 #include <net/net_namespace.h>
18 #include <linux/rtnetlink.h>
19 #include <linux/vmalloc.h>
20 #include <linux/export.h>
21 #include <linux/jiffies.h>
22 #include <linux/pm_runtime.h>
24 #include <linux/of_net.h>
25 #include <linux/cpu.h>
26 #include <net/netdev_rx_queue.h>
29 #include "net-sysfs.h"
32 static const char fmt_hex[] = "%#x\n";
33 static const char fmt_dec[] = "%d\n";
34 static const char fmt_ulong[] = "%lu\n";
35 static const char fmt_u64[] = "%llu\n";
37 /* Caller holds RTNL or dev_base_lock */
38 static inline int dev_isalive(const struct net_device *dev)
40 return dev->reg_state <= NETREG_REGISTERED;
43 /* use same locking rules as GIF* ioctl's */
44 static ssize_t netdev_show(const struct device *dev,
45 struct device_attribute *attr, char *buf,
46 ssize_t (*format)(const struct net_device *, char *))
48 struct net_device *ndev = to_net_dev(dev);
49 ssize_t ret = -EINVAL;
51 read_lock(&dev_base_lock);
52 if (dev_isalive(ndev))
53 ret = (*format)(ndev, buf);
54 read_unlock(&dev_base_lock);
59 /* generate a show function for simple field */
60 #define NETDEVICE_SHOW(field, format_string) \
61 static ssize_t format_##field(const struct net_device *dev, char *buf) \
63 return sysfs_emit(buf, format_string, dev->field); \
65 static ssize_t field##_show(struct device *dev, \
66 struct device_attribute *attr, char *buf) \
68 return netdev_show(dev, attr, buf, format_##field); \
71 #define NETDEVICE_SHOW_RO(field, format_string) \
72 NETDEVICE_SHOW(field, format_string); \
73 static DEVICE_ATTR_RO(field)
75 #define NETDEVICE_SHOW_RW(field, format_string) \
76 NETDEVICE_SHOW(field, format_string); \
77 static DEVICE_ATTR_RW(field)
79 /* use same locking and permission rules as SIF* ioctl's */
80 static ssize_t netdev_store(struct device *dev, struct device_attribute *attr,
81 const char *buf, size_t len,
82 int (*set)(struct net_device *, unsigned long))
84 struct net_device *netdev = to_net_dev(dev);
85 struct net *net = dev_net(netdev);
89 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
92 ret = kstrtoul(buf, 0, &new);
97 return restart_syscall();
99 if (dev_isalive(netdev)) {
100 ret = (*set)(netdev, new);
109 NETDEVICE_SHOW_RO(dev_id, fmt_hex);
110 NETDEVICE_SHOW_RO(dev_port, fmt_dec);
111 NETDEVICE_SHOW_RO(addr_assign_type, fmt_dec);
112 NETDEVICE_SHOW_RO(addr_len, fmt_dec);
113 NETDEVICE_SHOW_RO(ifindex, fmt_dec);
114 NETDEVICE_SHOW_RO(type, fmt_dec);
115 NETDEVICE_SHOW_RO(link_mode, fmt_dec);
117 static ssize_t iflink_show(struct device *dev, struct device_attribute *attr,
120 struct net_device *ndev = to_net_dev(dev);
122 return sysfs_emit(buf, fmt_dec, dev_get_iflink(ndev));
124 static DEVICE_ATTR_RO(iflink);
126 static ssize_t format_name_assign_type(const struct net_device *dev, char *buf)
128 return sysfs_emit(buf, fmt_dec, dev->name_assign_type);
131 static ssize_t name_assign_type_show(struct device *dev,
132 struct device_attribute *attr,
135 struct net_device *ndev = to_net_dev(dev);
136 ssize_t ret = -EINVAL;
138 if (ndev->name_assign_type != NET_NAME_UNKNOWN)
139 ret = netdev_show(dev, attr, buf, format_name_assign_type);
143 static DEVICE_ATTR_RO(name_assign_type);
145 /* use same locking rules as GIFHWADDR ioctl's */
146 static ssize_t address_show(struct device *dev, struct device_attribute *attr,
149 struct net_device *ndev = to_net_dev(dev);
150 ssize_t ret = -EINVAL;
152 read_lock(&dev_base_lock);
153 if (dev_isalive(ndev))
154 ret = sysfs_format_mac(buf, ndev->dev_addr, ndev->addr_len);
155 read_unlock(&dev_base_lock);
158 static DEVICE_ATTR_RO(address);
160 static ssize_t broadcast_show(struct device *dev,
161 struct device_attribute *attr, char *buf)
163 struct net_device *ndev = to_net_dev(dev);
165 if (dev_isalive(ndev))
166 return sysfs_format_mac(buf, ndev->broadcast, ndev->addr_len);
169 static DEVICE_ATTR_RO(broadcast);
171 static int change_carrier(struct net_device *dev, unsigned long new_carrier)
173 if (!netif_running(dev))
175 return dev_change_carrier(dev, (bool)new_carrier);
178 static ssize_t carrier_store(struct device *dev, struct device_attribute *attr,
179 const char *buf, size_t len)
181 struct net_device *netdev = to_net_dev(dev);
183 /* The check is also done in change_carrier; this helps returning early
184 * without hitting the trylock/restart in netdev_store.
186 if (!netdev->netdev_ops->ndo_change_carrier)
189 return netdev_store(dev, attr, buf, len, change_carrier);
192 static ssize_t carrier_show(struct device *dev,
193 struct device_attribute *attr, char *buf)
195 struct net_device *netdev = to_net_dev(dev);
197 if (netif_running(netdev))
198 return sysfs_emit(buf, fmt_dec, !!netif_carrier_ok(netdev));
202 static DEVICE_ATTR_RW(carrier);
204 static ssize_t speed_show(struct device *dev,
205 struct device_attribute *attr, char *buf)
207 struct net_device *netdev = to_net_dev(dev);
210 /* The check is also done in __ethtool_get_link_ksettings; this helps
211 * returning early without hitting the trylock/restart below.
213 if (!netdev->ethtool_ops->get_link_ksettings)
217 return restart_syscall();
219 if (netif_running(netdev) && netif_device_present(netdev)) {
220 struct ethtool_link_ksettings cmd;
222 if (!__ethtool_get_link_ksettings(netdev, &cmd))
223 ret = sysfs_emit(buf, fmt_dec, cmd.base.speed);
228 static DEVICE_ATTR_RO(speed);
230 static ssize_t duplex_show(struct device *dev,
231 struct device_attribute *attr, char *buf)
233 struct net_device *netdev = to_net_dev(dev);
236 /* The check is also done in __ethtool_get_link_ksettings; this helps
237 * returning early without hitting the trylock/restart below.
239 if (!netdev->ethtool_ops->get_link_ksettings)
243 return restart_syscall();
245 if (netif_running(netdev)) {
246 struct ethtool_link_ksettings cmd;
248 if (!__ethtool_get_link_ksettings(netdev, &cmd)) {
251 switch (cmd.base.duplex) {
262 ret = sysfs_emit(buf, "%s\n", duplex);
268 static DEVICE_ATTR_RO(duplex);
270 static ssize_t testing_show(struct device *dev,
271 struct device_attribute *attr, char *buf)
273 struct net_device *netdev = to_net_dev(dev);
275 if (netif_running(netdev))
276 return sysfs_emit(buf, fmt_dec, !!netif_testing(netdev));
280 static DEVICE_ATTR_RO(testing);
282 static ssize_t dormant_show(struct device *dev,
283 struct device_attribute *attr, char *buf)
285 struct net_device *netdev = to_net_dev(dev);
287 if (netif_running(netdev))
288 return sysfs_emit(buf, fmt_dec, !!netif_dormant(netdev));
292 static DEVICE_ATTR_RO(dormant);
294 static const char *const operstates[] = {
296 "notpresent", /* currently unused */
304 static ssize_t operstate_show(struct device *dev,
305 struct device_attribute *attr, char *buf)
307 const struct net_device *netdev = to_net_dev(dev);
308 unsigned char operstate;
310 read_lock(&dev_base_lock);
311 operstate = netdev->operstate;
312 if (!netif_running(netdev))
313 operstate = IF_OPER_DOWN;
314 read_unlock(&dev_base_lock);
316 if (operstate >= ARRAY_SIZE(operstates))
317 return -EINVAL; /* should not happen */
319 return sysfs_emit(buf, "%s\n", operstates[operstate]);
321 static DEVICE_ATTR_RO(operstate);
323 static ssize_t carrier_changes_show(struct device *dev,
324 struct device_attribute *attr,
327 struct net_device *netdev = to_net_dev(dev);
329 return sysfs_emit(buf, fmt_dec,
330 atomic_read(&netdev->carrier_up_count) +
331 atomic_read(&netdev->carrier_down_count));
333 static DEVICE_ATTR_RO(carrier_changes);
335 static ssize_t carrier_up_count_show(struct device *dev,
336 struct device_attribute *attr,
339 struct net_device *netdev = to_net_dev(dev);
341 return sysfs_emit(buf, fmt_dec, atomic_read(&netdev->carrier_up_count));
343 static DEVICE_ATTR_RO(carrier_up_count);
345 static ssize_t carrier_down_count_show(struct device *dev,
346 struct device_attribute *attr,
349 struct net_device *netdev = to_net_dev(dev);
351 return sysfs_emit(buf, fmt_dec, atomic_read(&netdev->carrier_down_count));
353 static DEVICE_ATTR_RO(carrier_down_count);
355 /* read-write attributes */
357 static int change_mtu(struct net_device *dev, unsigned long new_mtu)
359 return dev_set_mtu(dev, (int)new_mtu);
362 static ssize_t mtu_store(struct device *dev, struct device_attribute *attr,
363 const char *buf, size_t len)
365 return netdev_store(dev, attr, buf, len, change_mtu);
367 NETDEVICE_SHOW_RW(mtu, fmt_dec);
369 static int change_flags(struct net_device *dev, unsigned long new_flags)
371 return dev_change_flags(dev, (unsigned int)new_flags, NULL);
374 static ssize_t flags_store(struct device *dev, struct device_attribute *attr,
375 const char *buf, size_t len)
377 return netdev_store(dev, attr, buf, len, change_flags);
379 NETDEVICE_SHOW_RW(flags, fmt_hex);
381 static ssize_t tx_queue_len_store(struct device *dev,
382 struct device_attribute *attr,
383 const char *buf, size_t len)
385 if (!capable(CAP_NET_ADMIN))
388 return netdev_store(dev, attr, buf, len, dev_change_tx_queue_len);
390 NETDEVICE_SHOW_RW(tx_queue_len, fmt_dec);
392 static int change_gro_flush_timeout(struct net_device *dev, unsigned long val)
394 WRITE_ONCE(dev->gro_flush_timeout, val);
398 static ssize_t gro_flush_timeout_store(struct device *dev,
399 struct device_attribute *attr,
400 const char *buf, size_t len)
402 if (!capable(CAP_NET_ADMIN))
405 return netdev_store(dev, attr, buf, len, change_gro_flush_timeout);
407 NETDEVICE_SHOW_RW(gro_flush_timeout, fmt_ulong);
409 static int change_napi_defer_hard_irqs(struct net_device *dev, unsigned long val)
411 WRITE_ONCE(dev->napi_defer_hard_irqs, val);
415 static ssize_t napi_defer_hard_irqs_store(struct device *dev,
416 struct device_attribute *attr,
417 const char *buf, size_t len)
419 if (!capable(CAP_NET_ADMIN))
422 return netdev_store(dev, attr, buf, len, change_napi_defer_hard_irqs);
424 NETDEVICE_SHOW_RW(napi_defer_hard_irqs, fmt_dec);
426 static ssize_t ifalias_store(struct device *dev, struct device_attribute *attr,
427 const char *buf, size_t len)
429 struct net_device *netdev = to_net_dev(dev);
430 struct net *net = dev_net(netdev);
434 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
437 /* ignore trailing newline */
438 if (len > 0 && buf[len - 1] == '\n')
442 return restart_syscall();
444 if (dev_isalive(netdev)) {
445 ret = dev_set_alias(netdev, buf, count);
449 netdev_state_change(netdev);
457 static ssize_t ifalias_show(struct device *dev,
458 struct device_attribute *attr, char *buf)
460 const struct net_device *netdev = to_net_dev(dev);
464 ret = dev_get_alias(netdev, tmp, sizeof(tmp));
466 ret = sysfs_emit(buf, "%s\n", tmp);
469 static DEVICE_ATTR_RW(ifalias);
471 static int change_group(struct net_device *dev, unsigned long new_group)
473 dev_set_group(dev, (int)new_group);
477 static ssize_t group_store(struct device *dev, struct device_attribute *attr,
478 const char *buf, size_t len)
480 return netdev_store(dev, attr, buf, len, change_group);
482 NETDEVICE_SHOW(group, fmt_dec);
483 static DEVICE_ATTR(netdev_group, 0644, group_show, group_store);
485 static int change_proto_down(struct net_device *dev, unsigned long proto_down)
487 return dev_change_proto_down(dev, (bool)proto_down);
490 static ssize_t proto_down_store(struct device *dev,
491 struct device_attribute *attr,
492 const char *buf, size_t len)
494 return netdev_store(dev, attr, buf, len, change_proto_down);
496 NETDEVICE_SHOW_RW(proto_down, fmt_dec);
498 static ssize_t phys_port_id_show(struct device *dev,
499 struct device_attribute *attr, char *buf)
501 struct net_device *netdev = to_net_dev(dev);
502 ssize_t ret = -EINVAL;
504 /* The check is also done in dev_get_phys_port_id; this helps returning
505 * early without hitting the trylock/restart below.
507 if (!netdev->netdev_ops->ndo_get_phys_port_id)
511 return restart_syscall();
513 if (dev_isalive(netdev)) {
514 struct netdev_phys_item_id ppid;
516 ret = dev_get_phys_port_id(netdev, &ppid);
518 ret = sysfs_emit(buf, "%*phN\n", ppid.id_len, ppid.id);
524 static DEVICE_ATTR_RO(phys_port_id);
526 static ssize_t phys_port_name_show(struct device *dev,
527 struct device_attribute *attr, char *buf)
529 struct net_device *netdev = to_net_dev(dev);
530 ssize_t ret = -EINVAL;
532 /* The checks are also done in dev_get_phys_port_name; this helps
533 * returning early without hitting the trylock/restart below.
535 if (!netdev->netdev_ops->ndo_get_phys_port_name &&
536 !netdev->devlink_port)
540 return restart_syscall();
542 if (dev_isalive(netdev)) {
545 ret = dev_get_phys_port_name(netdev, name, sizeof(name));
547 ret = sysfs_emit(buf, "%s\n", name);
553 static DEVICE_ATTR_RO(phys_port_name);
555 static ssize_t phys_switch_id_show(struct device *dev,
556 struct device_attribute *attr, char *buf)
558 struct net_device *netdev = to_net_dev(dev);
559 ssize_t ret = -EINVAL;
561 /* The checks are also done in dev_get_phys_port_name; this helps
562 * returning early without hitting the trylock/restart below. This works
563 * because recurse is false when calling dev_get_port_parent_id.
565 if (!netdev->netdev_ops->ndo_get_port_parent_id &&
566 !netdev->devlink_port)
570 return restart_syscall();
572 if (dev_isalive(netdev)) {
573 struct netdev_phys_item_id ppid = { };
575 ret = dev_get_port_parent_id(netdev, &ppid, false);
577 ret = sysfs_emit(buf, "%*phN\n", ppid.id_len, ppid.id);
583 static DEVICE_ATTR_RO(phys_switch_id);
585 static ssize_t threaded_show(struct device *dev,
586 struct device_attribute *attr, char *buf)
588 struct net_device *netdev = to_net_dev(dev);
589 ssize_t ret = -EINVAL;
592 return restart_syscall();
594 if (dev_isalive(netdev))
595 ret = sysfs_emit(buf, fmt_dec, netdev->threaded);
601 static int modify_napi_threaded(struct net_device *dev, unsigned long val)
605 if (list_empty(&dev->napi_list))
608 if (val != 0 && val != 1)
611 ret = dev_set_threaded(dev, val);
616 static ssize_t threaded_store(struct device *dev,
617 struct device_attribute *attr,
618 const char *buf, size_t len)
620 return netdev_store(dev, attr, buf, len, modify_napi_threaded);
622 static DEVICE_ATTR_RW(threaded);
624 static struct attribute *net_class_attrs[] __ro_after_init = {
625 &dev_attr_netdev_group.attr,
627 &dev_attr_dev_id.attr,
628 &dev_attr_dev_port.attr,
629 &dev_attr_iflink.attr,
630 &dev_attr_ifindex.attr,
631 &dev_attr_name_assign_type.attr,
632 &dev_attr_addr_assign_type.attr,
633 &dev_attr_addr_len.attr,
634 &dev_attr_link_mode.attr,
635 &dev_attr_address.attr,
636 &dev_attr_broadcast.attr,
637 &dev_attr_speed.attr,
638 &dev_attr_duplex.attr,
639 &dev_attr_dormant.attr,
640 &dev_attr_testing.attr,
641 &dev_attr_operstate.attr,
642 &dev_attr_carrier_changes.attr,
643 &dev_attr_ifalias.attr,
644 &dev_attr_carrier.attr,
646 &dev_attr_flags.attr,
647 &dev_attr_tx_queue_len.attr,
648 &dev_attr_gro_flush_timeout.attr,
649 &dev_attr_napi_defer_hard_irqs.attr,
650 &dev_attr_phys_port_id.attr,
651 &dev_attr_phys_port_name.attr,
652 &dev_attr_phys_switch_id.attr,
653 &dev_attr_proto_down.attr,
654 &dev_attr_carrier_up_count.attr,
655 &dev_attr_carrier_down_count.attr,
656 &dev_attr_threaded.attr,
659 ATTRIBUTE_GROUPS(net_class);
661 /* Show a given an attribute in the statistics group */
662 static ssize_t netstat_show(const struct device *d,
663 struct device_attribute *attr, char *buf,
664 unsigned long offset)
666 struct net_device *dev = to_net_dev(d);
667 ssize_t ret = -EINVAL;
669 WARN_ON(offset > sizeof(struct rtnl_link_stats64) ||
670 offset % sizeof(u64) != 0);
672 read_lock(&dev_base_lock);
673 if (dev_isalive(dev)) {
674 struct rtnl_link_stats64 temp;
675 const struct rtnl_link_stats64 *stats = dev_get_stats(dev, &temp);
677 ret = sysfs_emit(buf, fmt_u64, *(u64 *)(((u8 *)stats) + offset));
679 read_unlock(&dev_base_lock);
683 /* generate a read-only statistics attribute */
684 #define NETSTAT_ENTRY(name) \
685 static ssize_t name##_show(struct device *d, \
686 struct device_attribute *attr, char *buf) \
688 return netstat_show(d, attr, buf, \
689 offsetof(struct rtnl_link_stats64, name)); \
691 static DEVICE_ATTR_RO(name)
693 NETSTAT_ENTRY(rx_packets);
694 NETSTAT_ENTRY(tx_packets);
695 NETSTAT_ENTRY(rx_bytes);
696 NETSTAT_ENTRY(tx_bytes);
697 NETSTAT_ENTRY(rx_errors);
698 NETSTAT_ENTRY(tx_errors);
699 NETSTAT_ENTRY(rx_dropped);
700 NETSTAT_ENTRY(tx_dropped);
701 NETSTAT_ENTRY(multicast);
702 NETSTAT_ENTRY(collisions);
703 NETSTAT_ENTRY(rx_length_errors);
704 NETSTAT_ENTRY(rx_over_errors);
705 NETSTAT_ENTRY(rx_crc_errors);
706 NETSTAT_ENTRY(rx_frame_errors);
707 NETSTAT_ENTRY(rx_fifo_errors);
708 NETSTAT_ENTRY(rx_missed_errors);
709 NETSTAT_ENTRY(tx_aborted_errors);
710 NETSTAT_ENTRY(tx_carrier_errors);
711 NETSTAT_ENTRY(tx_fifo_errors);
712 NETSTAT_ENTRY(tx_heartbeat_errors);
713 NETSTAT_ENTRY(tx_window_errors);
714 NETSTAT_ENTRY(rx_compressed);
715 NETSTAT_ENTRY(tx_compressed);
716 NETSTAT_ENTRY(rx_nohandler);
718 static struct attribute *netstat_attrs[] __ro_after_init = {
719 &dev_attr_rx_packets.attr,
720 &dev_attr_tx_packets.attr,
721 &dev_attr_rx_bytes.attr,
722 &dev_attr_tx_bytes.attr,
723 &dev_attr_rx_errors.attr,
724 &dev_attr_tx_errors.attr,
725 &dev_attr_rx_dropped.attr,
726 &dev_attr_tx_dropped.attr,
727 &dev_attr_multicast.attr,
728 &dev_attr_collisions.attr,
729 &dev_attr_rx_length_errors.attr,
730 &dev_attr_rx_over_errors.attr,
731 &dev_attr_rx_crc_errors.attr,
732 &dev_attr_rx_frame_errors.attr,
733 &dev_attr_rx_fifo_errors.attr,
734 &dev_attr_rx_missed_errors.attr,
735 &dev_attr_tx_aborted_errors.attr,
736 &dev_attr_tx_carrier_errors.attr,
737 &dev_attr_tx_fifo_errors.attr,
738 &dev_attr_tx_heartbeat_errors.attr,
739 &dev_attr_tx_window_errors.attr,
740 &dev_attr_rx_compressed.attr,
741 &dev_attr_tx_compressed.attr,
742 &dev_attr_rx_nohandler.attr,
746 static const struct attribute_group netstat_group = {
747 .name = "statistics",
748 .attrs = netstat_attrs,
751 static struct attribute *wireless_attrs[] = {
755 static const struct attribute_group wireless_group = {
757 .attrs = wireless_attrs,
760 static bool wireless_group_needed(struct net_device *ndev)
762 #if IS_ENABLED(CONFIG_CFG80211)
763 if (ndev->ieee80211_ptr)
766 #if IS_ENABLED(CONFIG_WIRELESS_EXT)
767 if (ndev->wireless_handlers)
773 #else /* CONFIG_SYSFS */
774 #define net_class_groups NULL
775 #endif /* CONFIG_SYSFS */
778 #define to_rx_queue_attr(_attr) \
779 container_of(_attr, struct rx_queue_attribute, attr)
781 #define to_rx_queue(obj) container_of(obj, struct netdev_rx_queue, kobj)
783 static ssize_t rx_queue_attr_show(struct kobject *kobj, struct attribute *attr,
786 const struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
787 struct netdev_rx_queue *queue = to_rx_queue(kobj);
789 if (!attribute->show)
792 return attribute->show(queue, buf);
795 static ssize_t rx_queue_attr_store(struct kobject *kobj, struct attribute *attr,
796 const char *buf, size_t count)
798 const struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
799 struct netdev_rx_queue *queue = to_rx_queue(kobj);
801 if (!attribute->store)
804 return attribute->store(queue, buf, count);
807 static const struct sysfs_ops rx_queue_sysfs_ops = {
808 .show = rx_queue_attr_show,
809 .store = rx_queue_attr_store,
813 static ssize_t show_rps_map(struct netdev_rx_queue *queue, char *buf)
819 if (!zalloc_cpumask_var(&mask, GFP_KERNEL))
823 map = rcu_dereference(queue->rps_map);
825 for (i = 0; i < map->len; i++)
826 cpumask_set_cpu(map->cpus[i], mask);
828 len = sysfs_emit(buf, "%*pb\n", cpumask_pr_args(mask));
830 free_cpumask_var(mask);
832 return len < PAGE_SIZE ? len : -EINVAL;
835 static int netdev_rx_queue_set_rps_mask(struct netdev_rx_queue *queue,
838 static DEFINE_MUTEX(rps_map_mutex);
839 struct rps_map *old_map, *map;
842 map = kzalloc(max_t(unsigned int,
843 RPS_MAP_SIZE(cpumask_weight(mask)), L1_CACHE_BYTES),
849 for_each_cpu_and(cpu, mask, cpu_online_mask)
850 map->cpus[i++] = cpu;
859 mutex_lock(&rps_map_mutex);
860 old_map = rcu_dereference_protected(queue->rps_map,
861 mutex_is_locked(&rps_map_mutex));
862 rcu_assign_pointer(queue->rps_map, map);
865 static_branch_inc(&rps_needed);
867 static_branch_dec(&rps_needed);
869 mutex_unlock(&rps_map_mutex);
872 kfree_rcu(old_map, rcu);
876 int rps_cpumask_housekeeping(struct cpumask *mask)
878 if (!cpumask_empty(mask)) {
879 cpumask_and(mask, mask, housekeeping_cpumask(HK_TYPE_DOMAIN));
880 cpumask_and(mask, mask, housekeeping_cpumask(HK_TYPE_WQ));
881 if (cpumask_empty(mask))
887 static ssize_t store_rps_map(struct netdev_rx_queue *queue,
888 const char *buf, size_t len)
893 if (!capable(CAP_NET_ADMIN))
896 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
899 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
903 err = rps_cpumask_housekeeping(mask);
907 err = netdev_rx_queue_set_rps_mask(queue, mask);
910 free_cpumask_var(mask);
914 static ssize_t show_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
917 struct rps_dev_flow_table *flow_table;
918 unsigned long val = 0;
921 flow_table = rcu_dereference(queue->rps_flow_table);
923 val = (unsigned long)flow_table->mask + 1;
926 return sysfs_emit(buf, "%lu\n", val);
929 static void rps_dev_flow_table_release(struct rcu_head *rcu)
931 struct rps_dev_flow_table *table = container_of(rcu,
932 struct rps_dev_flow_table, rcu);
936 static ssize_t store_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
937 const char *buf, size_t len)
939 unsigned long mask, count;
940 struct rps_dev_flow_table *table, *old_table;
941 static DEFINE_SPINLOCK(rps_dev_flow_lock);
944 if (!capable(CAP_NET_ADMIN))
947 rc = kstrtoul(buf, 0, &count);
953 /* mask = roundup_pow_of_two(count) - 1;
954 * without overflows...
956 while ((mask | (mask >> 1)) != mask)
958 /* On 64 bit arches, must check mask fits in table->mask (u32),
959 * and on 32bit arches, must check
960 * RPS_DEV_FLOW_TABLE_SIZE(mask + 1) doesn't overflow.
962 #if BITS_PER_LONG > 32
963 if (mask > (unsigned long)(u32)mask)
966 if (mask > (ULONG_MAX - RPS_DEV_FLOW_TABLE_SIZE(1))
967 / sizeof(struct rps_dev_flow)) {
968 /* Enforce a limit to prevent overflow */
972 table = vmalloc(RPS_DEV_FLOW_TABLE_SIZE(mask + 1));
977 for (count = 0; count <= mask; count++)
978 table->flows[count].cpu = RPS_NO_CPU;
983 spin_lock(&rps_dev_flow_lock);
984 old_table = rcu_dereference_protected(queue->rps_flow_table,
985 lockdep_is_held(&rps_dev_flow_lock));
986 rcu_assign_pointer(queue->rps_flow_table, table);
987 spin_unlock(&rps_dev_flow_lock);
990 call_rcu(&old_table->rcu, rps_dev_flow_table_release);
995 static struct rx_queue_attribute rps_cpus_attribute __ro_after_init
996 = __ATTR(rps_cpus, 0644, show_rps_map, store_rps_map);
998 static struct rx_queue_attribute rps_dev_flow_table_cnt_attribute __ro_after_init
999 = __ATTR(rps_flow_cnt, 0644,
1000 show_rps_dev_flow_table_cnt, store_rps_dev_flow_table_cnt);
1001 #endif /* CONFIG_RPS */
1003 static struct attribute *rx_queue_default_attrs[] __ro_after_init = {
1005 &rps_cpus_attribute.attr,
1006 &rps_dev_flow_table_cnt_attribute.attr,
1010 ATTRIBUTE_GROUPS(rx_queue_default);
1012 static void rx_queue_release(struct kobject *kobj)
1014 struct netdev_rx_queue *queue = to_rx_queue(kobj);
1016 struct rps_map *map;
1017 struct rps_dev_flow_table *flow_table;
1019 map = rcu_dereference_protected(queue->rps_map, 1);
1021 RCU_INIT_POINTER(queue->rps_map, NULL);
1022 kfree_rcu(map, rcu);
1025 flow_table = rcu_dereference_protected(queue->rps_flow_table, 1);
1027 RCU_INIT_POINTER(queue->rps_flow_table, NULL);
1028 call_rcu(&flow_table->rcu, rps_dev_flow_table_release);
1032 memset(kobj, 0, sizeof(*kobj));
1033 netdev_put(queue->dev, &queue->dev_tracker);
1036 static const void *rx_queue_namespace(const struct kobject *kobj)
1038 struct netdev_rx_queue *queue = to_rx_queue(kobj);
1039 struct device *dev = &queue->dev->dev;
1040 const void *ns = NULL;
1042 if (dev->class && dev->class->ns_type)
1043 ns = dev->class->namespace(dev);
1048 static void rx_queue_get_ownership(const struct kobject *kobj,
1049 kuid_t *uid, kgid_t *gid)
1051 const struct net *net = rx_queue_namespace(kobj);
1053 net_ns_get_ownership(net, uid, gid);
1056 static const struct kobj_type rx_queue_ktype = {
1057 .sysfs_ops = &rx_queue_sysfs_ops,
1058 .release = rx_queue_release,
1059 .default_groups = rx_queue_default_groups,
1060 .namespace = rx_queue_namespace,
1061 .get_ownership = rx_queue_get_ownership,
1064 static int rx_queue_default_mask(struct net_device *dev,
1065 struct netdev_rx_queue *queue)
1067 #if IS_ENABLED(CONFIG_RPS) && IS_ENABLED(CONFIG_SYSCTL)
1068 struct cpumask *rps_default_mask = READ_ONCE(dev_net(dev)->core.rps_default_mask);
1070 if (rps_default_mask && !cpumask_empty(rps_default_mask))
1071 return netdev_rx_queue_set_rps_mask(queue, rps_default_mask);
1076 static int rx_queue_add_kobject(struct net_device *dev, int index)
1078 struct netdev_rx_queue *queue = dev->_rx + index;
1079 struct kobject *kobj = &queue->kobj;
1082 /* Kobject_put later will trigger rx_queue_release call which
1083 * decreases dev refcount: Take that reference here
1085 netdev_hold(queue->dev, &queue->dev_tracker, GFP_KERNEL);
1087 kobj->kset = dev->queues_kset;
1088 error = kobject_init_and_add(kobj, &rx_queue_ktype, NULL,
1093 if (dev->sysfs_rx_queue_group) {
1094 error = sysfs_create_group(kobj, dev->sysfs_rx_queue_group);
1099 error = rx_queue_default_mask(dev, queue);
1103 kobject_uevent(kobj, KOBJ_ADD);
1112 static int rx_queue_change_owner(struct net_device *dev, int index, kuid_t kuid,
1115 struct netdev_rx_queue *queue = dev->_rx + index;
1116 struct kobject *kobj = &queue->kobj;
1119 error = sysfs_change_owner(kobj, kuid, kgid);
1123 if (dev->sysfs_rx_queue_group)
1124 error = sysfs_group_change_owner(
1125 kobj, dev->sysfs_rx_queue_group, kuid, kgid);
1129 #endif /* CONFIG_SYSFS */
1132 net_rx_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
1139 if (!dev->sysfs_rx_queue_group)
1142 for (i = old_num; i < new_num; i++) {
1143 error = rx_queue_add_kobject(dev, i);
1150 while (--i >= new_num) {
1151 struct kobject *kobj = &dev->_rx[i].kobj;
1153 if (!refcount_read(&dev_net(dev)->ns.count))
1154 kobj->uevent_suppress = 1;
1155 if (dev->sysfs_rx_queue_group)
1156 sysfs_remove_group(kobj, dev->sysfs_rx_queue_group);
1166 static int net_rx_queue_change_owner(struct net_device *dev, int num,
1167 kuid_t kuid, kgid_t kgid)
1174 if (!dev->sysfs_rx_queue_group)
1177 for (i = 0; i < num; i++) {
1178 error = rx_queue_change_owner(dev, i, kuid, kgid);
1191 * netdev_queue sysfs structures and functions.
1193 struct netdev_queue_attribute {
1194 struct attribute attr;
1195 ssize_t (*show)(struct netdev_queue *queue, char *buf);
1196 ssize_t (*store)(struct netdev_queue *queue,
1197 const char *buf, size_t len);
1199 #define to_netdev_queue_attr(_attr) \
1200 container_of(_attr, struct netdev_queue_attribute, attr)
1202 #define to_netdev_queue(obj) container_of(obj, struct netdev_queue, kobj)
1204 static ssize_t netdev_queue_attr_show(struct kobject *kobj,
1205 struct attribute *attr, char *buf)
1207 const struct netdev_queue_attribute *attribute
1208 = to_netdev_queue_attr(attr);
1209 struct netdev_queue *queue = to_netdev_queue(kobj);
1211 if (!attribute->show)
1214 return attribute->show(queue, buf);
1217 static ssize_t netdev_queue_attr_store(struct kobject *kobj,
1218 struct attribute *attr,
1219 const char *buf, size_t count)
1221 const struct netdev_queue_attribute *attribute
1222 = to_netdev_queue_attr(attr);
1223 struct netdev_queue *queue = to_netdev_queue(kobj);
1225 if (!attribute->store)
1228 return attribute->store(queue, buf, count);
1231 static const struct sysfs_ops netdev_queue_sysfs_ops = {
1232 .show = netdev_queue_attr_show,
1233 .store = netdev_queue_attr_store,
1236 static ssize_t tx_timeout_show(struct netdev_queue *queue, char *buf)
1238 unsigned long trans_timeout = atomic_long_read(&queue->trans_timeout);
1240 return sysfs_emit(buf, fmt_ulong, trans_timeout);
1243 static unsigned int get_netdev_queue_index(struct netdev_queue *queue)
1245 struct net_device *dev = queue->dev;
1248 i = queue - dev->_tx;
1249 BUG_ON(i >= dev->num_tx_queues);
1254 static ssize_t traffic_class_show(struct netdev_queue *queue,
1257 struct net_device *dev = queue->dev;
1261 if (!netif_is_multiqueue(dev))
1264 if (!rtnl_trylock())
1265 return restart_syscall();
1267 index = get_netdev_queue_index(queue);
1269 /* If queue belongs to subordinate dev use its TC mapping */
1270 dev = netdev_get_tx_queue(dev, index)->sb_dev ? : dev;
1272 num_tc = dev->num_tc;
1273 tc = netdev_txq_to_tc(dev, index);
1280 /* We can report the traffic class one of two ways:
1281 * Subordinate device traffic classes are reported with the traffic
1282 * class first, and then the subordinate class so for example TC0 on
1283 * subordinate device 2 will be reported as "0-2". If the queue
1284 * belongs to the root device it will be reported with just the
1285 * traffic class, so just "0" for TC 0 for example.
1287 return num_tc < 0 ? sysfs_emit(buf, "%d%d\n", tc, num_tc) :
1288 sysfs_emit(buf, "%d\n", tc);
1292 static ssize_t tx_maxrate_show(struct netdev_queue *queue,
1295 return sysfs_emit(buf, "%lu\n", queue->tx_maxrate);
1298 static ssize_t tx_maxrate_store(struct netdev_queue *queue,
1299 const char *buf, size_t len)
1301 struct net_device *dev = queue->dev;
1302 int err, index = get_netdev_queue_index(queue);
1305 if (!capable(CAP_NET_ADMIN))
1308 /* The check is also done later; this helps returning early without
1309 * hitting the trylock/restart below.
1311 if (!dev->netdev_ops->ndo_set_tx_maxrate)
1314 err = kstrtou32(buf, 10, &rate);
1318 if (!rtnl_trylock())
1319 return restart_syscall();
1322 if (dev->netdev_ops->ndo_set_tx_maxrate)
1323 err = dev->netdev_ops->ndo_set_tx_maxrate(dev, index, rate);
1327 queue->tx_maxrate = rate;
1333 static struct netdev_queue_attribute queue_tx_maxrate __ro_after_init
1334 = __ATTR_RW(tx_maxrate);
1337 static struct netdev_queue_attribute queue_trans_timeout __ro_after_init
1338 = __ATTR_RO(tx_timeout);
1340 static struct netdev_queue_attribute queue_traffic_class __ro_after_init
1341 = __ATTR_RO(traffic_class);
1345 * Byte queue limits sysfs structures and functions.
1347 static ssize_t bql_show(char *buf, unsigned int value)
1349 return sysfs_emit(buf, "%u\n", value);
1352 static ssize_t bql_set(const char *buf, const size_t count,
1353 unsigned int *pvalue)
1358 if (!strcmp(buf, "max") || !strcmp(buf, "max\n")) {
1359 value = DQL_MAX_LIMIT;
1361 err = kstrtouint(buf, 10, &value);
1364 if (value > DQL_MAX_LIMIT)
1373 static ssize_t bql_show_hold_time(struct netdev_queue *queue,
1376 struct dql *dql = &queue->dql;
1378 return sysfs_emit(buf, "%u\n", jiffies_to_msecs(dql->slack_hold_time));
1381 static ssize_t bql_set_hold_time(struct netdev_queue *queue,
1382 const char *buf, size_t len)
1384 struct dql *dql = &queue->dql;
1388 err = kstrtouint(buf, 10, &value);
1392 dql->slack_hold_time = msecs_to_jiffies(value);
1397 static struct netdev_queue_attribute bql_hold_time_attribute __ro_after_init
1398 = __ATTR(hold_time, 0644,
1399 bql_show_hold_time, bql_set_hold_time);
1401 static ssize_t bql_show_inflight(struct netdev_queue *queue,
1404 struct dql *dql = &queue->dql;
1406 return sysfs_emit(buf, "%u\n", dql->num_queued - dql->num_completed);
1409 static struct netdev_queue_attribute bql_inflight_attribute __ro_after_init =
1410 __ATTR(inflight, 0444, bql_show_inflight, NULL);
1412 #define BQL_ATTR(NAME, FIELD) \
1413 static ssize_t bql_show_ ## NAME(struct netdev_queue *queue, \
1416 return bql_show(buf, queue->dql.FIELD); \
1419 static ssize_t bql_set_ ## NAME(struct netdev_queue *queue, \
1420 const char *buf, size_t len) \
1422 return bql_set(buf, len, &queue->dql.FIELD); \
1425 static struct netdev_queue_attribute bql_ ## NAME ## _attribute __ro_after_init \
1426 = __ATTR(NAME, 0644, \
1427 bql_show_ ## NAME, bql_set_ ## NAME)
1429 BQL_ATTR(limit, limit);
1430 BQL_ATTR(limit_max, max_limit);
1431 BQL_ATTR(limit_min, min_limit);
1433 static struct attribute *dql_attrs[] __ro_after_init = {
1434 &bql_limit_attribute.attr,
1435 &bql_limit_max_attribute.attr,
1436 &bql_limit_min_attribute.attr,
1437 &bql_hold_time_attribute.attr,
1438 &bql_inflight_attribute.attr,
1442 static const struct attribute_group dql_group = {
1443 .name = "byte_queue_limits",
1446 #endif /* CONFIG_BQL */
1449 static ssize_t xps_queue_show(struct net_device *dev, unsigned int index,
1450 int tc, char *buf, enum xps_map_type type)
1452 struct xps_dev_maps *dev_maps;
1453 unsigned long *mask;
1454 unsigned int nr_ids;
1458 dev_maps = rcu_dereference(dev->xps_maps[type]);
1460 /* Default to nr_cpu_ids/dev->num_rx_queues and do not just return 0
1461 * when dev_maps hasn't been allocated yet, to be backward compatible.
1463 nr_ids = dev_maps ? dev_maps->nr_ids :
1464 (type == XPS_CPUS ? nr_cpu_ids : dev->num_rx_queues);
1466 mask = bitmap_zalloc(nr_ids, GFP_NOWAIT);
1472 if (!dev_maps || tc >= dev_maps->num_tc)
1475 for (j = 0; j < nr_ids; j++) {
1476 int i, tci = j * dev_maps->num_tc + tc;
1477 struct xps_map *map;
1479 map = rcu_dereference(dev_maps->attr_map[tci]);
1483 for (i = map->len; i--;) {
1484 if (map->queues[i] == index) {
1493 len = bitmap_print_to_pagebuf(false, buf, mask, nr_ids);
1496 return len < PAGE_SIZE ? len : -EINVAL;
1499 static ssize_t xps_cpus_show(struct netdev_queue *queue, char *buf)
1501 struct net_device *dev = queue->dev;
1505 if (!netif_is_multiqueue(dev))
1508 index = get_netdev_queue_index(queue);
1510 if (!rtnl_trylock())
1511 return restart_syscall();
1513 /* If queue belongs to subordinate dev use its map */
1514 dev = netdev_get_tx_queue(dev, index)->sb_dev ? : dev;
1516 tc = netdev_txq_to_tc(dev, index);
1522 /* Make sure the subordinate device can't be freed */
1523 get_device(&dev->dev);
1526 len = xps_queue_show(dev, index, tc, buf, XPS_CPUS);
1528 put_device(&dev->dev);
1532 static ssize_t xps_cpus_store(struct netdev_queue *queue,
1533 const char *buf, size_t len)
1535 struct net_device *dev = queue->dev;
1540 if (!netif_is_multiqueue(dev))
1543 if (!capable(CAP_NET_ADMIN))
1546 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
1549 index = get_netdev_queue_index(queue);
1551 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
1553 free_cpumask_var(mask);
1557 if (!rtnl_trylock()) {
1558 free_cpumask_var(mask);
1559 return restart_syscall();
1562 err = netif_set_xps_queue(dev, mask, index);
1565 free_cpumask_var(mask);
1570 static struct netdev_queue_attribute xps_cpus_attribute __ro_after_init
1571 = __ATTR_RW(xps_cpus);
1573 static ssize_t xps_rxqs_show(struct netdev_queue *queue, char *buf)
1575 struct net_device *dev = queue->dev;
1579 index = get_netdev_queue_index(queue);
1581 if (!rtnl_trylock())
1582 return restart_syscall();
1584 tc = netdev_txq_to_tc(dev, index);
1589 return xps_queue_show(dev, index, tc, buf, XPS_RXQS);
1592 static ssize_t xps_rxqs_store(struct netdev_queue *queue, const char *buf,
1595 struct net_device *dev = queue->dev;
1596 struct net *net = dev_net(dev);
1597 unsigned long *mask;
1601 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
1604 mask = bitmap_zalloc(dev->num_rx_queues, GFP_KERNEL);
1608 index = get_netdev_queue_index(queue);
1610 err = bitmap_parse(buf, len, mask, dev->num_rx_queues);
1616 if (!rtnl_trylock()) {
1618 return restart_syscall();
1622 err = __netif_set_xps_queue(dev, mask, index, XPS_RXQS);
1631 static struct netdev_queue_attribute xps_rxqs_attribute __ro_after_init
1632 = __ATTR_RW(xps_rxqs);
1633 #endif /* CONFIG_XPS */
1635 static struct attribute *netdev_queue_default_attrs[] __ro_after_init = {
1636 &queue_trans_timeout.attr,
1637 &queue_traffic_class.attr,
1639 &xps_cpus_attribute.attr,
1640 &xps_rxqs_attribute.attr,
1641 &queue_tx_maxrate.attr,
1645 ATTRIBUTE_GROUPS(netdev_queue_default);
1647 static void netdev_queue_release(struct kobject *kobj)
1649 struct netdev_queue *queue = to_netdev_queue(kobj);
1651 memset(kobj, 0, sizeof(*kobj));
1652 netdev_put(queue->dev, &queue->dev_tracker);
1655 static const void *netdev_queue_namespace(const struct kobject *kobj)
1657 struct netdev_queue *queue = to_netdev_queue(kobj);
1658 struct device *dev = &queue->dev->dev;
1659 const void *ns = NULL;
1661 if (dev->class && dev->class->ns_type)
1662 ns = dev->class->namespace(dev);
1667 static void netdev_queue_get_ownership(const struct kobject *kobj,
1668 kuid_t *uid, kgid_t *gid)
1670 const struct net *net = netdev_queue_namespace(kobj);
1672 net_ns_get_ownership(net, uid, gid);
1675 static const struct kobj_type netdev_queue_ktype = {
1676 .sysfs_ops = &netdev_queue_sysfs_ops,
1677 .release = netdev_queue_release,
1678 .default_groups = netdev_queue_default_groups,
1679 .namespace = netdev_queue_namespace,
1680 .get_ownership = netdev_queue_get_ownership,
1683 static int netdev_queue_add_kobject(struct net_device *dev, int index)
1685 struct netdev_queue *queue = dev->_tx + index;
1686 struct kobject *kobj = &queue->kobj;
1689 /* Kobject_put later will trigger netdev_queue_release call
1690 * which decreases dev refcount: Take that reference here
1692 netdev_hold(queue->dev, &queue->dev_tracker, GFP_KERNEL);
1694 kobj->kset = dev->queues_kset;
1695 error = kobject_init_and_add(kobj, &netdev_queue_ktype, NULL,
1701 error = sysfs_create_group(kobj, &dql_group);
1706 kobject_uevent(kobj, KOBJ_ADD);
1714 static int tx_queue_change_owner(struct net_device *ndev, int index,
1715 kuid_t kuid, kgid_t kgid)
1717 struct netdev_queue *queue = ndev->_tx + index;
1718 struct kobject *kobj = &queue->kobj;
1721 error = sysfs_change_owner(kobj, kuid, kgid);
1726 error = sysfs_group_change_owner(kobj, &dql_group, kuid, kgid);
1730 #endif /* CONFIG_SYSFS */
1733 netdev_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
1739 /* Tx queue kobjects are allowed to be updated when a device is being
1740 * unregistered, but solely to remove queues from qdiscs. Any path
1741 * adding queues should be fixed.
1743 WARN(dev->reg_state == NETREG_UNREGISTERING && new_num > old_num,
1744 "New queues can't be registered after device unregistration.");
1746 for (i = old_num; i < new_num; i++) {
1747 error = netdev_queue_add_kobject(dev, i);
1754 while (--i >= new_num) {
1755 struct netdev_queue *queue = dev->_tx + i;
1757 if (!refcount_read(&dev_net(dev)->ns.count))
1758 queue->kobj.uevent_suppress = 1;
1760 sysfs_remove_group(&queue->kobj, &dql_group);
1762 kobject_put(&queue->kobj);
1768 #endif /* CONFIG_SYSFS */
1771 static int net_tx_queue_change_owner(struct net_device *dev, int num,
1772 kuid_t kuid, kgid_t kgid)
1778 for (i = 0; i < num; i++) {
1779 error = tx_queue_change_owner(dev, i, kuid, kgid);
1787 #endif /* CONFIG_SYSFS */
1790 static int register_queue_kobjects(struct net_device *dev)
1792 int error = 0, txq = 0, rxq = 0, real_rx = 0, real_tx = 0;
1795 dev->queues_kset = kset_create_and_add("queues",
1796 NULL, &dev->dev.kobj);
1797 if (!dev->queues_kset)
1799 real_rx = dev->real_num_rx_queues;
1801 real_tx = dev->real_num_tx_queues;
1803 error = net_rx_queue_update_kobjects(dev, 0, real_rx);
1808 error = netdev_queue_update_kobjects(dev, 0, real_tx);
1816 netdev_queue_update_kobjects(dev, txq, 0);
1817 net_rx_queue_update_kobjects(dev, rxq, 0);
1819 kset_unregister(dev->queues_kset);
1824 static int queue_change_owner(struct net_device *ndev, kuid_t kuid, kgid_t kgid)
1826 int error = 0, real_rx = 0, real_tx = 0;
1829 if (ndev->queues_kset) {
1830 error = sysfs_change_owner(&ndev->queues_kset->kobj, kuid, kgid);
1834 real_rx = ndev->real_num_rx_queues;
1836 real_tx = ndev->real_num_tx_queues;
1838 error = net_rx_queue_change_owner(ndev, real_rx, kuid, kgid);
1842 error = net_tx_queue_change_owner(ndev, real_tx, kuid, kgid);
1849 static void remove_queue_kobjects(struct net_device *dev)
1851 int real_rx = 0, real_tx = 0;
1854 real_rx = dev->real_num_rx_queues;
1856 real_tx = dev->real_num_tx_queues;
1858 net_rx_queue_update_kobjects(dev, real_rx, 0);
1859 netdev_queue_update_kobjects(dev, real_tx, 0);
1861 dev->real_num_rx_queues = 0;
1862 dev->real_num_tx_queues = 0;
1864 kset_unregister(dev->queues_kset);
1868 static bool net_current_may_mount(void)
1870 struct net *net = current->nsproxy->net_ns;
1872 return ns_capable(net->user_ns, CAP_SYS_ADMIN);
1875 static void *net_grab_current_ns(void)
1877 struct net *ns = current->nsproxy->net_ns;
1878 #ifdef CONFIG_NET_NS
1880 refcount_inc(&ns->passive);
1885 static const void *net_initial_ns(void)
1890 static const void *net_netlink_ns(struct sock *sk)
1892 return sock_net(sk);
1895 const struct kobj_ns_type_operations net_ns_type_operations = {
1896 .type = KOBJ_NS_TYPE_NET,
1897 .current_may_mount = net_current_may_mount,
1898 .grab_current_ns = net_grab_current_ns,
1899 .netlink_ns = net_netlink_ns,
1900 .initial_ns = net_initial_ns,
1901 .drop_ns = net_drop_ns,
1903 EXPORT_SYMBOL_GPL(net_ns_type_operations);
1905 static int netdev_uevent(const struct device *d, struct kobj_uevent_env *env)
1907 const struct net_device *dev = to_net_dev(d);
1910 /* pass interface to uevent. */
1911 retval = add_uevent_var(env, "INTERFACE=%s", dev->name);
1915 /* pass ifindex to uevent.
1916 * ifindex is useful as it won't change (interface name may change)
1917 * and is what RtNetlink uses natively.
1919 retval = add_uevent_var(env, "IFINDEX=%d", dev->ifindex);
1926 * netdev_release -- destroy and free a dead device.
1927 * Called when last reference to device kobject is gone.
1929 static void netdev_release(struct device *d)
1931 struct net_device *dev = to_net_dev(d);
1933 BUG_ON(dev->reg_state != NETREG_RELEASED);
1935 /* no need to wait for rcu grace period:
1936 * device is dead and about to be freed.
1938 kfree(rcu_access_pointer(dev->ifalias));
1939 netdev_freemem(dev);
1942 static const void *net_namespace(const struct device *d)
1944 const struct net_device *dev = to_net_dev(d);
1946 return dev_net(dev);
1949 static void net_get_ownership(const struct device *d, kuid_t *uid, kgid_t *gid)
1951 const struct net_device *dev = to_net_dev(d);
1952 const struct net *net = dev_net(dev);
1954 net_ns_get_ownership(net, uid, gid);
1957 static struct class net_class __ro_after_init = {
1959 .dev_release = netdev_release,
1960 .dev_groups = net_class_groups,
1961 .dev_uevent = netdev_uevent,
1962 .ns_type = &net_ns_type_operations,
1963 .namespace = net_namespace,
1964 .get_ownership = net_get_ownership,
1968 static int of_dev_node_match(struct device *dev, const void *data)
1970 for (; dev; dev = dev->parent) {
1971 if (dev->of_node == data)
1979 * of_find_net_device_by_node - lookup the net device for the device node
1980 * @np: OF device node
1982 * Looks up the net_device structure corresponding with the device node.
1983 * If successful, returns a pointer to the net_device with the embedded
1984 * struct device refcount incremented by one, or NULL on failure. The
1985 * refcount must be dropped when done with the net_device.
1987 struct net_device *of_find_net_device_by_node(struct device_node *np)
1991 dev = class_find_device(&net_class, NULL, np, of_dev_node_match);
1995 return to_net_dev(dev);
1997 EXPORT_SYMBOL(of_find_net_device_by_node);
2000 /* Delete sysfs entries but hold kobject reference until after all
2001 * netdev references are gone.
2003 void netdev_unregister_kobject(struct net_device *ndev)
2005 struct device *dev = &ndev->dev;
2007 if (!refcount_read(&dev_net(ndev)->ns.count))
2008 dev_set_uevent_suppress(dev, 1);
2010 kobject_get(&dev->kobj);
2012 remove_queue_kobjects(ndev);
2014 pm_runtime_set_memalloc_noio(dev, false);
2019 /* Create sysfs entries for network device. */
2020 int netdev_register_kobject(struct net_device *ndev)
2022 struct device *dev = &ndev->dev;
2023 const struct attribute_group **groups = ndev->sysfs_groups;
2026 device_initialize(dev);
2027 dev->class = &net_class;
2028 dev->platform_data = ndev;
2029 dev->groups = groups;
2031 dev_set_name(dev, "%s", ndev->name);
2034 /* Allow for a device specific group */
2038 *groups++ = &netstat_group;
2040 if (wireless_group_needed(ndev))
2041 *groups++ = &wireless_group;
2042 #endif /* CONFIG_SYSFS */
2044 error = device_add(dev);
2048 error = register_queue_kobjects(ndev);
2054 pm_runtime_set_memalloc_noio(dev, true);
2059 /* Change owner for sysfs entries when moving network devices across network
2060 * namespaces owned by different user namespaces.
2062 int netdev_change_owner(struct net_device *ndev, const struct net *net_old,
2063 const struct net *net_new)
2065 kuid_t old_uid = GLOBAL_ROOT_UID, new_uid = GLOBAL_ROOT_UID;
2066 kgid_t old_gid = GLOBAL_ROOT_GID, new_gid = GLOBAL_ROOT_GID;
2067 struct device *dev = &ndev->dev;
2070 net_ns_get_ownership(net_old, &old_uid, &old_gid);
2071 net_ns_get_ownership(net_new, &new_uid, &new_gid);
2073 /* The network namespace was changed but the owning user namespace is
2074 * identical so there's no need to change the owner of sysfs entries.
2076 if (uid_eq(old_uid, new_uid) && gid_eq(old_gid, new_gid))
2079 error = device_change_owner(dev, new_uid, new_gid);
2083 error = queue_change_owner(ndev, new_uid, new_gid);
2090 int netdev_class_create_file_ns(const struct class_attribute *class_attr,
2093 return class_create_file_ns(&net_class, class_attr, ns);
2095 EXPORT_SYMBOL(netdev_class_create_file_ns);
2097 void netdev_class_remove_file_ns(const struct class_attribute *class_attr,
2100 class_remove_file_ns(&net_class, class_attr, ns);
2102 EXPORT_SYMBOL(netdev_class_remove_file_ns);
2104 int __init netdev_kobject_init(void)
2106 kobj_ns_type_register(&net_ns_type_operations);
2107 return class_register(&net_class);