aboutsummaryrefslogtreecommitdiffstats
path: root/src/vnet/devices/af_packet/af_packet.h
blob: 940acbb137245814897dea6eb17e0ac478f7f0a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 *------------------------------------------------------------------
 * af_packet.h - linux kernel packet interface header file
 *
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *------------------------------------------------------------------
 */

#include <linux/if_packet.h>

#include <vppinfra/lock.h>
#include <vlib/log.h>

typedef struct tpacket_block_desc block_desc_t;
typedef struct tpacket_req3 tpacket_req3_t;
typedef struct tpacket3_hdr tpacket3_hdr_t;

typedef enum
{
  AF_PACKET_IF_MODE_ETHERNET = 1,
  AF_PACKET_IF_MODE_IP = 2
} af_packet_if_mode_t;

typedef enum
{
  AF_PACKET_IF_FLAGS_QDISC_BYPASS = 1,
  AF_PACKET_IF_FLAGS_CKSUM_GSO = 2,
  AF_PACKET_IF_FLAGS_FANOUT = 4,
} af_packet_if_flags_t;

typedef struct
{
  u32 sw_if_index;
  u8 host_if_name[64];
} af_packet_if_detail_t;

typedef struct
{
  u8 *ring_start_addr;
  u32 ring_size;
} af_packet_ring_t;

typedef struct
{
  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  clib_spinlock_t lockp;
  int fd;
  union
  {
    tpacket_req3_t *rx_req;
    tpacket_req3_t *tx_req;
  };

  union
  {
    u8 **rx_ring;
    u8 **tx_ring;
  };

  union
  {
    u32 next_rx_block;
    u32 next_tx_frame;
  };

  u16 queue_id;
  u32 queue_index;

  u32 clib_file_index;

  u32 rx_frame_offset;
  u16 num_rx_pkts;
  u8 is_rx_pending;
  u8 is_tx_pending;
  vnet_hw_if_rx_mode mode;
} af_packet_queue_t;

typedef struct
{
  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  u32 hw_if_index;
  u32 sw_if_index;
  u32 per_interface_next_index;
  af_packet_if_mode_t mode;
  u8 is_admin_up;
  u8 is_cksum_gso_enabled;

  af_packet_queue_t *rx_queues;
  af_packet_queue_t *tx_queues;

  u8 num_rxqs;
  u8 num_txqs;

  u8 *host_if_name;
  int host_if_index;

  u32 host_mtu;
  u32 dev_instance;

  af_packet_ring_t *rings;
  u8 is_qdisc_bypass_enabled;
  u8 is_fanout_enabled;
} af_packet_if_t;

typedef struct
{
  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  af_packet_if_t *interfaces;

  u32 polling_count;
  /* rx buffer cache */
  u32 **rx_buffers;

  /* hash of host interface names */
  mhash_t if_index_by_host_if_name;

  /** log class */
  vlib_log_class_t log_class;
} af_packet_main_t;

typedef struct
{
  u8 *host_if_name;
  u8 *hw_addr;
  u32 rx_frame_size;
  u32 tx_frame_size;
  u32 rx_frames_per_block;
  u32 tx_frames_per_block;
  u8 num_rxqs;
  u8 num_txqs;
  af_packet_if_mode_t mode;
  af_packet_if_flags_t flags;

  /* return */
  u32 sw_if_index;
} af_packet_create_if_arg_t;

extern af_packet_main_t af_packet_main;
extern vnet_device_class_t af_packet_device_class;
extern vlib_node_registration_t af_packet_input_node;

int af_packet_create_if (af_packet_create_if_arg_t *arg);
int af_packet_delete_if (u8 *host_if_name);
int af_packet_set_l4_cksum_offload (u32 sw_if_index, u8 set);
int af_packet_dump_ifs (af_packet_if_detail_t ** out_af_packet_ifs);

format_function_t format_af_packet_device_name;

#define MIN(x,y) (((x)<(y))?(x):(y))

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */