isisd/isisd.h

   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; see the file COPYING; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #ifndef ISISD_H
  24 #define ISISD_H
  25
  26 #include "vty.h"
  27
  28 #define ISISD_VERSION "0.0.7"
  29
  30 #include "isisd/isis_constants.h"
  31 #include "isisd/isis_common.h"
  32 #include "isisd/isis_redist.h"
  33 #include "isis_flags.h"
  34 #include "dict.h"
  35 #include "isis_memory.h"
  36 #include "qobj.h"
  37
  38 /* uncomment if you are a developer in bug hunt */
  39 /* #define EXTREME_DEBUG  */
  40 /* #define EXTREME_TLV_DEBUG */
  41
  42 struct isis
  43 {
  44   u_long process_id;
  45   int sysid_set;
  46   u_char sysid[ISIS_SYS_ID_LEN];        /* SystemID for this IS */
  47   u_int32_t router_id;          /* Router ID from zebra */
  48   struct list *area_list;       /* list of IS-IS areas */
  49   struct list *init_circ_list;
  50   struct list *nexthops;        /* IPv4 next hops from this IS */
  51   struct list *nexthops6;       /* IPv6 next hops from this IS */
  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 */
  56   struct thread *t_dync_clean;  /* dynamic hostname cache cleanup thread */
  57
  58   struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
  59
  60   QOBJ_FIELDS
  61 };
  62
  63 extern struct isis *isis;
  64 DECLARE_QOBJ_TYPE(isis_area)
  65
  66 struct isis_area
  67 {
  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 */
  72   struct isis_spftree *spftree6[ISIS_LEVELS];     /* The v6 SPTs */
  73   struct route_table *route_table6[ISIS_LEVELS];  /* IPv6 routes */
  74 #define DEFAULT_LSP_MTU 1497
  75   unsigned int lsp_mtu;                           /* Size of LSPs to generate */
  76   struct list *circuit_list;    /* IS-IS circuits */
  77   struct flags flags;
  78   struct thread *t_tick;        /* LSP walker */
  79   struct thread *t_lsp_refresh[ISIS_LEVELS];
  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    */
  91   int lsp_regenerate_pending[ISIS_LEVELS];
  92
  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?  */
 101   char newmetric;
 102   char oldmetric;
 103   /* identifies the routing instance   */
 104   char *area_tag;
 105   /* area addresses for this area      */
 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 */
 109   /* are we overloaded? */
 110   char overload_bit;
 111   /* L1/L2 router identifier for inter-area traffic */
 112   char attached_bit;
 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 */
 117   u_int16_t min_spf_interval[ISIS_LEVELS];
 118   /* the percentage of LSP mtu size used, before generating a new frag */
 119   int lsp_frag_threshold;
 120   int ip_circuits;
 121   /* logging adjacency changes? */
 122   u_char log_adj_changes;
 123   /* multi topology settings */
 124   struct list *mt_settings;
 125   int ipv6_circuits;
 126   /* Counters */
 127   u_int32_t circuit_state_changes;
 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];
 131
 132   struct spf_backoff *spf_delay_ietf[ISIS_LEVELS]; /*Structure with IETF SPF algo parameters*/
 133   struct thread *spf_timer[ISIS_LEVELS];
 134
 135   QOBJ_FIELDS
 136 };
 137 DECLARE_QOBJ_TYPE(isis_area)
 138
 139 void isis_init (void);
 140 void isis_new(unsigned long);
 141 struct isis_area *isis_area_create(const char *);
 142 struct isis_area *isis_area_lookup (const char *);
 143 int isis_area_get (struct vty *vty, const char *area_tag);
 144 void print_debug(struct vty *, int, int);
 145
 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);
 151 void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
 152 void isis_area_is_type_set(struct isis_area *area, int is_type);
 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);
 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);
 163 void isis_vty_init (void);
 164
 165 /* Master of threads. */
 166 extern struct thread_master *master;
 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)
 179 #define DEBUG_ZEBRA                      (1<<11)
 180 #define DEBUG_PACKET_DUMP                (1<<12)
 181 #define DEBUG_LSP_GEN                    (1<<13)
 182 #define DEBUG_LSP_SCHED                  (1<<14)
 183
 184 #define lsp_debug(...) \
 185   do \
 186     { \
 187       if (isis->debugs & DEBUG_LSP_GEN) \
 188         zlog_debug(__VA_ARGS__); \
 189     } \
 190   while (0)
 191
 192 #define sched_debug(...) \
 193   do \
 194     { \
 195       if (isis->debugs & DEBUG_LSP_SCHED) \
 196         zlog_debug(__VA_ARGS__); \
 197     } \
 198   while (0)
 199
 200 #define DEBUG_TE                         (1<<13)
 201
 202 #define IS_DEBUG_ISIS(x)                 (isis->debugs & x)
 203
 204 #endif /* ISISD_H */