307e7c49611729ec53ead9e0516d7f89a820b7dd
[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 * **Added AES-CTR support to AESNI MB PMD.**
51
52   Now AESNI MB PMD supports 128/192/256-bit counter mode AES encryption and
53   decryption.
54
55 * **Added support of AES counter mode for Intel QuickAssist devices.**
56
57   Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
58   Provided support for algorithm-chaining operations.
59
60
61 Resolved Issues
62 ---------------
63
64 .. This section should contain bug fixes added to the relevant sections. Sample format:
65
66    * **code/section Fixed issue in the past tense with a full stop.**
67
68      Add a short 1-2 sentence description of the resolved issue in the past tense.
69      The title should contain the code/lib section like a commit message.
70      Add the entries in alphabetic order in the relevant sections below.
71
72
73 EAL
74 ~~~
75
76
77 Drivers
78 ~~~~~~~
79
80 * **i40e: Fixed vlan stripping from inner header.**
81
82   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
83   tags of the inner header will be stripped without putting vlan
84   info to descriptor.
85   Now this issue is fixed by disabling vlan stripping from inner header.
86
87
88 Libraries
89 ~~~~~~~~~
90
91 * **mbuf: Fixed refcnt update when detaching.**
92
93   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
94   mbuf's reference counter. The previous behavior was not to affect
95   the reference counter. It lead a memory leak of the direct mbuf.
96
97
98 Examples
99 ~~~~~~~~
100
101
102 Other
103 ~~~~~
104
105
106 Known Issues
107 ------------
108
109 .. This section should contain new known issues in this release. Sample format:
110
111    * **Add title in present tense with full stop.**
112
113      Add a short 1-2 sentence description of the known issue in the present
114      tense. Add information on any known workarounds.
115
116
117 API Changes
118 -----------
119
120 .. This section should contain API changes. Sample format:
121
122    * Add a short 1-2 sentence description of the API change. Use fixed width
123      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
124
125 * The following counters are removed from ``rte_eth_stats`` structure:
126   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
127   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
128
129
130 ABI Changes
131 -----------
132
133 .. * Add a short 1-2 sentence description of the ABI change that was announced in
134      the previous releases and made in this release. Use fixed width quotes for
135      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
136
137 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
138   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
139
140
141 Shared Library Versions
142 -----------------------
143
144 .. Update any library version updated in this release and prepend with a ``+`` sign.
145
146 The libraries prepended with a plus sign were incremented in this version.
147
148 .. code-block:: diff
149
150    + libethdev.so.4
151      librte_acl.so.2
152      librte_cfgfile.so.2
153      librte_cmdline.so.2
154      librte_distributor.so.1
155      librte_eal.so.2
156      librte_hash.so.2
157      librte_ip_frag.so.1
158      librte_ivshmem.so.1
159      librte_jobstats.so.1
160      librte_kni.so.2
161      librte_kvargs.so.1
162      librte_lpm.so.2
163      librte_mbuf.so.2
164    + librte_mempool.so.2
165      librte_meter.so.1
166      librte_pipeline.so.3
167      librte_pmd_bond.so.1
168      librte_pmd_ring.so.2
169    + librte_port.so.3
170      librte_power.so.1
171      librte_reorder.so.1
172      librte_ring.so.1
173      librte_sched.so.1
174      librte_table.so.2
175      librte_timer.so.1
176      librte_vhost.so.2
177
178
179 Tested Platforms
180 ----------------
181
182 .. This section should contain a list of platforms that were tested with this
183    release.
184
185    The format is:
186
187    #. Platform name.
188
189       - Platform details.
190       - Platform details.
191
192
193 Tested NICs
194 -----------
195
196 .. This section should contain a list of NICs that were tested with this release.
197
198    The format is:
199
200    #. NIC name.
201
202       - NIC details.
203       - NIC details.