net/batman-adv/debugfs.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /* Copyright (C) 2010-2018  B.A.T.M.A.N. contributors:
   3  *
   4  * Marek Lindner
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of version 2 of the GNU General Public
   8  * License as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "debugfs.h"
  20 #include "main.h"
  21
  22 #include <linux/dcache.h>
  23 #include <linux/debugfs.h>
  24 #include <linux/err.h>
  25 #include <linux/errno.h>
  26 #include <linux/export.h>
  27 #include <linux/fs.h>
  28 #include <linux/netdevice.h>
  29 #include <linux/printk.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 originator
  71  *  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, 0444, 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, 0444, neighbors_open);
 199 static BATADV_DEBUGINFO(originators, 0444, batadv_originators_open);
 200 static BATADV_DEBUGINFO(gateways, 0444, batadv_gateways_open);
 201 static BATADV_DEBUGINFO(transtable_global, 0444, batadv_transtable_global_open);
 202 #ifdef CONFIG_BATMAN_ADV_BLA
 203 static BATADV_DEBUGINFO(bla_claim_table, 0444, batadv_bla_claim_table_open);
 204 static BATADV_DEBUGINFO(bla_backbone_table, 0444,
 205                         batadv_bla_backbone_table_open);
 206 #endif
 207 #ifdef CONFIG_BATMAN_ADV_DAT
 208 static BATADV_DEBUGINFO(dat_cache, 0444, batadv_dat_cache_open);
 209 #endif
 210 static BATADV_DEBUGINFO(transtable_local, 0444, batadv_transtable_local_open);
 211 #ifdef CONFIG_BATMAN_ADV_NC
 212 static BATADV_DEBUGINFO(nc_nodes, 0444, batadv_nc_nodes_open);
 213 #endif
 214 #ifdef CONFIG_BATMAN_ADV_MCAST
 215 static BATADV_DEBUGINFO(mcast_flags, 0444, 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, 0444,
 256                                batadv_originators_hardif_open);
 257
 258 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
 259         &batadv_hardif_debuginfo_originators,
 260         NULL,
 261 };
 262
 263 /**
 264  * batadv_debugfs_init() - Initialize soft interface independent debugfs entries
 265  */
 266 void batadv_debugfs_init(void)
 267 {
 268         struct batadv_debuginfo **bat_debug;
 269         struct dentry *file;
 270
 271         batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
 272         if (batadv_debugfs == ERR_PTR(-ENODEV))
 273                 batadv_debugfs = NULL;
 274
 275         if (!batadv_debugfs)
 276                 goto err;
 277
 278         for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
 279                 file = debugfs_create_file(((*bat_debug)->attr).name,
 280                                            S_IFREG | ((*bat_debug)->attr).mode,
 281                                            batadv_debugfs, NULL,
 282                                            &(*bat_debug)->fops);
 283                 if (!file) {
 284                         pr_err("Can't add general debugfs file: %s\n",
 285                                ((*bat_debug)->attr).name);
 286                         goto err;
 287                 }
 288         }
 289
 290         return;
 291 err:
 292         debugfs_remove_recursive(batadv_debugfs);
 293         batadv_debugfs = NULL;
 294 }
 295
 296 /**
 297  * batadv_debugfs_destroy() - Remove all debugfs entries
 298  */
 299 void batadv_debugfs_destroy(void)
 300 {
 301         debugfs_remove_recursive(batadv_debugfs);
 302         batadv_debugfs = NULL;
 303 }
 304
 305 /**
 306  * batadv_debugfs_add_hardif() - creates the base directory for a hard interface
 307  *  in debugfs.
 308  * @hard_iface: hard interface which should be added.
 309  *
 310  * Return: 0 on success or negative error number in case of failure
 311  */
 312 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
 313 {
 314         struct net *net = dev_net(hard_iface->net_dev);
 315         struct batadv_debuginfo **bat_debug;
 316         struct dentry *file;
 317
 318         if (!batadv_debugfs)
 319                 goto out;
 320
 321         if (net != &init_net)
 322                 return 0;
 323
 324         hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
 325                                                    batadv_debugfs);
 326         if (!hard_iface->debug_dir)
 327                 goto out;
 328
 329         for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
 330                 file = debugfs_create_file(((*bat_debug)->attr).name,
 331                                            S_IFREG | ((*bat_debug)->attr).mode,
 332                                            hard_iface->debug_dir,
 333                                            hard_iface->net_dev,
 334                                            &(*bat_debug)->fops);
 335                 if (!file)
 336                         goto rem_attr;
 337         }
 338
 339         return 0;
 340 rem_attr:
 341         debugfs_remove_recursive(hard_iface->debug_dir);
 342         hard_iface->debug_dir = NULL;
 343 out:
 344         return -ENOMEM;
 345 }
 346
 347 /**
 348  * batadv_debugfs_rename_hardif() - Fix debugfs path for renamed hardif
 349  * @hard_iface: hard interface which was renamed
 350  */
 351 void batadv_debugfs_rename_hardif(struct batadv_hard_iface *hard_iface)
 352 {
 353         const char *name = hard_iface->net_dev->name;
 354         struct dentry *dir;
 355         struct dentry *d;
 356
 357         dir = hard_iface->debug_dir;
 358         if (!dir)
 359                 return;
 360
 361         d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
 362         if (!d)
 363                 pr_err("Can't rename debugfs dir to %s\n", name);
 364 }
 365
 366 /**
 367  * batadv_debugfs_del_hardif() - delete the base directory for a hard interface
 368  *  in debugfs.
 369  * @hard_iface: hard interface which is deleted.
 370  */
 371 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
 372 {
 373         struct net *net = dev_net(hard_iface->net_dev);
 374
 375         if (net != &init_net)
 376                 return;
 377
 378         if (batadv_debugfs) {
 379                 debugfs_remove_recursive(hard_iface->debug_dir);
 380                 hard_iface->debug_dir = NULL;
 381         }
 382 }
 383
 384 /**
 385  * batadv_debugfs_add_meshif() - Initialize interface dependent debugfs entries
 386  * @dev: netdev struct of the soft interface
 387  *
 388  * Return: 0 on success or negative error number in case of failure
 389  */
 390 int batadv_debugfs_add_meshif(struct net_device *dev)
 391 {
 392         struct batadv_priv *bat_priv = netdev_priv(dev);
 393         struct batadv_debuginfo **bat_debug;
 394         struct net *net = dev_net(dev);
 395         struct dentry *file;
 396
 397         if (!batadv_debugfs)
 398                 goto out;
 399
 400         if (net != &init_net)
 401                 return 0;
 402
 403         bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
 404         if (!bat_priv->debug_dir)
 405                 goto out;
 406
 407         if (batadv_socket_setup(bat_priv) < 0)
 408                 goto rem_attr;
 409
 410         if (batadv_debug_log_setup(bat_priv) < 0)
 411                 goto rem_attr;
 412
 413         for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
 414                 file = debugfs_create_file(((*bat_debug)->attr).name,
 415                                            S_IFREG | ((*bat_debug)->attr).mode,
 416                                            bat_priv->debug_dir,
 417                                            dev, &(*bat_debug)->fops);
 418                 if (!file) {
 419                         batadv_err(dev, "Can't add debugfs file: %s/%s\n",
 420                                    dev->name, ((*bat_debug)->attr).name);
 421                         goto rem_attr;
 422                 }
 423         }
 424
 425         if (batadv_nc_init_debugfs(bat_priv) < 0)
 426                 goto rem_attr;
 427
 428         return 0;
 429 rem_attr:
 430         debugfs_remove_recursive(bat_priv->debug_dir);
 431         bat_priv->debug_dir = NULL;
 432 out:
 433         return -ENOMEM;
 434 }
 435
 436 /**
 437  * batadv_debugfs_rename_meshif() - Fix debugfs path for renamed softif
 438  * @dev: net_device which was renamed
 439  */
 440 void batadv_debugfs_rename_meshif(struct net_device *dev)
 441 {
 442         struct batadv_priv *bat_priv = netdev_priv(dev);
 443         const char *name = dev->name;
 444         struct dentry *dir;
 445         struct dentry *d;
 446
 447         dir = bat_priv->debug_dir;
 448         if (!dir)
 449                 return;
 450
 451         d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
 452         if (!d)
 453                 pr_err("Can't rename debugfs dir to %s\n", name);
 454 }
 455
 456 /**
 457  * batadv_debugfs_del_meshif() - Remove interface dependent debugfs entries
 458  * @dev: netdev struct of the soft interface
 459  */
 460 void batadv_debugfs_del_meshif(struct net_device *dev)
 461 {
 462         struct batadv_priv *bat_priv = netdev_priv(dev);
 463         struct net *net = dev_net(dev);
 464
 465         if (net != &init_net)
 466                 return;
 467
 468         batadv_debug_log_cleanup(bat_priv);
 469
 470         if (batadv_debugfs) {
 471                 debugfs_remove_recursive(bat_priv->debug_dir);
 472                 bat_priv->debug_dir = NULL;
 473         }
 474 }