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