]> git.proxmox.com Git - mirror_frr.git/blob - ospfd/ospfd.h
Merge pull request #563 from qlyoung/enforce-no-pthread-cancellation
[mirror_frr.git] / ospfd / ospfd.h
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.
11 *
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 *
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
20 */
21
22 #ifndef _ZEBRA_OSPFD_H
23 #define _ZEBRA_OSPFD_H
24
25 #include <zebra.h>
26 #include "qobj.h"
27 #include "libospf.h"
28
29 #include "filter.h"
30 #include "log.h"
31
32 #include "ospf_memory.h"
33 #include "ospf_dump_api.h"
34
35 #define OSPF_VERSION 2
36
37 /* VTY port number. */
38 #define OSPF_VTY_PORT 2604
39
40 /* IP TTL for OSPF protocol. */
41 #define OSPF_IP_TTL 1
42 #define OSPF_VL_IP_TTL 100
43
44 /* Default configuration file name for ospfd. */
45 #define OSPF_DEFAULT_CONFIG "ospfd.conf"
46
47 #define OSPF_NSSA_TRANS_STABLE_DEFAULT 40
48
49 #define OSPF_ALLSPFROUTERS 0xe0000005 /* 224.0.0.5 */
50 #define OSPF_ALLDROUTERS 0xe0000006 /* 224.0.0.6 */
51
52
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
63
64 /* OSPF options. */
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
73
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
79
80 #define OSPF_LS_REFRESH_SHIFT (60 * 15)
81 #define OSPF_LS_REFRESH_JITTER 60
82
83 struct ospf_external
84 {
85 u_short instance;
86 struct route_table *external_info;
87 };
88
89 /* OSPF master for system wide configuration and variables. */
90 struct ospf_master
91 {
92 /* OSPF instance. */
93 struct list *ospf;
94
95 /* OSPF thread master. */
96 struct thread_master *master;
97
98 /* Zebra interface list. */
99 struct list *iflist;
100
101 /* Redistributed external information. */
102 struct list *external[ZEBRA_ROUTE_MAX + 1];
103 #define EXTERNAL_INFO(E) (E->external_info)
104
105 /* Various OSPF global configuration. */
106 u_char options;
107 #define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
108 };
109
110 struct ospf_redist
111 {
112 u_short instance;
113
114 /* Redistribute metric info. */
115 struct
116 {
117 int type; /* External metric type (E1 or E2). */
118 int value; /* Value for static metric (24-bit).
119 -1 means metric value is not set. */
120 } dmetric;
121
122 /* For redistribute route map. */
123 struct
124 {
125 char *name;
126 struct route_map *map;
127 } route_map; /* +1 is for default-information */
128 #define ROUTEMAP_NAME(R) (R->route_map.name)
129 #define ROUTEMAP(R) (R->route_map.map)
130 };
131
132 /* OSPF instance structure. */
133 struct ospf
134 {
135 /* OSPF's running state based on the '[no] router ospf [<instance>]' config. */
136 u_char oi_running;
137
138 /* OSPF instance ID */
139 u_short instance;
140
141 /* OSPF Router ID. */
142 struct in_addr router_id; /* Configured automatically. */
143 struct in_addr router_id_static; /* Configured manually. */
144
145 /* ABR/ASBR internal flags. */
146 u_char flags;
147 #define OSPF_FLAG_ABR 0x0001
148 #define OSPF_FLAG_ASBR 0x0002
149
150 /* ABR type. */
151 u_char abr_type;
152 #define OSPF_ABR_UNKNOWN 0
153 #define OSPF_ABR_STAND 1
154 #define OSPF_ABR_IBM 2
155 #define OSPF_ABR_CISCO 3
156 #define OSPF_ABR_SHORTCUT 4
157 #define OSPF_ABR_DEFAULT OSPF_ABR_CISCO
158
159 /* NSSA ABR */
160 u_char anyNSSA; /* Bump for every NSSA attached. */
161
162 /* Configured variables. */
163 u_char config;
164 #define OSPF_RFC1583_COMPATIBLE (1 << 0)
165 #define OSPF_OPAQUE_CAPABLE (1 << 2)
166 #define OSPF_LOG_ADJACENCY_CHANGES (1 << 3)
167 #define OSPF_LOG_ADJACENCY_DETAIL (1 << 4)
168
169 /* Opaque-LSA administrative flags. */
170 u_char opaque;
171 #define OPAQUE_OPERATION_READY_BIT (1 << 0)
172
173 /* RFC3137 stub router. Configured time to stay stub / max-metric */
174 unsigned int stub_router_startup_time; /* seconds */
175 unsigned int stub_router_shutdown_time; /* seconds */
176 #define OSPF_STUB_ROUTER_UNCONFIGURED 0
177 u_char stub_router_admin_set;
178 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_SET 1
179 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_UNSET 0
180
181 #define OSPF_STUB_MAX_METRIC_SUMMARY_COST 0x00ff0000
182
183 /* LSA timers */
184 unsigned int min_ls_interval; /* minimum delay between LSAs (in msec) */
185 unsigned int min_ls_arrival; /* minimum interarrival time between LSAs (in msec) */
186
187 /* SPF parameters */
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 */
191 unsigned int spf_hold_multiplier; /* Adaptive multiplier for hold time */
192
193 int default_originate; /* Default information originate. */
194 #define DEFAULT_ORIGINATE_NONE 0
195 #define DEFAULT_ORIGINATE_ZEBRA 1
196 #define DEFAULT_ORIGINATE_ALWAYS 2
197 u_int32_t ref_bandwidth; /* Reference Bandwidth (Kbps). */
198 struct route_table *networks; /* OSPF config networks. */
199 struct list *vlinks; /* Configured Virtual-Links. */
200 struct list *areas; /* OSPF areas. */
201 struct route_table *nbr_nbma;
202 struct ospf_area *backbone; /* Pointer to the Backbone Area. */
203
204 struct list *oiflist; /* ospf interfaces */
205 u_char passive_interface_default; /* passive-interface default */
206
207 /* LSDB of AS-external-LSAs. */
208 struct ospf_lsdb *lsdb;
209
210 /* Flags. */
211 int external_origin; /* AS-external-LSA origin flag. */
212 int ase_calc; /* ASE calculation flag. */
213
214 struct list *opaque_lsa_self; /* Type-11 Opaque-LSAs */
215
216 /* Routing tables. */
217 struct route_table *old_table; /* Old routing table. */
218 struct route_table *new_table; /* Current routing table. */
219
220 struct route_table *old_rtrs; /* Old ABR/ASBR RT. */
221 struct route_table *new_rtrs; /* New ABR/ASBR RT. */
222
223 struct route_table *new_external_route; /* New External Route. */
224 struct route_table *old_external_route; /* Old External Route. */
225
226 struct route_table *external_lsas; /* Database of external LSAs,
227 prefix is LSA's adv. network*/
228
229 /* Time stamps */
230 struct timeval ts_spf; /* SPF calculation time stamp. */
231 struct timeval ts_spf_duration; /* Execution time of last SPF */
232
233 struct route_table *maxage_lsa; /* List of MaxAge LSA for deletion. */
234 int redistribute; /* Num of redistributed protocols. */
235
236 /* Threads. */
237 struct thread *t_abr_task; /* ABR task timer. */
238 struct thread *t_asbr_check; /* ASBR check timer. */
239 struct thread *t_distribute_update; /* Distirbute list update timer. */
240 struct thread *t_spf_calc; /* SPF calculation timer. */
241 struct thread *t_ase_calc; /* ASE calculation timer. */
242 struct thread *t_external_lsa; /* AS-external-LSA origin timer. */
243 struct thread *t_opaque_lsa_self; /* Type-11 Opaque-LSAs origin event. */
244
245 unsigned int maxage_delay; /* Delay on Maxage remover timer, sec */
246 struct thread *t_maxage; /* MaxAge LSA remover timer. */
247 struct thread *t_maxage_walker; /* MaxAge LSA checking timer. */
248
249 struct thread *t_deferred_shutdown; /* deferred/stub-router shutdown timer*/
250
251 struct thread *t_write;
252 #define OSPF_WRITE_INTERFACE_COUNT_DEFAULT 20
253 int write_oi_count; /* Num of packets sent per thread invocation */
254 struct thread *t_read;
255 int fd;
256 struct stream *ibuf;
257 struct list *oi_write_q;
258
259 /* Distribute lists out of other route sources. */
260 struct
261 {
262 char *name;
263 struct access_list *list;
264 } dlist[ZEBRA_ROUTE_MAX];
265 #define DISTRIBUTE_NAME(O,T) (O)->dlist[T].name
266 #define DISTRIBUTE_LIST(O,T) (O)->dlist[T].list
267
268 /* OSPF redistribute configuration */
269 struct list *redist[ZEBRA_ROUTE_MAX + 1];
270
271 /* Redistribute tag info. */
272 route_tag_t dtag[ZEBRA_ROUTE_MAX + 1]; //Pending: cant configure as of now
273
274 int default_metric; /* Default metric for redistribute. */
275
276 #define OSPF_LSA_REFRESHER_GRANULARITY 10
277 #define OSPF_LSA_REFRESHER_SLOTS ((OSPF_LS_REFRESH_TIME + \
278 OSPF_LS_REFRESH_SHIFT)/OSPF_LSA_REFRESHER_GRANULARITY + 1)
279 struct
280 {
281 u_int16_t index;
282 struct list *qs[OSPF_LSA_REFRESHER_SLOTS];
283 } lsa_refresh_queue;
284
285 struct thread *t_lsa_refresher;
286 time_t lsa_refresher_started;
287 #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
288 u_int16_t lsa_refresh_interval;
289
290 /* Distance parameter. */
291 u_char distance_all;
292 u_char distance_intra;
293 u_char distance_inter;
294 u_char distance_external;
295
296 /* Statistics for LSA origination. */
297 u_int32_t lsa_originate_count;
298
299 /* Statistics for LSA used for new instantiation. */
300 u_int32_t rx_lsa_count;
301
302 /* Counter of "ip ospf area x.x.x.x" */
303 u_int32_t if_ospf_cli_count;
304
305 struct route_table *distance_table;
306
307 QOBJ_FIELDS
308 };
309 DECLARE_QOBJ_TYPE(ospf)
310
311 /* OSPF area structure. */
312 struct ospf_area
313 {
314 /* OSPF instance. */
315 struct ospf *ospf;
316
317 /* Zebra interface list belonging to the area. */
318 struct list *oiflist;
319
320 /* Area ID. */
321 struct in_addr area_id;
322
323 /* Area ID format. */
324 int area_id_fmt;
325 #define OSPF_AREA_ID_FMT_DOTTEDQUAD 1
326 #define OSPF_AREA_ID_FMT_DECIMAL 2
327
328 /* Address range. */
329 struct list *address_range;
330
331 /* Configured variables. */
332 int external_routing; /* ExternalRoutingCapability. */
333 int no_summary; /* Don't inject summaries into stub.*/
334 int shortcut_configured; /* Area configured as shortcut. */
335 #define OSPF_SHORTCUT_DEFAULT 0
336 #define OSPF_SHORTCUT_ENABLE 1
337 #define OSPF_SHORTCUT_DISABLE 2
338 int shortcut_capability; /* Other ABRs agree on S-bit */
339 u_int32_t default_cost; /* StubDefaultCost. */
340 int auth_type; /* Authentication type. */
341
342
343 u_char NSSATranslatorRole; /* NSSA configured role */
344 #define OSPF_NSSA_ROLE_NEVER 0
345 #define OSPF_NSSA_ROLE_CANDIDATE 1
346 #define OSPF_NSSA_ROLE_ALWAYS 2
347 u_char NSSATranslatorState; /* NSSA operational role */
348 #define OSPF_NSSA_TRANSLATE_DISABLED 0
349 #define OSPF_NSSA_TRANSLATE_ENABLED 1
350 int NSSATranslatorStabilityInterval;
351
352 u_char transit; /* TransitCapability. */
353 #define OSPF_TRANSIT_FALSE 0
354 #define OSPF_TRANSIT_TRUE 1
355 struct route_table *ranges; /* Configured Area Ranges. */
356
357 /* RFC3137 stub router state flags for area */
358 u_char stub_router_state;
359 #define OSPF_AREA_ADMIN_STUB_ROUTED (1 << 0) /* admin stub-router set */
360 #define OSPF_AREA_IS_STUB_ROUTED (1 << 1) /* stub-router active */
361 #define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */
362
363 /* Area related LSDBs[Type1-4]. */
364 struct ospf_lsdb *lsdb;
365
366 /* Self-originated LSAs. */
367 struct ospf_lsa *router_lsa_self;
368 struct list *opaque_lsa_self; /* Type-10 Opaque-LSAs */
369
370 /* Area announce list. */
371 struct
372 {
373 char *name;
374 struct access_list *list;
375 } _export;
376 #define EXPORT_NAME(A) (A)->_export.name
377 #define EXPORT_LIST(A) (A)->_export.list
378
379 /* Area acceptance list. */
380 struct
381 {
382 char *name;
383 struct access_list *list;
384 } import;
385 #define IMPORT_NAME(A) (A)->import.name
386 #define IMPORT_LIST(A) (A)->import.list
387
388 /* Type 3 LSA Area prefix-list. */
389 struct
390 {
391 char *name;
392 struct prefix_list *list;
393 } plist_in;
394 #define PREFIX_LIST_IN(A) (A)->plist_in.list
395 #define PREFIX_NAME_IN(A) (A)->plist_in.name
396
397 struct
398 {
399 char *name;
400 struct prefix_list *list;
401 } plist_out;
402 #define PREFIX_LIST_OUT(A) (A)->plist_out.list
403 #define PREFIX_NAME_OUT(A) (A)->plist_out.name
404
405 /* Shortest Path Tree. */
406 struct vertex *spf;
407
408 /* Threads. */
409 struct thread *t_stub_router; /* Stub-router timer */
410 struct thread *t_opaque_lsa_self; /* Type-10 Opaque-LSAs origin. */
411
412 /* Statistics field. */
413 u_int32_t spf_calculation; /* SPF Calculation Count. */
414
415 /* Time stamps. */
416 struct timeval ts_spf; /* SPF calculation time stamp. */
417
418 /* Router count. */
419 u_int32_t abr_count; /* ABR router in this area. */
420 u_int32_t asbr_count; /* ASBR router in this area. */
421
422 /* Counters. */
423 u_int32_t act_ints; /* Active interfaces. */
424 u_int32_t full_nbrs; /* Fully adjacent neighbors. */
425 u_int32_t full_vls; /* Fully adjacent virtual neighbors. */
426 };
427
428 /* OSPF config network structure. */
429 struct ospf_network
430 {
431 /* Area ID. */
432 struct in_addr area_id;
433 int area_id_fmt;
434 };
435
436 /* OSPF NBMA neighbor structure. */
437 struct ospf_nbr_nbma
438 {
439 /* Neighbor IP address. */
440 struct in_addr addr;
441
442 /* OSPF interface. */
443 struct ospf_interface *oi;
444
445 /* OSPF neighbor structure. */
446 struct ospf_neighbor *nbr;
447
448 /* Neighbor priority. */
449 u_char priority;
450
451 /* Poll timer value. */
452 u_int32_t v_poll;
453
454 /* Poll timer thread. */
455 struct thread *t_poll;
456
457 /* State change. */
458 u_int32_t state_change;
459 };
460
461 /* Macro. */
462 #define OSPF_AREA_SAME(X,Y) \
463 (memcmp ((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
464
465 #define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR)
466 #define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR)
467
468 #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
469 #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
470
471 #ifdef roundup
472 # define ROUNDUP(val, gran) roundup(val, gran)
473 #else /* roundup */
474 # define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1)
475 #endif /* roundup */
476
477 #define LSA_OPTIONS_GET(area) \
478 (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
479 #define LSA_OPTIONS_NSSA_GET(area) \
480 (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0)
481
482 #define OSPF_TIMER_ON(T,F,V) thread_add_timer (master,(F),ospf,(V),&(T))
483 #define OSPF_AREA_TIMER_ON(T,F,V) thread_add_timer (master, (F), area, (V), &(T))
484 #define OSPF_POLL_TIMER_ON(T,F,V) thread_add_timer (master, (F), nbr_nbma, (V), &(T))
485 #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X))
486 #define OSPF_TIMER_OFF(X) \
487 do { \
488 if (X) \
489 { \
490 thread_cancel (X); \
491 (X) = NULL; \
492 } \
493 } while (0)
494
495 /* Extern variables. */
496 extern struct ospf_master *om;
497 extern const int ospf_redistributed_proto_max;
498 extern struct zclient *zclient;
499 extern struct thread_master *master;
500 extern int ospf_zlog;
501
502 /* Prototypes. */
503 extern const char *ospf_redist_string(u_int route_type);
504 extern struct ospf *ospf_lookup (void);
505 extern struct ospf *ospf_lookup_instance (u_short);
506 extern struct ospf *ospf_get (void);
507 extern struct ospf *ospf_get_instance (u_short);
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 *,
511 struct in_addr, int);
512 extern int ospf_network_unset (struct ospf *, struct prefix_ipv4 *,
513 struct in_addr);
514 extern int ospf_area_display_format_set (struct ospf *, struct ospf_area *area,
515 int df);
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);
522 extern int ospf_area_nssa_translator_role_set (struct ospf *, struct in_addr,
523 int);
524 extern int ospf_area_export_list_set (struct ospf *, struct ospf_area *,
525 const char *);
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 *,
528 const char *);
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, u_char);
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,
539 unsigned int);
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 *,
548 struct in_addr);
549 extern struct ospf_nbr_nbma *ospf_nbr_nbma_lookup_next (struct ospf *,
550 struct in_addr *,
551 int);
552 extern int ospf_oi_count (struct interface *);
553
554 extern struct ospf_area *ospf_area_get (struct ospf *, struct in_addr);
555 extern void ospf_area_check_free (struct ospf *, struct in_addr);
556 extern struct ospf_area *ospf_area_lookup_by_area_id (struct ospf *,
557 struct in_addr);
558 extern void ospf_area_add_if (struct ospf_area *, struct ospf_interface *);
559 extern void ospf_area_del_if (struct ospf_area *, struct ospf_interface *);
560
561 extern void ospf_route_map_init (void);
562
563 extern void ospf_master_init (struct thread_master *master);
564
565 extern int ospf_interface_set (struct interface *ifp, struct in_addr area_id);
566 extern int ospf_interface_unset (struct interface *ifp);
567 #endif /* _ZEBRA_OSPFD_H */