[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 "isis_flags.h"
#include "dict.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
#endif

extern struct zebra_privs_t isisd_privs;

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

struct fabricd;

struct isis {
	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;		  /* IPv4 next hops from this IS */
	struct list *nexthops6;		  /* IPv6 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;
};

struct isis_area {
	struct isis *isis;			       /* back pointer */
	dict_t *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];
	int ip_circuits;
	/* logging adjacency changes? */
	uint8_t log_adj_changes;
	/* multi topology settings */
	struct list *mt_settings;
	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);
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);
void print_debug(struct vty *, int, int);
struct isis_lsp *lsp_for_arg(const char *argv, dict_t *lspdb);

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"
65f9a9a8 DL	32	#include "isis_flags.h"
65f9a9a8 DL	33	#include "dict.h"
4a1ab8e4	34	#include "isis_memory.h"
676a4ea3	35	#include "qobj.h"
f3ccedaa	36
7c0cbd0e CF	37	#ifdef FABRICD
	38	static const bool fabricd = true;
	39	#define PROTO_TYPE ZEBRA_ROUTE_OPENFABRIC
	40	#define PROTO_NAME "openfabric"
	41	#define PROTO_HELP "OpenFabric routing protocol\n"
	42	#define PROTO_REDIST_STR FRR_REDIST_STR_FABRICD
	43	#define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_FABRICD
	44	#define ROUTER_NODE OPENFABRIC_NODE
	45	#else
	46	static const bool fabricd = false;
	47	#define PROTO_TYPE ZEBRA_ROUTE_ISIS
	48	#define PROTO_NAME "isis"
	49	#define PROTO_HELP "IS-IS routing protocol\n"
	50	#define PROTO_REDIST_STR FRR_REDIST_STR_ISISD
	51	#define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_ISISD
	52	#define ROUTER_NODE ISIS_NODE
	53	#endif
	54
76e292f9 DS	55	extern struct zebra_privs_t isisd_privs;
76e292f9 DS	56
eb5d44eb	57	/* uncomment if you are a developer in bug hunt */
eb5d44eb	58	/* #define EXTREME_DEBUG */
8955008f	59	/* #define EXTREME_DICT_DEBUG */
eb5d44eb	60
8e6fb83b CF	61	struct fabricd;
8e6fb83b CF	62
d62a17ae	63	struct isis {
d7c0a89a	64	unsigned long process_id;
d62a17ae	65	int sysid_set;
d7c0a89a QY	66	uint8_t sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
d7c0a89a QY	67	uint32_t router_id; /* Router ID from zebra */
d62a17ae	68	struct list area_list; / list of IS-IS areas */
	69	struct list *init_circ_list;
	70	struct list nexthops; / IPv4 next hops from this IS */
	71	struct list nexthops6; / IPv6 next hops from this IS */
d7c0a89a	72	uint8_t max_area_addrs; /* maximumAreaAdresses */
d62a17ae	73	struct area_addr man_area_addrs; / manualAreaAddresses */
d7c0a89a	74	uint32_t debugs; /* bitmap for debug */
d62a17ae	75	time_t uptime; /* when did we start */
98c5bc15	76	struct thread t_dync_clean; / dynamic hostname cache cleanup thread */
c59f88c8	77	uint32_t circuit_ids_used[8]; /* 256 bits to track circuit ids 1 through 255 */
d62a17ae	78
	79	struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
	80
	81	QOBJ_FIELDS
eb5d44eb	82	};
eb5d44eb	83
3f045a08	84	extern struct isis *isis;
676a4ea3	85	DECLARE_QOBJ_TYPE(isis_area)
3f045a08	86
be985ba0 CF	87	enum spf_tree_id {
	88	SPFTREE_IPV4 = 0,
	89	SPFTREE_IPV6,
321c1bbb	90	SPFTREE_DSTSRC,
be985ba0 CF	91	SPFTREE_COUNT
	92	};
	93
