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/debugfs.h>
  22 #include <linux/device.h>
  23 #include <linux/errno.h>
  24 #include <linux/export.h>
  25 #include <linux/fs.h>
  26 #include <linux/netdevice.h>
  27 #include <linux/printk.h>
  28 #include <linux/sched.h> /* for linux/wait.h */
  29 #include <linux/seq_file.h>
  30 #include <linux/stat.h>
  31 #include <linux/stddef.h>
  32 #include <linux/stringify.h>
  33 #include <linux/sysfs.h>
  34
  35 #include "bat_algo.h"
  36 #include "bridge_loop_avoidance.h"
  37 #include "distributed-arp-table.h"
  38 #include "gateway_client.h"
  39 #include "icmp_socket.h"
  40 #include "log.h"
  41 #include "multicast.h"
  42 #include "network-coding.h"
  43 #include "originator.h"
  44 #include "translation-table.h"
  45
  46 static struct dentry *batadv_debugfs;
  47
  48 static int batadv_algorithms_open(struct inode *inode, struct file *file)
  49 {
  50         return single_open(file, batadv_algo_seq_print_text, NULL);
  51 }
  52
  53 static int neighbors_open(struct inode *inode, struct file *file)
  54 {
  55         struct net_device *net_dev = (struct net_device *)inode->i_private;
  56
  57         return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
  58 }
  59
  60 static int batadv_originators_open(struct inode *inode, struct file *file)
  61 {
  62         struct net_device *net_dev = (struct net_device *)inode->i_private;
  63
  64         return single_open(file, batadv_orig_seq_print_text, net_dev);
  65 }
  66
  67 /**
  68  * batadv_originators_hardif_open - handles debugfs output for the
  69  *  originator table of an hard interface
  70  * @inode: inode pointer to debugfs file
  71  * @file: pointer to the seq_file
  72  *
  73  * Return: 0 on success or negative error number in case of failure
  74  */
  75 static int batadv_originators_hardif_open(struct inode *inode,
  76                                           struct file *file)
  77 {
  78         struct net_device *net_dev = (struct net_device *)inode->i_private;
  79
  80         return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
  81 }
  82
  83 static int batadv_gateways_open(struct inode *inode, struct file *file)
  84 {
  85         struct net_device *net_dev = (struct net_device *)inode->i_private;
  86
  87         return single_open(file, batadv_gw_client_seq_print_text, net_dev);
  88 }
  89
  90 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
  91 {
  92         struct net_device *net_dev = (struct net_device *)inode->i_private;
  93
  94         return single_open(file, batadv_tt_global_seq_print_text, net_dev);
  95 }
  96
  97 #ifdef CONFIG_BATMAN_ADV_BLA
  98 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
  99 {
 100         struct net_device *net_dev = (struct net_device *)inode->i_private;
 101
 102         return single_open(file, batadv_bla_claim_table_seq_print_text,
 103                            net_dev);
 104 }
 105
 106 static int batadv_bla_backbone_table_open(struct inode *inode,
 107                                           struct file *file)
 108 {
 109         struct net_device *net_dev = (struct net_device *)inode->i_private;
 110
 111         return single_open(file, batadv_bla_backbone_table_seq_print_text,
 112                            net_dev);
 113 }
 114
 115 #endif
 116
 117 #ifdef CONFIG_BATMAN_ADV_DAT
 118 /**
 119  * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
 120  * @inode: inode which was opened
 121  * @file: file handle to be initialized
 122  *
 123  * Return: 0 on success or negative error number in case of failure
 124  */
 125 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
 126 {
 127         struct net_device *net_dev = (struct net_device *)inode->i_private;
 128
 129         return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
 130 }
 131 #endif
 132
 133 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
 134 {
 135         struct net_device *net_dev = (struct net_device *)inode->i_private;
 136
 137         return single_open(file, batadv_tt_local_seq_print_text, net_dev);
 138 }
 139
 140 struct batadv_debuginfo {
 141         struct attribute attr;
 142         const struct file_operations fops;
 143 };
 144
 145 #ifdef CONFIG_BATMAN_ADV_NC
 146 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
 147 {
 148         struct net_device *net_dev = (struct net_device *)inode->i_private;
 149
 150         return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
 151 }
 152 #endif
 153
 154 #ifdef CONFIG_BATMAN_ADV_MCAST
 155 /**
 156  * batadv_mcast_flags_open - prepare file handler for reads from mcast_flags
 157  * @inode: inode which was opened
 158  * @file: file handle to be initialized
 159  *
 160  * Return: 0 on success or negative error number in case of failure
 161  */
 162 static int batadv_mcast_flags_open(struct inode *inode, struct file *file)
 163 {
 164         struct net_device *net_dev = (struct net_device *)inode->i_private;
 165
 166         return single_open(file, batadv_mcast_flags_seq_print_text, net_dev);
 167 }
 168 #endif
 169
 170 #define BATADV_DEBUGINFO(_name, _mode, _open)           \
 171 struct batadv_debuginfo batadv_debuginfo_##_name = {    \
 172         .attr = {                                       \
 173                 .name = __stringify(_name),             \
 174                 .mode = _mode,                          \
 175         },                                              \
 176         .fops = {                                       \
 177                 .owner = THIS_MODULE,                   \
 178                 .open = _open,                          \
 179                 .read   = seq_read,                     \
 180                 .llseek = seq_lseek,                    \
 181                 .release = single_release,              \
 182         },                                              \
 183 }
 184
 185 /* the following attributes are general and therefore they will be directly
 186  * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
 187  */
 188 static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
 189
 190 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
 191         &batadv_debuginfo_routing_algos,
 192         NULL,
 193 };
 194
 195 /* The following attributes are per soft interface */
 196 static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
 197 static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
 198 static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
 199 static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
 200                         batadv_transtable_global_open);
 201 #ifdef CONFIG_BATMAN_ADV_BLA
 202 static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
 203 static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
 204                         batadv_bla_backbone_table_open);
 205 #endif
 206 #ifdef CONFIG_BATMAN_ADV_DAT
 207 static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
 208 #endif
 209 static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
 210                         batadv_transtable_local_open);
 211 #ifdef CONFIG_BATMAN_ADV_NC
 212 static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
 213 #endif
 214 #ifdef CONFIG_BATMAN_ADV_MCAST
 215 static BATADV_DEBUGINFO(mcast_flags, S_IRUGO, batadv_mcast_flags_open);
 216 #endif
 217
 218 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
 219         &batadv_debuginfo_neighbors,
 220         &batadv_debuginfo_originators,
 221         &batadv_debuginfo_gateways,
 222         &batadv_debuginfo_transtable_global,
 223 #ifdef CONFIG_BATMAN_ADV_BLA
 224         &batadv_debuginfo_bla_claim_table,
 225         &batadv_debuginfo_bla_backbone_table,
 226 #endif
 227 #ifdef CONFIG_BATMAN_ADV_DAT
 228         &batadv_debuginfo_dat_cache,
 229 #endif
 230         &batadv_debuginfo_transtable_local,
 231 #ifdef CONFIG_BATMAN_ADV_NC
 232         &batadv_debuginfo_nc_nodes,
 233 #endif
 234 #ifdef CONFIG_BATMAN_ADV_MCAST
 235         &batadv_debuginfo_mcast_flags,
 236 #endif
 237         NULL,
 238 };
 239
 240 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open)            \
 241 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = {     \
 242         .attr = {                                               \
 243                 .name = __stringify(_name),                     \
 244                 .mode = _mode,                                  \
 245         },                                                      \
 246         .fops = {                                               \
 247                 .owner = THIS_MODULE,                           \
 248                 .open = _open,                                  \
 249                 .read   = seq_read,                             \
 250                 .llseek = seq_lseek,                            \
 251                 .release = single_release,                      \
 252         },                                                      \
 253 }
 254
 255 static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
 256                                batadv_originators_hardif_open);
 257
 258 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
 259         &batadv_hardif_debuginfo_originators,
 260         NULL,
 261 };
 262
 263 void batadv_debugfs_init(void)
 264 {
 265         struct batadv_debuginfo **bat_debug;
 266         struct dentry *file;
 267
 268         batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
 269         if (batadv_debugfs == ERR_PTR(-ENODEV))
 270                 batadv_debugfs = NULL;
 271
 272         if (!batadv_debugfs)
 273                 goto err;
 274
 275         for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
 276                 file = debugfs_create_file(((*bat_debug)->attr).name,
 277                                            S_IFREG | ((*bat_debug)->attr).mode,
 278                                            batadv_debugfs, NULL,
 279                                            &(*bat_debug)->fops);
 280                 if (!file) {
 281                         pr_err("Can't add general debugfs file: %s\n",
 282                                ((*bat_debug)->attr).name);
 283                         goto err;
 284                 }
 285         }
 286
 287         return;
 288 err:
 289         debugfs_remove_recursive(batadv_debugfs);
 290         batadv_debugfs = NULL;
 291 }
 292
 293 void batadv_debugfs_destroy(void)
 294 {
 295         debugfs_remove_recursive(batadv_debugfs);
 296         batadv_debugfs = NULL;
 297 }
 298
 299 /**
 300  * batadv_debugfs_add_hardif - creates the base directory for a hard interface
 301  *  in debugfs.
 302  * @hard_iface: hard interface which should be added.
 303  *
 304  * Return: 0 on success or negative error number in case of failure
 305  */
 306 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
 307 {
 308         struct batadv_debuginfo **bat_debug;
 309         struct dentry *file;
 310
 311         if (!batadv_debugfs)
 312                 goto out;
 313
 314         hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
 315                                                    batadv_debugfs);
 316         if (!hard_iface->debug_dir)
 317                 goto out;
 318
 319         for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
 320                 file = debugfs_create_file(((*bat_debug)->attr).name,
 321                                            S_IFREG | ((*bat_debug)->attr).mode,
 322                                            hard_iface->debug_dir,
 323                                            hard_iface->net_dev,
 324                                            &(*bat_debug)->fops);
 325                 if (!file)
 326                         goto rem_attr;
 327         }
 328
 329         return 0;
 330 rem_attr:
 331         debugfs_remove_recursive(hard_iface->debug_dir);
 332         hard_iface->debug_dir = NULL;
 333 out:
 334         return -ENOMEM;
 335 }
 336
 337 /**
 338  * batadv_debugfs_del_hardif - delete the base directory for a hard interface
 339  *  in debugfs.
 340  * @hard_iface: hard interface which is deleted.
 341  */
 342 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
 343 {
 344         if (batadv_debugfs) {
 345                 debugfs_remove_recursive(hard_iface->debug_dir);
 346                 hard_iface->debug_dir = NULL;
 347         }
 348 }
 349
 350 int batadv_debugfs_add_meshif(struct net_device *dev)
 351 {
 352         struct batadv_priv *bat_priv = netdev_priv(dev);
 353         struct batadv_debuginfo **bat_debug;
 354         struct dentry *file;
 355
 356         if (!batadv_debugfs)
 357                 goto out;
 358
 359         bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
 360         if (!bat_priv->debug_dir)
 361                 goto out;
 362
 363         if (batadv_socket_setup(bat_priv) < 0)
 364                 goto rem_attr;
 365
 366         if (batadv_debug_log_setup(bat_priv) < 0)
 367                 goto rem_attr;
 368
 369         for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
 370                 file = debugfs_create_file(((*bat_debug)->attr).name,
 371                                            S_IFREG | ((*bat_debug)->attr).mode,
 372                                            bat_priv->debug_dir,
 373                                            dev, &(*bat_debug)->fops);
 374                 if (!file) {
 375                         batadv_err(dev, "Can't add debugfs file: %s/%s\n",
 376                                    dev->name, ((*bat_debug)->attr).name);
 377                         goto rem_attr;
 378                 }
 379         }
 380
 381         if (batadv_nc_init_debugfs(bat_priv) < 0)
 382                 goto rem_attr;
 383
 384         return 0;
 385 rem_attr:
 386         debugfs_remove_recursive(bat_priv->debug_dir);
 387         bat_priv->debug_dir = NULL;
 388 out:
 389         return -ENOMEM;
 390 }
 391
 392 void batadv_debugfs_del_meshif(struct net_device *dev)
 393 {
 394         struct batadv_priv *bat_priv = netdev_priv(dev);
 395
 396         batadv_debug_log_cleanup(bat_priv);
 397
 398         if (batadv_debugfs) {
 399                 debugfs_remove_recursive(bat_priv->debug_dir);
 400                 bat_priv->debug_dir = NULL;
 401         }
 402 }