[mirror_frr.git] / lib / nexthop.c

/* A generic nexthop structure
 * Copyright (C) 2013 Cumulus Networks, Inc.
 *
 * This file is part of Quagga.
 *
 * Quagga is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * Quagga is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */
#include <zebra.h>

#include "prefix.h"
#include "table.h"
#include "memory.h"
#include "command.h"
#include "if.h"
#include "log.h"
#include "sockunion.h"
#include "linklist.h"
#include "thread.h"
#include "prefix.h"
#include "nexthop.h"
#include "mpls.h"
#include "jhash.h"
#include "printfrr.h"
#include "vrf.h"

DEFINE_MTYPE_STATIC(LIB, NEXTHOP, "Nexthop")
DEFINE_MTYPE_STATIC(LIB, NH_LABEL, "Nexthop label")

static int _nexthop_labels_cmp(const struct nexthop *nh1,
			       const struct nexthop *nh2)
{
	const struct mpls_label_stack *nhl1 = NULL;
	const struct mpls_label_stack *nhl2 = NULL;

	nhl1 = nh1->nh_label;
	nhl2 = nh2->nh_label;

	/* No labels is a match */
	if (!nhl1 && !nhl2)
		return 0;

	if (nhl1 && !nhl2)
		return 1;

	if (nhl2 && !nhl1)
		return -1;

	if (nhl1->num_labels > nhl2->num_labels)
		return 1;

	if (nhl1->num_labels < nhl2->num_labels)
		return -1;

	return memcmp(nhl1->label, nhl2->label, nhl1->num_labels);
}

int nexthop_g_addr_cmp(enum nexthop_types_t type, const union g_addr *addr1,
		       const union g_addr *addr2)
{
	int ret = 0;

	switch (type) {
	case NEXTHOP_TYPE_IPV4:
	case NEXTHOP_TYPE_IPV4_IFINDEX:
		ret = IPV4_ADDR_CMP(&addr1->ipv4, &addr2->ipv4);
		break;
	case NEXTHOP_TYPE_IPV6:
	case NEXTHOP_TYPE_IPV6_IFINDEX:
		ret = IPV6_ADDR_CMP(&addr1->ipv6, &addr2->ipv6);
		break;
	case NEXTHOP_TYPE_IFINDEX:
	case NEXTHOP_TYPE_BLACKHOLE:
		/* No addr here */
		break;
	}

	return ret;
}

static int _nexthop_gateway_cmp(const struct nexthop *nh1,
				const struct nexthop *nh2)
{
	return nexthop_g_addr_cmp(nh1->type, &nh1->gate, &nh2->gate);
}

static int _nexthop_source_cmp(const struct nexthop *nh1,
			       const struct nexthop *nh2)
{
	return nexthop_g_addr_cmp(nh1->type, &nh1->src, &nh2->src);
}

static int _nexthop_cmp_no_labels(const struct nexthop *next1,
				  const struct nexthop *next2)
{
	int ret = 0;

	if (next1->vrf_id < next2->vrf_id)
		return -1;

	if (next1->vrf_id > next2->vrf_id)
		return 1;

	if (next1->type < next2->type)
		return -1;

	if (next1->type > next2->type)
		return 1;

	switch (next1->type) {
	case NEXTHOP_TYPE_IPV4:
	case NEXTHOP_TYPE_IPV6:
		ret = _nexthop_gateway_cmp(next1, next2);
		if (ret != 0)
			return ret;
		break;
	case NEXTHOP_TYPE_IPV4_IFINDEX:
	case NEXTHOP_TYPE_IPV6_IFINDEX:
		ret = _nexthop_gateway_cmp(next1, next2);
		if (ret != 0)
			return ret;
		/* Intentional Fall-Through */
	case NEXTHOP_TYPE_IFINDEX:
		if (next1->ifindex < next2->ifindex)
			return -1;

		if (next1->ifindex > next2->ifindex)
			return 1;
		break;
	case NEXTHOP_TYPE_BLACKHOLE:
		if (next1->bh_type < next2->bh_type)
			return -1;

		if (next1->bh_type > next2->bh_type)
			return 1;
		break;
	}

	ret = _nexthop_source_cmp(next1, next2);

	return ret;
}

int nexthop_cmp(const struct nexthop *next1, const struct nexthop *next2)
{
	int ret = 0;

	ret = _nexthop_cmp_no_labels(next1, next2);
	if (ret != 0)
		return ret;

	ret = _nexthop_labels_cmp(next1, next2);

	return ret;
}

int nexthop_same_firsthop(struct nexthop *next1, struct nexthop *next2)
{
	int type1 = NEXTHOP_FIRSTHOPTYPE(next1->type);
	int type2 = NEXTHOP_FIRSTHOPTYPE(next2->type);

	if (type1 != type2)
		return 0;
	switch (type1) {
	case NEXTHOP_TYPE_IPV4_IFINDEX:
		if (!IPV4_ADDR_SAME(&next1->gate.ipv4, &next2->gate.ipv4))
			return 0;
		if (next1->ifindex != next2->ifindex)
			return 0;
		break;
	case NEXTHOP_TYPE_IFINDEX:
		if (next1->ifindex != next2->ifindex)
			return 0;
		break;
	case NEXTHOP_TYPE_IPV6_IFINDEX:
		if (!IPV6_ADDR_SAME(&next1->gate.ipv6, &next2->gate.ipv6))
			return 0;
		if (next1->ifindex != next2->ifindex)
			return 0;
		break;
	default:
		/* do nothing */
		break;
	}
	return 1;
}

/*
 * nexthop_type_to_str
 */
const char *nexthop_type_to_str(enum nexthop_types_t nh_type)
{
	static const char *const desc[] = {
		"none",		 "Directly connected",
		"IPv4 nexthop",  "IPv4 nexthop with ifindex",
		"IPv6 nexthop",  "IPv6 nexthop with ifindex",
		"Null0 nexthop",
	};

	return desc[nh_type];
}

