SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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         struct net_device       *real_dev; /* The ethernet(like) device
  85                                             * the vlan is attached to.
  86                                             */
  87         unsigned int            nr_vlans;
  88         struct hlist_node       hlist;  /* linked list */
  89         struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
  90         struct rcu_head         rcu;
  91 };
  92
  93 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
  94                                                        unsigned int vlan_id)
  95 {
  96         struct net_device **array;
  97         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
  98         return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
  99 }
 100
 101 static inline void vlan_group_set_device(struct vlan_group *vg,
 102                                          unsigned int vlan_id,
 103                                          struct net_device *dev)
 104 {
 105         struct net_device **array;
 106         if (!vg)
 107                 return;
 108         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
 109         array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
 110 }
 111
 112 /* VLAN tx hw acceleration helpers. */
 113 struct vlan_skb_tx_cookie {
 114         u32     magic;
 115         u32     vlan_tag;
 116 };
 117
 118 #define VLAN_TX_COOKIE_MAGIC    0x564c414e      /* "VLAN" in ascii. */
 119 #define VLAN_TX_SKB_CB(__skb)   ((struct vlan_skb_tx_cookie *)&((__skb)->cb[0]))
 120 #define vlan_tx_tag_present(__skb) \
 121         (VLAN_TX_SKB_CB(__skb)->magic == VLAN_TX_COOKIE_MAGIC)
 122 #define vlan_tx_tag_get(__skb)  (VLAN_TX_SKB_CB(__skb)->vlan_tag)
 123
 124 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
 125 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
 126 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
 127
 128 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
 129                              unsigned short vlan_tag, int polling);
 130 #else
 131 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
 132 {
 133         BUG();
 134         return NULL;
 135 }
 136
 137 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
 138 {
 139         BUG();
 140         return 0;
 141 }
 142
 143 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
 144                                     unsigned short vlan_tag, int polling)
 145 {
 146         BUG();
 147         return NET_XMIT_SUCCESS;
 148 }
 149 #endif
 150
 151 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
 152                                   struct vlan_group *grp,
 153                                   unsigned short vlan_tag)
 154 {
 155         return __vlan_hwaccel_rx(skb, grp, vlan_tag, 0);
 156 }
 157
 158 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
 159                                            struct vlan_group *grp,
 160                                            unsigned short vlan_tag)
 161 {
 162         return __vlan_hwaccel_rx(skb, grp, vlan_tag, 1);
 163 }
 164
 165 /**
 166  * __vlan_put_tag - regular VLAN tag inserting
 167  * @skb: skbuff to tag
 168  * @tag: VLAN tag to insert
 169  *
 170  * Inserts the VLAN tag into @skb as part of the payload
 171  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
 172  *
 173  * Following the skb_unshare() example, in case of error, the calling function
 174  * doesn't have to worry about freeing the original skb.
 175  */
 176 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, unsigned short tag)
 177 {
 178         struct vlan_ethhdr *veth;
 179
 180         if (skb_headroom(skb) < VLAN_HLEN) {
 181                 struct sk_buff *sk_tmp = skb;
 182                 skb = skb_realloc_headroom(sk_tmp, VLAN_HLEN);
 183                 kfree_skb(sk_tmp);
 184                 if (!skb) {
 185                         printk(KERN_ERR "vlan: failed to realloc headroom\n");
 186                         return NULL;
 187                 }
 188         } else {
 189                 skb = skb_unshare(skb, GFP_ATOMIC);
 190                 if (!skb) {
 191                         printk(KERN_ERR "vlan: failed to unshare skbuff\n");
 192                         return NULL;
 193                 }
 194         }
 195
 196         veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
 197
 198         /* Move the mac addresses to the beginning of the new header. */
 199         memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
 200
 201         /* first, the ethernet type */
 202         veth->h_vlan_proto = htons(ETH_P_8021Q);
 203
 204         /* now, the tag */
 205         veth->h_vlan_TCI = htons(tag);
 206
 207         skb->protocol = htons(ETH_P_8021Q);
 208
 209         return skb;
 210 }
 211
 212 /**
 213  * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
 214  * @skb: skbuff to tag
 215  * @tag: VLAN tag to insert
 216  *
 217  * Puts the VLAN tag in @skb->cb[] and lets the device do the rest
 218  */
 219 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb, unsigned short tag)
 220 {
 221         struct vlan_skb_tx_cookie *cookie;
 222
 223         cookie = VLAN_TX_SKB_CB(skb);
 224         cookie->magic = VLAN_TX_COOKIE_MAGIC;
 225         cookie->vlan_tag = tag;
 226
 227         return skb;
 228 }
 229
 230 #define HAVE_VLAN_PUT_TAG
 231
 232 /**
 233  * vlan_put_tag - inserts VLAN tag according to device features
 234  * @skb: skbuff to tag
 235  * @tag: VLAN tag to insert
 236  *
 237  * Assumes skb->dev is the target that will xmit this frame.
 238  * Returns a VLAN tagged skb.
 239  */
 240 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, unsigned short tag)
 241 {
 242         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 243                 return __vlan_hwaccel_put_tag(skb, tag);
 244         } else {
 245                 return __vlan_put_tag(skb, tag);
 246         }
 247 }
 248
 249 /**
 250  * __vlan_get_tag - get the VLAN ID that is part of the payload
 251  * @skb: skbuff to query
 252  * @tag: buffer to store vlaue
 253  *
 254  * Returns error if the skb is not of VLAN type
 255  */
 256 static inline int __vlan_get_tag(const struct sk_buff *skb, unsigned short *tag)
 257 {
 258         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
 259
 260         if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
 261                 return -EINVAL;
 262         }
 263
 264         *tag = ntohs(veth->h_vlan_TCI);
 265
 266         return 0;
 267 }
 268
 269 /**
 270  * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
 271  * @skb: skbuff to query
 272  * @tag: buffer to store vlaue
 273  *
 274  * Returns error if @skb->cb[] is not set correctly
 275  */
 276 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
 277                                          unsigned short *tag)
 278 {
 279         struct vlan_skb_tx_cookie *cookie;
 280
 281         cookie = VLAN_TX_SKB_CB(skb);
 282         if (cookie->magic == VLAN_TX_COOKIE_MAGIC) {
 283                 *tag = cookie->vlan_tag;
 284                 return 0;
 285         } else {
 286                 *tag = 0;
 287                 return -EINVAL;
 288         }
 289 }
 290
 291 #define HAVE_VLAN_GET_TAG
 292
 293 /**
 294  * vlan_get_tag - get the VLAN ID from the skb
 295  * @skb: skbuff to query
 296  * @tag: buffer to store vlaue
 297  *
 298  * Returns error if the skb is not VLAN tagged
 299  */
 300 static inline int vlan_get_tag(const struct sk_buff *skb, unsigned short *tag)
 301 {
 302         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 303                 return __vlan_hwaccel_get_tag(skb, tag);
 304         } else {
 305                 return __vlan_get_tag(skb, tag);
 306         }
 307 }
 308
 309 #endif /* __KERNEL__ */
 310
 311 /* VLAN IOCTLs are found in sockios.h */
 312
 313 /* Passed in vlan_ioctl_args structure to determine behaviour. */
 314 enum vlan_ioctl_cmds {
 315         ADD_VLAN_CMD,
 316         DEL_VLAN_CMD,
 317         SET_VLAN_INGRESS_PRIORITY_CMD,
 318         SET_VLAN_EGRESS_PRIORITY_CMD,
 319         GET_VLAN_INGRESS_PRIORITY_CMD,
 320         GET_VLAN_EGRESS_PRIORITY_CMD,
 321         SET_VLAN_NAME_TYPE_CMD,
 322         SET_VLAN_FLAG_CMD,
 323         GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
 324         GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
 325 };
 326
 327 enum vlan_flags {
 328         VLAN_FLAG_REORDER_HDR   = 0x1,
 329         VLAN_FLAG_GVRP          = 0x2,
 330 };
 331
 332 enum vlan_name_types {
 333         VLAN_NAME_TYPE_PLUS_VID, /* Name will look like:  vlan0005 */
 334         VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like:  eth1.0005 */
 335         VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like:  vlan5 */
 336         VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like:  eth0.5 */
 337         VLAN_NAME_TYPE_HIGHEST
 338 };
 339
 340 struct vlan_ioctl_args {
 341         int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
 342         char device1[24];
 343
 344         union {
 345                 char device2[24];
 346                 int VID;
 347                 unsigned int skb_priority;
 348                 unsigned int name_type;
 349                 unsigned int bind_type;
 350                 unsigned int flag; /* Matches vlan_dev_info flags */
 351         } u;
 352
 353         short vlan_qos;
 354 };
 355
 356 #endif /* !(_LINUX_IF_VLAN_H_) */