ospfd/ospf_lsa.h

   1 /*
   2  * OSPF Link State Advertisement
   3  * Copyright (C) 1999, 2000 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
  18  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  19  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  20  * 02111-1307, USA.
  21  */
  22
  23 #ifndef _ZEBRA_OSPF_LSA_H
  24 #define _ZEBRA_OSPF_LSA_H
  25
  26 #include "stream.h"
  27
  28 /* OSPF LSA Range definition. */
  29 #define OSPF_MIN_LSA            1  /* begin range here */
  30 #if defined (HAVE_OPAQUE_LSA)
  31 #define OSPF_MAX_LSA           12
  32 #else
  33 #define OSPF_MAX_LSA            8
  34 #endif
  35
  36 /* OSPF LSA Type definition. */
  37 #define OSPF_UNKNOWN_LSA              0
  38 #define OSPF_ROUTER_LSA               1
  39 #define OSPF_NETWORK_LSA              2
  40 #define OSPF_SUMMARY_LSA              3
  41 #define OSPF_ASBR_SUMMARY_LSA         4
  42 #define OSPF_AS_EXTERNAL_LSA          5
  43 #define OSPF_GROUP_MEMBER_LSA         6  /* Not supported. */
  44 #define OSPF_AS_NSSA_LSA                      7
  45 #define OSPF_EXTERNAL_ATTRIBUTES_LSA  8  /* Not supported. */
  46 #define OSPF_OPAQUE_LINK_LSA          9
  47 #define OSPF_OPAQUE_AREA_LSA         10
  48 #define OSPF_OPAQUE_AS_LSA           11
  49
  50 #define OSPF_LSA_HEADER_SIZE         20U
  51 #define OSPF_ROUTER_LSA_LINK_SIZE    12U
  52 #define OSPF_MAX_LSA_SIZE          1500U
  53
  54 /* AS-external-LSA refresh method. */
  55 #define LSA_REFRESH_IF_CHANGED  0
  56 #define LSA_REFRESH_FORCE       1
  57
  58 /* OSPF LSA header. */
  59 struct lsa_header
  60 {
  61   u_int16_t ls_age;
  62   u_char options;
  63   u_char type;
  64   struct in_addr id;
  65   struct in_addr adv_router;
  66   u_int32_t ls_seqnum;
  67   u_int16_t checksum;
  68   u_int16_t length;
  69 };
  70
  71 /* OSPF LSA. */
  72 struct ospf_lsa
  73 {
  74   /* LSA origination flag. */
  75   u_char flags;
  76 #define OSPF_LSA_SELF             0x01
  77 #define OSPF_LSA_SELF_CHECKED     0x02
  78 #define OSPF_LSA_RECEIVED         0x04
  79 #define OSPF_LSA_APPROVED         0x08
  80 #define OSPF_LSA_DISCARD          0x10
  81 #define OSPF_LSA_LOCAL_XLT        0x20
  82 #define OSPF_LSA_PREMATURE_AGE    0x40
  83
  84   /* LSA data. */
  85   struct lsa_header *data;
  86
  87   /* Received time stamp. */
  88   struct timeval tv_recv;
  89
  90   /* Last time it was originated */
  91   struct timeval tv_orig;
  92
  93   /* All of reference count, also lock to remove. */
  94   int lock;
  95
  96   /* Flags for the SPF calculation. */
  97   int stat;
  98   #define LSA_SPF_NOT_EXPLORED  -1
  99   #define LSA_SPF_IN_SPFTREE    -2
 100   /* If stat >= 0, stat is LSA position in candidates heap. */
 101
 102   /* References to this LSA in neighbor retransmission lists*/
 103   int retransmit_counter;
 104
 105   /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
 106   struct ospf_area *area;
 107
 108   /* Parent LSDB. */
 109   struct ospf_lsdb *lsdb;
 110
 111   /* Related Route. */
 112   void *route;
 113
 114   /* Refreshement List or Queue */
 115   int refresh_list;
 116
 117 #ifdef HAVE_OPAQUE_LSA
 118   /* For Type-9 Opaque-LSAs, reference to ospf-interface is required. */
 119   struct ospf_interface *oi;
 120 #endif /* HAVE_OPAQUE_LSA */
 121 };
 122
 123 /* OSPF LSA Link Type. */
 124 #define LSA_LINK_TYPE_POINTOPOINT      1
 125 #define LSA_LINK_TYPE_TRANSIT          2
 126 #define LSA_LINK_TYPE_STUB             3
 127 #define LSA_LINK_TYPE_VIRTUALLINK      4
 128
 129 /* OSPF Router LSA Flag. */
 130 #define ROUTER_LSA_BORDER              0x01 /* The router is an ABR */
 131 #define ROUTER_LSA_EXTERNAL            0x02 /* The router is an ASBR */
 132 #define ROUTER_LSA_VIRTUAL             0x04 /* The router has a VL in this area */
 133 #define ROUTER_LSA_NT                  0x10 /* The routers always translates Type-7 */
 134 #define ROUTER_LSA_SHORTCUT            0x20 /* Shortcut-ABR specific flag */
 135
 136 #define IS_ROUTER_LSA_VIRTUAL(x)       ((x)->flags & ROUTER_LSA_VIRTUAL)
 137 #define IS_ROUTER_LSA_EXTERNAL(x)      ((x)->flags & ROUTER_LSA_EXTERNAL)
 138 #define IS_ROUTER_LSA_BORDER(x)        ((x)->flags & ROUTER_LSA_BORDER)
 139 #define IS_ROUTER_LSA_SHORTCUT(x)      ((x)->flags & ROUTER_LSA_SHORTCUT)
 140 #define IS_ROUTER_LSA_NT(x)            ((x)->flags & ROUTER_LSA_NT)
 141
 142 /* OSPF Router-LSA Link information. */
 143 struct router_lsa_link
 144 {
 145   struct in_addr link_id;
 146   struct in_addr link_data;
 147   struct
 148   {
 149     u_char type;
 150     u_char tos_count;
 151     u_int16_t metric;
 152   } m[1];
 153 };
 154
 155 /* OSPF Router-LSAs structure. */
 156 struct router_lsa
 157 {
 158   struct lsa_header header;
 159   u_char flags;
 160   u_char zero;
 161   u_int16_t links;
 162   struct
 163   {
 164     struct in_addr link_id;
 165     struct in_addr link_data;
 166     u_char type;
 167     u_char tos;
 168     u_int16_t metric;
 169   } link[1];
 170 };
 171
 172 /* OSPF Network-LSAs structure. */
 173 struct network_lsa
 174 {
 175   struct lsa_header header;
 176   struct in_addr mask;
 177   struct in_addr routers[1];
 178 };
 179
 180 /* OSPF Summary-LSAs structure. */
 181 struct summary_lsa
 182 {
 183   struct lsa_header header;
 184   struct in_addr mask;
 185   u_char tos;
 186   u_char metric[3];
 187 };
 188
 189 /* OSPF AS-external-LSAs structure. */
 190 struct as_external_lsa
 191 {
 192   struct lsa_header header;
 193   struct in_addr mask;
 194   struct
 195   {
 196     u_char tos;
 197     u_char metric[3];
 198     struct in_addr fwd_addr;
 199     u_int32_t route_tag;
 200   } e[1];
 201 };
 202
 203 #ifdef HAVE_OPAQUE_LSA
 204 #include "ospfd/ospf_opaque.h"
 205 #endif /* HAVE_OPAQUE_LSA */
 206
 207 /* Macros. */
 208 #define GET_METRIC(x) get_metric(x)
 209 #define IS_EXTERNAL_METRIC(x)   ((x) & 0x80)
 210
 211 #define GET_AGE(x)     (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
 212 #define LS_AGE(x)      (OSPF_LSA_MAXAGE < get_age(x) ? \
 213                                            OSPF_LSA_MAXAGE : get_age(x))
 214 #define IS_LSA_SELF(L)          (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
 215 #define IS_LSA_MAXAGE(L)        (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
 216
 217 #define OSPF_LSA_UPDATE_DELAY           2
 218
 219 #define OSPF_LSA_UPDATE_TIMER_ON(T,F) \
 220       if (!(T)) \
 221         (T) = thread_add_timer (master, (F), 0, 2)
 222
 223 /* Prototypes. */
 224 /* XXX: Eek, time functions, similar are in lib/thread.c */
 225 extern struct timeval tv_adjust (struct timeval);
 226 extern int tv_ceil (struct timeval);
 227 extern int tv_floor (struct timeval);
 228 extern struct timeval int2tv (int);
 229 extern struct timeval tv_add (struct timeval, struct timeval);
 230 extern struct timeval tv_sub (struct timeval, struct timeval);
 231 extern int tv_cmp (struct timeval, struct timeval);
 232
 233 extern int get_age (struct ospf_lsa *);
 234 extern u_int16_t ospf_lsa_checksum (struct lsa_header *);
 235 extern int ospf_lsa_refresh_delay (struct ospf_lsa *);
 236
 237 extern const char *dump_lsa_key (struct ospf_lsa *);
 238 extern u_int32_t lsa_seqnum_increment (struct ospf_lsa *);
 239 extern void lsa_header_set (struct stream *, u_char, u_char, struct in_addr,
 240                      struct in_addr);
 241 extern struct ospf_neighbor *ospf_nbr_lookup_ptop (struct ospf_interface *);
 242
 243 /* Prototype for LSA primitive. */
 244 extern struct ospf_lsa *ospf_lsa_new (void);
 245 extern struct ospf_lsa *ospf_lsa_dup (struct ospf_lsa *);
 246 extern void ospf_lsa_free (struct ospf_lsa *);
 247 extern struct ospf_lsa *ospf_lsa_lock (struct ospf_lsa *);
 248 extern void ospf_lsa_unlock (struct ospf_lsa *);
 249 extern void ospf_lsa_discard (struct ospf_lsa *);
 250
 251 extern struct lsa_header *ospf_lsa_data_new (size_t);
 252 extern struct lsa_header *ospf_lsa_data_dup (struct lsa_header *);
 253 extern void ospf_lsa_data_free (struct lsa_header *);
 254
 255 /* Prototype for various LSAs */
 256 extern int ospf_router_lsa_update_timer (struct thread *);
 257 extern void ospf_router_lsa_timer_add (struct ospf_area *);
 258
 259 extern int ospf_network_lsa_refresh (struct ospf_lsa *, struct ospf_interface *);
 260 extern void ospf_network_lsa_timer_add (struct ospf_interface *);
 261
 262 extern struct ospf_lsa *ospf_summary_lsa_originate (struct prefix_ipv4 *, u_int32_t,
 263                                              struct ospf_area *);
 264 extern struct ospf_lsa *ospf_summary_asbr_lsa_originate (struct prefix_ipv4 *,
 265                                                   u_int32_t,
 266                                                   struct ospf_area *);
 267 extern struct ospf_lsa *ospf_summary_lsa_refresh (struct ospf *, struct ospf_lsa *);
 268 extern struct ospf_lsa *ospf_summary_asbr_lsa_refresh (struct ospf *, struct ospf_lsa *);
 269
 270 extern struct ospf_lsa *ospf_lsa_install (struct ospf *,
 271                                    struct ospf_interface *, struct ospf_lsa *);
 272
 273 extern void ospf_nssa_lsa_flush (struct ospf *ospf, struct prefix_ipv4 *p);
 274 extern void ospf_external_lsa_flush (struct ospf *, u_char, struct prefix_ipv4 *,
 275                               unsigned int /* , struct in_addr nexthop */);
 276
 277 extern struct in_addr ospf_get_ip_from_ifp (struct ospf_interface *);
 278
 279 extern struct ospf_lsa *ospf_external_lsa_originate (struct ospf *, struct external_info *);
 280 extern int ospf_external_lsa_originate_timer (struct thread *);
 281 extern struct ospf_lsa *ospf_lsa_lookup (struct ospf_area *, u_int32_t,
 282                                   struct in_addr, struct in_addr);
 283 extern struct ospf_lsa *ospf_lsa_lookup_by_id (struct ospf_area *,
 284                                         u_int32_t,
 285                                         struct in_addr);
 286 extern struct ospf_lsa *ospf_lsa_lookup_by_header (struct ospf_area *,
 287                                             struct lsa_header *);
 288 extern int ospf_lsa_more_recent (struct ospf_lsa *, struct ospf_lsa *);
 289 extern int ospf_lsa_different (struct ospf_lsa *, struct ospf_lsa *);
 290 extern void ospf_flush_self_originated_lsas_now (struct ospf *);
 291
 292 extern int ospf_lsa_is_self_originated (struct ospf *, struct ospf_lsa *);
 293
 294 extern struct ospf_lsa *ospf_lsa_lookup_by_prefix (struct ospf_lsdb *, u_char,
 295                                             struct prefix_ipv4 *,
 296                                             struct in_addr);
 297
 298 extern void ospf_lsa_maxage (struct ospf *, struct ospf_lsa *);
 299 extern u_int32_t get_metric (u_char *);
 300
 301 extern int ospf_lsa_maxage_walker (struct thread *);
 302
 303 extern void ospf_external_lsa_refresh_default (struct ospf *);
 304
 305 extern void ospf_external_lsa_refresh_type (struct ospf *, u_char, int);
 306 extern void ospf_external_lsa_refresh (struct ospf *, struct ospf_lsa *,
 307                                 struct external_info *, int);
 308 extern struct in_addr ospf_lsa_unique_id (struct ospf *, struct ospf_lsdb *, u_char,
 309                                    struct prefix_ipv4 *);
 310 extern void ospf_schedule_lsa_flood_area (struct ospf_area *, struct ospf_lsa *);
 311 extern void ospf_schedule_lsa_flush_area (struct ospf_area *, struct ospf_lsa *);
 312
 313 extern void ospf_refresher_register_lsa (struct ospf *, struct ospf_lsa *);
 314 extern void ospf_refresher_unregister_lsa (struct ospf *, struct ospf_lsa *);
 315 extern int ospf_lsa_refresh_walker (struct thread *);
 316
 317 extern void ospf_lsa_maxage_delete (struct ospf *, struct ospf_lsa *);
 318
 319 extern void ospf_discard_from_db (struct ospf *, struct ospf_lsdb *, struct ospf_lsa*);
 320 extern int is_prefix_default (struct prefix_ipv4 *);
 321
 322 extern int metric_type (struct ospf *, u_char);
 323 extern int metric_value (struct ospf *, u_char);
 324
 325 extern struct in_addr ospf_get_nssa_ip (struct ospf_area *);
 326 extern int ospf_translated_nssa_compare (struct ospf_lsa *, struct ospf_lsa *);
 327 extern struct ospf_lsa *ospf_translated_nssa_refresh (struct ospf *, struct ospf_lsa *,
 328                                    struct ospf_lsa *);
 329 extern struct ospf_lsa *ospf_translated_nssa_originate (struct ospf *, struct ospf_lsa *);
 330
 331 #endif /* _ZEBRA_OSPF_LSA_H */