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 #include "isisd/isis_constants.h"
  29 #include "isisd/isis_common.h"
  30 #include "isisd/isis_redist.h"
  31 #include "isis_flags.h"
  32 #include "dict.h"
  33 #include "isis_memory.h"
  34 #include "qobj.h"
  35
  36 extern struct zebra_privs_t isisd_privs;
  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         unsigned long process_id;
  44         int sysid_set;
  45         uint8_t sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
  46         uint32_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         uint8_t max_area_addrs;           /* maximumAreaAdresses */
  52         struct area_addr *man_area_addrs; /* manualAreaAddresses */
  53         uint32_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         uint32_t circuit_ids_used[8];     /* 256 bits to track circuit ids 1 through 255 */
  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 enum spf_tree_id {
  67         SPFTREE_IPV4 = 0,
  68         SPFTREE_IPV6,
  69         SPFTREE_COUNT
  70 };
  71
  72 struct isis_area {
  73         struct isis *isis;                             /* back pointer */
  74         dict_t *lspdb[ISIS_LEVELS];                    /* link-state dbs */
  75         struct isis_spftree *spftree[SPFTREE_COUNT][ISIS_LEVELS];
  76 #define DEFAULT_LSP_MTU 1497
  77         unsigned int lsp_mtu;      /* Size of LSPs to generate */
  78         struct list *circuit_list; /* IS-IS circuits */
  79         struct flags flags;
  80         struct thread *t_tick; /* LSP walker */
  81         struct thread *t_lsp_refresh[ISIS_LEVELS];
  82         /* t_lsp_refresh is used in two ways:
  83          * a) regular refresh of LSPs
  84          * b) (possibly throttled) updates to LSPs
  85          *
  86          * The lsp_regenerate_pending flag tracks whether the timer is active
  87          * for the a) or the b) case.
  88          *
  89          * It is of utmost importance to clear this flag when the timer is
  90          * rescheduled for normal refresh, because otherwise, updates will
  91          * be delayed until the next regular refresh.
  92          */
  93         int lsp_regenerate_pending[ISIS_LEVELS];
  94
  95         /*
  96          * Configurables
  97          */
  98         struct isis_passwd area_passwd;
  99         struct isis_passwd domain_passwd;
 100         /* do we support dynamic hostnames?  */
 101         char dynhostname;
 102         /* do we support new style metrics?  */
 103         char newmetric;
 104         char oldmetric;
 105         /* identifies the routing instance   */
 106         char *area_tag;
 107         /* area addresses for this area      */
 108         struct list *area_addrs;
 109         uint16_t max_lsp_lifetime[ISIS_LEVELS];
 110         char is_type; /* level-1 level-1-2 or level-2-only */
 111         /* are we overloaded? */
 112         char overload_bit;
 113         /* L1/L2 router identifier for inter-area traffic */
 114         char attached_bit;
 115         uint16_t lsp_refresh[ISIS_LEVELS];
 116         /* minimum time allowed before lsp retransmission */
 117         uint16_t lsp_gen_interval[ISIS_LEVELS];
 118         /* min interval between between consequtive SPFs */
 119         uint16_t min_spf_interval[ISIS_LEVELS];
 120         /* the percentage of LSP mtu size used, before generating a new frag */
 121         int lsp_frag_threshold;
 122         int ip_circuits;
 123         /* logging adjacency changes? */
 124         uint8_t log_adj_changes;
 125         /* multi topology settings */
 126         struct list *mt_settings;
 127         int ipv6_circuits;
 128         /* Counters */
 129         uint32_t circuit_state_changes;
 130         struct isis_redist redist_settings[REDIST_PROTOCOL_COUNT]
 131                                           [ZEBRA_ROUTE_MAX + 1][ISIS_LEVELS];
 132         struct route_table *ext_reach[REDIST_PROTOCOL_COUNT][ISIS_LEVELS];
 133
 134         struct spf_backoff *spf_delay_ietf[ISIS_LEVELS]; /*Structure with IETF
 135                                                             SPF algo
 136                                                             parameters*/
 137         struct thread *spf_timer[ISIS_LEVELS];
 138
 139         QOBJ_FIELDS
 140 };
 141 DECLARE_QOBJ_TYPE(isis_area)
 142
 143 void isis_init(void);
 144 void isis_new(unsigned long);
 145 struct isis_area *isis_area_create(const char *);
 146 struct isis_area *isis_area_lookup(const char *);
 147 int isis_area_get(struct vty *vty, const char *area_tag);
 148 void print_debug(struct vty *, int, int);
 149
 150 void isis_area_invalidate_routes(struct isis_area *area, int levels);
 151 void isis_area_verify_routes(struct isis_area *area);
 152
 153 void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
 154 void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
 155 void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
 156 void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
 157                                bool new_metric);
 158 void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
 159 void isis_area_is_type_set(struct isis_area *area, int is_type);
 160 void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
 161                                     uint16_t max_lsp_lifetime);
 162 void isis_area_lsp_refresh_set(struct isis_area *area, int level,
 163                                uint16_t lsp_refresh);
 164 /* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
 165 int isis_area_passwd_unset(struct isis_area *area, int level);
 166 int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
 167                                    const char *passwd, uint8_t snp_auth);
 168 int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
 169                                   const char *passwd, uint8_t snp_auth);
 170 void isis_vty_init(void);
 171
 172 /* Master of threads. */
 173 extern struct thread_master *master;
 174
 175 #define DEBUG_ADJ_PACKETS                (1<<0)
 176 #define DEBUG_CHECKSUM_ERRORS            (1<<1)
 177 #define DEBUG_LOCAL_UPDATES              (1<<2)
 178 #define DEBUG_PROTOCOL_ERRORS            (1<<3)
 179 #define DEBUG_SNP_PACKETS                (1<<4)
 180 #define DEBUG_UPDATE_PACKETS             (1<<5)
 181 #define DEBUG_SPF_EVENTS                 (1<<6)
 182 #define DEBUG_SPF_STATS                  (1<<7)
 183 #define DEBUG_SPF_TRIGGERS               (1<<8)
 184 #define DEBUG_RTE_EVENTS                 (1<<9)
 185 #define DEBUG_EVENTS                     (1<<10)
 186 #define DEBUG_ZEBRA                      (1<<11)
 187 #define DEBUG_PACKET_DUMP                (1<<12)
 188 #define DEBUG_LSP_GEN                    (1<<13)
 189 #define DEBUG_LSP_SCHED                  (1<<14)
 190
 191 #define lsp_debug(...)                                                         \
 192         do {                                                                   \
 193                 if (isis->debugs & DEBUG_LSP_GEN)                              \
 194                         zlog_debug(__VA_ARGS__);                               \
 195         } while (0)
 196
 197 #define sched_debug(...)                                                       \
 198         do {                                                                   \
 199                 if (isis->debugs & DEBUG_LSP_SCHED)                            \
 200                         zlog_debug(__VA_ARGS__);                               \
 201         } while (0)
 202
 203 #define DEBUG_TE                         (1<<13)
 204
 205 #define IS_DEBUG_ISIS(x)                 (isis->debugs & x)
 206
 207 #endif /* ISISD_H */