]> git.proxmox.com Git - mirror_frr.git/blame - ospfd/ospf_lsa.h
2003-10-13 Douglas Fraser <doug+quagga@idmf.net>
[mirror_frr.git] / ospfd / ospf_lsa.h
CommitLineData
718e3744 1/*
2 * OSPF Link State Advertisement
3 * Copyright (C) 1999, 2000 Toshiaki Takada
4 *
5 * This file is part of GNU Zebra.
6 *
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
10 * later version.
11 *
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Zebra; see the file COPYING. If not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 * 02111-1307, USA.
21 */
22
23#ifndef _ZEBRA_OSPF_LSA_H
24#define _ZEBRA_OSPF_LSA_H
25
26/* OSPF LSA Range definition. */
27#define OSPF_MIN_LSA 1 /* begin range here */
28#if defined (HAVE_OPAQUE_LSA)
29#define OSPF_MAX_LSA 12
30#elif defined (HAVE_NSSA)
31#define OSPF_MAX_LSA 8
32#else
33#define OSPF_MAX_LSA 6
34#endif
35
36/* OSPF LSA Type definition. */
37#define OSPF_UNKNOWN_LSA 0
38#define OSPF_ROUTER_LSA 1
39#define OSPF_NETWORK_LSA 2
40#define OSPF_SUMMARY_LSA 3
41#define OSPF_ASBR_SUMMARY_LSA 4
42#define OSPF_AS_EXTERNAL_LSA 5
43#define OSPF_GROUP_MEMBER_LSA 6 /* Not supported. */
44#define OSPF_AS_NSSA_LSA 7
45#define OSPF_EXTERNAL_ATTRIBUTES_LSA 8 /* Not supported. */
46#define OSPF_OPAQUE_LINK_LSA 9
47#define OSPF_OPAQUE_AREA_LSA 10
48#define OSPF_OPAQUE_AS_LSA 11
49
50#define OSPF_LSA_HEADER_SIZE 20
51#define OSPF_MAX_LSA_SIZE 1500
52
53/* AS-external-LSA refresh method. */
54#define LSA_REFRESH_IF_CHANGED 0
55#define LSA_REFRESH_FORCE 1
56
57/* OSPF LSA header. */
58struct lsa_header
59{
60 u_int16_t ls_age;
61 u_char options;
62 u_char type;
63 struct in_addr id;
64 struct in_addr adv_router;
65 int ls_seqnum;
66 u_int16_t checksum;
67 u_int16_t length;
68};
69
70/* OSPF LSA. */
71struct ospf_lsa
72{
73 /* LSA origination flag. */
74 u_char flags;
75#define OSPF_LSA_SELF 0x01
76#define OSPF_LSA_SELF_CHECKED 0x02
77#define OSPF_LSA_RECEIVED 0x04
78#define OSPF_LSA_APPROVED 0x08
79#define OSPF_LSA_DISCARD 0x10
80#ifdef HAVE_NSSA
81#define OSPF_LSA_LOCAL_XLT 0x20
82#endif /* HAVE_NSSA */
83
84 /* LSA data. */
85 struct lsa_header *data;
86
87 /* Received time stamp. */
88 struct timeval tv_recv;
89
90 /* Last time it was originated */
91 struct timeval tv_orig;
92
93 /* All of reference count, also lock to remove. */
94 int lock;
95
96 /* References to this LSA in neighbor retransmission lists*/
97 int retransmit_counter;
98
99 /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
100 struct ospf_area *area;
101
102 /* Parent LSDB. */
103 struct ospf_lsdb *lsdb;
104
105 /* Related Route. */
106 void *route;
107
108 /* Refreshement List or Queue */
109 int refresh_list;
110
111#ifdef HAVE_OPAQUE_LSA
112 /* For Type-9 Opaque-LSAs, reference to ospf-interface is required. */
113 struct ospf_interface *oi;
114#endif /* HAVE_OPAQUE_LSA */
115};
116
117/* OSPF LSA Link Type. */
118#define LSA_LINK_TYPE_POINTOPOINT 1
119#define LSA_LINK_TYPE_TRANSIT 2
120#define LSA_LINK_TYPE_STUB 3
121#define LSA_LINK_TYPE_VIRTUALLINK 4
122
123/* OSPF Router LSA Flag. */
124#define ROUTER_LSA_BORDER 0x01 /* The router is an ABR */
125#define ROUTER_LSA_EXTERNAL 0x02 /* The router is an ASBR */
126#define ROUTER_LSA_VIRTUAL 0x04 /* The router has a VL in this area */
0c9491b3 127#define ROUTER_LSA_NT 0x10 /* The routers always translates Type-7 */
718e3744 128#define ROUTER_LSA_SHORTCUT 0x20 /* Shortcut-ABR specific flag */
129
130#define IS_ROUTER_LSA_VIRTUAL(x) ((x)->flags & ROUTER_LSA_VIRTUAL)
131#define IS_ROUTER_LSA_EXTERNAL(x) ((x)->flags & ROUTER_LSA_EXTERNAL)
132#define IS_ROUTER_LSA_BORDER(x) ((x)->flags & ROUTER_LSA_BORDER)
133#define IS_ROUTER_LSA_SHORTCUT(x) ((x)->flags & ROUTER_LSA_SHORTCUT)
0c9491b3 134#define IS_ROUTER_LSA_NT(x) ((x)->flags & ROUTER_LSA_NT)
718e3744 135
136/* OSPF Router-LSA Link information. */
137struct router_lsa_link
138{
139 struct in_addr link_id;
140 struct in_addr link_data;
141 struct
142 {
143 u_char type;
144 u_char tos_count;
145 u_int16_t metric;
146 } m[1];
147};
148
149/* OSPF Router-LSAs structure. */
150struct router_lsa
151{
152 struct lsa_header header;
153 u_char flags;
154 u_char zero;
155 u_int16_t links;
156 struct
157 {
158 struct in_addr link_id;
159 struct in_addr link_data;
160 u_char type;
161 u_char tos;
162 u_int16_t metric;
163 } link[1];
164};
165
166/* OSPF Network-LSAs structure. */
167struct network_lsa
168{
169 struct lsa_header header;
170 struct in_addr mask;
171 struct in_addr routers[1];
172};
173
174/* OSPF Summary-LSAs structure. */
175struct summary_lsa
176{
177 struct lsa_header header;
178 struct in_addr mask;
179 u_char tos;
180 u_char metric[3];
181};
182
183/* OSPF AS-external-LSAs structure. */
184struct as_external_lsa
185{
186 struct lsa_header header;
187 struct in_addr mask;
188 struct
189 {
190 u_char tos;
191 u_char metric[3];
192 struct in_addr fwd_addr;
193 u_int32_t route_tag;
194 } e[1];
195};
196
197#ifdef HAVE_OPAQUE_LSA
198#include "ospfd/ospf_opaque.h"
199#endif /* HAVE_OPAQUE_LSA */
200
201/* Macros. */
202#define GET_METRIC(x) get_metric(x)
203#define IS_EXTERNAL_METRIC(x) ((x) & 0x80)
204
205#define GET_AGE(x) (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
206#define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? \
207 OSPF_LSA_MAXAGE : get_age(x))
208#define IS_LSA_SELF(L) (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
209#define IS_LSA_MAXAGE(L) (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
210
718e3744 211#define OSPF_LSA_UPDATE_DELAY 2
212
213#define OSPF_LSA_UPDATE_TIMER_ON(T,F) \
214 if (!(T)) \
215 (T) = thread_add_timer (master, (F), 0, 2)
216
217struct ospf_route;
218struct ospf_lsdb;
219
220/* Prototypes. */
221struct timeval tv_adjust (struct timeval);
222int tv_ceil (struct timeval);
223int tv_floor (struct timeval);
224struct timeval int2tv (int);
225struct timeval tv_add (struct timeval, struct timeval);
226struct timeval tv_sub (struct timeval, struct timeval);
227int tv_cmp (struct timeval, struct timeval);
228
229int get_age (struct ospf_lsa *);
230u_int16_t ospf_lsa_checksum (struct lsa_header *);
231
232struct stream;
68980084 233const char *dump_lsa_key (struct ospf_lsa *);
234u_int32_t lsa_seqnum_increment (struct ospf_lsa *);
235void lsa_header_set (struct stream *, u_char, u_char, struct in_addr,
236 struct in_addr);
237struct ospf_neighbor *ospf_nbr_lookup_ptop (struct ospf_interface *);
718e3744 238
239/* Prototype for LSA primitive. */
240struct ospf_lsa *ospf_lsa_new ();
241struct ospf_lsa *ospf_lsa_dup ();
68980084 242void ospf_lsa_free (struct ospf_lsa *);
718e3744 243struct ospf_lsa *ospf_lsa_lock (struct ospf_lsa *);
244void ospf_lsa_unlock (struct ospf_lsa *);
245void ospf_lsa_discard (struct ospf_lsa *);
246
247struct lsa_header *ospf_lsa_data_new (size_t);
248struct lsa_header *ospf_lsa_data_dup (struct lsa_header *);
249void ospf_lsa_data_free (struct lsa_header *);
250
251/* Prototype for various LSAs */
252struct ospf_lsa *ospf_router_lsa_originate (struct ospf_area *);
253int ospf_router_lsa_update_timer (struct thread *);
254void ospf_router_lsa_timer_add (struct ospf_area *);
255
256int ospf_network_lsa_refresh (struct ospf_lsa *, struct ospf_interface *);
257void ospf_network_lsa_timer_add (struct ospf_interface *);
258
259struct ospf_lsa *ospf_summary_lsa_originate (struct prefix_ipv4 *, u_int32_t,
260 struct ospf_area *);
261struct ospf_lsa *ospf_summary_asbr_lsa_originate (struct prefix_ipv4 *,
262 u_int32_t,
263 struct ospf_area *);
68980084 264struct ospf_lsa *ospf_summary_lsa_refresh (struct ospf *, struct ospf_lsa *);
265struct ospf_lsa *ospf_summary_asbr_lsa_refresh (struct ospf *, struct ospf_lsa *);
718e3744 266
68980084 267struct ospf_lsa *ospf_lsa_install (struct ospf *,
268 struct ospf_interface *, struct ospf_lsa *);
718e3744 269
645878f1 270void ospf_nssa_lsa_flush (struct ospf *ospf, struct prefix_ipv4 *p);
68980084 271void ospf_external_lsa_flush (struct ospf *, u_char, struct prefix_ipv4 *,
718e3744 272 unsigned int, struct in_addr);
273
68980084 274struct in_addr ospf_get_ip_from_ifp (struct ospf_interface *);
718e3744 275
68980084 276struct ospf_lsa *ospf_external_lsa_originate (struct ospf *, struct external_info *);
718e3744 277int ospf_external_lsa_originate_timer (struct thread *);
278struct ospf_lsa *ospf_lsa_lookup (struct ospf_area *, u_int32_t,
279 struct in_addr, struct in_addr);
d4a53d58 280struct ospf_lsa *ospf_lsa_lookup_by_id (struct ospf_area *,
281 u_int32_t,
282 struct in_addr);
718e3744 283struct ospf_lsa *ospf_lsa_lookup_by_header (struct ospf_area *,
284 struct lsa_header *);
285int ospf_lsa_more_recent (struct ospf_lsa *, struct ospf_lsa *);
286int ospf_lsa_different (struct ospf_lsa *, struct ospf_lsa *);
68980084 287void ospf_flush_self_originated_lsas_now (struct ospf *);
718e3744 288
68980084 289int ospf_lsa_is_self_originated (struct ospf *, struct ospf_lsa *);
718e3744 290
68980084 291struct ospf_lsa *ospf_lsa_lookup_by_prefix (struct ospf_lsdb *, u_char,
292 struct prefix_ipv4 *,
293 struct in_addr);
718e3744 294
68980084 295void ospf_lsa_maxage (struct ospf *, struct ospf_lsa *);
718e3744 296u_int32_t get_metric (u_char *);
297
298int ospf_lsa_maxage_walker (struct thread *);
299
68980084 300void ospf_external_lsa_refresh_default (struct ospf *);
718e3744 301
68980084 302void ospf_external_lsa_refresh_type (struct ospf *, u_char, int);
303void ospf_external_lsa_refresh (struct ospf *, struct ospf_lsa *,
304 struct external_info *, int);
305struct in_addr ospf_lsa_unique_id (struct ospf *, struct ospf_lsdb *, u_char,
718e3744 306 struct prefix_ipv4 *);
307void ospf_schedule_lsa_flood_area (struct ospf_area *, struct ospf_lsa *);
308void ospf_schedule_lsa_flush_area (struct ospf_area *, struct ospf_lsa *);
309
310void ospf_refresher_register_lsa (struct ospf *, struct ospf_lsa *);
311void ospf_refresher_unregister_lsa (struct ospf *, struct ospf_lsa *);
312int ospf_lsa_refresh_walker (struct thread *);
313
68980084 314void ospf_lsa_maxage_delete (struct ospf *, struct ospf_lsa *);
718e3744 315
68980084 316void ospf_discard_from_db (struct ospf *, struct ospf_lsdb *, struct ospf_lsa*);
718e3744 317int is_prefix_default (struct prefix_ipv4 *);
318
68980084 319int metric_type (struct ospf *, u_char);
320int metric_value (struct ospf *, u_char);
321
322#ifdef HAVE_NSSA
323struct in_addr ospf_get_nssa_ip (struct ospf_area *);
d4a53d58 324int ospf_translated_nssa_compare (struct ospf_lsa *, struct ospf_lsa *);
325struct ospf_lsa *ospf_translated_nssa_refresh (struct ospf *, struct ospf_lsa *,
326 struct ospf_lsa *);
327struct ospf_lsa *ospf_translated_nssa_originate (struct ospf *, struct ospf_lsa *);
f2c80652 328#endif
329
718e3744 330#endif /* _ZEBRA_OSPF_LSA_H */