/*
 * Check if the labels match for the 2 nexthops specified.
 */
bool nexthop_labels_match(const struct nexthop *nh1, const struct nexthop *nh2)
{
	if (_nexthop_labels_cmp(nh1, nh2) != 0)
		return false;

	return true;
}

struct nexthop *nexthop_new(void)
{
	return XCALLOC(MTYPE_NEXTHOP, sizeof(struct nexthop));
}

/* Free nexthop. */
void nexthop_free(struct nexthop *nexthop)
{
	nexthop_del_labels(nexthop);
	if (nexthop->resolved)
		nexthops_free(nexthop->resolved);
	XFREE(MTYPE_NEXTHOP, nexthop);
}

/* Frees a list of nexthops */
void nexthops_free(struct nexthop *nexthop)
{
	struct nexthop *nh, *next;

	for (nh = nexthop; nh; nh = next) {
		next = nh->next;
		nexthop_free(nh);
	}
}

bool nexthop_same(const struct nexthop *nh1, const struct nexthop *nh2)
{
	if (nh1 && !nh2)
		return false;

	if (!nh1 && nh2)
		return false;

	if (nh1 == nh2)
		return true;

	if (nexthop_cmp(nh1, nh2) != 0)
		return false;

	return true;
}

bool nexthop_same_no_labels(const struct nexthop *nh1,
			    const struct nexthop *nh2)
{
	if (nh1 && !nh2)
		return false;

	if (!nh1 && nh2)
		return false;

	if (nh1 == nh2)
		return true;

	if (_nexthop_cmp_no_labels(nh1, nh2) != 0)
		return false;

	return true;
}

/*
 * Allocate a new nexthop object and initialize it from various args.
 */
struct nexthop *nexthop_from_ifindex(ifindex_t ifindex, vrf_id_t vrf_id)
{
	struct nexthop *nexthop;

	nexthop = nexthop_new();
	nexthop->type = NEXTHOP_TYPE_IFINDEX;
	nexthop->ifindex = ifindex;
	nexthop->vrf_id = vrf_id;

	return nexthop;
}

struct nexthop *nexthop_from_ipv4(const struct in_addr *ipv4,
				  const struct in_addr *src,
				  vrf_id_t vrf_id)
{
	struct nexthop *nexthop;

	nexthop = nexthop_new();
	nexthop->type = NEXTHOP_TYPE_IPV4;
	nexthop->vrf_id = vrf_id;
	nexthop->gate.ipv4 = *ipv4;
	if (src)
		nexthop->src.ipv4 = *src;

	return nexthop;
}

struct nexthop *nexthop_from_ipv4_ifindex(const struct in_addr *ipv4,
					  const struct in_addr *src,
					  ifindex_t ifindex, vrf_id_t vrf_id)
{
	struct nexthop *nexthop;

	nexthop = nexthop_new();
	nexthop->type = NEXTHOP_TYPE_IPV4_IFINDEX;
	nexthop->vrf_id = vrf_id;
	nexthop->gate.ipv4 = *ipv4;
	if (src)
		nexthop->src.ipv4 = *src;
	nexthop->ifindex = ifindex;

	return nexthop;
}

struct nexthop *nexthop_from_ipv6(const struct in6_addr *ipv6,
				  vrf_id_t vrf_id)
{
	struct nexthop *nexthop;

	nexthop = nexthop_new();
	nexthop->vrf_id = vrf_id;
	nexthop->type = NEXTHOP_TYPE_IPV6;
	nexthop->gate.ipv6 = *ipv6;

	return nexthop;
}

struct nexthop *nexthop_from_ipv6_ifindex(const struct in6_addr *ipv6,
					  ifindex_t ifindex, vrf_id_t vrf_id)
{
	struct nexthop *nexthop;

	nexthop = nexthop_new();
	nexthop->vrf_id = vrf_id;
	nexthop->type = NEXTHOP_TYPE_IPV6_IFINDEX;
	nexthop->gate.ipv6 = *ipv6;
	nexthop->ifindex = ifindex;

	return nexthop;
}

struct nexthop *nexthop_from_blackhole(enum blackhole_type bh_type)
{
	struct nexthop *nexthop;

	nexthop = nexthop_new();
	nexthop->vrf_id = VRF_DEFAULT;
	nexthop->type = NEXTHOP_TYPE_BLACKHOLE;
	nexthop->bh_type = bh_type;

	return nexthop;
}

/* Update nexthop with label information. */
void nexthop_add_labels(struct nexthop *nexthop, enum lsp_types_t type,
			uint8_t num_labels, mpls_label_t *label)
{
	struct mpls_label_stack *nh_label;
	int i;

	if (num_labels == 0)
		return;

	nexthop->nh_label_type = type;
	nh_label = XCALLOC(MTYPE_NH_LABEL,
			   sizeof(struct mpls_label_stack)
				   + num_labels * sizeof(mpls_label_t));
	nh_label->num_labels = num_labels;
	for (i = 0; i < num_labels; i++)
		nh_label->label[i] = *(label + i);
	nexthop->nh_label = nh_label;
}

/* Free label information of nexthop, if present. */
void nexthop_del_labels(struct nexthop *nexthop)
{
	if (nexthop->nh_label) {
		XFREE(MTYPE_NH_LABEL, nexthop->nh_label);
		nexthop->nh_label_type = ZEBRA_LSP_NONE;
	}
}

