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 #include <linux/netdevice.h>
  18 #include <linux/etherdevice.h>
  19 #include <linux/rtnetlink.h>
  20 #include <linux/bug.h>
  21
  22 #define VLAN_HLEN       4               /* The additional bytes (on top of the Ethernet header)
  23                                          * that VLAN requires.
  24                                          */
  25 #define VLAN_ETH_ALEN   6               /* Octets in one ethernet addr   */
  26 #define VLAN_ETH_HLEN   18              /* Total octets in header.       */
  27 #define VLAN_ETH_ZLEN   64              /* Min. octets in frame sans FCS */
  28
  29 /*
  30  * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
  31  */
  32 #define VLAN_ETH_DATA_LEN       1500    /* Max. octets in payload        */
  33 #define VLAN_ETH_FRAME_LEN      1518    /* Max. octets in frame sans FCS */
  34
  35 /*
  36  *      struct vlan_hdr - vlan header
  37  *      @h_vlan_TCI: priority and VLAN ID
  38  *      @h_vlan_encapsulated_proto: packet type ID or len
  39  */
  40 struct vlan_hdr {
  41         __be16  h_vlan_TCI;
  42         __be16  h_vlan_encapsulated_proto;
  43 };
  44
  45 /**
  46  *      struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
  47  *      @h_dest: destination ethernet address
  48  *      @h_source: source ethernet address
  49  *      @h_vlan_proto: ethernet protocol (always 0x8100)
  50  *      @h_vlan_TCI: priority and VLAN ID
  51  *      @h_vlan_encapsulated_proto: packet type ID or len
  52  */
  53 struct vlan_ethhdr {
  54         unsigned char   h_dest[ETH_ALEN];
  55         unsigned char   h_source[ETH_ALEN];
  56         __be16          h_vlan_proto;
  57         __be16          h_vlan_TCI;
  58         __be16          h_vlan_encapsulated_proto;
  59 };
  60
  61 #include <linux/skbuff.h>
  62
  63 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
  64 {
  65         return (struct vlan_ethhdr *)skb_mac_header(skb);
  66 }
  67
  68 #define VLAN_PRIO_MASK          0xe000 /* Priority Code Point */
  69 #define VLAN_PRIO_SHIFT         13
  70 #define VLAN_CFI_MASK           0x1000 /* Canonical Format Indicator */
  71 #define VLAN_TAG_PRESENT        VLAN_CFI_MASK
  72 #define VLAN_VID_MASK           0x0fff /* VLAN Identifier */
  73 #define VLAN_N_VID              4096
  74
  75 /* found in socket.c */
  76 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
  77
  78 struct vlan_info;
  79
  80 static inline int is_vlan_dev(struct net_device *dev)
  81 {
  82         return dev->priv_flags & IFF_802_1Q_VLAN;
  83 }
  84
  85 #define vlan_tx_tag_present(__skb)      ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
  86 #define vlan_tx_tag_get(__skb)          ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
  87
  88 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
  89
  90 extern struct net_device *__vlan_find_dev_deep(struct net_device *real_dev,
  91                                                u16 vlan_id);
  92 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
  93 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
  94
  95 extern bool vlan_do_receive(struct sk_buff **skb, bool last_handler);
  96 extern struct sk_buff *vlan_untag(struct sk_buff *skb);
  97
  98 extern int vlan_vid_add(struct net_device *dev, unsigned short vid);
  99 extern void vlan_vid_del(struct net_device *dev, unsigned short vid);
 100
 101 extern int vlan_vids_add_by_dev(struct net_device *dev,
 102                                 const struct net_device *by_dev);
 103 extern void vlan_vids_del_by_dev(struct net_device *dev,
 104                                  const struct net_device *by_dev);
 105 #else
 106 static inline struct net_device *
 107 __vlan_find_dev_deep(struct net_device *real_dev, u16 vlan_id)
 108 {
 109         return NULL;
 110 }
 111
 112 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
 113 {
 114         BUG();
 115         return NULL;
 116 }
 117
 118 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
 119 {
 120         BUG();
 121         return 0;
 122 }
 123
 124 static inline bool vlan_do_receive(struct sk_buff **skb, bool last_handler)
 125 {
 126         if (((*skb)->vlan_tci & VLAN_VID_MASK) && last_handler)
 127                 (*skb)->pkt_type = PACKET_OTHERHOST;
 128         return false;
 129 }
 130
 131 static inline struct sk_buff *vlan_untag(struct sk_buff *skb)
 132 {
 133         return skb;
 134 }
 135
 136 static inline int vlan_vid_add(struct net_device *dev, unsigned short vid)
 137 {
 138         return 0;
 139 }
 140
 141 static inline void vlan_vid_del(struct net_device *dev, unsigned short vid)
 142 {
 143 }
 144
 145 static inline int vlan_vids_add_by_dev(struct net_device *dev,
 146                                        const struct net_device *by_dev)
 147 {
 148         return 0;
 149 }
 150
 151 static inline void vlan_vids_del_by_dev(struct net_device *dev,
 152                                         const struct net_device *by_dev)
 153 {
 154 }
 155 #endif
 156
 157 /**
 158  * vlan_insert_tag - regular VLAN tag inserting
 159  * @skb: skbuff to tag
 160  * @vlan_tci: VLAN TCI to insert
 161  *
 162  * Inserts the VLAN tag into @skb as part of the payload
 163  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
 164  *
 165  * Following the skb_unshare() example, in case of error, the calling function
 166  * doesn't have to worry about freeing the original skb.
 167  *
 168  * Does not change skb->protocol so this function can be used during receive.
 169  */
 170 static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb, u16 vlan_tci)
 171 {
 172         struct vlan_ethhdr *veth;
 173
 174         if (skb_cow_head(skb, VLAN_HLEN) < 0) {
 175                 kfree_skb(skb);
 176                 return NULL;
 177         }
 178         veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
 179
 180         /* Move the mac addresses to the beginning of the new header. */
 181         memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
 182         skb->mac_header -= VLAN_HLEN;
 183
 184         /* first, the ethernet type */
 185         veth->h_vlan_proto = htons(ETH_P_8021Q);
 186
 187         /* now, the TCI */
 188         veth->h_vlan_TCI = htons(vlan_tci);
 189
 190         return skb;
 191 }
 192
 193 /**
 194  * __vlan_put_tag - regular VLAN tag inserting
 195  * @skb: skbuff to tag
 196  * @vlan_tci: VLAN TCI to insert
 197  *
 198  * Inserts the VLAN tag into @skb as part of the payload
 199  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
 200  *
 201  * Following the skb_unshare() example, in case of error, the calling function
 202  * doesn't have to worry about freeing the original skb.
 203  */
 204 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
 205 {
 206         skb = vlan_insert_tag(skb, vlan_tci);
 207         if (skb)
 208                 skb->protocol = htons(ETH_P_8021Q);
 209         return skb;
 210 }
 211
 212 /**
 213  * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
 214  * @skb: skbuff to tag
 215  * @vlan_tci: VLAN TCI to insert
 216  *
 217  * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
 218  */
 219 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
 220                                                      u16 vlan_tci)
 221 {
 222         skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
 223         return skb;
 224 }
 225
 226 #define HAVE_VLAN_PUT_TAG
 227
 228 /**
 229  * vlan_put_tag - inserts VLAN tag according to device features
 230  * @skb: skbuff to tag
 231  * @vlan_tci: VLAN TCI to insert
 232  *
 233  * Assumes skb->dev is the target that will xmit this frame.
 234  * Returns a VLAN tagged skb.
 235  */
 236 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
 237 {
 238         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 239                 return __vlan_hwaccel_put_tag(skb, vlan_tci);
 240         } else {
 241                 return __vlan_put_tag(skb, vlan_tci);
 242         }
 243 }
 244
 245 /**
 246  * __vlan_get_tag - get the VLAN ID that is part of the payload
 247  * @skb: skbuff to query
 248  * @vlan_tci: buffer to store vlaue
 249  *
 250  * Returns error if the skb is not of VLAN type
 251  */
 252 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
 253 {
 254         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
 255
 256         if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
 257                 return -EINVAL;
 258         }
 259
 260         *vlan_tci = ntohs(veth->h_vlan_TCI);
 261         return 0;
 262 }
 263
 264 /**
 265  * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
 266  * @skb: skbuff to query
 267  * @vlan_tci: buffer to store vlaue
 268  *
 269  * Returns error if @skb->vlan_tci is not set correctly
 270  */
 271 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
 272                                          u16 *vlan_tci)
 273 {
 274         if (vlan_tx_tag_present(skb)) {
 275                 *vlan_tci = vlan_tx_tag_get(skb);
 276                 return 0;
 277         } else {
 278                 *vlan_tci = 0;
 279                 return -EINVAL;
 280         }
 281 }
 282
 283 #define HAVE_VLAN_GET_TAG
 284
 285 /**
 286  * vlan_get_tag - get the VLAN ID from the skb
 287  * @skb: skbuff to query
 288  * @vlan_tci: buffer to store vlaue
 289  *
 290  * Returns error if the skb is not VLAN tagged
 291  */
 292 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
 293 {
 294         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 295                 return __vlan_hwaccel_get_tag(skb, vlan_tci);
 296         } else {
 297                 return __vlan_get_tag(skb, vlan_tci);
 298         }
 299 }
 300
 301 /**
 302  * vlan_get_protocol - get protocol EtherType.
 303  * @skb: skbuff to query
 304  *
 305  * Returns the EtherType of the packet, regardless of whether it is
 306  * vlan encapsulated (normal or hardware accelerated) or not.
 307  */
 308 static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
 309 {
 310         __be16 protocol = 0;
 311
 312         if (vlan_tx_tag_present(skb) ||
 313              skb->protocol != cpu_to_be16(ETH_P_8021Q))
 314                 protocol = skb->protocol;
 315         else {
 316                 __be16 proto, *protop;
 317                 protop = skb_header_pointer(skb, offsetof(struct vlan_ethhdr,
 318                                                 h_vlan_encapsulated_proto),
 319                                                 sizeof(proto), &proto);
 320                 if (likely(protop))
 321                         protocol = *protop;
 322         }
 323
 324         return protocol;
 325 }
 326
 327 static inline void vlan_set_encap_proto(struct sk_buff *skb,
 328                                         struct vlan_hdr *vhdr)
 329 {
 330         __be16 proto;
 331         unsigned char *rawp;
 332
 333         /*
 334          * Was a VLAN packet, grab the encapsulated protocol, which the layer
 335          * three protocols care about.
 336          */
 337
 338         proto = vhdr->h_vlan_encapsulated_proto;
 339         if (ntohs(proto) >= 1536) {
 340                 skb->protocol = proto;
 341                 return;
 342         }
 343
 344         rawp = skb->data;
 345         if (*(unsigned short *) rawp == 0xFFFF)
 346                 /*
 347                  * This is a magic hack to spot IPX packets. Older Novell
 348                  * breaks the protocol design and runs IPX over 802.3 without
 349                  * an 802.2 LLC layer. We look for FFFF which isn't a used
 350                  * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
 351                  * but does for the rest.
 352                  */
 353                 skb->protocol = htons(ETH_P_802_3);
 354         else
 355                 /*
 356                  * Real 802.2 LLC
 357                  */
 358                 skb->protocol = htons(ETH_P_802_2);
 359 }
 360 #endif /* __KERNEL__ */
 361
 362 /* VLAN IOCTLs are found in sockios.h */
 363
 364 /* Passed in vlan_ioctl_args structure to determine behaviour. */
 365 enum vlan_ioctl_cmds {
 366         ADD_VLAN_CMD,
 367         DEL_VLAN_CMD,
 368         SET_VLAN_INGRESS_PRIORITY_CMD,
 369         SET_VLAN_EGRESS_PRIORITY_CMD,
 370         GET_VLAN_INGRESS_PRIORITY_CMD,
 371         GET_VLAN_EGRESS_PRIORITY_CMD,
 372         SET_VLAN_NAME_TYPE_CMD,
 373         SET_VLAN_FLAG_CMD,
 374         GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
 375         GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
 376 };
 377
 378 enum vlan_flags {
 379         VLAN_FLAG_REORDER_HDR   = 0x1,
 380         VLAN_FLAG_GVRP          = 0x2,
 381         VLAN_FLAG_LOOSE_BINDING = 0x4,
 382 };
 383
 384 enum vlan_name_types {
 385         VLAN_NAME_TYPE_PLUS_VID, /* Name will look like:  vlan0005 */
 386         VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like:  eth1.0005 */
 387         VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like:  vlan5 */
 388         VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like:  eth0.5 */
 389         VLAN_NAME_TYPE_HIGHEST
 390 };
 391
 392 struct vlan_ioctl_args {
 393         int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
 394         char device1[24];
 395
 396         union {
 397                 char device2[24];
 398                 int VID;
 399                 unsigned int skb_priority;
 400                 unsigned int name_type;
 401                 unsigned int bind_type;
 402                 unsigned int flag; /* Matches vlan_dev_priv flags */
 403         } u;
 404
 405         short vlan_qos;
 406 };
 407
 408 #endif /* !(_LINUX_IF_VLAN_H_) */