[CCID3]: Remove ifdef surrounding BUG_ON
[linux-block.git] / net / core / net-sysfs.c
CommitLineData
1da177e4
LT
1/*
2 * net-sysfs.c - network device class and attributes
3 *
4 * Copyright (c) 2003 Stephen Hemminger <shemminger@osdl.org>
4ec93edb 5 *
1da177e4
LT
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.
10 */
11
4fc268d2 12#include <linux/capability.h>
1da177e4
LT
13#include <linux/kernel.h>
14#include <linux/netdevice.h>
15#include <linux/if_arp.h>
16#include <net/sock.h>
17#include <linux/rtnetlink.h>
18#include <linux/wireless.h>
6dd214b5 19#include <net/iw_handler.h>
1da177e4 20
1da177e4 21static const char fmt_hex[] = "%#x\n";
d1102b59 22static const char fmt_long_hex[] = "%#lx\n";
1da177e4
LT
23static const char fmt_dec[] = "%d\n";
24static const char fmt_ulong[] = "%lu\n";
25
4ec93edb 26static inline int dev_isalive(const struct net_device *dev)
1da177e4 27{
fe9925b5 28 return dev->reg_state <= NETREG_REGISTERED;
1da177e4
LT
29}
30
31/* use same locking rules as GIF* ioctl's */
43cb76d9
GKH
32static ssize_t netdev_show(const struct device *dev,
33 struct device_attribute *attr, char *buf,
1da177e4
LT
34 ssize_t (*format)(const struct net_device *, char *))
35{
43cb76d9 36 struct net_device *net = to_net_dev(dev);
1da177e4
LT
37 ssize_t ret = -EINVAL;
38
39 read_lock(&dev_base_lock);
40 if (dev_isalive(net))
41 ret = (*format)(net, buf);
42 read_unlock(&dev_base_lock);
43
44 return ret;
45}
46
47/* generate a show function for simple field */
48#define NETDEVICE_SHOW(field, format_string) \
49static ssize_t format_##field(const struct net_device *net, char *buf) \
50{ \
51 return sprintf(buf, format_string, net->field); \
52} \
43cb76d9
GKH
53static ssize_t show_##field(struct device *dev, \
54 struct device_attribute *attr, char *buf) \
1da177e4 55{ \
43cb76d9 56 return netdev_show(dev, attr, buf, format_##field); \
1da177e4
LT
57}
58
59
60/* use same locking and permission rules as SIF* ioctl's */
43cb76d9 61static ssize_t netdev_store(struct device *dev, struct device_attribute *attr,
1da177e4
LT
62 const char *buf, size_t len,
63 int (*set)(struct net_device *, unsigned long))
64{
65 struct net_device *net = to_net_dev(dev);
66 char *endp;
67 unsigned long new;
68 int ret = -EINVAL;
69
70 if (!capable(CAP_NET_ADMIN))
71 return -EPERM;
72
73 new = simple_strtoul(buf, &endp, 0);
74 if (endp == buf)
75 goto err;
76
77 rtnl_lock();
78 if (dev_isalive(net)) {
79 if ((ret = (*set)(net, new)) == 0)
80 ret = len;
81 }
82 rtnl_unlock();
83 err:
84 return ret;
85}
86
fd586bac
KS
87NETDEVICE_SHOW(addr_len, fmt_dec);
88NETDEVICE_SHOW(iflink, fmt_dec);
89NETDEVICE_SHOW(ifindex, fmt_dec);
90NETDEVICE_SHOW(features, fmt_long_hex);
91NETDEVICE_SHOW(type, fmt_dec);
b00055aa 92NETDEVICE_SHOW(link_mode, fmt_dec);
1da177e4
LT
93
94/* use same locking rules as GIFHWADDR ioctl's */
95static ssize_t format_addr(char *buf, const unsigned char *addr, int len)
96{
97 int i;
98 char *cp = buf;
99
100 for (i = 0; i < len; i++)
101 cp += sprintf(cp, "%02x%c", addr[i],
102 i == (len - 1) ? '\n' : ':');
103 return cp - buf;
104}
105
43cb76d9
GKH
106static ssize_t show_address(struct device *dev, struct device_attribute *attr,
107 char *buf)
1da177e4
LT
108{
109 struct net_device *net = to_net_dev(dev);
110 ssize_t ret = -EINVAL;
111
112 read_lock(&dev_base_lock);
113 if (dev_isalive(net))
114 ret = format_addr(buf, net->dev_addr, net->addr_len);
115 read_unlock(&dev_base_lock);
116 return ret;
117}
118
43cb76d9
GKH
119static ssize_t show_broadcast(struct device *dev,
120 struct device_attribute *attr, char *buf)
1da177e4
LT
121{
122 struct net_device *net = to_net_dev(dev);
123 if (dev_isalive(net))
124 return format_addr(buf, net->broadcast, net->addr_len);
125 return -EINVAL;
126}
127
43cb76d9
GKH
128static ssize_t show_carrier(struct device *dev,
129 struct device_attribute *attr, char *buf)
1da177e4
LT
130{
131 struct net_device *netdev = to_net_dev(dev);
132 if (netif_running(netdev)) {
133 return sprintf(buf, fmt_dec, !!netif_carrier_ok(netdev));
134 }
135 return -EINVAL;
136}
137
43cb76d9
GKH
138static ssize_t show_dormant(struct device *dev,
139 struct device_attribute *attr, char *buf)
b00055aa
SR
140{
141 struct net_device *netdev = to_net_dev(dev);
142
143 if (netif_running(netdev))
144 return sprintf(buf, fmt_dec, !!netif_dormant(netdev));
145
146 return -EINVAL;
147}
148
149static const char *operstates[] = {
150 "unknown",
151 "notpresent", /* currently unused */
152 "down",
153 "lowerlayerdown",
154 "testing", /* currently unused */
155 "dormant",
156 "up"
157};
158
43cb76d9
GKH
159static ssize_t show_operstate(struct device *dev,
160 struct device_attribute *attr, char *buf)
b00055aa
SR
161{
162 const struct net_device *netdev = to_net_dev(dev);
163 unsigned char operstate;
164
165 read_lock(&dev_base_lock);
166 operstate = netdev->operstate;
167 if (!netif_running(netdev))
168 operstate = IF_OPER_DOWN;
169 read_unlock(&dev_base_lock);
170
e3a5cd9e 171 if (operstate >= ARRAY_SIZE(operstates))
b00055aa
SR
172 return -EINVAL; /* should not happen */
173
174 return sprintf(buf, "%s\n", operstates[operstate]);
175}
176
1da177e4
LT
177/* read-write attributes */
178NETDEVICE_SHOW(mtu, fmt_dec);
179
180static int change_mtu(struct net_device *net, unsigned long new_mtu)
181{
182 return dev_set_mtu(net, (int) new_mtu);
183}
184
43cb76d9
GKH
185static ssize_t store_mtu(struct device *dev, struct device_attribute *attr,
186 const char *buf, size_t len)
1da177e4 187{
43cb76d9 188 return netdev_store(dev, attr, buf, len, change_mtu);
1da177e4
LT
189}
190
1da177e4
LT
191NETDEVICE_SHOW(flags, fmt_hex);
192
193static int change_flags(struct net_device *net, unsigned long new_flags)
194{
195 return dev_change_flags(net, (unsigned) new_flags);
196}
197
43cb76d9
GKH
198static ssize_t store_flags(struct device *dev, struct device_attribute *attr,
199 const char *buf, size_t len)
1da177e4 200{
43cb76d9 201 return netdev_store(dev, attr, buf, len, change_flags);
1da177e4
LT
202}
203
1da177e4
LT
204NETDEVICE_SHOW(tx_queue_len, fmt_ulong);
205
206static int change_tx_queue_len(struct net_device *net, unsigned long new_len)
207{
208 net->tx_queue_len = new_len;
209 return 0;
210}
211
43cb76d9
GKH
212static ssize_t store_tx_queue_len(struct device *dev,
213 struct device_attribute *attr,
214 const char *buf, size_t len)
1da177e4 215{
43cb76d9 216 return netdev_store(dev, attr, buf, len, change_tx_queue_len);
1da177e4
LT
217}
218
43cb76d9 219static struct device_attribute net_class_attributes[] = {
fd586bac
KS
220 __ATTR(addr_len, S_IRUGO, show_addr_len, NULL),
221 __ATTR(iflink, S_IRUGO, show_iflink, NULL),
222 __ATTR(ifindex, S_IRUGO, show_ifindex, NULL),
223 __ATTR(features, S_IRUGO, show_features, NULL),
224 __ATTR(type, S_IRUGO, show_type, NULL),
b00055aa 225 __ATTR(link_mode, S_IRUGO, show_link_mode, NULL),
fd586bac
KS
226 __ATTR(address, S_IRUGO, show_address, NULL),
227 __ATTR(broadcast, S_IRUGO, show_broadcast, NULL),
228 __ATTR(carrier, S_IRUGO, show_carrier, NULL),
b00055aa
SR
229 __ATTR(dormant, S_IRUGO, show_dormant, NULL),
230 __ATTR(operstate, S_IRUGO, show_operstate, NULL),
fd586bac
KS
231 __ATTR(mtu, S_IRUGO | S_IWUSR, show_mtu, store_mtu),
232 __ATTR(flags, S_IRUGO | S_IWUSR, show_flags, store_flags),
233 __ATTR(tx_queue_len, S_IRUGO | S_IWUSR, show_tx_queue_len,
234 store_tx_queue_len),
fd586bac 235 {}
1da177e4
LT
236};
237
238/* Show a given an attribute in the statistics group */
43cb76d9
GKH
239static ssize_t netstat_show(const struct device *d,
240 struct device_attribute *attr, char *buf,
1da177e4
LT
241 unsigned long offset)
242{
43cb76d9 243 struct net_device *dev = to_net_dev(d);
1da177e4
LT
244 struct net_device_stats *stats;
245 ssize_t ret = -EINVAL;
246
247 if (offset > sizeof(struct net_device_stats) ||
248 offset % sizeof(unsigned long) != 0)
249 WARN_ON(1);
250
251 read_lock(&dev_base_lock);
252 if (dev_isalive(dev) && dev->get_stats &&
4ec93edb 253 (stats = (*dev->get_stats)(dev)))
1da177e4
LT
254 ret = sprintf(buf, fmt_ulong,
255 *(unsigned long *)(((u8 *) stats) + offset));
256
257 read_unlock(&dev_base_lock);
258 return ret;
259}
260
261/* generate a read-only statistics attribute */
262#define NETSTAT_ENTRY(name) \
43cb76d9
GKH
263static ssize_t show_##name(struct device *d, \
264 struct device_attribute *attr, char *buf) \
1da177e4 265{ \
43cb76d9 266 return netstat_show(d, attr, buf, \
1da177e4
LT
267 offsetof(struct net_device_stats, name)); \
268} \
43cb76d9 269static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
1da177e4
LT
270
271NETSTAT_ENTRY(rx_packets);
272NETSTAT_ENTRY(tx_packets);
273NETSTAT_ENTRY(rx_bytes);
274NETSTAT_ENTRY(tx_bytes);
275NETSTAT_ENTRY(rx_errors);
276NETSTAT_ENTRY(tx_errors);
277NETSTAT_ENTRY(rx_dropped);
278NETSTAT_ENTRY(tx_dropped);
279NETSTAT_ENTRY(multicast);
280NETSTAT_ENTRY(collisions);
281NETSTAT_ENTRY(rx_length_errors);
282NETSTAT_ENTRY(rx_over_errors);
283NETSTAT_ENTRY(rx_crc_errors);
284NETSTAT_ENTRY(rx_frame_errors);
285NETSTAT_ENTRY(rx_fifo_errors);
286NETSTAT_ENTRY(rx_missed_errors);
287NETSTAT_ENTRY(tx_aborted_errors);
288NETSTAT_ENTRY(tx_carrier_errors);
289NETSTAT_ENTRY(tx_fifo_errors);
290NETSTAT_ENTRY(tx_heartbeat_errors);
291NETSTAT_ENTRY(tx_window_errors);
292NETSTAT_ENTRY(rx_compressed);
293NETSTAT_ENTRY(tx_compressed);
294
295static struct attribute *netstat_attrs[] = {
43cb76d9
GKH
296 &dev_attr_rx_packets.attr,
297 &dev_attr_tx_packets.attr,
298 &dev_attr_rx_bytes.attr,
299 &dev_attr_tx_bytes.attr,
300 &dev_attr_rx_errors.attr,
301 &dev_attr_tx_errors.attr,
302 &dev_attr_rx_dropped.attr,
303 &dev_attr_tx_dropped.attr,
304 &dev_attr_multicast.attr,
305 &dev_attr_collisions.attr,
306 &dev_attr_rx_length_errors.attr,
307 &dev_attr_rx_over_errors.attr,
308 &dev_attr_rx_crc_errors.attr,
309 &dev_attr_rx_frame_errors.attr,
310 &dev_attr_rx_fifo_errors.attr,
311 &dev_attr_rx_missed_errors.attr,
312 &dev_attr_tx_aborted_errors.attr,
313 &dev_attr_tx_carrier_errors.attr,
314 &dev_attr_tx_fifo_errors.attr,
315 &dev_attr_tx_heartbeat_errors.attr,
316 &dev_attr_tx_window_errors.attr,
317 &dev_attr_rx_compressed.attr,
318 &dev_attr_tx_compressed.attr,
1da177e4
LT
319 NULL
320};
321
322
323static struct attribute_group netstat_group = {
324 .name = "statistics",
325 .attrs = netstat_attrs,
326};
327
9d4a6040 328#ifdef CONFIG_WIRELESS_EXT
1da177e4 329/* helper function that does all the locking etc for wireless stats */
43cb76d9 330static ssize_t wireless_show(struct device *d, char *buf,
1da177e4
LT
331 ssize_t (*format)(const struct iw_statistics *,
332 char *))
333{
43cb76d9 334 struct net_device *dev = to_net_dev(d);
6dd214b5 335 const struct iw_statistics *iw = NULL;
1da177e4 336 ssize_t ret = -EINVAL;
4ec93edb 337
1da177e4 338 read_lock(&dev_base_lock);
6dd214b5 339 if (dev_isalive(dev)) {
e71a4783
SH
340 if (dev->wireless_handlers &&
341 dev->wireless_handlers->get_wireless_stats)
6dd214b5 342 iw = dev->wireless_handlers->get_wireless_stats(dev);
6dd214b5
AB
343 if (iw != NULL)
344 ret = (*format)(iw, buf);
345 }
1da177e4
LT
346 read_unlock(&dev_base_lock);
347
348 return ret;
349}
350
351/* show function template for wireless fields */
352#define WIRELESS_SHOW(name, field, format_string) \
353static ssize_t format_iw_##name(const struct iw_statistics *iw, char *buf) \
354{ \
355 return sprintf(buf, format_string, iw->field); \
356} \
43cb76d9
GKH
357static ssize_t show_iw_##name(struct device *d, \
358 struct device_attribute *attr, char *buf) \
1da177e4 359{ \
43cb76d9 360 return wireless_show(d, buf, format_iw_##name); \
1da177e4 361} \
43cb76d9 362static DEVICE_ATTR(name, S_IRUGO, show_iw_##name, NULL)
1da177e4
LT
363
364WIRELESS_SHOW(status, status, fmt_hex);
365WIRELESS_SHOW(link, qual.qual, fmt_dec);
366WIRELESS_SHOW(level, qual.level, fmt_dec);
367WIRELESS_SHOW(noise, qual.noise, fmt_dec);
368WIRELESS_SHOW(nwid, discard.nwid, fmt_dec);
369WIRELESS_SHOW(crypt, discard.code, fmt_dec);
370WIRELESS_SHOW(fragment, discard.fragment, fmt_dec);
371WIRELESS_SHOW(misc, discard.misc, fmt_dec);
372WIRELESS_SHOW(retries, discard.retries, fmt_dec);
373WIRELESS_SHOW(beacon, miss.beacon, fmt_dec);
374
375static struct attribute *wireless_attrs[] = {
43cb76d9
GKH
376 &dev_attr_status.attr,
377 &dev_attr_link.attr,
378 &dev_attr_level.attr,
379 &dev_attr_noise.attr,
380 &dev_attr_nwid.attr,
381 &dev_attr_crypt.attr,
382 &dev_attr_fragment.attr,
383 &dev_attr_retries.attr,
384 &dev_attr_misc.attr,
385 &dev_attr_beacon.attr,
1da177e4
LT
386 NULL
387};
388
389static struct attribute_group wireless_group = {
390 .name = "wireless",
391 .attrs = wireless_attrs,
392};
393#endif
394
395#ifdef CONFIG_HOTPLUG
43cb76d9 396static int netdev_uevent(struct device *d, char **envp,
312c004d 397 int num_envp, char *buf, int size)
1da177e4 398{
43cb76d9 399 struct net_device *dev = to_net_dev(d);
bf62456e 400 int retval, len = 0, i = 0;
1da177e4 401
312c004d 402 /* pass interface to uevent. */
bf62456e
ER
403 retval = add_uevent_var(envp, num_envp, &i,
404 buf, size, &len,
405 "INTERFACE=%s", dev->name);
406 if (retval)
407 goto exit;
ca2f37db
JT
408
409 /* pass ifindex to uevent.
410 * ifindex is useful as it won't change (interface name may change)
411 * and is what RtNetlink uses natively. */
bf62456e
ER
412 retval = add_uevent_var(envp, num_envp, &i,
413 buf, size, &len,
414 "IFINDEX=%d", dev->ifindex);
1da177e4 415
bf62456e 416exit:
1da177e4 417 envp[i] = NULL;
bf62456e 418 return retval;
1da177e4
LT
419}
420#endif
421
422/*
4ec93edb 423 * netdev_release -- destroy and free a dead device.
43cb76d9 424 * Called when last reference to device kobject is gone.
1da177e4 425 */
43cb76d9 426static void netdev_release(struct device *d)
1da177e4 427{
43cb76d9 428 struct net_device *dev = to_net_dev(d);
1da177e4
LT
429
430 BUG_ON(dev->reg_state != NETREG_RELEASED);
431
432 kfree((char *)dev - dev->padded);
433}
434
435static struct class net_class = {
436 .name = "net",
43cb76d9
GKH
437 .dev_release = netdev_release,
438 .dev_attrs = net_class_attributes,
1da177e4 439#ifdef CONFIG_HOTPLUG
43cb76d9 440 .dev_uevent = netdev_uevent,
1da177e4
LT
441#endif
442};
443
9093bbb2
SH
444/* Delete sysfs entries but hold kobject reference until after all
445 * netdev references are gone.
446 */
1da177e4
LT
447void netdev_unregister_sysfs(struct net_device * net)
448{
9093bbb2
SH
449 struct device *dev = &(net->dev);
450
451 kobject_get(&dev->kobj);
452 device_del(dev);
1da177e4
LT
453}
454
455/* Create sysfs entries for network device. */
456int netdev_register_sysfs(struct net_device *net)
457{
43cb76d9 458 struct device *dev = &(net->dev);
fe9925b5 459 struct attribute_group **groups = net->sysfs_groups;
1da177e4 460
43cb76d9
GKH
461 device_initialize(dev);
462 dev->class = &net_class;
463 dev->platform_data = net;
464 dev->groups = groups;
1da177e4 465
fe9925b5 466 BUILD_BUG_ON(BUS_ID_SIZE < IFNAMSIZ);
43cb76d9 467 strlcpy(dev->bus_id, net->name, BUS_ID_SIZE);
1da177e4 468
fe9925b5
SH
469 if (net->get_stats)
470 *groups++ = &netstat_group;
1da177e4 471
9d4a6040 472#ifdef CONFIG_WIRELESS_EXT
baef1865 473 if (net->wireless_handlers && net->wireless_handlers->get_wireless_stats)
fe9925b5 474 *groups++ = &wireless_group;
1da177e4
LT
475#endif
476
43cb76d9 477 return device_add(dev);
1da177e4
LT
478}
479
480int netdev_sysfs_init(void)
481{
482 return class_register(&net_class);
483}