ospf6d/ospf6_lsa.h

   1 /*
   2  * Copyright (C) 2003 Yasuhiro Ohara
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef OSPF6_LSA_H
  22 #define OSPF6_LSA_H
  23 #include "ospf6_top.h"
  24 #include "lib/json.h"
  25
  26 /* Debug option */
  27 #define OSPF6_LSA_DEBUG           0x01
  28 #define OSPF6_LSA_DEBUG_ORIGINATE 0x02
  29 #define OSPF6_LSA_DEBUG_EXAMIN    0x04
  30 #define OSPF6_LSA_DEBUG_FLOOD     0x08
  31 #define OSPF6_LSA_DEBUG_AGGR      0x10
  32
  33 /* OSPF LSA Default metric values */
  34 #define DEFAULT_DEFAULT_METRIC 20
  35 #define DEFAULT_DEFAULT_ORIGINATE_METRIC 10
  36 #define DEFAULT_DEFAULT_ALWAYS_METRIC 1
  37 #define DEFAULT_METRIC_TYPE 2
  38
  39 #define IS_OSPF6_DEBUG_LSA(name)                                               \
  40         (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name)) & OSPF6_LSA_DEBUG)
  41 #define IS_OSPF6_DEBUG_ORIGINATE(name)                                         \
  42         (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name))                        \
  43          & OSPF6_LSA_DEBUG_ORIGINATE)
  44 #define IS_OSPF6_DEBUG_EXAMIN(name)                                            \
  45         (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name))                        \
  46          & OSPF6_LSA_DEBUG_EXAMIN)
  47 #define IS_OSPF6_DEBUG_LSA_TYPE(type)                                          \
  48         (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG)
  49 #define IS_OSPF6_DEBUG_ORIGINATE_TYPE(type)                                    \
  50         (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_ORIGINATE)
  51 #define IS_OSPF6_DEBUG_EXAMIN_TYPE(type)                                       \
  52         (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_EXAMIN)
  53 #define IS_OSPF6_DEBUG_FLOOD_TYPE(type)                                        \
  54         (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_FLOOD)
  55 #define IS_OSPF6_DEBUG_AGGR                                                    \
  56         (ospf6_lstype_debug(OSPF6_LSTYPE_AS_EXTERNAL) & OSPF6_LSA_DEBUG_AGGR)  \
  57
  58 /* LSA definition */
  59
  60 #define OSPF6_MAX_LSASIZE      4096
  61
  62 /* Type */
  63 #define OSPF6_LSTYPE_UNKNOWN          0x0000
  64 #define OSPF6_LSTYPE_ROUTER           0x2001
  65 #define OSPF6_LSTYPE_NETWORK          0x2002
  66 #define OSPF6_LSTYPE_INTER_PREFIX     0x2003
  67 #define OSPF6_LSTYPE_INTER_ROUTER     0x2004
  68 #define OSPF6_LSTYPE_AS_EXTERNAL      0x4005
  69 #define OSPF6_LSTYPE_GROUP_MEMBERSHIP 0x2006
  70 #define OSPF6_LSTYPE_TYPE_7           0x2007
  71 #define OSPF6_LSTYPE_LINK             0x0008
  72 #define OSPF6_LSTYPE_INTRA_PREFIX     0x2009
  73 #define OSPF6_LSTYPE_GRACE_LSA        0x000b
  74 #define OSPF6_LSTYPE_SIZE             0x000c
  75
  76 /* Masks for LS Type : RFC 2740 A.4.2.1 "LS type" */
  77 #define OSPF6_LSTYPE_UBIT_MASK        0x8000
  78 #define OSPF6_LSTYPE_SCOPE_MASK       0x6000
  79 #define OSPF6_LSTYPE_FCODE_MASK       0x1fff
  80
  81 /* LSA scope */
  82 #define OSPF6_SCOPE_LINKLOCAL  0x0000
  83 #define OSPF6_SCOPE_AREA       0x2000
  84 #define OSPF6_SCOPE_AS         0x4000
  85 #define OSPF6_SCOPE_RESERVED   0x6000
  86
  87 /* AS-external-LSA refresh method. */
  88 #define LSA_REFRESH_IF_CHANGED  0
  89 #define LSA_REFRESH_FORCE       1
  90
  91
  92 /* XXX U-bit handling should be treated here */
  93 #define OSPF6_LSA_SCOPE(type) (ntohs(type) & OSPF6_LSTYPE_SCOPE_MASK)
  94
  95 /* LSA Header */
  96 #define OSPF6_LSA_HEADER_SIZE                 20U
  97 struct ospf6_lsa_header {
  98         uint16_t age;   /* LS age */
  99         uint16_t type;       /* LS type */
 100         in_addr_t id;    /* Link State ID */
 101         in_addr_t adv_router; /* Advertising Router */
 102         uint32_t seqnum;     /* LS sequence number */
 103         uint16_t checksum;   /* LS checksum */
 104         uint16_t length;     /* LSA length */
 105 };
 106
 107 #define OSPF6_LSA_HEADER_END(h) ((caddr_t)(h) + sizeof(struct ospf6_lsa_header))
 108 #define OSPF6_LSA_SIZE(h) (ntohs(((struct ospf6_lsa_header *)(h))->length))
 109 #define OSPF6_LSA_END(h)                                                       \
 110         ((caddr_t)(h) + ntohs(((struct ospf6_lsa_header *)(h))->length))
 111 #define OSPF6_LSA_IS_TYPE(t, L)                                                \
 112         ((L)->header->type == htons(OSPF6_LSTYPE_##t) ? 1 : 0)
 113 #define OSPF6_LSA_IS_SAME(L1, L2)                                              \
 114         ((L1)->header->adv_router == (L2)->header->adv_router                  \
 115          && (L1)->header->id == (L2)->header->id                               \
 116          && (L1)->header->type == (L2)->header->type)
 117 #define OSPF6_LSA_IS_MATCH(t, i, a, L)                                         \
 118         ((L)->header->adv_router == (a) && (L)->header->id == (i)              \
 119          && (L)->header->type == (t))
 120 #define OSPF6_LSA_IS_DIFFER(L1, L2)  ospf6_lsa_is_differ (L1, L2)
 121 #define OSPF6_LSA_IS_MAXAGE(L) (ospf6_lsa_age_current (L) == OSPF_LSA_MAXAGE)
 122 #define OSPF6_LSA_IS_CHANGED(L1, L2) ospf6_lsa_is_changed (L1, L2)
 123 #define OSPF6_LSA_IS_SEQWRAP(L) ((L)->header->seqnum == htonl(OSPF_MAX_SEQUENCE_NUMBER + 1))
 124
 125
 126 struct ospf6_lsa {
 127         char name[64]; /* dump string */
 128
 129         struct route_node *rn;
 130
 131         unsigned char lock; /* reference counter */
 132         unsigned char flag; /* special meaning (e.g. floodback) */
 133
 134         struct timeval birth;      /* tv_sec when LS age 0 */
 135         struct timeval originated; /* used by MinLSInterval check */
 136         struct timeval received;   /* used by MinLSArrival check */
 137         struct timeval installed;
 138
 139         struct thread *expire;
 140         struct thread *refresh; /* For self-originated LSA */
 141
 142         int retrans_count;
 143
 144         struct ospf6_lsdb *lsdb;
 145
 146         in_addr_t external_lsa_id;
 147
 148         /* lsa instance */
 149         struct ospf6_lsa_header *header;
 150
 151         /*For topo chg detection in HELPER role*/
 152         bool tobe_acknowledged;
 153 };
 154
 155 #define OSPF6_LSA_HEADERONLY 0x01
 156 #define OSPF6_LSA_FLOODBACK  0x02
 157 #define OSPF6_LSA_DUPLICATE  0x04
 158 #define OSPF6_LSA_IMPLIEDACK 0x08
 159 #define OSPF6_LSA_UNAPPROVED 0x10
 160 #define OSPF6_LSA_SEQWRAPPED 0x20
 161 #define OSPF6_LSA_FLUSH      0x40
 162
 163 struct ospf6_lsa_handler {
 164         uint16_t lh_type; /* host byte order */
 165         const char *lh_name;
 166         const char *lh_short_name;
 167         int (*lh_show)(struct vty *, struct ospf6_lsa *, json_object *json_obj,
 168                        bool use_json);
 169         char *(*lh_get_prefix_str)(struct ospf6_lsa *, char *buf, int buflen,
 170                                    int pos);
 171
 172         uint8_t lh_debug;
 173 };
 174
 175 #define OSPF6_LSA_IS_KNOWN(t)                                                  \
 176         (ospf6_get_lsa_handler(t)->lh_type != OSPF6_LSTYPE_UNKNOWN ? 1 : 0)
 177
 178 extern vector ospf6_lsa_handler_vector;
 179
 180 /* Macro for LSA Origination */
 181 /* addr is (struct prefix *) */
 182 #define CONTINUE_IF_ADDRESS_LINKLOCAL(debug, addr)                             \
 183         if (IN6_IS_ADDR_LINKLOCAL(&(addr)->u.prefix6)) {                       \
 184                 if (debug)                                                     \
 185                         zlog_debug("Filter out Linklocal: %pFX", addr);        \
 186                 continue;                                                      \
 187         }
 188
 189 #define CONTINUE_IF_ADDRESS_UNSPECIFIED(debug, addr)                           \
 190         if (IN6_IS_ADDR_UNSPECIFIED(&(addr)->u.prefix6)) {                     \
 191                 if (debug)                                                     \
 192                         zlog_debug("Filter out Unspecified: %pFX", addr);      \
 193                 continue;                                                      \
 194         }
 195
 196 #define CONTINUE_IF_ADDRESS_LOOPBACK(debug, addr)                              \
 197         if (IN6_IS_ADDR_LOOPBACK(&(addr)->u.prefix6)) {                        \
 198                 if (debug)                                                     \
 199                         zlog_debug("Filter out Loopback: %pFX", addr);         \
 200                 continue;                                                      \
 201         }
 202
 203 #define CONTINUE_IF_ADDRESS_V4COMPAT(debug, addr)                              \
 204         if (IN6_IS_ADDR_V4COMPAT(&(addr)->u.prefix6)) {                        \
 205                 if (debug)                                                     \
 206                         zlog_debug("Filter out V4Compat: %pFX", addr);         \
 207                 continue;                                                      \
 208         }
 209
 210 #define CONTINUE_IF_ADDRESS_V4MAPPED(debug, addr)                              \
 211         if (IN6_IS_ADDR_V4MAPPED(&(addr)->u.prefix6)) {                        \
 212                 if (debug)                                                     \
 213                         zlog_debug("Filter out V4Mapped: %pFX", addr);         \
 214                 continue;                                                      \
 215         }
 216
 217 #define CHECK_LSA_TOPO_CHG_ELIGIBLE(type)               \
 218         ((type == OSPF6_LSTYPE_ROUTER)                  \
 219          || (type == OSPF6_LSTYPE_NETWORK)              \
 220          || (type == OSPF6_LSTYPE_INTER_PREFIX)         \
 221          || (type == OSPF6_LSTYPE_INTER_ROUTER)         \
 222          || (type == OSPF6_LSTYPE_AS_EXTERNAL)          \
 223          || (type == OSPF6_LSTYPE_TYPE_7)               \
 224          || (type == OSPF6_LSTYPE_INTRA_PREFIX))
 225
 226 /* Function Prototypes */
 227 extern const char *ospf6_lstype_name(uint16_t type);
 228 extern const char *ospf6_lstype_short_name(uint16_t type);
 229 extern uint8_t ospf6_lstype_debug(uint16_t type);
 230 extern int metric_type(struct ospf6 *ospf6, int type, uint8_t instance);
 231 extern int metric_value(struct ospf6 *ospf6, int type, uint8_t instance);
 232 extern int ospf6_lsa_is_differ(struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
 233 extern int ospf6_lsa_is_changed(struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
 234 extern uint16_t ospf6_lsa_age_current(struct ospf6_lsa *lsa);
 235 extern void ospf6_lsa_age_update_to_send(struct ospf6_lsa *lsa,
 236                                          uint32_t transdelay);
 237 extern void ospf6_lsa_premature_aging(struct ospf6_lsa *lsa);
 238 extern int ospf6_lsa_compare(struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
 239
 240 extern char *ospf6_lsa_printbuf(struct ospf6_lsa *lsa, char *buf, int size);
 241 extern void ospf6_lsa_header_print_raw(struct ospf6_lsa_header *header);
 242 extern void ospf6_lsa_header_print(struct ospf6_lsa *lsa);
 243 extern void ospf6_lsa_show_summary_header(struct vty *vty);
 244 extern void ospf6_lsa_show_summary(struct vty *vty, struct ospf6_lsa *lsa,
 245                                    json_object *json, bool use_json);
 246 extern void ospf6_lsa_show_dump(struct vty *vty, struct ospf6_lsa *lsa,
 247                                 json_object *json, bool use_json);
 248 extern void ospf6_lsa_show_internal(struct vty *vty, struct ospf6_lsa *lsa,
 249                                     json_object *json, bool use_json);
 250 extern void ospf6_lsa_show(struct vty *vty, struct ospf6_lsa *lsa,
 251                            json_object *json, bool use_json);
 252
 253 extern struct ospf6_lsa *ospf6_lsa_alloc(size_t lsa_length);
 254 extern struct ospf6_lsa *ospf6_lsa_create(struct ospf6_lsa_header *header);
 255 extern struct ospf6_lsa *
 256 ospf6_lsa_create_headeronly(struct ospf6_lsa_header *header);
 257 extern void ospf6_lsa_delete(struct ospf6_lsa *lsa);
 258 extern struct ospf6_lsa *ospf6_lsa_copy(struct ospf6_lsa *lsa);
 259
 260 extern struct ospf6_lsa *ospf6_lsa_lock(struct ospf6_lsa *lsa);
 261 extern struct ospf6_lsa *ospf6_lsa_unlock(struct ospf6_lsa *lsa);
 262
 263 extern int ospf6_lsa_expire(struct thread *thread);
 264 extern int ospf6_lsa_refresh(struct thread *thread);
 265
 266 extern unsigned short ospf6_lsa_checksum(struct ospf6_lsa_header *lsah);
 267 extern int ospf6_lsa_checksum_valid(struct ospf6_lsa_header *lsah);
 268 extern int ospf6_lsa_prohibited_duration(uint16_t type, uint32_t id,
 269                                          uint32_t adv_router, void *scope);
 270
 271 extern void ospf6_install_lsa_handler(struct ospf6_lsa_handler *handler);
 272 extern struct ospf6_lsa_handler *ospf6_get_lsa_handler(uint16_t type);
 273
 274 extern void ospf6_lsa_init(void);
 275 extern void ospf6_lsa_terminate(void);
 276
 277 extern int config_write_ospf6_debug_lsa(struct vty *vty);
 278 extern void install_element_ospf6_debug_lsa(void);
 279 extern void ospf6_lsa_age_set(struct ospf6_lsa *lsa);
 280 extern void ospf6_flush_self_originated_lsas_now(struct ospf6 *ospf6);
 281 extern struct ospf6 *ospf6_get_by_lsdb(struct ospf6_lsa *lsa);
 282 struct ospf6_lsa *ospf6_find_external_lsa(struct ospf6 *ospf6,
 283                                           struct prefix *p);
 284 #endif /* OSPF6_LSA_H */