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