net-sysfs.c 12.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
/*
 * net-sysfs.c - network device class and attributes
 *
 * Copyright (c) 2003 Stephen Hemminger <shemminger@osdl.org>
5
 *
L
Linus Torvalds 已提交
6 7 8 9 10 11
 *	This program is free software; you can redistribute it and/or
 *	modify it under the terms of the GNU General Public License
 *	as published by the Free Software Foundation; either version
 *	2 of the License, or (at your option) any later version.
 */

12
#include <linux/capability.h>
L
Linus Torvalds 已提交
13 14 15 16 17 18
#include <linux/kernel.h>
#include <linux/netdevice.h>
#include <linux/if_arp.h>
#include <net/sock.h>
#include <linux/rtnetlink.h>
#include <linux/wireless.h>
19
#include <net/iw_handler.h>
L
Linus Torvalds 已提交
20 21

static const char fmt_hex[] = "%#x\n";
22
static const char fmt_long_hex[] = "%#lx\n";
L
Linus Torvalds 已提交
23 24 25
static const char fmt_dec[] = "%d\n";
static const char fmt_ulong[] = "%lu\n";

26
static inline int dev_isalive(const struct net_device *dev)
L
Linus Torvalds 已提交
27
{
28
	return dev->reg_state <= NETREG_REGISTERED;
L
Linus Torvalds 已提交
29 30 31
}

/* use same locking rules as GIF* ioctl's */
32 33
static ssize_t netdev_show(const struct device *dev,
			   struct device_attribute *attr, char *buf,
L
Linus Torvalds 已提交
34 35
			   ssize_t (*format)(const struct net_device *, char *))
{
36
	struct net_device *net = to_net_dev(dev);
L
Linus Torvalds 已提交
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
	ssize_t ret = -EINVAL;

	read_lock(&dev_base_lock);
	if (dev_isalive(net))
		ret = (*format)(net, buf);
	read_unlock(&dev_base_lock);

	return ret;
}

/* generate a show function for simple field */
#define NETDEVICE_SHOW(field, format_string)				\
static ssize_t format_##field(const struct net_device *net, char *buf)	\
{									\
	return sprintf(buf, format_string, net->field);			\
}									\
53 54
static ssize_t show_##field(struct device *dev,				\
			    struct device_attribute *attr, char *buf)	\
