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/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>           /* verify_area(), etc. */
  26 #include <linux/string.h>       /* inline mem*, str* functions */
  27 #include <linux/init.h>         /* __initfunc et al. */
  28 #include <asm/segment.h>        /* kernel <-> user copy */
  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/fs.h>
  34 #include <linux/netdevice.h>
  35 #include <linux/if_vlan.h>
  36 #include "vlanproc.h"
  37 #include "vlan.h"
  38
  39 /****** Function Prototypes *************************************************/
  40
  41 #ifdef CONFIG_PROC_FS
  42
  43 /* Proc filesystem interface */
  44 static ssize_t vlan_proc_read(struct file *file, char *buf, size_t count,
  45                               loff_t *ppos);
  46
  47 /* Methods for preparing data for reading proc entries */
  48
  49 static int vlan_config_get_info(char *buf, char **start, off_t offs, int len);
  50 static int vlandev_get_info(char *buf, char **start, off_t offs, int len);
  51
  52 /* Miscellaneous */
  53
  54 /*
  55  *      Global Data
  56  */
  57
  58 /*
  59  *      Names of the proc directory entries
  60  */
  61
  62 static char name_root[]  = "vlan";
  63 static char name_conf[]  = "config";
  64 static char term_msg[]   = "***KERNEL:  Out of buffer space!***\n";
  65
  66 /*
  67  *      Structures for interfacing with the /proc filesystem.
  68  *      VLAN creates its own directory /proc/net/vlan with the folowing
  69  *      entries:
  70  *      config          device status/configuration
  71  *      <device>        entry for each  device
  72  */
  73
  74 /*
  75  *      Generic /proc/net/vlan/<file> file and inode operations
  76  */
  77
  78 static struct file_operations vlan_fops = {
  79         read:   vlan_proc_read,
  80         ioctl: NULL, /* vlan_proc_ioctl */
  81 };
  82
  83 /*
  84  *      /proc/net/vlan/<device> file and inode operations
  85  */
  86
  87 static struct file_operations vlandev_fops = {
  88         read:   vlan_proc_read,
  89         ioctl:  NULL, /* vlan_proc_ioctl */
  90 };
  91
  92 /*
  93  * Proc filesystem derectory entries.
  94  */
  95
  96 /*
  97  *      /proc/net/vlan
  98  */
  99
 100 static struct proc_dir_entry *proc_vlan_dir;
 101
 102 /*
 103  *      /proc/net/vlan/config
 104  */
 105
 106 static struct proc_dir_entry *proc_vlan_conf;
 107
 108 /* Strings */
 109 static char conf_hdr[] = "VLAN Dev name  | VLAN ID\n";
 110
 111 /*
 112  *      Interface functions
 113  */
 114
 115 /*
 116  *      Clean up /proc/net/vlan entries
 117  */
 118
 119 void vlan_proc_cleanup(void)
 120 {
 121         if (proc_vlan_conf)
 122                 remove_proc_entry(name_conf, proc_vlan_dir);
 123
 124         if (proc_vlan_dir)
 125                 proc_net_remove(name_root);
 126
 127         /* Dynamically added entries should be cleaned up as their vlan_device
 128          * is removed, so we should not have to take care of it here...
 129          */
 130 }
 131
 132 /*
 133  *      Create /proc/net/vlan entries
 134  */
 135
 136 int __init vlan_proc_init(void)
 137 {
 138         proc_vlan_dir = proc_mkdir(name_root, proc_net);
 139         if (proc_vlan_dir) {
 140                 proc_vlan_conf = create_proc_entry(name_conf,
 141                                                    S_IFREG|S_IRUSR|S_IWUSR,
 142                                                    proc_vlan_dir);
 143                 if (proc_vlan_conf) {
 144                         proc_vlan_conf->proc_fops = &vlan_fops;
 145                         proc_vlan_conf->get_info = vlan_config_get_info;
 146                         return 0;
 147                 }
 148         }
 149         vlan_proc_cleanup();
 150         return -ENOBUFS;
 151 }
 152
 153 /*
 154  *      Add directory entry for VLAN device.
 155  */
 156
 157 int vlan_proc_add_dev (struct net_device *vlandev)
 158 {
 159         struct vlan_dev_info *dev_info = VLAN_DEV_INFO(vlandev);
 160
 161         if (!(vlandev->priv_flags & IFF_802_1Q_VLAN)) {
 162                 printk(KERN_ERR
 163                        "ERROR:  vlan_proc_add, device -:%s:- is NOT a VLAN\n",
 164                        vlandev->name);
 165                 return -EINVAL;
 166         }
 167
 168         dev_info->dent = create_proc_entry(vlandev->name,
 169                                            S_IFREG|S_IRUSR|S_IWUSR,
 170                                            proc_vlan_dir);
 171         if (!dev_info->dent)
 172                 return -ENOBUFS;
 173
 174         dev_info->dent->proc_fops = &vlandev_fops;
 175         dev_info->dent->get_info = &vlandev_get_info;
 176         dev_info->dent->data = vlandev;
 177
 178 #ifdef VLAN_DEBUG
 179         printk(KERN_ERR "vlan_proc_add, device -:%s:- being added.\n",
 180                vlandev->name);
 181 #endif
 182         return 0;
 183 }
 184
 185 /*
 186  *      Delete directory entry for VLAN device.
 187  */
 188 int vlan_proc_rem_dev(struct net_device *vlandev)
 189 {
 190         if (!vlandev) {
 191                 printk(VLAN_ERR "%s: invalid argument: %p\n",
 192                         __FUNCTION__, vlandev);
 193                 return -EINVAL;
 194         }
 195
 196         if (!(vlandev->priv_flags & IFF_802_1Q_VLAN)) {
 197                 printk(VLAN_DBG "%s: invalid argument, device: %s is not a VLAN device, priv_flags: 0x%4hX.\n",
 198                         __FUNCTION__, vlandev->name, vlandev->priv_flags);
 199                 return -EINVAL;
 200         }
 201
 202 #ifdef VLAN_DEBUG
 203         printk(VLAN_DBG __FUNCTION__ ": dev: %p\n", vlandev);
 204 #endif
 205
 206         /** NOTE:  This will consume the memory pointed to by dent, it seems. */
 207         remove_proc_entry(VLAN_DEV_INFO(vlandev)->dent->name, proc_vlan_dir);
 208         VLAN_DEV_INFO(vlandev)->dent = NULL;
 209
 210         return 0;
 211 }
 212
 213 /****** Proc filesystem entry points ****************************************/
 214
 215 /*
 216  *      Read VLAN proc directory entry.
 217  *      This is universal routine for reading all entries in /proc/net/vlan
 218  *      directory.  Each directory entry contains a pointer to the 'method' for
 219  *      preparing data for that entry.
 220  *      o verify arguments
 221  *      o allocate kernel buffer
 222  *      o call get_info() to prepare data
 223  *      o copy data to user space
 224  *      o release kernel buffer
 225  *
 226  *      Return: number of bytes copied to user space (0, if no data)
 227  *              <0      error
 228  */
 229 static ssize_t vlan_proc_read(struct file *file, char *buf,
 230                               size_t count, loff_t *ppos)
 231 {
 232         struct inode *inode = file->f_dentry->d_inode;
 233         struct proc_dir_entry *dent;
 234         char *page;
 235         int pos, offs, len;
 236
 237         if (count <= 0)
 238                 return 0;
 239
 240         dent = inode->u.generic_ip;
 241         if ((dent == NULL) || (dent->get_info == NULL))
 242                 return 0;
 243
 244         page = kmalloc(VLAN_PROC_BUFSZ, GFP_KERNEL);
 245         VLAN_MEM_DBG("page malloc, addr: %p  size: %i\n",
 246                      page, VLAN_PROC_BUFSZ);
 247
 248         if (page == NULL)
 249                 return -ENOBUFS;
 250
 251         pos = dent->get_info(page, dent->data, 0, 0);
 252         offs = file->f_pos;
 253         if (offs < pos) {
 254                 len = min_t(int, pos - offs, count);
 255                 if (copy_to_user(buf, (page + offs), len))
 256                         return -EFAULT;
 257
 258                 file->f_pos += len;
 259         } else {
 260                 len = 0;
 261         }
 262
 263         kfree(page);
 264         VLAN_FMEM_DBG("page free, addr: %p\n", page);
 265         return len;
 266 }
 267
 268 /*
 269  * The following few functions build the content of /proc/net/vlan/config
 270  */
 271
 272 static int vlan_proc_get_vlan_info(char* buf, unsigned int cnt)
 273 {
 274         struct net_device *vlandev = NULL;
 275         struct vlan_group *grp = NULL;
 276         int h, i;
 277         char *nm_type = NULL;
 278         struct vlan_dev_info *dev_info = NULL;
 279
 280 #ifdef VLAN_DEBUG
 281         printk(VLAN_DBG __FUNCTION__ ": cnt == %i\n", cnt);
 282 #endif
 283
 284         if (vlan_name_type == VLAN_NAME_TYPE_RAW_PLUS_VID) {
 285                 nm_type = "VLAN_NAME_TYPE_RAW_PLUS_VID";
 286         } else if (vlan_name_type == VLAN_NAME_TYPE_PLUS_VID_NO_PAD) {
 287                 nm_type = "VLAN_NAME_TYPE_PLUS_VID_NO_PAD";
 288         } else if (vlan_name_type == VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD) {
 289                 nm_type = "VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD";
 290         } else if (vlan_name_type == VLAN_NAME_TYPE_PLUS_VID) {
 291                 nm_type = "VLAN_NAME_TYPE_PLUS_VID";
 292         } else {
 293                 nm_type = "UNKNOWN";
 294         }
 295
 296         cnt += sprintf(buf + cnt, "Name-Type: %s\n", nm_type);
 297
 298         spin_lock_bh(&vlan_group_lock);
 299         for (h = 0; h < VLAN_GRP_HASH_SIZE; h++) {
 300                 for (grp = vlan_group_hash[h]; grp != NULL; grp = grp->next) {
 301                         for (i = 0; i < VLAN_GROUP_ARRAY_LEN; i++) {
 302                                 vlandev = grp->vlan_devices[i];
 303                                 if (!vlandev)
 304                                         continue;
 305
 306                                 if ((cnt + 100) > VLAN_PROC_BUFSZ) {
 307                                         if ((cnt+strlen(term_msg)) < VLAN_PROC_BUFSZ)
 308                                                 cnt += sprintf(buf+cnt, "%s", term_msg);
 309
 310                                         goto out;
 311                                 }
 312
 313                                 dev_info = VLAN_DEV_INFO(vlandev);
 314                                 cnt += sprintf(buf + cnt, "%-15s| %d  | %s\n",
 315                                                vlandev->name,
 316                                                dev_info->vlan_id,
 317                                                dev_info->real_dev->name);
 318                         }
 319                 }
 320         }
 321 out:
 322         spin_unlock_bh(&vlan_group_lock);
 323
 324         return cnt;
 325 }
 326
 327 /*
 328  *      Prepare data for reading 'Config' entry.
 329  *      Return length of data.
 330  */
 331
 332 static int vlan_config_get_info(char *buf, char **start,
 333                                 off_t offs, int len)
 334 {
 335         strcpy(buf, conf_hdr);
 336         return vlan_proc_get_vlan_info(buf, (unsigned int)(strlen(conf_hdr)));
 337 }
 338
 339 /*
 340  *      Prepare data for reading <device> entry.
 341  *      Return length of data.
 342  *
 343  *      On entry, the 'start' argument will contain a pointer to VLAN device
 344  *      data space.
 345  */
 346
 347 static int vlandev_get_info(char *buf, char **start,
 348                             off_t offs, int len)
 349 {
 350         struct net_device *vlandev = (void *) start;
 351         struct net_device_stats *stats = NULL;
 352         struct vlan_dev_info *dev_info = NULL;
 353         struct vlan_priority_tci_mapping *mp;
 354         int cnt = 0;
 355         int i;
 356
 357         if ((vlandev == NULL) || (!(vlandev->priv_flags & IFF_802_1Q_VLAN)))
 358                 return 0;
 359
 360         dev_info = VLAN_DEV_INFO(vlandev);
 361
 362         cnt += sprintf(buf + cnt, "%s  VID: %d   REORDER_HDR: %i  dev->priv_flags: %hx\n",
 363                        vlandev->name, dev_info->vlan_id,
 364                        (int)(dev_info->flags & 1), vlandev->priv_flags);
 365
 366         stats = vlan_dev_get_stats(vlandev);
 367
 368         cnt += sprintf(buf + cnt, "%30s: %12lu\n",
 369                        "total frames received", stats->rx_packets);
 370
 371         cnt += sprintf(buf + cnt, "%30s: %12lu\n",
 372                        "total bytes received", stats->rx_bytes);
 373
 374         cnt += sprintf(buf + cnt, "%30s: %12lu\n",
 375                        "Broadcast/Multicast Rcvd", stats->multicast);
 376
 377         cnt += sprintf(buf + cnt, "\n%30s: %12lu\n",
 378                        "total frames transmitted", stats->tx_packets);
 379
 380         cnt += sprintf(buf + cnt, "%30s: %12lu\n",
 381                        "total bytes transmitted", stats->tx_bytes);
 382
 383         cnt += sprintf(buf + cnt, "%30s: %12lu\n",
 384                        "total headroom inc", dev_info->cnt_inc_headroom_on_tx);
 385
 386         cnt += sprintf(buf + cnt, "%30s: %12lu\n",
 387                        "total encap on xmit", dev_info->cnt_encap_on_xmit);
 388
 389         cnt += sprintf(buf + cnt, "Device: %s", dev_info->real_dev->name);
 390
 391         /* now show all PRIORITY mappings relating to this VLAN */
 392         cnt += sprintf(buf + cnt, "\nINGRESS priority mappings: 0:%lu  1:%lu  2:%lu  3:%lu  4:%lu  5:%lu  6:%lu 7:%lu\n",
 393                        dev_info->ingress_priority_map[0],
 394                        dev_info->ingress_priority_map[1],
 395                        dev_info->ingress_priority_map[2],
 396                        dev_info->ingress_priority_map[3],
 397                        dev_info->ingress_priority_map[4],
 398                        dev_info->ingress_priority_map[5],
 399                        dev_info->ingress_priority_map[6],
 400                        dev_info->ingress_priority_map[7]);
 401
 402         if ((cnt + 100) > VLAN_PROC_BUFSZ) {
 403                 if ((cnt + strlen(term_msg)) >= VLAN_PROC_BUFSZ) {
 404                         /* should never get here */
 405                         return cnt;
 406                 } else {
 407                         cnt += sprintf(buf + cnt, "%s", term_msg);
 408                         return cnt;
 409                 }
 410         }
 411
 412         cnt += sprintf(buf + cnt, "EGRESSS priority Mappings: ");
 413
 414         for (i = 0; i < 16; i++) {
 415                 mp = dev_info->egress_priority_map[i];
 416                 while (mp) {
 417                         cnt += sprintf(buf + cnt, "%lu:%hu ",
 418                                        mp->priority, ((mp->vlan_qos >> 13) & 0x7));
 419
 420                         if ((cnt + 100) > VLAN_PROC_BUFSZ) {
 421                                 if ((cnt + strlen(term_msg)) >= VLAN_PROC_BUFSZ) {
 422                                         /* should never get here */
 423                                         return cnt;
 424                                 } else {
 425                                         cnt += sprintf(buf + cnt, "%s", term_msg);
 426                                         return cnt;
 427                                 }
 428                         }
 429                         mp = mp->next;
 430                 }
 431         }
 432
 433         cnt += sprintf(buf + cnt, "\n");
 434
 435         return cnt;
 436 }
 437
 438 #else /* No CONFIG_PROC_FS */
 439
 440 /*
 441  *      No /proc - output stubs
 442  */
 443
 444 int __init vlan_proc_init (void)
 445 {
 446         return 0;
 447 }
 448
 449 void vlan_proc_cleanup(void)
 450 {
 451         return;
 452 }
 453
 454
 455 int vlan_proc_add_dev(struct net_device *vlandev)
 456 {
 457         return 0;
 458 }
 459
 460 int vlan_proc_rem_dev(struct net_device *vlandev)
 461 {
 462         return 0;
 463 }
 464
 465 #endif /* No CONFIG_PROC_FS */