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