9196731f CF	94	struct lsp_refresh_arg {
	95	struct isis_area *area;
	96	int level;
	97	};
	98
d62a17ae	99	struct isis_area {
	100	struct isis isis; / back pointer */
	101	dict_t lspdb[ISIS_LEVELS]; / link-state dbs */
be985ba0	102	struct isis_spftree *spftree[SPFTREE_COUNT][ISIS_LEVELS];
b20ccb3a	103	#define DEFAULT_LSP_MTU 1497
d62a17ae	104	unsigned int lsp_mtu; /* Size of LSPs to generate */
	105	struct list circuit_list; / IS-IS circuits */
	106	struct flags flags;
	107	struct thread t_tick; / LSP walker */
	108	struct thread *t_lsp_refresh[ISIS_LEVELS];
f93025e1	109	struct timeval last_lsp_refresh_event[ISIS_LEVELS];
d62a17ae	110	/* t_lsp_refresh is used in two ways:
	111	* a) regular refresh of LSPs
	112	* b) (possibly throttled) updates to LSPs
	113	*
	114	* The lsp_regenerate_pending flag tracks whether the timer is active
	115	* for the a) or the b) case.
	116	*
	117	* It is of utmost importance to clear this flag when the timer is
	118	* rescheduled for normal refresh, because otherwise, updates will
	119	* be delayed until the next regular refresh.
	120	*/
	121	int lsp_regenerate_pending[ISIS_LEVELS];
	122
8e6fb83b CF	123	struct fabricd *fabricd;
8e6fb83b CF	124
d62a17ae	125	/*
	126	* Configurables
	127	*/
	128	struct isis_passwd area_passwd;
	129	struct isis_passwd domain_passwd;
	130	/* do we support dynamic hostnames? */
	131	char dynhostname;
	132	/* do we support new style metrics? */
	133	char newmetric;
	134	char oldmetric;
	135	/* identifies the routing instance */
	136	char *area_tag;
	137	/* area addresses for this area */
	138	struct list *area_addrs;
d7c0a89a	139	uint16_t max_lsp_lifetime[ISIS_LEVELS];
d62a17ae	140	char is_type; /* level-1 level-1-2 or level-2-only */
	141	/* are we overloaded? */
	142	char overload_bit;
	143	/* L1/L2 router identifier for inter-area traffic */
	144	char attached_bit;
d7c0a89a	145	uint16_t lsp_refresh[ISIS_LEVELS];
d62a17ae	146	/* minimum time allowed before lsp retransmission */
d7c0a89a	147	uint16_t lsp_gen_interval[ISIS_LEVELS];
d62a17ae	148	/* min interval between between consequtive SPFs */
d7c0a89a	149	uint16_t min_spf_interval[ISIS_LEVELS];
d62a17ae	150	/* the percentage of LSP mtu size used, before generating a new frag */
d62a17ae	151	int lsp_frag_threshold;
062f4d36	152	uint64_t lsp_gen_count[ISIS_LEVELS];
d62a17ae	153	int ip_circuits;
d62a17ae	154	/* logging adjacency changes? */
d7c0a89a	155	uint8_t log_adj_changes;
d62a17ae	156	/* multi topology settings */
	157	struct list *mt_settings;
	158	int ipv6_circuits;
2c92bee4	159	bool purge_originator;
d62a17ae	160	/* Counters */
d7c0a89a	161	uint32_t circuit_state_changes;
d62a17ae	162	struct isis_redist redist_settings[REDIST_PROTOCOL_COUNT]
	163	[ZEBRA_ROUTE_MAX + 1][ISIS_LEVELS];
	164	struct route_table *ext_reach[REDIST_PROTOCOL_COUNT][ISIS_LEVELS];
	165
	166	struct spf_backoff spf_delay_ietf[ISIS_LEVELS]; /Structure with IETF
	167	SPF algo
	168	parameters*/
	169	struct thread *spf_timer[ISIS_LEVELS];
9196731f CF	170
9196731f CF	171	struct lsp_refresh_arg lsp_refresh_arg[ISIS_LEVELS];
d62a17ae	172
39bb53d6 CF	173	pdu_counter_t pdu_tx_counters;
39bb53d6 CF	174	pdu_counter_t pdu_rx_counters;
86d6f80d	175	uint64_t lsp_rxmt_count;
39bb53d6	176
d62a17ae	177	QOBJ_FIELDS
eb5d44eb	178	};
676a4ea3	179	DECLARE_QOBJ_TYPE(isis_area)
eb5d44eb	180
d62a17ae	181	void isis_init(void);
3f045a08 JB	182	void isis_new(unsigned long);
3f045a08 JB	183	struct isis_area isis_area_create(const char );
d62a17ae	184	struct isis_area isis_area_lookup(const char );
d62a17ae	185	int isis_area_get(struct vty vty, const char area_tag);
3f045a08	186	void print_debug(struct vty *, int, int);
eb2bcb28	187	struct isis_lsp lsp_for_arg(const char argv, dict_t *lspdb);
3f045a08	188
3dace42d CF	189	void isis_area_invalidate_routes(struct isis_area *area, int levels);
	190	void isis_area_verify_routes(struct isis_area *area);
	191
