4 .. **Read this first.**
6 The text in the sections 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:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_17_11.html
23 .. This section should contain new features added in this release. Sample
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense. The description
29 should be enough to allow someone scanning the release notes to
30 understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list like
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
40 This section is a comment. do not overwrite or remove it.
41 Also, make sure to start the actual text at the margin.
42 =========================================================
44 * **Extended port_id range from uint8_t to uint16_t.**
46 Increased port_id range from 8 bits to 16 bits in order to support more than
47 256 ports in dpdk. All ethdev APIs which have port_id as parameter are changed
50 * **nfp: Added PF support.**
52 Previously Netronome's NFP PMD had just support for VFs. PF support is
53 just as a basic DPDK port and has no VF management yet.
55 PF support comes with firmware upload support which allows the PMD to
56 independently work from kernel netdev NFP drivers.
58 NFP 4000 devices are also now supported along with previous 6000 devices.
60 * **Updated bnxt PMD.**
62 Major enhancements include:
64 * Support for Flow API
65 * Support for Tx and Rx descriptor status functions
67 * **Added IOMMU support to libvhost-user**
69 Implemented device IOTLB in Vhost-user backend, and enabled Virtio's IOMMU
72 * **Added Membership library (rte_member).**
74 Added membership library. It provides an API for DPDK applications to insert a
75 new member, delete an existing member, or query the existence of a member in a
76 given set, or a group of sets. For the case of a group of sets the library
77 will return not only whether the element has been inserted before in one of
78 the sets but also which set it belongs to.
80 The Membership Library is an extension and generalization of a traditional
81 filter (for example Bloom Filter) structure that has multiple usages in a wide
82 variety of workloads and applications. In general, the Membership Library is a
83 data structure that provides a “set-summary” and responds to set-membership
84 queries whether a certain member belongs to a set(s).
86 See the :ref:`Membership Library <Member_Library>` documentation in
87 the Programmers Guide document, for more information.
89 * **Added the Generic Segmentation Offload Library.**
91 Added the Generic Segmentation Offload (GSO) library to enable
92 applications to split large packets (e.g. MTU is 64KB) into small
93 ones (e.g. MTU is 1500B). Supported packet types are:
96 * VxLAN packets, which must have an outer IPv4 header, and contain
97 an inner TCP/IPv4 packet.
99 The GSO library doesn't check if the input packets have correct
100 checksums, and doesn't update checksums for output packets.
101 Additionally, the GSO library doesn't process IP fragmented packets.
107 .. This section should contain bug fixes added to the relevant
108 sections. Sample format:
110 * **code/section Fixed issue in the past tense with a full stop.**
112 Add a short 1-2 sentence description of the resolved issue in the past
115 The title should contain the code/lib section like a commit message.
117 Add the entries in alphabetic order in the relevant sections below.
119 This section is a comment. do not overwrite or remove it.
120 Also, make sure to start the actual text at the margin.
121 =========================================================
127 * **Service core fails to call service callback due to atomic lock**
129 In a specific configuration of multi-thread unsafe services and service
130 cores, a service core previously did not correctly release the atomic lock
131 on the service. This would result in the cores polling the service, but it
132 looked like another thread was executing the service callback. The logic for
133 atomic locking of the services has been fixed and refactored for readability.
154 .. This section should contain new known issues in this release. Sample format:
156 * **Add title in present tense with full stop.**
158 Add a short 1-2 sentence description of the known issue in the present
159 tense. Add information on any known workarounds.
161 This section is a comment. do not overwrite or remove it.
162 Also, make sure to start the actual text at the margin.
163 =========================================================
169 .. This section should contain API changes. Sample format:
171 * Add a short 1-2 sentence description of the API change. Use fixed width
172 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
175 This section is a comment. do not overwrite or remove it.
176 Also, make sure to start the actual text at the margin.
177 =========================================================
179 * **Service cores API updated for usability**
181 The service cores API has been changed, removing pointers from the API
182 where possible, instead using integer IDs to identify each service. This
183 simplifed application code, aids debugging, and provides better
184 encapsulation. A summary of the main changes made is as follows:
186 * Services identified by ID not by ``rte_service_spec`` pointer
187 * Reduced API surface by using ``set`` functions instead of enable/disable
188 * Reworked ``rte_service_register`` to provide the service ID to registrar
189 * Rework start and stop APIs into ``rte_service_runstate_set``
190 * Added API to set runstate of service implementation to indicate readyness
192 * **The following changes made in mempool library**
194 * Moved ``flags`` datatype from int to unsigned int for ``rte_mempool``.
195 * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
196 and ``rte_mempool_generic_get`` API.
197 * Added ``flags`` param in ``rte_mempool_xmem_size`` and
198 ``rte_mempool_xmem_usage``.
200 * Xen dom0 in EAL was removed, as well as xenvirt PMD and vhost_xen.
202 * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
203 remove this API as Xen dom0 support was removed.
209 .. This section should contain ABI changes. Sample format:
211 * Add a short 1-2 sentence description of the ABI change that was announced
212 in the previous releases and made in this release. Use fixed width quotes
213 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
215 This section is a comment. do not overwrite or remove it.
216 Also, make sure to start the actual text at the margin.
217 =========================================================
219 * **Extended port_id range.**
221 The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
222 changed, as described in the `New Features` section.
224 Shared Library Versions
225 -----------------------
227 .. Update any library version updated in this release and prepend with a ``+``
231 + librte_cfgfile.so.2
234 This section is a comment. do not overwrite or remove it.
235 =========================================================
238 The libraries prepended with a plus sign were incremented in this version.
243 librte_bitratestats.so.2
246 librte_cryptodev.so.3
247 librte_distributor.so.1
258 librte_latencystats.so.1
270 librte_pmd_ixgbe.so.2
272 librte_pmd_vhost.so.2
286 .. This section should contain a list of platforms that were tested with this
291 * <vendor> platform with <vendor> <type of devices> combinations
296 * Other relevant details...
298 This section is a comment. do not overwrite or remove it.
299 Also, make sure to start the actual text at the margin.
300 =========================================================