net/core/net-sysfs.c

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