From 9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160 Mon Sep 17 00:00:00 2001 From: Nathan Skrzypczak Date: Thu, 19 Aug 2021 11:38:06 +0200 Subject: docs: better docs, mv doxygen to sphinx This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak Signed-off-by: Andrew Yourtchenko --- .gitignore | 5 +- MAINTAINERS | 5 - Makefile | 50 +- README.md | 45 +- RELEASE.md | 9671 -------------------- docs/Makefile | 88 +- docs/README | 2 +- docs/_images/htmlBuild.png | Bin 266686 -> 0 bytes docs/_images/libmemif_architecture.png | 1 + docs/_scripts/Makefile | 212 + docs/_scripts/filter_api.py | 49 + docs/_scripts/filter_c.py | 87 + docs/_scripts/filter_h.py | 56 + docs/_scripts/includes_renderer.py | 78 + docs/_scripts/prepare-for-site.sh | 18 + docs/_scripts/publish-docs.sh | 85 + docs/_scripts/siphon-generate | 79 + docs/_scripts/siphon-process | 90 + docs/_scripts/siphon/__init__.py | 24 + docs/_scripts/siphon/generate.py | 306 + docs/_scripts/siphon/generate_clicmd.py | 24 + docs/_scripts/siphon/generate_syscfg.py | 24 + docs/_scripts/siphon/parsers.py | 150 + docs/_scripts/siphon/process.py | 407 + docs/_scripts/siphon/process_clicmd.py | 73 + docs/_scripts/siphon/process_syscfg.py | 31 + .../markdown/clicmd/index_entry.md | 15 + .../markdown/clicmd/index_header.md | 23 + .../markdown/clicmd/index_section.md | 16 + .../markdown/clicmd/item_format.md | 62 + .../markdown/clicmd/item_header.md | 20 + .../markdown/default/index_entry.md | 16 + .../markdown/default/index_section.md | 18 + .../markdown/default/item_format.md | 16 + .../markdown/default/item_header.md | 18 + .../markdown/syscfg/index_header.md | 111 + .../markdown/syscfg/item_format.md | 42 + docs/about.rst | 9 - docs/aboutvpp/developer.rst | 29 + docs/aboutvpp/extensible.rst | 43 + docs/aboutvpp/hoststack.rst | 26 + docs/aboutvpp/networkstack.rst | 37 + docs/aboutvpp/performance.rst | 70 + docs/aboutvpp/releasenotes/index.rst | 11 + docs/aboutvpp/releasenotes/past.rst | 39 + docs/aboutvpp/releasenotes/v16.06.rst | 52 + docs/aboutvpp/releasenotes/v16.09.rst | 252 + docs/aboutvpp/releasenotes/v17.01.1.rst | 9 + docs/aboutvpp/releasenotes/v17.01.rst | 99 + docs/aboutvpp/releasenotes/v17.04.rst | 146 + docs/aboutvpp/releasenotes/v17.07.rst | 76 + docs/aboutvpp/releasenotes/v17.10.rst | 236 + docs/aboutvpp/releasenotes/v18.01.1.rst | 9 + docs/aboutvpp/releasenotes/v18.01.2.rst | 9 + docs/aboutvpp/releasenotes/v18.01.rst | 382 + docs/aboutvpp/releasenotes/v18.04.rst | 2523 +++++ docs/aboutvpp/releasenotes/v18.07.rst | 306 + docs/aboutvpp/releasenotes/v18.10.rst | 316 + docs/aboutvpp/releasenotes/v19.01.1.rst | 9 + docs/aboutvpp/releasenotes/v19.01.2.rst | 9 + docs/aboutvpp/releasenotes/v19.01.3.rst | 9 + docs/aboutvpp/releasenotes/v19.01.rst | 413 + docs/aboutvpp/releasenotes/v19.04.1.rst | 9 + docs/aboutvpp/releasenotes/v19.04.2.rst | 9 + docs/aboutvpp/releasenotes/v19.04.3.rst | 9 + docs/aboutvpp/releasenotes/v19.04.rst | 387 + docs/aboutvpp/releasenotes/v19.08.1.rst | 75 + docs/aboutvpp/releasenotes/v19.08.2.rst | 187 + docs/aboutvpp/releasenotes/v19.08.3.rst | 9 + docs/aboutvpp/releasenotes/v19.08.rst | 752 ++ docs/aboutvpp/releasenotes/v20.01.rst | 1384 +++ docs/aboutvpp/releasenotes/v20.05.1.rst | 9 + docs/aboutvpp/releasenotes/v20.05.rst | 848 ++ docs/aboutvpp/releasenotes/v20.09.rst | 714 ++ docs/aboutvpp/releasenotes/v21.01.rst | 764 ++ docs/aboutvpp/releasenotes/v21.06.rst | 1477 +++ docs/aboutvpp/releasenotes/v21.10.rst | 4 + .../scalar-vs-vector-packet-processing.rst | 69 + docs/aboutvpp/supported.rst | 28 + docs/cli-reference/gettingstarted/index.rst | 126 + docs/cli-reference/interface/basic.rst | 83 + docs/cli-reference/interface/create_interface.rst | 223 + docs/cli-reference/interface/hardware.rst | 161 + docs/cli-reference/interface/index.rst | 17 + docs/cli-reference/interface/setinterface.rst | 182 + docs/conf.py | 12 +- docs/configuration/config_getting_started.rst | 84 + docs/configuration/reference.rst | 1600 ++++ docs/contributing/gitreview.rst | 199 + docs/contributing/reportingissues/index.rst | 23 + .../reportingissues/reportingissues.rst | 266 + docs/contributing/writingdocs.rst | 52 + docs/developer/build-run-debug/building.rst | 181 + .../build-run-debug/cross_compile_macos.rst | 70 + docs/developer/build-run-debug/gdb_examples.rst | 141 + docs/developer/build-run-debug/index.rst | 14 + docs/developer/build-run-debug/running_vpp.rst | 48 + docs/developer/build-run-debug/testing_vpp.rst | 140 + docs/developer/corearchitecture/bihash.rst | 313 + .../developer/corearchitecture/buffer_metadata.rst | 237 + .../buildsystem/buildrootmakefile.rst | 353 + .../corearchitecture/buildsystem/cmakeandninja.rst | 186 + .../corearchitecture/buildsystem/index.rst | 14 + .../corearchitecture/buildsystem/mainmakefile.rst | 2 + docs/developer/corearchitecture/featurearcs.rst | 225 + docs/developer/corearchitecture/index.rst | 21 + docs/developer/corearchitecture/infrastructure.rst | 612 ++ docs/developer/corearchitecture/mem.rst | 1 + docs/developer/corearchitecture/multi_thread.rst | 169 + .../corearchitecture/multiarch/arbfns.rst | 87 + .../developer/corearchitecture/multiarch/index.rst | 12 + .../corearchitecture/multiarch/nodefns.rst | 138 + .../corearchitecture/softwarearchitecture.rst | 47 + docs/developer/corearchitecture/vlib.rst | 888 ++ docs/developer/corearchitecture/vnet.rst | 807 ++ docs/developer/corefeatures/bfd_doc.rst | 1 + docs/developer/corefeatures/eventviewer.rst | 286 + docs/developer/corefeatures/fib/attachedexport.rst | 50 + docs/developer/corefeatures/fib/barnacles.rst | 78 + docs/developer/corefeatures/fib/controlplane.rst | 23 + docs/developer/corefeatures/fib/dataplane.rst | 100 + docs/developer/corefeatures/fib/debugging.rst | 106 + .../developer/corefeatures/fib/fastconvergence.rst | 576 ++ docs/developer/corefeatures/fib/graphs.rst | 34 + docs/developer/corefeatures/fib/graphwalks.rst | 80 + docs/developer/corefeatures/fib/hacking.rst | 68 + docs/developer/corefeatures/fib/index.rst | 21 + docs/developer/corefeatures/fib/marknsweep.rst | 68 + docs/developer/corefeatures/fib/missing.rst | 110 + docs/developer/corefeatures/fib/mplsfib.rst | 220 + docs/developer/corefeatures/fib/multicast.rst | 106 + docs/developer/corefeatures/fib/neighbors.rst | 88 + docs/developer/corefeatures/fib/prefixes.rst | 17 + docs/developer/corefeatures/fib/prerequisites.rst | 12 + docs/developer/corefeatures/fib/routes.rst | 353 + docs/developer/corefeatures/fib/scale.rst | 247 + docs/developer/corefeatures/fib/thedatamodel.rst | 15 + docs/developer/corefeatures/fib/tunnels.rst | 62 + docs/developer/corefeatures/index.rst | 21 + docs/developer/corefeatures/ipfix_doc.rst | 1 + docs/developer/corefeatures/ipsec.rst | 1 + docs/developer/corefeatures/mtu.rst | 1 + docs/developer/corefeatures/punt.rst | 1 + docs/developer/corefeatures/selinux_doc.rst | 1 + docs/developer/corefeatures/span_doc.rst | 1 + docs/developer/corefeatures/sr/index.rst | 14 + docs/developer/corefeatures/sr/sr_doc.rst | 1 + docs/developer/corefeatures/sr/sr_localsid.rst | 1 + docs/developer/corefeatures/sr/sr_mpls.rst | 1 + docs/developer/corefeatures/sr/sr_policy.rst | 1 + docs/developer/corefeatures/sr/sr_steering.rst | 1 + docs/developer/corefeatures/stats.rst | 1 + docs/developer/corefeatures/sylog_doc.rst | 1 + docs/developer/devicedrivers/af_xdp.rst | 1 + docs/developer/devicedrivers/avf.rst | 1 + docs/developer/devicedrivers/index.rst | 15 + docs/developer/devicedrivers/rdma.rst | 1 + docs/developer/devicedrivers/vmxnet3.rst | 1 + docs/developer/extras/index.rst | 17 + docs/developer/extras/lcov.rst | 1 + docs/developer/extras/snap.rst | 1 + docs/developer/extras/strongswan.rst | 1 + docs/developer/extras/vcl_ldpreload.rst | 1 + docs/developer/extras/vpp_config.rst | 1 + docs/developer/extras/vpp_if_stats.rst | 1 + docs/developer/extras/vpp_stats_fs.rst | 1 + docs/developer/extras/vpptop.rst | 1 + docs/developer/plugindoc/add_plugin.rst | 362 + docs/developer/plugindoc/handoffdemo.rst | 1 + docs/developer/plugindoc/index.rst | 13 + docs/developer/plugindoc/sample_plugin_doc.rst | 1 + docs/developer/plugins/acl_hash_lookup.rst | 1 + docs/developer/plugins/acl_lookup_context.rst | 1 + docs/developer/plugins/acl_multicore.rst | 1 + docs/developer/plugins/bufmon_doc.rst | 1 + docs/developer/plugins/cnat.rst | 1 + docs/developer/plugins/dhcp6_pd.rst | 1 + docs/developer/plugins/flowprobe.rst | 1 + docs/developer/plugins/index.rst | 41 + docs/developer/plugins/ioam.rst | 1 + docs/developer/plugins/lacp.rst | 1 + docs/developer/plugins/lb.rst | 1 + docs/developer/plugins/lcp.rst | 1 + docs/developer/plugins/lldp.rst | 1 + docs/developer/plugins/map_lw4o6.rst | 1 + docs/developer/plugins/marvell.rst | 1 + docs/developer/plugins/mdata.rst | 1 + docs/developer/plugins/nat44_ei_ha.rst | 1 + docs/developer/plugins/nat64.rst | 1 + docs/developer/plugins/pnat.rst | 1 + docs/developer/plugins/quic.rst | 1 + docs/developer/plugins/srtp.rst | 1 + docs/developer/plugins/srv6/ad_flow_plugin_doc.rst | 1 + docs/developer/plugins/srv6/ad_plugin_doc.rst | 1 + docs/developer/plugins/srv6/am_plugin_doc.rst | 1 + docs/developer/plugins/srv6/as_plugin_doc.rst | 1 + docs/developer/plugins/srv6/index.rst | 16 + docs/developer/plugins/srv6/mobile_plugin_doc.rst | 1 + docs/developer/plugins/srv6/runner_doc.rst | 1 + .../plugins/srv6/srv6_sample_localsid_doc.rst | 1 + docs/developer/plugins/wireguard.rst | 1 + docs/developer/tests/overview.rst | 450 + docs/docsignore | 8 + docs/dynamic_includes/.gitkeep | 0 docs/gettingstarted/developers/VPPAPI.md | 1 - docs/gettingstarted/developers/add_plugin.rst | 362 - .../gettingstarted/developers/add_plugin_goapi.rst | 83 - docs/gettingstarted/developers/bihash.md | 308 - .../developers/binary_api_support.rst | 485 - docs/gettingstarted/developers/building.rst | 181 - .../developers/buildsystem/buildrootmakefile.rst | 353 - .../developers/buildsystem/cmakeandninja.rst | 186 - .../developers/buildsystem/index.rst | 14 - .../developers/buildsystem/mainmakefile.md | 3 - docs/gettingstarted/developers/buildwireshark.md | 72 - docs/gettingstarted/developers/cnat.rst | 1 - .../developers/cross_compile_macos.rst | 70 - docs/gettingstarted/developers/eventviewer.rst | 286 - docs/gettingstarted/developers/featurearcs.md | 224 - .../developers/fib20/attachedexport.rst | 50 - docs/gettingstarted/developers/fib20/barnacles.rst | 78 - .../developers/fib20/controlplane.rst | 23 - docs/gettingstarted/developers/fib20/dataplane.rst | 100 - docs/gettingstarted/developers/fib20/debugging.rst | 106 - .../developers/fib20/fastconvergence.rst | 576 -- docs/gettingstarted/developers/fib20/graphs.rst | 34 - .../gettingstarted/developers/fib20/graphwalks.rst | 80 - docs/gettingstarted/developers/fib20/hacking.rst | 68 - docs/gettingstarted/developers/fib20/index.rst | 18 - .../gettingstarted/developers/fib20/marknsweep.rst | 68 - docs/gettingstarted/developers/fib20/missing.rst | 110 - docs/gettingstarted/developers/fib20/mplsfib.rst | 220 - docs/gettingstarted/developers/fib20/multicast.rst | 106 - docs/gettingstarted/developers/fib20/neighbors.rst | 88 - docs/gettingstarted/developers/fib20/prefixes.rst | 17 - .../developers/fib20/prerequisites.rst | 12 - docs/gettingstarted/developers/fib20/routes.rst | 353 - docs/gettingstarted/developers/fib20/scale.rst | 247 - .../developers/fib20/thedatamodel.rst | 15 - docs/gettingstarted/developers/fib20/tunnels.rst | 62 - docs/gettingstarted/developers/gdb_examples.rst | 141 - docs/gettingstarted/developers/gitreview.rst | 199 - docs/gettingstarted/developers/index.rst | 48 - docs/gettingstarted/developers/infrastructure.md | 614 -- docs/gettingstarted/developers/ipsec.rst | 1 - docs/gettingstarted/developers/metadata.md | 190 - .../gettingstarted/developers/multiarch/arbfns.rst | 87 - docs/gettingstarted/developers/multiarch/index.rst | 12 - .../developers/multiarch/nodefns.rst | 138 - docs/gettingstarted/developers/plugins.rst | 13 - docs/gettingstarted/developers/punt.rst | 1 - docs/gettingstarted/developers/quic_plugin.rst | 1 - docs/gettingstarted/developers/running_vpp.rst | 48 - .../developers/softwarearchitecture.md | 44 - docs/gettingstarted/developers/testing_vpp.md | 141 - docs/gettingstarted/developers/vlib.md | 891 -- docs/gettingstarted/developers/vnet.md | 795 -- docs/gettingstarted/developers/vpp_api_module.rst | 122 - docs/gettingstarted/index.rst | 44 - docs/gettingstarted/installing/centos.rst | 176 - docs/gettingstarted/installing/index.rst | 8 - docs/gettingstarted/installing/packages.rst | 4 +- docs/gettingstarted/installing/ubuntu.rst | 2 +- docs/gettingstarted/progressivevpp/index.rst | 2 - docs/gettingstarted/progressivevpp/interface.rst | 4 +- docs/gettingstarted/progressivevpp/routing.rst | 8 +- docs/gettingstarted/progressivevpp/runningvpp.rst | 2 +- .../progressivevpp/settingupenvironment.rst | 15 +- docs/gettingstarted/progressivevpp/switching.rst | 16 +- docs/gettingstarted/progressivevpp/traces.rst | 30 +- .../progressivevpp/twovppinstances.rst | 4 +- docs/gettingstarted/running/index.rst | 121 + docs/gettingstarted/troubleshooting/cpuusage.rst | 112 + docs/gettingstarted/troubleshooting/index.rst | 14 + docs/gettingstarted/troubleshooting/mem.rst | 87 + docs/gettingstarted/troubleshooting/sanitizer.rst | 45 + .../gettingstarted/users/configuring/hugepages.rst | 63 - docs/gettingstarted/users/configuring/index.rst | 13 - docs/gettingstarted/users/configuring/startup.rst | 1683 ---- docs/gettingstarted/users/index.rst | 25 - docs/gettingstarted/users/running/index.rst | 59 - docs/gettingstarted/writingdocs/buildingrst.rst | 94 - docs/gettingstarted/writingdocs/index.rst | 20 - .../writingdocs/styleguide/index.rst | 31 - .../writingdocs/styleguide/iperf-vm.xml | 106 - .../writingdocs/styleguide/rawhtml.rst | 10 - .../writingdocs/styleguide/styleguide.rst | 20 - .../writingdocs/styleguide/styleguide02.rst | 83 - .../writingdocs/styleguide/styleguide02table.rst | 76 - .../writingdocs/styleguide/styleguide03.rst | 32 - .../writingdocs/styleguide/styleguide04.rst | 12 - .../writingdocs/styleguide/styleguide05.rst | 11 - .../writingdocs/styleguide/xmlexample.rst | 11 - .../writingdocs/styleguidemd/index.rst | 16 - .../writingdocs/styleguidemd/styleguide.md | 13 - .../writingdocs/styleguidemd/styleguide02.md | 66 - .../writingdocs/styleguidemd/styleguide03.md | 32 - docs/includes_renderer.py | 77 - docs/index.rst | 105 +- docs/interfacing/binapi/index.rst | 12 + docs/interfacing/binapi/vpp_api_language.rst | 1 + docs/interfacing/binapi/vpp_api_module.rst | 1 + docs/interfacing/binapi/writing_api_handlers.rst | 1 + docs/interfacing/go/add_plugin_goapi.rst | 83 + docs/interfacing/go/index.rst | 10 + .../interfacing/libmemif/buildinstructions_doc.rst | 1 + docs/interfacing/libmemif/example_setup_doc.rst | 1 + docs/interfacing/libmemif/examples_doc.rst | 1 + docs/interfacing/libmemif/gettingstarted_doc.rst | 1 + docs/interfacing/libmemif/index.rst | 24 + docs/interfacing/libmemif/libmemif_doc.rst | 1 + docs/interfacing/rust/index.rst | 8 + docs/links/index.rst | 33 - docs/reference/cmdreference/index.rst | 57 - docs/reference/cmdreference/interface/basic.rst | 89 - .../cmdreference/interface/create_interface.rst | 224 - docs/reference/cmdreference/interface/hardware.rst | 167 - docs/reference/cmdreference/interface/index.rst | 18 - .../cmdreference/interface/setinterface.rst | 193 - docs/reference/cmdreference/ip/index.rst | 12 - docs/reference/cmdreference/ip/ip.rst | 151 - docs/reference/cmdreference/show/index.rst | 12 - docs/reference/cmdreference/show/show.rst | 286 - docs/reference/cmdreference/trace/index.rst | 12 - docs/reference/cmdreference/trace/trace.rst | 59 - docs/reference/cmdreference/vhost/index.rst | 10 - docs/reference/cmdreference/vhost/vhostuser.rst | 271 - docs/reference/github/index.rst | 237 - docs/reference/index.rst | 13 - docs/reference/readthedocs/index.rst | 129 - docs/reference/vppvagrant/VagrantVMSetup.rst | 56 - docs/reference/vppvagrant/Vagrantfile | 112 - docs/reference/vppvagrant/boxSetup.rst | 122 - docs/reference/vppvagrant/index.rst | 15 - .../reference/vppvagrant/installingVboxVagrant.rst | 38 - docs/reference/vppvagrant/settingENV.rst | 29 - docs/reference/vppvagrant/vagrantOverview.rst | 25 - docs/reference/vppvagrant/vppVagrantfile.rst | 14 - docs/relatedprojects/index.rst | 20 - docs/scripts/prepare-for-site.sh | 18 - docs/scripts/publish-docs.sh | 85 - docs/scripts/sphinx-make.sh | 38 - docs/spelling_wordlist.txt | 970 +- docs/troubleshooting/cpuusage.rst | 112 - docs/troubleshooting/index.rst | 15 - docs/troubleshooting/mem.rst | 87 - docs/troubleshooting/reportingissues/index.rst | 8 - .../reportingissues/reportingissues.rst | 284 - docs/troubleshooting/sanitizer.rst | 45 - docs/usecases/2_vpp.md | 128 - docs/usecases/ConnectingVPC.rst | 109 - docs/usecases/Routing.rst | 266 - docs/usecases/acls.rst | 372 +- docs/usecases/automatingthedeployment.rst | 12 - docs/usecases/containerCreation.rst | 125 - docs/usecases/containerSetup.rst | 49 - docs/usecases/container_test.md | 640 -- docs/usecases/container_test.rst | 655 ++ docs/usecases/containers.rst | 13 - docs/usecases/containers/Routing.rst | 266 + docs/usecases/containers/containerCreation.rst | 125 + docs/usecases/containers/containerSetup.rst | 49 + docs/usecases/containers/index.rst | 13 + docs/usecases/contiv/BUG_REPORTS.md | 333 - docs/usecases/contiv/BUG_REPORTS.rst | 401 + docs/usecases/contiv/CORE_FILES.md | 73 - docs/usecases/contiv/CORE_FILES.rst | 101 + docs/usecases/contiv/CUSTOM_MGMT_NETWORK.md | 26 - docs/usecases/contiv/CUSTOM_MGMT_NETWORK.rst | 36 + docs/usecases/contiv/K8s_Overview.md | 109 - docs/usecases/contiv/K8s_Overview.rst | 144 + docs/usecases/contiv/MANUAL_INSTALL.md | 482 - docs/usecases/contiv/MANUAL_INSTALL.rst | 609 ++ docs/usecases/contiv/MULTI_NIC_SETUP.md | 21 - docs/usecases/contiv/MULTI_NIC_SETUP.rst | 24 + docs/usecases/contiv/NETWORKING.md | 137 - docs/usecases/contiv/NETWORKING.rst | 196 + docs/usecases/contiv/Prometheus.md | 159 - docs/usecases/contiv/Prometheus.rst | 158 + docs/usecases/contiv/SECURITY.md | 104 - docs/usecases/contiv/SECURITY.rst | 145 + docs/usecases/contiv/SINGLE_NIC_SETUP.md | 111 - docs/usecases/contiv/SINGLE_NIC_SETUP.rst | 140 + docs/usecases/contiv/VMWARE_FUSION_HOST.md | 52 - docs/usecases/contiv/VMWARE_FUSION_HOST.rst | 66 + docs/usecases/contiv/VPPTRACE.md | 95 - docs/usecases/contiv/VPPTRACE.rst | 120 + docs/usecases/contiv/VPP_CONFIG.md | 153 - docs/usecases/contiv/VPP_CONFIG.rst | 183 + docs/usecases/contiv/VPP_PACKET_TRACING_K8S.md | 510 -- docs/usecases/contiv/VPP_PACKET_TRACING_K8S.rst | 535 ++ docs/usecases/contiv/Vagrant.md | 250 - docs/usecases/contiv/Vagrant.rst | 284 + docs/usecases/contiv/index.rst | 52 +- docs/usecases/hgw.md | 497 - docs/usecases/home_gateway.rst | 520 ++ docs/usecases/ikev2.rst | 14 - docs/usecases/ikev2/2_vpp.rst | 128 + docs/usecases/ikev2/index.rst | 14 + docs/usecases/ikev2/vpp_init_sswan_resp.rst | 202 + docs/usecases/ikev2/vpp_resp_sswan_init.rst | 203 + docs/usecases/index.rst | 24 - docs/usecases/networksim.md | 90 - docs/usecases/networksim.rst | 91 + docs/usecases/simpleperf/iperf3.rst | 8 +- docs/usecases/simpleperf/iperf31.rst | 22 +- docs/usecases/simpleperf/trex.rst | 8 +- docs/usecases/simpleperf/trex1.rst | 2 +- docs/usecases/simpleperf/trex2.rst | 234 +- docs/usecases/trafficgen.md | 105 - docs/usecases/trafficgen.rst | 104 + docs/usecases/vhost/index.rst | 4 +- docs/usecases/vhost/vhost.rst | 16 +- docs/usecases/vhost/vhost02.rst | 13 +- docs/usecases/vhost/vhost03.rst | 4 +- docs/usecases/vhost/vhost04.rst | 2 +- docs/usecases/vhost/vhost05.rst | 2 +- docs/usecases/vmxnet3.rst | 4 +- docs/usecases/vpp_init_sswan_resp.md | 195 - docs/usecases/vpp_resp_sswan_init.md | 197 - docs/usecases/vppcloud.rst | 14 - docs/usecases/vppcloud/ConnectingVPC.rst | 109 + docs/usecases/vppcloud/automatingthedeployment.rst | 12 + docs/usecases/vppcloud/index.rst | 14 + docs/usecases/vppcloud/vppinaws.rst | 147 + docs/usecases/vppcloud/vppinazure.rst | 160 + docs/usecases/vppinaws.rst | 147 - docs/usecases/vppinazure.rst | 160 - docs/usecases/webapp.md | 274 - docs/usecases/webapp.rst | 279 + docs/whatisvpp/developer.rst | 29 - docs/whatisvpp/extensible.rst | 43 - docs/whatisvpp/hoststack.rst | 26 - docs/whatisvpp/index.rst | 37 - docs/whatisvpp/networkstack.rst | 39 - docs/whatisvpp/performance.rst | 70 - .../scalar-vs-vector-packet-processing.rst | 69 - docs/whatisvpp/supported.rst | 29 - doxygen/Makefile | 270 - doxygen/assets/doxy-vpp.css | 53 - doxygen/assets/logo_fdio.png | Bin 3092 -> 0 bytes doxygen/dev_doc.md | 27 - doxygen/dir.dox.sample | 30 - doxygen/doxygen.cfg | 2457 ----- doxygen/filter_api.py | 49 - doxygen/filter_c.py | 87 - doxygen/filter_h.py | 56 - doxygen/layout.xml | 194 - doxygen/siphon-generate | 79 - doxygen/siphon-process | 77 - doxygen/siphon/__init__.py | 24 - doxygen/siphon/generate.py | 306 - doxygen/siphon/generate_clicmd.py | 24 - doxygen/siphon/generate_syscfg.py | 24 - doxygen/siphon/parsers.py | 150 - doxygen/siphon/process.py | 318 - doxygen/siphon/process_clicmd.py | 56 - doxygen/siphon/process_syscfg.py | 31 - .../itemlist/clicmd/item_format.itemlist | 17 - .../itemlist/default/index_entry.itemlist | 15 - .../itemlist/default/index_header.itemlist | 15 - .../itemlist/default/index_section.itemlist | 15 - .../itemlist/default/item_format.itemlist | 16 - .../itemlist/default/item_header.itemlist | 15 - .../itemlist/syscfg/item_format.itemlist | 17 - .../markdown/clicmd/index_entry.md | 17 - .../markdown/clicmd/index_header.md | 130 - .../markdown/clicmd/item_format.md | 59 - .../markdown/default/index_entry.md | 16 - .../markdown/default/index_section.md | 18 - .../markdown/default/item_format.md | 16 - .../markdown/default/item_header.md | 18 - .../markdown/syscfg/index_header.md | 111 - .../markdown/syscfg/item_format.md | 42 - doxygen/test_framework_doc.md | 9 - doxygen/user_doc.md | 35 - src/scripts/fts.py | 17 +- test/Makefile | 25 +- test/doc/Makefile | 36 - test/doc/conf.py | 352 - test/doc/index.rst | 11 - test/doc/indices.rst | 6 - test/doc/overview.rst | 450 - test/requirements-3.txt | 156 +- test/requirements.txt | 2 + 485 files changed, 33721 insertions(+), 36665 deletions(-) delete mode 100644 RELEASE.md delete mode 100644 docs/_images/htmlBuild.png create mode 120000 docs/_images/libmemif_architecture.png create mode 100644 docs/_scripts/Makefile create mode 100755 docs/_scripts/filter_api.py create mode 100755 docs/_scripts/filter_c.py create mode 100755 docs/_scripts/filter_h.py create mode 100644 docs/_scripts/includes_renderer.py create mode 100755 docs/_scripts/prepare-for-site.sh create mode 100755 docs/_scripts/publish-docs.sh create mode 100755 docs/_scripts/siphon-generate create mode 100755 docs/_scripts/siphon-process create mode 100644 docs/_scripts/siphon/__init__.py create mode 100644 docs/_scripts/siphon/generate.py create mode 100644 docs/_scripts/siphon/generate_clicmd.py create mode 100644 docs/_scripts/siphon/generate_syscfg.py create mode 100644 docs/_scripts/siphon/parsers.py create mode 100644 docs/_scripts/siphon/process.py create mode 100644 docs/_scripts/siphon/process_clicmd.py create mode 100644 docs/_scripts/siphon/process_syscfg.py create mode 100644 docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md create mode 100644 docs/_scripts/siphon_templates/markdown/clicmd/index_header.md create mode 100644 docs/_scripts/siphon_templates/markdown/clicmd/index_section.md create mode 100644 docs/_scripts/siphon_templates/markdown/clicmd/item_format.md create mode 100644 docs/_scripts/siphon_templates/markdown/clicmd/item_header.md create mode 100644 docs/_scripts/siphon_templates/markdown/default/index_entry.md create mode 100644 docs/_scripts/siphon_templates/markdown/default/index_section.md create mode 100644 docs/_scripts/siphon_templates/markdown/default/item_format.md create mode 100644 docs/_scripts/siphon_templates/markdown/default/item_header.md create mode 100644 docs/_scripts/siphon_templates/markdown/syscfg/index_header.md create mode 100644 docs/_scripts/siphon_templates/markdown/syscfg/item_format.md delete mode 100644 docs/about.rst create mode 100644 docs/aboutvpp/developer.rst create mode 100644 docs/aboutvpp/extensible.rst create mode 100644 docs/aboutvpp/hoststack.rst create mode 100644 docs/aboutvpp/networkstack.rst create mode 100644 docs/aboutvpp/performance.rst create mode 100644 docs/aboutvpp/releasenotes/index.rst create mode 100644 docs/aboutvpp/releasenotes/past.rst create mode 100644 docs/aboutvpp/releasenotes/v16.06.rst create mode 100644 docs/aboutvpp/releasenotes/v16.09.rst create mode 100644 docs/aboutvpp/releasenotes/v17.01.1.rst create mode 100644 docs/aboutvpp/releasenotes/v17.01.rst create mode 100644 docs/aboutvpp/releasenotes/v17.04.rst create mode 100644 docs/aboutvpp/releasenotes/v17.07.rst create mode 100644 docs/aboutvpp/releasenotes/v17.10.rst create mode 100644 docs/aboutvpp/releasenotes/v18.01.1.rst create mode 100644 docs/aboutvpp/releasenotes/v18.01.2.rst create mode 100644 docs/aboutvpp/releasenotes/v18.01.rst create mode 100644 docs/aboutvpp/releasenotes/v18.04.rst create mode 100644 docs/aboutvpp/releasenotes/v18.07.rst create mode 100644 docs/aboutvpp/releasenotes/v18.10.rst create mode 100644 docs/aboutvpp/releasenotes/v19.01.1.rst create mode 100644 docs/aboutvpp/releasenotes/v19.01.2.rst create mode 100644 docs/aboutvpp/releasenotes/v19.01.3.rst create mode 100644 docs/aboutvpp/releasenotes/v19.01.rst create mode 100644 docs/aboutvpp/releasenotes/v19.04.1.rst create mode 100644 docs/aboutvpp/releasenotes/v19.04.2.rst create mode 100644 docs/aboutvpp/releasenotes/v19.04.3.rst create mode 100644 docs/aboutvpp/releasenotes/v19.04.rst create mode 100644 docs/aboutvpp/releasenotes/v19.08.1.rst create mode 100644 docs/aboutvpp/releasenotes/v19.08.2.rst create mode 100644 docs/aboutvpp/releasenotes/v19.08.3.rst create mode 100644 docs/aboutvpp/releasenotes/v19.08.rst create mode 100644 docs/aboutvpp/releasenotes/v20.01.rst create mode 100644 docs/aboutvpp/releasenotes/v20.05.1.rst create mode 100644 docs/aboutvpp/releasenotes/v20.05.rst create mode 100644 docs/aboutvpp/releasenotes/v20.09.rst create mode 100644 docs/aboutvpp/releasenotes/v21.01.rst create mode 100644 docs/aboutvpp/releasenotes/v21.06.rst create mode 100644 docs/aboutvpp/releasenotes/v21.10.rst create mode 100644 docs/aboutvpp/scalar-vs-vector-packet-processing.rst create mode 100644 docs/aboutvpp/supported.rst create mode 100644 docs/cli-reference/gettingstarted/index.rst create mode 100644 docs/cli-reference/interface/basic.rst create mode 100644 docs/cli-reference/interface/create_interface.rst create mode 100644 docs/cli-reference/interface/hardware.rst create mode 100644 docs/cli-reference/interface/index.rst create mode 100644 docs/cli-reference/interface/setinterface.rst create mode 100644 docs/configuration/config_getting_started.rst create mode 100644 docs/configuration/reference.rst create mode 100644 docs/contributing/gitreview.rst create mode 100644 docs/contributing/reportingissues/index.rst create mode 100644 docs/contributing/reportingissues/reportingissues.rst create mode 100644 docs/contributing/writingdocs.rst create mode 100644 docs/developer/build-run-debug/building.rst create mode 100644 docs/developer/build-run-debug/cross_compile_macos.rst create mode 100644 docs/developer/build-run-debug/gdb_examples.rst create mode 100644 docs/developer/build-run-debug/index.rst create mode 100644 docs/developer/build-run-debug/running_vpp.rst create mode 100644 docs/developer/build-run-debug/testing_vpp.rst create mode 100644 docs/developer/corearchitecture/bihash.rst create mode 100644 docs/developer/corearchitecture/buffer_metadata.rst create mode 100644 docs/developer/corearchitecture/buildsystem/buildrootmakefile.rst create mode 100644 docs/developer/corearchitecture/buildsystem/cmakeandninja.rst create mode 100644 docs/developer/corearchitecture/buildsystem/index.rst create mode 100644 docs/developer/corearchitecture/buildsystem/mainmakefile.rst create mode 100644 docs/developer/corearchitecture/featurearcs.rst create mode 100644 docs/developer/corearchitecture/index.rst create mode 100644 docs/developer/corearchitecture/infrastructure.rst create mode 120000 docs/developer/corearchitecture/mem.rst create mode 100644 docs/developer/corearchitecture/multi_thread.rst create mode 100644 docs/developer/corearchitecture/multiarch/arbfns.rst create mode 100644 docs/developer/corearchitecture/multiarch/index.rst create mode 100644 docs/developer/corearchitecture/multiarch/nodefns.rst create mode 100644 docs/developer/corearchitecture/softwarearchitecture.rst create mode 100644 docs/developer/corearchitecture/vlib.rst create mode 100644 docs/developer/corearchitecture/vnet.rst create mode 120000 docs/developer/corefeatures/bfd_doc.rst create mode 100644 docs/developer/corefeatures/eventviewer.rst create mode 100644 docs/developer/corefeatures/fib/attachedexport.rst create mode 100644 docs/developer/corefeatures/fib/barnacles.rst create mode 100644 docs/developer/corefeatures/fib/controlplane.rst create mode 100644 docs/developer/corefeatures/fib/dataplane.rst create mode 100644 docs/developer/corefeatures/fib/debugging.rst create mode 100644 docs/developer/corefeatures/fib/fastconvergence.rst create mode 100644 docs/developer/corefeatures/fib/graphs.rst create mode 100644 docs/developer/corefeatures/fib/graphwalks.rst create mode 100644 docs/developer/corefeatures/fib/hacking.rst create mode 100644 docs/developer/corefeatures/fib/index.rst create mode 100644 docs/developer/corefeatures/fib/marknsweep.rst create mode 100644 docs/developer/corefeatures/fib/missing.rst create mode 100644 docs/developer/corefeatures/fib/mplsfib.rst create mode 100644 docs/developer/corefeatures/fib/multicast.rst create mode 100644 docs/developer/corefeatures/fib/neighbors.rst create mode 100644 docs/developer/corefeatures/fib/prefixes.rst create mode 100644 docs/developer/corefeatures/fib/prerequisites.rst create mode 100644 docs/developer/corefeatures/fib/routes.rst create mode 100644 docs/developer/corefeatures/fib/scale.rst create mode 100644 docs/developer/corefeatures/fib/thedatamodel.rst create mode 100644 docs/developer/corefeatures/fib/tunnels.rst create mode 100644 docs/developer/corefeatures/index.rst create mode 120000 docs/developer/corefeatures/ipfix_doc.rst create mode 120000 docs/developer/corefeatures/ipsec.rst create mode 120000 docs/developer/corefeatures/mtu.rst create mode 120000 docs/developer/corefeatures/punt.rst create mode 120000 docs/developer/corefeatures/selinux_doc.rst create mode 120000 docs/developer/corefeatures/span_doc.rst create mode 100644 docs/developer/corefeatures/sr/index.rst create mode 120000 docs/developer/corefeatures/sr/sr_doc.rst create mode 120000 docs/developer/corefeatures/sr/sr_localsid.rst create mode 120000 docs/developer/corefeatures/sr/sr_mpls.rst create mode 120000 docs/developer/corefeatures/sr/sr_policy.rst create mode 120000 docs/developer/corefeatures/sr/sr_steering.rst create mode 120000 docs/developer/corefeatures/stats.rst create mode 120000 docs/developer/corefeatures/sylog_doc.rst create mode 120000 docs/developer/devicedrivers/af_xdp.rst create mode 120000 docs/developer/devicedrivers/avf.rst create mode 100644 docs/developer/devicedrivers/index.rst create mode 120000 docs/developer/devicedrivers/rdma.rst create mode 120000 docs/developer/devicedrivers/vmxnet3.rst create mode 100644 docs/developer/extras/index.rst create mode 120000 docs/developer/extras/lcov.rst create mode 120000 docs/developer/extras/snap.rst create mode 120000 docs/developer/extras/strongswan.rst create mode 120000 docs/developer/extras/vcl_ldpreload.rst create mode 120000 docs/developer/extras/vpp_config.rst create mode 120000 docs/developer/extras/vpp_if_stats.rst create mode 120000 docs/developer/extras/vpp_stats_fs.rst create mode 120000 docs/developer/extras/vpptop.rst create mode 100644 docs/developer/plugindoc/add_plugin.rst create mode 120000 docs/developer/plugindoc/handoffdemo.rst create mode 100644 docs/developer/plugindoc/index.rst create mode 120000 docs/developer/plugindoc/sample_plugin_doc.rst create mode 120000 docs/developer/plugins/acl_hash_lookup.rst create mode 120000 docs/developer/plugins/acl_lookup_context.rst create mode 120000 docs/developer/plugins/acl_multicore.rst create mode 120000 docs/developer/plugins/bufmon_doc.rst create mode 120000 docs/developer/plugins/cnat.rst create mode 120000 docs/developer/plugins/dhcp6_pd.rst create mode 120000 docs/developer/plugins/flowprobe.rst create mode 100644 docs/developer/plugins/index.rst create mode 120000 docs/developer/plugins/ioam.rst create mode 120000 docs/developer/plugins/lacp.rst create mode 120000 docs/developer/plugins/lb.rst create mode 120000 docs/developer/plugins/lcp.rst create mode 120000 docs/developer/plugins/lldp.rst create mode 120000 docs/developer/plugins/map_lw4o6.rst create mode 120000 docs/developer/plugins/marvell.rst create mode 120000 docs/developer/plugins/mdata.rst create mode 120000 docs/developer/plugins/nat44_ei_ha.rst create mode 120000 docs/developer/plugins/nat64.rst create mode 120000 docs/developer/plugins/pnat.rst create mode 120000 docs/developer/plugins/quic.rst create mode 120000 docs/developer/plugins/srtp.rst create mode 120000 docs/developer/plugins/srv6/ad_flow_plugin_doc.rst create mode 120000 docs/developer/plugins/srv6/ad_plugin_doc.rst create mode 120000 docs/developer/plugins/srv6/am_plugin_doc.rst create mode 120000 docs/developer/plugins/srv6/as_plugin_doc.rst create mode 100644 docs/developer/plugins/srv6/index.rst create mode 120000 docs/developer/plugins/srv6/mobile_plugin_doc.rst create mode 120000 docs/developer/plugins/srv6/runner_doc.rst create mode 120000 docs/developer/plugins/srv6/srv6_sample_localsid_doc.rst create mode 120000 docs/developer/plugins/wireguard.rst create mode 100644 docs/developer/tests/overview.rst create mode 100644 docs/docsignore delete mode 100644 docs/dynamic_includes/.gitkeep delete mode 120000 docs/gettingstarted/developers/VPPAPI.md delete mode 100644 docs/gettingstarted/developers/add_plugin.rst delete mode 100644 docs/gettingstarted/developers/add_plugin_goapi.rst delete mode 100644 docs/gettingstarted/developers/bihash.md delete mode 100644 docs/gettingstarted/developers/binary_api_support.rst delete mode 100644 docs/gettingstarted/developers/building.rst delete mode 100644 docs/gettingstarted/developers/buildsystem/buildrootmakefile.rst delete mode 100644 docs/gettingstarted/developers/buildsystem/cmakeandninja.rst delete mode 100644 docs/gettingstarted/developers/buildsystem/index.rst delete mode 100644 docs/gettingstarted/developers/buildsystem/mainmakefile.md delete mode 100644 docs/gettingstarted/developers/buildwireshark.md delete mode 120000 docs/gettingstarted/developers/cnat.rst delete mode 100644 docs/gettingstarted/developers/cross_compile_macos.rst delete mode 100644 docs/gettingstarted/developers/eventviewer.rst delete mode 100644 docs/gettingstarted/developers/featurearcs.md delete mode 100644 docs/gettingstarted/developers/fib20/attachedexport.rst delete mode 100644 docs/gettingstarted/developers/fib20/barnacles.rst delete mode 100644 docs/gettingstarted/developers/fib20/controlplane.rst delete mode 100644 docs/gettingstarted/developers/fib20/dataplane.rst delete mode 100644 docs/gettingstarted/developers/fib20/debugging.rst delete mode 100644 docs/gettingstarted/developers/fib20/fastconvergence.rst delete mode 100644 docs/gettingstarted/developers/fib20/graphs.rst delete mode 100644 docs/gettingstarted/developers/fib20/graphwalks.rst delete mode 100644 docs/gettingstarted/developers/fib20/hacking.rst delete mode 100644 docs/gettingstarted/developers/fib20/index.rst delete mode 100644 docs/gettingstarted/developers/fib20/marknsweep.rst delete mode 100644 docs/gettingstarted/developers/fib20/missing.rst delete mode 100644 docs/gettingstarted/developers/fib20/mplsfib.rst delete mode 100644 docs/gettingstarted/developers/fib20/multicast.rst delete mode 100644 docs/gettingstarted/developers/fib20/neighbors.rst delete mode 100644 docs/gettingstarted/developers/fib20/prefixes.rst delete mode 100644 docs/gettingstarted/developers/fib20/prerequisites.rst delete mode 100644 docs/gettingstarted/developers/fib20/routes.rst delete mode 100644 docs/gettingstarted/developers/fib20/scale.rst delete mode 100644 docs/gettingstarted/developers/fib20/thedatamodel.rst delete mode 100644 docs/gettingstarted/developers/fib20/tunnels.rst delete mode 100644 docs/gettingstarted/developers/gdb_examples.rst delete mode 100644 docs/gettingstarted/developers/gitreview.rst delete mode 100644 docs/gettingstarted/developers/index.rst delete mode 100644 docs/gettingstarted/developers/infrastructure.md delete mode 120000 docs/gettingstarted/developers/ipsec.rst delete mode 100644 docs/gettingstarted/developers/metadata.md delete mode 100644 docs/gettingstarted/developers/multiarch/arbfns.rst delete mode 100644 docs/gettingstarted/developers/multiarch/index.rst delete mode 100644 docs/gettingstarted/developers/multiarch/nodefns.rst delete mode 100644 docs/gettingstarted/developers/plugins.rst delete mode 120000 docs/gettingstarted/developers/punt.rst delete mode 120000 docs/gettingstarted/developers/quic_plugin.rst delete mode 100644 docs/gettingstarted/developers/running_vpp.rst delete mode 100644 docs/gettingstarted/developers/softwarearchitecture.md delete mode 100644 docs/gettingstarted/developers/testing_vpp.md delete mode 100644 docs/gettingstarted/developers/vlib.md delete mode 100644 docs/gettingstarted/developers/vnet.md delete mode 100644 docs/gettingstarted/developers/vpp_api_module.rst delete mode 100644 docs/gettingstarted/index.rst delete mode 100644 docs/gettingstarted/installing/centos.rst create mode 100644 docs/gettingstarted/running/index.rst create mode 100644 docs/gettingstarted/troubleshooting/cpuusage.rst create mode 100644 docs/gettingstarted/troubleshooting/index.rst create mode 100644 docs/gettingstarted/troubleshooting/mem.rst create mode 100644 docs/gettingstarted/troubleshooting/sanitizer.rst delete mode 100644 docs/gettingstarted/users/configuring/hugepages.rst delete mode 100644 docs/gettingstarted/users/configuring/index.rst delete mode 100644 docs/gettingstarted/users/configuring/startup.rst delete mode 100644 docs/gettingstarted/users/index.rst delete mode 100644 docs/gettingstarted/users/running/index.rst delete mode 100644 docs/gettingstarted/writingdocs/buildingrst.rst delete mode 100644 docs/gettingstarted/writingdocs/index.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/index.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/iperf-vm.xml delete mode 100644 docs/gettingstarted/writingdocs/styleguide/rawhtml.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/styleguide.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/styleguide02.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/styleguide02table.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/styleguide03.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/styleguide04.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/styleguide05.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguide/xmlexample.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguidemd/index.rst delete mode 100644 docs/gettingstarted/writingdocs/styleguidemd/styleguide.md delete mode 100644 docs/gettingstarted/writingdocs/styleguidemd/styleguide02.md delete mode 100644 docs/gettingstarted/writingdocs/styleguidemd/styleguide03.md delete mode 100644 docs/includes_renderer.py create mode 100644 docs/interfacing/binapi/index.rst create mode 120000 docs/interfacing/binapi/vpp_api_language.rst create mode 120000 docs/interfacing/binapi/vpp_api_module.rst create mode 120000 docs/interfacing/binapi/writing_api_handlers.rst create mode 100644 docs/interfacing/go/add_plugin_goapi.rst create mode 100644 docs/interfacing/go/index.rst create mode 120000 docs/interfacing/libmemif/buildinstructions_doc.rst create mode 120000 docs/interfacing/libmemif/example_setup_doc.rst create mode 120000 docs/interfacing/libmemif/examples_doc.rst create mode 120000 docs/interfacing/libmemif/gettingstarted_doc.rst create mode 100644 docs/interfacing/libmemif/index.rst create mode 120000 docs/interfacing/libmemif/libmemif_doc.rst create mode 100644 docs/interfacing/rust/index.rst delete mode 100644 docs/links/index.rst delete mode 100644 docs/reference/cmdreference/index.rst delete mode 100644 docs/reference/cmdreference/interface/basic.rst delete mode 100644 docs/reference/cmdreference/interface/create_interface.rst delete mode 100644 docs/reference/cmdreference/interface/hardware.rst delete mode 100644 docs/reference/cmdreference/interface/index.rst delete mode 100644 docs/reference/cmdreference/interface/setinterface.rst delete mode 100644 docs/reference/cmdreference/ip/index.rst delete mode 100644 docs/reference/cmdreference/ip/ip.rst delete mode 100644 docs/reference/cmdreference/show/index.rst delete mode 100644 docs/reference/cmdreference/show/show.rst delete mode 100644 docs/reference/cmdreference/trace/index.rst delete mode 100644 docs/reference/cmdreference/trace/trace.rst delete mode 100644 docs/reference/cmdreference/vhost/index.rst delete mode 100644 docs/reference/cmdreference/vhost/vhostuser.rst delete mode 100644 docs/reference/github/index.rst delete mode 100644 docs/reference/index.rst delete mode 100644 docs/reference/readthedocs/index.rst delete mode 100644 docs/reference/vppvagrant/VagrantVMSetup.rst delete mode 100644 docs/reference/vppvagrant/Vagrantfile delete mode 100644 docs/reference/vppvagrant/boxSetup.rst delete mode 100644 docs/reference/vppvagrant/index.rst delete mode 100644 docs/reference/vppvagrant/installingVboxVagrant.rst delete mode 100644 docs/reference/vppvagrant/settingENV.rst delete mode 100644 docs/reference/vppvagrant/vagrantOverview.rst delete mode 100644 docs/reference/vppvagrant/vppVagrantfile.rst delete mode 100644 docs/relatedprojects/index.rst delete mode 100755 docs/scripts/prepare-for-site.sh delete mode 100755 docs/scripts/publish-docs.sh delete mode 100755 docs/scripts/sphinx-make.sh delete mode 100644 docs/troubleshooting/cpuusage.rst delete mode 100644 docs/troubleshooting/index.rst delete mode 100644 docs/troubleshooting/mem.rst delete mode 100644 docs/troubleshooting/reportingissues/index.rst delete mode 100644 docs/troubleshooting/reportingissues/reportingissues.rst delete mode 100644 docs/troubleshooting/sanitizer.rst delete mode 100644 docs/usecases/2_vpp.md delete mode 100644 docs/usecases/ConnectingVPC.rst delete mode 100644 docs/usecases/Routing.rst delete mode 100644 docs/usecases/automatingthedeployment.rst delete mode 100644 docs/usecases/containerCreation.rst delete mode 100644 docs/usecases/containerSetup.rst delete mode 100644 docs/usecases/container_test.md create mode 100644 docs/usecases/container_test.rst delete mode 100644 docs/usecases/containers.rst create mode 100644 docs/usecases/containers/Routing.rst create mode 100644 docs/usecases/containers/containerCreation.rst create mode 100644 docs/usecases/containers/containerSetup.rst create mode 100644 docs/usecases/containers/index.rst delete mode 100644 docs/usecases/contiv/BUG_REPORTS.md create mode 100644 docs/usecases/contiv/BUG_REPORTS.rst delete mode 100644 docs/usecases/contiv/CORE_FILES.md create mode 100644 docs/usecases/contiv/CORE_FILES.rst delete mode 100644 docs/usecases/contiv/CUSTOM_MGMT_NETWORK.md create mode 100644 docs/usecases/contiv/CUSTOM_MGMT_NETWORK.rst delete mode 100644 docs/usecases/contiv/K8s_Overview.md create mode 100644 docs/usecases/contiv/K8s_Overview.rst delete mode 100644 docs/usecases/contiv/MANUAL_INSTALL.md create mode 100644 docs/usecases/contiv/MANUAL_INSTALL.rst delete mode 100644 docs/usecases/contiv/MULTI_NIC_SETUP.md create mode 100644 docs/usecases/contiv/MULTI_NIC_SETUP.rst delete mode 100644 docs/usecases/contiv/NETWORKING.md create mode 100644 docs/usecases/contiv/NETWORKING.rst delete mode 100644 docs/usecases/contiv/Prometheus.md create mode 100644 docs/usecases/contiv/Prometheus.rst delete mode 100644 docs/usecases/contiv/SECURITY.md create mode 100644 docs/usecases/contiv/SECURITY.rst delete mode 100644 docs/usecases/contiv/SINGLE_NIC_SETUP.md create mode 100644 docs/usecases/contiv/SINGLE_NIC_SETUP.rst delete mode 100644 docs/usecases/contiv/VMWARE_FUSION_HOST.md create mode 100644 docs/usecases/contiv/VMWARE_FUSION_HOST.rst delete mode 100644 docs/usecases/contiv/VPPTRACE.md create mode 100644 docs/usecases/contiv/VPPTRACE.rst delete mode 100644 docs/usecases/contiv/VPP_CONFIG.md create mode 100644 docs/usecases/contiv/VPP_CONFIG.rst delete mode 100644 docs/usecases/contiv/VPP_PACKET_TRACING_K8S.md create mode 100644 docs/usecases/contiv/VPP_PACKET_TRACING_K8S.rst delete mode 100644 docs/usecases/contiv/Vagrant.md create mode 100644 docs/usecases/contiv/Vagrant.rst delete mode 100644 docs/usecases/hgw.md create mode 100644 docs/usecases/home_gateway.rst delete mode 100644 docs/usecases/ikev2.rst create mode 100644 docs/usecases/ikev2/2_vpp.rst create mode 100644 docs/usecases/ikev2/index.rst create mode 100644 docs/usecases/ikev2/vpp_init_sswan_resp.rst create mode 100644 docs/usecases/ikev2/vpp_resp_sswan_init.rst delete mode 100644 docs/usecases/index.rst delete mode 100644 docs/usecases/networksim.md create mode 100644 docs/usecases/networksim.rst delete mode 100644 docs/usecases/trafficgen.md create mode 100644 docs/usecases/trafficgen.rst delete mode 100644 docs/usecases/vpp_init_sswan_resp.md delete mode 100644 docs/usecases/vpp_resp_sswan_init.md delete mode 100644 docs/usecases/vppcloud.rst create mode 100644 docs/usecases/vppcloud/ConnectingVPC.rst create mode 100644 docs/usecases/vppcloud/automatingthedeployment.rst create mode 100644 docs/usecases/vppcloud/index.rst create mode 100644 docs/usecases/vppcloud/vppinaws.rst create mode 100644 docs/usecases/vppcloud/vppinazure.rst delete mode 100644 docs/usecases/vppinaws.rst delete mode 100644 docs/usecases/vppinazure.rst delete mode 100644 docs/usecases/webapp.md create mode 100644 docs/usecases/webapp.rst delete mode 100644 docs/whatisvpp/developer.rst delete mode 100644 docs/whatisvpp/extensible.rst delete mode 100644 docs/whatisvpp/hoststack.rst delete mode 100644 docs/whatisvpp/index.rst delete mode 100644 docs/whatisvpp/networkstack.rst delete mode 100644 docs/whatisvpp/performance.rst delete mode 100644 docs/whatisvpp/scalar-vs-vector-packet-processing.rst delete mode 100644 docs/whatisvpp/supported.rst delete mode 100644 doxygen/Makefile delete mode 100644 doxygen/assets/doxy-vpp.css delete mode 100644 doxygen/assets/logo_fdio.png delete mode 100644 doxygen/dev_doc.md delete mode 100644 doxygen/dir.dox.sample delete mode 100644 doxygen/doxygen.cfg delete mode 100755 doxygen/filter_api.py delete mode 100755 doxygen/filter_c.py delete mode 100755 doxygen/filter_h.py delete mode 100644 doxygen/layout.xml delete mode 100755 doxygen/siphon-generate delete mode 100755 doxygen/siphon-process delete mode 100644 doxygen/siphon/__init__.py delete mode 100644 doxygen/siphon/generate.py delete mode 100644 doxygen/siphon/generate_clicmd.py delete mode 100644 doxygen/siphon/generate_syscfg.py delete mode 100644 doxygen/siphon/parsers.py delete mode 100644 doxygen/siphon/process.py delete mode 100644 doxygen/siphon/process_clicmd.py delete mode 100644 doxygen/siphon/process_syscfg.py delete mode 100644 doxygen/siphon_templates/itemlist/clicmd/item_format.itemlist delete mode 100644 doxygen/siphon_templates/itemlist/default/index_entry.itemlist delete mode 100644 doxygen/siphon_templates/itemlist/default/index_header.itemlist delete mode 100644 doxygen/siphon_templates/itemlist/default/index_section.itemlist delete mode 100644 doxygen/siphon_templates/itemlist/default/item_format.itemlist delete mode 100644 doxygen/siphon_templates/itemlist/default/item_header.itemlist delete mode 100644 doxygen/siphon_templates/itemlist/syscfg/item_format.itemlist delete mode 100644 doxygen/siphon_templates/markdown/clicmd/index_entry.md delete mode 100644 doxygen/siphon_templates/markdown/clicmd/index_header.md delete mode 100644 doxygen/siphon_templates/markdown/clicmd/item_format.md delete mode 100644 doxygen/siphon_templates/markdown/default/index_entry.md delete mode 100644 doxygen/siphon_templates/markdown/default/index_section.md delete mode 100644 doxygen/siphon_templates/markdown/default/item_format.md delete mode 100644 doxygen/siphon_templates/markdown/default/item_header.md delete mode 100644 doxygen/siphon_templates/markdown/syscfg/index_header.md delete mode 100644 doxygen/siphon_templates/markdown/syscfg/item_format.md delete mode 100644 doxygen/test_framework_doc.md delete mode 100644 doxygen/user_doc.md delete mode 100644 test/doc/Makefile delete mode 100644 test/doc/conf.py delete mode 100644 test/doc/index.rst delete mode 100644 test/doc/indices.rst delete mode 100644 test/doc/overview.rst diff --git a/.gitignore b/.gitignore index 80c4e4f92c9..4fb7ecc809f 100644 --- a/.gitignore +++ b/.gitignore @@ -82,10 +82,7 @@ GTAGS /build-root/docs /build-root/.doxygen-bootstrap.ok /build-root/.doxygen-siphon.dep -/docs/_build -/docs/dynamic_includes -/sphinx_venv -!/docs/Makefile +/docs/venv # language servers compile_commands.json diff --git a/MAINTAINERS b/MAINTAINERS index a5bcc707983..7085a3415b9 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -33,11 +33,6 @@ I: bonding M: Steven Luong F: src/vnet/bonding/ -Doxygen -I: doxygen -M: Chris Luke -F: doxygen/ - Sphinx Documents I: docs M: John DeNisco diff --git a/Makefile b/Makefile index 28e44ce9095..1456ef2b720 100644 --- a/Makefile +++ b/Makefile @@ -209,9 +209,9 @@ help: @echo " checkstyle-test-diff - check test framework coding style (only changed files)" @echo " checkstyle-api - check api for incompatible changes" @echo " fixstyle - fix coding style" - @echo " doxygen - (re)generate documentation" - @echo " bootstrap-doxygen - setup Doxygen dependencies" - @echo " wipe-doxygen - wipe all generated documentation" + @echo " doxygen - DEPRECATED - use 'make docs'" + @echo " bootstrap-doxygen - DEPRECATED" + @echo " wipe-doxygen - DEPRECATED" @echo " checkfeaturelist - check FEATURE.yaml according to schema" @echo " featurelist - dump feature list in markdown" @echo " json-api-files - (re)-generate json api files" @@ -451,11 +451,13 @@ test-dep: .PHONY: test-doc test-doc: - @make -C test doc + @echo "make test-doc is DEPRECATED: use 'make doc'" + sleep 300 .PHONY: test-wipe-doc test-wipe-doc: - @make -C test wipe-doc + @echo "make test-wipe-doc is DEPRECATED" + sleep 300 .PHONY: test-cov test-cov: @@ -667,42 +669,28 @@ checkfeaturelist: centos-pyyaml # Build the documentation # -# Doxygen configuration and our utility scripts -export DOXY_DIR ?= $(WS_ROOT)/doxygen - -define make-doxy - @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@ -endef - .PHONY: bootstrap-doxygen bootstrap-doxygen: - $(call make-doxy) + @echo "make bootstrap-doxygen is DEPRECATED" + sleep 300 .PHONY: doxygen -doxygen: bootstrap-doxygen - $(call make-doxy) +doxygen: docs + @echo "make doxygen is DEPRECATED: use 'make docs'" + sleep 300 .PHONY: wipe-doxygen wipe-doxygen: - $(call make-doxy) + @echo "make wipe-doxygen is DEPRECATED" + sleep 300 -# Sphinx Documents -export DOCS_DIR = $(WS_ROOT)/docs -export VENV_DIR = $(WS_ROOT)/sphinx_venv -export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts - -.PHONY: docs-venv -docs-venv: - @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv) +.PHONY: docs-% +docs-%: + @make -C $(WS_ROOT)/docs $* .PHONY: docs -docs: $(DOCS_DIR) - @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html) - -.PHONY: docs-clean -docs-clean: - @rm -rf $(DOCS_DIR)/_build - @rm -rf $(VENV_DIR) +docs: + @make -C $(WS_ROOT)/docs docs .PHONY: pkg-verify pkg-verify: install-dep $(BR)/.deps.ok install-ext-deps diff --git a/README.md b/README.md index 4cc283b5e53..05036807610 100644 --- a/README.md +++ b/README.md @@ -19,32 +19,32 @@ For more information on VPP and its features please visit the ## Changes Details of the changes leading up to this version of VPP can be found under -@ref release_notes. +doc/releasenotes. ## Directory layout | Directory name | Description | | ---------------------- | ------------------------------------------- | -| build-data | Build metadata | -| build-root | Build output directory | -| doxygen | Documentation generator configuration | -| dpdk | DPDK patches and build infrastructure | -| @ref extras/libmemif | Client library for memif | -| @ref src/examples | VPP example code | -| @ref src/plugins | VPP bundled plugins directory | -| @ref src/svm | Shared virtual memory allocation library | -| src/tests | Standalone tests (not part of test harness) | -| src/vat | VPP API test program | -| @ref src/vlib | VPP application library | -| @ref src/vlibapi | VPP API library | -| @ref src/vlibmemory | VPP Memory management | -| @ref src/vnet | VPP networking | -| @ref src/vpp | VPP application | -| @ref src/vpp-api | VPP application API bindings | -| @ref src/vppinfra | VPP core library | -| @ref src/vpp/api | Not-yet-relocated API bindings | -| test | Unit tests and Python test harness | +| build-data | Build metadata | +| build-root | Build output directory | +| docs | Sphinx Documentation | +| dpdk | DPDK patches and build infrastructure | +| extras/libmemif | Client library for memif | +| src/examples | VPP example code | +| src/plugins | VPP bundled plugins directory | +| src/svm | Shared virtual memory allocation library | +| src/tests | Standalone tests (not part of test harness) | +| src/vat | VPP API test program | +| src/vlib | VPP application library | +| src/vlibapi | VPP API library | +| src/vlibmemory | VPP Memory management | +| src/vnet | VPP networking | +| src/vpp | VPP application | +| src/vpp-api | VPP application API bindings | +| src/vppinfra | VPP core library | +| src/vpp/api | Not-yet-relocated API bindings | +| test | Unit tests and Python test harness | ## Getting started @@ -99,8 +99,3 @@ end-user-oriented information. Also see @subpage dev_doc for developer notes. Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more advanced building strategies and other development notes. - -## Test Framework - -There is PyDoc generated documentation available for the VPP test framework. -See @ref test_framework_doc for details. diff --git a/RELEASE.md b/RELEASE.md deleted file mode 100644 index 33de3c5cc4b..00000000000 --- a/RELEASE.md +++ /dev/null @@ -1,9671 +0,0 @@ -# Release Notes {#release_notes} - -* @subpage release_notes_2202 -* @subpage release_notes_2110 -* @subpage release_notes_2106 -* @subpage release_notes_2101 -* @subpage release_notes_2009 -* @subpage release_notes_20051 -* @subpage release_notes_2005 -* @subpage release_notes_2001 -* @subpage release_notes_19083 -* @subpage release_notes_19082 -* @subpage release_notes_19081 -* @subpage release_notes_1908 -* @subpage release_notes_19043 -* @subpage release_notes_19042 -* @subpage release_notes_19041 -* @subpage release_notes_1904 -* @subpage release_notes_19013 -* @subpage release_notes_19012 -* @subpage release_notes_19011 -* @subpage release_notes_1901 -* @subpage release_notes_1810 -* @subpage release_notes_1807 -* @subpage release_notes_1804 -* @subpage release_notes_18012 -* @subpage release_notes_18011 -* @subpage release_notes_1801 -* @subpage release_notes_1710 -* @subpage release_notes_1707 -* @subpage release_notes_1704 -* @subpage release_notes_17011 -* @subpage release_notes_1701 -* @subpage release_notes_1609 -* @subpage release_notes_1606 - -@page release_notes_2202 Release notes for VPP 22.02 - -TBD - -@page release_notes_2110 Release notes for VPP 21.10 - -TBD - -@page release_notes_2106 Release notes for VPP 21.06 - -More than 787 commits since the previous release, including 364 fixes. - -## Release Highlights - -There are many excellent new features in this release, however a few of them deserve a special mention. - -### Linux Control Plane Plugin (linux-cp) - -One of the more significant new features included in this release is a linux control plane (linux-cp) plugin. -It enables the near-seamless integration of VPP with the host control plane, by mirroring the VPP interfaces -into a TUN or TAP device created in the linux kernel. All of the punted packets received on the VPP interface -will be sent to the linux counterpart, and in the reverse direction, packets sent by linux kernel will be -transmitted out the VPP interface. This plugin lays the foundation for the much easier integration of external -software with VPP. - -### Performance Monitor Plugin (perfmon) - -Another interesting feature is the performance monitor (perfmon) plugin. It allows collection of detailed low-level -CPU statistics on a per-node basis. It provides a useful advanced troubleshooting tool, should you encounter that a -specific node's performance is not on par with what it should be. Note, that the correct functioning of this plugin -may require changing the /proc/sys/kernel/perf_event_paranoid setting to enable access to the performance counters. - -### API CRC Substitution Table Removal - -And finally a clarification, not a feature per se. Some messages in the API changes table for this release have a -new marking: "message CRC32 fix". The history of this issue goes back to summer of 2020, when it was discovered that -for a considerable amount of time (several months) the calculation of the CRC of API messages was incorrect. -Specifically, all but the first user-defined types in the message failed to be included in the CRC calculation. -In plain words, this means that one might end up with a situation where client and VPP layout of message in memory -could be quite different. - -At the time of discovery, there were no API changes that were affected by that bug. However, simply fixing it meant -the CRC of about half of the VPP API messages would be altered for no reason which would result in a significant -amount of pain to the consumers of VPP. A message CRC is just an opague number for anyone using it, and the -only property of it for the user is that the messages with the same value of CRC have the same layout on the wire -with a sufficiently high certainty. - -Therefore a fix ([9f84e70c6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9f84e70c6)) was merged that also -contained a "band-aid" to avoid this pain. In addition to fixing the CRC generation algorithm, the fix captured -the "new" CRC values for those messages that had their CRCs arbitrarily changed by this fix and created a substituion -table with [message name, new CRC, old CRC] triplets. For a given message, if the CRC matched the recorded new -value, the code would substitute it with the old value, thus trading in a reduction in collision resistance -(two values of CRC out of 2^32 space) for not forcing users to adapt to several hundred of messages which changed -the CRCs. - -This band-aid also had the property that whenever a message did change the definition, it would automatically get -a "correct" calculation of CRC32 and no longer use the slot in the table. The table naturally shrinks over -time, thus allowing a painless transition, while also preserving the integrity check for the affected messages. -If any fields changed, the CRC would no longer match the "new" value thus no substitution would be made. Since the -choice of CRC32 is just an implementation detail which is supposed to be opaque to the user, the band-aid was deemed -a reasonable approach to avoid a major burden on VPP consumers. - -However, in practice this solution was not accepted well. After a notification period, the API CRC Substitution table -was removed by the patch ([da1b76aa8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=da1b76aa8)). Thus all of the -API CRC changes that did not happen in 9f84e70c6, happened in da1b76aa8. Hopefully the notification of these changes -has reduced the inconvenience. VPP users are asked to not rely on any other property of the message CRC other than -changes to its value when the message layout changes. - -## Features - -- Binary API Compiler for Python - - Support an 'autoendian' keyword for message definitions in .api files ([9302cfea9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9302cfea9)) -- Build System - - Make rpath optional ([2c91922eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2c91922eb)) -- Infrastructure Library - - Add option to use libexecinfo ([67d7acd05](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=67d7acd05)) - - Add bihash with 32 byte key ([f613a4402](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f613a4402)) - - Add missing %o ([04a14133c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=04a14133c)) -- Plugins - - ARPing CLI - - Add arping command ([a77ae4708](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a77ae4708)) - - AVF Device driver - - Add avf flow framework ([ffe9a5489](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ffe9a5489)) - - CNat - - Add maglev support ([4d237874e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4d237874e)) - - Add input feature node ([cc9a1a0d3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cc9a1a0d3)) - - Add calico/k8s src policy ([516b0adf6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=516b0adf6)) - - Crypto - ipsecmb - - Add support for AES CTR ([fe7ff320b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fe7ff320b)) - - DPDK - - Rebase cryptodev engine for DPDK 20.11 ([25f371ee0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=25f371ee0)) - - Allow configure individual VMBUS devices ([982272974](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=982272974)) - - Implement interrupt mode ([19ff0c369](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=19ff0c369)) - - IPv6 Segment Routing Flow-Based Dynamic Proxy - - SRv6 Per-Flow Dynamic Proxy ([ed7c62a30](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ed7c62a30)) - - Internet Key Exchange (IKEv2) Protocol - - Use new counters data model & add more counters ([fab5e7f39](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fab5e7f39)) - - Add per SA stats ([68d275356](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=68d275356)) - - Support responder hostname ([af2cc6425](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=af2cc6425)) - - NAT - - 1:1 policy NAT ([18327be5d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=18327be5d)) - - Pnat copy and clear byte instructions ([ab3151c52](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ab3151c52)) - - QUIC protocol - - Quicly v0.1.2 update ([2e4523816](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2e4523816)) - - Update quicly to v0.1.3 ([db36fda74](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=db36fda74)) - - RDMA (ibverb) driver - - Add support for RSS configuration ([f5a45680e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f5a45680e)) - - SRTP - - Basic implementation based on libsrtp2 ([6621abf49](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6621abf49)) - - TCP MSS Clamping - - TCP MSS clamping plugin ([bf55e9931](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bf55e9931)) - - Linux-cp - - Linux Interface Mirroring for Control Plane Integration ([44db1caef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=44db1caef)) - - Memif device driver - - Adapt to new rxq framework ([755941865](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=755941865)) - - Performance counter - - New perfmon plugin ([8b60fb0fe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8b60fb0fe)) -- Python binding for the VPP API - - Expose vpp\_papi version to client ([b552ff2e9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b552ff2e9)) -- SVM Library - - Allow mq attachments at random offsets ([b46241889](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b46241889)) - - Per app rx message queues ([41d5f541d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=41d5f541d)) -- Statistics Segment - - Adding symlinks for nodes and interfaces in the stat segment ([db0238090](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=db0238090)) - - Memory heap counters ([a606d9210](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a606d9210)) -- VNET - - Crypto Infra - - Add support for aes-ctr+sha-1 chains ([40ee2003b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=40ee2003b)) - - Support hashing operations ([06111a837](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=06111a837)) - - Add chacha20-poly1305 support to ipsecmb ([106e24bd9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=106e24bd9)) - - FIB - - Allow the creation of new source on the API ([976b259be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=976b259be)) - - FLOW - - Add API implementation of IP4/IP6, IP4\_VXLAN/IP6\_VXLAN ([c7e7819ad](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c7e7819ad)) - - IPIP - - Support MPLS over IP ([e294de6f8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e294de6f8)) - - IPSec - - Support MPLS over IPSec[46] interface ([4a58e49cf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4a58e49cf)) - - Add support for AES CTR ([490b92738](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=490b92738)) - - CLI improvement for udp port encap ([048189e7a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=048189e7a)) - - Use the new tunnel API types to add flow label and TTL copy support ([c7eaa711f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c7eaa711f)) - - Use the new tunnel API types to add flow label and TTL copy support ([9ec846c26](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9ec846c26)) - - Support async mode per-SA ([f16e9a550](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f16e9a550)) - - IPv4 LPM - - Add API to retrieve IPv6 link-layer address ([58a1915b5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58a1915b5)) - - Router ID included in flow hash ([3d5f08a82](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3d5f08a82)) - - Path MTU ([8f5fef2c7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8f5fef2c7)) - - Extend punt CLI for exception packets ([45723b8d3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=45723b8d3)) - - Extend show cmd of ip reassembly configuration ([74a4a70ef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=74a4a70ef)) - - Interface Common - - RX/TX direction type in API ([6a999d67d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6a999d67d)) - - Add promisc on/off in api ([fd0b399ff](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fd0b399ff)) - - L2 - - Add per bridge domain learn limit ([5f93e3b7f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5f93e3b7f)) - - Separating scan-delay and learn-limit into a separate API from want\_l2\_macs\_events ([0f8d10035](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0f8d10035)) - - Session Layer - - Basic support for interrupt mode ([7da8829d8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7da8829d8)) - - Api to update connection attributes ([04ae8273f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=04ae8273f)) - - TLS and TLS engine plugins - - Dtls initial implementation ([4b47ee26c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4b47ee26c)) - - Vhost User Driver - - Add event index for interrupt notification to driver ([27ba5008a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=27ba5008a)) - - Tunnel - - Support copying TTL and flow label from inner to outer ([a91cb4590](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a91cb4590)) -- VPP Comms Library - - Extended connect/listen configuration ([4ac258497](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4ac258497)) -- Libmemif - - Set next free buffer ([47e68de22](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=47e68de22)) - - Set data offset for memif buffer ([1421748e3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1421748e3)) - -## Known issues - -### Coverity Issues - -Starting with this release, we add the section about the section with the unresolved Coverity Issues -into the Release Notes. In order to view the issues, visit https://scan.coverity.com/, add -yourself to fd.io VPP project and click on the matching IDs. - -#### Plugin - PPPoE: - * BUG 218437 in function: pppoe_input_node_fn, file: /src/plugins/pppoe/pppoe_decap.c - * BUG 218401 in function: pppoe_input_node_fn, file: /src/plugins/pppoe/pppoe_decap.c -#### VNET - IP6 Neighbor Discovery: - * BUG 218382 in function: set_ip6_nd_proxy_cmd, file: /src/vnet/ip6-nd/ip6_nd_proxy.c -#### Plugin - TCP MSS Clamping: - * BUG 219550 in function: vl_api_mss_clamp_enable_disable_t_handler, file: /src/plugins/mss_clamp/mss_clamp_api.c -#### Plugin - performance counter: - * BUG 216295 in function: format_text_cell, file: /src/plugins/perfmon/table.c - * BUG 218459 in function: intel_uncore_init, file: /src/plugins/perfmon/intel/uncore.c - * BUG 216249 in function: perfmon_reset, file: /src/plugins/perfmon/perfmon.c -#### Plugin - DPDK: - * BUG 220290 in function: dpdk_lib_init, file: /src/plugins/dpdk/device/init.c - * BUG 220289 in function: dpdk_lib_init, file: /src/plugins/dpdk/device/init.c - * BUG 220105 in function: cryptodev_get_common_capabilities, file: /src/plugins/dpdk/cryptodev/cryptodev.c -#### VNET IPv4 LPM: - * BUG 216981 in function: icmp_to_icmp6, file: /src/vnet/ip/ip4_to_ip6.h - * BUG 214755 in function: ip_in_out_acl_inline, file: /src/vnet/ip/ip_in_out_acl.c - * BUG 220099 in function: vl_api_ip_route_lookup_v2_t_handler, file: /src/vnet/ip/ip_api.c -#### Plugin - Unit Tests: - * BUG 218446 in function: test_crypto_perf, file: /src/plugins/unittest/crypto_test.c -#### Plugin - NSH: - * BUG 218432 in function: nsh_add_del_entry, file: /src/plugins/nsh/nsh_api.c -#### Vector Library - PCI: - * BUG 218391 in function: vlib_pci_device_open, file: /src/vlib/linux/pci.c - * BUG 218396 in function: linux_pci_init, file: /src/vlib/linux/pci.c -#### VNET Segment Routing (IPv6 and MPLS): - * BUG 218375 in function: sr_policy_del, file: /src/vnet/srv6/sr_policy_rewrite.c - * BUG 218409 in function: sr_steering_policy, file: /src/vnet/srv6/sr_steering.c - * BUG 218427 in function: sr_policy_mod, file: /src/vnet/srv6/sr_policy_rewrite.c - * BUG 180995 in function: sr_mpls_policy_assign_endpoint_color, file: /src/vnet/srmpls/sr_mpls_policy.c -#### Vector Library: - * BUG 218552 in function: add_sub_command, file: /src/vlib/cli.c -#### VNET FIB: - * BUG 216057 in function: fib_sas6_get, file: /src/vnet/fib/fib_sas.c -#### VNET Ethernet: - * BUG 214973 in function: ethernet_input_inline, file: /src/vnet/ethernet/node.c - * BUG 218549 in function: identify_subint, file: /src/vnet/ethernet/node.c -#### Infrastructure Library: - * BUG 236112 in function: extract_bits, file: /src/vppinfra/clib.h -#### Binary API Compiler for C and C++: - * BUG 236138 in function: test_loopbacks_2, file: /src/vpp-api/vapi/vapi_cpp_test.cpp - * BUG 236140 in function: test_loopbacks_1, file: /src/vpp-api/vapi/vapi_cpp_test.cpp - * BUG 236139 in function: Create_loopback_cb, file: /src/vpp-api/vapi/vapi_cpp_test.cpp - * BUG 236136 in function: test_api_strings, file: /src/vpp-api/vapi/vapi_c_test.c - * BUG 236137 in function: Delete_loopback_cb, file: /src/vpp-api/vapi/vapi_cpp_test.cpp -#### Plugin - IPv6 Segment Routing Masquerading Proxy: - * BUG 218441 in function: srv6_am_localsid_removal_fn, file: /src/plugins/srv6-am/am.c -#### VNET Policer: - * BUG 218398 in function: show_policer_command_fn, file: /src/vnet/policer/policer.c -#### Plugin - DHCP: - * BUG 218381 in function: dhcpv6_proxy_to_client_input, file: /src/plugins/dhcp/dhcp6_proxy_node.c -#### Plugin - IOAM: - * BUG 216232 in function: ioam_cache_ts_table_destroy, file: /src/plugins/ioam/ip6/ioam_cache.h -#### VNET IPv6 LPM: - * BUG 216981 in function: icmp_to_icmp6, file: /src/vnet/ip/ip4_to_ip6.h - * BUG 214755 in function: ip_in_out_acl_inline, file: /src/vnet/ip/ip_in_out_acl.c - * BUG 220099 in function: vl_api_ip_route_lookup_v2_t_handler, file: /src/vnet/ip/ip_api.c - -### Jira Issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Fixed issues - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=master) - - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. -* _Message CRC32 fix_: please refer to release highlights for description. - -Message Name | Result --------------------------------------------------------------|------------------ -abf_policy_add_del | message CRC32 fix -abf_policy_details | message CRC32 fix -acl_add_replace | message CRC32 fix -acl_details | message CRC32 fix -af_xdp_create | definition changed -arping | only in image -arping_reply | only in image -bd_ip_mac_add_del | message CRC32 fix -bd_ip_mac_details | message CRC32 fix -bfd_udp_add | message CRC32 fix -bfd_udp_auth_activate | message CRC32 fix -bfd_udp_auth_deactivate | message CRC32 fix -bfd_udp_del | message CRC32 fix -bfd_udp_get_echo_source_reply | message CRC32 fix -bfd_udp_mod | message CRC32 fix -bfd_udp_session_details | message CRC32 fix -bfd_udp_session_event | only in image -bfd_udp_session_set_flags | message CRC32 fix -bier_disp_entry_add_del | message CRC32 fix -bier_disp_entry_details | message CRC32 fix -bier_route_add_del | message CRC32 fix -bier_route_details | message CRC32 fix -bond_create | message CRC32 fix -bond_enslave | message CRC32 fix -bridge_domain_details | message CRC32 fix -bridge_domain_set_default_learn_limit | only in image -bridge_domain_set_default_learn_limit_reply | only in image -bridge_domain_set_learn_limit | only in image -bridge_domain_set_learn_limit_reply | only in image -cnat_add_del_snat_prefix | only in file -cnat_add_del_snat_prefix_reply | only in file -cnat_session_details | definition changed -cnat_set_snat_policy | only in image -cnat_set_snat_policy_reply | only in image -cnat_snat_policy_add_del_exclude_pfx | only in image -cnat_snat_policy_add_del_exclude_pfx_reply | only in image -cnat_snat_policy_add_del_if | only in image -cnat_snat_policy_add_del_if_reply | only in image -cnat_translation_details | definition changed -cnat_translation_update | definition changed -cop_interface_enable_disable | only in file -cop_interface_enable_disable_reply | only in file -cop_whitelist_enable_disable | only in file -cop_whitelist_enable_disable_reply | only in file -create_subif | message CRC32 fix -create_vhost_user_if_v2 | only in image -create_vhost_user_if_v2_reply | only in image -dhcp6_pd_reply_event | message CRC32 fix -dhcp6_pd_send_client_message | message CRC32 fix -dhcp6_reply_event | message CRC32 fix -dhcp6_send_client_message | message CRC32 fix -dhcp_client_config | message CRC32 fix -dhcp_client_details | message CRC32 fix -dhcp_compl_event | message CRC32 fix -dhcp_proxy_config | message CRC32 fix -dhcp_proxy_details | message CRC32 fix -dslite_add_del_pool_addr_range | message CRC32 fix -dslite_get_aftr_addr_reply | message CRC32 fix -dslite_get_b4_addr_reply | message CRC32 fix -dslite_set_aftr_addr | message CRC32 fix -dslite_set_b4_addr | message CRC32 fix -fib_source_add | only in image -fib_source_add_reply | only in image -fib_source_details | only in image -fib_source_dump | only in image -flow_add | definition changed -gbp_bridge_domain_add | message CRC32 fix -gbp_bridge_domain_details | message CRC32 fix -gbp_contract_add_del | message CRC32 fix -gbp_contract_details | message CRC32 fix -gbp_endpoint_add | message CRC32 fix -gbp_endpoint_details | message CRC32 fix -gbp_endpoint_group_add | message CRC32 fix -gbp_endpoint_group_details | message CRC32 fix -gbp_ext_itf_add_del | message CRC32 fix -gbp_ext_itf_details | message CRC32 fix -gbp_route_domain_add | message CRC32 fix -gbp_route_domain_details | message CRC32 fix -gbp_subnet_add_del | message CRC32 fix -gbp_subnet_details | message CRC32 fix -geneve_add_del_tunnel | message CRC32 fix -geneve_tunnel_details | message CRC32 fix -gpe_add_del_fwd_entry | message CRC32 fix -gpe_add_del_native_fwd_rpath | message CRC32 fix -gpe_fwd_entries_get_reply | message CRC32 fix -gpe_fwd_entry_path_details | message CRC32 fix -gpe_native_fwd_rpaths_get_reply | message CRC32 fix -gre_tunnel_add_del | message CRC32 fix -gre_tunnel_details | message CRC32 fix -gtpu_add_del_tunnel | message CRC32 fix -gtpu_tunnel_details | message CRC32 fix -gtpu_tunnel_update_tteid | message CRC32 fix -igmp_details | message CRC32 fix -igmp_event | message CRC32 fix -igmp_group_prefix_details | message CRC32 fix -igmp_group_prefix_set | message CRC32 fix -igmp_listen | message CRC32 fix -ikev2_sa_details | definition changed -ikev2_set_responder_hostname | only in image -ikev2_set_responder_hostname_reply | only in image -ioam_export_ip6_enable_disable | message CRC32 fix -ip6_add_del_address_using_prefix | message CRC32 fix -ip6_ra_event | message CRC32 fix -ip6nd_proxy_add_del | message CRC32 fix -ip6nd_proxy_details | message CRC32 fix -ip_address_details | message CRC32 fix -ip_container_proxy_add_del | message CRC32 fix -ip_container_proxy_details | message CRC32 fix -ip_neighbor_add_del | message CRC32 fix -ip_neighbor_details | message CRC32 fix -ip_neighbor_dump | message CRC32 fix -ip_neighbor_event | message CRC32 fix -ip_path_mtu_details | only in image -ip_path_mtu_get | only in image -ip_path_mtu_get_reply | only in image -ip_path_mtu_replace_begin | only in image -ip_path_mtu_replace_begin_reply | only in image -ip_path_mtu_replace_end | only in image -ip_path_mtu_replace_end_reply | only in image -ip_path_mtu_update | only in image -ip_path_mtu_update_reply | only in image -ip_punt_redirect | message CRC32 fix -ip_punt_redirect_details | message CRC32 fix -ip_reassembly_enable_disable | message CRC32 fix -ip_route_add_del | message CRC32 fix -ip_route_add_del_v2 | only in image -ip_route_add_del_v2_reply | only in image -ip_route_details | message CRC32 fix -ip_route_lookup | message CRC32 fix -ip_route_lookup_reply | message CRC32 fix -ip_route_lookup_v2 | only in image -ip_route_lookup_v2_reply | only in image -ip_route_v2_details | only in image -ip_route_v2_dump | only in image -ip_source_and_port_range_check_add_del | message CRC32 fix -ip_unnumbered_details | message CRC32 fix -ipfix_exporter_details | message CRC32 fix -ipip_6rd_add_tunnel | message CRC32 fix -ipip_add_tunnel | message CRC32 fix -ipip_tunnel_details | message CRC32 fix -ipsec_sa_details | message CRC32 fix -ipsec_sa_v3_details | only in image -ipsec_sa_v3_dump | only in image -ipsec_sad_entry_add_del | message CRC32 fix -ipsec_sad_entry_add_del_v3 | only in image -ipsec_sad_entry_add_del_v3_reply | only in image -ipsec_spd_details | message CRC32 fix -ipsec_spd_entry_add_del | message CRC32 fix -ipsec_tunnel_if_add_del | only in file -ipsec_tunnel_if_add_del_reply | only in file -ipsec_tunnel_if_set_sa | only in file -ipsec_tunnel_if_set_sa_reply | only in file -ipsec_tunnel_protect_del | message CRC32 fix -ipsec_tunnel_protect_details | message CRC32 fix -ipsec_tunnel_protect_update | message CRC32 fix -l2_arp_term_event | message CRC32 fix -l2_fib_table_details | message CRC32 fix -l2_interface_pbb_tag_rewrite | message CRC32 fix -l2_macs_event | message CRC32 fix -l2_patch_add_del | message CRC32 fix -l2_xconnect_details | message CRC32 fix -l2fib_add_del | message CRC32 fix -l2fib_set_scan_delay | only in image -l2fib_set_scan_delay_reply | only in image -l2tpv3_create_tunnel | message CRC32 fix -l3xc_details | message CRC32 fix -l3xc_update | message CRC32 fix -lb_add_del_as | message CRC32 fix -lb_add_del_vip | message CRC32 fix -lb_as_details | message CRC32 fix -lb_conf | message CRC32 fix -lb_vip_details | message CRC32 fix -lb_vip_dump | message CRC32 fix -lisp_add_del_adjacency | message CRC32 fix -lisp_add_del_local_eid | message CRC32 fix -lisp_add_del_map_resolver | message CRC32 fix -lisp_add_del_map_server | message CRC32 fix -lisp_add_del_remote_mapping | message CRC32 fix -lisp_adjacencies_get_reply | message CRC32 fix -lisp_eid_table_details | message CRC32 fix -lisp_eid_table_dump | message CRC32 fix -lisp_locator_details | message CRC32 fix -lisp_map_resolver_details | message CRC32 fix -lisp_map_server_details | message CRC32 fix -lisp_use_petr | message CRC32 fix -log_details | message CRC32 fix -macip_acl_add | message CRC32 fix -macip_acl_add_replace | message CRC32 fix -macip_acl_details | message CRC32 fix -mactime_add_del_range | message CRC32 fix -mactime_details | message CRC32 fix -map_add_domain | message CRC32 fix -map_domain_details | message CRC32 fix -map_param_add_del_pre_resolve | message CRC32 fix -map_param_get_reply | message CRC32 fix -memif_details | message CRC32 fix -mfib_signal_details | message CRC32 fix -modify_vhost_user_if_v2 | only in image -modify_vhost_user_if_v2_reply | only in image -mpls_ip_bind_unbind | message CRC32 fix -mpls_route_add_del | message CRC32 fix -mpls_route_details | message CRC32 fix -mpls_tunnel_add_del | message CRC32 fix -mpls_tunnel_details | message CRC32 fix -mss_clamp_details | only in image -mss_clamp_enable_disable | only in image -mss_clamp_enable_disable_reply | only in image -mss_clamp_get | only in image -mss_clamp_get_reply | only in image -nat44_add_del_address_range | message CRC32 fix -nat44_add_del_identity_mapping | message CRC32 fix -nat44_add_del_interface_addr | message CRC32 fix -nat44_add_del_lb_static_mapping | message CRC32 fix -nat44_add_del_static_mapping | message CRC32 fix -nat44_address_details | message CRC32 fix -nat44_del_session | message CRC32 fix -nat44_ed_plugin_enable_disable | only in image -nat44_ed_plugin_enable_disable_reply | only in image -nat44_ed_set_fq_options | only in image -nat44_ed_set_fq_options_reply | only in image -nat44_ed_show_fq_options | only in image -nat44_ed_show_fq_options_reply | only in image -nat44_ei_add_del_address_range | only in image -nat44_ei_add_del_address_range_reply | only in image -nat44_ei_add_del_identity_mapping | only in image -nat44_ei_add_del_identity_mapping_reply | only in image -nat44_ei_add_del_interface_addr | only in image -nat44_ei_add_del_interface_addr_reply | only in image -nat44_ei_add_del_static_mapping | only in image -nat44_ei_add_del_static_mapping_reply | only in image -nat44_ei_address_details | only in image -nat44_ei_address_dump | only in image -nat44_ei_del_session | only in image -nat44_ei_del_session_reply | only in image -nat44_ei_del_user | only in image -nat44_ei_del_user_reply | only in image -nat44_ei_forwarding_enable_disable | only in image -nat44_ei_forwarding_enable_disable_reply | only in image -nat44_ei_get_addr_and_port_alloc_alg | only in image -nat44_ei_get_addr_and_port_alloc_alg_reply | only in image -nat44_ei_get_mss_clamping | only in image -nat44_ei_get_mss_clamping_reply | only in image -nat44_ei_ha_flush | only in image -nat44_ei_ha_flush_reply | only in image -nat44_ei_ha_get_failover | only in image -nat44_ei_ha_get_failover_reply | only in image -nat44_ei_ha_get_listener | only in image -nat44_ei_ha_get_listener_reply | only in image -nat44_ei_ha_resync | only in image -nat44_ei_ha_resync_completed_event | only in image -nat44_ei_ha_resync_reply | only in image -nat44_ei_ha_set_failover | only in image -nat44_ei_ha_set_failover_reply | only in image -nat44_ei_ha_set_listener | only in image -nat44_ei_ha_set_listener_reply | only in image -nat44_ei_identity_mapping_details | only in image -nat44_ei_identity_mapping_dump | only in image -nat44_ei_interface_add_del_feature | only in image -nat44_ei_interface_add_del_feature_reply | only in image -nat44_ei_interface_add_del_output_feature | only in image -nat44_ei_interface_add_del_output_feature_reply | only in image -nat44_ei_interface_addr_details | only in image -nat44_ei_interface_addr_dump | only in image -nat44_ei_interface_details | only in image -nat44_ei_interface_dump | only in image -nat44_ei_interface_output_feature_details | only in image -nat44_ei_interface_output_feature_dump | only in image -nat44_ei_ipfix_enable_disable | only in image -nat44_ei_ipfix_enable_disable_reply | only in image -nat44_ei_plugin_enable_disable | only in image -nat44_ei_plugin_enable_disable_reply | only in image -nat44_ei_set_addr_and_port_alloc_alg | only in image -nat44_ei_set_addr_and_port_alloc_alg_reply | only in image -nat44_ei_set_fq_options | only in image -nat44_ei_set_fq_options_reply | only in image -nat44_ei_set_log_level | only in image -nat44_ei_set_log_level_reply | only in image -nat44_ei_set_mss_clamping | only in image -nat44_ei_set_mss_clamping_reply | only in image -nat44_ei_set_timeouts | only in image -nat44_ei_set_timeouts_reply | only in image -nat44_ei_set_workers | only in image -nat44_ei_set_workers_reply | only in image -nat44_ei_show_fq_options | only in image -nat44_ei_show_fq_options_reply | only in image -nat44_ei_show_running_config | only in image -nat44_ei_show_running_config_reply | only in image -nat44_ei_static_mapping_details | only in image -nat44_ei_static_mapping_dump | only in image -nat44_ei_user_details | only in image -nat44_ei_user_dump | only in image -nat44_ei_user_session_details | only in image -nat44_ei_user_session_dump | only in image -nat44_ei_worker_details | only in image -nat44_ei_worker_dump | only in image -nat44_identity_mapping_details | message CRC32 fix -nat44_interface_addr_details | message CRC32 fix -nat44_lb_static_mapping_add_del_local | message CRC32 fix -nat44_lb_static_mapping_details | message CRC32 fix -nat44_static_mapping_details | message CRC32 fix -nat44_user_session_details | message CRC32 fix -nat64_add_del_pool_addr_range | message CRC32 fix -nat64_add_del_static_bib | message CRC32 fix -nat64_bib_details | message CRC32 fix -nat64_st_details | message CRC32 fix -nat66_add_del_static_mapping | message CRC32 fix -nat66_plugin_enable_disable | only in image -nat66_plugin_enable_disable_reply | only in image -nat66_static_mapping_details | message CRC32 fix -nat_det_add_del_map | message CRC32 fix -nat_det_close_session_in | message CRC32 fix -nat_det_close_session_out | message CRC32 fix -nat_det_map_details | message CRC32 fix -nsh_add_del_map | message CRC32 fix -nsh_map_details | message CRC32 fix -nsim_cross_connect_enable_disable | message CRC32 fix -one_add_del_adjacency | message CRC32 fix -one_add_del_l2_arp_entry | message CRC32 fix -one_add_del_local_eid | message CRC32 fix -one_add_del_map_resolver | message CRC32 fix -one_add_del_map_server | message CRC32 fix -one_add_del_ndp_entry | message CRC32 fix -one_add_del_remote_mapping | message CRC32 fix -one_adjacencies_get_reply | message CRC32 fix -one_eid_table_details | message CRC32 fix -one_eid_table_dump | message CRC32 fix -one_l2_arp_entries_get_reply | message CRC32 fix -one_locator_details | message CRC32 fix -one_map_resolver_details | message CRC32 fix -one_map_server_details | message CRC32 fix -one_ndp_entries_get_reply | message CRC32 fix -one_stats_details | message CRC32 fix -one_use_petr | message CRC32 fix -p2p_ethernet_add | message CRC32 fix -p2p_ethernet_del | message CRC32 fix -pipe_create_reply | message CRC32 fix -pipe_details | message CRC32 fix -pnat_binding_add | only in image -pnat_binding_add_reply | only in image -pnat_binding_attach | only in image -pnat_binding_attach_reply | only in image -pnat_binding_del | only in image -pnat_binding_del_reply | only in image -pnat_binding_detach | only in image -pnat_binding_detach_reply | only in image -pnat_bindings_details | only in image -pnat_bindings_get | only in image -pnat_bindings_get_reply | only in image -pnat_interfaces_details | only in image -pnat_interfaces_get | only in image -pnat_interfaces_get_reply | only in image -policer_add_del | message CRC32 fix -policer_bind | only in image -policer_bind_reply | only in image -policer_details | message CRC32 fix -policer_input | only in image -policer_input_reply | only in image -pppoe_add_del_session | message CRC32 fix -pppoe_session_details | message CRC32 fix -proxy_arp_add_del | message CRC32 fix -proxy_arp_details | message CRC32 fix -punt_socket_deregister | message CRC32 fix -punt_socket_details | message CRC32 fix -punt_socket_register | message CRC32 fix -qos_record_details | message CRC32 fix -qos_record_enable_disable | message CRC32 fix -qos_store_details | message CRC32 fix -qos_store_enable_disable | message CRC32 fix -rdma_create_v3 | only in image -rdma_create_v3_reply | only in image -session_rule_add_del | message CRC32 fix -session_rules_details | message CRC32 fix -set_ip_flow_hash_router_id | only in image -set_ip_flow_hash_router_id_reply | only in image -set_ip_flow_hash_v2 | only in image -set_ip_flow_hash_v2_reply | only in image -set_ipfix_exporter | message CRC32 fix -set_punt | message CRC32 fix -show_lisp_use_petr_reply | message CRC32 fix -show_one_use_petr_reply | message CRC32 fix -sr_localsid_add_del | message CRC32 fix -sr_localsids_details | message CRC32 fix -sr_mpls_policy_assign_endpoint_color | message CRC32 fix -sr_mpls_steering_add_del | message CRC32 fix -sr_policies_details | message CRC32 fix -sr_policy_add | message CRC32 fix -sr_policy_mod | message CRC32 fix -sr_steering_add_del | message CRC32 fix -sr_steering_pol_details | message CRC32 fix -stn_add_del_rule | message CRC32 fix -stn_rules_details | message CRC32 fix -svs_details | message CRC32 fix -svs_route_add_del | message CRC32 fix -sw_if_l2tpv3_tunnel_details | message CRC32 fix -sw_interface_add_del_address | message CRC32 fix -sw_interface_bond_details | message CRC32 fix -sw_interface_details | message CRC32 fix -sw_interface_event | message CRC32 fix -sw_interface_ip6_get_link_local_address | only in image -sw_interface_ip6_get_link_local_address_reply | only in image -sw_interface_ip6_set_link_local_address | message CRC32 fix -sw_interface_ip6nd_ra_prefix | message CRC32 fix -sw_interface_lacp_details | message CRC32 fix -sw_interface_rx_placement_details | message CRC32 fix -sw_interface_set_flags | message CRC32 fix -sw_interface_set_l2_bridge | message CRC32 fix -sw_interface_set_l2_xconnect | message CRC32 fix -sw_interface_set_lldp | message CRC32 fix -sw_interface_set_mac_address | message CRC32 fix -sw_interface_set_promisc | only in image -sw_interface_set_promisc_reply | only in image -sw_interface_set_rx_mode | message CRC32 fix -sw_interface_set_unnumbered | message CRC32 fix -sw_interface_span_details | message CRC32 fix -sw_interface_span_enable_disable | message CRC32 fix -sw_interface_tap_v2_details | message CRC32 fix -sw_interface_vhost_user_details | message CRC32 fix -sw_interface_virtio_pci_details | message CRC32 fix -syslog_get_sender_reply | message CRC32 fix -syslog_set_sender | message CRC32 fix -tap_create_v2 | message CRC32 fix -tcp_configure_src_addresses | message CRC32 fix -teib_details | message CRC32 fix -teib_entry_add_del | message CRC32 fix -udp_encap_add | message CRC32 fix -udp_encap_details | message CRC32 fix -udp_ping_add_del | message CRC32 fix -virtio_pci_create | message CRC32 fix -vmxnet3_details | message CRC32 fix -vrrp_vr_add_del | message CRC32 fix -vrrp_vr_details | message CRC32 fix -vrrp_vr_peer_details | message CRC32 fix -vrrp_vr_set_peers | message CRC32 fix -vrrp_vr_track_if_add_del | message CRC32 fix -vrrp_vr_track_if_details | message CRC32 fix -vxlan_add_del_tunnel | message CRC32 fix -vxlan_add_del_tunnel_v2 | only in image -vxlan_add_del_tunnel_v2_reply | only in image -vxlan_add_del_tunnel_v3 | only in image -vxlan_add_del_tunnel_v3_reply | only in image -vxlan_gbp_tunnel_add_del | message CRC32 fix -vxlan_gbp_tunnel_details | message CRC32 fix -vxlan_gpe_add_del_tunnel | message CRC32 fix -vxlan_gpe_ioam_export_enable_disable | message CRC32 fix -vxlan_gpe_ioam_transit_disable | message CRC32 fix -vxlan_gpe_ioam_transit_enable | message CRC32 fix -vxlan_gpe_ioam_vni_disable | message CRC32 fix -vxlan_gpe_ioam_vni_enable | message CRC32 fix -vxlan_gpe_tunnel_details | message CRC32 fix -vxlan_offload_rx | message CRC32 fix -vxlan_tunnel_details | message CRC32 fix -vxlan_tunnel_v2_details | only in image -vxlan_tunnel_v2_dump | only in image -want_ip_neighbor_events | message CRC32 fix -want_l2_macs_events2 | only in image -want_l2_macs_events2_reply | only in image - -Found 456 api message signature differences - - -### Newly deprecated API messages - -These messages are still there in the API, but can and probably -will disappear in the next release. - -- application_tls_cert_add -- application_tls_cert_add_reply -- application_tls_key_add -- application_tls_key_add_reply -- create_vhost_user_if -- create_vhost_user_if_reply -- ipsec_sa_details -- ipsec_sa_dump -- ipsec_sad_entry_add_del -- ipsec_sad_entry_add_del_reply -- modify_vhost_user_if -- modify_vhost_user_if_reply -- nat44_ei_add_del_identity_mapping -- nat44_ei_add_del_identity_mapping_reply -- nat44_ei_add_del_interface_addr -- nat44_ei_add_del_interface_addr_reply -- nat44_ei_get_addr_and_port_alloc_alg -- nat44_ei_get_addr_and_port_alloc_alg_reply -- nat44_ei_get_mss_clamping -- nat44_ei_get_mss_clamping_reply -- nat44_ei_ha_get_failover -- nat44_ei_ha_get_failover_reply -- nat44_ei_ha_get_listener -- nat44_ei_ha_get_listener_reply -- nat44_ei_identity_mapping_details -- nat44_ei_identity_mapping_dump -- nat44_ei_interface_add_del_output_feature -- nat44_ei_interface_add_del_output_feature_reply -- nat44_ei_interface_addr_details -- nat44_ei_interface_addr_dump -- nat44_ei_interface_output_feature_details -- nat44_ei_interface_output_feature_dump -- nat44_ei_set_log_level -- nat44_ei_set_log_level_reply -- nat44_forwarding_enable_disable -- nat44_forwarding_enable_disable_reply -- nat44_forwarding_is_enabled -- nat44_forwarding_is_enabled_reply -- nat44_plugin_enable_disable -- nat44_plugin_enable_disable_reply -- nat44_session_cleanup -- nat44_session_cleanup_reply -- nat_control_ping -- nat_control_ping_reply -- nat_get_timeouts -- nat_get_timeouts_reply -- nat_ipfix_enable_disable -- nat_ipfix_enable_disable_reply -- nat_set_log_level -- nat_set_log_level_reply -- nat_set_timeouts -- nat_set_timeouts_reply -- nat_show_config -- nat_show_config_2 -- nat_show_config_2_reply -- nat_show_config_reply -- rdma_create_v2 -- set_ip_flow_hash -- set_ip_flow_hash_reply -- want_l2_macs_events -- want_l2_macs_events_reply - -### In-progress API messages - -These messages are provided for testing and experimentation only. -They are *not* subject to any compatibility process, -and therefore can arbitrarily change or disappear at *any* moment. -Also they may have less than satisfactory testing, making -them unsuitable for other use than the technology preview. -If you are intending to use these messages in production projects, -please collaborate with the feature maintainer on their productization. - -- abf_itf_attach_add_del -- abf_itf_attach_add_del_reply -- abf_itf_attach_details -- abf_itf_attach_dump -- abf_plugin_get_version -- abf_plugin_get_version_reply -- abf_policy_add_del -- abf_policy_add_del_reply -- abf_policy_details -- abf_policy_dump -- adl_allowlist_enable_disable -- adl_allowlist_enable_disable_reply -- adl_interface_enable_disable -- adl_interface_enable_disable_reply -- af_xdp_create -- af_xdp_create_reply -- af_xdp_delete -- af_xdp_delete_reply -- cnat_get_snat_addresses -- cnat_get_snat_addresses_reply -- cnat_session_details -- cnat_session_dump -- cnat_session_purge -- cnat_session_purge_reply -- cnat_set_snat_addresses -- cnat_set_snat_addresses_reply -- cnat_set_snat_policy -- cnat_set_snat_policy_reply -- cnat_snat_policy_add_del_exclude_pfx -- cnat_snat_policy_add_del_exclude_pfx_reply -- cnat_snat_policy_add_del_if -- cnat_snat_policy_add_del_if_reply -- cnat_translation_del -- cnat_translation_del_reply -- cnat_translation_details -- cnat_translation_dump -- cnat_translation_update -- cnat_translation_update_reply -- crypto_sw_scheduler_set_worker -- crypto_sw_scheduler_set_worker_reply -- det44_get_timeouts_reply -- det44_interface_add_del_feature -- det44_interface_add_del_feature_reply -- det44_interface_details -- det44_interface_dump -- det44_plugin_enable_disable -- det44_plugin_enable_disable_reply -- det44_set_timeouts -- det44_set_timeouts_reply -- flow_add -- flow_add_reply -- flow_del -- flow_del_reply -- flow_disable -- flow_disable_reply -- flow_enable -- flow_enable_reply -- gbp_bridge_domain_add -- gbp_bridge_domain_add_reply -- gbp_bridge_domain_del -- gbp_bridge_domain_del_reply -- gbp_bridge_domain_details -- gbp_bridge_domain_dump -- gbp_bridge_domain_dump_reply -- gbp_contract_add_del -- gbp_contract_add_del_reply -- gbp_contract_details -- gbp_contract_dump -- gbp_endpoint_add -- gbp_endpoint_add_reply -- gbp_endpoint_del -- gbp_endpoint_del_reply -- gbp_endpoint_details -- gbp_endpoint_dump -- gbp_endpoint_group_add -- gbp_endpoint_group_add_reply -- gbp_endpoint_group_del -- gbp_endpoint_group_del_reply -- gbp_endpoint_group_details -- gbp_endpoint_group_dump -- gbp_ext_itf_add_del -- gbp_ext_itf_add_del_reply -- gbp_ext_itf_details -- gbp_ext_itf_dump -- gbp_recirc_add_del -- gbp_recirc_add_del_reply -- gbp_recirc_details -- gbp_recirc_dump -- gbp_route_domain_add -- gbp_route_domain_add_reply -- gbp_route_domain_del -- gbp_route_domain_del_reply -- gbp_route_domain_details -- gbp_route_domain_dump -- gbp_route_domain_dump_reply -- gbp_subnet_add_del -- gbp_subnet_add_del_reply -- gbp_subnet_details -- gbp_subnet_dump -- gbp_vxlan_tunnel_add -- gbp_vxlan_tunnel_add_reply -- gbp_vxlan_tunnel_del -- gbp_vxlan_tunnel_del_reply -- gbp_vxlan_tunnel_details -- gbp_vxlan_tunnel_dump -- ikev2_child_sa_details -- ikev2_child_sa_dump -- ikev2_initiate_del_child_sa -- ikev2_initiate_del_child_sa_reply -- ikev2_initiate_del_ike_sa -- ikev2_initiate_del_ike_sa_reply -- ikev2_initiate_rekey_child_sa -- ikev2_initiate_rekey_child_sa_reply -- ikev2_initiate_sa_init -- ikev2_initiate_sa_init_reply -- ikev2_nonce_get -- ikev2_nonce_get_reply -- ikev2_profile_add_del -- ikev2_profile_add_del_reply -- ikev2_profile_details -- ikev2_profile_disable_natt -- ikev2_profile_disable_natt_reply -- ikev2_profile_dump -- ikev2_profile_set_auth -- ikev2_profile_set_auth_reply -- ikev2_profile_set_id -- ikev2_profile_set_id_reply -- ikev2_profile_set_ipsec_udp_port -- ikev2_profile_set_ipsec_udp_port_reply -- ikev2_profile_set_liveness -- ikev2_profile_set_liveness_reply -- ikev2_profile_set_ts -- ikev2_profile_set_ts_reply -- ikev2_profile_set_udp_encap -- ikev2_profile_set_udp_encap_reply -- ikev2_sa_details -- ikev2_sa_dump -- ikev2_set_esp_transforms -- ikev2_set_esp_transforms_reply -- ikev2_set_ike_transforms -- ikev2_set_ike_transforms_reply -- ikev2_set_local_key -- ikev2_set_local_key_reply -- ikev2_set_responder -- ikev2_set_responder_hostname -- ikev2_set_responder_hostname_reply -- ikev2_set_responder_reply -- ikev2_set_sa_lifetime -- ikev2_set_sa_lifetime_reply -- ikev2_set_tunnel_interface -- ikev2_set_tunnel_interface_reply -- ikev2_traffic_selector_details -- ikev2_traffic_selector_dump -- ip_route_add_del_v2 -- ip_route_add_del_v2_reply -- ip_route_lookup_v2 -- ip_route_lookup_v2_reply -- ip_route_v2_details -- ip_route_v2_dump -- l2_emulation -- l2_emulation_reply -- mdata_enable_disable -- mdata_enable_disable_reply -- nat44_add_del_static_mapping_v2 -- nat44_add_del_static_mapping_v2_reply -- nat44_ed_plugin_enable_disable -- nat44_ed_plugin_enable_disable_reply -- nat44_ed_set_fq_options -- nat44_ed_set_fq_options_reply -- nat44_ed_show_fq_options -- nat44_ed_show_fq_options_reply -- nat44_ei_add_del_address_range -- nat44_ei_add_del_address_range_reply -- nat44_ei_add_del_static_mapping -- nat44_ei_add_del_static_mapping_reply -- nat44_ei_address_details -- nat44_ei_address_dump -- nat44_ei_del_session -- nat44_ei_del_session_reply -- nat44_ei_del_user -- nat44_ei_del_user_reply -- nat44_ei_forwarding_enable_disable -- nat44_ei_forwarding_enable_disable_reply -- nat44_ei_ha_flush -- nat44_ei_ha_flush_reply -- nat44_ei_ha_resync -- nat44_ei_ha_resync_completed_event -- nat44_ei_ha_resync_reply -- nat44_ei_ha_set_failover -- nat44_ei_ha_set_failover_reply -- nat44_ei_ha_set_listener -- nat44_ei_ha_set_listener_reply -- nat44_ei_interface_add_del_feature -- nat44_ei_interface_add_del_feature_reply -- nat44_ei_interface_details -- nat44_ei_interface_dump -- nat44_ei_ipfix_enable_disable -- nat44_ei_ipfix_enable_disable_reply -- nat44_ei_plugin_enable_disable -- nat44_ei_plugin_enable_disable_reply -- nat44_ei_set_addr_and_port_alloc_alg -- nat44_ei_set_addr_and_port_alloc_alg_reply -- nat44_ei_set_fq_options -- nat44_ei_set_fq_options_reply -- nat44_ei_set_mss_clamping -- nat44_ei_set_mss_clamping_reply -- nat44_ei_set_timeouts -- nat44_ei_set_timeouts_reply -- nat44_ei_set_workers -- nat44_ei_set_workers_reply -- nat44_ei_show_fq_options -- nat44_ei_show_fq_options_reply -- nat44_ei_show_running_config -- nat44_ei_show_running_config_reply -- nat44_ei_static_mapping_details -- nat44_ei_static_mapping_dump -- nat44_ei_user_details -- nat44_ei_user_dump -- nat44_ei_user_session_details -- nat44_ei_user_session_dump -- nat44_ei_worker_details -- nat44_ei_worker_dump -- nat44_show_running_config -- nat44_show_running_config_reply -- nat64_plugin_enable_disable -- nat64_plugin_enable_disable_reply -- oddbuf_enable_disable -- oddbuf_enable_disable_reply -- pg_interface_enable_disable_coalesce -- pg_interface_enable_disable_coalesce_reply -- pnat_binding_add -- pnat_binding_add_reply -- pnat_binding_attach -- pnat_binding_attach_reply -- pnat_binding_del -- pnat_binding_del_reply -- pnat_binding_detach -- pnat_binding_detach_reply -- pnat_bindings_details -- pnat_bindings_get -- pnat_bindings_get_reply -- pnat_interfaces_details -- pnat_interfaces_get -- pnat_interfaces_get_reply -- sample_macswap_enable_disable -- sample_macswap_enable_disable_reply -- sr_policies_with_sl_index_details -- sr_policies_with_sl_index_dump -- sw_interface_set_vxlan_gbp_bypass -- sw_interface_set_vxlan_gbp_bypass_reply -- test_addresses -- test_addresses2 -- test_addresses2_reply -- test_addresses3 -- test_addresses3_reply -- test_addresses_reply -- test_empty -- test_empty_reply -- test_enum -- test_enum_reply -- test_interface -- test_interface_reply -- test_prefix -- test_prefix_reply -- test_string -- test_string2 -- test_string2_reply -- test_string_reply -- test_vla -- test_vla2 -- test_vla2_reply -- test_vla3 -- test_vla3_reply -- test_vla4 -- test_vla4_reply -- test_vla5 -- test_vla5_reply -- test_vla_reply -- trace_capture_packets -- trace_capture_packets_reply -- trace_clear_capture -- trace_clear_capture_reply -- trace_details -- trace_dump -- trace_dump_reply -- trace_set_filters -- trace_set_filters_reply -- vxlan_gbp_tunnel_add_del -- vxlan_gbp_tunnel_add_del_reply -- vxlan_gbp_tunnel_details -- vxlan_gbp_tunnel_dump -- wireguard_interface_create -- wireguard_interface_create_reply -- wireguard_interface_delete -- wireguard_interface_delete_reply -- wireguard_interface_details -- wireguard_interface_dump -- wireguard_peer_add -- wireguard_peer_add_reply -- wireguard_peer_remove -- wireguard_peer_remove_reply -- wireguard_peers_details -- wireguard_peers_dump - -### Patches that changed API definitions - -| @c src/vnet/policer/policer_types.api || -| ------- | ------- | -| [c5299ff30](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c5299ff30) | policer: remove SSE2 prefix | - -| @c src/vnet/policer/policer.api || -| ------- | ------- | -| [b04683017](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b04683017) | policer: add api to configure input policing | -| [48e26367c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=48e26367c) | policer: add api to bind policer to worker | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [a5a9efd4d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a5a9efd4d) | vcl session: switch to generic cert key apis | - -| @c src/vnet/ipfix-export/ipfix_export.api || -| ------- | ------- | -| [baa18701b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=baa18701b) | misc: ipfix process node wait time adjustment | - -| @c src/vnet/ipsec/ipsec_types.api || -| ------- | ------- | -| [f16e9a550](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f16e9a550) | ipsec: Support async mode per-SA | -| [9ec846c26](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9ec846c26) | ipsec: Use the new tunnel API types to add flow label and TTL copy support | -| [751bb131e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=751bb131e) | Revert "ipsec: Use the new tunnel API types to add flow label and TTL copy" | -| [c7eaa711f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c7eaa711f) | ipsec: Use the new tunnel API types to add flow label and TTL copy support | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [9ec846c26](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9ec846c26) | ipsec: Use the new tunnel API types to add flow label and TTL copy support | -| [751bb131e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=751bb131e) | Revert "ipsec: Use the new tunnel API types to add flow label and TTL copy" | -| [c7eaa711f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c7eaa711f) | ipsec: Use the new tunnel API types to add flow label and TTL copy support | -| [a9e2774f5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a9e2774f5) | ipsec: Deprecated the old IPsec Tunnel interface | -| [95f59f380](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=95f59f380) | ipsec: Mark the interface create reply deprecated | - -| @c src/vnet/devices/virtio/vhost_user.api || -| ------- | ------- | -| [27ba5008a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=27ba5008a) | vhost: Add event index for interrupt notification to driver | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [976b259be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=976b259be) | fib: Allow the creation of new source on the API | -| [8f5fef2c7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8f5fef2c7) | ip: Path MTU | -| [3d5f08a82](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3d5f08a82) | ip: Router ID included in flow hash | -| [f2984bbb0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f2984bbb0) | ip: use IPv6 flowlabel in flow hash computation | -| [58a1915b5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58a1915b5) | ip: add API to retrieve IPv6 link-layer address | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [0f8d10035](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0f8d10035) | l2: Separating scan-delay and learn-limit into a separate API from want_l2_macs_events | -| [5f93e3b7f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5f93e3b7f) | l2: add per bridge domain learn limit | - -| @c src/vnet/flow/flow_types.api || -| ------- | ------- | -| [91f102ed8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=91f102ed8) | flow: The type of vni in VxLAN flow should be u32 | - -| @c src/vnet/flow/flow.api || -| ------- | ------- | -| [c7e7819ad](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c7e7819ad) | flow: Add API implementation of IP4/IP6, IP4_VXLAN/IP6_VXLAN | - -| @c src/vnet/fib/fib_types.api || -| ------- | ------- | -| [976b259be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=976b259be) | fib: Allow the creation of new source on the API | - -| @c src/vnet/fib/fib.api || -| ------- | ------- | -| [976b259be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=976b259be) | fib: Allow the creation of new source on the API | - -| @c src/vnet/vxlan/vxlan.api || -| ------- | ------- | -| [3e38422ab](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3e38422ab) | vxlan: Fix L3 mode | -| [839dcc0fb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=839dcc0fb) | vxlan: add udp-port configuration support | - -| @c src/vnet/bfd/bfd.api || -| ------- | ------- | -| [4376ab2a9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4376ab2a9) | tests: use socket transport instead of shared memory | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [fd0b399ff](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fd0b399ff) | interface: Add promisc on/off in api | - -| @c src/vnet/tunnel/tunnel_types.api || -| ------- | ------- | -| [a91cb4590](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a91cb4590) | tunnel: support copying TTL and flow label from inner to outer | - -| @c src/vnet/interface_types.api || -| ------- | ------- | -| [6a999d67d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6a999d67d) | interface: RX/TX direction type in API | - -| @c src/vat2/test/vat2_test.api || -| ------- | ------- | -| [ab9f57355](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ab9f57355) | api: crchcecker ignore version < 1.0.0 and outside of src directory | -| [71134f26a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=71134f26a) | vat2: jsonconvert return checking - coverity | -| [93c4b1bb3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=93c4b1bb3) | vppapigen: more _fromjson autogeneration coverity fixes | -| [316967cfa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=316967cfa) | vppapigen: fix coverity issues in jsonconvert | -| [cf0102b3b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cf0102b3b) | vppapigen: coverity issues in autogenerated code pass 3. | -| [fb0afab7f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fb0afab7f) | vppapigen: fix fromjson coverity errors in generation | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [dc22c839f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc22c839f) | tests: clean up gbp calls from vpp_papi_provider | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [9302cfea9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9302cfea9) | vppapigen: Support an 'autoendian' keyword for message definitions in .api files | - -| @c src/plugins/arping/arping.api || -| ------- | ------- | -| [a77ae4708](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a77ae4708) | arping: add arping command | - -| @c src/plugins/linux-cp/lcp.api || -| ------- | ------- | -| [6bb77dec7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bb77dec7) | linux-cp: A V2 variant of pair create API that returns the host interface created | -| [4376ab2a9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4376ab2a9) | tests: use socket transport instead of shared memory | -| [44db1caef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=44db1caef) | linux-cp: Linux Interface Mirroring for Control Plane Integration | - -| @c src/plugins/ikev2/ikev2_types.api || -| ------- | ------- | -| [68d275356](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=68d275356) | ikev2: add per SA stats | - -| @c src/plugins/ikev2/ikev2.api || -| ------- | ------- | -| [af2cc6425](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=af2cc6425) | ikev2: support responder hostname | -| [68d275356](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=68d275356) | ikev2: add per SA stats | -| [fab5e7f39](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fab5e7f39) | ikev2: use new counters data model & add more counters | - -| @c src/plugins/nat/det44/det44.api || -| ------- | ------- | -| [0eaf4e678](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0eaf4e678) | nat: Final NAT44 EI/ED split patch | - -| @c src/plugins/nat/nat44-ed/nat44_ed.api || -| ------- | ------- | -| [e3f078fcf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e3f078fcf) | nat: fix byte order on ipfix message fields | -| [e7a80a98b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e7a80a98b) | nat: NAT44ED fail if using old plugin option | -| [0eaf4e678](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0eaf4e678) | nat: Final NAT44 EI/ED split patch | - -| @c src/plugins/nat/nat64/nat64.api || -| ------- | ------- | -| [0eaf4e678](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0eaf4e678) | nat: Final NAT44 EI/ED split patch | - -| @c src/plugins/nat/nat66/nat66.api || -| ------- | ------- | -| [ed2ee5e57](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ed2ee5e57) | nat: NAT66 plugin enable&disable calls update | -| [0eaf4e678](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0eaf4e678) | nat: Final NAT44 EI/ED split patch | - -| @c src/plugins/nat/pnat/pnat.api || -| ------- | ------- | -| [ec34fb772](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ec34fb772) | pnat: coverity errors | -| [ab3151c52](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ab3151c52) | nat: pnat copy and clear byte instructions | -| [18327be5d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=18327be5d) | nat: 1:1 policy NAT | - -| @c src/plugins/nat/lib/nat_types.api || -| ------- | ------- | -| [0eaf4e678](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0eaf4e678) | nat: Final NAT44 EI/ED split patch | - -| @c src/plugins/nat/nat44-ei/nat44_ei.api || -| ------- | ------- | -| [01930f568](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=01930f568) | nat: report correct EI per-user session limit | -| [e3f078fcf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e3f078fcf) | nat: fix byte order on ipfix message fields | -| [0eaf4e678](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0eaf4e678) | nat: Final NAT44 EI/ED split patch | - -| @c src/plugins/af_xdp/af_xdp.api || -| ------- | ------- | -| [a42c41be4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a42c41be4) | af_xdp: workaround kernel race between poll() and sendmsg() | - -| @c src/plugins/mss_clamp/mss_clamp.api || -| ------- | ------- | -| [bf55e9931](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bf55e9931) | mss_clamp: TCP MSS clamping plugin | - -| @c src/plugins/rdma/rdma.api || -| ------- | ------- | -| [f5a45680e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f5a45680e) | rdma: add support for RSS configuration | - -| @c src/plugins/cnat/cnat.api || -| ------- | ------- | -| [516b0adf6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=516b0adf6) | cnat: Add calico/k8s src policy | -| [3fd77f7de](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3fd77f7de) | cnat: Prepare extended snat policies | -| [cc9a1a0d3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cc9a1a0d3) | cnat: add input feature node | -| [4d237874e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4d237874e) | cnat: Add maglev support | -| [27647a27c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=27647a27c) | cnat: fixes & prepare maglev | - - -@page release_notes_2101 Release notes for VPP 21.01 - -## Release Highlights - -The FD.io VPP 20.09 release comprises more than 562 commits since the previous -release, including 274 fixes. Notable changes in this release were the Virtio -driver adding packet buffering on the transmit path to handle slow back-ends -which often have jitter and delays in free'ing buffers, and also adding support -for Virtio 1.1 packed rings. FD.io VPP IPSEC added support for multi-point on -IPSec interfaces, brings the meshed benefits of IP to IPSec tunnels. The FD.io -VPP Cloud NAT (CNAT), added support source NAT ICMP and DHCP. The FD.io VPP FIB -added support for source address selection (SAS) and flow hashing on the inner -packets. Finally the FD.io VPP Perfmon plugin has been substantially rewritten, -to support measuring bundles of counters, and reporting statistics per graph -node. - -Reflecting the API change policy introduced in the 20.09, please review the -following sections below: -- Newly deprecated API messages: please note that if you are using a deprecated -message, they will soon be removed in a subsequent release. Collaborate with -the feature maintainer on the best approach to mitigate. -- In-progress API messages: They are work-in-progress, and are *not* subject to -the policy, and may change or even be removed at any time. Please collaborate -with the feature maintainer on plans to productize the message before using in -any product. In-progress APIs must eventually become stable or be removed. - -## Features - -- Binary API Libraries - - Vat2 and JSON autogeneration for API messages ([df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092)) -- Plugins - - AF\_XDP driver - - Add option to claim all available RX queues ([d4e109138](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d4e109138)) - - CNat - - Disable default scanner process ([d63f73b83](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d63f73b83)) - - IP ICMP error support ([ece39214b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ece39214b)) - - Add support for SNat ICMP ([613b2c3c7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=613b2c3c7)) - - Introduce parametric source policy ([ce25b60de](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ce25b60de)) - - Add DHCP support ([af897c5e3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=af897c5e3)) - - Crypto - ipsecmb - - Bump to intel-ipsec-mb version 0.55 ([b5df85e24](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b5df85e24)) - - DPDK - - Call the meson-based build instead of Makefiles ([4c4633cad](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4c4633cad)) - - Telemetry thread is off by default. ([83f37fc3b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=83f37fc3b)) - - Bump to DPDK 20.11 ([f0419a0c8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f0419a0c8)) - - Internet Key Exchange (IKEv2) Protocol - - Support IPv6 traffic selectors & overlay ([84962d19b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=84962d19b)) - - CLI for disabling dead peer detection ([af4a414eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=af4a414eb)) - - Add option to disable NAT traversal ([d7fc12f07](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d7fc12f07)) - - RDMA (ibverb) driver - - Add RSS support for IPv6 and TCP ([91603958d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=91603958d)) - - VRRP - - Asynchronous events on VR state change ([78f487e11](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=78f487e11)) - - Wireguard - - Return public key in API ([de22111b5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=de22111b5)) - - Flowprobe - - Add show commands for params and list of interfaces for recording ([d1146f6dd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d1146f6dd)) -- Python binding for the VPP API - - add support for enumflag part 1 of 2 ([3825d93af](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3825d93af)) -- SVM Library - - Support for multi-segment enqueues ([c95cfa218](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c95cfa218)) -- Statistics Segment - - Counters data model ([148c7b768](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=148c7b768)) -- VNET - - FIB - - Source Address Selection ([e2fe09742](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e2fe09742)) - - Adjacency flag for midchain to perfom flow hash (on inner packet) ([5c544c8c3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5c544c8c3)) - - Feature Arcs - - Add packet trace API ([c0b195450](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0b195450)) - - IPSec - - Support for multipoint on IPSec interfaces ([6ba4e41d3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6ba4e41d3)) - - Tunnel SA DSCP behaviour ([041add7d1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=041add7d1)) - - Native Virtio Drivers - - Add packet buffering on transmit path ([e347acbc3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e347acbc3)) - - Virtio: implement packed queues from virtio 1.1 ([b977d3f7c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b977d3f7c)) - - Segment Routing (IPv6 and MPLS) - - Show IPv6 address used as SRv6 Encaps source ([448bc81d3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=448bc81d3)) - - Show the hop-limit value used for SRv6 encapsulation ([80f0b88fc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=80f0b88fc)) - - Session Layer - - Add Unix socket API for app attachment ([61ae056bd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=61ae056bd)) - - Per worker state for ct sessions ([2d0e3de14](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2d0e3de14)) - - TAP Drivers - - Allow change of carrier state on host ([bd50ed18d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bd50ed18d)) - - Add function to set speed ([a6c34a19d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a6c34a19d)) -- VPP Comms Library - - Add support for app socket API ([935ce75cb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=935ce75cb)) - - Provide apps access to fifo chunks ([d68faf855](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d68faf855)) -- VPP Executable - - Use VPP heap for libc ([ec4749a20](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ec4749a20)) -- Vector Library - Buffer Management - - Add page-size config ([61559029d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=61559029d)) - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Fixed issues - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=master) - - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - -Message Name | Result --------------------------------------------------------------|------------------ -classify_pcap_get_tables | only in image -classify_pcap_get_tables_reply | only in image -classify_pcap_lookup_table | only in image -classify_pcap_lookup_table_reply | only in image -classify_pcap_set_table | only in image -classify_pcap_set_table_reply | only in image -classify_trace_get_tables | only in image -classify_trace_get_tables_reply | only in image -classify_trace_lookup_table | only in image -classify_trace_lookup_table_reply | only in image -classify_trace_set_table | only in image -classify_trace_set_table_reply | only in image -cnat_get_snat_addresses | only in image -cnat_get_snat_addresses_reply | only in image -cnat_session_details | definition changed -cnat_set_snat_addresses | definition changed -cnat_translation_details | definition changed -cnat_translation_update | definition changed -det44_plugin_enable_disable | definition changed -graph_node_details | only in image -graph_node_get | only in image -graph_node_get_reply | only in image -ikev2_profile_details | definition changed -ikev2_profile_disable_natt | only in image -ikev2_profile_disable_natt_reply | only in image -ikev2_profile_set_ts | definition changed -ikev2_sa_details | definition changed -ikev2_set_responder | definition changed -ikev2_traffic_selector_details | definition changed -ip_mroute_add_del | definition changed -ip_mroute_details | definition changed -ip_neighbor_event_v2 | only in image -ipsec_sa_v2_details | only in image -ipsec_sa_v2_dump | only in image -ipsec_sad_entry_add_del_v2 | only in image -ipsec_sad_entry_add_del_v2_reply | only in image -nat44_plugin_enable_disable | only in image -nat44_plugin_enable_disable_reply | only in image -nat44_show_running_config | only in image -nat44_show_running_config_reply | only in image -nat64_get_timeouts | only in image -nat64_get_timeouts_reply | only in image -nat64_plugin_enable_disable | only in image -nat64_plugin_enable_disable_reply | only in image -nat64_set_timeouts | only in image -nat64_set_timeouts_reply | only in image -pppoe_add_del_cp | only in image -pppoe_add_del_cp_reply | only in image -rdma_create_v2 | only in image -rdma_create_v2_reply | only in image -sw_vmxnet3_interface_details | only in image -sw_vmxnet3_interface_dump | only in image -trace_capture_packets | only in image -trace_capture_packets_reply | only in image -trace_clear_capture | only in image -trace_clear_capture_reply | only in image -trace_details | definition changed -trace_set_filters | only in image -trace_set_filters_reply | only in image -vrrp_vr_event | only in image -want_ip_neighbor_events_v2 | only in image -want_ip_neighbor_events_v2_reply | only in image -want_vrrp_vr_events | only in image -want_vrrp_vr_events_reply | only in image -wireguard_interface_create | definition changed -wireguard_interface_details | definition changed - -Found 66 api message signature differences - - -### Newly deprecated API messages - -These messages are still there in the API, but can and probably -will disappear in the next release. - -- geneve_add_del_tunnel -- ip_neighbor_event -- nat44_forwarding_enable_disable -- nat44_forwarding_enable_disable_reply -- nat44_forwarding_is_enabled -- nat44_forwarding_is_enabled_reply -- nat44_session_cleanup -- nat44_session_cleanup_reply -- nat_control_ping -- nat_control_ping_reply -- nat_get_timeouts -- nat_get_timeouts_reply -- nat_ipfix_enable_disable -- nat_ipfix_enable_disable_reply -- nat_set_log_level -- nat_set_log_level_reply -- nat_set_timeouts -- nat_set_timeouts_reply -- nat_show_config -- nat_show_config_2 -- nat_show_config_2_reply -- nat_show_config_reply -- rdma_create -- vmxnet3_dump -- want_ip_neighbor_events -- want_ip_neighbor_events_reply - -### In-progress API messages - -These messages are provided for testing and experimentation only. -They are *not* subject to any compatibility process, -and therefore can arbitrarily change or disappear at *any* moment. -Also they may have less than satisfactory testing, making -them unsuitable for other use than the technology preview. -If you are intending to use these messages in production projects, -please collaborate with the feature maintainer on their productization. - -- abf_itf_attach_add_del -- abf_itf_attach_add_del_reply -- abf_itf_attach_details -- abf_itf_attach_dump -- abf_plugin_get_version -- abf_plugin_get_version_reply -- abf_policy_add_del -- abf_policy_add_del_reply -- abf_policy_details -- abf_policy_dump -- adl_allowlist_enable_disable -- adl_allowlist_enable_disable_reply -- adl_interface_enable_disable -- adl_interface_enable_disable_reply -- af_xdp_create -- af_xdp_create_reply -- af_xdp_delete -- af_xdp_delete_reply -- cnat_add_del_snat_prefix -- cnat_add_del_snat_prefix_reply -- cnat_get_snat_addresses -- cnat_get_snat_addresses_reply -- cnat_session_details -- cnat_session_dump -- cnat_session_purge -- cnat_session_purge_reply -- cnat_set_snat_addresses -- cnat_set_snat_addresses_reply -- cnat_translation_del -- cnat_translation_del_reply -- cnat_translation_details -- cnat_translation_dump -- cnat_translation_update -- cnat_translation_update_reply -- crypto_sw_scheduler_set_worker -- crypto_sw_scheduler_set_worker_reply -- det44_get_timeouts_reply -- det44_interface_add_del_feature -- det44_interface_add_del_feature_reply -- det44_interface_details -- det44_interface_dump -- det44_plugin_enable_disable -- det44_plugin_enable_disable_reply -- det44_set_timeouts -- det44_set_timeouts_reply -- flow_add -- flow_add_reply -- flow_del -- flow_del_reply -- flow_disable -- flow_disable_reply -- flow_enable -- flow_enable_reply -- gbp_bridge_domain_add -- gbp_bridge_domain_add_reply -- gbp_bridge_domain_del -- gbp_bridge_domain_del_reply -- gbp_bridge_domain_details -- gbp_bridge_domain_dump -- gbp_bridge_domain_dump_reply -- gbp_contract_add_del -- gbp_contract_add_del_reply -- gbp_contract_details -- gbp_contract_dump -- gbp_endpoint_add -- gbp_endpoint_add_reply -- gbp_endpoint_del -- gbp_endpoint_del_reply -- gbp_endpoint_details -- gbp_endpoint_dump -- gbp_endpoint_group_add -- gbp_endpoint_group_add_reply -- gbp_endpoint_group_del -- gbp_endpoint_group_del_reply -- gbp_endpoint_group_details -- gbp_endpoint_group_dump -- gbp_ext_itf_add_del -- gbp_ext_itf_add_del_reply -- gbp_ext_itf_details -- gbp_ext_itf_dump -- gbp_recirc_add_del -- gbp_recirc_add_del_reply -- gbp_recirc_details -- gbp_recirc_dump -- gbp_route_domain_add -- gbp_route_domain_add_reply -- gbp_route_domain_del -- gbp_route_domain_del_reply -- gbp_route_domain_details -- gbp_route_domain_dump -- gbp_route_domain_dump_reply -- gbp_subnet_add_del -- gbp_subnet_add_del_reply -- gbp_subnet_details -- gbp_subnet_dump -- gbp_vxlan_tunnel_add -- gbp_vxlan_tunnel_add_reply -- gbp_vxlan_tunnel_del -- gbp_vxlan_tunnel_del_reply -- gbp_vxlan_tunnel_details -- gbp_vxlan_tunnel_dump -- ikev2_child_sa_details -- ikev2_child_sa_dump -- ikev2_initiate_del_child_sa -- ikev2_initiate_del_child_sa_reply -- ikev2_initiate_del_ike_sa -- ikev2_initiate_del_ike_sa_reply -- ikev2_initiate_rekey_child_sa -- ikev2_initiate_rekey_child_sa_reply -- ikev2_initiate_sa_init -- ikev2_initiate_sa_init_reply -- ikev2_nonce_get -- ikev2_nonce_get_reply -- ikev2_profile_add_del -- ikev2_profile_add_del_reply -- ikev2_profile_details -- ikev2_profile_disable_natt -- ikev2_profile_disable_natt_reply -- ikev2_profile_dump -- ikev2_profile_set_auth -- ikev2_profile_set_auth_reply -- ikev2_profile_set_id -- ikev2_profile_set_id_reply -- ikev2_profile_set_ipsec_udp_port -- ikev2_profile_set_ipsec_udp_port_reply -- ikev2_profile_set_liveness -- ikev2_profile_set_liveness_reply -- ikev2_profile_set_ts -- ikev2_profile_set_ts_reply -- ikev2_profile_set_udp_encap -- ikev2_profile_set_udp_encap_reply -- ikev2_sa_details -- ikev2_sa_dump -- ikev2_set_esp_transforms -- ikev2_set_esp_transforms_reply -- ikev2_set_ike_transforms -- ikev2_set_ike_transforms_reply -- ikev2_set_local_key -- ikev2_set_local_key_reply -- ikev2_set_responder -- ikev2_set_responder_reply -- ikev2_set_sa_lifetime -- ikev2_set_sa_lifetime_reply -- ikev2_set_tunnel_interface -- ikev2_set_tunnel_interface_reply -- ikev2_traffic_selector_details -- ikev2_traffic_selector_dump -- l2_emulation -- l2_emulation_reply -- mdata_enable_disable -- mdata_enable_disable_reply -- nat44_add_del_static_mapping_v2 -- nat44_add_del_static_mapping_v2_reply -- nat44_show_running_config -- nat44_show_running_config_reply -- nat64_plugin_enable_disable -- nat64_plugin_enable_disable_reply -- oddbuf_enable_disable -- oddbuf_enable_disable_reply -- pg_interface_enable_disable_coalesce -- pg_interface_enable_disable_coalesce_reply -- sample_macswap_enable_disable -- sample_macswap_enable_disable_reply -- sr_policies_with_sl_index_details -- sr_policies_with_sl_index_dump -- sw_interface_set_vxlan_gbp_bypass -- sw_interface_set_vxlan_gbp_bypass_reply -- test_enum -- test_enum_reply -- test_prefix -- test_prefix_reply -- trace_capture_packets -- trace_capture_packets_reply -- trace_clear_capture -- trace_clear_capture_reply -- trace_details -- trace_dump -- trace_dump_reply -- trace_set_filters -- trace_set_filters_reply -- vxlan_gbp_tunnel_add_del -- vxlan_gbp_tunnel_add_del_reply -- vxlan_gbp_tunnel_details -- vxlan_gbp_tunnel_dump -- wireguard_interface_create -- wireguard_interface_create_reply -- wireguard_interface_delete -- wireguard_interface_delete_reply -- wireguard_interface_details -- wireguard_interface_dump -- wireguard_peer_add -- wireguard_peer_add_reply -- wireguard_peer_remove -- wireguard_peer_remove_reply -- wireguard_peers_details -- wireguard_peers_dump - -### Patches that changed API definitions - -| @c src/vpp/api/vpe_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | - -| @c src/vat2/test/vat2_test.api || -| ------- | ------- | -| [58a6e7725](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58a6e7725) | api: crchcecker ignore version < 1.0.0 and outside of src directory | -| [510aaa891](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=510aaa891) | api: crchcecker ignore version < 1.0.0 and outside of src directory | -| [793be4632](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=793be4632) | api: fromjson/tojson enum flag support | - -| @c src/vnet/mpls/mpls.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [33c45f56a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33c45f56a) | fib: supporting inner flow hash on tunnels | - -| @c src/vnet/vxlan-gbp/vxlan_gbp.api || -| ------- | ------- | -| [b468773aa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b468773aa) | vxlan-gbp: Mark APIs as in-progress | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [041add7d1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=041add7d1) | ipsec: Tunnel SA DSCP behaviour | -| [f916414b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f916414b3) | api: clean up use of deprecated flag | - -| @c src/vnet/ipsec/ipsec_types.api || -| ------- | ------- | -| [041add7d1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=041add7d1) | ipsec: Tunnel SA DSCP behaviour | - -| @c src/vnet/tunnel/tunnel_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | -| [33c45f56a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33c45f56a) | fib: supporting inner flow hash on tunnels | - -| @c src/vnet/classify/classify.api || -| ------- | ------- | -| [5c1e48c01](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5c1e48c01) | classify: add pcap/trace classfier mgmt API calls | - -| @c src/vnet/ipfix-export/ipfix_export.api || -| ------- | ------- | -| [f6cf57ceb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f6cf57ceb) | misc: fix api in ipfix_classify_table_add/details | - -| @c src/vnet/mfib/mfib_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | -| [990f69450](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=990f69450) | ip: convert u32 entry_flags to vl_api_mfib_entry_flags_t on mroute API | - -| @c src/vnet/gre/gre.api || -| ------- | ------- | -| [33c45f56a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33c45f56a) | fib: supporting inner flow hash on tunnels | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [6dc0c8d14](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6dc0c8d14) | ip: Sub Address Family types. Feature enable for each SAFI | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | -| [990f69450](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=990f69450) | ip: convert u32 entry_flags to vl_api_mfib_entry_flags_t on mroute API | - -| @c src/vnet/ethernet/ethernet_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - -| @c src/vnet/cop/cop.api || -| ------- | ------- | -| [6c8cdf78b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6c8cdf78b) | misc: cop - clean up stray doxygen block | -| [f916414b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f916414b3) | api: clean up use of deprecated flag | - -| @c src/vnet/crypto/crypto.api || -| ------- | ------- | -| [8c91b2ae2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8c91b2ae2) | crypto: Crypto set handler API to support set all as CLI | - -| @c src/vnet/devices/virtio/virtio.api || -| ------- | ------- | -| [e347acbc3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e347acbc3) | virtio: add packet buffering on transmit path | -| [f916414b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f916414b3) | api: clean up use of deprecated flag | - -| @c src/vnet/interface_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | - -| @c src/vnet/ip-neighbor/ip_neighbor.api || -| ------- | ------- | -| [4ac36bcb1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4ac36bcb1) | ip-neighbor: Send API event when neighbor is removed | - -| @c src/vnet/policer/policer_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | - -| @c src/vnet/srv6/sr_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [148c7b768](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=148c7b768) | stats: counters data model | -| [f916414b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f916414b3) | api: clean up use of deprecated flag | - -| @c src/plugins/nat/nat64/nat64.api || -| ------- | ------- | -| [1f36023d2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1f36023d2) | nat: move nat64 to a subfeature | - -| @c src/plugins/nat/det44/det44.api || -| ------- | ------- | -| [d1762e614](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d1762e614) | nat: det44 plugin fix style and api cleanup | -| [f916414b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f916414b3) | api: clean up use of deprecated flag | - -| @c src/plugins/nat/nat44.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | -| [25fd8ad03](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=25fd8ad03) | nat: cleanup & reorganization | -| [b227aa699](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b227aa699) | nat: api,cli and test update & cleanup | - -| @c src/plugins/nat/nat_types.api || -| ------- | ------- | -| [25fd8ad03](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=25fd8ad03) | nat: cleanup & reorganization | - -| @c src/plugins/lisp/lisp-cp/one.api || -| ------- | ------- | -| [2b202bc4b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2b202bc4b) | lisp: Move to plugin | - -| @c src/plugins/lisp/lisp-cp/lisp.api || -| ------- | ------- | -| [068ad25c1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=068ad25c1) | lisp: .api dont set defaults in reply messages | -| [2b202bc4b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2b202bc4b) | lisp: Move to plugin | - -| @c src/plugins/lisp/lisp-cp/lisp_types.api || -| ------- | ------- | -| [2b202bc4b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2b202bc4b) | lisp: Move to plugin | - -| @c src/plugins/lisp/lisp-gpe/lisp_gpe.api || -| ------- | ------- | -| [2b202bc4b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2b202bc4b) | lisp: Move to plugin | - -| @c src/plugins/nsim/nsim.api || -| ------- | ------- | -| [f916414b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f916414b3) | api: clean up use of deprecated flag | - -| @c src/plugins/lb/lb_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - -| @c src/plugins/pppoe/pppoe.api || -| ------- | ------- | -| [340b10a38](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=340b10a38) | pppoe: make pppoe plugin work with dot1q subinterfaces | - -| @c src/plugins/geneve/geneve.api || -| ------- | ------- | -| [3a6adc52f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3a6adc52f) | geneve: Move to plugin | - -| @c src/plugins/vmxnet3/vmxnet3.api || -| ------- | ------- | -| [490e077fb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=490e077fb) | vmxnet3: add sw_if_index filter to vmxnet3 interface dump | - -| @c src/plugins/wireguard/wireguard.api || -| ------- | ------- | -| [de22111b5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=de22111b5) | wireguard: return public key in api | - -| @c src/plugins/l2tp/l2tp.api || -| ------- | ------- | -| [6810a77da](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6810a77da) | misc: Move l2tp to plugin | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - -| @c src/plugins/acl/acl_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | - -| @c src/plugins/rdma/rdma.api || -| ------- | ------- | -| [798267aaa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=798267aaa) | rdma: implement multiseg rx without striding rq | - -| @c src/plugins/ikev2/ikev2.api || -| ------- | ------- | -| [d7fc12f07](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d7fc12f07) | ikev2: add option to disable NAT traversal | -| [84962d19b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=84962d19b) | ikev2: support ipv6 traffic selectors & overlay | - -| @c src/plugins/ikev2/ikev2_types.api || -| ------- | ------- | -| [dc01471be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dc01471be) | api: add missing version info | -| [d7fc12f07](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d7fc12f07) | ikev2: add option to disable NAT traversal | -| [84962d19b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=84962d19b) | ikev2: support ipv6 traffic selectors & overlay | - -| @c src/plugins/cnat/cnat.api || -| ------- | ------- | -| [2082835fe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2082835fe) | cnat: allow max_u16 translation backends | -| [af897c5e3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=af897c5e3) | cnat: Add DHCP support | - -| @c src/plugins/tracedump/tracedump.api || -| ------- | ------- | -| [c0b195450](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0b195450) | feature: Add packet trace API | - -| @c src/plugins/tracedump/graph.api || -| ------- | ------- | -| [c0b195450](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0b195450) | feature: Add packet trace API | - -| @c src/plugins/vrrp/vrrp.api || -| ------- | ------- | -| [78f487e11](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=78f487e11) | vrrp: asynchronous events on VR state change | - -| @c src/plugins/flowprobe/flowprobe.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - -| @c src/plugins/lldp/lldp.api || -| ------- | ------- | -| [3f9fdd984](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3f9fdd984) | lldp: Move to plugin | - -| @c src/plugins/memif/memif.api || -| ------- | ------- | -| [6223766f9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6223766f9) | libmemif: clean up typos | - -| @c src/plugins/dns/dns.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - -| @c src/plugins/stn/stn.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - -| @c src/plugins/af_xdp/af_xdp.api || -| ------- | ------- | -| [d4e109138](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d4e109138) | af_xdp: add option to claim all available rx queues | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [df87f8092](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df87f8092) | api: vat2 and json autogeneration for api messages | - - -@page release_notes_2009 Release notes for VPP 20.09 - -More than 458 commits since the previous release, including 266 fixes. - -## Release Highlights - -The FD.io VPP 20.09 release added a number of notable new features. In plugins, -the I/O layer added support for the Linux AF\_XDP interface with the AF\_XDP -plugin. New plugins where added supporting both the Wireguard security protocol -and CNAT destination based address translation, and the existing IKEv2 plugin -added support for NAT-T. In the cryptography layer, support was added for -synchronous software crypto engines, enabling users to allocate dedicated crypto -worker threads. The flow layer added support for steering IPSEC ESP/AH flows to -worker threads. GRO support was added to the packet coalescing library. - -This release introduces the new FD.io VPP API change policy to ensure -backwards-compatibility. The policy will ensure seamless upgrades to new -versions of FD.io VPP in future, provided no "in-progress" or deprecated APIs -are in use. Enabling the FD.io community to enjoy the benefits of new releases, -while minimizing the work involved in staying current. - -If you dive into the implementation, you will note that policy in action. A -number of modified API messages have had their original versions maintained to -ensure compatibility. - -Reflecting the new policy we added two new sections to the release notes -describing: -- Newly deprecated API messages: please note that if you are using a deprecated -message, they will soon be removed in a subsequent release. Collaborate with -the feature maintainer on the best approach to mitigate. -- In-progress API messages: They are work-in-progress, and are *not* subject to -the policy, and may change or even be removed at any time. Please collaborate -with the feature maintainer on plans to productize the message before using in -any product. In-progress APIs must eventually become stable or be removed. - -## Features - -- VNET - - Crypto Infra - - Add chacha20-poly1305 algo (61f49aa38) - - Asynchronous crypto engines (2284817ea) - - Add asynchronous crypto APIs (0c936b147) - - Added support for optimized cryptodev API (ef80ad6bf) - - FLOW - - Added ability to steer IPSec ESP/AH flows to worker threads (d4c3666b9) - - Added the vnet/flow API (d0236f725) - - GENEVE - - Support geneve interface acting as a bvi (7fc88cf3a) - - GSO - - Added software GRO support (f382b06fe) - - IPSec - - Dedicated IPSec interface type (dd4ccf262) - - Deprecate old interface API (e6df80de4) - - Interface Common - - Support configuring RSS steering queues (c4665093c) - - Native Virtio Drivers - - Add vhost sw\_if\_index filter for sw\_interface\_vhost\_user\_dump (a0e8d9669) - - Add modern device support (379aac395) - - Add virtio 1.1 api flags (518251bc8) - - TAP Drivers - - Add gro support (9e2a78564) - - Add virtio 1.1 API flag (50bd16559) - - TCP - - Track reorder with selective acknowledgments (cc4d6d022) -- Plugins - - AF\_XDP driver - - New plugin for Linux AF\_XDP input (4a76d6f6d) - - CNat - - New plugin for destination based NAT (29f3c7d2e) - - Wireguard - - New plugin, initial implementation of wireguard protocol (edca1325c) - - Crypto - OpenSSL - - Add chacha20-poly1305 support to crypto-openssl (1b6ed022e) - - DPDK - - Device\_id sorted order for cryptodev (5a849e3b3) - - Call the meson-based build instead of Makefiles (73903d7e8) - - Internet Key Exchange (IKEv2) Protocol - - Add support for NAT traversal (NAT-T) (4362baa33) - - Add profile dump API (6a9bd8188) - - Add support for AES-GCM cipher in IKE (a7b963df2) - - Add SA dump API (a340fe1ac) - - Network Delay Simulator - - Basic reorder support (e6c3e8f0e) -- VPP Comms Library - - Nest vcl\_mq\_epfd to support epoll\_wait without high CPU usage (4266d4d5f) - - Support connected udp listens (1e96617d9) - - Support inter worker rpc (40c07ce7a) - - Support multi-threads with session migration (a3a489691) -- Vector Library - - Add recursive macro expander to debug cli (961e3c842) -- Binary API Libraries - - Add new stream message convention (f5db3711b) - - Make VPP api handlers endian independent (e796a1873) -- Infrastructure Library - - Multiarch support for OCTEONTX2 SoC (e2f5236dc) - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Fixed issues - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/2009) - - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - -Message Name | Result --------------------------------------------------------------|------------------ -adl_allowlist_enable_disable | only in image -adl_allowlist_enable_disable_reply | only in image -adl_interface_enable_disable | only in image -adl_interface_enable_disable_reply | only in image -bond_add_member | only in image -bond_add_member_reply | only in image -bond_create2 | only in image -bond_create2_reply | only in image -bond_detach_member | only in image -bond_detach_member_reply | only in image -cnat_add_del_snat_prefix | only in image -cnat_add_del_snat_prefix_reply | only in image -cnat_session_details | only in image -cnat_session_dump | only in image -cnat_session_purge | only in image -cnat_session_purge_reply | only in image -cnat_set_snat_addresses | only in image -cnat_set_snat_addresses_reply | only in image -cnat_translation_del | only in image -cnat_translation_del_reply | only in image -cnat_translation_details | only in image -cnat_translation_dump | only in image -cnat_translation_update | only in image -cnat_translation_update_reply | only in image -crypto_set_async_dispatch | only in image -crypto_set_async_dispatch_reply | only in image -crypto_set_handler | only in image -crypto_set_handler_reply | only in image -crypto_sw_scheduler_set_worker | only in image -crypto_sw_scheduler_set_worker_reply | only in image -det44_add_del_map | only in image -det44_add_del_map_reply | only in image -det44_close_session_in | only in image -det44_close_session_in_reply | only in image -det44_close_session_out | only in image -det44_close_session_out_reply | only in image -det44_forward | only in image -det44_forward_reply | only in image -det44_get_timeouts | only in image -det44_get_timeouts_reply | only in image -det44_interface_add_del_feature | only in image -det44_interface_add_del_feature_reply | only in image -det44_interface_details | only in image -det44_interface_dump | only in image -det44_map_details | only in image -det44_map_dump | only in image -det44_plugin_enable_disable | only in image -det44_plugin_enable_disable_reply | only in image -det44_reverse | only in image -det44_reverse_reply | only in image -det44_session_details | only in image -det44_session_dump | only in image -det44_set_timeouts | only in image -det44_set_timeouts_reply | only in image -flow_add | only in image -flow_add_reply | only in image -flow_del | only in image -flow_del_reply | only in image -flow_disable | only in image -flow_disable_reply | only in image -flow_enable | only in image -flow_enable_reply | only in image -geneve_add_del_tunnel2 | only in image -geneve_add_del_tunnel2_reply | only in image -gtpu_add_del_tunnel | definition changed -gtpu_tunnel_details | definition changed -gtpu_tunnel_update_tteid | only in image -gtpu_tunnel_update_tteid_reply | only in image -ikev2_child_sa_details | only in image -ikev2_child_sa_dump | only in image -ikev2_nonce_get | only in image -ikev2_nonce_get_reply | only in image -ikev2_profile_details | only in image -ikev2_profile_dump | only in image -ikev2_profile_set_ts | definition changed -ikev2_sa_details | only in image -ikev2_sa_dump | only in image -ikev2_set_esp_transforms | definition changed -ikev2_set_ike_transforms | definition changed -ikev2_set_responder | definition changed -ikev2_traffic_selector_details | only in image -ikev2_traffic_selector_dump | only in image -ipsec_itf_create | only in image -ipsec_itf_create_reply | only in image -ipsec_itf_delete | only in image -ipsec_itf_delete_reply | only in image -ipsec_itf_details | only in image -ipsec_itf_dump | only in image -ipsec_set_async_mode | only in image -ipsec_set_async_mode_reply | only in image -map_domains_get | only in image -map_domains_get_reply | only in image -nat44_add_del_static_mapping_v2 | only in image -nat44_add_del_static_mapping_v2_reply | only in image -nat_show_config_2 | only in image -nat_show_config_2_reply | only in image -nsim_configure2 | only in image -nsim_configure2_reply | only in image -pg_interface_enable_disable_coalesce | only in image -pg_interface_enable_disable_coalesce_reply | only in image -sr_policies_with_sl_index_details | only in image -sr_policies_with_sl_index_dump | only in image -sw_bond_interface_details | only in image -sw_bond_interface_dump | only in image -sw_member_interface_details | only in image -sw_member_interface_dump | only in image -trace_details | only in image -trace_dump | only in image -trace_dump_reply | only in image -virtio_pci_create_v2 | only in image -virtio_pci_create_v2_reply | only in image -wireguard_interface_create | only in image -wireguard_interface_create_reply | only in image -wireguard_interface_delete | only in image -wireguard_interface_delete_reply | only in image -wireguard_interface_details | only in image -wireguard_interface_dump | only in image -wireguard_peer_add | only in image -wireguard_peer_add_reply | only in image -wireguard_peer_remove | only in image -wireguard_peer_remove_reply | only in image -wireguard_peers_details | only in image -wireguard_peers_dump | only in image - -Found 123 api message signature differences - - -### Newly deprecated API messages - -These messages are still there in the API, but can and probably -will disappear in the next release. - -- bond_create -- bond_detach_slave -- bond_detach_slave_reply -- bond_enslave -- cop_interface_enable_disable -- cop_interface_enable_disable_reply -- cop_whitelist_enable_disable -- cop_whitelist_enable_disable_reply -- geneve_add_del_tunnel -- ipsec_tunnel_if_add_del -- ipsec_tunnel_if_set_sa -- ipsec_tunnel_if_set_sa_reply -- map_domain_dump -- nat_det_add_del_map -- nat_det_add_del_map_reply -- nat_det_close_session_in -- nat_det_close_session_in_reply -- nat_det_close_session_out -- nat_det_close_session_out_reply -- nat_det_forward -- nat_det_forward_reply -- nat_det_map_details -- nat_det_map_dump -- nat_det_reverse -- nat_det_reverse_reply -- nat_det_session_details -- nat_det_session_dump -- nat_show_config -- nsim_configure -- nsim_configure_reply -- sw_interface_bond_dump -- sw_interface_slave_dump -- virtio_pci_create -- virtio_pci_create_reply - -### In-progress API messages - -These messages are provided for testing and experimentation only. -They are *not* subject to any compatibility process, -and therefore can arbitrarily change or disappear at *any* moment. -Also they may have less than satisfactory testing, making -them unsuitable for other use than the technology preview. -If you are intending to use these messages in production projects, -please collaborate with the feature maintainer on their productization. - -- abf_itf_attach_add_del -- abf_itf_attach_add_del_reply -- abf_itf_attach_details -- abf_itf_attach_dump -- abf_plugin_get_version -- abf_plugin_get_version_reply -- abf_policy_add_del -- abf_policy_add_del_reply -- abf_policy_details -- abf_policy_dump -- adl_allowlist_enable_disable -- adl_allowlist_enable_disable_reply -- adl_interface_enable_disable -- adl_interface_enable_disable_reply -- af_xdp_create -- af_xdp_create_reply -- af_xdp_delete -- af_xdp_delete_reply -- cnat_add_del_snat_prefix -- cnat_add_del_snat_prefix_reply -- cnat_session_details -- cnat_session_dump -- cnat_session_purge -- cnat_session_purge_reply -- cnat_set_snat_addresses -- cnat_set_snat_addresses_reply -- cnat_translation_del -- cnat_translation_del_reply -- cnat_translation_details -- cnat_translation_dump -- cnat_translation_update -- cnat_translation_update_reply -- crypto_sw_scheduler_set_worker -- crypto_sw_scheduler_set_worker_reply -- det44_get_timeouts_reply -- det44_interface_add_del_feature -- det44_interface_add_del_feature_reply -- det44_interface_details -- det44_interface_dump -- det44_plugin_enable_disable -- det44_plugin_enable_disable_reply -- det44_set_timeouts -- det44_set_timeouts_reply -- flow_add -- flow_add_reply -- flow_del -- flow_del_reply -- flow_disable -- flow_disable_reply -- flow_enable -- flow_enable_reply -- gbp_bridge_domain_add -- gbp_bridge_domain_add_reply -- gbp_bridge_domain_del -- gbp_bridge_domain_del_reply -- gbp_bridge_domain_details -- gbp_bridge_domain_dump -- gbp_bridge_domain_dump_reply -- gbp_contract_add_del -- gbp_contract_add_del_reply -- gbp_contract_details -- gbp_contract_dump -- gbp_endpoint_add -- gbp_endpoint_add_reply -- gbp_endpoint_del -- gbp_endpoint_del_reply -- gbp_endpoint_details -- gbp_endpoint_dump -- gbp_endpoint_group_add -- gbp_endpoint_group_add_reply -- gbp_endpoint_group_del -- gbp_endpoint_group_del_reply -- gbp_endpoint_group_details -- gbp_endpoint_group_dump -- gbp_ext_itf_add_del -- gbp_ext_itf_add_del_reply -- gbp_ext_itf_details -- gbp_ext_itf_dump -- gbp_recirc_add_del -- gbp_recirc_add_del_reply -- gbp_recirc_details -- gbp_recirc_dump -- gbp_route_domain_add -- gbp_route_domain_add_reply -- gbp_route_domain_del -- gbp_route_domain_del_reply -- gbp_route_domain_details -- gbp_route_domain_dump -- gbp_route_domain_dump_reply -- gbp_subnet_add_del -- gbp_subnet_add_del_reply -- gbp_subnet_details -- gbp_subnet_dump -- gbp_vxlan_tunnel_add -- gbp_vxlan_tunnel_add_reply -- gbp_vxlan_tunnel_del -- gbp_vxlan_tunnel_del_reply -- gbp_vxlan_tunnel_details -- gbp_vxlan_tunnel_dump -- ikev2_child_sa_details -- ikev2_child_sa_dump -- ikev2_initiate_del_child_sa -- ikev2_initiate_del_child_sa_reply -- ikev2_initiate_del_ike_sa -- ikev2_initiate_del_ike_sa_reply -- ikev2_initiate_rekey_child_sa -- ikev2_initiate_rekey_child_sa_reply -- ikev2_initiate_sa_init -- ikev2_initiate_sa_init_reply -- ikev2_nonce_get -- ikev2_nonce_get_reply -- ikev2_profile_add_del -- ikev2_profile_add_del_reply -- ikev2_profile_details -- ikev2_profile_dump -- ikev2_profile_set_auth -- ikev2_profile_set_auth_reply -- ikev2_profile_set_id -- ikev2_profile_set_id_reply -- ikev2_profile_set_ipsec_udp_port -- ikev2_profile_set_ipsec_udp_port_reply -- ikev2_profile_set_liveness -- ikev2_profile_set_liveness_reply -- ikev2_profile_set_ts -- ikev2_profile_set_ts_reply -- ikev2_profile_set_udp_encap -- ikev2_profile_set_udp_encap_reply -- ikev2_sa_details -- ikev2_sa_dump -- ikev2_set_esp_transforms -- ikev2_set_esp_transforms_reply -- ikev2_set_ike_transforms -- ikev2_set_ike_transforms_reply -- ikev2_set_local_key -- ikev2_set_local_key_reply -- ikev2_set_responder -- ikev2_set_responder_reply -- ikev2_set_sa_lifetime -- ikev2_set_sa_lifetime_reply -- ikev2_set_tunnel_interface -- ikev2_set_tunnel_interface_reply -- ikev2_traffic_selector_details -- ikev2_traffic_selector_dump -- l2_emulation -- l2_emulation_reply -- mdata_enable_disable -- mdata_enable_disable_reply -- nat44_add_del_static_mapping_v2 -- nat44_add_del_static_mapping_v2_reply -- oddbuf_enable_disable -- oddbuf_enable_disable_reply -- pg_interface_enable_disable_coalesce -- pg_interface_enable_disable_coalesce_reply -- sample_macswap_enable_disable -- sample_macswap_enable_disable_reply -- sr_policies_with_sl_index_details -- sr_policies_with_sl_index_dump -- sw_interface_set_vxlan_gbp_bypass -- sw_interface_set_vxlan_gbp_bypass_reply -- trace_details -- trace_dump -- trace_dump_reply -- vxlan_gbp_tunnel_add_del -- vxlan_gbp_tunnel_add_del_reply -- vxlan_gbp_tunnel_details -- vxlan_gbp_tunnel_dump -- wireguard_interface_create -- wireguard_interface_create_reply -- wireguard_interface_delete -- wireguard_interface_delete_reply -- wireguard_interface_details -- wireguard_interface_dump -- wireguard_peer_add -- wireguard_peer_add_reply -- wireguard_peer_remove -- wireguard_peer_remove_reply -- wireguard_peers_details -- wireguard_peers_dump - -### Patches that changed API definitions - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [d0236f725](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d0236f725) | flow: add vnet/flow formal API | - -| @c src/vnet/crypto/crypto.api || -| ------- | ------- | -| [4035daffd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4035daffd) | crypto: Crypto set handler API to support set all as CLI | -| [0c936b147](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0c936b147) | crypto: Add async crypto APIs | - -| @c src/vnet/cop/cop.api || -| ------- | ------- | -| [00f21fb2f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00f21fb2f) | api: clean up use of deprecated flag | -| [ac0326fc5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ac0326fc5) | adl: move allow/deny list function to plugin | - -| @c src/vnet/lisp-gpe/lisp_gpe.api || -| ------- | ------- | -| [4ab5190eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4ab5190eb) | lisp: API cleanup | - -| @c src/vnet/vxlan-gbp/vxlan_gbp.api || -| ------- | ------- | -| [f72b1aff7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f72b1aff7) | vxlan-gbp: Mark APIs as in-progress | - -| @c src/vnet/flow/flow_types.api || -| ------- | ------- | -| [34bfa50b6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=34bfa50b6) | flow: code refactor | -| [d0236f725](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d0236f725) | flow: add vnet/flow formal API | - -| @c src/vnet/flow/flow.api || -| ------- | ------- | -| [d0236f725](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d0236f725) | flow: add vnet/flow formal API | - -| @c src/vnet/srv6/sr.api || -| ------- | ------- | -| [30fa97dc6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=30fa97dc6) | sr: new messages created to return sl index for segment lists in a sr policy | - -| @c src/vnet/pg/pg.api || -| ------- | ------- | -| [f382b06fe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f382b06fe) | gso: packet coalesce library | -| [0cf528233](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0cf528233) | gso: fix the udp checksum in test | - -| @c src/vnet/geneve/geneve.api || -| ------- | ------- | -| [00f21fb2f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00f21fb2f) | api: clean up use of deprecated flag | -| [7fc88cf3a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7fc88cf3a) | geneve: support geneve interface acting as a bvi | - -| @c src/vnet/lisp-cp/one.api || -| ------- | ------- | -| [4ab5190eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4ab5190eb) | lisp: API cleanup | - -| @c src/vnet/lisp-cp/lisp.api || -| ------- | ------- | -| [4ab5190eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4ab5190eb) | lisp: API cleanup | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [50bd16559](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=50bd16559) | tap: add virtio 1.1 API flag | - -| @c src/vnet/devices/virtio/vhost_user.api || -| ------- | ------- | -| [a0e8d9669](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a0e8d9669) | virtio: add vhost sw_if_index filter for sw_interface_vhost_user_dump | - -| @c src/vnet/devices/virtio/virtio.api || -| ------- | ------- | -| [00f21fb2f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00f21fb2f) | api: clean up use of deprecated flag | -| [518251bc8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=518251bc8) | virtio: add virtio 1.1 api flags | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [00f21fb2f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00f21fb2f) | api: clean up use of deprecated flag | -| [2e84d6655](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2e84d6655) | ipsec: add ipsec set async mode api | -| [e6df80de4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e6df80de4) | ipsec: Deprecate old interface API | -| [dd4ccf262](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dd4ccf262) | ipsec: Dedicated IPSec interface type | - -| @c src/vnet/bonding/bond.api || -| ------- | ------- | -| [ea7178631](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ea7178631) | bonding: add bond_create2 API to include gso option | -| [4c4223edf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4c4223edf) | bonding lacp: replace slave string with member | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [d0236f725](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d0236f725) | flow: add vnet/flow formal API | - -| @c src/plugins/wireguard/wireguard.api || -| ------- | ------- | -| [edca1325c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=edca1325c) | wireguard: initial implementation of wireguard protocol | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [00f21fb2f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00f21fb2f) | api: clean up use of deprecated flag | -| [ac0326fc5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ac0326fc5) | adl: move allow/deny list function to plugin | -| [f5db3711b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f5db3711b) | api: add new stream message convention | - -| @c src/plugins/lacp/lacp.api || -| ------- | ------- | -| [4c4223edf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4c4223edf) | bonding lacp: replace slave string with member | - -| @c src/plugins/l2e/l2e.api || -| ------- | ------- | -| [f733e7ade](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f733e7ade) | l2e: mark API as in-progress | - -| @c src/plugins/ikev2/ikev2.api || -| ------- | ------- | -| [a340fe1ac](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a340fe1ac) | ikev2: add SA dump API | -| [459d17bb7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=459d17bb7) | ikev2: refactor and test profile dump API | -| [ac46e3b1d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ac46e3b1d) | ikev2: API downgrade due to lack of ikev2 tests | -| [6a9bd8188](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6a9bd8188) | ikev2: add profile dump API | - -| @c src/plugins/ikev2/ikev2_types.api || -| ------- | ------- | -| [a340fe1ac](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a340fe1ac) | ikev2: add SA dump API | -| [459d17bb7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=459d17bb7) | ikev2: refactor and test profile dump API | -| [6a9bd8188](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6a9bd8188) | ikev2: add profile dump API | - -| @c src/plugins/tracedump/tracedump.api || -| ------- | ------- | -| [65b65a469](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=65b65a469) | misc: add tracedump API plugin | - -| @c src/plugins/gtpu/gtpu.api || -| ------- | ------- | -| [9ebbb5c41](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9ebbb5c41) | gtpu: support separate rx-decap and encap-tx teid values | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [d2f8fb9c7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d2f8fb9c7) | gbp: mark APIs as in-progress | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [24ee40a5c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=24ee40a5c) | acl: correct acl vat help message | - -| @c src/plugins/nat/dslite/dslite.api || -| ------- | ------- | -| [603e75465](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=603e75465) | nat: move deterministic nat to det44 sub feature | - -| @c src/plugins/nat/det44/det44.api || -| ------- | ------- | -| [00f21fb2f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00f21fb2f) | api: clean up use of deprecated flag | -| [603e75465](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=603e75465) | nat: move deterministic nat to det44 sub feature | - -| @c src/plugins/nat/nat_types.api || -| ------- | ------- | -| [96068d6b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=96068d6b9) | nat: nat66 to plugin | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [6484f4b9c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6484f4b9c) | nat: twice-nat static mapping pool address | -| [edc816355](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=edc816355) | nat: fix type in api message | -| [603e75465](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=603e75465) | nat: move deterministic nat to det44 sub feature | -| [96068d6b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=96068d6b9) | nat: nat66 to plugin | - -| @c src/plugins/nat/nat66/nat66.api || -| ------- | ------- | -| [96068d6b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=96068d6b9) | nat: nat66 to plugin | - -| @c src/plugins/cnat/cnat.api || -| ------- | ------- | -| [29f3c7d2e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=29f3c7d2e) | cnat: Destination based NAT | - -| @c src/plugins/abf/abf.api || -| ------- | ------- | -| [df494dafa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df494dafa) | abf: mark API as in-progress | - -| @c src/plugins/adl/adl.api || -| ------- | ------- | -| [ac0326fc5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ac0326fc5) | adl: move allow/deny list function to plugin | - -| @c src/plugins/nsim/nsim.api || -| ------- | ------- | -| [00f21fb2f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00f21fb2f) | api: clean up use of deprecated flag | -| [e6c3e8f0e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e6c3e8f0e) | nsim: basic reorder support | - -| @c src/plugins/crypto_sw_scheduler/crypto_sw_scheduler.api || -| ------- | ------- | -| [0c936b147](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0c936b147) | crypto: Add async crypto APIs | - -| @c src/plugins/dhcp/dhcp.api || -| ------- | ------- | -| [bad679291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bad679291) | api: register endian handlers for reply messages | - -| @c src/plugins/af_xdp/af_xdp.api || -| ------- | ------- | -| [4a76d6f6d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4a76d6f6d) | af_xdp: AF_XDP input plugin | - - -@page release_notes_20051 Release notes for VPP 20.05.1 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/2005) - -@page release_notes_2005 Release notes for VPP 20.05 - -More than 751 commits since the 20.01 release. - -## Release Highlights - -### Feature Highlights - -As per commits involving -FEATURE.yaml edits between the previous release and this release. -They are mentioned in the below "features" section as well, -together with the corresponding commits. - -- TAP Drivers - - Implement sw_interface_tap_v2_dump filtering by sw_if_index - - Add support for persistence -- Native Virtio Drivers - - Support virtio 1.1 packed ring in vhost -- gso - - Add support for IP-IP - - Add vxlan tunnel support -- VRRP - - Add plugin providing VRRP support - -### Ongoing Work On More Semantic-Typed API - -This release, like the 20.01, continues the journey on defining -the semantic-based types instead of storage-based types within the API, -so you may have noticed this in the API changes. - -Some of the changes -are related to the infrastructure, and may be bugfixes, they -do not change the CRC of the message but affect the representation -on the wire. One particular commit we want you to pay attention to, -is [b5c0d35f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b5c0d35f), which -fixes the bug with the enum representation on the wire - before it, -even the enums declared as u8 or u16 were represented as u32 in -the API messages. - -Another important commit we would like to call out explicitly as well is -[7dd63e5c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7dd63e5c), which -pinned the address_family and ip_proto enum types to be u8 instead of the default u32. - -The above two commits will be primarily interesting for those who work with the low-level -APIs on VPP - the API frameworks should make these under-the-hood changes transparent. -However, we decided to call these out, given that for those affected these will -be pretty important changes. - -Another commit, that does not have the immediate impact at the moment, but that -is poised to improve the user interaction with the API is [5c318c70](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5c318c70). -This adds the tooling and ability to implement a structured process, -by which the API messages can evolve, while minimizing the impact to the -API users. - -## Features - -- Binary API Compiler for Python - - Api crc checker (5c318c70d) -- Binary API Libraries - - Add macro that zeros out api reply buffer (f24de1795) -- Build System - - Add snap packaging (experimental) (6d97e62c0) - - Support arch-specific compiling for Neoverse N1 (690ce8672) -- Crypto native Plugin - - Add ARMv8 AES-CBC implementation (776644efe) - - Add AArch64 AES-GCM native implementation (622b5ce61) - - Calculate ghash using vpclmulqdq instructions (627fb6a16) - - GCM implementation with vector AESNI instructions (47d8f5dcd) -- Infrastructure Library - - Add x86 CPU definitions (38e0413b2) - - Numa vector placement support (a690fdbfe) - - Add cmake option to grow vectors by 1 (98bd75778) - - Add tw\_timer\_2t\_2w\_512sl variant (907678977) -- Link Bonding - - Add GSO support (2e1fa54b7) -- Plugins - - DPDK - - Output switch information (2347278d9) - - Use port\_id as interface name suffix for representors (a80f8f371) - - Add iova-mode to startup (4e96ddaec) - - Bump DPDK version to 20.02 (76be887d8) - - Enable DPDK iAVF PMD (162ea767c) - - DPDK 20.05 iavf flow director backporting to DPDK 20.02 (7f83738b4) - - GTPU - - Offload RX flow (00fdf53c7) - - RX offload for IPv6 payload supporting (ed63a0ff7) - - Host Stack Applications - - Proxy rcv wnd update acks after full fifos (dda2dbeda) - - IPv6 Segment Routing Mobile - - Support GTP4/6.DT and User Plane message mapping (9e722bd46) - - Internet Key Exchange (IKEv2) Protocol - - Configure a profile with an existing interface (44476c6b2) - - Responder honours the protected tunnel config (685001f0a) - - Add support for custom ipsec-over-udp port (e5d34919b) - - Dead peer detection (c415d0a8e) - - NAT - - In2out-output nodes work with acl reflect (d539e256b) - - Api & cli command for forcing session cleanup (edf777272) - - Dslite ce mode in separate config entry (958919f36) - - QUIC protocol - - Update quicly to v0.0.10-VPP (62b1cea6e) - - Quicly crypto offloading (92de6b65b) - - Check quicly version tag at compile time (ffdc72da4) - - RDMA (ibverb) driver - - Bunp rdma-core version to v28.0 (eb89b9093) - - Add Mellanox mlx5 Direct Verbs receive support (dd648aac0) - - Introduce direct verb for Cx4/5 tx (dc812d9a7) - - Unicast Reverse Path forwarding - - Unicast reverse Path Forwarding (plugin) (d724e4f43) - - VRRP - - Add plugin providing vrrp support (39e9428b9) -- SVM Library - - Numa awareness for ssvm segments (6fe8998fe) - - Support multi-chunk fifo chunk alloc (8e755a16a) - - Chunk alloc stats (d35887297) - - New FIFO design/architecture (f22f4e562) - - Fifo test (64e96613d) -- Test Infrastructure - - Add running\_gcov\_tests to framework.py (d498c9eb2) - - Implement ipaddress convenience methods (e64e5fff4) -- VNET - - Crypto Infra - - Add chained buffer support in ipsecmb (AES-GCM) (2fc409131) - - Add support for testing quad loops in crypto algos (a9075dcf6) - - Introduce async crypto infra (f539578ba) - - Ethernet - - Configure system default ethernet MTU (5fa452554) - - FLOW - - Add vlan tagged types for IPv4/IPv6 5-tuple flows (f13830ce7) - - Add RSS support (24e2c50bf) - - Add l2tpv3oip flow (8b43aaaf1) - - GRE - - Tunnel encap/decap flags (e5b94dded) - - GSO - - Add vxlan tunnel support (0b04209ed) - - Add support for IP-IP (84f91fa9c) - - IP Neighbors - - Populate neighbor age via API (9c1928f81) - - Replace feature for the ip-neighbor data-base (c87fbb417) - - Add flush API (240dcb24a) - - IPIP - - Multi-point interface (14053c9db) - - IPSec - - Add support for chained buffers (efcad1a9d) - - IPSec protection for multi-point tunnel interfaces (282872127) - - Add input node bypass/discard functionality (0546483ce) - - User can choose the UDP source port (abc5660c6) - - Support 4o6 and 6o4 for SPD tunnel mode SAs (b1fd80f09) - - IPv4 LPM - - More detailed show reassembly commands (a877cf9f3) - - Replace Sematics for Interface IP addresses (59f71132e) - - MPLS - - Add user defined name tag to mpls tunnels (39ae0a07a) - - Native Virtio Drivers - - Support virtio 1.1 packed ring in vhost (bc0d9ff67) - - Packet Generator - - Set vnet buffer flags in pg streams (08eb2bb20) - - Segment Routing (IPv6 and MPLS) - - Change the CLI keyword from address to prefix. (b24e287b9) - - Support uSID function. (ec9cb9668) - - Session Layer - - Tracking segment memory usage (234fe894d) - - Basic fifo-tuning-logic (d8f48e216) - - Api to add new transport types (07063b8ea) - - Support connect on listeners (0a1e183e5) - - Adding debug events (7357043d2) - - Add option to preallocate fifo headers (9845c20d7) - - TAP Drivers - - Add support for persistance (b49bc1ae6) - - Add initial support for tun (206acf84d) - - Implement sw\_interface\_tap\_v2\_dump filtering by sw\_if\_index (073d74d0b) - - TCP - - Add option to avoid endpoint cleanup (43818c1e0) - - Minimal set of worker stats (5e6305fb0) - - Allow custom mss on connects (ff19e3bf4) - - TLS and TLS engine plugins - - Picotls engine symmetric crypto enhancement by VPP crypto framework (3b8518164) - - UDP - - Track connection port sharing (a039620c2) -- VPP Comms Library - - Udp session migration notifications (68b7e5888) - - Propagate cleanup notifications to apps (9ace36d0f) -- Vector Library - - Add plugin override support (8dc954a4e) - - Calculate per-worker loops/second metric (000a029e4) - - Leave SIGPROF signal with its default handler (6f533d780) - - Add nosyslog unix option (e31820af1) -- Gomemif - - Introduce gomemif (07363a45f) - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Fixed issues - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/2005) - - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - -Message Name | Result --------------------------------------------------------------|------------------ -acl_add_replace | definition changed -acl_details | definition changed -acl_interface_add_del | definition changed -acl_interface_etype_whitelist_details | definition changed -acl_interface_etype_whitelist_dump | definition changed -acl_interface_list_details | definition changed -acl_interface_list_dump | definition changed -acl_interface_set_acl_list | definition changed -acl_interface_set_etype_whitelist | definition changed -add_node_next | definition changed -app_attach | definition changed -app_attach_reply | definition changed -app_cut_through_registration_add | only in file -app_cut_through_registration_add_reply | only in file -app_namespace_add_del | definition changed -app_worker_add_del | definition changed -app_worker_add_del_reply | definition changed -application_attach | only in file -application_attach_reply | only in file -bd_ip_mac_add_del | definition changed -bind_sock | only in file -bind_sock_reply | only in file -bind_uri | only in file -bind_uri_reply | only in file -bridge_domain_add_del | definition changed -bridge_domain_details | definition changed -bridge_domain_dump | definition changed -bridge_flags | definition changed -bvi_create_reply | definition changed -bvi_delete | definition changed -connect_sock | only in file -connect_sock_reply | only in file -connect_uri | only in file -connect_uri_reply | only in file -create_vhost_user_if | definition changed -disconnect_session | only in file -disconnect_session_reply | only in file -get_next_index | definition changed -get_node_index | definition changed -gpe_add_del_fwd_entry | definition changed -gpe_add_del_iface | definition changed -gpe_add_del_native_fwd_rpath | definition changed -gpe_enable_disable | definition changed -gpe_fwd_entries_get_reply | definition changed -gpe_fwd_entry_path_details | definition changed -gpe_native_fwd_rpaths_get | definition changed -gpe_native_fwd_rpaths_get_reply | definition changed -gpe_set_encap_mode | definition changed -gre_tunnel_add_del | definition changed -gre_tunnel_details | definition changed -gtpu_offload_rx | only in image -gtpu_offload_rx_reply | only in image -ikev2_profile_set_ipsec_udp_port | only in image -ikev2_profile_set_ipsec_udp_port_reply | only in image -ikev2_profile_set_liveness | only in image -ikev2_profile_set_liveness_reply | only in image -ikev2_profile_set_udp_encap | only in image -ikev2_profile_set_udp_encap_reply | only in image -ikev2_set_local_key | definition changed -ikev2_set_tunnel_interface | only in image -ikev2_set_tunnel_interface_reply | only in image -ip_neighbor_details | definition changed -ip_neighbor_flush | only in image -ip_neighbor_flush_reply | only in image -ip_neighbor_replace_begin | only in image -ip_neighbor_replace_begin_reply | only in image -ip_neighbor_replace_end | only in image -ip_neighbor_replace_end_reply | only in image -ip_route_lookup | only in image -ip_route_lookup_reply | only in image -ip_source_check_interface_add_del | only in file -ip_source_check_interface_add_del_reply | only in file -ipfix_classify_table_add_del | definition changed -ipfix_classify_table_details | definition changed -ipip_add_tunnel | definition changed -ipip_tunnel_details | definition changed -ipsec_backend_details | definition changed -ipsec_interface_add_del_spd | definition changed -ipsec_sa_details | definition changed -ipsec_sad_entry_add_del | definition changed -ipsec_select_backend | definition changed -ipsec_spd_add_del | definition changed -ipsec_spd_details | definition changed -ipsec_spd_entry_add_del | definition changed -ipsec_spd_interface_details | definition changed -ipsec_tunnel_if_add_del | definition changed -ipsec_tunnel_if_add_del_reply | definition changed -ipsec_tunnel_if_set_sa | definition changed -ipsec_tunnel_protect_del | definition changed -ipsec_tunnel_protect_details | definition changed -ipsec_tunnel_protect_update | definition changed -l2_fib_table_details | definition changed -l2_flags | definition changed -l2_interface_efp_filter | definition changed -l2_interface_pbb_tag_rewrite | definition changed -l2_interface_vlan_tag_rewrite | definition changed -l2_macs_event | definition changed -l2_patch_add_del | definition changed -l2_xconnect_details | definition changed -l2fib_add_del | definition changed -l2fib_flush_int | definition changed -lisp_add_del_adjacency | definition changed -lisp_add_del_local_eid | definition changed -lisp_add_del_locator | definition changed -lisp_add_del_locator_set | definition changed -lisp_add_del_map_request_itr_rlocs | definition changed -lisp_add_del_map_resolver | definition changed -lisp_add_del_map_server | definition changed -lisp_add_del_remote_mapping | definition changed -lisp_adjacencies_get_reply | definition changed -lisp_eid_table_add_del_map | definition changed -lisp_eid_table_details | definition changed -lisp_eid_table_dump | definition changed -lisp_eid_table_map_dump | definition changed -lisp_enable_disable | definition changed -lisp_get_map_request_itr_rlocs_reply | definition changed -lisp_locator_details | definition changed -lisp_locator_dump | definition changed -lisp_locator_set_details | definition changed -lisp_locator_set_dump | definition changed -lisp_map_register_enable_disable | definition changed -lisp_map_request_mode | definition changed -lisp_map_resolver_details | definition changed -lisp_map_server_details | definition changed -lisp_pitr_set_locator_set | definition changed -lisp_rloc_probe_enable_disable | definition changed -lisp_use_petr | definition changed -lldp_config | definition changed -macip_acl_add | definition changed -macip_acl_add_replace | definition changed -macip_acl_details | definition changed -macip_acl_interface_add_del | definition changed -macip_acl_interface_list_details | definition changed -macip_acl_interface_list_dump | definition changed -map_another_segment | only in file -map_another_segment_reply | only in file -modify_vhost_user_if | definition changed -mpls_tunnel_add_del | definition changed -mpls_tunnel_details | definition changed -nat44_del_user | only in image -nat44_del_user_reply | only in image -nat44_session_cleanup | only in image -nat44_session_cleanup_reply | only in image -nat44_set_session_limit | only in image -nat44_set_session_limit_reply | only in image -nat_show_config_reply | definition changed -netmap_create | only in file -netmap_create_reply | only in file -netmap_delete | only in file -netmap_delete_reply | only in file -nhrp_details | only in file -nhrp_dump | only in file -nhrp_entry_add_del | only in file -nhrp_entry_add_del_reply | only in file -one_add_del_adjacency | definition changed -one_add_del_l2_arp_entry | definition changed -one_add_del_local_eid | definition changed -one_add_del_locator | definition changed -one_add_del_locator_set | definition changed -one_add_del_map_request_itr_rlocs | definition changed -one_add_del_map_resolver | definition changed -one_add_del_map_server | definition changed -one_add_del_ndp_entry | definition changed -one_add_del_remote_mapping | definition changed -one_adjacencies_get_reply | definition changed -one_eid_table_add_del_map | definition changed -one_eid_table_details | definition changed -one_eid_table_dump | definition changed -one_eid_table_map_dump | definition changed -one_enable_disable | definition changed -one_enable_disable_petr_mode | definition changed -one_enable_disable_pitr_mode | definition changed -one_enable_disable_xtr_mode | definition changed -one_get_map_request_itr_rlocs_reply | definition changed -one_l2_arp_entries_get_reply | definition changed -one_locator_details | definition changed -one_locator_dump | definition changed -one_locator_set_details | definition changed -one_locator_set_dump | definition changed -one_map_register_enable_disable | definition changed -one_map_request_mode | definition changed -one_map_resolver_details | definition changed -one_map_server_details | definition changed -one_ndp_entries_get_reply | definition changed -one_nsh_set_locator_set | definition changed -one_pitr_set_locator_set | definition changed -one_rloc_probe_enable_disable | definition changed -one_show_petr_mode_reply | definition changed -one_show_pitr_mode_reply | definition changed -one_show_xtr_mode_reply | definition changed -one_stats_details | definition changed -one_stats_enable_disable | definition changed -one_use_petr | definition changed -pg_capture | definition changed -pg_create_interface | definition changed -pg_create_interface_reply | definition changed -pg_enable_disable | definition changed -policer_add_del | definition changed -policer_details | definition changed -policer_dump | definition changed -session_enable_disable | definition changed -session_rule_add_del | definition changed -session_rules_details | definition changed -show_lisp_map_register_state_reply | definition changed -show_lisp_map_request_mode_reply | definition changed -show_lisp_pitr_reply | definition changed -show_lisp_rloc_probe_state_reply | definition changed -show_lisp_status_reply | definition changed -show_lisp_use_petr_reply | definition changed -show_one_map_register_state_reply | definition changed -show_one_map_request_mode_reply | definition changed -show_one_nsh_mapping_reply | definition changed -show_one_pitr_reply | definition changed -show_one_rloc_probe_state_reply | definition changed -show_one_stats_enable_disable_reply | definition changed -show_one_status_reply | definition changed -show_one_use_petr_reply | definition changed -show_threads_reply | definition changed -sr_localsid_add_del | definition changed -sr_localsids_details | definition changed -sr_mpls_policy_add | definition changed -sr_mpls_policy_assign_endpoint_color | definition changed -sr_mpls_policy_mod | definition changed -sr_mpls_steering_add_del | definition changed -sr_policies_details | definition changed -sr_policy_add | definition changed -sr_policy_del | definition changed -sr_policy_mod | definition changed -sr_set_encap_source | definition changed -sr_steering_add_del | definition changed -sr_steering_pol_details | definition changed -sw_interface_address_replace_begin | only in image -sw_interface_address_replace_begin_reply | only in image -sw_interface_address_replace_end | only in image -sw_interface_address_replace_end_reply | only in image -sw_interface_set_l2_bridge | definition changed -sw_interface_set_l2_xconnect | definition changed -sw_interface_set_lldp | definition changed -sw_interface_set_vpath | definition changed -sw_interface_set_vxlan_bypass | definition changed -sw_interface_set_vxlan_gpe_bypass | definition changed -sw_interface_span_details | definition changed -sw_interface_span_dump | definition changed -sw_interface_span_enable_disable | definition changed -teib_details | only in image -teib_dump | only in image -teib_entry_add_del | only in image -teib_entry_add_del_reply | only in image -unbind_sock | only in file -unbind_sock_reply | only in file -unbind_uri | only in file -unbind_uri_reply | only in file -unmap_segment | only in file -unmap_segment_reply | only in file -urpf_update | only in image -urpf_update_reply | only in image -vrrp_vr_add_del | only in image -vrrp_vr_add_del_reply | only in image -vrrp_vr_details | only in image -vrrp_vr_dump | only in image -vrrp_vr_peer_details | only in image -vrrp_vr_peer_dump | only in image -vrrp_vr_set_peers | only in image -vrrp_vr_set_peers_reply | only in image -vrrp_vr_start_stop | only in image -vrrp_vr_start_stop_reply | only in image -vrrp_vr_track_if_add_del | only in image -vrrp_vr_track_if_add_del_reply | only in image -vrrp_vr_track_if_details | only in image -vrrp_vr_track_if_dump | only in image -vxlan_add_del_tunnel | definition changed -vxlan_add_del_tunnel_reply | definition changed -vxlan_gpe_add_del_tunnel | definition changed -vxlan_gpe_add_del_tunnel_reply | definition changed -vxlan_gpe_tunnel_details | definition changed -vxlan_gpe_tunnel_dump | definition changed -vxlan_offload_rx | definition changed -vxlan_tunnel_details | definition changed -vxlan_tunnel_dump | definition changed - -Found 279 api message signature differences - -### Patches that changed API definitions - -| @c extras/deprecated/dpdk-hqos/api/dpdk.api || -| ------- | ------- | -| [548d70de6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=548d70de6) | misc: deprecate dpdk hqos | - -| @c extras/deprecated/netmap/netmap.api || -| ------- | ------- | -| [7db6ab03d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7db6ab03d) | misc: deprecate netmap and ixge drivers | - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [933fcf489](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=933fcf489) | api: API cleanup | -| [7db6ab03d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7db6ab03d) | misc: deprecate netmap and ixge drivers | - -| @c src/vnet/tunnel/tunnel_types.api || -| ------- | ------- | -| [14053c9db](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=14053c9db) | ipip: Multi-point interface | -| [59ff918ea](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=59ff918ea) | tunnel: Common types for IP tunnels | - -| @c src/vnet/policer/policer_types.api || -| ------- | ------- | -| [cd01fb423](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cd01fb423) | policer: API cleanup | - -| @c src/vnet/policer/policer.api || -| ------- | ------- | -| [cd01fb423](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cd01fb423) | policer: API cleanup | - -| @c src/vnet/lisp-gpe/lisp_gpe.api || -| ------- | ------- | -| [58db6e16c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58db6e16c) | lisp: API cleanup | - -| @c src/vnet/teib/teib.api || -| ------- | ------- | -| [03ce46219](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=03ce46219) | teib: Rename NHRP to TEIB | - -| @c src/vnet/ip-neighbor/ip_neighbor.api || -| ------- | ------- | -| [240dcb24a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=240dcb24a) | ip-neighbor: Add flush API | -| [e64e5fff4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e64e5fff4) | tests: implement ipaddress convenience methods | -| [c87fbb417](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c87fbb417) | ip-neighbor: Replace feature for the ip-neighbor data-base | -| [8e7fdddd3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8e7fdddd3) | ip-neighbor: add description to the age parameter | -| [9c1928f81](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9c1928f81) | ip-neighbor: populate neighbor age via API | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [6fdd7a5f7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6fdd7a5f7) | session: improve .api comments slightly | -| [9845c20d7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9845c20d7) | session: add option to preallocate fifo headers | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | -| [256779c85](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=256779c85) | udp: remove connected udp transport proto | -| [888d9f05e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=888d9f05e) | session: remove obsolete apis | -| [07063b8ea](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=07063b8ea) | session: api to add new transport types | -| [b4e5e50fe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b4e5e50fe) | session: API cleanup | -| [2de9c0f92](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de9c0f92) | svm: minimal initial fifo | - -| @c src/vnet/interface_types.api || -| ------- | ------- | -| [c4ae0fffb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c4ae0fffb) | interface: fix interface_types.api enums | - -| @c src/vnet/vxlan/vxlan.api || -| ------- | ------- | -| [7c0eb56f4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7c0eb56f4) | vxlan: vxlan/vxlan.api API cleanup | - -| @c src/vnet/vxlan-gbp/vxlan_gbp.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | - -| @c src/vnet/gre/gre.api || -| ------- | ------- | -| [48ac1c2b2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=48ac1c2b2) | gre: improve .api descriptions | -| [8ab4e507c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8ab4e507c) | gre: add missing .api edits | -| [e5b94dded](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5b94dded) | gre: Tunnel encap/decap flags | -| [59ff918ea](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=59ff918ea) | tunnel: Common types for IP tunnels | - -| @c src/vnet/span/span.api || -| ------- | ------- | -| [908965db7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=908965db7) | span: API cleanup | - -| @c src/vnet/srv6/sr.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | -| [0938eba15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0938eba15) | sr: srv6 API cleanup | -| [79bfd2725](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=79bfd2725) | sr: SRv6 uN behavior | - -| @c src/vnet/srv6/sr_types.api || -| ------- | ------- | -| [0938eba15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0938eba15) | sr: srv6 API cleanup | - -| @c src/vnet/pg/pg.api || -| ------- | ------- | -| [db86329ab](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=db86329ab) | pg: API cleanup | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | -| [145e330f0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=145e330f0) | l2: API cleanup | - -| @c src/vnet/lldp/lldp.api || -| ------- | ------- | -| [1c684f9af](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1c684f9af) | lldp: API cleanup | - -| @c src/vnet/vxlan-gpe/vxlan_gpe.api || -| ------- | ------- | -| [1c2002a31](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1c2002a31) | vxlan: vxlan-gpe/vxlan-gpe.cpi API cleanup | - -| @c src/vnet/lisp-cp/one.api || -| ------- | ------- | -| [58db6e16c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58db6e16c) | lisp: API cleanup | - -| @c src/vnet/lisp-cp/lisp_types.api || -| ------- | ------- | -| [58db6e16c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58db6e16c) | lisp: API cleanup | - -| @c src/vnet/lisp-cp/lisp.api || -| ------- | ------- | -| [58db6e16c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58db6e16c) | lisp: API cleanup | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [d88fc0fce](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d88fc0fce) | tap: refactor existing flags | -| [073d74d0b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=073d74d0b) | tap: implement sw_interface_tap_v2_dump filtering by sw_if_index | -| [206acf84d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=206acf84d) | tap: add initial support for tun | -| [b49bc1ae6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b49bc1ae6) | tap: add support for persistance | - -| @c src/vnet/devices/virtio/vhost_user.api || -| ------- | ------- | -| [bc0d9ff67](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bc0d9ff67) | virtio: support virtio 1.1 packed ring in vhost | - -| @c src/vnet/devices/virtio/virtio.api || -| ------- | ------- | -| [53f06a014](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53f06a014) | vlib: move pci api types from vnet/pci to vlib/pci | - -| @c src/vnet/ipsec/ipsec_types.api || -| ------- | ------- | -| [abc5660c6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=abc5660c6) | ipsec: User can choose the UDP source port | -| [287d5e109](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=287d5e109) | ipsec: API cleanup | -| [5893747d7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5893747d7) | api: ipsec: add missing IS_INBOUND flag. | -| [2fcd265d3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2fcd265d3) | ipsec: Revert API cleanup | -| [666ece35c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=666ece35c) | ipsec: API cleanup | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [48d32b43c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=48d32b43c) | ipsec: provide stat index in sa details | -| [287d5e109](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=287d5e109) | ipsec: API cleanup | -| [2fcd265d3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2fcd265d3) | ipsec: Revert API cleanup | -| [666ece35c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=666ece35c) | ipsec: API cleanup | -| [282872127](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=282872127) | ipsec: IPSec protection for multi-point tunnel interfaces | - -| @c src/vnet/ethernet/p2p_ethernet.api || -| ------- | ------- | -| [bdfe5955f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdfe5955f) | ethernet: add sanity checks to p2p_ethernet_add/del | - -| @c src/vnet/bonding/bond.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | - -| @c src/vnet/mpls/mpls.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | -| [39ae0a07a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=39ae0a07a) | mpls: add user defined name tag to mpls tunnels | - -| @c src/vnet/syslog/syslog.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [59f71132e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=59f71132e) | ip: Replace Sematics for Interface IP addresses | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [14053c9db](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=14053c9db) | ipip: Multi-point interface | -| [59ff918ea](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=59ff918ea) | tunnel: Common types for IP tunnels | - -| @c src/vnet/srmpls/sr_mpls.api || -| ------- | ------- | -| [0938eba15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0938eba15) | sr: srv6 API cleanup | -| [00ec4019b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00ec4019b) | sr: API cleanup | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [f5d38e05a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f5d38e05a) | api: ip: add IP_ROUTE_LOOKUP API | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | -| [d724e4f43](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d724e4f43) | urpf: Unicast reverse Path Forwarding (plugin) | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [164c44f0b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=164c44f0b) | ip: Fix the AH/ESP protocol numbers on the API | -| [7dd63e5cc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7dd63e5cc) | ip: change ip API enums address_family and ip_proto size to u8 | -| [3ec09e924](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3ec09e924) | ip: ip_address_t uses ip46_address_t | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | - -| @c src/plugins/ikev2/ikev2.api || -| ------- | ------- | -| [933c4ca5a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=933c4ca5a) | ikev2: fix string in api | -| [59fea5a6a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=59fea5a6a) | ikev2: make liveness params configurable | -| [8ceb44a89](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8ceb44a89) | ikev2: fix typo in .api description | -| [e5d34919b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5d34919b) | ikev2: add support for custom ipsec-over-udp port | -| [b29d523af](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b29d523af) | ikev2: make UDP encap flag configurable | -| [44476c6b2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=44476c6b2) | ikev2: Configure a profile with an existing interface | - -| @c src/plugins/urpf/urpf.api || -| ------- | ------- | -| [d724e4f43](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d724e4f43) | urpf: Unicast reverse Path Forwarding (plugin) | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | - -| @c src/plugins/gtpu/gtpu.api || -| ------- | ------- | -| [00fdf53c7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=00fdf53c7) | gtpu: offload RX flow | - -| @c src/plugins/acl/acl_types.api || -| ------- | ------- | -| [2f8cd9145](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2f8cd9145) | acl: API cleanup | -| [492a5d0bd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=492a5d0bd) | acl: revert acl: api cleanup | -| [aad1ee149](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=aad1ee149) | acl: API cleanup | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [c0e9441e7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0e9441e7) | tests: move defaults from defaultmapping to .api files | -| [2f8cd9145](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2f8cd9145) | acl: API cleanup | -| [492a5d0bd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=492a5d0bd) | acl: revert acl: api cleanup | -| [aad1ee149](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=aad1ee149) | acl: API cleanup | - -| @c src/plugins/nat/dslite/dslite.api || -| ------- | ------- | -| [2c6639c69](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2c6639c69) | nat: move dslite to separate sub-plugin | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [6bb080f1e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bb080f1e) | nat: per vrf session limits | -| [61717cc38](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=61717cc38) | nat: use correct data types for memory sizes | -| [98301bd56](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=98301bd56) | nat: user deletion function & extra metrics | -| [edf777272](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=edf777272) | nat: api & cli command for forcing session cleanup | -| [2c6639c69](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2c6639c69) | nat: move dslite to separate sub-plugin | - -| @c src/plugins/vrrp/vrrp.api || -| ------- | ------- | -| [3fccd0278](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3fccd0278) | vrrp: do not define _details as autoreply | -| [39e9428b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=39e9428b9) | vrrp: add plugin providing vrrp support | - -| @c src/vlib/pci/pci_types.api || -| ------- | ------- | -| [53f06a014](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53f06a014) | vlib: move pci api types from vnet/pci to vlib/pci | - -@page release_notes_2001 Release notes for VPP 20.01 - -More than 1039 commits since the 19.08 release. - -## Features - -- API trace tool - - Add text output (a2ac36c91) -- Binary API Compiler for Python - - Raise ValueError when fieldname is python keyword (ff47fb645) -- Binary API Libraries - - Add API support for marvell PP2 plugin (859b59133) - - Add bapi thread handle to api main structure. (8229580e8) - - Multiple connections per process (39d69112f) - - Multiple socket connections per single process (59cea1a9d) -- Build System - - Add build types helpstring to cmake project (952a7b8b7) - - Add env variable to pass extra cmake args (297365403) - - Add yaml file linting to make checkstyle (6b0dd5502) - - Export vapi generation in vpp-dev (dc20371f8) - - Fix 3rd party CI systems. (86a9441c2) - - Pass 'no-pci' to autgenerated config (be7ef3b5c) -- Crypto ipsecmb Plugin - - Bump to intel-ipsec-mb version 0.53 (d35fefe8b) - - Improve gcm performance using dedicated API. (76a36e83e) -- Infrastructure Library - - Bihash walk cb typedef and continue/stop controls (f50bac1bb) - - Create unformat function for data size parsing (579b16506) - - Implement CLIB\_PAUSE () for aarch64 platforms (18512b002) -- libmemif - - Introduce 'memif\_per\_thread\_' namespace (17f2a7bbf) -- Link Bonding - - Add/del secondary mac address callback (e83aa456b) - - Add /if/lacp/bond-sw-if-index/slave-sw-if-index/partner-state (aa7257863) - - Add weight support for active-backup mode (a1876b84e) - - Fix interface deletion (cc3aac056) -- Miscellaneous - - Add address sanitizer heap instrumentation (9fb6d40eb) - - Add CentOS 8 package support (c025329bb) - - Add gdb helpers for vlib buffers (2b65f9ca0) - - Add lcov scripts, README.md (8d74caa0a) - - Add "maxframe" and "rate" to packet-generator cli. (87d7bac5c) - - Add "show run summary" (ac78f8a90) - - Add vnet classify filter set support (f5667c305) - - Classifier-based packet trace filter (9137e5400) - - Improve pcap drop trace output (9382ad9b3) - - Update gitignore for /test/ext/.d (8161d73d7) -- Physical Memory Allocator - - Always lock pages (801c7016a) -- Plugins - - AVF Device driver - - Improve timeout handling (1a7bb281f) - - Print queue id in packet trace (c33eddebe) - - Buffer Metadata Modification Tracker - - Buffer metadata change tracker plugin (d7b306657) - - builtinurl - - New plugin (43765e2b4) - - DHCP - - Ipv6 prefix delegation improvements (d318a996b) - - Move to plugin (02bfd641b) - - DPDK - - Add devargs support (f2bde7ac5) - - Add function to add/del extra MAC addrs (153727743) - - Add TSO support in dpdk plugin. (de5ed58fd) - - Apply dual loop unrolling in DPDK TX (fe2523d1a) - - Bump DPDK version to 19.08 (b6103105f) - - Enable bnxt PMD (c3731ac89) - - Ipsec tunnel support for ip6-in-ip4 (5025d40a1) - - QAT devices update, add c4xxx and xeon d15xx (4d843b994) - - Group Based Policy (GBP) - - Add extended SFC unit tests (a3c8ca10e) - - Host Stack Applications - - Add ckpair & crypto engine in vpp\_echo (7c40a3837) - - Add option for multiple ips (f98e59b86) - - Add periodic timing (ff6cdcca2) - - Improve for mq-intensive (b2fce36c8) - - Less verbose logging for many sessions (08f26641f) - - Make APP\_OPTIONS\_PREALLOC\_FIFO\_PAIRS configurable (7028a0157) - - http\_static - - Add dynamic GET / POST method hooks (5554c56a6) - - Add "http static cache clear" CLI (e0fd9ed11) - - Add .json content (71a5da0c8) - - Internet Key Exchange (IKEv2) Protocol - - Add support for GCM cipher (de2dd6c35) - - IPv6 Segment Routing Mobile - - (57584d99d) - - Load Balancer - - Add APIs for set interface nat4 and nat6 (33538a150) - - NAT - - Handoff traffic matching for dynamic NAT (22bb417e9) - - Ping - - Move the echo responder into the ping plugin (f6c8f5090) - - QUIC protocol - - Add aggregated quicly stats (deaf97f45) - - Add cli command for stats (922f0b211) - - Add conn-timeout config option (2f566c23f) - - Add more detailed statistics (1802fcc5f) - - Add support for ckpair & crypto engine (dcbbf2833) - - Add support for unidirectional streams (c00f480ba) - - Add Tx, Rx and packet drop counters (ff1f6faaa) - - Create custom event logger (dd4d8ac29) - - Implement crypto contexts (d1b9e7068) - - Make quic fifo size configurable via cli (00078b991) - - Update quicly to v0.0.5 (72c159e64) - - Update quicly to v0.0.6-vpp (3afac8f81) - - Update quicly to v0.0.7-vpp (69885b72a) - - Update quicly to v0.0.8-vpp (ecb9d18c5) - - Update quicly to v0.0.9-vpp (84def7cb7) - - RDMA (ibverb) driver - - Add rdma API (812afe712) - - Add support for input feature arcs (74eba446b) - - Add support for MAC changes (0dcafcc50) - - API: prepare support for direct verb (d8c1ef925) - - Time-based MAC filter - - Add a "top" command to watch device stats (2c41a61d5) - - Add the "mactime.json" builtin URL (ef3c11ca9) - - vmxnet3 device driver - - Per interface gso support (2985e0af6) -- Python binding for the VPP API - - Add a per-call \_timeout option (e2ccdf031) - - Add call stats (fd574087e) - - Add repr to packer types for troubleshooting (14b0b4791) - - Add wrapper to validate crc manifest (c046d709e) - - Enhance MACAddress() equality (6af62565e) - - Introduce read\_blocking (0938547ea) - - Let async calls return context (2f6e0c600) - - Support default for type alias decaying to basetype (418ebb711) -- Sphinx Documents - - Add spellcheck to 'make docs' sphinx docs (340c15c6e) -- Statistics Segment - - Add /if/\/\/state for lacp interface state (0f09a828a) -- SVM Library - - Improve fifo segment verbose cli (f8461bfb4) -- Test Infrastructure - - Add cli\_return\_response to vpp\_papi\_provider (5932ce17e) - - Add test run time. (0c6293230) - - Support setting random seed (45a95dd78) - - Support worker threads (4ecbf105a) - - Test tls case (419d31f81) -- Vector Library - - Add flag to explicitelly mark nodes which can init per-node packet trace (7ca5aaac1) - - Add max-size configuration parameter for pmalloc (842506f3c) - - Add 'wait' cli command (bfd7d294d) - - Enhance the "show cli" debug CLI command (a1f5a956e) -- VNET - - Classify - - Per-interface rx/tx pcap capture filters (d28437cdf) - - Use vector code even when data is not aligned (830493392) - - Vpp packet tracer support (87d24db65) - - Ethernet - - All dmac checks include secondary addrs (42bde459b) - - Dmac filter checks secondary mac addrs (d459bf344) - - FIB - - Adjacency creation notifications for dlegates (77cfc0171) - - Decouple source from priority and behaviour (3bab8f9c5) - - Table Replace (9db6ada77) - - FLOW - - Add 'drop' and 'redirect-to-queue' actions support (e8c9f4f1c) - - Add ethernet flow (4ff8d615c) - - Add GTP support (bf85a98fb) - - GRE - - Multi-point interfaces (5f8f61733) - - GSO - - Add protocol header parser (72e7312af) - - Interface Common - - Callback to manage extra MAC addresses (e0792fdff) - - Dump the interface device type (de312c2d5) - - IPIP - - Tunnel flags controlling copying data to/from payload/encap (9534696b4) - - IPSec - - Add 'detail' option to 'sh ipsec sa' (670027a50) - - Add insecure option for format of SA (01d61e788) - - Bind an SA to a worker (f62a8c013) - - Remove dedicated IPSec tunnels (12989b538) - - Support 4o6 and 6o4 for tunnel protect (b325983a4) - - IPv4 LPM - - Add shallow virtual reassembly functionality (de34c35fc) - - Add tracing for ipv6 frag headers (0eb75d0e9) - - Allow addrs from the same prefix on intf (6c92f5bab) - - Apply dual loop unrolling in ip4\_input (86b1871ba) - - Apply dual loop unrolling in ip4\_rewrite (840f64b4b) - - IPv4 LPM - - Protocol Independent IP Neighbors (cbe25aab3) - - Punt rather than drop unkown IPv6 ICMP packets (1afe95272) - - Reassembly: trace ip headers over worker handoffs (8563cb389) - - Segment Routing (IPv6 and MPLS) - - Add "set sr encaps hop-limit" command (eeb5fb3a5) - - Session Layer - - Add certificate store (79f89537c) - - Add crypto context (de6caf481) - - Add explicit reset api (dfb3b8771) - - Add mq debug cli (cfdb10918) - - Add session enable option in config file (1292d19c7) - - Builtin app rx notifications regardless of state (5c29029ef) - - Ckpair store & crypto engine as mq params (45ec9f49b) - - Improve cli (5bb23ecd0) - - Increasing the Header lengthe size (93e060aee) - - Limit pacer bucket size (7c8f828ba) - - More show cli output (91f90d082) - - Reschedule asap when snd space constrained (dd97a48d9) - - Support registration of custom crypto engines (79ba25d40) - - Support for segments larger than 4GB (ef4f3e7fe) - - Add opaque data to show cli (d9035a409) - - Infra for transports to send buffers (2a7ea2ee9) - - Support pacer idle timeouts (11e9e3510) - - TAP Drivers - - Add check for vhost-net backend (39807d02c) - - Multiqueue support (7c6102b1a) - - TCP - - Add FEATURE.yaml (93e053ebe) - - Add no csum offload config option (f4ce6ba22) - - Add option for always on event logging (a436a4222) - - Allow cc algos to set pacing rate (d206724e7) - - Compute snd time for rate sample (7436b4367) - - Custom checksum calculations for Ipv4/Ipv6 (02833ff32) - - Enable gso in tcp hoststack (1146ff4bc) - - Enable TCP timewait port use (b092b77cf) - - Extend protocol configuration (9094b5c31) - - Force zero window on full rx fifo (182d21983) - - Handle sack reneging (558e3e095) - - Improve lost rxt heuristic (b3dce89a7) - - Improve pacing after idle send periods (c31dc31f8) - - Retry lost retransmits (be237bf02) - - Send rwnd update only if wnd is large enough (017dc4524) - - Set cc\_algo on connection alloc (12f6936cd) - - Track lost rxt segments in byte tracker (46ec6e018) - - Track zero rwnd errors (a495a3ea1) - - Use rate sample rtt in recovery if possible (1dbda64b4) - - Use sacks for timer based recovery (36ebcfffb) - - Validate connections in output (78dae0088) - - Validate the IP address while checking TCP connection (cf4c2102d) - - TLS and TLS engine plugins - - Add C API for TLS openssl to set engine (be4d1aa2c) - - Improve connection formating (0d74dd1f8) - - Picotls engine basic enabling for TLS (f83194c2f) -- VPP Comms Library - - Add api to set lcl ip (ef7cbf6ad) - - Add config option for preferred tls engine (d747c3c36) - - Allow non-blocking connects (57c88938f) -- VPP Object Model - - Get interface type from vpp device type (3f4be92ce) - - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/2001) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - -Message Name | Result --------------------------------------------------------------|------------------ -abf_itf_attach_add_del | definition changed -abf_itf_attach_details | definition changed -abf_policy_add_del | definition changed -abf_policy_details | definition changed -af_packet_create | definition changed -af_packet_create_reply | definition changed -af_packet_delete | definition changed -af_packet_details | definition changed -af_packet_set_l4_cksum_offload | definition changed -api_versions_reply | definition changed -app_add_cert_key_pair | only in image -app_add_cert_key_pair_reply | only in image -app_attach | only in image -app_attach_reply | only in image -app_del_cert_key_pair | only in image -app_del_cert_key_pair_reply | only in image -avf_create_reply | definition changed -avf_delete | definition changed -bd_ip_mac_add_del | definition changed -bd_ip_mac_details | definition changed -bfd_udp_add | definition changed -bfd_udp_auth_activate | definition changed -bfd_udp_auth_deactivate | definition changed -bfd_udp_del | definition changed -bfd_udp_get_echo_source_reply | definition changed -bfd_udp_mod | definition changed -bfd_udp_session_details | definition changed -bfd_udp_session_set_flags | definition changed -bfd_udp_set_echo_source | definition changed -bier_disp_entry_add_del | definition changed -bier_disp_entry_details | definition changed -bier_disp_table_add_del | definition changed -bier_route_add_del | definition changed -bier_table_add_del | definition changed -bond_create | definition changed -bond_create_reply | definition changed -bond_delete | definition changed -bond_detach_slave | definition changed -bond_enslave | definition changed -builtinurl_enable | only in image -builtinurl_enable_reply | only in image -bvi_create | definition changed -cdp_enable_disable | definition changed -classify_add_del_session | definition changed -classify_add_del_table | definition changed -classify_set_interface_ip_table | definition changed -classify_set_interface_l2_tables | definition changed -classify_table_by_interface | definition changed -classify_table_by_interface_reply | definition changed -cli_inband | definition changed -cli_inband_reply | definition changed -collect_detailed_interface_stats | definition changed -connect_sock | definition changed -cop_interface_enable_disable | definition changed -cop_whitelist_enable_disable | definition changed -create_loopback | definition changed -create_loopback_instance | definition changed -create_loopback_instance_reply | definition changed -create_loopback_reply | definition changed -create_subif | definition changed -create_subif_reply | definition changed -create_vhost_user_if | definition changed -create_vhost_user_if_reply | definition changed -create_vlan_subif | definition changed -create_vlan_subif_reply | definition changed -ct6_enable_disable | definition changed -delete_loopback | definition changed -delete_subif | definition changed -delete_vhost_user_if | definition changed -dhcp6_client_enable_disable | definition changed -dhcp6_clients_enable_disable | definition changed -dhcp6_pd_client_enable_disable | definition changed -dhcp6_pd_reply_event | definition changed -dhcp6_pd_send_client_message | definition changed -dhcp6_reply_event | definition changed -dhcp6_send_client_message | definition changed -dhcp_client_config | definition changed -dhcp_client_details | definition changed -dhcp_compl_event | definition changed -dhcp_plugin_control_ping | only in image -dhcp_plugin_control_ping_reply | only in image -dhcp_plugin_get_version | only in image -dhcp_plugin_get_version_reply | only in image -dhcp_proxy_config | definition changed -dhcp_proxy_details | definition changed -dhcp_proxy_dump | definition changed -dhcp_proxy_set_vss | definition changed -dslite_add_del_pool_addr_range | definition changed -dslite_address_details | definition changed -dslite_get_aftr_addr_reply | definition changed -dslite_get_b4_addr_reply | definition changed -dslite_set_aftr_addr | definition changed -dslite_set_b4_addr | definition changed -feature_enable_disable | definition changed -feature_gso_enable_disable | only in image -feature_gso_enable_disable_reply | only in image -flow_classify_details | definition changed -flow_classify_dump | definition changed -flow_classify_set_interface | definition changed -flowprobe_params | definition changed -flowprobe_tx_interface_add_del | definition changed -gbp_bridge_domain_add | definition changed -gbp_bridge_domain_details | definition changed -gbp_contract_add_del | definition changed -gbp_contract_details | definition changed -gbp_endpoint_add | definition changed -gbp_endpoint_details | definition changed -gbp_endpoint_group_add | definition changed -gbp_endpoint_group_details | definition changed -gbp_ext_itf_add_del | definition changed -gbp_ext_itf_details | definition changed -gbp_recirc_add_del | definition changed -gbp_recirc_details | definition changed -gbp_route_domain_add | definition changed -gbp_route_domain_details | definition changed -gbp_subnet_add_del | definition changed -gbp_subnet_details | definition changed -gbp_vxlan_tunnel_add | definition changed -gbp_vxlan_tunnel_add_reply | definition changed -gbp_vxlan_tunnel_details | definition changed -geneve_add_del_tunnel | definition changed -geneve_add_del_tunnel_reply | definition changed -geneve_tunnel_details | definition changed -geneve_tunnel_dump | definition changed -get_first_msg_id | definition changed -gre_tunnel_add_del | definition changed -gre_tunnel_add_del_reply | definition changed -gre_tunnel_details | definition changed -gre_tunnel_dump | definition changed -gtpu_add_del_tunnel | definition changed -gtpu_add_del_tunnel_reply | definition changed -gtpu_tunnel_details | definition changed -gtpu_tunnel_dump | definition changed -http_static_enable | definition changed -hw_interface_set_mtu | definition changed -igmp_clear_interface | definition changed -igmp_details | definition changed -igmp_dump | definition changed -igmp_enable_disable | definition changed -igmp_event | definition changed -igmp_group_prefix_details | definition changed -igmp_group_prefix_set | definition changed -igmp_listen | definition changed -igmp_proxy_device_add_del | definition changed -igmp_proxy_device_add_del_interface | definition changed -ikev2_initiate_sa_init | definition changed -ikev2_profile_add_del | definition changed -ikev2_profile_set_auth | definition changed -ikev2_profile_set_id | definition changed -ikev2_profile_set_ts | definition changed -ikev2_set_esp_transforms | definition changed -ikev2_set_ike_transforms | definition changed -ikev2_set_responder | definition changed -ikev2_set_sa_lifetime | definition changed -input_acl_set_interface | definition changed -interface_name_renumber | definition changed -ioam_cache_ip6_enable_disable | definition changed -ioam_enable | definition changed -ioam_export_ip6_enable_disable | definition changed -ip4_arp_event | only in file -ip6_add_del_address_using_prefix | definition changed -ip6_nd_address_autoconfig | definition changed -ip6_nd_event | only in file -ip6_ra_event | definition changed -ip6nd_proxy_add_del | definition changed -ip6nd_proxy_details | definition changed -ip6nd_send_router_solicitation | definition changed -ip_address_details | definition changed -ip_address_dump | definition changed -ip_container_proxy_add_del | definition changed -ip_container_proxy_details | definition changed -ip_details | definition changed -ip_dump | definition changed -ip_mroute_add_del | definition changed -ip_mroute_details | definition changed -ip_mroute_dump | definition changed -ip_mtable_details | definition changed -ip_neighbor_add_del | definition changed -ip_neighbor_config | only in image -ip_neighbor_config_reply | only in image -ip_neighbor_details | definition changed -ip_neighbor_dump | definition changed -ip_neighbor_event | only in image -ip_probe_neighbor | only in file -ip_probe_neighbor_reply | only in file -ip_punt_police | definition changed -ip_punt_redirect | definition changed -ip_punt_redirect_details | definition changed -ip_punt_redirect_dump | definition changed -ip_reassembly_enable_disable | definition changed -ip_reassembly_get | definition changed -ip_reassembly_get_reply | definition changed -ip_reassembly_set | definition changed -ip_route_add_del | definition changed -ip_route_details | definition changed -ip_route_dump | definition changed -ip_scan_neighbor_enable_disable | only in file -ip_scan_neighbor_enable_disable_reply | only in file -ip_source_and_port_range_check_add_del | definition changed -ip_source_and_port_range_check_interface_add_del | definition changed -ip_source_check_interface_add_del | definition changed -ip_table_add_del | definition changed -ip_table_details | definition changed -ip_table_flush | only in image -ip_table_flush_reply | only in image -ip_table_replace_begin | only in image -ip_table_replace_begin_reply | only in image -ip_table_replace_end | only in image -ip_table_replace_end_reply | only in image -ip_unnumbered_details | definition changed -ip_unnumbered_dump | definition changed -ipfix_classify_table_add_del | definition changed -ipfix_classify_table_details | definition changed -ipfix_exporter_details | definition changed -ipip_6rd_add_tunnel | definition changed -ipip_6rd_add_tunnel_reply | definition changed -ipip_6rd_del_tunnel | definition changed -ipip_add_tunnel | definition changed -ipip_add_tunnel_reply | definition changed -ipip_del_tunnel | definition changed -ipip_tunnel_details | definition changed -ipip_tunnel_dump | definition changed -ipsec_spd_details | definition changed -ipsec_spd_entry_add_del | definition changed -ipsec_tunnel_if_add_del | definition changed -ipsec_tunnel_protect_del | definition changed -ipsec_tunnel_protect_details | definition changed -ipsec_tunnel_protect_dump | definition changed -ipsec_tunnel_protect_update | definition changed -l2_arp_term_event | only in image -l2_emulation | definition changed -l2tpv3_create_tunnel | definition changed -l2tpv3_create_tunnel_reply | definition changed -l2tpv3_interface_enable_disable | definition changed -l2tpv3_set_lookup_key | definition changed -l2tpv3_set_tunnel_cookies | definition changed -l3xc_del | definition changed -l3xc_details | definition changed -l3xc_dump | definition changed -l3xc_update | definition changed -lb_add_del_as | definition changed -lb_add_del_intf_nat4 | only in image -lb_add_del_intf_nat4_reply | only in image -lb_add_del_intf_nat6 | only in image -lb_add_del_intf_nat6_reply | only in image -lb_add_del_vip | definition changed -lb_as_details | definition changed -lb_as_dump | definition changed -lb_conf | definition changed -lb_flush_vip | definition changed -lb_vip_details | definition changed -lb_vip_dump | definition changed -log_details | definition changed -log_dump | definition changed -mactime_add_del_range | definition changed -mactime_details | only in image -mactime_dump | only in image -mactime_dump_reply | only in image -mactime_enable_disable | definition changed -map_add_del_rule | definition changed -map_add_domain | definition changed -map_domain_details | definition changed -map_if_enable_disable | definition changed -map_param_add_del_pre_resolve | definition changed -map_param_get_reply | definition changed -map_param_set_icmp | definition changed -map_param_set_reassembly | only in file -map_param_set_reassembly_reply | only in file -map_param_set_traffic_class | definition changed -map_rule_details | definition changed -mdata_enable_disable | only in image -mdata_enable_disable_reply | only in image -memclnt_create | definition changed -memclnt_delete | definition changed -memif_create | definition changed -memif_create_reply | definition changed -memif_delete | definition changed -memif_details | definition changed -memif_socket_filename_add_del | definition changed -memif_socket_filename_details | definition changed -mfib_signal_details | definition changed -modify_vhost_user_if | definition changed -mpls_ip_bind_unbind | definition changed -mpls_route_add_del | definition changed -mpls_route_details | definition changed -mpls_route_dump | definition changed -mpls_table_add_del | definition changed -mpls_table_details | definition changed -mpls_tunnel_add_del | definition changed -mpls_tunnel_add_del_reply | definition changed -mpls_tunnel_details | definition changed -mpls_tunnel_dump | definition changed -nat44_add_del_address_range | definition changed -nat44_add_del_identity_mapping | definition changed -nat44_add_del_interface_addr | definition changed -nat44_add_del_lb_static_mapping | definition changed -nat44_add_del_static_mapping | definition changed -nat44_address_details | definition changed -nat44_del_session | definition changed -nat44_identity_mapping_details | definition changed -nat44_interface_add_del_feature | definition changed -nat44_interface_add_del_output_feature | definition changed -nat44_interface_addr_details | definition changed -nat44_interface_details | definition changed -nat44_interface_output_feature_details | definition changed -nat44_lb_static_mapping_add_del_local | definition changed -nat44_lb_static_mapping_details | definition changed -nat44_static_mapping_details | definition changed -nat44_user_details | definition changed -nat44_user_session_details | definition changed -nat44_user_session_dump | definition changed -nat64_add_del_interface_addr | definition changed -nat64_add_del_interface | definition changed -nat64_add_del_pool_addr_range | definition changed -nat64_add_del_prefix | definition changed -nat64_add_del_static_bib | definition changed -nat64_bib_details | definition changed -nat64_interface_details | definition changed -nat64_pool_addr_details | definition changed -nat64_prefix_details | definition changed -nat64_st_details | definition changed -nat66_add_del_interface | definition changed -nat66_add_del_static_mapping | definition changed -nat66_interface_details | definition changed -nat66_static_mapping_details | definition changed -nat_det_add_del_map | definition changed -nat_det_close_session_in | definition changed -nat_det_close_session_out | definition changed -nat_det_forward | definition changed -nat_det_forward_reply | definition changed -nat_det_map_details | definition changed -nat_det_reverse | definition changed -nat_det_reverse_reply | definition changed -nat_det_session_details | definition changed -nat_det_session_dump | definition changed -nat_get_reass | only in file -nat_get_reass_reply | only in file -nat_ha_get_failover_reply | definition changed -nat_ha_get_listener_reply | definition changed -nat_ha_set_failover | definition changed -nat_ha_set_listener | definition changed -nat_reass_details | only in file -nat_reass_dump | only in file -nat_set_reass | only in file -nat_set_reass_reply | only in file -nat_worker_details | definition changed -nhrp_details | only in image -nhrp_dump | only in image -nhrp_entry_add_del | only in image -nhrp_entry_add_del_reply | only in image -nsh_add_del_entry | definition changed -nsh_add_del_map | definition changed -nsh_map_details | definition changed -nsim_cross_connect_enable_disable | definition changed -nsim_output_feature_enable_disable | definition changed -output_acl_set_interface | definition changed -p2p_ethernet_add | definition changed -p2p_ethernet_add_reply | definition changed -p2p_ethernet_del | definition changed -pipe_create | definition changed -pipe_create_reply | definition changed -pipe_delete | definition changed -pipe_details | definition changed -policer_classify_details | definition changed -policer_classify_dump | definition changed -policer_classify_set_interface | definition changed -pot_profile_activate | definition changed -pot_profile_add | definition changed -pot_profile_del | definition changed -pppoe_add_del_session | definition changed -pppoe_add_del_session_reply | definition changed -pppoe_session_details | definition changed -pppoe_session_dump | definition changed -proxy_arp_add_del | definition changed -proxy_arp_details | definition changed -proxy_arp_intfc_enable_disable | definition changed -punt_reason_details | definition changed -punt_reason_dump | definition changed -punt_socket_details | definition changed -punt_socket_register | definition changed -punt_socket_register_reply | definition changed -qos_mark_dump | definition changed -qos_mark_enable_disable | definition changed -qos_record_details | definition changed -qos_record_enable_disable | definition changed -qos_store_details | definition changed -qos_store_enable_disable | definition changed -rdma_create | only in image -rdma_create_reply | only in image -rdma_delete | only in image -rdma_delete_reply | only in image -reset_fib | only in file -reset_fib_reply | only in file -set_arp_neighbor_limit | only in file -set_arp_neighbor_limit_reply | only in file -set_ip_flow_hash | definition changed -set_ipfix_exporter | definition changed -set_punt | definition changed -show_version_reply | definition changed -show_vpe_system_time_reply | definition changed -sockclnt_create | definition changed -sockclnt_create_reply | definition changed -sr_set_encap_hop_limit | only in image -sr_set_encap_hop_limit_reply | only in image -stn_add_del_rule | definition changed -stn_rules_details | definition changed -svs_details | definition changed -svs_enable_disable | definition changed -svs_route_add_del | definition changed -svs_table_add_del | definition changed -sw_if_l2tpv3_tunnel_details | definition changed -sw_interface_add_del_address | definition changed -sw_interface_add_del_mac_address | only in image -sw_interface_add_del_mac_address_reply | only in image -sw_interface_bond_details | definition changed -sw_interface_clear_stats | definition changed -sw_interface_details | definition changed -sw_interface_dump | definition changed -sw_interface_event | definition changed -sw_interface_get_mac_address | definition changed -sw_interface_get_mac_address_reply | definition changed -sw_interface_get_table | definition changed -sw_interface_ip6_enable_disable | definition changed -sw_interface_ip6_set_link_local_address | definition changed -sw_interface_ip6nd_ra_config | definition changed -sw_interface_ip6nd_ra_prefix | definition changed -sw_interface_lacp_details | definition changed -sw_interface_rx_placement_details | definition changed -sw_interface_rx_placement_dump | definition changed -sw_interface_set_bond_weight | only in image -sw_interface_set_bond_weight_reply | only in image -sw_interface_set_flags | definition changed -sw_interface_set_geneve_bypass | definition changed -sw_interface_set_gtpu_bypass | definition changed -sw_interface_set_ip_directed_broadcast | definition changed -sw_interface_set_mac_address | definition changed -sw_interface_set_mpls_enable | definition changed -sw_interface_set_mtu | definition changed -sw_interface_set_rx_mode | definition changed -sw_interface_set_rx_placement | definition changed -sw_interface_set_table | definition changed -sw_interface_set_unnumbered | definition changed -sw_interface_set_vxlan_gbp_bypass | definition changed -sw_interface_slave_details | definition changed -sw_interface_slave_dump | definition changed -sw_interface_tag_add_del | definition changed -sw_interface_tap_v2_details | definition changed -sw_interface_tap_v2_dump | definition changed -sw_interface_vhost_user_details | definition changed -sw_interface_vhost_user_dump | definition changed -sw_interface_virtio_pci_details | definition changed -syslog_get_sender_reply | definition changed -syslog_set_sender | definition changed -tap_create_v2 | definition changed -tap_create_v2_reply | definition changed -tap_delete_v2 | definition changed -tcp_configure_src_addresses | definition changed -tls_openssl_set_engine | only in image -tls_openssl_set_engine_reply | only in image -trace_plugin_msg_ids | definition changed -udp_encap_add | definition changed -udp_encap_details | definition changed -udp_ping_add_del | definition changed -udp_ping_export | definition changed -virtio_pci_create | definition changed -virtio_pci_create_reply | definition changed -virtio_pci_delete | definition changed -vmxnet3_create | definition changed -vmxnet3_create_reply | definition changed -vmxnet3_delete | definition changed -vmxnet3_details | definition changed -vxlan_gbp_tunnel_add_del | definition changed -vxlan_gbp_tunnel_add_del_reply | definition changed -vxlan_gbp_tunnel_details | definition changed -vxlan_gbp_tunnel_dump | definition changed -vxlan_gpe_ioam_enable | definition changed -vxlan_gpe_ioam_export_enable_disable | definition changed -vxlan_gpe_ioam_transit_disable | definition changed -vxlan_gpe_ioam_transit_enable | definition changed -vxlan_gpe_ioam_vni_disable | definition changed -vxlan_gpe_ioam_vni_enable | definition changed -want_bfd_events | definition changed -want_dhcp6_pd_reply_events | definition changed -want_ip4_arp_events | only in file -want_ip4_arp_events_reply | only in file -want_ip6_nd_events | only in file -want_ip6_nd_events_reply | only in file -want_ip6_ra_events | definition changed -want_ip_neighbor_events | only in image -want_ip_neighbor_events_reply | only in image -want_l2_arp_term_events | only in image -want_l2_arp_term_events_reply | only in image -want_l2_macs_events | definition changed - -Found 493 api message signature differences - -### Patches that changed API definitions - -| @c src/vlibmemory/memclnt.api || -| ------- | ------- | -| [8e388390d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8e388390d) | vlib: use explicit types in api | -| [daa4bff16](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=daa4bff16) | api: memclnt api use string type. | -| [7adaa226e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7adaa226e) | api: revert use string type for strings in memclnt.api | -| [2959d42fe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2959d42fe) | api: use string type for strings in memclnt.api | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | - -| @c src/examples/sample-plugin/sample/sample.api || -| ------- | ------- | -| [33a58171e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33a58171e) | api: autogenerate api trace print/endian | -| [78d91cf9a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=78d91cf9a) | sample-plugin: refactor .api to use explicit types | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [418ebb711](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=418ebb711) | papi: support default for type alias decaying to basetype | -| [9485d99bd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9485d99bd) | interface: Allow VLAN tag-rewrite on non-sub-interfaces too. | -| [c12eae73f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c12eae73f) | interface: shmemioerror while getting name_filter arg | -| [de312c2d5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=de312c2d5) | interface: dump the interface device type | -| [e0792fdff](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e0792fdff) | interface: callback to manage extra MAC addresses | -| [75761b933](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75761b933) | api: split vl_api_prefix into two | -| [e5ff5a36d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5ff5a36d) | api: enforce vla is last and fixed string type | -| [053204ab0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=053204ab0) | api: Cleanup APIs interface.api | -| [0ad4a439d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0ad4a439d) | Fix vpp crash bug while deleting dhcp client | -| [9a29f795a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9a29f795a) | vpp_papi_provider.py: update defautmapping. | -| [b8591ac91](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b8591ac91) | API sw_interface_dump: Dump all if index is zero | -| [4a7240636](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4a7240636) | Make sw_interface_dump more compatible with 2.2.0 | -| [6407ba56a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6407ba56a) | api: Add to interface crud - read by sw_if_index. | - -| @c src/vnet/interface_types.api || -| ------- | ------- | -| [053204ab0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=053204ab0) | api: Cleanup APIs interface.api | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [c4c4cf506](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c4c4cf506) | session: move add/del segment msg to mq | -| [79f89537c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=79f89537c) | session: Add certificate store | -| [e5ff5a36d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5ff5a36d) | api: enforce vla is last and fixed string type | -| [458089bba](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=458089bba) | session: move ctrl messages from bapi to mq | -| [8ac1d6d05](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8ac1d6d05) | session: Use parent_handle instead of transport_opts | -| [ba65ca496](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ba65ca496) | Add transport_opts to connect_sock bapi | - -| @c src/vnet/classify/classify.api || -| ------- | ------- | -| [692bfc85f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=692bfc85f) | classify: API cleanup | - -| @c src/vnet/l2tp/l2tp.api || -| ------- | ------- | -| [3ae526271](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3ae526271) | l2: l2tp API cleanup | - -| @c src/vnet/gre/gre.api || -| ------- | ------- | -| [5f8f61733](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5f8f61733) | gre: Multi-point interfaces | -| [814f15948](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=814f15948) | gre: update gre.api with explicit types | -| [d0aed2eb3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d0aed2eb3) | GRE: set gre_tunnel_type init value to zero in API | -| [5a8844bdb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5a8844bdb) | GRE: API update | - -| @c src/vnet/fib/fib_types.api || -| ------- | ------- | -| [1dbcf30b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1dbcf30b7) | fib: Support the POP of a Psuedo Wire Control Word | -| [097fa66b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=097fa66b9) | fib: fib api updates | - -| @c src/vnet/lisp-cp/one.api || -| ------- | ------- | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | - -| @c src/vnet/lisp-cp/lisp.api || -| ------- | ------- | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | - -| @c src/vnet/feature/feature.api || -| ------- | ------- | -| [bf6c5c158](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bf6c5c158) | feature: API cleanup | - -| @c src/vnet/nhrp/nhrp.api || -| ------- | ------- | -| [5f8f61733](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5f8f61733) | gre: Multi-point interfaces | - -| @c src/vnet/qos/qos.api || -| ------- | ------- | -| [4b76c58be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4b76c58be) | qos: api clenup | -| [83832e7ce](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=83832e7ce) | qos: Store function | -| [5281a9029](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5281a9029) | qos: QoS dump APIs | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [dbf68c9aa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dbf68c9aa) | ipsec: Changes to make ipsec encoder/decoders reusable by the plugins | -| [12989b538](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=12989b538) | ipsec: remove dedicated IPSec tunnels | -| [c87b66c86](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c87b66c86) | ipsec: ipsec-tun protect | -| [f2922422d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f2922422d) | ipsec: remove the set_key API | -| [80f6fd53f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=80f6fd53f) | IPSEC: Pass the algorithm salt (used in GCM) over the API | - -| @c src/vnet/ipsec/ipsec_types.api || -| ------- | ------- | -| [dbf68c9aa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dbf68c9aa) | ipsec: Changes to make ipsec encoder/decoders reusable by the plugins | - -| @c src/vnet/lisp-gpe/lisp_gpe.api || -| ------- | ------- | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | - -| @c src/vnet/pci/pci_types.api || -| ------- | ------- | -| [2c504f89c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2c504f89c) | devices: virtio API cleanup | - -| @c src/vnet/bonding/bond.api || -| ------- | ------- | -| [3d1ef873d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3d1ef873d) | bonding: API cleanup | -| [a1876b84e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a1876b84e) | bonding: add weight support for active-backup mode | -| [751e3f382](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=751e3f382) | bonding: add support for numa-only in lacp mode | - -| @c src/vnet/tcp/tcp.api || -| ------- | ------- | -| [956819afa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=956819afa) | tcp: api clenup | - -| @c src/vnet/cop/cop.api || -| ------- | ------- | -| [aa4438a31](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=aa4438a31) | cop: API cleanup | - -| @c src/vnet/ip-neighbor/ip_neighbor.api || -| ------- | ------- | -| [cbe25aab3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cbe25aab3) | ip: Protocol Independent IP Neighbors | - -| @c src/vnet/ethernet/p2p_ethernet.api || -| ------- | ------- | -| [8edca1361](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8edca1361) | p2p ethernet: update p2p_ethernet.api with explicit types. | - -| @c src/vnet/ethernet/ethernet_types.api || -| ------- | ------- | -| [33a58171e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33a58171e) | api: autogenerate api trace print/endian | - -| @c src/vnet/vxlan-gbp/vxlan_gbp.api || -| ------- | ------- | -| [fb27096ee](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fb27096ee) | vxlan-gbp: api cleanup | - -| @c src/vnet/arp/arp.api || -| ------- | ------- | -| [cbe25aab3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cbe25aab3) | ip: Protocol Independent IP Neighbors | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [9534696b4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9534696b4) | ipip: Tunnel flags controlling copying data to/from payload/encap | -| [288e09362](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=288e09362) | ipip: refactor ipip.api with explicit types | -| [cbd0824d6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cbd0824d6) | IPIP tunnel: use address types on API | - -| @c src/vnet/ipip/ipip_types.api || -| ------- | ------- | -| [9534696b4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9534696b4) | ipip: Tunnel flags controlling copying data to/from payload/encap | - -| @c src/vnet/bfd/bfd.api || -| ------- | ------- | -| [4682feb1f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4682feb1f) | bfd: API cleanup | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [cbe25aab3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cbe25aab3) | ip: Protocol Independent IP Neighbors | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [bc764c8bc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bc764c8bc) | l2: BD ARP termination entry API update | -| [54bc5e40c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=54bc5e40c) | Update API description | -| [5e6f7348c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5e6f7348c) | l2: Add support for arp unicast forwarding | - -| @c src/vnet/ip6-nd/ip6_nd.api || -| ------- | ------- | -| [cbe25aab3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cbe25aab3) | ip: Protocol Independent IP Neighbors | - -| @c src/vnet/ip6-nd/rd_cp.api || -| ------- | ------- | -| [cbe25aab3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cbe25aab3) | ip: Protocol Independent IP Neighbors | - -| @c src/vnet/udp/udp.api || -| ------- | ------- | -| [10dc2eabd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=10dc2eabd) | udp: fix copyright typo | - -| @c src/vnet/mpls/mpls.api || -| ------- | ------- | -| [3eb8f207b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3eb8f207b) | mpls: api cleanup | -| [75761b933](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75761b933) | api: split vl_api_prefix into two | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [097fa66b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=097fa66b9) | fib: fib api updates | - -| @c src/vnet/mfib/mfib_types.api || -| ------- | ------- | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [097fa66b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=097fa66b9) | fib: fib api updates | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [75761b933](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75761b933) | api: split vl_api_prefix into two | -| [33a58171e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33a58171e) | api: autogenerate api trace print/endian | -| [515eed425](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=515eed425) | api: add prefix matcher typedef | -| [038e1dfbd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=038e1dfbd) | dhcp ip: DSCP settings for transmitted DHCP packets | -| [53c501512](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53c501512) | api: add DSCP definitions to ip_types.api | -| [ab05508e1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ab05508e1) | api: refactor format_vl_api_prefix_t return keys | -| [b538dd868](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b538dd868) | Punt: specify packets by IP protocol Type | -| [50f0ac0f0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=50f0ac0f0) | Punt: socket register for exception dispatched/punted packets based on reason | - -| @c src/vnet/ip/punt.api || -| ------- | ------- | -| [f158944cc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f158944cc) | ip: trivial typos in docs | -| [f72ad93d6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f72ad93d6) | ip: punt API cleanup | -| [e5ff5a36d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5ff5a36d) | api: enforce vla is last and fixed string type | -| [719beb709](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=719beb709) | ip ipsec: Remove IPSec SPI-0 punt reason | -| [b538dd868](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b538dd868) | Punt: specify packets by IP protocol Type | -| [50f0ac0f0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=50f0ac0f0) | Punt: socket register for exception dispatched/punted packets based on reason | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [58989a37d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=58989a37d) | ip: API cleanup | -| [cbe25aab3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cbe25aab3) | ip: Protocol Independent IP Neighbors | -| [668605fc8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=668605fc8) | ip: use explicit types in api | -| [9db6ada77](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9db6ada77) | fib: Table Replace | -| [de34c35fc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=de34c35fc) | ip: add shallow virtual reassembly functionality | -| [75761b933](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75761b933) | api: split vl_api_prefix into two | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [097fa66b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=097fa66b9) | fib: fib api updates | -| [3a343d42d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3a343d42d) | reassembly: prevent long chain attack | - -| @c src/vnet/pg/pg.api || -| ------- | ------- | -| [22e9cfd76](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=22e9cfd76) | pg: add GSO support | - -| @c src/vnet/bier/bier.api || -| ------- | ------- | -| [f1f5a8a1a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f1f5a8a1a) | bier: API cleanup | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [097fa66b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=097fa66b9) | fib: fib api updates | -| [e6eefb6e3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e6eefb6e3) | Trivial Typo's in bier comments/docs. | - -| @c src/vnet/ipfix-export/ipfix_export.api || -| ------- | ------- | -| [2f71a8889](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2f71a8889) | ip: ipfix-export API update | -| [21b83e96d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=21b83e96d) | api: implement ipfix_flush | - -| @c src/vnet/gso/gso.api || -| ------- | ------- | -| [29467b534](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=29467b534) | gso: Add gso feature arc | - -| @c src/vnet/devices/af_packet/af_packet.api || -| ------- | ------- | -| [97c998c28](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=97c998c28) | docs: devices-- add FEATURES.yaml | -| [3b2db9002](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3b2db9002) | devices: af_packet API cleanup | - -| @c src/vnet/devices/virtio/vhost_user.api || -| ------- | ------- | -| [5d4c99f27](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5d4c99f27) | devices: vhost API cleanup | -| [4208a4ce8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4208a4ce8) | devices interface tests: vhosst GSO support | - -| @c src/vnet/devices/virtio/virtio_types.api || -| ------- | ------- | -| [5d4c99f27](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5d4c99f27) | devices: vhost API cleanup | - -| @c src/vnet/devices/virtio/virtio.api || -| ------- | ------- | -| [6d4af8918](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6d4af8918) | virtio: split gso and checksum offload functionality | -| [2c504f89c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2c504f89c) | devices: virtio API cleanup | -| [97c998c28](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=97c998c28) | docs: devices-- add FEATURES.yaml | -| [bbd6b746e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bbd6b746e) | virtio: Add gso support for native virtio driver | -| [43b512cac](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=43b512cac) | virtio: remove configurable queue size support | - -| @c src/vnet/devices/pipe/pipe.api || -| ------- | ------- | -| [97c998c28](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=97c998c28) | docs: devices-- add FEATURES.yaml | -| [df40cb5b5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df40cb5b5) | devices: pipe API cleanup | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [ba0061feb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ba0061feb) | tap: split gso and checksum offload functionality | -| [5de4fb707](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5de4fb707) | devices: tap API cleanup | -| [44d06916b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=44d06916b) | tap: Move client registration check to top | -| [97c998c28](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=97c998c28) | docs: devices-- add FEATURES.yaml | -| [97d54ed43](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=97d54ed43) | tap: add support to configure tap interface host MTU size | - -| @c src/vnet/srv6/sr.api || -| ------- | ------- | -| [eeb5fb3a5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=eeb5fb3a5) | sr: add "set sr encaps hop-limit" command | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | - -| @c src/vnet/geneve/geneve.api || -| ------- | ------- | -| [2d3282e17](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2d3282e17) | geneve: API cleanup | - -| @c src/plugins/marvell/pp2/pp2.api || -| ------- | ------- | -| [4a65b910a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4a65b910a) | marvell: use explicit types in api | -| [859b59133](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=859b59133) | api: Add API support for marvell PP2 plugin | - -| @c src/plugins/svs/svs.api || -| ------- | ------- | -| [5e913f374](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5e913f374) | svs: use explicit types in api | - -| @c src/plugins/acl/acl_types.api || -| ------- | ------- | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [bb2e5221a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bb2e5221a) | api acl: breakout acl_types.api for reuse by others | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [b5076cbe1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b5076cbe1) | acl: add missing square brackets to vat_help option in acl api | -| [709dad304](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=709dad304) | acl: remove api boilerplate | -| [bb2e5221a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bb2e5221a) | api acl: breakout acl_types.api for reuse by others | -| [f995c7122](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f995c7122) | acl: implement counters | - -| @c src/plugins/memif/memif.api || -| ------- | ------- | -| [3ae9f5a90](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3ae9f5a90) | memif: remove api boilerplate | -| [546f955b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=546f955b3) | memif: API cleanup | - -| @c src/plugins/cdp/cdp.api || -| ------- | ------- | -| [07e557a73](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=07e557a73) | cdp: use explicit types in api | - -| @c src/plugins/dhcp/dhcp6_ia_na_client_cp.api || -| ------- | ------- | -| [02bfd641b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=02bfd641b) | dhcp: Move to plugin | - -| @c src/plugins/dhcp/dhcp6_pd_client_cp.api || -| ------- | ------- | -| [d5262831a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d5262831a) | dhcp: dhcp6_pd_client_cp API cleanup | -| [02bfd641b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=02bfd641b) | dhcp: Move to plugin | - -| @c src/plugins/dhcp/dhcp.api || -| ------- | ------- | -| [6bcc6a455](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bcc6a455) | dhcp: fix crash on unicast renewal send | -| [02bfd641b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=02bfd641b) | dhcp: Move to plugin | - -| @c src/plugins/avf/avf.api || -| ------- | ------- | -| [a0bf06d74](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a0bf06d74) | avf: explicit types in api | -| [74af6f081](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=74af6f081) | avf: remote api boilerplate | - -| @c src/plugins/dpdk/api/dpdk.api || -| ------- | ------- | -| [6d75c20a6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6d75c20a6) | dpdk: use explicit types in api | -| [025166dc7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=025166dc7) | dpdk: remove api boilerplate | - -| @c src/plugins/builtinurl/builtinurl.api || -| ------- | ------- | -| [43765e2b4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=43765e2b4) | builtinurl: initial working attempt | - -| @c src/plugins/mactime/mactime.api || -| ------- | ------- | -| [7b22df06f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7b22df06f) | mactime: update api to use explicit types | -| [2c41a61d5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2c41a61d5) | mactime: add a "top" command to watch device stats | -| [7071952df](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7071952df) | mactime: remove api boilerplate | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [7681b1c46](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7681b1c46) | mactime: add per-mac allow-with-quota feature | -| [0c6ac791d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0c6ac791d) | mactime: upstream new features | - -| @c src/plugins/ikev2/ikev2.api || -| ------- | ------- | -| [6aaee8c7c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6aaee8c7c) | ikev2: use explicit api types | -| [fc7b77db7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fc7b77db7) | ikev2: remove api boilerplate | - -| @c src/plugins/http_static/http_static.api || -| ------- | ------- | -| [e5ff5a36d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5ff5a36d) | api: enforce vla is last and fixed string type | -| [68b24e2c9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=68b24e2c9) | plugins: http_static. Migrate to use api string type. | -| [22bc2c46e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=22bc2c46e) | Static http server | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [38277e407](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=38277e407) | gbp: use explicit types in api | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [3918bdbcb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3918bdbcb) | gbp: update gbp-ext-itf API | -| [3c0d84c98](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3c0d84c98) | gbp: add anonymous l3-out subnets | -| [cfc7a107e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=cfc7a107e) | gbp: add anonymous l3-out external interfaces | -| [160c923f9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=160c923f9) | gbp: VRF scoped contracts | - -| @c src/plugins/l2e/l2e.api || -| ------- | ------- | -| [b2e463a10](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b2e463a10) | l2e: use explicit api types | - -| @c src/plugins/gtpu/gtpu.api || -| ------- | ------- | -| [55636cb62](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=55636cb62) | gtpu: use explicit types in api | -| [49228efce](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=49228efce) | gtpu: remove api boilerplate | - -| @c src/plugins/igmp/igmp.api || -| ------- | ------- | -| [4a7fc4cf1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4a7fc4cf1) | igmp: use explicit types in api | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [4ff09ae34](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4ff09ae34) | API: Python and Unix domain socket improvement | - -| @c src/plugins/ioam/lib-vxlan-gpe/ioam_vxlan_gpe.api || -| ------- | ------- | -| [0fa66d618](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0fa66d618) | ioam: use explicit api types | - -| @c src/plugins/ioam/udp-ping/udp_ping.api || -| ------- | ------- | -| [0fa66d618](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0fa66d618) | ioam: use explicit api types | - -| @c src/plugins/ioam/export/ioam_export.api || -| ------- | ------- | -| [0fa66d618](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0fa66d618) | ioam: use explicit api types | - -| @c src/plugins/ioam/ip6/ioam_cache.api || -| ------- | ------- | -| [0fa66d618](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0fa66d618) | ioam: use explicit api types | - -| @c src/plugins/ioam/lib-pot/pot.api || -| ------- | ------- | -| [0fa66d618](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0fa66d618) | ioam: use explicit api types | - -| @c src/plugins/ioam/export-vxlan-gpe/vxlan_gpe_ioam_export.api || -| ------- | ------- | -| [0fa66d618](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0fa66d618) | ioam: use explicit api types | - -| @c src/plugins/stn/stn.api || -| ------- | ------- | -| [7929f9f5c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7929f9f5c) | stn: use explicit types in api | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [be31c2a25](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=be31c2a25) | map: use explicit types in api | -| [7b2e9fb1a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7b2e9fb1a) | map: use ip6-full-reassembly instead of own code | -| [640edcd90](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=640edcd90) | map: use SVR for MAP-T | -| [e5ff5a36d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5ff5a36d) | api: enforce vla is last and fixed string type | -| [ff47fb645](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ff47fb645) | vppapigen map: raise ValueError when fieldname is python keyword | -| [4d376f67a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4d376f67a) | map: Use vl_api_string macros. | - -| @c src/plugins/oddbuf/oddbuf.api || -| ------- | ------- | -| [7ff64fb97](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7ff64fb97) | oddbuf: remove api boilerplate | -| [a287a30dd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a287a30dd) | misc: fix coverity warning in the oddbuf plugin | -| [c4abafd83](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c4abafd83) | ip: fix udp/tcp checksum corner cases | - -| @c src/plugins/l3xc/l3xc.api || -| ------- | ------- | -| [60f5108a9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=60f5108a9) | l3xc: use explicit types in api | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [59fa121f8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=59fa121f8) | L3 cross connect | - -| @c src/plugins/pppoe/pppoe.api || -| ------- | ------- | -| [04338e85a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=04338e85a) | pppoe: use explicit types in api | -| [25fe57821](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=25fe57821) | pppoe: remove api boilerplate | - -| @c src/plugins/mdata/mdata.api || -| ------- | ------- | -| [d7b306657](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d7b306657) | mdata: buffer metadata change tracker plugin | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [ae0724034](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ae0724034) | lb: remove api boilerplate | -| [33538a150](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33538a150) | lb: add APIs for set interface nat4 and nat6 | -| [75761b933](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75761b933) | api: split vl_api_prefix into two | -| [3efcd0d7c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3efcd0d7c) | lb: vip and as dump/detail api's | -| [a0cb32cb9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a0cb32cb9) | lb: update api.c to use scaffolding from latest skel | - -| @c src/plugins/lb/lb_types.api || -| ------- | ------- | -| [75761b933](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75761b933) | api: split vl_api_prefix into two | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [3efcd0d7c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3efcd0d7c) | lb: vip and as dump/detail api's | - -| @c src/plugins/nsim/nsim.api || -| ------- | ------- | -| [e06e7c672](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e06e7c672) | nsim: use explicit api types | -| [2e7a43ca4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2e7a43ca4) | nsim: remove api boilerplate | -| [7c91007e1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7c91007e1) | Make the loss / delay sim available as an output feature | - -| @c src/plugins/vmxnet3/vmxnet3.api || -| ------- | ------- | -| [277f03f06](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=277f03f06) | vmxnet3: use explicit types in api | -| [10bbfce02](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=10bbfce02) | vmxnet3: remove api boilerplate | -| [2985e0af6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2985e0af6) | vmxnet3: per interface gso support | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | - -| @c src/plugins/tlsopenssl/tls_openssl.api || -| ------- | ------- | -| [1e582206a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1e582206a) | tls: remove api boilerplate | -| [dd0cc9ec3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dd0cc9ec3) | tls: some rework based on TLS openssl C API | -| [be4d1aa2c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=be4d1aa2c) | tls: Add C API for TLS openssl to set engine | - -| @c src/plugins/abf/abf.api || -| ------- | ------- | -| [bdde58534](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdde58534) | abf: use explicit types in api | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [097fa66b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=097fa66b9) | fib: fib api updates | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [f126e746f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f126e746f) | nat: use SVR | -| [e5ff5a36d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5ff5a36d) | api: enforce vla is last and fixed string type | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [e6e09a4ac](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e6e09a4ac) | nat: elog rewrite for multi-worker support | -| [c1f93067e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c1f93067e) | Add default value for API Nat flags | -| [dd1e3e780](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dd1e3e780) | NAT: VPP-1531 api cleanup & update | -| [89fec713f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=89fec713f) | Revert "NAT: VPP-1531 api cleanup & update" | -| [bed1421b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bed1421b9) | NAT: VPP-1531 api cleanup & update | - -| @c src/plugins/rdma/rdma.api || -| ------- | ------- | -| [d8c1ef925](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d8c1ef925) | rdma: api: prepare support for direct verb | -| [b644eb54f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b644eb54f) | rdma: add explicit types in api | -| [812afe712](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=812afe712) | rdma: add rdma API | - -| @c src/plugins/sctp/sctp.api || -| ------- | ------- | -| [3ffe6cadf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3ffe6cadf) | sctp: move to plugins, disabled by default | - -| @c src/plugins/ct6/ct6.api || -| ------- | ------- | -| [d4efce2e0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d4efce2e0) | ct6: use explicit type in api | -| [ee98904e0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ee98904e0) | ct6: remove api boilerplate | - -| @c src/plugins/nsh/nsh.api || -| ------- | ------- | -| [d3f0a4869](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d3f0a4869) | nsh: use explicit api types | - -| @c src/plugins/flowprobe/flowprobe.api || -| ------- | ------- | -| [3013e6988](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3013e6988) | flowprobe: use explicit types in api | -| [2a1ca787b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2a1ca787b) | api: split api generated files | - -| @c src/plugins/lacp/lacp.api || -| ------- | ------- | -| [ebef4a9e5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ebef4a9e5) | lacp: use explit api types | - -| @c src/plugins/dns/dns.api || -| ------- | ------- | -| [b922f16ba](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b922f16ba) | dns: remove api boilerplate | -| [34af0ccf5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=34af0ccf5) | dns: make the dns name resolver a plugin | - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [e5ff5a36d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e5ff5a36d) | api: enforce vla is last and fixed string type | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [a47a5f20a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a47a5f20a) | api papi: add alias for timestamp(datetime)/timedelta | -| [888640a39](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=888640a39) | map gbp papi: match endianess of f64 | -| [03f1af23b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=03f1af23b) | api: Implement log_dump/log_details | -| [c87b66c86](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c87b66c86) | ipsec: ipsec-tun protect | -| [9ac113815](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9ac113815) | API: Add support for limits to language. | - -| @c src/vpp/api/vpe_types.api || -| ------- | ------- | -| [e71748291](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e71748291) | vppapigen: remove support for legacy typedefs | -| [a47a5f20a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a47a5f20a) | api papi: add alias for timestamp(datetime)/timedelta | -| [3cf9e67f5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3cf9e67f5) | api: add vl_api_version_t type | - -@page release_notes_19083 Release notes for VPP 19.08.3 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1908) - -@page release_notes_19082 Release notes for VPP 19.08.2 - -The 19.08.2 is an LTS release. It contains numerous fixes, -as well as new features and API additions. - -## Features - -- API trace tool - - Add text output (c395ff143) -- Binary API Libraries - - Add API support for PP2 plugin to stable/1908 (1c3c9f039) -- Build System - - Pass 'no-pci' to autgenerated config (c0552134e) - - Add env variable to pass extra cmake args (116e05f57) -- Infrastructure Library - - Implement CLIB\_PAUSE () for aarch64 platforms (a3c45242b) - - Create unformat function for data size parsing (cb19100c1) -- Link Bonding - - Fix interface deletion (1517d5e72) - - Add GSO support (a06f68556) -- Physical Memory Allocator - - Always lock pages (5b2eea6e0) -- Plugins - - AVF Device driver - - Print queue id in packet trace (9e028d047) - - DPDK - - Ipsec tunnel support for ip6-in-ip4 (2dde5a478) - - QAT devices update, add c4xxx and xeon d15xx (f5d6c80ac) - - Add TSO support in DPDK plugin. (5564db853) - - Group Based Policy (GBP) - - Add extended SFC unit tests (30f7e4198) - - Host Stack Applications - - Make APP\_OPTIONS\_PREALLOC\_FIFO\_PAIRS configurable (47c6f36be) - - Internet Key Exchange (IKEv2) Protocol - - Add support for GCM cipher (2fa9f679c) - - QUIC protocol - - Add cli command for stats (88af6c3f4) - - Add Tx, Rx and packet drop counters (3a61a40dd) - - Create custom event logger (2f9ec5001) - - Make quic fifo size configurable via cli (7fc3d97b8) - - RDMA (ibverb) driver - - Add support for input feature arcs (cbae1e1c5) - - Add support for MAC changes (ffdfe308b) - - Http\_static - - Add dynamic GET / POST method hooks (faf5195e3) -- Python binding for the VPP API - - Let async calls return context (e6b29a9df) - - Introduce read\_blocking (1c45b85df) -- SVM Library - - Improve fifo segment verbose cli (d2bff0786) -- Statistics Segment - - Add /if/\/\/state for lacp interface state (d5e8ed7be) -- Test Infrastructure - - Support worker threads (51699e62c) - - Support setting random seed (fc000f0e1) - - Add cli\_return\_response to vpp\_papi\_provider (64d744350) - - Test tls case (87e1bcdd7) -- VNET - - Classifier - - Use vector code even when data is not aligned (bebbd7f62) - - VPP packet tracer support (7c5a3536c) - - IPSec - - Add 'detail' option to 'sh ipsec sa' (56417fa94) - - Add insecure option for format of SA (591aa64e8) - - Support 4o6 and 6o4 for tunnel protect (2e6d73934) - - IPv4 and IPv6 LPM - - Allow addrs from the same prefix on intf (da900b25c) - - Punt rather than drop unkown IPv6 ICMP packets (fd2f6f89e) - - Session Layer - - Add explicit reset api (a267cba29) - - Improve cli (2ff21af39) - - Add session enable option in config file (b1ef5567b) - - Limit pacer bucket size (079895d95) - - Builtin app rx notifications regardless of state (8e4afc86d) - - Infra for transports to send buffers (57997c874) - - Reschedule asap when snd space constrained (89ab1762d) - - TCP - - Allow cc algos to set pacing rate (82df1eb90) - - Set cc\_algo on connection alloc (7fe501a4b) - - Add option for always on event logging (e73bd8503) - - Track zero rwnd errors (a2c063712) - - Validate connections in output (ea584d137) - - Force zero window on full rx fifo (fbe948c81) - - Send rwnd update only if wnd is large enough (0ad8477ba) - - Enable gso in tcp hoststack (6f3621d77) - - Handle SACK reneging (9dba3dbf0) - - Use rate sample RTT in recovery if possible (6702641f5) - - Compute snd time for rate sample (69460ae11) - - Use sacks for timer based recovery (d4aa3d9f8) - - Custom checksum calculations for Ipv4/Ipv6 (3642782a2) - - Retry lost retransmits (7b135c639) - - Improve pacing after idle send periods (abdc7dfb5) - - Track lost rxt segments in byte tracker (6de46b40d) - - Validate the IP address while checking TCP connection (6c1ce53b4) - - Improve lost rxt heuristic (04b4204d9) -- VPP Comms Library - - Allow non-blocking connects (4767cf24f) - - Add api to set lcl ip (2c55610e2) -- Vector Library - - Add flag to explicitelly mark nodes which can init per-node packet trace (29dc11bde) - - Enhance the "show cli" debug CLI command (b5a0108ac) -- Libmemif - - Introduce 'memif\_per\_thread\_' namespace (2736fc7fc) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - -Message Name | Result --------------------------------------------------------------|------------------ -app_attach | only in image -app_attach_reply | only in image - -Found 2 api message signature differences - -## Fixed issues - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1908) - -@page release_notes_19081 Release notes for VPP 19.08.1 - -Exceptionally, this release has an API-changing fix introduced via -https://gerrit.fd.io/r/#/c/vpp/+/21762/ - documented in VPP-1767. -Given the exceptional nature of the change, also including the text here: - -Bug: https://gerrit.fd.io/r/c/vpp/+/21492 - -Variable length strings were committed to VPP in 413f4a5b. -The VPP server side of the API does not use a wire encoder/decoder. It maps a C struct directly onto on-the-wire API messages. -The client side C language binding is the same, while other language bindings have their own encoder/decoders. - -Multiple strings alone or combined with other variable length types turned out to be error prone to manually implement on the VPP side, -and not supported by VPP API (VAPI) very well at all. - -To avoid having to rewrite VAPI significantly, and to mitigate the risk -and error prone server side support of multiple variable length fields, -this patch extends strings to have a fixed size (on the wire) and -a variable flavour, as well as adding detection in the API compiler -to detect multiple variable length fields in a message (or type). - -Given that this change breaks the commitment to binary API compatibility, -normally present in point builds, ALL 19.08 build artifacts are being -deferred. - -This means the artifacts for the VPP 19.08.1 will be installed -in the release repository (packagecloud.io/fdio/release), then -ALL 19.08 build artifacts will be moved into the deferred repository -(packagecloud.io/fdio/deferred). The 19.08 artifacts will always be -available for archive purposes in the deferred repository. - -During the further testing by Networking-VPP team, they discovered -another issue documented in VPP-1769 - which requires a CRC-affecting -fix in https://gerrit.fd.io/r/#/c/vpp/+/22015/ - so the 19.08.1 -will contain the fixes for both issues. - -These two changes have resulted in the following 20 messages changing -their signatures: - -Message Name | Result --------------------------------------------------------------|------------------ -cli_inband | definition changed -cli_inband_reply | definition changed -connect_sock | definition changed -http_static_enable | definition changed -log_details | definition changed -map_add_domain | definition changed -map_domain_details | definition changed -nat44_add_del_identity_mapping | definition changed -nat44_add_del_lb_static_mapping | definition changed -nat44_add_del_static_mapping | definition changed -nat44_identity_mapping_details | definition changed -nat44_lb_static_mapping_details | definition changed -nat44_static_mapping_details | definition changed -nat_worker_details | definition changed -punt_reason_details | definition changed -punt_reason_dump | definition changed -show_version_reply | definition changed -sw_interface_details | definition changed -sw_interface_dump | definition changed -sw_interface_tag_add_del | definition changed - -Please accept our apologies for the inconvenience this caused. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1904) - -@page release_notes_1908 Release notes for VPP 19.08 - -More than 850 commits since the 19.04 release. - -## Features - -### Infrastructure -- API - - API language: new types and limits support - - Python API - add support for defaults - - Export ip_types.api for out-of-tree plugins use - - Refactor ipip.api with explicit types -- DPDK - - 19.05 integration - - Remove bonding code - - Rework extended stats -- Debugging & Servicability - - debug CLI leak-checker - - vlib: add "memory-trace stats-segment" - - vppapitrace JSON/API trace converter - - ARP: add arp-disabled node - - igmp: Trace more data from input packets - - ip: Trace the packet from the punt node - - Python API debug introspection improvements - - Pin dependencies for make test infra - - FEATURE.yaml meta-data infrastructure - - tcp: add cc stats plotting tools - - Packet tracer support for thread handoffs -- libmemif: support for multi-thread connection establishment -- svm - - fifo ooo reads/writes with multiple chunks - - support addition/removal of chunks to fifos -- vppinfra - - Mapped pcap file support - - More AVX2 and AVX512 inlines - - VLIB_INIT_FUNCTION sequencing rework - - refactor spinlocks and rwlocks - - add rbtree - - add doubly linked list -- rdma: bump rdma-core to v25.0 -- stats - - Add the number of worker threads and per worker thread vector rates - - Support multiple workers for error counters - -### VNET & Plugins -- New Plugins - - HTTP static page server with TLS support - - L3 cross connect -- acl: implement stat-segment counters -- arp: add feature arcs: arp-reply, arp-input, arp-proxy -- avf: improved logging and added 2.5/5 Gbps speeds -- bonding: NUMA-related improvements -- crypto: add support for AES-CTR cipher -- fib - - FIB Entry tracking - - Support the POP of a Pseudo Wire Control Word -- gbp - - Anonymous l3-out subnets support - - ARP unicast forward in gbp bridge domain - - An Endpoint can change sclass - - Consider data-plane learnt source better than control-plane - - VRF scoped contracts -- gso (experimental) - - Add support to pg interfaces - - Add support to vhost user - - Add support to native virtio - - Add support for tagged interfaces -- punt: allow to specify packets by IP protocol Type -- ip6-local: hop-by-hop protocol demux table -- ipsec - - intel-ipsec-mb version 0.52 - - AH encrypt rework - - handle UDP keepalives - - support GCM in ESP -- virtio - - Refactor control queue support -- dhcp-client: DSCP marking for transmitted packets -- Idle resource usage improvements - - Allocate bihash virtual space on demand - - gre: don't register gre input nodes unless a gre tunnel is created - - gtpu: don't register udp ports unless a tunnel is created - - lacp: create lacp-process on demand - - lisp-cp: start lisp retry service on demand - - start the cdp period and dns resolver process on demand - - vat: unload unused vat plugins -- nat: api cleanup & update -- nsim: make available as an output feature -- load-balance performance improvements -- l2: Add support for arp unicast forwarding -- mactime - - Mini-ACLs - - Per-MAC allow-with-quota feature -- qos - - QoS dump APIs - - Store function -- rdma: add support for promiscuous mode (l2-switching and xconnect) -- sr: update the Segment Routing definition to be compliant with current in IETF -- udp-ping: disable due to conflict with mldv2 -- vxlan-gpe: improve encap performance -- vom - - QoS support - - Bridge domain arp unicast forwarding flag - - Bridge domain unknown unicast flooding flag - -### Host stack -- session - - API to support manual svm fifo resizing - - Improved session output scheduler and close state machine - - Transport and session cleanup notifications for builtin apps - - Session migration notifications for builtin apps - - Support for no session layer lookup transports (quic and tls) - - Ability to retrieve local/remote endpoint in transport vft - - Cleanup segment manager and fifo segment - - Fix vpp to app msg generation on enqueue fail - - Improve event logging - - Moved test applications to hsa plugin -- tcp - - Congestion control algorithm enhancements - - Delivery rate estimator - - ACK/retransmission refactor and pacing - - Add tcp-input sibling nodes without full 6-tuple lookup - - More RFC4898 connection statistics - - Allow custom output next node - - Allow custom congestion control algorithms -- quic - - Multi-thread support - - Logs readability improvements - - Multistream support -- tls - - Fix close with data and listen failures - - Handle TCP transport rests - - Support endpoint retrieval interface -- vcl - - support quic streams and "connectable listeners" - - worker unregister api - - fix epoll with large events batch - - ldp: add option to eanble transparent TLS connections -- udp: - - support close with data - - fixed session migration -- sctp - - add option to enable/disable default to disable - - moved from vnet to plugins - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1908) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - - -Message Name | Result --------------------------------------------------------------|------------------ -abf_itf_attach_add_del | definition changed -abf_itf_attach_details | definition changed -abf_policy_add_del | definition changed -abf_policy_details | definition changed -acl_add_replace | definition changed -acl_details | definition changed -acl_stats_intf_counters_enable | only in image -acl_stats_intf_counters_enable_reply | only in image -api_versions_reply | definition changed -bd_ip_mac_add_del | definition changed -bd_ip_mac_details | definition changed -bier_disp_entry_add_del | definition changed -bier_disp_entry_details | definition changed -bier_imp_add | definition changed -bier_imp_details | definition changed -bier_route_add_del | definition changed -bier_route_details | definition changed -bier_route_dump | definition changed -bier_table_add_del | definition changed -bier_table_details | definition changed -bond_create | definition changed -bridge_domain_add_del | definition changed -bridge_domain_details | definition changed -bridge_flags | definition changed -connect_sock | definition changed -create_vhost_user_if | definition changed -ct6_enable | only in file -ct6_enable_disable | only in image -ct6_enable_disable_reply | only in image -ct6_enable_disable | only in file -dhcp6_pd_reply_event | definition changed -dhcp6_pd_send_client_message | definition changed -dhcp6_reply_event | definition changed -dhcp6_send_client_message | definition changed -dhcp_client_config | definition changed -dhcp_client_details | definition changed -dhcp_compl_event | definition changed -dhcp_proxy_details | definition changed -dslite_add_del_pool_addr_range | definition changed -dslite_address_details | definition changed -dslite_get_aftr_addr_reply | definition changed -dslite_get_b4_addr_reply | definition changed -dslite_set_aftr_addr | definition changed -dslite_set_b4_addr | definition changed -gbp_bridge_domain_add | definition changed -gbp_bridge_domain_details | definition changed -gbp_contract_add_del | definition changed -gbp_contract_details | definition changed -gbp_endpoint_add | definition changed -gbp_endpoint_details | definition changed -gbp_endpoint_group_add | definition changed -gbp_endpoint_group_details | definition changed -gbp_ext_itf_add_del | definition changed -gbp_ext_itf_details | definition changed -gbp_recirc_add_del | definition changed -gbp_recirc_details | definition changed -gbp_route_domain_add | definition changed -gbp_route_domain_details | definition changed -gbp_subnet_add_del | definition changed -gbp_subnet_details | definition changed -gbp_vxlan_tunnel_add | definition changed -gbp_vxlan_tunnel_details | definition changed -get_f64_endian_value | only in image -get_f64_endian_value_reply | only in image -get_f64_increment_by_one | only in image -get_f64_increment_by_one_reply | only in image -gpe_add_del_fwd_entry | definition changed -gpe_fwd_entries_get_reply | definition changed -gpe_fwd_entry_path_details | definition changed -gpe_native_fwd_rpaths_get_reply | definition changed -gre_add_del_tunnel | only in file -gre_add_del_tunnel_reply | only in file -gre_tunnel_add_del | only in image -gre_tunnel_add_del_reply | only in image -gre_tunnel_details | definition changed -gre_tunnel_dump | definition changed -http_static_enable | only in image -http_static_enable_reply | only in image -igmp_event | definition changed -igmp_group_prefix_details | definition changed -igmp_group_prefix_set | definition changed -igmp_listen | definition changed -ip6_fib_details | only in file -ip6_fib_dump | only in file -ip6_mfib_details | only in file -ip6_mfib_dump | only in file -ip6_ra_event | definition changed -ip_add_del_route | only in file -ip_add_del_route_reply | only in file -ip_address_details | definition changed -ip_container_proxy_add_del | definition changed -ip_container_proxy_details | definition changed -ip_fib_details | only in file -ip_fib_dump | only in file -ip_mfib_details | only in file -ip_mfib_dump | only in file -ip_mroute_add_del | definition changed -ip_mroute_details | only in image -ip_mroute_dump | only in image -ip_mtable_details | only in image -ip_mtable_dump | only in image -ip_neighbor_add_del | definition changed -ip_neighbor_details | definition changed -ip_probe_neighbor | definition changed -ip_punt_redirect | definition changed -ip_punt_redirect_details | definition changed -ip_reassembly_get_reply | definition changed -ip_reassembly_set | definition changed -ip_route_add_del | only in image -ip_route_add_del_reply | only in image -ip_route_details | only in image -ip_route_dump | only in image -ip_source_and_port_range_check_add_del | definition changed -ip_table_add_del | definition changed -ip_table_details | only in image -ip_table_dump | only in image -ipfix_flush | only in image -ipfix_flush_reply | only in image -ipip_6rd_add_tunnel | definition changed -ipip_add_tunnel | definition changed -ipip_tunnel_details | definition changed -ipsec_backend_details | definition changed -ipsec_gre_tunnel_add_del | only in file -ipsec_gre_tunnel_add_del_reply | only in file -ipsec_gre_tunnel_details | only in file -ipsec_gre_tunnel_dump | only in file -ipsec_sa_details | definition changed -ipsec_sa_set_key | only in file -ipsec_sa_set_key_reply | only in file -ipsec_sad_entry_add_del | definition changed -ipsec_select_backend | definition changed -ipsec_spd_details | definition changed -ipsec_spd_entry_add_del | definition changed -ipsec_tunnel_if_add_del | definition changed -ipsec_tunnel_if_set_key | only in file -ipsec_tunnel_if_set_key_reply | only in file -ipsec_tunnel_protect_del | only in image -ipsec_tunnel_protect_del_reply | only in image -ipsec_tunnel_protect_details | only in image -ipsec_tunnel_protect_dump | only in image -ipsec_tunnel_protect_update | only in image -ipsec_tunnel_protect_update_reply | only in image -l2_macs_event | definition changed -l3xc_del | only in image -l3xc_del_reply | only in image -l3xc_details | only in image -l3xc_dump | only in image -l3xc_plugin_get_version | only in image -l3xc_plugin_get_version_reply | only in image -l3xc_update | only in image -l3xc_update_reply | only in image -lb_add_del_as | definition changed -lb_add_del_vip | definition changed -lb_as_details | only in image -lb_as_dump | only in image -lb_flush_vip | definition changed -lb_vip_details | only in image -lb_vip_dump | only in image -lisp_add_del_locator_set | definition changed -lisp_add_del_remote_mapping | definition changed -lisp_adjacencies_get_reply | definition changed -log_details | only in image -log_dump | only in image -macip_acl_add | definition changed -macip_acl_add_replace | definition changed -macip_acl_details | definition changed -mactime_add_del_range | definition changed -map_add_domain | definition changed -map_domain_details | definition changed -mfib_signal_details | definition changed -modify_vhost_user_if | definition changed -mpls_fib_details | only in file -mpls_fib_dump | only in file -mpls_ip_bind_unbind | definition changed -mpls_route_add_del | definition changed -mpls_route_details | only in image -mpls_route_dump | only in image -mpls_table_add_del | definition changed -mpls_table_details | only in image -mpls_table_dump | only in image -mpls_tunnel_add_del | definition changed -mpls_tunnel_details | definition changed -nat44_add_del_address_range | definition changed -nat44_add_del_identity_mapping | definition changed -nat44_add_del_interface_addr | definition changed -nat44_add_del_lb_static_mapping | definition changed -nat44_add_del_static_mapping | definition changed -nat44_address_details | definition changed -nat44_del_session | definition changed -nat44_forwarding_enable_disable | definition changed -nat44_forwarding_is_enabled_reply | definition changed -nat44_identity_mapping_details | definition changed -nat44_interface_add_del_feature | definition changed -nat44_interface_add_del_output_feature | definition changed -nat44_interface_addr_details | definition changed -nat44_interface_details | definition changed -nat44_interface_output_feature_details | definition changed -nat44_lb_static_mapping_add_del_local | definition changed -nat44_lb_static_mapping_details | definition changed -nat44_static_mapping_details | definition changed -nat44_user_details | definition changed -nat44_user_session_details | definition changed -nat44_user_session_dump | definition changed -nat64_add_del_interface_addr | definition changed -nat64_add_del_interface | definition changed -nat64_add_del_pool_addr_range | definition changed -nat64_add_del_prefix | definition changed -nat64_add_del_static_bib | definition changed -nat64_bib_details | definition changed -nat64_interface_details | definition changed -nat64_pool_addr_details | definition changed -nat64_prefix_details | definition changed -nat64_st_details | definition changed -nat66_add_del_interface | definition changed -nat66_add_del_static_mapping | definition changed -nat66_interface_details | definition changed -nat66_static_mapping_details | definition changed -nat_det_add_del_map | definition changed -nat_det_close_session_in | definition changed -nat_det_close_session_out | definition changed -nat_det_forward | definition changed -nat_det_forward_reply | definition changed -nat_det_map_details | definition changed -nat_det_reverse | definition changed -nat_det_reverse_reply | definition changed -nat_det_session_details | definition changed -nat_det_session_dump | definition changed -nat_get_mss_clamping_reply | definition changed -nat_ipfix_enable_disable | definition changed -nat_reass_details | definition changed -nat_set_log_level | only in image -nat_set_log_level_reply | only in image -nat_set_mss_clamping | definition changed -nat_set_reass | definition changed -nat_show_config_reply | definition changed -nat_worker_details | definition changed -nsim_cross_connect_enable_disable | only in image -nsim_cross_connect_enable_disable_reply | only in image -nsim_enable_disable | only in file -nsim_enable_disable_reply | only in file -nsim_output_feature_enable_disable | only in image -nsim_output_feature_enable_disable_reply | only in image -oam_add_del | only in file -oam_add_del_reply | only in file -oam_event | only in file -one_add_del_locator_set | definition changed -one_add_del_remote_mapping | definition changed -one_adjacencies_get_reply | definition changed -one_l2_arp_entries_get_reply | definition changed -one_ndp_entries_get_reply | definition changed -p2p_ethernet_add | definition changed -p2p_ethernet_add_reply | definition changed -p2p_ethernet_del | definition changed -pg_create_interface | definition changed -proxy_arp_add_del | definition changed -proxy_arp_details | definition changed -punt_details | only in file -punt_dump | only in file -punt_reason_details | only in image -punt_reason_dump | only in image -punt_socket_deregister | definition changed -punt_socket_details | definition changed -punt_socket_dump | definition changed -punt_socket_register | definition changed -qos_egress_map_delete | definition changed -qos_egress_map_details | only in image -qos_egress_map_dump | only in image -qos_egress_map_update | definition changed -qos_mark_details | only in image -qos_mark_details_reply | only in image -qos_mark_dump | only in image -qos_mark_enable_disable | definition changed -qos_record_details | only in image -qos_record_dump | only in image -qos_record_enable_disable | definition changed -qos_store_details | only in image -qos_store_dump | only in image -qos_store_enable_disable | only in image -qos_store_enable_disable_reply | only in image -sctp_add_src_dst_connection | only in file -sctp_add_src_dst_connection_reply | only in file -sctp_config | only in file -sctp_config_reply | only in file -sctp_del_src_dst_connection | only in file -sctp_del_src_dst_connection_reply | only in file -set_punt | definition changed -show_threads_reply | definition changed -show_vpe_system_time | only in image -show_vpe_system_time_reply | only in image -sockclnt_create_reply | definition changed -sr_localsid_add_del | definition changed -sr_localsids_details | definition changed -sr_policies_details | definition changed -sr_policy_add | definition changed -sr_policy_del | definition changed -sr_policy_mod | definition changed -sr_steering_pol_details | definition changed -svs_details | definition changed -svs_enable_disable | definition changed -svs_route_add_del | definition changed -svs_table_add_del | definition changed -sw_interface_bond_details | definition changed -sw_interface_dump | definition changed -sw_interface_ip6_set_link_local_address | only in image -sw_interface_ip6_set_link_local_address_reply | only in image -sw_interface_ip6nd_ra_prefix | definition changed -sw_interface_set_l2_bridge | definition changed -sw_interface_tap_v2_details | definition changed -syslog_get_filter_reply | definition changed -syslog_set_filter | definition changed -tap_create_v2 | definition changed -udp_encap_add | definition changed -udp_encap_details | definition changed -virtio_pci_create | definition changed -vmxnet3_details | definition changed -vxlan_gbp_tunnel_add_del | definition changed -vxlan_gbp_tunnel_details | definition changed -want_oam_events | only in file -want_oam_events_reply | only in file - -Found 319 api message signature differences - -### Patches that changed API definitions - -| @c src/vpp/api/vpe_types.api || -| ------- | ------- | -| [b'a47a5f20a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'a47a5f20a') | api papi: add alias for timestamp(datetime)/timedelta | -| [b'3cf9e67f5'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'3cf9e67f5') | api: add vl_api_version_t type | - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [b'a47a5f20a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'a47a5f20a') | api papi: add alias for timestamp(datetime)/timedelta | -| [b'888640a39'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'888640a39') | map gbp papi: match endianess of f64 | -| [b'03f1af23b'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'03f1af23b') | api: Implement log_dump/log_details | -| [b'c87b66c86'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'c87b66c86') | ipsec: ipsec-tun protect | -| [b'9ac113815'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'9ac113815') | API: Add support for limits to language. | - -| @c src/examples/sample-plugin/sample/sample.api || -| ------- | ------- | -| [b'78d91cf9a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'78d91cf9a') | sample-plugin: refactor .api to use explicit types | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [b'0ad4a439d'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'0ad4a439d') | Fix vpp crash bug while deleting dhcp client | -| [b'9a29f795a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'9a29f795a') | vpp_papi_provider.py: update defautmapping. | -| [b'b8591ac91'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'b8591ac91') | API sw_interface_dump: Dump all if index is zero | -| [b'4a7240636'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'4a7240636') | Make sw_interface_dump more compatible with 2.2.0 | -| [b'6407ba56a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'6407ba56a') | api: Add to interface crud - read by sw_if_index. | - -| @c src/vnet/qos/qos.api || -| ------- | ------- | -| [b'83832e7ce'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'83832e7ce') | qos: Store function | -| [b'5281a9029'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'5281a9029') | qos: QoS dump APIs | - -| @c src/vnet/bier/bier.api || -| ------- | ------- | -| [b'097fa66b9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'097fa66b9') | fib: fib api updates | -| [b'e6eefb6e3'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'e6eefb6e3') | Trivial Typo's in bier comments/docs. | - -| @c src/vnet/ipfix-export/ipfix_export.api || -| ------- | ------- | -| [b'21b83e96d'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'21b83e96d') | api: implement ipfix_flush | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [b'8ac1d6d05'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'8ac1d6d05') | session: Use parent_handle instead of transport_opts | -| [b'ba65ca496'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'ba65ca496') | Add transport_opts to connect_sock bapi | - -| @c src/vnet/gre/gre.api || -| ------- | ------- | -| [b'814f15948'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'814f15948') | gre: update gre.api with explicit types | -| [b'd0aed2eb3'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'd0aed2eb3') | GRE: set gre_tunnel_type init value to zero in API | -| [b'5a8844bdb'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'5a8844bdb') | GRE: API update | - -| @c src/vnet/pg/pg.api || -| ------- | ------- | -| [b'22e9cfd76'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'22e9cfd76') | pg: add GSO support | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [b'bc764c8bc'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'bc764c8bc') | l2: BD ARP termination entry API update | -| [b'54bc5e40c'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'54bc5e40c') | Update API description | -| [b'5e6f7348c'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'5e6f7348c') | l2: Add support for arp unicast forwarding | - -| @c src/vnet/udp/udp.api || -| ------- | ------- | -| [b'10dc2eabd'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'10dc2eabd') | udp: fix copyright typo | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [b'97d54ed43'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'97d54ed43') | tap: add support to configure tap interface host MTU size | - -| @c src/vnet/devices/virtio/vhost_user.api || -| ------- | ------- | -| [b'4208a4ce8'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'4208a4ce8') | devices interface tests: vhosst GSO support | - -| @c src/vnet/devices/virtio/virtio.api || -| ------- | ------- | -| [b'bbd6b746e'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'bbd6b746e') | virtio: Add gso support for native virtio driver | -| [b'43b512cac'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'43b512cac') | virtio: remove configurable queue size support | - -| @c src/vnet/mfib/mfib_types.api || -| ------- | ------- | -| [b'097fa66b9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'097fa66b9') | fib: fib api updates | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [b'c87b66c86'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'c87b66c86') | ipsec: ipsec-tun protect | -| [b'f2922422d'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'f2922422d') | ipsec: remove the set_key API | -| [b'80f6fd53f'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'80f6fd53f') | IPSEC: Pass the algorithm salt (used in GCM) over the API | - -| @c src/vnet/ethernet/p2p_ethernet.api || -| ------- | ------- | -| [b'8edca1361'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'8edca1361') | p2p ethernet: update p2p_ethernet.api with explicit types. | - -| @c src/vnet/bonding/bond.api || -| ------- | ------- | -| [b'751e3f382'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'751e3f382') | bonding: add support for numa-only in lacp mode | - -| @c src/vnet/mpls/mpls.api || -| ------- | ------- | -| [b'097fa66b9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'097fa66b9') | fib: fib api updates | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [b'288e09362'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'288e09362') | ipip: refactor ipip.api with explicit types | -| [b'cbd0824d6'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'cbd0824d6') | IPIP tunnel: use address types on API | - -| @c src/vnet/fib/fib_types.api || -| ------- | ------- | -| [b'1dbcf30b7'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'1dbcf30b7') | fib: Support the POP of a Psuedo Wire Control Word | -| [b'097fa66b9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'097fa66b9') | fib: fib api updates | - -| @c src/vnet/dhcp/dhcp.api || -| ------- | ------- | -| [b'038e1dfbd'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'038e1dfbd') | dhcp ip: DSCP settings for transmitted DHCP packets | -| [b'56bc738dc'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'56bc738dc') | Fix VPP-1487 DHCP client does not support option 6-domain server | - -| @c src/vnet/ip/punt.api || -| ------- | ------- | -| [b'719beb709'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'719beb709') | ip ipsec: Remove IPSec SPI-0 punt reason | -| [b'b538dd868'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'b538dd868') | Punt: specify packets by IP protocol Type | -| [b'50f0ac0f0'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'50f0ac0f0') | Punt: socket register for exception dispatched/punted packets based on reason | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [b'097fa66b9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'097fa66b9') | fib: fib api updates | -| [b'3a343d42d'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'3a343d42d') | reassembly: prevent long chain attack | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [b'515eed425'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'515eed425') | api: add prefix matcher typedef | -| [b'038e1dfbd'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'038e1dfbd') | dhcp ip: DSCP settings for transmitted DHCP packets | -| [b'53c501512'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'53c501512') | api: add DSCP definitions to ip_types.api | -| [b'ab05508e1'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'ab05508e1') | api: refactor format_vl_api_prefix_t return keys | -| [b'b538dd868'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'b538dd868') | Punt: specify packets by IP protocol Type | -| [b'50f0ac0f0'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'50f0ac0f0') | Punt: socket register for exception dispatched/punted packets based on reason | - -| @c src/plugins/l3xc/l3xc.api || -| ------- | ------- | -| [b'59fa121f8'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'59fa121f8') | L3 cross connect | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [b'4d376f67a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'4d376f67a') | map: Use vl_api_string macros. | - -| @c src/plugins/http_static/http_static.api || -| ------- | ------- | -| [b'68b24e2c9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'68b24e2c9') | plugins: http_static. Migrate to use api string type. | -| [b'22bc2c46e'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'22bc2c46e') | Static http server | - -| @c src/plugins/igmp/igmp.api || -| ------- | ------- | -| [b'4ff09ae34'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'4ff09ae34') | API: Python and Unix domain socket improvement | - -| @c src/plugins/sctp/sctp.api || -| ------- | ------- | -| [b'3ffe6cadf'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'3ffe6cadf') | sctp: move to plugins, disabled by default | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [b'3efcd0d7c'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'3efcd0d7c') | lb: vip and as dump/detail api's | -| [b'a0cb32cb9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'a0cb32cb9') | lb: update api.c to use scaffolding from latest skel | - -| @c src/plugins/lb/lb_types.api || -| ------- | ------- | -| [b'3efcd0d7c'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'3efcd0d7c') | lb: vip and as dump/detail api's | - -| @c src/plugins/mactime/mactime.api || -| ------- | ------- | -| [b'7681b1c46'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'7681b1c46') | mactime: add per-mac allow-with-quota feature | -| [b'0c6ac791d'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'0c6ac791d') | mactime: upstream new features | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [b'3918bdbcb'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'3918bdbcb') | gbp: update gbp-ext-itf API | -| [b'3c0d84c98'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'3c0d84c98') | gbp: add anonymous l3-out subnets | -| [b'cfc7a107e'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'cfc7a107e') | gbp: add anonymous l3-out external interfaces | -| [b'160c923f9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'160c923f9') | gbp: VRF scoped contracts | - -| @c src/plugins/acl/acl_types.api || -| ------- | ------- | -| [b'bb2e5221a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'bb2e5221a') | api acl: breakout acl_types.api for reuse by others | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [b'bb2e5221a'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'bb2e5221a') | api acl: breakout acl_types.api for reuse by others | -| [b'f995c7122'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'f995c7122') | acl: implement counters | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [b'e6e09a4ac'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'e6e09a4ac') | nat: elog rewrite for multi-worker support | -| [b'c1f93067e'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'c1f93067e') | Add default value for API Nat flags | -| [b'dd1e3e780'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'dd1e3e780') | NAT: VPP-1531 api cleanup & update | -| [b'89fec713f'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'89fec713f') | Revert "NAT: VPP-1531 api cleanup & update" | -| [b'bed1421b9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'bed1421b9') | NAT: VPP-1531 api cleanup & update | - -| @c src/plugins/abf/abf.api || -| ------- | ------- | -| [b'097fa66b9'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'097fa66b9') | fib: fib api updates | - -| @c src/plugins/nsim/nsim.api || -| ------- | ------- | -| [b'7c91007e1'](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b'7c91007e1') | Make the loss / delay sim available as an output feature | - - -@page release_notes_19043 Release notes for VPP 19.04.3 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1904) - -@page release_notes_19042 Release notes for VPP 19.04.2 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1904) - -@page release_notes_19041 Release notes for VPP 19.04.1 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1904) - -@page release_notes_1904 Release notes for VPP 19.04 - -More than 700 commits since the 19.01 release. - -## Features - -### Infrastructure -- DPDK 19.02 integration -- Buffer manager rework and improvements -- Python3 migration (work in progress) - - vppapigen - - Python API wrappers - - Docs generation - - vpp_config - - "make test" python3 readiness and refactoring -- Add "make test-gcov" target to main Makefile -- Refactor multiarch code -- vfctl script: bind VF to vfio-pci after VF is created -- cmake cross-compilation support -- CLI control of graph dispatch elogs -- AppImage packaging (disabled by default) -- Complete upstreaming of wireshark dissector -- Remove JVPP which is now an FD.io project -- Punt infra: manage dispatch of exception packets - -### VNET & Plugins -- BVI Interface -- Deprecate TAP cli -- Experimental TAP interface TCP segmentation offload -- Vmxnet3 driver plugin -- LACP passive mode -- ACL plugin refactoring -- RDMA (ibverb) driver plugin - MLX5 with multiqueue -- IPSEC - - Intel IPSEC-MB engine plugin - - Tunnel fragmentation - - CLI improvements - - Performance improvements - - API modernisation and improvements - - New Tests and test refactoring -- Crypto - - Introduce crypto infra - - crypto_ia32 plugin - - Add support for AEAD and AES-GCM - - Implement rfc4231 test cases - - Implement crypto tests per RFC2202 -- Perfmon improvements - - Python to C parser for intel CPUs - - 2-way parallel stat collection - - Collect data on selected thread(s) - -### Host stack -- Improve ldp/vls/vcl support for multi-process and multi-threaded applications -- Major refactor/cleanup of session layer -- Refactor cut-through sessions to use a custom transport -- Baseline QUIC transport support - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1904) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - - -Message Name | Result --------------------------------------------------------------|------------------ -accept_session | only in file -accept_session_reply | only in file -bind_sock_reply | definition changed -bind_uri_reply | definition changed -bvi_create | only in image -bvi_create_reply | only in image -bvi_delete | only in image -bvi_delete_reply | only in image -connect_session | only in file -connect_session_reply | only in file -ct6_enable | only in image -ct6_enable_disable | only in image -gbp_contract_add_del_reply | definition changed -gbp_endpoint_group_del | definition changed -gbp_endpoint_learn_set_inactive_threshold | only in file -gbp_endpoint_learn_set_inactive_threshold_reply | only in file -ikev2_plugin_get_version | only in image -ikev2_plugin_get_version_reply | only in image -ip4_arp_event | definition changed -ip6_nd_event | definition changed -ip6_ra_event | definition changed -ip6nd_proxy_add_del | definition changed -ip6nd_proxy_details | definition changed -ip_container_proxy_add_del | definition changed -ip_neighbor_add_del | definition changed -ip_neighbor_details | definition changed -ip_probe_neighbor | definition changed -ip_source_and_port_range_check_add_del | definition changed -ipsec_backend_details | definition changed -ipsec_gre_add_del_tunnel | only in file -ipsec_gre_add_del_tunnel_reply | only in file -ipsec_gre_tunnel_add_del | only in image -ipsec_gre_tunnel_add_del_reply | only in image -ipsec_gre_tunnel_details | definition changed -ipsec_sa_details | definition changed -ipsec_sa_set_key | definition changed -ipsec_sad_add_del_entry | only in file -ipsec_sad_add_del_entry_reply | only in file -ipsec_sad_entry_add_del | only in image -ipsec_sad_entry_add_del_reply | only in image -ipsec_select_backend | definition changed -ipsec_spd_add_del_entry | only in file -ipsec_spd_add_del_entry_reply | only in file -ipsec_spd_details | definition changed -ipsec_spd_entry_add_del | only in image -ipsec_spd_entry_add_del_reply | only in image -ipsec_tunnel_if_add_del | definition changed -lb_conf | definition changed -map_add_domain | definition changed -map_domain_details | definition changed -nat_ha_flush | only in image -nat_ha_flush_reply | only in image -nat_ha_get_failover | only in image -nat_ha_get_failover_reply | only in image -nat_ha_get_listener | only in image -nat_ha_get_listener_reply | only in image -nat_ha_resync | only in image -nat_ha_resync_completed_event | only in image -nat_ha_resync_reply | only in image -nat_ha_set_failover | only in image -nat_ha_set_failover_reply | only in image -nat_ha_set_listener | only in image -nat_ha_set_listener_reply | only in image -reset_session | only in file -reset_session_reply | only in file -sw_interface_ip6nd_ra_prefix | definition changed -sw_interface_set_dpdk_hqos_pipe | only in file -sw_interface_set_dpdk_hqos_pipe_reply | only in file -sw_interface_set_dpdk_hqos_subport | only in file -sw_interface_set_dpdk_hqos_subport_reply | only in file -sw_interface_set_dpdk_hqos_tctbl | only in file -sw_interface_set_dpdk_hqos_tctbl_reply | only in file -sw_interface_tap_details | only in file -sw_interface_tap_dump | only in file -sw_interface_virtio_pci_details | only in image -sw_interface_virtio_pci_dump | only in image -tap_connect | only in file -tap_connect_reply | only in file -tap_delete | only in file -tap_delete_reply | only in file -tap_modify | only in file -tap_modify_reply | only in file -virtio_pci_create | only in image -virtio_pci_create_reply | only in image -virtio_pci_delete | only in image -virtio_pci_delete_reply | only in image -vmxnet3_create | definition changed -vmxnet3_details | definition changed -want_ip4_arp_events | definition changed -want_ip6_nd_events | definition changed - -Found 90 api message signature differences - -### Patches that changed API definitions - -| @c src/vlibmemory/memclnt.api || -| ------- | ------- | -| [eaec2a6d9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=eaec2a6d9) | bapi: add options to have vpp cleanup client registration | - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [1aaf0e343](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1aaf0e343) | deprecate tapcli | -| [f49ba0e81](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f49ba0e81) | stats: Deprecate old stats framework | -| [413f4a5b2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=413f4a5b2) | API: Use string type instead of u8. | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [3b0d7e42f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3b0d7e42f) | Revert "API: Cleanup APIs interface.api" | -| [e63325e3c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e63325e3c) | API: Cleanup APIs interface.api | -| [bb2c7b580](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bb2c7b580) | Update documentation for src/vnet/interface.api sw_interface_dump | -| [f49ba0e81](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f49ba0e81) | stats: Deprecate old stats framework | -| [53fffa1db](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53fffa1db) | API: Add support for type aliases | -| [5100aa9cb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5100aa9cb) | vnet: store hw interface speed in kbps instead of using flags | - -| @c src/vnet/interface_types.api || -| ------- | ------- | -| [3b0d7e42f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3b0d7e42f) | Revert "API: Cleanup APIs interface.api" | -| [e63325e3c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e63325e3c) | API: Cleanup APIs interface.api | -| [53fffa1db](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53fffa1db) | API: Add support for type aliases | - -| @c src/vnet/bonding/bond.api || -| ------- | ------- | -| [ad9d52831](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ad9d52831) | bonding: support custom interface IDs | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [53fffa1db](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53fffa1db) | API: Add support for type aliases | - -| @c src/vnet/ipsec-gre/ipsec_gre.api || -| ------- | ------- | -| [e524d45ef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e524d45ef) | IPSEC-GRE: fixes and API update to common types. | - -| @c src/vnet/syslog/syslog.api || -| ------- | ------- | -| [b4515b4be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b4515b4be) | Add RFC5424 syslog protocol support (VPP-1139) | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [754f24b35](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=754f24b35) | tapv2: add "tap_flags" field to the TAPv2 interface API | - -| @c src/vnet/devices/virtio/virtio.api || -| ------- | ------- | -| [d6c15af33](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d6c15af33) | virtio: Native virtio driver | - -| @c src/vnet/fib/fib_types.api || -| ------- | ------- | -| [775f73c6b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=775f73c6b) | FIB: encode the label stack in the FIB path during table dump | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [8c8acc027](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8c8acc027) | API: Change ip4_address and ip6_address to use type alias. | -| [ffba3c377](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ffba3c377) | MAP: Use explicit address/prefix types in API | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [48ae19e90](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=48ae19e90) | API: Add python2.7 support for enum flags via aenum | -| [37029305c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=37029305c) | Use IP and MAC API types for neighbors | -| [7c03ed47d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7c03ed47d) | VOM: mroutes | -| [3460b014a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3460b014a) | api: ip_source_check_interface_add_del api is added. | -| [609e1210c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=609e1210c) | VPP-1507: Added binary api to dump configured ip_punt_redirect | -| [2af0e3a74](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2af0e3a74) | flow-hash: Add symmetric flag for flow hashing | -| [47527b24a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=47527b24a) | IP-punt: add documentation to the API and fix IP address init | -| [5bb1ecae8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5bb1ecae8) | IPv6: Make link-local configurable per-interface (VPP-1446) | -| [75b9f45a1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75b9f45a1) | ip: add container proxy dump API (VPP-1364) | - -| @c src/vnet/ip/punt.api || -| ------- | ------- | -| [e88865d7b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e88865d7b) | VPP-1506: dump local punts and registered punt sockets | - -| @c src/vnet/vxlan-gbp/vxlan_gbp.api || -| ------- | ------- | -| [4dd4cf4f9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4dd4cf4f9) | GBP: fixes for l3-out routing | -| [93cc3ee3b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=93cc3ee3b) | GBP Endpoint Learning | - -| @c src/vnet/ethernet/ethernet_types.api || -| ------- | ------- | -| [8006c6aa4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8006c6aa4) | PAPI: Add MACAddress object wrapper for vl_api_mac_address_t | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [1e3aa5e21](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1e3aa5e21) | ipsec: USE_EXTENDED_SEQ_NUM -> USE_ESN | -| [1ba5bc8d8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1ba5bc8d8) | ipsec: add ipv6 support for ipsec tunnel interface | -| [5d704aea5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5d704aea5) | updates now that flags are supported on the API | -| [53f526b68](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53f526b68) | TEST: IPSEC NAT-T with UDP header | -| [7c44d78ef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7c44d78ef) | IKEv2 to plugin | -| [eba31eceb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=eba31eceb) | IPSEC: move SA counters into the stats segment | -| [8d7c50200](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8d7c50200) | IPSEC: no second lookup after tunnel encap | -| [a09c1ff5b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a09c1ff5b) | IPSEC: SPD counters in the stats sgement | -| [17dcec0b9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=17dcec0b9) | IPSEC: API modernisation | -| [4c422f9a3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4c422f9a3) | Add IPSec interface FIB index for TX packet | -| [b4a7a7dcf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b4a7a7dcf) | Add UDP encap flag | -| [b4d305344](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b4d305344) | ipsec: infra for selecting backends | -| [871bca9aa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=871bca9aa) | VPP-1450: binary api call for dumping SPD to interface registration | - -| @c src/vnet/tcp/tcp.api || -| ------- | ------- | -| [c5df8c71c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c5df8c71c) | host stack: update stale copyright | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [192b13f96](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=192b13f96) | BVI Interface | -| [5daf0c55c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5daf0c55c) | add default NONE flag for bd_flags | -| [e26c81fc8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e26c81fc8) | L2 BD API to flush all IP-MAC entries in the specified BD | -| [8006c6aa4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8006c6aa4) | PAPI: Add MACAddress object wrapper for vl_api_mac_address_t | -| [93cc3ee3b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=93cc3ee3b) | GBP Endpoint Learning | -| [4d5b917b1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4d5b917b1) | BD ARP entry use common API types | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [6442401c2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6442401c2) | session: remove deprecated binary apis | -| [d85de68ec](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d85de68ec) | vcl: wait for segments with segment handle | -| [fa76a76bf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fa76a76bf) | session: segment handle in accept/connect notifications | -| [c1f5a4336](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c1f5a4336) | session: cleanup use of api_client_index | -| [c0d532d17](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0d532d17) | session: mark apis for deprecation | - -| @c src/vnet/udp/udp.api || -| ------- | ------- | -| [c5df8c71c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c5df8c71c) | host stack: update stale copyright | - -| @c src/plugins/cdp/cdp.api || -| ------- | ------- | -| [76ef6094c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=76ef6094c) | tests: cdp plugin. Replace cdp enable cli command with API call. | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [8feeaff56](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8feeaff56) | Typos. A bunch of typos I've been collecting. | -| [34931eb47](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=34931eb47) | NAT44: active-passive HA (VPP-1571) | -| [b686508c4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b686508c4) | NAT44: nat44_add_del_lb_static_mapping enhancements (VPP-1514) | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [4dc5c7b90](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4dc5c7b90) | MAP: Add optional user-supplied 'tag' field in MAPs. | -| [fc7344f9b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fc7344f9b) | MAP: Convert from DPO to input feature. | -| [f34597fc8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f34597fc8) | MAP: Add API support for MAP input feature. | -| [5a2e278a0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5a2e278a0) | MAP: Add API support for setting parameters. | -| [a173a7a07](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a173a7a07) | MAP: Use bool type in map.api instead of u8. | -| [ffba3c377](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ffba3c377) | MAP: Use explicit address/prefix types in API | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [1aa35576e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1aa35576e) | GBP: Counters per-contract | -| [8ea109e40](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8ea109e40) | gbp: Add bd flags | -| [7bd343509](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7bd343509) | GBP: custom-dump functions | -| [fa0ac2c56](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fa0ac2c56) | GBP: contracts API fixed length of allowed ethertypes | -| [5d704aea5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5d704aea5) | updates now that flags are supported on the API | -| [4ba67723d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4ba67723d) | GBP: use sclass in the DP for policy | -| [8da9fc659](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8da9fc659) | GBP: learn from ARP and L2 packets | -| [32f6d8e0c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=32f6d8e0c) | GBP: per-group EP retention policy | -| [879d11c25](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=879d11c25) | GBP: Sclass to src-epg conversions | -| [1c17e2eca](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1c17e2eca) | GBP: add allowed ethertypes to contracts | -| [b6a479539](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b6a479539) | GBP: l3-out subnets | -| [33b81da54](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33b81da54) | vom: Add support for redirect contracts in gbp | -| [13a08cc09](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=13a08cc09) | GBP: redirect contracts | -| [c29c0af40](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c29c0af40) | GBP: Endpoints with VLAN tags and birdges that don't learn | -| [93cc3ee3b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=93cc3ee3b) | GBP Endpoint Learning | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [bb5d22daf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bb5d22daf) | New api in order to get max entries of connection table is added. | - -| @c src/plugins/vmxnet3/vmxnet3.api || -| ------- | ------- | -| [ee8ba6877](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ee8ba6877) | vmxnet3: auto bind support | -| [854559d15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=854559d15) | vmxnet3: RSS support | -| [773291163](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=773291163) | vmxnet3: multiple TX queues support | - -| @c src/plugins/nsim/nsim.api || -| ------- | ------- | -| [10c5ff143](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=10c5ff143) | nsim: add packet loss simulation, docs | - -| @c src/plugins/igmp/igmp.api || -| ------- | ------- | -| [97748cae2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=97748cae2) | IGMP: proxy device | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [f7f13347b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7f13347b) | tests: update test_lb.py to use api call lb_conf. | - -| @c src/plugins/ct6/ct6.api || -| ------- | ------- | -| [a55df1081](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a55df1081) | ipv6 connection tracking plugin | - -| @c src/plugins/ikev2/ikev2.api || -| ------- | ------- | -| [7c44d78ef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7c44d78ef) | IKEv2 to plugin | - - -@page release_notes_19013 Release notes for VPP 19.01.3 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1901) - -@page release_notes_19012 Release notes for VPP 19.01.2 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1901) - -@page release_notes_19011 Release notes for VPP 19.01.1 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1901) - -@page release_notes_1901 Release notes for VPP 19.01 - -More than 649 commits since the 18.10 release. - -## Features - -### Infrastructure -- NUMA-aware, growable physical memory allocator (pmalloc) -- FIB: sticky load-balance -- C11 safe string handling: provide and use "safe" C string handling functions -- vlib: allocate buffers on local numa, not on numa 1 -- vppinfra: autodetect default hugepage size -- Move RPC traffic off the shared-memory API queue -- IPv6: Make link-local configurable per-interface -- IGMP: improve CLI debug output -- IPSec: split ipsec nodes into ip4/ip6 nodes -- IPSec: infra for selecting backends -- vhost-user: cleanup and performance optimizations -- ethernet-input, memif improvements and optimizations -- DPDK: bump to DPDK 18.11 -- reassembly: harden reassembly code -- stats: Deprecate old (event-based) stats framework -- vlib: support Hyper-V/Azure VMBus -- binary api clients: wait for vpp to start -- graph dispatch trace: capture packet data and buffer metadata, output in pcap format -- improve feature arc order constraint specification - -### VNET & Plugins -- pktgen: correctly replay a mix of single and multi-buffer packets -- add wireshark dissector to extras -- avf: optimizations -- acl-plugin: use L2 feature arc instead of L2 classifier -- acl-plugin: performance enhancement -- dpdk: allow interface name to be specified from startup.conf -- dpdk: blacklist PCI devices by type -- dpdk: switch to in-memory mode, deprecate use of socket-mem -- vnet: store hw interface speed in kbps instead of using flags -- vmxnet3: enable promiscuous mode & cli enhancements -- gbp: Add support for flow hash profile & l3-out subnets -- map: Add API support for setting parameters. -- map: Convert from DPO to input feature -- nat: improve expired sessions reuse in NAT44 -- nat: syslog - sessions logging -- nsim: add packet loss simulation, docs -- perfmon: x86_64 perf counter plugin -- vnet: L2 feature arc infrastructure - -### Host stack -- TCP congestion control improvements -- TCP Cubic congestion control algorithm -- TCP fast path optimizations -- Transport tx connection pacer. TCP uses it by default -- Basic support for session flushing and TCP PSH segments -- TCP/session api support for configuring custom local src ip/port -- VCL/LDP basic support for multi-process applications -- Overall code hardening, cleanup and bugfixing for tcp, session, vcl and ldp - -### PAPI & Test framework -- add specific API types for IP addresses, MAC address, interface index etc. -- add timeout support for socket transport -- add support for format/unformat functions -- generic API types format/unformat support for VAT and custom dump -- python3 test adjustments -- make test: create virtualenv under /test/ -- make test: print TEST= values for failed tests -- add human-friendly annotations to log messages - -### VOM -- Add support for redirect contracts in gbp -- deprecate TAP add ip-punt redirect dump -- vxlan-gbp support - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1810) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - -Message Name | Results ------------------------------------------------------------- | ---------------- -acl_plugin_get_conn_table_max_entries | only in image -acl_plugin_get_conn_table_max_entries_reply | only in image -app_worker_add_del | definition changed -app_worker_add_del_reply | definition changed -application_attach_reply | definition changed -bd_ip_mac_add_del | definition changed -bd_ip_mac_details | definition changed -bd_ip_mac_flush | only in image -bd_ip_mac_flush_reply | only in image -bond_create | definition changed -cli_inband | definition changed -cli_inband_reply | definition changed -gbp_bridge_domain_add | only in image -gbp_bridge_domain_add_reply | only in image -gbp_bridge_domain_del | only in image -gbp_bridge_domain_del_reply | only in image -gbp_bridge_domain_details | only in image -gbp_bridge_domain_dump | only in image -gbp_bridge_domain_dump_reply | only in image -gbp_endpoint_details | definition changed -gbp_endpoint_group_add | only in image -gbp_endpoint_group_add_del | only in file -gbp_endpoint_group_add_del_reply | only in file -gbp_endpoint_group_add_reply | only in image -gbp_endpoint_group_del | only in image -gbp_endpoint_group_del_reply | only in image -gbp_endpoint_learn_set_inactive_threshold | only in image -gbp_endpoint_learn_set_inactive_threshold_reply | only in image -gbp_ext_itf_add_del | only in image -gbp_ext_itf_add_del_reply | only in image -gbp_ext_itf_details | only in image -gbp_ext_itf_dump | only in image -gbp_route_domain_add | only in image -gbp_route_domain_add_reply | only in image -gbp_route_domain_del | only in image -gbp_route_domain_del_reply | only in image -gbp_route_domain_details | only in image -gbp_route_domain_dump | only in image -gbp_route_domain_dump_reply | only in image -gbp_vxlan_tunnel_add | only in image -gbp_vxlan_tunnel_add_reply | only in image -gbp_vxlan_tunnel_del | only in image -gbp_vxlan_tunnel_del_reply | only in image -gbp_vxlan_tunnel_details | only in image -gbp_vxlan_tunnel_dump | only in image -igmp_proxy_device_add_del | only in image -igmp_proxy_device_add_del_interface | only in image -igmp_proxy_device_add_del_interface_reply | only in image -igmp_proxy_device_add_del_reply | only in image -ip6_mfib_details | definition changed -ip_container_proxy_details | only in image -ip_container_proxy_dump | only in image -ip_mfib_details | definition changed -ip_punt_redirect | definition changed -ip_punt_redirect_details | only in image -ip_punt_redirect_dump | only in image -ip_source_check_interface_add_del | only in image -ip_source_check_interface_add_del_reply | only in image -ipip_6rd_add_tunnel_reply | definition changed -ipip_6rd_del_tunnel | definition changed -ipip_add_tunnel_reply | definition changed -ipip_del_tunnel | definition changed -ipip_tunnel_details | definition changed -ipip_tunnel_dump | definition changed -ipsec_backend_details | only in image -ipsec_backend_dump | only in image -ipsec_sa_details | definition changed -ipsec_select_backend | only in image -ipsec_select_backend_reply | only in image -ipsec_tunnel_if_add_del | definition changed -map_add_del_rule | definition changed -map_add_domain | definition changed -map_another_segment | definition changed -map_domain_details | definition changed -map_if_enable_disable | only in image -map_if_enable_disable_reply | only in image -map_param_add_del_pre_resolve | only in image -map_param_add_del_pre_resolve_reply | only in image -map_param_get | only in image -map_param_get_reply | only in image -map_param_set_fragmentation | only in image -map_param_set_fragmentation_reply | only in image -map_param_set_icmp6 | only in image -map_param_set_icmp6_reply | only in image -map_param_set_icmp | only in image -map_param_set_icmp_reply | only in image -map_param_set_reassembly | only in image -map_param_set_reassembly_reply | only in image -map_param_set_security_check | only in image -map_param_set_security_check_reply | only in image -map_param_set_tcp | only in image -map_param_set_tcp_reply | only in image -map_param_set_traffic_class | only in image -map_param_set_traffic_class_reply | only in image -map_rule_details | definition changed -memclnt_delete | definition changed -nat44_add_del_lb_static_mapping | definition changed -nat44_lb_static_mapping_add_del_local | only in image -nat44_lb_static_mapping_add_del_local_reply | only in image -nat44_lb_static_mapping_details | definition changed -nsim_configure | definition changed -punt | only in file -punt_details | only in image -punt_dump | only in image -punt_reply | only in file -punt_socket_deregister | definition changed -punt_socket_details | only in image -punt_socket_dump | only in image -punt_socket_register | definition changed -set_ip_flow_hash | definition changed -set_punt | only in image -set_punt_reply | only in image -show_version_reply | definition changed -stats_get_poller_delay | only in file -stats_get_poller_delay_reply | only in file -sw_interface_bond_details | definition changed -sw_interface_details | definition changed -sw_interface_ip6_set_link_local_address | only in file -sw_interface_ip6_set_link_local_address_reply | only in file -sw_interface_tap_v2_details | definition changed -syslog_get_filter | only in image -syslog_get_filter_reply | only in image -syslog_get_sender | only in image -syslog_get_sender_reply | only in image -syslog_set_filter | only in image -syslog_set_filter_reply | only in image -syslog_set_sender | only in image -syslog_set_sender_reply | only in image -tap_create_v2 | definition changed -unmap_segment | definition changed -vnet_bier_neighbor_counters | only in file -vnet_get_summary_stats | only in file -vnet_get_summary_stats_reply | only in file -vnet_interface_combined_counters | only in file -vnet_interface_simple_counters | only in file -vnet_ip4_fib_counters | only in file -vnet_ip4_mfib_counters | only in file -vnet_ip4_nbr_counters | only in file -vnet_ip6_fib_counters | only in file -vnet_ip6_mfib_counters | only in file -vnet_ip6_nbr_counters | only in file -vnet_per_interface_combined_counters | only in file -vnet_per_interface_simple_counters | only in file -vnet_udp_encap_counters | only in file -want_bier_neighbor_stats | only in file -want_bier_neighbor_stats_reply | only in file -want_interface_combined_stats | only in file -want_interface_combined_stats_reply | only in file -want_interface_simple_stats | only in file -want_interface_simple_stats_reply | only in file -want_ip4_fib_stats | only in file -want_ip4_fib_stats_reply | only in file -want_ip4_mfib_stats | only in file -want_ip4_mfib_stats_reply | only in file -want_ip4_nbr_stats | only in file -want_ip4_nbr_stats_reply | only in file -want_ip6_fib_stats | only in file -want_ip6_fib_stats_reply | only in file -want_ip6_mfib_stats | only in file -want_ip6_mfib_stats_reply | only in file -want_ip6_nbr_stats | only in file -want_ip6_nbr_stats_reply | only in file -want_per_interface_combined_stats | only in file -want_per_interface_combined_stats_reply | only in file -want_per_interface_simple_stats | only in file -want_per_interface_simple_stats_reply | only in file -want_stats | only in file -want_stats_reply | only in file -want_udp_encap_stats | only in file -want_udp_encap_stats_reply | only in file - -Found 170 api message signature differences - -### Patches that changed API definitions - -| @c src/vnet/interface_types.api || -| ------- | ------- | -| [53fffa1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53fffa1) | API: Add support for type aliases | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [f49ba0e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f49ba0e) | stats: Deprecate old stats framework | -| [53fffa1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53fffa1) | API: Add support for type aliases | -| [5100aa9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5100aa9) | vnet: store hw interface speed in kbps instead of using flags | - -| @c src/vnet/syslog/syslog.api || -| ------- | ------- | -| [b4515b4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b4515b4) | Add RFC5424 syslog protocol support (VPP-1139) | - -| @c src/vnet/fib/fib_types.api || -| ------- | ------- | -| [775f73c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=775f73c) | FIB: encode the label stack in the FIB path during table dump | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [7c03ed4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7c03ed4) | VOM: mroutes | -| [3460b01](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3460b01) | api: ip_source_check_interface_add_del api is added. | -| [609e121](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=609e121) | VPP-1507: Added binary api to dump configured ip_punt_redirect | -| [2af0e3a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2af0e3a) | flow-hash: Add symmetric flag for flow hashing | -| [47527b2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=47527b2) | IP-punt: add documentation to the API and fix IP address init | -| [5bb1eca](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5bb1eca) | IPv6: Make link-local configurable per-interface (VPP-1446) | -| [75b9f45](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75b9f45) | ip: add container proxy dump API (VPP-1364) | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [8c8acc0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8c8acc0) | API: Change ip4_address and ip6_address to use type alias. | -| [ffba3c3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ffba3c3) | MAP: Use explicit address/prefix types in API | - -| @c src/vnet/ip/punt.api || -| ------- | ------- | -| [e88865d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e88865d) | VPP-1506: dump local punts and registered punt sockets | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [4c422f9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4c422f9) | Add IPSec interface FIB index for TX packet | -| [b4a7a7d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b4a7a7d) | Add UDP encap flag | -| [b4d3053](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b4d3053) | ipsec: infra for selecting backends | -| [871bca9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=871bca9) | VPP-1450: binary api call for dumping SPD to interface registration | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [e26c81f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e26c81f) | L2 BD API to flush all IP-MAC entries in the specified BD | -| [8006c6a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8006c6a) | PAPI: Add MACAddress object wrapper for vl_api_mac_address_t | -| [93cc3ee](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=93cc3ee) | GBP Endpoint Learning | -| [4d5b917](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4d5b917) | BD ARP entry use common API types | - -| @c src/vnet/vxlan-gbp/vxlan_gbp.api || -| ------- | ------- | -| [93cc3ee](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=93cc3ee) | GBP Endpoint Learning | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [53fffa1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=53fffa1) | API: Add support for type aliases | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [d85de68](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d85de68) | vcl: wait for segments with segment handle | -| [fa76a76](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fa76a76) | session: segment handle in accept/connect notifications | -| [c1f5a43](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c1f5a43) | session: cleanup use of api_client_index | -| [c0d532d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0d532d) | session: mark apis for deprecation | - -| @c src/vnet/ethernet/ethernet_types.api || -| ------- | ------- | -| [8006c6a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8006c6a) | PAPI: Add MACAddress object wrapper for vl_api_mac_address_t | - -| @c src/vnet/bonding/bond.api || -| ------- | ------- | -| [ad9d528](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ad9d528) | bonding: support custom interface IDs | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [754f24b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=754f24b) | tapv2: add "tap_flags" field to the TAPv2 interface API | - -| @c src/vlibmemory/memclnt.api || -| ------- | ------- | -| [eaec2a6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=eaec2a6) | bapi: add options to have vpp cleanup client registration | - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [f49ba0e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f49ba0e) | stats: Deprecate old stats framework | -| [413f4a5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=413f4a5) | API: Use string type instead of u8. | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [bb5d22d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bb5d22d) | New api in order to get max entries of connection table is added. | - -| @c src/plugins/nsim/nsim.api || -| ------- | ------- | -| [10c5ff1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=10c5ff1) | nsim: add packet loss simulation, docs | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [1c17e2e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1c17e2e) | GBP: add allowed ethertypes to contracts | -| [b6a4795](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b6a4795) | GBP: l3-out subnets | -| [33b81da](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=33b81da) | vom: Add support for redirect contracts in gbp | -| [13a08cc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=13a08cc) | GBP: redirect contracts | -| [c29c0af](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c29c0af) | GBP: Endpoints with VLAN tags and birdges that don't learn | -| [93cc3ee](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=93cc3ee) | GBP Endpoint Learning | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [b686508](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b686508) | NAT44: nat44_add_del_lb_static_mapping enhancements (VPP-1514) | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [fc7344f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fc7344f) | MAP: Convert from DPO to input feature. | -| [f34597f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f34597f) | MAP: Add API support for MAP input feature. | -| [5a2e278](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5a2e278) | MAP: Add API support for setting parameters. | -| [a173a7a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a173a7a) | MAP: Use bool type in map.api instead of u8. | -| [ffba3c3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ffba3c3) | MAP: Use explicit address/prefix types in API | - -| @c src/plugins/igmp/igmp.api || -| ------- | ------- | -| [97748ca](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=97748ca) | IGMP: proxy device | - - -@page release_notes_1810 Release notes for VPP 18.10 - -More than 632 commits since the 18.07 release. - -## Features - -### Infrastructure -- DPDK 18.08 integration -- New Stats infrastructure (interface, error, node performance counters) -- Add configurable "Doug Lea malloc" support - -### VNET & Plugins -- Load balancing: support per-port VIP and all-port VIP -- Port NSH plugin to VPP -- NAT - - Configurable port range - - Virtual Fragmentation Reassembly for endpoint-dependent mode - - Client-IP based session affinity for load-balancing - - TCP MSS clamping - - Session timeout - - Bug-fixing and performance optimizations - -### Host stack -- Support for applications with multiple workers -- Support for binds from multiple app workers to same ip:port -- Switched to a message queue for io and control event notifications -- Support for eventfd based notifications as alternative to mutext-condvar pair -- VCL refactor to support async event notifications and multiple workers -- TLS async support in client for HW accleration -- Performance optimizations and bug-fixing -- A number of binary APIs will be deprecated in favor of using the event - message queue. Details in the API section. - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1810) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - - Message Name Result -api_versions_reply definition changed -app_cut_through_registration_add definition changed -app_worker_add_del definition changed -application_attach_reply definition changed -bd_ip_mac_details only in image -bd_ip_mac_dump only in image -bfd_udp_get_echo_source definition changed -bier_imp_details definition changed -bier_route_details definition changed -bind_sock definition changed -bridge_domain_details definition changed -bridge_flags definition changed -classify_add_del_session definition changed -classify_add_del_table definition changed -connect_sock definition changed -create_vhost_user_if definition changed -get_first_msg_id_reply definition changed -gpe_add_del_fwd_entry_reply definition changed -gpe_fwd_entry_path_details definition changed -ip6_fib_details definition changed -ip6nd_proxy_details definition changed -ip_add_del_route_reply definition changed -ip_address_details definition changed -ip_details definition changed -ip_fib_details definition changed -ip_mfib_details definition changed -ip_mroute_add_del_reply definition changed -ip_neighbor_add_del_reply definition changed -ip_neighbor_details definition changed -ip_reassembly_get_reply definition changed -ip_unnumbered_details definition changed -ipip_6rd_add_tunnel definition changed -ipip_add_tunnel definition changed -ipsec_spds_details only in image -ipsec_spds_dump only in image -l2_interface_efp_filter definition changed -lisp_eid_table_vni_details definition changed -map_another_segment definition changed -mfib_signal_details definition changed -mpls_route_add_del_reply definition changed -mpls_tunnel_add_del definition changed -mpls_tunnel_add_del_reply definition changed -mpls_tunnel_details definition changed -mpls_tunnel_dump definition changed -one_eid_table_vni_details definition changed -qos_mark_enable_disable definition changed -qos_record_enable_disable definition changed -reset_session_reply definition changed -rpc_call definition changed -show_threads definition changed -sockclnt_create_reply definition changed -sockclnt_delete definition changed -sockclnt_delete_reply definition changed -sw_interface_rx_placement_details only in image -sw_interface_rx_placement_dump only in image -sw_interface_set_ip_directed_broadcast definition changed -sw_interface_set_l2_bridge definition changed -sw_interface_set_rx_placement definition changed -sw_interface_set_vxlan_gbp_bypass definition changed -udp_encap_add definition changed -udp_encap_add_del_reply only in file -udp_encap_add_reply only in image -udp_encap_del definition changed -udp_encap_details definition changed -unbind_sock definition changed -vxlan_gbp_tunnel_add_del definition changed -vxlan_gbp_tunnel_details only in image -vxlan_gbp_tunnel_dump only in image -Found 68 api message signature differences - -### Patches that changed API definitions - -| @c src/plugins/avf/avf.api || -| ------- | ------- | -| [149d0e28](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=149d0e28) | avf: RSS support | -| [4e6014fc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4e6014fc) | avf: api fix | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [c0a93143](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c0a93143) | GBP Endpoint Updates | -| [61b94c6b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=61b94c6b) | vxlan-gbp: Add support for vxlan gbp | - -| @c src/plugins/igmp/igmp.api || -| ------- | ------- | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [6a4375e0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6a4375e0) | LB: fix flush flow table issue | -| [49ca2601](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=49ca2601) | Add flush flag on del as command | -| [219cc90c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=219cc90c) | Support lb on both vip and per-port-vip case | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [bb4e0225](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bb4e0225) | NAT: TCP MSS clamping | -| [5d28c7af](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5d28c7af) | NAT: add support for configurable port range (VPP-1346) | -| [ea5b5be4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ea5b5be4) | NAT44: client-IP based session affinity for load-balancing (VPP-1297) | -| [878c646a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=878c646a) | NAT44: add support for session timeout (VPP-1272) | -| [69ce30d6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=69ce30d6) | NAT: update nat_show_config_reply API (VPP-1403) | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | -| [c6c0d2a0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c6c0d2a0) | NAT44: LB NAT - local backends in multiple VRFs (VPP-1345) | - -| @c src/plugins/vmxnet3/vmxnet3.api || -| ------- | ------- | -| [df7f8e8c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=df7f8e8c) | vmxnet3 device driver | - -| @c src/plugins/nsh/nsh.api || -| ------- | ------- | -| [d313f9e6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d313f9e6) | Port NSH plugin to VPP | - -| @c src/plugins/nsim/nsim.api || -| ------- | ------- | -| [9e3252b5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9e3252b5) | Network delay simulator plugin | - -| @c src/plugins/svs/svs.api || -| ------- | ------- | -| [d1e68ab7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d1e68ab7) | Source VRF Select | - -| @c src/vlibmemory/memclnt.api || -| ------- | ------- | -| [94495f2a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=94495f2a) | PAPI: Use UNIX domain sockets instead of shared memory | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | -| [75282457](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75282457) | Fix "Old Style VLA" build warnings | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [f0b42f48](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f0b42f48) | itf: dump interface rx-placement | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | -| [54f7c51f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=54f7c51f) | rx-placement: Add API call for interface rx-placement | -| [1855b8e4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1855b8e4) | IP directed broadcast | - -| @c src/vnet/bfd/bfd.api || -| ------- | ------- | -| [2d3c7b9c](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2d3c7b9c) | BFD: add get echo source API (VPP-1367) | - -| @c src/vnet/bier/bier.api || -| ------- | ------- | -| [ef90ed08](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ef90ed08) | BIER API and load-balancing fixes | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | - -| @c src/vnet/classify/classify.api || -| ------- | ------- | -| [34eb5d42](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=34eb5d42) | classify_add_del_session API: Use more descriptive docstring (VPP-1385) | -| [75282457](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75282457) | Fix "Old Style VLA" build warnings | - -| @c src/vnet/devices/pipe/pipe.api || -| ------- | ------- | -| [208c29aa](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=208c29aa) | VOM: support for pipes | - -| @c src/vnet/devices/virtio/vhost_user.api || -| ------- | ------- | -| [ee2e58f6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ee2e58f6) | vhost-user: Add disable feature support in api | - -| @c src/vnet/ethernet/ethernet_types.api || -| ------- | ------- | -| [de5b08fb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=de5b08fb) | Introduce a mac_address_t on the API and in VPP | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [d0df49f2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d0df49f2) | Use IP address types on UDP encap API | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [412ecd32](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=412ecd32) | Improve ip_mroute_add_del documentation | -| [14260393](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=14260393) | Add adjacency counters to the stats segment | -| [28c142e3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=28c142e3) | mroute routers in the stats segment | -| [008dbe10](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=008dbe10) | Route counters in the stats segment | -| [de5b08fb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=de5b08fb) | Introduce a mac_address_t on the API and in VPP | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | -| [b11f903a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b11f903a) | Fix context field position in API definition | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [61502115](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=61502115) | IPIP and SIXRD tunnels create API needs table-IDs not fib-indexes | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [a9a0b2ce](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a9a0b2ce) | IPsec: add API for SPDs dump (VPP-1363) | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [0a4e0063](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0a4e0063) | Fix documentation about sw_interface_set_l2_bridge | -| [b474380f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b474380f) | L2 BD: introduce a BD interface on which to send UU packets | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | -| [5c7c49d1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5c7c49d1) | Fix documentation for SHG in bridge domain | -| [5d82d2f1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5d82d2f1) | l2: arp termination dump | -| [6b9b41c8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6b9b41c8) | L2 EFP: byteswap sw_if_index, enable flag can be u8 on .api | - -| @c src/vnet/lisp-cp/lisp.api || -| ------- | ------- | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | - -| @c src/vnet/lisp-cp/one.api || -| ------- | ------- | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | - -| @c src/vnet/lisp-gpe/lisp_gpe.api || -| ------- | ------- | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | -| [b11f903a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=b11f903a) | Fix context field position in API definition | - -| @c src/vnet/mpls/mpls.api || -| ------- | ------- | -| [f5fa5ae2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f5fa5ae2) | MPLS tunnel dump: use sw_if_index not tunnel_index | -| [6a30b5f9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6a30b5f9) | MPLS tunnel dump fix | -| [008dbe10](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=008dbe10) | Route counters in the stats segment | -| [7c922dc4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7c922dc4) | SR-MPLS: fixes and tests | - -| @c src/vnet/qos/qos.api || -| ------- | ------- | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | -| [ed234e7f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ed234e7f) | Enum type on the API for QoS sources | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [ab2f6dbf](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ab2f6dbf) | session: support multiple worker binds | -| [134a996a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=134a996a) | vcl: add support for multi-worker apps | -| [1553197f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1553197f) | session: add support for multiple app workers | -| [6bd197eb](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6bd197eb) | Remove client_index field from replies in API | -| [99368315](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=99368315) | vcl: support for eventfd mq signaling | - -| @c src/vnet/span/span.api || -| ------- | ------- | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | - -| @c src/vnet/udp/udp.api || -| ------- | ------- | -| [9c0a3c42](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9c0a3c42) | UDP-Encap: name counters for the stats segment | -| [d0df49f2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d0df49f2) | Use IP address types on UDP encap API | - -| @c src/vnet/unix/tap.api || -| ------- | ------- | -| [bdc0e6b7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bdc0e6b7) | Trivial: Clean up some typos. | - -| @c src/vnet/vxlan-gbp/vxlan_gbp.api || -| ------- | ------- | -| [79a05f54](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=79a05f54) | VXLAN-GBP: use common types on the API | -| [61b94c6b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=61b94c6b) | vxlan-gbp: Add support for vxlan gbp | - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [5d64c786](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5d64c786) | thread: Add show threads api | -| [ec11b13a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ec11b13a) | Trivial: Cleanup some typos. | - -| @c src/vpp/stats/stats.api || -| ------- | ------- | -| [ec11b13a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ec11b13a) | Trivial: Cleanup some typos. | - -### Notice of future API deprecation -- bind_uri_reply -- accept_session -- accept_session_reply -- disconnect_session_reply -- reset_session -- reset_session_reply -- bind_sock_reply -- connect_session_reply - - -@page release_notes_1807 Release notes for VPP 18.07 - -More than 533 commits since the 18.04 release. - -## Features - -### Infrastructure -- DPDK 18.02.1 - - Complete rework of the dpdk-input node - - Display rx/tx burst function name in "show hardware detail" - - Improve buffer alloc perfomance - - This is ~50% improvement in buffer alloc performance. For a 256 buffer allocation, it was ~10 clocks/buffer, now is < 5 clocks. - - Add per-numa page allocation info to 'show memory' - - Vectorized bihash_{48,40,24,16}_8 key compare - - bihash_48_8 case: - - Scalar code: 6 clocks - - SSE4.2 code: 3 clocks - - AVX2 code: 2.27 clocks - - AVX512 code: 1.5 clocks - - Pollable Stats - - Stats are now available to a client in a shared memory segment and - in the form of a directory, allowing very high performance polling - of stats without directly querying VPP. - -### VNET & Plugins -- IGMP improvements - - Enable/Disable an interface for IGMP - - improve logging - - refactor common code - - no orphaned timers - - IGMP state changes in main thread only - - Large groups split over multiple state-change reports - - SSM range configuration API. - - more tests -- IP: vectorized IP checksum -- VXLAN : HW offload RX flow -- Rework kube-proxy into LB plugin and add NATA66 -- NAT: - - Code refactor - - Syslog - - Multiple outside interfaces - - Endpoint dependent filtering and mapping -- ACL: - - Tuple Merge algorithm cleanup and integration - - Processing pipeline optimizations - - Refactoring -- Experimental AVF driver - -### Host stack - -- Session: performance improvements, add support for connectionless transports, datagram reception and transmission -- TCP: congestion control improvements and overall fixes -- UDP: datagram mode -- TLS async support - - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1807) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - - Message Name Result -abf_itf_attach_add_del definition changed -abf_itf_attach_details only in image -abf_itf_attach_dump only in image -abf_plugin_get_version definition changed -abf_policy_add_del definition changed -abf_policy_details only in image -abf_policy_dump only in image -af_packet_details only in image -af_packet_dump only in image -avf_create definition changed -avf_delete definition changed -bind_sock_reply definition changed -bind_uri_reply definition changed -dhcp6_client_enable_disable definition changed -dhcp6_clients_enable_disable definition changed -dhcp6_duid_ll_set definition changed -dhcp6_pd_client_enable_disable definition changed -dhcp6_pd_reply_event only in image -dhcp6_pd_send_client_message definition changed -dhcp6_reply_event only in image -dhcp6_send_client_message definition changed -dhcp_client_config definition changed -dhcp_client_details only in image -dhcp_client_dump only in image -dhcp_compl_event definition changed -dslite_address_details only in image -dslite_address_dump only in image -gbp_endpoint_group_add_del definition changed -gbp_endpoint_group_details only in image -gbp_endpoint_group_dump only in image -gbp_recirc_add_del definition changed -gbp_recirc_details only in image -gbp_recirc_dump only in image -gbp_subnet_add_del definition changed -gbp_subnet_details only in image -gbp_subnet_dump only in image -hw_interface_set_mtu definition changed -igmp_details definition changed -igmp_dump definition changed -igmp_enable_disable definition changed -igmp_event definition changed -igmp_group_prefix_details only in image -igmp_group_prefix_dump only in image -igmp_group_prefix_set definition changed -igmp_listen definition changed -ikev2_profile_set_auth definition changed -ikev2_profile_set_id definition changed -ip6_add_del_address_using_prefix definition changed -ip_mroute_add_del definition changed -ip_probe_neighbor definition changed -ip_scan_neighbor_enable_disable definition changed -ip_unnumbered_details only in image -ip_unnumbered_dump only in image -ipip_6rd_add_tunnel definition changed -ipip_add_tunnel definition changed -ipip_tunnel_details definition changed -ipsec_sa_details definition changed -ipsec_sad_add_del_entry definition changed -ipsec_tunnel_if_add_del definition changed -kp_add_del_pod definition changed -kp_add_del_vip definition changed -kp_conf definition changed -lb_add_del_vip definition changed -mactime_add_del definition changed -mactime_enable definition changed -memclnt_create definition changed -memclnt_create_reply definition changed -memfd_segment_create definition changed -nat44_add_del_lb_static_mapping definition changed -nat44_add_del_static_mapping definition changed -nat44_del_session definition changed -nat44_lb_static_mapping_details definition changed -nat44_static_mapping_details definition changed -nat44_user_session_details definition changed -pipe_create definition changed -pipe_delete definition changed -pipe_details only in image -pipe_dump only in image -pot_profile_activate definition changed -pot_profile_add definition changed -pot_profile_del definition changed -proxy_arp_add_del definition changed -proxy_arp_details only in image -proxy_arp_dump only in image -proxy_arp_intfc_details only in image -proxy_arp_intfc_dump only in image -sock_init_shm_reply definition changed -sockclnt_create definition changed -sockclnt_create_reply definition changed -sr_localsid_add_del definition changed -sr_localsids_details definition changed -sr_policies_details only in image -sr_policies_dump only in image -sr_policy_add definition changed -sr_policy_del definition changed -sr_policy_mod definition changed -sr_steering_pol_details only in image -sr_steering_pol_dump only in image -sw_interface_details definition changed -sw_interface_set_mtu definition changed -tap_create_v2 definition changed -vnet_bier_neighbor_counters only in image -vnet_get_summary_stats_reply definition changed -vxlan_offload_rx definition changed -want_bier_neighbor_stats definition changed -want_dhcp6_pd_reply_events definition changed -want_dhcp6_reply_events definition changed -Found 107 api message signature differences - -### Patches that changed API definitions - -| @c src/plugins/ioam/lib-pot/pot.api || -| ------- | ------- | -| [e9fcf23](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e9fcf23) | Fix some build warnings about "Old Style VLA" | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [25b0494](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=25b0494) | GBP V2 | - -| @c src/plugins/map/map.api || -| ------- | ------- | -| [381e9a9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=381e9a9) | MAP: Move MAP-E/T to a plugin. | - -| @c src/plugins/igmp/igmp.api || -| ------- | ------- | -| [947ea62](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=947ea62) | IGMP improvements | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [d92a0b5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d92a0b5) | Rework kube-proxy into LB plugin | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [70a26ac](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=70a26ac) | NAT44: nat44_del_session and nat44_user_session_details API update (VPP-1271) | -| [ebdf190](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ebdf190) | NAT44: TCP connection close detection (VPP-1266) | -| [1e5c07d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=1e5c07d) | Add special Twice-NAT feature (VPP-1221) | -| [16aa7f8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=16aa7f8) | DSLite: Implement new API call DSLITE_ADDRESS_DUMP. | - -| @c src/plugins/avf/avf.api || -| ------- | ------- | -| [258a189](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=258a189) | avf: api fix | -| [6c9b964](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6c9b964) | avf: binary API and configurable RX/TX queue size | - -| @c src/plugins/mactime/mactime.api || -| ------- | ------- | -| [7055e26](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7055e26) | Driver level time-based src mac filter | - -| @c src/plugins/abf/abf.api || -| ------- | ------- | -| [669d07d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=669d07d) | ACL based forwarding | - -| @c src/vlibmemory/memclnt.api || -| ------- | ------- | -| [dab732a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dab732a) | VPP-1335 vapi crash when memclnt_keepalive received | -| [7895872](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7895872) | Remove the historical memfd api segment bootstrap | - -| @c src/vpp/stats/stats.api || -| ------- | ------- | -| [a21a367](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a21a367) | VPP-1324 SIGSEGV vl_msg_api_handler_with_vm_node() | -| [586479a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=586479a) | BIER neighbor stats | -| [e906aac](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e906aac) | STATS: Separate socket for fd exchange. | -| [048a4e5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=048a4e5) | export counters in a memfd segment | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [d723161](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d723161) | MTU: Software interface / Per-protocol MTU support | -| [fe7d4a2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=fe7d4a2) | Revert "MTU: Setting of MTU on software interface (instead of hardware interface)" | -| [70083ee](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=70083ee) | MTU: Setting of MTU on software interface (instead of hardware interface) | - -| @c src/vnet/ipfix-export/ipfix_export.api || -| ------- | ------- | -| [a9855ef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a9855ef) | Flow: Rename IPFIX exporter. | - -| @c src/vnet/dhcp/dhcp6_pd_client_cp.api || -| ------- | ------- | -| [81119e8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=81119e8) | Implement DHCPv6 PD client (VPP-718, VPP-1050) | - -| @c src/vnet/dhcp/dhcp.api || -| ------- | ------- | -| [dd3b8f7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dd3b8f7) | Implement DHCPv6 IA NA client (VPP-1094) | -| [d9778c2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d9778c2) | Update DHCPv6 DUID code and fix coverity warnings | -| [81119e8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=81119e8) | Implement DHCPv6 PD client (VPP-718, VPP-1050) | -| [daff178](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=daff178) | DHCP Client Dump | - -| @c src/vnet/dhcp/dhcp6_ia_na_client_cp.api || -| ------- | ------- | -| [dd3b8f7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=dd3b8f7) | Implement DHCPv6 IA NA client (VPP-1094) | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [947ea62](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=947ea62) | IGMP improvements | -| [7eaaf74](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7eaaf74) | proxy_arp: remove unused is_add | -| [0053de6](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0053de6) | ARP proxy dumps | -| [9e2f915](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9e2f915) | IP unnumbered dump | -| [7f358b3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7f358b3) | Periodic scan and probe of IP neighbors to maintain neighbor pools | -| [e821ab1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e821ab1) | IP mcast: allow unicast address as a next-hop | -| [c7b4304](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c7b4304) | Implement ip_probe_neighbor API | - -| @c src/vnet/ip/ip_types.api || -| ------- | ------- | -| [947ea62](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=947ea62) | IGMP improvements | -| [2c2feab](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2c2feab) | VPPAPIGEN: Add union and enum support and IP4/IP6 address type. | - -| @c src/vnet/devices/af_packet/af_packet.api || -| ------- | ------- | -| [04e0bb2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=04e0bb2) | af_packet: Add support for dump interfaces | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [d600ffe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d600ffe) | Update tapv2 documentation | -| [0b06111](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0b06111) | VPP-1305: Add support for tags | - -| @c src/vnet/devices/pipe/pipe.api || -| ------- | ------- | -| [ee8b973](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ee8b973) | VOM: support for pipes | -| [17ff3c1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=17ff3c1) | Pipes | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [d57f636](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=d57f636) | VPP-1277: IPIP - Copy TOS/TC from inner packet to outer. | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [7fb0fe1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7fb0fe1) | udp/session: refactor to support dgram mode | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [4b089f2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4b089f2) | ipsec: support UDP encap/decap for NAT traversal | -| [e9fcf23](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e9fcf23) | Fix some build warnings about "Old Style VLA" | -| [8e1039a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8e1039a) | Allow an IPsec tunnel interface to be renumbered | - -| @c src/vnet/vxlan/vxlan.api || -| ------- | ------- | -| [af86a48](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=af86a48) | vxlan:offload RX flow | - -| @c src/vnet/srv6/sr.api || -| ------- | ------- | -| [3337bd2](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3337bd2) | Fixed bugs in SRv6 API | -| [e9fcf23](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e9fcf23) | Fix some build warnings about "Old Style VLA" | - - - -@page release_notes_1804 Release notes for VPP 18.04 - -More than 570 commits since the 18.01 release. - -## Features - -### Infrastructure -- DPDK 18.02.1 -- ARM aarch64 integrated into CI - -### VNET & Plugins -- ERSPAN -- L3DSR load balancing support -- VPC bonding / LACP -- IPv4/IPv6 packet reassembly -- IPv6 link-local support -- Asymmetrical static NAT -- 464XLAT for NAT44 -- MAP-T CE support -- Intel Adaptive Virtual Function native device driver plugin -- Marvell device plugin -- SRv6 static, dynamic and masquerading proxy plugins -- MPLS Uniform mode -- IGMP plugin -- IPIP tunnel support (IPv4/IPv6 over IPv4/IPv6) -- IPv6 Router Discovery mechanism - -### VLIB -- ARM-optimized library variations for key functions -- Better handling of physmem on non-NUMA kernels - -### Host stack -- TLS support via OpenSSL or mbedtls software engines -- Session layer can utilize both shm and memfd (secure) FIFO segments -- STCP -- VCL logging / tracing - -### API framework -- New API definition compiler (vppapigen) -- Memory (shm) and socket APIs refactored -- API handlers refactored to make them transport (shared memory or socket) - agnostic -- Improved support for bootstrapping of the shm API with memfd segments - over the socket API - -### Packaging -- SELinux for RPM builds -- Debuginfo RPMs -- ARM aarch64 for Ubuntu - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1804) - -## API changes - -Description of results: - -* _Definition changed_: indicates that the API file was modified between releases. -* _Only in image_: indicates the API is new for this release. -* _Only in file_: indicates the API has been removed in this release. - -Message Name | Results ------------------------------------------------------------- | ---------------- -accept_session | definition changed -accept_session_reply | definition changed -acl_add_replace | definition changed -acl_add_replace_reply | definition changed -acl_del | definition changed -acl_del_reply | definition changed -acl_details | definition changed -acl_dump | definition changed -acl_interface_add_del | definition changed -acl_interface_add_del_reply | definition changed -acl_interface_etype_whitelist_details | only in image -acl_interface_etype_whitelist_dump | only in image -acl_interface_list_details | definition changed -acl_interface_list_dump | definition changed -acl_interface_set_acl_list | definition changed -acl_interface_set_acl_list_reply | definition changed -acl_interface_set_etype_whitelist | definition changed -acl_plugin_control_ping | definition changed -acl_plugin_control_ping_reply | definition changed -acl_plugin_get_version | definition changed -acl_plugin_get_version_reply | definition changed -add_node_next | definition changed -add_node_next_reply | definition changed -af_packet_create | definition changed -af_packet_create_reply | definition changed -af_packet_delete | definition changed -af_packet_delete_reply | definition changed -af_packet_set_l4_cksum_offload | definition changed -af_packet_set_l4_cksum_offload_reply | definition changed -api_versions | definition changed -api_versions_reply | definition changed -app_namespace_add_del | definition changed -app_namespace_add_del_reply | definition changed -application_attach | definition changed -application_attach_reply | definition changed -application_detach | definition changed -application_detach_reply | definition changed -application_tls_cert_add | definition changed -application_tls_key_add | definition changed -bd_ip_mac_add_del | definition changed -bd_ip_mac_add_del_reply | definition changed -bfd_auth_del_key | definition changed -bfd_auth_del_key_reply | definition changed -bfd_auth_keys_details | definition changed -bfd_auth_keys_dump | definition changed -bfd_auth_set_key | definition changed -bfd_auth_set_key_reply | definition changed -bfd_udp_add | definition changed -bfd_udp_add_reply | definition changed -bfd_udp_auth_activate | definition changed -bfd_udp_auth_activate_reply | definition changed -bfd_udp_auth_deactivate | definition changed -bfd_udp_auth_deactivate_reply | definition changed -bfd_udp_del | definition changed -bfd_udp_del_echo_source | definition changed -bfd_udp_del_echo_source_reply | definition changed -bfd_udp_del_reply | definition changed -bfd_udp_mod | definition changed -bfd_udp_mod_reply | definition changed -bfd_udp_session_details | definition changed -bfd_udp_session_dump | definition changed -bfd_udp_session_set_flags | definition changed -bfd_udp_session_set_flags_reply | definition changed -bfd_udp_set_echo_source | definition changed -bfd_udp_set_echo_source_reply | definition changed -bier_disp_entry_add_del | definition changed -bier_disp_entry_add_del_reply | definition changed -bier_disp_entry_details | definition changed -bier_disp_entry_dump | definition changed -bier_disp_table_add_del | definition changed -bier_disp_table_add_del_reply | definition changed -bier_disp_table_details | definition changed -bier_disp_table_dump | definition changed -bier_imp_add | definition changed -bier_imp_add_reply | definition changed -bier_imp_del | definition changed -bier_imp_del_reply | definition changed -bier_imp_details | definition changed -bier_imp_dump | definition changed -bier_route_add_del | definition changed -bier_route_add_del_reply | definition changed -bier_route_details | definition changed -bier_route_dump | definition changed -bier_table_add_del | definition changed -bier_table_add_del_reply | definition changed -bier_table_details | definition changed -bier_table_dump | definition changed -bind_sock | definition changed -bind_sock_reply | definition changed -bind_uri | definition changed -bind_uri_reply | definition changed -bond_create | definition changed -bond_delete | definition changed -bond_detach_slave | definition changed -bond_enslave | definition changed -bridge_domain_add_del | definition changed -bridge_domain_add_del_reply | definition changed -bridge_domain_details | definition changed -bridge_domain_dump | definition changed -bridge_domain_set_mac_age | definition changed -bridge_domain_set_mac_age_reply | definition changed -bridge_flags | definition changed -bridge_flags_reply | definition changed -cdp_enable | definition changed -classify_add_del_session | definition changed -classify_add_del_session_reply | definition changed -classify_add_del_table | definition changed -classify_add_del_table_reply | definition changed -classify_session_details | definition changed -classify_session_dump | definition changed -classify_set_interface_ip_table | definition changed -classify_set_interface_ip_table_reply | definition changed -classify_set_interface_l2_tables | definition changed -classify_set_interface_l2_tables_reply | definition changed -classify_table_by_interface | definition changed -classify_table_by_interface_reply | definition changed -classify_table_ids | definition changed -classify_table_ids_reply | definition changed -classify_table_info | definition changed -classify_table_info_reply | definition changed -cli | definition changed -cli_inband | definition changed -cli_inband_reply | definition changed -cli_reply | definition changed -collect_detailed_interface_stats | definition changed -connect_session | definition changed -connect_session_reply | definition changed -connect_sock | definition changed -connect_sock_reply | definition changed -connect_uri | definition changed -connect_uri_reply | definition changed -control_ping | definition changed -control_ping_reply | definition changed -cop_interface_enable_disable | definition changed -cop_interface_enable_disable_reply | definition changed -cop_whitelist_enable_disable | definition changed -cop_whitelist_enable_disable_reply | definition changed -create_loopback | definition changed -create_loopback_instance | definition changed -create_loopback_instance_reply | definition changed -create_loopback_reply | definition changed -create_subif | definition changed -create_subif_reply | definition changed -create_vhost_user_if | definition changed -create_vhost_user_if_reply | definition changed -create_vlan_subif | definition changed -create_vlan_subif_reply | definition changed -delete_loopback | definition changed -delete_loopback_reply | definition changed -delete_subif | definition changed -delete_subif_reply | definition changed -delete_vhost_user_if | definition changed -delete_vhost_user_if_reply | definition changed -dhcp_client_config | definition changed -dhcp_client_config_reply | definition changed -dhcp_compl_event | definition changed -dhcp_proxy_config | definition changed -dhcp_proxy_config_reply | definition changed -dhcp_proxy_details | definition changed -dhcp_proxy_dump | definition changed -dhcp_proxy_set_vss | definition changed -dhcp_proxy_set_vss_reply | definition changed -disconnect_session | definition changed -disconnect_session_reply | definition changed -dns_enable_disable | definition changed -dns_enable_disable_reply | definition changed -dns_name_server_add_del | definition changed -dns_name_server_add_del_reply | definition changed -dns_resolve_ip | definition changed -dns_resolve_ip_reply | definition changed -dns_resolve_name | definition changed -dns_resolve_name_reply | definition changed -dslite_add_del_pool_addr_range | definition changed -dslite_add_del_pool_addr_range_reply | definition changed -dslite_get_aftr_addr | definition changed -dslite_get_b4_addr | definition changed -dslite_set_aftr_addr | definition changed -dslite_set_aftr_addr_reply | definition changed -dslite_set_b4_addr | definition changed -feature_enable_disable | definition changed -feature_enable_disable_reply | definition changed -flow_classify_details | definition changed -flow_classify_dump | definition changed -flow_classify_set_interface | definition changed -flow_classify_set_interface_reply | definition changed -flowprobe_params | definition changed -flowprobe_params_reply | definition changed -flowprobe_tx_interface_add_del | definition changed -flowprobe_tx_interface_add_del_reply | definition changed -gbp_contract_add_del | definition changed -gbp_contract_details | only in image -gbp_contract_dump | only in image -gbp_endpoint_add_del | definition changed -gbp_endpoint_details | only in image -gbp_endpoint_dump | only in image -geneve_add_del_tunnel | definition changed -geneve_add_del_tunnel_reply | definition changed -geneve_tunnel_details | definition changed -geneve_tunnel_dump | definition changed -get_first_msg_id | definition changed -get_first_msg_id_reply | definition changed -get_next_index | definition changed -get_next_index_reply | definition changed -get_node_graph | definition changed -get_node_graph_reply | definition changed -get_node_index | definition changed -get_node_index_reply | definition changed -gpe_add_del_fwd_entry | definition changed -gpe_add_del_fwd_entry_reply | definition changed -gpe_add_del_iface | definition changed -gpe_add_del_iface_reply | definition changed -gpe_add_del_native_fwd_rpath | definition changed -gpe_add_del_native_fwd_rpath_reply | definition changed -gpe_enable_disable | definition changed -gpe_enable_disable_reply | definition changed -gpe_fwd_entries_get | definition changed -gpe_fwd_entries_get_reply | definition changed -gpe_fwd_entry_path_details | definition changed -gpe_fwd_entry_path_dump | definition changed -gpe_fwd_entry_vnis_get | definition changed -gpe_fwd_entry_vnis_get_reply | definition changed -gpe_get_encap_mode | definition changed -gpe_get_encap_mode_reply | definition changed -gpe_native_fwd_rpaths_get | definition changed -gpe_native_fwd_rpaths_get_reply | definition changed -gpe_set_encap_mode | definition changed -gpe_set_encap_mode_reply | definition changed -gre_add_del_tunnel | definition changed -gre_add_del_tunnel_reply | definition changed -gre_tunnel_details | definition changed -gre_tunnel_dump | definition changed -gtpu_add_del_tunnel | definition changed -gtpu_add_del_tunnel_reply | definition changed -gtpu_tunnel_details | definition changed -gtpu_tunnel_dump | definition changed -igmp_clear_interface | definition changed -igmp_details | only in image -igmp_dump | only in image -igmp_enable_disable | definition changed -igmp_event | only in image -igmp_listen | definition changed -ikev2_initiate_del_child_sa | definition changed -ikev2_initiate_del_child_sa_reply | definition changed -ikev2_initiate_del_ike_sa | definition changed -ikev2_initiate_del_ike_sa_reply | definition changed -ikev2_initiate_rekey_child_sa | definition changed -ikev2_initiate_rekey_child_sa_reply | definition changed -ikev2_initiate_sa_init | definition changed -ikev2_initiate_sa_init_reply | definition changed -ikev2_profile_add_del | definition changed -ikev2_profile_add_del_reply | definition changed -ikev2_profile_set_auth | definition changed -ikev2_profile_set_auth_reply | definition changed -ikev2_profile_set_id | definition changed -ikev2_profile_set_id_reply | definition changed -ikev2_profile_set_ts | definition changed -ikev2_profile_set_ts_reply | definition changed -ikev2_set_esp_transforms | definition changed -ikev2_set_esp_transforms_reply | definition changed -ikev2_set_ike_transforms | definition changed -ikev2_set_ike_transforms_reply | definition changed -ikev2_set_local_key | definition changed -ikev2_set_local_key_reply | definition changed -ikev2_set_responder | definition changed -ikev2_set_responder_reply | definition changed -ikev2_set_sa_lifetime | definition changed -ikev2_set_sa_lifetime_reply | definition changed -input_acl_set_interface | definition changed -input_acl_set_interface_reply | definition changed -interface_name_renumber | definition changed -interface_name_renumber_reply | definition changed -ioam_cache_ip6_enable_disable | definition changed -ioam_cache_ip6_enable_disable_reply | definition changed -ioam_disable | definition changed -ioam_disable_reply | definition changed -ioam_enable | definition changed -ioam_enable_reply | definition changed -ioam_export_ip6_enable_disable | definition changed -ioam_export_ip6_enable_disable_reply | definition changed -ip4_arp_event | definition changed -ip6_fib_details | definition changed -ip6_fib_dump | definition changed -ip6_mfib_details | definition changed -ip6_mfib_dump | definition changed -ip6_nd_address_autoconfig | definition changed -ip6_nd_event | definition changed -ip6_ra_event | only in image -ip6nd_proxy_add_del | definition changed -ip6nd_proxy_add_del_reply | definition changed -ip6nd_proxy_details | definition changed -ip6nd_proxy_dump | definition changed -ip6nd_send_router_solicitation | definition changed -ip_add_del_route | definition changed -ip_add_del_route_reply | definition changed -ip_address_details | definition changed -ip_address_dump | definition changed -ip_container_proxy_add_del | definition changed -ip_container_proxy_add_del_reply | definition changed -ip_details | definition changed -ip_dump | definition changed -ip_fib_details | definition changed -ip_fib_dump | definition changed -ip_mfib_details | definition changed -ip_mfib_dump | definition changed -ip_mroute_add_del | definition changed -ip_mroute_add_del_reply | definition changed -ip_neighbor_add_del | definition changed -ip_neighbor_add_del_reply | definition changed -ip_neighbor_details | definition changed -ip_neighbor_dump | definition changed -ip_punt_police | definition changed -ip_punt_police_reply | definition changed -ip_punt_redirect | definition changed -ip_punt_redirect_reply | definition changed -ip_reassembly_enable_disable | definition changed -ip_reassembly_get | definition changed -ip_reassembly_set | definition changed -ip_source_and_port_range_check_add_del | definition changed -ip_source_and_port_range_check_add_del_reply | definition changed -ip_source_and_port_range_check_interface_add_del | definition changed -ip_source_and_port_range_check_interface_add_del_reply | definition changed -ip_table_add_del | definition changed -ip_table_add_del_reply | definition changed -ipfix_classify_stream_details | definition changed -ipfix_classify_stream_dump | definition changed -ipfix_classify_table_add_del | definition changed -ipfix_classify_table_add_del_reply | definition changed -ipfix_classify_table_details | definition changed -ipfix_classify_table_dump | definition changed -ipfix_exporter_details | definition changed -ipfix_exporter_dump | definition changed -ipip_6rd_add_tunnel | definition changed -ipip_6rd_del_tunnel | definition changed -ipip_add_tunnel | definition changed -ipip_del_tunnel | definition changed -ipip_tunnel_details | only in image -ipip_tunnel_dump | only in image -ipsec_gre_add_del_tunnel | definition changed -ipsec_gre_add_del_tunnel_reply | definition changed -ipsec_gre_tunnel_details | definition changed -ipsec_gre_tunnel_dump | definition changed -ipsec_interface_add_del_spd | definition changed -ipsec_interface_add_del_spd_reply | definition changed -ipsec_sa_details | definition changed -ipsec_sa_dump | definition changed -ipsec_sa_set_key | definition changed -ipsec_sa_set_key_reply | definition changed -ipsec_sad_add_del_entry | definition changed -ipsec_sad_add_del_entry_reply | definition changed -ipsec_spd_add_del | definition changed -ipsec_spd_add_del_entry | definition changed -ipsec_spd_add_del_entry_reply | definition changed -ipsec_spd_add_del_reply | definition changed -ipsec_spd_details | definition changed -ipsec_spd_dump | definition changed -ipsec_tunnel_if_add_del | definition changed -ipsec_tunnel_if_add_del_reply | definition changed -ipsec_tunnel_if_set_key | definition changed -ipsec_tunnel_if_set_key_reply | definition changed -ipsec_tunnel_if_set_sa | definition changed -ipsec_tunnel_if_set_sa_reply | definition changed -kp_add_del_pod | definition changed -kp_add_del_pod_reply | definition changed -kp_add_del_vip | definition changed -kp_add_del_vip_reply | definition changed -kp_conf | definition changed -kp_conf_reply | definition changed -l2_emulation | definition changed -l2_emulation_reply | definition changed -l2_fib_clear_table | definition changed -l2_fib_clear_table_reply | definition changed -l2_fib_table_details | definition changed -l2_fib_table_dump | definition changed -l2_flags | definition changed -l2_flags_reply | definition changed -l2_interface_efp_filter | definition changed -l2_interface_efp_filter_reply | definition changed -l2_interface_pbb_tag_rewrite | definition changed -l2_interface_pbb_tag_rewrite_reply | definition changed -l2_interface_vlan_tag_rewrite | definition changed -l2_interface_vlan_tag_rewrite_reply | definition changed -l2_macs_event | definition changed -l2_patch_add_del | definition changed -l2_patch_add_del_reply | definition changed -l2_xconnect_details | definition changed -l2_xconnect_dump | definition changed -l2fib_add_del | definition changed -l2fib_add_del_reply | definition changed -l2fib_flush_all | definition changed -l2fib_flush_all_reply | definition changed -l2fib_flush_bd | definition changed -l2fib_flush_bd_reply | definition changed -l2fib_flush_int | definition changed -l2fib_flush_int_reply | definition changed -l2tpv3_create_tunnel | definition changed -l2tpv3_create_tunnel_reply | definition changed -l2tpv3_interface_enable_disable | definition changed -l2tpv3_interface_enable_disable_reply | definition changed -l2tpv3_set_lookup_key | definition changed -l2tpv3_set_lookup_key_reply | definition changed -l2tpv3_set_tunnel_cookies | definition changed -l2tpv3_set_tunnel_cookies_reply | definition changed -lb_add_del_as | definition changed -lb_add_del_as_reply | definition changed -lb_add_del_vip | definition changed -lb_add_del_vip_reply | definition changed -lb_conf | definition changed -lb_conf_reply | definition changed -lisp_add_del_adjacency | definition changed -lisp_add_del_adjacency_reply | definition changed -lisp_add_del_local_eid | definition changed -lisp_add_del_local_eid_reply | definition changed -lisp_add_del_locator | definition changed -lisp_add_del_locator_reply | definition changed -lisp_add_del_locator_set | definition changed -lisp_add_del_locator_set_reply | definition changed -lisp_add_del_map_request_itr_rlocs | definition changed -lisp_add_del_map_request_itr_rlocs_reply | definition changed -lisp_add_del_map_resolver | definition changed -lisp_add_del_map_resolver_reply | definition changed -lisp_add_del_map_server | definition changed -lisp_add_del_map_server_reply | definition changed -lisp_add_del_remote_mapping | definition changed -lisp_add_del_remote_mapping_reply | definition changed -lisp_adjacencies_get | definition changed -lisp_adjacencies_get_reply | definition changed -lisp_eid_table_add_del_map | definition changed -lisp_eid_table_add_del_map_reply | definition changed -lisp_eid_table_details | definition changed -lisp_eid_table_dump | definition changed -lisp_eid_table_map_details | definition changed -lisp_eid_table_map_dump | definition changed -lisp_eid_table_vni_details | definition changed -lisp_eid_table_vni_dump | definition changed -lisp_enable_disable | definition changed -lisp_enable_disable_reply | definition changed -lisp_get_map_request_itr_rlocs | definition changed -lisp_get_map_request_itr_rlocs_reply | definition changed -lisp_locator_details | definition changed -lisp_locator_dump | definition changed -lisp_locator_set_details | definition changed -lisp_locator_set_dump | definition changed -lisp_map_register_enable_disable | definition changed -lisp_map_register_enable_disable_reply | definition changed -lisp_map_request_mode | definition changed -lisp_map_request_mode_reply | definition changed -lisp_map_resolver_details | definition changed -lisp_map_resolver_dump | definition changed -lisp_map_server_details | definition changed -lisp_map_server_dump | definition changed -lisp_pitr_set_locator_set | definition changed -lisp_pitr_set_locator_set_reply | definition changed -lisp_rloc_probe_enable_disable | definition changed -lisp_rloc_probe_enable_disable_reply | definition changed -lisp_use_petr | definition changed -lisp_use_petr_reply | definition changed -lldp_config | definition changed -lldp_config_reply | definition changed -macip_acl_add | definition changed -macip_acl_add_replace | definition changed -macip_acl_add_replace_reply | definition changed -macip_acl_add_reply | definition changed -macip_acl_del | definition changed -macip_acl_del_reply | definition changed -macip_acl_details | definition changed -macip_acl_dump | definition changed -macip_acl_interface_add_del | definition changed -macip_acl_interface_add_del_reply | definition changed -macip_acl_interface_get | definition changed -macip_acl_interface_get_reply | definition changed -macip_acl_interface_list_details | definition changed -macip_acl_interface_list_dump | definition changed -map_add_del_rule | definition changed -map_add_del_rule_reply | definition changed -map_add_domain | definition changed -map_add_domain_reply | definition changed -map_another_segment | definition changed -map_another_segment_reply | definition changed -map_del_domain | definition changed -map_del_domain_reply | definition changed -map_domain_details | definition changed -map_domain_dump | definition changed -map_rule_details | definition changed -map_rule_dump | definition changed -map_summary_stats | definition changed -map_summary_stats_reply | definition changed -memclnt_create | definition changed -memclnt_create_reply | definition changed -memclnt_delete | definition changed -memclnt_delete_reply | definition changed -memclnt_keepalive | definition changed -memclnt_keepalive_reply | definition changed -memclnt_read_timeout | definition changed -memclnt_rx_thread_suspend | definition changed -memfd_segment_create | definition changed -memfd_segment_create_reply | definition changed -memif_create | definition changed -memif_create_reply | definition changed -memif_delete | definition changed -memif_delete_reply | definition changed -memif_details | definition changed -memif_dump | definition changed -memif_socket_filename_add_del | definition changed -memif_socket_filename_details | only in image -memif_socket_filename_dump | only in image -mfib_signal_details | definition changed -mfib_signal_dump | definition changed -modify_vhost_user_if | definition changed -modify_vhost_user_if_reply | definition changed -mpls_fib_details | definition changed -mpls_fib_dump | definition changed -mpls_ip_bind_unbind | definition changed -mpls_ip_bind_unbind_reply | definition changed -mpls_route_add_del | definition changed -mpls_route_add_del_reply | definition changed -mpls_table_add_del | definition changed -mpls_table_add_del_reply | definition changed -mpls_tunnel_add_del | definition changed -mpls_tunnel_add_del_reply | definition changed -mpls_tunnel_details | definition changed -mpls_tunnel_dump | definition changed -nat44_add_del_address_range | definition changed -nat44_add_del_address_range_reply | definition changed -nat44_add_del_identity_mapping | definition changed -nat44_add_del_identity_mapping_reply | definition changed -nat44_add_del_interface_addr | definition changed -nat44_add_del_interface_addr_reply | definition changed -nat44_add_del_lb_static_mapping | definition changed -nat44_add_del_lb_static_mapping_reply | definition changed -nat44_add_del_static_mapping | definition changed -nat44_add_del_static_mapping_reply | definition changed -nat44_address_details | definition changed -nat44_address_dump | definition changed -nat44_del_session | definition changed -nat44_del_session_reply | definition changed -nat44_forwarding_enable_disable | definition changed -nat44_forwarding_enable_disable_reply | definition changed -nat44_forwarding_is_enabled | definition changed -nat44_forwarding_is_enabled_reply | definition changed -nat44_identity_mapping_details | definition changed -nat44_identity_mapping_dump | definition changed -nat44_interface_add_del_feature | definition changed -nat44_interface_add_del_feature_reply | definition changed -nat44_interface_add_del_output_feature | definition changed -nat44_interface_add_del_output_feature_reply | definition changed -nat44_interface_addr_details | definition changed -nat44_interface_addr_dump | definition changed -nat44_interface_details | definition changed -nat44_interface_dump | definition changed -nat44_interface_output_feature_details | definition changed -nat44_interface_output_feature_dump | definition changed -nat44_lb_static_mapping_details | definition changed -nat44_lb_static_mapping_dump | definition changed -nat44_static_mapping_details | definition changed -nat44_static_mapping_dump | definition changed -nat44_user_details | definition changed -nat44_user_dump | definition changed -nat44_user_session_details | definition changed -nat44_user_session_dump | definition changed -nat64_add_del_interface_addr | definition changed -nat64_add_del_interface_addr_reply | definition changed -nat64_add_del_interface | definition changed -nat64_add_del_interface_reply | definition changed -nat64_add_del_pool_addr_range | definition changed -nat64_add_del_pool_addr_range_reply | definition changed -nat64_add_del_prefix | definition changed -nat64_add_del_prefix_reply | definition changed -nat64_add_del_static_bib | definition changed -nat64_add_del_static_bib_reply | definition changed -nat64_bib_details | definition changed -nat64_bib_dump | definition changed -nat64_get_timeouts | definition changed -nat64_get_timeouts_reply | definition changed -nat64_interface_details | definition changed -nat64_interface_dump | definition changed -nat64_pool_addr_details | definition changed -nat64_pool_addr_dump | definition changed -nat64_prefix_details | definition changed -nat64_prefix_dump | definition changed -nat64_set_timeouts | definition changed -nat64_set_timeouts_reply | definition changed -nat64_st_details | definition changed -nat64_st_dump | definition changed -nat66_add_del_interface | definition changed -nat66_add_del_static_mapping | definition changed -nat66_interface_details | only in image -nat66_interface_dump | only in image -nat66_static_mapping_details | only in image -nat66_static_mapping_dump | only in image -nat_control_ping | definition changed -nat_control_ping_reply | definition changed -nat_det_add_del_map | definition changed -nat_det_add_del_map_reply | definition changed -nat_det_close_session_in | definition changed -nat_det_close_session_in_reply | definition changed -nat_det_close_session_out | definition changed -nat_det_close_session_out_reply | definition changed -nat_det_forward | definition changed -nat_det_forward_reply | definition changed -nat_det_get_timeouts | definition changed -nat_det_get_timeouts_reply | definition changed -nat_det_map_details | definition changed -nat_det_map_dump | definition changed -nat_det_reverse | definition changed -nat_det_reverse_reply | definition changed -nat_det_session_details | definition changed -nat_det_session_dump | definition changed -nat_det_set_timeouts | definition changed -nat_det_set_timeouts_reply | definition changed -nat_get_reass | definition changed -nat_get_reass_reply | definition changed -nat_ipfix_enable_disable | definition changed -nat_ipfix_enable_disable_reply | definition changed -nat_reass_details | definition changed -nat_reass_dump | definition changed -nat_set_reass | definition changed -nat_set_reass_reply | definition changed -nat_set_workers | definition changed -nat_set_workers_reply | definition changed -nat_show_config | definition changed -nat_show_config_reply | definition changed -nat_worker_details | definition changed -nat_worker_dump | definition changed -netmap_create | definition changed -netmap_create_reply | definition changed -netmap_delete | definition changed -netmap_delete_reply | definition changed -oam_add_del | definition changed -oam_add_del_reply | definition changed -oam_event | definition changed -one_add_del_adjacency | definition changed -one_add_del_adjacency_reply | definition changed -one_add_del_l2_arp_entry | definition changed -one_add_del_l2_arp_entry_reply | definition changed -one_add_del_local_eid | definition changed -one_add_del_local_eid_reply | definition changed -one_add_del_locator | definition changed -one_add_del_locator_reply | definition changed -one_add_del_locator_set | definition changed -one_add_del_locator_set_reply | definition changed -one_add_del_map_request_itr_rlocs | definition changed -one_add_del_map_request_itr_rlocs_reply | definition changed -one_add_del_map_resolver | definition changed -one_add_del_map_resolver_reply | definition changed -one_add_del_map_server | definition changed -one_add_del_map_server_reply | definition changed -one_add_del_ndp_entry | definition changed -one_add_del_ndp_entry_reply | definition changed -one_add_del_remote_mapping | definition changed -one_add_del_remote_mapping_reply | definition changed -one_adjacencies_get | definition changed -one_adjacencies_get_reply | definition changed -one_eid_table_add_del_map | definition changed -one_eid_table_add_del_map_reply | definition changed -one_eid_table_details | definition changed -one_eid_table_dump | definition changed -one_eid_table_map_details | definition changed -one_eid_table_map_dump | definition changed -one_eid_table_vni_details | definition changed -one_eid_table_vni_dump | definition changed -one_enable_disable | definition changed -one_enable_disable_petr_mode | definition changed -one_enable_disable_petr_mode_reply | definition changed -one_enable_disable_pitr_mode | definition changed -one_enable_disable_pitr_mode_reply | definition changed -one_enable_disable_reply | definition changed -one_enable_disable_xtr_mode | definition changed -one_enable_disable_xtr_mode_reply | definition changed -one_get_map_request_itr_rlocs | definition changed -one_get_map_request_itr_rlocs_reply | definition changed -one_get_transport_protocol | definition changed -one_get_transport_protocol_reply | definition changed -one_l2_arp_bd_get | definition changed -one_l2_arp_bd_get_reply | definition changed -one_l2_arp_entries_get | definition changed -one_l2_arp_entries_get_reply | definition changed -one_locator_details | definition changed -one_locator_dump | definition changed -one_locator_set_details | definition changed -one_locator_set_dump | definition changed -one_map_register_enable_disable | definition changed -one_map_register_enable_disable_reply | definition changed -one_map_register_fallback_threshold | definition changed -one_map_register_fallback_threshold_reply | definition changed -one_map_register_set_ttl | definition changed -one_map_register_set_ttl_reply | definition changed -one_map_request_mode | definition changed -one_map_request_mode_reply | definition changed -one_map_resolver_details | definition changed -one_map_resolver_dump | definition changed -one_map_server_details | definition changed -one_map_server_dump | definition changed -one_ndp_bd_get | definition changed -one_ndp_bd_get_reply | definition changed -one_ndp_entries_get | definition changed -one_ndp_entries_get_reply | definition changed -one_nsh_set_locator_set | definition changed -one_nsh_set_locator_set_reply | definition changed -one_pitr_set_locator_set | definition changed -one_pitr_set_locator_set_reply | definition changed -one_rloc_probe_enable_disable | definition changed -one_rloc_probe_enable_disable_reply | definition changed -one_set_transport_protocol | definition changed -one_set_transport_protocol_reply | definition changed -one_show_petr_mode | definition changed -one_show_petr_mode_reply | definition changed -one_show_pitr_mode | definition changed -one_show_pitr_mode_reply | definition changed -one_show_xtr_mode | definition changed -one_show_xtr_mode_reply | definition changed -one_stats_details | definition changed -one_stats_dump | definition changed -one_stats_enable_disable | definition changed -one_stats_enable_disable_reply | definition changed -one_stats_flush | definition changed -one_stats_flush_reply | definition changed -one_use_petr | definition changed -one_use_petr_reply | definition changed -output_acl_set_interface | definition changed -p2p_ethernet_add | definition changed -p2p_ethernet_add_reply | definition changed -p2p_ethernet_del | definition changed -p2p_ethernet_del_reply | definition changed -pg_capture | definition changed -pg_capture_reply | definition changed -pg_create_interface | definition changed -pg_create_interface_reply | definition changed -pg_enable_disable | definition changed -pg_enable_disable_reply | definition changed -policer_add_del | definition changed -policer_add_del_reply | definition changed -policer_classify_details | definition changed -policer_classify_dump | definition changed -policer_classify_set_interface | definition changed -policer_classify_set_interface_reply | definition changed -policer_details | definition changed -policer_dump | definition changed -pot_profile_activate | definition changed -pot_profile_activate_reply | definition changed -pot_profile_add | definition changed -pot_profile_add_reply | definition changed -pot_profile_del | definition changed -pot_profile_del_reply | definition changed -pot_profile_show_config_details | definition changed -pot_profile_show_config_dump | definition changed -pppoe_add_del_session | definition changed -pppoe_add_del_session_reply | definition changed -pppoe_session_details | definition changed -pppoe_session_dump | definition changed -proxy_arp_add_del | definition changed -proxy_arp_add_del_reply | definition changed -proxy_arp_intfc_enable_disable | definition changed -proxy_arp_intfc_enable_disable_reply | definition changed -punt | definition changed -punt_reply | definition changed -punt_socket_deregister | definition changed -punt_socket_deregister_reply | definition changed -punt_socket_register | definition changed -punt_socket_register_reply | definition changed -qos_egress_map_delete | definition changed -qos_egress_map_update | definition changed -qos_mark_enable_disable | definition changed -qos_record_enable_disable | definition changed -reset_fib | definition changed -reset_fib_reply | definition changed -reset_session | definition changed -reset_session_reply | definition changed -rpc_call | definition changed -rpc_call_reply | definition changed -rx_thread_exit | definition changed -sctp_add_src_dst_connection | definition changed -sctp_config | definition changed -sctp_del_src_dst_connection | definition changed -session_enable_disable | definition changed -session_enable_disable_reply | definition changed -session_rule_add_del | definition changed -session_rule_add_del_reply | definition changed -session_rules_details | definition changed -session_rules_dump | definition changed -set_arp_neighbor_limit | definition changed -set_arp_neighbor_limit_reply | definition changed -set_ip_flow_hash | definition changed -set_ip_flow_hash_reply | definition changed -set_ipfix_classify_stream | definition changed -set_ipfix_classify_stream_reply | definition changed -set_ipfix_exporter | definition changed -set_ipfix_exporter_reply | definition changed -show_lisp_map_register_state | definition changed -show_lisp_map_register_state_reply | definition changed -show_lisp_map_request_mode | definition changed -show_lisp_map_request_mode_reply | definition changed -show_lisp_pitr | definition changed -show_lisp_pitr_reply | definition changed -show_lisp_rloc_probe_state | definition changed -show_lisp_rloc_probe_state_reply | definition changed -show_lisp_status | definition changed -show_lisp_status_reply | definition changed -show_lisp_use_petr | definition changed -show_lisp_use_petr_reply | definition changed -show_one_map_register_fallback_threshold | definition changed -show_one_map_register_fallback_threshold_reply | definition changed -show_one_map_register_state | definition changed -show_one_map_register_state_reply | definition changed -show_one_map_register_ttl | definition changed -show_one_map_register_ttl_reply | definition changed -show_one_map_request_mode | definition changed -show_one_map_request_mode_reply | definition changed -show_one_nsh_mapping | definition changed -show_one_nsh_mapping_reply | definition changed -show_one_pitr | definition changed -show_one_pitr_reply | definition changed -show_one_rloc_probe_state | definition changed -show_one_rloc_probe_state_reply | definition changed -show_one_stats_enable_disable | definition changed -show_one_stats_enable_disable_reply | definition changed -show_one_status | definition changed -show_one_status_reply | definition changed -show_one_use_petr | definition changed -show_one_use_petr_reply | definition changed -show_version | definition changed -show_version_reply | definition changed -sock_init_shm | definition changed -sockclnt_create | definition changed -sockclnt_create_reply | definition changed -sockclnt_delete | definition changed -sockclnt_delete_reply | definition changed -sr_localsid_add_del | definition changed -sr_localsid_add_del_reply | definition changed -sr_localsids_details | definition changed -sr_localsids_dump | definition changed -sr_mpls_policy_add | definition changed -sr_mpls_policy_add_reply | definition changed -sr_mpls_policy_assign_endpoint_color | definition changed -sr_mpls_policy_assign_endpoint_color_reply | definition changed -sr_mpls_policy_del | definition changed -sr_mpls_policy_del_reply | definition changed -sr_mpls_policy_mod | definition changed -sr_mpls_policy_mod_reply | definition changed -sr_mpls_steering_add_del | definition changed -sr_mpls_steering_add_del_reply | definition changed -sr_policy_add | definition changed -sr_policy_add_reply | definition changed -sr_policy_del | definition changed -sr_policy_del_reply | definition changed -sr_policy_mod | definition changed -sr_policy_mod_reply | definition changed -sr_set_encap_source | definition changed -sr_set_encap_source_reply | definition changed -sr_steering_add_del | definition changed -sr_steering_add_del_reply | definition changed -stats_get_poller_delay | definition changed -stn_add_del_rule | definition changed -stn_add_del_rule_reply | definition changed -stn_rule_details | only in file -stn_rules_details | only in image -stn_rules_dump | definition changed -sw_if_l2tpv3_tunnel_details | definition changed -sw_if_l2tpv3_tunnel_dump | definition changed -sw_interface_add_del_address | definition changed -sw_interface_add_del_address_reply | definition changed -sw_interface_bond_details | only in image -sw_interface_bond_dump | only in image -sw_interface_clear_stats | definition changed -sw_interface_clear_stats_reply | definition changed -sw_interface_details | definition changed -sw_interface_dump | definition changed -sw_interface_event | definition changed -sw_interface_get_mac_address | definition changed -sw_interface_get_table | definition changed -sw_interface_get_table_reply | definition changed -sw_interface_ip6_enable_disable | definition changed -sw_interface_ip6_enable_disable_reply | definition changed -sw_interface_ip6_set_link_local_address | definition changed -sw_interface_ip6_set_link_local_address_reply | definition changed -sw_interface_ip6nd_ra_config | definition changed -sw_interface_ip6nd_ra_config_reply | definition changed -sw_interface_ip6nd_ra_prefix | definition changed -sw_interface_ip6nd_ra_prefix_reply | definition changed -sw_interface_lacp_details | only in image -sw_interface_lacp_dump | only in image -sw_interface_set_dpdk_hqos_pipe | definition changed -sw_interface_set_dpdk_hqos_pipe_reply | definition changed -sw_interface_set_dpdk_hqos_subport | definition changed -sw_interface_set_dpdk_hqos_subport_reply | definition changed -sw_interface_set_dpdk_hqos_tctbl | definition changed -sw_interface_set_dpdk_hqos_tctbl_reply | definition changed -sw_interface_set_flags | definition changed -sw_interface_set_flags_reply | definition changed -sw_interface_set_geneve_bypass | definition changed -sw_interface_set_geneve_bypass_reply | definition changed -sw_interface_set_gtpu_bypass | definition changed -sw_interface_set_gtpu_bypass_reply | definition changed -sw_interface_set_l2_bridge | definition changed -sw_interface_set_l2_bridge_reply | definition changed -sw_interface_set_l2_xconnect | definition changed -sw_interface_set_l2_xconnect_reply | definition changed -sw_interface_set_lldp | definition changed -sw_interface_set_lldp_reply | definition changed -sw_interface_set_mac_address | definition changed -sw_interface_set_mac_address_reply | definition changed -sw_interface_set_mpls_enable | definition changed -sw_interface_set_mpls_enable_reply | definition changed -sw_interface_set_mtu | definition changed -sw_interface_set_mtu_reply | definition changed -sw_interface_set_rx_mode | definition changed -sw_interface_set_rx_mode_reply | definition changed -sw_interface_set_table | definition changed -sw_interface_set_table_reply | definition changed -sw_interface_set_unnumbered | definition changed -sw_interface_set_unnumbered_reply | definition changed -sw_interface_set_vpath | definition changed -sw_interface_set_vpath_reply | definition changed -sw_interface_set_vxlan_bypass | definition changed -sw_interface_set_vxlan_bypass_reply | definition changed -sw_interface_set_vxlan_gpe_bypass | definition changed -sw_interface_set_vxlan_gpe_bypass_reply | definition changed -sw_interface_slave_details | only in image -sw_interface_slave_dump | only in image -sw_interface_span_details | definition changed -sw_interface_span_dump | definition changed -sw_interface_span_enable_disable | definition changed -sw_interface_span_enable_disable_reply | definition changed -sw_interface_tag_add_del | definition changed -sw_interface_tag_add_del_reply | definition changed -sw_interface_tap_details | definition changed -sw_interface_tap_dump | definition changed -sw_interface_tap_v2_details | definition changed -sw_interface_tap_v2_dump | definition changed -sw_interface_vhost_user_details | definition changed -sw_interface_vhost_user_dump | definition changed -tap_connect | definition changed -tap_connect_reply | definition changed -tap_create_v2 | definition changed -tap_create_v2_reply | definition changed -tap_delete | definition changed -tap_delete_reply | definition changed -tap_delete_v2 | definition changed -tap_delete_v2_reply | definition changed -tap_modify | definition changed -tap_modify_reply | definition changed -tcp_configure_src_addresses | definition changed -tcp_configure_src_addresses_reply | definition changed -trace_plugin_msg_ids | definition changed -trace_profile_add | definition changed -trace_profile_add_reply | definition changed -trace_profile_del | definition changed -trace_profile_del_reply | definition changed -trace_profile_show_config | definition changed -trace_profile_show_config_reply | definition changed -udp_encap_add_del | definition changed -udp_encap_add_del_reply | definition changed -udp_encap_details | definition changed -udp_encap_dump | definition changed -udp_ping_add_del | definition changed -udp_ping_add_del_reply | only in image -udp_ping_add_del_req | only in file -udp_ping_export | definition changed -udp_ping_export_reply | only in image -udp_ping_export_req | only in file -unbind_sock | definition changed -unbind_sock_reply | definition changed -unbind_uri | definition changed -unbind_uri_reply | definition changed -unmap_segment | definition changed -vnet_get_summary_stats | definition changed -vnet_get_summary_stats_reply | definition changed -vnet_interface_combined_counters | definition changed -vnet_interface_simple_counters | definition changed -vnet_ip4_fib_counters | definition changed -vnet_ip4_mfib_counters | definition changed -vnet_ip4_nbr_counters | definition changed -vnet_ip6_fib_counters | definition changed -vnet_ip6_mfib_counters | definition changed -vnet_ip6_nbr_counters | definition changed -vnet_per_interface_combined_counters | definition changed -vnet_per_interface_simple_counters | definition changed -vnet_udp_encap_counters | only in image -vxlan_add_del_tunnel | definition changed -vxlan_add_del_tunnel_reply | definition changed -vxlan_gpe_add_del_tunnel | definition changed -vxlan_gpe_add_del_tunnel_reply | definition changed -vxlan_gpe_ioam_disable | definition changed -vxlan_gpe_ioam_disable_reply | definition changed -vxlan_gpe_ioam_enable | definition changed -vxlan_gpe_ioam_enable_reply | definition changed -vxlan_gpe_ioam_export_enable_disable | definition changed -vxlan_gpe_ioam_export_enable_disable_reply | definition changed -vxlan_gpe_ioam_transit_disable | definition changed -vxlan_gpe_ioam_transit_disable_reply | definition changed -vxlan_gpe_ioam_transit_enable | definition changed -vxlan_gpe_ioam_transit_enable_reply | definition changed -vxlan_gpe_ioam_vni_disable | definition changed -vxlan_gpe_ioam_vni_disable_reply | definition changed -vxlan_gpe_ioam_vni_enable | definition changed -vxlan_gpe_ioam_vni_enable_reply | definition changed -vxlan_gpe_tunnel_details | definition changed -vxlan_gpe_tunnel_dump | definition changed -vxlan_tunnel_details | definition changed -vxlan_tunnel_dump | definition changed -want_bfd_events | definition changed -want_bfd_events_reply | definition changed -want_igmp_events | definition changed -want_interface_combined_stats | definition changed -want_interface_combined_stats_reply | definition changed -want_interface_events | definition changed -want_interface_events_reply | definition changed -want_interface_simple_stats | definition changed -want_interface_simple_stats_reply | definition changed -want_ip4_arp_events | definition changed -want_ip4_arp_events_reply | definition changed -want_ip4_fib_stats | definition changed -want_ip4_fib_stats_reply | definition changed -want_ip4_mfib_stats | definition changed -want_ip4_mfib_stats_reply | definition changed -want_ip4_nbr_stats | definition changed -want_ip4_nbr_stats_reply | definition changed -want_ip6_fib_stats | definition changed -want_ip6_fib_stats_reply | definition changed -want_ip6_mfib_stats | definition changed -want_ip6_mfib_stats_reply | definition changed -want_ip6_nbr_stats | definition changed -want_ip6_nbr_stats_reply | definition changed -want_ip6_nd_events | definition changed -want_ip6_nd_events_reply | definition changed -want_ip6_ra_events | definition changed -want_l2_macs_events | definition changed -want_l2_macs_events_reply | definition changed -want_oam_events | definition changed -want_oam_events_reply | definition changed -want_per_interface_combined_stats | definition changed -want_per_interface_combined_stats_reply | definition changed -want_per_interface_simple_stats | definition changed -want_per_interface_simple_stats_reply | definition changed -want_stats | definition changed -want_stats_reply | definition changed -want_udp_encap_stats | definition changed - -Found 1036 api message signature differences - -### Patches that changed API definitions - -| @c src/vpp/stats/stats.api || -| ------- | ------- | -| [43b1f44](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=43b1f44) | UDP Encap counters | -| [ff92efe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=ff92efe) | stats: allow configuring poller delay | -| [51e5968](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=51e5968) | API: Add service definitions for events and singleton messages (second attempt) | -| [2de1f15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de1f15) | Revert "API: Add service definitions for events and singleton messages." | -| [f7b7fa5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7b7fa5) | API: Add service definitions for events and singleton messages. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vpp/oam/oam.api || -| ------- | ------- | -| [51e5968](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=51e5968) | API: Add service definitions for events and singleton messages (second attempt) | -| [2de1f15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de1f15) | Revert "API: Add service definitions for events and singleton messages." | -| [f7b7fa5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7b7fa5) | API: Add service definitions for events and singleton messages. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vpp/api/vpe.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/interface.api || -| ------- | ------- | -| [0cae3f7](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=0cae3f7) | Detailed Interface stats API takes sw_if_index | -| [6f4a6be](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=6f4a6be) | Interface Unicast, Multicast and Broadcast stats on the API | -| [c037423](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c037423) | IPv6 ND Router discovery control plane (VPP-1095) | -| [51e5968](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=51e5968) | API: Add service definitions for events and singleton messages (second attempt) | -| [2de1f15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de1f15) | Revert "API: Add service definitions for events and singleton messages." | -| [f7b7fa5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7b7fa5) | API: Add service definitions for events and singleton messages. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/unix/tap.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/qos/qos.api || -| ------- | ------- | -| [039cbfe](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=039cbfe) | QoS recording and marking | - -| @c src/vnet/policer/policer.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/mpls/mpls.api || -| ------- | ------- | -| [31ed744](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=31ed744) | MPLS Unifom mode | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/span/span.api || -| ------- | ------- | -| [179ab36](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=179ab36) | SPAN: Add "is_l2" flag to DETAILS response messages. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/vxlan-gpe/vxlan_gpe.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/l2tp/l2tp.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/lldp/lldp.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/srmpls/sr_mpls.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/cop/cop.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/feature/feature.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/ipsec-gre/ipsec_gre.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/geneve/geneve.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/lisp-gpe/lisp_gpe.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/map/map.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | -| [e31d956](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e31d956) | MAP: Add RFC6052 mapping to MAP-T | - -| @c src/vnet/lisp-cp/lisp.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/lisp-cp/one.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/tcp/tcp.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/dhcp/dhcp.api || -| ------- | ------- | -| [51e5968](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=51e5968) | API: Add service definitions for events and singleton messages (second attempt) | -| [2de1f15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de1f15) | Revert "API: Add service definitions for events and singleton messages." | -| [f7b7fa5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7b7fa5) | API: Add service definitions for events and singleton messages. | -| [54c6dc4](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=54c6dc4) | For DHCP client configuration control the setting of the broadcast flag in the DISCOVER message sent. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/gre/gre.api || -| ------- | ------- | -| [a43ccae](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=a43ccae) | Optimize GRE Tunnel and add support for ERSPAN encap | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/flow/flow.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/devices/virtio/vhost_user.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/devices/af_packet/af_packet.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/devices/tap/tapv2.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | -| [7866c45](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7866c45) | tapv2: add option to set host-side default gw | - -| @c src/vnet/devices/netmap/netmap.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/dns/dns.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/bonding/bond.api || -| ------- | ------- | -| [9cd2d7a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9cd2d7a) | bond: Add bonding driver and LACP protocol | - -| @c src/vnet/session/session.api || -| ------- | ------- | -| [8f89dd0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8f89dd0) | tls: enforce certificate verification | -| [371ca50](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=371ca50) | session: first approximation implementation of tls | -| [f8f516a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f8f516a) | session: support local sessions and deprecate redirects | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/ethernet/p2p_ethernet.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/ip/rd_cp.api || -| ------- | ------- | -| [c037423](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c037423) | IPv6 ND Router discovery control plane (VPP-1095) | - -| @c src/vnet/ip/punt.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/ip/ip.api || -| ------- | ------- | -| [4c53313](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4c53313) | reassembly: feature/concurrency | -| [4b9669d](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=4b9669d) | IPv6 ND Router discovery data plane (VPP-1095) | -| [31ed744](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=31ed744) | MPLS Unifom mode | -| [51e5968](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=51e5968) | API: Add service definitions for events and singleton messages (second attempt) | -| [2de1f15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de1f15) | Revert "API: Add service definitions for events and singleton messages." | -| [f7b7fa5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7b7fa5) | API: Add service definitions for events and singleton messages. | -| [75e7d13](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=75e7d13) | IPv4/6 reassembly | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | -| [f068c3e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f068c3e) | DVR: run L3 output features | - -| @c src/vnet/classify/classify.api || -| ------- | ------- | -| [815d7d5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=815d7d5) | classifier-based ACL: refactor + add output ACL | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/ipip/ipip.api || -| ------- | ------- | -| [298c695](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=298c695) | IPIP: Add IP{v4,v6} over IP{v4,v6} configured tunnel support. | - -| @c src/vnet/udp/udp.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/bfd/bfd.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/srv6/sr.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/ipsec/ipsec.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/bier/bier.api || -| ------- | ------- | -| [31ed744](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=31ed744) | MPLS Unifom mode | -| [f051072](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f051072) | BIER: fix support for longer bit-string lengths | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/sctp/sctp.api || -| ------- | ------- | -| [c7fe4f3](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c7fe4f3) | SCTP: API to configure some tunables | -| [465c087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=465c087) | SCTP: API to delete a sub-connection | -| [3c6a976](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3c6a976) | SCTP: API to add a sub-connection | - -| @c src/vnet/l2/l2.api || -| ------- | ------- | -| [e23c99e](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e23c99e) | Improve l2_macs_events API to provide MAC move information | -| [51e5968](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=51e5968) | API: Add service definitions for events and singleton messages (second attempt) | -| [2de1f15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de1f15) | Revert "API: Add service definitions for events and singleton messages." | -| [f7b7fa5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7b7fa5) | API: Add service definitions for events and singleton messages. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/vxlan/vxlan.api || -| ------- | ------- | -| [31ed744](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=31ed744) | MPLS Unifom mode | -| [3d460bd](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=3d460bd) | VXLAN: Allow user to specify a custom vxlan tunnel instance id. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/fib/fib_types.api || -| ------- | ------- | -| [2303cb1](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2303cb1) | FIB Interpose Source | -| [8145842](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=8145842) | Common form of fib-path reproting in dumps | -| [31ed744](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=31ed744) | MPLS Unifom mode | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/vnet/pg/pg.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/examples/sample-plugin/sample/sample.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/lb/lb.api || -| ------- | ------- | -| [647f609](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=647f609) | Add L3DSR feature in LB plugin | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/gtpu/gtpu.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/kubeproxy/kp.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/pppoe/pppoe.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/nat/nat.api || -| ------- | ------- | -| [f2a23cc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f2a23cc) | NAT66 1:1 mapping (VPP-1108) | -| [9dba781](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9dba781) | NAT44: nat44_static_mapping_details protocol=0 if addr_only=0 (VPP-1158) | -| [bc39e34](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bc39e34) | NAT: add missing CLI and API documentation (VPP-1142) | -| [5f22499](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=5f22499) | NAT44: add opaque string tag to static mapping APIs (VPP-1147) | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | -| [e82488f](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=e82488f) | NAT44: asymmetrical static mapping rule (VPP-1135) | -| [240b5ef](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=240b5ef) | NAT44: asymmetrical load balancing static mapping rule (VPP-1132) | -| [c5c6a33](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c5c6a33) | Add basic support for DS-Lite CE (VPP-1059) | - -| @c src/plugins/l2e/l2e.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/ioam/lib-pot/pot.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/ioam/ip6/ioam_cache.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/ioam/udp-ping/udp_ping.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | -| [149a143](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=149a143) | fix udp_ping api naming error | - -| @c src/plugins/ioam/export/ioam_export.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/ioam/export-vxlan-gpe/vxlan_gpe_ioam_export.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/ioam/lib-vxlan-gpe/ioam_vxlan_gpe.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/ioam/lib-trace/trace.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/igmp/igmp.api || -| ------- | ------- | -| [7b867a8](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=7b867a8) | IGMP plugin | - -| @c src/plugins/memif/memif.api || -| ------- | ------- | -| [30349b0](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=30349b0) | memif: Add new API calls to manage memif socket names. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/lacp/lacp.api || -| ------- | ------- | -| [9cd2d7a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9cd2d7a) | bond: Add bonding driver and LACP protocol | - -| @c src/plugins/acl/acl.api || -| ------- | ------- | -| [27fe75a](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=27fe75a) | acl-plugin: add the support for dumping the ethertype whitelist (VPP-1163) | -| [c43b3f9](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=c43b3f9) | acl-plugin: add whitelisted ethertype mode (VPP-1163) | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/flowprobe/flowprobe.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/dpdk/api/dpdk.api || -| ------- | ------- | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/gbp/gbp.api || -| ------- | ------- | -| [bc27d1b](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=bc27d1b) | GBP plugin | - -| @c src/plugins/stn/stn.api || -| ------- | ------- | -| [62bab65](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=62bab65) | STN: Fix stn_rules_dump/details to follow API convention | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | - -| @c src/plugins/cdp/cdp.api || -| ------- | ------- | -| [aaacfbc](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=aaacfbc) | Move the vnet cdp protocol implementation to a plugin | - -| @c src/vlibmemory/memclnt.api || -| ------- | ------- | -| [51e5968](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=51e5968) | API: Add service definitions for events and singleton messages (second attempt) | -| [2de1f15](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=2de1f15) | Revert "API: Add service definitions for events and singleton messages." | -| [f7b7fa5](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=f7b7fa5) | API: Add service definitions for events and singleton messages. | -| [9d42087](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=9d42087) | VPPAPIGEN: vppapigen replacement in Python PLY. | -| [90a6398](https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=90a6398) | sock api: add infra for bootstrapping shm clients | - - - -@page release_notes_18012 Release notes for VPP 18.01.2 - -This is bug fix release. - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1801) - - -@page release_notes_18011 Release notes for VPP 18.01.1 - -This is bug fix release. - -For the full list of fixed issues please reffer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1801) - - -@page release_notes_1801 Release notes for VPP 18.01 - -More than 560 commits since the 17.10 release. - -## Features -- Infrastructure - - DPDK 17.11 - - TCP Checksum Offload - - Arm64/Arm-v8 support - - SUSE packaging - - bihash_vec8_8 variant - - PCI rework to support VFIO - - chi-squared test calculator - -- SNAT / NAT - - One armed NAT - - Twice NAT44 - - NAT hairpinning rework - - NAT64 multi-thread - - NAT64 IPFIX - - NAT64 Fragmentation - - NAT: DS-Lite - - Remove old SNAT API - - ACL-based NAT - -- VNET - - DNS name resolver - - BIER - - GENEVE Tunnel - - IPSec Openssl 1.1.0 api support - - FIB improvements - - tap v2 - -- API - - VPP stats (Broadcast & Multicast support) - - SR MPLS - - VPP Object Model (VOM) - -- Host Stack - - VPP TCP Stack scale / congestion improvements - - Refactor UDP - - Namespace support - - Session rules table - - VPP Comms Library (VCL) improvements - -- ACL - - ACL stats - -- Plugins - - Kube-proxy - - L2 Emulation - - Memif - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1801) - -## API changes - -Message Name | Result --------------------------------------------------------------|----------------- -af_packet_set_l4_cksum_offload | definition changed -api_versions | definition changed -app_namespace_add_del | definition changed -application_attach | definition changed -bier_disp_entry_add_del | definition changed -bier_disp_entry_details | only in image -bier_disp_entry_dump | only in image -bier_disp_table_add_del | definition changed -bier_disp_table_details | only in image -bier_disp_table_dump | only in image -bier_imp_add | definition changed -bier_imp_del | definition changed -bier_imp_details | only in image -bier_imp_dump | only in image -bier_route_add_del | definition changed -bier_route_details | only in image -bier_route_dump | only in image -bier_table_add_del | definition changed -bier_table_details | only in image -bier_table_dump | only in image -bind_sock_reply | definition changed -connect_session_reply | definition changed -connect_sock | definition changed -connect_uri | definition changed -dhcp_proxy_details | definition changed -dhcp_proxy_set_vss | definition changed -dns_enable_disable | definition changed -dns_name_server_add_del | definition changed -dns_resolve_ip | definition changed -dns_resolve_name | definition changed -dslite_add_del_pool_addr_range | definition changed -dslite_set_aftr_addr | definition changed -geneve_add_del_tunnel | definition changed -geneve_tunnel_details | only in image -geneve_tunnel_dump | only in image -ip_add_del_route | definition changed -ip_container_proxy_add_del | definition changed -ip_mroute_add_del | definition changed -ip_neighbor_details | definition changed -ip_punt_police | definition changed -ip_punt_redirect | definition changed -ipsec_sa_details | only in image -ipsec_sa_dump | only in image -ipsec_sad_add_del_entry | definition changed -ipsec_tunnel_if_set_key | definition changed -ipsec_tunnel_if_set_sa | definition changed -kp_add_del_pod | definition changed -kp_add_del_vip | definition changed -kp_conf | definition changed -l2_emulation | definition changed -l2_fib_table_details | definition changed -l2fib_add_del | definition changed -memclnt_keepalive | definition changed -memfd_segment_create | definition changed -mpls_ip_bind_unbind | definition changed -mpls_route_add_del | definition changed -nat44_add_del_address_range | definition changed -nat44_add_del_identity_mapping | definition changed -nat44_add_del_interface_addr | definition changed -nat44_add_del_lb_static_mapping | definition changed -nat44_add_del_static_mapping | definition changed -nat44_address_details | definition changed -nat44_del_session | definition changed -nat44_forwarding_enable_disable | definition changed -nat44_forwarding_is_enabled | definition changed -nat44_identity_mapping_details | only in image -nat44_identity_mapping_dump | only in image -nat44_interface_addr_details | definition changed -nat44_lb_static_mapping_details | definition changed -nat44_static_mapping_details | definition changed -nat64_add_del_interface_addr | definition changed -nat_get_reass | definition changed -nat_reass_details | only in image -nat_reass_dump | only in image -nat_set_reass | definition changed -reset_vrf | definition changed -session_rule_add_del | definition changed -session_rules_details | only in image -session_rules_dump | only in image -snat_add_address_range | definition changed -snat_add_del_interface_addr | definition changed -snat_add_det_map | definition changed -snat_add_static_mapping | definition changed -snat_address_details | only in file -snat_address_dump | only in file -snat_control_ping | definition changed -snat_det_close_session_in | definition changed -snat_det_close_session_out | definition changed -snat_det_forward | definition changed -snat_det_get_timeouts | definition changed -snat_det_map_details | only in file -snat_det_map_dump | only in file -snat_det_reverse | definition changed -snat_det_session_details | only in file -snat_det_session_dump | only in file -snat_det_set_timeouts | definition changed -snat_interface_add_del_feature | definition changed -snat_interface_add_del_output_feature | definition changed -snat_interface_addr_details | only in file -snat_interface_addr_dump | only in file -snat_interface_details | only in file -snat_interface_dump | only in file -snat_interface_output_feature_details | only in file -snat_interface_output_feature_dump | only in file -snat_ipfix_enable_disable | definition changed -snat_set_workers | definition changed -snat_show_config | definition changed -snat_static_mapping_details | only in file -snat_static_mapping_dump | only in file -snat_user_details | only in file -snat_user_dump | only in file -snat_user_session_details | only in file -snat_user_session_dump | only in file -snat_worker_details | only in file -snat_worker_dump | only in file -sockclnt_create | definition changed -sockclnt_delete | definition changed -sr_localsids_details | only in image -sr_localsids_dump | only in image -sr_mpls_policy_add | definition changed -sr_mpls_policy_assign_endpoint_color | definition changed -sr_mpls_policy_del | definition changed -sr_mpls_policy_mod | definition changed -sr_mpls_steering_add_del | definition changed -sr_set_encap_source | definition changed -stn_add_del_rule | definition changed -stn_rule_details | only in image -stn_rules_dump | only in image -sw_interface_set_geneve_bypass | definition changed -sw_interface_set_lldp | definition changed -sw_interface_set_rx_mode | definition changed -sw_interface_tap_v2_details | only in image -sw_interface_tap_v2_dump | only in image -tap_create_v2 | definition changed -tap_delete_v2 | definition changed -udp_encap_add_del | definition changed -udp_encap_details | only in image -udp_encap_dump | only in image -vnet_ip4_mfib_counters | only in image -vnet_ip6_mfib_counters | only in image -want_ip4_mfib_stats | definition changed -want_ip6_mfib_stats | definition changed - -Found 142 api message signature differences - -### Patches that changed API definitions - -./src/examples/sample-plugin/sample/sample.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/interface.api -b8d4481a Break up vpe.api -ad8015be devices: Add binary API for set interface rx-mode -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/feature/feature.api -b8d4481a Break up vpe.api - -./src/vnet/srv6/sr.api -1a5e301f SRv6 improvements to binary API -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/bier/bier.api -be302d72 BIER coverity fix in route downlaod -ceb4d05b BIER disposition default route -fa1da15c BIER: API documentation fixes. -9128637e BIER in non-MPLS netowrks -d792d9c0 BIER - -./src/vnet/vxlan-gpe/vxlan_gpe.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/unix/tap.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/lldp/lldp.api -9a6fcef4 LLDP: Add Management Address TLV -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/dns/dns.api -d2080159 Add reverse DNS (ip to name) resolution -6545716c VPP-1027: DNS name resolver - -./src/vnet/session/session.api -dcf55ce2 vppcom: improve listener session handling -6e8c6679 session: add app ns index to ns create api -c97a7398 session: add rule tags -6c36f53f session: add api to dump rules -1c710451 session: rules tables -ade70e45 session: return local transport endpoint in connect reply -cea194d8 session: add support for application namespacing -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/devices/af_packet/af_packet.api -92b0275a af_packet: invalid TCP/UDP offload checksum on RX node recalculation -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/devices/netmap/netmap.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/devices/tap/tapv2.api -73e7f427 tap_v2: include host-side parameters in the dump binary API -2df39094 tapv2: multiple improvements -c99b4cd1 tap_v2: move code to vnet/devices/tap - -./src/vnet/devices/virtio/vhost_user.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/lisp-gpe/lisp_gpe.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/srmpls/sr_mpls.api -42998828 SR-MPLS: binary API and automated steering - -./src/vnet/l2/l2.api -b8d4481a Break up vpe.api -57938f63 l2fib: MAC: Fix uint64 to u8 byte array -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/udp/udp.api -810086d8 UDP Encapsulation. - -./src/vnet/policer/policer.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/bfd/bfd.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/geneve/geneve.api -556033a0 Add API versioning to GENEVE tunnel implementation. -b598f1d3 Initial GENEVE TUNNEL implementation and tests. - -./src/vnet/gre/gre.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/map/map.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/flow/flow.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/pg/pg.api -b8d4481a Break up vpe.api - -./src/vnet/dhcp/dhcp.api -70bfcaf4 Add Support of DHCP VSS Type 0 where VPN-ID is ASCII -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/ipsec/ipsec.api -ca514fda Allow IPsec interface to have SAs reset -75d85609 Add API call to set keys on IPsec tunnel intf -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps -28029530 Add API support to dump IPsec SAs - -./src/vnet/mpls/mpls.api -c42fc05b Remove the unused 'create VRF if needed' API parameters -b8d4481a Break up vpe.api -d792d9c0 BIER -d0a59722 Revert "Enforce FIB table creation before use" -f9342023 Enforce FIB table creation before use -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/ethernet/p2p_ethernet.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/span/span.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/lisp-cp/lisp.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/lisp-cp/one.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/vxlan/vxlan.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/ipsec-gre/ipsec_gre.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/classify/classify.api -b8d4481a Break up vpe.api -8527f12b add classify session action set-sr-policy-index -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/ip/punt.api -b8d4481a Break up vpe.api - -./src/vnet/ip/ip.api -c42fc05b Remove the unused 'create VRF if needed' API parameters -b8d4481a Break up vpe.api -af8dfbf6 Add sw_if_index to the ip_neighbor_details_t response. -d792d9c0 BIER -810086d8 UDP Encapsulation. -595992c5 ip: add container proxy api -0164a06d Remove unused 'not_last' parameter from ip_add_del_route -d0a59722 Revert "Enforce FIB table creation before use" -054c03ac Source Lookup progammable via API -f9342023 Enforce FIB table creation before use -d91c1dbd punt and drop features: - new IPv4 and IPv6 feature arcs on the punt and drop nodes - new features: - redirect punted traffic to an interface and nexthop - police punted traffic. -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps -6f631156 Distributed Virtual Router Support - -./src/vnet/cop/cop.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vnet/l2tp/l2tp.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vpp/oam/oam.api -b8d4481a Break up vpe.api - -./src/vpp/stats/stats.api -ff233898 Stats for Multicast FIB -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/vpp/api/vpe.api -b8d4481a Break up vpe.api -d792d9c0 BIER -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps -b598f1d3 Initial GENEVE TUNNEL implementation and tests. - -./src/plugins/ioam/udp-ping/udp_ping.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/ioam/ip6/ioam_cache.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/ioam/lib-pot/pot.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/ioam/lib-trace/trace.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/ioam/export/ioam_export.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/ioam/export-vxlan-gpe/vxlan_gpe_ioam_export.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/ioam/lib-vxlan-gpe/ioam_vxlan_gpe.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/pppoe/pppoe.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/dpdk/api/dpdk.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/acl/acl.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/gtpu/gtpu.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/l2e/l2e.api -4ec38711 L2 emulation: remove usued ip-table-id from API -55d03788 L2 Emulation - -./src/plugins/flowprobe/flowprobe.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/nat/nat.api -7b929793 Translate matching packets using NAT (VPP-1069) -b932d26e NAT: Twice NAT44 (VPP-969) -ab7a805f NAT44: identity NAT (VPP-1073) -c6fb36fc NAT: Remove old SNAT API (VPP-1070) -0938dcf1 NAT64 to use IPv4 address from interface (VPP-1051) -efcd1e9e SNAT: IP fragmentation (VPP-890) -8ebe6253 NAT: DS-Lite (VPP-1040) -5ba86f72 NAT: delete session API/CLI (VPP-1041) -36ea2d6d One armed NAT (VPP-1035) -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/memif/memif.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/kubeproxy/kp.api -c91f5024 Support kube-proxy data plane - -./src/plugins/lb/lb.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps - -./src/plugins/stn/stn.api -0906c5cf Plugin for IP-Address to Interface Punting - -./src/vlibmemory/memclnt.api -0d056e5e vppapigen: support per-file (major,minor,patch) version stamps -59b2565c Repair vlib API socket server - - -@page release_notes_1710 Release notes for VPP 17.10 - -More than 400 commits since the 1707 release. - -## Features -- Infrastructure - - DPDK 17.08 - - IP reassembly - - Bounded-index extensible hash bucket-level LRU cache - - Templated timer wheel improvements - -- API - - C/C++ language binding - - API stats - -- Host stack - - VPP TCP stack scale/congestion improvements - - VPP Comms Library (VCL) - - Overall performance, scale and hardening - -- Network features - - IPSec rework - utilize new FIB - - VPLS and VPWS implementation - - - NAT - - Renamed SNAT to NAT - - Performance / Scale - - Destination NAT44 with load-balancing - - In2out translation as an output feature on the outside interface - - Fullback to 3-tuple key for non TCP/UDP/ICMP sessions - - - Security Groups/ACLs - - "Replace" semantics for adding a new MacIP acl - - Test suite tests for MacIP ACLs - - - ONE-LISP - - Map-server fallback support - - Preemptive re-fetch of active mappings that are about to expire - - ND termination - - - PPPoE - - PPPoE Control Plane packet dispatch - - PPPoE decapsulation - - PPPoE encapsulation - -## Known issues - -For the full list of issues please refer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please refer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1710) - -## API changes - -Message Name | Result --------------------------------------------------------------|---------------- -bridge_domain_add_del | definition changed -bridge_domain_details | definition changed -connect_session | definition changed -connect_sock | definition changed -connect_sock_reply | definition changed -connect_uri_reply | definition changed -create_vhost_user_if | definition changed -dhcp_client_config | definition changed -ip4_arp_event | definition changed -ip6_fib_details | definition changed -ip6_nd_event | definition changed -ip_add_del_route | definition changed -ip_fib_details | definition changed -ip_table_add_del | definition changed -l2_macs_event | only in image -macip_acl_add_replace | definition changed -macip_acl_interface_list_details | only in image -macip_acl_interface_list_dump | only in image -modify_vhost_user_if | definition changed -mpls_fib_details | definition changed -mpls_route_add_del | definition changed -mpls_table_add_del | definition changed -mpls_tunnel_add_del | definition changed -nat44_add_del_address_range | definition changed -nat44_add_del_interface_addr | definition changed -nat44_add_del_lb_static_mapping | definition changed -nat44_add_del_static_mapping | definition changed -nat44_address_details | only in image -nat44_address_dump | only in image -nat44_interface_add_del_feature | definition changed -nat44_interface_add_del_output_feature | definition changed -nat44_interface_addr_details | only in image -nat44_interface_addr_dump | only in image -nat44_interface_details | only in image -nat44_interface_dump | only in image -nat44_interface_output_feature_details | only in image -nat44_interface_output_feature_dump | only in image -nat44_lb_static_mapping_details | only in image -nat44_lb_static_mapping_dump | only in image -nat44_static_mapping_details | only in image -nat44_static_mapping_dump | only in image -nat44_user_details | only in image -nat44_user_dump | only in image -nat44_user_session_details | only in image -nat44_user_session_dump | only in image -nat_control_ping | definition changed -nat_det_add_del_map | definition changed -nat_det_close_session_in | definition changed -nat_det_close_session_out | definition changed -nat_det_forward | definition changed -nat_det_get_timeouts | definition changed -nat_det_map_details | only in image -nat_det_map_dump | only in image -nat_det_reverse | definition changed -nat_det_session_details | only in image -nat_det_session_dump | only in image -nat_det_set_timeouts | definition changed -nat_ipfix_enable_disable | definition changed -nat_set_workers | definition changed -nat_show_config | definition changed -nat_worker_details | only in image -nat_worker_dump | only in image -one_add_del_ndp_entry | definition changed -one_enable_disable_petr_mode | definition changed -one_enable_disable_pitr_mode | definition changed -one_enable_disable_xtr_mode | definition changed -one_get_transport_protocol | definition changed -one_map_register_fallback_threshold | definition changed -one_map_register_set_ttl | definition changed -one_ndp_bd_get | definition changed -one_ndp_entries_get | definition changed -one_set_transport_protocol | definition changed -one_show_petr_mode | definition changed -one_show_pitr_mode | definition changed -one_show_xtr_mode | definition changed -p2p_ethernet_add | definition changed -pppoe_add_del_session | definition changed -pppoe_session_details | only in image -pppoe_session_dump | only in image -punt_socket_deregister | definition changed -punt_socket_register | definition changed -show_one_map_register_fallback_threshold | definition changed -show_one_map_register_ttl | definition changed -snat_interface_add_del_output_feature | definition changed -snat_interface_output_feature_details | only in image -snat_interface_output_feature_dump | only in image -sw_interface_event | only in image -sw_interface_set_flags | definition changed -sw_interface_span_dump | definition changed -sw_interface_span_enable_disable | definition changed -sw_interface_vhost_user_details | definition changed -tcp_configure_src_addresses | definition changed -vnet_per_interface_combined_counters | only in image -vnet_per_interface_simple_counters | only in image -want_interface_combined_stats | definition changed -want_interface_simple_stats | definition changed -want_ip4_fib_stats | definition changed -want_ip4_nbr_stats | definition changed -want_ip6_fib_stats | definition changed -want_ip6_nbr_stats | definition changed -want_l2_macs_events | definition changed -want_per_interface_combined_stats | definition changed -want_per_interface_simple_stats | definition changed - -Found 103 api message signature differences - -Patches that updated the API files: - -./src/plugins/pppoe/pppoe.api -62f9cdd8 Add PPPoE Plugin - -./src/plugins/acl/acl.api -c29940c5 ACL-plugin add "replace" semantics for adding a new MacIP acl -de9fbf43 MAC IP ACL interface list dump (as an alternative to the get/reply) - -./src/plugins/nat/nat.api -704018cf NAT: Destination NAT44 with load-balancing (VPP-954) -2ba92e32 NAT: Rename snat plugin to nat (VPP-955) - -./src/vnet/interface.api -831fb59f Stats refactor -d292ab1e No context in SW interface event -a07bd708 Dedicated SW Interface Event - -./src/vnet/dhcp/dhcp.api -51822bf0 DHCP client option 61 "client_id" -4729b1ec DHCP complete event sends mask length - -./src/vnet/lldp/lldp.api -99a0e60e Add API support for LLDP config/interface set - -./src/vnet/lisp-cp/one.api -d630713d LISP: add neighbor discovery and CP protocol separation APIs -111a5cea LISP: Add APIs for enable/disable xTR/P-ITR/P-ETR modes -7048ff1e LISP: Map-server fallback feature -1e553a00 LISP: make TTL for map register messages configurable - -./src/vnet/ethernet/p2p_ethernet.api -15ac81c1 P2P Ethernet - -./src/vnet/mpls/mpls.api -2297af01 Add a name to the creation of an IP and MPLS table -28ab9cc1 FIB table add/delete API only -da78f957 L2 over MPLS -a0a908f1 FIB path weight incorrect in dump (VPP-922) -57b5860f FIB path preference - -./src/vnet/session/session.api -33e002b1 Fix session connect api message handling. - -./src/vnet/span/span.api -5b311202 SPAN/API:enable L2 dump -001fd406 SPAN:add l2 mirror - -./src/vnet/devices/virtio/vhost_user.api -4ba75f54 vhost: Remove operation mode in the API - -./src/vnet/vxlan-gpe/vxlan_gpe.api -04ffd0ad VPP crash on creating vxlan gpe interface. VPP-875 - -./src/vnet/tcp/tcp.api -3bbcfab1 TCP source address automation - -./src/vnet/ip/ip.api -2297af01 Add a name to the creation of an IP and MPLS table -28ab9cc1 FIB table add/delete API only -57b5860f FIB path preference - -./src/vnet/lisp-gpe/lisp_gpe.api -af3d9771 Remove unused retval from gpe_native_fwd_rpath type definition - -./src/vnet/l2/l2.api -50570ece Update of free text tag patch for BD -48304141 Support for bridge domain free text tag -e531f4cb Increase default MAC learn limit and check it in learn-update path -8d00fff8 Add support for API client to receive L2 MAC events - -./src/vpp/api/vpe.api -8a19f12a Allow individual stats API and introduce stats.api -4802632d Punt socket: Fix coverity error for pathname length mismatch between API and sun_path. -f7a55ad7 PUNT socket: External control plane processes connected via UNIX domain sockets. -75e2f2ac API:fix arp/ND event messages - remove context -99a0e60e Add API support for LLDP config/interface set - -./src/vpp/stats/stats.api -831fb59f Stats refactor -8a19f12a Allow individual stats API and introduce stats.api - - -@page release_notes_1707 Release notes for VPP 17.07 - -More than 400 commits since the 1704 release. - -## Features -- Infrastructure - - make test; improved debuggability. - - TAB auto-completion on the CLI - - DPDK 17.05 - - python 3 support in test infra - -- Host stack - - Improved Linux TCP stack compatibility using IWL test suite (https://jira.fd.io/browse/VPP-720) - - Improved loss recovery (RFC5681, RFC6582, RF6675) - - Basic implementation of Eifel detection algorithm (RFC3522) - - Basic support for buffer chains - - Refactored session layer API - - Overall performance, scale and hardening - -- Interfaces - - memif: IP mode, jumbo frames, multi queue - - virtio-user support - - vhost-usr; adaptive (poll/interupt) support. - -- Network features - - MPLS Multicast FIB - - - BFD FIB integration - - - NAT64 support - - - GRE over IPv6 - - - Segement routing MPLS - - - IOAM configuration for SRv6 localsid - - - LISP - - NSH support - - native forward static routes - - L2 ARP - - - ACL multi-core suuport - - - Flowprobe: - - Add flowstartns, flowendns and tcpcontrolbits - - Stateful flows and IPv6, L4 recording - - - GTP-U support - - - VXLAN GPE support for FIB2.0 and bypass. - - -## Known issues - -For the full list of issues please reffer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please reffer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1707) - - -@page release_notes_1704 Release notes for VPP 17.04 - -More than 500 commits since the 1701 release. - -## Features -- Infrastructure - - make test improvements - - vnet: add device-input threadplacement infra - - 64 bit per-thread counters - - process restart cli - - High performance timer wheels - - Plugin infrastructure improvements - - Support for .default_disabled, .version_required - - Added MAINTAINERS file - -- Host stack - - TCP stack (experimental) - - DHCPv4 / DHCPv6 relay multi-destination - - DHCPv4 option 82 - - ND proxy - - Attached hosts - - Consolidated DHCPv4 and DHCPv6 implementation - -- Interfaces - - DPDK 17.02 (retire support for DPDK 16.07) - - Add memif - packet memory interface for intra-host communication - - vhost: support interrupt mode - - DPDK as plugin (retired vpp_lite) - - DPDPK input optimizations - - Loopback interface allocation scheme - -- Network features - - IP Multicast FIB - - - Bridging - - Learning on local interfaces - - Flushing of MACs from the L2 FIB - - - SNAT - - CGN (Deterministic and dynamic) - - CGN configurable port allocation algorithm - - ICMP support - - Tentant VRF id for SNAT outside addresses - - Session dump / User dump - - Port allocation per protocol - - - Security groups - - Routed interface support - - L2+L3 unified processing node - - Improve fragment handling - - - Segement routing v6 - - SR policies with weighted SID lists - - Binding SID - - SR steering policies - - SR Local SIDs - - Framework to expand local SIDs w/plugins - - Documentation - - - IOAM - - UDP Pinger w/path fault isolation - - IOAM as type 2 metadata in NSH - - IAOM raw IPFIX collector and analyzer - - Anycast active server selection - - Documentation - - SRv6 Local SID - - IP6 HBH header and SR header co-existence - - Active probe - - - LISP - - Statistics collection - - Generalize encap for overlay transport (vxlan-gpe support) - - Improve data plane speed - - - GPE - - CLI - - NSH added to encap/decap path - - Renamed LISP GPE API to GPE - - - MPLS - - Performance improvements (quad loop) - - - BFD - - Command line interface - - Echo function - - Remote demand mode - - SHA1 authentication - - - IPsec - - IKEv2 initiator features - - - VXLAN - - unify IP4/IP6 control plane handling - -## API changes - -- Python API: To avoid conflicts between VPP API messages names and - the Python API binding function names, VPP API methods are put in a - separate proxy object. - https://gerrit.fd.io/r/#/c/5570/ - The api methods are now referenced as: - vpp_handle = VPP(jsonfiles) - vpp_handle.connect(...) - vpp = vpp_handle.api - vpp.show_version() - vpp_handle.disconnect() - - For backwards compatibility VPP API methods are left in the main - name space (VPP), but will be removed from 17.07. - - - Python API: Change from cPython to CFFI. - -- create_loopback message to be replaced with create_loopback_instance - create_loopback will be removed from 17.07. - https://gerrit.fd.io/r/#/c/5572/ - -## Known issues - -For the full list of issues please reffer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please reffer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1704) - - -@page release_notes_17011 Release notes for VPP 17.01.1 - -This is bug fix release. - -For the full list of fixed issues please reffer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1701) - - -@page release_notes_1701 Release notes for VPP 17.01 - -@note This release was for a while known as 16.12. - -## Features - -- [Integrated November 2016 DPDK release](http://www.dpdk.org/doc/guides/rel_notes/release_16_11.html) - -- Complete rework of Forwarding Information Base (FIB) - -- Performance Improvements - - Improvements in DPDK input and output nodes - - Improvements in L2 path - - Improvmeents in IPv4 lookup node - -- Feature Arcs Improvements - - Consolidation of the code - - New feature arcs - - device-input - - interface-output - -- DPDK Cryptodev Support - - Software and Hardware Crypto Support - -- DPDK HQoS support - -- Simple Port Analyzer (SPAN) - -- Bidirectional Forwarding Detection - - Basic implementation - -- IPFIX Improvements - -- L2 GRE over IPSec tunnels - -- Link Layer Discovery Protocol (LLDP) - -- Vhost-user Improvements - - Performance Improvements - - Multiqueue - - Reconnect - -- LISP Enhancements - - Source/Dest control plane support - - L2 over LISP and GRE - - Map-Register/Map-Notify/RLOC-probing support - - L2 API improvements, overall code hardening - -- Plugins: - - New: ACL - - New: Flow per Packet - - Improved: SNAT - - Mutlithreading - - Flow export - -- Doxygen Enhancements - -- Luajit API bindings - -- API Refactoring - - file split - - message signatures - -- Python and Scapy based unit testing infrastructure - - Infrastructure - - Various tests - -- Packet Generator improvements - -- TUN/TAP jumbo frames support - -- Other various bug fixes and improvements - -## Known issues - -For the full list of issues please reffer to fd.io [JIRA](https://jira.fd.io). - -## Issues fixed - -For the full list of fixed issues please reffer to: -- fd.io [JIRA](https://jira.fd.io) -- git [commit log](https://git.fd.io/vpp/log/?h=stable/1701) - - -@page release_notes_1609 Release notes for VPP 16.09 - -## Features - -- [Integrated July 2016 DPDK release](http://www.dpdk.org/doc/guides/rel_notes/release_16_07.html) - - DPDK-vhost is depreciated pending a complete rework of the original integration and - addressing of rx performance deltas. - - Patches required for DPDK 16.07: - - Correctly setting the Packet Type in the IGB, IXGBE and i40e drivers. - - Correctly setting checksum in the i40e driver. - - NXP DPAA2 PMD Driver. - - rte_delay (yield) functionality. - -- Add “in tree” plugins: - - IPv6 ILA. - - iOAM. - - Load Balancer. - - SNAT. - -- High-performance (line-rate) “neutron like” L4 port-filtering. - -- API refactoring - addressing some of the issues around JVPP bindings. - - Accommodating plugins [(e.g. NSH_SFC)](https://wiki.fd.io/view/NSH_SFC) - - Binding for [python](https://wiki.fd.io/view/VPP/Python_API) - -- LISP - - L2 LISP overlays - - Multitenancy - - Multihoming - - RTR mode - - Map-resolver failover algorithm - -- Support 64-bit vector lengths, huge shared-memory segments. - -- Dynamic IP Feature ordering - - IP Features can now specify features they appear before and after - -- 16.09 Builds - - Ubuntu 14.04 LTS - Trusty Tahr - - Ubuntu 16.04 LTS - Xenial Xerus - - CentOS 7 - - More information on [VPP wiki](https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages) - -- Performance, characterize and document performance for this release - [(more information on CSIT page)](https://wiki.fd.io/view/CSIT) - - - IPv4 and IPv6 Scale - performance tests. - - Bidirectional 10k/100k/1M flows. - - 64B,570B, 1518B,9000B packet sizes. - - IPv6 iACL - performance - - DUT1 and DUT2 are configured with IPv6 routing, two static IPv6 /64 routes and IPv6 iAcl - security whitelist ingress /64 filter entries applied on links. - - TG traffic profile contains two L3 flow-groups (flow-group per direction, 253 flows per - flow-group) with all packets containing Ethernet header, IPv6 header and generated payload. - MAC addresses are matching MAC addresses of the TG node interfaces. - - - L2XC VXLANoIPv4 - performance - - DUT1 and DUT2 are configured with L2 cross-connect. VXLAN tunnels are configured between - L2XCs on DUT1 and DUT2. - - TG traffic profile contains two L3 flow-groups (flow-group per direction, 253 flows per - flow-group) with all packets containing Ethernet header, IPv4 header with IP protocol=61 - and generated payload. MAC addresses are matching MAC addresses of the TG node interfaces. - -- Documentation - - Autogenerated CLI documentation. - - Using doxygen to automate API/Node documentation. - - [(available online)](https://docs.fd.io/vpp/16.09/) - -- Resolved all static analysis issues found by Coverity - - Beginning of 16.09 cycle: 505 issues. - - Release: 0 outstanding issues. - - -## Known issues - -Issues in fd.io are tracked in [JIRA](https://jira.fd.io). - -Issue | Description ---- | --- -VPP-391 | vpp debug version assert appeared in the process of start -VPP-380 | Mapping algorithm compute wrong ea-bits when IPv4 prefix 0.0.0.0/0 -VPP-371 | load_one_plugin:63: Loaded plugin: message from vppctl -VPP-367 | vpp packages need to depend on specific versions of each other -VPP-312 | IP6 FIB gets in indeterminate state by duplicating commands -VPP-224 | Lookup-in-vrf can not be set correctly -VPP-206 | Fix classify table delete -VPP-203 | Fix binary API for reading vpp node graph -VPP-147 | Inconsistent behaviour when adding L2 FIB filter entry -VPP-99 | VPP doesn't discard DHCPOFFER message with wrong XID - - -## Issues fixed - -Issues in fd.io are tracked in [JIRA](https://jira.fd.io). - -Issue | Description ---- | --- -VPP-396 | Ubuntu systems Graphviz bug -VPP-390 | vpp-lib rpm fails to include *.so symlinks, causing linking problems with out of tree builds -VPP-388 | IPSec output feature assumes packets have been ethernet rewritten -VPP-385 | ARP for indirect adjacencies not working correctly -VPP-361 | Memory leak on delete of VXLAN over IPv6 tunnel -VPP-357 | VNI not set correctly when removing LISP fwd entries -VPP-349 | sw_interface_vhost_user_dump not working -VPP-345 | net/enic: bad L4 checksum ptype set on ICMP packets -VPP-340 | MAP-T wrong destination address -VPP-330 | Use fifo to store LISP pending map-requests -VPP-326 | map_add_domain VAT command: unable to configure domain with mtu parameter -VPP-318 | The map_add_domain VAT command accepts invalid arguments -VPP-315 | Fix "show vxlan-gpe" issue -VPP-310 | Mapping algorithm compute wrong ea-bits -VPP-239 | LISP IP forwarding does not tag packets that hit negative mapping entries -VPP-235 | Invalid help in VAT for sw_interface_set_l2_bridge -VPP-228 | Mapping algorithm sends packet to wrong IPv6 address -VPP-214 | vpp-api-test: api_ipsec_sad_add_del_entry: vector "ck" not initialized -VPP-200 | VPP - TAP port create problem -VPP-189 | Coverity Issues for 16.09 -VPP-184 | u16 translating to char ,not short -VPP-179 | Adjacency share-count botch -VPP-163 | "show ip6 interface" ignores non-global addresses -VPP-155 | Netmap: Inconsistency in interface state between "show hardware" and "show interface" -VPP-145 | Dynamically compute IP feature ordering based on constraints -VPP-137 | VPP sends ARP with wrong requested IP -VPP-118 | JVpp: 0 length arrays not handled properly in VPP responses -VPP-112 | linux kernel info missing from build log -VPP-110 | vxlan encap node should never touch a deleted tunnel -VPP-107 | RPM build broken in master -VPP-92 | segment routing is not properly filling out the segment list -VPP-91 | segment routing add/del tunnel lookup doesn't work -VPP-84 | af_packet throws a fatal error on EAGAIN -VPP-74 | Clang compile fails due to warning in vlib/unix/cli.c -VPP-64 | Top level "make pkg-deb" fails if CDPATH is set in user env. -VPP-48 | Traceroute does not terminate when VPP is the target -VPP-23 | CLI pager does not gracefully handle lines longer than the terminal width - - -@page release_notes_1606 Release notes for VPP 16.06 - - -The FD.io Project, relentlessly focused on data IO speed and efficiency -supporting the creation of high performance, flexible, and scalable software -defined infrastructures, announces the availability of the community’s first -software release (16.06). - -In the four months since launching, FD.io has brought together more than 75 -developers from 11 different companies including network operators, solution -providers chip vendors, and network equipment vendors who are collaborating to -enhance and innovate around the Vector Packet Processing (VPP) technology. The -FD.io community has quickly formed to grow the number of projects from the -initial VPP project to an additional 6 projects addressing a diverse set of -requirements and usability across a variety of deployment environments. - -The 16.06 release brings unprecedented performance: 480Gbps/200mpps with 8 -million routes and 2k whitelist entries on standard high volume x86 servers. - - -## Features - -In addition to the existing full suite of vswitch/vrouter features, the new -16.06 release adds: - -* Enhanced Switching and Routing: - * IPv6 Segment Routing multicast support. - * LISP xTR support. - * VXLAN over IPv6 underlay. - * Per interface whitelists. - * Shared adjacencies in FIB. - -* New and improved interface support: - * Jumbo frame support for vhost-user. - * Netmap interface support. - * AF_Packet interface support. - -* Expanded and improved programmability: - * Python API bindings. - * Enhanced JVPP Java API bindings. - * Debugging CLI. - -* Expanded Hardware and Software Support: - * Support for ARM 32 targets including Rasberry Pi single-board computer. - * Support for DPDK 16.04. diff --git a/docs/Makefile b/docs/Makefile index 49938640a34..ca4a3acdb9c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,33 +5,46 @@ ifeq ($(shell uname),Darwin) OS_ID = darwin endif +# These should be passed in by the root Makefile +WS_ROOT ?= $(CURDIR)/.. +BR ?= $(WS_ROOT)/build-root +DOCS_DIR ?= $(WS_ROOT)/docs + +VENV_DIR ?= $(DOCS_DIR)/venv +SPHINX_SCRIPTS_DIR ?= $(WS_ROOT)/docs/scripts + # Work out the OS if we haven't already OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') +OS_VERSION ?= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') +PIP_VERSION ?= $(shell grep 'PIP_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2) +PIP_TOOLS_VERSION ?= $(shell grep 'PIP_TOOLS_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2) + +PYTHON ?= "python3" DOC_DEB_DEPENDS = enchant DOC_RPM_DEPENDS = enchant # You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = fdio-vpp -SOURCEDIR = . -BUILDDIR = _build +SPHINXOPTS = --keep-going -n -W +SPHINXBUILD = sphinx-build +SPHINXPROJ = fdio-vpp +SOURCEDIR = . +BUILDDIR = ${BR}/docs +BUILDDIR_SRC = ${BUILDDIR}/src +BUILDDIR_OUT = ${BUILDDIR}/html +SCRIPTS_DIR = _scripts + # Put it first so that "make" without argument is like "make help". +.PHONY: help help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + @( \ + . ${VENV_DIR}/bin/activate; \ + $(SPHINXBUILD) --help ;\ + ) -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile -# Generate dynamic content - @python3 ./includes_renderer.py - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -spell: +.PHONY: checkdeps +checkdeps: @echo "Checking whether dependencies for Docs are installed..." ifeq ($(OS_ID),ubuntu) @set -e; inst=; \ @@ -45,4 +58,45 @@ ifeq ($(OS_ID),ubuntu) else ifneq ("$(wildcard /etc/redhat-release)","") @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS) endif - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -W -b spelling $(O) + +.PHONY: spell +spell: clean checkdeps venv ${BUILDDIR_SRC} + @( \ + . ${VENV_DIR}/bin/activate; \ + make -C ${SCRIPTS_DIR} generate && \ + $(SPHINXBUILD) -b spelling $(SPHINXOPTS) $(BUILDDIR_SRC) $(BUILDDIR_OUT); \ + ) + +.PHONY: venv +venv: + @( \ + if [ ! -d ${VENV_DIR} ]; then \ + ${PYTHON} -m venv ${VENV_DIR}; \ + . ${VENV_DIR}/bin/activate; \ + ${PYTHON} -m pip install pip==${PIP_VERSION}; \ + ${PYTHON} -m pip install pip-tools==${PIP_TOOLS_VERSION}; \ + ${PYTHON} -m pip install -r ${WS_ROOT}/test/requirements-3.txt; \ + fi; \ + ) + +${BUILDDIR_SRC}: + @mkdir -p ${BUILDDIR_SRC} + @cp -r $(SOURCEDIR) ${BUILDDIR_SRC} + @cd ${BUILDDIR_SRC} && find . -type l -exec cp --remove-destination -L ${DOCS_DIR}/{} {} \; + +.PHONY: docs +docs: clean venv ${BUILDDIR_SRC} + @( \ + . ${VENV_DIR}/bin/activate; \ + make -C ${SCRIPTS_DIR} generate && \ + $(SPHINXBUILD) $(SPHINXOPTS) -b html $(BUILDDIR_SRC) $(BUILDDIR_OUT); \ + ) + +.PHONY: clean +clean: + @rm -rf $(BUILDDIR) + @make -C ${SCRIPTS_DIR} clean + +.PHONY: build +build: docs + diff --git a/docs/README b/docs/README index d9a70912edb..7e82709c876 100644 --- a/docs/README +++ b/docs/README @@ -23,7 +23,7 @@ $ cd vpp Install the virtual environment ---------------------------------------------- -$ python -m pip install --user virtualenv +$ python -m pip install --user virtualenv $ python -m virtualenv env $ source env/bin/activate $ pip install -r docs/etc/requirements.txt diff --git a/docs/_images/htmlBuild.png b/docs/_images/htmlBuild.png deleted file mode 100644 index c95a643de23..00000000000 Binary files a/docs/_images/htmlBuild.png and /dev/null differ diff --git a/docs/_images/libmemif_architecture.png b/docs/_images/libmemif_architecture.png new file mode 120000 index 00000000000..77cbc4f4abf --- /dev/null +++ b/docs/_images/libmemif_architecture.png @@ -0,0 +1 @@ +../../extras/libmemif/docs/architecture.png \ No newline at end of file diff --git a/docs/_scripts/Makefile b/docs/_scripts/Makefile new file mode 100644 index 00000000000..dbd88bf9a20 --- /dev/null +++ b/docs/_scripts/Makefile @@ -0,0 +1,212 @@ +# Copyright (c) 2021 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# +# Build the documentation +# + +# Default target +.PHONY: all +all: siphon + +# These should be passed in by the root Makefile +WS_ROOT ?= $(CURDIR)/../.. +BR ?= $(WS_ROOT)/build-root + +# Tag used in github repository path. +# Change this when genearting for a release +VPP_TAG ?= master + +REPOSITORY_URL ?= https://github.com/FDio/vpp/blob/$(VPP_TAG)/ + +# Doxygen configuration and our utility scripts +SCRIPTS_DIR ?= $(WS_ROOT)/docs/_scripts + +# docs root directory +DOCS_DIR ?= ${BR}/docs/src + +FEATURE_LIST_FILE = ${DOCS_DIR}/aboutvpp/featurelist.md + +# Siphoned fragements are processed into here +DOCS_GENERATED_DIR ?= $(DOCS_DIR)/_generated + +# Siphoned fragments end up in here +SIPHON_INPUT_DIR ?= $(DOCS_GENERATED_DIR)/fragments + +DYNAMIC_RENDER_DIR ?= ${DOCS_GENERATED_DIR}/includes + +# Primary source directories +SIPHON_SRC ?= $(WS_ROOT)/src +SIPHON_SRC_DIRECTORIES = \ + $(shell find $(SIPHON_SRC) -name '*.md' -print | xargs dirname \ + | sort | uniq) \ + $(SIPHON_SRC)/vppinfra \ + $(SIPHON_SRC)/svm \ + $(SIPHON_SRC)/vlib \ + $(SIPHON_SRC)/vlibapi \ + $(SIPHON_SRC)/vlibmemory \ + $(SIPHON_SRC)/vnet \ + $(SIPHON_SRC)/vpp \ + $(SIPHON_SRC)/vpp-api \ + $(SIPHON_SRC)/examples + +# Input directories and files +SIPHON_INPUT ?= \ + $(wildcard $(WS_ROOT)/*.md) \ + $(wildcard $(SCRIPTS_DIR)/*.md) \ + $(SIPHON_SRC_DIRECTORIES) \ + $(SIPHON_SRC)/plugins \ + extras + +# Strip leading workspace path from input names +SIPHON_INPUT := $(subst $(WS_ROOT)/,,$(SIPHON_INPUT)) + +# Files to exclude, from pre-Doxygen steps, eg because they're +# selectively compiled. +# Examples would be to exclude non-DPDK related sources when +# there's a DPDK equivalent that conflicts. +# These must be left-anchored paths for the regexp below to work. +SIPHON_EXCLUDE ?= \ + $(SIPHON_SRC)/vpp-api/lua + +# Generate a regexp for filenames to exclude +SIPHON_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(SIPHON_EXCLUDE))' | sed -e 's/ /|/g'))) + +# Include all the normal source directories in the include file path +SIPHON_INCLUDE_PATH = $(SIPHON_SRC_DIRECTORIES) + +# Find API header directories and include them in the header path. +# This is only useful if VPP and plugins are already built; nothing +# here depends on those targets. We don't build documentation for these +# header files, they're just added to the INCLUDE search path for Doxygen. +_vpp_br = $(shell find "$(BR)" -maxdepth 1 -type d \ + '(' -name build-vpp_debug-native -o -name build-vpp-native ')' -print \ + | sed -e 's@^$(WS_ROOT)/*@@' -e 1q) +ifneq ($(strip $(_vpp_br)),) +SIPHON_INCLUDE_PATH += \ + $(_vpp_br)/vlib-api \ + $(_vpp_br)/vpp +# Also include any plugin directories that exist +SIPHON_INCLUDE_PATH += \ + $(shell find $(WS_ROOT)/$(_vpp_br)/plugins -maxdepth 1 -type d | sed -e 's@^$(WS_ROOT)/*@@') +endif + +# Discover if we have CPP available +_cpp = $(shell which cpp) +ifneq ($(strip $(_cpp)),) +# Add whatever directories CPP normally includes to the header path +SIPHON_INCLUDE_PATH += $(shell set -e; $(_cpp) -v &1 | awk 'f&&/^ /{print $$1} /^\#include/{f=1}') +endif + +# All the siphon types we know about +SIPHONS ?= clicmd syscfg + +SIPHON_FILES = $(addprefix $(SIPHON_INPUT_DIR)/,$(addsuffix .siphon,$(SIPHONS))) +SIPHON_DOCS = $(addprefix $(DOCS_GENERATED_DIR)/,$(addsuffix .rst,$(SIPHONS))) + +BUILT_ON = $(shell date '+%d %B %Y') +VPP_VERSION = $(shell ${WS_ROOT}/src/scripts/version) + +.PHONY: featurelist +featurelist: + @( \ + cd $(WS_ROOT) && \ + find . -name FEATURE.yaml | \ + ./src/scripts/fts.py \ + --markdown \ + --repolink $(REPOSITORY_URL) > \ + $(FEATURE_LIST_FILE) ; \ + ) + + +.PHONY: includes-render +includes-render: + @mkdir -p "$(DYNAMIC_RENDER_DIR)" + @python3 $(SCRIPTS_DIR)/includes_renderer.py ${WS_ROOT} ${DYNAMIC_RENDER_DIR} + +.PHONY: template-index +template-index: + @sed -ie "s/__VPP_VERSION__/${VPP_VERSION}/g" ${DOCS_DIR}/index.rst + @sed -ie "s/__BUILT_ON__/${BUILT_ON}/g" ${DOCS_DIR}/index.rst + +.NOTPARALLEL: $(SIPHON_FILES) +$(SIPHON_FILES): $(SCRIPTS_DIR)/siphon-generate \ + $(addprefix,$(WSROOT),$(SIPHON_INPUT)) \ + $(wildcard $(SCRIPTS_DIR)/siphon/*.py) + @echo "Validating source tree..." + @set -e; for input in $(SIPHON_INPUT); do \ + if [ ! -e "$(WS_ROOT)/$$input" ]; then \ + echo "ERROR: Input path '$$input' does not exist." >&2; \ + exit 1; \ + fi; \ + done + @rm -rf "$(SIPHON_INPUT_DIR)" "$(DOCS_GENERATED_DIR)" + @mkdir -p "$(SIPHON_INPUT_DIR)" "$(DOCS_GENERATED_DIR)" + @touch $(SIPHON_INPUT_DIR)/files + @echo "Collating source file list for siphoning..." + @for input in $(SIPHON_INPUT); do \ + cd "$(WS_ROOT)"; \ + find "$$input" -type f \ + \( -name '*.[ch]' -or -name '*.dox' \) -print \ + | grep -v -E '^src/examples/' \ + | grep -v -E '^$(SIPHON_EXCLUDE_REGEXP)' \ + >> $(SIPHON_INPUT_DIR)/files; \ + done + @echo "Generating siphons..." + @set -e; \ + cd "$(WS_ROOT)"; \ + $(SCRIPTS_DIR)/siphon-generate \ + --output="$(SIPHON_INPUT_DIR)" \ + "@$(SIPHON_INPUT_DIR)/files" + +# Evaluate this to build a siphon doc output target for each desired +# output type: +# $(eval $(call siphon-process,file_extension,output_type_name)) +define siphon-process +$(DOCS_GENERATED_DIR)/%.$(1): $(SIPHON_INPUT_DIR)/%.siphon \ + $(SCRIPTS_DIR)/siphon-process \ + $(wildcard $(SCRIPTS_DIR)/siphon/*.py) \ + $(wildcard $(SCRIPTS_DIR)/siphon_templates/$(2)/*/*.$(1)) + @echo "Processing siphon for $(2) from $$(notdir $$<)..." + @set -e; \ + cd "$(WS_ROOT)"; \ + mkdir -p $(DOCS_GENERATED_DIR)/$$(basename $$(notdir $$<)).$(1).dir; \ + $(SCRIPTS_DIR)/siphon-process \ + --type=$$(basename $$(notdir $$<)) \ + --format=$(2) \ + --repolink=$(REPOSITORY_URL)/ \ + --outdir=$(DOCS_GENERATED_DIR)/$$(basename $$(notdir $$<)).$(1).dir \ + --output="$$@" \ + "$$<" +endef + +# Process the .siphon source fragments and render them into siphon flavored +# markdown documentation +.DELETE_ON_ERROR: $(SIPHON_DOCS) +$(eval $(call siphon-process,rst,markdown)) + +# This target can be used just to generate the siphoned things +.PHONY: siphon +siphon: $(SIPHON_DOCS) + @cp $(DOCS_GENERATED_DIR)/clicmd.rst $(DOCS_DIR)/cli-reference/index.rst + @cp -r $(DOCS_GENERATED_DIR)/clicmd.rst.dir $(DOCS_DIR)/cli-reference/clis + +.PHONY: generate +generate: siphon includes-render template-index featurelist + +.PHONY: clean +clean: + @rm -rf $(BR)/.siphon.dep + @rm -rf $(SCRIPTS_DIR)/siphon/__pycache__ + diff --git a/docs/_scripts/filter_api.py b/docs/_scripts/filter_api.py new file mode 100755 index 00000000000..484881439b8 --- /dev/null +++ b/docs/_scripts/filter_api.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python3 +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Filter for vpe.api to make it Doxygenish. + +import re +import sys + +if len(sys.argv) < 2: + sys.stderr.write("Usage: %s \n" % (sys.argv[0])) + sys.exit(1) + +patterns = [ + # Search for "define" blocks and treat them as structs + (re.compile(r"^.*(manual_.[^\s]+\s+)?define\s+(?P[^\s]+)"), + r"typedef struct vl_api_\g_t"), + + # For every "brief" statement at the start of a comment block, add an + # xref with whatever is on the same line. This gives us an index page + # with all the API methods in one place. + # XXX Commented out for now; works but duplicates the brief text in the + # struct documentation + # (re.compile(r"/\*\*\s*(?P[\\@]brief)\s+(?P.+)(\*/)$"), + # r'/** @xrefitem api "" "VPP API" \g \g \g'), # capture inline comment close + # (re.compile(r"/\*\*\s*(?P[\\@]brief)\s+(?P.+)$"), + # r'/** @xrefitem api "" "VPP API" \g \g \g'), + + # Since structs don't have params, replace @param with @tparam + ( re.compile("[\\@]param\\b"), "@tparam"), +] + +with open(sys.argv[1]) as fd: + for line in fd: + str = line[:-1] # strip \n + for p in patterns: + str = p[0].sub(p[1], str) + sys.stdout.write(str+"\n") diff --git a/docs/_scripts/filter_c.py b/docs/_scripts/filter_c.py new file mode 100755 index 00000000000..897f9f6d0b3 --- /dev/null +++ b/docs/_scripts/filter_c.py @@ -0,0 +1,87 @@ +#!/usr/bin/env python3 +# Copyright (c) 2016 Comcast Cable Communications Management, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at: +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Filter for .c files to make various preprocessor tricks Doxygenish + +import os, sys, re + +if len(sys.argv) < 2: + sys.stderr.write("Usage: %s \n" % (sys.argv[0])) + sys.exit(1) + +replace_patterns = [ + # Search for VLIB_CLI_COMMAND, extract its parameters and add a docblock for it + ( re.compile("(?PVLIB_CLI_COMMAND)\s*[(](?P[a-zA-Z0-9_]+)[)]"), + r"/** @brief (@em constructor) \g (\g) */ vlib_cli_command_t \g"), + ( re.compile("(?PVLIB_CLI_COMMAND)\s*[(](?P[a-zA-Z0-9_]+),\s*(?P[^)]*)[)]"), + r"/** @brief (@em constructor) \g (\g) */ \g vlib_cli_command_t \g"), + + # Search for VLIB_REGISTER_NODE, extract its parameters and add a docblock for it + ( re.compile("(?PVLIB_REGISTER_NODE)\s*[(](?P[a-zA-Z0-9_]+)[)]"), + r"/** @brief (@em constructor) \g (\g) */ vlib_node_registration_t \g"), + ( re.compile("(?PVLIB_REGISTER_NODE)\s*[(](?P[a-zA-Z0-9_]+),\s*(?P[^)]*)[)]"), + r"/** @brief (@em constructor) \g (\g) */ \g vlib_node_registration_t \g"), + + # Search for VLIB_INIT_FUNCTION, extract its parameter and add a docblock for it + ( re.compile("(?PVLIB_INIT_FUNCTION)\s*[(](?P[a-zA-Z0-9_]+)[)]"), + r"/** @brief (@em constructor) \g (@ref \g) */ vlib_init_function_t * _vlib_init_function_\g"), + ( re.compile("(?PVLIB_DECLARE_INIT_FUNCTION)\s*[(](?P[a-zA-Z0-9_]+)[)]"), + r"/** @brief (@em constructor) \g (@ref \g) */ vlib_init_function_t * _vlib_init_function_\g"), + + # Search for VLIB_LOOP_ENTER_FUNCTION, extract the parameters and add a docblock for it + ( re.compile("(?PVLIB_MAIN_LOOP_ENTER_FUNCTION)\s*[(](?P[a-zA-Z0-9_]+)(,[^)]*)?[)]"), + r"/** @brief (@em constructor) \g (@ref \g) */ _vlib_main_loop_enter_\g"), + ( re.compile("(?PVLIB_MAIN_LOOP_EXIT_FUNCTION)\s*[(](?P[a-zA-Z0-9_]+)(,[^)]*)?[)]"), + r"/** @brief (@em constructor) \g (@ref \g) */ _vlib_main_loop_exit_\g"), + + # Search for VLIB_CONFIG_FUNCTION, extract the parameters and add a docblock for it + ( re.compile("(?PVLIB_CONFIG_FUNCTION)\s*[(](?P[a-zA-Z0-9_]+),\s*(?P\"[^\"]+\")(,[^)]*)?[)]"), + r"/** @brief (@em constructor) \g (\g, \g) */ vlib_config_function_runtime_t _vlib_config_function_\g"), + ( re.compile("(?PVLIB_EARLY_CONFIG_FUNCTION)\s*[(](?P[a-zA-Z0-9_]+),\s*(?P\"[^\"]+\")(,[^)]*)?[)]"), + r"/** @brief (@em constructor) \g (\g, \g) */ vlib_config_function_runtime_t _vlib_config_function_\g"), + + # Search for "format_thing" and "unformat_thing" when used as a function pointer and add parens + ( re.compile("(?P
(^|,)\s*)(?P(un)?format_[a-zA-Z0-9_]+)(?P\s*(,|$))"),
+        r"\g
\g()\g" ),
+
+    # Search for CLIB_PAD_FROM_TO(...); and replace with padding
+    # #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
+    ( re.compile("(?PCLIB_PAD_FROM_TO)\s*[(](?P[^,]+),\s*(?P[^)]+)[)]"),
+        r"/** Padding. */ u8 pad_\g[(\g) - (\g)]" ),
+
+]
+
+
+filename = sys.argv[1]
+cwd = os.getcwd()
+if filename[0:len(cwd)] == cwd:
+    filename = filename[len(cwd):]
+    if filename[0] == "/":
+        filename = filename[1:]
+
+with open(filename) as fd:
+    line_num = 0
+
+    for line in fd:
+        line_num += 1
+        str = line[:-1] # filter \n
+
+        # Look for search/replace patterns
+        for p in replace_patterns:
+            str = p[0].sub(p[1], str)
+
+        sys.stdout.write(str+"\n")
+
+# All done
diff --git a/docs/_scripts/filter_h.py b/docs/_scripts/filter_h.py
new file mode 100755
index 00000000000..0891fa708e1
--- /dev/null
+++ b/docs/_scripts/filter_h.py
@@ -0,0 +1,56 @@
+#!/usr/bin/env python3
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Filter for .c files to make various preprocessor tricks Doxygenish
+
+import os
+import re
+import sys
+
+if len(sys.argv) < 2:
+    sys.stderr.write("Usage: %s \n" % (sys.argv[0]))
+    sys.exit(1)
+
+replace_patterns = [
+    # Search for CLIB_PAD_FROM_TO(...); and replace with padding
+    # #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
+    (re.compile(r"(?PCLIB_PAD_FROM_TO)\s*[(](?P[^,]+),"
+                r"\s*(?P[^)]+)[)]"),
+     r"/** Padding. */ u8 pad_\g[(\g) - (\g)]"),
+
+]
+
+
+filename = sys.argv[1]
+cwd = os.getcwd()
+if filename[0:len(cwd)] == cwd:
+    filename = filename[len(cwd):]
+    if filename[0] == "/":
+        filename = filename[1:]
+
+with open(filename) as fd:
+    line_num = 0
+
+    for line in fd:
+        line_num += 1
+        str = line[:-1]  # filter \n
+
+        # Look for search/replace patterns
+        for p in replace_patterns:
+            str = p[0].sub(p[1], str)
+
+        sys.stdout.write(str+"\n")
+
+# All done
diff --git a/docs/_scripts/includes_renderer.py b/docs/_scripts/includes_renderer.py
new file mode 100644
index 00000000000..6bd501d83ff
--- /dev/null
+++ b/docs/_scripts/includes_renderer.py
@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+#  Copyright (c) 2020. Vinci Consulting Corp. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import glob
+import inspect
+import os
+import re
+import sys
+
+
+class ContentRenderer:
+    def __init__(self, ws_root, output_dir):
+        self.ws_root = ws_root
+        self.output_dir = output_dir
+
+    def plugin_dir(self):
+        return os.path.join(self.ws_root, "src/plugins")
+
+    def render(self):
+        raise NotImplementedError
+
+
+class PluginRenderer(ContentRenderer):
+
+    def _render_entry(self, output_file, entry):
+        description = ""
+        # we use glob because a plugin can (ioam for now)
+        # define the plugin definition in
+        # a further subdirectory.
+        path = os.path.join(self.plugin_dir(), entry.name, '**')
+        for f in glob.iglob(path, recursive=True):
+            if not f.endswith('.c'):
+                continue
+            with open(f, "r", encoding="utf-8") as src:
+                for match in self.regex.finditer(src.read()):
+                    description = "%s" % (match.group(1))
+
+        output_file.write(f"* {entry.name} - {description}\n")
+
+    def render(self):
+        pattern = r'VLIB_PLUGIN_REGISTER\s?\(\)\s*=\s*{.*\.description\s?=\s?"([^"]*)".*};'  # noqa: 501
+        self.regex = re.compile(pattern, re.MULTILINE | re.DOTALL)
+        fname = os.path.join(self.output_dir, "plugin_list.inc")
+        with open(fname, "w") as output_file:
+            with os.scandir(self.plugin_dir()) as pdir:
+                for entry in sorted(pdir, key=lambda entry: entry.name):
+                    if not entry.name.startswith('.') and entry.is_dir():
+                        self._render_entry(output_file, entry)
+
+
+renderers = [PluginRenderer]
+
+
+def main():
+    if len(sys.argv) != 3:
+        print("You need to pass WS_ROOT and OUTPUT_DIR")
+        exit(1)
+
+    print("rendering dynamic includes...")
+    for renderer in renderers:
+        renderer(*sys.argv[1:]).render()
+    print("done.")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/docs/_scripts/prepare-for-site.sh b/docs/_scripts/prepare-for-site.sh
new file mode 100755
index 00000000000..15888ba6e83
--- /dev/null
+++ b/docs/_scripts/prepare-for-site.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+if [ ! -d "docs" ]; then
+  echo "This script is meant to be run from the root directory"
+  exit 1;
+fi
+
+for f in $(find ./docs -type l)
+do
+  target=$(readlink $f)
+  rm $f
+  cp $(dirname $f)/$target $(dirname $f)/$(basename $target)
+  echo "Replaced symlink $f"
+done
+
+echo "Cleaning doc build directory"
+make docs-clean
+
diff --git a/docs/_scripts/publish-docs.sh b/docs/_scripts/publish-docs.sh
new file mode 100755
index 00000000000..026ab2f3907
--- /dev/null
+++ b/docs/_scripts/publish-docs.sh
@@ -0,0 +1,85 @@
+#!/bin/bash -ex
+
+# publish-docs.sh
+#
+# This sccript is used to publish the VPP User documents to
+# the FD.io Site.
+#
+# Arguments:
+#
+# $1: The main site repo user name
+# $2: The release branch name for example 1908, 1904 etc.
+
+# Some basic checks
+if [ ! -d "docs" ]; then
+  echo "This script is meant to be run from the root directory."
+  exit 1;
+fi
+
+if [ "$#" -ne 2 ]; then
+    echo "Please specify the site username and branch."
+    exit 1;
+fi
+
+# Get the workspace root
+WS_ROOT=$PWD
+
+# Get the VPP branch and username
+SITE_USERNAME=$1
+VPP_BRANCH=$2
+
+#Build the docs
+make docs-clean
+make docs-venv
+make docs
+
+# Clone the site repo
+rm -fr site
+rm -fr sphinx_env
+git clone ssh://git@github.com/$SITE_USERNAME/site
+cd site
+git submodule update --init --recursive
+git remote add upstream ssh://git@github.com/FDio/site
+git remote -v
+git fetch upstream
+git merge -m "Publish the Docs" upstream/master
+
+# Get the version
+VERSION=`source $WS_ROOT/src/scripts/version`
+VERSION=${VERSION/"~"/"-"}
+
+# Copy the files to the appropriate directory
+SRC_DIR=../docs/_build/html/.
+if [ "$VPP_BRANCH" == "master" ]
+then
+    TARGET_DIR=./static/docs/vpp/master
+    rm -fr $TARGET_DIR
+else
+    TARGET_DIR=./static/docs/vpp/v$VPP_BRANCH
+    rm -fr $TARGET_DIR
+    mkdir -p $TARGET_DIR
+    VERSION=v$VPP_BRANCH
+    rm ./static/docs/vpp/latest
+    ln -s $VERSION ./static/docs/vpp/latest
+fi
+
+# Create a branch for the commit
+git checkout -b $VERSION
+git branch
+
+# Copy the docs
+cp -r $SRC_DIR $TARGET_DIR
+
+# Create the feature list
+pushd ..
+source ./docs/venv/bin/activate
+find . -name FEATURE.yaml | ./src/scripts/fts.py --markdown > site/content/vppProject/vppfeatures/features.md
+deactivate
+popd
+
+# Push the new docs
+git add "*"
+git commit -s -m "Publish docs from VPP $VERSION"
+git push origin "$VERSION"
+
+exit 0
diff --git a/docs/_scripts/siphon-generate b/docs/_scripts/siphon-generate
new file mode 100755
index 00000000000..9b69c52cf17
--- /dev/null
+++ b/docs/_scripts/siphon-generate
@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Looks for preprocessor macros with struct initializers and siphons them
+# off into another file for later parsing; ostensibly to generate
+# documentation from struct initializer data.
+
+import argparse
+import logging
+import os
+
+import siphon
+
+DEFAULT_LOGFILE = None
+DEFAULT_LOGLEVEL = "info"
+DEFAULT_OUTPUT = "build-root/docs/siphons"
+DEFAULT_PREFIX = os.getcwd()
+
+ap = argparse.ArgumentParser()
+ap.add_argument("--log-file", default=DEFAULT_LOGFILE,
+                help="Log file [%s]" % DEFAULT_LOGFILE)
+ap.add_argument("--log-level", default=DEFAULT_LOGLEVEL,
+                choices=["debug", "info", "warning", "error", "critical"],
+                help="Logging level [%s]" % DEFAULT_LOGLEVEL)
+
+ap.add_argument("--output", '-o', metavar="directory", default=DEFAULT_OUTPUT,
+                help="Output directory for .siphon files [%s]" %
+                     DEFAULT_OUTPUT)
+ap.add_argument("--input-prefix", metavar="path", default=DEFAULT_PREFIX,
+                help="Prefix to strip from input pathnames [%s]" %
+                     DEFAULT_PREFIX)
+ap.add_argument("input", nargs='+', metavar="input_file",
+                help="Input C source files")
+args = ap.parse_args()
+
+logging.basicConfig(filename=args.log_file,
+                    level=getattr(logging, args.log_level.upper(), None))
+log = logging.getLogger("siphon_generate")
+
+
+generate = siphon.generate.Generate(output_directory=args.output,
+                                    input_prefix=args.input_prefix)
+
+# Pre-process file names in case they indicate a file with
+# a list of files
+files = []
+for filename in args.input:
+    if filename.startswith('@'):
+        with open(filename[1:], 'r') as fp:
+            lines = fp.readlines()
+            for line in lines:
+                file = line.strip()
+                if file not in files:
+                    files.append(file)
+            lines = None
+    else:
+        if filename not in files:
+            files.append(filename)
+
+# Iterate all the input files we've been given
+for filename in files:
+    generate.parse(filename)
+
+# Write the extracted data
+generate.deliver()
+
+# All done
diff --git a/docs/_scripts/siphon-process b/docs/_scripts/siphon-process
new file mode 100755
index 00000000000..cbee1e90786
--- /dev/null
+++ b/docs/_scripts/siphon-process
@@ -0,0 +1,90 @@
+#!/usr/bin/env python3
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Filter for .siphon files that are generated by other filters.
+# The idea is to siphon off certain initializers so that we can better
+# auto-document the contents of that initializer.
+
+import argparse
+import logging
+import os
+import sys
+
+import siphon
+
+DEFAULT_LOGFILE = None
+DEFAULT_LOGLEVEL = "info"
+DEFAULT_SIPHON = "clicmd"
+DEFAULT_FORMAT = "markdown"
+DEFAULT_OUTPUT = None
+DEFAULT_TEMPLATES = os.path.dirname(__file__) + "/siphon_templates"
+DEFAULT_OUTPUT_DIR = os.path.dirname(__file__) + "/siphon_docs"
+DEFAULT_REPO_LINK = "https://github.com/FDio/vpp/blob/master/"
+
+ap = argparse.ArgumentParser()
+ap.add_argument("--log-file", default=DEFAULT_LOGFILE,
+                help="Log file [%s]" % DEFAULT_LOGFILE)
+ap.add_argument("--log-level", default=DEFAULT_LOGLEVEL,
+                choices=["debug", "info", "warning", "error", "critical"],
+                help="Logging level [%s]" % DEFAULT_LOGLEVEL)
+
+ap.add_argument("--type", '-t', metavar="siphon_type", default=DEFAULT_SIPHON,
+                choices=siphon.process.siphons.keys(),
+                help="Siphon type to process [%s]" % DEFAULT_SIPHON)
+ap.add_argument("--format", '-f', default=DEFAULT_FORMAT,
+                choices=siphon.process.formats.keys(),
+                help="Output format to generate [%s]" % DEFAULT_FORMAT)
+ap.add_argument("--output", '-o', metavar="file", default=DEFAULT_OUTPUT,
+                help="Output file (uses stdout if not defined) [%s]" %
+                     DEFAULT_OUTPUT)
+ap.add_argument("--templates", metavar="directory", default=DEFAULT_TEMPLATES,
+                help="Path to render templates directory [%s]" %
+                     DEFAULT_TEMPLATES)
+ap.add_argument("--outdir", metavar="directory", default=DEFAULT_OUTPUT_DIR,
+                help="Path to output rendered parts [%s]" %
+                     DEFAULT_OUTPUT_DIR)
+ap.add_argument("--repolink", metavar="repolink", default=DEFAULT_REPO_LINK,
+                help="Link to public repository [%s]" %
+                     DEFAULT_REPO_LINK)
+ap.add_argument("input", nargs='+', metavar="input_file",
+                help="Input .siphon files")
+args = ap.parse_args()
+
+logging.basicConfig(filename=args.log_file,
+                    level=getattr(logging, args.log_level.upper(), None))
+log = logging.getLogger("siphon_process")
+
+# Determine where to send the generated output
+if args.output is None:
+    out = sys.stdout
+else:
+    out = open(args.output, "w+")
+
+# Get our processor
+klass = siphon.process.siphons[args.type]
+processor = klass(
+    template_directory=args.templates,
+    format=args.format,
+    outdir=args.outdir,
+    repository_link=args.repolink
+)
+
+# Load the input files
+processor.load_json(args.input)
+
+# Process the data
+processor.process(out=out)
+
+# All done
diff --git a/docs/_scripts/siphon/__init__.py b/docs/_scripts/siphon/__init__.py
new file mode 100644
index 00000000000..f6417314d82
--- /dev/null
+++ b/docs/_scripts/siphon/__init__.py
@@ -0,0 +1,24 @@
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Siphon classes
+
+from . import generate
+from . import generate_clicmd
+from . import generate_syscfg
+
+from . import parsers
+from . import process
+from . import process_clicmd
+from . import process_syscfg
diff --git a/docs/_scripts/siphon/generate.py b/docs/_scripts/siphon/generate.py
new file mode 100644
index 00000000000..2ae5a1b6f1b
--- /dev/null
+++ b/docs/_scripts/siphon/generate.py
@@ -0,0 +1,306 @@
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generate .siphon source fragments for later processing
+
+import json
+import logging
+import os
+import re
+
+"""List of (regexp, siphon_name) tuples for matching the start of C
+   initializer blocks in source files. Each siphon class registers
+   themselves on this list."""
+siphon_patterns = []
+
+class Generate(object):
+    """Matches a siphon comment block start"""
+    siphon_block_start = re.compile("^\s*/\*\?\s*(.*)$")
+
+    """Matches a siphon comment block stop"""
+    siphon_block_stop = re.compile("^(.*)\s*\?\*/\s*$")
+
+    """Siphon block directive delimiter"""
+    siphon_block_delimiter = "%%"
+
+    """Matches a siphon block directive such as
+       '%clicmd:group_label Debug CLI%'"""
+    siphon_block_directive = re.compile("(%s)\s*([a-zA-Z0-9_:]+)\s+(.*)\s*(%s)" % \
+            (siphon_block_delimiter, siphon_block_delimiter))
+
+    """Matches the start of an initializer block"""
+    siphon_initializer = re.compile("\s*=")
+
+    """Collated output for each siphon"""
+    output = None
+
+    """Directory prefix to strip from input filenames to keep things tidy."""
+    input_prefix = None
+
+    """List of known siphons"""
+    known_siphons = None
+
+    """Logging handler"""
+    log = None
+
+
+    def __init__(self, output_directory, input_prefix):
+        super(Generate, self).__init__()
+        self.log = logging.getLogger("siphon.generate")
+
+        # Build a list of known siphons
+        self.known_siphons = []
+        for item in siphon_patterns:
+            siphon = item[1]
+            if siphon not in self.known_siphons:
+                self.known_siphons.append(siphon)
+
+        # Setup information for siphons we know about
+        self.output = {}
+        for siphon in self.known_siphons:
+            self.output[siphon] = {
+                    "file": "%s/%s.siphon" % (output_directory, siphon),
+                    "global": {},
+                    "items": [],
+                }
+
+        self.input_prefix = input_prefix
+
+
+    """
+    count open and close braces in str
+    return (0, index) when braces were found and count becomes 0.
+    index indicates the position at which the last closing brace was
+    found.
+    return (-1, -1) if a closing brace is found before any opening one.
+    return (count, -1) if not all opening braces are closed, count is the
+    current depth
+    """
+    def count_braces(self, str, count=0, found=False):
+        for index in range(0, len(str)):
+            if str[index] == '{':
+                count += 1;
+                found = True
+            elif str[index] == '}':
+                if count == 0:
+                    # means we never found an open brace
+                    return (-1, -1)
+                count -= 1;
+
+            if count == 0 and found:
+                return (count, index)
+
+        return (count, -1)
+
+    def parse(self, filename):
+        # Strip the current directory off the start of the
+        # filename for brevity
+        if filename[0:len(self.input_prefix)] == self.input_prefix:
+            filename = filename[len(self.input_prefix):]
+            if filename[0] == "/":
+                filename = filename[1:]
+
+        # Work out the abbreviated directory name
+        directory = os.path.dirname(filename)
+        if directory[0:2] == "./":
+            directory = directory[2:]
+        elif directory[0:len(self.input_prefix)] == self.input_prefix:
+            directory = directory[len(self.input_prefix):]
+        if directory[0] == "/":
+            directory = directory[1:]
+
+        # Open the file and explore its contents...
+        self.log.info("Siphoning from %s." % filename)
+        directives = {}
+        with open(filename) as fd:
+            siphon = None
+            close_siphon = None
+            siphon_block = ""
+            in_block = False
+            line_num = 0
+            siphon_line = 0
+
+            for line in fd:
+                line_num += 1
+                str = line[:-1] # filter \n
+
+                """See if there is a block directive and if so extract it"""
+                def process_block_directive(str, directives):
+                    m = self.siphon_block_directive.search(str)
+                    if m is not None:
+                        k = m.group(2)
+                        v = m.group(3).strip()
+                        directives[k] = v
+                        # Return only the parts we did not match
+                        return str[0:m.start(1)] + str[m.end(4):]
+
+                    return str
+
+                def process_block_prefix(str):
+                    if str.startswith(" * "):
+                        str = str[3:]
+                    elif str == " *":
+                        str = ""
+                    return str
+
+                if not in_block:
+                    # See if the line contains the start of a siphon doc block
+                    m = self.siphon_block_start.search(str)
+                    if m is not None:
+                        in_block = True
+                        t = m.group(1)
+
+                        # Now check if the block closes on the same line
+                        m = self.siphon_block_stop.search(t)
+                        if m is not None:
+                            t = m.group(1)
+                            in_block = False
+
+                        # Check for directives
+                        t = process_block_directive(t, directives)
+
+                        # Filter for normal comment prefixes
+                        t = process_block_prefix(t)
+
+                        # Add what is left
+                        siphon_block += t
+
+                        # Skip to next line
+                        continue
+
+                else:
+                    # Check to see if we have an end block marker
+                    m = self.siphon_block_stop.search(str)
+                    if m is not None:
+                        in_block = False
+                        t = m.group(1)
+                    else:
+                        t = str
+
+                    # Check for directives
+                    t = process_block_directive(t, directives)
+
+                    # Filter for normal comment prefixes
+                    t = process_block_prefix(t)
+
+                    # Add what is left
+                    siphon_block += t + "\n"
+
+                    # Skip to next line
+                    continue
+
+
+                if siphon is None:
+                    # Look for blocks we need to siphon
+                    for p in siphon_patterns:
+                        if p[0].match(str):
+                            siphon = [ p[1], str + "\n", 0 ]
+                            siphon_line = line_num
+
+                            # see if we have an initializer
+                            m = self.siphon_initializer.search(str)
+                            if m is not None:
+                                # count the braces on this line
+                                (count, index) = \
+                                    self.count_braces(str[m.start():])
+                                siphon[2] = count
+                                # TODO - it's possible we have the
+                                # initializer all on the first line
+                                # we should check for it, but also
+                                # account for the possibility that
+                                # the open brace is on the next line
+                                #if count == 0:
+                                #    # braces balanced
+                                #    close_siphon = siphon
+                                #    siphon = None
+                            else:
+                                # no initializer: close the siphon right now
+                                close_siphon = siphon
+                                siphon = None
+                else:
+                    # See if we should end the siphon here - do we have
+                    # balanced braces?
+                    (count, index) = self.count_braces(str,
+                            count=siphon[2], found=True)
+                    if count == 0:
+                        # braces balanced - add the substring and
+                        # close the siphon
+                        siphon[1] += str[:index+1] + ";\n"
+                        close_siphon = siphon
+                        siphon = None
+                    else:
+                        # add the whole string, move on
+                        siphon[2] = count
+                        siphon[1] += str + "\n"
+
+                if close_siphon is not None:
+                    # Write the siphoned contents to the right place
+                    siphon_name = close_siphon[0]
+
+                    # Copy directives for the file
+                    details = {}
+                    for key in directives:
+                        if ":" in key:
+                            (sn, label) = key.split(":")
+                            if sn == siphon_name:
+                                details[label] = directives[key]
+                        else:
+                            details[key] = directives[key]
+
+                    # Copy details for this block
+                    details['file'] = filename
+                    details['directory'] = directory
+                    details['line_start'] = siphon_line
+                    details['line_end'] = line_num
+                    details['siphon_block'] = siphon_block.strip()
+                    details["block"] = close_siphon[1]
+
+                    # Store the item
+                    self.output[siphon_name]['items'].append(details)
+
+                    # All done
+                    close_siphon = None
+                    siphon_block = ""
+
+            # Update globals
+            for key in directives.keys():
+                if ':' not in key:
+                    continue
+
+                if filename.endswith("/dir.dox"):
+                    # very special! use the parent directory name
+                    l = directory
+                else:
+                    l = filename
+
+                (sn, label) = key.split(":")
+
+                if sn not in self.output:
+                    self.output[sn] = {}
+                if 'global' not in self.output[sn]:
+                    self.output[sn]['global'] = {}
+                if l not in self.output[sn]['global']:
+                    self.output[sn]['global'][l] = {}
+
+                self.output[sn]['global'][l][label] = directives[key]
+
+    def deliver(self):
+        # Write out the data
+        for siphon in self.output.keys():
+            self.log.info("Saving siphon data %s." % siphon)
+            s = self.output[siphon]
+            with open(s['file'], "a") as fp:
+                json.dump(s, fp,
+                    separators=(',', ': '), indent=4, sort_keys=True)
+
diff --git a/docs/_scripts/siphon/generate_clicmd.py b/docs/_scripts/siphon/generate_clicmd.py
new file mode 100644
index 00000000000..6d24aaf4926
--- /dev/null
+++ b/docs/_scripts/siphon/generate_clicmd.py
@@ -0,0 +1,24 @@
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+
+from . import generate
+
+# Register our regexp
+generate.siphon_patterns.append((
+    re.compile("(?PVLIB_CLI_COMMAND)\s*"
+        "[(](?P[a-zA-Z0-9_]+)(,[^)]*)?[)]"),
+    "clicmd"
+))
diff --git a/docs/_scripts/siphon/generate_syscfg.py b/docs/_scripts/siphon/generate_syscfg.py
new file mode 100644
index 00000000000..52c802e5752
--- /dev/null
+++ b/docs/_scripts/siphon/generate_syscfg.py
@@ -0,0 +1,24 @@
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+
+from . import generate
+
+# Register our regexp
+generate.siphon_patterns.append((
+    re.compile("(?PVLIB_CONFIG_FUNCTION)\s*"
+        '[(](?P[a-zA-Z0-9_]+)\s*,\s*"(?P[^"]*)"[)]'),
+    "syscfg"
+))
diff --git a/docs/_scripts/siphon/parsers.py b/docs/_scripts/siphon/parsers.py
new file mode 100644
index 00000000000..162205de4ca
--- /dev/null
+++ b/docs/_scripts/siphon/parsers.py
@@ -0,0 +1,150 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import html
+import pyparsing as pp
+
+# Some useful primitives
+ident = pp.Word(pp.alphas + "_", pp.alphas + pp.nums + "_")
+intNum = pp.Word(pp.nums)
+hexNum = pp.Literal("0x") + pp.Word(pp.hexnums)
+octalNum = pp.Literal("0") + pp.Word("01234567")
+integer = (hexNum | octalNum | intNum) + \
+    pp.Optional(pp.Literal("ULL") | pp.Literal("LL") | pp.Literal("L"))
+floatNum = pp.Regex(r'\d+(\.\d*)?([eE]\d+)?') + pp.Optional(pp.Literal("f"))
+char = pp.Literal("'") + pp.Word(pp.printables, exact=1) + pp.Literal("'")
+arrayIndex = integer | ident
+
+lbracket = pp.Literal("(").suppress()
+rbracket = pp.Literal(")").suppress()
+lbrace = pp.Literal("{").suppress()
+rbrace = pp.Literal("}").suppress()
+comma = pp.Literal(",").suppress()
+equals = pp.Literal("=").suppress()
+dot = pp.Literal(".").suppress()
+semicolon = pp.Literal(";").suppress()
+
+# initializer := { [member = ] (variable | expression | { initializer } ) }
+typeName = ident
+varName = ident
+typeSpec = pp.Optional("unsigned") + \
+           pp.oneOf("int long short float double char u8 i8 void") + \
+           pp.Optional(pp.Word("*"), default="")
+typeCast = pp.Combine( "(" + ( typeSpec | typeName ) + ")" ).suppress()
+
+string = pp.Combine(pp.OneOrMore(pp.QuotedString(quoteChar='"',
+    escChar='\\', multiline=True)), adjacent=False)
+literal = pp.Optional(typeCast) + (integer | floatNum | char | string)
+var = pp.Combine(pp.Optional(typeCast) + varName +
+    pp.Optional("[" + arrayIndex + "]"))
+
+# This could be more complete, but suffices for our uses
+expr = (literal | var)
+
+"""Parse and render a block of text into a Python dictionary."""
+class Parser(object):
+    """Compiled PyParsing BNF"""
+    _parser = None
+
+    def __init__(self):
+        super(Parser, self).__init__()
+        self._parser = self.BNF()
+
+    def BNF(self):
+        raise NotImplementedError
+
+    def item(self, item):
+        raise NotImplementedError
+
+    def parse(self, input):
+        item = self._parser.parseString(input).asList()
+        return self.item(item)
+
+
+"""Parser for function-like macros - without the closing semi-colon."""
+class ParserFunctionMacro(Parser):
+    def BNF(self):
+        # VLIB_CONFIG_FUNCTION (unix_config, "unix")
+        macroName = ident
+        params = pp.Group(pp.ZeroOrMore(expr + comma) + expr)
+        macroParams = lbracket + params + rbracket
+
+        return macroName + macroParams
+
+    def item(self, item):
+        r = {
+            "macro": item[0],
+            "name": item[1][1],
+            "function": item[1][0],
+        }
+
+        return r
+
+
+"""Parser for function-like macros with a closing semi-colon."""
+class ParseFunctionMacroStmt(ParserFunctionMacro):
+    def BNF(self):
+        # VLIB_CONFIG_FUNCTION (unix_config, "unix");
+        function_macro = super(ParseFunctionMacroStmt, self).BNF()
+        mi = function_macro + semicolon
+        mi.ignore(pp.cppStyleComment)
+
+        return mi
+
+
+"""
+Parser for our struct initializers which are composed from a
+function-like macro, equals sign, and then a normal C struct initializer
+block.
+"""
+class MacroInitializer(ParserFunctionMacro):
+    def BNF(self):
+        # VLIB_CLI_COMMAND (show_sr_tunnel_command, static) = {
+        #    .path = "show sr tunnel",
+        #    .short_help = "show sr tunnel [name ]",
+        #    .function = show_sr_tunnel_fn,
+        # };
+        cs = pp.Forward()
+
+
+        member = pp.Combine(dot + varName + pp.Optional("[" + arrayIndex + "]"),
+            adjacent=False)
+        value = (expr | cs)
+
+        entry = pp.Group(pp.Optional(member + equals, default="") + value)
+        entries = (pp.ZeroOrMore(entry + comma) + entry + pp.Optional(comma)) | \
+                  (pp.ZeroOrMore(entry + comma))
+
+        cs << (lbrace + entries + rbrace)
+
+        macroName = ident
+        params = pp.Group(pp.ZeroOrMore(expr + comma) + expr)
+        macroParams = lbracket + params + rbracket
+
+        function_macro = super(MacroInitializer, self).BNF()
+        mi = function_macro + equals + pp.Group(cs) + semicolon
+        mi.ignore(pp.cppStyleComment)
+
+        return mi
+
+    def item(self, item):
+        r = {
+            "macro": item[0],
+            "name": item[1][0],
+            "params": item[2],
+            "value": {},
+        }
+
+        for param in item[2]:
+            r["value"][param[0]] = html.escape(param[1])
+
+        return r
diff --git a/docs/_scripts/siphon/process.py b/docs/_scripts/siphon/process.py
new file mode 100644
index 00000000000..e3a70152487
--- /dev/null
+++ b/docs/_scripts/siphon/process.py
@@ -0,0 +1,407 @@
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generation template class
+
+import html.parser
+import json
+import logging
+import os
+import sys
+import re
+
+import jinja2
+
+# Classes register themselves in this dictionary
+"""Mapping of known processors to their classes"""
+siphons = {}
+
+"""Mapping of known output formats to their classes"""
+formats = {}
+
+
+class Siphon(object):
+    """Generate rendered output for siphoned data."""
+
+    # Set by subclasses
+    """Our siphon name"""
+    name = None
+
+    # Set by subclasses
+    """Name of an identifier used by this siphon"""
+    identifier = None
+
+    # Set by subclasses
+    """The pyparsing object to use to parse with"""
+    _parser = None
+
+    """The input data"""
+    _cmds = None
+
+    """Group key to (directory,file) mapping"""
+    _group = None
+
+    """Logging handler"""
+    log = None
+
+    """Directory to look for siphon rendering templates"""
+    template_directory = None
+
+    """Directory to output parts in"""
+    outdir = None
+
+    """Template environment, if we're using templates"""
+    _tplenv = None
+
+    def __init__(self, template_directory, format, outdir, repository_link):
+        super(Siphon, self).__init__()
+        self.log = logging.getLogger("siphon.process.%s" % self.name)
+
+        # Get our output format details
+        fmt_klass = formats[format]
+        fmt = fmt_klass()
+        self._format = fmt
+
+        # Sort out the template search path
+        def _tpldir(name):
+            return os.sep.join((template_directory, fmt.name, name))
+
+        self.template_directory = template_directory
+        searchpath = [
+            _tpldir(self.name),
+            _tpldir("default"),
+        ]
+        self.outdir = outdir
+        loader = jinja2.FileSystemLoader(searchpath=searchpath)
+        self._tplenv = jinja2.Environment(
+            loader=loader,
+            trim_blocks=True,
+            autoescape=False,
+            keep_trailing_newline=True)
+
+        # Convenience, get a reference to the internal escape and
+        # unescape methods in html.parser. These then become
+        # available to templates to use, if needed.
+        self._h = html.parser.HTMLParser()
+        self.escape = html.escape
+        self.unescape = html.unescape
+
+        # TODO: customize release
+        self.repository_link = repository_link
+
+    # Output renderers
+
+    """Returns an object to be used as the sorting key in the item index."""
+    def index_sort_key(self, group):
+        return group
+
+    """Returns a string to use as the header at the top of the item index."""
+    def index_header(self):
+        return self.template("index_header")
+
+    """Returns the string fragment to use for each section in the item
+    index."""
+    def index_section(self, group):
+        return self.template("index_section", group=group)
+
+    """Returns the string fragment to use for each entry in the item index."""
+    def index_entry(self, meta, item):
+        return self.template("index_entry", meta=meta, item=item)
+
+    """Returns an object, typically a string, to be used as the sorting key
+    for items within a section."""
+    def item_sort_key(self, item):
+        return item['name']
+
+    """Returns a key for grouping items together."""
+    def group_key(self, directory, file, macro, name):
+        _global = self._cmds['_global']
+
+        if file in _global and 'group_label' in _global[file]:
+            self._group[file] = (directory, file)
+            return file
+
+        self._group[directory] = (directory, None)
+        return directory
+
+    """Returns a key for identifying items within a grouping."""
+    def item_key(self, directory, file, macro, name):
+        return name
+
+    """Returns a string to use as the header when rendering the item."""
+    def item_header(self, group):
+        return self.template("item_header", group=group)
+
+    """Returns a string to use as the body when rendering the item."""
+    def item_format(self, meta, item):
+        return self.template("item_format", meta=meta, item=item)
+
+    """Returns a string to use as the label for the page reference."""
+    def page_label(self, group):
+        return "_".join((
+            self.name,
+            self.sanitize_label(group)
+        ))
+
+    """Returns a title to use for a page."""
+    def page_title(self, group):
+        _global = self._cmds['_global']
+        (directory, file) = self._group[group]
+
+        if file and file in _global and 'group_label' in _global[file]:
+            return _global[file]['group_label']
+
+        if directory in _global and 'group_label' in _global[directory]:
+            return _global[directory]['group_label']
+
+        return directory
+
+    """Returns a string to use as the label for the section reference."""
+    def item_label(self, group, item):
+        return "__".join((
+            self.name,
+            item
+        ))
+
+    """Label sanitizer; for creating Doxygen references"""
+    def sanitize_label(self, value):
+        return value.replace(" ", "_") \
+                    .replace("/", "_") \
+                    .replace(".", "_")
+
+    """Template processor"""
+    def template(self, name, **kwargs):
+        tpl = self._tplenv.get_template(name + self._format.extension)
+        return tpl.render(
+            this=self,
+            **kwargs)
+
+    # Processing methods
+
+    """Parse the input file into a more usable dictionary structure."""
+    def load_json(self, files):
+        self._cmds = {}
+        self._group = {}
+
+        line_num = 0
+        line_start = 0
+        for filename in files:
+            filename = os.path.relpath(filename)
+            self.log.info("Parsing items in file \"%s\"." % filename)
+            data = None
+            with open(filename, "r") as fd:
+                data = json.load(fd)
+
+            self._cmds['_global'] = data['global']
+
+            # iterate the items loaded and regroup it
+            for item in data["items"]:
+                try:
+                    o = self._parser.parse(item['block'])
+                except Exception:
+                    self.log.error("Exception parsing item: %s\n%s"
+                                   % (json.dumps(item, separators=(',', ': '),
+                                                 indent=4),
+                                      item['block']))
+                    raise
+
+                # Augment the item with metadata
+                o["meta"] = {}
+                for key in item:
+                    if key == 'block':
+                        continue
+                    o['meta'][key] = item[key]
+
+                # Load some interesting fields
+                directory = item['directory']
+                file = item['file']
+                macro = o["macro"]
+                name = o["name"]
+
+                # Generate keys to group items by
+                group_key = self.group_key(directory, file, macro, name)
+                item_key = self.item_key(directory, file, macro, name)
+
+                if group_key not in self._cmds:
+                    self._cmds[group_key] = {}
+
+                self._cmds[group_key][item_key] = o
+
+    """Iterate over the input data, calling render methods to generate the
+    output."""
+    def process(self, out=None):
+
+        if out is None:
+            out = sys.stdout
+
+        # Accumulated body contents
+        contents = ""
+
+        # Write the header for this siphon type
+        out.write(self.index_header())
+
+        # Sort key helper for the index
+        def group_sort_key(group):
+            return self.index_sort_key(group)
+
+        # Iterate the dictionary and process it
+        for group in sorted(self._cmds.keys(), key=group_sort_key):
+            if group.startswith('_'):
+                continue
+
+            self.log.info("Processing items in group \"%s\" (%s)." %
+                          (group, group_sort_key(group)))
+
+            # Generate the section index entry (write it now)
+            out.write(self.index_section(group))
+
+            # Generate the item header (save for later)
+            contents += self.item_header(group)
+
+            def item_sort_key(key):
+                return self.item_sort_key(self._cmds[group][key])
+
+            for key in sorted(self._cmds[group].keys(), key=item_sort_key):
+                self.log.debug("--- Processing key \"%s\" (%s)." %
+                               (key, item_sort_key(key)))
+
+                o = self._cmds[group][key]
+                meta = {
+                    "directory": o['meta']['directory'],
+                    "file": o['meta']['file'],
+                    "macro": o['macro'],
+                    "name": o['name'],
+                    "key": key,
+                    "label": self.item_label(group, key),
+                }
+
+                # Generate the index entry for the item (write it now)
+                out.write(self.index_entry(meta, o))
+
+                # Generate the item itself (save for later)
+                contents += self.item_format(meta, o)
+
+            page_name = self.separate_page_names(group)
+            if page_name != "":
+                path = os.path.join(self.outdir, page_name)
+                with open(path, "w+") as page:
+                    page.write(contents)
+                contents = ""
+
+        # Deliver the accumulated body output
+        out.write(contents)
+
+    def do_cliexstart(self, matchobj):
+        title = matchobj.group(1)
+        title = ' '.join(title.splitlines())
+        content = matchobj.group(2)
+        content = re.sub(r"\n", r"\n    ", content)
+        return "\n\n.. code-block:: console\n\n    %s\n    %s\n\n" % (title, content)
+
+    def do_clistart(self, matchobj):
+        content = matchobj.group(1)
+        content = re.sub(r"\n", r"\n    ", content)
+        return "\n\n.. code-block:: console\n\n    %s\n\n" % content
+
+    def do_cliexcmd(self, matchobj):
+        content = matchobj.group(1)
+        content = ' '.join(content.splitlines())
+        return "\n\n.. code-block:: console\n\n    %s\n\n" % content
+
+    def process_list(self, matchobj):
+        content = matchobj.group(1)
+        content = self.reindent(content, 2)
+        return "@@@@%s\nBBBB" % content
+
+    def process_special(self, s):
+        # ----------- markers to remove
+        s = re.sub(r"@cliexpar\s*", r"", s)
+        s = re.sub(r"@parblock\s*", r"", s)
+        s = re.sub(r"@endparblock\s*", r"", s)
+        s = re.sub(r"
", "", s)
+        # ----------- emphasis
+        # 
+        s = re.sub(r"\s*", "``", s)
+        s = re.sub(r"\s*", "``", s)
+        s = re.sub(r"\s*", "``", s)
+        # 
+        s = re.sub(r"\s*", "**", s)
+        s = re.sub(r"\s*", "**", s)
+        # 
+        s = re.sub(r"\s*", "``", s)
+        s = re.sub(r"\s*", "``", s)
+        # 
+        s = re.sub(r"'?\s*", r"``", s)
+        s = re.sub(r"\s*'?", r"``", s)
+        # @c 
+        s = re.sub(r"@c\s(\S+)", r"``\1``", s)
+        # ----------- todos
+        s = re.sub(r"@todo[^\n]*", "", s)
+        s = re.sub(r"@TODO[^\n]*", "", s)
+        # ----------- code blocks
+        s = re.sub(r"@cliexcmd{(.+?)}", self.do_cliexcmd, s, flags=re.DOTALL)
+        s = re.sub(r"@cliexstart{(.+?)}(.+?)@cliexend", self.do_cliexstart, s, flags=re.DOTALL)
+        s = re.sub(r"@clistart(.+?)@cliend", self.do_clistart, s, flags=re.DOTALL)
+        # ----------- lists
+        s = re.sub(r"^\s*-", r"\n@@@@", s, flags=re.MULTILINE)
+        s = re.sub(r"@@@@(.*?)\n\n+", self.process_list, s, flags=re.DOTALL)
+        s = re.sub(r"BBBB@@@@", r"-", s)
+        s = re.sub(r"@@@@", r"-", s)
+        s = re.sub(r"BBBB", r"\n\n", s)
+        # ----------- Cleanup remains
+        s = re.sub(r"@cliexend\s*", r"", s)
+        return s
+
+    def separate_page_names(self, group):
+        return ""
+
+    # This push the given textblock  spaces right
+    def reindent(self, s, indent):
+        ind = " " * indent
+        s = re.sub(r"\n", "\n" + ind, s)
+        return s
+
+    # This aligns the given textblock left (no indent)
+    def noindent(self, s):
+        s = re.sub(r"\n[ \f\v\t]*", "\n", s)
+        return s
+
+class Format(object):
+    """Output format class"""
+
+    """Name of this output format"""
+    name = None
+
+    """Expected file extension of templates that build this format"""
+    extension = None
+
+
+class FormatMarkdown(Format):
+    """Markdown output format"""
+    name = "markdown"
+    extension = ".md"
+
+
+# Register 'markdown'
+formats["markdown"] = FormatMarkdown
+
+
+class FormatItemlist(Format):
+    """Itemlist output format"""
+    name = "itemlist"
+    extension = ".itemlist"
+
+
+# Register 'itemlist'
+formats["itemlist"] = FormatItemlist
diff --git a/docs/_scripts/siphon/process_clicmd.py b/docs/_scripts/siphon/process_clicmd.py
new file mode 100644
index 00000000000..bf270518ad1
--- /dev/null
+++ b/docs/_scripts/siphon/process_clicmd.py
@@ -0,0 +1,73 @@
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generate clicmd formatted output
+
+from . import process, parsers
+import os
+
+class SiphonCLICMD(process.Siphon):
+
+    name = "clicmd"
+    identifier = "VLIB_CLI_COMMAND"
+
+    def __init__(self, *args, **kwargs):
+        super(SiphonCLICMD, self).__init__(*args, **kwargs)
+        self._parser = parsers.MacroInitializer()
+
+    # Output renderers
+
+    def separate_page_names(self, group):
+        return self.page_label(group) + ".rst"
+
+    def index_sort_key(self, group):
+        _global = self._cmds['_global']
+        if group not in self._group:
+            return group
+        (directory, file) = self._group[group]
+
+        if file in _global and 'group_label' in _global[file]:
+            return _global[file]['group_label']
+
+        if directory in _global and 'group_label' in _global[directory]:
+            return _global[directory]['group_label']
+
+        return group
+
+    def item_sort_key(self, item):
+        return item['value']['path']
+
+    def item_label(self, group, item):
+        return "_".join((
+            self.name,
+            self.sanitize_label(self._cmds[group][item]['value']['path'])
+        ))
+
+    def page_title(self, group):
+        _global = self._cmds['_global']
+        (directory, file) = self._group[group]
+
+        if file and file in _global and 'group_label' in _global[file]:
+            return _global[file]['group_label']
+
+        if directory in _global and 'group_label' in _global[directory]:
+            return _global[directory]['group_label']
+
+        file_ext = os.path.basename(directory)
+        fname, ext = os.path.splitext(file_ext)
+        return "%s cli reference" % fname.capitalize()
+
+
+# Register our processor
+process.siphons["clicmd"] = SiphonCLICMD
diff --git a/docs/_scripts/siphon/process_syscfg.py b/docs/_scripts/siphon/process_syscfg.py
new file mode 100644
index 00000000000..bccde2c153d
--- /dev/null
+++ b/docs/_scripts/siphon/process_syscfg.py
@@ -0,0 +1,31 @@
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generate syscfg formatted output
+
+from . import process, parsers
+
+
+class SiphonSYSCFG(process.Siphon):
+
+    name = "syscfg"
+    identifier = "VLIB_CONFIG_FUNCTION"
+
+    def __init__(self, *args, **kwargs):
+        super(SiphonSYSCFG, self).__init__(*args, **kwargs)
+        self._parser = parsers.ParseFunctionMacroStmt()
+
+
+# Register our processor
+process.siphons["syscfg"] = SiphonSYSCFG
diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md b/docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md
new file mode 100644
index 00000000000..de517f160c1
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/clicmd/index_entry.md
@@ -0,0 +1,15 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
\ No newline at end of file
diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/index_header.md b/docs/_scripts/siphon_templates/markdown/clicmd/index_header.md
new file mode 100644
index 00000000000..86e5bb6c3e5
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/clicmd/index_header.md
@@ -0,0 +1,23 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+.. _cmdreference:
+
+Reference
+=========
+
+.. toctree::
+    :maxdepth: 2
+
diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/index_section.md b/docs/_scripts/siphon_templates/markdown/clicmd/index_section.md
new file mode 100644
index 00000000000..0da934ac938
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/clicmd/index_section.md
@@ -0,0 +1,16 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+    clis/{{ this.page_label(group) }}
diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md b/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md
new file mode 100644
index 00000000000..f1caa961f56
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/clicmd/item_format.md
@@ -0,0 +1,62 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+{% set v = item['value'] %}
+{% if 'short_help' in v %}
+{% set str = v['short_help'] %}
+{% set str = this.unescape(str) %}
+
+{# Summary/usage #}
+{{ item['value']['path'] }}
+-------------------------------------------------------------------------
+
+.. code-block:: console
+
+    {{ this.reindent(str, 4) }}
+
+{% endif %}
+{% if 'long_help' in v %}
+{% set long_help = v['long_help'] %}
+{% set long_help = this.unescape(long_help) %}
+{# This is seldom used and will likely be deprecated #}
+{# Long help #}
+.. code-block:: console
+
+    {{ this.reindent(long_help, 4) }}
+
+{% endif %}
+{% if 'siphon_block' in item['meta'] %}
+{% set sb = item["meta"]["siphon_block"] %}
+{% set sb = this.process_special(sb) %}
+{% if sb %}
+{# Extracted from the code in /*? ... ?*/ blocks #}
+
+{# Description #}
+
+{{ sb }}
+{% endif %}
+{% endif %}
+{% if 'name' in meta or 'function' in v %}
+{# Gives some developer-useful linking #}
+
+{% if "name" in meta %}
+Declaration: ``{{ meta['name'] }}`` `{{ meta["file"] }} line {{ item["meta"]["line_start"] }} <{{ this.repository_link }}{{ meta["file"] }}#L{{ item["meta"]["line_start"] }}>`_
+{% endif %}
+{% if "function" in v %}
+
+Implementation: ``{{ v["function"] }}``
+{% endif %}
+{% endif %}
+
diff --git a/docs/_scripts/siphon_templates/markdown/clicmd/item_header.md b/docs/_scripts/siphon_templates/markdown/clicmd/item_header.md
new file mode 100644
index 00000000000..20e4803ec2e
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/clicmd/item_header.md
@@ -0,0 +1,20 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+.. _{{ this.page_label(group) }}:
+
+===============================================================
+{{ this.page_title(group) }}
+===============================================================
diff --git a/docs/_scripts/siphon_templates/markdown/default/index_entry.md b/docs/_scripts/siphon_templates/markdown/default/index_entry.md
new file mode 100644
index 00000000000..479dcdb2cc3
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/default/index_entry.md
@@ -0,0 +1,16 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+{{ "* [%s](@ref %s)" % (item["name"], meta["label"]) }}
diff --git a/docs/_scripts/siphon_templates/markdown/default/index_section.md b/docs/_scripts/siphon_templates/markdown/default/index_section.md
new file mode 100644
index 00000000000..3c9d2b474c5
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/default/index_section.md
@@ -0,0 +1,18 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+
+@subpage {{ this.page_label(group) }}
+
diff --git a/docs/_scripts/siphon_templates/markdown/default/item_format.md b/docs/_scripts/siphon_templates/markdown/default/item_format.md
new file mode 100644
index 00000000000..ed1b1bf7eeb
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/default/item_format.md
@@ -0,0 +1,16 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+{{ raise NotImplementedError }}
diff --git a/docs/_scripts/siphon_templates/markdown/default/item_header.md b/docs/_scripts/siphon_templates/markdown/default/item_header.md
new file mode 100644
index 00000000000..0c21e51fa5d
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/default/item_header.md
@@ -0,0 +1,18 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+
+{{ "@page %s %s" % (this.page_label(group), this.page_title(group)) }}
+
diff --git a/docs/_scripts/siphon_templates/markdown/syscfg/index_header.md b/docs/_scripts/siphon_templates/markdown/syscfg/index_header.md
new file mode 100644
index 00000000000..f5a9816b99c
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/syscfg/index_header.md
@@ -0,0 +1,111 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+# Startup Configuration    {{'{#'}}syscfg}
+
+The VPP network stack comes with several configuration options that can be
+provided either on the command line or in a configuration file.
+
+Specific applications built on the stack have been known to require a dozen
+arguments, depending on requirements. This section describes commonly-used
+options and parameters.
+
+You can find command-line argument parsers in the source code by searching for
+instances of the `VLIB_CONFIG_FUNCTION` macro. The invocation
+`VLIB_CONFIG_FUNCTION(foo_config, "foo")` will cause the function
+`foo_config` to receive all the options and values supplied in a parameter
+block named "`foo`", for example: `foo { arg1 arg2 arg3 ... }`.
+
+@todo Tell the nice people where this document lives so that the might
+help improve it!
+
+## Command-line arguments
+
+Parameters are grouped by a section name. When providing more than one
+parameter to a section all parameters for that section must be wrapped in
+curly braces.
+
+```
+/usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
+```
+
+Which will produce output similar to this:
+
+    
+        _______    _        _   _____  ___ 
+     __/ __/ _ \  (_)__    | | / / _ \/ _ \
+     _/ _// // / / / _ \   | |/ / ___/ ___/
+     /_/ /____(_)_/\___/   |___/_/  /_/    
+    
+    vpp# 
+
+When providing only one such parameter the braces are optional. For example,
+the following command argument, `unix interactive` does not have braces:
+
+```
+/usr/bin/vpp unix interactive
+```
+
+The command line can be presented as a single string or as several; anything
+given on the command line is concatenated with spaces into a single string
+before parsing.
+
+VPP applications must be able to locate their own executable images. The
+simplest way to ensure this will work is to invoke a VPP application by giving
+its absolute path; for example: `/usr/bin/vpp `. At startup, VPP
+applications parse through their own ELF-sections (primarily) to make lists
+of init, configuration, and exit handlers.
+
+When developing with VPP, in _gdb_ it's often sufficient to start an application
+like this at the `(gdb)` prompt:
+
+```
+run unix interactive
+```
+
+## Configuration file
+
+It is also possible to supply parameters in a startup configuration file the
+path of which is provided to the VPP application on its command line.
+
+The format of the configuration file is a simple text file with the same
+content as the command line but with the benefit of being able to use newlines
+to make the content easier to read. For example:
+
+```
+unix {
+  nodaemon
+  log /var/log/vpp/vpp.log
+  full-coredump
+  cli-listen localhost:5002
+}
+api-trace {
+  on
+}
+dpdk {
+  dev 0000:03:00.0
+}
+```
+
+VPP is then instructed to load this file with the `-c` option:
+
+```
+/usr/bin/vpp -c /etc/vpp/startup.conf
+```
+
+## Index of startup command sections
+
+[TOC]
+
diff --git a/docs/_scripts/siphon_templates/markdown/syscfg/item_format.md b/docs/_scripts/siphon_templates/markdown/syscfg/item_format.md
new file mode 100644
index 00000000000..53136115bbc
--- /dev/null
+++ b/docs/_scripts/siphon_templates/markdown/syscfg/item_format.md
@@ -0,0 +1,42 @@
+{#
+# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#}
+{% set v = item['value'] %}
+{{ "@section %s %s" % (meta['label'], item['name']) }}
+{% if 'siphon_block' in item['meta'] %}
+{% set sb = item["meta"]["siphon_block"] %}
+{% if sb %}
+{# Extracted from the code in /*? ... ?*/ blocks #}
+
+### Description
+
+{{ sb }}
+{% endif %}
+{% endif %}
+{% if "name" in meta or "function" in item %}
+{# Gives some developer-useful linking #}
+
+### Declaration and implementation
+{% if "name" in meta %}
+
+{{ "Declaration: @ref %s (@ref %s line %d)" %
+   (meta['name'], meta["file"], item["meta"]["line_start"]) }}
+{% endif %}
+{% if "function" in item %}
+
+{{ "Implementation: @ref %s." % item["function"] }}
+{% endif %}
+{% endif %}
+
diff --git a/docs/about.rst b/docs/about.rst
deleted file mode 100644
index dc04d09d0fc..00000000000
--- a/docs/about.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. _about:
-
-=====
-About
-=====
-
-**VPP Version:** 21.10-rc0~204-g13e841847
-
-**Built on:** Thu Jul 22 23:44:06 GMT 2021
diff --git a/docs/aboutvpp/developer.rst b/docs/aboutvpp/developer.rst
new file mode 100644
index 00000000000..cc5783da51c
--- /dev/null
+++ b/docs/aboutvpp/developer.rst
@@ -0,0 +1,29 @@
+.. _developer-friendly:
+
+===================
+Additional features
+===================
+
+This section describes a little about the VPP environment and some of the features
+that can be used by developers.
+
+* Extensive runtime counters; throughput, `intructions per cycle `_, errors, events etc.
+* Integrated pipeline tracing facilities
+* Multi-language API bindings
+* Integrated command line for debugging
+* Fault-tolerant and upgradable
+
+  * Runs as a standard user-space process for fault tolerance, software crashes seldom require more than a process restart. 
+  * Improved fault-tolerance and upgradability when compared to running similar packet processing in the kernel, software updates never require system reboots. 
+  * Development experience is easier compared to similar kernel code
+  * Hardware isolation and protection (`iommu `_)
+
+* Built for security
+
+  * Extensive white-box testing
+  * Image segment base address randomization
+  * Shared-memory segment base address randomization
+  * Stack bounds checking
+  * Static analysis with `Coverity `_
+
+For the supported architectures click next.
diff --git a/docs/aboutvpp/extensible.rst b/docs/aboutvpp/extensible.rst
new file mode 100644
index 00000000000..adba873ac1c
--- /dev/null
+++ b/docs/aboutvpp/extensible.rst
@@ -0,0 +1,43 @@
+.. _extensible:
+
+===========================
+The Packet Processing Graph
+===========================
+
+At the core of the FD.io VPP design is the **Packet Processing Graph**
+
+This makes the software:
+
+* Pluggable, easy to understand & extend
+* Mature graph node architecture
+* Full control to reorganize the pipeline
+* Fast, plugins are equal citizens
+
+The FD.io VPP packet processing pipeline is decomposed into a ‘packet processing
+graph’.  This modular approach means that anyone can ‘plugin’ new graph
+nodes. This makes VPP easily extensible and means that plugins can be
+customized for specific purposes. VPP is also configurable through it's
+Low-Level API.
+
+.. figure:: /_images/VPP_custom_application_packet_processing_graph.280.jpg
+   :alt: Extensible, modular graph node architecture?
+
+   Extensible and modular graph node architecture.
+
+At runtime, the FD.io VPP platform assembles a vector of packets from RX rings,
+typically up to 256 packets in a single vector. The packet processing graph is
+then applied, node by node (including plugins) to the entire packet vector. The
+received packets typically traverse the packet processing graph nodes in the
+vector, when the network processing represented by each graph node is applied to
+each packet in turn.  Graph nodes are small and modular, and loosely
+coupled. This makes it easy to introduce new graph nodes and rewire existing
+graph nodes.
+
+Plugins are `shared libraries `_
+and are loaded at runtime by VPP. VPP find plugins by searching the plugin path
+for libraries, and then dynamically loads each one in turn on startup.
+A plugin can introduce new graph nodes or rearrange the packet processing graph.
+You can build a plugin completely independently of the FD.io VPP source tree,
+which means you can treat it as an independent component.
+
+For more on the network stack press next.
diff --git a/docs/aboutvpp/hoststack.rst b/docs/aboutvpp/hoststack.rst
new file mode 100644
index 00000000000..b50c715a888
--- /dev/null
+++ b/docs/aboutvpp/hoststack.rst
@@ -0,0 +1,26 @@
+.. _hoststack:
+
+==========
+Host Stack
+==========
+
+VPP’s host stack leverages VPP’s graph based forwarding model and vectorized packet
+processing to ensure high throughput and scale transport protocol termination. It
+exposes apis that apart from allowing for efficient user-space app consumption and
+generation of data, also enables highly efficient local inter-app communication.
+
+At a high level VPP’s host stack consists of 3 major components:
+
+* A session layer that facilitates interaction between transport protocols and applications
+* Pluggable transport protocols, including TCP, QUIC, TLS, UDP
+* VCL (VPPComs library) a set of libraries meant to ease the consumability of the stack from application perspective
+
+All of these components were custom built to fit within VPP’s architecture and to
+leverage its speed. As a result, a significant amount of effort was invested into:
+
+*  building a transport pluggable session layer that abstracts the interaction between applications and transports using a custom-built shared memory infrastructure. Notably, this also allows for transport protocols that are typically implemented in applications, like QUIC and TLS, to be implemented within VPP.
+* a clean slate TCP implementation that supports vectorized packet processing and follows VPP’s highly scalable threading model. The implementation is RFC compliant, supports a high number of high-speed TCP protocol features and it was validated using Defensic’s Codenomicon 1M+ tests suite.
+* VCL, a library that emulates traditional asynchronous communication functions in user-space, all while allowing for new patterns to be developed, if needed.
+* implementing a high performance “cut-through” communication mode that enables applications attached to vpp to transparently exchange data over shared memory without incurring the extra cost of a traditional transport protocol. Testing has shown this to be much more efficient than traditional inter-container networking.
+
+For developer features press next.
diff --git a/docs/aboutvpp/networkstack.rst b/docs/aboutvpp/networkstack.rst
new file mode 100644
index 00000000000..8141d4fe3cb
--- /dev/null
+++ b/docs/aboutvpp/networkstack.rst
@@ -0,0 +1,37 @@
+.. _network-stack:
+
+======================
+Network Stack Features
+======================
+
+This section describes a little about the FD.io network stack and describes some benefits:
+
+* Layer 2 - 4 Network Stack
+
+  * Fast lookup tables for routes, bridge entries
+  * Arbitrary n-tuple classifiers
+  * Control Plane, Traffic Management and Overlays
+
+
+* `Linux `_ and `FreeBSD `_ support
+
+  * Support for standard Operating System Interfaces such as AF_Packet, Tun/Tap & Netmap.
+
+* Network and cryptographic hardware support with `DPDK `_.
+* Container and Virtualization support
+
+  * Para-virtualized interfaces; Vhost and Virtio
+  * Network Adapters over PCI passthrough
+  * Native container interfaces; MemIF
+
+* Host Stack
+* Universal Data Plane: one code base, for many use cases
+
+  * Discrete appliances; such as `Routers `_ and `Switches `_.
+  * `Cloud Infrastructure and Virtual Network Functions `_
+  * `Cloud Native Infrastructure `_
+  * The same binary package for all use cases.
+
+* Out of the box production quality, with thanks to `CSIT `_.
+
+For more on the TCP Host Stack press next.
diff --git a/docs/aboutvpp/performance.rst b/docs/aboutvpp/performance.rst
new file mode 100644
index 00000000000..c818ff60aa0
--- /dev/null
+++ b/docs/aboutvpp/performance.rst
@@ -0,0 +1,70 @@
+.. _performance:
+
+Performance
+===========
+
+One of the benefits of FD.io VPP is it's high performance on relatively low-power computing.
+Included are the following.
+
+* A high-performance user-space network stack designed for commodity hardware:
+
+  - L2, L3 and L4 features and encapsulations.
+
+* Optimized packet interfaces supporting a multitude of use cases:
+
+  - An integrated vhost-user backend for high speed VM-to-VM connectivity
+  - An integrated memif container backend for high speed Container-to-Container connectivity
+  - An integrated vhost based interface to punt packets to the Linux Kernel
+
+* The same optimized code-paths run execute on the host, and inside VMs and Linux containers
+* Leverages best-of-breed open source driver technology: `DPDK `_
+* Tested at scale; linear core scaling, tested with millions of flows and mac addresses
+
+These features have been designed to take full advantage of common micro-processor optimization techniques, such as:
+
+* Reducing cache and TLS misses by processing packets in vectors
+* Realizing `IPC `_ gains with vector instructions such as: SSE, AVX and NEON
+* Eliminating mode switching, context switches and blocking, to always be doing useful work
+* Cache-lined aligned buffers for cache and memory efficiency
+
+
+CSIT
+----
+
+The Continuous System Integration and Testing (CSIT) project provides functional and performance
+testing for FD.io VPP. This testing is focused on functional and performance regressions. The results
+are posted to `CSIT Test Report `_.
+
+For more about CSIT checkout the following links:
+
+* `CSIT Code Documentation `_
+* `CSIT Test Overview `_
+* `VPP Performance Dashboard `_
+
+
+Packet Throughput examples
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Following are pointers to a few of the CSIT test reports. The test's titles read like this:
+
+---
+
+For example the test with the title 64b-2t1c-l2switching-base-i40e is the
+test that does l2 switching using 64 byte packets, 2 threads, 1 core using an i40e
+interface.
+
+Here are a few examples:
+
+* `L2 Ethernet switching `_
+* `IPv4 Routing `_
+* `IPv6 Routing `_
+
+
+Trending Throughput Graphs
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+These are some of the trending packet throughput graphs from the CSIT `trending dashboard `_. **Please note that**, performance in the trending graphs will change on a nightly basis in line with the software development cycle:
+
+* `L2 Ethernet Switching Trending `_
+* `IPv4 Routing Trending `_
+* `IPv6 Routing Trending `_
diff --git a/docs/aboutvpp/releasenotes/index.rst b/docs/aboutvpp/releasenotes/index.rst
new file mode 100644
index 00000000000..694096fcfa8
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/index.rst
@@ -0,0 +1,11 @@
+.. _release_notes:
+
+Release notes
+=============
+
+.. toctree::
+    :maxdepth: 2
+
+    v21.10
+    v21.06
+    past
diff --git a/docs/aboutvpp/releasenotes/past.rst b/docs/aboutvpp/releasenotes/past.rst
new file mode 100644
index 00000000000..2ead5ec5a20
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/past.rst
@@ -0,0 +1,39 @@
+.. _past_releases:
+
+Past releases
+=============
+
+.. toctree::
+    :maxdepth: 1
+
+    v21.01
+    v20.09
+    v20.05.1
+    v20.05
+    v20.01
+    v19.08.3
+    v19.08.2
+    v19.08.1
+    v19.08
+    v19.04.3
+    v19.04.2
+    v19.04.1
+    v19.04
+    v19.01.3
+    v19.01.2
+    v19.01.1
+    v19.01
+    v18.10
+    v18.07
+    v18.04
+    v18.01.2
+    v18.01.1
+    v18.01
+    v17.10
+    v17.07
+    v17.04
+    v17.01.1
+    v17.01
+    v16.09
+    v16.06
+
diff --git a/docs/aboutvpp/releasenotes/v16.06.rst b/docs/aboutvpp/releasenotes/v16.06.rst
new file mode 100644
index 00000000000..400f2b3785c
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v16.06.rst
@@ -0,0 +1,52 @@
+Release notes for VPP 16.06
+===========================
+
+The FD.io Project, relentlessly focused on data IO speed and efficiency
+supporting the creation of high performance, flexible, and scalable
+software defined infrastructures, announces the availability of the
+community’s first software release (16.06).
+
+In the four months since launching, FD.io has brought together more than
+75 developers from 11 different companies including network operators,
+solution providers chip vendors, and network equipment vendors who are
+collaborating to enhance and innovate around the Vector Packet
+Processing (VPP) technology. The FD.io community has quickly formed to
+grow the number of projects from the initial VPP project to an
+additional 6 projects addressing a diverse set of requirements and
+usability across a variety of deployment environments.
+
+The 16.06 release brings unprecedented performance: 480Gbps/200mpps with
+8 million routes and 2k whitelist entries on standard high volume x86
+servers.
+
+Features
+--------
+
+In addition to the existing full suite of vswitch/vrouter features, the
+new 16.06 release adds:
+
+-  Enhanced Switching and Routing:
+
+   -  IPv6 Segment Routing multicast support.
+   -  LISP xTR support.
+   -  VXLAN over IPv6 underlay.
+   -  Per interface whitelists.
+   -  Shared adjacencies in FIB.
+
+-  New and improved interface support:
+
+   -  Jumbo frame support for vhost-user.
+   -  Netmap interface support.
+   -  AF_Packet interface support.
+
+-  Expanded and improved programmability:
+
+   -  Python API bindings.
+   -  Enhanced JVPP Java API bindings.
+   -  Debugging CLI.
+
+-  Expanded Hardware and Software Support:
+
+   -  Support for ARM 32 targets including Rasberry Pi single-board
+      computer.
+   -  Support for DPDK 16.04.
diff --git a/docs/aboutvpp/releasenotes/v16.09.rst b/docs/aboutvpp/releasenotes/v16.09.rst
new file mode 100644
index 00000000000..00179bc67c8
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v16.09.rst
@@ -0,0 +1,252 @@
+Release notes for VPP 16.09
+===========================
+
+Features
+--------
+
+-  `Integrated July 2016 DPDK release `__
+
+   -  DPDK-vhost is depreciated pending a complete rework of the
+      original integration and addressing of rx performance deltas.
+   -  Patches required for DPDK 16.07:
+
+      -  Correctly setting the Packet Type in the IGB, IXGBE and i40e
+         drivers.
+      -  Correctly setting checksum in the i40e driver.
+      -  NXP DPAA2 PMD Driver.
+      -  rte_delay (yield) functionality.
+
+-  Add “in tree” plugins:
+
+   -  IPv6 ILA.
+   -  iOAM.
+   -  Load Balancer.
+   -  SNAT.
+
+-  High-performance (line-rate) “neutron like” L4 port-filtering.
+
+-  API refactoring - addressing some of the issues around JVPP bindings.
+
+   -  Accommodating plugins
+      `(e.g. NSH_SFC) `__
+   -  Binding for `python `__
+
+-  LISP
+
+   -  L2 LISP overlays
+   -  Multitenancy
+   -  Multihoming
+   -  RTR mode
+   -  Map-resolver failover algorithm
+
+-  Support 64-bit vector lengths, huge shared-memory segments.
+
+-  Dynamic IP Feature ordering
+
+   -  IP Features can now specify features they appear before and after
+
+-  16.09 Builds
+
+   -  Ubuntu 14.04 LTS - Trusty Tahr
+   -  Ubuntu 16.04 LTS - Xenial Xerus
+   -  CentOS 7
+   -  More information on `VPP wiki `__
+
+-  Performance, characterize and document performance for this release
+   `(more information on CSIT page) `__
+
+   -  IPv4 and IPv6 Scale - performance tests.
+
+      -  Bidirectional 10k/100k/1M flows.
+      -  64B,570B, 1518B,9000B packet sizes.
+
+   -  IPv6 iACL - performance
+
+      -  DUT1 and DUT2 are configured with IPv6 routing, two static IPv6
+         /64 routes and IPv6 iAcl security whitelist ingress /64 filter
+         entries applied on links.
+      -  TG traffic profile contains two L3 flow-groups (flow-group per
+         direction, 253 flows per flow-group) with all packets
+         containing Ethernet header, IPv6 header and generated payload.
+         MAC addresses are matching MAC addresses of the TG node
+         interfaces.
+
+   -  L2XC VXLANoIPv4 - performance
+
+      -  DUT1 and DUT2 are configured with L2 cross-connect. VXLAN
+         tunnels are configured between L2XCs on DUT1 and DUT2.
+      -  TG traffic profile contains two L3 flow-groups (flow-group per
+         direction, 253 flows per flow-group) with all packets
+         containing Ethernet header, IPv4 header with IP protocol=61 and
+         generated payload. MAC addresses are matching MAC addresses of
+         the TG node interfaces.
+
+-  Documentation
+
+   -  Autogenerated CLI documentation.
+   -  Using doxygen to automate API/Node documentation.
+   -  `(available online) `__
+
+-  Resolved all static analysis issues found by Coverity
+
+   -  Beginning of 16.09 cycle: 505 issues.
+   -  Release: 0 outstanding issues.
+
+Known issues
+------------
+
+Issues in fd.io are tracked in `JIRA `__.
+
++-----------------------------------+-----------------------------------+
+| Issue                             | Description                       |
++===================================+===================================+
+| VPP-391                           | vpp debug version assert appeared |
+|                                   | in the process of start           |
++-----------------------------------+-----------------------------------+
+| VPP-380                           | Mapping algorithm compute wrong   |
+|                                   | ea-bits when IPv4 prefix          |
+|                                   | 0.0.0.0/0                         |
++-----------------------------------+-----------------------------------+
+| VPP-371                           | load_one_plugin:63: Loaded        |
+|                                   | plugin: message from vppctl       |
++-----------------------------------+-----------------------------------+
+| VPP-367                           | vpp packages need to depend on    |
+|                                   | specific versions of each other   |
++-----------------------------------+-----------------------------------+
+| VPP-312                           | IP6 FIB gets in indeterminate     |
+|                                   | state by duplicating commands     |
++-----------------------------------+-----------------------------------+
+| VPP-224                           | Lookup-in-vrf can not be set      |
+|                                   | correctly                         |
++-----------------------------------+-----------------------------------+
+| VPP-206                           | Fix classify table delete         |
++-----------------------------------+-----------------------------------+
+| VPP-203                           | Fix binary API for reading vpp    |
+|                                   | node graph                        |
++-----------------------------------+-----------------------------------+
+| VPP-147                           | Inconsistent behaviour when       |
+|                                   | adding L2 FIB filter entry        |
++-----------------------------------+-----------------------------------+
+| VPP-99                            | VPP doesn’t discard DHCPOFFER     |
+|                                   | message with wrong XID            |
++-----------------------------------+-----------------------------------+
+
+Issues fixed
+------------
+
+Issues in fd.io are tracked in `JIRA `__.
+
++-----------------------------------+-----------------------------------+
+| Issue                             | Description                       |
++===================================+===================================+
+| VPP-396                           | Ubuntu systems Graphviz bug       |
++-----------------------------------+-----------------------------------+
+| VPP-390                           | vpp-lib rpm fails to include      |
+|                                   | \*.so symlinks, causing linking   |
+|                                   | problems with out of tree builds  |
++-----------------------------------+-----------------------------------+
+| VPP-388                           | IPSec output feature assumes      |
+|                                   | packets have been ethernet        |
+|                                   | rewritten                         |
++-----------------------------------+-----------------------------------+
+| VPP-385                           | ARP for indirect adjacencies not  |
+|                                   | working correctly                 |
++-----------------------------------+-----------------------------------+
+| VPP-361                           | Memory leak on delete of VXLAN    |
+|                                   | over IPv6 tunnel                  |
++-----------------------------------+-----------------------------------+
+| VPP-357                           | VNI not set correctly when        |
+|                                   | removing LISP fwd entries         |
++-----------------------------------+-----------------------------------+
+| VPP-349                           | sw_interface_vhost_user_dump not  |
+|                                   | working                           |
++-----------------------------------+-----------------------------------+
+| VPP-345                           | net/enic: bad L4 checksum ptype   |
+|                                   | set on ICMP packets               |
++-----------------------------------+-----------------------------------+
+| VPP-340                           | MAP-T wrong destination address   |
++-----------------------------------+-----------------------------------+
+| VPP-330                           | Use fifo to store LISP pending    |
+|                                   | map-requests                      |
++-----------------------------------+-----------------------------------+
+| VPP-326                           | map_add_domain VAT command:       |
+|                                   | unable to configure domain with   |
+|                                   | mtu parameter                     |
++-----------------------------------+-----------------------------------+
+| VPP-318                           | The map_add_domain VAT command    |
+|                                   | accepts invalid arguments         |
++-----------------------------------+-----------------------------------+
+| VPP-315                           | Fix “show vxlan-gpe” issue        |
++-----------------------------------+-----------------------------------+
+| VPP-310                           | Mapping algorithm compute wrong   |
+|                                   | ea-bits                           |
++-----------------------------------+-----------------------------------+
+| VPP-239                           | LISP IP forwarding does not tag   |
+|                                   | packets that hit negative mapping |
+|                                   | entries                           |
++-----------------------------------+-----------------------------------+
+| VPP-235                           | Invalid help in VAT for           |
+|                                   | sw_interface_set_l2_bridge        |
++-----------------------------------+-----------------------------------+
+| VPP-228                           | Mapping algorithm sends packet to |
+|                                   | wrong IPv6 address                |
++-----------------------------------+-----------------------------------+
+| VPP-214                           | vpp-api-test:                     |
+|                                   | api_ipsec_sad_add_del_entry:      |
+|                                   | vector “ck” not initialized       |
++-----------------------------------+-----------------------------------+
+| VPP-200                           | VPP - TAP port create problem     |
++-----------------------------------+-----------------------------------+
+| VPP-189                           | Coverity Issues for 16.09         |
++-----------------------------------+-----------------------------------+
+| VPP-184                           | u16 translating to char ,not      |
+|                                   | short                             |
++-----------------------------------+-----------------------------------+
+| VPP-179                           | Adjacency share-count botch       |
++-----------------------------------+-----------------------------------+
+| VPP-163                           | “show ip6 interface” ignores      |
+|                                   | non-global addresses              |
++-----------------------------------+-----------------------------------+
+| VPP-155                           | Netmap: Inconsistency in          |
+|                                   | interface state between “show     |
+|                                   | hardware” and “show interface”    |
++-----------------------------------+-----------------------------------+
+| VPP-145                           | Dynamically compute IP feature    |
+|                                   | ordering based on constraints     |
++-----------------------------------+-----------------------------------+
+| VPP-137                           | VPP sends ARP with wrong          |
+|                                   | requested IP                      |
++-----------------------------------+-----------------------------------+
+| VPP-118                           | JVpp: 0 length arrays not handled |
+|                                   | properly in VPP responses         |
++-----------------------------------+-----------------------------------+
+| VPP-112                           | linux kernel info missing from    |
+|                                   | build log                         |
++-----------------------------------+-----------------------------------+
+| VPP-110                           | vxlan encap node should never     |
+|                                   | touch a deleted tunnel            |
++-----------------------------------+-----------------------------------+
+| VPP-107                           | RPM build broken in master        |
++-----------------------------------+-----------------------------------+
+| VPP-92                            | segment routing is not properly   |
+|                                   | filling out the segment list      |
++-----------------------------------+-----------------------------------+
+| VPP-91                            | segment routing add/del tunnel    |
+|                                   | lookup doesn’t work               |
++-----------------------------------+-----------------------------------+
+| VPP-84                            | af_packet throws a fatal error on |
+|                                   | EAGAIN                            |
++-----------------------------------+-----------------------------------+
+| VPP-74                            | Clang compile fails due to        |
+|                                   | warning in vlib/unix/cli.c        |
++-----------------------------------+-----------------------------------+
+| VPP-64                            | Top level “make pkg-deb” fails if |
+|                                   | CDPATH is set in user env.        |
++-----------------------------------+-----------------------------------+
+| VPP-48                            | Traceroute does not terminate     |
+|                                   | when VPP is the target            |
++-----------------------------------+-----------------------------------+
+| VPP-23                            | CLI pager does not gracefully     |
+|                                   | handle lines longer than the      |
+|                                   | terminal width                    |
++-----------------------------------+-----------------------------------+
diff --git a/docs/aboutvpp/releasenotes/v17.01.1.rst b/docs/aboutvpp/releasenotes/v17.01.1.rst
new file mode 100644
index 00000000000..9453654c770
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v17.01.1.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 17.01.1
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v17.01.rst b/docs/aboutvpp/releasenotes/v17.01.rst
new file mode 100644
index 00000000000..0f22fa782ff
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v17.01.rst
@@ -0,0 +1,99 @@
+Release notes for VPP 17.01
+===========================
+
+@note This release was for a while known as 16.12.
+
+Features
+--------
+
+-  `Integrated November 2016 DPDK release `__
+
+-  Complete rework of Forwarding Information Base (FIB)
+
+-  Performance Improvements
+
+   -  Improvements in DPDK input and output nodes
+   -  Improvements in L2 path
+   -  Improvmeents in IPv4 lookup node
+
+-  Feature Arcs Improvements
+
+   -  Consolidation of the code
+   -  New feature arcs
+
+      -  device-input
+      -  interface-output
+
+-  DPDK Cryptodev Support
+
+   -  Software and Hardware Crypto Support
+
+-  DPDK HQoS support
+
+-  Simple Port Analyzer (SPAN)
+
+-  Bidirectional Forwarding Detection
+
+   -  Basic implementation
+
+-  IPFIX Improvements
+
+-  L2 GRE over IPSec tunnels
+
+-  Link Layer Discovery Protocol (LLDP)
+
+-  Vhost-user Improvements
+
+   -  Performance Improvements
+   -  Multiqueue
+   -  Reconnect
+
+-  LISP Enhancements
+
+   -  Source/Dest control plane support
+   -  L2 over LISP and GRE
+   -  Map-Register/Map-Notify/RLOC-probing support
+   -  L2 API improvements, overall code hardening
+
+-  Plugins:
+
+   -  New: ACL
+   -  New: Flow per Packet
+   -  Improved: SNAT
+
+      -  Mutlithreading
+      -  Flow export
+
+-  Doxygen Enhancements
+
+-  Luajit API bindings
+
+-  API Refactoring
+
+   -  file split
+   -  message signatures
+
+-  Python and Scapy based unit testing infrastructure
+
+   -  Infrastructure
+   -  Various tests
+
+-  Packet Generator improvements
+
+-  TUN/TAP jumbo frames support
+
+-  Other various bug fixes and improvements
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v17.04.rst b/docs/aboutvpp/releasenotes/v17.04.rst
new file mode 100644
index 00000000000..dd21462d9d2
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v17.04.rst
@@ -0,0 +1,146 @@
+Release notes for VPP 17.04
+===========================
+
+More than 500 commits since the 1701 release.
+
+Features
+--------
+
+-  Infrastructure
+
+   -  make test improvements
+   -  vnet: add device-input threadplacement infra
+   -  64 bit per-thread counters
+   -  process restart cli
+   -  High performance timer wheels
+   -  Plugin infrastructure improvements
+
+      -  Support for .default_disabled, .version_required
+
+   -  Added MAINTAINERS file
+
+-  Host stack
+
+   -  TCP stack (experimental)
+   -  DHCPv4 / DHCPv6 relay multi-destination
+   -  DHCPv4 option 82
+   -  ND proxy
+   -  Attached hosts
+   -  Consolidated DHCPv4 and DHCPv6 implementation
+
+-  Interfaces
+
+   -  DPDK 17.02 (retire support for DPDK 16.07)
+   -  Add memif - packet memory interface for intra-host communication
+   -  vhost: support interrupt mode
+   -  DPDK as plugin (retired vpp_lite)
+   -  DPDPK input optimizations
+   -  Loopback interface allocation scheme
+
+-  Network features
+
+   -  IP Multicast FIB
+
+   -  Bridging
+
+      -  Learning on local interfaces
+      -  Flushing of MACs from the L2 FIB
+
+   -  SNAT
+
+      -  CGN (Deterministic and dynamic)
+      -  CGN configurable port allocation algorithm
+      -  ICMP support
+      -  Tentant VRF id for SNAT outside addresses
+      -  Session dump / User dump
+      -  Port allocation per protocol
+
+   -  Security groups
+
+      -  Routed interface support
+      -  L2+L3 unified processing node
+      -  Improve fragment handling
+
+   -  Segement routing v6
+
+      -  SR policies with weighted SID lists
+      -  Binding SID
+      -  SR steering policies
+      -  SR Local SIDs
+      -  Framework to expand local SIDs w/plugins
+      -  Documentation
+
+   -  IOAM
+
+      -  UDP Pinger w/path fault isolation
+      -  IOAM as type 2 metadata in NSH
+      -  IAOM raw IPFIX collector and analyzer
+      -  Anycast active server selection
+      -  Documentation
+      -  SRv6 Local SID
+      -  IP6 HBH header and SR header co-existence
+      -  Active probe
+
+   -  LISP
+
+      -  Statistics collection
+      -  Generalize encap for overlay transport (vxlan-gpe support)
+      -  Improve data plane speed
+
+   -  GPE
+
+      -  CLI
+      -  NSH added to encap/decap path
+      -  Renamed LISP GPE API to GPE
+
+   -  MPLS
+
+      -  Performance improvements (quad loop)
+
+   -  BFD
+
+      -  Command line interface
+      -  Echo function
+      -  Remote demand mode
+      -  SHA1 authentication
+
+   -  IPsec
+
+      -  IKEv2 initiator features
+
+   -  VXLAN
+
+      -  unify IP4/IP6 control plane handling
+
+API changes
+-----------
+
+-  Python API: To avoid conflicts between VPP API messages names and the
+   Python API binding function names, VPP API methods are put in a
+   separate proxy object. https://gerrit.fd.io/r/#/c/5570/ The api
+   methods are now referenced as: vpp_handle = VPP(jsonfiles)
+   vpp_handle.connect(…) vpp = vpp_handle.api vpp.show_version()
+   vpp_handle.disconnect()
+
+   For backwards compatibility VPP API methods are left in the main name
+   space (VPP), but will be removed from 17.07.
+
+   -  Python API: Change from cPython to CFFI.
+
+-  create_loopback message to be replaced with create_loopback_instance
+   create_loopback will be removed from 17.07.
+   https://gerrit.fd.io/r/#/c/5572/
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v17.07.rst b/docs/aboutvpp/releasenotes/v17.07.rst
new file mode 100644
index 00000000000..aaa4d5afec5
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v17.07.rst
@@ -0,0 +1,76 @@
+Release notes for VPP 17.07
+===========================
+
+More than 400 commits since the 1704 release.
+
+Features
+--------
+
+-  Infrastructure
+
+   -  make test; improved debuggability.
+   -  TAB auto-completion on the CLI
+   -  DPDK 17.05
+   -  python 3 support in test infra
+
+-  Host stack
+
+   -  Improved Linux TCP stack compatibility using IWL test suite
+      (https://jira.fd.io/browse/VPP-720)
+   -  Improved loss recovery (RFC5681, RFC6582, RF6675)
+   -  Basic implementation of Eifel detection algorithm (RFC3522)
+   -  Basic support for buffer chains
+   -  Refactored session layer API
+   -  Overall performance, scale and hardening
+
+-  Interfaces
+
+   -  memif: IP mode, jumbo frames, multi queue
+   -  virtio-user support
+   -  vhost-usr; adaptive (poll/interupt) support.
+
+-  Network features
+
+   -  MPLS Multicast FIB
+
+   -  BFD FIB integration
+
+   -  NAT64 support
+
+   -  GRE over IPv6
+
+   -  Segement routing MPLS
+
+   -  IOAM configuration for SRv6 localsid
+
+   -  LISP
+
+      -  NSH support
+      -  native forward static routes
+      -  L2 ARP
+
+   -  ACL multi-core suuport
+
+   -  Flowprobe:
+
+      -  Add flowstartns, flowendns and tcpcontrolbits
+      -  Stateful flows and IPv6, L4 recording
+
+   -  GTP-U support
+
+   -  VXLAN GPE support for FIB2.0 and bypass.
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
diff --git a/docs/aboutvpp/releasenotes/v17.10.rst b/docs/aboutvpp/releasenotes/v17.10.rst
new file mode 100644
index 00000000000..d96f5ab7973
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v17.10.rst
@@ -0,0 +1,236 @@
+Release notes for VPP 17.10
+===========================
+
+More than 400 commits since the 1707 release.
+
+Features
+--------
+
+-  Infrastructure
+
+   -  DPDK 17.08
+   -  IP reassembly
+   -  Bounded-index extensible hash bucket-level LRU cache
+   -  Templated timer wheel improvements
+
+-  API
+
+   -  C/C++ language binding
+   -  API stats
+
+-  Host stack
+
+   -  VPP TCP stack scale/congestion improvements
+   -  VPP Comms Library (VCL)
+   -  Overall performance, scale and hardening
+
+-  Network features
+
+   -  IPSec rework - utilize new FIB
+
+   -  VPLS and VPWS implementation
+
+   -  NAT
+
+      -  Renamed SNAT to NAT
+      -  Performance / Scale
+      -  Destination NAT44 with load-balancing
+      -  In2out translation as an output feature on the outside
+         interface
+      -  Fullback to 3-tuple key for non TCP/UDP/ICMP sessions
+
+   -  Security Groups/ACLs
+
+      -  “Replace” semantics for adding a new MacIP acl
+      -  Test suite tests for MacIP ACLs
+
+   -  ONE-LISP
+
+      -  Map-server fallback support
+      -  Preemptive re-fetch of active mappings that are about to expire
+      -  ND termination
+
+   -  PPPoE
+
+      -  PPPoE Control Plane packet dispatch
+      -  PPPoE decapsulation
+      -  PPPoE encapsulation
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+======================================== ==================
+Message Name                             Result
+======================================== ==================
+bridge_domain_add_del                    definition changed
+bridge_domain_details                    definition changed
+connect_session                          definition changed
+connect_sock                             definition changed
+connect_sock_reply                       definition changed
+connect_uri_reply                        definition changed
+create_vhost_user_if                     definition changed
+dhcp_client_config                       definition changed
+ip4_arp_event                            definition changed
+ip6_fib_details                          definition changed
+ip6_nd_event                             definition changed
+ip_add_del_route                         definition changed
+ip_fib_details                           definition changed
+ip_table_add_del                         definition changed
+l2_macs_event                            only in image
+macip_acl_add_replace                    definition changed
+macip_acl_interface_list_details         only in image
+macip_acl_interface_list_dump            only in image
+modify_vhost_user_if                     definition changed
+mpls_fib_details                         definition changed
+mpls_route_add_del                       definition changed
+mpls_table_add_del                       definition changed
+mpls_tunnel_add_del                      definition changed
+nat44_add_del_address_range              definition changed
+nat44_add_del_interface_addr             definition changed
+nat44_add_del_lb_static_mapping          definition changed
+nat44_add_del_static_mapping             definition changed
+nat44_address_details                    only in image
+nat44_address_dump                       only in image
+nat44_interface_add_del_feature          definition changed
+nat44_interface_add_del_output_feature   definition changed
+nat44_interface_addr_details             only in image
+nat44_interface_addr_dump                only in image
+nat44_interface_details                  only in image
+nat44_interface_dump                     only in image
+nat44_interface_output_feature_details   only in image
+nat44_interface_output_feature_dump      only in image
+nat44_lb_static_mapping_details          only in image
+nat44_lb_static_mapping_dump             only in image
+nat44_static_mapping_details             only in image
+nat44_static_mapping_dump                only in image
+nat44_user_details                       only in image
+nat44_user_dump                          only in image
+nat44_user_session_details               only in image
+nat44_user_session_dump                  only in image
+nat_control_ping                         definition changed
+nat_det_add_del_map                      definition changed
+nat_det_close_session_in                 definition changed
+nat_det_close_session_out                definition changed
+nat_det_forward                          definition changed
+nat_det_get_timeouts                     definition changed
+nat_det_map_details                      only in image
+nat_det_map_dump                         only in image
+nat_det_reverse                          definition changed
+nat_det_session_details                  only in image
+nat_det_session_dump                     only in image
+nat_det_set_timeouts                     definition changed
+nat_ipfix_enable_disable                 definition changed
+nat_set_workers                          definition changed
+nat_show_config                          definition changed
+nat_worker_details                       only in image
+nat_worker_dump                          only in image
+one_add_del_ndp_entry                    definition changed
+one_enable_disable_petr_mode             definition changed
+one_enable_disable_pitr_mode             definition changed
+one_enable_disable_xtr_mode              definition changed
+one_get_transport_protocol               definition changed
+one_map_register_fallback_threshold      definition changed
+one_map_register_set_ttl                 definition changed
+one_ndp_bd_get                           definition changed
+one_ndp_entries_get                      definition changed
+one_set_transport_protocol               definition changed
+one_show_petr_mode                       definition changed
+one_show_pitr_mode                       definition changed
+one_show_xtr_mode                        definition changed
+p2p_ethernet_add                         definition changed
+pppoe_add_del_session                    definition changed
+pppoe_session_details                    only in image
+pppoe_session_dump                       only in image
+punt_socket_deregister                   definition changed
+punt_socket_register                     definition changed
+show_one_map_register_fallback_threshold definition changed
+show_one_map_register_ttl                definition changed
+snat_interface_add_del_output_feature    definition changed
+snat_interface_output_feature_details    only in image
+snat_interface_output_feature_dump       only in image
+sw_interface_event                       only in image
+sw_interface_set_flags                   definition changed
+sw_interface_span_dump                   definition changed
+sw_interface_span_enable_disable         definition changed
+sw_interface_vhost_user_details          definition changed
+tcp_configure_src_addresses              definition changed
+vnet_per_interface_combined_counters     only in image
+vnet_per_interface_simple_counters       only in image
+want_interface_combined_stats            definition changed
+want_interface_simple_stats              definition changed
+want_ip4_fib_stats                       definition changed
+want_ip4_nbr_stats                       definition changed
+want_ip6_fib_stats                       definition changed
+want_ip6_nbr_stats                       definition changed
+want_l2_macs_events                      definition changed
+want_per_interface_combined_stats        definition changed
+want_per_interface_simple_stats          definition changed
+======================================== ==================
+
+Found 103 api message signature differences
+
+Patches that updated the API files
+----------------------------------
+* ``./src/plugins/pppoe/pppoe.api`` 62f9cdd8 Add PPPoE Plugin
+* ``./src/plugins/acl/acl.api`` c29940c5 ACL-plugin add “replace” semantics
+  for adding a new MacIP acl de9fbf43 MAC IP ACL interface list dump (as
+  an alternative to the get/reply)
+* ``./src/plugins/nat/nat.api`` 704018cf NAT: Destination NAT44 with
+  load-balancing (VPP-954) 2ba92e32 NAT: Rename snat plugin to nat
+  (VPP-955)
+* ``./src/vnet/interface.api`` 831fb59f Stats refactor d292ab1e No context in
+  SW interface event a07bd708 Dedicated SW Interface Event
+* ``./src/vnet/dhcp/dhcp.api`` 51822bf0 DHCP client option 61 “client_id”
+  4729b1ec DHCP complete event sends mask length
+* ``./src/vnet/lldp/lldp.api`` 99a0e60e Add API support for LLDP
+  config/interface set
+* ``./src/vnet/lisp-cp/one.api`` d630713d LISP: add neighbor discovery and CP
+  protocol separation APIs 111a5cea LISP: Add APIs for enable/disable
+  xTR/P-ITR/P-ETR modes 7048ff1e LISP: Map-server fallback feature
+  1e553a00 LISP: make TTL for map register messages configurable
+* ``./src/vnet/ethernet/p2p_ethernet.api`` 15ac81c1 P2P Ethernet
+* ``./src/vnet/mpls/mpls.api`` 2297af01 Add a name to the creation of an IP
+  and MPLS table 28ab9cc1 FIB table add/delete API only da78f957 L2 over
+  MPLS a0a908f1 FIB path weight incorrect in dump (VPP-922) 57b5860f FIB
+  path preference
+* ``./src/vnet/session/session.api`` 33e002b1 Fix session connect api message
+  handling.
+* ``./src/vnet/span/span.api`` 5b311202 SPAN/API:enable L2 dump 001fd406
+  SPAN:add l2 mirror
+* ``./src/vnet/devices/virtio/vhost_user.api`` 4ba75f54 vhost: Remove
+  operation mode in the API
+* ``./src/vnet/vxlan-gpe/vxlan_gpe.api`` 04ffd0ad VPP crash on creating vxlan
+  gpe interface. VPP-875
+* ``./src/vnet/tcp/tcp.api`` 3bbcfab1 TCP source address automation
+* ``./src/vnet/ip/ip.api`` 2297af01 Add a name to the creation of an IP and
+  MPLS table 28ab9cc1 FIB table add/delete API only 57b5860f FIB path
+  preference
+* ``./src/vnet/lisp-gpe/lisp_gpe.api`` af3d9771 Remove unused retval from
+  gpe_native_fwd_rpath type definition
+* ``./src/vnet/l2/l2.api`` 50570ece Update of free text tag patch for BD
+  48304141 Support for bridge domain free text tag e531f4cb Increase
+  default MAC learn limit and check it in learn-update path 8d00fff8 Add
+  support for API client to receive L2 MAC events
+* ``./src/vpp/api/vpe.api`` 8a19f12a Allow individual stats API and introduce
+  stats.api 4802632d Punt socket: Fix coverity error for pathname length
+  mismatch between API and sun_path. f7a55ad7 PUNT socket: External
+  control plane processes connected via UNIX domain sockets. 75e2f2ac
+  API:fix arp/ND event messages - remove context 99a0e60e Add API support
+  for LLDP config/interface set
+* ``./src/vpp/stats/stats.api`` 831fb59f Stats refactor 8a19f12a Allow
+  individual stats API and introduce stats.api
diff --git a/docs/aboutvpp/releasenotes/v18.01.1.rst b/docs/aboutvpp/releasenotes/v18.01.1.rst
new file mode 100644
index 00000000000..7f2cb6fa2ae
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v18.01.1.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 18.01.1
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v18.01.2.rst b/docs/aboutvpp/releasenotes/v18.01.2.rst
new file mode 100644
index 00000000000..c984b36961c
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v18.01.2.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 18.01.2
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v18.01.rst b/docs/aboutvpp/releasenotes/v18.01.rst
new file mode 100644
index 00000000000..e760de282a6
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v18.01.rst
@@ -0,0 +1,382 @@
+Release notes for VPP 18.01
+===========================
+
+More than 560 commits since the 17.10 release.
+
+Features
+--------
+
+-  Infrastructure
+
+   -  DPDK 17.11
+   -  TCP Checksum Offload
+   -  Arm64/Arm-v8 support
+   -  SUSE packaging
+   -  bihash_vec8_8 variant
+   -  PCI rework to support VFIO
+   -  chi-squared test calculator
+
+-  SNAT / NAT
+
+   -  One armed NAT
+   -  Twice NAT44
+   -  NAT hairpinning rework
+   -  NAT64 multi-thread
+   -  NAT64 IPFIX
+   -  NAT64 Fragmentation
+   -  NAT: DS-Lite
+   -  Remove old SNAT API
+   -  ACL-based NAT
+
+-  VNET
+
+   -  DNS name resolver
+   -  BIER
+   -  GENEVE Tunnel
+   -  IPSec Openssl 1.1.0 api support
+   -  FIB improvements
+   -  tap v2
+
+-  API
+
+   -  VPP stats (Broadcast & Multicast support)
+   -  SR MPLS
+   -  VPP Object Model (VOM)
+
+-  Host Stack
+
+   -  VPP TCP Stack scale / congestion improvements
+   -  Refactor UDP
+   -  Namespace support
+   -  Session rules table
+   -  VPP Comms Library (VCL) improvements
+
+-  ACL
+
+   -  ACL stats
+
+-  Plugins
+
+   -  Kube-proxy
+   -  L2 Emulation
+   -  Memif
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+===================================== ==================
+Message Name                          Result
+===================================== ==================
+af_packet_set_l4_cksum_offload        definition changed
+api_versions                          definition changed
+app_namespace_add_del                 definition changed
+application_attach                    definition changed
+bier_disp_entry_add_del               definition changed
+bier_disp_entry_details               only in image
+bier_disp_entry_dump                  only in image
+bier_disp_table_add_del               definition changed
+bier_disp_table_details               only in image
+bier_disp_table_dump                  only in image
+bier_imp_add                          definition changed
+bier_imp_del                          definition changed
+bier_imp_details                      only in image
+bier_imp_dump                         only in image
+bier_route_add_del                    definition changed
+bier_route_details                    only in image
+bier_route_dump                       only in image
+bier_table_add_del                    definition changed
+bier_table_details                    only in image
+bier_table_dump                       only in image
+bind_sock_reply                       definition changed
+connect_session_reply                 definition changed
+connect_sock                          definition changed
+connect_uri                           definition changed
+dhcp_proxy_details                    definition changed
+dhcp_proxy_set_vss                    definition changed
+dns_enable_disable                    definition changed
+dns_name_server_add_del               definition changed
+dns_resolve_ip                        definition changed
+dns_resolve_name                      definition changed
+dslite_add_del_pool_addr_range        definition changed
+dslite_set_aftr_addr                  definition changed
+geneve_add_del_tunnel                 definition changed
+geneve_tunnel_details                 only in image
+geneve_tunnel_dump                    only in image
+ip_add_del_route                      definition changed
+ip_container_proxy_add_del            definition changed
+ip_mroute_add_del                     definition changed
+ip_neighbor_details                   definition changed
+ip_punt_police                        definition changed
+ip_punt_redirect                      definition changed
+ipsec_sa_details                      only in image
+ipsec_sa_dump                         only in image
+ipsec_sad_add_del_entry               definition changed
+ipsec_tunnel_if_set_key               definition changed
+ipsec_tunnel_if_set_sa                definition changed
+kp_add_del_pod                        definition changed
+kp_add_del_vip                        definition changed
+kp_conf                               definition changed
+l2_emulation                          definition changed
+l2_fib_table_details                  definition changed
+l2fib_add_del                         definition changed
+memclnt_keepalive                     definition changed
+memfd_segment_create                  definition changed
+mpls_ip_bind_unbind                   definition changed
+mpls_route_add_del                    definition changed
+nat44_add_del_address_range           definition changed
+nat44_add_del_identity_mapping        definition changed
+nat44_add_del_interface_addr          definition changed
+nat44_add_del_lb_static_mapping       definition changed
+nat44_add_del_static_mapping          definition changed
+nat44_address_details                 definition changed
+nat44_del_session                     definition changed
+nat44_forwarding_enable_disable       definition changed
+nat44_forwarding_is_enabled           definition changed
+nat44_identity_mapping_details        only in image
+nat44_identity_mapping_dump           only in image
+nat44_interface_addr_details          definition changed
+nat44_lb_static_mapping_details       definition changed
+nat44_static_mapping_details          definition changed
+nat64_add_del_interface_addr          definition changed
+nat_get_reass                         definition changed
+nat_reass_details                     only in image
+nat_reass_dump                        only in image
+nat_set_reass                         definition changed
+reset_vrf                             definition changed
+session_rule_add_del                  definition changed
+session_rules_details                 only in image
+session_rules_dump                    only in image
+snat_add_address_range                definition changed
+snat_add_del_interface_addr           definition changed
+snat_add_det_map                      definition changed
+snat_add_static_mapping               definition changed
+snat_address_details                  only in file
+snat_address_dump                     only in file
+snat_control_ping                     definition changed
+snat_det_close_session_in             definition changed
+snat_det_close_session_out            definition changed
+snat_det_forward                      definition changed
+snat_det_get_timeouts                 definition changed
+snat_det_map_details                  only in file
+snat_det_map_dump                     only in file
+snat_det_reverse                      definition changed
+snat_det_session_details              only in file
+snat_det_session_dump                 only in file
+snat_det_set_timeouts                 definition changed
+snat_interface_add_del_feature        definition changed
+snat_interface_add_del_output_feature definition changed
+snat_interface_addr_details           only in file
+snat_interface_addr_dump              only in file
+snat_interface_details                only in file
+snat_interface_dump                   only in file
+snat_interface_output_feature_details only in file
+snat_interface_output_feature_dump    only in file
+snat_ipfix_enable_disable             definition changed
+snat_set_workers                      definition changed
+snat_show_config                      definition changed
+snat_static_mapping_details           only in file
+snat_static_mapping_dump              only in file
+snat_user_details                     only in file
+snat_user_dump                        only in file
+snat_user_session_details             only in file
+snat_user_session_dump                only in file
+snat_worker_details                   only in file
+snat_worker_dump                      only in file
+sockclnt_create                       definition changed
+sockclnt_delete                       definition changed
+sr_localsids_details                  only in image
+sr_localsids_dump                     only in image
+sr_mpls_policy_add                    definition changed
+sr_mpls_policy_assign_endpoint_color  definition changed
+sr_mpls_policy_del                    definition changed
+sr_mpls_policy_mod                    definition changed
+sr_mpls_steering_add_del              definition changed
+sr_set_encap_source                   definition changed
+stn_add_del_rule                      definition changed
+stn_rule_details                      only in image
+stn_rules_dump                        only in image
+sw_interface_set_geneve_bypass        definition changed
+sw_interface_set_lldp                 definition changed
+sw_interface_set_rx_mode              definition changed
+sw_interface_tap_v2_details           only in image
+sw_interface_tap_v2_dump              only in image
+tap_create_v2                         definition changed
+tap_delete_v2                         definition changed
+udp_encap_add_del                     definition changed
+udp_encap_details                     only in image
+udp_encap_dump                        only in image
+vnet_ip4_mfib_counters                only in image
+vnet_ip6_mfib_counters                only in image
+want_ip4_mfib_stats                   definition changed
+want_ip6_mfib_stats                   definition changed
+===================================== ==================
+
+Found 142 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ``./src/examples/sample-plugin/sample/sample.api`` 0d056e5e vppapigen:
+  support per-file (major,minor,patch) version stamps
+* ``./src/vnet/interface.api b8d4481a`` Break up vpe.api ad8015be devices: Add
+  binary API for set interface rx-mode 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/vnet/feature/feature.api`` b8d4481a Break up vpe.api
+* ``./src/vnet/srv6/sr.api`` 1a5e301f SRv6 improvements to binary API 0d056e5e
+  vppapigen: support per-file (major,minor,patch) version stamps
+* ``./src/vnet/bier/bier.api`` be302d72 BIER coverity fix in route downlaod
+  ceb4d05b BIER disposition default route fa1da15c BIER: API documentation
+  fixes. 9128637e BIER in non-MPLS netowrks d792d9c0 BIER
+* ``./src/vnet/vxlan-gpe/vxlan_gpe.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/unix/tap.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/lldp/lldp.api`` 9a6fcef4 LLDP: Add Management Address TLV
+  0d056e5e vppapigen: support per-file (major,minor,patch) version stamps
+* ``./src/vnet/dns/dns.api`` d2080159 Add reverse DNS (ip to name) resolution
+  6545716c VPP-1027: DNS name resolver
+* ``./src/vnet/session/session.api`` dcf55ce2 vppcom: improve listener session
+  handling 6e8c6679 session: add app ns index to ns create api c97a7398
+  session: add rule tags 6c36f53f session: add api to dump rules 1c710451
+  session: rules tables ade70e45 session: return local transport endpoint
+  in connect reply cea194d8 session: add support for application
+  namespacing 0d056e5e vppapigen: support per-file (major,minor,patch)
+  version stamps
+* ``./src/vnet/devices/af_packet/af_packet.api`` 92b0275a af_packet: invalid
+  TCP/UDP offload checksum on RX node recalculation 0d056e5e vppapigen:
+  support per-file (major,minor,patch) version stamps
+* ``./src/vnet/devices/netmap/netmap.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/vnet/devices/tap/tapv2.api`` 73e7f427 tap_v2: include host-side
+  parameters in the dump binary API 2df39094 tapv2: multiple improvements
+  c99b4cd1 tap_v2: move code to vnet/devices/tap
+* ``./src/vnet/devices/virtio/vhost_user.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/vnet/lisp-gpe/lisp_gpe.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/srmpls/sr_mpls.api`` 42998828 SR-MPLS: binary API and automated
+  steering
+* ``./src/vnet/l2/l2.api`` b8d4481a Break up vpe.api 57938f63 l2fib: MAC: Fix
+  uint64 to u8 byte array 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/udp/udp.api`` 810086d8 UDP Encapsulation.
+* ``./src/vnet/policer/policer.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/bfd/bfd.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/geneve/geneve.api`` 556033a0 Add API versioning to GENEVE
+  tunnel implementation. b598f1d3 Initial GENEVE TUNNEL implementation and
+  tests.
+* ``./src/vnet/gre/gre.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/map/map.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/flow/flow.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/pg/pg.api`` b8d4481a Break up vpe.api
+* ``./src/vnet/dhcp/dhcp.api`` 70bfcaf4 Add Support of DHCP VSS Type 0 where
+  VPN-ID is ASCII 0d056e5e vppapigen: support per-file (major,minor,patch)
+  version stamps
+* ``./src/vnet/ipsec/ipsec.api`` ca514fda Allow IPsec interface to have SAs
+  reset 75d85609 Add API call to set keys on IPsec tunnel intf 0d056e5e
+  vppapigen: support per-file (major,minor,patch) version stamps 28029530
+  Add API support to dump IPsec SAs
+* ``./src/vnet/mpls/mpls.api`` c42fc05b Remove the unused ‘create VRF if
+  needed’ API parameters b8d4481a Break up vpe.api d792d9c0 BIER d0a59722
+  Revert “Enforce FIB table creation before use” f9342023 Enforce FIB
+  table creation before use 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/ethernet/p2p_ethernet.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/vnet/span/span.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/lisp-cp/lisp.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/lisp-cp/one.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/vxlan/vxlan.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/ipsec-gre/ipsec_gre.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/vnet/classify/classify.api`` b8d4481a Break up vpe.api 8527f12b add
+  classify session action set-sr-policy-index 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/vnet/ip/punt.api`` b8d4481a Break up vpe.api
+* ``./src/vnet/ip/ip.api`` c42fc05b Remove the unused ‘create VRF if needed’
+  API parameters b8d4481a Break up vpe.api af8dfbf6 Add sw_if_index to the
+  ip_neighbor_details_t response. d792d9c0 BIER 810086d8 UDP
+  Encapsulation. 595992c5 ip: add container proxy api 0164a06d Remove
+  unused ‘not_last’ parameter from ip_add_del_route d0a59722 Revert
+  “Enforce FIB table creation before use” 054c03ac Source Lookup
+  progammable via API f9342023 Enforce FIB table creation before use
+  d91c1dbd punt and drop features: - new IPv4 and IPv6 feature arcs on the
+  punt and drop nodes - new features: - redirect punted traffic to an
+  interface and nexthop - police punted traffic. 0d056e5e vppapigen:
+  support per-file (major,minor,patch) version stamps 6f631156 Distributed
+  Virtual Router Support
+* ``./src/vnet/cop/cop.api`` 0d056e5e vppapigen: support per-file (major,minor,patch) version stamps
+* ``./src/vnet/l2tp/l2tp.api`` 0d056e5e vppapigen: support per-file (major,minor,patch) version stamps
+* ``./src/vpp/oam/oam.api`` b8d4481a Break up vpe.api
+* ``./src/vpp/stats/stats.api`` ff233898 Stats for Multicast FIB 0d056e5e
+  vppapigen: support per-file (major,minor,patch) version stamps
+* ``./src/vpp/api/vpe.api`` b8d4481a Break up vpe.api d792d9c0 BIER 0d056e5e
+  vppapigen: support per-file (major,minor,patch) version stamps b598f1d3
+  Initial GENEVE TUNNEL implementation and tests.
+* ``./src/plugins/ioam/udp-ping/udp_ping.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/plugins/ioam/ip6/ioam_cache.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/plugins/ioam/lib-pot/pot.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/plugins/ioam/lib-trace/trace.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/plugins/ioam/export/ioam_export.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/plugins/ioam/export-vxlan-gpe/vxlan_gpe_ioam_export.api`` 0d056e5e
+  vppapigen: support per-file (major,minor,patch) version stamps
+* ``./src/plugins/ioam/lib-vxlan-gpe/ioam_vxlan_gpe.api`` 0d056e5e vppapigen:
+  support per-file (major,minor,patch) version stamps
+* ``./src/plugins/pppoe/pppoe.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/plugins/dpdk/api/dpdk.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/plugins/acl/acl.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/plugins/gtpu/gtpu.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/plugins/l2e/l2e.api`` 4ec38711 L2 emulation: remove usued
+  ip-table-id from API 55d03788 L2 Emulation
+* ``./src/plugins/flowprobe/flowprobe.api`` 0d056e5e vppapigen: support
+  per-file (major,minor,patch) version stamps
+* ``./src/plugins/nat/nat.api`` 7b929793 Translate matching packets using NAT
+  (VPP-1069) b932d26e NAT: Twice NAT44 (VPP-969) ab7a805f NAT44: identity
+  NAT (VPP-1073) c6fb36fc NAT: Remove old SNAT API (VPP-1070) 0938dcf1
+  NAT64 to use IPv4 address from interface (VPP-1051) efcd1e9e SNAT: IP
+  fragmentation (VPP-890) 8ebe6253 NAT: DS-Lite (VPP-1040) 5ba86f72 NAT:
+  delete session API/CLI (VPP-1041) 36ea2d6d One armed NAT (VPP-1035)
+  0d056e5e vppapigen: support per-file (major,minor,patch) version stamps
+* ``./src/plugins/memif/memif.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/plugins/kubeproxy/kp.api`` c91f5024 Support kube-proxy data plane
+* ``./src/plugins/lb/lb.api`` 0d056e5e vppapigen: support per-file
+  (major,minor,patch) version stamps
+* ``./src/plugins/stn/stn.api`` 0906c5cf Plugin for IP-Address to Interface
+  Punting
+* ``./src/vlibmemory/memclnt.api 0d056e5e`` vppapigen: support per-file
+  (major,minor,patch) version stamps 59b2565c Repair vlib API socket
+  server
diff --git a/docs/aboutvpp/releasenotes/v18.04.rst b/docs/aboutvpp/releasenotes/v18.04.rst
new file mode 100644
index 00000000000..603e1d84c36
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v18.04.rst
@@ -0,0 +1,2523 @@
+Release notes for VPP 18.04
+===========================
+
+More than 570 commits since the 18.01 release.
+
+Features
+--------
+
+Infrastructure
+~~~~~~~~~~~~~~
+
+-  DPDK 18.02.1
+-  ARM aarch64 integrated into CI
+
+VNET & Plugins
+~~~~~~~~~~~~~~
+
+-  ERSPAN
+-  L3DSR load balancing support
+-  VPC bonding / LACP
+-  IPv4/IPv6 packet reassembly
+-  IPv6 link-local support
+-  Asymmetrical static NAT
+-  464XLAT for NAT44
+-  MAP-T CE support
+-  Intel Adaptive Virtual Function native device driver plugin
+-  Marvell device plugin
+-  SRv6 static, dynamic and masquerading proxy plugins
+-  MPLS Uniform mode
+-  IGMP plugin
+-  IPIP tunnel support (IPv4/IPv6 over IPv4/IPv6)
+-  IPv6 Router Discovery mechanism
+
+VLIB
+~~~~
+
+-  ARM-optimized library variations for key functions
+-  Better handling of physmem on non-NUMA kernels
+
+Host stack
+~~~~~~~~~~
+
+-  TLS support via OpenSSL or mbedtls software engines
+-  Session layer can utilize both shm and memfd (secure) FIFO segments
+-  STCP
+-  VCL logging / tracing
+
+API framework
+~~~~~~~~~~~~~
+
+-  New API definition compiler (vppapigen)
+-  Memory (shm) and socket APIs refactored
+-  API handlers refactored to make them transport (shared memory or
+   socket) agnostic
+-  Improved support for bootstrapping of the shm API with memfd segments
+   over the socket API
+
+Packaging
+~~~~~~~~~
+
+-  SELinux for RPM builds
+-  Debuginfo RPMs
+-  ARM aarch64 for Ubuntu
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
++--------------------------------------------------------+--------------------+
+| Message Name                                           | Results            |
++========================================================+====================+
+| accept_session                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| accept_session_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_add_replace                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_add_replace_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_del                                                | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_del_reply                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_details                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_dump                                               | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_interface_add_del                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_interface_add_del_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_interface_etype_whitelist_details                  | only in image      |
++--------------------------------------------------------+--------------------+
+| acl_interface_etype_whitelist_dump                     | only in image      |
++--------------------------------------------------------+--------------------+
+| acl_interface_list_details                             | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_interface_list_dump                                | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_interface_set_acl_list                             | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_interface_set_acl_list_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_interface_set_etype_whitelist                      | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_plugin_control_ping                                | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_plugin_control_ping_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_plugin_get_version                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| acl_plugin_get_version_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| add_node_next                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| add_node_next_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| af_packet_create                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| af_packet_create_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| af_packet_delete                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| af_packet_delete_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| af_packet_set_l4_cksum_offload                         | definition changed |
++--------------------------------------------------------+--------------------+
+| af_packet_set_l4_cksum_offload_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| api_versions                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| api_versions_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| app_namespace_add_del                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| app_namespace_add_del_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| application_attach                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| application_attach_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| application_detach                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| application_detach_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| application_tls_cert_add                               | definition changed |
++--------------------------------------------------------+--------------------+
+| application_tls_key_add                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bd_ip_mac_add_del                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| bd_ip_mac_add_del_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_auth_del_key                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_auth_del_key_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_auth_keys_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_auth_keys_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_auth_set_key                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_auth_set_key_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_add                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_add_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_auth_activate                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_auth_activate_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_auth_deactivate                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_auth_deactivate_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_del                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_del_echo_source                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_del_echo_source_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_del_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_mod                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_mod_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_session_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_session_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_session_set_flags                              | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_session_set_flags_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_set_echo_source                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bfd_udp_set_echo_source_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_entry_add_del                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_entry_add_del_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_entry_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_entry_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_table_add_del                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_table_add_del_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_table_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_disp_table_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_imp_add                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_imp_add_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_imp_del                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_imp_del_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_imp_details                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_imp_dump                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_route_add_del                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_route_add_del_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_route_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_route_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_table_add_del                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_table_add_del_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_table_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bier_table_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| bind_sock                                              | definition changed |
++--------------------------------------------------------+--------------------+
+| bind_sock_reply                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| bind_uri                                               | definition changed |
++--------------------------------------------------------+--------------------+
+| bind_uri_reply                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| bond_create                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| bond_delete                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| bond_detach_slave                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| bond_enslave                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_domain_add_del                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_domain_add_del_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_domain_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_domain_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_domain_set_mac_age                              | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_domain_set_mac_age_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_flags                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| bridge_flags_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| cdp_enable                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_add_del_session                               | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_add_del_session_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_add_del_table                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_add_del_table_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_session_details                               | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_session_dump                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_set_interface_ip_table                        | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_set_interface_ip_table_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_set_interface_l2_tables                       | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_set_interface_l2_tables_reply                 | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_table_by_interface                            | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_table_by_interface_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_table_ids                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_table_ids_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_table_info                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| classify_table_info_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| cli                                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| cli_inband                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| cli_inband_reply                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| cli_reply                                              | definition changed |
++--------------------------------------------------------+--------------------+
+| collect_detailed_interface_stats                       | definition changed |
++--------------------------------------------------------+--------------------+
+| connect_session                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| connect_session_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| connect_sock                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| connect_sock_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| connect_uri                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| connect_uri_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| control_ping                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| control_ping_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| cop_interface_enable_disable                           | definition changed |
++--------------------------------------------------------+--------------------+
+| cop_interface_enable_disable_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| cop_whitelist_enable_disable                           | definition changed |
++--------------------------------------------------------+--------------------+
+| cop_whitelist_enable_disable_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| create_loopback                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| create_loopback_instance                               | definition changed |
++--------------------------------------------------------+--------------------+
+| create_loopback_instance_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| create_loopback_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| create_subif                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| create_subif_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| create_vhost_user_if                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| create_vhost_user_if_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| create_vlan_subif                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| create_vlan_subif_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| delete_loopback                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| delete_loopback_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| delete_subif                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| delete_subif_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| delete_vhost_user_if                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| delete_vhost_user_if_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_client_config                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_client_config_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_compl_event                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_proxy_config                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_proxy_config_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_proxy_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_proxy_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_proxy_set_vss                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| dhcp_proxy_set_vss_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| disconnect_session                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| disconnect_session_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_enable_disable                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_enable_disable_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_name_server_add_del                                | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_name_server_add_del_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_resolve_ip                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_resolve_ip_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_resolve_name                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| dns_resolve_name_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| dslite_add_del_pool_addr_range                         | definition changed |
++--------------------------------------------------------+--------------------+
+| dslite_add_del_pool_addr_range_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| dslite_get_aftr_addr                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| dslite_get_b4_addr                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| dslite_set_aftr_addr                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| dslite_set_aftr_addr_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| dslite_set_b4_addr                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| feature_enable_disable                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| feature_enable_disable_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| flow_classify_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| flow_classify_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| flow_classify_set_interface                            | definition changed |
++--------------------------------------------------------+--------------------+
+| flow_classify_set_interface_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| flowprobe_params                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| flowprobe_params_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| flowprobe_tx_interface_add_del                         | definition changed |
++--------------------------------------------------------+--------------------+
+| flowprobe_tx_interface_add_del_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| gbp_contract_add_del                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| gbp_contract_details                                   | only in image      |
++--------------------------------------------------------+--------------------+
+| gbp_contract_dump                                      | only in image      |
++--------------------------------------------------------+--------------------+
+| gbp_endpoint_add_del                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| gbp_endpoint_details                                   | only in image      |
++--------------------------------------------------------+--------------------+
+| gbp_endpoint_dump                                      | only in image      |
++--------------------------------------------------------+--------------------+
+| geneve_add_del_tunnel                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| geneve_add_del_tunnel_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| geneve_tunnel_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| geneve_tunnel_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| get_first_msg_id                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| get_first_msg_id_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| get_next_index                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| get_next_index_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| get_node_graph                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| get_node_graph_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| get_node_index                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| get_node_index_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_add_del_fwd_entry                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_add_del_fwd_entry_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_add_del_iface                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_add_del_iface_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_add_del_native_fwd_rpath                           | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_add_del_native_fwd_rpath_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_enable_disable                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_enable_disable_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_fwd_entries_get                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_fwd_entries_get_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_fwd_entry_path_details                             | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_fwd_entry_path_dump                                | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_fwd_entry_vnis_get                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_fwd_entry_vnis_get_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_get_encap_mode                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_get_encap_mode_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_native_fwd_rpaths_get                              | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_native_fwd_rpaths_get_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_set_encap_mode                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| gpe_set_encap_mode_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| gre_add_del_tunnel                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| gre_add_del_tunnel_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| gre_tunnel_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| gre_tunnel_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| gtpu_add_del_tunnel                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| gtpu_add_del_tunnel_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| gtpu_tunnel_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| gtpu_tunnel_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| igmp_clear_interface                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| igmp_details                                           | only in image      |
++--------------------------------------------------------+--------------------+
+| igmp_dump                                              | only in image      |
++--------------------------------------------------------+--------------------+
+| igmp_enable_disable                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| igmp_event                                             | only in image      |
++--------------------------------------------------------+--------------------+
+| igmp_listen                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_del_child_sa                            | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_del_child_sa_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_del_ike_sa                              | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_del_ike_sa_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_rekey_child_sa                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_rekey_child_sa_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_sa_init                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_initiate_sa_init_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_add_del                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_add_del_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_set_auth                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_set_auth_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_set_id                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_set_id_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_set_ts                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_profile_set_ts_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_esp_transforms                               | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_esp_transforms_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_ike_transforms                               | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_ike_transforms_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_local_key                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_local_key_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_responder                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_responder_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_sa_lifetime                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| ikev2_set_sa_lifetime_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| input_acl_set_interface                                | definition changed |
++--------------------------------------------------------+--------------------+
+| input_acl_set_interface_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| interface_name_renumber                                | definition changed |
++--------------------------------------------------------+--------------------+
+| interface_name_renumber_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_cache_ip6_enable_disable                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_cache_ip6_enable_disable_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_disable                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_disable_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_enable                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_enable_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_export_ip6_enable_disable                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ioam_export_ip6_enable_disable_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| ip4_arp_event                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6_fib_details                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6_fib_dump                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6_mfib_details                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6_mfib_dump                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6_nd_address_autoconfig                              | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6_nd_event                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6_ra_event                                           | only in image      |
++--------------------------------------------------------+--------------------+
+| ip6nd_proxy_add_del                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6nd_proxy_add_del_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6nd_proxy_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6nd_proxy_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip6nd_send_router_solicitation                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_add_del_route                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_add_del_route_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_address_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_address_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_container_proxy_add_del                             | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_container_proxy_add_del_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_details                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_dump                                                | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_fib_details                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_fib_dump                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_mfib_details                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_mfib_dump                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_mroute_add_del                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_mroute_add_del_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_neighbor_add_del                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_neighbor_add_del_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_neighbor_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_neighbor_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_punt_police                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_punt_police_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_punt_redirect                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_punt_redirect_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_reassembly_enable_disable                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_reassembly_get                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_reassembly_set                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_source_and_port_range_check_add_del                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_source_and_port_range_check_add_del_reply           | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_source_and_port_range_check_interface_add_del       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_source_and_port_range_check_interface_add_del_reply | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_table_add_del                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ip_table_add_del_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_classify_stream_details                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_classify_stream_dump                             | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_classify_table_add_del                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_classify_table_add_del_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_classify_table_details                           | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_classify_table_dump                              | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_exporter_details                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ipfix_exporter_dump                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ipip_6rd_add_tunnel                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ipip_6rd_del_tunnel                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| ipip_add_tunnel                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| ipip_del_tunnel                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| ipip_tunnel_details                                    | only in image      |
++--------------------------------------------------------+--------------------+
+| ipip_tunnel_dump                                       | only in image      |
++--------------------------------------------------------+--------------------+
+| ipsec_gre_add_del_tunnel                               | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_gre_add_del_tunnel_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_gre_tunnel_details                               | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_gre_tunnel_dump                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_interface_add_del_spd                            | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_interface_add_del_spd_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_sa_details                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_sa_dump                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_sa_set_key                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_sa_set_key_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_sad_add_del_entry                                | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_sad_add_del_entry_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_spd_add_del                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_spd_add_del_entry                                | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_spd_add_del_entry_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_spd_add_del_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_spd_details                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_spd_dump                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_tunnel_if_add_del                                | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_tunnel_if_add_del_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_tunnel_if_set_key                                | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_tunnel_if_set_key_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_tunnel_if_set_sa                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| ipsec_tunnel_if_set_sa_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| kp_add_del_pod                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| kp_add_del_pod_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| kp_add_del_vip                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| kp_add_del_vip_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| kp_conf                                                | definition changed |
++--------------------------------------------------------+--------------------+
+| kp_conf_reply                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_emulation                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_emulation_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_fib_clear_table                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_fib_clear_table_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_fib_table_details                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_fib_table_dump                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_flags                                               | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_flags_reply                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_interface_efp_filter                                | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_interface_efp_filter_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_interface_pbb_tag_rewrite                           | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_interface_pbb_tag_rewrite_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_interface_vlan_tag_rewrite                          | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_interface_vlan_tag_rewrite_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_macs_event                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_patch_add_del                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_patch_add_del_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_xconnect_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| l2_xconnect_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_add_del                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_add_del_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_flush_all                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_flush_all_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_flush_bd                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_flush_bd_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_flush_int                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| l2fib_flush_int_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_create_tunnel                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_create_tunnel_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_interface_enable_disable                        | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_interface_enable_disable_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_set_lookup_key                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_set_lookup_key_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_set_tunnel_cookies                              | definition changed |
++--------------------------------------------------------+--------------------+
+| l2tpv3_set_tunnel_cookies_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| lb_add_del_as                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| lb_add_del_as_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| lb_add_del_vip                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| lb_add_del_vip_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| lb_conf                                                | definition changed |
++--------------------------------------------------------+--------------------+
+| lb_conf_reply                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_adjacency                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_adjacency_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_local_eid                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_local_eid_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_locator                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_locator_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_locator_set                               | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_locator_set_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_map_request_itr_rlocs                     | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_map_request_itr_rlocs_reply               | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_map_resolver                              | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_map_resolver_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_map_server                                | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_map_server_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_remote_mapping                            | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_add_del_remote_mapping_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_adjacencies_get                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_adjacencies_get_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_add_del_map                             | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_add_del_map_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_details                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_dump                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_map_details                             | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_map_dump                                | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_vni_details                             | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_eid_table_vni_dump                                | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_enable_disable                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_enable_disable_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_get_map_request_itr_rlocs                         | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_get_map_request_itr_rlocs_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_locator_details                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_locator_dump                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_locator_set_details                               | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_locator_set_dump                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_register_enable_disable                       | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_register_enable_disable_reply                 | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_request_mode                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_request_mode_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_resolver_details                              | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_resolver_dump                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_server_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_map_server_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_pitr_set_locator_set                              | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_pitr_set_locator_set_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_rloc_probe_enable_disable                         | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_rloc_probe_enable_disable_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_use_petr                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| lisp_use_petr_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| lldp_config                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| lldp_config_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_add                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_add_replace                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_add_replace_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_add_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_del                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_del_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_details                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_dump                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_interface_add_del                            | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_interface_add_del_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_interface_get                                | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_interface_get_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_interface_list_details                       | definition changed |
++--------------------------------------------------------+--------------------+
+| macip_acl_interface_list_dump                          | definition changed |
++--------------------------------------------------------+--------------------+
+| map_add_del_rule                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| map_add_del_rule_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| map_add_domain                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| map_add_domain_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| map_another_segment                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| map_another_segment_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| map_del_domain                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| map_del_domain_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| map_domain_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| map_domain_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| map_rule_details                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| map_rule_dump                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| map_summary_stats                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| map_summary_stats_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_create                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_create_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_delete                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_delete_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_keepalive                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_keepalive_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_read_timeout                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| memclnt_rx_thread_suspend                              | definition changed |
++--------------------------------------------------------+--------------------+
+| memfd_segment_create                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| memfd_segment_create_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_create                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_create_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_delete                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_delete_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_details                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_dump                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_socket_filename_add_del                          | definition changed |
++--------------------------------------------------------+--------------------+
+| memif_socket_filename_details                          | only in image      |
++--------------------------------------------------------+--------------------+
+| memif_socket_filename_dump                             | only in image      |
++--------------------------------------------------------+--------------------+
+| mfib_signal_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| mfib_signal_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| modify_vhost_user_if                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| modify_vhost_user_if_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_fib_details                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_fib_dump                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_ip_bind_unbind                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_ip_bind_unbind_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_route_add_del                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_route_add_del_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_table_add_del                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_table_add_del_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_tunnel_add_del                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_tunnel_add_del_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_tunnel_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| mpls_tunnel_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_address_range                            | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_address_range_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_identity_mapping                         | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_identity_mapping_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_interface_addr                           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_interface_addr_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_lb_static_mapping                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_lb_static_mapping_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_static_mapping                           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_add_del_static_mapping_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_address_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_address_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_del_session                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_del_session_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_forwarding_enable_disable                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_forwarding_enable_disable_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_forwarding_is_enabled                            | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_forwarding_is_enabled_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_identity_mapping_details                         | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_identity_mapping_dump                            | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_add_del_feature                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_add_del_feature_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_add_del_output_feature                 | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_add_del_output_feature_reply           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_addr_details                           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_addr_dump                              | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_output_feature_details                 | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_interface_output_feature_dump                    | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_lb_static_mapping_details                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_lb_static_mapping_dump                           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_static_mapping_details                           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_static_mapping_dump                              | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_user_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_user_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_user_session_details                             | definition changed |
++--------------------------------------------------------+--------------------+
+| nat44_user_session_dump                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_interface_addr                           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_interface_addr_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_interface                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_interface_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_pool_addr_range                          | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_pool_addr_range_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_prefix                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_prefix_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_static_bib                               | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_add_del_static_bib_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_bib_details                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_bib_dump                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_get_timeouts                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_get_timeouts_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_interface_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_interface_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_pool_addr_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_pool_addr_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_prefix_details                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_prefix_dump                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_set_timeouts                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_set_timeouts_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_st_details                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| nat64_st_dump                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| nat66_add_del_interface                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat66_add_del_static_mapping                           | definition changed |
++--------------------------------------------------------+--------------------+
+| nat66_interface_details                                | only in image      |
++--------------------------------------------------------+--------------------+
+| nat66_interface_dump                                   | only in image      |
++--------------------------------------------------------+--------------------+
+| nat66_static_mapping_details                           | only in image      |
++--------------------------------------------------------+--------------------+
+| nat66_static_mapping_dump                              | only in image      |
++--------------------------------------------------------+--------------------+
+| nat_control_ping                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_control_ping_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_add_del_map                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_add_del_map_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_close_session_in                               | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_close_session_in_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_close_session_out                              | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_close_session_out_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_forward                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_forward_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_get_timeouts                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_get_timeouts_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_map_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_map_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_reverse                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_reverse_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_session_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_session_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_set_timeouts                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_det_set_timeouts_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_get_reass                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_get_reass_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_ipfix_enable_disable                               | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_ipfix_enable_disable_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_reass_details                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_reass_dump                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_set_reass                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_set_reass_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_set_workers                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_set_workers_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_show_config                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_show_config_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_worker_details                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| nat_worker_dump                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| netmap_create                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| netmap_create_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| netmap_delete                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| netmap_delete_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| oam_add_del                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| oam_add_del_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| oam_event                                              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_adjacency                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_adjacency_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_l2_arp_entry                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_l2_arp_entry_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_local_eid                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_local_eid_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_locator                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_locator_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_locator_set                                | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_locator_set_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_map_request_itr_rlocs                      | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_map_request_itr_rlocs_reply                | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_map_resolver                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_map_resolver_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_map_server                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_map_server_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_ndp_entry                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_ndp_entry_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_remote_mapping                             | definition changed |
++--------------------------------------------------------+--------------------+
+| one_add_del_remote_mapping_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| one_adjacencies_get                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_adjacencies_get_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_add_del_map                              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_add_del_map_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_map_details                              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_map_dump                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_vni_details                              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_eid_table_vni_dump                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable_petr_mode                           | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable_petr_mode_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable_pitr_mode                           | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable_pitr_mode_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable_xtr_mode                            | definition changed |
++--------------------------------------------------------+--------------------+
+| one_enable_disable_xtr_mode_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| one_get_map_request_itr_rlocs                          | definition changed |
++--------------------------------------------------------+--------------------+
+| one_get_map_request_itr_rlocs_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_get_transport_protocol                             | definition changed |
++--------------------------------------------------------+--------------------+
+| one_get_transport_protocol_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| one_l2_arp_bd_get                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| one_l2_arp_bd_get_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| one_l2_arp_entries_get                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| one_l2_arp_entries_get_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| one_locator_details                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_locator_dump                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| one_locator_set_details                                | definition changed |
++--------------------------------------------------------+--------------------+
+| one_locator_set_dump                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_register_enable_disable                        | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_register_enable_disable_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_register_fallback_threshold                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_register_fallback_threshold_reply              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_register_set_ttl                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_register_set_ttl_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_request_mode                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_request_mode_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_resolver_details                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_resolver_dump                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_server_details                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| one_map_server_dump                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_ndp_bd_get                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| one_ndp_bd_get_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| one_ndp_entries_get                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_ndp_entries_get_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| one_nsh_set_locator_set                                | definition changed |
++--------------------------------------------------------+--------------------+
+| one_nsh_set_locator_set_reply                          | definition changed |
++--------------------------------------------------------+--------------------+
+| one_pitr_set_locator_set                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_pitr_set_locator_set_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| one_rloc_probe_enable_disable                          | definition changed |
++--------------------------------------------------------+--------------------+
+| one_rloc_probe_enable_disable_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| one_set_transport_protocol                             | definition changed |
++--------------------------------------------------------+--------------------+
+| one_set_transport_protocol_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| one_show_petr_mode                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| one_show_petr_mode_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_show_pitr_mode                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| one_show_pitr_mode_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_show_xtr_mode                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| one_show_xtr_mode_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| one_stats_details                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| one_stats_dump                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| one_stats_enable_disable                               | definition changed |
++--------------------------------------------------------+--------------------+
+| one_stats_enable_disable_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| one_stats_flush                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| one_stats_flush_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| one_use_petr                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| one_use_petr_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| output_acl_set_interface                               | definition changed |
++--------------------------------------------------------+--------------------+
+| p2p_ethernet_add                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| p2p_ethernet_add_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| p2p_ethernet_del                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| p2p_ethernet_del_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| pg_capture                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| pg_capture_reply                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| pg_create_interface                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| pg_create_interface_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| pg_enable_disable                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| pg_enable_disable_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_add_del                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_add_del_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_classify_details                               | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_classify_dump                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_classify_set_interface                         | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_classify_set_interface_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_details                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| policer_dump                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_activate                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_activate_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_add                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_add_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_del                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_del_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_show_config_details                        | definition changed |
++--------------------------------------------------------+--------------------+
+| pot_profile_show_config_dump                           | definition changed |
++--------------------------------------------------------+--------------------+
+| pppoe_add_del_session                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| pppoe_add_del_session_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| pppoe_session_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| pppoe_session_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| proxy_arp_add_del                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| proxy_arp_add_del_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| proxy_arp_intfc_enable_disable                         | definition changed |
++--------------------------------------------------------+--------------------+
+| proxy_arp_intfc_enable_disable_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| punt                                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| punt_reply                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| punt_socket_deregister                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| punt_socket_deregister_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| punt_socket_register                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| punt_socket_register_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| qos_egress_map_delete                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| qos_egress_map_update                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| qos_mark_enable_disable                                | definition changed |
++--------------------------------------------------------+--------------------+
+| qos_record_enable_disable                              | definition changed |
++--------------------------------------------------------+--------------------+
+| reset_fib                                              | definition changed |
++--------------------------------------------------------+--------------------+
+| reset_fib_reply                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| reset_session                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| reset_session_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| rpc_call                                               | definition changed |
++--------------------------------------------------------+--------------------+
+| rpc_call_reply                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| rx_thread_exit                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| sctp_add_src_dst_connection                            | definition changed |
++--------------------------------------------------------+--------------------+
+| sctp_config                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| sctp_del_src_dst_connection                            | definition changed |
++--------------------------------------------------------+--------------------+
+| session_enable_disable                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| session_enable_disable_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| session_rule_add_del                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| session_rule_add_del_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| session_rules_details                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| session_rules_dump                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| set_arp_neighbor_limit                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| set_arp_neighbor_limit_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| set_ip_flow_hash                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| set_ip_flow_hash_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| set_ipfix_classify_stream                              | definition changed |
++--------------------------------------------------------+--------------------+
+| set_ipfix_classify_stream_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| set_ipfix_exporter                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| set_ipfix_exporter_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_map_register_state                           | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_map_register_state_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_map_request_mode                             | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_map_request_mode_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_pitr                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_pitr_reply                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_rloc_probe_state                             | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_rloc_probe_state_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_status                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_status_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_use_petr                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| show_lisp_use_petr_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_register_fallback_threshold               | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_register_fallback_threshold_reply         | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_register_state                            | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_register_state_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_register_ttl                              | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_register_ttl_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_request_mode                              | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_map_request_mode_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_nsh_mapping                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_nsh_mapping_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_pitr                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_pitr_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_rloc_probe_state                              | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_rloc_probe_state_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_stats_enable_disable                          | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_stats_enable_disable_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_status                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_status_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_use_petr                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| show_one_use_petr_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| show_version                                           | definition changed |
++--------------------------------------------------------+--------------------+
+| show_version_reply                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sock_init_shm                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| sockclnt_create                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| sockclnt_create_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| sockclnt_delete                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| sockclnt_delete_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_localsid_add_del                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_localsid_add_del_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_localsids_details                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_localsids_dump                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_add                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_add_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_assign_endpoint_color                   | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_assign_endpoint_color_reply             | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_del                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_del_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_mod                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_policy_mod_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_steering_add_del                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_mpls_steering_add_del_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_policy_add                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_policy_add_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_policy_del                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_policy_del_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_policy_mod                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_policy_mod_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_set_encap_source                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_set_encap_source_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_steering_add_del                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| sr_steering_add_del_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| stats_get_poller_delay                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| stn_add_del_rule                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| stn_add_del_rule_reply                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| stn_rule_details                                       | only in file       |
++--------------------------------------------------------+--------------------+
+| stn_rules_details                                      | only in image      |
++--------------------------------------------------------+--------------------+
+| stn_rules_dump                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_if_l2tpv3_tunnel_details                            | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_if_l2tpv3_tunnel_dump                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_add_del_address                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_add_del_address_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_bond_details                              | only in image      |
++--------------------------------------------------------+--------------------+
+| sw_interface_bond_dump                                 | only in image      |
++--------------------------------------------------------+--------------------+
+| sw_interface_clear_stats                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_clear_stats_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_details                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_dump                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_event                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_get_mac_address                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_get_table                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_get_table_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6_enable_disable                        | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6_enable_disable_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6_set_link_local_address                | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6_set_link_local_address_reply          | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6nd_ra_config                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6nd_ra_config_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6nd_ra_prefix                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_ip6nd_ra_prefix_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_lacp_details                              | only in image      |
++--------------------------------------------------------+--------------------+
+| sw_interface_lacp_dump                                 | only in image      |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_dpdk_hqos_pipe                        | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_dpdk_hqos_pipe_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_dpdk_hqos_subport                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_dpdk_hqos_subport_reply               | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_dpdk_hqos_tctbl                       | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_dpdk_hqos_tctbl_reply                 | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_flags                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_flags_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_geneve_bypass                         | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_geneve_bypass_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_gtpu_bypass                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_gtpu_bypass_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_l2_bridge                             | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_l2_bridge_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_l2_xconnect                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_l2_xconnect_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_lldp                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_lldp_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_mac_address                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_mac_address_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_mpls_enable                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_mpls_enable_reply                     | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_mtu                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_mtu_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_rx_mode                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_rx_mode_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_table                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_table_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_unnumbered                            | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_unnumbered_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_vpath                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_vpath_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_vxlan_bypass                          | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_vxlan_bypass_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_vxlan_gpe_bypass                      | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_set_vxlan_gpe_bypass_reply                | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_slave_details                             | only in image      |
++--------------------------------------------------------+--------------------+
+| sw_interface_slave_dump                                | only in image      |
++--------------------------------------------------------+--------------------+
+| sw_interface_span_details                              | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_span_dump                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_span_enable_disable                       | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_span_enable_disable_reply                 | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_tag_add_del                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_tag_add_del_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_tap_details                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_tap_dump                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_tap_v2_details                            | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_tap_v2_dump                               | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_vhost_user_details                        | definition changed |
++--------------------------------------------------------+--------------------+
+| sw_interface_vhost_user_dump                           | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_connect                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_connect_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_create_v2                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_create_v2_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_delete                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_delete_reply                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_delete_v2                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_delete_v2_reply                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_modify                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| tap_modify_reply                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| tcp_configure_src_addresses                            | definition changed |
++--------------------------------------------------------+--------------------+
+| tcp_configure_src_addresses_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| trace_plugin_msg_ids                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| trace_profile_add                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| trace_profile_add_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| trace_profile_del                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| trace_profile_del_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| trace_profile_show_config                              | definition changed |
++--------------------------------------------------------+--------------------+
+| trace_profile_show_config_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| udp_encap_add_del                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| udp_encap_add_del_reply                                | definition changed |
++--------------------------------------------------------+--------------------+
+| udp_encap_details                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| udp_encap_dump                                         | definition changed |
++--------------------------------------------------------+--------------------+
+| udp_ping_add_del                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| udp_ping_add_del_reply                                 | only in image      |
++--------------------------------------------------------+--------------------+
+| udp_ping_add_del_req                                   | only in file       |
++--------------------------------------------------------+--------------------+
+| udp_ping_export                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| udp_ping_export_reply                                  | only in image      |
++--------------------------------------------------------+--------------------+
+| udp_ping_export_req                                    | only in file       |
++--------------------------------------------------------+--------------------+
+| unbind_sock                                            | definition changed |
++--------------------------------------------------------+--------------------+
+| unbind_sock_reply                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| unbind_uri                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| unbind_uri_reply                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| unmap_segment                                          | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_get_summary_stats                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_get_summary_stats_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_interface_combined_counters                       | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_interface_simple_counters                         | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_ip4_fib_counters                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_ip4_mfib_counters                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_ip4_nbr_counters                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_ip6_fib_counters                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_ip6_mfib_counters                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_ip6_nbr_counters                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_per_interface_combined_counters                   | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_per_interface_simple_counters                     | definition changed |
++--------------------------------------------------------+--------------------+
+| vnet_udp_encap_counters                                | only in image      |
++--------------------------------------------------------+--------------------+
+| vxlan_add_del_tunnel                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_add_del_tunnel_reply                             | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_add_del_tunnel                               | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_add_del_tunnel_reply                         | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_disable                                 | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_disable_reply                           | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_enable                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_enable_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_export_enable_disable                   | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_export_enable_disable_reply             | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_transit_disable                         | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_transit_disable_reply                   | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_transit_enable                          | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_transit_enable_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_vni_disable                             | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_vni_disable_reply                       | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_vni_enable                              | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_ioam_vni_enable_reply                        | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_tunnel_details                               | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_gpe_tunnel_dump                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_tunnel_details                                   | definition changed |
++--------------------------------------------------------+--------------------+
+| vxlan_tunnel_dump                                      | definition changed |
++--------------------------------------------------------+--------------------+
+| want_bfd_events                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| want_bfd_events_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| want_igmp_events                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| want_interface_combined_stats                          | definition changed |
++--------------------------------------------------------+--------------------+
+| want_interface_combined_stats_reply                    | definition changed |
++--------------------------------------------------------+--------------------+
+| want_interface_events                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| want_interface_events_reply                            | definition changed |
++--------------------------------------------------------+--------------------+
+| want_interface_simple_stats                            | definition changed |
++--------------------------------------------------------+--------------------+
+| want_interface_simple_stats_reply                      | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_arp_events                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_arp_events_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_fib_stats                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_fib_stats_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_mfib_stats                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_mfib_stats_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_nbr_stats                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip4_nbr_stats_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_fib_stats                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_fib_stats_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_mfib_stats                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_mfib_stats_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_nbr_stats                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_nbr_stats_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_nd_events                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_nd_events_reply                               | definition changed |
++--------------------------------------------------------+--------------------+
+| want_ip6_ra_events                                     | definition changed |
++--------------------------------------------------------+--------------------+
+| want_l2_macs_events                                    | definition changed |
++--------------------------------------------------------+--------------------+
+| want_l2_macs_events_reply                              | definition changed |
++--------------------------------------------------------+--------------------+
+| want_oam_events                                        | definition changed |
++--------------------------------------------------------+--------------------+
+| want_oam_events_reply                                  | definition changed |
++--------------------------------------------------------+--------------------+
+| want_per_interface_combined_stats                      | definition changed |
++--------------------------------------------------------+--------------------+
+| want_per_interface_combined_stats_reply                | definition changed |
++--------------------------------------------------------+--------------------+
+| want_per_interface_simple_stats                        | definition changed |
++--------------------------------------------------------+--------------------+
+| want_per_interface_simple_stats_reply                  | definition changed |
++--------------------------------------------------------+--------------------+
+| want_stats                                             | definition changed |
++--------------------------------------------------------+--------------------+
+| want_stats_reply                                       | definition changed |
++--------------------------------------------------------+--------------------+
+| want_udp_encap_stats                                   | definition changed |
++--------------------------------------------------------+--------------------+
+
+Found 1036 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``src/vpp/stats/stats.api``
+
+* `43b1f44 `_ UDP Encap counters
+* `ff92efe `_ stats: allow configuring poller delay
+* `51e5968 `_ API: Add service definitions for events and singleton messages (second attempt)
+* `2de1f15 `_ Revert "API: Add service definitions for events and singleton messages."
+* `f7b7fa5 `_ API: Add service definitions for events and singleton messages.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vpp/oam/oam.api``
+
+* `51e5968 `_ API: Add service definitions for events and singleton messages (second attempt)
+* `2de1f15 `_ Revert "API: Add service definitions for events and singleton messages."
+* `f7b7fa5 `_ API: Add service definitions for events and singleton messages.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vpp/api/vpe.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/interface.api``
+
+* `0cae3f7 `_ Detailed Interface stats API takes sw_if_index
+* `6f4a6be `_ Interface Unicast, Multicast and Broadcast stats on the API
+* `c037423 `_ IPv6 ND Router discovery control plane (VPP-1095)
+* `51e5968 `_ API: Add service definitions for events and singleton messages (second attempt)
+* `2de1f15 `_ Revert "API: Add service definitions for events and singleton messages."
+* `f7b7fa5 `_ API: Add service definitions for events and singleton messages.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/unix/tap.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/qos/qos.api``
+
+* `039cbfe `_ QoS recording and marking
+
+``src/vnet/policer/policer.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/mpls/mpls.api``
+
+* `31ed744 `_ MPLS Unifom mode
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/span/span.api``
+
+* `179ab36 `_ SPAN: Add "is_l2" flag to DETAILS response messages.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/vxlan-gpe/vxlan_gpe.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/l2tp/l2tp.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/lldp/lldp.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/srmpls/sr_mpls.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/cop/cop.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/feature/feature.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/ipsec-gre/ipsec_gre.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/geneve/geneve.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/lisp-gpe/lisp_gpe.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/map/map.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+* `e31d956 `_ MAP: Add RFC6052 mapping to MAP-T
+
+``src/vnet/lisp-cp/lisp.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/lisp-cp/one.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/tcp/tcp.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/dhcp/dhcp.api``
+
+* `51e5968 `_ API: Add service definitions for events and singleton messages (second attempt)
+* `2de1f15 `_ Revert "API: Add service definitions for events and singleton messages."
+* `f7b7fa5 `_ API: Add service definitions for events and singleton messages.
+* `54c6dc4 `_ For DHCP client configuration control the setting of the broadcast flag in the DISCOVER message sent.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/gre/gre.api``
+
+* `a43ccae `_ Optimize GRE Tunnel and add support for ERSPAN encap
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/flow/flow.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/devices/virtio/vhost_user.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/devices/af_packet/af_packet.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+* `7866c45 `_ tapv2: add option to set host-side default gw
+
+``src/vnet/devices/netmap/netmap.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/dns/dns.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/bonding/bond.api``
+
+* `9cd2d7a `_ bond: Add bonding driver and LACP protocol
+
+``src/vnet/session/session.api``
+
+* `8f89dd0 `_ tls: enforce certificate verification
+* `371ca50 `_ session: first approximation implementation of tls
+* `f8f516a `_ session: support local sessions and deprecate redirects
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/ethernet/p2p_ethernet.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/ip/rd_cp.api``
+
+* `c037423 `_ IPv6 ND Router discovery control plane (VPP-1095)
+
+``src/vnet/ip/punt.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/ip/ip.api``
+
+* `4c53313 `_ reassembly: feature/concurrency
+* `4b9669d `_ IPv6 ND Router discovery data plane (VPP-1095)
+* `31ed744 `_ MPLS Unifom mode
+* `51e5968 `_ API: Add service definitions for events and singleton messages (second attempt)
+* `2de1f15 `_ Revert "API: Add service definitions for events and singleton messages."
+* `f7b7fa5 `_ API: Add service definitions for events and singleton messages.
+* `75e7d13 `_ IPv4/6 reassembly
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+* `f068c3e `_ DVR: run L3 output features
+
+``src/vnet/classify/classify.api``
+
+* `815d7d5 `_ classifier-based ACL: refactor + add output ACL
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/ipip/ipip.api``
+
+* `298c695 `_ IPIP: Add IP{v4,v6} over IP{v4,v6} configured tunnel support.
+
+``src/vnet/udp/udp.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/bfd/bfd.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/srv6/sr.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/ipsec/ipsec.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/bier/bier.api``
+
+* `31ed744 `_ MPLS Unifom mode
+* `f051072 `_ BIER: fix support for longer bit-string lengths
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/sctp/sctp.api``
+
+* `c7fe4f3 `_ SCTP: API to configure some tunables
+* `465c087 `_ SCTP: API to delete a sub-connection
+* `3c6a976 `_ SCTP: API to add a sub-connection
+
+``src/vnet/l2/l2.api``
+
+* `e23c99e `_ Improve l2_macs_events API to provide MAC move information
+* `51e5968 `_ API: Add service definitions for events and singleton messages (second attempt)
+* `2de1f15 `_ Revert "API: Add service definitions for events and singleton messages."
+* `f7b7fa5 `_ API: Add service definitions for events and singleton messages.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/vxlan/vxlan.api``
+
+* `31ed744 `_ MPLS Unifom mode
+* `3d460bd `_ VXLAN: Allow user to specify a custom vxlan tunnel instance id.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/fib/fib_types.api``
+
+* `2303cb1 `_ FIB Interpose Source
+* `8145842 `_ Common form of fib-path reproting in dumps
+* `31ed744 `_ MPLS Unifom mode
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/vnet/pg/pg.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/examples/sample-plugin/sample/sample.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/lb/lb.api``
+
+* `647f609 `_ Add L3DSR feature in LB plugin
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/gtpu/gtpu.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/kubeproxy/kp.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/pppoe/pppoe.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/nat/nat.api``
+
+* `f2a23cc `_ NAT66 1:1 mapping (VPP-1108)
+* `9dba781 `_ NAT44: nat44_static_mapping_details protocol=0 if addr_only=0 (VPP-1158)
+* `bc39e34 `_ NAT: add missing CLI and API documentation (VPP-1142)
+* `5f22499 `_ NAT44: add opaque string tag to static mapping APIs (VPP-1147)
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+* `e82488f `_ NAT44: asymmetrical static mapping rule (VPP-1135)
+* `240b5ef `_ NAT44: asymmetrical load balancing static mapping rule (VPP-1132)
+* `c5c6a33 `_ Add basic support for DS-Lite CE (VPP-1059)
+
+``src/plugins/l2e/l2e.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/ioam/lib-pot/pot.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/ioam/ip6/ioam_cache.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/ioam/udp-ping/udp_ping.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+* `149a143 `_ fix udp_ping api naming error
+
+``src/plugins/ioam/export/ioam_export.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/ioam/export-vxlan-gpe/vxlan_gpe_ioam_export.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/ioam/lib-vxlan-gpe/ioam_vxlan_gpe.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/ioam/lib-trace/trace.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/igmp/igmp.api``
+
+* `7b867a8 `_ IGMP plugin
+
+``src/plugins/memif/memif.api``
+
+* `30349b0 `_ memif: Add new API calls to manage memif socket names.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/lacp/lacp.api``
+
+* `9cd2d7a `_ bond: Add bonding driver and LACP protocol
+
+``src/plugins/acl/acl.api``
+
+* `27fe75a `_ acl-plugin: add the support for dumping the ethertype whitelist (VPP-1163)
+* `c43b3f9 `_ acl-plugin: add whitelisted ethertype mode (VPP-1163)
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/flowprobe/flowprobe.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/dpdk/api/dpdk.api``
+
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/gbp/gbp.api``
+
+* `bc27d1b `_ GBP plugin
+
+``src/plugins/stn/stn.api``
+
+* `62bab65 `_ STN: Fix stn_rules_dump/details to follow API convention
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+
+``src/plugins/cdp/cdp.api``
+
+* `aaacfbc `_ Move the vnet cdp protocol implementation to a plugin
+
+``src/vlibmemory/memclnt.api``
+
+* `51e5968 `_ API: Add service definitions for events and singleton messages (second attempt)
+* `2de1f15 `_ Revert "API: Add service definitions for events and singleton messages."
+* `f7b7fa5 `_ API: Add service definitions for events and singleton messages.
+* `9d42087 `_ VPPAPIGEN: vppapigen replacement in Python PLY.
+* `90a6398 `_ sock api: add infra for bootstrapping shm clients
+
+
diff --git a/docs/aboutvpp/releasenotes/v18.07.rst b/docs/aboutvpp/releasenotes/v18.07.rst
new file mode 100644
index 00000000000..472f38bb37d
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v18.07.rst
@@ -0,0 +1,306 @@
+Release notes for VPP 18.07
+===========================
+
+More than 533 commits since the 18.04 release.
+
+Features
+--------
+
+Infrastructure
+~~~~~~~~~~~~~~
+
+-  DPDK 18.02.1
+
+   -  Complete rework of the dpdk-input node
+   -  Display rx/tx burst function name in “show hardware detail”
+   -  Improve buffer alloc perfomance
+
+      -  This is ~50% improvement in buffer alloc performance. For a 256
+         buffer allocation, it was ~10 clocks/buffer, now is < 5 clocks.
+
+   -  Add per-numa page allocation info to ‘show memory’
+   -  Vectorized bihash_{48,40,24,16}_8 key compare
+
+      -  bihash_48_8 case:
+
+         -  Scalar code: 6 clocks
+         -  SSE4.2 code: 3 clocks
+         -  AVX2 code: 2.27 clocks
+         -  AVX512 code: 1.5 clocks
+
+   -  Pollable Stats
+
+      -  Stats are now available to a client in a shared memory segment
+         and in the form of a directory, allowing very high performance
+         polling of stats without directly querying VPP.
+
+VNET & Plugins
+~~~~~~~~~~~~~~
+
+-  IGMP improvements
+
+   -  Enable/Disable an interface for IGMP
+   -  improve logging
+   -  refactor common code
+   -  no orphaned timers
+   -  IGMP state changes in main thread only
+   -  Large groups split over multiple state-change reports
+   -  SSM range configuration API.
+   -  more tests
+
+-  IP: vectorized IP checksum
+-  VXLAN : HW offload RX flow
+-  Rework kube-proxy into LB plugin and add NATA66
+-  NAT:
+
+   -  Code refactor
+   -  Syslog
+   -  Multiple outside interfaces
+   -  Endpoint dependent filtering and mapping
+
+-  ACL:
+
+   -  Tuple Merge algorithm cleanup and integration
+   -  Processing pipeline optimizations
+   -  Refactoring
+
+-  Experimental AVF driver
+
+Host stack
+~~~~~~~~~~
+
+-  Session: performance improvements, add support for connectionless
+   transports, datagram reception and transmission
+-  TCP: congestion control improvements and overall fixes
+-  UDP: datagram mode
+-  TLS async support
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+
+-  *Only in image*: indicates the API is new for this release.
+
+-  *Only in file*: indicates the API has been removed in this release.
+
+   ::
+
+                        Message Name                         Result
+
+   abf_itf_attach_add_del definition changed abf_itf_attach_details only
+   in image abf_itf_attach_dump only in image abf_plugin_get_version
+   definition changed abf_policy_add_del definition changed
+   abf_policy_details only in image abf_policy_dump only in image
+   af_packet_details only in image af_packet_dump only in image
+   avf_create definition changed avf_delete definition changed
+   bind_sock_reply definition changed bind_uri_reply definition changed
+   dhcp6_client_enable_disable definition changed
+   dhcp6_clients_enable_disable definition changed dhcp6_duid_ll_set
+   definition changed dhcp6_pd_client_enable_disable definition changed
+   dhcp6_pd_reply_event only in image dhcp6_pd_send_client_message
+   definition changed dhcp6_reply_event only in image
+   dhcp6_send_client_message definition changed dhcp_client_config
+   definition changed dhcp_client_details only in image dhcp_client_dump
+   only in image dhcp_compl_event definition changed
+   dslite_address_details only in image dslite_address_dump only in
+   image gbp_endpoint_group_add_del definition changed
+   gbp_endpoint_group_details only in image gbp_endpoint_group_dump only
+   in image gbp_recirc_add_del definition changed gbp_recirc_details
+   only in image gbp_recirc_dump only in image gbp_subnet_add_del
+   definition changed gbp_subnet_details only in image gbp_subnet_dump
+   only in image hw_interface_set_mtu definition changed igmp_details
+   definition changed igmp_dump definition changed igmp_enable_disable
+   definition changed igmp_event definition changed
+   igmp_group_prefix_details only in image igmp_group_prefix_dump only
+   in image igmp_group_prefix_set definition changed igmp_listen
+   definition changed ikev2_profile_set_auth definition changed
+   ikev2_profile_set_id definition changed
+   ip6_add_del_address_using_prefix definition changed ip_mroute_add_del
+   definition changed ip_probe_neighbor definition changed
+   ip_scan_neighbor_enable_disable definition changed
+   ip_unnumbered_details only in image ip_unnumbered_dump only in image
+   ipip_6rd_add_tunnel definition changed ipip_add_tunnel definition
+   changed ipip_tunnel_details definition changed ipsec_sa_details
+   definition changed ipsec_sad_add_del_entry definition changed
+   ipsec_tunnel_if_add_del definition changed kp_add_del_pod definition
+   changed kp_add_del_vip definition changed kp_conf definition changed
+   lb_add_del_vip definition changed mactime_add_del definition changed
+   mactime_enable definition changed memclnt_create definition changed
+   memclnt_create_reply definition changed memfd_segment_create
+   definition changed nat44_add_del_lb_static_mapping definition changed
+   nat44_add_del_static_mapping definition changed nat44_del_session
+   definition changed nat44_lb_static_mapping_details definition changed
+   nat44_static_mapping_details definition changed
+   nat44_user_session_details definition changed pipe_create definition
+   changed pipe_delete definition changed pipe_details only in image
+   pipe_dump only in image pot_profile_activate definition changed
+   pot_profile_add definition changed pot_profile_del definition changed
+   proxy_arp_add_del definition changed proxy_arp_details only in image
+   proxy_arp_dump only in image proxy_arp_intfc_details only in image
+   proxy_arp_intfc_dump only in image sock_init_shm_reply definition
+   changed sockclnt_create definition changed sockclnt_create_reply
+   definition changed sr_localsid_add_del definition changed
+   sr_localsids_details definition changed sr_policies_details only in
+   image sr_policies_dump only in image sr_policy_add definition changed
+   sr_policy_del definition changed sr_policy_mod definition changed
+   sr_steering_pol_details only in image sr_steering_pol_dump only in
+   image sw_interface_details definition changed sw_interface_set_mtu
+   definition changed tap_create_v2 definition changed
+   vnet_bier_neighbor_counters only in image
+   vnet_get_summary_stats_reply definition changed vxlan_offload_rx
+   definition changed want_bier_neighbor_stats definition changed
+   want_dhcp6_pd_reply_events definition changed want_dhcp6_reply_events
+   definition changed Found 107 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``src/plugins/ioam/lib-pot/pot.api``
+
+* `e9fcf23 `_ Fix some build warnings about "Old Style VLA"
+
+``src/plugins/gbp/gbp.api``
+
+* `25b0494 `_ GBP V2
+
+``src/plugins/map/map.api``
+
+* `381e9a9 `_ MAP: Move MAP-E/T to a plugin.
+
+``src/plugins/igmp/igmp.api``
+
+* `947ea62 `_ IGMP improvements
+
+``src/plugins/lb/lb.api``
+
+* `d92a0b5 `_ Rework kube-proxy into LB plugin
+
+``src/plugins/nat/nat.api``
+
+* `70a26ac `_ NAT44: nat44_del_session and nat44_user_session_details API update (VPP-1271)
+* `ebdf190 `_ NAT44: TCP connection close detection (VPP-1266)
+* `1e5c07d `_ Add special Twice-NAT feature (VPP-1221)
+* `16aa7f8 `_ DSLite: Implement new API call DSLITE_ADDRESS_DUMP.
+
+``src/plugins/avf/avf.api``
+
+* `258a189 `_ avf: api fix
+* `6c9b964 `_ avf: binary API and configurable RX/TX queue size
+
+``src/plugins/mactime/mactime.api``
+
+* `7055e26 `_ Driver level time-based src mac filter
+
+``src/plugins/abf/abf.api``
+
+* `669d07d `_ ACL based forwarding
+
+``src/vlibmemory/memclnt.api``
+
+* `dab732a `_ VPP-1335 vapi crash when memclnt_keepalive received
+* `7895872 `_ Remove the historical memfd api segment bootstrap
+
+``src/vpp/stats/stats.api``
+
+* `a21a367 `_ VPP-1324 SIGSEGV vl_msg_api_handler_with_vm_node()
+* `586479a `_ BIER neighbor stats
+* `e906aac `_ STATS: Separate socket for fd exchange.
+* `048a4e5 `_ export counters in a memfd segment
+
+``src/vnet/interface.api``
+
+* `d723161 `_ MTU: Software interface / Per-protocol MTU support
+* `fe7d4a2 `_ Revert "MTU: Setting of MTU on software interface (instead of hardware interface)"
+* `70083ee `_ MTU: Setting of MTU on software interface (instead of hardware interface)
+
+``src/vnet/ipfix-export/ipfix_export.api``
+
+* `a9855ef `_ Flow: Rename IPFIX exporter.
+
+``src/vnet/dhcp/dhcp6_pd_client_cp.api``
+
+* `81119e8 `_ Implement DHCPv6 PD client (VPP-718, VPP-1050)
+
+``src/vnet/dhcp/dhcp.api``
+
+* `dd3b8f7 `_ Implement DHCPv6 IA NA client (VPP-1094)
+* `d9778c2 `_ Update DHCPv6 DUID code and fix coverity warnings
+* `81119e8 `_ Implement DHCPv6 PD client (VPP-718, VPP-1050)
+* `daff178 `_ DHCP Client Dump
+
+``src/vnet/dhcp/dhcp6_ia_na_client_cp.api``
+
+* `dd3b8f7 `_ Implement DHCPv6 IA NA client (VPP-1094)
+
+``src/vnet/ip/ip.api``
+
+* `947ea62 `_ IGMP improvements
+* `7eaaf74 `_ proxy_arp: remove unused is_add
+* `0053de6 `_ ARP proxy dumps
+* `9e2f915 `_ IP unnumbered dump
+* `7f358b3 `_ Periodic scan and probe of IP neighbors to maintain neighbor pools
+* `e821ab1 `_ IP mcast: allow unicast address as a next-hop
+* `c7b4304 `_ Implement ip_probe_neighbor API
+
+``src/vnet/ip/ip_types.api``
+
+* `947ea62 `_ IGMP improvements
+* `2c2feab `_ VPPAPIGEN: Add union and enum support and IP4/IP6 address type.
+
+``src/vnet/devices/af_packet/af_packet.api``
+
+* `04e0bb2 `_ af_packet: Add support for dump interfaces
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `d600ffe `_ Update tapv2 documentation
+* `0b06111 `_ VPP-1305: Add support for tags
+
+``src/vnet/devices/pipe/pipe.api``
+
+* `ee8b973 `_ VOM: support for pipes
+* `17ff3c1 `_ Pipes
+
+``src/vnet/ipip/ipip.api``
+
+* `d57f636 `_ VPP-1277: IPIP - Copy TOS/TC from inner packet to outer.
+
+``src/vnet/session/session.api``
+
+* `7fb0fe1 `_ udp/session: refactor to support dgram mode
+
+``src/vnet/ipsec/ipsec.api``
+
+* `4b089f2 `_ ipsec: support UDP encap/decap for NAT traversal
+* `e9fcf23 `_ Fix some build warnings about "Old Style VLA"
+* `8e1039a `_ Allow an IPsec tunnel interface to be renumbered
+
+``src/vnet/vxlan/vxlan.api``
+
+* `af86a48 `_ vxlan:offload RX flow
+
+``src/vnet/srv6/sr.api``
+
+* `3337bd2 `_ Fixed bugs in SRv6 API
+* `e9fcf23 `_ Fix some build warnings about "Old Style VLA"
+
+
diff --git a/docs/aboutvpp/releasenotes/v18.10.rst b/docs/aboutvpp/releasenotes/v18.10.rst
new file mode 100644
index 00000000000..952d7151e78
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v18.10.rst
@@ -0,0 +1,316 @@
+Release notes for VPP 18.10
+===========================
+
+More than 632 commits since the 18.07 release.
+
+Features
+--------
+
+Infrastructure
+~~~~~~~~~~~~~~
+
+-  DPDK 18.08 integration
+-  New Stats infrastructure (interface, error, node performance
+   counters)
+-  Add configurable “Doug Lea malloc” support
+
+VNET & Plugins
+~~~~~~~~~~~~~~
+
+-  Load balancing: support per-port VIP and all-port VIP
+-  Port NSH plugin to VPP
+-  NAT
+
+   -  Configurable port range
+   -  Virtual Fragmentation Reassembly for endpoint-dependent mode
+   -  Client-IP based session affinity for load-balancing
+   -  TCP MSS clamping
+   -  Session timeout
+   -  Bug-fixing and performance optimizations
+
+Host stack
+~~~~~~~~~~
+
+-  Support for applications with multiple workers
+-  Support for binds from multiple app workers to same ip:port
+-  Switched to a message queue for io and control event notifications
+-  Support for eventfd based notifications as alternative to
+   mutext-condvar pair
+-  VCL refactor to support async event notifications and multiple
+   workers
+-  TLS async support in client for HW accleration
+-  Performance optimizations and bug-fixing
+-  A number of binary APIs will be deprecated in favor of using the
+   event message queue. Details in the API section.
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+
+-  *Only in image*: indicates the API is new for this release.
+
+-  *Only in file*: indicates the API has been removed in this release.
+
+   ::
+
+                        Message Name                         Result
+
+   api_versions_reply definition changed
+   app_cut_through_registration_add definition changed
+   app_worker_add_del definition changed application_attach_reply
+   definition changed bd_ip_mac_details only in image bd_ip_mac_dump
+   only in image bfd_udp_get_echo_source definition changed
+   bier_imp_details definition changed bier_route_details definition
+   changed bind_sock definition changed bridge_domain_details definition
+   changed bridge_flags definition changed classify_add_del_session
+   definition changed classify_add_del_table definition changed
+   connect_sock definition changed create_vhost_user_if definition
+   changed get_first_msg_id_reply definition changed
+   gpe_add_del_fwd_entry_reply definition changed
+   gpe_fwd_entry_path_details definition changed ip6_fib_details
+   definition changed ip6nd_proxy_details definition changed
+   ip_add_del_route_reply definition changed ip_address_details
+   definition changed ip_details definition changed ip_fib_details
+   definition changed ip_mfib_details definition changed
+   ip_mroute_add_del_reply definition changed ip_neighbor_add_del_reply
+   definition changed ip_neighbor_details definition changed
+   ip_reassembly_get_reply definition changed ip_unnumbered_details
+   definition changed ipip_6rd_add_tunnel definition changed
+   ipip_add_tunnel definition changed ipsec_spds_details only in image
+   ipsec_spds_dump only in image l2_interface_efp_filter definition
+   changed lisp_eid_table_vni_details definition changed
+   map_another_segment definition changed mfib_signal_details definition
+   changed mpls_route_add_del_reply definition changed
+   mpls_tunnel_add_del definition changed mpls_tunnel_add_del_reply
+   definition changed mpls_tunnel_details definition changed
+   mpls_tunnel_dump definition changed one_eid_table_vni_details
+   definition changed qos_mark_enable_disable definition changed
+   qos_record_enable_disable definition changed reset_session_reply
+   definition changed rpc_call definition changed show_threads
+   definition changed sockclnt_create_reply definition changed
+   sockclnt_delete definition changed sockclnt_delete_reply definition
+   changed sw_interface_rx_placement_details only in image
+   sw_interface_rx_placement_dump only in image
+   sw_interface_set_ip_directed_broadcast definition changed
+   sw_interface_set_l2_bridge definition changed
+   sw_interface_set_rx_placement definition changed
+   sw_interface_set_vxlan_gbp_bypass definition changed udp_encap_add
+   definition changed udp_encap_add_del_reply only in file
+   udp_encap_add_reply only in image udp_encap_del definition changed
+   udp_encap_details definition changed unbind_sock definition changed
+   vxlan_gbp_tunnel_add_del definition changed vxlan_gbp_tunnel_details
+   only in image vxlan_gbp_tunnel_dump only in image Found 68 api
+   message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``src/plugins/avf/avf.api``
+
+* `149d0e28 `_ avf: RSS support
+* `4e6014fc `_ avf: api fix
+
+``src/plugins/gbp/gbp.api``
+
+* `c0a93143 `_ GBP Endpoint Updates
+* `61b94c6b `_ vxlan-gbp: Add support for vxlan gbp
+
+``src/plugins/igmp/igmp.api``
+
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+
+``src/plugins/lb/lb.api``
+
+* `6a4375e0 `_ LB: fix flush flow table issue
+* `49ca2601 `_ Add flush flag on del as command
+* `219cc90c `_ Support lb on both vip and per-port-vip case
+
+``src/plugins/nat/nat.api``
+
+* `bb4e0225 `_ NAT: TCP MSS clamping
+* `5d28c7af `_ NAT: add support for configurable port range (VPP-1346)
+* `ea5b5be4 `_ NAT44: client-IP based session affinity for load-balancing (VPP-1297)
+* `878c646a `_ NAT44: add support for session timeout (VPP-1272)
+* `69ce30d6 `_ NAT: update nat_show_config_reply API (VPP-1403)
+* `6bd197eb `_ Remove client_index field from replies in API
+* `c6c0d2a0 `_ NAT44: LB NAT - local backends in multiple VRFs (VPP-1345)
+
+``src/plugins/vmxnet3/vmxnet3.api``
+
+* `df7f8e8c `_ vmxnet3 device driver
+
+``src/plugins/nsh/nsh.api``
+
+* `d313f9e6 `_ Port NSH plugin to VPP
+
+``src/plugins/nsim/nsim.api``
+
+* `9e3252b5 `_ Network delay simulator plugin
+
+``src/plugins/svs/svs.api``
+
+* `d1e68ab7 `_ Source VRF Select
+
+``src/vlibmemory/memclnt.api``
+
+* `94495f2a `_ PAPI: Use UNIX domain sockets instead of shared memory
+* `6bd197eb `_ Remove client_index field from replies in API
+* `75282457 `_ Fix "Old Style VLA" build warnings
+
+``src/vnet/interface.api``
+
+* `f0b42f48 `_ itf: dump interface rx-placement
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+* `54f7c51f `_ rx-placement: Add API call for interface rx-placement
+* `1855b8e4 `_ IP directed broadcast
+
+``src/vnet/bfd/bfd.api``
+
+* `2d3c7b9c `_ BFD: add get echo source API (VPP-1367)
+
+``src/vnet/bier/bier.api``
+
+* `ef90ed08 `_ BIER API and load-balancing fixes
+* `6bd197eb `_ Remove client_index field from replies in API
+
+``src/vnet/classify/classify.api``
+
+* `34eb5d42 `_ classify_add_del_session API: Use more descriptive docstring (VPP-1385)
+* `75282457 `_ Fix "Old Style VLA" build warnings
+
+``src/vnet/devices/pipe/pipe.api``
+
+* `208c29aa `_ VOM: support for pipes
+
+``src/vnet/devices/virtio/vhost_user.api``
+
+* `ee2e58f6 `_ vhost-user: Add disable feature support in api
+
+``src/vnet/ethernet/ethernet_types.api``
+
+* `de5b08fb `_ Introduce a mac_address_t on the API and in VPP
+
+``src/vnet/ip/ip_types.api``
+
+* `d0df49f2 `_ Use IP address types on UDP encap API
+
+``src/vnet/ip/ip.api``
+
+* `412ecd32 `_ Improve ip_mroute_add_del documentation
+* `14260393 `_ Add adjacency counters to the stats segment
+* `28c142e3 `_ mroute routers in the stats segment
+* `008dbe10 `_ Route counters in the stats segment
+* `de5b08fb `_ Introduce a mac_address_t on the API and in VPP
+* `6bd197eb `_ Remove client_index field from replies in API
+* `b11f903a `_ Fix context field position in API definition
+
+``src/vnet/ipip/ipip.api``
+
+* `61502115 `_ IPIP and SIXRD tunnels create API needs table-IDs not fib-indexes
+
+``src/vnet/ipsec/ipsec.api``
+
+* `a9a0b2ce `_ IPsec: add API for SPDs dump (VPP-1363)
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+
+``src/vnet/l2/l2.api``
+
+* `0a4e0063 `_ Fix documentation about sw_interface_set_l2_bridge
+* `b474380f `_ L2 BD: introduce a BD interface on which to send UU packets
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+* `5c7c49d1 `_ Fix documentation for SHG in bridge domain
+* `5d82d2f1 `_ l2: arp termination dump
+* `6b9b41c8 `_ L2 EFP: byteswap sw_if_index, enable flag can be u8 on .api
+
+``src/vnet/lisp-cp/lisp.api``
+
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+* `6bd197eb `_ Remove client_index field from replies in API
+
+``src/vnet/lisp-cp/one.api``
+
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+* `6bd197eb `_ Remove client_index field from replies in API
+
+``src/vnet/lisp-gpe/lisp_gpe.api``
+
+* `6bd197eb `_ Remove client_index field from replies in API
+* `b11f903a `_ Fix context field position in API definition
+
+``src/vnet/mpls/mpls.api``
+
+* `f5fa5ae2 `_ MPLS tunnel dump: use sw_if_index not tunnel_index
+* `6a30b5f9 `_ MPLS tunnel dump fix
+* `008dbe10 `_ Route counters in the stats segment
+* `7c922dc4 `_ SR-MPLS: fixes and tests
+
+``src/vnet/qos/qos.api``
+
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+* `ed234e7f `_ Enum type on the API for QoS sources
+
+``src/vnet/session/session.api``
+
+* `ab2f6dbf `_ session: support multiple worker binds
+* `134a996a `_ vcl: add support for multi-worker apps
+* `1553197f `_ session: add support for multiple app workers
+* `6bd197eb `_ Remove client_index field from replies in API
+* `99368315 `_ vcl: support for eventfd mq signaling
+
+``src/vnet/span/span.api``
+
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+
+``src/vnet/udp/udp.api``
+
+* `9c0a3c42 `_ UDP-Encap: name counters for the stats segment
+* `d0df49f2 `_ Use IP address types on UDP encap API
+
+``src/vnet/unix/tap.api``
+
+* `bdc0e6b7 `_ Trivial: Clean up some typos.
+
+``src/vnet/vxlan-gbp/vxlan_gbp.api``
+
+* `79a05f54 `_ VXLAN-GBP: use common types on the API
+* `61b94c6b `_ vxlan-gbp: Add support for vxlan gbp
+
+``src/vpp/api/vpe.api``
+
+* `5d64c786 `_ thread: Add show threads api
+* `ec11b13a `_ Trivial: Cleanup some typos.
+
+``src/vpp/stats/stats.api``
+
+* `ec11b13a `_ Trivial: Cleanup some typos.
+
+Notice of future API deprecation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  bind_uri_reply
+-  accept_session
+-  accept_session_reply
+-  disconnect_session_reply
+-  reset_session
+-  reset_session_reply
+-  bind_sock_reply
+-  connect_session_reply
diff --git a/docs/aboutvpp/releasenotes/v19.01.1.rst b/docs/aboutvpp/releasenotes/v19.01.1.rst
new file mode 100644
index 00000000000..a3a53abb069
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.01.1.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 19.01.1
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.01.2.rst b/docs/aboutvpp/releasenotes/v19.01.2.rst
new file mode 100644
index 00000000000..5aef09c48fb
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.01.2.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 19.01.2
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.01.3.rst b/docs/aboutvpp/releasenotes/v19.01.3.rst
new file mode 100644
index 00000000000..f3d5a1c9896
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.01.3.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 19.01.3
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.01.rst b/docs/aboutvpp/releasenotes/v19.01.rst
new file mode 100644
index 00000000000..b2311c84950
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.01.rst
@@ -0,0 +1,413 @@
+Release notes for VPP 19.01
+===========================
+
+More than 649 commits since the 18.10 release.
+
+Features
+--------
+
+Infrastructure
+~~~~~~~~~~~~~~
+
+-  NUMA-aware, growable physical memory allocator (pmalloc)
+-  FIB: sticky load-balance
+-  C11 safe string handling: provide and use “safe” C string handling
+   functions
+-  vlib: allocate buffers on local numa, not on numa 1
+-  vppinfra: autodetect default hugepage size
+-  Move RPC traffic off the shared-memory API queue
+-  IPv6: Make link-local configurable per-interface
+-  IGMP: improve CLI debug output
+-  IPSec: split ipsec nodes into ip4/ip6 nodes
+-  IPSec: infra for selecting backends
+-  vhost-user: cleanup and performance optimizations
+-  ethernet-input, memif improvements and optimizations
+-  DPDK: bump to DPDK 18.11
+-  reassembly: harden reassembly code
+-  stats: Deprecate old (event-based) stats framework
+-  vlib: support Hyper-V/Azure VMBus
+-  binary api clients: wait for vpp to start
+-  graph dispatch trace: capture packet data and buffer metadata, output
+   in pcap format
+-  improve feature arc order constraint specification
+
+VNET & Plugins
+~~~~~~~~~~~~~~
+
+-  pktgen: correctly replay a mix of single and multi-buffer packets
+-  add wireshark dissector to extras
+-  avf: optimizations
+-  acl-plugin: use L2 feature arc instead of L2 classifier
+-  acl-plugin: performance enhancement
+-  dpdk: allow interface name to be specified from startup.conf
+-  dpdk: blacklist PCI devices by type
+-  dpdk: switch to in-memory mode, deprecate use of socket-mem
+-  vnet: store hw interface speed in kbps instead of using flags
+-  vmxnet3: enable promiscuous mode & cli enhancements
+-  gbp: Add support for flow hash profile & l3-out subnets
+-  map: Add API support for setting parameters.
+-  map: Convert from DPO to input feature
+-  nat: improve expired sessions reuse in NAT44
+-  nat: syslog - sessions logging
+-  nsim: add packet loss simulation, docs
+-  perfmon: x86_64 perf counter plugin
+-  vnet: L2 feature arc infrastructure
+
+Host stack
+~~~~~~~~~~
+
+-  TCP congestion control improvements
+-  TCP Cubic congestion control algorithm
+-  TCP fast path optimizations
+-  Transport tx connection pacer. TCP uses it by default
+-  Basic support for session flushing and TCP PSH segments
+-  TCP/session api support for configuring custom local src ip/port
+-  VCL/LDP basic support for multi-process applications
+-  Overall code hardening, cleanup and bugfixing for tcp, session, vcl
+   and ldp
+
+PAPI & Test framework
+~~~~~~~~~~~~~~~~~~~~~
+
+-  add specific API types for IP addresses, MAC address, interface index
+   etc.
+-  add timeout support for socket transport
+-  add support for format/unformat functions
+-  generic API types format/unformat support for VAT and custom dump
+-  python3 test adjustments
+-  make test: create virtualenv under /test/
+-  make test: print TEST= values for failed tests
+-  add human-friendly annotations to log messages
+
+VOM
+~~~
+
+-  Add support for redirect contracts in gbp
+-  deprecate TAP add ip-punt redirect dump
+-  vxlan-gbp support
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+=============================================== ==================
+Message Name                                    Results
+=============================================== ==================
+acl_plugin_get_conn_table_max_entries           only in image
+acl_plugin_get_conn_table_max_entries_reply     only in image
+app_worker_add_del                              definition changed
+app_worker_add_del_reply                        definition changed
+application_attach_reply                        definition changed
+bd_ip_mac_add_del                               definition changed
+bd_ip_mac_details                               definition changed
+bd_ip_mac_flush                                 only in image
+bd_ip_mac_flush_reply                           only in image
+bond_create                                     definition changed
+cli_inband                                      definition changed
+cli_inband_reply                                definition changed
+gbp_bridge_domain_add                           only in image
+gbp_bridge_domain_add_reply                     only in image
+gbp_bridge_domain_del                           only in image
+gbp_bridge_domain_del_reply                     only in image
+gbp_bridge_domain_details                       only in image
+gbp_bridge_domain_dump                          only in image
+gbp_bridge_domain_dump_reply                    only in image
+gbp_endpoint_details                            definition changed
+gbp_endpoint_group_add                          only in image
+gbp_endpoint_group_add_del                      only in file
+gbp_endpoint_group_add_del_reply                only in file
+gbp_endpoint_group_add_reply                    only in image
+gbp_endpoint_group_del                          only in image
+gbp_endpoint_group_del_reply                    only in image
+gbp_endpoint_learn_set_inactive_threshold       only in image
+gbp_endpoint_learn_set_inactive_threshold_reply only in image
+gbp_ext_itf_add_del                             only in image
+gbp_ext_itf_add_del_reply                       only in image
+gbp_ext_itf_details                             only in image
+gbp_ext_itf_dump                                only in image
+gbp_route_domain_add                            only in image
+gbp_route_domain_add_reply                      only in image
+gbp_route_domain_del                            only in image
+gbp_route_domain_del_reply                      only in image
+gbp_route_domain_details                        only in image
+gbp_route_domain_dump                           only in image
+gbp_route_domain_dump_reply                     only in image
+gbp_vxlan_tunnel_add                            only in image
+gbp_vxlan_tunnel_add_reply                      only in image
+gbp_vxlan_tunnel_del                            only in image
+gbp_vxlan_tunnel_del_reply                      only in image
+gbp_vxlan_tunnel_details                        only in image
+gbp_vxlan_tunnel_dump                           only in image
+igmp_proxy_device_add_del                       only in image
+igmp_proxy_device_add_del_interface             only in image
+igmp_proxy_device_add_del_interface_reply       only in image
+igmp_proxy_device_add_del_reply                 only in image
+ip6_mfib_details                                definition changed
+ip_container_proxy_details                      only in image
+ip_container_proxy_dump                         only in image
+ip_mfib_details                                 definition changed
+ip_punt_redirect                                definition changed
+ip_punt_redirect_details                        only in image
+ip_punt_redirect_dump                           only in image
+ip_source_check_interface_add_del               only in image
+ip_source_check_interface_add_del_reply         only in image
+ipip_6rd_add_tunnel_reply                       definition changed
+ipip_6rd_del_tunnel                             definition changed
+ipip_add_tunnel_reply                           definition changed
+ipip_del_tunnel                                 definition changed
+ipip_tunnel_details                             definition changed
+ipip_tunnel_dump                                definition changed
+ipsec_backend_details                           only in image
+ipsec_backend_dump                              only in image
+ipsec_sa_details                                definition changed
+ipsec_select_backend                            only in image
+ipsec_select_backend_reply                      only in image
+ipsec_tunnel_if_add_del                         definition changed
+map_add_del_rule                                definition changed
+map_add_domain                                  definition changed
+map_another_segment                             definition changed
+map_domain_details                              definition changed
+map_if_enable_disable                           only in image
+map_if_enable_disable_reply                     only in image
+map_param_add_del_pre_resolve                   only in image
+map_param_add_del_pre_resolve_reply             only in image
+map_param_get                                   only in image
+map_param_get_reply                             only in image
+map_param_set_fragmentation                     only in image
+map_param_set_fragmentation_reply               only in image
+map_param_set_icmp6                             only in image
+map_param_set_icmp6_reply                       only in image
+map_param_set_icmp                              only in image
+map_param_set_icmp_reply                        only in image
+map_param_set_reassembly                        only in image
+map_param_set_reassembly_reply                  only in image
+map_param_set_security_check                    only in image
+map_param_set_security_check_reply              only in image
+map_param_set_tcp                               only in image
+map_param_set_tcp_reply                         only in image
+map_param_set_traffic_class                     only in image
+map_param_set_traffic_class_reply               only in image
+map_rule_details                                definition changed
+memclnt_delete                                  definition changed
+nat44_add_del_lb_static_mapping                 definition changed
+nat44_lb_static_mapping_add_del_local           only in image
+nat44_lb_static_mapping_add_del_local_reply     only in image
+nat44_lb_static_mapping_details                 definition changed
+nsim_configure                                  definition changed
+punt                                            only in file
+punt_details                                    only in image
+punt_dump                                       only in image
+punt_reply                                      only in file
+punt_socket_deregister                          definition changed
+punt_socket_details                             only in image
+punt_socket_dump                                only in image
+punt_socket_register                            definition changed
+set_ip_flow_hash                                definition changed
+set_punt                                        only in image
+set_punt_reply                                  only in image
+show_version_reply                              definition changed
+stats_get_poller_delay                          only in file
+stats_get_poller_delay_reply                    only in file
+sw_interface_bond_details                       definition changed
+sw_interface_details                            definition changed
+sw_interface_ip6_set_link_local_address         only in file
+sw_interface_ip6_set_link_local_address_reply   only in file
+sw_interface_tap_v2_details                     definition changed
+syslog_get_filter                               only in image
+syslog_get_filter_reply                         only in image
+syslog_get_sender                               only in image
+syslog_get_sender_reply                         only in image
+syslog_set_filter                               only in image
+syslog_set_filter_reply                         only in image
+syslog_set_sender                               only in image
+syslog_set_sender_reply                         only in image
+tap_create_v2                                   definition changed
+unmap_segment                                   definition changed
+vnet_bier_neighbor_counters                     only in file
+vnet_get_summary_stats                          only in file
+vnet_get_summary_stats_reply                    only in file
+vnet_interface_combined_counters                only in file
+vnet_interface_simple_counters                  only in file
+vnet_ip4_fib_counters                           only in file
+vnet_ip4_mfib_counters                          only in file
+vnet_ip4_nbr_counters                           only in file
+vnet_ip6_fib_counters                           only in file
+vnet_ip6_mfib_counters                          only in file
+vnet_ip6_nbr_counters                           only in file
+vnet_per_interface_combined_counters            only in file
+vnet_per_interface_simple_counters              only in file
+vnet_udp_encap_counters                         only in file
+want_bier_neighbor_stats                        only in file
+want_bier_neighbor_stats_reply                  only in file
+want_interface_combined_stats                   only in file
+want_interface_combined_stats_reply             only in file
+want_interface_simple_stats                     only in file
+want_interface_simple_stats_reply               only in file
+want_ip4_fib_stats                              only in file
+want_ip4_fib_stats_reply                        only in file
+want_ip4_mfib_stats                             only in file
+want_ip4_mfib_stats_reply                       only in file
+want_ip4_nbr_stats                              only in file
+want_ip4_nbr_stats_reply                        only in file
+want_ip6_fib_stats                              only in file
+want_ip6_fib_stats_reply                        only in file
+want_ip6_mfib_stats                             only in file
+want_ip6_mfib_stats_reply                       only in file
+want_ip6_nbr_stats                              only in file
+want_ip6_nbr_stats_reply                        only in file
+want_per_interface_combined_stats               only in file
+want_per_interface_combined_stats_reply         only in file
+want_per_interface_simple_stats                 only in file
+want_per_interface_simple_stats_reply           only in file
+want_stats                                      only in file
+want_stats_reply                                only in file
+want_udp_encap_stats                            only in file
+want_udp_encap_stats_reply                      only in file
+=============================================== ==================
+
+Found 170 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``src/vnet/interface_types.api``
+
+* `53fffa1 `_ API: Add support for type aliases
+
+``src/vnet/interface.api``
+
+* `f49ba0e `_ stats: Deprecate old stats framework
+* `53fffa1 `_ API: Add support for type aliases
+* `5100aa9 `_ vnet: store hw interface speed in kbps instead of using flags
+
+``src/vnet/syslog/syslog.api``
+
+* `b4515b4 `_ Add RFC5424 syslog protocol support (VPP-1139)
+
+``src/vnet/fib/fib_types.api``
+
+* `775f73c `_ FIB: encode the label stack in the FIB path during table dump
+
+``src/vnet/ip/ip.api``
+
+* `7c03ed4 `_ VOM: mroutes
+* `3460b01 `_ api: ip_source_check_interface_add_del api is added.
+* `609e121 `_ VPP-1507: Added binary api to dump configured ip_punt_redirect
+* `2af0e3a `_ flow-hash: Add symmetric flag for flow hashing
+* `47527b2 `_ IP-punt: add documentation to the API and fix IP address init
+* `5bb1eca `_ IPv6: Make link-local configurable per-interface (VPP-1446)
+* `75b9f45 `_ ip: add container proxy dump API (VPP-1364)
+
+``src/vnet/ip/ip_types.api``
+
+* `8c8acc0 `_ API: Change ip4_address and ip6_address to use type alias.
+* `ffba3c3 `_ MAP: Use explicit address/prefix types in API
+
+``src/vnet/ip/punt.api``
+
+* `e88865d `_ VPP-1506: dump local punts and registered punt sockets
+
+``src/vnet/ipsec/ipsec.api``
+
+* `4c422f9 `_ Add IPSec interface FIB index for TX packet
+* `b4a7a7d `_ Add UDP encap flag
+* `b4d3053 `_ ipsec: infra for selecting backends
+* `871bca9 `_ VPP-1450: binary api call for dumping SPD to interface registration
+
+``src/vnet/l2/l2.api``
+
+* `e26c81f `_ L2 BD API to flush all IP-MAC entries in the specified BD
+* `8006c6a `_ PAPI: Add MACAddress object wrapper for vl_api_mac_address_t
+* `93cc3ee `_ GBP Endpoint Learning
+* `4d5b917 `_ BD ARP entry use common API types
+
+``src/vnet/vxlan-gbp/vxlan_gbp.api``
+
+* `93cc3ee `_ GBP Endpoint Learning
+
+``src/vnet/ipip/ipip.api``
+
+* `53fffa1 `_ API: Add support for type aliases
+
+``src/vnet/session/session.api``
+
+* `d85de68 `_ vcl: wait for segments with segment handle
+* `fa76a76 `_ session: segment handle in accept/connect notifications
+* `c1f5a43 `_ session: cleanup use of api_client_index
+* `c0d532d `_ session: mark apis for deprecation
+
+``src/vnet/ethernet/ethernet_types.api``
+
+* `8006c6a `_ PAPI: Add MACAddress object wrapper for vl_api_mac_address_t
+
+``src/vnet/bonding/bond.api``
+
+* `ad9d528 `_ bonding: support custom interface IDs
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `754f24b `_ tapv2: add "tap_flags" field to the TAPv2 interface API
+
+``src/vlibmemory/memclnt.api``
+
+* `eaec2a6 `_ bapi: add options to have vpp cleanup client registration
+
+``src/vpp/api/vpe.api``
+
+* `f49ba0e `_ stats: Deprecate old stats framework
+* `413f4a5 `_ API: Use string type instead of u8.
+
+``src/plugins/acl/acl.api``
+
+* `bb5d22d `_ New api in order to get max entries of connection table is added.
+
+``src/plugins/nsim/nsim.api``
+
+* `10c5ff1 `_ nsim: add packet loss simulation, docs
+
+``src/plugins/gbp/gbp.api``
+
+* `1c17e2e `_ GBP: add allowed ethertypes to contracts
+* `b6a4795 `_ GBP: l3-out subnets
+* `33b81da `_ vom: Add support for redirect contracts in gbp
+* `13a08cc `_ GBP: redirect contracts
+* `c29c0af `_ GBP: Endpoints with VLAN tags and birdges that don't learn
+* `93cc3ee `_ GBP Endpoint Learning
+
+``src/plugins/nat/nat.api``
+
+* `b686508 `_ NAT44: nat44_add_del_lb_static_mapping enhancements (VPP-1514)
+
+``src/plugins/map/map.api``
+
+* `fc7344f `_ MAP: Convert from DPO to input feature.
+* `f34597f `_ MAP: Add API support for MAP input feature.
+* `5a2e278 `_ MAP: Add API support for setting parameters.
+* `a173a7a `_ MAP: Use bool type in map.api instead of u8.
+* `ffba3c3 `_ MAP: Use explicit address/prefix types in API
+
+``src/plugins/igmp/igmp.api``
+
+* `97748ca `_ IGMP: proxy device
+
diff --git a/docs/aboutvpp/releasenotes/v19.04.1.rst b/docs/aboutvpp/releasenotes/v19.04.1.rst
new file mode 100644
index 00000000000..f7c46df4f68
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.04.1.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 19.04.1
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.04.2.rst b/docs/aboutvpp/releasenotes/v19.04.2.rst
new file mode 100644
index 00000000000..9d15b52343a
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.04.2.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 19.04.2
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.04.3.rst b/docs/aboutvpp/releasenotes/v19.04.3.rst
new file mode 100644
index 00000000000..c10d969cffd
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.04.3.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 19.04.3
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.04.rst b/docs/aboutvpp/releasenotes/v19.04.rst
new file mode 100644
index 00000000000..9c5c1b1697f
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.04.rst
@@ -0,0 +1,387 @@
+Release notes for VPP 19.04
+===========================
+
+More than 700 commits since the 19.01 release.
+
+Features
+--------
+
+Infrastructure
+~~~~~~~~~~~~~~
+
+-  DPDK 19.02 integration
+-  Buffer manager rework and improvements
+-  Python3 migration (work in progress)
+
+   -  vppapigen
+   -  Python API wrappers
+   -  Docs generation
+   -  vpp_config
+   -  “make test” python3 readiness and refactoring
+
+-  Add “make test-gcov” target to main Makefile
+-  Refactor multiarch code
+-  vfctl script: bind VF to vfio-pci after VF is created
+-  cmake cross-compilation support
+-  CLI control of graph dispatch elogs
+-  AppImage packaging (disabled by default)
+-  Complete upstreaming of wireshark dissector
+-  Remove JVPP which is now an FD.io project
+-  Punt infra: manage dispatch of exception packets
+
+VNET & Plugins
+~~~~~~~~~~~~~~
+
+-  BVI Interface
+-  Deprecate TAP cli
+-  Experimental TAP interface TCP segmentation offload
+-  Vmxnet3 driver plugin
+-  LACP passive mode
+-  ACL plugin refactoring
+-  RDMA (ibverb) driver plugin - MLX5 with multiqueue
+-  IPSEC
+
+   -  Intel IPSEC-MB engine plugin
+   -  Tunnel fragmentation
+   -  CLI improvements
+   -  Performance improvements
+   -  API modernisation and improvements
+   -  New Tests and test refactoring
+
+-  Crypto
+
+   -  Introduce crypto infra
+   -  crypto_ia32 plugin
+   -  Add support for AEAD and AES-GCM
+   -  Implement rfc4231 test cases
+   -  Implement crypto tests per RFC2202
+
+-  Perfmon improvements
+
+   -  Python to C parser for intel CPUs
+   -  2-way parallel stat collection
+   -  Collect data on selected thread(s)
+
+Host stack
+~~~~~~~~~~
+
+-  Improve ldp/vls/vcl support for multi-process and multi-threaded
+   applications
+-  Major refactor/cleanup of session layer
+-  Refactor cut-through sessions to use a custom transport
+-  Baseline QUIC transport support
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+=============================================== ==================
+Message Name                                    Result
+=============================================== ==================
+accept_session                                  only in file
+accept_session_reply                            only in file
+bind_sock_reply                                 definition changed
+bind_uri_reply                                  definition changed
+bvi_create                                      only in image
+bvi_create_reply                                only in image
+bvi_delete                                      only in image
+bvi_delete_reply                                only in image
+connect_session                                 only in file
+connect_session_reply                           only in file
+ct6_enable                                      only in image
+ct6_enable_disable                              only in image
+gbp_contract_add_del_reply                      definition changed
+gbp_endpoint_group_del                          definition changed
+gbp_endpoint_learn_set_inactive_threshold       only in file
+gbp_endpoint_learn_set_inactive_threshold_reply only in file
+ikev2_plugin_get_version                        only in image
+ikev2_plugin_get_version_reply                  only in image
+ip4_arp_event                                   definition changed
+ip6_nd_event                                    definition changed
+ip6_ra_event                                    definition changed
+ip6nd_proxy_add_del                             definition changed
+ip6nd_proxy_details                             definition changed
+ip_container_proxy_add_del                      definition changed
+ip_neighbor_add_del                             definition changed
+ip_neighbor_details                             definition changed
+ip_probe_neighbor                               definition changed
+ip_source_and_port_range_check_add_del          definition changed
+ipsec_backend_details                           definition changed
+ipsec_gre_add_del_tunnel                        only in file
+ipsec_gre_add_del_tunnel_reply                  only in file
+ipsec_gre_tunnel_add_del                        only in image
+ipsec_gre_tunnel_add_del_reply                  only in image
+ipsec_gre_tunnel_details                        definition changed
+ipsec_sa_details                                definition changed
+ipsec_sa_set_key                                definition changed
+ipsec_sad_add_del_entry                         only in file
+ipsec_sad_add_del_entry_reply                   only in file
+ipsec_sad_entry_add_del                         only in image
+ipsec_sad_entry_add_del_reply                   only in image
+ipsec_select_backend                            definition changed
+ipsec_spd_add_del_entry                         only in file
+ipsec_spd_add_del_entry_reply                   only in file
+ipsec_spd_details                               definition changed
+ipsec_spd_entry_add_del                         only in image
+ipsec_spd_entry_add_del_reply                   only in image
+ipsec_tunnel_if_add_del                         definition changed
+lb_conf                                         definition changed
+map_add_domain                                  definition changed
+map_domain_details                              definition changed
+nat_ha_flush                                    only in image
+nat_ha_flush_reply                              only in image
+nat_ha_get_failover                             only in image
+nat_ha_get_failover_reply                       only in image
+nat_ha_get_listener                             only in image
+nat_ha_get_listener_reply                       only in image
+nat_ha_resync                                   only in image
+nat_ha_resync_completed_event                   only in image
+nat_ha_resync_reply                             only in image
+nat_ha_set_failover                             only in image
+nat_ha_set_failover_reply                       only in image
+nat_ha_set_listener                             only in image
+nat_ha_set_listener_reply                       only in image
+reset_session                                   only in file
+reset_session_reply                             only in file
+sw_interface_ip6nd_ra_prefix                    definition changed
+sw_interface_set_dpdk_hqos_pipe                 only in file
+sw_interface_set_dpdk_hqos_pipe_reply           only in file
+sw_interface_set_dpdk_hqos_subport              only in file
+sw_interface_set_dpdk_hqos_subport_reply        only in file
+sw_interface_set_dpdk_hqos_tctbl                only in file
+sw_interface_set_dpdk_hqos_tctbl_reply          only in file
+sw_interface_tap_details                        only in file
+sw_interface_tap_dump                           only in file
+sw_interface_virtio_pci_details                 only in image
+sw_interface_virtio_pci_dump                    only in image
+tap_connect                                     only in file
+tap_connect_reply                               only in file
+tap_delete                                      only in file
+tap_delete_reply                                only in file
+tap_modify                                      only in file
+tap_modify_reply                                only in file
+virtio_pci_create                               only in image
+virtio_pci_create_reply                         only in image
+virtio_pci_delete                               only in image
+virtio_pci_delete_reply                         only in image
+vmxnet3_create                                  definition changed
+vmxnet3_details                                 definition changed
+want_ip4_arp_events                             definition changed
+want_ip6_nd_events                              definition changed
+=============================================== ==================
+
+Found 90 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``src/vlibmemory/memclnt.api``
+
+* `eaec2a6d9 `_ bapi: add options to have vpp cleanup client registration
+
+``src/vpp/api/vpe.api``
+
+* `1aaf0e343 `_ deprecate tapcli
+* `f49ba0e81 `_ stats: Deprecate old stats framework
+* `413f4a5b2 `_ API: Use string type instead of u8.
+
+``src/vnet/interface.api``
+
+* `3b0d7e42f `_ Revert "API: Cleanup APIs interface.api"
+* `e63325e3c `_ API: Cleanup APIs interface.api
+* `bb2c7b580 `_ Update documentation for src/vnet/interface.api sw_interface_dump
+* `f49ba0e81 `_ stats: Deprecate old stats framework
+* `53fffa1db `_ API: Add support for type aliases
+* `5100aa9cb `_ vnet: store hw interface speed in kbps instead of using flags
+
+``src/vnet/interface_types.api``
+
+* `3b0d7e42f `_ Revert "API: Cleanup APIs interface.api"
+* `e63325e3c `_ API: Cleanup APIs interface.api
+* `53fffa1db `_ API: Add support for type aliases
+
+``src/vnet/bonding/bond.api``
+
+* `ad9d52831 `_ bonding: support custom interface IDs
+
+``src/vnet/ipip/ipip.api``
+
+* `53fffa1db `_ API: Add support for type aliases
+
+``src/vnet/ipsec-gre/ipsec_gre.api``
+
+* `e524d45ef `_ IPSEC-GRE: fixes and API update to common types.
+
+``src/vnet/syslog/syslog.api``
+
+* `b4515b4be `_ Add RFC5424 syslog protocol support (VPP-1139)
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `754f24b35 `_ tapv2: add "tap_flags" field to the TAPv2 interface API
+
+``src/vnet/devices/virtio/virtio.api``
+
+* `d6c15af33 `_ virtio: Native virtio driver
+
+``src/vnet/fib/fib_types.api``
+
+* `775f73c6b `_ FIB: encode the label stack in the FIB path during table dump
+
+``src/vnet/ip/ip_types.api``
+
+* `8c8acc027 `_ API: Change ip4_address and ip6_address to use type alias.
+* `ffba3c377 `_ MAP: Use explicit address/prefix types in API
+
+``src/vnet/ip/ip.api``
+
+* `48ae19e90 `_ API: Add python2.7 support for enum flags via aenum
+* `37029305c `_ Use IP and MAC API types for neighbors
+* `7c03ed47d `_ VOM: mroutes
+* `3460b014a `_ api: ip_source_check_interface_add_del api is added.
+* `609e1210c `_ VPP-1507: Added binary api to dump configured ip_punt_redirect
+* `2af0e3a74 `_ flow-hash: Add symmetric flag for flow hashing
+* `47527b24a `_ IP-punt: add documentation to the API and fix IP address init
+* `5bb1ecae8 `_ IPv6: Make link-local configurable per-interface (VPP-1446)
+* `75b9f45a1 `_ ip: add container proxy dump API (VPP-1364)
+
+``src/vnet/ip/punt.api``
+
+* `e88865d7b `_ VPP-1506: dump local punts and registered punt sockets
+
+``src/vnet/vxlan-gbp/vxlan_gbp.api``
+
+* `4dd4cf4f9 `_ GBP: fixes for l3-out routing
+* `93cc3ee3b `_ GBP Endpoint Learning
+
+``src/vnet/ethernet/ethernet_types.api``
+
+* `8006c6aa4 `_ PAPI: Add MACAddress object wrapper for vl_api_mac_address_t
+
+``src/vnet/ipsec/ipsec.api``
+
+* `1e3aa5e21 `_ ipsec: USE_EXTENDED_SEQ_NUM -> USE_ESN
+* `1ba5bc8d8 `_ ipsec: add ipv6 support for ipsec tunnel interface
+* `5d704aea5 `_ updates now that flags are supported on the API
+* `53f526b68 `_ TEST: IPSEC NAT-T with UDP header
+* `7c44d78ef `_ IKEv2 to plugin
+* `eba31eceb `_ IPSEC: move SA counters into the stats segment
+* `8d7c50200 `_ IPSEC: no second lookup after tunnel encap
+* `a09c1ff5b `_ IPSEC: SPD counters in the stats sgement
+* `17dcec0b9 `_ IPSEC: API modernisation
+* `4c422f9a3 `_ Add IPSec interface FIB index for TX packet
+* `b4a7a7dcf `_ Add UDP encap flag
+* `b4d305344 `_ ipsec: infra for selecting backends
+* `871bca9aa `_ VPP-1450: binary api call for dumping SPD to interface registration
+
+``src/vnet/tcp/tcp.api``
+
+* `c5df8c71c `_ host stack: update stale copyright
+
+``src/vnet/l2/l2.api``
+
+* `192b13f96 `_ BVI Interface
+* `5daf0c55c `_ add default NONE flag for bd_flags
+* `e26c81fc8 `_ L2 BD API to flush all IP-MAC entries in the specified BD
+* `8006c6aa4 `_ PAPI: Add MACAddress object wrapper for vl_api_mac_address_t
+* `93cc3ee3b `_ GBP Endpoint Learning
+* `4d5b917b1 `_ BD ARP entry use common API types
+
+``src/vnet/session/session.api``
+
+* `6442401c2 `_ session: remove deprecated binary apis
+* `d85de68ec `_ vcl: wait for segments with segment handle
+* `fa76a76bf `_ session: segment handle in accept/connect notifications
+* `c1f5a4336 `_ session: cleanup use of api_client_index
+* `c0d532d17 `_ session: mark apis for deprecation
+
+``src/vnet/udp/udp.api``
+
+* `c5df8c71c `_ host stack: update stale copyright
+
+``src/plugins/cdp/cdp.api``
+
+* `76ef6094c `_ tests: cdp plugin. Replace cdp enable cli command with API call.
+
+``src/plugins/nat/nat.api``
+
+* `8feeaff56 `_ Typos. A bunch of typos I've been collecting.
+* `34931eb47 `_ NAT44: active-passive HA (VPP-1571)
+* `b686508c4 `_ NAT44: nat44_add_del_lb_static_mapping enhancements (VPP-1514)
+
+``src/plugins/map/map.api``
+
+* `4dc5c7b90 `_ MAP: Add optional user-supplied 'tag' field in MAPs.
+* `fc7344f9b `_ MAP: Convert from DPO to input feature.
+* `f34597fc8 `_ MAP: Add API support for MAP input feature.
+* `5a2e278a0 `_ MAP: Add API support for setting parameters.
+* `a173a7a07 `_ MAP: Use bool type in map.api instead of u8.
+* `ffba3c377 `_ MAP: Use explicit address/prefix types in API
+
+``src/plugins/gbp/gbp.api``
+
+* `1aa35576e `_ GBP: Counters per-contract
+* `8ea109e40 `_ gbp: Add bd flags
+* `7bd343509 `_ GBP: custom-dump functions
+* `fa0ac2c56 `_ GBP: contracts API fixed length of allowed ethertypes
+* `5d704aea5 `_ updates now that flags are supported on the API
+* `4ba67723d `_ GBP: use sclass in the DP for policy
+* `8da9fc659 `_ GBP: learn from ARP and L2 packets
+* `32f6d8e0c `_ GBP: per-group EP retention policy
+* `879d11c25 `_ GBP: Sclass to src-epg conversions
+* `1c17e2eca `_ GBP: add allowed ethertypes to contracts
+* `b6a479539 `_ GBP: l3-out subnets
+* `33b81da54 `_ vom: Add support for redirect contracts in gbp
+* `13a08cc09 `_ GBP: redirect contracts
+* `c29c0af40 `_ GBP: Endpoints with VLAN tags and birdges that don't learn
+* `93cc3ee3b `_ GBP Endpoint Learning
+
+``src/plugins/acl/acl.api``
+
+* `bb5d22daf `_ New api in order to get max entries of connection table is added.
+
+``src/plugins/vmxnet3/vmxnet3.api``
+
+* `ee8ba6877 `_ vmxnet3: auto bind support
+* `854559d15 `_ vmxnet3: RSS support
+* `773291163 `_ vmxnet3: multiple TX queues support
+
+``src/plugins/nsim/nsim.api``
+
+* `10c5ff143 `_ nsim: add packet loss simulation, docs
+
+``src/plugins/igmp/igmp.api``
+
+* `97748cae2 `_ IGMP: proxy device
+
+``src/plugins/lb/lb.api``
+
+* `f7f13347b `_ tests: update test_lb.py to use api call lb_conf.
+
+``src/plugins/ct6/ct6.api``
+
+* `a55df1081 `_ ipv6 connection tracking plugin
+
+``src/plugins/ikev2/ikev2.api``
+
+* `7c44d78ef `_ IKEv2 to plugin
diff --git a/docs/aboutvpp/releasenotes/v19.08.1.rst b/docs/aboutvpp/releasenotes/v19.08.1.rst
new file mode 100644
index 00000000000..bd6eec80242
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.08.1.rst
@@ -0,0 +1,75 @@
+Release notes for VPP 19.08.1
+=============================
+
+Exceptionally, this release has an API-changing fix introduced via
+https://gerrit.fd.io/r/#/c/vpp/+/21762/ - documented in VPP-1767. Given
+the exceptional nature of the change, also including the text here:
+
+Bug: https://gerrit.fd.io/r/c/vpp/+/21492
+
+Variable length strings were committed to VPP in 413f4a5b. The VPP
+server side of the API does not use a wire encoder/decoder. It maps a C
+struct directly onto on-the-wire API messages. The client side C
+language binding is the same, while other language bindings have their
+own encoder/decoders.
+
+Multiple strings alone or combined with other variable length types
+turned out to be error prone to manually implement on the VPP side, and
+not supported by VPP API (VAPI) very well at all.
+
+To avoid having to rewrite VAPI significantly, and to mitigate the risk
+and error prone server side support of multiple variable length fields,
+this patch extends strings to have a fixed size (on the wire) and a
+variable flavour, as well as adding detection in the API compiler to
+detect multiple variable length fields in a message (or type).
+
+Given that this change breaks the commitment to binary API
+compatibility, normally present in point builds, ALL 19.08 build
+artifacts are being deferred.
+
+This means the artifacts for the VPP 19.08.1 will be installed in the
+release repository (packagecloud.io/fdio/release), then ALL 19.08 build
+artifacts will be moved into the deferred repository
+(packagecloud.io/fdio/deferred). The 19.08 artifacts will always be
+available for archive purposes in the deferred repository.
+
+During the further testing by Networking-VPP team, they discovered
+another issue documented in VPP-1769 - which requires a CRC-affecting
+fix in https://gerrit.fd.io/r/#/c/vpp/+/22015/ - so the 19.08.1 will
+contain the fixes for both issues.
+
+These two changes have resulted in the following 20 messages changing
+their signatures:
+
+=============================== ==================
+Message Name                    Result
+=============================== ==================
+cli_inband                      definition changed
+cli_inband_reply                definition changed
+connect_sock                    definition changed
+http_static_enable              definition changed
+log_details                     definition changed
+map_add_domain                  definition changed
+map_domain_details              definition changed
+nat44_add_del_identity_mapping  definition changed
+nat44_add_del_lb_static_mapping definition changed
+nat44_add_del_static_mapping    definition changed
+nat44_identity_mapping_details  definition changed
+nat44_lb_static_mapping_details definition changed
+nat44_static_mapping_details    definition changed
+nat_worker_details              definition changed
+punt_reason_details             definition changed
+punt_reason_dump                definition changed
+show_version_reply              definition changed
+sw_interface_details            definition changed
+sw_interface_dump               definition changed
+sw_interface_tag_add_del        definition changed
+=============================== ==================
+
+Please accept our apologies for the inconvenience this caused.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
diff --git a/docs/aboutvpp/releasenotes/v19.08.2.rst b/docs/aboutvpp/releasenotes/v19.08.2.rst
new file mode 100644
index 00000000000..75eb3ff7fde
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.08.2.rst
@@ -0,0 +1,187 @@
+Release notes for VPP 19.08.2
+=============================
+
+The 19.08.2 is an LTS release. It contains numerous fixes, as well as
+new features and API additions.
+
+Features
+--------
+
+-  API trace tool
+
+   -  Add text output (c395ff143)
+
+-  Binary API Libraries
+
+   -  Add API support for PP2 plugin to stable/1908 (1c3c9f039)
+
+-  Build System
+
+   -  Pass ‘no-pci’ to autgenerated config (c0552134e)
+   -  Add env variable to pass extra cmake args (116e05f57)
+
+-  Infrastructure Library
+
+   -  Implement CLIB_PAUSE () for aarch64 platforms (a3c45242b)
+   -  Create unformat function for data size parsing (cb19100c1)
+
+-  Link Bonding
+
+   -  Fix interface deletion (1517d5e72)
+   -  Add GSO support (a06f68556)
+
+-  Physical Memory Allocator
+
+   -  Always lock pages (5b2eea6e0)
+
+-  Plugins
+
+   -  AVF Device driver
+
+      -  Print queue id in packet trace (9e028d047)
+
+   -  DPDK
+
+      -  Ipsec tunnel support for ip6-in-ip4 (2dde5a478)
+      -  QAT devices update, add c4xxx and xeon d15xx (f5d6c80ac)
+      -  Add TSO support in DPDK plugin. (5564db853)
+
+   -  Group Based Policy (GBP)
+
+      -  Add extended SFC unit tests (30f7e4198)
+
+   -  Host Stack Applications
+
+      -  Make APP_OPTIONS_PREALLOC_FIFO_PAIRS configurable (47c6f36be)
+
+   -  Internet Key Exchange (IKEv2) Protocol
+
+      -  Add support for GCM cipher (2fa9f679c)
+
+   -  QUIC protocol
+
+      -  Add cli command for stats (88af6c3f4)
+      -  Add Tx, Rx and packet drop counters (3a61a40dd)
+      -  Create custom event logger (2f9ec5001)
+      -  Make quic fifo size configurable via cli (7fc3d97b8)
+
+   -  RDMA (ibverb) driver
+
+      -  Add support for input feature arcs (cbae1e1c5)
+      -  Add support for MAC changes (ffdfe308b)
+
+   -  Http_static
+
+      -  Add dynamic GET / POST method hooks (faf5195e3)
+
+-  Python binding for the VPP API
+
+   -  Let async calls return context (e6b29a9df)
+   -  Introduce read_blocking (1c45b85df)
+
+-  SVM Library
+
+   -  Improve fifo segment verbose cli (d2bff0786)
+
+-  Statistics Segment
+
+   -  Add /if///state for lacp interface state (d5e8ed7be)
+
+-  Test Infrastructure
+
+   -  Support worker threads (51699e62c)
+   -  Support setting random seed (fc000f0e1)
+   -  Add cli_return_response to vpp_papi_provider (64d744350)
+   -  Test tls case (87e1bcdd7)
+
+-  VNET
+
+   -  Classifier
+
+      -  Use vector code even when data is not aligned (bebbd7f62)
+      -  VPP packet tracer support (7c5a3536c)
+
+   -  IPSec
+
+      -  Add ‘detail’ option to ‘sh ipsec sa’ (56417fa94)
+      -  Add insecure option for format of SA (591aa64e8)
+      -  Support 4o6 and 6o4 for tunnel protect (2e6d73934)
+
+   -  IPv4 and IPv6 LPM
+
+      -  Allow addrs from the same prefix on intf (da900b25c)
+      -  Punt rather than drop unkown IPv6 ICMP packets (fd2f6f89e)
+
+   -  Session Layer
+
+      -  Add explicit reset api (a267cba29)
+      -  Improve cli (2ff21af39)
+      -  Add session enable option in config file (b1ef5567b)
+      -  Limit pacer bucket size (079895d95)
+      -  Builtin app rx notifications regardless of state (8e4afc86d)
+      -  Infra for transports to send buffers (57997c874)
+      -  Reschedule asap when snd space constrained (89ab1762d)
+
+   -  TCP
+
+      -  Allow cc algos to set pacing rate (82df1eb90)
+      -  Set cc_algo on connection alloc (7fe501a4b)
+      -  Add option for always on event logging (e73bd8503)
+      -  Track zero rwnd errors (a2c063712)
+      -  Validate connections in output (ea584d137)
+      -  Force zero window on full rx fifo (fbe948c81)
+      -  Send rwnd update only if wnd is large enough (0ad8477ba)
+      -  Enable gso in tcp hoststack (6f3621d77)
+      -  Handle SACK reneging (9dba3dbf0)
+      -  Use rate sample RTT in recovery if possible (6702641f5)
+      -  Compute snd time for rate sample (69460ae11)
+      -  Use sacks for timer based recovery (d4aa3d9f8)
+      -  Custom checksum calculations for Ipv4/Ipv6 (3642782a2)
+      -  Retry lost retransmits (7b135c639)
+      -  Improve pacing after idle send periods (abdc7dfb5)
+      -  Track lost rxt segments in byte tracker (6de46b40d)
+      -  Validate the IP address while checking TCP connection
+         (6c1ce53b4)
+      -  Improve lost rxt heuristic (04b4204d9)
+
+-  VPP Comms Library
+
+   -  Allow non-blocking connects (4767cf24f)
+   -  Add api to set lcl ip (2c55610e2)
+
+-  Vector Library
+
+   -  Add flag to explicitelly mark nodes which can init per-node packet
+      trace (29dc11bde)
+   -  Enhance the “show cli” debug CLI command (b5a0108ac)
+
+-  Libmemif
+
+   -  Introduce ‘memif_per_thread\_’ namespace (2736fc7fc)
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+================ =============
+Message Name     Result
+================ =============
+app_attach       only in image
+app_attach_reply only in image
+================ =============
+
+Found 2 api message signature differences
+
+Fixed issues
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.08.3.rst b/docs/aboutvpp/releasenotes/v19.08.3.rst
new file mode 100644
index 00000000000..fe7ccc3c9c2
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.08.3.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 19.08.3
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v19.08.rst b/docs/aboutvpp/releasenotes/v19.08.rst
new file mode 100644
index 00000000000..efbba1ce603
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v19.08.rst
@@ -0,0 +1,752 @@
+Release notes for VPP 19.08
+===========================
+
+More than 850 commits since the 19.04 release.
+
+Features
+--------
+
+Infrastructure
+~~~~~~~~~~~~~~
+
+-  API
+
+   -  API language: new types and limits support
+   -  Python API - add support for defaults
+   -  Export ip_types.api for out-of-tree plugins use
+   -  Refactor ipip.api with explicit types
+
+-  DPDK
+
+   -  19.05 integration
+   -  Remove bonding code
+   -  Rework extended stats
+
+-  Debugging & Servicability
+
+   -  debug CLI leak-checker
+   -  vlib: add “memory-trace stats-segment”
+   -  vppapitrace JSON/API trace converter
+   -  ARP: add arp-disabled node
+   -  igmp: Trace more data from input packets
+   -  ip: Trace the packet from the punt node
+   -  Python API debug introspection improvements
+   -  Pin dependencies for make test infra
+   -  FEATURE.yaml meta-data infrastructure
+   -  tcp: add cc stats plotting tools
+   -  Packet tracer support for thread handoffs
+
+-  libmemif: support for multi-thread connection establishment
+-  svm
+
+   -  fifo ooo reads/writes with multiple chunks
+   -  support addition/removal of chunks to fifos
+
+-  vppinfra
+
+   -  Mapped pcap file support
+   -  More AVX2 and AVX512 inlines
+   -  VLIB_INIT_FUNCTION sequencing rework
+   -  refactor spinlocks and rwlocks
+   -  add rbtree
+   -  add doubly linked list
+
+-  rdma: bump rdma-core to v25.0
+-  stats
+
+   -  Add the number of worker threads and per worker thread vector
+      rates
+   -  Support multiple workers for error counters
+
+VNET & Plugins
+~~~~~~~~~~~~~~
+
+-  New Plugins
+
+   -  HTTP static page server with TLS support
+   -  L3 cross connect
+
+-  acl: implement stat-segment counters
+-  arp: add feature arcs: arp-reply, arp-input, arp-proxy
+-  avf: improved logging and added 2.5/5 Gbps speeds
+-  bonding: NUMA-related improvements
+-  crypto: add support for AES-CTR cipher
+-  fib
+
+   -  FIB Entry tracking
+   -  Support the POP of a Pseudo Wire Control Word
+
+-  gbp
+
+   -  Anonymous l3-out subnets support
+   -  ARP unicast forward in gbp bridge domain
+   -  An Endpoint can change sclass
+   -  Consider data-plane learnt source better than control-plane
+   -  VRF scoped contracts
+
+-  gso (experimental)
+
+   -  Add support to pg interfaces
+   -  Add support to vhost user
+   -  Add support to native virtio
+   -  Add support for tagged interfaces
+
+-  punt: allow to specify packets by IP protocol Type
+-  ip6-local: hop-by-hop protocol demux table
+-  ipsec
+
+   -  intel-ipsec-mb version 0.52
+   -  AH encrypt rework
+   -  handle UDP keepalives
+   -  support GCM in ESP
+
+-  virtio
+
+   -  Refactor control queue support
+
+-  dhcp-client: DSCP marking for transmitted packets
+-  Idle resource usage improvements
+
+   -  Allocate bihash virtual space on demand
+   -  gre: don’t register gre input nodes unless a gre tunnel is created
+   -  gtpu: don’t register udp ports unless a tunnel is created
+   -  lacp: create lacp-process on demand
+   -  lisp-cp: start lisp retry service on demand
+   -  start the cdp period and dns resolver process on demand
+   -  vat: unload unused vat plugins
+
+-  nat: api cleanup & update
+-  nsim: make available as an output feature
+-  load-balance performance improvements
+-  l2: Add support for arp unicast forwarding
+-  mactime
+
+   -  Mini-ACLs
+   -  Per-MAC allow-with-quota feature
+
+-  qos
+
+   -  QoS dump APIs
+   -  Store function
+
+-  rdma: add support for promiscuous mode (l2-switching and xconnect)
+-  sr: update the Segment Routing definition to be compliant with
+   current in IETF
+-  udp-ping: disable due to conflict with mldv2
+-  vxlan-gpe: improve encap performance
+-  vom
+
+   -  QoS support
+   -  Bridge domain arp unicast forwarding flag
+   -  Bridge domain unknown unicast flooding flag
+
+Host stack
+~~~~~~~~~~
+
+-  session
+
+   -  API to support manual svm fifo resizing
+   -  Improved session output scheduler and close state machine
+   -  Transport and session cleanup notifications for builtin apps
+   -  Session migration notifications for builtin apps
+   -  Support for no session layer lookup transports (quic and tls)
+   -  Ability to retrieve local/remote endpoint in transport vft
+   -  Cleanup segment manager and fifo segment
+   -  Fix vpp to app msg generation on enqueue fail
+   -  Improve event logging
+   -  Moved test applications to hsa plugin
+
+-  tcp
+
+   -  Congestion control algorithm enhancements
+   -  Delivery rate estimator
+   -  ACK/retransmission refactor and pacing
+   -  Add tcp-input sibling nodes without full 6-tuple lookup
+   -  More RFC4898 connection statistics
+   -  Allow custom output next node
+   -  Allow custom congestion control algorithms
+
+-  quic
+
+   -  Multi-thread support
+   -  Logs readability improvements
+   -  Multistream support
+
+-  tls
+
+   -  Fix close with data and listen failures
+   -  Handle TCP transport rests
+   -  Support endpoint retrieval interface
+
+-  vcl
+
+   -  support quic streams and “connectable listeners”
+   -  worker unregister api
+   -  fix epoll with large events batch
+   -  ldp: add option to eanble transparent TLS connections
+
+-  udp:
+
+   -  support close with data
+   -  fixed session migration
+
+-  sctp
+
+   -  add option to enable/disable default to disable
+   -  moved from vnet to plugins
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+============================================= ==================
+Message Name                                  Result
+============================================= ==================
+abf_itf_attach_add_del                        definition changed
+abf_itf_attach_details                        definition changed
+abf_policy_add_del                            definition changed
+abf_policy_details                            definition changed
+acl_add_replace                               definition changed
+acl_details                                   definition changed
+acl_stats_intf_counters_enable                only in image
+acl_stats_intf_counters_enable_reply          only in image
+api_versions_reply                            definition changed
+bd_ip_mac_add_del                             definition changed
+bd_ip_mac_details                             definition changed
+bier_disp_entry_add_del                       definition changed
+bier_disp_entry_details                       definition changed
+bier_imp_add                                  definition changed
+bier_imp_details                              definition changed
+bier_route_add_del                            definition changed
+bier_route_details                            definition changed
+bier_route_dump                               definition changed
+bier_table_add_del                            definition changed
+bier_table_details                            definition changed
+bond_create                                   definition changed
+bridge_domain_add_del                         definition changed
+bridge_domain_details                         definition changed
+bridge_flags                                  definition changed
+connect_sock                                  definition changed
+create_vhost_user_if                          definition changed
+ct6_enable                                    only in file
+ct6_enable_disable                            only in image
+ct6_enable_disable_reply                      only in image
+ct6_enable_disable                            only in file
+dhcp6_pd_reply_event                          definition changed
+dhcp6_pd_send_client_message                  definition changed
+dhcp6_reply_event                             definition changed
+dhcp6_send_client_message                     definition changed
+dhcp_client_config                            definition changed
+dhcp_client_details                           definition changed
+dhcp_compl_event                              definition changed
+dhcp_proxy_details                            definition changed
+dslite_add_del_pool_addr_range                definition changed
+dslite_address_details                        definition changed
+dslite_get_aftr_addr_reply                    definition changed
+dslite_get_b4_addr_reply                      definition changed
+dslite_set_aftr_addr                          definition changed
+dslite_set_b4_addr                            definition changed
+gbp_bridge_domain_add                         definition changed
+gbp_bridge_domain_details                     definition changed
+gbp_contract_add_del                          definition changed
+gbp_contract_details                          definition changed
+gbp_endpoint_add                              definition changed
+gbp_endpoint_details                          definition changed
+gbp_endpoint_group_add                        definition changed
+gbp_endpoint_group_details                    definition changed
+gbp_ext_itf_add_del                           definition changed
+gbp_ext_itf_details                           definition changed
+gbp_recirc_add_del                            definition changed
+gbp_recirc_details                            definition changed
+gbp_route_domain_add                          definition changed
+gbp_route_domain_details                      definition changed
+gbp_subnet_add_del                            definition changed
+gbp_subnet_details                            definition changed
+gbp_vxlan_tunnel_add                          definition changed
+gbp_vxlan_tunnel_details                      definition changed
+get_f64_endian_value                          only in image
+get_f64_endian_value_reply                    only in image
+get_f64_increment_by_one                      only in image
+get_f64_increment_by_one_reply                only in image
+gpe_add_del_fwd_entry                         definition changed
+gpe_fwd_entries_get_reply                     definition changed
+gpe_fwd_entry_path_details                    definition changed
+gpe_native_fwd_rpaths_get_reply               definition changed
+gre_add_del_tunnel                            only in file
+gre_add_del_tunnel_reply                      only in file
+gre_tunnel_add_del                            only in image
+gre_tunnel_add_del_reply                      only in image
+gre_tunnel_details                            definition changed
+gre_tunnel_dump                               definition changed
+http_static_enable                            only in image
+http_static_enable_reply                      only in image
+igmp_event                                    definition changed
+igmp_group_prefix_details                     definition changed
+igmp_group_prefix_set                         definition changed
+igmp_listen                                   definition changed
+ip6_fib_details                               only in file
+ip6_fib_dump                                  only in file
+ip6_mfib_details                              only in file
+ip6_mfib_dump                                 only in file
+ip6_ra_event                                  definition changed
+ip_add_del_route                              only in file
+ip_add_del_route_reply                        only in file
+ip_address_details                            definition changed
+ip_container_proxy_add_del                    definition changed
+ip_container_proxy_details                    definition changed
+ip_fib_details                                only in file
+ip_fib_dump                                   only in file
+ip_mfib_details                               only in file
+ip_mfib_dump                                  only in file
+ip_mroute_add_del                             definition changed
+ip_mroute_details                             only in image
+ip_mroute_dump                                only in image
+ip_mtable_details                             only in image
+ip_mtable_dump                                only in image
+ip_neighbor_add_del                           definition changed
+ip_neighbor_details                           definition changed
+ip_probe_neighbor                             definition changed
+ip_punt_redirect                              definition changed
+ip_punt_redirect_details                      definition changed
+ip_reassembly_get_reply                       definition changed
+ip_reassembly_set                             definition changed
+ip_route_add_del                              only in image
+ip_route_add_del_reply                        only in image
+ip_route_details                              only in image
+ip_route_dump                                 only in image
+ip_source_and_port_range_check_add_del        definition changed
+ip_table_add_del                              definition changed
+ip_table_details                              only in image
+ip_table_dump                                 only in image
+ipfix_flush                                   only in image
+ipfix_flush_reply                             only in image
+ipip_6rd_add_tunnel                           definition changed
+ipip_add_tunnel                               definition changed
+ipip_tunnel_details                           definition changed
+ipsec_backend_details                         definition changed
+ipsec_gre_tunnel_add_del                      only in file
+ipsec_gre_tunnel_add_del_reply                only in file
+ipsec_gre_tunnel_details                      only in file
+ipsec_gre_tunnel_dump                         only in file
+ipsec_sa_details                              definition changed
+ipsec_sa_set_key                              only in file
+ipsec_sa_set_key_reply                        only in file
+ipsec_sad_entry_add_del                       definition changed
+ipsec_select_backend                          definition changed
+ipsec_spd_details                             definition changed
+ipsec_spd_entry_add_del                       definition changed
+ipsec_tunnel_if_add_del                       definition changed
+ipsec_tunnel_if_set_key                       only in file
+ipsec_tunnel_if_set_key_reply                 only in file
+ipsec_tunnel_protect_del                      only in image
+ipsec_tunnel_protect_del_reply                only in image
+ipsec_tunnel_protect_details                  only in image
+ipsec_tunnel_protect_dump                     only in image
+ipsec_tunnel_protect_update                   only in image
+ipsec_tunnel_protect_update_reply             only in image
+l2_macs_event                                 definition changed
+l3xc_del                                      only in image
+l3xc_del_reply                                only in image
+l3xc_details                                  only in image
+l3xc_dump                                     only in image
+l3xc_plugin_get_version                       only in image
+l3xc_plugin_get_version_reply                 only in image
+l3xc_update                                   only in image
+l3xc_update_reply                             only in image
+lb_add_del_as                                 definition changed
+lb_add_del_vip                                definition changed
+lb_as_details                                 only in image
+lb_as_dump                                    only in image
+lb_flush_vip                                  definition changed
+lb_vip_details                                only in image
+lb_vip_dump                                   only in image
+lisp_add_del_locator_set                      definition changed
+lisp_add_del_remote_mapping                   definition changed
+lisp_adjacencies_get_reply                    definition changed
+log_details                                   only in image
+log_dump                                      only in image
+macip_acl_add                                 definition changed
+macip_acl_add_replace                         definition changed
+macip_acl_details                             definition changed
+mactime_add_del_range                         definition changed
+map_add_domain                                definition changed
+map_domain_details                            definition changed
+mfib_signal_details                           definition changed
+modify_vhost_user_if                          definition changed
+mpls_fib_details                              only in file
+mpls_fib_dump                                 only in file
+mpls_ip_bind_unbind                           definition changed
+mpls_route_add_del                            definition changed
+mpls_route_details                            only in image
+mpls_route_dump                               only in image
+mpls_table_add_del                            definition changed
+mpls_table_details                            only in image
+mpls_table_dump                               only in image
+mpls_tunnel_add_del                           definition changed
+mpls_tunnel_details                           definition changed
+nat44_add_del_address_range                   definition changed
+nat44_add_del_identity_mapping                definition changed
+nat44_add_del_interface_addr                  definition changed
+nat44_add_del_lb_static_mapping               definition changed
+nat44_add_del_static_mapping                  definition changed
+nat44_address_details                         definition changed
+nat44_del_session                             definition changed
+nat44_forwarding_enable_disable               definition changed
+nat44_forwarding_is_enabled_reply             definition changed
+nat44_identity_mapping_details                definition changed
+nat44_interface_add_del_feature               definition changed
+nat44_interface_add_del_output_feature        definition changed
+nat44_interface_addr_details                  definition changed
+nat44_interface_details                       definition changed
+nat44_interface_output_feature_details        definition changed
+nat44_lb_static_mapping_add_del_local         definition changed
+nat44_lb_static_mapping_details               definition changed
+nat44_static_mapping_details                  definition changed
+nat44_user_details                            definition changed
+nat44_user_session_details                    definition changed
+nat44_user_session_dump                       definition changed
+nat64_add_del_interface_addr                  definition changed
+nat64_add_del_interface                       definition changed
+nat64_add_del_pool_addr_range                 definition changed
+nat64_add_del_prefix                          definition changed
+nat64_add_del_static_bib                      definition changed
+nat64_bib_details                             definition changed
+nat64_interface_details                       definition changed
+nat64_pool_addr_details                       definition changed
+nat64_prefix_details                          definition changed
+nat64_st_details                              definition changed
+nat66_add_del_interface                       definition changed
+nat66_add_del_static_mapping                  definition changed
+nat66_interface_details                       definition changed
+nat66_static_mapping_details                  definition changed
+nat_det_add_del_map                           definition changed
+nat_det_close_session_in                      definition changed
+nat_det_close_session_out                     definition changed
+nat_det_forward                               definition changed
+nat_det_forward_reply                         definition changed
+nat_det_map_details                           definition changed
+nat_det_reverse                               definition changed
+nat_det_reverse_reply                         definition changed
+nat_det_session_details                       definition changed
+nat_det_session_dump                          definition changed
+nat_get_mss_clamping_reply                    definition changed
+nat_ipfix_enable_disable                      definition changed
+nat_reass_details                             definition changed
+nat_set_log_level                             only in image
+nat_set_log_level_reply                       only in image
+nat_set_mss_clamping                          definition changed
+nat_set_reass                                 definition changed
+nat_show_config_reply                         definition changed
+nat_worker_details                            definition changed
+nsim_cross_connect_enable_disable             only in image
+nsim_cross_connect_enable_disable_reply       only in image
+nsim_enable_disable                           only in file
+nsim_enable_disable_reply                     only in file
+nsim_output_feature_enable_disable            only in image
+nsim_output_feature_enable_disable_reply      only in image
+oam_add_del                                   only in file
+oam_add_del_reply                             only in file
+oam_event                                     only in file
+one_add_del_locator_set                       definition changed
+one_add_del_remote_mapping                    definition changed
+one_adjacencies_get_reply                     definition changed
+one_l2_arp_entries_get_reply                  definition changed
+one_ndp_entries_get_reply                     definition changed
+p2p_ethernet_add                              definition changed
+p2p_ethernet_add_reply                        definition changed
+p2p_ethernet_del                              definition changed
+pg_create_interface                           definition changed
+proxy_arp_add_del                             definition changed
+proxy_arp_details                             definition changed
+punt_details                                  only in file
+punt_dump                                     only in file
+punt_reason_details                           only in image
+punt_reason_dump                              only in image
+punt_socket_deregister                        definition changed
+punt_socket_details                           definition changed
+punt_socket_dump                              definition changed
+punt_socket_register                          definition changed
+qos_egress_map_delete                         definition changed
+qos_egress_map_details                        only in image
+qos_egress_map_dump                           only in image
+qos_egress_map_update                         definition changed
+qos_mark_details                              only in image
+qos_mark_details_reply                        only in image
+qos_mark_dump                                 only in image
+qos_mark_enable_disable                       definition changed
+qos_record_details                            only in image
+qos_record_dump                               only in image
+qos_record_enable_disable                     definition changed
+qos_store_details                             only in image
+qos_store_dump                                only in image
+qos_store_enable_disable                      only in image
+qos_store_enable_disable_reply                only in image
+sctp_add_src_dst_connection                   only in file
+sctp_add_src_dst_connection_reply             only in file
+sctp_config                                   only in file
+sctp_config_reply                             only in file
+sctp_del_src_dst_connection                   only in file
+sctp_del_src_dst_connection_reply             only in file
+set_punt                                      definition changed
+show_threads_reply                            definition changed
+show_vpe_system_time                          only in image
+show_vpe_system_time_reply                    only in image
+sockclnt_create_reply                         definition changed
+sr_localsid_add_del                           definition changed
+sr_localsids_details                          definition changed
+sr_policies_details                           definition changed
+sr_policy_add                                 definition changed
+sr_policy_del                                 definition changed
+sr_policy_mod                                 definition changed
+sr_steering_pol_details                       definition changed
+svs_details                                   definition changed
+svs_enable_disable                            definition changed
+svs_route_add_del                             definition changed
+svs_table_add_del                             definition changed
+sw_interface_bond_details                     definition changed
+sw_interface_dump                             definition changed
+sw_interface_ip6_set_link_local_address       only in image
+sw_interface_ip6_set_link_local_address_reply only in image
+sw_interface_ip6nd_ra_prefix                  definition changed
+sw_interface_set_l2_bridge                    definition changed
+sw_interface_tap_v2_details                   definition changed
+syslog_get_filter_reply                       definition changed
+syslog_set_filter                             definition changed
+tap_create_v2                                 definition changed
+udp_encap_add                                 definition changed
+udp_encap_details                             definition changed
+virtio_pci_create                             definition changed
+vmxnet3_details                               definition changed
+vxlan_gbp_tunnel_add_del                      definition changed
+vxlan_gbp_tunnel_details                      definition changed
+want_oam_events                               only in file
+want_oam_events_reply                         only in file
+============================================= ==================
+
+Found 319 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``src/vpp/api/vpe_types.api``
+
+* `a47a5f20a `_ api papi: add alias for timestamp(datetime)/timedelta
+* `3cf9e67f5 `_ api: add vl_api_version_t type
+
+``src/vpp/api/vpe.api``
+
+* `a47a5f20a `_ api papi: add alias for timestamp(datetime)/timedelta
+* `888640a39 `_ map gbp papi: match endianess of f64
+* `03f1af23b `_ api: Implement log_dump/log_details
+* `c87b66c86 `_ ipsec: ipsec-tun protect
+* `9ac113815 `_ API: Add support for limits to language.
+
+``src/examples/sample-plugin/sample/sample.api``
+
+* `78d91cf9a `_ sample-plugin: refactor .api to use explicit types
+
+``src/vnet/interface.api``
+
+* `0ad4a439d `_ Fix vpp crash bug while deleting dhcp client
+* `9a29f795a `_ vpp_papi_provider.py: update defautmapping.
+* `b8591ac91 `_ API sw_interface_dump: Dump all if index is zero
+* `4a7240636 `_ Make sw_interface_dump more compatible with 2.2.0
+* `6407ba56a `_ api: Add to interface crud - read by sw_if_index.
+
+``src/vnet/qos/qos.api``
+
+* `83832e7ce `_ qos: Store function
+* `5281a9029 `_ qos: QoS dump APIs
+
+``src/vnet/bier/bier.api``
+
+* `097fa66b9 `_ fib: fib api updates
+* `e6eefb6e3 `_ Trivial Typo's in bier comments/docs.
+
+``src/vnet/ipfix-export/ipfix_export.api``
+
+* `21b83e96d `_ api: implement ipfix_flush
+
+``src/vnet/session/session.api``
+
+* `8ac1d6d05 `_ session: Use parent_handle instead of transport_opts
+* `ba65ca496 `_ Add transport_opts to connect_sock bapi
+
+``src/vnet/gre/gre.api``
+
+* `814f15948 `_ gre: update gre.api with explicit types
+* `d0aed2eb3 `_ GRE: set gre_tunnel_type init value to zero in API
+* `5a8844bdb `_ GRE: API update
+
+``src/vnet/pg/pg.api``
+
+* `22e9cfd76 `_ pg: add GSO support
+
+``src/vnet/l2/l2.api``
+
+* `bc764c8bc `_ l2: BD ARP termination entry API update
+* `54bc5e40c `_ Update API description
+* `5e6f7348c `_ l2: Add support for arp unicast forwarding
+
+``src/vnet/udp/udp.api``
+
+* `10dc2eabd `_ udp: fix copyright typo
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `97d54ed43 `_ tap: add support to configure tap interface host MTU size
+
+``src/vnet/devices/virtio/vhost_user.api``
+
+* `4208a4ce8 `_ devices interface tests: vhosst GSO support
+
+``src/vnet/devices/virtio/virtio.api``
+
+* `bbd6b746e `_ virtio: Add gso support for native virtio driver
+* `43b512cac `_ virtio: remove configurable queue size support
+
+``src/vnet/mfib/mfib_types.api``
+
+* `097fa66b9 `_ fib: fib api updates
+
+``src/vnet/ipsec/ipsec.api``
+
+* `c87b66c86 `_ ipsec: ipsec-tun protect
+* `f2922422d `_ ipsec: remove the set_key API
+* `80f6fd53f `_ IPSEC: Pass the algorithm salt (used in GCM) over the API
+
+``src/vnet/ethernet/p2p_ethernet.api``
+
+* `8edca1361 `_ p2p ethernet: update p2p_ethernet.api with explicit types.
+
+``src/vnet/bonding/bond.api``
+
+* `751e3f382 `_ bonding: add support for numa-only in lacp mode
+
+``src/vnet/mpls/mpls.api``
+
+* `097fa66b9 `_ fib: fib api updates
+
+``src/vnet/ipip/ipip.api``
+
+* `288e09362 `_ ipip: refactor ipip.api with explicit types
+* `cbd0824d6 `_ IPIP tunnel: use address types on API
+
+``src/vnet/fib/fib_types.api``
+
+* `1dbcf30b7 `_ fib: Support the POP of a Psuedo Wire Control Word
+* `097fa66b9 `_ fib: fib api updates
+
+``src/vnet/dhcp/dhcp.api``
+
+* `038e1dfbd `_ dhcp ip: DSCP settings for transmitted DHCP packets
+* `56bc738dc `_ Fix VPP-1487 DHCP client does not support option 6-domain server
+
+``src/vnet/ip/punt.api``
+
+* `719beb709 `_ ip ipsec: Remove IPSec SPI-0 punt reason
+* `b538dd868 `_ Punt: specify packets by IP protocol Type
+* `50f0ac0f0 `_ Punt: socket register for exception dispatched/punted packets based on reason
+
+``src/vnet/ip/ip.api``
+
+* `097fa66b9 `_ fib: fib api updates
+* `3a343d42d `_ reassembly: prevent long chain attack
+
+``src/vnet/ip/ip_types.api``
+
+* `515eed425 `_ api: add prefix matcher typedef
+* `038e1dfbd `_ dhcp ip: DSCP settings for transmitted DHCP packets
+* `53c501512 `_ api: add DSCP definitions to ip_types.api
+* `ab05508e1 `_ api: refactor format_vl_api_prefix_t return keys
+* `b538dd868 `_ Punt: specify packets by IP protocol Type
+* `50f0ac0f0 `_ Punt: socket register for exception dispatched/punted packets based on reason
+
+``src/plugins/l3xc/l3xc.api``
+
+* `59fa121f8 `_ L3 cross connect
+
+``src/plugins/map/map.api``
+
+* `4d376f67a `_ map: Use vl_api_string macros.
+
+``src/plugins/http_static/http_static.api``
+
+* `68b24e2c9 `_ plugins: http_static. Migrate to use api string type.
+* `22bc2c46e `_ Static http server
+
+``src/plugins/igmp/igmp.api``
+
+* `4ff09ae34 `_ API: Python and Unix domain socket improvement
+
+``src/plugins/sctp/sctp.api``
+
+* `3ffe6cadf `_ sctp: move to plugins, disabled by default
+
+``src/plugins/lb/lb.api``
+
+* `3efcd0d7c `_ lb: vip and as dump/detail api's
+* `a0cb32cb9 `_ lb: update api.c to use scaffolding from latest skel
+
+``src/plugins/lb/lb_types.api``
+
+* `3efcd0d7c `_ lb: vip and as dump/detail api's
+
+``src/plugins/mactime/mactime.api``
+
+* `7681b1c46 `_ mactime: add per-mac allow-with-quota feature
+* `0c6ac791d `_ mactime: upstream new features
+
+``src/plugins/gbp/gbp.api``
+
+* `3918bdbcb `_ gbp: update gbp-ext-itf API
+* `3c0d84c98 `_ gbp: add anonymous l3-out subnets
+* `cfc7a107e `_ gbp: add anonymous l3-out external interfaces
+* `160c923f9 `_ gbp: VRF scoped contracts
+
+``src/plugins/acl/acl_types.api``
+
+* `bb2e5221a `_ api acl: breakout acl_types.api for reuse by others
+
+``src/plugins/acl/acl.api``
+
+* `bb2e5221a `_ api acl: breakout acl_types.api for reuse by others
+* `f995c7122 `_ acl: implement counters
+
+``src/plugins/nat/nat.api``
+
+* `e6e09a4ac `_ nat: elog rewrite for multi-worker support
+* `c1f93067e `_ Add default value for API Nat flags
+* `dd1e3e780 `_ NAT: VPP-1531 api cleanup & update
+* `89fec713f `_ Revert "NAT: VPP-1531 api cleanup & update"
+* `bed1421b9 `_ NAT: VPP-1531 api cleanup & update
+
+``src/plugins/abf/abf.api``
+
+* `097fa66b9 `_ fib: fib api updates
+
+``src/plugins/nsim/nsim.api``
+
+* `7c91007e1 `_ Make the loss / delay sim available as an output feature
+
diff --git a/docs/aboutvpp/releasenotes/v20.01.rst b/docs/aboutvpp/releasenotes/v20.01.rst
new file mode 100644
index 00000000000..a2fbebcb235
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v20.01.rst
@@ -0,0 +1,1384 @@
+Release notes for VPP 20.01
+===========================
+
+More than 1039 commits since the 19.08 release.
+
+Features
+--------
+
+-  API trace tool
+
+   -  Add text output (a2ac36c91)
+
+-  Binary API Compiler for Python
+
+   -  Raise ValueError when fieldname is python keyword (ff47fb645)
+
+-  Binary API Libraries
+
+   -  Add API support for marvell PP2 plugin (859b59133)
+   -  Add bapi thread handle to api main structure. (8229580e8)
+   -  Multiple connections per process (39d69112f)
+   -  Multiple socket connections per single process (59cea1a9d)
+
+-  Build System
+
+   -  Add build types helpstring to cmake project (952a7b8b7)
+   -  Add env variable to pass extra cmake args (297365403)
+   -  Add yaml file linting to make checkstyle (6b0dd5502)
+   -  Export vapi generation in vpp-dev (dc20371f8)
+   -  Fix 3rd party CI systems. (86a9441c2)
+   -  Pass ‘no-pci’ to autgenerated config (be7ef3b5c)
+
+-  Crypto ipsecmb Plugin
+
+   -  Bump to intel-ipsec-mb version 0.53 (d35fefe8b)
+   -  Improve gcm performance using dedicated API. (76a36e83e)
+
+-  Infrastructure Library
+
+   -  Bihash walk cb typedef and continue/stop controls (f50bac1bb)
+   -  Create unformat function for data size parsing (579b16506)
+   -  Implement CLIB_PAUSE () for aarch64 platforms (18512b002)
+
+-  libmemif
+
+   -  Introduce ‘memif_per_thread\_’ namespace (17f2a7bbf)
+
+-  Link Bonding
+
+   -  Add/del secondary mac address callback (e83aa456b)
+   -  Add /if/lacp/bond-sw-if-index/slave-sw-if-index/partner-state
+      (aa7257863)
+   -  Add weight support for active-backup mode (a1876b84e)
+   -  Fix interface deletion (cc3aac056)
+
+-  Miscellaneous
+
+   -  Add address sanitizer heap instrumentation (9fb6d40eb)
+   -  Add CentOS 8 package support (c025329bb)
+   -  Add gdb helpers for vlib buffers (2b65f9ca0)
+   -  Add lcov scripts, README.md (8d74caa0a)
+   -  Add “maxframe” and “rate” to packet-generator cli. (87d7bac5c)
+   -  Add “show run summary” (ac78f8a90)
+   -  Add vnet classify filter set support (f5667c305)
+   -  Classifier-based packet trace filter (9137e5400)
+   -  Improve pcap drop trace output (9382ad9b3)
+   -  Update gitignore for /test/ext/.d (8161d73d7)
+
+-  Physical Memory Allocator
+
+   -  Always lock pages (801c7016a)
+
+-  Plugins
+
+   -  AVF Device driver
+   -  Improve timeout handling (1a7bb281f)
+   -  Print queue id in packet trace (c33eddebe)
+   -  Buffer Metadata Modification Tracker
+   -  Buffer metadata change tracker plugin (d7b306657)
+   -  builtinurl
+   -  New plugin (43765e2b4)
+   -  DHCP
+   -  Ipv6 prefix delegation improvements (d318a996b)
+   -  Move to plugin (02bfd641b)
+   -  DPDK
+   -  Add devargs support (f2bde7ac5)
+   -  Add function to add/del extra MAC addrs (153727743)
+   -  Add TSO support in dpdk plugin. (de5ed58fd)
+   -  Apply dual loop unrolling in DPDK TX (fe2523d1a)
+   -  Bump DPDK version to 19.08 (b6103105f)
+   -  Enable bnxt PMD (c3731ac89)
+   -  Ipsec tunnel support for ip6-in-ip4 (5025d40a1)
+   -  QAT devices update, add c4xxx and xeon d15xx (4d843b994)
+   -  Group Based Policy (GBP)
+   -  Add extended SFC unit tests (a3c8ca10e)
+   -  Host Stack Applications
+   -  Add ckpair & crypto engine in vpp_echo (7c40a3837)
+   -  Add option for multiple ips (f98e59b86)
+   -  Add periodic timing (ff6cdcca2)
+   -  Improve for mq-intensive (b2fce36c8)
+   -  Less verbose logging for many sessions (08f26641f)
+   -  Make APP_OPTIONS_PREALLOC_FIFO_PAIRS configurable (7028a0157)
+   -  http_static
+   -  Add dynamic GET / POST method hooks (5554c56a6)
+   -  Add “http static cache clear” CLI (e0fd9ed11)
+   -  Add .json content (71a5da0c8)
+   -  Internet Key Exchange (IKEv2) Protocol
+   -  Add support for GCM cipher (de2dd6c35)
+   -  IPv6 Segment Routing Mobile
+   -  (57584d99d)
+   -  Load Balancer
+   -  Add APIs for set interface nat4 and nat6 (33538a150)
+   -  NAT
+   -  Handoff traffic matching for dynamic NAT (22bb417e9)
+   -  Ping
+   -  Move the echo responder into the ping plugin (f6c8f5090)
+   -  QUIC protocol
+   -  Add aggregated quicly stats (deaf97f45)
+   -  Add cli command for stats (922f0b211)
+   -  Add conn-timeout config option (2f566c23f)
+   -  Add more detailed statistics (1802fcc5f)
+   -  Add support for ckpair & crypto engine (dcbbf2833)
+   -  Add support for unidirectional streams (c00f480ba)
+   -  Add Tx, Rx and packet drop counters (ff1f6faaa)
+   -  Create custom event logger (dd4d8ac29)
+   -  Implement crypto contexts (d1b9e7068)
+   -  Make quic fifo size configurable via cli (00078b991)
+   -  Update quicly to v0.0.5 (72c159e64)
+   -  Update quicly to v0.0.6-vpp (3afac8f81)
+   -  Update quicly to v0.0.7-vpp (69885b72a)
+   -  Update quicly to v0.0.8-vpp (ecb9d18c5)
+   -  Update quicly to v0.0.9-vpp (84def7cb7)
+   -  RDMA (ibverb) driver
+   -  Add rdma API (812afe712)
+   -  Add support for input feature arcs (74eba446b)
+   -  Add support for MAC changes (0dcafcc50)
+   -  API: prepare support for direct verb (d8c1ef925)
+   -  Time-based MAC filter
+   -  Add a “top” command to watch device stats (2c41a61d5)
+   -  Add the “mactime.json” builtin URL (ef3c11ca9)
+   -  vmxnet3 device driver
+   -  Per interface gso support (2985e0af6)
+
+-  Python binding for the VPP API
+
+   -  Add a per-call \_timeout option (e2ccdf031)
+   -  Add call stats (fd574087e)
+   -  Add repr to packer types for troubleshooting (14b0b4791)
+   -  Add wrapper to validate crc manifest (c046d709e)
+   -  Enhance MACAddress() equality (6af62565e)
+   -  Introduce read_blocking (0938547ea)
+   -  Let async calls return context (2f6e0c600)
+   -  Support default for type alias decaying to basetype (418ebb711)
+
+-  Sphinx Documents
+
+   -  Add spellcheck to ‘make docs’ sphinx docs (340c15c6e)
+
+-  Statistics Segment
+
+   -  Add /if///state for lacp interface state (0f09a828a)
+
+-  SVM Library
+
+   -  Improve fifo segment verbose cli (f8461bfb4)
+
+-  Test Infrastructure
+
+   -  Add cli_return_response to vpp_papi_provider (5932ce17e)
+   -  Add test run time. (0c6293230)
+   -  Support setting random seed (45a95dd78)
+   -  Support worker threads (4ecbf105a)
+   -  Test tls case (419d31f81)
+
+-  Vector Library
+
+   -  Add flag to explicitelly mark nodes which can init per-node packet
+      trace (7ca5aaac1)
+   -  Add max-size configuration parameter for pmalloc (842506f3c)
+   -  Add ‘wait’ cli command (bfd7d294d)
+   -  Enhance the “show cli” debug CLI command (a1f5a956e)
+
+-  VNET
+
+   -  Classify
+
+      -  Per-interface rx/tx pcap capture filters (d28437cdf)
+      -  Use vector code even when data is not aligned (830493392)
+      -  Vpp packet tracer support (87d24db65)
+
+   -  Ethernet
+
+      -  All dmac checks include secondary addrs (42bde459b)
+      -  Dmac filter checks secondary mac addrs (d459bf344)
+
+   -  FIB
+
+      -  Adjacency creation notifications for dlegates (77cfc0171)
+      -  Decouple source from priority and behaviour (3bab8f9c5)
+      -  Table Replace (9db6ada77)
+
+   -  FLOW
+
+      -  Add ‘drop’ and ‘redirect-to-queue’ actions support (e8c9f4f1c)
+      -  Add ethernet flow (4ff8d615c)
+      -  Add GTP support (bf85a98fb)
+
+   -  GRE
+
+      -  Multi-point interfaces (5f8f61733)
+
+   -  GSO
+
+      -  Add protocol header parser (72e7312af)
+
+   -  Interface Common
+
+      -  Callback to manage extra MAC addresses (e0792fdff)
+      -  Dump the interface device type (de312c2d5)
+
+   -  IPIP
+
+      -  Tunnel flags controlling copying data to/from payload/encap
+         (9534696b4)
+
+   -  IPSec
+
+      -  Add ‘detail’ option to ‘sh ipsec sa’ (670027a50)
+      -  Add insecure option for format of SA (01d61e788)
+      -  Bind an SA to a worker (f62a8c013)
+      -  Remove dedicated IPSec tunnels (12989b538)
+      -  Support 4o6 and 6o4 for tunnel protect (b325983a4)
+
+   -  IPv4 LPM
+
+      -  Add shallow virtual reassembly functionality (de34c35fc)
+      -  Add tracing for ipv6 frag headers (0eb75d0e9)
+      -  Allow addrs from the same prefix on intf (6c92f5bab)
+      -  Apply dual loop unrolling in ip4_input (86b1871ba)
+      -  Apply dual loop unrolling in ip4_rewrite (840f64b4b)
+
+   -  IPv4 LPM
+
+      -  Protocol Independent IP Neighbors (cbe25aab3)
+      -  Punt rather than drop unkown IPv6 ICMP packets (1afe95272)
+      -  Reassembly: trace ip headers over worker handoffs (8563cb389)
+
+   -  Segment Routing (IPv6 and MPLS)
+
+      -  Add “set sr encaps hop-limit” command (eeb5fb3a5)
+
+   -  Session Layer
+
+      -  Add certificate store (79f89537c)
+      -  Add crypto context (de6caf481)
+      -  Add explicit reset api (dfb3b8771)
+      -  Add mq debug cli (cfdb10918)
+      -  Add session enable option in config file (1292d19c7)
+      -  Builtin app rx notifications regardless of state (5c29029ef)
+      -  Ckpair store & crypto engine as mq params (45ec9f49b)
+      -  Improve cli (5bb23ecd0)
+      -  Increasing the Header lengthe size (93e060aee)
+      -  Limit pacer bucket size (7c8f828ba)
+      -  More show cli output (91f90d082)
+      -  Reschedule asap when snd space constrained (dd97a48d9)
+      -  Support registration of custom crypto engines (79ba25d40)
+      -  Support for segments larger than 4GB (ef4f3e7fe)
+      -  Add opaque data to show cli (d9035a409)
+      -  Infra for transports to send buffers (2a7ea2ee9)
+      -  Support pacer idle timeouts (11e9e3510)
+
+   -  TAP Drivers
+
+      -  Add check for vhost-net backend (39807d02c)
+      -  Multiqueue support (7c6102b1a)
+
+   -  TCP
+
+      -  Add FEATURE.yaml (93e053ebe)
+      -  Add no csum offload config option (f4ce6ba22)
+      -  Add option for always on event logging (a436a4222)
+      -  Allow cc algos to set pacing rate (d206724e7)
+      -  Compute snd time for rate sample (7436b4367)
+      -  Custom checksum calculations for Ipv4/Ipv6 (02833ff32)
+      -  Enable gso in tcp hoststack (1146ff4bc)
+      -  Enable TCP timewait port use (b092b77cf)
+      -  Extend protocol configuration (9094b5c31)
+      -  Force zero window on full rx fifo (182d21983)
+      -  Handle sack reneging (558e3e095)
+      -  Improve lost rxt heuristic (b3dce89a7)
+      -  Improve pacing after idle send periods (c31dc31f8)
+      -  Retry lost retransmits (be237bf02)
+      -  Send rwnd update only if wnd is large enough (017dc4524)
+      -  Set cc_algo on connection alloc (12f6936cd)
+      -  Track lost rxt segments in byte tracker (46ec6e018)
+      -  Track zero rwnd errors (a495a3ea1)
+      -  Use rate sample rtt in recovery if possible (1dbda64b4)
+      -  Use sacks for timer based recovery (36ebcfffb)
+      -  Validate connections in output (78dae0088)
+      -  Validate the IP address while checking TCP connection
+         (cf4c2102d)
+
+   -  TLS and TLS engine plugins
+
+      -  Add C API for TLS openssl to set engine (be4d1aa2c)
+      -  Improve connection formating (0d74dd1f8)
+      -  Picotls engine basic enabling for TLS (f83194c2f)
+
+-  VPP Comms Library
+
+   -  Add api to set lcl ip (ef7cbf6ad)
+   -  Add config option for preferred tls engine (d747c3c36)
+   -  Allow non-blocking connects (57c88938f)
+
+-  VPP Object Model
+
+   -  Get interface type from vpp device type (3f4be92ce)
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Issues fixed
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+================================================ ==================
+Message Name                                     Result
+================================================ ==================
+abf_itf_attach_add_del                           definition changed
+abf_itf_attach_details                           definition changed
+abf_policy_add_del                               definition changed
+abf_policy_details                               definition changed
+af_packet_create                                 definition changed
+af_packet_create_reply                           definition changed
+af_packet_delete                                 definition changed
+af_packet_details                                definition changed
+af_packet_set_l4_cksum_offload                   definition changed
+api_versions_reply                               definition changed
+app_add_cert_key_pair                            only in image
+app_add_cert_key_pair_reply                      only in image
+app_attach                                       only in image
+app_attach_reply                                 only in image
+app_del_cert_key_pair                            only in image
+app_del_cert_key_pair_reply                      only in image
+avf_create_reply                                 definition changed
+avf_delete                                       definition changed
+bd_ip_mac_add_del                                definition changed
+bd_ip_mac_details                                definition changed
+bfd_udp_add                                      definition changed
+bfd_udp_auth_activate                            definition changed
+bfd_udp_auth_deactivate                          definition changed
+bfd_udp_del                                      definition changed
+bfd_udp_get_echo_source_reply                    definition changed
+bfd_udp_mod                                      definition changed
+bfd_udp_session_details                          definition changed
+bfd_udp_session_set_flags                        definition changed
+bfd_udp_set_echo_source                          definition changed
+bier_disp_entry_add_del                          definition changed
+bier_disp_entry_details                          definition changed
+bier_disp_table_add_del                          definition changed
+bier_route_add_del                               definition changed
+bier_table_add_del                               definition changed
+bond_create                                      definition changed
+bond_create_reply                                definition changed
+bond_delete                                      definition changed
+bond_detach_slave                                definition changed
+bond_enslave                                     definition changed
+builtinurl_enable                                only in image
+builtinurl_enable_reply                          only in image
+bvi_create                                       definition changed
+cdp_enable_disable                               definition changed
+classify_add_del_session                         definition changed
+classify_add_del_table                           definition changed
+classify_set_interface_ip_table                  definition changed
+classify_set_interface_l2_tables                 definition changed
+classify_table_by_interface                      definition changed
+classify_table_by_interface_reply                definition changed
+cli_inband                                       definition changed
+cli_inband_reply                                 definition changed
+collect_detailed_interface_stats                 definition changed
+connect_sock                                     definition changed
+cop_interface_enable_disable                     definition changed
+cop_whitelist_enable_disable                     definition changed
+create_loopback                                  definition changed
+create_loopback_instance                         definition changed
+create_loopback_instance_reply                   definition changed
+create_loopback_reply                            definition changed
+create_subif                                     definition changed
+create_subif_reply                               definition changed
+create_vhost_user_if                             definition changed
+create_vhost_user_if_reply                       definition changed
+create_vlan_subif                                definition changed
+create_vlan_subif_reply                          definition changed
+ct6_enable_disable                               definition changed
+delete_loopback                                  definition changed
+delete_subif                                     definition changed
+delete_vhost_user_if                             definition changed
+dhcp6_client_enable_disable                      definition changed
+dhcp6_clients_enable_disable                     definition changed
+dhcp6_pd_client_enable_disable                   definition changed
+dhcp6_pd_reply_event                             definition changed
+dhcp6_pd_send_client_message                     definition changed
+dhcp6_reply_event                                definition changed
+dhcp6_send_client_message                        definition changed
+dhcp_client_config                               definition changed
+dhcp_client_details                              definition changed
+dhcp_compl_event                                 definition changed
+dhcp_plugin_control_ping                         only in image
+dhcp_plugin_control_ping_reply                   only in image
+dhcp_plugin_get_version                          only in image
+dhcp_plugin_get_version_reply                    only in image
+dhcp_proxy_config                                definition changed
+dhcp_proxy_details                               definition changed
+dhcp_proxy_dump                                  definition changed
+dhcp_proxy_set_vss                               definition changed
+dslite_add_del_pool_addr_range                   definition changed
+dslite_address_details                           definition changed
+dslite_get_aftr_addr_reply                       definition changed
+dslite_get_b4_addr_reply                         definition changed
+dslite_set_aftr_addr                             definition changed
+dslite_set_b4_addr                               definition changed
+feature_enable_disable                           definition changed
+feature_gso_enable_disable                       only in image
+feature_gso_enable_disable_reply                 only in image
+flow_classify_details                            definition changed
+flow_classify_dump                               definition changed
+flow_classify_set_interface                      definition changed
+flowprobe_params                                 definition changed
+flowprobe_tx_interface_add_del                   definition changed
+gbp_bridge_domain_add                            definition changed
+gbp_bridge_domain_details                        definition changed
+gbp_contract_add_del                             definition changed
+gbp_contract_details                             definition changed
+gbp_endpoint_add                                 definition changed
+gbp_endpoint_details                             definition changed
+gbp_endpoint_group_add                           definition changed
+gbp_endpoint_group_details                       definition changed
+gbp_ext_itf_add_del                              definition changed
+gbp_ext_itf_details                              definition changed
+gbp_recirc_add_del                               definition changed
+gbp_recirc_details                               definition changed
+gbp_route_domain_add                             definition changed
+gbp_route_domain_details                         definition changed
+gbp_subnet_add_del                               definition changed
+gbp_subnet_details                               definition changed
+gbp_vxlan_tunnel_add                             definition changed
+gbp_vxlan_tunnel_add_reply                       definition changed
+gbp_vxlan_tunnel_details                         definition changed
+geneve_add_del_tunnel                            definition changed
+geneve_add_del_tunnel_reply                      definition changed
+geneve_tunnel_details                            definition changed
+geneve_tunnel_dump                               definition changed
+get_first_msg_id                                 definition changed
+gre_tunnel_add_del                               definition changed
+gre_tunnel_add_del_reply                         definition changed
+gre_tunnel_details                               definition changed
+gre_tunnel_dump                                  definition changed
+gtpu_add_del_tunnel                              definition changed
+gtpu_add_del_tunnel_reply                        definition changed
+gtpu_tunnel_details                              definition changed
+gtpu_tunnel_dump                                 definition changed
+http_static_enable                               definition changed
+hw_interface_set_mtu                             definition changed
+igmp_clear_interface                             definition changed
+igmp_details                                     definition changed
+igmp_dump                                        definition changed
+igmp_enable_disable                              definition changed
+igmp_event                                       definition changed
+igmp_group_prefix_details                        definition changed
+igmp_group_prefix_set                            definition changed
+igmp_listen                                      definition changed
+igmp_proxy_device_add_del                        definition changed
+igmp_proxy_device_add_del_interface              definition changed
+ikev2_initiate_sa_init                           definition changed
+ikev2_profile_add_del                            definition changed
+ikev2_profile_set_auth                           definition changed
+ikev2_profile_set_id                             definition changed
+ikev2_profile_set_ts                             definition changed
+ikev2_set_esp_transforms                         definition changed
+ikev2_set_ike_transforms                         definition changed
+ikev2_set_responder                              definition changed
+ikev2_set_sa_lifetime                            definition changed
+input_acl_set_interface                          definition changed
+interface_name_renumber                          definition changed
+ioam_cache_ip6_enable_disable                    definition changed
+ioam_enable                                      definition changed
+ioam_export_ip6_enable_disable                   definition changed
+ip4_arp_event                                    only in file
+ip6_add_del_address_using_prefix                 definition changed
+ip6_nd_address_autoconfig                        definition changed
+ip6_nd_event                                     only in file
+ip6_ra_event                                     definition changed
+ip6nd_proxy_add_del                              definition changed
+ip6nd_proxy_details                              definition changed
+ip6nd_send_router_solicitation                   definition changed
+ip_address_details                               definition changed
+ip_address_dump                                  definition changed
+ip_container_proxy_add_del                       definition changed
+ip_container_proxy_details                       definition changed
+ip_details                                       definition changed
+ip_dump                                          definition changed
+ip_mroute_add_del                                definition changed
+ip_mroute_details                                definition changed
+ip_mroute_dump                                   definition changed
+ip_mtable_details                                definition changed
+ip_neighbor_add_del                              definition changed
+ip_neighbor_config                               only in image
+ip_neighbor_config_reply                         only in image
+ip_neighbor_details                              definition changed
+ip_neighbor_dump                                 definition changed
+ip_neighbor_event                                only in image
+ip_probe_neighbor                                only in file
+ip_probe_neighbor_reply                          only in file
+ip_punt_police                                   definition changed
+ip_punt_redirect                                 definition changed
+ip_punt_redirect_details                         definition changed
+ip_punt_redirect_dump                            definition changed
+ip_reassembly_enable_disable                     definition changed
+ip_reassembly_get                                definition changed
+ip_reassembly_get_reply                          definition changed
+ip_reassembly_set                                definition changed
+ip_route_add_del                                 definition changed
+ip_route_details                                 definition changed
+ip_route_dump                                    definition changed
+ip_scan_neighbor_enable_disable                  only in file
+ip_scan_neighbor_enable_disable_reply            only in file
+ip_source_and_port_range_check_add_del           definition changed
+ip_source_and_port_range_check_interface_add_del definition changed
+ip_source_check_interface_add_del                definition changed
+ip_table_add_del                                 definition changed
+ip_table_details                                 definition changed
+ip_table_flush                                   only in image
+ip_table_flush_reply                             only in image
+ip_table_replace_begin                           only in image
+ip_table_replace_begin_reply                     only in image
+ip_table_replace_end                             only in image
+ip_table_replace_end_reply                       only in image
+ip_unnumbered_details                            definition changed
+ip_unnumbered_dump                               definition changed
+ipfix_classify_table_add_del                     definition changed
+ipfix_classify_table_details                     definition changed
+ipfix_exporter_details                           definition changed
+ipip_6rd_add_tunnel                              definition changed
+ipip_6rd_add_tunnel_reply                        definition changed
+ipip_6rd_del_tunnel                              definition changed
+ipip_add_tunnel                                  definition changed
+ipip_add_tunnel_reply                            definition changed
+ipip_del_tunnel                                  definition changed
+ipip_tunnel_details                              definition changed
+ipip_tunnel_dump                                 definition changed
+ipsec_spd_details                                definition changed
+ipsec_spd_entry_add_del                          definition changed
+ipsec_tunnel_if_add_del                          definition changed
+ipsec_tunnel_protect_del                         definition changed
+ipsec_tunnel_protect_details                     definition changed
+ipsec_tunnel_protect_dump                        definition changed
+ipsec_tunnel_protect_update                      definition changed
+l2_arp_term_event                                only in image
+l2_emulation                                     definition changed
+l2tpv3_create_tunnel                             definition changed
+l2tpv3_create_tunnel_reply                       definition changed
+l2tpv3_interface_enable_disable                  definition changed
+l2tpv3_set_lookup_key                            definition changed
+l2tpv3_set_tunnel_cookies                        definition changed
+l3xc_del                                         definition changed
+l3xc_details                                     definition changed
+l3xc_dump                                        definition changed
+l3xc_update                                      definition changed
+lb_add_del_as                                    definition changed
+lb_add_del_intf_nat4                             only in image
+lb_add_del_intf_nat4_reply                       only in image
+lb_add_del_intf_nat6                             only in image
+lb_add_del_intf_nat6_reply                       only in image
+lb_add_del_vip                                   definition changed
+lb_as_details                                    definition changed
+lb_as_dump                                       definition changed
+lb_conf                                          definition changed
+lb_flush_vip                                     definition changed
+lb_vip_details                                   definition changed
+lb_vip_dump                                      definition changed
+log_details                                      definition changed
+log_dump                                         definition changed
+mactime_add_del_range                            definition changed
+mactime_details                                  only in image
+mactime_dump                                     only in image
+mactime_dump_reply                               only in image
+mactime_enable_disable                           definition changed
+map_add_del_rule                                 definition changed
+map_add_domain                                   definition changed
+map_domain_details                               definition changed
+map_if_enable_disable                            definition changed
+map_param_add_del_pre_resolve                    definition changed
+map_param_get_reply                              definition changed
+map_param_set_icmp                               definition changed
+map_param_set_reassembly                         only in file
+map_param_set_reassembly_reply                   only in file
+map_param_set_traffic_class                      definition changed
+map_rule_details                                 definition changed
+mdata_enable_disable                             only in image
+mdata_enable_disable_reply                       only in image
+memclnt_create                                   definition changed
+memclnt_delete                                   definition changed
+memif_create                                     definition changed
+memif_create_reply                               definition changed
+memif_delete                                     definition changed
+memif_details                                    definition changed
+memif_socket_filename_add_del                    definition changed
+memif_socket_filename_details                    definition changed
+mfib_signal_details                              definition changed
+modify_vhost_user_if                             definition changed
+mpls_ip_bind_unbind                              definition changed
+mpls_route_add_del                               definition changed
+mpls_route_details                               definition changed
+mpls_route_dump                                  definition changed
+mpls_table_add_del                               definition changed
+mpls_table_details                               definition changed
+mpls_tunnel_add_del                              definition changed
+mpls_tunnel_add_del_reply                        definition changed
+mpls_tunnel_details                              definition changed
+mpls_tunnel_dump                                 definition changed
+nat44_add_del_address_range                      definition changed
+nat44_add_del_identity_mapping                   definition changed
+nat44_add_del_interface_addr                     definition changed
+nat44_add_del_lb_static_mapping                  definition changed
+nat44_add_del_static_mapping                     definition changed
+nat44_address_details                            definition changed
+nat44_del_session                                definition changed
+nat44_identity_mapping_details                   definition changed
+nat44_interface_add_del_feature                  definition changed
+nat44_interface_add_del_output_feature           definition changed
+nat44_interface_addr_details                     definition changed
+nat44_interface_details                          definition changed
+nat44_interface_output_feature_details           definition changed
+nat44_lb_static_mapping_add_del_local            definition changed
+nat44_lb_static_mapping_details                  definition changed
+nat44_static_mapping_details                     definition changed
+nat44_user_details                               definition changed
+nat44_user_session_details                       definition changed
+nat44_user_session_dump                          definition changed
+nat64_add_del_interface_addr                     definition changed
+nat64_add_del_interface                          definition changed
+nat64_add_del_pool_addr_range                    definition changed
+nat64_add_del_prefix                             definition changed
+nat64_add_del_static_bib                         definition changed
+nat64_bib_details                                definition changed
+nat64_interface_details                          definition changed
+nat64_pool_addr_details                          definition changed
+nat64_prefix_details                             definition changed
+nat64_st_details                                 definition changed
+nat66_add_del_interface                          definition changed
+nat66_add_del_static_mapping                     definition changed
+nat66_interface_details                          definition changed
+nat66_static_mapping_details                     definition changed
+nat_det_add_del_map                              definition changed
+nat_det_close_session_in                         definition changed
+nat_det_close_session_out                        definition changed
+nat_det_forward                                  definition changed
+nat_det_forward_reply                            definition changed
+nat_det_map_details                              definition changed
+nat_det_reverse                                  definition changed
+nat_det_reverse_reply                            definition changed
+nat_det_session_details                          definition changed
+nat_det_session_dump                             definition changed
+nat_get_reass                                    only in file
+nat_get_reass_reply                              only in file
+nat_ha_get_failover_reply                        definition changed
+nat_ha_get_listener_reply                        definition changed
+nat_ha_set_failover                              definition changed
+nat_ha_set_listener                              definition changed
+nat_reass_details                                only in file
+nat_reass_dump                                   only in file
+nat_set_reass                                    only in file
+nat_set_reass_reply                              only in file
+nat_worker_details                               definition changed
+nhrp_details                                     only in image
+nhrp_dump                                        only in image
+nhrp_entry_add_del                               only in image
+nhrp_entry_add_del_reply                         only in image
+nsh_add_del_entry                                definition changed
+nsh_add_del_map                                  definition changed
+nsh_map_details                                  definition changed
+nsim_cross_connect_enable_disable                definition changed
+nsim_output_feature_enable_disable               definition changed
+output_acl_set_interface                         definition changed
+p2p_ethernet_add                                 definition changed
+p2p_ethernet_add_reply                           definition changed
+p2p_ethernet_del                                 definition changed
+pipe_create                                      definition changed
+pipe_create_reply                                definition changed
+pipe_delete                                      definition changed
+pipe_details                                     definition changed
+policer_classify_details                         definition changed
+policer_classify_dump                            definition changed
+policer_classify_set_interface                   definition changed
+pot_profile_activate                             definition changed
+pot_profile_add                                  definition changed
+pot_profile_del                                  definition changed
+pppoe_add_del_session                            definition changed
+pppoe_add_del_session_reply                      definition changed
+pppoe_session_details                            definition changed
+pppoe_session_dump                               definition changed
+proxy_arp_add_del                                definition changed
+proxy_arp_details                                definition changed
+proxy_arp_intfc_enable_disable                   definition changed
+punt_reason_details                              definition changed
+punt_reason_dump                                 definition changed
+punt_socket_details                              definition changed
+punt_socket_register                             definition changed
+punt_socket_register_reply                       definition changed
+qos_mark_dump                                    definition changed
+qos_mark_enable_disable                          definition changed
+qos_record_details                               definition changed
+qos_record_enable_disable                        definition changed
+qos_store_details                                definition changed
+qos_store_enable_disable                         definition changed
+rdma_create                                      only in image
+rdma_create_reply                                only in image
+rdma_delete                                      only in image
+rdma_delete_reply                                only in image
+reset_fib                                        only in file
+reset_fib_reply                                  only in file
+set_arp_neighbor_limit                           only in file
+set_arp_neighbor_limit_reply                     only in file
+set_ip_flow_hash                                 definition changed
+set_ipfix_exporter                               definition changed
+set_punt                                         definition changed
+show_version_reply                               definition changed
+show_vpe_system_time_reply                       definition changed
+sockclnt_create                                  definition changed
+sockclnt_create_reply                            definition changed
+sr_set_encap_hop_limit                           only in image
+sr_set_encap_hop_limit_reply                     only in image
+stn_add_del_rule                                 definition changed
+stn_rules_details                                definition changed
+svs_details                                      definition changed
+svs_enable_disable                               definition changed
+svs_route_add_del                                definition changed
+svs_table_add_del                                definition changed
+sw_if_l2tpv3_tunnel_details                      definition changed
+sw_interface_add_del_address                     definition changed
+sw_interface_add_del_mac_address                 only in image
+sw_interface_add_del_mac_address_reply           only in image
+sw_interface_bond_details                        definition changed
+sw_interface_clear_stats                         definition changed
+sw_interface_details                             definition changed
+sw_interface_dump                                definition changed
+sw_interface_event                               definition changed
+sw_interface_get_mac_address                     definition changed
+sw_interface_get_mac_address_reply               definition changed
+sw_interface_get_table                           definition changed
+sw_interface_ip6_enable_disable                  definition changed
+sw_interface_ip6_set_link_local_address          definition changed
+sw_interface_ip6nd_ra_config                     definition changed
+sw_interface_ip6nd_ra_prefix                     definition changed
+sw_interface_lacp_details                        definition changed
+sw_interface_rx_placement_details                definition changed
+sw_interface_rx_placement_dump                   definition changed
+sw_interface_set_bond_weight                     only in image
+sw_interface_set_bond_weight_reply               only in image
+sw_interface_set_flags                           definition changed
+sw_interface_set_geneve_bypass                   definition changed
+sw_interface_set_gtpu_bypass                     definition changed
+sw_interface_set_ip_directed_broadcast           definition changed
+sw_interface_set_mac_address                     definition changed
+sw_interface_set_mpls_enable                     definition changed
+sw_interface_set_mtu                             definition changed
+sw_interface_set_rx_mode                         definition changed
+sw_interface_set_rx_placement                    definition changed
+sw_interface_set_table                           definition changed
+sw_interface_set_unnumbered                      definition changed
+sw_interface_set_vxlan_gbp_bypass                definition changed
+sw_interface_slave_details                       definition changed
+sw_interface_slave_dump                          definition changed
+sw_interface_tag_add_del                         definition changed
+sw_interface_tap_v2_details                      definition changed
+sw_interface_tap_v2_dump                         definition changed
+sw_interface_vhost_user_details                  definition changed
+sw_interface_vhost_user_dump                     definition changed
+sw_interface_virtio_pci_details                  definition changed
+syslog_get_sender_reply                          definition changed
+syslog_set_sender                                definition changed
+tap_create_v2                                    definition changed
+tap_create_v2_reply                              definition changed
+tap_delete_v2                                    definition changed
+tcp_configure_src_addresses                      definition changed
+tls_openssl_set_engine                           only in image
+tls_openssl_set_engine_reply                     only in image
+trace_plugin_msg_ids                             definition changed
+udp_encap_add                                    definition changed
+udp_encap_details                                definition changed
+udp_ping_add_del                                 definition changed
+udp_ping_export                                  definition changed
+virtio_pci_create                                definition changed
+virtio_pci_create_reply                          definition changed
+virtio_pci_delete                                definition changed
+vmxnet3_create                                   definition changed
+vmxnet3_create_reply                             definition changed
+vmxnet3_delete                                   definition changed
+vmxnet3_details                                  definition changed
+vxlan_gbp_tunnel_add_del                         definition changed
+vxlan_gbp_tunnel_add_del_reply                   definition changed
+vxlan_gbp_tunnel_details                         definition changed
+vxlan_gbp_tunnel_dump                            definition changed
+vxlan_gpe_ioam_enable                            definition changed
+vxlan_gpe_ioam_export_enable_disable             definition changed
+vxlan_gpe_ioam_transit_disable                   definition changed
+vxlan_gpe_ioam_transit_enable                    definition changed
+vxlan_gpe_ioam_vni_disable                       definition changed
+vxlan_gpe_ioam_vni_enable                        definition changed
+want_bfd_events                                  definition changed
+want_dhcp6_pd_reply_events                       definition changed
+want_ip4_arp_events                              only in file
+want_ip4_arp_events_reply                        only in file
+want_ip6_nd_events                               only in file
+want_ip6_nd_events_reply                         only in file
+want_ip6_ra_events                               definition changed
+want_ip_neighbor_events                          only in image
+want_ip_neighbor_events_reply                    only in image
+want_l2_arp_term_events                          only in image
+want_l2_arp_term_events_reply                    only in image
+want_l2_macs_events                              definition changed
+================================================ ==================
+
+Found 493 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+``src/vlibmemory/memclnt.api``
+
+* `8e388390d `_ vlib: use explicit types in api
+* `daa4bff16 `_ api: memclnt api use string type.
+* `7adaa226e `_ api: revert use string type for strings in memclnt.api
+* `2959d42fe `_ api: use string type for strings in memclnt.api
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+
+``src/examples/sample-plugin/sample/sample.api``
+
+* `33a58171e `_ api: autogenerate api trace print/endian
+* `78d91cf9a `_ sample-plugin: refactor .api to use explicit types
+
+``src/vnet/interface.api``
+
+* `418ebb711 `_ papi: support default for type alias decaying to basetype
+* `9485d99bd `_ interface: Allow VLAN tag-rewrite on non-sub-interfaces too.
+* `c12eae73f `_ interface: shmemioerror while getting name_filter arg
+* `de312c2d5 `_ interface: dump the interface device type
+* `e0792fdff `_ interface: callback to manage extra MAC addresses
+* `75761b933 `_ api: split vl_api_prefix into two
+* `e5ff5a36d `_ api: enforce vla is last and fixed string type
+* `053204ab0 `_ api: Cleanup APIs interface.api
+* `0ad4a439d `_ Fix vpp crash bug while deleting dhcp client
+* `9a29f795a `_ vpp_papi_provider.py: update defautmapping.
+* `b8591ac91 `_ API sw_interface_dump: Dump all if index is zero
+* `4a7240636 `_ Make sw_interface_dump more compatible with 2.2.0
+* `6407ba56a `_ api: Add to interface crud - read by sw_if_index.
+
+``src/vnet/interface_types.api``
+
+* `053204ab0 `_ api: Cleanup APIs interface.api
+
+``src/vnet/session/session.api``
+
+* `c4c4cf506 `_ session: move add/del segment msg to mq
+* `79f89537c `_ session: Add certificate store
+* `e5ff5a36d `_ api: enforce vla is last and fixed string type
+* `458089bba `_ session: move ctrl messages from bapi to mq
+* `8ac1d6d05 `_ session: Use parent_handle instead of transport_opts
+* `ba65ca496 `_ Add transport_opts to connect_sock bapi
+
+``src/vnet/classify/classify.api``
+
+* `692bfc85f `_ classify: API cleanup
+
+``src/vnet/l2tp/l2tp.api``
+
+* `3ae526271 `_ l2: l2tp API cleanup
+
+``src/vnet/gre/gre.api``
+
+* `5f8f61733 `_ gre: Multi-point interfaces
+* `814f15948 `_ gre: update gre.api with explicit types
+* `d0aed2eb3 `_ GRE: set gre_tunnel_type init value to zero in API
+* `5a8844bdb `_ GRE: API update
+
+``src/vnet/fib/fib_types.api``
+
+* `1dbcf30b7 `_ fib: Support the POP of a Psuedo Wire Control Word
+* `097fa66b9 `_ fib: fib api updates
+
+``src/vnet/lisp-cp/one.api``
+
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+
+``src/vnet/lisp-cp/lisp.api``
+
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+
+``src/vnet/feature/feature.api``
+
+* `bf6c5c158 `_ feature: API cleanup
+
+``src/vnet/nhrp/nhrp.api``
+
+* `5f8f61733 `_ gre: Multi-point interfaces
+
+``src/vnet/qos/qos.api``
+
+* `4b76c58be `_ qos: api clenup
+* `83832e7ce `_ qos: Store function
+* `5281a9029 `_ qos: QoS dump APIs
+
+``src/vnet/ipsec/ipsec.api``
+
+* `dbf68c9aa `_ ipsec: Changes to make ipsec encoder/decoders reusable by the plugins
+* `12989b538 `_ ipsec: remove dedicated IPSec tunnels
+* `c87b66c86 `_ ipsec: ipsec-tun protect
+* `f2922422d `_ ipsec: remove the set_key API
+* `80f6fd53f `_ IPSEC: Pass the algorithm salt (used in GCM) over the API
+
+``src/vnet/ipsec/ipsec_types.api``
+
+* `dbf68c9aa `_ ipsec: Changes to make ipsec encoder/decoders reusable by the plugins
+
+``src/vnet/lisp-gpe/lisp_gpe.api``
+
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+
+``src/vnet/pci/pci_types.api``
+
+* `2c504f89c `_ devices: virtio API cleanup
+
+``src/vnet/bonding/bond.api``
+
+* `3d1ef873d `_ bonding: API cleanup
+* `a1876b84e `_ bonding: add weight support for active-backup mode
+* `751e3f382 `_ bonding: add support for numa-only in lacp mode
+
+``src/vnet/tcp/tcp.api``
+
+* `956819afa `_ tcp: api clenup
+
+``src/vnet/cop/cop.api``
+
+* `aa4438a31 `_ cop: API cleanup
+
+``src/vnet/ip-neighbor/ip_neighbor.api``
+
+* `cbe25aab3 `_ ip: Protocol Independent IP Neighbors
+
+``src/vnet/ethernet/p2p_ethernet.api``
+
+* `8edca1361 `_ p2p ethernet: update p2p_ethernet.api with explicit types.
+
+``src/vnet/ethernet/ethernet_types.api``
+
+* `33a58171e `_ api: autogenerate api trace print/endian
+
+``src/vnet/vxlan-gbp/vxlan_gbp.api``
+
+* `fb27096ee `_ vxlan-gbp: api cleanup
+
+``src/vnet/arp/arp.api``
+
+* `cbe25aab3 `_ ip: Protocol Independent IP Neighbors
+
+``src/vnet/ipip/ipip.api``
+
+* `9534696b4 `_ ipip: Tunnel flags controlling copying data to/from payload/encap
+* `288e09362 `_ ipip: refactor ipip.api with explicit types
+* `cbd0824d6 `_ IPIP tunnel: use address types on API
+
+``src/vnet/ipip/ipip_types.api``
+
+* `9534696b4 `_ ipip: Tunnel flags controlling copying data to/from payload/encap
+
+``src/vnet/bfd/bfd.api``
+
+* `4682feb1f `_ bfd: API cleanup
+
+``src/vnet/l2/l2.api``
+
+* `cbe25aab3 `_ ip: Protocol Independent IP Neighbors
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `bc764c8bc `_ l2: BD ARP termination entry API update
+* `54bc5e40c `_ Update API description
+* `5e6f7348c `_ l2: Add support for arp unicast forwarding
+
+``src/vnet/ip6-nd/ip6_nd.api``
+
+* `cbe25aab3 `_ ip: Protocol Independent IP Neighbors
+
+``src/vnet/ip6-nd/rd_cp.api``
+
+* `cbe25aab3 `_ ip: Protocol Independent IP Neighbors
+
+``src/vnet/udp/udp.api``
+
+* `10dc2eabd `_ udp: fix copyright typo
+
+``src/vnet/mpls/mpls.api``
+
+* `3eb8f207b `_ mpls: api cleanup
+* `75761b933 `_ api: split vl_api_prefix into two
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `097fa66b9 `_ fib: fib api updates
+
+``src/vnet/mfib/mfib_types.api``
+
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `097fa66b9 `_ fib: fib api updates
+
+``src/vnet/ip/ip_types.api``
+
+* `75761b933 `_ api: split vl_api_prefix into two
+* `33a58171e `_ api: autogenerate api trace print/endian
+* `515eed425 `_ api: add prefix matcher typedef
+* `038e1dfbd `_ dhcp ip: DSCP settings for transmitted DHCP packets
+* `53c501512 `_ api: add DSCP definitions to ip_types.api
+* `ab05508e1 `_ api: refactor format_vl_api_prefix_t return keys
+* `b538dd868 `_ Punt: specify packets by IP protocol Type
+* `50f0ac0f0 `_ Punt: socket register for exception dispatched/punted packets based on reason
+
+``src/vnet/ip/punt.api``
+
+* `f158944cc `_ ip: trivial typos in docs
+* `f72ad93d6 `_ ip: punt API cleanup
+* `e5ff5a36d `_ api: enforce vla is last and fixed string type
+* `719beb709 `_ ip ipsec: Remove IPSec SPI-0 punt reason
+* `b538dd868 `_ Punt: specify packets by IP protocol Type
+* `50f0ac0f0 `_ Punt: socket register for exception dispatched/punted packets based on reason
+
+``src/vnet/ip/ip.api``
+
+* `58989a37d `_ ip: API cleanup
+* `cbe25aab3 `_ ip: Protocol Independent IP Neighbors
+* `668605fc8 `_ ip: use explicit types in api
+* `9db6ada77 `_ fib: Table Replace
+* `de34c35fc `_ ip: add shallow virtual reassembly functionality
+* `75761b933 `_ api: split vl_api_prefix into two
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `097fa66b9 `_ fib: fib api updates
+* `3a343d42d `_ reassembly: prevent long chain attack
+
+``src/vnet/pg/pg.api``
+
+* `22e9cfd76 `_ pg: add GSO support
+
+``src/vnet/bier/bier.api``
+
+* `f1f5a8a1a `_ bier: API cleanup
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `097fa66b9 `_ fib: fib api updates
+* `e6eefb6e3 `_ Trivial Typo's in bier comments/docs.
+
+``src/vnet/ipfix-export/ipfix_export.api``
+
+* `2f71a8889 `_ ip: ipfix-export API update
+* `21b83e96d `_ api: implement ipfix_flush
+
+``src/vnet/gso/gso.api``
+
+* `29467b534 `_ gso: Add gso feature arc
+
+``src/vnet/devices/af_packet/af_packet.api``
+
+* `97c998c28 `_ docs: devices-- add FEATURES.yaml
+* `3b2db9002 `_ devices: af_packet API cleanup
+
+``src/vnet/devices/virtio/vhost_user.api``
+
+* `5d4c99f27 `_ devices: vhost API cleanup
+* `4208a4ce8 `_ devices interface tests: vhosst GSO support
+
+``src/vnet/devices/virtio/virtio_types.api``
+
+* `5d4c99f27 `_ devices: vhost API cleanup
+
+``src/vnet/devices/virtio/virtio.api``
+
+* `6d4af8918 `_ virtio: split gso and checksum offload functionality
+* `2c504f89c `_ devices: virtio API cleanup
+* `97c998c28 `_ docs: devices-- add FEATURES.yaml
+* `bbd6b746e `_ virtio: Add gso support for native virtio driver
+* `43b512cac `_ virtio: remove configurable queue size support
+
+``src/vnet/devices/pipe/pipe.api``
+
+* `97c998c28 `_ docs: devices-- add FEATURES.yaml
+* `df40cb5b5 `_ devices: pipe API cleanup
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `ba0061feb `_ tap: split gso and checksum offload functionality
+* `5de4fb707 `_ devices: tap API cleanup
+* `44d06916b `_ tap: Move client registration check to top
+* `97c998c28 `_ docs: devices-- add FEATURES.yaml
+* `97d54ed43 `_ tap: add support to configure tap interface host MTU size
+
+``src/vnet/srv6/sr.api``
+
+* `eeb5fb3a5 `_ sr: add "set sr encaps hop-limit" command
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+
+``src/vnet/geneve/geneve.api``
+
+* `2d3282e17 `_ geneve: API cleanup
+
+``src/plugins/marvell/pp2/pp2.api``
+
+* `4a65b910a `_ marvell: use explicit types in api
+* `859b59133 `_ api: Add API support for marvell PP2 plugin
+
+``src/plugins/svs/svs.api``
+
+* `5e913f374 `_ svs: use explicit types in api
+
+``src/plugins/acl/acl_types.api``
+
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `bb2e5221a `_ api acl: breakout acl_types.api for reuse by others
+
+``src/plugins/acl/acl.api``
+
+* `b5076cbe1 `_ acl: add missing square brackets to vat_help option in acl api
+* `709dad304 `_ acl: remove api boilerplate
+* `bb2e5221a `_ api acl: breakout acl_types.api for reuse by others
+* `f995c7122 `_ acl: implement counters
+
+``src/plugins/memif/memif.api``
+
+* `3ae9f5a90 `_ memif: remove api boilerplate
+* `546f955b3 `_ memif: API cleanup
+
+``src/plugins/cdp/cdp.api``
+
+* `07e557a73 `_ cdp: use explicit types in api
+
+``src/plugins/dhcp/dhcp6_ia_na_client_cp.api``
+
+* `02bfd641b `_ dhcp: Move to plugin
+
+``src/plugins/dhcp/dhcp6_pd_client_cp.api``
+
+* `d5262831a `_ dhcp: dhcp6_pd_client_cp API cleanup
+* `02bfd641b `_ dhcp: Move to plugin
+
+``src/plugins/dhcp/dhcp.api``
+
+* `6bcc6a455 `_ dhcp: fix crash on unicast renewal send
+* `02bfd641b `_ dhcp: Move to plugin
+
+``src/plugins/avf/avf.api``
+
+* `a0bf06d74 `_ avf: explicit types in api
+* `74af6f081 `_ avf: remote api boilerplate
+
+``src/plugins/dpdk/api/dpdk.api``
+
+* `6d75c20a6 `_ dpdk: use explicit types in api
+* `025166dc7 `_ dpdk: remove api boilerplate
+
+``src/plugins/builtinurl/builtinurl.api``
+
+* `43765e2b4 `_ builtinurl: initial working attempt
+
+``src/plugins/mactime/mactime.api``
+
+* `7b22df06f `_ mactime: update api to use explicit types
+* `2c41a61d5 `_ mactime: add a "top" command to watch device stats
+* `7071952df `_ mactime: remove api boilerplate
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `7681b1c46 `_ mactime: add per-mac allow-with-quota feature
+* `0c6ac791d `_ mactime: upstream new features
+
+``src/plugins/ikev2/ikev2.api``
+
+* `6aaee8c7c `_ ikev2: use explicit api types
+* `fc7b77db7 `_ ikev2: remove api boilerplate
+
+``src/plugins/http_static/http_static.api``
+
+* `e5ff5a36d `_ api: enforce vla is last and fixed string type
+* `68b24e2c9 `_ plugins: http_static. Migrate to use api string type.
+* `22bc2c46e `_ Static http server
+
+``src/plugins/gbp/gbp.api``
+
+* `38277e407 `_ gbp: use explicit types in api
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `3918bdbcb `_ gbp: update gbp-ext-itf API
+* `3c0d84c98 `_ gbp: add anonymous l3-out subnets
+* `cfc7a107e `_ gbp: add anonymous l3-out external interfaces
+* `160c923f9 `_ gbp: VRF scoped contracts
+
+``src/plugins/l2e/l2e.api``
+
+* `b2e463a10 `_ l2e: use explicit api types
+
+``src/plugins/gtpu/gtpu.api``
+
+* `55636cb62 `_ gtpu: use explicit types in api
+* `49228efce `_ gtpu: remove api boilerplate
+
+``src/plugins/igmp/igmp.api``
+
+* `4a7fc4cf1 `_ igmp: use explicit types in api
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `4ff09ae34 `_ API: Python and Unix domain socket improvement
+
+``src/plugins/ioam/lib-vxlan-gpe/ioam_vxlan_gpe.api``
+
+* `0fa66d618 `_ ioam: use explicit api types
+
+``src/plugins/ioam/udp-ping/udp_ping.api``
+
+* `0fa66d618 `_ ioam: use explicit api types
+
+``src/plugins/ioam/export/ioam_export.api``
+
+* `0fa66d618 `_ ioam: use explicit api types
+
+``src/plugins/ioam/ip6/ioam_cache.api``
+
+* `0fa66d618 `_ ioam: use explicit api types
+
+``src/plugins/ioam/lib-pot/pot.api``
+
+* `0fa66d618 `_ ioam: use explicit api types
+
+``src/plugins/ioam/export-vxlan-gpe/vxlan_gpe_ioam_export.api``
+
+* `0fa66d618 `_ ioam: use explicit api types
+
+``src/plugins/stn/stn.api``
+
+* `7929f9f5c `_ stn: use explicit types in api
+
+``src/plugins/map/map.api``
+
+* `be31c2a25 `_ map: use explicit types in api
+* `7b2e9fb1a `_ map: use ip6-full-reassembly instead of own code
+* `640edcd90 `_ map: use SVR for MAP-T
+* `e5ff5a36d `_ api: enforce vla is last and fixed string type
+* `ff47fb645 `_ vppapigen map: raise ValueError when fieldname is python keyword
+* `4d376f67a `_ map: Use vl_api_string macros.
+
+``src/plugins/oddbuf/oddbuf.api``
+
+* `7ff64fb97 `_ oddbuf: remove api boilerplate
+* `a287a30dd `_ misc: fix coverity warning in the oddbuf plugin
+* `c4abafd83 `_ ip: fix udp/tcp checksum corner cases
+
+``src/plugins/l3xc/l3xc.api``
+
+* `60f5108a9 `_ l3xc: use explicit types in api
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `59fa121f8 `_ L3 cross connect
+
+``src/plugins/pppoe/pppoe.api``
+
+* `04338e85a `_ pppoe: use explicit types in api
+* `25fe57821 `_ pppoe: remove api boilerplate
+
+``src/plugins/mdata/mdata.api``
+
+* `d7b306657 `_ mdata: buffer metadata change tracker plugin
+
+``src/plugins/lb/lb.api``
+
+* `ae0724034 `_ lb: remove api boilerplate
+* `33538a150 `_ lb: add APIs for set interface nat4 and nat6
+* `75761b933 `_ api: split vl_api_prefix into two
+* `3efcd0d7c `_ lb: vip and as dump/detail api's
+* `a0cb32cb9 `_ lb: update api.c to use scaffolding from latest skel
+
+``src/plugins/lb/lb_types.api``
+
+* `75761b933 `_ api: split vl_api_prefix into two
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `3efcd0d7c `_ lb: vip and as dump/detail api's
+
+``src/plugins/nsim/nsim.api``
+
+* `e06e7c672 `_ nsim: use explicit api types
+* `2e7a43ca4 `_ nsim: remove api boilerplate
+* `7c91007e1 `_ Make the loss / delay sim available as an output feature
+
+``src/plugins/vmxnet3/vmxnet3.api``
+
+* `277f03f06 `_ vmxnet3: use explicit types in api
+* `10bbfce02 `_ vmxnet3: remove api boilerplate
+* `2985e0af6 `_ vmxnet3: per interface gso support
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+
+``src/plugins/tlsopenssl/tls_openssl.api``
+
+* `1e582206a `_ tls: remove api boilerplate
+* `dd0cc9ec3 `_ tls: some rework based on TLS openssl C API
+* `be4d1aa2c `_ tls: Add C API for TLS openssl to set engine
+
+``src/plugins/abf/abf.api``
+
+* `bdde58534 `_ abf: use explicit types in api
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `097fa66b9 `_ fib: fib api updates
+
+``src/plugins/nat/nat.api``
+
+* `f126e746f `_ nat: use SVR
+* `e5ff5a36d `_ api: enforce vla is last and fixed string type
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `e6e09a4ac `_ nat: elog rewrite for multi-worker support
+* `c1f93067e `_ Add default value for API Nat flags
+* `dd1e3e780 `_ NAT: VPP-1531 api cleanup & update
+* `89fec713f `_ Revert "NAT: VPP-1531 api cleanup & update"
+* `bed1421b9 `_ NAT: VPP-1531 api cleanup & update
+
+``src/plugins/rdma/rdma.api``
+
+* `d8c1ef925 `_ rdma: api: prepare support for direct verb
+* `b644eb54f `_ rdma: add explicit types in api
+* `812afe712 `_ rdma: add rdma API
+
+``src/plugins/sctp/sctp.api``
+
+* `3ffe6cadf `_ sctp: move to plugins, disabled by default
+
+``src/plugins/ct6/ct6.api``
+
+* `d4efce2e0 `_ ct6: use explicit type in api
+* `ee98904e0 `_ ct6: remove api boilerplate
+
+``src/plugins/nsh/nsh.api``
+
+* `d3f0a4869 `_ nsh: use explicit api types
+
+``src/plugins/flowprobe/flowprobe.api``
+
+* `3013e6988 `_ flowprobe: use explicit types in api
+* `2a1ca787b `_ api: split api generated files
+
+``src/plugins/lacp/lacp.api``
+
+* `ebef4a9e5 `_ lacp: use explit api types
+
+``src/plugins/dns/dns.api``
+
+* `b922f16ba `_ dns: remove api boilerplate
+* `34af0ccf5 `_ dns: make the dns name resolver a plugin
+
+``src/vpp/api/vpe.api``
+
+* `e5ff5a36d `_ api: enforce vla is last and fixed string type
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `a47a5f20a `_ api papi: add alias for timestamp(datetime)/timedelta
+* `888640a39 `_ map gbp papi: match endianess of f64
+* `03f1af23b `_ api: Implement log_dump/log_details
+* `c87b66c86 `_ ipsec: ipsec-tun protect
+* `9ac113815 `_ API: Add support for limits to language.
+
+``src/vpp/api/vpe_types.api``
+
+* `e71748291 `_ vppapigen: remove support for legacy typedefs
+* `a47a5f20a `_ api papi: add alias for timestamp(datetime)/timedelta
+* `3cf9e67f5 `_ api: add vl_api_version_t type
diff --git a/docs/aboutvpp/releasenotes/v20.05.1.rst b/docs/aboutvpp/releasenotes/v20.05.1.rst
new file mode 100644
index 00000000000..7a8f65030cf
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v20.05.1.rst
@@ -0,0 +1,9 @@
+Release notes for VPP 20.05.1
+=============================
+
+This is bug fix release.
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
diff --git a/docs/aboutvpp/releasenotes/v20.05.rst b/docs/aboutvpp/releasenotes/v20.05.rst
new file mode 100644
index 00000000000..a510bf580da
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v20.05.rst
@@ -0,0 +1,848 @@
+Release notes for VPP 20.05
+===========================
+
+More than 751 commits since the 20.01 release.
+
+Release Highlights
+------------------
+
+Feature Highlights
+~~~~~~~~~~~~~~~~~~
+
+As per commits involving FEATURE.yaml edits between the previous release
+and this release. They are mentioned in the below “features” section as
+well, together with the corresponding commits.
+
+-  TAP Drivers
+
+   -  Implement sw_interface_tap_v2_dump filtering by sw_if_index
+   -  Add support for persistence
+
+-  Native Virtio Drivers
+
+   -  Support virtio 1.1 packed ring in vhost
+
+-  gso
+
+   -  Add support for IP-IP
+   -  Add vxlan tunnel support
+
+-  VRRP
+
+   -  Add plugin providing VRRP support
+
+Ongoing Work On More Semantic-Typed API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This release, like the 20.01, continues the journey on defining the
+semantic-based types instead of storage-based types within the API, so
+you may have noticed this in the API changes.
+
+Some of the changes are related to the infrastructure, and may be
+bugfixes, they do not change the CRC of the message but affect the
+representation on the wire. One particular commit we want you to pay
+attention to, is
+`b5c0d35f `__,
+which fixes the bug with the enum representation on the wire - before
+it, even the enums declared as u8 or u16 were represented as u32 in the
+API messages.
+
+Another important commit we would like to call out explicitly as well is
+`7dd63e5c `__,
+which pinned the address_family and ip_proto enum types to be u8 instead
+of the default u32.
+
+The above two commits will be primarily interesting for those who work
+with the low-level APIs on VPP - the API frameworks should make these
+under-the-hood changes transparent. However, we decided to call these
+out, given that for those affected these will be pretty important
+changes.
+
+Another commit, that does not have the immediate impact at the moment,
+but that is poised to improve the user interaction with the API is
+`5c318c70 `__.
+This adds the tooling and ability to implement a structured process, by
+which the API messages can evolve, while minimizing the impact to the
+API users.
+
+Features
+--------
+
+-  Binary API Compiler for Python
+
+   -  Api crc checker (5c318c70d)
+
+-  Binary API Libraries
+
+   -  Add macro that zeros out api reply buffer (f24de1795)
+
+-  Build System
+
+   -  Add snap packaging (experimental) (6d97e62c0)
+   -  Support arch-specific compiling for Neoverse N1 (690ce8672)
+
+-  Crypto native Plugin
+
+   -  Add ARMv8 AES-CBC implementation (776644efe)
+   -  Add AArch64 AES-GCM native implementation (622b5ce61)
+   -  Calculate ghash using vpclmulqdq instructions (627fb6a16)
+   -  GCM implementation with vector AESNI instructions (47d8f5dcd)
+
+-  Infrastructure Library
+
+   -  Add x86 CPU definitions (38e0413b2)
+   -  Numa vector placement support (a690fdbfe)
+   -  Add cmake option to grow vectors by 1 (98bd75778)
+   -  Add tw_timer_2t_2w_512sl variant (907678977)
+
+-  Link Bonding
+
+   -  Add GSO support (2e1fa54b7)
+
+-  Plugins
+
+   -  DPDK
+
+      -  Output switch information (2347278d9)
+      -  Use port_id as interface name suffix for representors
+         (a80f8f371)
+      -  Add iova-mode to startup (4e96ddaec)
+      -  Bump DPDK version to 20.02 (76be887d8)
+      -  Enable DPDK iAVF PMD (162ea767c)
+      -  DPDK 20.05 iavf flow director backporting to DPDK 20.02
+         (7f83738b4)
+
+   -  GTPU
+
+      -  Offload RX flow (00fdf53c7)
+      -  RX offload for IPv6 payload supporting (ed63a0ff7)
+
+   -  Host Stack Applications
+
+      -  Proxy rcv wnd update acks after full fifos (dda2dbeda)
+
+   -  IPv6 Segment Routing Mobile
+
+      -  Support GTP4/6.DT and User Plane message mapping (9e722bd46)
+
+   -  Internet Key Exchange (IKEv2) Protocol
+
+      -  Configure a profile with an existing interface (44476c6b2)
+      -  Responder honours the protected tunnel config (685001f0a)
+      -  Add support for custom ipsec-over-udp port (e5d34919b)
+      -  Dead peer detection (c415d0a8e)
+
+   -  NAT
+
+      -  In2out-output nodes work with acl reflect (d539e256b)
+      -  Api & cli command for forcing session cleanup (edf777272)
+      -  Dslite ce mode in separate config entry (958919f36)
+
+   -  QUIC protocol
+
+      -  Update quicly to v0.0.10-VPP (62b1cea6e)
+      -  Quicly crypto offloading (92de6b65b)
+      -  Check quicly version tag at compile time (ffdc72da4)
+
+   -  RDMA (ibverb) driver
+
+      -  Bunp rdma-core version to v28.0 (eb89b9093)
+      -  Add Mellanox mlx5 Direct Verbs receive support (dd648aac0)
+      -  Introduce direct verb for Cx4/5 tx (dc812d9a7)
+
+   -  Unicast Reverse Path forwarding
+
+      -  Unicast reverse Path Forwarding (plugin) (d724e4f43)
+
+   -  VRRP
+
+      -  Add plugin providing vrrp support (39e9428b9)
+
+-  SVM Library
+
+   -  Numa awareness for ssvm segments (6fe8998fe)
+   -  Support multi-chunk fifo chunk alloc (8e755a16a)
+   -  Chunk alloc stats (d35887297)
+   -  New FIFO design/architecture (f22f4e562)
+   -  Fifo test (64e96613d)
+
+-  Test Infrastructure
+
+   -  Add running_gcov_tests to framework.py (d498c9eb2)
+   -  Implement ipaddress convenience methods (e64e5fff4)
+
+-  VNET
+
+   -  Crypto Infra
+
+      -  Add chained buffer support in ipsecmb (AES-GCM) (2fc409131)
+      -  Add support for testing quad loops in crypto algos (a9075dcf6)
+      -  Introduce async crypto infra (f539578ba)
+
+   -  Ethernet
+
+      -  Configure system default ethernet MTU (5fa452554)
+
+   -  FLOW
+
+      -  Add vlan tagged types for IPv4/IPv6 5-tuple flows (f13830ce7)
+      -  Add RSS support (24e2c50bf)
+      -  Add l2tpv3oip flow (8b43aaaf1)
+
+   -  GRE
+
+      -  Tunnel encap/decap flags (e5b94dded)
+
+   -  GSO
+
+      -  Add vxlan tunnel support (0b04209ed)
+      -  Add support for IP-IP (84f91fa9c)
+
+   -  IP Neighbors
+
+      -  Populate neighbor age via API (9c1928f81)
+      -  Replace feature for the ip-neighbor data-base (c87fbb417)
+      -  Add flush API (240dcb24a)
+
+   -  IPIP
+
+      -  Multi-point interface (14053c9db)
+
+   -  IPSec
+
+      -  Add support for chained buffers (efcad1a9d)
+      -  IPSec protection for multi-point tunnel interfaces (282872127)
+      -  Add input node bypass/discard functionality (0546483ce)
+      -  User can choose the UDP source port (abc5660c6)
+      -  Support 4o6 and 6o4 for SPD tunnel mode SAs (b1fd80f09)
+
+   -  IPv4 LPM
+
+      -  More detailed show reassembly commands (a877cf9f3)
+      -  Replace Sematics for Interface IP addresses (59f71132e)
+
+   -  MPLS
+
+      -  Add user defined name tag to mpls tunnels (39ae0a07a)
+
+   -  Native Virtio Drivers
+
+      -  Support virtio 1.1 packed ring in vhost (bc0d9ff67)
+
+   -  Packet Generator
+
+      -  Set vnet buffer flags in pg streams (08eb2bb20)
+
+   -  Segment Routing (IPv6 and MPLS)
+
+      -  Change the CLI keyword from address to prefix. (b24e287b9)
+      -  Support uSID function. (ec9cb9668)
+
+   -  Session Layer
+
+      -  Tracking segment memory usage (234fe894d)
+      -  Basic fifo-tuning-logic (d8f48e216)
+      -  Api to add new transport types (07063b8ea)
+      -  Support connect on listeners (0a1e183e5)
+      -  Adding debug events (7357043d2)
+      -  Add option to preallocate fifo headers (9845c20d7)
+
+   -  TAP Drivers
+
+      -  Add support for persistance (b49bc1ae6)
+      -  Add initial support for tun (206acf84d)
+      -  Implement sw_interface_tap_v2_dump filtering by sw_if_index
+         (073d74d0b)
+
+   -  TCP
+
+      -  Add option to avoid endpoint cleanup (43818c1e0)
+      -  Minimal set of worker stats (5e6305fb0)
+      -  Allow custom mss on connects (ff19e3bf4)
+
+   -  TLS and TLS engine plugins
+
+      -  Picotls engine symmetric crypto enhancement by VPP crypto
+         framework (3b8518164)
+
+   -  UDP
+
+      -  Track connection port sharing (a039620c2)
+
+-  VPP Comms Library
+
+   -  Udp session migration notifications (68b7e5888)
+   -  Propagate cleanup notifications to apps (9ace36d0f)
+
+-  Vector Library
+
+   -  Add plugin override support (8dc954a4e)
+   -  Calculate per-worker loops/second metric (000a029e4)
+   -  Leave SIGPROF signal with its default handler (6f533d780)
+   -  Add nosyslog unix option (e31820af1)
+
+-  Gomemif
+
+   -  Introduce gomemif (07363a45f)
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Fixed issues
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+======================================== ==================
+Message Name                             Result
+======================================== ==================
+acl_add_replace                          definition changed
+acl_details                              definition changed
+acl_interface_add_del                    definition changed
+acl_interface_etype_whitelist_details    definition changed
+acl_interface_etype_whitelist_dump       definition changed
+acl_interface_list_details               definition changed
+acl_interface_list_dump                  definition changed
+acl_interface_set_acl_list               definition changed
+acl_interface_set_etype_whitelist        definition changed
+add_node_next                            definition changed
+app_attach                               definition changed
+app_attach_reply                         definition changed
+app_cut_through_registration_add         only in file
+app_cut_through_registration_add_reply   only in file
+app_namespace_add_del                    definition changed
+app_worker_add_del                       definition changed
+app_worker_add_del_reply                 definition changed
+application_attach                       only in file
+application_attach_reply                 only in file
+bd_ip_mac_add_del                        definition changed
+bind_sock                                only in file
+bind_sock_reply                          only in file
+bind_uri                                 only in file
+bind_uri_reply                           only in file
+bridge_domain_add_del                    definition changed
+bridge_domain_details                    definition changed
+bridge_domain_dump                       definition changed
+bridge_flags                             definition changed
+bvi_create_reply                         definition changed
+bvi_delete                               definition changed
+connect_sock                             only in file
+connect_sock_reply                       only in file
+connect_uri                              only in file
+connect_uri_reply                        only in file
+create_vhost_user_if                     definition changed
+disconnect_session                       only in file
+disconnect_session_reply                 only in file
+get_next_index                           definition changed
+get_node_index                           definition changed
+gpe_add_del_fwd_entry                    definition changed
+gpe_add_del_iface                        definition changed
+gpe_add_del_native_fwd_rpath             definition changed
+gpe_enable_disable                       definition changed
+gpe_fwd_entries_get_reply                definition changed
+gpe_fwd_entry_path_details               definition changed
+gpe_native_fwd_rpaths_get                definition changed
+gpe_native_fwd_rpaths_get_reply          definition changed
+gpe_set_encap_mode                       definition changed
+gre_tunnel_add_del                       definition changed
+gre_tunnel_details                       definition changed
+gtpu_offload_rx                          only in image
+gtpu_offload_rx_reply                    only in image
+ikev2_profile_set_ipsec_udp_port         only in image
+ikev2_profile_set_ipsec_udp_port_reply   only in image
+ikev2_profile_set_liveness               only in image
+ikev2_profile_set_liveness_reply         only in image
+ikev2_profile_set_udp_encap              only in image
+ikev2_profile_set_udp_encap_reply        only in image
+ikev2_set_local_key                      definition changed
+ikev2_set_tunnel_interface               only in image
+ikev2_set_tunnel_interface_reply         only in image
+ip_neighbor_details                      definition changed
+ip_neighbor_flush                        only in image
+ip_neighbor_flush_reply                  only in image
+ip_neighbor_replace_begin                only in image
+ip_neighbor_replace_begin_reply          only in image
+ip_neighbor_replace_end                  only in image
+ip_neighbor_replace_end_reply            only in image
+ip_route_lookup                          only in image
+ip_route_lookup_reply                    only in image
+ip_source_check_interface_add_del        only in file
+ip_source_check_interface_add_del_reply  only in file
+ipfix_classify_table_add_del             definition changed
+ipfix_classify_table_details             definition changed
+ipip_add_tunnel                          definition changed
+ipip_tunnel_details                      definition changed
+ipsec_backend_details                    definition changed
+ipsec_interface_add_del_spd              definition changed
+ipsec_sa_details                         definition changed
+ipsec_sad_entry_add_del                  definition changed
+ipsec_select_backend                     definition changed
+ipsec_spd_add_del                        definition changed
+ipsec_spd_details                        definition changed
+ipsec_spd_entry_add_del                  definition changed
+ipsec_spd_interface_details              definition changed
+ipsec_tunnel_if_add_del                  definition changed
+ipsec_tunnel_if_add_del_reply            definition changed
+ipsec_tunnel_if_set_sa                   definition changed
+ipsec_tunnel_protect_del                 definition changed
+ipsec_tunnel_protect_details             definition changed
+ipsec_tunnel_protect_update              definition changed
+l2_fib_table_details                     definition changed
+l2_flags                                 definition changed
+l2_interface_efp_filter                  definition changed
+l2_interface_pbb_tag_rewrite             definition changed
+l2_interface_vlan_tag_rewrite            definition changed
+l2_macs_event                            definition changed
+l2_patch_add_del                         definition changed
+l2_xconnect_details                      definition changed
+l2fib_add_del                            definition changed
+l2fib_flush_int                          definition changed
+lisp_add_del_adjacency                   definition changed
+lisp_add_del_local_eid                   definition changed
+lisp_add_del_locator                     definition changed
+lisp_add_del_locator_set                 definition changed
+lisp_add_del_map_request_itr_rlocs       definition changed
+lisp_add_del_map_resolver                definition changed
+lisp_add_del_map_server                  definition changed
+lisp_add_del_remote_mapping              definition changed
+lisp_adjacencies_get_reply               definition changed
+lisp_eid_table_add_del_map               definition changed
+lisp_eid_table_details                   definition changed
+lisp_eid_table_dump                      definition changed
+lisp_eid_table_map_dump                  definition changed
+lisp_enable_disable                      definition changed
+lisp_get_map_request_itr_rlocs_reply     definition changed
+lisp_locator_details                     definition changed
+lisp_locator_dump                        definition changed
+lisp_locator_set_details                 definition changed
+lisp_locator_set_dump                    definition changed
+lisp_map_register_enable_disable         definition changed
+lisp_map_request_mode                    definition changed
+lisp_map_resolver_details                definition changed
+lisp_map_server_details                  definition changed
+lisp_pitr_set_locator_set                definition changed
+lisp_rloc_probe_enable_disable           definition changed
+lisp_use_petr                            definition changed
+lldp_config                              definition changed
+macip_acl_add                            definition changed
+macip_acl_add_replace                    definition changed
+macip_acl_details                        definition changed
+macip_acl_interface_add_del              definition changed
+macip_acl_interface_list_details         definition changed
+macip_acl_interface_list_dump            definition changed
+map_another_segment                      only in file
+map_another_segment_reply                only in file
+modify_vhost_user_if                     definition changed
+mpls_tunnel_add_del                      definition changed
+mpls_tunnel_details                      definition changed
+nat44_del_user                           only in image
+nat44_del_user_reply                     only in image
+nat44_session_cleanup                    only in image
+nat44_session_cleanup_reply              only in image
+nat44_set_session_limit                  only in image
+nat44_set_session_limit_reply            only in image
+nat_show_config_reply                    definition changed
+netmap_create                            only in file
+netmap_create_reply                      only in file
+netmap_delete                            only in file
+netmap_delete_reply                      only in file
+nhrp_details                             only in file
+nhrp_dump                                only in file
+nhrp_entry_add_del                       only in file
+nhrp_entry_add_del_reply                 only in file
+one_add_del_adjacency                    definition changed
+one_add_del_l2_arp_entry                 definition changed
+one_add_del_local_eid                    definition changed
+one_add_del_locator                      definition changed
+one_add_del_locator_set                  definition changed
+one_add_del_map_request_itr_rlocs        definition changed
+one_add_del_map_resolver                 definition changed
+one_add_del_map_server                   definition changed
+one_add_del_ndp_entry                    definition changed
+one_add_del_remote_mapping               definition changed
+one_adjacencies_get_reply                definition changed
+one_eid_table_add_del_map                definition changed
+one_eid_table_details                    definition changed
+one_eid_table_dump                       definition changed
+one_eid_table_map_dump                   definition changed
+one_enable_disable                       definition changed
+one_enable_disable_petr_mode             definition changed
+one_enable_disable_pitr_mode             definition changed
+one_enable_disable_xtr_mode              definition changed
+one_get_map_request_itr_rlocs_reply      definition changed
+one_l2_arp_entries_get_reply             definition changed
+one_locator_details                      definition changed
+one_locator_dump                         definition changed
+one_locator_set_details                  definition changed
+one_locator_set_dump                     definition changed
+one_map_register_enable_disable          definition changed
+one_map_request_mode                     definition changed
+one_map_resolver_details                 definition changed
+one_map_server_details                   definition changed
+one_ndp_entries_get_reply                definition changed
+one_nsh_set_locator_set                  definition changed
+one_pitr_set_locator_set                 definition changed
+one_rloc_probe_enable_disable            definition changed
+one_show_petr_mode_reply                 definition changed
+one_show_pitr_mode_reply                 definition changed
+one_show_xtr_mode_reply                  definition changed
+one_stats_details                        definition changed
+one_stats_enable_disable                 definition changed
+one_use_petr                             definition changed
+pg_capture                               definition changed
+pg_create_interface                      definition changed
+pg_create_interface_reply                definition changed
+pg_enable_disable                        definition changed
+policer_add_del                          definition changed
+policer_details                          definition changed
+policer_dump                             definition changed
+session_enable_disable                   definition changed
+session_rule_add_del                     definition changed
+session_rules_details                    definition changed
+show_lisp_map_register_state_reply       definition changed
+show_lisp_map_request_mode_reply         definition changed
+show_lisp_pitr_reply                     definition changed
+show_lisp_rloc_probe_state_reply         definition changed
+show_lisp_status_reply                   definition changed
+show_lisp_use_petr_reply                 definition changed
+show_one_map_register_state_reply        definition changed
+show_one_map_request_mode_reply          definition changed
+show_one_nsh_mapping_reply               definition changed
+show_one_pitr_reply                      definition changed
+show_one_rloc_probe_state_reply          definition changed
+show_one_stats_enable_disable_reply      definition changed
+show_one_status_reply                    definition changed
+show_one_use_petr_reply                  definition changed
+show_threads_reply                       definition changed
+sr_localsid_add_del                      definition changed
+sr_localsids_details                     definition changed
+sr_mpls_policy_add                       definition changed
+sr_mpls_policy_assign_endpoint_color     definition changed
+sr_mpls_policy_mod                       definition changed
+sr_mpls_steering_add_del                 definition changed
+sr_policies_details                      definition changed
+sr_policy_add                            definition changed
+sr_policy_del                            definition changed
+sr_policy_mod                            definition changed
+sr_set_encap_source                      definition changed
+sr_steering_add_del                      definition changed
+sr_steering_pol_details                  definition changed
+sw_interface_address_replace_begin       only in image
+sw_interface_address_replace_begin_reply only in image
+sw_interface_address_replace_end         only in image
+sw_interface_address_replace_end_reply   only in image
+sw_interface_set_l2_bridge               definition changed
+sw_interface_set_l2_xconnect             definition changed
+sw_interface_set_lldp                    definition changed
+sw_interface_set_vpath                   definition changed
+sw_interface_set_vxlan_bypass            definition changed
+sw_interface_set_vxlan_gpe_bypass        definition changed
+sw_interface_span_details                definition changed
+sw_interface_span_dump                   definition changed
+sw_interface_span_enable_disable         definition changed
+teib_details                             only in image
+teib_dump                                only in image
+teib_entry_add_del                       only in image
+teib_entry_add_del_reply                 only in image
+unbind_sock                              only in file
+unbind_sock_reply                        only in file
+unbind_uri                               only in file
+unbind_uri_reply                         only in file
+unmap_segment                            only in file
+unmap_segment_reply                      only in file
+urpf_update                              only in image
+urpf_update_reply                        only in image
+vrrp_vr_add_del                          only in image
+vrrp_vr_add_del_reply                    only in image
+vrrp_vr_details                          only in image
+vrrp_vr_dump                             only in image
+vrrp_vr_peer_details                     only in image
+vrrp_vr_peer_dump                        only in image
+vrrp_vr_set_peers                        only in image
+vrrp_vr_set_peers_reply                  only in image
+vrrp_vr_start_stop                       only in image
+vrrp_vr_start_stop_reply                 only in image
+vrrp_vr_track_if_add_del                 only in image
+vrrp_vr_track_if_add_del_reply           only in image
+vrrp_vr_track_if_details                 only in image
+vrrp_vr_track_if_dump                    only in image
+vxlan_add_del_tunnel                     definition changed
+vxlan_add_del_tunnel_reply               definition changed
+vxlan_gpe_add_del_tunnel                 definition changed
+vxlan_gpe_add_del_tunnel_reply           definition changed
+vxlan_gpe_tunnel_details                 definition changed
+vxlan_gpe_tunnel_dump                    definition changed
+vxlan_offload_rx                         definition changed
+vxlan_tunnel_details                     definition changed
+vxlan_tunnel_dump                        definition changed
+======================================== ==================
+
+Found 279 api message signature differences
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``extras/deprecated/dpdk-hqos/api/dpdk.api``
+
+* `548d70de6 `_ misc: deprecate dpdk hqos
+
+``extras/deprecated/netmap/netmap.api``
+
+* `7db6ab03d `_ misc: deprecate netmap and ixge drivers
+
+``src/vpp/api/vpe.api``
+
+* `933fcf489 `_ api: API cleanup
+* `7db6ab03d `_ misc: deprecate netmap and ixge drivers
+
+``src/vnet/tunnel/tunnel_types.api``
+
+* `14053c9db `_ ipip: Multi-point interface
+* `59ff918ea `_ tunnel: Common types for IP tunnels
+
+``src/vnet/policer/policer_types.api``
+
+* `cd01fb423 `_ policer: API cleanup
+
+``src/vnet/policer/policer.api``
+
+* `cd01fb423 `_ policer: API cleanup
+
+``src/vnet/lisp-gpe/lisp_gpe.api``
+
+* `58db6e16c `_ lisp: API cleanup
+
+``src/vnet/teib/teib.api``
+
+* `03ce46219 `_ teib: Rename NHRP to TEIB
+
+``src/vnet/ip-neighbor/ip_neighbor.api``
+
+* `240dcb24a `_ ip-neighbor: Add flush API
+* `e64e5fff4 `_ tests: implement ipaddress convenience methods
+* `c87fbb417 `_ ip-neighbor: Replace feature for the ip-neighbor data-base
+* `8e7fdddd3 `_ ip-neighbor: add description to the age parameter
+* `9c1928f81 `_ ip-neighbor: populate neighbor age via API
+
+``src/vnet/session/session.api``
+
+* `6fdd7a5f7 `_ session: improve .api comments slightly
+* `9845c20d7 `_ session: add option to preallocate fifo headers
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+* `256779c85 `_ udp: remove connected udp transport proto
+* `888d9f05e `_ session: remove obsolete apis
+* `07063b8ea `_ session: api to add new transport types
+* `b4e5e50fe `_ session: API cleanup
+* `2de9c0f92 `_ svm: minimal initial fifo
+
+``src/vnet/interface_types.api``
+
+* `c4ae0fffb `_ interface: fix interface_types.api enums
+
+``src/vnet/vxlan/vxlan.api``
+
+* `7c0eb56f4 `_ vxlan: vxlan/vxlan.api API cleanup
+
+``src/vnet/vxlan-gbp/vxlan_gbp.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+
+``src/vnet/gre/gre.api``
+
+* `48ac1c2b2 `_ gre: improve .api descriptions
+* `8ab4e507c `_ gre: add missing .api edits
+* `e5b94dded `_ gre: Tunnel encap/decap flags
+* `59ff918ea `_ tunnel: Common types for IP tunnels
+
+``src/vnet/span/span.api``
+
+* `908965db7 `_ span: API cleanup
+
+``src/vnet/srv6/sr.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+* `0938eba15 `_ sr: srv6 API cleanup
+* `79bfd2725 `_ sr: SRv6 uN behavior
+
+``src/vnet/srv6/sr_types.api``
+
+* `0938eba15 `_ sr: srv6 API cleanup
+
+``src/vnet/pg/pg.api``
+
+* `db86329ab `_ pg: API cleanup
+
+``src/vnet/l2/l2.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+* `145e330f0 `_ l2: API cleanup
+
+``src/vnet/lldp/lldp.api``
+
+* `1c684f9af `_ lldp: API cleanup
+
+``src/vnet/vxlan-gpe/vxlan_gpe.api``
+
+* `1c2002a31 `_ vxlan: vxlan-gpe/vxlan-gpe.cpi API cleanup
+
+``src/vnet/lisp-cp/one.api``
+
+* `58db6e16c `_ lisp: API cleanup
+
+``src/vnet/lisp-cp/lisp_types.api``
+
+* `58db6e16c `_ lisp: API cleanup
+
+``src/vnet/lisp-cp/lisp.api``
+
+* `58db6e16c `_ lisp: API cleanup
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `d88fc0fce `_ tap: refactor existing flags
+* `073d74d0b `_ tap: implement sw_interface_tap_v2_dump filtering by sw_if_index
+* `206acf84d `_ tap: add initial support for tun
+* `b49bc1ae6 `_ tap: add support for persistance
+
+``src/vnet/devices/virtio/vhost_user.api``
+
+* `bc0d9ff67 `_ virtio: support virtio 1.1 packed ring in vhost
+
+``src/vnet/devices/virtio/virtio.api``
+
+* `53f06a014 `_ vlib: move pci api types from vnet/pci to vlib/pci
+
+``src/vnet/ipsec/ipsec_types.api``
+
+* `abc5660c6 `_ ipsec: User can choose the UDP source port
+* `287d5e109 `_ ipsec: API cleanup
+* `5893747d7 `_ api: ipsec: add missing IS_INBOUND flag.
+* `2fcd265d3 `_ ipsec: Revert API cleanup
+* `666ece35c `_ ipsec: API cleanup
+
+``src/vnet/ipsec/ipsec.api``
+
+* `48d32b43c `_ ipsec: provide stat index in sa details
+* `287d5e109 `_ ipsec: API cleanup
+* `2fcd265d3 `_ ipsec: Revert API cleanup
+* `666ece35c `_ ipsec: API cleanup
+* `282872127 `_ ipsec: IPSec protection for multi-point tunnel interfaces
+
+``src/vnet/ethernet/p2p_ethernet.api``
+
+* `bdfe5955f `_ ethernet: add sanity checks to p2p_ethernet_add/del
+
+``src/vnet/bonding/bond.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+
+``src/vnet/mpls/mpls.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+* `39ae0a07a `_ mpls: add user defined name tag to mpls tunnels
+
+``src/vnet/syslog/syslog.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+
+``src/vnet/interface.api``
+
+* `59f71132e `_ ip: Replace Sematics for Interface IP addresses
+
+``src/vnet/ipip/ipip.api``
+
+* `14053c9db `_ ipip: Multi-point interface
+* `59ff918ea `_ tunnel: Common types for IP tunnels
+
+``src/vnet/srmpls/sr_mpls.api``
+
+* `0938eba15 `_ sr: srv6 API cleanup
+* `00ec4019b `_ sr: API cleanup
+
+``src/vnet/ip/ip.api``
+
+* `f5d38e05a `_ api: ip: add IP_ROUTE_LOOKUP API
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+* `d724e4f43 `_ urpf: Unicast reverse Path Forwarding (plugin)
+
+``src/vnet/ip/ip_types.api``
+
+* `164c44f0b `_ ip: Fix the AH/ESP protocol numbers on the API
+* `7dd63e5cc `_ ip: change ip API enums address_family and ip_proto size to u8
+* `3ec09e924 `_ ip: ip_address_t uses ip46_address_t
+
+``src/plugins/map/map.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+
+``src/plugins/ikev2/ikev2.api``
+
+* `933c4ca5a `_ ikev2: fix string in api
+* `59fea5a6a `_ ikev2: make liveness params configurable
+* `8ceb44a89 `_ ikev2: fix typo in .api description
+* `e5d34919b `_ ikev2: add support for custom ipsec-over-udp port
+* `b29d523af `_ ikev2: make UDP encap flag configurable
+* `44476c6b2 `_ ikev2: Configure a profile with an existing interface
+
+``src/plugins/urpf/urpf.api``
+
+* `d724e4f43 `_ urpf: Unicast reverse Path Forwarding (plugin)
+
+``src/plugins/lb/lb.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+
+``src/plugins/gtpu/gtpu.api``
+
+* `00fdf53c7 `_ gtpu: offload RX flow
+
+``src/plugins/acl/acl_types.api``
+
+* `2f8cd9145 `_ acl: API cleanup
+* `492a5d0bd `_ acl: revert acl: api cleanup
+* `aad1ee149 `_ acl: API cleanup
+
+``src/plugins/acl/acl.api``
+
+* `c0e9441e7 `_ tests: move defaults from defaultmapping to .api files
+* `2f8cd9145 `_ acl: API cleanup
+* `492a5d0bd `_ acl: revert acl: api cleanup
+* `aad1ee149 `_ acl: API cleanup
+
+``src/plugins/nat/dslite/dslite.api``
+
+* `2c6639c69 `_ nat: move dslite to separate sub-plugin
+
+``src/plugins/nat/nat.api``
+
+* `6bb080f1e `_ nat: per vrf session limits
+* `61717cc38 `_ nat: use correct data types for memory sizes
+* `98301bd56 `_ nat: user deletion function & extra metrics
+* `edf777272 `_ nat: api & cli command for forcing session cleanup
+* `2c6639c69 `_ nat: move dslite to separate sub-plugin
+
+``src/plugins/vrrp/vrrp.api``
+
+* `3fccd0278 `_ vrrp: do not define _details as autoreply
+* `39e9428b9 `_ vrrp: add plugin providing vrrp support
+
+``src/vlib/pci/pci_types.api``
+
+* `53f06a014 `_ vlib: move pci api types from vnet/pci to vlib/pci
diff --git a/docs/aboutvpp/releasenotes/v20.09.rst b/docs/aboutvpp/releasenotes/v20.09.rst
new file mode 100644
index 00000000000..5a1322310fc
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v20.09.rst
@@ -0,0 +1,714 @@
+Release notes for VPP 20.09
+===========================
+
+More than 458 commits since the previous release, including 266 fixes.
+
+Release Highlights
+------------------
+
+The FD.io VPP 20.09 release added a number of notable new features. In
+plugins, the I/O layer added support for the Linux AF_XDP interface with
+the AF_XDP plugin. New plugins where added supporting both the Wireguard
+security protocol and CNAT destination based address translation, and
+the existing IKEv2 plugin added support for NAT-T. In the cryptography
+layer, support was added for synchronous software crypto engines,
+enabling users to allocate dedicated crypto worker threads. The flow
+layer added support for steering IPSEC ESP/AH flows to worker threads.
+GRO support was added to the packet coalescing library.
+
+This release introduces the new FD.io VPP API change policy to ensure
+backwards-compatibility. The policy will ensure seamless upgrades to new
+versions of FD.io VPP in future, provided no “in-progress” or deprecated
+APIs are in use. Enabling the FD.io community to enjoy the benefits of
+new releases, while minimizing the work involved in staying current.
+
+If you dive into the implementation, you will note that policy in
+action. A number of modified API messages have had their original
+versions maintained to ensure compatibility.
+
+Reflecting the new policy we added two new sections to the release notes
+describing: - Newly deprecated API messages: please note that if you are
+using a deprecated message, they will soon be removed in a subsequent
+release. Collaborate with the feature maintainer on the best approach to
+mitigate. - In-progress API messages: They are work-in-progress, and are
+*not* subject to the policy, and may change or even be removed at any
+time. Please collaborate with the feature maintainer on plans to
+productize the message before using in any product. In-progress APIs
+must eventually become stable or be removed.
+
+Features
+--------
+
+-  VNET
+
+   -  Crypto Infra
+
+      -  Add chacha20-poly1305 algo (61f49aa38)
+      -  Asynchronous crypto engines (2284817ea)
+      -  Add asynchronous crypto APIs (0c936b147)
+      -  Added support for optimized cryptodev API (ef80ad6bf)
+
+   -  FLOW
+
+      -  Added ability to steer IPSec ESP/AH flows to worker threads
+         (d4c3666b9)
+      -  Added the vnet/flow API (d0236f725)
+
+   -  GENEVE
+
+      -  Support geneve interface acting as a bvi (7fc88cf3a)
+
+   -  GSO
+
+      -  Added software GRO support (f382b06fe)
+
+   -  IPSec
+
+      -  Dedicated IPSec interface type (dd4ccf262)
+      -  Deprecate old interface API (e6df80de4)
+
+   -  Interface Common
+
+      -  Support configuring RSS steering queues (c4665093c)
+
+   -  Native Virtio Drivers
+
+      -  Add vhost sw_if_index filter for sw_interface_vhost_user_dump
+         (a0e8d9669)
+      -  Add modern device support (379aac395)
+      -  Add virtio 1.1 api flags (518251bc8)
+
+   -  TAP Drivers
+
+      -  Add gro support (9e2a78564)
+      -  Add virtio 1.1 API flag (50bd16559)
+
+   -  TCP
+
+      -  Track reorder with selective acknowledgments (cc4d6d022)
+
+-  Plugins
+
+   -  AF_XDP driver
+
+      -  New plugin for Linux AF_XDP input (4a76d6f6d)
+
+   -  CNat
+
+      -  New plugin for destination based NAT (29f3c7d2e)
+
+   -  Wireguard
+
+      -  New plugin, initial implementation of wireguard protocol
+         (edca1325c)
+
+   -  Crypto - OpenSSL
+
+      -  Add chacha20-poly1305 support to crypto-openssl (1b6ed022e)
+
+   -  DPDK
+
+      -  Device_id sorted order for cryptodev (5a849e3b3)
+      -  Call the meson-based build instead of Makefiles (73903d7e8)
+
+   -  Internet Key Exchange (IKEv2) Protocol
+
+      -  Add support for NAT traversal (NAT-T) (4362baa33)
+      -  Add profile dump API (6a9bd8188)
+      -  Add support for AES-GCM cipher in IKE (a7b963df2)
+      -  Add SA dump API (a340fe1ac)
+
+   -  Network Delay Simulator
+
+      -  Basic reorder support (e6c3e8f0e)
+
+-  VPP Comms Library
+
+   -  Nest vcl_mq_epfd to support epoll_wait without high CPU usage
+      (4266d4d5f)
+   -  Support connected udp listens (1e96617d9)
+   -  Support inter worker rpc (40c07ce7a)
+   -  Support multi-threads with session migration (a3a489691)
+
+-  Vector Library
+
+   -  Add recursive macro expander to debug cli (961e3c842)
+
+-  Binary API Libraries
+
+   -  Add new stream message convention (f5db3711b)
+   -  Make VPP api handlers endian independent (e796a1873)
+
+-  Infrastructure Library
+
+   -  Multiarch support for OCTEONTX2 SoC (e2f5236dc)
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Fixed issues
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+========================================== ==================
+Message Name                               Result
+========================================== ==================
+adl_allowlist_enable_disable               only in image
+adl_allowlist_enable_disable_reply         only in image
+adl_interface_enable_disable               only in image
+adl_interface_enable_disable_reply         only in image
+bond_add_member                            only in image
+bond_add_member_reply                      only in image
+bond_create2                               only in image
+bond_create2_reply                         only in image
+bond_detach_member                         only in image
+bond_detach_member_reply                   only in image
+cnat_add_del_snat_prefix                   only in image
+cnat_add_del_snat_prefix_reply             only in image
+cnat_session_details                       only in image
+cnat_session_dump                          only in image
+cnat_session_purge                         only in image
+cnat_session_purge_reply                   only in image
+cnat_set_snat_addresses                    only in image
+cnat_set_snat_addresses_reply              only in image
+cnat_translation_del                       only in image
+cnat_translation_del_reply                 only in image
+cnat_translation_details                   only in image
+cnat_translation_dump                      only in image
+cnat_translation_update                    only in image
+cnat_translation_update_reply              only in image
+crypto_set_async_dispatch                  only in image
+crypto_set_async_dispatch_reply            only in image
+crypto_set_handler                         only in image
+crypto_set_handler_reply                   only in image
+crypto_sw_scheduler_set_worker             only in image
+crypto_sw_scheduler_set_worker_reply       only in image
+det44_add_del_map                          only in image
+det44_add_del_map_reply                    only in image
+det44_close_session_in                     only in image
+det44_close_session_in_reply               only in image
+det44_close_session_out                    only in image
+det44_close_session_out_reply              only in image
+det44_forward                              only in image
+det44_forward_reply                        only in image
+det44_get_timeouts                         only in image
+det44_get_timeouts_reply                   only in image
+det44_interface_add_del_feature            only in image
+det44_interface_add_del_feature_reply      only in image
+det44_interface_details                    only in image
+det44_interface_dump                       only in image
+det44_map_details                          only in image
+det44_map_dump                             only in image
+det44_plugin_enable_disable                only in image
+det44_plugin_enable_disable_reply          only in image
+det44_reverse                              only in image
+det44_reverse_reply                        only in image
+det44_session_details                      only in image
+det44_session_dump                         only in image
+det44_set_timeouts                         only in image
+det44_set_timeouts_reply                   only in image
+flow_add                                   only in image
+flow_add_reply                             only in image
+flow_del                                   only in image
+flow_del_reply                             only in image
+flow_disable                               only in image
+flow_disable_reply                         only in image
+flow_enable                                only in image
+flow_enable_reply                          only in image
+geneve_add_del_tunnel2                     only in image
+geneve_add_del_tunnel2_reply               only in image
+gtpu_add_del_tunnel                        definition changed
+gtpu_tunnel_details                        definition changed
+gtpu_tunnel_update_tteid                   only in image
+gtpu_tunnel_update_tteid_reply             only in image
+ikev2_child_sa_details                     only in image
+ikev2_child_sa_dump                        only in image
+ikev2_nonce_get                            only in image
+ikev2_nonce_get_reply                      only in image
+ikev2_profile_details                      only in image
+ikev2_profile_dump                         only in image
+ikev2_profile_set_ts                       definition changed
+ikev2_sa_details                           only in image
+ikev2_sa_dump                              only in image
+ikev2_set_esp_transforms                   definition changed
+ikev2_set_ike_transforms                   definition changed
+ikev2_set_responder                        definition changed
+ikev2_traffic_selector_details             only in image
+ikev2_traffic_selector_dump                only in image
+ipsec_itf_create                           only in image
+ipsec_itf_create_reply                     only in image
+ipsec_itf_delete                           only in image
+ipsec_itf_delete_reply                     only in image
+ipsec_itf_details                          only in image
+ipsec_itf_dump                             only in image
+ipsec_set_async_mode                       only in image
+ipsec_set_async_mode_reply                 only in image
+map_domains_get                            only in image
+map_domains_get_reply                      only in image
+nat44_add_del_static_mapping_v2            only in image
+nat44_add_del_static_mapping_v2_reply      only in image
+nat_show_config_2                          only in image
+nat_show_config_2_reply                    only in image
+nsim_configure2                            only in image
+nsim_configure2_reply                      only in image
+pg_interface_enable_disable_coalesce       only in image
+pg_interface_enable_disable_coalesce_reply only in image
+sr_policies_with_sl_index_details          only in image
+sr_policies_with_sl_index_dump             only in image
+sw_bond_interface_details                  only in image
+sw_bond_interface_dump                     only in image
+sw_member_interface_details                only in image
+sw_member_interface_dump                   only in image
+trace_details                              only in image
+trace_dump                                 only in image
+trace_dump_reply                           only in image
+virtio_pci_create_v2                       only in image
+virtio_pci_create_v2_reply                 only in image
+wireguard_interface_create                 only in image
+wireguard_interface_create_reply           only in image
+wireguard_interface_delete                 only in image
+wireguard_interface_delete_reply           only in image
+wireguard_interface_details                only in image
+wireguard_interface_dump                   only in image
+wireguard_peer_add                         only in image
+wireguard_peer_add_reply                   only in image
+wireguard_peer_remove                      only in image
+wireguard_peer_remove_reply                only in image
+wireguard_peers_details                    only in image
+wireguard_peers_dump                       only in image
+========================================== ==================
+
+Found 123 api message signature differences
+
+Newly deprecated API messages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These messages are still there in the API, but can and probably will
+disappear in the next release.
+
+-  bond_create
+-  bond_detach_slave
+-  bond_detach_slave_reply
+-  bond_enslave
+-  cop_interface_enable_disable
+-  cop_interface_enable_disable_reply
+-  cop_whitelist_enable_disable
+-  cop_whitelist_enable_disable_reply
+-  geneve_add_del_tunnel
+-  ipsec_tunnel_if_add_del
+-  ipsec_tunnel_if_set_sa
+-  ipsec_tunnel_if_set_sa_reply
+-  map_domain_dump
+-  nat_det_add_del_map
+-  nat_det_add_del_map_reply
+-  nat_det_close_session_in
+-  nat_det_close_session_in_reply
+-  nat_det_close_session_out
+-  nat_det_close_session_out_reply
+-  nat_det_forward
+-  nat_det_forward_reply
+-  nat_det_map_details
+-  nat_det_map_dump
+-  nat_det_reverse
+-  nat_det_reverse_reply
+-  nat_det_session_details
+-  nat_det_session_dump
+-  nat_show_config
+-  nsim_configure
+-  nsim_configure_reply
+-  sw_interface_bond_dump
+-  sw_interface_slave_dump
+-  virtio_pci_create
+-  virtio_pci_create_reply
+
+In-progress API messages
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+These messages are provided for testing and experimentation only. They
+are *not* subject to any compatibility process, and therefore can
+arbitrarily change or disappear at *any* moment. Also they may have less
+than satisfactory testing, making them unsuitable for other use than the
+technology preview. If you are intending to use these messages in
+production projects, please collaborate with the feature maintainer on
+their productization.
+
+-  abf_itf_attach_add_del
+-  abf_itf_attach_add_del_reply
+-  abf_itf_attach_details
+-  abf_itf_attach_dump
+-  abf_plugin_get_version
+-  abf_plugin_get_version_reply
+-  abf_policy_add_del
+-  abf_policy_add_del_reply
+-  abf_policy_details
+-  abf_policy_dump
+-  adl_allowlist_enable_disable
+-  adl_allowlist_enable_disable_reply
+-  adl_interface_enable_disable
+-  adl_interface_enable_disable_reply
+-  af_xdp_create
+-  af_xdp_create_reply
+-  af_xdp_delete
+-  af_xdp_delete_reply
+-  cnat_add_del_snat_prefix
+-  cnat_add_del_snat_prefix_reply
+-  cnat_session_details
+-  cnat_session_dump
+-  cnat_session_purge
+-  cnat_session_purge_reply
+-  cnat_set_snat_addresses
+-  cnat_set_snat_addresses_reply
+-  cnat_translation_del
+-  cnat_translation_del_reply
+-  cnat_translation_details
+-  cnat_translation_dump
+-  cnat_translation_update
+-  cnat_translation_update_reply
+-  crypto_sw_scheduler_set_worker
+-  crypto_sw_scheduler_set_worker_reply
+-  det44_get_timeouts_reply
+-  det44_interface_add_del_feature
+-  det44_interface_add_del_feature_reply
+-  det44_interface_details
+-  det44_interface_dump
+-  det44_plugin_enable_disable
+-  det44_plugin_enable_disable_reply
+-  det44_set_timeouts
+-  det44_set_timeouts_reply
+-  flow_add
+-  flow_add_reply
+-  flow_del
+-  flow_del_reply
+-  flow_disable
+-  flow_disable_reply
+-  flow_enable
+-  flow_enable_reply
+-  gbp_bridge_domain_add
+-  gbp_bridge_domain_add_reply
+-  gbp_bridge_domain_del
+-  gbp_bridge_domain_del_reply
+-  gbp_bridge_domain_details
+-  gbp_bridge_domain_dump
+-  gbp_bridge_domain_dump_reply
+-  gbp_contract_add_del
+-  gbp_contract_add_del_reply
+-  gbp_contract_details
+-  gbp_contract_dump
+-  gbp_endpoint_add
+-  gbp_endpoint_add_reply
+-  gbp_endpoint_del
+-  gbp_endpoint_del_reply
+-  gbp_endpoint_details
+-  gbp_endpoint_dump
+-  gbp_endpoint_group_add
+-  gbp_endpoint_group_add_reply
+-  gbp_endpoint_group_del
+-  gbp_endpoint_group_del_reply
+-  gbp_endpoint_group_details
+-  gbp_endpoint_group_dump
+-  gbp_ext_itf_add_del
+-  gbp_ext_itf_add_del_reply
+-  gbp_ext_itf_details
+-  gbp_ext_itf_dump
+-  gbp_recirc_add_del
+-  gbp_recirc_add_del_reply
+-  gbp_recirc_details
+-  gbp_recirc_dump
+-  gbp_route_domain_add
+-  gbp_route_domain_add_reply
+-  gbp_route_domain_del
+-  gbp_route_domain_del_reply
+-  gbp_route_domain_details
+-  gbp_route_domain_dump
+-  gbp_route_domain_dump_reply
+-  gbp_subnet_add_del
+-  gbp_subnet_add_del_reply
+-  gbp_subnet_details
+-  gbp_subnet_dump
+-  gbp_vxlan_tunnel_add
+-  gbp_vxlan_tunnel_add_reply
+-  gbp_vxlan_tunnel_del
+-  gbp_vxlan_tunnel_del_reply
+-  gbp_vxlan_tunnel_details
+-  gbp_vxlan_tunnel_dump
+-  ikev2_child_sa_details
+-  ikev2_child_sa_dump
+-  ikev2_initiate_del_child_sa
+-  ikev2_initiate_del_child_sa_reply
+-  ikev2_initiate_del_ike_sa
+-  ikev2_initiate_del_ike_sa_reply
+-  ikev2_initiate_rekey_child_sa
+-  ikev2_initiate_rekey_child_sa_reply
+-  ikev2_initiate_sa_init
+-  ikev2_initiate_sa_init_reply
+-  ikev2_nonce_get
+-  ikev2_nonce_get_reply
+-  ikev2_profile_add_del
+-  ikev2_profile_add_del_reply
+-  ikev2_profile_details
+-  ikev2_profile_dump
+-  ikev2_profile_set_auth
+-  ikev2_profile_set_auth_reply
+-  ikev2_profile_set_id
+-  ikev2_profile_set_id_reply
+-  ikev2_profile_set_ipsec_udp_port
+-  ikev2_profile_set_ipsec_udp_port_reply
+-  ikev2_profile_set_liveness
+-  ikev2_profile_set_liveness_reply
+-  ikev2_profile_set_ts
+-  ikev2_profile_set_ts_reply
+-  ikev2_profile_set_udp_encap
+-  ikev2_profile_set_udp_encap_reply
+-  ikev2_sa_details
+-  ikev2_sa_dump
+-  ikev2_set_esp_transforms
+-  ikev2_set_esp_transforms_reply
+-  ikev2_set_ike_transforms
+-  ikev2_set_ike_transforms_reply
+-  ikev2_set_local_key
+-  ikev2_set_local_key_reply
+-  ikev2_set_responder
+-  ikev2_set_responder_reply
+-  ikev2_set_sa_lifetime
+-  ikev2_set_sa_lifetime_reply
+-  ikev2_set_tunnel_interface
+-  ikev2_set_tunnel_interface_reply
+-  ikev2_traffic_selector_details
+-  ikev2_traffic_selector_dump
+-  l2_emulation
+-  l2_emulation_reply
+-  mdata_enable_disable
+-  mdata_enable_disable_reply
+-  nat44_add_del_static_mapping_v2
+-  nat44_add_del_static_mapping_v2_reply
+-  oddbuf_enable_disable
+-  oddbuf_enable_disable_reply
+-  pg_interface_enable_disable_coalesce
+-  pg_interface_enable_disable_coalesce_reply
+-  sample_macswap_enable_disable
+-  sample_macswap_enable_disable_reply
+-  sr_policies_with_sl_index_details
+-  sr_policies_with_sl_index_dump
+-  sw_interface_set_vxlan_gbp_bypass
+-  sw_interface_set_vxlan_gbp_bypass_reply
+-  trace_details
+-  trace_dump
+-  trace_dump_reply
+-  vxlan_gbp_tunnel_add_del
+-  vxlan_gbp_tunnel_add_del_reply
+-  vxlan_gbp_tunnel_details
+-  vxlan_gbp_tunnel_dump
+-  wireguard_interface_create
+-  wireguard_interface_create_reply
+-  wireguard_interface_delete
+-  wireguard_interface_delete_reply
+-  wireguard_interface_details
+-  wireguard_interface_dump
+-  wireguard_peer_add
+-  wireguard_peer_add_reply
+-  wireguard_peer_remove
+-  wireguard_peer_remove_reply
+-  wireguard_peers_details
+-  wireguard_peers_dump
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``src/vpp/api/vpe.api``
+
+* `d0236f725 `_ flow: add vnet/flow formal API
+
+``src/vnet/crypto/crypto.api``
+
+* `4035daffd `_ crypto: Crypto set handler API to support set all as CLI
+* `0c936b147 `_ crypto: Add async crypto APIs
+
+``src/vnet/cop/cop.api``
+
+* `00f21fb2f `_ api: clean up use of deprecated flag
+* `ac0326fc5 `_ adl: move allow/deny list function to plugin
+
+``src/vnet/lisp-gpe/lisp_gpe.api``
+
+* `4ab5190eb `_ lisp: API cleanup
+
+``src/vnet/vxlan-gbp/vxlan_gbp.api``
+
+* `f72b1aff7 `_ vxlan-gbp: Mark APIs as in-progress
+
+``src/vnet/flow/flow_types.api``
+
+* `34bfa50b6 `_ flow: code refactor
+* `d0236f725 `_ flow: add vnet/flow formal API
+
+``src/vnet/flow/flow.api``
+
+* `d0236f725 `_ flow: add vnet/flow formal API
+
+``src/vnet/srv6/sr.api``
+
+* `30fa97dc6 `_ sr: new messages created to return sl index for segment lists in a sr policy
+
+``src/vnet/pg/pg.api``
+
+* `f382b06fe `_ gso: packet coalesce library
+* `0cf528233 `_ gso: fix the udp checksum in test
+
+``src/vnet/geneve/geneve.api``
+
+* `00f21fb2f `_ api: clean up use of deprecated flag
+* `7fc88cf3a `_ geneve: support geneve interface acting as a bvi
+
+``src/vnet/lisp-cp/one.api``
+
+* `4ab5190eb `_ lisp: API cleanup
+
+``src/vnet/lisp-cp/lisp.api``
+
+* `4ab5190eb `_ lisp: API cleanup
+
+``src/vnet/devices/tap/tapv2.api``
+
+* `50bd16559 `_ tap: add virtio 1.1 API flag
+
+``src/vnet/devices/virtio/vhost_user.api``
+
+* `a0e8d9669 `_ virtio: add vhost sw_if_index filter for sw_interface_vhost_user_dump
+
+``src/vnet/devices/virtio/virtio.api``
+
+* `00f21fb2f `_ api: clean up use of deprecated flag
+* `518251bc8 `_ virtio: add virtio 1.1 api flags
+
+``src/vnet/ipsec/ipsec.api``
+
+* `00f21fb2f `_ api: clean up use of deprecated flag
+* `2e84d6655 `_ ipsec: add ipsec set async mode api
+* `e6df80de4 `_ ipsec: Deprecate old interface API
+* `dd4ccf262 `_ ipsec: Dedicated IPSec interface type
+
+``src/vnet/bonding/bond.api``
+
+* `ea7178631 `_ bonding: add bond_create2 API to include gso option
+* `4c4223edf `_ bonding lacp: replace slave string with member
+
+``src/vnet/ip/ip_types.api``
+
+* `d0236f725 `_ flow: add vnet/flow formal API
+
+``src/plugins/wireguard/wireguard.api``
+
+* `edca1325c `_ wireguard: initial implementation of wireguard protocol
+
+``src/plugins/map/map.api``
+
+* `00f21fb2f `_ api: clean up use of deprecated flag
+* `ac0326fc5 `_ adl: move allow/deny list function to plugin
+* `f5db3711b `_ api: add new stream message convention
+
+``src/plugins/lacp/lacp.api``
+
+* `4c4223edf `_ bonding lacp: replace slave string with member
+
+``src/plugins/l2e/l2e.api``
+
+* `f733e7ade `_ l2e: mark API as in-progress
+
+``src/plugins/ikev2/ikev2.api``
+
+* `a340fe1ac `_ ikev2: add SA dump API
+* `459d17bb7 `_ ikev2: refactor and test profile dump API
+* `ac46e3b1d `_ ikev2: API downgrade due to lack of ikev2 tests
+* `6a9bd8188 `_ ikev2: add profile dump API
+
+``src/plugins/ikev2/ikev2_types.api``
+
+* `a340fe1ac `_ ikev2: add SA dump API
+* `459d17bb7 `_ ikev2: refactor and test profile dump API
+* `6a9bd8188 `_ ikev2: add profile dump API
+
+``src/plugins/tracedump/tracedump.api``
+
+* `65b65a469 `_ misc: add tracedump API plugin
+
+``src/plugins/gtpu/gtpu.api``
+
+* `9ebbb5c41 `_ gtpu: support separate rx-decap and encap-tx teid values
+
+``src/plugins/gbp/gbp.api``
+
+* `d2f8fb9c7 `_ gbp: mark APIs as in-progress
+
+``src/plugins/acl/acl.api``
+
+* `24ee40a5c `_ acl: correct acl vat help message
+
+``src/plugins/nat/dslite/dslite.api``
+
+* `603e75465 `_ nat: move deterministic nat to det44 sub feature
+
+``src/plugins/nat/det44/det44.api``
+
+* `00f21fb2f `_ api: clean up use of deprecated flag
+* `603e75465 `_ nat: move deterministic nat to det44 sub feature
+
+``src/plugins/nat/nat_types.api``
+
+* `96068d6b9 `_ nat: nat66 to plugin
+
+``src/plugins/nat/nat.api``
+
+* `6484f4b9c `_ nat: twice-nat static mapping pool address
+* `edc816355 `_ nat: fix type in api message
+* `603e75465 `_ nat: move deterministic nat to det44 sub feature
+* `96068d6b9 `_ nat: nat66 to plugin
+
+``src/plugins/nat/nat66/nat66.api``
+
+* `96068d6b9 `_ nat: nat66 to plugin
+
+``src/plugins/cnat/cnat.api``
+
+* `29f3c7d2e `_ cnat: Destination based NAT
+
+``src/plugins/abf/abf.api``
+
+* `df494dafa `_ abf: mark API as in-progress
+
+``src/plugins/adl/adl.api``
+
+* `ac0326fc5 `_ adl: move allow/deny list function to plugin
+
+``src/plugins/nsim/nsim.api``
+
+* `00f21fb2f `_ api: clean up use of deprecated flag
+* `e6c3e8f0e `_ nsim: basic reorder support
+
+``src/plugins/crypto_sw_scheduler/crypto_sw_scheduler.api``
+
+* `0c936b147 `_ crypto: Add async crypto APIs
+
+``src/plugins/dhcp/dhcp.api``
+
+* `bad679291 `_ api: register endian handlers for reply messages
+
+``src/plugins/af_xdp/af_xdp.api``
+
+* `4a76d6f6d `_ af_xdp: AF_XDP input plugin
diff --git a/docs/aboutvpp/releasenotes/v21.01.rst b/docs/aboutvpp/releasenotes/v21.01.rst
new file mode 100644
index 00000000000..e0070b712db
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v21.01.rst
@@ -0,0 +1,764 @@
+Release notes for VPP 21.01
+===========================
+
+Release Highlights
+------------------
+
+The FD.io VPP 20.09 release comprises more than 562 commits since the
+previous release, including 274 fixes. Notable changes in this release
+were the Virtio driver adding packet buffering on the transmit path to
+handle slow back-ends which often have jitter and delays in free’ing
+buffers, and also adding support for Virtio 1.1 packed rings. FD.io VPP
+IPSEC added support for multi-point on IPSec interfaces, brings the
+meshed benefits of IP to IPSec tunnels. The FD.io VPP Cloud NAT (CNAT),
+added support source NAT ICMP and DHCP. The FD.io VPP FIB added support
+for source address selection (SAS) and flow hashing on the inner
+packets. Finally the FD.io VPP Perfmon plugin has been substantially
+rewritten, to support measuring bundles of counters, and reporting
+statistics per graph node.
+
+Reflecting the API change policy introduced in the 20.09, please review
+the following sections below: - Newly deprecated API messages: please
+note that if you are using a deprecated message, they will soon be
+removed in a subsequent release. Collaborate with the feature maintainer
+on the best approach to mitigate. - In-progress API messages: They are
+work-in-progress, and are *not* subject to the policy, and may change or
+even be removed at any time. Please collaborate with the feature
+maintainer on plans to productize the message before using in any
+product. In-progress APIs must eventually become stable or be removed.
+
+Features
+--------
+
+-  Binary API Libraries
+
+   -  Vat2 and JSON autogeneration for API messages
+      (`df87f8092 `__)
+
+-  Plugins
+
+   -  AF_XDP driver
+
+      -  Add option to claim all available RX queues
+         (`d4e109138 `__)
+
+   -  CNat
+
+      -  Disable default scanner process
+         (`d63f73b83 `__)
+      -  IP ICMP error support
+         (`ece39214b `__)
+      -  Add support for SNat ICMP
+         (`613b2c3c7 `__)
+      -  Introduce parametric source policy
+         (`ce25b60de `__)
+      -  Add DHCP support
+         (`af897c5e3 `__)
+
+   -  Crypto - ipsecmb
+
+      -  Bump to intel-ipsec-mb version 0.55
+         (`b5df85e24 `__)
+
+   -  DPDK
+
+      -  Call the meson-based build instead of Makefiles
+         (`4c4633cad `__)
+      -  Telemetry thread is off by default.
+         (`83f37fc3b `__)
+      -  Bump to DPDK 20.11
+         (`f0419a0c8 `__)
+
+   -  Internet Key Exchange (IKEv2) Protocol
+
+      -  Support IPv6 traffic selectors & overlay
+         (`84962d19b `__)
+      -  CLI for disabling dead peer detection
+         (`af4a414eb `__)
+      -  Add option to disable NAT traversal
+         (`d7fc12f07 `__)
+
+   -  RDMA (ibverb) driver
+
+      -  Add RSS support for IPv6 and TCP
+         (`91603958d `__)
+
+   -  VRRP
+
+      -  Asynchronous events on VR state change
+         (`78f487e11 `__)
+
+   -  Wireguard
+
+      -  Return public key in API
+         (`de22111b5 `__)
+
+   -  Flowprobe
+
+      -  Add show commands for params and list of interfaces for
+         recording
+         (`d1146f6dd `__)
+
+-  Python binding for the VPP API
+
+   -  add support for enumflag part 1 of 2
+      (`3825d93af `__)
+
+-  SVM Library
+
+   -  Support for multi-segment enqueues
+      (`c95cfa218 `__)
+
+-  Statistics Segment
+
+   -  Counters data model
+      (`148c7b768 `__)
+
+-  VNET
+
+   -  FIB
+
+      -  Source Address Selection
+         (`e2fe09742 `__)
+      -  Adjacency flag for midchain to perfom flow hash (on inner
+         packet)
+         (`5c544c8c3 `__)
+
+   -  Feature Arcs
+
+      -  Add packet trace API
+         (`c0b195450 `__)
+
+   -  IPSec
+
+      -  Support for multipoint on IPSec interfaces
+         (`6ba4e41d3 `__)
+      -  Tunnel SA DSCP behaviour
+         (`041add7d1 `__)
+
+   -  Native Virtio Drivers
+
+      -  Add packet buffering on transmit path
+         (`e347acbc3 `__)
+      -  Virtio: implement packed queues from virtio 1.1
+         (`b977d3f7c `__)
+
+   -  Segment Routing (IPv6 and MPLS)
+
+      -  Show IPv6 address used as SRv6 Encaps source
+         (`448bc81d3 `__)
+      -  Show the hop-limit value used for SRv6 encapsulation
+         (`80f0b88fc `__)
+
+   -  Session Layer
+
+      -  Add Unix socket API for app attachment
+         (`61ae056bd `__)
+      -  Per worker state for ct sessions
+         (`2d0e3de14 `__)
+
+   -  TAP Drivers
+
+      -  Allow change of carrier state on host
+         (`bd50ed18d `__)
+      -  Add function to set speed
+         (`a6c34a19d `__)
+
+-  VPP Comms Library
+
+   -  Add support for app socket API
+      (`935ce75cb `__)
+   -  Provide apps access to fifo chunks
+      (`d68faf855 `__)
+
+-  VPP Executable
+
+   -  Use VPP heap for libc
+      (`ec4749a20 `__)
+
+-  Vector Library - Buffer Management
+
+   -  Add page-size config
+      (`61559029d `__)
+
+Known issues
+------------
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Fixed issues
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+
+================================= ==================
+Message Name                      Result
+================================= ==================
+classify_pcap_get_tables          only in image
+classify_pcap_get_tables_reply    only in image
+classify_pcap_lookup_table        only in image
+classify_pcap_lookup_table_reply  only in image
+classify_pcap_set_table           only in image
+classify_pcap_set_table_reply     only in image
+classify_trace_get_tables         only in image
+classify_trace_get_tables_reply   only in image
+classify_trace_lookup_table       only in image
+classify_trace_lookup_table_reply only in image
+classify_trace_set_table          only in image
+classify_trace_set_table_reply    only in image
+cnat_get_snat_addresses           only in image
+cnat_get_snat_addresses_reply     only in image
+cnat_session_details              definition changed
+cnat_set_snat_addresses           definition changed
+cnat_translation_details          definition changed
+cnat_translation_update           definition changed
+det44_plugin_enable_disable       definition changed
+graph_node_details                only in image
+graph_node_get                    only in image
+graph_node_get_reply              only in image
+ikev2_profile_details             definition changed
+ikev2_profile_disable_natt        only in image
+ikev2_profile_disable_natt_reply  only in image
+ikev2_profile_set_ts              definition changed
+ikev2_sa_details                  definition changed
+ikev2_set_responder               definition changed
+ikev2_traffic_selector_details    definition changed
+ip_mroute_add_del                 definition changed
+ip_mroute_details                 definition changed
+ip_neighbor_event_v2              only in image
+ipsec_sa_v2_details               only in image
+ipsec_sa_v2_dump                  only in image
+ipsec_sad_entry_add_del_v2        only in image
+ipsec_sad_entry_add_del_v2_reply  only in image
+nat44_plugin_enable_disable       only in image
+nat44_plugin_enable_disable_reply only in image
+nat44_show_running_config         only in image
+nat44_show_running_config_reply   only in image
+nat64_get_timeouts                only in image
+nat64_get_timeouts_reply          only in image
+nat64_plugin_enable_disable       only in image
+nat64_plugin_enable_disable_reply only in image
+nat64_set_timeouts                only in image
+nat64_set_timeouts_reply          only in image
+pppoe_add_del_cp                  only in image
+pppoe_add_del_cp_reply            only in image
+rdma_create_v2                    only in image
+rdma_create_v2_reply              only in image
+sw_vmxnet3_interface_details      only in image
+sw_vmxnet3_interface_dump         only in image
+trace_capture_packets             only in image
+trace_capture_packets_reply       only in image
+trace_clear_capture               only in image
+trace_clear_capture_reply         only in image
+trace_details                     definition changed
+trace_set_filters                 only in image
+trace_set_filters_reply           only in image
+vrrp_vr_event                     only in image
+want_ip_neighbor_events_v2        only in image
+want_ip_neighbor_events_v2_reply  only in image
+want_vrrp_vr_events               only in image
+want_vrrp_vr_events_reply         only in image
+wireguard_interface_create        definition changed
+wireguard_interface_details       definition changed
+================================= ==================
+
+Found 66 api message signature differences
+
+Newly deprecated API messages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These messages are still there in the API, but can and probably will
+disappear in the next release.
+
+-  geneve_add_del_tunnel
+-  ip_neighbor_event
+-  nat44_forwarding_enable_disable
+-  nat44_forwarding_enable_disable_reply
+-  nat44_forwarding_is_enabled
+-  nat44_forwarding_is_enabled_reply
+-  nat44_session_cleanup
+-  nat44_session_cleanup_reply
+-  nat_control_ping
+-  nat_control_ping_reply
+-  nat_get_timeouts
+-  nat_get_timeouts_reply
+-  nat_ipfix_enable_disable
+-  nat_ipfix_enable_disable_reply
+-  nat_set_log_level
+-  nat_set_log_level_reply
+-  nat_set_timeouts
+-  nat_set_timeouts_reply
+-  nat_show_config
+-  nat_show_config_2
+-  nat_show_config_2_reply
+-  nat_show_config_reply
+-  rdma_create
+-  vmxnet3_dump
+-  want_ip_neighbor_events
+-  want_ip_neighbor_events_reply
+
+In-progress API messages
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+These messages are provided for testing and experimentation only. They
+are *not* subject to any compatibility process, and therefore can
+arbitrarily change or disappear at *any* moment. Also they may have less
+than satisfactory testing, making them unsuitable for other use than the
+technology preview. If you are intending to use these messages in
+production projects, please collaborate with the feature maintainer on
+their productization.
+
+-  abf_itf_attach_add_del
+-  abf_itf_attach_add_del_reply
+-  abf_itf_attach_details
+-  abf_itf_attach_dump
+-  abf_plugin_get_version
+-  abf_plugin_get_version_reply
+-  abf_policy_add_del
+-  abf_policy_add_del_reply
+-  abf_policy_details
+-  abf_policy_dump
+-  adl_allowlist_enable_disable
+-  adl_allowlist_enable_disable_reply
+-  adl_interface_enable_disable
+-  adl_interface_enable_disable_reply
+-  af_xdp_create
+-  af_xdp_create_reply
+-  af_xdp_delete
+-  af_xdp_delete_reply
+-  cnat_add_del_snat_prefix
+-  cnat_add_del_snat_prefix_reply
+-  cnat_get_snat_addresses
+-  cnat_get_snat_addresses_reply
+-  cnat_session_details
+-  cnat_session_dump
+-  cnat_session_purge
+-  cnat_session_purge_reply
+-  cnat_set_snat_addresses
+-  cnat_set_snat_addresses_reply
+-  cnat_translation_del
+-  cnat_translation_del_reply
+-  cnat_translation_details
+-  cnat_translation_dump
+-  cnat_translation_update
+-  cnat_translation_update_reply
+-  crypto_sw_scheduler_set_worker
+-  crypto_sw_scheduler_set_worker_reply
+-  det44_get_timeouts_reply
+-  det44_interface_add_del_feature
+-  det44_interface_add_del_feature_reply
+-  det44_interface_details
+-  det44_interface_dump
+-  det44_plugin_enable_disable
+-  det44_plugin_enable_disable_reply
+-  det44_set_timeouts
+-  det44_set_timeouts_reply
+-  flow_add
+-  flow_add_reply
+-  flow_del
+-  flow_del_reply
+-  flow_disable
+-  flow_disable_reply
+-  flow_enable
+-  flow_enable_reply
+-  gbp_bridge_domain_add
+-  gbp_bridge_domain_add_reply
+-  gbp_bridge_domain_del
+-  gbp_bridge_domain_del_reply
+-  gbp_bridge_domain_details
+-  gbp_bridge_domain_dump
+-  gbp_bridge_domain_dump_reply
+-  gbp_contract_add_del
+-  gbp_contract_add_del_reply
+-  gbp_contract_details
+-  gbp_contract_dump
+-  gbp_endpoint_add
+-  gbp_endpoint_add_reply
+-  gbp_endpoint_del
+-  gbp_endpoint_del_reply
+-  gbp_endpoint_details
+-  gbp_endpoint_dump
+-  gbp_endpoint_group_add
+-  gbp_endpoint_group_add_reply
+-  gbp_endpoint_group_del
+-  gbp_endpoint_group_del_reply
+-  gbp_endpoint_group_details
+-  gbp_endpoint_group_dump
+-  gbp_ext_itf_add_del
+-  gbp_ext_itf_add_del_reply
+-  gbp_ext_itf_details
+-  gbp_ext_itf_dump
+-  gbp_recirc_add_del
+-  gbp_recirc_add_del_reply
+-  gbp_recirc_details
+-  gbp_recirc_dump
+-  gbp_route_domain_add
+-  gbp_route_domain_add_reply
+-  gbp_route_domain_del
+-  gbp_route_domain_del_reply
+-  gbp_route_domain_details
+-  gbp_route_domain_dump
+-  gbp_route_domain_dump_reply
+-  gbp_subnet_add_del
+-  gbp_subnet_add_del_reply
+-  gbp_subnet_details
+-  gbp_subnet_dump
+-  gbp_vxlan_tunnel_add
+-  gbp_vxlan_tunnel_add_reply
+-  gbp_vxlan_tunnel_del
+-  gbp_vxlan_tunnel_del_reply
+-  gbp_vxlan_tunnel_details
+-  gbp_vxlan_tunnel_dump
+-  ikev2_child_sa_details
+-  ikev2_child_sa_dump
+-  ikev2_initiate_del_child_sa
+-  ikev2_initiate_del_child_sa_reply
+-  ikev2_initiate_del_ike_sa
+-  ikev2_initiate_del_ike_sa_reply
+-  ikev2_initiate_rekey_child_sa
+-  ikev2_initiate_rekey_child_sa_reply
+-  ikev2_initiate_sa_init
+-  ikev2_initiate_sa_init_reply
+-  ikev2_nonce_get
+-  ikev2_nonce_get_reply
+-  ikev2_profile_add_del
+-  ikev2_profile_add_del_reply
+-  ikev2_profile_details
+-  ikev2_profile_disable_natt
+-  ikev2_profile_disable_natt_reply
+-  ikev2_profile_dump
+-  ikev2_profile_set_auth
+-  ikev2_profile_set_auth_reply
+-  ikev2_profile_set_id
+-  ikev2_profile_set_id_reply
+-  ikev2_profile_set_ipsec_udp_port
+-  ikev2_profile_set_ipsec_udp_port_reply
+-  ikev2_profile_set_liveness
+-  ikev2_profile_set_liveness_reply
+-  ikev2_profile_set_ts
+-  ikev2_profile_set_ts_reply
+-  ikev2_profile_set_udp_encap
+-  ikev2_profile_set_udp_encap_reply
+-  ikev2_sa_details
+-  ikev2_sa_dump
+-  ikev2_set_esp_transforms
+-  ikev2_set_esp_transforms_reply
+-  ikev2_set_ike_transforms
+-  ikev2_set_ike_transforms_reply
+-  ikev2_set_local_key
+-  ikev2_set_local_key_reply
+-  ikev2_set_responder
+-  ikev2_set_responder_reply
+-  ikev2_set_sa_lifetime
+-  ikev2_set_sa_lifetime_reply
+-  ikev2_set_tunnel_interface
+-  ikev2_set_tunnel_interface_reply
+-  ikev2_traffic_selector_details
+-  ikev2_traffic_selector_dump
+-  l2_emulation
+-  l2_emulation_reply
+-  mdata_enable_disable
+-  mdata_enable_disable_reply
+-  nat44_add_del_static_mapping_v2
+-  nat44_add_del_static_mapping_v2_reply
+-  nat44_show_running_config
+-  nat44_show_running_config_reply
+-  nat64_plugin_enable_disable
+-  nat64_plugin_enable_disable_reply
+-  oddbuf_enable_disable
+-  oddbuf_enable_disable_reply
+-  pg_interface_enable_disable_coalesce
+-  pg_interface_enable_disable_coalesce_reply
+-  sample_macswap_enable_disable
+-  sample_macswap_enable_disable_reply
+-  sr_policies_with_sl_index_details
+-  sr_policies_with_sl_index_dump
+-  sw_interface_set_vxlan_gbp_bypass
+-  sw_interface_set_vxlan_gbp_bypass_reply
+-  test_enum
+-  test_enum_reply
+-  test_prefix
+-  test_prefix_reply
+-  trace_capture_packets
+-  trace_capture_packets_reply
+-  trace_clear_capture
+-  trace_clear_capture_reply
+-  trace_details
+-  trace_dump
+-  trace_dump_reply
+-  trace_set_filters
+-  trace_set_filters_reply
+-  vxlan_gbp_tunnel_add_del
+-  vxlan_gbp_tunnel_add_del_reply
+-  vxlan_gbp_tunnel_details
+-  vxlan_gbp_tunnel_dump
+-  wireguard_interface_create
+-  wireguard_interface_create_reply
+-  wireguard_interface_delete
+-  wireguard_interface_delete_reply
+-  wireguard_interface_details
+-  wireguard_interface_dump
+-  wireguard_peer_add
+-  wireguard_peer_add_reply
+-  wireguard_peer_remove
+-  wireguard_peer_remove_reply
+-  wireguard_peers_details
+-  wireguard_peers_dump
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``src/vpp/api/vpe_types.api``
+
+* `dc01471be `_ api: add missing version info
+
+``src/vat2/test/vat2_test.api``
+
+* `58a6e7725 `_ api: crchcecker ignore version < 1.0.0 and outside of src directory
+* `510aaa891 `_ api: crchcecker ignore version < 1.0.0 and outside of src directory
+* `793be4632 `_ api: fromjson/tojson enum flag support
+
+``src/vnet/mpls/mpls.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
+``src/vnet/ipip/ipip.api``
+
+* `33c45f56a `_ fib: supporting inner flow hash on tunnels
+
+``src/vnet/vxlan-gbp/vxlan_gbp.api``
+
+* `b468773aa `_ vxlan-gbp: Mark APIs as in-progress
+
+``src/vnet/ipsec/ipsec.api``
+
+* `041add7d1 `_ ipsec: Tunnel SA DSCP behaviour
+* `f916414b3 `_ api: clean up use of deprecated flag
+
+``src/vnet/ipsec/ipsec_types.api``
+
+* `041add7d1 `_ ipsec: Tunnel SA DSCP behaviour
+
+``src/vnet/tunnel/tunnel_types.api``
+
+* `dc01471be `_ api: add missing version info
+* `33c45f56a `_ fib: supporting inner flow hash on tunnels
+
+``src/vnet/classify/classify.api``
+
+* `5c1e48c01 `_ classify: add pcap/trace classfier mgmt API calls
+
+``src/vnet/ipfix-export/ipfix_export.api``
+
+* `f6cf57ceb `_ misc: fix api in ipfix_classify_table_add/details
+
+``src/vnet/mfib/mfib_types.api``
+
+* `dc01471be `_ api: add missing version info
+* `990f69450 `_ ip: convert u32 entry_flags to vl_api_mfib_entry_flags_t on mroute API
+
+``src/vnet/gre/gre.api``
+
+* `33c45f56a `_ fib: supporting inner flow hash on tunnels
+
+``src/vnet/ip/ip_types.api``
+
+* `6dc0c8d14 `_ ip: Sub Address Family types. Feature enable for each SAFI
+
+``src/vnet/ip/ip.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+* `990f69450 `_ ip: convert u32 entry_flags to vl_api_mfib_entry_flags_t on mroute API
+
+``src/vnet/ethernet/ethernet_types.api``
+
+* `dc01471be `_ api: add missing version info
+
+``src/vnet/l2/l2.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
+``src/vnet/cop/cop.api``
+
+* `6c8cdf78b `_ misc: cop - clean up stray doxygen block
+* `f916414b3 `_ api: clean up use of deprecated flag
+
+``src/vnet/crypto/crypto.api``
+
+* `8c91b2ae2 `_ crypto: Crypto set handler API to support set all as CLI
+
+``src/vnet/devices/virtio/virtio.api``
+
+* `e347acbc3 `_ virtio: add packet buffering on transmit path
+* `f916414b3 `_ api: clean up use of deprecated flag
+
+``src/vnet/interface_types.api``
+
+* `dc01471be `_ api: add missing version info
+
+``src/vnet/ip-neighbor/ip_neighbor.api``
+
+* `4ac36bcb1 `_ ip-neighbor: Send API event when neighbor is removed
+
+``src/vnet/policer/policer_types.api``
+
+* `dc01471be `_ api: add missing version info
+
+``src/vnet/srv6/sr_types.api``
+
+* `dc01471be `_ api: add missing version info
+
+``src/plugins/map/map.api``
+
+* `148c7b768 `_ stats: counters data model
+* `f916414b3 `_ api: clean up use of deprecated flag
+
+``src/plugins/nat/nat64/nat64.api``
+
+* `1f36023d2 `_ nat: move nat64 to a subfeature
+
+``src/plugins/nat/det44/det44.api``
+
+* `d1762e614 `_ nat: det44 plugin fix style and api cleanup
+* `f916414b3 `_ api: clean up use of deprecated flag
+
+``src/plugins/nat/nat44.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+* `25fd8ad03 `_ nat: cleanup & reorganization
+* `b227aa699 `_ nat: api,cli and test update & cleanup
+
+``src/plugins/nat/nat_types.api``
+
+* `25fd8ad03 `_ nat: cleanup & reorganization
+
+``src/plugins/lisp/lisp-cp/one.api``
+
+* `2b202bc4b `_ lisp: Move to plugin
+
+``src/plugins/lisp/lisp-cp/lisp.api``
+
+* `068ad25c1 `_ lisp: .api dont set defaults in reply messages
+* `2b202bc4b `_ lisp: Move to plugin
+
+``src/plugins/lisp/lisp-cp/lisp_types.api``
+
+* `2b202bc4b `_ lisp: Move to plugin
+
+``src/plugins/lisp/lisp-gpe/lisp_gpe.api``
+
+* `2b202bc4b `_ lisp: Move to plugin
+
+``src/plugins/nsim/nsim.api``
+
+* `f916414b3 `_ api: clean up use of deprecated flag
+
+``src/plugins/lb/lb_types.api``
+
+* `dc01471be `_ api: add missing version info
+
+``src/plugins/lb/lb.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
+``src/plugins/pppoe/pppoe.api``
+
+* `340b10a38 `_ pppoe: make pppoe plugin work with dot1q subinterfaces
+
+``src/plugins/geneve/geneve.api``
+
+* `3a6adc52f `_ geneve: Move to plugin
+
+``src/plugins/vmxnet3/vmxnet3.api``
+
+* `490e077fb `_ vmxnet3: add sw_if_index filter to vmxnet3 interface dump
+
+``src/plugins/wireguard/wireguard.api``
+
+* `de22111b5 `_ wireguard: return public key in api
+
+``src/plugins/l2tp/l2tp.api``
+
+* `6810a77da `_ misc: Move l2tp to plugin
+
+``src/plugins/acl/acl.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
+``src/plugins/acl/acl_types.api``
+
+* `dc01471be `_ api: add missing version info
+
+``src/plugins/rdma/rdma.api``
+
+* `798267aaa `_ rdma: implement multiseg rx without striding rq
+
+``src/plugins/ikev2/ikev2.api``
+
+* `d7fc12f07 `_ ikev2: add option to disable NAT traversal
+* `84962d19b `_ ikev2: support ipv6 traffic selectors & overlay
+
+``src/plugins/ikev2/ikev2_types.api``
+
+* `dc01471be `_ api: add missing version info
+* `d7fc12f07 `_ ikev2: add option to disable NAT traversal
+* `84962d19b `_ ikev2: support ipv6 traffic selectors & overlay
+
+``src/plugins/cnat/cnat.api``
+
+* `2082835fe `_ cnat: allow max_u16 translation backends
+* `af897c5e3 `_ cnat: Add DHCP support
+
+``src/plugins/tracedump/tracedump.api``
+
+* `c0b195450 `_ feature: Add packet trace API
+
+``src/plugins/tracedump/graph.api``
+
+* `c0b195450 `_ feature: Add packet trace API
+
+``src/plugins/vrrp/vrrp.api``
+
+* `78f487e11 `_ vrrp: asynchronous events on VR state change
+
+``src/plugins/flowprobe/flowprobe.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
+``src/plugins/lldp/lldp.api``
+
+* `3f9fdd984 `_ lldp: Move to plugin
+
+``src/plugins/memif/memif.api``
+
+* `6223766f9 `_ libmemif: clean up typos
+
+``src/plugins/dns/dns.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
+``src/plugins/stn/stn.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
+``src/plugins/af_xdp/af_xdp.api``
+
+* `d4e109138 `_ af_xdp: add option to claim all available rx queues
+
+``src/plugins/gbp/gbp.api``
+
+* `df87f8092 `_ api: vat2 and json autogeneration for api messages
+
diff --git a/docs/aboutvpp/releasenotes/v21.06.rst b/docs/aboutvpp/releasenotes/v21.06.rst
new file mode 100644
index 00000000000..0c5820d868c
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v21.06.rst
@@ -0,0 +1,1477 @@
+Release notes for VPP 21.06
+===========================
+
+More than 787 commits since the previous release, including 364 fixes.
+
+Release Highlights
+------------------
+
+There are many excellent new features in this release, however a few of
+them deserve a special mention.
+
+Linux Control Plane Plugin (linux-cp)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+One of the more significant new features included in this release is a
+linux control plane (linux-cp) plugin. It enables the near-seamless
+integration of VPP with the host control plane, by mirroring the VPP
+interfaces into a TUN or TAP device created in the linux kernel. All of
+the punted packets received on the VPP interface will be sent to the
+linux counterpart, and in the reverse direction, packets sent by linux
+kernel will be transmitted out the VPP interface. This plugin lays the
+foundation for the much easier integration of external software with
+VPP.
+
+Performance Monitor Plugin (perfmon)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Another interesting feature is the performance monitor (perfmon) plugin.
+It allows collection of detailed low-level CPU statistics on a per-node
+basis. It provides a useful advanced troubleshooting tool, should you
+encounter that a specific node’s performance is not on par with what it
+should be. Note, that the correct functioning of this plugin may require
+changing the /proc/sys/kernel/perf_event_paranoid setting to enable
+access to the performance counters.
+
+API CRC Substitution Table Removal
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+And finally a clarification, not a feature per se. Some messages in the
+API changes table for this release have a new marking: “message CRC32
+fix”. The history of this issue goes back to summer of 2020, when it was
+discovered that for a considerable amount of time (several months) the
+calculation of the CRC of API messages was incorrect. Specifically, all
+but the first user-defined types in the message failed to be included in
+the CRC calculation. In plain words, this means that one might end up
+with a situation where client and VPP layout of message in memory could
+be quite different.
+
+At the time of discovery, there were no API changes that were affected
+by that bug. However, simply fixing it meant the CRC of about half of
+the VPP API messages would be altered for no reason which would result
+in a significant amount of pain to the consumers of VPP. A message CRC
+is just an opague number for anyone using it, and the only property of
+it for the user is that the messages with the same value of CRC have the
+same layout on the wire with a sufficiently high certainty.
+
+Therefore a fix
+(`9f84e70c6 `__)
+was merged that also contained a “band-aid” to avoid this pain. In
+addition to fixing the CRC generation algorithm, the fix captured the
+“new” CRC values for those messages that had their CRCs arbitrarily
+changed by this fix and created a substituion table with [message name,
+new CRC, old CRC] triplets. For a given message, if the CRC matched the
+recorded new value, the code would substitute it with the old value,
+thus trading in a reduction in collision resistance (two values of CRC
+out of 2^32 space) for not forcing users to adapt to several hundred of
+messages which changed the CRCs.
+
+This band-aid also had the property that whenever a message did change
+the definition, it would automatically get a “correct” calculation of
+CRC32 and no longer use the slot in the table. The table naturally
+shrinks over time, thus allowing a painless transition, while also
+preserving the integrity check for the affected messages. If any fields
+changed, the CRC would no longer match the “new” value thus no
+substitution would be made. Since the choice of CRC32 is just an
+implementation detail which is supposed to be opaque to the user, the
+band-aid was deemed a reasonable approach to avoid a major burden on VPP
+consumers.
+
+However, in practice this solution was not accepted well. After a
+notification period, the API CRC Substitution table was removed by the
+patch
+(`da1b76aa8 `__).
+Thus all of the API CRC changes that did not happen in 9f84e70c6,
+happened in da1b76aa8. Hopefully the notification of these changes has
+reduced the inconvenience. VPP users are asked to not rely on any other
+property of the message CRC other than changes to its value when the
+message layout changes.
+
+Features
+--------
+
+-  Binary API Compiler for Python
+
+   -  Support an ‘autoendian’ keyword for message definitions in .api
+      files
+      (`9302cfea9 `__)
+
+-  Build System
+
+   -  Make rpath optional
+      (`2c91922eb `__)
+
+-  Infrastructure Library
+
+   -  Add option to use libexecinfo
+      (`67d7acd05 `__)
+   -  Add bihash with 32 byte key
+      (`f613a4402 `__)
+   -  Add missing %o
+      (`04a14133c `__)
+
+-  Plugins
+
+   -  ARPing CLI
+
+      -  Add arping command
+         (`a77ae4708 `__)
+
+   -  AVF Device driver
+
+      -  Add avf flow framework
+         (`ffe9a5489 `__)
+
+   -  CNat
+
+      -  Add maglev support
+         (`4d237874e `__)
+      -  Add input feature node
+         (`cc9a1a0d3 `__)
+      -  Add calico/k8s src policy
+         (`516b0adf6 `__)
+
+   -  Crypto - ipsecmb
+
+      -  Add support for AES CTR
+         (`fe7ff320b `__)
+
+   -  DPDK
+
+      -  Rebase cryptodev engine for DPDK 20.11
+         (`25f371ee0 `__)
+      -  Allow configure individual VMBUS devices
+         (`982272974 `__)
+      -  Implement interrupt mode
+         (`19ff0c369 `__)
+
+   -  IPv6 Segment Routing Flow-Based Dynamic Proxy
+
+      -  SRv6 Per-Flow Dynamic Proxy
+         (`ed7c62a30 `__)
+
+   -  Internet Key Exchange (IKEv2) Protocol
+
+      -  Use new counters data model & add more counters
+         (`fab5e7f39 `__)
+      -  Add per SA stats
+         (`68d275356 `__)
+      -  Support responder hostname
+         (`af2cc6425 `__)
+
+   -  NAT
+
+      -  1:1 policy NAT
+         (`18327be5d `__)
+      -  Pnat copy and clear byte instructions
+         (`ab3151c52 `__)
+
+   -  QUIC protocol
+
+      -  Quicly v0.1.2 update
+         (`2e4523816 `__)
+      -  Update quicly to v0.1.3
+         (`db36fda74 `__)
+
+   -  RDMA (ibverb) driver
+
+      -  Add support for RSS configuration
+         (`f5a45680e `__)
+
+   -  SRTP
+
+      -  Basic implementation based on libsrtp2
+         (`6621abf49 `__)
+
+   -  TCP MSS Clamping
+
+      -  TCP MSS clamping plugin
+         (`bf55e9931 `__)
+
+   -  Linux-cp
+
+      -  Linux Interface Mirroring for Control Plane Integration
+         (`44db1caef `__)
+
+   -  Memif device driver
+
+      -  Adapt to new rxq framework
+         (`755941865 `__)
+
+   -  Performance counter
+
+      -  New perfmon plugin
+         (`8b60fb0fe `__)
+
+-  Python binding for the VPP API
+
+   -  Expose vpp_papi version to client
+      (`b552ff2e9 `__)
+
+-  SVM Library
+
+   -  Allow mq attachments at random offsets
+      (`b46241889 `__)
+   -  Per app rx message queues
+      (`41d5f541d `__)
+
+-  Statistics Segment
+
+   -  Adding symlinks for nodes and interfaces in the stat segment
+      (`db0238090 `__)
+   -  Memory heap counters
+      (`a606d9210 `__)
+
+-  VNET
+
+   -  Crypto Infra
+
+      -  Add support for aes-ctr+sha-1 chains
+         (`40ee2003b `__)
+      -  Support hashing operations
+         (`06111a837 `__)
+      -  Add chacha20-poly1305 support to ipsecmb
+         (`106e24bd9 `__)
+
+   -  FIB
+
+      -  Allow the creation of new source on the API
+         (`976b259be `__)
+
+   -  FLOW
+
+      -  Add API implementation of IP4/IP6, IP4_VXLAN/IP6_VXLAN
+         (`c7e7819ad `__)
+
+   -  IPIP
+
+      -  Support MPLS over IP
+         (`e294de6f8 `__)
+
+   -  IPSec
+
+      -  Support MPLS over IPSec[46] interface
+         (`4a58e49cf `__)
+      -  Add support for AES CTR
+         (`490b92738 `__)
+      -  CLI improvement for udp port encap
+         (`048189e7a `__)
+      -  Use the new tunnel API types to add flow label and TTL copy
+         support
+         (`c7eaa711f `__)
+      -  Use the new tunnel API types to add flow label and TTL copy
+         support
+         (`9ec846c26 `__)
+      -  Support async mode per-SA
+         (`f16e9a550 `__)
+
+   -  IPv4 LPM
+
+      -  Add API to retrieve IPv6 link-layer address
+         (`58a1915b5 `__)
+      -  Router ID included in flow hash
+         (`3d5f08a82 `__)
+      -  Path MTU
+         (`8f5fef2c7 `__)
+      -  Extend punt CLI for exception packets
+         (`45723b8d3 `__)
+      -  Extend show cmd of ip reassembly configuration
+         (`74a4a70ef `__)
+
+   -  Interface Common
+
+      -  RX/TX direction type in API
+         (`6a999d67d `__)
+      -  Add promisc on/off in api
+         (`fd0b399ff `__)
+
+   -  L2
+
+      -  Add per bridge domain learn limit
+         (`5f93e3b7f `__)
+      -  Separating scan-delay and learn-limit into a separate API from
+         want_l2_macs_events
+         (`0f8d10035 `__)
+
+   -  Session Layer
+
+      -  Basic support for interrupt mode
+         (`7da8829d8 `__)
+      -  Api to update connection attributes
+         (`04ae8273f `__)
+
+   -  TLS and TLS engine plugins
+
+      -  Dtls initial implementation
+         (`4b47ee26c `__)
+
+   -  Vhost User Driver
+
+      -  Add event index for interrupt notification to driver
+         (`27ba5008a `__)
+
+   -  Tunnel
+
+      -  Support copying TTL and flow label from inner to outer
+         (`a91cb4590 `__)
+
+-  VPP Comms Library
+
+   -  Extended connect/listen configuration
+      (`4ac258497 `__)
+
+-  Libmemif
+
+   -  Set next free buffer
+      (`47e68de22 `__)
+   -  Set data offset for memif buffer
+      (`1421748e3 `__)
+
+Known issues
+------------
+
+Coverity Issues
+~~~~~~~~~~~~~~~
+
+Starting with this release, we add the section about the section with
+the unresolved Coverity Issues into the Release Notes. In order to view
+the issues, visit https://scan.coverity.com/, add yourself to fd.io VPP
+project and click on the matching IDs.
+
+Plugin - PPPoE:
+^^^^^^^^^^^^^^^
+
+-  BUG 218437 in function: pppoe_input_node_fn, file:
+   /src/plugins/pppoe/pppoe_decap.c
+-  BUG 218401 in function: pppoe_input_node_fn, file:
+   /src/plugins/pppoe/pppoe_decap.c #### VNET - IP6 Neighbor Discovery:
+-  BUG 218382 in function: set_ip6_nd_proxy_cmd, file:
+   /src/vnet/ip6-nd/ip6_nd_proxy.c #### Plugin - TCP MSS Clamping:
+-  BUG 219550 in function: vl_api_mss_clamp_enable_disable_t_handler,
+   file: /src/plugins/mss_clamp/mss_clamp_api.c #### Plugin -
+   performance counter:
+-  BUG 216295 in function: format_text_cell, file:
+   /src/plugins/perfmon/table.c
+-  BUG 218459 in function: intel_uncore_init, file:
+   /src/plugins/perfmon/intel/uncore.c
+-  BUG 216249 in function: perfmon_reset, file:
+   /src/plugins/perfmon/perfmon.c #### Plugin - DPDK:
+-  BUG 220290 in function: dpdk_lib_init, file:
+   /src/plugins/dpdk/device/init.c
+-  BUG 220289 in function: dpdk_lib_init, file:
+   /src/plugins/dpdk/device/init.c
+-  BUG 220105 in function: cryptodev_get_common_capabilities, file:
+   /src/plugins/dpdk/cryptodev/cryptodev.c #### VNET IPv4 LPM:
+-  BUG 216981 in function: icmp_to_icmp6, file:
+   /src/vnet/ip/ip4_to_ip6.h
+-  BUG 214755 in function: ip_in_out_acl_inline, file:
+   /src/vnet/ip/ip_in_out_acl.c
+-  BUG 220099 in function: vl_api_ip_route_lookup_v2_t_handler, file:
+   /src/vnet/ip/ip_api.c #### Plugin - Unit Tests:
+-  BUG 218446 in function: test_crypto_perf, file:
+   /src/plugins/unittest/crypto_test.c #### Plugin - NSH:
+-  BUG 218432 in function: nsh_add_del_entry, file:
+   /src/plugins/nsh/nsh_api.c #### Vector Library - PCI:
+-  BUG 218391 in function: vlib_pci_device_open, file:
+   /src/vlib/linux/pci.c
+-  BUG 218396 in function: linux_pci_init, file: /src/vlib/linux/pci.c
+   #### VNET Segment Routing (IPv6 and MPLS):
+-  BUG 218375 in function: sr_policy_del, file:
+   /src/vnet/srv6/sr_policy_rewrite.c
+-  BUG 218409 in function: sr_steering_policy, file:
+   /src/vnet/srv6/sr_steering.c
+-  BUG 218427 in function: sr_policy_mod, file:
+   /src/vnet/srv6/sr_policy_rewrite.c
+-  BUG 180995 in function: sr_mpls_policy_assign_endpoint_color, file:
+   /src/vnet/srmpls/sr_mpls_policy.c #### Vector Library:
+-  BUG 218552 in function: add_sub_command, file: /src/vlib/cli.c ####
+   VNET FIB:
+-  BUG 216057 in function: fib_sas6_get, file: /src/vnet/fib/fib_sas.c
+   #### VNET Ethernet:
+-  BUG 214973 in function: ethernet_input_inline, file:
+   /src/vnet/ethernet/node.c
+-  BUG 218549 in function: identify_subint, file:
+   /src/vnet/ethernet/node.c #### Infrastructure Library:
+-  BUG 236112 in function: extract_bits, file: /src/vppinfra/clib.h ####
+   Binary API Compiler for C and C++:
+-  BUG 236138 in function: test_loopbacks_2, file:
+   /src/vpp-api/vapi/vapi_cpp_test.cpp
+-  BUG 236140 in function: test_loopbacks_1, file:
+   /src/vpp-api/vapi/vapi_cpp_test.cpp
+-  BUG 236139 in function: Create_loopback_cb, file:
+   /src/vpp-api/vapi/vapi_cpp_test.cpp
+-  BUG 236136 in function: test_api_strings, file:
+   /src/vpp-api/vapi/vapi_c_test.c
+-  BUG 236137 in function: Delete_loopback_cb, file:
+   /src/vpp-api/vapi/vapi_cpp_test.cpp #### Plugin - IPv6 Segment
+   Routing Masquerading Proxy:
+-  BUG 218441 in function: srv6_am_localsid_removal_fn, file:
+   /src/plugins/srv6-am/am.c #### VNET Policer:
+-  BUG 218398 in function: show_policer_command_fn, file:
+   /src/vnet/policer/policer.c #### Plugin - DHCP:
+-  BUG 218381 in function: dhcpv6_proxy_to_client_input, file:
+   /src/plugins/dhcp/dhcp6_proxy_node.c #### Plugin - IOAM:
+-  BUG 216232 in function: ioam_cache_ts_table_destroy, file:
+   /src/plugins/ioam/ip6/ioam_cache.h #### VNET IPv6 LPM:
+-  BUG 216981 in function: icmp_to_icmp6, file:
+   /src/vnet/ip/ip4_to_ip6.h
+-  BUG 214755 in function: ip_in_out_acl_inline, file:
+   /src/vnet/ip/ip_in_out_acl.c
+-  BUG 220099 in function: vl_api_ip_route_lookup_v2_t_handler, file:
+   /src/vnet/ip/ip_api.c
+
+Jira Issues
+~~~~~~~~~~~
+
+For the full list of issues please refer to fd.io
+`JIRA `__.
+
+Fixed issues
+------------
+
+For the full list of fixed issues please refer to:
+
+- fd.io `JIRA `__
+- git `commit log `__
+
+
+API changes
+-----------
+
+Description of results:
+
+-  *Definition changed*: indicates that the API file was modified
+   between releases.
+-  *Only in image*: indicates the API is new for this release.
+-  *Only in file*: indicates the API has been removed in this release.
+-  *Message CRC32 fix*: please refer to release highlights for
+   description.
+
+=============================================== ==================
+Message Name                                    Result
+=============================================== ==================
+abf_policy_add_del                              message CRC32 fix
+abf_policy_details                              message CRC32 fix
+acl_add_replace                                 message CRC32 fix
+acl_details                                     message CRC32 fix
+af_xdp_create                                   definition changed
+arping                                          only in image
+arping_reply                                    only in image
+bd_ip_mac_add_del                               message CRC32 fix
+bd_ip_mac_details                               message CRC32 fix
+bfd_udp_add                                     message CRC32 fix
+bfd_udp_auth_activate                           message CRC32 fix
+bfd_udp_auth_deactivate                         message CRC32 fix
+bfd_udp_del                                     message CRC32 fix
+bfd_udp_get_echo_source_reply                   message CRC32 fix
+bfd_udp_mod                                     message CRC32 fix
+bfd_udp_session_details                         message CRC32 fix
+bfd_udp_session_event                           only in image
+bfd_udp_session_set_flags                       message CRC32 fix
+bier_disp_entry_add_del                         message CRC32 fix
+bier_disp_entry_details                         message CRC32 fix
+bier_route_add_del                              message CRC32 fix
+bier_route_details                              message CRC32 fix
+bond_create                                     message CRC32 fix
+bond_enslave                                    message CRC32 fix
+bridge_domain_details                           message CRC32 fix
+bridge_domain_set_default_learn_limit           only in image
+bridge_domain_set_default_learn_limit_reply     only in image
+bridge_domain_set_learn_limit                   only in image
+bridge_domain_set_learn_limit_reply             only in image
+cnat_add_del_snat_prefix                        only in file
+cnat_add_del_snat_prefix_reply                  only in file
+cnat_session_details                            definition changed
+cnat_set_snat_policy                            only in image
+cnat_set_snat_policy_reply                      only in image
+cnat_snat_policy_add_del_exclude_pfx            only in image
+cnat_snat_policy_add_del_exclude_pfx_reply      only in image
+cnat_snat_policy_add_del_if                     only in image
+cnat_snat_policy_add_del_if_reply               only in image
+cnat_translation_details                        definition changed
+cnat_translation_update                         definition changed
+cop_interface_enable_disable                    only in file
+cop_interface_enable_disable_reply              only in file
+cop_whitelist_enable_disable                    only in file
+cop_whitelist_enable_disable_reply              only in file
+create_subif                                    message CRC32 fix
+create_vhost_user_if_v2                         only in image
+create_vhost_user_if_v2_reply                   only in image
+dhcp6_pd_reply_event                            message CRC32 fix
+dhcp6_pd_send_client_message                    message CRC32 fix
+dhcp6_reply_event                               message CRC32 fix
+dhcp6_send_client_message                       message CRC32 fix
+dhcp_client_config                              message CRC32 fix
+dhcp_client_details                             message CRC32 fix
+dhcp_compl_event                                message CRC32 fix
+dhcp_proxy_config                               message CRC32 fix
+dhcp_proxy_details                              message CRC32 fix
+dslite_add_del_pool_addr_range                  message CRC32 fix
+dslite_get_aftr_addr_reply                      message CRC32 fix
+dslite_get_b4_addr_reply                        message CRC32 fix
+dslite_set_aftr_addr                            message CRC32 fix
+dslite_set_b4_addr                              message CRC32 fix
+fib_source_add                                  only in image
+fib_source_add_reply                            only in image
+fib_source_details                              only in image
+fib_source_dump                                 only in image
+flow_add                                        definition changed
+gbp_bridge_domain_add                           message CRC32 fix
+gbp_bridge_domain_details                       message CRC32 fix
+gbp_contract_add_del                            message CRC32 fix
+gbp_contract_details                            message CRC32 fix
+gbp_endpoint_add                                message CRC32 fix
+gbp_endpoint_details                            message CRC32 fix
+gbp_endpoint_group_add                          message CRC32 fix
+gbp_endpoint_group_details                      message CRC32 fix
+gbp_ext_itf_add_del                             message CRC32 fix
+gbp_ext_itf_details                             message CRC32 fix
+gbp_route_domain_add                            message CRC32 fix
+gbp_route_domain_details                        message CRC32 fix
+gbp_subnet_add_del                              message CRC32 fix
+gbp_subnet_details                              message CRC32 fix
+geneve_add_del_tunnel                           message CRC32 fix
+geneve_tunnel_details                           message CRC32 fix
+gpe_add_del_fwd_entry                           message CRC32 fix
+gpe_add_del_native_fwd_rpath                    message CRC32 fix
+gpe_fwd_entries_get_reply                       message CRC32 fix
+gpe_fwd_entry_path_details                      message CRC32 fix
+gpe_native_fwd_rpaths_get_reply                 message CRC32 fix
+gre_tunnel_add_del                              message CRC32 fix
+gre_tunnel_details                              message CRC32 fix
+gtpu_add_del_tunnel                             message CRC32 fix
+gtpu_tunnel_details                             message CRC32 fix
+gtpu_tunnel_update_tteid                        message CRC32 fix
+igmp_details                                    message CRC32 fix
+igmp_event                                      message CRC32 fix
+igmp_group_prefix_details                       message CRC32 fix
+igmp_group_prefix_set                           message CRC32 fix
+igmp_listen                                     message CRC32 fix
+ikev2_sa_details                                definition changed
+ikev2_set_responder_hostname                    only in image
+ikev2_set_responder_hostname_reply              only in image
+ioam_export_ip6_enable_disable                  message CRC32 fix
+ip6_add_del_address_using_prefix                message CRC32 fix
+ip6_ra_event                                    message CRC32 fix
+ip6nd_proxy_add_del                             message CRC32 fix
+ip6nd_proxy_details                             message CRC32 fix
+ip_address_details                              message CRC32 fix
+ip_container_proxy_add_del                      message CRC32 fix
+ip_container_proxy_details                      message CRC32 fix
+ip_neighbor_add_del                             message CRC32 fix
+ip_neighbor_details                             message CRC32 fix
+ip_neighbor_dump                                message CRC32 fix
+ip_neighbor_event                               message CRC32 fix
+ip_path_mtu_details                             only in image
+ip_path_mtu_get                                 only in image
+ip_path_mtu_get_reply                           only in image
+ip_path_mtu_replace_begin                       only in image
+ip_path_mtu_replace_begin_reply                 only in image
+ip_path_mtu_replace_end                         only in image
+ip_path_mtu_replace_end_reply                   only in image
+ip_path_mtu_update                              only in image
+ip_path_mtu_update_reply                        only in image
+ip_punt_redirect                                message CRC32 fix
+ip_punt_redirect_details                        message CRC32 fix
+ip_reassembly_enable_disable                    message CRC32 fix
+ip_route_add_del                                message CRC32 fix
+ip_route_add_del_v2                             only in image
+ip_route_add_del_v2_reply                       only in image
+ip_route_details                                message CRC32 fix
+ip_route_lookup                                 message CRC32 fix
+ip_route_lookup_reply                           message CRC32 fix
+ip_route_lookup_v2                              only in image
+ip_route_lookup_v2_reply                        only in image
+ip_route_v2_details                             only in image
+ip_route_v2_dump                                only in image
+ip_source_and_port_range_check_add_del          message CRC32 fix
+ip_unnumbered_details                           message CRC32 fix
+ipfix_exporter_details                          message CRC32 fix
+ipip_6rd_add_tunnel                             message CRC32 fix
+ipip_add_tunnel                                 message CRC32 fix
+ipip_tunnel_details                             message CRC32 fix
+ipsec_sa_details                                message CRC32 fix
+ipsec_sa_v3_details                             only in image
+ipsec_sa_v3_dump                                only in image
+ipsec_sad_entry_add_del                         message CRC32 fix
+ipsec_sad_entry_add_del_v3                      only in image
+ipsec_sad_entry_add_del_v3_reply                only in image
+ipsec_spd_details                               message CRC32 fix
+ipsec_spd_entry_add_del                         message CRC32 fix
+ipsec_tunnel_if_add_del                         only in file
+ipsec_tunnel_if_add_del_reply                   only in file
+ipsec_tunnel_if_set_sa                          only in file
+ipsec_tunnel_if_set_sa_reply                    only in file
+ipsec_tunnel_protect_del                        message CRC32 fix
+ipsec_tunnel_protect_details                    message CRC32 fix
+ipsec_tunnel_protect_update                     message CRC32 fix
+l2_arp_term_event                               message CRC32 fix
+l2_fib_table_details                            message CRC32 fix
+l2_interface_pbb_tag_rewrite                    message CRC32 fix
+l2_macs_event                                   message CRC32 fix
+l2_patch_add_del                                message CRC32 fix
+l2_xconnect_details                             message CRC32 fix
+l2fib_add_del                                   message CRC32 fix
+l2fib_set_scan_delay                            only in image
+l2fib_set_scan_delay_reply                      only in image
+l2tpv3_create_tunnel                            message CRC32 fix
+l3xc_details                                    message CRC32 fix
+l3xc_update                                     message CRC32 fix
+lb_add_del_as                                   message CRC32 fix
+lb_add_del_vip                                  message CRC32 fix
+lb_as_details                                   message CRC32 fix
+lb_conf                                         message CRC32 fix
+lb_vip_details                                  message CRC32 fix
+lb_vip_dump                                     message CRC32 fix
+lisp_add_del_adjacency                          message CRC32 fix
+lisp_add_del_local_eid                          message CRC32 fix
+lisp_add_del_map_resolver                       message CRC32 fix
+lisp_add_del_map_server                         message CRC32 fix
+lisp_add_del_remote_mapping                     message CRC32 fix
+lisp_adjacencies_get_reply                      message CRC32 fix
+lisp_eid_table_details                          message CRC32 fix
+lisp_eid_table_dump                             message CRC32 fix
+lisp_locator_details                            message CRC32 fix
+lisp_map_resolver_details                       message CRC32 fix
+lisp_map_server_details                         message CRC32 fix
+lisp_use_petr                                   message CRC32 fix
+log_details                                     message CRC32 fix
+macip_acl_add                                   message CRC32 fix
+macip_acl_add_replace                           message CRC32 fix
+macip_acl_details                               message CRC32 fix
+mactime_add_del_range                           message CRC32 fix
+mactime_details                                 message CRC32 fix
+map_add_domain                                  message CRC32 fix
+map_domain_details                              message CRC32 fix
+map_param_add_del_pre_resolve                   message CRC32 fix
+map_param_get_reply                             message CRC32 fix
+memif_details                                   message CRC32 fix
+mfib_signal_details                             message CRC32 fix
+modify_vhost_user_if_v2                         only in image
+modify_vhost_user_if_v2_reply                   only in image
+mpls_ip_bind_unbind                             message CRC32 fix
+mpls_route_add_del                              message CRC32 fix
+mpls_route_details                              message CRC32 fix
+mpls_tunnel_add_del                             message CRC32 fix
+mpls_tunnel_details                             message CRC32 fix
+mss_clamp_details                               only in image
+mss_clamp_enable_disable                        only in image
+mss_clamp_enable_disable_reply                  only in image
+mss_clamp_get                                   only in image
+mss_clamp_get_reply                             only in image
+nat44_add_del_address_range                     message CRC32 fix
+nat44_add_del_identity_mapping                  message CRC32 fix
+nat44_add_del_interface_addr                    message CRC32 fix
+nat44_add_del_lb_static_mapping                 message CRC32 fix
+nat44_add_del_static_mapping                    message CRC32 fix
+nat44_address_details                           message CRC32 fix
+nat44_del_session                               message CRC32 fix
+nat44_ed_plugin_enable_disable                  only in image
+nat44_ed_plugin_enable_disable_reply            only in image
+nat44_ed_set_fq_options                         only in image
+nat44_ed_set_fq_options_reply                   only in image
+nat44_ed_show_fq_options                        only in image
+nat44_ed_show_fq_options_reply                  only in image
+nat44_ei_add_del_address_range                  only in image
+nat44_ei_add_del_address_range_reply            only in image
+nat44_ei_add_del_identity_mapping               only in image
+nat44_ei_add_del_identity_mapping_reply         only in image
+nat44_ei_add_del_interface_addr                 only in image
+nat44_ei_add_del_interface_addr_reply           only in image
+nat44_ei_add_del_static_mapping                 only in image
+nat44_ei_add_del_static_mapping_reply           only in image
+nat44_ei_address_details                        only in image
+nat44_ei_address_dump                           only in image
+nat44_ei_del_session                            only in image
+nat44_ei_del_session_reply                      only in image
+nat44_ei_del_user                               only in image
+nat44_ei_del_user_reply                         only in image
+nat44_ei_forwarding_enable_disable              only in image
+nat44_ei_forwarding_enable_disable_reply        only in image
+nat44_ei_get_addr_and_port_alloc_alg            only in image
+nat44_ei_get_addr_and_port_alloc_alg_reply      only in image
+nat44_ei_get_mss_clamping                       only in image
+nat44_ei_get_mss_clamping_reply                 only in image
+nat44_ei_ha_flush                               only in image
+nat44_ei_ha_flush_reply                         only in image
+nat44_ei_ha_get_failover                        only in image
+nat44_ei_ha_get_failover_reply                  only in image
+nat44_ei_ha_get_listener                        only in image
+nat44_ei_ha_get_listener_reply                  only in image
+nat44_ei_ha_resync                              only in image
+nat44_ei_ha_resync_completed_event              only in image
+nat44_ei_ha_resync_reply                        only in image
+nat44_ei_ha_set_failover                        only in image
+nat44_ei_ha_set_failover_reply                  only in image
+nat44_ei_ha_set_listener                        only in image
+nat44_ei_ha_set_listener_reply                  only in image
+nat44_ei_identity_mapping_details               only in image
+nat44_ei_identity_mapping_dump                  only in image
+nat44_ei_interface_add_del_feature              only in image
+nat44_ei_interface_add_del_feature_reply        only in image
+nat44_ei_interface_add_del_output_feature       only in image
+nat44_ei_interface_add_del_output_feature_reply only in image
+nat44_ei_interface_addr_details                 only in image
+nat44_ei_interface_addr_dump                    only in image
+nat44_ei_interface_details                      only in image
+nat44_ei_interface_dump                         only in image
+nat44_ei_interface_output_feature_details       only in image
+nat44_ei_interface_output_feature_dump          only in image
+nat44_ei_ipfix_enable_disable                   only in image
+nat44_ei_ipfix_enable_disable_reply             only in image
+nat44_ei_plugin_enable_disable                  only in image
+nat44_ei_plugin_enable_disable_reply            only in image
+nat44_ei_set_addr_and_port_alloc_alg            only in image
+nat44_ei_set_addr_and_port_alloc_alg_reply      only in image
+nat44_ei_set_fq_options                         only in image
+nat44_ei_set_fq_options_reply                   only in image
+nat44_ei_set_log_level                          only in image
+nat44_ei_set_log_level_reply                    only in image
+nat44_ei_set_mss_clamping                       only in image
+nat44_ei_set_mss_clamping_reply                 only in image
+nat44_ei_set_timeouts                           only in image
+nat44_ei_set_timeouts_reply                     only in image
+nat44_ei_set_workers                            only in image
+nat44_ei_set_workers_reply                      only in image
+nat44_ei_show_fq_options                        only in image
+nat44_ei_show_fq_options_reply                  only in image
+nat44_ei_show_running_config                    only in image
+nat44_ei_show_running_config_reply              only in image
+nat44_ei_static_mapping_details                 only in image
+nat44_ei_static_mapping_dump                    only in image
+nat44_ei_user_details                           only in image
+nat44_ei_user_dump                              only in image
+nat44_ei_user_session_details                   only in image
+nat44_ei_user_session_dump                      only in image
+nat44_ei_worker_details                         only in image
+nat44_ei_worker_dump                            only in image
+nat44_identity_mapping_details                  message CRC32 fix
+nat44_interface_addr_details                    message CRC32 fix
+nat44_lb_static_mapping_add_del_local           message CRC32 fix
+nat44_lb_static_mapping_details                 message CRC32 fix
+nat44_static_mapping_details                    message CRC32 fix
+nat44_user_session_details                      message CRC32 fix
+nat64_add_del_pool_addr_range                   message CRC32 fix
+nat64_add_del_static_bib                        message CRC32 fix
+nat64_bib_details                               message CRC32 fix
+nat64_st_details                                message CRC32 fix
+nat66_add_del_static_mapping                    message CRC32 fix
+nat66_plugin_enable_disable                     only in image
+nat66_plugin_enable_disable_reply               only in image
+nat66_static_mapping_details                    message CRC32 fix
+nat_det_add_del_map                             message CRC32 fix
+nat_det_close_session_in                        message CRC32 fix
+nat_det_close_session_out                       message CRC32 fix
+nat_det_map_details                             message CRC32 fix
+nsh_add_del_map                                 message CRC32 fix
+nsh_map_details                                 message CRC32 fix
+nsim_cross_connect_enable_disable               message CRC32 fix
+one_add_del_adjacency                           message CRC32 fix
+one_add_del_l2_arp_entry                        message CRC32 fix
+one_add_del_local_eid                           message CRC32 fix
+one_add_del_map_resolver                        message CRC32 fix
+one_add_del_map_server                          message CRC32 fix
+one_add_del_ndp_entry                           message CRC32 fix
+one_add_del_remote_mapping                      message CRC32 fix
+one_adjacencies_get_reply                       message CRC32 fix
+one_eid_table_details                           message CRC32 fix
+one_eid_table_dump                              message CRC32 fix
+one_l2_arp_entries_get_reply                    message CRC32 fix
+one_locator_details                             message CRC32 fix
+one_map_resolver_details                        message CRC32 fix
+one_map_server_details                          message CRC32 fix
+one_ndp_entries_get_reply                       message CRC32 fix
+one_stats_details                               message CRC32 fix
+one_use_petr                                    message CRC32 fix
+p2p_ethernet_add                                message CRC32 fix
+p2p_ethernet_del                                message CRC32 fix
+pipe_create_reply                               message CRC32 fix
+pipe_details                                    message CRC32 fix
+pnat_binding_add                                only in image
+pnat_binding_add_reply                          only in image
+pnat_binding_attach                             only in image
+pnat_binding_attach_reply                       only in image
+pnat_binding_del                                only in image
+pnat_binding_del_reply                          only in image
+pnat_binding_detach                             only in image
+pnat_binding_detach_reply                       only in image
+pnat_bindings_details                           only in image
+pnat_bindings_get                               only in image
+pnat_bindings_get_reply                         only in image
+pnat_interfaces_details                         only in image
+pnat_interfaces_get                             only in image
+pnat_interfaces_get_reply                       only in image
+policer_add_del                                 message CRC32 fix
+policer_bind                                    only in image
+policer_bind_reply                              only in image
+policer_details                                 message CRC32 fix
+policer_input                                   only in image
+policer_input_reply                             only in image
+pppoe_add_del_session                           message CRC32 fix
+pppoe_session_details                           message CRC32 fix
+proxy_arp_add_del                               message CRC32 fix
+proxy_arp_details                               message CRC32 fix
+punt_socket_deregister                          message CRC32 fix
+punt_socket_details                             message CRC32 fix
+punt_socket_register                            message CRC32 fix
+qos_record_details                              message CRC32 fix
+qos_record_enable_disable                       message CRC32 fix
+qos_store_details                               message CRC32 fix
+qos_store_enable_disable                        message CRC32 fix
+rdma_create_v3                                  only in image
+rdma_create_v3_reply                            only in image
+session_rule_add_del                            message CRC32 fix
+session_rules_details                           message CRC32 fix
+set_ip_flow_hash_router_id                      only in image
+set_ip_flow_hash_router_id_reply                only in image
+set_ip_flow_hash_v2                             only in image
+set_ip_flow_hash_v2_reply                       only in image
+set_ipfix_exporter                              message CRC32 fix
+set_punt                                        message CRC32 fix
+show_lisp_use_petr_reply                        message CRC32 fix
+show_one_use_petr_reply                         message CRC32 fix
+sr_localsid_add_del                             message CRC32 fix
+sr_localsids_details                            message CRC32 fix
+sr_mpls_policy_assign_endpoint_color            message CRC32 fix
+sr_mpls_steering_add_del                        message CRC32 fix
+sr_policies_details                             message CRC32 fix
+sr_policy_add                                   message CRC32 fix
+sr_policy_mod                                   message CRC32 fix
+sr_steering_add_del                             message CRC32 fix
+sr_steering_pol_details                         message CRC32 fix
+stn_add_del_rule                                message CRC32 fix
+stn_rules_details                               message CRC32 fix
+svs_details                                     message CRC32 fix
+svs_route_add_del                               message CRC32 fix
+sw_if_l2tpv3_tunnel_details                     message CRC32 fix
+sw_interface_add_del_address                    message CRC32 fix
+sw_interface_bond_details                       message CRC32 fix
+sw_interface_details                            message CRC32 fix
+sw_interface_event                              message CRC32 fix
+sw_interface_ip6_get_link_local_address         only in image
+sw_interface_ip6_get_link_local_address_reply   only in image
+sw_interface_ip6_set_link_local_address         message CRC32 fix
+sw_interface_ip6nd_ra_prefix                    message CRC32 fix
+sw_interface_lacp_details                       message CRC32 fix
+sw_interface_rx_placement_details               message CRC32 fix
+sw_interface_set_flags                          message CRC32 fix
+sw_interface_set_l2_bridge                      message CRC32 fix
+sw_interface_set_l2_xconnect                    message CRC32 fix
+sw_interface_set_lldp                           message CRC32 fix
+sw_interface_set_mac_address                    message CRC32 fix
+sw_interface_set_promisc                        only in image
+sw_interface_set_promisc_reply                  only in image
+sw_interface_set_rx_mode                        message CRC32 fix
+sw_interface_set_unnumbered                     message CRC32 fix
+sw_interface_span_details                       message CRC32 fix
+sw_interface_span_enable_disable                message CRC32 fix
+sw_interface_tap_v2_details                     message CRC32 fix
+sw_interface_vhost_user_details                 message CRC32 fix
+sw_interface_virtio_pci_details                 message CRC32 fix
+syslog_get_sender_reply                         message CRC32 fix
+syslog_set_sender                               message CRC32 fix
+tap_create_v2                                   message CRC32 fix
+tcp_configure_src_addresses                     message CRC32 fix
+teib_details                                    message CRC32 fix
+teib_entry_add_del                              message CRC32 fix
+udp_encap_add                                   message CRC32 fix
+udp_encap_details                               message CRC32 fix
+udp_ping_add_del                                message CRC32 fix
+virtio_pci_create                               message CRC32 fix
+vmxnet3_details                                 message CRC32 fix
+vrrp_vr_add_del                                 message CRC32 fix
+vrrp_vr_details                                 message CRC32 fix
+vrrp_vr_peer_details                            message CRC32 fix
+vrrp_vr_set_peers                               message CRC32 fix
+vrrp_vr_track_if_add_del                        message CRC32 fix
+vrrp_vr_track_if_details                        message CRC32 fix
+vxlan_add_del_tunnel                            message CRC32 fix
+vxlan_add_del_tunnel_v2                         only in image
+vxlan_add_del_tunnel_v2_reply                   only in image
+vxlan_add_del_tunnel_v3                         only in image
+vxlan_add_del_tunnel_v3_reply                   only in image
+vxlan_gbp_tunnel_add_del                        message CRC32 fix
+vxlan_gbp_tunnel_details                        message CRC32 fix
+vxlan_gpe_add_del_tunnel                        message CRC32 fix
+vxlan_gpe_ioam_export_enable_disable            message CRC32 fix
+vxlan_gpe_ioam_transit_disable                  message CRC32 fix
+vxlan_gpe_ioam_transit_enable                   message CRC32 fix
+vxlan_gpe_ioam_vni_disable                      message CRC32 fix
+vxlan_gpe_ioam_vni_enable                       message CRC32 fix
+vxlan_gpe_tunnel_details                        message CRC32 fix
+vxlan_offload_rx                                message CRC32 fix
+vxlan_tunnel_details                            message CRC32 fix
+vxlan_tunnel_v2_details                         only in image
+vxlan_tunnel_v2_dump                            only in image
+want_ip_neighbor_events                         message CRC32 fix
+want_l2_macs_events2                            only in image
+want_l2_macs_events2_reply                      only in image
+=============================================== ==================
+
+Found 456 api message signature differences
+
+Newly deprecated API messages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+These messages are still there in the API, but can and probably will
+disappear in the next release.
+
+-  application_tls_cert_add
+-  application_tls_cert_add_reply
+-  application_tls_key_add
+-  application_tls_key_add_reply
+-  create_vhost_user_if
+-  create_vhost_user_if_reply
+-  ipsec_sa_details
+-  ipsec_sa_dump
+-  ipsec_sad_entry_add_del
+-  ipsec_sad_entry_add_del_reply
+-  modify_vhost_user_if
+-  modify_vhost_user_if_reply
+-  nat44_ei_add_del_identity_mapping
+-  nat44_ei_add_del_identity_mapping_reply
+-  nat44_ei_add_del_interface_addr
+-  nat44_ei_add_del_interface_addr_reply
+-  nat44_ei_get_addr_and_port_alloc_alg
+-  nat44_ei_get_addr_and_port_alloc_alg_reply
+-  nat44_ei_get_mss_clamping
+-  nat44_ei_get_mss_clamping_reply
+-  nat44_ei_ha_get_failover
+-  nat44_ei_ha_get_failover_reply
+-  nat44_ei_ha_get_listener
+-  nat44_ei_ha_get_listener_reply
+-  nat44_ei_identity_mapping_details
+-  nat44_ei_identity_mapping_dump
+-  nat44_ei_interface_add_del_output_feature
+-  nat44_ei_interface_add_del_output_feature_reply
+-  nat44_ei_interface_addr_details
+-  nat44_ei_interface_addr_dump
+-  nat44_ei_interface_output_feature_details
+-  nat44_ei_interface_output_feature_dump
+-  nat44_ei_set_log_level
+-  nat44_ei_set_log_level_reply
+-  nat44_forwarding_enable_disable
+-  nat44_forwarding_enable_disable_reply
+-  nat44_forwarding_is_enabled
+-  nat44_forwarding_is_enabled_reply
+-  nat44_plugin_enable_disable
+-  nat44_plugin_enable_disable_reply
+-  nat44_session_cleanup
+-  nat44_session_cleanup_reply
+-  nat_control_ping
+-  nat_control_ping_reply
+-  nat_get_timeouts
+-  nat_get_timeouts_reply
+-  nat_ipfix_enable_disable
+-  nat_ipfix_enable_disable_reply
+-  nat_set_log_level
+-  nat_set_log_level_reply
+-  nat_set_timeouts
+-  nat_set_timeouts_reply
+-  nat_show_config
+-  nat_show_config_2
+-  nat_show_config_2_reply
+-  nat_show_config_reply
+-  rdma_create_v2
+-  set_ip_flow_hash
+-  set_ip_flow_hash_reply
+-  want_l2_macs_events
+-  want_l2_macs_events_reply
+
+In-progress API messages
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+These messages are provided for testing and experimentation only. They
+are *not* subject to any compatibility process, and therefore can
+arbitrarily change or disappear at *any* moment. Also they may have less
+than satisfactory testing, making them unsuitable for other use than the
+technology preview. If you are intending to use these messages in
+production projects, please collaborate with the feature maintainer on
+their productization.
+
+-  abf_itf_attach_add_del
+-  abf_itf_attach_add_del_reply
+-  abf_itf_attach_details
+-  abf_itf_attach_dump
+-  abf_plugin_get_version
+-  abf_plugin_get_version_reply
+-  abf_policy_add_del
+-  abf_policy_add_del_reply
+-  abf_policy_details
+-  abf_policy_dump
+-  adl_allowlist_enable_disable
+-  adl_allowlist_enable_disable_reply
+-  adl_interface_enable_disable
+-  adl_interface_enable_disable_reply
+-  af_xdp_create
+-  af_xdp_create_reply
+-  af_xdp_delete
+-  af_xdp_delete_reply
+-  cnat_get_snat_addresses
+-  cnat_get_snat_addresses_reply
+-  cnat_session_details
+-  cnat_session_dump
+-  cnat_session_purge
+-  cnat_session_purge_reply
+-  cnat_set_snat_addresses
+-  cnat_set_snat_addresses_reply
+-  cnat_set_snat_policy
+-  cnat_set_snat_policy_reply
+-  cnat_snat_policy_add_del_exclude_pfx
+-  cnat_snat_policy_add_del_exclude_pfx_reply
+-  cnat_snat_policy_add_del_if
+-  cnat_snat_policy_add_del_if_reply
+-  cnat_translation_del
+-  cnat_translation_del_reply
+-  cnat_translation_details
+-  cnat_translation_dump
+-  cnat_translation_update
+-  cnat_translation_update_reply
+-  crypto_sw_scheduler_set_worker
+-  crypto_sw_scheduler_set_worker_reply
+-  det44_get_timeouts_reply
+-  det44_interface_add_del_feature
+-  det44_interface_add_del_feature_reply
+-  det44_interface_details
+-  det44_interface_dump
+-  det44_plugin_enable_disable
+-  det44_plugin_enable_disable_reply
+-  det44_set_timeouts
+-  det44_set_timeouts_reply
+-  flow_add
+-  flow_add_reply
+-  flow_del
+-  flow_del_reply
+-  flow_disable
+-  flow_disable_reply
+-  flow_enable
+-  flow_enable_reply
+-  gbp_bridge_domain_add
+-  gbp_bridge_domain_add_reply
+-  gbp_bridge_domain_del
+-  gbp_bridge_domain_del_reply
+-  gbp_bridge_domain_details
+-  gbp_bridge_domain_dump
+-  gbp_bridge_domain_dump_reply
+-  gbp_contract_add_del
+-  gbp_contract_add_del_reply
+-  gbp_contract_details
+-  gbp_contract_dump
+-  gbp_endpoint_add
+-  gbp_endpoint_add_reply
+-  gbp_endpoint_del
+-  gbp_endpoint_del_reply
+-  gbp_endpoint_details
+-  gbp_endpoint_dump
+-  gbp_endpoint_group_add
+-  gbp_endpoint_group_add_reply
+-  gbp_endpoint_group_del
+-  gbp_endpoint_group_del_reply
+-  gbp_endpoint_group_details
+-  gbp_endpoint_group_dump
+-  gbp_ext_itf_add_del
+-  gbp_ext_itf_add_del_reply
+-  gbp_ext_itf_details
+-  gbp_ext_itf_dump
+-  gbp_recirc_add_del
+-  gbp_recirc_add_del_reply
+-  gbp_recirc_details
+-  gbp_recirc_dump
+-  gbp_route_domain_add
+-  gbp_route_domain_add_reply
+-  gbp_route_domain_del
+-  gbp_route_domain_del_reply
+-  gbp_route_domain_details
+-  gbp_route_domain_dump
+-  gbp_route_domain_dump_reply
+-  gbp_subnet_add_del
+-  gbp_subnet_add_del_reply
+-  gbp_subnet_details
+-  gbp_subnet_dump
+-  gbp_vxlan_tunnel_add
+-  gbp_vxlan_tunnel_add_reply
+-  gbp_vxlan_tunnel_del
+-  gbp_vxlan_tunnel_del_reply
+-  gbp_vxlan_tunnel_details
+-  gbp_vxlan_tunnel_dump
+-  ikev2_child_sa_details
+-  ikev2_child_sa_dump
+-  ikev2_initiate_del_child_sa
+-  ikev2_initiate_del_child_sa_reply
+-  ikev2_initiate_del_ike_sa
+-  ikev2_initiate_del_ike_sa_reply
+-  ikev2_initiate_rekey_child_sa
+-  ikev2_initiate_rekey_child_sa_reply
+-  ikev2_initiate_sa_init
+-  ikev2_initiate_sa_init_reply
+-  ikev2_nonce_get
+-  ikev2_nonce_get_reply
+-  ikev2_profile_add_del
+-  ikev2_profile_add_del_reply
+-  ikev2_profile_details
+-  ikev2_profile_disable_natt
+-  ikev2_profile_disable_natt_reply
+-  ikev2_profile_dump
+-  ikev2_profile_set_auth
+-  ikev2_profile_set_auth_reply
+-  ikev2_profile_set_id
+-  ikev2_profile_set_id_reply
+-  ikev2_profile_set_ipsec_udp_port
+-  ikev2_profile_set_ipsec_udp_port_reply
+-  ikev2_profile_set_liveness
+-  ikev2_profile_set_liveness_reply
+-  ikev2_profile_set_ts
+-  ikev2_profile_set_ts_reply
+-  ikev2_profile_set_udp_encap
+-  ikev2_profile_set_udp_encap_reply
+-  ikev2_sa_details
+-  ikev2_sa_dump
+-  ikev2_set_esp_transforms
+-  ikev2_set_esp_transforms_reply
+-  ikev2_set_ike_transforms
+-  ikev2_set_ike_transforms_reply
+-  ikev2_set_local_key
+-  ikev2_set_local_key_reply
+-  ikev2_set_responder
+-  ikev2_set_responder_hostname
+-  ikev2_set_responder_hostname_reply
+-  ikev2_set_responder_reply
+-  ikev2_set_sa_lifetime
+-  ikev2_set_sa_lifetime_reply
+-  ikev2_set_tunnel_interface
+-  ikev2_set_tunnel_interface_reply
+-  ikev2_traffic_selector_details
+-  ikev2_traffic_selector_dump
+-  ip_route_add_del_v2
+-  ip_route_add_del_v2_reply
+-  ip_route_lookup_v2
+-  ip_route_lookup_v2_reply
+-  ip_route_v2_details
+-  ip_route_v2_dump
+-  l2_emulation
+-  l2_emulation_reply
+-  mdata_enable_disable
+-  mdata_enable_disable_reply
+-  nat44_add_del_static_mapping_v2
+-  nat44_add_del_static_mapping_v2_reply
+-  nat44_ed_plugin_enable_disable
+-  nat44_ed_plugin_enable_disable_reply
+-  nat44_ed_set_fq_options
+-  nat44_ed_set_fq_options_reply
+-  nat44_ed_show_fq_options
+-  nat44_ed_show_fq_options_reply
+-  nat44_ei_add_del_address_range
+-  nat44_ei_add_del_address_range_reply
+-  nat44_ei_add_del_static_mapping
+-  nat44_ei_add_del_static_mapping_reply
+-  nat44_ei_address_details
+-  nat44_ei_address_dump
+-  nat44_ei_del_session
+-  nat44_ei_del_session_reply
+-  nat44_ei_del_user
+-  nat44_ei_del_user_reply
+-  nat44_ei_forwarding_enable_disable
+-  nat44_ei_forwarding_enable_disable_reply
+-  nat44_ei_ha_flush
+-  nat44_ei_ha_flush_reply
+-  nat44_ei_ha_resync
+-  nat44_ei_ha_resync_completed_event
+-  nat44_ei_ha_resync_reply
+-  nat44_ei_ha_set_failover
+-  nat44_ei_ha_set_failover_reply
+-  nat44_ei_ha_set_listener
+-  nat44_ei_ha_set_listener_reply
+-  nat44_ei_interface_add_del_feature
+-  nat44_ei_interface_add_del_feature_reply
+-  nat44_ei_interface_details
+-  nat44_ei_interface_dump
+-  nat44_ei_ipfix_enable_disable
+-  nat44_ei_ipfix_enable_disable_reply
+-  nat44_ei_plugin_enable_disable
+-  nat44_ei_plugin_enable_disable_reply
+-  nat44_ei_set_addr_and_port_alloc_alg
+-  nat44_ei_set_addr_and_port_alloc_alg_reply
+-  nat44_ei_set_fq_options
+-  nat44_ei_set_fq_options_reply
+-  nat44_ei_set_mss_clamping
+-  nat44_ei_set_mss_clamping_reply
+-  nat44_ei_set_timeouts
+-  nat44_ei_set_timeouts_reply
+-  nat44_ei_set_workers
+-  nat44_ei_set_workers_reply
+-  nat44_ei_show_fq_options
+-  nat44_ei_show_fq_options_reply
+-  nat44_ei_show_running_config
+-  nat44_ei_show_running_config_reply
+-  nat44_ei_static_mapping_details
+-  nat44_ei_static_mapping_dump
+-  nat44_ei_user_details
+-  nat44_ei_user_dump
+-  nat44_ei_user_session_details
+-  nat44_ei_user_session_dump
+-  nat44_ei_worker_details
+-  nat44_ei_worker_dump
+-  nat44_show_running_config
+-  nat44_show_running_config_reply
+-  nat64_plugin_enable_disable
+-  nat64_plugin_enable_disable_reply
+-  oddbuf_enable_disable
+-  oddbuf_enable_disable_reply
+-  pg_interface_enable_disable_coalesce
+-  pg_interface_enable_disable_coalesce_reply
+-  pnat_binding_add
+-  pnat_binding_add_reply
+-  pnat_binding_attach
+-  pnat_binding_attach_reply
+-  pnat_binding_del
+-  pnat_binding_del_reply
+-  pnat_binding_detach
+-  pnat_binding_detach_reply
+-  pnat_bindings_details
+-  pnat_bindings_get
+-  pnat_bindings_get_reply
+-  pnat_interfaces_details
+-  pnat_interfaces_get
+-  pnat_interfaces_get_reply
+-  sample_macswap_enable_disable
+-  sample_macswap_enable_disable_reply
+-  sr_policies_with_sl_index_details
+-  sr_policies_with_sl_index_dump
+-  sw_interface_set_vxlan_gbp_bypass
+-  sw_interface_set_vxlan_gbp_bypass_reply
+-  test_addresses
+-  test_addresses2
+-  test_addresses2_reply
+-  test_addresses3
+-  test_addresses3_reply
+-  test_addresses_reply
+-  test_empty
+-  test_empty_reply
+-  test_enum
+-  test_enum_reply
+-  test_interface
+-  test_interface_reply
+-  test_prefix
+-  test_prefix_reply
+-  test_string
+-  test_string2
+-  test_string2_reply
+-  test_string_reply
+-  test_vla
+-  test_vla2
+-  test_vla2_reply
+-  test_vla3
+-  test_vla3_reply
+-  test_vla4
+-  test_vla4_reply
+-  test_vla5
+-  test_vla5_reply
+-  test_vla_reply
+-  trace_capture_packets
+-  trace_capture_packets_reply
+-  trace_clear_capture
+-  trace_clear_capture_reply
+-  trace_details
+-  trace_dump
+-  trace_dump_reply
+-  trace_set_filters
+-  trace_set_filters_reply
+-  vxlan_gbp_tunnel_add_del
+-  vxlan_gbp_tunnel_add_del_reply
+-  vxlan_gbp_tunnel_details
+-  vxlan_gbp_tunnel_dump
+-  wireguard_interface_create
+-  wireguard_interface_create_reply
+-  wireguard_interface_delete
+-  wireguard_interface_delete_reply
+-  wireguard_interface_details
+-  wireguard_interface_dump
+-  wireguard_peer_add
+-  wireguard_peer_add_reply
+-  wireguard_peer_remove
+-  wireguard_peer_remove_reply
+-  wireguard_peers_details
+-  wireguard_peers_dump
+
+Patches that changed API definitions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. |clk| replace:: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commit;h=
+
+``src/vnet/policer/policer_types.api``
+
+* `c5299ff30 `_  policer: remove SSE2 prefix
+
+``src/vnet/policer/policer.api``
+
+* `b04683017 `_  policer: add api to configure input policing
+* `48e26367c `_  policer: add api to bind policer to worker
+
+``src/vnet/session/session.api``
+
+* `a5a9efd4d `_  vcl session: switch to generic cert key apis
+
+``src/vnet/ipfix-export/ipfix_export.api``
+
+* `baa18701b `_  misc: ipfix process node wait time adjustment
+
+``src/vnet/ipsec/ipsec_types.api``
+
+* `f16e9a550 `_  ipsec: Support async mode per-SA
+* `9ec846c26 `_  ipsec: Use the new tunnel API types to add flow label and TTL copy support
+* `751bb131e `_  Revert "ipsec: Use the new tunnel API types to add flow label and TTL copy"
+* `c7eaa711f `_  ipsec: Use the new tunnel API types to add flow label and TTL copsupport
+
+``src/vnet/ipsec/ipsec.api``
+
+* `9ec846c26 `_  ipsec: Use the new tunnel API types to add flow label and TTL copsupport
+* `751bb131e `_  Revert "ipsec: Use the new tunnel API types to add flow label and TTL copy"
+* `c7eaa711f `_  ipsec: Use the new tunnel API types to add flow label and TTL copy support
+* `a9e2774f5 `_  ipsec: Deprecated the old IPsec Tunnel interface
+* `95f59f380 `_  ipsec: Mark the interface create reply deprecated
+
+``src/vnet/devices/virtio/vhost_user.api``
+
+* `27ba5008a `_  vhost: Add event index for interrupt notification to driver
+
+``src/vnet/ip/ip.api``
+
+* `976b259be `_  fib: Allow the creation of new source on the API
+* `8f5fef2c7 `_  ip: Path MTU
+* `3d5f08a82 `_  ip: Router ID included in flow hash
+* `f2984bbb0 `_  ip: use IPv6 flowlabel in flow hash computation
+* `58a1915b5 `_  ip: add API to retrieve IPv6 link-layer address
+
+``src/vnet/l2/l2.api``
+
+* `0f8d10035 `_  l2: Separating scan-delay and learn-limit into a separate API from want_l2_macs_events
+* `5f93e3b7f `_  l2: add per bridge domain learn limit
+
+``src/vnet/flow/flow_types.api``
+
+* `91f102ed8 `_  flow: The type of vni in VxLAN flow should be u32
+
+``src/vnet/flow/flow.api``
+
+* `c7e7819ad `_  flow: Add API implementation of IP4/IP6, IP4_VXLAN/IP6_VXLAN
+
+``src/vnet/fib/fib_types.api``
+
+* `976b259be `_  fib: Allow the creation of new source on the API
+
+``src/vnet/fib/fib.api``
+
+* `976b259be `_  fib: Allow the creation of new source on the API
+
+``src/vnet/vxlan/vxlan.api``
+
+* `3e38422ab `_  vxlan: Fix L3 mode
+* `839dcc0fb `_  vxlan: add udp-port configuration support
+
+``src/vnet/bfd/bfd.api``
+
+* `4376ab2a9 `_  tests: use socket transport instead of shared memory
+
+``src/vnet/interface.api``
+
+* `fd0b399ff `_  interface: Add promisc on/off in api
+
+``src/vnet/tunnel/tunnel_types.api``
+
+* `a91cb4590 `_  tunnel: support copying TTL and flow label from inner to outer
+
+``src/vnet/interface_types.api``
+
+* `6a999d67d `_  interface: RX/TX direction type in API
+
+``src/vat2/test/vat2_test.api``
+
+* `ab9f57355 `_  api: crchcecker ignore version < 1.0.0 and outside of src directory
+* `71134f26a `_  vat2: jsonconvert return checking - coverity
+* `93c4b1bb3 `_  vppapigen: more _fromjson autogeneration coverity fixes
+* `316967cfa `_  vppapigen: fix coverity issues in jsonconvert
+* `cf0102b3b `_  vppapigen: coverity issues in autogenerated code pass 3.
+* `fb0afab7f `_  vppapigen: fix fromjson coverity errors in generation
+
+``src/plugins/gbp/gbp.api``
+
+* `dc22c839f `_  tests: clean up gbp calls from vpp_papi_provider
+
+``src/plugins/map/map.api``
+
+* `9302cfea9 `_  vppapigen: Support an 'autoendian' keyword for message definitions i.api files |
+
+``src/plugins/arping/arping.api``
+
+* `a77ae4708 `_  arping: add arping command
+
+``src/plugins/linux-cp/lcp.api``
+
+* `6bb77dec7 `_  linux-cp: A V2 variant of pair create API that returns the hosinterface created |
+* `4376ab2a9 `_  tests: use socket transport instead of shared memory
+* `44db1caef `_  linux-cp: Linux Interface Mirroring for Control Plane Integration
+
+``src/plugins/ikev2/ikev2_types.api``
+
+* `68d275356 `_  ikev2: add per SA stats
+
+``src/plugins/ikev2/ikev2.api``
+
+* `af2cc6425 `_  ikev2: support responder hostname
+* `68d275356 `_  ikev2: add per SA stats
+* `fab5e7f39 `_  ikev2: use new counters data model & add more counters
+
+``src/plugins/nat/det44/det44.api``
+
+* `0eaf4e678 `_  nat: Final NAT44 EI/ED split patch
+
+``src/plugins/nat/nat44-ed/nat44_ed.api``
+
+* `e3f078fcf `_  nat: fix byte order on ipfix message fields
+* `e7a80a98b `_  nat: NAT44ED fail if using old plugin option
+* `0eaf4e678 `_  nat: Final NAT44 EI/ED split patch
+
+``src/plugins/nat/nat64/nat64.api``
+
+* `0eaf4e678 `_  nat: Final NAT44 EI/ED split patch
+
+``src/plugins/nat/nat66/nat66.api``
+
+* `ed2ee5e57 `_  nat: NAT66 plugin enable&disable calls update
+* `0eaf4e678 `_  nat: Final NAT44 EI/ED split patch
+
+``src/plugins/nat/pnat/pnat.api``
+
+* `ec34fb772 `_  pnat: coverity errors
+* `ab3151c52 `_  nat: pnat copy and clear byte instructions
+* `18327be5d `_  nat: 1:1 policy NAT
+
+``src/plugins/nat/lib/nat_types.api``
+
+* `0eaf4e678 `_  nat: Final NAT44 EI/ED split patch
+
+``src/plugins/nat/nat44-ei/nat44_ei.api``
+
+* `01930f568 `_  nat: report correct EI per-user session limit
+* `e3f078fcf `_  nat: fix byte order on ipfix message fields
+* `0eaf4e678 `_  nat: Final NAT44 EI/ED split patch
+
+``src/plugins/af_xdp/af_xdp.api``
+
+* `a42c41be4 `_  af_xdp: workaround kernel race between poll() and sendmsg()
+
+``src/plugins/mss_clamp/mss_clamp.api``
+
+* `bf55e9931 `_  mss_clamp: TCP MSS clamping plugin
+
+``src/plugins/rdma/rdma.api``
+
+* `f5a45680e `_  rdma: add support for RSS configuration
+
+``src/plugins/cnat/cnat.api``
+
+* `516b0adf6 `_  cnat: Add calico/k8s src policy
+* `3fd77f7de `_  cnat: Prepare extended snat policies
+* `cc9a1a0d3 `_  cnat: add input feature node
+* `4d237874e `_  cnat: Add maglev support
+* `27647a27c `_  cnat: fixes & prepare maglev
diff --git a/docs/aboutvpp/releasenotes/v21.10.rst b/docs/aboutvpp/releasenotes/v21.10.rst
new file mode 100644
index 00000000000..ba3a01aee22
--- /dev/null
+++ b/docs/aboutvpp/releasenotes/v21.10.rst
@@ -0,0 +1,4 @@
+Release notes for VPP 21.10
+===========================
+
+TBD
diff --git a/docs/aboutvpp/scalar-vs-vector-packet-processing.rst b/docs/aboutvpp/scalar-vs-vector-packet-processing.rst
new file mode 100644
index 00000000000..173efecebc5
--- /dev/null
+++ b/docs/aboutvpp/scalar-vs-vector-packet-processing.rst
@@ -0,0 +1,69 @@
+.. _scalar_vector:
+
+==================================
+Scalar vs Vector packet processing
+==================================
+
+FD.io VPP is developed using vector packet processing, as opposed to
+scalar packet processing.
+
+Vector packet processing is a common approach among high performance packet
+processing applications such FD.io VPP and `DPDK `_.
+The scalar based approach tends to be favoured by network stacks that
+don't necessarily have strict performance requirements.
+
+**Scalar Packet Processing**
+
+A scalar packet processing network stack typically processes one packet at a
+time: an interrupt handling function takes a single packet from a Network
+Interface, and processes it through a set of functions: fooA calls fooB calls
+fooC and so on.
+
+.. code-block:: none
+
+   +---> fooA(packet1) +---> fooB(packet1) +---> fooC(packet1)
+   +---> fooA(packet2) +---> fooB(packet2) +---> fooC(packet2)
+   ...
+   +---> fooA(packet3) +---> fooB(packet3) +---> fooC(packet3)
+
+
+Scalar packet processing is simple, but inefficient in these ways:
+
+* When the code path length exceeds the size of the Microprocessor's instruction
+  cache (I-cache), `thrashing
+  `_ occurs as the
+  Microprocessor is continually loading new instructions. In this model, each
+  packet incurs an identical set of I-cache misses.
+* The associated deep call stack will also add load-store-unit pressure as
+  stack-locals fall out of the Microprocessor's Layer 1 Data Cache (D-cache).
+
+**Vector Packet Processing**
+
+In contrast, a vector packet processing network stack processes multiple packets
+at a time, called 'vectors of packets' or simply a 'vector'. An interrupt
+handling function takes the vector of packets from a Network Interface, and
+processes the vector through a set of functions: fooA calls fooB calls fooC and
+so on.
+
+.. code-block:: none
+
+   +---> fooA([packet1, +---> fooB([packet1, +---> fooC([packet1, +--->
+               packet2,             packet2,             packet2,
+               ...                  ...                  ...
+               packet256])          packet256])          packet256])
+
+This approach fixes:
+
+* The I-cache thrashing problem described above, by amortizing the cost of
+  I-cache loads across multiple packets.
+
+* The inefficiencies associated with the deep call stack by receiving vectors
+  of up to 256 packets at a time from the Network Interface, and processes them
+  using a directed graph of node. The graph scheduler invokes one node dispatch
+  function at a time, restricting stack depth to a few stack frames.
+
+The further optimizations that this approaches enables are pipelining and
+prefetching to minimize read latency on table data and parallelize packet loads
+needed to process packets.
+
+Press next for more on Packet Processing Graphs.
diff --git a/docs/aboutvpp/supported.rst b/docs/aboutvpp/supported.rst
new file mode 100644
index 00000000000..077090bad9e
--- /dev/null
+++ b/docs/aboutvpp/supported.rst
@@ -0,0 +1,28 @@
+.. _supported:
+
+.. toctree::
+
+Supported archs and OS
+**********************
+
+The following architectures and operating systems are supported in VPP:
+
+Architectures
+-------------
+
+* The FD.io VPP platform supports:
+
+   * x86/64
+   * ARM-AArch64
+
+Operating Systems and Packaging
+-------------------------------
+
+FD.io VPP supports package installation on the following
+recent LTS releases:
+
+* Distributions:
+
+   * Debian
+   * Ubuntu
+
diff --git a/docs/cli-reference/gettingstarted/index.rst b/docs/cli-reference/gettingstarted/index.rst
new file mode 100644
index 00000000000..6528725de45
--- /dev/null
+++ b/docs/cli-reference/gettingstarted/index.rst
@@ -0,0 +1,126 @@
+.. _cli_getting_started:
+
+Getting Started with the debug CLI
+==================================
+
+The VPP network stack comes equipped with a set of commands that are useful
+for debugging.
+
+The easiest way to access the CLI (with proper permissions) is to use the
+vppctl command:
+
+.. code-block:: console
+
+    sudo vppctl 
+
+
+The CLI parser matches static keyword strings, eventually invoking an action
+function. Unambiguous partial keyword matching always occurs. The action
+functions consume input until satisfied or until they fail. This model makes
+for easy coding, but does not guarantee useful "help" output. It's up to the
+CLI command writer to add useful help strings.
+
+You can find the source code of CLI commands by searching for instances of the
+``VLIB_CLI_COMMAND`` macro in the code source files.
+
+Please help maintain and improve this document to make and keep these commands
+clear and useful!
+
+.. _debug_telnet_cli:
+
+Debug and Telnet CLI
+--------------------
+
+The debug CLI is enabled with the unix interactive parameter or startup
+configuration option. This causes VPP to start without daemonizing and
+presents a command line interface on the terminal where it is run.
+
+The Telnet CLI is enabled with the ``cli-listen localhost:5002`` option which
+will cause VPP to listen for TCP connections on the localhost address port
+``5002``. A Telnet client can then connect to this port (for example, ``telnet
+localhost 5002``) and will receive a command line prompt.
+
+This configuration will enable both mechanisms:
+
+.. code-block:: console
+
+    unix {
+      interactive
+      cli-listen localhost:5002
+    }
+
+
+The debug CLI can operate in line mode, which may be useful when running
+inside an IDE like Emacs. This is enabled with the option
+``unix cli-line-mode``. Several other options exist that alter how this
+CLI works, see the @ref syscfg section for details.
+
+The CLI starts with a banner graphic (which can be disabled) and a prompt. The
+prompt will typically read ``vpp`` for a release version of VPP and ``DBGvpp#``
+for a development version with debugging enabled, for example:
+
+.. code-block:: console
+
+        _______    _        _   _____  ___
+     __/ __/ _ \  (_)__    | | / / _ \/ _ \
+     _/ _// // / / / _ \   | |/ / ___/ ___/
+     /_/ /____(_)_/\___/   |___/_/  /_/
+
+    vpp#
+
+
+
+versus:
+
+.. code-block:: console
+
+        _______    _        _   _____  ___
+     __/ __/ _ \  (_)__    | | / / _ \/ _ \
+     _/ _// // / / / _ \   | |/ / ___/ ___/
+     /_/ /____(_)_/\___/   |___/_/  /_/
+
+    DBGvpp#
+
+
+This prompt can be configured with the ``unix cli-prompt`` setting and the
+banner is disabled with ``unix cli-no-banner``.
+
+.. _cli_features:
+
+CLI features
+------------
+
+The CLI has several editing features that make it easy to use.
+
+- Cursor keys ``left/right`` will move the cursor within a command line;
+  typing will insert at the cursor; erase will erase at the cursor.
+
+- ``Ctrl-left/right`` will search for the start of the next word to
+  the left or right.
+- ``Home/end`` will jump the cursor to the start and end of the line.
+- Cursor keys up/down and ``^P/^N`` iterate through the command history
+  buffer. Lines from the history buffer may be edited. New commands
+  are added to the end of the buffer when executed; though
+  duplicates of the previous command are not added.
+- ``^U`` erases the line contents from the left of the cursor to the
+  start.
+- ``^K`` erases the contents from the cursor to the end.
+- ``^S/^R`` will search the command history forwards or in reverse for
+  a command; start typing for matches to auto complete.
+- ``^L`` will clear the screen (if supported by the terminal) and repaint
+  the prompt and any current line. The cursor position is also
+  retained.
+- The CLI can be closed with the quit command. Alternatively, ``^D`` on
+  an empty input line will also close the session. Closing the debug
+  session will also shutdown VPP.
+
+Output that exceeds the length of a terminal page will be buffered, up to a
+limit.
+
+- ``Space`` or ``page-down`` displays the next page.
+- ``Enter`` or ``down-arrow`` displays the next line.
+- ``Page-up`` goes back a page.
+- ``Up-arrow`` goes up a line.
+- ``Home/end`` jump to the start/end of the buffered output.
+- The key ``q`` quits the pager. ``Space`` and ``enter`` will also quit the
+  pager if the end of the buffer has been reached.
\ No newline at end of file
diff --git a/docs/cli-reference/interface/basic.rst b/docs/cli-reference/interface/basic.rst
new file mode 100644
index 00000000000..2d4202dfc57
--- /dev/null
+++ b/docs/cli-reference/interface/basic.rst
@@ -0,0 +1,83 @@
+.. _interface:
+
+.. toctree::
+
+Basic Interface Commands
+=========================
+
+There are several commands that are associated to Basic Interface:
+
+* `Show Interface`_
+* `Clear Interfaces`_
+
+.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents `_ .
+
+.. _showintcommand:
+
+Show Interface
+++++++++++++++++
+Shows software interface information including counters and features.
+
+.. code-block:: shell
+
+    show interface [address|addr|features|feat] [ [ [..]]]
+
+Examples
+--------
+
+Example of how to show the interface counters:
+
+.. code-block:: console
+
+    vpp# show int
+                  Name               Idx       State          Counter          Count
+    TenGigabitEthernet86/0/0          1         up       rx packets               6569213
+                                                         rx bytes              9928352943
+                                                         tx packets                 50384
+                                                         tx bytes                 3329279
+    TenGigabitEthernet86/0/1          2        down
+    VirtualEthernet0/0/0              3         up       rx packets                 50384
+                                                         rx bytes                 3329279
+                                                         tx packets               6569213
+                                                         tx bytes              9928352943
+                                                         drops                       1498
+    local0                            0        down
+
+Example of how to display the interface placement:
+
+.. code-block:: console
+
+    vpp# show interface rx-placement
+    Thread 1 (vpp_wk_0):
+      node dpdk-input:
+        GigabitEthernet7/0/0 queue 0 (polling)
+      node vhost-user-input:
+        VirtualEthernet0/0/12 queue 0 (polling)
+        VirtualEthernet0/0/12 queue 2 (polling)
+        VirtualEthernet0/0/13 queue 0 (polling)
+        VirtualEthernet0/0/13 queue 2 (polling)
+    Thread 2 (vpp_wk_1):
+      node dpdk-input:
+        GigabitEthernet7/0/1 queue 0 (polling)
+      node vhost-user-input:
+        VirtualEthernet0/0/12 queue 1 (polling)
+        VirtualEthernet0/0/12 queue 3 (polling)
+        VirtualEthernet0/0/13 queue 1 (polling)
+        VirtualEthernet0/0/13 queue 3 (polling)
+
+Clear Interfaces
++++++++++++++++++
+Clear the statistics for all interfaces (statistics associated with the
+'*show interface*' command).
+
+.. code-block:: shell
+
+    clear interfaces
+
+Example
+-------
+Example of how to clear the statistics for all interfaces:
+
+.. code-block:: console
+
+    vpp# clear interfaces
diff --git a/docs/cli-reference/interface/create_interface.rst b/docs/cli-reference/interface/create_interface.rst
new file mode 100644
index 00000000000..abd1f40de04
--- /dev/null
+++ b/docs/cli-reference/interface/create_interface.rst
@@ -0,0 +1,223 @@
+.. _interface:
+
+.. toctree::
+
+Create Interfaces Commands
+===========================
+This section contains those interface commands that are associated to creating an interface:
+
+* `Create Host-Interface`_
+* `Create Interface Memif`_
+* `Create Loopback Interface`_
+* `Create Sub-Interfaces`_
+
+.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents `_ .
+
+Create Host-Interface
+++++++++++++++++++++++
+
+.. code-block:: console
+
+    create host-interface name <*ifname*> [*hw-addr <*mac-addr*>]
+
+
+Description
+------------
+
+Create a host interface that will attach to a linux AF_PACKET interface, one side of a veth pair.
+The veth pair must already exist. Once created, a new host interface will exist in VPP with the name
+'host-<*ifname*>', where '<*ifname*>' is the name of the specified veth pair.
+Use the `show interface` command to display host interface details.
+
+This command has the following optional parameters:
+
+    hw-addr <*mac-addr*> - Optional ethernet address, can be in either X:X:X:X:X:X unix or X.X.X cisco format
+
+Example Usage
+-------------
+
+Example of how to create a host interface tied to one side of an existing linux veth pair named vpp1:
+
+	.. code-block:: console
+
+		vpp# create host-interface name vpp1
+
+		host-vpp1
+
+Once the host interface is created, enable the interface using:
+
+	.. code-block:: console
+
+		vpp# set interface state host-vpp1 up
+
+Declaration and Implementation
+-------------------------------
+
+**Declaration:** af_packet_create_command (src/vnet/devices/af_packet/cli.c line 133)
+
+**Implementation:** af_packet_create_command_fn
+
+Create Interface Memif
++++++++++++++++++++++++
+
+.. code-block:: console
+
+    create interface memif [id <*id*>] [socket-id <*socket-id*>] [ring-size <*size*>] [buffer-size <*size*>] [hw-addr <*mac-address*>]  [rx-queues <*number*>] [tx-queues <*number*>] [mode ip] [secret <*string*>]
+
+
+Declaration and Implementation
+-------------------------------
+
+**Declaration:** memif_create_command (src/plugins/memif/cli.c line 258)
+
+**Implementation:** memif_create_command_fn
+
+
+Create Loopback Interface
+++++++++++++++++++++++++++
+
+
+Create a loopback interface. Optionally, a MAC Address can be provided. If not provided, de:ad:00:00:00:<*loopId*> will be used.
+
+.. code-block:: console
+
+    create loopback interface [mac <*mac-addr*>] [instance <*instance*>]
+
+
+Example Usage
+--------------
+The following two command syntaxes are equivalent:
+
+	.. code-block:: console
+
+		vpp# loopback create-interface [mac <*mac-addr*>] [instance <*instance*>]
+
+		vpp# create loopback interface [mac <*mac-addr*>] [instance <*instance*>]
+
+Example of how to create a loopback interface:
+
+	.. code-block:: console
+
+		vpp# create loopback interface
+
+Declaration and Implementation
+-------------------------------
+
+**Declaration:** create_loopback_interface_command (src/vnet/ethernet/interface.c line 879)
+
+**Implementation:** create_simulated_ethernet_interfaces
+
+
+Create Sub-Interfaces
+++++++++++++++++++++++
+
+This command is used to add VLAN IDs to interfaces, also known as
+subinterfaces. The primary input to this command is the *interface*
+and *subId* (subinterface Id) parameters. If no additional VLAN ID is
+provide, the VLAN ID is assumed to be the *subId*. The VLAN ID and
+*subId* can be different, but this is not recommended.
+
+This command has several variations:
+
+-  **create sub-interfaces** <*interface*> <*subId*> - Create a subinterface
+   to process packets with a given 802.1q VLAN ID (same value as the
+   *subId*).
+-  **create sub-interfaces** <*interface*> <*subId*> default - Adding the
+   *default* parameter indicates that packets with VLAN IDs that do
+   not match any other subinterfaces should be sent to this
+   subinterface.
+-  **create sub-interfaces** <*interface*> <*subId*> untagged - Adding the
+   *untagged* parameter indicates that packets no VLAN IDs should be
+   sent to this subinterface.
+-  **create sub-interfaces** <*interface*> <*subId*>-<*subId*> - Create a
+   range of subinterfaces to handle a range of VLAN IDs.
+-  **create sub-interfaces** <*interface*> <*subId*> dot1q|dot1ad <*vlanId*>|any
+   [exact-match] - Use this command to explicitly specify the outer VLAN ID,
+   or to make the VLAN ID different from the *subId*.
+-  **create sub-interfaces** <*interface*> <*subId*> dot1q|dot1ad <*vlanId*>|any
+   inner-dot1q <*vlanId*>|any [exact-match] - Use this command to
+   specify the outer VLAN ID and the inner VLAN ID.
+
+When *dot1q* or *dot1ad* is explicitly entered, subinterfaces can be
+configured as either *exact-match* or *non-exact match*. *Non-exact match* is
+the CLI default. If *exact-match* is specified, packets must have the
+same number of VLAN tags as the configuration. For *non-exact-match*,
+packets must at least that number of tags. L3 (routed) interfaces must
+be configured as exact-match. L2 interfaces are typically configured as
+non-exact-match. If *dot1q* or *dot1ad* is NOT entered, then the
+default behavior is *exact-match*.
+
+Use the **show interface** command to display all subinterfaces.
+
+Summary/Usage
+-------------
+
+.. code-block:: shell
+
+    create sub-interfaces  { [default|untagged]} | {-} | { dot1q|dot1ad |any [inner-dot1q |any] [exact-match]}
+
+Example Usage
+--------------
+
+Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11
+
+The previous example is shorthand and is equivalent to:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match
+
+Example of how to create a subinterface number that is different from the VLAN ID:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100
+
+Examples of how to create q-in-q and q-in-any subinterfaces:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200
+    vpp# create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any
+
+Examples of how to create dot1ad interfaces:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11
+    vpp# create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200
+
+Examples of *exact-match* versus non-exact match. A packet with outer VLAN 100 and inner VLAN 200 would match this interface, because the default is non-exact match:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100
+
+However, the same packet would NOT match this interface because *exact-match* is specified and only one VLAN is configured, but packet contains two VLANs:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match
+
+Example of how to created a subinterface to process untagged packets:
+
+.. code-block:: console
+
+   vpp# create sub-interfaces GigabitEthernet2/0/0 5 untagged
+
+Example of how to created a subinterface to process any packet with a VLAN ID that does not match any other subinterface:
+
+.. code-block:: console
+
+    vpp# create sub-interfaces GigabitEthernet2/0/0 7 default
+
+When subinterfaces are created, they are in the down state. Example of how to enable a newly created subinterface:
+
+.. code-block:: console
+
+    vpp# set interface GigabitEthernet2/0/0.7 up
+
diff --git a/docs/cli-reference/interface/hardware.rst b/docs/cli-reference/interface/hardware.rst
new file mode 100644
index 00000000000..0d124385fac
--- /dev/null
+++ b/docs/cli-reference/interface/hardware.rst
@@ -0,0 +1,161 @@
+.. _interface:
+
+.. toctree::
+
+Hardware-Interfaces Commands
+============================
+This section contains those interface commands that are related to hardware-interfaces:
+
+
+* `Show Bridge-Domain`_
+* `Show Hardware-Interfaces`_
+* `Clear Hardware-Interfaces`_
+
+.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents `_ .
+
+Show Bridge-Domain
++++++++++++++++++++
+
+Show a summary of all the bridge-domain instances or detailed view of a single bridge-domain.
+Bridge-domains are created by adding an interface to a bridge using the **set interface l2 bridge** command.
+
+
+.. code-block:: console
+
+    show bridge-domain [*bridge-domain-id* [detail|int|arp| *bd-tag* ]]
+
+
+Example Usage
+-------------
+.. code-block:: console
+
+    Example of displaying all bridge-domains:
+
+    vpp# show bridge-domain
+
+     ID   Index   Learning   U-Forwrd   UU-Flood   Flooding   ARP-Term     BVI-Intf
+     0      0        off        off        off        off        off        local0
+    200     1        on         on         on         on         off          N/A
+
+    Example of displaying details of a single bridge-domains:
+
+    vpp# show bridge-domain 200 detail
+
+     ID   Index   Learning   U-Forwrd   UU-Flood   Flooding   ARP-Term     BVI-Intf
+    200     1        on         on         on         on         off          N/A
+
+             Interface           Index  SHG  BVI        VLAN-Tag-Rewrite
+     GigabitEthernet0/8/0.200      3     0    -               none
+     GigabitEthernet0/9/0.200      4     0    -               none
+
+Declaration and Implementation
+------------------------------
+
+**Declaration:** bd_show_cli (src/vnet/l2/l2_bd.c line 1151)
+
+**Implementation:** bd_show
+
+Show Hardware-Interfaces
++++++++++++++++++++++++++
+Display more detailed information about all or a list of given
+interfaces. The verboseness of the output can be controlled by the
+following optional parameters:
+
+-  **brief**: Only show name, index and state (default for bonded
+   interfaces).
+-  **verbose**: Also display additional attributes (default for all other
+   interfaces).
+-  **detail**: Also display all remaining attributes and extended
+   statistics.
+
+.. note::
+	To limit the output of the command to bonded interfaces and their
+	slave interfaces, use the '*bond*' optional parameter.
+
+
+.. code-block:: shell
+
+    show hardware-interfaces [brief|verbose|detail] [bond] [ [ [..]]] [ [ [..]]].
+
+
+Examples
+--------
+Example of how to display default data for all interfaces:
+
+.. code-block:: console
+
+    vpp# show hardware-interfaces
+                  Name                Idx   Link  Hardware
+    GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
+      Ethernet address ec:f4:bb:c0:bc:fc
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+    GigabitEthernet7/0/1               2     up   GigabitEthernet7/0/1
+      Ethernet address ec:f4:bb:c0:bc:fd
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+    VirtualEthernet0/0/0               3     up   VirtualEthernet0/0/0
+      Ethernet address 02:fe:a5:a9:8b:8e
+    VirtualEthernet0/0/1               4     up   VirtualEthernet0/0/1
+      Ethernet address 02:fe:c0:4e:3b:b0
+    VirtualEthernet0/0/2               5     up   VirtualEthernet0/0/2
+      Ethernet address 02:fe:1f:73:92:81
+    VirtualEthernet0/0/3               6     up   VirtualEthernet0/0/3
+      Ethernet address 02:fe:f2:25:c4:68
+    local0                             0    down  local0
+      local
+
+Example of how to display *verbose* data for an interface by name and software index
+(where 2 is the software index):
+
+.. code-block:: console
+
+    vpp# show hardware-interfaces GigabitEthernet7/0/0 2 verbose
+                   Name                Idx   Link  Hardware
+    GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
+      Ethernet address ec:f4:bb:c0:bc:fc
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+    GigabitEthernet7/0/1               2    down  GigabitEthernet7/0/1
+      Ethernet address ec:f4:bb:c0:bc:fd
+      Intel e1000
+        carrier up full duplex speed 1000 mtu 9216
+        rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
+        cpu socket 0
+
+Clear Hardware-Interfaces
++++++++++++++++++++++++++
+
+Clear the extended statistics for all or a list of given interfaces
+(statistics associated with the **show hardware-interfaces** command).
+
+
+.. code-block:: shell
+
+    clear hardware-interfaces [ [ [..]]] [ [ [..]]].
+
+
+Examples
+--------
+
+Example of how to clear the extended statistics for all interfaces:
+
+
+.. code-block:: console
+
+        vpp# clear hardware-interfaces
+
+Example of how to clear the extended statistics for an interface by name and software index
+(where 2 is the software index):
+
+.. code-block:: console
+
+        vpp# clear hardware-interfaces GigabitEthernet7/0/0 2
+
+
diff --git a/docs/cli-reference/interface/index.rst b/docs/cli-reference/interface/index.rst
new file mode 100644
index 00000000000..7fca8f11df2
--- /dev/null
+++ b/docs/cli-reference/interface/index.rst
@@ -0,0 +1,17 @@
+.. _interface:
+
+.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents `_ .
+
+.. _intcommands:
+
+Interface Commands
+==================
+This section identifies the following types of interface commands:
+
+.. toctree::
+   :maxdepth: 2
+
+   basic
+   hardware
+   create_interface
+   setinterface
diff --git a/docs/cli-reference/interface/setinterface.rst b/docs/cli-reference/interface/setinterface.rst
new file mode 100644
index 00000000000..7eb14adf455
--- /dev/null
+++ b/docs/cli-reference/interface/setinterface.rst
@@ -0,0 +1,182 @@
+======================
+Set Interface Commands
+======================
+
+This section covers those commands that are related to setting an
+interface:
+
+-  `Set Interface IP Address <#set-interface-ip-address>`__
+-  `Set Interface L2 Bridge <#set-interface-l2-bridge>`__
+-  `Set Interface MTU <#set-interface-mtu>`__
+-  `Set Interface Promiscuous <#set-interface-promiscuous>`__
+-  `Set Interface State <#set-interface-state>`__
+
+.. note::
+
+   For a complete list of CLI Debug commands refer to the Debug CLI
+   section of the `Source Code
+   Documents `__ .
+
+Set Interface IP Address
+========================
+
+.. code:: console
+
+   set interface ip address [del] <*interface*> <*ip-addr*>/<*mask*> | [all]
+
+Add an IP Address to an interface or remove and IP Address from an
+interface. The IP Address can be an IPv4 or an IPv6 address. Interfaces
+may have multiple IPv4 and IPv6 addresses. There is no concept of
+primary vs. secondary interface addresses; they're just addresses.
+
+To display the addresses associated with a given interface, use the
+command **show interface address** <*interface*>.
+
+.. note::
+
+   The debug CLI does not enforce classful mask-width / addressing
+   constraints.
+
+Example Usage
+-------------
+
+An example of how to add an IPv4 address to an interface:
+
+.. code:: console
+
+   vpp# set interface ip address GigabitEthernet2/0/0 172.16.2.12/24
+
+An example of how to add an IPv6 address to an interface:
+
+.. code:: console
+
+   vpp# set interface ip address GigabitEthernet2/0/0 ::a:1:1:0:7/126
+
+To delete a specific interface ip address:
+
+.. code:: console
+
+   vpp# set interface ip address GigabitEthernet2/0/0 172.16.2.12/24 del
+
+To delete all interfaces addresses (IPv4 and IPv6):
+
+.. code:: console
+
+   vpp# set interface ip address GigabitEthernet2/0/0 del all
+
+Declaration and Implementation
+------------------------------
+
+**Declaration:** set_interface_ip_address_command
+(src/vnet/ip/ip46_cli.c line 216)
+
+**Implementation:** add_del_ip_address
+
+Set Interface L2 Bridge
+=======================
+
+.. code:: console
+
+    set interface l2 bridge <*interface*> <*bridge-domain-id*> [bvi|uu-fwd]
+    [shg]
+
+Use this command put an interface into Layer 2 bridge domain. If a
+bridge-domain with the provided bridge-domain-id does not exist, it will
+be created. Interfaces in a bridge-domain forward packets to other
+interfaces in the same bridge-domain based on destination mac address.
+To remove an interface from a the Layer 2 bridge domain, put the
+interface in a different mode, for example Layer 3 mode.
+
+Optionally, an interface can be added to a Layer 2 bridge-domain as a
+Bridged Virtual Interface (bvi). Only one interface in a Layer 2
+bridge-domain can be a bvi.
+
+Optionally, a split-horizon group can also be specified. This defaults
+to 0 if not specified.
+
+.. _example-usage-1:
+
+Example Usage
+-------------
+
+Example of how to configure a Layer 2 bridge-domain with three
+interfaces (where 200 is the bridge-domain-id):
+
+.. code:: console
+
+   vpp# set interface l2 bridge GigabitEthernet0/8/0.200 200
+
+This interface is added a BVI interface:
+
+.. code:: console
+
+   vpp# set interface l2 bridge GigabitEthernet0/9/0.200 200 bvi
+
+This interface also has a split-horizon group of 1 specified:
+
+.. code:: console
+
+   vpp# set interface l2 bridge GigabitEthernet0/a/0.200 200 1
+
+Example of how to remove an interface from a Layer2 bridge-domain:
+
+.. code:: console
+
+   vpp# set interface l3 GigabitEthernet0/a/0.200
+
+.. _declaration-and-implementation-1:
+
+Declaration and Implementation
+------------------------------
+
+**Declaration:** int_l2_bridge_cli (src/vnet/l2/l2_input.c line 949)
+
+**Implementation:** int_l2_bridge
+
+Set Interface MTU
+=================
+
+.. code:: shell
+
+   set interface mtu [packet|ip4|ip6|mpls]  
+
+Set Interface Promiscuous
+=========================
+
+.. code:: shell
+
+   set interface promiscuous [on|off] .
+
+.. _setintstate:
+
+Set Interface State
+===================
+
+This command is used to change the admin state (up/down) of an
+interface.
+
+If an interface is down, the optional *punt* flag can also be set. The
+*punt* flag implies the interface is disabled for forwarding but punt
+all traffic to slow-path. Use the *enable* flag to clear *punt* flag
+(interface is still down).
+
+.. code:: shell
+
+   set interface state  [up|down|punt|enable].
+
+.. _example-usage-2:
+
+Example Usage
+-------------
+
+Example of how to configure the admin state of an interface to **up**:
+
+.. code:: console
+
+   vpp# set interface state GigabitEthernet2/0/0 up
+
+Example of how to configure the admin state of an interface to **down**:
+
+.. code:: console
+
+   vpp# set interface state GigabitEthernet2/0/0 down
diff --git a/docs/conf.py b/docs/conf.py
index 09c4d9b4ce4..8a2aef51bb1 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,6 +16,8 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import subprocess
+
 # -- Project information -----------------------------------------------------
 
 project = u'The Vector Packet Processor'
@@ -23,9 +25,9 @@ copyright = u'2018-2021, Linux Foundation'
 author = u'FD.io VPP Community'
 
 # The short X.Y version
-version = u'master'
+version = subprocess.run(["git", "describe"], stdout=subprocess.PIPE, text=True).stdout
 # The full version, including alpha/beta/rc tags
-release = u'20.01'
+release = subprocess.run(["git", "describe", "--long"], stdout=subprocess.PIPE, text=True).stdout
 
 
 # -- General configuration ---------------------------------------------------
@@ -44,6 +46,10 @@ extensions = [
     'sphinxcontrib.spelling']
 
 spelling_word_list_filename = 'spelling_wordlist.txt'
+
+# do not spell check those files
+spelling_exclude_patterns = ['aboutvpp/releasenotes/*']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -68,7 +74,7 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['Thumbs.db', '.DS_Store', '_scripts', 'venv', '_generated']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'default'
diff --git a/docs/configuration/config_getting_started.rst b/docs/configuration/config_getting_started.rst
new file mode 100644
index 00000000000..9321ce6a6c8
--- /dev/null
+++ b/docs/configuration/config_getting_started.rst
@@ -0,0 +1,84 @@
+.. _config_getting_started:
+
+=======================================
+Getting started with the configuration
+=======================================
+
+After a successful installation, VPP installs a startup config file named
+*startup.conf* in the */etc/vpp/* directory. This file can be tailored to
+make VPP run as desired, but contains default values for typical installations.
+
+Below are more details about this file and some of the the parameters and values
+it contains.
+
+Command-line Arguments
+----------------------
+
+Before we describe details of the startup configuration file (startup.conf) it
+should be mentioned that VPP can be started without a startup configuration
+file.
+
+Parameters are grouped by a section name. When providing more than one
+parameter to a section, all parameters for that section must be wrapped in
+curly braces. For example, to start VPP with configuration data via the
+command line with the section name *'unix'*:
+
+.. code-block:: console
+
+    $ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
+
+The command line can be presented as a single string or as several; anything
+given on the command line is concatenated with spaces into a single string
+before parsing. VPP applications must be able to locate their own executable
+images. The simplest way to ensure this will work is to invoke a VPP
+application by giving its absolute path. For example:
+*'/usr/bin/vpp '*  At startup, VPP applications parse through their
+own ELF-sections [primarily] to make lists of init, configuration, and exit
+handlers.
+
+When developing with VPP, in gdb it's often sufficient to start an application
+like this:
+
+.. code-block:: console
+
+    (gdb) run unix interactive
+
+
+Configuration File (startup.conf)
+-----------------------------------------
+
+The more typical way to specify the startup configuration to VPP is with the
+startup configuration file (startup.conf).
+
+The path of the file is provided to the VPP application on the command line.
+This is typically at /etc/vpp/startup.conf. If VPP is installed as a package
+a default startup.conf file is provided at this location.
+
+The format of the configuration file is a simple text file with the same content
+as the command line.
+
+**A very simple startup.conf file:**
+
+.. code-block:: console
+
+    $ cat /etc/vpp/startup.conf
+    unix {
+      nodaemon
+      log /var/log/vpp/vpp.log
+      full-coredump
+      cli-listen localhost:5002
+    }
+
+    api-trace {
+      on
+    }
+
+    dpdk {
+      dev 0000:03:00.0
+    }
+
+VPP is instructed to load this file with the -c option. For example:
+
+.. code-block:: console
+
+    $ sudo /usr/bin/vpp -c /etc/vpp/startup.conf
\ No newline at end of file
diff --git a/docs/configuration/reference.rst b/docs/configuration/reference.rst
new file mode 100644
index 00000000000..84b2fd75887
--- /dev/null
+++ b/docs/configuration/reference.rst
@@ -0,0 +1,1600 @@
+.. _configuration_reference:
+
+Configuration Reference
+=======================
+
+Below is the list of some section names and their associated parameters.
+This is not an exhaustive list, but should give you an idea of how VPP can be configured.
+
+For all of the configuration parameters search the source code for instances of
+**VLIB_CONFIG_FUNCTION** and **VLIB_EARLY_CONFIG_FUNCTION**.
+
+For example, the invocation *'VLIB_CONFIG_FUNCTION (foo_config, "foo")'* will
+cause the function *'foo_config'* to receive all parameters given in a
+parameter block named "foo": "foo { arg1 arg2 arg3 ... }".
+
+The unix section
+----------------
+
+Configures VPP startup and behavior type attributes, as well and any OS based
+attributes.
+
+.. code-block:: console
+
+  unix {
+    nodaemon
+    log /var/log/vpp/vpp.log
+    full-coredump
+    cli-listen /run/vpp/cli.sock
+    gid vpp
+  }
+
+nodaemon
+^^^^^^^^
+
+Do not fork / background the vpp process. Typical when invoking VPP
+applications from a process monitor. Set by default in the default
+*'startup.conf'* file.
+
+.. code-block:: console
+
+   nodaemon
+
+nosyslog
+^^^^^^^^
+
+Disable syslog and log errors to stderr instead. Typical when invoking
+VPP applications from a process monitor like runit or daemontools that
+pipe service's output to a dedicated log service, which will typically
+attach a timestamp and rotate the logs as necessary.
+
+.. code-block:: console
+
+   nosyslog
+
+interactive
+^^^^^^^^^^^
+
+Attach CLI to stdin/out and provide a debugging command line interface.
+
+.. code-block:: console
+
+   interactive
+
+log 
+^^^^^^^^^^^^^^
+
+Logs the startup configuration and all subsequent CLI commands in filename.
+Very useful in situations where folks don't remember or can't be bothered
+to include CLI commands in bug reports. The default *'startup.conf'* file
+is to write to *'/var/log/vpp/vpp.log'*.
+
+In VPP 18.04, the default log file location was moved from '/tmp/vpp.log'
+to '/var/log/vpp/vpp.log' . The VPP code is indifferent to the file location.
+However, if SELinux is enabled, then the new location is required for the file
+to be properly labeled. Check your local *'startup.conf'* file for the log file
+location on your system.
+
+.. code-block:: console
+
+   log /var/log/vpp/vpp-debug.log
+
+exec | startup-config 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Read startup operational configuration from filename. The contents of the file
+will be performed as though entered at the CLI. The two keywords are aliases
+for the same function; if both are specified, only the last will have an effect.
+
+A file of CLI commands might look like:
+
+.. code-block:: console
+
+   $ cat /usr/share/vpp/scripts/interface-up.txt
+   set interface state TenGigabitEthernet1/0/0 up
+   set interface state TenGigabitEthernet1/0/1 up
+
+Parameter Example:
+
+.. code-block:: console
+
+     startup-config /usr/share/vpp/scripts/interface-up.txt
+
+gid 
+^^^^^^^^^^^^^^^^^^^
+
+Sets the effective group ID to the input group ID or group name of the calling
+process.
+
+.. code-block:: console
+
+   gid vpp
+
+full-coredump
+^^^^^^^^^^^^^
+
+Ask the Linux kernel to dump all memory-mapped address regions, instead of
+just text+data+bss.
+
+.. code-block:: console
+
+   full-coredump
+
+coredump-size unlimited | G | M | K | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Set the maximum size of the coredump file. The input value can be set in
+     GB, MB, KB or bytes, or set to *'unlimited'*.
+
+.. code-block:: console
+
+   coredump-size unlimited
+
+cli-listen  | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Bind the CLI to listen at address localhost on TCP port 5002. This will
+     accept an ipaddress:port pair or a filesystem path; in the latter case a
+     local Unix socket is opened instead. The default *'startup.conf'* file
+     is to open the socket *'/run/vpp/cli.sock'*.
+
+.. code-block:: console
+
+     cli-listen localhost:5002
+     cli-listen /run/vpp/cli.sock
+
+cli-line-mode
+^^^^^^^^^^^^^
+
+     Disable character-by-character I/O on stdin. Useful when combined with,
+     for example, emacs M-x gud-gdb.
+
+.. code-block:: console
+
+   cli-line-mode
+
+cli-prompt 
+^^^^^^^^^^^^^^^^^^^
+
+     Configure the CLI prompt to be string.
+
+.. code-block:: console
+
+     cli-prompt vpp-2
+
+cli-history-limit 
+^^^^^^^^^^^^^^^^^^^^^
+
+     Limit command history to  lines. A value of 0 disables command history.
+     Default value: 50
+
+.. code-block:: console
+
+     cli-history-limit 100
+
+cli-no-banner
+^^^^^^^^^^^^^
+
+     Disable the login banner on stdin and Telnet connections.
+
+.. code-block:: console
+
+     cli-no-banner
+
+cli-no-pager
+^^^^^^^^^^^^
+
+     Disable the output pager.
+
+.. code-block:: console
+
+     cli-no-pager
+
+cli-pager-buffer-limit 
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Limit pager buffer to  lines of output. A value of 0 disables the
+     pager. Default value: 100000
+
+.. code-block:: console
+
+     cli-pager-buffer-limit 5000
+
+runtime-dir 
+^^^^^^^^^^^^^^^^^
+
+     Set the runtime directory, which is the default location for certain
+     files, like socket files. Default is based on User ID used to start VPP.
+     Typically it is *'root'*, which defaults to *'/run/vpp/'*. Otherwise,
+     defaults to *'/run/user//vpp/'*.
+
+.. code-block:: console
+
+     runtime-dir /tmp/vpp
+
+poll-sleep-usec 
+^^^^^^^^^^^^^^^^^^^
+
+     Add a fixed-sleep between main loop poll. Default is 0, which is not to
+     sleep.
+
+.. code-block:: console
+
+     poll-sleep-usec 100
+
+pidfile 
+^^^^^^^^^^^^^^^^^^
+
+     Writes the pid of the main thread in the given filename.
+
+.. code-block:: console
+
+     pidfile /run/vpp/vpp1.pid
+
+
+The api-trace Section
+---------------------
+
+The ability to trace, dump, and replay control-plane API traces makes all the
+difference in the world when trying to understand what the control-plane has
+tried to ask the forwarding-plane to do.
+
+Typically, one simply enables the API message trace scheme:
+
+.. code-block:: console
+
+   api-trace {
+     api-trace on
+   }
+
+on | enable
+^^^^^^^^^^^
+
+     Enable API trace capture from the beginning of time, and arrange for a
+     post-mortem dump of the API trace if the application terminates abnormally.
+     By default, the (circular) trace buffer will be configured to capture
+     256K traces. The default *'startup.conf'* file has trace enabled by default,
+     and unless there is a very strong reason, it should remain enabled.
+
+.. code-block:: console
+
+    on
+
+nitems 
+^^^^^^^^^^
+
+     Configure the circular trace buffer to contain the last  entries. By
+     default, the trace buffer captures the last 256K API messages received.
+
+.. code-block:: console
+
+    nitems 524288
+
+save-api-table 
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Dumps the API message table to /tmp/.
+
+.. code-block:: console
+
+    save-api-table apiTrace-07-04.txt
+
+
+The api-segment Section
+-----------------------
+
+These values control various aspects of the binary API interface to VPP.
+
+The default looks like the following:
+
+.. code-block:: console
+
+   api-segment {
+     gid vpp
+   }
+
+
+prefix 
+^^^^^^^^^^^^^
+
+     Sets the prefix prepended to the name used for shared memory (SHM)
+     segments. The default is empty, meaning shared memory segments are created
+     directly in the SHM directory *'/dev/shm'*. It is worth noting that on
+     many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
+     system; Ubuntu links it to *'/run/shm'*.
+
+.. code-block:: console
+
+    prefix /run/shm
+
+uid 
+^^^^^^^^^^^^^^^^^^^
+
+     Sets the user ID or name that should be used to set the ownership of the
+     shared memory segments. Defaults to the same user that VPP is started
+     with, probably root.
+
+.. code-block:: console
+
+    uid root
+
+gid 
+^^^^^^^^^^^^^^^^^^^
+
+     Sets the group ID or name that should be used to set the ownership of the
+     shared memory segments. Defaults to the same group that VPP is started
+     with, probably root.
+
+.. code-block:: console
+
+    gid vpp
+
+**The following parameters should only be set by those that are familiar with the
+interworkings of VPP.**
+
+baseva 
+^^^^^^^^^^
+
+     Set the base address for SVM global region. If not set, on AArch64, the
+     code will try to determine the base address. All other default to
+     0x30000000.
+
+.. code-block:: console
+
+    baseva 0x20000000
+
+global-size G | M | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Set the global memory size, memory shared across all router instances,
+     packet buffers, etc. If not set, defaults to 64M. The input value can be
+     set in GB, MB or bytes.
+
+.. code-block:: console
+
+    global-size 2G
+
+global-pvt-heap-size M | size 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Set the size of the global VM private mheap. If not set, defaults to 128k.
+     The input value can be set in MB or bytes.
+
+.. code-block:: console
+
+    global-pvt-heap-size size 262144
+
+api-pvt-heap-size M | size 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Set the size of the api private mheap. If not set, defaults to 128k.
+     The input value can be set in MB or bytes.
+
+.. code-block:: console
+
+    api-pvt-heap-size 1M
+
+api-size M | G | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+     Set the size of the API region. If not set, defaults to 16M. The input
+     value can be set in GB, MB or bytes.
+
+.. code-block:: console
+
+    api-size 64M
+
+The socksvr Section
+-------------------
+
+Enables a Unix domain socket which processes binary API messages. See
+.../vlibmemory/socket_api.c.  If this parameter is not set, vpp
+won't process binary API messages over sockets.
+
+.. code-block:: console
+
+   socksvr {
+      # Explicitly name a socket file
+      socket-name /run/vpp/api.sock
+      or
+      # Use defaults as described below
+      default
+   }
+
+The "default" keyword instructs vpp to use /run/vpp/api.sock when
+running as root, otherwise to use /run/user//api.sock.
+
+The cpu Section
+---------------
+
+In the VPP there is one main thread and optionally the user can create worker(s)
+The main thread and worker thread(s) can be pinned to CPU core(s) manually or automatically
+
+.. code-block:: console
+
+   cpu {
+      main-core 1
+      corelist-workers 2-3,18-19
+   }
+
+
+Manual pinning of thread(s) to CPU core(s)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+main-core
+^^^^^^^^^
+
+Set logical CPU core where main thread runs, if main core is not set VPP will use
+core 1 if available
+
+.. code-block:: console
+
+   main-core 1
+
+corelist-workers
+^^^^^^^^^^^^^^^^
+
+Set logical CPU core(s) where worker threads are running
+
+.. code-block:: console
+
+   corelist-workers 2-3,18-19
+
+Automatic pinning of thread(s) to CPU core(s)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+skip-cores number
+^^^^^^^^^^^^^^^^^
+
+Sets number of CPU core(s) to be skipped (1 ... N-1), Skipped CPU core(s) are
+not used for pinning main thread and working thread(s).
+
+The main thread is automatically pinned to the first available CPU core and worker(s)
+are pinned to next free CPU core(s) after core assigned to main thread
+
+.. code-block:: console
+
+   skip-cores 4
+
+workers number
+^^^^^^^^^^^^^^
+
+Specify a number of workers to be created Workers are pinned to N consecutive
+CPU cores while skipping "skip-cores" CPU core(s) and main thread's CPU core
+
+.. code-block:: console
+
+   workers 2
+
+scheduler-policy other | batch | idle | fifo | rr
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set scheduling policy and priority of main and worker threads
+
+Scheduling policy options are: other (SCHED_OTHER), batch (SCHED_BATCH)
+idle (SCHED_IDLE), fifo (SCHED_FIFO), rr (SCHED_RR)
+
+.. code-block:: console
+
+   scheduler-policy fifo
+
+scheduler-priority number
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Scheduling priority is used only for "real-time policies (fifo and rr),
+and has to be in the range of priorities supported for a particular policy
+
+.. code-block:: console
+
+   scheduler-priority 50
+
+The buffers Section
+-------------------
+
+.. code-block:: console
+
+   buffers {
+      buffers-per-numa 128000
+      default data-size 2048
+      page-size default-hugepage
+   }
+
+buffers-per-numa number
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Increase number of buffers allocated, needed only in scenarios with
+large number of interfaces and worker threads. Value is per numa node.
+Default is 16384 (8192 if running unprivileged)
+
+.. code-block:: console
+
+   buffers-per-numa 128000
+
+default data-size number
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Size of buffer data area, default is 2048
+
+.. code-block:: console
+
+   default data-size 2048
+
+page-size number
+^^^^^^^^^^^^^^^^
+
+Set the page size for buffer allocation
+
+.. code-block:: console
+
+   page-size 4K
+   page-size 2M
+   page-size 1G
+   page-size default
+   page-size default-hugepage
+
+
+The dpdk Section
+----------------
+
+.. code-block:: console
+
+   dpdk {
+      dev default {
+         num-rx-desc 512
+         num-tx-desc 512
+      }
+
+      dev 0000:02:00.1 {
+         num-rx-queues 2
+         name eth0
+      }
+   }
+
+dev  | default { .. }
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+White-list [as in, attempt to drive] a specific PCI device. PCI-dev is a
+string of the form "DDDD:BB:SS.F" where:
+
+* DDDD = Domain
+* BB = Bus Number
+* SS = Slot number
+* F = Function
+
+If the keyword **default** is used the values will apply to all the devices.
+
+This is the same format used in the linux sysfs tree (i.e./sys/bus/pci/devices)
+for PCI device directory names.
+
+.. code-block:: console
+
+   dpdk {
+      dev default {
+         num-rx-desc 512
+         num-tx-desc 512
+      }
+
+dev  { .. }
+^^^^^^^^^^^^^^^^^^^^
+
+Whitelist specific interface by specifying PCI address. When whitelisting specific
+interfaces by specifying PCI address, additional custom parameters can also be
+specified. Valid options include:
+
+.. code-block:: console
+
+   dev 0000:02:00.0
+   dev 0000:03:00.0
+
+blacklist 
+^^^^^^^^^^^^^^^^^^^
+
+Blacklist specific device type by specifying PCI vendor:device Whitelist entries
+take precedence
+
+.. code-block:: console
+
+   blacklist 8086:10fb
+
+name interface-name
+^^^^^^^^^^^^^^^^^^^
+
+Set interface name
+
+.. code-block:: console
+
+   dev 0000:02:00.1 {
+      name eth0
+   }
+
+num-rx-queues 
+^^^^^^^^^^^^^^^^^
+
+Number of receive queues. Also enables RSS. Default value is 1.
+
+.. code-block:: console
+
+   dev 0000:02:00.1 {
+      num-rx-queues 
+   }
+
+num-tx-queues 
+^^^^^^^^^^^^^^^^^
+
+Number of transmit queues. Default is equal to number of worker threads
+or 1 if no workers treads.
+
+.. code-block:: console
+
+   dev 000:02:00.1 {
+      num-tx-queues 
+   }
+
+num-rx-desc 
+^^^^^^^^^^^^^^^
+
+Number of descriptors in receive ring. Increasing or reducing number
+can impact performance. Default is 1024.
+
+.. code-block:: console
+
+   dev 000:02:00.1 {
+      num-rx-desc 
+   }
+
+vlan-strip-offload on | off
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+VLAN strip offload mode for interface. VLAN stripping is off by default
+for all NICs except VICs, using ENIC driver, which has VLAN stripping on
+by default.
+
+.. code-block:: console
+
+   dev 000:02:00.1 {
+      vlan-strip-offload on|off
+   }
+
+uio-driver driver-name
+^^^^^^^^^^^^^^^^^^^^^^
+
+Change UIO driver used by VPP, Options are: igb_uio, vfio-pci, uio_pci_generic
+or auto (default)
+
+
+.. code-block:: console
+
+   uio-driver vfio-pci
+
+no-multi-seg
+^^^^^^^^^^^^
+
+Disable multi-segment buffers, improves performance but disables Jumbo MTU support
+
+.. code-block:: console
+
+   no-multi-seg
+
+socket-mem 
+^^^^^^^^^^^^^^
+
+Change hugepages allocation per-socket, needed only if there is need for
+larger number of mbufs. Default is 256M on each detected CPU socket
+
+.. code-block:: console
+
+   socket-mem 2048,2048
+
+no-tx-checksum-offload
+^^^^^^^^^^^^^^^^^^^^^^
+
+Disables UDP / TCP TX checksum offload. Typically needed for use faster
+vector PMDs (together with no-multi-seg)
+
+.. code-block:: console
+
+   no-tx-checksum-offload
+
+enable-tcp-udp-checksum
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Enable UDP / TCP TX checksum offload This is the reversed option of
+'no-tx-checksum-offload'
+
+.. code-block:: console
+
+   enable-tcp-udp-checksum
+
+The plugins Section
+-------------------
+
+Configure VPP plugins.
+
+.. code-block:: console
+
+   plugins {
+      path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
+      plugin dpdk_plugin.so enable
+   }
+
+path pathname
+^^^^^^^^^^^^^
+
+Adjust the plugin path depending on where the VPP plugins are.
+
+.. code-block:: console
+
+   path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
+
+plugin plugin-name | default enable | disable
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Disable all plugins by default and then selectively enable specific plugins
+
+.. code-block:: console
+
+   plugin default disable
+   plugin dpdk_plugin.so enable
+   plugin acl_plugin.so enable
+
+Enable all plugins by default and then selectively disable specific plugins
+
+.. code-block:: console
+
+   plugin dpdk_plugin.so disable
+   plugin acl_plugin.so disable
+
+Th statseg Section
+^^^^^^^^^^^^^^^^^^
+
+.. code-block:: console
+
+   statseg {
+      per-node-counters on
+    }
+
+socket-name 
+^^^^^^^^^^^^^^^^^^^^^^
+
+Name of the stats segment socket defaults to /run/vpp/stats.sock.
+
+.. code-block:: console
+
+   socket-name /run/vpp/stats.sock
+
+size [KMG]
+^^^^^^^^^^^^^^^
+
+The size of the stats segment, defaults to 32mb
+
+.. code-block:: console
+
+   size 1024M
+
+per-node-counters on | off
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Defaults to none
+
+.. code-block:: console
+
+   per-node-counters on
+
+update-interval 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the segment scrape / update interval
+
+.. code-block:: console
+
+   update-interval 300
+
+
+Some Advanced Parameters:
+-------------------------
+
+
+acl-plugin Section
+------------------
+
+These parameters change the configuration of the ACL (access control list) plugin,
+such as how the ACL bi-hash tables are initialized.
+
+They should only be set by those that are familiar with the interworkings of VPP
+and the ACL Plugin.
+
+The first three parameters, *connection hash buckets*, *connection hash memory*,
+and *connection count max*, set the **connection table per-interface parameters**
+for modifying how the two bounded-index extensible hash tables for
+IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4
+(16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions**
+are initialized.
+
+connection hash buckets 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of hash buckets (rounded up to a power of 2) in each
+of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
+
+.. code-block:: console
+
+   connection hash buckets 65536
+
+connection hash memory 
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the allocated memory size (in bytes) for each of the two bi-hash tables.
+Defaults to 1073741824 bytes.
+
+.. code-block:: console
+
+   connection hash memory 1073741824
+
+connection count max 
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the maximum number of pool elements when allocating each per-worker
+pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
+
+.. code-block:: console
+
+   connection count max 500000
+
+main heap size G | M | K | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the size of the main memory heap that holds all the ACL module related
+allocations (other than hash.) Default size is 0, but during
+ACL heap initialization is equal to
+*per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*.
+Note that these variables are partially based on the
+**connection table per-interface parameters** mentioned above.
+
+.. code-block:: console
+
+   main heap size 3G
+
+The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*,
+and *hash lookup hash memory*, modify the initialization of the bi-hash lookup
+table used by the ACL plugin. This table is initialized when attempting to apply
+an ACL to the existing vector of ACLs looked up during packet processing
+(but it is found that the table does not exist / has not been initialized yet.)
+
+hash lookup heap size  G | M |  K | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the size of the memory heap that holds all the miscellaneous allocations
+related to hash-based lookups. Default size is 67108864 bytes.
+
+.. code-block:: console
+
+   hash lookup heap size 70M
+
+hash lookup hash buckets 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash
+lookup table. Defaults to 65536 hash buckets.
+
+.. code-block:: console
+
+   hash lookup hash buckets 65536
+
+hash lookup hash memory 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the allocated memory size (in bytes) for the bi-hash lookup table.
+Defaults to 67108864 bytes.
+
+.. code-block:: console
+
+   hash lookup hash memory 67108864
+
+use tuple merge 
+^^^^^^^^^^^^^^^^^^^
+
+Sets a boolean value indicating whether or not to use TupleMerge
+for hash ACL's. Defaults to 1 (true), meaning the default implementation
+of hashing ACL's does use TupleMerge.
+
+.. code-block:: console
+
+   use tuple merge 1
+
+tuple merge split threshold 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the maximum amount of rules (ACE's) that can collide in a bi-hash
+lookup table before the table is split into two new tables. Splitting ensures
+less rule collisions by hashing colliding rules based on their common tuple
+(usually their maximum common tuple.) Splitting occurs when the
+*length of the colliding rules vector* is greater than this threshold amount.
+Defaults to a maximum of 39 rule collisions per table.
+
+.. code-block:: console
+
+   tuple merge split threshold 30
+
+reclassify sessions 
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets a boolean value indicating whether or not to take the epoch of the session
+into account when dealing with re-applying ACL's or changing already applied ACL's.
+Defaults to 0 (false), meaning the default implementation does NOT take the
+epoch of the session into account.
+
+.. code-block:: console
+
+   reclassify sessions 1
+
+.. _api-queue:
+
+api-queue Section
+-----------------
+
+length  
+^^^^^^^^^^^
+
+Sets the api queue length. Minimum valid queue length is 1024, which is
+also the default.
+
+.. code-block:: console
+
+   length 2048
+
+.. _cj:
+
+cj Section
+----------
+
+The circular journal (CJ) thread-safe circular log buffer scheme is
+occasionally useful when chasing bugs. Calls to it should not be checked in.
+See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
+When enabled, the number of records must be provided, there is no default
+value.
+
+records 
+^^^^^^^^^^^
+
+Configure the number of circular journal records in the circular buffer.
+The number of records should be a power of 2.
+
+.. code-block:: console
+
+   records 131072
+
+on
+^^
+
+Turns on logging at the earliest possible moment.
+
+.. code-block:: console
+
+   on
+
+dns Section
+-----------
+
+max-cache-size 
+^^^^^^^^^^^^^^^^^^
+
+Set the maximum number of active elements allowed in the pool of
+dns cache entries. When resolving an expired entry or adding a new
+static entry and the max number of active entries is reached,
+a random, non-static entry is deleted. Defaults to 65535 entries.
+
+.. code-block:: console
+
+   max-cache-size 65535
+
+
+ethernet Section
+-----------------
+
+default-mtu 
+^^^^^^^^^^^^^^^
+
+Specifies the default MTU size for Ethernet interfaces.  Must be in
+the range of 64-9000.  The default is 9000.
+
+.. code-block:: console
+
+   default-mtu 1500
+
+heapsize Section
+-----------------
+
+Heapsize configuration controls the size of the main heap. The heap size is
+configured very early in the boot sequence, before loading plug-ins or doing
+much of anything else.
+
+heapsize M | G
+^^^^^^^^^^^^^^^^^^^^
+
+Specifies the size of the heap in MB or GB. The default is 1GB.
+
+.. code-block:: console
+
+   heapsize 2G
+
+ip Section
+----------
+
+IPv4 heap configuration. he heap size is configured very early in the boot
+sequence, before loading plug-ins or doing much of anything else.
+
+heap-size G | M | K | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
+the destination IP lookup table. The input value can be set in GB, MB, KB
+or bytes. The default value is 32MB.
+
+.. code-block:: console
+
+   heap-size 64M
+
+ip6 Section
+-----------
+
+IPv6 heap configuration. he heap size is configured very early in the boot
+sequence, before loading plug-ins or doing much of anything else.
+
+
+heap-size G | M | K | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the IPv6 forwarding table heap size. The input value can be set in GB,
+MB, KB or bytes. The default value is 32MB.
+
+.. code-block:: console
+
+   heap-size 64M
+
+hash-buckets 
+^^^^^^^^^^^^^^^^
+
+Set the number of IPv6 forwarding table hash buckets. The default value is
+64K (65536).
+
+.. code-block:: console
+
+   hash-buckets 131072
+
+l2learn Section
+---------------
+
+Configure Layer 2 MAC Address learning parameters.
+
+limit 
+^^^^^^^^^
+
+Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
+which limits the size of the L2 FIB to  concurrent entries.  Defaults to
+4M entries (4194304).
+
+.. code-block:: console
+
+   limit 8388608
+
+l2tp Section
+------------
+
+IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
+the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
+are mutually exclusive:
+
+lookup-v6-src
+^^^^^^^^^^^^^
+
+Lookup tunnel by IPv6 source address.
+
+.. code-block:: console
+
+   lookup-v6-src
+
+lookup-v6-dst
+^^^^^^^^^^^^^
+
+Lookup tunnel by IPv6 destination address.
+
+.. code-block:: console
+
+   lookup-v6-dst
+
+lookup-session-id
+^^^^^^^^^^^^^^^^^
+
+Lookup tunnel by L2TPv3 session identifier.
+
+.. code-block:: console
+
+   lookup-session-id
+
+logging Section
+---------------
+
+size 
+^^^^^^^^
+
+Number of entries in the global logging buffer. Defaults to 512.
+
+.. code-block:: console
+
+   size 512
+
+nthrottle-time 
+^^^^^^^^^^^^^^^^^^
+
+Set the global value for the time to wait (in seconds) before resuming
+logging of a log subclass that exceeded the per-subclass message-per-second
+threshold.  Defaults to 3.
+
+.. code-block:: console
+
+   unthrottle-time 3
+
+default-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the default logging level of the system log.  Defaults to notice.
+
+.. code-block:: console
+
+   default-log-level notice
+
+default-syslog-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the default logging level of the syslog target.  Defaults to warning.
+
+.. code-block:: console
+
+   default-syslog-log-level warning
+
+mactime Section
+---------------
+
+lookup-table-buckets 
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of hash buckets in the mactime bi-hash lookup table.
+Defaults to 128 buckets.
+
+.. code-block:: console
+
+   lookup-table-buckets 128
+
+lookup-table-memory G | M | K | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the allocated memory size (in bytes) for the mactime bi-hash lookup table.
+The input value can be set in GB, MB, KB or bytes. The default value is 262144
+(256 << 10) bytes or roughly 256KB.
+
+.. code-block:: console
+
+   lookup-table-memory 300K
+
+timezone_offset 
+^^^^^^^^^^^^^^^^^^^
+
+Sets the timezone offset from UTC. Defaults to an offset of -5 hours
+from UTC (US EST / EDT.)
+
+.. code-block:: console
+
+   timezone_offset -5
+
+"map" Parameters
+----------------
+
+customer edge
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets a boolean true to indicate that the MAP node is a Customer Edge (CE)
+router. The boolean defaults to false, meaning the MAP node is not treated
+as a CE router.
+
+.. code-block:: console
+
+   customer edge
+
+nat Section
+-----------
+
+These parameters change the configuration of the NAT (Network address translation)
+plugin, such as how the NAT & NAT64 bi-hash tables are initialized, if the NAT is
+endpoint dependent, or if the NAT is deterministic.
+
+For each NAT per thread data, the following 4 parameters change how certain
+bi-hash tables are initialized.
+
+translation hash buckets 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of hash buckets in each of the two in/out NAT bi-hash lookup
+tables. Defaults to 1024 buckets.
+
+If the NAT is indicated to be endpoint dependent, which can be set with the
+:ref:`endpoint-dependent parameter `, then this parameter sets
+the number of hash buckets in each of the two endpoint dependent sessions
+NAT bi-hash lookup tables.
+
+.. code-block:: console
+
+   translation hash buckets 1024
+
+translation hash memory 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the allocated memory size (in bytes) for each of the two in/out NAT
+bi-hash tables. Defaults to 134217728 (128 << 20) bytes, which is roughly 128 MB.
+
+If the NAT is indicated to be endpoint dependent, which can be set with the
+:ref:`endpoint-dependent parameter `, then this parameter sets the
+allocated memory size for each of the two endpoint dependent sessions NAT bi-hash
+lookup tables.
+
+.. code-block:: console
+
+   translation hash memory 134217728
+
+user hash buckets 
+^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of hash buckets in the user bi-hash lookup table
+(src address lookup for a user.) Defaults to 128 buckets.
+
+.. code-block:: console
+
+   user hash buckets 128
+
+user hash memory 
+^^^^^^^^^^^^^^^^^^^^
+
+Sets the allocated memory size (in bytes) for the user bi-hash lookup table
+(src address lookup for a user.) Defaults to 67108864 (64 << 20) bytes,
+which is roughly 64 MB.
+
+.. code-block:: console
+
+   user hash memory 67108864
+
+max translations per user 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the maximum amount of dynamic and/or static NAT sessions each user can have.
+Defaults to 100. When this limit is reached, the least recently used translation
+is recycled.
+
+.. code-block:: console
+
+   max translations per user 50
+
+deterministic
+^^^^^^^^^^^^^
+
+Sets a boolean value to 1 indicating that the NAT is deterministic. Defaults to 0,
+meaning the NAT is not deterministic.
+
+.. code-block:: console
+
+   deterministic
+
+nat64 bib hash buckets 
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
+tables. Defaults to 1024 buckets.
+
+.. code-block:: console
+
+   nat64 bib hash buckets 1024
+
+nat64 bib hash memory 
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the allocated memory size (in bytes) for each of the two in/out NAT64
+BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
+which is roughly 128 MB.
+
+.. code-block:: console
+
+   nat64 bib hash memory 134217728
+
+nat64 st hash buckets 
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of hash buckets in each of the two in/out NAT64 session table
+bi-hash tables. Defaults to 2048 buckets.
+
+.. code-block:: console
+
+   nat64 st hash buckets 2048
+
+nat64 st hash memory 
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
+table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
+256 MB.
+
+.. code-block:: console
+
+   nat64 st hash memory 268435456
+
+.. _endpointLabel:
+
+endpoint-dependent
+^^^^^^^^^^^^^^^^^^
+
+Sets a boolean value to 1, indicating that the NAT is endpoint dependent.
+Defaults to 0, meaning the NAT is not endpoint dependent.
+
+.. code-block:: console
+
+   endpoint-dependent
+
+oam Section
+-----------
+
+OAM configuration controls the (ip4-icmp) interval, and number of misses
+allowed before reporting an oam target down to any registered listener.
+
+interval 
+^^^^^^^^^^^^^^
+
+Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
+Default is 2.04 seconds.
+
+.. code-block:: console
+
+   interval 3.5
+
+physmem Section
+---------------
+
+Configuration parameters used to specify base address and maximum size of
+the memory allocated for the pmalloc module in VPP. pmalloc is a NUMA-aware,
+growable physical memory allocator. pmalloc allocates memory for the DPDK
+memory pool.
+
+base-addr 

+^^^^^^^^^^^^^^^^^^^
+
+Specify the base address for pmalloc memory space.
+
+.. code-block:: console
+
+    base-addr 0xfffe00000000
+
+max-size G | M | K | 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the memory size for pmalloc memory space. The default is 16G.
+
+.. code-block:: console
+
+    max-size 4G
+
+tapcli Section
+--------------
+
+Configuration parameters for TAPCLI (dynamic tap interface hookup.)
+
+mtu 
+^^^^^^^
+
+Sets interface MTU (maximum transmission unit) size in bytes. This size
+is also related to the number of MTU buffers. Defaults to 1500 bytes.
+
+.. code-block:: console
+
+   mtu 1500
+
+disable
+^^^^^^^
+
+Disables TAPCLI. Default is that TAPCLI is enabled.
+
+.. code-block:: console
+
+   disable
+
+
+tcp Section
+-----------
+
+Configuration parameters for TCP host stack utilities. The following
+preallocation parameters are related to the initialization of fixed-size,
+preallocation pools.
+
+preallocated-connections 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of preallocated TCP connections. Defaults to 0.
+The preallocated connections per thread is related to this value,
+equal to (preallocated_connections / (num_threads - 1)).
+
+.. code-block:: console
+
+   preallocated-connections 5
+
+preallocated-half-open-connections 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the number of preallocated TCP half-open connections. Defaults to 0.
+
+.. code-block:: console
+
+   preallocated-half-open-connections 5
+
+buffer-fail-fraction 
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the TCP buffer fail fraction (a float) used for fault-injection
+when debugging TCP buffer allocation. Its use is found in *tcp_debug.h*.
+Defaults to 0.0.
+
+.. code-block:: console
+
+   buffer-fail-fraction 0.0
+
+
+tls Section
+-----------
+
+Configures TLS parameters, such as enabling the use of test certificates.
+These parameters affect the tlsmbedtls and tlsopenssl plugins.
+
+use-test-cert-in-ca
+^^^^^^^^^^^^^^^^^^^
+
+Sets a boolean value to 1 to indicate during the initialization of a
+TLS CA chain to attempt to parse and add test certificates to the chain.
+Defaults to 0, meaning test certificates are not used.
+
+.. code-block:: console
+
+   use-test-cert-in-ca
+
+ca-cert-path 
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets the filename path of the location of TLS CA certificates, used when
+initializing and loading TLS CA certificates during the initialization
+of a TLS CA chain. If not set, the default filename path is
+*/etc/ssl/certs/ca-certificates.crt*.
+
+.. code-block:: console
+
+   ca-cert-path /etc/ssl/certs/ca-certificates.crt
+
+
+tuntap Section
+--------------
+
+The "tuntap" driver configures a point-to-point interface between the vpp
+engine and the local Linux kernel stack. This allows e.g. users to ssh to the
+host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
+is currently disabled by default. To [dynamically] create TAP interfaces - the
+preferred scheme - see the "tap_connect" binary API. The Linux network stack
+"vnet" interface needs to manually configure, and VLAN and other settings if
+desired.
+
+
+enable|disable
+^^^^^^^^^^^^^^
+
+Enable or disable the tun/tap driver.
+
+.. code-block:: console
+
+   enable
+
+ethernet|ether
+^^^^^^^^^^^^^^
+
+Create a tap device (ethernet MAC) instead of a tun device (point-to-point
+tunnel). The two keywords are aliases for the same function.
+
+.. code-block:: console
+
+   ethernet
+
+have-normal-interface|have-normal
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Treat the host Linux stack as a routing peer instead of programming VPP
+interface L3 addresses onto the tun/tap devices. The two keywords are
+aliases for the same function.
+
+.. code-block:: console
+
+   have-normal-interface
+
+name 
+^^^^^^^^^^^
+
+Assign name to the tun/tap device.
+
+.. code-block:: console
+
+   name vpp1
+
+
+vhost-user Section
+------------------
+
+Vhost-user configuration parameters control the vhost-user driver.
+
+coalesce-frames 
+^^^^^^^^^^^^^^^^^^^
+
+Subject to deadline-timer expiration - see next item - attempt to transmit
+at least  packet frames. Default is 32 frames.
+
+.. code-block:: console
+
+   coalesce-frames 64
+
+coalesce-time 
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Hold packets no longer than (floating-point) seconds before transmitting
+them. Default is 0.001 seconds
+
+.. code-block:: console
+
+   coalesce-time 0.002
+
+dont-dump-memory
+^^^^^^^^^^^^^^^^
+
+vhost-user shared-memory segments can add up to a large amount of memory, so
+it's handy to avoid adding them to corefiles when using a significant number
+of such interfaces.
+
+.. code-block:: console
+
+   dont-dump-memory
+
+
+vlib Section
+------------
+
+These parameters configure VLIB, such as allowing you to choose whether to
+enable memory traceback or a post-mortem elog dump.
+
+memory-trace
+^^^^^^^^^^^^
+
+Enables memory trace (mheap traceback.) Defaults to 0, meaning memory
+trace is disabled.
+
+.. code-block:: console
+
+   memory-trace
+
+elog-events 
+^^^^^^^^^^^^^^^
+
+Sets the number of elements/events (the size) of the event ring
+(a circular buffer of events.) This number rounds to a power of 2.
+Defaults to 131072 (128 << 10) elements.
+
+.. code-block:: console
+
+   elog-events 4096
+
+elog-post-mortem-dump
+^^^^^^^^^^^^^^^^^^^^^
+
+Enables the attempt of a post-mortem elog dump to
+*/tmp/elog_post_mortem.* if os_panic or
+os_exit is called.
+
+.. code-block:: console
+
+   elog-post-mortem-dump
diff --git a/docs/contributing/gitreview.rst b/docs/contributing/gitreview.rst
new file mode 100644
index 00000000000..b2608d11812
--- /dev/null
+++ b/docs/contributing/gitreview.rst
@@ -0,0 +1,199 @@
+.. _gitreview:
+
+*******************************
+Getting a Patch Reviewed
+*******************************
+
+This section describes how to get FD.io VPP sources reviewed and merged.
+
+Setup
+========
+
+If you don't have a Linux Foundation ID, `create one here. `_
+
+With your Linux Foundation ID credentials sign into `Gerrit Code Review at gerrit.fd.io `_
+
+`Install git-review, `_ which is a "command-line tool for Git / Gerrit to submit a change or to fetch an existing one."
+
+If you're on Ubuntu, install keychain:
+
+.. code-block:: console
+
+    $ sudo apt-get install keychain
+
+ssh keys
+-------------
+
+To get FD.io VPP documents reviewed the VPP repository should be cloned with ssh. You should be logged into Gerrit Code Review as noted above.
+
+Create your public and private ssh key with:
+
+.. code-block:: console
+
+    $ ssh-keygen -t rsa
+    $ keychain
+    $ cat ~/.ssh/id_rsa.pub
+
+Copy **all** the contents of the public key (id_rsa.pub) output by the above **cat** command. Then go to your `SSH Public keys settings page `_, click **Add Key ...**, paste your public key, and finally click **Add**.
+
+.. _clone-ssh:
+
+Clone with ssh
+==============
+
+Clone the repo with:
+
+.. code-block:: console
+
+    $ git clone ssh://gerrit.fd.io:29418/vpp
+    $ cd vpp
+
+This will only work if the name of the user on your system matches your Gerrit username.
+
+Otherwise, clone with:
+
+.. code-block:: console
+
+    $ git clone ssh://@gerrit.fd.io:29418/vpp
+    $ cd vpp
+
+When attempting to clone the repo Git will prompt you asking if you want to add the Server Host Key to the list of known hosts. Enter **yes** and press the **Enter** key.
+
+Git Review
+===========
+
+The VPP documents use the gerrit server, and git review for submitting and fetching patches.
+
+
+New patch
+-----------------
+
+When working with a new patch, use the following commands to get your patch reviewed.
+
+Make sure you have modified the correct files by issuing the following commands:
+
+.. code-block:: console
+
+    $ git status
+    $ git diff
+
+Then add and commit the patch. You may want to add a tag to the commit comments.
+For example for a document with only patches you should add the tag **docs:**.
+
+.. code-block:: console
+
+    $ git add 
+    $ git commit -s
+
+The commit comment should have something like the following comment:
+
+.. code-block:: console
+
+   docs: A brief description of the commit
+
+   Type: Improvement (The type of commit this could be: Improvement, Fix or Feature)
+
+   A detailed description of the commit could go here.
+
+Push the patch for review.
+
+.. code-block:: console
+
+    $ git review
+
+If you are creating a draft, meaning you do not want your changes reviewed yet, do the following:
+
+.. code-block:: console
+
+    $ git review -D
+
+After submitting a review, reset where the HEAD is pointing to with:
+
+.. code-block:: console
+
+    $ git reset --hard origin/master
+
+Existing patch
+-----------------------
+
+The "change number" used below is in the URL of the review.
+
+After clicking an individual review, the change number can be found in the URL at "https://gerrit.fd.io/r/#/c/<*CHANGE_NUMBER*>/"
+
+To view an existing patch:
+
+.. code-block:: console
+
+    $ git review -d 
+    $ git status
+    $ git diff
+
+.. caution::
+
+    If you have made changes and do "git review -d ", your current
+    changes will try to be stashed so that the working tree can change to the review branch
+    you specified. If you want to make sure you don't lose your changes, clone another Gerrit
+    repo into a new directory using the cloning steps shown in :ref:`clone-ssh`, and perform
+    "git review -d " in this new directory.
+
+To modify an existing patch, make sure you modified the correct files, and apply the patch with:
+
+.. code-block:: console
+
+    $ git review -d 
+    $ git status
+    $ git diff
+
+    $ git add 
+    $ git commit --amend
+    $ git review
+
+When you're done viewing or modifying a branch, get back to the master branch by entering:
+
+.. code-block:: console
+
+    $ git reset --hard origin/master
+    $ git checkout master
+
+Patch Conflict Resolution
+-------------------------
+
+Two different patch conflict scenarios arise from time to
+time. Sometime after uploading a patch to https://gerrit.fd.io, the
+gerrit UI may show a patch status of "Merge Conflict."
+
+Or, you may attempt to upload a new patch-set via "git review," only to
+discover that the gerrit server won't allow the upload due to an upstream
+merge conflict.
+
+In both cases, it's [usually] fairly simple to fix the problem. You
+need to rebase the patch onto master/latest. Details vary from case to
+case.
+
+Here's how to rebase a patch previously uploaded to the Gerrit server
+which now has a merge conflict. In a fresh workspace cloned from
+master/latest, do the following:
+
+.. code-block:: console
+
+    $ git-review -d <*Gerrit change #*>
+    $ git rebase origin/master
+       while (conflicts)
+          
+          $ git rebase --continue
+    $ git review
+
+In the upload-failure case, use caution: carefully **save your work**
+before you do anything else!
+
+Rebase your patch and try again. Please **do not** re-download ["git
+review -d"] the patch from the gerrit server...:
+
+.. code-block:: console
+
+    $ git rebase origin/master
+       while (conflicts)
+          
+          $ git rebase --continue
+    $ git review
+
diff --git a/docs/contributing/reportingissues/index.rst b/docs/contributing/reportingissues/index.rst
new file mode 100644
index 00000000000..b16a2a915a8
--- /dev/null
+++ b/docs/contributing/reportingissues/index.rst
@@ -0,0 +1,23 @@
+.. _reportingissues:
+
+Reporting Bugs
+==============
+
+Although every situation is different, this section describes how to
+collect data which will help make efficient use of everyone's time
+when dealing with vpp bugs.
+
+Before you press the Jira button to create a bug report - or email
+vpp-dev@lists.fd.io - please ask yourself whether there's enough
+information for someone else to understand and to reproduce the issue
+given a reasonable amount of effort. **Unicast emails to maintainers,
+committers, and the project PTL are strongly discouraged.**
+
+A good strategy for clear-cut bugs: file a detailed Jira ticket, and
+then send a short description of the issue to vpp-dev@lists.fd.io,
+perhaps from the Jira ticket description. It's fine to send email to
+vpp-dev@lists.fd.io to ask a few questions **before** filing Jira tickets.
+
+.. toctree::
+
+  reportingissues
diff --git a/docs/contributing/reportingissues/reportingissues.rst b/docs/contributing/reportingissues/reportingissues.rst
new file mode 100644
index 00000000000..970f3407c54
--- /dev/null
+++ b/docs/contributing/reportingissues/reportingissues.rst
@@ -0,0 +1,266 @@
+.. _reportingbugs:
+
+.. toctree::
+
+Data to include in bug reports
+==============================
+
+Image version and operating environment
+---------------------------------------
+
+Please make sure to include the vpp image version and command-line arguments.
+
+.. code-block:: console
+
+    $ sudo bash
+    # vppctl show version verbose cmdline
+    Version:                  v18.07-rc0~509-gb9124828
+    Compiled by:              vppuser
+    Compile host:             vppbuild
+    Compile date:             Fri Jul 13 09:05:37 EDT 2018
+    Compile location:         /scratch/vpp-showversion
+    Compiler:                 GCC 7.3.0
+    Current PID:              5211
+    Command line arguments:
+      /scratch/vpp-showversion/build-root/install-vpp_debug-native/vpp/bin/vpp
+      unix
+      interactive
+
+With respect to the operating environment: if misbehavior involving a
+specific VM / container / bare-metal environment is involved, please
+describe the environment in detail:
+
+* Linux Distro (e.g. Ubuntu 18.04.2 LTS, CentOS-7, etc.)
+* NIC type(s) (ixgbe, i40e, enic, etc. etc.), vhost-user, tuntap
+* NUMA configuration if applicable
+
+Please note the CPU architecture (x86_86, aarch64), and hardware platform.
+
+When practicable, please report issues against released software, or
+unmodified master/latest software.
+
+"Show" command output
+---------------------
+
+Every situation is different. If the issue involves a sequence of
+debug CLI command, please enable CLI command logging, and send the
+sequence involved. Note that the debug CLI is a developer's tool -
+**no warranty express or implied** - and that we may choose not to fix
+debug CLI bugs.
+
+Please include "show error" [error counter] output. It's often helpful
+to "clear error", send a bit of traffic, then "show error"
+particularly when running vpp on noisy networks.
+
+Please include ip4 / ip6 / mpls FIB contents ("show ip fib", "show ip6
+fib", "show mpls fib", "show mpls tunnel").
+
+Please include "show hardware", "show interface", and "show interface
+address" output
+
+Here is a consolidated set of commands that are generally useful
+before/after sending traffic.  Before sending traffic:
+
+.. code-block:: console
+
+    vppctl clear hardware
+    vppctl clear interface
+    vppctl clear error
+    vppctl clear run
+
+Send some traffic and then issue the following commands.
+
+.. code-block:: console
+
+    vppctl show version verbose
+    vppctl show hardware
+    vppctl show interface address
+    vppctl show interface
+    vppctl show run
+    vppctl show error
+
+Here are some protocol specific show commands that may also make
+sense.  Only include those features which have been configured.
+
+.. code-block:: console
+
+     vppctl show l2fib
+     vppctl show bridge-domain
+
+     vppctl show ip fib
+     vppctl show ip neighbors
+
+     vppctl show ip6 fib
+     vppctl show ip6 neighbors
+
+     vppctl show mpls fib
+     vppctl show mpls tunnel
+
+Network Topology
+----------------
+
+Please include a crisp description of the network topology, including
+L2 / IP / MPLS / segment-routing addressing details. If you expect
+folks to reproduce and debug issues, this is a must.
+
+At or above a certain level of topological complexity, it becomes
+problematic to reproduce the original setup.
+
+Packet Tracer Output
+--------------------
+
+If you capture packet tracer output which seems relevant, please include it.
+
+.. code-block:: console
+
+    vppctl trace add dpdk-input 100  # or similar
+
+send-traffic
+
+.. code-block:: console
+
+    vppctl show trace
+
+Capturing post-mortem data
+==========================
+
+It should go without saying, but anyhow: **please put post-mortem data
+in obvious, accessible places.** Time wasted trying to acquire
+accounts, credentials, and IP addresses simply delays problem
+resolution.
+
+Please remember to add post-mortem data location information to Jira
+tickets.
+
+Syslog Output
+-------------
+
+The vpp signal handler typically writes a certain amount of data in
+/var/log/syslog before exiting. Make sure to check for evidence, e.g
+via "grep /usr/bin/vpp /var/log/syslog" or similar.
+
+Binary API Trace
+----------------
+
+If the issue involves a sequence of control-plane API messages - even
+a very long sequence - please enable control-plane API
+tracing. Control-plane API post-mortem traces end up in
+/tmp/api_post_mortem..
+
+Please remember to put post-mortem binary api traces in accessible
+places.
+
+These API traces are especially helpful in cases where the vpp engine
+is throwing traffic on the floor, e.g. for want of a default route or
+similar.
+
+Make sure to leave the default stanza "... api-trace { on } ... " in
+the vpp startup configuration file /etc/vpp/startup.conf, or to
+include it in the command line arguments passed by orchestration
+software.
+
+Core Files
+----------
+
+Production systems, as well as long-running pre-production soak-test
+systems, **must** arrange to collect core images. There are various
+ways to configure core image capture, including e.g. the Ubuntu
+"corekeeper" package. In a pinch, the following very basic sequence
+will capture usable vpp core files in /tmp/dumps.
+
+.. code-block:: console
+
+    # mkdir -p /tmp/dumps
+    # sysctl -w debug.exception-trace=1
+    # sysctl -w kernel.core_pattern="/tmp/dumps/%e-%t"
+    # ulimit -c unlimited
+    # echo 2 > /proc/sys/fs/suid_dumpable
+
+If you start VPP from systemd, you also need to edit
+/lib/systemd/system/vpp.service and uncomment the "LimitCORE=infinity"
+line before restarting VPP.
+
+Vpp core files often appear enormous, but they are invariably
+sparse. Gzip compresses them to manageable sizes. A multi-GByte
+corefile often compresses to 10-20 Mbytes.
+
+When decompressing a vpp core file, we suggest using "dd" as shown to
+create a sparse, uncompressed core file:
+
+.. code-block:: console
+
+   $ zcat vpp_core.gz | dd conv=sparse of=vpp_core
+
+Please remember to put compressed core files in accessible places.
+
+Make sure to leave the default stanza "... unix { ... full-coredump
+... } ... " in the vpp startup configuration file
+/etc/vpp/startup.conf, or to include it in the command line arguments
+passed by orchestration software.
+
+Core files from Private Images
+==============================
+
+Core files from private images require special handling. If it's
+necessary to go that route, copy the **exact** Debian packages (or
+RPMs) which correspond to the core file to the same public place as
+the core file. A no-excuses-allowed, hard-and-fast requirement.
+
+In particular:
+
+.. code-block:: console
+
+  libvppinfra__.deb # vppinfra library
+  libvppinfra-dev__.deb # vppinfra library development pkg
+  vpp__.deb         # the vpp executable
+  vpp-dbg__.deb     # debug symbols
+  vpp-dev__.deb     # vpp development pkg
+  vpp-lib__.deb     # shared libraries
+  vpp-plugin-core__.deb # core plugins
+  vpp-plugin-dpdk__.deb # dpdk plugin
+
+For reference, please include git commit-ID, branch, and git repo
+information [for repos other than gerrit.fd.io] in the Jira ticket.
+
+Note that git commit-ids are crypto sums of the head [latest]
+**merged** patch. They say **nothing whatsoever** about local
+workspace modifications, branching, or the git repo in question.
+
+Even given a byte-for-byte identical source tree, it's easy to build
+dramatically different binary artifacts. All it takes is a different
+toolchain version.
+
+
+On-the-fly Core File Compression
+--------------------------------
+
+Depending on operational requirements, it's possible to compress
+corefiles as they are generated. Please note that it takes several
+seconds' worth of wall-clock time to compress a vpp core file on the
+fly, during which all packet processing activities are suspended.
+
+To create compressed core files on the fly, create the following
+script, e.g. in /usr/local/bin/compressed_corefiles, owned by root,
+executable:
+
+.. code-block:: console
+
+  #!/bin/sh
+  exec /bin/gzip -f - >"/tmp/dumps/core-$1.$2.gz"
+
+Adjust the kernel core file pattern as shown:
+
+.. code-block:: console
+
+  sysctl -w kernel.core_pattern="|/usr/local/bin/compressed_corefiles %e %t"
+
+Core File Summary
+-----------------
+
+Bottom line: please follow core file handling instructions to the
+letter. It's not complicated. Simply copy the exact Debian packages or
+RPMs which correspond to core files to accessible locations.
+
+If we go through the setup process only to discover that the image and
+core files don't match, it will simply delay resolution of the issue;
+to say nothing of irritating the person who just wasted their time.
diff --git a/docs/contributing/writingdocs.rst b/docs/contributing/writingdocs.rst
new file mode 100644
index 00000000000..ba3713045cc
--- /dev/null
+++ b/docs/contributing/writingdocs.rst
@@ -0,0 +1,52 @@
+.. _buildingrst:
+
+Writing VPP Documentation
+=========================
+
+These instructions show how the VPP documentation sources are built.
+
+The VPP Documents are written using `reStructuredText `_ (rst),
+or markdown (md). These files are then built using the Sphinx build system `Sphinx `_.
+
+Building the docs
+-----------------
+
+Start with a clone of the vpp repository.
+
+.. code-block:: console
+
+   $ git clone https://gerrit.fd.io/r/vpp
+   $ cd vpp
+
+Build the html **index.html** file:
+
+.. code-block:: console
+
+   $ make docs
+
+Delete all the generated files with the following:
+
+.. code-block:: console
+
+   $ make docs-clean
+
+View the results
+----------------
+
+If there are no errors during the build process, you should now have an ``index.html`` file in your ``vpp/docs/_build/html`` directory, which you can then view in your browser.
+
+Whenever you make changes to your ``.rst`` files that you want to see, repeat this build process.
+
+Writing Docs and merging
+------------------------
+
+Documentation should be added as ``.rst`` file in the ``./src/`` tree next to the code it refers to. A symlink should be added at the relevant place in the ``./docs`` folder and a link in the appropriate place in the tree.
+
+To ensure documentation is correctly inserted, you can run
+
+.. code-block:: console
+
+   $ ./extras/scripts/check_documentation.sh
+
+VPP documents are reviewed and merged like and other source code. Refer to :ref:`gitreview`
+to get your changes reviewed and merged.
diff --git a/docs/developer/build-run-debug/building.rst b/docs/developer/build-run-debug/building.rst
new file mode 100644
index 00000000000..1df838abf84
--- /dev/null
+++ b/docs/developer/build-run-debug/building.rst
@@ -0,0 +1,181 @@
+.. _building:
+
+.. toctree::
+
+Building VPP
+============
+
+To get started developing with VPP, you need to get the required VPP sources and then build the packages.
+For more detailed information on the build system please refer to :ref:`buildsystem`.
+
+.. _setupproxies:
+
+Set up Proxies
+--------------------------
+
+Depending on the environment you are operating in, proxies may need to be set.
+Run these proxy commands to specify the *proxy-server-name* and corresponding *port-number*:
+
+.. code-block:: console
+
+    $ export http_proxy=http://.com:
+    $ export https_proxy=https://.com:
+
+
+Get the VPP Sources
+-----------------------------------
+
+To get the VPP sources that are used to create the build, run the following commands:
+
+.. code-block:: console
+
+    $ git clone https://gerrit.fd.io/r/vpp
+    $ cd vpp
+
+Build VPP Dependencies
+--------------------------------------
+
+Before building a VPP image, make sure there are no FD.io VPP or DPDK packages
+installed, by entering the following commands:
+
+.. code-block:: console
+
+    $ dpkg -l | grep vpp
+    $ dpkg -l | grep DPDK
+
+There should be no output, or no packages shown after the above commands are run.
+
+Run the following **make** command to install the dependencies for FD.io VPP.
+
+If the download hangs at any point, then you may need to
+:ref:`set up proxies ` for the download to work.
+
+.. code-block:: console
+
+    $ make install-dep
+    Hit:1 http://us.archive.ubuntu.com/ubuntu xenial InRelease
+    Get:2 http://us.archive.ubuntu.com/ubuntu xenial-updates InRelease [109 kB]
+    Get:3 http://security.ubuntu.com/ubuntu xenial-security InRelease [107 kB]
+    Get:4 http://us.archive.ubuntu.com/ubuntu xenial-backports InRelease [107 kB]
+    Get:5 http://us.archive.ubuntu.com/ubuntu xenial-updates/main amd64 Packages [803 kB]
+    Get:6 http://us.archive.ubuntu.com/ubuntu xenial-updates/main i386 Packages [732 kB]
+    ...
+    ...
+    Update-alternatives: using /usr/lib/jvm/java-8-openjdk-amd64/bin/jmap to provide /usr/bin/jmap (jmap) in auto mode
+    Setting up default-jdk-headless (2:1.8-56ubuntu2) ...
+    Processing triggers for libc-bin (2.23-0ubuntu3) ...
+    Processing triggers for systemd (229-4ubuntu6) ...
+    Processing triggers for ureadahead (0.100.0-19) ...
+    Processing triggers for ca-certificates (20160104ubuntu1) ...
+    Updating certificates in /etc/ssl/certs...
+    0 added, 0 removed; done.
+    Running hooks in /etc/ca-certificates/update.d...
+
+    done.
+    done.
+
+Build VPP (Debug)
+----------------------------
+
+This build version contains debug symbols which are useful for modifying VPP. The
+**make** command below builds a debug version of VPP. The binaries, when building the
+debug images, can be found in /build-root/vpp_debug-native.
+
+The Debug build version contains debug symbols, which are useful for troubleshooting
+or modifying VPP. The **make** command below, builds a debug version of VPP. The
+binaries used for building the debug image can be found in */build-root/vpp_debug-native*.
+
+.. code-block:: console
+
+    $ make build
+    make[1]: Entering directory '/home/vagrant/vpp-master/build-root'
+    @@@@ Arch for platform 'vpp' is native @@@@
+    @@@@ Finding source for dpdk @@@@
+    @@@@ Makefile fragment found in /home/vagrant/vpp-master/build-data/packages/dpdk.mk @@@@
+    @@@@ Source found in /home/vagrant/vpp-master/dpdk @@@@
+    @@@@ Arch for platform 'vpp' is native @@@@
+    @@@@ Finding source for vpp @@@@
+    @@@@ Makefile fragment found in /home/vagrant/vpp-master/build-data/packages/vpp.mk @@@@
+    @@@@ Source found in /home/vagrant/vpp-master/src @@@@
+    ...
+    ...
+    make[5]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp/vpp-api/java'
+    make[4]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp/vpp-api/java'
+    make[3]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp'
+    make[2]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp'
+    @@@@ Installing vpp: nothing to do @@@@
+    make[1]: Leaving directory '/home/vagrant/vpp-master/build-root'
+
+Build VPP (Release Version)
+-----------------------------------------
+
+This section describes how to build the regular release version of FD.io VPP. The
+release build is optimized and does not create any debug symbols.
+The binaries used in building the release images are found in */build-root/vpp-native*.
+
+Use the following **make** command below to build the release version of FD.io VPP.
+
+.. code-block:: console
+
+    $ make build-release
+
+
+Building Necessary Packages
+--------------------------------------------
+
+The package that needs to be built depends on the type system VPP will be running on:
+
+* The :ref:`Debian package ` is built if VPP is going to run on Ubuntu
+* The :ref:`RPM package ` is built if VPP is going to run on Centos or Redhat
+
+.. _debianpackages:
+
+Building Debian Packages
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To build the debian packages, use the following command:
+
+.. code-block:: console
+
+    $ make pkg-deb
+
+.. _rpmpackages:
+
+Building RPM Packages
+^^^^^^^^^^^^^^^^^^^^^^^
+
+To build the rpm packages, use one of the following commands below, depending on the system:
+
+.. code-block:: console
+
+    $ make pkg-rpm
+
+Once the packages are built they can be found in the build-root directory.
+
+.. code-block:: console
+
+    $ ls *.deb
+
+    If the packages are built correctly, then this should be the corresponding output:
+
+    vpp_18.07-rc0~456-gb361076_amd64.deb             vpp-dbg_18.07-rc0~456-gb361076_amd64.deb
+    vpp-dev_18.07-rc0~456-gb361076_amd64.deb         vpp-api-lua_18.07-rc0~456-gb361076_amd64.deb
+    vpp-lib_18.07-rc0~456-gb361076_amd64.deb         vpp-api-python_18.07-rc0~456-gb361076_amd64.deb
+    vpp-plugins_18.07-rc0~456-gb361076_amd64.deb
+
+Finally, the created packages can be installed using the following commands. Install
+the package that corresponds to OS that VPP will be running on:
+
+For Ubuntu:
+
+.. code-block:: console
+
+   $ sudo bash
+   # dpkg -i *.deb
+
+For Centos or Redhat:
+
+.. code-block:: console
+
+   $ sudo bash
+   # rpm -ivh *.rpm
diff --git a/docs/developer/build-run-debug/cross_compile_macos.rst b/docs/developer/build-run-debug/cross_compile_macos.rst
new file mode 100644
index 00000000000..5eec5569a8b
--- /dev/null
+++ b/docs/developer/build-run-debug/cross_compile_macos.rst
@@ -0,0 +1,70 @@
+.. _cross_compile_macos :
+
+Cross compilation on MacOS
+==========================
+
+This is a first attempt to support Cross compilation of VPP on MacOS for development (linting, completion, compile_commands.json)
+
+
+**Prerequisites**
+
+* You'll need to install the following packages
+
+.. code-block:: console
+
+  $ pip3 install ply pyyaml jsonschema
+  $ brew install gnu-sed pkg-config ninja crosstool-ng
+
+* You'll also need to install ``clang-format 10.0.0`` to be able to ``make checkstyle``. This can be done with :ref:`this doc`
+* You should link the binaries to make them available in your path with their original names e.g. :
+
+.. code-block:: console
+
+  $ ln -s $(which gsed) /usr/local/bin/sed
+
+**Setup**
+
+* Create a `cross compile toolchain `_
+* Create a case sensitive volume and mount the toolchain in it e.g. in ``/Volumes/xchain``
+* Create a xchain.toolchain file with ``$VPP_DIR/extras/scripts/cross_compile_macos.sh conf /Volumes/xchan``
+
+For now we don't support e-build so dpdk, rdma, quicly won't be compiled as part of ``make build``
+
+To build with the toolchain do:
+
+.. code-block:: console
+
+  $ $VPP_DIR/extras/scripts/cross_compile_macos.sh build
+
+
+To get the compile_commands.json do
+
+.. code-block:: console
+
+  $ $VPP_DIR/extras/scripts/cross_compile_macos.sh cc
+  $ >> ./build-root/build-vpp[_debug]-native/vpp/compile_commands.json
+
+
+
+This should build vpp on MacOS
+
+
+Good luck :)
+
+.. _install_clang_format_10_0_0 :
+
+Installing clang-format 10.0.0
+------------------------------
+
+In order to install clang-format on macos :
+
+.. code-block:: bash
+
+    $ wget https://github.com/llvm/llvm-project/releases/download/llvmorg-10.0.0/clang-10.0.0.src.tar.xz
+    $ tar -xvf clang+llvm-10.0.0-x86_64-apple-darwin.tar.xz
+    $ mv clang+llvm-10.0.0-x86_64-apple-darwin /usr/local/Cellar/
+    $ sudo ln -s ../Cellar/clang+llvm-10.0.0-x86_64-apple-darwin/bin/clang-format /usr/local/bin/clang-format
+    $ sudo ln -s ../Cellar/clang+llvm-10.0.0-x86_64-apple-darwin/bin/clang-format /usr/local/bin/clang-format-10
+    $ sudo ln -s ../Cellar/clang+llvm-10.0.0-x86_64-apple-darwin/share/clang/clang-format-diff.py /usr/local/bin/clang-format-diff-10
+
+Source `Clang website `_
diff --git a/docs/developer/build-run-debug/gdb_examples.rst b/docs/developer/build-run-debug/gdb_examples.rst
new file mode 100644
index 00000000000..2a33f17f4da
--- /dev/null
+++ b/docs/developer/build-run-debug/gdb_examples.rst
@@ -0,0 +1,141 @@
+.. _gdb_examples:
+
+.. toctree::
+
+GDB Examples
+===============
+
+In this section we have a few useful gdb commands.
+
+Starting GDB
+----------------------------
+
+Once at the gdb prompt, VPP can be started by running the following commands:
+
+.. code-block:: console
+
+   (gdb) run -c /etc/vpp/startup.conf
+   Starting program: /scratch/vpp-master/build-root/install-vpp_debug-native/vpp/bin/vpp -c /etc/vpp/startup.conf
+    [Thread debugging using libthread_db enabled]
+    Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
+    vlib_plugin_early_init:361: plugin path /scratch/vpp-master/build-root/install-vpp_debug-native/vpp/lib/vpp_plugins:/scratch/vpp-master/build-root/install-vpp_debug-native/vpp/lib/vpp_plugins
+    ....
+
+Backtrace
+----------------------------
+
+If you encounter errors when running VPP, such as VPP terminating due to a segfault
+or abort signal, then you can run the VPP debug binary and then execute **backtrace** or **bt**.
+
+.. code-block:: console
+
+    (gdb) bt
+    #0  ip4_icmp_input (vm=0x7ffff7b89a40 , node=0x7fffb6bb6900, frame=0x7fffb6725ac0) at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:187
+    #1  0x00007ffff78da4be in dispatch_node (vm=0x7ffff7b89a40 , node=0x7fffb6bb    6900, type=VLIB_NODE_TYPE_INTERNAL, dispatch_state=VLIB_NODE_STATE_POLLING, frame=0x7fffb6725ac0, last_time_stamp=10581236529    65565) at /scratch/vpp-master/build-data/../src/vlib/main.c:988
+    #2  0x00007ffff78daa77 in dispatch_pending_node (vm=0x7ffff7b89a40 , pending_frame_index=6, last_time_stamp=1058123652965565) at /scratch/vpp-master/build-data/../src/vlib/main.c:1138
+    ....
+
+Get to the GDB prompt
+---------------------------------------
+
+When VPP is running, you can get to the command prompt by pressing **CTRL+C**.
+
+Breakpoints
+---------------------------------------
+
+When at the GDB prompt, set a breakpoint by running the commands below:
+
+.. code-block:: console
+
+    (gdb) break ip4_icmp_input
+    Breakpoint 4 at 0x7ffff6b9c00b: file /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c, line 142.
+
+List the breakpoints already set:
+
+.. code-block:: console
+
+    (gdb) i b
+    Num     Type           Disp Enb Address            What
+    1       breakpoint     keep y   0x00007ffff6b9c00b in ip4_icmp_input at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
+        breakpoint already hit 3 times
+    2       breakpoint     keep y   0x00007ffff6b9c00b in ip4_icmp_input at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
+    3       breakpoint     keep y   0x00007ffff640f646 in tw_timer_expire_timers_internal_1t_3w_1024sl_ov
+        at /scratch/vpp-master/build-data/../src/vppinfra/tw_timer_template.c:775
+
+Delete a breakpoint:
+
+.. code-block:: console
+
+    (gdb) del 2
+    (gdb) i b
+    Num     Type           Disp Enb Address            What
+    1       breakpoint     keep y   0x00007ffff6b9c00b in ip4_icmp_input at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
+	breakpoint already hit 3 times
+    3       breakpoint     keep y   0x00007ffff640f646 in tw_timer_expire_timers_internal_1t_3w_1024sl_ov
+        at /scratch/vpp-master/build-data/../src/vppinfra/tw_timer_template.c:775
+
+Step/Next/List
+---------------------------------------
+
+Step through the code using (s)tep into, (n)ext, and list some lines before and after where you are with list.
+
+.. code-block:: console
+
+    Thread 1 "vpp_main" hit Breakpoint 1, ip4_icmp_input (vm=0x7ffff7b89a40 , node=0x7fffb6bb6900, frame=0x7fffb6709480)
+        at /scratch/jdenisco/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
+    142	{
+    (gdb) n
+    143	  icmp4_main_t *im = &icmp4_main;
+    (
+    (gdb) list
+    202	      vlib_put_next_frame (vm, node, next, n_left_to_next);
+    203	    }
+    204
+    205	  return frame->n_vectors;
+    206	}
+    207
+    208	/* *INDENT-OFF* */
+    209	VLIB_REGISTER_NODE (ip4_icmp_input_node,static) = {
+    210	  .function = ip4_icmp_input,
+    211	  .name = "ip4-icmp-input",
+
+Examining Data and packets
+-----------------------------------------------
+
+To look at data and packets use e(x)amine or (p)rint.
+
+
+For example in this code look at the ip packet:
+
+.. code-block:: console
+
+    (gdb) p/x *ip0
+    $3 = {{ip_version_and_header_length = 0x45, tos = 0x0, length = 0x5400,
+    fragment_id = 0x7049, flags_and_fragment_offset = 0x40, ttl = 0x40, protocol = 0x1,
+    checksum = 0x2ddd, {{src_address = {data = {0xa, 0x0, 0x0, 0x2},
+    data_u32 = 0x200000a, as_u8 = {0xa, 0x0, 0x0, 0x2}, as_u16 = {0xa, 0x200},
+    as_u32 = 0x200000a}, dst_address = {data = {0xa, 0x0, 0x0, 0xa}, data_u32 = 0xa00000a,
+    as_u8 = {0xa, 0x0, 0x0, 0xa}, as_u16 = {0xa, 0xa00},  as_u32 = 0xa00000a}},
+    address_pair = {src = {data = {0xa, 0x0, 0x0, 0x2}, data_u32 = 0x200000a,
+    as_u8 = {0xa, 0x0, 0x0, 0x2}, as_u16 = {0xa, 0x200},  as_u32 = 0x200000a},
+    dst = {data = {0xa, 0x0, 0x0, 0xa}, data_u32 = 0xa00000a, as_u8 = {0xa, 0x0, 0x0, 0xa},
+    as_u16 = {0xa, 0xa00}, as_u32 = 0xa00000a}}}}, {checksum_data_64 =
+    {0x40704954000045, 0x200000a2ddd0140}, checksum_data_64_32 = {0xa00000a}},
+    {checksum_data_32 = {0x54000045, 0x407049, 0x2ddd0140, 0x200000a, 0xa00000a}}}
+
+Then the icmp header
+
+.. code-block:: console
+
+    (gdb) p/x *icmp0
+    $4 = {type = 0x8, code = 0x0, checksum = 0xf148}
+
+Then look at the actual bytes:
+
+.. code-block:: console
+
+    (gdb) x/50w ip0
+    0x7fde9953510e:	0x54000045	0x00407049	0x2ddd0140	0x0200000a
+    0x7fde9953511e:	0x0a00000a	0xf1480008	0x03000554	0x5b6b2e8a
+    0x7fde9953512e:	0x00000000	0x000ca99a	0x00000000	0x13121110
+    0x7fde9953513e:	0x17161514	0x1b1a1918	0x1f1e1d1c	0x23222120
diff --git a/docs/developer/build-run-debug/index.rst b/docs/developer/build-run-debug/index.rst
new file mode 100644
index 00000000000..f8bfeab0bf8
--- /dev/null
+++ b/docs/developer/build-run-debug/index.rst
@@ -0,0 +1,14 @@
+.. _build_run_debug:
+
+=======================
+Build, Run & Debug
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   building
+   running_vpp
+   testing_vpp
+   gdb_examples
+   cross_compile_macos
diff --git a/docs/developer/build-run-debug/running_vpp.rst b/docs/developer/build-run-debug/running_vpp.rst
new file mode 100644
index 00000000000..9b33e53ec60
--- /dev/null
+++ b/docs/developer/build-run-debug/running_vpp.rst
@@ -0,0 +1,48 @@
+.. _running_vpp:
+
+.. toctree::
+
+Running VPP
+===========
+
+After building the VPP binaries, you now have several images built.
+These images are useful when you need to run VPP without installing the packages.
+For instance if you want to run VPP with GDB.
+
+Running Without GDB
+_________________________
+
+To run the VPP images that you've built without GDB, run the following commands:
+
+Running the release image:
+
+.. code-block:: console
+
+   # make run-release
+   #
+
+Running the debug image:
+
+.. code-block:: console
+
+   # make run
+   #
+
+Running With GDB
+_________________________
+
+With the following commands you can run VPP and then be dropped into the GDB prompt.
+
+Running the release image:
+
+.. code-block:: console
+
+   # make debug-release
+   (gdb)
+
+Running the debug image:
+
+.. code-block:: console
+
+   # make debug
+   (gdb)
diff --git a/docs/developer/build-run-debug/testing_vpp.rst b/docs/developer/build-run-debug/testing_vpp.rst
new file mode 100644
index 00000000000..ca9a09efb71
--- /dev/null
+++ b/docs/developer/build-run-debug/testing_vpp.rst
@@ -0,0 +1,140 @@
+Testing VPP
+===========
+
+As of this writing, the vpp source tree includes over 1,000 unit test
+vectors. Best practices prior to pushing patches for code review: make
+sure that all of the “make test” test vectors pass.
+
+We attempt to maintain the top-level “make test-help” command so that it
+accurately describes all of the “make test” options.
+
+Examples
+--------
+
+Basic test run, all test vectors, single-vpp instance, optimized image:
+
+::
+
+     $ make test
+
+10-way parallel basic test run:
+
+::
+
+     $ make TEST_JOBS=10 test
+
+Run a specific test suite (mpls, in this case):
+
+::
+
+     $ make TEST=test_mpls test
+
+Run a specific test suite, debug image, pause prior to running the test
+suite; attach to the vpp image in gdb:
+
+::
+
+     $ make TEST=xxx DEBUG=gdb test-debug
+
+Detailed Documentation
+----------------------
+
+Current “make test-help” output:
+
+::
+
+     $ make test-help
+      test                   - build and run (basic) functional tests
+      test-debug             - build and run (basic) functional tests (debug build)
+      test-all               - build and run functional and extended tests
+      test-all-debug         - build and run functional and extended tests (debug build)
+      retest                 - run functional tests
+      retest-debug           - run functional tests (debug build)
+      retest-all             - run functional and extended tests
+      retest-all-debug       - run functional and extended tests (debug build)
+      test-cov               - generate code coverage report for test framework
+      test-gcov                      - build and run functional tests (gcov build)
+      test-wipe              - wipe (temporary) files generated by unit tests
+      test-wipe-cov          - wipe code coverage report for test framework
+      test-wipe-doc          - wipe documentation for test framework
+      test-wipe-papi         - rebuild vpp_papi sources
+      test-wipe-all          - wipe (temporary) files generated by unit tests, docs, and coverage
+      test-shell             - enter shell with test environment
+      test-shell-debug       - enter shell with test environment (debug build)
+      test-checkstyle        - check PEP8 compliance for test framework
+      test-refresh-deps      - refresh the Python dependencies for the tests
+
+     Arguments controlling test runs:
+      V=[0|1|2]              - set test verbosity level
+                               0=ERROR, 1=INFO, 2=DEBUG
+      TEST_JOBS=[|auto]   - use at most  parallel python processes for test execution, if auto, set to number of available cpus (default: 1)
+      MAX_VPP_CPUS=[|auto]- use at most  cpus for running vpp main and worker threads, if auto, set to number of available cpus (default: auto)
+      CACHE_OUTPUT=[0|1]     - cache VPP stdout/stderr and log as one block after test finishes (default: 1)
+      FAILFAST=[0|1]         - fail fast if 1, complete all tests if 0
+      TIMEOUT=      - fail test suite if any single test takes longer than  (in seconds) to finish (default: 600)
+      RETRIES=            - retry failed tests  times
+      DEBUG=           - set VPP debugging kind
+         DEBUG=core          - detect coredump and load it in gdb on crash
+         DEBUG=gdb           - allow easy debugging by printing VPP PID
+                               and waiting for user input before running
+                               and tearing down a testcase
+         DEBUG=gdbserver     - run gdb inside a gdb server, otherwise
+                               same as above
+         DEBUG=attach        - attach test case to already running vpp in gdb (see test-start-vpp-in-gdb)
+
+      STEP=[yes|no]          - ease debugging by stepping through a testcase
+      SANITY=[yes|no]        - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)
+      EXTENDED_TESTS=[1|y]   - used by '[re]test-all' & '[re]test-all-debug' to run extended tests
+      TEST=          - filter the set of tests:
+         by file-name        - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py
+         by file-suffix      - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py
+         by wildcard         - wildcard filter is .., each can be replaced by '*'
+                               e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name
+                                    TEST='bfd.*.*' is equivalent to above example of filter by file-suffix
+                                    TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class
+                                    TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase
+                                    TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes
+
+      VARIANT=      - specify which march node variant to unit test
+                               e.g. VARIANT=skx test the skx march variants
+                               e.g. VARIANT=icl test the icl march variants
+
+      COREDUMP_SIZE=   - pass  as unix { coredump-size  } argument to vpp
+                               e.g. COREDUMP_SIZE=4g
+                                    COREDUMP_SIZE=unlimited
+      COREDUMP_COMPRESS=1    - compress core files if not debugging them
+      EXTERN_TESTS=    - path to out-of-tree test_.py files containing test cases
+      EXTERN_PLUGINS=  - path to out-of-tree plugins to be loaded by vpp under test
+      EXTERN_COV_DIR=  - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report
+
+      PROFILE=1              - enable profiling of test framework via cProfile module
+      PROFILE_SORT_BY=opt    - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)
+      PROFILE_OUTPUT=file    - output profiling info to file - use absolute path (default: stdout)
+
+      TEST_DEBUG=1           - turn on debugging of the test framework itself (expert)
+
+      SKIP_AARCH64=1         - skip tests that are failing on the ARM platorm in FD.io CI
+
+      RND_SEED=seed          - Seed RND with given seed
+
+     Starting VPP in GDB for use with DEBUG=attach:
+
+      test-start-vpp-in-gdb       - start VPP in gdb (release)
+      test-start-vpp-debug-in-gdb - start VPP in gdb (debug)
+
+     Arguments controlling VPP in GDB runs:
+
+      VPP_IN_GDB_TMP_DIR     - specify directory to run VPP IN (default: /tmp/unittest-attach-gdb)
+      VPP_IN_GDB_NO_RMDIR=0  - don't remove existing tmp dir but fail instead
+      VPP_IN_GDB_CMDLINE=1   - add 'interactive' to VPP arguments to run with command line
+
+     Creating test documentation
+      test-doc               - generate documentation for test framework
+      test-wipe-doc          - wipe documentation for test framework
+
+     Creating test code coverage report
+      test-cov               - generate code coverage report for test framework
+      test-wipe-cov          - wipe code coverage report for test framework
+
+     Verifying code-style
+      test-checkstyle        - check PEP8 compliance
diff --git a/docs/developer/corearchitecture/bihash.rst b/docs/developer/corearchitecture/bihash.rst
new file mode 100644
index 00000000000..9b62baaf9cf
--- /dev/null
+++ b/docs/developer/corearchitecture/bihash.rst
@@ -0,0 +1,313 @@
+Bounded-index Extensible Hashing (bihash)
+=========================================
+
+Vpp uses bounded-index extensible hashing to solve a variety of
+exact-match (key, value) lookup problems. Benefits of the current
+implementation:
+
+-  Very high record count scaling, tested to 100,000,000 records.
+-  Lookup performance degrades gracefully as the number of records
+   increases
+-  No reader locking required
+-  Template implementation, it’s easy to support arbitrary (key,value)
+   types
+
+Bounded-index extensible hashing has been widely used in databases for
+decades.
+
+Bihash uses a two-level data structure:
+
+::
+
+       +-----------------+
+       | bucket-0        |
+       |  log2_size      |
+       |  backing store  |
+       +-----------------+
+       | bucket-1        |
+       |  log2_size      |           +--------------------------------+
+       |  backing store  | --------> | KVP_PER_PAGE * key-value-pairs |
+       +-----------------+           | page 0                         |
+            ...                      +--------------------------------+
+       +-----------------+           | KVP_PER_PAGE * key-value-pairs |
+       | bucket-2**N-1   |           | page 1                         |
+       |  log2_size      |           +--------------------------------+
+       |  backing store  |                       ---
+       +-----------------+           +--------------------------------+
+                                     | KVP_PER_PAGE * key-value-pairs |
+                                     | page 2**(log2(size)) - 1       |
+                                     +--------------------------------+
+
+Discussion of the algorithm
+---------------------------
+
+This structure has a couple of major advantages. In practice, each
+bucket entry fits into a 64-bit integer. Coincidentally, vpp’s target
+CPU architectures support 64-bit atomic operations. When modifying the
+contents of a specific bucket, we do the following:
+
+-  Make a working copy of the bucket’s backing storage
+-  Atomically swap a pointer to the working copy into the bucket array
+-  Change the original backing store data
+-  Atomically swap back to the original
+
+So, no reader locking is required to search a bihash table.
+
+At lookup time, the implementation computes a key hash code. We use the
+least-significant N bits of the hash to select the bucket.
+
+With the bucket in hand, we learn log2 (nBackingPages) for the selected
+bucket. At this point, we use the next log2_size bits from the hash code
+to select the specific backing page in which the (key,value) page will
+be found.
+
+Net result: we search **one** backing page, not 2**log2_size pages. This
+is a key property of the algorithm.
+
+When sufficient collisions occur to fill the backing pages for a given
+bucket, we double the bucket size, rehash, and deal the bucket contents
+into a double-sized set of backing pages. In the future, we may
+represent the size as a linear combination of two powers-of-two, to
+increase space efficiency.
+
+To solve the “jackpot case” where a set of records collide under hashing
+in a bad way, the implementation will fall back to linear search across
+2**log2_size backing pages on a per-bucket basis.
+
+To maintain *space* efficiency, we should configure the bucket array so
+that backing pages are effectively utilized. Lookup performance tends to
+change *very little* if the bucket array is too small or too large.
+
+Bihash depends on selecting an effective hash function. If one were to
+use a truly broken hash function such as “return 1ULL.” bihash would
+still work, but it would be equivalent to poorly-programmed linear
+search.
+
+We often use cpu intrinsic functions - think crc32 - to rapidly compute
+a hash code which has decent statistics.
+
+Bihash Cookbook
+---------------
+
+Using current (key,value) template instance types
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+It’s quite easy to use one of the template instance types. As of this
+writing, …/src/vppinfra provides pre-built templates for 8, 16, 20, 24,
+40, and 48 byte keys, u8 \* vector keys, and 8 byte values.
+
+See …/src/vppinfra/{bihash\_\_8}.h
+
+To define the data types, #include a specific template instance, most
+often in a subsystem header file:
+
+.. code:: c
+
+        #include 
+
+If you’re building a standalone application, you’ll need to define the
+various functions by #including the method implementation file in a C
+source file.
+
+The core vpp engine currently uses most if not all of the known bihash
+types, so you probably won’t need to #include the method implementation
+file.
+
+.. code:: c
+
+        #include 
+
+Add an instance of the selected bihash data structure to e.g. a “main_t”
+structure:
+
+.. code:: c
+
+       typedef struct
+       {
+         ...
+         BVT (clib_bihash) hash_table;
+         or
+         clib_bihash_8_8_t hash_table;
+         ...
+       } my_main_t;
+
+The BV macro concatenate its argument with the value of the preprocessor
+symbol BIHASH_TYPE. The BVT macro concatenates its argument with the
+value of BIHASH_TYPE and the fixed-string “_t”. So in the above example,
+BVT (clib_bihash) generates “clib_bihash_8_8_t”.
+
+If you’re sure you won’t decide to change the template / type name
+later, it’s perfectly OK to code “clib_bihash_8_8_t” and so forth.
+
+In fact, if you #include multiple template instances in a single source
+file, you **must** use fully-enumerated type names. The macros stand no
+chance of working.
+
+Initializing a bihash table
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Call the init function as shown. As a rough guide, pick a number of
+buckets which is approximately
+number_of_expected_records/BIHASH_KVP_PER_PAGE from the relevant
+template instance header-file. See previous discussion.
+
+The amount of memory selected should easily contain all of the records,
+with a generous allowance for hash collisions. Bihash memory is
+allocated separately from the main heap, and won’t cost anything except
+kernel PTE’s until touched, so it’s OK to be reasonably generous.
+
+For example:
+
+.. code:: c
+
+       my_main_t *mm = &my_main;
+       clib_bihash_8_8_t *h;
+
+       h = &mm->hash_table;
+
+       clib_bihash_init_8_8 (h, "test", (u32) number_of_buckets,
+                              (uword) memory_size);
+
+Add or delete a key/value pair
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use BV(clib_bihash_add_del), or the explicit type variant:
+
+.. code:: c
+
+      clib_bihash_kv_8_8_t kv;
+      clib_bihash_8_8_t * h;
+      my_main_t *mm = &my_main;
+      clib_bihash_8_8_t *h;
+
+      h = &mm->hash_table;
+      kv.key = key_to_add_or_delete;
+      kv.value = value_to_add_or_delete;
+
+      clib_bihash_add_del_8_8 (h, &kv, is_add /* 1=add, 0=delete */);
+
+In the delete case, kv.value is irrelevant. To change the value
+associated with an existing (key,value) pair, simply re-add the [new]
+pair.
+
+Simple search
+~~~~~~~~~~~~~
+
+The simplest possible (key, value) search goes like so:
+
+.. code:: c
+
+      clib_bihash_kv_8_8_t search_kv, return_kv;
+      clib_bihash_8_8_t * h;
+      my_main_t *mm = &my_main;
+      clib_bihash_8_8_t *h;
+
+      h = &mm->hash_table;
+      search_kv.key = key_to_add_or_delete;
+
+      if (clib_bihash_search_8_8 (h, &search_kv, &return_kv) < 0)
+        key_not_found();
+      else
+        key_found();
+
+Note that it’s perfectly fine to collect the lookup result
+
+.. code:: c
+
+      if (clib_bihash_search_8_8 (h, &search_kv, &search_kv))
+        key_not_found();
+      etc.
+
+Bihash vector processing
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+When processing a vector of packets which need a certain lookup
+performed, it’s worth the trouble to compute the key hash, and prefetch
+the correct bucket ahead of time.
+
+Here’s a sketch of one way to write the required code:
+
+Dual-loop: \* 6 packets ahead, prefetch 2x vlib_buffer_t’s and 2x packet
+data required to form the record keys \* 4 packets ahead, form 2x record
+keys and call BV(clib_bihash_hash) or the explicit hash function to
+calculate the record hashes. Call 2x BV(clib_bihash_prefetch_bucket) to
+prefetch the buckets \* 2 packets ahead, call 2x
+BV(clib_bihash_prefetch_data) to prefetch 2x (key,value) data pages. \*
+In the processing section, call 2x
+BV(clib_bihash_search_inline_with_hash) to perform the search
+
+Programmer’s choice whether to stash the hash code somewhere in
+vnet_buffer(b) metadata, or to use local variables.
+
+Single-loop: \* Use simple search as shown above.
+
+Walking a bihash table
+~~~~~~~~~~~~~~~~~~~~~~
+
+A fairly common scenario to build “show” commands involves walking a
+bihash table. It’s simple enough:
+
+.. code:: c
+
+      my_main_t *mm = &my_main;
+      clib_bihash_8_8_t *h;
+      void callback_fn (clib_bihash_kv_8_8_t *, void *);
+
+      h = &mm->hash_table;
+
+      BV(clib_bihash_foreach_key_value_pair) (h, callback_fn, (void *) arg);
+
+To nobody’s great surprise: clib_bihash_foreach_key_value_pair iterates
+across the entire table, calling callback_fn with active entries.
+
+Bihash table iteration safety
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The iterator template “clib_bihash_foreach_key_value_pair” must be used
+with a certain amount of care. For one thing, the iterator template does
+*not* take the bihash hash table writer lock. If your use-case requires
+it, lock the table.
+
+For another, the iterator template is not safe under all conditions:
+
+-  It’s **OK to delete** bihash table entries during a table-walk. The
+   iterator checks whether the current bucket has been freed after each
+   *callback_fn(…)* invocation.
+
+-  It is **not OK to add** entries during a table-walk.
+
+The add-during-walk case involves a jackpot: while processing a
+key-value-pair in a particular bucket, add a certain number of entries.
+By luck, assume that one or more of the added entries causes the
+**current bucket** to split-and-rehash.
+
+Since we rehash KVP’s to different pages based on what amounts to a
+different hash function, either of these things can go wrong:
+
+-  We may revisit previously-visited entries. Depending on how one coded
+   the use-case, we could end up in a recursive-add situation.
+
+-  We may skip entries that have not been visited
+
+One could build an add-safe iterator, at a significant cost in
+performance: copy the entire bucket, and walk the copy.
+
+It’s hard to imagine a worthwhile add-during walk use-case in the first
+place; let alone one which couldn’t be implemented by walking the table
+without modifying it, then adding a set of records.
+
+Creating a new template instance
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Creating a new template is easy. Use one of the existing templates as a
+model, and make the obvious changes. The hash and key_compare methods
+are performance-critical in multiple senses.
+
+If the key compare method is slow, every lookup will be slow. If the
+hash function is slow, same story. If the hash function has poor
+statistical properties, space efficiency will suffer. In the limit, a
+bad enough hash function will cause large portions of the table to
+revert to linear search.
+
+Use of the best available vector unit is well worth the trouble in the
+hash and key_compare functions.
diff --git a/docs/developer/corearchitecture/buffer_metadata.rst b/docs/developer/corearchitecture/buffer_metadata.rst
new file mode 100644
index 00000000000..545c31f3041
--- /dev/null
+++ b/docs/developer/corearchitecture/buffer_metadata.rst
@@ -0,0 +1,237 @@
+Buffer Metadata
+===============
+
+Each vlib_buffer_t (packet buffer) carries buffer metadata which
+describes the current packet-processing state. The underlying techniques
+have been used for decades, across multiple packet processing
+environments.
+
+We will examine vpp buffer metadata in some detail, but folks who need
+to manipulate and/or extend the scheme should expect to do a certain
+level of code inspection.
+
+Vlib (Vector library) primary buffer metadata
+---------------------------------------------
+
+The first 64 octets of each vlib_buffer_t carries the primary buffer
+metadata. See …/src/vlib/buffer.h for full details.
+
+Important fields:
+
+-  i16 current_data: the signed offset in data[], pre_data[] that we are
+   currently processing. If negative current header points into the
+   pre-data (rewrite space) area.
+-  u16 current_length: nBytes between current_data and the end of this
+   buffer.
+-  u32 flags: Buffer flag bits. Heavily used, not many bits left
+
+   -  src/vlib/buffer.h flag bits
+
+      -  VLIB_BUFFER_IS_TRACED: buffer is traced
+      -  VLIB_BUFFER_NEXT_PRESENT: buffer has multiple chunks
+      -  VLIB_BUFFER_TOTAL_LENGTH_VALID:
+         total_length_not_including_first_buffer is valid (see below)
+
+   -  src/vnet/buffer.h flag bits
+
+      -  VNET_BUFFER_F_L4_CHECKSUM_COMPUTED: tcp/udp checksum has been
+         computed
+      -  VNET_BUFFER_F_L4_CHECKSUM_CORRECT: tcp/udp checksum is correct
+      -  VNET_BUFFER_F_VLAN_2_DEEP: two vlan tags present
+      -  VNET_BUFFER_F_VLAN_1_DEEP: one vlan tag present
+      -  VNET_BUFFER_F_SPAN_CLONE: packet has already been cloned (span
+         feature)
+      -  VNET_BUFFER_F_LOOP_COUNTER_VALID: packet look-up loop count
+         valid
+      -  VNET_BUFFER_F_LOCALLY_ORIGINATED: packet built by vpp
+      -  VNET_BUFFER_F_IS_IP4: packet is ipv4, for checksum offload
+      -  VNET_BUFFER_F_IS_IP6: packet is ipv6, for checksum offload
+      -  VNET_BUFFER_F_OFFLOAD_IP_CKSUM: hardware ip checksum offload
+         requested
+      -  VNET_BUFFER_F_OFFLOAD_TCP_CKSUM: hardware tcp checksum offload
+         requested
+      -  VNET_BUFFER_F_OFFLOAD_UDP_CKSUM: hardware udp checksum offload
+         requested
+      -  VNET_BUFFER_F_IS_NATED: natted packet, skip input checks
+      -  VNET_BUFFER_F_L2_HDR_OFFSET_VALID: L2 header offset valid
+      -  VNET_BUFFER_F_L3_HDR_OFFSET_VALID: L3 header offset valid
+      -  VNET_BUFFER_F_L4_HDR_OFFSET_VALID: L4 header offset valid
+      -  VNET_BUFFER_F_FLOW_REPORT: packet is an ipfix packet
+      -  VNET_BUFFER_F_IS_DVR: packet to be reinjected into the l2
+         output path
+      -  VNET_BUFFER_F_QOS_DATA_VALID: QoS data valid in
+         vnet_buffer_opaque2
+      -  VNET_BUFFER_F_GSO: generic segmentation offload requested
+      -  VNET_BUFFER_F_AVAIL1: available bit
+      -  VNET_BUFFER_F_AVAIL2: available bit
+      -  VNET_BUFFER_F_AVAIL3: available bit
+      -  VNET_BUFFER_F_AVAIL4: available bit
+      -  VNET_BUFFER_F_AVAIL5: available bit
+      -  VNET_BUFFER_F_AVAIL6: available bit
+      -  VNET_BUFFER_F_AVAIL7: available bit
+
+-  u32 flow_id: generic flow identifier
+-  u8 ref_count: buffer reference / clone count (e.g. for span
+   replication)
+-  u8 buffer_pool_index: buffer pool index which owns this buffer
+-  vlib_error_t (u16) error: error code for buffers enqueued to error
+   handler
+-  u32 next_buffer: buffer index of next buffer in chain. Only valid if
+   VLIB_BUFFER_NEXT_PRESENT is set
+-  union
+
+   -  u32 current_config_index: current index on feature arc
+   -  u32 punt_reason: reason code once packet punted. Mutually
+      exclusive with current_config_index
+
+-  u32 opaque[10]: primary vnet-layer opaque data (see below)
+-  END of first cache line / data initialized by the buffer allocator
+-  u32 trace_index: buffer’s index in the packet trace subsystem
+-  u32 total_length_not_including_first_buffer: see
+   VLIB_BUFFER_TOTAL_LENGTH_VALID above
+-  u32 opaque2[14]: secondary vnet-layer opaque data (see below)
+-  u8 pre_data[VLIB_BUFFER_PRE_DATA_SIZE]: rewrite space, often used to
+   prepend tunnel encapsulations
+-  u8 data[0]: buffer data received from the wire. Ordinarily, hardware
+   devices use b->data[0] as the DMA target but there are exceptions. Do
+   not write code which blindly assumes that packet data starts in
+   b->data[0]. Use vlib_buffer_get_current(…).
+
+Vnet (network stack) primary buffer metadata
+--------------------------------------------
+
+Vnet primary buffer metadata occupies space reserved in the vlib opaque
+field shown above, and has the type name vnet_buffer_opaque_t.
+Ordinarily accessed using the vnet_buffer(b) macro. See
+../src/vnet/buffer.h for full details.
+
+Important fields:
+
+-  u32 sw_if_index[2]: RX and TX interface handles. At the ip lookup
+   stage, vnet_buffer(b)->sw_if_index[VLIB_TX] is interpreted as a FIB
+   index.
+-  i16 l2_hdr_offset: offset from b->data[0] of the packet L2 header.
+   Valid only if b->flags & VNET_BUFFER_F_L2_HDR_OFFSET_VALID is set
+-  i16 l3_hdr_offset: offset from b->data[0] of the packet L3 header.
+   Valid only if b->flags & VNET_BUFFER_F_L3_HDR_OFFSET_VALID is set
+-  i16 l4_hdr_offset: offset from b->data[0] of the packet L4 header.
+   Valid only if b->flags & VNET_BUFFER_F_L4_HDR_OFFSET_VALID is set
+-  u8 feature_arc_index: feature arc that the packet is currently
+   traversing
+-  union
+
+   -  ip
+
+      -  u32 adj_index[2]: adjacency from dest IP lookup in [VLIB_TX],
+         adjacency from source ip lookup in [VLIB_RX], set to ~0 until
+         source lookup done
+      -  union
+
+         -  generic fields
+         -  ICMP fields
+         -  reassembly fields
+
+   -  mpls fields
+   -  l2 bridging fields, only valid in the L2 path
+   -  l2tpv3 fields
+   -  l2 classify fields
+   -  vnet policer fields
+   -  MAP fields
+   -  MAP-T fields
+   -  ip fragmentation fields
+   -  COP (whitelist/blacklist filter) fields
+   -  LISP fields
+   -  TCP fields
+
+      -  connection index
+      -  sequence numbers
+      -  header and data offsets
+      -  data length
+      -  flags
+
+   -  SCTP fields
+   -  NAT fields
+   -  u32 unused[6]
+
+Vnet (network stack) secondary buffer metadata
+----------------------------------------------
+
+Vnet primary buffer metadata occupies space reserved in the vlib opaque2
+field shown above, and has the type name vnet_buffer_opaque2_t.
+Ordinarily accessed using the vnet_buffer2(b) macro. See
+../src/vnet/buffer.h for full details.
+
+Important fields:
+
+-  qos fields
+
+   -  u8 bits
+   -  u8 source
+
+-  u8 loop_counter: used to detect and report internal forwarding loops
+-  group-based policy fields
+
+   -  u8 flags
+   -  u16 sclass: the packet’s source class
+
+-  u16 gso_size: L4 payload size, persists all the way to
+   interface-output in case GSO is not enabled
+-  u16 gso_l4_hdr_sz: size of the L4 protocol header
+-  union
+
+   -  packet trajectory tracer (largely deprecated)
+
+      -  u16 \*trajectory_trace; only #if VLIB_BUFFER_TRACE_TRAJECTORY >
+         0
+
+   -  packet generator
+
+      -  u64 pg_replay_timestamp: timestamp for replayed pcap trace
+         packets
+
+   -  u32 unused[8]
+
+Buffer Metadata Extensions
+--------------------------
+
+Plugin developers may wish to extend either the primary or secondary
+vnet buffer opaque unions. Please perform a manual live variable
+analysis, otherwise nodes which use shared buffer metadata space may
+break things.
+
+It’s not OK to add plugin or proprietary metadata to the core vpp engine
+header files named above. Instead, proceed as follows. The example
+concerns the vnet primary buffer opaque union vlib_buffer_opaque_t. It’s
+a very simple variation to use the vnet secondary buffer opaque union
+vlib_buffer_opaque2_t.
+
+In a plugin header file:
+
+::
+
+       /* Add arbitrary buffer metadata */
+       #include 
+
+       typedef struct
+       {
+         u32 my_stuff[6];
+       } my_buffer_opaque_t;
+
+       STATIC_ASSERT (sizeof (my_buffer_opaque_t) <=
+                      STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
+                      "Custom meta-data too large for vnet_buffer_opaque_t");
+
+       #define my_buffer_opaque(b)  \
+         ((my_buffer_opaque_t *)((u8 *)((b)->opaque) + STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))
+
+To set data in the custom buffer opaque type given a vlib_buffer_t \*b:
+
+::
+
+       my_buffer_opaque (b)->my_stuff[2] = 123;
+
+To read data from the custom buffer opaque type:
+
+::
+
+       stuff0 = my_buffer_opaque (b)->my_stuff[2];
diff --git a/docs/developer/corearchitecture/buildsystem/buildrootmakefile.rst b/docs/developer/corearchitecture/buildsystem/buildrootmakefile.rst
new file mode 100644
index 00000000000..1eb4e6b5301
--- /dev/null
+++ b/docs/developer/corearchitecture/buildsystem/buildrootmakefile.rst
@@ -0,0 +1,353 @@
+Introduction to build-root/Makefile
+===================================
+
+The vpp build system consists of a top-level Makefile, a data-driven
+build-root/Makefile, and a set of makefile fragments. The various parts
+come together as the result of a set of well-thought-out conventions.
+
+This section describes build-root/Makefile in some detail.
+
+Repository Groups and Source Paths
+----------------------------------
+
+Current vpp workspaces comprise a single repository group. The file
+.../build-root/build-config.mk defines a key variable called
+SOURCE\_PATH. The SOURCE\_PATH variable names the set of repository
+groups. At the moment, there is only one repository group.
+
+Single pass build system, dependencies and components
+-----------------------------------------------------
+
+The vpp build system caters to components built with GNU autoconf /
+automake. Adding such components is a simple process. Dealing with
+components which use BSD-style raw Makefiles is a more difficult.
+Dealing with toolchain components such as gcc, glibc, and binutils can
+be considerably more complicated.
+
+The vpp build system is a **single-pass** build system. A partial order
+must exist for any set of components: the set of (a before b) tuples
+must resolve to an ordered list. If you create a circular dependency of
+the form; (a,b) (b,c) (c,a), gmake will try to build the target list,
+but there’s a 0.0% chance that the results will be pleasant. Cut-n-paste
+mistakes in .../build-data/packages/.mk can produce confusing failures.
+
+In a single-pass build system, it’s best to separate libraries and
+applications which instantiate them. For example, if vpp depends on
+libfoo.a, and myapp depends on both vpp and libfoo.a, it's best to place
+libfoo.a and myapp in separate components. The build system will build
+libfoo.a, vpp, and then (as a separate component) myapp. If you try to
+build libfoo.a and myapp from the same component, it won’t work.
+
+If you absolutely, positively insist on having myapp and libfoo.a in the
+same source tree, you can create a pseudo-component in a separate .mk
+file in the .../build-data/packages/ directory. Define the code
+phoneycomponent\_source = realcomponent, and provide manual
+configure/build/install targets.
+
+Separate components for myapp, libfoo.a, and vpp is the best and easiest
+solution. However, the “mumble\_source = realsource” degree of freedom
+exists to solve intractable circular dependencies, such as: to build
+gcc-bootstrap, followed by glibc, followed by “real” gcc/g++ [which
+depends on glibc too].
+
+.../build-root
+--------------
+
+The .../build-root directory contains the repository group specification
+build-config.mk, the main Makefile, and the system-wide set of
+autoconf/automake variable overrides in config.site. We'll describe
+these files in some detail. To be clear about expectations: the main
+Makefile and config.site file are subtle and complex. It's unlikely that
+you'll need or want to modify them. Poorly planned changes in either
+place typically cause bugs that are difficult to solve.
+
+.../build-root/build-config.mk
+------------------------------
+
+As described above, the build-config.mk file is straightforward: it sets
+the make variable SOURCE\_PATH to a list of repository group absolute
+paths.
+
+The SOURCE\_PATH variable If you choose to move a workspace, make sure
+to modify the paths defined by the SOURCE\_PATH variable. Those paths
+need to match changes you make in the workspace paths. For example, if
+you place the vpp directory in the workspace of a user named jsmith, you
+might change the SOURCE\_PATH to:
+
+SOURCE\_PATH = /home/jsmithuser/workspace/vpp
+
+The "out of the box" setting should work 99.5% of the time:
+
+::
+
+        SOURCE_PATH = $(CURDIR)/..
+
+.../vpp/build-root/Makefile
+---------------------------
+
+The main Makefile is complex in a number of dimensions. If you think you
+need to modify it, it's a good idea to do some research, or ask for
+advice before you change it.
+
+The main Makefile was organized and designed to provide the following
+characteristics: excellent performance, accurate dependency processing,
+cache enablement, timestamp optimizations, git integration,
+extensibility, builds with cross-compilation tool chains, and builds
+with embedded Linux distributions.
+
+If you really need to do so, you can build double-cross tools with it,
+with a minimum amount of fuss. For example, you could: compile gdb on
+x86\_64, to run on PowerPC, to debug the Xtensa instruction set.
+
+The PLATFORM variable
+---------------------
+
+The PLATFORM make/environment variable controls a number of important
+characteristics, primarily:
+
+-  CPU architecture
+-  The list of images to build.
+
+With respect to .../build-root/Makefile, the list of images to build is
+specified by the target. For example:
+
+::
+
+       make PLATFORM=vpp TAG=vpp_debug install-deb
+
+builds vpp debug Debian packages.
+
+The main Makefile interprets $PLATFORM by attempting to "-include" the
+file /build-data/platforms.mk:
+
+::
+
+        $(foreach d,$(FULL_SOURCE_PATH), \
+          $(eval -include $(d)/platforms.mk))
+
+By convention, we don't define **platforms** in the
+...//build-data/platforms.mk file.
+
+In the vpp case, we search for platform definition makefile fragments in
+.../vpp/build-data/platforms.mk, as follows:
+
+::
+
+        $(foreach d,$(SOURCE_PATH_BUILD_DATA_DIRS), \
+             $(eval -include $(d)/platforms/*.mk))
+
+With vpp, which uses the "vpp" platform as discussed above, we end up
+"-include"-ing .../vpp/build-data/platforms/vpp.mk.
+
+The platform-specific .mk fragment
+----------------------------------
+
+Here are the contents of .../build-data/platforms/vpp.mk:
+
+::
+
+        MACHINE=$(shell uname -m)
+
+        vpp_arch = native
+        ifeq ($(TARGET_PLATFORM),thunderx)
+        vpp_dpdk_target = arm64-thunderx-linuxapp-gcc
+        endif
+        vpp_native_tools = vppapigen
+
+        vpp_uses_dpdk = yes
+
+        # Uncomment to enable building unit tests
+        # vpp_enable_tests = yes
+
+        vpp_root_packages = vpp
+
+        # DPDK configuration parameters
+        # vpp_uses_dpdk_mlx4_pmd = yes
+        # vpp_uses_dpdk_mlx5_pmd = yes
+        # vpp_uses_external_dpdk = yes
+        # vpp_dpdk_inc_dir = /usr/include/dpdk
+        # vpp_dpdk_lib_dir = /usr/lib
+        # vpp_dpdk_shared_lib = yes
+
+        # Use '--without-libnuma' for non-numa aware architecture
+        # Use '--enable-dlmalloc' to use dlmalloc instead of mheap
+        vpp_configure_args_vpp = --enable-dlmalloc
+        sample-plugin_configure_args_vpp = --enable-dlmalloc
+
+        # load balancer plugin is not portable on 32 bit platform
+        ifeq ($(MACHINE),i686)
+        vpp_configure_args_vpp += --disable-lb-plugin
+        endif
+
+        vpp_debug_TAG_CFLAGS = -g -O0 -DCLIB_DEBUG \
+            -fstack-protector-all -fPIC -Werror
+        vpp_debug_TAG_CXXFLAGS = -g -O0 -DCLIB_DEBUG \
+            -fstack-protector-all -fPIC -Werror
+        vpp_debug_TAG_LDFLAGS = -g -O0 -DCLIB_DEBUG \
+            -fstack-protector-all -fPIC -Werror
+
+        vpp_TAG_CFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
+        vpp_TAG_CXXFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
+        vpp_TAG_LDFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror -pie -Wl,-z,now
+
+        vpp_clang_TAG_CFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
+        vpp_clang_TAG_LDFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
+
+        vpp_gcov_TAG_CFLAGS = -g -O0 -DCLIB_DEBUG -fPIC -Werror -fprofile-arcs -ftest-coverage
+        vpp_gcov_TAG_LDFLAGS = -g -O0 -DCLIB_DEBUG -fPIC -Werror -coverage
+
+        vpp_coverity_TAG_CFLAGS = -g -O2 -fPIC -Werror -D__COVERITY__
+        vpp_coverity_TAG_LDFLAGS = -g -O2 -fPIC -Werror -D__COVERITY__
+
+Note the following variable settings:
+
+-  The variable \_arch sets the CPU architecture used to build the
+   per-platform cross-compilation toolchain. With the exception of the
+   "native" architecture - used in our example - the vpp build system
+   produces cross-compiled binaries.
+
+-  The variable \_native\_tools lists the required set of self-compiled
+   build tools.
+
+-  The variable \_root\_packages lists the set of images to build when
+   specifying the target: make PLATFORM= TAG= [install-deb \|
+   install-rpm].
+
+The TAG variable
+----------------
+
+The TAG variable indirectly sets CFLAGS and LDFLAGS, as well as the
+build and install directory names in the .../vpp/build-root directory.
+See definitions above.
+
+Important targets build-root/Makefile
+-------------------------------------
+
+The main Makefile and the various makefile fragments implement the
+following user-visible targets:
+
++------------------+----------------------+--------------------------------------------------------------------------------------+
+| Target           | ENV Variable Settings| Notes                                                                                |
+|                  |                      |                                                                                      |
++==================+======================+======================================================================================+
+| foo              |      bar             | mumble                                                                               |
++------------------+----------------------+--------------------------------------------------------------------------------------+
+| bootstrap-tools  | none                 |  Builds the set of native tools needed by the vpp build system to                    |
+|                  |                      |  build images. Example: vppapigen. In a full cross compilation case might include    |
+|                  |                      |  include "make", "git", "find", and "tar                                             |
++------------------+----------------------+--------------------------------------------------------------------------------------+
+| install-tools    | PLATFORM             | Builds the tool chain for the indicated . Not used in vpp builds           |
++------------------+----------------------+--------------------------------------------------------------------------------------+
+| distclean        | none                 | Roto-rooters everything in sight: toolchains, images, and so forth.                  |
++------------------+----------------------+--------------------------------------------------------------------------------------+
+| install-deb      | PLATFORM and TAG     | Build Debian packages comprising components listed in _root_packages,      |
+|                  |                      | using compile / link options defined by TAG.                                         |
++------------------+----------------------+--------------------------------------------------------------------------------------+
+| install-rpm      | PLATFORM and TAG     | Build RPMs comprising components listed in _root_packages,                 |
+|                  |                      | using compile / link options defined by TAG.                                         |
++------------------+----------------------+--------------------------------------------------------------------------------------+
+
+Additional build-root/Makefile environment variable settings
+------------------------------------------------------------
+
+These variable settings may be of use:
+
++----------------------+------------------------------------------------------------------------------------------------------------+
+| ENV Variable         | Notes                                                                                                      |
++======================+======================+=====================================================================================+
+| BUILD_DEBUG=vx       | Directs Makefile et al. to make a good-faith effort to show what's going on in excruciating detail.        |
+|                      | Use it as follows: "make ... BUILD_DEBUG=vx". Fairly effective in Makefile debug situations.               |
++----------------------+------------------------------------------------------------------------------------------------------------+
+| V=1                  | print detailed cc / ld command lines. Useful for discovering if -DFOO=11 is in the command line or not     |
++----------------------+------------------------------------------------------------------------------------------------------------+
+| CC=mygcc             | Override the configured C-compiler                                                                         |
++----------------------+------------------------------------------------------------------------------------------------------------+
+
+.../build-root/config.site
+--------------------------
+
+The contents of .../build-root/config.site override individual autoconf /
+automake default variable settings. Here are a few sample settings related to
+building a full toolchain:
+
+::
+
+    # glibc needs these setting for cross compiling
+    libc_cv_forced_unwind=yes
+    libc_cv_c_cleanup=yes
+    libc_cv_ssp=no
+
+Determining the set of variables which need to be overridden, and the
+override values is a matter of trial and error. It should be
+unnecessary to modify this file for use with fd.io vpp.
+
+.../build-data/platforms.mk
+---------------------------
+
+Each repo group includes the platforms.mk file, which is included by
+the main Makefile. The vpp/build-data/platforms.mk file is not terribly
+complex. As of this writing, .../build-data/platforms.mk file accomplishes two
+tasks.
+
+First, it includes vpp/build-data/platforms/\*.mk:
+
+::
+
+    # Pick up per-platform makefile fragments
+    $(foreach d,$(SOURCE_PATH_BUILD_DATA_DIRS),	\
+      $(eval -include $(d)/platforms/*.mk))
+
+This collects the set of platform definition makefile fragments, as discussed above.
+
+Second, platforms.mk implements the user-visible "install-deb" target.
+
+.../build-data/packages/\*.mk
+-----------------------------
+
+Each component needs a makefile fragment in order for the build system
+to recognize it. The per-component makefile fragments vary
+considerably in complexity. For a component built with GNU autoconf /
+automake which does not depend on other components, the make fragment
+can be empty. See .../build-data/packages/vpp.mk for an uncomplicated
+but fully realistic example.
+
+Here are some of the important variable settings in per-component makefile fragments:
+
++----------------------+------------------------------------------------------------------------------------------------------------+
+| Variable             | Notes                                                                                                      |
++======================+======================+=====================================================================================+
+| xxx_configure_depend |  Lists the set of component build dependencies for the xxx component. In plain English: don't try to       |
+|                      |  configure this component until you've successfully built the indicated targets. Almost always,            |
+|                      |  xxx_configure_depend will list a set of "yyy-install" targets. Note the pattern:                          |
+|                      |  "variable names contain underscores, make target names contain hyphens"                                   |
++----------------------+------------------------------------------------------------------------------------------------------------+
+| xxx_configure_args   | (optional) Lists any additional arguments to pass to the xxx component "configure" script.                 |
+|                      | The main Makefile %-configure rule adds the required settings for --libdir, --prefix, and                  |
+|                      | --host (when cross-compiling)                                                                              |
++----------------------+------------------------------------------------------------------------------------------------------------+
+| xxx_CPPFLAGS         | Adds -I stanzas to CPPFLAGS for components upon which xxx depends.                                         |
+|                      | Almost invariably "xxx_CPPFLAGS = $(call installed_includes_fn, dep1 dep2 dep3)", where dep1, dep2, and    |
+|                      | dep3 are listed in xxx_configure_depend. It is bad practice to set "-g -O3" here. Those settings           |
+|                      | belong in a TAG.                                                                                           |
++----------------------+------------------------------------------------------------------------------------------------------------+
+| xxx_LDFLAGS          | Adds -Wl,-rpath -Wl,depN stanzas to LDFLAGS for components upon which xxx depends.                         |
+|                      | Almost invariably "xxx_LDFLAGS = $(call installed_lib_fn, dep1 dep2 dep3)", where dep1, dep2, and          |
+|                      | dep3 are listed in xxx_configure_depend. It is bad manners to set "-liberty-or-death" here.                |
+|                      | Those settings belong in Makefile.am.                                                                      |
++----------------------+------------------------------------------------------------------------------------------------------------+
+
+When dealing with "irritating" components built with raw Makefiles
+which only work when building in the source tree, we use a specific
+strategy in the xxx.mk file.
+
+The strategy is simple for those components: We copy the source tree
+into .../vpp/build-root/build-xxx. This works, but completely defeats
+dependency processing. This strategy is acceptable only for 3rd party
+software which won't need extensive (or preferably any) modifications.
+
+Take a look at .../vpp/build-data/packages/dpdk.mk. When invoked, the
+dpdk_configure variable copies source code into $(PACKAGE_BUILD_DIR),
+and performs the BSD equivalent of "autoreconf -i -f" to configure the
+build area. The rest of the file is similar: a bunch of hand-rolled
+glue code which manages to make the dpdk act like a good vpp build
+citizen even though it is not.
diff --git a/docs/developer/corearchitecture/buildsystem/cmakeandninja.rst b/docs/developer/corearchitecture/buildsystem/cmakeandninja.rst
new file mode 100644
index 00000000000..580d261bdac
--- /dev/null
+++ b/docs/developer/corearchitecture/buildsystem/cmakeandninja.rst
@@ -0,0 +1,186 @@
+Introduction to cmake and ninja
+===============================
+
+Cmake plus ninja is approximately equal to GNU autotools plus GNU
+make, respectively. Both cmake and GNU autotools support self and
+cross-compilation, checking for required components and versions.
+
+- For a decent-sized project - such as vpp - build performance is drastically better with (cmake, ninja).
+
+- The cmake input language looks like an actual language, rather than a shell scripting scheme on steroids.
+
+- Ninja doesn't pretend to support manually-generated input files. Think of it as a fast, dumb robot which eats mildly legible byte-code.
+
+See the `cmake website `_, and the `ninja website
+`_ for additional information.
+
+vpp cmake configuration files
+-----------------------------
+
+The top of the vpp project cmake hierarchy lives in .../src/CMakeLists.txt.
+This file defines the vpp project, and (recursively) includes two kinds
+of files: rule/function definitions, and target lists.
+
+- Rule/function definitions live in .../src/cmake/{\*.cmake}. Although the contents of these files is simple enough to read, it shouldn't be necessary to modify them very often
+
+- Build target lists come from CMakeLists.txt files found in subdirectories, which are named in the SUBDIRS list in .../src/CMakeLists.txt
+
+::
+
+    ##############################################################################
+    # subdirs - order matters
+    ##############################################################################
+    if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
+      find_package(OpenSSL REQUIRED)
+      set(SUBDIRS
+        vppinfra svm vlib vlibmemory vlibapi vnet vpp vat vcl plugins
+        vpp-api tools/vppapigen tools/g2 tools/perftool)
+    elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
+      set(SUBDIRS vppinfra)
+    else()
+      message(FATAL_ERROR "Unsupported system: ${CMAKE_SYSTEM_NAME}")
+    endif()
+
+    foreach(DIR ${SUBDIRS})
+      add_subdirectory(${DIR})
+    endforeach()
+
+- The vpp cmake configuration hierarchy discovers the list of plugins to be built by searching for subdirectories in .../src/plugins which contain CMakeLists.txt files
+
+
+::
+
+    ##############################################################################
+    # find and add all plugin subdirs
+    ##############################################################################
+    FILE(GLOB files RELATIVE
+      ${CMAKE_CURRENT_SOURCE_DIR}
+      ${CMAKE_CURRENT_SOURCE_DIR}/*/CMakeLists.txt
+    )
+    foreach (f ${files})
+      get_filename_component(dir ${f} DIRECTORY)
+      add_subdirectory(${dir})
+    endforeach()
+
+How to write a plugin CMakeLists.txt file
+-----------------------------------------
+
+It's really quite simple. Follow the pattern:
+
+::
+
+    add_vpp_plugin(mactime
+      SOURCES
+      mactime.c
+      node.c
+
+      API_FILES
+      mactime.api
+
+      INSTALL_HEADERS
+      mactime_all_api_h.h
+      mactime_msg_enum.h
+
+      API_TEST_SOURCES
+      mactime_test.c
+    )
+
+Adding a target elsewhere in the source tree
+--------------------------------------------
+
+Within reason, adding a subdirectory to the SUBDIRS list in
+.../src/CMakeLists.txt is perfectly OK. The indicated directory will
+need a CMakeLists.txt file.
+
+.. _building-g2:
+
+Here's how we build the g2 event data visualization tool:
+
+::
+
+    option(VPP_BUILD_G2 "Build g2 tool." OFF)
+    if(VPP_BUILD_G2)
+      find_package(GTK2 COMPONENTS gtk)
+      if(GTK2_FOUND)
+        include_directories(${GTK2_INCLUDE_DIRS})
+        add_vpp_executable(g2
+          SOURCES
+          clib.c
+          cpel.c
+          events.c
+          main.c
+          menu1.c
+          pointsel.c
+          props.c
+          g2version.c
+          view1.c
+
+          LINK_LIBRARIES vppinfra Threads::Threads m ${GTK2_LIBRARIES}
+          NO_INSTALL
+        )
+      endif()
+    endif()
+
+The g2 component is optional, and is not built by default. There are
+a couple of ways to tell cmake to include it in build.ninja [or in Makefile.]
+
+When invoking cmake manually [rarely done and not very easy], specify
+-DVPP_BUILD_G2=ON:
+
+::
+
+   $ cmake ... -DVPP_BUILD_G2=ON
+
+Take a good look at .../build-data/packages/vpp.mk to see where and
+how the top-level Makefile and .../build-root/Makefile set all of the
+cmake arguments. One strategy to enable an optional component is fairly
+obvious. Add -DVPP_BUILD_G2=ON to vpp_cmake_args.
+
+That would work, of course, but it's not a particularly elegant solution.
+
+Tinkering with build options: ccmake
+------------------------------------
+
+The easy way to set VPP_BUILD_G2 - or frankly **any** cmake
+parameter - is to install the "cmake-curses-gui" package and use
+it.
+
+- Do a straightforward vpp build using the top level Makefile, "make build" or "make build-release"
+- Ajourn to .../build-root/build-vpp-native/vpp or .../build-root/build-vpp_debug-native/vpp
+- Invoke "ccmake ." to reconfigure the project as desired
+
+Here's approximately what you'll see:
+
+::
+
+     CCACHE_FOUND                     /usr/bin/ccache
+     CMAKE_BUILD_TYPE
+     CMAKE_INSTALL_PREFIX             /scratch/vpp-gate/build-root/install-vpp-nati
+     DPDK_INCLUDE_DIR                 /scratch/vpp-gate/build-root/install-vpp-nati
+     DPDK_LIB                         /scratch/vpp-gate/build-root/install-vpp-nati
+     MBEDTLS_INCLUDE_DIR              /usr/include
+     MBEDTLS_LIB1                     /usr/lib/x86_64-linux-gnu/libmbedtls.so
+     MBEDTLS_LIB2                     /usr/lib/x86_64-linux-gnu/libmbedx509.so
+     MBEDTLS_LIB3                     /usr/lib/x86_64-linux-gnu/libmbedcrypto.so
+     MUSDK_INCLUDE_DIR                MUSDK_INCLUDE_DIR-NOTFOUND
+     MUSDK_LIB                        MUSDK_LIB-NOTFOUND
+     PRE_DATA_SIZE                    128
+     VPP_API_TEST_BUILTIN             ON
+     VPP_BUILD_G2                     OFF
+     VPP_BUILD_PERFTOOL               OFF
+     VPP_BUILD_VCL_TESTS              ON
+     VPP_BUILD_VPPINFRA_TESTS         OFF
+
+    CCACHE_FOUND: Path to a program.
+    Press [enter] to edit option Press [d] to delete an entry   CMake Version 3.10.2
+    Press [c] to configure
+    Press [h] for help           Press [q] to quit without generating
+    Press [t] to toggle advanced mode (Currently Off)
+
+Use the cursor to point at the VPP_BUILD_G2 line. Press the return key
+to change OFF to ON. Press "c" to regenerate build.ninja, etc.
+
+At that point "make build" or "make build-release" will build g2. And so on.
+
+Note that toggling advanced mode ["t"] gives access to substantially
+all of the cmake option, discovered directories and paths.
diff --git a/docs/developer/corearchitecture/buildsystem/index.rst b/docs/developer/corearchitecture/buildsystem/index.rst
new file mode 100644
index 00000000000..908e91e1fc1
--- /dev/null
+++ b/docs/developer/corearchitecture/buildsystem/index.rst
@@ -0,0 +1,14 @@
+.. _buildsystem:
+
+Build System
+============
+
+This guide describes the vpp build system in detail. As of this writing,
+the build systems uses a mix of make / Makefiles, cmake, and ninja to
+achieve excellent build performance.
+
+.. toctree::
+
+    mainmakefile
+    cmakeandninja
+    buildrootmakefile
diff --git a/docs/developer/corearchitecture/buildsystem/mainmakefile.rst b/docs/developer/corearchitecture/buildsystem/mainmakefile.rst
new file mode 100644
index 00000000000..96b97496350
--- /dev/null
+++ b/docs/developer/corearchitecture/buildsystem/mainmakefile.rst
@@ -0,0 +1,2 @@
+Introduction to the top-level Makefile
+======================================
diff --git a/docs/developer/corearchitecture/featurearcs.rst b/docs/developer/corearchitecture/featurearcs.rst
new file mode 100644
index 00000000000..89c50e38dce
--- /dev/null
+++ b/docs/developer/corearchitecture/featurearcs.rst
@@ -0,0 +1,225 @@
+Feature Arcs
+============
+
+A significant number of vpp features are configurable on a per-interface
+or per-system basis. Rather than ask feature coders to manually
+construct the required graph arcs, we built a general mechanism to
+manage these mechanics.
+
+Specifically, feature arcs comprise ordered sets of graph nodes. Each
+feature node in an arc is independently controlled. Feature arc nodes
+are generally unaware of each other. Handing a packet to “the next
+feature node” is quite inexpensive.
+
+The feature arc implementation solves the problem of creating graph arcs
+used for steering.
+
+At the beginning of a feature arc, a bit of setup work is needed, but
+only if at least one feature is enabled on the arc.
+
+On a per-arc basis, individual feature definitions create a set of
+ordering dependencies. Feature infrastructure performs a topological
+sort of the ordering dependencies, to determine the actual feature
+order. Missing dependencies **will** lead to runtime disorder. See
+https://gerrit.fd.io/r/#/c/12753 for an example.
+
+If no partial order exists, vpp will refuse to run. Circular dependency
+loops of the form “a then b, b then c, c then a” are impossible to
+satisfy.
+
+Adding a feature to an existing feature arc
+-------------------------------------------
+
+To nobody’s great surprise, we set up feature arcs using the typical
+“macro -> constructor function -> list of declarations” pattern:
+
+.. code:: c
+
+       VNET_FEATURE_INIT (mactime, static) =
+       {
+         .arc_name = "device-input",
+         .node_name = "mactime",
+         .runs_before = VNET_FEATURES ("ethernet-input"),
+       };
+
+This creates a “mactime” feature on the “device-input” arc.
+
+Once per frame, dig up the vnet_feature_config_main_t corresponding to
+the “device-input” feature arc:
+
+.. code:: c
+
+       vnet_main_t *vnm = vnet_get_main ();
+       vnet_interface_main_t *im = &vnm->interface_main;
+       u8 arc = im->output_feature_arc_index;
+       vnet_feature_config_main_t *fcm;
+
+       fcm = vnet_feature_get_config_main (arc);
+
+Note that in this case, we’ve stored the required arc index - assigned
+by the feature infrastructure - in the vnet_interface_main_t. Where to
+put the arc index is a programmer’s decision when creating a feature
+arc.
+
+Per packet, set next0 to steer packets to the next node they should
+visit:
+
+.. code:: c
+
+       vnet_get_config_data (&fcm->config_main,
+                             &b0->current_config_index /* value-result */,
+                             &next0, 0 /* # bytes of config data */);
+
+Configuration data is per-feature arc, and is often unused. Note that
+it’s normal to reset next0 to divert packets elsewhere; often, to drop
+them for cause:
+
+.. code:: c
+
+       next0 = MACTIME_NEXT_DROP;
+       b0->error = node->errors[DROP_CAUSE];
+
+Creating a feature arc
+----------------------
+
+Once again, we create feature arcs using constructor macros:
+
+.. code:: c
+
+       VNET_FEATURE_ARC_INIT (ip4_unicast, static) =
+       {
+         .arc_name = "ip4-unicast",
+         .start_nodes = VNET_FEATURES ("ip4-input", "ip4-input-no-checksum"),
+         .arc_index_ptr = &ip4_main.lookup_main.ucast_feature_arc_index,
+       };
+
+In this case, we configure two arc start nodes to handle the
+“hardware-verified ip checksum or not” cases. During initialization, the
+feature infrastructure stores the arc index as shown.
+
+In the head-of-arc node, do the following to send packets along the
+feature arc:
+
+.. code:: c
+
+       ip_lookup_main_t *lm = &im->lookup_main;
+       arc = lm->ucast_feature_arc_index;
+
+Once per packet, initialize packet metadata to walk the feature arc:
+
+.. code:: c
+
+   vnet_feature_arc_start (arc, sw_if_index0, &next, b0);
+
+Enabling / Disabling features
+-----------------------------
+
+Simply call vnet_feature_enable_disable to enable or disable a specific
+feature:
+
+.. code:: c
+
+       vnet_feature_enable_disable ("device-input", /* arc name */
+                                    "mactime",      /* feature name */
+                                sw_if_index,    /* Interface sw_if_index */
+                                    enable_disable, /* 1 => enable */
+                                    0 /* (void *) feature_configuration */,
+                                    0 /* feature_configuration_nbytes */);
+
+The feature_configuration opaque is seldom used.
+
+If you wish to make a feature a *de facto* system-level concept, pass
+sw_if_index=0 at all times. Sw_if_index 0 is always valid, and
+corresponds to the “local” interface.
+
+Related “show” commands
+-----------------------
+
+To display the entire set of features, use “show features [verbose]”.
+The verbose form displays arc indices, and feature indicies within the
+arcs
+
+::
+
+   $ vppctl show features verbose
+   Available feature paths
+   
+   [14] ip4-unicast:
+     [ 0]: nat64-out2in-handoff
+     [ 1]: nat64-out2in
+     [ 2]: nat44-ed-hairpin-dst
+     [ 3]: nat44-hairpin-dst
+     [ 4]: ip4-dhcp-client-detect
+     [ 5]: nat44-out2in-fast
+     [ 6]: nat44-in2out-fast
+     [ 7]: nat44-handoff-classify
+     [ 8]: nat44-out2in-worker-handoff
+     [ 9]: nat44-in2out-worker-handoff
+     [10]: nat44-ed-classify
+     [11]: nat44-ed-out2in
+     [12]: nat44-ed-in2out
+     [13]: nat44-det-classify
+     [14]: nat44-det-out2in
+     [15]: nat44-det-in2out
+     [16]: nat44-classify
+     [17]: nat44-out2in
+     [18]: nat44-in2out
+     [19]: ip4-qos-record
+     [20]: ip4-vxlan-gpe-bypass
+     [21]: ip4-reassembly-feature
+     [22]: ip4-not-enabled
+     [23]: ip4-source-and-port-range-check-rx
+     [24]: ip4-flow-classify
+     [25]: ip4-inacl
+     [26]: ip4-source-check-via-rx
+     [27]: ip4-source-check-via-any
+     [28]: ip4-policer-classify
+     [29]: ipsec-input-ip4
+     [30]: vpath-input-ip4
+     [31]: ip4-vxlan-bypass
+     [32]: ip4-lookup
+   
+
+Here, we learn that the ip4-unicast feature arc has index 14, and that
+e.g. ip4-inacl is the 25th feature in the generated partial order.
+
+To display the features currently active on a specific interface, use
+“show interface features”:
+
+::
+
+   $ vppctl show interface GigabitEthernet3/0/0 features
+   Feature paths configured on GigabitEthernet3/0/0...
+   
+   ip4-unicast:
+     nat44-out2in
+   
+
+Table of Feature Arcs
+---------------------
+
+Simply search for name-strings to track down the arc definition,
+location of the arc index, etc.
+
+::
+
+               |    Arc Name      |
+               |------------------|
+               | device-input     |
+               | ethernet-output  |
+               | interface-output |
+               | ip4-drop         |
+               | ip4-local        |
+               | ip4-multicast    |
+               | ip4-output       |
+               | ip4-punt         |
+               | ip4-unicast      |
+               | ip6-drop         |
+               | ip6-local        |
+               | ip6-multicast    |
+               | ip6-output       |
+               | ip6-punt         |
+               | ip6-unicast      |
+               | mpls-input       |
+               | mpls-output      |
+               | nsh-output       |
diff --git a/docs/developer/corearchitecture/index.rst b/docs/developer/corearchitecture/index.rst
new file mode 100644
index 00000000000..ecd5a3cdb08
--- /dev/null
+++ b/docs/developer/corearchitecture/index.rst
@@ -0,0 +1,21 @@
+.. _corearchitecture:
+
+=================
+Core Architecture
+=================
+
+.. toctree::
+    :maxdepth: 1
+
+    softwarearchitecture
+    infrastructure
+    vlib
+    vnet
+    featurearcs
+    buffer_metadata
+    multiarch/index
+    bihash
+    buildsystem/index
+    mem
+    multi_thread
+
diff --git a/docs/developer/corearchitecture/infrastructure.rst b/docs/developer/corearchitecture/infrastructure.rst
new file mode 100644
index 00000000000..b4e1065f81e
--- /dev/null
+++ b/docs/developer/corearchitecture/infrastructure.rst
@@ -0,0 +1,612 @@
+VPPINFRA (Infrastructure)
+=========================
+
+The files associated with the VPP Infrastructure layer are located in
+the ``./src/vppinfra`` folder.
+
+VPPinfra is a collection of basic c-library services, quite sufficient
+to build standalone programs to run directly on bare metal. It also
+provides high-performance dynamic arrays, hashes, bitmaps,
+high-precision real-time clock support, fine-grained event-logging, and
+data structure serialization.
+
+One fair comment / fair warning about vppinfra: you can't always tell a
+macro from an inline function from an ordinary function simply by name.
+Macros are used to avoid function calls in the typical case, and to
+cause (intentional) side-effects.
+
+Vppinfra has been around for almost 20 years and tends not to change
+frequently. The VPP Infrastructure layer contains the following
+functions:
+
+Vectors
+-------
+
+Vppinfra vectors are ubiquitous dynamically resized arrays with by user
+defined "headers". Many vpppinfra data structures (e.g. hash, heap,
+pool) are vectors with various different headers.
+
+The memory layout looks like this:
+
+::
+
+                      User header (optional, uword aligned)
+                      Alignment padding (if needed)
+                      Vector length in elements
+    User's pointer -> Vector element 0
+                      Vector element 1
+                      ...
+                      Vector element N-1
+
+As shown above, the vector APIs deal with pointers to the 0th element of
+a vector. Null pointers are valid vectors of length zero.
+
+To avoid thrashing the memory allocator, one often resets the length of
+a vector to zero while retaining the memory allocation. Set the vector
+length field to zero via the vec_reset_length(v) macro. [Use the macro!
+It’s smart about NULL pointers.]
+
+Typically, the user header is not present. User headers allow for other
+data structures to be built atop vppinfra vectors. Users may specify the
+alignment for first data element of a vector via the [vec]()*_aligned
+macros.
+
+Vector elements can be any C type e.g. (int, double, struct bar). This
+is also true for data types built atop vectors (e.g. heap, pool, etc.).
+Many macros have \_a variants supporting alignment of vector elements
+and \_h variants supporting non-zero-length vector headers. The \_ha
+variants support both. Additionally cacheline alignment within a vector
+element structure can be specified using the
+``[CLIB_CACHE_LINE_ALIGN_MARK]()`` macro.
+
+Inconsistent usage of header and/or alignment related macro variants
+will cause delayed, confusing failures.
+
+Standard programming error: memorize a pointer to the ith element of a
+vector, and then expand the vector. Vectors expand by 3/2, so such code
+may appear to work for a period of time. Correct code almost always
+memorizes vector **indices** which are invariant across reallocations.
+
+In typical application images, one supplies a set of global functions
+designed to be called from gdb. Here are a few examples:
+
+-  vl(v) - prints vec_len(v)
+-  pe(p) - prints pool_elts(p)
+-  pifi(p, index) - prints pool_is_free_index(p, index)
+-  debug_hex_bytes (p, nbytes) - hex memory dump nbytes starting at p
+
+Use the “show gdb” debug CLI command to print the current set.
+
+Bitmaps
+-------
+
+Vppinfra bitmaps are dynamic, built using the vppinfra vector APIs.
+Quite handy for a variety jobs.
+
+Pools
+-----
+
+Vppinfra pools combine vectors and bitmaps to rapidly allocate and free
+fixed-size data structures with independent lifetimes. Pools are perfect
+for allocating per-session structures.
+
+Hashes
+------
+
+Vppinfra provides several hash flavors. Data plane problems involving
+packet classification / session lookup often use
+./src/vppinfra/bihash_template.[ch] bounded-index extensible hashes.
+These templates are instantiated multiple times, to efficiently service
+different fixed-key sizes.
+
+Bihashes are thread-safe. Read-locking is not required. A simple
+spin-lock ensures that only one thread writes an entry at a time.
+
+The original vppinfra hash implementation in ./src/vppinfra/hash.[ch]
+are simple to use, and are often used in control-plane code which needs
+exact-string-matching.
+
+In either case, one almost always looks up a key in a hash table to
+obtain an index in a related vector or pool. The APIs are simple enough,
+but one must take care when using the unmanaged arbitrary-sized key
+variant. Hash_set_mem (hash_table, key_pointer, value) memorizes
+key_pointer. It is usually a bad mistake to pass the address of a vector
+element as the second argument to hash_set_mem. It is perfectly fine to
+memorize constant string addresses in the text segment.
+
+Timekeeping
+-----------
+
+Vppinfra includes high-precision, low-cost timing services. The datatype
+clib_time_t and associated functions reside in ./src/vppinfra/time.[ch].
+Call clib_time_init (clib_time_t \*cp) to initialize the clib_time_t
+object.
+
+Clib_time_init(…) can use a variety of different ways to establish the
+hardware clock frequency. At the end of the day, vppinfra timekeeping
+takes the attitude that the operating system’s clock is the closest
+thing to a gold standard it has handy.
+
+When properly configured, NTP maintains kernel clock synchronization
+with a highly accurate off-premises reference clock. Notwithstanding
+network propagation delays, a synchronized NTP client will keep the
+kernel clock accurate to within 50ms or so.
+
+Why should one care? Simply put, oscillators used to generate CPU ticks
+aren’t super accurate. They work pretty well, but a 0.1% error wouldn’t
+be out of the question. That’s a minute and a half’s worth of error in 1
+day. The error changes constantly, due to temperature variation, and a
+host of other physical factors.
+
+It’s far too expensive to use system calls for timing, so we’re left
+with the problem of continuously adjusting our view of the CPU tick
+register’s clocks_per_second parameter.
+
+The clock rate adjustment algorithm measures the number of cpu ticks and
+the “gold standard” reference time across an interval of approximately
+16 seconds. We calculate clocks_per_second for the interval: use rdtsc
+(on x86_64) and a system call to get the latest cpu tick count and the
+kernel’s latest nanosecond timestamp. We subtract the previous interval
+end values, and use exponential smoothing to merge the new clock rate
+sample into the clocks_per_second parameter.
+
+As of this writing, we maintain the clock rate by way of the following
+first-order differential equation:
+
+.. code:: c
+
+      clocks_per_second(t) = clocks_per_second(t-1) * K + sample_cps(t)*(1-K)
+      where K = e**(-1.0/3.75);
+
+This yields a per observation “half-life” of 1 minute. Empirically, the
+clock rate converges within 5 minutes, and appears to maintain
+near-perfect agreement with the kernel clock in the face of ongoing NTP
+time adjustments.
+
+See ./src/vppinfra/time.c:clib_time_verify_frequency(…) to look at the
+rate adjustment algorithm. The code rejects frequency samples
+corresponding to the sort of adjustment which might occur if someone
+changes the gold standard kernel clock by several seconds.
+
+Monotonic timebase support
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Particularly during system initialization, the “gold standard” system
+reference clock can change by a large amount, in an instant. It’s not a
+best practice to yank the reference clock - in either direction - by
+hours or days. In fact, some poorly-constructed use-cases do so.
+
+To deal with this reality, clib_time_now(…) returns the number of
+seconds since vpp started, *guaranteed to be monotonically increasing,
+no matter what happens to the system reference clock*.
+
+This is first-order important, to avoid breaking every active timer in
+the system. The vpp host stack alone may account for tens of millions of
+active timers. It’s utterly impractical to track down and fix timers, so
+we must deal with the issue at the timebase level.
+
+Here’s how it works. Prior to adjusting the clock rate, we collect the
+kernel reference clock and the cpu clock:
+
+.. code:: c
+
+     /* Ask the kernel and the CPU what time it is... */
+     now_reference = unix_time_now ();
+     now_clock = clib_cpu_time_now ();
+
+Compute changes for both clocks since the last rate adjustment, roughly
+15 seconds ago:
+
+.. code:: c
+
+     /* Compute change in the reference clock */
+     delta_reference = now_reference - c->last_verify_reference_time;
+
+     /* And change in the CPU clock */
+     delta_clock_in_seconds = (f64) (now_clock - c->last_verify_cpu_time) *
+       c->seconds_per_clock;
+
+Delta_reference is key. Almost 100% of the time, delta_reference and
+delta_clock_in_seconds are identical modulo one system-call time.
+However, NTP or a privileged user can yank the system reference time -
+in either direction - by an hour, a day, or a decade.
+
+As described above, clib_time_now(…) must return monotonically
+increasing answers to the question “how long has it been since vpp
+started, in seconds.” To do that, the clock rate adjustment algorithm
+begins by recomputing the initial reference time:
+
+.. code:: c
+
+     c->init_reference_time += (delta_reference - delta_clock_in_seconds);
+
+It’s easy to convince yourself that if the reference clock changes by
+15.000000 seconds and the cpu clock tick time changes by 15.000000
+seconds, the initial reference time won’t change.
+
+If, on the other hand, delta_reference is -86400.0 and delta clock is
+15.0 - reference time jumped backwards by exactly one day in a 15-second
+rate update interval - we add -86415.0 to the initial reference time.
+
+Given the corrected initial reference time, we recompute the total
+number of cpu ticks which have occurred since the corrected initial
+reference time, at the current clock tick rate:
+
+.. code:: c
+
+     c->total_cpu_time = (now_reference - c->init_reference_time)
+       * c->clocks_per_second;
+
+Timebase precision
+~~~~~~~~~~~~~~~~~~
+
+Cognoscenti may notice that vlib/clib_time_now(…) return a 64-bit
+floating-point value; the number of seconds since vpp started.
+
+Please see `this Wikipedia
+article `__
+for more information. C double-precision floating point numbers (called
+f64 in the vpp code base) have a 53-bit effective mantissa, and can
+accurately represent 15 decimal digits’ worth of precision.
+
+There are 315,360,000.000001 seconds in ten years plus one microsecond.
+That string has exactly 15 decimal digits. The vpp time base retains 1us
+precision for roughly 30 years.
+
+vlib/clib_time_now do *not* provide precision in excess of 1e-6 seconds.
+If necessary, please use clib_cpu_time_now(…) for direct access to the
+CPU clock-cycle counter. Note that the number of CPU clock cycles per
+second varies significantly across CPU architectures.
+
+Timer Wheels
+------------
+
+Vppinfra includes configurable timer wheel support. See the source code
+in …/src/vppinfra/tw_timer_template.[ch], as well as a considerable
+number of template instances defined in …/src/vppinfra/tw_timer\_.[ch].
+
+Instantiation of tw_timer_template.h generates named structures to
+implement specific timer wheel geometries. Choices include: number of
+timer wheels (currently, 1 or 2), number of slots per ring (a power of
+two), and the number of timers per “object handle”.
+
+Internally, user object/timer handles are 32-bit integers, so if one
+selects 16 timers/object (4 bits), the resulting timer wheel handle is
+limited to 2**28 objects.
+
+Here are the specific settings required to generate a single 2048 slot
+wheel which supports 2 timers per object:
+
+.. code:: c
+
+       #define TW_TIMER_WHEELS 1
+       #define TW_SLOTS_PER_RING 2048
+       #define TW_RING_SHIFT 11
+       #define TW_RING_MASK (TW_SLOTS_PER_RING -1)
+       #define TW_TIMERS_PER_OBJECT 2
+       #define LOG2_TW_TIMERS_PER_OBJECT 1
+       #define TW_SUFFIX _2t_1w_2048sl
+       #define TW_FAST_WHEEL_BITMAP 0
+       #define TW_TIMER_ALLOW_DUPLICATE_STOP 0
+
+See tw_timer_2t_1w_2048sl.h for a complete example.
+
+tw_timer_template.h is not intended to be #included directly. Client
+codes can include multiple timer geometry header files, although extreme
+caution would required to use the TW and TWT macros in such a case.
+
+API usage examples
+~~~~~~~~~~~~~~~~~~
+
+The unit test code in …/src/vppinfra/test_tw_timer.c provides a concrete
+API usage example. It uses a synthetic clock to rapidly exercise the
+underlying tw_timer_expire_timers(…) template.
+
+There are not many API routines to call.
+
+Initialize a two-timer, single 2048-slot wheel w/ a 1-second timer granularity
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code:: c
+
+       tw_timer_wheel_init_2t_1w_2048sl (&tm->single_wheel,
+                                        expired_timer_single_callback,
+                         1.0 / * timer interval * / );
+
+Start a timer
+^^^^^^^^^^^^^
+
+.. code:: c
+
+       handle = tw_timer_start_2t_1w_2048sl (&tm->single_wheel, elt_index,
+                                             [0 | 1] / * timer id * / ,
+                                             expiration_time_in_u32_ticks);
+
+Stop a timer
+^^^^^^^^^^^^
+
+.. code:: c
+
+       tw_timer_stop_2t_1w_2048sl (&tm->single_wheel, handle);
+
+An expired timer callback
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code:: c
+
+       static void
+       expired_timer_single_callback (u32 * expired_timers)
+       {
+           int i;
+           u32 pool_index, timer_id;
+           tw_timer_test_elt_t *e;
+           tw_timer_test_main_t *tm = &tw_timer_test_main;
+
+           for (i = 0; i < vec_len (expired_timers);
+               {
+               pool_index = expired_timers[i] & 0x7FFFFFFF;
+               timer_id = expired_timers[i] >> 31;
+
+               ASSERT (timer_id == 1);
+
+               e = pool_elt_at_index (tm->test_elts, pool_index);
+
+               if (e->expected_to_expire != tm->single_wheel.current_tick)
+                 {
+                   fformat (stdout, "[%d] expired at %d not %d\n",
+                            e - tm->test_elts, tm->single_wheel.current_tick,
+                            e->expected_to_expire);
+                 }
+            pool_put (tm->test_elts, e);
+            }
+        }
+
+We use wheel timers extensively in the vpp host stack. Each TCP session
+needs 5 timers, so supporting 10 million flows requires up to 50 million
+concurrent timers.
+
+Timers rarely expire, so it’s of utmost important that stopping and
+restarting a timer costs as few clock cycles as possible.
+
+Stopping a timer costs a doubly-linked list dequeue. Starting a timer
+involves modular arithmetic to determine the correct timer wheel and
+slot, and a list head enqueue.
+
+Expired timer processing generally involves bulk link-list retirement
+with user callback presentation. Some additional complexity at wheel
+wrap time, to relocate timers from slower-turning timer wheels into
+faster-turning wheels.
+
+Format
+------
+
+Vppinfra format is roughly equivalent to printf.
+
+Format has a few properties worth mentioning. Format’s first argument is
+a (u8 \*) vector to which it appends the result of the current format
+operation. Chaining calls is very easy:
+
+.. code:: c
+
+       u8 * result;
+
+       result = format (0, "junk = %d, ", junk);
+       result = format (result, "more junk = %d\n", more_junk);
+
+As previously noted, NULL pointers are perfectly proper 0-length
+vectors. Format returns a (u8 \*) vector, **not** a C-string. If you
+wish to print a (u8 \*) vector, use the “%v” format string. If you need
+a (u8 \*) vector which is also a proper C-string, either of these
+schemes may be used:
+
+.. code:: c
+
+       vec_add1 (result, 0)
+       or
+       result = format (result, "%c", 0);
+
+Remember to vec_free() the result if appropriate. Be careful not to pass
+format an uninitialized (u8 \*).
+
+Format implements a particularly handy user-format scheme via the “%U”
+format specification. For example:
+
+.. code:: c
+
+       u8 * format_junk (u8 * s, va_list *va)
+       {
+         junk = va_arg (va, u32);
+         s = format (s, "%s", junk);
+         return s;
+       }
+
+       result = format (0, "junk = %U, format_junk, "This is some junk");
+
+format_junk() can invoke other user-format functions if desired. The
+programmer shoulders responsibility for argument type-checking. It is
+typical for user format functions to blow up spectacularly if the
+va_arg(va, type) macros don’t match the caller’s idea of reality.
+
+Unformat
+--------
+
+Vppinfra unformat is vaguely related to scanf, but considerably more
+general.
+
+A typical use case involves initializing an unformat_input_t from either
+a C-string or a (u8 \*) vector, then parsing via unformat() as follows:
+
+.. code:: c
+
+       unformat_input_t input;
+       u8 *s = "";
+
+       unformat_init_string (&input, (char *) s, strlen((char *) s));
+       /* or */
+       unformat_init_vector (&input, );
+
+Then loop parsing individual elements:
+
+.. code:: c
+
+       while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
+       {
+         if (unformat (&input, "value1 %d", &value1))
+           ;/* unformat sets value1 */
+         else if (unformat (&input, "value2 %d", &value2)
+           ;/* unformat sets value2 */
+         else
+           return clib_error_return (0, "unknown input '%U'",
+                                     format_unformat_error, input);
+       }
+
+As with format, unformat implements a user-unformat function capability
+via a “%U” user unformat function scheme. Generally, one can trivially
+transform “format (s,”foo %d”, foo) -> “unformat (input,”foo %d”,
+&foo)“.
+
+Unformat implements a couple of handy non-scanf-like format specifiers:
+
+.. code:: c
+
+       unformat (input, "enable %=", &enable, 1 /* defaults to 1 */);
+       unformat (input, "bitzero %|", &mask, (1<<0));
+       unformat (input, "bitone %|", &mask, (1<<1));
+       
+
+The phrase “enable %=” means “set the supplied variable to the default
+value” if unformat parses the “enable” keyword all by itself. If
+unformat parses “enable 123” set the supplied variable to 123.
+
+We could clean up a number of hand-rolled “verbose” + “verbose %d”
+argument parsing codes using “%=”.
+
+The phrase “bitzero %\|” means “set the specified bit in the supplied
+bitmask” if unformat parses “bitzero”. Although it looks like it could
+be fairly handy, it’s very lightly used in the code base.
+
+``%_`` toggles whether or not to skip input white space.
+
+For transition from skip to no-skip in middle of format string, skip
+input white space. For example, the following:
+
+.. code:: c
+
+   fmt = "%_%d.%d%_->%_%d.%d%_"
+   unformat (input, fmt, &one, &two, &three, &four);
+
+matches input “1.2 -> 3.4”. Without this, the space after -> does not
+get skipped.
+
+
+How to parse a single input line
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Debug CLI command functions MUST NOT accidentally consume input
+belonging to other debug CLI commands. Otherwise, it's impossible to
+script a set of debug CLI commands which "work fine" when issued one
+at a time.
+
+This bit of code is NOT correct:
+
+.. code:: c
+
+     /* Eats script input NOT beloging to it, and chokes! */
+     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+       {
+         if (unformat (input, ...))
+       ;
+         else if (unformat (input, ...))
+       ;
+         else
+           return clib_error_return (0, "parse error: '%U'",
+                                format_unformat_error, input);
+       }
+       }
+
+When executed as part of a script, such a function will return “parse
+error: ‘’” every time, unless it happens to be the last command in the
+script.
+
+Instead, use “unformat_line_input” to consume the rest of a line’s worth
+of input - everything past the path specified in the VLIB_CLI_COMMAND
+declaration.
+
+For example, unformat_line_input with “my_command” set up as shown below
+and user input “my path is clear” will produce an unformat_input_t that
+contains “is clear”.
+
+.. code:: c
+
+       VLIB_CLI_COMMAND (...) = {
+           .path = "my path",
+       };
+
+Here’s a bit of code which shows the required mechanics, in full:
+
+.. code:: c
+
+       static clib_error_t *
+       my_command_fn (vlib_main_t * vm,
+                      unformat_input_t * input,
+                      vlib_cli_command_t * cmd)
+       {
+         unformat_input_t _line_input, *line_input = &_line_input;
+         u32 this, that;
+         clib_error_t *error = 0;
+
+         if (!unformat_user (input, unformat_line_input, line_input))
+           return 0;
+
+         /*
+          * Here, UNFORMAT_END_OF_INPUT is at the end of the line we consumed,
+          * not at the end of the script...
+          */
+         while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
+           {
+              if (unformat (line_input, "this %u", &this))
+                ;
+              else if (unformat (line_input, "that %u", &that))
+                ;
+              else
+                {
+                  error = clib_error_return (0, "parse error: '%U'",
+                                    format_unformat_error, line_input);
+                  goto done;
+                }
+             }
+
+       
+
+       done:
+         unformat_free (line_input);
+         return error;
+       }
+      VLIB_CLI_COMMAND (my_command, static) = {
+        .path = "my path",
+        .function = my_command_fn",
+      };
+
+Vppinfra errors and warnings
+----------------------------
+
+Many functions within the vpp dataplane have return-values of type
+clib_error_t \*. Clib_error_t’s are arbitrary strings with a bit of
+metadata [fatal, warning] and are easy to announce. Returning a NULL
+clib_error_t \* indicates “A-OK, no error.”
+
+Clib_warning(format-args) is a handy way to add debugging output; clib
+warnings prepend function:line info to unambiguously locate the message
+source. Clib_unix_warning() adds perror()-style Linux system-call
+information. In production images, clib_warnings result in syslog
+entries.
+
+Serialization
+-------------
+
+Vppinfra serialization support allows the programmer to easily serialize
+and unserialize complex data structures.
+
+The underlying primitive serialize/unserialize functions use network
+byte-order, so there are no structural issues serializing on a
+little-endian host and unserializing on a big-endian host.
diff --git a/docs/developer/corearchitecture/mem.rst b/docs/developer/corearchitecture/mem.rst
new file mode 120000
index 00000000000..0fc53eab68c
--- /dev/null
+++ b/docs/developer/corearchitecture/mem.rst
@@ -0,0 +1 @@
+../../../src/vpp/mem/mem.rst
\ No newline at end of file
diff --git a/docs/developer/corearchitecture/multi_thread.rst b/docs/developer/corearchitecture/multi_thread.rst
new file mode 100644
index 00000000000..195a9b791fd
--- /dev/null
+++ b/docs/developer/corearchitecture/multi_thread.rst
@@ -0,0 +1,169 @@
+.. _vpp_multi_thread:
+
+Multi-threading in VPP
+======================
+
+Modes
+-----
+
+VPP can work in 2 different modes:
+
+-  single-thread
+-  multi-thread with worker threads
+
+Single-thread
+~~~~~~~~~~~~~
+
+In a single-thread mode there is one main thread which handles both
+packet processing and other management functions (Command-Line Interface
+(CLI), API, stats). This is the default setup. There is no special
+startup config needed.
+
+Multi-thread with Worker Threads
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In this mode, the main threads handles management functions(debug CLI,
+API, stats collection) and one or more worker threads handle packet
+processing from input to output of the packet.
+
+Each worker thread polls input queues on subset of interfaces.
+
+With RSS (Receive Side Scaling) enabled multiple threads can service one
+physical interface (RSS function on NIC distributes traffic between
+different queues which are serviced by different worker threads).
+
+Thread placement
+----------------
+
+Thread placement is defined in the startup config under the cpu { … }
+section.
+
+The VPP platform can place threads automatically or manually. Automatic
+placement works in the following way:
+
+-  if “skip-cores X” is defined first X cores will not be used
+-  if “main-core X” is defined, VPP main thread will be placed on core
+   X, otherwise 1st available one will be used
+-  if “workers N” is defined vpp will allocate first N available cores
+   and it will run threads on them
+-  if “corelist-workers A,B1-Bn,C1-Cn” is defined vpp will automatically
+   assign those CPU cores to worker threads
+
+User can see active placement of cores by using the VPP debug CLI
+command show threads:
+
+.. code-block:: console
+
+   vpd# show threads
+   ID     Name                Type        LWP     lcore  Core   Socket State
+   0      vpe_main                        59723   2      2      0      wait
+   1      vpe_wk_0            workers     59755   4      4      0      running
+   2      vpe_wk_1            workers     59756   5      5      0      running
+   3      vpe_wk_2            workers     59757   6      0      1      running
+   4      vpe_wk_3            workers     59758   7      1      1      running
+   5                          stats       59775
+   vpd#
+
+The sample output above shows the main thread running on core 2 (2nd
+core on the CPU socket 0), worker threads running on cores 4-7.
+
+Sample Configurations
+---------------------
+
+By default, at start-up VPP uses
+configuration values from: ``/etc/vpp/startup.conf``
+
+The following sections describe some of the additional changes that can be made to this file.
+This file is initially populated from the files located in the following directory ``/vpp/vpp/conf/``
+
+Manual Placement
+~~~~~~~~~~~~~~~~
+
+Manual placement places the main thread on core 1, workers on cores
+4,5,20,21.
+
+.. code-block:: console
+
+   cpu {
+     main-core 1
+     corelist-workers  4-5,20-21
+   }
+
+Auto placement
+--------------
+
+Auto placement is likely to place the main thread on core 1 and workers
+on cores 2,3,4.
+
+.. code-block:: console
+
+   cpu {
+     skip-cores 1
+     workers 3
+   }
+
+Buffer Memory Allocation
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The VPP platform is NUMA aware. It can allocate memory for buffers on
+different CPU sockets (NUMA nodes). The amount of memory allocated can
+be defined in the startup config for each CPU socket by using the
+socket-mem A[[,B],C] statement inside the dpdk { … } section.
+
+For example:
+
+.. code-block:: console
+
+   dpdk {
+     socket-mem 1024,1024
+   }
+
+The above configuration allocates 1GB of memory on NUMA#0 and 1GB on
+NUMA#1. Each worker thread uses buffers which are local to itself.
+
+Buffer memory is allocated from hugepages. VPP prefers 1G pages if they
+are available. If not 2MB pages will be used.
+
+VPP takes care of mounting/unmounting hugepages file-system
+automatically so there is no need to do that manually.
+
+’‘’NOTE’’’: If you are running latest VPP release, there is no need for
+specifying socket-mem manually. VPP will discover all NUMA nodes and it
+will allocate 512M on each by default. socket-mem is only needed if
+bigger number of mbufs is required (default is 16384 per socket and can
+be changed with num-mbufs startup config command).
+
+Interface Placement in Multi-thread Setup
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On startup, the VPP platform assigns interfaces (or interface, queue
+pairs if RSS is used) to different worker threads in round robin
+fashion.
+
+The following example shows debug CLI commands to show and change
+interface placement:
+
+.. code-block:: console
+
+   vpd# sh dpdk interface placement
+   Thread 1 (vpp_wk_0 at lcore 5):
+    TenGigabitEthernet2/0/0 queue 0
+    TenGigabitEthernet2/0/1 queue 0
+   Thread 2 (vpp_wk_1 at lcore 6):
+    TenGigabitEthernet2/0/0 queue 1
+    TenGigabitEthernet2/0/1 queue 1
+
+The following shows an example of moving TenGigabitEthernet2/0/1 queue 1
+processing to 1st worker thread:
+
+.. code-block:: console
+
+   vpd# set interface placement TenGigabitEthernet2/0/1 queue 1 thread 1
+
+   vpp# sh dpdk interface placement
+   Thread 1 (vpp_wk_0 at lcore 5):
+    TenGigabitEthernet2/0/0 queue 0
+    TenGigabitEthernet2/0/1 queue 0
+    TenGigabitEthernet2/0/1 queue 1
+   Thread 2 (vpp_wk_1 at lcore 6):
+    TenGigabitEthernet2/0/0 queue 1
diff --git a/docs/developer/corearchitecture/multiarch/arbfns.rst b/docs/developer/corearchitecture/multiarch/arbfns.rst
new file mode 100644
index 00000000000..d469bd8a140
--- /dev/null
+++ b/docs/developer/corearchitecture/multiarch/arbfns.rst
@@ -0,0 +1,87 @@
+Multi-Architecture Arbitrary Function Cookbook
+==============================================
+
+Optimizing arbitrary functions for multiple architectures is simple
+enough, and very similar to process used to produce multi-architecture
+graph node dispatch functions.
+
+As with multi-architecture graph nodes, we compile source files
+multiple times, generating multiple implementations of the original
+function, and a public selector function.
+
+Details
+-------
+
+Decorate function definitions with CLIB_MARCH_FN macros. For example:
+
+Change the original function prototype...
+
+::
+
+   u32 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
+                                 u32 frame_flags)
+
+...by recasting the function name and return type as the first two
+arguments to the CLIB_MARCH_FN macro:
+
+::
+
+    CLIB_MARCH_FN (vlib_frame_alloc_to_node, u32, vlib_main_t * vm,
+                   u32 to_node_index, u32 frame_flags)
+
+In the actual vpp image, several versions of vlib_frame_alloc_to_node
+will appear: vlib_frame_alloc_to_node_avx2,
+vlib_frame_alloc_to_node_avx512, and so forth.
+
+
+For each multi-architecture function, use the CLIB_MARCH_FN_SELECT
+macro to help generate the one-and-only multi-architecture selector
+function:
+
+::
+
+    #ifndef CLIB_MARCH_VARIANT
+    u32
+    vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
+    			  u32 frame_flags)
+    {
+      return CLIB_MARCH_FN_SELECT (vlib_frame_alloc_to_node)
+        (vm, to_node_index, frame_flags);
+    }
+    #endif /* CLIB_MARCH_VARIANT */
+
+Once bound, the multi-architecture selector function is about as
+expensive as an indirect function call; which is to say: not very
+expensive.
+
+Modify CMakeLists.txt
+---------------------
+
+If the component in question already lists "MULTIARCH_SOURCES", simply
+add the indicated .c file to the list.  Otherwise, add as shown
+below. Note that the added file "new_multiarch_node.c" should appear in
+*both* SOURCES and MULTIARCH_SOURCES:
+
+::
+
+    add_vpp_plugin(myplugin
+      SOURCES
+      multiarch_code.c
+      ...
+
+      MULTIARCH_SOURCES
+      multiarch_code.c
+      ...
+     )
+
+A Word to the Wise
+------------------
+
+A file which liberally mixes functions worth compiling for multiple
+architectures and functions which are not will end up full of
+#ifndef CLIB_MARCH_VARIANT conditionals. This won't do a thing to make
+the code look any better.
+
+Depending on requirements, it may make sense to move functions to
+(new) files to reduce complexity and/or improve legibility of the
+resulting code.
diff --git a/docs/developer/corearchitecture/multiarch/index.rst b/docs/developer/corearchitecture/multiarch/index.rst
new file mode 100644
index 00000000000..824a8e68438
--- /dev/null
+++ b/docs/developer/corearchitecture/multiarch/index.rst
@@ -0,0 +1,12 @@
+.. _multiarch:
+
+Multi-architecture support
+==========================
+
+This reference guide describes how to use the vpp multi-architecture support scheme
+
+.. toctree::
+   :maxdepth: 1
+
+   nodefns
+   arbfns
diff --git a/docs/developer/corearchitecture/multiarch/nodefns.rst b/docs/developer/corearchitecture/multiarch/nodefns.rst
new file mode 100644
index 00000000000..9647e64f08c
--- /dev/null
+++ b/docs/developer/corearchitecture/multiarch/nodefns.rst
@@ -0,0 +1,138 @@
+Multi-Architecture Graph Node Cookbook
+======================================
+
+In the context of graph node dispatch functions, it's easy enough to
+use the vpp multi-architecture support setup. The point of the scheme
+is simple: for performance-critical nodes, generate multiple CPU
+hardware-dependent versions of the node dispatch functions, and pick
+the best one at runtime.
+
+The vpp scheme is simple enough to use, but details matter.
+
+100,000 foot view
+-----------------
+
+We compile entire graph node dispatch function implementation files
+multiple times. These compilations give rise to multiple versions of
+the graph node dispatch functions. Per-node constructor-functions
+interrogate CPU hardware, select the node dispatch function variant to
+use, and set the vlib_node_registration_t ".function" member to the
+address of the selected variant.
+
+Details
+-------
+
+Declare the node dispatch function as shown, using the VLIB\_NODE\_FN macro. The
+name of the node function **MUST** match the name of the graph node.
+
+::
+
+    VLIB_NODE_FN (ip4_sdp_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
+                                 vlib_frame_t * frame)
+    {
+      if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
+        return ip46_sdp_inline (vm, node, frame, 1 /* is_ip4 */ ,
+    			    1 /* is_trace */ );
+      else
+        return ip46_sdp_inline (vm, node, frame, 1 /* is_ip4 */ ,
+    			    0 /* is_trace */ );
+    }
+
+We need to generate *precisely one copy* of the
+vlib_node_registration_t, error strings, and packet trace decode function.
+
+Simply bracket these items with "#ifndef CLIB_MARCH_VARIANT...#endif":
+
+::
+
+    #ifndef CLIB_MARCH_VARIANT
+    static u8 *
+    format_sdp_trace (u8 * s, va_list * args)
+    {
+       
+    }
+    #endif
+
+    ...
+
+    #ifndef CLIB_MARCH_VARIANT
+    static char *sdp_error_strings[] = {
+    #define _(sym,string) string,
+      foreach_sdp_error
+    #undef _
+    };
+    #endif
+
+    ...
+
+    #ifndef CLIB_MARCH_VARIANT
+    VLIB_REGISTER_NODE (ip4_sdp_node) =
+    {
+      // DO NOT set the .function structure member.
+      // The multiarch selection __attribute__((constructor)) function
+      // takes care of it at runtime
+      .name = "ip4-sdp",
+      .vector_size = sizeof (u32),
+      .format_trace = format_sdp_trace,
+      .type = VLIB_NODE_TYPE_INTERNAL,
+
+      .n_errors = ARRAY_LEN(sdp_error_strings),
+      .error_strings = sdp_error_strings,
+
+      .n_next_nodes = SDP_N_NEXT,
+
+      /* edit / add dispositions here */
+      .next_nodes =
+      {
+        [SDP_NEXT_DROP] = "ip4-drop",
+      },
+    };
+    #endif
+
+To belabor the point: *do not* set the ".function" member! That's the job of the multi-arch
+selection \_\_attribute\_\_((constructor)) function
+
+Always inline node dispatch functions
+-------------------------------------
+
+It's typical for a graph dispatch function to contain one or more
+calls to an inline function. See above. If your node dispatch function
+is structured that way, make *ABSOLUTELY CERTAIN* to use the
+"always_inline" macro:
+
+::
+
+    always_inline uword
+    ip46_sdp_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
+                 vlib_frame_t * frame,
+    		 int is_ip4, int is_trace)
+    { ... }
+
+Otherwise, the compiler is highly likely NOT to build multiple
+versions of the guts of your dispatch function.
+
+It's fairly easy to spot this mistake in "perf top." If you see, for
+example, a bunch of functions with names of the form
+"xxx_node_fn_avx2" in the profile, *BUT* your brand-new node function
+shows up with a name of the form "xxx_inline.isra.1", it's quite likely
+that the inline was declared "static inline" instead of "always_inline".
+
+Modify CMakeLists.txt
+---------------------
+
+If the component in question already lists "MULTIARCH_SOURCES", simply
+add the indicated .c file to the list.  Otherwise, add as shown
+below. Note that the added file "new_multiarch_node.c" should appear in
+*both* SOURCES and MULTIARCH_SOURCES:
+
+::
+
+    add_vpp_plugin(myplugin
+      SOURCES
+      new_multiarch_node.c
+      ...
+
+      MULTIARCH_SOURCES
+      new_ multiarch_node.c
+      ...
+     )
diff --git a/docs/developer/corearchitecture/softwarearchitecture.rst b/docs/developer/corearchitecture/softwarearchitecture.rst
new file mode 100644
index 00000000000..7f8a0e04645
--- /dev/null
+++ b/docs/developer/corearchitecture/softwarearchitecture.rst
@@ -0,0 +1,47 @@
+Software Architecture
+=====================
+
+The fd.io vpp implementation is a third-generation vector packet
+processing implementation specifically related to US Patent 7,961,636,
+as well as earlier work. Note that the Apache-2 license specifically
+grants non-exclusive patent licenses; we mention this patent as a point
+of historical interest.
+
+For performance, the vpp dataplane consists of a directed graph of
+forwarding nodes which process multiple packets per invocation. This
+schema enables a variety of micro-processor optimizations: pipelining
+and prefetching to cover dependent read latency, inherent I-cache phase
+behavior, vector instructions. Aside from hardware input and hardware
+output nodes, the entire forwarding graph is portable code.
+
+Depending on the scenario at hand, we often spin up multiple worker
+threads which process ingress-hashes packets from multiple queues using
+identical forwarding graph replicas.
+
+VPP Layers - Implementation Taxonomy
+------------------------------------
+
+.. figure:: /_images/VPP_Layering.png
+   :alt: image
+
+   image
+
+-  VPP Infra - the VPP infrastructure layer, which contains the core
+   library source code. This layer performs memory functions, works with
+   vectors and rings, performs key lookups in hash tables, and works
+   with timers for dispatching graph nodes.
+-  VLIB - the vector processing library. The vlib layer also handles
+   various application management functions: buffer, memory and graph
+   node management, maintaining and exporting counters, thread
+   management, packet tracing. Vlib implements the debug CLI (command
+   line interface).
+-  VNET - works with VPP's networking interface (layers 2, 3, and 4)
+   performs session and traffic management, and works with devices and
+   the data control plane.
+-  Plugins - Contains an increasingly rich set of data-plane plugins, as
+   noted in the above diagram.
+-  VPP - the container application linked against all of the above.
+
+It’s important to understand each of these layers in a certain amount of
+detail. Much of the implementation is best dealt with at the API level
+and otherwise left alone.
diff --git a/docs/developer/corearchitecture/vlib.rst b/docs/developer/corearchitecture/vlib.rst
new file mode 100644
index 00000000000..f542d33ebb8
--- /dev/null
+++ b/docs/developer/corearchitecture/vlib.rst
@@ -0,0 +1,888 @@
+VLIB (Vector Processing Library)
+================================
+
+The files associated with vlib are located in the ./src/{vlib, vlibapi,
+vlibmemory} folders. These libraries provide vector processing support
+including graph-node scheduling, reliable multicast support,
+ultra-lightweight cooperative multi-tasking threads, a CLI, plug in .DLL
+support, physical memory and Linux epoll support. Parts of this library
+embody US Patent 7,961,636.
+
+Init function discovery
+-----------------------
+
+vlib applications register for various [initialization] events by
+placing structures and \__attribute__((constructor)) functions into the
+image. At appropriate times, the vlib framework walks
+constructor-generated singly-linked structure lists, performs a
+topological sort based on specified constraints, and calls the indicated
+functions. Vlib applications create graph nodes, add CLI functions,
+start cooperative multi-tasking threads, etc. etc. using this mechanism.
+
+vlib applications invariably include a number of VLIB_INIT_FUNCTION
+(my_init_function) macros.
+
+Each init / configure / etc. function has the return type clib_error_t
+\*. Make sure that the function returns 0 if all is well, otherwise the
+framework will announce an error and exit.
+
+vlib applications must link against vppinfra, and often link against
+other libraries such as VNET. In the latter case, it may be necessary to
+explicitly reference symbol(s) otherwise large portions of the library
+may be AWOL at runtime.
+
+Init function construction and constraint specification
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+It’s easy to add an init function:
+
+.. code:: c
+
+      static clib_error_t *my_init_function (vlib_main_t *vm)
+      {
+         /* ... initialize things ... */
+
+         return 0; // or return clib_error_return (0, "BROKEN!");
+      }
+      VLIB_INIT_FUNCTION(my_init_function);
+
+As given, my_init_function will be executed “at some point,” but with no
+ordering guarantees.
+
+Specifying ordering constraints is easy:
+
+.. code:: c
+
+      VLIB_INIT_FUNCTION(my_init_function) =
+      {
+         .runs_before = VLIB_INITS("we_run_before_function_1",
+                                   "we_run_before_function_2"),
+         .runs_after = VLIB_INITS("we_run_after_function_1",
+                                  "we_run_after_function_2),
+       };
+
+It’s also easy to specify bulk ordering constraints of the form “a then
+b then c then d”:
+
+.. code:: c
+
+      VLIB_INIT_FUNCTION(my_init_function) =
+      {
+         .init_order = VLIB_INITS("a", "b", "c", "d"),
+      };
+
+It’s OK to specify all three sorts of ordering constraints for a single
+init function, although it’s hard to imagine why it would be necessary.
+
+Node Graph Initialization
+-------------------------
+
+vlib packet-processing applications invariably define a set of graph
+nodes to process packets.
+
+One constructs a vlib_node_registration_t, most often via the
+VLIB_REGISTER_NODE macro. At runtime, the framework processes the set of
+such registrations into a directed graph. It is easy enough to add nodes
+to the graph at runtime. The framework does not support removing nodes.
+
+vlib provides several types of vector-processing graph nodes, primarily
+to control framework dispatch behaviors. The type member of the
+vlib_node_registration_t functions as follows:
+
+-  VLIB_NODE_TYPE_PRE_INPUT - run before all other node types
+-  VLIB_NODE_TYPE_INPUT - run as often as possible, after pre_input
+   nodes
+-  VLIB_NODE_TYPE_INTERNAL - only when explicitly made runnable by
+   adding pending frames for processing
+-  VLIB_NODE_TYPE_PROCESS - only when explicitly made runnable.
+   “Process” nodes are actually cooperative multi-tasking threads. They
+   **must** explicitly suspend after a reasonably short period of time.
+
+For a precise understanding of the graph node dispatcher, please read
+./src/vlib/main.c:vlib_main_loop.
+
+Graph node dispatcher
+---------------------
+
+Vlib_main_loop() dispatches graph nodes. The basic vector processing
+algorithm is diabolically simple, but may not be obvious from even a
+long stare at the code. Here’s how it works: some input node, or set of
+input nodes, produce a vector of work to process. The graph node
+dispatcher pushes the work vector through the directed graph,
+subdividing it as needed, until the original work vector has been
+completely processed. At that point, the process recurs.
+
+This scheme yields a stable equilibrium in frame size, by construction.
+Here’s why: as the frame size increases, the per-frame-element
+processing time decreases. There are several related forces at work; the
+simplest to describe is the effect of vector processing on the CPU L1
+I-cache. The first frame element [packet] processed by a given node
+warms up the node dispatch function in the L1 I-cache. All subsequent
+frame elements profit. As we increase the number of frame elements, the
+cost per element goes down.
+
+Under light load, it is a crazy waste of CPU cycles to run the graph
+node dispatcher flat-out. So, the graph node dispatcher arranges to wait
+for work by sitting in a timed epoll wait if the prevailing frame size
+is low. The scheme has a certain amount of hysteresis to avoid
+constantly toggling back and forth between interrupt and polling mode.
+Although the graph dispatcher supports interrupt and polling modes, our
+current default device drivers do not.
+
+The graph node scheduler uses a hierarchical timer wheel to reschedule
+process nodes upon timer expiration.
+
+Graph dispatcher internals
+--------------------------
+
+This section may be safely skipped. It’s not necessary to understand
+graph dispatcher internals to create graph nodes.
+
+Vector Data Structure
+---------------------
+
+In vpp / vlib, we represent vectors as instances of the vlib_frame_t
+type:
+
+.. code:: c
+
+       typedef struct vlib_frame_t
+       {
+         /* Frame flags. */
+         u16 flags;
+
+         /* Number of scalar bytes in arguments. */
+         u8 scalar_size;
+
+         /* Number of bytes per vector argument. */
+         u8 vector_size;
+
+         /* Number of vector elements currently in frame. */
+         u16 n_vectors;
+
+         /* Scalar and vector arguments to next node. */
+         u8 arguments[0];
+       } vlib_frame_t;
+
+Note that one *could* construct all kinds of vectors - including vectors
+with some associated scalar data - using this structure. In the vpp
+application, vectors typically use a 4-byte vector element size, and
+zero bytes’ worth of associated per-frame scalar data.
+
+Frames are always allocated on CLIB_CACHE_LINE_BYTES boundaries. Frames
+have u32 indices which make use of the alignment property, so the
+maximum feasible main heap offset of a frame is CLIB_CACHE_LINE_BYTES \*
+0xFFFFFFFF: 64*4 = 256 Gbytes.
+
+Scheduling Vectors
+------------------
+
+As you can see, vectors are not directly associated with graph nodes. We
+represent that association in a couple of ways. The simplest is the
+vlib_pending_frame_t:
+
+.. code:: c
+
+       /* A frame pending dispatch by main loop. */
+       typedef struct
+       {
+         /* Node and runtime for this frame. */
+         u32 node_runtime_index;
+
+         /* Frame index (in the heap). */
+         u32 frame_index;
+
+         /* Start of next frames for this node. */
+         u32 next_frame_index;
+
+         /* Special value for next_frame_index when there is no next frame. */
+       #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
+       } vlib_pending_frame_t;
+
+Here is the code in …/src/vlib/main.c:vlib_main_or_worker_loop() which
+processes frames:
+
+.. code:: c
+
+         /*
+          * Input nodes may have added work to the pending vector.
+          * Process pending vector until there is nothing left.
+          * All pending vectors will be processed from input -> output.
+          */
+         for (i = 0; i < _vec_len (nm->pending_frames); i++)
+       cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
+         /* Reset pending vector for next iteration. */
+
+The pending frame node_runtime_index associates the frame with the node
+which will process it.
+
+Complications
+-------------
+
+Fasten your seatbelt. Here’s where the story - and the data structures -
+become quite complicated…
+
+At 100,000 feet: vpp uses a directed graph, not a directed *acyclic*
+graph. It’s really quite normal for a packet to visit ip[46]-lookup
+multiple times. The worst-case: a graph node which enqueues packets to
+itself.
+
+To deal with this issue, the graph dispatcher must force allocation of a
+new frame if the current graph node’s dispatch function happens to
+enqueue a packet back to itself.
+
+There are no guarantees that a pending frame will be processed
+immediately, which means that more packets may be added to the
+underlying vlib_frame_t after it has been attached to a
+vlib_pending_frame_t. Care must be taken to allocate new frames and
+pending frames if a (pending_frame, frame) pair fills.
+
+Next frames, next frame ownership
+---------------------------------
+
+The vlib_next_frame_t is the last key graph dispatcher data structure:
+
+.. code:: c
+
+       typedef struct
+       {
+         /* Frame index. */
+         u32 frame_index;
+
+         /* Node runtime for this next. */
+         u32 node_runtime_index;
+
+         /* Next frame flags. */
+         u32 flags;
+
+         /* Reflects node frame-used flag for this next. */
+       #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
+         VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
+
+         /* This next frame owns enqueue to node
+            corresponding to node_runtime_index. */
+       #define VLIB_FRAME_OWNER (1 << 15)
+
+         /* Set when frame has been allocated for this next. */
+       #define VLIB_FRAME_IS_ALLOCATED VLIB_NODE_FLAG_IS_OUTPUT
+
+         /* Set when frame has been added to pending vector. */
+       #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
+
+         /* Set when frame is to be freed after dispatch. */
+       #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
+
+         /* Set when frame has traced packets. */
+       #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
+
+         /* Number of vectors enqueue to this next since last overflow. */
+         u32 vectors_since_last_overflow;
+       } vlib_next_frame_t;
+
+Graph node dispatch functions call vlib_get_next_frame (…) to set “(u32
+\*)to_next” to the right place in the vlib_frame_t corresponding to the
+ith arc (aka next0) from the current node to the indicated next node.
+
+After some scuffling around - two levels of macros - processing reaches
+vlib_get_next_frame_internal (…). Get-next-frame-internal digs up the
+vlib_next_frame_t corresponding to the desired graph arc.
+
+The next frame data structure amounts to a graph-arc-centric frame
+cache. Once a node finishes adding element to a frame, it will acquire a
+vlib_pending_frame_t and end up on the graph dispatcher’s run-queue. But
+there’s no guarantee that more vector elements won’t be added to the
+underlying frame from the same (source_node, next_index) arc or from a
+different (source_node, next_index) arc.
+
+Maintaining consistency of the arc-to-frame cache is necessary. The
+first step in maintaining consistency is to make sure that only one
+graph node at a time thinks it “owns” the target vlib_frame_t.
+
+Back to the graph node dispatch function. In the usual case, a certain
+number of packets will be added to the vlib_frame_t acquired by calling
+vlib_get_next_frame (…).
+
+Before a dispatch function returns, it’s required to call
+vlib_put_next_frame (…) for all of the graph arcs it actually used. This
+action adds a vlib_pending_frame_t to the graph dispatcher’s pending
+frame vector.
+
+Vlib_put_next_frame makes a note in the pending frame of the frame
+index, and also of the vlib_next_frame_t index.
+
+dispatch_pending_node actions
+-----------------------------
+
+The main graph dispatch loop calls dispatch pending node as shown above.
+
+Dispatch_pending_node recovers the pending frame, and the graph node
+runtime / dispatch function. Further, it recovers the next_frame
+currently associated with the vlib_frame_t, and detaches the
+vlib_frame_t from the next_frame.
+
+In …/src/vlib/main.c:dispatch_pending_node(…), note this stanza:
+
+.. code:: c
+
+     /* Force allocation of new frame while current frame is being
+        dispatched. */
+     restore_frame_index = ~0;
+     if (nf->frame_index == p->frame_index)
+       {
+         nf->frame_index = ~0;
+         nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
+         if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
+       restore_frame_index = p->frame_index;
+       }
+
+dispatch_pending_node is worth a hard stare due to the several
+second-order optimizations it implements. Almost as an afterthought, it
+calls dispatch_node which actually calls the graph node dispatch
+function.
+
+Process / thread model
+----------------------
+
+vlib provides an ultra-lightweight cooperative multi-tasking thread
+model. The graph node scheduler invokes these processes in much the same
+way as traditional vector-processing run-to-completion graph nodes;
+plus-or-minus a setjmp/longjmp pair required to switch stacks. Simply
+set the vlib_node_registration_t type field to vlib_NODE_TYPE_PROCESS.
+Yes, process is a misnomer. These are cooperative multi-tasking threads.
+
+As of this writing, the default stack size is 2<<15 = 32kb. Initialize
+the node registration’s process_log2_n_stack_bytes member as needed. The
+graph node dispatcher makes some effort to detect stack overrun, e.g. by
+mapping a no-access page below each thread stack.
+
+Process node dispatch functions are expected to be “while(1) { }” loops
+which suspend when not otherwise occupied, and which must not run for
+unreasonably long periods of time.
+
+“Unreasonably long” is an application-dependent concept. Over the years,
+we have constructed frame-size sensitive control-plane nodes which will
+use a much higher fraction of the available CPU bandwidth when the frame
+size is low. The classic example: modifying forwarding tables. So long
+as the table-builder leaves the forwarding tables in a valid state, one
+can suspend the table builder to avoid dropping packets as a result of
+control-plane activity.
+
+Process nodes can suspend for fixed amounts of time, or until another
+entity signals an event, or both. See the next section for a description
+of the vlib process event mechanism.
+
+When running in vlib process context, one must pay strict attention to
+loop invariant issues. If one walks a data structure and calls a
+function which may suspend, one had best know by construction that it
+cannot change. Often, it’s best to simply make a snapshot copy of a data
+structure, walk the copy at leisure, then free the copy.
+
+Process events
+--------------
+
+The vlib process event mechanism API is extremely lightweight and easy
+to use. Here is a typical example:
+
+.. code:: c
+
+       vlib_main_t *vm = &vlib_global_main;
+       uword event_type, * event_data = 0;
+
+       while (1)
+       {
+          vlib_process_wait_for_event_or_clock (vm, 5.0 /* seconds */);
+
+          event_type = vlib_process_get_events (vm, &event_data);
+
+          switch (event_type) {
+          case EVENT1:
+              handle_event1s (event_data);
+              break;
+
+          case EVENT2:
+              handle_event2s (event_data);
+              break;
+
+          case ~0: /* 5-second idle/periodic */
+              handle_idle ();
+              break;
+
+          default: /* bug! */
+              ASSERT (0);
+          }
+
+          vec_reset_length(event_data);
+       }
+
+In this example, the VLIB process node waits for an event to occur, or
+for 5 seconds to elapse. The code demuxes on the event type, calling the
+appropriate handler function. Each call to vlib_process_get_events
+returns a vector of per-event-type data passed to successive
+vlib_process_signal_event calls; it is a serious error to process only
+event_data[0].
+
+Resetting the event_data vector-length to 0 [instead of calling
+vec_free] means that the event scheme doesn’t burn cycles continuously
+allocating and freeing the event data vector. This is a common vppinfra
+/ vlib coding pattern, well worth using when appropriate.
+
+Signaling an event is easy, for example:
+
+.. code:: c
+
+       vlib_process_signal_event (vm, process_node_index, EVENT1,
+           (uword)arbitrary_event1_data); /* and so forth */
+
+One can either know the process node index by construction - dig it out
+of the appropriate vlib_node_registration_t - or by finding the
+vlib_node_t with vlib_get_node_by_name(…).
+
+Buffers
+-------
+
+vlib buffering solves the usual set of packet-processing problems,
+albeit at high performance. Key in terms of performance: one ordinarily
+allocates / frees N buffers at a time rather than one at a time. Except
+when operating directly on a specific buffer, one deals with buffers by
+index, not by pointer.
+
+Packet-processing frames are u32[] arrays, not vlib_buffer_t[] arrays.
+
+Packets comprise one or more vlib buffers, chained together as required.
+Multiple particle sizes are supported; hardware input nodes simply ask
+for the required size(s). Coalescing support is available. For obvious
+reasons one is discouraged from writing one’s own wild and wacky buffer
+chain traversal code.
+
+vlib buffer headers are allocated immediately prior to the buffer data
+area. In typical packet processing this saves a dependent read wait:
+given a buffer’s address, one can prefetch the buffer header [metadata]
+at the same time as the first cache line of buffer data.
+
+Buffer header metadata (vlib_buffer_t) includes the usual rewrite
+expansion space, a current_data offset, RX and TX interface indices,
+packet trace information, and a opaque areas.
+
+The opaque data is intended to control packet processing in arbitrary
+subgraph-dependent ways. The programmer shoulders responsibility for
+data lifetime analysis, type-checking, etc.
+
+Buffers have reference-counts in support of e.g. multicast replication.
+
+Shared-memory message API
+-------------------------
+
+Local control-plane and application processes interact with the vpp
+dataplane via asynchronous message-passing in shared memory over
+unidirectional queues. The same application APIs are available via
+sockets.
+
+Capturing API traces and replaying them in a simulation environment
+requires a disciplined approach to the problem. This seems like a
+make-work task, but it is not. When something goes wrong in the
+control-plane after 300,000 or 3,000,000 operations, high-speed replay
+of the events leading up to the accident is a huge win.
+
+The shared-memory message API message allocator vl_api_msg_alloc uses a
+particularly cute trick. Since messages are processed in order, we try
+to allocate message buffering from a set of fixed-size, preallocated
+rings. Each ring item has a “busy” bit. Freeing one of the preallocated
+message buffers merely requires the message consumer to clear the busy
+bit. No locking required.
+
+Debug CLI
+---------
+
+Adding debug CLI commands to VLIB applications is very simple.
+
+Here is a complete example:
+
+.. code:: c
+
+       static clib_error_t *
+       show_ip_tuple_match (vlib_main_t * vm,
+                            unformat_input_t * input,
+                            vlib_cli_command_t * cmd)
+       {
+           vlib_cli_output (vm, "%U\n", format_ip_tuple_match_tables, &routing_main);
+           return 0;
+       }
+
+       static VLIB_CLI_COMMAND (show_ip_tuple_command) =
+       {
+           .path = "show ip tuple match",
+           .short_help = "Show ip 5-tuple match-and-broadcast tables",
+           .function = show_ip_tuple_match,
+       };
+
+This example implements the “show ip tuple match” debug cli command. In
+ordinary usage, the vlib cli is available via the “vppctl” application,
+which sends traffic to a named pipe. One can configure debug CLI telnet
+access on a configurable port.
+
+The cli implementation has an output redirection facility which makes it
+simple to deliver cli output via shared-memory API messaging,
+
+Particularly for debug or “show tech support” type commands, it would be
+wasteful to write vlib application code to pack binary data, write more
+code elsewhere to unpack the data and finally print the answer. If a
+certain cli command has the potential to hurt packet processing
+performance by running for too long, do the work incrementally in a
+process node. The client can wait.
+
+Macro expansion
+~~~~~~~~~~~~~~~
+
+The vpp debug CLI engine includes a recursive macro expander. This is
+quite useful for factoring out address and/or interface name specifics:
+
+::
+
+      define ip1 192.168.1.1/24
+      define ip2 192.168.2.1/24
+      define iface1 GigabitEthernet3/0/0
+      define iface2 loop1
+
+      set int ip address $iface1 $ip1
+      set int ip address $iface2 $(ip2)
+
+      undefine ip1
+      undefine ip2
+      undefine iface1
+      undefine iface2
+
+Each socket (or telnet) debug CLI session has its own macro tables. All
+debug CLI sessions which use CLI_INBAND binary API messages share a
+single table.
+
+The macro expander recognizes circular definitions:
+
+::
+
+       define foo \$(bar)
+       define bar \$(mumble)
+       define mumble \$(foo)
+
+At 8 levels of recursion, the macro expander throws up its hands and
+replies “CIRCULAR.”
+
+Macro-related debug CLI commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In addition to the “define” and “undefine” debug CLI commands, use “show
+macro [noevaluate]” to dump the macro table. The “echo” debug CLI
+command will evaluate and print its argument:
+
+::
+
+       vpp# define foo This\ Is\ Foo
+       vpp# echo $foo
+       This Is Foo
+
+Handing off buffers between threads
+-----------------------------------
+
+Vlib includes an easy-to-use mechanism for handing off buffers between
+worker threads. A typical use-case: software ingress flow hashing. At a
+high level, one creates a per-worker-thread queue which sends packets to
+a specific graph node in the indicated worker thread. With the queue in
+hand, enqueue packets to the worker thread of your choice.
+
+Initialize a handoff queue
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Simple enough, call vlib_frame_queue_main_init:
+
+.. code:: c
+
+      main_ptr->frame_queue_index
+          = vlib_frame_queue_main_init (dest_node.index, frame_queue_size);
+
+Frame_queue_size means what it says: the number of frames which may be
+queued. Since frames contain 1…256 packets, frame_queue_size should be a
+reasonably small number (32…64). If the frame queue producer(s) are
+faster than the frame queue consumer(s), congestion will occur. Suggest
+letting the enqueue operator deal with queue congestion, as shown in the
+enqueue example below.
+
+Under the floorboards, vlib_frame_queue_main_init creates an input queue
+for each worker thread.
+
+Please do NOT create frame queues until it’s clear that they will be
+used. Although the main dispatch loop is reasonably smart about how
+often it polls the (entire set of) frame queues, polling unused frame
+queues is a waste of clock cycles.
+
+Hand off packets
+~~~~~~~~~~~~~~~~
+
+The actual handoff mechanics are simple, and integrate nicely with a
+typical graph-node dispatch function:
+
+.. code:: c
+
+       always_inline uword
+       do_handoff_inline (vlib_main_t * vm,
+                      vlib_node_runtime_t * node, vlib_frame_t * frame,
+                      int is_ip4, int is_trace)
+       {
+         u32 n_left_from, *from;
+         vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
+         u16 thread_indices [VLIB_FRAME_SIZE];
+         u16 nexts[VLIB_FRAME_SIZE], *next;
+         u32 n_enq;
+         htest_main_t *hmp = &htest_main;
+         int i;
+
+         from = vlib_frame_vector_args (frame);
+         n_left_from = frame->n_vectors;
+
+         vlib_get_buffers (vm, from, bufs, n_left_from);
+         next = nexts;
+         b = bufs;
+
+         /*
+          * Typical frame traversal loop, details vary with
+          * use case. Make sure to set thread_indices[i] with
+          * the desired destination thread index. You may
+          * or may not bother to set next[i].
+          */
+
+         for (i = 0; i < frame->n_vectors; i++)
+           {
+             
+             /* Pick a thread to handle this packet */
+             thread_indices[i] = f (packet_data_or_whatever);
+             
+
+             b += 1;
+             next += 1;
+             n_left_from -= 1;
+           }
+
+          /* Enqueue buffers to threads */
+          n_enq =
+           vlib_buffer_enqueue_to_thread (vm, node, hmp->frame_queue_index,
+                                          from, thread_indices, frame->n_vectors,
+                                          1 /* drop on congestion */);
+          /* Typical counters,
+         if (n_enq < frame->n_vectors)
+           vlib_node_increment_counter (vm, node->node_index,
+                        XXX_ERROR_CONGESTION_DROP,
+                        frame->n_vectors - n_enq);
+         vlib_node_increment_counter (vm, node->node_index,
+                            XXX_ERROR_HANDED_OFF, n_enq);
+         return frame->n_vectors;
+   }
+
+Notes about calling vlib_buffer_enqueue_to_thread(…):
+
+-  If you pass “drop on congestion” non-zero, all packets in the inbound
+   frame will be consumed one way or the other. This is the recommended
+   setting.
+
+-  In the drop-on-congestion case, please don’t try to “help” in the
+   enqueue node by freeing dropped packets, or by pushing them to
+   “error-drop.” Either of those actions would be a severe error.
+
+-  It’s perfectly OK to enqueue packets to the current thread.
+
+Handoff Demo Plugin
+-------------------
+
+Check out the sample (plugin) example in …/src/examples/handoffdemo. If
+you want to build the handoff demo plugin:
+
+::
+
+   $ cd .../src/plugins
+   $ ln -s ../examples/handoffdemo
+
+This plugin provides a simple example of how to hand off packets between
+threads. We used it to debug packet-tracer handoff tracing support.
+
+Packet generator input script
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+    packet-generator new {
+       name x
+       limit 5
+       size 128-128
+       interface local0
+       node handoffdemo-1
+       data {
+           incrementing 30
+       }
+    }
+
+Start vpp with 2 worker threads
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The demo plugin hands packets from worker 1 to worker 2.
+
+Enable tracing, and start the packet generator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+     trace add pg-input 100
+     packet-generator enable
+
+Sample Run
+~~~~~~~~~~
+
+::
+
+     DBGvpp# ex /tmp/pg_input_script
+     DBGvpp# pa en
+     DBGvpp# sh err
+      Count                    Node                  Reason
+            5              handoffdemo-1             packets handed off processed
+            5              handoffdemo-2             completed packets
+     DBGvpp# show run
+     Thread 1 vpp_wk_0 (lcore 0)
+     Time 133.9, average vectors/node 5.00, last 128 main loops 0.00 per node 0.00
+       vector rates in 3.7331e-2, out 0.0000e0, drop 0.0000e0, punt 0.0000e0
+                  Name                 State         Calls          Vectors        Suspends         Clocks       Vectors/Call
+     handoffdemo-1                    active                  1               5               0          4.76e3            5.00
+     pg-input                        disabled                 2               5               0          5.58e4            2.50
+     unix-epoll-input                 polling             22760               0               0          2.14e7            0.00
+     ---------------
+     Thread 2 vpp_wk_1 (lcore 2)
+     Time 133.9, average vectors/node 5.00, last 128 main loops 0.00 per node 0.00
+       vector rates in 0.0000e0, out 0.0000e0, drop 3.7331e-2, punt 0.0000e0
+                  Name                 State         Calls          Vectors        Suspends         Clocks       Vectors/Call
+     drop                             active                  1               5               0          1.35e4            5.00
+     error-drop                       active                  1               5               0          2.52e4            5.00
+     handoffdemo-2                    active                  1               5               0          2.56e4            5.00
+     unix-epoll-input                 polling             22406               0               0          2.18e7            0.00
+
+Enable the packet tracer and run it again…
+
+::
+
+     DBGvpp# trace add pg-input 100
+     DBGvpp# pa en
+     DBGvpp# sh trace
+     sh trace
+     ------------------- Start of thread 0 vpp_main -------------------
+     No packets in trace buffer
+     ------------------- Start of thread 1 vpp_wk_0 -------------------
+     Packet 1
+
+     00:06:50:520688: pg-input
+       stream x, 128 bytes, 0 sw_if_index
+       current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000000
+       00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
+       00000020: 0000000000000000000000000000000000000000000000000000000000000000
+       00000040: 0000000000000000000000000000000000000000000000000000000000000000
+       00000060: 0000000000000000000000000000000000000000000000000000000000000000
+     00:06:50:520762: handoffdemo-1
+       HANDOFFDEMO: current thread 1
+
+     Packet 2
+
+     00:06:50:520688: pg-input
+       stream x, 128 bytes, 0 sw_if_index
+       current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000001
+       00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
+       00000020: 0000000000000000000000000000000000000000000000000000000000000000
+       00000040: 0000000000000000000000000000000000000000000000000000000000000000
+       00000060: 0000000000000000000000000000000000000000000000000000000000000000
+     00:06:50:520762: handoffdemo-1
+       HANDOFFDEMO: current thread 1
+
+     Packet 3
+
+     00:06:50:520688: pg-input
+       stream x, 128 bytes, 0 sw_if_index
+       current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000002
+       00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
+       00000020: 0000000000000000000000000000000000000000000000000000000000000000
+       00000040: 0000000000000000000000000000000000000000000000000000000000000000
+       00000060: 0000000000000000000000000000000000000000000000000000000000000000
+     00:06:50:520762: handoffdemo-1
+       HANDOFFDEMO: current thread 1
+
+     Packet 4
+
+     00:06:50:520688: pg-input
+       stream x, 128 bytes, 0 sw_if_index
+       current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000003
+       00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
+       00000020: 0000000000000000000000000000000000000000000000000000000000000000
+       00000040: 0000000000000000000000000000000000000000000000000000000000000000
+       00000060: 0000000000000000000000000000000000000000000000000000000000000000
+     00:06:50:520762: handoffdemo-1
+       HANDOFFDEMO: current thread 1
+
+     Packet 5
+
+     00:06:50:520688: pg-input
+       stream x, 128 bytes, 0 sw_if_index
+       current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000004
+       00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
+       00000020: 0000000000000000000000000000000000000000000000000000000000000000
+       00000040: 0000000000000000000000000000000000000000000000000000000000000000
+       00000060: 0000000000000000000000000000000000000000000000000000000000000000
+     00:06:50:520762: handoffdemo-1
+       HANDOFFDEMO: current thread 1
+
+     ------------------- Start of thread 2 vpp_wk_1 -------------------
+     Packet 1
+
+     00:06:50:520796: handoff_trace
+       HANDED-OFF: from thread 1 trace index 0
+     00:06:50:520796: handoffdemo-2
+       HANDOFFDEMO: current thread 2
+     00:06:50:520867: error-drop
+       rx:local0
+     00:06:50:520914: drop
+       handoffdemo-2: completed packets
+
+     Packet 2
+
+     00:06:50:520796: handoff_trace
+       HANDED-OFF: from thread 1 trace index 1
+     00:06:50:520796: handoffdemo-2
+       HANDOFFDEMO: current thread 2
+     00:06:50:520867: error-drop
+       rx:local0
+     00:06:50:520914: drop
+       handoffdemo-2: completed packets
+
+     Packet 3
+
+     00:06:50:520796: handoff_trace
+       HANDED-OFF: from thread 1 trace index 2
+     00:06:50:520796: handoffdemo-2
+       HANDOFFDEMO: current thread 2
+     00:06:50:520867: error-drop
+       rx:local0
+     00:06:50:520914: drop
+       handoffdemo-2: completed packets
+
+     Packet 4
+
+     00:06:50:520796: handoff_trace
+       HANDED-OFF: from thread 1 trace index 3
+     00:06:50:520796: handoffdemo-2
+       HANDOFFDEMO: current thread 2
+     00:06:50:520867: error-drop
+       rx:local0
+     00:06:50:520914: drop
+       handoffdemo-2: completed packets
+
+     Packet 5
+
+     00:06:50:520796: handoff_trace
+       HANDED-OFF: from thread 1 trace index 4
+     00:06:50:520796: handoffdemo-2
+       HANDOFFDEMO: current thread 2
+     00:06:50:520867: error-drop
+       rx:local0
+     00:06:50:520914: drop
+       handoffdemo-2: completed packets
+    DBGvpp#
diff --git a/docs/developer/corearchitecture/vnet.rst b/docs/developer/corearchitecture/vnet.rst
new file mode 100644
index 00000000000..812e2fb4f8a
--- /dev/null
+++ b/docs/developer/corearchitecture/vnet.rst
@@ -0,0 +1,807 @@
+VNET (VPP Network Stack)
+========================
+
+The files associated with the VPP network stack layer are located in the
+*./src/vnet* folder. The Network Stack Layer is basically an
+instantiation of the code in the other layers. This layer has a vnet
+library that provides vectorized layer-2 and 3 networking graph nodes, a
+packet generator, and a packet tracer.
+
+In terms of building a packet processing application, vnet provides a
+platform-independent subgraph to which one connects a couple of
+device-driver nodes.
+
+Typical RX connections include “ethernet-input” [full software
+classification, feeds ipv4-input, ipv6-input, arp-input etc.] and
+“ipv4-input-no-checksum” [if hardware can classify, perform ipv4 header
+checksum].
+
+Effective graph dispatch function coding
+----------------------------------------
+
+Over the 15 years, multiple coding styles have emerged: a
+single/dual/quad loop coding model (with variations) and a
+fully-pipelined coding model.
+
+Single/dual loops
+-----------------
+
+The single/dual/quad loop model variations conveniently solve problems
+where the number of items to process is not known in advance: typical
+hardware RX-ring processing. This coding style is also very effective
+when a given node will not need to cover a complex set of dependent
+reads.
+
+Here is an quad/single loop which can leverage up-to-avx512 SIMD vector
+units to convert buffer indices to buffer pointers:
+
+.. code:: c
+
+      static uword
+      simulated_ethernet_interface_tx (vlib_main_t * vm,
+                    vlib_node_runtime_t *
+                    node, vlib_frame_t * frame)
+      {
+        u32 n_left_from, *from;
+        u32 next_index = 0;
+        u32 n_bytes;
+        u32 thread_index = vm->thread_index;
+        vnet_main_t *vnm = vnet_get_main ();
+        vnet_interface_main_t *im = &vnm->interface_main;
+        vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
+        u16 nexts[VLIB_FRAME_SIZE], *next;
+
+        n_left_from = frame->n_vectors;
+        from = vlib_frame_vector_args (frame);
+
+        /*
+         * Convert up to VLIB_FRAME_SIZE indices in "from" to
+         * buffer pointers in bufs[]
+         */
+        vlib_get_buffers (vm, from, bufs, n_left_from);
+        b = bufs;
+        next = nexts;
+
+        /*
+         * While we have at least 4 vector elements (pkts) to process..
+         */
+        while (n_left_from >= 4)
+          {
+            /* Prefetch next quad-loop iteration. */
+            if (PREDICT_TRUE (n_left_from >= 8))
+          {
+            vlib_prefetch_buffer_header (b[4], STORE);
+            vlib_prefetch_buffer_header (b[5], STORE);
+            vlib_prefetch_buffer_header (b[6], STORE);
+            vlib_prefetch_buffer_header (b[7], STORE);
+              }
+
+            /*
+             * $$$ Process 4x packets right here...
+             * set next[0..3] to send the packets where they need to go
+             */
+
+             do_something_to (b[0]);
+             do_something_to (b[1]);
+             do_something_to (b[2]);
+             do_something_to (b[3]);
+
+            /* Process the next 0..4 packets */
+        b += 4;
+        next += 4;
+        n_left_from -= 4;
+       }
+        /*
+         * Clean up 0...3 remaining packets at the end of the incoming frame
+         */
+        while (n_left_from > 0)
+          {
+            /*
+             * $$$ Process one packet right here...
+             * set next[0..3] to send the packets where they need to go
+             */
+             do_something_to (b[0]);
+
+            /* Process the next packet */
+            b += 1;
+            next += 1;
+            n_left_from -= 1;
+          }
+
+        /*
+         * Send the packets along their respective next-node graph arcs
+         * Considerable locality of reference is expected, most if not all
+         * packets in the inbound vector will traverse the same next-node
+         * arc
+         */
+        vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
+
+        return frame->n_vectors;
+      }
+
+Given a packet processing task to implement, it pays to scout around
+looking for similar tasks, and think about using the same coding
+pattern. It is not uncommon to recode a given graph node dispatch
+function several times during performance optimization.
+
+Creating Packets from Scratch
+-----------------------------
+
+At times, it’s necessary to create packets from scratch and send them.
+Tasks like sending keepalives or actively opening connections come to
+mind. Its not difficult, but accurate buffer metadata setup is required.
+
+Allocating Buffers
+~~~~~~~~~~~~~~~~~~
+
+Use vlib_buffer_alloc, which allocates a set of buffer indices. For
+low-performance applications, it’s OK to allocate one buffer at a time.
+Note that vlib_buffer_alloc(…) does NOT initialize buffer metadata. See
+below.
+
+In high-performance cases, allocate a vector of buffer indices, and hand
+them out from the end of the vector; decrement \_vec_len(..) as buffer
+indices are allocated. See tcp_alloc_tx_buffers(…) and
+tcp_get_free_buffer_index(…) for an example.
+
+Buffer Initialization Example
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example shows the **main points**, but is not to be
+blindly cut-’n-pasted.
+
+.. code:: c
+
+     u32 bi0;
+     vlib_buffer_t *b0;
+     ip4_header_t *ip;
+     udp_header_t *udp;
+
+     /* Allocate a buffer */
+     if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
+       return -1;
+
+     b0 = vlib_get_buffer (vm, bi0);
+
+     /* At this point b0->current_data = 0, b0->current_length = 0 */
+
+     /*
+      * Copy data into the buffer. This example ASSUMES that data will fit
+      * in a single buffer, and is e.g. an ip4 packet.
+      */
+     if (have_packet_rewrite)
+        {
+          clib_memcpy (b0->data, data, vec_len (data));
+          b0->current_length = vec_len (data);
+        }
+     else
+        {
+          /* OR, build a udp-ip packet (for example) */
+          ip = vlib_buffer_get_current (b0);
+          udp = (udp_header_t *) (ip + 1);
+          data_dst = (u8 *) (udp + 1);
+
+          ip->ip_version_and_header_length = 0x45;
+          ip->ttl = 254;
+          ip->protocol = IP_PROTOCOL_UDP;
+          ip->length = clib_host_to_net_u16 (sizeof (*ip) + sizeof (*udp) +
+                     vec_len(udp_data));
+          ip->src_address.as_u32 = src_address->as_u32;
+          ip->dst_address.as_u32 = dst_address->as_u32;
+          udp->src_port = clib_host_to_net_u16 (src_port);
+          udp->dst_port = clib_host_to_net_u16 (dst_port);
+          udp->length = clib_host_to_net_u16 (vec_len (udp_data));
+          clib_memcpy (data_dst, udp_data, vec_len(udp_data));
+
+          if (compute_udp_checksum)
+            {
+              /* RFC 7011 section 10.3.2. */
+              udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
+              if (udp->checksum == 0)
+                udp->checksum = 0xffff;
+         }
+         b0->current_length = vec_len (sizeof (*ip) + sizeof (*udp) +
+                                      vec_len (udp_data));
+
+       }
+     b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
+
+     /* sw_if_index 0 is the "local" interface, which always exists */
+     vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
+
+     /* Use the default FIB index for tx lookup. Set non-zero to use another fib */
+     vnet_buffer (b0)->sw_if_index[VLIB_TX] = 0;
+
+If your use-case calls for large packet transmission, use
+vlib_buffer_chain_append_data_with_alloc(…) to create the requisite
+buffer chain.
+
+Enqueueing packets for lookup and transmission
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The simplest way to send a set of packets is to use
+vlib_get_frame_to_node(…) to allocate fresh frame(s) to ip4_lookup_node
+or ip6_lookup_node, add the constructed buffer indices, and dispatch the
+frame using vlib_put_frame_to_node(…).
+
+.. code:: c
+
+       vlib_frame_t *f;
+       f = vlib_get_frame_to_node (vm, ip4_lookup_node.index);
+       f->n_vectors = vec_len(buffer_indices_to_send);
+       to_next = vlib_frame_vector_args (f);
+
+       for (i = 0; i < vec_len (buffer_indices_to_send); i++)
+         to_next[i] = buffer_indices_to_send[i];
+
+       vlib_put_frame_to_node (vm, ip4_lookup_node_index, f);
+
+It is inefficient to allocate and schedule single packet frames. That’s
+typical in case you need to send one packet per second, but should
+**not** occur in a for-loop!
+
+Packet tracer
+-------------
+
+Vlib includes a frame element [packet] trace facility, with a simple
+debug CLI interface. The cli is straightforward: “trace add
+input-node-name count” to start capturing packet traces.
+
+To trace 100 packets on a typical x86_64 system running the dpdk plugin:
+“trace add dpdk-input 100”. When using the packet generator: “trace add
+pg-input 100”
+
+To display the packet trace: “show trace”
+
+Each graph node has the opportunity to capture its own trace data. It is
+almost always a good idea to do so. The trace capture APIs are simple.
+
+The packet capture APIs snapshoot binary data, to minimize processing at
+capture time. Each participating graph node initialization provides a
+vppinfra format-style user function to pretty-print data when required
+by the VLIB “show trace” command.
+
+Set the VLIB node registration “.format_trace” member to the name of the
+per-graph node format function.
+
+Here’s a simple example:
+
+.. code:: c
+
+       u8 * my_node_format_trace (u8 * s, va_list * args)
+       {
+           vlib_main_t * vm = va_arg (*args, vlib_main_t *);
+           vlib_node_t * node = va_arg (*args, vlib_node_t *);
+           my_node_trace_t * t = va_arg (*args, my_trace_t *);
+
+           s = format (s, "My trace data was: %d", t->);
+
+           return s;
+       }
+
+The trace framework hands the per-node format function the data it
+captured as the packet whizzed by. The format function pretty-prints the
+data as desired.
+
+Graph Dispatcher Pcap Tracing
+-----------------------------
+
+The vpp graph dispatcher knows how to capture vectors of packets in pcap
+format as they’re dispatched. The pcap captures are as follows:
+
+::
+
+       VPP graph dispatch trace record description:
+
+           0                   1                   2                   3
+           0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          | Major Version | Minor Version | NStrings      | ProtoHint     |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          | Buffer index (big endian)                                     |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          + VPP graph node name ...     ...               | NULL octet    |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          | Buffer Metadata ... ...                       | NULL octet    |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          | Buffer Opaque ... ...                         | NULL octet    |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          | Buffer Opaque 2 ... ...                       | NULL octet    |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          | VPP ASCII packet trace (if NStrings > 4)      | NULL octet    |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+          | Packet data (up to 16K)                                       |
+          +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+Graph dispatch records comprise a version stamp, an indication of how
+many NULL-terminated strings will follow the record header and preceed
+packet data, and a protocol hint.
+
+The buffer index is an opaque 32-bit cookie which allows consumers of
+these data to easily filter/track single packets as they traverse the
+forwarding graph.
+
+Multiple records per packet are normal, and to be expected. Packets will
+appear multiple times as they traverse the vpp forwarding graph. In this
+way, vpp graph dispatch traces are significantly different from regular
+network packet captures from an end-station. This property complicates
+stateful packet analysis.
+
+Restricting stateful analysis to records from a single vpp graph node
+such as “ethernet-input” seems likely to improve the situation.
+
+As of this writing: major version = 1, minor version = 0. Nstrings
+SHOULD be 4 or 5. Consumers SHOULD be wary values less than 4 or greater
+than 5. They MAY attempt to display the claimed number of strings, or
+they MAY treat the condition as an error.
+
+Here is the current set of protocol hints:
+
+.. code:: c
+
+       typedef enum
+         {
+           VLIB_NODE_PROTO_HINT_NONE = 0,
+           VLIB_NODE_PROTO_HINT_ETHERNET,
+           VLIB_NODE_PROTO_HINT_IP4,
+           VLIB_NODE_PROTO_HINT_IP6,
+           VLIB_NODE_PROTO_HINT_TCP,
+           VLIB_NODE_PROTO_HINT_UDP,
+           VLIB_NODE_N_PROTO_HINTS,
+         } vlib_node_proto_hint_t;
+
+Example: VLIB_NODE_PROTO_HINT_IP6 means that the first octet of packet
+data SHOULD be 0x60, and should begin an ipv6 packet header.
+
+Downstream consumers of these data SHOULD pay attention to the protocol
+hint. They MUST tolerate inaccurate hints, which MAY occur from time to
+time.
+
+Dispatch Pcap Trace Debug CLI
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To start a dispatch trace capture of up to 10,000 trace records:
+
+::
+
+        pcap dispatch trace on max 10000 file dispatch.pcap
+
+To start a dispatch trace which will also include standard vpp packet
+tracing for packets which originate in dpdk-input:
+
+::
+
+        pcap dispatch trace on max 10000 file dispatch.pcap buffer-trace dpdk-input 1000
+
+To save the pcap trace, e.g. in /tmp/dispatch.pcap:
+
+::
+
+       pcap dispatch trace off
+
+Wireshark dissection of dispatch pcap traces
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+It almost goes without saying that we built a companion wireshark
+dissector to display these traces. As of this writing, we have
+upstreamed the wireshark dissector.
+
+Since it will be a while before wireshark/master/latest makes it into
+all of the popular Linux distros, please see the “How to build a vpp
+dispatch trace aware Wireshark” page for build info.
+
+Here is a sample packet dissection, with some fields omitted for
+clarity. The point is that the wireshark dissector accurately displays
+**all** of the vpp buffer metadata, and the name of the graph node in
+question.
+
+::
+
+       Frame 1: 2216 bytes on wire (17728 bits), 2216 bytes captured (17728 bits)
+           Encapsulation type: USER 13 (58)
+           [Protocols in frame: vpp:vpp-metadata:vpp-opaque:vpp-opaque2:eth:ethertype:ip:tcp:data]
+       VPP Dispatch Trace
+           BufferIndex: 0x00036663
+       NodeName: ethernet-input
+       VPP Buffer Metadata
+           Metadata: flags:
+           Metadata: current_data: 0, current_length: 102
+           Metadata: current_config_index: 0, flow_id: 0, next_buffer: 0
+           Metadata: error: 0, n_add_refs: 0, buffer_pool_index: 0
+           Metadata: trace_index: 0, recycle_count: 0, len_not_first_buf: 0
+           Metadata: free_list_index: 0
+           Metadata:
+       VPP Buffer Opaque
+           Opaque: raw: 00000007 ffffffff 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
+           Opaque: sw_if_index[VLIB_RX]: 7, sw_if_index[VLIB_TX]: -1
+           Opaque: L2 offset 0, L3 offset 0, L4 offset 0, feature arc index 0
+           Opaque: ip.adj_index[VLIB_RX]: 0, ip.adj_index[VLIB_TX]: 0
+           Opaque: ip.flow_hash: 0x0, ip.save_protocol: 0x0, ip.fib_index: 0
+           Opaque: ip.save_rewrite_length: 0, ip.rpf_id: 0
+           Opaque: ip.icmp.type: 0 ip.icmp.code: 0, ip.icmp.data: 0x0
+           Opaque: ip.reass.next_index: 0, ip.reass.estimated_mtu: 0
+           Opaque: ip.reass.fragment_first: 0 ip.reass.fragment_last: 0
+           Opaque: ip.reass.range_first: 0 ip.reass.range_last: 0
+           Opaque: ip.reass.next_range_bi: 0x0, ip.reass.ip6_frag_hdr_offset: 0
+           Opaque: mpls.ttl: 0, mpls.exp: 0, mpls.first: 0, mpls.save_rewrite_length: 0, mpls.bier.n_bytes: 0
+           Opaque: l2.feature_bitmap: 00000000, l2.bd_index: 0, l2.l2_len: 0, l2.shg: 0, l2.l2fib_sn: 0, l2.bd_age: 0
+           Opaque: l2.feature_bitmap_input:   none configured, L2.feature_bitmap_output:   none configured
+           Opaque: l2t.next_index: 0, l2t.session_index: 0
+           Opaque: l2_classify.table_index: 0, l2_classify.opaque_index: 0, l2_classify.hash: 0x0
+           Opaque: policer.index: 0
+           Opaque: ipsec.flags: 0x0, ipsec.sad_index: 0
+           Opaque: map.mtu: 0
+           Opaque: map_t.v6.saddr: 0x0, map_t.v6.daddr: 0x0, map_t.v6.frag_offset: 0, map_t.v6.l4_offset: 0
+           Opaque: map_t.v6.l4_protocol: 0, map_t.checksum_offset: 0, map_t.mtu: 0
+           Opaque: ip_frag.mtu: 0, ip_frag.next_index: 0, ip_frag.flags: 0x0
+           Opaque: cop.current_config_index: 0
+           Opaque: lisp.overlay_afi: 0
+           Opaque: tcp.connection_index: 0, tcp.seq_number: 0, tcp.seq_end: 0, tcp.ack_number: 0, tcp.hdr_offset: 0, tcp.data_offset: 0
+           Opaque: tcp.data_len: 0, tcp.flags: 0x0
+           Opaque: sctp.connection_index: 0, sctp.sid: 0, sctp.ssn: 0, sctp.tsn: 0, sctp.hdr_offset: 0
+           Opaque: sctp.data_offset: 0, sctp.data_len: 0, sctp.subconn_idx: 0, sctp.flags: 0x0
+           Opaque: snat.flags: 0x0
+           Opaque:
+       VPP Buffer Opaque2
+           Opaque2: raw: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
+           Opaque2: qos.bits: 0, qos.source: 0
+           Opaque2: loop_counter: 0
+           Opaque2: gbp.flags: 0, gbp.src_epg: 0
+           Opaque2: pg_replay_timestamp: 0
+           Opaque2:
+       Ethernet II, Src: 06:d6:01:41:3b:92 (06:d6:01:41:3b:92), Dst: IntelCor_3d:f6    Transmission Control Protocol, Src Port: 22432, Dst Port: 54084, Seq: 1, Ack: 1, Len: 36
+           Source Port: 22432
+           Destination Port: 54084
+           TCP payload (36 bytes)
+       Data (36 bytes)
+
+       0000  cf aa 8b f5 53 14 d4 c7 29 75 3e 56 63 93 9d 11   ....S...)u>Vc...
+       0010  e5 f2 92 27 86 56 4c 21 ce c5 23 46 d7 eb ec 0d   ...'.VL!..#F....
+       0020  a8 98 36 5a                                       ..6Z
+           Data: cfaa8bf55314d4c729753e5663939d11e5f2922786564c21…
+           [Length: 36]
+
+It’s a matter of a couple of mouse-clicks in Wireshark to filter the
+trace to a specific buffer index. With that specific kind of filtration,
+one can watch a packet walk through the forwarding graph; noting any/all
+metadata changes, header checksum changes, and so forth.
+
+This should be of significant value when developing new vpp graph nodes.
+If new code mispositions b->current_data, it will be completely obvious
+from looking at the dispatch trace in wireshark.
+
+pcap rx, tx, and drop tracing
+-----------------------------
+
+vpp also supports rx, tx, and drop packet capture in pcap format,
+through the “pcap trace” debug CLI command.
+
+This command is used to start or stop a packet capture, or show the
+status of packet capture. Each of “pcap trace rx”, “pcap trace tx”, and
+“pcap trace drop” is implemented. Supply one or more of “rx”, “tx”, and
+“drop” to enable multiple simultaneous capture types.
+
+These commands have the following optional parameters:
+
+-  rx - trace received packets.
+
+-  tx - trace transmitted packets.
+
+-  drop - trace dropped packets.
+
+-  max *nnnn*\  - file size, number of packet captures. Once packets
+   have been received, the trace buffer buffer is flushed to the
+   indicated file. Defaults to 1000. Can only be updated if packet
+   capture is off.
+
+-  max-bytes-per-pkt *nnnn*\  - maximum number of bytes to trace on a
+   per-packet basis. Must be >32 and less than 9000. Default value:
+
+   512.
+
+-  filter - Use the pcap rx / tx / drop trace filter, which must be
+   configured. Use classify filter pcap… to configure the filter. The
+   filter will only be executed if the per-interface or any-interface
+   tests fail.
+
+-  intfc *interface* \| *any*\  - Used to specify a given interface, or
+   use ‘any’ to run packet capture on all interfaces. ‘any’ is the
+   default if not provided. Settings from a previous packet capture are
+   preserved, so ‘any’ can be used to reset the interface setting.
+
+-  file *filename*\  - Used to specify the output filename. The file
+   will be placed in the ‘/tmp’ directory. If *filename* already exists,
+   file will be overwritten. If no filename is provided, ‘/tmp/rx.pcap
+   or tx.pcap’ will be used, depending on capture direction. Can only be
+   updated when pcap capture is off.
+
+-  status - Displays the current status and configured attributes
+   associated with a packet capture. If packet capture is in progress,
+   ‘status’ also will return the number of packets currently in the
+   buffer. Any additional attributes entered on command line with a
+   ‘status’ request will be ignored.
+
+-  filter - Capture packets which match the current packet trace filter
+   set. See next section. Configure the capture filter first.
+
+packet trace capture filtering
+------------------------------
+
+The “classify filter pcap \| \| trace” debug CLI command constructs an
+arbitrary set of packet classifier tables for use with “pcap rx \| tx \|
+drop trace,” and with the vpp packet tracer on a per-interface or
+system-wide basis.
+
+Packets which match a rule in the classifier table chain will be traced.
+The tables are automatically ordered so that matches in the most
+specific table are tried first.
+
+It’s reasonably likely that folks will configure a single table with one
+or two matches. As a result, we configure 8 hash buckets and 128K of
+match rule space by default. One can override the defaults by specifying
+“buckets ” and “memory-size ” as desired.
+
+To build up complex filter chains, repeatedly issue the classify filter
+debug CLI command. Each command must specify the desired mask and match
+values. If a classifier table with a suitable mask already exists, the
+CLI command adds a match rule to the existing table. If not, the CLI
+command add a new table and the indicated mask rule
+
+Configure a simple pcap classify filter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       classify filter pcap mask l3 ip4 src match l3 ip4 src 192.168.1.11
+       pcap trace rx max 100 filter
+
+Configure a simple per-interface capture filter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       classify filter GigabitEthernet3/0/0 mask l3 ip4 src match l3 ip4 src 192.168.1.11"
+       pcap trace rx max 100 intfc GigabitEthernet3/0/0
+
+Note that per-interface capture filters are *always* applied.
+
+Clear per-interface capture filters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       classify filter GigabitEthernet3/0/0 del
+
+Configure another fairly simple pcap classify filter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      classify filter pcap mask l3 ip4 src dst match l3 ip4 src 192.168.1.10 dst 192.168.2.10
+      pcap trace tx max 100 filter
+
+Configure a vpp packet tracer filter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      classify filter trace mask l3 ip4 src dst match l3 ip4 src 192.168.1.10 dst 192.168.2.10
+      trace add dpdk-input 100 filter
+
+Clear all current classifier filters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       classify filter [pcap |  | trace] del
+
+To inspect the classifier tables
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      show classify table [verbose]
+
+The verbose form displays all of the match rules, with hit-counters.
+
+Terse description of the “mask ” syntax:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+       l2 src dst proto tag1 tag2 ignore-tag1 ignore-tag2 cos1 cos2 dot1q dot1ad
+       l3 ip4  ip6 
+        version hdr_length src[/width] dst[/width]
+                  tos length fragment_id ttl protocol checksum
+        version traffic-class flow-label src dst proto
+                  payload_length hop_limit protocol
+       l4 tcp  udp  src_port dst_port
+        src dst  # ports
+        src_port dst_port
+
+To construct **matches**, add the values to match after the indicated
+keywords in the mask syntax. For example: “… mask l3 ip4 src” -> “…
+match l3 ip4 src 192.168.1.11”
+
+VPP Packet Generator
+--------------------
+
+We use the VPP packet generator to inject packets into the forwarding
+graph. The packet generator can replay pcap traces, and generate packets
+out of whole cloth at respectably high performance.
+
+The VPP pg enables quite a variety of use-cases, ranging from functional
+testing of new data-plane nodes to regression testing to performance
+tuning.
+
+PG setup scripts
+----------------
+
+PG setup scripts describe traffic in detail, and leverage vpp debug CLI
+mechanisms. It’s reasonably unusual to construct a pg setup script which
+doesn’t include a certain amount of interface and FIB configuration.
+
+For example:
+
+::
+
+       loop create
+       set int ip address loop0 192.168.1.1/24
+       set int state loop0 up
+
+       packet-generator new {
+           name pg0
+           limit 100
+           rate 1e6
+           size 300-300
+           interface loop0
+           node ethernet-input
+           data { IP4: 1.2.3 -> 4.5.6
+                  UDP: 192.168.1.10 - 192.168.1.254 -> 192.168.2.10
+                  UDP: 1234 -> 2345
+                  incrementing 286
+           }
+       }
+
+A packet generator stream definition includes two major sections: -
+Stream Parameter Setup - Packet Data
+
+Stream Parameter Setup
+~~~~~~~~~~~~~~~~~~~~~~
+
+Given the example above, let’s look at how to set up stream parameters:
+
+-  **name pg0** - Name of the stream, in this case “pg0”
+
+-  **limit 1000** - Number of packets to send when the stream is
+   enabled. “limit 0” means send packets continuously.
+
+-  **maxframe ** - Maximum frame size. Handy for injecting multiple
+   frames no larger than . Useful for checking dual / quad loop
+   codes
+
+-  **rate 1e6** - Packet injection rate, in this case 1 MPPS. When not
+   specified, the packet generator injects packets as fast as possible
+
+-  **size 300-300** - Packet size range, in this case send 300-byte
+   packets
+
+-  **interface loop0** - Packets appear as if they were received on the
+   specified interface. This datum is used in multiple ways: to select
+   graph arc feature configuration, to select IP FIBs. Configure
+   features e.g. on loop0 to exercise those features.
+
+-  **tx-interface ** - Packets will be transmitted on the
+   indicated interface. Typically required only when injecting packets
+   into post-IP-rewrite graph nodes.
+
+-  **pcap ** - Replay packets from the indicated pcap capture
+   file. “make test” makes extensive use of this feature: generate
+   packets using scapy, save them in a .pcap file, then inject them into
+   the vpp graph via a vpp pg “pcap ” stream definition
+
+-  **worker ** - Generate packets for the stream using the indicated
+   vpp worker thread. The vpp pg generates and injects O(10 MPPS /
+   core). Use multiple stream definitions and worker threads to generate
+   and inject enough traffic to easily fill a 40 gbit pipe with small
+   packets.
+
+Data definition
+~~~~~~~~~~~~~~~
+
+Packet generator data definitions make use of a layered implementation
+strategy. Networking layers are specified in order, and the notation can
+seem a bit counter-intuitive. In the example above, the data definition
+stanza constructs a set of L2-L4 headers layers, and uses an
+incrementing fill pattern to round out the requested 300-byte packets.
+
+-  **IP4: 1.2.3 -> 4.5.6** - Construct an L2 (MAC) header with the ip4
+   ethertype (0x800), src MAC address of 00:01:00:02:00:03 and dst MAC
+   address of 00:04:00:05:00:06. Mac addresses may be specified in
+   either *xxxx.xxxx.xxxx* format or *xx:xx:xx:xx:xx:xx* format.
+
+-  **UDP: 192.168.1.10 - 192.168.1.254 -> 192.168.2.10** - Construct an
+   incrementing set of L3 (IPv4) headers for successive packets with
+   source addresses ranging from .10 to .254. All packets in the stream
+   have a constant dest address of 192.168.2.10. Set the protocol field
+   to 17, UDP.
+
+-  **UDP: 1234 -> 2345** - Set the UDP source and destination ports to
+   1234 and 2345, respectively
+
+-  **incrementing 256** - Insert up to 256 incrementing data bytes.
+
+Obvious variations involve “s/IP4/IP6/” in the above, along with
+changing from IPv4 to IPv6 address notation.
+
+The vpp pg can set any / all IPv4 header fields, including tos, packet
+length, mf / df / fragment id and offset, ttl, protocol, checksum, and
+src/dst addresses. Take a look at ../src/vnet/ip/ip[46]_pg.c for
+details.
+
+If all else fails, specify the entire packet data in hex:
+
+-  **hex 0xabcd…** - copy hex data verbatim into the packet
+
+When replaying pcap files (“**pcap **”), do not specify a data
+stanza.
+
+Diagnosing “packet-generator new” parse failures
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to inject packets into a brand-new graph node, remember to
+tell the packet generator debug CLI how to parse the packet data stanza.
+
+If the node expects L2 Ethernet MAC headers, specify “.unformat_buffer =
+unformat_ethernet_header”:
+
+.. code:: c
+
+       VLIB_REGISTER_NODE (ethernet_input_node) =
+       {
+         
+         .unformat_buffer = unformat_ethernet_header,
+         
+       };
+
+Beyond that, it may be necessary to set breakpoints in
+…/src/vnet/pg/cli.c. Debug image suggested.
+
+When debugging new nodes, it may be far simpler to directly inject
+ethernet frames - and add a corresponding vlib_buffer_advance in the new
+node - than to modify the packet generator.
+
+Debug CLI
+---------
+
+The descriptions above describe the “packet-generator new” debug CLI in
+detail.
+
+Additional debug CLI commands include:
+
+::
+
+       vpp# packet-generator enable []
+
+which enables the named stream, or all streams.
+
+::
+
+       vpp# packet-generator disable []
+
+disables the named stream, or all streams.
+
+::
+
+       vpp# packet-generator delete 
+
+Deletes the named stream.
+
+::
+
+       vpp# packet-generator configure  [limit ]
+            [rate ] [size -]
+
+Changes stream parameters without having to recreate the entire stream
+definition. Note that re-issuing a “packet-generator new” command will
+correctly recreate the named stream.
diff --git a/docs/developer/corefeatures/bfd_doc.rst b/docs/developer/corefeatures/bfd_doc.rst
new file mode 120000
index 00000000000..6e9fdd5e508
--- /dev/null
+++ b/docs/developer/corefeatures/bfd_doc.rst
@@ -0,0 +1 @@
+../../../src/vnet/bfd/bfd_doc.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/eventviewer.rst b/docs/developer/corefeatures/eventviewer.rst
new file mode 100644
index 00000000000..21d5fa95275
--- /dev/null
+++ b/docs/developer/corefeatures/eventviewer.rst
@@ -0,0 +1,286 @@
+.. _eventviewer:
+
+Event-logger
+============
+
+The vppinfra event logger provides very lightweight (sub-100ns)
+precisely time-stamped event-logging services. See
+./src/vppinfra/{elog.c, elog.h}
+
+Serialization support makes it easy to save and ultimately to combine a
+set of event logs. In a distributed system running NTP over a local LAN,
+we find that event logs collected from multiple system elements can be
+combined with a temporal uncertainty no worse than 50us.
+
+A typical event definition and logging call looks like this:
+
+.. code-block:: c
+
+    ELOG_TYPE_DECLARE (e) =
+    {
+      .format = "tx-msg: stream %d local seq %d attempt %d",
+      .format_args = "i4i4i4",
+    };
+    struct { u32 stream_id, local_sequence, retry_count; } * ed;
+    ed = ELOG_DATA (m->elog_main, e);
+    ed->stream_id = stream_id;
+    ed->local_sequence = local_sequence;
+    ed->retry_count = retry_count;
+
+The ELOG\_DATA macro returns a pointer to 20 bytes worth of arbitrary
+event data, to be formatted (offline, not at runtime) as described by
+format\_args. Aside from obvious integer formats, the CLIB event logger
+provides a couple of interesting additions. The "t4" format
+pretty-prints enumerated values:
+
+.. code-block:: c
+
+    ELOG_TYPE_DECLARE (e) =
+    {
+      .format = "get_or_create: %s",
+      .format_args = "t4",
+      .n_enum_strings = 2,
+      .enum_strings = { "old", "new", },
+    };
+
+The "t" format specifier indicates that the corresponding datum is an
+index in the event's set of enumerated strings, as shown in the previous
+event type definition.
+
+The “T” format specifier indicates that the corresponding datum is an
+index in the event log’s string heap. This allows the programmer to emit
+arbitrary formatted strings. One often combines this facility with a
+hash table to keep the event-log string heap from growing arbitrarily
+large.
+
+Noting the 20-octet limit per-log-entry data field, the event log
+formatter supports arbitrary combinations of these data types. As in:
+the ".format" field may contain one or more instances of the following:
+
+-   i1 - 8-bit unsigned integer
+-   i2 - 16-bit unsigned integer
+-   i4 - 32-bit unsigned integer
+-   i8 - 64-bit unsigned integer
+-   f4 - float
+-   f8 - double
+-   s - NULL-terminated string - be careful
+-   sN - N-byte character array
+-   t1,2,4 - per-event enumeration ID
+-   T4 - Event-log string table offset
+
+The vpp engine event log is thread-safe, and is shared by all threads.
+Take care not to serialize the computation. Although the event-logger is
+about as fast as practicable, it's not appropriate for per-packet use in
+hard-core data plane code. It's most appropriate for capturing rare
+events - link up-down events, specific control-plane events and so
+forth.
+
+The vpp engine has several debug CLI commands for manipulating its event
+log:
+
+.. code-block:: console
+
+    vpp# event-logger clear
+    vpp# event-logger save  # for security, writes into /tmp/.
+                                      #  must not contain '.' or '/' characters
+    vpp# show event-logger [all] [] # display the event log
+                                       # by default, the last 250 entries
+
+The event log defaults to 128K entries. The command-line argument "...
+vlib { elog-events nnn } ..." configures the size of the event log.
+
+As described above, the vpp engine event log is thread-safe and shared.
+To avoid confusing non-appearance of events logged by worker threads,
+make sure to code vlib\_global\_main.elog\_main - instead of
+vm->elog\_main. The latter form is correct in the main thread, but
+will almost certainly produce bad results in worker threads.
+
+G2 graphical event viewer
+-------------------------
+
+The G2 graphical event viewer can display serialized vppinfra event logs
+directly, or via the c2cpel tool. G2 is a fine-grained event-log viewer. It's
+highly scalable, supporting O(1e7 events) and O(1e3 discrete display "tracks").
+G2 displays binary data generated by the vppinfra "elog.[ch]" logger component,
+and also supports the CPEL file format, as described in this section.
+
+Building G2
+~~~~~~~~~~~
+
+This link describes :ref:`how to build G2 `
+
+Setting the Display Preferences
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The file $<*HOMEDIR*>/.g2 contains display preferences, which can be overridden.
+Simply un-comment one of the stanzas shown below, or experiment as desired.
+
+.. code-block:: c
+
+    /*
+     * Property / parameter settings for G2
+     *
+     * Setting for a 1024x768 display:
+     * event_selector_lines=20
+     * drawbox_height=800
+     * drawbox_width=600
+     *
+     * new mac w/ no monitor:
+     * event_selector_lines=20
+     * drawbox_height=1200
+     * drawbox_width=700
+     *
+     * 1600x1200:
+     * drawbox_width=1200
+     * drawbox_height=1000
+     * event_selector_lines=25
+     *
+     * for making screenshots on a Macbook Pro
+     * drawbox_width=1200
+     * drawbox_height=600
+     * event_selector_lines=20
+     */
+
+Screen Taxonomy
+~~~~~~~~~~~~~~~
+
+Here is an annotated G2 viewer screenshot, corresponding to activity during BGP
+prefix download. This data was captured on a Cisco IOS-XR system:
+
+.. figure:: /_images/g21.jpg
+   :scale: 75%
+
+
+The viewer has two main scrollbars: the horizontal axis scrollbar shifts the main
+drawing area in time; the vertical axis changes the set of visible process traces.
+The zoomin / zoomout operators change the time scale.
+
+The event selector PolyCheckMenu changes the set of displayed events.
+Using these tools -- and some patience -- you can understand a given event log.
+
+Mouse Gestures
+~~~~~~~~~~~~~~~
+
+G2 has three fairly sophisticated mouse gesture interfaces, which are worth describing
+in detail. First, a left mouse click on a display event pops up a per-event detail box.
+
+.. figure:: /_images/g22.jpg
+   :scale: 75%
+
+A left mouse click on an event detail box closes it.
+To zoom to a region of the display, press and hold the left mouse button, then drag
+right or left until the zoom-fence pair appears:
+
+.. figure:: /_images/g23.jpg
+   :scale: 75%
+
+When the zoom operation completes, the display is as follows:
+
+.. figure:: /_images/g24.jpg
+
+A click on any of the figures will show them at full resolution, right-click will open figures in new tabs,
+
+Time Ruler
+~~~~~~~~~~
+
+To use a time ruler, press and hold the right mouse button; drag right or left
+until the ruler measures the region of interest. If the time axis scale is coarse,
+event boxes can have significant width in time, so use a "reference point" in
+each event box when using the time ruler.
+
+.. figure:: /_images/g25.jpg
+   :scale: 75%
+
+Event Selection
+~~~~~~~~~~~~~~~
+
+Changing the Event Selector setup controls the set of points displayed in an
+obvious way. Here, we suppress all events except "this thread is now running on the CPU":
+
+.. figure:: /_images/g26.jpg
+   :scale: 75%
+
+Same setup, with all events displayed:
+
+.. figure:: /_images/g27.jpg
+   :scale: 75%
+
+Note that event detail boxes previously shown, but suppressed due to deselection
+of the event code will reappear when one reselects the event code. In the example
+above, the "THREAD/THREADY pid:491720 tid:12" detail box appears in this fashion.
+
+Snapshot Ring
+~~~~~~~~~~~~~
+
+Three buttons in lower left-hand corner of the g2 main window control the snapshot
+ring. Snapshots are simply saved views: maneuver the viewer into an "interesting"
+configuration, then press the "Snap" button to add a snapshot to the ring.
+
+Click **Next** to restore the next available snapshot. The **Del** button deletes the current snapshot.
+
+See the hotkey section below for access to a quick and easy method to save and
+restore the snapshot ring. Eventually we may add a safe/portable/supported mechanism
+to save/restore the snapshot ring from CPEL and vppinfra event log files.
+
+Chasing Events
+~~~~~~~~~~~~~~
+
+Event chasing sorts the trace axis by occurrence of the last selected event. For
+example, if one selects an event which means "thread running on the CPU" the first
+N displayed traces will be the first M threads to run (N <= M; a thread may run
+more than once. This feature addresses analytic problems caused by the finite size of the drawing area.
+
+In standard (NoChaseEvent) mode, it looks like only BGP threads 5 and 9 are active:
+
+.. figure:: /_images/g28.jpg
+   :scale: 75%
+
+After pressing the ChaseEvent button, we see a different picture:
+
+.. figure:: /_images/g29.jpg
+   :scale: 75%
+
+Burying Boring Tracks
+~~~~~~~~~~~~~~~~~~~~~
+
+The sequence  moves the track under the mouse to the end
+of the set of tracks, effectively burying it. The sequence 
+moves the track under the mouse to the beginning of the set of tracks. The latter
+function probably isn't precisely right--I think we may eventually provide an "undo"
+stack to provide precise thread exhumation.
+
+Summary Mode
+~~~~~~~~~~~~
+
+Summary mode declutters the screen by rendering events as short vertical line
+segments instead of numbered boxes. Event detail display is unaffected. G2 starts
+in summary mode, zoomed out sufficiently for all events in the trace to be displayed.
+Given a large number of events, summary mode reduces initial screen-paint time to a
+tolerable value. Once you've zoomed in sufficiently, type "e" - enter event mode,
+to enable boxed numeric event display.
+
+Hotkeys
+~~~~~~~
+
+G2 supports the following hotkey actions, supposedly (circa 1996) Quake-like
+according to the feature's original author:
+
++----------------------+--------------------------------------------------------+
+| Key                  | Function                                               |
++======================+========================================================+
+| w                    | Zoom-in                                                |
++----------------------+--------------------------------------------------------+
+| s                    | Zoom-out                                               |
++----------------------+--------------------------------------------------------+
+| a                    | Scroll Left                                            |
++----------------------+--------------------------------------------------------+
+| d                    | Scroll Right                                           |
++----------------------+--------------------------------------------------------+
+| e                    | Toggle between event and summary-event mode            |
++----------------------+--------------------------------------------------------+
+| p                    | Put (write) snapshot ring to snapshots.g2              |
++----------------------+--------------------------------------------------------+
+| l                    | Load (read) snapshot ring from snapshots.g2            |
++----------------------+--------------------------------------------------------+
+| -q             | quit                                                   |
++----------------------+--------------------------------------------------------+
diff --git a/docs/developer/corefeatures/fib/attachedexport.rst b/docs/developer/corefeatures/fib/attachedexport.rst
new file mode 100644
index 00000000000..3bf933de679
--- /dev/null
+++ b/docs/developer/corefeatures/fib/attachedexport.rst
@@ -0,0 +1,50 @@
+.. _attachedexport:
+
+Attached Export
+^^^^^^^^^^^^^^^^
+
+Extranets make prefixes in table A also reachable from table B. Table A is the export table,
+B the import. Consider this route in the export table;
+
+.. code-block:: console
+
+   # ip route add table 2 1.1.1.0/24 via 10.10.10.0 GigabitEthernet0/8/0
+
+there are two ways one might consider representing this route in the import VRF:
+
+#. ip route add table 3 1.1.1.0/24 via 10.10.10.0 GigabitEthernet0/8/0
+#. ip route add table 3 1.1.1.0/24 via lookup-in-table 2
+
+where option 2) is an example of a de-aggregate route where a second lookup is
+performed in table 2, the export VRF. Option 2) is clearly less efficient, since
+the cost of the second lookup is high. Option 1) is therefore preferred. However,
+connected and attached prefixes, and specifically the adj-fibs that they cover,
+require special attention. The control plane is aware of the connected and
+attached prefixes that are required to be exported, but it is unaware of the
+adj-fibs. It is therefore the responsibility of FIB to ensure that whenever an
+attached prefix is exported, so are the adj-fibs and local prefixes that it
+covers, and only the adj-fibs and locals, not any covered more specific
+(sourced e.g. by API). The imported FIB entries are sourced as *attached-export*
+this is a low priority source, so if those prefixes already exist in the import
+table, sourced by the API, then they will continue to forward with that information.
+
+.. figure:: /_images/fib20fig6.png
+
+Figure 6: Attached Export Class diagram.
+
+Figure 6 shows the data structures used to perform attached export.
+
+- *fib_import_t*. A representation of the need to import covered prefixes. An instance is associated with the FIB entry in the import VRF. The need to import prefixes is recognised when an attached route is added to a table that is different to the table of the interface to which it t is attached. The creation of a *fib_import_t* will trigger the creation of a *fib_export_t*.
+- *fib_export_t*. A representation of the need to export prefixes. An instance is associated with the attached entry in the export VRF. A *fib_export_t* can have many associated *fib_import_t* objects representing multiple VRFs into which the prefix is exported.
+
+.. figure:: /_images/fib20fig6.png
+
+Figure 7: Attached Export object diagram
+
+Figure 7 shows an object instance diagram for the export of a connected from table
+1 to two other tables. The /32 adj-fib and local prefix in the export VRF are
+exported into the import VRFs, where they are sourced as *attached-export* and
+inherit the forwarding information from the exported entry. The attached prefix
+in the import VRF also performs cover tracking with the connected prefix in the
+export VRF so that it can react to updates to that prefix that will require the
+removal the imported covered prefixes.
diff --git a/docs/developer/corefeatures/fib/barnacles.rst b/docs/developer/corefeatures/fib/barnacles.rst
new file mode 100644
index 00000000000..08e842ade28
--- /dev/null
+++ b/docs/developer/corefeatures/fib/barnacles.rst
@@ -0,0 +1,78 @@
+.. _barnacles:
+
+Barnacles
+---------
+
+Features that are stuck on the side of the FIB. Those that directly use
+the services that the FIB provides.
+
+In the section on FIB fundamentals it was mentioned  that there is a
+separation between what to match and how to forward. In an IP FIB what
+to match is the packet's destination address against a table of IP
+prefixes, and how to forward is described by a list of paths (the
+**fib_path_list_t**).
+
+ACL Based Forwarding
+^^^^^^^^^^^^^^^^^^^^
+
+ACL Based Forwarding (ABF) is also know as policy based routing
+(PBR). In ABF what to match is described by an ACL.
+
+ABF uses two VPP services; ACL as a service, as provided by the ACL
+plugin and FIB path-lists. It just glues them together.
+
+An ABF policy is the combination of an ACL with the forwarding
+description of a FIB path-list. An ABF attachment is the association
+of [an ordered set of] ABF policies to an interface. The attachment is
+consulted on the ingress path of the IP DP (as an input
+feature). If the ACL matches then the associated forwarding is
+followed, if not, the packet continues along the DP. Simple.
+
+Layer 3 Cross Connect
+^^^^^^^^^^^^^^^^^^^^^
+
+An L3 cross-connect (L3XC) matches all packets
+that ingress the interface and then forwards using the supplied FIB
+path-list. Naturally it runs as an input feature in the IP
+path. Super simple.
+
+IP Punt
+^^^^^^^
+
+Matches all IP packets that VPP has punted. Why they are punted is not
+relevant. All IP punted packets are sent by VPP to the punt feature
+arc. This feature 'matches' all packets that it receives and forwards
+using the FIB path-list.
+
+
+Unicast Reverse Path Forwarding
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Unicast Reverse Path Forwarding (uRPF) is the process of ensuring that
+a packet has a conforming source address. It comes in two
+flavours:
+
+- loose: The source address must be reachable, i.e. FIB must have a
+  route that will forward to the source address. The default route
+  counts as long as it does not drop.
+- strict: The source address is reachable via the interface on which
+  the packet arrived, i.e. the FIB's route for the source address must
+  include the input interface as an output interface.
+
+The uRPF feature can run on either the input or output IP feature
+arc. In both cases it serves as an anti-spoofing check, though the
+semantics are slightly different. On the input arc it enforces that
+peers on that link are only using source addresses that they should -
+a network admin should employ at the access edge. On the output
+arc it enforces that a packet is sourced from a prefix that belongs to
+the network, i.e. that is has originated from within an SP's
+network, a network admin could use at its peering points.
+
+To perform a uRPF check, the DP performs an IP FIB lookup on the
+source address, this always results in a load-balance (LB) object. If
+the LB has only 1 bucket and that bucket stacks on a drop DPO, then
+both a loose and strict check will fail, otherwise a loose check
+will pass. Each LB object has an associated uRPF list object. This
+object holds the list of interfaces through which the prefix is
+reachable. To pass the strict check, the input/output interface must
+be in this list.
diff --git a/docs/developer/corefeatures/fib/controlplane.rst b/docs/developer/corefeatures/fib/controlplane.rst
new file mode 100644
index 00000000000..8b58d42f5b3
--- /dev/null
+++ b/docs/developer/corefeatures/fib/controlplane.rst
@@ -0,0 +1,23 @@
+.. _controlplane:
+
+The Control Plane
+-----------------
+
+The control plane follows a layered data representation. This document describes the
+model starting from the lowest layer. The description uses IPv4 addresses and
+protocols, but all concepts apply equally to the IPv6 equivalents. The diagrams
+all portray the CLI command to install the information in VPP and an
+[approximation of] a UML diagram [#f1]_ of the data structures used to represent that
+information.
+
+.. toctree::
+
+   neighbors
+   routes
+   attachedexport
+   graphwalks
+   marknsweep
+
+.. rubric:: Footnotes:
+
+.. [#f1] The arrow indicates a ‘has-a’ relationship. The object attached to the arrow head ‘has-a’ instance of the other. The numbers next to the arrows indicate the multiplicity, i.e. object A has n to m instances of object B. The difference between a UML association and aggregation is not conveyed in any diagrams. To UML aficionados, I apologize. Word is not the best drawing tool.
diff --git a/docs/developer/corefeatures/fib/dataplane.rst b/docs/developer/corefeatures/fib/dataplane.rst
new file mode 100644
index 00000000000..94e11d1428c
--- /dev/null
+++ b/docs/developer/corefeatures/fib/dataplane.rst
@@ -0,0 +1,100 @@
+.. _dataplane:
+
+The Data Plane
+---------------
+
+The data-plane data model is a directed, acyclic [#f16]_ graph of heterogeneous objects.
+A packet will forward walk the graph as it is switched. Each object describes
+the actions to perform on the packet. Each object type has an associated VLIB
+graph node. For a packet to forward walk the graph is therefore to move from one
+VLIB node to the next, with each performing the required actions. This is the
+heart of the VPP model.
+
+The data-plane graph is composed of generic data-path objects (DPOs). A parent
+DPO is identified by the tuple:{type,index,next_node}. The *next_node* parameter
+is the index of the VLIB node to which the packets should be sent next, this is
+present to maximise performance - it is important to ensure that the parent does
+not need to be read [#f17]_ whilst processing the child. Specialisations [#f18]_ of the DPO
+perform distinct actions. The most common DPOs and briefly what they represent are:
+
+- Load-balance: a choice in an ECMP set.
+- Adjacency:  apply a rewrite and forward through an interface
+- MPLS-label: impose an MPLS label.
+- Lookup: perform another lookup in a different table.
+
+The data-plane graph is derived from the control-plane graph by the objects
+therein 'contributing' a DPO to the data-plane graph. Objects in the data-plane
+contain only the information needed to switch a packet, they are therefore
+simpler, and in memory terms smaller, with the aim to fit one DPO on a single
+cache-line. The derivation from the control plane means that the data-plane
+graph contains only object whose current state can forward packets. For example,
+the difference between a *fib_path_list_t* and a *load_balance_t* is that the former
+expresses the control-plane's desired state, the latter the data-plane available
+state. If some paths in the path-list are unresolved or down, then the
+load-balance will not include them in the forwarding choice.
+
+.. figure:: /_images/fib20fig8.png
+
+Figure 8: DPO contributions for a non-recursive route
+
+Figure 8 shows a simplified view of the control-plane graph indicating those
+objects that contribute DPOs. Also shown are the VLIB node graphs at which the DPO is used.
+
+Each *fib_entry_t* contributes it own *load_balance_t*, for three reasons;
+
+- The result of a lookup in a IPv[46] table is a single 32 bit unsigned integer. This is an index into a memory pool. Consequently the object type must be the same for each result. Some routes will need a load-balance and some will not, but to insert another object in the graph to represent this choice is a waste of cycles, so the load-balance object is always the result. If the route does not have ECMP, then the load-balance has only one choice.
+
+- In order to collect per-route counters, the lookup result must in some way uniquely identify the *fib_entry_t*. A shared load-balance (contributed by the path-list) would not allow this.
+- In the case the *fib_entry_t* has MPLS out labels, and hence a *fib_path_ext_t*, then the load-balance must be per-prefix, since the MPLS labels that are its parents are themselves per-fib_entry_t.
+
+.. figure:: /_images/fib20fig9.png
+
+Figure 9: DPO contribution for a recursive route.
+
+Figure 9 shows the load-balance objects contributed for a recursive route.
+
+.. figure:: /_images/fib20fig10.png
+
+Figure 10: DPO Contributions from labelled recursive routes.
+
+Figure 10 shows the derived data-plane graph for a labelled recursive route.
+There can be as many MPLS-label DPO instances as there are routes multiplied by
+the number of paths per-route. For this reason the mpls-label DPO should be as
+small as possible [#f19]_.
+
+The data-plane graph is constructed by 'stacking' one
+instance of a DPO on another to form the child-parent relationship. When this
+stacking occurs, the necessary VLIB graph arcs are automatically constructed
+from the respected DPO type's registered graph nodes.
+
+The diagrams above show that for any given route the full data-plane graph is
+known before any packet arrives. If that graph is composed of n objects, then the
+packet will visit n nodes and thus incur a forwarding cost of approximately n
+times the graph node cost. This could be reduced if the graph were *collapsed*
+into fewer DPOs and nodes. There are two ways we might consider doing
+this:
+
+- write custom DPOs/nodes for combined functions, e.g. pop MPLS label
+  and lookup in v4 table. This has the disadvantage that the number of
+  such nodes would be, well, combinatorial, and resolving a path via
+  a combined DPO would be more difficult as it would involve a
+  forward walk of the graph to determine what the combination
+  is. However, VPP power users might consider this option for a
+  limited set of their use cases where performance is truly king.
+- collapse multiple levels of load-balancing into one. For example,
+  if there were two levels of load-balancing each with two choices,
+  this could equally be represented by one level with 4 choices.
+
+In either case a disadvantage to collapsing the graph is that it
+removes the indirection objects that provide fast convergence (see
+section Fast Convergence). To collapse is then a trade-off between
+faster forwarding and fast convergence; VPP favours the latter.
+
+
+.. rubric:: Footnotes:
+
+.. [#f16] Directed implies it cannot be back-walked. It is acyclic even in the presence of a recursion loop.
+.. [#f17] Loaded into cache, and hence potentially incurring a d-cache miss.
+.. [#f18] The engaged reader is directed to vnet/vnet/dpo/*
+.. [#f19] i.e. we should not re-use the adjacency structure.
+
diff --git a/docs/developer/corefeatures/fib/debugging.rst b/docs/developer/corefeatures/fib/debugging.rst
new file mode 100644
index 00000000000..750ad65c420
--- /dev/null
+++ b/docs/developer/corefeatures/fib/debugging.rst
@@ -0,0 +1,106 @@
+.. _debugging:
+
+Debugging
+---------
+
+the anatomy of a route:
+
+.. code-block:: console
+
+  BGvpp# sh ip fib 1.1.1.3/32
+  ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
+  1.1.1.0/24 fib:0 index:9 locks:2
+    CLI refs:1 src-flags:added,contributing,active,
+      path-list:[24] locks:4 flags:shared, uPRF-list:11 len:1 itfs:[1, ]
+        path:[26] pl-index:24 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
+          10.0.0.1 loop0
+        [@0]: arp-ipv4: via 10.0.0.1 loop0
+
+   forwarding:   unicast-ip4-chain
+    [@0]: dpo-load-balance: [proto:ip4 index:11 buckets:1 uRPF:11 to:[0:0]]
+      [0] [@3]: arp-ipv4: via 10.0.0.1 loop0
+
+let's go line by line.
+
+.. code-block:: console
+
+     ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
+
+Each field in turn:
+
+- ipv4-VRF:0: the name of the table (as given by the user, or
+  automatically generated by VPP).
+- fib-index:0; in the VPP pool of FIB objects, this is index 0
+- flow hash:[src dst sport dport proto ]: When calculating the flow
+  hash to use for load-balancing, these are the fields in the packet
+  that are used. There is an API to change this per-table.
+- epoch:0; Used during mark-n-sweep.
+- flags:none; use the force, to find the per-table flags.
+- locks: per-source reference counting, a table can only be deleted
+  when all sources no longer reference it.
+
+next line:
+
+.. code-block:: console
+
+   1.1.1.0/24 fib:0 index:9 locks:2
+
+this shows the route that matched the show request. note that it is not
+an exact match, it's an LPM. The route is in FIB index 0, its index
+(in the VPP pool of fib_entry_t objects) is nine and there are two
+references to the entry.
+You'll get the same output if you type "sh fib entry 9"
+
+next line:
+
+.. code-block:: console
+
+    CLI refs:1 src-flags:added,contributing,active,
+
+the 'CLI' has sourced this route (it was added via CLI). This source
+has been added (well duh) it is 'active', meaning it is the best
+source, and it is contributing a forwarding object. There are some
+scenarios where sources other than the active source contribute,
+namely interpose sources.
+
+next line:
+
+.. code-block:: console
+
+      path-list:[24] locks:4 flags:shared, uPRF-list:11 len:1 itfs:[1, ]
+
+This is path-list inex 24 (see "sh fib path-list 24" this will also
+show the  children), it is 'shared',
+meaning that if other prefixes were to use the same set of paths,
+then they would also use this path-list object. It has uRPF list 11 of
+length 1 containing interface index 1 (which is loop0, see "sh int").
+
+next line:
+
+.. code-block:: console
+
+        path:[26] pl-index:24 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
+          10.0.0.1 loop0
+        [@0]: arp-ipv4: via 10.0.0.1 loop0
+
+This is path 26 (see "sh fib path 26"). It's a member of
+path-list 24. It's ip4 has a weight of 1 and a preference of 0. It's
+of type 'attached-nexthop' and currently resolved - woohoo.
+It is a path 'via 10.0.0.1 loop0'. It is contributing an incomplete adjacency.
+
+next line:
+
+.. code-block:: console
+
+  forwarding:   unicast-ip4-chain
+    [@0]: dpo-load-balance: [proto:ip4 index:11 buckets:1 uRPF:11 to:[0:0]]
+      [0] [@3]: arp-ipv4: via 10.0.0.1 loop0
+
+This section describes how packets of type 'unicast-ip4' will be
+forwarded. It is the result of processing the path information from
+above.
+Here we see load-balance object 11, which has 1 bucket/choice. It is
+also linked to uRPF instance 11 (which it got from path-list 24).
+In bucket 0 there is the incomplete adjacency that was contributed by
+path 26.
+
diff --git a/docs/developer/corefeatures/fib/fastconvergence.rst b/docs/developer/corefeatures/fib/fastconvergence.rst
new file mode 100644
index 00000000000..e1c5d0cc095
--- /dev/null
+++ b/docs/developer/corefeatures/fib/fastconvergence.rst
@@ -0,0 +1,576 @@
+.. _fastconvergence:
+
+Fast Convergence
+------------------------------------
+
+This is an excellent description of the topic:
+
+'FIB '_
+
+but if you're interested in my take keep reading...
+
+First some definitions:
+
+- Convergence; When a FIB is forwarding all packets correctly based
+  on the network topology (i.e. doing what the routing control plane
+  has instructed it to do), then it is said to be 'converged'.
+  Not being in a converged state is [hopefully] a transient state,
+  when either the topology change (e.g. a link failure) has not been
+  observed or processed by the routing control plane, or that the FIB
+  is still processing routing updates. Convergence is the act of
+  getting to the converged state.
+- Fast: In the shortest time possible. There are no absolute limits
+  placed on how short this must be, although there is one number often
+  mentioned. Apparently the human ear can detect loss/delay/jitter in
+  VOIP of 50ms, therefore network failures should last no longer than
+  this, and some technologies (notably link-free alternate fast
+  reroute) are designed to converge in this time. However, it is
+  generally accepted that it is not possible to converge a FIB with
+  tens of millions of routes in this time scale, the industry
+  'standard' is sub-second.
+
+Converging the FIB quickly is thus a matter of:
+
+- discovering something is down
+- updating as few objects as possible
+- to determine which objects to update as efficiently as possible
+- to update each object as quickly as possible
+
+we'll discuss each in turn.
+All output came from VPP version 21.01rc0. In what follows I use IPv4
+prefixes, addresses and IPv4 host length masks, however, exactly the
+same applies to IPv6.
+
+
+Failure Detection
+^^^^^^^^^^^^^^^^^
+
+The two common forms (we'll see others later on) of failure detection
+are:
+
+- link down
+- BFD
+
+The FIB needs to hook into these notifications to trigger
+convergence.
+
+Whenever an interface goes down, VPP issues a callback to all
+registered clients. The adjacency code is such a client. The adjacency
+is a leaf node in the FIB control-plane graph (containing fib_path_t,
+fib_entry_t etc). A back-walk from the adjacency will trigger a
+re-resolution of the paths.
+
+FIB is a client of BFD in order to receive BFD notifications. BFD
+comes in two flavours; single and multi hop. Single hop is to protect
+a specific peer on an interface, such peers are modelled by an
+adjacency. Multi hop is to protect a peer on an unspecified interface
+(i.e. a remote peer), this peer is represented by a host-prefix
+**fib_entry_t**. In both case FIB will add a delegate to the
+**ip_adjacency_t** or **fib_entry_t** that represents the association
+to the BFD session. If the BFD session signals up/down then a backwalk
+can be triggered from the object to trigger re-resolution and hence
+convergence.
+
+
+Few Updates
+^^^^^^^^^^^
+
+In order to talk about what 'a few' is we have to leave the realm of
+the FIB as an abstract graph based object DB and move into the
+concrete representation of forwarding in a large network. Large
+networks are built in layers, it's how you scale them. We'll take
+here a hypothetical service provider (SP) network, but the concepts
+apply equally to data center leaf-spines. This is a rudimentary
+description, but it should serve our purpose.
+
+An SP manages a BGP autonomous system (AS). The SP's goal is both to
+attract traffic into its network to serve its customers, but also to
+serve transit traffic passing through it, we'll consider the latter here.
+The SP's network is all devices in that AS, these
+devices are split into those at the edge (provider edge (PE) routers)
+which peer with routers in other SP networks,
+and those in the core (termed provider (P) routers). Both the PE and P
+routers run the IGP (usually OSPF or ISIS). Only the reachability of the devices
+in the AS are advertised in the IGP - thus the scale (i.e. the number
+of routes) in the IGP is 'small' -  only the number of
+devices that the SP has (typically not more than a few 10k).
+PE routers run BGP; they have external BGP sessions to devices in
+other ASs and internal BGP sessions to devices in the same AS. BGP is
+used to advertise the routes to *all* networks on the internet - at
+the time of writing this number is approaching 900k IPv4 route, hopefully by
+the time you are reading this the number of IPv6 routes has caught up ...
+If we include the additional routes the SP carries to offering VPN service to its
+customers the number of BGP routes can grow to the tens of millions.
+
+BGP scale thus exceeds IGP scale by two orders of magnitude... pause for
+a moment and let that sink in...
+
+A comparison of BGP and an IGP is way way beyond the scope of this
+documentation (and frankly beyond me) so we'll note only the
+difference in the form of the routes they present to FIB. A routing
+protocol will produce routes that specify the prefixes that are
+reachable through its peers. A good IGP
+is link state based, it forms peerings to other devices over these
+links, hence its routes specify links/interfaces. In
+FIB nomenclature this means an IGP produces routes that are
+attached-nexthop, e.g.:
+
+.. code-block:: console
+
+    ip route add 1.1.1.1/32 via 10.0.0.1 GigEthernet0/0/0
+
+BGP on the other hand forms peerings only to neighbours, it does not
+know, nor care, what interface is used to reach the peer. In FIB
+nomenclature therefore BGP produces recursive routes, e.g.:
+
+.. code-block:: console
+
+    ip route 8.0.0.0/16 via 1.1.1.1
+
+where 1.1.1.1 is the BGP peer. It's no accident in this example that
+1.1.1.1/32 happens to be the route the IGP advertised... BGP installs
+routes for prefixes reachable via other BGP peers, and the IGP install
+the routes to those BGP peers.
+
+This has been a very long winded way of describing why the scale of
+recursive routes is therefore 2 orders of magnitude greater than
+non-recursive/attached-nexthop routes.
+
+If we step back for a moment and recall why we've crawled down this
+rabbit hole, we're trying to determine what 'a few' updates means,
+does it include all those recursive routes, probably not ... let's
+keep crawling.
+
+We started this chapter with an abstract description of convergence,
+let's now make that more real. In the event of a network failure an SP
+is interested in moving to an alternate forwarding path as quickly as
+possible. If there is no alternate path, and a converged FIB will drop
+the packet, then who cares how fast it converges. In other words the
+interesting convergence scenarios are the scenarios where the network has
+alternate paths.
+
+PIC Core
+^^^^^^^^
+
+First let's consider alternate paths in the IGP, e.g.;
+
+.. code-block:: console
+
+    ip route add 1.1.1.1/32 via 10.0.0.2 GigEthernet0/0/0
+    ip route add 1.1.1.1/32 via 10.0.1.2 GigEthernet0/0/1
+
+this gives us in the FIB:
+
+.. code-block:: console
+
+                DBGvpp# sh ip fib 1.1.1.1/32
+                  ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, default-route:1, ]
+                  1.1.1.1/32 fib:0 index:15 locks:2
+                    API refs:1 src-flags:added,contributing,active,
+                      path-list:[23] locks:2 flags:shared, uPRF-list:22 len:2 itfs:[1, 2, ]
+                        path:[27] pl-index:23 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
+                          10.0.0.2 GigEthernet0/0/0
+                            [@0]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001111111111dead000000000800
+                        path:[28] pl-index:23 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
+                           10.0.1.2 GigEthernet0/0/1
+                             [@0]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+                    forwarding:   unicast-ip4-chain
+                      [@0]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:22 to:[0:0]]
+                        [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001111111111dead000000000800
+                        [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+There is ECMP across the two paths. Note that the instance/index of the
+load-balance present in the forwarding graph is 17.
+
+Let's add a BGP route via this peer;
+
+.. code-block:: console
+
+    ip route add 8.0.0.0/16 via 1.1.1.1
+
+in the FIB we see:
+
+
+.. code-block:: console
+
+    DBGvpp# sh ip fib 8.0.0.0/16
+        ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:1, default-route:1, ]
+        8.0.0.0/16 fib:0 index:18 locks:2
+          API refs:1 src-flags:added,contributing,active,
+            path-list:[24] locks:2 flags:shared, uPRF-list:21 len:2 itfs:[1, 2, ]
+              path:[29] pl-index:24 ip4 weight=1 pref=0 recursive:  oper-flags:resolved,
+                via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
+
+          forwarding:   unicast-ip4-chain
+            [@0]: dpo-load-balance: [proto:ip4 index:20 buckets:1 uRPF:21 to:[0:0]]
+                [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:22 to:[0:0]]
+                  [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001111111111dead000000000800
+                  [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+the load-balance object used by this route is index 20, but note that
+the next load-balance in the chain is index 17, i.e. it is exactly
+the same instance that appears in the forwarding chain for the IGP
+route. So in the forwarding plane the packet first encounters
+load-balance object 20 (which it will use in ip4-lookup) and then
+number 17 (in ip4-load-balance).
+
+What's the significance? Let's shut down one of those IGP paths:
+
+.. code-block:: console
+
+    DBGvpp# set in state GigEthernet0/0/0 down
+
+the resulting update to the IGP route is:
+
+.. code-block:: console
+
+    DBGvpp# sh ip fib 1.1.1.1/32
+        ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:1, default-route:1, ]
+        1.1.1.1/32 fib:0 index:15 locks:4
+          API refs:1 src-flags:added,contributing,active,
+            path-list:[23] locks:2 flags:shared, uPRF-list:25 len:2 itfs:[1, 2, ]
+              path:[27] pl-index:23 ip4 weight=1 pref=0 attached-nexthop:
+                10.0.0.2 GigEthernet0/0/0
+                  [@0]: arp-ipv4: via 10.0.0.2 GigEthernet0/0/0
+              path:[28] pl-index:23 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
+                10.0.1.2 GigEthernet0/0/1
+                  [@0]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+          recursive-resolution refs:1 src-flags:added, cover:-1
+
+          forwarding:   unicast-ip4-chain
+            [@0]: dpo-load-balance: [proto:ip4 index:17 buckets:1 uRPF:25 to:[0:0]]
+                [0] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+
+notice that the path via 10.0.0.2 is no longer flagged as resolved,
+and the forwarding chain does not contain this path as a
+choice. However, the key thing to note is the load-balance
+instance is still index 17, i.e. it has been modified not
+exchanged. In the FIB vernacular we say it has been 'in-place
+modified', a somewhat linguistically redundant expression, but one that serves
+to emphasise that it was changed whilst still be part of the graph, it
+was never at any point removed from the graph and re-added, and it was
+modified without worker barrier lock held.
+
+Still don't see the significance? In order to converge around the
+failure of the IGP link it was not necessary to update load-balance
+object number 20! It was not necessary to update the recursive
+route. i.e. convergence is achieved without updating any recursive
+routes, it is only necessary to update the affected IGP routes, this is
+the definition of 'a few'. We call this 'prefix independent
+convergence' (PIC) which should really be called 'recursive prefix
+independent convergence' but it isn't...
+
+How was the trick done? As with all problems in computer science, it
+was solved by a layer of misdirection, I mean indirection. The
+indirection is the load-balance that belongs to the IGP route. By
+keeping this object in the forwarding graph and updating it in place,
+we get PIC. The alternative design would be to collapse the two layers of
+load-balancing into one, which would improve forwarding performance
+but would come at the cost of prefix dependent convergence. No doubt
+there are situations where the VPP deployment would favour forwarding
+performance over convergence, you know the drill, contributions welcome.
+
+This failure scenario is known as PIC core, since it's one of the IGP's
+core links that has failed.
+
+iBGP PIC Edge
+^^^^^^^^^^^^^
+
+Next, let's consider alternate paths in BGP, e.g:
+
+.. code-block:: console
+
+    ip route add 8.0.0.0/16 via 1.1.1.1
+    ip route add 8.0.0.0/16 via 1.1.1.2
+
+the 8.0.0.0/16 prefix is reachable via two BGP next-hops (two PEs).
+
+Our FIB now also contains:
+
+.. code-block:: console
+
+    DBGvpp# sh ip fib 8.0.0.0/16
+    ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:2, default-route:1, ]
+    8.0.0.0/16 fib:0 index:18 locks:2
+      API refs:1 src-flags:added,contributing,active,
+        path-list:[15] locks:2 flags:shared, uPRF-list:11 len:2 itfs:[1, 2, ]
+          path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved,
+            via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
+          path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved,
+            via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-load-balance:12]
+
+      forwarding:   unicast-ip4-chain
+        [@0]: dpo-load-balance: [proto:ip4 index:20 buckets:2 uRPF:11 to:[0:0]]
+           [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:1 uRPF:25 to:[0:0]]
+             [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
+             [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+           [1] [@12]: dpo-load-balance: [proto:ip4 index:12 buckets:1 uRPF:13 to:[0:0]]
+             [0] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+The first load-balance (LB) in the forwarding graph is index 20 (the astute
+reader will note this is the same index as in the previous
+section, I am adding paths to the same route, the load-balance is
+in-place modified again). Each choice in LB 20 is another LB
+contributed by the IGP route through which the route's paths recurse.
+
+So what's the equivalent in BGP to a link down in the IGP? An IGP link
+down means it loses its peering out of that link, so the equivalent in
+BGP is the loss of the peering and thus the loss of reachability to
+the peer. This is signaled by the IGP withdrawing the route to the
+peer. But "Wait wait wait", i hear you say ... "just because the IGP
+withdraws 1.1.1.1/32 doesn't mean I can't reach 1.1.1.1, perhaps there
+is a less specific route that gives reachability to 1.1.1.1". Indeed
+there may be. So a little more on BGP network design. I know it's like
+a bad detective novel where the author drip feeds you the plot... When
+describing iBGP peerings one 'always' describes the peer using one of
+its GigEthernet0/0/back addresses. Why? A GigEthernet0/0/back interface
+never goes down (unless you admin down it yourself), some muppet can't
+accidentally cut through the GigEthernet0/0/back cable whilst digging up the
+street. And what subnet mask length does a prefix have on a GigEthernet0/0/back
+interface? it's 'always' a /32. Why? because there's no cable to connect
+any other devices. This choice justifies there 'always' being a /32
+route for the BGP peer. But what prevents there not being a less
+specific - nothing.
+Now clearly if the BGP peer crashes then the /32 for its GigEthernet0/0/back is
+going to be removed from the IGP, but what will withdraw the less
+specific - nothing.
+
+So in order to make use of this trick of relying on the withdrawal of
+the /32 for the peer to signal that the peer is down and thus the
+signal to converge the FIB, we need to force FIB to recurse only via
+the /32 and not via a less specific. This is called a 'recursion
+constraint'. In this case the constraint is 'recurse via host'
+i.e. for ipv4 use a /32.
+So we need to update our route additions from before:
+
+.. code-block:: console
+
+    ip route add 8.0.0.0/16 via 1.1.1.1 resolve-via-host
+    ip route add 8.0.0.0/16 via 1.1.1.2 resolve-via-host
+
+checking the FIB output is left as an exercise to the reader. I hope
+you're doing these configs as you read. There's little change in the
+output, you'll see some extra flags on the paths.
+
+Now let's add the less specific, just for fun:
+
+
+.. code-block:: console
+
+    ip route add 1.1.1.0/28 via 10.0.0.2 GigEthernet0/0/0
+
+nothing changes in resolution of 8.0.0.0/16.
+
+Now withdraw the route to 1.1.1.2/32:
+
+.. code-block:: console
+
+    ip route del 1.1.1.2/32 via 10.0.0.2 GigEthernet0/0/0
+
+In the FIB we see:
+
+.. code-block:: console
+
+    DBGvpp# sh ip fib 8.0.0.0/32
+      ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:2, default-route:1, ]
+      8.0.0.0/16 fib:0 index:18 locks:2
+        API refs:1 src-flags:added,contributing,active,
+          path-list:[15] locks:2 flags:shared, uPRF-list:13 len:2 itfs:[1, 2, ]
+            path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
+              via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
+            path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  cfg-flags:resolve-host,
+              via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-drop:0]
+
+        forwarding:   unicast-ip4-chain
+          [@0]: dpo-load-balance: [proto:ip4 index:20 buckets:1 uRPF:13 to:[0:0]]
+            [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:27 to:[0:0]]
+              [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
+              [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+the path via 1.1.1.2 is unresolved, because the recursion constraints
+are preventing the the path resolving via 1.1.1.0/28. the LB index 20
+has been updated to remove the unresolved path.
+
+Job done? Not quite! Why not?
+
+Let's re-examine the goals of this chapter. We wanted to update 'a
+few' objects, which we have defined as not all the millions of
+recursive routes. Did we do that here? We sure did, when we
+modified LB index 20. So WTF?? Where's the indirection object that can
+be modified so that the LBs for the recursive routes are not
+modified - it's not there.... WTF?
+
+OK so the great detective has assembled all the suspects in the
+drawing room and only now does he drop the bomb; the FIB knows the
+scale, we talked above about what the scale **can** be, worst case
+scenario, but that's not necessarily what it is in this hypothetical
+(your) deployment. It knows how many recursive routes there are that
+depend on a /32, it can thus make its own determination of the
+definition of 'a few'. In other words, if there are only 'a few'
+recursive prefixes that depend on a /32 then it will update them
+synchronously (and we'll discuss what synchronously means a bit more later).
+
+So what does FIB consider to be 'a few'. Let's add more routes and
+find out.
+
+.. code-block:: console
+
+    DBGvpp# ip route add 8.1.0.0/16 via 1.1.1.2 resolve-via-host via 1.1.1.1 resolve-via-host
+      ...
+    DBGvpp# ip route add 8.63.0.0/16 via 1.1.1.2 resolve-via-host via 1.1.1.1 resolve-via-host
+
+and we see:
+
+.. code-block:: console
+
+    DBGvpp# sh ip fib 8.8.0.0
+     ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
+     8.8.0.0/16 fib:0 index:77 locks:2
+     API refs:1 src-flags:added,contributing,active,
+       path-list:[15] locks:128 flags:shared,popular, uPRF-list:28 len:2 itfs:[1, 2, ]
+         path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
+           via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
+         path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
+           via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-load-balance:12]
+
+     forwarding:   unicast-ip4-chain
+       [@0]: dpo-load-balance: [proto:ip4 index:79 buckets:2 uRPF:28 flags:[uses-map] to:[0:0]]
+           load-balance-map: index:0 buckets:2
+              index:    0    1
+                map:    0    1
+         [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:27 to:[0:0]]
+           [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
+           [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+         [1] [@12]: dpo-load-balance: [proto:ip4 index:12 buckets:1 uRPF:18 to:[0:0]]
+           [0] [@3]: arp-ipv4: via 10.0.1.2 GigEthernet0/0/0
+
+
+Two elements to note here; the path-list has the 'popular' flag and
+there is a load-balance map in the forwarding path.
+
+'popular' in this case means that the path-list has passed the limit
+of 'a few' in the number of children it has.
+
+here are the children:
+
+.. code-block:: console
+
+  DBGvpp# sh fib path-list 15
+    path-list:[15] locks:128 flags:shared,popular, uPRF-list:28 len:2 itfs:[1, 2, ]
+      path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
+        via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
+      path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
+        via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-load-balance:12]
+      children:{entry:18}{entry:21}{entry:22}{entry:23}{entry:25}{entry:26}{entry:27}{entry:28}{entry:29}{entry:30}{entry:31}{entry:32}{entry:33}{entry:34}{entry:35}{entry:36}{entry:37}{entry:38}{entry:39}{entry:40}{entry:41}{entry:42}{entry:43}{entry:44}{entry:45}{entry:46}{entry:47}{entry:48}{entry:49}{entry:50}{entry:51}{entry:52}{entry:53}{entry:54}{entry:55}{entry:56}{entry:57}{entry:58}{entry:59}{entry:60}{entry:61}{entry:62}{entry:63}{entry:64}{entry:65}{entry:66}{entry:67}{entry:68}{entry:69}{entry:70}{entry:71}{entry:72}{entry:73}{entry:74}{entry:75}{entry:76}{entry:77}{entry:78}{entry:79}{entry:80}{entry:81}{entry:82}{entry:83}{entry:84}
+
+64 children makes it popular. The number is fixed (there is no API to
+change it). Its choice is an attempt to balance the performance cost
+of the indirection performance degradation versus the convergence
+gain.
+
+Popular path-lists contribute the load-balance map, this is the
+missing indirection object. Its indirection happens when choosing the
+bucket in the LB. The packet's flow-hash is taken 'mod number of
+buckets' to give the 'candidate bucket' then the map will take this
+'index' and convert it into the 'map'. You can see in the example above
+that no change occurs, i.e. if the flow-hash mod n chooses bucket 1
+then it gets bucket 1.
+
+Why is this useful? The path-list is shared (you can convince
+yourself of this if you look at each of the 8.x.0.0/16 routes we
+added) and all of these routes use the same load-balance map, therefore, to
+converge all the recursive routs, we need only change the map and
+we're good; we again get PIC.
+
+OK who's still awake... if you're thinking there's more to this story,
+you're right. Keep reading.
+
+This failure scenario is called iBGP PIC edge. It's 'edge' because it
+refers to the loss of an edge device, and iBGP because the device was
+a iBGP peer (we learn iBGP peers in the IGP). There is a similar eBGP
+PIC edge scenario, but this is left for an exercise to the reader (hint
+there are other recursion constraints - see the RFC).
+
+Which Objects
+^^^^^^^^^^^^^
+
+The next topic on our list of how to converge quickly was to
+effectively find the objects that need to be updated when a converge
+event happens. If you haven't realised by now that the FIB is an
+object graph, then can I politely suggest you go back and start from
+the beginning ...
+
+Finding the objects affected by a change is simply a matter of walking
+from the parent (the object affected) to its children. These
+dependencies are kept really for this reason.
+
+So is fast convergence just a matter of walking the graph? Yes and
+no. The question to ask yourself is this, "in the case of iBGP PIC edge,
+when the /32 is withdrawn, what is the list of objects that need to be
+updated and particularly what is the order they should be updated in
+order to obtain the best convergence time?" Think breadth v. depth first.
+
+... ponder for a while ...
+
+For iBGP PIC edge we said it's the path-list that provides the
+indirection through the load-balance map. Hence once all path-lists
+are updated we are converged, thereafter, at our leisure, we can
+update the child recursive prefixes. Is the breadth or depth first?
+
+It's breadth first.
+
+Breadth first walks are achieved by spawning an async walk of the
+branch of the graph that we don't want to traverse. Withdrawing the /32
+triggers a synchronous walk of the children of the /32 route, we want
+a synchronous walk because we want to converge ASAP. This synchronous
+walk will encounter path-lists in the /32 route's child dependent list.
+These path-lists (and their LB maps) will be updated. If a path-list is
+popular, then it will spawn a async walk of the path-list's child
+dependent routes, if not it will walk those routes. So the walk
+effectively proceeds breadth first across the path-lists, then returns
+to the start to do the affected routes.
+
+Now the story is complete. The murderer is revealed.
+
+Let's withdraw one of the IGP routes.
+
+.. code-block:: console
+
+  DBGvpp# ip route del 1.1.1.2/32 via 10.0.1.2 GigEthernet0/0/1
+
+  DBGvpp# sh ip fib 8.8.0.0
+  ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
+  8.8.0.0/16 fib:0 index:77 locks:2
+    API refs:1 src-flags:added,contributing,active,
+      path-list:[15] locks:128 flags:shared,popular, uPRF-list:18 len:2 itfs:[1, 2, ]
+        path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
+          via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
+        path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  cfg-flags:resolve-host,
+          via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-drop:0]
+
+    forwarding:   unicast-ip4-chain
+      [@0]: dpo-load-balance: [proto:ip4 index:79 buckets:1 uRPF:18 to:[0:0]]
+        [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:27 to:[0:0]]
+          [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
+          [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
+
+the LB Map has gone, since the prefix now only has one path. You'll
+need to be a CLI ninja if you want to catch the output showing the LB
+map in its transient state of:
+
+.. code-block:: console
+
+           load-balance-map: index:0 buckets:2
+              index:    0    1
+                map:    0    0
+
+but it happens. Trust me. I've got tests and everything.
+
+On the final topic of how to converge quickly; 'make each update fast'
+there are no tricks.
+
+
+
diff --git a/docs/developer/corefeatures/fib/graphs.rst b/docs/developer/corefeatures/fib/graphs.rst
new file mode 100644
index 00000000000..aec0e4b0135
--- /dev/null
+++ b/docs/developer/corefeatures/fib/graphs.rst
@@ -0,0 +1,34 @@
+.. _graphs:
+
+Graphs
+^^^^^^
+
+The FIB is essentially a collection of related graphs. Terminology from graph theory
+is often used in the sections that follow. From Wikipedia:
+
+*... a graph is a representation of a set of objects where some pairs of objects are
+connected by links. The interconnected objects are represented by mathematical
+abstractions called vertices (also called nodes or points), and the links that
+connect some pairs of vertices are called edges (also called arcs or lines) ...
+edges may be directed or undirected.*
+
+In a directed graph the edges can only be traversed in one direction - from child to
+parent. The names are chosen to represent the many to one relationship. A child has
+one parent, but a parent many children.  In undirected graphs the edge traversal
+can be in either direction, but in FIB the parent child nomenclature remains to
+represent the many to one relationship. Children of the same parent are termed
+siblings. When the traversal is from child to parent it is considered to be a
+forward traversal, or walk, and from parent to the many children a back walk.
+Forward walks are cheap since they start from the many and move toward the few.
+Back walks are expensive as the start from the few and visit the many.
+
+The many to one relationship between child and parent means that the lifetime of a
+parent object must extend to the lifetime of its children. If the control plane
+removes a parent object before its children, then the parent must remain, in an
+**incomplete** state, until the children are themselves removed. Likewise if a child
+is created before its parent, the parent is created in an *incomplete* state. These
+incomplete objects are needed to maintain the graph dependencies. Without them when
+the parent is added finding the affected children would require a search through many
+databases for those children. To extend the lifetime of parents all children thereof
+hold a **lock** on the parent. This is a simple reference count. Children then follow
+the add-or-lock/unlock semantics for finding a parent, as opposed to a malloc/free.
diff --git a/docs/developer/corefeatures/fib/graphwalks.rst b/docs/developer/corefeatures/fib/graphwalks.rst
new file mode 100644
index 00000000000..e740660a2ed
--- /dev/null
+++ b/docs/developer/corefeatures/fib/graphwalks.rst
@@ -0,0 +1,80 @@
+.. _graphwalks:
+
+Graph Walks
+^^^^^^^^^^^^
+
+All FIB object types are allocated from a VPP memory pool [#f13]_. The objects are thus
+susceptible to memory re-allocation, therefore the use of a bare "C" pointer to refer
+to a child or parent is not possible. Instead there is the concept of a *fib_node_ptr_t*
+which is a tuple of type,index. The type indicates what type of object it is
+(and hence which pool to use) and the index is the index in that pool. This allows
+for the safe retrieval of any object type.
+
+When a child resolves via a parent it does so knowing the type of that parent. The
+child to parent relationship is thus fully known to the child, and hence a forward
+walk of the graph (from child to parent) is trivial. However, a parent does not choose
+its children, it does not even choose the type. All object types that form part of the
+FIB control plane graph all inherit from a single base class; *fib_node_t*. A *fib_node_t*
+identifies the object's index and its associated virtual function table provides the
+parent a mechanism to visit that object during the walk. The reason for a back-walk
+is to inform all children that the state of the parent has changed in some way, and
+that the child may itself need to update.
+
+To support the many to one, child to parent, relationship a parent must maintain a
+list of its children. The requirements of this list are;
+
+- O(1) insertion and delete time. Several child-parent relationships are made/broken during route addition/deletion.
+- Ordering. High priority children are at the front, low priority at the back (see section Fast Convergence)
+- Insertion at arbitrary locations.
+
+To realise these requirements the child-list is a doubly linked-list, where each element
+contains a *fib_node_ptr_t*. The VPP pool memory model applies to the list elements, so
+they are also identified by an index. When a child is added to a list it is returned the
+index of the element. Using this index the element can be removed in constant time.
+The list supports 'push-front' and 'push-back' semantics for ordering. To walk the children
+of a parent is then to iterate this list.
+
+A back-walk of the graph is a depth first search where all children in all levels of the
+hierarchy are visited. Such walks can therefore encounter all object instances in the
+FIB control plane graph, numbering in the millions. A FIB control-plane graph is cyclic
+in the presence of a recursion loop, so the walk implementation has mechanisms to detect
+this and exit early.
+
+A back-walk can be either synchronous or asynchronous. A synchronous walk will visit the
+entire section of the graph before control is returned to the caller, an asynchronous
+walk will queue the walk to a background process, to run at a later time, and immediately
+return to the caller. To implement asynchronous walks a *fib_walk_t* object it added to
+the front of the parent's child list. As children are visited the *fib_walk_t* object
+advances through the list. Since it is inserted in the list, when the walk suspends
+and resumes, it can continue at the correct location. It is also safe with respect to
+the deletion of children from the list. New children are added to the head of the list,
+and so will not encounter the walk, but since they are new, they already have the up to
+date state of the parent.
+
+A VLIB process 'fib-walk' runs to perform the asynchronous walks. VLIB has no priority
+scheduling between respective processes, so the fib-walk process does work in small
+increments so it does not block the main route download process. Since the main download
+process effectively has priority numerous asynchronous back-walks can be started on the
+same parent instance before the fib-walk process can run. FIB is a 'final state' application.
+If a parent changes n times, it is not necessary for the children to also update n
+times, instead it is only necessary that this child updates to the latest, or final,
+state. Consequently when multiple walks on a parent (and hence potential updates to a
+child) are queued, these walks can be merged into a single walk. This
+is the main reason the walks are designed this way, to eliminate (as
+much as possible) redundant work and thus converge the system as fast
+as possible.
+
+Choosing between a synchronous and an asynchronous walk is therefore a trade-off between
+time it takes to propagate a change in the parent to all of its children, versus the
+time it takes to act on a single route update. For example, if a route update were to
+affect millions of child recursive routes, then the rate at which such updates could be
+processed would be dependent on the number of child recursive route which would not be
+good. At the time of writing FIB2.0 uses synchronous walk in all locations except when
+walking the children of a path-list, and it has more than 32 [#f15]_ children. This avoids the
+case mentioned above.
+
+.. rubric:: Footnotes:
+
+.. [#f13] Fast memory allocation is crucial to fast route update times.
+.. [#f14] VPP may be written in C and not C++ but inheritance is still possible.
+.. [#f15] The value is arbitrary and yet to be tuned.
diff --git a/docs/developer/corefeatures/fib/hacking.rst b/docs/developer/corefeatures/fib/hacking.rst
new file mode 100644
index 00000000000..f64d3deb860
--- /dev/null
+++ b/docs/developer/corefeatures/fib/hacking.rst
@@ -0,0 +1,68 @@
+.. _hacking:
+
+Get Hacking
+-----------
+
+The code's directory structure is trivial, FIB, mFIB, adj have their
+own directories.
+
+for the most part, for all the FIB object types mentioned in this
+documentation there is a corresponding .h and .c file. As with any VPP
+component/sub-system a 'public' header file is any file that can be
+included by another sub-system and/or plugin. These must be specified
+in the build-system, so go look there. Public header files are always
+a good entry point to start reading.
+
+FIB
+^^^
+
+There is no direct [VPP's binary] API access to FIB, but FIB does
+expose types that can be used on the API by FIB and by other
+subsystems (e.g. :ref:`barnacles`). These types are specified in
+fib.api and the encoding and decoding thereof in fib_api.[ch].
+
+Most operations on a FIB entry happen as a result of an operation on a
+FIB table; an entry does not exist in isolation. The APIs in
+fib_table.h are well doxygen documented you should be able to figure
+out what they do. Use this as a starting point to explore how entries
+are created and deleted and how the source priority scheme works.
+
+FIB sources are defined in fib_source.h. Each source behaviour has its
+own file fib_entry_src_*.c These define the virtual functions that
+determine how the source behaves when actions on the FIB occur. For
+example, what the entry must do when its covering prefix's forwarding
+is updated.
+
+When creating new paths/path-lists the main action required is to
+resolve them; see fib_path*_resolve, and once resolved to have them
+contribute a DPO for forwarding or for the uRPF list; see
+fib_*_contribute_forwarding and fib_*_contribute_urpf respectively.
+
+The data-structures that used for entry lookup are protocol
+specific, they are implemented in separate files; ip4_fib.[ch],
+ip6_fib.[ch] and mpls_fib.[ch].
+
+FIB extranet support is implemented in fib_attached_export.[ch].
+FIB tracking is implemented in fib_entry_track.[ch].
+FIB [back]walk is implemented in fib_walk.[ch].
+
+Adjacency
+^^^^^^^^^
+
+Not much to say here, each adjacency type has it own file; use the
+force, read the source.
+
+
+Testing
+^^^^^^^
+
+the majority of FIB coverage comes from the C Unit tests in
+fib_test.c. I strongly encourage you to add code here. It's a much
+easier development cycle to fire up GDB, run VPP and iterate with
+'test fib', than it is work in the python UT. You still need to write
+python UT, don't get me wrong, it's just easier to do the FIB dev
+using C UT.
+
+
+
+Enjoy!
diff --git a/docs/developer/corefeatures/fib/index.rst b/docs/developer/corefeatures/fib/index.rst
new file mode 100644
index 00000000000..37c548b3f59
--- /dev/null
+++ b/docs/developer/corefeatures/fib/index.rst
@@ -0,0 +1,21 @@
+.. _fib20:
+
+The FIB
+===========================================
+
+This describe the FIB (Forwarding information base) implementation :
+Hierarchical, Protocol, Independent
+
+.. toctree::
+
+   prerequisites
+   thedatamodel
+   tunnels
+   mplsfib
+   multicast
+   debugging
+   fastconvergence
+   scale
+   barnacles
+   hacking
+   missing
diff --git a/docs/developer/corefeatures/fib/marknsweep.rst b/docs/developer/corefeatures/fib/marknsweep.rst
new file mode 100644
index 00000000000..e9e38a33f3a
--- /dev/null
+++ b/docs/developer/corefeatures/fib/marknsweep.rst
@@ -0,0 +1,68 @@
+.. _marknsweep:
+
+Mark and Sweep
+--------------
+
+The mark and sweep procedures, in FIB and in other subsystems, are
+built for the purpose of recovering from a control plane crash.
+
+In routing if the control plane (CP) crashes, when it restarts, the network
+topology may have changed. This means that some of the routes that
+were programmed in the FIB may no longer be needed, and perhaps some
+new ones are. If the CP were simply to insert all the new routes it
+learned after it restarts, then FIB could be left with old routes that
+never get removed, this would be bigly bad.
+
+At a high level the requirement is to delete routes from the old set
+that are not present in the new set; 'delete the diff' as it might
+be colloquially known.
+
+How should the control plane determine the old set? It could
+conceivably read back the FIB from VPP. But this presents two
+problems, firstly, it could be a large set of routes, numbering in the
+millions, this is not an efficient mechanism and not one one wants to
+perform at a point when the router is trying to converge
+ASAP. Secondly it represents a 'source of truth' inversion. The
+routing plane is the source of truth, not forwarding. Routing should
+not receive its 'input' from the layers below. Thirdly, on a practical
+note, the reading of VPP data structures to glean this sort of
+accurate information, would only happen in this scenario, i.e. it's
+not well tested and therefore not particularly reliable (see point 2).
+
+Enter 'mark and sweep' or m-n-s (not to be confused with the retail
+giant) as it's affectionately known.
+
+The Mark and Sweep algorithm proceeds in three steps:
+
+- Step 1; the CP declares to VPP that it wants to begin the process
+  (i.e. it has just restarted). At this point VPP will iterate through
+  all the objects that the CP owns and 'mark' then as being
+  stale. This process effectively declares a new 'epoch', a barrier in
+  time that separates the old objects from the new.
+- Step 2; The CP downloads all of its new objects. If one of these new
+  CP objects matches (has the same key as) an existing object, then
+  the CP add is considered an update, and the object's stale state is
+  removed.
+- Step 3: The CP declares it has 'converged'; it has no more updates
+  to give (at this time). VPP will then again iterate through all the
+  CP's objects and remove those that do not belong to the new epoch,
+  i.e. those that are still marked stale.
+
+After step 3, the CP and VPP databases are in sync.
+
+The cost of the process was to download all the new routes again. This
+is a highly-tuned and well-tested scenario.
+
+In VPP we use the synonym 'replace' to describe the mark-n-sweep
+action in the API. We use this term because it refers to the goals of
+the algorithm at a high level - the CP wants to replace the old DB
+with a new one - but it does not specify the algorithm by which that
+is achieved. One could equally perform this task by constructing a
+brand new DB in VPP, and then swapping them when the CP
+converges. Other subsystems may employ that approach, but FIB does
+not. Updates are typically faster than adds, since the update is
+likely a no-op, whereas a separate add would require the memory
+allocator, which is the long pole in FIB additions. Additionally, it requires
+twice the memory for a moment in time, which could be prohibitive when
+the FIB is large.
+
diff --git a/docs/developer/corefeatures/fib/missing.rst b/docs/developer/corefeatures/fib/missing.rst
new file mode 100644
index 00000000000..0beccb17af1
--- /dev/null
+++ b/docs/developer/corefeatures/fib/missing.rst
@@ -0,0 +1,110 @@
+.. _missing:
+
+Missing Functionality
+---------------------
+
+A list of functionality that the FIB does not currently provide.
+
+
+PIC Edge Backup Paths
+^^^^^^^^^^^^^^^^^^^^^
+
+FIB supports the concept of path 'preference'. Only paths that have
+the best preference contribute to forwarding. Only once all the paths with
+the best preference go down do the paths with the next best preference
+contribute.
+
+In BGP PIC edge, BGP would install the primary paths and the backup
+paths. With expectation that backups are only used once all primaries
+fail; this is the same behaviour that FIB's preference sets provide.
+
+However, in order to get prefix independent convergence, one must be
+able to only modify the path-list's load-balance map (LBM) to choose the
+paths to use. Hence the paths must already be in the map, and
+conversely must be in the fib_entry's load-balance (LB). In other
+words, to use backup paths with PIC, the fib_entry's LB must include
+the backup paths, and the path-lists LBM must map from the backups to
+the primaries.
+
+This is change that is reasonably easy w.r.t. to knowing what to
+change, but hard to get right and hard to test.
+
+
+Loop Free Alternate Paths
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Contrary to the BGP approach for path backups, an IGP could install a
+loop free alternate (LFA) path to achieve fast re-route (FRR).
+
+Because of the way the LFA paths are calculated by the IGP an LFA backup
+path is always paired with a primary. VPP FIB does not support this
+primary-backup pair relationship.
+
+In intent of LFA FRR is/was to get below the magic 50ms mark. To do
+this the expectation is/was that one would need in the forwarding
+graph an object that represents a path's state. This object would be
+checked for each packet being sent. If the path is up, the graph (an
+adjacency since it's the IGP) for the primary path is taken, if it's
+down the graph for the backup is taken. When a path goes down only
+this indirection object needs to be updated to affect all
+routes. Naturally, the indirection would incur a performance cost, but
+we know that there are many performance-convergence trade-offs in a
+FIB design.
+
+Should VPP's FIB support this feature? It all depends on the
+50ms. LFA FRR comes from the era when routers ran on lower performance
+CPUs and interface down was an interrupt. VPP typically has plenty of
+gas but runs as a user space process. So, can it update all routes in
+under 50ms on a meaty CPU and can the OS deliver the interface down
+within the time requirements? I don't have the answers to either
+question.
+
+
+Extranets for Multicast
+^^^^^^^^^^^^^^^^^^^^^^^
+
+When a unicast prefix is present in two different tables, then it
+refers to a different set of devices. When the prefix is imported it
+refers to the same set of devices. If the set of paths to reach the
+prefix is different in the import and export table, it doesn't matter,
+since they both refer to the same devices, so either set can be
+used. Therefore, FIB's usual source preference rules can apply. The
+'import' source is lower priority.
+
+When a multicast prefix is present in two different tables, then it's
+two different flows referring to two different set of receivers. When
+the prefix is imported, then it refers to the same flow and two
+different sets of receivers. In other words, the receiver set in the
+import table needs to be the super set of receivers.
+
+There are two ways one might consider doing this; merging the
+path-lists or replicating the packet first into each table.
+
+
+Collapsing
+^^^^^^^^^^
+
+Read :ref:`fastconvergence`
+
+Collapsing the DPO graph for recursive routes doesn't have to be an
+all or nothing. Easy cases:
+
+
+- A recursive prefix with only one path and a path-list that is not
+  popular, could stack directly on the LB of the via entry.
+- A recursive prefix with only multiple paths and a path-list that is not
+  popular, could construct a new load balance using the choices
+  present in each bucket of its via entries. The choices in the new LB
+  though would need to reflect the relative weighting.
+
+
+The condition of an non-popular path-list means that the LB doesn't
+have an LB map and hence it needs to be updated for convergence to
+occur.
+
+The more difficult cases come when the recursive prefix has labels
+which need to be stack on the via entries' choices.
+
+You might also envision a global configuration that always collapses all
+chains, which could be used in deployments where convergence is not a
+priority.
diff --git a/docs/developer/corefeatures/fib/mplsfib.rst b/docs/developer/corefeatures/fib/mplsfib.rst
new file mode 100644
index 00000000000..50b17304850
--- /dev/null
+++ b/docs/developer/corefeatures/fib/mplsfib.rst
@@ -0,0 +1,220 @@
+.. _mplsfib:
+
+MPLS FIB
+--------
+
+Implementation
+^^^^^^^^^^^^^^^
+
+The MPLS FIB is implemented using exactly the same data structures as
+the IP FIB.  The only difference is the implementation of the
+table. Whereas for IPv4 this is an mtrie and for IPv6 a hash table,
+for MPLS it is a flat array indexed by a 21 bit key (label & EOS
+bit). This implementation is chosen to favour packet forwarding speed.
+
+It can be the case in MPLS forwarding that packets received with the
+EOS bit set in the MPLS label need to be forwarded differently from
+those without. The most common example of this is if the path set
+contains a path that does not have an output label. In this case the
+non-EOS packets cannot take this path, because to do so would expose
+the neighbouring router to a label that it did not allocate.
+
+The design choice to make with an MPLS FIB table is therefore:
+- 20 bit key: label only. When the EOS and non-EOS actions differ the result is a 'EOS-choice' object.
+- 21 bit key: label and EOS-bit. The result is then the specific action based on EOS-bit.
+
+20 bit key
+  - Advantages:lower memory overhead, since there are few DB entries.
+  - Disadvantages: slower DP performance in the case the path-lists
+    differ, as more objects are encountered in the switch path
+
+21 bit key
+  - Advantages: faster DP performance
+    Disadvantages: increased memory footprint.
+
+Switching between schemes based on observed/measured action similarity
+is not considered on the grounds of complexity and flip-flopping.
+
+VPP mantra - favour performance over memory. We choose a 21 bit key.
+
+Basics
+^^^^^^
+
+MPLS is not enabled by default. There are two steps to get
+started. First, create the default MPLS FIB:
+
+.. code-block:: console
+
+   $ mpls table add 0
+
+With '0' being the magic number for the 'default' table (just like it
+is for IPv[46]). One can create other MPLS tables, but, unlike IP
+tables, one cannot 'bind' non-default MPLS tables to interfaces, in
+other words all MPLS packets received on an interface will always
+result in a lookup in the default table. One has to be more inventive
+to use the non-default tables...
+
+Secondly, for *each* interface on which you wish to *receive* MPLS
+packets, that interface must be MPLS 'enabled'
+
+.. code-block:: console
+
+   $ set interface mpls GigEthernet0/0/0 enable
+
+there is no equivalent enable for transmit, all that is required is to
+use an interface as an egress path.
+
+Entries in the MPLS FIB can be displayed with:
+
+.. code-block:: console
+
+   $ sh mpls fib [table X] [label]
+
+There is a tight coupling between IP and MPLS forwarding. MPLS
+forwarding equivalence classes (FECs) are often an IP prefix – that is
+to say that traffic matching a given IP prefix is routed into a MPLS
+label switch path (LSP). It is thus necessary to be able to associate
+a given prefix/route with an [out-going] MPLS label that will be
+imposed when the packet is forwarded. This is configured as:
+
+.. code-block:: console
+
+   $ ip route add 1.1.1.1/32 via 10.10.10.10 GigEthernet0/0/0 out-labels 33
+
+packets matching 1.1.1.1/32 will be forwarded out GigEthernet0/0/0 and have
+MPLS label 33 imposed. More than one out-going label can be
+specified. Out-going MPLS labels can be applied to recursive and
+non-recursive routes, e.g;
+
+.. code-block:: console
+
+   $ ip route add 2.2.2.0/24 via 1.1.1.1 out-labels 34
+
+packets matching 2.2.2.0/24 will thus have two MPLS labels imposed; 34
+and 33. This is the realisation of, e,g, an MPLS BGP VPNv4.
+
+To associate/allocate a local-label for a prefix, and thus have
+packets to that local-label forwarded equivalently to the prefix do;
+
+.. code-block:: console
+
+   $ mpls local-label 99 2.2.2.0/24
+
+In the API this action is called a ‘bind’.
+The router receiving the MPLS encapsulated packets needs to be
+programmed with actions associated which each label value – this is
+the role of the MPLS FIB. The MPLS FIB is a table, whose key is the
+MPLS label value and end-of-stack (EOS) bit, which stores the action
+to perform on packets with matching encapsulation. Currently supported
+actions are:
+
+#. Pop the label and perform an IPv[46] lookup in a specified table
+#. Pop the label and forward via a specified next-hop (this is penultimate-hop-pop, PHP)
+#. Swap the label and forward via a specified next-hop.
+
+These can be programmed respectively by:	
+
+.. code-block:: console
+
+   $ mpls local-label 33 eos ip4-lookup-in-table X
+   $ mpls local-label 33 [eos] via 10.10.10.10 GigEthernet0/0/0
+   $ mpls local-label 33 [eos] via 10.10.10.10 GigEthernet0/0/0 out-labels 66
+
+the latter is an example of an MPLS cross connect. Any description of
+a next-hop, recursive, non-recursive, labelled, non-labelled, etc,
+that is valid for an IP prefix, is also valid for an MPLS
+local-label. Note the use of the 'eos' keyword which indicates the
+programming is for the case when the label is end-of-stack. The last
+two operations can apply to both eos and non-eos packets, but the pop
+and IP lookup only to an eos packet.
+
+
+MPLS VPN
+^^^^^^^^
+
+To configure an MPLS VPN for a PE the following example can be used.
+
+Step 1; Configure routes to the iBGP peers - note these route MUST
+have out-going labels;
+
+.. code-block:: console
+
+   $ ip route add 10.0.0.1/32 via 192.168.1.2 Eth0 out-labels 33
+   $ ip route add 10.0.0.2/32 via 192.168.2.2 Eth0 out-labels 34
+
+Step 2; Configure the customer 'VRF'
+
+.. code-block:: console
+
+   $ ip table add 2
+
+Step 3; add a route via the iBGP peer[s] with the MPLS label
+advertised by that peer
+
+.. code-block:: console
+
+   $ ip route add table 2 10.10.10.0/24 via 10.0.0.2 next-hop-table 0 out-label 122
+   $ ip route add table 2 10.10.10.0/24 via 10.0.0.1 next-hop-table 0 out-label 121
+
+Step 4; add a route via the eBGP peer
+
+.. code-block:: console
+
+   $ ip route add table 2 10.10.20.0/24 via 172.16.0.1 next-hop-table 2
+
+Step 5; depending on the label allocation scheme used, add routes to
+the MPLS FIB to accept incoming labelled packets:
+
+#. per-prefix label scheme - this command 'binds' the label to the same
+   forwarding as the IP route
+
+   .. code-block:: console
+
+      $ mpls local-label 99 10.10.20.0/24
+
+#. per-CE label scheme - this pops the incoming label and forwards via
+   the next-hop provided. Append config for 'out-labels' if so desired.
+
+   .. code-block:: console
+
+      $ mpls local-label 99 via 172.16.0.1 next-hop-table 2
+
+#. per-VRF label scheme
+
+   .. code-block:: console
+
+      $ mpls local-label 99 via ip4-lookup-in-table 2
+
+MPLS Tunnels
+^^^^^^^^^^^^
+
+MPLS tunnels are unidirectional and can impose a stack of labels. They
+are 'normal' interfaces and thus can be used, for example, as the
+target for IP routes and L2 cross-connects. To construct a tunnel:
+
+.. code-block:: console
+
+   $ mpls tunnel add via 10.10.10.10 GigEthernet0/0/0 out-labels 33 44 55
+
+and to then have that created tunnel to perform ECMP:
+
+.. code-block:: console
+
+   $ mpls tunnel add mpls-tunnel0 via 10.10.10.11 GigEthernet0/0/0 out-labels 66 77 88
+
+use
+
+.. code-block:: console
+
+   $ sh mpls tunnel [X]
+
+to see the monster you have created.
+
+An MPLS tunnel interface is an interface like any other and now ready
+for use with the usual set of interface commands, e.g.:
+
+.. code-block:: console
+
+   $ set interface state mpls-tunnel0 up
+   $ set interface ip address mpls-tunnel0 192.168.1.1/30
+   $ ip route 1.1.1.1/32 via mpls-tunnel0
diff --git a/docs/developer/corefeatures/fib/multicast.rst b/docs/developer/corefeatures/fib/multicast.rst
new file mode 100644
index 00000000000..37c5673dcde
--- /dev/null
+++ b/docs/developer/corefeatures/fib/multicast.rst
@@ -0,0 +1,106 @@
+.. _mfib:
+
+IP Multicast FIB
+----------------
+
+The two principal differences between multicast and unicast forwarding
+are:
+
+* there is no load-balancing among paths, there is only replication
+  across paths.
+* multicast forwarding has an explicit reverse path forwarding (RPF)
+  check. It will only forward a packet if it arrives from a peer for
+  which it has been explicitly configured to accept.
+
+The other factor that influences the design of the mFIB is that the
+match criteria (the prefix) is different. For multicast it is
+necessary to be able to match on source and destination/group
+addresses (termed an (S,G)) and only on a destination prefix (a (\*,
+G/m)). This prefix is much bigger than a unicast prefix, and since
+unicast scale is almost always greater than multicast scale, it is not
+a good idea to have a single definition of a prefix. Therefore,
+there is a fib_prefix_t (and hence a fib_entry_t) and an
+mfib_prefix_t (and hence a mfib_entry_t).
+
+The fib_path_t and fib_path_list_t are reused. A path can represent
+either a peer from which to accept packets or a peer to which to send
+packets. A path-extension is added to the fib_path_t/mfib_entry_t to
+describe the role the path plays. Logically the path-list is split
+into two sets; an accepting set and a forwarding set. The forwarding set
+contributes a replicate DPO for forwarding and the accepting set
+contributes a list of interfaces (an mfib_itf_t) for the RPF check.
+
+An IP multicast FIB (mFIB) is a data-structure that holds entries that
+represent a (S,G) or a (\*,G/m) multicast group. There is one IPv4 and
+one IPv6 mFIB per IP table, i.e. each time the user calls 'ip[6] table
+add X' an mFIB is created.
+
+Usage
+^^^^^
+
+To add an entry to the default mFIB for the group (1.1.1.1, 239.1.1.1)
+that will replicate packets to GigEthernet0/0/0 and GigEthernet0/0/1, do:
+
+.. code-block:: console
+
+   $ ip mroute add 1.1.1.1 239.1.1.1 via GigEthernet0/0/0 Forward
+   $ ip mroute add 1.1.1.1 239.1.1.1 via GigEthernet0/0/1 Forward
+
+the flag 'Forward' passed with the path specifies this path to be part of the replication set.
+To add a path from GigEthernet0/0/2 to the accepting (RPF) set do:
+
+.. code-block:: console
+
+   $ ip mroute add 1.1.1.1 239.1.1.1 via GigEthernet0/0/2 Accept
+
+A (\*,G) entry is added by not specifying a source address:
+
+.. code-block:: console
+
+   $ ip mroute add 232.2.2.2 via GigEthernet0/0/2 Forward
+
+A (\*,G/m) entry is added by not specifying a source address and giving
+the group address a mask:
+
+.. code-block:: console
+
+   $ ip mroute add 232.2.2.0/24 via GigEthernet0/0/2 Forward
+
+Entries are deleted when all paths have been removed and all entry flags (see below) are also removed.
+
+Advanced
+^^^^^^^^
+
+There are a set of flags associated only with an entry, see:
+
+.. code-block:: console
+
+   $ show mfib route flags
+
+only some of these are relevant over the API/CLI:
+
+#. Signal - packets that match this entry will generate an event that
+   is sent to the control plane (which can be retrieved via the signal
+   dump API)
+#. Connected - indicates that the control plane should be informed of
+   connected sources (also retrieved via the signal dump API)
+#. Accept-all-itf - the entry shall accept packets from all
+   interfaces, thus eliminating the RPF check
+#. Drop - Drop all packet matching this entry.
+
+flags on an entry can be changed with:
+
+.. code-block:: console
+
+   $ ip mroute  
+
+An alternative approach to the RPF check, that does check the
+accepting path set, is to give the entry and RPF-ID:
+
+.. code-block:: console
+
+   $ ip mroute  rpf-id X
+
+the RPF-ID is an attribute of a received packet's meta-data and is
+added to the packet when it ingresses on a given entity such as an
+MPLS-tunnel or a BIER table disposition entry.
diff --git a/docs/developer/corefeatures/fib/neighbors.rst b/docs/developer/corefeatures/fib/neighbors.rst
new file mode 100644
index 00000000000..13a3f079b4f
--- /dev/null
+++ b/docs/developer/corefeatures/fib/neighbors.rst
@@ -0,0 +1,88 @@
+.. _neighbors:
+
+Neighbours
+^^^^^^^^^^^
+
+.. figure:: /_images/ip-neighbor.png
+
+Figure 1: Neighbour data model
+
+Figure 1 shows the data model for IP neighbours. An IP neighbour contains the mapping
+between a peer, identified by an IPv4 or IPv6 address, and its MAC address on a given
+interface. An IP-table (VRF) is not part of the neighbour's
+data/identity. This is because the virtualization of a router into
+different tables (VRFs) is performed at the interface level, i.e. an
+IP-table is bound to a particular interface. A neighbour, which is
+attached to an interface, is thus implicitly in that table, and
+only in that table. It is also worth noting that IP neighbours
+contribute forwarding for the egress direction, whereas an IP-table
+is an ingress only function.
+
+The *ip_neighbor_t* represents the control-plane addition of the
+neighbour. The *ip_adjacency_t* contains the data derived from the *ip_neighbor_t* that is needed to
+forward packets to the peer. The additional data in the adjacency are the *rewrite*
+and the *link_type*. The *link_type* is a description of the protocol of the packets
+that will be forwarded with this adjacency; e.g. IPv4, IPv6 or MPLS. The *link_type*
+maps directly to the ether-type in an Ethernet header, or the protocol filed in a
+GRE header. The rewrite is a byte string representation of the header that will be
+prepended to the packet when it is sent to that peer. For Ethernet interfaces this
+is be the src,dst MAC and the ether-type. For LISP tunnels, the IP src,dst pair
+and the LISP header.
+
+The *ip_neighbor_t* for an IPv4 peer (learned e.g. over ARP) will
+install a *link_type=IPv4* when the entry is created and a
+link_type=MPLS on demand (i.e. when a route with output labels resolves via the peer).
+
+Adjacency
+---------
+
+There are three sub-types of adjacencies. Purists would argue that some
+of these sub-types are not really adjacencies but are instead other
+forms of DPOs, and it would be hard to argue against that, but
+historically (not just in VPP, but in the FIB implementations from
+which VPP draws on for some of its concepts), these have been modelled
+as adjacency types, the one thing they have in common is that they
+have an associated interface and are terminal. The [sub] sub-types are:
+
+* A Neighbour Adjacency (key={interface, next-hop, link-type}). A
+  representation of a peer on a link (as described above). A neighbour adjacency itself has
+  two sub-types; terminal and mid-chain. When one speak of 'an
+  adjacency' one is usually referring to a terminal neighbour
+  sub-type. A mid-chain adjacency represents a neighbor on a virtual
+  interface which relies on the FIB to perform further forwarding. This
+  adjacency is thus not terminal for the FIB object graph but instead
+  appears in the 'middle' (the term chain is a synonym for graph in
+  some contexts).
+  A neighbour adjacency can be in one of two states; complete and
+  incomplete. A complete adjacency knows the rewrite string that
+  should be used to reach the peer, an incomplete adjacency does
+  not. If the adjacency was added as a result of the addition of an
+  *ip_neighbor_t* then the adjacency will be complete (because the
+  *ip_neighbor_t* knows the peer's MAC address). An incomplete
+  adjacency is created on demand by the FIB when a route's path
+  requires to resolve through such an adjacency. It is thus created in
+  order to resolve the missing dependency, it will become complete
+  once the *ip_neighbor_t* is discovered.
+  In the forwarding path a complete adjacency will prepend the rewrite
+  string and transmit on the egress interface, an incomplete adjacency
+  will construct a ARP/ND request to resolve the peer's IP address.
+
+* A Glean Adjacency (key={interface}). This is a representation of the need to discover
+  a peer on the given interface. It is used when it is known that the
+  packet is destined to an undiscovered peer on that interface. The
+  difference between the glean adjacency and an
+  incomplete neighbour adjacency is that in the forwarding path the
+  glean adjacency will construct an ARP/ND request for the peer as
+  determined from the packet's destination address. The glean
+  adjacency is used to resolve connected prefixes on multi-access
+  interfaces.
+
+* A Multicast Adjacency (key={interface}). This represents the need to send an IP
+  multicast packet out of the adjacency's associated interface. Since
+  IP multicast constructs the destination MAC address from the IP
+  packet's destination/group address, the rewrite is always known and
+  hence the adjacency is always complete.
+
+
+All adjacency types can be shared between routes, hence each type is
+stored in a DB whose key is appropriate for the type.
diff --git a/docs/developer/corefeatures/fib/prefixes.rst b/docs/developer/corefeatures/fib/prefixes.rst
new file mode 100644
index 00000000000..5e0437ae3b3
--- /dev/null
+++ b/docs/developer/corefeatures/fib/prefixes.rst
@@ -0,0 +1,17 @@
+.. _prefixes:
+
+Prefixes
+^^^^^^^^
+
+Some nomenclature used to describe prefixes:
+
+* 1.1.1.1 This is an address since it has no associated mask
+* 1.1.1.0/24 This is a prefix.
+* 1.1.1.1/32 This is a host prefix (the mask length is the size of the address).
+
+Prefix A is more specific than B if its mask length is longer, and less specific if
+the mask is shorter. For example, 1.1.1.0/28 is more specific than 1.1.1.0/24. A
+less specific prefix that overlaps with a more specific is the **covering** prefix.
+For example, 1.1.1.0/24 is the covering prefix for 1.1.1.0/28 and 1.1.1.0/28 is termed
+the **covered** prefix. A covering prefix is therefore always less specific than its
+covered prefixes.
diff --git a/docs/developer/corefeatures/fib/prerequisites.rst b/docs/developer/corefeatures/fib/prerequisites.rst
new file mode 100644
index 00000000000..9d2b5ca21f4
--- /dev/null
+++ b/docs/developer/corefeatures/fib/prerequisites.rst
@@ -0,0 +1,12 @@
+.. _prerequisites:
+
+Prerequisites
+-------------
+
+This section describes some prerequisite topics and nomenclature that are
+foundational to understanding the FIB architecture.
+
+.. toctree::
+
+   graphs
+   prefixes
diff --git a/docs/developer/corefeatures/fib/routes.rst b/docs/developer/corefeatures/fib/routes.rst
new file mode 100644
index 00000000000..a43cbd112d5
--- /dev/null
+++ b/docs/developer/corefeatures/fib/routes.rst
@@ -0,0 +1,353 @@
+.. _routes:
+
+Routes
+^^^^^^
+
+Basics
+------
+
+The anatomy of a route is crucial to understand:
+
+.. code-block:: console
+
+                1.1.1.0/24 via 10.0.0.1 eth0
+
+A route is composed of two parts; **what** to match against and **how** to forward
+the matched packets. In the above example we want to match packets
+whose destination IP address is in the 1.1.1.0/24 subnet and then we
+want to forward those packet to 10.0.0.1 on interface eth0. We
+therefore want to match the **prefix** 1.1.1.0/24 and forward on the
+**path** to 10.0.0.1, eth0.
+
+Matching on a prefix is the particular task of the IP FIB, matching on
+other packet attributes is done by other subsystems, e.g. matching on
+MPLS labels in the MPLS-FIB, or matching on a tuple in ACL based
+forwarding (ABF), 'matching' on all packets that arrive on an L3
+interface (l3XC). Although these subsystems match on different
+properties, they share the infrastructure on **how** to forward
+matched packets, that is they share the **paths**. The FIB paths (or
+really the path-list) thus provide services to clients, this service
+is to **contribute** forwarding, this, in terms that will be made
+clear in later sections, is to provide the DPO to use.
+
+The prime function of the FIB is to *resolve* the paths for a
+route. To resolve a route is to construct an object graph that fully
+describes how to forward matching packets. This means that the graph
+must terminate with an object (the leaf node) that describes how
+to send a packet on an interface [#f1]_, i.e what encap to add to the
+packet and what interface to send it to; this is the purpose of the IP
+adjacency object. In Figure 3 the route is resolved as the graph is
+complete from *fib_entry_t* to *ip_adjacency_t*.
+
+
+Thread Model
+^^^^^^^^^^^^
+
+The FIB is not thread safe. All actions on the FIB are expected to
+occur exclusively in the main thread. However, the data-structures
+that FIB updates to add routes are thread safe,
+w.r.t. addition/deletion and read, therefore routes can be added
+without holding the worker thread barrier lock.
+
+
+Tables
+------
+
+An IP FIB is a set of prefixes against which to match; it is
+sub-address family (SAFI) specific (i.e. there is one for ipv4 and ipv6, unicast
+and multicast). An IP Table is address family (AFI) specific (i.e. the
+'table' includes the unicast and multicast FIB).
+
+Each FIB is identified by the SAFI and instance number (the [pool]
+index), each table is identified by the AFI and ID. The table's ID is
+assigned by the user when the table is constructed. Table ID 0 is
+reserved for the global/default table.
+
+In most routing models a VRF is composed of an IPv4 and IPv6 table,
+however, VPP has no construct to model this association, it deals only
+with tables and FIBs.
+
+A unicast FIB is comprised of two route data-bases; forwarding and non-forwarding. The
+forwarding data-base contains routes against which a packet will perform a longest
+prefix match (LPM) in the data-plane. The non-forwarding DB contains all the routes
+with which VPP has been programmed. Some of these routes may be
+unresolved, preventing their insertion into the forwarding DB.
+(see section: Adjacency source FIB entries).
+
+Model
+-----
+
+The route data is decomposed into three parts; entry, path-list and paths;
+
+* The *fib_entry_t*, which contains the route's prefix, is the representation of that prefix's entry in the FIB table.
+* The *fib_path_t* is a description of where to send the packets destined to the route's prefix. There are several types of path, including:
+
+    * Attached next-hop: the path is described with an interface and a next-hop. The next-hop is in the same sub-net as the router's own address on that interface, hence the peer is considered to be *attached*
+
+    * Attached: the path is described only by an interface. An
+      attached path means that all addresses covered by the route's
+      prefix are on the same L2 segment to which that router's
+      interface is attached. This means it is possible to ARP for any
+      address covered by the route's prefix. If this is not the case
+      then another device in that L2 segment needs to run proxy
+      ARP. An attached path is really only appropriate for a point-to-point
+      (P2P) interface where ARP is not required, i.e. a GRE tunnel. On
+      a p2p interface, attached and attached-nexthop paths will
+      resolve via a special 'auto-adjacency'. This is an adjacency
+      whose next-hop is the all zeros address and describes the only
+      peer on the link.
+
+    * Recursive: The path is described only via the next-hop and table-id.
+
+    * De-aggregate: The path is described only via the special all
+      zeros address and a table-id. This implies a subsequent lookup
+      in the table should be performed.
+
+    * There are other path types, please consult the code.
+
+* The *fib_path_list_t* represents the list of paths from which to choose when forwarding. A path-list is a shared object, i.e. it is the parent to multiple fib_entry_t children. In order to share any object type it is necessary for a child to search for an existing object matching its requirements. For this there must be a database. The key to the path-list database is a combined description of all of the paths it contains [#f2]_.  Searching the path-list database is required with each route addition, so it is populated only with path-lists for which sharing will bring convergence benefits (see Section: :ref:`fastconvergence`).
+
+.. figure:: /_images/fib20fig2.png
+
+Figure 2: Route data model class diagram
+
+Figure 2 shows an example of a route with two attached-next-hop paths. Each of these
+paths will *resolve* by finding the adjacency that matches the paths attributes, which
+are the same as the key for the adjacency database [#f3]_. The *forwarding information (FI)*
+is the set of adjacencies that are available for load-balancing the traffic in the
+data-plane. A path *contributes* an adjacency to the route's forwarding information, the
+path-list contributes the full forwarding information for IP packets.
+
+.. figure:: /_images/fib20fig3.png
+
+Figure 3: Route object diagram
+
+Figure 3 shows the object instances and their relationships created in order to resolve
+the routes also shown. The graph nature of these relationships is evident; children
+are displayed at the top of the diagram, their parents below them. Forward walks are
+thus from top to bottom, back walks bottom to top. The diagram shows the objects
+that are shared, the path-list and adjacency. Sharing objects is critical to fast
+convergence (see section :ref:`fastconvergence`).
+
+FIB sources
+"""""""""""
+There are various entities in the system that can add routes to the FIB tables.
+Each of these entities is termed a *source*. When the same prefix is added by different
+sources the FIB must arbitrate between them to determine which source will contribute
+the forwarding information. Since each source determines the forwarding information
+using different best path and loop prevention algorithms, it is not correct for the
+forwarding information of multiple sources to be combined. Instead the FIB must choose
+to use the forwarding information from only one source. This choice is based on a static
+priority assignment [#f4]_. The FIB must maintain the information each source has added
+so it can be restored should that source become the best source. VPP has two
+*control-plane* sources; the API and the CLI the API has the higher priority.
+Each *source* data is represented by a *fib_entry_src_t* object of which a
+*fib_entry_t* maintains a sorted vector.
+
+The following configuration:
+
+.. code-block:: console
+
+   $ set interface ip address GigabitEthernet0/8/0 192.168.1.1/24
+
+results in the addition of two FIB entries; 192.168.1.0/24 which is connected and
+attached, and 192.168.1.1/32 which is connected and local (a.k.a.
+receive or for-us). A prefix is *connected* when it is applied to a router's interface.
+Both prefixes are *interface* sourced. The interface source has a high priority, so
+the accidental or nefarious addition of identical prefixes does not prevent the
+router from correctly forwarding. Packets matching a connected prefix will
+generate an ARP request for the packets destination address, this process is known
+as a *glean*.
+
+An *attached* prefix also results in a glean, but the router does not have its own
+address in that sub-net. The following configuration will result in an attached
+route, which resolves via an attached path;
+
+.. code-block:: console
+
+   $ ip route add table X 10.10.10.0/24 via gre0
+
+as mentioned before, these are only appropriate for point-to-point
+links.
+
+If table X is not the table to which gre0 is bound,
+then this is the case of an attached export (see the section :ref:`attachedexport`).
+
+Adjacency source FIB entries
+""""""""""""""""""""""""""""
+
+Whenever an ARP entry is created it will source a *fib_entry_t*. In this case the
+route is of the form:
+
+.. code-block:: console
+
+   $ ip route add table X 10.0.0.1/32 via 10.0.0.1 GigabitEthernet0/8/0
+
+This is a host prefix with a path whose next-hop address is the same host. This route
+highlights the distinction between the route's prefix - a description of the traffic
+to match - and the path - a description of where to send the matched traffic.
+Table X is the same table to which the interface is bound. FIB entries that are
+sourced by adjacencies are termed *adj-fibs*. The priority of the adjacency source
+is lower than the API source, so the following configuration:
+
+.. code-block:: console
+
+   $ set interface address 192.168.1.1/24 GigabitEthernet0/8/0
+   $ ip arp 192.168.1.2 GigabitEthernet0/8/0 dead.dead.dead
+   $ ip route add 192.168.1.2 via 10.10.10.10 GigabitEthernet1/8/0
+
+will forward traffic for 192.168.1.2 via GigabitEthernet1/8/0. That is the route added by the control
+plane is favoured over the adjacency discovered by ARP. The control plane, with its
+associated authentication, is considered the authoritative source. To counter the
+nefarious addition of adj-fibs, through the nefarious injection of adjacencies, the
+FIB is also required to ensure that only adj-fibs whose less specific covering prefix
+is attached are installed in forwarding. This requires the use of *cover tracking*,
+where a route maintains a dependency relationship with the route that is its less
+specific cover. When this cover changes (i.e. there is a new covering route) or the
+forwarding information of the cover is updated, then the covered route is notified.
+Adj-fibs that fail this cover check are not installed in the fib_table_t's forwarding
+table, they are only present in the non-forwarding table.
+
+Overlapping sub-nets are not supported, so no adj-fib has multiple paths. The control
+plane is expected to remove a prefix configured for an interface before the interface
+changes VRF.
+
+Recursive Routes
+""""""""""""""""
+
+Figure 4 shows the data structures used to describe a recursive route. The
+representation is almost identical to attached next-hop paths. The difference
+being that the *fib_path_t* has a parent that is another *fib_entry_t*, termed the
+*via-entry*
+
+.. figure:: /_images/fib20fig4.png
+
+Figure 4: Recursive route class diagram.
+
+In order to forward traffic to 64.10.128.0/20 the FIB must first determine how to forward
+traffic to 1.1.1.1/32. This is recursive resolution. Recursive resolution, which is
+essentially a cache of the data-plane result, emulates a longest prefix match for the
+*via-address" 1.1.1.1 in the *via-table* table 0 [#f5]_.
+
+Recursive resolution (RR) will source a host-prefix entry in the via-table for the
+via-address. The RR source is a low priority source. In the unlikely [#f6]_ event that the
+RR source is the best source, then it must derive forwarding information from its
+covering prefix.
+
+There are two cases to consider:
+
+* The cover is connected [#f7]_. The via-address is then an attached host and the RR source can resolve directly via the adjacency with the key {via-address, interface-of-connected-cover}
+* The cover is not connected [#f8]_. The RR source can directly inherit the forwarding information from its cover.
+
+This dependency on the covering prefix means the RR source will track its cover The
+covering prefix will *change* when;
+
+* A more specific prefix is inserted. For this reason whenever an entry is inserted into a FIB table its cover must be found so that its covered dependents can be informed.
+* The existing cover is removed. The covered prefixes must form a new relationship with the next less specific.
+
+The cover will be *updated* when the route for the covering prefix is modified. The
+cover tracking mechanism will provide the RR sourced entry with a notification in the
+event of a change or update of the cover, and the source can take the necessary action.
+
+The RR sourced FIB entry becomes the parent of the *fib_path_t* and will contribute its
+forwarding information to that path, so that the child's FIB entry can construct its own
+forwarding information.
+
+Figure 5 shows the object instances created to represent the recursive route and
+its resolving route also shown.
+
+.. figure:: /_images/fib20fig5.png
+
+Figure 5: Recursive Routes object diagram
+
+If the source adding recursive routes does not itself perform recursive resolution [#f9]_
+then it is possible that the source may inadvertently programme a recursion loop.
+
+An example of a recursion loop is the following configuration:
+
+.. code-block:: console
+
+   $ ip route add 5.5.5.5/32 via 6.6.6.6
+   $ ip route add 6.6.6.6/32 via 7.7.7.7
+   $ ip route add 7.7.7.7/32 via 5.5.5.5
+
+This shows a loop over three levels, but any number is possible. FIB will detect
+recursion loops by forward walking the graph when a *fib_entry_t* forms a child-parent
+relationship with a *fib_path_list_t*. The walk checks to see if the same object instances
+are encountered. When a recursion loop is formed the control plane [#f10]_ graph becomes
+cyclic, thus allowing the child-parent dependencies to form. This is necessary so that
+when the loop breaks, the affected children and be updated.
+
+Output labels
+"""""""""""""
+
+A route may have associated output MPLS labels [#f11]_. These are labels that are expected
+to be imposed on a packet as it is forwarded. It is important to note that an MPLS
+label is per-route and per-path, therefore, even though routes share paths they do not
+necessarily have the same label for that path [#f12]_. A label is therefore uniquely associated
+to a *fib_entry_t* and associated with one of the *fib_path_t* to which it forwards.
+MPLS labels are modelled via the generic concept of a *path-extension*. A *fib_entry_t*
+therefore has a vector of zero to many *fib_path_ext_t* objects to represent the labels
+with which it is configured.
+
+
+Delegates
+^^^^^^^^^
+
+A common software development pattern, a delegate is a means to
+extend the functionality of one object through composition of
+another, these other objects are called delegates. Both
+**fib_entry_t** and **ip_adjacency_t** support extension via delegates.
+
+The FIB uses delegates to add functionality when those functions are
+required by only a few objects instances rather than all of them, to
+save on memory. For example, building/contributing a load-balance
+object used to forward non-EOS MPLS traffic is only required for a
+fib_entry_t that corresponds to a BGP peer and that peer is
+advertising labeled route - there are only a few of
+these. See **fib_entry_delegate.h** for a full list of delegate types.
+
+
+Tracking
+^^^^^^^^
+
+A prime service FIB provides for other sub-system is the ability to
+'track' the forwarding for a given next-hop. For example, a tunnel
+will want to know how to forward to its destination address. It can
+therefore request of the FIB to track this host-prefix and inform it
+when the forwarding for that prefix changes.
+
+FIB tracking sources a host-prefix entry in the FIB using the 'recusive
+resolution (RR)' source, it exactly the same way that a recursive path
+does. If the entry did not previously exist, then the RR source will
+inherit (and track) forwarding from its covering prefix, therefore all
+packets that match this entry are forwarded in the same way as if the
+entry did not exist. The tunnel that is tracking this FIB entry will
+become a child dependent. The benefit to creating the entry, is that
+it now exists in the FIB node graph, so all actions that happen on its
+parents, are propagated to the host-prefix entry and consequently to
+the tunnel.
+
+FIB provides a wrapper to the sourcing of the host-prefix using a
+delegate attached to the entry, and the entry is RR sourced only once.
+. The benefit of this approach is that each time a new client tracks
+the entry it doesn't RR source it. When an entry is sourced all its
+children are updated. Thus, new clients tracking an entry is
+O(n^2). With the tracker as indirection, the entry is sourced only once.
+
+
+.. rubric:: Footnotes:
+
+.. [#f1] Or terminate in an object that transitions the packet out of
+         the FIB domain, e.g. a drop.
+.. [#f2] Optimisations
+.. [#f3] Note it is valid for either interface to be bound to a different table than table 1
+.. [#f4] The engaged reader can see the full priority list in vnet/vnet/fib/fib_entry.h
+.. [#f5] Note it is only possible to add routes via an address (i.e. a/32 or /128) not via a shorter mask prefix. There is no use case for the latter
+.. [#f6] For iBGP the via-address is the loopback address of the peer PE, for eBGP it is the adj-fib for the CE
+.. [#f7] As is the case ofr eBGP
+.. [#f8] As is the case for iBGP
+.. [#f9] If that source is relying on FIB to perform recursive resolution, then there is no reason it should do so itself.
+.. [#f10] The derived data-plane graph MUST never be cyclic
+.. [#f11] Advertised, e.g. by LDP, SR or BGP
+.. [#f12] The only case where the labels will be the same is BGP VPNv4 label allocation per-VRF
diff --git a/docs/developer/corefeatures/fib/scale.rst b/docs/developer/corefeatures/fib/scale.rst
new file mode 100644
index 00000000000..2ec8c6a85ec
--- /dev/null
+++ b/docs/developer/corefeatures/fib/scale.rst
@@ -0,0 +1,247 @@
+.. _scale:
+
+Scale
+-----
+
+The only limiting factor on FIB scale is the amount of memory
+allocated to each heap the FIB uses, and there are 2:
+
+* The main heap
+* The stats heap
+
+
+Main Heap
+^^^^^^^^^
+
+The main heap is used to allocate all memory needed for the FIB
+data-structures. Each table, created by the user, i.e. with;
+
+.. code-block:: console
+
+   $ ip table add 1
+
+or the default table, comprises 2 *ip4_fib_t* objects.
+The 'non-forwarding' *ip4_fib_t* contains all the entries in the table
+and, the 'forwarding' contains the entries that are matched against in
+the data-plane. The difference between the two sets are the entries
+that should not be matched in the data-plane.
+Each *ip4_fib_t* comprises an mtrie (for fast lookup in the data-plane)
+and a hash table per-prefix length (for lookup in the control plane).
+
+To see the amount of memory consumed by the IPv4 tables use:
+
+.. code-block:: console
+
+ vpp# sh ip fib mem
+ ipv4-VRF:0 mtrie:335744 hash:4663
+ ipv4-VRF:1 mtrie:333056 hash:3499
+ totals: mtrie:668800 hash:8162 all:676962
+
+this output shows two 'empty' (i.e. no added routes) tables. Each
+mtrie uses about 150k of memory, so each table about 300k.
+
+
+Below the output having added 1M, 2M and 4M routes respectively:
+
+.. code-block:: console
+
+ vpp# sh ip fib mem
+ ipv4-VRF:0 mtrie:335744 hash:4695
+ totals: mtrie:335744 hash:4695 all:340439
+
+.. code-block:: console
+
+ vpp# sh ip fib mem
+ ipv4-VRF:0 mtrie:5414720 hash:41177579
+ totals: mtrie:5414720 hash:41177579 all:46592299
+
+.. code-block:: console
+
+ vpp# sh ip fib mem
+ ipv4-VRF:0 mtrie:22452608 hash:168544508
+ totals: mtrie:22452608 hash:168544508 all:190997116
+
+
+IPv6 also has the concept of forwarding and non-forwarding entries,
+however for IPv6 all the forwarding entries are stored in a single
+hash table (same goes for the non-forwarding). The key to the hash
+table includes the IPv6 table-id.
+
+To see the amount of memory consumed by the IPv4 tables use:
+
+.. code-block:: console
+
+ vpp# sh ip6 fib mem
+ IPv6 Non-Forwarding Hash Table:
+ Hash table ip6 FIB non-fwding table
+     7 active elements 7 active buckets
+     1 free lists
+     0 linear search buckets
+     arena: base 7f2fe28bf000, next 803c0
+            used 525248 b (0 Mbytes) of 33554432 b (32 Mbytes)
+
+ IPv6 Forwarding Hash Table:
+ Hash table ip6 FIB fwding table
+     7 active elements 7 active buckets
+     1 free lists
+     0 linear search buckets
+     arena: base 7f2fe48bf000, next 803c0
+            used 525248 b (0 Mbytes) of 33554432 b (32 Mbytes)
+
+as we scale to 128k IPv6 entries:
+
+.. code-block:: console
+
+ vpp# sh ip6 fib mem
+ IPv6 Non-Forwarding Hash Table:
+ Hash table ip6 FIB non-fwding table
+     131079 active elements 32773 active buckets
+     2 free lists
+        [len 1] 2 free elts
+     0 linear search buckets
+     arena: base 7fed7a514000, next 4805c0
+            used 4720064 b (4 Mbytes) of 1073741824 b (1024 Mbytes)
+
+ IPv6 Forwarding Hash Table:
+ Hash table ip6 FIB fwding table
+     131079 active elements 32773 active buckets
+     2 free lists
+        [len 1] 2 free elts
+     0 linear search buckets
+     arena: base 7fedba514000, next 4805c0
+            used 4720064 b (4 Mbytes) of 1073741824 b (1024 Mbytes)
+
+and 256k:
+
+.. code-block:: console
+
+ vpp# sh ip6 fib mem
+ IPv6 Non-Forwarding Hash Table:
+ Hash table ip6 FIB non-fwding table
+     262151 active elements 65536 active buckets
+     2 free lists
+        [len 1] 6 free elts
+     0 linear search buckets
+     arena: base 7fed7a514000, next 880840
+            used 8915008 b (8 Mbytes) of 1073741824 b (1024 Mbytes)
+
+ IPv6 Forwarding Hash Table:
+ Hash table ip6 FIB fwding table
+     262151 active elements 65536 active buckets
+     2 free lists
+        [len 1] 6 free elts
+     0 linear search buckets
+     arena: base 7fedba514000, next 880840
+            used 8915008 b (8 Mbytes) of 1073741824 b (1024 Mbytes)
+
+and 1M:
+
+.. code-block:: console
+
+ vpp# sh ip6 fib mem
+ IPv6 Non-Forwarding Hash Table:
+ Hash table ip6 FIB non-fwding table
+     1048583 active elements 65536 active buckets
+     4 free lists
+        [len 1] 65533 free elts
+        [len 2] 65531 free elts
+        [len 4] 9 free elts
+     0 linear search buckets
+     arena: base 7fed7a514000, next 3882740
+            used 59254592 b (56 Mbytes) of 1073741824 b (1024 Mbytes)
+
+ IPv6 Forwarding Hash Table:
+ Hash table ip6 FIB fwding table
+     1048583 active elements 65536 active buckets
+     4 free lists
+        [len 1] 65533 free elts
+        [len 2] 65531 free elts
+        [len 4] 9 free elts
+     0 linear search buckets
+     arena: base 7fedba514000, next 3882740
+            used 59254592 b (56 Mbytes) of 1073741824 b (1024 Mbytes)
+
+as can be seen from the output the IPv6 hash-table in this case was scaled
+to 1GB and 1million prefixes has used 56MB of it.
+
+The main heap is also used to allocate objects that represent the FIB
+entries in the control and data plane (see :ref:`controlplane` and
+:ref:`dataplane`) such as *fib_entry_t* and *load_balance_t*. These come
+from the main heap because they are not protocol specific
+(i.e. they are used to represent either IPv4, IPv6 or MPLS
+entries).
+
+With 1M prefixes allocated the memory usage is:
+
+.. code-block:: console
+
+ vpp# sh fib mem
+ FIB memory
+  Tables:
+             SAFI              Number     Bytes
+         IPv4 unicast             1     33619968
+         IPv6 unicast             2     118502784
+             MPLS                 0         0
+        IPv4 multicast            1       1175
+        IPv6 multicast            1      525312
+  Nodes:
+             Name               Size  in-use /allocated   totals
+             Entry               72   1048589/ 1048589    75498408/75498408
+         Entry Source            40   1048589/ 1048589    41943560/41943560
+     Entry Path-Extensions       76      0   /    0       0/0
+        multicast-Entry         192      6   /    6       1152/1152
+           Path-list             40     18   /    18      720/720
+           uRPF-list             16     14   /    14      224/224
+             Path                72     22   /    22      1584/1584
+      Node-list elements         20   1048602/ 1048602    20972040/20972040
+        Node-list heads          8      24   /    24      192/192
+
+and with 2M
+
+.. code-block:: console
+
+ vpp# sh fib mem
+ FIB memory
+  Tables:
+             SAFI              Number     Bytes
+         IPv4 unicast             1     33619968
+         IPv6 unicast             2     252743040
+             MPLS                 0         0
+        IPv4 multicast            1       1175
+        IPv6 multicast            1      525312
+  Nodes:
+             Name               Size  in-use /allocated   totals
+             Entry               72   2097165/ 2097165    150995880/150995880
+         Entry Source            40   2097165/ 2097165    83886600/83886600
+     Entry Path-Extensions       76      0   /    0       0/0
+        multicast-Entry         192      6   /    6       1152/1152
+           Path-list             40     18   /    19      720/760
+           uRPF-list             16     18   /    18      288/288
+             Path                72     22   /    23      1584/1656
+      Node-list elements         20   2097178/ 2097178    41943560/41943560
+        Node-list heads          8      24   /    24      192/192
+
+However, the situation is not a simple as that. All of the 1M prefixes
+added above were reachable via the same next-hop, so the path-list
+(and path) they use is shared. As prefixes are added that use
+different (sets of) next-hops, the number of path-lists and paths
+requires will increase.
+
+
+Stats Heap
+^^^^^^^^^^
+
+VPP collects statistics for each route. For each route VPP collects
+byte and packet counters for packets sent to the prefix (i.e. the
+route was matched in the data-plane) and packets sent via the prefix (i.e. the
+matching prefix is reachable through it - like a BGP peer). This
+requires 4 counters per route in the stats segment.
+
+Below shows the size of the stats segment with 1M, 2M and 4M routes.
+
+.. code-block:: console
+
+ total: 1023.99M, used: 127.89M, free: 896.10M, trimmable: 830.94M
+ total: 1023.99M, used: 234.14M, free: 789.85M, trimmable: 668.15M
+ total: 1023.99M, used: 456.83M, free: 567.17M, trimmable: 388.91M
+
diff --git a/docs/developer/corefeatures/fib/thedatamodel.rst b/docs/developer/corefeatures/fib/thedatamodel.rst
new file mode 100644
index 00000000000..cd3de179814
--- /dev/null
+++ b/docs/developer/corefeatures/fib/thedatamodel.rst
@@ -0,0 +1,15 @@
+.. _thedatamodel:
+
+The Data Model
+--------------
+
+The FIB data model comprises two parts; the control-plane (CP) and the data-plane
+(DP). The CP data model represents the data that is programmed into VPP by the
+upper layers. The DP model represents how VPP derives actions to be performed on
+packets as they are switched.
+
+.. toctree::
+
+   controlplane
+   dataplane
+
diff --git a/docs/developer/corefeatures/fib/tunnels.rst b/docs/developer/corefeatures/fib/tunnels.rst
new file mode 100644
index 00000000000..d948a5e2bda
--- /dev/null
+++ b/docs/developer/corefeatures/fib/tunnels.rst
@@ -0,0 +1,62 @@
+.. _tunnels:
+
+Tunnels
+-------
+
+Tunnels share a similar property to recursive routes in that after applying the
+tunnel encapsulation, a new packet must be forwarded, i.e. forwarding is
+recursive. However, as with recursive routes the tunnel's destination is known
+beforehand, so the second lookup can be avoided if the packet can follow the
+already constructed data-plane graph for the tunnel's destination. This process
+of joining to DP graphs together is termed *stacking*.
+
+.. figure:: /_images/fib20fig11.png
+
+Figure 11: Tunnel control plane object diagram
+
+Figure 11 shows the control plane object graph for a route via a tunnel. The two
+sub-graphs for the route via the tunnel and the route for the tunnel's
+destination are shown to the right and left respectively. The red line shows the
+relationship form by stacking the two sub-graphs. The adjacency on the tunnel
+interface is termed a 'mid-chain' since it is now present in the middle of the
+graph/chain rather than its usual terminal location.
+
+The mid-chain adjacency is contributed by the gre_tunnel_t , which also becomes
+part of the FIB control-plane graph. Consequently it will be visited by a
+back-walk when the forwarding information for the tunnel's destination changes.
+This will trigger it to restack the mid-chain adjacency on the new
+*load_balance_t* contributed by the parent *fib_entry_t*.
+
+If the back-walk indicates that there is no route to the tunnel's
+destination, or that the resolving route does not meet resolution
+constraints, then the tunnel can be marked as down, and fast
+convergence can be triggered in the same way as for physical interfaces (see section ...).
+
+
+Multi-Point Tunnels
+^^^^^^^^^^^^^^^^^^^
+
+Multi-point tunnels are an example of a non-broadcast multi-access
+interface. In simple terms this means there are many peers on the link
+but it is not possible to broadcast a single message to all of them at
+once, and hence the usual peer discovery mechanism (as employed,
+e.g. by ARP) is not available. Although an *ip_neighbor_t* is a
+representation of an IP peer on a link, it is not valid in this
+context as it maps the peer's identity to its MAC address. For a
+tunnel peer it is required to map the peer's overlay address (the
+attached address, the one in the same subnet as the device) with the
+peer's underlay address (probably on the other side of the
+internet). In the P2P case where there is only one peer on the link,
+the peer's underlay address is the same as the tunnel's destination
+address.
+The data structure that represents the mapping of the peer's overlay
+with underlay address is an entry in the Tunnel Endpoint Information
+Base (TEIB); the *tieb_entry_t*. TEIB entries are created by the
+control plane (e.g. NHRP (RFC2332)).
+
+Each mid-chain adjacency on a multi-point tunnel is stacked on the
+*fib_entry_t* object that resolves the peer's underlay address. The
+glean adjacency on the tunnel resolves via a drop, since broadcasts
+are not possible. A multicast adjacency on a multi-point tunnel is
+currently a work in progress.
+
diff --git a/docs/developer/corefeatures/index.rst b/docs/developer/corefeatures/index.rst
new file mode 100644
index 00000000000..adc086e3c98
--- /dev/null
+++ b/docs/developer/corefeatures/index.rst
@@ -0,0 +1,21 @@
+.. _corefeatures:
+
+=======================
+Core Features
+=======================
+
+.. toctree::
+    :maxdepth: 1
+
+    fib/index
+    sr/index
+    punt
+    ipsec
+    bfd_doc
+    ipfix_doc
+    span_doc
+    mtu
+    sylog_doc
+    eventviewer
+    stats
+    selinux_doc
diff --git a/docs/developer/corefeatures/ipfix_doc.rst b/docs/developer/corefeatures/ipfix_doc.rst
new file mode 120000
index 00000000000..a4242e19928
--- /dev/null
+++ b/docs/developer/corefeatures/ipfix_doc.rst
@@ -0,0 +1 @@
+../../../src/vnet/ipfix-export/ipfix_doc.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/ipsec.rst b/docs/developer/corefeatures/ipsec.rst
new file mode 120000
index 00000000000..46a12cdeacc
--- /dev/null
+++ b/docs/developer/corefeatures/ipsec.rst
@@ -0,0 +1 @@
+../../../src/vnet/ipsec/ipsec.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/mtu.rst b/docs/developer/corefeatures/mtu.rst
new file mode 120000
index 00000000000..08930ffa03a
--- /dev/null
+++ b/docs/developer/corefeatures/mtu.rst
@@ -0,0 +1 @@
+../../../src/vnet/mtu.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/punt.rst b/docs/developer/corefeatures/punt.rst
new file mode 120000
index 00000000000..0a56632f671
--- /dev/null
+++ b/docs/developer/corefeatures/punt.rst
@@ -0,0 +1 @@
+../../../src/vnet/ip/punt.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/selinux_doc.rst b/docs/developer/corefeatures/selinux_doc.rst
new file mode 120000
index 00000000000..f0b3f5cf3fc
--- /dev/null
+++ b/docs/developer/corefeatures/selinux_doc.rst
@@ -0,0 +1 @@
+../../../extras/selinux/selinux_doc.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/span_doc.rst b/docs/developer/corefeatures/span_doc.rst
new file mode 120000
index 00000000000..a8a1cb3f994
--- /dev/null
+++ b/docs/developer/corefeatures/span_doc.rst
@@ -0,0 +1 @@
+../../../src/vnet/span/span_doc.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/sr/index.rst b/docs/developer/corefeatures/sr/index.rst
new file mode 100644
index 00000000000..8c87e2c00a3
--- /dev/null
+++ b/docs/developer/corefeatures/sr/index.rst
@@ -0,0 +1,14 @@
+.. _corefeature_sr:
+
+===============
+Segment routing
+===============
+
+.. toctree::
+    :maxdepth: 1
+
+    sr_doc
+    sr_localsid
+    sr_mpls
+    sr_policy
+    sr_steering
\ No newline at end of file
diff --git a/docs/developer/corefeatures/sr/sr_doc.rst b/docs/developer/corefeatures/sr/sr_doc.rst
new file mode 120000
index 00000000000..94bdfaa0de1
--- /dev/null
+++ b/docs/developer/corefeatures/sr/sr_doc.rst
@@ -0,0 +1 @@
+../../../../src/vnet/srv6/sr_doc.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/sr/sr_localsid.rst b/docs/developer/corefeatures/sr/sr_localsid.rst
new file mode 120000
index 00000000000..0492fc7532f
--- /dev/null
+++ b/docs/developer/corefeatures/sr/sr_localsid.rst
@@ -0,0 +1 @@
+../../../../src/vnet/srv6/sr_localsid.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/sr/sr_mpls.rst b/docs/developer/corefeatures/sr/sr_mpls.rst
new file mode 120000
index 00000000000..d2fe4025326
--- /dev/null
+++ b/docs/developer/corefeatures/sr/sr_mpls.rst
@@ -0,0 +1 @@
+../../../../src/vnet/srmpls/sr_doc.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/sr/sr_policy.rst b/docs/developer/corefeatures/sr/sr_policy.rst
new file mode 120000
index 00000000000..bbd87348c84
--- /dev/null
+++ b/docs/developer/corefeatures/sr/sr_policy.rst
@@ -0,0 +1 @@
+../../../../src/vnet/srv6/sr_policy.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/sr/sr_steering.rst b/docs/developer/corefeatures/sr/sr_steering.rst
new file mode 120000
index 00000000000..7edf737ab2b
--- /dev/null
+++ b/docs/developer/corefeatures/sr/sr_steering.rst
@@ -0,0 +1 @@
+../../../../src/vnet/srv6/sr_steering.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/stats.rst b/docs/developer/corefeatures/stats.rst
new file mode 120000
index 00000000000..ef1829611d9
--- /dev/null
+++ b/docs/developer/corefeatures/stats.rst
@@ -0,0 +1 @@
+../../../src/vpp/stats/stats.rst
\ No newline at end of file
diff --git a/docs/developer/corefeatures/sylog_doc.rst b/docs/developer/corefeatures/sylog_doc.rst
new file mode 120000
index 00000000000..731267b3c25
--- /dev/null
+++ b/docs/developer/corefeatures/sylog_doc.rst
@@ -0,0 +1 @@
+../../../src/vnet/syslog/sylog_doc.rst
\ No newline at end of file
diff --git a/docs/developer/devicedrivers/af_xdp.rst b/docs/developer/devicedrivers/af_xdp.rst
new file mode 120000
index 00000000000..ae41d1f5d72
--- /dev/null
+++ b/docs/developer/devicedrivers/af_xdp.rst
@@ -0,0 +1 @@
+../../../src/plugins/af_xdp/af_xdp_doc.rst
\ No newline at end of file
diff --git a/docs/developer/devicedrivers/avf.rst b/docs/developer/devicedrivers/avf.rst
new file mode 120000
index 00000000000..06a84f56418
--- /dev/null
+++ b/docs/developer/devicedrivers/avf.rst
@@ -0,0 +1 @@
+../../../src/plugins/avf/README.rst
\ No newline at end of file
diff --git a/docs/developer/devicedrivers/index.rst b/docs/developer/devicedrivers/index.rst
new file mode 100644
index 00000000000..e1194e7aa98
--- /dev/null
+++ b/docs/developer/devicedrivers/index.rst
@@ -0,0 +1,15 @@
+.. _devicedrivers:
+
+==============
+Device drivers
+==============
+
+
+
+.. toctree::
+    :maxdepth: 1
+
+    avf
+    rdma
+    vmxnet3
+    af_xdp
diff --git a/docs/developer/devicedrivers/rdma.rst b/docs/developer/devicedrivers/rdma.rst
new file mode 120000
index 00000000000..d16203c7c5a
--- /dev/null
+++ b/docs/developer/devicedrivers/rdma.rst
@@ -0,0 +1 @@
+../../../src/plugins/rdma/rdma_doc.rst
\ No newline at end of file
diff --git a/docs/developer/devicedrivers/vmxnet3.rst b/docs/developer/devicedrivers/vmxnet3.rst
new file mode 120000
index 00000000000..361b899fcc0
--- /dev/null
+++ b/docs/developer/devicedrivers/vmxnet3.rst
@@ -0,0 +1 @@
+../../../src/plugins/vmxnet3/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/index.rst b/docs/developer/extras/index.rst
new file mode 100644
index 00000000000..200caf56d3a
--- /dev/null
+++ b/docs/developer/extras/index.rst
@@ -0,0 +1,17 @@
+.. _vpp_extras:
+
+===============
+VPP extra tools
+===============
+
+.. toctree::
+    :maxdepth: 2
+
+    lcov
+    snap
+    strongswan
+    vpp_config
+    vpp_if_stats
+    vpp_stats_fs
+    vpptop
+    vcl_ldpreload
diff --git a/docs/developer/extras/lcov.rst b/docs/developer/extras/lcov.rst
new file mode 120000
index 00000000000..9f8de245ea6
--- /dev/null
+++ b/docs/developer/extras/lcov.rst
@@ -0,0 +1 @@
+../../../extras/lcov/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/snap.rst b/docs/developer/extras/snap.rst
new file mode 120000
index 00000000000..773ec9be3eb
--- /dev/null
+++ b/docs/developer/extras/snap.rst
@@ -0,0 +1 @@
+../../../extras/snap/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/strongswan.rst b/docs/developer/extras/strongswan.rst
new file mode 120000
index 00000000000..1fef5a0fdfb
--- /dev/null
+++ b/docs/developer/extras/strongswan.rst
@@ -0,0 +1 @@
+../../../extras/strongswan/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/vcl_ldpreload.rst b/docs/developer/extras/vcl_ldpreload.rst
new file mode 120000
index 00000000000..3740db2ffd2
--- /dev/null
+++ b/docs/developer/extras/vcl_ldpreload.rst
@@ -0,0 +1 @@
+../../../extras/vcl-ldpreload/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/vpp_config.rst b/docs/developer/extras/vpp_config.rst
new file mode 120000
index 00000000000..0db2e6f8ccc
--- /dev/null
+++ b/docs/developer/extras/vpp_config.rst
@@ -0,0 +1 @@
+../../../extras/vpp_config/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/vpp_if_stats.rst b/docs/developer/extras/vpp_if_stats.rst
new file mode 120000
index 00000000000..857cdee8587
--- /dev/null
+++ b/docs/developer/extras/vpp_if_stats.rst
@@ -0,0 +1 @@
+../../../extras/vpp_if_stats/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/vpp_stats_fs.rst b/docs/developer/extras/vpp_stats_fs.rst
new file mode 120000
index 00000000000..5e67c6a6818
--- /dev/null
+++ b/docs/developer/extras/vpp_stats_fs.rst
@@ -0,0 +1 @@
+../../../extras/vpp_stats_fs/README.rst
\ No newline at end of file
diff --git a/docs/developer/extras/vpptop.rst b/docs/developer/extras/vpptop.rst
new file mode 120000
index 00000000000..cf7f78e0c39
--- /dev/null
+++ b/docs/developer/extras/vpptop.rst
@@ -0,0 +1 @@
+../../../extras/vpptop/README.rst
\ No newline at end of file
diff --git a/docs/developer/plugindoc/add_plugin.rst b/docs/developer/plugindoc/add_plugin.rst
new file mode 100644
index 00000000000..cf771116095
--- /dev/null
+++ b/docs/developer/plugindoc/add_plugin.rst
@@ -0,0 +1,362 @@
+.. _add_plugin:
+
+Adding a plugin
+===============
+
+.. toctree::
+
+Strategic Choices
+_________________
+
+Plugins may implement lightly-used, experimental, or test
+functionality. In such cases, please disable the plugin by default:
+
+.. code-block:: console
+
+    /* *INDENT-OFF* */
+    VLIB_PLUGIN_REGISTER () =
+    {
+      .version = VPP_BUILD_VER,
+      .description = "Plugin Disabled by Default...",
+      .default_disabled = 1,
+    };
+    /* *INDENT-ON* */
+
+Please do not create processes, or other dynamic data structures
+unless the plugin is configured by API or debug CLI.
+
+Specifically, please don't initialize bihash tables from
+VLIB_INIT_FUNCTIONS, *especially* if the bihash template involved
+doesn't #define BIHASH_LAZY_INSTANTIATE 1.
+
+.. code-block:: console
+
+    static clib_error_t * sample_init (vlib_main_t * vm)
+    {
+      
+      /* DONT DO THIS! */
+      BV(clib_bihash_init (h, ...))
+      
+    }
+    VLIB_INIT_FUNCTION (sample_init);
+
+Instead, please add a feature_init function:
+
+.. code-block:: console
+
+    static void
+    feature_init (my_main_t * mm)
+    {
+      if (mm->feature_initialized == 0)
+        {
+          BV(clib_bihash_init)(mm->hash_table, ...)
+          /* Create Other Things, e.g a periodic process */
+          mm->feature_initialized = 1;
+        }
+    }
+
+And call it from debug CLI and API message handlers any time the feature
+is enabled.
+
+How to create a new plugin
+__________________________
+
+This section shows how a VPP developer can create a new plugin, and
+add it to VPP. We assume that we are starting from the VPP .
+
+As an example, we will use the **make-plugin.sh** tool found in
+**./extras/emacs**. make-plugin.sh is a simple wrapper for a comprehensive
+plugin generator constructed from a set of emacs-lisp skeletons.
+
+Change directory to **./src/plugins**, and run the plugin generator:
+
+.. code-block:: console
+
+    $ cd ./src/plugins
+    $ ../../extras/emacs/make-plugin.sh
+    
+    Loading /scratch/vpp-docs/extras/emacs/tunnel-c-skel.el (source)...
+    Loading /scratch/vpp-docs/extras/emacs/tunnel-decap-skel.el (source)...
+    Loading /scratch/vpp-docs/extras/emacs/tunnel-encap-skel.el (source)...
+    Loading /scratch/vpp-docs/extras/emacs/tunnel-h-skel.el (source)...
+    Loading /scratch/vpp-docs/extras/emacs/elog-4-int-skel.el (source)...
+    Loading /scratch/vpp-docs/extras/emacs/elog-4-int-track-skel.el (source)...
+    Loading /scratch/vpp-docs/extras/emacs/elog-enum-skel.el (source)...
+    Loading /scratch/vpp-docs/extras/emacs/elog-one-datum-skel.el (source)...
+    Plugin name: myplugin
+    Dispatch type [dual or qs]: dual
+    (Shell command succeeded with no output)
+
+    OK...
+
+The plugin generator script asks two questions: the name of the
+plugin, and which of two dispatch types to use. Since the plugin name
+finds its way into quite a number of places - filenames, typedef
+names, graph arc names - it pays to think for a moment.
+
+The dispatch type refers to the coding pattern used to construct
+**node.c**, the *pro forma* data-plane node. The **dual** option
+constructs a dual-single loop pair with speculative enqueueing. This
+is the traditional coding pattern for load-store intensive graph
+nodes.
+
+The **qs** option generates a quad-single loop pair which uses
+vlib_get_buffers(...) and vlib_buffer_enqueue_to_next(...). These
+operators make excellent use of available SIMD vector unit
+operations. It's very simple to change a quad-single loop-pair to a
+dual-single loop pair if you decide to do so later.
+
+Generated Files
+---------------
+
+Here are the generated files. We'll go through them in a moment.
+
+.. code-block:: console
+
+    $ cd ./myplugin
+    $ ls
+    CMakeLists.txt  myplugin.api  myplugin.c  myplugin.h
+    myplugin_periodic.c  myplugin_test.c  node.c  setup.pg
+
+Due to recent build system improvements, you **don't** need to touch
+any other files to integrate your new plugin into the vpp build. Simply
+rebuild your workspace from scratch, and the new plugin will appear.
+
+Rebuild your workspace
+----------------------
+
+This is the straightforward way to reconfigure and rebuild your workspace:
+
+.. code-block:: console
+
+    $ cd 
+    $ make rebuild [or rebuild-release]
+
+Thanks to ccache, this operation doesn't take an annoying amount of time.
+
+Sanity check: run vpp
+---------------------
+
+As a quick sanity check, run vpp and make sure that
+"myplugin_plugin.so" and "myplugin_test_plugin.so" are loaded:
+
+.. code-block:: console
+
+    $ cd 
+    $ make run
+    
+    load_one_plugin:189: Loaded plugin: myplugin_plugin.so (myplugin description goes here)
+    
+    load_one_vat_plugin:67: Loaded plugin: myplugin_test_plugin.so
+    
+    DBGvpp#
+
+If this simple test fails, please seek assistance.
+
+Generated Files in Detail
+_________________________
+
+This section discusses the generated files in some detail. It's fine to
+skim this section, and return later for more detail.
+
+CMakeLists.txt
+--------------
+
+This is the build system recipe for building your plugin. Please fix
+the copyright notice:
+
+.. code-block:: console
+
+    # Copyright (c)  
+
+The rest of the build recipe is pretty simple:
+
+.. code-block:: CMake
+
+    add_vpp_plugin (myplugin
+    SOURCES
+    myplugin.c
+    node.c
+    myplugin_periodic.c
+    myplugin.h
+
+    MULTIARCH_SOURCES
+    node.c
+
+    API_FILES
+    myplugin.api
+
+    API_TEST_SOURCES
+    myplugin_test.c
+    )
+
+As you can see, the build recipe consists of several lists of
+files. **SOURCES** is a list of C source files. **API_FILES** is a
+list of the plugin's binary API definition files [one such file is
+usually plenty], and so forth.
+
+**MULTIARCH_SOURCES** lists data plane graph node dispatch function
+source files considered to be performance-critical. Specific functions
+in these files are compiled multiple times, so that they can leverage
+CPU-specific features. More on this in a moment.
+
+If you add source files, simply add them to the indicated list(s).
+
+myplugin.h
+----------
+
+This is the primary #include file for the new plugin. Among other
+things, it defines the plugin's *main_t* data structure. This is the
+right place to add problem-specific data structures. Please **resist
+the temptation** to create a set of static or [worse yet] global
+variables in your plugin. Refereeing name-collisions between plugins
+is not anyone's idea of a good time.
+
+myplugin.c
+----------
+
+For want of a better way to describe it, myplugin.c is the vpp plugin
+equivalent of "main.c". Its job is to hook the plugin into the vpp
+binary API message dispatcher, and to add its messages to vpp's global
+"message-name_crc" hash table. See "myplugin_init (...")"
+
+Vpp itself uses dlsym(...) to track down the vlib_plugin_registration_t
+generated by the VLIB_PLUGIN_REGISTER macro:
+
+.. code-block:: C
+
+    VLIB_PLUGIN_REGISTER () =
+      {
+        .version = VPP_BUILD_VER,
+        .description = "myplugin plugin description goes here",
+      };
+
+Vpp only loads .so files from the plugin directory which contain an
+instance of this data structure.
+
+You can enable or disable specific vpp plugins from the command
+line. By default, plugins are loaded. To change that behavior, set
+default_disabled in the macro VLIB_PLUGIN_REGISTER:
+
+.. code-block:: C
+
+    VLIB_PLUGIN_REGISTER () =
+      {
+        .version = VPP_BUILD_VER,
+        .default_disabled = 1
+        .description = "myplugin plugin description goes here",
+      };
+
+The boilerplate generator places the graph node dispatch function
+onto the "device-input" feature arc. This may or may not be useful.
+
+.. code-block:: C
+
+    VNET_FEATURE_INIT (myplugin, static) =
+    {
+      .arc_name = "device-input",
+      .node_name = "myplugin",
+      .runs_before = VNET_FEATURES ("ethernet-input"),
+    };
+
+As given by the plugin generator, myplugin.c contains the binary API
+message handler for a generic "please enable my feature on such and
+such an interface" binary API message. As you'll see, setting up the
+vpp message API tables is simple. Big fat warning: the scheme is
+intolerant of minor mistakes. Example: forgetting to add
+mainp->msg_id_base can lead to very confusing failures.
+
+If you stick to modifying the generated boilerplate with care -
+instead of trying to build code from first principles - you'll save
+yourself a bunch of time and aggravation
+
+myplugin_test.c
+---------------
+
+This file contains binary API message **generation** code, which is
+compiled into a separate .so file. The "vpp_api_test" program loads
+these plugins, yielding immediate access to your plugin APIs for
+external client binary API testing.
+
+vpp itself loads test plugins, and makes the code available via the
+"binary-api" debug CLI. This is a favorite way to unit-test binary
+APIs prior to integration testing.
+
+node.c
+------
+
+This is the generated graph node dispatch function. You'll need to
+rewrite it to solve the problem at hand. It will save considerable
+time and aggravation to retain the **structure** of the node dispatch
+function.
+
+Even for an expert, it's a waste of time to reinvent the *loop
+structure*, enqueue patterns, and so forth. Simply tear out and
+replace the specimen 1x, 2x, 4x packet processing code with code
+relevant to the problem you're trying to solve.
+
+myplugin.api
+------------
+
+This contains the API message definition. Here we only have defined
+a single one named ``myplugin_enable_disable`` and an implicit
+``myplugin_enable_disable_reply`` containing only a return value due
+to the ``autoreply`` keyword.
+
+The syntax reference for ``.api`` files can be found at VPP API Language
+
+Addressing the binary API with this message will run the handler defined
+in ``myplugin.c`` as ``vl_api_myplugin_enable_disable_t_handler``.
+It will receive a message pointer ``*mp`` which is the struct defined
+in ``myplugin.api`` and should return another message pointer ``*rmp``,
+of the reply type. That's what ``REPLY_MACRO`` does.
+
+To be noted, all API messages are in net-endian and vpp is host-endian,
+so you will need to use :
+
+* ``u32 value = ntohl(mp->value);``
+* ``rmp->value = htonl(value);``
+
+You can now use this API with :ref:`GoLang bindings `
+
+myplugin_periodic.c
+-------------------
+
+This defines a VPP process, a routine that will run indefinitely and
+be woken up intermittently, here to process plugin events.
+
+To be noted, vlib_processes aren't thread-safe, and data structures
+should be locked when shared between workers.
+
+Plugin "Friends with Benefits"
+------------------------------
+
+In vpp VLIB_INIT_FUNCTION functions, It's reasonably common to see a
+specific init function invoke other init functions:
+
+.. code-block:: C
+
+    if ((error = vlib_call_init_function (vm, some_other_init_function))
+       return error;
+
+In the case where one plugin needs to call a init function in another
+plugin, use the vlib_call_plugin_init_function macro:
+
+.. code-block:: C
+
+    if ((error = vlib_call_plugin_init_function (vm, "otherpluginname", some_init_function))
+       return error;
+
+This allows sequencing between plugin init functions.
+
+If you wish to obtain a pointer to a symbol in another plugin, use the
+vlib_plugin_get_symbol(...) API:
+
+.. code-block:: C
+
+    void *p = vlib_get_plugin_symbol ("plugin_name", "symbol");
+
+More Examples
+-------------
+
+For more information you can read many example plugins in the directory "./src/plugins".
diff --git a/docs/developer/plugindoc/handoffdemo.rst b/docs/developer/plugindoc/handoffdemo.rst
new file mode 120000
index 00000000000..d9eaebf3c02
--- /dev/null
+++ b/docs/developer/plugindoc/handoffdemo.rst
@@ -0,0 +1 @@
+../../../src/examples/handoffdemo/handoffdemo.rst
\ No newline at end of file
diff --git a/docs/developer/plugindoc/index.rst b/docs/developer/plugindoc/index.rst
new file mode 100644
index 00000000000..2fcddb4cc5b
--- /dev/null
+++ b/docs/developer/plugindoc/index.rst
@@ -0,0 +1,13 @@
+.. _add_new_plugin:
+
+==============================
+Adding a new plugin or feature
+==============================
+
+
+.. toctree::
+    :maxdepth: 2
+
+    add_plugin
+    sample_plugin_doc
+    handoffdemo
diff --git a/docs/developer/plugindoc/sample_plugin_doc.rst b/docs/developer/plugindoc/sample_plugin_doc.rst
new file mode 120000
index 00000000000..5f4c67accfa
--- /dev/null
+++ b/docs/developer/plugindoc/sample_plugin_doc.rst
@@ -0,0 +1 @@
+../../../src/examples/sample-plugin/sample_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/acl_hash_lookup.rst b/docs/developer/plugins/acl_hash_lookup.rst
new file mode 120000
index 00000000000..934be2816ba
--- /dev/null
+++ b/docs/developer/plugins/acl_hash_lookup.rst
@@ -0,0 +1 @@
+../../../src/plugins/acl/acl_hash_lookup_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/acl_lookup_context.rst b/docs/developer/plugins/acl_lookup_context.rst
new file mode 120000
index 00000000000..e9e15ed3684
--- /dev/null
+++ b/docs/developer/plugins/acl_lookup_context.rst
@@ -0,0 +1 @@
+../../../src/plugins/acl/acl_lookup_context.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/acl_multicore.rst b/docs/developer/plugins/acl_multicore.rst
new file mode 120000
index 00000000000..564b6a10876
--- /dev/null
+++ b/docs/developer/plugins/acl_multicore.rst
@@ -0,0 +1 @@
+../../../src/plugins/acl/acl_multicore_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/bufmon_doc.rst b/docs/developer/plugins/bufmon_doc.rst
new file mode 120000
index 00000000000..3578898d323
--- /dev/null
+++ b/docs/developer/plugins/bufmon_doc.rst
@@ -0,0 +1 @@
+../../../src/plugins/bufmon/bufmon_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/cnat.rst b/docs/developer/plugins/cnat.rst
new file mode 120000
index 00000000000..c261d501228
--- /dev/null
+++ b/docs/developer/plugins/cnat.rst
@@ -0,0 +1 @@
+../../../src/plugins/cnat/cnat.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/dhcp6_pd.rst b/docs/developer/plugins/dhcp6_pd.rst
new file mode 120000
index 00000000000..80bd946c952
--- /dev/null
+++ b/docs/developer/plugins/dhcp6_pd.rst
@@ -0,0 +1 @@
+../../../src/plugins/dhcp/dhcp6_pd_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/flowprobe.rst b/docs/developer/plugins/flowprobe.rst
new file mode 120000
index 00000000000..7e2fbd2f079
--- /dev/null
+++ b/docs/developer/plugins/flowprobe.rst
@@ -0,0 +1 @@
+../../../src/plugins/flowprobe/flowprobe_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/index.rst b/docs/developer/plugins/index.rst
new file mode 100644
index 00000000000..9aedc89bdca
--- /dev/null
+++ b/docs/developer/plugins/index.rst
@@ -0,0 +1,41 @@
+.. _vpp_plugins:
+
+=======
+Plugins
+=======
+
+vlib implements a straightforward plug-in DLL mechanism. VLIB client
+applications specify a directory to search for plug-in .DLLs, and a name
+filter to apply (if desired). VLIB needs to load plug-ins very early.
+
+Once loaded, the plug-in DLL mechanism uses dlsym to find and verify a
+vlib\_plugin\_registration data structure in the newly-loaded plug-in.
+
+For more on plugins please refer to :ref:`add_plugin`.
+
+
+.. toctree::
+    :maxdepth: 2
+
+    quic
+    cnat
+    lcp
+    srv6/index
+    marvell
+    lldp
+    nat64
+    nat44_ei_ha
+    pnat
+    lb
+    lacp
+    flowprobe
+    map_lw4o6
+    mdata
+    dhcp6_pd
+    ioam
+    wireguard
+    srtp
+    acl_multicore
+    acl_hash_lookup
+    acl_lookup_context
+    bufmon_doc
diff --git a/docs/developer/plugins/ioam.rst b/docs/developer/plugins/ioam.rst
new file mode 120000
index 00000000000..7a8faf6fb7a
--- /dev/null
+++ b/docs/developer/plugins/ioam.rst
@@ -0,0 +1 @@
+../../../src/plugins/ioam/ioam_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/lacp.rst b/docs/developer/plugins/lacp.rst
new file mode 120000
index 00000000000..4d410243a8b
--- /dev/null
+++ b/docs/developer/plugins/lacp.rst
@@ -0,0 +1 @@
+../../../src/plugins/lacp/lacp_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/lb.rst b/docs/developer/plugins/lb.rst
new file mode 120000
index 00000000000..de3183a8b44
--- /dev/null
+++ b/docs/developer/plugins/lb.rst
@@ -0,0 +1 @@
+../../../src/plugins/lb/lb_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/lcp.rst b/docs/developer/plugins/lcp.rst
new file mode 120000
index 00000000000..2fbbe1f4db6
--- /dev/null
+++ b/docs/developer/plugins/lcp.rst
@@ -0,0 +1 @@
+../../../src/plugins/linux-cp/lcp.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/lldp.rst b/docs/developer/plugins/lldp.rst
new file mode 120000
index 00000000000..b913eca926c
--- /dev/null
+++ b/docs/developer/plugins/lldp.rst
@@ -0,0 +1 @@
+../../../src/plugins/lldp/lldp_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/map_lw4o6.rst b/docs/developer/plugins/map_lw4o6.rst
new file mode 120000
index 00000000000..427f189082e
--- /dev/null
+++ b/docs/developer/plugins/map_lw4o6.rst
@@ -0,0 +1 @@
+../../../src/plugins/map/map_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/marvell.rst b/docs/developer/plugins/marvell.rst
new file mode 120000
index 00000000000..28f0cd0f664
--- /dev/null
+++ b/docs/developer/plugins/marvell.rst
@@ -0,0 +1 @@
+../../../src/plugins/marvell/README.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/mdata.rst b/docs/developer/plugins/mdata.rst
new file mode 120000
index 00000000000..87e5c929bc4
--- /dev/null
+++ b/docs/developer/plugins/mdata.rst
@@ -0,0 +1 @@
+../../../src/plugins/mdata/mdata_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/nat44_ei_ha.rst b/docs/developer/plugins/nat44_ei_ha.rst
new file mode 120000
index 00000000000..a8a00f40218
--- /dev/null
+++ b/docs/developer/plugins/nat44_ei_ha.rst
@@ -0,0 +1 @@
+../../../src/plugins/nat/nat44-ei/nat44_ei_ha_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/nat64.rst b/docs/developer/plugins/nat64.rst
new file mode 120000
index 00000000000..22c6bbea80d
--- /dev/null
+++ b/docs/developer/plugins/nat64.rst
@@ -0,0 +1 @@
+../../../src/plugins/nat/nat64/nat64_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/pnat.rst b/docs/developer/plugins/pnat.rst
new file mode 120000
index 00000000000..4a8da6ef31a
--- /dev/null
+++ b/docs/developer/plugins/pnat.rst
@@ -0,0 +1 @@
+../../../src/plugins/nat/pnat/pnat.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/quic.rst b/docs/developer/plugins/quic.rst
new file mode 120000
index 00000000000..ffe53429571
--- /dev/null
+++ b/docs/developer/plugins/quic.rst
@@ -0,0 +1 @@
+../../../src/plugins/quic/quic_plugin.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srtp.rst b/docs/developer/plugins/srtp.rst
new file mode 120000
index 00000000000..51013cce036
--- /dev/null
+++ b/docs/developer/plugins/srtp.rst
@@ -0,0 +1 @@
+../../../src/plugins/srtp/srtp_plugin.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srv6/ad_flow_plugin_doc.rst b/docs/developer/plugins/srv6/ad_flow_plugin_doc.rst
new file mode 120000
index 00000000000..f944884a992
--- /dev/null
+++ b/docs/developer/plugins/srv6/ad_flow_plugin_doc.rst
@@ -0,0 +1 @@
+../../../../src/plugins/srv6-ad-flow/ad_flow_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srv6/ad_plugin_doc.rst b/docs/developer/plugins/srv6/ad_plugin_doc.rst
new file mode 120000
index 00000000000..46ec8a8899e
--- /dev/null
+++ b/docs/developer/plugins/srv6/ad_plugin_doc.rst
@@ -0,0 +1 @@
+../../../../src/plugins/srv6-ad/ad_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srv6/am_plugin_doc.rst b/docs/developer/plugins/srv6/am_plugin_doc.rst
new file mode 120000
index 00000000000..842426adc54
--- /dev/null
+++ b/docs/developer/plugins/srv6/am_plugin_doc.rst
@@ -0,0 +1 @@
+../../../../src/plugins/srv6-am/am_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srv6/as_plugin_doc.rst b/docs/developer/plugins/srv6/as_plugin_doc.rst
new file mode 120000
index 00000000000..90dd28e6606
--- /dev/null
+++ b/docs/developer/plugins/srv6/as_plugin_doc.rst
@@ -0,0 +1 @@
+../../../../src/plugins/srv6-as/as_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srv6/index.rst b/docs/developer/plugins/srv6/index.rst
new file mode 100644
index 00000000000..eb8f3e815a2
--- /dev/null
+++ b/docs/developer/plugins/srv6/index.rst
@@ -0,0 +1,16 @@
+.. _dplugins_srv6:
+
+============
+SRv6 Plugins
+============
+
+.. toctree::
+    :maxdepth: 2
+
+    ad_flow_plugin_doc
+    ad_plugin_doc
+    am_plugin_doc
+    as_plugin_doc
+    mobile_plugin_doc
+    runner_doc
+    srv6_sample_localsid_doc
diff --git a/docs/developer/plugins/srv6/mobile_plugin_doc.rst b/docs/developer/plugins/srv6/mobile_plugin_doc.rst
new file mode 120000
index 00000000000..546f5f2cc14
--- /dev/null
+++ b/docs/developer/plugins/srv6/mobile_plugin_doc.rst
@@ -0,0 +1 @@
+../../../../src/plugins/srv6-mobile/mobile_plugin_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srv6/runner_doc.rst b/docs/developer/plugins/srv6/runner_doc.rst
new file mode 120000
index 00000000000..16217038309
--- /dev/null
+++ b/docs/developer/plugins/srv6/runner_doc.rst
@@ -0,0 +1 @@
+../../../../src/plugins/srv6-mobile/extra/runner_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/srv6/srv6_sample_localsid_doc.rst b/docs/developer/plugins/srv6/srv6_sample_localsid_doc.rst
new file mode 120000
index 00000000000..db924565db4
--- /dev/null
+++ b/docs/developer/plugins/srv6/srv6_sample_localsid_doc.rst
@@ -0,0 +1 @@
+../../../../src/examples/srv6-sample-localsid/srv6_sample_localsid_doc.rst
\ No newline at end of file
diff --git a/docs/developer/plugins/wireguard.rst b/docs/developer/plugins/wireguard.rst
new file mode 120000
index 00000000000..3cba6b438c3
--- /dev/null
+++ b/docs/developer/plugins/wireguard.rst
@@ -0,0 +1 @@
+../../../src/plugins/wireguard/README.rst
\ No newline at end of file
diff --git a/docs/developer/tests/overview.rst b/docs/developer/tests/overview.rst
new file mode 100644
index 00000000000..cc9836e3992
--- /dev/null
+++ b/docs/developer/tests/overview.rst
@@ -0,0 +1,450 @@
+.. _unittest: https://docs.python.org/2/library/unittest.html
+.. _TestCase: https://docs.python.org/2/library/unittest.html#unittest.TestCase
+.. _AssertionError: https://docs.python.org/2/library/exceptions.html#exceptions.AssertionError
+.. _SkipTest: https://docs.python.org/2/library/unittest.html#unittest.SkipTest
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
+.. _scapy: http://www.secdev.org/projects/scapy/
+.. _logging: https://docs.python.org/2/library/logging.html
+.. _process: https://docs.python.org/2/library/multiprocessing.html#the-process-class
+.. _pipes: https://docs.python.org/2/library/multiprocessing.html#multiprocessing.Pipe
+.. _managed: https://docs.python.org/2/library/multiprocessing.html#managers
+
+.. |vtf| replace:: VPP Test Framework
+
+|vtf|
+=====
+
+.. contents::
+   :local:
+   :depth: 1
+
+Overview
+########
+
+The goal of the |vtf| is to ease writing, running and debugging
+unit tests for the VPP. For this, python was chosen as a high level language
+allowing rapid development with scapy_ providing the necessary tool for creating
+and dissecting packets.
+
+Anatomy of a test case
+######################
+
+Python's unittest_ is used as the base framework upon which the VPP test
+framework is built. A test suite in the |vtf| consists of multiple classes
+derived from `VppTestCase`, which is itself derived from TestCase_.
+The test class defines one or more test functions, which act as test cases.
+
+Function flow when running a test case is:
+
+1. `setUpClass `:
+   This function is called once for each test class, allowing a one-time test
+   setup to be executed. If this functions throws an exception,
+   none of the test functions are executed.
+2. `setUp `:
+   The setUp function runs before each of the test functions. If this function
+   throws an exception other than AssertionError_ or SkipTest_, then this is
+   considered an error, not a test failure.
+3. *test_*:
+   This is the guts of the test case. It should execute the test scenario
+   and use the various assert functions from the unittest framework to check
+   necessary. Multiple test_ methods can exist in a test case.
+4. `tearDown `:
+   The tearDown function is called after each test function with the purpose
+   of doing partial cleanup.
+5. `tearDownClass `:
+   Method called once after running all of the test functions to perform
+   the final cleanup.
+
+Logging
+#######
+
+Each test case has a logger automatically created for it, stored in
+'logger' property, based on logging_. Use the logger's standard methods
+debug(), info(), error(), ... to emit log messages to the logger.
+
+All the log messages go always into a log file in temporary directory
+(see below).
+
+To control the messages printed to console, specify the V= parameter.
+
+.. code-block:: shell
+
+   make test         # minimum verbosity
+   make test V=1     # moderate verbosity
+   make test V=2     # maximum verbosity
+
+Parallel test execution
+#######################
+
+|vtf| test suites can be run in parallel. Each test suite is executed
+in a separate process spawned by Python multiprocessing process_.
+
+The results from child test suites are sent to parent through pipes_, which are
+aggregated and summarized at the end of the run.
+
+Stdout, stderr and logs logged in child processes are redirected to individual
+parent managed_ queues. The data from these queues are then emitted to stdout
+of the parent process in the order the test suites have finished. In case there
+are no finished test suites (such as at the beginning of the run), the data
+from last started test suite are emitted in real time.
+
+To enable parallel test run, specify the number of parallel processes:
+
+.. code-block:: shell
+
+   make test TEST_JOBS=n       # at most n processes will be spawned
+   make test TEST_JOBS=auto    # chosen based on the number of cores
+                               # and the size of shared memory
+
+Test temporary directory and VPP life cycle
+###########################################
+
+Test separation is achieved by separating the test files and vpp instances.
+Each test creates a temporary directory and it's name is used to create
+a shared memory prefix which is used to run a VPP instance.
+The temporary directory name contains the testcase class name for easy
+reference, so for testcase named 'TestVxlan' the directory could be named
+e.g. vpp-unittest-TestVxlan-UNUP3j.
+This way, there is no conflict between any other VPP instances running
+on the box and the test VPP. Any temporary files created by the test case
+are stored in this temporary test directory.
+
+The test temporary directory holds the following interesting files:
+
+* log.txt - this contains the logger output on max verbosity
+* pg*_in.pcap - last injected packet stream into VPP, named after the interface,
+  so for pg0, the file will be named pg0_in.pcap
+* pg*_out.pcap - last capture file created by VPP for interface, similarly,
+  named after the interface, so for e.g. pg1, the file will be named
+  pg1_out.pcap
+* history files - whenever the capture is restarted or a new stream is added,
+  the existing files are rotated and renamed, so all the pcap files
+  are always saved for later debugging if needed
+* core - if vpp dumps a core, it'll be stored in the temporary directory
+* vpp_stdout.txt - file containing output which vpp printed to stdout
+* vpp_stderr.txt - file containing output which vpp printed to stderr
+
+*NOTE*: existing temporary directories named vpp-unittest-* are automatically
+removed when invoking 'make test*' or 'make retest*' to keep the temporary
+directory clean.
+
+Virtual environment
+###################
+
+Virtualenv_ is a python module which provides a means to create an environment
+containing the dependencies required by the |vtf|, allowing a separation
+from any existing system-wide packages. |vtf|'s Makefile automatically
+creates a virtualenv_ inside build-root and installs the required packages
+in that environment. The environment is entered whenever executing a test
+via one of the make test targets.
+
+Naming conventions
+##################
+
+Most unit tests do some kind of packet manipulation - sending and receiving
+packets between VPP and virtual hosts connected to the VPP. Referring
+to the sides, addresses, etc. is always done as if looking from the VPP side,
+thus:
+
+* *local_* prefix is used for the VPP side.
+  So e.g. `local_ip4 ` address is the IPv4 address
+  assigned to the VPP interface.
+* *remote_* prefix is used for the virtual host side.
+  So e.g. `remote_mac ` address is the MAC address
+  assigned to the virtual host connected to the VPP.
+
+Automatically generated addresses
+#################################
+
+To send packets, one needs to typically provide some addresses, otherwise
+the packets will be dropped. The interface objects in |vtf| automatically
+provide addresses based on (typically) their indexes, which ensures
+there are no conflicts and eases debugging by making the addressing scheme
+consistent.
+
+The developer of a test case typically doesn't need to work with the actual
+numbers, rather using the properties of the objects. The addresses typically
+come in two flavors: '
' and '
n' - note the 'n' suffix.
+The former address is a Python string, while the latter is translated using
+socket.inet_pton to raw format in network byte order - this format is suitable
+for passing as an argument to VPP APIs.
+
+e.g. for the IPv4 address assigned to the VPP interface:
+
+* local_ip4 - Local IPv4 address on VPP interface (string)
+* local_ip4n - Local IPv4 address - raw, suitable as API parameter.
+
+These addresses need to be configured in VPP to be usable using e.g.
+`VppInterface.config_ip4` API. Please see the documentation to
+`VppInterface` for more details.
+
+By default, there is one remote address of each kind created for L3:
+remote_ip4 and remote_ip6. If the test needs more addresses, because it's
+simulating more remote hosts, they can be generated using
+`generate_remote_hosts` API and the entries for them inserted into the ARP
+table using `configure_ipv4_neighbors` API.
+
+Packet flow in the |vtf|
+########################
+
+Test framework -> VPP
+~~~~~~~~~~~~~~~~~~~~~
+
+|vtf| doesn't send any packets to VPP directly. Traffic is instead injected
+using packet-generator interfaces, represented by the `VppPGInterface` class.
+Packets are written into a temporary .pcap file, which is then read by the VPP
+and the packets are injected into the VPP world.
+
+To add a list of packets to an interface, call the `VppPGInterface.add_stream`
+method on that interface. Once everything is prepared, call `pg_start` method to
+start the packet generator on the VPP side.
+
+VPP -> test framework
+~~~~~~~~~~~~~~~~~~~~~
+
+Similarly, VPP doesn't send any packets to |vtf| directly. Instead, packet
+capture feature is used to capture and write traffic to a temporary .pcap file,
+which is then read and analyzed by the |vtf|.
+
+The following APIs are available to the test case for reading pcap files.
+
+* `VppPGInterface.get_capture`: this API is suitable for bulk & batch
+  style of test, where a list of packets is prepared & sent, then the
+  received packets are read and verified. The API needs the number of
+  packets which are expected to be captured (ignoring filtered
+  packets - see below) to know when the pcap file is completely
+  written by the VPP. If using packet infos for verifying packets,
+  then the counts of the packet infos can be automatically used by
+  `VppPGInterface.get_capture` to get the proper count (in this case
+  the default value None can be supplied as expected_count or omitted
+  altogether).
+* `VppPGInterface.wait_for_packet`: this API is suitable for
+  interactive style of test, e.g. when doing session management,
+  three-way handshakes, etc. This API waits for and returns a single
+  packet, keeping the capture file in place and remembering
+  context. Repeated invocations return following packets (or raise
+  Exception if timeout is reached) from the same capture file (=
+  packets arriving on the same interface).
+
+*NOTE*: it is not recommended to mix these APIs unless you understand
+how they work internally. None of these APIs rotate the pcap capture
+file, so calling e.g. `VppPGInterface.get_capture` after
+`VppPGInterface.wait_for_packet` will return already read packets.  It
+is safe to switch from one API to another after calling
+`VppPGInterface.enable_capture` as that API rotates the capture file.
+
+Automatic filtering of packets:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Both APIs (`VppPGInterface.get_capture` and
+`VppPGInterface.wait_for_packet`) by default filter the packet
+capture, removing known uninteresting packets from it - these are IPv6
+Router Advertisements and IPv6 Router Alerts. These packets are
+unsolicited and from the point of |vtf| are random. If a test wants
+to receive these packets, it should specify either None or a custom
+filtering function as the value to the 'filter_out_fn' argument.
+
+Common API flow for sending/receiving packets:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+We will describe a simple scenario, where packets are sent from pg0 to pg1
+interface, assuming that the interfaces were created using
+`create_pg_interfaces` API.
+
+1. Create a list of packets for pg0::
+
+     packet_count = 10
+     packets = create_packets(src=self.pg0, dst=self.pg1,
+                              count=packet_count)
+
+2. Add that list of packets to the source interface::
+
+     self.pg0.add_stream(packets)
+
+3. Enable capture on the destination interface::
+
+     self.pg1.enable_capture()
+
+4. Start the packet generator::
+
+     self.pg_start()
+
+5. Wait for capture file to appear and read it::
+
+     capture = self.pg1.get_capture(expected_count=packet_count)
+
+6. Verify packets match sent packets::
+
+     self.verify_capture(send=packets, captured=capture)
+
+Test framework objects
+######################
+
+The following objects provide VPP abstraction and provide a means to do
+common tasks easily in the test cases.
+
+* `VppInterface`: abstract class representing generic VPP interface
+  and contains some common functionality, which is then used by derived classes
+* `VppPGInterface`: class representing VPP packet-generator interface.
+  The interface is created/destroyed when the object is created/destroyed.
+* `VppSubInterface`: VPP sub-interface abstract class, containing common
+  functionality for e.g. `VppDot1QSubint` and `VppDot1ADSubint` classes
+
+How VPP APIs/CLIs are called
+############################
+
+Vpp provides python bindings in a python module called vpp-papi, which the test
+framework installs in the virtual environment. A shim layer represented by
+the `VppPapiProvider` class is built on top of the vpp-papi, serving these
+purposes:
+
+1. Automatic return value checks:
+   After each API is called, the return value is checked against the expected
+   return value (by default 0, but can be overridden) and an exception
+   is raised if the check fails.
+2. Automatic call of hooks:
+
+   a. `before_cli ` and `before_api ` hooks
+      are used for debug logging and stepping through the test
+   b. `after_cli ` and `after_api ` hooks
+      are used for monitoring the vpp process for crashes
+3. Simplification of API calls:
+   Many of the VPP APIs take a lot of parameters and by providing sane defaults
+   for these, the API is much easier to use in the common case and the code is
+   more readable. E.g. ip_add_del_route API takes ~25 parameters, of which
+   in the common case, only 3 are needed.
+
+Utility methods
+###############
+
+Some interesting utility methods are:
+
+* `ppp`: 'Pretty Print Packet' - returns a string containing the same output
+  as Scapy's packet.show() would print
+* `ppc`: 'Pretty Print Capture' - returns a string containing printout of
+  a capture (with configurable limit on the number of packets printed from it)
+  using `ppp`
+
+*NOTE*: Do not use Scapy's packet.show() in the tests, because it prints
+the output to stdout. All output should go to the logger associated with
+the test case.
+
+Example: how to add a new test
+##############################
+
+In this example, we will describe how to add a new test case which tests
+basic IPv4 forwarding.
+
+1. Add a new file called test_ip4_fwd.py in the test directory, starting
+   with a few imports::
+
+     from framework import VppTestCase
+     from scapy.layers.l2 import Ether
+     from scapy.packet import Raw
+     from scapy.layers.inet import IP, UDP
+     from random import randint
+
+2. Create a class inherited from the VppTestCase::
+
+     class IP4FwdTestCase(VppTestCase):
+         """ IPv4 simple forwarding test case """
+
+3. Add a setUpClass function containing the setup needed for our test to run::
+
+         @classmethod
+         def setUpClass(self):
+             super(IP4FwdTestCase, self).setUpClass()
+             self.create_pg_interfaces(range(2))  #  create pg0 and pg1
+             for i in self.pg_interfaces:
+                 i.admin_up()  # put the interface up
+                 i.config_ip4()  # configure IPv4 address on the interface
+                 i.resolve_arp()  # resolve ARP, so that we know VPP MAC
+
+4. Create a helper method to create the packets to send::
+
+         def create_stream(self, src_if, dst_if, count):
+             packets = []
+             for i in range(count):
+                 # create packet info stored in the test case instance
+                 info = self.create_packet_info(src_if, dst_if)
+                 # convert the info into packet payload
+                 payload = self.info_to_payload(info)
+                 # create the packet itself
+                 p = (Ether(dst=src_if.local_mac, src=src_if.remote_mac) /
+                      IP(src=src_if.remote_ip4, dst=dst_if.remote_ip4) /
+                      UDP(sport=randint(1000, 2000), dport=5678) /
+                      Raw(payload))
+                 # store a copy of the packet in the packet info
+                 info.data = p.copy()
+                 # append the packet to the list
+                 packets.append(p)
+
+             # return the created packet list
+             return packets
+
+5. Create a helper method to verify the capture::
+
+         def verify_capture(self, src_if, dst_if, capture):
+             packet_info = None
+             for packet in capture:
+                 try:
+                     ip = packet[IP]
+                     udp = packet[UDP]
+                     # convert the payload to packet info object
+                     payload_info = self.payload_to_info(packet[Raw])
+                     # make sure the indexes match
+                     self.assert_equal(payload_info.src, src_if.sw_if_index,
+                                       "source sw_if_index")
+                     self.assert_equal(payload_info.dst, dst_if.sw_if_index,
+                                       "destination sw_if_index")
+                     packet_info = self.get_next_packet_info_for_interface2(
+                                       src_if.sw_if_index,
+                                       dst_if.sw_if_index,
+                                       packet_info)
+                     # make sure we didn't run out of saved packets
+                     self.assertIsNotNone(packet_info)
+                     self.assert_equal(payload_info.index, packet_info.index,
+                                       "packet info index")
+                     saved_packet = packet_info.data  # fetch the saved packet
+                     # assert the values match
+                     self.assert_equal(ip.src, saved_packet[IP].src,
+                                       "IP source address")
+                     # ... more assertions here
+                     self.assert_equal(udp.sport, saved_packet[UDP].sport,
+                                       "UDP source port")
+                 except:
+                     self.logger.error(ppp("Unexpected or invalid packet:",
+                                       packet))
+                     raise
+             remaining_packet = self.get_next_packet_info_for_interface2(
+                        src_if.sw_if_index,
+                        dst_if.sw_if_index,
+                        packet_info)
+             self.assertIsNone(remaining_packet,
+                               "Interface %s: Packet expected from interface "
+                               "%s didn't arrive" % (dst_if.name, src_if.name))
+
+6. Add the test code to test_basic function::
+
+         def test_basic(self):
+             count = 10
+             # create the packet stream
+             packets = self.create_stream(self.pg0, self.pg1, count)
+             # add the stream to the source interface
+             self.pg0.add_stream(packets)
+             # enable capture on both interfaces
+             self.pg0.enable_capture()
+             self.pg1.enable_capture()
+             # start the packet generator
+             self.pg_start()
+             # get capture - the proper count of packets was saved by
+             # create_packet_info() based on dst_if parameter
+             capture = self.pg1.get_capture()
+             # assert nothing captured on pg0 (always do this last, so that
+             # some time has already passed since pg_start())
+             self.pg0.assert_nothing_captured()
+             # verify capture
+             self.verify_capture(self.pg0, self.pg1, capture)
+
+7. Run the test by issuing 'make test' or, to run only this specific
+   test, issue 'make test TEST=test_ip4_fwd'.
diff --git a/docs/docsignore b/docs/docsignore
new file mode 100644
index 00000000000..abd2eb5fa4d
--- /dev/null
+++ b/docs/docsignore
@@ -0,0 +1,8 @@
+# This is a list of ignored documentation files
+# in VPP. Not linking these files in ./docs won't
+# trigger an error in ./extra/scripts/check_documentation.sh
+extras/deprecated/dpdk-hqos/qos_doc.md
+extras/deprecated/dpdk-ipsec/dpdk_crypto_ipsec_doc.md
+src/vpp-api/lua/README.md
+src/vpp-api/lua/examples/cli/README.md
+src/vpp-api/lua/examples/lute/README.md
diff --git a/docs/dynamic_includes/.gitkeep b/docs/dynamic_includes/.gitkeep
deleted file mode 100644
index e69de29bb2d..00000000000
diff --git a/docs/gettingstarted/developers/VPPAPI.md b/docs/gettingstarted/developers/VPPAPI.md
deleted file mode 120000
index a5404c116ee..00000000000
--- a/docs/gettingstarted/developers/VPPAPI.md
+++ /dev/null
@@ -1 +0,0 @@
-../../../src/tools/vppapigen/VPPAPI.md
\ No newline at end of file
diff --git a/docs/gettingstarted/developers/add_plugin.rst b/docs/gettingstarted/developers/add_plugin.rst
deleted file mode 100644
index cf771116095..00000000000
--- a/docs/gettingstarted/developers/add_plugin.rst
+++ /dev/null
@@ -1,362 +0,0 @@
-.. _add_plugin:
-
-Adding a plugin
-===============
-
-.. toctree::
-
-Strategic Choices
-_________________
-
-Plugins may implement lightly-used, experimental, or test
-functionality. In such cases, please disable the plugin by default:
-
-.. code-block:: console
-
-    /* *INDENT-OFF* */
-    VLIB_PLUGIN_REGISTER () =
-    {
-      .version = VPP_BUILD_VER,
-      .description = "Plugin Disabled by Default...",
-      .default_disabled = 1,
-    };
-    /* *INDENT-ON* */
-
-Please do not create processes, or other dynamic data structures
-unless the plugin is configured by API or debug CLI.
-
-Specifically, please don't initialize bihash tables from
-VLIB_INIT_FUNCTIONS, *especially* if the bihash template involved
-doesn't #define BIHASH_LAZY_INSTANTIATE 1.
-
-.. code-block:: console
-
-    static clib_error_t * sample_init (vlib_main_t * vm)
-    {
-      
-      /* DONT DO THIS! */
-      BV(clib_bihash_init (h, ...))
-      
-    }
-    VLIB_INIT_FUNCTION (sample_init);
-
-Instead, please add a feature_init function:
-
-.. code-block:: console
-
-    static void
-    feature_init (my_main_t * mm)
-    {
-      if (mm->feature_initialized == 0)
-        {
-          BV(clib_bihash_init)(mm->hash_table, ...)
-          /* Create Other Things, e.g a periodic process */
-          mm->feature_initialized = 1;
-        }
-    }
-
-And call it from debug CLI and API message handlers any time the feature
-is enabled.
-
-How to create a new plugin
-__________________________
-
-This section shows how a VPP developer can create a new plugin, and
-add it to VPP. We assume that we are starting from the VPP .
-
-As an example, we will use the **make-plugin.sh** tool found in
-**./extras/emacs**. make-plugin.sh is a simple wrapper for a comprehensive
-plugin generator constructed from a set of emacs-lisp skeletons.
-
-Change directory to **./src/plugins**, and run the plugin generator:
-
-.. code-block:: console
-
-    $ cd ./src/plugins
-    $ ../../extras/emacs/make-plugin.sh
-    
-    Loading /scratch/vpp-docs/extras/emacs/tunnel-c-skel.el (source)...
-    Loading /scratch/vpp-docs/extras/emacs/tunnel-decap-skel.el (source)...
-    Loading /scratch/vpp-docs/extras/emacs/tunnel-encap-skel.el (source)...
-    Loading /scratch/vpp-docs/extras/emacs/tunnel-h-skel.el (source)...
-    Loading /scratch/vpp-docs/extras/emacs/elog-4-int-skel.el (source)...
-    Loading /scratch/vpp-docs/extras/emacs/elog-4-int-track-skel.el (source)...
-    Loading /scratch/vpp-docs/extras/emacs/elog-enum-skel.el (source)...
-    Loading /scratch/vpp-docs/extras/emacs/elog-one-datum-skel.el (source)...
-    Plugin name: myplugin
-    Dispatch type [dual or qs]: dual
-    (Shell command succeeded with no output)
-
-    OK...
-
-The plugin generator script asks two questions: the name of the
-plugin, and which of two dispatch types to use. Since the plugin name
-finds its way into quite a number of places - filenames, typedef
-names, graph arc names - it pays to think for a moment.
-
-The dispatch type refers to the coding pattern used to construct
-**node.c**, the *pro forma* data-plane node. The **dual** option
-constructs a dual-single loop pair with speculative enqueueing. This
-is the traditional coding pattern for load-store intensive graph
-nodes.
-
-The **qs** option generates a quad-single loop pair which uses
-vlib_get_buffers(...) and vlib_buffer_enqueue_to_next(...). These
-operators make excellent use of available SIMD vector unit
-operations. It's very simple to change a quad-single loop-pair to a
-dual-single loop pair if you decide to do so later.
-
-Generated Files
----------------
-
-Here are the generated files. We'll go through them in a moment.
-
-.. code-block:: console
-
-    $ cd ./myplugin
-    $ ls
-    CMakeLists.txt  myplugin.api  myplugin.c  myplugin.h
-    myplugin_periodic.c  myplugin_test.c  node.c  setup.pg
-
-Due to recent build system improvements, you **don't** need to touch
-any other files to integrate your new plugin into the vpp build. Simply
-rebuild your workspace from scratch, and the new plugin will appear.
-
-Rebuild your workspace
-----------------------
-
-This is the straightforward way to reconfigure and rebuild your workspace:
-
-.. code-block:: console
-
-    $ cd 
-    $ make rebuild [or rebuild-release]
-
-Thanks to ccache, this operation doesn't take an annoying amount of time.
-
-Sanity check: run vpp
----------------------
-
-As a quick sanity check, run vpp and make sure that
-"myplugin_plugin.so" and "myplugin_test_plugin.so" are loaded:
-
-.. code-block:: console
-
-    $ cd 
-    $ make run
-    
-    load_one_plugin:189: Loaded plugin: myplugin_plugin.so (myplugin description goes here)
-    
-    load_one_vat_plugin:67: Loaded plugin: myplugin_test_plugin.so
-    
-    DBGvpp#
-
-If this simple test fails, please seek assistance.
-
-Generated Files in Detail
-_________________________
-
-This section discusses the generated files in some detail. It's fine to
-skim this section, and return later for more detail.
-
-CMakeLists.txt
---------------
-
-This is the build system recipe for building your plugin. Please fix
-the copyright notice:
-
-.. code-block:: console
-
-    # Copyright (c)  
-
-The rest of the build recipe is pretty simple:
-
-.. code-block:: CMake
-
-    add_vpp_plugin (myplugin
-    SOURCES
-    myplugin.c
-    node.c
-    myplugin_periodic.c
-    myplugin.h
-
-    MULTIARCH_SOURCES
-    node.c
-
-    API_FILES
-    myplugin.api
-
-    API_TEST_SOURCES
-    myplugin_test.c
-    )
-
-As you can see, the build recipe consists of several lists of
-files. **SOURCES** is a list of C source files. **API_FILES** is a
-list of the plugin's binary API definition files [one such file is
-usually plenty], and so forth.
-
-**MULTIARCH_SOURCES** lists data plane graph node dispatch function
-source files considered to be performance-critical. Specific functions
-in these files are compiled multiple times, so that they can leverage
-CPU-specific features. More on this in a moment.
-
-If you add source files, simply add them to the indicated list(s).
-
-myplugin.h
-----------
-
-This is the primary #include file for the new plugin. Among other
-things, it defines the plugin's *main_t* data structure. This is the
-right place to add problem-specific data structures. Please **resist
-the temptation** to create a set of static or [worse yet] global
-variables in your plugin. Refereeing name-collisions between plugins
-is not anyone's idea of a good time.
-
-myplugin.c
-----------
-
-For want of a better way to describe it, myplugin.c is the vpp plugin
-equivalent of "main.c". Its job is to hook the plugin into the vpp
-binary API message dispatcher, and to add its messages to vpp's global
-"message-name_crc" hash table. See "myplugin_init (...")"
-
-Vpp itself uses dlsym(...) to track down the vlib_plugin_registration_t
-generated by the VLIB_PLUGIN_REGISTER macro:
-
-.. code-block:: C
-
-    VLIB_PLUGIN_REGISTER () =
-      {
-        .version = VPP_BUILD_VER,
-        .description = "myplugin plugin description goes here",
-      };
-
-Vpp only loads .so files from the plugin directory which contain an
-instance of this data structure.
-
-You can enable or disable specific vpp plugins from the command
-line. By default, plugins are loaded. To change that behavior, set
-default_disabled in the macro VLIB_PLUGIN_REGISTER:
-
-.. code-block:: C
-
-    VLIB_PLUGIN_REGISTER () =
-      {
-        .version = VPP_BUILD_VER,
-        .default_disabled = 1
-        .description = "myplugin plugin description goes here",
-      };
-
-The boilerplate generator places the graph node dispatch function
-onto the "device-input" feature arc. This may or may not be useful.
-
-.. code-block:: C
-
-    VNET_FEATURE_INIT (myplugin, static) =
-    {
-      .arc_name = "device-input",
-      .node_name = "myplugin",
-      .runs_before = VNET_FEATURES ("ethernet-input"),
-    };
-
-As given by the plugin generator, myplugin.c contains the binary API
-message handler for a generic "please enable my feature on such and
-such an interface" binary API message. As you'll see, setting up the
-vpp message API tables is simple. Big fat warning: the scheme is
-intolerant of minor mistakes. Example: forgetting to add
-mainp->msg_id_base can lead to very confusing failures.
-
-If you stick to modifying the generated boilerplate with care -
-instead of trying to build code from first principles - you'll save
-yourself a bunch of time and aggravation
-
-myplugin_test.c
----------------
-
-This file contains binary API message **generation** code, which is
-compiled into a separate .so file. The "vpp_api_test" program loads
-these plugins, yielding immediate access to your plugin APIs for
-external client binary API testing.
-
-vpp itself loads test plugins, and makes the code available via the
-"binary-api" debug CLI. This is a favorite way to unit-test binary
-APIs prior to integration testing.
-
-node.c
-------
-
-This is the generated graph node dispatch function. You'll need to
-rewrite it to solve the problem at hand. It will save considerable
-time and aggravation to retain the **structure** of the node dispatch
-function.
-
-Even for an expert, it's a waste of time to reinvent the *loop
-structure*, enqueue patterns, and so forth. Simply tear out and
-replace the specimen 1x, 2x, 4x packet processing code with code
-relevant to the problem you're trying to solve.
-
-myplugin.api
-------------
-
-This contains the API message definition. Here we only have defined
-a single one named ``myplugin_enable_disable`` and an implicit
-``myplugin_enable_disable_reply`` containing only a return value due
-to the ``autoreply`` keyword.
-
-The syntax reference for ``.api`` files can be found at VPP API Language
-
-Addressing the binary API with this message will run the handler defined
-in ``myplugin.c`` as ``vl_api_myplugin_enable_disable_t_handler``.
-It will receive a message pointer ``*mp`` which is the struct defined
-in ``myplugin.api`` and should return another message pointer ``*rmp``,
-of the reply type. That's what ``REPLY_MACRO`` does.
-
-To be noted, all API messages are in net-endian and vpp is host-endian,
-so you will need to use :
-
-* ``u32 value = ntohl(mp->value);``
-* ``rmp->value = htonl(value);``
-
-You can now use this API with :ref:`GoLang bindings `
-
-myplugin_periodic.c
--------------------
-
-This defines a VPP process, a routine that will run indefinitely and
-be woken up intermittently, here to process plugin events.
-
-To be noted, vlib_processes aren't thread-safe, and data structures
-should be locked when shared between workers.
-
-Plugin "Friends with Benefits"
-------------------------------
-
-In vpp VLIB_INIT_FUNCTION functions, It's reasonably common to see a
-specific init function invoke other init functions:
-
-.. code-block:: C
-
-    if ((error = vlib_call_init_function (vm, some_other_init_function))
-       return error;
-
-In the case where one plugin needs to call a init function in another
-plugin, use the vlib_call_plugin_init_function macro:
-
-.. code-block:: C
-
-    if ((error = vlib_call_plugin_init_function (vm, "otherpluginname", some_init_function))
-       return error;
-
-This allows sequencing between plugin init functions.
-
-If you wish to obtain a pointer to a symbol in another plugin, use the
-vlib_plugin_get_symbol(...) API:
-
-.. code-block:: C
-
-    void *p = vlib_get_plugin_symbol ("plugin_name", "symbol");
-
-More Examples
--------------
-
-For more information you can read many example plugins in the directory "./src/plugins".
diff --git a/docs/gettingstarted/developers/add_plugin_goapi.rst b/docs/gettingstarted/developers/add_plugin_goapi.rst
deleted file mode 100644
index dce35b8f0a2..00000000000
--- a/docs/gettingstarted/developers/add_plugin_goapi.rst
+++ /dev/null
@@ -1,83 +0,0 @@
-.. _add_plugin_goapi:
-
-Add a plugin's GO API
-=====================
-
-In order to use your plugin's API with GO, you will need to use
-a GO client and GO definitions of the API messages that you defined
-in ``myplugin.api`` (go bindings).
-
-These two things can be found in `govpp `_
-
-* The API client lives in `./core`
-* The api-generator lives in `./binapigen`
-* A sample of its output (the go bindings) for VPP's latest version lives in `./binapi`
-
-To generate the go bindings for your plugin. Assuming :
-* ``/home/vpp`` is a VPP clone with your plugin in it.
-* ``/home/controlplane`` is a go controlplane repo
-
-.. code-block:: console
-
-    $ mkdir /home/controlplane/vpp-go-bindings
-    $ git clone https://github.com/FDio/govpp>
-    $ cd govpp
-    $ BINAPI_DIR=/home/controlplane/vpp-go-bindings VPP_DIR=/home/vpp make gen-binapi-from-code
-
-This will generate the go-bindings in ``/home/controlplane/vpp-go-bindings``
-For example ``vpp-go-bindings/myplugin/myplugin.ba.go`` will contain :
-
-.. code-block:: go
-
-    // MypluginEnableDisable defines message 'myplugin_enable_disable'.
-    type MypluginEnableDisable struct {
-	    EnableDisable bool                           `binapi:"bool,name=enable_disable" json:"enable_disable,omitempty"`
-	    SwIfIndex     interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
-    }
-
-
-You can then use the generated go bindings in your go code like this :
-
-.. code-block:: go
-
-    package main
-
-    import (
-	    "fmt"
-	    "git.fd.io/govpp.git"
-	    "git.fd.io/govpp.git/binapi/interfaces"
-	    "git.fd.io/govpp.git/binapi/vpe"
-
-	    "myplugin.io/controlplane/vpp-go-bindings/myplugin/myplugin"
-    )
-
-    func main() {
-	    // Connect to VPP
-	    conn, _ := govpp.Connect("/run/vpp/api.sock")
-	    defer conn.Disconnect()
-
-	    // Open channel
-	    ch, _ := conn.NewAPIChannel()
-	    defer ch.Close()
-
-	    request := &vpe.MypluginEnableDisable{
-		EnableDisable: true,
-	    }
-	    reply := &vpe.MypluginEnableDisableReply{}
-
-	    err := ch.SendRequest(request).ReceiveReply(reply)
-	    if err != nil {
-		    fmt.Errorf("SendRequest: %w\n", err)
-	    }
-    }
-
-As you will need to import (or ``go get "git.fd.io/govpp.git"``) to leverage the API
-client in your code, you might want to use the api-generator directly from the
-clone ``go build`` fetches for you. You can do this with :
-
-.. code-block:: console
-
-  $ export GOVPP_DIR=$(go list -f '{{.Dir}}' -m git.fd.io/govpp.git)
-  $ cd $GOVPP_DIR && go build -o /some/bin/dir ./cmd/binapi-generator
-  $ # instead of make gen-binapi-from-code you can rewrite the code to target
-  $ # your version ./binapi-generator
diff --git a/docs/gettingstarted/developers/bihash.md b/docs/gettingstarted/developers/bihash.md
deleted file mode 100644
index b0f98869887..00000000000
--- a/docs/gettingstarted/developers/bihash.md
+++ /dev/null
@@ -1,308 +0,0 @@
-Bounded-index Extensible Hashing (bihash)
-=========================================
-
-Vpp uses bounded-index extensible hashing to solve a variety of
-exact-match (key, value) lookup problems. Benefits of the current
-implementation:
-
-* Very high record count scaling, tested to 100,000,000 records.
-* Lookup performance degrades gracefully as the number of records increases
-* No reader locking required
-* Template implementation, it's easy to support arbitrary (key,value) types
-
-Bounded-index extensible hashing has been widely used in databases for
-decades.
-
-Bihash uses a two-level data structure:
-
-```
-    +-----------------+
-    | bucket-0        |
-    |  log2_size      |
-    |  backing store  |
-    +-----------------+
-    | bucket-1        |
-    |  log2_size      |           +--------------------------------+
-    |  backing store  | --------> | KVP_PER_PAGE * key-value-pairs |
-    +-----------------+           | page 0                         |
-         ...                      +--------------------------------+
-    +-----------------+           | KVP_PER_PAGE * key-value-pairs |
-    | bucket-2**N-1   |           | page 1                         |
-    |  log2_size      |           +--------------------------------+
-    |  backing store  |                       ---
-    +-----------------+           +--------------------------------+
-                                  | KVP_PER_PAGE * key-value-pairs |
-                                  | page 2**(log2(size)) - 1       |
-                                  +--------------------------------+
-```
-
-Discussion of the algorithm
----------------------------
-
-This structure has a couple of major advantages. In practice, each
-bucket entry fits into a 64-bit integer. Coincidentally, vpp's target
-CPU architectures support 64-bit atomic operations. When modifying the
-contents of a specific bucket, we do the following:
-
-* Make a working copy of the bucket's backing storage
-* Atomically swap a pointer to the working copy into the bucket array
-* Change the original backing store data
-* Atomically swap back to the original
-
-So, no reader locking is required to search a bihash table.
-
-At lookup time, the implementation computes a key hash code. We use
-the least-significant N bits of the hash to select the bucket.
-
-With the bucket in hand, we learn log2 (nBackingPages) for the
-selected bucket. At this point, we use the next log2_size bits from
-the hash code to select the specific backing page in which the
-(key,value) page will be found.
-
-Net result: we search **one** backing page, not 2**log2_size
-pages. This is a key property of the algorithm.
-
-When sufficient collisions occur to fill the backing pages for a given
-bucket, we double the bucket size, rehash, and deal the bucket
-contents into a double-sized set of backing pages. In the future, we
-may represent the size as a linear combination of two powers-of-two,
-to increase space efficiency.
-
-To solve the "jackpot case" where a set of records collide under
-hashing in a bad way, the implementation will fall back to linear
-search across 2**log2_size backing pages on a per-bucket basis.
-
-To maintain *space* efficiency, we should configure the bucket array
-so that backing pages are effectively utilized. Lookup performance
-tends to change *very little* if the bucket array is too small or too
-large.
-
-Bihash depends on selecting an effective hash function. If one were to
-use a truly broken hash function such as "return 1ULL." bihash would
-still work, but it would be equivalent to poorly-programmed linear
-search.
-
-We often use cpu intrinsic functions - think crc32 - to rapidly
-compute a hash code which has decent statistics.
-
-Bihash Cookbook
----------------
-
-### Using current (key,value) template instance types
-
-It's quite easy to use one of the template instance types. As of this
-writing, .../src/vppinfra provides pre-built templates for 8, 16, 20,
-24, 40, and 48 byte keys, u8 * vector keys, and 8 byte values.
-
-See .../src/vppinfra/{bihash__8}.h
-
-To define the data types, #include a specific template instance, most
-often in a subsystem header file:
-
-```c
-     #include 
-```
-
-If you're building a standalone application, you'll need to define the
-various functions by #including the method implementation file in a C
-source file.
-
-The core vpp engine currently uses most if not all of the known bihash
-types, so you probably won't need to #include the method
-implementation file.
-
-
-```c
-     #include 
-```
-
-Add an instance of the selected bihash data structure to e.g. a
-"main_t" structure:
-
-```c
-    typedef struct
-    {
-      ...
-      BVT (clib_bihash) hash_table;
-      or
-      clib_bihash_8_8_t hash_table;
-      ...
-    } my_main_t;
-```
-
-The BV macro concatenate its argument with the value of the
-preprocessor symbol BIHASH_TYPE. The BVT macro concatenates its
-argument with the value of BIHASH_TYPE and the fixed-string "_t". So
-in the above example, BVT (clib_bihash) generates "clib_bihash_8_8_t".
-
-If you're sure you won't decide to change the template / type name
-later, it's perfectly OK to code "clib_bihash_8_8_t" and so forth.
-
-In fact, if you #include multiple template instances in a single
-source file, you **must** use fully-enumerated type names. The macros
-stand no chance of working.
-
-### Initializing a bihash table
-
-Call the init function as shown. As a rough guide, pick a number of
-buckets which is approximately
-number_of_expected_records/BIHASH_KVP_PER_PAGE from the relevant
-template instance header-file.  See previous discussion.
-
-The amount of memory selected should easily contain all of the
-records, with a generous allowance for hash collisions. Bihash memory
-is allocated separately from the main heap, and won't cost anything
-except kernel PTE's until touched, so it's OK to be reasonably
-generous.
-
-For example:
-
-```c
-    my_main_t *mm = &my_main;
-    clib_bihash_8_8_t *h;
-
-    h = &mm->hash_table;
-
-    clib_bihash_init_8_8 (h, "test", (u32) number_of_buckets,
-                           (uword) memory_size);
-```
-
-### Add or delete a key/value pair
-
-Use BV(clib_bihash_add_del), or the explicit type variant:
-
-```c
-   clib_bihash_kv_8_8_t kv;
-   clib_bihash_8_8_t * h;
-   my_main_t *mm = &my_main;
-   clib_bihash_8_8_t *h;
-
-   h = &mm->hash_table;
-   kv.key = key_to_add_or_delete;
-   kv.value = value_to_add_or_delete;
-
-   clib_bihash_add_del_8_8 (h, &kv, is_add /* 1=add, 0=delete */);
-```
-
-In the delete case, kv.value is irrelevant. To change the value associated
-with an existing (key,value) pair, simply re-add the [new] pair.
-
-### Simple search
-
-The simplest possible (key, value) search goes like so:
-
-```c
-   clib_bihash_kv_8_8_t search_kv, return_kv;
-   clib_bihash_8_8_t * h;
-   my_main_t *mm = &my_main;
-   clib_bihash_8_8_t *h;
-
-   h = &mm->hash_table;
-   search_kv.key = key_to_add_or_delete;
-
-   if (clib_bihash_search_8_8 (h, &search_kv, &return_kv) < 0)
-     key_not_found();
-   else
-     key_found();
-```
-
-Note that it's perfectly fine to collect the lookup result
-
-```c
-   if (clib_bihash_search_8_8 (h, &search_kv, &search_kv))
-     key_not_found();
-   etc.
-```
-
-### Bihash vector processing
-
-When processing a vector of packets which need a certain lookup
-performed, it's worth the trouble to compute the key hash, and
-prefetch the correct bucket ahead of time.
-
-Here's a sketch of one way to write the required code:
-
-Dual-loop:
-* 6 packets ahead, prefetch 2x vlib_buffer_t's and 2x packet data
-  required to form the record keys
-* 4 packets ahead, form 2x record keys and call BV(clib_bihash_hash)
-  or the explicit hash function to calculate the record hashes.
-  Call 2x BV(clib_bihash_prefetch_bucket) to prefetch the buckets
-* 2 packets ahead, call 2x BV(clib_bihash_prefetch_data) to prefetch
-  2x (key,value) data pages.
-* In the processing section, call 2x BV(clib_bihash_search_inline_with_hash)
-  to perform the search
-
-Programmer's choice whether to stash the hash code somewhere in
-vnet_buffer(b) metadata, or to use local variables.
-
-Single-loop:
-* Use simple search as shown above.
-
-### Walking a bihash table
-
-A fairly common scenario to build "show" commands involves walking a
-bihash table. It's simple enough:
-
-```c
-   my_main_t *mm = &my_main;
-   clib_bihash_8_8_t *h;
-   void callback_fn (clib_bihash_kv_8_8_t *, void *);
-
-   h = &mm->hash_table;
-
-   BV(clib_bihash_foreach_key_value_pair) (h, callback_fn, (void *) arg);
-```
-To nobody's great surprise: clib_bihash_foreach_key_value_pair
-iterates across the entire table, calling callback_fn with active
-entries.
-
-#### Bihash table iteration safety
-
-The iterator template "clib_bihash_foreach_key_value_pair" must be
-used with a certain amount of care. For one thing, the iterator
-template does _not_ take the bihash hash table writer lock. If your
-use-case requires it, lock the table.
-
-For another, the iterator template is not safe under all conditions:
-
-* It's __OK to delete__ bihash table entries during a table-walk. The
-iterator checks whether the current bucket has been freed after each
-_callback_fn(...)_ invocation.
-
-* It is __not OK to add__ entries during a table-walk.
-
-The add-during-walk case involves a jackpot: while processing a
-key-value-pair in a particular bucket, add a certain number of
-entries. By luck, assume that one or more of the added entries causes
-the __current bucket__ to split-and-rehash.
-
-Since we rehash KVP's to different pages based on what amounts to a
-different hash function, either of these things can go wrong:
-
-* We may revisit previously-visited entries. Depending on how one
-coded the use-case, we could end up in a recursive-add situation.
-
-* We may skip entries that have not been visited
-
-One could build an add-safe iterator, at a significant cost in
-performance: copy the entire bucket, and walk the copy.
-
-It's hard to imagine a worthwhile add-during walk use-case in the
-first place; let alone one which couldn't be implemented by walking
-the table without modifying it, then adding a set of records.
-
-### Creating a new template instance
-
-Creating a new template is easy. Use one of the existing templates as
-a model, and make the obvious changes. The hash and key_compare
-methods are performance-critical in multiple senses.
-
-If the key compare method is slow, every lookup will be slow. If the
-hash function is slow, same story. If the hash function has poor
-statistical properties, space efficiency will suffer. In the limit, a
-bad enough hash function will cause large portions of the table to
-revert to linear search.
-
-Use of the best available vector unit is well worth the trouble in the
-hash and key_compare functions.
diff --git a/docs/gettingstarted/developers/binary_api_support.rst b/docs/gettingstarted/developers/binary_api_support.rst
deleted file mode 100644
index f93bbc296fc..00000000000
--- a/docs/gettingstarted/developers/binary_api_support.rst
+++ /dev/null
@@ -1,485 +0,0 @@
-.. _binary_api_support:
-
-.. toctree::
-
-Binary API Support
-==================
-
-VPP provides a binary API scheme to allow a wide variety of client
-codes to program data-plane tables. As of this writing, there are
-hundreds of binary APIs.
-
-Messages are defined in \*.api files. Today, there are about 80 api
-files, with more arriving as folks add programmable features. The API
-file compiler sources reside in src/tools/vppapigen.
-
-From `src/vnet/interface.api
-`_, here's a
-typical request/response message definition:
-
-.. code-block:: console
-
-	autoreply define sw_interface_set_flags
-	{
-	  u32 client_index;
-	  u32 context;
-	  u32 sw_if_index;
-	  /* 1 = up, 0 = down */
-	  u8 admin_up_down;
-	};
-
-To a first approximation, the API compiler renders this definition
-into
-*vpp/build-root/install-vpp_debug-native/vpp/include/vnet/interface.api.h*
-as follows:
-
-.. code-block:: C
-
-	/****** Message ID / handler enum ******/
-
-	#ifdef vl_msg_id
-	vl_msg_id(VL_API_SW_INTERFACE_SET_FLAGS, vl_api_sw_interface_set_flags_t_handler)
-	vl_msg_id(VL_API_SW_INTERFACE_SET_FLAGS_REPLY, vl_api_sw_interface_set_flags_reply_t_handler)
-	#endif
-	/****** Message names ******/
-
-	#ifdef vl_msg_name
-	vl_msg_name(vl_api_sw_interface_set_flags_t, 1)
-	vl_msg_name(vl_api_sw_interface_set_flags_reply_t, 1)
-	#endif
-	/****** Message name, crc list ******/
-
-	#ifdef vl_msg_name_crc_list
-	#define foreach_vl_msg_name_crc_interface \
-	_(VL_API_SW_INTERFACE_SET_FLAGS, sw_interface_set_flags, f890584a) \
-	_(VL_API_SW_INTERFACE_SET_FLAGS_REPLY, sw_interface_set_flags_reply, dfbf3afa) \
-	#endif
-	/****** Typedefs *****/
-
-	#ifdef vl_typedefs
-	#ifndef defined_sw_interface_set_flags
-	#define defined_sw_interface_set_flags
-	typedef VL_API_PACKED(struct _vl_api_sw_interface_set_flags {
-	    u16 _vl_msg_id;
-	    u32 client_index;
-	    u32 context;
-	    u32 sw_if_index;
-	    u8 admin_up_down;
-	}) vl_api_sw_interface_set_flags_t;
-	#endif
-
-	#ifndef defined_sw_interface_set_flags_reply
-	#define defined_sw_interface_set_flags_reply
-	typedef VL_API_PACKED(struct _vl_api_sw_interface_set_flags_reply {
-	    u16 _vl_msg_id;
-	    u32 context;
-	    i32 retval;
-	}) vl_api_sw_interface_set_flags_reply_t;
-	#endif
-	...
-	#endif /* vl_typedefs */
-
-To change the admin state of an interface, a binary api client sends a
-`vl_api_sw_interface_set_flags_t
-`_
-to VPP, which will respond with a
-vl_api_sw_interface_set_flags_reply_t message.
-
-Multiple layers of software, transport types, and shared libraries
-implement a variety of features:
-
-* API message allocation, tracing, pretty-printing, and replay.
-* Message transport via global shared memory, pairwise/private shared memory, and sockets.
-* Barrier synchronization of worker threads across thread-unsafe message handlers.
-
-Correctly-coded message handlers know nothing about the transport used
-to deliver messages to/from VPP. It's reasonably straightforward to use
-multiple API message transport types simultaneously.
-
-For historical reasons, binary api messages are (putatively) sent in
-network byte order. As of this writing, we're seriously considering
-whether that choice makes sense.
-
-Message Allocation
-__________________
-
-Since binary API messages are always processed in order, we allocate
-messages using a ring allocator whenever possible. This scheme is
-extremely fast when compared with a traditional memory allocator, and
-doesn't cause heap fragmentation. See `src/vlibmemory/memory_shared.c
-`_
-`vl_msg_api_alloc_internal()
-`_.
-
-Regardless of transport, binary api messages always follow a `msgbuf_t `_ header:
-
-.. code-block:: C
-
-	/** Message header structure */
-	typedef struct msgbuf_
-	{
-	  svm_queue_t *q; /**< message allocated in this shmem ring  */
-	  u32 data_len;                  /**< message length not including header  */
-	  u32 gc_mark_timestamp;         /**< message garbage collector mark TS  */
-	  u8 data[0];                    /**< actual message begins here  */
-	} msgbuf_t;
-
-This structure makes it easy to trace messages without having to
-decode them - simply save data_len bytes - and allows
-`vl_msg_api_free()
-`_
-to rapidly dispose of message buffers:
-
-.. code-block:: C
-
-	void
-	vl_msg_api_free (void *a)
-	{
-	  msgbuf_t *rv;
-	  void *oldheap;
-	  api_main_t *am = &api_main;
-
-	  rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
-
-	  /*
-	   * Here's the beauty of the scheme.  Only one proc/thread has
-	   * control of a given message buffer. To free a buffer, we just clear the
-	   * queue field, and leave. No locks, no hits, no errors...
-	   */
-	  if (rv->q)
-	    {
-	      rv->q = 0;
-	      rv->gc_mark_timestamp = 0;
-	      
-	      return;
-	    }
-	  
-	}
-
-Message Tracing and Replay
-__________________________
-
-It's extremely important that VPP can capture and replay sizeable
-binary API traces. System-level issues involving hundreds of thousands
-of API transactions can be re-run in a second or less. Partial replay
-allows one to binary-search for the point where the wheels fall
-off. One can add scaffolding to the data plane, to trigger when
-complex conditions obtain.
-
-With binary API trace, print, and replay, system-level bug reports of
-the form "after 300,000 API transactions, the VPP data-plane stopped
-forwarding traffic, FIX IT!" can be solved offline.
-
-More often than not, one discovers that a control-plane client
-misprograms the data plane after a long time or under complex
-circumstances. Without direct evidence, "it's a data-plane problem!"
-
-See `src/vlibmemory/memory_vlib::c
-`_
-`vl_msg_api_process_file()
-`_,
-and `src/vlibapi/api_shared.c
-`_. See also
-the debug CLI command "api trace"
-
-API trace replay caveats
-________________________
-
-The vpp instance which replays a binary API trace must have the same
-message-ID numbering space as the vpp instance which captured the
-trace. The replay instance **must** load the same set of plugins as
-the capture instance. Otherwise, API messages will be processed by the
-**wrong** API message handlers!
-
-Always start vpp with command-line arguments which include an
-"api-trace on" stanza, so vpp will start tracing binary API messages
-from the beginning:
-
-.. code-block:: console
-
-   api-trace {
-     on
-   }
-
-Given a binary api trace in /tmp/api_trace, do the following to work
-out the set of plugins:
-
-.. code-block:: console
-
-   DBGvpp# api trace dump /tmp/api_trace
-   vl_api_trace_plugin_msg_ids: arp_cfdf7292 first 49 last 56
-   vl_api_trace_plugin_msg_ids: ip6_nd_ac628462 first 57 last 69
-   vl_api_trace_plugin_msg_ids: rd_cp_8a996e86 first 70 last 71
-   
-
-Here, we see the "abf," "acl," "cdp," and "flowprobe" plugins. Use the
-list of plugins to construct a matching "plugins" command-line argument
-stanza:
-
-.. code-block:: console
-
-    plugins {
-   	## Disable all plugins, selectively enable specific plugins
-    	plugin default { disable }
-    	plugin abf_plugin.so { enable }
-    	plugin acl_plugin.so { enable }
-    	plugin cdp_plugin.so { enable }
-    	plugin flowprobe_plugin.so { enable }
-    }
-
-To begin with, use the same vpp image that captured a trace to replay
-it. It's perfectly fair to rebuild the vpp replay instance, to add
-scaffolding to facilitate setting gdb breakpoints on complex
-conditions or similar.
-
-API trace interface issues
-__________________________
-
-Along the same lines, it may be necessary to manufacture [simulated]
-physical interfaces so that an API trace will replay correctly. "show
-interface" on the trace origin system can help. An API trace
-dump as shown above may make it obvious how many loopback
-interfaces to create. If you see vhost interfaces being created and
-then configured, the first such configuration message in the trace
-will tell you how many physical interfaces were involved.
-
-.. code-block:: console
-
-  SCRIPT: create_vhost_user_if socket /tmp/foosock server
-  SCRIPT: sw_interface_set_flags sw_if_index 3 admin-up
-
-In this case, it's fair to guess that one needs to create two loopback
-interfaces to "help" the trace replay correctly.
-
-These issues can be mitigated to a certain extent by replaying the
-trace on the system which created it, but in a field debug case that's
-not a realistic.
-
-Client connection details
-_________________________
-
-Establishing a binary API connection to VPP from a C-language client is easy:
-
-.. code-block:: C
-
-	int
-	connect_to_vpe (char *client_name, int client_message_queue_length)
-	{
-	  vat_main_t *vam = &vat_main;
-	  api_main_t *am = &api_main;
-	  if (vl_client_connect_to_vlib ("/vpe-api", client_name,
-	                                client_message_queue_length) < 0)
-	    return -1;
-	  /* Memorize vpp's binary API message input queue address */
-	  vam->vl_input_queue = am->shmem_hdr->vl_input_queue;
-	  /* And our client index */
-	  vam->my_client_index = am->my_client_index;
-	  return 0;
-	}
-
-32 is a typical value for client_message_queue_length. VPP *cannot*
-block when it needs to send an API message to a binary API client. The
-VPP-side binary API message handlers are very fast. So, when sending
-asynchronous messages, make sure to scrape the binary API rx ring with
-some enthusiasm!
-
-**Binary API message RX pthread**
-
-Calling `vl_client_connect_to_vlib
-`_
-spins up a binary API message RX pthread:
-
-.. code-block:: C
-
-	static void *
-	rx_thread_fn (void *arg)
-	{
-	  svm_queue_t *q;
-	  memory_client_main_t *mm = &memory_client_main;
-	  api_main_t *am = &api_main;
-	  int i;
-
-	  q = am->vl_input_queue;
-
-	  /* So we can make the rx thread terminate cleanly */
-	  if (setjmp (mm->rx_thread_jmpbuf) == 0)
-	    {
-	      mm->rx_thread_jmpbuf_valid = 1;
-	      /*
-	       * Find an unused slot in the per-cpu-mheaps array,
-	       * and grab it for this thread. We need to be able to
-	       * push/pop the thread heap without affecting other thread(s).
-	       */
-	      if (__os_thread_index == 0)
-	        {
-	          for (i = 0; i < ARRAY_LEN (clib_per_cpu_mheaps); i++)
-	            {
-	              if (clib_per_cpu_mheaps[i] == 0)
-	                {
-	                  /* Copy the main thread mheap pointer */
-	                  clib_per_cpu_mheaps[i] = clib_per_cpu_mheaps[0];
-	                  __os_thread_index = i;
-	                  break;
-	                }
-	            }
-	          ASSERT (__os_thread_index > 0);
-	        }
-	      while (1)
-	        vl_msg_api_queue_handler (q);
-	    }
-	  pthread_exit (0);
-	}
-
-To handle the binary API message queue yourself, use
-`vl_client_connect_to_vlib_no_rx_pthread
-`_.
-
-**Queue non-empty signalling**
-
-vl_msg_api_queue_handler(...) uses mutex/condvar signalling to wake
-up, process VPP -> client traffic, then sleep. VPP supplies a condvar
-broadcast when the VPP -> client API message queue transitions from
-empty to nonempty.
-
-VPP checks its own binary API input queue at a very high rate. VPP
-invokes message handlers in "process" context [aka cooperative
-multitasking thread context] at a variable rate, depending on
-data-plane packet processing requirements.
-
-Client disconnection details
-____________________________
-
-To disconnect from VPP, call `vl_client_disconnect_from_vlib
-`_. Please
-arrange to call this function if the client application terminates
-abnormally. VPP makes every effort to hold a decent funeral for dead
-clients, but VPP can't guarantee to free leaked memory in the shared
-binary API segment.
-
-Sending binary API messages to VPP
-__________________________________
-
-The point of the exercise is to send binary API messages to VPP, and
-to receive replies from VPP. Many VPP binary APIs comprise a client
-request message, and a simple status reply. For example, to set the
-admin status of an interface:
-
-.. code-block:: C
-
-	vl_api_sw_interface_set_flags_t *mp;
-	mp = vl_msg_api_alloc (sizeof (*mp));
-	memset (mp, 0, sizeof (*mp));
-	mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_SW_INTERFACE_SET_FLAGS);
-	mp->client_index = api_main.my_client_index;
-	mp->sw_if_index = clib_host_to_net_u32 ();
-	vl_msg_api_send (api_main.shmem_hdr->vl_input_queue, (u8 *)mp);
-
-Key points:
-
-* Use `vl_msg_api_alloc `_ to allocate message buffers
-* Allocated message buffers are not initialized, and must be presumed to contain trash.
-* Don't forget to set the _vl_msg_id field!
-* As of this writing, binary API message IDs and data are sent in network byte order
-* The client-library global data structure `api_main `_ keeps track of sufficient pointers and handles used to communicate with VPP
-
-Receiving binary API messages from VPP
-______________________________________
-
-Unless you've made other arrangements (see
-`vl_client_connect_to_vlib_no_rx_pthread
-`_),
-*messages are received on a separate rx pthread*. Synchronization with
-the client application main thread is the responsibility of the
-application!
-
-Set up message handlers about as follows:
-
-.. code-block:: C
-
-	#define vl_typedefs         /* define message structures */
-	#include 
-	#undef vl_typedefs
-	/* declare message handlers for each api */
-	#define vl_endianfun                /* define message structures */
-	#include 
-	#undef vl_endianfun
-	/* instantiate all the print functions we know about */
-	#define vl_print(handle, ...)
-	#define vl_printfun
-	#include 
-	#undef vl_printfun
-	/* Define a list of all message that the client handles */
-	#define foreach_vpe_api_reply_msg                            \
-	   _(SW_INTERFACE_SET_FLAGS_REPLY, sw_interface_set_flags_reply)
-	   static clib_error_t *
-	   my_api_hookup (vlib_main_t * vm)
-	   {
-	     api_main_t *am = &api_main;
-	   #define _(N,n)                                                  \
-	       vl_msg_api_set_handlers(VL_API_##N, #n,                     \
-	                              vl_api_##n##_t_handler,              \
-	                              vl_noop_handler,                     \
-	                              vl_api_##n##_t_endian,               \
-	                              vl_api_##n##_t_print,                \
-	                              sizeof(vl_api_##n##_t), 1);
-	     foreach_vpe_api_msg;
-	   #undef _
-	     return 0;
-	    }
-
-The key API used to establish message handlers is
-`vl_msg_api_set_handlers
-`_
-, which sets values in multiple parallel vectors in the `api_main_t
-`_
-structure. As of this writing: not all vector element values can be
-set through the API. You'll see sporadic API message registrations
-followed by minor adjustments of this form:
-
-.. code-block:: C
-
-	/*
-	 * Thread-safe API messages
-	 */
-	am->is_mp_safe[VL_API_IP_ADD_DEL_ROUTE] = 1;
-	am->is_mp_safe[VL_API_GET_NODE_GRAPH] = 1;
-
-API message numbering in plugins
---------------------------------
-
-Binary API message numbering in plugins relies on vpp to issue a block
-of message-ID's for the plugin to use:
-
-.. code-block:: C
-
-        static clib_error_t *
-        my_init (vlib_main_t * vm)
-        {
-          my_main_t *mm = &my_main;
-
-          name = format (0, "myplugin_%08x%c", api_version, 0);
-
-          /* Ask for a correctly-sized block of API message decode slots */
-          mm->msg_id_base = vl_msg_api_get_msg_ids
-            ((char *) name, VL_MSG_FIRST_AVAILABLE);
-
-          }
-
-Control-plane codes use the vl_client_get_first_plugin_msg_id (...) api
-to recover the message ID block base:
-
-.. code-block:: C
-
-          /* Ask the vpp engine for the first assigned message-id */
-          name = format (0, "myplugin_%08x%c", api_version, 0);
-          sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
-
-It's a fairly common error to forget to add msg_id_base when
-registering message handlers, or when sending messages. Using macros
-from .../src/vlibapi/api_helper_macros.h can automate the process, but
-remember to #define REPLY_MSG_ID_BASE before #including the file:
-
-.. code-block:: C
-
-          #define REPLY_MSG_ID_BASE mm->msg_id_base
-          #include 
diff --git a/docs/gettingstarted/developers/building.rst b/docs/gettingstarted/developers/building.rst
deleted file mode 100644
index 4d7af16bc18..00000000000
--- a/docs/gettingstarted/developers/building.rst
+++ /dev/null
@@ -1,181 +0,0 @@
-.. _building:
-
-.. toctree::
-
-Building VPP
-============
-
-To get started developing with VPP, you need to get the required VPP sources and then build the packages. 
-For more detailed information on the build system please refer to :ref:`buildsystem`.
-
-.. _setupproxies:
-
-Set up Proxies
---------------------------
-
-Depending on the environment you are operating in, proxies may need to be set. 
-Run these proxy commands to specify the *proxy-server-name* and corresponding *port-number*:
-
-.. code-block:: console
-
-    $ export http_proxy=http://.com:
-    $ export https_proxy=https://.com:
-
-
-Get the VPP Sources
------------------------------------
-
-To get the VPP sources that are used to create the build, run the following commands:
-
-.. code-block:: console
-
-    $ git clone https://gerrit.fd.io/r/vpp
-    $ cd vpp
-
-Build VPP Dependencies
---------------------------------------
-
-Before building a VPP image, make sure there are no FD.io VPP or DPDK packages
-installed, by entering the following commands:
-
-.. code-block:: console
-
-    $ dpkg -l | grep vpp 
-    $ dpkg -l | grep DPDK
-
-There should be no output, or no packages shown after the above commands are run.
-
-Run the following **make** command to install the dependencies for FD.io VPP. 
-
-If the download hangs at any point, then you may need to 
-:ref:`set up proxies ` for the download to work.
-
-.. code-block:: console
-
-    $ make install-dep
-    Hit:1 http://us.archive.ubuntu.com/ubuntu xenial InRelease
-    Get:2 http://us.archive.ubuntu.com/ubuntu xenial-updates InRelease [109 kB]
-    Get:3 http://security.ubuntu.com/ubuntu xenial-security InRelease [107 kB]
-    Get:4 http://us.archive.ubuntu.com/ubuntu xenial-backports InRelease [107 kB]
-    Get:5 http://us.archive.ubuntu.com/ubuntu xenial-updates/main amd64 Packages [803 kB]
-    Get:6 http://us.archive.ubuntu.com/ubuntu xenial-updates/main i386 Packages [732 kB]
-    ...
-    ...
-    Update-alternatives: using /usr/lib/jvm/java-8-openjdk-amd64/bin/jmap to provide /usr/bin/jmap (jmap) in auto mode
-    Setting up default-jdk-headless (2:1.8-56ubuntu2) ...
-    Processing triggers for libc-bin (2.23-0ubuntu3) ...
-    Processing triggers for systemd (229-4ubuntu6) ...
-    Processing triggers for ureadahead (0.100.0-19) ...
-    Processing triggers for ca-certificates (20160104ubuntu1) ...
-    Updating certificates in /etc/ssl/certs...
-    0 added, 0 removed; done.
-    Running hooks in /etc/ca-certificates/update.d...
-
-    done.
-    done.
-
-Build VPP (Debug)
-----------------------------
-
-This build version contains debug symbols which are useful for modifying VPP. The
-**make** command below builds a debug version of VPP. The binaries, when building the
-debug images, can be found in /build-root/vpp_debug-native.
-
-The Debug build version contains debug symbols, which are useful for troubleshooting
-or modifying VPP. The **make** command below, builds a debug version of VPP. The
-binaries used for building the debug image can be found in */build-root/vpp_debug-native*.
-
-.. code-block:: console
-
-    $ make build
-    make[1]: Entering directory '/home/vagrant/vpp-master/build-root'
-    @@@@ Arch for platform 'vpp' is native @@@@
-    @@@@ Finding source for dpdk @@@@
-    @@@@ Makefile fragment found in /home/vagrant/vpp-master/build-data/packages/dpdk.mk @@@@
-    @@@@ Source found in /home/vagrant/vpp-master/dpdk @@@@
-    @@@@ Arch for platform 'vpp' is native @@@@
-    @@@@ Finding source for vpp @@@@
-    @@@@ Makefile fragment found in /home/vagrant/vpp-master/build-data/packages/vpp.mk @@@@
-    @@@@ Source found in /home/vagrant/vpp-master/src @@@@
-    ...
-    ...
-    make[5]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp/vpp-api/java'
-    make[4]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp/vpp-api/java'
-    make[3]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp'
-    make[2]: Leaving directory '/home/vagrant/vpp-master/build-root/build-vpp_debug-native/vpp'
-    @@@@ Installing vpp: nothing to do @@@@
-    make[1]: Leaving directory '/home/vagrant/vpp-master/build-root'
-
-Build VPP (Release Version)
------------------------------------------
-
-This section describes how to build the regular release version of FD.io VPP. The
-release build is optimized and does not create any debug symbols.
-The binaries used in building the release images are found in */build-root/vpp-native*.
-
-Use the following **make** command below to build the release version of FD.io VPP.
-
-.. code-block:: console
-
-    $ make build-release
-
-
-Building Necessary Packages
---------------------------------------------
-
-The package that needs to be built depends on the type system VPP will be running on:
-
-* The :ref:`Debian package ` is built if VPP is going to run on Ubuntu
-* The :ref:`RPM package ` is built if VPP is going to run on Centos or Redhat
-
-.. _debianpackages:
-
-Building Debian Packages
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To build the debian packages, use the following command:
-
-.. code-block:: console
-
-    $ make pkg-deb 
-	
-.. _rpmpackages:
-
-Building RPM Packages
-^^^^^^^^^^^^^^^^^^^^^^^
-
-To build the rpm packages, use one of the following commands below, depending on the system:
-
-.. code-block:: console
-
-    $ make pkg-rpm
-
-Once the packages are built they can be found in the build-root directory.
-
-.. code-block:: console
-    
-    $ ls *.deb
-
-    If the packages are built correctly, then this should be the corresponding output:
-
-    vpp_18.07-rc0~456-gb361076_amd64.deb             vpp-dbg_18.07-rc0~456-gb361076_amd64.deb
-    vpp-dev_18.07-rc0~456-gb361076_amd64.deb         vpp-api-lua_18.07-rc0~456-gb361076_amd64.deb
-    vpp-lib_18.07-rc0~456-gb361076_amd64.deb         vpp-api-python_18.07-rc0~456-gb361076_amd64.deb
-    vpp-plugins_18.07-rc0~456-gb361076_amd64.deb
-
-Finally, the created packages can be installed using the following commands. Install
-the package that corresponds to OS that VPP will be running on:
-
-For Ubuntu:
-
-.. code-block:: console
-
-   $ sudo bash
-   # dpkg -i *.deb
-
-For Centos or Redhat:
-
-.. code-block:: console
-
-   $ sudo bash
-   # rpm -ivh *.rpm
diff --git a/docs/gettingstarted/developers/buildsystem/buildrootmakefile.rst b/docs/gettingstarted/developers/buildsystem/buildrootmakefile.rst
deleted file mode 100644
index 84647d04b5a..00000000000
--- a/docs/gettingstarted/developers/buildsystem/buildrootmakefile.rst
+++ /dev/null
@@ -1,353 +0,0 @@
-Introduction to build-root/Makefile
-===================================
-
-The vpp build system consists of a top-level Makefile, a data-driven
-build-root/Makefile, and a set of makefile fragments. The various parts
-come together as the result of a set of well-thought-out conventions.
-
-This section describes build-root/Makefile in some detail.
-
-Repository Groups and Source Paths
-----------------------------------
-
-Current vpp workspaces comprise a single repository group. The file
-.../build-root/build-config.mk defines a key variable called
-SOURCE\_PATH. The SOURCE\_PATH variable names the set of repository
-groups. At the moment, there is only one repository group.
-
-Single pass build system, dependencies and components
------------------------------------------------------
-
-The vpp build system caters to components built with GNU autoconf /
-automake. Adding such components is a simple process. Dealing with
-components which use BSD-style raw Makefiles is a more difficult.
-Dealing with toolchain components such as gcc, glibc, and binutils can
-be considerably more complicated.
-
-The vpp build system is a **single-pass** build system. A partial order
-must exist for any set of components: the set of (a before b) tuples
-must resolve to an ordered list. If you create a circular dependency of
-the form; (a,b) (b,c) (c,a), gmake will try to build the target list,
-but there’s a 0.0% chance that the results will be pleasant. Cut-n-paste
-mistakes in .../build-data/packages/.mk can produce confusing failures.
-
-In a single-pass build system, it’s best to separate libraries and
-applications which instantiate them. For example, if vpp depends on
-libfoo.a, and myapp depends on both vpp and libfoo.a, it's best to place
-libfoo.a and myapp in separate components. The build system will build
-libfoo.a, vpp, and then (as a separate component) myapp. If you try to
-build libfoo.a and myapp from the same component, it won’t work.
-
-If you absolutely, positively insist on having myapp and libfoo.a in the
-same source tree, you can create a pseudo-component in a separate .mk
-file in the .../build-data/packages/ directory. Define the code
-phoneycomponent\_source = realcomponent, and provide manual
-configure/build/install targets.
-
-Separate components for myapp, libfoo.a, and vpp is the best and easiest
-solution. However, the “mumble\_source = realsource” degree of freedom
-exists to solve intractable circular dependencies, such as: to build
-gcc-bootstrap, followed by glibc, followed by “real” gcc/g++ [which
-depends on glibc too].
-
-.../build-root
---------------
-
-The .../build-root directory contains the repository group specification
-build-config.mk, the main Makefile, and the system-wide set of
-autoconf/automake variable overrides in config.site. We'll describe
-these files in some detail. To be clear about expectations: the main
-Makefile and config.site file are subtle and complex. It's unlikely that
-you'll need or want to modify them. Poorly planned changes in either
-place typically cause bugs that are difficult to solve.
-
-.../build-root/build-config.mk
-------------------------------
-
-As described above, the build-config.mk file is straightforward: it sets
-the make variable SOURCE\_PATH to a list of repository group absolute
-paths.
-
-The SOURCE\_PATH variable If you choose to move a workspace, make sure
-to modify the paths defined by the SOURCE\_PATH variable. Those paths
-need to match changes you make in the workspace paths. For example, if
-you place the vpp directory in the workspace of a user named jsmith, you
-might change the SOURCE\_PATH to:
-
-SOURCE\_PATH = /home/jsmithuser/workspace/vpp
-
-The "out of the box" setting should work 99.5% of the time:
-
-::
-
-        SOURCE_PATH = $(CURDIR)/..
-
-.../vpp/build-root/Makefile
----------------------------
-
-The main Makefile is complex in a number of dimensions. If you think you
-need to modify it, it's a good idea to do some research, or ask for
-advice before you change it.
-
-The main Makefile was organized and designed to provide the following
-characteristics: excellent performance, accurate dependency processing,
-cache enablement, timestamp optimizations, git integration,
-extensibility, builds with cross-compilation tool chains, and builds
-with embedded Linux distributions.
-
-If you really need to do so, you can build double-cross tools with it,
-with a minimum amount of fuss. For example, you could: compile gdb on
-x86\_64, to run on PowerPC, to debug the Xtensa instruction set.
-
-The PLATFORM variable
----------------------
-
-The PLATFORM make/environment variable controls a number of important
-characteristics, primarily:
-
--  CPU architecture
--  The list of images to build.
-
-With respect to .../build-root/Makefile, the list of images to build is
-specified by the target. For example:
-
-::
-
-       make PLATFORM=vpp TAG=vpp_debug install-deb
-
-builds vpp debug Debian packages.
-
-The main Makefile interprets $PLATFORM by attempting to "-include" the
-file /build-data/platforms.mk:
-
-::
-
-        $(foreach d,$(FULL_SOURCE_PATH), \
-          $(eval -include $(d)/platforms.mk))
-
-By convention, we don't define **platforms** in the
-...//build-data/platforms.mk file.
-
-In the vpp case, we search for platform definition makefile fragments in
-.../vpp/build-data/platforms.mk, as follows:
-
-::
-
-        $(foreach d,$(SOURCE_PATH_BUILD_DATA_DIRS), \
-             $(eval -include $(d)/platforms/*.mk))
-
-With vpp, which uses the "vpp" platform as discussed above, we end up
-"-include"-ing .../vpp/build-data/platforms/vpp.mk.
-
-The platform-specific .mk fragment
-----------------------------------
-
-Here are the contents of .../build-data/platforms/vpp.mk:
-
-::
-
-        MACHINE=$(shell uname -m)
-     
-        vpp_arch = native
-        ifeq ($(TARGET_PLATFORM),thunderx)
-        vpp_dpdk_target = arm64-thunderx-linuxapp-gcc
-        endif
-        vpp_native_tools = vppapigen
-     
-        vpp_uses_dpdk = yes
-     
-        # Uncomment to enable building unit tests
-        # vpp_enable_tests = yes
-     
-        vpp_root_packages = vpp
-     
-        # DPDK configuration parameters
-        # vpp_uses_dpdk_mlx4_pmd = yes
-        # vpp_uses_dpdk_mlx5_pmd = yes
-        # vpp_uses_external_dpdk = yes
-        # vpp_dpdk_inc_dir = /usr/include/dpdk
-        # vpp_dpdk_lib_dir = /usr/lib
-        # vpp_dpdk_shared_lib = yes
-     
-        # Use '--without-libnuma' for non-numa aware architecture
-        # Use '--enable-dlmalloc' to use dlmalloc instead of mheap
-        vpp_configure_args_vpp = --enable-dlmalloc
-        sample-plugin_configure_args_vpp = --enable-dlmalloc
-     
-        # load balancer plugin is not portable on 32 bit platform
-        ifeq ($(MACHINE),i686)
-        vpp_configure_args_vpp += --disable-lb-plugin
-        endif
-     
-        vpp_debug_TAG_CFLAGS = -g -O0 -DCLIB_DEBUG \
-            -fstack-protector-all -fPIC -Werror
-        vpp_debug_TAG_CXXFLAGS = -g -O0 -DCLIB_DEBUG \
-            -fstack-protector-all -fPIC -Werror
-        vpp_debug_TAG_LDFLAGS = -g -O0 -DCLIB_DEBUG \
-            -fstack-protector-all -fPIC -Werror
-
-        vpp_TAG_CFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
-        vpp_TAG_CXXFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
-        vpp_TAG_LDFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror -pie -Wl,-z,now
-
-        vpp_clang_TAG_CFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
-        vpp_clang_TAG_LDFLAGS = -g -O2 -D_FORTIFY_SOURCE=2 -fstack-protector -fPIC -Werror
-
-        vpp_gcov_TAG_CFLAGS = -g -O0 -DCLIB_DEBUG -fPIC -Werror -fprofile-arcs -ftest-coverage
-        vpp_gcov_TAG_LDFLAGS = -g -O0 -DCLIB_DEBUG -fPIC -Werror -coverage
-
-        vpp_coverity_TAG_CFLAGS = -g -O2 -fPIC -Werror -D__COVERITY__
-        vpp_coverity_TAG_LDFLAGS = -g -O2 -fPIC -Werror -D__COVERITY__
-
-Note the following variable settings:
-
--  The variable \_arch sets the CPU architecture used to build the
-   per-platform cross-compilation toolchain. With the exception of the
-   "native" architecture - used in our example - the vpp build system
-   produces cross-compiled binaries.
-
--  The variable \_native\_tools lists the required set of self-compiled
-   build tools.
-
--  The variable \_root\_packages lists the set of images to build when
-   specifying the target: make PLATFORM= TAG= [install-deb \|
-   install-rpm].
-
-The TAG variable
-----------------
-
-The TAG variable indirectly sets CFLAGS and LDFLAGS, as well as the
-build and install directory names in the .../vpp/build-root directory.
-See definitions above.
-
-Important targets build-root/Makefile
--------------------------------------
-
-The main Makefile and the various makefile fragments implement the
-following user-visible targets:
-
-+------------------+----------------------+--------------------------------------------------------------------------------------+
-| Target           | ENV Variable Settings| Notes                                                                                |
-|                  |                      |                                                                                      |
-+==================+======================+======================================================================================+
-| foo              |      bar             | mumble                                                                               |
-+------------------+----------------------+--------------------------------------------------------------------------------------+
-| bootstrap-tools  | none                 |  Builds the set of native tools needed by the vpp build system to                    |
-|                  |                      |  build images. Example: vppapigen. In a full cross compilation case might include    |
-|                  |                      |  include "make", "git", "find", and "tar                                             |  
-+------------------+----------------------+--------------------------------------------------------------------------------------+  
-| install-tools    | PLATFORM             | Builds the tool chain for the indicated . Not used in vpp builds           |
-+------------------+----------------------+--------------------------------------------------------------------------------------+  
-| distclean        | none                 | Roto-rooters everything in sight: toolchains, images, and so forth.                  |
-+------------------+----------------------+--------------------------------------------------------------------------------------+  
-| install-deb      | PLATFORM and TAG     | Build Debian packages comprising components listed in _root_packages,      |
-|                  |                      | using compile / link options defined by TAG.                                         |
-+------------------+----------------------+--------------------------------------------------------------------------------------+  
-| install-rpm      | PLATFORM and TAG     | Build RPMs comprising components listed in _root_packages,                 |
-|                  |                      | using compile / link options defined by TAG.                                         |
-+------------------+----------------------+--------------------------------------------------------------------------------------+  
-
-Additional build-root/Makefile environment variable settings
-------------------------------------------------------------
-
-These variable settings may be of use:
-
-+----------------------+------------------------------------------------------------------------------------------------------------+
-| ENV Variable         | Notes                                                                                                      |
-+======================+======================+=====================================================================================+
-| BUILD_DEBUG=vx       | Directs Makefile et al. to make a good-faith effort to show what's going on in excruciating detail.        |
-|                      | Use it as follows: "make ... BUILD_DEBUG=vx". Fairly effective in Makefile debug situations.               |
-+----------------------+------------------------------------------------------------------------------------------------------------+  
-| V=1                  | print detailed cc / ld command lines. Useful for discovering if -DFOO=11 is in the command line or not     |
-+----------------------+------------------------------------------------------------------------------------------------------------+  
-| CC=mygcc             | Override the configured C-compiler                                                                         |
-+----------------------+------------------------------------------------------------------------------------------------------------+  
-
-.../build-root/config.site
---------------------------
-
-The contents of .../build-root/config.site override individual autoconf /
-automake default variable settings. Here are a few sample settings related to
-building a full toolchain:
-
-::
-
-    # glibc needs these setting for cross compiling 
-    libc_cv_forced_unwind=yes
-    libc_cv_c_cleanup=yes
-    libc_cv_ssp=no
-
-Determining the set of variables which need to be overridden, and the
-override values is a matter of trial and error. It should be
-unnecessary to modify this file for use with fd.io vpp.
-
-.../build-data/platforms.mk
----------------------------
-
-Each repo group includes the platforms.mk file, which is included by
-the main Makefile. The vpp/build-data/platforms.mk file is not terribly
-complex. As of this writing, .../build-data/platforms.mk file accomplishes two
-tasks.
-
-First, it includes vpp/build-data/platforms/\*.mk:
-
-::
-
-    # Pick up per-platform makefile fragments
-    $(foreach d,$(SOURCE_PATH_BUILD_DATA_DIRS),	\
-      $(eval -include $(d)/platforms/*.mk))
-
-This collects the set of platform definition makefile fragments, as discussed above.
-
-Second, platforms.mk implements the user-visible "install-deb" target.
-
-.../build-data/packages/\*.mk
------------------------------
-
-Each component needs a makefile fragment in order for the build system
-to recognize it. The per-component makefile fragments vary
-considerably in complexity. For a component built with GNU autoconf /
-automake which does not depend on other components, the make fragment
-can be empty. See .../build-data/packages/vpp.mk for an uncomplicated
-but fully realistic example.
-
-Here are some of the important variable settings in per-component makefile fragments:
-
-+----------------------+------------------------------------------------------------------------------------------------------------+
-| Variable             | Notes                                                                                                      |
-+======================+======================+=====================================================================================+
-| xxx_configure_depend |  Lists the set of component build dependencies for the xxx component. In plain English: don't try to       |
-|                      |  configure this component until you've successfully built the indicated targets. Almost always,            |
-|                      |  xxx_configure_depend will list a set of "yyy-install" targets. Note the pattern:                          |
-|                      |  "variable names contain underscores, make target names contain hyphens"                                   |
-+----------------------+------------------------------------------------------------------------------------------------------------+  
-| xxx_configure_args   | (optional) Lists any additional arguments to pass to the xxx component "configure" script.                 |
-|                      | The main Makefile %-configure rule adds the required settings for --libdir, --prefix, and                  |
-|                      | --host (when cross-compiling)                                                                              |
-+----------------------+------------------------------------------------------------------------------------------------------------+  
-| xxx_CPPFLAGS         | Adds -I stanzas to CPPFLAGS for components upon which xxx depends.                                         |
-|                      | Almost invariably "xxx_CPPFLAGS = $(call installed_includes_fn, dep1 dep2 dep3)", where dep1, dep2, and    |
-|                      | dep3 are listed in xxx_configure_depend. It is bad practice to set "-g -O3" here. Those settings           |
-|                      | belong in a TAG.                                                                                           |
-+----------------------+------------------------------------------------------------------------------------------------------------+  
-| xxx_LDFLAGS          | Adds -Wl,-rpath -Wl,depN stanzas to LDFLAGS for components upon which xxx depends.                         |
-|                      | Almost invariably "xxx_LDFLAGS = $(call installed_lib_fn, dep1 dep2 dep3)", where dep1, dep2, and          |
-|                      | dep3 are listed in xxx_configure_depend. It is bad manners to set "-liberty-or-death" here.                |
-|                      | Those settings belong in Makefile.am.                                                                      |
-+----------------------+------------------------------------------------------------------------------------------------------------+  
-
-When dealing with "irritating" components built with raw Makefiles
-which only work when building in the source tree, we use a specific
-strategy in the xxx.mk file. 
-
-The strategy is simple for those components: We copy the source tree
-into .../vpp/build-root/build-xxx. This works, but completely defeats
-dependency processing. This strategy is acceptable only for 3rd party
-software which won't need extensive (or preferably any) modifications.
-
-Take a look at .../vpp/build-data/packages/dpdk.mk. When invoked, the
-dpdk_configure variable copies source code into $(PACKAGE_BUILD_DIR),
-and performs the BSD equivalent of "autoreconf -i -f" to configure the
-build area. The rest of the file is similar: a bunch of hand-rolled
-glue code which manages to make the dpdk act like a good vpp build
-citizen even though it is not. 
diff --git a/docs/gettingstarted/developers/buildsystem/cmakeandninja.rst b/docs/gettingstarted/developers/buildsystem/cmakeandninja.rst
deleted file mode 100644
index 580d261bdac..00000000000
--- a/docs/gettingstarted/developers/buildsystem/cmakeandninja.rst
+++ /dev/null
@@ -1,186 +0,0 @@
-Introduction to cmake and ninja
-===============================
-
-Cmake plus ninja is approximately equal to GNU autotools plus GNU
-make, respectively. Both cmake and GNU autotools support self and
-cross-compilation, checking for required components and versions.
-
-- For a decent-sized project - such as vpp - build performance is drastically better with (cmake, ninja).
-
-- The cmake input language looks like an actual language, rather than a shell scripting scheme on steroids.
-
-- Ninja doesn't pretend to support manually-generated input files. Think of it as a fast, dumb robot which eats mildly legible byte-code.
-
-See the `cmake website `_, and the `ninja website
-`_ for additional information.
-
-vpp cmake configuration files
------------------------------
-
-The top of the vpp project cmake hierarchy lives in .../src/CMakeLists.txt.
-This file defines the vpp project, and (recursively) includes two kinds
-of files: rule/function definitions, and target lists.
-
-- Rule/function definitions live in .../src/cmake/{\*.cmake}. Although the contents of these files is simple enough to read, it shouldn't be necessary to modify them very often
-
-- Build target lists come from CMakeLists.txt files found in subdirectories, which are named in the SUBDIRS list in .../src/CMakeLists.txt
-
-::
-
-    ##############################################################################
-    # subdirs - order matters
-    ##############################################################################
-    if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
-      find_package(OpenSSL REQUIRED)
-      set(SUBDIRS
-        vppinfra svm vlib vlibmemory vlibapi vnet vpp vat vcl plugins
-        vpp-api tools/vppapigen tools/g2 tools/perftool)
-    elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
-      set(SUBDIRS vppinfra)
-    else()
-      message(FATAL_ERROR "Unsupported system: ${CMAKE_SYSTEM_NAME}")
-    endif()
-
-    foreach(DIR ${SUBDIRS})
-      add_subdirectory(${DIR})
-    endforeach()
-
-- The vpp cmake configuration hierarchy discovers the list of plugins to be built by searching for subdirectories in .../src/plugins which contain CMakeLists.txt files
-
-
-::
-
-    ##############################################################################
-    # find and add all plugin subdirs
-    ##############################################################################
-    FILE(GLOB files RELATIVE
-      ${CMAKE_CURRENT_SOURCE_DIR}
-      ${CMAKE_CURRENT_SOURCE_DIR}/*/CMakeLists.txt
-    )
-    foreach (f ${files})
-      get_filename_component(dir ${f} DIRECTORY)
-      add_subdirectory(${dir})
-    endforeach()
-
-How to write a plugin CMakeLists.txt file
------------------------------------------
-
-It's really quite simple. Follow the pattern:
-
-::
-
-    add_vpp_plugin(mactime
-      SOURCES
-      mactime.c
-      node.c
-
-      API_FILES
-      mactime.api
-
-      INSTALL_HEADERS
-      mactime_all_api_h.h
-      mactime_msg_enum.h
-
-      API_TEST_SOURCES
-      mactime_test.c
-    )
-
-Adding a target elsewhere in the source tree
---------------------------------------------
-
-Within reason, adding a subdirectory to the SUBDIRS list in
-.../src/CMakeLists.txt is perfectly OK. The indicated directory will
-need a CMakeLists.txt file.
-
-.. _building-g2:
-
-Here's how we build the g2 event data visualization tool:
-
-::
-
-    option(VPP_BUILD_G2 "Build g2 tool." OFF)
-    if(VPP_BUILD_G2)
-      find_package(GTK2 COMPONENTS gtk)
-      if(GTK2_FOUND)
-        include_directories(${GTK2_INCLUDE_DIRS})
-        add_vpp_executable(g2
-          SOURCES
-          clib.c
-          cpel.c
-          events.c
-          main.c
-          menu1.c
-          pointsel.c
-          props.c
-          g2version.c
-          view1.c
-
-          LINK_LIBRARIES vppinfra Threads::Threads m ${GTK2_LIBRARIES}
-          NO_INSTALL
-        )
-      endif()
-    endif()
-
-The g2 component is optional, and is not built by default. There are
-a couple of ways to tell cmake to include it in build.ninja [or in Makefile.]
-
-When invoking cmake manually [rarely done and not very easy], specify
--DVPP_BUILD_G2=ON:
-
-::
-
-   $ cmake ... -DVPP_BUILD_G2=ON
-
-Take a good look at .../build-data/packages/vpp.mk to see where and
-how the top-level Makefile and .../build-root/Makefile set all of the
-cmake arguments. One strategy to enable an optional component is fairly
-obvious. Add -DVPP_BUILD_G2=ON to vpp_cmake_args.
-
-That would work, of course, but it's not a particularly elegant solution.
-
-Tinkering with build options: ccmake
-------------------------------------
-
-The easy way to set VPP_BUILD_G2 - or frankly **any** cmake
-parameter - is to install the "cmake-curses-gui" package and use
-it.
-
-- Do a straightforward vpp build using the top level Makefile, "make build" or "make build-release"
-- Ajourn to .../build-root/build-vpp-native/vpp or .../build-root/build-vpp_debug-native/vpp
-- Invoke "ccmake ." to reconfigure the project as desired
-
-Here's approximately what you'll see:
-
-::
-
-     CCACHE_FOUND                     /usr/bin/ccache
-     CMAKE_BUILD_TYPE
-     CMAKE_INSTALL_PREFIX             /scratch/vpp-gate/build-root/install-vpp-nati
-     DPDK_INCLUDE_DIR                 /scratch/vpp-gate/build-root/install-vpp-nati
-     DPDK_LIB                         /scratch/vpp-gate/build-root/install-vpp-nati
-     MBEDTLS_INCLUDE_DIR              /usr/include
-     MBEDTLS_LIB1                     /usr/lib/x86_64-linux-gnu/libmbedtls.so
-     MBEDTLS_LIB2                     /usr/lib/x86_64-linux-gnu/libmbedx509.so
-     MBEDTLS_LIB3                     /usr/lib/x86_64-linux-gnu/libmbedcrypto.so
-     MUSDK_INCLUDE_DIR                MUSDK_INCLUDE_DIR-NOTFOUND
-     MUSDK_LIB                        MUSDK_LIB-NOTFOUND
-     PRE_DATA_SIZE                    128
-     VPP_API_TEST_BUILTIN             ON
-     VPP_BUILD_G2                     OFF
-     VPP_BUILD_PERFTOOL               OFF
-     VPP_BUILD_VCL_TESTS              ON
-     VPP_BUILD_VPPINFRA_TESTS         OFF
-
-    CCACHE_FOUND: Path to a program.
-    Press [enter] to edit option Press [d] to delete an entry   CMake Version 3.10.2
-    Press [c] to configure
-    Press [h] for help           Press [q] to quit without generating
-    Press [t] to toggle advanced mode (Currently Off)
-
-Use the cursor to point at the VPP_BUILD_G2 line. Press the return key
-to change OFF to ON. Press "c" to regenerate build.ninja, etc.
-
-At that point "make build" or "make build-release" will build g2. And so on.
-
-Note that toggling advanced mode ["t"] gives access to substantially
-all of the cmake option, discovered directories and paths.
diff --git a/docs/gettingstarted/developers/buildsystem/index.rst b/docs/gettingstarted/developers/buildsystem/index.rst
deleted file mode 100644
index 908e91e1fc1..00000000000
--- a/docs/gettingstarted/developers/buildsystem/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. _buildsystem:
-
-Build System
-============
-
-This guide describes the vpp build system in detail. As of this writing,
-the build systems uses a mix of make / Makefiles, cmake, and ninja to
-achieve excellent build performance.
-
-.. toctree::
-
-    mainmakefile
-    cmakeandninja
-    buildrootmakefile
diff --git a/docs/gettingstarted/developers/buildsystem/mainmakefile.md b/docs/gettingstarted/developers/buildsystem/mainmakefile.md
deleted file mode 100644
index ddf0661942f..00000000000
--- a/docs/gettingstarted/developers/buildsystem/mainmakefile.md
+++ /dev/null
@@ -1,3 +0,0 @@
-Introduction to the top-level Makefile
-======================================
-
diff --git a/docs/gettingstarted/developers/buildwireshark.md b/docs/gettingstarted/developers/buildwireshark.md
deleted file mode 100644
index 5d87b7a9b7b..00000000000
--- a/docs/gettingstarted/developers/buildwireshark.md
+++ /dev/null
@@ -1,72 +0,0 @@
-How to build a vpp dispatch trace aware Wireshark
-=================================================
-
-The vpp pcap dispatch trace dissector has been merged into the wireshark
-main branch, so the process is simple. Download wireshark, compile it,
-and install it.
-
-Download wireshark source code
-------------------------------
-
-The wireshark git repo is large, so it takes a while to clone.
-
-```
-    git clone https://code.wireshark.org/review/wireshark
-```
-
-Install prerequisite packages
-------------------------------------
-
-Here is a list of prerequisite packages which must be present in order
-to compile wireshark, beyond what's typically installed on an Ubuntu
-18.04 system:
-
-```
-    libgcrypt11-dev flex bison qtbase5-dev qttools5-dev-tools qttools5-dev
-    qtmultimedia5-dev libqt5svg5-dev libpcap-dev qt5-default
-```
-
-Compile Wireshark
------------------
-
-Mercifully, Wireshark uses cmake, so it's relatively easy to build, at
-least on Ubuntu 18.04.
-
-
-```
-    $ cd wireshark
-    $ mkdir build
-    $ cd build
-    $ cmake -G Ninja ../
-    $ ninja -j 8
-    $ sudo ninja install
-```
-
-Make a pcap dispatch trace
---------------------------
-
-Configure vpp to pass traffic in some fashion or other, and then:
-
-
-```
-    vpp# pcap dispatch trace on max 10000 file vppcapture buffer-trace dpdk-input 1000
-```
-
-
-or similar. Run traffic for long enough to capture some data. Save the
-dispatch trace capture like so:
-
-```
-    vpp# pcap dispatch trace off
-```
-
-Display in Wireshark
---------------------
-
-Display /tmp/vppcapture in the vpp-enabled version of wireshark. With
-any luck, normal version of wireshark will refuse to process vpp
-dispatch trace pcap files because they won't understand the encap type.
-
-Set wireshark to filter on vpp.bufferindex to watch a single packet
-traverse the forwarding graph. Otherwise, you'll see a vector of packets
-in e.g. ip4-lookup, then a vector of packets in ip4-rewrite, etc.
diff --git a/docs/gettingstarted/developers/cnat.rst b/docs/gettingstarted/developers/cnat.rst
deleted file mode 120000
index c261d501228..00000000000
--- a/docs/gettingstarted/developers/cnat.rst
+++ /dev/null
@@ -1 +0,0 @@
-../../../src/plugins/cnat/cnat.rst
\ No newline at end of file
diff --git a/docs/gettingstarted/developers/cross_compile_macos.rst b/docs/gettingstarted/developers/cross_compile_macos.rst
deleted file mode 100644
index 5eec5569a8b..00000000000
--- a/docs/gettingstarted/developers/cross_compile_macos.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-.. _cross_compile_macos :
-
-Cross compilation on MacOS
-==========================
-
-This is a first attempt to support Cross compilation of VPP on MacOS for development (linting, completion, compile_commands.json)
-
-
-**Prerequisites**
-
-* You'll need to install the following packages
-
-.. code-block:: console
-
-  $ pip3 install ply pyyaml jsonschema
-  $ brew install gnu-sed pkg-config ninja crosstool-ng
-
-* You'll also need to install ``clang-format 10.0.0`` to be able to ``make checkstyle``. This can be done with :ref:`this doc`
-* You should link the binaries to make them available in your path with their original names e.g. :
-
-.. code-block:: console
-
-  $ ln -s $(which gsed) /usr/local/bin/sed
-
-**Setup**
-
-* Create a `cross compile toolchain `_
-* Create a case sensitive volume and mount the toolchain in it e.g. in ``/Volumes/xchain``
-* Create a xchain.toolchain file with ``$VPP_DIR/extras/scripts/cross_compile_macos.sh conf /Volumes/xchan``
-
-For now we don't support e-build so dpdk, rdma, quicly won't be compiled as part of ``make build``
-
-To build with the toolchain do:
-
-.. code-block:: console
-
-  $ $VPP_DIR/extras/scripts/cross_compile_macos.sh build
-
-
-To get the compile_commands.json do
-
-.. code-block:: console
-
-  $ $VPP_DIR/extras/scripts/cross_compile_macos.sh cc
-  $ >> ./build-root/build-vpp[_debug]-native/vpp/compile_commands.json
-
-
-
-This should build vpp on MacOS
-
-
-Good luck :)
-
-.. _install_clang_format_10_0_0 :
-
-Installing clang-format 10.0.0
-------------------------------
-
-In order to install clang-format on macos :
-
-.. code-block:: bash
-
-    $ wget https://github.com/llvm/llvm-project/releases/download/llvmorg-10.0.0/clang-10.0.0.src.tar.xz
-    $ tar -xvf clang+llvm-10.0.0-x86_64-apple-darwin.tar.xz
-    $ mv clang+llvm-10.0.0-x86_64-apple-darwin /usr/local/Cellar/
-    $ sudo ln -s ../Cellar/clang+llvm-10.0.0-x86_64-apple-darwin/bin/clang-format /usr/local/bin/clang-format
-    $ sudo ln -s ../Cellar/clang+llvm-10.0.0-x86_64-apple-darwin/bin/clang-format /usr/local/bin/clang-format-10
-    $ sudo ln -s ../Cellar/clang+llvm-10.0.0-x86_64-apple-darwin/share/clang/clang-format-diff.py /usr/local/bin/clang-format-diff-10
-
-Source `Clang website `_
diff --git a/docs/gettingstarted/developers/eventviewer.rst b/docs/gettingstarted/developers/eventviewer.rst
deleted file mode 100644
index 59aaef0604d..00000000000
--- a/docs/gettingstarted/developers/eventviewer.rst
+++ /dev/null
@@ -1,286 +0,0 @@
-.. _eventviewer:
-
-Event-logger
-============
-
-The vppinfra event logger provides very lightweight (sub-100ns)
-precisely time-stamped event-logging services. See
-./src/vppinfra/{elog.c, elog.h}
-
-Serialization support makes it easy to save and ultimately to combine a
-set of event logs. In a distributed system running NTP over a local LAN,
-we find that event logs collected from multiple system elements can be
-combined with a temporal uncertainty no worse than 50us.
-
-A typical event definition and logging call looks like this:
-
-.. code-block:: c
-
-    ELOG_TYPE_DECLARE (e) =
-    {
-      .format = "tx-msg: stream %d local seq %d attempt %d",
-      .format_args = "i4i4i4",
-    };
-    struct { u32 stream_id, local_sequence, retry_count; } * ed;
-    ed = ELOG_DATA (m->elog_main, e);
-    ed->stream_id = stream_id;
-    ed->local_sequence = local_sequence;
-    ed->retry_count = retry_count;
-
-The ELOG\_DATA macro returns a pointer to 20 bytes worth of arbitrary
-event data, to be formatted (offline, not at runtime) as described by
-format\_args. Aside from obvious integer formats, the CLIB event logger
-provides a couple of interesting additions. The "t4" format
-pretty-prints enumerated values:
-
-.. code-block:: c
-
-    ELOG_TYPE_DECLARE (e) =
-    {
-      .format = "get_or_create: %s",
-      .format_args = "t4",
-      .n_enum_strings = 2,
-      .enum_strings = { "old", "new", },
-    };
-
-The "t" format specifier indicates that the corresponding datum is an
-index in the event's set of enumerated strings, as shown in the previous
-event type definition.
-
-The “T” format specifier indicates that the corresponding datum is an
-index in the event log’s string heap. This allows the programmer to emit
-arbitrary formatted strings. One often combines this facility with a
-hash table to keep the event-log string heap from growing arbitrarily
-large.
-
-Noting the 20-octet limit per-log-entry data field, the event log
-formatter supports arbitrary combinations of these data types. As in:
-the ".format" field may contain one or more instances of the following:
-
--   i1 - 8-bit unsigned integer
--   i2 - 16-bit unsigned integer
--   i4 - 32-bit unsigned integer
--   i8 - 64-bit unsigned integer
--   f4 - float
--   f8 - double
--   s - NULL-terminated string - be careful
--   sN - N-byte character array
--   t1,2,4 - per-event enumeration ID
--   T4 - Event-log string table offset
-
-The vpp engine event log is thread-safe, and is shared by all threads.
-Take care not to serialize the computation. Although the event-logger is
-about as fast as practicable, it's not appropriate for per-packet use in
-hard-core data plane code. It's most appropriate for capturing rare
-events - link up-down events, specific control-plane events and so
-forth.
-
-The vpp engine has several debug CLI commands for manipulating its event
-log:
-
-.. code-block:: console
-
-    vpp# event-logger clear
-    vpp# event-logger save  # for security, writes into /tmp/.
-                                      #  must not contain '.' or '/' characters
-    vpp# show event-logger [all] [] # display the event log
-                                       # by default, the last 250 entries
-
-The event log defaults to 128K entries. The command-line argument "...
-vlib { elog-events nnn } ..." configures the size of the event log.
-
-As described above, the vpp engine event log is thread-safe and shared.
-To avoid confusing non-appearance of events logged by worker threads,
-make sure to code vlib\_global\_main.elog\_main - instead of
-vm->elog\_main. The latter form is correct in the main thread, but
-will almost certainly produce bad results in worker threads.
-
-G2 graphical event viewer
-==========================
-
-The G2 graphical event viewer can display serialized vppinfra event logs
-directly, or via the c2cpel tool. G2 is a fine-grained event-log viewer. It's
-highly scalable, supporting O(1e7 events) and O(1e3 discrete display "tracks").
-G2 displays binary data generated by the vppinfra "elog.[ch]" logger component,
-and also supports the CPEL file format, as described in this section.
-
-Building G2
------------
-
-This link describes :ref:`how to build G2 `
-
-Setting the Display Preferences
-------------------------------------------------
-
-The file $<*HOMEDIR*>/.g2 contains display preferences, which can be overridden.
-Simply un-comment one of the stanzas shown below, or experiment as desired.
-
-.. code-block:: c
-
-    /*
-     * Property / parameter settings for G2
-     *
-     * Setting for a 1024x768 display:
-     * event_selector_lines=20
-     * drawbox_height=800
-     * drawbox_width=600
-     *
-     * new mac w/ no monitor:
-     * event_selector_lines=20
-     * drawbox_height=1200
-     * drawbox_width=700
-     *
-     * 1600x1200:
-     * drawbox_width=1200
-     * drawbox_height=1000
-     * event_selector_lines=25
-     *
-     * for making screenshots on a Macbook Pro
-     * drawbox_width=1200
-     * drawbox_height=600
-     * event_selector_lines=20
-     */
-
-Screen Taxonomy
-----------------------------
-
-Here is an annotated G2 viewer screenshot, corresponding to activity during BGP
-prefix download. This data was captured on a Cisco IOS-XR system:
-
-.. figure:: /_images/g21.jpg
-   :scale: 75%
-
-
-The viewer has two main scrollbars: the horizontal axis scrollbar shifts the main
-drawing area in time; the vertical axis changes the set of visible process traces.
-The zoomin / zoomout operators change the time scale.
-
-The event selector PolyCheckMenu changes the set of displayed events.
-Using these tools -- and some patience -- you can understand a given event log.
-
-Mouse Gestures
--------------------------
-
-G2 has three fairly sophisticated mouse gesture interfaces, which are worth describing
-in detail. First, a left mouse click on a display event pops up a per-event detail box.
-
-.. figure:: /_images/g22.jpg
-   :scale: 75%
-
-A left mouse click on an event detail box closes it.
-To zoom to a region of the display, press and hold the left mouse button, then drag
-right or left until the zoom-fence pair appears:
-
-.. figure:: /_images/g23.jpg
-   :scale: 75%
-
-When the zoom operation completes, the display is as follows:
-
-.. figure:: /_images/g24.jpg
-
-A click on any of the figures will show them at full resolution, right-click will open figures in new tabs,
-
-Time Ruler
-------------------
-
-To use a time ruler, press and hold the right mouse button; drag right or left
-until the ruler measures the region of interest. If the time axis scale is coarse,
-event boxes can have significant width in time, so use a "reference point" in
-each event box when using the time ruler.
-
-.. figure:: /_images/g25.jpg
-   :scale: 75%
-
-Event Selection
--------------------------
-
-Changing the Event Selector setup controls the set of points displayed in an
-obvious way. Here, we suppress all events except "this thread is now running on the CPU":
-
-.. figure:: /_images/g26.jpg
-   :scale: 75%
-
-Same setup, with all events displayed:
-
-.. figure:: /_images/g27.jpg
-   :scale: 75%
-
-Note that event detail boxes previously shown, but suppressed due to deselection
-of the event code will reappear when one reselects the event code. In the example
-above, the "THREAD/THREADY pid:491720 tid:12" detail box appears in this fashion.
-
-Snapshot Ring
------------------------
-
-Three buttons in lower left-hand corner of the g2 main window control the snapshot
-ring. Snapshots are simply saved views: maneuver the viewer into an "interesting"
-configuration, then press the "Snap" button to add a snapshot to the ring.
-
-Click **Next** to restore the next available snapshot. The **Del** button deletes the current snapshot.
-
-See the hotkey section below for access to a quick and easy method to save and
-restore the snapshot ring. Eventually we may add a safe/portable/supported mechanism
-to save/restore the snapshot ring from CPEL and vppinfra event log files.
-
-Chasing Events
-------------------------
-
-Event chasing sorts the trace axis by occurrence of the last selected event. For
-example, if one selects an event which means "thread running on the CPU" the first
-N displayed traces will be the first M threads to run (N <= M; a thread may run
-more than once. This feature addresses analytic problems caused by the finite size of the drawing area.
-
-In standard (NoChaseEvent) mode, it looks like only BGP threads 5 and 9 are active:
-
-.. figure:: /_images/g28.jpg
-   :scale: 75%
-
-After pressing the ChaseEvent button, we see a different picture:
-
-.. figure:: /_images/g29.jpg
-   :scale: 75%
-
-Burying Boring Tracks
------------------------------------
-
-The sequence  moves the track under the mouse to the end
-of the set of tracks, effectively burying it. The sequence 
-moves the track under the mouse to the beginning of the set of tracks. The latter
-function probably isn't precisely right--I think we may eventually provide an "undo"
-stack to provide precise thread exhumation.
-
-Summary Mode
--------------------------
-
-Summary mode declutters the screen by rendering events as short vertical line
-segments instead of numbered boxes. Event detail display is unaffected. G2 starts
-in summary mode, zoomed out sufficiently for all events in the trace to be displayed.
-Given a large number of events, summary mode reduces initial screen-paint time to a
-tolerable value. Once you've zoomed in sufficiently, type "e" - enter event mode,
-to enable boxed numeric event display.
-
-Hotkeys
--------------
-
-G2 supports the following hotkey actions, supposedly (circa 1996) Quake-like
-according to the feature's original author:
-
-+----------------------+--------------------------------------------------------+
-| Key                  | Function                                               |
-+======================+========================================================+
-| w                    | Zoom-in                                                |
-+----------------------+--------------------------------------------------------+
-| s                    | Zoom-out                                               |
-+----------------------+--------------------------------------------------------+
-| a                    | Scroll Left                                            |
-+----------------------+--------------------------------------------------------+
-| d                    | Scroll Right                                           |
-+----------------------+--------------------------------------------------------+
-| e                    | Toggle between event and summary-event mode            |
-+----------------------+--------------------------------------------------------+
-| p                    | Put (write) snapshot ring to snapshots.g2              |
-+----------------------+--------------------------------------------------------+
-| l                    | Load (read) snapshot ring from snapshots.g2            |
-+----------------------+--------------------------------------------------------+
-| -q             | quit                                                   |
-+----------------------+--------------------------------------------------------+
diff --git a/docs/gettingstarted/developers/featurearcs.md b/docs/gettingstarted/developers/featurearcs.md
deleted file mode 100644
index f1e3ec47d05..00000000000
--- a/docs/gettingstarted/developers/featurearcs.md
+++ /dev/null
@@ -1,224 +0,0 @@
-Feature Arcs
-============
-
-A significant number of vpp features are configurable on a per-interface
-or per-system basis. Rather than ask feature coders to manually
-construct the required graph arcs, we built a general mechanism to
-manage these mechanics.
-
-Specifically, feature arcs comprise ordered sets of graph nodes. Each
-feature node in an arc is independently controlled. Feature arc nodes
-are generally unaware of each other. Handing a packet to "the next
-feature node" is quite inexpensive.
-
-The feature arc implementation solves the problem of creating graph arcs
-used for steering.
-
-At the beginning of a feature arc, a bit of setup work is needed, but
-only if at least one feature is enabled on the arc.
-
-On a per-arc basis, individual feature definitions create a set of
-ordering dependencies. Feature infrastructure performs a topological
-sort of the ordering dependencies, to determine the actual feature
-order. Missing dependencies **will** lead to runtime disorder. See
- for an example.
-
-If no partial order exists, vpp will refuse to run. Circular dependency
-loops of the form "a then b, b then c, c then a" are impossible to
-satisfy.
-
-Adding a feature to an existing feature arc
--------------------------------------------
-
-To nobody's great surprise, we set up feature arcs using the typical
-"macro -> constructor function -> list of declarations" pattern:
-
-```c
-    VNET_FEATURE_INIT (mactime, static) =
-    {
-      .arc_name = "device-input",
-      .node_name = "mactime",
-      .runs_before = VNET_FEATURES ("ethernet-input"),
-    };  
-```
-
-This creates a "mactime" feature on the "device-input" arc.
-
-Once per frame, dig up the vnet\_feature\_config\_main\_t corresponding
-to the "device-input" feature arc:
-
-```c
-    vnet_main_t *vnm = vnet_get_main ();
-    vnet_interface_main_t *im = &vnm->interface_main;
-    u8 arc = im->output_feature_arc_index;
-    vnet_feature_config_main_t *fcm;
-
-    fcm = vnet_feature_get_config_main (arc);
-```
-
-Note that in this case, we've stored the required arc index - assigned
-by the feature infrastructure - in the vnet\_interface\_main\_t. Where
-to put the arc index is a programmer's decision when creating a feature
-arc.
-
-Per packet, set next0 to steer packets to the next node they should
-visit:
-
-```c
-    vnet_get_config_data (&fcm->config_main,
-                          &b0->current_config_index /* value-result */, 
-                          &next0, 0 /* # bytes of config data */);
-```
-
-Configuration data is per-feature arc, and is often unused. Note that
-it's normal to reset next0 to divert packets elsewhere; often, to drop
-them for cause:
-
-```c
-    next0 = MACTIME_NEXT_DROP;
-    b0->error = node->errors[DROP_CAUSE];
-```
-
-Creating a feature arc
-----------------------
-
-Once again, we create feature arcs using constructor macros:
-
-```c
-    VNET_FEATURE_ARC_INIT (ip4_unicast, static) =
-    {
-      .arc_name = "ip4-unicast",
-      .start_nodes = VNET_FEATURES ("ip4-input", "ip4-input-no-checksum"),
-      .arc_index_ptr = &ip4_main.lookup_main.ucast_feature_arc_index,
-    };  
-```
-
-In this case, we configure two arc start nodes to handle the
-"hardware-verified ip checksum or not" cases. During initialization,
-the feature infrastructure stores the arc index as shown.
-
-In the head-of-arc node, do the following to send packets along the
-feature arc:
-
-```c
-    ip_lookup_main_t *lm = &im->lookup_main;
-    arc = lm->ucast_feature_arc_index;
-```
-
-Once per packet, initialize packet metadata to walk the feature arc:
-
-```c
-vnet_feature_arc_start (arc, sw_if_index0, &next, b0);
-```
-
-Enabling / Disabling features
------------------------------
-
-Simply call vnet_feature_enable_disable to enable or disable a specific
-feature:
-
-```c
-    vnet_feature_enable_disable ("device-input", /* arc name */
-                                 "mactime",      /* feature name */
-           		             sw_if_index,    /* Interface sw_if_index */
-                                 enable_disable, /* 1 => enable */
-                                 0 /* (void *) feature_configuration */, 
-                                 0 /* feature_configuration_nbytes */);
-```
-
-The feature_configuration opaque is seldom used. 
-
-If you wish to make a feature a _de facto_ system-level concept, pass
-sw_if_index=0 at all times. Sw_if_index 0 is always valid, and
-corresponds to the "local" interface.
-
-Related "show" commands
------------------------
-
-To display the entire set of features, use "show features [verbose]". The
-verbose form displays arc indices, and feature indicies within the arcs
-
-```
-$ vppctl show features verbose
-Available feature paths
-
-[14] ip4-unicast:
-  [ 0]: nat64-out2in-handoff
-  [ 1]: nat64-out2in
-  [ 2]: nat44-ed-hairpin-dst
-  [ 3]: nat44-hairpin-dst
-  [ 4]: ip4-dhcp-client-detect
-  [ 5]: nat44-out2in-fast
-  [ 6]: nat44-in2out-fast
-  [ 7]: nat44-handoff-classify
-  [ 8]: nat44-out2in-worker-handoff
-  [ 9]: nat44-in2out-worker-handoff
-  [10]: nat44-ed-classify
-  [11]: nat44-ed-out2in
-  [12]: nat44-ed-in2out
-  [13]: nat44-det-classify
-  [14]: nat44-det-out2in
-  [15]: nat44-det-in2out
-  [16]: nat44-classify
-  [17]: nat44-out2in
-  [18]: nat44-in2out
-  [19]: ip4-qos-record
-  [20]: ip4-vxlan-gpe-bypass
-  [21]: ip4-reassembly-feature
-  [22]: ip4-not-enabled
-  [23]: ip4-source-and-port-range-check-rx
-  [24]: ip4-flow-classify
-  [25]: ip4-inacl
-  [26]: ip4-source-check-via-rx
-  [27]: ip4-source-check-via-any
-  [28]: ip4-policer-classify
-  [29]: ipsec-input-ip4
-  [30]: vpath-input-ip4
-  [31]: ip4-vxlan-bypass
-  [32]: ip4-lookup
-
-```
-
-Here, we learn that the ip4-unicast feature arc has index 14, and that
-e.g. ip4-inacl is the 25th feature in the generated partial order.
-
-To display the features currently active on a specific interface,
-use "show interface  features":
-
-```
-$ vppctl show interface GigabitEthernet3/0/0 features
-Feature paths configured on GigabitEthernet3/0/0...
-
-ip4-unicast:
-  nat44-out2in
-
-```
-
-Table of Feature Arcs
----------------------
-
-Simply search for name-strings to track down the arc definition, location of
-the arc index, etc.
-
-```
-            |    Arc Name      |
-            |------------------|
-            | device-input     |
-            | ethernet-output  |
-            | interface-output |
-            | ip4-drop         |
-            | ip4-local        |
-            | ip4-multicast    |
-            | ip4-output       |
-            | ip4-punt         |
-            | ip4-unicast      |
-            | ip6-drop         |
-            | ip6-local        |
-            | ip6-multicast    |
-            | ip6-output       |
-            | ip6-punt         |
-            | ip6-unicast      |
-            | mpls-input       |
-            | mpls-output      |
-            | nsh-output       |
-```
diff --git a/docs/gettingstarted/developers/fib20/attachedexport.rst b/docs/gettingstarted/developers/fib20/attachedexport.rst
deleted file mode 100644
index 3bf933de679..00000000000
--- a/docs/gettingstarted/developers/fib20/attachedexport.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-.. _attachedexport:
-
-Attached Export
-^^^^^^^^^^^^^^^^
-
-Extranets make prefixes in table A also reachable from table B. Table A is the export table,
-B the import. Consider this route in the export table;
-
-.. code-block:: console
-
-   # ip route add table 2 1.1.1.0/24 via 10.10.10.0 GigabitEthernet0/8/0
-
-there are two ways one might consider representing this route in the import VRF:
-
-#. ip route add table 3 1.1.1.0/24 via 10.10.10.0 GigabitEthernet0/8/0
-#. ip route add table 3 1.1.1.0/24 via lookup-in-table 2
-
-where option 2) is an example of a de-aggregate route where a second lookup is
-performed in table 2, the export VRF. Option 2) is clearly less efficient, since
-the cost of the second lookup is high. Option 1) is therefore preferred. However,
-connected and attached prefixes, and specifically the adj-fibs that they cover,
-require special attention. The control plane is aware of the connected and
-attached prefixes that are required to be exported, but it is unaware of the
-adj-fibs. It is therefore the responsibility of FIB to ensure that whenever an
-attached prefix is exported, so are the adj-fibs and local prefixes that it
-covers, and only the adj-fibs and locals, not any covered more specific
-(sourced e.g. by API). The imported FIB entries are sourced as *attached-export*
-this is a low priority source, so if those prefixes already exist in the import
-table, sourced by the API, then they will continue to forward with that information.
-
-.. figure:: /_images/fib20fig6.png
-
-Figure 6: Attached Export Class diagram.
-
-Figure 6 shows the data structures used to perform attached export.
-
-- *fib_import_t*. A representation of the need to import covered prefixes. An instance is associated with the FIB entry in the import VRF. The need to import prefixes is recognised when an attached route is added to a table that is different to the table of the interface to which it t is attached. The creation of a *fib_import_t* will trigger the creation of a *fib_export_t*.
-- *fib_export_t*. A representation of the need to export prefixes. An instance is associated with the attached entry in the export VRF. A *fib_export_t* can have many associated *fib_import_t* objects representing multiple VRFs into which the prefix is exported.
-
-.. figure:: /_images/fib20fig6.png
-
-Figure 7: Attached Export object diagram
-
-Figure 7 shows an object instance diagram for the export of a connected from table
-1 to two other tables. The /32 adj-fib and local prefix in the export VRF are
-exported into the import VRFs, where they are sourced as *attached-export* and
-inherit the forwarding information from the exported entry. The attached prefix
-in the import VRF also performs cover tracking with the connected prefix in the
-export VRF so that it can react to updates to that prefix that will require the
-removal the imported covered prefixes.
diff --git a/docs/gettingstarted/developers/fib20/barnacles.rst b/docs/gettingstarted/developers/fib20/barnacles.rst
deleted file mode 100644
index b5b89a34b36..00000000000
--- a/docs/gettingstarted/developers/fib20/barnacles.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-.. _barnacles:
-
-Barnacles
----------
-
-Features that are stuck on the side of the FIB. Those that directly use
-the services that the FIB provides.
-
-In the section on FIB fundamentals it was mentioned  that there is a
-separation between what to match and how to forward. In an IP FIB what
-to match is the packet's destination address against a table of IP
-prefixes, and how to forward is described by a list of paths (the
-**fib_path_list_t**).
-
-ACL Based Forwarding
-^^^^^^^^^^^^^^^^^^^^
-
-ACL Based Forwarding (ABF) is also know as policy based routing
-(PBR). In ABF what to match is described by an ACL.
-
-ABF uses two VPP services; ACL as a service, as provided by the ACL
-plugin and FIB path-lists. It just glues them together.
-
-An ABF policy is the combination of an ACL with the forwarding
-description of a FIB path-list. An ABF attachment is the association
-of [an ordered set of] ABF policies to an interface. The attachment is
-consulted on the ingress path of the IP DP (as an input
-feature). If the ACL matches then the associated forwarding is
-followed, if not, the packet continues along the DP. Simples.
-
-Layer 3 Cross Connect
-^^^^^^^^^^^^^^^^^^^^^
-
-An L3 cross-connect (L3XC) matches all packets
-that ingress the interface and then forwards using the supplied FIB
-path-list. Naturally it runs as an input feature in the IP
-path. Super simples.
-
-IP Punt
-^^^^^^^
-
-Matches all IP packets that VPP has punted. Why they are punted is not
-relevant. All IP punted packets are sent by VPP to the punt feature
-arc. This feature 'matches' all packets that it receives and forwards
-using the FIB path-list.
-
-
-Unicast Reverse Path Forwarding
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Unicast Reverse Path Forwarding (uRPF) is the process of ensuring that
-a packet has a conforming source address. It comes in two
-flavours:
-
-- loose: The source address must be reachable, i.e. FIB must have a
-  route that will forward to the source address. The default route
-  counts as long as it does not drop.
-- strict: The source address is reachable via the interface on which
-  the packet arrived, i.e. the FIB's route for the source address must
-  include the input interface as an output interface.
-
-The uRPF feature can run on either the input or output IP feature
-arc. In both cases it serves as an anti-spoofing check, though the
-semantics are slightly different. On the input arc it enforces that
-peers on that link are only using source addresses that they should -
-a network admin should employ at the access edge. On the output
-arc it enforces that a packet is sourced from a prefix that belongs to
-the network, i.e. that is has originated from within an SP's
-network, a network admin could use at its peering points.
-
-To perform a uRPF check, the DP performs an IP FIB lookup on the
-source address, this always results in a load-balance (LB) object. If
-the LB has only 1 bucket and that bucket stacks on a drop DPO, then
-both a loose and strict check will fail, otherwise a loose check
-will pass. Each LB object has an associated uRPF list object. This
-object holds the list of interfaces through which the prefix is
-reachable. To pass the strict check, the input/output interface must
-be in this list.
diff --git a/docs/gettingstarted/developers/fib20/controlplane.rst b/docs/gettingstarted/developers/fib20/controlplane.rst
deleted file mode 100644
index 8b58d42f5b3..00000000000
--- a/docs/gettingstarted/developers/fib20/controlplane.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-.. _controlplane:
-
-The Control Plane
------------------
-
-The control plane follows a layered data representation. This document describes the
-model starting from the lowest layer. The description uses IPv4 addresses and
-protocols, but all concepts apply equally to the IPv6 equivalents. The diagrams
-all portray the CLI command to install the information in VPP and an
-[approximation of] a UML diagram [#f1]_ of the data structures used to represent that
-information.
-
-.. toctree::
-
-   neighbors
-   routes
-   attachedexport
-   graphwalks
-   marknsweep
-
-.. rubric:: Footnotes:
-
-.. [#f1] The arrow indicates a ‘has-a’ relationship. The object attached to the arrow head ‘has-a’ instance of the other. The numbers next to the arrows indicate the multiplicity, i.e. object A has n to m instances of object B. The difference between a UML association and aggregation is not conveyed in any diagrams. To UML aficionados, I apologize. Word is not the best drawing tool.
diff --git a/docs/gettingstarted/developers/fib20/dataplane.rst b/docs/gettingstarted/developers/fib20/dataplane.rst
deleted file mode 100644
index 34886e18a44..00000000000
--- a/docs/gettingstarted/developers/fib20/dataplane.rst
+++ /dev/null
@@ -1,100 +0,0 @@
-.. _dataplane:
-
-The Data Plane
----------------
-
-The data-plane data model is a directed, acyclic [#f16]_ graph of heterogeneous objects.
-A packet will forward walk the graph as it is switched. Each object describes
-the actions to perform on the packet. Each object type has an associated VLIB
-graph node. For a packet to forward walk the graph is therefore to move from one
-VLIB node to the next, with each performing the required actions. This is the
-heart of the VPP model. 
-
-The data-plane graph is composed of generic data-path objects (DPOs). A parent
-DPO is identified by the tuple:{type,index,next_node}. The *next_node* parameter
-is the index of the VLIB node to which the packets should be sent next, this is
-present to maximise performance - it is important to ensure that the parent does
-not need to be read [#f17]_ whilst processing the child. Specialisations [#f18]_ of the DPO
-perform distinct actions. The most common DPOs and briefly what they represent are:
-
-- Load-balance: a choice in an ECMP set. 
-- Adjacency:  apply a rewrite and forward through an interface
-- MPLS-label: impose an MPLS label.
-- Lookup: perform another lookup in a different table.
-
-The data-plane graph is derived from the control-plane graph by the objects
-therein 'contributing' a DPO to the data-plane graph. Objects in the data-plane
-contain only the information needed to switch a packet, they are therefore
-simpler, and in memory terms smaller, with the aim to fit one DPO on a single
-cache-line. The derivation from the control plane means that the data-plane
-graph contains only object whose current state can forward packets. For example,
-the difference between a *fib_path_list_t* and a *load_balance_t* is that the former
-expresses the control-plane's desired state, the latter the data-plane available
-state. If some paths in the path-list are unresolved or down, then the
-load-balance will not include them in the forwarding choice.
-
-.. figure:: /_images/fib20fig8.png
-
-Figure 8: DPO contributions for a non-recursive route
-
-Figure 8 shows a simplified view of the control-plane graph indicating those
-objects that contribute DPOs. Also shown are the VLIB node graphs at which the DPO is used.
-
-Each *fib_entry_t* contributes it own *load_balance_t*, for three reasons;
-
-- The result of a lookup in a IPv[46] table is a single 32 bit unsigned integer. This is an index into a memory pool. Consequently the object type must be the same for each result. Some routes will need a load-balance and some will not, but to insert another object in the graph to represent this choice is a waste of cycles, so the load-balance object is always the result. If the route does not have ECMP, then the load-balance has only one choice. 
-
-- In order to collect per-route counters, the lookup result must in some way uniquely identify the *fib_entry_t*. A shared load-balance (contributed by the path-list) would not allow this.
-- In the case the *fib_entry_t* has MPLS out labels, and hence a *fib_path_ext_t*, then the load-balance must be per-prefix, since the MPLS labels that are its parents are themselves per-fib_entry_t.
-
-.. figure:: /_images/fib20fig9.png
-
-Figure 9: DPO contribution for a recursive route.
-
-Figure 9 shows the load-balance objects contributed for a recursive route.
-
-.. figure:: /_images/fib20fig10.png
-
-Figure 10: DPO Contributions from labelled recursive routes.
-
-Figure 10 shows the derived data-plane graph for a labelled recursive route.
-There can be as many MPLS-label DPO instances as there are routes multiplied by
-the number of paths per-route. For this reason the mpls-label DPO should be as
-small as possible [#f19]_.
-
-The data-plane graph is constructed by 'stacking' one
-instance of a DPO on another to form the child-parent relationship. When this
-stacking occurs, the necessary VLIB graph arcs are automatically constructed
-from the respected DPO type's registered graph nodes.
-
-The diagrams above show that for any given route the full data-plane graph is
-known before any packet arrives. If that graph is composed of n objects, then the
-packet will visit n nodes and thus incur a forwarding cost of approximately n
-times the graph node cost. This could be reduced if the graph were *collapsed*
-into fewer DPOs and nodes. There are two ways we might consider doing
-this:
-
-- write custom DPOs/nodes for combinded functions, e.g. pop MPLS label
-  and lookup in v4 table. This has the disadvantage that the number of
-  such nodes would be, well, combinatorial, and resolving a path via
-  a combined DPO would be more difficult as it would involve a
-  forward walk of the graph to determine what the combination
-  is. However, VPP power users might consider this option for a
-  limited set of their use cases where performance is truely king.
-- collapse multiple levels of load-balancing into one. For example,
-  if there were two levels of load-balancing each with two choices,
-  this could equally be represented by one level with 4 choices.
-
-In either case a disadvantage to collapsing the graph is that it
-removes the indirection objects that provide fast convergence (see
-section Fast Convergence). To collapse is then a trade-off between
-faster forwarding and fast convergence; VPP favours the latter.
-
-
-.. rubric:: Footnotes:
-
-.. [#f16] Directed implies it cannot be back-walked. It is acyclic even in the presence of a recursion loop.
-.. [#f17] Loaded into cache, and hence potentially incurring a d-cache miss.
-.. [#f18] The engaged reader is directed to vnet/vnet/dpo/*
-.. [#f19] i.e. we should not re-use the adjacency structure.
-
diff --git a/docs/gettingstarted/developers/fib20/debugging.rst b/docs/gettingstarted/developers/fib20/debugging.rst
deleted file mode 100644
index e0a85fd736e..00000000000
--- a/docs/gettingstarted/developers/fib20/debugging.rst
+++ /dev/null
@@ -1,106 +0,0 @@
-.. _debugging:
-
-Debugging
----------
-
-the anatomy of a route:
-
-.. code-block:: console
-
-  BGvpp# sh ip fib 1.1.1.3/32
-  ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
-  1.1.1.0/24 fib:0 index:9 locks:2
-    CLI refs:1 src-flags:added,contributing,active,
-      path-list:[24] locks:4 flags:shared, uPRF-list:11 len:1 itfs:[1, ]
-        path:[26] pl-index:24 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
-          10.0.0.1 loop0
-        [@0]: arp-ipv4: via 10.0.0.1 loop0
-
-   forwarding:   unicast-ip4-chain
-    [@0]: dpo-load-balance: [proto:ip4 index:11 buckets:1 uRPF:11 to:[0:0]]
-      [0] [@3]: arp-ipv4: via 10.0.0.1 loop0
-
-let's go line by line.
-
-.. code-block:: console
-
-     ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
-
-Each field in turn:
-
-- ipv4-VRF:0: the name of the table (as given by the user, or
-  automatically generated by VPP).
-- fib-index:0; in the VPP pool of FIB objects, this is index 0
-- flow hash:[src dst sport dport proto ]: When calculating the flow
-  hash to use for load-balanacing, these are the fields in the packet
-  that are used. There is an API to change this per-table.
-- epoch:0; Used during mark-n-sweep.
-- flags:none; use the force, to find the per-table flags.
-- locks: per-source reference counting, a table can only be deleted
-  when all sources no longer reference it.
-
-next line:
-
-.. code-block:: console
-
-   1.1.1.0/24 fib:0 index:9 locks:2
-
-this shows the route that matched the show request. note that it is not
-an exact match, it's an LPM. The route is in FIB index 0, its index
-(in the VPP pool of fib_entry_t objects) is nine and there are two
-references to the entry.
-You'll get the same output if you type "sh fib entry 9"
-
-next line:
-
-.. code-block:: console
-
-    CLI refs:1 src-flags:added,contributing,active,
-
-the 'CLI' has sourced this route (it was added via CLI). This source
-has been added (well duh) it is 'active', meaning it is the best
-source, and it is contributing a forwarding object. There are some
-scenarios where sources other than the active source contribute,
-namely interpose sources.
-
-next line:
-
-.. code-block:: console
-
-      path-list:[24] locks:4 flags:shared, uPRF-list:11 len:1 itfs:[1, ]
-
-This is path-list inex 24 (see "sh fib path-list 24" this will also
-show the  children), it is 'shared',
-meaning that if other prefixes were to use the same set of paths,
-then they would also use this path-list object. It has uRPF list 11 of
-length 1 containing interface index 1 (which is loop0, see "sh int").
-
-next line:
-
-.. code-block:: console
-
-        path:[26] pl-index:24 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
-          10.0.0.1 loop0
-        [@0]: arp-ipv4: via 10.0.0.1 loop0
-
-This is path 26 (see "sh fib path 26"). It's a member of
-path-list 24. It's ip4 has a weight of 1 and a preference of 0. It's
-of type 'attached-nexthop' and currently resolved - woohoo.
-It is a path 'via 10.0.0.1 loop0'. It is contributing an incomplete adjacency.
-   
-next line:
-
-.. code-block:: console
-
-  forwarding:   unicast-ip4-chain
-    [@0]: dpo-load-balance: [proto:ip4 index:11 buckets:1 uRPF:11 to:[0:0]]
-      [0] [@3]: arp-ipv4: via 10.0.0.1 loop0
-
-This section describes how packets of type 'unicast-ip4' will be
-forwarded. It is the result of processing the path information from
-above.
-Here we see load-balance object 11, which has 1 bucket/choice. It is
-also linked to uRPF instance 11 (which it got from path-list 24).
-In bucket 0 there is the incomplete adjacnecy that was contributed by
-path 26.
-
diff --git a/docs/gettingstarted/developers/fib20/fastconvergence.rst b/docs/gettingstarted/developers/fib20/fastconvergence.rst
deleted file mode 100644
index b07e08cea6d..00000000000
--- a/docs/gettingstarted/developers/fib20/fastconvergence.rst
+++ /dev/null
@@ -1,576 +0,0 @@
-.. _fastconvergence:
-
-Fast Convergence
-------------------------------------
-
-This is an excellent description of the topic:
-
-'FIB '_
-
-but if you're interested in my take keep reading...
-
-First some definitions:
-
-- Convergence; When a FIB is forwarding all packets correctly based
-  on the network topology (i.e. doing what the routing control plane
-  has instructed it to do), then it is said to be 'converged'.
-  Not being in a converged state is [hopefully] a transient state,
-  when either the topology change (e.g. a link failure) has not been
-  observed or processed by the routing control plane, or that the FIB
-  is still processing routing updates. Convergence is the act of
-  getting to the converged state.
-- Fast: In the shortest time possible. There are no absolute limits
-  placed on how short this must be, although there is one number often
-  mentioned. Apparently the human ear can detect loss/delay/jitter in
-  VOIP of 50ms, therefore network failures should last no longer than
-  this, and some technologies (notably link-free alternate fast
-  reroute) are designed to converge in this time. However, it is
-  generally accepted that it is not possible to converge a FIB with
-  tens of millions of routes in this time scale, the industry
-  'standard' is sub-second.
-
-Converging the FIB quickly is thus a matter of:
-
-- discovering something is down
-- updating as few objects as possible
-- to determine which objects to update as efficiently as possible
-- to update each object as quickly as possible
-
-we'll discuss each in turn.
-All output came from VPP version 21.01rc0. In what follows I use IPv4
-prefixes, addresses and IPv4 host length masks, however, exactly the
-same applies to IPv6.
-
-
-Failure Detection
-^^^^^^^^^^^^^^^^^
-
-The two common forms (we'll see others later on) of failure detection
-are:
-
-- link down
-- BFD
-
-The FIB needs to hook into these notifications to trigger
-convergence.
-
-Whenever an interface goes down, VPP issues a callback to all
-registerd clients. The adjacency code is such a client. The adjacency
-is a leaf node in the FIB control-plane graph (containing fib_path_t,
-fib_entry_t etc). A back-walk from the adjacnecy will trigger a
-re-resolution of the paths.
-
-FIB is a client of BFD in order to receive BFD notifications. BFD
-comes in two flavours; single and multi hop. Single hop is to protect
-a specific peer on an interface, such peers are modelled by an
-adjacency. Multi hop is to protect a peer on an unspecified interface
-(i.e. a remote peer), this peer is represented by a host-prefix
-**fib_entry_t**. In both case FIB will add a delegate to the
-**ip_adjacency_t** or **fib_entry_t** that represents the association
-to the BFD session. If the BFD session signals up/down then a backwalk
-can be triggered from the object to trigger re-resolution and hence
-convergence.
-
-
-Few Updates
-^^^^^^^^^^^
-
-In order to talk about what 'a few' is we have to leave the realm of
-the FIB as an abstract graph based object DB and move into the
-concrete representation of forwarding in a large network. Large
-networks are built in layers, it's how you scale them. We'll take
-here a hypothetical service provider (SP) network, but the concepts
-apply equally to data center leaf-spines. This is a rudimentary
-description, but it should serve our purpose. 
-
-An SP manages a BGP autonomous system (AS). The SP's goal is both to
-attract traffic into its network to serve its customers, but also to
-serve transit traffic passing through it, we'll consider the latter here.
-The SP's network is all devices in that AS, these
-devices are split into those at the edge (provider edge (PE) routers)
-which peer with routers in other SP networks,
-and those in the core (termed provider (P) routers). Both the PE and P
-routers run the IGP (usually OSPF or ISIS). Only the reachability of the devices
-in the AS are advertised in the IGP - thus the scale (i.e. the number
-of routes) in the IGP is 'small' -  only the number of
-devices that the SP has (typically not more than a few 10k).
-PE routers run BGP; they have external BGP sessions to devices in
-other ASs and internal BGP sessions to devices in the same AS. BGP is
-used to advertise the routes to *all* networks on the internet - at
-the time of writing this number is approaching 900k IPv4 route, hopefully by
-the time you are reading this the number of IPv6 routes has caught up ...
-If we include the additional routes the SP carries to offering VPN service to its
-customers the number of BGP routes can grow to the tens of millions.
-
-BGP scale thus exceeds IGP scale by two orders of magnitude... pause for
-a moment and let that sink in...
-
-A comparison of BGP and an IGP is way way beyond the scope of this
-documentation (and frankly beyond me) so we'll note only the
-difference in the form of the routes they present to FIB. A routing
-protocol will produce routes that specify the prefixes that are
-reachable through its peers. A good IGP
-is link state based, it forms peerings to other devices over these
-links, hence its routes specify links/interfaces. In
-FIB nomenclature this means an IGP produces routes that are
-attached-nexthop, e.g.:
-
-.. code-block:: console
-
-    ip route add 1.1.1.1/32 via 10.0.0.1 GigEthernet0/0/0
-
-BGP on the other hand forms peerings only to neighbours, it does not
-know, nor care, what interface is used to reach the peer. In FIB
-nomenclature therefore BGP produces recursive routes, e.g.:
-
-.. code-block:: console
-
-    ip route 8.0.0.0/16 via 1.1.1.1
-
-where 1.1.1.1 is the BGP peer. It's no accident in this example that
-1.1.1.1/32 happens to be the route the IGP advertised... BGP installs
-routes for prefixes reachable via other BGP peers, and the IGP install
-the routes to those BGP peers.
-
-This has been a very long winded way of describing why the scale of
-recursive routes is therefore 2 orders of magnitude greater than
-non-recursive/attached-nexthop routes.
-
-If we step back for a moment and recall why we've crawled down this
-rabbit hole, we're trying to determine what 'a few' updates means,
-does it include all those recursive routes, probably not ... let's
-keep crawling.
-
-We started this chapter with an abstract description of convergence,
-let's now make that more real. In the event of a network failure an SP
-is interested in moving to an alternate forwarding path as quickly as
-possible. If there is no alternate path, and a converged FIB will drop
-the packet, then who cares how fast it converges. In other words the
-interesting convergence scenarios are the scenarios where the network has
-alternate paths.
-
-PIC Core
-^^^^^^^^
-
-First let's consider alternate paths in the IGP, e.g.;
-
-.. code-block:: console
-
-    ip route add 1.1.1.1/32 via 10.0.0.2 GigEthernet0/0/0
-    ip route add 1.1.1.1/32 via 10.0.1.2 GigEthernet0/0/1
-
-this gives us in the FIB:
-
-.. code-block:: console
-
-                DBGvpp# sh ip fib 1.1.1.1/32
-                  ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, default-route:1, ]
-                  1.1.1.1/32 fib:0 index:15 locks:2
-                    API refs:1 src-flags:added,contributing,active,
-                      path-list:[23] locks:2 flags:shared, uPRF-list:22 len:2 itfs:[1, 2, ]
-                        path:[27] pl-index:23 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
-                          10.0.0.2 GigEthernet0/0/0
-                            [@0]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001111111111dead000000000800
-                        path:[28] pl-index:23 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
-                           10.0.1.2 GigEthernet0/0/1
-                             [@0]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-
-                    forwarding:   unicast-ip4-chain
-                      [@0]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:22 to:[0:0]]
-                        [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001111111111dead000000000800
-                        [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-
-There is ECMP across the two paths. Note that the instance/index of the
-load-balance present in the forwarding graph is 17.
-
-Let's add a BGP route via this peer;
-
-.. code-block:: console
-
-    ip route add 8.0.0.0/16 via 1.1.1.1
-
-in the FIB we see:
-
-
-.. code-block:: console
-
-    DBGvpp# sh ip fib 8.0.0.0/16
-        ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:1, default-route:1, ]
-        8.0.0.0/16 fib:0 index:18 locks:2
-          API refs:1 src-flags:added,contributing,active,
-            path-list:[24] locks:2 flags:shared, uPRF-list:21 len:2 itfs:[1, 2, ]
-              path:[29] pl-index:24 ip4 weight=1 pref=0 recursive:  oper-flags:resolved,
-                via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
-
-          forwarding:   unicast-ip4-chain
-            [@0]: dpo-load-balance: [proto:ip4 index:20 buckets:1 uRPF:21 to:[0:0]]
-                [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:22 to:[0:0]]
-                  [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001111111111dead000000000800
-                  [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-              
-the load-balance object used by this route is index 20, but note that
-the next load-balance in the chain is index 17, i.e. it is exactly
-the same instance that appears in the forwarding chain for the IGP
-route. So in the forwarding plane the packet first encounters
-load-balance object 20 (which it will use in ip4-lookup) and then
-number 17 (in ip4-load-balance).
-
-What's the significance? Let's shut down one of those IGP paths:
-
-.. code-block:: console
-
-    DBGvpp# set in state GigEthernet0/0/0 down
-
-the resulting update to the IGP route is:
-
-.. code-block:: console
-
-    DBGvpp# sh ip fib 1.1.1.1/32                        
-        ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:1, default-route:1, ]
-        1.1.1.1/32 fib:0 index:15 locks:4
-          API refs:1 src-flags:added,contributing,active,
-            path-list:[23] locks:2 flags:shared, uPRF-list:25 len:2 itfs:[1, 2, ]
-              path:[27] pl-index:23 ip4 weight=1 pref=0 attached-nexthop: 
-                10.0.0.2 GigEthernet0/0/0
-                  [@0]: arp-ipv4: via 10.0.0.2 GigEthernet0/0/0
-              path:[28] pl-index:23 ip4 weight=1 pref=0 attached-nexthop:  oper-flags:resolved,
-                10.0.1.2 GigEthernet0/0/1
-                  [@0]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-
-          recursive-resolution refs:1 src-flags:added, cover:-1
-
-          forwarding:   unicast-ip4-chain
-            [@0]: dpo-load-balance: [proto:ip4 index:17 buckets:1 uRPF:25 to:[0:0]]
-                [0] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-
-
-notice that the path via 10.0.0.2 is no longer flagged as resolved,
-and the forwarding chain does not contain this path as a
-choice. However, the key thing to note is the load-balance
-instance is still index 17, i.e. it has been modified not
-exchanged. In the FIB vernacular we say it has been 'in-place
-modified', a somewhat linguistically redundant expression, but one that serves
-to emphasise that it was changed whilst still be part of the graph, it
-was never at any point removed from the graph and re-added, and it was
-modified without worker barrier lock held.
-
-Still don't see the significance? In order to converge around the
-failure of the IGP link it was not necessary to update load-balance
-object number 20! It was not necessary to update the recursive
-route. i.e. convergence is achieved without updating any recursive
-routes, it is only necessary to update the affected IGP routes, this is
-the definition of 'a few'. We call this 'prefix independent
-convergence' (PIC) which should really be called 'recursive prefix
-independent convergence' but it isn't...
-
-How was the trick done? As with all problems in computer science, it
-was solved by a layer of misdirection, I mean indirection. The
-indirection is the load-balance that belongs to the IGP route. By
-keeping this object in the forwarding graph and updating it in place,
-we get PIC. The alternative design would be to collapse the two layers of
-load-balancing into one, which would improve forwarding performance
-but would come at the cost of prefix dependent convergence. No doubt
-there are situations where the VPP deployment would favour forwarding
-performance over convergence, you know the drill, contributions welcome.
-
-This failure scenario is known as PIC core, since it's one of the IGP's
-core links that has failed.
-
-iBGP PIC Edge
-^^^^^^^^^^^^^
-
-Next, let's consider alternate paths in BGP, e.g:
-
-.. code-block:: console
-
-    ip route add 8.0.0.0/16 via 1.1.1.1
-    ip route add 8.0.0.0/16 via 1.1.1.2
-
-the 8.0.0.0/16 prefix is reachable via two BGP next-hops (two PEs).
-
-Our FIB now also contains:
-
-.. code-block:: console
-
-    DBGvpp# sh ip fib 8.0.0.0/16
-    ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:2, default-route:1, ]
-    8.0.0.0/16 fib:0 index:18 locks:2
-      API refs:1 src-flags:added,contributing,active,
-        path-list:[15] locks:2 flags:shared, uPRF-list:11 len:2 itfs:[1, 2, ]
-          path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved,
-            via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
-          path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved,
-            via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-load-balance:12]
-
-      forwarding:   unicast-ip4-chain
-        [@0]: dpo-load-balance: [proto:ip4 index:20 buckets:2 uRPF:11 to:[0:0]]
-           [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:1 uRPF:25 to:[0:0]]
-             [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
-             [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-           [1] [@12]: dpo-load-balance: [proto:ip4 index:12 buckets:1 uRPF:13 to:[0:0]]
-             [0] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-
-The first load-balance (LB) in the forwarding graph is index 20 (the astute
-reader will note this is the same index as in the previous
-section, I am adding paths to the same route, the load-balance is
-in-place modified again). Each choice in LB 20 is another LB
-contributed by the IGP route through which the route's paths recurse.
-
-So what's the equivalent in BGP to a link down in the IGP? An IGP link
-down means it loses its peering out of that link, so the equivalent in
-BGP is the loss of the peering and thus the loss of reachability to
-the peer. This is signaled by the IGP withdrawing the route to the
-peer. But "Wait wait wait", i hear you say ... "just because the IGP
-withdraws 1.1.1.1/32 doesn't mean I can't reach 1.1.1.1, perhaps there
-is a less specific route that gives reachability to 1.1.1.1". Indeed
-there may be. So a little more on BGP network design. I know it's like
-a bad detective novel where the author drip feeds you the plot... When
-describing iBGP peerings one 'always' describes the peer using one of
-its GigEthernet0/0/back addresses. Why? A GigEthernet0/0/back interface
-never goes down (unless you admin down it yourself), some muppet can't
-accidentally cut through the GigEthernet0/0/back cable whilst digging up the
-street. And what subnet mask length does a prefix have on a GigEthernet0/0/back
-interface? it's 'always' a /32. Why? because there's no cable to connect
-any other devices. This choice justifies there 'always' being a /32
-route for the BGP peer. But what prevents there not being a less
-specific - nothing.
-Now clearly if the BGP peer crashes then the /32 for its GigEthernet0/0/back is
-going to be removed from the IGP, but what will withdraw the less
-specific - nothing.
-
-So in order to make use of this trick of relying on the withdrawal of
-the /32 for the peer to signal that the peer is down and thus the
-signal to converge the FIB, we need to force FIB to recurse only via
-the /32 and not via a less specific. This is called a 'recursion
-constraint'. In this case the constraint is 'recurse via host'
-i.e. for ipv4 use a /32.
-So we need to update our route additions from before:
-
-.. code-block:: console
-
-    ip route add 8.0.0.0/16 via 1.1.1.1 resolve-via-host
-    ip route add 8.0.0.0/16 via 1.1.1.2 resolve-via-host
-
-checking the FIB output is left as an exercise to the reader. I hope
-you're doing these configs as you read. There's little change in the
-output, you'll see some extra flags on the paths.
-
-Now let's add the less specific, just for fun:
-
-
-.. code-block:: console
-
-    ip route add 1.1.1.0/28 via 10.0.0.2 GigEthernet0/0/0
-
-nothing changes in resolution of 8.0.0.0/16.
-
-Now withdraw the route to 1.1.1.2/32:
-
-.. code-block:: console
-
-    ip route del 1.1.1.2/32 via 10.0.0.2 GigEthernet0/0/0
-
-In the FIB we see:
-
-.. code-block:: console
-
-    DBGvpp# sh ip fib 8.0.0.0/32                      
-      ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:2, default-route:1, ]
-      8.0.0.0/16 fib:0 index:18 locks:2
-        API refs:1 src-flags:added,contributing,active,
-          path-list:[15] locks:2 flags:shared, uPRF-list:13 len:2 itfs:[1, 2, ]
-            path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
-              via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
-            path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  cfg-flags:resolve-host,
-              via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-drop:0]
-
-        forwarding:   unicast-ip4-chain
-          [@0]: dpo-load-balance: [proto:ip4 index:20 buckets:1 uRPF:13 to:[0:0]]
-            [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:27 to:[0:0]]
-              [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
-              [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-
-the path via 1.1.1.2 is unresolved, because the recursion constraints
-are preventing the the path resolving via 1.1.1.0/28. the LB index 20
-has been updated to remove the unresolved path.
-
-Job done? Not quite! Why not?
-
-Let's re-examine the goals of this chapter. We wanted to update 'a
-few' objects, which we have defined as not all the millions of
-recursive routes. Did we do that here? We sure did, when we
-modified LB index 20. So WTF?? Where's the indirection object that can
-be modified so that the LBs for the recursive routes are not
-modified - it's not there.... WTF?
-
-OK so the great detective has assembled all the suspects in the
-drawing room and only now does he drop the bomb; the FIB knows the
-scale, we talked above about what the scale **can** be, worst case
-scenario, but that's not necessarily what it is in this hypothetical
-(your) deployment. It knows how many recursive routes there are that
-depend on a /32, it can thus make its own determination of the
-definition of 'a few'. In other words, if there are only 'a few'
-recursive prefixes that depend on a /32 then it will update them
-synchronously (and we'll discuss what synchronously means a bit more later).
-
-So what does FIB consider to be 'a few'. Let's add more routes and
-find out.
-
-.. code-block:: console
-
-    DBGvpp# ip route add 8.1.0.0/16 via 1.1.1.2 resolve-via-host via 1.1.1.1 resolve-via-host
-      ...
-    DBGvpp# ip route add 8.63.0.0/16 via 1.1.1.2 resolve-via-host via 1.1.1.1 resolve-via-host
-
-and we see:
-
-.. code-block:: console
-
-    DBGvpp# sh ip fib 8.8.0.0                         
-     ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
-     8.8.0.0/16 fib:0 index:77 locks:2
-     API refs:1 src-flags:added,contributing,active,
-       path-list:[15] locks:128 flags:shared,popular, uPRF-list:28 len:2 itfs:[1, 2, ]
-         path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
-           via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
-         path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
-           via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-load-balance:12]
-
-     forwarding:   unicast-ip4-chain
-       [@0]: dpo-load-balance: [proto:ip4 index:79 buckets:2 uRPF:28 flags:[uses-map] to:[0:0]]
-           load-balance-map: index:0 buckets:2
-              index:    0    1
-                map:    0    1
-         [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:27 to:[0:0]]
-           [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
-           [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-         [1] [@12]: dpo-load-balance: [proto:ip4 index:12 buckets:1 uRPF:18 to:[0:0]]
-           [0] [@3]: arp-ipv4: via 10.0.1.2 GigEthernet0/0/0
-
-
-Two elements to note here; the path-list has the 'popular' flag and
-there is a load-balance map in the forwarding path.
-
-'popular' in this case means that the path-list has passed the limit
-of 'a few' in the number of children it has.
-
-here are the children:
-
-.. code-block:: console
-
-  DBGvpp# sh fib path-list 15
-    path-list:[15] locks:128 flags:shared,popular, uPRF-list:28 len:2 itfs:[1, 2, ]
-      path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
-        via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
-      path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
-        via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-load-balance:12]
-      children:{entry:18}{entry:21}{entry:22}{entry:23}{entry:25}{entry:26}{entry:27}{entry:28}{entry:29}{entry:30}{entry:31}{entry:32}{entry:33}{entry:34}{entry:35}{entry:36}{entry:37}{entry:38}{entry:39}{entry:40}{entry:41}{entry:42}{entry:43}{entry:44}{entry:45}{entry:46}{entry:47}{entry:48}{entry:49}{entry:50}{entry:51}{entry:52}{entry:53}{entry:54}{entry:55}{entry:56}{entry:57}{entry:58}{entry:59}{entry:60}{entry:61}{entry:62}{entry:63}{entry:64}{entry:65}{entry:66}{entry:67}{entry:68}{entry:69}{entry:70}{entry:71}{entry:72}{entry:73}{entry:74}{entry:75}{entry:76}{entry:77}{entry:78}{entry:79}{entry:80}{entry:81}{entry:82}{entry:83}{entry:84}
-
-64 children makes it popular. The number is fixed (there is no API to
-change it). Its choice is an attempt to balance the performance cost
-of the indirection performance degradation versus the convergence
-gain.
-
-Popular path-lists contribute the load-balance map, this is the
-missing indirection object. Its indirection happens when choosing the
-bucket in the LB. The packet's flow-hash is taken 'mod number of
-buckets' to give the 'candidate bucket' then the map will take this
-'index' and convert it into the 'map'. You can see in the example above
-that no change occurs, i.e. if the flow-hash mod n chooses bucket 1
-then it gets bucket 1.
-
-Why is this useful? The path-list is shared (you can convince
-yourself of this if you look at each of the 8.x.0.0/16 routes we
-added) and all of these routes use the same load-balance map, therefore, to
-converge all the recursive routs, we need only change the map and
-we're good; we again get PIC.
-
-OK who's still awake... if you're thinking there's more to this story,
-you're right. Keep reading.
-
-This failure scenario is called iBGP PIC edge. It's 'edge' because it
-refers to the loss of an edge device, and iBGP because the device was
-a iBGP peer (we learn iBGP peers in the IGP). There is a similar eBGP
-PIC edge scenario, but this is left for an exercise to the reader (hint
-there are other recursion constraints - see the RFC).
-
-Which Objects
-^^^^^^^^^^^^^
-
-The next topic on our list of how to converge quickly was to
-effectively find the objects that need to be updated when a converge
-event happens. If you haven't realised by now that the FIB is an
-object graph, then can I politely suggest you go back and start from
-the beginning ...
-
-Finding the objects affected by a change is simply a matter of walking
-from the parent (the object affected) to its children. These
-dependencies are kept really for this reason.
-
-So is fast convergence just a matter of walking the graph? Yes and
-no. The question to ask yourself is this, "in the case of iBGP PIC edge,
-when the /32 is withdrawn, what is the list of objects that need to be
-updated and particularly what is the order they should be updated in
-order to obtain the best convergence time?" Think breadth v. depth first.
-
-... ponder for a while ...
-
-For iBGP PIC edge we said it's the path-list that provides the
-indirection through the load-balance map. Hence once all path-lists
-are updated we are converged, thereafter, at our leisure, we can
-update the child recursive prefixes. Is the breadth or depth first?
-
-It's breadth first.
-
-Breadth first walks are achieved by spawning an async walk of the
-branch of the graph that we don't want to traverse. Withdrawing the /32
-triggers a synchronous walk of the children of the /32 route, we want
-a synchronous walk because we want to converge ASAP. This synchronous
-walk will encounter path-lists in the /32 route's child dependent list.
-These path-lists (and thier LB maps) will be updated. If a path-list is
-popular, then it will spawn a async walk of the path-list's child
-dependent routes, if not it will walk those routes. So the walk
-effectively proceeds breadth first across the path-lists, then returns
-to the start to do the affected routes.
-
-Now the story is complete. The murderer is revealed.
-
-Let's withdraw one of the IGP routes.
-
-.. code-block:: console
-
-  DBGvpp# ip route del 1.1.1.2/32 via 10.0.1.2 GigEthernet0/0/1
-
-  DBGvpp# sh ip fib 8.8.0.0                         
-  ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] epoch:0 flags:none locks:[adjacency:1, recursive-resolution:4, default-route:1, ]
-  8.8.0.0/16 fib:0 index:77 locks:2
-    API refs:1 src-flags:added,contributing,active,
-      path-list:[15] locks:128 flags:shared,popular, uPRF-list:18 len:2 itfs:[1, 2, ]
-        path:[17] pl-index:15 ip4 weight=1 pref=0 recursive:  oper-flags:resolved, cfg-flags:resolve-host,
-          via 1.1.1.1 in fib:0 via-fib:15 via-dpo:[dpo-load-balance:17]
-        path:[15] pl-index:15 ip4 weight=1 pref=0 recursive:  cfg-flags:resolve-host,
-          via 1.1.1.2 in fib:0 via-fib:10 via-dpo:[dpo-drop:0]
-
-    forwarding:   unicast-ip4-chain
-      [@0]: dpo-load-balance: [proto:ip4 index:79 buckets:1 uRPF:18 to:[0:0]]
-        [0] [@12]: dpo-load-balance: [proto:ip4 index:17 buckets:2 uRPF:27 to:[0:0]]
-          [0] [@5]: ipv4 via 10.0.0.2 GigEthernet0/0/0: mtu:9000 next:3 001122334455dead000000000800
-          [1] [@5]: ipv4 via 10.0.1.2 GigEthernet0/0/1: mtu:9000 next:4 001111111111dead000000010800
-
-the LB Map has gone, since the prefix now only has one path. You'll
-need to be a CLI ninja if you want to catch the output showing the LB
-map in its transient state of:
-
-.. code-block:: console
-
-           load-balance-map: index:0 buckets:2
-              index:    0    1
-                map:    0    0
-
-but it happens. Trust me. I've got tests and everything.
-
-On the final topic of how to converge quickly; 'make each update fast'
-there are no tricks.
-
-
-
diff --git a/docs/gettingstarted/developers/fib20/graphs.rst b/docs/gettingstarted/developers/fib20/graphs.rst
deleted file mode 100644
index aec0e4b0135..00000000000
--- a/docs/gettingstarted/developers/fib20/graphs.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. _graphs:
-
-Graphs
-^^^^^^
-
-The FIB is essentially a collection of related graphs. Terminology from graph theory
-is often used in the sections that follow. From Wikipedia:
-
-*... a graph is a representation of a set of objects where some pairs of objects are
-connected by links. The interconnected objects are represented by mathematical
-abstractions called vertices (also called nodes or points), and the links that
-connect some pairs of vertices are called edges (also called arcs or lines) ...
-edges may be directed or undirected.*
-
-In a directed graph the edges can only be traversed in one direction - from child to
-parent. The names are chosen to represent the many to one relationship. A child has
-one parent, but a parent many children.  In undirected graphs the edge traversal
-can be in either direction, but in FIB the parent child nomenclature remains to
-represent the many to one relationship. Children of the same parent are termed
-siblings. When the traversal is from child to parent it is considered to be a
-forward traversal, or walk, and from parent to the many children a back walk.
-Forward walks are cheap since they start from the many and move toward the few.
-Back walks are expensive as the start from the few and visit the many.
-
-The many to one relationship between child and parent means that the lifetime of a
-parent object must extend to the lifetime of its children. If the control plane
-removes a parent object before its children, then the parent must remain, in an
-**incomplete** state, until the children are themselves removed. Likewise if a child
-is created before its parent, the parent is created in an *incomplete* state. These
-incomplete objects are needed to maintain the graph dependencies. Without them when
-the parent is added finding the affected children would require a search through many
-databases for those children. To extend the lifetime of parents all children thereof
-hold a **lock** on the parent. This is a simple reference count. Children then follow
-the add-or-lock/unlock semantics for finding a parent, as opposed to a malloc/free.
diff --git a/docs/gettingstarted/developers/fib20/graphwalks.rst b/docs/gettingstarted/developers/fib20/graphwalks.rst
deleted file mode 100644
index e740660a2ed..00000000000
--- a/docs/gettingstarted/developers/fib20/graphwalks.rst
+++ /dev/null
@@ -1,80 +0,0 @@
-.. _graphwalks:
-
-Graph Walks
-^^^^^^^^^^^^
-
-All FIB object types are allocated from a VPP memory pool [#f13]_. The objects are thus
-susceptible to memory re-allocation, therefore the use of a bare "C" pointer to refer
-to a child or parent is not possible. Instead there is the concept of a *fib_node_ptr_t*
-which is a tuple of type,index. The type indicates what type of object it is
-(and hence which pool to use) and the index is the index in that pool. This allows
-for the safe retrieval of any object type.
-
-When a child resolves via a parent it does so knowing the type of that parent. The
-child to parent relationship is thus fully known to the child, and hence a forward
-walk of the graph (from child to parent) is trivial. However, a parent does not choose
-its children, it does not even choose the type. All object types that form part of the
-FIB control plane graph all inherit from a single base class; *fib_node_t*. A *fib_node_t*
-identifies the object's index and its associated virtual function table provides the
-parent a mechanism to visit that object during the walk. The reason for a back-walk
-is to inform all children that the state of the parent has changed in some way, and
-that the child may itself need to update.
-
-To support the many to one, child to parent, relationship a parent must maintain a
-list of its children. The requirements of this list are;
-
-- O(1) insertion and delete time. Several child-parent relationships are made/broken during route addition/deletion.
-- Ordering. High priority children are at the front, low priority at the back (see section Fast Convergence)
-- Insertion at arbitrary locations.
-
-To realise these requirements the child-list is a doubly linked-list, where each element
-contains a *fib_node_ptr_t*. The VPP pool memory model applies to the list elements, so
-they are also identified by an index. When a child is added to a list it is returned the
-index of the element. Using this index the element can be removed in constant time.
-The list supports 'push-front' and 'push-back' semantics for ordering. To walk the children
-of a parent is then to iterate this list.
-
-A back-walk of the graph is a depth first search where all children in all levels of the
-hierarchy are visited. Such walks can therefore encounter all object instances in the
-FIB control plane graph, numbering in the millions. A FIB control-plane graph is cyclic
-in the presence of a recursion loop, so the walk implementation has mechanisms to detect
-this and exit early.
-
-A back-walk can be either synchronous or asynchronous. A synchronous walk will visit the
-entire section of the graph before control is returned to the caller, an asynchronous
-walk will queue the walk to a background process, to run at a later time, and immediately
-return to the caller. To implement asynchronous walks a *fib_walk_t* object it added to
-the front of the parent's child list. As children are visited the *fib_walk_t* object
-advances through the list. Since it is inserted in the list, when the walk suspends
-and resumes, it can continue at the correct location. It is also safe with respect to
-the deletion of children from the list. New children are added to the head of the list,
-and so will not encounter the walk, but since they are new, they already have the up to
-date state of the parent.
-
-A VLIB process 'fib-walk' runs to perform the asynchronous walks. VLIB has no priority
-scheduling between respective processes, so the fib-walk process does work in small
-increments so it does not block the main route download process. Since the main download
-process effectively has priority numerous asynchronous back-walks can be started on the
-same parent instance before the fib-walk process can run. FIB is a 'final state' application.
-If a parent changes n times, it is not necessary for the children to also update n
-times, instead it is only necessary that this child updates to the latest, or final,
-state. Consequently when multiple walks on a parent (and hence potential updates to a
-child) are queued, these walks can be merged into a single walk. This
-is the main reason the walks are designed this way, to eliminate (as
-much as possible) redundant work and thus converge the system as fast
-as possible.
-
-Choosing between a synchronous and an asynchronous walk is therefore a trade-off between
-time it takes to propagate a change in the parent to all of its children, versus the
-time it takes to act on a single route update. For example, if a route update were to
-affect millions of child recursive routes, then the rate at which such updates could be
-processed would be dependent on the number of child recursive route which would not be
-good. At the time of writing FIB2.0 uses synchronous walk in all locations except when
-walking the children of a path-list, and it has more than 32 [#f15]_ children. This avoids the
-case mentioned above.
-
-.. rubric:: Footnotes:
-
-.. [#f13] Fast memory allocation is crucial to fast route update times.
-.. [#f14] VPP may be written in C and not C++ but inheritance is still possible.
-.. [#f15] The value is arbitrary and yet to be tuned.
diff --git a/docs/gettingstarted/developers/fib20/hacking.rst b/docs/gettingstarted/developers/fib20/hacking.rst
deleted file mode 100644
index f64d3deb860..00000000000
--- a/docs/gettingstarted/developers/fib20/hacking.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. _hacking:
-
-Get Hacking
------------
-
-The code's directory structure is trivial, FIB, mFIB, adj have their
-own directories.
-
-for the most part, for all the FIB object types mentioned in this
-documentation there is a corresponding .h and .c file. As with any VPP
-component/sub-system a 'public' header file is any file that can be
-included by another sub-system and/or plugin. These must be specified
-in the build-system, so go look there. Public header files are always
-a good entry point to start reading.
-
-FIB
-^^^
-
-There is no direct [VPP's binary] API access to FIB, but FIB does
-expose types that can be used on the API by FIB and by other
-subsystems (e.g. :ref:`barnacles`). These types are specified in
-fib.api and the encoding and decoding thereof in fib_api.[ch].
-
-Most operations on a FIB entry happen as a result of an operation on a
-FIB table; an entry does not exist in isolation. The APIs in
-fib_table.h are well doxygen documented you should be able to figure
-out what they do. Use this as a starting point to explore how entries
-are created and deleted and how the source priority scheme works.
-
-FIB sources are defined in fib_source.h. Each source behaviour has its
-own file fib_entry_src_*.c These define the virtual functions that
-determine how the source behaves when actions on the FIB occur. For
-example, what the entry must do when its covering prefix's forwarding
-is updated.
-
-When creating new paths/path-lists the main action required is to
-resolve them; see fib_path*_resolve, and once resolved to have them
-contribute a DPO for forwarding or for the uRPF list; see
-fib_*_contribute_forwarding and fib_*_contribute_urpf respectively.
-
-The data-structures that used for entry lookup are protocol
-specific, they are implemented in separate files; ip4_fib.[ch],
-ip6_fib.[ch] and mpls_fib.[ch].
-
-FIB extranet support is implemented in fib_attached_export.[ch].
-FIB tracking is implemented in fib_entry_track.[ch].
-FIB [back]walk is implemented in fib_walk.[ch].
-
-Adjacency
-^^^^^^^^^
-
-Not much to say here, each adjacency type has it own file; use the
-force, read the source.
-
-
-Testing
-^^^^^^^
-
-the majority of FIB coverage comes from the C Unit tests in
-fib_test.c. I strongly encourage you to add code here. It's a much
-easier development cycle to fire up GDB, run VPP and iterate with
-'test fib', than it is work in the python UT. You still need to write
-python UT, don't get me wrong, it's just easier to do the FIB dev
-using C UT.
-
-
-
-Enjoy!
diff --git a/docs/gettingstarted/developers/fib20/index.rst b/docs/gettingstarted/developers/fib20/index.rst
deleted file mode 100644
index 6a3115beb2c..00000000000
--- a/docs/gettingstarted/developers/fib20/index.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-.. _fib20:
-
-FIB 2.0 Hierarchical, Protocol, Independent
-===========================================
-
-.. toctree::
-
-   prerequisites
-   thedatamodel
-   tunnels
-   mplsfib
-   multicast
-   debugging
-   fastconvergence
-   scale
-   barnacles
-   hacking
-   missing
diff --git a/docs/gettingstarted/developers/fib20/marknsweep.rst b/docs/gettingstarted/developers/fib20/marknsweep.rst
deleted file mode 100644
index e9e38a33f3a..00000000000
--- a/docs/gettingstarted/developers/fib20/marknsweep.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. _marknsweep:
-
-Mark and Sweep
---------------
-
-The mark and sweep procedures, in FIB and in other subsystems, are
-built for the purpose of recovering from a control plane crash.
-
-In routing if the control plane (CP) crashes, when it restarts, the network
-topology may have changed. This means that some of the routes that
-were programmed in the FIB may no longer be needed, and perhaps some
-new ones are. If the CP were simply to insert all the new routes it
-learned after it restarts, then FIB could be left with old routes that
-never get removed, this would be bigly bad.
-
-At a high level the requirement is to delete routes from the old set
-that are not present in the new set; 'delete the diff' as it might
-be colloquially known.
-
-How should the control plane determine the old set? It could
-conceivably read back the FIB from VPP. But this presents two
-problems, firstly, it could be a large set of routes, numbering in the
-millions, this is not an efficient mechanism and not one one wants to
-perform at a point when the router is trying to converge
-ASAP. Secondly it represents a 'source of truth' inversion. The
-routing plane is the source of truth, not forwarding. Routing should
-not receive its 'input' from the layers below. Thirdly, on a practical
-note, the reading of VPP data structures to glean this sort of
-accurate information, would only happen in this scenario, i.e. it's
-not well tested and therefore not particularly reliable (see point 2).
-
-Enter 'mark and sweep' or m-n-s (not to be confused with the retail
-giant) as it's affectionately known.
-
-The Mark and Sweep algorithm proceeds in three steps:
-
-- Step 1; the CP declares to VPP that it wants to begin the process
-  (i.e. it has just restarted). At this point VPP will iterate through
-  all the objects that the CP owns and 'mark' then as being
-  stale. This process effectively declares a new 'epoch', a barrier in
-  time that separates the old objects from the new.
-- Step 2; The CP downloads all of its new objects. If one of these new
-  CP objects matches (has the same key as) an existing object, then
-  the CP add is considered an update, and the object's stale state is
-  removed.
-- Step 3: The CP declares it has 'converged'; it has no more updates
-  to give (at this time). VPP will then again iterate through all the
-  CP's objects and remove those that do not belong to the new epoch,
-  i.e. those that are still marked stale.
-
-After step 3, the CP and VPP databases are in sync.
-
-The cost of the process was to download all the new routes again. This
-is a highly-tuned and well-tested scenario.
-
-In VPP we use the synonym 'replace' to describe the mark-n-sweep
-action in the API. We use this term because it refers to the goals of
-the algorithm at a high level - the CP wants to replace the old DB
-with a new one - but it does not specify the algorithm by which that
-is achieved. One could equally perform this task by constructing a
-brand new DB in VPP, and then swapping them when the CP
-converges. Other subsystems may employ that approach, but FIB does
-not. Updates are typically faster than adds, since the update is
-likely a no-op, whereas a separate add would require the memory
-allocator, which is the long pole in FIB additions. Additionally, it requires
-twice the memory for a moment in time, which could be prohibitive when
-the FIB is large.
-
diff --git a/docs/gettingstarted/developers/fib20/missing.rst b/docs/gettingstarted/developers/fib20/missing.rst
deleted file mode 100644
index c5aa51f6106..00000000000
--- a/docs/gettingstarted/developers/fib20/missing.rst
+++ /dev/null
@@ -1,110 +0,0 @@
-.. _missing:
-
-Missing Functionality
----------------------
-
-A list of functionality that the FIB does not currently provide.
-
-
-PIC Edge Backup Paths
-^^^^^^^^^^^^^^^^^^^^^
-
-FIB supports the concept of path 'preference'. Only paths that have
-the best preference contribute to forwarding. Only once all the paths with
-the best preference go down do the paths with the next best preference
-contribute.
-
-In BGP PIC edge, BGP would install the primary paths and the backup
-paths. With expectation that backups are only used once all primaries
-fail; this is the same behaviour that FIB's preference sets provide.
-
-However, in order to get prefix independent convergence, one must be
-able to only modify the path-list's load-balance map (LBM) to choose the
-paths to use. Hence the paths must already be in the map, and
-conversely must be in the fib_entry's load-balance (LB). In other
-words, to use backup paths with PIC, the fib_entry's LB must include
-the backup paths, and the path-lists LBM must map from the backups to
-the primaries.
-
-This is change that is reasonably easy w.r.t. to knowing what to
-change, but hard to get right and hard to test.
-
-
-Loop Free Alternate Paths
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Contrary to the BGP approach for path backups, an IGP could install a
-loop free alternate (LFA) path to achieve fast re-route (FRR).
-
-Because of the way the LFA paths are calculated by the IGP an LFA backup
-path is always paired with a primary. VPP FIB does not support this
-primary-backup pair relationship.
-
-In intent of LFA FRR is/was to get below the magic 50ms mark. To do
-this the expectation is/was that one would need in the forwarding
-graph an object that represents a path's state. This object would be
-checked for each packet being sent. If the path is up, the graph (an
-adjacency since it's the IGP) for the primary path is taken, if it's
-down the graph for the backup is taken. When a path goes down only
-this indirection object needs to be updated to affect all
-routes. Naturally, the indirection would incur a performance cost, but
-we know that there are many performance-convergence trade-offs in a
-FIB design.
-
-Should VPP's FIB support this feature? It all depends on the
-50ms. LFA FRR comes from the era when routers ran on lower performance
-CPUs and interface down was an interrupt. VPP typically has plenty of
-gas but runs as a user space process. So, can it update all routes in
-under 50ms on a meaty CPU and can the OS deliver the interface down
-within the time requirements? I don't have the answers to either
-question.
-
-
-Extranets for Multicast
-^^^^^^^^^^^^^^^^^^^^^^^
-
-When a unicast prefix is present in two different tables, then it
-refers to a different set of devices. When the prefix is imported it
-refers to the same set of devices. If the set of paths to reach the
-prefix is different in the import and export table, it doesn't matter,
-since they both refer to the same devices, so either set can be
-used. Therefore, FIB's usual source preference rules can apply. The
-'import' source is lower priority.
-
-When a multicast prefix is present in two different tables, then it's
-two different flows referring to two different set of receivers. When
-the prefix is imported, then it refers to the same flow and two
-different sets of receivers. In other words, the receiver set in the
-import table needs to be the super set of receivers.
-
-There are two ways one might consider doing this; merging the
-path-lists or replicating the packet first into each table.
-
-
-Collapsing
-^^^^^^^^^^
-
-Read :ref:`fastconvergence`
-
-Collapsing the DPO graph for recursive routes doesn't have to be an
-all or nothing. Easy cases:
-
-
-- A recursive prefix with only one path and a path-list that is not
-  popular, could stack directly on the LB of the via entry. 
-- A recursive prefix with only multiple paths and a path-list that is not
-  popular, could construct a new load balance using the choices
-  present in each bucket of its via entries. The choices in the new LB
-  though would need to reflect the relative weighting.
-
-
-The condition of an non-popular path-list means that the LB doesn't
-have an LB map and hence it needs to be updated for convergence to
-occur.
-
-The more difficult cases come when the recursive prefix has labels
-which need to be stack on the via entries' choices.
-
-You might also envision a global configuration that always collapses all
-chains, which could be used in deployments where convergence is not a
-priority.
diff --git a/docs/gettingstarted/developers/fib20/mplsfib.rst b/docs/gettingstarted/developers/fib20/mplsfib.rst
deleted file mode 100644
index f66724ea81b..00000000000
--- a/docs/gettingstarted/developers/fib20/mplsfib.rst
+++ /dev/null
@@ -1,220 +0,0 @@
-.. _mplsfib:
-
-MPLS FIB
---------
-
-Implementation
-^^^^^^^^^^^^^^^
-
-The MPLS FIB is implemented using exactly the same data structures as
-the IP FIB.  The only difference is the implementation of the
-table. Whereas for IPv4 this is an mtrie and for IPv6 a hash table,
-for MPLS it is a flat array indexed by a 21 bit key (label & EOS
-bit). This implementation is chosen to favour packet forwarding speed.
-
-It can be the case in MPLS forwarding that packets received with the
-EOS bit set in the MPLS label need to be forwarded differently from
-those without. The most common example of this is if the path set
-contains a path that does not have an output label. In this case the
-non-EOS packets cannot take this path, because to do so would expose
-the neighbouring router to a label that it did not allocate.
-
-The desgin choice to make with an MPLS FIB table is therefore:
-- 20 bit key: label only. When the EOS and non-EOS actions differ the result is a 'EOS-choice' object.
-- 21 bit key: label and EOS-bit. The result is then the specific action based on EOS-bit.
-
-20 bit key
-  - Advantages:lower memory overhead, since there are few DB entries.
-  - Disadvantages: slower DP performance in the case the path-lists
-    differ, as more objects are encounterd in the switch path
-
-21 bit key
-  - Advantages: faster DP performance
-    Disadvantages: increased memory footprint.
-
-Switching between schemes based on observed/measured action similarity
-is not considered on the grounds of complexity and flip-flopping.
-
-VPP mantra - favour performance over memory. We choose a 21 bit key.
-
-Basics
-^^^^^^
-
-MPLS is not enabled by default. There are two steps to get
-started. First, create the default MPLS FIB:
-
-.. code-block:: console
-
-   $ mpls table add 0
-
-With '0' being the magic number for the 'default' table (just like it
-is for IPv[46]). One can create other MPLS tables, but, unlike IP
-tables, one cannot 'bind' non-default MPLS tables to interfaces, in
-other words all MPLS packets received on an interface will always
-result in a lookup in the default table. One has to be more inventive
-to use the non-default tables...
-
-Secondly, for *each* interface on which you wish to *receive* MPLS
-packets, that interface must be MPLS 'enabled'
-
-.. code-block:: console
-
-   $ set interface mpls GigEthernet0/0/0 enable
-
-there is no equivalent enable for transmit, all that is required is to
-use an interface as an egress path.
-
-Entries in the MPLS FIB can be displayed with:
-
-.. code-block:: console
-
-   $ sh mpls fib [table X] [label]
-
-There is a tight coupling between IP and MPLS forwarding. MPLS
-forwarding equivalence classes (FECs) are often an IP prefix – that is
-to say that traffic matching a given IP prefix is routed into a MPLS
-label switch path (LSP). It is thus necessary to be able to associate
-a given prefix/route with an [out-going] MPLS label that will be
-imposed when the packet is forwarded. This is configured as:
-
-.. code-block:: console
-
-   $ ip route add 1.1.1.1/32 via 10.10.10.10 GigEthernet0/0/0 out-labels 33
-
-packets matching 1.1.1.1/32 will be forwarded out GigEthernet0/0/0 and have
-MPLS label 33 imposed. More than one out-going label can be
-specified. Out-going MPLS labels can be applied to recursive and
-non-recursive routes, e.g;
-
-.. code-block:: console
-
-   $ ip route add 2.2.2.0/24 via 1.1.1.1 out-labels 34
-
-packets matching 2.2.2.0/24 will thus have two MPLS labels imposed; 34
-and 33. This is the realisation of, e,g, an MPLS BGP VPNv4.
-
-To associate/allocate a local-label for a prefix, and thus have
-packets to that local-label forwarded equivalently to the prefix do;
-
-.. code-block:: console
-
-   $ mpls local-label 99 2.2.2.0/24
-
-In the API this action is called a ‘bind’.
-The router receiving the MPLS encapsulated packets needs to be
-programmed with actions associated which each label value – this is
-the role of the MPLS FIB. The MPLS FIB is a table, whose key is the
-MPLS label value and end-of-stack (EOS) bit, which stores the action
-to perform on packets with matching encapsulation. Currently supported
-actions are:
-
-#. Pop the label and perform an IPv[46] lookup in a specified table
-#. Pop the label and forward via a specified next-hop (this is penultimate-hop-pop, PHP)
-#. Swap the label and forward via a specified next-hop.
-
-These can be programmed respectively by:	
-
-.. code-block:: console
-
-   $ mpls local-label 33 eos ip4-lookup-in-table X
-   $ mpls local-label 33 [eos] via 10.10.10.10 GigEthernet0/0/0
-   $ mpls local-label 33 [eos] via 10.10.10.10 GigEthernet0/0/0 out-labels 66
-
-the latter is an example of an MPLS cross connect. Any description of
-a next-hop, recursive, non-recursive, labelled, non-labelled, etc,
-that is valid for an IP prefix, is also valid for an MPLS
-local-label. Note the use of the 'eos' keyword which indicates the
-programming is for the case when the label is end-of-stack. The last
-two operations can apply to both eos and non-eos packets, but the pop
-and IP lookup only to an eos packet.
-
-
-MPLS VPN
-^^^^^^^^
-
-To configure an MPLS VPN for a PE the following example can be used.
-
-Step 1; Configure routes to the iBGP peers - note these route MUST
-have out-going labels;
-
-.. code-block:: console
-
-   $ ip route add 10.0.0.1/32 via 192.168.1.2 Eth0 out-labels 33
-   $ ip route add 10.0.0.2/32 via 192.168.2.2 Eth0 out-labels 34
-
-Step 2; Configure the customer 'VRF'
-
-.. code-block:: console
-
-   $ ip table add 2
-
-Step 3; add a route via the iBGP peer[s] with the MPLS label
-advertised by that peer
-
-.. code-block:: console
-
-   $ ip route add table 2 10.10.10.0/24 via 10.0.0.2 next-hop-table 0 out-label 122
-   $ ip route add table 2 10.10.10.0/24 via 10.0.0.1 next-hop-table 0 out-label 121
-
-Step 4; add a route via the eBGP peer
-
-.. code-block:: console
-
-   $ ip route add table 2 10.10.20.0/24 via 172.16.0.1 next-hop-table 2
-
-Step 5; depending on the label allocation scheme used, add routes to
-the MPLS FIB to accept incoming labelled packets:
-
-#. per-prefix label scheme - this command 'binds' the label to the same
-   forwarding as the IP route
-
-   .. code-block:: console
-
-      $ mpls local-label 99 10.10.20.0/24
-
-#. per-CE label scheme - this pops the incoming label and forwards via
-   the next-hop provided. Append config for 'out-labels' if so desired.
-
-   .. code-block:: console
-
-      $ mpls local-label 99 via 172.16.0.1 next-hop-table 2
-
-#. per-VRF label scheme
-
-   .. code-block:: console
-
-      $ mpls local-label 99 via ip4-lookup-in-table 2
-
-MPLS Tunnels
-^^^^^^^^^^^^
-
-MPLS tunnels are unidirectional and can impose a stack of labels. They
-are 'normal' interfaces and thus can be used, for example, as the
-target for IP routes and L2 cross-connects. To construct a tunnel:
-
-.. code-block:: console
-
-   $ mpls tunnel add via 10.10.10.10 GigEthernet0/0/0 out-labels 33 44 55
-
-and to then have that created tunnel to perform ECMP:
-
-.. code-block:: console
-
-   $ mpls tunnel add mpls-tunnel0 via 10.10.10.11 GigEthernet0/0/0 out-labels 66 77 88
-
-use
-
-.. code-block:: console
-
-   $ sh mpls tunnel [X]
-
-to see the monster you have created.
-
-An MPLS tunnel interface is an interface like any other and now ready
-for use with the usual set of interface commands, e.g.:
-
-.. code-block:: console
-
-   $ set interface state mpls-tunnel0 up
-   $ set interface ip address mpls-tunnel0 192.168.1.1/30
-   $ ip route 1.1.1.1/32 via mpls-tunnel0
diff --git a/docs/gettingstarted/developers/fib20/multicast.rst b/docs/gettingstarted/developers/fib20/multicast.rst
deleted file mode 100644
index 7cffba81666..00000000000
--- a/docs/gettingstarted/developers/fib20/multicast.rst
+++ /dev/null
@@ -1,106 +0,0 @@
-.. _mfib:
-
-IP Multicast FIB
-----------------
-
-The two principal differences between multicast and unicast forwarding
-are:
-
-* there is no load-balancing among paths, there is only replication
-  across paths.
-* multicast forwarding has an explicit reverse path forwarding (RPF)
-  check. It will only forward a packet if it arrives from a peer for
-  which it has been explicitly configured to accept.
-
-The other factor that influences the design of the mFIB is that the
-match criteria (the prefix) is different. For multicast it is 
-necessary to be able to match on source and destination/group
-addresses (termed an (S,G)) and only on a destination prefix (a (\*,
-G/m)). This prefix is much bigger than a unicast prefix, and since
-unicast scale is almost always greater than multicast scale, it is not
-a good idea to have a single definition of a prefix. Therefore,
-there is a fib_prefix_t (and hence a fib_entry_t) and an
-mfib_prefix_t (and hence a mfib_entry_t).
-
-The fib_path_t and fib_path_list_t are reused. A path can represent
-either a peer from which to accept packets or a peer to which to send
-packets. A path-extension is added to the fib_path_t/mfib_entry_t to
-describe the role the path plays. Logically the path-list is split
-into two sets; an accepting set and a forwarding set. The forwarding set
-contributes a replicate DPO for forwarding and the accepting set
-contributes a list of interfaces (an mfib_itf_t) for the RPF check.
-
-An IP multicast FIB (mFIB) is a data-structure that holds entries that
-represent a (S,G) or a (\*,G/m) multicast group. There is one IPv4 and
-one IPv6 mFIB per IP table, i.e. each time the user calls 'ip[6] table
-add X' an mFIB is created.
-
-Usage
-^^^^^
-
-To add an entry to the default mFIB for the group (1.1.1.1, 239.1.1.1)
-that will replicate packets to GigEthernet0/0/0 and GigEthernet0/0/1, do:
-
-.. code-block:: console
-
-   $ ip mroute add 1.1.1.1 239.1.1.1 via GigEthernet0/0/0 Forward
-   $ ip mroute add 1.1.1.1 239.1.1.1 via GigEthernet0/0/1 Forward
-
-the flag 'Forward' passed with the path specifies this path to be part of the replication set.
-To add a path from GigEthernet0/0/2 to the accepting (RPF) set do:
-
-.. code-block:: console
-
-   $ ip mroute add 1.1.1.1 239.1.1.1 via GigEthernet0/0/2 Accept
-
-A (\*,G) entry is added by not specifying a source address:
-
-.. code-block:: console
-
-   $ ip mroute add 232.2.2.2 via GigEthernet0/0/2 Forward
-
-A (\*,G/m) entry is added by not specifying a source address and giving
-the group address a mask:
-
-.. code-block:: console
-
-   $ ip mroute add 232.2.2.0/24 via GigEthernet0/0/2 Forward
-
-Entries are deleted when all paths have been removed and all entry flags (see below) are also removed.
-
-Advanced
-^^^^^^^^
-
-There are a set of flags associated only with an entry, see:
-
-.. code-block:: console
-
-   $ show mfib route flags
-
-only some of these are relevant over the API/CLI:
-
-#. Signal - packets that match this entry will generate an event that
-   is sent to the control plane (which can be retrieved via the signal
-   dump API)
-#. Connected - indicates that the control plane should be informed of
-   connected sources (also retrieved via the signal dump API)
-#. Accept-all-itf - the entry shall accept packets from all
-   interfaces, thus eliminating the RPF check
-#. Drop - Drop all packet matching this entry.
-
-flags on an entry can be changed with:
-
-.. code-block:: console
-
-   $ ip mroute  
-
-An alternative approach to the RPF check, that does check the
-accepting path set, is to give the entry and RPF-ID:
-
-.. code-block:: console
-
-   $ ip mroute  rpf-id X
-
-the RPF-ID is an attribute of a received packet's meta-data and is
-added to the packet when it ingresses on a given entity such as an
-MPLS-tunnel or a BIER table disposition entry.
diff --git a/docs/gettingstarted/developers/fib20/neighbors.rst b/docs/gettingstarted/developers/fib20/neighbors.rst
deleted file mode 100644
index f460955239c..00000000000
--- a/docs/gettingstarted/developers/fib20/neighbors.rst
+++ /dev/null
@@ -1,88 +0,0 @@
-.. _neighbors:
-
-Neighbours
-^^^^^^^^^^^
-
-.. figure:: /_images/ip-neighbor.png
-
-Figure 1: Neighbour data model
-
-Figure 1 shows the data model for IP neighbours. An IP neighbour contains the mapping
-between a peer, identified by an IPv4 or IPv6 address, and its MAC address on a given
-interface. An IP-table (VRF) is not part of the neighbour's
-data/identity. This is because the virtualisation of a router into
-different tables (VRFs) is performed at the interface level, i.e. an
-IP-table is bound to a particular interface. A neighbour, which is
-attached to an interface, is thus implicitly in that table, and
-only in that table. It is also worth noting that IP neighbours
-contribute forwarding for the egress direction, whereas an IP-table
-is an ingress only function.
-
-The *ip_neighbor_t* represents the control-plane addition of the
-neighbour. The *ip_adjacency_t* contains the data derived from the *ip_neighbor_t* that is needed to
-forward packets to the peer. The additional data in the adjacency are the *rewrite*
-and the *link_type*. The *link_type* is a description of the protocol of the packets
-that will be forwarded with this adjacency; e.g. IPv4, IPv6 or MPLS. The *link_type*
-maps directly to the ether-type in an Ethernet header, or the protocol filed in a
-GRE header. The rewrite is a byte string representation of the header that will be
-prepended to the packet when it is sent to that peer. For Ethernet interfaces this
-is be the src,dst MAC and the ether-type. For LISP tunnels, the IP src,dst pair
-and the LISP header.
-
-The *ip_neighbor_t* for an IPv4 peer (learned e.g. over ARP) will
-install a *link_type=IPv4* when the entry is created and a
-link_type=MPLS on demand (i.e. when a route with output labels resolves via the peer).
-
-Adjacency
----------
-
-There are three sub-types of adjacencies. Purists would argue that some
-of these sub-types are not really adjacencies but are instead other
-forms of DPOs, and it would be hard to argue against that, but
-historically (not just in VPP, but in the FIB implementations from
-which VPP draws on for some of its concepts), these have been modelled
-as adjacency types, the one thing they have in common is that they
-have an associated interface and are terminal. The [sub] sub-types are:
-
-* A Neighbour Adjacency (key={interface, next-hop, link-type}). A
-  representation of a peer on a link (as described above). A neighbour adjacency itself has
-  two sub-types; terminal and mid-chain. When one speak of 'an
-  adjacency' one is usually referring to a terminal neighbour
-  sub-type. A mid-chain adjacency represents a neighbor on a virtual
-  interface which relies on the FIB to perform further forwarding. This
-  adjacency is thus not terminal for the FIB object graph but instead
-  appears in the 'middle' (the term chain is a synonym for graph in
-  some contexts).
-  A neighbour adjacency can be in one of two states; complete and
-  incomplete. A complete adjacency knows the rewrite string that
-  should be used to reach the peer, an incomplete adjacency does
-  not. If the adjacency was added as a result of the addition of an
-  *ip_neighbor_t* then the adjacency will be complete (because the
-  *ip_neighbor_t* knows the peer's MAC address). An incomplete
-  adjacency is created on demand by the FIB when a route's path
-  requires to resolve through such an adjacency. It is thus created in
-  order to resolve the missing dependency, it will become complete
-  once the *ip_neighbor_t* is discovered.
-  In the forwarding path a complete adjacency will prepend the rewrite
-  string and transmit on the egress interface, an incomplete adjacency
-  will construct a ARP/ND request to resolve the peer's IP address.
-
-* A Glean Adjacency (key={interface}). This is a representation of the need to discover
-  a peer on the given interface. It is used when it is known that the
-  packet is destined to an undiscoverd peer on that interface. The
-  difference between the glean adjacency and an
-  incomplete neighbour adjacency is that in the forwarding path the
-  glean adjacency will construct an ARP/ND request for the peer as
-  determined from the packet's destination address. The glean
-  adjacency is used to resolve connected prefixes on multi-access
-  interfaces.
-
-* A Multicast Adjacency (key={interface}). This represents the need to send an IP
-  multicast packet out of the adjacency's associated interface. Since
-  IP multicast constructs the destination MAC address from the IP
-  packet's destination/group address, the rewrite is always known and
-  hence the adjacency is always complete.
-
-
-All adjacency types can be shared between routes, hence each type is
-stored in a DB whose key is appropriate for the type.
diff --git a/docs/gettingstarted/developers/fib20/prefixes.rst b/docs/gettingstarted/developers/fib20/prefixes.rst
deleted file mode 100644
index 5e0437ae3b3..00000000000
--- a/docs/gettingstarted/developers/fib20/prefixes.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-.. _prefixes:
-
-Prefixes
-^^^^^^^^
-
-Some nomenclature used to describe prefixes:
-
-* 1.1.1.1 This is an address since it has no associated mask
-* 1.1.1.0/24 This is a prefix.
-* 1.1.1.1/32 This is a host prefix (the mask length is the size of the address).
-
-Prefix A is more specific than B if its mask length is longer, and less specific if
-the mask is shorter. For example, 1.1.1.0/28 is more specific than 1.1.1.0/24. A
-less specific prefix that overlaps with a more specific is the **covering** prefix.
-For example, 1.1.1.0/24 is the covering prefix for 1.1.1.0/28 and 1.1.1.0/28 is termed
-the **covered** prefix. A covering prefix is therefore always less specific than its
-covered prefixes.
diff --git a/docs/gettingstarted/developers/fib20/prerequisites.rst b/docs/gettingstarted/developers/fib20/prerequisites.rst
deleted file mode 100644
index 9d2b5ca21f4..00000000000
--- a/docs/gettingstarted/developers/fib20/prerequisites.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. _prerequisites:
-
-Prerequisites
--------------
-
-This section describes some prerequisite topics and nomenclature that are
-foundational to understanding the FIB architecture.
-
-.. toctree::
-
-   graphs
-   prefixes
diff --git a/docs/gettingstarted/developers/fib20/routes.rst b/docs/gettingstarted/developers/fib20/routes.rst
deleted file mode 100644
index 313a86c3af4..00000000000
--- a/docs/gettingstarted/developers/fib20/routes.rst
+++ /dev/null
@@ -1,353 +0,0 @@
-.. _routes:
-
-Routes
-^^^^^^
-
-Basics
-------
-
-The anatomy of a route is crucial to understand:
-
-.. code-block:: console
-
-                1.1.1.0/24 via 10.0.0.1 eth0
-
-A route is composed of two parts; **what** to match against and **how** to forward
-the matched packets. In the above example we want to match packets
-whose destination IP address is in the 1.1.1.0/24 subnet and then we
-want to forward those packet to 10.0.0.1 on interface eth0. We
-therefore want to match the **prefix** 1.1.1.0/24 and forward on the
-**path** to 10.0.0.1, eth0.
-
-Matching on a prefix is the particular task of the IP FIB, matching on
-other packet attributes is done by other subsystems, e.g. matching on
-MPLS labels in the MPLS-FIB, or matching on a tuple in ACL based
-forwarding (ABF), 'matching' on all packets that arrive on an L3
-interface (l3XC). Although these subsystems match on different
-properties, they share the infrastructure on **how** to forward
-matched packets, that is they share the **paths**. The FIB paths (or
-really the path-list) thus provide services to clients, this service
-is to **contribute** forwarding, this, in terms that will be made
-clear in later sections, is to provide the DPO to use.
-
-The prime function of the FIB is to *resolve* the paths for a
-route. To resolve a route is to construct an object graph that fully
-describes how to forward matching packets. This means that the graph
-must terminate with an object (the leaf node) that describes how
-to send a packet on an interface [#f1]_, i.e what encap to add to the
-packet and what interface to send it to; this is the purpose of the IP
-adjacency object. In Figure 3 the route is resolved as the graph is
-complete from *fib_entry_t* to *ip_adjacency_t*.
-
-
-Thread Model
-^^^^^^^^^^^^
-
-The FIB is not thread safe. All actions on the FIB are expected to
-occur exclusively in the main thread. However, the data-structures
-that FIB updates to add routes are thread safe,
-w.r.t. addition/deletion and read, therefore routes can be added
-without holding the worker thread barrier lock.
-
-
-Tables
-------
-
-An IP FIB is a set of prefixes against which to match; it is
-sub-address family (SAFI) specific (i.e. there is one for ipv4 and ipv6, unicast
-and multicast). An IP Table is address family (AFI) specific (i.e. the
-'table' includes the unicast and multicast FIB).
-
-Each FIB is identified by the SAFI and instance number (the [pool]
-index), each table is identified by the AFI and ID. The table's ID is
-assigned by the user when the table is constructed. Table ID 0 is
-reserved for the global/default table.
-
-In most routing models a VRF is composed of an IPv4 and IPv6 table,
-however, VPP has no construct to model this association, it deals only
-with tables and FIBs.
-
-A unicast FIB is comprised of two route data-bases; forwarding and non-forwarding. The
-forwarding data-base contains routes against which a packet will perform a longest
-prefix match (LPM) in the data-plane. The non-forwarding DB contains all the routes
-with which VPP has been programmed. Some of these routes may be
-unresolved, preventing their insertion into the forwarding DB.
-(see section: Adjacency source FIB entries).
-
-Model
------
-
-The route data is decomposed into three parts; entry, path-list and paths;
-
-* The *fib_entry_t*, which contains the route's prefix, is the representation of that prefix's entry in the FIB table.
-* The *fib_path_t* is a description of where to send the packets destined to the route's prefix. There are several types of path, including:
-
-    * Attached next-hop: the path is described with an interface and a next-hop. The next-hop is in the same sub-net as the router's own address on that interface, hence the peer is considered to be *attached*
-
-    * Attached: the path is described only by an interface. An
-      attached path means that all addresses covered by the route's
-      prefix are on the same L2 segment to which that router's
-      interface is attached. This means it is possible to ARP for any
-      address covered by the route's prefix. If this is not the case
-      then another device in that L2 segment needs to run proxy
-      ARP. An attached path is really only appropriate for a point-to-point
-      (P2P) interface where ARP is not required, i.e. a GRE tunnel. On
-      a p2p interface, attached and attached-nexthop paths will
-      resolve via a special 'auto-adjacency'. This is an adjacency
-      whose next-hop is the all zeros address and describes the only
-      peer on the link.
-
-    * Recursive: The path is described only via the next-hop and table-id. 
-
-    * De-aggregate: The path is described only via the special all
-      zeros address and a table-id. This implies a subsequent lookup
-      in the table should be performed.
-
-    * There are other path types, please consult the code.
-
-* The *fib_path_list_t* represents the list of paths from which to choose when forwarding. A path-list is a shared object, i.e. it is the parent to multiple fib_entry_t children. In order to share any object type it is necessary for a child to search for an existing object matching its requirements. For this there must be a database. The key to the path-list database is a combined description of all of the paths it contains [#f2]_.  Searching the path-list database is required with each route addition, so it is populated only with path-lists for which sharing will bring convergence benefits (see Section: :ref:`fastconvergence`).
-
-.. figure:: /_images/fib20fig2.png
-
-Figure 2: Route data model class diagram
-
-Figure 2 shows an example of a route with two attached-next-hop paths. Each of these
-paths will *resolve* by finding the adjacency that matches the paths attributes, which
-are the same as the key for the adjacency database [#f3]_. The *forwarding information (FI)*
-is the set of adjacencies that are available for load-balancing the traffic in the
-data-plane. A path *contributes* an adjacency to the route's forwarding information, the
-path-list contributes the full forwarding information for IP packets.
-
-.. figure:: /_images/fib20fig3.png
-
-Figure 3: Route object diagram
-
-Figure 3 shows the object instances and their relationships created in order to resolve
-the routes also shown. The graph nature of these relationships is evident; children
-are displayed at the top of the diagram, their parents below them. Forward walks are
-thus from top to bottom, back walks bottom to top. The diagram shows the objects
-that are shared, the path-list and adjacency. Sharing objects is critical to fast
-convergence (see section :ref:`fastconvergence`). 
-
-FIB sources
-"""""""""""
-There are various entities in the system that can add routes to the FIB tables.
-Each of these entities is termed a *source*. When the same prefix is added by different
-sources the FIB must arbitrate between them to determine which source will contribute
-the forwarding information. Since each source determines the forwarding information
-using different best path and loop prevention algorithms, it is not correct for the
-forwarding information of multiple sources to be combined. Instead the FIB must choose
-to use the forwarding information from only one source. This choice is based on a static
-priority assignment [#f4]_. The FIB must maintain the information each source has added
-so it can be restored should that source become the best source. VPP has two
-*control-plane* sources; the API and the CLI the API has the higher priority.
-Each *source* data is represented by a *fib_entry_src_t* object of which a
-*fib_entry_t* maintains a sorted vector.
-
-The following configuration:
-
-.. code-block:: console
-
-   $ set interface ip address GigabitEthernet0/8/0 192.168.1.1/24 
-
-results in the addition of two FIB entries; 192.168.1.0/24 which is connected and
-attached, and 192.168.1.1/32 which is connected and local (a.k.a.
-receive or for-us). A prefix is *connected* when it is applied to a router's interface.
-Both prefixes are *interface* sourced. The interface source has a high priority, so
-the accidental or nefarious addition of identical prefixes does not prevent the
-router from correctly forwarding. Packets matching a connected prefix will
-generate an ARP request for the packets destination address, this process is known
-as a *glean*. 
-
-An *attached* prefix also results in a glean, but the router does not have its own
-address in that sub-net. The following configuration will result in an attached
-route, which resolves via an attached path;
-
-.. code-block:: console
-
-   $ ip route add table X 10.10.10.0/24 via gre0
-
-as mentioned before, these are only appropriate for point-to-point
-links.
-
-If table X is not the table to which gre0 is bound,
-then this is the case of an attached export (see the section :ref:`attachedexport`).
-
-Adjacency source FIB entries
-""""""""""""""""""""""""""""
-
-Whenever an ARP entry is created it will source a *fib_entry_t*. In this case the
-route is of the form:
-
-.. code-block:: console
-
-   $ ip route add table X 10.0.0.1/32 via 10.0.0.1 GigabitEthernet0/8/0
-
-This is a host prefix with a path whose next-hop address is the same host. This route
-highlights the distinction between the route's prefix - a description of the traffic
-to match - and the path - a description of where to send the matched traffic.
-Table X is the same table to which the interface is bound. FIB entries that are
-sourced by adjacencies are termed *adj-fibs*. The priority of the adjacency source
-is lower than the API source, so the following configuration:
-
-.. code-block:: console
-
-   $ set interface address 192.168.1.1/24 GigabitEthernet0/8/0
-   $ ip arp 192.168.1.2 GigabitEthernet0/8/0 dead.dead.dead
-   $ ip route add 192.168.1.2 via 10.10.10.10 GigabitEthernet1/8/0
-
-will forward traffic for 192.168.1.2 via GigabitEthernet1/8/0. That is the route added by the control
-plane is favoured over the adjacency discovered by ARP. The control plane, with its
-associated authentication, is considered the authoritative source. To counter the
-nefarious addition of adj-fibs, through the nefarious injection of adjacencies, the
-FIB is also required to ensure that only adj-fibs whose less specific covering prefix
-is attached are installed in forwarding. This requires the use of *cover tracking*,
-where a route maintains a dependency relationship with the route that is its less
-specific cover. When this cover changes (i.e. there is a new covering route) or the
-forwarding information of the cover is updated, then the covered route is notified.
-Adj-fibs that fail this cover check are not installed in the fib_table_t's forwarding
-table, they are only present in the non-forwarding table.
-
-Overlapping sub-nets are not supported, so no adj-fib has multiple paths. The control
-plane is expected to remove a prefix configured for an interface before the interface
-changes VRF.
-
-Recursive Routes
-""""""""""""""""
-
-Figure 4 shows the data structures used to describe a recursive route. The
-representation is almost identical to attached next-hop paths. The difference
-being that the *fib_path_t* has a parent that is another *fib_entry_t*, termed the
-*via-entry*
-
-.. figure:: /_images/fib20fig4.png
-
-Figure 4: Recursive route class diagram.
-
-In order to forward traffic to 64.10.128.0/20 the FIB must first determine how to forward
-traffic to 1.1.1.1/32. This is recursive resolution. Recursive resolution, which is
-essentially a cache of the data-plane result, emulates a longest prefix match for the
-*via-address" 1.1.1.1 in the *via-table* table 0 [#f5]_.
-
-Recursive resolution (RR) will source a host-prefix entry in the via-table for the
-via-address. The RR source is a low priority source. In the unlikely [#f6]_ event that the
-RR source is the best source, then it must derive forwarding information from its
-covering prefix.
-
-There are two cases to consider:
-
-* The cover is connected [#f7]_. The via-address is then an attached host and the RR source can resolve directly via the adjacency with the key {via-address, interface-of-connected-cover}
-* The cover is not connected [#f8]_. The RR source can directly inherit the forwarding information from its cover.
-
-This dependency on the covering prefix means the RR source will track its cover The
-covering prefix will *change* when;
-
-* A more specific prefix is inserted. For this reason whenever an entry is inserted into a FIB table its cover must be found so that its covered dependents can be informed.
-* The existing cover is removed. The covered prefixes must form a new relationship with the next less specific.
-
-The cover will be *updated* when the route for the covering prefix is modified. The
-cover tracking mechanism will provide the RR sourced entry with a notification in the
-event of a change or update of the cover, and the source can take the necessary action.
-
-The RR sourced FIB entry becomes the parent of the *fib_path_t* and will contribute its
-forwarding information to that path, so that the child's FIB entry can construct its own
-forwarding information. 
- 
-Figure 5 shows the object instances created to represent the recursive route and
-its resolving route also shown.
-
-.. figure:: /_images/fib20fig5.png
-
-Figure 5: Recursive Routes object diagram
-
-If the source adding recursive routes does not itself perform recursive resolution [#f9]_
-then it is possible that the source may inadvertently programme a recursion loop.
-
-An example of a recursion loop is the following configuration:
-
-.. code-block:: console
-
-   $ ip route add 5.5.5.5/32 via 6.6.6.6
-   $ ip route add 6.6.6.6/32 via 7.7.7.7
-   $ ip route add 7.7.7.7/32 via 5.5.5.5
-
-This shows a loop over three levels, but any number is possible. FIB will detect
-recursion loops by forward walking the graph when a *fib_entry_t* forms a child-parent
-relationship with a *fib_path_list_t*. The walk checks to see if the same object instances
-are encountered. When a recursion loop is formed the control plane [#f10]_ graph becomes
-cyclic, thus allowing the child-parent dependencies to form. This is necessary so that
-when the loop breaks, the affected children and be updated.
-
-Output labels
-"""""""""""""
-
-A route may have associated output MPLS labels [#f11]_. These are labels that are expected
-to be imposed on a packet as it is forwarded. It is important to note that an MPLS
-label is per-route and per-path, therefore, even though routes share paths they do not
-necessarily have the same label for that path [#f12]_. A label is therefore uniquely associated
-to a *fib_entry_t* and associated with one of the *fib_path_t* to which it forwards.
-MPLS labels are modelled via the generic concept of a *path-extension*. A *fib_entry_t*
-therefore has a vector of zero to many *fib_path_ext_t* objects to represent the labels
-with which it is configured.
-
-
-Delegates
-^^^^^^^^^
-
-A common software development pattern, a delegate is a means to
-extend the functionality of one object through composition of
-another, these other objects are called delegates. Both
-**fib_entry_t** and **ip_adjacency_t** support extension via delegates.
-
-The FIB uses delegates to add functionality when those functions are
-required by only a few objects instances rather than all of them, to
-save on memory. For example, building/contributing a load-balance
-object used to forward non-EOS MPLS traffic is only required for a
-fib_entry_t that corresponds to a BGP peer and that peer is
-advertising labeled route - there are only a few of
-these. See **fib_entry_delegate.h** for a full list of delegate types.
-
-
-Tracking
-^^^^^^^^
-
-A prime service FIB provides for other sub-system is the ability to
-'track' the forwarding for a given next-hop. For example, a tunnel
-will want to know how to forward to its destination address. It can
-therefore request of the FIB to track this host-prefix and inform it
-when the forwarding for that prefix changes.
-
-FIB tracking sources a host-prefix entry in the FIB using the 'recusive
-resolution (RR)' source, it exactly the same way that a recursive path
-does. If the entry did not previsouly exist, then the RR source will
-inherit (and track) forwarding from its covering prefix, therefore all
-packets that match this entry are forwarded in the same way as if the
-entry did not exist. The tunnel that is tracking this FIB entry will
-become a child dependent. The benefit to creating the entry, is that
-it now exists in the FIB node graph, so all actions that happen on its
-parents, are propagated to the host-prefix entry and consequently to
-the tunnel.
-
-FIB provides a wrapper to the sourcing of the host-prefix using a
-delegate attached to the entry, and the entry is RR sourced only once.
-. The benefit of this aproach is that each time a new client tracks
-the entry it doesn't RR source it. When an entry is sourced all its
-children are updated. Thus, new clients tracking an entry is
-O(n^2). With the tracker as indirection, the entry is sourced only once.
-
-
-.. rubric:: Footnotes:
-
-.. [#f1] Or terminate in an object that transitions the packet out of
-         the FIB domain, e.g. a drop.
-.. [#f2] Optimisations
-.. [#f3] Note it is valid for either interface to be bound to a different table than table 1
-.. [#f4] The engaged reader can see the full priority list in vnet/vnet/fib/fib_entry.h
-.. [#f5] Note it is only possible to add routes via an address (i.e. a/32 or /128) not via a shorter mask prefix. There is no use case for the latter
-.. [#f6] For iBGP the via-address is the loopback address of the peer PE, for eBGP it is the adj-fib for the CE
-.. [#f7] As is the case ofr eBGP
-.. [#f8] As is the case for iBGP
-.. [#f9] If that source is relying on FIB to perform recursive resolution, then there is no reason it should do so itself.
-.. [#f10] The derived data-plane graph MUST never be cyclic
-.. [#f11] Advertised, e.g. by LDP, SR or BGP
-.. [#f12] The only case where the labels will be the same is BGP VPNv4 label allocation per-VRF
diff --git a/docs/gettingstarted/developers/fib20/scale.rst b/docs/gettingstarted/developers/fib20/scale.rst
deleted file mode 100644
index 4100f9aa7cf..00000000000
--- a/docs/gettingstarted/developers/fib20/scale.rst
+++ /dev/null
@@ -1,247 +0,0 @@
-.. _scale:
-
-Scale
------
-
-The only limiting factor on FIB scale is the amount of memory
-allocated to each heap the FIB uses, and there are 2:
-
-* The main heap
-* The stats heap
-
-
-Main Heap
-^^^^^^^^^
-
-The main heap is used to allocate all memory needed for the FIB
-data-structures. Each table, created by the user, i.e. with;
-
-.. code-block:: console
-
-   $ ip table add 1
-
-or the default table, comprises 2 *ip4_fib_t* objects. 
-The 'non-forwarding' *ip4_fib_t* contains all the entries in the table
-and, the 'forwarding' contains the entries that are matched against in
-the data-plane. The difference between the two sets are the entries
-that should not be matched in the data-plane.
-Each *ip4_fib_t* comprises an mtrie (for fast lookup in the data-plane)
-and a hash table per-prefix length (for lookup in the control plane).
-
-To see the amount of memory consumed by the IPv4 tables use:
-
-.. code-block:: console
-                
- vpp# sh ip fib mem
- ipv4-VRF:0 mtrie:335744 hash:4663
- ipv4-VRF:1 mtrie:333056 hash:3499
- totals: mtrie:668800 hash:8162 all:676962
-
-this output shows two 'empty' (i.e. no added routes) tables. Each
-mtrie uses about 150k of memory, so each table about 300k.
-
-
-Below the output having added 1M, 2M and 4M routes respectively:
-
-.. code-block:: console
-
- vpp# sh ip fib mem
- ipv4-VRF:0 mtrie:335744 hash:4695
- totals: mtrie:335744 hash:4695 all:340439
-
-.. code-block:: console
-
- vpp# sh ip fib mem
- ipv4-VRF:0 mtrie:5414720 hash:41177579
- totals: mtrie:5414720 hash:41177579 all:46592299
-
-.. code-block:: console
-
- vpp# sh ip fib mem
- ipv4-VRF:0 mtrie:22452608 hash:168544508
- totals: mtrie:22452608 hash:168544508 all:190997116
-
-
-IPv6 also has the concept of forwarding and non-forwarding entries,
-however for IPv6 all the forwarding entries are stored in a single
-hash table (same goes for the non-forwarding). The key to the hash
-table includes the IPv6 table-id.
-
-To see the amount of memory consumed by the IPv4 tables use:
-
-.. code-block:: console
-
- vpp# sh ip6 fib mem                                
- IPv6 Non-Forwarding Hash Table:
- Hash table ip6 FIB non-fwding table
-     7 active elements 7 active buckets
-     1 free lists
-     0 linear search buckets
-     arena: base 7f2fe28bf000, next 803c0
-            used 525248 b (0 Mbytes) of 33554432 b (32 Mbytes)
-
- IPv6 Forwarding Hash Table:
- Hash table ip6 FIB fwding table
-     7 active elements 7 active buckets
-     1 free lists
-     0 linear search buckets
-     arena: base 7f2fe48bf000, next 803c0
-            used 525248 b (0 Mbytes) of 33554432 b (32 Mbytes)
-     
-as we scale to 128k IPv6 entries:
-
-.. code-block:: console
-
- vpp# sh ip6 fib mem
- IPv6 Non-Forwarding Hash Table:
- Hash table ip6 FIB non-fwding table
-     131079 active elements 32773 active buckets
-     2 free lists
-        [len 1] 2 free elts
-     0 linear search buckets
-     arena: base 7fed7a514000, next 4805c0
-            used 4720064 b (4 Mbytes) of 1073741824 b (1024 Mbytes)
-
- IPv6 Forwarding Hash Table:
- Hash table ip6 FIB fwding table
-     131079 active elements 32773 active buckets
-     2 free lists
-        [len 1] 2 free elts
-     0 linear search buckets
-     arena: base 7fedba514000, next 4805c0
-            used 4720064 b (4 Mbytes) of 1073741824 b (1024 Mbytes)
-
-and 256k:
-
-.. code-block:: console
-
- vpp# sh ip6 fib mem
- IPv6 Non-Forwarding Hash Table:
- Hash table ip6 FIB non-fwding table
-     262151 active elements 65536 active buckets
-     2 free lists
-        [len 1] 6 free elts
-     0 linear search buckets
-     arena: base 7fed7a514000, next 880840
-            used 8915008 b (8 Mbytes) of 1073741824 b (1024 Mbytes)
-
- IPv6 Forwarding Hash Table:
- Hash table ip6 FIB fwding table
-     262151 active elements 65536 active buckets
-     2 free lists
-        [len 1] 6 free elts
-     0 linear search buckets
-     arena: base 7fedba514000, next 880840
-            used 8915008 b (8 Mbytes) of 1073741824 b (1024 Mbytes)
-
-and 1M:
-
-.. code-block:: console
-
- vpp# sh ip6 fib mem
- IPv6 Non-Forwarding Hash Table:
- Hash table ip6 FIB non-fwding table
-     1048583 active elements 65536 active buckets
-     4 free lists
-        [len 1] 65533 free elts
-        [len 2] 65531 free elts
-        [len 4] 9 free elts
-     0 linear search buckets
-     arena: base 7fed7a514000, next 3882740
-            used 59254592 b (56 Mbytes) of 1073741824 b (1024 Mbytes)
-
- IPv6 Forwarding Hash Table:
- Hash table ip6 FIB fwding table
-     1048583 active elements 65536 active buckets
-     4 free lists
-        [len 1] 65533 free elts
-        [len 2] 65531 free elts
-        [len 4] 9 free elts
-     0 linear search buckets
-     arena: base 7fedba514000, next 3882740
-            used 59254592 b (56 Mbytes) of 1073741824 b (1024 Mbytes)
-
-as can be seen from the output the IPv6 hash-table in this case was scaled
-to 1GB and 1million prefixes has used 56MB of it.
-
-The main heap is also used to allocate objects that represent the FIB
-entries in the control and data plane (see :ref:`controlplane` and
-:ref:`dataplane`) such as *fib_entry_t* and *load_balance_t*. These come
-from the main heap because they are not protocol specific
-(i.e. they are used to represent either IPv4, IPv6 or MPLS
-entries).
-
-With 1M prefixes allocated the memory usage is:
-
-.. code-block:: console
-
- vpp# sh fib mem
- FIB memory
-  Tables:
-             SAFI              Number     Bytes   
-         IPv4 unicast             1     33619968  
-         IPv6 unicast             2     118502784 
-             MPLS                 0         0     
-        IPv4 multicast            1       1175    
-        IPv6 multicast            1      525312   
-  Nodes:
-             Name               Size  in-use /allocated   totals
-             Entry               72   1048589/ 1048589    75498408/75498408 
-         Entry Source            40   1048589/ 1048589    41943560/41943560 
-     Entry Path-Extensions       76      0   /    0       0/0 
-        multicast-Entry         192      6   /    6       1152/1152 
-           Path-list             40     18   /    18      720/720 
-           uRPF-list             16     14   /    14      224/224 
-             Path                72     22   /    22      1584/1584 
-      Node-list elements         20   1048602/ 1048602    20972040/20972040 
-        Node-list heads          8      24   /    24      192/192 
-
-and with 2M
-
-.. code-block:: console
-       
- vpp# sh fib mem         
- FIB memory
-  Tables:
-             SAFI              Number     Bytes   
-         IPv4 unicast             1     33619968  
-         IPv6 unicast             2     252743040 
-             MPLS                 0         0     
-        IPv4 multicast            1       1175    
-        IPv6 multicast            1      525312   
-  Nodes:
-             Name               Size  in-use /allocated   totals
-             Entry               72   2097165/ 2097165    150995880/150995880 
-         Entry Source            40   2097165/ 2097165    83886600/83886600 
-     Entry Path-Extensions       76      0   /    0       0/0 
-        multicast-Entry         192      6   /    6       1152/1152 
-           Path-list             40     18   /    19      720/760 
-           uRPF-list             16     18   /    18      288/288 
-             Path                72     22   /    23      1584/1656 
-      Node-list elements         20   2097178/ 2097178    41943560/41943560 
-        Node-list heads          8      24   /    24      192/192 
-
-However, the situation is not a simple as that. All of the 1M prefixes
-added above were reachable via the same next-hop, so the path-list
-(and path) they use is shared. As prefixes are added that use
-different (sets of) next-hops, the number of path-lists and paths
-requires will increase.
-
-
-Stats Heap
-^^^^^^^^^^
-
-VPP collects statistics for each route. For each route VPP collects
-byte and packet counters for packets sent to the prefix (i.e. the
-route was matched in the data-plane) and packets sent via the prefix (i.e. the
-matching prefix is reachable through it - like a BGP peer). This
-requires 4 counters per route in the stats segment.
-
-Below shows the size of the stats segment with 1M, 2M and 4M routes.
-
-.. code-block:: console
-
- total: 1023.99M, used: 127.89M, free: 896.10M, trimmable: 830.94M
- total: 1023.99M, used: 234.14M, free: 789.85M, trimmable: 668.15M
- total: 1023.99M, used: 456.83M, free: 567.17M, trimmable: 388.91M
-
diff --git a/docs/gettingstarted/developers/fib20/thedatamodel.rst b/docs/gettingstarted/developers/fib20/thedatamodel.rst
deleted file mode 100644
index cd3de179814..00000000000
--- a/docs/gettingstarted/developers/fib20/thedatamodel.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. _thedatamodel:
-
-The Data Model
---------------
-
-The FIB data model comprises two parts; the control-plane (CP) and the data-plane
-(DP). The CP data model represents the data that is programmed into VPP by the
-upper layers. The DP model represents how VPP derives actions to be performed on
-packets as they are switched.
-
-.. toctree::
-
-   controlplane
-   dataplane
-
diff --git a/docs/gettingstarted/developers/fib20/tunnels.rst b/docs/gettingstarted/developers/fib20/tunnels.rst
deleted file mode 100644
index f53d6223589..00000000000
--- a/docs/gettingstarted/developers/fib20/tunnels.rst
+++ /dev/null
@@ -1,62 +0,0 @@
-.. _tunnels:
-
-Tunnels
--------
-
-Tunnels share a similar property to recursive routes in that after applying the
-tunnel encapsulation, a new packet must be forwarded, i.e. forwarding is
-recursive. However, as with recursive routes the tunnel's destination is known
-beforehand, so the second lookup can be avoided if the packet can follow the
-already constructed data-plane graph for the tunnel's destination. This process
-of joining to DP graphs together is termed *stacking*.
-  
-.. figure:: /_images/fib20fig11.png
-
-Figure 11: Tunnel control plane object diagram
-
-Figure 11 shows the control plane object graph for a route via a tunnel. The two
-sub-graphs for the route via the tunnel and the route for the tunnel's
-destination are shown to the right and left respectively. The red line shows the
-relationship form by stacking the two sub-graphs. The adjacency on the tunnel
-interface is termed a 'mid-chain' since it is now present in the middle of the
-graph/chain rather than its usual terminal location.
-
-The mid-chain adjacency is contributed by the gre_tunnel_t , which also becomes
-part of the FIB control-plane graph. Consequently it will be visited by a
-back-walk when the forwarding information for the tunnel's destination changes.
-This will trigger it to restack the mid-chain adjacency on the new
-*load_balance_t* contributed by the parent *fib_entry_t*.
-
-If the back-walk indicates that there is no route to the tunnel's
-destination, or that the resolving route does not meet resolution
-constraints, then the tunnel can be marked as down, and fast
-convergence can be triggered in the same way as for physical interfaces (see section ...).
-
-
-Multi-Point Tunnels
-^^^^^^^^^^^^^^^^^^^
-
-Multi-point tunnels are an example of a non-broadcast multi-access
-interface. In simple terms this means there are many peers on the link
-but it is not possible to broadcast a single message to all of them at
-once, and hence the usual peer discovery mechanism (as employed,
-e.g. by ARP) is not available. Although an *ip_neighbor_t* is a
-representation of an IP peer on a link, it is not valid in this
-context as it maps the peer's identity to its MAC address. For a
-tunnel peer it is required to map the peer's overlay address (the
-attached address, the one in the same subnet as the device) with the
-peer's underlay address (probably on the other side of the
-internet). In the P2P case where there is only one peer on the link,
-the peer's underlay address is the same as the tunnel's destination
-address.
-The data structure that represents the mapping of the peer's overlay
-with underlay address is an entry in the Tunnel Endpoint Information
-Base (TEIB); the *tieb_entry_t*. TEIB entries are created by the
-control plane (e.g. NHRP (RFC2332)).
-
-Each mid-chain adjacency on a multi-point tunnel is stacked on the
-*fib_entry_t* object that resolves the peer's underlay address. The
-glean adjacency on the tunnel resolves via a drop, since broadcasts
-are not possible. A multicast adjacency on a multi-point tunnel is
-currently a work in progress.
-
diff --git a/docs/gettingstarted/developers/gdb_examples.rst b/docs/gettingstarted/developers/gdb_examples.rst
deleted file mode 100644
index 893987796cf..00000000000
--- a/docs/gettingstarted/developers/gdb_examples.rst
+++ /dev/null
@@ -1,141 +0,0 @@
-.. _gdb_examples:
-
-.. toctree::
-
-GDB Examples
-===============
-
-In this section we have a few useful gdb commands.
-
-Starting GDB
-----------------------------
-
-Once at the gdb prompt, VPP can be started by running the following commands:
-
-.. code-block:: console
-
-   (gdb) run -c /etc/vpp/startup.conf
-   Starting program: /scratch/vpp-master/build-root/install-vpp_debug-native/vpp/bin/vpp -c /etc/vpp/startup.conf
-    [Thread debugging using libthread_db enabled]
-    Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
-    vlib_plugin_early_init:361: plugin path /scratch/vpp-master/build-root/install-vpp_debug-native/vpp/lib/vpp_plugins:/scratch/vpp-master/build-root/install-vpp_debug-native/vpp/lib/vpp_plugins
-    ....
-
-Backtrace
-----------------------------
-
-If you encounter errors when running VPP, such as VPP terminating due to a segfault
-or abort signal, then you can run the VPP debug binary and then execute **backtrace** or **bt**.
-
-.. code-block:: console
-
-    (gdb) bt
-    #0  ip4_icmp_input (vm=0x7ffff7b89a40 , node=0x7fffb6bb6900, frame=0x7fffb6725ac0) at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:187
-    #1  0x00007ffff78da4be in dispatch_node (vm=0x7ffff7b89a40 , node=0x7fffb6bb    6900, type=VLIB_NODE_TYPE_INTERNAL, dispatch_state=VLIB_NODE_STATE_POLLING, frame=0x7fffb6725ac0, last_time_stamp=10581236529    65565) at /scratch/vpp-master/build-data/../src/vlib/main.c:988
-    #2  0x00007ffff78daa77 in dispatch_pending_node (vm=0x7ffff7b89a40 , pending_frame_index=6, last_time_stamp=1058123652965565) at /scratch/vpp-master/build-data/../src/vlib/main.c:1138
-    ....
-
-Get to the GDB prompt
----------------------------------------
-
-When VPP is running, you can get to the command prompt by pressing **CTRL+C**.
-
-Breakpoints
----------------------------------------
-
-When at the GDB prompt, set a breakpoint by running the commands below:
-
-.. code-block:: console
-
-    (gdb) break ip4_icmp_input
-    Breakpoint 4 at 0x7ffff6b9c00b: file /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c, line 142.
-
-List the breakpoints already set:
-
-.. code-block:: console
-
-    (gdb) i b
-    Num     Type           Disp Enb Address            What
-    1       breakpoint     keep y   0x00007ffff6b9c00b in ip4_icmp_input at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
-        breakpoint already hit 3 times
-    2       breakpoint     keep y   0x00007ffff6b9c00b in ip4_icmp_input at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
-    3       breakpoint     keep y   0x00007ffff640f646 in tw_timer_expire_timers_internal_1t_3w_1024sl_ov 
-        at /scratch/vpp-master/build-data/../src/vppinfra/tw_timer_template.c:775
-
-Delete a breakpoint:
-
-.. code-block:: console
-
-    (gdb) del 2
-    (gdb) i b
-    Num     Type           Disp Enb Address            What
-    1       breakpoint     keep y   0x00007ffff6b9c00b in ip4_icmp_input at /scratch/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
-	breakpoint already hit 3 times
-    3       breakpoint     keep y   0x00007ffff640f646 in tw_timer_expire_timers_internal_1t_3w_1024sl_ov 
-        at /scratch/vpp-master/build-data/../src/vppinfra/tw_timer_template.c:775
-
-Step/Next/List
----------------------------------------
-
-Step through the code using (s)tep into, (n)ext, and list some lines before and after where you are with list.
-
-.. code-block:: console
-
-    Thread 1 "vpp_main" hit Breakpoint 1, ip4_icmp_input (vm=0x7ffff7b89a40 , node=0x7fffb6bb6900, frame=0x7fffb6709480)
-        at /scratch/jdenisco/vpp-master/build-data/../src/vnet/ip/icmp4.c:142
-    142	{
-    (gdb) n
-    143	  icmp4_main_t *im = &icmp4_main;
-    (
-    (gdb) list
-    202	      vlib_put_next_frame (vm, node, next, n_left_to_next);
-    203	    }
-    204	
-    205	  return frame->n_vectors;
-    206	}
-    207	
-    208	/* *INDENT-OFF* */
-    209	VLIB_REGISTER_NODE (ip4_icmp_input_node,static) = {
-    210	  .function = ip4_icmp_input,
-    211	  .name = "ip4-icmp-input",
-
-Examining Data and packets
------------------------------------------------
-
-To look at data and packets use e(x)amine or (p)rint.
-
-
-For example in this code look at the ip packet:
-
-.. code-block:: console
-
-    (gdb) p/x *ip0
-    $3 = {{ip_version_and_header_length = 0x45, tos = 0x0, length = 0x5400,
-    fragment_id = 0x7049, flags_and_fragment_offset = 0x40, ttl = 0x40, protocol = 0x1,
-    checksum = 0x2ddd, {{src_address = {data = {0xa, 0x0, 0x0, 0x2},
-    data_u32 = 0x200000a, as_u8 = {0xa, 0x0, 0x0, 0x2}, as_u16 = {0xa, 0x200},
-    as_u32 = 0x200000a}, dst_address = {data = {0xa, 0x0, 0x0, 0xa}, data_u32 = 0xa00000a,
-    as_u8 = {0xa, 0x0, 0x0, 0xa}, as_u16 = {0xa, 0xa00},  as_u32 = 0xa00000a}},
-    address_pair = {src = {data = {0xa, 0x0, 0x0, 0x2}, data_u32 = 0x200000a,
-    as_u8 = {0xa, 0x0, 0x0, 0x2}, as_u16 = {0xa, 0x200},  as_u32 = 0x200000a},
-    dst = {data = {0xa, 0x0, 0x0, 0xa}, data_u32 = 0xa00000a, as_u8 = {0xa, 0x0, 0x0, 0xa},
-    as_u16 = {0xa, 0xa00}, as_u32 = 0xa00000a}}}}, {checksum_data_64 =
-    {0x40704954000045, 0x200000a2ddd0140}, checksum_data_64_32 = {0xa00000a}},
-    {checksum_data_32 = {0x54000045, 0x407049, 0x2ddd0140, 0x200000a, 0xa00000a}}}
-      
-Then the icmp header
-
-.. code-block:: console
-
-    (gdb) p/x *icmp0
-    $4 = {type = 0x8, code = 0x0, checksum = 0xf148}
-
-Then look at the actual bytes:
-
-.. code-block:: console
-
-    (gdb) x/50w ip0
-    0x7fde9953510e:	0x54000045	0x00407049	0x2ddd0140	0x0200000a
-    0x7fde9953511e:	0x0a00000a	0xf1480008	0x03000554	0x5b6b2e8a
-    0x7fde9953512e:	0x00000000	0x000ca99a	0x00000000	0x13121110
-    0x7fde9953513e:	0x17161514	0x1b1a1918	0x1f1e1d1c	0x23222120
diff --git a/docs/gettingstarted/developers/gitreview.rst b/docs/gettingstarted/developers/gitreview.rst
deleted file mode 100644
index 3f865c159a2..00000000000
--- a/docs/gettingstarted/developers/gitreview.rst
+++ /dev/null
@@ -1,199 +0,0 @@
-.. _gitreview:
-
-*******************************
-Getting a Patch Reviewed
-*******************************
-
-This section describes how to get FD.io VPP sources reviewed and merged.
-
-Setup
-========
-
-If you don't have a Linux Foundation ID, `create one here. `_
-
-With your Linux Foundation ID credentials sign into `Gerrit Code Review at gerrit.fd.io `_
-
-`Install git-review, `_ which is a "command-line tool for Git / Gerrit to submit a change or to fetch an existing one."
-
-If you're on Ubuntu, install keychain:
-
-.. code-block:: console
-
-    $ sudo apt-get install keychain
-
-ssh keys
--------------
-
-To get FD.io VPP documents reviewed the VPP repository should be cloned with ssh. You should be logged into Gerrit Code Review as noted above.
-
-Create your public and private ssh key with:
-
-.. code-block:: console
-
-    $ ssh-keygen -t rsa
-    $ keychain
-    $ cat ~/.ssh/id_rsa.pub 
-
-Copy **all** the contents of the public key (id_rsa.pub) output by the above **cat** command. Then go to your `SSH Public keys settings page `_, click **Add Key ...**, paste your public key, and finally click **Add**.  
-
-.. _clone-ssh:
-
-Clone with ssh
-==============
-
-Clone the repo with:
-
-.. code-block:: console
-
-    $ git clone ssh://gerrit.fd.io:29418/vpp
-    $ cd vpp
-
-This will only work if the name of the user on your system matches your Gerrit username.
-
-Otherwise, clone with:
-
-.. code-block:: console
-
-    $ git clone ssh://@gerrit.fd.io:29418/vpp
-    $ cd vpp
-
-When attempting to clone the repo Git will prompt you asking if you want to add the Server Host Key to the list of known hosts. Enter **yes** and press the **Enter** key.
-
-Git Review
-===========
-
-The VPP documents use the gerrit server, and git review for submitting and fetching patches.
-
-
-New patch
------------------
-
-When working with a new patch, use the following commands to get your patch reviewed.
-
-Make sure you have modified the correct files by issuing the following commands:
-
-.. code-block:: console
-
-    $ git status
-    $ git diff
-
-Then add and commit the patch. You may want to add a tag to the commit comments.
-For example for a document with only patches you should add the tag **docs:**.
-
-.. code-block:: console
-
-    $ git add 
-    $ git commit -s
-
-The commit comment should have something like the following comment:
-
-.. code-block:: console
-
-   docs: A brief description of the commit
-
-   Type: Improvement (The type of commit this could be: Improvement, Fix or Feature)
-
-   A detailed description of the commit could go here.
-
-Push the patch for review.
-
-.. code-block:: console
-
-    $ git review
-
-If you are creating a draft, meaning you do not want your changes reviewed yet, do the following:
-
-.. code-block:: console
-
-    $ git review -D
-
-After submitting a review, reset where the HEAD is pointing to with:
-
-.. code-block:: console
-
-    $ git reset --hard origin/master
-
-Existing patch
------------------------
-
-The "change number" used below is in the URL of the review.
-
-After clicking an individual review, the change number can be found in the URL at "https://gerrit.fd.io/r/#/c/<*CHANGE_NUMBER*>/"
-
-To view an existing patch:
-
-.. code-block:: console
-
-    $ git review -d 
-    $ git status
-    $ git diff
-
-.. caution::
-
-    If you have made changes and do "git review -d ", your current
-    changes will try to be stashed so that the working tree can change to the review branch
-    you specified. If you want to make sure you don't lose your changes, clone another Gerrit
-    repo into a new directory using the cloning steps shown in :ref:`clone-ssh`, and perform
-    "git review -d " in this new directory.
-
-To modify an existing patch, make sure you modified the correct files, and apply the patch with:
-
-.. code-block:: console
-
-    $ git review -d 
-    $ git status
-    $ git diff
-
-    $ git add 
-    $ git commit --amend
-    $ git review
-
-When you're done viewing or modifying a branch, get back to the master branch by entering:
-
-.. code-block:: console
-
-    $ git reset --hard origin/master
-    $ git checkout master
-
-Patch Conflict Resolution
--------------------------
-
-Two different patch conflict scenarios arise from time to
-time. Sometime after uploading a patch to https://gerrit.fd.io, the
-gerrit UI may show a patch status of "Merge Conflict."
-
-Or, you may attempt to upload a new patch-set via "git review," only to
-discover that the gerrit server won't allow the upload due to an upstream
-merge conflict.
-
-In both cases, it's [usually] fairly simple to fix the problem. You
-need to rebase the patch onto master/latest. Details vary from case to
-case.
-
-Here's how to rebase a patch previously uploaded to the Gerrit server
-which now has a merge conflict. In a fresh workspace cloned from
-master/latest, do the following:
-
-.. code-block:: console
-
-    $ git-review -d <*Gerrit change #*>
-    $ git rebase origin/master
-       while (conflicts)
-          
-          $ git rebase --continue
-    $ git review
-
-In the upload-failure case, use caution: carefully **save your work**
-before you do anything else! 
-
-Rebase your patch and try again. Please **do not** re-download ["git
-review -d"] the patch from the gerrit server...:
-
-.. code-block:: console
-
-    $ git rebase origin/master
-       while (conflicts)
-          
-          $ git rebase --continue
-    $ git review
-
diff --git a/docs/gettingstarted/developers/index.rst b/docs/gettingstarted/developers/index.rst
deleted file mode 100644
index b47abcdf08c..00000000000
--- a/docs/gettingstarted/developers/index.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-.. _gstarteddevel:
-
-###############
-For Developers
-###############
-
-The Developers section covers the following areas:
-
-* Describes how to build different types of VPP images
-* Explains how to run VPP with and without GDB, with some GDB examples
-* Describes the steps required to get a patch reviewed and merged
-* Describes the VPP software architecture and identifies the associated four VPP layers
-* Describes the different components that are associated with each VPP layer
-* Explains how to Create, Add, Enable/Disable different ARC features
-* Discusses different aspects of Bounded-index Extensible Hashing (bihash), and how it is used in database lookups
-* Describes the different types of API support and how to integrate a plugin
-
-.. toctree::
-   :maxdepth: 2
-
-   building
-   running_vpp
-   testing_vpp
-   gdb_examples
-   add_plugin
-   add_plugin_goapi
-   gitreview
-   softwarearchitecture
-   infrastructure
-   vlib
-   plugins
-   vnet
-   featurearcs
-   metadata
-   multiarch/index.rst
-   bihash
-   vpp_api_module
-   binary_api_support
-   buildsystem/index.rst
-   eventviewer
-   fib20/index.rst
-   buildwireshark
-   punt
-   quic_plugin
-   cross_compile_macos.rst
-   cnat
-   ipsec
-   VPPAPI.md
diff --git a/docs/gettingstarted/developers/infrastructure.md b/docs/gettingstarted/developers/infrastructure.md
deleted file mode 100644
index a61068c75cd..00000000000
--- a/docs/gettingstarted/developers/infrastructure.md
+++ /dev/null
@@ -1,614 +0,0 @@
-VPPINFRA (Infrastructure)
-=========================
-
-The files associated with the VPP Infrastructure layer are located in
-the ./src/vppinfra folder.
-
-VPPinfra is a collection of basic c-library services, quite
-sufficient to build standalone programs to run directly on bare metal.
-It also provides high-performance dynamic arrays, hashes, bitmaps,
-high-precision real-time clock support, fine-grained event-logging, and
-data structure serialization.
-
-One fair comment / fair warning about vppinfra: you can\'t always tell a
-macro from an inline function from an ordinary function simply by name.
-Macros are used to avoid function calls in the typical case, and to
-cause (intentional) side-effects.
-
-Vppinfra has been around for almost 20 years and tends not to change
-frequently. The VPP Infrastructure layer contains the following
-functions:
-
-Vectors
--------
-
-Vppinfra vectors are ubiquitous dynamically resized arrays with by user
-defined \"headers\". Many vpppinfra data structures (e.g. hash, heap,
-pool) are vectors with various different headers.
-
-The memory layout looks like this:
-
-```
-                   User header (optional, uword aligned)
-                   Alignment padding (if needed)
-                   Vector length in elements
- User's pointer -> Vector element 0
-                   Vector element 1
-                   ...
-                   Vector element N-1
-```
-
-As shown above, the vector APIs deal with pointers to the 0th element of
-a vector. Null pointers are valid vectors of length zero.
-
-To avoid thrashing the memory allocator, one often resets the length of
-a vector to zero while retaining the memory allocation. Set the vector
-length field to zero via the vec\_reset\_length(v) macro. \[Use the
-macro! It's smart about NULL pointers.\]
-
-Typically, the user header is not present. User headers allow for other
-data structures to be built atop vppinfra vectors. Users may specify the
-alignment for first data element of a vector via the \[vec\]()\*\_aligned
-macros.
-
-Vector elements can be any C type e.g. (int, double, struct bar). This
-is also true for data types built atop vectors (e.g. heap, pool, etc.).
-Many macros have \_a variants supporting alignment of vector elements
-and \_h variants supporting non-zero-length vector headers. The \_ha
-variants support both.  Additionally cacheline alignment within a
-vector element structure can be specified using the
-\[CLIB_CACHE_LINE_ALIGN_MARK\]() macro.
-
-Inconsistent usage of header and/or alignment related macro variants
-will cause delayed, confusing failures.
-
-Standard programming error: memorize a pointer to the ith element of a
-vector, and then expand the vector. Vectors expand by 3/2, so such code
-may appear to work for a period of time. Correct code almost always
-memorizes vector **indices** which are invariant across reallocations.
-
-In typical application images, one supplies a set of global functions
-designed to be called from gdb. Here are a few examples:
-
--   vl(v) - prints vec\_len(v)
--   pe(p) - prints pool\_elts(p)
--   pifi(p, index) - prints pool\_is\_free\_index(p, index)
--   debug\_hex\_bytes (p, nbytes) - hex memory dump nbytes starting at p
-
-Use the "show gdb" debug CLI command to print the current set.
-
-Bitmaps
--------
-
-Vppinfra bitmaps are dynamic, built using the vppinfra vector APIs.
-Quite handy for a variety jobs.
-
-Pools
------
-
-Vppinfra pools combine vectors and bitmaps to rapidly allocate and free
-fixed-size data structures with independent lifetimes. Pools are perfect
-for allocating per-session structures.
-
-Hashes
-------
-
-Vppinfra provides several hash flavors. Data plane problems involving
-packet classification / session lookup often use
-./src/vppinfra/bihash\_template.\[ch\] bounded-index extensible
-hashes. These templates are instantiated multiple times, to efficiently
-service different fixed-key sizes.
-
-Bihashes are thread-safe. Read-locking is not required. A simple
-spin-lock ensures that only one thread writes an entry at a time.
-
-The original vppinfra hash implementation in
-./src/vppinfra/hash.\[ch\] are simple to use, and are often used in
-control-plane code which needs exact-string-matching.
-
-In either case, one almost always looks up a key in a hash table to
-obtain an index in a related vector or pool. The APIs are simple enough,
-but one must take care when using the unmanaged arbitrary-sized key
-variant. Hash\_set\_mem (hash\_table, key\_pointer, value) memorizes
-key\_pointer. It is usually a bad mistake to pass the address of a
-vector element as the second argument to hash\_set\_mem. It is perfectly
-fine to memorize constant string addresses in the text segment.
-
-Timekeeping
------------
-
-Vppinfra includes high-precision, low-cost timing services. The
-datatype clib_time_t and associated functions reside in
-./src/vppinfra/time.\[ch\]. Call clib_time_init (clib_time_t \*cp) to
-initialize the clib_time_t object.
-
-Clib_time_init(...) can use a variety of different ways to establish
-the hardware clock frequency. At the end of the day, vppinfra
-timekeeping takes the attitude that the operating system's clock is
-the closest thing to a gold standard it has handy.
-
-When properly configured, NTP maintains kernel clock synchronization
-with a highly accurate off-premises reference clock.  Notwithstanding
-network propagation delays, a synchronized NTP client will keep the
-kernel clock accurate to within 50ms or so.
-
-Why should one care? Simply put, oscillators used to generate CPU
-ticks aren't super accurate. They work pretty well, but a 0.1% error
-wouldn't be out of the question. That's a minute and a half's worth of
-error in 1 day. The error changes constantly, due to temperature
-variation, and a host of other physical factors.
-
-It's far too expensive to use system calls for timing, so we're left
-with the problem of continously adjusting our view of the CPU tick
-register's clocks_per_second parameter.
-
-The clock rate adjustment algorithm measures the number of cpu ticks
-and the "gold standard" reference time across an interval of
-approximately 16 seconds. We calculate clocks_per_second for the
-interval: use rdtsc (on x86_64) and a system call to get the latest
-cpu tick count and the kernel's latest nanosecond timestamp. We
-subtract the previous interval end values, and use exponential
-smoothing to merge the new clock rate sample into the clocks_per_second
-parameter.
-
-As of this writing, we maintain the clock rate by way of the following
-first-order differential equation:
-
-
-```
-   clocks_per_second(t) = clocks_per_second(t-1) * K + sample_cps(t)*(1-K)
-   where K = e**(-1.0/3.75);
-```
-
-This yields a per observation "half-life" of 1 minute. Empirically,
-the clock rate converges within 5 minutes, and appears to maintain
-near-perfect agreement with the kernel clock in the face of ongoing
-NTP time adjustments.
-
-See ./src/vppinfra/time.c:clib_time_verify_frequency(...) to look at
-the rate adjustment algorithm. The code rejects frequency samples
-corresponding to the sort of adjustment which might occur if someone
-changes the gold standard kernel clock by several seconds.
-
-### Monotonic timebase support
-
-Particularly during system initialization, the "gold standard" system
-reference clock can change by a large amount, in an instant. It's not
-a best practice to yank the reference clock - in either direction - by
-hours or days. In fact, some poorly-constructed use-cases do so.
-
-To deal with this reality, clib_time_now(...) returns the number of
-seconds since vpp started, *guaranteed to be monotonically
-increasing, no matter what happens to the system reference clock*.
-
-This is first-order important, to avoid breaking every active timer in
-the system. The vpp host stack alone may account for tens of millions
-of active timers. It's utterly impractical to track down and fix
-timers, so we must deal with the issue at the timebase level.
-
-Here's how it works. Prior to adjusting the clock rate, we collect the
-kernel reference clock and the cpu clock:
-
-```
-  /* Ask the kernel and the CPU what time it is... */
-  now_reference = unix_time_now ();
-  now_clock = clib_cpu_time_now ();
-```
-
-Compute changes for both clocks since the last rate adjustment,
-roughly 15 seconds ago:
-
-```
-  /* Compute change in the reference clock */
-  delta_reference = now_reference - c->last_verify_reference_time;
-
-  /* And change in the CPU clock */
-  delta_clock_in_seconds = (f64) (now_clock - c->last_verify_cpu_time) *
-    c->seconds_per_clock;
-```
-
-Delta_reference is key. Almost 100% of the time, delta_reference and
-delta_clock_in_seconds are identical modulo one system-call
-time. However, NTP or a privileged user can yank the system reference
-time - in either direction - by an hour, a day, or a decade.
-
-As described above, clib_time_now(...) must return monotonically
-increasing answers to the question "how long has it been since vpp
-started, in seconds." To do that, the clock rate adjustment algorithm
-begins by recomputing the initial reference time:
-
-```
-  c->init_reference_time += (delta_reference - delta_clock_in_seconds);
-```
-
-It's easy to convince yourself that if the reference clock changes by
-15.000000 seconds and the cpu clock tick time changes by 15.000000
-seconds, the initial reference time won't change.
-
-If, on the other hand, delta_reference is -86400.0 and delta clock is
-15.0 - reference time jumped backwards by exactly one day in a
-15-second rate update interval - we add -86415.0 to the initial
-reference time.
-
-Given the corrected initial reference time, we recompute the total
-number of cpu ticks which have occurred since the corrected initial
-reference time, at the current clock tick rate:
-
-```
-  c->total_cpu_time = (now_reference - c->init_reference_time)
-    * c->clocks_per_second;
-```
-
-### Timebase precision
-
-Cognoscenti may notice that vlib/clib\_time\_now(...) return a 64-bit
-floating-point value; the number of seconds since vpp started.
-
-Please see [this Wikipedia
-article](https://en.wikipedia.org/wiki/Double-precision_floating-point_format)
-for more information. C double-precision floating point numbers
-(called f64 in the vpp code base) have a 53-bit effective mantissa,
-and can accurately represent 15 decimal digits' worth of precision.
-
-There are 315,360,000.000001 seconds in ten years plus one
-microsecond. That string has exactly 15 decimal digits. The vpp time
-base retains 1us precision for roughly 30 years.
-
-vlib/clib\_time\_now do *not* provide precision in excess of 1e-6
-seconds. If necessary, please use clib_cpu_time_now(...) for direct
-access to the CPU clock-cycle counter. Note that the number of CPU
-clock cycles per second varies significantly across CPU architectures.
-
-Timer Wheels
-------------
-
-Vppinfra includes configurable timer wheel support. See the source
-code in .../src/vppinfra/tw_timer_template.[ch], as well as a
-considerable number of template instances defined in
-.../src/vppinfra/tw_timer_.[ch].
-
-Instantiation of tw_timer_template.h generates named structures to
-implement specific timer wheel geometries. Choices include: number of
-timer wheels (currently, 1 or 2), number of slots per ring (a power of
-two), and the number of timers per "object handle".
-
-Internally, user object/timer handles are 32-bit integers, so if one
-selects 16 timers/object (4 bits), the resulting timer wheel handle is
-limited to 2**28 objects.
-
-Here are the specific settings required to generate a single 2048 slot
-wheel which supports 2 timers per object:
-
-```
-    #define TW_TIMER_WHEELS 1
-    #define TW_SLOTS_PER_RING 2048
-    #define TW_RING_SHIFT 11
-    #define TW_RING_MASK (TW_SLOTS_PER_RING -1)
-    #define TW_TIMERS_PER_OBJECT 2
-    #define LOG2_TW_TIMERS_PER_OBJECT 1
-    #define TW_SUFFIX _2t_1w_2048sl
-    #define TW_FAST_WHEEL_BITMAP 0
-    #define TW_TIMER_ALLOW_DUPLICATE_STOP 0
-```
-
-See tw_timer_2t_1w_2048sl.h for a complete
-example.
-
-tw_timer_template.h is not intended to be #included directly. Client
-codes can include multiple timer geometry header files, although
-extreme caution would required to use the TW and TWT macros in such a
-case.
-
-### API usage examples
-
-The unit test code in .../src/vppinfra/test_tw_timer.c provides a
-concrete API usage example. It uses a synthetic clock to rapidly
-exercise the underlying tw_timer_expire_timers(...) template.
-
-There are not many API routines to call.
-
-#### Initialize a two-timer, single 2048-slot wheel w/ a 1-second timer granularity
-
-```
-    tw_timer_wheel_init_2t_1w_2048sl (&tm->single_wheel,
-                                     expired_timer_single_callback,
-				      1.0 / * timer interval * / );
-```
-
-#### Start a timer
-
-```
-    handle = tw_timer_start_2t_1w_2048sl (&tm->single_wheel, elt_index,
-                                          [0 | 1] / * timer id * / ,
-                                          expiration_time_in_u32_ticks);
-```
-
-#### Stop a timer
-
-```
-    tw_timer_stop_2t_1w_2048sl (&tm->single_wheel, handle);
-```
-
-#### An expired timer callback
-
-```
-    static void
-    expired_timer_single_callback (u32 * expired_timers)
-    {
-    	int i;
-        u32 pool_index, timer_id;
-        tw_timer_test_elt_t *e;
-        tw_timer_test_main_t *tm = &tw_timer_test_main;
-
-        for (i = 0; i < vec_len (expired_timers);
-            {
-            pool_index = expired_timers[i] & 0x7FFFFFFF;
-            timer_id = expired_timers[i] >> 31;
-
-            ASSERT (timer_id == 1);
-
-            e = pool_elt_at_index (tm->test_elts, pool_index);
-
-            if (e->expected_to_expire != tm->single_wheel.current_tick)
-              {
-              	fformat (stdout, "[%d] expired at %d not %d\n",
-                         e - tm->test_elts, tm->single_wheel.current_tick,
-                         e->expected_to_expire);
-              }
-         pool_put (tm->test_elts, e);
-         }
-     }
-```
-
-We use wheel timers extensively in the vpp host stack. Each TCP
-session needs 5 timers, so supporting 10 million flows requires up to
-50 million concurrent timers.
-
-Timers rarely expire, so it's of utmost important that stopping and
-restarting a timer costs as few clock cycles as possible.
-
-Stopping a timer costs a doubly-linked list dequeue. Starting a timer
-involves modular arithmetic to determine the correct timer wheel and
-slot, and a list head enqueue.
-
-Expired timer processing generally involves bulk link-list retirement
-with user callback presentation. Some additional complexity at wheel
-wrap time, to relocate timers from slower-turning timer wheels into
-faster-turning wheels.
-
-Format
-------
-
-Vppinfra format is roughly equivalent to printf.
-
-Format has a few properties worth mentioning. Format's first argument is
-a (u8 \*) vector to which it appends the result of the current format
-operation. Chaining calls is very easy:
-
-```c
-    u8 * result;
-
-    result = format (0, "junk = %d, ", junk);
-    result = format (result, "more junk = %d\n", more_junk);
-```
-
-As previously noted, NULL pointers are perfectly proper 0-length
-vectors. Format returns a (u8 \*) vector, **not** a C-string. If you
-wish to print a (u8 \*) vector, use the "%v" format string. If you need
-a (u8 \*) vector which is also a proper C-string, either of these
-schemes may be used:
-
-```c
-    vec_add1 (result, 0)
-    or
-    result = format (result, "%c", 0);
-```
-
-Remember to vec\_free() the result if appropriate. Be careful not to
-pass format an uninitialized (u8 \*).
-
-Format implements a particularly handy user-format scheme via the "%U"
-format specification. For example:
-
-```c
-    u8 * format_junk (u8 * s, va_list *va)
-    {
-      junk = va_arg (va, u32);
-      s = format (s, "%s", junk);
-      return s;
-    }
-
-    result = format (0, "junk = %U, format_junk, "This is some junk");
-```
-
-format\_junk() can invoke other user-format functions if desired. The
-programmer shoulders responsibility for argument type-checking. It is
-typical for user format functions to blow up spectacularly if the
-va\_arg(va, type) macros don't match the caller's idea of reality.
-
-Unformat
---------
-
-Vppinfra unformat is vaguely related to scanf, but considerably more
-general.
-
-A typical use case involves initializing an unformat\_input\_t from
-either a C-string or a (u8 \*) vector, then parsing via unformat() as
-follows:
-
-```c
-    unformat_input_t input;
-    u8 *s = "";
-
-    unformat_init_string (&input, (char *) s, strlen((char *) s));
-    /* or */
-    unformat_init_vector (&input, );
-```
-
-Then loop parsing individual elements:
-
-```c
-    while (unformat_check_input (&input) != UNFORMAT_END_OF_INPUT)
-    {
-      if (unformat (&input, "value1 %d", &value1))
-        ;/* unformat sets value1 */
-      else if (unformat (&input, "value2 %d", &value2)
-        ;/* unformat sets value2 */
-      else
-        return clib_error_return (0, "unknown input '%U'",
-                                  format_unformat_error, input);
-    }
-```
-
-As with format, unformat implements a user-unformat function capability
-via a "%U" user unformat function scheme. Generally, one can trivially
-transform "format (s, "foo %d", foo) -> "unformat (input, "foo %d", &foo)".
-
-Unformat implements a couple of handy non-scanf-like format specifiers:
-
-```c
-    unformat (input, "enable %=", &enable, 1 /* defaults to 1 */);
-    unformat (input, "bitzero %|", &mask, (1<<0));
-    unformat (input, "bitone %|", &mask, (1<<1));
-    
-```
-
-The phrase "enable %=" means "set the supplied variable to the default
-value" if unformat parses the "enable" keyword all by itself. If
-unformat parses "enable 123" set the supplied variable to 123.
-
-We could clean up a number of hand-rolled "verbose" + "verbose %d"
-argument parsing codes using "%=".
-
-The phrase "bitzero %|" means "set the specified bit in the supplied
-bitmask" if unformat parses "bitzero". Although it looks like it could
-be fairly handy, it's very lightly used in the code base.
-
-`%_` toggles whether or not to skip input white space.
-
-For transition from skip to no-skip in middle of format string, skip input white space.  For example, the following:
-
-```c
-fmt = "%_%d.%d%_->%_%d.%d%_"
-unformat (input, fmt, &one, &two, &three, &four);
-```
-matches input "1.2 -> 3.4".
-Without this, the space after -> does not get skipped.
-
-
-```
-
-### How to parse a single input line
-
-Debug CLI command functions MUST NOT accidentally consume input
-belonging to other debug CLI commands. Otherwise, it's impossible to
-script a set of debug CLI commands which "work fine" when issued one
-at a time.
-
-This bit of code is NOT correct:
-
-```c
-  /* Eats script input NOT beloging to it, and chokes! */
-  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
-    {
-      if (unformat (input, ...))
-	;
-      else if (unformat (input, ...))
-	;
-      else
-        return clib_error_return (0, "parse error: '%U'",
-              			     format_unformat_error, input);
-	}
-    }
-```
-
-When executed as part of a script, such a function will return "parse
-error: ''" every time, unless it happens to be the
-last command in the script.
-
-Instead, use "unformat_line_input" to consume the rest of a line's
-worth of input - everything past the path specified in the
-VLIB_CLI_COMMAND declaration.
-
-For example, unformat_line_input with "my_command" set up as shown
-below and user input "my path is clear" will produce an
-unformat_input_t that contains "is clear".
-
-```c
-    VLIB_CLI_COMMAND (...) = {
-        .path = "my path",
-    };
-```
-
-Here's a bit of code which shows the required mechanics, in full:
-
-```c
-    static clib_error_t *
-    my_command_fn (vlib_main_t * vm,
-                   unformat_input_t * input,
-                   vlib_cli_command_t * cmd)
-    {
-      unformat_input_t _line_input, *line_input = &_line_input;
-      u32 this, that;
-      clib_error_t *error = 0;
-
-      if (!unformat_user (input, unformat_line_input, line_input))
-        return 0;
-
-      /*
-       * Here, UNFORMAT_END_OF_INPUT is at the end of the line we consumed,
-       * not at the end of the script...
-       */
-      while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
-        {
-           if (unformat (line_input, "this %u", &this))
-             ;
-           else if (unformat (line_input, "that %u", &that))
-             ;
-           else
-             {
-               error = clib_error_return (0, "parse error: '%U'",
-              	     		     format_unformat_error, line_input);
-               goto done;
-             }
-          }
-
-    
-
-    done:
-      unformat_free (line_input);
-      return error;
-    }
-   /* *INDENT-OFF* */
-   VLIB_CLI_COMMAND (my_command, static) = {
-     .path = "my path",
-     .function = my_command_fn",
-   };
-   /* *INDENT-ON* */
-
-```
-
-
-Vppinfra errors and warnings
-----------------------------
-
-Many functions within the vpp dataplane have return-values of type
-clib\_error\_t \*. Clib\_error\_t's are arbitrary strings with a bit of
-metadata \[fatal, warning\] and are easy to announce. Returning a NULL
-clib\_error\_t \* indicates "A-OK, no error."
-
-Clib\_warning(format-args) is a handy way to add debugging
-output; clib warnings prepend function:line info to unambiguously locate
-the message source. Clib\_unix\_warning() adds perror()-style Linux
-system-call information. In production images, clib\_warnings result in
-syslog entries.
-
-Serialization
--------------
-
-Vppinfra serialization support allows the programmer to easily serialize
-and unserialize complex data structures.
-
-The underlying primitive serialize/unserialize functions use network
-byte-order, so there are no structural issues serializing on a
-little-endian host and unserializing on a big-endian host.
diff --git a/docs/gettingstarted/developers/ipsec.rst b/docs/gettingstarted/developers/ipsec.rst
deleted file mode 120000
index 46a12cdeacc..00000000000
--- a/docs/gettingstarted/developers/ipsec.rst
+++ /dev/null
@@ -1 +0,0 @@
-../../../src/vnet/ipsec/ipsec.rst
\ No newline at end of file
diff --git a/docs/gettingstarted/developers/metadata.md b/docs/gettingstarted/developers/metadata.md
deleted file mode 100644
index 34400ef4568..00000000000
--- a/docs/gettingstarted/developers/metadata.md
+++ /dev/null
@@ -1,190 +0,0 @@
-Buffer Metadata
-===============
-
-Each vlib_buffer_t (packet buffer) carries buffer metadata which
-describes the current packet-processing state. The underlying
-techniques have been used for decades, across multiple packet
-processing environments.
-
-We will examine vpp buffer metadata in some detail, but folks who need
-to manipulate and/or extend the scheme should expect to do a certain
-level of code inspection.
-
-Vlib (Vector library) primary buffer metadata
-----------------------------------------------
-
-The first 64 octets of each vlib_buffer_t carries the primary buffer
-metadata. See .../src/vlib/buffer.h for full details.
-
-Important fields:
-
-* i16 current_data: the signed offset in data[], pre_data[] that we
-are currently processing. If negative current header points into
-the pre-data (rewrite space) area.
-* u16 current_length: nBytes between current_data and the end of this buffer.
-* u32 flags: Buffer flag bits. Heavily used, not many bits left
-  * src/vlib/buffer.h flag bits
-    * VLIB_BUFFER_IS_TRACED: buffer is traced
-    * VLIB_BUFFER_NEXT_PRESENT: buffer has multiple chunks
-    * VLIB_BUFFER_TOTAL_LENGTH_VALID: total_length_not_including_first_buffer is valid (see below)
-  * src/vnet/buffer.h flag bits
-    * VNET_BUFFER_F_L4_CHECKSUM_COMPUTED: tcp/udp checksum has been computed
-    * VNET_BUFFER_F_L4_CHECKSUM_CORRECT: tcp/udp checksum is correct
-    * VNET_BUFFER_F_VLAN_2_DEEP: two vlan tags present
-    * VNET_BUFFER_F_VLAN_1_DEEP: one vlan tag present
-    * VNET_BUFFER_F_SPAN_CLONE: packet has already been cloned (span feature)
-    * VNET_BUFFER_F_LOOP_COUNTER_VALID: packet look-up loop count valid
-    * VNET_BUFFER_F_LOCALLY_ORIGINATED: packet built by vpp
-    * VNET_BUFFER_F_IS_IP4: packet is ipv4, for checksum offload
-    * VNET_BUFFER_F_IS_IP6: packet is ipv6, for checksum offload
-    * VNET_BUFFER_F_OFFLOAD_IP_CKSUM: hardware ip checksum offload requested
-    * VNET_BUFFER_F_OFFLOAD_TCP_CKSUM: hardware tcp checksum offload requested
-    * VNET_BUFFER_F_OFFLOAD_UDP_CKSUM: hardware udp checksum offload requested
-    * VNET_BUFFER_F_IS_NATED: natted packet, skip input checks
-    * VNET_BUFFER_F_L2_HDR_OFFSET_VALID: L2 header offset valid
-    * VNET_BUFFER_F_L3_HDR_OFFSET_VALID: L3 header offset valid
-    * VNET_BUFFER_F_L4_HDR_OFFSET_VALID: L4 header offset valid
-    * VNET_BUFFER_F_FLOW_REPORT: packet is an ipfix packet
-    * VNET_BUFFER_F_IS_DVR: packet to be reinjected into the l2 output path
-    * VNET_BUFFER_F_QOS_DATA_VALID: QoS data valid in vnet_buffer_opaque2
-    * VNET_BUFFER_F_GSO: generic segmentation offload requested
-    * VNET_BUFFER_F_AVAIL1: available bit
-    * VNET_BUFFER_F_AVAIL2: available bit
-    * VNET_BUFFER_F_AVAIL3: available bit
-    * VNET_BUFFER_F_AVAIL4: available bit
-    * VNET_BUFFER_F_AVAIL5: available bit
-    * VNET_BUFFER_F_AVAIL6: available bit
-    * VNET_BUFFER_F_AVAIL7: available bit
-* u32 flow_id: generic flow identifier
-* u8 ref_count: buffer reference / clone count (e.g. for span replication)
-* u8 buffer_pool_index: buffer pool index which owns this buffer
-* vlib_error_t (u16) error: error code for buffers enqueued to error handler
-* u32 next_buffer: buffer index of next buffer in chain. Only valid if VLIB_BUFFER_NEXT_PRESENT is set
-* union
-  * u32 current_config_index: current index on feature arc
-  * u32 punt_reason: reason code once packet punted. Mutually exclusive with current_config_index
-* u32 opaque[10]: primary vnet-layer opaque data (see below)
-* END of first cache line / data initialized by the buffer allocator
-* u32 trace_index: buffer's index in the packet trace subsystem
-* u32 total_length_not_including_first_buffer: see VLIB_BUFFER_TOTAL_LENGTH_VALID above
-* u32 opaque2[14]: secondary vnet-layer opaque data (see below)
-* u8 pre_data[VLIB_BUFFER_PRE_DATA_SIZE]: rewrite space, often used to prepend tunnel encapsulations
-* u8 data[0]: buffer data received from the wire. Ordinarily, hardware devices use b->data[0] as the DMA target but there are exceptions. Do not write code which blindly assumes that packet data starts in b->data[0]. Use vlib_buffer_get_current(...).
-
-Vnet (network stack) primary buffer metadata
---------------------------------------------
-
-Vnet primary buffer metadata occupies space reserved in the vlib
-opaque field shown above, and has the type name
-vnet_buffer_opaque_t. Ordinarily accessed using the vnet_buffer(b)
-macro. See ../src/vnet/buffer.h for full details.
-
-Important fields:
-
-* u32 sw_if_index[2]: RX and TX interface handles. At the ip lookup
-  stage, vnet_buffer(b)->sw_if_index[VLIB_TX] is interpreted as a FIB
-  index.
-* i16 l2_hdr_offset: offset from b->data[0] of the packet L2 header.
-  Valid only if b->flags & VNET_BUFFER_F_L2_HDR_OFFSET_VALID is set
-* i16 l3_hdr_offset: offset from b->data[0] of the packet L3 header.
-  Valid only if b->flags & VNET_BUFFER_F_L3_HDR_OFFSET_VALID is set
-* i16 l4_hdr_offset: offset from b->data[0] of the packet L4 header.
-  Valid only if b->flags & VNET_BUFFER_F_L4_HDR_OFFSET_VALID is set
-* u8 feature_arc_index: feature arc that the packet is currently traversing
-* union
-  * ip
-    * u32 adj_index[2]: adjacency from dest IP lookup in [VLIB_TX], adjacency
-      from source ip lookup in [VLIB_RX], set to ~0 until source lookup done
-    * union
-      * generic fields
-      * ICMP fields
-      * reassembly fields
-  * mpls fields
-  * l2 bridging fields, only valid in the L2 path
-  * l2tpv3 fields
-  * l2 classify fields
-  * vnet policer fields
-  * MAP fields
-  * MAP-T fields
-  * ip fragmentation fields
-  * COP (whitelist/blacklist filter) fields
-  * LISP fields
-  * TCP fields
-    * connection index
-    * sequence numbers
-    * header and data offsets
-    * data length
-    * flags
-  * SCTP fields
-  * NAT fields
-  * u32 unused[6]
-
-Vnet (network stack) secondary buffer metadata
------------------------------------------------
-
-Vnet primary buffer metadata occupies space reserved in the vlib
-opaque2 field shown above, and has the type name
-vnet_buffer_opaque2_t. Ordinarily accessed using the vnet_buffer2(b)
-macro. See ../src/vnet/buffer.h for full details.
-
-Important fields:
-
-* qos fields
-  * u8 bits
-  * u8 source
-* u8 loop_counter: used to detect and report internal forwarding loops
-* group-based policy fields
-  * u8 flags
-  * u16 sclass: the packet's source class
-* u16 gso_size: L4 payload size, persists all the way to
-  interface-output in case GSO is not enabled
-* u16 gso_l4_hdr_sz: size of the L4 protocol header
-* union
-  * packet trajectory tracer (largely deprecated)
-    * u16 *trajectory_trace; only #if VLIB_BUFFER_TRACE_TRAJECTORY > 0
-  * packet generator
-    * u64 pg_replay_timestamp: timestamp for replayed pcap trace packets
-  * u32 unused[8]
-
-Buffer Metadata Extensions
-==========================
-
-Plugin developers may wish to extend either the primary or secondary
-vnet buffer opaque unions. Please perform a
-manual live variable analysis, otherwise nodes which use shared buffer metadata space may break things.
-
-It's not OK to add plugin or proprietary metadata to the core vpp
-engine header files named above. Instead, proceed as follows. The
-example concerns the vnet primary buffer opaque union
-vlib_buffer_opaque_t. It's a very simple variation to use the vnet
-secondary buffer opaque union vlib_buffer_opaque2_t.
-
-In a plugin header file:
-
-```
-    /* Add arbitrary buffer metadata */
-    #include 
-
-    typedef struct
-    {
-      u32 my_stuff[6];
-    } my_buffer_opaque_t;
-
-    STATIC_ASSERT (sizeof (my_buffer_opaque_t) <=
-                   STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
-                   "Custom meta-data too large for vnet_buffer_opaque_t");
-
-    #define my_buffer_opaque(b)  \
-      ((my_buffer_opaque_t *)((u8 *)((b)->opaque) + STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))
-```
-To set data in the custom buffer opaque type given a vlib_buffer_t *b:
-
-```
-    my_buffer_opaque (b)->my_stuff[2] = 123;
-```
-
-To read data from the custom buffer opaque type:
-
-```
-    stuff0 = my_buffer_opaque (b)->my_stuff[2];
-```
diff --git a/docs/gettingstarted/developers/multiarch/arbfns.rst b/docs/gettingstarted/developers/multiarch/arbfns.rst
deleted file mode 100644
index d469bd8a140..00000000000
--- a/docs/gettingstarted/developers/multiarch/arbfns.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-Multi-Architecture Arbitrary Function Cookbook
-==============================================
-
-Optimizing arbitrary functions for multiple architectures is simple
-enough, and very similar to process used to produce multi-architecture
-graph node dispatch functions.
-
-As with multi-architecture graph nodes, we compile source files
-multiple times, generating multiple implementations of the original
-function, and a public selector function.
-
-Details
--------
-
-Decorate function definitions with CLIB_MARCH_FN macros. For example:
-
-Change the original function prototype...
-
-::
-
-   u32 vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
-                                 u32 frame_flags)
-
-...by recasting the function name and return type as the first two
-arguments to the CLIB_MARCH_FN macro:
-
-::
-
-    CLIB_MARCH_FN (vlib_frame_alloc_to_node, u32, vlib_main_t * vm,
-                   u32 to_node_index, u32 frame_flags)
-
-In the actual vpp image, several versions of vlib_frame_alloc_to_node
-will appear: vlib_frame_alloc_to_node_avx2,
-vlib_frame_alloc_to_node_avx512, and so forth.
-
-
-For each multi-architecture function, use the CLIB_MARCH_FN_SELECT
-macro to help generate the one-and-only multi-architecture selector
-function:
-
-::
-
-    #ifndef CLIB_MARCH_VARIANT
-    u32
-    vlib_frame_alloc_to_node (vlib_main_t * vm, u32 to_node_index,
-    			  u32 frame_flags)
-    {
-      return CLIB_MARCH_FN_SELECT (vlib_frame_alloc_to_node)
-        (vm, to_node_index, frame_flags);
-    }
-    #endif /* CLIB_MARCH_VARIANT */
-
-Once bound, the multi-architecture selector function is about as
-expensive as an indirect function call; which is to say: not very
-expensive.
-
-Modify CMakeLists.txt
----------------------
-
-If the component in question already lists "MULTIARCH_SOURCES", simply
-add the indicated .c file to the list.  Otherwise, add as shown
-below. Note that the added file "new_multiarch_node.c" should appear in
-*both* SOURCES and MULTIARCH_SOURCES:
-
-::
-
-    add_vpp_plugin(myplugin
-      SOURCES
-      multiarch_code.c
-      ...
-
-      MULTIARCH_SOURCES
-      multiarch_code.c
-      ...
-     )
-
-A Word to the Wise
-------------------
-
-A file which liberally mixes functions worth compiling for multiple
-architectures and functions which are not will end up full of
-#ifndef CLIB_MARCH_VARIANT conditionals. This won't do a thing to make
-the code look any better.
-
-Depending on requirements, it may make sense to move functions to
-(new) files to reduce complexity and/or improve legibility of the
-resulting code.
diff --git a/docs/gettingstarted/developers/multiarch/index.rst b/docs/gettingstarted/developers/multiarch/index.rst
deleted file mode 100644
index 824a8e68438..00000000000
--- a/docs/gettingstarted/developers/multiarch/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. _multiarch:
-
-Multi-architecture support
-==========================
-
-This reference guide describes how to use the vpp multi-architecture support scheme
-
-.. toctree::
-   :maxdepth: 1
-
-   nodefns
-   arbfns
diff --git a/docs/gettingstarted/developers/multiarch/nodefns.rst b/docs/gettingstarted/developers/multiarch/nodefns.rst
deleted file mode 100644
index a43d40e301f..00000000000
--- a/docs/gettingstarted/developers/multiarch/nodefns.rst
+++ /dev/null
@@ -1,138 +0,0 @@
-Multi-Architecture Graph Node Cookbook
-======================================
-
-In the context of graph node dispatch functions, it's easy enough to
-use the vpp multi-architecture support setup. The point of the scheme
-is simple: for performance-critical nodes, generate multiple CPU
-hardware-dependent versions of the node dispatch functions, and pick
-the best one at runtime.
-
-The vpp scheme is simple enough to use, but details matter.
-
-100,000 foot view
------------------
-
-We compile entire graph node dispatch function implementation files
-multiple times. These compilations give rise to multiple versions of
-the graph node dispatch functions. Per-node constructor-functions
-interrogate CPU hardware, select the node dispatch function variant to
-use, and set the vlib_node_registration_t ".function" member to the
-address of the selected variant.
-
-Details
--------
-
-Declare the node dispatch function as shown, using the VLIB\_NODE\_FN macro. The
-name of the node function **MUST** match the name of the graph node. 
-
-:: 
-
-    VLIB_NODE_FN (ip4_sdp_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
-                                 vlib_frame_t * frame)
-    {
-      if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE))
-        return ip46_sdp_inline (vm, node, frame, 1 /* is_ip4 */ ,
-    			    1 /* is_trace */ );
-      else
-        return ip46_sdp_inline (vm, node, frame, 1 /* is_ip4 */ ,
-    			    0 /* is_trace */ );
-    }   
-
-We need to generate *precisely one copy* of the
-vlib_node_registration_t, error strings, and packet trace decode function.
-
-Simply bracket these items with "#ifndef CLIB_MARCH_VARIANT...#endif":
-
-::
-
-    #ifndef CLIB_MARCH_VARIANT
-    static u8 *
-    format_sdp_trace (u8 * s, va_list * args)
-    {
-       
-    }
-    #endif
-
-    ...
-
-    #ifndef CLIB_MARCH_VARIANT
-    static char *sdp_error_strings[] = {
-    #define _(sym,string) string,
-      foreach_sdp_error
-    #undef _
-    };
-    #endif
-
-    ...
-
-    #ifndef CLIB_MARCH_VARIANT
-    VLIB_REGISTER_NODE (ip4_sdp_node) =
-    {
-      // DO NOT set the .function structure member.
-      // The multiarch selection __attribute__((constructor)) function
-      // takes care of it at runtime
-      .name = "ip4-sdp",
-      .vector_size = sizeof (u32),
-      .format_trace = format_sdp_trace,
-      .type = VLIB_NODE_TYPE_INTERNAL,
-
-      .n_errors = ARRAY_LEN(sdp_error_strings),
-      .error_strings = sdp_error_strings,
-
-      .n_next_nodes = SDP_N_NEXT,
-
-      /* edit / add dispositions here */
-      .next_nodes =
-      {
-        [SDP_NEXT_DROP] = "ip4-drop",
-      },
-    };
-    #endif
-
-To belabor the point: *do not* set the ".function" member! That's the job of the multi-arch
-selection \_\_attribute\_\_((constructor)) function
-
-Always inline node dispatch functions
--------------------------------------
-
-It's typical for a graph dispatch function to contain one or more
-calls to an inline function. See above. If your node dispatch function
-is structured that way, make *ABSOLUTELY CERTAIN* to use the
-"always_inline" macro:
-
-::
-
-    always_inline uword
-    ip46_sdp_inline (vlib_main_t * vm, vlib_node_runtime_t * node, 
-                 vlib_frame_t * frame,
-    		 int is_ip4, int is_trace)
-    { ... }
-
-Otherwise, the compiler is highly likely NOT to build multiple
-versions of the guts of your dispatch function. 
-
-It's fairly easy to spot this mistake in "perf top." If you see, for
-example, a bunch of functions with names of the form
-"xxx_node_fn_avx2" in the profile, *BUT* your brand-new node function
-shows up with a name of the form "xxx_inline.isra.1", it's quite likely
-that the inline was declared "static inline" instead of "always_inline".
-
-Modify CMakeLists.txt
----------------------
-
-If the component in question already lists "MULTIARCH_SOURCES", simply
-add the indicated .c file to the list.  Otherwise, add as shown
-below. Note that the added file "new_multiarch_node.c" should appear in
-*both* SOURCES and MULTIARCH_SOURCES:
-
-::
-
-    add_vpp_plugin(myplugin
-      SOURCES
-      new_multiarch_node.c
-      ...  
-
-      MULTIARCH_SOURCES
-      new_ multiarch_node.c
-      ...
-     )
diff --git a/docs/gettingstarted/developers/plugins.rst b/docs/gettingstarted/developers/plugins.rst
deleted file mode 100644
index 09db1d3459f..00000000000
--- a/docs/gettingstarted/developers/plugins.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-.. _dplugins:
-
-Plugins
-=======
-
-vlib implements a straightforward plug-in DLL mechanism. VLIB client
-applications specify a directory to search for plug-in .DLLs, and a name
-filter to apply (if desired). VLIB needs to load plug-ins very early.
-
-Once loaded, the plug-in DLL mechanism uses dlsym to find and verify a
-vlib\_plugin\_registration data structure in the newly-loaded plug-in.
-
-For more on plugins please refer to :ref:`add_plugin`.
diff --git a/docs/gettingstarted/developers/punt.rst b/docs/gettingstarted/developers/punt.rst
deleted file mode 120000
index 0a56632f671..00000000000
--- a/docs/gettingstarted/developers/punt.rst
+++ /dev/null
@@ -1 +0,0 @@
-../../../src/vnet/ip/punt.rst
\ No newline at end of file
diff --git a/docs/gettingstarted/developers/quic_plugin.rst b/docs/gettingstarted/developers/quic_plugin.rst
deleted file mode 120000
index ffe53429571..00000000000
--- a/docs/gettingstarted/developers/quic_plugin.rst
+++ /dev/null
@@ -1 +0,0 @@
-../../../src/plugins/quic/quic_plugin.rst
\ No newline at end of file
diff --git a/docs/gettingstarted/developers/running_vpp.rst b/docs/gettingstarted/developers/running_vpp.rst
deleted file mode 100644
index 9b33e53ec60..00000000000
--- a/docs/gettingstarted/developers/running_vpp.rst
+++ /dev/null
@@ -1,48 +0,0 @@
-.. _running_vpp:
-
-.. toctree::
-
-Running VPP
-===========
-
-After building the VPP binaries, you now have several images built.
-These images are useful when you need to run VPP without installing the packages.
-For instance if you want to run VPP with GDB.
-
-Running Without GDB
-_________________________
-
-To run the VPP images that you've built without GDB, run the following commands:
-
-Running the release image:
-
-.. code-block:: console
-
-   # make run-release
-   #
-
-Running the debug image:
-
-.. code-block:: console
-
-   # make run
-   #
-
-Running With GDB
-_________________________
-
-With the following commands you can run VPP and then be dropped into the GDB prompt.
-
-Running the release image:
-
-.. code-block:: console
-
-   # make debug-release
-   (gdb)
-
-Running the debug image:
-
-.. code-block:: console
-
-   # make debug
-   (gdb)
diff --git a/docs/gettingstarted/developers/softwarearchitecture.md b/docs/gettingstarted/developers/softwarearchitecture.md
deleted file mode 100644
index a663134cd46..00000000000
--- a/docs/gettingstarted/developers/softwarearchitecture.md
+++ /dev/null
@@ -1,44 +0,0 @@
-Software Architecture
-=====================
-
-The fd.io vpp implementation is a third-generation vector packet
-processing implementation specifically related to US Patent 7,961,636,
-as well as earlier work. Note that the Apache-2 license specifically
-grants non-exclusive patent licenses; we mention this patent as a point
-of historical interest.
-
-For performance, the vpp dataplane consists of a directed graph of
-forwarding nodes which process multiple packets per invocation. This
-schema enables a variety of micro-processor optimizations: pipelining
-and prefetching to cover dependent read latency, inherent I-cache phase
-behavior, vector instructions. Aside from hardware input and hardware
-output nodes, the entire forwarding graph is portable code.
-
-Depending on the scenario at hand, we often spin up multiple worker
-threads which process ingress-hashes packets from multiple queues using
-identical forwarding graph replicas.
-
-VPP Layers - Implementation Taxonomy
-------------------------------------
-
-![image](/_images/VPP_Layering.png)
-
--   VPP Infra - the VPP infrastructure layer, which contains the core
-    library source code. This layer performs memory functions, works
-    with vectors and rings, performs key lookups in hash tables, and
-    works with timers for dispatching graph nodes.
--   VLIB - the vector processing library. The vlib layer also handles
-    various application management functions: buffer, memory and graph
-    node management, maintaining and exporting counters, thread
-    management, packet tracing. Vlib implements the debug CLI (command
-    line interface).
--   VNET - works with VPP\'s networking interface (layers 2, 3, and 4)
-    performs session and traffic management, and works with devices and
-    the data control plane.
--   Plugins - Contains an increasingly rich set of data-plane plugins,
-    as noted in the above diagram.
--   VPP - the container application linked against all of the above.
-
-It's important to understand each of these layers in a certain amount of
-detail. Much of the implementation is best dealt with at the API level
-and otherwise left alone.
diff --git a/docs/gettingstarted/developers/testing_vpp.md b/docs/gettingstarted/developers/testing_vpp.md
deleted file mode 100644
index 4e4ca1aa30a..00000000000
--- a/docs/gettingstarted/developers/testing_vpp.md
+++ /dev/null
@@ -1,141 +0,0 @@
-Testing VPP
-===========
-
-As of this writing, the vpp source tree includes over 1,000 unit test
-vectors. Best practices prior to pushing patches for code review: make
-sure that all of the "make test" test vectors pass.
-
-We attempt to maintain the top-level "make test-help" command so that it
-accurately describes all of the "make test" options.
-
-Examples
---------
-
-Basic test run, all test vectors, single-vpp instance, optimized image:
-
-```
-  $ make test
-```
-
-10-way parallel basic test run:
-
-```
-  $ make TEST_JOBS=10 test
-```
-
-Run a specific test suite (mpls, in this case):
-
-```
-  $ make TEST=test_mpls test
-```
-
-Run a specifc test suite, debug image, pause prior to running the test
-suite; attach to the vpp image in gdb:
-
-```
-  $ make TEST=xxx DEBUG=gdb test-debug
-```
-
-Detailed Documentation
-----------------------
-
-Current "make test-help" output:
-
-
-```
-  $ make test-help
-   test                   - build and run (basic) functional tests
-   test-debug             - build and run (basic) functional tests (debug build)
-   test-all               - build and run functional and extended tests
-   test-all-debug         - build and run functional and extended tests (debug build)
-   retest                 - run functional tests
-   retest-debug           - run functional tests (debug build)
-   retest-all             - run functional and extended tests
-   retest-all-debug       - run functional and extended tests (debug build)
-   test-cov               - generate code coverage report for test framework
-   test-gcov                      - build and run functional tests (gcov build)
-   test-wipe              - wipe (temporary) files generated by unit tests
-   test-wipe-cov          - wipe code coverage report for test framework
-   test-wipe-doc          - wipe documentation for test framework
-   test-wipe-papi         - rebuild vpp_papi sources
-   test-wipe-all          - wipe (temporary) files generated by unit tests, docs, and coverage
-   test-shell             - enter shell with test environment
-   test-shell-debug       - enter shell with test environment (debug build)
-   test-checkstyle        - check PEP8 compliance for test framework
-   test-refresh-deps      - refresh the Python dependencies for the tests
-
-  Arguments controlling test runs:
-   V=[0|1|2]              - set test verbosity level
-                            0=ERROR, 1=INFO, 2=DEBUG
-   TEST_JOBS=[|auto]   - use at most  parallel python processes for test execution, if auto, set to number of available cpus (default: 1)
-   MAX_VPP_CPUS=[|auto]- use at most  cpus for running vpp main and worker threads, if auto, set to number of available cpus (default: auto)
-   CACHE_OUTPUT=[0|1]     - cache VPP stdout/stderr and log as one block after test finishes (default: 1)
-   FAILFAST=[0|1]         - fail fast if 1, complete all tests if 0
-   TIMEOUT=      - fail test suite if any single test takes longer than  (in seconds) to finish (default: 600)
-   RETRIES=            - retry failed tests  times
-   DEBUG=           - set VPP debugging kind
-      DEBUG=core          - detect coredump and load it in gdb on crash
-      DEBUG=gdb           - allow easy debugging by printing VPP PID
-                            and waiting for user input before running
-                            and tearing down a testcase
-      DEBUG=gdbserver     - run gdb inside a gdb server, otherwise
-                            same as above
-      DEBUG=attach        - attach test case to already running vpp in gdb (see test-start-vpp-in-gdb)
-
-   STEP=[yes|no]          - ease debugging by stepping through a testcase
-   SANITY=[yes|no]        - perform sanity import of vpp-api/sanity vpp run before running tests (default: yes)
-   EXTENDED_TESTS=[1|y]   - used by '[re]test-all' & '[re]test-all-debug' to run extended tests
-   TEST=          - filter the set of tests:
-      by file-name        - only run tests from specified file, e.g. TEST=test_bfd selects all tests from test_bfd.py
-      by file-suffix      - same as file-name, but 'test_' is omitted e.g. TEST=bfd selects all tests from test_bfd.py
-      by wildcard         - wildcard filter is .., each can be replaced by '*'
-                            e.g. TEST='test_bfd.*.*' is equivalent to above example of filter by file-name
-                                 TEST='bfd.*.*' is equivalent to above example of filter by file-suffix
-                                 TEST='bfd.BFDAPITestCase.*' selects all tests from test_bfd.py which are part of BFDAPITestCase class
-                                 TEST='bfd.BFDAPITestCase.test_add_bfd' selects a single test named test_add_bfd from test_bfd.py/BFDAPITestCase
-                                 TEST='*.*.test_add_bfd' selects all test functions named test_add_bfd from all files/classes
-
-   VARIANT=      - specify which march node variant to unit test
-                            e.g. VARIANT=skx test the skx march variants
-                            e.g. VARIANT=icl test the icl march variants
-
-   COREDUMP_SIZE=   - pass  as unix { coredump-size  } argument to vpp
-                            e.g. COREDUMP_SIZE=4g
-                                 COREDUMP_SIZE=unlimited
-   COREDUMP_COMPRESS=1    - compress core files if not debugging them
-   EXTERN_TESTS=    - path to out-of-tree test_.py files containing test cases
-   EXTERN_PLUGINS=  - path to out-of-tree plugins to be loaded by vpp under test
-   EXTERN_COV_DIR=  - path to out-of-tree prefix, where source, object and .gcda files can be found for coverage report
-
-   PROFILE=1              - enable profiling of test framework via cProfile module
-   PROFILE_SORT_BY=opt    - sort profiling report by opt - consult cProfile documentation for possible values (default: cumtime)
-   PROFILE_OUTPUT=file    - output profiling info to file - use absolute path (default: stdout)
-
-   TEST_DEBUG=1           - turn on debugging of the test framework itself (expert)
-
-   SKIP_AARCH64=1         - skip tests that are failing on the ARM platorm in FD.io CI
-
-   RND_SEED=seed          - Seed RND with given seed
-
-  Starting VPP in GDB for use with DEBUG=attach:
-
-   test-start-vpp-in-gdb       - start VPP in gdb (release)
-   test-start-vpp-debug-in-gdb - start VPP in gdb (debug)
-
-  Arguments controlling VPP in GDB runs:
-
-   VPP_IN_GDB_TMP_DIR     - specify directory to run VPP IN (default: /tmp/unittest-attach-gdb)
-   VPP_IN_GDB_NO_RMDIR=0  - don't remove existing tmp dir but fail instead
-   VPP_IN_GDB_CMDLINE=1   - add 'interactive' to VPP arguments to run with command line
-
-  Creating test documentation
-   test-doc               - generate documentation for test framework
-   test-wipe-doc          - wipe documentation for test framework
-
-  Creating test code coverage report
-   test-cov               - generate code coverage report for test framework
-   test-wipe-cov          - wipe code coverage report for test framework
-
-  Verifying code-style
-   test-checkstyle        - check PEP8 compliance
-```
diff --git a/docs/gettingstarted/developers/vlib.md b/docs/gettingstarted/developers/vlib.md
deleted file mode 100644
index 3a35978136c..00000000000
--- a/docs/gettingstarted/developers/vlib.md
+++ /dev/null
@@ -1,891 +0,0 @@
-
-VLIB (Vector Processing Library)
-================================
-
-The files associated with vlib are located in the ./src/{vlib,
-vlibapi, vlibmemory} folders. These libraries provide vector
-processing support including graph-node scheduling, reliable multicast
-support, ultra-lightweight cooperative multi-tasking threads, a CLI,
-plug in .DLL support, physical memory and Linux epoll support. Parts of
-this library embody US Patent 7,961,636.
-
-Init function discovery
------------------------
-
-vlib applications register for various \[initialization\] events by
-placing structures and \_\_attribute\_\_((constructor)) functions into
-the image. At appropriate times, the vlib framework walks
-constructor-generated singly-linked structure lists, performs a
-topological sort based on specified constraints, and calls the
-indicated functions. Vlib applications create graph nodes, add CLI
-functions, start cooperative multi-tasking threads, etc. etc. using
-this mechanism.
-
-vlib applications invariably include a number of VLIB\_INIT\_FUNCTION
-(my\_init\_function) macros.
-
-Each init / configure / etc. function has the return type clib\_error\_t
-\*. Make sure that the function returns 0 if all is well, otherwise the
-framework will announce an error and exit.
-
-vlib applications must link against vppinfra, and often link against
-other libraries such as VNET. In the latter case, it may be necessary to
-explicitly reference symbol(s) otherwise large portions of the library
-may be AWOL at runtime.
-
-### Init function construction and constraint specification
-
-It's easy to add an init function:
-
-```
-   static clib_error_t *my_init_function (vlib_main_t *vm)
-   {
-      /* ... initialize things ... */
-
-      return 0; // or return clib_error_return (0, "BROKEN!");
-   }
-   VLIB_INIT_FUNCTION(my_init_function);
-```
-
-As given, my_init_function will be executed "at some point," but with
-no ordering guarantees.
-
-Specifying ordering constraints is easy:
-
-```
-   VLIB_INIT_FUNCTION(my_init_function) =
-   {
-      .runs_before = VLIB_INITS("we_run_before_function_1",
-                                "we_run_before_function_2"),
-      .runs_after = VLIB_INITS("we_run_after_function_1",
-                               "we_run_after_function_2),
-    };
-```
-
-It's also easy to specify bulk ordering constraints of the form "a
-then b then c then d":
-
-```
-   VLIB_INIT_FUNCTION(my_init_function) =
-   {
-      .init_order = VLIB_INITS("a", "b", "c", "d"),
-   };
-```
-
-It's OK to specify all three sorts of ordering constraints for a
-single init function, although it's hard to imagine why it would be
-necessary.
-
-
-Node Graph Initialization
--------------------------
-
-vlib packet-processing applications invariably define a set of graph
-nodes to process packets.
-
-One constructs a vlib\_node\_registration\_t, most often via the
-VLIB\_REGISTER\_NODE macro. At runtime, the framework processes the set
-of such registrations into a directed graph. It is easy enough to add
-nodes to the graph at runtime. The framework does not support removing
-nodes.
-
-vlib provides several types of vector-processing graph nodes, primarily
-to control framework dispatch behaviors. The type member of the
-vlib\_node\_registration\_t functions as follows:
-
--   VLIB\_NODE\_TYPE\_PRE\_INPUT - run before all other node types
--   VLIB\_NODE\_TYPE\_INPUT - run as often as possible, after pre\_input
-    nodes
--   VLIB\_NODE\_TYPE\_INTERNAL - only when explicitly made runnable by
-    adding pending frames for processing
--   VLIB\_NODE\_TYPE\_PROCESS - only when explicitly made runnable.
-    "Process" nodes are actually cooperative multi-tasking threads. They
-    **must** explicitly suspend after a reasonably short period of time.
-
-For a precise understanding of the graph node dispatcher, please read
-./src/vlib/main.c:vlib\_main\_loop.
-
-Graph node dispatcher
----------------------
-
-Vlib\_main\_loop() dispatches graph nodes. The basic vector processing
-algorithm is diabolically simple, but may not be obvious from even a
-long stare at the code. Here's how it works: some input node, or set of
-input nodes, produce a vector of work to process. The graph node
-dispatcher pushes the work vector through the directed graph,
-subdividing it as needed, until the original work vector has been
-completely processed. At that point, the process recurs.
-
-This scheme yields a stable equilibrium in frame size, by construction.
-Here's why: as the frame size increases, the per-frame-element
-processing time decreases. There are several related forces at work; the
-simplest to describe is the effect of vector processing on the CPU L1
-I-cache. The first frame element \[packet\] processed by a given node
-warms up the node dispatch function in the L1 I-cache. All subsequent
-frame elements profit. As we increase the number of frame elements, the
-cost per element goes down.
-
-Under light load, it is a crazy waste of CPU cycles to run the graph
-node dispatcher flat-out. So, the graph node dispatcher arranges to wait
-for work by sitting in a timed epoll wait if the prevailing frame size
-is low. The scheme has a certain amount of hysteresis to avoid
-constantly toggling back and forth between interrupt and polling mode.
-Although the graph dispatcher supports interrupt and polling modes, our
-current default device drivers do not.
-
-The graph node scheduler uses a hierarchical timer wheel to reschedule
-process nodes upon timer expiration.
-
-Graph dispatcher internals
---------------------------
-
-This section may be safely skipped. It's not necessary to understand
-graph dispatcher internals to create graph nodes.
-
-Vector Data Structure
----------------------
-
-In vpp / vlib, we represent vectors as instances of the vlib_frame_t type:
-
-```c
-    typedef struct vlib_frame_t
-    {
-      /* Frame flags. */
-      u16 flags;
-
-      /* Number of scalar bytes in arguments. */
-      u8 scalar_size;
-
-      /* Number of bytes per vector argument. */
-      u8 vector_size;
-
-      /* Number of vector elements currently in frame. */
-      u16 n_vectors;
-
-      /* Scalar and vector arguments to next node. */
-      u8 arguments[0];
-    } vlib_frame_t;
-```
-
-Note that one _could_ construct all kinds of vectors - including
-vectors with some associated scalar data - using this structure. In
-the vpp application, vectors typically use a 4-byte vector element
-size, and zero bytes' worth of associated per-frame scalar data.
-
-Frames are always allocated on CLIB_CACHE_LINE_BYTES boundaries.
-Frames have u32 indices which make use of the alignment property, so
-the maximum feasible main heap offset of a frame is
-CLIB_CACHE_LINE_BYTES * 0xFFFFFFFF: 64*4 = 256 Gbytes.
-
-Scheduling Vectors
-------------------
-
-As you can see, vectors are not directly associated with graph
-nodes. We represent that association in a couple of ways.  The
-simplest is the vlib\_pending\_frame\_t:
-
-```c
-    /* A frame pending dispatch by main loop. */
-    typedef struct
-    {
-      /* Node and runtime for this frame. */
-      u32 node_runtime_index;
-
-      /* Frame index (in the heap). */
-      u32 frame_index;
-
-      /* Start of next frames for this node. */
-      u32 next_frame_index;
-
-      /* Special value for next_frame_index when there is no next frame. */
-    #define VLIB_PENDING_FRAME_NO_NEXT_FRAME ((u32) ~0)
-    } vlib_pending_frame_t;
-```
-
-Here is the code in .../src/vlib/main.c:vlib_main_or_worker_loop()
-which processes frames:
-
-```c
-      /*
-       * Input nodes may have added work to the pending vector.
-       * Process pending vector until there is nothing left.
-       * All pending vectors will be processed from input -> output.
-       */
-      for (i = 0; i < _vec_len (nm->pending_frames); i++)
-	cpu_time_now = dispatch_pending_node (vm, i, cpu_time_now);
-      /* Reset pending vector for next iteration. */
-```
-
-The pending frame node_runtime_index associates the frame with the
-node which will process it.
-
-Complications
--------------
-
-Fasten your seatbelt. Here's where the story - and the data structures
-\- become quite complicated...
-
-At 100,000 feet: vpp uses a directed graph, not a directed _acyclic_
-graph. It's really quite normal for a packet to visit ip\[46\]-lookup
-multiple times. The worst-case: a graph node which enqueues packets to
-itself.
-
-To deal with this issue, the graph dispatcher must force allocation of
-a new frame if the current graph node's dispatch function happens to
-enqueue a packet back to itself.
-
-There are no guarantees that a pending frame will be processed
-immediately, which means that more packets may be added to the
-underlying vlib_frame_t after it has been attached to a
-vlib_pending_frame_t. Care must be taken to allocate new
-frames and pending frames if a (pending\_frame, frame) pair fills.
-
-Next frames, next frame ownership
----------------------------------
-
-The vlib\_next\_frame\_t is the last key graph dispatcher data structure:
-
-```c
-    typedef struct
-    {
-      /* Frame index. */
-      u32 frame_index;
-
-      /* Node runtime for this next. */
-      u32 node_runtime_index;
-
-      /* Next frame flags. */
-      u32 flags;
-
-      /* Reflects node frame-used flag for this next. */
-    #define VLIB_FRAME_NO_FREE_AFTER_DISPATCH \
-      VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH
-
-      /* This next frame owns enqueue to node
-         corresponding to node_runtime_index. */
-    #define VLIB_FRAME_OWNER (1 << 15)
-
-      /* Set when frame has been allocated for this next. */
-    #define VLIB_FRAME_IS_ALLOCATED	VLIB_NODE_FLAG_IS_OUTPUT
-
-      /* Set when frame has been added to pending vector. */
-    #define VLIB_FRAME_PENDING VLIB_NODE_FLAG_IS_DROP
-
-      /* Set when frame is to be freed after dispatch. */
-    #define VLIB_FRAME_FREE_AFTER_DISPATCH VLIB_NODE_FLAG_IS_PUNT
-
-      /* Set when frame has traced packets. */
-    #define VLIB_FRAME_TRACE VLIB_NODE_FLAG_TRACE
-
-      /* Number of vectors enqueue to this next since last overflow. */
-      u32 vectors_since_last_overflow;
-    } vlib_next_frame_t;
-```
-
-Graph node dispatch functions call vlib\_get\_next\_frame (...)  to
-set "(u32 \*)to_next" to the right place in the vlib_frame_t
-corresponding to the ith arc (aka next0) from the current node to the
-indicated next node.
-
-After some scuffling around - two levels of macros - processing
-reaches vlib\_get\_next\_frame_internal (...). Get-next-frame-internal
-digs up the vlib\_next\_frame\_t corresponding to the desired graph
-arc.
-
-The next frame data structure amounts to a graph-arc-centric frame
-cache. Once a node finishes adding element to a frame, it will acquire
-a vlib_pending_frame_t and end up on the graph dispatcher's
-run-queue. But there's no guarantee that more vector elements won't be
-added to the underlying frame from the same (source\_node,
-next\_index) arc or from a different (source\_node, next\_index) arc.
-
-Maintaining consistency of the arc-to-frame cache is necessary. The
-first step in maintaining consistency is to make sure that only one
-graph node at a time thinks it "owns" the target vlib\_frame\_t.
-
-Back to the graph node dispatch function. In the usual case, a certain
-number of packets will be added to the vlib\_frame\_t acquired by
-calling vlib\_get\_next\_frame (...).
-
-Before a dispatch function returns, it's required to call
-vlib\_put\_next\_frame (...) for all of the graph arcs it actually
-used.  This action adds a vlib\_pending\_frame\_t to the graph
-dispatcher's pending frame vector.
-
-Vlib\_put\_next\_frame makes a note in the pending frame of the frame
-index, and also of the vlib\_next\_frame\_t index.
-
-dispatch\_pending\_node actions
--------------------------------
-
-The main graph dispatch loop calls dispatch pending node as shown
-above.
-
-Dispatch\_pending\_node recovers the pending frame, and the graph node
-runtime / dispatch function. Further, it recovers the next\_frame
-currently associated with the vlib\_frame\_t, and detaches the
-vlib\_frame\_t from the next\_frame.
-
-In .../src/vlib/main.c:dispatch\_pending\_node(...), note this stanza:
-
-```c
-  /* Force allocation of new frame while current frame is being
-     dispatched. */
-  restore_frame_index = ~0;
-  if (nf->frame_index == p->frame_index)
-    {
-      nf->frame_index = ~0;
-      nf->flags &= ~VLIB_FRAME_IS_ALLOCATED;
-      if (!(n->flags & VLIB_NODE_FLAG_FRAME_NO_FREE_AFTER_DISPATCH))
-	restore_frame_index = p->frame_index;
-    }
-```
-
-dispatch\_pending\_node is worth a hard stare due to the several
-second-order optimizations it implements. Almost as an afterthought,
-it calls dispatch_node which actually calls the graph node dispatch
-function.
-
-Process / thread model
-----------------------
-
-vlib provides an ultra-lightweight cooperative multi-tasking thread
-model. The graph node scheduler invokes these processes in much the same
-way as traditional vector-processing run-to-completion graph nodes;
-plus-or-minus a setjmp/longjmp pair required to switch stacks. Simply
-set the vlib\_node\_registration\_t type field to
-vlib\_NODE\_TYPE\_PROCESS. Yes, process is a misnomer. These are
-cooperative multi-tasking threads.
-
-As of this writing, the default stack size is 2<<15 = 32kb.
-Initialize the node registration's process\_log2\_n\_stack\_bytes member
-as needed. The graph node dispatcher makes some effort to detect stack
-overrun, e.g. by mapping a no-access page below each thread stack.
-
-Process node dispatch functions are expected to be "while(1) { }" loops
-which suspend when not otherwise occupied, and which must not run for
-unreasonably long periods of time.
-
-"Unreasonably long" is an application-dependent concept. Over the years,
-we have constructed frame-size sensitive control-plane nodes which will
-use a much higher fraction of the available CPU bandwidth when the frame
-size is low. The classic example: modifying forwarding tables. So long
-as the table-builder leaves the forwarding tables in a valid state, one
-can suspend the table builder to avoid dropping packets as a result of
-control-plane activity.
-
-Process nodes can suspend for fixed amounts of time, or until another
-entity signals an event, or both. See the next section for a description
-of the vlib process event mechanism.
-
-When running in vlib process context, one must pay strict attention to
-loop invariant issues. If one walks a data structure and calls a
-function which may suspend, one had best know by construction that it
-cannot change. Often, it's best to simply make a snapshot copy of a data
-structure, walk the copy at leisure, then free the copy.
-
-Process events
---------------
-
-The vlib process event mechanism API is extremely lightweight and easy
-to use. Here is a typical example:
-
-```c
-    vlib_main_t *vm = &vlib_global_main;
-    uword event_type, * event_data = 0;
-
-    while (1)
-    {
-       vlib_process_wait_for_event_or_clock (vm, 5.0 /* seconds */);
-
-       event_type = vlib_process_get_events (vm, &event_data);
-
-       switch (event_type) {
-       case EVENT1:
-           handle_event1s (event_data);
-           break;
-
-       case EVENT2:
-           handle_event2s (event_data);
-           break;
-
-       case ~0: /* 5-second idle/periodic */
-           handle_idle ();
-           break;
-
-       default: /* bug! */
-           ASSERT (0);
-       }
-
-       vec_reset_length(event_data);
-    }
-```
-
-In this example, the VLIB process node waits for an event to occur, or
-for 5 seconds to elapse. The code demuxes on the event type, calling
-the appropriate handler function. Each call to
-vlib\_process\_get\_events returns a vector of per-event-type data
-passed to successive vlib\_process\_signal\_event calls; it is a
-serious error to process only event\_data\[0\].
-
-Resetting the event\_data vector-length to 0 \[instead of calling
-vec\_free\] means that the event scheme doesn't burn cycles continuously
-allocating and freeing the event data vector. This is a common vppinfra
-/ vlib coding pattern, well worth using when appropriate.
-
-Signaling an event is easy, for example:
-
-```c
-    vlib_process_signal_event (vm, process_node_index, EVENT1,
-        (uword)arbitrary_event1_data); /* and so forth */
-```
-
-One can either know the process node index by construction - dig it out
-of the appropriate vlib\_node\_registration\_t - or by finding the
-vlib\_node\_t with vlib\_get\_node\_by\_name(...).
-
-Buffers
--------
-
-vlib buffering solves the usual set of packet-processing problems,
-albeit at high performance. Key in terms of performance: one ordinarily
-allocates / frees N buffers at a time rather than one at a time. Except
-when operating directly on a specific buffer, one deals with buffers by
-index, not by pointer.
-
-Packet-processing frames are u32\[\] arrays, not
-vlib\_buffer\_t\[\] arrays.
-
-Packets comprise one or more vlib buffers, chained together as required.
-Multiple particle sizes are supported; hardware input nodes simply ask
-for the required size(s). Coalescing support is available. For obvious
-reasons one is discouraged from writing one's own wild and wacky buffer
-chain traversal code.
-
-vlib buffer headers are allocated immediately prior to the buffer data
-area. In typical packet processing this saves a dependent read wait:
-given a buffer's address, one can prefetch the buffer header
-\[metadata\] at the same time as the first cache line of buffer data.
-
-Buffer header metadata (vlib\_buffer\_t) includes the usual rewrite
-expansion space, a current\_data offset, RX and TX interface indices,
-packet trace information, and a opaque areas.
-
-The opaque data is intended to control packet processing in arbitrary
-subgraph-dependent ways. The programmer shoulders responsibility for
-data lifetime analysis, type-checking, etc.
-
-Buffers have reference-counts in support of e.g. multicast replication.
-
-Shared-memory message API
--------------------------
-
-Local control-plane and application processes interact with the vpp
-dataplane via asynchronous message-passing in shared memory over
-unidirectional queues. The same application APIs are available via
-sockets.
-
-Capturing API traces and replaying them in a simulation environment
-requires a disciplined approach to the problem. This seems like a
-make-work task, but it is not. When something goes wrong in the
-control-plane after 300,000 or 3,000,000 operations, high-speed replay
-of the events leading up to the accident is a huge win.
-
-The shared-memory message API message allocator vl\_api\_msg\_alloc uses
-a particularly cute trick. Since messages are processed in order, we try
-to allocate message buffering from a set of fixed-size, preallocated
-rings. Each ring item has a "busy" bit. Freeing one of the preallocated
-message buffers merely requires the message consumer to clear the busy
-bit. No locking required.
-
-Debug CLI
----------
-
-Adding debug CLI commands to VLIB applications is very simple.
-
-Here is a complete example:
-
-```c
-    static clib_error_t *
-    show_ip_tuple_match (vlib_main_t * vm,
-                         unformat_input_t * input,
-                         vlib_cli_command_t * cmd)
-    {
-        vlib_cli_output (vm, "%U\n", format_ip_tuple_match_tables, &routing_main);
-        return 0;
-    }
-
-    /* *INDENT-OFF* */
-    static VLIB_CLI_COMMAND (show_ip_tuple_command) =
-    {
-        .path = "show ip tuple match",
-        .short_help = "Show ip 5-tuple match-and-broadcast tables",
-        .function = show_ip_tuple_match,
-    };
-    /* *INDENT-ON* */
-```
-
-This example implements the "show ip tuple match" debug cli
-command. In ordinary usage, the vlib cli is available via the "vppctl"
-application, which sends traffic to a named pipe. One can configure
-debug CLI telnet access on a configurable port.
-
-The cli implementation has an output redirection facility which makes it
-simple to deliver cli output via shared-memory API messaging,
-
-Particularly for debug or "show tech support" type commands, it would be
-wasteful to write vlib application code to pack binary data, write more
-code elsewhere to unpack the data and finally print the answer. If a
-certain cli command has the potential to hurt packet processing
-performance by running for too long, do the work incrementally in a
-process node. The client can wait.
-
-### Macro expansion
-
-The vpp debug CLI engine includes a recursive macro expander. This
-is quite useful for factoring out address and/or interface name
-specifics:
-
-```
-   define ip1 192.168.1.1/24
-   define ip2 192.168.2.1/24
-   define iface1 GigabitEthernet3/0/0
-   define iface2 loop1
-
-   set int ip address $iface1 $ip1
-   set int ip address $iface2 $(ip2)
-
-   undefine ip1
-   undefine ip2
-   undefine iface1
-   undefine iface2
-```
-
-Each socket (or telnet) debug CLI session has its own macro
-tables. All debug CLI sessions which use CLI_INBAND binary API
-messages share a single table.
-
-The macro expander recognizes circular defintions:
-
-```
-    define foo \$(bar)
-    define bar \$(mumble)
-    define mumble \$(foo)
-```
-
-At 8 levels of recursion, the macro expander throws up its hands and
-replies "CIRCULAR."
-
-### Macro-related debug CLI commands
-
-In addition to the "define" and "undefine" debug CLI commands, use
-"show macro [noevaluate]" to dump the macro table. The "echo" debug
-CLI command will evaluate and print its argument:
-
-```
-    vpp# define foo This\ Is\ Foo
-    vpp# echo $foo
-    This Is Foo
-```
-
-Handing off buffers between threads
------------------------------------
-
-Vlib includes an easy-to-use mechanism for handing off buffers between
-worker threads. A typical use-case: software ingress flow hashing. At
-a high level, one creates a per-worker-thread queue which sends packets
-to a specific graph node in the indicated worker thread. With the
-queue in hand, enqueue packets to the worker thread of your choice.
-
-### Initialize a handoff queue
-
-Simple enough, call vlib_frame_queue_main_init:
-
-```c
-   main_ptr->frame_queue_index
-       = vlib_frame_queue_main_init (dest_node.index, frame_queue_size);
-```
-
-Frame_queue_size means what it says: the number of frames which may be
-queued. Since frames contain 1...256 packets, frame_queue_size should
-be a reasonably small number (32...64). If the frame queue producer(s)
-are faster than the frame queue consumer(s), congestion will
-occur. Suggest letting the enqueue operator deal with queue
-congestion, as shown in the enqueue example below.
-
-Under the floorboards, vlib_frame_queue_main_init creates an input queue
-for each worker thread.
-
-Please do NOT create frame queues until it's clear that they will be
-used. Although the main dispatch loop is reasonably smart about how
-often it polls the (entire set of) frame queues, polling unused frame
-queues is a waste of clock cycles.
-
-### Hand off packets
-
-The actual handoff mechanics are simple, and integrate nicely with
-a typical graph-node dispatch function:
-
-```c
-    always_inline uword
-    do_handoff_inline (vlib_main_t * vm,
-         	       vlib_node_runtime_t * node, vlib_frame_t * frame,
-    		       int is_ip4, int is_trace)
-    {
-      u32 n_left_from, *from;
-      vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
-      u16 thread_indices [VLIB_FRAME_SIZE];
-      u16 nexts[VLIB_FRAME_SIZE], *next;
-      u32 n_enq;
-      htest_main_t *hmp = &htest_main;
-      int i;
-
-      from = vlib_frame_vector_args (frame);
-      n_left_from = frame->n_vectors;
-
-      vlib_get_buffers (vm, from, bufs, n_left_from);
-      next = nexts;
-      b = bufs;
-
-      /*
-       * Typical frame traversal loop, details vary with
-       * use case. Make sure to set thread_indices[i] with
-       * the desired destination thread index. You may
-       * or may not bother to set next[i].
-       */
-
-      for (i = 0; i < frame->n_vectors; i++)
-        {
-          
-          /* Pick a thread to handle this packet */
-          thread_indices[i] = f (packet_data_or_whatever);
-          
-
-          b += 1;
-          next += 1;
-          n_left_from -= 1;
-        }
-
-       /* Enqueue buffers to threads */
-       n_enq =
-        vlib_buffer_enqueue_to_thread (vm, node, hmp->frame_queue_index,
-                                       from, thread_indices, frame->n_vectors,
-                                       1 /* drop on congestion */);
-       /* Typical counters,
-      if (n_enq < frame->n_vectors)
-        vlib_node_increment_counter (vm, node->node_index,
-    				 XXX_ERROR_CONGESTION_DROP,
-    				 frame->n_vectors - n_enq);
-      vlib_node_increment_counter (vm, node->node_index,
-    			         XXX_ERROR_HANDED_OFF, n_enq);
-      return frame->n_vectors;
-}
-```
-
-Notes about calling vlib_buffer_enqueue_to_thread(...):
-
-* If you pass "drop on congestion" non-zero, all packets in the
-inbound frame will be consumed one way or the other. This is the
-recommended setting.
-
-* In the drop-on-congestion case, please don't try to "help" in the
-enqueue node by freeing dropped packets, or by pushing them to
-"error-drop." Either of those actions would be a severe error.
-
-* It's perfectly OK to enqueue packets to the current thread.
-
-Handoff Demo Plugin
--------------------
-
-Check out the sample (plugin) example in
-.../src/examples/handoffdemo. If you want to build the handoff demo plugin:
-
-```
-$ cd .../src/plugins
-$ ln -s ../examples/handoffdemo
-```
-
-This plugin provides a simple example of how to hand off packets
-between threads. We used it to debug packet-tracer handoff tracing
-support.
-
-# Packet generator input script
-
-```
- packet-generator new {
-    name x
-    limit 5
-    size 128-128
-    interface local0
-    node handoffdemo-1
-    data {
-        incrementing 30
-    }
- }
-```
-# Start vpp with 2 worker threads
-
-The demo plugin hands packets from worker 1 to worker 2.
-
-# Enable tracing, and start the packet generator
-
-```
-  trace add pg-input 100
-  packet-generator enable
-```
-
-# Sample Run
-
-```
-  DBGvpp# ex /tmp/pg_input_script
-  DBGvpp# pa en
-  DBGvpp# sh err
-   Count                    Node                  Reason
-         5              handoffdemo-1             packets handed off processed
-         5              handoffdemo-2             completed packets
-  DBGvpp# show run
-  Thread 1 vpp_wk_0 (lcore 0)
-  Time 133.9, average vectors/node 5.00, last 128 main loops 0.00 per node 0.00
-    vector rates in 3.7331e-2, out 0.0000e0, drop 0.0000e0, punt 0.0000e0
-               Name                 State         Calls          Vectors        Suspends         Clocks       Vectors/Call
-  handoffdemo-1                    active                  1               5               0          4.76e3            5.00
-  pg-input                        disabled                 2               5               0          5.58e4            2.50
-  unix-epoll-input                 polling             22760               0               0          2.14e7            0.00
-  ---------------
-  Thread 2 vpp_wk_1 (lcore 2)
-  Time 133.9, average vectors/node 5.00, last 128 main loops 0.00 per node 0.00
-    vector rates in 0.0000e0, out 0.0000e0, drop 3.7331e-2, punt 0.0000e0
-               Name                 State         Calls          Vectors        Suspends         Clocks       Vectors/Call
-  drop                             active                  1               5               0          1.35e4            5.00
-  error-drop                       active                  1               5               0          2.52e4            5.00
-  handoffdemo-2                    active                  1               5               0          2.56e4            5.00
-  unix-epoll-input                 polling             22406               0               0          2.18e7            0.00
-```
-
-Enable the packet tracer and run it again...
-
-```
-  DBGvpp# trace add pg-input 100
-  DBGvpp# pa en
-  DBGvpp# sh trace
-  sh trace
-  ------------------- Start of thread 0 vpp_main -------------------
-  No packets in trace buffer
-  ------------------- Start of thread 1 vpp_wk_0 -------------------
-  Packet 1
-
-  00:06:50:520688: pg-input
-    stream x, 128 bytes, 0 sw_if_index
-    current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000000
-    00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
-    00000020: 0000000000000000000000000000000000000000000000000000000000000000
-    00000040: 0000000000000000000000000000000000000000000000000000000000000000
-    00000060: 0000000000000000000000000000000000000000000000000000000000000000
-  00:06:50:520762: handoffdemo-1
-    HANDOFFDEMO: current thread 1
-
-  Packet 2
-
-  00:06:50:520688: pg-input
-    stream x, 128 bytes, 0 sw_if_index
-    current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000001
-    00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
-    00000020: 0000000000000000000000000000000000000000000000000000000000000000
-    00000040: 0000000000000000000000000000000000000000000000000000000000000000
-    00000060: 0000000000000000000000000000000000000000000000000000000000000000
-  00:06:50:520762: handoffdemo-1
-    HANDOFFDEMO: current thread 1
-
-  Packet 3
-
-  00:06:50:520688: pg-input
-    stream x, 128 bytes, 0 sw_if_index
-    current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000002
-    00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
-    00000020: 0000000000000000000000000000000000000000000000000000000000000000
-    00000040: 0000000000000000000000000000000000000000000000000000000000000000
-    00000060: 0000000000000000000000000000000000000000000000000000000000000000
-  00:06:50:520762: handoffdemo-1
-    HANDOFFDEMO: current thread 1
-
-  Packet 4
-
-  00:06:50:520688: pg-input
-    stream x, 128 bytes, 0 sw_if_index
-    current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000003
-    00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
-    00000020: 0000000000000000000000000000000000000000000000000000000000000000
-    00000040: 0000000000000000000000000000000000000000000000000000000000000000
-    00000060: 0000000000000000000000000000000000000000000000000000000000000000
-  00:06:50:520762: handoffdemo-1
-    HANDOFFDEMO: current thread 1
-
-  Packet 5
-
-  00:06:50:520688: pg-input
-    stream x, 128 bytes, 0 sw_if_index
-    current data 0, length 128, buffer-pool 0, ref-count 1, trace handle 0x1000004
-    00000000: 000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d0000
-    00000020: 0000000000000000000000000000000000000000000000000000000000000000
-    00000040: 0000000000000000000000000000000000000000000000000000000000000000
-    00000060: 0000000000000000000000000000000000000000000000000000000000000000
-  00:06:50:520762: handoffdemo-1
-    HANDOFFDEMO: current thread 1
-
-  ------------------- Start of thread 2 vpp_wk_1 -------------------
-  Packet 1
-
-  00:06:50:520796: handoff_trace
-    HANDED-OFF: from thread 1 trace index 0
-  00:06:50:520796: handoffdemo-2
-    HANDOFFDEMO: current thread 2
-  00:06:50:520867: error-drop
-    rx:local0
-  00:06:50:520914: drop
-    handoffdemo-2: completed packets
-
-  Packet 2
-
-  00:06:50:520796: handoff_trace
-    HANDED-OFF: from thread 1 trace index 1
-  00:06:50:520796: handoffdemo-2
-    HANDOFFDEMO: current thread 2
-  00:06:50:520867: error-drop
-    rx:local0
-  00:06:50:520914: drop
-    handoffdemo-2: completed packets
-
-  Packet 3
-
-  00:06:50:520796: handoff_trace
-    HANDED-OFF: from thread 1 trace index 2
-  00:06:50:520796: handoffdemo-2
-    HANDOFFDEMO: current thread 2
-  00:06:50:520867: error-drop
-    rx:local0
-  00:06:50:520914: drop
-    handoffdemo-2: completed packets
-
-  Packet 4
-
-  00:06:50:520796: handoff_trace
-    HANDED-OFF: from thread 1 trace index 3
-  00:06:50:520796: handoffdemo-2
-    HANDOFFDEMO: current thread 2
-  00:06:50:520867: error-drop
-    rx:local0
-  00:06:50:520914: drop
-    handoffdemo-2: completed packets
-
-  Packet 5
-
-  00:06:50:520796: handoff_trace
-    HANDED-OFF: from thread 1 trace index 4
-  00:06:50:520796: handoffdemo-2
-    HANDOFFDEMO: current thread 2
-  00:06:50:520867: error-drop
-    rx:local0
-  00:06:50:520914: drop
-    handoffdemo-2: completed packets
- DBGvpp#
-```
diff --git a/docs/gettingstarted/developers/vnet.md b/docs/gettingstarted/developers/vnet.md
deleted file mode 100644
index 09f81e46643..00000000000
--- a/docs/gettingstarted/developers/vnet.md
+++ /dev/null
@@ -1,795 +0,0 @@
-
-VNET (VPP Network Stack)
-========================
-
-The files associated with the VPP network stack layer are located in the
-*./src/vnet* folder. The Network Stack Layer is basically an
-instantiation of the code in the other layers. This layer has a vnet
-library that provides vectorized layer-2 and 3 networking graph nodes, a
-packet generator, and a packet tracer.
-
-In terms of building a packet processing application, vnet provides a
-platform-independent subgraph to which one connects a couple of
-device-driver nodes.
-
-Typical RX connections include "ethernet-input" \[full software
-classification, feeds ipv4-input, ipv6-input, arp-input etc.\] and
-"ipv4-input-no-checksum" \[if hardware can classify, perform ipv4 header
-checksum\].
-
-Effective graph dispatch function coding
-----------------------------------------
-
-Over the 15 years, multiple coding styles have emerged: a
-single/dual/quad loop coding model (with variations) and a
-fully-pipelined coding model.
-
-Single/dual loops
------------------
-
-The single/dual/quad loop model variations conveniently solve problems
-where the number of items to process is not known in advance: typical
-hardware RX-ring processing. This coding style is also very effective
-when a given node will not need to cover a complex set of dependent
-reads.
-
-Here is an quad/single loop which can leverage up-to-avx512 SIMD vector
-units to convert buffer indices to buffer pointers:
-
-```c
-   static uword
-   simulated_ethernet_interface_tx (vlib_main_t * vm,
-   				 vlib_node_runtime_t *
-   				 node, vlib_frame_t * frame)
-   {
-     u32 n_left_from, *from;
-     u32 next_index = 0;
-     u32 n_bytes;
-     u32 thread_index = vm->thread_index;
-     vnet_main_t *vnm = vnet_get_main ();
-     vnet_interface_main_t *im = &vnm->interface_main;
-     vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
-     u16 nexts[VLIB_FRAME_SIZE], *next;
-
-     n_left_from = frame->n_vectors;
-     from = vlib_frame_vector_args (frame);
-
-     /*
-      * Convert up to VLIB_FRAME_SIZE indices in "from" to
-      * buffer pointers in bufs[]
-      */
-     vlib_get_buffers (vm, from, bufs, n_left_from);
-     b = bufs;
-     next = nexts;
-
-     /*
-      * While we have at least 4 vector elements (pkts) to process..
-      */
-     while (n_left_from >= 4)
-       {
-         /* Prefetch next quad-loop iteration. */
-         if (PREDICT_TRUE (n_left_from >= 8))
-   	   {
-   	     vlib_prefetch_buffer_header (b[4], STORE);
-   	     vlib_prefetch_buffer_header (b[5], STORE);
-   	     vlib_prefetch_buffer_header (b[6], STORE);
-   	     vlib_prefetch_buffer_header (b[7], STORE);
-           }
-
-         /*
-          * $$$ Process 4x packets right here...
-          * set next[0..3] to send the packets where they need to go
-          */
-
-          do_something_to (b[0]);
-          do_something_to (b[1]);
-          do_something_to (b[2]);
-          do_something_to (b[3]);
-
-         /* Process the next 0..4 packets */
-   	 b += 4;
-   	 next += 4;
-   	 n_left_from -= 4;
-   	}
-     /*
-      * Clean up 0...3 remaining packets at the end of the incoming frame
-      */
-     while (n_left_from > 0)
-       {
-         /*
-          * $$$ Process one packet right here...
-          * set next[0..3] to send the packets where they need to go
-          */
-          do_something_to (b[0]);
-
-         /* Process the next packet */
-         b += 1;
-         next += 1;
-         n_left_from -= 1;
-       }
-
-     /*
-      * Send the packets along their respective next-node graph arcs
-      * Considerable locality of reference is expected, most if not all
-      * packets in the inbound vector will traverse the same next-node
-      * arc
-      */
-     vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
-
-     return frame->n_vectors;
-   }
-```
-
-Given a packet processing task to implement, it pays to scout around
-looking for similar tasks, and think about using the same coding
-pattern. It is not uncommon to recode a given graph node dispatch function
-several times during performance optimization.
-
-Creating Packets from Scratch
------------------------------
-
-At times, it's necessary to create packets from scratch and send
-them. Tasks like sending keepalives or actively opening connections
-come to mind. Its not difficult, but accurate buffer metadata setup is
-required.
-
-### Allocating Buffers
-
-Use vlib_buffer_alloc, which allocates a set of buffer indices. For
-low-performance applications, it's OK to allocate one buffer at a
-time. Note that vlib_buffer_alloc(...) does NOT initialize buffer
-metadata. See below.
-
-In high-performance cases, allocate a vector of buffer indices,
-and hand them out from the end of the vector; decrement _vec_len(..)
-as buffer indices are allocated. See tcp_alloc_tx_buffers(...) and
-tcp_get_free_buffer_index(...) for an example.
-
-### Buffer Initialization Example
-
-The following example shows the **main points**, but is not to be
-blindly cut-'n-pasted.
-
-```c
-  u32 bi0;
-  vlib_buffer_t *b0;
-  ip4_header_t *ip;
-  udp_header_t *udp;
-
-  /* Allocate a buffer */
-  if (vlib_buffer_alloc (vm, &bi0, 1) != 1)
-    return -1;
-
-  b0 = vlib_get_buffer (vm, bi0);
-
-  /* At this point b0->current_data = 0, b0->current_length = 0 */
-
-  /*
-   * Copy data into the buffer. This example ASSUMES that data will fit
-   * in a single buffer, and is e.g. an ip4 packet.
-   */
-  if (have_packet_rewrite)
-     {
-       clib_memcpy (b0->data, data, vec_len (data));
-       b0->current_length = vec_len (data);
-     }
-  else
-     {
-       /* OR, build a udp-ip packet (for example) */
-       ip = vlib_buffer_get_current (b0);
-       udp = (udp_header_t *) (ip + 1);
-       data_dst = (u8 *) (udp + 1);
-
-       ip->ip_version_and_header_length = 0x45;
-       ip->ttl = 254;
-       ip->protocol = IP_PROTOCOL_UDP;
-       ip->length = clib_host_to_net_u16 (sizeof (*ip) + sizeof (*udp) +
-                  vec_len(udp_data));
-       ip->src_address.as_u32 = src_address->as_u32;
-       ip->dst_address.as_u32 = dst_address->as_u32;
-       udp->src_port = clib_host_to_net_u16 (src_port);
-       udp->dst_port = clib_host_to_net_u16 (dst_port);
-       udp->length = clib_host_to_net_u16 (vec_len (udp_data));
-       clib_memcpy (data_dst, udp_data, vec_len(udp_data));
-
-       if (compute_udp_checksum)
-         {
-           /* RFC 7011 section 10.3.2. */
-           udp->checksum = ip4_tcp_udp_compute_checksum (vm, b0, ip);
-           if (udp->checksum == 0)
-             udp->checksum = 0xffff;
-      }
-      b0->current_length = vec_len (sizeof (*ip) + sizeof (*udp) +
-                                   vec_len (udp_data));
-
-    }
-  b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
-
-  /* sw_if_index 0 is the "local" interface, which always exists */
-  vnet_buffer (b0)->sw_if_index[VLIB_RX] = 0;
-
-  /* Use the default FIB index for tx lookup. Set non-zero to use another fib */
-  vnet_buffer (b0)->sw_if_index[VLIB_TX] = 0;
-
-```
-
-If your use-case calls for large packet transmission, use
-vlib_buffer_chain_append_data_with_alloc(...) to create the requisite
-buffer chain.
-
-### Enqueueing packets for lookup and transmission
-
-The simplest way to send a set of packets is to use
-vlib_get_frame_to_node(...) to allocate fresh frame(s) to
-ip4_lookup_node or ip6_lookup_node, add the constructed buffer
-indices, and dispatch the frame using vlib_put_frame_to_node(...).
-
-```c
-    vlib_frame_t *f;
-    f = vlib_get_frame_to_node (vm, ip4_lookup_node.index);
-    f->n_vectors = vec_len(buffer_indices_to_send);
-    to_next = vlib_frame_vector_args (f);
-
-    for (i = 0; i < vec_len (buffer_indices_to_send); i++)
-      to_next[i] = buffer_indices_to_send[i];
-
-    vlib_put_frame_to_node (vm, ip4_lookup_node_index, f);
-```
-
-It is inefficient to allocate and schedule single packet frames.
-That's typical in case you need to send one packet per second, but
-should **not** occur in a for-loop!
-
-Packet tracer
--------------
-
-Vlib includes a frame element \[packet\] trace facility, with a simple
-debug CLI interface. The cli is straightforward: "trace add
-input-node-name count" to start capturing packet traces.
-
-To trace 100 packets on a typical x86\_64 system running the dpdk
-plugin: "trace add dpdk-input 100". When using the packet generator:
-"trace add pg-input 100"
-
-To display the packet trace: "show trace"
-
-Each graph node has the opportunity to capture its own trace data. It is
-almost always a good idea to do so. The trace capture APIs are simple.
-
-The packet capture APIs snapshoot binary data, to minimize processing at
-capture time. Each participating graph node initialization provides a
-vppinfra format-style user function to pretty-print data when required
-by the VLIB "show trace" command.
-
-Set the VLIB node registration ".format\_trace" member to the name of
-the per-graph node format function.
-
-Here's a simple example:
-
-```c
-    u8 * my_node_format_trace (u8 * s, va_list * args)
-    {
-        vlib_main_t * vm = va_arg (*args, vlib_main_t *);
-        vlib_node_t * node = va_arg (*args, vlib_node_t *);
-        my_node_trace_t * t = va_arg (*args, my_trace_t *);
-
-        s = format (s, "My trace data was: %d", t->);
-
-        return s;
-    }
-```
-
-The trace framework hands the per-node format function the data it
-captured as the packet whizzed by. The format function pretty-prints the
-data as desired.
-
-Graph Dispatcher Pcap Tracing
------------------------------
-
-The vpp graph dispatcher knows how to capture vectors of packets in pcap
-format as they're dispatched. The pcap captures are as follows:
-
-```
-    VPP graph dispatch trace record description:
-
-        0                   1                   2                   3
-        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       | Major Version | Minor Version | NStrings      | ProtoHint     |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       | Buffer index (big endian)                                     |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       + VPP graph node name ...     ...               | NULL octet    |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       | Buffer Metadata ... ...                       | NULL octet    |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       | Buffer Opaque ... ...                         | NULL octet    |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       | Buffer Opaque 2 ... ...                       | NULL octet    |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       | VPP ASCII packet trace (if NStrings > 4)      | NULL octet    |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-       | Packet data (up to 16K)                                       |
-       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-```
-
-Graph dispatch records comprise a version stamp, an indication of how
-many NULL-terminated strings will follow the record header and preceed
-packet data, and a protocol hint.
-
-The buffer index is an opaque 32-bit cookie which allows consumers of
-these data to easily filter/track single packets as they traverse the
-forwarding graph.
-
-Multiple records per packet are normal, and to be expected. Packets
-will appear multiple times as they traverse the vpp forwarding
-graph. In this way, vpp graph dispatch traces are significantly
-different from regular network packet captures from an end-station.
-This property complicates stateful packet analysis.
-
-Restricting stateful analysis to records from a single vpp graph node
-such as "ethernet-input" seems likely to improve the situation.
-
-As of this writing: major version = 1, minor version = 0. Nstrings
-SHOULD be 4 or 5. Consumers SHOULD be wary values less than 4 or
-greater than 5. They MAY attempt to display the claimed number of
-strings, or they MAY treat the condition as an error.
-
-Here is the current set of protocol hints:
-
-```c
-    typedef enum
-      {
-        VLIB_NODE_PROTO_HINT_NONE = 0,
-        VLIB_NODE_PROTO_HINT_ETHERNET,
-        VLIB_NODE_PROTO_HINT_IP4,
-        VLIB_NODE_PROTO_HINT_IP6,
-        VLIB_NODE_PROTO_HINT_TCP,
-        VLIB_NODE_PROTO_HINT_UDP,
-        VLIB_NODE_N_PROTO_HINTS,
-      } vlib_node_proto_hint_t;
-```
-
-Example: VLIB_NODE_PROTO_HINT_IP6 means that the first octet of packet
-data SHOULD be 0x60, and should begin an ipv6 packet header.
-
-Downstream consumers of these data SHOULD pay attention to the
-protocol hint. They MUST tolerate inaccurate hints, which MAY occur
-from time to time.
-
-### Dispatch Pcap Trace Debug CLI
-
-To start a dispatch trace capture of up to 10,000 trace records:
-
-```
-     pcap dispatch trace on max 10000 file dispatch.pcap
-```
-
-To start a dispatch trace which will also include standard vpp packet
-tracing for packets which originate in dpdk-input:
-
-```
-     pcap dispatch trace on max 10000 file dispatch.pcap buffer-trace dpdk-input 1000
-```
-To save the pcap trace, e.g. in /tmp/dispatch.pcap:
-
-```
-    pcap dispatch trace off
-```
-
-### Wireshark dissection of dispatch pcap traces
-
-It almost goes without saying that we built a companion wireshark
-dissector to display these traces. As of this writing, we have
-upstreamed the wireshark dissector.
-
-Since it will be a while before wireshark/master/latest makes it into
-all of the popular Linux distros, please see the "How to build a vpp
-dispatch trace aware Wireshark" page for build info.
-
-Here is a sample packet dissection, with some fields omitted for
-clarity.  The point is that the wireshark dissector accurately
-displays **all** of the vpp buffer metadata, and the name of the graph
-node in question.
-
-```
-    Frame 1: 2216 bytes on wire (17728 bits), 2216 bytes captured (17728 bits)
-        Encapsulation type: USER 13 (58)
-        [Protocols in frame: vpp:vpp-metadata:vpp-opaque:vpp-opaque2:eth:ethertype:ip:tcp:data]
-    VPP Dispatch Trace
-        BufferIndex: 0x00036663
-    NodeName: ethernet-input
-    VPP Buffer Metadata
-        Metadata: flags:
-        Metadata: current_data: 0, current_length: 102
-        Metadata: current_config_index: 0, flow_id: 0, next_buffer: 0
-        Metadata: error: 0, n_add_refs: 0, buffer_pool_index: 0
-        Metadata: trace_index: 0, recycle_count: 0, len_not_first_buf: 0
-        Metadata: free_list_index: 0
-        Metadata:
-    VPP Buffer Opaque
-        Opaque: raw: 00000007 ffffffff 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
-        Opaque: sw_if_index[VLIB_RX]: 7, sw_if_index[VLIB_TX]: -1
-        Opaque: L2 offset 0, L3 offset 0, L4 offset 0, feature arc index 0
-        Opaque: ip.adj_index[VLIB_RX]: 0, ip.adj_index[VLIB_TX]: 0
-        Opaque: ip.flow_hash: 0x0, ip.save_protocol: 0x0, ip.fib_index: 0
-        Opaque: ip.save_rewrite_length: 0, ip.rpf_id: 0
-        Opaque: ip.icmp.type: 0 ip.icmp.code: 0, ip.icmp.data: 0x0
-        Opaque: ip.reass.next_index: 0, ip.reass.estimated_mtu: 0
-        Opaque: ip.reass.fragment_first: 0 ip.reass.fragment_last: 0
-        Opaque: ip.reass.range_first: 0 ip.reass.range_last: 0
-        Opaque: ip.reass.next_range_bi: 0x0, ip.reass.ip6_frag_hdr_offset: 0
-        Opaque: mpls.ttl: 0, mpls.exp: 0, mpls.first: 0, mpls.save_rewrite_length: 0, mpls.bier.n_bytes: 0
-        Opaque: l2.feature_bitmap: 00000000, l2.bd_index: 0, l2.l2_len: 0, l2.shg: 0, l2.l2fib_sn: 0, l2.bd_age: 0
-        Opaque: l2.feature_bitmap_input:   none configured, L2.feature_bitmap_output:   none configured
-        Opaque: l2t.next_index: 0, l2t.session_index: 0
-        Opaque: l2_classify.table_index: 0, l2_classify.opaque_index: 0, l2_classify.hash: 0x0
-        Opaque: policer.index: 0
-        Opaque: ipsec.flags: 0x0, ipsec.sad_index: 0
-        Opaque: map.mtu: 0
-        Opaque: map_t.v6.saddr: 0x0, map_t.v6.daddr: 0x0, map_t.v6.frag_offset: 0, map_t.v6.l4_offset: 0
-        Opaque: map_t.v6.l4_protocol: 0, map_t.checksum_offset: 0, map_t.mtu: 0
-        Opaque: ip_frag.mtu: 0, ip_frag.next_index: 0, ip_frag.flags: 0x0
-        Opaque: cop.current_config_index: 0
-        Opaque: lisp.overlay_afi: 0
-        Opaque: tcp.connection_index: 0, tcp.seq_number: 0, tcp.seq_end: 0, tcp.ack_number: 0, tcp.hdr_offset: 0, tcp.data_offset: 0
-        Opaque: tcp.data_len: 0, tcp.flags: 0x0
-        Opaque: sctp.connection_index: 0, sctp.sid: 0, sctp.ssn: 0, sctp.tsn: 0, sctp.hdr_offset: 0
-        Opaque: sctp.data_offset: 0, sctp.data_len: 0, sctp.subconn_idx: 0, sctp.flags: 0x0
-        Opaque: snat.flags: 0x0
-        Opaque:
-    VPP Buffer Opaque2
-        Opaque2: raw: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
-        Opaque2: qos.bits: 0, qos.source: 0
-        Opaque2: loop_counter: 0
-        Opaque2: gbp.flags: 0, gbp.src_epg: 0
-        Opaque2: pg_replay_timestamp: 0
-        Opaque2:
-    Ethernet II, Src: 06:d6:01:41:3b:92 (06:d6:01:41:3b:92), Dst: IntelCor_3d:f6    Transmission Control Protocol, Src Port: 22432, Dst Port: 54084, Seq: 1, Ack: 1, Len: 36
-        Source Port: 22432
-        Destination Port: 54084
-        TCP payload (36 bytes)
-    Data (36 bytes)
-
-    0000  cf aa 8b f5 53 14 d4 c7 29 75 3e 56 63 93 9d 11   ....S...)u>Vc...
-    0010  e5 f2 92 27 86 56 4c 21 ce c5 23 46 d7 eb ec 0d   ...'.VL!..#F....
-    0020  a8 98 36 5a                                       ..6Z
-        Data: cfaa8bf55314d4c729753e5663939d11e5f2922786564c21…
-        [Length: 36]
-```
-
-It's a matter of a couple of mouse-clicks in Wireshark to filter the
-trace to a specific buffer index. With that specific kind of filtration,
-one can watch a packet walk through the forwarding graph; noting any/all
-metadata changes, header checksum changes, and so forth.
-
-This should be of significant value when developing new vpp graph
-nodes. If new code mispositions b->current_data, it will be completely
-obvious from looking at the dispatch trace in wireshark.
-
-## pcap rx, tx, and drop tracing
-
-vpp also supports rx, tx, and drop packet capture in pcap format,
-through the "pcap trace" debug CLI command.
-
-This command is used to start or stop a packet capture, or show the
-status of packet capture. Each of "pcap trace rx", "pcap trace tx",
-and "pcap trace drop" is implemented.  Supply one or more of "rx",
-"tx", and "drop" to enable multiple simultaneous capture types.
-
-These commands have the following optional parameters:
-
-- rx - trace received packets.
-
-- tx - trace transmitted packets.
-
-- drop - trace dropped packets.
-
-- max _nnnn_ - file size, number of packet captures. Once
-   packets have been received, the trace buffer buffer is flushed
-  to the indicated file. Defaults to 1000. Can only be updated if packet
-  capture is off.
-
-- max-bytes-per-pkt _nnnn_ - maximum number of bytes to trace
-  on a per-packet basis. Must be >32 and less than 9000. Default value:
-  512.
-
-- filter - Use the pcap rx / tx / drop trace filter, which must
-  be configured. Use classify filter pcap... to configure the
-  filter. The filter will only be executed if the per-interface or
-  any-interface tests fail.
-
-- intfc _interface_ | _any_ - Used to specify a given interface,
-  or use 'any' to run packet capture on all interfaces.
-  'any' is the default if not provided. Settings from a previous
-  packet capture are preserved, so 'any' can be used to reset
-  the interface setting.
-
-- file _filename_ - Used to specify the output filename. The
-  file will be placed in the '/tmp' directory.  If _filename_
-  already exists, file will be overwritten. If no filename is
-  provided, '/tmp/rx.pcap or tx.pcap' will be used, depending
-  on capture direction. Can only be updated when pcap capture is off.
-
-- status - Displays the current status and configured
-  attributes associated with a packet capture. If packet capture is in
-  progress, 'status' also will return the number of packets
-  currently in the buffer. Any additional attributes entered on
-  command line with a 'status' request will be ignored.
-
-- filter - Capture packets which match the current packet
-  trace filter set. See next section. Configure the capture filter
-  first.
-
-## packet trace capture filtering
-
-The "classify filter pcap |  | trace" debug CLI command
-constructs an arbitrary set of packet classifier tables for use with
-"pcap rx | tx | drop trace," and with the vpp packet tracer on a
-per-interface or system-wide basis.
-
-Packets which match a rule in the classifier table chain will be
-traced. The tables are automatically ordered so that matches in the
-most specific table are tried first.
-
-It's reasonably likely that folks will configure a single table with
-one or two matches. As a result, we configure 8 hash buckets and 128K
-of match rule space by default. One can override the defaults by
-specifying "buckets " and "memory-size " as desired.
-
-To build up complex filter chains, repeatedly issue the classify
-filter debug CLI command. Each command must specify the desired mask
-and match values. If a classifier table with a suitable mask already
-exists, the CLI command adds a match rule to the existing table.  If
-not, the CLI command add a new table and the indicated mask rule
-
-### Configure a simple pcap classify filter
-
-```
-    classify filter pcap mask l3 ip4 src match l3 ip4 src 192.168.1.11
-    pcap trace rx max 100 filter
-```
-
-### Configure a simple per-interface capture filter
-
-```
-    classify filter GigabitEthernet3/0/0 mask l3 ip4 src match l3 ip4 src 192.168.1.11"
-    pcap trace rx max 100 intfc GigabitEthernet3/0/0
-```
-
-Note that per-interface capture filters are _always_ applied.
-
-### Clear per-interface capture filters
-
-```
-    classify filter GigabitEthernet3/0/0 del
-```
-
-### Configure another fairly simple pcap classify filter
-
-```
-   classify filter pcap mask l3 ip4 src dst match l3 ip4 src 192.168.1.10 dst 192.168.2.10
-   pcap trace tx max 100 filter
-```
-
-### Configure a vpp packet tracer filter
-
-```
-   classify filter trace mask l3 ip4 src dst match l3 ip4 src 192.168.1.10 dst 192.168.2.10
-   trace add dpdk-input 100 filter
-```
-
-### Clear all current classifier filters
-
-```
-    classify filter [pcap |  | trace] del
-```
-
-### To inspect the classifier tables
-
-```
-   show classify table [verbose]
-```
-
-The verbose form displays all of the match rules, with hit-counters.
-
-### Terse description of the "mask " syntax:
-
-```
-    l2 src dst proto tag1 tag2 ignore-tag1 ignore-tag2 cos1 cos2 dot1q dot1ad
-    l3 ip4  ip6 
-     version hdr_length src[/width] dst[/width]
-               tos length fragment_id ttl protocol checksum
-     version traffic-class flow-label src dst proto
-               payload_length hop_limit protocol
-    l4 tcp  udp  src_port dst_port
-     src dst  # ports
-     src_port dst_port
-```
-
-To construct **matches**, add the values to match after the indicated
-keywords in the mask syntax. For example: "... mask l3 ip4 src" ->
-"... match l3 ip4 src 192.168.1.11"
-
-## VPP Packet Generator
-
-We use the VPP packet generator to inject packets into the forwarding
-graph. The packet generator can replay pcap traces, and generate packets
-out of whole cloth at respectably high performance.
-
-The VPP pg enables quite a variety of use-cases, ranging from functional
-testing of new data-plane nodes to regression testing to performance
-tuning.
-
-## PG setup scripts
-
-PG setup scripts describe traffic in detail, and leverage vpp debug
-CLI mechanisms. It's reasonably unusual to construct a pg setup script
-which doesn't include a certain amount of interface and FIB configuration.
-
-For example:
-
-```
-    loop create
-    set int ip address loop0 192.168.1.1/24
-    set int state loop0 up
-
-    packet-generator new {
-        name pg0
-        limit 100
-        rate 1e6
-        size 300-300
-        interface loop0
-        node ethernet-input
-        data { IP4: 1.2.3 -> 4.5.6
-               UDP: 192.168.1.10 - 192.168.1.254 -> 192.168.2.10
-               UDP: 1234 -> 2345
-               incrementing 286
-        }
-    }
-```
-
-A packet generator stream definition includes two major sections:
-- Stream Parameter Setup
-- Packet Data
-
-### Stream Parameter Setup
-
-Given the example above, let's look at how to set up stream
-parameters:
-
-- **name pg0** - Name of the stream, in this case "pg0"
-
-- **limit 1000** - Number of packets to send when the stream is
-enabled. "limit 0" means send packets continuously.
-
-- **maxframe \** - Maximum frame size. Handy for injecting
-multiple frames no larger than \. Useful for checking dual /
-quad loop codes
-
-- **rate 1e6** - Packet injection rate, in this case 1 MPPS. When not
-specified, the packet generator injects packets as fast as possible
-
-- **size 300-300** - Packet size range, in this case send 300-byte packets
-
-- **interface loop0** - Packets appear as if they were received on the
-specified interface. This datum is used in multiple ways: to select
-graph arc feature configuration, to select IP FIBs.  Configure
-features e.g. on loop0 to exercise those features.
-
-- **tx-interface \** - Packets will be transmitted on the
-indicated interface. Typically required only when injecting packets
-into post-IP-rewrite graph nodes.
-
-- **pcap \** - Replay packets from the indicated pcap
-capture file. "make test" makes extensive use of this feature:
-generate packets using scapy, save them in a .pcap file, then inject
-them into the vpp graph via a vpp pg "pcap \" stream
-definition
-
-- **worker \** - Generate packets for the stream using the
-indicated vpp worker thread. The vpp pg generates and injects O(10
-MPPS / core).  Use multiple stream definitions and worker threads to
-generate and inject enough traffic to easily fill a 40 gbit pipe with
-small packets.
-
-### Data definition
-
-Packet generator data definitions make use of a layered implementation
-strategy. Networking layers are specified in order, and the notation can
-seem a bit counter-intuitive. In the example above, the data
-definition stanza constructs a set of L2-L4 headers layers, and
-uses an incrementing fill pattern to round out the requested 300-byte
-packets.
-
-- **IP4: 1.2.3 -> 4.5.6** - Construct an L2 (MAC) header with the ip4
-ethertype (0x800), src MAC address of 00:01:00:02:00:03 and dst MAC
-address of 00:04:00:05:00:06. Mac addresses may be specified in either
-_xxxx.xxxx.xxxx_ format or _xx:xx:xx:xx:xx:xx_ format.
-
-- **UDP: 192.168.1.10 - 192.168.1.254 -> 192.168.2.10** - Construct an
-incrementing set of L3 (IPv4) headers for successive packets with
-source addresses ranging from .10 to .254. All packets in the stream
-have a constant dest address of 192.168.2.10. Set the protocol field
-to 17, UDP.
-
-- **UDP: 1234 -> 2345** - Set the UDP source and destination ports to
-1234 and 2345, respectively
-
-- **incrementing 256** - Insert up to 256 incrementing data bytes.
-
-Obvious variations involve "s/IP4/IP6/" in the above, along with
-changing from IPv4 to IPv6 address notation.
-
-The vpp pg can set any / all IPv4 header fields, including tos, packet
-length, mf / df / fragment id and offset, ttl, protocol, checksum, and
-src/dst addresses. Take a look at ../src/vnet/ip/ip[46]_pg.c for
-details.
-
-If all else fails, specify the entire packet data in hex:
-
-- **hex 0xabcd...** - copy hex data verbatim into the packet
-
-When replaying pcap files ("**pcap \**"), do not specify a
-data stanza.
-
-### Diagnosing "packet-generator new" parse failures
-
-If you want to inject packets into a brand-new graph node, remember
-to tell the packet generator debug CLI how to parse the packet
-data stanza.
-
-If the node expects L2 Ethernet MAC headers, specify ".unformat_buffer
-= unformat_ethernet_header":
-
-```
-    /* *INDENT-OFF* */
-    VLIB_REGISTER_NODE (ethernet_input_node) =
-    {
-      
-      .unformat_buffer = unformat_ethernet_header,
-      
-    };
-```
-
-Beyond that, it may be necessary to set breakpoints in
-.../src/vnet/pg/cli.c. Debug image suggested.
-
-When debugging new nodes, it may be far simpler to directly inject
-ethernet frames - and add a corresponding vlib_buffer_advance in the
-new node - than to modify the packet generator.
-
-## Debug CLI
-
-The descriptions above describe the "packet-generator new" debug CLI in
-detail.
-
-Additional debug CLI commands include:
-
-```
-    vpp# packet-generator enable []
-```
-
-which enables the named stream, or all streams.
-
-```
-    vpp# packet-generator disable []
-```
-
-disables the named stream, or all streams.
-
-
-```
-    vpp# packet-generator delete 
-```
-
-Deletes the named stream.
-
-```
-    vpp# packet-generator configure  [limit ]
-         [rate ] [size -]
-```
-
-Changes stream parameters without having to recreate the entire stream
-definition. Note that re-issuing a "packet-generator new" command will
-correctly recreate the named stream.
diff --git a/docs/gettingstarted/developers/vpp_api_module.rst b/docs/gettingstarted/developers/vpp_api_module.rst
deleted file mode 100644
index 3cdea524e4e..00000000000
--- a/docs/gettingstarted/developers/vpp_api_module.rst
+++ /dev/null
@@ -1,122 +0,0 @@
-.. _vpp_api_module:
-
-.. toctree::
-
-VPP API module
-==============
-
-Overview
-________
-
-VPP API module allows communicating with VPP over shared memory interface. The API consists of 3 parts:
-
-* common code - low-level API
-* generated code - high-level API
-* code generator - to generate your own high-level API e.g. for custom plugins
-
-Common code
-___________
-
-**C**
-
-C common code represents the basic, low-level API, providing functions to connect/disconnect, perform message discovery and send/receive messages. The C variant is in vapi.h.
-
-**C++**
-
-C++ is provided by vapi.hpp and contains high-level API templates, which are specialized by generated code.
-
-Generated code
-______________
-
-Each API file present in the source tree is automatically translated to JSON file, which the code generator parses and generates either C (vapi_c_gen.py) or C++ (vapi_cpp_gen.py) code.
-
-This can then be included in the client application and provides convenient way to interact with VPP. This includes:
-
-* automatic byte-swapping
-* automatic request-response matching based on context
-* automatic casts to appropriate types (type-safety) when calling callbacks
-* automatic sending of control-pings for dump messages
-
-The API supports two modes of operation:
-
-* blocking
-* non-blocking
-
-In blocking mode, whenever an operation is initiated, the code waits until it can finish. This means that when sending a message, the call blocks until the message can be written to shared memory. Similarly, receiving a message blocks until a message becomes available. On higher level, this also means that when doing a request (e.g. show_version), the call blocks until a response comes back (e.g. show_version_reply).
-
-In non-blocking mode, these are decoupled, the API returns VAPI_EAGAIN whenever an operation cannot be performed and after sending a request, it's up to the client to wait for and process a response.
-
-Code generator
-______________
-
-Python code generator comes in two flavors - C and C++ and generates high-level API headers. All the code is stored in the headers.
-
-C Usage
-_______
-
-**Low-level API**
-
-Refer to inline API documentation in doxygen format in vapi.h header for description of functions. It's recommended to use the safer, high-level API provided by specialized headers (e.g. vpe.api.vapi.h or vpe.api.vapi.hpp).
-
-**C high-level API**
-
-*Callbacks*
-
-The C high-level API is strictly callback-based for maximum efficiency. Whenever an operation is initiated a callback with a callback context is part of that operation. The callback is then invoked when the response (or multiple responses) arrive which are tied to the request. Also, callbacks are invoked whenever an event arrives, if such callback is registered. All the pointers to responses/events point to shared memory and are immediately freed after callback finishes so the client needs to extract/copy any data in which it is interested in.
-
-**Blocking mode**
-
-In simple blocking mode, the whole operation (being a simple request or a dump) is finished and it's callback is called (potentially multiple times for dumps) during function call.
-
-Example pseudo-code for a simple request in this mode:
-
-vapi_show_version(message, callback, callback_context)
-
-#. generate unique internal context and assign it to message.header.context 
-#. byteswap the message to network byte order 
-#. send message to vpp (message is now consumed and vpp will free it) 
-#. create internal "outstanding request context" which stores the callback, callback context and the internal context value 
-#. call dispatch, which in this mode receives and processes responses until the internal "outstanding requests" queue is empty. In blocking mode, this queue always contains at most one item. 
-
-.. note::
-
-	It's possible for different - unrelated callbacks to be called before the response callbacks is called in cases where e.g. events are stored in shared memory queue.
-
-**Non-blocking mode**
-In non-blocking mode, all the requests are only byte-swapped and the context information along with callbacks is stored locally (so in the above example, only steps 1-4 are executed and step 5 is skipped). Calling dispatch is up to the client application. This allows to alternate between sending/receiving messages or have a dedicated thread which calls dispatch.
-
-C++ high level API
-__________________
-
-**Callbacks**
-
-In C++ API, the response is automatically tied to the corresponding Request, Dump or Event_registration object. Optionally a callback might be specified, which then gets called when the response is received.
-
-.. note::
-
-	Responses take up shared memory space and should be freed either manually (in case of result sets) or automatically (by destroying the object owning them) when no longer needed. Once a Request or Dump object was executed, it cannot be re-sent, since the request itself (stores in shared memory) is consumed by vpp and inaccessible (set to nullptr) anymore.
-
-C++ Usage
-_________
-
-**Requests & dumps**
-
-*Create an object of Connection type and call connect() to connect to vpp.*
-
-#. Create an object of Request or Dump type using it's typedef (e.g. Show_version)
-#. Use get_request() to obtain and manipulate the underlying request if required.
-#. Issue execute() to send the request.
-#. Use either wait_for_response() or dispatch() to wait for the response.
-#. Use get_response_state() to get the state and get_response() to read the response.
-
-**Events**
-
-*Create a Connection and execute the appropriate Request to subscribe to events (e.g. Want_stats)*
-
-#. Create an Event_registration with a template argument being the type of event you are interested in.
-#. Call dispatch() or wait_for_response() to wait for the event. A callback will be called when an event occurs (if passed to Event_registration() constructor). Alternatively, read the result set.
-
-.. note::
-
-	Events stored in the result set take up space in shared memory and should be freed regularly (e.g. in the callback, once the event is processed).
-
diff --git a/docs/gettingstarted/index.rst b/docs/gettingstarted/index.rst
deleted file mode 100644
index 08fc1cd329e..00000000000
--- a/docs/gettingstarted/index.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-.. _gettingstarted:
-
-######################
-Getting Started
-######################
-
-The Getting Started Guide is comprised of several different sections; a User section
-that describes a basic installation and configuration of VPP (either manually or
-using a config utility),  another install for Developers, which contains additional
-code that provides tools that are used in a development environment.
-
-This section covers the following:
-
-* Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos) and then how to configure and use VPP.
-* Describes the different types of VPP packages, which are used in both basic and developer installs.
-* A VPP tutorial which is a great way to learn VPP basics.
-
-The Users section covers configuration operations; this
-
-* How to configure and Run VPP manually.
-* How to use the Configuration Utility to install, and then configure VPP.
-
-The Developers section covers the following areas:
-
-* Building VPP
-* Describes the components of the four VPP layers
-* How to Create, Add, Enable/Disable features
-* Discusses different aspects of Bounded-index Extensible Hashing (bihash)
-
-The Writing VPP Documentation section covers the following topics:
-
-* How to build VPP documents
-* How to push your changes to the VPP Docs Repository
-* Identifies the different styles associated to reStructuredText
-* Identifies the different styles associated to Markdown
-
-.. toctree::
-   :maxdepth: 2
-
-   installing/index.rst
-   progressivevpp/index.rst
-   users/index.rst
-   developers/index.rst
-   writingdocs/index.rst
diff --git a/docs/gettingstarted/installing/centos.rst b/docs/gettingstarted/installing/centos.rst
deleted file mode 100644
index 88691a238ff..00000000000
--- a/docs/gettingstarted/installing/centos.rst
+++ /dev/null
@@ -1,176 +0,0 @@
-.. _centos:
-
-.. toctree::
-
-Setup the FD.io Repository - Centos 7
-=====================================
-
-Update the OS
--------------
-
-Before starting the repository setup, it is a good idea to first update and upgrade
-the OS; run the following commands to update the OS and get some packages.
-
-.. code-block:: console
-
-    $ sudo yum update
-    $ sudo yum install pygpgme yum-utils
-
-
-Package Cloud Repository
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-Build artifacts are also posted to a packagecloud.io Repository. This includes
-official point releases. To use any of these build artifacts, create a file
-*'/etc/yum.repos.d/fdio-release.repo'* with the content that points to the
-version needed. Below are some common examples of the content needed:
-
-
-VPP Latest Release
-""""""""""""""""""
-
-To allow *'yum'* access to the official VPP releases, create the file
-*'/etc/yum.repos.d/fdio-release.repo'* with the following content.
-
-.. code-block:: console
-
-   $ cat /etc/yum.repos.d/fdio-release.repo
-   [fdio_release]
-   name=fdio_release
-   baseurl=https://packagecloud.io/fdio/release/el/7/$basearch
-   repo_gpgcheck=1
-   gpgcheck=0
-   enabled=1
-   gpgkey=https://packagecloud.io/fdio/release/gpgkey
-   sslverify=1
-   sslcacert=/etc/pki/tls/certs/ca-bundle.crt
-   metadata_expire=300
-
-   [fdio_release-source]
-   name=fdio_release-source
-   baseurl=https://packagecloud.io/fdio/release/el/7/SRPMS
-   repo_gpgcheck=1
-   gpgcheck=0
-   enabled=1
-   gpgkey=https://packagecloud.io/fdio/release/gpgkey
-   sslverify=1
-   sslcacert=/etc/pki/tls/certs/ca-bundle.crt
-   metadata_expire=300
-
-Update your local yum cache.
-
-.. code-block:: console
-
-   $ sudo yum clean all
-   $ sudo yum -q makecache -y --disablerepo='*' --enablerepo='fdio_release'
-
-The *'yum install vpp'* command will install the most recent release. To
-install older releases, run the following command to get the list of releases
-provided.
-
-.. code-block:: console
-
-   $ sudo yum --showduplicates list vpp* | expand
-
-VPP Master Branch
-"""""""""""""""""""
-
-To allow *yum* access to the nightly builds from the VPP master branch, create
-the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content.
-
-.. code-block:: console
-
-   $ cat /etc/yum.repos.d/fdio-release.repo
-   [fdio_master]
-   name=fdio_master
-   baseurl=https://packagecloud.io/fdio/master/el/7/$basearch
-   repo_gpgcheck=1
-   gpgcheck=0
-   enabled=1
-   gpgkey=https://packagecloud.io/fdio/master/gpgkey
-   sslverify=1
-   sslcacert=/etc/pki/tls/certs/ca-bundle.crt
-   metadata_expire=300
-
-   [fdio_master-source]
-   name=fdio_master-source
-   baseurl=https://packagecloud.io/fdio/master/el/7/SRPMS
-   repo_gpgcheck=1
-   gpgcheck=0
-   enabled=1
-   gpgkey=https://packagecloud.io/fdio/master/gpgkey
-   sslverify=1
-   sslcacert=/etc/pki/tls/certs/ca-bundle.crt
-   metadata_expire=300
-
-Update your local yum cache.
-
-.. code-block:: console
-
-   $ sudo yum clean all
-   $ sudo yum -q makecache -y --disablerepo='*' --enablerepo='fdio_master'
-
-The *'yum install vpp'* command will install the most recent build on the
-branch. Run the following command to get the list of images produce by the
-branch.
-
-.. code-block:: console
-
-   $ sudo yum clean all
-   $ sudo yum --showduplicates list vpp* | expand
-
-Install VPP RPMs
-================
-
-To install the VPP packet engine, run the following command:
-
-.. code-block:: console
-
-   $ sudo yum install vpp
-
-The *vpp* RPM depends on the *vpp-lib* and *vpp-selinux-policy*
-RPMs, so they will be installed as well.
-
-.. note::
-
-    The *vpp-selinux-policy* will not enable SELinux on the system. It
-    will install a Custom VPP SELinux policy that will be used if SELinux is
-    enabled at any time.
-
-There are additional packages that are optional. These packages can be
-combined with the command above and installed all at once, or installed as
-needed: 
-
-.. code-block:: console
-
-   $ sudo yum install vpp-plugins vpp-devel vpp-api-python vpp-api-lua vpp-api-java vpp-debuginfo vpp-devel libvpp0
-
-Starting VPP
-============
-
-Once VPP is installed on the system, to run VPP as a systemd service on CentOS,
-run the following command:
-
-.. code-block:: console
-
-   $ sudo systemctl start vpp
-
-Then to enable VPP to start on system reboot, run the following command:
-
-.. code-block:: console
-
-   $ sudo systemctl enable vpp
-
-Outside of running VPP as a systemd service, VPP can be started manually or
-made to run within GDB for debugging. See :ref:`running` for more details and
-ways to tailor VPP to a specific system.
-
-
-Uninstall the VPP RPMs
-======================
-
-To uninstall a VPP RPM, run the following command:
-
-.. code-block:: console
-
-   $ sudo yum autoremove vpp*
diff --git a/docs/gettingstarted/installing/index.rst b/docs/gettingstarted/installing/index.rst
index b482ea65146..ba67375f8c7 100644
--- a/docs/gettingstarted/installing/index.rst
+++ b/docs/gettingstarted/installing/index.rst
@@ -27,14 +27,6 @@ The following are instructions on how to install VPP on Ubuntu.
 
    ubuntu
 
-Installing on Centos
--------------------------------
-
-The following are instructions on how to install VPP on Centos.
-
-.. toctree::
-
-   centos
 
 Package Descriptions
 ----------------------------------
diff --git a/docs/gettingstarted/installing/packages.rst b/docs/gettingstarted/installing/packages.rst
index 6c4fae18ee3..7eea532413f 100644
--- a/docs/gettingstarted/installing/packages.rst
+++ b/docs/gettingstarted/installing/packages.rst
@@ -35,7 +35,7 @@ vpp-plugins
 
 Vector Packet Processing plugin modules.
 
-.. include:: ../../dynamic_includes/plugin_list.inc
+.. include:: ../../_generated/includes/plugin_list.inc
 
 vpp-dbg
 -------
@@ -48,7 +48,7 @@ vpp-dev
 Vector Packet Processing development support. This package contains
 development support files for the VPP libraries.
 
-vpp-api-python 
+vpp-api-python
 --------------
 
 Python binding for the VPP Binary API.
diff --git a/docs/gettingstarted/installing/ubuntu.rst b/docs/gettingstarted/installing/ubuntu.rst
index 2521b6d2790..f1bdb3eecd0 100644
--- a/docs/gettingstarted/installing/ubuntu.rst
+++ b/docs/gettingstarted/installing/ubuntu.rst
@@ -67,7 +67,7 @@ Install the mandatory packages by running the following commands:
   sudo apt-get update
   sudo apt-get install vpp vpp-plugin-core vpp-plugin-dpdk
 
-  
+
 Install the Optional Packages
 ==============================
 
diff --git a/docs/gettingstarted/progressivevpp/index.rst b/docs/gettingstarted/progressivevpp/index.rst
index ab257f25258..7d1a2e2b237 100644
--- a/docs/gettingstarted/progressivevpp/index.rst
+++ b/docs/gettingstarted/progressivevpp/index.rst
@@ -14,8 +14,6 @@ will discuss basic operations, and the state of a running FD.io VPP on a system.
 
     This is **not** intended to be a 'How to Run in a Production Environment' set of instructions.
 
-For more information on using VPP with Virtual Box/Vagrant, please refer to :ref:`vppvagrant`
-
 .. toctree::
 
    settingupenvironment.rst
diff --git a/docs/gettingstarted/progressivevpp/interface.rst b/docs/gettingstarted/progressivevpp/interface.rst
index 112eaa974b4..7e35ca870f9 100644
--- a/docs/gettingstarted/progressivevpp/interface.rst
+++ b/docs/gettingstarted/progressivevpp/interface.rst
@@ -41,7 +41,7 @@ Initial State
 
 The initial state here is presumed to be the final state from the previous sections
 of the tutorial.
- 
+
 Create veth interfaces on host
 -------------------------------
 
@@ -104,7 +104,7 @@ command:
      __/ __/ _ \  (_)__    | | / / _ \/ _ \
      _/ _// // / / / _ \   | |/ / ___/ ___/
      /_/ /____(_)_/\___/   |___/_/  /_/
-    
+
     vpp#
 
 Create a host interface attached to **vpp1out**.
diff --git a/docs/gettingstarted/progressivevpp/routing.rst b/docs/gettingstarted/progressivevpp/routing.rst
index c9586c1c85d..38841b744b3 100644
--- a/docs/gettingstarted/progressivevpp/routing.rst
+++ b/docs/gettingstarted/progressivevpp/routing.rst
@@ -50,10 +50,10 @@ Setup host route
 
    $ sudo ip route add 10.10.2.0/24 via 10.10.1.2
    $ ip route
-   default via 10.0.2.2 dev enp0s3 
-   10.0.2.0/24 dev enp0s3  proto kernel  scope link  src 10.0.2.15 
-   10.10.1.0/24 dev vpp1host  proto kernel  scope link  src 10.10.1.1 
-   10.10.2.0/24 via 10.10.1.2 dev vpp1host 
+   default via 10.0.2.2 dev enp0s3
+   10.0.2.0/24 dev enp0s3  proto kernel  scope link  src 10.0.2.15
+   10.10.1.0/24 dev vpp1host  proto kernel  scope link  src 10.10.1.1
+   10.10.2.0/24 via 10.10.1.2 dev vpp1host
 
 Setup return route on vpp2
 ---------------------------
diff --git a/docs/gettingstarted/progressivevpp/runningvpp.rst b/docs/gettingstarted/progressivevpp/runningvpp.rst
index 19d2f4e9ede..c24d1040ddf 100644
--- a/docs/gettingstarted/progressivevpp/runningvpp.rst
+++ b/docs/gettingstarted/progressivevpp/runningvpp.rst
@@ -50,7 +50,7 @@ We should now be able to execute the VPP shell and show the version.
     __/ __/ _ \  (_)__    | | / / _ \/ _ \
     _/ _// // / / / _ \   | |/ / ___/ ___/
     /_/ /____(_)_/\___/   |___/_/  /_/
-   
+
    vpp# show version
    vpp v18.07-release built by root on c469eba2a593 at Mon Jul 30 23:27:03 UTC 2018
    vpp#
diff --git a/docs/gettingstarted/progressivevpp/settingupenvironment.rst b/docs/gettingstarted/progressivevpp/settingupenvironment.rst
index c012f691e8b..8c67c79b188 100644
--- a/docs/gettingstarted/progressivevpp/settingupenvironment.rst
+++ b/docs/gettingstarted/progressivevpp/settingupenvironment.rst
@@ -11,8 +11,7 @@ All of these exercises are designed to be performed on an Ubuntu 16.04 (Xenial)
 Install Virtual Box and Vagrant
 -------------------------------
 
-You will need to install Virtual Box and Vagrant. If you have not installed Virtual Box or Vagrant please
-refer to :ref:`installingVboxVagrant` to install Virtual Box and Vagrant.
+You will need to install Virtual Box and Vagrant.
 
 Create a Vagrant Directory
 ---------------------------
@@ -30,17 +29,17 @@ Create a file called **Vagrantfile** with the following contents:
 
     # -*- mode: ruby -*-
     # vi: set ft=ruby :
-    
+
     Vagrant.configure(2) do |config|
-    
+
       config.vm.box = "bento/ubuntu-18.04"
       config.vm.box_check_update = false
-    
+
       vmcpu=(ENV['VPP_VAGRANT_VMCPU'] || 2)
       vmram=(ENV['VPP_VAGRANT_VMRAM'] || 4096)
-    
+
       config.ssh.forward_agent = true
-    
+
       config.vm.provider "virtualbox" do |vb|
           vb.customize ["modifyvm", :id, "--ioapic", "on"]
           vb.memory = "#{vmram}"
@@ -129,7 +128,7 @@ Create some startup files
 
 We will create some startup files for the use of this tutorial. Typically you will
 modify the startup.conf file found in /etc/vpp/startup.conf. For more information
-on this file refer to :ref:`startup`.
+on this file refer to :ref:`configuration_reference`.
 
 When running multiple VPP instances, each instance needs to have
 specified a 'name' or 'prefix'. In the example below, the 'name' or 'prefix'
diff --git a/docs/gettingstarted/progressivevpp/switching.rst b/docs/gettingstarted/progressivevpp/switching.rst
index a28e860fdaa..7ee559815ec 100644
--- a/docs/gettingstarted/progressivevpp/switching.rst
+++ b/docs/gettingstarted/progressivevpp/switching.rst
@@ -80,8 +80,8 @@ bridge domain number not in use:
 .. code-block:: console
 
    vpp# show bridge-domain
-    ID   Index   Learning   U-Forwrd   UU-Flood   Flooding   ARP-Term     BVI-Intf   
-    0      0        off        off        off        off        off        local0    
+    ID   Index   Learning   U-Forwrd   UU-Flood   Flooding   ARP-Term     BVI-Intf
+    0      0        off        off        off        off        off        local0
 
 In the example above, there is bridge domain ID '0' already. Even though
 sometimes we might get feedback as below:
@@ -175,15 +175,15 @@ Examine l2 fib
 .. code-block:: console
 
     vpp# show l2fib verbose
-    Mac Address     BD Idx           Interface           Index  static  filter  bvi   Mac Age (min) 
-    de:ad:00:00:00:00    1            host-vpp1vpp2           2       0       0     0      disabled    
-    c2:f6:88:31:7b:8e    1            host-vpp1out            1       0       0     0      disabled    
+    Mac Address     BD Idx           Interface           Index  static  filter  bvi   Mac Age (min)
+    de:ad:00:00:00:00    1            host-vpp1vpp2           2       0       0     0      disabled
+    c2:f6:88:31:7b:8e    1            host-vpp1out            1       0       0     0      disabled
     2 l2fib entries
 
 .. code-block:: console
 
     vpp# show l2fib verbose
-    Mac Address     BD Idx           Interface           Index  static  filter  bvi   Mac Age (min) 
-    de:ad:00:00:00:00    1                loop0               2       1       0     1      disabled    
-    c2:f6:88:31:7b:8e    1            host-vpp2vpp1           1       0       0     0      disabled    
+    Mac Address     BD Idx           Interface           Index  static  filter  bvi   Mac Age (min)
+    de:ad:00:00:00:00    1                loop0               2       1       0     1      disabled
+    c2:f6:88:31:7b:8e    1            host-vpp2vpp1           1       0       0     0      disabled
     2 l2fib entries
diff --git a/docs/gettingstarted/progressivevpp/traces.rst b/docs/gettingstarted/progressivevpp/traces.rst
index a3408586ee8..d1dfad56a45 100644
--- a/docs/gettingstarted/progressivevpp/traces.rst
+++ b/docs/gettingstarted/progressivevpp/traces.rst
@@ -2,7 +2,7 @@
 
 .. toctree::
 
-Using the trace command 
+Using the trace command
 ========================
 
 Skills to be Learned
@@ -21,26 +21,26 @@ Basic Trace Commands
 
 Show trace buffer [max COUNT].
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# show trace
 
 Clear trace buffer and free memory.
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# clear trace
 
 filter trace output - include NODE COUNT | exclude NODE COUNT | none.
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# trace filter 
 
 Add Trace
 ----------
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# trace add af-packet-input 10
 
@@ -69,7 +69,7 @@ The following list of nodes are supported under trace add:
 Ping from Host to VPP
 ----------------------
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# q
   $ ping -c 1 10.10.1.2
@@ -80,10 +80,10 @@ Ping from Host to VPP
   1 packets transmitted, 1 received, 0% packet loss, time 0ms
   rtt min/avg/max/mdev = 0.283/0.283/0.283/0.000 ms
 
-Examine Trace of ping from host to VPP 
+Examine Trace of ping from host to VPP
 ----------------------------------------
 
-.. code-block:: console 
+.. code-block:: console
 
   $ sudo vppctl -s /run/vpp/cli-vpp1.sock
   vpp# show trace
@@ -144,14 +144,14 @@ Examine Trace of ping from host to VPP
 Clear trace buffer
 -------------------
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# clear trace
 
-Ping from VPP to Host 
+Ping from VPP to Host
 -----------------------
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# ping 10.10.1.1
   64 bytes from 10.10.1.1: icmp_seq=1 ttl=64 time=.0789 ms
@@ -167,7 +167,7 @@ Examine Trace of ping from VPP to host
 
 The output will demonstrate FD.io VPP's trace of ping for all packets.
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# show trace
   ------------------- Start of thread 0 vpp_main -------------------
@@ -465,16 +465,16 @@ After examining the trace, clear it again using vpp# clear trace.
 Examine ARP table (neighbors)
 -----------------------------
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# show ip neighbors
   Time           IP4       Flags      Ethernet              Interface
-  1101.5636    10.10.1.1      D    e2:0f:1e:59:ec:f7 host-vpp1out        
+  1101.5636    10.10.1.1      D    e2:0f:1e:59:ec:f7 host-vpp1out
 
 Examine routing tables
 -----------------------
 
-.. code-block:: console 
+.. code-block:: console
 
   vpp# show ip fib
     ipv4-VRF:0, fib_index:0, flow hash:[src dst sport dport proto ] locks:[src:plugin-hi:2, src:adjacency:1, src:default-route:1, ]
diff --git a/docs/gettingstarted/progressivevpp/twovppinstances.rst b/docs/gettingstarted/progressivevpp/twovppinstances.rst
index c6a7420fcc8..eadd4e62b12 100644
--- a/docs/gettingstarted/progressivevpp/twovppinstances.rst
+++ b/docs/gettingstarted/progressivevpp/twovppinstances.rst
@@ -64,7 +64,7 @@ Run a second FD.io VPP instance named: vpp2.
      __/ __/ _ \  (_)__    | | / / _ \/ _ \
      _/ _// // / / / _ \   | |/ / ___/ ___/
      /_/ /____(_)_/\___/   |___/_/  /_/
-    
+
     vpp# show version
     vpp v18.07-release built by root on c469eba2a593 at Mon Jul 30 23:27:03 UTC 2018
     vpp# quit
@@ -121,7 +121,7 @@ Ping 10.10.2.2 from vpp1
 
 .. code-block:: console
 
-    $ ping 10.10.2.2 
+    $ ping 10.10.2.2
 
 Ping 10.10.2.1 from vpp2
 
diff --git a/docs/gettingstarted/running/index.rst b/docs/gettingstarted/running/index.rst
new file mode 100644
index 00000000000..626be6c7deb
--- /dev/null
+++ b/docs/gettingstarted/running/index.rst
@@ -0,0 +1,121 @@
+.. _running:
+
+Running VPP
+===========
+
+.. toctree::
+
+Usergroup
+---------
+
+When VPP is installed, a new usergroup *'vpp'* is created. To avoid running the
+VPP CLI (vppctl) as root, add any existing users to the new group that need to
+interact with VPP:
+
+.. code-block:: console
+
+    $ sudo usermod -a -G vpp user1
+
+Update your current session for the group change to take effect:
+
+.. code-block:: console
+
+    $ newgrp vpp
+
+
+Systemd File vpp.service
+------------------------
+
+When the VPP is installed, a systemd service files is also installed. This
+file, vpp.service (Ubuntu: /lib/systemd/system/vpp.service and CentOS:
+/usr/lib/systemd/system/vpp.service), controls how VPP is run as a service. For
+example, whether or not to restart on failure and if so, with how much delay.
+Also, which UIO driver should be loaded and location of the *'startup.conf'*
+file.
+
+.. code-block:: console
+
+    $ cat /usr/lib/systemd/system/vpp.service
+    [Unit]
+    Description=Vector Packet Processing Process
+    After=syslog.target network.target auditd.service
+
+    [Service]
+    ExecStartPre=-/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
+    ExecStartPre=-/sbin/modprobe uio_pci_generic
+    ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
+    Type=simple
+    Restart=on-failure
+    RestartSec=5s
+
+    [Install]
+    WantedBy=multi-user.target
+
+.. note::
+
+    Some older versions of the *'uio_pci_generic'* driver don't bind all
+    the supported NICs properly, so the *'igb_uio'* driver built from DPDK
+    needs to be installed. This file controls which driver is loaded at boot.
+    *'startup.conf'* file controls which driver is used.
+
+Huge Pages
+----------
+
+VPP requires *hugepages* to run during VPP operation, to manage large pages of memory.
+During VPP installation, VPP will overwrite the existing hugepage settings.
+By default, VPP sets the number of hugepages on a system to 1024 2M hugepages.
+This is the number of hugepages on the system, not just used by VPP.
+
+When VPP is installed, the following configuration file is copied to the system. The
+hugepage settings are applied in the VPP installation and on system reboots. To set
+the hugepage settings, perform the following commands:
+
+.. code-block:: console
+
+    $ cat /etc/sysctl.d/80-vpp.conf
+    # Number of 2MB hugepages desired
+    vm.nr_hugepages=1024
+
+    # Must be greater than or equal to (2 * vm.nr_hugepages).
+    vm.max_map_count=3096
+
+    # All groups allowed to access hugepages
+    vm.hugetlb_shm_group=0
+
+    # Shared Memory Max must be greater or equal to the total size of hugepages.
+    # For 2MB pages, TotalHugepageSize = vm.nr_hugepages * 2 * 1024 * 1024
+    # If the existing kernel.shmmax setting  (cat /sys/proc/kernel/shmmax)
+    # is greater than the calculated TotalHugepageSize then set this parameter
+    # to current shmmax value.
+    kernel.shmmax=2147483648
+
+Depending on how the system is being used, this configuration file can be updated to adjust
+the number of hugepages reserved on a system. Below are some examples of
+possible settings.
+
+For a small VM with minimal workload:
+
+.. code-block:: console
+
+    vm.nr_hugepages=512
+    vm.max_map_count=2048
+    kernel.shmmax=1073741824
+
+For a large system running multiple VMs, each needing its own set of hugepages:
+
+.. code-block:: console
+
+    vm.nr_hugepages=32768
+    vm.max_map_count=66560
+    kernel.shmmax=68719476736
+
+
+.. note::
+
+    If VPP is being run in a Virtual Machine (VM), the VM must have hugepage
+    backing. When VPP is installed, it will attempt to overwrite existing the
+    hugepage setting. If the VM does not have hugepage backing, the install will fail,
+    but the failure may go unnoticed. When the VM is rebooted, on system startup,
+    *'vm.nr_hugepages'* will be reapplied, and will fail, and the VM will abort kernel
+    boot, locking up the VM. To avoid this scenario, ensure the VM has enough
+    hugepage backing.
diff --git a/docs/gettingstarted/troubleshooting/cpuusage.rst b/docs/gettingstarted/troubleshooting/cpuusage.rst
new file mode 100644
index 00000000000..9b4514e128e
--- /dev/null
+++ b/docs/gettingstarted/troubleshooting/cpuusage.rst
@@ -0,0 +1,112 @@
+.. _cpuusage:
+
+**************
+CPU Load/Usage
+**************
+
+There are various commands and tools that can help users see FD.io VPP CPU and memory usage at runtime.
+
+Linux top/htop
+==============
+
+The Linux top and htop are decent tools to look at FD.io VPP cpu and memory usage, but they will only show
+preallocated memory and total CPU usage. These commands can be useful to show which cores VPP is running on.
+
+This is an example of VPP instance that is running on cores 8 and 9. For this output type **top** and then
+type **1** when the tool starts.
+
+.. code-block:: console
+
+    $ top
+
+    top - 11:04:04 up 35 days,  3:16,  5 users,  load average: 2.33, 2.23, 2.16
+    Tasks: 435 total,   2 running, 432 sleeping,   1 stopped,   0 zombie
+    %Cpu0  :  1.0 us,  0.7 sy,  0.0 ni, 98.0 id,  0.0 wa,  0.0 hi,  0.3 si,  0.0 st
+    %Cpu1  :  2.0 us,  0.3 sy,  0.0 ni, 97.7 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu2  :  0.7 us,  1.0 sy,  0.0 ni, 98.3 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu3  :  1.7 us,  0.7 sy,  0.0 ni, 97.7 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu4  :  2.0 us,  0.7 sy,  0.0 ni, 97.4 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu5  :  3.0 us,  0.3 sy,  0.0 ni, 96.7 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu6  :  2.3 us,  0.7 sy,  0.0 ni, 97.0 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu7  :  2.6 us,  0.3 sy,  0.0 ni, 97.0 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu8  : 96.0 us,  0.3 sy,  0.0 ni,  3.6 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu9  :100.0 us,  0.0 sy,  0.0 ni,  0.0 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    %Cpu10 :  1.0 us,  0.3 sy,  0.0 ni, 98.7 id,  0.0 wa,  0.0 hi,  0.0 si,  0.0 st
+    ....
+
+VPP Memory Usage
+================
+
+For details on VPP memory usage you can use the **show memory** command
+
+This is the example VPP memory usage on 2 cores.
+
+.. code-block:: console
+
+    # vppctl show memory verbose
+    Thread 0 vpp_main
+    22043 objects, 17878k of 20826k used, 2426k free, 2396k reclaimed, 346k overhead, 1048572k capacity
+      alloc. from small object cache: 22875 hits 39973 attempts (57.23%) replacements 5143
+      alloc. from free-list: 44732 attempts, 26017 hits (58.16%), 528461 considered (per-attempt 11.81)
+      alloc. from vector-expand: 3430
+      allocs: 52324 2027.84 clocks/call
+      frees: 30280 594.38 clocks/call
+    Thread 1 vpp_wk_0
+    22043 objects, 17878k of 20826k used, 2427k free, 2396k reclaimed, 346k overhead, 1048572k capacity
+      alloc. from small object cache: 22881 hits 39984 attempts (57.23%) replacements 5148
+      alloc. from free-list: 44736 attempts, 26021 hits (58.17%), 528465 considered (per-attempt 11.81)
+      alloc. from vector-expand: 3430
+      allocs: 52335 2027.54 clocks/call
+      frees: 30291 594.36 clocks/call
+
+VPP CPU Load
+============
+
+To find the VPP CPU load or how busy VPP is use the **show runtime** command.
+
+With at least one interface in polling mode, the VPP CPU utilization is always 100%.
+
+A good indicator of CPU load is **"average vectors/node"**. A bigger number means VPP
+is more busy but also more efficient. The Maximum value is 255 (unless you change VLIB_FRAME_SIZE in code).
+It basically means how many packets are processed in batch.
+
+If VPP is not loaded it will likely poll so fast that it will just get one or few
+packets from the rx queue. This is the case shown below on Thread 1. As load goes up vpp
+will have more work to do, so it will poll less frequently, and that will result in more
+packets waiting in rx queue. More packets will result in more efficient execution of the
+code so number of clock cycles / packet will go down. When "average vectors/node" goes up
+close to 255, you will likely start observing rx queue tail drops.
+
+.. code-block:: console
+
+    # vppctl show run
+    Thread 0 vpp_main (lcore 8)
+    Time 6152.9, average vectors/node 0.00, last 128 main loops 0.00 per node 0.00
+      vector rates in 0.0000e0, out 0.0000e0, drop 0.0000e0, punt 0.0000e0
+                 Name                 State         Calls          Vectors        Suspends         Clocks       Vectors/Call
+    acl-plugin-fa-cleaner-process  event wait                0               0               1          3.66e4            0.00
+    admin-up-down-process          event wait                0               0               1          2.54e3            0.00
+    ....
+    ---------------
+    Thread 1 vpp_wk_0 (lcore 9)
+    Time 6152.9, average vectors/node 1.00, last 128 main loops 0.00 per node 0.00
+      vector rates in 1.3073e2, out 1.3073e2, drop 6.5009e-4, punt 0.0000e0
+                 Name                 State         Calls          Vectors        Suspends         Clocks       Vectors/Call
+    TenGigabitEthernet86/0/0-outpu   active             804395          804395               0          6.17e2            1.00
+    TenGigabitEthernet86/0/0-tx      active             804395          804395               0          7.29e2            1.00
+    arp-input                        active                  2               2               0          3.82e4            1.00
+    dpdk-input                       polling       24239296364          804398               0          1.59e7            0.00
+    error-drop                       active                  4               4               0          4.65e3            1.00
+    ethernet-input                   active                  2               2               0          1.08e4            1.00
+    interface-output                 active                  1               1               0          3.78e3            1.00
+    ip4-glean                        active                  1               1               0          6.98e4            1.00
+    ip4-icmp-echo-request            active             804394          804394               0          5.02e2            1.00
+    ip4-icmp-input                   active             804394          804394               0          4.63e2            1.00
+    ip4-input-no-checksum            active             804394          804394               0          8.51e2            1.00
+    ip4-load-balance                 active             804394          804394               0          5.46e2            1.00
+    ip4-local                        active             804394          804394               0          5.79e2            1.00
+    ip4-lookup                       active             804394          804394               0          5.71e2            1.00
+    ip4-rewrite                      active             804393          804393               0          5.69e2            1.00
+    ip6-input                        active                  2               2               0          5.72e3            1.00
+    ip6-not-enabled                  active                  2               2               0          1.56e4            1.00
+    unix-epoll-input                 polling            835722               0               0         3.03e-3            0.00
diff --git a/docs/gettingstarted/troubleshooting/index.rst b/docs/gettingstarted/troubleshooting/index.rst
new file mode 100644
index 00000000000..d70c19042c8
--- /dev/null
+++ b/docs/gettingstarted/troubleshooting/index.rst
@@ -0,0 +1,14 @@
+.. _troubleshooting:
+
+###############
+Troubleshooting
+###############
+
+This chapter describes some of the many techniques used to troubleshoot and diagnose
+problem with FD.io VPP implementations.
+
+.. toctree::
+
+    cpuusage
+    sanitizer
+    mem
diff --git a/docs/gettingstarted/troubleshooting/mem.rst b/docs/gettingstarted/troubleshooting/mem.rst
new file mode 100644
index 00000000000..630b0af02f3
--- /dev/null
+++ b/docs/gettingstarted/troubleshooting/mem.rst
@@ -0,0 +1,87 @@
+.. _memleak:
+
+*****************
+Memory leaks
+*****************
+
+Memory traces
+=============
+
+VPP supports memory traces to help debug (suspected) memory leaks. Each
+allocation/deallocation is instrumented so that the number of allocations and
+current global allocated size is maintained for each unique allocation stack
+trace.
+
+Looking at a memory trace can help diagnose where memory is (over-)used, and
+comparing memory traces at different point in time can help diagnose if and
+where memory leaks happen.
+
+To enable memory traces on main-heap:
+
+.. code-block:: console
+
+    $ vppctl memory-trace on main-heap
+
+To dump memory traces for analysis:
+
+.. code-block:: console
+
+    $ vppctl show memory-trace on main-heap
+    Thread 0 vpp_main
+      base 0x7fffb6422000, size 1g, locked, unmap-on-destroy, name 'main heap'
+	page stats: page-size 4K, total 262144, mapped 30343, not-mapped 231801
+	  numa 0: 30343 pages, 118.53m bytes
+	total: 1023.99M, used: 115.49M, free: 908.50M, trimmable: 908.48M
+	  free chunks 451 free fastbin blks 0
+	  max total allocated 1023.99M
+
+      Bytes    Count     Sample   Traceback
+     31457440        1 0x7fffbb31ad00 clib_mem_alloc_aligned_at_offset + 0x80
+				      clib_mem_alloc_aligned + 0x26
+				      alloc_aligned_8_8 + 0xe1
+				      clib_bihash_instantiate_8_8 + 0x76
+				      clib_bihash_init2_8_8 + 0x2ec
+				      clib_bihash_init_8_8 + 0x6a
+				      l2fib_table_init + 0x54
+				      set_int_l2_mode + 0x89
+				      int_l3 + 0xb4
+				      vlib_cli_dispatch_sub_commands + 0xeee
+				      vlib_cli_dispatch_sub_commands + 0xc62
+				      vlib_cli_dispatch_sub_commands + 0xc62
+       266768     5222 0x7fffbd79f978 clib_mem_alloc_aligned_at_offset + 0x80
+				      vec_resize_allocate_memory + 0xa8
+				      _vec_resize_inline + 0x240
+				      unix_cli_file_add + 0x83d
+				      unix_cli_listen_read_ready + 0x10b
+				      linux_epoll_input_inline + 0x943
+				      linux_epoll_input + 0x39
+				      dispatch_node + 0x336
+				      vlib_main_or_worker_loop + 0xbf1
+				      vlib_main_loop + 0x1a
+				      vlib_main + 0xae7
+				      thread0 + 0x3e
+    ....
+
+libc memory traces
+==================
+
+Internal VPP memory allocations rely on VPP main-heap, however when using
+external libraries, esp. in plugins (e.g. OpenSSL library used by the IKEv2
+plugin), those external libraries usually manages memory using the standard
+libc malloc()/free()/... calls. This, in turn, makes use of the default
+libc heap.
+
+VPP has no knowledge of this heap and tools such as memory traces cannot be
+used.
+
+In order to enable the use of standard VPP debugging tools, this library
+replaces standard libc memory management calls with version using VPP
+main-heap.
+
+To use it, you need to use the `LD_PRELOAD` mechanism, e.g.
+
+.. code-block:: console
+
+    ~# LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libvppmem_preload.so /usr/bin/vpp -c /etc/vpp/startup.conf
+
+You can then use tools such as memory traces as usual.
diff --git a/docs/gettingstarted/troubleshooting/sanitizer.rst b/docs/gettingstarted/troubleshooting/sanitizer.rst
new file mode 100644
index 00000000000..217f5e57182
--- /dev/null
+++ b/docs/gettingstarted/troubleshooting/sanitizer.rst
@@ -0,0 +1,45 @@
+.. _sanitizer:
+
+*****************
+Google Sanitizers
+*****************
+
+VPP is instrumented to support `Google Sanitizers `_.
+As of today, only `AddressSanitizer `_
+is supported, both for GCC and clang.
+
+AddressSanitizer
+================
+
+`AddressSanitizer `_  (aka ASan) is a memory
+error detector for C/C++. Think Valgrind but much faster.
+
+In order to use it, VPP must be recompiled with ASan support. It is implemented as a cmake
+build option, so all VPP targets should be supported. For example:
+
+.. code-block:: console
+
+    # build a debug image with ASan support:
+    $ make rebuild VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON
+    ....
+
+    # build a release image with ASan support:
+    $ make rebuild-release VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON
+    ....
+
+    # build packages in debug mode with ASan support:
+    $ make pkg-deb-debug VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON
+    ....
+
+    # run GBP plugin tests in debug mode with ASan
+    $ make test-debug TEST=test_gbp VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON
+    ....
+
+Once VPP has been built with ASan support you can use it as usual including
+under gdb:
+
+.. code-block:: console
+
+    $ gdb --args $PWD/build-root/install-vpp_debug-native/vpp/bin/vpp "unix { interactive }"
+    ....
+
diff --git a/docs/gettingstarted/users/configuring/hugepages.rst b/docs/gettingstarted/users/configuring/hugepages.rst
deleted file mode 100644
index 7a1e0bd8057..00000000000
--- a/docs/gettingstarted/users/configuring/hugepages.rst
+++ /dev/null
@@ -1,63 +0,0 @@
-.. _hugepages:
-
-Huge Pages
-----------
-
-VPP requires *hugepages* to run during VPP operation, to manage large pages of memory.
-During VPP installation, VPP will overwrite the existing hugepage settings.
-By default, VPP sets the number of hugepages on a system to 1024 2M hugepages.
-This is the number of hugepages on the system, not just used by VPP. 
-
-When VPP is installed, the following configuration file is copied to the system. The
-hugepage settings are applied in the VPP installation and on system reboots. To set
-the hugepage settings, perform the following commands:
-
-.. code-block:: console
-
-    $ cat /etc/sysctl.d/80-vpp.conf
-    # Number of 2MB hugepages desired
-    vm.nr_hugepages=1024
-    
-    # Must be greater than or equal to (2 * vm.nr_hugepages).
-    vm.max_map_count=3096
-    
-    # All groups allowed to access hugepages
-    vm.hugetlb_shm_group=0
-    
-    # Shared Memory Max must be greater or equal to the total size of hugepages.
-    # For 2MB pages, TotalHugepageSize = vm.nr_hugepages * 2 * 1024 * 1024
-    # If the existing kernel.shmmax setting  (cat /sys/proc/kernel/shmmax)
-    # is greater than the calculated TotalHugepageSize then set this parameter
-    # to current shmmax value.
-    kernel.shmmax=2147483648
-
-Depending on how the system is being used, this configuration file can be updated to adjust
-the number of hugepages reserved on a system. Below are some examples of
-possible settings.
- 
-For a small VM with minimal workload:
-
-.. code-block:: console
-
-    vm.nr_hugepages=512
-    vm.max_map_count=2048
-    kernel.shmmax=1073741824
-
-For a large system running multiple VMs, each needing its own set of hugepages:
-
-.. code-block:: console
-
-    vm.nr_hugepages=32768
-    vm.max_map_count=66560
-    kernel.shmmax=68719476736
-
-
-.. note::
-
-    If VPP is being run in a Virtual Machine (VM), the VM must have hugepage
-    backing. When VPP is installed, it will attempt to overwrite existing the
-    hugepage setting. If the VM does not have hugepage backing, the install will fail,
-    but the failure may go unnoticed. When the VM is rebooted, on system startup,
-    *'vm.nr_hugepages'* will be reapplied, and will fail, and the VM will abort kernel
-    boot, locking up the VM. To avoid this scenario, ensure the VM has enough
-    hugepage backing.
diff --git a/docs/gettingstarted/users/configuring/index.rst b/docs/gettingstarted/users/configuring/index.rst
deleted file mode 100644
index 0de77adea6c..00000000000
--- a/docs/gettingstarted/users/configuring/index.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-.. _configuring:
-
-Configuring VPP
-==================
-
-There is some basic configuration that needs to be performed before running
-FD.io VPP.  This section describes the configuration process:
-
-.. toctree::
-   :maxdepth: 2
-
-   hugepages
-   startup
diff --git a/docs/gettingstarted/users/configuring/startup.rst b/docs/gettingstarted/users/configuring/startup.rst
deleted file mode 100644
index e594b6a08a4..00000000000
--- a/docs/gettingstarted/users/configuring/startup.rst
+++ /dev/null
@@ -1,1683 +0,0 @@
-.. _startup:
-
-==========================================
-VPP Configuration - CLI and 'startup.conf'
-==========================================
-
-After a successful installation, VPP installs a startup config file named
-*startup.conf* in the */etc/vpp/* directory. This file can be tailored to
-make VPP run as desired, but contains default values for typical installations.
-
-Below are more details about this file and some of the the parameters and values
-it contains.
-
-Command-line Arguments
-----------------------
-
-Before we describe details of the startup configuration file (startup.conf) it
-should be mentioned that VPP can be started without a startup configuration
-file.
-
-Parameters are grouped by a section name. When providing more than one
-parameter to a section, all parameters for that section must be wrapped in
-curly braces. For example, to start VPP with configuration data via the
-command line with the section name *'unix'*:
-
-.. code-block:: console
-
-    $ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 }
-
-The command line can be presented as a single string or as several; anything
-given on the command line is concatenated with spaces into a single string
-before parsing. VPP applications must be able to locate their own executable
-images. The simplest way to ensure this will work is to invoke a VPP
-application by giving its absolute path. For example:
-*'/usr/bin/vpp '*  At startup, VPP applications parse through their
-own ELF-sections [primarily] to make lists of init, configuration, and exit
-handlers.
-
-When developing with VPP, in gdb it's often sufficient to start an application
-like this:
-
-.. code-block:: console
-
-    (gdb) run unix interactive
-
-
-Startup Configuration File (startup.conf)
------------------------------------------
-
-The more typical way to specify the startup configuration to VPP is with the
-startup configuration file (startup.conf).
-
-The path of the file is provided to the VPP application on the command line.
-This is typically at /etc/vpp/startup.conf. If VPP is installed as a package
-a default startup.conf file is provided at this location.
-
-The format of the configuration file is a simple text file with the same content
-as the command line.
-
-**A very simple startup.conf file:**
-
-.. code-block:: console
-
-    $ cat /etc/vpp/startup.conf
-    unix {
-      nodaemon
-      log /var/log/vpp/vpp.log
-      full-coredump
-      cli-listen localhost:5002
-    }
-
-    api-trace {
-      on
-    }
-
-    dpdk {
-      dev 0000:03:00.0
-    }
-
-VPP is instructed to load this file with the -c option. For example:
-
-.. code-block:: console
-
-    $ sudo /usr/bin/vpp -c /etc/vpp/startup.conf
-
-Configuration Parameters
-------------------------
-
-Below is the list of some section names and their associated parameters.
-This is not an exhaustive list, but should give you an idea of how VPP can be configured.
-
-For all of the configuration parameters search the source code for instances of
-**VLIB_CONFIG_FUNCTION** and **VLIB_EARLY_CONFIG_FUNCTION**.
-
-For example, the invocation *'VLIB_CONFIG_FUNCTION (foo_config, "foo")'* will
-cause the function *'foo_config'* to receive all parameters given in a
-parameter block named "foo": "foo { arg1 arg2 arg3 ... }".
-
-The unix section
-----------------
-
-Configures VPP startup and behavior type attributes, as well and any OS based
-attributes.
-
-.. code-block:: console
-
-  unix {
-    nodaemon
-    log /var/log/vpp/vpp.log
-    full-coredump
-    cli-listen /run/vpp/cli.sock
-    gid vpp
-  }
-
-nodaemon
-^^^^^^^^
-
-Do not fork / background the vpp process. Typical when invoking VPP
-applications from a process monitor. Set by default in the default
-*'startup.conf'* file.
-
-.. code-block:: console
-
-   nodaemon
-
-nosyslog
-^^^^^^^^
-
-Disable syslog and log errors to stderr instead. Typical when invoking
-VPP applications from a process monitor like runit or daemontools that
-pipe service's output to a dedicated log service, which will typically
-attach a timestamp and rotate the logs as necessary.
-
-.. code-block:: console
-
-   nosyslog
-
-interactive
-^^^^^^^^^^^
-
-Attach CLI to stdin/out and provide a debugging command line interface.
-
-.. code-block:: console
-
-   interactive
-
-log 
-^^^^^^^^^^^^^^
-
-Logs the startup configuration and all subsequent CLI commands in filename.
-Very useful in situations where folks don't remember or can't be bothered
-to include CLI commands in bug reports. The default *'startup.conf'* file
-is to write to *'/var/log/vpp/vpp.log'*.
-
-In VPP 18.04, the default log file location was moved from '/tmp/vpp.log'
-to '/var/log/vpp/vpp.log' . The VPP code is indifferent to the file location.
-However, if SELinux is enabled, then the new location is required for the file
-to be properly labeled. Check your local *'startup.conf'* file for the log file
-location on your system.
-
-.. code-block:: console
-
-   log /var/log/vpp/vpp-debug.log
-
-exec | startup-config 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Read startup operational configuration from filename. The contents of the file
-will be performed as though entered at the CLI. The two keywords are aliases
-for the same function; if both are specified, only the last will have an effect.
-
-A file of CLI commands might look like:
-
-.. code-block:: console
-
-   $ cat /usr/share/vpp/scripts/interface-up.txt
-   set interface state TenGigabitEthernet1/0/0 up
-   set interface state TenGigabitEthernet1/0/1 up
-
-Parameter Example:
-
-.. code-block:: console
-
-     startup-config /usr/share/vpp/scripts/interface-up.txt
-
-gid 
-^^^^^^^^^^^^^^^^^^^
-
-Sets the effective group ID to the input group ID or group name of the calling
-process.
-
-.. code-block:: console
-
-   gid vpp
-
-full-coredump
-^^^^^^^^^^^^^
-
-Ask the Linux kernel to dump all memory-mapped address regions, instead of
-just text+data+bss.
-
-.. code-block:: console
-
-   full-coredump
-
-coredump-size unlimited | G | M | K | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Set the maximum size of the coredump file. The input value can be set in
-     GB, MB, KB or bytes, or set to *'unlimited'*.
-
-.. code-block:: console
-
-   coredump-size unlimited
-
-cli-listen  | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Bind the CLI to listen at address localhost on TCP port 5002. This will
-     accept an ipaddress:port pair or a filesystem path; in the latter case a
-     local Unix socket is opened instead. The default *'startup.conf'* file
-     is to open the socket *'/run/vpp/cli.sock'*.
-
-.. code-block:: console
-
-     cli-listen localhost:5002
-     cli-listen /run/vpp/cli.sock
-
-cli-line-mode
-^^^^^^^^^^^^^
-
-     Disable character-by-character I/O on stdin. Useful when combined with,
-     for example, emacs M-x gud-gdb.
-
-.. code-block:: console
-
-   cli-line-mode
-
-cli-prompt 
-^^^^^^^^^^^^^^^^^^^
-
-     Configure the CLI prompt to be string.
-
-.. code-block:: console
-
-     cli-prompt vpp-2
-
-cli-history-limit 
-^^^^^^^^^^^^^^^^^^^^^
-
-     Limit command history to  lines. A value of 0 disables command history.
-     Default value: 50
-
-.. code-block:: console
-
-     cli-history-limit 100
-
-cli-no-banner
-^^^^^^^^^^^^^
-
-     Disable the login banner on stdin and Telnet connections.
-
-.. code-block:: console
-
-     cli-no-banner
-
-cli-no-pager
-^^^^^^^^^^^^
-
-     Disable the output pager.
-
-.. code-block:: console
-
-     cli-no-pager
-
-cli-pager-buffer-limit 
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Limit pager buffer to  lines of output. A value of 0 disables the
-     pager. Default value: 100000
-
-.. code-block:: console
-
-     cli-pager-buffer-limit 5000
-
-runtime-dir 
-^^^^^^^^^^^^^^^^^
-
-     Set the runtime directory, which is the default location for certain
-     files, like socket files. Default is based on User ID used to start VPP.
-     Typically it is *'root'*, which defaults to *'/run/vpp/'*. Otherwise,
-     defaults to *'/run/user//vpp/'*.
-
-.. code-block:: console
-
-     runtime-dir /tmp/vpp
-
-poll-sleep-usec 
-^^^^^^^^^^^^^^^^^^^
-
-     Add a fixed-sleep between main loop poll. Default is 0, which is not to
-     sleep.
-
-.. code-block:: console
-
-     poll-sleep-usec 100
-
-pidfile 
-^^^^^^^^^^^^^^^^^^
-
-     Writes the pid of the main thread in the given filename.
-
-.. code-block:: console
-
-     pidfile /run/vpp/vpp1.pid
-
-
-The api-trace Section
----------------------
-
-The ability to trace, dump, and replay control-plane API traces makes all the
-difference in the world when trying to understand what the control-plane has
-tried to ask the forwarding-plane to do.
-
-Typically, one simply enables the API message trace scheme:
-
-.. code-block:: console
-
-   api-trace {
-     api-trace on
-   }
-
-on | enable
-^^^^^^^^^^^
-
-     Enable API trace capture from the beginning of time, and arrange for a
-     post-mortem dump of the API trace if the application terminates abnormally.
-     By default, the (circular) trace buffer will be configured to capture
-     256K traces. The default *'startup.conf'* file has trace enabled by default,
-     and unless there is a very strong reason, it should remain enabled.
-
-.. code-block:: console
-
-    on
-
-nitems 
-^^^^^^^^^^
-
-     Configure the circular trace buffer to contain the last  entries. By
-     default, the trace buffer captures the last 256K API messages received.
-
-.. code-block:: console
-
-    nitems 524288
-
-save-api-table 
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Dumps the API message table to /tmp/.
-
-.. code-block:: console
-
-    save-api-table apiTrace-07-04.txt
-
-
-The api-segment Section
------------------------
-
-These values control various aspects of the binary API interface to VPP.
-
-The default looks like the following:
-
-.. code-block:: console
-
-   api-segment {
-     gid vpp
-   }
-
-
-prefix 
-^^^^^^^^^^^^^
-
-     Sets the prefix prepended to the name used for shared memory (SHM)
-     segments. The default is empty, meaning shared memory segments are created
-     directly in the SHM directory *'/dev/shm'*. It is worth noting that on
-     many systems *'/dev/shm'* is a symbolic link to somewhere else in the file
-     system; Ubuntu links it to *'/run/shm'*.
-
-.. code-block:: console
-
-    prefix /run/shm
-
-uid 
-^^^^^^^^^^^^^^^^^^^
-
-     Sets the user ID or name that should be used to set the ownership of the
-     shared memory segments. Defaults to the same user that VPP is started
-     with, probably root.
-
-.. code-block:: console
-
-    uid root
-
-gid 
-^^^^^^^^^^^^^^^^^^^
-
-     Sets the group ID or name that should be used to set the ownership of the
-     shared memory segments. Defaults to the same group that VPP is started
-     with, probably root.
-
-.. code-block:: console
-
-    gid vpp
-
-**The following parameters should only be set by those that are familiar with the
-interworkings of VPP.**
-
-baseva 
-^^^^^^^^^^
-
-     Set the base address for SVM global region. If not set, on AArch64, the
-     code will try to determine the base address. All other default to
-     0x30000000.
-
-.. code-block:: console
-
-    baseva 0x20000000
-
-global-size G | M | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Set the global memory size, memory shared across all router instances,
-     packet buffers, etc. If not set, defaults to 64M. The input value can be
-     set in GB, MB or bytes.
-
-.. code-block:: console
-
-    global-size 2G
-
-global-pvt-heap-size M | size 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Set the size of the global VM private mheap. If not set, defaults to 128k.
-     The input value can be set in MB or bytes.
-
-.. code-block:: console
-
-    global-pvt-heap-size size 262144
-
-api-pvt-heap-size M | size 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Set the size of the api private mheap. If not set, defaults to 128k.
-     The input value can be set in MB or bytes.
-
-.. code-block:: console
-
-    api-pvt-heap-size 1M
-
-api-size M | G | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-     Set the size of the API region. If not set, defaults to 16M. The input
-     value can be set in GB, MB or bytes.
-
-.. code-block:: console
-
-    api-size 64M
-
-The socksvr Section
--------------------
-
-Enables a Unix domain socket which processes binary API messages. See
-.../vlibmemory/socket_api.c.  If this parameter is not set, vpp
-won't process binary API messages over sockets.
-
-.. code-block:: console
-
-   socksvr {
-      # Explicitly name a socket file
-      socket-name /run/vpp/api.sock
-      or
-      # Use defaults as described below
-      default
-   }
-
-The "default" keyword instructs vpp to use /run/vpp/api.sock when
-running as root, otherwise to use /run/user//api.sock.
-
-The cpu Section
----------------
-
-In the VPP there is one main thread and optionally the user can create worker(s)
-The main thread and worker thread(s) can be pinned to CPU core(s) manually or automatically
-
-.. code-block:: console
-
-   cpu {
-      main-core 1
-      corelist-workers 2-3,18-19
-   }
-
-
-Manual pinning of thread(s) to CPU core(s)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-main-core
-^^^^^^^^^
-
-Set logical CPU core where main thread runs, if main core is not set VPP will use
-core 1 if available
-
-.. code-block:: console
-
-   main-core 1
-
-corelist-workers
-^^^^^^^^^^^^^^^^
-
-Set logical CPU core(s) where worker threads are running
-
-.. code-block:: console
-
-   corelist-workers 2-3,18-19
-
-Automatic pinning of thread(s) to CPU core(s)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-skip-cores number
-^^^^^^^^^^^^^^^^^
-
-Sets number of CPU core(s) to be skipped (1 ... N-1), Skipped CPU core(s) are
-not used for pinning main thread and working thread(s).
-
-The main thread is automatically pinned to the first available CPU core and worker(s)
-are pinned to next free CPU core(s) after core assigned to main thread
-
-.. code-block:: console
-
-   skip-cores 4
-
-workers number
-^^^^^^^^^^^^^^
-
-Specify a number of workers to be created Workers are pinned to N consecutive
-CPU cores while skipping "skip-cores" CPU core(s) and main thread's CPU core
-
-.. code-block:: console
-
-   workers 2
-
-scheduler-policy other | batch | idle | fifo | rr
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Set scheduling policy and priority of main and worker threads
-
-Scheduling policy options are: other (SCHED_OTHER), batch (SCHED_BATCH)
-idle (SCHED_IDLE), fifo (SCHED_FIFO), rr (SCHED_RR)
-
-.. code-block:: console
-
-   scheduler-policy fifo
-
-scheduler-priority number
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Scheduling priority is used only for "real-time policies (fifo and rr),
-and has to be in the range of priorities supported for a particular policy
-
-.. code-block:: console
-
-   scheduler-priority 50
-
-The buffers Section
--------------------
-
-.. code-block:: console
-
-   buffers {
-      buffers-per-numa 128000
-      default data-size 2048
-      page-size default-hugepage
-   }
-
-buffers-per-numa number
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Increase number of buffers allocated, needed only in scenarios with
-large number of interfaces and worker threads. Value is per numa node.
-Default is 16384 (8192 if running unpriviledged)
-
-.. code-block:: console
-
-   buffers-per-numa 128000
-
-default data-size number
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-Size of buffer data area, default is 2048
-
-.. code-block:: console
-
-   default data-size 2048
-
-page-size number
-^^^^^^^^^^^^^^^^
-
-Set the page size for buffer allocation
-
-.. code-block:: console
-
-   page-size 4K
-   page-size 2M
-   page-size 1G
-   page-size default
-   page-size default-hugepage
-
-
-The dpdk Section
-----------------
-
-.. code-block:: console
-
-   dpdk {
-      dev default {
-         num-rx-desc 512
-         num-tx-desc 512
-      }
-
-      dev 0000:02:00.1 {
-         num-rx-queues 2
-         name eth0
-      }
-   }
-
-dev  | default { .. }
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-White-list [as in, attempt to drive] a specific PCI device. PCI-dev is a
-string of the form "DDDD:BB:SS.F" where:
-
-* DDDD = Domain
-* BB = Bus Number
-* SS = Slot number
-* F = Function
-
-If the keyword **default** is used the values will apply to all the devices.
-
-This is the same format used in the linux sysfs tree (i.e./sys/bus/pci/devices)
-for PCI device directory names.
-
-.. code-block:: console
-
-   dpdk {
-      dev default {
-         num-rx-desc 512
-         num-tx-desc 512
-      }
-
-dev  { .. }
-^^^^^^^^^^^^^^^^^^^^
-
-Whitelist specific interface by specifying PCI address. When whitelisting specific
-interfaces by specifying PCI address, additional custom parameters can also be
-specified. Valid options include:
-
-.. code-block:: console
-
-   dev 0000:02:00.0
-   dev 0000:03:00.0
-
-blacklist 
-^^^^^^^^^^^^^^^^^^^
-
-Blacklist specific device type by specifying PCI vendor:device Whitelist entries
-take precedence
-
-.. code-block:: console
-
-   blacklist 8086:10fb
-
-name interface-name
-^^^^^^^^^^^^^^^^^^^
-
-Set interface name
-
-.. code-block:: console
-
-   dev 0000:02:00.1 {
-      name eth0
-   }
-
-num-rx-queues 
-^^^^^^^^^^^^^^^^^
-
-Number of receive queues. Also enables RSS. Default value is 1.
-
-.. code-block:: console
-
-   dev 0000:02:00.1 {
-      num-rx-queues 
-   }
-
-num-tx-queues 
-^^^^^^^^^^^^^^^^^
-
-Number of transmit queues. Default is equal to number of worker threads
-or 1 if no workers treads.
-
-.. code-block:: console
-
-   dev 000:02:00.1 {
-      num-tx-queues 
-   }
-
-num-rx-desc 
-^^^^^^^^^^^^^^^
-
-Number of descriptors in receive ring. Increasing or reducing number
-can impact performance. Default is 1024.
-
-.. code-block:: console
-
-   dev 000:02:00.1 {
-      num-rx-desc 
-   }
-
-vlan-strip-offload on | off
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-VLAN strip offload mode for interface. VLAN stripping is off by default
-for all NICs except VICs, using ENIC driver, which has VLAN stripping on
-by default.
-
-.. code-block:: console
-
-   dev 000:02:00.1 {
-      vlan-strip-offload on|off
-   }
-
-uio-driver driver-name
-^^^^^^^^^^^^^^^^^^^^^^
-
-Change UIO driver used by VPP, Options are: igb_uio, vfio-pci, uio_pci_generic
-or auto (default)
-
-
-.. code-block:: console
-
-   uio-driver vfio-pci
-
-no-multi-seg
-^^^^^^^^^^^^
-
-Disable multi-segment buffers, improves performance but disables Jumbo MTU support
-
-.. code-block:: console
-
-   no-multi-seg
-
-socket-mem 
-^^^^^^^^^^^^^^
-
-Change hugepages allocation per-socket, needed only if there is need for
-larger number of mbufs. Default is 256M on each detected CPU socket
-
-.. code-block:: console
-
-   socket-mem 2048,2048
-
-no-tx-checksum-offload
-^^^^^^^^^^^^^^^^^^^^^^
-
-Disables UDP / TCP TX checksum offload. Typically needed for use faster
-vector PMDs (together with no-multi-seg)
-
-.. code-block:: console
-
-   no-tx-checksum-offload
-
-enable-tcp-udp-checksum
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Enable UDP / TCP TX checksum offload This is the reversed option of
-'no-tx-checksum-offload'
-
-.. code-block:: console
-
-   enable-tcp-udp-checksum
-
-The plugins Section
--------------------
-
-Configure VPP plugins.
-
-.. code-block:: console
-
-   plugins {
-      path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
-      plugin dpdk_plugin.so enable
-   }
-
-path pathname
-^^^^^^^^^^^^^
-
-Adjust the plugin path depending on where the VPP plugins are.
-
-.. code-block:: console
-
-   path /ws/vpp/build-root/install-vpp-native/vpp/lib/vpp_plugins
-
-plugin plugin-name | default enable | disable
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Disable all plugins by default and then selectively enable specific plugins
-
-.. code-block:: console
-
-   plugin default disable
-   plugin dpdk_plugin.so enable
-   plugin acl_plugin.so enable
-
-Enable all plugins by default and then selectively disable specific plugins
-
-.. code-block:: console
-
-   plugin dpdk_plugin.so disable
-   plugin acl_plugin.so disable
-
-Th statseg Section
-^^^^^^^^^^^^^^^^^^
-
-.. code-block:: console
-
-   statseg {
-      per-node-counters on
-    }
-
-socket-name 
-^^^^^^^^^^^^^^^^^^^^^^
-
-Name of the stats segment socket defaults to /run/vpp/stats.sock.
-
-.. code-block:: console
-
-   socket-name /run/vpp/stats.sock
-
-size [KMG]
-^^^^^^^^^^^^^^^
-
-The size of the stats segment, defaults to 32mb
-
-.. code-block:: console
-
-   size 1024M
-
-per-node-counters on | off
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Defaults to none
-
-.. code-block:: console
-
-   per-node-counters on
-
-update-interval 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the segment scrape / update interval
-
-.. code-block:: console
-
-   update-interval 300
-
-
-Some Advanced Parameters:
--------------------------
-
-
-acl-plugin Section
-------------------
-
-These parameters change the configuration of the ACL (access control list) plugin,
-such as how the ACL bi-hash tables are initialized.
-
-They should only be set by those that are familiar with the interworkings of VPP
-and the ACL Plugin.
-
-The first three parameters, *connection hash buckets*, *connection hash memory*,
-and *connection count max*, set the **connection table per-interface parameters**
-for modifying how the two bounded-index extensible hash tables for
-IPv6 (40\*8 bit key and 8\*8 bit value pairs) and IPv4
-(16\*8 bit key and 8\*8 bit value pairs) **ACL plugin FA interface sessions**
-are initialized.
-
-connection hash buckets 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of hash buckets (rounded up to a power of 2) in each
-of the two bi-hash tables. Defaults to 64\*1024 (65536) hash buckets.
-
-.. code-block:: console
-
-   connection hash buckets 65536
-
-connection hash memory 
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the allocated memory size (in bytes) for each of the two bi-hash tables.
-Defaults to 1073741824 bytes.
-
-.. code-block:: console
-
-   connection hash memory 1073741824
-
-connection count max 
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the maximum number of pool elements when allocating each per-worker
-pool of sessions for both bi-hash tables. Defaults to 500000 elements in each pool.
-
-.. code-block:: console
-
-   connection count max 500000
-
-main heap size G | M | K | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the size of the main memory heap that holds all the ACL module related
-allocations (other than hash.) Default size is 0, but during
-ACL heap initialization is equal to
-*per_worker_size_with_slack * tm->n_vlib_mains + bihash_size + main_slack*.
-Note that these variables are partially based on the
-**connection table per-interface parameters** mentioned above.
-
-.. code-block:: console
-
-   main heap size 3G
-
-The next three parameters, *hash lookup heap size*, *hash lookup hash buckets*,
-and *hash lookup hash memory*, modify the initialization of the bi-hash lookup
-table used by the ACL plugin. This table is initialized when attempting to apply
-an ACL to the existing vector of ACLs looked up during packet processing
-(but it is found that the table does not exist / has not been initialized yet.)
-
-hash lookup heap size  G | M |  K | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the size of the memory heap that holds all the miscellaneous allocations
-related to hash-based lookups. Default size is 67108864 bytes.
-
-.. code-block:: console
-
-   hash lookup heap size 70M
-
-hash lookup hash buckets 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of hash buckets (rounded up to a power of 2) in the bi-hash
-lookup table. Defaults to 65536 hash buckets.
-
-.. code-block:: console
-
-   hash lookup hash buckets 65536
-
-hash lookup hash memory 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the allocated memory size (in bytes) for the bi-hash lookup table.
-Defaults to 67108864 bytes.
-
-.. code-block:: console
-
-   hash lookup hash memory 67108864
-
-use tuple merge 
-^^^^^^^^^^^^^^^^^^^
-
-Sets a boolean value indicating whether or not to use TupleMerge
-for hash ACL's. Defaults to 1 (true), meaning the default implementation
-of hashing ACL's does use TupleMerge.
-
-.. code-block:: console
-
-   use tuple merge 1
-
-tuple merge split threshold 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the maximum amount of rules (ACE's) that can collide in a bi-hash
-lookup table before the table is split into two new tables. Splitting ensures
-less rule collisions by hashing colliding rules based on their common tuple
-(usually their maximum common tuple.) Splitting occurs when the
-*length of the colliding rules vector* is greater than this threshold amount.
-Defaults to a maximum of 39 rule collisions per table.
-
-.. code-block:: console
-
-   tuple merge split threshold 30
-
-reclassify sessions 
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets a boolean value indicating whether or not to take the epoch of the session
-into account when dealing with re-applying ACL's or changing already applied ACL's.
-Defaults to 0 (false), meaning the default implementation does NOT take the
-epoch of the session into account.
-
-.. code-block:: console
-
-   reclassify sessions 1
-
-.. _api-queue:
-
-api-queue Section
------------------
-
-length  
-^^^^^^^^^^^
-
-Sets the api queue length. Minimum valid queue length is 1024, which is
-also the default.
-
-.. code-block:: console
-
-   length 2048
-
-.. _cj:
-
-cj Section
-----------
-
-The circular journal (CJ) thread-safe circular log buffer scheme is
-occasionally useful when chasing bugs. Calls to it should not be checked in.
-See .../vlib/vlib/unix/cj.c. The circular journal is disables by default.
-When enabled, the number of records must be provided, there is no default
-value.
-
-records 
-^^^^^^^^^^^
-
-Configure the number of circular journal records in the circular buffer.
-The number of records should be a power of 2.
-
-.. code-block:: console
-
-   records 131072
-
-on
-^^
-
-Turns on logging at the earliest possible moment.
-
-.. code-block:: console
-
-   on
-
-dns Section
------------
-
-max-cache-size 
-^^^^^^^^^^^^^^^^^^
-
-Set the maximum number of active elements allowed in the pool of
-dns cache entries. When resolving an expired entry or adding a new
-static entry and the max number of active entries is reached,
-a random, non-static entry is deleted. Defaults to 65535 entries.
-
-.. code-block:: console
-
-   max-cache-size 65535
-
-
-ethernet Section
------------------
-
-default-mtu 
-^^^^^^^^^^^^^^^
-
-Specifies the default MTU size for Ethernet interfaces.  Must be in
-the range of 64-9000.  The default is 9000.
-
-.. code-block:: console
-
-   default-mtu 1500
-
-heapsize Section
------------------
-
-Heapsize configuration controls the size of the main heap. The heap size is
-configured very early in the boot sequence, before loading plug-ins or doing
-much of anything else.
-
-heapsize M | G
-^^^^^^^^^^^^^^^^^^^^
-
-Specifies the size of the heap in MB or GB. The default is 1GB.
-
-.. code-block:: console
-
-   heapsize 2G
-
-ip Section
-----------
-
-IPv4 heap configuration. he heap size is configured very early in the boot
-sequence, before loading plug-ins or doing much of anything else.
-
-heap-size G | M | K | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Set the IPv4 mtrie heap size, which is the amount of memory dedicated to
-the destination IP lookup table. The input value can be set in GB, MB, KB
-or bytes. The default value is 32MB.
-
-.. code-block:: console
-
-   heap-size 64M
-
-ip6 Section
------------
-
-IPv6 heap configuration. he heap size is configured very early in the boot
-sequence, before loading plug-ins or doing much of anything else.
-
-
-heap-size G | M | K | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Set the IPv6 forwarding table heap size. The input value can be set in GB,
-MB, KB or bytes. The default value is 32MB.
-
-.. code-block:: console
-
-   heap-size 64M
-
-hash-buckets 
-^^^^^^^^^^^^^^^^
-
-Set the number of IPv6 forwarding table hash buckets. The default value is
-64K (65536).
-
-.. code-block:: console
-
-   hash-buckets 131072
-
-l2learn Section
----------------
-
-Configure Layer 2 MAC Address learning parameters.
-
-limit 
-^^^^^^^^^
-
-Configures the number of L2 (MAC) addresses in the L2 FIB at any one time,
-which limits the size of the L2 FIB to  concurrent entries.  Defaults to
-4M entries (4194304).
-
-.. code-block:: console
-
-   limit 8388608
-
-l2tp Section
-------------
-
-IPv6 Layer 2 Tunnelling Protocol Version 3 (IPv6-L2TPv3) configuration controls
-the method used to locate a specific IPv6-L2TPv3 tunnel. The following settings
-are mutually exclusive:
-
-lookup-v6-src
-^^^^^^^^^^^^^
-
-Lookup tunnel by IPv6 source address.
-
-.. code-block:: console
-
-   lookup-v6-src
-
-lookup-v6-dst
-^^^^^^^^^^^^^
-
-Lookup tunnel by IPv6 destination address.
-
-.. code-block:: console
-
-   lookup-v6-dst
-
-lookup-session-id
-^^^^^^^^^^^^^^^^^
-
-Lookup tunnel by L2TPv3 session identifier.
-
-.. code-block:: console
-
-   lookup-session-id
-
-logging Section
----------------
-
-size 
-^^^^^^^^
-
-Number of entries in the global logging buffer. Defaults to 512.
-
-.. code-block:: console
-
-   size 512
-
-nthrottle-time 
-^^^^^^^^^^^^^^^^^^
-
-Set the global value for the time to wait (in seconds) before resuming
-logging of a log subclass that exceeded the per-subclass message-per-second
-threshold.  Defaults to 3.
-
-.. code-block:: console
-
-   unthrottle-time 3
-
-default-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Set the default logging level of the system log.  Defaults to notice.
-
-.. code-block:: console
-
-   default-log-level notice
-
-default-syslog-log-level emerg|alert | crit | err | warn | notice | info | debug | disabled
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Set the default logging level of the syslog target.  Defaults to warning.
-
-.. code-block:: console
-
-   default-syslog-log-level warning
-
-mactime Section
----------------
-
-lookup-table-buckets 
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of hash buckets in the mactime bi-hash lookup table.
-Defaults to 128 buckets.
-
-.. code-block:: console
-
-   lookup-table-buckets 128
-
-lookup-table-memory G | M | K | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the allocated memory size (in bytes) for the mactime bi-hash lookup table.
-The input value can be set in GB, MB, KB or bytes. The default value is 262144
-(256 << 10) bytes or roughly 256KB.
-
-.. code-block:: console
-
-   lookup-table-memory 300K
-
-timezone_offset 
-^^^^^^^^^^^^^^^^^^^
-
-Sets the timezone offset from UTC. Defaults to an offset of -5 hours
-from UTC (US EST / EDT.)
-
-.. code-block:: console
-
-   timezone_offset -5
-
-"map" Parameters
-----------------
-
-customer edge
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets a boolean true to indicate that the MAP node is a Customer Edge (CE)
-router. The boolean defaults to false, meaning the MAP node is not treated
-as a CE router.
-
-.. code-block:: console
-
-   customer edge
-
-nat Section
------------
-
-These parameters change the configuration of the NAT (Network address translation)
-plugin, such as how the NAT & NAT64 bi-hash tables are initialized, if the NAT is
-endpoint dependent, or if the NAT is deterministic.
-
-For each NAT per thread data, the following 4 parameters change how certain
-bi-hash tables are initialized.
-
-translation hash buckets 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of hash buckets in each of the two in/out NAT bi-hash lookup
-tables. Defaults to 1024 buckets.
-
-If the NAT is indicated to be endpoint dependent, which can be set with the
-:ref:`endpoint-dependent parameter `, then this parameter sets
-the number of hash buckets in each of the two endpoint dependent sessions
-NAT bi-hash lookup tables.
-
-.. code-block:: console
-
-   translation hash buckets 1024
-
-translation hash memory 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the allocated memory size (in bytes) for each of the two in/out NAT
-bi-hash tables. Defaults to 134217728 (128 << 20) bytes, which is roughly 128 MB.
-
-If the NAT is indicated to be endpoint dependent, which can be set with the
-:ref:`endpoint-dependent parameter `, then this parameter sets the
-allocated memory size for each of the two endpoint dependent sessions NAT bi-hash
-lookup tables.
-
-.. code-block:: console
-
-   translation hash memory 134217728
-
-user hash buckets 
-^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of hash buckets in the user bi-hash lookup table
-(src address lookup for a user.) Defaults to 128 buckets.
-
-.. code-block:: console
-
-   user hash buckets 128
-
-user hash memory 
-^^^^^^^^^^^^^^^^^^^^
-
-Sets the allocated memory size (in bytes) for the user bi-hash lookup table
-(src address lookup for a user.) Defaults to 67108864 (64 << 20) bytes,
-which is roughly 64 MB.
-
-.. code-block:: console
-
-   user hash memory 67108864
-
-max translations per user 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the maximum amount of dynamic and/or static NAT sessions each user can have.
-Defaults to 100. When this limit is reached, the least recently used translation
-is recycled.
-
-.. code-block:: console
-
-   max translations per user 50
-
-deterministic
-^^^^^^^^^^^^^
-
-Sets a boolean value to 1 indicating that the NAT is deterministic. Defaults to 0,
-meaning the NAT is not deterministic.
-
-.. code-block:: console
-
-   deterministic
-
-nat64 bib hash buckets 
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
-tables. Defaults to 1024 buckets.
-
-.. code-block:: console
-
-   nat64 bib hash buckets 1024
-
-nat64 bib hash memory 
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the allocated memory size (in bytes) for each of the two in/out NAT64
-BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
-which is roughly 128 MB.
-
-.. code-block:: console
-
-   nat64 bib hash memory 134217728
-
-nat64 st hash buckets 
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of hash buckets in each of the two in/out NAT64 session table
-bi-hash tables. Defaults to 2048 buckets.
-
-.. code-block:: console
-
-   nat64 st hash buckets 2048
-
-nat64 st hash memory 
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
-table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
-256 MB.
-
-.. code-block:: console
-
-   nat64 st hash memory 268435456
-
-.. _endpointLabel:
-
-endpoint-dependent
-^^^^^^^^^^^^^^^^^^
-
-Sets a boolean value to 1, indicating that the NAT is endpoint dependent.
-Defaults to 0, meaning the NAT is not endpoint dependent.
-
-.. code-block:: console
-
-   endpoint-dependent
-
-oam Section
------------
-
-OAM configuration controls the (ip4-icmp) interval, and number of misses
-allowed before reporting an oam target down to any registered listener.
-
-interval 
-^^^^^^^^^^^^^^
-
-Interval, floating-point seconds, between sending OAM IPv4 ICMP messages.
-Default is 2.04 seconds.
-
-.. code-block:: console
-
-   interval 3.5
-
-physmem Section
----------------
-
-Configuration parameters used to specify base address and maximum size of
-the memory allocated for the pmalloc module in VPP. pmalloc is a NUMA-aware,
-growable physical memory allocator. pmalloc allocates memory for the DPDK
-memory pool.
-
-base-addr 

-^^^^^^^^^^^^^^^^^^^
-
-Specify the base address for pmalloc memory space.
-
-.. code-block:: console
-
-    base-addr 0xfffe00000000
-
-max-size G | M | K | 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Set the memory size for pmalloc memory space. The default is 16G.
-
-.. code-block:: console
-
-    max-size 4G
-
-tapcli Section
---------------
-
-Configuration parameters for TAPCLI (dynamic tap interface hookup.)
-
-mtu 
-^^^^^^^
-
-Sets interface MTU (maximum transmission unit) size in bytes. This size
-is also related to the number of MTU buffers. Defaults to 1500 bytes.
-
-.. code-block:: console
-
-   mtu 1500
-
-disable
-^^^^^^^
-
-Disables TAPCLI. Default is that TAPCLI is enabled.
-
-.. code-block:: console
-
-   disable
-
-
-tcp Section
------------
-
-Configuration parameters for TCP host stack utilities. The following
-preallocation parameters are related to the initialization of fixed-size,
-preallocation pools.
-
-preallocated-connections 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of preallocated TCP connections. Defaults to 0.
-The preallocated connections per thread is related to this value,
-equal to (preallocated_connections / (num_threads - 1)).
-
-.. code-block:: console
-
-   preallocated-connections 5
-
-preallocated-half-open-connections 
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the number of preallocated TCP half-open connections. Defaults to 0.
-
-.. code-block:: console
-
-   preallocated-half-open-connections 5
-
-buffer-fail-fraction 
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the TCP buffer fail fraction (a float) used for fault-injection
-when debugging TCP buffer allocation. Its use is found in *tcp_debug.h*.
-Defaults to 0.0.
-
-.. code-block:: console
-
-   buffer-fail-fraction 0.0
-
-
-tls Section
------------
-
-Configures TLS parameters, such as enabling the use of test certificates.
-These parameters affect the tlsmbedtls and tlsopenssl plugins.
-
-use-test-cert-in-ca
-^^^^^^^^^^^^^^^^^^^
-
-Sets a boolean value to 1 to indicate during the initialization of a
-TLS CA chain to attempt to parse and add test certificates to the chain.
-Defaults to 0, meaning test certificates are not used.
-
-.. code-block:: console
-
-   use-test-cert-in-ca
-
-ca-cert-path 
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Sets the filename path of the location of TLS CA certificates, used when
-initializing and loading TLS CA certificates during the initialization
-of a TLS CA chain. If not set, the default filename path is
-*/etc/ssl/certs/ca-certificates.crt*.
-
-.. code-block:: console
-
-   ca-cert-path /etc/ssl/certs/ca-certificates.crt
-
-
-tuntap Section
---------------
-
-The "tuntap" driver configures a point-to-point interface between the vpp
-engine and the local Linux kernel stack. This allows e.g. users to ssh to the
-host | VM | container via vpp "revenue" interfaces. It's marginally useful, and
-is currently disabled by default. To [dynamically] create TAP interfaces - the
-preferred scheme - see the "tap_connect" binary API. The Linux network stack
-"vnet" interface needs to manually configure, and VLAN and other settings if
-desired.
-
-
-enable|disable
-^^^^^^^^^^^^^^
-
-Enable or disable the tun/tap driver.
-
-.. code-block:: console
-
-   enable
-
-ethernet|ether
-^^^^^^^^^^^^^^
-
-Create a tap device (ethernet MAC) instead of a tun device (point-to-point
-tunnel). The two keywords are aliases for the same function.
-
-.. code-block:: console
-
-   ethernet
-
-have-normal-interface|have-normal
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Treat the host Linux stack as a routing peer instead of programming VPP
-interface L3 addresses onto the tun/tap devices. The two keywords are
-aliases for the same function.
-
-.. code-block:: console
-
-   have-normal-interface
-
-name 
-^^^^^^^^^^^
-
-Assign name to the tun/tap device.
-
-.. code-block:: console
-
-   name vpp1
-
-
-vhost-user Section
-------------------
-
-Vhost-user configuration parameters control the vhost-user driver.
-
-coalesce-frames 
-^^^^^^^^^^^^^^^^^^^
-
-Subject to deadline-timer expiration - see next item - attempt to transmit
-at least  packet frames. Default is 32 frames.
-
-.. code-block:: console
-
-   coalesce-frames 64
-
-coalesce-time 
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Hold packets no longer than (floating-point) seconds before transmitting
-them. Default is 0.001 seconds
-
-.. code-block:: console
-
-   coalesce-time 0.002
-
-dont-dump-memory
-^^^^^^^^^^^^^^^^
-
-vhost-user shared-memory segments can add up to a large amount of memory, so
-it's handy to avoid adding them to corefiles when using a significant number
-of such interfaces.
-
-.. code-block:: console
-
-   dont-dump-memory
-
-
-vlib Section
-------------
-
-These parameters configure VLIB, such as allowing you to choose whether to
-enable memory traceback or a post-mortem elog dump.
-
-memory-trace
-^^^^^^^^^^^^
-
-Enables memory trace (mheap traceback.) Defaults to 0, meaning memory
-trace is disabled.
-
-.. code-block:: console
-
-   memory-trace
-
-elog-events 
-^^^^^^^^^^^^^^^
-
-Sets the number of elements/events (the size) of the event ring
-(a circular buffer of events.) This number rounds to a power of 2.
-Defaults to 131072 (128 << 10) elements.
-
-.. code-block:: console
-
-   elog-events 4096
-
-elog-post-mortem-dump
-^^^^^^^^^^^^^^^^^^^^^
-
-Enables the attempt of a post-mortem elog dump to
-*/tmp/elog_post_mortem.* if os_panic or
-os_exit is called.
-
-.. code-block:: console
-
-   elog-post-mortem-dump
diff --git a/docs/gettingstarted/users/index.rst b/docs/gettingstarted/users/index.rst
deleted file mode 100644
index e04889d3ab0..00000000000
--- a/docs/gettingstarted/users/index.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-.. _users:
-
-###########
-For Users
-###########
-
-The Users section describe a basic VPP installation and configuration operation.
-The  installation and configuration of VPP can be done either manually, or by
-using a configuration utility.
-
-This section covers the following areas:
-
-The Users section covers basic VPP installation and configuration operations. This
-section covers the following areas:
-
-* Describes the different types of VPP packages 
-* Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE)
-* Explains how to manually configure, then run VPP
-* Explains how to install, then configure VPP using the Configuration Utility
-
-.. toctree::
-   :maxdepth: 2
-
-   configuring/index.rst
-   running/index.rst
diff --git a/docs/gettingstarted/users/running/index.rst b/docs/gettingstarted/users/running/index.rst
deleted file mode 100644
index b36773e6b43..00000000000
--- a/docs/gettingstarted/users/running/index.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-.. _running:
-
-Running VPP
-===========
-
-.. toctree::
-
-'vpp' Usergroup
----------------
-
-When VPP is installed, a new usergroup *'vpp'* is created. To avoid running the
-VPP CLI (vppctl) as root, add any existing users to the new group that need to
-interact with VPP:
-
-.. code-block:: console
-
-    $ sudo usermod -a -G vpp user1
-
-Update your current session for the group change to take effect: 
-
-.. code-block:: console
-
-    $ newgrp vpp
-
-
-VPP Systemd File - 'vpp.service'
---------------------------------
-
-When the VPP is installed, a systemd service files is also installed. This
-file, vpp.service (Ubuntu: /lib/systemd/system/vpp.service and CentOS:
-/usr/lib/systemd/system/vpp.service), controls how VPP is run as a service. For
-example, whether or not to restart on failure and if so, with how much delay.
-Also, which UIO driver should be loaded and location of the *'startup.conf'*
-file.
-
-.. code-block:: console
-
-    $ cat /usr/lib/systemd/system/vpp.service
-    [Unit]
-    Description=Vector Packet Processing Process
-    After=syslog.target network.target auditd.service
-    
-    [Service]
-    ExecStartPre=-/bin/rm -f /dev/shm/db /dev/shm/global_vm /dev/shm/vpe-api
-    ExecStartPre=-/sbin/modprobe uio_pci_generic
-    ExecStart=/usr/bin/vpp -c /etc/vpp/startup.conf
-    Type=simple
-    Restart=on-failure
-    RestartSec=5s
-
-    [Install]
-    WantedBy=multi-user.target
-
-.. note::
-
-    Some older versions of the *'uio_pci_generic'* driver don't bind all
-    the supported NICs properly, so the *'igb_uio'* driver built from DPDK
-    needs to be installed. This file controls which driver is loaded at boot.
-    *'startup.conf'* file controls which driver is used.
diff --git a/docs/gettingstarted/writingdocs/buildingrst.rst b/docs/gettingstarted/writingdocs/buildingrst.rst
deleted file mode 100644
index 474257d35d0..00000000000
--- a/docs/gettingstarted/writingdocs/buildingrst.rst
+++ /dev/null
@@ -1,94 +0,0 @@
-.. _buildingrst:
-
-**************************
-Creating VPP Documents
-**************************
-
-These instructions show how the VPP documentation sources are built.
-
-The VPP Documents are written using `reStructuredText `_ (rst),
-or markdown (md). These files are then built using the Sphinx build system `Sphinx `_.
-
-Get the VPP sources
-=====================
-
-Start with a clone of the vpp repository.
-
-.. code-block:: console
-
-   $ git clone https://gerrit.fd.io/r/vpp
-   $ cd vpp
-
-
-Install the Necessary Packages
-===============================
-
-Before building the docs there are some packages that are needed. To install
-these packages on ubuntu execute the following.
-
-.. code-block:: console
-
-   $ sudo apt-get install python3-all python3-setuptools python3-pip
-
- 
-Create a Virtual Environment using virtualenv
-===============================================
- 
-For more information on how to use the Python virtual environment check out
-`Installing packages using pip and virtualenv`_.
-
-.. _`Installing packages using pip and virtualenv`: https://packaging.python.org/guides/installing-using-pip-and-virtualenv/
-
-In the vpp root directory on your system, run: 
-
-.. code-block:: console
-
-   $ make docs-venv
-
-Which installs all the required applications into it's own, isolated, virtual environment, so as to not
-interfere with other builds that may use different versions of software.
-
-Build the html files
-======================
-
-Build the html **index.html** file: 
-
-.. code-block:: console
-
-   $ make docs
-
-Clean the environment
-======================
-
-Delete all the generated files with the following:
-
-.. code-block:: console
-
-   $ make docs-clean
-
-View the results
-=================
-
-| If there are no errors during the build process, you should now have an **index.html** file in your
-| **vpp/docs/_build/html** directory, which you can then view in your browser.
-
-.. figure:: /_images/htmlBuild.png
-   :alt: Figure: My directory containing the index.html file
-   :scale: 35%
-   :align: center
-
-Whenever you make changes to your **.rst** files that you want to see, repeat this build process.
-
-.. note::
-
-   To exit from the virtual environment execute:
-
-.. code-block:: console
-
-   $ deactivate
-
-Getting your documents reviewed and merged
-==========================================
-
-VPP documents are reviewed and merged like and other source code. Refer to :ref:`gitreview`
-to get your changes reviewed and merged.
diff --git a/docs/gettingstarted/writingdocs/index.rst b/docs/gettingstarted/writingdocs/index.rst
deleted file mode 100644
index 45a746df826..00000000000
--- a/docs/gettingstarted/writingdocs/index.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-.. _writingdocs:
-
-#########################
-Writing Documents
-#########################
-
-This section covers the following topics:
-
-* Building VPP Documents
-* Merging FD.io VPP documents and performing a Git review
-* reStructured Text Style Guide that describes different format styles
-* Markdown Style Guide that describes different format styles
-
-
-.. toctree::
-   :maxdepth: 3
-
-   buildingrst
-   styleguide/index.rst
-   styleguidemd/index.rst
diff --git a/docs/gettingstarted/writingdocs/styleguide/index.rst b/docs/gettingstarted/writingdocs/styleguide/index.rst
deleted file mode 100644
index 240b3a26b19..00000000000
--- a/docs/gettingstarted/writingdocs/styleguide/index.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. _styleguide:
-
-#############################
-reStructured Text Style Guide
-#############################
-
-Most of the these documents are written ins reStructured Text (rst). This chapter describes some of
-the Sphinx Markup Constructs used in these documents. The Sphinx style guide can be found at:
-`Sphinx Style Guide `_
-For a more detailed list of Sphinx Markup Constructs please refer to:
-`Sphinx Markup Constructs `_
-
-This document is also an example of a directory structure for a document that spans multiple pages.
-Notice we have the file **index.rst** and the then documents that are referenced in index.rst. The
-referenced documents are shown at the bottom of this page.
-
-A label is shown at the top of this page. Then the first construct describes a the document title
-**FD.io Style Guide**. Text usually follows under each title or heading.
-
-A **Table of Contents** structure is shown below. Using **toctree** in this way will show the headings
-in a nicely in the generated documents.
-
-.. toctree::
-   :maxdepth: 2
-
-   styleguide.rst
-   styleguide02.rst
-   styleguide02table.rst
-   styleguide03.rst
-   styleguide04.rst
-   styleguide05.rst
diff --git a/docs/gettingstarted/writingdocs/styleguide/iperf-vm.xml b/docs/gettingstarted/writingdocs/styleguide/iperf-vm.xml
deleted file mode 100644
index be354c5f977..00000000000
--- a/docs/gettingstarted/writingdocs/styleguide/iperf-vm.xml
+++ /dev/null
@@ -1,106 +0,0 @@
-
-  iperf-server
-  1048576
-  1048576
-  
-    
-      
-    
-  
-  1
-  
-    /machine
-  
-  
-    hvm
-    
-  
-  
-    
-    
-  
-  
-    
-    
-      
-    
-  
-  
-    
-    
-    
-  
-  destroy
-  restart
-  restart
-  
-    
-    
-  
-  
-    /usr/bin/kvm
-    
-      
-      
-      
-      
-      
-      

-    
-    
-      
-      
-      
-      
-      
-      
-      

-    
-    
-      
-      

-    
-    
-      
-    
-    
-      
-      

-    
-    
-      
-      

-    
-    
-      
-      
-      
-      
-      

-    
-    
-      
-      
-      
-    
-    
-      
-      
-      
-    
-    
-    
-    
-      
-    
-    
-      
-      

-    
-  
-  
-    
-    libvirt-2c4c9317-c7a5-4b37-b789-386ccda7348a
-  
-
-
diff --git a/docs/gettingstarted/writingdocs/styleguide/rawhtml.rst b/docs/gettingstarted/writingdocs/styleguide/rawhtml.rst
deleted file mode 100644
index e94eb452312..00000000000
--- a/docs/gettingstarted/writingdocs/styleguide/rawhtml.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. _rawhtml01:
-
-Raw HTML Example
-================
-
-This example shows how to include include a CSIT performance graph.
-
-.. raw:: html
-
-