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