net/8021q/vlanproc.c

   1 /******************************************************************************
   2  * vlanproc.c   VLAN Module. /proc filesystem interface.
   3  *
   4  *              This module is completely hardware-independent and provides
   5  *              access to the router using Linux /proc filesystem.
   6  *
   7  * Author:      Ben Greear, <greearb@candelatech.com> coppied from wanproc.c
   8  *               by: Gene Kozin <genek@compuserve.com>
   9  *
  10  * Copyright:   (c) 1998 Ben Greear
  11  *
  12  *              This program is free software; you can redistribute it and/or
  13  *              modify it under the terms of the GNU General Public License
  14  *              as published by the Free Software Foundation; either version
  15  *              2 of the License, or (at your option) any later version.
  16  * ============================================================================
  17  * Jan 20, 1998        Ben Greear     Initial Version
  18  *****************************************************************************/
  19
  20 #include <linux/module.h>
  21 #include <linux/stddef.h>       /* offsetof(), etc. */
  22 #include <linux/errno.h>        /* return codes */
  23 #include <linux/kernel.h>
  24 #include <linux/slab.h>         /* kmalloc(), kfree() */
  25 #include <linux/mm.h>
  26 #include <linux/string.h>       /* inline mem*, str* functions */
  27 #include <linux/init.h>         /* __initfunc et al. */
  28 #include <asm/byteorder.h>      /* htons(), etc. */
  29 #include <asm/uaccess.h>        /* copy_to_user */
  30 #include <asm/io.h>
  31 #include <linux/proc_fs.h>
  32 #include <linux/seq_file.h>
  33 #include <linux/fs.h>
  34 #include <linux/netdevice.h>
  35 #include <linux/if_vlan.h>
  36 #include <net/net_namespace.h>
  37 #include <net/netns/generic.h>
  38 #include "vlanproc.h"
  39 #include "vlan.h"
  40
  41 /****** Function Prototypes *************************************************/
  42
  43 /* Methods for preparing data for reading proc entries */
  44 static int vlan_seq_show(struct seq_file *seq, void *v);
  45 static void *vlan_seq_start(struct seq_file *seq, loff_t *pos);
  46 static void *vlan_seq_next(struct seq_file *seq, void *v, loff_t *pos);
  47 static void vlan_seq_stop(struct seq_file *seq, void *);
  48 static int vlandev_seq_show(struct seq_file *seq, void *v);
  49
  50 /*
  51  *      Global Data
  52  */
  53
  54
  55 /*
  56  *      Names of the proc directory entries
  57  */
  58
  59 static const char name_root[]    = "vlan";
  60 static const char name_conf[]    = "config";
  61
  62 /*
  63  *      Structures for interfacing with the /proc filesystem.
  64  *      VLAN creates its own directory /proc/net/vlan with the folowing
  65  *      entries:
  66  *      config          device status/configuration
  67  *      <device>        entry for each  device
  68  */
  69
  70 /*
  71  *      Generic /proc/net/vlan/<file> file and inode operations
  72  */
  73
  74 static const struct seq_operations vlan_seq_ops = {
  75         .start = vlan_seq_start,
  76         .next = vlan_seq_next,
  77         .stop = vlan_seq_stop,
  78         .show = vlan_seq_show,
  79 };
  80
  81 static int vlan_seq_open(struct inode *inode, struct file *file)
  82 {
  83         return seq_open_net(inode, file, &vlan_seq_ops,
  84                         sizeof(struct seq_net_private));
  85 }
  86
  87 static const struct file_operations vlan_fops = {
  88         .owner   = THIS_MODULE,
  89         .open    = vlan_seq_open,
  90         .read    = seq_read,
  91         .llseek  = seq_lseek,
  92         .release = seq_release_net,
  93 };
  94
  95 /*
  96  *      /proc/net/vlan/<device> file and inode operations
  97  */
  98
  99 static int vlandev_seq_open(struct inode *inode, struct file *file)
 100 {
 101         return single_open(file, vlandev_seq_show, PDE(inode)->data);
 102 }
 103
 104 static const struct file_operations vlandev_fops = {
 105         .owner = THIS_MODULE,
 106         .open    = vlandev_seq_open,
 107         .read    = seq_read,
 108         .llseek  = seq_lseek,
 109         .release = single_release,
 110 };
 111
 112 /*
 113  * Proc filesystem derectory entries.
 114  */
 115
 116 /* Strings */
 117 static const char *vlan_name_type_str[VLAN_NAME_TYPE_HIGHEST] = {
 118     [VLAN_NAME_TYPE_RAW_PLUS_VID]        = "VLAN_NAME_TYPE_RAW_PLUS_VID",
 119     [VLAN_NAME_TYPE_PLUS_VID_NO_PAD]     = "VLAN_NAME_TYPE_PLUS_VID_NO_PAD",
 120     [VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD] = "VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD",
 121     [VLAN_NAME_TYPE_PLUS_VID]            = "VLAN_NAME_TYPE_PLUS_VID",
 122 };
 123 /*
 124  *      Interface functions
 125  */
 126
 127 /*
 128  *      Clean up /proc/net/vlan entries
 129  */
 130
 131 void vlan_proc_cleanup(struct net *net)
 132 {
 133         struct vlan_net *vn = net_generic(net, vlan_net_id);
 134
 135         if (vn->proc_vlan_conf)
 136                 remove_proc_entry(name_conf, vn->proc_vlan_dir);
 137
 138         if (vn->proc_vlan_dir)
 139                 proc_net_remove(net, name_root);
 140
 141         /* Dynamically added entries should be cleaned up as their vlan_device
 142          * is removed, so we should not have to take care of it here...
 143          */
 144 }
 145
 146 /*
 147  *      Create /proc/net/vlan entries
 148  */
 149
 150 int vlan_proc_init(struct net *net)
 151 {
 152         struct vlan_net *vn = net_generic(net, vlan_net_id);
 153
 154         vn->proc_vlan_dir = proc_net_mkdir(net, name_root, net->proc_net);
 155         if (!vn->proc_vlan_dir)
 156                 goto err;
 157
 158         vn->proc_vlan_conf = proc_create(name_conf, S_IFREG|S_IRUSR|S_IWUSR,
 159                                      vn->proc_vlan_dir, &vlan_fops);
 160         if (!vn->proc_vlan_conf)
 161                 goto err;
 162         return 0;
 163
 164 err:
 165         pr_err("%s: can't create entry in proc filesystem!\n", __func__);
 166         vlan_proc_cleanup(net);
 167         return -ENOBUFS;
 168 }
 169
 170 /*
 171  *      Add directory entry for VLAN device.
 172  */
 173
 174 int vlan_proc_add_dev(struct net_device *vlandev)
 175 {
 176         struct vlan_dev_info *dev_info = vlan_dev_info(vlandev);
 177         struct vlan_net *vn = net_generic(dev_net(vlandev), vlan_net_id);
 178
 179         dev_info->dent = proc_create(vlandev->name, S_IFREG|S_IRUSR|S_IWUSR,
 180                                      vn->proc_vlan_dir, &vlandev_fops);
 181         if (!dev_info->dent)
 182                 return -ENOBUFS;
 183
 184         dev_info->dent->data = vlandev;
 185         return 0;
 186 }
 187
 188 /*
 189  *      Delete directory entry for VLAN device.
 190  */
 191 int vlan_proc_rem_dev(struct net_device *vlandev)
 192 {
 193         struct vlan_net *vn = net_generic(dev_net(vlandev), vlan_net_id);
 194
 195         /** NOTE:  This will consume the memory pointed to by dent, it seems. */
 196         if (vlan_dev_info(vlandev)->dent) {
 197                 remove_proc_entry(vlan_dev_info(vlandev)->dent->name,
 198                                   vn->proc_vlan_dir);
 199                 vlan_dev_info(vlandev)->dent = NULL;
 200         }
 201         return 0;
 202 }
 203
 204 /****** Proc filesystem entry points ****************************************/
 205
 206 /*
 207  * The following few functions build the content of /proc/net/vlan/config
 208  */
 209
 210 /* start read of /proc/net/vlan/config */
 211 static void *vlan_seq_start(struct seq_file *seq, loff_t *pos)
 212         __acquires(dev_base_lock)
 213 {
 214         struct net_device *dev;
 215         struct net *net = seq_file_net(seq);
 216         loff_t i = 1;
 217
 218         read_lock(&dev_base_lock);
 219
 220         if (*pos == 0)
 221                 return SEQ_START_TOKEN;
 222
 223         for_each_netdev(net, dev) {
 224                 if (!is_vlan_dev(dev))
 225                         continue;
 226
 227                 if (i++ == *pos)
 228                         return dev;
 229         }
 230
 231         return  NULL;
 232 }
 233
 234 static void *vlan_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 235 {
 236         struct net_device *dev;
 237         struct net *net = seq_file_net(seq);
 238
 239         ++*pos;
 240
 241         dev = (struct net_device *)v;
 242         if (v == SEQ_START_TOKEN)
 243                 dev = net_device_entry(&net->dev_base_head);
 244
 245         for_each_netdev_continue(net, dev) {
 246                 if (!is_vlan_dev(dev))
 247                         continue;
 248
 249                 return dev;
 250         }
 251
 252         return NULL;
 253 }
 254
 255 static void vlan_seq_stop(struct seq_file *seq, void *v)
 256         __releases(dev_base_lock)
 257 {
 258         read_unlock(&dev_base_lock);
 259 }
 260
 261 static int vlan_seq_show(struct seq_file *seq, void *v)
 262 {
 263         struct net *net = seq_file_net(seq);
 264         struct vlan_net *vn = net_generic(net, vlan_net_id);
 265
 266         if (v == SEQ_START_TOKEN) {
 267                 const char *nmtype = NULL;
 268
 269                 seq_puts(seq, "VLAN Dev name     | VLAN ID\n");
 270
 271                 if (vn->name_type < ARRAY_SIZE(vlan_name_type_str))
 272                     nmtype =  vlan_name_type_str[vn->name_type];
 273
 274                 seq_printf(seq, "Name-Type: %s\n",
 275                            nmtype ? nmtype :  "UNKNOWN");
 276         } else {
 277                 const struct net_device *vlandev = v;
 278                 const struct vlan_dev_info *dev_info = vlan_dev_info(vlandev);
 279
 280                 seq_printf(seq, "%-15s| %d  | %s\n",  vlandev->name,
 281                            dev_info->vlan_id,    dev_info->real_dev->name);
 282         }
 283         return 0;
 284 }
 285
 286 static int vlandev_seq_show(struct seq_file *seq, void *offset)
 287 {
 288         struct net_device *vlandev = (struct net_device *) seq->private;
 289         const struct vlan_dev_info *dev_info = vlan_dev_info(vlandev);
 290         struct net_device_stats *stats = &vlandev->stats;
 291         static const char fmt[] = "%30s %12lu\n";
 292         int i;
 293
 294         if (!(vlandev->priv_flags & IFF_802_1Q_VLAN))
 295                 return 0;
 296
 297         seq_printf(seq,
 298                    "%s  VID: %d  REORDER_HDR: %i  dev->priv_flags: %hx\n",
 299                    vlandev->name, dev_info->vlan_id,
 300                    (int)(dev_info->flags & 1), vlandev->priv_flags);
 301
 302         seq_printf(seq, fmt, "total frames received", stats->rx_packets);
 303         seq_printf(seq, fmt, "total bytes received", stats->rx_bytes);
 304         seq_printf(seq, fmt, "Broadcast/Multicast Rcvd", stats->multicast);
 305         seq_puts(seq, "\n");
 306         seq_printf(seq, fmt, "total frames transmitted", stats->tx_packets);
 307         seq_printf(seq, fmt, "total bytes transmitted", stats->tx_bytes);
 308         seq_printf(seq, fmt, "total headroom inc",
 309                    dev_info->cnt_inc_headroom_on_tx);
 310         seq_printf(seq, fmt, "total encap on xmit",
 311                    dev_info->cnt_encap_on_xmit);
 312         seq_printf(seq, "Device: %s", dev_info->real_dev->name);
 313         /* now show all PRIORITY mappings relating to this VLAN */
 314         seq_printf(seq, "\nINGRESS priority mappings: "
 315                         "0:%u  1:%u  2:%u  3:%u  4:%u  5:%u  6:%u 7:%u\n",
 316                    dev_info->ingress_priority_map[0],
 317                    dev_info->ingress_priority_map[1],
 318                    dev_info->ingress_priority_map[2],
 319                    dev_info->ingress_priority_map[3],
 320                    dev_info->ingress_priority_map[4],
 321                    dev_info->ingress_priority_map[5],
 322                    dev_info->ingress_priority_map[6],
 323                    dev_info->ingress_priority_map[7]);
 324
 325         seq_printf(seq, "EGRESSS priority Mappings: ");
 326         for (i = 0; i < 16; i++) {
 327                 const struct vlan_priority_tci_mapping *mp
 328                         = dev_info->egress_priority_map[i];
 329                 while (mp) {
 330                         seq_printf(seq, "%u:%hu ",
 331                                    mp->priority, ((mp->vlan_qos >> 13) & 0x7));
 332                         mp = mp->next;
 333                 }
 334         }
 335         seq_puts(seq, "\n");
 336
 337         return 0;
 338 }