]> git.proxmox.com Git - mirror_frr.git/blame - isisd/isisd.h
isisd: implement the 'lsp-received' notification
[mirror_frr.git] / isisd / isisd.h
CommitLineData
eb5d44eb 1/*
d62a17ae 2 * IS-IS Rout(e)ing protocol - isisd.h
eb5d44eb 3 *
4 * Copyright (C) 2001,2002 Sampo Saaristo
d62a17ae 5 * Tampere University of Technology
eb5d44eb 6 * Institute of Communications Engineering
7 *
d62a17ae 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)
eb5d44eb 11 * any later version.
12 *
d62a17ae 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
eb5d44eb 16 * more details.
896014f4
DL
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
eb5d44eb 21 */
22
23#ifndef ISISD_H
24#define ISISD_H
25
91283e76
DS
26#include "vty.h"
27
65f9a9a8
DL
28#include "isisd/isis_constants.h"
29#include "isisd/isis_common.h"
f3ccedaa 30#include "isisd/isis_redist.h"
39bb53d6 31#include "isisd/isis_pdu_counter.h"
aaf2fd21 32#include "isisd/isis_circuit.h"
65f9a9a8
DL
33#include "isis_flags.h"
34#include "dict.h"
4a1ab8e4 35#include "isis_memory.h"
676a4ea3 36#include "qobj.h"
f3ccedaa 37
7c0cbd0e
CF
38#ifdef FABRICD
39static 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
47static 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
20bd27e2 54extern void isis_cli_init(void);
7c0cbd0e
CF
55#endif
56
76e292f9
DS
57extern struct zebra_privs_t isisd_privs;
58
eb5d44eb 59/* uncomment if you are a developer in bug hunt */
60/* #define EXTREME_DEBUG */
8955008f 61/* #define EXTREME_DICT_DEBUG */
eb5d44eb 62
8e6fb83b
CF
63struct fabricd;
64
d62a17ae 65struct isis {
d7c0a89a 66 unsigned long process_id;
d62a17ae 67 int sysid_set;
d7c0a89a
QY
68 uint8_t sysid[ISIS_SYS_ID_LEN]; /* SystemID for this IS */
69 uint32_t router_id; /* Router ID from zebra */
d62a17ae 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 */
d7c0a89a 74 uint8_t max_area_addrs; /* maximumAreaAdresses */
d62a17ae 75 struct area_addr *man_area_addrs; /* manualAreaAddresses */
d7c0a89a 76 uint32_t debugs; /* bitmap for debug */
d62a17ae 77 time_t uptime; /* when did we start */
98c5bc15 78 struct thread *t_dync_clean; /* dynamic hostname cache cleanup thread */
c59f88c8 79 uint32_t circuit_ids_used[8]; /* 256 bits to track circuit ids 1 through 255 */
d62a17ae 80
81 struct route_table *ext_info[REDIST_PROTOCOL_COUNT];
82
83 QOBJ_FIELDS
eb5d44eb 84};
85
3f045a08 86extern struct isis *isis;
676a4ea3 87DECLARE_QOBJ_TYPE(isis_area)
3f045a08 88
be985ba0
CF
89enum spf_tree_id {
90 SPFTREE_IPV4 = 0,
91 SPFTREE_IPV6,
321c1bbb 92 SPFTREE_DSTSRC,
be985ba0
CF
93 SPFTREE_COUNT
94};
95
9196731f
CF
96struct lsp_refresh_arg {
97 struct isis_area *area;
98 int level;
99};
100
e0df3206
EDP
101/* for yang configuration */
102enum isis_metric_style {
103 ISIS_NARROW_METRIC = 0,
104 ISIS_WIDE_METRIC,
105 ISIS_TRANSITION_METRIC,
106};
107
d62a17ae 108struct isis_area {
109 struct isis *isis; /* back pointer */
110 dict_t *lspdb[ISIS_LEVELS]; /* link-state dbs */
be985ba0 111 struct isis_spftree *spftree[SPFTREE_COUNT][ISIS_LEVELS];
b20ccb3a 112#define DEFAULT_LSP_MTU 1497
d62a17ae 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];
f93025e1 118 struct timeval last_lsp_refresh_event[ISIS_LEVELS];
d62a17ae 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
8e6fb83b
CF
132 struct fabricd *fabricd;
133
d62a17ae 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;
d7c0a89a 148 uint16_t max_lsp_lifetime[ISIS_LEVELS];
d62a17ae 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;
d7c0a89a 154 uint16_t lsp_refresh[ISIS_LEVELS];
d62a17ae 155 /* minimum time allowed before lsp retransmission */
d7c0a89a 156 uint16_t lsp_gen_interval[ISIS_LEVELS];
d62a17ae 157 /* min interval between between consequtive SPFs */
d7c0a89a 158 uint16_t min_spf_interval[ISIS_LEVELS];
d62a17ae 159 /* the percentage of LSP mtu size used, before generating a new frag */
160 int lsp_frag_threshold;
062f4d36 161 uint64_t lsp_gen_count[ISIS_LEVELS];
6f004b60 162 uint64_t lsp_purge_count[ISIS_LEVELS];
d62a17ae 163 int ip_circuits;
164 /* logging adjacency changes? */
d7c0a89a 165 uint8_t log_adj_changes;
d62a17ae 166 /* multi topology settings */
167 struct list *mt_settings;
168 int ipv6_circuits;
2c92bee4 169 bool purge_originator;
d62a17ae 170 /* Counters */
d7c0a89a 171 uint32_t circuit_state_changes;
d62a17ae 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];
9196731f
CF
180
181 struct lsp_refresh_arg lsp_refresh_arg[ISIS_LEVELS];
d62a17ae 182
39bb53d6
CF
183 pdu_counter_t pdu_tx_counters;
184 pdu_counter_t pdu_rx_counters;
86d6f80d 185 uint64_t lsp_rxmt_count;
39bb53d6 186
d62a17ae 187 QOBJ_FIELDS
eb5d44eb 188};
676a4ea3 189DECLARE_QOBJ_TYPE(isis_area)
eb5d44eb 190
d62a17ae 191void isis_init(void);
3f045a08
JB
192void isis_new(unsigned long);
193struct isis_area *isis_area_create(const char *);
d62a17ae 194struct isis_area *isis_area_lookup(const char *);
195int isis_area_get(struct vty *vty, const char *area_tag);
aaf2fd21 196int isis_area_destroy(const char *area_tag);
3f045a08 197void print_debug(struct vty *, int, int);
eb2bcb28 198struct isis_lsp *lsp_for_arg(const char *argv, dict_t *lspdb);
3f045a08 199
3dace42d
CF
200void isis_area_invalidate_routes(struct isis_area *area, int levels);
201void isis_area_verify_routes(struct isis_area *area);
202
a38a72db
CF
203void isis_area_overload_bit_set(struct isis_area *area, bool overload_bit);
204void isis_area_attached_bit_set(struct isis_area *area, bool attached_bit);
205void isis_area_dynhostname_set(struct isis_area *area, bool dynhostname);
206void isis_area_metricstyle_set(struct isis_area *area, bool old_metric,
207 bool new_metric);
6754fc66
CF
208void isis_area_lsp_mtu_set(struct isis_area *area, unsigned int lsp_mtu);
209void isis_area_is_type_set(struct isis_area *area, int is_type);
466ed406 210void isis_area_max_lsp_lifetime_set(struct isis_area *area, int level,
d62a17ae 211 uint16_t max_lsp_lifetime);
466ed406
CF
212void isis_area_lsp_refresh_set(struct isis_area *area, int level,
213 uint16_t lsp_refresh);
9093b230 214/* IS_LEVEL_1 sets area_passwd, IS_LEVEL_2 domain_passwd */
d62a17ae 215int isis_area_passwd_unset(struct isis_area *area, int level);
216int isis_area_passwd_cleartext_set(struct isis_area *area, int level,
d7c0a89a 217 const char *passwd, uint8_t snp_auth);
d62a17ae 218int isis_area_passwd_hmac_md5_set(struct isis_area *area, int level,
d7c0a89a 219 const char *passwd, uint8_t snp_auth);
65f9a9a8 220
20bd27e2
EDP
221extern const struct frr_yang_module_info frr_isisd_info;
222extern void isis_northbound_init(void);
9414b6f6
EDP
223
224/* YANG northbound notifications */
225extern void isis_notif_db_overload(const struct isis_area *area, bool overload);
56e22fb6
EDP
226extern void isis_notif_lsp_too_large(const struct isis_circuit *circuit,
227 uint32_t pdu_size, const char *lsp_id);
392b89f3
EDP
228extern void isis_notif_if_state_change(const struct isis_circuit *circuit,
229 bool down);
a2370545
EDP
230extern void isis_notif_corrupted_lsp(const struct isis_area *area,
231 const char *lsp_id); /* currently unused */
b21b068d
EDP
232extern void isis_notif_lsp_exceed_max(const struct isis_area *area,
233 const char *lsp_id);
2ab5a2d1
EDP
234extern void
235isis_notif_max_area_addr_mismatch(const struct isis_circuit *circuit,
236 uint8_t max_area_addrs, const char *raw_pdu);
3380c990
EDP
237extern void
238isis_notif_authentication_type_failure(const struct isis_circuit *circuit,
239 const char *raw_pdu);
240extern void
241isis_notif_authentication_failure(const struct isis_circuit *circuit,
242 const char *raw_pdu);
de983bb8
EDP
243extern void isis_notif_adj_state_change(const struct isis_adjacency *adj,
244 int new_state, const char *reason);
af6911c9
EDP
245extern void isis_notif_reject_adjacency(const struct isis_circuit *circuit,
246 const char *reason,
247 const char *raw_pdu);
9d92b84b
EDP
248extern void isis_notif_area_mismatch(const struct isis_circuit *circuit,
249 const char *raw_pdu);
8375020a
EDP
250extern 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);
3f045a08
JB
253/* Master of threads. */
254extern struct thread_master *master;
eb5d44eb 255
256#define DEBUG_ADJ_PACKETS (1<<0)
26687d25
CF
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)
ddb33326 265#define DEBUG_FLOODING (1<<9)
26687d25 266#define DEBUG_BFD (1<<10)
161fa356 267#define DEBUG_TX_QUEUE (1<<11)
14872644 268
d62a17ae 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)
414766a1 280
26687d25 281#define DEBUG_TE DEBUG_LSP_GEN
f8c06e2c
OD
282
283#define IS_DEBUG_ISIS(x) (isis->debugs & x)
284
eb5d44eb 285#endif /* ISISD_H */