L
Linus Torvalds 已提交
55
{									\
56
	return netdev_show(dev, attr, buf, format_##field);		\
L
Linus Torvalds 已提交
57 58 59 60
}


/* use same locking and permission rules as SIF* ioctl's */
61
static ssize_t netdev_store(struct device *dev, struct device_attribute *attr,
L
Linus Torvalds 已提交
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
			    const char *buf, size_t len,
			    int (*set)(struct net_device *, unsigned long))
{
	struct net_device *net = to_net_dev(dev);
	char *endp;
	unsigned long new;
	int ret = -EINVAL;

	if (!capable(CAP_NET_ADMIN))
		return -EPERM;

	new = simple_strtoul(buf, &endp, 0);
	if (endp == buf)
		goto err;

	rtnl_lock();
	if (dev_isalive(net)) {
		if ((ret = (*set)(net, new)) == 0)
			ret = len;
	}
	rtnl_unlock();
 err:
	return ret;
}

87 88 89 90 91
NETDEVICE_SHOW(addr_len, fmt_dec);
NETDEVICE_SHOW(iflink, fmt_dec);
NETDEVICE_SHOW(ifindex, fmt_dec);
NETDEVICE_SHOW(features, fmt_long_hex);
NETDEVICE_SHOW(type, fmt_dec);
S
Stefan Rompf 已提交
92
NETDEVICE_SHOW(link_mode, fmt_dec);
L
Linus Torvalds 已提交
93 94 95 96 97 98 99 100 101 102 103 104 105

/* use same locking rules as GIFHWADDR ioctl's */
static ssize_t format_addr(char *buf, const unsigned char *addr, int len)
{
	int i;
	char *cp = buf;

	for (i = 0; i < len; i++)
		cp += sprintf(cp, "%02x%c", addr[i],
			      i == (len - 1) ? '\n' : ':');
	return cp - buf;
}

106 107
static ssize_t show_address(struct device *dev, struct device_attribute *attr,
			    char *buf)
L
Linus Torvalds 已提交
108 109 110 111 112 113 114 115 116 117 118
{
	struct net_device *net = to_net_dev(dev);
	ssize_t ret = -EINVAL;

	read_lock(&dev_base_lock);
	if (dev_isalive(net))
	    ret = format_addr(buf, net->dev_addr, net->addr_len);
	read_unlock(&dev_base_lock);
	return ret;
}

119 120
static ssize_t show_broadcast(struct device *dev,
			    struct device_attribute *attr, char *buf)
L
Linus Torvalds 已提交
121 122 123 124 125 126 127
{
	struct net_device *net = to_net_dev(dev);
	if (dev_isalive(net))
		return format_addr(buf, net->broadcast, net->addr_len);
	return -EINVAL;
}

128 129
static ssize_t show_carrier(struct device *dev,
			    struct device_attribute *attr, char *buf)
L
Linus Torvalds 已提交
130 131 132 133 134 135 136 137
{
	struct net_device *netdev = to_net_dev(dev);
	if (netif_running(netdev)) {
		return sprintf(buf, fmt_dec, !!netif_carrier_ok(netdev));
	}
	return -EINVAL;
}

138 139
static ssize_t show_dormant(struct device *dev,
			    struct device_attribute *attr, char *buf)
S
Stefan Rompf 已提交
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
{
	struct net_device *netdev = to_net_dev(dev);

	if (netif_running(netdev))
		return sprintf(buf, fmt_dec, !!netif_dormant(netdev));

	return -EINVAL;
}

static const char *operstates[] = {
	"unknown",
	"notpresent", /* currently unused */
	"down",
	"lowerlayerdown",
	"testing", /* currently unused */
	"dormant",
	"up"
};

159 160
static ssize_t show_operstate(struct device *dev,
			      struct device_attribute *attr, char *buf)
S
Stefan Rompf 已提交
161 162 163 164 165 166 167 168 169 170
{
	const struct net_device *netdev = to_net_dev(dev);
	unsigned char operstate;

	read_lock(&dev_base_lock);
	operstate = netdev->operstate;
	if (!netif_running(netdev))
		operstate = IF_OPER_DOWN;
	read_unlock(&dev_base_lock);

171
	if (operstate >= ARRAY_SIZE(operstates))
S
Stefan Rompf 已提交
172 173 174 175 176
		return -EINVAL; /* should not happen */

	return sprintf(buf, "%s\n", operstates[operstate]);
}

L
Linus Torvalds 已提交
177 178 179 180 181 182 183 184
/* read-write attributes */
NETDEVICE_SHOW(mtu, fmt_dec);

static int change_mtu(struct net_device *net, unsigned long new_mtu)
{
	return dev_set_mtu(net, (int) new_mtu);
}

185 186
static ssize_t store_mtu(struct device *dev, struct device_attribute *attr,
			 const char *buf, size_t len)
L
Linus Torvalds 已提交
187
{
188
	return netdev_store(dev, attr, buf, len, change_mtu);
L
Linus Torvalds 已提交
189 190 191 192 193 194 195 196 197
}

NETDEVICE_SHOW(flags, fmt_hex);

static int change_flags(struct net_device *net, unsigned long new_flags)
{
	return dev_change_flags(net, (unsigned) new_flags);
}

198 199
static ssize_t store_flags(struct device *dev, struct device_attribute *attr,
			   const char *buf, size_t len)
L
Linus Torvalds 已提交
200
{
201
	return netdev_store(dev, attr, buf, len, change_flags);
L
Linus Torvalds 已提交
202 203 204 205 206 207 208 209 210 211
}

NETDEVICE_SHOW(tx_queue_len, fmt_ulong);

static int change_tx_queue_len(struct net_device *net, unsigned long new_len)
{
	net->tx_queue_len = new_len;
	return 0;
}

212 213 214
static ssize_t store_tx_queue_len(struct device *dev,
				  struct device_attribute *attr,
				  const char *buf, size_t len)
L
Linus Torvalds 已提交
215
{
216
	return netdev_store(dev, attr, buf, len, change_tx_queue_len);
L
Linus Torvalds 已提交
217 218
}

219 220 221 222 223 224 225 226
NETDEVICE_SHOW(weight, fmt_dec);

static int change_weight(struct net_device *net, unsigned long new_weight)
{
	net->weight = new_weight;
	return 0;
}

227 228
static ssize_t store_weight(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t len)
229
{
230
	return netdev_store(dev, attr, buf, len, change_weight);
231 232
}

233
static struct device_attribute net_class_attributes[] = {
234 235 236 237 238
	__ATTR(addr_len, S_IRUGO, show_addr_len, NULL),
	__ATTR(iflink, S_IRUGO, show_iflink, NULL),
	__ATTR(ifindex, S_IRUGO, show_ifindex, NULL),
	__ATTR(features, S_IRUGO, show_features, NULL),
	__ATTR(type, S_IRUGO, show_type, NULL),
S
Stefan Rompf 已提交
239
	__ATTR(link_mode, S_IRUGO, show_link_mode, NULL),
240 241 242
	__ATTR(address, S_IRUGO, show_address, NULL),
	__ATTR(broadcast, S_IRUGO, show_broadcast, NULL),
	__ATTR(carrier, S_IRUGO, show_carrier, NULL),
S
Stefan Rompf 已提交
243 244
	__ATTR(dormant, S_IRUGO, show_dormant, NULL),
	__ATTR(operstate, S_IRUGO, show_operstate, NULL),
245 246 247 248 249 250
	__ATTR(mtu, S_IRUGO | S_IWUSR, show_mtu, store_mtu),
	__ATTR(flags, S_IRUGO | S_IWUSR, show_flags, store_flags),
	__ATTR(tx_queue_len, S_IRUGO | S_IWUSR, show_tx_queue_len,
	       store_tx_queue_len),
	__ATTR(weight, S_IRUGO | S_IWUSR, show_weight, store_weight),
	{}
L
Linus Torvalds 已提交
251 252 253
};

/* Show a given an attribute in the statistics group */
254 255
static ssize_t netstat_show(const struct device *d,
			    struct device_attribute *attr, char *buf,
L
Linus Torvalds 已提交
256 257
			    unsigned long offset)
{
258
	struct net_device *dev = to_net_dev(d);
L
Linus Torvalds 已提交
259 260 261 262 263 264 265 266 267
	struct net_device_stats *stats;
	ssize_t ret = -EINVAL;

	if (offset > sizeof(struct net_device_stats) ||
	    offset % sizeof(unsigned long) != 0)
		WARN_ON(1);

	read_lock(&dev_base_lock);
	if (dev_isalive(dev) && dev->get_stats &&
268
	    (stats = (*dev->get_stats)(dev)))
L
Linus Torvalds 已提交
269 270 271 272 273 274 275 276 277
		ret = sprintf(buf, fmt_ulong,
			      *(unsigned long *)(((u8 *) stats) + offset));

	read_unlock(&dev_base_lock);
	return ret;
}

/* generate a read-only statistics attribute */
#define NETSTAT_ENTRY(name)						\
278 279
static ssize_t show_##name(struct device *d,				\
			   struct device_attribute *attr, char *buf) 	\
