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