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