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