const char *nexthop2str(const struct nexthop *nexthop, char *str, int size)
{
	switch (nexthop->type) {
	case NEXTHOP_TYPE_IFINDEX:
		snprintf(str, size, "if %u", nexthop->ifindex);
		break;
	case NEXTHOP_TYPE_IPV4:
	case NEXTHOP_TYPE_IPV4_IFINDEX:
		snprintf(str, size, "%s if %u", inet_ntoa(nexthop->gate.ipv4),
			 nexthop->ifindex);
		break;
	case NEXTHOP_TYPE_IPV6:
	case NEXTHOP_TYPE_IPV6_IFINDEX:
		snprintf(str, size, "%s if %u", inet6_ntoa(nexthop->gate.ipv6),
			 nexthop->ifindex);
		break;
	case NEXTHOP_TYPE_BLACKHOLE:
		snprintf(str, size, "blackhole");
		break;
	default:
		snprintf(str, size, "unknown");
		break;
	}

	return str;
}

/*
 * Iteration step for ALL_NEXTHOPS macro:
 * This is the tricky part. Check if `nexthop' has
 * NEXTHOP_FLAG_RECURSIVE set. If yes, this implies that `nexthop' has
 * at least one nexthop attached to `nexthop->resolved', which will be
 * the next one.
 *
 * If NEXTHOP_FLAG_RECURSIVE is not set, `nexthop' will progress in its
 * current chain. In case its current chain end is reached, it will move
 * upwards in the recursion levels and progress there. Whenever a step
 * forward in a chain is done, recursion will be checked again.
 * In a nustshell, it's equivalent to a pre-traversal order assuming that
 * left branch is 'resolved' and right branch is 'next':
 * https://en.wikipedia.org/wiki/Tree_traversal#/media/File:Sorted_binary_tree_preorder.svg
 */
struct nexthop *nexthop_next(const struct nexthop *nexthop)
{
	if (CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_RECURSIVE))
		return nexthop->resolved;

	if (nexthop->next)
		return nexthop->next;

	for (struct nexthop *par = nexthop->rparent; par; par = par->rparent)
		if (par->next)
			return par->next;

	return NULL;
}

/* Return the next nexthop in the tree that is resolved and active */
struct nexthop *nexthop_next_active_resolved(const struct nexthop *nexthop)
{
	struct nexthop *next = nexthop_next(nexthop);

	while (next
	       && (CHECK_FLAG(next->flags, NEXTHOP_FLAG_RECURSIVE)
		   || !CHECK_FLAG(next->flags, NEXTHOP_FLAG_ACTIVE)))
		next = nexthop_next(next);

	return next;
}

unsigned int nexthop_level(struct nexthop *nexthop)
{
	unsigned int rv = 0;

	for (struct nexthop *par = nexthop->rparent; par; par = par->rparent)
		rv++;

	return rv;
}

/* Only hash word-sized things, let cmp do the rest. */
uint32_t nexthop_hash_quick(const struct nexthop *nexthop)
{
	uint32_t key = 0x45afe398;

	key = jhash_3words(nexthop->type, nexthop->vrf_id,
			   nexthop->nh_label_type, key);

	if (nexthop->nh_label) {
		int labels = nexthop->nh_label->num_labels;
		int i = 0;

		while (labels >= 3) {
			key = jhash_3words(nexthop->nh_label->label[i],
					   nexthop->nh_label->label[i + 1],
					   nexthop->nh_label->label[i + 2],
					   key);
			labels -= 3;
			i += 3;
		}

		if (labels >= 2) {
			key = jhash_2words(nexthop->nh_label->label[i],
					   nexthop->nh_label->label[i + 1],
					   key);
			labels -= 2;
			i += 2;
		}

		if (labels >= 1)
			key = jhash_1word(nexthop->nh_label->label[i], key);
	}

	key = jhash_2words(nexthop->ifindex,
			   CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_ONLINK),
			   key);

	return key;
}


#define GATE_SIZE 4 /* Number of uint32_t words in struct g_addr */

/* For a more granular hash */
uint32_t nexthop_hash(const struct nexthop *nexthop)
{
	uint32_t gate_src_rmap_raw[GATE_SIZE * 3] = {};
	/* Get all the quick stuff */
	uint32_t key = nexthop_hash_quick(nexthop);

	assert(((sizeof(nexthop->gate) + sizeof(nexthop->src)
		 + sizeof(nexthop->rmap_src))
		/ 3)
	       == (GATE_SIZE * sizeof(uint32_t)));

	memcpy(gate_src_rmap_raw, &nexthop->gate, GATE_SIZE);
	memcpy(gate_src_rmap_raw + GATE_SIZE, &nexthop->src, GATE_SIZE);
	memcpy(gate_src_rmap_raw + (2 * GATE_SIZE), &nexthop->rmap_src,
	       GATE_SIZE);

	key = jhash2(gate_src_rmap_raw, (GATE_SIZE * 3), key);

	return key;
}

void nexthop_copy(struct nexthop *copy, const struct nexthop *nexthop,
		  struct nexthop *rparent)
{
	copy->vrf_id = nexthop->vrf_id;
	copy->ifindex = nexthop->ifindex;
	copy->type = nexthop->type;
	copy->flags = nexthop->flags;
	memcpy(&copy->gate, &nexthop->gate, sizeof(nexthop->gate));
	memcpy(&copy->src, &nexthop->src, sizeof(nexthop->src));
	memcpy(&copy->rmap_src, &nexthop->rmap_src, sizeof(nexthop->rmap_src));
	copy->rparent = rparent;
	if (nexthop->nh_label)
		nexthop_add_labels(copy, nexthop->nh_label_type,
				   nexthop->nh_label->num_labels,
				   &nexthop->nh_label->label[0]);
}

struct nexthop *nexthop_dup(const struct nexthop *nexthop,
			    struct nexthop *rparent)
{
	struct nexthop *new = nexthop_new();

	nexthop_copy(new, nexthop, rparent);
	return new;
}

/*
 * nexthop printing variants:
 *	%pNHvv
 *		via 1.2.3.4
 *		via 1.2.3.4, eth0
 *		is directly connected, eth0
 *		unreachable (blackhole)
 *	%pNHv
 *		1.2.3.4
 *		1.2.3.4, via eth0
 *		directly connected, eth0
 *		unreachable (blackhole)
 *	%pNHs
 *		nexthop2str()
 */
