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