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

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

struct isis {
	u_long process_id;
	int sysid_set;
	u_char sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
	u_int32_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 */
	u_char max_area_addrs;		  /* maximumAreaAdresses */
	struct area_addr *man_area_addrs; /* manualAreaAddresses */
	u_int32_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 0 through 255 */

	struct route_table *ext_info[REDIST_PROTOCOL_COUNT];

	QOBJ_FIELDS
};

extern struct isis *isis;
DECLARE_QOBJ_TYPE(isis_area)

struct isis_area {
	struct isis *isis;			       /* back pointer */
	dict_t *lspdb[ISIS_LEVELS];		       /* link-state dbs */
	struct isis_spftree *spftree[ISIS_LEVELS];     /* The v4 SPTs */
	struct route_table *route_table[ISIS_LEVELS];  /* IPv4 routes */
	struct isis_spftree *spftree6[ISIS_LEVELS];    /* The v6 SPTs */
	struct route_table *route_table6[ISIS_LEVELS]; /* IPv6 routes */
						       /* $FRR indent$ */
/* clang-format off */
#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];
	/* 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];

	/*
	 * 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;
	u_int16_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;
	u_int16_t lsp_refresh[ISIS_LEVELS];
	/* minimum time allowed before lsp retransmission */
	u_int16_t lsp_gen_interval[ISIS_LEVELS];
	/* min interval between between consequtive SPFs */
	u_int16_t min_spf_interval[ISIS_LEVELS];
	/* the percentage of LSP mtu size used, before generating a new frag */
	int lsp_frag_threshold;
	int ip_circuits;
	/* logging adjacency changes? */
	u_char log_adj_changes;
	/* multi topology settings */
	struct list *mt_settings;
	int ipv6_circuits;
	/* Counters */
	u_int32_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];

	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);

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, u_char snp_auth);
int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
				  const char *passwd, u_char snp_auth);
void isis_vty_init(void);

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

#define DEBUG_ADJ_PACKETS                (1<<0)
#define DEBUG_CHECKSUM_ERRORS            (1<<1)
#define DEBUG_LOCAL_UPDATES              (1<<2)
#define DEBUG_PROTOCOL_ERRORS            (1<<3)
#define DEBUG_SNP_PACKETS                (1<<4)
#define DEBUG_UPDATE_PACKETS             (1<<5)
#define DEBUG_SPF_EVENTS                 (1<<6)
#define DEBUG_SPF_STATS                  (1<<7)
#define DEBUG_SPF_TRIGGERS               (1<<8)
#define DEBUG_RTE_EVENTS                 (1<<9)
#define DEBUG_EVENTS                     (1<<10)
#define DEBUG_ZEBRA                      (1<<11)
#define DEBUG_PACKET_DUMP                (1<<12)
#define DEBUG_LSP_GEN                    (1<<13)
#define DEBUG_LSP_SCHED                  (1<<14)

#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                         (1<<13)

