]> git.proxmox.com Git - mirror_frr.git/blame - ospf6d/ospf6_lsa.h
2004-10-10 Paul Jakma <paul@dishone.st>
[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 */
718e3744 82struct ospf6_lsa_header
718e3744 83{
84 u_int16_t age; /* LS age */
85 u_int16_t type; /* LS type */
86 u_int32_t id; /* Link State ID */
87 u_int32_t adv_router; /* Advertising Router */
88 u_int32_t seqnum; /* LS sequence number */
89 u_int16_t checksum; /* LS checksum */
90 u_int16_t length; /* LSA length */
91};
92
508e53e2 93#define OSPF6_LSA_HEADER_END(h) \
94 ((caddr_t)(h) + sizeof (struct ospf6_lsa_header))
95#define OSPF6_LSA_SIZE(h) \
96 (ntohs (((struct ospf6_lsa_header *) (h))->length))
97#define OSPF6_LSA_END(h) \
98 ((caddr_t)(h) + ntohs (((struct ospf6_lsa_header *) (h))->length))
99#define OSPF6_LSA_IS_TYPE(t, L) \
100 ((L)->header->type == htons (OSPF6_LSTYPE_ ## t) ? 1 : 0)
101#define OSPF6_LSA_IS_SAME(L1, L2) \
102 ((L1)->header->adv_router == (L2)->header->adv_router && \
103 (L1)->header->id == (L2)->header->id && \
104 (L1)->header->type == (L2)->header->type)
105#define OSPF6_LSA_IS_MATCH(t, i, a, L) \
106 ((L)->header->adv_router == (a) && (L)->header->id == (i) && \
107 (L)->header->type == (t))
108#define OSPF6_LSA_IS_DIFFER(L1, L2) ospf6_lsa_is_differ (L1, L2)
109#define OSPF6_LSA_IS_MAXAGE(L) (ospf6_lsa_age_current (L) == MAXAGE)
110#define OSPF6_LSA_IS_CHANGED(L1, L2) ospf6_lsa_is_changed (L1, L2)
718e3744 111
112struct ospf6_lsa
113{
6452df09 114 char name[64]; /* dump string */
718e3744 115
6452df09 116 struct ospf6_lsa *prev;
117 struct ospf6_lsa *next;
718e3744 118
6452df09 119 unsigned char lock; /* reference counter */
120 unsigned char flag; /* special meaning (e.g. floodback) */
718e3744 121
6452df09 122 struct timeval birth; /* tv_sec when LS age 0 */
6452df09 123 struct timeval originated; /* used by MinLSInterval check */
ccb59b11 124 struct timeval received; /* used by MinLSArrival check */
125 struct timeval installed;
718e3744 126
6452df09 127 struct thread *expire;
128 struct thread *refresh; /* For self-originated LSA */
718e3744 129
6452df09 130 int retrans_count;
131
6452df09 132 struct ospf6_lsdb *lsdb;
718e3744 133
508e53e2 134 /* lsa instance */
135 struct ospf6_lsa_header *header;
718e3744 136};
137
6452df09 138#define OSPF6_LSA_HEADERONLY 0x01
139#define OSPF6_LSA_FLOODBACK 0x02
140#define OSPF6_LSA_DUPLICATE 0x04
141#define OSPF6_LSA_IMPLIEDACK 0x08
508e53e2 142
6452df09 143struct ospf6_lsa_handler
508e53e2 144{
1e05838a 145 u_int16_t type; /* host byte order */
0c083ee9 146 const char *name;
508e53e2 147 int (*show) (struct vty *, struct ospf6_lsa *);
1e05838a 148 u_char debug;
508e53e2 149};
150
508e53e2 151/* Macro for LSA Origination */
1e05838a 152/* addr is (struct prefix *) */
153#define CONTINUE_IF_ADDRESS_LINKLOCAL(debug,addr) \
508e53e2 154 if (IN6_IS_ADDR_LINKLOCAL (&(addr)->u.prefix6)) \
155 { \
156 char buf[64]; \
157 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 158 if (debug) \
508e53e2 159 zlog_info ("Filter out Linklocal: %s", buf); \
160 continue; \
718e3744 161 }
162
1e05838a 163#define CONTINUE_IF_ADDRESS_UNSPECIFIED(debug,addr) \
508e53e2 164 if (IN6_IS_ADDR_UNSPECIFIED (&(addr)->u.prefix6)) \
165 { \
166 char buf[64]; \
167 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 168 if (debug) \
508e53e2 169 zlog_info ("Filter out Unspecified: %s", buf); \
170 continue; \
718e3744 171 }
508e53e2 172
1e05838a 173#define CONTINUE_IF_ADDRESS_LOOPBACK(debug,addr) \
508e53e2 174 if (IN6_IS_ADDR_LOOPBACK (&(addr)->u.prefix6)) \
175 { \
176 char buf[64]; \
177 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 178 if (debug) \
508e53e2 179 zlog_info ("Filter out Loopback: %s", buf); \
180 continue; \
718e3744 181 }
508e53e2 182
1e05838a 183#define CONTINUE_IF_ADDRESS_V4COMPAT(debug,addr) \
508e53e2 184 if (IN6_IS_ADDR_V4COMPAT (&(addr)->u.prefix6)) \
185 { \
186 char buf[64]; \
187 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 188 if (debug) \
508e53e2 189 zlog_info ("Filter out V4Compat: %s", buf); \
190 continue; \
718e3744 191 }
192
1e05838a 193#define CONTINUE_IF_ADDRESS_V4MAPPED(debug,addr) \
508e53e2 194 if (IN6_IS_ADDR_V4MAPPED (&(addr)->u.prefix6)) \
195 { \
196 char buf[64]; \
197 prefix2str (addr, buf, sizeof (buf)); \
1e05838a 198 if (debug) \
508e53e2 199 zlog_info ("Filter out V4Mapped: %s", buf); \
200 continue; \
201 }
718e3744 202
508e53e2 203\f
718e3744 204/* Function Prototypes */
0c083ee9 205const char *ospf6_lstype_name (u_int16_t type);
1e05838a 206u_char ospf6_lstype_debug (u_int16_t type);
508e53e2 207int ospf6_lsa_is_differ (struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
208int ospf6_lsa_is_changed (struct ospf6_lsa *lsa1, struct ospf6_lsa *lsa2);
209u_int16_t ospf6_lsa_age_current (struct ospf6_lsa *);
210void ospf6_lsa_age_update_to_send (struct ospf6_lsa *, u_int32_t);
211void ospf6_lsa_premature_aging (struct ospf6_lsa *);
212int ospf6_lsa_compare (struct ospf6_lsa *, struct ospf6_lsa *);
718e3744 213
508e53e2 214char *ospf6_lsa_printbuf (struct ospf6_lsa *lsa, char *buf, int size);
215void ospf6_lsa_header_print_raw (struct ospf6_lsa_header *header);
216void ospf6_lsa_header_print (struct ospf6_lsa *lsa);
508e53e2 217void ospf6_lsa_show_summary_header (struct vty *vty);
218void ospf6_lsa_show_summary (struct vty *vty, struct ospf6_lsa *lsa);
219void ospf6_lsa_show_dump (struct vty *vty, struct ospf6_lsa *lsa);
220void ospf6_lsa_show_internal (struct vty *vty, struct ospf6_lsa *lsa);
6452df09 221void ospf6_lsa_show (struct vty *vty, struct ospf6_lsa *lsa);
718e3744 222
508e53e2 223struct ospf6_lsa *ospf6_lsa_create (struct ospf6_lsa_header *header);
224struct ospf6_lsa *ospf6_lsa_create_headeronly (struct ospf6_lsa_header *header);
225void ospf6_lsa_delete (struct ospf6_lsa *lsa);
226struct ospf6_lsa *ospf6_lsa_copy (struct ospf6_lsa *);
718e3744 227
228void ospf6_lsa_lock (struct ospf6_lsa *);
229void ospf6_lsa_unlock (struct ospf6_lsa *);
230
718e3744 231int ospf6_lsa_expire (struct thread *);
232int ospf6_lsa_refresh (struct thread *);
233
508e53e2 234unsigned short ospf6_lsa_checksum (struct ospf6_lsa_header *);
235int ospf6_lsa_prohibited_duration (u_int16_t type, u_int32_t id,
236 u_int32_t adv_router, void *scope);
718e3744 237
6452df09 238void ospf6_install_lsa_handler (struct ospf6_lsa_handler *handler);
508e53e2 239void ospf6_lsa_init ();
1e05838a 240void ospf6_lsa_cmd_init ();
718e3744 241
508e53e2 242int config_write_ospf6_debug_lsa (struct vty *vty);
243void install_element_ospf6_debug_lsa ();
718e3744 244
245#endif /* OSPF6_LSA_H */
246