86 Commits

Author SHA1 Message Date
Paul Vinciguerra
d1598d4274 docs: update list of plugins
The list of plugins is outdated.

This change introduces a dynamically
generated list of the plugins along with their descriptions,
extracted directly from the sources.

Type: docs

Change-Id: Icb7b65e6b45289e257d71a1c18d10f62ced59cbe
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
(cherry picked from commit 630ca994e0ff210a3de80d73bb395c931d2fd83f)
2020-12-21 23:23:53 +00:00
Paul Vinciguerra
1e44cf53b5 docs: fix missing quotes in ubuntu install instructions
type: docs

Change-Id: Ifa09b63924f4b7bf2719bba6ada0e1122407641c
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
(cherry picked from commit ac9a585c6207ac876025f924aeb96ddcac8c8805)
2020-12-18 23:37:48 +00:00
Dave Wallace
d88c9a13e8 build: remove opensuse build infra
- VPP on opensuse has not been supported
  for several releases.

Type: fix

Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Change-Id: I2b5316ad5c20a843b8936f4ceb473f932a5338d9
(cherry picked from commit bc35f469c89daf0126937580b6972516b5007d3a)
2020-09-22 11:35:12 +00:00
Nathan Skrzypczak
c4781a32df docs: Improve new plugin doc & add govpp API doc
Type: docs

Change-Id: I5f20ac0232c5cdc3cf64015185b0d0fc5c4a3100
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-09 20:44:08 +00:00
Nathan Skrzypczak
f681e9f736 docs: Update and improve indent install
Type: docs

Change-Id: I1a37450261e0bcedf90685243b14027f3cf23704
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-09 20:44:00 +00:00
Nathan Skrzypczak
24179ee1a4 docs: Improve & link cnat doc
Type: docs

Change-Id: Ib985ed6a644ae3f4c330bf6a27dc69c49a489a2f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-05 08:37:51 +00:00
Christian Hopps
047f67eedd docs: correct fib tunnel diagram reference
The included image was pulling in figure 2, change to the correct
figure 11.

Type: docs
Signed-off-by: Christian Hopps <chopps@labn.net>
Change-Id: I3679916364753fc682d1d1713fce952de398e626
2020-08-13 12:29:10 +00:00
John DeNisco
b046487622 docs: Update the VPP tutorial
Update the documents for the VPP tutorial.

Type: fix

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I62d0641ff0af7b07a26b4379f19cbdaf285537d7
2020-07-28 16:30:53 +00:00
John DeNisco
742000af20 docs: Reflect the fact that the DPDK is now a plugin
Type: Improvement

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic1253f601ee515392902a21b92e1dfd3962cc0a4
2020-07-06 12:30:31 -04:00
Dave Barach
b30b9549ac vlib: debug CLI macro expander, part deux
Deal with circular macro definitions instead of crashing due to stack
overflow.

Separate macro tables, per CLI session

Add documentation to the Sphinx docs

Type: improvement

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I55fc9152bd37ad0c15fa3959f38b07b63100e634
2020-06-23 15:35:14 +00:00
Dave Barach
ce412fd7d6 docs: improve handoff queue writeup
Type: docs
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I4d63a0fbbdb3cc00eac9116f122e5b831d059e33
2020-06-03 20:17:45 +00:00
Damjan Marion
5505ee8904 misc: deprecate elftool
Type: make

Change-Id: I34fec1c40ef660177c266517eaf41d60827609f4
Signed-off-by: Damjan Marion <damarion@cisco.com>
2020-05-07 16:47:33 +00:00
Dave Barach
aad5e0c16f vppinfra: add timer wheel section to Sphinx docs
Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Id0576d98b8e78cf4cd00161968d3eb6dbd58055a
2020-05-06 14:08:33 +00:00
Ruslan Babayev
e31820af10 vlib: add nosyslog unix option
The "nosyslog" option disables syslog just like the "interactive" mode
but can be used together with "nodaemon".

This is useful for when VPP is running under a process supervisor like
runit or daemontools that pipe the stdout/stderr to a dedicated logger
service.

Type: feature

Change-Id: Ic4287338d6836fea9f3eabdcf960dc1f51875dd1
Signed-off-by: Ruslan Babayev <ruslan@babayev.com>
2020-05-02 16:06:16 -07:00
Dave Barach
883bf3d1a3 docs: add a timebase precision section
Type: docs
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I47434cb305f291a6221780ff4ee9a2c1bb041286
2020-04-02 01:24:28 +00:00
Paul Vinciguerra
491741a404 docs ethernet: add docs for ethernet Section
Type: docs

Change-Id: I6ad92b35df3e0fecb1334511625eacf3e3d8925f
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-27 16:12:45 +00:00
Paul Vinciguerra
5ac392dc41 docs: minor typos in configuring/startup.rst
Change-Id: I8a6596d7cfa84cb2c5ee2d847395e9cea69c5349
Type: docs
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-27 16:11:41 +00:00
Dave Barach
437e33f1f9 docs: describe clib_time monotonic timebase support
Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I5b27d8b945472388498a4afc4be8dd868bb45ac3
2020-03-11 15:04:36 +00:00
Paul Vinciguerra
262971e783 docs: Add list of nodes for 'trace add'
(provided by Andrew/Damjan: git grep -h -B20 VLIB_NODE_FLAG_TRACE_SUPPORTED | grep VLIB_REGISTER_NODE | awk -F [\(\),] '{print $2 }' | sed 's/_/-/g' | sort |sed 's/-node//' )