printfrr_ext_autoreg_p("NH", printfrr_nh)
static ssize_t printfrr_nh(char *buf, size_t bsz, const char *fmt,
			   int prec, const void *ptr)
{
	const struct nexthop *nexthop = ptr;
	struct fbuf fb = { .buf = buf, .pos = buf, .len = bsz - 1 };
	bool do_ifi = false;
	const char *s, *v_is = "", *v_via = "", *v_viaif = "via ";
	ssize_t ret = 3;

	switch (fmt[2]) {
	case 'v':
		if (fmt[3] == 'v') {
			v_is = "is ";
			v_via = "via ";
			v_viaif = "";
			ret++;
		}

		switch (nexthop->type) {
		case NEXTHOP_TYPE_IPV4:
		case NEXTHOP_TYPE_IPV4_IFINDEX:
			bprintfrr(&fb, "%s%pI4", v_via, &nexthop->gate.ipv4);
			do_ifi = true;
			break;
		case NEXTHOP_TYPE_IPV6:
		case NEXTHOP_TYPE_IPV6_IFINDEX:
			bprintfrr(&fb, "%s%pI6", v_via, &nexthop->gate.ipv6);
			do_ifi = true;
			break;
		case NEXTHOP_TYPE_IFINDEX:
			bprintfrr(&fb, "%sdirectly connected, %s", v_is,
				ifindex2ifname(nexthop->ifindex,
					       nexthop->vrf_id));
			break;
		case NEXTHOP_TYPE_BLACKHOLE:
			switch (nexthop->bh_type) {
			case BLACKHOLE_REJECT:
				s = " (ICMP unreachable)";
				break;
			case BLACKHOLE_ADMINPROHIB:
				s = " (ICMP admin-prohibited)";
				break;
			case BLACKHOLE_NULL:
				s = " (blackhole)";
				break;
			default:
				s = "";
				break;
			}
			bprintfrr(&fb, "unreachable%s", s);
			break;
		default:
			break;
		}
		if (do_ifi && nexthop->ifindex)
			bprintfrr(&fb, ", %s%s", v_viaif, ifindex2ifname(
					nexthop->ifindex,
					nexthop->vrf_id));

		*fb.pos = '\0';
		return ret;
	case 's':
		nexthop2str(nexthop, buf, bsz);
		return 3;
	}
	return 0;
}
Commit	Line	Data
fb018d25 DS	1	/* A generic nexthop structure
	2	* Copyright (C) 2013 Cumulus Networks, Inc.
	3	*
a399694f	4	* This file is part of Quagga.
fb018d25	5	*
a399694f	6	* Quagga is free software; you can redistribute it and/or modify it
fb018d25 DS	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2, or (at your option) any
	9	* later version.
	10	*
a399694f	11	* Quagga is distributed in the hope that it will be useful, but
fb018d25 DS	12	* WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	14	* General Public License for more details.
	15	*
896014f4 DL	16	* You should have received a copy of the GNU General Public License along
	17	* with this program; see the file COPYING; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
fb018d25 DS	19	*/
	20	#include <zebra.h>
	21
	22	#include "prefix.h"
	23	#include "table.h"
	24	#include "memory.h"
fb018d25 DS	25	#include "command.h"
	26	#include "if.h"
	27	#include "log.h"
	28	#include "sockunion.h"
	29	#include "linklist.h"
	30	#include "thread.h"
	31	#include "prefix.h"
	32	#include "nexthop.h"
40c7bdb0	33	#include "mpls.h"
d36d0d57	34	#include "jhash.h"
d52ec572	35	#include "printfrr.h"
f3323df2	36	#include "vrf.h"
fb018d25	37
d62a17ae	38	DEFINE_MTYPE_STATIC(LIB, NEXTHOP, "Nexthop")
d62a17ae	39	DEFINE_MTYPE_STATIC(LIB, NH_LABEL, "Nexthop label")
4a1ab8e4	40
a5a2d802 SW	41	static int _nexthop_labels_cmp(const struct nexthop *nh1,
a5a2d802 SW	42	const struct nexthop *nh2)
ebc403dd SW	43	{
	44	const struct mpls_label_stack *nhl1 = NULL;
	45	const struct mpls_label_stack *nhl2 = NULL;
	46
	47	nhl1 = nh1->nh_label;
	48	nhl2 = nh2->nh_label;
	49
	50	/* No labels is a match */
	51	if (!nhl1 && !nhl2)
	52	return 0;
	53
	54	if (nhl1 && !nhl2)
	55	return 1;
	56
	57	if (nhl2 && !nhl1)
	58	return -1;
	59
	60	if (nhl1->num_labels > nhl2->num_labels)
	61	return 1;
	62
	63	if (nhl1->num_labels < nhl2->num_labels)
	64	return -1;
	65
	66	return memcmp(nhl1->label, nhl2->label, nhl1->num_labels);
	67	}
	68
3c6e0bd4 SW	69	int nexthop_g_addr_cmp(enum nexthop_types_t type, const union g_addr *addr1,
3c6e0bd4 SW	70	const union g_addr *addr2)
24cfec84 SW	71	{
	72	int ret = 0;
	73
	74	switch (type) {
	75	case NEXTHOP_TYPE_IPV4:
	76	case NEXTHOP_TYPE_IPV4_IFINDEX:
	77	ret = IPV4_ADDR_CMP(&addr1->ipv4, &addr2->ipv4);
	78	break;
	79	case NEXTHOP_TYPE_IPV6:
	80	case NEXTHOP_TYPE_IPV6_IFINDEX:
	81	ret = IPV6_ADDR_CMP(&addr1->ipv6, &addr2->ipv6);
	82	break;
	83	case NEXTHOP_TYPE_IFINDEX:
	84	case NEXTHOP_TYPE_BLACKHOLE:
	85	/* No addr here */
	86	break;
	87	}
	88
	89	return ret;
	90	}
	91
