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