a38a72db CF	192	void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
	193	void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
	194	void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
	195	void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
	196	bool new_metric);
6754fc66 CF	197	void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
6754fc66 CF	198	void isis_area_is_type_set(struct isis_area *area, int is_type);
466ed406	199	void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
d62a17ae	200	uint16_t max_lsp_lifetime);
466ed406 CF	201	void isis_area_lsp_refresh_set(struct isis_area *area, int level,
466ed406 CF	202	uint16_t lsp_refresh);
9093b230	203	/* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
d62a17ae	204	int isis_area_passwd_unset(struct isis_area *area, int level);
d62a17ae	205	int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
d7c0a89a	206	const char *passwd, uint8_t snp_auth);
d62a17ae	207	int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
d7c0a89a	208	const char *passwd, uint8_t snp_auth);
65f9a9a8	209
3f045a08 JB	210	/* Master of threads. */
3f045a08 JB	211	extern struct thread_master *master;
eb5d44eb	212
eb5d44eb	213	#define DEBUG_ADJ_PACKETS (1<<0)
26687d25 CF	214	#define DEBUG_SNP_PACKETS (1<<1)
	215	#define DEBUG_UPDATE_PACKETS (1<<2)
	216	#define DEBUG_SPF_EVENTS (1<<3)
	217	#define DEBUG_RTE_EVENTS (1<<4)
	218	#define DEBUG_EVENTS (1<<5)
	219	#define DEBUG_PACKET_DUMP (1<<6)
	220	#define DEBUG_LSP_GEN (1<<7)
	221	#define DEBUG_LSP_SCHED (1<<8)
ddb33326	222	#define DEBUG_FLOODING (1<<9)
26687d25	223	#define DEBUG_BFD (1<<10)
161fa356	224	#define DEBUG_TX_QUEUE (1<<11)
14872644	225
d62a17ae	226	#define lsp_debug(...) \
	227	do { \
	228	if (isis->debugs & DEBUG_LSP_GEN) \
	229	zlog_debug(__VA_ARGS__); \
	230	} while (0)
	231
	232	#define sched_debug(...) \
	233	do { \
	234	if (isis->debugs & DEBUG_LSP_SCHED) \
	235	zlog_debug(__VA_ARGS__); \
	236	} while (0)
414766a1	237
26687d25	238	#define DEBUG_TE DEBUG_LSP_GEN
f8c06e2c OD	239
	240	#define IS_DEBUG_ISIS(x) (isis->debugs & x)
	241
eb5d44eb	242	#endif /* ISISD_H */