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