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