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 * **Added vhost-user client mode.**
56 DPDK vhost-user could be the server as well as the client. It supports
57 server mode only before, now it also supports client mode. Client mode
58 is enabled when ``RTE_VHOST_USER_CLIENT`` flag is set while calling
59 ``rte_vhost_driver_register``.
61 When DPDK vhost-user restarts from normal or abnormal quit (say crash),
62 the client mode would allow DPDK to establish the connect again. Note
63 that a brand new QEMU version (v2.7 or above) is needed, otherwise, the
66 * **Added AES-CTR support to AESNI MB PMD.**
68 Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
71 * **Added support of AES counter mode for Intel QuickAssist devices.**
73 Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
74 Provided support for algorithm-chaining operations.
76 * **Added KASUMI SW PMD.**
78 A new Crypto PMD has been added, which provides KASUMI F8 (UEA1) ciphering
79 and KASUMI F9 (UIA1) hashing.
81 * **Improved IP Pipeline Application.**
83 The following features have been added to ip_pipeline application:
85 * Configure the MAC address in the routing pipeline and automatic routes
86 updates with change in link state.
87 * Enable RSS per network interface through the configuration file.
88 * Streamline the CLI code.
90 * **Added keepalive enhancements.**
92 Adds support for reporting of core states other than dead to
93 monitoring applications, enabling the support of broader liveness
94 reporting to external processes.
96 * **Added packet capture framework.**
98 * A new library ``librte_pdump`` is added to provide packet capture API.
99 * A new ``app/pdump`` tool is added to capture packets in DPDK.
105 .. This section should contain bug fixes added to the relevant sections. Sample format:
107 * **code/section Fixed issue in the past tense with a full stop.**
109 Add a short 1-2 sentence description of the resolved issue in the past tense.
110 The title should contain the code/lib section like a commit message.
111 Add the entries in alphabetic order in the relevant sections below.
121 * **i40e: Fixed vlan stripping from inner header.**
123 Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
124 tags of the inner header will be stripped without putting vlan
126 Now this issue is fixed by disabling vlan stripping from inner header.
132 * **mbuf: Fixed refcnt update when detaching.**
134 Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
135 mbuf's reference counter. The previous behavior was not to affect
136 the reference counter. It lead a memory leak of the direct mbuf.
150 .. This section should contain new known issues in this release. Sample format:
152 * **Add title in present tense with full stop.**
154 Add a short 1-2 sentence description of the known issue in the present
155 tense. Add information on any known workarounds.
161 .. This section should contain API changes. Sample format:
163 * Add a short 1-2 sentence description of the API change. Use fixed width
164 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
166 * The following counters are removed from ``rte_eth_stats`` structure:
167 ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
168 tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
170 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
171 after a lookup by name ``rte_eth_xstats_get_names``.
173 * The function ``rte_eth_dev_info_get`` fill the new fields ``nb_rx_queues``
174 and ``nb_tx_queues`` in the structure ``rte_eth_dev_info``.
176 * The vhost function ``rte_vring_available_entries`` is renamed to
177 ``rte_vhost_avail_entries``.
179 * All existing vhost APIs and callbacks with ``virtio_net`` struct pointer
180 as the parameter have been changed due to the ABI refactoring mentioned
181 below: it's replaced by ``int vid``.
187 .. * Add a short 1-2 sentence description of the ABI change that was announced in
188 the previous releases and made in this release. Use fixed width quotes for
189 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
191 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
192 It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
194 * The ``rte_eth_dev_info`` structure has new fields ``nb_rx_queues`` and ``nb_tx_queues``
195 to support number of queues configured by software.
197 * vhost ABI refactoring has been made: ``virtio_net`` structure is never
198 exported to application any more. Instead, a handle, ``vid``, has been
199 used to represent this structure internally.
202 Shared Library Versions
203 -----------------------
205 .. Update any library version updated in this release and prepend with a ``+`` sign.
207 The libraries prepended with a plus sign were incremented in this version.
215 librte_distributor.so.1
225 + librte_mempool.so.2
243 .. This section should contain a list of platforms that were tested with this
257 .. This section should contain a list of NICs that were tested with this release.