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