[mirror_frr.git] / lib / mpls.h

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * MPLS definitions
 * Copyright 2015 Cumulus Networks, Inc.
 */

#ifndef _QUAGGA_MPLS_H
#define _QUAGGA_MPLS_H

#include <zebra.h>
#include <vxlan.h>
#include <arpa/inet.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifdef MPLS_LABEL_MAX
#undef MPLS_LABEL_MAX
#endif

#define MPLS_LABEL_HELPSTR                                                     \
	"Specify label(s) for this route\nOne or more "                        \
	"labels in the range (16-1048575) separated by '/'\n"

/* Well-known MPLS label values (RFC 3032 etc). */
#define MPLS_LABEL_IPV4_EXPLICIT_NULL  0       /* [RFC3032] */
#define MPLS_LABEL_ROUTER_ALERT        1       /* [RFC3032] */
#define MPLS_LABEL_IPV6_EXPLICIT_NULL  2       /* [RFC3032] */
#define MPLS_LABEL_IMPLICIT_NULL       3       /* [RFC3032] */
#define MPLS_LABEL_ELI                 7       /* [RFC6790] */
#define MPLS_LABEL_GAL                 13      /* [RFC5586] */
#define MPLS_LABEL_OAM_ALERT           14      /* [RFC3429] */
#define MPLS_LABEL_EXTENSION           15      /* [RFC7274] */
#define MPLS_LABEL_MAX                 1048575
#define MPLS_LABEL_VALUE_MASK          0x000FFFFF
#define MPLS_LABEL_NONE                0xFFFFFFFF /* for internal use only */

/* Minimum and maximum label values */
#define MPLS_LABEL_RESERVED_MIN            0
#define MPLS_LABEL_RESERVED_MAX            15
#define MPLS_LABEL_UNRESERVED_MIN          16
#define MPLS_LABEL_UNRESERVED_MAX          1048575
#define MPLS_LABEL_BASE_ANY                0

/* Default min and max SRGB label range */
/* Even if the SRGB allows to manage different Label space between routers,
 * if an operator want to use the same SRGB for all its router, we must fix
 * a common range. However, Cisco start its SRGB at 16000 and Juniper ends
 * its SRGB at 16384 for OSPF. Thus, by fixing the minimum SRGB label to
 * 8000 we could deal with both Cisco and Juniper.
 */
#define MPLS_DEFAULT_MIN_SRGB_LABEL        8000
#define MPLS_DEFAULT_MAX_SRGB_LABEL        50000
#define MPLS_DEFAULT_MIN_SRGB_SIZE         5000
#define MPLS_DEFAULT_MAX_SRGB_SIZE         20000

/* Maximum # labels that can be pushed. */
#define MPLS_MAX_LABELS                    16

#define IS_MPLS_RESERVED_LABEL(label) (label <= MPLS_LABEL_RESERVED_MAX)

#define IS_MPLS_UNRESERVED_LABEL(label)                                        \
	(label >= MPLS_LABEL_UNRESERVED_MIN                                    \
	 && label <= MPLS_LABEL_UNRESERVED_MAX)

/* Definitions for a MPLS label stack entry (RFC 3032). This encodes the
 * label, EXP, BOS and TTL fields.
 */
typedef unsigned int mpls_lse_t;

#define MPLS_LS_LABEL_MASK             0xFFFFF000
#define MPLS_LS_LABEL_SHIFT            12
#define MPLS_LS_EXP_MASK               0x00000E00
#define MPLS_LS_EXP_SHIFT              9
#define MPLS_LS_S_MASK                 0x00000100
#define MPLS_LS_S_SHIFT                8
#define MPLS_LS_TTL_MASK               0x000000FF
#define MPLS_LS_TTL_SHIFT              0

#define MPLS_LABEL_VALUE(lse)                                                  \
	((lse & MPLS_LS_LABEL_MASK) >> MPLS_LS_LABEL_SHIFT)
