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 #include "memory.h"
  28
  29 #include "isisd/isis_constants.h"
  30 #include "isisd/isis_common.h"
  31 #include "isisd/isis_redist.h"
  32 #include "isisd/isis_pdu_counter.h"
  33 #include "isisd/isis_circuit.h"
  34 #include "isisd/isis_sr.h"
  35 #include "isis_flags.h"
  36 #include "isis_lsp.h"
  37 #include "isis_lfa.h"
  38 #include "qobj.h"
  39 #include "ldp_sync.h"
  40
  41 DECLARE_MGROUP(ISISD);
  42
  43 #ifdef FABRICD
  44 static const bool fabricd = true;
  45 #define PROTO_TYPE ZEBRA_ROUTE_OPENFABRIC
  46 #define PROTO_NAME "openfabric"
  47 #define PROTO_HELP "OpenFabric routing protocol\n"
  48 #define PROTO_REDIST_STR FRR_REDIST_STR_FABRICD
  49 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_FABRICD
  50 #define ROUTER_NODE OPENFABRIC_NODE
  51 #else
  52 static const bool fabricd = false;
  53 #define PROTO_TYPE ZEBRA_ROUTE_ISIS
  54 #define PROTO_NAME "isis"
  55 #define PROTO_HELP "IS-IS routing protocol\n"
  56 #define PROTO_REDIST_STR FRR_REDIST_STR_ISISD
  57 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_ISISD
  58 #define ROUTER_NODE ISIS_NODE
  59 extern void isis_cli_init(void);
  60 #endif
  61
  62 #define ISIS_FIND_VRF_ARGS(argv, argc, idx_vrf, vrf_name, all_vrf)             \
  63         if (argv_find(argv, argc, "vrf", &idx_vrf)) {                          \
  64                 vrf_name = argv[idx_vrf + 1]->arg;                             \
  65                 all_vrf = strmatch(vrf_name, "all");                           \
  66         }
  67
  68 extern struct zebra_privs_t isisd_privs;
  69
  70 /* uncomment if you are a developer in bug hunt */
  71 /* #define EXTREME_DEBUG  */
  72
  73 struct fabricd;
  74
  75 struct isis_master {
  76         /* ISIS instance. */
  77         struct list *isis;
  78         /* ISIS thread master. */
  79         struct thread_master *master;
  80         uint8_t options;
  81 };
  82 #define F_ISIS_UNIT_TEST 0x01
  83
  84 struct isis {
  85         vrf_id_t vrf_id;
  86         char *name;
  87         unsigned long process_id;
  88         int sysid_set;
  89         uint8_t sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
  90         uint32_t router_id;             /* Router ID from zebra */
  91         struct list *area_list; /* list of IS-IS areas */
  92         uint8_t max_area_addrs;           /* maximumAreaAdresses */
  93         struct area_addr *man_area_addrs; /* manualAreaAddresses */
  94         time_t uptime;                    /* when did we start */
  95         struct thread *t_dync_clean;      /* dynamic hostname cache cleanup thread */
  96         uint32_t circuit_ids_used[8];     /* 256 bits to track circuit ids 1 through 255 */
  97         int snmp_notifications;
  98         struct list *dyn_cache;
  99
 100         struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
 101 };
 102
 103 extern struct isis_master *im;
 104
 105 enum spf_tree_id {
 106         SPFTREE_IPV4 = 0,
 107         SPFTREE_IPV6,
 108         SPFTREE_DSTSRC,
 109         SPFTREE_COUNT
 110 };
 111
 112 struct lsp_refresh_arg {
 113         struct isis_area *area;
 114         int level;
 115 };
 116
 117 /* for yang configuration */
 118 enum isis_metric_style {
 119         ISIS_NARROW_METRIC = 0,
 120         ISIS_WIDE_METRIC,
 121         ISIS_TRANSITION_METRIC,
 122 };
 123
 124 struct isis_area {
 125         struct isis *isis;                             /* back pointer */
 126         struct lspdb_head lspdb[ISIS_LEVELS];          /* link-state dbs */
 127         struct isis_spftree *spftree[SPFTREE_COUNT][ISIS_LEVELS];
 128 #define DEFAULT_LSP_MTU 1497
 129         unsigned int lsp_mtu;      /* Size of LSPs to generate */
 130         struct list *circuit_list; /* IS-IS circuits */
 131         struct list *adjacency_list; /* IS-IS adjacencies */
 132         struct flags flags;
 133         struct thread *t_tick; /* LSP walker */
 134         struct thread *t_lsp_refresh[ISIS_LEVELS];
 135         struct timeval last_lsp_refresh_event[ISIS_LEVELS];
 136         struct thread *t_rlfa_rib_update;
 137         /* t_lsp_refresh is used in two ways:
 138          * a) regular refresh of LSPs
 139          * b) (possibly throttled) updates to LSPs
 140          *
 141          * The lsp_regenerate_pending flag tracks whether the timer is active
 142          * for the a) or the b) case.
 143          *
 144          * It is of utmost importance to clear this flag when the timer is
 145          * rescheduled for normal refresh, because otherwise, updates will
 146          * be delayed until the next regular refresh.
 147          */
 148         int lsp_regenerate_pending[ISIS_LEVELS];
 149
 150         bool bfd_signalled_down;
 151         bool bfd_force_spf_refresh;
 152
 153         struct fabricd *fabricd;
 154
 155         /*
 156          * Configurables
 157          */
 158         struct isis_passwd area_passwd;
 159         struct isis_passwd domain_passwd;
 160         /* do we support dynamic hostnames?  */
 161         char dynhostname;
 162         /* do we support new style metrics?  */
 163         char newmetric;
 164         char oldmetric;
 165         /* identifies the routing instance   */
 166         char *area_tag;
 167         /* area addresses for this area      */
 168         struct list *area_addrs;
 169         uint16_t max_lsp_lifetime[ISIS_LEVELS];
 170         char is_type; /* level-1 level-1-2 or level-2-only */
 171         /* are we overloaded? */
 172         char overload_bit;
 173         uint32_t overload_counter;
 174         /* L1/L2 router identifier for inter-area traffic */
 175         char attached_bit_send;
 176         char attached_bit_rcv_ignore;
 177         uint16_t lsp_refresh[ISIS_LEVELS];
 178         /* minimum time allowed before lsp retransmission */
 179         uint16_t lsp_gen_interval[ISIS_LEVELS];
 180         /* min interval between between consequtive SPFs */
 181         uint16_t min_spf_interval[ISIS_LEVELS];
 182         /* the percentage of LSP mtu size used, before generating a new frag */
 183         int lsp_frag_threshold;
 184         uint64_t lsp_gen_count[ISIS_LEVELS];
 185         uint64_t lsp_purge_count[ISIS_LEVELS];
 186         uint32_t lsp_exceeded_max_counter;
 187         uint32_t lsp_seqno_skipped_counter;
 188         uint64_t spf_run_count[ISIS_LEVELS];
 189         int ip_circuits;
 190         /* logging adjacency changes? */
 191         uint8_t log_adj_changes;
 192         /* multi topology settings */
 193         struct list *mt_settings;
 194         /* MPLS-TE settings */
 195         struct mpls_te_area *mta;
 196         /* Segment Routing information */
 197         struct isis_sr_db srdb;
 198         int ipv6_circuits;
 199         bool purge_originator;
 200         /* SPF prefix priorities. */
 201         struct spf_prefix_priority_acl
 202                 spf_prefix_priorities[SPF_PREFIX_PRIO_MAX];
 203         /* Fast Re-Route information. */
 204         size_t lfa_protected_links[ISIS_LEVELS];
 205         size_t lfa_load_sharing[ISIS_LEVELS];
 206         enum spf_prefix_priority lfa_priority_limit[ISIS_LEVELS];
 207         struct lfa_tiebreaker_tree_head lfa_tiebreakers[ISIS_LEVELS];
 208         char *rlfa_plist_name[ISIS_LEVELS];
 209         struct prefix_list *rlfa_plist[ISIS_LEVELS];
 210         size_t rlfa_protected_links[ISIS_LEVELS];
 211         size_t tilfa_protected_links[ISIS_LEVELS];
 212         /* MPLS LDP-IGP Sync */
 213         struct ldp_sync_info_cmd ldp_sync_cmd;
 214         /* Counters */
 215         uint32_t circuit_state_changes;
 216         struct isis_redist redist_settings[REDIST_PROTOCOL_COUNT]
 217                                           [ZEBRA_ROUTE_MAX + 1][ISIS_LEVELS];
 218         struct route_table *ext_reach[REDIST_PROTOCOL_COUNT][ISIS_LEVELS];
 219
 220         struct spf_backoff *spf_delay_ietf[ISIS_LEVELS]; /*Structure with IETF
 221                                                             SPF algo
 222                                                             parameters*/
 223         struct thread *spf_timer[ISIS_LEVELS];
 224
 225         struct lsp_refresh_arg lsp_refresh_arg[ISIS_LEVELS];
 226
 227         pdu_counter_t pdu_tx_counters;
 228         pdu_counter_t pdu_rx_counters;
 229         uint64_t lsp_rxmt_count;
 230
 231         /* Area counters */
 232         uint64_t rej_adjacencies[2];
 233         uint64_t auth_type_failures[2];
 234         uint64_t auth_failures[2];
 235         uint64_t id_len_mismatches[2];
 236         uint64_t lsp_error_counter[2];
 237
 238         QOBJ_FIELDS;
 239 };
 240 DECLARE_QOBJ_TYPE(isis_area);
 241
 242 DECLARE_MTYPE(ISIS_ACL_NAME);   /* isis_area->spf_prefix_prioritites */
 243 DECLARE_MTYPE(ISIS_AREA_ADDR);  /* isis_area->area_addrs */
 244
 245 DECLARE_HOOK(isis_area_overload_bit_update, (struct isis_area * area), (area));
 246
 247 void isis_terminate(void);
 248 void isis_master_init(struct thread_master *master);
 249 void isis_vrf_link(struct isis *isis, struct vrf *vrf);
 250 void isis_vrf_unlink(struct isis *isis, struct vrf *vrf);
 251 void isis_global_instance_create(const char *vrf_name);
 252 struct isis *isis_lookup_by_vrfid(vrf_id_t vrf_id);
 253 struct isis *isis_lookup_by_vrfname(const char *vrfname);
 254 struct isis *isis_lookup_by_sysid(const uint8_t *sysid);
 255
 256 void isis_init(void);
 257 void isis_vrf_init(void);
 258
 259 struct isis *isis_new(const char *vrf_name);
 260 void isis_finish(struct isis *isis);
 261
 262 void isis_area_add_circuit(struct isis_area *area,
 263                            struct isis_circuit *circuit);
 264 void isis_area_del_circuit(struct isis_area *area,
 265                            struct isis_circuit *circuit);
 266
 267 struct isis_area *isis_area_create(const char *, const char *);
 268 struct isis_area *isis_area_lookup(const char *, vrf_id_t vrf_id);
 269 struct isis_area *isis_area_lookup_by_vrf(const char *area_tag,
 270                                           const char *vrf_name);
 271 int isis_area_get(struct vty *vty, const char *area_tag);
 272 void isis_area_destroy(struct isis_area *area);
 273 void isis_filter_update(struct access_list *access);
 274 void isis_prefix_list_update(struct prefix_list *plist);
 275 void print_debug(struct vty *, int, int);
 276 struct isis_lsp *lsp_for_sysid(struct lspdb_head *head, const char *sysid_str,
 277                                struct isis *isis);
 278
 279 void isis_area_invalidate_routes(struct isis_area *area, int levels);
 280 void isis_area_verify_routes(struct isis_area *area);
 281
 282 void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
 283 void isis_area_attached_bit_send_set(struct isis_area *area, bool attached_bit);
 284 void isis_area_attached_bit_receive_set(struct isis_area *area,
 285                                         bool attached_bit);
 286 void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
 287 void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
 288                                bool new_metric);
 289 void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
 290 void isis_area_is_type_set(struct isis_area *area, int is_type);
 291 void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
 292                                     uint16_t max_lsp_lifetime);
 293 void isis_area_lsp_refresh_set(struct isis_area *area, int level,
 294                                uint16_t lsp_refresh);
 295 /* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
 296 int isis_area_passwd_unset(struct isis_area *area, int level);
 297 int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
 298                                    const char *passwd, uint8_t snp_auth);
 299 int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
 300                                   const char *passwd, uint8_t snp_auth);
 301 void show_isis_database_lspdb(struct vty *vty, struct isis_area *area,
 302                               int level, struct lspdb_head *lspdb,
 303                               const char *argv, int ui_level);
 304
 305 /* YANG paths */
 306 #define ISIS_INSTANCE   "/frr-isisd:isis/instance"
 307 #define ISIS_SR         "/frr-isisd:isis/instance/segment-routing"
 308
 309 /* Master of threads. */
 310 extern struct thread_master *master;
 311
 312 extern unsigned long debug_adj_pkt;
 313 extern unsigned long debug_snp_pkt;
 314 extern unsigned long debug_update_pkt;
 315 extern unsigned long debug_spf_events;
 316 extern unsigned long debug_rte_events;
 317 extern unsigned long debug_events;
 318 extern unsigned long debug_pkt_dump;
 319 extern unsigned long debug_lsp_gen;
 320 extern unsigned long debug_lsp_sched;
 321 extern unsigned long debug_flooding;
 322 extern unsigned long debug_bfd;
 323 extern unsigned long debug_tx_queue;
 324 extern unsigned long debug_sr;
 325 extern unsigned long debug_ldp_sync;
 326 extern unsigned long debug_lfa;
 327
 328 #define DEBUG_ADJ_PACKETS                (1<<0)
 329 #define DEBUG_SNP_PACKETS                (1<<1)
 330 #define DEBUG_UPDATE_PACKETS             (1<<2)
 331 #define DEBUG_SPF_EVENTS                 (1<<3)
 332 #define DEBUG_RTE_EVENTS                 (1<<4)
 333 #define DEBUG_EVENTS                     (1<<5)
 334 #define DEBUG_PACKET_DUMP                (1<<6)
 335 #define DEBUG_LSP_GEN                    (1<<7)
 336 #define DEBUG_LSP_SCHED                  (1<<8)
 337 #define DEBUG_FLOODING                   (1<<9)
 338 #define DEBUG_BFD                        (1<<10)
 339 #define DEBUG_TX_QUEUE                   (1<<11)
 340 #define DEBUG_SR                         (1<<12)
 341 #define DEBUG_LDP_SYNC                   (1<<13)
 342 #define DEBUG_LFA                        (1<<14)
 343
 344 /* Debug related macro. */
 345 #define IS_DEBUG_ADJ_PACKETS (debug_adj_pkt & DEBUG_ADJ_PACKETS)
 346 #define IS_DEBUG_SNP_PACKETS (debug_snp_pkt & DEBUG_SNP_PACKETS)
 347 #define IS_DEBUG_UPDATE_PACKETS (debug_update_pkt & DEBUG_UPDATE_PACKETS)
 348 #define IS_DEBUG_SPF_EVENTS (debug_spf_events & DEBUG_SPF_EVENTS)
 349 #define IS_DEBUG_RTE_EVENTS (debug_rte_events & DEBUG_RTE_EVENTS)
 350 #define IS_DEBUG_EVENTS (debug_events & DEBUG_EVENTS)
 351 #define IS_DEBUG_PACKET_DUMP (debug_pkt_dump & DEBUG_PACKET_DUMP)
 352 #define IS_DEBUG_LSP_GEN (debug_lsp_gen & DEBUG_LSP_GEN)
 353 #define IS_DEBUG_LSP_SCHED (debug_lsp_sched & DEBUG_LSP_SCHED)
 354 #define IS_DEBUG_FLOODING (debug_flooding & DEBUG_FLOODING)
 355 #define IS_DEBUG_BFD (debug_bfd & DEBUG_BFD)
 356 #define IS_DEBUG_TX_QUEUE (debug_tx_queue & DEBUG_TX_QUEUE)
 357 #define IS_DEBUG_SR (debug_sr & DEBUG_SR)
 358 #define IS_DEBUG_LDP_SYNC (debug_ldp_sync & DEBUG_LDP_SYNC)
 359 #define IS_DEBUG_LFA (debug_lfa & DEBUG_LFA)
 360
 361 #define lsp_debug(...)                                                         \
 362         do {                                                                   \
 363                 if (IS_DEBUG_LSP_GEN)                                          \
 364                         zlog_debug(__VA_ARGS__);                               \
 365         } while (0)
 366
 367 #define sched_debug(...)                                                       \
 368         do {                                                                   \
 369                 if (IS_DEBUG_LSP_SCHED)                                        \
 370                         zlog_debug(__VA_ARGS__);                               \
 371         } while (0)
 372
 373 #define sr_debug(...)                                                          \
 374         do {                                                                   \
 375                 if (IS_DEBUG_SR)                                               \
 376                         zlog_debug(__VA_ARGS__);                               \
 377         } while (0)
 378
 379 #define DEBUG_TE                         DEBUG_LSP_GEN
 380
 381 #endif /* ISISD_H */