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_IGNORE_OUTGOING     0x4000
  74 #define PACKET_FANOUT_FLAG_DEFRAG       0x8000
  75
  76 struct tpacket_stats {
  77         unsigned int    tp_packets;
  78         unsigned int    tp_drops;
  79 };
  80
  81 struct tpacket_stats_v3 {
  82         unsigned int    tp_packets;
  83         unsigned int    tp_drops;
  84         unsigned int    tp_freeze_q_cnt;
  85 };
  86
  87 struct tpacket_rollover_stats {
  88         __aligned_u64   tp_all;
  89         __aligned_u64   tp_huge;
  90         __aligned_u64   tp_failed;
  91 };
  92
  93 union tpacket_stats_u {
  94         struct tpacket_stats stats1;
  95         struct tpacket_stats_v3 stats3;
  96 };
  97
  98 struct tpacket_auxdata {
  99         __u32           tp_status;
 100         __u32           tp_len;
 101         __u32           tp_snaplen;
 102         __u16           tp_mac;
 103         __u16           tp_net;
 104         __u16           tp_vlan_tci;
 105         __u16           tp_vlan_tpid;
 106 };
 107
 108 /* Rx ring - header status */
 109 #define TP_STATUS_KERNEL                      0
 110 #define TP_STATUS_USER                  (1 << 0)
 111 #define TP_STATUS_COPY                  (1 << 1)
 112 #define TP_STATUS_LOSING                (1 << 2)
 113 #define TP_STATUS_CSUMNOTREADY          (1 << 3)
 114 #define TP_STATUS_VLAN_VALID            (1 << 4) /* auxdata has valid tp_vlan_tci */
 115 #define TP_STATUS_BLK_TMO               (1 << 5)
 116 #define TP_STATUS_VLAN_TPID_VALID       (1 << 6) /* auxdata has valid tp_vlan_tpid */
 117 #define TP_STATUS_CSUM_VALID            (1 << 7)
 118
 119 /* Tx ring - header status */
 120 #define TP_STATUS_AVAILABLE           0
 121 #define TP_STATUS_SEND_REQUEST  (1 << 0)
 122 #define TP_STATUS_SENDING       (1 << 1)
 123 #define TP_STATUS_WRONG_FORMAT  (1 << 2)
 124
 125 /* Rx and Tx ring - header status */
 126 #define TP_STATUS_TS_SOFTWARE           (1 << 29)
 127 #define TP_STATUS_TS_SYS_HARDWARE       (1 << 30) /* deprecated, never set */
 128 #define TP_STATUS_TS_RAW_HARDWARE       (1U << 31)
 129
 130 /* Rx ring - feature request bits */
 131 #define TP_FT_REQ_FILL_RXHASH   0x1
 132
 133 struct tpacket_hdr {
 134         unsigned long   tp_status;
 135         unsigned int    tp_len;
 136         unsigned int    tp_snaplen;
 137         unsigned short  tp_mac;
 138         unsigned short  tp_net;
 139         unsigned int    tp_sec;
 140         unsigned int    tp_usec;
 141 };
 142
 143 #define TPACKET_ALIGNMENT       16
 144 #define TPACKET_ALIGN(x)        (((x)+TPACKET_ALIGNMENT-1)&~(TPACKET_ALIGNMENT-1))
 145 #define TPACKET_HDRLEN          (TPACKET_ALIGN(sizeof(struct tpacket_hdr)) + sizeof(struct sockaddr_ll))
 146
 147 struct tpacket2_hdr {
 148         __u32           tp_status;
 149         __u32           tp_len;
 150         __u32           tp_snaplen;
 151         __u16           tp_mac;
 152         __u16           tp_net;
 153         __u32           tp_sec;
 154         __u32           tp_nsec;
 155         __u16           tp_vlan_tci;
 156         __u16           tp_vlan_tpid;
 157         __u8            tp_padding[4];
 158 };
 159
 160 struct tpacket_hdr_variant1 {
 161         __u32   tp_rxhash;
 162         __u32   tp_vlan_tci;
 163         __u16   tp_vlan_tpid;
 164         __u16   tp_padding;
 165 };
 166
 167 struct tpacket3_hdr {
 168         __u32           tp_next_offset;
 169         __u32           tp_sec;
 170         __u32           tp_nsec;
 171         __u32           tp_snaplen;
 172         __u32           tp_len;
 173         __u32           tp_status;
 174         __u16           tp_mac;
 175         __u16           tp_net;
 176         /* pkt_hdr variants */
 177         union {
 178                 struct tpacket_hdr_variant1 hv1;
 179         };
 180         __u8            tp_padding[8];
 181 };
 182
 183 struct tpacket_bd_ts {
 184         unsigned int ts_sec;
 185         union {
 186                 unsigned int ts_usec;
 187                 unsigned int ts_nsec;
 188         };
 189 };
 190
 191 struct tpacket_hdr_v1 {
 192         __u32   block_status;
 193         __u32   num_pkts;
 194         __u32   offset_to_first_pkt;
 195
 196         /* Number of valid bytes (including padding)
 197          * blk_len <= tp_block_size
 198          */
 199         __u32   blk_len;
 200
 201         /*
 202          * Quite a few uses of sequence number:
 203          * 1. Make sure cache flush etc worked.
 204          *    Well, one can argue - why not use the increasing ts below?
 205          *    But look at 2. below first.
 206          * 2. When you pass around blocks to other user space decoders,
 207          *    you can see which blk[s] is[are] outstanding etc.
 208          * 3. Validate kernel code.
 209          */
 210         __aligned_u64   seq_num;
 211
 212         /*
 213          * ts_last_pkt:
 214          *
 215          * Case 1.      Block has 'N'(N >=1) packets and TMO'd(timed out)
 216          *              ts_last_pkt == 'time-stamp of last packet' and NOT the
 217          *              time when the timer fired and the block was closed.
 218          *              By providing the ts of the last packet we can absolutely
 219          *              guarantee that time-stamp wise, the first packet in the
 220          *              next block will never precede the last packet of the
 221          *              previous block.
 222          * Case 2.      Block has zero packets and TMO'd
 223          *              ts_last_pkt = time when the timer fired and the block
 224          *              was closed.
 225          * Case 3.      Block has 'N' packets and NO TMO.
 226          *              ts_last_pkt = time-stamp of the last pkt in the block.
 227          *
 228          * ts_first_pkt:
 229          *              Is always the time-stamp when the block was opened.
 230          *              Case a) ZERO packets
 231          *                      No packets to deal with but atleast you know the
 232          *                      time-interval of this block.
 233          *              Case b) Non-zero packets
 234          *                      Use the ts of the first packet in the block.
 235          *
 236          */
 237         struct tpacket_bd_ts    ts_first_pkt, ts_last_pkt;
 238 };
 239
 240 union tpacket_bd_header_u {
 241         struct tpacket_hdr_v1 bh1;
 242 };
 243
 244 struct tpacket_block_desc {
 245         __u32 version;
 246         __u32 offset_to_priv;
 247         union tpacket_bd_header_u hdr;
 248 };
 249
 250 #define TPACKET2_HDRLEN         (TPACKET_ALIGN(sizeof(struct tpacket2_hdr)) + sizeof(struct sockaddr_ll))
 251 #define TPACKET3_HDRLEN         (TPACKET_ALIGN(sizeof(struct tpacket3_hdr)) + sizeof(struct sockaddr_ll))
 252
 253 enum tpacket_versions {
 254         TPACKET_V1,
 255         TPACKET_V2,
 256         TPACKET_V3
 257 };
 258
 259 /*
 260    Frame structure:
 261
 262    - Start. Frame must be aligned to TPACKET_ALIGNMENT=16
 263    - struct tpacket_hdr
 264    - pad to TPACKET_ALIGNMENT=16
 265    - struct sockaddr_ll
 266    - Gap, chosen so that packet data (Start+tp_net) alignes to TPACKET_ALIGNMENT=16
 267    - Start+tp_mac: [ Optional MAC header ]
 268    - Start+tp_net: Packet data, aligned to TPACKET_ALIGNMENT=16.
 269    - Pad to align to TPACKET_ALIGNMENT=16
 270  */
 271
 272 struct tpacket_req {
 273         unsigned int    tp_block_size;  /* Minimal size of contiguous block */
 274         unsigned int    tp_block_nr;    /* Number of blocks */
 275         unsigned int    tp_frame_size;  /* Size of frame */
 276         unsigned int    tp_frame_nr;    /* Total number of frames */
 277 };
 278
 279 struct tpacket_req3 {
 280         unsigned int    tp_block_size;  /* Minimal size of contiguous block */
 281         unsigned int    tp_block_nr;    /* Number of blocks */
 282         unsigned int    tp_frame_size;  /* Size of frame */
 283         unsigned int    tp_frame_nr;    /* Total number of frames */
 284         unsigned int    tp_retire_blk_tov; /* timeout in msecs */
 285         unsigned int    tp_sizeof_priv; /* offset to private data area */
 286         unsigned int    tp_feature_req_word;
 287 };
 288
 289 union tpacket_req_u {
 290         struct tpacket_req      req;
 291         struct tpacket_req3     req3;
 292 };
 293
 294 struct packet_mreq {
 295         int             mr_ifindex;
 296         unsigned short  mr_type;
 297         unsigned short  mr_alen;
 298         unsigned char   mr_address[8];
 299 };
 300
 301 struct fanout_args {
 302 #if defined(__LITTLE_ENDIAN_BITFIELD)
 303         __u16           id;
 304         __u16           type_flags;
 305 #else
 306         __u16           type_flags;
 307         __u16           id;
 308 #endif
 309         __u32           max_num_members;
 310 };
 311
 312 #define PACKET_MR_MULTICAST     0
 313 #define PACKET_MR_PROMISC       1
 314 #define PACKET_MR_ALLMULTI      2
 315 #define PACKET_MR_UNICAST       3
 316
 317 #endif