[mirror_frr.git] / isisd / isisd.h

/*
 * IS-IS Rout(e)ing protocol - isisd.h
 *
 * Copyright (C) 2001,2002   Sampo Saaristo
 *                           Tampere University of Technology
 *                           Institute of Communications Engineering
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public Licenseas 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 ISISD_H
#define ISISD_H

#include "vty.h"

#include "isisd/isis_constants.h"
#include "isisd/isis_common.h"
#include "isisd/isis_redist.h"
#include "isisd/isis_pdu_counter.h"
#include "isisd/isis_circuit.h"
#include "isis_flags.h"
#include "isis_lsp.h"
#include "isis_memory.h"
#include "qobj.h"

#ifdef FABRICD
static const bool fabricd = true;
#define PROTO_TYPE ZEBRA_ROUTE_OPENFABRIC
#define PROTO_NAME "openfabric"
#define PROTO_HELP "OpenFabric routing protocol\n"
#define PROTO_REDIST_STR FRR_REDIST_STR_FABRICD
#define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_FABRICD
#define ROUTER_NODE OPENFABRIC_NODE
#else
static const bool fabricd = false;
#define PROTO_TYPE ZEBRA_ROUTE_ISIS
#define PROTO_NAME "isis"
#define PROTO_HELP "IS-IS routing protocol\n"
#define PROTO_REDIST_STR FRR_REDIST_STR_ISISD
#define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_ISISD
#define ROUTER_NODE ISIS_NODE
extern void isis_cli_init(void);
#endif

extern struct zebra_privs_t isisd_privs;

/* uncomment if you are a developer in bug hunt */
/* #define EXTREME_DEBUG  */

struct fabricd;

struct isis {
	vrf_id_t vrf_id;
	unsigned long process_id;
	int sysid_set;
	uint8_t sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
	uint32_t router_id;		/* Router ID from zebra */
	struct list *area_list;	/* list of IS-IS areas */
	struct list *init_circ_list;
	struct list *nexthops;		  /* IP next hops from this IS */
	uint8_t max_area_addrs;		  /* maximumAreaAdresses */
	struct area_addr *man_area_addrs; /* manualAreaAddresses */
	uint32_t debugs;		  /* bitmap for debug */
	time_t uptime;			  /* when did we start */
	struct thread *t_dync_clean;      /* dynamic hostname cache cleanup thread */
	uint32_t circuit_ids_used[8];     /* 256 bits to track circuit ids 1 through 255 */

	struct route_table *ext_info[REDIST_PROTOCOL_COUNT];

	QOBJ_FIELDS
};

extern struct isis *isis;
DECLARE_QOBJ_TYPE(isis_area)

enum spf_tree_id {
	SPFTREE_IPV4 = 0,
	SPFTREE_IPV6,
	SPFTREE_DSTSRC,
	SPFTREE_COUNT
};

struct lsp_refresh_arg {
	struct isis_area *area;
	int level;
};

/* for yang configuration */
enum isis_metric_style {
	ISIS_NARROW_METRIC = 0,
	ISIS_WIDE_METRIC,
	ISIS_TRANSITION_METRIC,
};

struct isis_area {
	struct isis *isis;			       /* back pointer */
	struct lspdb_head lspdb[ISIS_LEVELS];	       /* link-state dbs */
	struct isis_spftree *spftree[SPFTREE_COUNT][ISIS_LEVELS];
#define DEFAULT_LSP_MTU 1497
	unsigned int lsp_mtu;      /* Size of LSPs to generate */
	struct list *circuit_list; /* IS-IS circuits */
	struct flags flags;
	struct thread *t_tick; /* LSP walker */
	struct thread *t_lsp_refresh[ISIS_LEVELS];
	struct timeval last_lsp_refresh_event[ISIS_LEVELS];
	/* t_lsp_refresh is used in two ways:
	 * a) regular refresh of LSPs
	 * b) (possibly throttled) updates to LSPs
	 *
	 * The lsp_regenerate_pending flag tracks whether the timer is active
	 * for the a) or the b) case.
	 *
	 * It is of utmost importance to clear this flag when the timer is
	 * rescheduled for normal refresh, because otherwise, updates will
	 * be delayed until the next regular refresh.
	 */
	int lsp_regenerate_pending[ISIS_LEVELS];

	struct fabricd *fabricd;

