[mirror_frr.git] / lib / srv6.h

/*
 * SRv6 definitions
 * Copyright (C) 2020  Hiroki Shirokura, LINE Corporation
 *
 * This program 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 of the License, or (at your option)
 * any later version.
 *
 * This program 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
 */

#ifndef _FRR_SRV6_H
#define _FRR_SRV6_H

#include <zebra.h>
#include "prefix.h"
#include "json.h"

#include <arpa/inet.h>
#include <netinet/in.h>

#define SRV6_MAX_SIDS 16
#define SRV6_LOCNAME_SIZE 256

#ifdef __cplusplus
extern "C" {
#endif

#define sid2str(sid, str, size) \
	inet_ntop(AF_INET6, sid, str, size)

enum seg6_mode_t {
	INLINE,
	ENCAP,
	L2ENCAP,
};

enum seg6local_action_t {
	ZEBRA_SEG6_LOCAL_ACTION_UNSPEC       = 0,
	ZEBRA_SEG6_LOCAL_ACTION_END          = 1,
	ZEBRA_SEG6_LOCAL_ACTION_END_X        = 2,
	ZEBRA_SEG6_LOCAL_ACTION_END_T        = 3,
	ZEBRA_SEG6_LOCAL_ACTION_END_DX2      = 4,
	ZEBRA_SEG6_LOCAL_ACTION_END_DX6      = 5,
	ZEBRA_SEG6_LOCAL_ACTION_END_DX4      = 6,
	ZEBRA_SEG6_LOCAL_ACTION_END_DT6      = 7,
	ZEBRA_SEG6_LOCAL_ACTION_END_DT4      = 8,
	ZEBRA_SEG6_LOCAL_ACTION_END_B6       = 9,
	ZEBRA_SEG6_LOCAL_ACTION_END_B6_ENCAP = 10,
	ZEBRA_SEG6_LOCAL_ACTION_END_BM       = 11,
	ZEBRA_SEG6_LOCAL_ACTION_END_S        = 12,
	ZEBRA_SEG6_LOCAL_ACTION_END_AS       = 13,
	ZEBRA_SEG6_LOCAL_ACTION_END_AM       = 14,
	ZEBRA_SEG6_LOCAL_ACTION_END_BPF      = 15,
	ZEBRA_SEG6_LOCAL_ACTION_END_DT46     = 16,
};

struct seg6_segs {
	size_t num_segs;
	struct in6_addr segs[256];
};

struct seg6local_context {
	struct in_addr nh4;
	struct in6_addr nh6;
	uint32_t table;
};

struct srv6_locator {
	char name[SRV6_LOCNAME_SIZE];
	struct prefix_ipv6 prefix;

	/*
	 * Bit length of SRv6 locator described in
	 * draft-ietf-bess-srv6-services-05#section-3.2.1
	 */
	uint8_t block_bits_length;
	uint8_t node_bits_length;
	uint8_t function_bits_length;
	uint8_t argument_bits_length;

	int algonum;
	uint64_t current;
	bool status_up;
	struct list *chunks;

	uint8_t flags;
#define SRV6_LOCATOR_USID (1 << 0) /* The SRv6 Locator is a uSID Locator */

	QOBJ_FIELDS;
};
DECLARE_QOBJ_TYPE(srv6_locator);

struct srv6_locator_chunk {
	char locator_name[SRV6_LOCNAME_SIZE];
	struct prefix_ipv6 prefix;

	/*
	 * Bit length of SRv6 locator described in
	 * draft-ietf-bess-srv6-services-05#section-3.2.1
	 */
	uint8_t block_bits_length;
	uint8_t node_bits_length;
	uint8_t function_bits_length;
	uint8_t argument_bits_length;

	/*
	 * For Zclient communication values
	 */
	uint8_t keep;
	uint8_t proto;
	uint16_t instance;
	uint32_t session_id;

	uint8_t flags;
};

/*
 * SRv6 Endpoint Behavior codepoints, as defined by IANA in
 * https://www.iana.org/assignments/segment-routing/segment-routing.xhtml
 */
enum srv6_endpoint_behavior_codepoint {
	SRV6_ENDPOINT_BEHAVIOR_RESERVED       = 0x0000,
	SRV6_ENDPOINT_BEHAVIOR_END_DT6        = 0x0012,
	SRV6_ENDPOINT_BEHAVIOR_END_DT4        = 0x0013,
	SRV6_ENDPOINT_BEHAVIOR_END_DT46       = 0x0014,
	SRV6_ENDPOINT_BEHAVIOR_END_DT6_USID   = 0x003E,
	SRV6_ENDPOINT_BEHAVIOR_END_DT4_USID   = 0x003F,
	SRV6_ENDPOINT_BEHAVIOR_END_DT46_USID  = 0x0040,
	SRV6_ENDPOINT_BEHAVIOR_OPAQUE         = 0xFFFF,
};

struct nexthop_srv6 {
	/* SRv6 localsid info for Endpoint-behaviour */
	enum seg6local_action_t seg6local_action;
	struct seg6local_context seg6local_ctx;

	/* SRv6 Headend-behaviour */
	struct in6_addr seg6_segs;
};

static inline const char *seg6_mode2str(enum seg6_mode_t mode)
{
	switch (mode) {
	case INLINE:
		return "INLINE";
	case ENCAP:
		return "ENCAP";
	case L2ENCAP:
		return "L2ENCAP";
	default:
		return "unknown";
	}
}

static inline bool sid_same(
		const struct in6_addr *a,
		const struct in6_addr *b)
{
	if (!a && !b)
		return true;
	else if (!(a && b))
		return false;
	else
		return memcmp(a, b, sizeof(struct in6_addr)) == 0;
}

static inline bool sid_diff(
		const struct in6_addr *a,
		const struct in6_addr *b)
{
	return !sid_same(a, b);
}

static inline bool sid_zero(
		const struct in6_addr *a)
{
	struct in6_addr zero = {};

	return sid_same(a, &zero);
}

static inline void *sid_copy(struct in6_addr *dst,
		const struct in6_addr *src)
{
	return memcpy(dst, src, sizeof(struct in6_addr));
}

const char *
seg6local_action2str(uint32_t action);

const char *seg6local_context2str(char *str, size_t size,
				  const struct seg6local_context *ctx,
				  uint32_t action);

int snprintf_seg6_segs(char *str,
		size_t size, const struct seg6_segs *segs);

extern struct srv6_locator *srv6_locator_alloc(const char *name);
extern struct srv6_locator_chunk *srv6_locator_chunk_alloc(void);
extern void srv6_locator_free(struct srv6_locator *locator);
extern void srv6_locator_chunk_free(struct srv6_locator_chunk **chunk);
json_object *srv6_locator_chunk_json(const struct srv6_locator_chunk *chunk);
json_object *srv6_locator_json(const struct srv6_locator *loc);
json_object *srv6_locator_detailed_json(const struct srv6_locator *loc);
json_object *
srv6_locator_chunk_detailed_json(const struct srv6_locator_chunk *chunk);

#ifdef __cplusplus
}
#endif

