]>
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. */
61 struct in_addr adv_router
;
70 /* LSA origination flag. */
72 #define OSPF_LSA_SELF 0x01
73 #define OSPF_LSA_SELF_CHECKED 0x02
74 #define OSPF_LSA_RECEIVED 0x04
75 #define OSPF_LSA_APPROVED 0x08
76 #define OSPF_LSA_DISCARD 0x10
77 #define OSPF_LSA_LOCAL_XLT 0x20
78 #define OSPF_LSA_PREMATURE_AGE 0x40
79 #define OSPF_LSA_IN_MAXAGE 0x80
82 struct lsa_header
*data
;
84 /* Received time stamp. */
85 struct timeval tv_recv
;
87 /* Last time it was originated */
88 struct timeval tv_orig
;
90 /* All of reference count, also lock to remove. */
93 /* Flags for the SPF calculation. */
95 #define LSA_SPF_NOT_EXPLORED -1
96 #define LSA_SPF_IN_SPFTREE -2
97 /* If stat >= 0, stat is LSA position in candidates heap. */
99 /* References to this LSA in neighbor retransmission lists*/
100 int retransmit_counter
;
102 /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
103 struct ospf_area
*area
;
106 struct ospf_lsdb
*lsdb
;
111 /* Refreshement List or Queue */
114 /* For Type-9 Opaque-LSAs */
115 struct ospf_interface
*oi
;
118 /* OSPF LSA Link Type. */
119 #define LSA_LINK_TYPE_POINTOPOINT 1
120 #define LSA_LINK_TYPE_TRANSIT 2
121 #define LSA_LINK_TYPE_STUB 3
122 #define LSA_LINK_TYPE_VIRTUALLINK 4
124 /* OSPF Router LSA Flag. */
125 #define ROUTER_LSA_BORDER 0x01 /* The router is an ABR */
126 #define ROUTER_LSA_EXTERNAL 0x02 /* The router is an ASBR */
127 #define ROUTER_LSA_VIRTUAL 0x04 /* The router has a VL in this area */
128 #define ROUTER_LSA_NT 0x10 /* The routers always translates Type-7 */
129 #define ROUTER_LSA_SHORTCUT 0x20 /* Shortcut-ABR specific flag */
131 #define IS_ROUTER_LSA_VIRTUAL(x) ((x)->flags & ROUTER_LSA_VIRTUAL)
132 #define IS_ROUTER_LSA_EXTERNAL(x) ((x)->flags & ROUTER_LSA_EXTERNAL)
133 #define IS_ROUTER_LSA_BORDER(x) ((x)->flags & ROUTER_LSA_BORDER)
134 #define IS_ROUTER_LSA_SHORTCUT(x) ((x)->flags & ROUTER_LSA_SHORTCUT)
135 #define IS_ROUTER_LSA_NT(x) ((x)->flags & ROUTER_LSA_NT)
137 /* OSPF Router-LSA Link information. */
138 struct router_lsa_link
140 struct in_addr link_id
;
141 struct in_addr link_data
;
150 /* OSPF Router-LSAs structure. */
151 #define OSPF_ROUTER_LSA_MIN_SIZE 4U /* w/0 link descriptors */
152 /* There is an edge case, when number of links in a Router-LSA may be 0 without
153 breaking the specification. A router, which has no other links to backbone
154 area besides one virtual link, will not put any VL descriptor blocks into
155 the Router-LSA generated for area 0 until a full adjacency over the VL is
156 reached (RFC2328 12.4.1.3). In this case the Router-LSA initially received
157 by the other end of the VL will have 0 link descriptor blocks, but soon will
158 be replaced with the next revision having 1 descriptor block. */
161 struct lsa_header header
;
167 struct in_addr link_id
;
168 struct in_addr link_data
;
175 /* OSPF Network-LSAs structure. */
176 #define OSPF_NETWORK_LSA_MIN_SIZE 8U /* w/1 router-ID */
179 struct lsa_header header
;
181 struct in_addr routers
[1];
184 /* OSPF Summary-LSAs structure. */
185 #define OSPF_SUMMARY_LSA_MIN_SIZE 8U /* w/1 TOS metric block */
188 struct lsa_header header
;
194 /* OSPF AS-external-LSAs structure. */
195 #define OSPF_AS_EXTERNAL_LSA_MIN_SIZE 16U /* w/1 TOS forwarding block */
196 struct as_external_lsa
198 struct lsa_header header
;
204 struct in_addr fwd_addr
;
209 #include "ospfd/ospf_opaque.h"
212 #define GET_METRIC(x) get_metric(x)
213 #define IS_EXTERNAL_METRIC(x) ((x) & 0x80)
215 #define GET_AGE(x) (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
216 #define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? \
217 OSPF_LSA_MAXAGE : get_age(x))
218 #define IS_LSA_SELF(L) (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
219 #define IS_LSA_MAXAGE(L) (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
221 #define OSPF_LSA_UPDATE_DELAY 2
223 #define OSPF_LSA_UPDATE_TIMER_ON(T,F) \
225 (T) = thread_add_timer (master, (F), 0, 2)
228 /* XXX: Eek, time functions, similar are in lib/thread.c */
229 extern struct timeval
int2tv (int);
230 extern struct timeval
msec2tv (int);
232 extern int get_age (struct ospf_lsa
*);
233 extern u_int16_t
ospf_lsa_checksum (struct lsa_header
*);
234 extern int ospf_lsa_checksum_valid (struct lsa_header
*);
235 extern int ospf_lsa_refresh_delay (struct ospf_lsa
*);
237 extern const char *dump_lsa_key (struct ospf_lsa
*);
238 extern u_int32_t
lsa_seqnum_increment (struct ospf_lsa
*);
239 extern void lsa_header_set (struct stream
*, u_char
, u_char
, struct in_addr
,
241 extern struct ospf_neighbor
*ospf_nbr_lookup_ptop (struct ospf_interface
*);
242 extern int ospf_check_nbr_status (struct ospf
*);
244 /* Prototype for LSA primitive. */
245 extern struct ospf_lsa
*ospf_lsa_new (void);
246 extern struct ospf_lsa
*ospf_lsa_dup (struct ospf_lsa
*);
247 extern void ospf_lsa_free (struct ospf_lsa
*);
248 extern struct ospf_lsa
*ospf_lsa_lock (struct ospf_lsa
*);
249 extern void ospf_lsa_unlock (struct ospf_lsa
**);
250 extern void ospf_lsa_discard (struct ospf_lsa
*);
251 extern int ospf_lsa_flush_schedule (struct ospf
*, struct ospf_lsa
*);
252 extern struct lsa_header
*ospf_lsa_data_new (size_t);
253 extern struct lsa_header
*ospf_lsa_data_dup (struct lsa_header
*);
254 extern void ospf_lsa_data_free (struct lsa_header
*);
256 /* Prototype for various LSAs */
257 extern int ospf_router_lsa_update (struct ospf
*);
258 extern int ospf_router_lsa_update_area (struct ospf_area
*);
260 extern void ospf_network_lsa_update (struct ospf_interface
*);
262 extern struct ospf_lsa
*ospf_summary_lsa_originate (struct prefix_ipv4
*, u_int32_t
,
264 extern struct ospf_lsa
*ospf_summary_asbr_lsa_originate (struct prefix_ipv4
*,
268 extern struct ospf_lsa
*ospf_lsa_install (struct ospf
*,
269 struct ospf_interface
*, struct ospf_lsa
*);
271 extern void ospf_nssa_lsa_flush (struct ospf
*ospf
, struct prefix_ipv4
*p
);
272 extern void ospf_external_lsa_flush (struct ospf
*, u_char
, struct prefix_ipv4
*,
273 ifindex_t
/* , struct in_addr nexthop */);
275 extern struct in_addr
ospf_get_ip_from_ifp (struct ospf_interface
*);
277 extern struct ospf_lsa
*ospf_external_lsa_originate (struct ospf
*, struct external_info
*);
278 extern int ospf_external_lsa_originate_timer (struct thread
*);
279 extern int ospf_default_originate_timer (struct thread
*);
280 extern struct ospf_lsa
*ospf_lsa_lookup (struct ospf_area
*, u_int32_t
,
281 struct in_addr
, struct in_addr
);
282 extern struct ospf_lsa
*ospf_lsa_lookup_by_id (struct ospf_area
*,
285 extern struct ospf_lsa
*ospf_lsa_lookup_by_header (struct ospf_area
*,
286 struct lsa_header
*);
287 extern int ospf_lsa_more_recent (struct ospf_lsa
*, struct ospf_lsa
*);
288 extern int ospf_lsa_different (struct ospf_lsa
*, struct ospf_lsa
*);
289 extern void ospf_flush_self_originated_lsas_now (struct ospf
*);
291 extern int ospf_lsa_is_self_originated (struct ospf
*, struct ospf_lsa
*);
293 extern struct ospf_lsa
*ospf_lsa_lookup_by_prefix (struct ospf_lsdb
*, u_char
,
294 struct prefix_ipv4
*,
297 extern void ospf_lsa_maxage (struct ospf
*, struct ospf_lsa
*);
298 extern u_int32_t
get_metric (u_char
*);
300 extern int ospf_lsa_maxage_walker (struct thread
*);
301 extern struct ospf_lsa
*ospf_lsa_refresh (struct ospf
*, struct ospf_lsa
*);
303 extern void ospf_external_lsa_refresh_default (struct ospf
*);
305 extern void ospf_external_lsa_refresh_type (struct ospf
*, u_char
, u_short
, int);
306 extern struct ospf_lsa
*ospf_external_lsa_refresh (struct ospf
*,
308 struct external_info
*,
310 extern struct in_addr
ospf_lsa_unique_id (struct ospf
*, struct ospf_lsdb
*, u_char
,
311 struct prefix_ipv4
*);
312 extern void ospf_schedule_lsa_flood_area (struct ospf_area
*, struct ospf_lsa
*);
313 extern void ospf_schedule_lsa_flush_area (struct ospf_area
*, struct ospf_lsa
*);
315 extern void ospf_refresher_register_lsa (struct ospf
*, struct ospf_lsa
*);
316 extern void ospf_refresher_unregister_lsa (struct ospf
*, struct ospf_lsa
*);
317 extern int ospf_lsa_refresh_walker (struct thread
*);
319 extern void ospf_lsa_maxage_delete (struct ospf
*, struct ospf_lsa
*);
321 extern void ospf_discard_from_db (struct ospf
*, struct ospf_lsdb
*, struct ospf_lsa
*);
322 extern int is_prefix_default (struct prefix_ipv4
*);
324 extern int metric_type (struct ospf
*, u_char
, u_short
);
325 extern int metric_value (struct ospf
*, u_char
, u_short
);
327 extern struct in_addr
ospf_get_nssa_ip (struct ospf_area
*);
328 extern int ospf_translated_nssa_compare (struct ospf_lsa
*, struct ospf_lsa
*);
329 extern struct ospf_lsa
*ospf_translated_nssa_refresh (struct ospf
*, struct ospf_lsa
*,
331 extern struct ospf_lsa
*ospf_translated_nssa_originate (struct ospf
*, struct ospf_lsa
*);
333 #endif /* _ZEBRA_OSPF_LSA_H */