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   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  44   clib_spinlock_t lockp;
  45   u8 *host_if_name;
  46   int host_if_index;
  47   int fd;
  48   tpacket_req3_t *rx_req;
  49   tpacket_req3_t *tx_req;
  50   u8 **rx_ring;
  51   u8 **tx_ring;
  52   u32 hdrlen;
  53   u32 hw_if_index;
  54   u32 sw_if_index;
  55   u32 clib_file_index;
  56
  57   u32 next_rx_block;
  58   u32 next_tx_frame;
  59
  60   u32 per_interface_next_index;
  61   u8 is_admin_up;
  62   u32 queue_index;
  63   u32 host_mtu;
  64   af_packet_if_mode_t mode;
  65 } af_packet_if_t;
  66
  67 typedef struct
  68 {
  69   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  70   af_packet_if_t *interfaces;
  71
  72   /* rx buffer cache */
  73   u32 **rx_buffers;
  74
  75   /* hash of host interface names */
  76   mhash_t if_index_by_host_if_name;
  77
  78   /** log class */
  79   vlib_log_class_t log_class;
  80 } af_packet_main_t;
  81
  82 typedef struct
  83 {
  84   u8 *host_if_name;
  85   u8 *hw_addr;
  86   u32 rx_frame_size;
  87   u32 tx_frame_size;
  88   u32 rx_frames_per_block;
  89   u32 tx_frames_per_block;
  90   af_packet_if_mode_t mode;
  91
  92   /* return */
  93   u32 sw_if_index;
  94 } af_packet_create_if_arg_t;
  95
  96 extern af_packet_main_t af_packet_main;
  97 extern vnet_device_class_t af_packet_device_class;
  98 extern vlib_node_registration_t af_packet_input_node;
  99
 100 int af_packet_create_if (af_packet_create_if_arg_t *arg);
 101 int af_packet_delete_if (u8 *host_if_name);
 102 int af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set);
 103 int af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs);
 104
 105 format_function_t format_af_packet_device_name;
 106
 107 #define MIN(x,y) (((x)<(y))?(x):(y))
 108
 109 /*
 110  * fd.io coding-style-patch-verification: ON
 111  *
 112  * Local Variables:
 113  * eval: (c-set-style "gnu")
 114  * End:
 115  */