[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; if not, write to the Free Software Foundation, Inc., 
 * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifndef ISISD_H
#define ISISD_H

#include "vty.h"

#define ISISD_VERSION "0.0.7"

#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_TLV_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 */

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