if_vlan.h 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
  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 (always 0x8100)
  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 int 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_nonzero_tag_present(__skb) \
  72. (vlan_tx_tag_present(__skb) && ((__skb)->vlan_tci & VLAN_VID_MASK))
  73. #define vlan_tx_tag_get(__skb) ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
  74. #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
  75. extern struct net_device *__vlan_find_dev_deep(struct net_device *real_dev,
  76. __be16 vlan_proto, u16 vlan_id);
  77. extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
  78. extern u16 vlan_dev_vlan_id(const struct net_device *dev);
  79. extern bool vlan_do_receive(struct sk_buff **skb);
  80. extern struct sk_buff *vlan_untag(struct sk_buff *skb);
  81. extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
  82. extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
  83. extern int vlan_vids_add_by_dev(struct net_device *dev,
  84. const struct net_device *by_dev);
  85. extern void vlan_vids_del_by_dev(struct net_device *dev,
  86. const struct net_device *by_dev);
  87. extern bool vlan_uses_dev(const struct net_device *dev);
  88. #else
  89. static inline struct net_device *
  90. __vlan_find_dev_deep(struct net_device *real_dev, u16 vlan_id)
  91. {
  92. return NULL;
  93. }
  94. static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
  95. {
  96. BUG();
  97. return NULL;
  98. }
  99. static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
  100. {
  101. BUG();
  102. return 0;
  103. }
  104. static inline bool vlan_do_receive(struct sk_buff **skb)
  105. {
  106. return false;
  107. }
  108. static inline struct sk_buff *vlan_untag(struct sk_buff *skb)
  109. {
  110. return skb;
  111. }
  112. static inline int vlan_vid_add(struct net_device *dev, unsigned short vid)
  113. {
  114. return 0;
  115. }
  116. static inline void vlan_vid_del(struct net_device *dev, unsigned short vid)
  117. {
  118. }
  119. static inline int vlan_vids_add_by_dev(struct net_device *dev,
  120. const struct net_device *by_dev)
  121. {
  122. return 0;
  123. }
  124. static inline void vlan_vids_del_by_dev(struct net_device *dev,
  125. const struct net_device *by_dev)
  126. {
  127. }
  128. static inline bool vlan_uses_dev(const struct net_device *dev)
  129. {
  130. return false;
  131. }
  132. #endif
  133. /**
  134. * vlan_insert_tag - regular VLAN tag inserting
  135. * @skb: skbuff to tag
  136. * @vlan_tci: VLAN TCI to insert
  137. *
  138. * Inserts the VLAN tag into @skb as part of the payload
  139. * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
  140. *
  141. * Following the skb_unshare() example, in case of error, the calling function
  142. * doesn't have to worry about freeing the original skb.
  143. *
  144. * Does not change skb->protocol so this function can be used during receive.
  145. */
  146. static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb, u16 vlan_tci)
  147. {
  148. struct vlan_ethhdr *veth;
  149. if (skb_cow_head(skb, VLAN_HLEN) < 0) {
  150. kfree_skb(skb);
  151. return NULL;
  152. }
  153. veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
  154. /* Move the mac addresses to the beginning of the new header. */
  155. memmove(skb->data, skb->data + VLAN_HLEN, 2 * ETH_ALEN);
  156. skb->mac_header -= VLAN_HLEN;
  157. /* first, the ethernet type */
  158. veth->h_vlan_proto = htons(ETH_P_8021Q);
  159. /* now, the TCI */
  160. veth->h_vlan_TCI = htons(vlan_tci);
  161. return skb;
  162. }
  163. /**
  164. * __vlan_put_tag - regular VLAN tag inserting
  165. * @skb: skbuff to tag
  166. * @vlan_tci: VLAN TCI to insert
  167. *
  168. * Inserts the VLAN tag into @skb as part of the payload
  169. * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
  170. *
  171. * Following the skb_unshare() example, in case of error, the calling function
  172. * doesn't have to worry about freeing the original skb.
  173. */
  174. static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
  175. {
  176. skb = vlan_insert_tag(skb, vlan_tci);
  177. if (skb)
  178. skb->protocol = htons(ETH_P_8021Q);
  179. return skb;
  180. }
  181. /**
  182. * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
  183. * @skb: skbuff to tag
  184. * @vlan_tci: VLAN TCI to insert
  185. *
  186. * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
  187. */
  188. static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
  189. u16 vlan_tci)
  190. {
  191. skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
  192. return skb;
  193. }
  194. #define HAVE_VLAN_PUT_TAG
  195. /**
  196. * vlan_put_tag - inserts VLAN tag according to device features
  197. * @skb: skbuff to tag
  198. * @vlan_tci: VLAN TCI to insert
  199. *
  200. * Assumes skb->dev is the target that will xmit this frame.
  201. * Returns a VLAN tagged skb.
  202. */
  203. static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
  204. {
  205. if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
  206. return __vlan_hwaccel_put_tag(skb, vlan_tci);
  207. } else {
  208. return __vlan_put_tag(skb, vlan_tci);
  209. }
  210. }
  211. /**
  212. * __vlan_get_tag - get the VLAN ID that is part of the payload
  213. * @skb: skbuff to query
  214. * @vlan_tci: buffer to store vlaue
  215. *
  216. * Returns error if the skb is not of VLAN type
  217. */
  218. static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
  219. {
  220. struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
  221. if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
  222. return -EINVAL;
  223. }
  224. *vlan_tci = ntohs(veth->h_vlan_TCI);
  225. return 0;
  226. }
  227. /**
  228. * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
  229. * @skb: skbuff to query
  230. * @vlan_tci: buffer to store vlaue
  231. *
  232. * Returns error if @skb->vlan_tci is not set correctly
  233. */
  234. static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
  235. u16 *vlan_tci)
  236. {
  237. if (vlan_tx_tag_present(skb)) {
  238. *vlan_tci = vlan_tx_tag_get(skb);
  239. return 0;
  240. } else {
  241. *vlan_tci = 0;
  242. return -EINVAL;
  243. }
  244. }
  245. #define HAVE_VLAN_GET_TAG
  246. /**
  247. * vlan_get_tag - get the VLAN ID from the skb
  248. * @skb: skbuff to query
  249. * @vlan_tci: buffer to store vlaue
  250. *
  251. * Returns error if the skb is not VLAN tagged
  252. */
  253. static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
  254. {
  255. if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
  256. return __vlan_hwaccel_get_tag(skb, vlan_tci);
  257. } else {
  258. return __vlan_get_tag(skb, vlan_tci);
  259. }
  260. }
  261. /**
  262. * vlan_get_protocol - get protocol EtherType.
  263. * @skb: skbuff to query
  264. *
  265. * Returns the EtherType of the packet, regardless of whether it is
  266. * vlan encapsulated (normal or hardware accelerated) or not.
  267. */
  268. static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
  269. {
  270. __be16 protocol = 0;
  271. if (vlan_tx_tag_present(skb) ||
  272. skb->protocol != cpu_to_be16(ETH_P_8021Q))
  273. protocol = skb->protocol;
  274. else {
  275. __be16 proto, *protop;
  276. protop = skb_header_pointer(skb, offsetof(struct vlan_ethhdr,
  277. h_vlan_encapsulated_proto),
  278. sizeof(proto), &proto);
  279. if (likely(protop))
  280. protocol = *protop;
  281. }
  282. return protocol;
  283. }
  284. static inline void vlan_set_encap_proto(struct sk_buff *skb,
  285. struct vlan_hdr *vhdr)
  286. {
  287. __be16 proto;
  288. unsigned short *rawp;
  289. /*
  290. * Was a VLAN packet, grab the encapsulated protocol, which the layer
  291. * three protocols care about.
  292. */
  293. proto = vhdr->h_vlan_encapsulated_proto;
  294. if (ntohs(proto) >= ETH_P_802_3_MIN) {
  295. skb->protocol = proto;
  296. return;
  297. }
  298. rawp = (unsigned short *)(vhdr + 1);
  299. if (*rawp == 0xFFFF)
  300. /*
  301. * This is a magic hack to spot IPX packets. Older Novell
  302. * breaks the protocol design and runs IPX over 802.3 without
  303. * an 802.2 LLC layer. We look for FFFF which isn't a used
  304. * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
  305. * but does for the rest.
  306. */
  307. skb->protocol = htons(ETH_P_802_3);
  308. else
  309. /*
  310. * Real 802.2 LLC
  311. */
  312. skb->protocol = htons(ETH_P_802_2);
  313. }
  314. #endif /* !(_LINUX_IF_VLAN_H_) */