if_packet.h 7.8 KB

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