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