]>
git.proxmox.com Git - mirror_frr.git/blob - ospfd/ospf_interface.h
2 * OSPF Interface functions.
3 * Copyright (C) 1999 Toshiaki Takada
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published
9 * by the Free Software Foundation; either version 2, or (at your
10 * option) any later version.
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_INTERFACE_H
23 #define _ZEBRA_OSPF_INTERFACE_H
27 #include "ospfd/ospf_packet.h"
28 #include "ospfd/ospf_spf.h"
30 #define IF_OSPF_IF_INFO(I) ((struct ospf_if_info *)((I)->info))
31 #define IF_DEF_PARAMS(I) (IF_OSPF_IF_INFO (I)->def_params)
32 #define IF_OIFS(I) (IF_OSPF_IF_INFO (I)->oifs)
33 #define IF_OIFS_PARAMS(I) (IF_OSPF_IF_INFO (I)->params)
35 /* Despite the name, this macro probably is for specialist use only */
36 #define OSPF_IF_PARAM_CONFIGURED(S, P) ((S) && (S)->P##__config)
38 /* Test whether an OSPF interface parameter is set, generally, given some
39 * existing ospf interface
41 #define OSPF_IF_PARAM_IS_SET(O, P) \
42 (OSPF_IF_PARAM_CONFIGURED((O)->params, P) \
43 || OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS((O)->ifp)->P))
45 #define OSPF_IF_PARAM(O, P) \
46 (OSPF_IF_PARAM_CONFIGURED((O)->params, P) \
48 : IF_DEF_PARAMS((O)->ifp)->P)
50 #define DECLARE_IF_PARAM(T, P) \
52 uint8_t P##__config : 1
53 #define UNSET_IF_PARAM(S, P) ((S)->P##__config) = 0
54 #define SET_IF_PARAM(S, P) ((S)->P##__config) = 1
56 struct ospf_if_params
{
57 DECLARE_IF_PARAM(uint32_t,
58 transmit_delay
); /* Interface Transmisson Delay */
59 DECLARE_IF_PARAM(uint32_t,
60 output_cost_cmd
); /* Command Interface Output Cost */
61 DECLARE_IF_PARAM(uint32_t,
62 retransmit_interval
); /* Retransmission Interval */
63 DECLARE_IF_PARAM(uint8_t, passive_interface
); /* OSPF Interface is
64 passive: no sending or
66 join multicast groups)
68 DECLARE_IF_PARAM(uint8_t, priority
); /* OSPF Interface priority */
69 /* Enable OSPF on this interface with area if_area */
70 DECLARE_IF_PARAM(struct in_addr
, if_area
);
71 uint32_t if_area_id_fmt
;
73 DECLARE_IF_PARAM(uint8_t, type
); /* type of interface */
74 #define OSPF_IF_ACTIVE 0
75 #define OSPF_IF_PASSIVE 1
77 #define OSPF_IF_PASSIVE_STATUS(O) \
78 (OSPF_IF_PARAM_CONFIGURED((O)->params, passive_interface) \
79 ? (O)->params->passive_interface \
80 : (OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS((O)->ifp), \
82 ? IF_DEF_PARAMS((O)->ifp)->passive_interface \
83 : (O)->ospf->passive_interface_default))
85 DECLARE_IF_PARAM(uint32_t, v_hello
); /* Hello Interval */
86 DECLARE_IF_PARAM(uint32_t, v_wait
); /* Router Dead Interval */
88 /* MTU mismatch check (see RFC2328, chap 10.6) */
89 DECLARE_IF_PARAM(uint8_t, mtu_ignore
);
92 DECLARE_IF_PARAM(uint8_t, fast_hello
);
94 /* Authentication data. */
95 uint8_t auth_simple
[OSPF_AUTH_SIMPLE_SIZE
+ 1]; /* Simple password. */
96 uint8_t auth_simple__config
: 1;
98 DECLARE_IF_PARAM(struct list
*,
99 auth_crypt
); /* List of Auth cryptographic data. */
100 DECLARE_IF_PARAM(int, auth_type
); /* OSPF authentication type */
102 /* Other, non-configuration state */
103 uint32_t network_lsa_seqnum
; /* Network LSA seqnum */
105 /* BFD configuration */
106 struct bfd_info
*bfd_info
;
109 enum { MEMBER_ALLROUTERS
= 0,
114 struct ospf_if_info
{
115 struct ospf_if_params
*def_params
;
116 struct route_table
*params
;
117 struct route_table
*oifs
;
119 membership_counts
[MEMBER_MAX
]; /* multicast group refcnts */
124 struct ospf_interface
;
126 struct ospf_vl_data
{
127 struct in_addr vl_peer
; /* Router-ID of the peer */
128 struct in_addr vl_area_id
; /* Transit area */
129 int vl_area_id_fmt
; /* Area ID format */
130 struct ospf_interface
*vl_oi
; /* Interface data structure */
131 struct vertex_nexthop nexthop
; /* Nexthop router and oi to use */
132 struct in_addr peer_addr
; /* Address used to reach the peer */
137 #define OSPF_VL_MAX_COUNT 256
138 #define OSPF_VL_MTU 1500
140 #define OSPF_VL_FLAG_APPROVED 0x01
144 uint8_t auth_key
[OSPF_AUTH_MD5_SIZE
+ 1];
147 /* OSPF interface structure. */
148 struct ospf_interface
{
149 /* This interface's parent ospf instance. */
153 struct ospf_area
*area
;
155 /* Position range in Router LSA */
156 uint16_t lsa_pos_beg
; /* inclusive, >= */
157 uint16_t lsa_pos_end
; /* exclusive, < */
159 /* Interface data from zebra. */
160 struct interface
*ifp
;
161 struct ospf_vl_data
*vl_data
; /* Data for Virtual Link */
163 /* Packet send buffer. */
164 struct ospf_fifo
*obuf
; /* Output queue */
166 /* OSPF Network Type. */
169 /* State of Interface State Machine. */
172 /* To which multicast groups do we currently belong? */
173 uint8_t multicast_memberships
;
174 #define OI_MEMBER_FLAG(M) (1 << (M))
175 #define OI_MEMBER_COUNT(O,M) (IF_OSPF_IF_INFO(oi->ifp)->membership_counts[(M)])
176 #define OI_MEMBER_CHECK(O, M) \
177 (CHECK_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)))
178 #define OI_MEMBER_JOINED(O, M) \
180 SET_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)); \
181 IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]++; \
183 #define OI_MEMBER_LEFT(O, M) \
185 UNSET_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)); \
186 IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]--; \
189 struct prefix
*address
; /* Interface prefix */
190 struct connected
*connected
; /* Pointer to connected */
192 /* Configured varables. */
193 struct ospf_if_params
*params
;
195 uint32_t crypt_seqnum
; /* Cryptographic Sequence Number */
196 uint32_t output_cost
; /* Acutual Interface Output Cost */
198 /* Neighbor information. */
199 struct route_table
*nbrs
; /* OSPF Neighbor List */
200 struct ospf_neighbor
*nbr_self
; /* Neighbor Self */
201 #define DR(I) ((I)->nbr_self->d_router)
202 #define BDR(I) ((I)->nbr_self->bd_router)
203 #define OPTIONS(I) ((I)->nbr_self->options)
204 #define PRIORITY(I) ((I)->nbr_self->priority)
206 /* List of configured NBMA neighbor. */
207 struct list
*nbr_nbma
;
209 /* self-originated LSAs. */
210 struct ospf_lsa
*network_lsa_self
; /* network-LSA. */
211 struct list
*opaque_lsa_self
; /* Type-9 Opaque-LSAs */
213 struct route_table
*ls_upd_queue
;
215 struct list
*ls_ack
; /* Link State Acknowledgment list. */
223 uint32_t v_ls_ack
; /* Delayed Link State Acknowledgment */
226 struct thread
*t_hello
; /* timer */
227 struct thread
*t_wait
; /* timer */
228 struct thread
*t_ls_ack
; /* timer */
229 struct thread
*t_ls_ack_direct
; /* event */
230 struct thread
*t_ls_upd_event
; /* event */
231 struct thread
*t_opaque_lsa_self
; /* Type-9 Opaque-LSAs */
235 /* Statistics fields. */
236 uint32_t hello_in
; /* Hello message input count. */
237 uint32_t hello_out
; /* Hello message output count. */
238 uint32_t db_desc_in
; /* database desc. message input count. */
239 uint32_t db_desc_out
; /* database desc. message output count. */
240 uint32_t ls_req_in
; /* LS request message input count. */
241 uint32_t ls_req_out
; /* LS request message output count. */
242 uint32_t ls_upd_in
; /* LS update message input count. */
243 uint32_t ls_upd_out
; /* LS update message output count. */
244 uint32_t ls_ack_in
; /* LS Ack message input count. */
245 uint32_t ls_ack_out
; /* LS Ack message output count. */
246 uint32_t discarded
; /* discarded input count by error. */
247 uint32_t state_change
; /* Number of status change. */
253 DECLARE_QOBJ_TYPE(ospf_interface
)
256 extern char *ospf_if_name(struct ospf_interface
*);
257 extern struct ospf_interface
*ospf_if_new(struct ospf
*, struct interface
*,
259 extern void ospf_if_cleanup(struct ospf_interface
*);
260 extern void ospf_if_free(struct ospf_interface
*);
261 extern int ospf_if_up(struct ospf_interface
*);
262 extern int ospf_if_down(struct ospf_interface
*);
264 extern int ospf_if_is_up(struct ospf_interface
*);
265 extern struct ospf_interface
*ospf_if_exists(struct ospf_interface
*);
266 extern struct ospf_interface
*ospf_if_lookup_by_lsa_pos(struct ospf_area
*,
268 extern struct ospf_interface
*
269 ospf_if_lookup_by_local_addr(struct ospf
*, struct interface
*, struct in_addr
);
270 extern struct ospf_interface
*ospf_if_lookup_by_prefix(struct ospf
*,
271 struct prefix_ipv4
*);
272 extern struct ospf_interface
*ospf_if_table_lookup(struct interface
*,
274 extern struct ospf_interface
*ospf_if_addr_local(struct in_addr
);
275 extern struct ospf_interface
*
276 ospf_if_lookup_recv_if(struct ospf
*, struct in_addr
, struct interface
*);
277 extern struct ospf_interface
*ospf_if_is_configured(struct ospf
*,
280 extern struct ospf_if_params
*ospf_lookup_if_params(struct interface
*,
282 extern struct ospf_if_params
*ospf_get_if_params(struct interface
*,
284 extern void ospf_del_if_params(struct ospf_if_params
*);
285 extern void ospf_free_if_params(struct interface
*, struct in_addr
);
286 extern void ospf_if_update_params(struct interface
*, struct in_addr
);
288 extern int ospf_if_new_hook(struct interface
*);
289 extern void ospf_if_init(void);
290 extern void ospf_if_stream_unset(struct ospf_interface
*);
291 extern void ospf_if_reset_variables(struct ospf_interface
*);
292 extern int ospf_if_is_enable(struct ospf_interface
*);
293 extern int ospf_if_get_output_cost(struct ospf_interface
*);
294 extern void ospf_if_recalculate_output_cost(struct interface
*);
296 /* Simulate down/up on the interface. */
297 extern void ospf_if_reset(struct interface
*);
299 extern struct ospf_interface
*ospf_vl_new(struct ospf
*, struct ospf_vl_data
*);
300 extern struct ospf_vl_data
*ospf_vl_data_new(struct ospf_area
*,
302 extern struct ospf_vl_data
*ospf_vl_lookup(struct ospf
*, struct ospf_area
*,
304 extern int ospf_vl_count(struct ospf
*ospf
, struct ospf_area
*area
);
305 extern void ospf_vl_data_free(struct ospf_vl_data
*);
306 extern void ospf_vl_add(struct ospf
*, struct ospf_vl_data
*);
307 extern void ospf_vl_delete(struct ospf
*, struct ospf_vl_data
*);
308 extern void ospf_vl_up_check(struct ospf_area
*, struct in_addr
,
310 extern void ospf_vl_unapprove(struct ospf
*);
311 extern void ospf_vl_shut_unapproved(struct ospf
*);
312 extern int ospf_full_virtual_nbrs(struct ospf_area
*);
313 extern int ospf_vls_in_area(struct ospf_area
*);
315 extern struct crypt_key
*ospf_crypt_key_lookup(struct list
*, uint8_t);
316 extern struct crypt_key
*ospf_crypt_key_new(void);
317 extern void ospf_crypt_key_add(struct list
*, struct crypt_key
*);
318 extern int ospf_crypt_key_delete(struct list
*, uint8_t);
319 extern uint8_t ospf_default_iftype(struct interface
*ifp
);
320 extern int ospf_interface_neighbor_count(struct ospf_interface
*oi
);
322 /* Set all multicast memberships appropriately based on the type and
323 state of the interface. */
324 extern void ospf_if_set_multicast(struct ospf_interface
*);
326 extern void ospf_if_interface(struct interface
*ifp
);
328 DECLARE_HOOK(ospf_vl_add
, (struct ospf_vl_data
* vd
), (vd
))
329 DECLARE_HOOK(ospf_vl_delete
, (struct ospf_vl_data
* vd
), (vd
))
331 DECLARE_HOOK(ospf_if_update
, (struct interface
* ifp
), (ifp
))
332 DECLARE_HOOK(ospf_if_delete
, (struct interface
* ifp
), (ifp
))
334 #endif /* _ZEBRA_OSPF_INTERFACE_H */