2 * IS-IS Rout(e)ing protocol - isisd.h
4 * Copyright (C) 2001,2002 Sampo Saaristo
5 * Tampere University of Technology
6 * Institute of Communications Engineering
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)
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
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
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"
41 DECLARE_MGROUP(ISISD
);
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_IP_REDIST_STR FRR_IP_REDIST_STR_FABRICD
50 #define PROTO_IP6_REDIST_STR FRR_IP6_REDIST_STR_FABRICD
51 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_FABRICD
52 #define PROTO_IP_REDIST_HELP FRR_IP_REDIST_HELP_STR_FABRICD
53 #define PROTO_IP6_REDIST_HELP FRR_IP6_REDIST_HELP_STR_FABRICD
54 #define ROUTER_NODE OPENFABRIC_NODE
56 static const bool fabricd
= false;
57 #define PROTO_TYPE ZEBRA_ROUTE_ISIS
58 #define PROTO_NAME "isis"
59 #define PROTO_HELP "IS-IS routing protocol\n"
60 #define PROTO_REDIST_STR FRR_REDIST_STR_ISISD
61 #define PROTO_IP_REDIST_STR FRR_IP_REDIST_STR_ISISD
62 #define PROTO_IP6_REDIST_STR FRR_IP6_REDIST_STR_ISISD
63 #define PROTO_REDIST_HELP FRR_REDIST_HELP_STR_ISISD
64 #define PROTO_IP_REDIST_HELP FRR_IP_REDIST_HELP_STR_ISISD
65 #define PROTO_IP6_REDIST_HELP FRR_IP6_REDIST_HELP_STR_ISISD
66 #define ROUTER_NODE ISIS_NODE
67 extern void isis_cli_init(void);
70 #define ISIS_FIND_VRF_ARGS(argv, argc, idx_vrf, vrf_name, all_vrf) \
71 if (argv_find(argv, argc, "vrf", &idx_vrf)) { \
72 vrf_name = argv[idx_vrf + 1]->arg; \
73 all_vrf = strmatch(vrf_name, "all"); \
76 extern struct zebra_privs_t isisd_privs
;
78 /* uncomment if you are a developer in bug hunt */
79 /* #define EXTREME_DEBUG */
86 /* ISIS thread master. */
87 struct thread_master
*master
;
90 #define F_ISIS_UNIT_TEST 0x01
92 #define ISIS_DEFAULT_MAX_AREA_ADDRESSES 3
97 unsigned long process_id
;
99 uint8_t sysid
[ISIS_SYS_ID_LEN
]; /* SystemID for this IS */
100 uint32_t router_id
; /* Router ID from zebra */
101 struct list
*area_list
; /* list of IS-IS areas */
102 uint8_t max_area_addrs
; /* maximumAreaAdresses */
103 struct area_addr
*man_area_addrs
; /* manualAreaAddresses */
104 time_t uptime
; /* when did we start */
105 struct thread
*t_dync_clean
; /* dynamic hostname cache cleanup thread */
106 uint32_t circuit_ids_used
[8]; /* 256 bits to track circuit ids 1 through 255 */
107 int snmp_notifications
;
108 struct list
*dyn_cache
;
110 struct route_table
*ext_info
[REDIST_PROTOCOL_COUNT
];
113 extern struct isis_master
*im
;
122 struct lsp_refresh_arg
{
123 struct isis_area
*area
;
127 /* for yang configuration */
128 enum isis_metric_style
{
129 ISIS_NARROW_METRIC
= 0,
131 ISIS_TRANSITION_METRIC
,
135 struct isis
*isis
; /* back pointer */
136 struct lspdb_head lspdb
[ISIS_LEVELS
]; /* link-state dbs */
137 struct isis_spftree
*spftree
[SPFTREE_COUNT
][ISIS_LEVELS
];
138 #define DEFAULT_LSP_MTU 1497
139 unsigned int lsp_mtu
; /* Size of LSPs to generate */
140 struct list
*circuit_list
; /* IS-IS circuits */
141 struct list
*adjacency_list
; /* IS-IS adjacencies */
143 struct thread
*t_tick
; /* LSP walker */
144 struct thread
*t_lsp_refresh
[ISIS_LEVELS
];
145 struct thread
*t_overload_on_startup_timer
;
146 struct timeval last_lsp_refresh_event
[ISIS_LEVELS
];
147 struct thread
*t_rlfa_rib_update
;
148 /* t_lsp_refresh is used in two ways:
149 * a) regular refresh of LSPs
150 * b) (possibly throttled) updates to LSPs
152 * The lsp_regenerate_pending flag tracks whether the timer is active
153 * for the a) or the b) case.
155 * It is of utmost importance to clear this flag when the timer is
156 * rescheduled for normal refresh, because otherwise, updates will
157 * be delayed until the next regular refresh.
159 int lsp_regenerate_pending
[ISIS_LEVELS
];
161 bool bfd_signalled_down
;
162 bool bfd_force_spf_refresh
;
164 struct fabricd
*fabricd
;
169 struct isis_passwd area_passwd
;
170 struct isis_passwd domain_passwd
;
171 /* do we support dynamic hostnames? */
173 /* do we support new style metrics? */
176 /* identifies the routing instance */
178 /* area addresses for this area */
179 struct list
*area_addrs
;
180 uint16_t max_lsp_lifetime
[ISIS_LEVELS
];
181 char is_type
; /* level-1 level-1-2 or level-2-only */
182 /* are we overloaded? */
184 bool overload_configured
;
185 uint32_t overload_counter
;
186 uint32_t overload_on_startup_time
;
187 /* L1/L2 router identifier for inter-area traffic */
188 char attached_bit_send
;
189 char attached_bit_rcv_ignore
;
190 uint16_t lsp_refresh
[ISIS_LEVELS
];
191 /* minimum time allowed before lsp retransmission */
192 uint16_t lsp_gen_interval
[ISIS_LEVELS
];
193 /* min interval between between consequtive SPFs */
194 uint16_t min_spf_interval
[ISIS_LEVELS
];
195 /* the percentage of LSP mtu size used, before generating a new frag */
196 int lsp_frag_threshold
;
197 uint64_t lsp_gen_count
[ISIS_LEVELS
];
198 uint64_t lsp_purge_count
[ISIS_LEVELS
];
199 uint32_t lsp_exceeded_max_counter
;
200 uint32_t lsp_seqno_skipped_counter
;
201 uint64_t spf_run_count
[ISIS_LEVELS
];
203 /* logging adjacency changes? */
204 uint8_t log_adj_changes
;
205 /* multi topology settings */
206 struct list
*mt_settings
;
207 /* MPLS-TE settings */
208 struct mpls_te_area
*mta
;
209 /* Segment Routing information */
210 struct isis_sr_db srdb
;
212 bool purge_originator
;
213 /* SPF prefix priorities. */
214 struct spf_prefix_priority_acl
215 spf_prefix_priorities
[SPF_PREFIX_PRIO_MAX
];
216 /* Fast Re-Route information. */
217 size_t lfa_protected_links
[ISIS_LEVELS
];
218 size_t lfa_load_sharing
[ISIS_LEVELS
];
219 enum spf_prefix_priority lfa_priority_limit
[ISIS_LEVELS
];
220 struct lfa_tiebreaker_tree_head lfa_tiebreakers
[ISIS_LEVELS
];
221 char *rlfa_plist_name
[ISIS_LEVELS
];
222 struct prefix_list
*rlfa_plist
[ISIS_LEVELS
];
223 size_t rlfa_protected_links
[ISIS_LEVELS
];
224 size_t tilfa_protected_links
[ISIS_LEVELS
];
225 /* MPLS LDP-IGP Sync */
226 struct ldp_sync_info_cmd ldp_sync_cmd
;
228 uint32_t circuit_state_changes
;
229 struct isis_redist redist_settings
[REDIST_PROTOCOL_COUNT
]
230 [ZEBRA_ROUTE_MAX
+ 1][ISIS_LEVELS
];
231 struct route_table
*ext_reach
[REDIST_PROTOCOL_COUNT
][ISIS_LEVELS
];
233 struct spf_backoff
*spf_delay_ietf
[ISIS_LEVELS
]; /*Structure with IETF
236 struct thread
*spf_timer
[ISIS_LEVELS
];
238 struct lsp_refresh_arg lsp_refresh_arg
[ISIS_LEVELS
];
240 pdu_counter_t pdu_tx_counters
;
241 pdu_counter_t pdu_rx_counters
;
242 uint64_t lsp_rxmt_count
;
245 uint64_t rej_adjacencies
[2];
246 uint64_t auth_type_failures
[2];
247 uint64_t auth_failures
[2];
248 uint64_t id_len_mismatches
[2];
249 uint64_t lsp_error_counter
[2];
253 DECLARE_QOBJ_TYPE(isis_area
);
255 DECLARE_MTYPE(ISIS_ACL_NAME
); /* isis_area->spf_prefix_prioritites */
256 DECLARE_MTYPE(ISIS_AREA_ADDR
); /* isis_area->area_addrs */
257 DECLARE_MTYPE(ISIS_PLIST_NAME
);
259 DECLARE_HOOK(isis_area_overload_bit_update
, (struct isis_area
* area
), (area
));
261 void isis_terminate(void);
262 void isis_master_init(struct thread_master
*master
);
263 void isis_vrf_link(struct isis
*isis
, struct vrf
*vrf
);
264 void isis_vrf_unlink(struct isis
*isis
, struct vrf
*vrf
);
265 struct isis
*isis_lookup_by_vrfid(vrf_id_t vrf_id
);
266 struct isis
*isis_lookup_by_vrfname(const char *vrfname
);
267 struct isis
*isis_lookup_by_sysid(const uint8_t *sysid
);
269 void isis_init(void);
270 void isis_vrf_init(void);
272 struct isis
*isis_new(const char *vrf_name
);
273 void isis_finish(struct isis
*isis
);
275 void isis_area_add_circuit(struct isis_area
*area
,
276 struct isis_circuit
*circuit
);
277 void isis_area_del_circuit(struct isis_area
*area
,
278 struct isis_circuit
*circuit
);
280 struct isis_area
*isis_area_create(const char *, const char *);
281 struct isis_area
*isis_area_lookup(const char *, vrf_id_t vrf_id
);
282 struct isis_area
*isis_area_lookup_by_vrf(const char *area_tag
,
283 const char *vrf_name
);
284 int isis_area_get(struct vty
*vty
, const char *area_tag
);
285 void isis_area_destroy(struct isis_area
*area
);
286 void isis_filter_update(struct access_list
*access
);
287 void isis_prefix_list_update(struct prefix_list
*plist
);
288 void print_debug(struct vty
*, int, int);
289 struct isis_lsp
*lsp_for_sysid(struct lspdb_head
*head
, const char *sysid_str
,
292 void isis_area_invalidate_routes(struct isis_area
*area
, int levels
);
293 void isis_area_verify_routes(struct isis_area
*area
);
294 void isis_area_switchover_routes(struct isis_area
*area
, int family
,
295 union g_addr
*nexthop_ip
, ifindex_t ifindex
,
298 void isis_area_overload_bit_set(struct isis_area
*area
, bool overload_bit
);
299 void isis_area_overload_on_startup_set(struct isis_area
*area
,
300 uint32_t startup_time
);
301 void isis_area_attached_bit_send_set(struct isis_area
*area
, bool attached_bit
);
302 void isis_area_attached_bit_receive_set(struct isis_area
*area
,
304 void isis_area_dynhostname_set(struct isis_area
*area
, bool dynhostname
);
305 void isis_area_metricstyle_set(struct isis_area
*area
, bool old_metric
,
307 void isis_area_lsp_mtu_set(struct isis_area
*area
, unsigned int lsp_mtu
);
308 void isis_area_is_type_set(struct isis_area
*area
, int is_type
);
309 void isis_area_max_lsp_lifetime_set(struct isis_area
*area
, int level
,
310 uint16_t max_lsp_lifetime
);
311 void isis_area_lsp_refresh_set(struct isis_area
*area
, int level
,
312 uint16_t lsp_refresh
);
313 /* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
314 int isis_area_passwd_unset(struct isis_area
*area
, int level
);
315 int isis_area_passwd_cleartext_set(struct isis_area
*area
, int level
,
316 const char *passwd
, uint8_t snp_auth
);
317 int isis_area_passwd_hmac_md5_set(struct isis_area
*area
, int level
,
318 const char *passwd
, uint8_t snp_auth
);
319 void show_isis_database_lspdb_json(struct json_object
*json
,
320 struct isis_area
*area
, int level
,
321 struct lspdb_head
*lspdb
, const char *argv
,
323 void show_isis_database_lspdb_vty(struct vty
*vty
, struct isis_area
*area
,
324 int level
, struct lspdb_head
*lspdb
,
325 const char *argv
, int ui_level
);
326 char *isis_restart_filepath(void);
327 void isis_restart_write_overload_time(struct isis_area
*isis_area
,
328 uint32_t overload_time
);
329 uint32_t isis_restart_read_overload_time(struct isis_area
*isis_area
);
331 #define ISIS_INSTANCE "/frr-isisd:isis/instance"
332 #define ISIS_SR "/frr-isisd:isis/instance/segment-routing"
334 /* Master of threads. */
335 extern struct thread_master
*master
;
337 extern unsigned long debug_adj_pkt
;
338 extern unsigned long debug_snp_pkt
;
339 extern unsigned long debug_update_pkt
;
340 extern unsigned long debug_spf_events
;
341 extern unsigned long debug_rte_events
;
342 extern unsigned long debug_events
;
343 extern unsigned long debug_pkt_dump
;
344 extern unsigned long debug_lsp_gen
;
345 extern unsigned long debug_lsp_sched
;
346 extern unsigned long debug_flooding
;
347 extern unsigned long debug_bfd
;
348 extern unsigned long debug_tx_queue
;
349 extern unsigned long debug_sr
;
350 extern unsigned long debug_ldp_sync
;
351 extern unsigned long debug_lfa
;
352 extern unsigned long debug_te
;
354 #define DEBUG_ADJ_PACKETS (1<<0)
355 #define DEBUG_SNP_PACKETS (1<<1)
356 #define DEBUG_UPDATE_PACKETS (1<<2)
357 #define DEBUG_SPF_EVENTS (1<<3)
358 #define DEBUG_RTE_EVENTS (1<<4)
359 #define DEBUG_EVENTS (1<<5)
360 #define DEBUG_PACKET_DUMP (1<<6)
361 #define DEBUG_LSP_GEN (1<<7)
362 #define DEBUG_LSP_SCHED (1<<8)
363 #define DEBUG_FLOODING (1<<9)
364 #define DEBUG_BFD (1<<10)
365 #define DEBUG_TX_QUEUE (1<<11)
366 #define DEBUG_SR (1<<12)
367 #define DEBUG_LDP_SYNC (1<<13)
368 #define DEBUG_LFA (1<<14)
369 #define DEBUG_TE (1<<15)
371 /* Debug related macro. */
372 #define IS_DEBUG_ADJ_PACKETS (debug_adj_pkt & DEBUG_ADJ_PACKETS)
373 #define IS_DEBUG_SNP_PACKETS (debug_snp_pkt & DEBUG_SNP_PACKETS)
374 #define IS_DEBUG_UPDATE_PACKETS (debug_update_pkt & DEBUG_UPDATE_PACKETS)
375 #define IS_DEBUG_SPF_EVENTS (debug_spf_events & DEBUG_SPF_EVENTS)
376 #define IS_DEBUG_RTE_EVENTS (debug_rte_events & DEBUG_RTE_EVENTS)
377 #define IS_DEBUG_EVENTS (debug_events & DEBUG_EVENTS)
378 #define IS_DEBUG_PACKET_DUMP (debug_pkt_dump & DEBUG_PACKET_DUMP)
379 #define IS_DEBUG_LSP_GEN (debug_lsp_gen & DEBUG_LSP_GEN)
380 #define IS_DEBUG_LSP_SCHED (debug_lsp_sched & DEBUG_LSP_SCHED)
381 #define IS_DEBUG_FLOODING (debug_flooding & DEBUG_FLOODING)
382 #define IS_DEBUG_BFD (debug_bfd & DEBUG_BFD)
383 #define IS_DEBUG_TX_QUEUE (debug_tx_queue & DEBUG_TX_QUEUE)
384 #define IS_DEBUG_SR (debug_sr & DEBUG_SR)
385 #define IS_DEBUG_LDP_SYNC (debug_ldp_sync & DEBUG_LDP_SYNC)
386 #define IS_DEBUG_LFA (debug_lfa & DEBUG_LFA)
387 #define IS_DEBUG_TE (debug_te & DEBUG_TE)
389 #define lsp_debug(...) \
391 if (IS_DEBUG_LSP_GEN) \
392 zlog_debug(__VA_ARGS__); \
395 #define sched_debug(...) \
397 if (IS_DEBUG_LSP_SCHED) \
398 zlog_debug(__VA_ARGS__); \
401 #define sr_debug(...) \
404 zlog_debug(__VA_ARGS__); \
407 #define te_debug(...) \
410 zlog_debug(__VA_ARGS__); \