a5a2d802 SW	92	static int _nexthop_gateway_cmp(const struct nexthop *nh1,
a5a2d802 SW	93	const struct nexthop *nh2)
24cfec84	94	{
3c6e0bd4	95	return nexthop_g_addr_cmp(nh1->type, &nh1->gate, &nh2->gate);
24cfec84 SW	96	}
24cfec84 SW	97
a5a2d802 SW	98	static int _nexthop_source_cmp(const struct nexthop *nh1,
a5a2d802 SW	99	const struct nexthop *nh2)
24cfec84	100	{
3c6e0bd4	101	return nexthop_g_addr_cmp(nh1->type, &nh1->src, &nh2->src);
24cfec84 SW	102	}
24cfec84 SW	103
a5a2d802 SW	104	static int _nexthop_cmp_no_labels(const struct nexthop *next1,
a5a2d802 SW	105	const struct nexthop *next2)
776c3e90	106	{
ff0e16da	107	int ret = 0;
776c3e90 DS	108
	109	if (next1->vrf_id < next2->vrf_id)
	110	return -1;
	111
	112	if (next1->vrf_id > next2->vrf_id)
	113	return 1;
	114
	115	if (next1->type < next2->type)
	116	return -1;
	117
	118	if (next1->type > next2->type)
	119	return 1;
	120
ff0e16da	121	switch (next1->type) {
776c3e90	122	case NEXTHOP_TYPE_IPV4:
776c3e90	123	case NEXTHOP_TYPE_IPV6:
a5a2d802 SW	124	ret = _nexthop_gateway_cmp(next1, next2);
a5a2d802 SW	125	if (ret != 0)
776c3e90 DS	126	return ret;
	127	break;
	128	case NEXTHOP_TYPE_IPV4_IFINDEX:
	129	case NEXTHOP_TYPE_IPV6_IFINDEX:
a5a2d802 SW	130	ret = _nexthop_gateway_cmp(next1, next2);
a5a2d802 SW	131	if (ret != 0)
776c3e90 DS	132	return ret;
	133	/* Intentional Fall-Through */
	134	case NEXTHOP_TYPE_IFINDEX:
	135	if (next1->ifindex < next2->ifindex)
	136	return -1;
	137
	138	if (next1->ifindex > next2->ifindex)
	139	return 1;
	140	break;
	141	case NEXTHOP_TYPE_BLACKHOLE:
	142	if (next1->bh_type < next2->bh_type)
	143	return -1;
	144
	145	if (next1->bh_type > next2->bh_type)
	146	return 1;
	147	break;
	148	}
	149
a5a2d802 SW	150	ret = _nexthop_source_cmp(next1, next2);
	151
	152	return ret;
	153	}
	154
	155	int nexthop_cmp(const struct nexthop next1, const struct nexthop next2)
	156	{
	157	int ret = 0;
	158
	159	ret = _nexthop_cmp_no_labels(next1, next2);
	160	if (ret != 0)
ff0e16da SW	161	return ret;
ff0e16da SW	162
a5a2d802 SW	163	ret = _nexthop_labels_cmp(next1, next2);
a5a2d802 SW	164
776c3e90 DS	165	return ret;
	166	}
	167
996c9314	168	int nexthop_same_firsthop(struct nexthop next1, struct nexthop next2)
25b9cb0c DL	169	{
	170	int type1 = NEXTHOP_FIRSTHOPTYPE(next1->type);
	171	int type2 = NEXTHOP_FIRSTHOPTYPE(next2->type);
	172
	173	if (type1 != type2)
	174	return 0;
996c9314	175	switch (type1) {
25b9cb0c	176	case NEXTHOP_TYPE_IPV4_IFINDEX:
996c9314	177	if (!IPV4_ADDR_SAME(&next1->gate.ipv4, &next2->gate.ipv4))
25b9cb0c DL	178	return 0;
	179	if (next1->ifindex != next2->ifindex)
	180	return 0;
	181	break;
	182	case NEXTHOP_TYPE_IFINDEX:
	183	if (next1->ifindex != next2->ifindex)
	184	return 0;
	185	break;
	186	case NEXTHOP_TYPE_IPV6_IFINDEX:
996c9314	187	if (!IPV6_ADDR_SAME(&next1->gate.ipv6, &next2->gate.ipv6))
25b9cb0c DL	188	return 0;
	189	if (next1->ifindex != next2->ifindex)
	190	return 0;
d62a17ae	191	break;
	192	default:
	193	/* do nothing */
	194	break;
	195	}
	196	return 1;
fb018d25 DS	197	}
	198
	199	/*
	200	* nexthop_type_to_str
	201	*/
d62a17ae	202	const char *nexthop_type_to_str(enum nexthop_types_t nh_type)
fb018d25	203	{
2b64873d	204	static const char *const desc[] = {
d62a17ae	205	"none", "Directly connected",
	206	"IPv4 nexthop", "IPv4 nexthop with ifindex",
	207	"IPv6 nexthop", "IPv6 nexthop with ifindex",
	208	"Null0 nexthop",
	209	};
	210
	211	return desc[nh_type];
fb018d25	212	}
a399694f	213
a64448ba DS	214	/*
	215	* Check if the labels match for the 2 nexthops specified.
	216	*/
