]>
git.proxmox.com Git - mirror_frr.git/blob - ospfd/ospf_lsa.h
2 * OSPF Link State Advertisement
3 * Copyright (C) 1999, 2000 Toshiaki Takada
5 * This file is part of GNU Zebra.
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
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.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef _ZEBRA_OSPF_LSA_H
23 #define _ZEBRA_OSPF_LSA_H
27 /* OSPF LSA Range definition. */
28 #define OSPF_MIN_LSA 1 /* begin range here */
29 #define OSPF_MAX_LSA 12
31 /* OSPF LSA Type definition. */
32 #define OSPF_UNKNOWN_LSA 0
33 #define OSPF_ROUTER_LSA 1
34 #define OSPF_NETWORK_LSA 2
35 #define OSPF_SUMMARY_LSA 3
36 #define OSPF_ASBR_SUMMARY_LSA 4
37 #define OSPF_AS_EXTERNAL_LSA 5
38 #define OSPF_GROUP_MEMBER_LSA 6 /* Not supported. */
39 #define OSPF_AS_NSSA_LSA 7
40 #define OSPF_EXTERNAL_ATTRIBUTES_LSA 8 /* Not supported. */
41 #define OSPF_OPAQUE_LINK_LSA 9
42 #define OSPF_OPAQUE_AREA_LSA 10
43 #define OSPF_OPAQUE_AS_LSA 11
45 #define OSPF_LSA_HEADER_SIZE 20U
46 #define OSPF_ROUTER_LSA_LINK_SIZE 12U
47 #define OSPF_ROUTER_LSA_TOS_SIZE 4U
48 #define OSPF_MAX_LSA_SIZE 1500U
50 /* AS-external-LSA refresh method. */
51 #define LSA_REFRESH_IF_CHANGED 0
52 #define LSA_REFRESH_FORCE 1
54 /* OSPF LSA header. */
60 struct in_addr adv_router
;
68 /* LSA origination flag. */
70 #define OSPF_LSA_SELF 0x01
71 #define OSPF_LSA_SELF_CHECKED 0x02
72 #define OSPF_LSA_RECEIVED 0x04
73 #define OSPF_LSA_APPROVED 0x08
74 #define OSPF_LSA_DISCARD 0x10
75 #define OSPF_LSA_LOCAL_XLT 0x20
76 #define OSPF_LSA_PREMATURE_AGE 0x40
77 #define OSPF_LSA_IN_MAXAGE 0x80
80 struct lsa_header
*data
;
82 /* Received time stamp. */
83 struct timeval tv_recv
;
85 /* Last time it was originated */
86 struct timeval tv_orig
;
88 /* All of reference count, also lock to remove. */
91 /* Flags for the SPF calculation. */
93 #define LSA_SPF_NOT_EXPLORED -1
94 #define LSA_SPF_IN_SPFTREE -2
95 /* If stat >= 0, stat is LSA position in candidates heap. */
97 /* References to this LSA in neighbor retransmission lists*/
98 int retransmit_counter
;
100 /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
101 struct ospf_area
*area
;
104 struct ospf_lsdb
*lsdb
;
109 /* Refreshement List or Queue */
112 /* For Type-9 Opaque-LSAs */
113 struct ospf_interface
*oi
;
119 /* OSPF LSA Link Type. */
120 #define LSA_LINK_TYPE_POINTOPOINT 1
121 #define LSA_LINK_TYPE_TRANSIT 2
122 #define LSA_LINK_TYPE_STUB 3
123 #define LSA_LINK_TYPE_VIRTUALLINK 4
125 /* OSPF Router LSA Flag. */
126 #define ROUTER_LSA_BORDER 0x01 /* The router is an ABR */
127 #define ROUTER_LSA_EXTERNAL 0x02 /* The router is an ASBR */
128 #define ROUTER_LSA_VIRTUAL 0x04 /* The router has a VL in this area */
129 #define ROUTER_LSA_NT 0x10 /* The routers always translates Type-7 */
130 #define ROUTER_LSA_SHORTCUT 0x20 /* Shortcut-ABR specific flag */
132 #define IS_ROUTER_LSA_VIRTUAL(x) ((x)->flags & ROUTER_LSA_VIRTUAL)
133 #define IS_ROUTER_LSA_EXTERNAL(x) ((x)->flags & ROUTER_LSA_EXTERNAL)
134 #define IS_ROUTER_LSA_BORDER(x) ((x)->flags & ROUTER_LSA_BORDER)
135 #define IS_ROUTER_LSA_SHORTCUT(x) ((x)->flags & ROUTER_LSA_SHORTCUT)
136 #define IS_ROUTER_LSA_NT(x) ((x)->flags & ROUTER_LSA_NT)
138 /* OSPF Router-LSA Link information. */
139 struct router_lsa_link
{
140 struct in_addr link_id
;
141 struct in_addr link_data
;
149 /* OSPF Router-LSAs structure. */
150 #define OSPF_ROUTER_LSA_MIN_SIZE 4U /* w/0 link descriptors */
151 /* There is an edge case, when number of links in a Router-LSA may be 0 without
152 breaking the specification. A router, which has no other links to backbone
153 area besides one virtual link, will not put any VL descriptor blocks into
154 the Router-LSA generated for area 0 until a full adjacency over the VL is
155 reached (RFC2328 12.4.1.3). In this case the Router-LSA initially received
156 by the other end of the VL will have 0 link descriptor blocks, but soon will
157 be replaced with the next revision having 1 descriptor block. */
159 struct lsa_header header
;
164 struct in_addr link_id
;
165 struct in_addr link_data
;
172 /* OSPF Network-LSAs structure. */
173 #define OSPF_NETWORK_LSA_MIN_SIZE 8U /* w/1 router-ID */
175 struct lsa_header header
;
177 struct in_addr routers
[1];
180 /* OSPF Summary-LSAs structure. */
181 #define OSPF_SUMMARY_LSA_MIN_SIZE 8U /* w/1 TOS metric block */
183 struct lsa_header header
;
189 /* OSPF AS-external-LSAs structure. */
190 #define OSPF_AS_EXTERNAL_LSA_MIN_SIZE 16U /* w/1 TOS forwarding block */
191 struct as_external_lsa
{
192 struct lsa_header header
;
197 struct in_addr fwd_addr
;
202 #include "ospfd/ospf_opaque.h"
205 #define GET_METRIC(x) get_metric(x)
206 #define IS_EXTERNAL_METRIC(x) ((x) & 0x80)
208 #define GET_AGE(x) (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
209 #define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? OSPF_LSA_MAXAGE : get_age(x))
210 #define IS_LSA_SELF(L) (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
211 #define IS_LSA_MAXAGE(L) (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
213 #define OSPF_LSA_UPDATE_DELAY 2
215 #define OSPF_LSA_UPDATE_TIMER_ON(T, F) \
217 (T) = thread_add_timer(master, (F), 0, 2)
220 /* XXX: Eek, time functions, similar are in lib/thread.c */
221 extern struct timeval
int2tv(int);
222 extern struct timeval
msec2tv(int);
224 extern int get_age(struct ospf_lsa
*);
225 extern u_int16_t
ospf_lsa_checksum(struct lsa_header
*);
226 extern int ospf_lsa_checksum_valid(struct lsa_header
*);
227 extern int ospf_lsa_refresh_delay(struct ospf_lsa
*);
229 extern const char *dump_lsa_key(struct ospf_lsa
*);
230 extern u_int32_t
lsa_seqnum_increment(struct ospf_lsa
*);
231 extern void lsa_header_set(struct stream
*, u_char
, u_char
, struct in_addr
,
233 extern struct ospf_neighbor
*ospf_nbr_lookup_ptop(struct ospf_interface
*);
234 extern int ospf_check_nbr_status(struct ospf
*);
236 /* Prototype for LSA primitive. */
237 extern struct ospf_lsa
*ospf_lsa_new(void);
238 extern struct ospf_lsa
*ospf_lsa_dup(struct ospf_lsa
*);
239 extern void ospf_lsa_free(struct ospf_lsa
*);
240 extern struct ospf_lsa
*ospf_lsa_lock(struct ospf_lsa
*);
241 extern void ospf_lsa_unlock(struct ospf_lsa
**);
242 extern void ospf_lsa_discard(struct ospf_lsa
*);
243 extern int ospf_lsa_flush_schedule(struct ospf
*, struct ospf_lsa
*);
244 extern struct lsa_header
*ospf_lsa_data_new(size_t);
245 extern struct lsa_header
*ospf_lsa_data_dup(struct lsa_header
*);
246 extern void ospf_lsa_data_free(struct lsa_header
*);
248 /* Prototype for various LSAs */
249 extern int ospf_router_lsa_update(struct ospf
*);
250 extern int ospf_router_lsa_update_area(struct ospf_area
*);
252 extern void ospf_network_lsa_update(struct ospf_interface
*);
254 extern struct ospf_lsa
*
255 ospf_summary_lsa_originate(struct prefix_ipv4
*, u_int32_t
, struct ospf_area
*);
256 extern struct ospf_lsa
*ospf_summary_asbr_lsa_originate(struct prefix_ipv4
*,
260 extern struct ospf_lsa
*ospf_lsa_install(struct ospf
*, struct ospf_interface
*,
263 extern void ospf_nssa_lsa_flush(struct ospf
*ospf
, struct prefix_ipv4
*p
);
264 extern void ospf_external_lsa_flush(struct ospf
*, u_char
, struct prefix_ipv4
*,
265 ifindex_t
/* , struct in_addr nexthop */);
267 extern struct in_addr
ospf_get_ip_from_ifp(struct ospf_interface
*);
269 extern struct ospf_lsa
*ospf_external_lsa_originate(struct ospf
*,
270 struct external_info
*);
271 extern int ospf_external_lsa_originate_timer(struct thread
*);
272 extern int ospf_default_originate_timer(struct thread
*);
273 extern struct ospf_lsa
*ospf_lsa_lookup(struct ospf
*ospf
, struct ospf_area
*,
274 u_int32_t
, struct in_addr
,
276 extern struct ospf_lsa
*ospf_lsa_lookup_by_id(struct ospf_area
*, u_int32_t
,
278 extern struct ospf_lsa
*ospf_lsa_lookup_by_header(struct ospf_area
*,
279 struct lsa_header
*);
280 extern int ospf_lsa_more_recent(struct ospf_lsa
*, struct ospf_lsa
*);
281 extern int ospf_lsa_different(struct ospf_lsa
*, struct ospf_lsa
*);
282 extern void ospf_flush_self_originated_lsas_now(struct ospf
*);
284 extern int ospf_lsa_is_self_originated(struct ospf
*, struct ospf_lsa
*);
286 extern struct ospf_lsa
*ospf_lsa_lookup_by_prefix(struct ospf_lsdb
*, u_char
,
287 struct prefix_ipv4
*,
290 extern void ospf_lsa_maxage(struct ospf
*, struct ospf_lsa
*);
291 extern u_int32_t
get_metric(u_char
*);
293 extern int ospf_lsa_maxage_walker(struct thread
*);
294 extern struct ospf_lsa
*ospf_lsa_refresh(struct ospf
*, struct ospf_lsa
*);
296 extern void ospf_external_lsa_refresh_default(struct ospf
*);
298 extern void ospf_external_lsa_refresh_type(struct ospf
*, u_char
, u_short
, int);
299 extern struct ospf_lsa
*ospf_external_lsa_refresh(struct ospf
*,
301 struct external_info
*, int);
302 extern struct in_addr
ospf_lsa_unique_id(struct ospf
*, struct ospf_lsdb
*,
303 u_char
, struct prefix_ipv4
*);
304 extern void ospf_schedule_lsa_flood_area(struct ospf_area
*, struct ospf_lsa
*);
305 extern void ospf_schedule_lsa_flush_area(struct ospf_area
*, struct ospf_lsa
*);
307 extern void ospf_refresher_register_lsa(struct ospf
*, struct ospf_lsa
*);
308 extern void ospf_refresher_unregister_lsa(struct ospf
*, struct ospf_lsa
*);
309 extern int ospf_lsa_refresh_walker(struct thread
*);
311 extern void ospf_lsa_maxage_delete(struct ospf
*, struct ospf_lsa
*);
313 extern void ospf_discard_from_db(struct ospf
*, struct ospf_lsdb
*,
315 extern int is_prefix_default(struct prefix_ipv4
*);
317 extern int metric_type(struct ospf
*, u_char
, u_short
);
318 extern int metric_value(struct ospf
*, u_char
, u_short
);
320 extern struct in_addr
ospf_get_nssa_ip(struct ospf_area
*);
321 extern int ospf_translated_nssa_compare(struct ospf_lsa
*, struct ospf_lsa
*);
322 extern struct ospf_lsa
*ospf_translated_nssa_refresh(struct ospf
*,
325 extern struct ospf_lsa
*ospf_translated_nssa_originate(struct ospf
*,
328 #endif /* _ZEBRA_OSPF_LSA_H */