ospfd/ospf_opaque.h

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