	/*
	 * Configurables
	 */
	struct isis_passwd area_passwd;
	struct isis_passwd domain_passwd;
	/* do we support dynamic hostnames?  */
	char dynhostname;
	/* do we support new style metrics?  */
	char newmetric;
	char oldmetric;
	/* identifies the routing instance   */
	char *area_tag;
	/* area addresses for this area      */
	struct list *area_addrs;
	uint16_t max_lsp_lifetime[ISIS_LEVELS];
	char is_type; /* level-1 level-1-2 or level-2-only */
	/* are we overloaded? */
	char overload_bit;
	/* L1/L2 router identifier for inter-area traffic */
	char attached_bit;
	uint16_t lsp_refresh[ISIS_LEVELS];
	/* minimum time allowed before lsp retransmission */
	uint16_t lsp_gen_interval[ISIS_LEVELS];
	/* min interval between between consequtive SPFs */
	uint16_t min_spf_interval[ISIS_LEVELS];
	/* the percentage of LSP mtu size used, before generating a new frag */
	int lsp_frag_threshold;
	uint64_t lsp_gen_count[ISIS_LEVELS];
	uint64_t lsp_purge_count[ISIS_LEVELS];
	int ip_circuits;
	/* logging adjacency changes? */
	uint8_t log_adj_changes;
	/* multi topology settings */
	struct list *mt_settings;
	/* MPLS-TE settings */
	struct mpls_te_area *mta;
	int ipv6_circuits;
	bool purge_originator;
	/* Counters */
	uint32_t circuit_state_changes;
	struct isis_redist redist_settings[REDIST_PROTOCOL_COUNT]
					  [ZEBRA_ROUTE_MAX + 1][ISIS_LEVELS];
	struct route_table *ext_reach[REDIST_PROTOCOL_COUNT][ISIS_LEVELS];

	struct spf_backoff *spf_delay_ietf[ISIS_LEVELS]; /*Structure with IETF
							    SPF algo
							    parameters*/
	struct thread *spf_timer[ISIS_LEVELS];

	struct lsp_refresh_arg lsp_refresh_arg[ISIS_LEVELS];

	pdu_counter_t pdu_tx_counters;
	pdu_counter_t pdu_rx_counters;
	uint64_t lsp_rxmt_count;

	QOBJ_FIELDS
};
DECLARE_QOBJ_TYPE(isis_area)

void isis_init(void);
void isis_new(unsigned long process_id, vrf_id_t vrf_id);
struct isis_area *isis_area_create(const char *);
struct isis_area *isis_area_lookup(const char *);
int isis_area_get(struct vty *vty, const char *area_tag);
int isis_area_destroy(const char *area_tag);
void print_debug(struct vty *, int, int);
struct isis_lsp *lsp_for_arg(struct lspdb_head *head, const char *argv);

void isis_area_invalidate_routes(struct isis_area *area, int levels);
void isis_area_verify_routes(struct isis_area *area);

void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
			       bool new_metric);
void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
void isis_area_is_type_set(struct isis_area *area, int is_type);
void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
				    uint16_t max_lsp_lifetime);
void isis_area_lsp_refresh_set(struct isis_area *area, int level,
			       uint16_t lsp_refresh);
/* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
int isis_area_passwd_unset(struct isis_area *area, int level);
int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
				   const char *passwd, uint8_t snp_auth);
int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
				  const char *passwd, uint8_t snp_auth);

/* Master of threads. */
extern struct thread_master *master;

#define DEBUG_ADJ_PACKETS                (1<<0)
#define DEBUG_SNP_PACKETS                (1<<1)
#define DEBUG_UPDATE_PACKETS             (1<<2)
#define DEBUG_SPF_EVENTS                 (1<<3)
#define DEBUG_RTE_EVENTS                 (1<<4)
#define DEBUG_EVENTS                     (1<<5)
#define DEBUG_PACKET_DUMP                (1<<6)
#define DEBUG_LSP_GEN                    (1<<7)
#define DEBUG_LSP_SCHED                  (1<<8)
#define DEBUG_FLOODING                   (1<<9)
#define DEBUG_BFD                        (1<<10)
#define DEBUG_TX_QUEUE                   (1<<11)

#define lsp_debug(...)                                                         \
	do {                                                                   \
		if (isis->debugs & DEBUG_LSP_GEN)                              \
			zlog_debug(__VA_ARGS__);                               \
	} while (0)

#define sched_debug(...)                                                       \
	do {                                                                   \
		if (isis->debugs & DEBUG_LSP_SCHED)                            \
			zlog_debug(__VA_ARGS__);                               \
	} while (0)