#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"
65f9a9a8 DL	31	#include "isis_flags.h"
65f9a9a8 DL	32	#include "dict.h"
4a1ab8e4	33	#include "isis_memory.h"
676a4ea3	34	#include "qobj.h"
f3ccedaa	35
eb5d44eb	36	/* uncomment if you are a developer in bug hunt */
eb5d44eb	37	/* #define EXTREME_DEBUG */
8955008f	38	/* #define EXTREME_DICT_DEBUG */
eb5d44eb	39
d62a17ae	40	struct isis {
	41	u_long process_id;
	42	int sysid_set;
	43	u_char sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
	44	u_int32_t router_id; /* Router ID from zebra */
	45	struct list area_list; / list of IS-IS areas */
	46	struct list *init_circ_list;
	47	struct list nexthops; / IPv4 next hops from this IS */
	48	struct list nexthops6; / IPv6 next hops from this IS */
	49	u_char max_area_addrs; /* maximumAreaAdresses */
	50	struct area_addr man_area_addrs; / manualAreaAddresses */
	51	u_int32_t debugs; /* bitmap for debug */
	52	time_t uptime; /* when did we start */
068c8222 CF	53	struct thread t_dync_clean; / dynamic hostname cache cleanup thread */
068c8222 CF	54	uint32_t circuit_ids_used[8]; /* 256 bits to track circuit ids 0 through 255 */
d62a17ae	55
	56	struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
	57
	58	QOBJ_FIELDS
eb5d44eb	59	};
eb5d44eb	60
3f045a08	61	extern struct isis *isis;
676a4ea3	62	DECLARE_QOBJ_TYPE(isis_area)
3f045a08	63
d62a17ae	64	struct isis_area {
	65	struct isis isis; / back pointer */
	66	dict_t lspdb[ISIS_LEVELS]; / link-state dbs */
	67	struct isis_spftree spftree[ISIS_LEVELS]; / The v4 SPTs */
	68	struct route_table route_table[ISIS_LEVELS]; / IPv4 routes */
	69	struct isis_spftree spftree6[ISIS_LEVELS]; / The v6 SPTs */
	70	struct route_table route_table6[ISIS_LEVELS]; / IPv6 routes */
	71	/* $FRR indent$ */
9d303b37	72	/* clang-format off */
b20ccb3a	73	#define DEFAULT_LSP_MTU 1497
d62a17ae	74	unsigned int lsp_mtu; /* Size of LSPs to generate */
	75	struct list circuit_list; / IS-IS circuits */
	76	struct flags flags;
	77	struct thread t_tick; / LSP walker */
	78	struct thread *t_lsp_refresh[ISIS_LEVELS];
	79	/* t_lsp_refresh is used in two ways:
	80	* a) regular refresh of LSPs
	81	* b) (possibly throttled) updates to LSPs
	82	*
	83	* The lsp_regenerate_pending flag tracks whether the timer is active
	84	* for the a) or the b) case.
	85	*
	86	* It is of utmost importance to clear this flag when the timer is
	87	* rescheduled for normal refresh, because otherwise, updates will
	88	* be delayed until the next regular refresh.
	89	*/
	90	int lsp_regenerate_pending[ISIS_LEVELS];
	91
	92	/*
	93	* Configurables
	94	*/
	95	struct isis_passwd area_passwd;
	96	struct isis_passwd domain_passwd;
	97	/* do we support dynamic hostnames? */
	98	char dynhostname;
	99	/* do we support new style metrics? */
	100	char newmetric;
	101	char oldmetric;
	102	/* identifies the routing instance */
	103	char *area_tag;
	104	/* area addresses for this area */
	105	struct list *area_addrs;
	106	u_int16_t max_lsp_lifetime[ISIS_LEVELS];
	107	char is_type; /* level-1 level-1-2 or level-2-only */
	108	/* are we overloaded? */
	109	char overload_bit;
	110	/* L1/L2 router identifier for inter-area traffic */
	111	char attached_bit;
	112	u_int16_t lsp_refresh[ISIS_LEVELS];
	113	/* minimum time allowed before lsp retransmission */
	114	u_int16_t lsp_gen_interval[ISIS_LEVELS];
	115	/* min interval between between consequtive SPFs */
	116	u_int16_t min_spf_interval[ISIS_LEVELS];
	117	/* the percentage of LSP mtu size used, before generating a new frag */
	118	int lsp_frag_threshold;
	119	int ip_circuits;
	120	/* logging adjacency changes? */
	121	u_char log_adj_changes;
	122	/* multi topology settings */
	123	struct list *mt_settings;
	124	int ipv6_circuits;
	125	/* Counters */
	126	u_int32_t circuit_state_changes;
	127	struct isis_redist redist_settings[REDIST_PROTOCOL_COUNT]
	128	[ZEBRA_ROUTE_MAX + 1][ISIS_LEVELS];
	129	struct route_table *ext_reach[REDIST_PROTOCOL_COUNT][ISIS_LEVELS];
	130
	131	struct spf_backoff spf_delay_ietf[ISIS_LEVELS]; /Structure with IETF
	132	SPF algo
	133	parameters*/
	134	struct thread *spf_timer[ISIS_LEVELS];
	135
	136	QOBJ_FIELDS
eb5d44eb	137	};
676a4ea3	138	DECLARE_QOBJ_TYPE(isis_area)
eb5d44eb	139
d62a17ae	140	void isis_init(void);
3f045a08 JB	141	void isis_new(unsigned long);
3f045a08 JB	142	struct isis_area isis_area_create(const char );
d62a17ae	143	struct isis_area isis_area_lookup(const char );
d62a17ae	144	int isis_area_get(struct vty vty, const char area_tag);
3f045a08 JB	145	void print_debug(struct vty *, int, int);
3f045a08 JB	146
a38a72db CF	147	void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
	148	void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
	149	void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
	150	void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
	151	bool new_metric);
6754fc66 CF	152	void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
6754fc66 CF	153	void isis_area_is_type_set(struct isis_area *area, int is_type);
466ed406	154	void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
d62a17ae	155	uint16_t max_lsp_lifetime);
466ed406 CF	156	void isis_area_lsp_refresh_set(struct isis_area *area, int level,
466ed406 CF	157	uint16_t lsp_refresh);
9093b230	158	/* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
d62a17ae	159	int isis_area_passwd_unset(struct isis_area *area, int level);
	160	int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
	161	const char *passwd, u_char snp_auth);
	162	int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
	163	const char *passwd, u_char snp_auth);
	164	void isis_vty_init(void);
65f9a9a8	165
3f045a08 JB	166	/* Master of threads. */
3f045a08 JB	167	extern struct thread_master *master;
eb5d44eb	168
	169	#define DEBUG_ADJ_PACKETS (1<<0)
	170	#define DEBUG_CHECKSUM_ERRORS (1<<1)
	171	#define DEBUG_LOCAL_UPDATES (1<<2)
	172	#define DEBUG_PROTOCOL_ERRORS (1<<3)
	173	#define DEBUG_SNP_PACKETS (1<<4)
	174	#define DEBUG_UPDATE_PACKETS (1<<5)
	175	#define DEBUG_SPF_EVENTS (1<<6)
	176	#define DEBUG_SPF_STATS (1<<7)
	177	#define DEBUG_SPF_TRIGGERS (1<<8)
	178	#define DEBUG_RTE_EVENTS (1<<9)
	179	#define DEBUG_EVENTS (1<<10)
c89c05dd	180	#define DEBUG_ZEBRA (1<<11)
3f045a08	181	#define DEBUG_PACKET_DUMP (1<<12)
14872644	182	#define DEBUG_LSP_GEN (1<<13)
414766a1	183	#define DEBUG_LSP_SCHED (1<<14)
14872644	184
d62a17ae	185	#define lsp_debug(...) \
	186	do { \
	187	if (isis->debugs & DEBUG_LSP_GEN) \
	188	zlog_debug(__VA_ARGS__); \
	189	} while (0)
	190
	191	#define sched_debug(...) \
	192	do { \
	193	if (isis->debugs & DEBUG_LSP_SCHED) \
	194	zlog_debug(__VA_ARGS__); \
	195	} while (0)
414766a1	196
f8c06e2c OD	197	#define DEBUG_TE (1<<13)
	198
	199	#define IS_DEBUG_ISIS(x) (isis->debugs & x)
	200
eb5d44eb	201	#endif /* ISISD_H */