4 .. **Read this first.**
6 The text below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
12 Build the docs and view the output file to ensure the changes are correct::
16 firefox build/doc/html/guides/rel_notes/release_16_07.html
22 .. This section should contain new features added in this release. Sample format:
24 * **Add a title in the past tense with a full stop.**
26 Add a short 1-2 sentence description in the past tense. The description
27 should be enough to allow someone scanning the release notes to understand
30 If the feature adds a lot of sub-features you can use a bullet list like this.
32 * Added feature foo to do something.
33 * Enhanced feature bar to do something else.
35 Refer to the previous release notes for examples.
37 * **Removed mempool cache if not needed.**
39 The size of the mempool structure is reduced if the per-lcore cache is disabled.
41 * **Added mempool external cache for non-EAL thread.**
43 Added new functions to create, free or flush a user-owned mempool
44 cache for non-EAL threads. Previously the cache was always disabled
47 * **Changed the memory allocation in mempool library.**
49 * Added ability to allocate a large mempool in virtually fragmented memory.
50 * Added new APIs to populate a mempool with memory.
51 * Added an API to free a mempool.
52 * Modified the API of the ``rte_mempool_obj_iter()`` function.
53 * Dropped specific Xen Dom0 code.
54 * Dropped specific anonymous mempool code in testpmd.
56 * **Added new driver for Broadcom NetXtreme-C devices.**
58 Added the new bnxt driver for Broadcom NetXtreme-C devices. See the
59 "Network Interface Controller Drivers" document for more details on this
62 * **Added new driver for ThunderX nicvf device.**
64 * **Added mailbox interrupt support for ixgbe and igb VFs.**
66 When the physical NIC link comes up or down, the PF driver will send a
67 mailbox message to notify each VF. To handle this link up/down event,
68 support have been added for a mailbox interrupt to receive the message and
69 allow the application to register a callback for it.
71 * **Updated the ixgbe base driver.**
73 The ixgbe base driver was updated with changes including the
76 * Added sgmii link for X550.
77 * Added MAC link setup for X550a SFP and SFP+.
78 * Added KR support for X550em_a.
79 * Added new PHY definitions for M88E1500.
80 * Added support for the VLVF to be bypassed when adding/removing a VFTA entry.
81 * Added X550a flow control auto negotiation support.
83 * **Updated the i40e base driver.**
85 Updated the i40e base driver including support for new devices IDs.
87 * **Updated the enic driver.**
89 The enic driver was updated with changes including the following:
91 * Optimized the Tx function.
92 * Added Scattered Rx capability.
93 * Improved packet type identification.
94 * Added MTU update in non Scattered Rx mode and enabled MTU of up to 9208
95 with UCS Software release 2.2 on 1300 series VICs.
97 * **Updated the mlx5 driver.**
99 The mlx5 driver was updated with changes including the following:
101 * Data path was refactored to bypass Verbs to improve RX and TX performance.
102 * Removed compilation parameters for inline send, ``MLX5_MAX_INLINE``, and
103 added command line parameter instead, ``txq_inline``.
104 * Improved TX scatter gather support:
105 Removed compilation parameter ``MLX5_PMD_SGE_WR_N``.
106 Scatter-gather elements is set to the maximum value the NIC supports.
107 Removed linearization logic, this decreases the memory consumption of the PMD.
108 * Improved jumbo frames support, by dynamically setting RX scatter gather elements
109 according to the MTU and mbuf size,
110 no need for compilation parameter ``MLX5_PMD_SGE_WR_N``
112 * **Added support for virtio on IBM POWER8.**
114 The ioports are mapped in memory when using Linux UIO.
116 * **Added support for Virtio in containers.**
118 Add a new virtual device, named virtio_user, to support virtio for containers.
122 * Control queue and multi-queue are not supported yet.
123 * Doesn't work with ``--huge-unlink``.
124 * Doesn't work with ``--no-huge``.
125 * Doesn't work when there are more than ``VHOST_MEMORY_MAX_NREGIONS(8)`` hugepages.
126 * Root privilege is required for sorting hugepages by physical address.
127 * Can only be used with the vhost user backend.
129 * **Added vhost-user client mode.**
131 DPDK vhost-user now supports client mode as well as server mode. Client mode
132 is enabled when the ``RTE_VHOST_USER_CLIENT`` flag is set while calling
133 ``rte_vhost_driver_register``.
135 When DPDK vhost-user restarts from an normal or abnormal exit (such as a
136 crash), the client mode allows DPDK to establish the connection again. Note
137 that QEMU version v2.7 or above is required for this feature.
139 DPDK vhost-user will also try to reconnect by default when:
141 * The first connect fails (when QEMU is not started yet).
142 * The connection is broken (when QEMU restarts).
144 It can be turned off by setting the ``RTE_VHOST_USER_NO_RECONNECT`` flag.
146 * **Added NSH packet recognition in i40e.**
148 * **Added AES-CTR support to AESNI MB PMD.**
150 Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
153 * **Added support for AES counter mode with Intel QuickAssist devices.**
155 Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
156 Provided support for algorithm-chaining operations.
158 * **Added KASUMI SW PMD.**
160 A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
161 and KASUMI F9 (UIA1) hashing.
163 * **Added multi-writer support for RTE Hash with Intel TSX.**
165 The following features/modifications have been added to rte_hash library:
167 * Enabled application developers to use an extra flag for ``rte_hash``
168 creation to specify default behavior (multi-thread safe/unsafe) with the
169 ``rte_hash_add_key`` function.
170 * Changed the Cuckoo Hash Search algorithm to breadth first search for
171 multi-writer routines and split Cuckoo Hash Search and Move operations in
172 order to reduce transactional code region and improve TSX performance.
173 * Added a hash multi-writer test case to the test app.
175 * **Improved IP Pipeline Application.**
177 The following features have been added to the ip_pipeline application:
179 * Configure the MAC address in the routing pipeline and automatic route
180 updates with change in link state.
181 * Enable RSS per network interface through the configuration file.
182 * Streamline the CLI code.
184 * **Added keepalive enhancements.**
186 Added support for reporting of core states other than dead to
187 monitoring applications, enabling the support of broader liveness
188 reporting to external processes.
190 * **Added packet capture framework.**
192 * A new library ``librte_pdump`` is added to provide a packet capture API.
193 * A new ``app/pdump`` tool is added to demonstrate capture packets in DPDK.
196 * **Added floating VEB support for i40e PF driver.**
198 A "floating VEB" is a special Virtual Ethernet Bridge (VEB) which does not
199 have an upload port, but instead is used for switching traffic between
200 virtual functions (VFs) on a port.
202 For information on this feature, please see the "I40E Poll Mode Driver"
203 section of the "Network Interface Controller Drivers" document.
205 * **Added support for live migration of a VM with SRIOV VF.**
207 Live migration of a VM with Virtio and VF PMD's using the bonding PMD.
213 .. This section should contain bug fixes added to the relevant sections. Sample format:
215 * **code/section Fixed issue in the past tense with a full stop.**
217 Add a short 1-2 sentence description of the resolved issue in the past tense.
218 The title should contain the code/lib section like a commit message.
219 Add the entries in alphabetic order in the relevant sections below.
225 * **igb_uio: Fixed possible mmap failure for Linux >= 4.5.**
227 The mmaping of the iomem range of the PCI device fails for kernels that
228 enabled the ``CONFIG_IO_STRICT_DEVMEM`` option. The error seen by the
229 user is as similar to the following::
231 EAL: pci_map_resource():
233 cannot mmap(39, 0x7f1c51800000, 0x100000, 0x0):
234 Invalid argument (0xffffffffffffffff)
236 The ``CONFIG_IO_STRICT_DEVMEM`` kernel option was introduced in Linux v4.5.
238 The issues was resolve by updating ``igb_uio`` to stop reserving PCI memory
239 resources. From the kernel point of view the iomem region looks like idle
240 and mmap works again. This matches the ``uio_pci_generic`` usage.
246 * **i40e: Fixed vlan stripping from inner header.**
248 Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
249 tags of the inner header will be stripped without putting vlan
251 Now this issue is fixed by disabling vlan stripping from inner header.
253 * **i40e: Fixed the type issue of a single VLAN type.**
255 Currently, if a single VLAN header is added in a packet, it's treated
256 as inner VLAN. But generally, a single VLAN header is treated as the
258 This issue is fixed by changing corresponding register for single VLAN.
260 * **enic: Fixed several issues when stopping then restarting ports and queues.**
262 Fixed several crashes related to stopping then restarting ports and queues.
263 Fixed possible crash when re-configuring the number of Rx queue descriptors.
265 * **enic: Fixed Rx data mis-alignment if mbuf data offset modified.**
267 Fixed possible Rx corruption when mbufs were returned to a pool with data
268 offset other than RTE_PKTMBUF_HEADROOM.
270 * **enic: Fixed Tx IP/UDP/TCP checksum offload and VLAN insertion.**
272 * **enic: Fixed Rx error and missed counters.**
278 * **mbuf: Fixed refcnt update when detaching.**
280 Fix the ``rte_pktmbuf_detach()`` function to decrement the direct mbuf's
281 reference counter. The previous behavior was not to affect the reference
282 counter. This lead to a memory leak of the direct mbuf.
296 .. This section should contain new known issues in this release. Sample format:
298 * **Add title in present tense with full stop.**
300 Add a short 1-2 sentence description of the known issue in the present
301 tense. Add information on any known workarounds.
307 .. This section should contain API changes. Sample format:
309 * Add a short 1-2 sentence description of the API change. Use fixed width
310 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
312 * The following counters are removed from the ``rte_eth_stats`` structure:
324 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
325 after a lookup by name ``rte_eth_xstats_get_names``.
327 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
328 and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
330 * The vhost function ``rte_vring_available_entries`` is renamed to
331 ``rte_vhost_avail_entries``.
333 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
334 as the parameter have been changed due to the ABI refactoring described
335 below. It is replaced by ``int vid``.
337 * The function ``rte_vhost_enqueue_burst`` no longer supports concurrent enqueuing
338 packets to the same queue.
340 * The function ``rte_eth_dev_set_mtu`` adds a new return value ``-EBUSY``, which
341 indicates the operation is forbidden because the port is running.
343 * The script ``dpdk_nic_bind.py`` is renamed to ``dpdk-devbind.py``.
344 And the script ``setup.sh`` is renamed to ``dpdk-setup.sh``.
350 .. * Add a short 1-2 sentence description of the ABI change that was announced in
351 the previous releases and made in this release. Use fixed width quotes for
352 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
354 * The ``rte_port_source_params`` structure has new fields to support PCAP files.
355 It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
357 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
358 to support the number of queues configured by software.
360 * A Vhost ABI refactoring has been made: the ``virtio_net`` structure is no
361 longer exported directly to the application. Instead, a handle, ``vid``, has
362 been used to represent this structure internally.
365 Shared Library Versions
366 -----------------------
368 .. Update any library version updated in this release and prepend with a ``+`` sign.
370 The libraries prepended with a plus sign were incremented in this version.
378 librte_cryptodev.so.1
379 librte_distributor.so.1
389 + librte_mempool.so.2
408 .. This section should contain a list of platforms that were tested with this
422 .. This section should contain a list of NICs that were tested with this release.