0368e04de30b4314470f218ae384a9a9b604db52
[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
135 Resolved Issues
136 ---------------
137
138 EAL
139 ~~~
140
141 * **eal/linux: Fixed epoll timeout.**
142
143   Fixed issue where the ``rte_epoll_wait()`` function didn't return when the
144   underlying call to ``epoll_wait()`` timed out.
145
146
147 Drivers
148 ~~~~~~~
149
150 * **igb: Fixed IEEE1588 frame identification in I210.**
151
152   Fixed issue where the flag PKT_RX_IEEE1588_PTP was not being set
153   in Intel I210 NIC, as EtherType in RX descriptor is in bits 8:10 of
154   Packet Type and not in the default bits 0:2.
155
156 * **igb: Fixed VF start with PF stopped.**
157
158   VF needs the PF interrupt support initialized even if not started.
159
160 * **igb: Fixed VF MAC address when using with DPDK PF.**
161
162   Assign a random MAC address in VF when not assigned by PF.
163
164 * **ixgbe: Fixed issue with X550 DCB.**
165
166   Fixed a DCB issue with x550 where for 8 TCs (Traffic Classes), if a packet
167   with user priority 6 or 7 was injected to the NIC, then the NIC would only
168   put 3 packets into the queue. There was also a similar issue for 4 TCs.
169
170 * **ixgbe: Removed burst size restriction of vector RX.**
171
172   Fixed issue where a burst size less than 32 didn't receive anything.
173
174 * **ixgbe: Fixed VF start with PF stopped.**
175
176   VF needs the PF interrupt support initialized even if not started.
177
178 * **ixgbe: Fixed TX hang when RS distance exceeds HW limit.**
179
180   Fixed an issue when TX queue can hang when a lot of highly fragmented
181   packets have to be sent.
182   As part of that fix, tx_rs_thresh for ixgbe PMD is not allowed to be greater
183   then to 32 to comply with HW restrictions.
184
185 * **i40e: Fixed base driver allocation when not using first numa node.**
186
187   Fixed i40e issue that occurred when a DPDK application didn't initialize
188   ports if memory wasn't available on socket 0.
189
190 * **i40e: Fixed maximum of 64 queues per port.**
191
192   Fixed the issue in i40e of cannot supporting more than 64 queues per port,
193   though hardware actually supports that. The real number of queues may vary,
194   as long as the total number of queues used in PF, VFs, VMDq and FD does not
195   exceeds the hardware maximum.
196
197 * **i40e: Fixed statistics of packets.**
198
199   Added discarding packets on VSI to the stats and rectify the old statistics.
200
201 * **i40e: Fixed issue of not freeing memzone.**
202
203   Fixed the issue of not freeing memzone in the call to free the memory for
204   adminq DMA.
205
206 * **mlx: Fixed driver loading.**
207
208   The mlx drivers were unable to load when built as a shared library,
209   due to a missing symbol in mempool library.
210
211 * **vhost: Fixed Qemu shutdown.**
212
213   Fixed issue with libvirt ``virsh destroy`` not killing the VM.
214
215 * **virtio: Fixed crash after changing link state.**
216
217   Fixed io permission in the interrupt handler.
218
219 * **virtio: Fixed crash when releasing queue.**
220
221   Fixed issue when releasing null control queue.
222
223
224 Libraries
225 ~~~~~~~~~
226
227 * **hash: Fixed memory allocation of Cuckoo Hash key table.**
228
229   Fixed issue where an incorrect Cuckoo Hash key table size could be
230   calculated limiting the size to 4GB.
231
232 * **hash: Fixed incorrect lookup if key is all zero.**
233
234   Fixed issue in hash library that occurred if an all zero
235   key was not added in the table and the key was looked up,
236   resulting in an incorrect hit.
237
238 * **hash: Fixed thread scaling by reducing contention.**
239
240   Fixed issue in hash library where, using multiple cores with
241   hardware transactional memory support, thread scaling did not work,
242   due to the global ring that is shared by all cores.
243
244
245 Examples
246 ~~~~~~~~
247
248 * **l3fwd: Fixed crash with IPv6.**
249
250 * **vhost_xen: Fixed compile error.**
251
252
253 Other
254 ~~~~~
255
256
257 Known Issues
258 ------------
259
260 * Some drivers do not fill the packet type when receiving.
261   As the l3fwd example application requires this info, the i40e vector
262   driver must be disabled to benefit of the packet type with i40e.
263
264
265 API Changes
266 -----------
267
268 * The deprecated flow director API is removed.
269   It was replaced by rte_eth_dev_filter_ctrl().
270
271 * The dcb_queue is renamed to dcb_tc in following dcb configuration
272   structures: rte_eth_dcb_rx_conf, rte_eth_dcb_tx_conf,
273   rte_eth_vmdq_dcb_conf, rte_eth_vmdq_dcb_tx_conf.
274
275 * The rte_eth_rx_queue_count() function now returns "int" instead of "uint32_t"
276   to allow the use of negative values as error codes on return.
277
278 * The function rte_eal_pci_close_one() is removed.
279   It was replaced by rte_eal_pci_detach().
280
281 * The deprecated ACL API ipv4vlan is removed.
282
283 * The deprecated hash function rte_jhash2() is removed.
284   It was replaced by rte_jhash_32b().
285
286 * The deprecated KNI functions are removed:
287   rte_kni_create(), rte_kni_get_port_id() and rte_kni_info_get().
288
289 * The deprecated ring PMD functions are removed:
290   rte_eth_ring_pair_create() and rte_eth_ring_pair_attach().
291
292 * The devargs union field virtual is renamed to virt for C++ compatibility.
293
294 ABI Changes
295 -----------
296
297 * The EAL and ethdev structures rte_intr_handle and rte_eth_conf were changed
298   to support Rx interrupt. It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
299
300 * The ethdev flow director entries for SCTP were changed.
301   It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
302
303 * The ethdev flow director structure rte_eth_fdir_flow_ext structure is changed.
304   New fields are added to support flow director filtering in VF.
305
306 * The size of the ethdev structure rte_eth_hash_filter_info is changed
307   by adding a new element rte_eth_input_set_conf in an union.
308
309 * The new fields rx_desc_lim and tx_desc_lim are added into rte_eth_dev_info
310   structure.
311
312 * For debug builds, the functions rte_eth_rx_burst(), rte_eth_tx_burst()
313   rte_eth_rx_descriptor_done() and rte_eth_rx_queue_count() will
314   no longer be separate functions in the DPDK libraries. Instead, they will
315   only be present in the rte_ethdev.h header file.
316
317 * The maximum number of queues per port CONFIG_RTE_MAX_QUEUES_PER_PORT is
318   increased to 1024.
319
320 * The mbuf structure was changed to support unified packet type.
321   It was already done in 2.1 for CONFIG_RTE_NEXT_ABI.
322
323 * The dummy malloc library is removed. The content was moved into EAL in 2.1.
324
325 * The LPM structure is changed. The deprecated field mem_location is removed.
326
327 * librte_table LPM: A new parameter to hold the table name will be added to
328   the LPM table parameter structure.
329
330 * librte_table hash: The key mask parameter is added to the hash table
331   parameter structure for 8-byte key and 16-byte key extendible bucket
332   and LRU tables.
333
334 * librte_port: Macros to access the packet meta-data stored within the packet
335   buffer has been adjusted to cover the packet mbuf structure.
336
337 * librte_cfgfile: Allow longer names and values by increasing the constants
338   CFG_NAME_LEN and CFG_VALUE_LEN to 64 and 256 respectively.
339
340
341 Shared Library Versions
342 -----------------------
343
344 The libraries prepended with a plus sign were incremented in this version.
345
346 .. code-block:: diff
347
348    + libethdev.so.2
349    + librte_acl.so.2
350    + librte_cfgfile.so.2
351      librte_cmdline.so.1
352      librte_distributor.so.1
353    + librte_eal.so.2
354    + librte_hash.so.2
355      librte_ip_frag.so.1
356      librte_ivshmem.so.1
357      librte_jobstats.so.1
358    + librte_kni.so.2
359      librte_kvargs.so.1
360    + librte_lpm.so.2
361    + librte_mbuf.so.2
362      librte_mempool.so.1
363      librte_meter.so.1
364    + librte_pipeline.so.2
365      librte_pmd_bond.so.1
366    + librte_pmd_ring.so.2
367    + librte_port.so.2
368      librte_power.so.1
369      librte_reorder.so.1
370      librte_ring.so.1
371      librte_sched.so.1
372    + librte_table.so.2
373      librte_timer.so.1
374      librte_vhost.so.1