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