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_CKSUM_GSO = 2,
  39   AF_PACKET_IF_FLAGS_FANOUT = 4,
  40 } af_packet_if_flags_t;
  41
  42 typedef struct
  43 {
  44   u32 sw_if_index;
  45   u8 host_if_name[64];
  46 } af_packet_if_detail_t;
  47
  48 typedef struct
  49 {
  50   u8 *ring_start_addr;
  51   u32 ring_size;
  52 } af_packet_ring_t;
  53
  54 typedef struct
  55 {
  56   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  57   clib_spinlock_t lockp;
  58   int fd;
  59   union
  60   {
  61     tpacket_req3_t *rx_req;
  62     tpacket_req3_t *tx_req;
  63   };
  64
  65   union
  66   {
  67     u8 **rx_ring;
  68     u8 **tx_ring;
  69   };
  70
  71   union
  72   {
  73     u32 next_rx_block;
  74     u32 next_tx_frame;
  75   };
  76
  77   u16 queue_id;
  78   u32 queue_index;
  79
  80   u32 clib_file_index;
  81
  82   u32 rx_frame_offset;
  83   u16 num_rx_pkts;
  84   u8 is_rx_pending;
  85   u8 is_tx_pending;
  86   vnet_hw_if_rx_mode mode;
  87 } af_packet_queue_t;
  88
  89 typedef struct
  90 {
  91   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  92   u32 hw_if_index;
  93   u32 sw_if_index;
  94   u32 per_interface_next_index;
  95   af_packet_if_mode_t mode;
  96   u8 is_admin_up;
  97   u8 is_cksum_gso_enabled;
  98
  99   af_packet_queue_t *rx_queues;
 100   af_packet_queue_t *tx_queues;
 101
 102   u8 num_rxqs;
 103   u8 num_txqs;
 104
 105   u8 *host_if_name;
 106   int host_if_index;
 107
 108   u32 host_mtu;
 109   u32 dev_instance;
 110
 111   af_packet_ring_t *rings;
 112   u8 is_qdisc_bypass_enabled;
 113   u8 is_fanout_enabled;
 114 } af_packet_if_t;
 115
 116 typedef struct
 117 {
 118   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 119   af_packet_if_t *interfaces;
 120
 121   /* rx buffer cache */
 122   u32 **rx_buffers;
 123
 124   /* hash of host interface names */
 125   mhash_t if_index_by_host_if_name;
 126
 127   /** log class */
 128   vlib_log_class_t log_class;
 129 } af_packet_main_t;
 130
 131 typedef struct
 132 {
 133   u8 *host_if_name;
 134   u8 *hw_addr;
 135   u32 rx_frame_size;
 136   u32 tx_frame_size;
 137   u32 rx_frames_per_block;
 138   u32 tx_frames_per_block;
 139   u8 num_rxqs;
 140   u8 num_txqs;
 141   af_packet_if_mode_t mode;
 142   af_packet_if_flags_t flags;
 143
 144   /* return */
 145   u32 sw_if_index;
 146 } af_packet_create_if_arg_t;
 147
 148 extern af_packet_main_t af_packet_main;
 149 extern vnet_device_class_t af_packet_device_class;
 150 extern vlib_node_registration_t af_packet_input_node;
 151
 152 int af_packet_create_if (af_packet_create_if_arg_t *arg);
 153 int af_packet_delete_if (u8 *host_if_name);
 154 int af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set);
 155 int af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs);
 156
 157 format_function_t format_af_packet_device_name;
 158
 159 #define MIN(x,y) (((x)<(y))?(x):(y))
 160
 161 /*
 162  * fd.io coding-style-patch-verification: ON
 163  *
 164  * Local Variables:
 165  * eval: (c-set-style "gnu")
 166  * End:
 167  */