L
Linus Torvalds 已提交
280
{									\
281
	return netstat_show(d, attr, buf,				\
L
Linus Torvalds 已提交
282 283
			    offsetof(struct net_device_stats, name));	\
}									\
284
static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
L
Linus Torvalds 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310

NETSTAT_ENTRY(rx_packets);
NETSTAT_ENTRY(tx_packets);
NETSTAT_ENTRY(rx_bytes);
NETSTAT_ENTRY(tx_bytes);
NETSTAT_ENTRY(rx_errors);
NETSTAT_ENTRY(tx_errors);
NETSTAT_ENTRY(rx_dropped);
NETSTAT_ENTRY(tx_dropped);
NETSTAT_ENTRY(multicast);
NETSTAT_ENTRY(collisions);
NETSTAT_ENTRY(rx_length_errors);
NETSTAT_ENTRY(rx_over_errors);
NETSTAT_ENTRY(rx_crc_errors);
NETSTAT_ENTRY(rx_frame_errors);
NETSTAT_ENTRY(rx_fifo_errors);
NETSTAT_ENTRY(rx_missed_errors);
NETSTAT_ENTRY(tx_aborted_errors);
NETSTAT_ENTRY(tx_carrier_errors);
NETSTAT_ENTRY(tx_fifo_errors);
NETSTAT_ENTRY(tx_heartbeat_errors);
NETSTAT_ENTRY(tx_window_errors);
NETSTAT_ENTRY(rx_compressed);
NETSTAT_ENTRY(tx_compressed);

