]> git.proxmox.com Git - mirror_frr.git/blob - ospfd/ospfd.h
b49bbdc17dfd33ae1a09acafa19c4953c0eb7ce6
[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 /* OSPF Authentication Type. */
53 #define OSPF_AUTH_NULL 0
54 #define OSPF_AUTH_SIMPLE 1
55 #define OSPF_AUTH_CRYPTOGRAPHIC 2
56 /* For Interface authentication setting default */
57 #define OSPF_AUTH_NOTSET -1
58 /* For the consumption and sanity of the command handler */
59 /* DO NIOT REMOVE!!! Need to detect whether a value has
60 been given or not in VLink command handlers */
61 #define OSPF_AUTH_CMD_NOTSEEN -2
62
63 /* OSPF options. */
64 #define OSPF_OPTION_MT 0x01 /* M/T */
65 #define OSPF_OPTION_E 0x02
66 #define OSPF_OPTION_MC 0x04
67 #define OSPF_OPTION_NP 0x08
68 #define OSPF_OPTION_EA 0x10
69 #define OSPF_OPTION_DC 0x20
70 #define OSPF_OPTION_O 0x40
71 #define OSPF_OPTION_DN 0x80
72
73 /* OSPF Database Description flags. */
74 #define OSPF_DD_FLAG_MS 0x01
75 #define OSPF_DD_FLAG_M 0x02
76 #define OSPF_DD_FLAG_I 0x04
77 #define OSPF_DD_FLAG_ALL 0x07
78
79 #define OSPF_LS_REFRESH_SHIFT (60 * 15)
80 #define OSPF_LS_REFRESH_JITTER 60
81
82 struct ospf_external {
83 u_short instance;
84 struct route_table *external_info;
85 };
86
87 /* OSPF master for system wide configuration and variables. */
88 struct ospf_master {
89 /* OSPF instance. */
90 struct list *ospf;
91
92 /* OSPF thread master. */
93 struct thread_master *master;
94
95 /* Zebra interface list. */
96 struct list *iflist;
97
98 /* Redistributed external information. */
99 struct list *external[ZEBRA_ROUTE_MAX + 1];
100 #define EXTERNAL_INFO(E) (E->external_info)
101
102 /* Various OSPF global configuration. */
103 u_char options;
104 #define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
105 };
106
107 struct ospf_redist {
108 u_short instance;
109
110 /* Redistribute metric info. */
111 struct {
112 int type; /* External metric type (E1 or E2). */
113 int value; /* Value for static metric (24-bit).
114 -1 means metric value is not set. */
115 } dmetric;
116
117 /* For redistribute route map. */
118 struct {
119 char *name;
120 struct route_map *map;
121 } route_map; /* +1 is for default-information */
122 #define ROUTEMAP_NAME(R) (R->route_map.name)
123 #define ROUTEMAP(R) (R->route_map.map)
124 };
125
126 /* OSPF instance structure. */
127 struct ospf {
128 /* OSPF's running state based on the '[no] router ospf [<instance>]'
129 * config. */
130 u_char oi_running;
131
132 /* OSPF instance ID */
133 u_short instance;
134
135 /* OSPF Router ID. */
136 struct in_addr router_id; /* Configured automatically. */
137 struct in_addr router_id_static; /* Configured manually. */
138
139 /* ABR/ASBR internal flags. */
140 u_char flags;
141 #define OSPF_FLAG_ABR 0x0001
142 #define OSPF_FLAG_ASBR 0x0002
143
144 /* ABR type. */
145 u_char abr_type;
146 #define OSPF_ABR_UNKNOWN 0
147 #define OSPF_ABR_STAND 1
148 #define OSPF_ABR_IBM 2
149 #define OSPF_ABR_CISCO 3
150 #define OSPF_ABR_SHORTCUT 4
151 #define OSPF_ABR_DEFAULT OSPF_ABR_CISCO
152
153 /* NSSA ABR */
154 u_char anyNSSA; /* Bump for every NSSA attached. */
155
156 /* Configured variables. */
157 u_char config;
158 #define OSPF_RFC1583_COMPATIBLE (1 << 0)
159 #define OSPF_OPAQUE_CAPABLE (1 << 2)
160 #define OSPF_LOG_ADJACENCY_CHANGES (1 << 3)
161 #define OSPF_LOG_ADJACENCY_DETAIL (1 << 4)
162
163 /* Opaque-LSA administrative flags. */
164 u_char opaque;
165 #define OPAQUE_OPERATION_READY_BIT (1 << 0)
166
167 /* RFC3137 stub router. Configured time to stay stub / max-metric */
168 unsigned int stub_router_startup_time; /* seconds */
169 unsigned int stub_router_shutdown_time; /* seconds */
170 /* $FRR indent$ */
171 /* clang-format off */
172 #define OSPF_STUB_ROUTER_UNCONFIGURED 0
173 u_char stub_router_admin_set;
174 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_SET 1
175 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_UNSET 0
176
177 #define OSPF_STUB_MAX_METRIC_SUMMARY_COST 0x00ff0000
178
179 /* LSA timers */
180 unsigned int min_ls_interval; /* minimum delay between LSAs (in msec) */
181 unsigned int min_ls_arrival; /* minimum interarrival time between LSAs
182 (in msec) */
183
184 /* SPF parameters */
185 unsigned int spf_delay; /* SPF delay time. */
186 unsigned int spf_holdtime; /* SPF hold time. */
187 unsigned int spf_max_holdtime; /* SPF maximum-holdtime */
188 unsigned int
189 spf_hold_multiplier; /* Adaptive multiplier for hold time */
190
191 int default_originate; /* Default information originate. */
192 /* $FRR indent$ */
193 /* clang-format off */
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
244 *t_opaque_lsa_self; /* Type-11 Opaque-LSAs origin event. */
245
246 unsigned int maxage_delay; /* Delay on Maxage remover timer, sec */
247 struct thread *t_maxage; /* MaxAge LSA remover timer. */
248 struct thread *t_maxage_walker; /* MaxAge LSA checking timer. */
249
250 struct thread
251 *t_deferred_shutdown; /* deferred/stub-router shutdown timer*/
252
253 struct thread *t_write;
254 #define OSPF_WRITE_INTERFACE_COUNT_DEFAULT 20
255 int write_oi_count; /* Num of packets sent per thread invocation */
256 struct thread *t_read;
257 int fd;
258 struct stream *ibuf;
259 struct list *oi_write_q;
260
261 /* Distribute lists out of other route sources. */
262 struct {
263 char *name;
264 struct access_list *list;
265 } dlist[ZEBRA_ROUTE_MAX];
266 #define DISTRIBUTE_NAME(O,T) (O)->dlist[T].name
267 #define DISTRIBUTE_LIST(O,T) (O)->dlist[T].list
268
269 /* OSPF redistribute configuration */
270 struct list *redist[ZEBRA_ROUTE_MAX + 1];
271
272 /* Redistribute tag info. */
273 route_tag_t
274 dtag[ZEBRA_ROUTE_MAX + 1]; // Pending: cant configure as of now
275
276 int default_metric; /* Default metric for redistribute. */
277
278 #define OSPF_LSA_REFRESHER_GRANULARITY 10
279 #define OSPF_LSA_REFRESHER_SLOTS \
280 ((OSPF_LS_REFRESH_TIME + OSPF_LS_REFRESH_SHIFT) \
281 / OSPF_LSA_REFRESHER_GRANULARITY \
282 + 1)
283 struct {
284 u_int16_t index;
285 struct list *qs[OSPF_LSA_REFRESHER_SLOTS];
286 } lsa_refresh_queue;
287
288 struct thread *t_lsa_refresher;
289 time_t lsa_refresher_started;
290 #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
291 u_int16_t lsa_refresh_interval;
292
293 /* Distance parameter. */
294 u_char distance_all;
295 u_char distance_intra;
296 u_char distance_inter;
297 u_char distance_external;
298
299 /* Statistics for LSA origination. */
300 u_int32_t lsa_originate_count;
301
302 /* Statistics for LSA used for new instantiation. */
303 u_int32_t rx_lsa_count;
304
305 /* Counter of "ip ospf area x.x.x.x" */
306 u_int32_t if_ospf_cli_count;
307
308 struct route_table *distance_table;
309
310 QOBJ_FIELDS
311 };
312 DECLARE_QOBJ_TYPE(ospf)
313
314 /* OSPF area structure. */
315 struct ospf_area {
316 /* OSPF instance. */
317 struct ospf *ospf;
318
319 /* Zebra interface list belonging to the area. */
320 struct list *oiflist;
321
322 /* Area ID. */
323 struct in_addr area_id;
324
325 /* Area ID format. */
326 int area_id_fmt;
327 #define OSPF_AREA_ID_FMT_DOTTEDQUAD 1
328 #define OSPF_AREA_ID_FMT_DECIMAL 2
329
330 /* Address range. */
331 struct list *address_range;
332
333 /* Configured variables. */
334 int external_routing; /* ExternalRoutingCapability. */
335 int no_summary; /* Don't inject summaries into stub.*/
336 int shortcut_configured; /* Area configured as shortcut. */
337 /* $FRR indent$ */
338 /* clang-format off */
339 #define OSPF_SHORTCUT_DEFAULT 0
340 #define OSPF_SHORTCUT_ENABLE 1
341 #define OSPF_SHORTCUT_DISABLE 2
342 int shortcut_capability; /* Other ABRs agree on S-bit */
343 u_int32_t default_cost; /* StubDefaultCost. */
344 int auth_type; /* Authentication type. */
345
346
347 u_char NSSATranslatorRole; /* NSSA configured role */
348 /* $FRR indent$ */
349 /* clang-format off */
350 #define OSPF_NSSA_ROLE_NEVER 0
351 #define OSPF_NSSA_ROLE_CANDIDATE 1
352 #define OSPF_NSSA_ROLE_ALWAYS 2
353 u_char NSSATranslatorState; /* NSSA operational role */
354 /* $FRR indent$ */
355 /* clang-format off */
356 #define OSPF_NSSA_TRANSLATE_DISABLED 0
357 #define OSPF_NSSA_TRANSLATE_ENABLED 1
358 int NSSATranslatorStabilityInterval;
359
360 u_char transit; /* TransitCapability. */
361 /* $FRR indent$ */
362 /* clang-format off */
363 #define OSPF_TRANSIT_FALSE 0
364 #define OSPF_TRANSIT_TRUE 1
365 struct route_table *ranges; /* Configured Area Ranges. */
366
367 /* RFC3137 stub router state flags for area */
368 u_char stub_router_state;
369 #define OSPF_AREA_ADMIN_STUB_ROUTED (1 << 0) /* admin stub-router set */
370 #define OSPF_AREA_IS_STUB_ROUTED (1 << 1) /* stub-router active */
371 #define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */
372 /* Area related LSDBs[Type1-4]. */
373 struct ospf_lsdb *lsdb;
374
375 /* Self-originated LSAs. */
376 struct ospf_lsa *router_lsa_self;
377 struct list *opaque_lsa_self; /* Type-10 Opaque-LSAs */
378
379 /* Area announce list. */
380 struct {
381 char *name;
382 struct access_list *list;
383 } _export;
384 #define EXPORT_NAME(A) (A)->_export.name
385 #define EXPORT_LIST(A) (A)->_export.list
386
387 /* Area acceptance list. */
388 struct {
389 char *name;
390 struct access_list *list;
391 } import;
392 #define IMPORT_NAME(A) (A)->import.name
393 #define IMPORT_LIST(A) (A)->import.list
394
395 /* Type 3 LSA Area prefix-list. */
396 struct {
397 char *name;
398 struct prefix_list *list;
399 } plist_in;
400 #define PREFIX_LIST_IN(A) (A)->plist_in.list
401 #define PREFIX_NAME_IN(A) (A)->plist_in.name
402
403 struct {
404 char *name;
405 struct prefix_list *list;
406 } plist_out;
407 #define PREFIX_LIST_OUT(A) (A)->plist_out.list
408 #define PREFIX_NAME_OUT(A) (A)->plist_out.name
409
410 /* Shortest Path Tree. */
411 struct vertex *spf;
412
413 /* Threads. */
414 struct thread *t_stub_router; /* Stub-router timer */
415 struct thread *t_opaque_lsa_self; /* Type-10 Opaque-LSAs origin. */
416
417 /* Statistics field. */
418 u_int32_t spf_calculation; /* SPF Calculation Count. */
419
420 /* Time stamps. */
421 struct timeval ts_spf; /* SPF calculation time stamp. */
422
423 /* Router count. */
424 u_int32_t abr_count; /* ABR router in this area. */
425 u_int32_t asbr_count; /* ASBR router in this area. */
426
427 /* Counters. */
428 u_int32_t act_ints; /* Active interfaces. */
429 u_int32_t full_nbrs; /* Fully adjacent neighbors. */
430 u_int32_t full_vls; /* Fully adjacent virtual neighbors. */
431 };
432
433 /* OSPF config network structure. */
434 struct ospf_network {
435 /* Area ID. */
436 struct in_addr area_id;
437 int area_id_fmt;
438 };
439
440 /* OSPF NBMA neighbor structure. */
441 struct ospf_nbr_nbma {
442 /* Neighbor IP address. */
443 struct in_addr addr;
444
445 /* OSPF interface. */
446 struct ospf_interface *oi;
447
448 /* OSPF neighbor structure. */
449 struct ospf_neighbor *nbr;
450
451 /* Neighbor priority. */
452 u_char priority;
453
454 /* Poll timer value. */
455 u_int32_t v_poll;
456
457 /* Poll timer thread. */
458 struct thread *t_poll;
459
460 /* State change. */
461 u_int32_t state_change;
462 };
463
464 /* Macro. */
465 #define OSPF_AREA_SAME(X, Y) \
466 (memcmp((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
467
468 #define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR)
469 #define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR)
470
471 #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
472 #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
473
474 #ifdef roundup
475 # define ROUNDUP(val, gran) roundup(val, gran)
476 #else /* roundup */
477 # define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1)
478 #endif /* roundup */
479
480 #define LSA_OPTIONS_GET(area) \
481 (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
482 #define LSA_OPTIONS_NSSA_GET(area) \
483 (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0)
484
485 #define OSPF_TIMER_ON(T,F,V) thread_add_timer (master,(F),ospf,(V),&(T))
486 #define OSPF_AREA_TIMER_ON(T,F,V) thread_add_timer (master, (F), area, (V), &(T))
487 #define OSPF_POLL_TIMER_ON(T,F,V) thread_add_timer (master, (F), nbr_nbma, (V), &(T))
488 #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X))
489 #define OSPF_TIMER_OFF(X) \
490 do { \
491 if (X) { \
492 thread_cancel(X); \
493 (X) = NULL; \
494 } \
495 } while (0)
496
497 /* Extern variables. */
498 extern struct ospf_master *om;
499 extern const int ospf_redistributed_proto_max;
500 extern struct zclient *zclient;
501 extern struct thread_master *master;
502 extern int ospf_zlog;
503
504 /* Prototypes. */
505 extern const char *ospf_redist_string(u_int route_type);
506 extern struct ospf *ospf_lookup(void);
507 extern struct ospf *ospf_lookup_instance(u_short);
508 extern struct ospf *ospf_get(void);
509 extern struct ospf *ospf_get_instance(u_short);
510 extern void ospf_finish(struct ospf *);
511 extern void ospf_router_id_update(struct ospf *ospf);
512 extern int ospf_network_set(struct ospf *, struct prefix_ipv4 *, struct in_addr,
513 int);
514 extern int ospf_network_unset(struct ospf *, struct prefix_ipv4 *,
515 struct in_addr);
516 extern int ospf_area_display_format_set(struct ospf *, struct ospf_area *area,
517 int df);
518 extern int ospf_area_stub_set(struct ospf *, struct in_addr);
519 extern int ospf_area_stub_unset(struct ospf *, struct in_addr);
520 extern int ospf_area_no_summary_set(struct ospf *, struct in_addr);
521 extern int ospf_area_no_summary_unset(struct ospf *, struct in_addr);
522 extern int ospf_area_nssa_set(struct ospf *, struct in_addr);
523 extern int ospf_area_nssa_unset(struct ospf *, struct in_addr);
524 extern int ospf_area_nssa_translator_role_set(struct ospf *, struct in_addr,
525 int);
526 extern int ospf_area_export_list_set(struct ospf *, struct ospf_area *,
527 const char *);
528 extern int ospf_area_export_list_unset(struct ospf *, struct ospf_area *);
529 extern int ospf_area_import_list_set(struct ospf *, struct ospf_area *,
530 const char *);
531 extern int ospf_area_import_list_unset(struct ospf *, struct ospf_area *);
532 extern int ospf_area_shortcut_set(struct ospf *, struct ospf_area *, int);
533 extern int ospf_area_shortcut_unset(struct ospf *, struct ospf_area *);
534 extern int ospf_timers_refresh_set(struct ospf *, int);
535 extern int ospf_timers_refresh_unset(struct ospf *);
536 extern int ospf_nbr_nbma_set(struct ospf *, struct in_addr);
537 extern int ospf_nbr_nbma_unset(struct ospf *, struct in_addr);
538 extern int ospf_nbr_nbma_priority_set(struct ospf *, struct in_addr, u_char);
539 extern int ospf_nbr_nbma_priority_unset(struct ospf *, struct in_addr);
540 extern int ospf_nbr_nbma_poll_interval_set(struct ospf *, struct in_addr,
541 unsigned int);
542 extern int ospf_nbr_nbma_poll_interval_unset(struct ospf *, struct in_addr);
543 extern void ospf_prefix_list_update(struct prefix_list *);
544 extern void ospf_init(void);
545 extern void ospf_if_update(struct ospf *, struct interface *);
546 extern void ospf_ls_upd_queue_empty(struct ospf_interface *);
547 extern void ospf_terminate(void);
548 extern void ospf_nbr_nbma_if_update(struct ospf *, struct ospf_interface *);
549 extern struct ospf_nbr_nbma *ospf_nbr_nbma_lookup(struct ospf *,
550 struct in_addr);
551 extern struct ospf_nbr_nbma *ospf_nbr_nbma_lookup_next(struct ospf *,
552 struct in_addr *, int);
553 extern int ospf_oi_count(struct interface *);
554
555 extern struct ospf_area *ospf_area_get(struct ospf *, struct in_addr);
556 extern void ospf_area_check_free(struct ospf *, struct in_addr);
557 extern struct ospf_area *ospf_area_lookup_by_area_id(struct ospf *,
558 struct in_addr);
559 extern void ospf_area_add_if(struct ospf_area *, struct ospf_interface *);
560 extern void ospf_area_del_if(struct ospf_area *, struct ospf_interface *);
561
562 extern void ospf_interface_area_set(struct interface *);
563 extern void ospf_interface_area_unset(struct interface *);
564
565 extern void ospf_route_map_init(void);
566
567 extern void ospf_master_init(struct thread_master *master);
568
569 #endif /* _ZEBRA_OSPFD_H */