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(ifindex, fmt_dec);
113 NETDEVICE_SHOW_RO(type, fmt_dec);
114 NETDEVICE_SHOW_RO(link_mode, fmt_dec);
116 static ssize_t iflink_show(struct device *dev, struct device_attribute *attr,
119 struct net_device *ndev = to_net_dev(dev);
121 return sprintf(buf, fmt_dec, dev_get_iflink(ndev));
123 static DEVICE_ATTR_RO(iflink);
125 static ssize_t format_name_assign_type(const struct net_device *dev, char *buf)
127 return sprintf(buf, fmt_dec, dev->name_assign_type);
130 static ssize_t name_assign_type_show(struct device *dev,
131 struct device_attribute *attr,
134 struct net_device *ndev = to_net_dev(dev);
135 ssize_t ret = -EINVAL;
137 if (ndev->name_assign_type != NET_NAME_UNKNOWN)
138 ret = netdev_show(dev, attr, buf, format_name_assign_type);
142 static DEVICE_ATTR_RO(name_assign_type);
144 /* use same locking rules as GIFHWADDR ioctl's */
145 static ssize_t address_show(struct device *dev, struct device_attribute *attr,
148 struct net_device *ndev = to_net_dev(dev);
149 ssize_t ret = -EINVAL;
151 read_lock(&dev_base_lock);
152 if (dev_isalive(ndev))
153 ret = sysfs_format_mac(buf, ndev->dev_addr, ndev->addr_len);
154 read_unlock(&dev_base_lock);
157 static DEVICE_ATTR_RO(address);
159 static ssize_t broadcast_show(struct device *dev,
160 struct device_attribute *attr, char *buf)
162 struct net_device *ndev = to_net_dev(dev);
163 if (dev_isalive(ndev))
164 return sysfs_format_mac(buf, ndev->broadcast, ndev->addr_len);
167 static DEVICE_ATTR_RO(broadcast);
169 static int change_carrier(struct net_device *dev, unsigned long new_carrier)
171 if (!netif_running(dev))
173 return dev_change_carrier(dev, (bool) new_carrier);
176 static ssize_t carrier_store(struct device *dev, struct device_attribute *attr,
177 const char *buf, size_t len)
179 return netdev_store(dev, attr, buf, len, change_carrier);
182 static ssize_t carrier_show(struct device *dev,
183 struct device_attribute *attr, char *buf)
185 struct net_device *netdev = to_net_dev(dev);
186 if (netif_running(netdev)) {
187 return sprintf(buf, fmt_dec, !!netif_carrier_ok(netdev));
191 static DEVICE_ATTR_RW(carrier);
193 static ssize_t speed_show(struct device *dev,
194 struct device_attribute *attr, char *buf)
196 struct net_device *netdev = to_net_dev(dev);
200 return restart_syscall();
202 if (netif_running(netdev)) {
203 struct ethtool_cmd cmd;
204 if (!__ethtool_get_settings(netdev, &cmd))
205 ret = sprintf(buf, fmt_udec, ethtool_cmd_speed(&cmd));
210 static DEVICE_ATTR_RO(speed);
212 static ssize_t duplex_show(struct device *dev,
213 struct device_attribute *attr, char *buf)
215 struct net_device *netdev = to_net_dev(dev);
219 return restart_syscall();
221 if (netif_running(netdev)) {
222 struct ethtool_cmd cmd;
223 if (!__ethtool_get_settings(netdev, &cmd)) {
225 switch (cmd.duplex) {
236 ret = sprintf(buf, "%s\n", duplex);
242 static DEVICE_ATTR_RO(duplex);
244 static ssize_t dormant_show(struct device *dev,
245 struct device_attribute *attr, char *buf)
247 struct net_device *netdev = to_net_dev(dev);
249 if (netif_running(netdev))
250 return sprintf(buf, fmt_dec, !!netif_dormant(netdev));
254 static DEVICE_ATTR_RO(dormant);
256 static const char *const operstates[] = {
258 "notpresent", /* currently unused */
261 "testing", /* currently unused */
266 static ssize_t operstate_show(struct device *dev,
267 struct device_attribute *attr, char *buf)
269 const struct net_device *netdev = to_net_dev(dev);
270 unsigned char operstate;
272 read_lock(&dev_base_lock);
273 operstate = netdev->operstate;
274 if (!netif_running(netdev))
275 operstate = IF_OPER_DOWN;
276 read_unlock(&dev_base_lock);
278 if (operstate >= ARRAY_SIZE(operstates))
279 return -EINVAL; /* should not happen */
281 return sprintf(buf, "%s\n", operstates[operstate]);
283 static DEVICE_ATTR_RO(operstate);
285 static ssize_t carrier_changes_show(struct device *dev,
286 struct device_attribute *attr,
289 struct net_device *netdev = to_net_dev(dev);
290 return sprintf(buf, fmt_dec,
291 atomic_read(&netdev->carrier_changes));
293 static DEVICE_ATTR_RO(carrier_changes);
295 /* read-write attributes */
297 static int change_mtu(struct net_device *dev, unsigned long new_mtu)
299 return dev_set_mtu(dev, (int) new_mtu);
302 static ssize_t mtu_store(struct device *dev, struct device_attribute *attr,
303 const char *buf, size_t len)
305 return netdev_store(dev, attr, buf, len, change_mtu);
307 NETDEVICE_SHOW_RW(mtu, fmt_dec);
309 static int change_flags(struct net_device *dev, unsigned long new_flags)
311 return dev_change_flags(dev, (unsigned int) new_flags);
314 static ssize_t flags_store(struct device *dev, struct device_attribute *attr,
315 const char *buf, size_t len)
317 return netdev_store(dev, attr, buf, len, change_flags);
319 NETDEVICE_SHOW_RW(flags, fmt_hex);
321 static int change_tx_queue_len(struct net_device *dev, unsigned long new_len)
323 dev->tx_queue_len = new_len;
327 static ssize_t tx_queue_len_store(struct device *dev,
328 struct device_attribute *attr,
329 const char *buf, size_t len)
331 if (!capable(CAP_NET_ADMIN))
334 return netdev_store(dev, attr, buf, len, change_tx_queue_len);
336 NETDEVICE_SHOW_RW(tx_queue_len, fmt_ulong);
338 static int change_gro_flush_timeout(struct net_device *dev, unsigned long val)
340 dev->gro_flush_timeout = val;
344 static ssize_t gro_flush_timeout_store(struct device *dev,
345 struct device_attribute *attr,
346 const char *buf, size_t len)
348 if (!capable(CAP_NET_ADMIN))
351 return netdev_store(dev, attr, buf, len, change_gro_flush_timeout);
353 NETDEVICE_SHOW_RW(gro_flush_timeout, fmt_ulong);
355 static ssize_t ifalias_store(struct device *dev, struct device_attribute *attr,
356 const char *buf, size_t len)
358 struct net_device *netdev = to_net_dev(dev);
359 struct net *net = dev_net(netdev);
363 if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
366 /* ignore trailing newline */
367 if (len > 0 && buf[len - 1] == '\n')
371 return restart_syscall();
372 ret = dev_set_alias(netdev, buf, count);
375 return ret < 0 ? ret : len;
378 static ssize_t ifalias_show(struct device *dev,
379 struct device_attribute *attr, char *buf)
381 const struct net_device *netdev = to_net_dev(dev);
385 return restart_syscall();
387 ret = sprintf(buf, "%s\n", netdev->ifalias);
391 static DEVICE_ATTR_RW(ifalias);
393 static int change_group(struct net_device *dev, unsigned long new_group)
395 dev_set_group(dev, (int) new_group);
399 static ssize_t group_store(struct device *dev, struct device_attribute *attr,
400 const char *buf, size_t len)
402 return netdev_store(dev, attr, buf, len, change_group);
404 NETDEVICE_SHOW(group, fmt_dec);
405 static DEVICE_ATTR(netdev_group, S_IRUGO | S_IWUSR, group_show, group_store);
407 static int change_proto_down(struct net_device *dev, unsigned long proto_down)
409 return dev_change_proto_down(dev, (bool) proto_down);
412 static ssize_t proto_down_store(struct device *dev,
413 struct device_attribute *attr,
414 const char *buf, size_t len)
416 return netdev_store(dev, attr, buf, len, change_proto_down);
418 NETDEVICE_SHOW_RW(proto_down, fmt_dec);
420 static ssize_t phys_port_id_show(struct device *dev,
421 struct device_attribute *attr, char *buf)
423 struct net_device *netdev = to_net_dev(dev);
424 ssize_t ret = -EINVAL;
427 return restart_syscall();
429 if (dev_isalive(netdev)) {
430 struct netdev_phys_item_id ppid;
432 ret = dev_get_phys_port_id(netdev, &ppid);
434 ret = sprintf(buf, "%*phN\n", ppid.id_len, ppid.id);
440 static DEVICE_ATTR_RO(phys_port_id);
442 static ssize_t phys_port_name_show(struct device *dev,
443 struct device_attribute *attr, char *buf)
445 struct net_device *netdev = to_net_dev(dev);
446 ssize_t ret = -EINVAL;
449 return restart_syscall();
451 if (dev_isalive(netdev)) {
454 ret = dev_get_phys_port_name(netdev, name, sizeof(name));
456 ret = sprintf(buf, "%s\n", name);
462 static DEVICE_ATTR_RO(phys_port_name);
464 static ssize_t phys_switch_id_show(struct device *dev,
465 struct device_attribute *attr, char *buf)
467 struct net_device *netdev = to_net_dev(dev);
468 ssize_t ret = -EINVAL;
471 return restart_syscall();
473 if (dev_isalive(netdev)) {
474 struct switchdev_attr attr = {
475 .id = SWITCHDEV_ATTR_PORT_PARENT_ID,
476 .flags = SWITCHDEV_F_NO_RECURSE,
479 ret = switchdev_port_attr_get(netdev, &attr);
481 ret = sprintf(buf, "%*phN\n", attr.u.ppid.id_len,
488 static DEVICE_ATTR_RO(phys_switch_id);
490 static struct attribute *net_class_attrs[] = {
491 &dev_attr_netdev_group.attr,
493 &dev_attr_dev_id.attr,
494 &dev_attr_dev_port.attr,
495 &dev_attr_iflink.attr,
496 &dev_attr_ifindex.attr,
497 &dev_attr_name_assign_type.attr,
498 &dev_attr_addr_assign_type.attr,
499 &dev_attr_addr_len.attr,
500 &dev_attr_link_mode.attr,
501 &dev_attr_address.attr,
502 &dev_attr_broadcast.attr,
503 &dev_attr_speed.attr,
504 &dev_attr_duplex.attr,
505 &dev_attr_dormant.attr,
506 &dev_attr_operstate.attr,
507 &dev_attr_carrier_changes.attr,
508 &dev_attr_ifalias.attr,
509 &dev_attr_carrier.attr,
511 &dev_attr_flags.attr,
512 &dev_attr_tx_queue_len.attr,
513 &dev_attr_gro_flush_timeout.attr,
514 &dev_attr_phys_port_id.attr,
515 &dev_attr_phys_port_name.attr,
516 &dev_attr_phys_switch_id.attr,
517 &dev_attr_proto_down.attr,
520 ATTRIBUTE_GROUPS(net_class);
522 /* Show a given an attribute in the statistics group */
523 static ssize_t netstat_show(const struct device *d,
524 struct device_attribute *attr, char *buf,
525 unsigned long offset)
527 struct net_device *dev = to_net_dev(d);
528 ssize_t ret = -EINVAL;
530 WARN_ON(offset > sizeof(struct rtnl_link_stats64) ||
531 offset % sizeof(u64) != 0);
533 read_lock(&dev_base_lock);
534 if (dev_isalive(dev)) {
535 struct rtnl_link_stats64 temp;
536 const struct rtnl_link_stats64 *stats = dev_get_stats(dev, &temp);
538 ret = sprintf(buf, fmt_u64, *(u64 *)(((u8 *) stats) + offset));
540 read_unlock(&dev_base_lock);
544 /* generate a read-only statistics attribute */
545 #define NETSTAT_ENTRY(name) \
546 static ssize_t name##_show(struct device *d, \
547 struct device_attribute *attr, char *buf) \
549 return netstat_show(d, attr, buf, \
550 offsetof(struct rtnl_link_stats64, name)); \
552 static DEVICE_ATTR_RO(name)
554 NETSTAT_ENTRY(rx_packets);
555 NETSTAT_ENTRY(tx_packets);
556 NETSTAT_ENTRY(rx_bytes);
557 NETSTAT_ENTRY(tx_bytes);
558 NETSTAT_ENTRY(rx_errors);
559 NETSTAT_ENTRY(tx_errors);
560 NETSTAT_ENTRY(rx_dropped);
561 NETSTAT_ENTRY(tx_dropped);
562 NETSTAT_ENTRY(multicast);
563 NETSTAT_ENTRY(collisions);
564 NETSTAT_ENTRY(rx_length_errors);
565 NETSTAT_ENTRY(rx_over_errors);
566 NETSTAT_ENTRY(rx_crc_errors);
567 NETSTAT_ENTRY(rx_frame_errors);
568 NETSTAT_ENTRY(rx_fifo_errors);
569 NETSTAT_ENTRY(rx_missed_errors);
570 NETSTAT_ENTRY(tx_aborted_errors);
571 NETSTAT_ENTRY(tx_carrier_errors);
572 NETSTAT_ENTRY(tx_fifo_errors);
573 NETSTAT_ENTRY(tx_heartbeat_errors);
574 NETSTAT_ENTRY(tx_window_errors);
575 NETSTAT_ENTRY(rx_compressed);
576 NETSTAT_ENTRY(tx_compressed);
578 static struct attribute *netstat_attrs[] = {
579 &dev_attr_rx_packets.attr,
580 &dev_attr_tx_packets.attr,
581 &dev_attr_rx_bytes.attr,
582 &dev_attr_tx_bytes.attr,
583 &dev_attr_rx_errors.attr,
584 &dev_attr_tx_errors.attr,
585 &dev_attr_rx_dropped.attr,
586 &dev_attr_tx_dropped.attr,
587 &dev_attr_multicast.attr,
588 &dev_attr_collisions.attr,
589 &dev_attr_rx_length_errors.attr,
590 &dev_attr_rx_over_errors.attr,
591 &dev_attr_rx_crc_errors.attr,
592 &dev_attr_rx_frame_errors.attr,
593 &dev_attr_rx_fifo_errors.attr,
594 &dev_attr_rx_missed_errors.attr,
595 &dev_attr_tx_aborted_errors.attr,
596 &dev_attr_tx_carrier_errors.attr,
597 &dev_attr_tx_fifo_errors.attr,
598 &dev_attr_tx_heartbeat_errors.attr,
599 &dev_attr_tx_window_errors.attr,
600 &dev_attr_rx_compressed.attr,
601 &dev_attr_tx_compressed.attr,
606 static struct attribute_group netstat_group = {
607 .name = "statistics",
608 .attrs = netstat_attrs,
611 #if IS_ENABLED(CONFIG_WIRELESS_EXT) || IS_ENABLED(CONFIG_CFG80211)
612 static struct attribute *wireless_attrs[] = {
616 static struct attribute_group wireless_group = {
618 .attrs = wireless_attrs,
622 #else /* CONFIG_SYSFS */
623 #define net_class_groups NULL
624 #endif /* CONFIG_SYSFS */
627 #define to_rx_queue_attr(_attr) container_of(_attr, \
628 struct rx_queue_attribute, attr)
630 #define to_rx_queue(obj) container_of(obj, struct netdev_rx_queue, kobj)
632 static ssize_t rx_queue_attr_show(struct kobject *kobj, struct attribute *attr,
635 struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
636 struct netdev_rx_queue *queue = to_rx_queue(kobj);
638 if (!attribute->show)
641 return attribute->show(queue, attribute, buf);
644 static ssize_t rx_queue_attr_store(struct kobject *kobj, struct attribute *attr,
645 const char *buf, size_t count)
647 struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
648 struct netdev_rx_queue *queue = to_rx_queue(kobj);
650 if (!attribute->store)
653 return attribute->store(queue, attribute, buf, count);
656 static const struct sysfs_ops rx_queue_sysfs_ops = {
657 .show = rx_queue_attr_show,
658 .store = rx_queue_attr_store,
662 static ssize_t show_rps_map(struct netdev_rx_queue *queue,
663 struct rx_queue_attribute *attribute, char *buf)
669 if (!zalloc_cpumask_var(&mask, GFP_KERNEL))
673 map = rcu_dereference(queue->rps_map);
675 for (i = 0; i < map->len; i++)
676 cpumask_set_cpu(map->cpus[i], mask);
678 len = snprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
680 free_cpumask_var(mask);
682 return len < PAGE_SIZE ? len : -EINVAL;
685 static ssize_t store_rps_map(struct netdev_rx_queue *queue,
686 struct rx_queue_attribute *attribute,
687 const char *buf, size_t len)
689 struct rps_map *old_map, *map;
692 static DEFINE_MUTEX(rps_map_mutex);
694 if (!capable(CAP_NET_ADMIN))
697 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
700 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
702 free_cpumask_var(mask);
706 map = kzalloc(max_t(unsigned int,
707 RPS_MAP_SIZE(cpumask_weight(mask)), L1_CACHE_BYTES),
710 free_cpumask_var(mask);
715 for_each_cpu_and(cpu, mask, cpu_online_mask)
716 map->cpus[i++] = cpu;
725 mutex_lock(&rps_map_mutex);
726 old_map = rcu_dereference_protected(queue->rps_map,
727 mutex_is_locked(&rps_map_mutex));
728 rcu_assign_pointer(queue->rps_map, map);
731 static_key_slow_inc(&rps_needed);
733 static_key_slow_dec(&rps_needed);
735 mutex_unlock(&rps_map_mutex);
738 kfree_rcu(old_map, rcu);
740 free_cpumask_var(mask);
744 static ssize_t show_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
745 struct rx_queue_attribute *attr,
748 struct rps_dev_flow_table *flow_table;
749 unsigned long val = 0;
752 flow_table = rcu_dereference(queue->rps_flow_table);
754 val = (unsigned long)flow_table->mask + 1;
757 return sprintf(buf, "%lu\n", val);
760 static void rps_dev_flow_table_release(struct rcu_head *rcu)
762 struct rps_dev_flow_table *table = container_of(rcu,
763 struct rps_dev_flow_table, rcu);
767 static ssize_t store_rps_dev_flow_table_cnt(struct netdev_rx_queue *queue,
768 struct rx_queue_attribute *attr,
769 const char *buf, size_t len)
771 unsigned long mask, count;
772 struct rps_dev_flow_table *table, *old_table;
773 static DEFINE_SPINLOCK(rps_dev_flow_lock);
776 if (!capable(CAP_NET_ADMIN))
779 rc = kstrtoul(buf, 0, &count);
785 /* mask = roundup_pow_of_two(count) - 1;
786 * without overflows...
788 while ((mask | (mask >> 1)) != mask)
790 /* On 64 bit arches, must check mask fits in table->mask (u32),
791 * and on 32bit arches, must check
792 * RPS_DEV_FLOW_TABLE_SIZE(mask + 1) doesn't overflow.
794 #if BITS_PER_LONG > 32
795 if (mask > (unsigned long)(u32)mask)
798 if (mask > (ULONG_MAX - RPS_DEV_FLOW_TABLE_SIZE(1))
799 / sizeof(struct rps_dev_flow)) {
800 /* Enforce a limit to prevent overflow */
804 table = vmalloc(RPS_DEV_FLOW_TABLE_SIZE(mask + 1));
809 for (count = 0; count <= mask; count++)
810 table->flows[count].cpu = RPS_NO_CPU;
814 spin_lock(&rps_dev_flow_lock);
815 old_table = rcu_dereference_protected(queue->rps_flow_table,
816 lockdep_is_held(&rps_dev_flow_lock));
817 rcu_assign_pointer(queue->rps_flow_table, table);
818 spin_unlock(&rps_dev_flow_lock);
821 call_rcu(&old_table->rcu, rps_dev_flow_table_release);
826 static struct rx_queue_attribute rps_cpus_attribute =
827 __ATTR(rps_cpus, S_IRUGO | S_IWUSR, show_rps_map, store_rps_map);
830 static struct rx_queue_attribute rps_dev_flow_table_cnt_attribute =
831 __ATTR(rps_flow_cnt, S_IRUGO | S_IWUSR,
832 show_rps_dev_flow_table_cnt, store_rps_dev_flow_table_cnt);
833 #endif /* CONFIG_RPS */
835 static struct attribute *rx_queue_default_attrs[] = {
837 &rps_cpus_attribute.attr,
838 &rps_dev_flow_table_cnt_attribute.attr,
843 static void rx_queue_release(struct kobject *kobj)
845 struct netdev_rx_queue *queue = to_rx_queue(kobj);
848 struct rps_dev_flow_table *flow_table;
851 map = rcu_dereference_protected(queue->rps_map, 1);
853 RCU_INIT_POINTER(queue->rps_map, NULL);
857 flow_table = rcu_dereference_protected(queue->rps_flow_table, 1);
859 RCU_INIT_POINTER(queue->rps_flow_table, NULL);
860 call_rcu(&flow_table->rcu, rps_dev_flow_table_release);
864 memset(kobj, 0, sizeof(*kobj));
868 static const void *rx_queue_namespace(struct kobject *kobj)
870 struct netdev_rx_queue *queue = to_rx_queue(kobj);
871 struct device *dev = &queue->dev->dev;
872 const void *ns = NULL;
874 if (dev->class && dev->class->ns_type)
875 ns = dev->class->namespace(dev);
880 static struct kobj_type rx_queue_ktype = {
881 .sysfs_ops = &rx_queue_sysfs_ops,
882 .release = rx_queue_release,
883 .default_attrs = rx_queue_default_attrs,
884 .namespace = rx_queue_namespace
887 static int rx_queue_add_kobject(struct net_device *dev, int index)
889 struct netdev_rx_queue *queue = dev->_rx + index;
890 struct kobject *kobj = &queue->kobj;
893 kobj->kset = dev->queues_kset;
894 error = kobject_init_and_add(kobj, &rx_queue_ktype, NULL,
899 if (dev->sysfs_rx_queue_group) {
900 error = sysfs_create_group(kobj, dev->sysfs_rx_queue_group);
905 kobject_uevent(kobj, KOBJ_ADD);
906 dev_hold(queue->dev);
913 #endif /* CONFIG_SYSFS */
916 net_rx_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
923 if (!dev->sysfs_rx_queue_group)
926 for (i = old_num; i < new_num; i++) {
927 error = rx_queue_add_kobject(dev, i);
934 while (--i >= new_num) {
935 if (dev->sysfs_rx_queue_group)
936 sysfs_remove_group(&dev->_rx[i].kobj,
937 dev->sysfs_rx_queue_group);
938 kobject_put(&dev->_rx[i].kobj);
949 * netdev_queue sysfs structures and functions.
951 struct netdev_queue_attribute {
952 struct attribute attr;
953 ssize_t (*show)(struct netdev_queue *queue,
954 struct netdev_queue_attribute *attr, char *buf);
955 ssize_t (*store)(struct netdev_queue *queue,
956 struct netdev_queue_attribute *attr, const char *buf, size_t len);
958 #define to_netdev_queue_attr(_attr) container_of(_attr, \
959 struct netdev_queue_attribute, attr)
961 #define to_netdev_queue(obj) container_of(obj, struct netdev_queue, kobj)
963 static ssize_t netdev_queue_attr_show(struct kobject *kobj,
964 struct attribute *attr, char *buf)
966 struct netdev_queue_attribute *attribute = to_netdev_queue_attr(attr);
967 struct netdev_queue *queue = to_netdev_queue(kobj);
969 if (!attribute->show)
972 return attribute->show(queue, attribute, buf);
975 static ssize_t netdev_queue_attr_store(struct kobject *kobj,
976 struct attribute *attr,
977 const char *buf, size_t count)
979 struct netdev_queue_attribute *attribute = to_netdev_queue_attr(attr);
980 struct netdev_queue *queue = to_netdev_queue(kobj);
982 if (!attribute->store)
985 return attribute->store(queue, attribute, buf, count);
988 static const struct sysfs_ops netdev_queue_sysfs_ops = {
989 .show = netdev_queue_attr_show,
990 .store = netdev_queue_attr_store,
993 static ssize_t show_trans_timeout(struct netdev_queue *queue,
994 struct netdev_queue_attribute *attribute,
997 unsigned long trans_timeout;
999 spin_lock_irq(&queue->_xmit_lock);
1000 trans_timeout = queue->trans_timeout;
1001 spin_unlock_irq(&queue->_xmit_lock);
1003 return sprintf(buf, "%lu", trans_timeout);
1007 static inline unsigned int get_netdev_queue_index(struct netdev_queue *queue)
1009 struct net_device *dev = queue->dev;
1012 for (i = 0; i < dev->num_tx_queues; i++)
1013 if (queue == &dev->_tx[i])
1016 BUG_ON(i >= dev->num_tx_queues);
1021 static ssize_t show_tx_maxrate(struct netdev_queue *queue,
1022 struct netdev_queue_attribute *attribute,
1025 return sprintf(buf, "%lu\n", queue->tx_maxrate);
1028 static ssize_t set_tx_maxrate(struct netdev_queue *queue,
1029 struct netdev_queue_attribute *attribute,
1030 const char *buf, size_t len)
1032 struct net_device *dev = queue->dev;
1033 int err, index = get_netdev_queue_index(queue);
1036 err = kstrtou32(buf, 10, &rate);
1040 if (!rtnl_trylock())
1041 return restart_syscall();
1044 if (dev->netdev_ops->ndo_set_tx_maxrate)
1045 err = dev->netdev_ops->ndo_set_tx_maxrate(dev, index, rate);
1049 queue->tx_maxrate = rate;
1055 static struct netdev_queue_attribute queue_tx_maxrate =
1056 __ATTR(tx_maxrate, S_IRUGO | S_IWUSR,
1057 show_tx_maxrate, set_tx_maxrate);
1060 static struct netdev_queue_attribute queue_trans_timeout =
1061 __ATTR(tx_timeout, S_IRUGO, show_trans_timeout, NULL);
1065 * Byte queue limits sysfs structures and functions.
1067 static ssize_t bql_show(char *buf, unsigned int value)
1069 return sprintf(buf, "%u\n", value);
1072 static ssize_t bql_set(const char *buf, const size_t count,
1073 unsigned int *pvalue)
1078 if (!strcmp(buf, "max") || !strcmp(buf, "max\n"))
1079 value = DQL_MAX_LIMIT;
1081 err = kstrtouint(buf, 10, &value);
1084 if (value > DQL_MAX_LIMIT)
1093 static ssize_t bql_show_hold_time(struct netdev_queue *queue,
1094 struct netdev_queue_attribute *attr,
1097 struct dql *dql = &queue->dql;
1099 return sprintf(buf, "%u\n", jiffies_to_msecs(dql->slack_hold_time));
1102 static ssize_t bql_set_hold_time(struct netdev_queue *queue,
1103 struct netdev_queue_attribute *attribute,
1104 const char *buf, size_t len)
1106 struct dql *dql = &queue->dql;
1110 err = kstrtouint(buf, 10, &value);
1114 dql->slack_hold_time = msecs_to_jiffies(value);
1119 static struct netdev_queue_attribute bql_hold_time_attribute =
1120 __ATTR(hold_time, S_IRUGO | S_IWUSR, bql_show_hold_time,
1123 static ssize_t bql_show_inflight(struct netdev_queue *queue,
1124 struct netdev_queue_attribute *attr,
1127 struct dql *dql = &queue->dql;
1129 return sprintf(buf, "%u\n", dql->num_queued - dql->num_completed);
1132 static struct netdev_queue_attribute bql_inflight_attribute =
1133 __ATTR(inflight, S_IRUGO, bql_show_inflight, NULL);
1135 #define BQL_ATTR(NAME, FIELD) \
1136 static ssize_t bql_show_ ## NAME(struct netdev_queue *queue, \
1137 struct netdev_queue_attribute *attr, \
1140 return bql_show(buf, queue->dql.FIELD); \
1143 static ssize_t bql_set_ ## NAME(struct netdev_queue *queue, \
1144 struct netdev_queue_attribute *attr, \
1145 const char *buf, size_t len) \
1147 return bql_set(buf, len, &queue->dql.FIELD); \
1150 static struct netdev_queue_attribute bql_ ## NAME ## _attribute = \
1151 __ATTR(NAME, S_IRUGO | S_IWUSR, bql_show_ ## NAME, \
1154 BQL_ATTR(limit, limit)
1155 BQL_ATTR(limit_max, max_limit)
1156 BQL_ATTR(limit_min, min_limit)
1158 static struct attribute *dql_attrs[] = {
1159 &bql_limit_attribute.attr,
1160 &bql_limit_max_attribute.attr,
1161 &bql_limit_min_attribute.attr,
1162 &bql_hold_time_attribute.attr,
1163 &bql_inflight_attribute.attr,
1167 static struct attribute_group dql_group = {
1168 .name = "byte_queue_limits",
1171 #endif /* CONFIG_BQL */
1174 static ssize_t show_xps_map(struct netdev_queue *queue,
1175 struct netdev_queue_attribute *attribute, char *buf)
1177 struct net_device *dev = queue->dev;
1178 struct xps_dev_maps *dev_maps;
1180 unsigned long index;
1183 if (!zalloc_cpumask_var(&mask, GFP_KERNEL))
1186 index = get_netdev_queue_index(queue);
1189 dev_maps = rcu_dereference(dev->xps_maps);
1191 for_each_possible_cpu(i) {
1192 struct xps_map *map =
1193 rcu_dereference(dev_maps->cpu_map[i]);
1196 for (j = 0; j < map->len; j++) {
1197 if (map->queues[j] == index) {
1198 cpumask_set_cpu(i, mask);
1207 len = snprintf(buf, PAGE_SIZE, "%*pb\n", cpumask_pr_args(mask));
1208 free_cpumask_var(mask);
1209 return len < PAGE_SIZE ? len : -EINVAL;
1212 static ssize_t store_xps_map(struct netdev_queue *queue,
1213 struct netdev_queue_attribute *attribute,
1214 const char *buf, size_t len)
1216 struct net_device *dev = queue->dev;
1217 unsigned long index;
1221 if (!capable(CAP_NET_ADMIN))
1224 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
1227 index = get_netdev_queue_index(queue);
1229 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
1231 free_cpumask_var(mask);
1235 err = netif_set_xps_queue(dev, mask, index);
1237 free_cpumask_var(mask);
1242 static struct netdev_queue_attribute xps_cpus_attribute =
1243 __ATTR(xps_cpus, S_IRUGO | S_IWUSR, show_xps_map, store_xps_map);
1244 #endif /* CONFIG_XPS */
1246 static struct attribute *netdev_queue_default_attrs[] = {
1247 &queue_trans_timeout.attr,
1249 &xps_cpus_attribute.attr,
1250 &queue_tx_maxrate.attr,
1255 static void netdev_queue_release(struct kobject *kobj)
1257 struct netdev_queue *queue = to_netdev_queue(kobj);
1259 memset(kobj, 0, sizeof(*kobj));
1260 dev_put(queue->dev);
1263 static const void *netdev_queue_namespace(struct kobject *kobj)
1265 struct netdev_queue *queue = to_netdev_queue(kobj);
1266 struct device *dev = &queue->dev->dev;
1267 const void *ns = NULL;
1269 if (dev->class && dev->class->ns_type)
1270 ns = dev->class->namespace(dev);
1275 static struct kobj_type netdev_queue_ktype = {
1276 .sysfs_ops = &netdev_queue_sysfs_ops,
1277 .release = netdev_queue_release,
1278 .default_attrs = netdev_queue_default_attrs,
1279 .namespace = netdev_queue_namespace,
1282 static int netdev_queue_add_kobject(struct net_device *dev, int index)
1284 struct netdev_queue *queue = dev->_tx + index;
1285 struct kobject *kobj = &queue->kobj;
1288 kobj->kset = dev->queues_kset;
1289 error = kobject_init_and_add(kobj, &netdev_queue_ktype, NULL,
1295 error = sysfs_create_group(kobj, &dql_group);
1300 kobject_uevent(kobj, KOBJ_ADD);
1301 dev_hold(queue->dev);
1308 #endif /* CONFIG_SYSFS */
1311 netdev_queue_update_kobjects(struct net_device *dev, int old_num, int new_num)
1317 for (i = old_num; i < new_num; i++) {
1318 error = netdev_queue_add_kobject(dev, i);
1325 while (--i >= new_num) {
1326 struct netdev_queue *queue = dev->_tx + i;
1329 sysfs_remove_group(&queue->kobj, &dql_group);
1331 kobject_put(&queue->kobj);
1337 #endif /* CONFIG_SYSFS */
1340 static int register_queue_kobjects(struct net_device *dev)
1342 int error = 0, txq = 0, rxq = 0, real_rx = 0, real_tx = 0;
1345 dev->queues_kset = kset_create_and_add("queues",
1346 NULL, &dev->dev.kobj);
1347 if (!dev->queues_kset)
1349 real_rx = dev->real_num_rx_queues;
1351 real_tx = dev->real_num_tx_queues;
1353 error = net_rx_queue_update_kobjects(dev, 0, real_rx);
1358 error = netdev_queue_update_kobjects(dev, 0, real_tx);
1366 netdev_queue_update_kobjects(dev, txq, 0);
1367 net_rx_queue_update_kobjects(dev, rxq, 0);
1371 static void remove_queue_kobjects(struct net_device *dev)
1373 int real_rx = 0, real_tx = 0;
1376 real_rx = dev->real_num_rx_queues;
1378 real_tx = dev->real_num_tx_queues;
1380 net_rx_queue_update_kobjects(dev, real_rx, 0);
1381 netdev_queue_update_kobjects(dev, real_tx, 0);
1383 kset_unregister(dev->queues_kset);
1387 static bool net_current_may_mount(void)
1389 struct net *net = current->nsproxy->net_ns;
1391 return ns_capable(net->user_ns, CAP_SYS_ADMIN);
1394 static void *net_grab_current_ns(void)
1396 struct net *ns = current->nsproxy->net_ns;
1397 #ifdef CONFIG_NET_NS
1399 atomic_inc(&ns->passive);
1404 static const void *net_initial_ns(void)
1409 static const void *net_netlink_ns(struct sock *sk)
1411 return sock_net(sk);
1414 struct kobj_ns_type_operations net_ns_type_operations = {
1415 .type = KOBJ_NS_TYPE_NET,
1416 .current_may_mount = net_current_may_mount,
1417 .grab_current_ns = net_grab_current_ns,
1418 .netlink_ns = net_netlink_ns,
1419 .initial_ns = net_initial_ns,
1420 .drop_ns = net_drop_ns,
1422 EXPORT_SYMBOL_GPL(net_ns_type_operations);
1424 static int netdev_uevent(struct device *d, struct kobj_uevent_env *env)
1426 struct net_device *dev = to_net_dev(d);
1429 /* pass interface to uevent. */
1430 retval = add_uevent_var(env, "INTERFACE=%s", dev->name);
1434 /* pass ifindex to uevent.
1435 * ifindex is useful as it won't change (interface name may change)
1436 * and is what RtNetlink uses natively. */
1437 retval = add_uevent_var(env, "IFINDEX=%d", dev->ifindex);
1444 * netdev_release -- destroy and free a dead device.
1445 * Called when last reference to device kobject is gone.
1447 static void netdev_release(struct device *d)
1449 struct net_device *dev = to_net_dev(d);
1451 BUG_ON(dev->reg_state != NETREG_RELEASED);
1453 kfree(dev->ifalias);
1454 netdev_freemem(dev);
1457 static const void *net_namespace(struct device *d)
1459 struct net_device *dev;
1460 dev = container_of(d, struct net_device, dev);
1461 return dev_net(dev);
1464 static struct class net_class = {
1466 .dev_release = netdev_release,
1467 .dev_groups = net_class_groups,
1468 .dev_uevent = netdev_uevent,
1469 .ns_type = &net_ns_type_operations,
1470 .namespace = net_namespace,
1473 #ifdef CONFIG_OF_NET
1474 static int of_dev_node_match(struct device *dev, const void *data)
1479 ret = dev->parent->of_node == data;
1481 return ret == 0 ? dev->of_node == data : ret;
1484 struct net_device *of_find_net_device_by_node(struct device_node *np)
1488 dev = class_find_device(&net_class, NULL, np, of_dev_node_match);
1492 return to_net_dev(dev);
1494 EXPORT_SYMBOL(of_find_net_device_by_node);
1497 /* Delete sysfs entries but hold kobject reference until after all
1498 * netdev references are gone.
1500 void netdev_unregister_kobject(struct net_device *ndev)
1502 struct device *dev = &(ndev->dev);
1504 kobject_get(&dev->kobj);
1506 remove_queue_kobjects(ndev);
1508 pm_runtime_set_memalloc_noio(dev, false);
1513 /* Create sysfs entries for network device. */
1514 int netdev_register_kobject(struct net_device *ndev)
1516 struct device *dev = &(ndev->dev);
1517 const struct attribute_group **groups = ndev->sysfs_groups;
1520 device_initialize(dev);
1521 dev->class = &net_class;
1522 dev->platform_data = ndev;
1523 dev->groups = groups;
1525 dev_set_name(dev, "%s", ndev->name);
1528 /* Allow for a device specific group */
1532 *groups++ = &netstat_group;
1534 #if IS_ENABLED(CONFIG_WIRELESS_EXT) || IS_ENABLED(CONFIG_CFG80211)
1535 if (ndev->ieee80211_ptr)
1536 *groups++ = &wireless_group;
1537 #if IS_ENABLED(CONFIG_WIRELESS_EXT)
1538 else if (ndev->wireless_handlers)
1539 *groups++ = &wireless_group;
1542 #endif /* CONFIG_SYSFS */
1544 error = device_add(dev);
1548 error = register_queue_kobjects(ndev);
1554 pm_runtime_set_memalloc_noio(dev, true);
1559 int netdev_class_create_file_ns(struct class_attribute *class_attr,
1562 return class_create_file_ns(&net_class, class_attr, ns);
1564 EXPORT_SYMBOL(netdev_class_create_file_ns);
1566 void netdev_class_remove_file_ns(struct class_attribute *class_attr,
1569 class_remove_file_ns(&net_class, class_attr, ns);
1571 EXPORT_SYMBOL(netdev_class_remove_file_ns);
1573 int __init netdev_kobject_init(void)
1575 kobj_ns_type_register(&net_ns_type_operations);
1576 return class_register(&net_class);