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