net-sysfs.c 13 KB

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