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