src/vnet/devices/af_packet/af_packet.h

   1 /*
   2  *------------------------------------------------------------------
   3  * af_packet.h - linux kernel packet interface header file
   4  *
   5  * Copyright (c) 2016 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #include <linux/if_packet.h>
  21
  22 #include <vppinfra/lock.h>
  23 #include <vlib/log.h>
  24
  25 typedef struct tpacket_block_desc block_desc_t;
  26 typedef struct tpacket_req3 tpacket_req3_t;
  27 typedef struct tpacket3_hdr tpacket3_hdr_t;
  28
  29 typedef enum
  30 {
  31   AF_PACKET_IF_MODE_ETHERNET = 1,
  32   AF_PACKET_IF_MODE_IP = 2
  33 } af_packet_if_mode_t;
  34
  35 typedef enum
  36 {
  37   AF_PACKET_IF_FLAGS_QDISC_BYPASS = 1,
  38 } af_packet_if_flags_t;
  39
  40 typedef struct
  41 {
  42   u32 sw_if_index;
  43   u8 host_if_name[64];
  44 } af_packet_if_detail_t;
  45
  46 typedef struct
  47 {
  48   u8 *ring_start_addr;
  49   u32 ring_size;
  50 } af_packet_ring_t;
  51
  52 typedef struct
  53 {
  54   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  55   clib_spinlock_t lockp;
  56   int fd;
  57   union
  58   {
  59     tpacket_req3_t *rx_req;
  60     tpacket_req3_t *tx_req;
  61   };
  62
  63   union
  64   {
  65     u8 **rx_ring;
  66     u8 **tx_ring;
  67   };
  68
  69   union
  70   {
  71     u32 next_rx_block;
  72     u32 next_tx_frame;
  73   };
  74
  75   u16 queue_id;
  76   u32 queue_index;
  77
  78   u32 clib_file_index;
  79
  80   u32 rx_frame_offset;
  81   u16 num_rx_pkts;
  82   u8 is_rx_pending;
  83   vnet_hw_if_rx_mode mode;
  84 } af_packet_queue_t;
  85
  86 typedef struct
  87 {
  88   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  89   u32 hw_if_index;
  90   u32 sw_if_index;
  91   u32 per_interface_next_index;
  92   af_packet_if_mode_t mode;
  93   u8 is_admin_up;
  94   u8 is_cksum_gso_enabled;
  95
  96   af_packet_queue_t *rx_queues;
  97   af_packet_queue_t *tx_queues;
  98
  99   u8 num_rxqs;
 100   u8 num_txqs;
 101
 102   u8 *host_if_name;
 103   int host_if_index;
 104
 105   u32 host_mtu;
 106   u32 dev_instance;
 107
 108   af_packet_ring_t *rings;
 109   u8 is_qdisc_bypass_enabled;
 110 } af_packet_if_t;
 111
 112 typedef struct
 113 {
 114   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 115   af_packet_if_t *interfaces;
 116
 117   /* rx buffer cache */
 118   u32 **rx_buffers;
 119
 120   /* hash of host interface names */
 121   mhash_t if_index_by_host_if_name;
 122
 123   /** log class */
 124   vlib_log_class_t log_class;
 125 } af_packet_main_t;
 126
 127 typedef struct
 128 {
 129   u8 *host_if_name;
 130   u8 *hw_addr;
 131   u32 rx_frame_size;
 132   u32 tx_frame_size;
 133   u32 rx_frames_per_block;
 134   u32 tx_frames_per_block;
 135   u8 num_rxqs;
 136   u8 num_txqs;
 137   af_packet_if_mode_t mode;
 138   af_packet_if_flags_t flags;
 139
 140   /* return */
 141   u32 sw_if_index;
 142 } af_packet_create_if_arg_t;
 143
 144 extern af_packet_main_t af_packet_main;
 145 extern vnet_device_class_t af_packet_device_class;
 146 extern vlib_node_registration_t af_packet_input_node;
 147
 148 int af_packet_create_if (af_packet_create_if_arg_t *arg);
 149 int af_packet_delete_if (u8 *host_if_name);
 150 int af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set);
 151 int af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs);
 152
 153 format_function_t format_af_packet_device_name;
 154
 155 #define MIN(x,y) (((x)<(y))?(x):(y))
 156
 157 /*
 158  * fd.io coding-style-patch-verification: ON
 159  *
 160  * Local Variables:
 161  * eval: (c-set-style "gnu")
 162  * End:
 163  */