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 <vppinfra/lock.h>
  21 #include <vlib/log.h>
  22
  23 typedef enum
  24 {
  25   AF_PACKET_IF_MODE_ETHERNET = 1,
  26   AF_PACKET_IF_MODE_IP = 2
  27 } af_packet_if_mode_t;
  28
  29 typedef struct
  30 {
  31   u32 sw_if_index;
  32   u8 host_if_name[64];
  33 } af_packet_if_detail_t;
  34
  35 typedef struct
  36 {
  37   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  38   clib_spinlock_t lockp;
  39   u8 *host_if_name;
  40   int host_if_index;
  41   int fd;
  42   struct tpacket_req *rx_req;
  43   struct tpacket_req *tx_req;
  44   u8 *rx_ring;
  45   u8 *tx_ring;
  46   u32 hw_if_index;
  47   u32 sw_if_index;
  48   u32 clib_file_index;
  49
  50   u32 next_rx_frame;
  51   u32 next_tx_frame;
  52
  53   u32 per_interface_next_index;
  54   u8 is_admin_up;
  55   u32 queue_index;
  56   u32 host_mtu;
  57   af_packet_if_mode_t mode;
  58 } af_packet_if_t;
  59
  60 typedef struct
  61 {
  62   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  63   af_packet_if_t *interfaces;
  64
  65   /* bitmap of pending rx interfaces */
  66   uword *pending_input_bitmap;
  67
  68   /* rx buffer cache */
  69   u32 **rx_buffers;
  70
  71   /* hash of host interface names */
  72   mhash_t if_index_by_host_if_name;
  73
  74   /** log class */
  75   vlib_log_class_t log_class;
  76 } af_packet_main_t;
  77
  78 typedef struct
  79 {
  80   u8 *host_if_name;
  81   u8 *hw_addr;
  82   u32 rx_frame_size;
  83   u32 tx_frame_size;
  84   u32 rx_frames_per_block;
  85   u32 tx_frames_per_block;
  86   af_packet_if_mode_t mode;
  87
  88   /* return */
  89   u32 sw_if_index;
  90 } af_packet_create_if_arg_t;
  91
  92 extern af_packet_main_t af_packet_main;
  93 extern vnet_device_class_t af_packet_device_class;
  94 extern vlib_node_registration_t af_packet_input_node;
  95
  96 int af_packet_create_if (af_packet_create_if_arg_t *arg);
  97 int af_packet_delete_if (u8 *host_if_name);
  98 int af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set);
  99 int af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs);
 100
 101 format_function_t format_af_packet_device_name;
 102
 103 #define MIN(x,y) (((x)<(y))?(x):(y))
 104
 105 /*
 106  * fd.io coding-style-patch-verification: ON
 107  *
 108  * Local Variables:
 109  * eval: (c-set-style "gnu")
 110  * End:
 111  */