#define MPLS_LABEL_EXP(lse) ((lse & MPLS_LS_EXP_MASK) >> MPLS_LS_EXP_SHIFT)
#define MPLS_LABEL_BOS(lse) ((lse & MPLS_LS_S_MASK) >> MPLS_LS_S_SHIFT)
#define MPLS_LABEL_TTL(lse) ((lse & MPLS_LS_TTL_MASK) >> MPLS_LS_TTL_SHIFT)

#define IS_MPLS_LABEL_BOS(ls)          (MPLS_LABEL_BOS(ls) == 1)

#define MPLS_LABEL_LEN_BITS            20

/* MPLS label value as a 32-bit (mostly we only care about the label value). */
typedef unsigned int mpls_label_t;

struct mpls_label_stack {
	uint8_t num_labels;
	uint8_t reserved[3];
	mpls_label_t label[0]; /* 1 or more labels */
};

/* The MPLS explicit-null label is 0 which means when you memset a mpls_label_t
 * to zero you have set that variable to explicit-null which was probably not
 * your intent. The work-around is to use one bit to indicate if the
 * mpls_label_t has been set by the user. MPLS_INVALID_LABEL has this bit clear
 * so that we can use MPLS_INVALID_LABEL to initialize mpls_label_t variables.
 */
#define MPLS_INVALID_LABEL                 0xFFFDFFFF

/* LSP types. */
enum lsp_types_t {
	ZEBRA_LSP_NONE = 0,   /* No LSP. */
	ZEBRA_LSP_STATIC = 1, /* Static LSP. */
	ZEBRA_LSP_LDP = 2,    /* LDP LSP. */
	ZEBRA_LSP_BGP = 3,    /* BGP LSP. */
	ZEBRA_LSP_OSPF_SR = 4,/* OSPF Segment Routing LSP. */
	ZEBRA_LSP_ISIS_SR = 5,/* IS-IS Segment Routing LSP. */
	ZEBRA_LSP_SHARP = 6,  /* Identifier for test protocol */
	ZEBRA_LSP_SRTE = 7,   /* SR-TE LSP */
	ZEBRA_LSP_EVPN = 8,  /* EVPN VNI Label */
};

/* Functions for basic label operations. */

static inline void vni2label(vni_t vni, mpls_label_t *label)
{
	uint8_t *tag = (uint8_t *)label;

	assert(tag);

	tag[0] = (vni >> 16) & 0xFF;
	tag[1] = (vni >> 8) & 0xFF;
	tag[2] = vni & 0xFF;
}

static inline vni_t label2vni(const mpls_label_t *label)
{
	uint8_t *tag = (uint8_t *)label;
	vni_t vni;

	assert(tag);

	vni = ((uint32_t)*tag++ << 16);
	vni |= (uint32_t)*tag++ << 8;
	vni |= (uint32_t)(*tag & 0xFF);

	return vni;
}

/* Encode a label stack entry from fields; convert to network byte-order as
 * the Netlink interface expects MPLS labels to be in this format.
 */
static inline mpls_lse_t mpls_lse_encode(mpls_label_t label, uint32_t ttl,
					 uint32_t exp, uint32_t bos)
{
	mpls_lse_t lse;
	lse = htonl((label << MPLS_LS_LABEL_SHIFT) | (exp << MPLS_LS_EXP_SHIFT)
		    | (bos ? (1 << MPLS_LS_S_SHIFT) : 0)
		    | (ttl << MPLS_LS_TTL_SHIFT));
	return lse;
}

/* Extract the fields from a label stack entry after converting to host-byte
 * order. This is expected to be called only for messages received over the
 * Netlink interface.
 */
static inline void mpls_lse_decode(mpls_lse_t lse, mpls_label_t *label,
				   uint32_t *ttl, uint32_t *exp, uint32_t *bos)
{
	mpls_lse_t local_lse;

	local_lse = ntohl(lse);
	*label = MPLS_LABEL_VALUE(local_lse);
	*exp = MPLS_LABEL_EXP(local_lse);
	*bos = MPLS_LABEL_BOS(local_lse);
	*ttl = MPLS_LABEL_TTL(local_lse);
}

