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