]> git.proxmox.com Git - mirror_frr.git/blame - ospfd/ospf_lsa.h
ospfd: make ospf_maxage_lsa_remover actually yield
[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
4dadc291 26#include "stream.h"
27
718e3744 28/* OSPF LSA Range definition. */
29#define OSPF_MIN_LSA 1 /* begin range here */
30#if defined (HAVE_OPAQUE_LSA)
31#define OSPF_MAX_LSA 12
718e3744 32#else
beebba75 33#define OSPF_MAX_LSA 8
718e3744 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
779adb01 50#define OSPF_LSA_HEADER_SIZE 20U
51#define OSPF_ROUTER_LSA_LINK_SIZE 12U
05b7709d 52#define OSPF_ROUTER_LSA_TOS_SIZE 4U
779adb01 53#define OSPF_MAX_LSA_SIZE 1500U
718e3744 54
55/* AS-external-LSA refresh method. */
56#define LSA_REFRESH_IF_CHANGED 0
57#define LSA_REFRESH_FORCE 1
58
59/* OSPF LSA header. */
60struct lsa_header
61{
62 u_int16_t ls_age;
63 u_char options;
64 u_char type;
65 struct in_addr id;
66 struct in_addr adv_router;
6c835671 67 u_int32_t ls_seqnum;
718e3744 68 u_int16_t checksum;
69 u_int16_t length;
70};
71
72/* OSPF LSA. */
73struct ospf_lsa
74{
75 /* LSA origination flag. */
76 u_char flags;
77#define OSPF_LSA_SELF 0x01
78#define OSPF_LSA_SELF_CHECKED 0x02
79#define OSPF_LSA_RECEIVED 0x04
80#define OSPF_LSA_APPROVED 0x08
81#define OSPF_LSA_DISCARD 0x10
718e3744 82#define OSPF_LSA_LOCAL_XLT 0x20
7ddf1d6e 83#define OSPF_LSA_PREMATURE_AGE 0x40
3106a032 84#define OSPF_LSA_IN_MAXAGE 0x80
718e3744 85
86 /* LSA data. */
87 struct lsa_header *data;
88
89 /* Received time stamp. */
90 struct timeval tv_recv;
91
92 /* Last time it was originated */
93 struct timeval tv_orig;
94
95 /* All of reference count, also lock to remove. */
96 int lock;
97
462f20d5 98 /* Flags for the SPF calculation. */
99 int stat;
100 #define LSA_SPF_NOT_EXPLORED -1
101 #define LSA_SPF_IN_SPFTREE -2
102 /* If stat >= 0, stat is LSA position in candidates heap. */
103
718e3744 104 /* References to this LSA in neighbor retransmission lists*/
105 int retransmit_counter;
106
107 /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
108 struct ospf_area *area;
109
110 /* Parent LSDB. */
111 struct ospf_lsdb *lsdb;
112
113 /* Related Route. */
114 void *route;
115
116 /* Refreshement List or Queue */
117 int refresh_list;
d71ea652
PJ
118
119 /* For Type-9 Opaque-LSAs */
120 struct ospf_interface *oi;
718e3744 121};
122
123/* OSPF LSA Link Type. */
124#define LSA_LINK_TYPE_POINTOPOINT 1
125#define LSA_LINK_TYPE_TRANSIT 2
126#define LSA_LINK_TYPE_STUB 3
127#define LSA_LINK_TYPE_VIRTUALLINK 4
128
129/* OSPF Router LSA Flag. */
130#define ROUTER_LSA_BORDER 0x01 /* The router is an ABR */
131#define ROUTER_LSA_EXTERNAL 0x02 /* The router is an ASBR */
132#define ROUTER_LSA_VIRTUAL 0x04 /* The router has a VL in this area */
0c9491b3 133#define ROUTER_LSA_NT 0x10 /* The routers always translates Type-7 */
718e3744 134#define ROUTER_LSA_SHORTCUT 0x20 /* Shortcut-ABR specific flag */
135
136#define IS_ROUTER_LSA_VIRTUAL(x) ((x)->flags & ROUTER_LSA_VIRTUAL)
137#define IS_ROUTER_LSA_EXTERNAL(x) ((x)->flags & ROUTER_LSA_EXTERNAL)
138#define IS_ROUTER_LSA_BORDER(x) ((x)->flags & ROUTER_LSA_BORDER)
139#define IS_ROUTER_LSA_SHORTCUT(x) ((x)->flags & ROUTER_LSA_SHORTCUT)
0c9491b3 140#define IS_ROUTER_LSA_NT(x) ((x)->flags & ROUTER_LSA_NT)
718e3744 141
142/* OSPF Router-LSA Link information. */
143struct router_lsa_link
144{
145 struct in_addr link_id;
146 struct in_addr link_data;
147 struct
148 {
149 u_char type;
150 u_char tos_count;
151 u_int16_t metric;
152 } m[1];
153};
154
155/* OSPF Router-LSAs structure. */
a25a44db
DO
156#define OSPF_ROUTER_LSA_MIN_SIZE 4U /* w/0 link descriptors */
157/* There is an edge case, when number of links in a Router-LSA may be 0 without
158 breaking the specification. A router, which has no other links to backbone
159 area besides one virtual link, will not put any VL descriptor blocks into
160 the Router-LSA generated for area 0 until a full adjacency over the VL is
161 reached (RFC2328 12.4.1.3). In this case the Router-LSA initially received
162 by the other end of the VL will have 0 link descriptor blocks, but soon will
163 be replaced with the next revision having 1 descriptor block. */
718e3744 164struct router_lsa
165{
166 struct lsa_header header;
167 u_char flags;
168 u_char zero;
169 u_int16_t links;
170 struct
171 {
172 struct in_addr link_id;
173 struct in_addr link_data;
174 u_char type;
175 u_char tos;
176 u_int16_t metric;
177 } link[1];
178};
179
180/* OSPF Network-LSAs structure. */
4e31de79 181#define OSPF_NETWORK_LSA_MIN_SIZE 8U /* w/1 router-ID */
718e3744 182struct network_lsa
183{
184 struct lsa_header header;
185 struct in_addr mask;
186 struct in_addr routers[1];
187};
188
189/* OSPF Summary-LSAs structure. */
4e31de79 190#define OSPF_SUMMARY_LSA_MIN_SIZE 8U /* w/1 TOS metric block */
718e3744 191struct summary_lsa
192{
193 struct lsa_header header;
194 struct in_addr mask;
195 u_char tos;
196 u_char metric[3];
197};
198
199/* OSPF AS-external-LSAs structure. */
4e31de79 200#define OSPF_AS_EXTERNAL_LSA_MIN_SIZE 16U /* w/1 TOS forwarding block */
718e3744 201struct as_external_lsa
202{
203 struct lsa_header header;
204 struct in_addr mask;
205 struct
206 {
207 u_char tos;
208 u_char metric[3];
209 struct in_addr fwd_addr;
210 u_int32_t route_tag;
211 } e[1];
212};
213
214#ifdef HAVE_OPAQUE_LSA
215#include "ospfd/ospf_opaque.h"
216#endif /* HAVE_OPAQUE_LSA */
217
218/* Macros. */
219#define GET_METRIC(x) get_metric(x)
220#define IS_EXTERNAL_METRIC(x) ((x) & 0x80)
221
222#define GET_AGE(x) (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
223#define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? \
224 OSPF_LSA_MAXAGE : get_age(x))
225#define IS_LSA_SELF(L) (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
226#define IS_LSA_MAXAGE(L) (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
227
718e3744 228#define OSPF_LSA_UPDATE_DELAY 2
229
230#define OSPF_LSA_UPDATE_TIMER_ON(T,F) \
231 if (!(T)) \
232 (T) = thread_add_timer (master, (F), 0, 2)
233
718e3744 234/* Prototypes. */
4dadc291 235/* XXX: Eek, time functions, similar are in lib/thread.c */
236extern struct timeval tv_adjust (struct timeval);
237extern int tv_ceil (struct timeval);
238extern int tv_floor (struct timeval);
239extern struct timeval int2tv (int);
240extern struct timeval tv_add (struct timeval, struct timeval);
241extern struct timeval tv_sub (struct timeval, struct timeval);
242extern int tv_cmp (struct timeval, struct timeval);
243
244extern int get_age (struct ospf_lsa *);
245extern u_int16_t ospf_lsa_checksum (struct lsa_header *);
0798cee3 246extern int ospf_lsa_checksum_valid (struct lsa_header *);
4dadc291 247extern int ospf_lsa_refresh_delay (struct ospf_lsa *);
248
249extern const char *dump_lsa_key (struct ospf_lsa *);
250extern u_int32_t lsa_seqnum_increment (struct ospf_lsa *);
251extern void lsa_header_set (struct stream *, u_char, u_char, struct in_addr,
68980084 252 struct in_addr);
4dadc291 253extern struct ospf_neighbor *ospf_nbr_lookup_ptop (struct ospf_interface *);
718e3744 254
255/* Prototype for LSA primitive. */
4dadc291 256extern struct ospf_lsa *ospf_lsa_new (void);
257extern struct ospf_lsa *ospf_lsa_dup (struct ospf_lsa *);
258extern void ospf_lsa_free (struct ospf_lsa *);
259extern struct ospf_lsa *ospf_lsa_lock (struct ospf_lsa *);
1fe6ed38 260extern void ospf_lsa_unlock (struct ospf_lsa **);
4dadc291 261extern void ospf_lsa_discard (struct ospf_lsa *);
718e3744 262
4dadc291 263extern struct lsa_header *ospf_lsa_data_new (size_t);
264extern struct lsa_header *ospf_lsa_data_dup (struct lsa_header *);
265extern void ospf_lsa_data_free (struct lsa_header *);
718e3744 266
267/* Prototype for various LSAs */
c363d386
PJ
268extern int ospf_router_lsa_update (struct ospf *);
269extern int ospf_router_lsa_update_area (struct ospf_area *);
718e3744 270
c363d386 271extern void ospf_network_lsa_update (struct ospf_interface *);
718e3744 272
4dadc291 273extern struct ospf_lsa *ospf_summary_lsa_originate (struct prefix_ipv4 *, u_int32_t,
718e3744 274 struct ospf_area *);
4dadc291 275extern struct ospf_lsa *ospf_summary_asbr_lsa_originate (struct prefix_ipv4 *,
718e3744 276 u_int32_t,
277 struct ospf_area *);
718e3744 278
4dadc291 279extern struct ospf_lsa *ospf_lsa_install (struct ospf *,
68980084 280 struct ospf_interface *, struct ospf_lsa *);
718e3744 281
4dadc291 282extern void ospf_nssa_lsa_flush (struct ospf *ospf, struct prefix_ipv4 *p);
283extern void ospf_external_lsa_flush (struct ospf *, u_char, struct prefix_ipv4 *,
5339cfdb 284 unsigned int /* , struct in_addr nexthop */);
718e3744 285
4dadc291 286extern struct in_addr ospf_get_ip_from_ifp (struct ospf_interface *);
718e3744 287
4dadc291 288extern struct ospf_lsa *ospf_external_lsa_originate (struct ospf *, struct external_info *);
289extern int ospf_external_lsa_originate_timer (struct thread *);
8216f53b 290extern int ospf_default_originate_timer (struct thread *);
4dadc291 291extern struct ospf_lsa *ospf_lsa_lookup (struct ospf_area *, u_int32_t,
718e3744 292 struct in_addr, struct in_addr);
4dadc291 293extern struct ospf_lsa *ospf_lsa_lookup_by_id (struct ospf_area *,
d4a53d58 294 u_int32_t,
295 struct in_addr);
4dadc291 296extern struct ospf_lsa *ospf_lsa_lookup_by_header (struct ospf_area *,
718e3744 297 struct lsa_header *);
4dadc291 298extern int ospf_lsa_more_recent (struct ospf_lsa *, struct ospf_lsa *);
299extern int ospf_lsa_different (struct ospf_lsa *, struct ospf_lsa *);
300extern void ospf_flush_self_originated_lsas_now (struct ospf *);
718e3744 301
4dadc291 302extern int ospf_lsa_is_self_originated (struct ospf *, struct ospf_lsa *);
718e3744 303
4dadc291 304extern struct ospf_lsa *ospf_lsa_lookup_by_prefix (struct ospf_lsdb *, u_char,
68980084 305 struct prefix_ipv4 *,
306 struct in_addr);
718e3744 307
4dadc291 308extern void ospf_lsa_maxage (struct ospf *, struct ospf_lsa *);
309extern u_int32_t get_metric (u_char *);
718e3744 310
4dadc291 311extern int ospf_lsa_maxage_walker (struct thread *);
c363d386
PJ
312extern struct ospf_lsa *ospf_lsa_refresh (struct ospf *, struct ospf_lsa *);
313
4dadc291 314extern void ospf_external_lsa_refresh_default (struct ospf *);
718e3744 315
4dadc291 316extern void ospf_external_lsa_refresh_type (struct ospf *, u_char, int);
c363d386
PJ
317extern struct ospf_lsa *ospf_external_lsa_refresh (struct ospf *,
318 struct ospf_lsa *,
319 struct external_info *,
320 int);
4dadc291 321extern struct in_addr ospf_lsa_unique_id (struct ospf *, struct ospf_lsdb *, u_char,
718e3744 322 struct prefix_ipv4 *);
4dadc291 323extern void ospf_schedule_lsa_flood_area (struct ospf_area *, struct ospf_lsa *);
324extern void ospf_schedule_lsa_flush_area (struct ospf_area *, struct ospf_lsa *);
718e3744 325
4dadc291 326extern void ospf_refresher_register_lsa (struct ospf *, struct ospf_lsa *);
327extern void ospf_refresher_unregister_lsa (struct ospf *, struct ospf_lsa *);
328extern int ospf_lsa_refresh_walker (struct thread *);
718e3744 329
4dadc291 330extern void ospf_lsa_maxage_delete (struct ospf *, struct ospf_lsa *);
718e3744 331
4dadc291 332extern void ospf_discard_from_db (struct ospf *, struct ospf_lsdb *, struct ospf_lsa*);
333extern int is_prefix_default (struct prefix_ipv4 *);
718e3744 334
4dadc291 335extern int metric_type (struct ospf *, u_char);
336extern int metric_value (struct ospf *, u_char);
68980084 337
4dadc291 338extern struct in_addr ospf_get_nssa_ip (struct ospf_area *);
339extern int ospf_translated_nssa_compare (struct ospf_lsa *, struct ospf_lsa *);
340extern struct ospf_lsa *ospf_translated_nssa_refresh (struct ospf *, struct ospf_lsa *,
d4a53d58 341 struct ospf_lsa *);
4dadc291 342extern struct ospf_lsa *ospf_translated_nssa_originate (struct ospf *, struct ospf_lsa *);
f2c80652 343
718e3744 344#endif /* _ZEBRA_OSPF_LSA_H */