#endif
Commit	Line	Data
e496b420 HS	1	/*
	2	* SRv6 definitions
	3	* Copyright (C) 2020 Hiroki Shirokura, LINE Corporation
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU General Public License as published by the Free
	7	* Software Foundation; either version 2 of the License, or (at your option)
	8	* any later version.
	9	*
	10	* This program is distributed in the hope that it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
	14	*
	15	* You should have received a copy of the GNU General Public License along
	16	* with this program; see the file COPYING; if not, write to the Free Software
	17	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	18	*/
	19
	20	#ifndef _FRR_SRV6_H
	21	#define _FRR_SRV6_H
	22
	23	#include <zebra.h>
f2867068 HS	24	#include "prefix.h"
	25	#include "json.h"
	26
e496b420 HS	27	#include <arpa/inet.h>
	28	#include <netinet/in.h>
	29
	30	#define SRV6_MAX_SIDS 16
f2867068	31	#define SRV6_LOCNAME_SIZE 256
e496b420 HS	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	#define sid2str(sid, str, size) \
	38	inet_ntop(AF_INET6, sid, str, size)
	39
	40	enum seg6_mode_t {
	41	INLINE,
	42	ENCAP,
	43	L2ENCAP,
	44	};
	45
	46	enum seg6local_action_t {
	47	ZEBRA_SEG6_LOCAL_ACTION_UNSPEC = 0,
	48	ZEBRA_SEG6_LOCAL_ACTION_END = 1,
	49	ZEBRA_SEG6_LOCAL_ACTION_END_X = 2,
	50	ZEBRA_SEG6_LOCAL_ACTION_END_T = 3,
	51	ZEBRA_SEG6_LOCAL_ACTION_END_DX2 = 4,
	52	ZEBRA_SEG6_LOCAL_ACTION_END_DX6 = 5,
	53	ZEBRA_SEG6_LOCAL_ACTION_END_DX4 = 6,
	54	ZEBRA_SEG6_LOCAL_ACTION_END_DT6 = 7,
	55	ZEBRA_SEG6_LOCAL_ACTION_END_DT4 = 8,
	56	ZEBRA_SEG6_LOCAL_ACTION_END_B6 = 9,
	57	ZEBRA_SEG6_LOCAL_ACTION_END_B6_ENCAP = 10,
	58	ZEBRA_SEG6_LOCAL_ACTION_END_BM = 11,
	59	ZEBRA_SEG6_LOCAL_ACTION_END_S = 12,
	60	ZEBRA_SEG6_LOCAL_ACTION_END_AS = 13,
	61	ZEBRA_SEG6_LOCAL_ACTION_END_AM = 14,
	62	ZEBRA_SEG6_LOCAL_ACTION_END_BPF = 15,
8bea07e4	63	ZEBRA_SEG6_LOCAL_ACTION_END_DT46 = 16,
e496b420 HS	64	};
	65
	66	struct seg6_segs {
	67	size_t num_segs;
	68	struct in6_addr segs[256];
	69	};
	70
	71	struct seg6local_context {
	72	struct in_addr nh4;
	73	struct in6_addr nh6;
	74	uint32_t table;
	75	};
	76
