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