static struct attribute *netstat_attrs[] = {
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
	&dev_attr_rx_packets.attr,
	&dev_attr_tx_packets.attr,
	&dev_attr_rx_bytes.attr,
	&dev_attr_tx_bytes.attr,
	&dev_attr_rx_errors.attr,
	&dev_attr_tx_errors.attr,
	&dev_attr_rx_dropped.attr,
	&dev_attr_tx_dropped.attr,
	&dev_attr_multicast.attr,
	&dev_attr_collisions.attr,
	&dev_attr_rx_length_errors.attr,
	&dev_attr_rx_over_errors.attr,
	&dev_attr_rx_crc_errors.attr,
	&dev_attr_rx_frame_errors.attr,
	&dev_attr_rx_fifo_errors.attr,
	&dev_attr_rx_missed_errors.attr,
	&dev_attr_tx_aborted_errors.attr,
	&dev_attr_tx_carrier_errors.attr,
	&dev_attr_tx_fifo_errors.attr,
	&dev_attr_tx_heartbeat_errors.attr,
	&dev_attr_tx_window_errors.attr,
	&dev_attr_rx_compressed.attr,
	&dev_attr_tx_compressed.attr,
L
Linus Torvalds 已提交
334 335 336 337 338 339 340 341 342
	NULL
};


static struct attribute_group netstat_group = {
	.name  = "statistics",
	.attrs  = netstat_attrs,
};

343
#ifdef CONFIG_WIRELESS_EXT
L
Linus Torvalds 已提交
344
/* helper function that does all the locking etc for wireless stats */
345
static ssize_t wireless_show(struct device *d, char *buf,
L
Linus Torvalds 已提交
346 347 348
			     ssize_t (*format)(const struct iw_statistics *,
					       char *))
{
349
	struct net_device *dev = to_net_dev(d);
350
	const struct iw_statistics *iw = NULL;
L
Linus Torvalds 已提交
351
	ssize_t ret = -EINVAL;
352

L
Linus Torvalds 已提交
353
	read_lock(&dev_base_lock);
354
	if (dev_isalive(dev)) {
355 356
		if (dev->wireless_handlers &&
		    dev->wireless_handlers->get_wireless_stats)
357 358 359 360
			iw = dev->wireless_handlers->get_wireless_stats(dev);
		if (iw != NULL)
			ret = (*format)(iw, buf);
	}
L
Linus Torvalds 已提交
361 362 363 364 365 366 367 368 369 370 371
	read_unlock(&dev_base_lock);

	return ret;
}

/* show function template for wireless fields */
#define WIRELESS_SHOW(name, field, format_string)			\
static ssize_t format_iw_##name(const struct iw_statistics *iw, char *buf) \
{									\
	return sprintf(buf, format_string, iw->field);			\
}									\
372 373
static ssize_t show_iw_##name(struct device *d,				\
			      struct device_attribute *attr, char *buf)	\
