]> git.proxmox.com Git - mirror_frr.git/blame - ospfd/ospf_lsa.h
build: change sense of opaque-{lsa,te} enable args to enable by default
[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
52#define OSPF_MAX_LSA_SIZE 1500U
718e3744 53
54/* AS-external-LSA refresh method. */
55#define LSA_REFRESH_IF_CHANGED 0
56#define LSA_REFRESH_FORCE 1
57
58/* OSPF LSA header. */
59struct lsa_header
60{
61 u_int16_t ls_age;
62 u_char options;
63 u_char type;
64 struct in_addr id;
65 struct in_addr adv_router;
6c835671 66 u_int32_t ls_seqnum;
718e3744 67 u_int16_t checksum;
68 u_int16_t length;
69};
70
71/* OSPF LSA. */
72struct ospf_lsa
73{
74 /* LSA origination flag. */
75 u_char flags;
76#define OSPF_LSA_SELF 0x01
77#define OSPF_LSA_SELF_CHECKED 0x02
78#define OSPF_LSA_RECEIVED 0x04
79#define OSPF_LSA_APPROVED 0x08
80#define OSPF_LSA_DISCARD 0x10
718e3744 81#define OSPF_LSA_LOCAL_XLT 0x20
7ddf1d6e 82#define OSPF_LSA_PREMATURE_AGE 0x40
3106a032 83#define OSPF_LSA_IN_MAXAGE 0x80
718e3744 84
85 /* LSA data. */
86 struct lsa_header *data;
87
88 /* Received time stamp. */
89 struct timeval tv_recv;
90
91 /* Last time it was originated */
92 struct timeval tv_orig;
93
94 /* All of reference count, also lock to remove. */
95 int lock;
96
462f20d5 97 /* Flags for the SPF calculation. */
98 int stat;
99 #define LSA_SPF_NOT_EXPLORED -1
100 #define LSA_SPF_IN_SPFTREE -2
101 /* If stat >= 0, stat is LSA position in candidates heap. */
102
718e3744 103 /* References to this LSA in neighbor retransmission lists*/
104 int retransmit_counter;
105
106 /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
107 struct ospf_area *area;
108
109 /* Parent LSDB. */
110 struct ospf_lsdb *lsdb;
111
112 /* Related Route. */
113 void *route;
114
115 /* Refreshement List or Queue */
116 int refresh_list;
718e3744 117};
118
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
124
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 */
0c9491b3 129#define ROUTER_LSA_NT 0x10 /* The routers always translates Type-7 */
718e3744 130#define ROUTER_LSA_SHORTCUT 0x20 /* Shortcut-ABR specific flag */
131
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)
0c9491b3 136#define IS_ROUTER_LSA_NT(x) ((x)->flags & ROUTER_LSA_NT)
718e3744 137
138/* OSPF Router-LSA Link information. */
139struct router_lsa_link
140{
141 struct in_addr link_id;
142 struct in_addr link_data;
143 struct
144 {
145 u_char type;
146 u_char tos_count;
147 u_int16_t metric;
148 } m[1];
149};
150
151/* OSPF Router-LSAs structure. */
152struct router_lsa
153{
154 struct lsa_header header;
155 u_char flags;
156 u_char zero;
157 u_int16_t links;
158 struct
159 {
160 struct in_addr link_id;
161 struct in_addr link_data;
162 u_char type;
163 u_char tos;
164 u_int16_t metric;
165 } link[1];
166};
167
168/* OSPF Network-LSAs structure. */
169struct network_lsa
170{
171 struct lsa_header header;
172 struct in_addr mask;
173 struct in_addr routers[1];
174};
175
176/* OSPF Summary-LSAs structure. */
177struct summary_lsa
178{
179 struct lsa_header header;
180 struct in_addr mask;
181 u_char tos;
182 u_char metric[3];
183};
184
185/* OSPF AS-external-LSAs structure. */
186struct as_external_lsa
187{
188 struct lsa_header header;
189 struct in_addr mask;
190 struct
191 {
192 u_char tos;
193 u_char metric[3];
194 struct in_addr fwd_addr;
195 u_int32_t route_tag;
196 } e[1];
197};
198
199#ifdef HAVE_OPAQUE_LSA
200#include "ospfd/ospf_opaque.h"
201#endif /* HAVE_OPAQUE_LSA */
202
203/* Macros. */
204#define GET_METRIC(x) get_metric(x)
205#define IS_EXTERNAL_METRIC(x) ((x) & 0x80)
206
207#define GET_AGE(x) (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
208#define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? \
209 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)
212
718e3744 213#define OSPF_LSA_UPDATE_DELAY 2
214
215#define OSPF_LSA_UPDATE_TIMER_ON(T,F) \
216 if (!(T)) \
217 (T) = thread_add_timer (master, (F), 0, 2)
218
718e3744 219/* Prototypes. */
4dadc291 220/* XXX: Eek, time functions, similar are in lib/thread.c */
221extern struct timeval tv_adjust (struct timeval);
222extern int tv_ceil (struct timeval);
223extern int tv_floor (struct timeval);
224extern struct timeval int2tv (int);
225extern struct timeval tv_add (struct timeval, struct timeval);
226extern struct timeval tv_sub (struct timeval, struct timeval);
227extern int tv_cmp (struct timeval, struct timeval);
228
229extern int get_age (struct ospf_lsa *);
230extern u_int16_t ospf_lsa_checksum (struct lsa_header *);
231extern int ospf_lsa_refresh_delay (struct ospf_lsa *);
232
233extern const char *dump_lsa_key (struct ospf_lsa *);
234extern u_int32_t lsa_seqnum_increment (struct ospf_lsa *);
235extern void lsa_header_set (struct stream *, u_char, u_char, struct in_addr,
68980084 236 struct in_addr);
4dadc291 237extern struct ospf_neighbor *ospf_nbr_lookup_ptop (struct ospf_interface *);
718e3744 238
239/* Prototype for LSA primitive. */
4dadc291 240extern struct ospf_lsa *ospf_lsa_new (void);
241extern struct ospf_lsa *ospf_lsa_dup (struct ospf_lsa *);
242extern void ospf_lsa_free (struct ospf_lsa *);
243extern struct ospf_lsa *ospf_lsa_lock (struct ospf_lsa *);
1fe6ed38 244extern void ospf_lsa_unlock (struct ospf_lsa **);
4dadc291 245extern void ospf_lsa_discard (struct ospf_lsa *);
718e3744 246
4dadc291 247extern struct lsa_header *ospf_lsa_data_new (size_t);
248extern struct lsa_header *ospf_lsa_data_dup (struct lsa_header *);
249extern void ospf_lsa_data_free (struct lsa_header *);
718e3744 250
251/* Prototype for various LSAs */
c363d386
PJ
252extern int ospf_router_lsa_update (struct ospf *);
253extern int ospf_router_lsa_update_area (struct ospf_area *);
718e3744 254
c363d386 255extern void ospf_network_lsa_update (struct ospf_interface *);
718e3744 256
4dadc291 257extern struct ospf_lsa *ospf_summary_lsa_originate (struct prefix_ipv4 *, u_int32_t,
718e3744 258 struct ospf_area *);
4dadc291 259extern struct ospf_lsa *ospf_summary_asbr_lsa_originate (struct prefix_ipv4 *,
718e3744 260 u_int32_t,
261 struct ospf_area *);
718e3744 262
4dadc291 263extern struct ospf_lsa *ospf_lsa_install (struct ospf *,
68980084 264 struct ospf_interface *, struct ospf_lsa *);
718e3744 265
4dadc291 266extern void ospf_nssa_lsa_flush (struct ospf *ospf, struct prefix_ipv4 *p);
267extern void ospf_external_lsa_flush (struct ospf *, u_char, struct prefix_ipv4 *,
5339cfdb 268 unsigned int /* , struct in_addr nexthop */);
718e3744 269
4dadc291 270extern struct in_addr ospf_get_ip_from_ifp (struct ospf_interface *);
718e3744 271
4dadc291 272extern struct ospf_lsa *ospf_external_lsa_originate (struct ospf *, struct external_info *);
273extern int ospf_external_lsa_originate_timer (struct thread *);
274extern struct ospf_lsa *ospf_lsa_lookup (struct ospf_area *, u_int32_t,
718e3744 275 struct in_addr, struct in_addr);
4dadc291 276extern struct ospf_lsa *ospf_lsa_lookup_by_id (struct ospf_area *,
d4a53d58 277 u_int32_t,
278 struct in_addr);
4dadc291 279extern struct ospf_lsa *ospf_lsa_lookup_by_header (struct ospf_area *,
718e3744 280 struct lsa_header *);
4dadc291 281extern int ospf_lsa_more_recent (struct ospf_lsa *, struct ospf_lsa *);
282extern int ospf_lsa_different (struct ospf_lsa *, struct ospf_lsa *);
283extern void ospf_flush_self_originated_lsas_now (struct ospf *);
718e3744 284
4dadc291 285extern int ospf_lsa_is_self_originated (struct ospf *, struct ospf_lsa *);
718e3744 286
4dadc291 287extern struct ospf_lsa *ospf_lsa_lookup_by_prefix (struct ospf_lsdb *, u_char,
68980084 288 struct prefix_ipv4 *,
289 struct in_addr);
718e3744 290
4dadc291 291extern void ospf_lsa_maxage (struct ospf *, struct ospf_lsa *);
292extern u_int32_t get_metric (u_char *);
718e3744 293
4dadc291 294extern int ospf_lsa_maxage_walker (struct thread *);
c363d386
PJ
295extern struct ospf_lsa *ospf_lsa_refresh (struct ospf *, struct ospf_lsa *);
296
4dadc291 297extern void ospf_external_lsa_refresh_default (struct ospf *);
718e3744 298
4dadc291 299extern void ospf_external_lsa_refresh_type (struct ospf *, u_char, int);
c363d386
PJ
300extern struct ospf_lsa *ospf_external_lsa_refresh (struct ospf *,
301 struct ospf_lsa *,
302 struct external_info *,
303 int);
4dadc291 304extern struct in_addr ospf_lsa_unique_id (struct ospf *, struct ospf_lsdb *, u_char,
718e3744 305 struct prefix_ipv4 *);
4dadc291 306extern void ospf_schedule_lsa_flood_area (struct ospf_area *, struct ospf_lsa *);
307extern void ospf_schedule_lsa_flush_area (struct ospf_area *, struct ospf_lsa *);
718e3744 308
4dadc291 309extern void ospf_refresher_register_lsa (struct ospf *, struct ospf_lsa *);
310extern void ospf_refresher_unregister_lsa (struct ospf *, struct ospf_lsa *);
311extern int ospf_lsa_refresh_walker (struct thread *);
718e3744 312
4dadc291 313extern void ospf_lsa_maxage_delete (struct ospf *, struct ospf_lsa *);
718e3744 314
4dadc291 315extern void ospf_discard_from_db (struct ospf *, struct ospf_lsdb *, struct ospf_lsa*);
316extern int is_prefix_default (struct prefix_ipv4 *);
718e3744 317
4dadc291 318extern int metric_type (struct ospf *, u_char);
319extern int metric_value (struct ospf *, u_char);
68980084 320
4dadc291 321extern struct in_addr ospf_get_nssa_ip (struct ospf_area *);
322extern int ospf_translated_nssa_compare (struct ospf_lsa *, struct ospf_lsa *);
323extern struct ospf_lsa *ospf_translated_nssa_refresh (struct ospf *, struct ospf_lsa *,
d4a53d58 324 struct ospf_lsa *);
4dadc291 325extern struct ospf_lsa *ospf_translated_nssa_originate (struct ospf *, struct ospf_lsa *);
f2c80652 326
718e3744 327#endif /* _ZEBRA_OSPF_LSA_H */