ospfd/ospf_interface.h

   1 /*
   2  * OSPF Interface functions.
   3  * Copyright (C) 1999 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
   8  * it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2, or (at your
  10  * option) any 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
  18  * along with GNU Zebra; see the file COPYING.  If not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef _ZEBRA_OSPF_INTERFACE_H
  24 #define _ZEBRA_OSPF_INTERFACE_H
  25
  26 #include "qobj.h"
  27 #include "hook.h"
  28 #include "ospfd/ospf_packet.h"
  29 #include "ospfd/ospf_spf.h"
  30
  31 #define IF_OSPF_IF_INFO(I) ((struct ospf_if_info *)((I)->info))
  32 #define IF_DEF_PARAMS(I) (IF_OSPF_IF_INFO (I)->def_params)
  33 #define IF_OIFS(I)  (IF_OSPF_IF_INFO (I)->oifs)
  34 #define IF_OIFS_PARAMS(I) (IF_OSPF_IF_INFO (I)->params)
  35
  36 #define OSPF_IF_PARAM_CONFIGURED(S, P) ((S) && (S)->P##__config)
  37 #define OSPF_IF_PARAM(O, P) \
  38         (OSPF_IF_PARAM_CONFIGURED ((O)->params, P)?\
  39                         (O)->params->P:IF_DEF_PARAMS((O)->ifp)->P)
  40
  41 #define DECLARE_IF_PARAM(T, P) T P; u_char P##__config:1
  42 #define UNSET_IF_PARAM(S, P) ((S)->P##__config) = 0
  43 #define SET_IF_PARAM(S, P) ((S)->P##__config) = 1
  44
  45 struct ospf_if_params
  46 {
  47   DECLARE_IF_PARAM (u_int32_t, transmit_delay); /* Interface Transmisson Delay */
  48   DECLARE_IF_PARAM (u_int32_t, output_cost_cmd);/* Command Interface Output Cost */
  49   DECLARE_IF_PARAM (u_int32_t, retransmit_interval); /* Retransmission Interval */
  50   DECLARE_IF_PARAM (u_char, passive_interface);      /* OSPF Interface is passive: no sending or receiving (no need to join multicast groups) */
  51   DECLARE_IF_PARAM (u_char, priority);               /* OSPF Interface priority */
  52   /* Enable OSPF on this interface with area if_area */
  53   DECLARE_IF_PARAM (struct in_addr, if_area);
  54   DECLARE_IF_PARAM (u_char, type);                   /* type of interface */
  55 #define OSPF_IF_ACTIVE                  0
  56 #define OSPF_IF_PASSIVE                 1
  57
  58 #define OSPF_IF_PASSIVE_STATUS(O) \
  59        (OSPF_IF_PARAM_CONFIGURED((O)->params, passive_interface) ? \
  60          (O)->params->passive_interface : \
  61          (OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS((O)->ifp), passive_interface) ? \
  62            IF_DEF_PARAMS((O)->ifp)->passive_interface : \
  63            (O)->ospf->passive_interface_default))
  64
  65   DECLARE_IF_PARAM (u_int32_t, v_hello);             /* Hello Interval */
  66   DECLARE_IF_PARAM (u_int32_t, v_wait);              /* Router Dead Interval */
  67
  68   /* MTU mismatch check (see RFC2328, chap 10.6) */
  69   DECLARE_IF_PARAM (u_char, mtu_ignore);
  70
  71   /* Fast-Hellos */
  72   DECLARE_IF_PARAM (u_char, fast_hello);
  73
  74   /* Authentication data. */
  75   u_char auth_simple[OSPF_AUTH_SIMPLE_SIZE + 1];       /* Simple password. */
  76   u_char auth_simple__config:1;
  77
  78   DECLARE_IF_PARAM (struct list *, auth_crypt);    /* List of Auth cryptographic data. */
  79   DECLARE_IF_PARAM (int, auth_type);               /* OSPF authentication type */
  80
  81   /* Other, non-configuration state */
  82   u_int32_t network_lsa_seqnum;         /* Network LSA seqnum */
  83
  84   /* BFD configuration */
  85   struct bfd_info *bfd_info;
  86 };
  87
  88 enum
  89 {
  90   MEMBER_ALLROUTERS = 0,
  91   MEMBER_DROUTERS,
  92   MEMBER_MAX,
  93 };
  94
  95 struct ospf_if_info
  96 {
  97   struct ospf_if_params *def_params;
  98   struct route_table *params;
  99   struct route_table *oifs;
 100   unsigned int membership_counts[MEMBER_MAX];   /* multicast group refcnts */
 101 };
 102
 103 struct ospf_interface;
 104
 105 struct ospf_vl_data
 106 {
 107   struct in_addr    vl_peer;      /* Router-ID of the peer */
 108   struct in_addr    vl_area_id;   /* Transit area */
 109   int vl_area_id_fmt;             /* Area ID format */
 110   struct ospf_interface *vl_oi;   /* Interface data structure */
 111   struct vertex_nexthop nexthop;  /* Nexthop router and oi to use */
 112   struct in_addr    peer_addr;    /* Address used to reach the peer */
 113   u_char flags;
 114 };
 115
 116
 117 #define OSPF_VL_MAX_COUNT 256
 118 #define OSPF_VL_MTU       1500
 119
 120 #define OSPF_VL_FLAG_APPROVED 0x01
 121
 122 struct crypt_key
 123 {
 124   u_char key_id;
 125   u_char auth_key[OSPF_AUTH_MD5_SIZE + 1];
 126 };
 127
 128 /* OSPF interface structure. */
 129 struct ospf_interface
 130 {
 131   /* This interface's parent ospf instance. */
 132   struct ospf *ospf;
 133
 134   /* OSPF Area. */
 135   struct ospf_area *area;
 136
 137   /* Position range in Router LSA */
 138   uint16_t lsa_pos_beg; /* inclusive, >= */
 139   uint16_t lsa_pos_end; /* exclusive, <  */
 140
 141   /* Interface data from zebra. */
 142   struct interface *ifp;
 143   struct ospf_vl_data *vl_data;         /* Data for Virtual Link */
 144
 145   /* Packet send buffer. */
 146   struct ospf_fifo *obuf;               /* Output queue */
 147
 148   /* OSPF Network Type. */
 149   u_char type;
 150
 151   /* State of Interface State Machine. */
 152   u_char state;
 153
 154   /* To which multicast groups do we currently belong? */
 155   u_char multicast_memberships;
 156 #define OI_MEMBER_FLAG(M) (1 << (M))
 157 #define OI_MEMBER_COUNT(O,M) (IF_OSPF_IF_INFO(oi->ifp)->membership_counts[(M)])
 158 #define OI_MEMBER_CHECK(O,M) \
 159     (CHECK_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)))
 160 #define OI_MEMBER_JOINED(O,M) \
 161   do { \
 162     SET_FLAG ((O)->multicast_memberships, OI_MEMBER_FLAG(M)); \
 163     IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]++; \
 164   } while (0)
 165 #define OI_MEMBER_LEFT(O,M) \
 166   do { \
 167     UNSET_FLAG ((O)->multicast_memberships, OI_MEMBER_FLAG(M)); \
 168     IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]--; \
 169   } while (0)
 170
 171   struct prefix *address;               /* Interface prefix */
 172   struct connected *connected;          /* Pointer to connected */
 173
 174   /* Configured varables. */
 175   struct ospf_if_params *params;
 176
 177   u_int32_t crypt_seqnum;               /* Cryptographic Sequence Number */
 178   u_int32_t output_cost;                /* Acutual Interface Output Cost */
 179
 180   /* Neighbor information. */
 181   struct route_table *nbrs;             /* OSPF Neighbor List */
 182   struct ospf_neighbor *nbr_self;       /* Neighbor Self */
 183 #define DR(I)                   ((I)->nbr_self->d_router)
 184 #define BDR(I)                  ((I)->nbr_self->bd_router)
 185 #define OPTIONS(I)              ((I)->nbr_self->options)
 186 #define PRIORITY(I)             ((I)->nbr_self->priority)
 187
 188   /* List of configured NBMA neighbor. */
 189   struct list *nbr_nbma;
 190
 191   /* self-originated LSAs. */
 192   struct ospf_lsa *network_lsa_self;    /* network-LSA. */
 193   struct list *opaque_lsa_self;                 /* Type-9 Opaque-LSAs */
 194
 195   struct route_table *ls_upd_queue;
 196
 197   struct list *ls_ack;                  /* Link State Acknowledgment list. */
 198
 199   struct
 200   {
 201     struct list *ls_ack;
 202     struct in_addr dst;
 203   } ls_ack_direct;
 204
 205   /* Timer values. */
 206   u_int32_t v_ls_ack;                   /* Delayed Link State Acknowledgment */
 207
 208   /* Threads. */
 209   struct thread *t_hello;               /* timer */
 210   struct thread *t_wait;                /* timer */
 211   struct thread *t_ls_ack;              /* timer */
 212   struct thread *t_ls_ack_direct;       /* event */
 213   struct thread *t_ls_upd_event;        /* event */
 214   struct thread *t_opaque_lsa_self;     /* Type-9 Opaque-LSAs */
 215
 216   int on_write_q;
 217
 218   /* Statistics fields. */
 219   u_int32_t hello_in;           /* Hello message input count. */
 220   u_int32_t hello_out;          /* Hello message output count. */
 221   u_int32_t db_desc_in;         /* database desc. message input count. */
 222   u_int32_t db_desc_out;        /* database desc. message output count. */
 223   u_int32_t ls_req_in;          /* LS request message input count. */
 224   u_int32_t ls_req_out;         /* LS request message output count. */
 225   u_int32_t ls_upd_in;          /* LS update message input count. */
 226   u_int32_t ls_upd_out;         /* LS update message output count. */
 227   u_int32_t ls_ack_in;          /* LS Ack message input count. */
 228   u_int32_t ls_ack_out;         /* LS Ack message output count. */
 229   u_int32_t discarded;          /* discarded input count by error. */
 230   u_int32_t state_change;       /* Number of status change. */
 231
 232   u_int32_t full_nbrs;
 233
 234   QOBJ_FIELDS
 235 };
 236 DECLARE_QOBJ_TYPE(ospf_interface)
 237
 238 /* Prototypes. */
 239 extern char *ospf_if_name (struct ospf_interface *);
 240 extern struct ospf_interface *ospf_if_new (struct ospf *, struct interface *,
 241                                            struct prefix *);
 242 extern void ospf_if_cleanup (struct ospf_interface *);
 243 extern void ospf_if_free (struct ospf_interface *);
 244 extern int ospf_if_up (struct ospf_interface *);
 245 extern int ospf_if_down (struct ospf_interface *);
 246
 247 extern int ospf_if_is_up (struct ospf_interface *);
 248 extern struct ospf_interface *ospf_if_exists (struct ospf_interface *);
 249 extern struct ospf_interface *ospf_if_lookup_by_lsa_pos (struct ospf_area *,
 250                                                          int);
 251 extern struct ospf_interface *ospf_if_lookup_by_local_addr (struct ospf *,
 252                                                             struct interface
 253                                                             *,
 254                                                             struct in_addr);
 255 extern struct ospf_interface *ospf_if_lookup_by_prefix (struct ospf *,
 256                                                         struct prefix_ipv4 *);
 257 extern struct ospf_interface *ospf_if_table_lookup (struct interface *,
 258                                                     struct prefix *);
 259 extern struct ospf_interface *ospf_if_addr_local (struct in_addr);
 260 extern struct ospf_interface *ospf_if_lookup_recv_if (struct ospf *,
 261                                                       struct in_addr,
 262                                                       struct interface *);
 263 extern struct ospf_interface *ospf_if_is_configured (struct ospf *,
 264                                                      struct in_addr *);
 265
 266 extern struct ospf_if_params *ospf_lookup_if_params (struct interface *,
 267                                                      struct in_addr);
 268 extern struct ospf_if_params *ospf_get_if_params (struct interface *,
 269                                                   struct in_addr);
 270 extern void ospf_del_if_params (struct ospf_if_params *);
 271 extern void ospf_free_if_params (struct interface *, struct in_addr);
 272 extern void ospf_if_update_params (struct interface *, struct in_addr);
 273
 274 extern int ospf_if_new_hook (struct interface *);
 275 extern void ospf_if_init (void);
 276 extern void ospf_if_stream_set (struct ospf_interface *);
 277 extern void ospf_if_stream_unset (struct ospf_interface *);
 278 extern void ospf_if_reset_variables (struct ospf_interface *);
 279 extern int ospf_if_is_enable (struct ospf_interface *);
 280 extern int ospf_if_get_output_cost (struct ospf_interface *);
 281 extern void ospf_if_recalculate_output_cost (struct interface *);
 282
 283 /* Simulate down/up on the interface. */
 284 extern void ospf_if_reset (struct interface *);
 285
 286 extern struct ospf_interface *ospf_vl_new (struct ospf *,
 287                                            struct ospf_vl_data *);
 288 extern struct ospf_vl_data *ospf_vl_data_new (struct ospf_area *,
 289                                               struct in_addr);
 290 extern struct ospf_vl_data *ospf_vl_lookup (struct ospf *, struct ospf_area *,
 291                                             struct in_addr);
 292 extern void ospf_vl_data_free (struct ospf_vl_data *);
 293 extern void ospf_vl_add (struct ospf *, struct ospf_vl_data *);
 294 extern void ospf_vl_delete (struct ospf *, struct ospf_vl_data *);
 295 extern void ospf_vl_up_check (struct ospf_area *, struct in_addr,
 296                               struct vertex *);
 297 extern void ospf_vl_unapprove (struct ospf *);
 298 extern void ospf_vl_shut_unapproved (struct ospf *);
 299 extern int ospf_full_virtual_nbrs (struct ospf_area *);
 300 extern int ospf_vls_in_area (struct ospf_area *);
 301
 302 extern struct crypt_key *ospf_crypt_key_lookup (struct list *, u_char);
 303 extern struct crypt_key *ospf_crypt_key_new (void);
 304 extern void ospf_crypt_key_add (struct list *, struct crypt_key *);
 305 extern int ospf_crypt_key_delete (struct list *, u_char);
 306
 307 extern u_char ospf_default_iftype (struct interface *ifp);
 308
 309 /* Set all multicast memberships appropriately based on the type and
 310    state of the interface. */
 311 extern void ospf_if_set_multicast (struct ospf_interface *);
 312
 313 DECLARE_HOOK(ospf_vl_add, (struct ospf_vl_data *vd), (vd))
 314 DECLARE_HOOK(ospf_vl_delete, (struct ospf_vl_data *vd), (vd))
 315
 316 #endif /* _ZEBRA_OSPF_INTERFACE_H */