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
{
84 unsigned short instance
;
85 struct route_table
*external_info
;
88 /* OSPF master for system wide configuration and variables. */
93 /* OSPF thread master. */
94 struct thread_master
*master
;
96 /* Various OSPF global configuration. */
98 #define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
102 unsigned short instance
;
104 /* Redistribute metric info. */
106 int type
; /* External metric type (E1 or E2). */
107 int value
; /* Value for static metric (24-bit).
108 -1 means metric value is not set. */
111 /* For redistribute route map. */
114 struct route_map
*map
;
115 } route_map
; /* +1 is for default-information */
116 #define ROUTEMAP_NAME(R) (R->route_map.name)
117 #define ROUTEMAP(R) (R->route_map.map)
120 /* OSPF instance structure. */
122 /* OSPF's running state based on the '[no] router ospf [<instance>]'
126 /* OSPF instance ID */
127 unsigned short instance
;
129 /* OSPF Router ID. */
130 struct in_addr router_id
; /* Configured automatically. */
131 struct in_addr router_id_static
; /* Configured manually. */
132 struct in_addr router_id_zebra
;
134 vrf_id_t vrf_id
; /* VRF Id */
135 char *name
; /* VRF name */
137 /* ABR/ASBR internal flags. */
139 #define OSPF_FLAG_ABR 0x0001
140 #define OSPF_FLAG_ASBR 0x0002
144 #define OSPF_ABR_UNKNOWN 0
145 #define OSPF_ABR_STAND 1
146 #define OSPF_ABR_IBM 2
147 #define OSPF_ABR_CISCO 3
148 #define OSPF_ABR_SHORTCUT 4
149 #define OSPF_ABR_DEFAULT OSPF_ABR_CISCO
152 uint8_t anyNSSA
; /* Bump for every NSSA attached. */
154 /* Configured variables. */
156 #define OSPF_RFC1583_COMPATIBLE (1 << 0)
157 #define OSPF_OPAQUE_CAPABLE (1 << 2)
158 #define OSPF_LOG_ADJACENCY_CHANGES (1 << 3)
159 #define OSPF_LOG_ADJACENCY_DETAIL (1 << 4)
161 /* Opaque-LSA administrative flags. */
163 #define OPAQUE_OPERATION_READY_BIT (1 << 0)
165 /* RFC3137 stub router. Configured time to stay stub / max-metric */
166 unsigned int stub_router_startup_time
; /* seconds */
167 unsigned int stub_router_shutdown_time
; /* seconds */
168 #define OSPF_STUB_ROUTER_UNCONFIGURED 0
169 uint8_t stub_router_admin_set
;
170 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_SET 1
171 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_UNSET 0
173 #define OSPF_STUB_MAX_METRIC_SUMMARY_COST 0x00ff0000
176 unsigned int min_ls_interval
; /* minimum delay between LSAs (in msec) */
177 unsigned int min_ls_arrival
; /* minimum interarrival time between LSAs
181 unsigned int spf_delay
; /* SPF delay time. */
182 unsigned int spf_holdtime
; /* SPF hold time. */
183 unsigned int spf_max_holdtime
; /* SPF maximum-holdtime */
185 spf_hold_multiplier
; /* Adaptive multiplier for hold time */
187 int default_originate
; /* Default information originate. */
188 #define DEFAULT_ORIGINATE_NONE 0
189 #define DEFAULT_ORIGINATE_ZEBRA 1
190 #define DEFAULT_ORIGINATE_ALWAYS 2
191 uint32_t ref_bandwidth
; /* Reference Bandwidth (Kbps). */
192 struct route_table
*networks
; /* OSPF config networks. */
193 struct list
*vlinks
; /* Configured Virtual-Links. */
194 struct list
*areas
; /* OSPF areas. */
195 struct route_table
*nbr_nbma
;
196 struct ospf_area
*backbone
; /* Pointer to the Backbone Area. */
198 struct list
*oiflist
; /* ospf interfaces */
199 uint8_t passive_interface_default
; /* passive-interface default */
201 /* LSDB of AS-external-LSAs. */
202 struct ospf_lsdb
*lsdb
;
205 int ase_calc
; /* ASE calculation flag. */
207 struct list
*opaque_lsa_self
; /* Type-11 Opaque-LSAs */
209 /* Routing tables. */
210 struct route_table
*old_table
; /* Old routing table. */
211 struct route_table
*new_table
; /* Current routing table. */
213 struct route_table
*old_rtrs
; /* Old ABR/ASBR RT. */
214 struct route_table
*new_rtrs
; /* New ABR/ASBR RT. */
216 struct route_table
*new_external_route
; /* New External Route. */
217 struct route_table
*old_external_route
; /* Old External Route. */
219 struct route_table
*external_lsas
; /* Database of external LSAs,
220 prefix is LSA's adv. network*/
223 struct timeval ts_spf
; /* SPF calculation time stamp. */
224 struct timeval ts_spf_duration
; /* Execution time of last SPF */
226 struct route_table
*maxage_lsa
; /* List of MaxAge LSA for deletion. */
227 int redistribute
; /* Num of redistributed protocols. */
230 struct thread
*t_abr_task
; /* ABR task timer. */
231 struct thread
*t_asbr_check
; /* ASBR check timer. */
232 struct thread
*t_distribute_update
; /* Distirbute list update timer. */
233 struct thread
*t_spf_calc
; /* SPF calculation timer. */
234 struct thread
*t_ase_calc
; /* ASE calculation timer. */
236 *t_opaque_lsa_self
; /* Type-11 Opaque-LSAs origin event. */
237 struct thread
*t_sr_update
; /* Segment Routing update timer */
239 unsigned int maxage_delay
; /* Delay on Maxage remover timer, sec */
240 struct thread
*t_maxage
; /* MaxAge LSA remover timer. */
241 struct thread
*t_maxage_walker
; /* MaxAge LSA checking timer. */
244 *t_deferred_shutdown
; /* deferred/stub-router shutdown timer*/
246 struct thread
*t_write
;
247 #define OSPF_WRITE_INTERFACE_COUNT_DEFAULT 20
248 int write_oi_count
; /* Num of packets sent per thread invocation */
249 struct thread
*t_read
;
252 struct list
*oi_write_q
;
254 /* Distribute lists out of other route sources. */
257 struct access_list
*list
;
258 } dlist
[ZEBRA_ROUTE_MAX
];
259 #define DISTRIBUTE_NAME(O,T) (O)->dlist[T].name
260 #define DISTRIBUTE_LIST(O,T) (O)->dlist[T].list
262 /* OSPF redistribute configuration */
263 struct list
*redist
[ZEBRA_ROUTE_MAX
+ 1];
265 /* Redistribute tag info. */
267 dtag
[ZEBRA_ROUTE_MAX
+ 1]; // Pending: cant configure as of now
269 int default_metric
; /* Default metric for redistribute. */
271 #define OSPF_LSA_REFRESHER_GRANULARITY 10
272 #define OSPF_LSA_REFRESHER_SLOTS \
273 ((OSPF_LS_REFRESH_TIME + OSPF_LS_REFRESH_SHIFT) \
274 / OSPF_LSA_REFRESHER_GRANULARITY \
278 struct list
*qs
[OSPF_LSA_REFRESHER_SLOTS
];
281 struct thread
*t_lsa_refresher
;
282 time_t lsa_refresher_started
;
283 #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
284 uint16_t lsa_refresh_interval
;
286 /* Distance parameter. */
287 uint8_t distance_all
;
288 uint8_t distance_intra
;
289 uint8_t distance_inter
;
290 uint8_t distance_external
;
292 /* Statistics for LSA origination. */
293 uint32_t lsa_originate_count
;
295 /* Statistics for LSA used for new instantiation. */
296 uint32_t rx_lsa_count
;
298 /* Counter of "ip ospf area x.x.x.x" used
299 * for multual exclusion of network command under
300 * router ospf or ip ospf area x under interface. */
301 uint32_t if_ospf_cli_count
;
303 struct route_table
*distance_table
;
305 /* Used during ospf instance going down send LSDB
306 * update to neighbors immediatly */
307 uint8_t inst_shutdown
;
309 /* Redistributed external information. */
310 struct list
*external
[ZEBRA_ROUTE_MAX
+ 1];
311 #define EXTERNAL_INFO(E) (E->external_info)
315 DECLARE_QOBJ_TYPE(ospf
)
317 /* OSPF area structure. */
322 /* Zebra interface list belonging to the area. */
323 struct list
*oiflist
;
326 struct in_addr area_id
;
328 /* Area ID format. */
330 #define OSPF_AREA_ID_FMT_DOTTEDQUAD 1
331 #define OSPF_AREA_ID_FMT_DECIMAL 2
334 struct list
*address_range
;
336 /* Configured variables. */
337 int external_routing
; /* ExternalRoutingCapability. */
338 int no_summary
; /* Don't inject summaries into stub.*/
339 int shortcut_configured
; /* Area configured as shortcut. */
340 #define OSPF_SHORTCUT_DEFAULT 0
341 #define OSPF_SHORTCUT_ENABLE 1
342 #define OSPF_SHORTCUT_DISABLE 2
343 int shortcut_capability
; /* Other ABRs agree on S-bit */
344 uint32_t default_cost
; /* StubDefaultCost. */
345 int auth_type
; /* Authentication type. */
348 uint8_t NSSATranslatorRole
; /* NSSA configured role */
349 #define OSPF_NSSA_ROLE_NEVER 0
350 #define OSPF_NSSA_ROLE_CANDIDATE 1
351 #define OSPF_NSSA_ROLE_ALWAYS 2
352 uint8_t NSSATranslatorState
; /* NSSA operational role */
353 #define OSPF_NSSA_TRANSLATE_DISABLED 0
354 #define OSPF_NSSA_TRANSLATE_ENABLED 1
355 int NSSATranslatorStabilityInterval
;
357 uint8_t transit
; /* TransitCapability. */
358 #define OSPF_TRANSIT_FALSE 0
359 #define OSPF_TRANSIT_TRUE 1
360 struct route_table
*ranges
; /* Configured Area Ranges. */
362 /* RFC3137 stub router state flags for area */
363 uint8_t stub_router_state
;
364 #define OSPF_AREA_ADMIN_STUB_ROUTED (1 << 0) /* admin stub-router set */
365 #define OSPF_AREA_IS_STUB_ROUTED (1 << 1) /* stub-router active */
366 #define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */
367 /* Area related LSDBs[Type1-4]. */
368 struct ospf_lsdb
*lsdb
;
370 /* Self-originated LSAs. */
371 struct ospf_lsa
*router_lsa_self
;
372 struct list
*opaque_lsa_self
; /* Type-10 Opaque-LSAs */
374 /* Area announce list. */
377 struct access_list
*list
;
379 #define EXPORT_NAME(A) (A)->_export.name
380 #define EXPORT_LIST(A) (A)->_export.list
382 /* Area acceptance list. */
385 struct access_list
*list
;
387 #define IMPORT_NAME(A) (A)->import.name
388 #define IMPORT_LIST(A) (A)->import.list
390 /* Type 3 LSA Area prefix-list. */
393 struct prefix_list
*list
;
395 #define PREFIX_LIST_IN(A) (A)->plist_in.list
396 #define PREFIX_NAME_IN(A) (A)->plist_in.name
400 struct prefix_list
*list
;
402 #define PREFIX_LIST_OUT(A) (A)->plist_out.list
403 #define PREFIX_NAME_OUT(A) (A)->plist_out.name
405 /* Shortest Path Tree. */
409 struct thread
*t_stub_router
; /* Stub-router timer */
410 struct thread
*t_opaque_lsa_self
; /* Type-10 Opaque-LSAs origin. */
412 /* Statistics field. */
413 uint32_t spf_calculation
; /* SPF Calculation Count. */
416 struct timeval ts_spf
; /* SPF calculation time stamp. */
419 uint32_t abr_count
; /* ABR router in this area. */
420 uint32_t asbr_count
; /* ASBR router in this area. */
423 uint32_t act_ints
; /* Active interfaces. */
424 uint32_t full_nbrs
; /* Fully adjacent neighbors. */
425 uint32_t full_vls
; /* Fully adjacent virtual neighbors. */
428 /* OSPF config network structure. */
429 struct ospf_network
{
431 struct in_addr area_id
;
435 /* OSPF NBMA neighbor structure. */
436 struct ospf_nbr_nbma
{
437 /* Neighbor IP address. */
440 /* OSPF interface. */
441 struct ospf_interface
*oi
;
443 /* OSPF neighbor structure. */
444 struct ospf_neighbor
*nbr
;
446 /* Neighbor priority. */
449 /* Poll timer value. */
452 /* Poll timer thread. */
453 struct thread
*t_poll
;
456 uint32_t state_change
;
460 #define OSPF_AREA_SAME(X, Y) \
461 (memcmp((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
463 #define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR)
464 #define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR)
466 #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
467 #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
470 # define ROUNDUP(val, gran) roundup(val, gran)
472 # define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1)
475 #define LSA_OPTIONS_GET(area) \
476 (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
477 #define LSA_OPTIONS_NSSA_GET(area) \
478 (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0)
480 #define OSPF_TIMER_ON(T,F,V) thread_add_timer (master,(F),ospf,(V),&(T))
481 #define OSPF_AREA_TIMER_ON(T,F,V) thread_add_timer (master, (F), area, (V), &(T))
482 #define OSPF_POLL_TIMER_ON(T,F,V) thread_add_timer (master, (F), nbr_nbma, (V), &(T))
483 #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X))
484 #define OSPF_TIMER_OFF(X) \
492 /* Extern variables. */
493 extern struct ospf_master
*om
;
494 extern const int ospf_redistributed_proto_max
;
495 extern struct zclient
*zclient
;
496 extern struct thread_master
*master
;
497 extern int ospf_zlog
;
498 extern struct zebra_privs_t ospfd_privs
;
501 extern const char *ospf_redist_string(unsigned int route_type
);
502 extern struct ospf
*ospf_lookup_instance(unsigned short);
503 extern struct ospf
*ospf_get(unsigned short instance
, const char *name
);
504 extern struct ospf
*ospf_get_instance(unsigned short);
505 extern struct ospf
*ospf_lookup_by_inst_name(unsigned short instance
,
507 extern struct ospf
*ospf_lookup_by_vrf_id(vrf_id_t vrf_id
);
508 extern void ospf_finish(struct ospf
*);
509 extern void ospf_router_id_update(struct ospf
*ospf
);
510 extern int ospf_network_set(struct ospf
*, struct prefix_ipv4
*, struct in_addr
,
512 extern int ospf_network_unset(struct ospf
*, struct prefix_ipv4
*,
514 extern int ospf_area_display_format_set(struct ospf
*, struct ospf_area
*area
,
516 extern int ospf_area_stub_set(struct ospf
*, struct in_addr
);
517 extern int ospf_area_stub_unset(struct ospf
*, struct in_addr
);
518 extern int ospf_area_no_summary_set(struct ospf
*, struct in_addr
);
519 extern int ospf_area_no_summary_unset(struct ospf
*, struct in_addr
);
520 extern int ospf_area_nssa_set(struct ospf
*, struct in_addr
);
521 extern int ospf_area_nssa_unset(struct ospf
*, struct in_addr
, int);
522 extern int ospf_area_nssa_translator_role_set(struct ospf
*, struct in_addr
,
524 extern int ospf_area_export_list_set(struct ospf
*, struct ospf_area
*,
526 extern int ospf_area_export_list_unset(struct ospf
*, struct ospf_area
*);
527 extern int ospf_area_import_list_set(struct ospf
*, struct ospf_area
*,
529 extern int ospf_area_import_list_unset(struct ospf
*, struct ospf_area
*);
530 extern int ospf_area_shortcut_set(struct ospf
*, struct ospf_area
*, int);
531 extern int ospf_area_shortcut_unset(struct ospf
*, struct ospf_area
*);
532 extern int ospf_timers_refresh_set(struct ospf
*, int);
533 extern int ospf_timers_refresh_unset(struct ospf
*);
534 extern int ospf_nbr_nbma_set(struct ospf
*, struct in_addr
);
535 extern int ospf_nbr_nbma_unset(struct ospf
*, struct in_addr
);
536 extern int ospf_nbr_nbma_priority_set(struct ospf
*, struct in_addr
, uint8_t);
537 extern int ospf_nbr_nbma_priority_unset(struct ospf
*, struct in_addr
);
538 extern int ospf_nbr_nbma_poll_interval_set(struct ospf
*, struct in_addr
,
540 extern int ospf_nbr_nbma_poll_interval_unset(struct ospf
*, struct in_addr
);
541 extern void ospf_prefix_list_update(struct prefix_list
*);
542 extern void ospf_init(void);
543 extern void ospf_if_update(struct ospf
*, struct interface
*);
544 extern void ospf_ls_upd_queue_empty(struct ospf_interface
*);
545 extern void ospf_terminate(void);
546 extern void ospf_nbr_nbma_if_update(struct ospf
*, struct ospf_interface
*);
547 extern struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup(struct ospf
*,
549 extern struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup_next(struct ospf
*,
550 struct in_addr
*, int);
551 extern int ospf_oi_count(struct interface
*);
553 extern struct ospf_area
*ospf_area_get(struct ospf
*, struct in_addr
);
554 extern void ospf_area_check_free(struct ospf
*, struct in_addr
);
555 extern struct ospf_area
*ospf_area_lookup_by_area_id(struct ospf
*,
557 extern void ospf_area_add_if(struct ospf_area
*, struct ospf_interface
*);
558 extern void ospf_area_del_if(struct ospf_area
*, struct ospf_interface
*);
560 extern void ospf_interface_area_set(struct ospf
*, struct interface
*);
561 extern void ospf_interface_area_unset(struct ospf
*, struct interface
*);
562 extern bool ospf_interface_area_is_already_set(struct ospf
*ospf
,
563 struct interface
*ifp
);
565 extern void ospf_route_map_init(void);
567 extern void ospf_master_init(struct thread_master
*master
);
568 extern void ospf_vrf_init(void);
569 extern void ospf_vrf_terminate(void);
570 extern void ospf_vrf_link(struct ospf
*ospf
, struct vrf
*vrf
);
571 extern void ospf_vrf_unlink(struct ospf
*ospf
, struct vrf
*vrf
);
572 const char *ospf_vrf_id_to_name(vrf_id_t vrf_id
);
573 int ospf_area_nssa_no_summary_set(struct ospf
*, struct in_addr
);
575 const char *ospf_get_name(const struct ospf
*ospf
);
576 #endif /* _ZEBRA_OSPFD_H */