doc: Fix code-block display for example shell commands

the code-block was jumbled and not displaying properly.

Reported by: Drew Bloechl
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
(cherry picked from commit 01af2696ebee84cb90427aa56066ea88b05083ed)

Merge pull request #9263 from FRRouting/mergify/bp/stable/8.0/pr-9056

bgpd: Clear capabilities field when resetting a bgp neighbor (backport #9056)

Merge pull request #9270 from FRRouting/mergify/bp/stable/8.0/pr-8789

doc: bump sphinx version to 4.0.2, remove deprecated API (backport #8789)

doc: use add_css_file(); not deprecated

add_stylesheet() is deprecated and removed in Sphinx 4.x

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
(cherry picked from commit d6ba203d2fb190e38956082429a34c747cf9de9d)

doc: add requirements.txt

Add a minimum sphinx version requirement for the docs; RTD needs this to
know what version of sphinx to install.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>
(cherry picked from commit 826186eab217a590d86a7bdfaab6174da51c79b2)

Merge pull request #9257 from FRRouting/mergify/bp/stable/8.0/pr-9255

bgpd: Set extended msg size only if we advertised and received capability (backport #9255)

Merge pull request #9245 from ton31337/fix/backport_9217

bgpd: [8.0] BGP dampening backports

bgpd: Clear capabilities field when resetting a bgp neighbor

Currently, the following sequence of events between peers could
result in erroneous capability reports on the peer
with enabled dont-capability-negotiate option:
- having some of the capabilities advertised to a bgp neighbor,
- then disabling capability negotiation to that neighbor,
- then resetting connection to it,
- and no capabilities are actually sent to the neighbor,
- but "show bgp neighbors" on the host still displays them
as advertised to the neighbor.

There are two possibilities for establishing a new connection
- the established connection was initiated by us with bgp_start(),
- the connection was initiated on the neighbor side and processed by
us via bgp_accept() in bgp_network.c.
The former case results in "show bgp neighbors" displaying only
"received" in capabilities, as the peer's cap is initiated to zero
in bgp_start().
In the latter case, if bgp_accept() happens before bgp_start()
is called, then new peer capabilities are being transferred
from its previous record before being zeroed in bgp_start().
This results in "show bgp neighbors" still displaying
"advertised and received" in capabilities.

Following the logic of a similar af_cap field clearing,
treated correctly in both cases, we
- reset peer's capability during bgp_stop()
- don't pass it over to a new peer structure in bgp_accept().
This fix prevents transferring of the previous capabilities record
to a new peer instance in arbitrary reconnect scenario.

Signed-off-by: Alexander Skorichenko <askorichenko@netgate.com>
(cherry picked from commit 24f569e9ccea56695ff57be71a6e108f9a7867b2)

bgpd: Set extended msg size only if we advertised and received capability

If we don't advertise any capabilities (dont-capability-negotiate), we
shouldn't set msg size to 65k only if received this capability from another
peer.

Before:

```
~/frr# vtysh -c 'show ip bgp update-group' | grep 'Max packet size'
    Max packet size: 65535
```

After:

```
~/frr# vtysh -c 'show ip bgp update-group' | grep 'Max packet size'
    Max packet size: 4096
```

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
(cherry picked from commit 8d976b0e2b78c3755d8d7868c535db8c8a163008)

Merge pull request #9155 from FRRouting/mergify/bp/stable/8.0/pr-8956

bgpd: prevent routes loop through itself (backport #8956)

bgpd: cleanup bgp_damp_info_free

bgp_damp_config, afi and safi are never used.

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>

bgpd: fix incorrect usage of slist in dampening

Current code is a complete misuse of SLIST structure. Instead of just
adding a SLIST_ENTRY to struct bgp_damp_info, it allocates a separate
structure to be a node in the list.

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>

Merge pull request #9221 from FRRouting/mergify/bp/stable/8.0/pr-9209

bgpd: Mark the node as the correct type for bgp ipv6 unicast (backport #9209)

bgpd: fix missing damp info free when cleaning bgp path

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>

Merge pull request #9233 from ton31337/fix/backport_cd58568b1889df753aa258ee61b6d949b1ce6fb9

bgpd: [8.0] fix missing list add in dampening

Merge pull request #9230 from FRRouting/mergify/bp/stable/8.0/pr-9222

bgpd: Drop double-pointer for bgp_damp_info_free() (backport #9222)

bgpd: fix missing list add in dampening

One more crash in dampening code...

When bgp_damp_withdraw is called, if there's already a BDI structure,
bgp_damp_info_claim is called to re-assign the bdi->config in case it
was changed. The problem is that bgp_damp_info_claim actually removes
the BDI from the reuse list of the old config and never adds it to the
reuse list of the new config. We must do this to prevent the crash
because all the code assumes that BDI is always in some list.

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>

Merge pull request #9226 from idryzhov/8.0-backport-8860-8920

[8.0] backport 8860 + 8920

bgpd: Drop double-pointer for bgp_damp_info_free()

This causes a crash using `clear ip bgp dampening <prefix>`.

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
(cherry picked from commit 19971c9a9218b31e6e1c3f7ebb23654f833bb4ef)

Merge pull request #9223 from FRRouting/mergify/bp/stable/8.0/pr-9215

bgpd: fix double free in dampening code (backport #9215)

bgpd: Fix SA warning about freeing an aspath

Fix coverity warning CID 1505589

Signed-off-by: Mark Stapp <mjs@voltanet.io>

tests: Check if as-path prepends work with route-maps and default-originate

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>

bgpd: Allow aspath prepending for default-originate with route-maps

The initial idea was to deny prepending and just use _self_.

This patch at least allows prepending aspath with route-maps, but drops
all non-self ASNs in the path.

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>

bgpd: fix double free in dampening code

bgp_damp_info_unclaim already calls bgp_reuselist_del. We must not call
it again here.

Fixes #9046.

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
(cherry picked from commit 96d6b8cc29bf5124ae93433ecfc16b3fd69be5ea)

bgpd: Mark the node as the correct type for bgp ipv6 unicast

The bgp ipv6 unicast node should be called `bgp ipv6 unicast`
to make it consistent with other nodes where we list the afi/safi

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
(cherry picked from commit a17cfb3fdaacbdc1d7303aeb898939595dc931ad)

Merge pull request #9208 from FRRouting/mergify/bp/stable/8.0/pr-9189

ospfd: don't exit when socket is not created (backport #9189)

Merge pull request #9183 from FRRouting/mergify/bp/stable/8.0/pr-9166

vtysh: another take at "enable" in vtysh user mode (backport #9166)

ospfd: don't exit when socket is not created

Let's be less radical. There's no reason to stop the whole daemon when
there's a socket creation error in a single VRF. The user can always
restart this single VRF to retry to create a socket.

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
(cherry picked from commit 95d7a42a1adb441741723e956004a12033164c1d)

Merge pull request #9184 from FRRouting/revert-9175-mergify/bp/stable/8.0/pr-8983

Revert "pimd: Minor fixes for BSM Show CLI and Hold Timer CLI (backport #8983)"

Merge pull request #9182 from FRRouting/revert-9179-PR9001-for-8.0

Revert "Backport of PR 9001 and PR 8174 for 8.0"

bgp_basic_functionality: fix pylint errors

fix pylint errors found.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
(cherry picked from commit 3881d05175b848d9b95a733635d50563c286e04b)

bgpd: prevent routes loop through itself

Some BGP updates received by BGP invite local router to
install a route through itself. The system will not do it, and
the route should be considered as not valid at the earliest.

This case is detected on the zebra, and this detection prevents
from trying to install this route to the local system. However,
the nexthop tracking mechanism is called, and acts as if the route
was valid, which is not the case.

By detecting in BGP that use case, we avoid installing the invalid
routes.

Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
(cherry picked from commit 654a5978f695087af062bfc9a382321fa2ccc4ae)

Revert "pimd: Minor fixes for BSM Show CLI and Hold Timer CLI (backport #8983)"

vtysh: don't install "enable" command in user mode

Recent change in d1b287e only fixed the problem for 3-letter words.

We were still displaying error for longer words starting with "ena":
```
nfware> enac
% Command not allowed: enable
nfware> enad
% Command not allowed: enable
nfware> enaena
% Command not allowed: enable
```

If we don't allow "enable" command in user mode, why add it at all?

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
(cherry picked from commit c54796288e8b55b3f5c241aa242ef81f1df76e44)

Revert "Backport of PR 9001 and PR 8174 for 8.0"

Merge pull request #9179 from opensourcerouting/PR9001-for-8.0

Backport of PR 9001 and PR 8174 for 8.0

Merge pull request #9177 from FRRouting/mergify/bp/stable/8.0/pr-8905

Isis argv (backport #8905)

Merge pull request #9175 from FRRouting/mergify/bp/stable/8.0/pr-8983

pimd: Minor fixes for BSM Show CLI and Hold Timer CLI (backport #8983)

zebra: When passing lookup information back pass the fully resolved

In the reachability code we auto pass back the fully resolved
nexthops.  Modify the ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB code
to do the exact same thing so that the zclient_lookup_nexthop
code does not need to recursively look for the data that
zebra already has.

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

zebra: add config control to hide backup nh events in nht

Add a config that can control hiding of backup-nexthop activation
changes in nexthop-tracking.

Signed-off-by: Mark Stapp <mjs@voltanet.io>

zebra: optionally hide backup-nexthop events in nht

Optionally hide route changes that only involve backup nexthop
activation/deactivation. The goal is to avoid route churn during
backup nexthop switchover events, before the resolving routes
re-converge. A UI config enables this 'hiding' behavior.

Signed-off-by: Mark Stapp <mjs@voltanet.io>

isisd: using argv as a string name is categorically wrong

We are passing around the system id using the variable name
of `argv`.  Let's name the variable correctly and pass it around
correctly named.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
(cherry picked from commit 1d88e63a4e3d29cec6f49602e3263f13a8de3d1e)

isisd: already checked for NULL

in lsp_for_arg we have already checked for NULL and returned
if argv is null.  We do not need to check for it again.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
(cherry picked from commit 730649da0eb8700ac9853c6b77e5f0300f3f0c14)

pimd: zlog_info changed to zlog_notice for neighbor up/down event

Co-authored-by: Sarita Patra <saritap@vmware.com>
Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>
(cherry picked from commit 69b2df12bb54f5a776dc40bb4b360a152b2cc9c8)

pimd: make pim interface hold interval range 1-630

Making the interface holdtime range to 3.5 times the hello-time

As per 7761, Section 4.11:
The Holdtime in a Hello message should be set to
   (3.5 * Hello_Period), giving a default value of 105 seconds.

Therefore providing the user also to configure max upto 3.5 times
the hello timer interval.

Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>
(cherry picked from commit 142774530ade49f63997bd52c434457fe8979bdf)

pimd: Adding BSM status in the show commands

Adding BSM status in the CLI and json output for
"show ip pim interface"

Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>
(cherry picked from commit 6eedc1a5b9d67e0c55b89125b5ddd584b4bd5e32)

Merge pull request #9172 from FRRouting/mergify/bp/stable/8.0/pr-8864

lib: fix interface configuration after vrf change (backport #8864)

Merge pull request #9174 from FRRouting/mergify/bp/stable/8.0/pr-8731

zebra: Fix pseudowires with backup nexthops (backport #8731)

Merge pull request #9173 from FRRouting/mergify/bp/stable/8.0/pr-8824

isisd, ospfd: update interface_link_params callback to check for change (backport #8824)

Merge pull request #9171 from FRRouting/mergify/bp/stable/8.0/pr-9039

bgpd: Do not check for NULL values for vni_hash_cmp() (backport #9039)

Merge pull request #9170 from FRRouting/mergify/bp/stable/8.0/pr-9036

bgpd: hash compare functions never receive null values (backport #9036)

Merge pull request #9169 from FRRouting/mergify/bp/stable/8.0/pr-8780

zebra: fix a couple of coverity warnings (backport #8780)

Merge pull request #9168 from FRRouting/mergify/bp/stable/8.0/pr-8836

bgpd: Call bgp_dest_unlock_node() inside bgp_adj_in_remove() (backport #8836)

zebra: update pw dataplane info

Include the complete set of primary and backup nexthops from
the resolving route for a pseudowire. Add accessors for that
info. Modify the logic that creates the fib set of pw nexthops
so that only installed, labelled nexthops are included.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
(cherry picked from commit 072b487b8f1b07829ccc547627ef7a0aa84ab289)

zebra: revise pw reachability logic

Modify the pseudowire reachability logic so that it returns
success if there is at least one installed labelled nexthop for
the route resolving the pw destination. We also check for
valid backup nexthops if necessary, in case there's been a
switchover event.
Only OpenBSD requires that _all_ nexthops be labelled, so we
have a more strict version of the logic also.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
(cherry picked from commit 0d145d47c89263caeb2ae21fe09ac6d5e99de789)

zebra: add boolean to control pw reachability checking

Add a boolean to control whether pseudowire reachability
checking needs to be strict.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
(cherry picked from commit 6fb3580882bef9cf94aa69a4b202eb9ea5307898)

zebra: use const in rib_match

Use const in common rib_match api.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
(cherry picked from commit bc77c3bb8abb15ff29c5e93a97e08fe3b7a3d1e9)

isisd, ospfd: update interface_link_params callback to check for change

Adding defensive code to the interface_link_params zebra callback
to check if the link params changed before taking action.

Signed-off-by: Karen Schoener <karen@voltanet.io>
(cherry picked from commit 0b4124c18cb826849f18af58dbc712db7d14b993)

lib: fix interface configuration after vrf change

This commit fixes the following problem:

- enter the interface node
- move the interface to another VRF
- try to continue configuring the interface

It is not possible to continue configuration because the XPath stored in
the vty doesn't correspond with the actual state of the system anymore.

For example:
```
nfware# conf
nfware(config)# interface enp2s0

<-- move the enp2s0 to a different VRF -->

nfware(config-if)# ip router isis 1
% Failed to get iface dnode in candidate DB
```

To fix the issue, go through all connected vty shells and update the
stored XPath.

Suggested-by: Renato Westphal <renato@opensourcerouting.org>
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
(cherry picked from commit 763725cd5e431cb4f4ec385e35b312cc7807163a)

tools: Add coccinelle script for hash compare functions NULL values

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
(cherry picked from commit 107df351c6f95ef15a045cde85697c0ee3b222b2)

bgpd: Do not check for NULL values for vni_hash_cmp()

There is no need to test for null values in the hash compare
function as that we are guaranteed to send in data in
the hash compare functions.

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
(cherry picked from commit ce40c6279a46dde35e25a6d31416e4e1ce519a18)

bgpd: hash compare functions never receive null values

There is no need to test for null values in the hash compare
function as that we are guaranteed to send in data in
the hash compare functions.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
(cherry picked from commit 63245a641a028dc991de3a5266052e41d876ab20)

*: unify prefix copying

There are a few places in the code where we use PREFIX_COPY(_IPV4/IPV6)
macro to copy a prefix. Let's always use prefix_copy function for this.

This should fix CID 1482142 and 1504610.

Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
(cherry picked from commit b08dcc3f3f0b128b4662f3be86eb53075e93ac9f)

bgpd: Call bgp_dest_unlock_node() inside bgp_adj_in_remove()

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
(cherry picked from commit 6a840fd93f147e69e5546618ad7e1001cb819c4a)

Merge pull request #9161 from idryzhov/backport-8976

[8.0] bgpd: Unlock bgp_dest for bgp_distance_unset if distance does not match (backport #8976)

Merge pull request #9160 from ton31337/fix/missing_unlock_for_bgp_dest_8.0

bgpd: [8.0] Don't forget bgp_dest_unlock_node for bgp_static_set()

Merge pull request #9159 from FRRouting/mergify/bp/stable/8.0/pr-9091

zebra: trigger remove all access vlans info for access port (backport #9091)

Merge pull request #9157 from FRRouting/mergify/bp/stable/8.0/pr-9105

vtysh, lib, zebra: fix exit from link-params and pseudowire nodes (backport #9105)

Merge pull request #9156 from FRRouting/mergify/bp/stable/8.0/pr-9094

pathd: don't use localtime (backport #9094)

Merge pull request #9158 from FRRouting/mergify/bp/stable/8.0/pr-9102

build: fix LDFLAGS confusion & gcov (backport #9102)

Merge pull request #9154 from FRRouting/mergify/bp/stable/8.0/pr-9095

ospf6d: always generate default route for stubs (backport #9095)

Merge pull request #9152 from FRRouting/mergify/bp/stable/8.0/pr-9080

bgpd: Drop unnecessary chars for filtered reason (backport #9080)

Merge pull request #9150 from FRRouting/mergify/bp/stable/8.0/pr-9063

zebra: fix ifp pointer for groups/recursives (backport #9063)

Merge pull request #9133 from FRRouting/mergify/bp/stable/8.0/pr-8867

tools: make frr-reload recognize `pbr table range` lines as single-line contexts (backport #8867)

Merge pull request #9138 from FRRouting/mergify/bp/stable/8.0/pr-8337

Reload with routemaps (backport #8337)

Merge pull request #9128 from FRRouting/mergify/bp/stable/8.0/pr-9116

vtysh: Handle `en` better when in -u for vtysh (backport #9116)

Merge pull request #9141 from FRRouting/mergify/bp/stable/8.0/pr-8962

bgpd: Ensure v6 LL address is available before establishing peering (backport #8962)

Merge pull request #9129 from FRRouting/mergify/bp/stable/8.0/pr-9120

zebra: Remove MM seq from evpn rmac json output (backport #9120)

Merge pull request #9127 from FRRouting/mergify/bp/stable/8.0/pr-9126

bgpd: Fix rpki spacing to be 1 for indentation (backport #9126)

Merge pull request #9153 from FRRouting/mergify/bp/stable/8.0/pr-9093

ospfd: ospfd crash while giving 'clear ip ospf neighbor' (backport #9093)

Merge pull request #9151 from FRRouting/mergify/bp/stable/8.0/pr-9062

bgpd: BGP dampening JSON fixes (backport #9062)

Merge pull request #9149 from FRRouting/mergify/bp/stable/8.0/pr-9055

bgpd: Reflect changes to pfxSnt when using default-originate (backport #9055)

Merge pull request #9147 from FRRouting/mergify/bp/stable/8.0/pr-9024

isisd: fix setting of the attached bit (backport #9024)

Merge pull request #9146 from FRRouting/mergify/bp/stable/8.0/pr-8961

bgpd: associate correct nexthop when using peer link-local (backport #8961)

Merge pull request #9145 from FRRouting/mergify/bp/stable/8.0/pr-8734

bgpd: Do not delete peer_af structure when deactivating peer-group from an address-family. (backport #8734)

Merge pull request #9144 from FRRouting/mergify/bp/stable/8.0/pr-9004

staticd: fix bug of Null0 wrongly converted into blackhole in running config (backport #9004)

Merge pull request #9142 from FRRouting/mergify/bp/stable/8.0/pr-8958

bgpd: nht unresolved with global address next-hop (backport #8958)

Merge pull request #9140 from FRRouting/mergify/bp/stable/8.0/pr-8950

ospf6d: use per-vrf router id instead of one global (backport #8950)

Merge pull request #9139 from FRRouting/mergify/bp/stable/8.0/pr-8909

isisd: fix extra space in the mpls-te config output (backport #8909)

Merge pull request #9137 from FRRouting/mergify/bp/stable/8.0/pr-8902

isisd: fix uninitialized variable when searching for LSP (backport #8902)

Merge pull request #9136 from FRRouting/mergify/bp/stable/8.0/pr-8869

bgpd: Force process networks on VRF creation (backport #8869)

Merge pull request #9135 from FRRouting/mergify/bp/stable/8.0/pr-8557

ospfd: External lsa handling in opaque capabilities enable/disable (backport #8557)

Merge pull request #9134 from FRRouting/mergify/bp/stable/8.0/pr-8334

ospf6d: Release last dbdesc packet after router dead interval (backport #8334)

Merge pull request #9132 from FRRouting/mergify/bp/stable/8.0/pr-8892

fabricd: fix running config (backport #8892)

Merge pull request #9131 from FRRouting/mergify/bp/stable/8.0/pr-8822

tools: add mac access-list context to frr-reload.py (backport #8822)

Merge pull request #9130 from FRRouting/mergify/bp/stable/8.0/pr-8955

ospfd: show ip ospf route json does not shown metric and tag (backport #8955)

bgpd: Unlock bgp_dest for bgp_distance_unset if distance does not match

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>

bgpd: Don't forget bgp_dest_unlock_node for bgp_static_set()

Before returning an error, unlock bgp dest which is locked by
bgp_node_lookup().

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>

zebra: trigger remove all access vlans for access port

When port was removed from last access vlan, the linux kernel
won't send any vlan info in the netlink message, it might affact
the evpn mh not withdraw EAD-EVI routes.

Signed-off-by: Gord Chen <gord_chen@edge-core.com>
(cherry picked from commit ec8977510e9ddb9b8a2ea610d0acbbc5355c1fac)

build: use `--coverage` for gcov

libtool does not understand `-coverage` with a single dash.  Official
gcc docs also say `--coverage` rather than `-coverage`.  (clang lists
both.)

Also, for correct linking, libtool needs `--coverage` in LDFLAGS as
opposed to `-lgcov` (with the latter you get library ordering/deps
issues)

Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
(cherry picked from commit 81aff2127f35da2ec667bc60989cac7df7a8ef48)