Pileus Git - ~andy/linux/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 #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         int                     killall;
  90         struct hlist_node       hlist;  /* linked list */
  91         struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
  92         struct rcu_head         rcu;
  93 };
  94
  95 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
  96                                                        u16 vlan_id)
  97 {
  98         struct net_device **array;
  99         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
 100         return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
 101 }
 102
 103 static inline void vlan_group_set_device(struct vlan_group *vg,
 104                                          u16 vlan_id,
 105                                          struct net_device *dev)
 106 {
 107         struct net_device **array;
 108         if (!vg)
 109                 return;
 110         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
 111         array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
 112 }
 113
 114 #define vlan_tx_tag_present(__skb)      ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
 115 #define vlan_tx_tag_get(__skb)          ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
 116
 117 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
 118 /* Must be invoked with rcu_read_lock or with RTNL. */
 119 static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
 120                                                u16 vlan_id)
 121 {
 122         struct vlan_group *grp = rcu_dereference_rtnl(real_dev->vlgrp);
 123
 124         if (grp)
 125                 return vlan_group_get_device(grp, vlan_id);
 126
 127         return NULL;
 128 }
 129
 130 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
 131 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
 132
 133 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
 134                              u16 vlan_tci, int polling);
 135 extern bool vlan_hwaccel_do_receive(struct sk_buff **skb);
 136 extern gro_result_t
 137 vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
 138                  unsigned int vlan_tci, struct sk_buff *skb);
 139 extern gro_result_t
 140 vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
 141                unsigned int vlan_tci);
 142
 143 #else
 144 static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
 145                                                u16 vlan_id)
 146 {
 147         return NULL;
 148 }
 149
 150 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
 151 {
 152         BUG();
 153         return NULL;
 154 }
 155
 156 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
 157 {
 158         BUG();
 159         return 0;
 160 }
 161
 162 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
 163                                     u16 vlan_tci, int polling)
 164 {
 165         BUG();
 166         return NET_XMIT_SUCCESS;
 167 }
 168
 169 static inline bool vlan_hwaccel_do_receive(struct sk_buff **skb)
 170 {
 171         BUG();
 172         return false;
 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_put_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 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
 228 {
 229         struct vlan_ethhdr *veth;
 230
 231         if (skb_cow_head(skb, VLAN_HLEN) < 0) {
 232                 kfree_skb(skb);
 233                 return NULL;
 234         }
 235         veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
 236
 237         /* Move the mac addresses to the beginning of the new header. */
 238         memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
 239         skb->mac_header -= VLAN_HLEN;
 240
 241         /* first, the ethernet type */
 242         veth->h_vlan_proto = htons(ETH_P_8021Q);
 243
 244         /* now, the TCI */
 245         veth->h_vlan_TCI = htons(vlan_tci);
 246
 247         skb->protocol = htons(ETH_P_8021Q);
 248
 249         return skb;
 250 }
 251
 252 /**
 253  * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
 254  * @skb: skbuff to tag
 255  * @vlan_tci: VLAN TCI to insert
 256  *
 257  * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
 258  */
 259 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
 260                                                      u16 vlan_tci)
 261 {
 262         skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
 263         return skb;
 264 }
 265
 266 #define HAVE_VLAN_PUT_TAG
 267
 268 /**
 269  * vlan_put_tag - inserts VLAN tag according to device features
 270  * @skb: skbuff to tag
 271  * @vlan_tci: VLAN TCI to insert
 272  *
 273  * Assumes skb->dev is the target that will xmit this frame.
 274  * Returns a VLAN tagged skb.
 275  */
 276 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
 277 {
 278         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 279                 return __vlan_hwaccel_put_tag(skb, vlan_tci);
 280         } else {
 281                 return __vlan_put_tag(skb, vlan_tci);
 282         }
 283 }
 284
 285 /**
 286  * __vlan_get_tag - get the VLAN ID that is part of the payload
 287  * @skb: skbuff to query
 288  * @vlan_tci: buffer to store vlaue
 289  *
 290  * Returns error if the skb is not of VLAN type
 291  */
 292 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
 293 {
 294         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
 295
 296         if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
 297                 return -EINVAL;
 298         }
 299
 300         *vlan_tci = ntohs(veth->h_vlan_TCI);
 301         return 0;
 302 }
 303
 304 /**
 305  * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
 306  * @skb: skbuff to query
 307  * @vlan_tci: buffer to store vlaue
 308  *
 309  * Returns error if @skb->vlan_tci is not set correctly
 310  */
 311 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
 312                                          u16 *vlan_tci)
 313 {
 314         if (vlan_tx_tag_present(skb)) {
 315                 *vlan_tci = vlan_tx_tag_get(skb);
 316                 return 0;
 317         } else {
 318                 *vlan_tci = 0;
 319                 return -EINVAL;
 320         }
 321 }
 322
 323 #define HAVE_VLAN_GET_TAG
 324
 325 /**
 326  * vlan_get_tag - get the VLAN ID from the skb
 327  * @skb: skbuff to query
 328  * @vlan_tci: buffer to store vlaue
 329  *
 330  * Returns error if the skb is not VLAN tagged
 331  */
 332 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
 333 {
 334         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
 335                 return __vlan_hwaccel_get_tag(skb, vlan_tci);
 336         } else {
 337                 return __vlan_get_tag(skb, vlan_tci);
 338         }
 339 }
 340
 341 #endif /* __KERNEL__ */
 342
 343 /* VLAN IOCTLs are found in sockios.h */
 344
 345 /* Passed in vlan_ioctl_args structure to determine behaviour. */
 346 enum vlan_ioctl_cmds {
 347         ADD_VLAN_CMD,
 348         DEL_VLAN_CMD,
 349         SET_VLAN_INGRESS_PRIORITY_CMD,
 350         SET_VLAN_EGRESS_PRIORITY_CMD,
 351         GET_VLAN_INGRESS_PRIORITY_CMD,
 352         GET_VLAN_EGRESS_PRIORITY_CMD,
 353         SET_VLAN_NAME_TYPE_CMD,
 354         SET_VLAN_FLAG_CMD,
 355         GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
 356         GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
 357 };
 358
 359 enum vlan_flags {
 360         VLAN_FLAG_REORDER_HDR   = 0x1,
 361         VLAN_FLAG_GVRP          = 0x2,
 362         VLAN_FLAG_LOOSE_BINDING = 0x4,
 363 };
 364
 365 enum vlan_name_types {
 366         VLAN_NAME_TYPE_PLUS_VID, /* Name will look like:  vlan0005 */
 367         VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like:  eth1.0005 */
 368         VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like:  vlan5 */
 369         VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like:  eth0.5 */
 370         VLAN_NAME_TYPE_HIGHEST
 371 };
 372
 373 struct vlan_ioctl_args {
 374         int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
 375         char device1[24];
 376
 377         union {
 378                 char device2[24];
 379                 int VID;
 380                 unsigned int skb_priority;
 381                 unsigned int name_type;
 382                 unsigned int bind_type;
 383                 unsigned int flag; /* Matches vlan_dev_info flags */
 384         } u;
 385
 386         short vlan_qos;
 387 };
 388
 389 #endif /* !(_LINUX_IF_VLAN_H_) */