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
18 * along with GNU Zebra; see the file COPYING. If not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23 #ifndef _ZEBRA_OSPFD_H
24 #define _ZEBRA_OSPFD_H
31 #define OSPF_VERSION 2
33 /* Default protocol, port number. */
34 #ifndef IPPROTO_OSPFIGP
35 #define IPPROTO_OSPFIGP 89
36 #endif /* IPPROTO_OSPFIGP */
39 #ifndef IPTOS_PREC_INTERNETCONTROL
40 #define IPTOS_PREC_INTERNETCONTROL 0xC0
41 #endif /* IPTOS_PREC_INTERNETCONTROL */
43 /* VTY port number. */
44 #define OSPF_VTY_PORT 2604
46 /* IP TTL for OSPF protocol. */
48 #define OSPF_VL_IP_TTL 100
50 /* Default configuration file name for ospfd. */
51 #define OSPF_DEFAULT_CONFIG "ospfd.conf"
53 /* Architectual Constants */
55 #define OSPF_LS_REFRESH_TIME 60
57 #define OSPF_LS_REFRESH_TIME 1800
59 #define OSPF_MIN_LS_INTERVAL 5
60 #define OSPF_MIN_LS_ARRIVAL 1
61 #define OSPF_LSA_MAXAGE 3600
62 #define OSPF_CHECK_AGE 300
63 #define OSPF_LSA_MAXAGE_DIFF 900
64 #define OSPF_LS_INFINITY 0xffffff
65 #define OSPF_DEFAULT_DESTINATION 0x00000000 /* 0.0.0.0 */
66 #define OSPF_INITIAL_SEQUENCE_NUMBER 0x80000001
67 #define OSPF_MAX_SEQUENCE_NUMBER 0x7fffffff
69 #define OSPF_LSA_MAXAGE_CHECK_INTERVAL 30
70 #define OSPF_NSSA_TRANS_STABLE_DEFAULT 40
72 #define OSPF_ALLSPFROUTERS 0xe0000005 /* 224.0.0.5 */
73 #define OSPF_ALLDROUTERS 0xe0000006 /* 224.0.0.6 */
75 /* XXX Where is this used? And why it was used only if compiled with
77 #define OSPF_LOOPer 0x7f000000 /* 127.0.0.0 */
79 #define OSPF_AREA_BACKBONE 0x00000000 /* 0.0.0.0 */
81 /* OSPF Authentication Type. */
82 #define OSPF_AUTH_NULL 0
83 #define OSPF_AUTH_SIMPLE 1
84 #define OSPF_AUTH_CRYPTOGRAPHIC 2
85 /* For Interface authentication setting default */
86 #define OSPF_AUTH_NOTSET -1
87 /* For the consumption and sanity of the command handler */
88 /* DO NIOT REMOVE!!! Need to detect whether a value has
89 been given or not in VLink command handlers */
90 #define OSPF_AUTH_CMD_NOTSEEN -2
92 /* OSPF SPF timer values. */
93 #define OSPF_SPF_DELAY_DEFAULT 200
94 #define OSPF_SPF_HOLDTIME_DEFAULT 1000
95 #define OSPF_SPF_MAX_HOLDTIME_DEFAULT 10000
97 /* OSPF interface default values. */
98 #define OSPF_OUTPUT_COST_DEFAULT 10
99 #define OSPF_OUTPUT_COST_INFINITE UINT16_MAX
100 #define OSPF_ROUTER_DEAD_INTERVAL_DEFAULT 40
101 #define OSPF_ROUTER_DEAD_INTERVAL_MINIMAL 1
102 #define OSPF_HELLO_INTERVAL_DEFAULT 10
103 #define OSPF_ROUTER_PRIORITY_DEFAULT 1
104 #define OSPF_RETRANSMIT_INTERVAL_DEFAULT 5
105 #define OSPF_TRANSMIT_DELAY_DEFAULT 1
106 #define OSPF_DEFAULT_BANDWIDTH 10000 /* Kbps */
108 #define OSPF_DEFAULT_REF_BANDWIDTH 100000 /* Kbps */
110 #define OSPF_POLL_INTERVAL_DEFAULT 60
111 #define OSPF_NEIGHBOR_PRIORITY_DEFAULT 0
113 #define OSPF_MTU_IGNORE_DEFAULT 0
114 #define OSPF_FAST_HELLO_DEFAULT 0
117 #define OSPF_OPTION_T 0x01 /* TOS. */
118 #define OSPF_OPTION_E 0x02
119 #define OSPF_OPTION_MC 0x04
120 #define OSPF_OPTION_NP 0x08
121 #define OSPF_OPTION_EA 0x10
122 #define OSPF_OPTION_DC 0x20
123 #define OSPF_OPTION_O 0x40
125 /* OSPF Database Description flags. */
126 #define OSPF_DD_FLAG_MS 0x01
127 #define OSPF_DD_FLAG_M 0x02
128 #define OSPF_DD_FLAG_I 0x04
129 #define OSPF_DD_FLAG_ALL 0x07
131 #define OSPF_LS_REFRESH_SHIFT (60 * 15)
132 #define OSPF_LS_REFRESH_JITTER 60
134 /* OSPF master for system wide configuration and variables. */
140 /* OSPF thread master. */
141 struct thread_master
*master
;
143 /* Zebra interface list. */
146 /* Redistributed external information. */
147 struct route_table
*external_info
[ZEBRA_ROUTE_MAX
+ 1];
148 #define EXTERNAL_INFO(T) om->external_info[T]
150 /* OSPF start time. */
153 /* Various OSPF global configuration. */
155 #define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
158 /* OSPF instance structure. */
161 /* OSPF Router ID. */
162 struct in_addr router_id
; /* Configured automatically. */
163 struct in_addr router_id_static
; /* Configured manually. */
165 /* ABR/ASBR internal flags. */
167 #define OSPF_FLAG_ABR 0x0001
168 #define OSPF_FLAG_ASBR 0x0002
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
177 #define OSPF_ABR_DEFAULT OSPF_ABR_CISCO
180 u_char anyNSSA
; /* Bump for every NSSA attached. */
182 /* Configured variables. */
184 #define OSPF_RFC1583_COMPATIBLE (1 << 0)
185 #define OSPF_OPAQUE_CAPABLE (1 << 2)
186 #define OSPF_LOG_ADJACENCY_CHANGES (1 << 3)
187 #define OSPF_LOG_ADJACENCY_DETAIL (1 << 4)
189 #ifdef HAVE_OPAQUE_LSA
190 /* Opaque-LSA administrative flags. */
192 #define OPAQUE_OPERATION_READY_BIT (1 << 0)
193 #define OPAQUE_BLOCK_TYPE_09_LSA_BIT (1 << 1)
194 #define OPAQUE_BLOCK_TYPE_10_LSA_BIT (1 << 2)
195 #define OPAQUE_BLOCK_TYPE_11_LSA_BIT (1 << 3)
196 #endif /* HAVE_OPAQUE_LSA */
198 /* RFC3137 stub router. Configured time to stay stub / max-metric */
199 unsigned int stub_router_startup_time
; /* seconds */
200 unsigned int stub_router_shutdown_time
; /* seconds */
201 #define OSPF_STUB_ROUTER_UNCONFIGURED 0
204 unsigned int spf_delay
; /* SPF delay time. */
205 unsigned int spf_holdtime
; /* SPF hold time. */
206 unsigned int spf_max_holdtime
; /* SPF maximum-holdtime */
207 unsigned int spf_hold_multiplier
; /* Adaptive multiplier for hold time */
209 int default_originate
; /* Default information originate. */
210 #define DEFAULT_ORIGINATE_NONE 0
211 #define DEFAULT_ORIGINATE_ZEBRA 1
212 #define DEFAULT_ORIGINATE_ALWAYS 2
213 u_int32_t ref_bandwidth
; /* Reference Bandwidth (Kbps). */
214 struct route_table
*networks
; /* OSPF config networks. */
215 struct list
*vlinks
; /* Configured Virtual-Links. */
216 struct list
*areas
; /* OSPF areas. */
217 struct route_table
*nbr_nbma
;
218 struct ospf_area
*backbone
; /* Pointer to the Backbone Area. */
220 struct list
*oiflist
; /* ospf interfaces */
221 u_char passive_interface_default
; /* passive-interface default */
223 /* LSDB of AS-external-LSAs. */
224 struct ospf_lsdb
*lsdb
;
227 int external_origin
; /* AS-external-LSA origin flag. */
228 int ase_calc
; /* ASE calculation flag. */
230 #ifdef HAVE_OPAQUE_LSA
231 struct list
*opaque_lsa_self
; /* Type-11 Opaque-LSAs */
232 #endif /* HAVE_OPAQUE_LSA */
234 /* Routing tables. */
235 struct route_table
*old_table
; /* Old routing table. */
236 struct route_table
*new_table
; /* Current routing table. */
238 struct route_table
*old_rtrs
; /* Old ABR/ASBR RT. */
239 struct route_table
*new_rtrs
; /* New ABR/ASBR RT. */
241 struct route_table
*new_external_route
; /* New External Route. */
242 struct route_table
*old_external_route
; /* Old External Route. */
244 struct route_table
*external_lsas
; /* Database of external LSAs,
245 prefix is LSA's adv. network*/
248 struct timeval ts_spf
; /* SPF calculation time stamp. */
250 struct list
*maxage_lsa
; /* List of MaxAge LSA for deletion. */
251 int redistribute
; /* Num of redistributed protocols. */
254 struct thread
*t_router_lsa_update
; /* router-LSA update timer. */
255 struct thread
*t_abr_task
; /* ABR task timer. */
256 struct thread
*t_asbr_check
; /* ASBR check timer. */
257 struct thread
*t_distribute_update
; /* Distirbute list update timer. */
258 struct thread
*t_spf_calc
; /* SPF calculation timer. */
259 struct thread
*t_ase_calc
; /* ASE calculation timer. */
260 struct thread
*t_external_lsa
; /* AS-external-LSA origin timer. */
261 #ifdef HAVE_OPAQUE_LSA
262 struct thread
*t_opaque_lsa_self
; /* Type-11 Opaque-LSAs origin event. */
263 #endif /* HAVE_OPAQUE_LSA */
264 struct thread
*t_maxage
; /* MaxAge LSA remover timer. */
265 struct thread
*t_maxage_walker
; /* MaxAge LSA checking timer. */
266 struct thread
*t_deferred_shutdown
; /* deferred/stub-router shutdown timer*/
268 struct thread
*t_write
;
269 struct thread
*t_read
;
273 struct list
*oi_write_q
;
275 /* Distribute lists out of other route sources. */
279 struct access_list
*list
;
280 } dlist
[ZEBRA_ROUTE_MAX
];
281 #define DISTRIBUTE_NAME(O,T) (O)->dlist[T].name
282 #define DISTRIBUTE_LIST(O,T) (O)->dlist[T].list
284 /* Redistribute metric info. */
287 int type
; /* External metric type (E1 or E2). */
288 int value
; /* Value for static metric (24-bit).
289 -1 means metric value is not set. */
290 } dmetric
[ZEBRA_ROUTE_MAX
+ 1];
292 /* For redistribute route map. */
296 struct route_map
*map
;
297 } route_map
[ZEBRA_ROUTE_MAX
+ 1]; /* +1 is for default-information */
298 #define ROUTEMAP_NAME(O,T) (O)->route_map[T].name
299 #define ROUTEMAP(O,T) (O)->route_map[T].map
301 int default_metric
; /* Default metric for redistribute. */
303 #define OSPF_LSA_REFRESHER_GRANULARITY 10
304 #define OSPF_LSA_REFRESHER_SLOTS ((OSPF_LS_REFRESH_TIME + \
305 OSPF_LS_REFRESH_SHIFT)/10 + 1)
309 struct list
*qs
[OSPF_LSA_REFRESHER_SLOTS
];
312 struct thread
*t_lsa_refresher
;
313 time_t lsa_refresher_started
;
314 #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
315 u_int16_t lsa_refresh_interval
;
317 /* Distance parameter. */
319 u_char distance_intra
;
320 u_char distance_inter
;
321 u_char distance_external
;
323 /* Statistics for LSA origination. */
324 u_int32_t lsa_originate_count
;
326 /* Statistics for LSA used for new instantiation. */
327 u_int32_t rx_lsa_count
;
329 struct route_table
*distance_table
;
332 /* OSPF area structure. */
338 /* Zebra interface list belonging to the area. */
339 struct list
*oiflist
;
342 struct in_addr area_id
;
344 /* Area ID format. */
346 #define OSPF_AREA_ID_FORMAT_ADDRESS 1
347 #define OSPF_AREA_ID_FORMAT_DECIMAL 2
350 struct list
*address_range
;
352 /* Configured variables. */
353 int external_routing
; /* ExternalRoutingCapability. */
354 #define OSPF_AREA_DEFAULT 0
355 #define OSPF_AREA_STUB 1
356 #define OSPF_AREA_NSSA 2
357 #define OSPF_AREA_TYPE_MAX 3
358 int no_summary
; /* Don't inject summaries into stub.*/
359 int shortcut_configured
; /* Area configured as shortcut. */
360 #define OSPF_SHORTCUT_DEFAULT 0
361 #define OSPF_SHORTCUT_ENABLE 1
362 #define OSPF_SHORTCUT_DISABLE 2
363 int shortcut_capability
; /* Other ABRs agree on S-bit */
364 u_int32_t default_cost
; /* StubDefaultCost. */
365 int auth_type
; /* Authentication type. */
368 u_char NSSATranslatorRole
; /* NSSA configured role */
369 #define OSPF_NSSA_ROLE_NEVER 0
370 #define OSPF_NSSA_ROLE_CANDIDATE 1
371 #define OSPF_NSSA_ROLE_ALWAYS 2
372 u_char NSSATranslatorState
; /* NSSA operational role */
373 #define OSPF_NSSA_TRANSLATE_DISABLED 0
374 #define OSPF_NSSA_TRANSLATE_ENABLED 1
375 int NSSATranslatorStabilityInterval
;
377 u_char transit
; /* TransitCapability. */
378 #define OSPF_TRANSIT_FALSE 0
379 #define OSPF_TRANSIT_TRUE 1
380 struct route_table
*ranges
; /* Configured Area Ranges. */
382 /* RFC3137 stub router state flags for area */
383 u_char stub_router_state
;
384 #define OSPF_AREA_ADMIN_STUB_ROUTED (1 << 0) /* admin stub-router set */
385 #define OSPF_AREA_IS_STUB_ROUTED (1 << 1) /* stub-router active */
386 #define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */
388 /* Area related LSDBs[Type1-4]. */
389 struct ospf_lsdb
*lsdb
;
391 /* Self-originated LSAs. */
392 struct ospf_lsa
*router_lsa_self
;
393 #ifdef HAVE_OPAQUE_LSA
394 struct list
*opaque_lsa_self
; /* Type-10 Opaque-LSAs */
395 #endif /* HAVE_OPAQUE_LSA */
397 /* Area announce list. */
401 struct access_list
*list
;
403 #define EXPORT_NAME(A) (A)->_export.name
404 #define EXPORT_LIST(A) (A)->_export.list
406 /* Area acceptance list. */
410 struct access_list
*list
;
412 #define IMPORT_NAME(A) (A)->import.name
413 #define IMPORT_LIST(A) (A)->import.list
415 /* Type 3 LSA Area prefix-list. */
419 struct prefix_list
*list
;
421 #define PREFIX_LIST_IN(A) (A)->plist_in.list
422 #define PREFIX_NAME_IN(A) (A)->plist_in.name
427 struct prefix_list
*list
;
429 #define PREFIX_LIST_OUT(A) (A)->plist_out.list
430 #define PREFIX_NAME_OUT(A) (A)->plist_out.name
432 /* Shortest Path Tree. */
436 struct thread
*t_router_lsa_self
;/* Self-originated router-LSA timer. */
437 struct thread
*t_stub_router
; /* Stub-router timer */
438 #ifdef HAVE_OPAQUE_LSA
439 struct thread
*t_opaque_lsa_self
; /* Type-10 Opaque-LSAs origin. */
440 #endif /* HAVE_OPAQUE_LSA */
442 /* Statistics field. */
443 u_int32_t spf_calculation
; /* SPF Calculation Count. */
446 u_int32_t abr_count
; /* ABR router in this area. */
447 u_int32_t asbr_count
; /* ASBR router in this area. */
450 u_int32_t act_ints
; /* Active interfaces. */
451 u_int32_t full_nbrs
; /* Fully adjacent neighbors. */
452 u_int32_t full_vls
; /* Fully adjacent virtual neighbors. */
455 /* OSPF config network structure. */
459 struct in_addr area_id
;
463 /* OSPF NBMA neighbor structure. */
466 /* Neighbor IP address. */
469 /* OSPF interface. */
470 struct ospf_interface
*oi
;
472 /* OSPF neighbor structure. */
473 struct ospf_neighbor
*nbr
;
475 /* Neighbor priority. */
478 /* Poll timer value. */
481 /* Poll timer thread. */
482 struct thread
*t_poll
;
485 u_int32_t state_change
;
489 #define OSPF_AREA_SAME(X,Y) \
490 (memcmp ((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
492 #define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR)
493 #define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR)
495 #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
496 #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
499 # define ROUNDUP(val, gran) roundup(val, gran)
501 # define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1)
504 #define LSA_OPTIONS_GET(area) \
505 (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
506 #define LSA_OPTIONS_NSSA_GET(area) \
507 (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0)
509 #define OSPF_TIMER_ON(T,F,V) \
512 (T) = thread_add_timer (master, (F), ospf, (V)); \
515 #define OSPF_AREA_TIMER_ON(T,F,V) \
518 (T) = thread_add_timer (master, (F), area, (V)); \
521 #define OSPF_POLL_TIMER_ON(T,F,V) \
524 (T) = thread_add_timer (master, (F), nbr_nbma, (V)); \
527 #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X))
529 #define OSPF_TIMER_OFF(X) \
538 /* Extern variables. */
539 extern struct ospf_master
*om
;
540 extern const struct message ospf_ism_state_msg
[];
541 extern const struct message ospf_nsm_state_msg
[];
542 extern const struct message ospf_lsa_type_msg
[];
543 extern const struct message ospf_link_state_id_type_msg
[];
544 extern const struct message ospf_network_type_msg
[];
545 extern const int ospf_ism_state_msg_max
;
546 extern const int ospf_nsm_state_msg_max
;
547 extern const int ospf_lsa_type_msg_max
;
548 extern const int ospf_link_state_id_type_msg_max
;
549 extern const int ospf_redistributed_proto_max
;
550 extern const int ospf_network_type_msg_max
;
551 extern struct zclient
*zclient
;
552 extern struct thread_master
*master
;
553 extern int ospf_zlog
;
556 extern const char *ospf_redist_string(u_int route_type
);
557 extern struct ospf
*ospf_lookup (void);
558 extern struct ospf
*ospf_get (void);
559 extern void ospf_finish (struct ospf
*);
560 extern void ospf_router_id_update (struct ospf
*ospf
);
561 extern int ospf_network_set (struct ospf
*, struct prefix_ipv4
*,
563 extern int ospf_network_unset (struct ospf
*, struct prefix_ipv4
*,
565 extern int ospf_area_stub_set (struct ospf
*, struct in_addr
);
566 extern int ospf_area_stub_unset (struct ospf
*, struct in_addr
);
567 extern int ospf_area_no_summary_set (struct ospf
*, struct in_addr
);
568 extern int ospf_area_no_summary_unset (struct ospf
*, struct in_addr
);
569 extern int ospf_area_nssa_set (struct ospf
*, struct in_addr
);
570 extern int ospf_area_nssa_unset (struct ospf
*, struct in_addr
);
571 extern int ospf_area_nssa_translator_role_set (struct ospf
*, struct in_addr
,
573 extern int ospf_area_export_list_set (struct ospf
*, struct ospf_area
*,
575 extern int ospf_area_export_list_unset (struct ospf
*, struct ospf_area
*);
576 extern int ospf_area_import_list_set (struct ospf
*, struct ospf_area
*,
578 extern int ospf_area_import_list_unset (struct ospf
*, struct ospf_area
*);
579 extern int ospf_area_shortcut_set (struct ospf
*, struct ospf_area
*, int);
580 extern int ospf_area_shortcut_unset (struct ospf
*, struct ospf_area
*);
581 extern int ospf_timers_refresh_set (struct ospf
*, int);
582 extern int ospf_timers_refresh_unset (struct ospf
*);
583 extern int ospf_nbr_nbma_set (struct ospf
*, struct in_addr
);
584 extern int ospf_nbr_nbma_unset (struct ospf
*, struct in_addr
);
585 extern int ospf_nbr_nbma_priority_set (struct ospf
*, struct in_addr
, u_char
);
586 extern int ospf_nbr_nbma_priority_unset (struct ospf
*, struct in_addr
);
587 extern int ospf_nbr_nbma_poll_interval_set (struct ospf
*, struct in_addr
,
589 extern int ospf_nbr_nbma_poll_interval_unset (struct ospf
*, struct in_addr
);
590 extern void ospf_prefix_list_update (struct prefix_list
*);
591 extern void ospf_init (void);
592 extern void ospf_if_update (struct ospf
*, struct interface
*);
593 extern void ospf_ls_upd_queue_empty (struct ospf_interface
*);
594 extern void ospf_terminate (void);
595 extern void ospf_nbr_nbma_if_update (struct ospf
*, struct ospf_interface
*);
596 extern struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup (struct ospf
*,
598 extern struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup_next (struct ospf
*,
601 extern int ospf_oi_count (struct interface
*);
603 extern struct ospf_area
*ospf_area_get (struct ospf
*, struct in_addr
, int);
604 extern void ospf_area_check_free (struct ospf
*, struct in_addr
);
605 extern struct ospf_area
*ospf_area_lookup_by_area_id (struct ospf
*,
607 extern void ospf_area_add_if (struct ospf_area
*, struct ospf_interface
*);
608 extern void ospf_area_del_if (struct ospf_area
*, struct ospf_interface
*);
610 extern void ospf_route_map_init (void);
611 extern void ospf_snmp_init (void);
613 extern void ospf_master_init (void);
615 #endif /* _ZEBRA_OSPFD_H */