include/uapi/linux/if_packet.h

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