89dc3160	217	bool nexthop_labels_match(const struct nexthop nh1, const struct nexthop nh2)
a64448ba	218	{
a5a2d802	219	if (_nexthop_labels_cmp(nh1, nh2) != 0)
89dc3160	220	return false;
a64448ba	221
89dc3160	222	return true;
a64448ba DS	223	}
a64448ba DS	224
d62a17ae	225	struct nexthop *nexthop_new(void)
a399694f	226	{
d62a17ae	227	return XCALLOC(MTYPE_NEXTHOP, sizeof(struct nexthop));
a399694f DS	228	}
a399694f DS	229
a399694f	230	/* Free nexthop. */
d62a17ae	231	void nexthop_free(struct nexthop *nexthop)
a399694f	232	{
d62a17ae	233	nexthop_del_labels(nexthop);
	234	if (nexthop->resolved)
	235	nexthops_free(nexthop->resolved);
	236	XFREE(MTYPE_NEXTHOP, nexthop);
a399694f DS	237	}
	238
	239	/* Frees a list of nexthops */
d62a17ae	240	void nexthops_free(struct nexthop *nexthop)
a399694f	241	{
d62a17ae	242	struct nexthop nh, next;
a399694f	243
d62a17ae	244	for (nh = nexthop; nh; nh = next) {
	245	next = nh->next;
	246	nexthop_free(nh);
	247	}
a399694f	248	}
80c2442a	249
31919191 DS	250	bool nexthop_same(const struct nexthop nh1, const struct nexthop nh2)
	251	{
	252	if (nh1 && !nh2)
	253	return false;
	254
	255	if (!nh1 && nh2)
	256	return false;
	257
	258	if (nh1 == nh2)
	259	return true;
	260
2ed74b93	261	if (nexthop_cmp(nh1, nh2) != 0)
31919191 DS	262	return false;
31919191 DS	263
2ed74b93	264	return true;
31919191 DS	265	}
31919191 DS	266
a5a2d802 SW	267	bool nexthop_same_no_labels(const struct nexthop *nh1,
	268	const struct nexthop *nh2)
	269	{
	270	if (nh1 && !nh2)
	271	return false;
	272
	273	if (!nh1 && nh2)
	274	return false;
	275
	276	if (nh1 == nh2)
	277	return true;
	278
	279	if (_nexthop_cmp_no_labels(nh1, nh2) != 0)
	280	return false;
	281
	282	return true;
	283	}
	284
f3323df2 MS	285	/*
	286	* Allocate a new nexthop object and initialize it from various args.
	287	*/
	288	struct nexthop *nexthop_from_ifindex(ifindex_t ifindex, vrf_id_t vrf_id)
	289	{
	290	struct nexthop *nexthop;
	291
	292	nexthop = nexthop_new();
	293	nexthop->type = NEXTHOP_TYPE_IFINDEX;
	294	nexthop->ifindex = ifindex;
	295	nexthop->vrf_id = vrf_id;
	296
	297	return nexthop;
	298	}
	299
	300	struct nexthop nexthop_from_ipv4(const struct in_addr ipv4,
	301	const struct in_addr *src,
	302	vrf_id_t vrf_id)
	303	{
	304	struct nexthop *nexthop;
	305
	306	nexthop = nexthop_new();
	307	nexthop->type = NEXTHOP_TYPE_IPV4;
	308	nexthop->vrf_id = vrf_id;
	309	nexthop->gate.ipv4 = *ipv4;
	310	if (src)
	311	nexthop->src.ipv4 = *src;
	312
	313	return nexthop;
	314	}
	315
	316	struct nexthop nexthop_from_ipv4_ifindex(const struct in_addr ipv4,
	317	const struct in_addr *src,
	318	ifindex_t ifindex, vrf_id_t vrf_id)
	319	{
	320	struct nexthop *nexthop;
	321
	322	nexthop = nexthop_new();
	323	nexthop->type = NEXTHOP_TYPE_IPV4_IFINDEX;
	324	nexthop->vrf_id = vrf_id;
	325	nexthop->gate.ipv4 = *ipv4;
	326	if (src)
	327	nexthop->src.ipv4 = *src;
	328	nexthop->ifindex = ifindex;
	329
	330	return nexthop;
	331	}
	332
	333	struct nexthop nexthop_from_ipv6(const struct in6_addr ipv6,
	334	vrf_id_t vrf_id)
	335	{
	336	struct nexthop *nexthop;
	337
	338	nexthop = nexthop_new();
	339	nexthop->vrf_id = vrf_id;
	340	nexthop->type = NEXTHOP_TYPE_IPV6;
	341	nexthop->gate.ipv6 = *ipv6;
	342
	343	return nexthop;
	344	}
	345
	346	struct nexthop nexthop_from_ipv6_ifindex(const struct in6_addr ipv6,
	347	ifindex_t ifindex, vrf_id_t vrf_id)
	348	{
349	struct nexthop *nexthop;
350
351	nexthop = nexthop_new();
352	nexthop->vrf_id = vrf_id;
353	nexthop->type = NEXTHOP_TYPE_IPV6_IFINDEX;
354	nexthop->gate.ipv6 = *ipv6;
355	nexthop->ifindex = ifindex;
356
357	return nexthop;
358	}
359
360	struct nexthop *nexthop_from_blackhole(enum blackhole_type bh_type)
361	{
362	struct nexthop *nexthop;
363
364	nexthop = nexthop_new();
365	nexthop->vrf_id = VRF_DEFAULT;
366	nexthop->type = NEXTHOP_TYPE_BLACKHOLE;
367	nexthop->bh_type = bh_type;
368
369	return nexthop;
370	}
371
40c7bdb0	372	/* Update nexthop with label information. */
d62a17ae	373	void nexthop_add_labels(struct nexthop *nexthop, enum lsp_types_t type,
d7c0a89a	374	uint8_t num_labels, mpls_label_t *label)
40c7bdb0	375	{
8ecdb26e	376	struct mpls_label_stack *nh_label;
d62a17ae	377	int i;
d62a17ae	378
054af19a MS	379	if (num_labels == 0)
	380	return;
	381
d62a17ae	382	nexthop->nh_label_type = type;
d62a17ae	383	nh_label = XCALLOC(MTYPE_NH_LABEL,
8ecdb26e	384	sizeof(struct mpls_label_stack)
d62a17ae	385	+ num_labels * sizeof(mpls_label_t));
	386	nh_label->num_labels = num_labels;
	387	for (i = 0; i < num_labels; i++)
	388	nh_label->label[i] = *(label + i);
	389	nexthop->nh_label = nh_label;
40c7bdb0	390	}
	391
	392	/* Free label information of nexthop, if present. */
