docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / aboutvpp / releasenotes / v16.09.rst
1 Release notes for VPP 16.09
2 ===========================
3
4 Features
5 --------
6
7 -  `Integrated July 2016 DPDK release <http://www.dpdk.org/doc/guides/rel_notes/release_16_07.html>`__
8
9    -  DPDK-vhost is depreciated pending a complete rework of the
10       original integration and addressing of rx performance deltas.
11    -  Patches required for DPDK 16.07:
12
13       -  Correctly setting the Packet Type in the IGB, IXGBE and i40e
14          drivers.
15       -  Correctly setting checksum in the i40e driver.
16       -  NXP DPAA2 PMD Driver.
17       -  rte_delay (yield) functionality.
18
19 -  Add “in tree” plugins:
20
21    -  IPv6 ILA.
22    -  iOAM.
23    -  Load Balancer.
24    -  SNAT.
25
26 -  High-performance (line-rate) “neutron like” L4 port-filtering.
27
28 -  API refactoring - addressing some of the issues around JVPP bindings.
29
30    -  Accommodating plugins
31       `(e.g. NSH_SFC) <https://wiki.fd.io/view/NSH_SFC>`__
32    -  Binding for `python <https://wiki.fd.io/view/VPP/Python_API>`__
33
34 -  LISP
35
36    -  L2 LISP overlays
37    -  Multitenancy
38    -  Multihoming
39    -  RTR mode
40    -  Map-resolver failover algorithm
41
42 -  Support 64-bit vector lengths, huge shared-memory segments.
43
44 -  Dynamic IP Feature ordering
45
46    -  IP Features can now specify features they appear before and after
47
48 -  16.09 Builds
49
50    -  Ubuntu 14.04 LTS - Trusty Tahr
51    -  Ubuntu 16.04 LTS - Xenial Xerus
52    -  CentOS 7
53    -  More information on `VPP wiki <https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages>`__
54
55 -  Performance, characterize and document performance for this release
56    `(more information on CSIT page) <https://wiki.fd.io/view/CSIT>`__
57
58    -  IPv4 and IPv6 Scale - performance tests.
59
60       -  Bidirectional 10k/100k/1M flows.
61       -  64B,570B, 1518B,9000B packet sizes.
62
63    -  IPv6 iACL - performance
64
65       -  DUT1 and DUT2 are configured with IPv6 routing, two static IPv6
66          /64 routes and IPv6 iAcl security whitelist ingress /64 filter
67          entries applied on links.
68       -  TG traffic profile contains two L3 flow-groups (flow-group per
69          direction, 253 flows per flow-group) with all packets
70          containing Ethernet header, IPv6 header and generated payload.
71          MAC addresses are matching MAC addresses of the TG node
72          interfaces.
73
74    -  L2XC VXLANoIPv4 - performance
75
76       -  DUT1 and DUT2 are configured with L2 cross-connect. VXLAN
77          tunnels are configured between L2XCs on DUT1 and DUT2.
78       -  TG traffic profile contains two L3 flow-groups (flow-group per
79          direction, 253 flows per flow-group) with all packets
80          containing Ethernet header, IPv4 header with IP protocol=61 and
81          generated payload. MAC addresses are matching MAC addresses of
82          the TG node interfaces.
83
84 -  Documentation
85
86    -  Autogenerated CLI documentation.
87    -  Using doxygen to automate API/Node documentation.
88    -  `(available online) <https://docs.fd.io/vpp/16.09/>`__
89
90 -  Resolved all static analysis issues found by Coverity
91
92    -  Beginning of 16.09 cycle: 505 issues.
93    -  Release: 0 outstanding issues.
94
95 Known issues
96 ------------
97
98 Issues in fd.io are tracked in `JIRA <https://jira.fd.io>`__.
99
100 +-----------------------------------+-----------------------------------+
101 | Issue                             | Description                       |
102 +===================================+===================================+
103 | VPP-391                           | vpp debug version assert appeared |
104 |                                   | in the process of start           |
105 +-----------------------------------+-----------------------------------+
106 | VPP-380                           | Mapping algorithm compute wrong   |
107 |                                   | ea-bits when IPv4 prefix          |
108 |                                   | 0.0.0.0/0                         |
109 +-----------------------------------+-----------------------------------+
110 | VPP-371                           | load_one_plugin:63: Loaded        |
111 |                                   | plugin: message from vppctl       |
112 +-----------------------------------+-----------------------------------+
113 | VPP-367                           | vpp packages need to depend on    |
114 |                                   | specific versions of each other   |
115 +-----------------------------------+-----------------------------------+
116 | VPP-312                           | IP6 FIB gets in indeterminate     |
117 |                                   | state by duplicating commands     |
118 +-----------------------------------+-----------------------------------+
119 | VPP-224                           | Lookup-in-vrf can not be set      |
120 |                                   | correctly                         |
121 +-----------------------------------+-----------------------------------+
122 | VPP-206                           | Fix classify table delete         |
123 +-----------------------------------+-----------------------------------+
124 | VPP-203                           | Fix binary API for reading vpp    |
125 |                                   | node graph                        |
126 +-----------------------------------+-----------------------------------+
127 | VPP-147                           | Inconsistent behaviour when       |
128 |                                   | adding L2 FIB filter entry        |
129 +-----------------------------------+-----------------------------------+
130 | VPP-99                            | VPP doesn’t discard DHCPOFFER     |
131 |                                   | message with wrong XID            |
132 +-----------------------------------+-----------------------------------+
133
134 Issues fixed
135 ------------
136
137 Issues in fd.io are tracked in `JIRA <https://jira.fd.io>`__.
138
139 +-----------------------------------+-----------------------------------+
140 | Issue                             | Description                       |
141 +===================================+===================================+
142 | VPP-396                           | Ubuntu systems Graphviz bug       |
143 +-----------------------------------+-----------------------------------+
144 | VPP-390                           | vpp-lib rpm fails to include      |
145 |                                   | \*.so symlinks, causing linking   |
146 |                                   | problems with out of tree builds  |
147 +-----------------------------------+-----------------------------------+
148 | VPP-388                           | IPSec output feature assumes      |
149 |                                   | packets have been ethernet        |
150 |                                   | rewritten                         |
151 +-----------------------------------+-----------------------------------+
152 | VPP-385                           | ARP for indirect adjacencies not  |
153 |                                   | working correctly                 |
154 +-----------------------------------+-----------------------------------+
155 | VPP-361                           | Memory leak on delete of VXLAN    |
156 |                                   | over IPv6 tunnel                  |
157 +-----------------------------------+-----------------------------------+
158 | VPP-357                           | VNI not set correctly when        |
159 |                                   | removing LISP fwd entries         |
160 +-----------------------------------+-----------------------------------+
161 | VPP-349                           | sw_interface_vhost_user_dump not  |
162 |                                   | working                           |
163 +-----------------------------------+-----------------------------------+
164 | VPP-345                           | net/enic: bad L4 checksum ptype   |
165 |                                   | set on ICMP packets               |
166 +-----------------------------------+-----------------------------------+
167 | VPP-340                           | MAP-T wrong destination address   |
168 +-----------------------------------+-----------------------------------+
169 | VPP-330                           | Use fifo to store LISP pending    |
170 |                                   | map-requests                      |
171 +-----------------------------------+-----------------------------------+
172 | VPP-326                           | map_add_domain VAT command:       |
173 |                                   | unable to configure domain with   |
174 |                                   | mtu parameter                     |
175 +-----------------------------------+-----------------------------------+
176 | VPP-318                           | The map_add_domain VAT command    |
177 |                                   | accepts invalid arguments         |
178 +-----------------------------------+-----------------------------------+
179 | VPP-315                           | Fix “show vxlan-gpe” issue        |
180 +-----------------------------------+-----------------------------------+
181 | VPP-310                           | Mapping algorithm compute wrong   |
182 |                                   | ea-bits                           |
183 +-----------------------------------+-----------------------------------+
184 | VPP-239                           | LISP IP forwarding does not tag   |
185 |                                   | packets that hit negative mapping |
186 |                                   | entries                           |
187 +-----------------------------------+-----------------------------------+
188 | VPP-235                           | Invalid help in VAT for           |
189 |                                   | sw_interface_set_l2_bridge        |
190 +-----------------------------------+-----------------------------------+
191 | VPP-228                           | Mapping algorithm sends packet to |
192 |                                   | wrong IPv6 address                |
193 +-----------------------------------+-----------------------------------+
194 | VPP-214                           | vpp-api-test:                     |
195 |                                   | api_ipsec_sad_add_del_entry:      |
196 |                                   | vector “ck” not initialized       |
197 +-----------------------------------+-----------------------------------+
198 | VPP-200                           | VPP - TAP port create problem     |
199 +-----------------------------------+-----------------------------------+
200 | VPP-189                           | Coverity Issues for 16.09         |
201 +-----------------------------------+-----------------------------------+
202 | VPP-184                           | u16 translating to char ,not      |
203 |                                   | short                             |
204 +-----------------------------------+-----------------------------------+
205 | VPP-179                           | Adjacency share-count botch       |
206 +-----------------------------------+-----------------------------------+
207 | VPP-163                           | “show ip6 interface” ignores      |
208 |                                   | non-global addresses              |
209 +-----------------------------------+-----------------------------------+
210 | VPP-155                           | Netmap: Inconsistency in          |
211 |                                   | interface state between “show     |
212 |                                   | hardware” and “show interface”    |
213 +-----------------------------------+-----------------------------------+
214 | VPP-145                           | Dynamically compute IP feature    |
215 |                                   | ordering based on constraints     |
216 +-----------------------------------+-----------------------------------+
217 | VPP-137                           | VPP sends ARP with wrong          |
218 |                                   | requested IP                      |
219 +-----------------------------------+-----------------------------------+
220 | VPP-118                           | JVpp: 0 length arrays not handled |
221 |                                   | properly in VPP responses         |
222 +-----------------------------------+-----------------------------------+
223 | VPP-112                           | linux kernel info missing from    |
224 |                                   | build log                         |
225 +-----------------------------------+-----------------------------------+
226 | VPP-110                           | vxlan encap node should never     |
227 |                                   | touch a deleted tunnel            |
228 +-----------------------------------+-----------------------------------+
229 | VPP-107                           | RPM build broken in master        |
230 +-----------------------------------+-----------------------------------+
231 | VPP-92                            | segment routing is not properly   |
232 |                                   | filling out the segment list      |
233 +-----------------------------------+-----------------------------------+
234 | VPP-91                            | segment routing add/del tunnel    |
235 |                                   | lookup doesn’t work               |
236 +-----------------------------------+-----------------------------------+
237 | VPP-84                            | af_packet throws a fatal error on |
238 |                                   | EAGAIN                            |
239 +-----------------------------------+-----------------------------------+
240 | VPP-74                            | Clang compile fails due to        |
241 |                                   | warning in vlib/unix/cli.c        |
242 +-----------------------------------+-----------------------------------+
243 | VPP-64                            | Top level “make pkg-deb” fails if |
244 |                                   | CDPATH is set in user env.        |
245 +-----------------------------------+-----------------------------------+
246 | VPP-48                            | Traceroute does not terminate     |
247 |                                   | when VPP is the target            |
248 +-----------------------------------+-----------------------------------+
249 | VPP-23                            | CLI pager does not gracefully     |
250 |                                   | handle lines longer than the      |
251 |                                   | terminal width                    |
252 +-----------------------------------+-----------------------------------+