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