1 /* Interface function header.
2 * Copyright (C) 1999 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
6 * GNU Zebra is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2, or (at your option) any
11 * GNU Zebra is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; see the file COPYING; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef _ZEBRA_INTERFACE_H
22 #define _ZEBRA_INTERFACE_H
24 #include "redistribute.h"
28 #include "zebra/zebra_l2.h"
30 /* For interface multicast configuration. */
31 #define IF_ZEBRA_MULTICAST_UNSPEC 0
32 #define IF_ZEBRA_MULTICAST_ON 1
33 #define IF_ZEBRA_MULTICAST_OFF 2
35 /* For interface shutdown configuration. */
36 #define IF_ZEBRA_SHUTDOWN_OFF 0
37 #define IF_ZEBRA_SHUTDOWN_ON 1
39 #if defined(HAVE_RTADV)
40 /* Router advertisement parameter. From RFC4861, RFC6275 and RFC4191. */
42 /* A flag indicating whether or not the router sends periodic Router
43 Advertisements and responds to Router Solicitations.
45 int AdvSendAdvertisements
;
47 /* The maximum time allowed between sending unsolicited multicast
48 Router Advertisements from the interface, in milliseconds.
49 MUST be no less than 70 ms [RFC6275 7.5] and no greater
50 than 1800000 ms [RFC4861 6.2.1].
52 Default: 600000 milliseconds */
53 int MaxRtrAdvInterval
;
54 #define RTADV_MAX_RTR_ADV_INTERVAL 600000
56 /* The minimum time allowed between sending unsolicited multicast
57 Router Advertisements from the interface, in milliseconds.
58 MUST be no less than 30 ms [RFC6275 7.5].
59 MUST be no greater than .75 * MaxRtrAdvInterval.
61 Default: 0.33 * MaxRtrAdvInterval */
62 int MinRtrAdvInterval
; /* This field is currently unused. */
64 /* clang-format off */
65 #define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)
67 /* Unsolicited Router Advertisements' interval timer. */
70 /* The TRUE/FALSE value to be placed in the "Managed address
71 configuration" flag field in the Router Advertisement. See
78 /* The TRUE/FALSE value to be placed in the "Other stateful
79 configuration" flag field in the Router Advertisement. See
83 int AdvOtherConfigFlag
;
85 /* The value to be placed in MTU options sent by the router. A
86 value of zero indicates that no MTU options are sent.
92 /* The value to be placed in the Reachable Time field in the Router
93 Advertisement messages sent by the router. The value zero means
94 unspecified (by this router). MUST be no greater than 3,600,000
95 milliseconds (1 hour).
98 u_int32_t AdvReachableTime
;
99 #define RTADV_MAX_REACHABLE_TIME 3600000
101 /* The value to be placed in the Retrans Timer field in the Router
102 Advertisement messages sent by the router. The value zero means
103 unspecified (by this router).
108 /* The default value to be placed in the Cur Hop Limit field in the
109 Router Advertisement messages sent by the router. The value
110 should be set to that current diameter of the Internet. The
111 value zero means unspecified (by this router).
113 Default: The value specified in the "Assigned Numbers" RFC
114 [ASSIGNED] that was in effect at the time of implementation. */
117 /* The value to be placed in the Router Lifetime field of Router
118 Advertisements sent from the interface, in seconds. MUST be
119 either zero or between MaxRtrAdvInterval and 9000 seconds. A
120 value of zero indicates that the router is not to be used as a
123 Default: 3 * MaxRtrAdvInterval */
124 int AdvDefaultLifetime
;
125 #define RTADV_MAX_RTRLIFETIME 9000 /* 2.5 hours */
127 /* A list of prefixes to be placed in Prefix Information options in
128 Router Advertisement messages sent from the interface.
130 Default: all prefixes that the router advertises via routing
131 protocols as being on-link for the interface from which the
132 advertisement is sent. The link-local prefix SHOULD NOT be
133 included in the list of advertised prefixes. */
134 struct list
*AdvPrefixList
;
136 /* The TRUE/FALSE value to be placed in the "Home agent"
137 flag field in the Router Advertisement. See [RFC6275 7.1].
140 int AdvHomeAgentFlag
;
141 #ifndef ND_RA_FLAG_HOME_AGENT
142 #define ND_RA_FLAG_HOME_AGENT 0x20
145 /* The value to be placed in Home Agent Information option if Home
148 int HomeAgentPreference
;
150 /* The value to be placed in Home Agent Information option if Home
151 Flag is set. Lifetime (seconds) MUST not be greater than 18.2
153 The value 0 has special meaning: use of AdvDefaultLifetime value.
156 int HomeAgentLifetime
;
157 #define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */
159 /* The TRUE/FALSE value to insert or not an Advertisement Interval
160 option. See [RFC 6275 7.3]
163 int AdvIntervalOption
;
165 /* The value to be placed in the Default Router Preference field of
166 a router advertisement. See [RFC 4191 2.1 & 2.2]
168 Default: 0 (medium) */
169 int DefaultPreference
;
170 #define RTADV_PREF_MEDIUM 0x0 /* Per RFC4191. */
172 u_char inFastRexmit
; /* True if we're rexmits faster than usual */
174 /* Track if RA was configured by BGP or by the Operator or both */
175 u_char ra_configured
; /* Was RA configured? */
176 #define BGP_RA_CONFIGURED (1<<0) /* BGP configured RA? */
177 #define VTY_RA_CONFIGURED (1<<1) /* Operator configured RA? */
178 #define VTY_RA_INTERVAL_CONFIGURED (1<<2) /* Operator configured RA interval */
180 NumFastReXmitsRemain
; /* Loaded first with number of fast
183 #define RTADV_FAST_REXMIT_PERIOD 1 /* 1 sec */
184 #define RTADV_NUM_FAST_REXMITS 4 /* Fast Rexmit RA 4 times on certain events */
187 #endif /* HAVE_RTADV */
189 /* Zebra interface type - ones of interest. */
191 ZEBRA_IF_OTHER
= 0, /* Anything else */
192 ZEBRA_IF_VXLAN
, /* VxLAN interface */
193 ZEBRA_IF_VRF
, /* VRF device */
194 ZEBRA_IF_BRIDGE
, /* bridge device */
195 ZEBRA_IF_VLAN
, /* VLAN sub-interface */
196 ZEBRA_IF_MACVLAN
, /* MAC VLAN interface*/
199 /* Zebra "slave" interface type */
201 ZEBRA_IF_SLAVE_NONE
, /* Not a slave */
202 ZEBRA_IF_SLAVE_VRF
, /* Member of a VRF */
203 ZEBRA_IF_SLAVE_BRIDGE
, /* Member of a bridge */
204 ZEBRA_IF_SLAVE_OTHER
, /* Something else - e.g., bond slave */
205 } zebra_slave_iftype_t
;
207 struct irdp_interface
;
209 /* `zebra' daemon local interface structure. */
211 /* Shutdown configuration. */
214 /* Multicast configuration. */
217 /* Router advertise configuration. */
220 /* Installed addresses chains tree. */
221 struct route_table
*ipv4_subnets
;
223 /* Information about up/down changes */
224 unsigned int up_count
;
225 char up_last
[QUAGGA_TIMESTAMP_LEN
];
226 unsigned int down_count
;
227 char down_last
[QUAGGA_TIMESTAMP_LEN
];
229 #if defined(HAVE_RTADV)
230 struct rtadvconf rtadv
;
231 unsigned int ra_sent
, ra_rcvd
;
232 #endif /* HAVE_RTADV */
234 struct irdp_interface
*irdp
;
236 #ifdef HAVE_STRUCT_SOCKADDR_DL
238 /* note that sdl_storage is never accessed, it only exists to
240 * all actual uses refer to sdl - but use sizeof(sdl_storage)!
242 * best with C aliasing rules. */
243 struct sockaddr_dl sdl
;
244 struct sockaddr_storage sdl_storage
;
249 /* the real IFF_UP state of the primary interface.
250 * need this to differentiate between all interfaces being
251 * down (but primary still plumbed) and primary having gone
252 * ~IFF_UP, and all addresses gone.
254 u_char primary_state
;
257 /* ptm enable configuration */
260 /* Zebra interface and "slave" interface type */
261 zebra_iftype_t zif_type
;
262 zebra_slave_iftype_t zif_slave_type
;
264 /* Additional L2 info, depends on zif_type */
265 union zebra_l2if_info l2info
;
267 /* For members of a bridge, link to bridge. */
268 /* Note: If additional fields become necessary, this can be modified to
269 * be a pointer to a dynamically allocd struct.
271 struct zebra_l2info_brslave brslave_info
;
273 /* Link fields - for sub-interfaces. */
274 ifindex_t link_ifindex
;
275 struct interface
*link
;
278 DECLARE_HOOK(zebra_if_extra_info
, (struct vty
*vty
, struct interface
*ifp
),
280 DECLARE_HOOK(zebra_if_config_wr
, (struct vty
*vty
, struct interface
*ifp
),
283 static inline void zebra_if_set_ziftype(struct interface
*ifp
,
284 zebra_iftype_t zif_type
,
285 zebra_slave_iftype_t zif_slave_type
)
287 struct zebra_if
*zif
;
289 zif
= (struct zebra_if
*)ifp
->info
;
290 zif
->zif_type
= zif_type
;
291 zif
->zif_slave_type
= zif_slave_type
;
294 #define IS_ZEBRA_IF_VRF(ifp) \
295 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VRF)
297 #define IS_ZEBRA_IF_BRIDGE(ifp) \
298 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BRIDGE)
300 #define IS_ZEBRA_IF_VLAN(ifp) \
301 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VLAN)
303 #define IS_ZEBRA_IF_VXLAN(ifp) \
304 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VXLAN)
306 #define IS_ZEBRA_IF_MACVLAN(ifp) \
307 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_MACVLAN)
309 #define IS_ZEBRA_IF_BRIDGE_SLAVE(ifp) \
310 (((struct zebra_if *)(ifp->info))->zif_slave_type \
311 == ZEBRA_IF_SLAVE_BRIDGE)
313 #define IS_ZEBRA_IF_VRF_SLAVE(ifp) \
314 (((struct zebra_if *)(ifp->info))->zif_slave_type == ZEBRA_IF_SLAVE_VRF)
316 extern void zebra_if_init(void);
318 extern struct interface
*if_lookup_by_index_per_ns(struct zebra_ns
*,
320 extern struct interface
*if_lookup_by_name_per_ns(struct zebra_ns
*,
322 extern struct interface
*if_link_per_ns(struct zebra_ns
*, struct interface
*);
323 extern const char *ifindex2ifname_per_ns(struct zebra_ns
*, unsigned int);
325 extern void if_unlink_per_ns(struct interface
*);
326 extern void if_nbr_ipv6ll_to_ipv4ll_neigh_update(struct interface
*ifp
,
327 struct in6_addr
*address
,
329 extern void if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(struct interface
*ifp
);
330 extern void if_delete_update(struct interface
*ifp
);
331 extern void if_add_update(struct interface
*ifp
);
332 extern void if_up(struct interface
*);
333 extern void if_down(struct interface
*);
334 extern void if_refresh(struct interface
*);
335 extern void if_flags_update(struct interface
*, uint64_t);
336 extern int if_subnet_add(struct interface
*, struct connected
*);
337 extern int if_subnet_delete(struct interface
*, struct connected
*);
338 extern int ipv6_address_configured(struct interface
*ifp
);
339 extern void if_handle_vrf_change(struct interface
*ifp
, vrf_id_t vrf_id
);
340 extern void zebra_if_update_link(struct interface
*ifp
, ifindex_t link_ifindex
);
342 extern void vrf_add_update(struct vrf
*vrfp
);
344 #ifdef HAVE_PROC_NET_DEV
345 extern void ifstat_update_proc(void);
346 #endif /* HAVE_PROC_NET_DEV */
347 #ifdef HAVE_NET_RT_IFLIST
348 extern void ifstat_update_sysctl(void);
350 #endif /* HAVE_NET_RT_IFLIST */
351 #ifdef HAVE_PROC_NET_DEV
352 extern int interface_list_proc(void);
353 #endif /* HAVE_PROC_NET_DEV */
354 #ifdef HAVE_PROC_NET_IF_INET6
355 extern int ifaddr_proc_ipv6(void);
356 #endif /* HAVE_PROC_NET_IF_INET6 */
358 #endif /* _ZEBRA_INTERFACE_H */