Gitiles
Code Review Sign In
gerrit.opencord.org / quagga / 3e0c78ef8a8fb80f52a36dab99d76a5913281e4c / . / ospfd / ospf_lsa.h
blob: 9e480dee5736cf379c02838c7a5d7d0b7bf6e4a3 [file] [log] [blame]
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]26#include "stream.h"
27
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]32#else
hassobeebba72004-06-20 21:00:27 +0000[diff] [blame]33#define OSPF_MAX_LSA 8
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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
paul779adb02006-01-18 15:07:38 +0000[diff] [blame]50#define OSPF_LSA_HEADER_SIZE 20U
51#define OSPF_ROUTER_LSA_LINK_SIZE 12U
52#define OSPF_MAX_LSA_SIZE 1500U
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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;
paul6c835672004-10-11 11:00:30 +0000[diff] [blame]66 u_int32_t ls_seqnum;
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]81#define OSPF_LSA_LOCAL_XLT 0x20
paul7ddf1d62003-10-13 09:06:46 +0000[diff] [blame]82#define OSPF_LSA_PREMATURE_AGE 0x40
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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
hasso462f20d2005-02-23 11:29:02 +0000[diff] [blame]96 /* Flags for the SPF calculation. */
97 int stat;
98 #define LSA_SPF_NOT_EXPLORED -1
99 #define LSA_SPF_IN_SPFTREE -2
100 /* If stat >= 0, stat is LSA position in candidates heap. */
101
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]102 /* References to this LSA in neighbor retransmission lists*/
103 int retransmit_counter;
104
105 /* Area the LSA belongs to, may be NULL if AS-external-LSA. */
106 struct ospf_area *area;
107
108 /* Parent LSDB. */
109 struct ospf_lsdb *lsdb;
110
111 /* Related Route. */
112 void *route;
113
114 /* Refreshement List or Queue */
115 int refresh_list;
116
117#ifdef HAVE_OPAQUE_LSA
118 /* For Type-9 Opaque-LSAs, reference to ospf-interface is required. */
119 struct ospf_interface *oi;
120#endif /* HAVE_OPAQUE_LSA */
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 */
paul0c9491b2003-06-22 08:23:01 +0000[diff] [blame]133#define ROUTER_LSA_NT 0x10 /* The routers always translates Type-7 */
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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)
paul0c9491b2003-06-22 08:23:01 +0000[diff] [blame]140#define IS_ROUTER_LSA_NT(x) ((x)->flags & ROUTER_LSA_NT)
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]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. */
156struct router_lsa
157{
158 struct lsa_header header;
159 u_char flags;
160 u_char zero;
161 u_int16_t links;
162 struct
163 {
164 struct in_addr link_id;
165 struct in_addr link_data;
166 u_char type;
167 u_char tos;
168 u_int16_t metric;
169 } link[1];
170};
171
172/* OSPF Network-LSAs structure. */
173struct network_lsa
174{
175 struct lsa_header header;
176 struct in_addr mask;
177 struct in_addr routers[1];
178};
179
180/* OSPF Summary-LSAs structure. */
181struct summary_lsa
182{
183 struct lsa_header header;
184 struct in_addr mask;
185 u_char tos;
186 u_char metric[3];
187};
188
189/* OSPF AS-external-LSAs structure. */
190struct as_external_lsa
191{
192 struct lsa_header header;
193 struct in_addr mask;
194 struct
195 {
196 u_char tos;
197 u_char metric[3];
198 struct in_addr fwd_addr;
199 u_int32_t route_tag;
200 } e[1];
201};
202
203#ifdef HAVE_OPAQUE_LSA
204#include "ospfd/ospf_opaque.h"
205#endif /* HAVE_OPAQUE_LSA */
206
207/* Macros. */
208#define GET_METRIC(x) get_metric(x)
209#define IS_EXTERNAL_METRIC(x) ((x) & 0x80)
210
211#define GET_AGE(x) (ntohs ((x)->data->ls_age) + time (NULL) - (x)->tv_recv)
212#define LS_AGE(x) (OSPF_LSA_MAXAGE < get_age(x) ? \
213 OSPF_LSA_MAXAGE : get_age(x))
214#define IS_LSA_SELF(L) (CHECK_FLAG ((L)->flags, OSPF_LSA_SELF))
215#define IS_LSA_MAXAGE(L) (LS_AGE ((L)) == OSPF_LSA_MAXAGE)
216
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]217#define OSPF_LSA_UPDATE_DELAY 2
218
219#define OSPF_LSA_UPDATE_TIMER_ON(T,F) \
220 if (!(T)) \
221 (T) = thread_add_timer (master, (F), 0, 2)
222
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]223/* Prototypes. */
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]224/* XXX: Eek, time functions, similar are in lib/thread.c */
225extern struct timeval tv_adjust (struct timeval);
226extern int tv_ceil (struct timeval);
227extern int tv_floor (struct timeval);
228extern struct timeval int2tv (int);
229extern struct timeval tv_add (struct timeval, struct timeval);
230extern struct timeval tv_sub (struct timeval, struct timeval);
231extern int tv_cmp (struct timeval, struct timeval);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]232
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]233extern int get_age (struct ospf_lsa *);
234extern u_int16_t ospf_lsa_checksum (struct lsa_header *);
235extern int ospf_lsa_refresh_delay (struct ospf_lsa *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]236
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]237extern const char *dump_lsa_key (struct ospf_lsa *);
238extern u_int32_t lsa_seqnum_increment (struct ospf_lsa *);
239extern void lsa_header_set (struct stream *, u_char, u_char, struct in_addr,
paul68980082003-03-25 05:07:42 +0000[diff] [blame]240 struct in_addr);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]241extern struct ospf_neighbor *ospf_nbr_lookup_ptop (struct ospf_interface *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]242
243/* Prototype for LSA primitive. */
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]244extern struct ospf_lsa *ospf_lsa_new (void);
245extern struct ospf_lsa *ospf_lsa_dup (struct ospf_lsa *);
246extern void ospf_lsa_free (struct ospf_lsa *);
247extern struct ospf_lsa *ospf_lsa_lock (struct ospf_lsa *);
248extern void ospf_lsa_unlock (struct ospf_lsa *);
249extern void ospf_lsa_discard (struct ospf_lsa *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]250
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]251extern struct lsa_header *ospf_lsa_data_new (size_t);
252extern struct lsa_header *ospf_lsa_data_dup (struct lsa_header *);
253extern void ospf_lsa_data_free (struct lsa_header *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]254
255/* Prototype for various LSAs */
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]256extern int ospf_router_lsa_update_timer (struct thread *);
257extern void ospf_router_lsa_timer_add (struct ospf_area *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]258
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]259extern int ospf_network_lsa_refresh (struct ospf_lsa *, struct ospf_interface *);
260extern void ospf_network_lsa_timer_add (struct ospf_interface *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]261
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]262extern struct ospf_lsa *ospf_summary_lsa_originate (struct prefix_ipv4 *, u_int32_t,
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]263 struct ospf_area *);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]264extern struct ospf_lsa *ospf_summary_asbr_lsa_originate (struct prefix_ipv4 *,
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]265 u_int32_t,
266 struct ospf_area *);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]267extern struct ospf_lsa *ospf_summary_lsa_refresh (struct ospf *, struct ospf_lsa *);
268extern struct ospf_lsa *ospf_summary_asbr_lsa_refresh (struct ospf *, struct ospf_lsa *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]269
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]270extern struct ospf_lsa *ospf_lsa_install (struct ospf *,
paul68980082003-03-25 05:07:42 +0000[diff] [blame]271 struct ospf_interface *, struct ospf_lsa *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]272
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]273extern void ospf_nssa_lsa_flush (struct ospf *ospf, struct prefix_ipv4 *p);
274extern void ospf_external_lsa_flush (struct ospf *, u_char, struct prefix_ipv4 *,
ajs5339cfd2005-09-19 13:28:05 +0000[diff] [blame]275 unsigned int /* , struct in_addr nexthop */);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]276
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]277extern struct in_addr ospf_get_ip_from_ifp (struct ospf_interface *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]278
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]279extern struct ospf_lsa *ospf_external_lsa_originate (struct ospf *, struct external_info *);
280extern int ospf_external_lsa_originate_timer (struct thread *);
281extern struct ospf_lsa *ospf_lsa_lookup (struct ospf_area *, u_int32_t,
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]282 struct in_addr, struct in_addr);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]283extern struct ospf_lsa *ospf_lsa_lookup_by_id (struct ospf_area *,
pauld4a53d52003-07-12 21:30:57 +0000[diff] [blame]284 u_int32_t,
285 struct in_addr);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]286extern struct ospf_lsa *ospf_lsa_lookup_by_header (struct ospf_area *,
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]287 struct lsa_header *);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]288extern int ospf_lsa_more_recent (struct ospf_lsa *, struct ospf_lsa *);
289extern int ospf_lsa_different (struct ospf_lsa *, struct ospf_lsa *);
290extern void ospf_flush_self_originated_lsas_now (struct ospf *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]291
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]292extern int ospf_lsa_is_self_originated (struct ospf *, struct ospf_lsa *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]293
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]294extern struct ospf_lsa *ospf_lsa_lookup_by_prefix (struct ospf_lsdb *, u_char,
paul68980082003-03-25 05:07:42 +0000[diff] [blame]295 struct prefix_ipv4 *,
296 struct in_addr);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]297
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]298extern void ospf_lsa_maxage (struct ospf *, struct ospf_lsa *);
299extern u_int32_t get_metric (u_char *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]300
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]301extern int ospf_lsa_maxage_walker (struct thread *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]302
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]303extern void ospf_external_lsa_refresh_default (struct ospf *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]304
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]305extern void ospf_external_lsa_refresh_type (struct ospf *, u_char, int);
306extern void ospf_external_lsa_refresh (struct ospf *, struct ospf_lsa *,
paul68980082003-03-25 05:07:42 +0000[diff] [blame]307 struct external_info *, int);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]308extern struct in_addr ospf_lsa_unique_id (struct ospf *, struct ospf_lsdb *, u_char,
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]309 struct prefix_ipv4 *);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]310extern void ospf_schedule_lsa_flood_area (struct ospf_area *, struct ospf_lsa *);
311extern void ospf_schedule_lsa_flush_area (struct ospf_area *, struct ospf_lsa *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]312
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]313extern void ospf_refresher_register_lsa (struct ospf *, struct ospf_lsa *);
314extern void ospf_refresher_unregister_lsa (struct ospf *, struct ospf_lsa *);
315extern int ospf_lsa_refresh_walker (struct thread *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]316
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]317extern void ospf_lsa_maxage_delete (struct ospf *, struct ospf_lsa *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]318
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]319extern void ospf_discard_from_db (struct ospf *, struct ospf_lsdb *, struct ospf_lsa*);
320extern int is_prefix_default (struct prefix_ipv4 *);
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]321
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]322extern int metric_type (struct ospf *, u_char);
323extern int metric_value (struct ospf *, u_char);
paul68980082003-03-25 05:07:42 +0000[diff] [blame]324
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]325extern struct in_addr ospf_get_nssa_ip (struct ospf_area *);
326extern int ospf_translated_nssa_compare (struct ospf_lsa *, struct ospf_lsa *);
327extern struct ospf_lsa *ospf_translated_nssa_refresh (struct ospf *, struct ospf_lsa *,
pauld4a53d52003-07-12 21:30:57 +0000[diff] [blame]328 struct ospf_lsa *);
paul4dadc292005-05-06 21:37:42 +0000[diff] [blame]329extern struct ospf_lsa *ospf_translated_nssa_originate (struct ospf *, struct ospf_lsa *);
paulf2c80652002-12-13 21:44:27 +0000[diff] [blame]330
paul718e3742002-12-13 20:15:29 +0000[diff] [blame]331#endif /* _ZEBRA_OSPF_LSA_H */