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 * **Changed the memory allocation in mempool library.**
43 * Added ability to allocate a large mempool in virtually fragmented memory.
44 * Added new APIs to populate a mempool with memory.
45 * Added an API to free a mempool.
46 * Modified the API of rte_mempool_obj_iter() function.
47 * Dropped specific Xen Dom0 code.
48 * Dropped specific anonymous mempool code in testpmd.
50 * **Added new driver for Broadcom NetXtreme-C devices.**
52 Added the new bnxt driver for Broadcom NetXtreme-C devices. See the
53 "Network Interface Controller Drivers" document for more details on this
56 * **Added new driver for ThunderX nicvf device.**
58 * **Added mailbox interrupt support for ixgbe and igb VFs.**
60 When the physical NIC link comes down or up, the PF driver will send a
61 mailbox message to notify each VF. To handle this link up/down event,
62 add mailbox interrupts support to receive the message and allow the app to
63 register a callback for it.
65 * **Updated the i40e base driver.**
67 Updated the i40e base driver, which includes support for new devices IDs.
69 * **Supported virtio on IBM POWER8.**
71 The ioports are mapped in memory when using Linux UIO.
73 * **Virtio support for containers.**
75 Add a new virtual device, named virtio-user, to support virtio for containers.
79 * Control queue and multi-queue are not supported yet.
80 * Cannot work with --huge-unlink.
81 * Cannot work with --no-huge.
82 * Cannot work when there are more than VHOST_MEMORY_MAX_NREGIONS(8) hugepages.
83 * Root privilege is a must for sorting hugepages by physical address.
84 * Can only be used with vhost user backend.
86 * **Added vhost-user client mode.**
88 DPDK vhost-user could be the server as well as the client. It supports
89 server mode only before, now it also supports client mode. Client mode
90 is enabled when ``RTE_VHOST_USER_CLIENT`` flag is set while calling
91 ``rte_vhost_driver_register``.
93 When DPDK vhost-user restarts from normal or abnormal quit (say crash),
94 the client mode would allow DPDK to establish the connect again. Note
95 that a brand new QEMU version (v2.7 or above) is needed, otherwise, the
98 DPDK vhost-user will also try to reconnect by default when
100 * the first connect fails (when QEMU is not started yet)
101 * the connection is broken (when QEMU restarts)
103 It can be turned off if flag ``RTE_VHOST_USER_NO_RECONNECT`` is set.
105 * **Added NSH packet recognition in i40e.**
107 * **Added AES-CTR support to AESNI MB PMD.**
109 Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
112 * **Added support of AES counter mode for Intel QuickAssist devices.**
114 Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
115 Provided support for algorithm-chaining operations.
117 * **Added KASUMI SW PMD.**
119 A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
120 and KASUMI F9 (UIA1) hashing.
122 * **Added multi-writer support for RTE Hash with Intel TSX.**
124 The following features/modifications have been added to rte_hash library:
126 * Enabled application developers to use an extra flag for rte_hash creation
127 to specify default behavior (multi-thread safe/unsafe) with rte_hash_add_key
129 * Changed Cuckoo search algorithm to breadth first search for multi-writer
130 routine and split Cuckoo Search and Move operations in order to reduce
131 transactional code region and improve TSX performance.
132 * Added a hash multi-writer test case for test app.
134 * **Improved IP Pipeline Application.**
136 The following features have been added to ip_pipeline application:
138 * Configure the MAC address in the routing pipeline and automatic routes
139 updates with change in link state.
140 * Enable RSS per network interface through the configuration file.
141 * Streamline the CLI code.
143 * **Added keepalive enhancements.**
145 Adds support for reporting of core states other than dead to
146 monitoring applications, enabling the support of broader liveness
147 reporting to external processes.
149 * **Added packet capture framework.**
151 * A new library ``librte_pdump`` is added to provide packet capture API.
152 * A new ``app/pdump`` tool is added to capture packets in DPDK.
158 .. This section should contain bug fixes added to the relevant sections. Sample format:
160 * **code/section Fixed issue in the past tense with a full stop.**
162 Add a short 1-2 sentence description of the resolved issue in the past tense.
163 The title should contain the code/lib section like a commit message.
164 Add the entries in alphabetic order in the relevant sections below.
174 * **i40e: Fixed vlan stripping from inner header.**
176 Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
177 tags of the inner header will be stripped without putting vlan
179 Now this issue is fixed by disabling vlan stripping from inner header.
181 * **i40e: Fixed the type issue of a single VLAN type.**
183 Currently, if a single VLAN header is added in a packet, it's treated
184 as inner VLAN. But generally, a single VLAN header is treated as the
186 This issue is fixed by changing corresponding register for single VLAN.
192 * **mbuf: Fixed refcnt update when detaching.**
194 Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
195 mbuf's reference counter. The previous behavior was not to affect
196 the reference counter. It lead a memory leak of the direct mbuf.
210 .. This section should contain new known issues in this release. Sample format:
212 * **Add title in present tense with full stop.**
214 Add a short 1-2 sentence description of the known issue in the present
215 tense. Add information on any known workarounds.
221 .. This section should contain API changes. Sample format:
223 * Add a short 1-2 sentence description of the API change. Use fixed width
224 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
226 * The following counters are removed from ``rte_eth_stats`` structure:
227 ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
228 tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
230 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
231 after a lookup by name ``rte_eth_xstats_get_names``.
233 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
234 and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
236 * The vhost function ``rte_vring_available_entries`` is renamed to
237 ``rte_vhost_avail_entries``.
239 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
240 as the parameter have been changed due to the ABI refactoring mentioned
241 below: it's replaced by ``int vid``.
243 * The function ``rte_vhost_enqueue_burst`` no longer supports concurrent enqueuing
244 packets to the same queue.
246 * The function ``rte_eth_dev_set_mtu`` adds a new return value ``-EBUSY``, which
247 indicates the operation is forbidden because the port is running.
253 .. * Add a short 1-2 sentence description of the ABI change that was announced in
254 the previous releases and made in this release. Use fixed width quotes for
255 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
257 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
258 It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
260 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
261 to support number of queues configured by software.
263 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
264 exported to application any more. Instead, a handle, ``vid``, has been
265 used to represent this structure internally.
268 Shared Library Versions
269 -----------------------
271 .. Update any library version updated in this release and prepend with a ``+`` sign.
273 The libraries prepended with a plus sign were incremented in this version.
281 librte_distributor.so.1
291 + librte_mempool.so.2
309 .. This section should contain a list of platforms that were tested with this
323 .. This section should contain a list of NICs that were tested with this release.