doc: update workflow.rst

* Rewrap lines to 80 characters
* Update some portions to reflect current practices
* Clean up some formatting (indent, markup, etc)
* Reorganize sections on patch submission
* Remove link to nonexistent github wiki page

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

Merge pull request #2409 from LabNConsulting/working/master/vtysh-2400

vtysh: -u fixes

Merge pull request #2458 from pacovn/Coverity_1221437_Unchecked_return_value

ospf6d: unchecked return value (Coverity 1221437)

ospf6d: unchecked return value (Coverity 1221437)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2426 from pacovn/Coverity_23089_Buffer_not_null_terminated

ospfd: buffer termination (Coverity 23089)

Merge pull request #2438 from pacovn/Coverity_1457300_Dereference_after_null_check

ospfd: null check (Coverity 1457300)

Merge pull request #2422 from pacovn/Coverity_23201_Dereference_before_null_check

bgpd: null check (Coverity 23201)

Merge pull request #2435 from pacovn/Coverity_1464993_Buffer_not_null_terminated

ospfd: buffer termination (Coverity 1464993)

ospfd: buffer termination (Coverity 23089)

Details:
- INET_ADDRSTRLEN is 16, for xxx.xxx.xxx\0, so 15 is now passed
 to the strncpy call instead of 16, ensuring ASCII-z output

Signed-off-by: F. Aragon <paco@voltanet.io>

bgpd: null check (Coverity 23201)

Signed-off-by: F. Aragon <paco@voltanet.io>

ospfd: buffer termination (Coverity 1464993)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2430 from pacovn/clang_scan_ospf_dereference

ospfd: dereference check (Clang scan-build)

Merge pull request #2434 from pacovn/Coverity_1457145_Out-of-bounds_access

lib: out-of-bounds access (Coverity 1457145)

Merge pull request #2436 from pacovn/Coverity_1143220_Argument_cannot_be_negative

tools: return check (Coverity 1143220)

Merge pull request #2437 from pacovn/Coverity_1436343_Dereference_after_null_check

lib: null check (Coverity 1436343)

Merge pull request #2428 from donaldsharp/zserv_debug

zebra: Cleanup code to test for failure once

Merge pull request #2410 from pacovn/Coverity_1448806_Out-of-bounds_access

lib: Out-of-bounds access (Coverity 1448806, 1448810)

Merge pull request #2439 from chiragshah6/evpn_dev

bgpd: Fix bgpd crash in evpn vni route-map apply

Merge pull request #2441 from MasterofJOKers/workflow_pr_info_url

doc: Correct wiki URL in workflow-documentation

doc: Correct wiki URL in workflow-documentation

The organization on github is called "FRRouting".

Signed-off-by: MasterofJOKers <joker@someserver.de>

lib: null check (Coverity 1436343)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2431 from pacovn/Coverity_1399290_Out-of-bounds_access

tools: out-of-bounds access (Coverity 1399290)

Merge pull request #2416 from pacovn/Coverity_1399389_Structurally_dead_code

bgpd: dead code (Coverity 1399389)

bgpd: Fix bgpd crash in evpn vni route-map

When evpn configured wiht route-map with vni which is not
configured. Upon receiving evpn routes (i.e Type-2, Type-3),
route-map match will be triggered. Since there is no l2vni
exists in db, some of the member fields in bgp_info (i.e.
dummy_info_extra) are passed uninitialized to evpn filter match cb.
This results in inaccessible memory causes crash.

Fix is to memset the bgp_info prior to passing to evpn filter cb.
In evpn vni filter cb, ensure to have NULL check for member filed
of the bgp_info.

memset bgp_info at few places where it is passed to route_match.

Ticket:CM-21335
Reviewed By:
Testing Done:

Configure route-map with not configured l2vni
Simulate to learn l2vpn type-2, 3 route

Restart frr.service with below config
address-family l2vpn evpn
  neighbor fear route-map EVPN_VNI out

route-map EVPN_VNI deny 10
 match evpn vni 140010

Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

ospfd: null check (Coverity 1457300)

Signed-off-by: F. Aragon <paco@voltanet.io>

bgpd: dead code removal (Coverity 1399389)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2424 from pacovn/Coverity_1399270_Dereference_after_null_check

bgpd: null check (Coverity 1399270)

tools: return check (Coverity 1143220)

Signed-off-by: F. Aragon <paco@voltanet.io>

bgpd: null check (Coverity 1399270)

Signed-off-by: F. Aragon <paco@voltanet.io>

lib: out-of-bounds access (Coverity 1457145)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2421 from pacovn/Coverity_1399232_Logically_dead_code

ospfd: dead code (Coverity 1399232)

tools: out-of-bounds access (Coverity 1399290)

Signed-off-by: F. Aragon <paco@voltanet.io>

ospfd: dereference check (Clang scan-build)

Signed-off-by: F. Aragon <paco@voltanet.io>

zebra: Cleanup code to test for failure once

Cleanup the zebra code to test for failure for reading
from stream once instead of once to see if we should
debug and once for the actual failure.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

