1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * net-sysfs.c - network device class and attributes
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>
30 #include "net-sysfs.h"
33 static const char fmt_hex[] = "%#x\n";
34 static const char fmt_dec[] = "%d\n";
35 static const char fmt_uint[] = "%u\n";
36 static const char fmt_ulong[] = "%lu\n";
37 static const char fmt_u64[] = "%llu\n";
39 /* Caller holds RTNL or RCU */
40 static inline int dev_isalive(const struct net_device *dev)
42 return READ_ONCE(dev->reg_state) <= NETREG_REGISTERED;
45 /* use same locking rules as GIF* ioctl's */
46 static ssize_t netdev_show(const struct device *dev,
47 struct device_attribute *attr, char *buf,
48 ssize_t (*format)(const struct net_device *, char *))
50 struct net_device *ndev = to_net_dev(dev);
51 ssize_t ret = -EINVAL;
54 if (dev_isalive(ndev))
55 ret = (*format)(ndev, buf);
61 /* generate a show function for simple field */
62 #define NETDEVICE_SHOW(field, format_string) \
63 static ssize_t format_##field(const struct net_device *dev, char *buf) \
65 return sysfs_emit(buf, format_string, READ_ONCE(dev->field)); \
67 static ssize_t field##_show(struct device *dev, \
68 struct device_attribute *attr, char *buf) \
70 return netdev_show(dev, attr, buf, format_##field); \
73 #define NETDEVICE_SHOW_RO(field, format_string) \
74 NETDEVICE_SHOW(field, format_string); \
75 static DEVICE_ATTR_RO(field)
77 #define NETDEVICE_SHOW_RW(field, format_string) \
78 NETDEVICE_SHOW(field, format_string); \
79 static DEVICE_ATTR_RW(field)
81 /* use same locking and permission rules as SIF* ioctl's */
82 static ssize_t netdev_store(struct device *dev, struct device_attribute *attr,
83 const char *buf, size_t len,
84 int (*set)(struct net_device *, unsigned long))
86 struct net_device *netdev = to_net_dev(dev);
87 struct net *net = dev_net(netdev);
91 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
94 ret = kstrtoul(buf, 0, &new);
99 return restart_syscall();
101 if (dev_isalive(netdev)) {
102 ret = (*set)(netdev, new);
111 NETDEVICE_SHOW_RO(dev_id, fmt_hex);
112 NETDEVICE_SHOW_RO(dev_port, fmt_dec);
113 NETDEVICE_SHOW_RO(addr_assign_type, fmt_dec);
114 NETDEVICE_SHOW_RO(addr_len, fmt_dec);
115 NETDEVICE_SHOW_RO(ifindex, fmt_dec);
116 NETDEVICE_SHOW_RO(type, fmt_dec);
117 NETDEVICE_SHOW_RO(link_mode, fmt_dec);
119 static ssize_t iflink_show(struct device *dev, struct device_attribute *attr,
122 struct net_device *ndev = to_net_dev(dev);
124 return sysfs_emit(buf, fmt_dec, dev_get_iflink(ndev));
126 static DEVICE_ATTR_RO(iflink);
128 static ssize_t format_name_assign_type(const struct net_device *dev, char *buf)
130 return sysfs_emit(buf, fmt_dec, READ_ONCE(dev->name_assign_type));
133 static ssize_t name_assign_type_show(struct device *dev,
134 struct device_attribute *attr,
137 struct net_device *ndev = to_net_dev(dev);
138 ssize_t ret = -EINVAL;
140 if (READ_ONCE(ndev->name_assign_type) != NET_NAME_UNKNOWN)
141 ret = netdev_show(dev, attr, buf, format_name_assign_type);
145 static DEVICE_ATTR_RO(name_assign_type);
147 /* use same locking rules as GIFHWADDR ioctl's (dev_get_mac_address()) */
148 static ssize_t address_show(struct device *dev, struct device_attribute *attr,
151 struct net_device *ndev = to_net_dev(dev);
152 ssize_t ret = -EINVAL;
154 down_read(&dev_addr_sem);
157 if (dev_isalive(ndev))
158 ret = sysfs_format_mac(buf, ndev->dev_addr, ndev->addr_len);
161 up_read(&dev_addr_sem);
164 static DEVICE_ATTR_RO(address);
166 static ssize_t broadcast_show(struct device *dev,
167 struct device_attribute *attr, char *buf)
169 struct net_device *ndev = to_net_dev(dev);
173 if (dev_isalive(ndev))
174 ret = sysfs_format_mac(buf, ndev->broadcast, ndev->addr_len);
178 static DEVICE_ATTR_RO(broadcast);
180 static int change_carrier(struct net_device *dev, unsigned long new_carrier)
182 if (!netif_running(dev))
184 return dev_change_carrier(dev, (bool)new_carrier);
187 static ssize_t carrier_store(struct device *dev, struct device_attribute *attr,
188 const char *buf, size_t len)
190 struct net_device *netdev = to_net_dev(dev);
192 /* The check is also done in change_carrier; this helps returning early
193 * without hitting the trylock/restart in netdev_store.
195 if (!netdev->netdev_ops->ndo_change_carrier)
198 return netdev_store(dev, attr, buf, len, change_carrier);
201 static ssize_t carrier_show(struct device *dev,
202 struct device_attribute *attr, char *buf)
204 struct net_device *netdev = to_net_dev(dev);
208 return restart_syscall();
210 if (netif_running(netdev)) {
211 /* Synchronize carrier state with link watch,
212 * see also rtnl_getlink().
214 linkwatch_sync_dev(netdev);
216 ret = sysfs_emit(buf, fmt_dec, !!netif_carrier_ok(netdev));
222 static DEVICE_ATTR_RW(carrier);
224 static ssize_t speed_show(struct device *dev,
225 struct device_attribute *attr, char *buf)
227 struct net_device *netdev = to_net_dev(dev);
230 /* The check is also done in __ethtool_get_link_ksettings; this helps
231 * returning early without hitting the trylock/restart below.
233 if (!netdev->ethtool_ops->get_link_ksettings)
237 return restart_syscall();
239 if (netif_running(netdev)) {
240 struct ethtool_link_ksettings cmd;
242 if (!__ethtool_get_link_ksettings(netdev, &cmd))
243 ret = sysfs_emit(buf, fmt_dec, cmd.base.speed);
248 static DEVICE_ATTR_RO(speed);
250 static ssize_t duplex_show(struct device *dev,
251 struct device_attribute *attr, char *buf)
253 struct net_device *netdev = to_net_dev(dev);
256 /* The check is also done in __ethtool_get_link_ksettings; this helps
257 * returning early without hitting the trylock/restart below.
259 if (!netdev->ethtool_ops->get_link_ksettings)
263 return restart_syscall();
265 if (netif_running(netdev)) {
266 struct ethtool_link_ksettings cmd;
268 if (!__ethtool_get_link_ksettings(netdev, &cmd)) {
271 switch (cmd.base.duplex) {
282 ret = sysfs_emit(buf, "%s\n", duplex);
288 static DEVICE_ATTR_RO(duplex);
290 static ssize_t testing_show(struct device *dev,
291 struct device_attribute *attr, char *buf)
293 struct net_device *netdev = to_net_dev(dev);
295 if (netif_running(netdev))
296 return sysfs_emit(buf, fmt_dec, !!netif_testing(netdev));
300 static DEVICE_ATTR_RO(testing);
302 static ssize_t dormant_show(struct device *dev,
303 struct device_attribute *attr, char *buf)
305 struct net_device *netdev = to_net_dev(dev);
307 if (netif_running(netdev))
308 return sysfs_emit(buf, fmt_dec, !!netif_dormant(netdev));
312 static DEVICE_ATTR_RO(dormant);
314 static const char *const operstates[] = {
316 "notpresent", /* currently unused */
324 static ssize_t operstate_show(struct device *dev,
325 struct device_attribute *attr, char *buf)
327 const struct net_device *netdev = to_net_dev(dev);
328 unsigned char operstate;
330 operstate = READ_ONCE(netdev->operstate);
331 if (!netif_running(netdev))
332 operstate = IF_OPER_DOWN;
334 if (operstate >= ARRAY_SIZE(operstates))
335 return -EINVAL; /* should not happen */
337 return sysfs_emit(buf, "%s\n", operstates[operstate]);
339 static DEVICE_ATTR_RO(operstate);
341 static ssize_t carrier_changes_show(struct device *dev,
342 struct device_attribute *attr,
345 struct net_device *netdev = to_net_dev(dev);
347 return sysfs_emit(buf, fmt_dec,
348 atomic_read(&netdev->carrier_up_count) +
349 atomic_read(&netdev->carrier_down_count));
351 static DEVICE_ATTR_RO(carrier_changes);
353 static ssize_t carrier_up_count_show(struct device *dev,
354 struct device_attribute *attr,
357 struct net_device *netdev = to_net_dev(dev);
359 return sysfs_emit(buf, fmt_dec, atomic_read(&netdev->carrier_up_count));
361 static DEVICE_ATTR_RO(carrier_up_count);
363 static ssize_t carrier_down_count_show(struct device *dev,
364 struct device_attribute *attr,
367 struct net_device *netdev = to_net_dev(dev);
369 return sysfs_emit(buf, fmt_dec, atomic_read(&netdev->carrier_down_count));
371 static DEVICE_ATTR_RO(carrier_down_count);
373 /* read-write attributes */
375 static int change_mtu(struct net_device *dev, unsigned long new_mtu)
377 return dev_set_mtu(dev, (int)new_mtu);
380 static ssize_t mtu_store(struct device *dev, struct device_attribute *attr,
381 const char *buf, size_t len)
383 return netdev_store(dev, attr, buf, len, change_mtu);
385 NETDEVICE_SHOW_RW(mtu, fmt_dec);
387 static int change_flags(struct net_device *dev, unsigned long new_flags)
389 return dev_change_flags(dev, (unsigned int)new_flags, NULL);
392 static ssize_t flags_store(struct device *dev, struct device_attribute *attr,
393 const char *buf, size_t len)
395 return netdev_store(dev, attr, buf, len, change_flags);
397 NETDEVICE_SHOW_RW(flags, fmt_hex);
399 static ssize_t tx_queue_len_store(struct device *dev,
400 struct device_attribute *attr,
401 const char *buf, size_t len)
403 if (!capable(CAP_NET_ADMIN))
406 return netdev_store(dev, attr, buf, len, dev_change_tx_queue_len);
408 NETDEVICE_SHOW_RW(tx_queue_len, fmt_dec);
410 static int change_gro_flush_timeout(struct net_device *dev, unsigned long val)
412 netdev_set_gro_flush_timeout(dev, val);
416 static ssize_t gro_flush_timeout_store(struct device *dev,
417 struct device_attribute *attr,
418 const char *buf, size_t len)
420 if (!capable(CAP_NET_ADMIN))
423 return netdev_store(dev, attr, buf, len, change_gro_flush_timeout);
425 NETDEVICE_SHOW_RW(gro_flush_timeout, fmt_ulong);
427 static int change_napi_defer_hard_irqs(struct net_device *dev, unsigned long val)
432 netdev_set_defer_hard_irqs(dev, (u32)val);
436 static ssize_t napi_defer_hard_irqs_store(struct device *dev,
437 struct device_attribute *attr,
438 const char *buf, size_t len)
440 if (!capable(CAP_NET_ADMIN))
443 return netdev_store(dev, attr, buf, len, change_napi_defer_hard_irqs);
445 NETDEVICE_SHOW_RW(napi_defer_hard_irqs, fmt_uint);
447 static ssize_t ifalias_store(struct device *dev, struct device_attribute *attr,
448 const char *buf, size_t len)
450 struct net_device *netdev = to_net_dev(dev);
451 struct net *net = dev_net(netdev);
455 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
458 /* ignore trailing newline */
459 if (len > 0 && buf[len - 1] == '\n')
463 return restart_syscall();
465 if (dev_isalive(netdev)) {
466 ret = dev_set_alias(netdev, buf, count);
470 netdev_state_change(netdev);
478 static ssize_t ifalias_show(struct device *dev,
479 struct device_attribute *attr, char *buf)
481 const struct net_device *netdev = to_net_dev(dev);
485 ret = dev_get_alias(netdev, tmp, sizeof(tmp));
487 ret = sysfs_emit(buf, "%s\n", tmp);
490 static DEVICE_ATTR_RW(ifalias);
492 static int change_group(struct net_device *dev, unsigned long new_group)
494 dev_set_group(dev, (int)new_group);
498 static ssize_t group_store(struct device *dev, struct device_attribute *attr,
499 const char *buf, size_t len)
501 return netdev_store(dev, attr, buf, len, change_group);
503 NETDEVICE_SHOW(group, fmt_dec);
504 static DEVICE_ATTR(netdev_group, 0644, group_show, group_store);
506 static int change_proto_down(struct net_device *dev, unsigned long proto_down)
508 return dev_change_proto_down(dev, (bool)proto_down);
511 static ssize_t proto_down_store(struct device *dev,
512 struct device_attribute *attr,
513 const char *buf, size_t len)
515 return netdev_store(dev, attr, buf, len, change_proto_down);
517 NETDEVICE_SHOW_RW(proto_down, fmt_dec);
519 static ssize_t phys_port_id_show(struct device *dev,
520 struct device_attribute *attr, char *buf)
522 struct net_device *netdev = to_net_dev(dev);
523 ssize_t ret = -EINVAL;
525 /* The check is also done in dev_get_phys_port_id; this helps returning
526 * early without hitting the trylock/restart below.
528 if (!netdev->netdev_ops->ndo_get_phys_port_id)
532 return restart_syscall();
534 if (dev_isalive(netdev)) {
535 struct netdev_phys_item_id ppid;
537 ret = dev_get_phys_port_id(netdev, &ppid);
539 ret = sysfs_emit(buf, "%*phN\n", ppid.id_len, ppid.id);
545 static DEVICE_ATTR_RO(phys_port_id);
547 static ssize_t phys_port_name_show(struct device *dev,
548 struct device_attribute *attr, char *buf)
550 struct net_device *netdev = to_net_dev(dev);
551 ssize_t ret = -EINVAL;
553 /* The checks are also done in dev_get_phys_port_name; this helps
554 * returning early without hitting the trylock/restart below.
556 if (!netdev->netdev_ops->ndo_get_phys_port_name &&
557 !netdev->devlink_port)
561 return restart_syscall();
563 if (dev_isalive(netdev)) {
566 ret = dev_get_phys_port_name(netdev, name, sizeof(name));
568 ret = sysfs_emit(buf, "%s\n", name);
574 static DEVICE_ATTR_RO(phys_port_name);
576 static ssize_t phys_switch_id_show(struct device *dev,
577 struct device_attribute *attr, char *buf)
579 struct net_device *netdev = to_net_dev(dev);
580 ssize_t ret = -EINVAL;
582 /* The checks are also done in dev_get_phys_port_name; this helps
583 * returning early without hitting the trylock/restart below. This works
584 * because recurse is false when calling dev_get_port_parent_id.
586 if (!netdev->netdev_ops->ndo_get_port_parent_id &&
587 !netdev->devlink_port)
591 return restart_syscall();
593 if (dev_isalive(netdev)) {
594 struct netdev_phys_item_id ppid = { };
596 ret = dev_get_port_parent_id(netdev, &ppid, false);
598 ret = sysfs_emit(buf, "%*phN\n", ppid.id_len, ppid.id);
604 static DEVICE_ATTR_RO(phys_switch_id);
606 static ssize_t threaded_show(struct device *dev,
607 struct device_attribute *attr, char *buf)
609 struct net_device *netdev = to_net_dev(dev);
610 ssize_t ret = -EINVAL;
614 if (dev_isalive(netdev))
615 ret = sysfs_emit(buf, fmt_dec, READ_ONCE(netdev->threaded));
622 static int modify_napi_threaded(struct net_device *dev, unsigned long val)
626 if (list_empty(&dev->napi_list))
629 if (val != 0 && val != 1)
632 ret = dev_set_threaded(dev, val);
637 static ssize_t threaded_store(struct device *dev,
638 struct device_attribute *attr,
639 const char *buf, size_t len)
641 return netdev_store(dev, attr, buf, len, modify_napi_threaded);
643 static DEVICE_ATTR_RW(threaded);
645 static struct attribute *net_class_attrs[] __ro_after_init = {
646 &dev_attr_netdev_group.attr,
648 &dev_attr_dev_id.attr,
649 &dev_attr_dev_port.attr,
650 &dev_attr_iflink.attr,
651 &dev_attr_ifindex.attr,
652 &dev_attr_name_assign_type.attr,
653 &dev_attr_addr_assign_type.attr,
654 &dev_attr_addr_len.attr,
655 &dev_attr_link_mode.attr,
656 &dev_attr_address.attr,
657 &dev_attr_broadcast.attr,
658 &dev_attr_speed.attr,
659 &dev_attr_duplex.attr,
660 &dev_attr_dormant.attr,
661 &dev_attr_testing.attr,
662 &dev_attr_operstate.attr,
663 &dev_attr_carrier_changes.attr,
664 &dev_attr_ifalias.attr,
665 &dev_attr_carrier.attr,
667 &dev_attr_flags.attr,
668 &dev_attr_tx_queue_len.attr,
669 &dev_attr_gro_flush_timeout.attr,
670 &dev_attr_napi_defer_hard_irqs.attr,
671 &dev_attr_phys_port_id.attr,
672 &dev_attr_phys_port_name.attr,
673 &dev_attr_phys_switch_id.attr,
674 &dev_attr_proto_down.attr,
675 &dev_attr_carrier_up_count.attr,
676 &dev_attr_carrier_down_count.attr,
677 &dev_attr_threaded.attr,
680 ATTRIBUTE_GROUPS(net_class);
682 /* Show a given an attribute in the statistics group */
683 static ssize_t netstat_show(const struct device *d,
684 struct device_attribute *attr, char *buf,
685 unsigned long offset)
687 struct net_device *dev = to_net_dev(d);
688 ssize_t ret = -EINVAL;
690 WARN_ON(offset > sizeof(struct rtnl_link_stats64) ||
691 offset % sizeof(u64) != 0);
694 if (dev_isalive(dev)) {
695 struct rtnl_link_stats64 temp;
696 const struct rtnl_link_stats64 *stats = dev_get_stats(dev, &temp);
698 ret = sysfs_emit(buf, fmt_u64, *(u64 *)(((u8 *)stats) + offset));
704 /* generate a read-only statistics attribute */
705 #define NETSTAT_ENTRY(name) \
706 static ssize_t name##_show(struct device *d, \
707 struct device_attribute *attr, char *buf) \
709 return netstat_show(d, attr, buf, \
710 offsetof(struct rtnl_link_stats64, name)); \
712 static DEVICE_ATTR_RO(name)
714 NETSTAT_ENTRY(rx_packets);
715 NETSTAT_ENTRY(tx_packets);
716 NETSTAT_ENTRY(rx_bytes);
717 NETSTAT_ENTRY(tx_bytes);
718 NETSTAT_ENTRY(rx_errors);
719 NETSTAT_ENTRY(tx_errors);
720 NETSTAT_ENTRY(rx_dropped);
721 NETSTAT_ENTRY(tx_dropped);
722 NETSTAT_ENTRY(multicast);
723 NETSTAT_ENTRY(collisions);
724 NETSTAT_ENTRY(rx_length_errors);
725 NETSTAT_ENTRY(rx_over_errors);
726 NETSTAT_ENTRY(rx_crc_errors);
727 NETSTAT_ENTRY(rx_frame_errors);
728 NETSTAT_ENTRY(rx_fifo_errors);
729 NETSTAT_ENTRY(rx_missed_errors);
730 NETSTAT_ENTRY(tx_aborted_errors);
731 NETSTAT_ENTRY(tx_carrier_errors);
732 NETSTAT_ENTRY(tx_fifo_errors);
733 NETSTAT_ENTRY(tx_heartbeat_errors);
734 NETSTAT_ENTRY(tx_window_errors);
735 NETSTAT_ENTRY(rx_compressed);
736 NETSTAT_ENTRY(tx_compressed);
737 NETSTAT_ENTRY(rx_nohandler);
739 static struct attribute *netstat_attrs[] __ro_after_init = {
740 &dev_attr_rx_packets.attr,
741 &dev_attr_tx_packets.attr,
742 &dev_attr_rx_bytes.attr,
743 &dev_attr_tx_bytes.attr,
744 &dev_attr_rx_errors.attr,
745 &dev_attr_tx_errors.attr,
746 &dev_attr_rx_dropped.attr,
747 &dev_attr_tx_dropped.attr,
748 &dev_attr_multicast.attr,
749 &dev_attr_collisions.attr,
750 &dev_attr_rx_length_errors.attr,
751 &dev_attr_rx_over_errors.attr,
752 &dev_attr_rx_crc_errors.attr,
753 &dev_attr_rx_frame_errors.attr,
754 &dev_attr_rx_fifo_errors.attr,
755 &dev_attr_rx_missed_errors.attr,
756 &dev_attr_tx_aborted_errors.attr,
757 &dev_attr_tx_carrier_errors.attr,
758 &dev_attr_tx_fifo_errors.attr,
759 &dev_attr_tx_heartbeat_errors.attr,
760 &dev_attr_tx_window_errors.attr,
761 &dev_attr_rx_compressed.attr,
762 &dev_attr_tx_compressed.attr,
763 &dev_attr_rx_nohandler.attr,
767 static const struct attribute_group netstat_group = {
768 .name = "statistics",
769 .attrs = netstat_attrs,
772 static struct attribute *wireless_attrs[] = {
776 static const struct attribute_group wireless_group = {
778 .attrs = wireless_attrs,
781 static bool wireless_group_needed(struct net_device *ndev)
783 #if IS_ENABLED(CONFIG_CFG80211)
784 if (ndev->ieee80211_ptr)
787 #if IS_ENABLED(CONFIG_WIRELESS_EXT)
788 if (ndev->wireless_handlers)
794 #else /* CONFIG_SYSFS */
795 #define net_class_groups NULL
796 #endif /* CONFIG_SYSFS */
799 #define to_rx_queue_attr(_attr) \
800 container_of(_attr, struct rx_queue_attribute, attr)
802 #define to_rx_queue(obj) container_of(obj, struct netdev_rx_queue, kobj)
804 static ssize_t rx_queue_attr_show(struct kobject *kobj, struct attribute *attr,
807 const struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
808 struct netdev_rx_queue *queue = to_rx_queue(kobj);
810 if (!attribute->show)
813 return attribute->show(queue, buf);
816 static ssize_t rx_queue_attr_store(struct kobject *kobj, struct attribute *attr,
817 const char *buf, size_t count)
819 const struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
820 struct netdev_rx_queue *queue = to_rx_queue(kobj);
822 if (!attribute->store)
825 return attribute->store(queue, buf, count);
828 static const struct sysfs_ops rx_queue_sysfs_ops = {
829 .show = rx_queue_attr_show,
830 .store = rx_queue_attr_store,
834 static ssize_t show_rps_map(struct netdev_rx_queue *queue, char *buf)
840 if (!zalloc_cpumask_var(&mask, GFP_KERNEL))
844 map = rcu_dereference(queue->rps_map);
846 for (i = 0; i < map->len; i++)
847 cpumask_set_cpu(map->cpus[i], mask);
849 len = sysfs_emit(buf, "%*pb\n", cpumask_pr_args(mask));
851 free_cpumask_var(mask);
853 return len < PAGE_SIZE ? len : -EINVAL;
856 static int netdev_rx_queue_set_rps_mask(struct netdev_rx_queue *queue,
859 static DEFINE_MUTEX(rps_map_mutex);
860 struct rps_map *old_map, *map;
863 map = kzalloc(max_t(unsigned int,
864 RPS_MAP_SIZE(cpumask_weight(mask)), L1_CACHE_BYTES),
870 for_each_cpu_and(cpu, mask, cpu_online_mask)
871 map->cpus[i++] = cpu;
880 mutex_lock(&rps_map_mutex);
881 old_map = rcu_dereference_protected(queue->rps_map,
882 mutex_is_locked(&rps_map_mutex));
883 rcu_assign_pointer(queue->rps_map, map);
886 static_branch_inc(&rps_needed);
888 static_branch_dec(&rps_needed);
890 mutex_unlock(&rps_map_mutex);
893 kfree_rcu(old_map, rcu);
897 int rps_cpumask_housekeeping(struct cpumask *mask)
899 if (!cpumask_empty(mask)) {
900 cpumask_and(mask, mask, housekeeping_cpumask(HK_TYPE_DOMAIN));
901 cpumask_and(mask, mask, housekeeping_cpumask(HK_TYPE_WQ));
902 if (cpumask_empty(mask))
908 static ssize_t store_rps_map(struct netdev_rx_queue *queue,
909 const char *buf, size_t len)
914 if (!capable(CAP_NET_ADMIN))
917 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
920 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
924 err = rps_cpumask_housekeeping(mask);
928 err = netdev_rx_queue_set_rps_mask(queue, mask);
931 free_cpumask_var(mask);
935 static ssize_t show_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
938 struct rps_dev_flow_table *flow_table;
939 unsigned long val = 0;
942 flow_table = rcu_dereference(queue->rps_flow_table);
944 val = (unsigned long)flow_table->mask + 1;
947 return sysfs_emit(buf, "%lu\n", val);
950 static void rps_dev_flow_table_release(struct rcu_head *rcu)
952 struct rps_dev_flow_table *table = container_of(rcu,
953 struct rps_dev_flow_table, rcu);
957 static ssize_t store_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
958 const char *buf, size_t len)
960 unsigned long mask, count;
961 struct rps_dev_flow_table *table, *old_table;
962 static DEFINE_SPINLOCK(rps_dev_flow_lock);
965 if (!capable(CAP_NET_ADMIN))
968 rc = kstrtoul(buf, 0, &count);
974 /* mask = roundup_pow_of_two(count) - 1;
975 * without overflows...
977 while ((mask | (mask >> 1)) != mask)
979 /* On 64 bit arches, must check mask fits in table->mask (u32),
980 * and on 32bit arches, must check
981 * RPS_DEV_FLOW_TABLE_SIZE(mask + 1) doesn't overflow.
983 #if BITS_PER_LONG > 32
984 if (mask > (unsigned long)(u32)mask)
987 if (mask > (ULONG_MAX - RPS_DEV_FLOW_TABLE_SIZE(1))
988 / sizeof(struct rps_dev_flow)) {
989 /* Enforce a limit to prevent overflow */
993 table = vmalloc(RPS_DEV_FLOW_TABLE_SIZE(mask + 1));
998 for (count = 0; count <= mask; count++)
999 table->flows[count].cpu = RPS_NO_CPU;
1004 spin_lock(&rps_dev_flow_lock);
1005 old_table = rcu_dereference_protected(queue->rps_flow_table,
1006 lockdep_is_held(&rps_dev_flow_lock));
1007 rcu_assign_pointer(queue->rps_flow_table, table);
1008 spin_unlock(&rps_dev_flow_lock);
1011 call_rcu(&old_table->rcu, rps_dev_flow_table_release);
1016 static struct rx_queue_attribute rps_cpus_attribute __ro_after_init
1017 = __ATTR(rps_cpus, 0644, show_rps_map, store_rps_map);
1019 static struct rx_queue_attribute rps_dev_flow_table_cnt_attribute __ro_after_init
1020 = __ATTR(rps_flow_cnt, 0644,
1021 show_rps_dev_flow_table_cnt, store_rps_dev_flow_table_cnt);
1022 #endif /* CONFIG_RPS */
1024 static struct attribute *rx_queue_default_attrs[] __ro_after_init = {
1026 &rps_cpus_attribute.attr,
1027 &rps_dev_flow_table_cnt_attribute.attr,
1031 ATTRIBUTE_GROUPS(rx_queue_default);
1033 static void rx_queue_release(struct kobject *kobj)
1035 struct netdev_rx_queue *queue = to_rx_queue(kobj);
1037 struct rps_map *map;
1038 struct rps_dev_flow_table *flow_table;
1040 map = rcu_dereference_protected(queue->rps_map, 1);
1042 RCU_INIT_POINTER(queue->rps_map, NULL);
1043 kfree_rcu(map, rcu);
1046 flow_table = rcu_dereference_protected(queue->rps_flow_table, 1);
1048 RCU_INIT_POINTER(queue->rps_flow_table, NULL);
1049 call_rcu(&flow_table->rcu, rps_dev_flow_table_release);
1053 memset(kobj, 0, sizeof(*kobj));
1054 netdev_put(queue->dev, &queue->dev_tracker);
1057 static const void *rx_queue_namespace(const struct kobject *kobj)
1059 struct netdev_rx_queue *queue = to_rx_queue(kobj);
1060 struct device *dev = &queue->dev->dev;
1061 const void *ns = NULL;
1063 if (dev->class && dev->class->namespace)
1064 ns = dev->class->namespace(dev);
1069 static void rx_queue_get_ownership(const struct kobject *kobj,
1070 kuid_t *uid, kgid_t *gid)
1072 const struct net *net = rx_queue_namespace(kobj);
1074 net_ns_get_ownership(net, uid, gid);
1077 static const struct kobj_type rx_queue_ktype = {
1078 .sysfs_ops = &rx_queue_sysfs_ops,
1079 .release = rx_queue_release,
1080 .default_groups = rx_queue_default_groups,
1081 .namespace = rx_queue_namespace,
1082 .get_ownership = rx_queue_get_ownership,
1085 static int rx_queue_default_mask(struct net_device *dev,
1086 struct netdev_rx_queue *queue)
1088 #if IS_ENABLED(CONFIG_RPS) && IS_ENABLED(CONFIG_SYSCTL)
1089 struct cpumask *rps_default_mask = READ_ONCE(dev_net(dev)->core.rps_default_mask);
1091 if (rps_default_mask && !cpumask_empty(rps_default_mask))
1092 return netdev_rx_queue_set_rps_mask(queue, rps_default_mask);
1097 static int rx_queue_add_kobject(struct net_device *dev, int index)
1099 struct netdev_rx_queue *queue = dev->_rx + index;
1100 struct kobject *kobj = &queue->kobj;
1103 /* Kobject_put later will trigger rx_queue_release call which
1104 * decreases dev refcount: Take that reference here
1106 netdev_hold(queue->dev, &queue->dev_tracker, GFP_KERNEL);
1108 kobj->kset = dev->queues_kset;
1109 error = kobject_init_and_add(kobj, &rx_queue_ktype, NULL,
1114 if (dev->sysfs_rx_queue_group) {
1115 error = sysfs_create_group(kobj, dev->sysfs_rx_queue_group);
1120 error = rx_queue_default_mask(dev, queue);
1124 kobject_uevent(kobj, KOBJ_ADD);
1133 static int rx_queue_change_owner(struct net_device *dev, int index, kuid_t kuid,
1136 struct netdev_rx_queue *queue = dev->_rx + index;
1137 struct kobject *kobj = &queue->kobj;
1140 error = sysfs_change_owner(kobj, kuid, kgid);
1144 if (dev->sysfs_rx_queue_group)
1145 error = sysfs_group_change_owner(
1146 kobj, dev->sysfs_rx_queue_group, kuid, kgid);
1150 #endif /* CONFIG_SYSFS */
1153 net_rx_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
1160 if (!dev->sysfs_rx_queue_group)
1163 for (i = old_num; i < new_num; i++) {
1164 error = rx_queue_add_kobject(dev, i);
1171 while (--i >= new_num) {
1172 struct kobject *kobj = &dev->_rx[i].kobj;
1174 if (!refcount_read(&dev_net(dev)->ns.count))
1175 kobj->uevent_suppress = 1;
1176 if (dev->sysfs_rx_queue_group)
1177 sysfs_remove_group(kobj, dev->sysfs_rx_queue_group);
1187 static int net_rx_queue_change_owner(struct net_device *dev, int num,
1188 kuid_t kuid, kgid_t kgid)
1195 if (!dev->sysfs_rx_queue_group)
1198 for (i = 0; i < num; i++) {
1199 error = rx_queue_change_owner(dev, i, kuid, kgid);
1212 * netdev_queue sysfs structures and functions.
1214 struct netdev_queue_attribute {
1215 struct attribute attr;
1216 ssize_t (*show)(struct netdev_queue *queue, char *buf);
1217 ssize_t (*store)(struct netdev_queue *queue,
1218 const char *buf, size_t len);
1220 #define to_netdev_queue_attr(_attr) \
1221 container_of(_attr, struct netdev_queue_attribute, attr)
1223 #define to_netdev_queue(obj) container_of(obj, struct netdev_queue, kobj)
1225 static ssize_t netdev_queue_attr_show(struct kobject *kobj,
1226 struct attribute *attr, char *buf)
1228 const struct netdev_queue_attribute *attribute
1229 = to_netdev_queue_attr(attr);
1230 struct netdev_queue *queue = to_netdev_queue(kobj);
1232 if (!attribute->show)
1235 return attribute->show(queue, buf);
1238 static ssize_t netdev_queue_attr_store(struct kobject *kobj,
1239 struct attribute *attr,
1240 const char *buf, size_t count)
1242 const struct netdev_queue_attribute *attribute
1243 = to_netdev_queue_attr(attr);
1244 struct netdev_queue *queue = to_netdev_queue(kobj);
1246 if (!attribute->store)
1249 return attribute->store(queue, buf, count);
1252 static const struct sysfs_ops netdev_queue_sysfs_ops = {
1253 .show = netdev_queue_attr_show,
1254 .store = netdev_queue_attr_store,
1257 static ssize_t tx_timeout_show(struct netdev_queue *queue, char *buf)
1259 unsigned long trans_timeout = atomic_long_read(&queue->trans_timeout);
1261 return sysfs_emit(buf, fmt_ulong, trans_timeout);
1264 static unsigned int get_netdev_queue_index(struct netdev_queue *queue)
1266 struct net_device *dev = queue->dev;
1269 i = queue - dev->_tx;
1270 BUG_ON(i >= dev->num_tx_queues);
1275 static ssize_t traffic_class_show(struct netdev_queue *queue,
1278 struct net_device *dev = queue->dev;
1282 if (!netif_is_multiqueue(dev))
1285 if (!rtnl_trylock())
1286 return restart_syscall();
1288 index = get_netdev_queue_index(queue);
1290 /* If queue belongs to subordinate dev use its TC mapping */
1291 dev = netdev_get_tx_queue(dev, index)->sb_dev ? : dev;
1293 num_tc = dev->num_tc;
1294 tc = netdev_txq_to_tc(dev, index);
1301 /* We can report the traffic class one of two ways:
1302 * Subordinate device traffic classes are reported with the traffic
1303 * class first, and then the subordinate class so for example TC0 on
1304 * subordinate device 2 will be reported as "0-2". If the queue
1305 * belongs to the root device it will be reported with just the
1306 * traffic class, so just "0" for TC 0 for example.
1308 return num_tc < 0 ? sysfs_emit(buf, "%d%d\n", tc, num_tc) :
1309 sysfs_emit(buf, "%d\n", tc);
1313 static ssize_t tx_maxrate_show(struct netdev_queue *queue,
1316 return sysfs_emit(buf, "%lu\n", queue->tx_maxrate);
1319 static ssize_t tx_maxrate_store(struct netdev_queue *queue,
1320 const char *buf, size_t len)
1322 struct net_device *dev = queue->dev;
1323 int err, index = get_netdev_queue_index(queue);
1326 if (!capable(CAP_NET_ADMIN))
1329 /* The check is also done later; this helps returning early without
1330 * hitting the trylock/restart below.
1332 if (!dev->netdev_ops->ndo_set_tx_maxrate)
1335 err = kstrtou32(buf, 10, &rate);
1339 if (!rtnl_trylock())
1340 return restart_syscall();
1343 if (dev->netdev_ops->ndo_set_tx_maxrate)
1344 err = dev->netdev_ops->ndo_set_tx_maxrate(dev, index, rate);
1348 queue->tx_maxrate = rate;
1354 static struct netdev_queue_attribute queue_tx_maxrate __ro_after_init
1355 = __ATTR_RW(tx_maxrate);
1358 static struct netdev_queue_attribute queue_trans_timeout __ro_after_init
1359 = __ATTR_RO(tx_timeout);
1361 static struct netdev_queue_attribute queue_traffic_class __ro_after_init
1362 = __ATTR_RO(traffic_class);
1366 * Byte queue limits sysfs structures and functions.
1368 static ssize_t bql_show(char *buf, unsigned int value)
1370 return sysfs_emit(buf, "%u\n", value);
1373 static ssize_t bql_set(const char *buf, const size_t count,
1374 unsigned int *pvalue)
1379 if (!strcmp(buf, "max") || !strcmp(buf, "max\n")) {
1380 value = DQL_MAX_LIMIT;
1382 err = kstrtouint(buf, 10, &value);
1385 if (value > DQL_MAX_LIMIT)
1394 static ssize_t bql_show_hold_time(struct netdev_queue *queue,
1397 struct dql *dql = &queue->dql;
1399 return sysfs_emit(buf, "%u\n", jiffies_to_msecs(dql->slack_hold_time));
1402 static ssize_t bql_set_hold_time(struct netdev_queue *queue,
1403 const char *buf, size_t len)
1405 struct dql *dql = &queue->dql;
1409 err = kstrtouint(buf, 10, &value);
1413 dql->slack_hold_time = msecs_to_jiffies(value);
1418 static struct netdev_queue_attribute bql_hold_time_attribute __ro_after_init
1419 = __ATTR(hold_time, 0644,
1420 bql_show_hold_time, bql_set_hold_time);
1422 static ssize_t bql_show_stall_thrs(struct netdev_queue *queue, char *buf)
1424 struct dql *dql = &queue->dql;
1426 return sysfs_emit(buf, "%u\n", jiffies_to_msecs(dql->stall_thrs));
1429 static ssize_t bql_set_stall_thrs(struct netdev_queue *queue,
1430 const char *buf, size_t len)
1432 struct dql *dql = &queue->dql;
1436 err = kstrtouint(buf, 10, &value);
1440 value = msecs_to_jiffies(value);
1441 if (value && (value < 4 || value > 4 / 2 * BITS_PER_LONG))
1444 if (!dql->stall_thrs && value)
1445 dql->last_reap = jiffies;
1446 /* Force last_reap to be live */
1448 dql->stall_thrs = value;
1453 static struct netdev_queue_attribute bql_stall_thrs_attribute __ro_after_init =
1454 __ATTR(stall_thrs, 0644, bql_show_stall_thrs, bql_set_stall_thrs);
1456 static ssize_t bql_show_stall_max(struct netdev_queue *queue, char *buf)
1458 return sysfs_emit(buf, "%u\n", READ_ONCE(queue->dql.stall_max));
1461 static ssize_t bql_set_stall_max(struct netdev_queue *queue,
1462 const char *buf, size_t len)
1464 WRITE_ONCE(queue->dql.stall_max, 0);
1468 static struct netdev_queue_attribute bql_stall_max_attribute __ro_after_init =
1469 __ATTR(stall_max, 0644, bql_show_stall_max, bql_set_stall_max);
1471 static ssize_t bql_show_stall_cnt(struct netdev_queue *queue, char *buf)
1473 struct dql *dql = &queue->dql;
1475 return sysfs_emit(buf, "%lu\n", dql->stall_cnt);
1478 static struct netdev_queue_attribute bql_stall_cnt_attribute __ro_after_init =
1479 __ATTR(stall_cnt, 0444, bql_show_stall_cnt, NULL);
1481 static ssize_t bql_show_inflight(struct netdev_queue *queue,
1484 struct dql *dql = &queue->dql;
1486 return sysfs_emit(buf, "%u\n", dql->num_queued - dql->num_completed);
1489 static struct netdev_queue_attribute bql_inflight_attribute __ro_after_init =
1490 __ATTR(inflight, 0444, bql_show_inflight, NULL);
1492 #define BQL_ATTR(NAME, FIELD) \
1493 static ssize_t bql_show_ ## NAME(struct netdev_queue *queue, \
1496 return bql_show(buf, queue->dql.FIELD); \
1499 static ssize_t bql_set_ ## NAME(struct netdev_queue *queue, \
1500 const char *buf, size_t len) \
1502 return bql_set(buf, len, &queue->dql.FIELD); \
1505 static struct netdev_queue_attribute bql_ ## NAME ## _attribute __ro_after_init \
1506 = __ATTR(NAME, 0644, \
1507 bql_show_ ## NAME, bql_set_ ## NAME)
1509 BQL_ATTR(limit, limit);
1510 BQL_ATTR(limit_max, max_limit);
1511 BQL_ATTR(limit_min, min_limit);
1513 static struct attribute *dql_attrs[] __ro_after_init = {
1514 &bql_limit_attribute.attr,
1515 &bql_limit_max_attribute.attr,
1516 &bql_limit_min_attribute.attr,
1517 &bql_hold_time_attribute.attr,
1518 &bql_inflight_attribute.attr,
1519 &bql_stall_thrs_attribute.attr,
1520 &bql_stall_cnt_attribute.attr,
1521 &bql_stall_max_attribute.attr,
1525 static const struct attribute_group dql_group = {
1526 .name = "byte_queue_limits",
1530 /* Fake declaration, all the code using it should be dead */
1531 static const struct attribute_group dql_group = {};
1532 #endif /* CONFIG_BQL */
1535 static ssize_t xps_queue_show(struct net_device *dev, unsigned int index,
1536 int tc, char *buf, enum xps_map_type type)
1538 struct xps_dev_maps *dev_maps;
1539 unsigned long *mask;
1540 unsigned int nr_ids;
1544 dev_maps = rcu_dereference(dev->xps_maps[type]);
1546 /* Default to nr_cpu_ids/dev->num_rx_queues and do not just return 0
1547 * when dev_maps hasn't been allocated yet, to be backward compatible.
1549 nr_ids = dev_maps ? dev_maps->nr_ids :
1550 (type == XPS_CPUS ? nr_cpu_ids : dev->num_rx_queues);
1552 mask = bitmap_zalloc(nr_ids, GFP_NOWAIT);
1558 if (!dev_maps || tc >= dev_maps->num_tc)
1561 for (j = 0; j < nr_ids; j++) {
1562 int i, tci = j * dev_maps->num_tc + tc;
1563 struct xps_map *map;
1565 map = rcu_dereference(dev_maps->attr_map[tci]);
1569 for (i = map->len; i--;) {
1570 if (map->queues[i] == index) {
1579 len = bitmap_print_to_pagebuf(false, buf, mask, nr_ids);
1582 return len < PAGE_SIZE ? len : -EINVAL;
1585 static ssize_t xps_cpus_show(struct netdev_queue *queue, char *buf)
1587 struct net_device *dev = queue->dev;
1591 if (!netif_is_multiqueue(dev))
1594 index = get_netdev_queue_index(queue);
1596 if (!rtnl_trylock())
1597 return restart_syscall();
1599 /* If queue belongs to subordinate dev use its map */
1600 dev = netdev_get_tx_queue(dev, index)->sb_dev ? : dev;
1602 tc = netdev_txq_to_tc(dev, index);
1608 /* Make sure the subordinate device can't be freed */
1609 get_device(&dev->dev);
1612 len = xps_queue_show(dev, index, tc, buf, XPS_CPUS);
1614 put_device(&dev->dev);
1618 static ssize_t xps_cpus_store(struct netdev_queue *queue,
1619 const char *buf, size_t len)
1621 struct net_device *dev = queue->dev;
1626 if (!netif_is_multiqueue(dev))
1629 if (!capable(CAP_NET_ADMIN))
1632 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
1635 index = get_netdev_queue_index(queue);
1637 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
1639 free_cpumask_var(mask);
1643 if (!rtnl_trylock()) {
1644 free_cpumask_var(mask);
1645 return restart_syscall();
1648 err = netif_set_xps_queue(dev, mask, index);
1651 free_cpumask_var(mask);
1656 static struct netdev_queue_attribute xps_cpus_attribute __ro_after_init
1657 = __ATTR_RW(xps_cpus);
1659 static ssize_t xps_rxqs_show(struct netdev_queue *queue, char *buf)
1661 struct net_device *dev = queue->dev;
1665 index = get_netdev_queue_index(queue);
1667 if (!rtnl_trylock())
1668 return restart_syscall();
1670 tc = netdev_txq_to_tc(dev, index);
1675 return xps_queue_show(dev, index, tc, buf, XPS_RXQS);
1678 static ssize_t xps_rxqs_store(struct netdev_queue *queue, const char *buf,
1681 struct net_device *dev = queue->dev;
1682 struct net *net = dev_net(dev);
1683 unsigned long *mask;
1687 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
1690 mask = bitmap_zalloc(dev->num_rx_queues, GFP_KERNEL);
1694 index = get_netdev_queue_index(queue);
1696 err = bitmap_parse(buf, len, mask, dev->num_rx_queues);
1702 if (!rtnl_trylock()) {
1704 return restart_syscall();
1708 err = __netif_set_xps_queue(dev, mask, index, XPS_RXQS);
1717 static struct netdev_queue_attribute xps_rxqs_attribute __ro_after_init
1718 = __ATTR_RW(xps_rxqs);
1719 #endif /* CONFIG_XPS */
1721 static struct attribute *netdev_queue_default_attrs[] __ro_after_init = {
1722 &queue_trans_timeout.attr,
1723 &queue_traffic_class.attr,
1725 &xps_cpus_attribute.attr,
1726 &xps_rxqs_attribute.attr,
1727 &queue_tx_maxrate.attr,
1731 ATTRIBUTE_GROUPS(netdev_queue_default);
1733 static void netdev_queue_release(struct kobject *kobj)
1735 struct netdev_queue *queue = to_netdev_queue(kobj);
1737 memset(kobj, 0, sizeof(*kobj));
1738 netdev_put(queue->dev, &queue->dev_tracker);
1741 static const void *netdev_queue_namespace(const struct kobject *kobj)
1743 struct netdev_queue *queue = to_netdev_queue(kobj);
1744 struct device *dev = &queue->dev->dev;
1745 const void *ns = NULL;
1747 if (dev->class && dev->class->namespace)
1748 ns = dev->class->namespace(dev);
1753 static void netdev_queue_get_ownership(const struct kobject *kobj,
1754 kuid_t *uid, kgid_t *gid)
1756 const struct net *net = netdev_queue_namespace(kobj);
1758 net_ns_get_ownership(net, uid, gid);
1761 static const struct kobj_type netdev_queue_ktype = {
1762 .sysfs_ops = &netdev_queue_sysfs_ops,
1763 .release = netdev_queue_release,
1764 .default_groups = netdev_queue_default_groups,
1765 .namespace = netdev_queue_namespace,
1766 .get_ownership = netdev_queue_get_ownership,
1769 static bool netdev_uses_bql(const struct net_device *dev)
1771 if (dev->lltx || (dev->priv_flags & IFF_NO_QUEUE))
1774 return IS_ENABLED(CONFIG_BQL);
1777 static int netdev_queue_add_kobject(struct net_device *dev, int index)
1779 struct netdev_queue *queue = dev->_tx + index;
1780 struct kobject *kobj = &queue->kobj;
1783 /* Kobject_put later will trigger netdev_queue_release call
1784 * which decreases dev refcount: Take that reference here
1786 netdev_hold(queue->dev, &queue->dev_tracker, GFP_KERNEL);
1788 kobj->kset = dev->queues_kset;
1789 error = kobject_init_and_add(kobj, &netdev_queue_ktype, NULL,
1794 if (netdev_uses_bql(dev)) {
1795 error = sysfs_create_group(kobj, &dql_group);
1800 kobject_uevent(kobj, KOBJ_ADD);
1808 static int tx_queue_change_owner(struct net_device *ndev, int index,
1809 kuid_t kuid, kgid_t kgid)
1811 struct netdev_queue *queue = ndev->_tx + index;
1812 struct kobject *kobj = &queue->kobj;
1815 error = sysfs_change_owner(kobj, kuid, kgid);
1819 if (netdev_uses_bql(ndev))
1820 error = sysfs_group_change_owner(kobj, &dql_group, kuid, kgid);
1824 #endif /* CONFIG_SYSFS */
1827 netdev_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
1833 /* Tx queue kobjects are allowed to be updated when a device is being
1834 * unregistered, but solely to remove queues from qdiscs. Any path
1835 * adding queues should be fixed.
1837 WARN(dev->reg_state == NETREG_UNREGISTERING && new_num > old_num,
1838 "New queues can't be registered after device unregistration.");
1840 for (i = old_num; i < new_num; i++) {
1841 error = netdev_queue_add_kobject(dev, i);
1848 while (--i >= new_num) {
1849 struct netdev_queue *queue = dev->_tx + i;
1851 if (!refcount_read(&dev_net(dev)->ns.count))
1852 queue->kobj.uevent_suppress = 1;
1854 if (netdev_uses_bql(dev))
1855 sysfs_remove_group(&queue->kobj, &dql_group);
1857 kobject_put(&queue->kobj);
1863 #endif /* CONFIG_SYSFS */
1866 static int net_tx_queue_change_owner(struct net_device *dev, int num,
1867 kuid_t kuid, kgid_t kgid)
1873 for (i = 0; i < num; i++) {
1874 error = tx_queue_change_owner(dev, i, kuid, kgid);
1882 #endif /* CONFIG_SYSFS */
1885 static int register_queue_kobjects(struct net_device *dev)
1887 int error = 0, txq = 0, rxq = 0, real_rx = 0, real_tx = 0;
1890 dev->queues_kset = kset_create_and_add("queues",
1891 NULL, &dev->dev.kobj);
1892 if (!dev->queues_kset)
1894 real_rx = dev->real_num_rx_queues;
1896 real_tx = dev->real_num_tx_queues;
1898 error = net_rx_queue_update_kobjects(dev, 0, real_rx);
1903 error = netdev_queue_update_kobjects(dev, 0, real_tx);
1911 netdev_queue_update_kobjects(dev, txq, 0);
1912 net_rx_queue_update_kobjects(dev, rxq, 0);
1914 kset_unregister(dev->queues_kset);
1919 static int queue_change_owner(struct net_device *ndev, kuid_t kuid, kgid_t kgid)
1921 int error = 0, real_rx = 0, real_tx = 0;
1924 if (ndev->queues_kset) {
1925 error = sysfs_change_owner(&ndev->queues_kset->kobj, kuid, kgid);
1929 real_rx = ndev->real_num_rx_queues;
1931 real_tx = ndev->real_num_tx_queues;
1933 error = net_rx_queue_change_owner(ndev, real_rx, kuid, kgid);
1937 error = net_tx_queue_change_owner(ndev, real_tx, kuid, kgid);
1944 static void remove_queue_kobjects(struct net_device *dev)
1946 int real_rx = 0, real_tx = 0;
1949 real_rx = dev->real_num_rx_queues;
1951 real_tx = dev->real_num_tx_queues;
1953 net_rx_queue_update_kobjects(dev, real_rx, 0);
1954 netdev_queue_update_kobjects(dev, real_tx, 0);
1956 dev->real_num_rx_queues = 0;
1957 dev->real_num_tx_queues = 0;
1959 kset_unregister(dev->queues_kset);
1963 static bool net_current_may_mount(void)
1965 struct net *net = current->nsproxy->net_ns;
1967 return ns_capable(net->user_ns, CAP_SYS_ADMIN);
1970 static void *net_grab_current_ns(void)
1972 struct net *ns = current->nsproxy->net_ns;
1973 #ifdef CONFIG_NET_NS
1975 refcount_inc(&ns->passive);
1980 static const void *net_initial_ns(void)
1985 static const void *net_netlink_ns(struct sock *sk)
1987 return sock_net(sk);
1990 const struct kobj_ns_type_operations net_ns_type_operations = {
1991 .type = KOBJ_NS_TYPE_NET,
1992 .current_may_mount = net_current_may_mount,
1993 .grab_current_ns = net_grab_current_ns,
1994 .netlink_ns = net_netlink_ns,
1995 .initial_ns = net_initial_ns,
1996 .drop_ns = net_drop_ns,
1998 EXPORT_SYMBOL_GPL(net_ns_type_operations);
2000 static int netdev_uevent(const struct device *d, struct kobj_uevent_env *env)
2002 const struct net_device *dev = to_net_dev(d);
2005 /* pass interface to uevent. */
2006 retval = add_uevent_var(env, "INTERFACE=%s", dev->name);
2010 /* pass ifindex to uevent.
2011 * ifindex is useful as it won't change (interface name may change)
2012 * and is what RtNetlink uses natively.
2014 retval = add_uevent_var(env, "IFINDEX=%d", dev->ifindex);
2021 * netdev_release -- destroy and free a dead device.
2022 * Called when last reference to device kobject is gone.
2024 static void netdev_release(struct device *d)
2026 struct net_device *dev = to_net_dev(d);
2028 BUG_ON(dev->reg_state != NETREG_RELEASED);
2030 /* no need to wait for rcu grace period:
2031 * device is dead and about to be freed.
2033 kfree(rcu_access_pointer(dev->ifalias));
2037 static const void *net_namespace(const struct device *d)
2039 const struct net_device *dev = to_net_dev(d);
2041 return dev_net(dev);
2044 static void net_get_ownership(const struct device *d, kuid_t *uid, kgid_t *gid)
2046 const struct net_device *dev = to_net_dev(d);
2047 const struct net *net = dev_net(dev);
2049 net_ns_get_ownership(net, uid, gid);
2052 static const struct class net_class = {
2054 .dev_release = netdev_release,
2055 .dev_groups = net_class_groups,
2056 .dev_uevent = netdev_uevent,
2057 .ns_type = &net_ns_type_operations,
2058 .namespace = net_namespace,
2059 .get_ownership = net_get_ownership,
2063 static int of_dev_node_match(struct device *dev, const void *data)
2065 for (; dev; dev = dev->parent) {
2066 if (dev->of_node == data)
2074 * of_find_net_device_by_node - lookup the net device for the device node
2075 * @np: OF device node
2077 * Looks up the net_device structure corresponding with the device node.
2078 * If successful, returns a pointer to the net_device with the embedded
2079 * struct device refcount incremented by one, or NULL on failure. The
2080 * refcount must be dropped when done with the net_device.
2082 struct net_device *of_find_net_device_by_node(struct device_node *np)
2086 dev = class_find_device(&net_class, NULL, np, of_dev_node_match);
2090 return to_net_dev(dev);
2092 EXPORT_SYMBOL(of_find_net_device_by_node);
2095 /* Delete sysfs entries but hold kobject reference until after all
2096 * netdev references are gone.
2098 void netdev_unregister_kobject(struct net_device *ndev)
2100 struct device *dev = &ndev->dev;
2102 if (!refcount_read(&dev_net(ndev)->ns.count))
2103 dev_set_uevent_suppress(dev, 1);
2105 kobject_get(&dev->kobj);
2107 remove_queue_kobjects(ndev);
2109 pm_runtime_set_memalloc_noio(dev, false);
2114 /* Create sysfs entries for network device. */
2115 int netdev_register_kobject(struct net_device *ndev)
2117 struct device *dev = &ndev->dev;
2118 const struct attribute_group **groups = ndev->sysfs_groups;
2121 device_initialize(dev);
2122 dev->class = &net_class;
2123 dev->platform_data = ndev;
2124 dev->groups = groups;
2126 dev_set_name(dev, "%s", ndev->name);
2129 /* Allow for a device specific group */
2133 *groups++ = &netstat_group;
2135 if (wireless_group_needed(ndev))
2136 *groups++ = &wireless_group;
2137 #endif /* CONFIG_SYSFS */
2139 error = device_add(dev);
2143 error = register_queue_kobjects(ndev);
2149 pm_runtime_set_memalloc_noio(dev, true);
2154 /* Change owner for sysfs entries when moving network devices across network
2155 * namespaces owned by different user namespaces.
2157 int netdev_change_owner(struct net_device *ndev, const struct net *net_old,
2158 const struct net *net_new)
2160 kuid_t old_uid = GLOBAL_ROOT_UID, new_uid = GLOBAL_ROOT_UID;
2161 kgid_t old_gid = GLOBAL_ROOT_GID, new_gid = GLOBAL_ROOT_GID;
2162 struct device *dev = &ndev->dev;
2165 net_ns_get_ownership(net_old, &old_uid, &old_gid);
2166 net_ns_get_ownership(net_new, &new_uid, &new_gid);
2168 /* The network namespace was changed but the owning user namespace is
2169 * identical so there's no need to change the owner of sysfs entries.
2171 if (uid_eq(old_uid, new_uid) && gid_eq(old_gid, new_gid))
2174 error = device_change_owner(dev, new_uid, new_gid);
2178 error = queue_change_owner(ndev, new_uid, new_gid);
2185 int netdev_class_create_file_ns(const struct class_attribute *class_attr,
2188 return class_create_file_ns(&net_class, class_attr, ns);
2190 EXPORT_SYMBOL(netdev_class_create_file_ns);
2192 void netdev_class_remove_file_ns(const struct class_attribute *class_attr,
2195 class_remove_file_ns(&net_class, class_attr, ns);
2197 EXPORT_SYMBOL(netdev_class_remove_file_ns);
2199 int __init netdev_kobject_init(void)
2201 kobj_ns_type_register(&net_ns_type_operations);
2202 return class_register(&net_class);