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