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 <linux/if_arp.h>
17 #include <linux/rtnetlink.h>
18 #include <linux/wireless.h>
21 #include "net-sysfs.h"
24 static const char fmt_hex[] = "%#x\n";
25 static const char fmt_long_hex[] = "%#lx\n";
26 static const char fmt_dec[] = "%d\n";
27 static const char fmt_ulong[] = "%lu\n";
29 static inline int dev_isalive(const struct net_device *dev)
31 return dev->reg_state <= NETREG_REGISTERED;
34 /* use same locking rules as GIF* ioctl's */
35 static ssize_t netdev_show(const struct device *dev,
36 struct device_attribute *attr, char *buf,
37 ssize_t (*format)(const struct net_device *, char *))
39 struct net_device *net = to_net_dev(dev);
40 ssize_t ret = -EINVAL;
42 read_lock(&dev_base_lock);
44 ret = (*format)(net, buf);
45 read_unlock(&dev_base_lock);
50 /* generate a show function for simple field */
51 #define NETDEVICE_SHOW(field, format_string) \
52 static ssize_t format_##field(const struct net_device *net, char *buf) \
54 return sprintf(buf, format_string, net->field); \
56 static ssize_t show_##field(struct device *dev, \
57 struct device_attribute *attr, char *buf) \
59 return netdev_show(dev, attr, buf, format_##field); \
63 /* use same locking and permission rules as SIF* ioctl's */
64 static ssize_t netdev_store(struct device *dev, struct device_attribute *attr,
65 const char *buf, size_t len,
66 int (*set)(struct net_device *, unsigned long))
68 struct net_device *net = to_net_dev(dev);
73 if (!capable(CAP_NET_ADMIN))
76 new = simple_strtoul(buf, &endp, 0);
81 return restart_syscall();
83 if (dev_isalive(net)) {
84 if ((ret = (*set)(net, new)) == 0)
92 NETDEVICE_SHOW(dev_id, fmt_hex);
93 NETDEVICE_SHOW(addr_len, fmt_dec);
94 NETDEVICE_SHOW(iflink, fmt_dec);
95 NETDEVICE_SHOW(ifindex, fmt_dec);
96 NETDEVICE_SHOW(features, fmt_long_hex);
97 NETDEVICE_SHOW(type, fmt_dec);
98 NETDEVICE_SHOW(link_mode, fmt_dec);
100 /* use same locking rules as GIFHWADDR ioctl's */
101 static ssize_t show_address(struct device *dev, struct device_attribute *attr,
104 struct net_device *net = to_net_dev(dev);
105 ssize_t ret = -EINVAL;
107 read_lock(&dev_base_lock);
108 if (dev_isalive(net))
109 ret = sysfs_format_mac(buf, net->dev_addr, net->addr_len);
110 read_unlock(&dev_base_lock);
114 static ssize_t show_broadcast(struct device *dev,
115 struct device_attribute *attr, char *buf)
117 struct net_device *net = to_net_dev(dev);
118 if (dev_isalive(net))
119 return sysfs_format_mac(buf, net->broadcast, net->addr_len);
123 static ssize_t show_carrier(struct device *dev,
124 struct device_attribute *attr, char *buf)
126 struct net_device *netdev = to_net_dev(dev);
127 if (netif_running(netdev)) {
128 return sprintf(buf, fmt_dec, !!netif_carrier_ok(netdev));
133 static ssize_t show_speed(struct device *dev,
134 struct device_attribute *attr, char *buf)
136 struct net_device *netdev = to_net_dev(dev);
140 return restart_syscall();
142 if (netif_running(netdev) &&
143 netdev->ethtool_ops &&
144 netdev->ethtool_ops->get_settings) {
145 struct ethtool_cmd cmd = { ETHTOOL_GSET };
147 if (!netdev->ethtool_ops->get_settings(netdev, &cmd))
148 ret = sprintf(buf, fmt_dec, ethtool_cmd_speed(&cmd));
154 static ssize_t show_duplex(struct device *dev,
155 struct device_attribute *attr, char *buf)
157 struct net_device *netdev = to_net_dev(dev);
161 return restart_syscall();
163 if (netif_running(netdev) &&
164 netdev->ethtool_ops &&
165 netdev->ethtool_ops->get_settings) {
166 struct ethtool_cmd cmd = { ETHTOOL_GSET };
168 if (!netdev->ethtool_ops->get_settings(netdev, &cmd))
169 ret = sprintf(buf, "%s\n", cmd.duplex ? "full" : "half");
175 static ssize_t show_dormant(struct device *dev,
176 struct device_attribute *attr, char *buf)
178 struct net_device *netdev = to_net_dev(dev);
180 if (netif_running(netdev))
181 return sprintf(buf, fmt_dec, !!netif_dormant(netdev));
186 static const char *const operstates[] = {
188 "notpresent", /* currently unused */
191 "testing", /* currently unused */
196 static ssize_t show_operstate(struct device *dev,
197 struct device_attribute *attr, char *buf)
199 const struct net_device *netdev = to_net_dev(dev);
200 unsigned char operstate;
202 read_lock(&dev_base_lock);
203 operstate = netdev->operstate;
204 if (!netif_running(netdev))
205 operstate = IF_OPER_DOWN;
206 read_unlock(&dev_base_lock);
208 if (operstate >= ARRAY_SIZE(operstates))
209 return -EINVAL; /* should not happen */
211 return sprintf(buf, "%s\n", operstates[operstate]);
214 /* read-write attributes */
215 NETDEVICE_SHOW(mtu, fmt_dec);
217 static int change_mtu(struct net_device *net, unsigned long new_mtu)
219 return dev_set_mtu(net, (int) new_mtu);
222 static ssize_t store_mtu(struct device *dev, struct device_attribute *attr,
223 const char *buf, size_t len)
225 return netdev_store(dev, attr, buf, len, change_mtu);
228 NETDEVICE_SHOW(flags, fmt_hex);
230 static int change_flags(struct net_device *net, unsigned long new_flags)
232 return dev_change_flags(net, (unsigned) new_flags);
235 static ssize_t store_flags(struct device *dev, struct device_attribute *attr,
236 const char *buf, size_t len)
238 return netdev_store(dev, attr, buf, len, change_flags);
241 NETDEVICE_SHOW(tx_queue_len, fmt_ulong);
243 static int change_tx_queue_len(struct net_device *net, unsigned long new_len)
245 net->tx_queue_len = new_len;
249 static ssize_t store_tx_queue_len(struct device *dev,
250 struct device_attribute *attr,
251 const char *buf, size_t len)
253 return netdev_store(dev, attr, buf, len, change_tx_queue_len);
256 static ssize_t store_ifalias(struct device *dev, struct device_attribute *attr,
257 const char *buf, size_t len)
259 struct net_device *netdev = to_net_dev(dev);
263 if (!capable(CAP_NET_ADMIN))
266 /* ignore trailing newline */
267 if (len > 0 && buf[len - 1] == '\n')
271 return restart_syscall();
272 ret = dev_set_alias(netdev, buf, count);
275 return ret < 0 ? ret : len;
278 static ssize_t show_ifalias(struct device *dev,
279 struct device_attribute *attr, char *buf)
281 const struct net_device *netdev = to_net_dev(dev);
285 return restart_syscall();
287 ret = sprintf(buf, "%s\n", netdev->ifalias);
292 static struct device_attribute net_class_attributes[] = {
293 __ATTR(addr_len, S_IRUGO, show_addr_len, NULL),
294 __ATTR(dev_id, S_IRUGO, show_dev_id, NULL),
295 __ATTR(ifalias, S_IRUGO | S_IWUSR, show_ifalias, store_ifalias),
296 __ATTR(iflink, S_IRUGO, show_iflink, NULL),
297 __ATTR(ifindex, S_IRUGO, show_ifindex, NULL),
298 __ATTR(features, S_IRUGO, show_features, NULL),
299 __ATTR(type, S_IRUGO, show_type, NULL),
300 __ATTR(link_mode, S_IRUGO, show_link_mode, NULL),
301 __ATTR(address, S_IRUGO, show_address, NULL),
302 __ATTR(broadcast, S_IRUGO, show_broadcast, NULL),
303 __ATTR(carrier, S_IRUGO, show_carrier, NULL),
304 __ATTR(speed, S_IRUGO, show_speed, NULL),
305 __ATTR(duplex, S_IRUGO, show_duplex, NULL),
306 __ATTR(dormant, S_IRUGO, show_dormant, NULL),
307 __ATTR(operstate, S_IRUGO, show_operstate, NULL),
308 __ATTR(mtu, S_IRUGO | S_IWUSR, show_mtu, store_mtu),
309 __ATTR(flags, S_IRUGO | S_IWUSR, show_flags, store_flags),
310 __ATTR(tx_queue_len, S_IRUGO | S_IWUSR, show_tx_queue_len,
315 /* Show a given an attribute in the statistics group */
316 static ssize_t netstat_show(const struct device *d,
317 struct device_attribute *attr, char *buf,
318 unsigned long offset)
320 struct net_device *dev = to_net_dev(d);
321 ssize_t ret = -EINVAL;
323 WARN_ON(offset > sizeof(struct net_device_stats) ||
324 offset % sizeof(unsigned long) != 0);
326 read_lock(&dev_base_lock);
327 if (dev_isalive(dev)) {
328 const struct net_device_stats *stats = dev_get_stats(dev);
329 ret = sprintf(buf, fmt_ulong,
330 *(unsigned long *)(((u8 *) stats) + offset));
332 read_unlock(&dev_base_lock);
336 /* generate a read-only statistics attribute */
337 #define NETSTAT_ENTRY(name) \
338 static ssize_t show_##name(struct device *d, \
339 struct device_attribute *attr, char *buf) \
341 return netstat_show(d, attr, buf, \
342 offsetof(struct net_device_stats, name)); \
344 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
346 NETSTAT_ENTRY(rx_packets);
347 NETSTAT_ENTRY(tx_packets);
348 NETSTAT_ENTRY(rx_bytes);
349 NETSTAT_ENTRY(tx_bytes);
350 NETSTAT_ENTRY(rx_errors);
351 NETSTAT_ENTRY(tx_errors);
352 NETSTAT_ENTRY(rx_dropped);
353 NETSTAT_ENTRY(tx_dropped);
354 NETSTAT_ENTRY(multicast);
355 NETSTAT_ENTRY(collisions);
356 NETSTAT_ENTRY(rx_length_errors);
357 NETSTAT_ENTRY(rx_over_errors);
358 NETSTAT_ENTRY(rx_crc_errors);
359 NETSTAT_ENTRY(rx_frame_errors);
360 NETSTAT_ENTRY(rx_fifo_errors);
361 NETSTAT_ENTRY(rx_missed_errors);
362 NETSTAT_ENTRY(tx_aborted_errors);
363 NETSTAT_ENTRY(tx_carrier_errors);
364 NETSTAT_ENTRY(tx_fifo_errors);
365 NETSTAT_ENTRY(tx_heartbeat_errors);
366 NETSTAT_ENTRY(tx_window_errors);
367 NETSTAT_ENTRY(rx_compressed);
368 NETSTAT_ENTRY(tx_compressed);
370 static struct attribute *netstat_attrs[] = {
371 &dev_attr_rx_packets.attr,
372 &dev_attr_tx_packets.attr,
373 &dev_attr_rx_bytes.attr,
374 &dev_attr_tx_bytes.attr,
375 &dev_attr_rx_errors.attr,
376 &dev_attr_tx_errors.attr,
377 &dev_attr_rx_dropped.attr,
378 &dev_attr_tx_dropped.attr,
379 &dev_attr_multicast.attr,
380 &dev_attr_collisions.attr,
381 &dev_attr_rx_length_errors.attr,
382 &dev_attr_rx_over_errors.attr,
383 &dev_attr_rx_crc_errors.attr,
384 &dev_attr_rx_frame_errors.attr,
385 &dev_attr_rx_fifo_errors.attr,
386 &dev_attr_rx_missed_errors.attr,
387 &dev_attr_tx_aborted_errors.attr,
388 &dev_attr_tx_carrier_errors.attr,
389 &dev_attr_tx_fifo_errors.attr,
390 &dev_attr_tx_heartbeat_errors.attr,
391 &dev_attr_tx_window_errors.attr,
392 &dev_attr_rx_compressed.attr,
393 &dev_attr_tx_compressed.attr,
398 static struct attribute_group netstat_group = {
399 .name = "statistics",
400 .attrs = netstat_attrs,
403 #ifdef CONFIG_WIRELESS_EXT_SYSFS
404 /* helper function that does all the locking etc for wireless stats */
405 static ssize_t wireless_show(struct device *d, char *buf,
406 ssize_t (*format)(const struct iw_statistics *,
409 struct net_device *dev = to_net_dev(d);
410 const struct iw_statistics *iw;
411 ssize_t ret = -EINVAL;
414 return restart_syscall();
415 if (dev_isalive(dev)) {
416 iw = get_wireless_stats(dev);
418 ret = (*format)(iw, buf);
425 /* show function template for wireless fields */
426 #define WIRELESS_SHOW(name, field, format_string) \
427 static ssize_t format_iw_##name(const struct iw_statistics *iw, char *buf) \
429 return sprintf(buf, format_string, iw->field); \
431 static ssize_t show_iw_##name(struct device *d, \
432 struct device_attribute *attr, char *buf) \
434 return wireless_show(d, buf, format_iw_##name); \
436 static DEVICE_ATTR(name, S_IRUGO, show_iw_##name, NULL)
438 WIRELESS_SHOW(status, status, fmt_hex);
439 WIRELESS_SHOW(link, qual.qual, fmt_dec);
440 WIRELESS_SHOW(level, qual.level, fmt_dec);
441 WIRELESS_SHOW(noise, qual.noise, fmt_dec);
442 WIRELESS_SHOW(nwid, discard.nwid, fmt_dec);
443 WIRELESS_SHOW(crypt, discard.code, fmt_dec);
444 WIRELESS_SHOW(fragment, discard.fragment, fmt_dec);
445 WIRELESS_SHOW(misc, discard.misc, fmt_dec);
446 WIRELESS_SHOW(retries, discard.retries, fmt_dec);
447 WIRELESS_SHOW(beacon, miss.beacon, fmt_dec);
449 static struct attribute *wireless_attrs[] = {
450 &dev_attr_status.attr,
452 &dev_attr_level.attr,
453 &dev_attr_noise.attr,
455 &dev_attr_crypt.attr,
456 &dev_attr_fragment.attr,
457 &dev_attr_retries.attr,
459 &dev_attr_beacon.attr,
463 static struct attribute_group wireless_group = {
465 .attrs = wireless_attrs,
470 * RX queue sysfs structures and functions.
472 struct rx_queue_attribute {
473 struct attribute attr;
474 ssize_t (*show)(struct netdev_rx_queue *queue,
475 struct rx_queue_attribute *attr, char *buf);
476 ssize_t (*store)(struct netdev_rx_queue *queue,
477 struct rx_queue_attribute *attr, const char *buf, size_t len);
479 #define to_rx_queue_attr(_attr) container_of(_attr, \
480 struct rx_queue_attribute, attr)
482 #define to_rx_queue(obj) container_of(obj, struct netdev_rx_queue, kobj)
484 static ssize_t rx_queue_attr_show(struct kobject *kobj, struct attribute *attr,
487 struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
488 struct netdev_rx_queue *queue = to_rx_queue(kobj);
490 if (!attribute->show)
493 return attribute->show(queue, attribute, buf);
496 static ssize_t rx_queue_attr_store(struct kobject *kobj, struct attribute *attr,
497 const char *buf, size_t count)
499 struct rx_queue_attribute *attribute = to_rx_queue_attr(attr);
500 struct netdev_rx_queue *queue = to_rx_queue(kobj);
502 if (!attribute->store)
505 return attribute->store(queue, attribute, buf, count);
508 static struct sysfs_ops rx_queue_sysfs_ops = {
509 .show = rx_queue_attr_show,
510 .store = rx_queue_attr_store,
513 static ssize_t show_rps_map(struct netdev_rx_queue *queue,
514 struct rx_queue_attribute *attribute, char *buf)
521 if (!zalloc_cpumask_var(&mask, GFP_KERNEL))
525 map = rcu_dereference(queue->rps_map);
527 for (i = 0; i < map->len; i++)
528 cpumask_set_cpu(map->cpus[i], mask);
530 len += cpumask_scnprintf(buf + len, PAGE_SIZE, mask);
531 if (PAGE_SIZE - len < 3) {
533 free_cpumask_var(mask);
538 free_cpumask_var(mask);
539 len += sprintf(buf + len, "\n");
543 static void rps_map_release(struct rcu_head *rcu)
545 struct rps_map *map = container_of(rcu, struct rps_map, rcu);
550 ssize_t store_rps_map(struct netdev_rx_queue *queue,
551 struct rx_queue_attribute *attribute,
552 const char *buf, size_t len)
554 struct rps_map *old_map, *map;
557 static DEFINE_SPINLOCK(rps_map_lock);
559 if (!capable(CAP_NET_ADMIN))
562 if (!alloc_cpumask_var(&mask, GFP_KERNEL))
565 err = bitmap_parse(buf, len, cpumask_bits(mask), nr_cpumask_bits);
567 free_cpumask_var(mask);
571 map = kzalloc(max_t(unsigned,
572 RPS_MAP_SIZE(cpumask_weight(mask)), L1_CACHE_BYTES),
575 free_cpumask_var(mask);
580 for_each_cpu_and(cpu, mask, cpu_online_mask)
581 map->cpus[i++] = cpu;
590 spin_lock(&rps_map_lock);
591 old_map = queue->rps_map;
592 rcu_assign_pointer(queue->rps_map, map);
593 spin_unlock(&rps_map_lock);
596 call_rcu(&old_map->rcu, rps_map_release);
598 free_cpumask_var(mask);
602 static struct rx_queue_attribute rps_cpus_attribute =
603 __ATTR(rps_cpus, S_IRUGO | S_IWUSR, show_rps_map, store_rps_map);
605 static struct attribute *rx_queue_default_attrs[] = {
606 &rps_cpus_attribute.attr,
610 static void rx_queue_release(struct kobject *kobj)
612 struct netdev_rx_queue *queue = to_rx_queue(kobj);
613 struct rps_map *map = queue->rps_map;
614 struct netdev_rx_queue *first = queue->first;
617 call_rcu(&map->rcu, rps_map_release);
619 if (atomic_dec_and_test(&first->count))
623 static struct kobj_type rx_queue_ktype = {
624 .sysfs_ops = &rx_queue_sysfs_ops,
625 .release = rx_queue_release,
626 .default_attrs = rx_queue_default_attrs,
629 static int rx_queue_add_kobject(struct net_device *net, int index)
631 struct netdev_rx_queue *queue = net->_rx + index;
632 struct kobject *kobj = &queue->kobj;
635 kobj->kset = net->queues_kset;
636 error = kobject_init_and_add(kobj, &rx_queue_ktype, NULL,
643 kobject_uevent(kobj, KOBJ_ADD);
648 static int rx_queue_register_kobjects(struct net_device *net)
653 net->queues_kset = kset_create_and_add("queues",
654 NULL, &net->dev.kobj);
655 if (!net->queues_kset)
657 for (i = 0; i < net->num_rx_queues; i++) {
658 error = rx_queue_add_kobject(net, i);
665 kobject_put(&net->_rx[i].kobj);
670 static void rx_queue_remove_kobjects(struct net_device *net)
674 for (i = 0; i < net->num_rx_queues; i++)
675 kobject_put(&net->_rx[i].kobj);
676 kset_unregister(net->queues_kset);
679 #endif /* CONFIG_SYSFS */
681 #ifdef CONFIG_HOTPLUG
682 static int netdev_uevent(struct device *d, struct kobj_uevent_env *env)
684 struct net_device *dev = to_net_dev(d);
687 if (!net_eq(dev_net(dev), &init_net))
690 /* pass interface to uevent. */
691 retval = add_uevent_var(env, "INTERFACE=%s", dev->name);
695 /* pass ifindex to uevent.
696 * ifindex is useful as it won't change (interface name may change)
697 * and is what RtNetlink uses natively. */
698 retval = add_uevent_var(env, "IFINDEX=%d", dev->ifindex);
706 * netdev_release -- destroy and free a dead device.
707 * Called when last reference to device kobject is gone.
709 static void netdev_release(struct device *d)
711 struct net_device *dev = to_net_dev(d);
713 BUG_ON(dev->reg_state != NETREG_RELEASED);
716 kfree((char *)dev - dev->padded);
719 static struct class net_class = {
721 .dev_release = netdev_release,
723 .dev_attrs = net_class_attributes,
724 #endif /* CONFIG_SYSFS */
725 #ifdef CONFIG_HOTPLUG
726 .dev_uevent = netdev_uevent,
730 /* Delete sysfs entries but hold kobject reference until after all
731 * netdev references are gone.
733 void netdev_unregister_kobject(struct net_device * net)
735 struct device *dev = &(net->dev);
737 kobject_get(&dev->kobj);
739 if (!net_eq(dev_net(net), &init_net))
742 rx_queue_remove_kobjects(net);
747 /* Create sysfs entries for network device. */
748 int netdev_register_kobject(struct net_device *net)
750 struct device *dev = &(net->dev);
751 const struct attribute_group **groups = net->sysfs_groups;
754 dev->class = &net_class;
755 dev->platform_data = net;
756 dev->groups = groups;
758 dev_set_name(dev, "%s", net->name);
761 /* Allow for a device specific group */
765 *groups++ = &netstat_group;
766 #ifdef CONFIG_WIRELESS_EXT_SYSFS
767 if (net->ieee80211_ptr)
768 *groups++ = &wireless_group;
769 #ifdef CONFIG_WIRELESS_EXT
770 else if (net->wireless_handlers)
771 *groups++ = &wireless_group;
774 #endif /* CONFIG_SYSFS */
776 if (!net_eq(dev_net(net), &init_net))
779 error = device_add(dev);
783 error = rx_queue_register_kobjects(net);
792 int netdev_class_create_file(struct class_attribute *class_attr)
794 return class_create_file(&net_class, class_attr);
797 void netdev_class_remove_file(struct class_attribute *class_attr)
799 class_remove_file(&net_class, class_attr);
802 EXPORT_SYMBOL(netdev_class_create_file);
803 EXPORT_SYMBOL(netdev_class_remove_file);
805 void netdev_initialize_kobject(struct net_device *net)
807 struct device *device = &(net->dev);
808 device_initialize(device);
811 int netdev_kobject_init(void)
813 return class_register(&net_class);