include/uapi/linux/if_packet.h

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