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