]> git.proxmox.com Git - mirror_frr.git/blame - ospfd/ospfd.h
Merge pull request #13455 from sri-mohan1/srib-ldpd
[mirror_frr.git] / ospfd / ospfd.h
CommitLineData
acddc0ed 1// SPDX-License-Identifier: GPL-2.0-or-later
718e3744 2/*
3 * OSPFd main header.
4 * Copyright (C) 1998, 99, 2000 Kunihiro Ishiguro, Toshiaki Takada
718e3744 5 */
6
7#ifndef _ZEBRA_OSPFD_H
8#define _ZEBRA_OSPFD_H
9
c514adc6 10#include <zebra.h>
7fd0729f 11#include "typesafe.h"
ae19c240 12#include "qobj.h"
8551e6da 13#include "libospf.h"
132a782e 14#include "ldp_sync.h"
c514adc6 15
718e3744 16#include "filter.h"
343f5cc7 17#include "log.h"
b5a8894d 18#include "vrf.h"
718e3744 19
4a1ab8e4 20#include "ospf_memory.h"
0a3fc2a5 21#include "ospf_dump_api.h"
4a1ab8e4 22
718e3744 23#define OSPF_VERSION 2
24
718e3744 25/* VTY port number. */
26#define OSPF_VTY_PORT 2604
718e3744 27
28/* IP TTL for OSPF protocol. */
29#define OSPF_IP_TTL 1
30#define OSPF_VL_IP_TTL 100
31
32/* Default configuration file name for ospfd. */
33#define OSPF_DEFAULT_CONFIG "ospfd.conf"
34
464c8204 35#define OSPF_NSSA_TRANS_STABLE_DEFAULT 40
718e3744 36
37#define OSPF_ALLSPFROUTERS 0xe0000005 /* 224.0.0.5 */
38#define OSPF_ALLDROUTERS 0xe0000006 /* 224.0.0.6 */
39
718e3744 40/* OSPF Authentication Type. */
41#define OSPF_AUTH_NULL 0
42#define OSPF_AUTH_SIMPLE 1
43#define OSPF_AUTH_CRYPTOGRAPHIC 2
44/* For Interface authentication setting default */
45#define OSPF_AUTH_NOTSET -1
d62a17ae 46/* For the consumption and sanity of the command handler */
718e3744 47/* DO NIOT REMOVE!!! Need to detect whether a value has
48 been given or not in VLink command handlers */
49#define OSPF_AUTH_CMD_NOTSEEN -2
50
718e3744 51/* OSPF options. */
16f1b9ee 52#define OSPF_OPTION_MT 0x01 /* M/T */
718e3744 53#define OSPF_OPTION_E 0x02
54#define OSPF_OPTION_MC 0x04
55#define OSPF_OPTION_NP 0x08
56#define OSPF_OPTION_EA 0x10
57#define OSPF_OPTION_DC 0x20
58#define OSPF_OPTION_O 0x40
16f1b9ee 59#define OSPF_OPTION_DN 0x80
718e3744 60
61/* OSPF Database Description flags. */
62#define OSPF_DD_FLAG_MS 0x01
63#define OSPF_DD_FLAG_M 0x02
64#define OSPF_DD_FLAG_I 0x04
65#define OSPF_DD_FLAG_ALL 0x07
66
718e3744 67#define OSPF_LS_REFRESH_SHIFT (60 * 15)
68#define OSPF_LS_REFRESH_JITTER 60
69
6e6e1020
MS
70/* Default socket buffer size */
71#define OSPF_DEFAULT_SOCK_BUFSIZE (8 * 1024 * 1024)
72
d62a17ae 73struct ospf_external {
d7c0a89a 74 unsigned short instance;
d62a17ae 75 struct route_table *external_info;
7c8ff89e
DS
76};
77
020709f9 78/* OSPF master for system wide configuration and variables. */
d62a17ae 79struct ospf_master {
80 /* OSPF instance. */
81 struct list *ospf;
020709f9 82
d62a17ae 83 /* OSPF thread master. */
cd9d0537 84 struct event_loop *master;
020709f9 85
d62a17ae 86 /* Various OSPF global configuration. */
d7c0a89a 87 uint8_t options;
32ab5cf4 88#define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
020709f9 89};
90
d62a17ae 91struct ospf_redist {
d7c0a89a 92 unsigned short instance;
d62a17ae 93
94 /* Redistribute metric info. */
95 struct {
96 int type; /* External metric type (E1 or E2). */
97 int value; /* Value for static metric (24-bit).
98 -1 means metric value is not set. */
99 } dmetric;
100
101 /* For redistribute route map. */
102 struct {
103 char *name;
104 struct route_map *map;
105 } route_map; /* +1 is for default-information */
7c8ff89e 106#define ROUTEMAP_NAME(R) (R->route_map.name)
6f7bbc0c
MN
107#define ROUTEMAP(R) (R->route_map.map)
108};
109
110/* OSPF area flood reduction info */
111struct ospf_area_fr_info {
112 bool enabled; /* Area support for Flood Reduction */
113 bool configured; /* Flood Reduction configured per area knob */
114 bool state_changed; /* flood reduction state change info */
115 int router_lsas_recv_dc_bit; /* Number of unique router lsas
116 * received with DC bit set.
117 * (excluding self)
118 */
119 bool area_ind_lsa_recvd; /* Indication lsa received in this area */
120 bool area_dc_clear; /* Area has atleast one lsa with dc bit 0(
121 * excluding indication lsa)
122 */
123 struct ospf_lsa *indication_lsa_self; /* Indication LSA generated
124 * in the area.
125 */
7c8ff89e
DS
126};
127
c572fbfe
DL
128/* ospf->config */
129enum {
130 OSPF_RFC1583_COMPATIBLE = (1 << 0),
131 OSPF_OPAQUE_CAPABLE = (1 << 2),
132 OSPF_LOG_ADJACENCY_CHANGES = (1 << 3),
133 OSPF_LOG_ADJACENCY_DETAIL = (1 << 4),
5b5d66c4 134 OSPF_SEND_EXTRA_DATA_TO_ZEBRA = (1 << 5),
c572fbfe
DL
135};
136
385a1e07
G
137/* TI-LFA */
138enum protection_type {
139 OSPF_TI_LFA_UNDEFINED_PROTECTION,
140 OSPF_TI_LFA_LINK_PROTECTION,
141 OSPF_TI_LFA_NODE_PROTECTION,
142};
143
10514170
RW
144/* OSPF nonstop forwarding aka Graceful Restart */
145struct ospf_gr_info {
146 bool restart_support;
147 bool restart_in_progress;
148 bool prepare_in_progress;
149 bool finishing_restart;
150 uint32_t grace_period;
e6685141 151 struct event *t_grace_period;
10514170
RW
152};
153
718e3744 154/* OSPF instance structure. */
d62a17ae 155struct ospf {
156 /* OSPF's running state based on the '[no] router ospf [<instance>]'
157 * config. */
d7c0a89a 158 uint8_t oi_running;
0bad4851 159
d62a17ae 160 /* OSPF instance ID */
d7c0a89a 161 unsigned short instance;
7c8ff89e 162
d62a17ae 163 /* OSPF Router ID. */
164 struct in_addr router_id; /* Configured automatically. */
165 struct in_addr router_id_static; /* Configured manually. */
6021c6c0 166 struct in_addr router_id_zebra;
718e3744 167
996c9314
LB
168 vrf_id_t vrf_id; /* VRF Id */
169 char *name; /* VRF name */
b5a8894d 170
d62a17ae 171 /* ABR/ASBR internal flags. */
d7c0a89a 172 uint8_t flags;
718e3744 173#define OSPF_FLAG_ABR 0x0001
174#define OSPF_FLAG_ASBR 0x0002
175
d62a17ae 176 /* ABR type. */
d7c0a89a 177 uint8_t abr_type;
718e3744 178#define OSPF_ABR_UNKNOWN 0
179#define OSPF_ABR_STAND 1
180#define OSPF_ABR_IBM 2
181#define OSPF_ABR_CISCO 3
182#define OSPF_ABR_SHORTCUT 4
d57834f6 183#define OSPF_ABR_DEFAULT OSPF_ABR_CISCO
718e3744 184
d62a17ae 185 /* NSSA ABR */
d7c0a89a 186 uint8_t anyNSSA; /* Bump for every NSSA attached. */
718e3744 187
c572fbfe 188 /* Configuration bitmask, refer to enum above */
d7c0a89a 189 uint8_t config;
718e3744 190
d62a17ae 191 /* Opaque-LSA administrative flags. */
d7c0a89a 192 uint8_t opaque;
718e3744 193#define OPAQUE_OPERATION_READY_BIT (1 << 0)
718e3744 194
d62a17ae 195 /* RFC3137 stub router. Configured time to stay stub / max-metric */
196 unsigned int stub_router_startup_time; /* seconds */
197 unsigned int stub_router_shutdown_time; /* seconds */
88d6cf37 198#define OSPF_STUB_ROUTER_UNCONFIGURED 0
d7c0a89a 199 uint8_t stub_router_admin_set;
4ba4fc85
AB
200#define OSPF_STUB_ROUTER_ADMINISTRATIVE_SET 1
201#define OSPF_STUB_ROUTER_ADMINISTRATIVE_UNSET 0
88d6cf37 202
b4154c14
JR
203#define OSPF_STUB_MAX_METRIC_SUMMARY_COST 0x00ff0000
204
d62a17ae 205 /* LSA timers */
206 unsigned int min_ls_interval; /* minimum delay between LSAs (in msec) */
207 unsigned int min_ls_arrival; /* minimum interarrival time between LSAs
208 (in msec) */
209
210 /* SPF parameters */
211 unsigned int spf_delay; /* SPF delay time. */
212 unsigned int spf_holdtime; /* SPF hold time. */
213 unsigned int spf_max_holdtime; /* SPF maximum-holdtime */
214 unsigned int
215 spf_hold_multiplier; /* Adaptive multiplier for hold time */
216
217 int default_originate; /* Default information originate. */
718e3744 218#define DEFAULT_ORIGINATE_NONE 0
219#define DEFAULT_ORIGINATE_ZEBRA 1
220#define DEFAULT_ORIGINATE_ALWAYS 2
d7c0a89a 221 uint32_t ref_bandwidth; /* Reference Bandwidth (Kbps). */
d62a17ae 222 struct route_table *networks; /* OSPF config networks. */
223 struct list *vlinks; /* Configured Virtual-Links. */
224 struct list *areas; /* OSPF areas. */
225 struct route_table *nbr_nbma;
226 struct ospf_area *backbone; /* Pointer to the Backbone Area. */
227
228 struct list *oiflist; /* ospf interfaces */
d7c0a89a 229 uint8_t passive_interface_default; /* passive-interface default */
d62a17ae 230
231 /* LSDB of AS-external-LSAs. */
232 struct ospf_lsdb *lsdb;
233
234 /* Flags. */
d62a17ae 235 int ase_calc; /* ASE calculation flag. */
236
237 struct list *opaque_lsa_self; /* Type-11 Opaque-LSAs */
238
239 /* Routing tables. */
240 struct route_table *old_table; /* Old routing table. */
241 struct route_table *new_table; /* Current routing table. */
242
b538baf3
CH
243 struct route_table *oall_rtrs; /* Old router RT. */
244 struct route_table *all_rtrs; /* New routers RT. */
245
d62a17ae 246 struct route_table *old_rtrs; /* Old ABR/ASBR RT. */
247 struct route_table *new_rtrs; /* New ABR/ASBR RT. */
248
249 struct route_table *new_external_route; /* New External Route. */
250 struct route_table *old_external_route; /* Old External Route. */
251
252 struct route_table *external_lsas; /* Database of external LSAs,
253 prefix is LSA's adv. network*/
254
255 /* Time stamps */
256 struct timeval ts_spf; /* SPF calculation time stamp. */
257 struct timeval ts_spf_duration; /* Execution time of last SPF */
258
259 struct route_table *maxage_lsa; /* List of MaxAge LSA for deletion. */
260 int redistribute; /* Num of redistributed protocols. */
261
262 /* Threads. */
e6685141
DS
263 struct event *t_abr_task; /* ABR task timer. */
264 struct event *t_abr_fr; /* ABR FR timer. */
265 struct event *t_asbr_check; /* ASBR check timer. */
266 struct event *t_asbr_nssa_redist_update; /* ASBR NSSA redistribution
1c1c342d 267 update timer. */
e6685141
DS
268 struct event *t_distribute_update; /* Distirbute list update timer. */
269 struct event *t_spf_calc; /* SPF calculation timer. */
270 struct event *t_ase_calc; /* ASE calculation timer. */
271 struct event *t_opaque_lsa_self; /* Type-11 Opaque-LSAs origin event. */
272 struct event *t_sr_update; /* Segment Routing update timer */
d62a17ae 273
274 unsigned int maxage_delay; /* Delay on Maxage remover timer, sec */
e6685141
DS
275 struct event *t_maxage; /* MaxAge LSA remover timer. */
276 struct event *t_maxage_walker; /* MaxAge LSA checking timer. */
d62a17ae 277
e6685141 278 struct event
d62a17ae 279 *t_deferred_shutdown; /* deferred/stub-router shutdown timer*/
280
e6685141 281 struct event *t_write;
e8f45e82 282#define OSPF_WRITE_INTERFACE_COUNT_DEFAULT 20
e6685141 283 struct event *t_default_routemap_timer;
1febb13d 284
d62a17ae 285 int write_oi_count; /* Num of packets sent per thread invocation */
e6685141 286 struct event *t_read;
d62a17ae 287 int fd;
288 struct stream *ibuf;
289 struct list *oi_write_q;
290
291 /* Distribute lists out of other route sources. */
292 struct {
293 char *name;
294 struct access_list *list;
295 } dlist[ZEBRA_ROUTE_MAX];
020709f9 296#define DISTRIBUTE_NAME(O,T) (O)->dlist[T].name
297#define DISTRIBUTE_LIST(O,T) (O)->dlist[T].list
718e3744 298
d62a17ae 299 /* OSPF redistribute configuration */
300 struct list *redist[ZEBRA_ROUTE_MAX + 1];
718e3744 301
d62a17ae 302 /* Redistribute tag info. */
303 route_tag_t
304 dtag[ZEBRA_ROUTE_MAX + 1]; // Pending: cant configure as of now
0d9551dc 305
d62a17ae 306 int default_metric; /* Default metric for redistribute. */
718e3744 307
017714e3
RW
308 /* NSSA default-information-originate */
309 struct {
310 /* # of NSSA areas requesting default information */
311 uint16_t refcnt;
312
313 /*
314 * Whether a default route known through non-OSPF protocol is
315 * present in the RIB.
316 */
317 bool status;
318 } nssa_default_import_check;
319
718e3744 320#define OSPF_LSA_REFRESHER_GRANULARITY 10
d62a17ae 321#define OSPF_LSA_REFRESHER_SLOTS \
322 ((OSPF_LS_REFRESH_TIME + OSPF_LS_REFRESH_SHIFT) \
323 / OSPF_LSA_REFRESHER_GRANULARITY \
324 + 1)
325 struct {
d7c0a89a 326 uint16_t index;
d62a17ae 327 struct list *qs[OSPF_LSA_REFRESHER_SLOTS];
328 } lsa_refresh_queue;
329
e6685141 330 struct event *t_lsa_refresher;
d62a17ae 331 time_t lsa_refresher_started;
718e3744 332#define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
d7c0a89a 333 uint16_t lsa_refresh_interval;
b345a3d9 334 uint16_t lsa_refresh_timer;
d62a17ae 335
336 /* Distance parameter. */
d7c0a89a
QY
337 uint8_t distance_all;
338 uint8_t distance_intra;
339 uint8_t distance_inter;
340 uint8_t distance_external;
d62a17ae 341
342 /* Statistics for LSA origination. */
d7c0a89a 343 uint32_t lsa_originate_count;
d62a17ae 344
345 /* Statistics for LSA used for new instantiation. */
d7c0a89a 346 uint32_t rx_lsa_count;
d62a17ae 347
d62a17ae 348 struct route_table *distance_table;
349
046460a1
CS
350 /* Used during ospf instance going down send LSDB
351 * update to neighbors immediatly */
352 uint8_t inst_shutdown;
353
a92706bb
JU
354 /* Enable or disable sending proactive ARP requests. */
355 bool proactive_arp;
356#define OSPF_PROACTIVE_ARP_DEFAULT true
357
de1ac5fd
CS
358 /* Redistributed external information. */
359 struct list *external[ZEBRA_ROUTE_MAX + 1];
f96f2713 360#define EXTERNAL_INFO(E) (E->external_info)
361
17be83bf 362 /* Graceful restart Helper supported configs*/
f96f2713 363 /* Supported grace interval*/
364 uint32_t supported_grace_time;
365
366 /* Helper support
367 * Supported : True
368 * Not Supported : False.
369 */
370 bool is_helper_supported;
371
372 /* Support for strict LSA check.
373 * if it is set,Helper aborted
374 * upon a TOPO change.
375 */
376 bool strict_lsa_check;
377
378 /* Support as HELPER only for
379 * planned restarts.
380 */
381 bool only_planned_restart;
382
383 /* This list contains the advertisement
384 * routerids which are not support for HELPERs.
385 */
386 struct hash *enable_rtr_list;
387
388 /* HELPER for number of active
389 * RESTARTERs.
390 */
391 uint16_t active_restarter_cnt;
392
393 /* last HELPER exit reason */
394 uint32_t last_exit_reason;
de1ac5fd 395
cb2bc4cb 396 /* delay timer to process external routes
397 * with summary address.
398 */
e6685141 399 struct event *t_external_aggr;
cb2bc4cb 400
401 /* delay interval in seconds */
4b939ad2 402 uint16_t aggr_delay_interval;
cb2bc4cb 403
404 /* Table of configured Aggregate addresses */
405 struct route_table *rt_aggr_tbl;
406
407 /* used as argument for aggr delay
408 * timer thread.
409 */
410 int aggr_action;
411
3d5b9855 412 /* Max number of multiple paths
413 * to support ECMP.
414 */
415 uint16_t max_multipath;
416
132a782e 417 /* MPLS LDP-IGP Sync */
418 struct ldp_sync_info_cmd ldp_sync_cmd;
419
10514170
RW
420 /* OSPF Graceful Restart info */
421 struct ospf_gr_info gr_info;
422
7fd0729f
G
423 /* TI-LFA support for all interfaces. */
424 bool ti_lfa_enabled;
385a1e07 425 enum protection_type ti_lfa_protection_type;
7fd0729f 426
6f7bbc0c
MN
427 /* Flood Reduction configuration state */
428 bool fr_configured;
429
6e6e1020
MS
430 /* Socket buffer sizes */
431 uint32_t recv_sock_bufsize;
432 uint32_t send_sock_bufsize;
433
04a0401f
MS
434 /* Per-interface write socket */
435 bool intf_socket_enabled;
436
96244aca 437 QOBJ_FIELDS;
718e3744 438};
96244aca 439DECLARE_QOBJ_TYPE(ospf);
718e3744 440
bdcfd34a
G
441enum ospf_ti_lfa_p_q_space_adjacency {
442 OSPF_TI_LFA_P_Q_SPACE_ADJACENT,
443 OSPF_TI_LFA_P_Q_SPACE_NON_ADJACENT,
444};
445
7fd0729f
G
446enum ospf_ti_lfa_node_type {
447 OSPF_TI_LFA_UNDEFINED_NODE,
448 OSPF_TI_LFA_PQ_NODE,
449 OSPF_TI_LFA_P_NODE,
450 OSPF_TI_LFA_Q_NODE,
451};
452
453struct ospf_ti_lfa_node_info {
454 struct vertex *node;
455 enum ospf_ti_lfa_node_type type;
456 struct in_addr nexthop;
457};
458
bdcfd34a
G
459struct ospf_ti_lfa_inner_backup_path_info {
460 struct ospf_ti_lfa_node_info p_node_info;
461 struct ospf_ti_lfa_node_info q_node_info;
462 struct mpls_label_stack *label_stack;
463};
464
385a1e07
G
465struct protected_resource {
466 enum protection_type type;
467
468 /* Link Protection */
469 struct router_lsa_link *link;
470
471 /* Node Protection */
472 struct in_addr router_id;
473};
474
960b9a53 475PREDECL_RBTREE_UNIQ(q_spaces);
7fd0729f
G
476struct q_space {
477 struct vertex *root;
478 struct list *vertex_list;
479 struct mpls_label_stack *label_stack;
480 struct in_addr nexthop;
9d3444f8 481 struct list *pc_path;
bdcfd34a
G
482 struct ospf_ti_lfa_node_info *p_node_info;
483 struct ospf_ti_lfa_node_info *q_node_info;
7fd0729f
G
484 struct q_spaces_item q_spaces_item;
485};
486
960b9a53 487PREDECL_RBTREE_UNIQ(p_spaces);
7fd0729f
G
488struct p_space {
489 struct vertex *root;
385a1e07 490 struct protected_resource *protected_resource;
7fd0729f
G
491 struct q_spaces_head *q_spaces;
492 struct list *vertex_list;
493 struct vertex *pc_spf;
494 struct list *pc_vertex_list;
495 struct p_spaces_item p_spaces_item;
496};
497
718e3744 498/* OSPF area structure. */
d62a17ae 499struct ospf_area {
500 /* OSPF instance. */
501 struct ospf *ospf;
718e3744 502
d62a17ae 503 /* Zebra interface list belonging to the area. */
504 struct list *oiflist;
718e3744 505
d62a17ae 506 /* Area ID. */
507 struct in_addr area_id;
718e3744 508
d62a17ae 509 /* Area ID format. */
510 int area_id_fmt;
86573dcb
QY
511#define OSPF_AREA_ID_FMT_DOTTEDQUAD 1
512#define OSPF_AREA_ID_FMT_DECIMAL 2
718e3744 513
d62a17ae 514 /* Address range. */
515 struct list *address_range;
718e3744 516
d62a17ae 517 /* Configured variables. */
518 int external_routing; /* ExternalRoutingCapability. */
519 int no_summary; /* Don't inject summaries into stub.*/
520 int shortcut_configured; /* Area configured as shortcut. */
718e3744 521#define OSPF_SHORTCUT_DEFAULT 0
522#define OSPF_SHORTCUT_ENABLE 1
523#define OSPF_SHORTCUT_DISABLE 2
d62a17ae 524 int shortcut_capability; /* Other ABRs agree on S-bit */
d7c0a89a 525 uint32_t default_cost; /* StubDefaultCost. */
d62a17ae 526 int auth_type; /* Authentication type. */
c317eddb 527 int suppress_fa; /* Suppress forwarding address in NSSA ABR */
d62a17ae 528
d7c0a89a 529 uint8_t NSSATranslatorRole; /* NSSA configured role */
718e3744 530#define OSPF_NSSA_ROLE_NEVER 0
d4a53d58 531#define OSPF_NSSA_ROLE_CANDIDATE 1
532#define OSPF_NSSA_ROLE_ALWAYS 2
d7c0a89a 533 uint8_t NSSATranslatorState; /* NSSA operational role */
d4a53d58 534#define OSPF_NSSA_TRANSLATE_DISABLED 0
535#define OSPF_NSSA_TRANSLATE_ENABLED 1
d62a17ae 536 int NSSATranslatorStabilityInterval;
537
d7c0a89a 538 uint8_t transit; /* TransitCapability. */
718e3744 539#define OSPF_TRANSIT_FALSE 0
540#define OSPF_TRANSIT_TRUE 1
d62a17ae 541 struct route_table *ranges; /* Configured Area Ranges. */
f07ff222 542 struct route_table *nssa_ranges; /* Configured NSSA Area Ranges. */
d62a17ae 543
544 /* RFC3137 stub router state flags for area */
d7c0a89a 545 uint8_t stub_router_state;
88d6cf37 546#define OSPF_AREA_ADMIN_STUB_ROUTED (1 << 0) /* admin stub-router set */
547#define OSPF_AREA_IS_STUB_ROUTED (1 << 1) /* stub-router active */
548#define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */
d62a17ae 549 /* Area related LSDBs[Type1-4]. */
550 struct ospf_lsdb *lsdb;
551
552 /* Self-originated LSAs. */
553 struct ospf_lsa *router_lsa_self;
554 struct list *opaque_lsa_self; /* Type-10 Opaque-LSAs */
555
556 /* Area announce list. */
557 struct {
558 char *name;
559 struct access_list *list;
560 } _export;
dea04441
PJ
561#define EXPORT_NAME(A) (A)->_export.name
562#define EXPORT_LIST(A) (A)->_export.list
718e3744 563
d62a17ae 564 /* Area acceptance list. */
565 struct {
566 char *name;
567 struct access_list *list;
568 } import;
718e3744 569#define IMPORT_NAME(A) (A)->import.name
570#define IMPORT_LIST(A) (A)->import.list
571
d62a17ae 572 /* Type 3 LSA Area prefix-list. */
573 struct {
574 char *name;
575 struct prefix_list *list;
576 } plist_in;
718e3744 577#define PREFIX_LIST_IN(A) (A)->plist_in.list
578#define PREFIX_NAME_IN(A) (A)->plist_in.name
579
d62a17ae 580 struct {
581 char *name;
582 struct prefix_list *list;
583 } plist_out;
718e3744 584#define PREFIX_LIST_OUT(A) (A)->plist_out.list
585#define PREFIX_NAME_OUT(A) (A)->plist_out.name
586
017714e3
RW
587 /* NSSA default-information-originate */
588 struct {
589 bool enabled;
590 int metric_type;
591 int metric_value;
592 } nssa_default_originate;
593
d62a17ae 594 /* Shortest Path Tree. */
595 struct vertex *spf;
81443a28
G
596 struct list *spf_vertex_list;
597
6fc9528e
G
598 bool spf_dry_run; /* flag for checking if the SPF calculation is
599 intended for the local RIB */
600 bool spf_root_node; /* flag for checking if the calculating node is the
601 root node of the SPF tree */
718e3744 602
7fd0729f 603 /* TI-LFA protected link for SPF calculations */
385a1e07 604 struct protected_resource *spf_protected_resource;
7fd0729f
G
605
606 /* P/Q spaces for TI-LFA */
607 struct p_spaces_head *p_spaces;
608
d62a17ae 609 /* Threads. */
e6685141
DS
610 struct event *t_stub_router; /* Stub-router timer */
611 struct event *t_opaque_lsa_self; /* Type-10 Opaque-LSAs origin. */
718e3744 612
d62a17ae 613 /* Statistics field. */
d7c0a89a 614 uint32_t spf_calculation; /* SPF Calculation Count. */
718e3744 615
133e59cf
G
616 /* reverse SPF (used for TI-LFA Q spaces) */
617 bool spf_reversed;
618
d62a17ae 619 /* Time stamps. */
620 struct timeval ts_spf; /* SPF calculation time stamp. */
cf744958 621
d62a17ae 622 /* Router count. */
d7c0a89a
QY
623 uint32_t abr_count; /* ABR router in this area. */
624 uint32_t asbr_count; /* ASBR router in this area. */
718e3744 625
d62a17ae 626 /* Counters. */
d7c0a89a
QY
627 uint32_t act_ints; /* Active interfaces. */
628 uint32_t full_nbrs; /* Fully adjacent neighbors. */
629 uint32_t full_vls; /* Fully adjacent virtual neighbors. */
6f7bbc0c
MN
630
631 struct ospf_area_fr_info fr_info; /* Flood reduction info. */
718e3744 632};
633
634/* OSPF config network structure. */
d62a17ae 635struct ospf_network {
636 /* Area ID. */
637 struct in_addr area_id;
638 int area_id_fmt;
718e3744 639};
640
641/* OSPF NBMA neighbor structure. */
d62a17ae 642struct ospf_nbr_nbma {
643 /* Neighbor IP address. */
644 struct in_addr addr;
718e3744 645
d62a17ae 646 /* OSPF interface. */
647 struct ospf_interface *oi;
718e3744 648
d62a17ae 649 /* OSPF neighbor structure. */
650 struct ospf_neighbor *nbr;
718e3744 651
d62a17ae 652 /* Neighbor priority. */
d7c0a89a 653 uint8_t priority;
718e3744 654
d62a17ae 655 /* Poll timer value. */
d7c0a89a 656 uint32_t v_poll;
718e3744 657
d62a17ae 658 /* Poll timer thread. */
e6685141 659 struct event *t_poll;
718e3744 660
d62a17ae 661 /* State change. */
d7c0a89a 662 uint32_t state_change;
718e3744 663};
664
665/* Macro. */
d62a17ae 666#define OSPF_AREA_SAME(X, Y) \
667 (memcmp((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
718e3744 668
020709f9 669#define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR)
670#define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR)
718e3744 671
672#define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
673#define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
674
675#ifdef roundup
676# define ROUNDUP(val, gran) roundup(val, gran)
d62a17ae 677#else /* roundup */
718e3744 678# define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1)
679#endif /* roundup */
680
d62a17ae 681#define LSA_OPTIONS_GET(area) \
682 (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
683#define LSA_OPTIONS_NSSA_GET(area) \
684 (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0)
718e3744 685
907a2395
DS
686#define OSPF_TIMER_ON(T, F, V) event_add_timer(master, (F), ospf, (V), &(T))
687#define OSPF_AREA_TIMER_ON(T, F, V) \
688 event_add_timer(master, (F), area, (V), &(T))
689#define OSPF_POLL_TIMER_ON(T, F, V) \
690 event_add_timer(master, (F), nbr_nbma, (V), &(T))
718e3744 691
020709f9 692/* Extern variables. */
693extern struct ospf_master *om;
409f98ab 694extern unsigned short ospf_instance;
7ba82f70 695extern const int ospf_redistributed_proto_max;
718e3744 696extern struct zclient *zclient;
cd9d0537 697extern struct event_loop *master;
718e3744 698extern int ospf_zlog;
e5c25022 699extern struct zebra_privs_t ospfd_privs;
718e3744 700
701/* Prototypes. */
d7c0a89a 702extern const char *ospf_redist_string(unsigned int route_type);
2d4093ee 703extern struct ospf *ospf_lookup_instance(unsigned short instance);
409f98ab 704extern struct ospf *ospf_lookup(unsigned short instance, const char *name);
c572fbfe
DL
705extern struct ospf *ospf_get(unsigned short instance, const char *name,
706 bool *created);
7fd0729f 707extern struct ospf *ospf_new_alloc(unsigned short instance, const char *name);
d7c0a89a 708extern struct ospf *ospf_lookup_by_inst_name(unsigned short instance,
b5a8894d
CS
709 const char *name);
710extern struct ospf *ospf_lookup_by_vrf_id(vrf_id_t vrf_id);
cbf32f74 711extern uint32_t ospf_count_area_params(struct ospf *ospf);
2d4093ee 712extern void ospf_finish(struct ospf *ospf);
f91ce319 713extern void ospf_process_refresh_data(struct ospf *ospf, bool reset);
d62a17ae 714extern void ospf_router_id_update(struct ospf *ospf);
f91ce319
MR
715extern void ospf_process_reset(struct ospf *ospf);
716extern void ospf_neighbor_reset(struct ospf *ospf, struct in_addr nbr_id,
717 const char *nbr_str);
2d4093ee
DS
718extern int ospf_network_set(struct ospf *ospf, struct prefix_ipv4 *p,
719 struct in_addr area_id, int df);
720extern int ospf_network_unset(struct ospf *ospf, struct prefix_ipv4 *p,
721 struct in_addr aread_id);
722extern int ospf_area_display_format_set(struct ospf *ospf,
723 struct ospf_area *area, int df);
724extern int ospf_area_stub_set(struct ospf *ospf, struct in_addr area_id);
725extern int ospf_area_stub_unset(struct ospf *ospf, struct in_addr area_id);
726extern int ospf_area_no_summary_set(struct ospf *ospf, struct in_addr area_id);
727extern int ospf_area_no_summary_unset(struct ospf *ospf,
728 struct in_addr area_id);
729extern int ospf_area_nssa_set(struct ospf *ospf, struct in_addr area_id);
e85194f5 730extern int ospf_area_nssa_unset(struct ospf *ospf, struct in_addr area_id);
c317eddb 731extern int ospf_area_nssa_suppress_fa_set(struct ospf *ospf,
732 struct in_addr area_id);
733extern int ospf_area_nssa_suppress_fa_unset(struct ospf *ospf,
734 struct in_addr area_id);
2d4093ee
DS
735extern int ospf_area_nssa_translator_role_set(struct ospf *ospf,
736 struct in_addr area_id, int role);
017714e3
RW
737extern void ospf_area_nssa_default_originate_set(struct ospf *ospf,
738 struct in_addr area_id,
739 int metric, int metric_type);
740extern void ospf_area_nssa_default_originate_unset(struct ospf *ospf,
741 struct in_addr area_id);
2d4093ee
DS
742extern int ospf_area_export_list_set(struct ospf *ospf,
743 struct ospf_area *area_id,
744 const char *list_name);
745extern int ospf_area_export_list_unset(struct ospf *ospf,
746 struct ospf_area *area_id);
747extern int ospf_area_import_list_set(struct ospf *ospf,
748 struct ospf_area *area_id,
749 const char *name);
750extern int ospf_area_import_list_unset(struct ospf *ospf,
751 struct ospf_area *area_id);
752extern int ospf_area_shortcut_set(struct ospf *ospf, struct ospf_area *area_id,
753 int mode);
754extern int ospf_area_shortcut_unset(struct ospf *ospf,
755 struct ospf_area *area_id);
756extern int ospf_timers_refresh_set(struct ospf *ospf, int interval);
757extern int ospf_timers_refresh_unset(struct ospf *ospf);
f91ce319 758void ospf_area_lsdb_discard_delete(struct ospf_area *area);
2d4093ee
DS
759extern int ospf_nbr_nbma_set(struct ospf *ospf, struct in_addr nbr_addr);
760extern int ospf_nbr_nbma_unset(struct ospf *ospf, struct in_addr nbr_addr);
761extern int ospf_nbr_nbma_priority_set(struct ospf *ospf,
762 struct in_addr nbr_addr,
763 uint8_t priority);
764extern int ospf_nbr_nbma_priority_unset(struct ospf *ospf,
765 struct in_addr nbr_addr);
766extern int ospf_nbr_nbma_poll_interval_set(struct ospf *ospf,
767 struct in_addr nbr_addr,
768 unsigned int interval);
769extern int ospf_nbr_nbma_poll_interval_unset(struct ospf *ospf,
770 struct in_addr addr);
771extern void ospf_if_update(struct ospf *ospf, struct interface *ifp);
772extern void ospf_ls_upd_queue_empty(struct ospf_interface *oi);
d62a17ae 773extern void ospf_terminate(void);
2d4093ee
DS
774extern void ospf_nbr_nbma_if_update(struct ospf *ospf,
775 struct ospf_interface *oi);
776extern struct ospf_nbr_nbma *ospf_nbr_nbma_lookup(struct ospf *ospf,
777 struct in_addr nbr_addr);
778extern int ospf_oi_count(struct interface *ifp);
d62a17ae 779
7fd0729f
G
780extern struct ospf_area *ospf_area_new(struct ospf *ospf,
781 struct in_addr area_id);
2d4093ee
DS
782extern struct ospf_area *ospf_area_get(struct ospf *ospf,
783 struct in_addr area_id);
784extern void ospf_area_check_free(struct ospf *ospf, struct in_addr area_id);
785extern struct ospf_area *ospf_area_lookup_by_area_id(struct ospf *ospf,
786 struct in_addr area_id);
787extern void ospf_area_add_if(struct ospf_area *oa, struct ospf_interface *oi);
788extern void ospf_area_del_if(struct ospf_area *oa, struct ospf_interface *oi);
d62a17ae 789
2d4093ee
DS
790extern void ospf_interface_area_set(struct ospf *ospf, struct interface *ifp);
791extern void ospf_interface_area_unset(struct ospf *ospf, struct interface *ifp);
d62a17ae 792
793extern void ospf_route_map_init(void);
794
cd9d0537 795extern void ospf_master_init(struct event_loop *master);
b5a8894d
CS
796extern void ospf_vrf_init(void);
797extern void ospf_vrf_terminate(void);
798extern void ospf_vrf_link(struct ospf *ospf, struct vrf *vrf);
799extern void ospf_vrf_unlink(struct ospf *ospf, struct vrf *vrf);
800const char *ospf_vrf_id_to_name(vrf_id_t vrf_id);
2d4093ee 801int ospf_area_nssa_no_summary_set(struct ospf *ospf, struct in_addr area_id);
7ef56a73 802
88b6b28e 803const char *ospf_get_name(const struct ospf *ospf);
7fd0729f
G
804extern struct ospf_interface *add_ospf_interface(struct connected *co,
805 struct ospf_area *area);
6e6e1020
MS
806/* Update socket bufsize(s), after config change */
807void ospf_update_bufsize(struct ospf *ospf, uint32_t recvsize,
808 uint32_t sendsize);
7fd0729f
G
809
810extern int p_spaces_compare_func(const struct p_space *a,
811 const struct p_space *b);
812extern int q_spaces_compare_func(const struct q_space *a,
813 const struct q_space *b);
a623b526 814
718e3744 815#endif /* _ZEBRA_OSPFD_H */