d62a17ae	393	void nexthop_del_labels(struct nexthop *nexthop)
40c7bdb0	394	{
d62a17ae	395	if (nexthop->nh_label) {
	396	XFREE(MTYPE_NH_LABEL, nexthop->nh_label);
	397	nexthop->nh_label_type = ZEBRA_LSP_NONE;
	398	}
40c7bdb0	399	}
40c7bdb0	400
d36d0d57	401	const char nexthop2str(const struct nexthop nexthop, char *str, int size)
80c2442a	402	{
d62a17ae	403	switch (nexthop->type) {
	404	case NEXTHOP_TYPE_IFINDEX:
	405	snprintf(str, size, "if %u", nexthop->ifindex);
	406	break;
	407	case NEXTHOP_TYPE_IPV4:
d62a17ae	408	case NEXTHOP_TYPE_IPV4_IFINDEX:
	409	snprintf(str, size, "%s if %u", inet_ntoa(nexthop->gate.ipv4),
	410	nexthop->ifindex);
	411	break;
	412	case NEXTHOP_TYPE_IPV6:
d62a17ae	413	case NEXTHOP_TYPE_IPV6_IFINDEX:
	414	snprintf(str, size, "%s if %u", inet6_ntoa(nexthop->gate.ipv6),
	415	nexthop->ifindex);
	416	break;
	417	case NEXTHOP_TYPE_BLACKHOLE:
	418	snprintf(str, size, "blackhole");
	419	break;
	420	default:
	421	snprintf(str, size, "unknown");
	422	break;
	423	}
	424
	425	return str;
80c2442a	426	}
9fb47c05 CF	427
	428	/*
	429	* Iteration step for ALL_NEXTHOPS macro:
	430	* This is the tricky part. Check if `nexthop' has
	431	* NEXTHOP_FLAG_RECURSIVE set. If yes, this implies that `nexthop' has
	432	* at least one nexthop attached to `nexthop->resolved', which will be
	433	* the next one.
	434	*
	435	* If NEXTHOP_FLAG_RECURSIVE is not set, `nexthop' will progress in its
	436	* current chain. In case its current chain end is reached, it will move
	437	* upwards in the recursion levels and progress there. Whenever a step
	438	* forward in a chain is done, recursion will be checked again.
	439	* In a nustshell, it's equivalent to a pre-traversal order assuming that
	440	* left branch is 'resolved' and right branch is 'next':
	441	* https://en.wikipedia.org/wiki/Tree_traversal#/media/File:Sorted_binary_tree_preorder.svg
	442	*/
17c25e03	443	struct nexthop nexthop_next(const struct nexthop nexthop)
9fb47c05	444	{
d62a17ae	445	if (CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_RECURSIVE))
d62a17ae	446	return nexthop->resolved;
9fb47c05	447
d62a17ae	448	if (nexthop->next)
d62a17ae	449	return nexthop->next;
9fb47c05	450
d62a17ae	451	for (struct nexthop *par = nexthop->rparent; par; par = par->rparent)
	452	if (par->next)
	453	return par->next;
9fb47c05	454
d62a17ae	455	return NULL;
9fb47c05	456	}
e3054ee9	457
986a6617	458	/* Return the next nexthop in the tree that is resolved and active */
17c25e03	459	struct nexthop nexthop_next_active_resolved(const struct nexthop nexthop)
986a6617 SW	460	{
	461	struct nexthop *next = nexthop_next(nexthop);
	462
	463	while (next
	464	&& (CHECK_FLAG(next->flags, NEXTHOP_FLAG_RECURSIVE)
	465	\|\| !CHECK_FLAG(next->flags, NEXTHOP_FLAG_ACTIVE)))
	466	next = nexthop_next(next);
	467
	468	return next;
	469	}
	470
d62a17ae	471	unsigned int nexthop_level(struct nexthop *nexthop)
e3054ee9	472	{
d62a17ae	473	unsigned int rv = 0;
e3054ee9	474
d62a17ae	475	for (struct nexthop *par = nexthop->rparent; par; par = par->rparent)
d62a17ae	476	rv++;
e3054ee9	477
d62a17ae	478	return rv;
e3054ee9	479	}
d36d0d57	480
73a38187 SW	481	/* Only hash word-sized things, let cmp do the rest. */
73a38187 SW	482	uint32_t nexthop_hash_quick(const struct nexthop *nexthop)
d36d0d57	483	{
1b1fe1c4	484	uint32_t key = 0x45afe398;
d36d0d57	485
1b1fe1c4 SW	486	key = jhash_3words(nexthop->type, nexthop->vrf_id,
1b1fe1c4 SW	487	nexthop->nh_label_type, key);
a15e669c	488
1b1fe1c4 SW	489	if (nexthop->nh_label) {
	490	int labels = nexthop->nh_label->num_labels;
	491	int i = 0;
	492
	493	while (labels >= 3) {
	494	key = jhash_3words(nexthop->nh_label->label[i],
	495	nexthop->nh_label->label[i + 1],
	496	nexthop->nh_label->label[i + 2],
	497	key);
	498	labels -= 3;
	499	i += 3;
	500	}
	501
	502	if (labels >= 2) {
	503	key = jhash_2words(nexthop->nh_label->label[i],
	504	nexthop->nh_label->label[i + 1],
	505	key);
	506	labels -= 2;
	507	i += 2;
	508	}
	509
	510	if (labels >= 1)
	511	key = jhash_1word(nexthop->nh_label->label[i], key);
	512	}
	513
cba6a409 SW	514	key = jhash_2words(nexthop->ifindex,
	515	CHECK_FLAG(nexthop->flags, NEXTHOP_FLAG_ONLINK),
	516	key);
a7df4ccf	517
d36d0d57 QY	518	return key;
d36d0d57 QY	519	}
d52ec572	520
73a38187 SW	521
	522	#define GATE_SIZE 4 /* Number of uint32_t words in struct g_addr */
	523
	524	/* For a more granular hash */
	525	uint32_t nexthop_hash(const struct nexthop *nexthop)
	526	{
	527	uint32_t gate_src_rmap_raw[GATE_SIZE * 3] = {};
	528	/* Get all the quick stuff */
	529	uint32_t key = nexthop_hash_quick(nexthop);
	530
	531	assert(((sizeof(nexthop->gate) + sizeof(nexthop->src)
	532	+ sizeof(nexthop->rmap_src))
	533	/ 3)
	534	== (GATE_SIZE * sizeof(uint32_t)));
	535
	536	memcpy(gate_src_rmap_raw, &nexthop->gate, GATE_SIZE);
	537	memcpy(gate_src_rmap_raw + GATE_SIZE, &nexthop->src, GATE_SIZE);
	538	memcpy(gate_src_rmap_raw + (2 * GATE_SIZE), &nexthop->rmap_src,
	539	GATE_SIZE);
	540
	541	key = jhash2(gate_src_rmap_raw, (GATE_SIZE * 3), key);
	542
	543	return key;
	544	}
	545
