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