net/mac80211/debugfs_netdev.c

   1 /*
   2  * Copyright (c) 2006   Jiri Benc <jbenc@suse.cz>
   3  * Copyright 2007       Johannes Berg <johannes@sipsolutions.net>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  */
   9
  10 #include <linux/kernel.h>
  11 #include <linux/device.h>
  12 #include <linux/if.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/netdevice.h>
  15 #include <linux/rtnetlink.h>
  16 #include <linux/notifier.h>
  17 #include <net/mac80211.h>
  18 #include <net/cfg80211.h>
  19 #include "ieee80211_i.h"
  20 #include "rate.h"
  21 #include "debugfs.h"
  22 #include "debugfs_netdev.h"
  23
  24 static ssize_t ieee80211_if_read(
  25         struct ieee80211_sub_if_data *sdata,
  26         char __user *userbuf,
  27         size_t count, loff_t *ppos,
  28         ssize_t (*format)(const struct ieee80211_sub_if_data *, char *, int))
  29 {
  30         char buf[70];
  31         ssize_t ret = -EINVAL;
  32
  33         read_lock(&dev_base_lock);
  34         if (sdata->dev->reg_state == NETREG_REGISTERED)
  35                 ret = (*format)(sdata, buf, sizeof(buf));
  36         read_unlock(&dev_base_lock);
  37
  38         if (ret != -EINVAL)
  39                 ret = simple_read_from_buffer(userbuf, count, ppos, buf, ret);
  40
  41         return ret;
  42 }
  43
  44 #define IEEE80211_IF_FMT(name, field, format_string)                    \
  45 static ssize_t ieee80211_if_fmt_##name(                                 \
  46         const struct ieee80211_sub_if_data *sdata, char *buf,           \
  47         int buflen)                                                     \
  48 {                                                                       \
  49         return scnprintf(buf, buflen, format_string, sdata->field);     \
  50 }
  51 #define IEEE80211_IF_FMT_DEC(name, field)                               \
  52                 IEEE80211_IF_FMT(name, field, "%d\n")
  53 #define IEEE80211_IF_FMT_HEX(name, field)                               \
  54                 IEEE80211_IF_FMT(name, field, "%#x\n")
  55 #define IEEE80211_IF_FMT_SIZE(name, field)                              \
  56                 IEEE80211_IF_FMT(name, field, "%zd\n")
  57
  58 #define IEEE80211_IF_FMT_ATOMIC(name, field)                            \
  59 static ssize_t ieee80211_if_fmt_##name(                                 \
  60         const struct ieee80211_sub_if_data *sdata,                      \
  61         char *buf, int buflen)                                          \
  62 {                                                                       \
  63         return scnprintf(buf, buflen, "%d\n", atomic_read(&sdata->field));\
  64 }
  65
  66 #define IEEE80211_IF_FMT_MAC(name, field)                               \
  67 static ssize_t ieee80211_if_fmt_##name(                                 \
  68         const struct ieee80211_sub_if_data *sdata, char *buf,           \
  69         int buflen)                                                     \
  70 {                                                                       \
  71         return scnprintf(buf, buflen, "%pM\n", sdata->field);           \
  72 }
  73
  74 #define __IEEE80211_IF_FILE(name)                                       \
  75 static ssize_t ieee80211_if_read_##name(struct file *file,              \
  76                                         char __user *userbuf,           \
  77                                         size_t count, loff_t *ppos)     \
  78 {                                                                       \
  79         return ieee80211_if_read(file->private_data,                    \
  80                                  userbuf, count, ppos,                  \
  81                                  ieee80211_if_fmt_##name);              \
  82 }                                                                       \
  83 static const struct file_operations name##_ops = {                      \
  84         .read = ieee80211_if_read_##name,                               \
  85         .open = mac80211_open_file_generic,                             \
  86 }
  87
  88 #define IEEE80211_IF_FILE(name, field, format)                          \
  89                 IEEE80211_IF_FMT_##format(name, field)                  \
  90                 __IEEE80211_IF_FILE(name)
  91
  92 /* common attributes */
  93 IEEE80211_IF_FILE(drop_unencrypted, drop_unencrypted, DEC);
  94 IEEE80211_IF_FILE(force_unicast_rateidx, force_unicast_rateidx, DEC);
  95 IEEE80211_IF_FILE(max_ratectrl_rateidx, max_ratectrl_rateidx, DEC);
  96
  97 /* STA attributes */
  98 IEEE80211_IF_FILE(bssid, u.mgd.bssid, MAC);
  99 IEEE80211_IF_FILE(aid, u.mgd.aid, DEC);
 100 IEEE80211_IF_FILE(capab, u.mgd.capab, HEX);
 101
 102 /* AP attributes */
 103 IEEE80211_IF_FILE(num_sta_ps, u.ap.num_sta_ps, ATOMIC);
 104 IEEE80211_IF_FILE(dtim_count, u.ap.dtim_count, DEC);
 105
 106 static ssize_t ieee80211_if_fmt_num_buffered_multicast(
 107         const struct ieee80211_sub_if_data *sdata, char *buf, int buflen)
 108 {
 109         return scnprintf(buf, buflen, "%u\n",
 110                          skb_queue_len(&sdata->u.ap.ps_bc_buf));
 111 }
 112 __IEEE80211_IF_FILE(num_buffered_multicast);
 113
 114 /* WDS attributes */
 115 IEEE80211_IF_FILE(peer, u.wds.remote_addr, MAC);
 116
 117 #ifdef CONFIG_MAC80211_MESH
 118 /* Mesh stats attributes */
 119 IEEE80211_IF_FILE(fwded_frames, u.mesh.mshstats.fwded_frames, DEC);
 120 IEEE80211_IF_FILE(dropped_frames_ttl, u.mesh.mshstats.dropped_frames_ttl, DEC);
 121 IEEE80211_IF_FILE(dropped_frames_no_route,
 122                 u.mesh.mshstats.dropped_frames_no_route, DEC);
 123 IEEE80211_IF_FILE(estab_plinks, u.mesh.mshstats.estab_plinks, ATOMIC);
 124
 125 /* Mesh parameters */
 126 IEEE80211_IF_FILE(dot11MeshMaxRetries,
 127                 u.mesh.mshcfg.dot11MeshMaxRetries, DEC);
 128 IEEE80211_IF_FILE(dot11MeshRetryTimeout,
 129                 u.mesh.mshcfg.dot11MeshRetryTimeout, DEC);
 130 IEEE80211_IF_FILE(dot11MeshConfirmTimeout,
 131                 u.mesh.mshcfg.dot11MeshConfirmTimeout, DEC);
 132 IEEE80211_IF_FILE(dot11MeshHoldingTimeout,
 133                 u.mesh.mshcfg.dot11MeshHoldingTimeout, DEC);
 134 IEEE80211_IF_FILE(dot11MeshTTL, u.mesh.mshcfg.dot11MeshTTL, DEC);
 135 IEEE80211_IF_FILE(auto_open_plinks, u.mesh.mshcfg.auto_open_plinks, DEC);
 136 IEEE80211_IF_FILE(dot11MeshMaxPeerLinks,
 137                 u.mesh.mshcfg.dot11MeshMaxPeerLinks, DEC);
 138 IEEE80211_IF_FILE(dot11MeshHWMPactivePathTimeout,
 139                 u.mesh.mshcfg.dot11MeshHWMPactivePathTimeout, DEC);
 140 IEEE80211_IF_FILE(dot11MeshHWMPpreqMinInterval,
 141                 u.mesh.mshcfg.dot11MeshHWMPpreqMinInterval, DEC);
 142 IEEE80211_IF_FILE(dot11MeshHWMPnetDiameterTraversalTime,
 143                 u.mesh.mshcfg.dot11MeshHWMPnetDiameterTraversalTime, DEC);
 144 IEEE80211_IF_FILE(dot11MeshHWMPmaxPREQretries,
 145                 u.mesh.mshcfg.dot11MeshHWMPmaxPREQretries, DEC);
 146 IEEE80211_IF_FILE(path_refresh_time,
 147                 u.mesh.mshcfg.path_refresh_time, DEC);
 148 IEEE80211_IF_FILE(min_discovery_timeout,
 149                 u.mesh.mshcfg.min_discovery_timeout, DEC);
 150 #endif
 151
 152
 153 #define DEBUGFS_ADD(name, type)\
 154         sdata->debugfs.type.name = debugfs_create_file(#name, 0400,\
 155                 sdata->debugfsdir, sdata, &name##_ops);
 156
 157 static void add_sta_files(struct ieee80211_sub_if_data *sdata)
 158 {
 159         DEBUGFS_ADD(drop_unencrypted, sta);
 160         DEBUGFS_ADD(force_unicast_rateidx, sta);
 161         DEBUGFS_ADD(max_ratectrl_rateidx, sta);
 162
 163         DEBUGFS_ADD(bssid, sta);
 164         DEBUGFS_ADD(aid, sta);
 165         DEBUGFS_ADD(capab, sta);
 166 }
 167
 168 static void add_ap_files(struct ieee80211_sub_if_data *sdata)
 169 {
 170         DEBUGFS_ADD(drop_unencrypted, ap);
 171         DEBUGFS_ADD(force_unicast_rateidx, ap);
 172         DEBUGFS_ADD(max_ratectrl_rateidx, ap);
 173
 174         DEBUGFS_ADD(num_sta_ps, ap);
 175         DEBUGFS_ADD(dtim_count, ap);
 176         DEBUGFS_ADD(num_buffered_multicast, ap);
 177 }
 178
 179 static void add_wds_files(struct ieee80211_sub_if_data *sdata)
 180 {
 181         DEBUGFS_ADD(drop_unencrypted, wds);
 182         DEBUGFS_ADD(force_unicast_rateidx, wds);
 183         DEBUGFS_ADD(max_ratectrl_rateidx, wds);
 184
 185         DEBUGFS_ADD(peer, wds);
 186 }
 187
 188 static void add_vlan_files(struct ieee80211_sub_if_data *sdata)
 189 {
 190         DEBUGFS_ADD(drop_unencrypted, vlan);
 191         DEBUGFS_ADD(force_unicast_rateidx, vlan);
 192         DEBUGFS_ADD(max_ratectrl_rateidx, vlan);
 193 }
 194
 195 static void add_monitor_files(struct ieee80211_sub_if_data *sdata)
 196 {
 197 }
 198
 199 #ifdef CONFIG_MAC80211_MESH
 200 #define MESHSTATS_ADD(name)\
 201         sdata->mesh_stats.name = debugfs_create_file(#name, 0400,\
 202                 sdata->mesh_stats_dir, sdata, &name##_ops);
 203
 204 static void add_mesh_stats(struct ieee80211_sub_if_data *sdata)
 205 {
 206         sdata->mesh_stats_dir = debugfs_create_dir("mesh_stats",
 207                                 sdata->debugfsdir);
 208         MESHSTATS_ADD(fwded_frames);
 209         MESHSTATS_ADD(dropped_frames_ttl);
 210         MESHSTATS_ADD(dropped_frames_no_route);
 211         MESHSTATS_ADD(estab_plinks);
 212 }
 213
 214 #define MESHPARAMS_ADD(name)\
 215         sdata->mesh_config.name = debugfs_create_file(#name, 0600,\
 216                 sdata->mesh_config_dir, sdata, &name##_ops);
 217
 218 static void add_mesh_config(struct ieee80211_sub_if_data *sdata)
 219 {
 220         sdata->mesh_config_dir = debugfs_create_dir("mesh_config",
 221                                 sdata->debugfsdir);
 222         MESHPARAMS_ADD(dot11MeshMaxRetries);
 223         MESHPARAMS_ADD(dot11MeshRetryTimeout);
 224         MESHPARAMS_ADD(dot11MeshConfirmTimeout);
 225         MESHPARAMS_ADD(dot11MeshHoldingTimeout);
 226         MESHPARAMS_ADD(dot11MeshTTL);
 227         MESHPARAMS_ADD(auto_open_plinks);
 228         MESHPARAMS_ADD(dot11MeshMaxPeerLinks);
 229         MESHPARAMS_ADD(dot11MeshHWMPactivePathTimeout);
 230         MESHPARAMS_ADD(dot11MeshHWMPpreqMinInterval);
 231         MESHPARAMS_ADD(dot11MeshHWMPnetDiameterTraversalTime);
 232         MESHPARAMS_ADD(dot11MeshHWMPmaxPREQretries);
 233         MESHPARAMS_ADD(path_refresh_time);
 234         MESHPARAMS_ADD(min_discovery_timeout);
 235 }
 236 #endif
 237
 238 static void add_files(struct ieee80211_sub_if_data *sdata)
 239 {
 240         if (!sdata->debugfsdir)
 241                 return;
 242
 243         switch (sdata->vif.type) {
 244         case NL80211_IFTYPE_MESH_POINT:
 245 #ifdef CONFIG_MAC80211_MESH
 246                 add_mesh_stats(sdata);
 247                 add_mesh_config(sdata);
 248 #endif
 249                 break;
 250         case NL80211_IFTYPE_STATION:
 251                 add_sta_files(sdata);
 252                 break;
 253         case NL80211_IFTYPE_ADHOC:
 254                 /* XXX */
 255                 break;
 256         case NL80211_IFTYPE_AP:
 257                 add_ap_files(sdata);
 258                 break;
 259         case NL80211_IFTYPE_WDS:
 260                 add_wds_files(sdata);
 261                 break;
 262         case NL80211_IFTYPE_MONITOR:
 263                 add_monitor_files(sdata);
 264                 break;
 265         case NL80211_IFTYPE_AP_VLAN:
 266                 add_vlan_files(sdata);
 267                 break;
 268         default:
 269                 break;
 270         }
 271 }
 272
 273 #define DEBUGFS_DEL(name, type)                                 \
 274         do {                                                    \
 275                 debugfs_remove(sdata->debugfs.type.name);       \
 276                 sdata->debugfs.type.name = NULL;                \
 277         } while (0)
 278
 279 static void del_sta_files(struct ieee80211_sub_if_data *sdata)
 280 {
 281         DEBUGFS_DEL(drop_unencrypted, sta);
 282         DEBUGFS_DEL(force_unicast_rateidx, sta);
 283         DEBUGFS_DEL(max_ratectrl_rateidx, sta);
 284
 285         DEBUGFS_DEL(bssid, sta);
 286         DEBUGFS_DEL(aid, sta);
 287         DEBUGFS_DEL(capab, sta);
 288 }
 289
 290 static void del_ap_files(struct ieee80211_sub_if_data *sdata)
 291 {
 292         DEBUGFS_DEL(drop_unencrypted, ap);
 293         DEBUGFS_DEL(force_unicast_rateidx, ap);
 294         DEBUGFS_DEL(max_ratectrl_rateidx, ap);
 295
 296         DEBUGFS_DEL(num_sta_ps, ap);
 297         DEBUGFS_DEL(dtim_count, ap);
 298         DEBUGFS_DEL(num_buffered_multicast, ap);
 299 }
 300
 301 static void del_wds_files(struct ieee80211_sub_if_data *sdata)
 302 {
 303         DEBUGFS_DEL(drop_unencrypted, wds);
 304         DEBUGFS_DEL(force_unicast_rateidx, wds);
 305         DEBUGFS_DEL(max_ratectrl_rateidx, wds);
 306
 307         DEBUGFS_DEL(peer, wds);
 308 }
 309
 310 static void del_vlan_files(struct ieee80211_sub_if_data *sdata)
 311 {
 312         DEBUGFS_DEL(drop_unencrypted, vlan);
 313         DEBUGFS_DEL(force_unicast_rateidx, vlan);
 314         DEBUGFS_DEL(max_ratectrl_rateidx, vlan);
 315 }
 316
 317 static void del_monitor_files(struct ieee80211_sub_if_data *sdata)
 318 {
 319 }
 320
 321 #ifdef CONFIG_MAC80211_MESH
 322 #define MESHSTATS_DEL(name)                     \
 323         do {                                            \
 324                 debugfs_remove(sdata->mesh_stats.name); \
 325                 sdata->mesh_stats.name = NULL;          \
 326         } while (0)
 327
 328 static void del_mesh_stats(struct ieee80211_sub_if_data *sdata)
 329 {
 330         MESHSTATS_DEL(fwded_frames);
 331         MESHSTATS_DEL(dropped_frames_ttl);
 332         MESHSTATS_DEL(dropped_frames_no_route);
 333         MESHSTATS_DEL(estab_plinks);
 334         debugfs_remove(sdata->mesh_stats_dir);
 335         sdata->mesh_stats_dir = NULL;
 336 }
 337
 338 #define MESHPARAMS_DEL(name)                    \
 339         do {                                            \
 340                 debugfs_remove(sdata->mesh_config.name);        \
 341                 sdata->mesh_config.name = NULL;         \
 342         } while (0)
 343
 344 static void del_mesh_config(struct ieee80211_sub_if_data *sdata)
 345 {
 346         MESHPARAMS_DEL(dot11MeshMaxRetries);
 347         MESHPARAMS_DEL(dot11MeshRetryTimeout);
 348         MESHPARAMS_DEL(dot11MeshConfirmTimeout);
 349         MESHPARAMS_DEL(dot11MeshHoldingTimeout);
 350         MESHPARAMS_DEL(dot11MeshTTL);
 351         MESHPARAMS_DEL(auto_open_plinks);
 352         MESHPARAMS_DEL(dot11MeshMaxPeerLinks);
 353         MESHPARAMS_DEL(dot11MeshHWMPactivePathTimeout);
 354         MESHPARAMS_DEL(dot11MeshHWMPpreqMinInterval);
 355         MESHPARAMS_DEL(dot11MeshHWMPnetDiameterTraversalTime);
 356         MESHPARAMS_DEL(dot11MeshHWMPmaxPREQretries);
 357         MESHPARAMS_DEL(path_refresh_time);
 358         MESHPARAMS_DEL(min_discovery_timeout);
 359         debugfs_remove(sdata->mesh_config_dir);
 360         sdata->mesh_config_dir = NULL;
 361 }
 362 #endif
 363
 364 static void del_files(struct ieee80211_sub_if_data *sdata)
 365 {
 366         if (!sdata->debugfsdir)
 367                 return;
 368
 369         switch (sdata->vif.type) {
 370         case NL80211_IFTYPE_MESH_POINT:
 371 #ifdef CONFIG_MAC80211_MESH
 372                 del_mesh_stats(sdata);
 373                 del_mesh_config(sdata);
 374 #endif
 375                 break;
 376         case NL80211_IFTYPE_STATION:
 377                 del_sta_files(sdata);
 378                 break;
 379         case NL80211_IFTYPE_ADHOC:
 380                 /* XXX */
 381                 break;
 382         case NL80211_IFTYPE_AP:
 383                 del_ap_files(sdata);
 384                 break;
 385         case NL80211_IFTYPE_WDS:
 386                 del_wds_files(sdata);
 387                 break;
 388         case NL80211_IFTYPE_MONITOR:
 389                 del_monitor_files(sdata);
 390                 break;
 391         case NL80211_IFTYPE_AP_VLAN:
 392                 del_vlan_files(sdata);
 393                 break;
 394         default:
 395                 break;
 396         }
 397 }
 398
 399 static int notif_registered;
 400
 401 void ieee80211_debugfs_add_netdev(struct ieee80211_sub_if_data *sdata)
 402 {
 403         char buf[10+IFNAMSIZ];
 404
 405         if (!notif_registered)
 406                 return;
 407
 408         sprintf(buf, "netdev:%s", sdata->dev->name);
 409         sdata->debugfsdir = debugfs_create_dir(buf,
 410                 sdata->local->hw.wiphy->debugfsdir);
 411         add_files(sdata);
 412 }
 413
 414 void ieee80211_debugfs_remove_netdev(struct ieee80211_sub_if_data *sdata)
 415 {
 416         del_files(sdata);
 417         debugfs_remove(sdata->debugfsdir);
 418         sdata->debugfsdir = NULL;
 419 }
 420
 421 static int netdev_notify(struct notifier_block *nb,
 422                          unsigned long state,
 423                          void *ndev)
 424 {
 425         struct net_device *dev = ndev;
 426         struct dentry *dir;
 427         struct ieee80211_sub_if_data *sdata;
 428         char buf[10+IFNAMSIZ];
 429
 430         if (state != NETDEV_CHANGENAME)
 431                 return 0;
 432
 433         if (!dev->ieee80211_ptr || !dev->ieee80211_ptr->wiphy)
 434                 return 0;
 435
 436         if (dev->ieee80211_ptr->wiphy->privid != mac80211_wiphy_privid)
 437                 return 0;
 438
 439         sdata = IEEE80211_DEV_TO_SUB_IF(dev);
 440
 441         dir = sdata->debugfsdir;
 442
 443         if (!dir)
 444                 return 0;
 445
 446         sprintf(buf, "netdev:%s", dev->name);
 447         if (!debugfs_rename(dir->d_parent, dir, dir->d_parent, buf))
 448                 printk(KERN_ERR "mac80211: debugfs: failed to rename debugfs "
 449                        "dir to %s\n", buf);
 450
 451         return 0;
 452 }
 453
 454 static struct notifier_block mac80211_debugfs_netdev_notifier = {
 455         .notifier_call = netdev_notify,
 456 };
 457
 458 void ieee80211_debugfs_netdev_init(void)
 459 {
 460         int err;
 461
 462         err = register_netdevice_notifier(&mac80211_debugfs_netdev_notifier);
 463         if (err) {
 464                 printk(KERN_ERR
 465                        "mac80211: failed to install netdev notifier,"
 466                        " disabling per-netdev debugfs!\n");
 467         } else
 468                 notif_registered = 1;
 469 }
 470
 471 void ieee80211_debugfs_netdev_exit(void)
 472 {
 473         unregister_netdevice_notifier(&mac80211_debugfs_netdev_notifier);
 474         notif_registered = 0;
 475 }