3 * Copyright (C) 1998, 99, 2000 Kunihiro Ishiguro, Toshiaki Takada
5 * This file is part of GNU Zebra.
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
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.
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
22 #ifndef _ZEBRA_OSPFD_H
23 #define _ZEBRA_OSPFD_H
33 #include "ospf_memory.h"
34 #include "ospf_dump_api.h"
36 #define OSPF_VERSION 2
38 /* VTY port number. */
39 #define OSPF_VTY_PORT 2604
41 /* IP TTL for OSPF protocol. */
43 #define OSPF_VL_IP_TTL 100
45 /* Default configuration file name for ospfd. */
46 #define OSPF_DEFAULT_CONFIG "ospfd.conf"
48 #define OSPF_NSSA_TRANS_STABLE_DEFAULT 40
50 #define OSPF_ALLSPFROUTERS 0xe0000005 /* 224.0.0.5 */
51 #define OSPF_ALLDROUTERS 0xe0000006 /* 224.0.0.6 */
53 /* OSPF Authentication Type. */
54 #define OSPF_AUTH_NULL 0
55 #define OSPF_AUTH_SIMPLE 1
56 #define OSPF_AUTH_CRYPTOGRAPHIC 2
57 /* For Interface authentication setting default */
58 #define OSPF_AUTH_NOTSET -1
59 /* For the consumption and sanity of the command handler */
60 /* DO NIOT REMOVE!!! Need to detect whether a value has
61 been given or not in VLink command handlers */
62 #define OSPF_AUTH_CMD_NOTSEEN -2
65 #define OSPF_OPTION_MT 0x01 /* M/T */
66 #define OSPF_OPTION_E 0x02
67 #define OSPF_OPTION_MC 0x04
68 #define OSPF_OPTION_NP 0x08
69 #define OSPF_OPTION_EA 0x10
70 #define OSPF_OPTION_DC 0x20
71 #define OSPF_OPTION_O 0x40
72 #define OSPF_OPTION_DN 0x80
74 /* OSPF Database Description flags. */
75 #define OSPF_DD_FLAG_MS 0x01
76 #define OSPF_DD_FLAG_M 0x02
77 #define OSPF_DD_FLAG_I 0x04
78 #define OSPF_DD_FLAG_ALL 0x07
80 #define OSPF_LS_REFRESH_SHIFT (60 * 15)
81 #define OSPF_LS_REFRESH_JITTER 60
83 struct ospf_external
{
85 struct route_table
*external_info
;
88 /* OSPF master for system wide configuration and variables. */
93 /* OSPF thread master. */
94 struct thread_master
*master
;
97 /* Redistributed external information. */
98 struct list
*external
[ZEBRA_ROUTE_MAX
+ 1];
99 #define EXTERNAL_INFO(E) (E->external_info)
101 /* Various OSPF global configuration. */
103 #define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
109 /* Redistribute metric info. */
111 int type
; /* External metric type (E1 or E2). */
112 int value
; /* Value for static metric (24-bit).
113 -1 means metric value is not set. */
116 /* For redistribute route map. */
119 struct route_map
*map
;
120 } route_map
; /* +1 is for default-information */
121 #define ROUTEMAP_NAME(R) (R->route_map.name)
122 #define ROUTEMAP(R) (R->route_map.map)
125 /* OSPF instance structure. */
127 /* OSPF's running state based on the '[no] router ospf [<instance>]'
131 /* OSPF instance ID */
134 /* OSPF Router ID. */
135 struct in_addr router_id
; /* Configured automatically. */
136 struct in_addr router_id_static
; /* Configured manually. */
137 struct in_addr router_id_zebra
;
139 vrf_id_t vrf_id
; /* VRF Id */
140 char *name
; /* VRF name */
142 /* ABR/ASBR internal flags. */
144 #define OSPF_FLAG_ABR 0x0001
145 #define OSPF_FLAG_ASBR 0x0002
149 #define OSPF_ABR_UNKNOWN 0
150 #define OSPF_ABR_STAND 1
151 #define OSPF_ABR_IBM 2
152 #define OSPF_ABR_CISCO 3
153 #define OSPF_ABR_SHORTCUT 4
154 #define OSPF_ABR_DEFAULT OSPF_ABR_CISCO
157 u_char anyNSSA
; /* Bump for every NSSA attached. */
159 /* Configured variables. */
161 #define OSPF_RFC1583_COMPATIBLE (1 << 0)
162 #define OSPF_OPAQUE_CAPABLE (1 << 2)
163 #define OSPF_LOG_ADJACENCY_CHANGES (1 << 3)
164 #define OSPF_LOG_ADJACENCY_DETAIL (1 << 4)
166 /* Opaque-LSA administrative flags. */
168 #define OPAQUE_OPERATION_READY_BIT (1 << 0)
170 /* RFC3137 stub router. Configured time to stay stub / max-metric */
171 unsigned int stub_router_startup_time
; /* seconds */
172 unsigned int stub_router_shutdown_time
; /* seconds */
174 /* clang-format off */
175 #define OSPF_STUB_ROUTER_UNCONFIGURED 0
176 u_char stub_router_admin_set
;
177 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_SET 1
178 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_UNSET 0
180 #define OSPF_STUB_MAX_METRIC_SUMMARY_COST 0x00ff0000
183 unsigned int min_ls_interval
; /* minimum delay between LSAs (in msec) */
184 unsigned int min_ls_arrival
; /* minimum interarrival time between LSAs
188 unsigned int spf_delay
; /* SPF delay time. */
189 unsigned int spf_holdtime
; /* SPF hold time. */
190 unsigned int spf_max_holdtime
; /* SPF maximum-holdtime */
192 spf_hold_multiplier
; /* Adaptive multiplier for hold time */
194 int default_originate
; /* Default information originate. */
196 /* clang-format off */
197 #define DEFAULT_ORIGINATE_NONE 0
198 #define DEFAULT_ORIGINATE_ZEBRA 1
199 #define DEFAULT_ORIGINATE_ALWAYS 2
200 u_int32_t ref_bandwidth
; /* Reference Bandwidth (Kbps). */
201 struct route_table
*networks
; /* OSPF config networks. */
202 struct list
*vlinks
; /* Configured Virtual-Links. */
203 struct list
*areas
; /* OSPF areas. */
204 struct route_table
*nbr_nbma
;
205 struct ospf_area
*backbone
; /* Pointer to the Backbone Area. */
207 struct list
*oiflist
; /* ospf interfaces */
208 u_char passive_interface_default
; /* passive-interface default */
210 /* LSDB of AS-external-LSAs. */
211 struct ospf_lsdb
*lsdb
;
214 int external_origin
; /* AS-external-LSA origin flag. */
215 int ase_calc
; /* ASE calculation flag. */
217 struct list
*opaque_lsa_self
; /* Type-11 Opaque-LSAs */
219 /* Routing tables. */
220 struct route_table
*old_table
; /* Old routing table. */
221 struct route_table
*new_table
; /* Current routing table. */
223 struct route_table
*old_rtrs
; /* Old ABR/ASBR RT. */
224 struct route_table
*new_rtrs
; /* New ABR/ASBR RT. */
226 struct route_table
*new_external_route
; /* New External Route. */
227 struct route_table
*old_external_route
; /* Old External Route. */
229 struct route_table
*external_lsas
; /* Database of external LSAs,
230 prefix is LSA's adv. network*/
233 struct timeval ts_spf
; /* SPF calculation time stamp. */
234 struct timeval ts_spf_duration
; /* Execution time of last SPF */
236 struct route_table
*maxage_lsa
; /* List of MaxAge LSA for deletion. */
237 int redistribute
; /* Num of redistributed protocols. */
240 struct thread
*t_abr_task
; /* ABR task timer. */
241 struct thread
*t_asbr_check
; /* ASBR check timer. */
242 struct thread
*t_distribute_update
; /* Distirbute list update timer. */
243 struct thread
*t_spf_calc
; /* SPF calculation timer. */
244 struct thread
*t_ase_calc
; /* ASE calculation timer. */
245 struct thread
*t_external_lsa
; /* AS-external-LSA origin timer. */
247 *t_opaque_lsa_self
; /* Type-11 Opaque-LSAs origin event. */
249 unsigned int maxage_delay
; /* Delay on Maxage remover timer, sec */
250 struct thread
*t_maxage
; /* MaxAge LSA remover timer. */
251 struct thread
*t_maxage_walker
; /* MaxAge LSA checking timer. */
254 *t_deferred_shutdown
; /* deferred/stub-router shutdown timer*/
256 struct thread
*t_write
;
257 #define OSPF_WRITE_INTERFACE_COUNT_DEFAULT 20
258 int write_oi_count
; /* Num of packets sent per thread invocation */
259 struct thread
*t_read
;
262 struct list
*oi_write_q
;
264 /* Distribute lists out of other route sources. */
267 struct access_list
*list
;
268 } dlist
[ZEBRA_ROUTE_MAX
];
269 #define DISTRIBUTE_NAME(O,T) (O)->dlist[T].name
270 #define DISTRIBUTE_LIST(O,T) (O)->dlist[T].list
272 /* OSPF redistribute configuration */
273 struct list
*redist
[ZEBRA_ROUTE_MAX
+ 1];
275 /* Redistribute tag info. */
277 dtag
[ZEBRA_ROUTE_MAX
+ 1]; // Pending: cant configure as of now
279 int default_metric
; /* Default metric for redistribute. */
281 #define OSPF_LSA_REFRESHER_GRANULARITY 10
282 #define OSPF_LSA_REFRESHER_SLOTS \
283 ((OSPF_LS_REFRESH_TIME + OSPF_LS_REFRESH_SHIFT) \
284 / OSPF_LSA_REFRESHER_GRANULARITY \
288 struct list
*qs
[OSPF_LSA_REFRESHER_SLOTS
];
291 struct thread
*t_lsa_refresher
;
292 time_t lsa_refresher_started
;
293 #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
294 u_int16_t lsa_refresh_interval
;
296 /* Distance parameter. */
298 u_char distance_intra
;
299 u_char distance_inter
;
300 u_char distance_external
;
302 /* Statistics for LSA origination. */
303 u_int32_t lsa_originate_count
;
305 /* Statistics for LSA used for new instantiation. */
306 u_int32_t rx_lsa_count
;
308 /* Counter of "ip ospf area x.x.x.x" */
309 u_int32_t if_ospf_cli_count
;
311 struct route_table
*distance_table
;
313 /* Used during ospf instance going down send LSDB
314 * update to neighbors immediatly */
315 uint8_t inst_shutdown
;
319 DECLARE_QOBJ_TYPE(ospf
)
321 /* OSPF area structure. */
326 /* Zebra interface list belonging to the area. */
327 struct list
*oiflist
;
330 struct in_addr area_id
;
332 /* Area ID format. */
334 #define OSPF_AREA_ID_FMT_DOTTEDQUAD 1
335 #define OSPF_AREA_ID_FMT_DECIMAL 2
338 struct list
*address_range
;
340 /* Configured variables. */
341 int external_routing
; /* ExternalRoutingCapability. */
342 int no_summary
; /* Don't inject summaries into stub.*/
343 int shortcut_configured
; /* Area configured as shortcut. */
345 /* clang-format off */
346 #define OSPF_SHORTCUT_DEFAULT 0
347 #define OSPF_SHORTCUT_ENABLE 1
348 #define OSPF_SHORTCUT_DISABLE 2
349 int shortcut_capability
; /* Other ABRs agree on S-bit */
350 u_int32_t default_cost
; /* StubDefaultCost. */
351 int auth_type
; /* Authentication type. */
354 u_char NSSATranslatorRole
; /* NSSA configured role */
356 /* clang-format off */
357 #define OSPF_NSSA_ROLE_NEVER 0
358 #define OSPF_NSSA_ROLE_CANDIDATE 1
359 #define OSPF_NSSA_ROLE_ALWAYS 2
360 u_char NSSATranslatorState
; /* NSSA operational role */
362 /* clang-format off */
363 #define OSPF_NSSA_TRANSLATE_DISABLED 0
364 #define OSPF_NSSA_TRANSLATE_ENABLED 1
365 int NSSATranslatorStabilityInterval
;
367 u_char transit
; /* TransitCapability. */
369 /* clang-format off */
370 #define OSPF_TRANSIT_FALSE 0
371 #define OSPF_TRANSIT_TRUE 1
372 struct route_table
*ranges
; /* Configured Area Ranges. */
374 /* RFC3137 stub router state flags for area */
375 u_char stub_router_state
;
376 #define OSPF_AREA_ADMIN_STUB_ROUTED (1 << 0) /* admin stub-router set */
377 #define OSPF_AREA_IS_STUB_ROUTED (1 << 1) /* stub-router active */
378 #define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */
379 /* Area related LSDBs[Type1-4]. */
380 struct ospf_lsdb
*lsdb
;
382 /* Self-originated LSAs. */
383 struct ospf_lsa
*router_lsa_self
;
384 struct list
*opaque_lsa_self
; /* Type-10 Opaque-LSAs */
386 /* Area announce list. */
389 struct access_list
*list
;
391 #define EXPORT_NAME(A) (A)->_export.name
392 #define EXPORT_LIST(A) (A)->_export.list
394 /* Area acceptance list. */
397 struct access_list
*list
;
399 #define IMPORT_NAME(A) (A)->import.name
400 #define IMPORT_LIST(A) (A)->import.list
402 /* Type 3 LSA Area prefix-list. */
405 struct prefix_list
*list
;
407 #define PREFIX_LIST_IN(A) (A)->plist_in.list
408 #define PREFIX_NAME_IN(A) (A)->plist_in.name
412 struct prefix_list
*list
;
414 #define PREFIX_LIST_OUT(A) (A)->plist_out.list
415 #define PREFIX_NAME_OUT(A) (A)->plist_out.name
417 /* Shortest Path Tree. */
421 struct thread
*t_stub_router
; /* Stub-router timer */
422 struct thread
*t_opaque_lsa_self
; /* Type-10 Opaque-LSAs origin. */
424 /* Statistics field. */
425 u_int32_t spf_calculation
; /* SPF Calculation Count. */
428 struct timeval ts_spf
; /* SPF calculation time stamp. */
431 u_int32_t abr_count
; /* ABR router in this area. */
432 u_int32_t asbr_count
; /* ASBR router in this area. */
435 u_int32_t act_ints
; /* Active interfaces. */
436 u_int32_t full_nbrs
; /* Fully adjacent neighbors. */
437 u_int32_t full_vls
; /* Fully adjacent virtual neighbors. */
440 /* OSPF config network structure. */
441 struct ospf_network
{
443 struct in_addr area_id
;
447 /* OSPF NBMA neighbor structure. */
448 struct ospf_nbr_nbma
{
449 /* Neighbor IP address. */
452 /* OSPF interface. */
453 struct ospf_interface
*oi
;
455 /* OSPF neighbor structure. */
456 struct ospf_neighbor
*nbr
;
458 /* Neighbor priority. */
461 /* Poll timer value. */
464 /* Poll timer thread. */
465 struct thread
*t_poll
;
468 u_int32_t state_change
;
472 #define OSPF_AREA_SAME(X, Y) \
473 (memcmp((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
475 #define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR)
476 #define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR)
478 #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
479 #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
482 # define ROUNDUP(val, gran) roundup(val, gran)
484 # define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1)
487 #define LSA_OPTIONS_GET(area) \
488 (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
489 #define LSA_OPTIONS_NSSA_GET(area) \
490 (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0)
492 #define OSPF_TIMER_ON(T,F,V) thread_add_timer (master,(F),ospf,(V),&(T))
493 #define OSPF_AREA_TIMER_ON(T,F,V) thread_add_timer (master, (F), area, (V), &(T))
494 #define OSPF_POLL_TIMER_ON(T,F,V) thread_add_timer (master, (F), nbr_nbma, (V), &(T))
495 #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X))
496 #define OSPF_TIMER_OFF(X) \
504 /* Extern variables. */
505 extern struct ospf_master
*om
;
506 extern const int ospf_redistributed_proto_max
;
507 extern struct zclient
*zclient
;
508 extern struct thread_master
*master
;
509 extern int ospf_zlog
;
510 extern struct zebra_privs_t ospfd_privs
;
513 extern const char *ospf_redist_string(u_int route_type
);
514 extern struct ospf
*ospf_lookup_instance(u_short
);
515 extern struct ospf
*ospf_get(u_short instance
, const char *name
);
516 extern struct ospf
*ospf_get_instance(u_short
);
517 extern struct ospf
*ospf_lookup_by_inst_name(u_short instance
,
519 extern struct ospf
*ospf_lookup_by_vrf_id(vrf_id_t vrf_id
);
520 extern void ospf_finish(struct ospf
*);
521 extern void ospf_router_id_update(struct ospf
*ospf
);
522 extern int ospf_network_set(struct ospf
*, struct prefix_ipv4
*, struct in_addr
,
524 extern int ospf_network_unset(struct ospf
*, struct prefix_ipv4
*,
526 extern int ospf_area_display_format_set(struct ospf
*, struct ospf_area
*area
,
528 extern int ospf_area_stub_set(struct ospf
*, struct in_addr
);
529 extern int ospf_area_stub_unset(struct ospf
*, struct in_addr
);
530 extern int ospf_area_no_summary_set(struct ospf
*, struct in_addr
);
531 extern int ospf_area_no_summary_unset(struct ospf
*, struct in_addr
);
532 extern int ospf_area_nssa_set(struct ospf
*, struct in_addr
);
533 extern int ospf_area_nssa_unset(struct ospf
*, struct in_addr
, int);
534 extern int ospf_area_nssa_translator_role_set(struct ospf
*, struct in_addr
,
536 extern int ospf_area_export_list_set(struct ospf
*, struct ospf_area
*,
538 extern int ospf_area_export_list_unset(struct ospf
*, struct ospf_area
*);
539 extern int ospf_area_import_list_set(struct ospf
*, struct ospf_area
*,
541 extern int ospf_area_import_list_unset(struct ospf
*, struct ospf_area
*);
542 extern int ospf_area_shortcut_set(struct ospf
*, struct ospf_area
*, int);
543 extern int ospf_area_shortcut_unset(struct ospf
*, struct ospf_area
*);
544 extern int ospf_timers_refresh_set(struct ospf
*, int);
545 extern int ospf_timers_refresh_unset(struct ospf
*);
546 extern int ospf_nbr_nbma_set(struct ospf
*, struct in_addr
);
547 extern int ospf_nbr_nbma_unset(struct ospf
*, struct in_addr
);
548 extern int ospf_nbr_nbma_priority_set(struct ospf
*, struct in_addr
, u_char
);
549 extern int ospf_nbr_nbma_priority_unset(struct ospf
*, struct in_addr
);
550 extern int ospf_nbr_nbma_poll_interval_set(struct ospf
*, struct in_addr
,
552 extern int ospf_nbr_nbma_poll_interval_unset(struct ospf
*, struct in_addr
);
553 extern void ospf_prefix_list_update(struct prefix_list
*);
554 extern void ospf_init(void);
555 extern void ospf_if_update(struct ospf
*, struct interface
*);
556 extern void ospf_ls_upd_queue_empty(struct ospf_interface
*);
557 extern void ospf_terminate(void);
558 extern void ospf_nbr_nbma_if_update(struct ospf
*, struct ospf_interface
*);
559 extern struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup(struct ospf
*,
561 extern struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup_next(struct ospf
*,
562 struct in_addr
*, int);
563 extern int ospf_oi_count(struct interface
*);
565 extern struct ospf_area
*ospf_area_get(struct ospf
*, struct in_addr
);
566 extern void ospf_area_check_free(struct ospf
*, struct in_addr
);
567 extern struct ospf_area
*ospf_area_lookup_by_area_id(struct ospf
*,
569 extern void ospf_area_add_if(struct ospf_area
*, struct ospf_interface
*);
570 extern void ospf_area_del_if(struct ospf_area
*, struct ospf_interface
*);
572 extern void ospf_interface_area_set(struct ospf
*, struct interface
*);
573 extern void ospf_interface_area_unset(struct ospf
*, struct interface
*);
575 extern void ospf_route_map_init(void);
577 extern void ospf_master_init(struct thread_master
*master
);
578 extern void ospf_vrf_init(void);
579 extern void ospf_vrf_terminate(void);
580 extern void ospf_vrf_link(struct ospf
*ospf
, struct vrf
*vrf
);
581 extern void ospf_vrf_unlink(struct ospf
*ospf
, struct vrf
*vrf
);
582 const char *ospf_vrf_id_to_name(vrf_id_t vrf_id
);
583 int ospf_area_nssa_no_summary_set(struct ospf
*, struct in_addr
);
585 #endif /* _ZEBRA_OSPFD_H */