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_DICT_DEBUG */
  41
  42 struct isis {
  43         u_long process_id;
  44         int sysid_set;
  45         u_char sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
  46         u_int32_t router_id;       /* Router ID from zebra */
  47         struct list *area_list; /* list of IS-IS areas */
  48         struct list *init_circ_list;
  49         struct list *nexthops;            /* IPv4 next hops from this IS */
  50         struct list *nexthops6;           /* IPv6 next hops from this IS */
  51         u_char max_area_addrs;            /* maximumAreaAdresses */
  52         struct area_addr *man_area_addrs; /* manualAreaAddresses */
  53         u_int32_t debugs;                 /* bitmap for debug */
  54         time_t uptime;                    /* when did we start */
  55         struct thread *t_dync_clean; /* dynamic hostname cache cleanup thread */
  56
  57         struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
  58
  59         QOBJ_FIELDS
  60 };
  61
  62 extern struct isis *isis;
  63 DECLARE_QOBJ_TYPE(isis_area)
  64
  65 struct isis_area {
  66         struct isis *isis;                             /* back pointer */
  67         dict_t *lspdb[ISIS_LEVELS];                    /* link-state dbs */
  68         struct isis_spftree *spftree[ISIS_LEVELS];     /* The v4 SPTs */
  69         struct route_table *route_table[ISIS_LEVELS];  /* IPv4 routes */
  70         struct isis_spftree *spftree6[ISIS_LEVELS];    /* The v6 SPTs */
  71         struct route_table *route_table6[ISIS_LEVELS]; /* IPv6 routes */
  72                                                        /* $FRR indent$ */
  73 /* clang-format off */
  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
 133                                                             SPF algo
 134                                                             parameters*/
 135         struct thread *spf_timer[ISIS_LEVELS];
 136
 137         QOBJ_FIELDS
 138 };
 139 DECLARE_QOBJ_TYPE(isis_area)
 140
 141 void isis_init(void);
 142 void isis_new(unsigned long);
 143 struct isis_area *isis_area_create(const char *);
 144 struct isis_area *isis_area_lookup(const char *);
 145 int isis_area_get(struct vty *vty, const char *area_tag);
 146 void print_debug(struct vty *, int, int);
 147
 148 void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
 149 void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
 150 void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
 151 void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
 152                                bool new_metric);
 153 void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
 154 void isis_area_is_type_set(struct isis_area *area, int is_type);
 155 void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
 156                                     uint16_t max_lsp_lifetime);
 157 void isis_area_lsp_refresh_set(struct isis_area *area, int level,
 158                                uint16_t lsp_refresh);
 159 /* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
 160 int isis_area_passwd_unset(struct isis_area *area, int level);
 161 int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
 162                                    const char *passwd, u_char snp_auth);
 163 int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
 164                                   const char *passwd, u_char snp_auth);
 165 void isis_vty_init(void);
 166
 167 /* Master of threads. */
 168 extern struct thread_master *master;
 169
 170 #define DEBUG_ADJ_PACKETS                (1<<0)
 171 #define DEBUG_CHECKSUM_ERRORS            (1<<1)
 172 #define DEBUG_LOCAL_UPDATES              (1<<2)
 173 #define DEBUG_PROTOCOL_ERRORS            (1<<3)
 174 #define DEBUG_SNP_PACKETS                (1<<4)
 175 #define DEBUG_UPDATE_PACKETS             (1<<5)
 176 #define DEBUG_SPF_EVENTS                 (1<<6)
 177 #define DEBUG_SPF_STATS                  (1<<7)
 178 #define DEBUG_SPF_TRIGGERS               (1<<8)
 179 #define DEBUG_RTE_EVENTS                 (1<<9)
 180 #define DEBUG_EVENTS                     (1<<10)
 181 #define DEBUG_ZEBRA                      (1<<11)
 182 #define DEBUG_PACKET_DUMP                (1<<12)
 183 #define DEBUG_LSP_GEN                    (1<<13)
 184 #define DEBUG_LSP_SCHED                  (1<<14)
 185
 186 #define lsp_debug(...)                                                         \
 187         do {                                                                   \
 188                 if (isis->debugs & DEBUG_LSP_GEN)                              \
 189                         zlog_debug(__VA_ARGS__);                               \
 190         } while (0)
 191
 192 #define sched_debug(...)                                                       \
 193         do {                                                                   \
 194                 if (isis->debugs & DEBUG_LSP_SCHED)                            \
 195                         zlog_debug(__VA_ARGS__);                               \
 196         } while (0)
 197
 198 #define DEBUG_TE                         (1<<13)
 199
 200 #define IS_DEBUG_ISIS(x)                 (isis->debugs & x)
 201
 202 #endif /* ISISD_H */