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