Type: docs

Change-Id: I4a58fe5ed6bb3598551482ea1c5f16e502cbd6a7
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-09 11:35:05 +00:00
Paul Vinciguerra
5e0e0df9b4 docs: document the unformat '%_' option
Type: docs

Change-Id: Id864fcff768a78aa313b193f2eaabe545d95bec4
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-06 13:53:19 +00:00
Dave Barach
2fef3dfa5c vppinfra: deprecate CLIB_VEC64
Type: refactor
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Id1e7c0926036db4601c91438397ceed22381fc07
2020-02-23 17:48:53 +00:00
Dave Barach
78a1877463 vppinfra: write up clib_time_t
Describe the clock rate adjustment algorithm in detail

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I5bcab18efafe05cd1db9a4b01ce6a6ba66e383fa
2020-01-31 21:56:12 +00:00
Jieqiang Wang
affa05532d docs: add physmem section in configuration parameters
physmem section is listed in 'Advanced Parameters', which has two
parameters, base-addr and max-size, for pmalloc module in VPP.

Type:feature

Change-Id: I7beef40603b864e4c8f3cf0fa716de74036cfdcc
Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
2019-12-18 22:47:42 +00:00
John DeNisco
4f85968a43 docs: Rework the startup configuration section
Type: docs

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic60aac96a4aeb5532f98dfb85c776bf549c0d660
Signed-off-by: Dave Barach <dave@barachs.net>
2019-12-11 20:41:24 +00:00
Dave Barach
87d24db65f classify: vpp packet tracer support
Configure n-tuple classifier filters which apply to the vpp packet
tracer.

Update the documentation to reflect the new feature.

Add a test vector.

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Iefa911716c670fc12e4825b937b62044433fec36
2019-12-05 15:31:57 +00:00
Dave Barach
d28437cdf2 classify: per-interface rx/tx pcap capture filters
Finish the feature, and fix a couple of doc bugs

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I2c62745fda137776204c8fc4fca0e7e288051573
2019-11-20 17:39:17 +00:00
Paul Vinciguerra
867b9ec6ab docs: update logging configuration section.
Type: docs

Change-Id: I6359623b2eadb404fc391e4c4608fff86020f53f
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-11-12 20:56:22 +00:00
Paul Vinciguerra
340c15c6ed docs: add spellcheck to 'make docs' sphinx docs
The CI gate will fail if there are typos in the docs.

  writing output... [ 21%] events/Summits/OpensourceSummit...
  writing output... [ 22%] events/Summits/UKNO/2017_04_30_...

  featuresbyrelease/vpp16.06.rst:34:Rasberry:vpp16.06
  writing output... [100%] usecases/vppinazure
  Spelling checker messages written to /vpp/docs/_build/html/output.txt

  Warning, treated as error:
  Found 1 misspelled words
  Makefile:31: recipe for target 'html' failed
  make[1]: *** [html] Error 2
  make[1]: Leaving directory '/vpp/docs'

If you introduce a term that is not recognized,
please add it to custom dictionary at
docs/spelling_wordlist.txt.

Type: feature

Change-Id: Id49be4fbee617f544f1ab8e78e7de8a4df36448b
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-11-06 17:53:42 +00:00
Paul Vinciguerra
7fa3dd2881 docs: cleanup typos on readthrough
Type: style

Change-Id: I3b15035ea6c13cd1ca3cdc9dfa9b10a6e1be9880
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-10-28 13:51:13 +00:00
Nathan Skrzypczak
66f2a8891f docs: Add macos build documentation
Type: docs

Change-Id: Iee03aacab2cfcb4e87190302dc641e8273b7f096
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-10-09 13:18:47 +00:00
Dave Barach
66a332cf19 docs: add packet-generator writeup
Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I4abb5c17e6fdfeaed5bbadb2ce83098dde6d05b1
2019-10-04 19:03:31 +00:00
Dave Barach
f5667c3055 misc: add vnet classify filter set support
Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I79b216d2499df143f53977e5b70382f6f887e0bc
2019-09-26 19:39:06 +00:00
Dave Barach
33909777c6 misc: unify pcap rx / tx / drop trace
Use a single vnet_pcap_t in vlib_global_main, specifically to support
unified tracing

Update sphinx docs, doxygen tags

Type: refactor
Ticket: VPP-1776

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Id15d41a596712968c0714cef1bd2cd5bc9cbdd55
2019-09-23 16:20:06 +00:00
Dave Barach
9137e54006 misc: classifier-based packet trace filter
See .../src/vnet/classify/trace_classify.h for the business end
of the scheme.

It would be best to hash pkts, prefetch buckets, and do the primary
table lookups two at a time. The inline as given works, but perf
tuning will be required. "At least it works..."

