if_vlan.h 13 KB

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