2 * Copyright (C) 2003 Yasuhiro Ohara
4 * This file is part of GNU Zebra.
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
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.
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
23 #include "ospf6_top.h"
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_ALL \
32 (OSPF6_LSA_DEBUG | OSPF6_LSA_DEBUG_ORIGINATE | OSPF6_LSA_DEBUG_EXAMIN \
33 | OSPF6_LSA_DEBUG_FLOOD)
34 #define OSPF6_LSA_DEBUG_AGGR 0x10
36 /* OSPF LSA Default metric values */
37 #define DEFAULT_DEFAULT_METRIC 20
38 #define DEFAULT_DEFAULT_ORIGINATE_METRIC 10
39 #define DEFAULT_DEFAULT_ALWAYS_METRIC 1
40 #define DEFAULT_METRIC_TYPE 2
42 #define IS_OSPF6_DEBUG_LSA(name) \
43 (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name)) & OSPF6_LSA_DEBUG)
44 #define IS_OSPF6_DEBUG_ORIGINATE(name) \
45 (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name)) \
46 & OSPF6_LSA_DEBUG_ORIGINATE)
47 #define IS_OSPF6_DEBUG_EXAMIN(name) \
48 (ospf6_lstype_debug(htons(OSPF6_LSTYPE_##name)) \
49 & OSPF6_LSA_DEBUG_EXAMIN)
50 #define IS_OSPF6_DEBUG_LSA_TYPE(type) \
51 (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG)
52 #define IS_OSPF6_DEBUG_ORIGINATE_TYPE(type) \
53 (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_ORIGINATE)
54 #define IS_OSPF6_DEBUG_EXAMIN_TYPE(type) \
55 (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_EXAMIN)
56 #define IS_OSPF6_DEBUG_FLOOD_TYPE(type) \
57 (ospf6_lstype_debug(type) & OSPF6_LSA_DEBUG_FLOOD)
58 #define IS_OSPF6_DEBUG_AGGR \
59 (ospf6_lstype_debug(OSPF6_LSTYPE_AS_EXTERNAL) & OSPF6_LSA_DEBUG_AGGR) \
63 #define OSPF6_MAX_LSASIZE 4096
66 #define OSPF6_LSTYPE_UNKNOWN 0x0000
67 #define OSPF6_LSTYPE_ROUTER 0x2001
68 #define OSPF6_LSTYPE_NETWORK 0x2002
69 #define OSPF6_LSTYPE_INTER_PREFIX 0x2003
70 #define OSPF6_LSTYPE_INTER_ROUTER 0x2004
71 #define OSPF6_LSTYPE_AS_EXTERNAL 0x4005
72 #define OSPF6_LSTYPE_GROUP_MEMBERSHIP 0x2006
73 #define OSPF6_LSTYPE_TYPE_7 0x2007
74 #define OSPF6_LSTYPE_LINK 0x0008
75 #define OSPF6_LSTYPE_INTRA_PREFIX 0x2009
76 #define OSPF6_LSTYPE_GRACE_LSA 0x000b
77 #define OSPF6_LSTYPE_SIZE 0x000c
79 /* Masks for LS Type : RFC 2740 A.4.2.1 "LS type" */
80 #define OSPF6_LSTYPE_UBIT_MASK 0x8000
81 #define OSPF6_LSTYPE_SCOPE_MASK 0x6000
82 #define OSPF6_LSTYPE_FCODE_MASK 0x1fff
85 #define OSPF6_SCOPE_LINKLOCAL 0x0000
86 #define OSPF6_SCOPE_AREA 0x2000
87 #define OSPF6_SCOPE_AS 0x4000
88 #define OSPF6_SCOPE_RESERVED 0x6000
90 /* XXX U-bit handling should be treated here */
91 #define OSPF6_LSA_SCOPE(type) (ntohs(type) & OSPF6_LSTYPE_SCOPE_MASK)
94 #define OSPF6_LSA_HEADER_SIZE 20U
95 struct ospf6_lsa_header
{
96 uint16_t age
; /* LS age */
97 uint16_t type
; /* LS type */
98 in_addr_t id
; /* Link State ID */
99 in_addr_t adv_router
; /* Advertising Router */
100 uint32_t seqnum
; /* LS sequence number */
101 uint16_t checksum
; /* LS checksum */
102 uint16_t length
; /* LSA length */
105 #define OSPF6_LSA_HEADER_END(h) ((caddr_t)(h) + sizeof(struct ospf6_lsa_header))
106 #define OSPF6_LSA_SIZE(h) (ntohs(((struct ospf6_lsa_header *)(h))->length))
107 #define OSPF6_LSA_END(h) \
108 ((caddr_t)(h) + ntohs(((struct ospf6_lsa_header *)(h))->length))
109 #define OSPF6_LSA_IS_TYPE(t, L) \
110 ((L)->header->type == htons(OSPF6_LSTYPE_##t) ? 1 : 0)
111 #define OSPF6_LSA_IS_SAME(L1, L2) \
112 ((L1)->header->adv_router == (L2)->header->adv_router \
113 && (L1)->header->id == (L2)->header->id \
114 && (L1)->header->type == (L2)->header->type)
115 #define OSPF6_LSA_IS_MATCH(t, i, a, L) \
116 ((L)->header->adv_router == (a) && (L)->header->id == (i) \
117 && (L)->header->type == (t))
118 #define OSPF6_LSA_IS_DIFFER(L1, L2) ospf6_lsa_is_differ (L1, L2)
119 #define OSPF6_LSA_IS_MAXAGE(L) (ospf6_lsa_age_current (L) == OSPF_LSA_MAXAGE)
120 #define OSPF6_LSA_IS_CHANGED(L1, L2) ospf6_lsa_is_changed (L1, L2)
121 #define OSPF6_LSA_IS_SEQWRAP(L) ((L)->header->seqnum == htonl(OSPF_MAX_SEQUENCE_NUMBER + 1))
125 char name
[64]; /* dump string */
127 struct route_node
*rn
;
129 unsigned char lock
; /* reference counter */
130 unsigned char flag
; /* special meaning (e.g. floodback) */
132 struct timeval birth
; /* tv_sec when LS age 0 */
133 struct timeval originated
; /* used by MinLSInterval check */
134 struct timeval received
; /* used by MinLSArrival check */
135 struct timeval installed
;
137 struct thread
*expire
;
138 struct thread
*refresh
; /* For self-originated LSA */
142 struct ospf6_lsdb
*lsdb
;
144 in_addr_t external_lsa_id
;
147 struct ospf6_lsa_header
*header
;
149 /*For topo chg detection in HELPER role*/
150 bool tobe_acknowledged
;
153 #define OSPF6_LSA_HEADERONLY 0x01
154 #define OSPF6_LSA_FLOODBACK 0x02
155 #define OSPF6_LSA_DUPLICATE 0x04
156 #define OSPF6_LSA_IMPLIEDACK 0x08
157 #define OSPF6_LSA_UNAPPROVED 0x10
158 #define OSPF6_LSA_SEQWRAPPED 0x20
159 #define OSPF6_LSA_FLUSH 0x40
161 struct ospf6_lsa_handler
{
162 uint16_t lh_type
; /* host byte order */
164 const char *lh_short_name
;
165 int (*lh_show
)(struct vty
*, struct ospf6_lsa
*, json_object
*json_obj
,
167 char *(*lh_get_prefix_str
)(struct ospf6_lsa
*, char *buf
, int buflen
,
173 #define OSPF6_LSA_IS_KNOWN(t) \
174 (ospf6_get_lsa_handler(t)->lh_type != OSPF6_LSTYPE_UNKNOWN ? 1 : 0)
176 extern vector ospf6_lsa_handler_vector
;
178 /* Macro for LSA Origination */
179 /* addr is (struct prefix *) */
180 #define CONTINUE_IF_ADDRESS_LINKLOCAL(debug, addr) \
181 if (IN6_IS_ADDR_LINKLOCAL(&(addr)->u.prefix6)) { \
183 zlog_debug("Filter out Linklocal: %pFX", addr); \
187 #define CONTINUE_IF_ADDRESS_UNSPECIFIED(debug, addr) \
188 if (IN6_IS_ADDR_UNSPECIFIED(&(addr)->u.prefix6)) { \
190 zlog_debug("Filter out Unspecified: %pFX", addr); \
194 #define CONTINUE_IF_ADDRESS_LOOPBACK(debug, addr) \
195 if (IN6_IS_ADDR_LOOPBACK(&(addr)->u.prefix6)) { \
197 zlog_debug("Filter out Loopback: %pFX", addr); \
201 #define CONTINUE_IF_ADDRESS_V4COMPAT(debug, addr) \
202 if (IN6_IS_ADDR_V4COMPAT(&(addr)->u.prefix6)) { \
204 zlog_debug("Filter out V4Compat: %pFX", addr); \
208 #define CONTINUE_IF_ADDRESS_V4MAPPED(debug, addr) \
209 if (IN6_IS_ADDR_V4MAPPED(&(addr)->u.prefix6)) { \
211 zlog_debug("Filter out V4Mapped: %pFX", addr); \
215 #define CHECK_LSA_TOPO_CHG_ELIGIBLE(type) \
216 ((type == OSPF6_LSTYPE_ROUTER) \
217 || (type == OSPF6_LSTYPE_NETWORK) \
218 || (type == OSPF6_LSTYPE_INTER_PREFIX) \
219 || (type == OSPF6_LSTYPE_INTER_ROUTER) \
220 || (type == OSPF6_LSTYPE_AS_EXTERNAL) \
221 || (type == OSPF6_LSTYPE_TYPE_7) \
222 || (type == OSPF6_LSTYPE_INTRA_PREFIX))
224 /* Function Prototypes */
225 extern const char *ospf6_lstype_name(uint16_t type
);
226 extern const char *ospf6_lstype_short_name(uint16_t type
);
227 extern uint8_t ospf6_lstype_debug(uint16_t type
);
228 extern int metric_type(struct ospf6
*ospf6
, int type
, uint8_t instance
);
229 extern int metric_value(struct ospf6
*ospf6
, int type
, uint8_t instance
);
230 extern int ospf6_lsa_is_differ(struct ospf6_lsa
*lsa1
, struct ospf6_lsa
*lsa2
);
231 extern int ospf6_lsa_is_changed(struct ospf6_lsa
*lsa1
, struct ospf6_lsa
*lsa2
);
232 extern uint16_t ospf6_lsa_age_current(struct ospf6_lsa
*lsa
);
233 extern void ospf6_lsa_age_update_to_send(struct ospf6_lsa
*lsa
,
234 uint32_t transdelay
);
235 extern void ospf6_lsa_premature_aging(struct ospf6_lsa
*lsa
);
236 extern int ospf6_lsa_compare(struct ospf6_lsa
*lsa1
, struct ospf6_lsa
*lsa2
);
238 extern char *ospf6_lsa_printbuf(struct ospf6_lsa
*lsa
, char *buf
, int size
);
239 extern void ospf6_lsa_header_print_raw(struct ospf6_lsa_header
*header
);
240 extern void ospf6_lsa_header_print(struct ospf6_lsa
*lsa
);
241 extern void ospf6_lsa_show_summary_header(struct vty
*vty
);
242 extern void ospf6_lsa_show_summary(struct vty
*vty
, struct ospf6_lsa
*lsa
,
243 json_object
*json
, bool use_json
);
244 extern void ospf6_lsa_show_dump(struct vty
*vty
, struct ospf6_lsa
*lsa
,
245 json_object
*json
, bool use_json
);
246 extern void ospf6_lsa_show_internal(struct vty
*vty
, struct ospf6_lsa
*lsa
,
247 json_object
*json
, bool use_json
);
248 extern void ospf6_lsa_show(struct vty
*vty
, struct ospf6_lsa
*lsa
,
249 json_object
*json
, bool use_json
);
251 extern struct ospf6_lsa
*ospf6_lsa_alloc(size_t lsa_length
);
252 extern struct ospf6_lsa
*ospf6_lsa_create(struct ospf6_lsa_header
*header
);
253 extern struct ospf6_lsa
*
254 ospf6_lsa_create_headeronly(struct ospf6_lsa_header
*header
);
255 extern void ospf6_lsa_delete(struct ospf6_lsa
*lsa
);
256 extern struct ospf6_lsa
*ospf6_lsa_copy(struct ospf6_lsa
*lsa
);
258 extern struct ospf6_lsa
*ospf6_lsa_lock(struct ospf6_lsa
*lsa
);
259 extern struct ospf6_lsa
*ospf6_lsa_unlock(struct ospf6_lsa
*lsa
);
261 extern int ospf6_lsa_expire(struct thread
*thread
);
262 extern int ospf6_lsa_refresh(struct thread
*thread
);
264 extern unsigned short ospf6_lsa_checksum(struct ospf6_lsa_header
*lsah
);
265 extern int ospf6_lsa_checksum_valid(struct ospf6_lsa_header
*lsah
);
266 extern int ospf6_lsa_prohibited_duration(uint16_t type
, uint32_t id
,
267 uint32_t adv_router
, void *scope
);
269 extern void ospf6_install_lsa_handler(struct ospf6_lsa_handler
*handler
);
270 extern struct ospf6_lsa_handler
*ospf6_get_lsa_handler(uint16_t type
);
272 extern void ospf6_lsa_init(void);
273 extern void ospf6_lsa_terminate(void);
275 extern int config_write_ospf6_debug_lsa(struct vty
*vty
);
276 extern void install_element_ospf6_debug_lsa(void);
277 extern void ospf6_lsa_age_set(struct ospf6_lsa
*lsa
);
278 extern void ospf6_flush_self_originated_lsas_now(struct ospf6
*ospf6
);
279 extern struct ospf6
*ospf6_get_by_lsdb(struct ospf6_lsa
*lsa
);
280 struct ospf6_lsa
*ospf6_find_external_lsa(struct ospf6
*ospf6
,
282 #endif /* OSPF6_LSA_H */