f2867068 HS	77	struct srv6_locator {
	78	char name[SRV6_LOCNAME_SIZE];
	79	struct prefix_ipv6 prefix;
ac6a9479 HS	80
	81	/*
	82	* Bit length of SRv6 locator described in
	83	* draft-ietf-bess-srv6-services-05#section-3.2.1
	84	*/
	85	uint8_t block_bits_length;
	86	uint8_t node_bits_length;
f2867068	87	uint8_t function_bits_length;
ac6a9479 HS	88	uint8_t argument_bits_length;
ac6a9479 HS	89
f2867068 HS	90	int algonum;
	91	uint64_t current;
	92	bool status_up;
	93	struct list *chunks;
	94
9b7491e1	95	uint8_t flags;
02b1544a	96	#define SRV6_LOCATOR_USID (1 << 0) /* The SRv6 Locator is a uSID Locator */
9b7491e1	97
f2867068 HS	98	QOBJ_FIELDS;
	99	};
	100	DECLARE_QOBJ_TYPE(srv6_locator);
	101
	102	struct srv6_locator_chunk {
ac6a9479 HS	103	char locator_name[SRV6_LOCNAME_SIZE];
	104	struct prefix_ipv6 prefix;
	105
	106	/*
	107	* Bit length of SRv6 locator described in
	108	* draft-ietf-bess-srv6-services-05#section-3.2.1
	109	*/
	110	uint8_t block_bits_length;
	111	uint8_t node_bits_length;
	112	uint8_t function_bits_length;
	113	uint8_t argument_bits_length;
	114
	115	/*
	116	* For Zclient communication values
	117	*/
f2867068 HS	118	uint8_t keep;
	119	uint8_t proto;
	120	uint16_t instance;
	121	uint32_t session_id;
9b7491e1 CS	122
9b7491e1 CS	123	uint8_t flags;
f2867068 HS	124	};
f2867068 HS	125
04947825 CS	126	/*
	127	* SRv6 Endpoint Behavior codepoints, as defined by IANA in
	128	* https://www.iana.org/assignments/segment-routing/segment-routing.xhtml
	129	*/
	130	enum srv6_endpoint_behavior_codepoint {
	131	SRV6_ENDPOINT_BEHAVIOR_RESERVED = 0x0000,
	132	SRV6_ENDPOINT_BEHAVIOR_END_DT6 = 0x0012,
	133	SRV6_ENDPOINT_BEHAVIOR_END_DT4 = 0x0013,
	134	SRV6_ENDPOINT_BEHAVIOR_END_DT46 = 0x0014,
	135	SRV6_ENDPOINT_BEHAVIOR_END_DT6_USID = 0x003E,
	136	SRV6_ENDPOINT_BEHAVIOR_END_DT4_USID = 0x003F,
	137	SRV6_ENDPOINT_BEHAVIOR_END_DT46_USID = 0x0040,
	138	SRV6_ENDPOINT_BEHAVIOR_OPAQUE = 0xFFFF,
f2867068 HS	139	};
f2867068 HS	140
eab0f8f0 HS	141	struct nexthop_srv6 {
	142	/* SRv6 localsid info for Endpoint-behaviour */
	143	enum seg6local_action_t seg6local_action;
	144	struct seg6local_context seg6local_ctx;
	145
	146	/* SRv6 Headend-behaviour */
	147	struct in6_addr seg6_segs;
	148	};
	149
