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