]> git.proxmox.com Git - mirror_frr.git/blame - ospf6d/ospf6_lsa.h
Merge pull request #531 from qlyoung/fix-stack-ref
[mirror_frr.git] / ospf6d / ospf6_lsa.h
CommitLineData
718e3744 1/*
508e53e2 2 * Copyright (C) 2003 Yasuhiro Ohara
718e3744 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
17 * along with GNU Zebra; see the file COPYING. If not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
20 */
21
22#ifndef OSPF6_LSA_H
23#define OSPF6_LSA_H
24
508e53e2 25/* Debug option */
1e05838a 26#define OSPF6_LSA_DEBUG 0x01
27#define OSPF6_LSA_DEBUG_ORIGINATE 0x02
28#define OSPF6_LSA_DEBUG_EXAMIN 0x04
29#define OSPF6_LSA_DEBUG_FLOOD 0x08
30
31#define IS_OSPF6_DEBUG_LSA(name) \
32 (ospf6_lstype_debug (htons (OSPF6_LSTYPE_ ## name)) & \
33 OSPF6_LSA_DEBUG)
34#define IS_OSPF6_DEBUG_ORIGINATE(name) \
35 (ospf6_lstype_debug (htons (OSPF6_LSTYPE_ ## name)) & \
36 OSPF6_LSA_DEBUG_ORIGINATE)
37#define IS_OSPF6_DEBUG_EXAMIN(name) \
38 (ospf6_lstype_debug (htons (OSPF6_LSTYPE_ ## name)) & \
39 OSPF6_LSA_DEBUG_EXAMIN)
40#define IS_OSPF6_DEBUG_LSA_TYPE(type) \
41 (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG)
42#define IS_OSPF6_DEBUG_ORIGINATE_TYPE(type) \
43 (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG_ORIGINATE)
44#define IS_OSPF6_DEBUG_EXAMIN_TYPE(type) \
45 (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG_EXAMIN)
46#define IS_OSPF6_DEBUG_FLOOD_TYPE(type) \
47 (ospf6_lstype_debug (type) & OSPF6_LSA_DEBUG_FLOOD)
718e3744 48
49/* LSA definition */
50
508e53e2 51#define OSPF6_MAX_LSASIZE 4096
718e3744 52
53/* Type */
508e53e2 54#define OSPF6_LSTYPE_UNKNOWN 0x0000
55#define OSPF6_LSTYPE_ROUTER 0x2001
56#define OSPF6_LSTYPE_NETWORK 0x2002
57#define OSPF6_LSTYPE_INTER_PREFIX 0x2003
58#define OSPF6_LSTYPE_INTER_ROUTER 0x2004
59#define OSPF6_LSTYPE_AS_EXTERNAL 0x4005
60#define OSPF6_LSTYPE_GROUP_MEMBERSHIP 0x2006
61#define OSPF6_LSTYPE_TYPE_7 0x2007
62#define OSPF6_LSTYPE_LINK 0x0008
63#define OSPF6_LSTYPE_INTRA_PREFIX 0x2009
64#define OSPF6_LSTYPE_SIZE 0x000a
718e3744 65
66/* Masks for LS Type : RFC 2740 A.4.2.1 "LS type" */
67#define OSPF6_LSTYPE_UBIT_MASK 0x8000
68#define OSPF6_LSTYPE_SCOPE_MASK 0x6000
508e53e2 69#define OSPF6_LSTYPE_FCODE_MASK 0x1fff
718e3744 70
508e53e2 71/* LSA scope */
6452df09 72#define OSPF6_SCOPE_LINKLOCAL 0x0000
73#define OSPF6_SCOPE_AREA 0x2000
74#define OSPF6_SCOPE_AS 0x4000
75#define OSPF6_SCOPE_RESERVED 0x6000
718e3744 76
6452df09 77/* XXX U-bit handling should be treated here */
508e53e2 78#define OSPF6_LSA_SCOPE(type) \
79 (ntohs (type) & OSPF6_LSTYPE_SCOPE_MASK)
718e3744 80
81/* LSA Header */
abc7ef44 82#define OSPF6_LSA_HEADER_SIZE 20U
718e3744 83struct ospf6_lsa_header
718e3744 84{
85 u_int16_t age; /* LS age */
86 u_int16_t type; /* LS type */
87 u_int32_t id; /* Link State ID */
88 u_int32_t adv_router; /* Advertising Router */
89 u_int32_t seqnum; /* LS sequence number */
90 u_int16_t checksum; /* LS checksum */
91 u_int16_t length; /* LSA length */
92};
93
508e53e2 94#define OSPF6_LSA_HEADER_END(h) \
95 ((caddr_t)(h) + sizeof (struct ospf6_lsa_header))
96#define OSPF6_LSA_SIZE(h) \
97 (ntohs (((struct ospf6_lsa_header *) (h))->length))
98#define OSPF6_LSA_END(h) \
99 ((caddr_t)(h) + ntohs (((struct ospf6_lsa_header *) (h))->length))
100#define OSPF6_LSA_IS_TYPE(t, L) \
101 ((L)->header->type == htons (OSPF6_LSTYPE_ ## t) ? 1 : 0)
102#define OSPF6_LSA_IS_SAME(L1, L2) \
103 ((L1)->header->adv_router == (L2)->header->adv_router && \
104 (L1)->header->id == (L2)->header->id && \
105 (L1)->header->type == (L2)->header->type)
106#define OSPF6_LSA_IS_MATCH(t, i, a, L) \
107 ((L)->header->adv_router == (a) && (L)->header->id == (i) && \
108 (L)->header->type == (t))
109#define OSPF6_LSA_IS_DIFFER(L1, L2) ospf6_lsa_is_differ (L1, L2)
8551e6da 110#define OSPF6_LSA_IS_MAXAGE(L) (ospf6_lsa_age_current (L) == OSPF_LSA_MAXAGE)
508e53e2 111#define OSPF6_LSA_IS_CHANGED(L1, L2) ospf6_lsa_is_changed (L1, L2)
3b220289
DD
112#define OSPF6_LSA_IS_SEQWRAP(L) ((L)->header->seqnum == htonl(OSPF_MAX_SEQUENCE_NUMBER + 1))
113
718e3744 114
115struct ospf6_lsa
116{
6452df09 117 char name[64]; /* dump string */
718e3744 118
a765eb93 119 struct route_node *rn;
718e3744 120
6452df09 121 unsigned char lock; /* reference counter */
122 unsigned char flag; /* special meaning (e.g. floodback) */
718e3744 123
6452df09 124 struct timeval birth; /* tv_sec when LS age 0 */
6452df09 125 struct timeval originated; /* used by MinLSInterval check */
ccb59b11 126 struct timeval received; /* used by MinLSArrival check */
127 struct timeval installed;
718e3744 128
6452df09 129 struct thread *expire;
130 struct thread *refresh; /* For self-originated LSA */
718e3744 131
6452df09 132 int retrans_count;
133
6452df09 134 struct ospf6_lsdb *lsdb;
718e3744 135
508e53e2 136 /* lsa instance */
137 struct ospf6_lsa_header *header;
718e3744 138};
139
6452df09 140#define OSPF6_LSA_HEADERONLY 0x01
141#define OSPF6_LSA_FLOODBACK 0x02
142#define OSPF6_LSA_DUPLICATE 0x04
143#define OSPF6_LSA_IMPLIEDACK 0x08
ca1f4309 144#define OSPF6_LSA_UNAPPROVED 0x10
3b220289 145#define OSPF6_LSA_SEQWRAPPED 0x20
508e53e2 146
6452df09 147struct ospf6_lsa_handler
508e53e2 148{
1e05838a 149 u_int16_t type; /* host byte order */
0c083ee9 150 const char *name;
e68a6767 151 const char *short_name;
508e53e2 152 int (*show) (struct vty *, struct ospf6_lsa *);
e68a6767 153 char *(*get_prefix_str) (struct ospf6_lsa *, char *buf, int buflen, int pos);
1e05838a 154 u_char debug;
508e53e2 155};
156
2680aa2b 157extern struct ospf6_lsa_handler unknown_handler;
158#define OSPF6_LSA_IS_KNOWN(type) \
159 (ospf6_get_lsa_handler (type) != &unknown_handler ? 1 : 0)
160
4dfd8aff
DW
161extern vector ospf6_lsa_handler_vector;
162
508e53e2 163/* Macro for LSA Origination */
1e05838a 164/* addr is (struct prefix *) */
165#define CONTINUE_IF_ADDRESS_LINKLOCAL(debug,addr) \
508e53e2 166 if (IN6_IS_ADDR_LINKLOCAL (&(addr)->u.prefix6)) \
167 { \
4690c7d7 168 char buf[PREFIX2STR_BUFFER]; \
508e53e2 169 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 170 if (debug) \
d1db06fa 171 zlog_debug ("Filter out Linklocal: %s", buf); \
508e53e2 172 continue; \
718e3744 173 }
174
1e05838a 175#define CONTINUE_IF_ADDRESS_UNSPECIFIED(debug,addr) \
508e53e2 176 if (IN6_IS_ADDR_UNSPECIFIED (&(addr)->u.prefix6)) \
177 { \
4690c7d7 178 char buf[PREFIX2STR_BUFFER]; \
508e53e2 179 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 180 if (debug) \
d1db06fa 181 zlog_debug ("Filter out Unspecified: %s", buf);\
508e53e2 182 continue; \
718e3744 183 }
508e53e2 184
1e05838a 185#define CONTINUE_IF_ADDRESS_LOOPBACK(debug,addr) \
508e53e2 186 if (IN6_IS_ADDR_LOOPBACK (&(addr)->u.prefix6)) \
187 { \
4690c7d7 188 char buf[PREFIX2STR_BUFFER]; \
508e53e2 189 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 190 if (debug) \
d1db06fa 191 zlog_debug ("Filter out Loopback: %s", buf); \
508e53e2 192 continue; \
718e3744 193 }
508e53e2 194
1e05838a 195#define CONTINUE_IF_ADDRESS_V4COMPAT(debug,addr) \
508e53e2 196 if (IN6_IS_ADDR_V4COMPAT (&(addr)->u.prefix6)) \
197 { \
4690c7d7 198 char buf[PREFIX2STR_BUFFER]; \
508e53e2 199 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 200 if (debug) \
d1db06fa 201 zlog_debug ("Filter out V4Compat: %s", buf); \
508e53e2 202 continue; \
718e3744 203 }
204
1e05838a 205#define CONTINUE_IF_ADDRESS_V4MAPPED(debug,addr) \
508e53e2 206 if (IN6_IS_ADDR_V4MAPPED (&(addr)->u.prefix6)) \
207 { \
4690c7d7 208 char buf[PREFIX2STR_BUFFER]; \
508e53e2 209 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 210 if (debug) \
d1db06fa 211 zlog_debug ("Filter out V4Mapped: %s", buf); \
508e53e2 212 continue; \
213 }
718e3744 214
6b0655a2 215
718e3744 216/* Function Prototypes */
6ac29a51 217extern const char *ospf6_lstype_name (u_int16_t type);
e68a6767 218extern const char *ospf6_lstype_short_name (u_int16_t type);
6ac29a51
PJ
219extern u_char ospf6_lstype_debug (u_int16_t type);
220extern int ospf6_lsa_is_differ (struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
221extern int ospf6_lsa_is_changed (struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
222extern u_int16_t ospf6_lsa_age_current (struct ospf6_lsa *);
223extern void ospf6_lsa_age_update_to_send (struct ospf6_lsa *, u_int32_t);
224extern void ospf6_lsa_premature_aging (struct ospf6_lsa *);
225extern int ospf6_lsa_compare (struct ospf6_lsa *, struct ospf6_lsa *);
226
227extern char *ospf6_lsa_printbuf (struct ospf6_lsa *lsa, char *buf, int size);
228extern void ospf6_lsa_header_print_raw (struct ospf6_lsa_header *header);
229extern void ospf6_lsa_header_print (struct ospf6_lsa *lsa);
230extern void ospf6_lsa_show_summary_header (struct vty *vty);
231extern void ospf6_lsa_show_summary (struct vty *vty, struct ospf6_lsa *lsa);
232extern void ospf6_lsa_show_dump (struct vty *vty, struct ospf6_lsa *lsa);
233extern void ospf6_lsa_show_internal (struct vty *vty, struct ospf6_lsa *lsa);
234extern void ospf6_lsa_show (struct vty *vty, struct ospf6_lsa *lsa);
235
236extern struct ospf6_lsa *ospf6_lsa_create (struct ospf6_lsa_header *header);
237extern struct ospf6_lsa *ospf6_lsa_create_headeronly (struct ospf6_lsa_header *header);
238extern void ospf6_lsa_delete (struct ospf6_lsa *lsa);
239extern struct ospf6_lsa *ospf6_lsa_copy (struct ospf6_lsa *);
240
241extern void ospf6_lsa_lock (struct ospf6_lsa *);
242extern void ospf6_lsa_unlock (struct ospf6_lsa *);
243
244extern int ospf6_lsa_expire (struct thread *);
245extern int ospf6_lsa_refresh (struct thread *);
246
247extern unsigned short ospf6_lsa_checksum (struct ospf6_lsa_header *);
d8a4e42b 248extern int ospf6_lsa_checksum_valid (struct ospf6_lsa_header *);
6ac29a51
PJ
249extern int ospf6_lsa_prohibited_duration (u_int16_t type, u_int32_t id,
250 u_int32_t adv_router, void *scope);
251
252extern void ospf6_install_lsa_handler (struct ospf6_lsa_handler *handler);
253extern struct ospf6_lsa_handler *ospf6_get_lsa_handler (u_int16_t type);
254
255extern void ospf6_lsa_init (void);
ae2254aa 256extern void ospf6_lsa_terminate (void);
6ac29a51
PJ
257
258extern int config_write_ospf6_debug_lsa (struct vty *vty);
259extern void install_element_ospf6_debug_lsa (void);
718e3744 260
261#endif /* OSPF6_LSA_H */
262