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