net/batman-adv/debugfs.c

   1 /* Copyright (C) 2010-2016  B.A.T.M.A.N. contributors:
   2  *
   3  * Marek Lindner
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 2 of the GNU General Public
   7  * License as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "debugfs.h"
  19 #include "main.h"
  20
  21 #include <linux/dcache.h>
  22 #include <linux/debugfs.h>
  23 #include <linux/device.h>
  24 #include <linux/errno.h>
  25 #include <linux/export.h>
  26 #include <linux/fs.h>
  27 #include <linux/netdevice.h>
  28 #include <linux/printk.h>
  29 #include <linux/sched.h> /* for linux/wait.h */
  30 #include <linux/seq_file.h>
  31 #include <linux/stat.h>
  32 #include <linux/stddef.h>
  33 #include <linux/stringify.h>
  34 #include <linux/sysfs.h>
  35 #include <net/net_namespace.h>
  36
  37 #include "bat_algo.h"
  38 #include "bridge_loop_avoidance.h"
  39 #include "distributed-arp-table.h"
  40 #include "gateway_client.h"
  41 #include "icmp_socket.h"
  42 #include "log.h"
  43 #include "multicast.h"
  44 #include "network-coding.h"
  45 #include "originator.h"
  46 #include "translation-table.h"
  47
  48 static struct dentry *batadv_debugfs;
  49
  50 static int batadv_algorithms_open(struct inode *inode, struct file *file)
  51 {
  52         return single_open(file, batadv_algo_seq_print_text, NULL);
  53 }
  54
  55 static int neighbors_open(struct inode *inode, struct file *file)
  56 {
  57         struct net_device *net_dev = (struct net_device *)inode->i_private;
  58
  59         return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
  60 }
  61
  62 static int batadv_originators_open(struct inode *inode, struct file *file)
  63 {
  64         struct net_device *net_dev = (struct net_device *)inode->i_private;
  65
  66         return single_open(file, batadv_orig_seq_print_text, net_dev);
  67 }
  68
  69 /**
  70  * batadv_originators_hardif_open - handles debugfs output for the
  71  *  originator table of an hard interface
  72  * @inode: inode pointer to debugfs file
  73  * @file: pointer to the seq_file
  74  *
  75  * Return: 0 on success or negative error number in case of failure
  76  */
  77 static int batadv_originators_hardif_open(struct inode *inode,
  78                                           struct file *file)
  79 {
  80         struct net_device *net_dev = (struct net_device *)inode->i_private;
  81
  82         return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
  83 }
  84
  85 static int batadv_gateways_open(struct inode *inode, struct file *file)
  86 {
  87         struct net_device *net_dev = (struct net_device *)inode->i_private;
  88
  89         return single_open(file, batadv_gw_client_seq_print_text, net_dev);
  90 }
  91
  92 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
  93 {
  94         struct net_device *net_dev = (struct net_device *)inode->i_private;
  95
  96         return single_open(file, batadv_tt_global_seq_print_text, net_dev);
  97 }
  98
  99 #ifdef CONFIG_BATMAN_ADV_BLA
 100 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
 101 {
 102         struct net_device *net_dev = (struct net_device *)inode->i_private;
 103
 104         return single_open(file, batadv_bla_claim_table_seq_print_text,
 105                            net_dev);
 106 }
 107
 108 static int batadv_bla_backbone_table_open(struct inode *inode,
 109                                           struct file *file)
 110 {
 111         struct net_device *net_dev = (struct net_device *)inode->i_private;
 112
 113         return single_open(file, batadv_bla_backbone_table_seq_print_text,
 114                            net_dev);
 115 }
 116
 117 #endif
 118
 119 #ifdef CONFIG_BATMAN_ADV_DAT
 120 /**
 121  * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
 122  * @inode: inode which was opened
 123  * @file: file handle to be initialized
 124  *
 125  * Return: 0 on success or negative error number in case of failure
 126  */
 127 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
 128 {
 129         struct net_device *net_dev = (struct net_device *)inode->i_private;
 130
 131         return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
 132 }
 133 #endif
 134
 135 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
 136 {
 137         struct net_device *net_dev = (struct net_device *)inode->i_private;
 138
 139         return single_open(file, batadv_tt_local_seq_print_text, net_dev);
 140 }
 141
 142 struct batadv_debuginfo {
 143         struct attribute attr;
 144         const struct file_operations fops;
 145 };
 146
 147 #ifdef CONFIG_BATMAN_ADV_NC
 148 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
 149 {
 150         struct net_device *net_dev = (struct net_device *)inode->i_private;
 151
 152         return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
 153 }
 154 #endif
 155
 156 #ifdef CONFIG_BATMAN_ADV_MCAST
 157 /**
 158  * batadv_mcast_flags_open - prepare file handler for reads from mcast_flags
 159  * @inode: inode which was opened
 160  * @file: file handle to be initialized
 161  *
 162  * Return: 0 on success or negative error number in case of failure
 163  */
 164 static int batadv_mcast_flags_open(struct inode *inode, struct file *file)
 165 {
 166         struct net_device *net_dev = (struct net_device *)inode->i_private;
 167
 168         return single_open(file, batadv_mcast_flags_seq_print_text, net_dev);
 169 }
 170 #endif
 171
 172 #define BATADV_DEBUGINFO(_name, _mode, _open)           \
 173 struct batadv_debuginfo batadv_debuginfo_##_name = {    \
 174         .attr = {                                       \
 175                 .name = __stringify(_name),             \
 176                 .mode = _mode,                          \
 177         },                                              \
 178         .fops = {                                       \
 179                 .owner = THIS_MODULE,                   \
 180                 .open = _open,                          \
 181                 .read   = seq_read,                     \
 182                 .llseek = seq_lseek,                    \
 183                 .release = single_release,              \
 184         },                                              \
 185 }
 186
 187 /* the following attributes are general and therefore they will be directly
 188  * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
 189  */
 190 static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
 191
 192 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
 193         &batadv_debuginfo_routing_algos,
 194         NULL,
 195 };
 196
 197 /* The following attributes are per soft interface */
 198 static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
 199 static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
 200 static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
 201 static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
 202                         batadv_transtable_global_open);
 203 #ifdef CONFIG_BATMAN_ADV_BLA
 204 static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
 205 static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
 206                         batadv_bla_backbone_table_open);
 207 #endif
 208 #ifdef CONFIG_BATMAN_ADV_DAT
 209 static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
 210 #endif
 211 static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
 212                         batadv_transtable_local_open);
 213 #ifdef CONFIG_BATMAN_ADV_NC
 214 static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
 215 #endif
 216 #ifdef CONFIG_BATMAN_ADV_MCAST
 217 static BATADV_DEBUGINFO(mcast_flags, S_IRUGO, batadv_mcast_flags_open);
 218 #endif
 219
 220 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
 221         &batadv_debuginfo_neighbors,
 222         &batadv_debuginfo_originators,
 223         &batadv_debuginfo_gateways,
 224         &batadv_debuginfo_transtable_global,
 225 #ifdef CONFIG_BATMAN_ADV_BLA
 226         &batadv_debuginfo_bla_claim_table,
 227         &batadv_debuginfo_bla_backbone_table,
 228 #endif
 229 #ifdef CONFIG_BATMAN_ADV_DAT
 230         &batadv_debuginfo_dat_cache,
 231 #endif
 232         &batadv_debuginfo_transtable_local,
 233 #ifdef CONFIG_BATMAN_ADV_NC
 234         &batadv_debuginfo_nc_nodes,
 235 #endif
 236 #ifdef CONFIG_BATMAN_ADV_MCAST
 237         &batadv_debuginfo_mcast_flags,
 238 #endif
 239         NULL,
 240 };
 241
 242 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open)            \
 243 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = {     \
 244         .attr = {                                               \
 245                 .name = __stringify(_name),                     \
 246                 .mode = _mode,                                  \
 247         },                                                      \
 248         .fops = {                                               \
 249                 .owner = THIS_MODULE,                           \
 250                 .open = _open,                                  \
 251                 .read   = seq_read,                             \
 252                 .llseek = seq_lseek,                            \
 253                 .release = single_release,                      \
 254         },                                                      \
 255 }
 256
 257 static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
 258                                batadv_originators_hardif_open);
 259
 260 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
 261         &batadv_hardif_debuginfo_originators,
 262         NULL,
 263 };
 264
 265 void batadv_debugfs_init(void)
 266 {
 267         struct batadv_debuginfo **bat_debug;
 268         struct dentry *file;
 269
 270         batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
 271         if (batadv_debugfs == ERR_PTR(-ENODEV))
 272                 batadv_debugfs = NULL;
 273
 274         if (!batadv_debugfs)
 275                 goto err;
 276
 277         for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
 278                 file = debugfs_create_file(((*bat_debug)->attr).name,
 279                                            S_IFREG | ((*bat_debug)->attr).mode,
 280                                            batadv_debugfs, NULL,
 281                                            &(*bat_debug)->fops);
 282                 if (!file) {
 283                         pr_err("Can't add general debugfs file: %s\n",
 284                                ((*bat_debug)->attr).name);
 285                         goto err;
 286                 }
 287         }
 288
 289         return;
 290 err:
 291         debugfs_remove_recursive(batadv_debugfs);
 292         batadv_debugfs = NULL;
 293 }
 294
 295 void batadv_debugfs_destroy(void)
 296 {
 297         debugfs_remove_recursive(batadv_debugfs);
 298         batadv_debugfs = NULL;
 299 }
 300
 301 /**
 302  * batadv_debugfs_add_hardif - creates the base directory for a hard interface
 303  *  in debugfs.
 304  * @hard_iface: hard interface which should be added.
 305  *
 306  * Return: 0 on success or negative error number in case of failure
 307  */
 308 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
 309 {
 310         struct net *net = dev_net(hard_iface->net_dev);
 311         struct batadv_debuginfo **bat_debug;
 312         struct dentry *file;
 313
 314         if (!batadv_debugfs)
 315                 goto out;
 316
 317         if (net != &init_net)
 318                 return 0;
 319
 320         hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
 321                                                    batadv_debugfs);
 322         if (!hard_iface->debug_dir)
 323                 goto out;
 324
 325         for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
 326                 file = debugfs_create_file(((*bat_debug)->attr).name,
 327                                            S_IFREG | ((*bat_debug)->attr).mode,
 328                                            hard_iface->debug_dir,
 329                                            hard_iface->net_dev,
 330                                            &(*bat_debug)->fops);
 331                 if (!file)
 332                         goto rem_attr;
 333         }
 334
 335         return 0;
 336 rem_attr:
 337         debugfs_remove_recursive(hard_iface->debug_dir);
 338         hard_iface->debug_dir = NULL;
 339 out:
 340         return -ENOMEM;
 341 }
 342
 343 /**
 344  * batadv_debugfs_rename_hardif() - Fix debugfs path for renamed hardif
 345  * @hard_iface: hard interface which was renamed
 346  */
 347 void batadv_debugfs_rename_hardif(struct batadv_hard_iface *hard_iface)
 348 {
 349         const char *name = hard_iface->net_dev->name;
 350         struct dentry *dir;
 351         struct dentry *d;
 352
 353         dir = hard_iface->debug_dir;
 354         if (!dir)
 355                 return;
 356
 357         d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
 358         if (!d)
 359                 pr_err("Can't rename debugfs dir to %s\n", name);
 360 }
 361
 362 /**
 363  * batadv_debugfs_del_hardif - delete the base directory for a hard interface
 364  *  in debugfs.
 365  * @hard_iface: hard interface which is deleted.
 366  */
 367 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
 368 {
 369         struct net *net = dev_net(hard_iface->net_dev);
 370
 371         if (net != &init_net)
 372                 return;
 373
 374         if (batadv_debugfs) {
 375                 debugfs_remove_recursive(hard_iface->debug_dir);
 376                 hard_iface->debug_dir = NULL;
 377         }
 378 }
 379
 380 int batadv_debugfs_add_meshif(struct net_device *dev)
 381 {
 382         struct batadv_priv *bat_priv = netdev_priv(dev);
 383         struct batadv_debuginfo **bat_debug;
 384         struct net *net = dev_net(dev);
 385         struct dentry *file;
 386
 387         if (!batadv_debugfs)
 388                 goto out;
 389
 390         if (net != &init_net)
 391                 return 0;
 392
 393         bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
 394         if (!bat_priv->debug_dir)
 395                 goto out;
 396
 397         if (batadv_socket_setup(bat_priv) < 0)
 398                 goto rem_attr;
 399
 400         if (batadv_debug_log_setup(bat_priv) < 0)
 401                 goto rem_attr;
 402
 403         for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
 404                 file = debugfs_create_file(((*bat_debug)->attr).name,
 405                                            S_IFREG | ((*bat_debug)->attr).mode,
 406                                            bat_priv->debug_dir,
 407                                            dev, &(*bat_debug)->fops);
 408                 if (!file) {
 409                         batadv_err(dev, "Can't add debugfs file: %s/%s\n",
 410                                    dev->name, ((*bat_debug)->attr).name);
 411                         goto rem_attr;
 412                 }
 413         }
 414
 415         if (batadv_nc_init_debugfs(bat_priv) < 0)
 416                 goto rem_attr;
 417
 418         return 0;
 419 rem_attr:
 420         debugfs_remove_recursive(bat_priv->debug_dir);
 421         bat_priv->debug_dir = NULL;
 422 out:
 423         return -ENOMEM;
 424 }
 425
 426 /**
 427  * batadv_debugfs_rename_meshif() - Fix debugfs path for renamed softif
 428  * @dev: net_device which was renamed
 429  */
 430 void batadv_debugfs_rename_meshif(struct net_device *dev)
 431 {
 432         struct batadv_priv *bat_priv = netdev_priv(dev);
 433         const char *name = dev->name;
 434         struct dentry *dir;
 435         struct dentry *d;
 436
 437         dir = bat_priv->debug_dir;
 438         if (!dir)
 439                 return;
 440
 441         d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
 442         if (!d)
 443                 pr_err("Can't rename debugfs dir to %s\n", name);
 444 }
 445
 446 void batadv_debugfs_del_meshif(struct net_device *dev)
 447 {
 448         struct batadv_priv *bat_priv = netdev_priv(dev);
 449         struct net *net = dev_net(dev);
 450
 451         if (net != &init_net)
 452                 return;
 453
 454         batadv_debug_log_cleanup(bat_priv);
 455
 456         if (batadv_debugfs) {
 457                 debugfs_remove_recursive(bat_priv->debug_dir);
 458                 bat_priv->debug_dir = NULL;
 459         }
 460 }