/* Invalid label index value (when used with BGP Prefix-SID). Should
 * match the BGP definition.
 */
#define MPLS_INVALID_LABEL_INDEX   0xFFFFFFFF

/* Printable string for labels (with consideration for reserved values). */
static inline char *label2str(mpls_label_t label, enum lsp_types_t type,
			      char *buf, size_t len)
{
	if (type == ZEBRA_LSP_EVPN) {
		snprintf(buf, len, "%u", label2vni(&label));
		return (buf);
	}

	switch (label) {
	case MPLS_LABEL_IPV4_EXPLICIT_NULL:
		strlcpy(buf, "IPv4 Explicit Null", len);
		return (buf);
	case MPLS_LABEL_ROUTER_ALERT:
		strlcpy(buf, "Router Alert", len);
		return (buf);
	case MPLS_LABEL_IPV6_EXPLICIT_NULL:
		strlcpy(buf, "IPv6 Explicit Null", len);
		return (buf);
	case MPLS_LABEL_IMPLICIT_NULL:
		strlcpy(buf, "implicit-null", len);
		return (buf);
	case MPLS_LABEL_ELI:
		strlcpy(buf, "Entropy Label Indicator", len);
		return (buf);
	case MPLS_LABEL_GAL:
		strlcpy(buf, "Generic Associated Channel", len);
		return (buf);
	case MPLS_LABEL_OAM_ALERT:
		strlcpy(buf, "OAM Alert", len);
		return (buf);
	case MPLS_LABEL_EXTENSION:
		strlcpy(buf, "Extension", len);
		return (buf);
	default:
		if (label < 16)
			snprintf(buf, len, "Reserved (%u)", label);
		else
			snprintf(buf, len, "%u", label);
		return buf;
	}
}

/*
 * String to label conversion, labels separated by '/'.
 */
int mpls_str2label(const char *label_str, uint8_t *num_labels,
		   mpls_label_t *labels);

/* Generic string buffer for label-stack-to-str */
#define MPLS_LABEL_STRLEN 1024

/*
 * Label to string conversion, labels in string separated by '/'.
 */
char *mpls_label2str(uint8_t num_labels, const mpls_label_t *labels, char *buf,
		     int len, enum lsp_types_t type, int pretty);

#ifdef __cplusplus
}
#endif

#endif
Commit	Line	Data
acddc0ed	1	// SPDX-License-Identifier: GPL-2.0-or-later
50f34207	2	/*
	3	* MPLS definitions
	4	* Copyright 2015 Cumulus Networks, Inc.
50f34207	5	*/
	6
	7	#ifndef _QUAGGA_MPLS_H
	8	#define _QUAGGA_MPLS_H
	9
