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