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 * **Supported virtio on IBM POWER8.**
52 The ioports are mapped in memory when using Linux UIO.
54 * **Virtio support for containers.**
56 Add a new virtual device, named virtio-user, to support virtio for containers.
60 * Control queue and multi-queue are not supported yet.
61 * Cannot work with --huge-unlink.
62 * Cannot work with --no-huge.
63 * Cannot work when there are more than VHOST_MEMORY_MAX_NREGIONS(8) hugepages.
64 * Root privilege is a must for sorting hugepages by physical address.
65 * Can only be used with vhost user backend.
67 * **Added vhost-user client mode.**
69 DPDK vhost-user could be the server as well as the client. It supports
70 server mode only before, now it also supports client mode. Client mode
71 is enabled when ``RTE_VHOST_USER_CLIENT`` flag is set while calling
72 ``rte_vhost_driver_register``.
74 When DPDK vhost-user restarts from normal or abnormal quit (say crash),
75 the client mode would allow DPDK to establish the connect again. Note
76 that a brand new QEMU version (v2.7 or above) is needed, otherwise, the
79 DPDK vhost-user will also try to reconnect by default when
81 * the first connect fails (when QEMU is not started yet)
82 * the connection is broken (when QEMU restarts)
84 It can be turned off if flag ``RTE_VHOST_USER_NO_RECONNECT`` is set.
86 * **Added NSH packet recognition in i40e.**
88 * **Added AES-CTR support to AESNI MB PMD.**
90 Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
93 * **Added support of AES counter mode for Intel QuickAssist devices.**
95 Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
96 Provided support for algorithm-chaining operations.
98 * **Added KASUMI SW PMD.**
100 A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
101 and KASUMI F9 (UIA1) hashing.
103 * **Added multi-writer support for RTE Hash with Intel TSX.**
105 The following features/modifications have been added to rte_hash library:
107 * Enabled application developers to use an extra flag for rte_hash creation
108 to specify default behavior (multi-thread safe/unsafe) with rte_hash_add_key
110 * Changed Cuckoo search algorithm to breadth first search for multi-writer
111 routine and split Cuckoo Search and Move operations in order to reduce
112 transactional code region and improve TSX performance.
113 * Added a hash multi-writer test case for test app.
115 * **Improved IP Pipeline Application.**
117 The following features have been added to ip_pipeline application:
119 * Configure the MAC address in the routing pipeline and automatic routes
120 updates with change in link state.
121 * Enable RSS per network interface through the configuration file.
122 * Streamline the CLI code.
124 * **Added keepalive enhancements.**
126 Adds support for reporting of core states other than dead to
127 monitoring applications, enabling the support of broader liveness
128 reporting to external processes.
130 * **Added packet capture framework.**
132 * A new library ``librte_pdump`` is added to provide packet capture API.
133 * A new ``app/pdump`` tool is added to capture packets in DPDK.
139 .. This section should contain bug fixes added to the relevant sections. Sample format:
141 * **code/section Fixed issue in the past tense with a full stop.**
143 Add a short 1-2 sentence description of the resolved issue in the past tense.
144 The title should contain the code/lib section like a commit message.
145 Add the entries in alphabetic order in the relevant sections below.
155 * **i40e: Fixed vlan stripping from inner header.**
157 Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
158 tags of the inner header will be stripped without putting vlan
160 Now this issue is fixed by disabling vlan stripping from inner header.
166 * **mbuf: Fixed refcnt update when detaching.**
168 Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
169 mbuf's reference counter. The previous behavior was not to affect
170 the reference counter. It lead a memory leak of the direct mbuf.
184 .. This section should contain new known issues in this release. Sample format:
186 * **Add title in present tense with full stop.**
188 Add a short 1-2 sentence description of the known issue in the present
189 tense. Add information on any known workarounds.
195 .. This section should contain API changes. Sample format:
197 * Add a short 1-2 sentence description of the API change. Use fixed width
198 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
200 * The following counters are removed from ``rte_eth_stats`` structure:
201 ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
202 tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
204 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
205 after a lookup by name ``rte_eth_xstats_get_names``.
207 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
208 and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
210 * The vhost function ``rte_vring_available_entries`` is renamed to
211 ``rte_vhost_avail_entries``.
213 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
214 as the parameter have been changed due to the ABI refactoring mentioned
215 below: it's replaced by ``int vid``.
217 * The function ``rte_vhost_enqueue_burst`` no longer supports concurrent enqueuing
218 packets to the same queue.
224 .. * Add a short 1-2 sentence description of the ABI change that was announced in
225 the previous releases and made in this release. Use fixed width quotes for
226 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
228 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
229 It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
231 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
232 to support number of queues configured by software.
234 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
235 exported to application any more. Instead, a handle, ``vid``, has been
236 used to represent this structure internally.
239 Shared Library Versions
240 -----------------------
242 .. Update any library version updated in this release and prepend with a ``+`` sign.
244 The libraries prepended with a plus sign were incremented in this version.
252 librte_distributor.so.1
262 + librte_mempool.so.2
280 .. This section should contain a list of platforms that were tested with this
294 .. This section should contain a list of NICs that were tested with this release.