ospfd/ospf_opaque.h

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * This is an implementation of rfc2370.
   4  * Copyright (C) 2001 KDD R&D Laboratories, Inc.
   5  * http://www.kddlabs.co.jp/
   6  */
   7
   8 #ifndef _ZEBRA_OSPF_OPAQUE_H
   9 #define _ZEBRA_OSPF_OPAQUE_H
  10
  11 #include "vty.h"
  12 #include <lib/json.h>
  13
  14 #define IS_OPAQUE_LSA(type)                                                    \
  15         ((type) == OSPF_OPAQUE_LINK_LSA || (type) == OSPF_OPAQUE_AREA_LSA      \
  16          || (type) == OSPF_OPAQUE_AS_LSA)
  17
  18 /*
  19  * Opaque LSA's link state ID is redefined as follows.
  20  *
  21  *        24       16        8        0
  22  * +--------+--------+--------+--------+
  23  * |tttttttt|........|........|........|
  24  * +--------+--------+--------+--------+
  25  * |<-Type->|<------- Opaque ID ------>|
  26  */
  27 #define LSID_OPAQUE_TYPE_MASK   0xff000000      /*  8 bits */
  28 #define LSID_OPAQUE_ID_MASK     0x00ffffff      /* 24 bits */
  29
  30 #define GET_OPAQUE_TYPE(lsid) (((uint32_t)(lsid)&LSID_OPAQUE_TYPE_MASK) >> 24)
  31
  32 #define GET_OPAQUE_ID(lsid) ((uint32_t)(lsid)&LSID_OPAQUE_ID_MASK)
  33
  34 #define SET_OPAQUE_LSID(type, id)                                              \
  35         ((((unsigned)(type) << 24) & LSID_OPAQUE_TYPE_MASK)                    \
  36          | ((id)&LSID_OPAQUE_ID_MASK))
  37
  38 /*
  39  * Opaque LSA types will be assigned by IANA.
  40  * <http://www.iana.org/assignments/ospf-opaque-types>
  41  */
  42 #define OPAQUE_TYPE_TRAFFIC_ENGINEERING_LSA             1
  43 #define OPAQUE_TYPE_SYCAMORE_OPTICAL_TOPOLOGY_DESC      2
  44 #define OPAQUE_TYPE_GRACE_LSA                           3
  45 #define OPAQUE_TYPE_L1VPN_LSA                          5
  46 #define OPAQUE_TYPE_ROUTER_INFORMATION_LSA             4
  47 #define OPAQUE_TYPE_INTER_AS_LSA                       6
  48 #define OPAQUE_TYPE_EXTENDED_PREFIX_LSA                7
  49 #define OPAQUE_TYPE_EXTENDED_LINK_LSA                  8
  50 #define OPAQUE_TYPE_MAX                                8
  51
  52 /* Following types are proposed in internet-draft documents. */
  53 #define OPAQUE_TYPE_8021_QOSPF                          129
  54 #define OPAQUE_TYPE_SECONDARY_NEIGHBOR_DISCOVERY        224
  55 #define OPAQUE_TYPE_FLOODGATE                           225
  56
  57 /* Ugly hack to make use of an unallocated value for wildcard matching! */
  58 #define OPAQUE_TYPE_WILDCARD                            0
  59
  60 #define OPAQUE_TYPE_RANGE_UNASSIGNED(type)                                     \
  61         (OPAQUE_TYPE_MAX <= (type) && (type) <= 127)
  62
  63 #define OPAQUE_TYPE_RANGE_RESERVED(type) (127 < (type) && (type) <= 255)
  64
  65 #define OSPF_OPAQUE_LSA_MIN_SIZE 0 /* RFC5250 imposes no minimum */
  66
  67 #define VALID_OPAQUE_INFO_LEN(lsahdr)                                          \
  68         ((ntohs((lsahdr)->length) >= sizeof(struct lsa_header))                \
  69          && ((ntohs((lsahdr)->length) < OSPF_MAX_LSA_SIZE))                    \
  70          && ((ntohs((lsahdr)->length) % sizeof(uint32_t)) == 0))
  71
  72 /*
  73  * Following section defines generic TLV (type, length, value) macros,
  74  * used for various LSA opaque usage e.g. Traffic Engineering.
  75  */
  76 struct tlv_header {
  77         uint16_t type;   /* Type of Value */
  78         uint16_t length; /* Length of Value portion only, in bytes */
  79 };
  80
  81 #define TLV_HDR_SIZE    (sizeof(struct tlv_header))
  82
  83 #define TLV_BODY_SIZE(tlvh) (ROUNDUP(ntohs((tlvh)->length), sizeof(uint32_t)))
  84
  85 #define TLV_SIZE(tlvh)  (uint32_t)(TLV_HDR_SIZE + TLV_BODY_SIZE(tlvh))
  86
  87 #define TLV_HDR_TOP(lsah)                                                      \
  88         (struct tlv_header *)((char *)(lsah) + OSPF_LSA_HEADER_SIZE)
  89
  90 #define TLV_HDR_NEXT(tlvh)                                                     \
  91         (struct tlv_header *)((char *)(tlvh) + TLV_SIZE(tlvh))
  92
  93 #define TLV_HDR_SUBTLV(tlvh)                                                   \
  94         (struct tlv_header *)((char *)(tlvh) + TLV_HDR_SIZE)
  95
  96 #define TLV_DATA(tlvh)  (void *)((char *)(tlvh) + TLV_HDR_SIZE)
  97
  98 #define TLV_TYPE(tlvh)  tlvh.header.type
  99 #define TLV_LEN(tlvh)   tlvh.header.length
 100 #define TLV_HDR(tlvh)   tlvh.header
 101
 102 /* Following declaration concerns the Opaque LSA management */
 103 enum lsa_opcode { REORIGINATE_THIS_LSA, REFRESH_THIS_LSA, FLUSH_THIS_LSA };
 104
 105 /* Prototypes. */
 106
 107 extern void ospf_opaque_init(void);
 108 extern void ospf_opaque_term(void);
 109 extern void ospf_opaque_finish(void);
 110 extern int ospf_opaque_type9_lsa_init(struct ospf_interface *oi);
 111 extern void ospf_opaque_type9_lsa_term(struct ospf_interface *oi);
 112 extern int ospf_opaque_type10_lsa_init(struct ospf_area *area);
 113 extern void ospf_opaque_type10_lsa_term(struct ospf_area *area);
 114 extern int ospf_opaque_type11_lsa_init(struct ospf *ospf);
 115 extern void ospf_opaque_type11_lsa_term(struct ospf *ospf);
 116
 117 extern int ospf_register_opaque_functab(
 118         uint8_t lsa_type, uint8_t opaque_type,
 119         int (*new_if_hook)(struct interface *ifp),
 120         int (*del_if_hook)(struct interface *ifp),
 121         void (*ism_change_hook)(struct ospf_interface *oi, int old_status),
 122         void (*nsm_change_hook)(struct ospf_neighbor *nbr, int old_status),
 123         void (*config_write_router)(struct vty *vty),
 124         void (*config_write_if)(struct vty *vty, struct interface *ifp),
 125         void (*config_write_debug)(struct vty *vty),
 126         void (*show_opaque_info)(struct vty *vty, struct json_object *json,
 127                                  struct ospf_lsa *lsa),
 128         int (*lsa_originator)(void *arg),
 129         struct ospf_lsa *(*lsa_refresher)(struct ospf_lsa *lsa),
 130         int (*new_lsa_hook)(struct ospf_lsa *lsa),
 131         int (*del_lsa_hook)(struct ospf_lsa *lsa));
 132 extern void ospf_delete_opaque_functab(uint8_t lsa_type, uint8_t opaque_type);
 133
 134 extern int ospf_opaque_new_if(struct interface *ifp);
 135 extern int ospf_opaque_del_if(struct interface *ifp);
 136 extern void ospf_opaque_ism_change(struct ospf_interface *oi, int old_status);
 137 extern void ospf_opaque_nsm_change(struct ospf_neighbor *nbr, int old_status);
 138 extern void ospf_opaque_config_write_router(struct vty *vty, struct ospf *ospf);
 139 extern void ospf_opaque_config_write_if(struct vty *vty, struct interface *ifp);
 140 extern void ospf_opaque_config_write_debug(struct vty *vty);
 141 extern void show_opaque_info_detail(struct vty *vty, struct ospf_lsa *lsa,
 142                                     json_object *json);
 143 extern void ospf_opaque_lsa_dump(struct stream *s, uint16_t length);
 144
 145 extern void ospf_opaque_lsa_originate_schedule(struct ospf_interface *oi,
 146                                                int *init_delay);
 147 extern struct ospf_lsa *ospf_opaque_lsa_install(struct ospf_lsa *lsa,
 148                                                 int rt_recalc);
 149 extern struct ospf_lsa *ospf_opaque_lsa_refresh(struct ospf_lsa *lsa);
 150
 151 extern void ospf_opaque_lsa_reoriginate_schedule(void *lsa_type_dependent,
 152                                                  uint8_t lsa_type,
 153                                                  uint8_t opaque_type);
 154 extern void ospf_opaque_lsa_refresh_schedule(struct ospf_lsa *lsa);
 155 extern void ospf_opaque_lsa_flush_schedule(struct ospf_lsa *lsa);
 156
 157 extern void ospf_opaque_self_originated_lsa_received(struct ospf_neighbor *nbr,
 158                                                      struct ospf_lsa *lsa);
 159 extern struct ospf *oi_to_top(struct ospf_interface *oi);
 160
 161 extern int ospf_opaque_is_owned(struct ospf_lsa *lsa);
 162
 163 #endif /* _ZEBRA_OSPF_OPAQUE_H */