Handle dynamic enable/disable VHOST_USER interface
[vpp.git] / vnet / vnet / devices / dpdk / dpdk.h
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __included_dpdk_h__
16 #define __included_dpdk_h__
17
18 /* $$$$ We should rename always_inline -> clib_always_inline */
19 #undef always_inline
20
21 #include <rte_config.h>
22
23 #include <rte_common.h>
24 #include <rte_dev.h>
25 #include <rte_log.h>
26 #include <rte_memory.h>
27 #include <rte_memcpy.h>
28 #include <rte_memzone.h>
29 #include <rte_tailq.h>
30 #include <rte_eal.h>
31 #include <rte_per_lcore.h>
32 #include <rte_launch.h>
33 #include <rte_atomic.h>
34 #include <rte_cycles.h>
35 #include <rte_prefetch.h>
36 #include <rte_lcore.h>
37 #include <rte_per_lcore.h>
38 #include <rte_branch_prediction.h>
39 #include <rte_interrupts.h>
40 #include <rte_pci.h>
41 #include <rte_random.h>
42 #include <rte_debug.h>
43 #include <rte_ether.h>
44 #include <rte_ethdev.h>
45 #include <rte_ring.h>
46 #include <rte_mempool.h>
47 #include <rte_mbuf.h>
48 #ifdef RTE_LIBRTE_KNI
49 #include <rte_kni.h>
50 #endif
51 #include <rte_virtio_net.h>
52 #include <rte_pci_dev_ids.h>
53 #include <rte_version.h>
54
55 #include <vnet/unix/pcap.h>
56 #include <vnet/devices/virtio/vhost-user.h>
57
58 #if CLIB_DEBUG > 0
59 #define always_inline static inline
60 #else
61 #define always_inline static inline __attribute__ ((__always_inline__))
62 #endif
63
64 #define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
65 #define NB_MBUF   (32<<10)
66
67 vnet_device_class_t dpdk_device_class;
68 vlib_node_registration_t dpdk_input_node;
69 vlib_node_registration_t dpdk_io_input_node;
70 vlib_node_registration_t handoff_dispatch_node;
71
72 typedef enum {
73   VNET_DPDK_DEV_ETH = 1,      /* Standard DPDK PMD driver */
74   VNET_DPDK_DEV_KNI,          /* Kernel NIC Interface */
75   VNET_DPDK_DEV_VHOST_USER,
76   VNET_DPDK_DEV_UNKNOWN,      /* must be last */
77 } dpdk_device_type_t;
78
79 #define foreach_dpdk_pmd          \
80   _ ("rte_nicvf_pmd", THUNDERX)   \
81   _ ("rte_em_pmd", E1000EM)       \
82   _ ("rte_igb_pmd", IGB)          \
83   _ ("rte_igbvf_pmd", IGBVF)      \
84   _ ("rte_ixgbe_pmd", IXGBE)      \
85   _ ("rte_ixgbevf_pmd", IXGBEVF)  \
86   _ ("rte_i40e_pmd", I40E)        \
87   _ ("rte_i40evf_pmd", I40EVF)    \
88   _ ("rte_virtio_pmd", VIRTIO)    \
89   _ ("rte_vice_pmd", VICE)        \
90   _ ("rte_enic_pmd", ENIC)        \
91   _ ("rte_vmxnet3_pmd", VMXNET3)  \
92   _ ("AF_PACKET PMD", AF_PACKET)  \
93   _ ("rte_pmd_fm10k", FM10K)      \
94   _ ("rte_cxgbe_pmd", CXGBE)
95
96 typedef enum {
97   VNET_DPDK_PMD_NONE,
98 #define _(s,f) VNET_DPDK_PMD_##f,
99   foreach_dpdk_pmd
100 #undef _
101 #ifdef NETMAP
102   VNET_DPDK_PMD_NETMAP,
103 #endif
104   VNET_DPDK_PMD_UNKNOWN, /* must be last */
105 } dpdk_pmd_t;
106
107 typedef enum {
108   VNET_DPDK_PORT_TYPE_ETH_1G,
109   VNET_DPDK_PORT_TYPE_ETH_10G,
110   VNET_DPDK_PORT_TYPE_ETH_40G,
111   VNET_DPDK_PORT_TYPE_ETH_SWITCH,
112 #ifdef NETMAP
113   VNET_DPDK_PORT_TYPE_NETMAP,
114 #endif
115   VNET_DPDK_PORT_TYPE_AF_PACKET,
116   VNET_DPDK_PORT_TYPE_UNKNOWN,
117 } dpdk_port_type_t;
118
119 typedef struct {
120   f64 deadline;
121   vlib_frame_t * frame;
122 } dpdk_frame_t;
123
124 #define DPDK_EFD_MAX_DISCARD_RATE 10
125
126 typedef struct {
127   u16 last_burst_sz;
128   u16 max_burst_sz;
129   u32 full_frames_cnt;
130   u32 consec_full_frames_cnt;
131   u32 congestion_cnt;
132   u64 last_poll_time;
133   u64 max_poll_delay;
134   u32 discard_cnt;
135   u32 total_packet_cnt;
136 } dpdk_efd_agent_t;
137
138 typedef struct {
139   int callfd;
140   int kickfd;
141   int errfd;
142 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
143   int enabled;
144 #endif
145   u32 callfd_idx;
146   u32 n_since_last_int;
147   f64 int_deadline;
148 } dpdk_vu_vring;
149
150 typedef struct {
151   u32 is_up;
152   u32 unix_fd;
153   u32 unix_file_index;
154   u32 client_fd;
155   char sock_filename[256];
156   int sock_errno;
157   u8 sock_is_server;
158   u8 active;
159
160   u64 feature_mask;
161   u32 num_vrings;
162 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
163   dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
164 #else
165   dpdk_vu_vring vrings[2];
166 #endif
167   u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
168   u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
169 } dpdk_vu_intf_t;
170
171 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t *vm,
172                                              u32 hw_if_index,
173                                              u32 n_packets);
174
175 /*
176  * The header for the tx_vector in dpdk_device_t.
177  * Head and tail are indexes into the tx_vector and are of type
178  * u64 so they never overflow.
179  */
180 typedef struct {
181   u64 tx_head;
182   u64 tx_tail;
183 } tx_ring_hdr_t;
184
185 typedef struct {
186   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
187   volatile u32 **lockp;
188
189   /* Instance ID */
190   u32 device_index;
191
192   u32 vlib_hw_if_index;
193   u32 vlib_sw_if_index;
194
195   /* next node index if we decide to steal the rx graph arc */
196   u32 per_interface_next_index;
197
198   /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
199   struct rte_mbuf *** tx_vectors; /* one per worker thread */
200   struct rte_mbuf *** rx_vectors;
201
202   /* vector of traced contexts, per device */
203   u32 * d_trace_buffers;
204
205   /* per-worker destination frame queue */
206   dpdk_frame_t * frames;
207
208   dpdk_device_type_t dev_type:8;
209   dpdk_pmd_t pmd:8;
210   i8 cpu_socket;
211
212   u8 admin_up;
213   u8 promisc;
214
215   CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
216
217   /* PMD related */
218   u16 tx_q_used;
219   u16 rx_q_used;
220   u16 nb_rx_desc;
221   u16 nb_tx_desc;
222   u16 * cpu_socket_id_by_queue;
223   struct rte_eth_conf port_conf;
224   struct rte_eth_txconf tx_conf;
225
226   /* KNI related */
227   struct rte_kni *kni;
228   u8 kni_port_id;
229
230   /* vhost-user related */
231   u32 vu_if_id;
232   struct virtio_net  vu_vhost_dev;
233   u32 vu_is_running;
234   dpdk_vu_intf_t *vu_intf;
235
236   /* af_packet */
237   u8 af_packet_port_id;
238
239   struct rte_eth_link link;
240   f64 time_last_link_update;
241
242   struct rte_eth_stats stats;
243   struct rte_eth_stats last_stats;
244   struct rte_eth_xstats * xstats;
245   f64 time_last_stats_update;
246   dpdk_port_type_t port_type;
247
248   dpdk_efd_agent_t efd_agent;
249   u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
250 } dpdk_device_t;
251
252 #define MAX_NELTS 32
253 typedef struct {
254   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
255   u64 head;
256   u64 head_hint;
257   u64 tail;
258   u32 n_in_use;
259   u32 nelts;
260   u32 written;
261   u32 threshold;
262   i32 n_vectors[MAX_NELTS];
263 } frame_queue_trace_t;
264
265 #define DPDK_TX_RING_SIZE (4 * 1024)
266
267 #define DPDK_STATS_POLL_INTERVAL  10.0
268 #define DPDK_LINK_POLL_INTERVAL   3.0
269
270 typedef struct {
271   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
272
273   /* total input packet counter */
274   u64 aggregate_rx_packets;
275 } dpdk_worker_t;
276
277 typedef struct {
278   u32 device;
279   u16 queue_id;
280 } dpdk_device_and_queue_t;
281
282 /* Early-Fast-Discard (EFD) */
283 #define DPDK_EFD_DISABLED                       0
284 #define DPDK_EFD_DISCARD_ENABLED                (1 << 0)
285 #define DPDK_EFD_MONITOR_ENABLED                (1 << 1)
286 #define DPDK_EFD_DROPALL_ENABLED                (1 << 2)
287
288 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT    90
289 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH  6
290
291 typedef struct dpdk_efd_t {
292   u16 enabled;
293   u16 queue_hi_thresh;
294   u16 consec_full_frames_hi_thresh;
295   u16 pad;
296 } dpdk_efd_t;
297
298 typedef struct {
299
300   /* Devices */
301   dpdk_device_t * devices;
302   dpdk_device_and_queue_t ** devices_by_cpu;
303
304   /* per-thread recycle lists */
305   u32 ** recycle;
306
307   /* buffer flags template, configurable to enable/disable tcp / udp cksum */
308   u32 buffer_flags_template;
309
310   /* flow control callback. If 0 then flow control is disabled */
311   dpdk_flowcontrol_callback_t flowcontrol_callback;
312
313   /* vlib buffer free list, must be same size as an rte_mbuf */
314   u32 vlib_buffer_free_list_index;
315
316   /*
317    * format interface names ala xxxEthernet%d/%d/%d instead of
318    * xxxEthernet%x/%x/%x. For VIRL.
319    */
320   u8 interface_name_format_decimal;
321
322
323   /* dpdk worker "threads" */
324   dpdk_worker_t * workers;
325
326   /* Config stuff */
327   u8 ** eal_init_args;
328   u8 * eal_init_args_str;
329   u8 * eth_if_blacklist;
330   u8 * eth_if_whitelist;
331   u8 * uio_driver_name;
332   u8 no_multi_seg;
333
334   /* Required config parameters */
335   u8 coremask_set_manually;
336   u8 nchannels_set_manually;
337   u32 coremask;
338   u32 nchannels;
339   u32 num_mbufs;
340   u32 use_rss;
341   u32 max_tx_queues;
342   u8 num_kni; /* while kni_init allows u32, port_id in callback fn is only u8 */
343
344   /* Ethernet input node index */
345   u32 ethernet_input_node_index;
346
347   /* dpdk i/o thread initialization barrier */
348   volatile u32 io_thread_release;
349
350   /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
351   int tx_pcap_enable;
352   pcap_main_t pcap_main;
353   u8 * pcap_filename;
354   u32 pcap_sw_if_index;
355   u32 pcap_pkts_to_capture;
356
357   /* virtio vhost-user switch */
358   u8 use_virtio_vhost;
359
360   /* vhost-user coalescence frames config */
361   u32 vhost_coalesce_frames;
362   f64 vhost_coalesce_time;
363
364   /* hashes */
365   uword * dpdk_device_by_kni_port_id;
366   uword * vu_sw_if_index_by_listener_fd;
367   uword * vu_sw_if_index_by_sock_fd;
368   u32 * vu_inactive_interfaces_device_index;
369
370   u32 next_vu_if_id;
371
372   /* efd (early-fast-discard) settings */
373   dpdk_efd_t efd;
374
375   /*
376    * flag indicating that a posted admin up/down
377    * (via post_sw_interface_set_flags) is in progress
378    */
379   u8 admin_up_down_in_progress;
380
381   u8 have_io_threads;
382
383   /* which cpus are running dpdk-input */
384   int input_cpu_first_index;
385   int input_cpu_count;
386
387   /* convenience */
388   vlib_main_t * vlib_main;
389   vnet_main_t * vnet_main;
390 } dpdk_main_t;
391
392 dpdk_main_t dpdk_main;
393
394 typedef enum {
395   DPDK_RX_NEXT_IP4_INPUT,
396   DPDK_RX_NEXT_IP6_INPUT,
397   DPDK_RX_NEXT_MPLS_INPUT,
398   DPDK_RX_NEXT_ETHERNET_INPUT,
399   DPDK_RX_NEXT_DROP,
400   DPDK_RX_N_NEXT,
401 } dpdk_rx_next_t;
402
403 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
404
405 void dpdk_set_next_node (dpdk_rx_next_t, char *);
406
407 typedef void (*dpdk_io_thread_callback_t) (vlib_main_t *vm);
408
409 void dpdk_io_thread (vlib_worker_thread_t * w,
410                      u32 instances,
411                      u32 instance_id,
412                      char *worker_name,
413                      dpdk_io_thread_callback_t callback);
414 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
415
416 clib_error_t * dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
417
418 void dpdk_set_flowcontrol_callback (vlib_main_t *vm, 
419                                     dpdk_flowcontrol_callback_t callback);
420
421 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
422
423 vlib_frame_queue_elt_t * vlib_get_handoff_queue_elt (u32 vlib_worker_index);
424
425 u32 dpdk_get_handoff_node_index (void);
426
427 void set_efd_bitmap (u8 *bitmap, u32 value, u32 op);
428
429 #define foreach_dpdk_error                                              \
430   _(NONE, "no error")                                                   \
431   _(RX_PACKET_ERROR, "Rx packet errors")                                \
432   _(RX_BAD_FCS, "Rx bad fcs")                                           \
433   _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors")                         \
434   _(IP_CHECKSUM_ERROR, "Rx ip checksum errors")                         \
435   _(RX_ALLOC_FAIL, "rx buf alloc from free list failed")                \
436   _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem")              \
437   _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")        \
438   _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops")             \
439   _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops")             \
440   _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops")             \
441   _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
442
443 typedef enum {
444 #define _(f,s) DPDK_ERROR_##f,
445   foreach_dpdk_error
446 #undef _
447   DPDK_N_ERROR,
448 } dpdk_error_t;
449
450 /*
451  * Increment EFD drop counter
452  */
453 static_always_inline
454 void increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
455 {
456    vlib_node_t *my_n;
457
458    my_n = vlib_get_node (vm, dpdk_input_node.index);
459    vm->error_main.counters[my_n->error_heap_index+counter_index] += count;
460 }
461
462 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
463 void dpdk_device_lock_init(dpdk_device_t * xd);
464 void dpdk_device_lock_free(dpdk_device_t * xd);
465 void dpdk_efd_update_counters(dpdk_device_t *xd, u32 n_buffers, u16 enabled);
466 u32 is_efd_discardable(vlib_thread_main_t *tm,
467                        vlib_buffer_t * b0,
468                        struct rte_mbuf *mb);
469
470 /* dpdk vhost-user interrupt management */
471 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t *xd, int idx);
472 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
473                                     int idx);
474
475
476 static inline u64 vnet_get_aggregate_rx_packets (void)
477 {
478     dpdk_main_t * dm = &dpdk_main;
479     u64 sum = 0;
480     dpdk_worker_t * dw;
481
482     vec_foreach(dw, dm->workers)
483         sum += dw->aggregate_rx_packets;
484
485     return sum;
486 }
487
488 void dpdk_rx_trace (dpdk_main_t * dm,
489                     vlib_node_runtime_t * node,
490                     dpdk_device_t * xd,
491                     u16 queue_id,
492                     u32 * buffers,
493                     uword n_buffers);
494
495 #define EFD_OPERATION_LESS_THAN          0
496 #define EFD_OPERATION_GREATER_OR_EQUAL   1
497
498 void efd_config(u32 enabled,
499                 u32 ip_prec,  u32 ip_op,
500                 u32 mpls_exp, u32 mpls_op,
501                 u32 vlan_cos, u32 vlan_op);
502
503 void post_sw_interface_set_flags (vlib_main_t *vm, u32 sw_if_index, u32 flags);
504
505 typedef struct vhost_user_memory vhost_user_memory_t;
506
507 void dpdk_vhost_user_process_init (void **ctx);
508 void dpdk_vhost_user_process_cleanup (void *ctx);
509 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx);
510
511 // vhost-user calls
512 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
513                               const char * sock_filename,
514                               u8 is_server,
515                               u32 * sw_if_index,
516                               u64 feature_mask,
517                               u8 renumber, u32 custom_dev_instance,
518                               u8 *hwaddr);
519 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
520                               const char * sock_filename,
521                               u8 is_server,
522                               u32 sw_if_index,
523                               u64 feature_mask,
524                               u8 renumber, u32 custom_dev_instance);
525 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
526                               u32 sw_if_index);
527 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
528                              vhost_user_intf_details_t **out_vuids);
529
530 u32 dpdk_get_admin_up_down_in_progress (void);
531
532 uword
533 dpdk_input_rss (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * f);
534
535 #endif /* __included_dpdk_h__ */