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