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