Add "classify filter" debug cli, for example:
classify filter mask l3 ip4 src dst \
  match l3 ip4 dst 192.168.2.10 src 192.168.1.10

Add "pcap rx | tx trace ... filter" to use the current classify filter chain

Patch includes sphinx documentation and doxygen tags.

Next step: device-driver integration

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I05b1358a769f61e6d32470e0c87058f640486b26
2019-09-20 15:55:25 +00:00
Dave Barach
5b786fb894 docs: improve unformat documentation
Specifically: document the unformat specifiers "%=", "%|", and correct
usage of unformat_line_input.

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I254f9c4a61c5c8d3edbf76f521e5f38fb89150f1
2019-09-09 18:37:35 +00:00
Ole Troan
6595ff7f88 api: api socket respect unix runtime directory
socksvr {} should respect the unix runtime directory.
Default is now /run/vpp/api.sock
The 'default' keyword is deprecated.
The user is responsible for creating directories outside of the
unix runtime directory.

Not yet done: Exit VPP when socket cannot be opened.
              (currently only process exits).

Type: fix
Signed-off-by: Ole Troan <ot@cisco.com>
Change-Id: I6dd66ed58a3d7e02674dfa16d72c1d7bba07b79e
2019-08-08 11:23:31 +00:00
Nathan Skrzypczak
7858d6e9e2 docs: Add more quic plugin documentation
Type: docs

Change-Id: I0209769f73a46ddad7c2625ad0f774ee2eef43dd
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-08-05 16:19:54 +00:00
Nathan Skrzypczak
55c68c9521 docs: Small fixes and ordering
* deactivtates the TODOs on doxygen (were empty)
* This move punt.md to readthedocs (should be the new
place for dev doc ?)
* Makes Handoff queue demo plugin a child of dev doc
in doxygen

Type: fix

Change-Id: I1f0476a911b35208212af8dd608bc76160efd22a
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-08-01 18:01:57 +00:00
Dave Barach
af57799fde docs: add binary api trace replay details
Folks need to know that they MUST carefully control the set of plugins
to avoid feeding messages to the wrong binary API message handlers.

Change-Id: Iefeeda6670aae4627446caee21717b847305c9b5
Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-26 14:46:17 +00:00
Neale Ranns
05cac30a92 FIB: correctly report IPv6 FIB Unicast and Multicast memory usage (VPP-1578)"
and document scaling

Change-Id: I65d8999e65616d77e525963c770d91e9b0d5e593
Signed-off-by: Neale Ranns <nranns@cisco.com>
2019-05-30 11:52:00 +00:00
jdenisco
65e410b3f3 docs: Add some packages for building the docs
Change-Id: I7af427ba6378ddd8480a153a65ec11c578bab12e
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-28 18:43:57 +00:00
jdenisco
8a6e1b190c docs: Update sphinx, requirements, support markdown tables
Change-Id: Ie7c546f5720b10fe5423397204e1ab5c22d7a2ba
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-16 17:42:13 +00:00
Dave Barach
8fa01c17aa DOC ONLY: document VLIB_INIT_FUNCTION scheme
Change-Id: I15c4256621da6c8d47b1a7c41755ee6587996757
Signed-off-by: Dave Barach <dave@barachs.net>
2019-05-16 16:59:19 +00:00
jdenisco
0da895dffe docs: Add 1904
Change-Id: Icf0e01d1dec69d48664ed633205248359b653f4d
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-10 19:48:54 +00:00
Dave Barach
bcfcb8e7fe DOC ONLY: add a buffer metadata writeup
Change-Id: Ic8034cfe3d3c5a9c3d32e97e93e5d9334cc58ca2
Signed-off-by: Dave Barach <dave@barachs.net>
2019-04-29 17:12:01 -04:00
Dave Barach
6c1f56f08c DOC-ONLY: improve multi-arch documentation
Document CLIB_MARCH_FN and CLIB_MARCH_FN_SELECT

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I661ba2af79db8205d70fa87203d40a2e31b795e4
2019-03-22 15:52:57 -04:00
Dave Barach
3fef8f811a DOC ONLY: fix g2 build documentation
Removed a broken paragraph, replaced it with a link.

Some nuisance white-space cleanups courtesy of emacs:
(add-hook 'before-save-hook 'delete-trailing-whitespace)

Change-Id: Ib348107c2dc0df8249461591015347d7b4f6fa4a
Signed-off-by: Dave Barach <dave@barachs.net>
2019-03-15 11:29:45 -04:00
Dave Barach
c4be9850f2 DOC ONLY: add packet handoff doc
Change-Id: I2e8076bb4f697819780e61ff761defdc74bf4f09
Signed-off-by: Dave Barach <dave@barachs.net>
2019-03-12 18:41:06 +00:00
jdenisco
e869269121 Fix centos build and build documentation
Change-Id: I326204d26b613254e39c6a0ffe9f9491981ba3c3
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-27 21:03:06 +00:00
jdenisco
2cefb06404 Add support for 19.01
Change-Id: I8583f6f6432d8d7c449f43d62d8707a1718f3240
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-23 09:42:48 +00:00