591f4cc9b49a3ec7bdba294fd1d11251e8323ce1
[dpdk.git] / doc / guides / rel_notes / release_2_2.rst
1 DPDK Release 2.2
2 ================
3
4 New Features
5 ------------
6
7 * **Introduce ARMv7 and ARMv8 architectures**
8
9   * It is now possible to build DPDK for the ARMv7 and ARMv8 platforms.
10   * ARMv7 can be tested with virtual PMD drivers.
11   * ARMv8 can be tested with virtual and physical PMD drivers.
12
13 * **Enabled freeing of ring.**
14
15   New function rte_ring_free() allows the user to free a ring
16   if it was created with rte_ring_create().
17
18 * **Added keepalive support to EAL and example application.**
19
20 * **Added experimental cryptodev API**
21
22   The cryptographic processing of packet is provided as a preview
23   with two drivers for:
24
25   * Intel QuickAssist devices
26   * Intel AES-NI multi-buffer library
27
28   Due to its experimental state, the API may change without prior notice.
29
30 * **Added ethdev API to support IEEE1588.**
31
32   Added functions to read, write and adjust system time in the NIC.
33
34 * **Extended Statistics**
35
36   Define extended statistics naming scheme to store metadata in the name
37   string name of each statistic, refer to the Extended Statistics section
38   of the programmers guide. Implemented the extended stats API for these
39   PMDs:
40
41   * igb
42   * igbvf
43   * i40e
44   * i40evf
45   * fm10k
46   * virtio
47
48 * **Added API in ethdev to retrieve RX/TX queue information.**
49
50   *  Add the ability for the upper layer to query RX/TX queue information.
51   *  Add into rte_eth_dev_info new fields to represent information about
52      RX/TX descriptors min/max/align numbers per queue for the device.
53
54 * **Added RSS dynamic configuration to bonding.**
55
56 * **Added e1000 Rx interrupt support.**
57
58 * **Added igb TSO support for both PF and VF.**
59
60 * **RSS enhancement on Intel x550 NIC**
61
62   * Support 512 entries RSS redirection table.
63   * Support per VF RSS redirection table.
64
65 * **Flow director enhancement on Intel x550 NIC**
66
67   * Add 2 new flow director modes on x550.
68   * One is MAC VLAN mode, the other is tunnel mode.
69
70 * **Added i40e vector RX/TX.**
71
72 * **Added i40e Rx interrupt support.**
73
74 * **Added i40e flow control support.**
75
76 * **Added DCB support to i40e PF driver.**
77
78 * **Added RSS/FD input set granularity on Intel X710/XL710.**
79
80 * **Added different GRE key length for input set on Intel X710/XL710.**
81
82 * **Added flow director support in i40e VF.**
83
84 * **Added fm10k vector RX/TX.**
85
86 * **Added fm10k TSO support for both PF and VF.**
87
88 * **Added fm10k VMDQ support.**
89
90 * **New NIC Boulder Rapid support.**
91
92   Boulder Rapid is a new NIC of Intel's fm10k family.
93
94 * **Enhanced support for the Chelsio CXGBE driver.**
95
96   *  Added support for Jumbo Frames.
97   *  Optimize forwarding performance for Chelsio T5 40GbE cards.
98
99 * **Improved enic Tx packet rate.**
100
101   Reduced frequency of Tx tail pointer updates to the NIC.
102
103 * **Added support for Mellanox ConnectX-4 adapters (mlx5).**
104
105   The mlx5 poll-mode driver implements support for Mellanox ConnectX-4 EN
106   and Mellanox ConnectX-4 Lx EN families of 10/25/40/50/100 Gb/s adapters.
107
108   Like mlx4, this PMD is only available for Linux and is disabled by default
109   due to external dependencies (libibverbs and libmlx5).
110
111 * **Added driver for Netronome nfp-6xxx card.**
112
113   Support for using Netronome nfp-6xxx with PCI VFs.
114
115 * **Added virtual szedata2 driver for COMBO cards.**
116
117   Added virtual PMD for COMBO-100G and COMBO-80G cards.
118   PMD is disabled in default configuration.
119
120 * **Enhanced support for virtio driver.**
121
122   * Virtio ring layout optimization (fixed avail ring)
123   * Vector RX
124   * Simple TX
125
126 * **Added vhost-user multiple queue support.**
127
128 * **Added port hotplug support to vmxnet3.**
129
130 * **Added port hotplug support to xenvirt.**
131
132 * **Added ethtool shim and sample application.**
133
134 * **Added experimental performance thread example application.**
135
136   The application demonstrates L3 fowarding with different threading
137   models: pthreads, cgroups, or lighweight threads. The example inludes
138   a simple cooperative scheduler.
139
140   Due to its experimental state this application may change without notice.
141   The application is supported only for Linux x86_64.
142
143
144 Resolved Issues
145 ---------------
146
147 EAL
148 ~~~
149
150 * **eal/linux: Fixed epoll timeout.**
151
152   Fixed issue where the ``rte_epoll_wait()`` function didn't return when the
153   underlying call to ``epoll_wait()`` timed out.
154
155
156 Drivers
157 ~~~~~~~
158
159 * **igb: Fixed IEEE1588 frame identification in I210.**
160
161   Fixed issue where the flag PKT_RX_IEEE1588_PTP was not being set
162   in Intel I210 NIC, as EtherType in RX descriptor is in bits 8:10 of
163   Packet Type and not in the default bits 0:2.
164
165 * **igb: Fixed VF start with PF stopped.**
166
167   VF needs the PF interrupt support initialized even if not started.
168
169 * **igb: Fixed VF MAC address when using with DPDK PF.**
170
171   Assign a random MAC address in VF when not assigned by PF.
172
173 * **ixgbe: Fixed issue with X550 DCB.**
174
175   Fixed a DCB issue with x550 where for 8 TCs (Traffic Classes), if a packet
176   with user priority 6 or 7 was injected to the NIC, then the NIC would only
177   put 3 packets into the queue. There was also a similar issue for 4 TCs.
178
179 * **ixgbe: Removed burst size restriction of vector RX.**
180
181   Fixed issue where a burst size less than 32 didn't receive anything.
182
183 * **ixgbe: Fixed VF start with PF stopped.**
184
185   VF needs the PF interrupt support initialized even if not started.
186
187 * **ixgbe: Fixed TX hang when RS distance exceeds HW limit.**
188
189   Fixed an issue when TX queue can hang when a lot of highly fragmented
190   packets have to be sent.
191   As part of that fix, tx_rs_thresh for ixgbe PMD is not allowed to be greater
192   then to 32 to comply with HW restrictions.
193
194 * **i40e: Fixed base driver allocation when not using first numa node.**
195
196   Fixed i40e issue that occurred when a DPDK application didn't initialize
197   ports if memory wasn't available on socket 0.
198
199 * **i40e: Fixed maximum of 64 queues per port.**
200
201   Fixed the issue in i40e of cannot supporting more than 64 queues per port,
202   though hardware actually supports that. The real number of queues may vary,
203   as long as the total number of queues used in PF, VFs, VMDq and FD does not
204   exceeds the hardware maximum.
205
206 * **i40e: Fixed statistics of packets.**
207
208   Added discarding packets on VSI to the stats and rectify the old statistics.
209
210 * **i40e: Fixed issue of not freeing memzone.**
211
212   Fixed the issue of not freeing memzone in the call to free the memory for
213   adminq DMA.
214
215 * **mlx: Fixed driver loading.**
216
217   The mlx drivers were unable to load when built as a shared library,
218   due to a missing symbol in mempool library.
219
220 * **vhost: Fixed Qemu shutdown.**
221
222   Fixed issue with libvirt ``virsh destroy`` not killing the VM.
223
224 * **virtio: Fixed crash after changing link state.**
225
226   Fixed io permission in the interrupt handler.
227
228 * **virtio: Fixed crash when releasing queue.**
229
230   Fixed issue when releasing null control queue.
231
232
233 Libraries
234 ~~~~~~~~~
235
236 * **hash: Fixed memory allocation of Cuckoo Hash key table.**
237
238   Fixed issue where an incorrect Cuckoo Hash key table size could be
239   calculated limiting the size to 4GB.
240
241 * **hash: Fixed incorrect lookup if key is all zero.**
242
243   Fixed issue in hash library that occurred if an all zero
244   key was not added in the table and the key was looked up,
245   resulting in an incorrect hit.
246
247 * **hash: Fixed thread scaling by reducing contention.**
248
249   Fixed issue in hash library where, using multiple cores with
250   hardware transactional memory support, thread scaling did not work,
251   due to the global ring that is shared by all cores.
252
253
254 Examples
255 ~~~~~~~~
256
257 * **l3fwd: Fixed crash with IPv6.**
258
259 * **vhost_xen: Fixed compile error.**
260
261
262 Other
263 ~~~~~
264
265
266 Known Issues
267 ------------
268
269 * Some drivers do not fill the packet type when receiving.
270   As the l3fwd example application requires this info, the i40e vector
271   driver must be disabled to benefit of the packet type with i40e.
272
273
274 API Changes
275 -----------
276
277 * The deprecated flow director API is removed.
278   It was replaced by rte_eth_dev_filter_ctrl().
279
280 * The dcb_queue is renamed to dcb_tc in following dcb configuration
281   structures: rte_eth_dcb_rx_conf, rte_eth_dcb_tx_conf,
282   rte_eth_vmdq_dcb_conf, rte_eth_vmdq_dcb_tx_conf.
283
284 * The rte_eth_rx_queue_count() function now returns "int" instead of "uint32_t"
285   to allow the use of negative values as error codes on return.
286
287 * The function rte_eal_pci_close_one() is removed.
288   It was replaced by rte_eal_pci_detach().
289
290 * The deprecated ACL API ipv4vlan is removed.
291
292 * The deprecated hash function rte_jhash2() is removed.
293   It was replaced by rte_jhash_32b().
294
295 * The deprecated KNI functions are removed:
296   rte_kni_create(), rte_kni_get_port_id() and rte_kni_info_get().
297
298 * The deprecated ring PMD functions are removed:
299   rte_eth_ring_pair_create() and rte_eth_ring_pair_attach().
300
301 * The devargs union field virtual is renamed to virt for C++ compatibility.
302
303 ABI Changes
304 -----------
305
306 * The EAL and ethdev structures rte_intr_handle and rte_eth_conf were changed
307   to support Rx interrupt. It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
308
309 * The ethdev flow director entries for SCTP were changed.
310   It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
311
312 * The ethdev flow director structure rte_eth_fdir_flow_ext structure is changed.
313   New fields are added to support flow director filtering in VF.
314
315 * The size of the ethdev structure rte_eth_hash_filter_info is changed
316   by adding a new element rte_eth_input_set_conf in an union.
317
318 * The new fields rx_desc_lim and tx_desc_lim are added into rte_eth_dev_info
319   structure.
320
321 * For debug builds, the functions rte_eth_rx_burst(), rte_eth_tx_burst()
322   rte_eth_rx_descriptor_done() and rte_eth_rx_queue_count() will
323   no longer be separate functions in the DPDK libraries. Instead, they will
324   only be present in the rte_ethdev.h header file.
325
326 * The maximum number of queues per port CONFIG_RTE_MAX_QUEUES_PER_PORT is
327   increased to 1024.
328
329 * The mbuf structure was changed to support unified packet type.
330   It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
331
332 * The dummy malloc library is removed. The content was moved into EAL in 2.1.
333
334 * The LPM structure is changed. The deprecated field mem_location is removed.
335
336 * librte_table LPM: A new parameter to hold the table name will be added to
337   the LPM table parameter structure.
338
339 * librte_table hash: The key mask parameter is added to the hash table
340   parameter structure for 8-byte key and 16-byte key extendible bucket
341   and LRU tables.
342
343 * librte_port: Macros to access the packet meta-data stored within the packet
344   buffer has been adjusted to cover the packet mbuf structure.
345
346 * librte_cfgfile: Allow longer names and values by increasing the constants
347   CFG_NAME_LEN and CFG_VALUE_LEN to 64 and 256 respectively.
348
349
350 Shared Library Versions
351 -----------------------
352
353 The libraries prepended with a plus sign were incremented in this version.
354
355 .. code-block:: diff
356
357    + libethdev.so.2
358    + librte_acl.so.2
359    + librte_cfgfile.so.2
360      librte_cmdline.so.1
361      librte_distributor.so.1
362    + librte_eal.so.2
363    + librte_hash.so.2
364      librte_ip_frag.so.1
365      librte_ivshmem.so.1
366      librte_jobstats.so.1
367    + librte_kni.so.2
368      librte_kvargs.so.1
369    + librte_lpm.so.2
370    + librte_mbuf.so.2
371      librte_mempool.so.1
372      librte_meter.so.1
373    + librte_pipeline.so.2
374      librte_pmd_bond.so.1
375    + librte_pmd_ring.so.2
376    + librte_port.so.2
377      librte_power.so.1
378      librte_reorder.so.1
379      librte_ring.so.1
380      librte_sched.so.1
381    + librte_table.so.2
382      librte_timer.so.1
383      librte_vhost.so.1