1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * IS-IS Rout(e)ing protocol - isisd.h
5 * Copyright (C) 2001,2002 Sampo Saaristo
6 * Tampere University of Technology
7 * Institute of Communications Engineering
16 #include "isisd/isis_constants.h"
17 #include "isisd/isis_common.h"
18 #include "isisd/isis_redist.h"
19 #include "isisd/isis_pdu_counter.h"
20 #include "isisd/isis_circuit.h"
21 #include "isisd/isis_sr.h"
22 #include "isis_flags.h"
28 DECLARE_MGROUP(ISISD
);
31 static const bool fabricd
= true;
32 #define PROTO_TYPE ZEBRA_ROUTE_OPENFABRIC
33 #define PROTO_NAME "openfabric"
34 #define PROTO_HELP "OpenFabric routing protocol\n"
35 #define PROTO_REDIST_STR FRR_REDIST_STR_FABRICD
36 #define PROTO_IP_REDIST_STR FRR_IP_REDIST_STR_FABRICD
37 #define PROTO_IP6_REDIST_STR FRR_IP6_REDIST_STR_FABRICD
38 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_FABRICD
39 #define PROTO_IP_REDIST_HELP FRR_IP_REDIST_HELP_STR_FABRICD
40 #define PROTO_IP6_REDIST_HELP FRR_IP6_REDIST_HELP_STR_FABRICD
41 #define ROUTER_NODE OPENFABRIC_NODE
43 static const bool fabricd
= false;
44 #define PROTO_TYPE ZEBRA_ROUTE_ISIS
45 #define PROTO_NAME "isis"
46 #define PROTO_HELP "IS-IS routing protocol\n"
47 #define PROTO_REDIST_STR FRR_REDIST_STR_ISISD
48 #define PROTO_IP_REDIST_STR FRR_IP_REDIST_STR_ISISD
49 #define PROTO_IP6_REDIST_STR FRR_IP6_REDIST_STR_ISISD
50 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_ISISD
51 #define PROTO_IP_REDIST_HELP FRR_IP_REDIST_HELP_STR_ISISD
52 #define PROTO_IP6_REDIST_HELP FRR_IP6_REDIST_HELP_STR_ISISD
53 #define ROUTER_NODE ISIS_NODE
54 extern void isis_cli_init(void);
57 #define ISIS_FIND_VRF_ARGS(argv, argc, idx_vrf, vrf_name, all_vrf) \
58 if (argv_find(argv, argc, "vrf", &idx_vrf)) { \
59 vrf_name = argv[idx_vrf + 1]->arg; \
60 all_vrf = strmatch(vrf_name, "all"); \
63 extern struct zebra_privs_t isisd_privs
;
65 /* uncomment if you are a developer in bug hunt */
66 /* #define EXTREME_DEBUG */
73 /* ISIS thread master. */
74 struct event_loop
*master
;
77 #define F_ISIS_UNIT_TEST 0x01
79 #define ISIS_DEFAULT_MAX_AREA_ADDRESSES 3
84 unsigned long process_id
;
86 uint8_t sysid
[ISIS_SYS_ID_LEN
]; /* SystemID for this IS */
87 uint32_t router_id
; /* Router ID from zebra */
88 struct list
*area_list
; /* list of IS-IS areas */
89 uint8_t max_area_addrs
; /* maximumAreaAdresses */
90 struct area_addr
*man_area_addrs
; /* manualAreaAddresses */
91 time_t uptime
; /* when did we start */
92 struct event
*t_dync_clean
; /* dynamic hostname cache cleanup thread */
93 uint32_t circuit_ids_used
[8]; /* 256 bits to track circuit ids 1 through 255 */
94 int snmp_notifications
;
95 struct list
*dyn_cache
;
97 struct route_table
*ext_info
[REDIST_PROTOCOL_COUNT
];
100 extern struct isis_master
*im
;
102 extern struct event
*t_isis_cfg
;
111 struct lsp_refresh_arg
{
112 struct isis_area
*area
;
116 /* for yang configuration */
117 enum isis_metric_style
{
118 ISIS_NARROW_METRIC
= 0,
120 ISIS_TRANSITION_METRIC
,
124 struct isis
*isis
; /* back pointer */
125 struct lspdb_head lspdb
[ISIS_LEVELS
]; /* link-state dbs */
126 struct isis_spftree
*spftree
[SPFTREE_COUNT
][ISIS_LEVELS
];
127 #define DEFAULT_LSP_MTU 1497
128 unsigned int lsp_mtu
; /* Size of LSPs to generate */
129 struct list
*circuit_list
; /* IS-IS circuits */
130 struct list
*adjacency_list
; /* IS-IS adjacencies */
132 struct event
*t_tick
; /* LSP walker */
133 struct event
*t_lsp_refresh
[ISIS_LEVELS
];
134 struct event
*t_overload_on_startup_timer
;
135 struct timeval last_lsp_refresh_event
[ISIS_LEVELS
];
136 struct event
*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
141 * The lsp_regenerate_pending flag tracks whether the timer is active
142 * for the a) or the b) case.
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.
148 int lsp_regenerate_pending
[ISIS_LEVELS
];
150 bool bfd_signalled_down
;
151 bool bfd_force_spf_refresh
;
153 struct fabricd
*fabricd
;
158 struct isis_passwd area_passwd
;
159 struct isis_passwd domain_passwd
;
160 /* do we support dynamic hostnames? */
162 /* do we support new style metrics? */
165 /* identifies the routing instance */
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? */
173 bool overload_configured
;
174 uint32_t overload_counter
;
175 uint32_t overload_on_startup_time
;
176 /* advertise prefixes of passive interfaces only? */
177 bool advertise_passive_only
;
178 /* Are we advertising high metrics? */
179 bool advertise_high_metrics
;
180 /* L1/L2 router identifier for inter-area traffic */
181 char attached_bit_send
;
182 char attached_bit_rcv_ignore
;
183 uint16_t lsp_refresh
[ISIS_LEVELS
];
184 /* minimum time allowed before lsp retransmission */
185 uint16_t lsp_gen_interval
[ISIS_LEVELS
];
186 /* min interval between between consequtive SPFs */
187 uint16_t min_spf_interval
[ISIS_LEVELS
];
188 /* the percentage of LSP mtu size used, before generating a new frag */
189 int lsp_frag_threshold
;
190 uint64_t lsp_gen_count
[ISIS_LEVELS
];
191 uint64_t lsp_purge_count
[ISIS_LEVELS
];
192 uint32_t lsp_exceeded_max_counter
;
193 uint32_t lsp_seqno_skipped_counter
;
194 uint64_t spf_run_count
[ISIS_LEVELS
];
196 /* logging adjacency changes? */
197 uint8_t log_adj_changes
;
198 /* multi topology settings */
199 struct list
*mt_settings
;
200 /* MPLS-TE settings */
201 struct mpls_te_area
*mta
;
202 /* Segment Routing information */
203 struct isis_sr_db srdb
;
205 bool purge_originator
;
206 /* SPF prefix priorities. */
207 struct spf_prefix_priority_acl
208 spf_prefix_priorities
[SPF_PREFIX_PRIO_MAX
];
209 /* Fast Re-Route information. */
210 size_t lfa_protected_links
[ISIS_LEVELS
];
211 size_t lfa_load_sharing
[ISIS_LEVELS
];
212 enum spf_prefix_priority lfa_priority_limit
[ISIS_LEVELS
];
213 struct lfa_tiebreaker_tree_head lfa_tiebreakers
[ISIS_LEVELS
];
214 char *rlfa_plist_name
[ISIS_LEVELS
];
215 struct prefix_list
*rlfa_plist
[ISIS_LEVELS
];
216 size_t rlfa_protected_links
[ISIS_LEVELS
];
217 size_t tilfa_protected_links
[ISIS_LEVELS
];
218 /* MPLS LDP-IGP Sync */
219 struct ldp_sync_info_cmd ldp_sync_cmd
;
221 uint32_t circuit_state_changes
;
222 struct isis_redist redist_settings
[REDIST_PROTOCOL_COUNT
]
223 [ZEBRA_ROUTE_MAX
+ 1][ISIS_LEVELS
];
224 struct route_table
*ext_reach
[REDIST_PROTOCOL_COUNT
][ISIS_LEVELS
];
226 struct spf_backoff
*spf_delay_ietf
[ISIS_LEVELS
]; /*Structure with IETF
229 struct event
*spf_timer
[ISIS_LEVELS
];
231 struct lsp_refresh_arg lsp_refresh_arg
[ISIS_LEVELS
];
233 pdu_counter_t pdu_tx_counters
;
234 pdu_counter_t pdu_rx_counters
;
235 pdu_counter_t pdu_drop_counters
;
236 uint64_t lsp_rxmt_count
;
239 uint64_t rej_adjacencies
[2];
240 uint64_t auth_type_failures
[2];
241 uint64_t auth_failures
[2];
242 uint64_t id_len_mismatches
[2];
243 uint64_t lsp_error_counter
[2];
247 DECLARE_QOBJ_TYPE(isis_area
);
249 DECLARE_MTYPE(ISIS_ACL_NAME
); /* isis_area->spf_prefix_prioritites */
250 DECLARE_MTYPE(ISIS_AREA_ADDR
); /* isis_area->area_addrs */
251 DECLARE_MTYPE(ISIS_PLIST_NAME
);
253 DECLARE_HOOK(isis_area_overload_bit_update
, (struct isis_area
* area
), (area
));
255 void isis_terminate(void);
256 void isis_master_init(struct event_loop
*master
);
257 void isis_vrf_link(struct isis
*isis
, struct vrf
*vrf
);
258 void isis_vrf_unlink(struct isis
*isis
, struct vrf
*vrf
);
259 struct isis
*isis_lookup_by_vrfid(vrf_id_t vrf_id
);
260 struct isis
*isis_lookup_by_vrfname(const char *vrfname
);
261 struct isis
*isis_lookup_by_sysid(const uint8_t *sysid
);
263 void isis_init(void);
264 void isis_vrf_init(void);
266 struct isis
*isis_new(const char *vrf_name
);
267 void isis_finish(struct isis
*isis
);
269 void isis_area_add_circuit(struct isis_area
*area
,
270 struct isis_circuit
*circuit
);
271 void isis_area_del_circuit(struct isis_area
*area
,
272 struct isis_circuit
*circuit
);
274 struct isis_area
*isis_area_create(const char *, const char *);
275 struct isis_area
*isis_area_lookup(const char *, vrf_id_t vrf_id
);
276 struct isis_area
*isis_area_lookup_by_vrf(const char *area_tag
,
277 const char *vrf_name
);
278 int isis_area_get(struct vty
*vty
, const char *area_tag
);
279 void isis_area_destroy(struct isis_area
*area
);
280 void isis_filter_update(struct access_list
*access
);
281 void isis_prefix_list_update(struct prefix_list
*plist
);
282 void print_debug(struct vty
*, int, int);
283 struct isis_lsp
*lsp_for_sysid(struct lspdb_head
*head
, const char *sysid_str
,
286 void isis_area_invalidate_routes(struct isis_area
*area
, int levels
);
287 void isis_area_verify_routes(struct isis_area
*area
);
288 void isis_area_switchover_routes(struct isis_area
*area
, int family
,
289 union g_addr
*nexthop_ip
, ifindex_t ifindex
,
292 void isis_area_overload_bit_set(struct isis_area
*area
, bool overload_bit
);
293 void isis_area_overload_on_startup_set(struct isis_area
*area
,
294 uint32_t startup_time
);
295 void isis_area_advertise_high_metrics_set(struct isis_area
*area
,
296 bool advertise_high_metrics
);
297 void isis_area_attached_bit_send_set(struct isis_area
*area
, bool attached_bit
);
298 void isis_area_attached_bit_receive_set(struct isis_area
*area
,
300 void isis_area_dynhostname_set(struct isis_area
*area
, bool dynhostname
);
301 void isis_area_metricstyle_set(struct isis_area
*area
, bool old_metric
,
303 void isis_area_lsp_mtu_set(struct isis_area
*area
, unsigned int lsp_mtu
);
304 void isis_area_is_type_set(struct isis_area
*area
, int is_type
);
305 void isis_area_max_lsp_lifetime_set(struct isis_area
*area
, int level
,
306 uint16_t max_lsp_lifetime
);
307 void isis_area_lsp_refresh_set(struct isis_area
*area
, int level
,
308 uint16_t lsp_refresh
);
309 /* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
310 int isis_area_passwd_unset(struct isis_area
*area
, int level
);
311 int isis_area_passwd_cleartext_set(struct isis_area
*area
, int level
,
312 const char *passwd
, uint8_t snp_auth
);
313 int isis_area_passwd_hmac_md5_set(struct isis_area
*area
, int level
,
314 const char *passwd
, uint8_t snp_auth
);
315 void show_isis_database_lspdb_json(struct json_object
*json
,
316 struct isis_area
*area
, int level
,
317 struct lspdb_head
*lspdb
, const char *argv
,
319 void show_isis_database_lspdb_vty(struct vty
*vty
, struct isis_area
*area
,
320 int level
, struct lspdb_head
*lspdb
,
321 const char *argv
, int ui_level
);
322 char *isis_restart_filepath(void);
323 void isis_restart_write_overload_time(struct isis_area
*isis_area
,
324 uint32_t overload_time
);
325 uint32_t isis_restart_read_overload_time(struct isis_area
*isis_area
);
326 void config_end_lsp_generate(struct isis_area
*area
);
329 #define ISIS_INSTANCE "/frr-isisd:isis/instance"
330 #define ISIS_SR "/frr-isisd:isis/instance/segment-routing"
332 /* Master of threads. */
333 extern struct event_loop
*master
;
335 extern unsigned long debug_adj_pkt
;
336 extern unsigned long debug_snp_pkt
;
337 extern unsigned long debug_update_pkt
;
338 extern unsigned long debug_spf_events
;
339 extern unsigned long debug_rte_events
;
340 extern unsigned long debug_events
;
341 extern unsigned long debug_pkt_dump
;
342 extern unsigned long debug_lsp_gen
;
343 extern unsigned long debug_lsp_sched
;
344 extern unsigned long debug_flooding
;
345 extern unsigned long debug_bfd
;
346 extern unsigned long debug_tx_queue
;
347 extern unsigned long debug_sr
;
348 extern unsigned long debug_ldp_sync
;
349 extern unsigned long debug_lfa
;
350 extern unsigned long debug_te
;
352 #define DEBUG_ADJ_PACKETS (1<<0)
353 #define DEBUG_SNP_PACKETS (1<<1)
354 #define DEBUG_UPDATE_PACKETS (1<<2)
355 #define DEBUG_SPF_EVENTS (1<<3)
356 #define DEBUG_RTE_EVENTS (1<<4)
357 #define DEBUG_EVENTS (1<<5)
358 #define DEBUG_PACKET_DUMP (1<<6)
359 #define DEBUG_LSP_GEN (1<<7)
360 #define DEBUG_LSP_SCHED (1<<8)
361 #define DEBUG_FLOODING (1<<9)
362 #define DEBUG_BFD (1<<10)
363 #define DEBUG_TX_QUEUE (1<<11)
364 #define DEBUG_SR (1<<12)
365 #define DEBUG_LDP_SYNC (1<<13)
366 #define DEBUG_LFA (1<<14)
367 #define DEBUG_TE (1<<15)
369 /* Debug related macro. */
370 #define IS_DEBUG_ADJ_PACKETS (debug_adj_pkt & DEBUG_ADJ_PACKETS)
371 #define IS_DEBUG_SNP_PACKETS (debug_snp_pkt & DEBUG_SNP_PACKETS)
372 #define IS_DEBUG_UPDATE_PACKETS (debug_update_pkt & DEBUG_UPDATE_PACKETS)
373 #define IS_DEBUG_SPF_EVENTS (debug_spf_events & DEBUG_SPF_EVENTS)
374 #define IS_DEBUG_RTE_EVENTS (debug_rte_events & DEBUG_RTE_EVENTS)
375 #define IS_DEBUG_EVENTS (debug_events & DEBUG_EVENTS)
376 #define IS_DEBUG_PACKET_DUMP (debug_pkt_dump & DEBUG_PACKET_DUMP)
377 #define IS_DEBUG_LSP_GEN (debug_lsp_gen & DEBUG_LSP_GEN)
378 #define IS_DEBUG_LSP_SCHED (debug_lsp_sched & DEBUG_LSP_SCHED)
379 #define IS_DEBUG_FLOODING (debug_flooding & DEBUG_FLOODING)
380 #define IS_DEBUG_BFD (debug_bfd & DEBUG_BFD)
381 #define IS_DEBUG_TX_QUEUE (debug_tx_queue & DEBUG_TX_QUEUE)
382 #define IS_DEBUG_SR (debug_sr & DEBUG_SR)
383 #define IS_DEBUG_LDP_SYNC (debug_ldp_sync & DEBUG_LDP_SYNC)
384 #define IS_DEBUG_LFA (debug_lfa & DEBUG_LFA)
385 #define IS_DEBUG_TE (debug_te & DEBUG_TE)
387 #define lsp_debug(...) \
389 if (IS_DEBUG_LSP_GEN) \
390 zlog_debug(__VA_ARGS__); \
393 #define sched_debug(...) \
395 if (IS_DEBUG_LSP_SCHED) \
396 zlog_debug(__VA_ARGS__); \
399 #define sr_debug(...) \
402 zlog_debug(__VA_ARGS__); \
405 #define te_debug(...) \
408 zlog_debug(__VA_ARGS__); \