#define DEBUG_TE                         DEBUG_LSP_GEN

#define IS_DEBUG_ISIS(x)                 (isis->debugs & x)

#endif /* ISISD_H */
Commit	Line	Data
eb5d44eb	1	/*
d62a17ae	2	* IS-IS Rout(e)ing protocol - isisd.h
eb5d44eb	3	*
eb5d44eb	4	* Copyright (C) 2001,2002 Sampo Saaristo
d62a17ae	5	* Tampere University of Technology
eb5d44eb	6	* Institute of Communications Engineering
eb5d44eb	7	*
d62a17ae	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public Licenseas published by the Free
	10	* Software Foundation; either version 2 of the License, or (at your option)
eb5d44eb	11	* any later version.
eb5d44eb	12	*
d62a17ae	13	* This program is distributed in the hope that it will be useful,but WITHOUT
	14	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	15	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
eb5d44eb	16	* more details.
896014f4 DL	17	*
	18	* You should have received a copy of the GNU General Public License along
	19	* with this program; see the file COPYING; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
eb5d44eb	21	*/
	22
	23	#ifndef ISISD_H
	24	#define ISISD_H
	25
91283e76 DS	26	#include "vty.h"
91283e76 DS	27
65f9a9a8 DL	28	#include "isisd/isis_constants.h"
65f9a9a8 DL	29	#include "isisd/isis_common.h"
f3ccedaa	30	#include "isisd/isis_redist.h"
39bb53d6	31	#include "isisd/isis_pdu_counter.h"
aaf2fd21	32	#include "isisd/isis_circuit.h"
65f9a9a8	33	#include "isis_flags.h"
4bef0ec4	34	#include "isis_lsp.h"
4a1ab8e4	35	#include "isis_memory.h"
676a4ea3	36	#include "qobj.h"
f3ccedaa	37
7c0cbd0e CF	38	#ifdef FABRICD
	39	static const bool fabricd = true;
	40	#define PROTO_TYPE ZEBRA_ROUTE_OPENFABRIC
	41	#define PROTO_NAME "openfabric"
	42	#define PROTO_HELP "OpenFabric routing protocol\n"
	43	#define PROTO_REDIST_STR FRR_REDIST_STR_FABRICD
	44	#define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_FABRICD
	45	#define ROUTER_NODE OPENFABRIC_NODE
	46	#else
	47	static const bool fabricd = false;
	48	#define PROTO_TYPE ZEBRA_ROUTE_ISIS
	49	#define PROTO_NAME "isis"
	50	#define PROTO_HELP "IS-IS routing protocol\n"
	51	#define PROTO_REDIST_STR FRR_REDIST_STR_ISISD
	52	#define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_ISISD
	53	#define ROUTER_NODE ISIS_NODE
20bd27e2	54	extern void isis_cli_init(void);
7c0cbd0e CF	55	#endif
7c0cbd0e CF	56
76e292f9 DS	57	extern struct zebra_privs_t isisd_privs;
76e292f9 DS	58
eb5d44eb	59	/* uncomment if you are a developer in bug hunt */
eb5d44eb	60	/* #define EXTREME_DEBUG */
eb5d44eb	61
8e6fb83b CF	62	struct fabricd;
8e6fb83b CF	63
d62a17ae	64	struct isis {
260fcb95	65	vrf_id_t vrf_id;
d7c0a89a	66	unsigned long process_id;
d62a17ae	67	int sysid_set;
d7c0a89a QY	68	uint8_t sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
d7c0a89a QY	69	uint32_t router_id; /* Router ID from zebra */
d62a17ae	70	struct list area_list; / list of IS-IS areas */
d62a17ae	71	struct list *init_circ_list;
363be4dd	72	struct list nexthops; / IP next hops from this IS */
d7c0a89a	73	uint8_t max_area_addrs; /* maximumAreaAdresses */
d62a17ae	74	struct area_addr man_area_addrs; / manualAreaAddresses */
d7c0a89a	75	uint32_t debugs; /* bitmap for debug */
d62a17ae	76	time_t uptime; /* when did we start */
98c5bc15	77	struct thread t_dync_clean; / dynamic hostname cache cleanup thread */
c59f88c8	78	uint32_t circuit_ids_used[8]; /* 256 bits to track circuit ids 1 through 255 */
d62a17ae	79
	80	struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
	81
	82	QOBJ_FIELDS
eb5d44eb	83	};
eb5d44eb	84
3f045a08	85	extern struct isis *isis;
676a4ea3	86	DECLARE_QOBJ_TYPE(isis_area)
3f045a08	87
be985ba0 CF	88	enum spf_tree_id {
	89	SPFTREE_IPV4 = 0,
	90	SPFTREE_IPV6,
321c1bbb	91	SPFTREE_DSTSRC,
be985ba0 CF	92	SPFTREE_COUNT
	93	};
	94
