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 "typesafe.h"
  27 #include "qobj.h"
  28 #include "libospf.h"
  29 #include "ldp_sync.h"
  30
  31 #include "filter.h"
  32 #include "log.h"
  33 #include "vrf.h"
  34
  35 #include "ospf_memory.h"
  36 #include "ospf_dump_api.h"
  37
  38 #define OSPF_VERSION            2
  39
  40 /* VTY port number. */
  41 #define OSPF_VTY_PORT          2604
  42
  43 /* IP TTL for OSPF protocol. */
  44 #define OSPF_IP_TTL             1
  45 #define OSPF_VL_IP_TTL          100
  46
  47 /* Default configuration file name for ospfd. */
  48 #define OSPF_DEFAULT_CONFIG   "ospfd.conf"
  49
  50 #define OSPF_NSSA_TRANS_STABLE_DEFAULT          40
  51
  52 #define OSPF_ALLSPFROUTERS              0xe0000005      /* 224.0.0.5 */
  53 #define OSPF_ALLDROUTERS                0xe0000006      /* 224.0.0.6 */
  54
  55 /* OSPF Authentication Type. */
  56 #define OSPF_AUTH_NULL                      0
  57 #define OSPF_AUTH_SIMPLE                    1
  58 #define OSPF_AUTH_CRYPTOGRAPHIC             2
  59 /* For Interface authentication setting default */
  60 #define OSPF_AUTH_NOTSET                   -1
  61 /* For the consumption and sanity of the command handler */
  62 /* DO NIOT REMOVE!!! Need to detect whether a value has
  63    been given or not in VLink command handlers */
  64 #define OSPF_AUTH_CMD_NOTSEEN              -2
  65
  66 /* OSPF options. */
  67 #define OSPF_OPTION_MT                   0x01  /* M/T */
  68 #define OSPF_OPTION_E                    0x02
  69 #define OSPF_OPTION_MC                   0x04
  70 #define OSPF_OPTION_NP                   0x08
  71 #define OSPF_OPTION_EA                   0x10
  72 #define OSPF_OPTION_DC                   0x20
  73 #define OSPF_OPTION_O                    0x40
  74 #define OSPF_OPTION_DN                   0x80
  75
  76 /* OSPF Database Description flags. */
  77 #define OSPF_DD_FLAG_MS                  0x01
  78 #define OSPF_DD_FLAG_M                   0x02
  79 #define OSPF_DD_FLAG_I                   0x04
  80 #define OSPF_DD_FLAG_ALL                 0x07
  81
  82 #define OSPF_LS_REFRESH_SHIFT       (60 * 15)
  83 #define OSPF_LS_REFRESH_JITTER      60
  84
  85 struct ospf_external {
  86         unsigned short instance;
  87         struct route_table *external_info;
  88 };
  89
  90 /* OSPF master for system wide configuration and variables. */
  91 struct ospf_master {
  92         /* OSPF instance. */
  93         struct list *ospf;
  94
  95         /* OSPF thread master. */
  96         struct thread_master *master;
  97
  98         /* Various OSPF global configuration. */
  99         uint8_t options;
 100 #define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */
 101 };
 102
 103 struct ospf_redist {
 104         unsigned short instance;
 105
 106         /* Redistribute metric info. */
 107         struct {
 108                 int type;  /* External metric type (E1 or E2).  */
 109                 int value; /* Value for static metric (24-bit).
 110                               -1 means metric value is not set. */
 111         } dmetric;
 112
 113         /* For redistribute route map. */
 114         struct {
 115                 char *name;
 116                 struct route_map *map;
 117         } route_map; /* +1 is for default-information */
 118 #define ROUTEMAP_NAME(R)   (R->route_map.name)
 119 #define ROUTEMAP(R)        (R->route_map.map)
 120 };
 121
 122 /* ospf->config */
 123 enum {
 124         OSPF_RFC1583_COMPATIBLE =       (1 << 0),
 125         OSPF_OPAQUE_CAPABLE =           (1 << 2),
 126         OSPF_LOG_ADJACENCY_CHANGES =    (1 << 3),
 127         OSPF_LOG_ADJACENCY_DETAIL =     (1 << 4),
 128         OSPF_SEND_EXTRA_DATA_TO_ZEBRA = (1 << 5),
 129 };
 130
 131 /* TI-LFA */
 132 enum protection_type {
 133         OSPF_TI_LFA_UNDEFINED_PROTECTION,
 134         OSPF_TI_LFA_LINK_PROTECTION,
 135         OSPF_TI_LFA_NODE_PROTECTION,
 136 };
 137
 138 /* OSPF nonstop forwarding aka Graceful Restart */
 139 struct ospf_gr_info {
 140         bool restart_support;
 141         bool restart_in_progress;
 142         bool prepare_in_progress;
 143         bool finishing_restart;
 144         uint32_t grace_period;
 145         struct thread *t_grace_period;
 146 };
 147
 148 /* OSPF instance structure. */
 149 struct ospf {
 150         /* OSPF's running state based on the '[no] router ospf [<instance>]'
 151          * config. */
 152         uint8_t oi_running;
 153
 154         /* OSPF instance ID  */
 155         unsigned short instance;
 156
 157         /* OSPF Router ID. */
 158         struct in_addr router_id;       /* Configured automatically. */
 159         struct in_addr router_id_static; /* Configured manually. */
 160         struct in_addr router_id_zebra;
 161
 162         vrf_id_t vrf_id; /* VRF Id */
 163         char *name;      /* VRF name */
 164
 165         /* ABR/ASBR internal flags. */
 166         uint8_t flags;
 167 #define OSPF_FLAG_ABR           0x0001
 168 #define OSPF_FLAG_ASBR          0x0002
 169
 170         /* ABR type. */
 171         uint8_t abr_type;
 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
 178
 179         /* NSSA ABR */
 180         uint8_t anyNSSA; /* Bump for every NSSA attached. */
 181
 182         /* Configuration bitmask, refer to enum above */
 183         uint8_t config;
 184
 185         /* Opaque-LSA administrative flags. */
 186         uint8_t opaque;
 187 #define OPAQUE_OPERATION_READY_BIT      (1 << 0)
 188
 189         /* RFC3137 stub router. Configured time to stay stub / max-metric */
 190         unsigned int stub_router_startup_time;  /* seconds */
 191         unsigned int stub_router_shutdown_time; /* seconds */
 192 #define OSPF_STUB_ROUTER_UNCONFIGURED     0
 193         uint8_t stub_router_admin_set;
 194 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_SET     1
 195 #define OSPF_STUB_ROUTER_ADMINISTRATIVE_UNSET   0
 196
 197 #define OSPF_STUB_MAX_METRIC_SUMMARY_COST       0x00ff0000
 198
 199         /* LSA timers */
 200         unsigned int min_ls_interval; /* minimum delay between LSAs (in msec) */
 201         unsigned int min_ls_arrival;  /* minimum interarrival time between LSAs
 202                                          (in msec) */
 203
 204         /* SPF parameters */
 205         unsigned int spf_delay; /* SPF delay time. */
 206         unsigned int spf_holdtime;     /* SPF hold time. */
 207         unsigned int spf_max_holdtime; /* SPF maximum-holdtime */
 208         unsigned int
 209                 spf_hold_multiplier; /* Adaptive multiplier for hold time */
 210
 211         int default_originate;  /* Default information originate. */
 212 #define DEFAULT_ORIGINATE_NONE          0
 213 #define DEFAULT_ORIGINATE_ZEBRA         1
 214 #define DEFAULT_ORIGINATE_ALWAYS        2
 215         uint32_t ref_bandwidth;       /* Reference Bandwidth (Kbps). */
 216         struct route_table *networks; /* OSPF config networks. */
 217         struct list *vlinks;      /* Configured Virtual-Links. */
 218         struct list *areas;        /* OSPF areas. */
 219         struct route_table *nbr_nbma;
 220         struct ospf_area *backbone; /* Pointer to the Backbone Area. */
 221
 222         struct list *oiflist;             /* ospf interfaces */
 223         uint8_t passive_interface_default; /* passive-interface default */
 224
 225         /* LSDB of AS-external-LSAs. */
 226         struct ospf_lsdb *lsdb;
 227
 228         /* Flags. */
 229         int ase_calc;   /* ASE calculation flag. */
 230
 231         struct list *opaque_lsa_self; /* Type-11 Opaque-LSAs */
 232
 233         /* Routing tables. */
 234         struct route_table *old_table; /* Old routing table. */
 235         struct route_table *new_table; /* Current routing table. */
 236
 237         struct route_table *oall_rtrs; /* Old router RT. */
 238         struct route_table *all_rtrs;  /* New routers RT. */
 239
 240         struct route_table *old_rtrs; /* Old ABR/ASBR RT. */
 241         struct route_table *new_rtrs; /* New ABR/ASBR RT. */
 242
 243         struct route_table *new_external_route; /* New External Route. */
 244         struct route_table *old_external_route; /* Old External Route. */
 245
 246         struct route_table *external_lsas; /* Database of external LSAs,
 247                                               prefix is LSA's adv. network*/
 248
 249         /* Time stamps */
 250         struct timeval ts_spf;          /* SPF calculation time stamp. */
 251         struct timeval ts_spf_duration; /* Execution time of last SPF */
 252
 253         struct route_table *maxage_lsa; /* List of MaxAge LSA for deletion. */
 254         int redistribute;               /* Num of redistributed protocols. */
 255
 256         /* Threads. */
 257         struct thread *t_abr_task;        /* ABR task timer. */
 258         struct thread *t_asbr_check;    /* ASBR check timer. */
 259         struct thread *t_asbr_nssa_redist_update; /* ASBR NSSA redistribution
 260                                                      update timer. */
 261         struct thread *t_distribute_update; /* Distirbute list update timer. */
 262         struct thread *t_spf_calc;        /* SPF calculation timer. */
 263         struct thread *t_ase_calc;        /* ASE calculation timer. */
 264         struct thread
 265                 *t_opaque_lsa_self; /* Type-11 Opaque-LSAs origin event. */
 266         struct thread *t_sr_update; /* Segment Routing update timer */
 267
 268         unsigned int maxage_delay;      /* Delay on Maxage remover timer, sec */
 269         struct thread *t_maxage;        /* MaxAge LSA remover timer. */
 270         struct thread *t_maxage_walker; /* MaxAge LSA checking timer. */
 271
 272         struct thread
 273                 *t_deferred_shutdown; /* deferred/stub-router shutdown timer*/
 274
 275         struct thread *t_write;
 276 #define OSPF_WRITE_INTERFACE_COUNT_DEFAULT    20
 277         struct thread *t_default_routemap_timer;
 278
 279         int write_oi_count; /* Num of packets sent per thread invocation */
 280         struct thread *t_read;
 281         int fd;
 282         struct stream *ibuf;
 283         struct list *oi_write_q;
 284
 285         /* Distribute lists out of other route sources. */
 286         struct {
 287                 char *name;
 288                 struct access_list *list;
 289         } dlist[ZEBRA_ROUTE_MAX];
 290 #define DISTRIBUTE_NAME(O,T)    (O)->dlist[T].name
 291 #define DISTRIBUTE_LIST(O,T)    (O)->dlist[T].list
 292
 293         /* OSPF redistribute configuration */
 294         struct list *redist[ZEBRA_ROUTE_MAX + 1];
 295
 296         /* Redistribute tag info. */
 297         route_tag_t
 298                 dtag[ZEBRA_ROUTE_MAX + 1]; // Pending: cant configure as of now
 299
 300         int default_metric; /* Default metric for redistribute. */
 301
 302 #define OSPF_LSA_REFRESHER_GRANULARITY 10
 303 #define OSPF_LSA_REFRESHER_SLOTS                                               \
 304         ((OSPF_LS_REFRESH_TIME + OSPF_LS_REFRESH_SHIFT)                        \
 305                  / OSPF_LSA_REFRESHER_GRANULARITY                              \
 306          + 1)
 307         struct {
 308                 uint16_t index;
 309                 struct list *qs[OSPF_LSA_REFRESHER_SLOTS];
 310         } lsa_refresh_queue;
 311
 312         struct thread *t_lsa_refresher;
 313         time_t lsa_refresher_started;
 314 #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10
 315         uint16_t lsa_refresh_interval;
 316
 317         /* Distance parameter. */
 318         uint8_t distance_all;
 319         uint8_t distance_intra;
 320         uint8_t distance_inter;
 321         uint8_t distance_external;
 322
 323         /* Statistics for LSA origination. */
 324         uint32_t lsa_originate_count;
 325
 326         /* Statistics for LSA used for new instantiation. */
 327         uint32_t rx_lsa_count;
 328
 329         struct route_table *distance_table;
 330
 331         /* Used during ospf instance going down send LSDB
 332          * update to neighbors immediatly */
 333         uint8_t inst_shutdown;
 334
 335         /* Enable or disable sending proactive ARP requests. */
 336         bool proactive_arp;
 337 #define OSPF_PROACTIVE_ARP_DEFAULT true
 338
 339         /* Redistributed external information. */
 340         struct list *external[ZEBRA_ROUTE_MAX + 1];
 341 #define EXTERNAL_INFO(E) (E->external_info)
 342
 343         /* Graceful restart Helper supported configs*/
 344         /* Supported grace interval*/
 345         uint32_t supported_grace_time;
 346
 347         /* Helper support
 348          * Supported : True
 349          * Not Supported : False.
 350          */
 351         bool is_helper_supported;
 352
 353         /* Support for strict LSA check.
 354          * if it is set,Helper aborted
 355          * upon a TOPO change.
 356          */
 357         bool strict_lsa_check;
 358
 359         /* Support as HELPER only for
 360          * planned restarts.
 361          */
 362         bool only_planned_restart;
 363
 364         /* This list contains the advertisement
 365          * routerids which are not support for HELPERs.
 366          */
 367         struct hash *enable_rtr_list;
 368
 369         /* HELPER for number of active
 370          * RESTARTERs.
 371          */
 372         uint16_t active_restarter_cnt;
 373
 374         /* last HELPER exit reason */
 375         uint32_t last_exit_reason;
 376
 377         /* delay timer to process external routes
 378          * with summary address.
 379          */
 380         struct thread *t_external_aggr;
 381
 382         /* delay interval in seconds */
 383         uint16_t aggr_delay_interval;
 384
 385         /* Table of configured Aggregate addresses */
 386         struct route_table *rt_aggr_tbl;
 387
 388         /* used as argument for aggr delay
 389          * timer thread.
 390          */
 391         int aggr_action;
 392
 393         /* Max number of multiple paths
 394          * to support ECMP.
 395          */
 396         uint16_t max_multipath;
 397
 398         /* MPLS LDP-IGP Sync */
 399         struct ldp_sync_info_cmd ldp_sync_cmd;
 400
 401         /* OSPF Graceful Restart info */
 402         struct ospf_gr_info gr_info;
 403
 404         /* TI-LFA support for all interfaces. */
 405         bool ti_lfa_enabled;
 406         enum protection_type ti_lfa_protection_type;
 407
 408         QOBJ_FIELDS;
 409 };
 410 DECLARE_QOBJ_TYPE(ospf);
 411
 412 enum ospf_ti_lfa_p_q_space_adjacency {
 413         OSPF_TI_LFA_P_Q_SPACE_ADJACENT,
 414         OSPF_TI_LFA_P_Q_SPACE_NON_ADJACENT,
 415 };
 416
 417 enum ospf_ti_lfa_node_type {
 418         OSPF_TI_LFA_UNDEFINED_NODE,
 419         OSPF_TI_LFA_PQ_NODE,
 420         OSPF_TI_LFA_P_NODE,
 421         OSPF_TI_LFA_Q_NODE,
 422 };
 423
 424 struct ospf_ti_lfa_node_info {
 425         struct vertex *node;
 426         enum ospf_ti_lfa_node_type type;
 427         struct in_addr nexthop;
 428 };
 429
 430 struct ospf_ti_lfa_inner_backup_path_info {
 431         struct ospf_ti_lfa_node_info p_node_info;
 432         struct ospf_ti_lfa_node_info q_node_info;
 433         struct mpls_label_stack *label_stack;
 434 };
 435
 436 struct protected_resource {
 437         enum protection_type type;
 438
 439         /* Link Protection */
 440         struct router_lsa_link *link;
 441
 442         /* Node Protection */
 443         struct in_addr router_id;
 444 };
 445
 446 PREDECL_RBTREE_UNIQ(q_spaces);
 447 struct q_space {
 448         struct vertex *root;
 449         struct list *vertex_list;
 450         struct mpls_label_stack *label_stack;
 451         struct in_addr nexthop;
 452         struct list *pc_path;
 453         struct ospf_ti_lfa_node_info *p_node_info;
 454         struct ospf_ti_lfa_node_info *q_node_info;
 455         struct q_spaces_item q_spaces_item;
 456 };
 457
 458 PREDECL_RBTREE_UNIQ(p_spaces);
 459 struct p_space {
 460         struct vertex *root;
 461         struct protected_resource *protected_resource;
 462         struct q_spaces_head *q_spaces;
 463         struct list *vertex_list;
 464         struct vertex *pc_spf;
 465         struct list *pc_vertex_list;
 466         struct p_spaces_item p_spaces_item;
 467 };
 468
 469 /* OSPF area structure. */
 470 struct ospf_area {
 471         /* OSPF instance. */
 472         struct ospf *ospf;
 473
 474         /* Zebra interface list belonging to the area. */
 475         struct list *oiflist;
 476
 477         /* Area ID. */
 478         struct in_addr area_id;
 479
 480         /* Area ID format. */
 481         int area_id_fmt;
 482 #define OSPF_AREA_ID_FMT_DOTTEDQUAD     1
 483 #define OSPF_AREA_ID_FMT_DECIMAL        2
 484
 485         /* Address range. */
 486         struct list *address_range;
 487
 488         /* Configured variables. */
 489         int external_routing;    /* ExternalRoutingCapability. */
 490         int no_summary;          /* Don't inject summaries into stub.*/
 491         int shortcut_configured; /* Area configured as shortcut. */
 492 #define OSPF_SHORTCUT_DEFAULT   0
 493 #define OSPF_SHORTCUT_ENABLE    1
 494 #define OSPF_SHORTCUT_DISABLE   2
 495         int shortcut_capability; /* Other ABRs agree on S-bit */
 496         uint32_t default_cost;   /* StubDefaultCost. */
 497         int auth_type;           /* Authentication type. */
 498         int suppress_fa;         /* Suppress forwarding address in NSSA ABR */
 499
 500         uint8_t NSSATranslatorRole; /* NSSA configured role */
 501 #define OSPF_NSSA_ROLE_NEVER     0
 502 #define OSPF_NSSA_ROLE_CANDIDATE 1
 503 #define OSPF_NSSA_ROLE_ALWAYS    2
 504         uint8_t NSSATranslatorState; /* NSSA operational role */
 505 #define OSPF_NSSA_TRANSLATE_DISABLED 0
 506 #define OSPF_NSSA_TRANSLATE_ENABLED  1
 507         int NSSATranslatorStabilityInterval;
 508
 509         uint8_t transit; /* TransitCapability. */
 510 #define OSPF_TRANSIT_FALSE      0
 511 #define OSPF_TRANSIT_TRUE       1
 512         struct route_table *ranges; /* Configured Area Ranges. */
 513
 514         /* RFC3137 stub router state flags for area */
 515         uint8_t stub_router_state;
 516 #define OSPF_AREA_ADMIN_STUB_ROUTED     (1 << 0) /* admin stub-router set */
 517 #define OSPF_AREA_IS_STUB_ROUTED        (1 << 1) /* stub-router active */
 518 #define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */
 519         /* Area related LSDBs[Type1-4]. */
 520         struct ospf_lsdb *lsdb;
 521
 522         /* Self-originated LSAs. */
 523         struct ospf_lsa *router_lsa_self;
 524         struct list *opaque_lsa_self; /* Type-10 Opaque-LSAs */
 525
 526         /* Area announce list. */
 527         struct {
 528                 char *name;
 529                 struct access_list *list;
 530         } _export;
 531 #define EXPORT_NAME(A)  (A)->_export.name
 532 #define EXPORT_LIST(A)  (A)->_export.list
 533
 534         /* Area acceptance list. */
 535         struct {
 536                 char *name;
 537                 struct access_list *list;
 538         } import;
 539 #define IMPORT_NAME(A)  (A)->import.name
 540 #define IMPORT_LIST(A)  (A)->import.list
 541
 542         /* Type 3 LSA Area prefix-list. */
 543         struct {
 544                 char *name;
 545                 struct prefix_list *list;
 546         } plist_in;
 547 #define PREFIX_LIST_IN(A)   (A)->plist_in.list
 548 #define PREFIX_NAME_IN(A)   (A)->plist_in.name
 549
 550         struct {
 551                 char *name;
 552                 struct prefix_list *list;
 553         } plist_out;
 554 #define PREFIX_LIST_OUT(A)  (A)->plist_out.list
 555 #define PREFIX_NAME_OUT(A)  (A)->plist_out.name
 556
 557         /* Shortest Path Tree. */
 558         struct vertex *spf;
 559         struct list *spf_vertex_list;
 560
 561         bool spf_dry_run;   /* flag for checking if the SPF calculation is
 562                                intended for the local RIB */
 563         bool spf_root_node; /* flag for checking if the calculating node is the
 564                                root node of the SPF tree */
 565
 566         /* TI-LFA protected link for SPF calculations */
 567         struct protected_resource *spf_protected_resource;
 568
 569         /* P/Q spaces for TI-LFA */
 570         struct p_spaces_head *p_spaces;
 571
 572         /* Threads. */
 573         struct thread *t_stub_router;     /* Stub-router timer */
 574         struct thread *t_opaque_lsa_self; /* Type-10 Opaque-LSAs origin. */
 575
 576         /* Statistics field. */
 577         uint32_t spf_calculation; /* SPF Calculation Count. */
 578
 579         /* reverse SPF (used for TI-LFA Q spaces) */
 580         bool spf_reversed;
 581
 582         /* Time stamps. */
 583         struct timeval ts_spf; /* SPF calculation time stamp. */
 584
 585         /* Router count. */
 586         uint32_t abr_count;  /* ABR router in this area. */
 587         uint32_t asbr_count; /* ASBR router in this area. */
 588
 589         /* Counters. */
 590         uint32_t act_ints;  /* Active interfaces. */
 591         uint32_t full_nbrs; /* Fully adjacent neighbors. */
 592         uint32_t full_vls;  /* Fully adjacent virtual neighbors. */
 593 };
 594
 595 /* OSPF config network structure. */
 596 struct ospf_network {
 597         /* Area ID. */
 598         struct in_addr area_id;
 599         int area_id_fmt;
 600 };
 601
 602 /* OSPF NBMA neighbor structure. */
 603 struct ospf_nbr_nbma {
 604         /* Neighbor IP address. */
 605         struct in_addr addr;
 606
 607         /* OSPF interface. */
 608         struct ospf_interface *oi;
 609
 610         /* OSPF neighbor structure. */
 611         struct ospf_neighbor *nbr;
 612
 613         /* Neighbor priority. */
 614         uint8_t priority;
 615
 616         /* Poll timer value. */
 617         uint32_t v_poll;
 618
 619         /* Poll timer thread. */
 620         struct thread *t_poll;
 621
 622         /* State change. */
 623         uint32_t state_change;
 624 };
 625
 626 /* Macro. */
 627 #define OSPF_AREA_SAME(X, Y)                                                   \
 628         (memcmp((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0)
 629
 630 #define IS_OSPF_ABR(O)          ((O)->flags & OSPF_FLAG_ABR)
 631 #define IS_OSPF_ASBR(O)         ((O)->flags & OSPF_FLAG_ASBR)
 632
 633 #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE)
 634 #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id)
 635
 636 #ifdef roundup
 637 #  define ROUNDUP(val, gran)    roundup(val, gran)
 638 #else  /* roundup */
 639 #  define ROUNDUP(val, gran)    (((val) - 1 | (gran) - 1) + 1)
 640 #endif /* roundup */
 641
 642 #define LSA_OPTIONS_GET(area)                                                  \
 643         (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0)
 644 #define LSA_OPTIONS_NSSA_GET(area)                                             \
 645         (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0)
 646
 647 #define OSPF_TIMER_ON(T,F,V) thread_add_timer (master,(F),ospf,(V),&(T))
 648 #define OSPF_AREA_TIMER_ON(T,F,V) thread_add_timer (master, (F), area, (V), &(T))
 649 #define OSPF_POLL_TIMER_ON(T,F,V) thread_add_timer (master, (F), nbr_nbma, (V), &(T))
 650 #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X))
 651 #define OSPF_TIMER_OFF(X) thread_cancel(&(X))
 652
 653 /* Extern variables. */
 654 extern struct ospf_master *om;
 655 extern unsigned short ospf_instance;
 656 extern const int ospf_redistributed_proto_max;
 657 extern struct zclient *zclient;
 658 extern struct thread_master *master;
 659 extern int ospf_zlog;
 660 extern struct zebra_privs_t ospfd_privs;
 661
 662 /* Prototypes. */
 663 extern const char *ospf_redist_string(unsigned int route_type);
 664 extern struct ospf *ospf_lookup_instance(unsigned short instance);
 665 extern struct ospf *ospf_lookup(unsigned short instance, const char *name);
 666 extern struct ospf *ospf_get(unsigned short instance, const char *name,
 667                              bool *created);
 668 extern struct ospf *ospf_new_alloc(unsigned short instance, const char *name);
 669 extern struct ospf *ospf_lookup_by_inst_name(unsigned short instance,
 670                                              const char *name);
 671 extern struct ospf *ospf_lookup_by_vrf_id(vrf_id_t vrf_id);
 672 extern uint32_t ospf_count_area_params(struct ospf *ospf);
 673 extern void ospf_finish(struct ospf *ospf);
 674 extern void ospf_process_refresh_data(struct ospf *ospf, bool reset);
 675 extern void ospf_router_id_update(struct ospf *ospf);
 676 extern void ospf_process_reset(struct ospf *ospf);
 677 extern void ospf_neighbor_reset(struct ospf *ospf, struct in_addr nbr_id,
 678                                 const char *nbr_str);
 679 extern int ospf_network_set(struct ospf *ospf, struct prefix_ipv4 *p,
 680                             struct in_addr area_id, int df);
 681 extern int ospf_network_unset(struct ospf *ospf, struct prefix_ipv4 *p,
 682                               struct in_addr aread_id);
 683 extern int ospf_area_display_format_set(struct ospf *ospf,
 684                                         struct ospf_area *area, int df);
 685 extern int ospf_area_stub_set(struct ospf *ospf, struct in_addr area_id);
 686 extern int ospf_area_stub_unset(struct ospf *ospf, struct in_addr area_id);
 687 extern int ospf_area_no_summary_set(struct ospf *ospf, struct in_addr area_id);
 688 extern int ospf_area_no_summary_unset(struct ospf *ospf,
 689                                       struct in_addr area_id);
 690 extern int ospf_area_nssa_set(struct ospf *ospf, struct in_addr area_id);
 691 extern int ospf_area_nssa_unset(struct ospf *ospf, struct in_addr area_id,
 692                                 int argc);
 693 extern int ospf_area_nssa_suppress_fa_set(struct ospf *ospf,
 694                                           struct in_addr area_id);
 695 extern int ospf_area_nssa_suppress_fa_unset(struct ospf *ospf,
 696                                             struct in_addr area_id);
 697 extern int ospf_area_nssa_translator_role_set(struct ospf *ospf,
 698                                               struct in_addr area_id, int role);
 699 extern int ospf_area_export_list_set(struct ospf *ospf,
 700                                      struct ospf_area *area_id,
 701                                      const char *list_name);
 702 extern int ospf_area_export_list_unset(struct ospf *ospf,
 703                                        struct ospf_area *area_id);
 704 extern int ospf_area_import_list_set(struct ospf *ospf,
 705                                      struct ospf_area *area_id,
 706                                      const char *name);
 707 extern int ospf_area_import_list_unset(struct ospf *ospf,
 708                                        struct ospf_area *area_id);
 709 extern int ospf_area_shortcut_set(struct ospf *ospf, struct ospf_area *area_id,
 710                                   int mode);
 711 extern int ospf_area_shortcut_unset(struct ospf *ospf,
 712                                     struct ospf_area *area_id);
 713 extern int ospf_timers_refresh_set(struct ospf *ospf, int interval);
 714 extern int ospf_timers_refresh_unset(struct ospf *ospf);
 715 void ospf_area_lsdb_discard_delete(struct ospf_area *area);
 716 extern int ospf_nbr_nbma_set(struct ospf *ospf, struct in_addr nbr_addr);
 717 extern int ospf_nbr_nbma_unset(struct ospf *ospf, struct in_addr nbr_addr);
 718 extern int ospf_nbr_nbma_priority_set(struct ospf *ospf,
 719                                       struct in_addr nbr_addr,
 720                                       uint8_t priority);
 721 extern int ospf_nbr_nbma_priority_unset(struct ospf *ospf,
 722                                         struct in_addr nbr_addr);
 723 extern int ospf_nbr_nbma_poll_interval_set(struct ospf *ospf,
 724                                            struct in_addr nbr_addr,
 725                                            unsigned int interval);
 726 extern int ospf_nbr_nbma_poll_interval_unset(struct ospf *ospf,
 727                                              struct in_addr addr);
 728 extern void ospf_if_update(struct ospf *ospf, struct interface *ifp);
 729 extern void ospf_ls_upd_queue_empty(struct ospf_interface *oi);
 730 extern void ospf_terminate(void);
 731 extern void ospf_nbr_nbma_if_update(struct ospf *ospf,
 732                                     struct ospf_interface *oi);
 733 extern struct ospf_nbr_nbma *ospf_nbr_nbma_lookup(struct ospf *ospf,
 734                                                   struct in_addr nbr_addr);
 735 extern int ospf_oi_count(struct interface *ifp);
 736
 737 extern struct ospf_area *ospf_area_new(struct ospf *ospf,
 738                                        struct in_addr area_id);
 739 extern struct ospf_area *ospf_area_get(struct ospf *ospf,
 740                                        struct in_addr area_id);
 741 extern void ospf_area_check_free(struct ospf *ospf, struct in_addr area_id);
 742 extern struct ospf_area *ospf_area_lookup_by_area_id(struct ospf *ospf,
 743                                                      struct in_addr area_id);
 744 extern void ospf_area_add_if(struct ospf_area *oa, struct ospf_interface *oi);
 745 extern void ospf_area_del_if(struct ospf_area *oa, struct ospf_interface *oi);
 746
 747 extern void ospf_interface_area_set(struct ospf *ospf, struct interface *ifp);
 748 extern void ospf_interface_area_unset(struct ospf *ospf, struct interface *ifp);
 749
 750 extern void ospf_route_map_init(void);
 751
 752 extern void ospf_master_init(struct thread_master *master);
 753 extern void ospf_vrf_init(void);
 754 extern void ospf_vrf_terminate(void);
 755 extern void ospf_vrf_link(struct ospf *ospf, struct vrf *vrf);
 756 extern void ospf_vrf_unlink(struct ospf *ospf, struct vrf *vrf);
 757 const char *ospf_vrf_id_to_name(vrf_id_t vrf_id);
 758 int ospf_area_nssa_no_summary_set(struct ospf *ospf, struct in_addr area_id);
 759
 760 const char *ospf_get_name(const struct ospf *ospf);
 761 extern struct ospf_interface *add_ospf_interface(struct connected *co,
 762                                                  struct ospf_area *area);
 763
 764 extern int p_spaces_compare_func(const struct p_space *a,
 765                                  const struct p_space *b);
 766 extern int q_spaces_compare_func(const struct q_space *a,
 767                                  const struct q_space *b);
 768
 769 #endif /* _ZEBRA_OSPFD_H */