| /* |
| * OSPFd main header. |
| * Copyright (C) 1998, 99, 2000 Kunihiro Ishiguro, Toshiaki Takada |
| * |
| * This file is part of GNU Zebra. |
| * |
| * GNU Zebra is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License as published by the |
| * Free Software Foundation; either version 2, or (at your option) any |
| * later version. |
| * |
| * GNU Zebra is distributed in the hope that it will be useful, but |
| * WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| * General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License |
| * along with GNU Zebra; see the file COPYING. If not, write to the Free |
| * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA |
| * 02111-1307, USA. |
| */ |
| |
| #ifndef _ZEBRA_OSPFD_H |
| #define _ZEBRA_OSPFD_H |
| |
| #include <zebra.h> |
| #include "libospf.h" |
| |
| #include "filter.h" |
| #include "log.h" |
| |
| #define OSPF_VERSION 2 |
| |
| /* VTY port number. */ |
| #define OSPF_VTY_PORT 2604 |
| |
| /* IP TTL for OSPF protocol. */ |
| #define OSPF_IP_TTL 1 |
| #define OSPF_VL_IP_TTL 100 |
| |
| /* Default configuration file name for ospfd. */ |
| #define OSPF_DEFAULT_CONFIG "ospfd.conf" |
| |
| #define OSPF_NSSA_TRANS_STABLE_DEFAULT 40 |
| |
| #define OSPF_ALLSPFROUTERS 0xe0000005 /* 224.0.0.5 */ |
| #define OSPF_ALLDROUTERS 0xe0000006 /* 224.0.0.6 */ |
| |
| |
| /* OSPF Authentication Type. */ |
| #define OSPF_AUTH_NULL 0 |
| #define OSPF_AUTH_SIMPLE 1 |
| #define OSPF_AUTH_CRYPTOGRAPHIC 2 |
| /* For Interface authentication setting default */ |
| #define OSPF_AUTH_NOTSET -1 |
| /* For the consumption and sanity of the command handler */ |
| /* DO NIOT REMOVE!!! Need to detect whether a value has |
| been given or not in VLink command handlers */ |
| #define OSPF_AUTH_CMD_NOTSEEN -2 |
| |
| /* OSPF options. */ |
| #define OSPF_OPTION_MT 0x01 /* M/T */ |
| #define OSPF_OPTION_E 0x02 |
| #define OSPF_OPTION_MC 0x04 |
| #define OSPF_OPTION_NP 0x08 |
| #define OSPF_OPTION_EA 0x10 |
| #define OSPF_OPTION_DC 0x20 |
| #define OSPF_OPTION_O 0x40 |
| #define OSPF_OPTION_DN 0x80 |
| |
| /* OSPF Database Description flags. */ |
| #define OSPF_DD_FLAG_MS 0x01 |
| #define OSPF_DD_FLAG_M 0x02 |
| #define OSPF_DD_FLAG_I 0x04 |
| #define OSPF_DD_FLAG_ALL 0x07 |
| |
| #define OSPF_LS_REFRESH_SHIFT (60 * 15) |
| #define OSPF_LS_REFRESH_JITTER 60 |
| |
| /* OSPF master for system wide configuration and variables. */ |
| struct ospf_master |
| { |
| /* OSPF instance. */ |
| struct list *ospf; |
| |
| /* OSPF thread master. */ |
| struct thread_master *master; |
| |
| /* Zebra interface list. */ |
| struct list *iflist; |
| |
| /* Redistributed external information. */ |
| struct route_table *external_info[ZEBRA_ROUTE_MAX + 1]; |
| #define EXTERNAL_INFO(T) om->external_info[T] |
| |
| /* OSPF start time. */ |
| time_t start_time; |
| |
| /* Various OSPF global configuration. */ |
| u_char options; |
| #define OSPF_MASTER_SHUTDOWN (1 << 0) /* deferred-shutdown */ |
| }; |
| |
| /* OSPF instance structure. */ |
| struct ospf |
| { |
| /* OSPF Router ID. */ |
| struct in_addr router_id; /* Configured automatically. */ |
| struct in_addr router_id_static; /* Configured manually. */ |
| |
| /* ABR/ASBR internal flags. */ |
| u_char flags; |
| #define OSPF_FLAG_ABR 0x0001 |
| #define OSPF_FLAG_ASBR 0x0002 |
| |
| /* ABR type. */ |
| u_char abr_type; |
| #define OSPF_ABR_UNKNOWN 0 |
| #define OSPF_ABR_STAND 1 |
| #define OSPF_ABR_IBM 2 |
| #define OSPF_ABR_CISCO 3 |
| #define OSPF_ABR_SHORTCUT 4 |
| #define OSPF_ABR_DEFAULT OSPF_ABR_CISCO |
| |
| /* NSSA ABR */ |
| u_char anyNSSA; /* Bump for every NSSA attached. */ |
| |
| /* Configured variables. */ |
| u_char config; |
| #define OSPF_RFC1583_COMPATIBLE (1 << 0) |
| #define OSPF_OPAQUE_CAPABLE (1 << 2) |
| #define OSPF_LOG_ADJACENCY_CHANGES (1 << 3) |
| #define OSPF_LOG_ADJACENCY_DETAIL (1 << 4) |
| |
| /* Opaque-LSA administrative flags. */ |
| u_char opaque; |
| #define OPAQUE_OPERATION_READY_BIT (1 << 0) |
| |
| /* RFC3137 stub router. Configured time to stay stub / max-metric */ |
| unsigned int stub_router_startup_time; /* seconds */ |
| unsigned int stub_router_shutdown_time; /* seconds */ |
| #define OSPF_STUB_ROUTER_UNCONFIGURED 0 |
| u_char stub_router_admin_set; |
| #define OSPF_STUB_ROUTER_ADMINISTRATIVE_SET 1 |
| #define OSPF_STUB_ROUTER_ADMINISTRATIVE_UNSET 0 |
| |
| #define OSPF_STUB_MAX_METRIC_SUMMARY_COST 0x00ff0000 |
| |
| /* LSA timers */ |
| unsigned int min_ls_interval; /* minimum delay between LSAs (in msec) */ |
| unsigned int min_ls_arrival; /* minimum interarrival time between LSAs (in msec) */ |
| |
| /* SPF parameters */ |
| unsigned int spf_delay; /* SPF delay time. */ |
| unsigned int spf_holdtime; /* SPF hold time. */ |
| unsigned int spf_max_holdtime; /* SPF maximum-holdtime */ |
| unsigned int spf_hold_multiplier; /* Adaptive multiplier for hold time */ |
| |
| int default_originate; /* Default information originate. */ |
| #define DEFAULT_ORIGINATE_NONE 0 |
| #define DEFAULT_ORIGINATE_ZEBRA 1 |
| #define DEFAULT_ORIGINATE_ALWAYS 2 |
| u_int32_t ref_bandwidth; /* Reference Bandwidth (Kbps). */ |
| struct route_table *networks; /* OSPF config networks. */ |
| struct list *vlinks; /* Configured Virtual-Links. */ |
| struct list *areas; /* OSPF areas. */ |
| struct route_table *nbr_nbma; |
| struct ospf_area *backbone; /* Pointer to the Backbone Area. */ |
| |
| struct list *oiflist; /* ospf interfaces */ |
| u_char passive_interface_default; /* passive-interface default */ |
| |
| /* LSDB of AS-external-LSAs. */ |
| struct ospf_lsdb *lsdb; |
| |
| /* Flags. */ |
| int external_origin; /* AS-external-LSA origin flag. */ |
| int ase_calc; /* ASE calculation flag. */ |
| |
| struct list *opaque_lsa_self; /* Type-11 Opaque-LSAs */ |
| |
| /* Routing tables. */ |
| struct route_table *old_table; /* Old routing table. */ |
| struct route_table *new_table; /* Current routing table. */ |
| |
| struct route_table *old_rtrs; /* Old ABR/ASBR RT. */ |
| struct route_table *new_rtrs; /* New ABR/ASBR RT. */ |
| |
| struct route_table *new_external_route; /* New External Route. */ |
| struct route_table *old_external_route; /* Old External Route. */ |
| |
| struct route_table *external_lsas; /* Database of external LSAs, |
| prefix is LSA's adv. network*/ |
| |
| /* Time stamps */ |
| struct timeval ts_spf; /* SPF calculation time stamp. */ |
| struct timeval ts_spf_duration; /* Execution time of last SPF */ |
| |
| struct route_table *maxage_lsa; /* List of MaxAge LSA for deletion. */ |
| int redistribute; /* Num of redistributed protocols. */ |
| |
| /* Threads. */ |
| struct thread *t_abr_task; /* ABR task timer. */ |
| struct thread *t_asbr_check; /* ASBR check timer. */ |
| struct thread *t_distribute_update; /* Distirbute list update timer. */ |
| struct thread *t_spf_calc; /* SPF calculation timer. */ |
| struct thread *t_ase_calc; /* ASE calculation timer. */ |
| struct thread *t_external_lsa; /* AS-external-LSA origin timer. */ |
| struct thread *t_opaque_lsa_self; /* Type-11 Opaque-LSAs origin event. */ |
| |
| unsigned int maxage_delay; /* Delay on Maxage remover timer, sec */ |
| struct thread *t_maxage; /* MaxAge LSA remover timer. */ |
| struct thread *t_maxage_walker; /* MaxAge LSA checking timer. */ |
| |
| struct thread *t_deferred_shutdown; /* deferred/stub-router shutdown timer*/ |
| |
| struct thread *t_write; |
| struct thread *t_read; |
| int fd; |
| unsigned int maxsndbuflen; |
| struct stream *ibuf; |
| struct list *oi_write_q; |
| |
| /* Distribute lists out of other route sources. */ |
| struct |
| { |
| char *name; |
| struct access_list *list; |
| } dlist[ZEBRA_ROUTE_MAX]; |
| #define DISTRIBUTE_NAME(O,T) (O)->dlist[T].name |
| #define DISTRIBUTE_LIST(O,T) (O)->dlist[T].list |
| |
| /* Redistribute metric info. */ |
| struct |
| { |
| int type; /* External metric type (E1 or E2). */ |
| int value; /* Value for static metric (24-bit). |
| -1 means metric value is not set. */ |
| } dmetric [ZEBRA_ROUTE_MAX + 1]; |
| |
| /* Redistribute tag info. */ |
| route_tag_t dtag [ZEBRA_ROUTE_MAX + 1]; |
| |
| /* For redistribute route map. */ |
| struct |
| { |
| char *name; |
| struct route_map *map; |
| } route_map [ZEBRA_ROUTE_MAX + 1]; /* +1 is for default-information */ |
| #define ROUTEMAP_NAME(O,T) (O)->route_map[T].name |
| #define ROUTEMAP(O,T) (O)->route_map[T].map |
| |
| int default_metric; /* Default metric for redistribute. */ |
| |
| #define OSPF_LSA_REFRESHER_GRANULARITY 10 |
| #define OSPF_LSA_REFRESHER_SLOTS ((OSPF_LS_REFRESH_TIME + \ |
| OSPF_LS_REFRESH_SHIFT)/10 + 1) |
| struct |
| { |
| u_int16_t index; |
| struct list *qs[OSPF_LSA_REFRESHER_SLOTS]; |
| } lsa_refresh_queue; |
| |
| struct thread *t_lsa_refresher; |
| time_t lsa_refresher_started; |
| #define OSPF_LSA_REFRESH_INTERVAL_DEFAULT 10 |
| u_int16_t lsa_refresh_interval; |
| |
| /* Distance parameter. */ |
| u_char distance_all; |
| u_char distance_intra; |
| u_char distance_inter; |
| u_char distance_external; |
| |
| /* Statistics for LSA origination. */ |
| u_int32_t lsa_originate_count; |
| |
| /* Statistics for LSA used for new instantiation. */ |
| u_int32_t rx_lsa_count; |
| |
| struct route_table *distance_table; |
| }; |
| |
| /* OSPF area structure. */ |
| struct ospf_area |
| { |
| /* OSPF instance. */ |
| struct ospf *ospf; |
| |
| /* Zebra interface list belonging to the area. */ |
| struct list *oiflist; |
| |
| /* Area ID. */ |
| struct in_addr area_id; |
| |
| /* Area ID format. */ |
| char format; |
| #define OSPF_AREA_ID_FORMAT_ADDRESS 1 |
| #define OSPF_AREA_ID_FORMAT_DECIMAL 2 |
| |
| /* Address range. */ |
| struct list *address_range; |
| |
| /* Configured variables. */ |
| int external_routing; /* ExternalRoutingCapability. */ |
| #define OSPF_AREA_DEFAULT 0 |
| #define OSPF_AREA_STUB 1 |
| #define OSPF_AREA_NSSA 2 |
| #define OSPF_AREA_TYPE_MAX 3 |
| int no_summary; /* Don't inject summaries into stub.*/ |
| int shortcut_configured; /* Area configured as shortcut. */ |
| #define OSPF_SHORTCUT_DEFAULT 0 |
| #define OSPF_SHORTCUT_ENABLE 1 |
| #define OSPF_SHORTCUT_DISABLE 2 |
| int shortcut_capability; /* Other ABRs agree on S-bit */ |
| u_int32_t default_cost; /* StubDefaultCost. */ |
| int auth_type; /* Authentication type. */ |
| |
| |
| u_char NSSATranslatorRole; /* NSSA configured role */ |
| #define OSPF_NSSA_ROLE_NEVER 0 |
| #define OSPF_NSSA_ROLE_CANDIDATE 1 |
| #define OSPF_NSSA_ROLE_ALWAYS 2 |
| u_char NSSATranslatorState; /* NSSA operational role */ |
| #define OSPF_NSSA_TRANSLATE_DISABLED 0 |
| #define OSPF_NSSA_TRANSLATE_ENABLED 1 |
| int NSSATranslatorStabilityInterval; |
| |
| u_char transit; /* TransitCapability. */ |
| #define OSPF_TRANSIT_FALSE 0 |
| #define OSPF_TRANSIT_TRUE 1 |
| struct route_table *ranges; /* Configured Area Ranges. */ |
| |
| /* RFC3137 stub router state flags for area */ |
| u_char stub_router_state; |
| #define OSPF_AREA_ADMIN_STUB_ROUTED (1 << 0) /* admin stub-router set */ |
| #define OSPF_AREA_IS_STUB_ROUTED (1 << 1) /* stub-router active */ |
| #define OSPF_AREA_WAS_START_STUB_ROUTED (1 << 2) /* startup SR was done */ |
| |
| /* Area related LSDBs[Type1-4]. */ |
| struct ospf_lsdb *lsdb; |
| |
| /* Self-originated LSAs. */ |
| struct ospf_lsa *router_lsa_self; |
| struct list *opaque_lsa_self; /* Type-10 Opaque-LSAs */ |
| |
| /* Area announce list. */ |
| struct |
| { |
| char *name; |
| struct access_list *list; |
| } _export; |
| #define EXPORT_NAME(A) (A)->_export.name |
| #define EXPORT_LIST(A) (A)->_export.list |
| |
| /* Area acceptance list. */ |
| struct |
| { |
| char *name; |
| struct access_list *list; |
| } import; |
| #define IMPORT_NAME(A) (A)->import.name |
| #define IMPORT_LIST(A) (A)->import.list |
| |
| /* Type 3 LSA Area prefix-list. */ |
| struct |
| { |
| char *name; |
| struct prefix_list *list; |
| } plist_in; |
| #define PREFIX_LIST_IN(A) (A)->plist_in.list |
| #define PREFIX_NAME_IN(A) (A)->plist_in.name |
| |
| struct |
| { |
| char *name; |
| struct prefix_list *list; |
| } plist_out; |
| #define PREFIX_LIST_OUT(A) (A)->plist_out.list |
| #define PREFIX_NAME_OUT(A) (A)->plist_out.name |
| |
| /* Shortest Path Tree. */ |
| struct vertex *spf; |
| |
| /* Threads. */ |
| struct thread *t_stub_router; /* Stub-router timer */ |
| struct thread *t_opaque_lsa_self; /* Type-10 Opaque-LSAs origin. */ |
| |
| /* Statistics field. */ |
| u_int32_t spf_calculation; /* SPF Calculation Count. */ |
| |
| /* Time stamps. */ |
| struct timeval ts_spf; /* SPF calculation time stamp. */ |
| |
| /* Router count. */ |
| u_int32_t abr_count; /* ABR router in this area. */ |
| u_int32_t asbr_count; /* ASBR router in this area. */ |
| |
| /* Counters. */ |
| u_int32_t act_ints; /* Active interfaces. */ |
| u_int32_t full_nbrs; /* Fully adjacent neighbors. */ |
| u_int32_t full_vls; /* Fully adjacent virtual neighbors. */ |
| }; |
| |
| /* OSPF config network structure. */ |
| struct ospf_network |
| { |
| /* Area ID. */ |
| struct in_addr area_id; |
| int format; |
| }; |
| |
| /* OSPF NBMA neighbor structure. */ |
| struct ospf_nbr_nbma |
| { |
| /* Neighbor IP address. */ |
| struct in_addr addr; |
| |
| /* OSPF interface. */ |
| struct ospf_interface *oi; |
| |
| /* OSPF neighbor structure. */ |
| struct ospf_neighbor *nbr; |
| |
| /* Neighbor priority. */ |
| u_char priority; |
| |
| /* Poll timer value. */ |
| u_int32_t v_poll; |
| |
| /* Poll timer thread. */ |
| struct thread *t_poll; |
| |
| /* State change. */ |
| u_int32_t state_change; |
| }; |
| |
| /* Macro. */ |
| #define OSPF_AREA_SAME(X,Y) \ |
| (memcmp ((X->area_id), (Y->area_id), IPV4_MAX_BYTELEN) == 0) |
| |
| #define IS_OSPF_ABR(O) ((O)->flags & OSPF_FLAG_ABR) |
| #define IS_OSPF_ASBR(O) ((O)->flags & OSPF_FLAG_ASBR) |
| |
| #define OSPF_IS_AREA_ID_BACKBONE(I) ((I).s_addr == OSPF_AREA_BACKBONE) |
| #define OSPF_IS_AREA_BACKBONE(A) OSPF_IS_AREA_ID_BACKBONE ((A)->area_id) |
| |
| #ifdef roundup |
| # define ROUNDUP(val, gran) roundup(val, gran) |
| #else /* roundup */ |
| # define ROUNDUP(val, gran) (((val) - 1 | (gran) - 1) + 1) |
| #endif /* roundup */ |
| |
| #define LSA_OPTIONS_GET(area) \ |
| (((area)->external_routing == OSPF_AREA_DEFAULT) ? OSPF_OPTION_E : 0) |
| #define LSA_OPTIONS_NSSA_GET(area) \ |
| (((area)->external_routing == OSPF_AREA_NSSA) ? OSPF_OPTION_NP : 0) |
| |
| #define OSPF_TIMER_ON(T,F,V) \ |
| do { \ |
| if (!(T)) \ |
| (T) = thread_add_timer (master, (F), ospf, (V)); \ |
| } while (0) |
| |
| #define OSPF_AREA_TIMER_ON(T,F,V) \ |
| do { \ |
| if (!(T)) \ |
| (T) = thread_add_timer (master, (F), area, (V)); \ |
| } while (0) |
| |
| #define OSPF_POLL_TIMER_ON(T,F,V) \ |
| do { \ |
| if (!(T)) \ |
| (T) = thread_add_timer (master, (F), nbr_nbma, (V)); \ |
| } while (0) |
| |
| #define OSPF_POLL_TIMER_OFF(X) OSPF_TIMER_OFF((X)) |
| |
| #define OSPF_TIMER_OFF(X) \ |
| do { \ |
| if (X) \ |
| { \ |
| thread_cancel (X); \ |
| (X) = NULL; \ |
| } \ |
| } while (0) |
| |
| /* Extern variables. */ |
| extern struct ospf_master *om; |
| extern const struct message ospf_ism_state_msg[]; |
| extern const struct message ospf_nsm_state_msg[]; |
| extern const struct message ospf_lsa_type_msg[]; |
| extern const struct message ospf_link_state_id_type_msg[]; |
| extern const struct message ospf_network_type_msg[]; |
| extern const int ospf_ism_state_msg_max; |
| extern const int ospf_nsm_state_msg_max; |
| extern const int ospf_lsa_type_msg_max; |
| extern const int ospf_link_state_id_type_msg_max; |
| extern const int ospf_redistributed_proto_max; |
| extern const int ospf_network_type_msg_max; |
| extern struct zclient *zclient; |
| extern struct thread_master *master; |
| extern int ospf_zlog; |
| |
| /* Prototypes. */ |
| extern const char *ospf_redist_string(u_int route_type); |
| extern struct ospf *ospf_lookup (void); |
| extern struct ospf *ospf_get (void); |
| extern void ospf_finish (struct ospf *); |
| extern void ospf_router_id_update (struct ospf *ospf); |
| extern int ospf_network_set (struct ospf *, struct prefix_ipv4 *, |
| struct in_addr); |
| extern int ospf_network_unset (struct ospf *, struct prefix_ipv4 *, |
| struct in_addr); |
| extern int ospf_area_stub_set (struct ospf *, struct in_addr); |
| extern int ospf_area_stub_unset (struct ospf *, struct in_addr); |
| extern int ospf_area_no_summary_set (struct ospf *, struct in_addr); |
| extern int ospf_area_no_summary_unset (struct ospf *, struct in_addr); |
| extern int ospf_area_nssa_set (struct ospf *, struct in_addr); |
| extern int ospf_area_nssa_unset (struct ospf *, struct in_addr); |
| extern int ospf_area_nssa_translator_role_set (struct ospf *, struct in_addr, |
| int); |
| extern int ospf_area_export_list_set (struct ospf *, struct ospf_area *, |
| const char *); |
| extern int ospf_area_export_list_unset (struct ospf *, struct ospf_area *); |
| extern int ospf_area_import_list_set (struct ospf *, struct ospf_area *, |
| const char *); |
| extern int ospf_area_import_list_unset (struct ospf *, struct ospf_area *); |
| extern int ospf_area_shortcut_set (struct ospf *, struct ospf_area *, int); |
| extern int ospf_area_shortcut_unset (struct ospf *, struct ospf_area *); |
| extern int ospf_timers_refresh_set (struct ospf *, int); |
| extern int ospf_timers_refresh_unset (struct ospf *); |
| extern int ospf_nbr_nbma_set (struct ospf *, struct in_addr); |
| extern int ospf_nbr_nbma_unset (struct ospf *, struct in_addr); |
| extern int ospf_nbr_nbma_priority_set (struct ospf *, struct in_addr, u_char); |
| extern int ospf_nbr_nbma_priority_unset (struct ospf *, struct in_addr); |
| extern int ospf_nbr_nbma_poll_interval_set (struct ospf *, struct in_addr, |
| unsigned int); |
| extern int ospf_nbr_nbma_poll_interval_unset (struct ospf *, struct in_addr); |
| extern void ospf_prefix_list_update (struct prefix_list *); |
| extern void ospf_init (void); |
| extern void ospf_if_update (struct ospf *, struct interface *); |
| extern void ospf_ls_upd_queue_empty (struct ospf_interface *); |
| extern void ospf_terminate (void); |
| extern void ospf_nbr_nbma_if_update (struct ospf *, struct ospf_interface *); |
| extern struct ospf_nbr_nbma *ospf_nbr_nbma_lookup (struct ospf *, |
| struct in_addr); |
| extern struct ospf_nbr_nbma *ospf_nbr_nbma_lookup_next (struct ospf *, |
| struct in_addr *, |
| int); |
| extern int ospf_oi_count (struct interface *); |
| |
| extern struct ospf_area *ospf_area_get (struct ospf *, struct in_addr, int); |
| extern void ospf_area_check_free (struct ospf *, struct in_addr); |
| extern struct ospf_area *ospf_area_lookup_by_area_id (struct ospf *, |
| struct in_addr); |
| extern void ospf_area_add_if (struct ospf_area *, struct ospf_interface *); |
| extern void ospf_area_del_if (struct ospf_area *, struct ospf_interface *); |
| |
| extern void ospf_interface_area_set (struct interface *); |
| extern void ospf_interface_area_unset (struct interface *); |
| |
| extern void ospf_route_map_init (void); |
| extern void ospf_snmp_init (void); |
| |
| extern void ospf_master_init (void); |
| |
| #endif /* _ZEBRA_OSPFD_H */ |