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 #ifndef _LINUX_IF_VLAN_H_
  13 #define _LINUX_IF_VLAN_H_
  14
  15 #include <linux/netdevice.h>
  16 #include <linux/etherdevice.h>
  17 #include <linux/rtnetlink.h>
  18 #include <linux/bug.h>
  19 #include <uapi/linux/if_vlan.h>
  20
  21 #define VLAN_HLEN       4               /* The additional bytes required by VLAN
  22                                          * (in addition to the Ethernet header)
  23                                          */
  24 #define VLAN_ETH_HLEN   18              /* Total octets in header.       */
  25 #define VLAN_ETH_ZLEN   64              /* Min. octets in frame sans FCS */
  26
  27 /*
  28  * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
  29  */
  30 #define VLAN_ETH_DATA_LEN       1500    /* Max. octets in payload        */
  31 #define VLAN_ETH_FRAME_LEN      1518    /* Max. octets in frame sans FCS */
  32
  33 /*
  34  *      struct vlan_hdr - vlan header
  35  *      @h_vlan_TCI: priority and VLAN ID
  36  *      @h_vlan_encapsulated_proto: packet type ID or len
  37  */
  38 struct vlan_hdr {
  39         __be16  h_vlan_TCI;
  40         __be16  h_vlan_encapsulated_proto;
  41 };
  42
  43 /**
  44  *      struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
  45  *      @h_dest: destination ethernet address
  46  *      @h_source: source ethernet address
  47  *      @h_vlan_proto: ethernet protocol
  48  *      @h_vlan_TCI: priority and VLAN ID
  49  *      @h_vlan_encapsulated_proto: packet type ID or len
  50  */
  51 struct vlan_ethhdr {
  52         unsigned char   h_dest[ETH_ALEN];
  53         unsigned char   h_source[ETH_ALEN];
  54         __be16          h_vlan_proto;
  55         __be16          h_vlan_TCI;
  56         __be16          h_vlan_encapsulated_proto;
  57 };
  58
  59 #include <linux/skbuff.h>
  60
  61 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
  62 {
  63         return (struct vlan_ethhdr *)skb_mac_header(skb);
  64 }
  65
  66 #define VLAN_PRIO_MASK          0xe000 /* Priority Code Point */
  67 #define VLAN_PRIO_SHIFT         13
  68 #define VLAN_CFI_MASK           0x1000 /* Canonical Format Indicator */
  69 #define VLAN_TAG_PRESENT        VLAN_CFI_MASK
  70 #define VLAN_VID_MASK           0x0fff /* VLAN Identifier */
  71 #define VLAN_N_VID              4096
  72
  73 /* found in socket.c */
  74 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
  75
  76 static inline bool is_vlan_dev(struct net_device *dev)
  77 {
  78         return dev->priv_flags & IFF_802_1Q_VLAN;
  79 }
  80
  81 #define vlan_tx_tag_present(__skb)      ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
  82 #define vlan_tx_tag_get(__skb)          ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
  83 #define vlan_tx_tag_get_id(__skb)       ((__skb)->vlan_tci & VLAN_VID_MASK)
  84
  85 /**
  86  *      struct vlan_pcpu_stats - VLAN percpu rx/tx stats
  87  *      @rx_packets: number of received packets
  88  *      @rx_bytes: number of received bytes
  89  *      @rx_multicast: number of received multicast packets
  90  *      @tx_packets: number of transmitted packets
  91  *      @tx_bytes: number of transmitted bytes
  92  *      @syncp: synchronization point for 64bit counters
  93  *      @rx_errors: number of rx errors
  94  *      @tx_dropped: number of tx drops
  95  */
  96 struct vlan_pcpu_stats {
  97         u64                     rx_packets;
  98         u64                     rx_bytes;
  99         u64                     rx_multicast;
 100         u64                     tx_packets;
 101         u64                     tx_bytes;
 102         struct u64_stats_sync   syncp;
 103         u32                     rx_errors;
 104         u32                     tx_dropped;
 105 };
 106
 107 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
 108
 109 extern struct net_device *__vlan_find_dev_deep(struct net_device *real_dev,
 110                                                __be16 vlan_proto, u16 vlan_id);
 111 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
 112 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
 113 extern __be16 vlan_dev_vlan_proto(const struct net_device *dev);
 114
 115 /**
 116  *      struct vlan_priority_tci_mapping - vlan egress priority mappings
 117  *      @priority: skb priority
 118  *      @vlan_qos: vlan priority: (skb->priority << 13) & 0xE000
 119  *      @next: pointer to next struct
 120  */
 121 struct vlan_priority_tci_mapping {
 122         u32                                     priority;
 123         u16                                     vlan_qos;
 124         struct vlan_priority_tci_mapping        *next;
 125 };
 126
 127 struct proc_dir_entry;
 128 struct netpoll;
 129
 130 /**
 131  *      struct vlan_dev_priv - VLAN private device data
 132  *      @nr_ingress_mappings: number of ingress priority mappings
 133  *      @ingress_priority_map: ingress priority mappings
 134  *      @nr_egress_mappings: number of egress priority mappings
 135  *      @egress_priority_map: hash of egress priority mappings
 136  *      @vlan_proto: VLAN encapsulation protocol
 137  *      @vlan_id: VLAN identifier
 138  *      @flags: device flags
 139  *      @real_dev: underlying netdevice
 140  *      @real_dev_addr: address of underlying netdevice
 141  *      @dent: proc dir entry
 142  *      @vlan_pcpu_stats: ptr to percpu rx stats
 143  */
 144 struct vlan_dev_priv {
 145         unsigned int                            nr_ingress_mappings;
 146         u32                                     ingress_priority_map[8];
 147         unsigned int                            nr_egress_mappings;
 148         struct vlan_priority_tci_mapping        *egress_priority_map[16];
 149
 150         __be16                                  vlan_proto;
 151         u16                                     vlan_id;
 152         u16                                     flags;
 153
 154         struct net_device                       *real_dev;
 155         unsigned char                           real_dev_addr[ETH_ALEN];
 156
 157         struct proc_dir_entry                   *dent;
 158         struct vlan_pcpu_stats __percpu         *vlan_pcpu_stats;
 159 #ifdef CONFIG_NET_POLL_CONTROLLER
 160         struct netpoll                          *netpoll;
 161 #endif
 162         unsigned int                            nest_level;
 163 };
 164
 165 static inline struct vlan_dev_priv *vlan_dev_priv(const struct net_device *dev)
 166 {
 167         return netdev_priv(dev);
 168 }
 169
 170 static inline u16
 171 vlan_dev_get_egress_qos_mask(struct net_device *dev, u32 skprio)
 172 {
 173         struct vlan_priority_tci_mapping *mp;
 174
 175         smp_rmb(); /* coupled with smp_wmb() in vlan_dev_set_egress_priority() */
 176
 177         mp = vlan_dev_priv(dev)->egress_priority_map[(skprio & 0xF)];
 178         while (mp) {
 179                 if (mp->priority == skprio) {
 180                         return mp->vlan_qos; /* This should already be shifted
 181                                               * to mask correctly with the
 182                                               * VLAN's TCI */
 183                 }
 184                 mp = mp->next;
 185         }
 186         return 0;
 187 }
 188
 189 extern bool vlan_do_receive(struct sk_buff **skb);
 190 extern struct sk_buff *vlan_untag(struct sk_buff *skb);
 191
 192 extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
 193 extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
 194
 195 extern int vlan_vids_add_by_dev(struct net_device *dev,
 196                                 const struct net_device *by_dev);
 197 extern void vlan_vids_del_by_dev(struct net_device *dev,
 198                                  const struct net_device *by_dev);
 199
 200 extern bool vlan_uses_dev(const struct net_device *dev);
 201 #else
 202 static inline struct net_device *
 203 __vlan_find_dev_deep(struct net_device *real_dev,
 204                      __be16 vlan_proto, u16 vlan_id)
 205 {
 206         return NULL;
 207 }
 208
 209 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
 210 {
 211         BUG();
 212         return NULL;
 213 }
 214
 215 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
 216 {
 217         BUG();
 218         return 0;
 219 }
 220
 221 static inline __be16 vlan_dev_vlan_proto(const struct net_device *dev)
 222 {
 223         BUG();
 224         return 0;
 225 }
 226
 227 static inline u16 vlan_dev_get_egress_qos_mask(struct net_device *dev,
 228                                                u32 skprio)
 229 {
 230         return 0;
 231 }
 232
 233 static inline bool vlan_do_receive(struct sk_buff **skb)
 234 {
 235         return false;
 236 }
 237
 238 static inline struct sk_buff *vlan_untag(struct sk_buff *skb)
 239 {
 240         return skb;
 241 }
 242
 243 static inline int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid)
 244 {
 245         return 0;
 246 }
 247
 248 static inline void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid)
 249 {
 250 }
 251
 252 static inline int vlan_vids_add_by_dev(struct net_device *dev,
 253                                        const struct net_device *by_dev)
 254 {
 255         return 0;
 256 }
 257
 258 static inline void vlan_vids_del_by_dev(struct net_device *dev,
 259                                         const struct net_device *by_dev)
 260 {
 261 }
 262
 263 static inline bool vlan_uses_dev(const struct net_device *dev)
 264 {
 265         return false;
 266 }
 267 #endif
 268
 269 static inline bool vlan_hw_offload_capable(netdev_features_t features,
 270                                            __be16 proto)
 271 {
 272         if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
 273                 return true;
 274         if (proto == htons(ETH_P_8021AD) && features & NETIF_F_HW_VLAN_STAG_TX)
 275                 return true;
 276         return false;
 277 }
 278
 279 /**
 280  * vlan_insert_tag - regular VLAN tag inserting
 281  * @skb: skbuff to tag
 282  * @vlan_proto: VLAN encapsulation protocol
 283  * @vlan_tci: VLAN TCI to insert
 284  *
 285  * Inserts the VLAN tag into @skb as part of the payload
 286  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
 287  *
 288  * Following the skb_unshare() example, in case of error, the calling function
 289  * doesn't have to worry about freeing the original skb.
 290  *
 291  * Does not change skb->protocol so this function can be used during receive.
 292  */
 293 static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
 294                                               __be16 vlan_proto, u16 vlan_tci)
 295 {
 296         struct vlan_ethhdr *veth;
 297
 298         if (skb_cow_head(skb, VLAN_HLEN) < 0) {
 299                 dev_kfree_skb_any(skb);
 300                 return NULL;
 301         }
 302         veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
 303
 304         /* Move the mac addresses to the beginning of the new header. */
 305         memmove(skb->data, skb->data + VLAN_HLEN, 2 * ETH_ALEN);
 306         skb->mac_header -= VLAN_HLEN;
 307
 308         /* first, the ethernet type */
 309         veth->h_vlan_proto = vlan_proto;
 310
 311         /* now, the TCI */
 312         veth->h_vlan_TCI = htons(vlan_tci);
 313
 314         return skb;
 315 }
 316
 317 /**
 318  * __vlan_put_tag - regular VLAN tag inserting
 319  * @skb: skbuff to tag
 320  * @vlan_tci: VLAN TCI to insert
 321  *
 322  * Inserts the VLAN tag into @skb as part of the payload
 323  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
 324  *
 325  * Following the skb_unshare() example, in case of error, the calling function
 326  * doesn't have to worry about freeing the original skb.
 327  */
 328 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb,
 329                                              __be16 vlan_proto, u16 vlan_tci)
 330 {
 331         skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
 332         if (skb)
 333                 skb->protocol = vlan_proto;
 334         return skb;
 335 }
 336
 337 /**
 338  * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
 339  * @skb: skbuff to tag
 340  * @vlan_proto: VLAN encapsulation protocol
 341  * @vlan_tci: VLAN TCI to insert
 342  *
 343  * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
 344  */
 345 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
 346                                                      __be16 vlan_proto,
 347                                                      u16 vlan_tci)
 348 {
 349         skb->vlan_proto = vlan_proto;
 350         skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
 351         return skb;
 352 }
 353
 354 /**
 355  * vlan_put_tag - inserts VLAN tag according to device features
 356  * @skb: skbuff to tag
 357  * @vlan_tci: VLAN TCI to insert
 358  *
 359  * Assumes skb->dev is the target that will xmit this frame.
 360  * Returns a VLAN tagged skb.
 361  */
 362 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb,
 363                                            __be16 vlan_proto, u16 vlan_tci)
 364 {
 365         if (vlan_hw_offload_capable(skb->dev->features, vlan_proto)) {
 366                 return __vlan_hwaccel_put_tag(skb, vlan_proto, vlan_tci);
 367         } else {
 368                 return __vlan_put_tag(skb, vlan_proto, vlan_tci);
 369         }
 370 }
 371
 372 /**
 373  * __vlan_get_tag - get the VLAN ID that is part of the payload
 374  * @skb: skbuff to query
 375  * @vlan_tci: buffer to store vlaue
 376  *
 377  * Returns error if the skb is not of VLAN type
 378  */
 379 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
 380 {
 381         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
 382
 383         if (veth->h_vlan_proto != htons(ETH_P_8021Q) &&
 384             veth->h_vlan_proto != htons(ETH_P_8021AD))
 385                 return -EINVAL;
 386
 387         *vlan_tci = ntohs(veth->h_vlan_TCI);
 388         return 0;
 389 }
 390
 391 /**
 392  * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
 393  * @skb: skbuff to query
 394  * @vlan_tci: buffer to store vlaue
 395  *
 396  * Returns error if @skb->vlan_tci is not set correctly
 397  */
 398 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
 399                                          u16 *vlan_tci)
 400 {
 401         if (vlan_tx_tag_present(skb)) {
 402                 *vlan_tci = vlan_tx_tag_get(skb);
 403                 return 0;
 404         } else {
 405                 *vlan_tci = 0;
 406                 return -EINVAL;
 407         }
 408 }
 409
 410 #define HAVE_VLAN_GET_TAG
 411
 412 /**
 413  * vlan_get_tag - get the VLAN ID from the skb
 414  * @skb: skbuff to query
 415  * @vlan_tci: buffer to store vlaue
 416  *
 417  * Returns error if the skb is not VLAN tagged
 418  */
 419 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
 420 {
 421         if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
 422                 return __vlan_hwaccel_get_tag(skb, vlan_tci);
 423         } else {
 424                 return __vlan_get_tag(skb, vlan_tci);
 425         }
 426 }
 427
 428 /**
 429  * vlan_get_protocol - get protocol EtherType.
 430  * @skb: skbuff to query
 431  *
 432  * Returns the EtherType of the packet, regardless of whether it is
 433  * vlan encapsulated (normal or hardware accelerated) or not.
 434  */
 435 static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
 436 {
 437         __be16 protocol = 0;
 438
 439         if (vlan_tx_tag_present(skb) ||
 440              skb->protocol != cpu_to_be16(ETH_P_8021Q))
 441                 protocol = skb->protocol;
 442         else {
 443                 __be16 proto, *protop;
 444                 protop = skb_header_pointer(skb, offsetof(struct vlan_ethhdr,
 445                                                 h_vlan_encapsulated_proto),
 446                                                 sizeof(proto), &proto);
 447                 if (likely(protop))
 448                         protocol = *protop;
 449         }
 450
 451         return protocol;
 452 }
 453
 454 static inline void vlan_set_encap_proto(struct sk_buff *skb,
 455                                         struct vlan_hdr *vhdr)
 456 {
 457         __be16 proto;
 458         unsigned short *rawp;
 459
 460         /*
 461          * Was a VLAN packet, grab the encapsulated protocol, which the layer
 462          * three protocols care about.
 463          */
 464
 465         proto = vhdr->h_vlan_encapsulated_proto;
 466         if (ntohs(proto) >= ETH_P_802_3_MIN) {
 467                 skb->protocol = proto;
 468                 return;
 469         }
 470
 471         rawp = (unsigned short *)(vhdr + 1);
 472         if (*rawp == 0xFFFF)
 473                 /*
 474                  * This is a magic hack to spot IPX packets. Older Novell
 475                  * breaks the protocol design and runs IPX over 802.3 without
 476                  * an 802.2 LLC layer. We look for FFFF which isn't a used
 477                  * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
 478                  * but does for the rest.
 479                  */
 480                 skb->protocol = htons(ETH_P_802_3);
 481         else
 482                 /*
 483                  * Real 802.2 LLC
 484                  */
 485                 skb->protocol = htons(ETH_P_802_2);
 486 }
 487 #endif /* !(_LINUX_IF_VLAN_H_) */