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 #define OSPF_LSA_IN_MAXAGE        0x80
  84
  85   /* LSA data. */
  86   struct lsa_header *data;
  87
  88   /* Received time stamp. */
  89   struct timeval tv_recv;
  90
  91   /* Last time it was originated */
  92   struct timeval tv_orig;
  93
  94   /* All of reference count, also lock to remove. */
  95   int lock;
  96
  97   /* Flags for the SPF calculation. */
  98   int stat;
  99   #define LSA_SPF_NOT_EXPLORED  -1
 100   #define LSA_SPF_IN_SPFTREE    -2
 101   /* If stat >= 0, stat is LSA position in candidates heap. */
 102
 103   /* References to this LSA in neighbor retransmission lists*/
 104   int retransmit_counter;
 105
 106   /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
 107   struct ospf_area *area;
 108
 109   /* Parent LSDB. */
 110   struct ospf_lsdb *lsdb;
 111
 112   /* Related Route. */
 113   void *route;
 114
 115   /* Refreshement List or Queue */
 116   int refresh_list;
 117
 118 #ifdef HAVE_OPAQUE_LSA
 119   /* For Type-9 Opaque-LSAs, reference to ospf-interface is required. */
 120   struct ospf_interface *oi;
 121 #endif /* HAVE_OPAQUE_LSA */
 122 };
 123
 124 /* OSPF LSA Link Type. */
 125 #define LSA_LINK_TYPE_POINTOPOINT      1
 126 #define LSA_LINK_TYPE_TRANSIT          2
 127 #define LSA_LINK_TYPE_STUB             3
 128 #define LSA_LINK_TYPE_VIRTUALLINK      4
 129
 130 /* OSPF Router LSA Flag. */
 131 #define ROUTER_LSA_BORDER              0x01 /* The router is an ABR */
 132 #define ROUTER_LSA_EXTERNAL            0x02 /* The router is an ASBR */
 133 #define ROUTER_LSA_VIRTUAL             0x04 /* The router has a VL in this area */
 134 #define ROUTER_LSA_NT                  0x10 /* The routers always translates Type-7 */
 135 #define ROUTER_LSA_SHORTCUT            0x20 /* Shortcut-ABR specific flag */
 136
 137 #define IS_ROUTER_LSA_VIRTUAL(x)       ((x)->flags & ROUTER_LSA_VIRTUAL)
 138 #define IS_ROUTER_LSA_EXTERNAL(x)      ((x)->flags & ROUTER_LSA_EXTERNAL)
 139 #define IS_ROUTER_LSA_BORDER(x)        ((x)->flags & ROUTER_LSA_BORDER)
 140 #define IS_ROUTER_LSA_SHORTCUT(x)      ((x)->flags & ROUTER_LSA_SHORTCUT)
 141 #define IS_ROUTER_LSA_NT(x)            ((x)->flags & ROUTER_LSA_NT)
 142
 143 /* OSPF Router-LSA Link information. */
 144 struct router_lsa_link
 145 {
 146   struct in_addr link_id;
 147   struct in_addr link_data;
 148   struct
 149   {
 150     u_char type;
 151     u_char tos_count;
 152     u_int16_t metric;
 153   } m[1];
 154 };
 155
 156 /* OSPF Router-LSAs structure. */
 157 struct router_lsa
 158 {
 159   struct lsa_header header;
 160   u_char flags;
 161   u_char zero;
 162   u_int16_t links;
 163   struct
 164   {
 165     struct in_addr link_id;
 166     struct in_addr link_data;
 167     u_char type;
 168     u_char tos;
 169     u_int16_t metric;
 170   } link[1];
 171 };
 172
 173 /* OSPF Network-LSAs structure. */
 174 struct network_lsa
 175 {
 176   struct lsa_header header;
 177   struct in_addr mask;
 178   struct in_addr routers[1];
 179 };
 180
 181 /* OSPF Summary-LSAs structure. */
 182 struct summary_lsa
 183 {
 184   struct lsa_header header;
 185   struct in_addr mask;
 186   u_char tos;
 187   u_char metric[3];
 188 };
 189
 190 /* OSPF AS-external-LSAs structure. */
 191 struct as_external_lsa
 192 {
 193   struct lsa_header header;
 194   struct in_addr mask;
 195   struct
 196   {
 197     u_char tos;
 198     u_char metric[3];
 199     struct in_addr fwd_addr;
 200     u_int32_t route_tag;
 201   } e[1];
 202 };
 203
 204 #ifdef HAVE_OPAQUE_LSA
 205 #include "ospfd/ospf_opaque.h"
 206 #endif /* HAVE_OPAQUE_LSA */
 207
 208 /* Macros. */
 209 #define GET_METRIC(x) get_metric(x)
 210 #define IS_EXTERNAL_METRIC(x)   ((x) & 0x80)
 211
 212 #define GET_AGE(x)     (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
 213 #define LS_AGE(x)      (OSPF_LSA_MAXAGE < get_age(x) ? \
 214                                            OSPF_LSA_MAXAGE : get_age(x))
 215 #define IS_LSA_SELF(L)          (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
 216 #define IS_LSA_MAXAGE(L)        (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
 217
 218 #define OSPF_LSA_UPDATE_DELAY           2
 219
 220 #define OSPF_LSA_UPDATE_TIMER_ON(T,F) \
 221       if (!(T)) \
 222         (T) = thread_add_timer (master, (F), 0, 2)
 223
 224 /* Prototypes. */
 225 /* XXX: Eek, time functions, similar are in lib/thread.c */
 226 extern struct timeval tv_adjust (struct timeval);
 227 extern int tv_ceil (struct timeval);
 228 extern int tv_floor (struct timeval);
 229 extern struct timeval int2tv (int);
 230 extern struct timeval tv_add (struct timeval, struct timeval);
 231 extern struct timeval tv_sub (struct timeval, struct timeval);
 232 extern int tv_cmp (struct timeval, struct timeval);
 233
 234 extern int get_age (struct ospf_lsa *);
 235 extern u_int16_t ospf_lsa_checksum (struct lsa_header *);
 236 extern int ospf_lsa_refresh_delay (struct ospf_lsa *);
 237
 238 extern const char *dump_lsa_key (struct ospf_lsa *);
 239 extern u_int32_t lsa_seqnum_increment (struct ospf_lsa *);
 240 extern void lsa_header_set (struct stream *, u_char, u_char, struct in_addr,
 241                      struct in_addr);
 242 extern struct ospf_neighbor *ospf_nbr_lookup_ptop (struct ospf_interface *);
 243
 244 /* Prototype for LSA primitive. */
 245 extern struct ospf_lsa *ospf_lsa_new (void);
 246 extern struct ospf_lsa *ospf_lsa_dup (struct ospf_lsa *);
 247 extern void ospf_lsa_free (struct ospf_lsa *);
 248 extern struct ospf_lsa *ospf_lsa_lock (struct ospf_lsa *);
 249 extern void ospf_lsa_unlock (struct ospf_lsa **);
 250 extern void ospf_lsa_discard (struct ospf_lsa *);
 251
 252 extern struct lsa_header *ospf_lsa_data_new (size_t);
 253 extern struct lsa_header *ospf_lsa_data_dup (struct lsa_header *);
 254 extern void ospf_lsa_data_free (struct lsa_header *);
 255
 256 /* Prototype for various LSAs */
 257 extern int ospf_router_lsa_update_timer (struct thread *);
 258 extern void ospf_router_lsa_timer_add (struct ospf_area *);
 259
 260 extern int ospf_network_lsa_refresh (struct ospf_lsa *, struct ospf_interface *);
 261 extern void ospf_network_lsa_timer_add (struct ospf_interface *);
 262
 263 extern struct ospf_lsa *ospf_summary_lsa_originate (struct prefix_ipv4 *, u_int32_t,
 264                                              struct ospf_area *);
 265 extern struct ospf_lsa *ospf_summary_asbr_lsa_originate (struct prefix_ipv4 *,
 266                                                   u_int32_t,
 267                                                   struct ospf_area *);
 268 extern struct ospf_lsa *ospf_summary_lsa_refresh (struct ospf *, struct ospf_lsa *);
 269 extern struct ospf_lsa *ospf_summary_asbr_lsa_refresh (struct ospf *, struct ospf_lsa *);
 270
 271 extern struct ospf_lsa *ospf_lsa_install (struct ospf *,
 272                                    struct ospf_interface *, struct ospf_lsa *);
 273
 274 extern void ospf_nssa_lsa_flush (struct ospf *ospf, struct prefix_ipv4 *p);
 275 extern void ospf_external_lsa_flush (struct ospf *, u_char, struct prefix_ipv4 *,
 276                               unsigned int /* , struct in_addr nexthop */);
 277
 278 extern struct in_addr ospf_get_ip_from_ifp (struct ospf_interface *);
 279
 280 extern struct ospf_lsa *ospf_external_lsa_originate (struct ospf *, struct external_info *);
 281 extern int ospf_external_lsa_originate_timer (struct thread *);
 282 extern struct ospf_lsa *ospf_lsa_lookup (struct ospf_area *, u_int32_t,
 283                                   struct in_addr, struct in_addr);
 284 extern struct ospf_lsa *ospf_lsa_lookup_by_id (struct ospf_area *,
 285                                         u_int32_t,
 286                                         struct in_addr);
 287 extern struct ospf_lsa *ospf_lsa_lookup_by_header (struct ospf_area *,
 288                                             struct lsa_header *);
 289 extern int ospf_lsa_more_recent (struct ospf_lsa *, struct ospf_lsa *);
 290 extern int ospf_lsa_different (struct ospf_lsa *, struct ospf_lsa *);
 291 extern void ospf_flush_self_originated_lsas_now (struct ospf *);
 292
 293 extern int ospf_lsa_is_self_originated (struct ospf *, struct ospf_lsa *);
 294
 295 extern struct ospf_lsa *ospf_lsa_lookup_by_prefix (struct ospf_lsdb *, u_char,
 296                                             struct prefix_ipv4 *,
 297                                             struct in_addr);
 298
 299 extern void ospf_lsa_maxage (struct ospf *, struct ospf_lsa *);
 300 extern u_int32_t get_metric (u_char *);
 301
 302 extern int ospf_lsa_maxage_walker (struct thread *);
 303
 304 extern void ospf_external_lsa_refresh_default (struct ospf *);
 305
 306 extern void ospf_external_lsa_refresh_type (struct ospf *, u_char, int);
 307 extern void ospf_external_lsa_refresh (struct ospf *, struct ospf_lsa *,
 308                                 struct external_info *, int);
 309 extern struct in_addr ospf_lsa_unique_id (struct ospf *, struct ospf_lsdb *, u_char,
 310                                    struct prefix_ipv4 *);
 311 extern void ospf_schedule_lsa_flood_area (struct ospf_area *, struct ospf_lsa *);
 312 extern void ospf_schedule_lsa_flush_area (struct ospf_area *, struct ospf_lsa *);
 313
 314 extern void ospf_refresher_register_lsa (struct ospf *, struct ospf_lsa *);
 315 extern void ospf_refresher_unregister_lsa (struct ospf *, struct ospf_lsa *);
 316 extern int ospf_lsa_refresh_walker (struct thread *);
 317
 318 extern void ospf_lsa_maxage_delete (struct ospf *, struct ospf_lsa *);
 319
 320 extern void ospf_discard_from_db (struct ospf *, struct ospf_lsdb *, struct ospf_lsa*);
 321 extern int is_prefix_default (struct prefix_ipv4 *);
 322
 323 extern int metric_type (struct ospf *, u_char);
 324 extern int metric_value (struct ospf *, u_char);
 325
 326 extern struct in_addr ospf_get_nssa_ip (struct ospf_area *);
 327 extern int ospf_translated_nssa_compare (struct ospf_lsa *, struct ospf_lsa *);
 328 extern struct ospf_lsa *ospf_translated_nssa_refresh (struct ospf *, struct ospf_lsa *,
 329                                    struct ospf_lsa *);
 330 extern struct ospf_lsa *ospf_translated_nssa_originate (struct ospf *, struct ospf_lsa *);
 331
 332 #endif /* _ZEBRA_OSPF_LSA_H */