L
Linus Torvalds 已提交
374
{									\
375
	return wireless_show(d, buf, format_iw_##name);			\
L
Linus Torvalds 已提交
376
}									\
377
static DEVICE_ATTR(name, S_IRUGO, show_iw_##name, NULL)
L
Linus Torvalds 已提交
378 379 380 381 382 383 384 385 386 387 388 389 390

WIRELESS_SHOW(status, status, fmt_hex);
WIRELESS_SHOW(link, qual.qual, fmt_dec);
WIRELESS_SHOW(level, qual.level, fmt_dec);
WIRELESS_SHOW(noise, qual.noise, fmt_dec);
WIRELESS_SHOW(nwid, discard.nwid, fmt_dec);
WIRELESS_SHOW(crypt, discard.code, fmt_dec);
WIRELESS_SHOW(fragment, discard.fragment, fmt_dec);
WIRELESS_SHOW(misc, discard.misc, fmt_dec);
WIRELESS_SHOW(retries, discard.retries, fmt_dec);
WIRELESS_SHOW(beacon, miss.beacon, fmt_dec);

static struct attribute *wireless_attrs[] = {
391 392 393 394 395 396 397 398 399 400
	&dev_attr_status.attr,
	&dev_attr_link.attr,
	&dev_attr_level.attr,
	&dev_attr_noise.attr,
	&dev_attr_nwid.attr,
	&dev_attr_crypt.attr,
	&dev_attr_fragment.attr,
	&dev_attr_retries.attr,
	&dev_attr_misc.attr,
	&dev_attr_beacon.attr,
L
Linus Torvalds 已提交
401 402 403 404 405 406 407 408 409 410
	NULL
};

static struct attribute_group wireless_group = {
	.name = "wireless",
	.attrs = wireless_attrs,
};
#endif

#ifdef CONFIG_HOTPLUG
411
static int netdev_uevent(struct device *d, char **envp,
412
			 int num_envp, char *buf, int size)
L
Linus Torvalds 已提交
413
{
414
	struct net_device *dev = to_net_dev(d);
415
	int retval, len = 0, i = 0;
L
Linus Torvalds 已提交
416

417
	/* pass interface to uevent. */
418 419 420 421 422
	retval = add_uevent_var(envp, num_envp, &i,
				buf, size, &len,
				"INTERFACE=%s", dev->name);
	if (retval)
		goto exit;
423 424 425 426

	/* pass ifindex to uevent.
	 * ifindex is useful as it won't change (interface name may change)
	 * and is what RtNetlink uses natively. */
427 428 429
	retval = add_uevent_var(envp, num_envp, &i,
				buf, size, &len,
				"IFINDEX=%d", dev->ifindex);
L
Linus Torvalds 已提交
430

431
exit:
L
Linus Torvalds 已提交
432
	envp[i] = NULL;
433
	return retval;
L
Linus Torvalds 已提交
434 435 436 437
}
#endif

/*
438
 *	netdev_release -- destroy and free a dead device.
439
 *	Called when last reference to device kobject is gone.
L
Linus Torvalds 已提交
440
 */
441
static void netdev_release(struct device *d)
L
Linus Torvalds 已提交
442
{
443
	struct net_device *dev = to_net_dev(d);
L
Linus Torvalds 已提交
444 445 446 447 448 449 450 451

	BUG_ON(dev->reg_state != NETREG_RELEASED);

	kfree((char *)dev - dev->padded);
}

static struct class net_class = {
	.name = "net",
452 453
	.dev_release = netdev_release,
	.dev_attrs = net_class_attributes,
L
Linus Torvalds 已提交
454
#ifdef CONFIG_HOTPLUG
455
	.dev_uevent = netdev_uevent,
L
Linus Torvalds 已提交
456 457 458 459 460
#endif
};

void netdev_unregister_sysfs(struct net_device * net)
{
461
	device_del(&(net->dev));
L
Linus Torvalds 已提交
462 463 464 465 466
}

/* Create sysfs entries for network device. */
int netdev_register_sysfs(struct net_device *net)
{
467
	struct device *dev = &(net->dev);
468
	struct attribute_group **groups = net->sysfs_groups;
L
Linus Torvalds 已提交
469

470 471 472 473
	device_initialize(dev);
	dev->class = &net_class;
	dev->platform_data = net;
	dev->groups = groups;
L
Linus Torvalds 已提交
474

475
	BUILD_BUG_ON(BUS_ID_SIZE < IFNAMSIZ);
476
	strlcpy(dev->bus_id, net->name, BUS_ID_SIZE);
L
Linus Torvalds 已提交
477

478 479
	if (net->get_stats)
		*groups++ = &netstat_group;
L
Linus Torvalds 已提交
480

481
#ifdef CONFIG_WIRELESS_EXT
482
	if (net->wireless_handlers && net->wireless_handlers->get_wireless_stats)
483
		*groups++ = &wireless_group;
L
Linus Torvalds 已提交
484 485
#endif

486
	return device_add(dev);
L
Linus Torvalds 已提交
487 488 489 490 491 492
}

int netdev_sysfs_init(void)
{
	return class_register(&net_class);
}