ff8cc0d8f00096a710a2cfbdbca5149b2280185d
[dpdk.git] / doc / guides / rel_notes / release_16_07.rst
1 DPDK Release 16.07
2 ==================
3
4 .. **Read this first.**
5
6    The text below explains how to update the release notes.
7
8    Use proper spelling, capitalization and punctuation in all sections.
9
10    Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
11
12    Build the docs and view the output file to ensure the changes are correct::
13
14       make doc-guides-html
15
16       firefox build/doc/html/guides/rel_notes/release_16_07.html
17
18
19 New Features
20 ------------
21
22 .. This section should contain new features added in this release. Sample format:
23
24    * **Add a title in the past tense with a full stop.**
25
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
28      the new feature.
29
30      If the feature adds a lot of sub-features you can use a bullet list like this.
31
32      * Added feature foo to do something.
33      * Enhanced feature bar to do something else.
34
35      Refer to the previous release notes for examples.
36
37 * **Removed mempool cache if not needed.**
38
39   The size of the mempool structure is reduced if the per-lcore cache is disabled.
40
41 * **Changed the memory allocation in mempool library.**
42
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.
49
50 * **Supported virtio on IBM POWER8.**
51
52   The ioports are mapped in memory when using Linux UIO.
53
54 * **Added AES-CTR support to AESNI MB PMD.**
55
56   Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
57   decryption.
58
59 * **Added support of AES counter mode for Intel QuickAssist devices.**
60
61   Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
62   Provided support for algorithm-chaining operations.
63
64 * **Improved IP Pipeline Application.**
65
66   The following features have been added to ip_pipeline application:
67
68   * Configure the MAC address in the routing pipeline and automatic routes
69     updates with change in link state.
70   * Enable RSS per network interface through the configuration file.
71   * Streamline the CLI code.
72
73 * **Added keepalive enhancements.**
74
75   Adds support for reporting of core states other than dead to
76   monitoring applications, enabling the support of broader liveness
77   reporting to external processes.
78
79
80 Resolved Issues
81 ---------------
82
83 .. This section should contain bug fixes added to the relevant sections. Sample format:
84
85    * **code/section Fixed issue in the past tense with a full stop.**
86
87      Add a short 1-2 sentence description of the resolved issue in the past tense.
88      The title should contain the code/lib section like a commit message.
89      Add the entries in alphabetic order in the relevant sections below.
90
91
92 EAL
93 ~~~
94
95
96 Drivers
97 ~~~~~~~
98
99 * **i40e: Fixed vlan stripping from inner header.**
100
101   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
102   tags of the inner header will be stripped without putting vlan
103   info to descriptor.
104   Now this issue is fixed by disabling vlan stripping from inner header.
105
106
107 Libraries
108 ~~~~~~~~~
109
110 * **mbuf: Fixed refcnt update when detaching.**
111
112   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
113   mbuf's reference counter. The previous behavior was not to affect
114   the reference counter. It lead a memory leak of the direct mbuf.
115
116
117 Examples
118 ~~~~~~~~
119
120
121 Other
122 ~~~~~
123
124
125 Known Issues
126 ------------
127
128 .. This section should contain new known issues in this release. Sample format:
129
130    * **Add title in present tense with full stop.**
131
132      Add a short 1-2 sentence description of the known issue in the present
133      tense. Add information on any known workarounds.
134
135
136 API Changes
137 -----------
138
139 .. This section should contain API changes. Sample format:
140
141    * Add a short 1-2 sentence description of the API change. Use fixed width
142      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
143
144 * The following counters are removed from ``rte_eth_stats`` structure:
145   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
146   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
147
148 * The extended statistics are fetched by ids with ``rte_eth_xstats_get``
149   after a lookup by name ``rte_eth_xstats_get_names``.
150
151
152 ABI Changes
153 -----------
154
155 .. * Add a short 1-2 sentence description of the ABI change that was announced in
156      the previous releases and made in this release. Use fixed width quotes for
157      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
158
159 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
160   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
161
162
163 Shared Library Versions
164 -----------------------
165
166 .. Update any library version updated in this release and prepend with a ``+`` sign.
167
168 The libraries prepended with a plus sign were incremented in this version.
169
170 .. code-block:: diff
171
172    + libethdev.so.4
173      librte_acl.so.2
174      librte_cfgfile.so.2
175      librte_cmdline.so.2
176      librte_distributor.so.1
177      librte_eal.so.2
178      librte_hash.so.2
179      librte_ip_frag.so.1
180      librte_ivshmem.so.1
181      librte_jobstats.so.1
182      librte_kni.so.2
183      librte_kvargs.so.1
184      librte_lpm.so.2
185      librte_mbuf.so.2
186    + librte_mempool.so.2
187      librte_meter.so.1
188      librte_pipeline.so.3
189      librte_pmd_bond.so.1
190      librte_pmd_ring.so.2
191    + librte_port.so.3
192      librte_power.so.1
193      librte_reorder.so.1
194      librte_ring.so.1
195      librte_sched.so.1
196      librte_table.so.2
197      librte_timer.so.1
198      librte_vhost.so.2
199
200
201 Tested Platforms
202 ----------------
203
204 .. This section should contain a list of platforms that were tested with this
205    release.
206
207    The format is:
208
209    #. Platform name.
210
211       - Platform details.
212       - Platform details.
213
214
215 Tested NICs
216 -----------
217
218 .. This section should contain a list of NICs that were tested with this release.
219
220    The format is:
221
222    #. NIC name.
223
224       - NIC details.
225       - NIC details.