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 #ifdef FABRICD
  37 static const bool fabricd = true;
  38 #define PROTO_TYPE ZEBRA_ROUTE_OPENFABRIC
  39 #define PROTO_NAME "openfabric"
  40 #define PROTO_HELP "OpenFabric routing protocol\n"
  41 #define PROTO_REDIST_STR FRR_REDIST_STR_FABRICD
  42 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_FABRICD
  43 #define ROUTER_NODE OPENFABRIC_NODE
  44 #else
  45 static const bool fabricd = false;
  46 #define PROTO_TYPE ZEBRA_ROUTE_ISIS
  47 #define PROTO_NAME "isis"
  48 #define PROTO_HELP "IS-IS routing protocol\n"
  49 #define PROTO_REDIST_STR FRR_REDIST_STR_ISISD
  50 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_ISISD
  51 #define ROUTER_NODE ISIS_NODE
  52 #endif
  53
  54 extern struct zebra_privs_t isisd_privs;
  55
  56 /* uncomment if you are a developer in bug hunt */
  57 /* #define EXTREME_DEBUG  */
  58 /* #define EXTREME_DICT_DEBUG */
  59
  60 struct isis {
  61         unsigned long process_id;
  62         int sysid_set;
  63         uint8_t sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
  64         uint32_t router_id;             /* Router ID from zebra */
  65         struct list *area_list; /* list of IS-IS areas */
  66         struct list *init_circ_list;
  67         struct list *nexthops;            /* IPv4 next hops from this IS */
  68         struct list *nexthops6;           /* IPv6 next hops from this IS */
  69         uint8_t max_area_addrs;           /* maximumAreaAdresses */
  70         struct area_addr *man_area_addrs; /* manualAreaAddresses */
  71         uint32_t debugs;                  /* bitmap for debug */
  72         time_t uptime;                    /* when did we start */
  73         struct thread *t_dync_clean;      /* dynamic hostname cache cleanup thread */
  74         uint32_t circuit_ids_used[8];     /* 256 bits to track circuit ids 1 through 255 */
  75
  76         struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
  77
  78         QOBJ_FIELDS
  79 };
  80
  81 extern struct isis *isis;
  82 DECLARE_QOBJ_TYPE(isis_area)
  83
  84 enum spf_tree_id {
  85         SPFTREE_IPV4 = 0,
  86         SPFTREE_IPV6,
  87         SPFTREE_DSTSRC,
  88         SPFTREE_COUNT
  89 };
  90
  91 struct isis_area {
  92         struct isis *isis;                             /* back pointer */
  93         dict_t *lspdb[ISIS_LEVELS];                    /* link-state dbs */
  94         struct isis_spftree *spftree[SPFTREE_COUNT][ISIS_LEVELS];
  95 #define DEFAULT_LSP_MTU 1497
  96         unsigned int lsp_mtu;      /* Size of LSPs to generate */
  97         struct list *circuit_list; /* IS-IS circuits */
  98         struct flags flags;
  99         struct thread *t_tick; /* LSP walker */
 100         struct thread *t_lsp_refresh[ISIS_LEVELS];
 101         /* t_lsp_refresh is used in two ways:
 102          * a) regular refresh of LSPs
 103          * b) (possibly throttled) updates to LSPs
 104          *
 105          * The lsp_regenerate_pending flag tracks whether the timer is active
 106          * for the a) or the b) case.
 107          *
 108          * It is of utmost importance to clear this flag when the timer is
 109          * rescheduled for normal refresh, because otherwise, updates will
 110          * be delayed until the next regular refresh.
 111          */
 112         int lsp_regenerate_pending[ISIS_LEVELS];
 113
 114         /*
 115          * Configurables
 116          */
 117         struct isis_passwd area_passwd;
 118         struct isis_passwd domain_passwd;
 119         /* do we support dynamic hostnames?  */
 120         char dynhostname;
 121         /* do we support new style metrics?  */
 122         char newmetric;
 123         char oldmetric;
 124         /* identifies the routing instance   */
 125         char *area_tag;
 126         /* area addresses for this area      */
 127         struct list *area_addrs;
 128         uint16_t max_lsp_lifetime[ISIS_LEVELS];
 129         char is_type; /* level-1 level-1-2 or level-2-only */
 130         /* are we overloaded? */
 131         char overload_bit;
 132         /* L1/L2 router identifier for inter-area traffic */
 133         char attached_bit;
 134         uint16_t lsp_refresh[ISIS_LEVELS];
 135         /* minimum time allowed before lsp retransmission */
 136         uint16_t lsp_gen_interval[ISIS_LEVELS];
 137         /* min interval between between consequtive SPFs */
 138         uint16_t min_spf_interval[ISIS_LEVELS];
 139         /* the percentage of LSP mtu size used, before generating a new frag */
 140         int lsp_frag_threshold;
 141         int ip_circuits;
 142         /* logging adjacency changes? */
 143         uint8_t log_adj_changes;
 144         /* multi topology settings */
 145         struct list *mt_settings;
 146         int ipv6_circuits;
 147         /* Counters */
 148         uint32_t circuit_state_changes;
 149         struct isis_redist redist_settings[REDIST_PROTOCOL_COUNT]
 150                                           [ZEBRA_ROUTE_MAX + 1][ISIS_LEVELS];
 151         struct route_table *ext_reach[REDIST_PROTOCOL_COUNT][ISIS_LEVELS];
 152
 153         struct spf_backoff *spf_delay_ietf[ISIS_LEVELS]; /*Structure with IETF
 154                                                             SPF algo
 155                                                             parameters*/
 156         struct thread *spf_timer[ISIS_LEVELS];
 157
 158         QOBJ_FIELDS
 159 };
 160 DECLARE_QOBJ_TYPE(isis_area)
 161
 162 void isis_init(void);
 163 void isis_new(unsigned long);
 164 struct isis_area *isis_area_create(const char *);
 165 struct isis_area *isis_area_lookup(const char *);
 166 int isis_area_get(struct vty *vty, const char *area_tag);
 167 void print_debug(struct vty *, int, int);
 168
 169 void isis_area_invalidate_routes(struct isis_area *area, int levels);
 170 void isis_area_verify_routes(struct isis_area *area);
 171
 172 void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
 173 void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
 174 void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
 175 void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
 176                                bool new_metric);
 177 void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
 178 void isis_area_is_type_set(struct isis_area *area, int is_type);
 179 void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
 180                                     uint16_t max_lsp_lifetime);
 181 void isis_area_lsp_refresh_set(struct isis_area *area, int level,
 182                                uint16_t lsp_refresh);
 183 /* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
 184 int isis_area_passwd_unset(struct isis_area *area, int level);
 185 int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
 186                                    const char *passwd, uint8_t snp_auth);
 187 int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
 188                                   const char *passwd, uint8_t snp_auth);
 189 void isis_vty_init(void);
 190
 191 /* Master of threads. */
 192 extern struct thread_master *master;
 193
 194 #define DEBUG_ADJ_PACKETS                (1<<0)
 195 #define DEBUG_CHECKSUM_ERRORS            (1<<1)
 196 #define DEBUG_LOCAL_UPDATES              (1<<2)
 197 #define DEBUG_PROTOCOL_ERRORS            (1<<3)
 198 #define DEBUG_SNP_PACKETS                (1<<4)
 199 #define DEBUG_UPDATE_PACKETS             (1<<5)
 200 #define DEBUG_SPF_EVENTS                 (1<<6)
 201 #define DEBUG_SPF_STATS                  (1<<7)
 202 #define DEBUG_SPF_TRIGGERS               (1<<8)
 203 #define DEBUG_RTE_EVENTS                 (1<<9)
 204 #define DEBUG_EVENTS                     (1<<10)
 205 #define DEBUG_ZEBRA                      (1<<11)
 206 #define DEBUG_PACKET_DUMP                (1<<12)
 207 #define DEBUG_LSP_GEN                    (1<<13)
 208 #define DEBUG_LSP_SCHED                  (1<<14)
 209
 210 #define lsp_debug(...)                                                         \
 211         do {                                                                   \
 212                 if (isis->debugs & DEBUG_LSP_GEN)                              \
 213                         zlog_debug(__VA_ARGS__);                               \
 214         } while (0)
 215
 216 #define sched_debug(...)                                                       \
 217         do {                                                                   \
 218                 if (isis->debugs & DEBUG_LSP_SCHED)                            \
 219                         zlog_debug(__VA_ARGS__);                               \
 220         } while (0)
 221
 222 #define DEBUG_TE                         (1<<13)
 223
 224 #define IS_DEBUG_ISIS(x)                 (isis->debugs & x)
 225
 226 #endif /* ISISD_H */