e496b420 HS	150	static inline const char *seg6_mode2str(enum seg6_mode_t mode)
	151	{
	152	switch (mode) {
	153	case INLINE:
	154	return "INLINE";
	155	case ENCAP:
	156	return "ENCAP";
	157	case L2ENCAP:
	158	return "L2ENCAP";
	159	default:
	160	return "unknown";
	161	}
	162	}
	163
	164	static inline bool sid_same(
	165	const struct in6_addr *a,
	166	const struct in6_addr *b)
	167	{
	168	if (!a && !b)
	169	return true;
	170	else if (!(a && b))
	171	return false;
	172	else
	173	return memcmp(a, b, sizeof(struct in6_addr)) == 0;
	174	}
	175
	176	static inline bool sid_diff(
	177	const struct in6_addr *a,
	178	const struct in6_addr *b)
	179	{
	180	return !sid_same(a, b);
	181	}
	182
	183	static inline bool sid_zero(
	184	const struct in6_addr *a)
	185	{
	186	struct in6_addr zero = {};
	187
	188	return sid_same(a, &zero);
	189	}
	190
	191	static inline void sid_copy(struct in6_addr dst,
	192	const struct in6_addr *src)
	193	{
	194	return memcpy(dst, src, sizeof(struct in6_addr));
	195	}
	196
	197	const char *
	198	seg6local_action2str(uint32_t action);
	199
7a4b49bd HS	200	const char seg6local_context2str(char str, size_t size,
	201	const struct seg6local_context *ctx,
	202	uint32_t action);
e496b420 HS	203
	204	int snprintf_seg6_segs(char *str,
	205	size_t size, const struct seg6_segs *segs);
	206
f2867068 HS	207	extern struct srv6_locator srv6_locator_alloc(const char name);
	208	extern struct srv6_locator_chunk *srv6_locator_chunk_alloc(void);
	209	extern void srv6_locator_free(struct srv6_locator *locator);
69467313	210	extern void srv6_locator_chunk_free(struct srv6_locator_chunk **chunk);
f2867068 HS	211	json_object srv6_locator_chunk_json(const struct srv6_locator_chunk chunk);
f2867068 HS	212	json_object srv6_locator_json(const struct srv6_locator loc);
559f4b2f YS	213	json_object srv6_locator_detailed_json(const struct srv6_locator loc);
	214	json_object *
	215	srv6_locator_chunk_detailed_json(const struct srv6_locator_chunk *chunk);
f2867068	216
e496b420 HS	217	#ifdef __cplusplus
	218	}
	219	#endif
	220
	221	#endif