ospfd: dead code (Coverity 1399232)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2420 from pacovn/Coverity_1399246_Logically_dead_code

bgpd: dead code (Coverity 1399246)

bgpd: dead code (Coverity 1399246)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2414 from donaldsharp/bsd_failure

zebra: Fix compilation of bsd

Merge pull request #2412 from opensourcerouting/lintian-warn-fix

debianpkg: Add additional lintian override for Ubuntu 18.04

Merge pull request #2407 from donaldsharp/bgp_spelunk

Bgp crash fix for topotests

Merge pull request #2411 from qlyoung/fix-vtysh-config-write

vtysh: fix config write

zebra: Fix compilation of bsd

Actually return a value.

Fixes: #2413
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

bgpd: Ensure that bgp_delete bgp pointer is non-null

Crash w/ an assert if someone calls bgp_delete with a
NULL parameter as opposed to crashing when we dereference
the pointer a bit later.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

bgpd: bgp_default may be null

The bgp_default variable when saved to the side might actually
be NULL.

Ticket: CM-21119
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

bgpd: Fix crash when shutdown

The process of BGP shutdown hard free's memory irrelevant to
the fact that another process may be using that memory still
in route leaking scenario's.

As a temporary fix find the default instance and free it
last.

Ticket: CM-21068
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

bgpd: Move extra free code and fix a bug.

The bgp_info_extra_free code was the correct place to free
up data associated with the bgp_info pointer when we are
deleting the bgp_info node.

Additionally, if we have a parent pointer, we may not have a net
pointer.  So make sure we do.

Finally clean up the bgp_info_extra_free code so it is a bit
easier to read.  Use variables instead of multiple level
of casting.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

debianpkg: Add additional lintian override for Ubuntu 18.04

Signed-off-by: Martin Winter <mwinter@opensourcerouting.org>

vtysh: fix config write

Changing vtysh to use vty_out() for everything broke writing to config
files.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

lib: OoB access (Coverity 1448806, 1448810)

Signed-off-by: F. Aragon <paco@voltanet.io>

vtysh: in user mode, don't show 'enable not allowed', also block writeconfig

Signed-off-by: Lou Berger <lberger@labn.net>

Merge pull request #2402 from qlyoung/germx-hand-sanitizer-kills-99-percent-of-germs

*: disable all sanitizers for clippy build

Merge pull request #2379 from qlyoung/docuser

Improve introductory user docs

Merge pull request #2384 from qlyoung/docs-bgp-update

doc: massive cleanup of bgp.rst

Merge pull request #2392 from chiragshah6/evpn_dev

bgpd: accept vni rd_rt command for default vrf only

Merge pull request #2399 from pacovn/Coverity_1469894_Dereference_null_return_value

lib: null return value check (Coverity 1469894)

Merge pull request #2404 from pacovn/Coverity_1455338_Dereference_null_return_value

eigrpd: null return value check (Coverity 1455338)

Merge pull request #2406 from pacovn/Coverity_1465495_Out-of-bounds_read

zebra: Out-of-bounds read (Coverity 1465495)

lib: null return value check (Coverity 1469894)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2405 from pacovn/Coverity_1399236_Logically_dead_code

ospfd: logically dead code (Coverity 1399236)

eigrpd: null return value check (Coverity 1455338)

Signed-off-by: F. Aragon <paco@voltanet.io>

zebra: Out-of-bounds read (Coverity 1465495)

Signed-off-by: F. Aragon <paco@voltanet.io>

ospfd: logically dead code (Coverity 1399236)

Signed-off-by: F. Aragon <paco@voltanet.io>

Merge pull request #2397 from pacovn/Coverity_1469896_Dereference_after_null_check

vtysh: null dereference (Coverity 1469896)

Merge pull request #2398 from pacovn/Coverity_1469895_Dereference_after_null_check

lib: null dereference (Coverity 1469895)

Merge pull request #2396 from pacovn/Coverity_1469897_1469893_Out-of-bounds_access

bgpd: OoB access (Coverity 1469897, 1469893)

lib: null dereference (Coverity 1469895)

Signed-off-by: F. Aragon <paco@voltanet.io>

vtysh: null dereference (Coverity 1469896)

Signed-off-by: F. Aragon <paco@voltanet.io>

bgpd: OoB access (Coverity 1469897, 1469893)

Signed-off-by: F. Aragon <paco@voltanet.io>

bgpd: accept vni rd_rt command for default vrf

L2VNI route-distinguisher and route-target configuartions
should only applied under DEFAULT VRF bgpd instance.

Add newline to each vni display.

router bgp 65006
  address-family l2vpn evpn
    vni 1000101
      route-target import 1:1000101

do not allow under
router bgp 65006 vrf RED

Ticket:CM-20204
Reviewed By:
Testing Done:

Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

Merge pull request #2390 from pacovn/Coverity_1221459_Use_after_free

spf6d: fix use after free (Coverity 1221459)

Merge pull request #2389 from pacovn/Coverity_1455482_Incorrect_sizeof_expression

