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