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/config.h>
  21 #include <linux/module.h>
  22 #include <linux/stddef.h>       /* offsetof(), etc. */
  23 #include <linux/errno.h>        /* return codes */
  24 #include <linux/kernel.h>
  25 #include <linux/slab.h>         /* kmalloc(), kfree() */
  26 #include <linux/mm.h>           /* verify_area(), etc. */
  27 #include <linux/string.h>       /* inline mem*, str* functions */
  28 #include <linux/init.h>         /* __initfunc et al. */
  29 #include <asm/byteorder.h>      /* htons(), etc. */
  30 #include <asm/uaccess.h>        /* copy_to_user */
  31 #include <asm/io.h>
  32 #include <linux/proc_fs.h>
  33 #include <linux/seq_file.h>
  34 #include <linux/fs.h>
  35 #include <linux/netdevice.h>
  36 #include <linux/if_vlan.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 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 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 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(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, proc_net);
 161         if (proc_vlan_dir) {
 162                 proc_vlan_conf = create_proc_entry(name_conf,
 163                                                    S_IFREG|S_IRUSR|S_IWUSR,
 164                                                    proc_vlan_dir);
 165                 if (proc_vlan_conf) {
 166                         proc_vlan_conf->proc_fops = &vlan_fops;
 167                         return 0;
 168                 }
 169         }
 170         vlan_proc_cleanup();
 171         return -ENOBUFS;
 172 }
 173
 174 /*
 175  *      Add directory entry for VLAN device.
 176  */
 177
 178 int vlan_proc_add_dev (struct net_device *vlandev)
 179 {
 180         struct vlan_dev_info *dev_info = VLAN_DEV_INFO(vlandev);
 181
 182         if (!(vlandev->priv_flags & IFF_802_1Q_VLAN)) {
 183                 printk(KERN_ERR
 184                        "ERROR:  vlan_proc_add, device -:%s:- is NOT a VLAN\n",
 185                        vlandev->name);
 186                 return -EINVAL;
 187         }
 188
 189         dev_info->dent = create_proc_entry(vlandev->name,
 190                                            S_IFREG|S_IRUSR|S_IWUSR,
 191                                            proc_vlan_dir);
 192         if (!dev_info->dent)
 193                 return -ENOBUFS;
 194
 195         dev_info->dent->proc_fops = &vlandev_fops;
 196         dev_info->dent->data = vlandev;
 197
 198 #ifdef VLAN_DEBUG
 199         printk(KERN_ERR "vlan_proc_add, device -:%s:- being added.\n",
 200                vlandev->name);
 201 #endif
 202         return 0;
 203 }
 204
 205 /*
 206  *      Delete directory entry for VLAN device.
 207  */
 208 int vlan_proc_rem_dev(struct net_device *vlandev)
 209 {
 210         if (!vlandev) {
 211                 printk(VLAN_ERR "%s: invalid argument: %p\n",
 212                         __FUNCTION__, vlandev);
 213                 return -EINVAL;
 214         }
 215
 216         if (!(vlandev->priv_flags & IFF_802_1Q_VLAN)) {
 217                 printk(VLAN_DBG "%s: invalid argument, device: %s is not a VLAN device, priv_flags: 0x%4hX.\n",
 218                         __FUNCTION__, vlandev->name, vlandev->priv_flags);
 219                 return -EINVAL;
 220         }
 221
 222 #ifdef VLAN_DEBUG
 223         printk(VLAN_DBG "%s: dev: %p\n", __FUNCTION__, vlandev);
 224 #endif
 225
 226         /** NOTE:  This will consume the memory pointed to by dent, it seems. */
 227         if (VLAN_DEV_INFO(vlandev)->dent) {
 228                 remove_proc_entry(VLAN_DEV_INFO(vlandev)->dent->name, proc_vlan_dir);
 229                 VLAN_DEV_INFO(vlandev)->dent = NULL;
 230         }
 231
 232         return 0;
 233 }
 234
 235 /****** Proc filesystem entry points ****************************************/
 236
 237 /*
 238  * The following few functions build the content of /proc/net/vlan/config
 239  */
 240
 241 /* starting at dev, find a VLAN device */
 242 static struct net_device *vlan_skip(struct net_device *dev)
 243 {
 244         while (dev && !(dev->priv_flags & IFF_802_1Q_VLAN))
 245                 dev = dev->next;
 246
 247         return dev;
 248 }
 249
 250 /* start read of /proc/net/vlan/config */
 251 static void *vlan_seq_start(struct seq_file *seq, loff_t *pos)
 252 {
 253         struct net_device *dev;
 254         loff_t i = 1;
 255
 256         read_lock(&dev_base_lock);
 257
 258         if (*pos == 0)
 259                 return SEQ_START_TOKEN;
 260
 261         for (dev = vlan_skip(dev_base); dev && i < *pos;
 262              dev = vlan_skip(dev->next), ++i);
 263
 264         return  (i == *pos) ? dev : NULL;
 265 }
 266
 267 static void *vlan_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 268 {
 269         ++*pos;
 270
 271         return vlan_skip((v == SEQ_START_TOKEN)
 272                             ? dev_base
 273                             : ((struct net_device *)v)->next);
 274 }
 275
 276 static void vlan_seq_stop(struct seq_file *seq, void *v)
 277 {
 278         read_unlock(&dev_base_lock);
 279 }
 280
 281 static int vlan_seq_show(struct seq_file *seq, void *v)
 282 {
 283         if (v == SEQ_START_TOKEN) {
 284                 const char *nmtype = NULL;
 285
 286                 seq_puts(seq, "VLAN Dev name     | VLAN ID\n");
 287
 288                 if (vlan_name_type < ARRAY_SIZE(vlan_name_type_str))
 289                     nmtype =  vlan_name_type_str[vlan_name_type];
 290
 291                 seq_printf(seq, "Name-Type: %s\n",
 292                            nmtype ? nmtype :  "UNKNOWN" );
 293         } else {
 294                 const struct net_device *vlandev = v;
 295                 const struct vlan_dev_info *dev_info = VLAN_DEV_INFO(vlandev);
 296
 297                 seq_printf(seq, "%-15s| %d  | %s\n",  vlandev->name,
 298                            dev_info->vlan_id,    dev_info->real_dev->name);
 299         }
 300         return 0;
 301 }
 302
 303 static int vlandev_seq_show(struct seq_file *seq, void *offset)
 304 {
 305         struct net_device *vlandev = (struct net_device *) seq->private;
 306         const struct vlan_dev_info *dev_info = VLAN_DEV_INFO(vlandev);
 307         struct net_device_stats *stats;
 308         static const char fmt[] = "%30s %12lu\n";
 309         int i;
 310
 311         if ((vlandev == NULL) || (!(vlandev->priv_flags & IFF_802_1Q_VLAN)))
 312                 return 0;
 313
 314         seq_printf(seq, "%s  VID: %d     REORDER_HDR: %i  dev->priv_flags: %hx\n",
 315                        vlandev->name, dev_info->vlan_id,
 316                        (int)(dev_info->flags & 1), vlandev->priv_flags);
 317
 318
 319         stats = vlan_dev_get_stats(vlandev);
 320
 321         seq_printf(seq, fmt, "total frames received", stats->rx_packets);
 322         seq_printf(seq, fmt, "total bytes received", stats->rx_bytes);
 323         seq_printf(seq, fmt, "Broadcast/Multicast Rcvd", stats->multicast);
 324         seq_puts(seq, "\n");
 325         seq_printf(seq, fmt, "total frames transmitted", stats->tx_packets);
 326         seq_printf(seq, fmt, "total bytes transmitted", stats->tx_bytes);
 327         seq_printf(seq, fmt, "total headroom inc",
 328                    dev_info->cnt_inc_headroom_on_tx);
 329         seq_printf(seq, fmt, "total encap on xmit",
 330                    dev_info->cnt_encap_on_xmit);
 331         seq_printf(seq, "Device: %s", dev_info->real_dev->name);
 332         /* now show all PRIORITY mappings relating to this VLAN */
 333         seq_printf(seq,
 334                        "\nINGRESS priority mappings: 0:%lu  1:%lu  2:%lu  3:%lu  4:%lu  5:%lu  6:%lu 7:%lu\n",
 335                        dev_info->ingress_priority_map[0],
 336                        dev_info->ingress_priority_map[1],
 337                        dev_info->ingress_priority_map[2],
 338                        dev_info->ingress_priority_map[3],
 339                        dev_info->ingress_priority_map[4],
 340                        dev_info->ingress_priority_map[5],
 341                        dev_info->ingress_priority_map[6],
 342                        dev_info->ingress_priority_map[7]);
 343
 344         seq_printf(seq, "EGRESSS priority Mappings: ");
 345         for (i = 0; i < 16; i++) {
 346                 const struct vlan_priority_tci_mapping *mp
 347                         = dev_info->egress_priority_map[i];
 348                 while (mp) {
 349                         seq_printf(seq, "%lu:%hu ",
 350                                    mp->priority, ((mp->vlan_qos >> 13) & 0x7));
 351                         mp = mp->next;
 352                 }
 353         }
 354         seq_puts(seq, "\n");
 355
 356         return 0;
 357 }