2 * net-sysfs.c - network device class and attributes
4 * Copyright (c) 2003 Stephen Hemminger <shemminger@osdl.org>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #include <linux/capability.h>
13 #include <linux/kernel.h>
14 #include <linux/netdevice.h>
15 #include <net/switchdev.h>
16 #include <linux/if_arp.h>
17 #include <linux/slab.h>
18 #include <linux/nsproxy.h>
20 #include <net/net_namespace.h>
21 #include <linux/rtnetlink.h>
22 #include <linux/vmalloc.h>
23 #include <linux/export.h>
24 #include <linux/jiffies.h>
25 #include <linux/pm_runtime.h>
28 #include "net-sysfs.h"
31 static const char fmt_hex[] = "%#x\n";
32 static const char fmt_long_hex[] = "%#lx\n";
33 static const char fmt_dec[] = "%d\n";
34 static const char fmt_udec[] = "%u\n";
35 static const char fmt_ulong[] = "%lu\n";
36 static const char fmt_u64[] = "%llu\n";
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 sprintf(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 if ((ret = (*set)(netdev, new)) == 0)
108 NETDEVICE_SHOW_RO(dev_id, fmt_hex);
109 NETDEVICE_SHOW_RO(dev_port, fmt_dec);
110 NETDEVICE_SHOW_RO(addr_assign_type, fmt_dec);
111 NETDEVICE_SHOW_RO(addr_len, fmt_dec);
112 NETDEVICE_SHOW_RO(iflink, 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 format_name_assign_type(const struct net_device *dev, char *buf)
119 return sprintf(buf, fmt_dec, dev->name_assign_type);
122 static ssize_t name_assign_type_show(struct device *dev,
123 struct device_attribute *attr,
126 struct net_device *ndev = to_net_dev(dev);
127 ssize_t ret = -EINVAL;
129 if (ndev->name_assign_type != NET_NAME_UNKNOWN)
130 ret = netdev_show(dev, attr, buf, format_name_assign_type);
134 static DEVICE_ATTR_RO(name_assign_type);
136 /* use same locking rules as GIFHWADDR ioctl's */
137 static ssize_t address_show(struct device *dev, struct device_attribute *attr,
140 struct net_device *ndev = to_net_dev(dev);
141 ssize_t ret = -EINVAL;
143 read_lock(&dev_base_lock);
144 if (dev_isalive(ndev))
145 ret = sysfs_format_mac(buf, ndev->dev_addr, ndev->addr_len);
146 read_unlock(&dev_base_lock);
149 static DEVICE_ATTR_RO(address);
151 static ssize_t broadcast_show(struct device *dev,
152 struct device_attribute *attr, char *buf)
154 struct net_device *ndev = to_net_dev(dev);
155 if (dev_isalive(ndev))
156 return sysfs_format_mac(buf, ndev->broadcast, ndev->addr_len);
159 static DEVICE_ATTR_RO(broadcast);
161 static int change_carrier(struct net_device *dev, unsigned long new_carrier)
163 if (!netif_running(dev))
165 return dev_change_carrier(dev, (bool) new_carrier);
168 static ssize_t carrier_store(struct device *dev, struct device_attribute *attr,
169 const char *buf, size_t len)
171 return netdev_store(dev, attr, buf, len, change_carrier);
174 static ssize_t carrier_show(struct device *dev,
175 struct device_attribute *attr, char *buf)
177 struct net_device *netdev = to_net_dev(dev);
178 if (netif_running(netdev)) {
179 return sprintf(buf, fmt_dec, !!netif_carrier_ok(netdev));
183 static DEVICE_ATTR_RW(carrier);
185 static ssize_t speed_show(struct device *dev,
186 struct device_attribute *attr, char *buf)
188 struct net_device *netdev = to_net_dev(dev);
192 return restart_syscall();
194 if (netif_running(netdev)) {
195 struct ethtool_cmd cmd;
196 if (!__ethtool_get_settings(netdev, &cmd))
197 ret = sprintf(buf, fmt_udec, ethtool_cmd_speed(&cmd));
202 static DEVICE_ATTR_RO(speed);
204 static ssize_t duplex_show(struct device *dev,
205 struct device_attribute *attr, char *buf)
207 struct net_device *netdev = to_net_dev(dev);
211 return restart_syscall();
213 if (netif_running(netdev)) {
214 struct ethtool_cmd cmd;
215 if (!__ethtool_get_settings(netdev, &cmd)) {
217 switch (cmd.duplex) {
228 ret = sprintf(buf, "%s\n", duplex);
234 static DEVICE_ATTR_RO(duplex);
236 static ssize_t dormant_show(struct device *dev,
237 struct device_attribute *attr, char *buf)
239 struct net_device *netdev = to_net_dev(dev);
241 if (netif_running(netdev))
242 return sprintf(buf, fmt_dec, !!netif_dormant(netdev));
246 static DEVICE_ATTR_RO(dormant);
248 static const char *const operstates[] = {
250 "notpresent", /* currently unused */
253 "testing", /* currently unused */
258 static ssize_t operstate_show(struct device *dev,
259 struct device_attribute *attr, char *buf)
261 const struct net_device *netdev = to_net_dev(dev);
262 unsigned char operstate;
264 read_lock(&dev_base_lock);
265 operstate = netdev->operstate;
266 if (!netif_running(netdev))
267 operstate = IF_OPER_DOWN;
268 read_unlock(&dev_base_lock);
270 if (operstate >= ARRAY_SIZE(operstates))
271 return -EINVAL; /* should not happen */
273 return sprintf(buf, "%s\n", operstates[operstate]);
275 static DEVICE_ATTR_RO(operstate);
277 static ssize_t carrier_changes_show(struct device *dev,
278 struct device_attribute *attr,
281 struct net_device *netdev = to_net_dev(dev);
282 return sprintf(buf, fmt_dec,
283 atomic_read(&netdev->carrier_changes));
285 static DEVICE_ATTR_RO(carrier_changes);
287 /* read-write attributes */
289 static int change_mtu(struct net_device *dev, unsigned long new_mtu)
291 return dev_set_mtu(dev, (int) new_mtu);
294 static ssize_t mtu_store(struct device *dev, struct device_attribute *attr,
295 const char *buf, size_t len)
297 return netdev_store(dev, attr, buf, len, change_mtu);
299 NETDEVICE_SHOW_RW(mtu, fmt_dec);
301 static int change_flags(struct net_device *dev, unsigned long new_flags)
303 return dev_change_flags(dev, (unsigned int) new_flags);
306 static ssize_t flags_store(struct device *dev, struct device_attribute *attr,
307 const char *buf, size_t len)
309 return netdev_store(dev, attr, buf, len, change_flags);
311 NETDEVICE_SHOW_RW(flags, fmt_hex);
313 static int change_tx_queue_len(struct net_device *dev, unsigned long new_len)
315 dev->tx_queue_len = new_len;
319 static ssize_t tx_queue_len_store(struct device *dev,
320 struct device_attribute *attr,
321 const char *buf, size_t len)
323 if (!capable(CAP_NET_ADMIN))
326 return netdev_store(dev, attr, buf, len, change_tx_queue_len);
328 NETDEVICE_SHOW_RW(tx_queue_len, fmt_ulong);
330 static int change_gro_flush_timeout(struct net_device *dev, unsigned long val)
332 dev->gro_flush_timeout = val;
336 static ssize_t gro_flush_timeout_store(struct device *dev,
337 struct device_attribute *attr,
338 const char *buf, size_t len)
340 if (!capable(CAP_NET_ADMIN))
343 return netdev_store(dev, attr, buf, len, change_gro_flush_timeout);
345 NETDEVICE_SHOW_RW(gro_flush_timeout, fmt_ulong);
347 static ssize_t ifalias_store(struct device *dev, struct device_attribute *attr,
348 const char *buf, size_t len)
350 struct net_device *netdev = to_net_dev(dev);
351 struct net *net = dev_net(netdev);
355 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
358 /* ignore trailing newline */
359 if (len > 0 && buf[len - 1] == '\n')
363 return restart_syscall();
364 ret = dev_set_alias(netdev, buf, count);
367 return ret < 0 ? ret : len;
370 static ssize_t ifalias_show(struct device *dev,
371 struct device_attribute *attr, char *buf)
373 const struct net_device *netdev = to_net_dev(dev);
377 return restart_syscall();
379 ret = sprintf(buf, "%s\n", netdev->ifalias);
383 static DEVICE_ATTR_RW(ifalias);
385 static int change_group(struct net_device *dev, unsigned long new_group)
387 dev_set_group(dev, (int) new_group);
391 static ssize_t group_store(struct device *dev, struct device_attribute *attr,
392 const char *buf, size_t len)
394 return netdev_store(dev, attr, buf, len, change_group);
396 NETDEVICE_SHOW(group, fmt_dec);
397 static DEVICE_ATTR(netdev_group, S_IRUGO | S_IWUSR, group_show, group_store);
399 static ssize_t phys_port_id_show(struct device *dev,
400 struct device_attribute *attr, char *buf)
402 struct net_device *netdev = to_net_dev(dev);
403 ssize_t ret = -EINVAL;
406 return restart_syscall();
408 if (dev_isalive(netdev)) {
409 struct netdev_phys_item_id ppid;
411 ret = dev_get_phys_port_id(netdev, &ppid);
413 ret = sprintf(buf, "%*phN\n", ppid.id_len, ppid.id);
419 static DEVICE_ATTR_RO(phys_port_id);
421 static ssize_t phys_port_name_show(struct device *dev,
422 struct device_attribute *attr, char *buf)
424 struct net_device *netdev = to_net_dev(dev);
425 ssize_t ret = -EINVAL;
428 return restart_syscall();
430 if (dev_isalive(netdev)) {
433 ret = dev_get_phys_port_name(netdev, name, sizeof(name));
435 ret = sprintf(buf, "%s\n", name);
441 static DEVICE_ATTR_RO(phys_port_name);
443 static ssize_t phys_switch_id_show(struct device *dev,
444 struct device_attribute *attr, char *buf)
446 struct net_device *netdev = to_net_dev(dev);
447 ssize_t ret = -EINVAL;
450 return restart_syscall();
452 if (dev_isalive(netdev)) {
453 struct netdev_phys_item_id ppid;
455 ret = netdev_switch_parent_id_get(netdev, &ppid);
457 ret = sprintf(buf, "%*phN\n", ppid.id_len, ppid.id);
463 static DEVICE_ATTR_RO(phys_switch_id);
465 static struct attribute *net_class_attrs[] = {
466 &dev_attr_netdev_group.attr,
468 &dev_attr_dev_id.attr,
469 &dev_attr_dev_port.attr,
470 &dev_attr_iflink.attr,
471 &dev_attr_ifindex.attr,
472 &dev_attr_name_assign_type.attr,
473 &dev_attr_addr_assign_type.attr,
474 &dev_attr_addr_len.attr,
475 &dev_attr_link_mode.attr,
476 &dev_attr_address.attr,
477 &dev_attr_broadcast.attr,
478 &dev_attr_speed.attr,
479 &dev_attr_duplex.attr,
480 &dev_attr_dormant.attr,
481 &dev_attr_operstate.attr,
482 &dev_attr_carrier_changes.attr,
483 &dev_attr_ifalias.attr,
484 &dev_attr_carrier.attr,
486 &dev_attr_flags.attr,
487 &dev_attr_tx_queue_len.attr,
488 &dev_attr_gro_flush_timeout.attr,
489 &dev_attr_phys_port_id.attr,
490 &dev_attr_phys_port_name.attr,
491 &dev_attr_phys_switch_id.attr,
494 ATTRIBUTE_GROUPS(net_class);
496 /* Show a given an attribute in the statistics group */
497 static ssize_t netstat_show(const struct device *d,
498 struct device_attribute *attr, char *buf,
499 unsigned long offset)
501 struct net_device *dev = to_net_dev(d);
502 ssize_t ret = -EINVAL;
504 WARN_ON(offset > sizeof(struct rtnl_link_stats64) ||
505 offset % sizeof(u64) != 0);
507 read_lock(&dev_base_lock);
508 if (dev_isalive(dev)) {
509 struct rtnl_link_stats64 temp;
510 const struct rtnl_link_stats64 *stats = dev_get_stats(dev, &temp);
512 ret = sprintf(buf, fmt_u64, *(u64 *)(((u8 *) stats) + offset));
514 read_unlock(&dev_base_lock);
518 /* generate a read-only statistics attribute */
519 #define NETSTAT_ENTRY(name) \
520 static ssize_t name##_show(struct device *d, \
521 struct device_attribute *attr, char *buf) \
523 return netstat_show(d, attr, buf, \
524 offsetof(struct rtnl_link_stats64, name)); \
526 static DEVICE_ATTR_RO(name)
528 NETSTAT_ENTRY(rx_packets);
529 NETSTAT_ENTRY(tx_packets);
530 NETSTAT_ENTRY(rx_bytes);
531 NETSTAT_ENTRY(tx_bytes);
532 NETSTAT_ENTRY(rx_errors);
533 NETSTAT_ENTRY(tx_errors);
534 NETSTAT_ENTRY(rx_dropped);
535 NETSTAT_ENTRY(tx_dropped);
536 NETSTAT_ENTRY(multicast);
537 NETSTAT_ENTRY(collisions);
538 NETSTAT_ENTRY(rx_length_errors);
539 NETSTAT_ENTRY(rx_over_errors);
540 NETSTAT_ENTRY(rx_crc_errors);
541 NETSTAT_ENTRY(rx_frame_errors);
542 NETSTAT_ENTRY(rx_fifo_errors);
543 NETSTAT_ENTRY(rx_missed_errors);
544 NETSTAT_ENTRY(tx_aborted_errors);
545 NETSTAT_ENTRY(tx_carrier_errors);
546 NETSTAT_ENTRY(tx_fifo_errors);
547 NETSTAT_ENTRY(tx_heartbeat_errors);
548 NETSTAT_ENTRY(tx_window_errors);
549 NETSTAT_ENTRY(rx_compressed);
550 NETSTAT_ENTRY(tx_compressed);
552 static struct attribute *netstat_attrs[] = {
553 &dev_attr_rx_packets.attr,
554 &dev_attr_tx_packets.attr,
555 &dev_attr_rx_bytes.attr,
556 &dev_attr_tx_bytes.attr,
557 &dev_attr_rx_errors.attr,
558 &dev_attr_tx_errors.attr,
559 &dev_attr_rx_dropped.attr,
560 &dev_attr_tx_dropped.attr,
561 &dev_attr_multicast.attr,
562 &dev_attr_collisions.attr,
563 &dev_attr_rx_length_errors.attr,
564 &dev_attr_rx_over_errors.attr,
565 &dev_attr_rx_crc_errors.attr,
566 &dev_attr_rx_frame_errors.attr,
567 &dev_attr_rx_fifo_errors.attr,
568 &dev_attr_rx_missed_errors.attr,
569 &dev_attr_tx_aborted_errors.attr,
570 &dev_attr_tx_carrier_errors.attr,
571 &dev_attr_tx_fifo_errors.attr,
572 &dev_attr_tx_heartbeat_errors.attr,
573 &dev_attr_tx_window_errors.attr,
574 &dev_attr_rx_compressed.attr,
575 &dev_attr_tx_compressed.attr,
580 static struct attribute_group netstat_group = {
581 .name = "statistics",
582 .attrs = netstat_attrs,
585 #if IS_ENABLED(CONFIG_WIRELESS_EXT) || IS_ENABLED(CONFIG_CFG80211)
586 static struct attribute *wireless_attrs[] = {
590 static struct attribute_group wireless_group = {
592 .attrs = wireless_attrs,
596 #else /* CONFIG_SYSFS */
597 #define net_class_groups NULL
598 #endif /* CONFIG_SYSFS */
601 #define to_rx_queue_attr(_attr) container_of(_attr, \
602 struct rx_queue_attribute, attr)
604 #define to_rx_queue(obj) container_of(obj, struct netdev_rx_queue, kobj)
606 static ssize_t rx_queue_attr_show(struct kobject *kobj, struct attribute *attr,
609 struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
610 struct netdev_rx_queue *queue = to_rx_queue(kobj);
612 if (!attribute->show)
615 return attribute->show(queue, attribute, buf);
618 static ssize_t rx_queue_attr_store(struct kobject *kobj, struct attribute *attr,
619 const char *buf, size_t count)
621 struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
622 struct netdev_rx_queue *queue = to_rx_queue(kobj);
624 if (!attribute->store)
627 return attribute->store(queue, attribute, buf, count);
630 static const struct sysfs_ops rx_queue_sysfs_ops = {
631 .show = rx_queue_attr_show,
632 .store = rx_queue_attr_store,
636 static ssize_t show_rps_map(struct netdev_rx_queue *queue,
637 struct rx_queue_attribute *attribute, char *buf)
643 if (!zalloc_cpumask_var(&mask, GFP_KERNEL))
647 map = rcu_dereference(queue->rps_map);
649 for (i = 0; i < map->len; i++)
650 cpumask_set_cpu(map->cpus[i], mask);
652 len = snprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
654 free_cpumask_var(mask);
656 return len < PAGE_SIZE ? len : -EINVAL;
659 static ssize_t store_rps_map(struct netdev_rx_queue *queue,
660 struct rx_queue_attribute *attribute,
661 const char *buf, size_t len)
663 struct rps_map *old_map, *map;
666 static DEFINE_SPINLOCK(rps_map_lock);
668 if (!capable(CAP_NET_ADMIN))
671 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
674 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
676 free_cpumask_var(mask);
680 map = kzalloc(max_t(unsigned int,
681 RPS_MAP_SIZE(cpumask_weight(mask)), L1_CACHE_BYTES),
684 free_cpumask_var(mask);
689 for_each_cpu_and(cpu, mask, cpu_online_mask)
690 map->cpus[i++] = cpu;
699 spin_lock(&rps_map_lock);
700 old_map = rcu_dereference_protected(queue->rps_map,
701 lockdep_is_held(&rps_map_lock));
702 rcu_assign_pointer(queue->rps_map, map);
703 spin_unlock(&rps_map_lock);
706 static_key_slow_inc(&rps_needed);
708 kfree_rcu(old_map, rcu);
709 static_key_slow_dec(&rps_needed);
711 free_cpumask_var(mask);
715 static ssize_t show_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
716 struct rx_queue_attribute *attr,
719 struct rps_dev_flow_table *flow_table;
720 unsigned long val = 0;
723 flow_table = rcu_dereference(queue->rps_flow_table);
725 val = (unsigned long)flow_table->mask + 1;
728 return sprintf(buf, "%lu\n", val);
731 static void rps_dev_flow_table_release(struct rcu_head *rcu)
733 struct rps_dev_flow_table *table = container_of(rcu,
734 struct rps_dev_flow_table, rcu);
738 static ssize_t store_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
739 struct rx_queue_attribute *attr,
740 const char *buf, size_t len)
742 unsigned long mask, count;
743 struct rps_dev_flow_table *table, *old_table;
744 static DEFINE_SPINLOCK(rps_dev_flow_lock);
747 if (!capable(CAP_NET_ADMIN))
750 rc = kstrtoul(buf, 0, &count);
756 /* mask = roundup_pow_of_two(count) - 1;
757 * without overflows...
759 while ((mask | (mask >> 1)) != mask)
761 /* On 64 bit arches, must check mask fits in table->mask (u32),
762 * and on 32bit arches, must check
763 * RPS_DEV_FLOW_TABLE_SIZE(mask + 1) doesn't overflow.
765 #if BITS_PER_LONG > 32
766 if (mask > (unsigned long)(u32)mask)
769 if (mask > (ULONG_MAX - RPS_DEV_FLOW_TABLE_SIZE(1))
770 / sizeof(struct rps_dev_flow)) {
771 /* Enforce a limit to prevent overflow */
775 table = vmalloc(RPS_DEV_FLOW_TABLE_SIZE(mask + 1));
780 for (count = 0; count <= mask; count++)
781 table->flows[count].cpu = RPS_NO_CPU;
785 spin_lock(&rps_dev_flow_lock);
786 old_table = rcu_dereference_protected(queue->rps_flow_table,
787 lockdep_is_held(&rps_dev_flow_lock));
788 rcu_assign_pointer(queue->rps_flow_table, table);
789 spin_unlock(&rps_dev_flow_lock);
792 call_rcu(&old_table->rcu, rps_dev_flow_table_release);
797 static struct rx_queue_attribute rps_cpus_attribute =
798 __ATTR(rps_cpus, S_IRUGO | S_IWUSR, show_rps_map, store_rps_map);
801 static struct rx_queue_attribute rps_dev_flow_table_cnt_attribute =
802 __ATTR(rps_flow_cnt, S_IRUGO | S_IWUSR,
803 show_rps_dev_flow_table_cnt, store_rps_dev_flow_table_cnt);
804 #endif /* CONFIG_RPS */
806 static struct attribute *rx_queue_default_attrs[] = {
808 &rps_cpus_attribute.attr,
809 &rps_dev_flow_table_cnt_attribute.attr,
814 static void rx_queue_release(struct kobject *kobj)
816 struct netdev_rx_queue *queue = to_rx_queue(kobj);
819 struct rps_dev_flow_table *flow_table;
822 map = rcu_dereference_protected(queue->rps_map, 1);
824 RCU_INIT_POINTER(queue->rps_map, NULL);
828 flow_table = rcu_dereference_protected(queue->rps_flow_table, 1);
830 RCU_INIT_POINTER(queue->rps_flow_table, NULL);
831 call_rcu(&flow_table->rcu, rps_dev_flow_table_release);
835 memset(kobj, 0, sizeof(*kobj));
839 static const void *rx_queue_namespace(struct kobject *kobj)
841 struct netdev_rx_queue *queue = to_rx_queue(kobj);
842 struct device *dev = &queue->dev->dev;
843 const void *ns = NULL;
845 if (dev->class && dev->class->ns_type)
846 ns = dev->class->namespace(dev);
851 static struct kobj_type rx_queue_ktype = {
852 .sysfs_ops = &rx_queue_sysfs_ops,
853 .release = rx_queue_release,
854 .default_attrs = rx_queue_default_attrs,
855 .namespace = rx_queue_namespace
858 static int rx_queue_add_kobject(struct net_device *dev, int index)
860 struct netdev_rx_queue *queue = dev->_rx + index;
861 struct kobject *kobj = &queue->kobj;
864 kobj->kset = dev->queues_kset;
865 error = kobject_init_and_add(kobj, &rx_queue_ktype, NULL,
870 if (dev->sysfs_rx_queue_group) {
871 error = sysfs_create_group(kobj, dev->sysfs_rx_queue_group);
876 kobject_uevent(kobj, KOBJ_ADD);
877 dev_hold(queue->dev);
884 #endif /* CONFIG_SYSFS */
887 net_rx_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
894 if (!dev->sysfs_rx_queue_group)
897 for (i = old_num; i < new_num; i++) {
898 error = rx_queue_add_kobject(dev, i);
905 while (--i >= new_num) {
906 if (dev->sysfs_rx_queue_group)
907 sysfs_remove_group(&dev->_rx[i].kobj,
908 dev->sysfs_rx_queue_group);
909 kobject_put(&dev->_rx[i].kobj);
920 * netdev_queue sysfs structures and functions.
922 struct netdev_queue_attribute {
923 struct attribute attr;
924 ssize_t (*show)(struct netdev_queue *queue,
925 struct netdev_queue_attribute *attr, char *buf);
926 ssize_t (*store)(struct netdev_queue *queue,
927 struct netdev_queue_attribute *attr, const char *buf, size_t len);
929 #define to_netdev_queue_attr(_attr) container_of(_attr, \
930 struct netdev_queue_attribute, attr)
932 #define to_netdev_queue(obj) container_of(obj, struct netdev_queue, kobj)
934 static ssize_t netdev_queue_attr_show(struct kobject *kobj,
935 struct attribute *attr, char *buf)
937 struct netdev_queue_attribute *attribute = to_netdev_queue_attr(attr);
938 struct netdev_queue *queue = to_netdev_queue(kobj);
940 if (!attribute->show)
943 return attribute->show(queue, attribute, buf);
946 static ssize_t netdev_queue_attr_store(struct kobject *kobj,
947 struct attribute *attr,
948 const char *buf, size_t count)
950 struct netdev_queue_attribute *attribute = to_netdev_queue_attr(attr);
951 struct netdev_queue *queue = to_netdev_queue(kobj);
953 if (!attribute->store)
956 return attribute->store(queue, attribute, buf, count);
959 static const struct sysfs_ops netdev_queue_sysfs_ops = {
960 .show = netdev_queue_attr_show,
961 .store = netdev_queue_attr_store,
964 static ssize_t show_trans_timeout(struct netdev_queue *queue,
965 struct netdev_queue_attribute *attribute,
968 unsigned long trans_timeout;
970 spin_lock_irq(&queue->_xmit_lock);
971 trans_timeout = queue->trans_timeout;
972 spin_unlock_irq(&queue->_xmit_lock);
974 return sprintf(buf, "%lu", trans_timeout);
978 static inline unsigned int get_netdev_queue_index(struct netdev_queue *queue)
980 struct net_device *dev = queue->dev;
983 for (i = 0; i < dev->num_tx_queues; i++)
984 if (queue == &dev->_tx[i])
987 BUG_ON(i >= dev->num_tx_queues);
992 static ssize_t show_tx_maxrate(struct netdev_queue *queue,
993 struct netdev_queue_attribute *attribute,
996 return sprintf(buf, "%lu\n", queue->tx_maxrate);
999 static ssize_t set_tx_maxrate(struct netdev_queue *queue,
1000 struct netdev_queue_attribute *attribute,
1001 const char *buf, size_t len)
1003 struct net_device *dev = queue->dev;
1004 int err, index = get_netdev_queue_index(queue);
1007 err = kstrtou32(buf, 10, &rate);
1011 if (!rtnl_trylock())
1012 return restart_syscall();
1015 if (dev->netdev_ops->ndo_set_tx_maxrate)
1016 err = dev->netdev_ops->ndo_set_tx_maxrate(dev, index, rate);
1020 queue->tx_maxrate = rate;
1026 static struct netdev_queue_attribute queue_tx_maxrate =
1027 __ATTR(tx_maxrate, S_IRUGO | S_IWUSR,
1028 show_tx_maxrate, set_tx_maxrate);
1031 static struct netdev_queue_attribute queue_trans_timeout =
1032 __ATTR(tx_timeout, S_IRUGO, show_trans_timeout, NULL);
1036 * Byte queue limits sysfs structures and functions.
1038 static ssize_t bql_show(char *buf, unsigned int value)
1040 return sprintf(buf, "%u\n", value);
1043 static ssize_t bql_set(const char *buf, const size_t count,
1044 unsigned int *pvalue)
1049 if (!strcmp(buf, "max") || !strcmp(buf, "max\n"))
1050 value = DQL_MAX_LIMIT;
1052 err = kstrtouint(buf, 10, &value);
1055 if (value > DQL_MAX_LIMIT)
1064 static ssize_t bql_show_hold_time(struct netdev_queue *queue,
1065 struct netdev_queue_attribute *attr,
1068 struct dql *dql = &queue->dql;
1070 return sprintf(buf, "%u\n", jiffies_to_msecs(dql->slack_hold_time));
1073 static ssize_t bql_set_hold_time(struct netdev_queue *queue,
1074 struct netdev_queue_attribute *attribute,
1075 const char *buf, size_t len)
1077 struct dql *dql = &queue->dql;
1081 err = kstrtouint(buf, 10, &value);
1085 dql->slack_hold_time = msecs_to_jiffies(value);
1090 static struct netdev_queue_attribute bql_hold_time_attribute =
1091 __ATTR(hold_time, S_IRUGO | S_IWUSR, bql_show_hold_time,
1094 static ssize_t bql_show_inflight(struct netdev_queue *queue,
1095 struct netdev_queue_attribute *attr,
1098 struct dql *dql = &queue->dql;
1100 return sprintf(buf, "%u\n", dql->num_queued - dql->num_completed);
1103 static struct netdev_queue_attribute bql_inflight_attribute =
1104 __ATTR(inflight, S_IRUGO, bql_show_inflight, NULL);
1106 #define BQL_ATTR(NAME, FIELD) \
1107 static ssize_t bql_show_ ## NAME(struct netdev_queue *queue, \
1108 struct netdev_queue_attribute *attr, \
1111 return bql_show(buf, queue->dql.FIELD); \
1114 static ssize_t bql_set_ ## NAME(struct netdev_queue *queue, \
1115 struct netdev_queue_attribute *attr, \
1116 const char *buf, size_t len) \
1118 return bql_set(buf, len, &queue->dql.FIELD); \
1121 static struct netdev_queue_attribute bql_ ## NAME ## _attribute = \
1122 __ATTR(NAME, S_IRUGO | S_IWUSR, bql_show_ ## NAME, \
1125 BQL_ATTR(limit, limit)
1126 BQL_ATTR(limit_max, max_limit)
1127 BQL_ATTR(limit_min, min_limit)
1129 static struct attribute *dql_attrs[] = {
1130 &bql_limit_attribute.attr,
1131 &bql_limit_max_attribute.attr,
1132 &bql_limit_min_attribute.attr,
1133 &bql_hold_time_attribute.attr,
1134 &bql_inflight_attribute.attr,
1138 static struct attribute_group dql_group = {
1139 .name = "byte_queue_limits",
1142 #endif /* CONFIG_BQL */
1145 static ssize_t show_xps_map(struct netdev_queue *queue,
1146 struct netdev_queue_attribute *attribute, char *buf)
1148 struct net_device *dev = queue->dev;
1149 struct xps_dev_maps *dev_maps;
1151 unsigned long index;
1154 if (!zalloc_cpumask_var(&mask, GFP_KERNEL))
1157 index = get_netdev_queue_index(queue);
1160 dev_maps = rcu_dereference(dev->xps_maps);
1162 for_each_possible_cpu(i) {
1163 struct xps_map *map =
1164 rcu_dereference(dev_maps->cpu_map[i]);
1167 for (j = 0; j < map->len; j++) {
1168 if (map->queues[j] == index) {
1169 cpumask_set_cpu(i, mask);
1178 len = snprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
1179 free_cpumask_var(mask);
1180 return len < PAGE_SIZE ? len : -EINVAL;
1183 static ssize_t store_xps_map(struct netdev_queue *queue,
1184 struct netdev_queue_attribute *attribute,
1185 const char *buf, size_t len)
1187 struct net_device *dev = queue->dev;
1188 unsigned long index;
1192 if (!capable(CAP_NET_ADMIN))
1195 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
1198 index = get_netdev_queue_index(queue);
1200 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
1202 free_cpumask_var(mask);
1206 err = netif_set_xps_queue(dev, mask, index);
1208 free_cpumask_var(mask);
1213 static struct netdev_queue_attribute xps_cpus_attribute =
1214 __ATTR(xps_cpus, S_IRUGO | S_IWUSR, show_xps_map, store_xps_map);
1215 #endif /* CONFIG_XPS */
1217 static struct attribute *netdev_queue_default_attrs[] = {
1218 &queue_trans_timeout.attr,
1220 &xps_cpus_attribute.attr,
1221 &queue_tx_maxrate.attr,
1226 static void netdev_queue_release(struct kobject *kobj)
1228 struct netdev_queue *queue = to_netdev_queue(kobj);
1230 memset(kobj, 0, sizeof(*kobj));
1231 dev_put(queue->dev);
1234 static const void *netdev_queue_namespace(struct kobject *kobj)
1236 struct netdev_queue *queue = to_netdev_queue(kobj);
1237 struct device *dev = &queue->dev->dev;
1238 const void *ns = NULL;
1240 if (dev->class && dev->class->ns_type)
1241 ns = dev->class->namespace(dev);
1246 static struct kobj_type netdev_queue_ktype = {
1247 .sysfs_ops = &netdev_queue_sysfs_ops,
1248 .release = netdev_queue_release,
1249 .default_attrs = netdev_queue_default_attrs,
1250 .namespace = netdev_queue_namespace,
1253 static int netdev_queue_add_kobject(struct net_device *dev, int index)
1255 struct netdev_queue *queue = dev->_tx + index;
1256 struct kobject *kobj = &queue->kobj;
1259 kobj->kset = dev->queues_kset;
1260 error = kobject_init_and_add(kobj, &netdev_queue_ktype, NULL,
1266 error = sysfs_create_group(kobj, &dql_group);
1271 kobject_uevent(kobj, KOBJ_ADD);
1272 dev_hold(queue->dev);
1279 #endif /* CONFIG_SYSFS */
1282 netdev_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
1288 for (i = old_num; i < new_num; i++) {
1289 error = netdev_queue_add_kobject(dev, i);
1296 while (--i >= new_num) {
1297 struct netdev_queue *queue = dev->_tx + i;
1300 sysfs_remove_group(&queue->kobj, &dql_group);
1302 kobject_put(&queue->kobj);
1308 #endif /* CONFIG_SYSFS */
1311 static int register_queue_kobjects(struct net_device *dev)
1313 int error = 0, txq = 0, rxq = 0, real_rx = 0, real_tx = 0;
1316 dev->queues_kset = kset_create_and_add("queues",
1317 NULL, &dev->dev.kobj);
1318 if (!dev->queues_kset)
1320 real_rx = dev->real_num_rx_queues;
1322 real_tx = dev->real_num_tx_queues;
1324 error = net_rx_queue_update_kobjects(dev, 0, real_rx);
1329 error = netdev_queue_update_kobjects(dev, 0, real_tx);
1337 netdev_queue_update_kobjects(dev, txq, 0);
1338 net_rx_queue_update_kobjects(dev, rxq, 0);
1342 static void remove_queue_kobjects(struct net_device *dev)
1344 int real_rx = 0, real_tx = 0;
1347 real_rx = dev->real_num_rx_queues;
1349 real_tx = dev->real_num_tx_queues;
1351 net_rx_queue_update_kobjects(dev, real_rx, 0);
1352 netdev_queue_update_kobjects(dev, real_tx, 0);
1354 kset_unregister(dev->queues_kset);
1358 static bool net_current_may_mount(void)
1360 struct net *net = current->nsproxy->net_ns;
1362 return ns_capable(net->user_ns, CAP_SYS_ADMIN);
1365 static void *net_grab_current_ns(void)
1367 struct net *ns = current->nsproxy->net_ns;
1368 #ifdef CONFIG_NET_NS
1370 atomic_inc(&ns->passive);
1375 static const void *net_initial_ns(void)
1380 static const void *net_netlink_ns(struct sock *sk)
1382 return sock_net(sk);
1385 struct kobj_ns_type_operations net_ns_type_operations = {
1386 .type = KOBJ_NS_TYPE_NET,
1387 .current_may_mount = net_current_may_mount,
1388 .grab_current_ns = net_grab_current_ns,
1389 .netlink_ns = net_netlink_ns,
1390 .initial_ns = net_initial_ns,
1391 .drop_ns = net_drop_ns,
1393 EXPORT_SYMBOL_GPL(net_ns_type_operations);
1395 static int netdev_uevent(struct device *d, struct kobj_uevent_env *env)
1397 struct net_device *dev = to_net_dev(d);
1400 /* pass interface to uevent. */
1401 retval = add_uevent_var(env, "INTERFACE=%s", dev->name);
1405 /* pass ifindex to uevent.
1406 * ifindex is useful as it won't change (interface name may change)
1407 * and is what RtNetlink uses natively. */
1408 retval = add_uevent_var(env, "IFINDEX=%d", dev->ifindex);
1415 * netdev_release -- destroy and free a dead device.
1416 * Called when last reference to device kobject is gone.
1418 static void netdev_release(struct device *d)
1420 struct net_device *dev = to_net_dev(d);
1422 BUG_ON(dev->reg_state != NETREG_RELEASED);
1424 kfree(dev->ifalias);
1425 netdev_freemem(dev);
1428 static const void *net_namespace(struct device *d)
1430 struct net_device *dev;
1431 dev = container_of(d, struct net_device, dev);
1432 return dev_net(dev);
1435 static struct class net_class = {
1437 .dev_release = netdev_release,
1438 .dev_groups = net_class_groups,
1439 .dev_uevent = netdev_uevent,
1440 .ns_type = &net_ns_type_operations,
1441 .namespace = net_namespace,
1444 #ifdef CONFIG_OF_NET
1445 static int of_dev_node_match(struct device *dev, const void *data)
1450 ret = dev->parent->of_node == data;
1452 return ret == 0 ? dev->of_node == data : ret;
1455 struct net_device *of_find_net_device_by_node(struct device_node *np)
1459 dev = class_find_device(&net_class, NULL, np, of_dev_node_match);
1463 return to_net_dev(dev);
1465 EXPORT_SYMBOL(of_find_net_device_by_node);
1468 /* Delete sysfs entries but hold kobject reference until after all
1469 * netdev references are gone.
1471 void netdev_unregister_kobject(struct net_device *ndev)
1473 struct device *dev = &(ndev->dev);
1475 kobject_get(&dev->kobj);
1477 remove_queue_kobjects(ndev);
1479 pm_runtime_set_memalloc_noio(dev, false);
1484 /* Create sysfs entries for network device. */
1485 int netdev_register_kobject(struct net_device *ndev)
1487 struct device *dev = &(ndev->dev);
1488 const struct attribute_group **groups = ndev->sysfs_groups;
1491 device_initialize(dev);
1492 dev->class = &net_class;
1493 dev->platform_data = ndev;
1494 dev->groups = groups;
1496 dev_set_name(dev, "%s", ndev->name);
1499 /* Allow for a device specific group */
1503 *groups++ = &netstat_group;
1505 #if IS_ENABLED(CONFIG_WIRELESS_EXT) || IS_ENABLED(CONFIG_CFG80211)
1506 if (ndev->ieee80211_ptr)
1507 *groups++ = &wireless_group;
1508 #if IS_ENABLED(CONFIG_WIRELESS_EXT)
1509 else if (ndev->wireless_handlers)
1510 *groups++ = &wireless_group;
1513 #endif /* CONFIG_SYSFS */
1515 error = device_add(dev);
1519 error = register_queue_kobjects(ndev);
1525 pm_runtime_set_memalloc_noio(dev, true);
1530 int netdev_class_create_file_ns(struct class_attribute *class_attr,
1533 return class_create_file_ns(&net_class, class_attr, ns);
1535 EXPORT_SYMBOL(netdev_class_create_file_ns);
1537 void netdev_class_remove_file_ns(struct class_attribute *class_attr,
1540 class_remove_file_ns(&net_class, class_attr, ns);
1542 EXPORT_SYMBOL(netdev_class_remove_file_ns);
1544 int __init netdev_kobject_init(void)
1546 kobj_ns_type_register(&net_ns_type_operations);
1547 return class_register(&net_class);