9196731f CF	95	struct lsp_refresh_arg {
	96	struct isis_area *area;
	97	int level;
	98	};
	99
e0df3206 EDP	100	/* for yang configuration */
	101	enum isis_metric_style {
	102	ISIS_NARROW_METRIC = 0,
	103	ISIS_WIDE_METRIC,
	104	ISIS_TRANSITION_METRIC,
	105	};
	106
d62a17ae	107	struct isis_area {
d62a17ae	108	struct isis isis; / back pointer */
4bef0ec4	109	struct lspdb_head lspdb[ISIS_LEVELS]; /* link-state dbs */
be985ba0	110	struct isis_spftree *spftree[SPFTREE_COUNT][ISIS_LEVELS];
b20ccb3a	111	#define DEFAULT_LSP_MTU 1497
d62a17ae	112	unsigned int lsp_mtu; /* Size of LSPs to generate */
	113	struct list circuit_list; / IS-IS circuits */
	114	struct flags flags;
	115	struct thread t_tick; / LSP walker */
	116	struct thread *t_lsp_refresh[ISIS_LEVELS];
f93025e1	117	struct timeval last_lsp_refresh_event[ISIS_LEVELS];
d62a17ae	118	/* t_lsp_refresh is used in two ways:
	119	* a) regular refresh of LSPs
	120	* b) (possibly throttled) updates to LSPs
	121	*
	122	* The lsp_regenerate_pending flag tracks whether the timer is active
	123	* for the a) or the b) case.
	124	*
	125	* It is of utmost importance to clear this flag when the timer is
	126	* rescheduled for normal refresh, because otherwise, updates will
	127	* be delayed until the next regular refresh.
	128	*/
	129	int lsp_regenerate_pending[ISIS_LEVELS];
	130
8e6fb83b CF	131	struct fabricd *fabricd;
8e6fb83b CF	132
d62a17ae	133	/*
	134	* Configurables
	135	*/
	136	struct isis_passwd area_passwd;
	137	struct isis_passwd domain_passwd;
	138	/* do we support dynamic hostnames? */
	139	char dynhostname;
	140	/* do we support new style metrics? */
	141	char newmetric;
	142	char oldmetric;
	143	/* identifies the routing instance */
	144	char *area_tag;
	145	/* area addresses for this area */
	146	struct list *area_addrs;
d7c0a89a	147	uint16_t max_lsp_lifetime[ISIS_LEVELS];
d62a17ae	148	char is_type; /* level-1 level-1-2 or level-2-only */
	149	/* are we overloaded? */
	150	char overload_bit;
	151	/* L1/L2 router identifier for inter-area traffic */
	152	char attached_bit;
d7c0a89a	153	uint16_t lsp_refresh[ISIS_LEVELS];
d62a17ae	154	/* minimum time allowed before lsp retransmission */
d7c0a89a	155	uint16_t lsp_gen_interval[ISIS_LEVELS];
d62a17ae	156	/* min interval between between consequtive SPFs */
d7c0a89a	157	uint16_t min_spf_interval[ISIS_LEVELS];
d62a17ae	158	/* the percentage of LSP mtu size used, before generating a new frag */
d62a17ae	159	int lsp_frag_threshold;
062f4d36	160	uint64_t lsp_gen_count[ISIS_LEVELS];
6f004b60	161	uint64_t lsp_purge_count[ISIS_LEVELS];
d62a17ae	162	int ip_circuits;
d62a17ae	163	/* logging adjacency changes? */
d7c0a89a	164	uint8_t log_adj_changes;
d62a17ae	165	/* multi topology settings */
d62a17ae	166	struct list *mt_settings;
2e2a8b91 OD	167	/* MPLS-TE settings */
2e2a8b91 OD	168	struct mpls_te_area *mta;
d62a17ae	169	int ipv6_circuits;
2c92bee4	170	bool purge_originator;
d62a17ae	171	/* Counters */
d7c0a89a	172	uint32_t circuit_state_changes;
d62a17ae	173	struct isis_redist redist_settings[REDIST_PROTOCOL_COUNT]
	174	[ZEBRA_ROUTE_MAX + 1][ISIS_LEVELS];
	175	struct route_table *ext_reach[REDIST_PROTOCOL_COUNT][ISIS_LEVELS];
	176
	177	struct spf_backoff spf_delay_ietf[ISIS_LEVELS]; /Structure with IETF
	178	SPF algo
	179	parameters*/
	180	struct thread *spf_timer[ISIS_LEVELS];
9196731f CF	181
9196731f CF	182	struct lsp_refresh_arg lsp_refresh_arg[ISIS_LEVELS];
d62a17ae	183
39bb53d6 CF	184	pdu_counter_t pdu_tx_counters;
39bb53d6 CF	185	pdu_counter_t pdu_rx_counters;
86d6f80d	186	uint64_t lsp_rxmt_count;
39bb53d6	187
d62a17ae	188	QOBJ_FIELDS
eb5d44eb	189	};
676a4ea3	190	DECLARE_QOBJ_TYPE(isis_area)
eb5d44eb	191
d62a17ae	192	void isis_init(void);
260fcb95	193	void isis_new(unsigned long process_id, vrf_id_t vrf_id);
3f045a08	194	struct isis_area isis_area_create(const char );
d62a17ae	195	struct isis_area isis_area_lookup(const char );
d62a17ae	196	int isis_area_get(struct vty vty, const char area_tag);
aaf2fd21	197	int isis_area_destroy(const char *area_tag);
3f045a08	198	void print_debug(struct vty *, int, int);
4bef0ec4	199	struct isis_lsp lsp_for_arg(struct lspdb_head head, const char *argv);
3f045a08	200
3dace42d CF	201	void isis_area_invalidate_routes(struct isis_area *area, int levels);
	202	void isis_area_verify_routes(struct isis_area *area);
	203
