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