Initial commit of vpp code.
[vpp.git] / vnet / vnet / devices / dpdk / dpdk_priv.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
16 #define DPDK_NB_RX_DESC_DEFAULT   512
17 #define DPDK_NB_TX_DESC_DEFAULT   512
18 #define DPDK_NB_RX_DESC_VIRTIO    256
19 #define DPDK_NB_TX_DESC_VIRTIO    256
20 #define DPDK_NB_RX_DESC_10GE    2048
21 #define DPDK_NB_TX_DESC_10GE    2048
22 #define DPDK_NB_RX_DESC_40GE    (4096-128)
23 #define DPDK_NB_TX_DESC_40GE    2048
24
25 #define foreach_dpdk_counter                    \
26   _ (tx_frames_ok, opackets)                    \
27   _ (tx_bytes_ok, obytes)                       \
28   _ (tx_errors, oerrors)                        \
29   _ (tx_loopback_frames_ok, olbpackets)         \
30   _ (tx_loopback_bytes_ok, olbbytes)            \
31   _ (rx_frames_ok, ipackets)                    \
32   _ (rx_bytes_ok, ibytes)                       \
33   _ (rx_errors, ierrors)                        \
34   _ (rx_missed, imissed)                        \
35   _ (rx_bad_crc, ibadcrc)                       \
36   _ (rx_bad_length, ibadlen)                    \
37   _ (rx_multicast_frames_ok, imcasts)           \
38   _ (rx_no_bufs, rx_nombuf)                     \
39   _ (rx_filter_match, fdirmatch)                \
40   _ (rx_filter_miss, fdirmiss)                  \
41   _ (tx_pause_xon, tx_pause_xon)                \
42   _ (rx_pause_xon, rx_pause_xon)                \
43   _ (tx_pause_xoff, tx_pause_xoff)              \
44   _ (rx_pause_xoff, rx_pause_xoff)              \
45   _ (rx_loopback_frames_ok, ilbpackets)         \
46   _ (rx_loopback_bytes_ok, ilbbytes)
47
48 #define foreach_dpdk_q_counter                  \
49   _ (rx_frames_ok, q_ipackets)                  \
50   _ (tx_frames_ok, q_opackets)                  \
51   _ (rx_bytes_ok, q_ibytes)                     \
52   _ (tx_bytes_ok, q_obytes)                     \
53   _ (rx_errors, q_errors)
54
55 #define foreach_dpdk_rss_hf                    \
56   _(ETH_RSS_IPV4,               "ipv4")        \
57   _(ETH_RSS_FRAG_IPV4,          "ipv4-frag")   \
58   _(ETH_RSS_NONFRAG_IPV4_TCP,   "ipv4-tcp")    \
59   _(ETH_RSS_NONFRAG_IPV4_UDP,   "ipv4-udp")    \
60   _(ETH_RSS_NONFRAG_IPV4_SCTP,  "ipv4-sctp")   \
61   _(ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other")  \
62   _(ETH_RSS_IPV6,               "ipv6")        \
63   _(ETH_RSS_FRAG_IPV6,          "ipv6-frag")   \
64   _(ETH_RSS_NONFRAG_IPV6_TCP,   "ipv6-tcp")    \
65   _(ETH_RSS_NONFRAG_IPV6_UDP,   "ipv6-udp")    \
66   _(ETH_RSS_NONFRAG_IPV6_SCTP,  "ipv6-sctp")   \
67   _(ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other")  \
68   _(ETH_RSS_L2_PAYLOAD,         "l2-payload")  \
69   _(ETH_RSS_IPV6_EX,            "ipv6-ex")     \
70   _(ETH_RSS_IPV6_TCP_EX,        "ipv6-tcp-ex") \
71   _(ETH_RSS_IPV6_UDP_EX,        "ipv6-udp-ex")
72
73 #define foreach_dpdk_rx_offload_caps            \
74   _(DEV_RX_OFFLOAD_VLAN_STRIP, "vlan-strip")    \
75   _(DEV_RX_OFFLOAD_IPV4_CKSUM, "ipv4-cksum")    \
76   _(DEV_RX_OFFLOAD_UDP_CKSUM , "udp-cksum")     \
77   _(DEV_RX_OFFLOAD_TCP_CKSUM , "tcp-cksum")     \
78   _(DEV_RX_OFFLOAD_TCP_LRO   , "rcp-lro")       \
79   _(DEV_RX_OFFLOAD_QINQ_STRIP, "qinq-strip")
80
81 #define foreach_dpdk_tx_offload_caps           \
82   _(DEV_TX_OFFLOAD_VLAN_INSERT, "vlan-insert") \
83   _(DEV_TX_OFFLOAD_IPV4_CKSUM,  "ipv4-cksum")  \
84   _(DEV_TX_OFFLOAD_UDP_CKSUM  , "udp-cksum")   \
85   _(DEV_TX_OFFLOAD_TCP_CKSUM  , "tcp-cksum")   \
86   _(DEV_TX_OFFLOAD_SCTP_CKSUM , "sctp-cksum")  \
87   _(DEV_TX_OFFLOAD_TCP_TSO    , "tcp-tso")     \
88   _(DEV_TX_OFFLOAD_UDP_TSO    , "udp-tso")     \
89   _(DEV_TX_OFFLOAD_OUTER_IPV4_CKSUM, "outer-ipv4-cksum") \
90   _(DEV_TX_OFFLOAD_QINQ_INSERT, "qinq-insert")
91
92 #if RTE_VERSION >= RTE_VERSION_NUM(2, 1, 0, 0)
93
94 #define foreach_dpdk_pkt_rx_offload_flag                                \
95   _ (PKT_RX_VLAN_PKT, "RX packet is a 802.1q VLAN packet")              \
96   _ (PKT_RX_RSS_HASH, "RX packet with RSS hash result")                 \
97   _ (PKT_RX_FDIR, "RX packet with FDIR infos")                          \
98   _ (PKT_RX_L4_CKSUM_BAD, "L4 cksum of RX pkt. is not OK")              \
99   _ (PKT_RX_IP_CKSUM_BAD, "IP cksum of RX pkt. is not OK")              \
100   _ (PKT_RX_IEEE1588_PTP, "RX IEEE1588 L2 Ethernet PT Packet")          \
101   _ (PKT_RX_IEEE1588_TMST, "RX IEEE1588 L2/L4 timestamped packet")
102
103 #define foreach_dpdk_pkt_type                                   \
104   _ (RTE_PTYPE_L3_IPV4, "Packet with IPv4 header")              \
105   _ (RTE_PTYPE_L3_IPV4_EXT, "Packet with extended IPv4 header") \
106   _ (RTE_PTYPE_L3_IPV6, "Packet with IPv6 header")              \
107   _ (RTE_PTYPE_L3_IPV6_EXT, "Packet with extended IPv6 header")
108 #else
109 #define foreach_dpdk_pkt_rx_offload_flag                                \
110   _ (PKT_RX_VLAN_PKT, "RX packet is a 802.1q VLAN packet")              \
111   _ (PKT_RX_RSS_HASH, "RX packet with RSS hash result")                 \
112   _ (PKT_RX_FDIR, "RX packet with FDIR infos")                          \
113   _ (PKT_RX_L4_CKSUM_BAD, "L4 cksum of RX pkt. is not OK")              \
114   _ (PKT_RX_IP_CKSUM_BAD, "IP cksum of RX pkt. is not OK")              \
115   _ (PKT_RX_IPV4_HDR, "RX packet with IPv4 header")                     \
116   _ (PKT_RX_IPV4_HDR_EXT, "RX packet with extended IPv4 header")        \
117   _ (PKT_RX_IPV6_HDR, "RX packet with IPv6 header")                     \
118   _ (PKT_RX_IPV6_HDR_EXT, "RX packet with extended IPv6 header")        \
119   _ (PKT_RX_IEEE1588_PTP, "RX IEEE1588 L2 Ethernet PT Packet")          \
120   _ (PKT_RX_IEEE1588_TMST, "RX IEEE1588 L2/L4 timestamped packet")
121
122 #define foreach_dpdk_pkt_type /* Dummy */
123 #endif /* RTE_VERSION */
124
125 #define foreach_dpdk_pkt_tx_offload_flag                                \
126   _ (PKT_TX_VLAN_PKT, "TX packet is a 802.1q VLAN packet")              \
127   _ (PKT_TX_IP_CKSUM, "IP cksum of TX pkt. computed by NIC")            \
128   _ (PKT_TX_TCP_CKSUM, "TCP cksum of TX pkt. computed by NIC")          \
129   _ (PKT_TX_SCTP_CKSUM, "SCTP cksum of TX pkt. computed by NIC")        \
130   _ (PKT_TX_IEEE1588_TMST, "TX IEEE1588 packet to timestamp")
131
132 #define foreach_dpdk_pkt_offload_flag           \
133   foreach_dpdk_pkt_rx_offload_flag              \
134   foreach_dpdk_pkt_tx_offload_flag
135
136 static inline u8 * format_dpdk_pkt_types (u8 * s, va_list * va)
137 {
138   u32 *pkt_types = va_arg (*va, u32 *);
139   uword indent __attribute__((unused)) = format_get_indent (s) + 2;
140
141   if (!*pkt_types)
142     return s;
143
144   s = format (s, "Packet Types");
145
146 #define _(F, S)             \
147   if (*pkt_types & F)           \
148     {               \
149       s = format (s, "\n%U%s (0x%04x) %s",      \
150       format_white_space, indent, #F, F, S);  \
151     }
152   
153   foreach_dpdk_pkt_type
154
155 #undef _
156
157   return s;
158 }
159
160 static inline u8 * format_dpdk_pkt_offload_flags (u8 * s, va_list * va)
161 {
162   u16 *ol_flags = va_arg (*va, u16 *);
163   uword indent = format_get_indent (s) + 2;
164
165   if (!*ol_flags)
166     return s;
167
168   s = format (s, "Packet Offload Flags");
169
170 #define _(F, S)             \
171   if (*ol_flags & F)            \
172     {               \
173       s = format (s, "\n%U%s (0x%04x) %s",      \
174       format_white_space, indent, #F, F, S);  \
175     }
176   
177   foreach_dpdk_pkt_offload_flag
178
179 #undef _
180
181   return s;
182 }
183
184 static inline u8 * format_dpdk_rte_mbuf (u8 * s, va_list * va)
185 {
186   struct rte_mbuf * mb = va_arg (*va, struct rte_mbuf *);
187   uword indent = format_get_indent (s) + 2;
188
189   s = format (s, "PKT MBUF: port %d, nb_segs %d, pkt_len %d"
190               "\n%Ubuf_len %d, data_len %d, ol_flags 0x%x,"
191               "\n%Upacket_type 0x%x",
192               mb->port, mb->nb_segs, mb->pkt_len,
193               format_white_space, indent, 
194               mb->buf_len, mb->data_len, mb->ol_flags,
195               format_white_space, indent, 
196               mb->packet_type);
197
198   if (mb->ol_flags)
199     s = format (s, "\n%U%U", format_white_space, indent,
200                 format_dpdk_pkt_offload_flags, &mb->ol_flags);
201
202   if (mb->packet_type)
203     s = format (s, "\n%U%U", format_white_space, indent,
204                 format_dpdk_pkt_types, &mb->packet_type);
205   return s;
206 }
207
208 #ifdef RTE_LIBRTE_MBUF_EXT_RX_OLFLAGS
209 #define foreach_dpdk_pkt_ext_rx_offload_flag                    \
210   _ (PKT_EXT_RX_PKT_ERROR, "RX Packet Error")                   \
211   _ (PKT_EXT_RX_BAD_FCS, "RX Bad FCS checksum")                 \
212   _ (PKT_EXT_RX_UDP, "RX packet with UDP L4 header")            \
213   _ (PKT_EXT_RX_TCP, "RX packet with TCP L4 header")            \
214   _ (PKT_EXT_RX_IPV4_FRAGMENT, "RX packet IPv4 Fragment")
215
216 #define foreach_dpdk_pkt_ext_offload_flag \
217   foreach_dpdk_pkt_rx_offload_flag    \
218   foreach_dpdk_pkt_ext_rx_offload_flag
219
220 static inline u8 * format_dpdk_pkt_rx_offload_flags (u8 * s, va_list * va)
221 {
222   u16 *ol_flags = va_arg (*va, u16 *);
223   uword indent = format_get_indent (s) + 2;
224
225   if (!*ol_flags)
226     return s;
227
228   s = format (s, "Packet RX Offload Flags");
229
230 #define _(F, S)             \
231   if (*ol_flags & F)            \
232     {               \
233       s = format (s, "\n%U%s (0x%04x) %s",      \
234       format_white_space, indent, #F, F, S);  \
235     }
236   
237   foreach_dpdk_pkt_ext_offload_flag
238
239 #undef _
240
241   return s;
242 }
243
244 static inline u8 * format_dpdk_rx_rte_mbuf (u8 * s, va_list * va)
245 {
246   struct rte_mbuf * mb = va_arg (*va, struct rte_mbuf *);
247   uword indent = format_get_indent (s) + 2;
248
249   /*
250    * Note: Assumes mb is head of pkt chain -- port, nb_segs, & pkt_len
251    *       are only valid for the 1st mbuf segment.
252    */
253   s = format (s, "PKT MBUF: port %d, nb_segs %d, pkt_len %d"
254               "\n%Ubuf_len %d, data_len %d, ol_flags 0x%x"
255               "\n%Upacket_type 0x%x",
256               mb->port, mb->nb_segs, mb->pkt_len,
257               format_white_space, indent,
258               mb->buf_len, mb->data_len, mb->ol_flags,
259               format_white_space, indent,
260               mb->packet_type);
261
262   if (mb->ol_flags)
263     s = format (s, "\n%U%U", format_white_space, indent,
264                 format_dpdk_pkt_rx_offload_flags, &mb->ol_flags);
265
266   if (mb->packet_type)
267     s = format (s, "\n%U%U", format_white_space, indent,
268                 format_dpdk_pkt_types, &mb->packet_type);
269   return s;
270 }
271 #endif /* RTE_LIBRTE_MBUF_EXT_RX_OLFLAGS */
272
273 /* These args appear by themselves */
274 #define foreach_eal_double_hyphen_predicate_arg \
275 _(no-shconf)                                    \
276 _(no-hpet)                                      \
277 _(no-pci)                                       \
278 _(no-huge)                                      \
279 _(vmware-tsc-map)                               \
280 _(virtio-vhost)
281
282 #define foreach_eal_single_hyphen_mandatory_arg \
283 _(coremask, c)                                  \
284 _(nchannels, n)                                 \
285
286 #define foreach_eal_single_hyphen_arg           \
287 _(blacklist, b)                                 \
288 _(mem-alloc-request, m)                         \
289 _(force-ranks, r)
290
291 /* These args are preceeded by "--" and followed by a single string */
292 #define foreach_eal_double_hyphen_arg           \
293 _(huge-dir)                                     \
294 _(proc-type)                                    \
295 _(file-prefix)                                  \
296 _(socket-mem)                                   \
297 _(vdev)
298
299 static inline u32
300 dpdk_rx_burst ( dpdk_main_t * dm, dpdk_device_t * xd, u16 queue_id)
301 {
302   u32 n_buffers;
303   u32 n_left;
304   u32 n_this_chunk;
305
306   n_left = VLIB_FRAME_SIZE;
307   n_buffers = 0;
308
309   if (PREDICT_TRUE(xd->dev_type == VNET_DPDK_DEV_ETH))
310     {
311       while (n_left)
312         {
313           n_this_chunk = rte_eth_rx_burst (xd->device_index, queue_id,
314                                            xd->rx_vectors[queue_id] + n_buffers, n_left);
315           n_buffers += n_this_chunk;
316           n_left -= n_this_chunk;
317
318           /* Empirically, DPDK r1.8 produces vectors w/ 32 or fewer elts */
319           if (n_this_chunk < 32)
320             break;
321       }
322     }
323   else if (xd->dev_type == VNET_DPDK_DEV_VHOST_USER)
324     {
325       vlib_main_t * vm = vlib_get_main();
326       vlib_buffer_main_t * bm = vm->buffer_main;
327       unsigned socket_id = rte_socket_id();
328
329       if (PREDICT_FALSE(!xd->vu_is_running))
330         return 0;
331
332       n_buffers = rte_vhost_dequeue_burst(&xd->vu_vhost_dev, VIRTIO_TXQ,
333                                           bm->pktmbuf_pools[socket_id],
334                                           xd->rx_vectors[queue_id], VLIB_FRAME_SIZE);
335
336       f64 now = vlib_time_now (dm->vlib_main);
337
338       /* send pending interrupts if needed */
339       if (dpdk_vhost_user_want_interrupt(xd, VIRTIO_TXQ)) {
340           dpdk_vu_vring *vring = &(xd->vu_intf->vrings[VIRTIO_TXQ]);
341           vring->n_since_last_int += n_buffers;
342
343           if ((vring->n_since_last_int && (vring->int_deadline < now))
344               || (vring->n_since_last_int > dm->vhost_coalesce_frames))
345             dpdk_vhost_user_send_interrupt(dm->vlib_main, xd, VIRTIO_TXQ);
346       }
347
348       if (dpdk_vhost_user_want_interrupt(xd, VIRTIO_RXQ)) {
349           dpdk_vu_vring *vring = &(xd->vu_intf->vrings[VIRTIO_RXQ]);
350           if (vring->n_since_last_int && (vring->int_deadline < now))
351             dpdk_vhost_user_send_interrupt(dm->vlib_main, xd, VIRTIO_RXQ);
352       }
353
354     }
355   else if (xd->dev_type == VNET_DPDK_DEV_KNI)
356     {
357       n_buffers = rte_kni_rx_burst(xd->kni, xd->rx_vectors[queue_id], VLIB_FRAME_SIZE);
358       rte_kni_handle_request(xd->kni);
359     }
360   else
361     {
362       ASSERT(0);
363     }
364
365   return n_buffers;
366 }
367
368
369 static inline void
370 dpdk_update_counters (dpdk_device_t * xd, f64 now)
371 {
372   vlib_simple_counter_main_t * cm;
373   vnet_main_t * vnm = vnet_get_main();
374   u32 my_cpu = os_get_cpu_number();
375   u64 rxerrors, last_rxerrors;
376   int len;
377
378   /* only update counters for PMD interfaces */
379   if (xd->dev_type != VNET_DPDK_DEV_ETH)
380     return;
381
382   /*
383    * DAW-FIXME: VMXNET3 device stop/start doesn't work,
384    * therefore fake the stop in the dpdk driver by
385    * silently dropping all of the incoming pkts instead of
386    * stopping the driver / hardware.
387    */
388   if (xd->admin_up != 0xff)
389     {
390       xd->time_last_stats_update = now ? now : xd->time_last_stats_update;
391       memcpy (&xd->last_stats, &xd->stats, sizeof (xd->last_stats));
392       rte_eth_stats_get (xd->device_index, &xd->stats);
393
394       /* maybe bump interface rx no buffer counter */
395       if (PREDICT_FALSE (xd->stats.rx_nombuf != xd->last_stats.rx_nombuf))
396         {
397           cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
398                                  VNET_INTERFACE_COUNTER_RX_NO_BUF);
399
400           vlib_increment_simple_counter (cm, my_cpu, xd->vlib_sw_if_index,
401                                          xd->stats.rx_nombuf -
402                                          xd->last_stats.rx_nombuf);
403         }
404
405       /* missed pkt counter */
406       if (PREDICT_FALSE (xd->stats.imissed != xd->last_stats.imissed))
407         {
408           cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
409                                  VNET_INTERFACE_COUNTER_RX_MISS);
410
411           vlib_increment_simple_counter (cm, my_cpu, xd->vlib_sw_if_index,
412                                          xd->stats.imissed -
413                                          xd->last_stats.imissed);
414         }
415       rxerrors = xd->stats.ibadcrc
416         + xd->stats.ibadlen + xd->stats.ierrors;
417       last_rxerrors = xd->last_stats.ibadcrc
418         + xd->last_stats.ibadlen + xd->last_stats.ierrors;
419
420       if (PREDICT_FALSE (rxerrors != last_rxerrors))
421         {
422           cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
423                                  VNET_INTERFACE_COUNTER_RX_ERROR);
424
425           vlib_increment_simple_counter (cm, my_cpu, xd->vlib_sw_if_index,
426                                          rxerrors - last_rxerrors);
427         }
428     }
429
430   if ((len = rte_eth_xstats_get(xd->device_index, NULL, 0)) > 0)
431     {
432       vec_validate(xd->xstats, len - 1);
433       len = rte_eth_xstats_get(xd->device_index, xd->xstats, vec_len(xd->xstats));
434       ASSERT(vec_len(xd->xstats) == len);
435       _vec_len(xd->xstats) = len;
436     }
437 }