a38a72db CF	204	void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
	205	void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
	206	void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
	207	void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
	208	bool new_metric);
6754fc66 CF	209	void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
6754fc66 CF	210	void isis_area_is_type_set(struct isis_area *area, int is_type);
466ed406	211	void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
d62a17ae	212	uint16_t max_lsp_lifetime);
466ed406 CF	213	void isis_area_lsp_refresh_set(struct isis_area *area, int level,
466ed406 CF	214	uint16_t lsp_refresh);
9093b230	215	/* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
d62a17ae	216	int isis_area_passwd_unset(struct isis_area *area, int level);
d62a17ae	217	int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
d7c0a89a	218	const char *passwd, uint8_t snp_auth);
d62a17ae	219	int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
d7c0a89a	220	const char *passwd, uint8_t snp_auth);
65f9a9a8	221
3f045a08 JB	222	/* Master of threads. */
3f045a08 JB	223	extern struct thread_master *master;
eb5d44eb	224
eb5d44eb	225	#define DEBUG_ADJ_PACKETS (1<<0)
26687d25 CF	226	#define DEBUG_SNP_PACKETS (1<<1)
	227	#define DEBUG_UPDATE_PACKETS (1<<2)
	228	#define DEBUG_SPF_EVENTS (1<<3)
	229	#define DEBUG_RTE_EVENTS (1<<4)
	230	#define DEBUG_EVENTS (1<<5)
	231	#define DEBUG_PACKET_DUMP (1<<6)
	232	#define DEBUG_LSP_GEN (1<<7)
	233	#define DEBUG_LSP_SCHED (1<<8)
ddb33326	234	#define DEBUG_FLOODING (1<<9)
26687d25	235	#define DEBUG_BFD (1<<10)
161fa356	236	#define DEBUG_TX_QUEUE (1<<11)
14872644	237
d62a17ae	238	#define lsp_debug(...) \
	239	do { \
	240	if (isis->debugs & DEBUG_LSP_GEN) \
	241	zlog_debug(__VA_ARGS__); \
	242	} while (0)
	243
	244	#define sched_debug(...) \
	245	do { \
	246	if (isis->debugs & DEBUG_LSP_SCHED) \
	247	zlog_debug(__VA_ARGS__); \
	248	} while (0)
414766a1	249
26687d25	250	#define DEBUG_TE DEBUG_LSP_GEN
f8c06e2c OD	251
	252	#define IS_DEBUG_ISIS(x) (isis->debugs & x)
	253
eb5d44eb	254	#endif /* ISISD_H */