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