e7addf02 SW	546	void nexthop_copy(struct nexthop copy, const struct nexthop nexthop,
	547	struct nexthop *rparent)
	548	{
	549	copy->vrf_id = nexthop->vrf_id;
	550	copy->ifindex = nexthop->ifindex;
	551	copy->type = nexthop->type;
	552	copy->flags = nexthop->flags;
	553	memcpy(&copy->gate, &nexthop->gate, sizeof(nexthop->gate));
	554	memcpy(&copy->src, &nexthop->src, sizeof(nexthop->src));
	555	memcpy(&copy->rmap_src, &nexthop->rmap_src, sizeof(nexthop->rmap_src));
	556	copy->rparent = rparent;
	557	if (nexthop->nh_label)
	558	nexthop_add_labels(copy, nexthop->nh_label_type,
	559	nexthop->nh_label->num_labels,
	560	&nexthop->nh_label->label[0]);
	561	}
	562
504d0a40 SW	563	struct nexthop nexthop_dup(const struct nexthop nexthop,
	564	struct nexthop *rparent)
	565	{
	566	struct nexthop *new = nexthop_new();
	567
	568	nexthop_copy(new, nexthop, rparent);
	569	return new;
	570	}
	571
d52ec572 DL	572	/*
	573	* nexthop printing variants:
	574	* %pNHvv
	575	* via 1.2.3.4
	576	* via 1.2.3.4, eth0
	577	* is directly connected, eth0
	578	* unreachable (blackhole)
	579	* %pNHv
	580	* 1.2.3.4
	581	* 1.2.3.4, via eth0
	582	* directly connected, eth0
	583	* unreachable (blackhole)
	584	* %pNHs
	585	* nexthop2str()
	586	*/
	587	printfrr_ext_autoreg_p("NH", printfrr_nh)
	588	static ssize_t printfrr_nh(char buf, size_t bsz, const char fmt,
	589	int prec, const void *ptr)
	590	{
	591	const struct nexthop *nexthop = ptr;
	592	struct fbuf fb = { .buf = buf, .pos = buf, .len = bsz - 1 };
	593	bool do_ifi = false;
	594	const char s, v_is = "", v_via = "", v_viaif = "via ";
	595	ssize_t ret = 3;
	596
	597	switch (fmt[2]) {
	598	case 'v':
	599	if (fmt[3] == 'v') {
	600	v_is = "is ";
	601	v_via = "via ";
	602	v_viaif = "";
	603	ret++;
	604	}
	605
	606	switch (nexthop->type) {
	607	case NEXTHOP_TYPE_IPV4:
	608	case NEXTHOP_TYPE_IPV4_IFINDEX:
	609	bprintfrr(&fb, "%s%pI4", v_via, &nexthop->gate.ipv4);
	610	do_ifi = true;
	611	break;
	612	case NEXTHOP_TYPE_IPV6:
	613	case NEXTHOP_TYPE_IPV6_IFINDEX:
	614	bprintfrr(&fb, "%s%pI6", v_via, &nexthop->gate.ipv6);
	615	do_ifi = true;
	616	break;
	617	case NEXTHOP_TYPE_IFINDEX:
	618	bprintfrr(&fb, "%sdirectly connected, %s", v_is,
	619	ifindex2ifname(nexthop->ifindex,
	620	nexthop->vrf_id));
	621	break;
	622	case NEXTHOP_TYPE_BLACKHOLE:
	623	switch (nexthop->bh_type) {
	624	case BLACKHOLE_REJECT:
	625	s = " (ICMP unreachable)";
	626	break;
	627	case BLACKHOLE_ADMINPROHIB:
	628	s = " (ICMP admin-prohibited)";
	629	break;
	630	case BLACKHOLE_NULL:
	631	s = " (blackhole)";
	632	break;
	633	default:
	634	s = "";
	635	break;
636	}
637	bprintfrr(&fb, "unreachable%s", s);
638	break;
639	default:
640	break;
641	}
642	if (do_ifi && nexthop->ifindex)
643	bprintfrr(&fb, ", %s%s", v_viaif, ifindex2ifname(
644	nexthop->ifindex,
645	nexthop->vrf_id));
646
647	*fb.pos = '\0';
648	return ret;
649	case 's':
650	nexthop2str(nexthop, buf, bsz);
651	return 3;
652	}
653	return 0;
654	}