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