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