lib: fix sizeof expression (Coverity 1455482)

Merge pull request #2388 from pacovn/Coverity_1453454_Resource_leak

zebra: resource leak fix (Coverity 1453454)

Merge pull request #2387 from pacovn/Coverity_1465679_Resource_leak

zebra: resource leak fix (Coverity 1465679)

Merge pull request #2386 from gromit1811/pim-connected-nexthop-fix2

pimd: Fix connected route nexthop fix from 66f5152f

spf6d: fix use after free (Coverity 1221459)

Signed-off-by: F. Aragon <paco@voltanet.io>

lib: fix sizeof expression (Coverity 1455482)

Signed-off-by: F. Aragon <paco@voltanet.io>

*: disable all sanitizers for clippy build

* Move configure flag propagations out of user flags
* Use AC_SUBST to transfer flag values to Automake
* Set default AM_CFLAGS and AM_CPPFLAGS in common.am and change child
  Makefiles to modify these base variables
* Add flag override to turn off all sanitizers when building clippy
* Remove LSAN suppressions blacklist as it's no longer needed

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

zebra: resource leak fix (Coverity 1453454)

Signed-off-by: F. Aragon <paco@voltanet.io>

zebra: resource leak fix (Coverity 1465679)

Signed-off-by: F. Aragon <paco@voltanet.io>

pimd: Fix connected route nexthop fix from 66f5152f

Fix a couple of problems in my 1st fix for PIM nexthops reachable via a
connected route:

Use NEXTHOP_TYPE_IPV4_IFINDEX instead of NEXTHOP_TYPE_IPV4 since we add an
IPv4 address to an already known ifindex.

Assign nexthop_tab[num_ifindex].protocol_distance and .route_metric before
incrementing num_ifindex.

Revert the default: to individual switch case statement conversion in
zclient_read_nexthop() as requested by donaldsharp in #2347

Signed-off-by: Martin Buck <mb-tmp-tvguho.pbz@gromit.dyndns.org>

Merge pull request #2298 from qlyoung/pipe-actions-vtysh

*: add support for `|` actions

Merge pull request #2347 from gromit1811/pim-connected-nexthop-fix

pimd: Fix nexthop determination when sending towards RP

Merge pull request #2377 from ajones-rvbd/ajones-issue-2375

tests/isisd: bypass test_fuzz_isis_tlv when inet_ntop is broken

Merge pull request #2380 from donaldsharp/pim_stuff

pimd: Fix ecmp_enable and ecmp_rebalance_enable

Merge pull request #2383 from donaldsharp/bgp_lunicast

bgpd: Actually display labeled unicast routes received

Merge pull request #2385 from donaldsharp/SA_SA_SA

Some small clang 6.0 cleanups

Merge pull request #2292 from donaldsharp/fixup_sb_stuff

Fixup sb stuff

Merge pull request #2123 from qlyoung/zserv-mt

Multithreaded Zserv

Merge pull request #2349 from donaldsharp/aggregate_stuff

Aggregate stuff

doc: cleanup community list docs more

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

doc: move find command docs to better spot

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

doc: remove :caption: from toctree

Older versions of Sphinx don't support toctree captions, so we can't use
them yet unfortunately.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

doc: update EXTRA_DIST

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

doc: clean up introductory user docs

* Update the list of protocol daemons from 5 to the current 13
* Rewrap and clean up formatting for lots of miscellaneous code blocks
* Improve English in various spots
* Update architecture description and diagram
* Remove duplicate information on reporting bugs

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

doc: reorganize into multiple toctrees

Use multiple toctrees to reorganize the user docs into logical sections.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

bgpd, lib, ospf6d, vtysh: fix possible snprintf possible truncation

With a new version of clang 6.0, the compiler is detecting more
issues where we may be possibly be truncating the output string.
Fix by increasing the size of the output string to make the compiler
happy.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

vtysh, zebra: Fix function parameters

New version of clang are detecting function parameters that we should
not be casting as such.  Fix these issues.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

doc: massive cleanup of bgp.rst

This doc needed (and still needs) a lot of love.

* Reorganize doc into logical sections
* Clean up lots of grammatical mistakes and misspellings
* Clean up lots of bad formatting
* Remove non-existent configuration options and commands
* Mark deprecated configuration options as deprecated
* Fix all cross-references to follow a standard format
* Fix capitalization on section and subsection titles
* Fix section and subsection level underlines

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

bgpd: Actually display labeled unicast routes received

The labeled unicast and unicast tables have been combined
into the unicast table.  Additionally we have a restriction
where if you configure labeled unicast you cannot configure
unicast.  This created a bug with 'show bgp ipv4 labeled-unicast summ'
command where we were displaying NoNeg, because v4 has been intentionally
turned off.

Modify the code so that when we are looking up if we have negotiated
a capapbility we use the correct one, while still using the appropriate
table for prefix count.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>

Merge pull request #2382 from opensourcerouting/remove_preprocessor_check

zebra: remove unnecessary preprocessor check