43e52561	10	#include <zebra.h>
4645cb6b	11	#include <vxlan.h>
fea12efb	12	#include <arpa/inet.h>
fea12efb	13
5e244469 RW	14	#ifdef __cplusplus
	15	extern "C" {
	16	#endif
	17
70e98a7f DS	18	#ifdef MPLS_LABEL_MAX
	19	#undef MPLS_LABEL_MAX
	20	#endif
	21
f890b146 DS	22	#define MPLS_LABEL_HELPSTR \
	23	"Specify label(s) for this route\nOne or more " \
	24	"labels in the range (16-1048575) separated by '/'\n"
	25
50f34207	26	/* Well-known MPLS label values (RFC 3032 etc). */
70e98a7f DS	27	#define MPLS_LABEL_IPV4_EXPLICIT_NULL 0 /* [RFC3032] */
	28	#define MPLS_LABEL_ROUTER_ALERT 1 /* [RFC3032] */
	29	#define MPLS_LABEL_IPV6_EXPLICIT_NULL 2 /* [RFC3032] */
	30	#define MPLS_LABEL_IMPLICIT_NULL 3 /* [RFC3032] */
	31	#define MPLS_LABEL_ELI 7 /* [RFC6790] */
	32	#define MPLS_LABEL_GAL 13 /* [RFC5586] */
	33	#define MPLS_LABEL_OAM_ALERT 14 /* [RFC3429] */
	34	#define MPLS_LABEL_EXTENSION 15 /* [RFC7274] */
	35	#define MPLS_LABEL_MAX 1048575
1b3f47d0	36	#define MPLS_LABEL_VALUE_MASK 0x000FFFFF
42567e00	37	#define MPLS_LABEL_NONE 0xFFFFFFFF /* for internal use only */
50f34207	38
50f34207	39	/* Minimum and maximum label values */
70e98a7f DS	40	#define MPLS_LABEL_RESERVED_MIN 0
	41	#define MPLS_LABEL_RESERVED_MAX 15
	42	#define MPLS_LABEL_UNRESERVED_MIN 16
	43	#define MPLS_LABEL_UNRESERVED_MAX 1048575
0e3b6a92	44	#define MPLS_LABEL_BASE_ANY 0
50f34207	45
12929668	46	/* Default min and max SRGB label range */
7726c479 OD	47	/* Even if the SRGB allows to manage different Label space between routers,
	48	* if an operator want to use the same SRGB for all its router, we must fix
	49	* a common range. However, Cisco start its SRGB at 16000 and Juniper ends
	50	* its SRGB at 16384 for OSPF. Thus, by fixing the minimum SRGB label to
	51	* 8000 we could deal with both Cisco and Juniper.
	52	*/
	53	#define MPLS_DEFAULT_MIN_SRGB_LABEL 8000
cf9b9f77 OD	54	#define MPLS_DEFAULT_MAX_SRGB_LABEL 50000
	55	#define MPLS_DEFAULT_MIN_SRGB_SIZE 5000
	56	#define MPLS_DEFAULT_MAX_SRGB_SIZE 20000
12929668	57
52dd3aa4 RW	58	/* Maximum # labels that can be pushed. */
	59	#define MPLS_MAX_LABELS 16
	60
95535717	61	#define IS_MPLS_RESERVED_LABEL(label) (label <= MPLS_LABEL_RESERVED_MAX)
50f34207	62
d62a17ae	63	#define IS_MPLS_UNRESERVED_LABEL(label) \
70e98a7f DS	64	(label >= MPLS_LABEL_UNRESERVED_MIN \
70e98a7f DS	65	&& label <= MPLS_LABEL_UNRESERVED_MAX)
50f34207	66
	67	/* Definitions for a MPLS label stack entry (RFC 3032). This encodes the
	68	* label, EXP, BOS and TTL fields.
	69	*/
	70	typedef unsigned int mpls_lse_t;
	71
	72	#define MPLS_LS_LABEL_MASK 0xFFFFF000
	73	#define MPLS_LS_LABEL_SHIFT 12
	74	#define MPLS_LS_EXP_MASK 0x00000E00
	75	#define MPLS_LS_EXP_SHIFT 9
	76	#define MPLS_LS_S_MASK 0x00000100
	77	#define MPLS_LS_S_SHIFT 8
	78	#define MPLS_LS_TTL_MASK 0x000000FF
	79	#define MPLS_LS_TTL_SHIFT 0
	80
d62a17ae	81	#define MPLS_LABEL_VALUE(lse) \
	82	((lse & MPLS_LS_LABEL_MASK) >> MPLS_LS_LABEL_SHIFT)
	83	#define MPLS_LABEL_EXP(lse) ((lse & MPLS_LS_EXP_MASK) >> MPLS_LS_EXP_SHIFT)
	84	#define MPLS_LABEL_BOS(lse) ((lse & MPLS_LS_S_MASK) >> MPLS_LS_S_SHIFT)
	85	#define MPLS_LABEL_TTL(lse) ((lse & MPLS_LS_TTL_MASK) >> MPLS_LS_TTL_SHIFT)
50f34207	86
	87	#define IS_MPLS_LABEL_BOS(ls) (MPLS_LABEL_BOS(ls) == 1)
	88
	89	#define MPLS_LABEL_LEN_BITS 20
	90
	91	/* MPLS label value as a 32-bit (mostly we only care about the label value). */
	92	typedef unsigned int mpls_label_t;
	93
8ecdb26e DS	94	struct mpls_label_stack {
	95	uint8_t num_labels;
	96	uint8_t reserved[3];
	97	mpls_label_t label[0]; /* 1 or more labels */
	98	};
	99
9bedbb1e DW	100	/* The MPLS explicit-null label is 0 which means when you memset a mpls_label_t
	101	* to zero you have set that variable to explicit-null which was probably not
	102	* your intent. The work-around is to use one bit to indicate if the
	103	* mpls_label_t has been set by the user. MPLS_INVALID_LABEL has this bit clear
	104	* so that we can use MPLS_INVALID_LABEL to initialize mpls_label_t variables.
	105	*/
	106	#define MPLS_INVALID_LABEL 0xFFFDFFFF
50f34207	107
ce549947	108	/* LSP types. */
d62a17ae	109	enum lsp_types_t {
	110	ZEBRA_LSP_NONE = 0, /* No LSP. */
	111	ZEBRA_LSP_STATIC = 1, /* Static LSP. */
	112	ZEBRA_LSP_LDP = 2, /* LDP LSP. */
cf9b9f77	113	ZEBRA_LSP_BGP = 3, /* BGP LSP. */
635a039e	114	ZEBRA_LSP_OSPF_SR = 4,/* OSPF Segment Routing LSP. */
26f6acaf RW	115	ZEBRA_LSP_ISIS_SR = 5,/* IS-IS Segment Routing LSP. */
26f6acaf RW	116	ZEBRA_LSP_SHARP = 6, /* Identifier for test protocol */
31f937fb	117	ZEBRA_LSP_SRTE = 7, /* SR-TE LSP */
4645cb6b	118	ZEBRA_LSP_EVPN = 8, /* EVPN VNI Label */
ce549947 RW	119	};
ce549947 RW	120
50f34207	121	/* Functions for basic label operations. */
50f34207	122
4645cb6b SW	123	static inline void vni2label(vni_t vni, mpls_label_t *label)
	124	{
	125	uint8_t tag = (uint8_t )label;
	126
1dd3cd10 SW	127	assert(tag);
1dd3cd10 SW	128
4645cb6b SW	129	tag[0] = (vni >> 16) & 0xFF;
	130	tag[1] = (vni >> 8) & 0xFF;
	131	tag[2] = vni & 0xFF;
	132	}
	133
	134	static inline vni_t label2vni(const mpls_label_t *label)
	135	{
	136	uint8_t tag = (uint8_t )label;
	137	vni_t vni;
	138
1dd3cd10 SW	139	assert(tag);
1dd3cd10 SW	140
4645cb6b SW	141	vni = ((uint32_t)*tag++ << 16);
	142	vni \|= (uint32_t)*tag++ << 8;
	143	vni \|= (uint32_t)(*tag & 0xFF);
	144
	145	return vni;
	146	}
	147
50f34207	148	/* Encode a label stack entry from fields; convert to network byte-order as
	149	* the Netlink interface expects MPLS labels to be in this format.
	150	*/
d7c0a89a QY	151	static inline mpls_lse_t mpls_lse_encode(mpls_label_t label, uint32_t ttl,
d7c0a89a QY	152	uint32_t exp, uint32_t bos)
50f34207	153	{
d62a17ae	154	mpls_lse_t lse;
	155	lse = htonl((label << MPLS_LS_LABEL_SHIFT) \| (exp << MPLS_LS_EXP_SHIFT)
	156	\| (bos ? (1 << MPLS_LS_S_SHIFT) : 0)
	157	\| (ttl << MPLS_LS_TTL_SHIFT));
	158	return lse;
50f34207	159	}
	160
	161	/* Extract the fields from a label stack entry after converting to host-byte
	162	* order. This is expected to be called only for messages received over the
	163	* Netlink interface.
	164	*/
d62a17ae	165	static inline void mpls_lse_decode(mpls_lse_t lse, mpls_label_t *label,
d7c0a89a	166	uint32_t ttl, uint32_t exp, uint32_t *bos)
50f34207	167	{
d62a17ae	168	mpls_lse_t local_lse;
50f34207	169
d62a17ae	170	local_lse = ntohl(lse);
	171	*label = MPLS_LABEL_VALUE(local_lse);
	172	*exp = MPLS_LABEL_EXP(local_lse);
	173	*bos = MPLS_LABEL_BOS(local_lse);
	174	*ttl = MPLS_LABEL_TTL(local_lse);
50f34207	175	}
50f34207	176
28d58fd7 VV	177	/* Invalid label index value (when used with BGP Prefix-SID). Should
	178	* match the BGP definition.
	179	*/
	180	#define MPLS_INVALID_LABEL_INDEX 0xFFFFFFFF
	181
50f34207	182	/* Printable string for labels (with consideration for reserved values). */
4645cb6b SW	183	static inline char *label2str(mpls_label_t label, enum lsp_types_t type,
4645cb6b SW	184	char *buf, size_t len)
50f34207	185	{
4645cb6b SW	186	if (type == ZEBRA_LSP_EVPN) {
	187	snprintf(buf, len, "%u", label2vni(&label));
	188	return (buf);
	189	}
	190
d62a17ae	191	switch (label) {
70e98a7f	192	case MPLS_LABEL_IPV4_EXPLICIT_NULL:
d62a17ae	193	strlcpy(buf, "IPv4 Explicit Null", len);
d62a17ae	194	return (buf);
70e98a7f	195	case MPLS_LABEL_ROUTER_ALERT:
d62a17ae	196	strlcpy(buf, "Router Alert", len);
d62a17ae	197	return (buf);
70e98a7f	198	case MPLS_LABEL_IPV6_EXPLICIT_NULL:
0437e105	199	strlcpy(buf, "IPv6 Explicit Null", len);
d62a17ae	200	return (buf);
70e98a7f	201	case MPLS_LABEL_IMPLICIT_NULL:
d62a17ae	202	strlcpy(buf, "implicit-null", len);
d62a17ae	203	return (buf);
70e98a7f	204	case MPLS_LABEL_ELI:
d62a17ae	205	strlcpy(buf, "Entropy Label Indicator", len);
d62a17ae	206	return (buf);
70e98a7f	207	case MPLS_LABEL_GAL:
d62a17ae	208	strlcpy(buf, "Generic Associated Channel", len);
d62a17ae	209	return (buf);
70e98a7f	210	case MPLS_LABEL_OAM_ALERT:
d62a17ae	211	strlcpy(buf, "OAM Alert", len);
d62a17ae	212	return (buf);
70e98a7f	213	case MPLS_LABEL_EXTENSION:
d62a17ae	214	strlcpy(buf, "Extension", len);
	215	return (buf);
	216	default:
	217	if (label < 16)
	218	snprintf(buf, len, "Reserved (%u)", label);
	219	else
	220	snprintf(buf, len, "%u", label);
d3909a21	221	return buf;
d62a17ae	222	}
50f34207	223	}
50f34207	224
036fdaad DS	225	/*
	226	* String to label conversion, labels separated by '/'.
	227	*/
	228	int mpls_str2label(const char label_str, uint8_t num_labels,
	229	mpls_label_t *labels);
	230
e4a1ec74 MS	231	/* Generic string buffer for label-stack-to-str */
	232	#define MPLS_LABEL_STRLEN 1024
	233
036fdaad DS	234	/*
	235	* Label to string conversion, labels in string separated by '/'.
	236	*/
e4a1ec74	237	char mpls_label2str(uint8_t num_labels, const mpls_label_t labels, char *buf,
4645cb6b	238	int len, enum lsp_types_t type, int pretty);
eac6e3f0	239
5e244469 RW	240	#ifdef __cplusplus
	241	}
	242	#endif
	243
50f34207	244	#endif