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
28 #define OSPF_VERSION 2
30 /* Default protocol, port number. */
31 #ifndef IPPROTO_OSPFIGP
32 #define IPPROTO_OSPFIGP 89
33 #endif /* IPPROTO_OSPFIGP */
36 #ifndef IPTOS_PREC_INTERNETCONTROL
37 #define IPTOS_PREC_INTERNETCONTROL 0xC0
38 #endif /* IPTOS_PREC_INTERNETCONTROL */
40 /* VTY port number. */
41 #define OSPF_VTY_PORT 2604
42 #define OSPF_VTYSH_PATH "/tmp/.ospfd"
44 /* IP TTL for OSPF protocol. */
46 #define OSPF_VL_IP_TTL 100
48 /* Default configuration file name for ospfd. */
49 #define OSPF_DEFAULT_CONFIG "ospfd.conf"
51 /* Architectual Constants */
53 #define OSPF_LS_REFRESH_TIME 60
55 #define OSPF_LS_REFRESH_TIME 1800
57 #define OSPF_MIN_LS_INTERVAL 5
58 #define OSPF_MIN_LS_ARRIVAL 1
59 #define OSPF_LSA_MAXAGE 3600
60 #define OSPF_CHECK_AGE 300
61 #define OSPF_LSA_MAXAGE_DIFF 900
62 #define OSPF_LS_INFINITY 0xffffff
63 #define OSPF_DEFAULT_DESTINATION 0x00000000 /* 0.0.0.0 */
64 #define OSPF_INITIAL_SEQUENCE_NUMBER 0x80000001
65 #define OSPF_MAX_SEQUENCE_NUMBER 0x7fffffff
67 #define OSPF_LSA_MAXAGE_CHECK_INTERVAL 30
69 #define OSPF_ALLSPFROUTERS 0xe0000005 /* 224.0.0.5 */
70 #define OSPF_ALLDROUTERS 0xe0000006 /* 224.0.0.6 */
73 #define OSPF_LOOPer 0x7f000000 /* 127.0.0.0 */
74 #endif /* HAVE_NSSA */
76 #define OSPF_AREA_BACKBONE 0x00000000 /* 0.0.0.0 */
78 /* OSPF Authentication Type. */
79 #define OSPF_AUTH_NULL 0
80 #define OSPF_AUTH_SIMPLE 1
81 #define OSPF_AUTH_CRYPTOGRAPHIC 2
82 /* For Interface authentication setting default */
83 #define OSPF_AUTH_NOTSET -1
84 /* For the consumption and sanity of the command handler */
85 /* DO NIOT REMOVE!!! Need to detect whether a value has
86 been given or not in VLink command handlers */
87 #define OSPF_AUTH_CMD_NOTSEEN -2
89 /* OSPF SPF timer values. */
90 #define OSPF_SPF_DELAY_DEFAULT 5
91 #define OSPF_SPF_HOLDTIME_DEFAULT 10
93 /* OSPF interface default values. */
94 #define OSPF_OUTPUT_COST_DEFAULT 10
95 #define OSPF_ROUTER_DEAD_INTERVAL_DEFAULT 40
96 #define OSPF_HELLO_INTERVAL_DEFAULT 10
97 #define OSPF_ROUTER_PRIORITY_DEFAULT 1
98 #define OSPF_RETRANSMIT_INTERVAL_DEFAULT 5
99 #define OSPF_TRANSMIT_DELAY_DEFAULT 1
100 #define OSPF_DEFAULT_BANDWIDTH 10000 /* Kbps */
102 #define OSPF_DEFAULT_REF_BANDWIDTH 100000 /* Kbps */
104 #define OSPF_POLL_INTERVAL_DEFAULT 60
105 #define OSPF_NEIGHBOR_PRIORITY_DEFAULT 0
108 #define OSPF_OPTION_T 0x01 /* TOS. */
109 #define OSPF_OPTION_E 0x02
110 #define OSPF_OPTION_MC 0x04
111 #define OSPF_OPTION_NP 0x08
112 #define OSPF_OPTION_EA 0x10
113 #define OSPF_OPTION_DC 0x20
114 #define OSPF_OPTION_O 0x40
116 /* OSPF Database Description flags. */
117 #define OSPF_DD_FLAG_MS 0x01
118 #define OSPF_DD_FLAG_M 0x02
119 #define OSPF_DD_FLAG_I 0x04
120 #define OSPF_DD_FLAG_ALL 0x07
123 #define OSPF_ROUTER_ID_UPDATE_DELAY 1
125 #define OSPF_LS_REFRESH_SHIFT (60 * 15)
126 #define OSPF_LS_REFRESH_JITTER 60
128 /* OSPF master for system wide configuration and variables. */
134 /* OSPF thread master. */
135 struct thread_master
*master
;
137 /* Zebra interface list. */
140 /* Redistributed external information. */
141 struct route_table
*external_info
[ZEBRA_ROUTE_MAX
+ 1];
142 #define EXTERNAL_INFO(T) om->external_info[T]
144 /* OSPF start time. */
147 /* Various OSPF global configuration. */
151 /* OSPF instance structure. */
154 /* OSPF Router ID. */
155 struct in_addr router_id
; /* Configured automatically. */
156 struct in_addr router_id_static
; /* Configured manually. */
158 /* ABR/ASBR internal flags. */
160 #define OSPF_FLAG_ABR 0x0001
161 #define OSPF_FLAG_ASBR 0x0002
165 #define OSPF_ABR_UNKNOWN 0
166 #define OSPF_ABR_STAND 1
167 #define OSPF_ABR_IBM 2
168 #define OSPF_ABR_CISCO 3
169 #define OSPF_ABR_SHORTCUT 4
172 u_char anyNSSA
; /* Bump for every NSSA attached. */
174 /* Configured variables. */
176 #define OSPF_RFC1583_COMPATIBLE (1 << 0)
177 #define OSPF_OPAQUE_CAPABLE (1 << 2)
179 #ifdef HAVE_OPAQUE_LSA
180 /* Opaque-LSA administrative flags. */
182 #define OPAQUE_OPERATION_READY_BIT (1 << 0)
183 #define OPAQUE_BLOCK_TYPE_09_LSA_BIT (1 << 1)
184 #define OPAQUE_BLOCK_TYPE_10_LSA_BIT (1 << 2)
185 #define OPAQUE_BLOCK_TYPE_11_LSA_BIT (1 << 3)
186 #endif /* HAVE_OPAQUE_LSA */
188 int spf_delay
; /* SPF delay time. */
189 int spf_holdtime
; /* SPF hold time. */
190 int default_originate
; /* Default information originate. */
191 #define DEFAULT_ORIGINATE_NONE 0
192 #define DEFAULT_ORIGINATE_ZEBRA 1
193 #define DEFAULT_ORIGINATE_ALWAYS 2
194 u_int32_t ref_bandwidth
; /* Reference Bandwidth (Kbps). */
195 struct route_table
*networks
; /* OSPF config networks. */
196 list vlinks
; /* Configured Virtual-Links. */
197 list areas
; /* OSPF areas. */
198 struct route_table
*nbr_nbma
;
199 struct ospf_area
*backbone
; /* Pointer to the Backbone Area. */
201 list oiflist
; /* ospf interfaces */
203 /* LSDB of AS-external-LSAs. */
204 struct ospf_lsdb
*lsdb
;
207 int external_origin
; /* AS-external-LSA origin flag. */
208 int ase_calc
; /* ASE calculation flag. */
210 #ifdef HAVE_OPAQUE_LSA
211 list opaque_lsa_self
; /* Type-11 Opaque-LSAs */
212 #endif /* HAVE_OPAQUE_LSA */
214 /* Routing tables. */
215 struct route_table
*old_table
; /* Old routing table. */
216 struct route_table
*new_table
; /* Current routing table. */
218 struct route_table
*old_rtrs
; /* Old ABR/ASBR RT. */
219 struct route_table
*new_rtrs
; /* New ABR/ASBR RT. */
221 struct route_table
*new_external_route
; /* New External Route. */
222 struct route_table
*old_external_route
; /* Old External Route. */
224 struct route_table
*external_lsas
; /* Database of external LSAs,
225 prefix is LSA's adv. network*/
228 time_t ts_spf
; /* SPF calculation time stamp. */
230 list maxage_lsa
; /* List of MaxAge LSA for deletion. */
231 int redistribute
; /* Num of redistributed protocols. */
234 struct thread
*t_router_id_update
; /* Router ID update timer. */
235 struct thread
*t_router_lsa_update
; /* router-LSA update timer. */
236 struct thread
*t_abr_task
; /* ABR task timer. */
237 struct thread
*t_asbr_check
; /* ASBR check timer. */
238 struct thread
*t_distribute_update
; /* Distirbute list update timer. */
239 struct thread
*t_spf_calc
; /* SPF calculation timer. */
240 struct thread
*t_ase_calc
; /* ASE calculation timer. */
241 struct thread
*t_external_lsa
; /* AS-external-LSA origin timer. */
242 #ifdef HAVE_OPAQUE_LSA
243 struct thread
*t_opaque_lsa_self
; /* Type-11 Opaque-LSAs origin event. */
244 #endif /* HAVE_OPAQUE_LSA */
245 struct thread
*t_maxage
; /* MaxAge LSA remover timer. */
246 struct thread
*t_maxage_walker
; /* MaxAge LSA checking timer. */
248 struct thread
*t_write
;
249 struct thread
*t_read
;
253 /* 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 /* Redistribute metric info. */
265 int type
; /* External metric type (E1 or E2). */
266 int value
; /* Value for static metric (24-bit).
267 -1 means metric value is not set. */
268 } dmetric
[ZEBRA_ROUTE_MAX
+ 1];
270 /* For redistribute route map. */
274 struct route_map
*map
;
275 } route_map
[ZEBRA_ROUTE_MAX
+ 1]; /* +1 is for default-information */
276 #define ROUTEMAP_NAME(O,T) (O)->route_map[T].name
277 #define ROUTEMAP(O,T) (O)->route_map[T].map
279 int default_metric
; /* Default metric for redistribute. */
281 #define OSPF_LSA_REFRESHER_GRANULARITY 10
282 #define OSPF_LSA_REFRESHER_SLOTS ((OSPF_LS_REFRESH_TIME + \
283 OSPF_LS_REFRESH_SHIFT)/10 + 1)
287 list qs
[OSPF_LSA_REFRESHER_SLOTS
];
290 struct thread
*t_lsa_refresher
;
291 time_t lsa_refresher_started
;
292 #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
293 u_int16_t lsa_refresh_interval
;
295 /* Distance parameter. */
297 u_char distance_intra
;
298 u_char distance_inter
;
299 u_char distance_external
;
301 /* Statistics for LSA origination. */
302 u_int32_t lsa_originate_count
;
304 /* Statistics for LSA used for new instantiation. */
305 u_int32_t rx_lsa_count
;
307 struct route_table
*distance_table
;
310 /* OSPF area structure. */
316 /* Zebra interface list belonging to the area. */
320 struct in_addr area_id
;
322 /* Area ID format. */
324 #define OSPF_AREA_ID_FORMAT_ADDRESS 1
325 #define OSPF_AREA_ID_FORMAT_DECIMAL 2
330 /* Configured variables. */
331 int external_routing
; /* ExternalRoutingCapability. */
332 #define OSPF_AREA_DEFAULT 0
333 #define OSPF_AREA_STUB 1
334 #define OSPF_AREA_NSSA 2
335 #define OSPF_AREA_TYPE_MAX 3
336 int no_summary
; /* Don't inject summaries into stub.*/
337 int shortcut_configured
; /* Area configured as shortcut. */
338 #define OSPF_SHORTCUT_DEFAULT 0
339 #define OSPF_SHORTCUT_ENABLE 1
340 #define OSPF_SHORTCUT_DISABLE 2
341 int shortcut_capability
; /* Other ABRs agree on S-bit */
342 u_int32_t default_cost
; /* StubDefaultCost. */
343 int auth_type
; /* Authentication type. */
345 u_char NSSATranslatorRole
; /* NSSA Role during configuration */
346 #define OSPF_NSSA_ROLE_NEVER 0
347 #define OSPF_NSSA_ROLE_ALWAYS 1
348 #define OSPF_NSSA_ROLE_CANDIDATE 2
349 u_char NSSATranslator
; /* NSSA Role after election process */
351 u_char transit
; /* TransitCapability. */
352 #define OSPF_TRANSIT_FALSE 0
353 #define OSPF_TRANSIT_TRUE 1
354 struct route_table
*ranges
; /* Configured Area Ranges. */
356 /* Area related LSDBs[Type1-4]. */
357 struct ospf_lsdb
*lsdb
;
359 /* Self-originated LSAs. */
360 struct ospf_lsa
*router_lsa_self
;
361 #ifdef HAVE_OPAQUE_LSA
362 list opaque_lsa_self
; /* Type-10 Opaque-LSAs */
363 #endif /* HAVE_OPAQUE_LSA */
365 /* Area announce list. */
369 struct access_list
*list
;
371 #define EXPORT_NAME(A) (A)->export.name
372 #define EXPORT_LIST(A) (A)->export.list
374 /* Area acceptance list. */
378 struct access_list
*list
;
380 #define IMPORT_NAME(A) (A)->import.name
381 #define IMPORT_LIST(A) (A)->import.list
383 /* Type 3 LSA Area prefix-list. */
387 struct prefix_list
*list
;
389 #define PREFIX_LIST_IN(A) (A)->plist_in.list
390 #define PREFIX_NAME_IN(A) (A)->plist_in.name
395 struct prefix_list
*list
;
397 #define PREFIX_LIST_OUT(A) (A)->plist_out.list
398 #define PREFIX_NAME_OUT(A) (A)->plist_out.name
400 /* Shortest Path Tree. */
404 struct thread
*t_router_lsa_self
;/* Self-originated router-LSA timer. */
405 #ifdef HAVE_OPAQUE_LSA
406 struct thread
*t_opaque_lsa_self
; /* Type-10 Opaque-LSAs origin. */
407 #endif /* HAVE_OPAQUE_LSA */
409 /* Statistics field. */
410 u_int32_t spf_calculation
; /* SPF Calculation Count. */
413 u_int32_t abr_count
; /* ABR router in this area. */
414 u_int32_t asbr_count
; /* ASBR router in this area. */
417 u_int32_t act_ints
; /* Active interfaces. */
418 u_int32_t full_nbrs
; /* Fully adjacent neighbors. */
419 u_int32_t full_vls
; /* Fully adjacent virtual neighbors. */
422 /* OSPF config network structure. */
426 struct in_addr area_id
;
430 /* OSPF NBMA neighbor structure. */
433 /* Neighbor IP address. */
436 /* OSPF interface. */
437 struct ospf_interface
*oi
;
439 /* OSPF neighbor structure. */
440 struct ospf_neighbor
*nbr
;
442 /* Neighbor priority. */
445 /* Poll timer value. */
448 /* Poll timer thread. */
449 struct thread
*t_poll
;
452 u_int32_t state_change
;
456 #define OSPF_AREA_SAME(X,Y) \
457 (memcmp ((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
459 #define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR)
460 #define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR)
462 #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
463 #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
466 # define ROUNDUP(val, gran) roundup(val, gran)
468 # define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1)
471 #define LSA_OPTIONS_GET(area) \
472 (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
474 #define LSA_NSSA_GET(area) \
475 (((area)->external_routing == OSPF_AREA_NSSA) ? \
476 (area)->NSSATranslator : 0)
477 #endif /* HAVE_NSSA */
479 #define OSPF_TIMER_ON(T,F,V) \
482 (T) = thread_add_timer (master, (F), ospf, (V)); \
485 #define OSPF_AREA_TIMER_ON(T,F,V) \
488 (T) = thread_add_timer (master, (F), area, (V)); \
491 #define OSPF_POLL_TIMER_ON(T,F,V) \
494 (T) = thread_add_timer (master, (F), nbr_nbma, (V)); \
497 #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X))
499 #define OSPF_TIMER_OFF(X) \
508 /* Extern variables. */
509 extern struct ospf_master
*om
;
510 extern struct message ospf_ism_state_msg
[];
511 extern struct message ospf_nsm_state_msg
[];
512 extern struct message ospf_lsa_type_msg
[];
513 extern struct message ospf_link_state_id_type_msg
[];
514 extern struct message ospf_redistributed_proto
[];
515 extern struct message ospf_network_type_msg
[];
516 extern int ospf_ism_state_msg_max
;
517 extern int ospf_nsm_state_msg_max
;
518 extern int ospf_lsa_type_msg_max
;
519 extern int ospf_link_state_id_type_msg_max
;
520 extern int ospf_redistributed_proto_max
;
521 extern int ospf_network_type_msg_max
;
522 extern struct zclient
*zclient
;
523 extern struct thread_master
*master
;
524 extern int ospf_zlog
;
527 struct ospf
*ospf_lookup ();
528 struct ospf
*ospf_get ();
529 void ospf_finish (struct ospf
*);
530 int ospf_router_id_update_timer (struct thread
*);
531 void ospf_router_id_update ();
532 int ospf_network_set (struct ospf
*, struct prefix_ipv4
*, struct in_addr
);
533 int ospf_network_unset (struct ospf
*, struct prefix_ipv4
*, struct in_addr
);
534 int ospf_area_stub_set (struct ospf
*, struct in_addr
);
535 int ospf_area_stub_unset (struct ospf
*, struct in_addr
);
536 int ospf_area_no_summary_set (struct ospf
*, struct in_addr
);
537 int ospf_area_no_summary_unset (struct ospf
*, struct in_addr
);
538 int ospf_area_nssa_set (struct ospf
*, struct in_addr
);
539 int ospf_area_nssa_unset (struct ospf
*, struct in_addr
);
540 int ospf_area_nssa_translator_role_set (struct ospf
*, struct in_addr
, int);
541 int ospf_area_export_list_set (struct ospf
*, struct ospf_area
*, char *);
542 int ospf_area_export_list_unset (struct ospf
*, struct ospf_area
*);
543 int ospf_area_import_list_set (struct ospf
*, struct ospf_area
*, char *);
544 int ospf_area_import_list_unset (struct ospf
*, struct ospf_area
*);
545 int ospf_area_shortcut_set (struct ospf
*, struct ospf_area
*, int);
546 int ospf_area_shortcut_unset (struct ospf
*, struct ospf_area
*);
547 int ospf_timers_spf_set (struct ospf
*, u_int32_t
, u_int32_t
);
548 int ospf_timers_spf_unset (struct ospf
*);
549 int ospf_timers_refresh_set (struct ospf
*, int);
550 int ospf_timers_refresh_unset (struct ospf
*);
551 int ospf_nbr_nbma_set (struct ospf
*, struct in_addr
);
552 int ospf_nbr_nbma_unset (struct ospf
*, struct in_addr
);
553 int ospf_nbr_nbma_priority_set (struct ospf
*, struct in_addr
, u_char
);
554 int ospf_nbr_nbma_priority_unset (struct ospf
*, struct in_addr
);
555 int ospf_nbr_nbma_poll_interval_set (struct ospf
*, struct in_addr
, int);
556 int ospf_nbr_nbma_poll_interval_unset (struct ospf
*, struct in_addr
);
557 void ospf_prefix_list_update (struct prefix_list
*);
559 void ospf_if_update (struct ospf
*);
560 void ospf_ls_upd_queue_empty (struct ospf_interface
*);
561 void ospf_terminate ();
562 void ospf_nbr_nbma_if_update (struct ospf
*, struct ospf_interface
*);
563 struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup (struct ospf
*, struct in_addr
);
564 struct ospf_nbr_nbma
*ospf_nbr_nbma_lookup_next (struct ospf
*,
565 struct in_addr
*, int);
566 int ospf_oi_count (struct interface
*);
568 struct ospf_area
*ospf_area_get (struct ospf
*, struct in_addr
, int);
569 void ospf_area_check_free (struct ospf
*, struct in_addr
);
570 struct ospf_area
*ospf_area_lookup_by_area_id (struct ospf
*, struct in_addr
);
571 void ospf_area_add_if (struct ospf_area
*, struct ospf_interface
*);
572 void ospf_area_del_if (struct ospf_area
*, struct ospf_interface
*);
574 void ospf_route_map_init ();
575 void ospf_snmp_init ();
577 void ospf_master_init ();
579 #endif /* _ZEBRA_OSPFD_H */