if_packet.h 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. #ifndef __LINUX_IF_PACKET_H
  3. #define __LINUX_IF_PACKET_H
  4. #include <asm/byteorder.h>
  5. #include <linux/types.h>
  6. struct sockaddr_pkt {
  7. unsigned short spkt_family;
  8. unsigned char spkt_device[14];
  9. __be16 spkt_protocol;
  10. };
  11. struct sockaddr_ll {
  12. unsigned short sll_family;
  13. __be16 sll_protocol;
  14. int sll_ifindex;
  15. unsigned short sll_hatype;
  16. unsigned char sll_pkttype;
  17. unsigned char sll_halen;
  18. unsigned char sll_addr[8];
  19. };
  20. /* Packet types */
  21. #define PACKET_HOST 0 /* To us */
  22. #define PACKET_BROADCAST 1 /* To all */
  23. #define PACKET_MULTICAST 2 /* To group */
  24. #define PACKET_OTHERHOST 3 /* To someone else */
  25. #define PACKET_OUTGOING 4 /* Outgoing of any type */
  26. #define PACKET_LOOPBACK 5 /* MC/BRD frame looped back */
  27. #define PACKET_USER 6 /* To user space */
  28. #define PACKET_KERNEL 7 /* To kernel space */
  29. /* Unused, PACKET_FASTROUTE and PACKET_LOOPBACK are invisible to user space */
  30. #define PACKET_FASTROUTE 6 /* Fastrouted frame */
  31. /* Packet socket options */
  32. #define PACKET_ADD_MEMBERSHIP 1
  33. #define PACKET_DROP_MEMBERSHIP 2
  34. #define PACKET_RECV_OUTPUT 3
  35. /* Value 4 is still used by obsolete turbo-packet. */
  36. #define PACKET_RX_RING 5
  37. #define PACKET_STATISTICS 6
  38. #define PACKET_COPY_THRESH 7
  39. #define PACKET_AUXDATA 8
  40. #define PACKET_ORIGDEV 9
  41. #define PACKET_VERSION 10
  42. #define PACKET_HDRLEN 11
  43. #define PACKET_RESERVE 12
  44. #define PACKET_TX_RING 13
  45. #define PACKET_LOSS 14
  46. #define PACKET_VNET_HDR 15
  47. #define PACKET_TX_TIMESTAMP 16
  48. #define PACKET_TIMESTAMP 17
  49. #define PACKET_FANOUT 18
  50. #define PACKET_TX_HAS_OFF 19
  51. #define PACKET_QDISC_BYPASS 20
  52. #define PACKET_ROLLOVER_STATS 21
  53. #define PACKET_FANOUT_DATA 22
  54. #define PACKET_IGNORE_OUTGOING 23
  55. #define PACKET_VNET_HDR_SZ 24
  56. #define PACKET_FANOUT_HASH 0
  57. #define PACKET_FANOUT_LB 1
  58. #define PACKET_FANOUT_CPU 2
  59. #define PACKET_FANOUT_ROLLOVER 3
  60. #define PACKET_FANOUT_RND 4
  61. #define PACKET_FANOUT_QM 5
  62. #define PACKET_FANOUT_CBPF 6
  63. #define PACKET_FANOUT_EBPF 7
  64. #define PACKET_FANOUT_FLAG_ROLLOVER 0x1000
  65. #define PACKET_FANOUT_FLAG_UNIQUEID 0x2000
  66. #define PACKET_FANOUT_FLAG_IGNORE_OUTGOING 0x4000
  67. #define PACKET_FANOUT_FLAG_DEFRAG 0x8000
  68. struct tpacket_stats {
  69. unsigned int tp_packets;
  70. unsigned int tp_drops;
  71. };
  72. struct tpacket_stats_v3 {
  73. unsigned int tp_packets;
  74. unsigned int tp_drops;
  75. unsigned int tp_freeze_q_cnt;
  76. };
  77. struct tpacket_rollover_stats {
  78. __aligned_u64 tp_all;
  79. __aligned_u64 tp_huge;
  80. __aligned_u64 tp_failed;
  81. };
  82. union tpacket_stats_u {
  83. struct tpacket_stats stats1;
  84. struct tpacket_stats_v3 stats3;
  85. };
  86. struct tpacket_auxdata {
  87. __u32 tp_status;
  88. __u32 tp_len;
  89. __u32 tp_snaplen;
  90. __u16 tp_mac;
  91. __u16 tp_net;
  92. __u16 tp_vlan_tci;
  93. __u16 tp_vlan_tpid;
  94. };
  95. /* Rx ring - header status */
  96. #define TP_STATUS_KERNEL 0
  97. #define TP_STATUS_USER (1 << 0)
  98. #define TP_STATUS_COPY (1 << 1)
  99. #define TP_STATUS_LOSING (1 << 2)
  100. #define TP_STATUS_CSUMNOTREADY (1 << 3)
  101. #define TP_STATUS_VLAN_VALID (1 << 4) /* auxdata has valid tp_vlan_tci */
  102. #define TP_STATUS_BLK_TMO (1 << 5)
  103. #define TP_STATUS_VLAN_TPID_VALID (1 << 6) /* auxdata has valid tp_vlan_tpid */
  104. #define TP_STATUS_CSUM_VALID (1 << 7)
  105. #define TP_STATUS_GSO_TCP (1 << 8)
  106. /* Tx ring - header status */
  107. #define TP_STATUS_AVAILABLE 0
  108. #define TP_STATUS_SEND_REQUEST (1 << 0)
  109. #define TP_STATUS_SENDING (1 << 1)
  110. #define TP_STATUS_WRONG_FORMAT (1 << 2)
  111. /* Rx and Tx ring - header status */
  112. #define TP_STATUS_TS_SOFTWARE (1 << 29)
  113. #define TP_STATUS_TS_SYS_HARDWARE (1 << 30) /* deprecated, never set */
  114. #define TP_STATUS_TS_RAW_HARDWARE (1U << 31)
  115. /* Rx ring - feature request bits */
  116. #define TP_FT_REQ_FILL_RXHASH 0x1
  117. struct tpacket_hdr {
  118. unsigned long tp_status;
  119. unsigned int tp_len;
  120. unsigned int tp_snaplen;
  121. unsigned short tp_mac;
  122. unsigned short tp_net;
  123. unsigned int tp_sec;
  124. unsigned int tp_usec;
  125. };
  126. #define TPACKET_ALIGNMENT 16
  127. #define TPACKET_ALIGN(x) (((x)+TPACKET_ALIGNMENT-1)&~(TPACKET_ALIGNMENT-1))
  128. #define TPACKET_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket_hdr)) + sizeof(struct sockaddr_ll))
  129. struct tpacket2_hdr {
  130. __u32 tp_status;
  131. __u32 tp_len;
  132. __u32 tp_snaplen;
  133. __u16 tp_mac;
  134. __u16 tp_net;
  135. __u32 tp_sec;
  136. __u32 tp_nsec;
  137. __u16 tp_vlan_tci;
  138. __u16 tp_vlan_tpid;
  139. __u8 tp_padding[4];
  140. };
  141. struct tpacket_hdr_variant1 {
  142. __u32 tp_rxhash;
  143. __u32 tp_vlan_tci;
  144. __u16 tp_vlan_tpid;
  145. __u16 tp_padding;
  146. };
  147. struct tpacket3_hdr {
  148. __u32 tp_next_offset;
  149. __u32 tp_sec;
  150. __u32 tp_nsec;
  151. __u32 tp_snaplen;
  152. __u32 tp_len;
  153. __u32 tp_status;
  154. __u16 tp_mac;
  155. __u16 tp_net;
  156. /* pkt_hdr variants */
  157. union {
  158. struct tpacket_hdr_variant1 hv1;
  159. };
  160. __u8 tp_padding[8];
  161. };
  162. struct tpacket_bd_ts {
  163. unsigned int ts_sec;
  164. union {
  165. unsigned int ts_usec;
  166. unsigned int ts_nsec;
  167. };
  168. };
  169. struct tpacket_hdr_v1 {
  170. __u32 block_status;
  171. __u32 num_pkts;
  172. __u32 offset_to_first_pkt;
  173. /* Number of valid bytes (including padding)
  174. * blk_len <= tp_block_size
  175. */
  176. __u32 blk_len;
  177. /*
  178. * Quite a few uses of sequence number:
  179. * 1. Make sure cache flush etc worked.
  180. * Well, one can argue - why not use the increasing ts below?
  181. * But look at 2. below first.
  182. * 2. When you pass around blocks to other user space decoders,
  183. * you can see which blk[s] is[are] outstanding etc.
  184. * 3. Validate kernel code.
  185. */
  186. __aligned_u64 seq_num;
  187. /*
  188. * ts_last_pkt:
  189. *
  190. * Case 1. Block has 'N'(N >=1) packets and TMO'd(timed out)
  191. * ts_last_pkt == 'time-stamp of last packet' and NOT the
  192. * time when the timer fired and the block was closed.
  193. * By providing the ts of the last packet we can absolutely
  194. * guarantee that time-stamp wise, the first packet in the
  195. * next block will never precede the last packet of the
  196. * previous block.
  197. * Case 2. Block has zero packets and TMO'd
  198. * ts_last_pkt = time when the timer fired and the block
  199. * was closed.
  200. * Case 3. Block has 'N' packets and NO TMO.
  201. * ts_last_pkt = time-stamp of the last pkt in the block.
  202. *
  203. * ts_first_pkt:
  204. * Is always the time-stamp when the block was opened.
  205. * Case a) ZERO packets
  206. * No packets to deal with but atleast you know the
  207. * time-interval of this block.
  208. * Case b) Non-zero packets
  209. * Use the ts of the first packet in the block.
  210. *
  211. */
  212. struct tpacket_bd_ts ts_first_pkt, ts_last_pkt;
  213. };
  214. union tpacket_bd_header_u {
  215. struct tpacket_hdr_v1 bh1;
  216. };
  217. struct tpacket_block_desc {
  218. __u32 version;
  219. __u32 offset_to_priv;
  220. union tpacket_bd_header_u hdr;
  221. };
  222. #define TPACKET2_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket2_hdr)) + sizeof(struct sockaddr_ll))
  223. #define TPACKET3_HDRLEN (TPACKET_ALIGN(sizeof(struct tpacket3_hdr)) + sizeof(struct sockaddr_ll))
  224. enum tpacket_versions {
  225. TPACKET_V1,
  226. TPACKET_V2,
  227. TPACKET_V3
  228. };
  229. /*
  230. Frame structure:
  231. - Start. Frame must be aligned to TPACKET_ALIGNMENT=16
  232. - struct tpacket_hdr
  233. - pad to TPACKET_ALIGNMENT=16
  234. - struct sockaddr_ll
  235. - Gap, chosen so that packet data (Start+tp_net) alignes to TPACKET_ALIGNMENT=16
  236. - Start+tp_mac: [ Optional MAC header ]
  237. - Start+tp_net: Packet data, aligned to TPACKET_ALIGNMENT=16.
  238. - Pad to align to TPACKET_ALIGNMENT=16
  239. */
  240. struct tpacket_req {
  241. unsigned int tp_block_size; /* Minimal size of contiguous block */
  242. unsigned int tp_block_nr; /* Number of blocks */
  243. unsigned int tp_frame_size; /* Size of frame */
  244. unsigned int tp_frame_nr; /* Total number of frames */
  245. };
  246. struct tpacket_req3 {
  247. unsigned int tp_block_size; /* Minimal size of contiguous block */
  248. unsigned int tp_block_nr; /* Number of blocks */
  249. unsigned int tp_frame_size; /* Size of frame */
  250. unsigned int tp_frame_nr; /* Total number of frames */
  251. unsigned int tp_retire_blk_tov; /* timeout in msecs */
  252. unsigned int tp_sizeof_priv; /* offset to private data area */
  253. unsigned int tp_feature_req_word;
  254. };
  255. union tpacket_req_u {
  256. struct tpacket_req req;
  257. struct tpacket_req3 req3;
  258. };
  259. struct packet_mreq {
  260. int mr_ifindex;
  261. unsigned short mr_type;
  262. unsigned short mr_alen;
  263. unsigned char mr_address[8];
  264. };
  265. struct fanout_args {
  266. #if defined(__LITTLE_ENDIAN_BITFIELD)
  267. __u16 id;
  268. __u16 type_flags;
  269. #else
  270. __u16 type_flags;
  271. __u16 id;
  272. #endif
  273. __u32 max_num_members;
  274. };
  275. #define PACKET_MR_MULTICAST 0
  276. #define PACKET_MR_PROMISC 1
  277. #define PACKET_MR_ALLMULTI 2
  278. #define PACKET_MR_UNICAST 3
  279. #endif