include/linux/if_vlan.h

   1 /*
   2  * VLAN         An implementation of 802.1Q VLAN tagging.
   3  *
   4  * Authors:     Ben Greear <greearb@candelatech.com>
   5  *
   6  *              This program is free software; you can redistribute it and/or
   7  *              modify it under the terms of the GNU General Public License
   8  *              as published by the Free Software Foundation; either version
   9  *              2 of the License, or (at your option) any later version.
  10  *
  11  */
  12
  13 #ifndef _LINUX_IF_VLAN_H_
  14 #define _LINUX_IF_VLAN_H_
  15
  16 #ifdef __KERNEL__
  17
  18 /* externally defined structs */
  19 struct vlan_group;
  20 struct net_device;
  21 struct sk_buff;
  22 struct packet_type;
  23 struct vlan_collection;
  24 struct vlan_dev_info;
  25 struct hlist_node;
  26
  27 #include <linux/proc_fs.h> /* for proc_dir_entry */
  28 #include <linux/netdevice.h>
  29
  30 #define VLAN_HLEN       4               /* The additional bytes (on top of the Ethernet header)
  31                                          * that VLAN requires.
  32                                          */
  33 #define VLAN_ETH_ALEN   6               /* Octets in one ethernet addr   */
  34 #define VLAN_ETH_HLEN   18              /* Total octets in header.       */
  35 #define VLAN_ETH_ZLEN   64              /* Min. octets in frame sans FCS */
  36
  37 /*
  38  * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
  39  */
  40 #define VLAN_ETH_DATA_LEN       1500    /* Max. octets in payload        */
  41 #define VLAN_ETH_FRAME_LEN      1518    /* Max. octets in frame sans FCS */
  42
  43 struct vlan_ethhdr {
  44    unsigned char        h_dest[ETH_ALEN];          /* destination eth addr      */
  45    unsigned char        h_source[ETH_ALEN];        /* source ether addr */
  46    unsigned short       h_vlan_proto;              /* Should always be 0x8100 */
  47    unsigned short       h_vlan_TCI;                /* Encapsulates priority and VLAN ID */
  48    unsigned short       h_vlan_encapsulated_proto; /* packet type ID field (or len) */
  49 };
  50
  51 struct vlan_hdr {
  52    unsigned short       h_vlan_TCI;                /* Encapsulates priority and VLAN ID */
  53    unsigned short       h_vlan_encapsulated_proto; /* packet type ID field (or len) */
  54 };
  55
  56 #define VLAN_VID_MASK   0xfff
  57
  58 /* found in socket.c */
  59 extern void vlan_ioctl_set(int (*hook)(void __user *));
  60
  61 #define VLAN_NAME "vlan"
  62
  63 /* if this changes, algorithm will have to be reworked because this
  64  * depends on completely exhausting the VLAN identifier space.  Thus
  65  * it gives constant time look-up, but in many cases it wastes memory.
  66  */
  67 #define VLAN_GROUP_ARRAY_LEN 4096
  68
  69 struct vlan_group {
  70         int real_dev_ifindex; /* The ifindex of the ethernet(like) device the vlan is attached to. */
  71         struct hlist_node       hlist;  /* linked list */
  72         struct net_device *vlan_devices[VLAN_GROUP_ARRAY_LEN];
  73         struct rcu_head         rcu;
  74 };
  75
  76 struct vlan_priority_tci_mapping {
  77         unsigned long priority;
  78         unsigned short vlan_qos; /* This should be shifted when first set, so we only do it
  79                                   * at provisioning time.
  80                                   * ((skb->priority << 13) & 0xE000)
  81                                   */
  82         struct vlan_priority_tci_mapping *next;
  83 };
  84
  85 /* Holds information that makes sense if this device is a VLAN device. */
  86 struct vlan_dev_info {
  87         /** This will be the mapping that correlates skb->priority to
  88          * 3 bits of VLAN QOS tags...
  89          */
  90         unsigned long ingress_priority_map[8];
  91         struct vlan_priority_tci_mapping *egress_priority_map[16]; /* hash table */
  92
  93         unsigned short vlan_id;        /*  The VLAN Identifier for this interface. */
  94         unsigned short flags;          /* (1 << 0) re_order_header   This option will cause the
  95                                         *   VLAN code to move around the ethernet header on
  96                                         *   ingress to make the skb look **exactly** like it
  97                                         *   came in from an ethernet port.  This destroys some of
  98                                         *   the VLAN information in the skb, but it fixes programs
  99                                         *   like DHCP that use packet-filtering and don't understand
 100                                         *   802.1Q
 101                                         */
 102         struct dev_mc_list *old_mc_list;  /* old multi-cast list for the VLAN interface..
 103                                            * we save this so we can tell what changes were
 104                                            * made, in order to feed the right changes down
 105                                            * to the real hardware...
 106                                            */
 107         int old_allmulti;               /* similar to above. */
 108         int old_promiscuity;            /* similar to above. */
 109         struct net_device *real_dev;    /* the underlying device/interface */
 110         struct proc_dir_entry *dent;    /* Holds the proc data */
 111         unsigned long cnt_inc_headroom_on_tx; /* How many times did we have to grow the skb on TX. */
 112         unsigned long cnt_encap_on_xmit;      /* How many times did we have to encapsulate the skb on TX. */
 113         struct net_device_stats dev_stats; /* Device stats (rx-bytes, tx-pkts, etc...) */
 114 };
 115
 116 #define VLAN_DEV_INFO(x) ((struct vlan_dev_info *)(x->priv))
 117
 118 /* inline functions */
 119
 120 static inline struct net_device_stats *vlan_dev_get_stats(struct net_device *dev)
 121 {
 122         return &(VLAN_DEV_INFO(dev)->dev_stats);
 123 }
 124
 125 static inline __u32 vlan_get_ingress_priority(struct net_device *dev,
 126                                               unsigned short vlan_tag)
 127 {
 128         struct vlan_dev_info *vip = VLAN_DEV_INFO(dev);
 129
 130         return vip->ingress_priority_map[(vlan_tag >> 13) & 0x7];
 131 }
 132
 133 /* VLAN tx hw acceleration helpers. */
 134 struct vlan_skb_tx_cookie {
 135         u32     magic;
 136         u32     vlan_tag;
 137 };
 138
 139 #define VLAN_TX_COOKIE_MAGIC    0x564c414e      /* "VLAN" in ascii. */
 140 #define VLAN_TX_SKB_CB(__skb)   ((struct vlan_skb_tx_cookie *)&((__skb)->cb[0]))
 141 #define vlan_tx_tag_present(__skb) \
 142         (VLAN_TX_SKB_CB(__skb)->magic == VLAN_TX_COOKIE_MAGIC)
 143 #define vlan_tx_tag_get(__skb)  (VLAN_TX_SKB_CB(__skb)->vlan_tag)
 144
 145 /* VLAN rx hw acceleration helper.  This acts like netif_{rx,receive_skb}(). */
 146 static inline int __vlan_hwaccel_rx(struct sk_buff *skb,
 147                                     struct vlan_group *grp,
 148                                     unsigned short vlan_tag, int polling)
 149 {
 150         struct net_device_stats *stats;
 151
 152         skb->real_dev = skb->dev;
 153         skb->dev = grp->vlan_devices[vlan_tag & VLAN_VID_MASK];
 154         if (skb->dev == NULL) {
 155                 kfree_skb(skb);
 156
 157                 /* Not NET_RX_DROP, this is not being dropped
 158                  * due to congestion.
 159                  */
 160                 return 0;
 161         }
 162
 163         skb->dev->last_rx = jiffies;
 164
 165         stats = vlan_dev_get_stats(skb->dev);
 166         stats->rx_packets++;
 167         stats->rx_bytes += skb->len;
 168
 169         skb->priority = vlan_get_ingress_priority(skb->dev, vlan_tag);
 170         switch (skb->pkt_type) {
 171         case PACKET_BROADCAST:
 172                 break;
 173
 174         case PACKET_MULTICAST:
 175                 stats->multicast++;
 176                 break;
 177
 178         case PACKET_OTHERHOST:
 179                 /* Our lower layer thinks this is not local, let's make sure.
 180                  * This allows the VLAN to have a different MAC than the underlying
 181                  * device, and still route correctly.
 182                  */
 183                 if (!memcmp(skb->mac.ethernet->h_dest, skb->dev->dev_addr, ETH_ALEN))
 184                         skb->pkt_type = PACKET_HOST;
 185                 break;
 186         };
 187
 188         return (polling ? netif_receive_skb(skb) : netif_rx(skb));
 189 }
 190
 191 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
 192                                   struct vlan_group *grp,
 193                                   unsigned short vlan_tag)
 194 {
 195         return __vlan_hwaccel_rx(skb, grp, vlan_tag, 0);
 196 }
 197
 198 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
 199                                            struct vlan_group *grp,
 200                                            unsigned short vlan_tag)
 201 {
 202         return __vlan_hwaccel_rx(skb, grp, vlan_tag, 1);
 203 }
 204
 205 /**
 206  * __vlan_put_tag - regular VLAN tag inserting
 207  * @skb: skbuff to tag
 208  * @tag: VLAN tag to insert
 209  *
 210  * Inserts the VLAN tag into @skb as part of the payload
 211  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
 212  *
 213  * Following the skb_unshare() example, in case of error, the calling function
 214  * doesn't have to worry about freeing the original skb.
 215  */
 216 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, unsigned short tag)
 217 {
 218         struct vlan_ethhdr *veth;
 219
 220         if (skb_headroom(skb) < VLAN_HLEN) {
 221                 struct sk_buff *sk_tmp = skb;
 222                 skb = skb_realloc_headroom(sk_tmp, VLAN_HLEN);
 223                 kfree_skb(sk_tmp);
 224                 if (!skb) {
 225                         printk(KERN_ERR "vlan: failed to realloc headroom\n");
 226                         return NULL;
 227                 }
 228         } else {
 229                 skb = skb_unshare(skb, GFP_ATOMIC);
 230                 if (!skb) {
 231                         printk(KERN_ERR "vlan: failed to unshare skbuff\n");
 232                         return NULL;
 233                 }
 234         }
 235
 236         veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
 237
 238         /* Move the mac addresses to the beginning of the new header. */
 239         memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
 240
 241         /* first, the ethernet type */
 242         veth->h_vlan_proto = __constant_htons(ETH_P_8021Q);
 243
 244         /* now, the tag */
 245         veth->h_vlan_TCI = htons(tag);
 246
 247         skb->protocol = __constant_htons(ETH_P_8021Q);
 248         skb->mac.raw -= VLAN_HLEN;
 249         skb->nh.raw -= VLAN_HLEN;
 250
 251         return skb;
 252 }
 253
 254 /**
 255  * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
 256  * @skb: skbuff to tag
 257  * @tag: VLAN tag to insert
 258  *
 259  * Puts the VLAN tag in @skb->cb[] and lets the device do the rest
 260  */
 261 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb, unsigned short tag)
 262 {
 263         struct vlan_skb_tx_cookie *cookie;
 264
 265         cookie = VLAN_TX_SKB_CB(skb);
 266         cookie->magic = VLAN_TX_COOKIE_MAGIC;
 267         cookie->vlan_tag = tag;
 268
 269         return skb;
 270 }
 271
 272 #define HAVE_VLAN_PUT_TAG
 273
 274 /**
 275  * vlan_put_tag - inserts VLAN tag according to device features
 276  * @skb: skbuff to tag
 277  * @tag: VLAN tag to insert
 278  *
 279  * Assumes skb->dev is the target that will xmit this frame.
 280  * Returns a VLAN tagged skb.
 281  */
 282 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, unsigned short tag)
 283 {
 284         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 285                 return __vlan_hwaccel_put_tag(skb, tag);
 286         } else {
 287                 return __vlan_put_tag(skb, tag);
 288         }
 289 }
 290
 291 /**
 292  * __vlan_get_tag - get the VLAN ID that is part of the payload
 293  * @skb: skbuff to query
 294  * @tag: buffer to store vlaue
 295  *
 296  * Returns error if the skb is not of VLAN type
 297  */
 298 static inline int __vlan_get_tag(struct sk_buff *skb, unsigned short *tag)
 299 {
 300         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
 301
 302         if (veth->h_vlan_proto != __constant_htons(ETH_P_8021Q)) {
 303                 return -EINVAL;
 304         }
 305
 306         *tag = ntohs(veth->h_vlan_TCI);
 307
 308         return 0;
 309 }
 310
 311 /**
 312  * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
 313  * @skb: skbuff to query
 314  * @tag: buffer to store vlaue
 315  *
 316  * Returns error if @skb->cb[] is not set correctly
 317  */
 318 static inline int __vlan_hwaccel_get_tag(struct sk_buff *skb, unsigned short *tag)
 319 {
 320         struct vlan_skb_tx_cookie *cookie;
 321
 322         cookie = VLAN_TX_SKB_CB(skb);
 323         if (cookie->magic == VLAN_TX_COOKIE_MAGIC) {
 324                 *tag = cookie->vlan_tag;
 325                 return 0;
 326         } else {
 327                 *tag = 0;
 328                 return -EINVAL;
 329         }
 330 }
 331
 332 #define HAVE_VLAN_GET_TAG
 333
 334 /**
 335  * vlan_get_tag - get the VLAN ID from the skb
 336  * @skb: skbuff to query
 337  * @tag: buffer to store vlaue
 338  *
 339  * Returns error if the skb is not VLAN tagged
 340  */
 341 static inline int vlan_get_tag(struct sk_buff *skb, unsigned short *tag)
 342 {
 343         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 344                 return __vlan_hwaccel_get_tag(skb, tag);
 345         } else {
 346                 return __vlan_get_tag(skb, tag);
 347         }
 348 }
 349
 350 #endif /* __KERNEL__ */
 351
 352 /* VLAN IOCTLs are found in sockios.h */
 353
 354 /* Passed in vlan_ioctl_args structure to determine behaviour. */
 355 enum vlan_ioctl_cmds {
 356         ADD_VLAN_CMD,
 357         DEL_VLAN_CMD,
 358         SET_VLAN_INGRESS_PRIORITY_CMD,
 359         SET_VLAN_EGRESS_PRIORITY_CMD,
 360         GET_VLAN_INGRESS_PRIORITY_CMD,
 361         GET_VLAN_EGRESS_PRIORITY_CMD,
 362         SET_VLAN_NAME_TYPE_CMD,
 363         SET_VLAN_FLAG_CMD
 364 };
 365
 366 enum vlan_name_types {
 367         VLAN_NAME_TYPE_PLUS_VID, /* Name will look like:  vlan0005 */
 368         VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like:  eth1.0005 */
 369         VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like:  vlan5 */
 370         VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like:  eth0.5 */
 371         VLAN_NAME_TYPE_HIGHEST
 372 };
 373
 374 struct vlan_ioctl_args {
 375         int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
 376         char device1[24];
 377
 378         union {
 379                 char device2[24];
 380                 int VID;
 381                 unsigned int skb_priority;
 382                 unsigned int name_type;
 383                 unsigned int bind_type;
 384                 unsigned int flag; /* Matches vlan_dev_info flags */
 385         } u;
 386
 387         short vlan_qos;
 388 };
 389
 390 #endif /* !(_LINUX_IF_VLAN_H_) */