2 /* Interface function header.
3 * Copyright (C) 1999 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
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
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_INTERFACE_H
23 #define _ZEBRA_INTERFACE_H
25 #include "redistribute.h"
29 #include "zebra/zebra_l2.h"
30 #include "zebra/zebra_nhg_private.h"
36 /* For interface multicast configuration. */
37 #define IF_ZEBRA_MULTICAST_UNSPEC 0
38 #define IF_ZEBRA_MULTICAST_ON 1
39 #define IF_ZEBRA_MULTICAST_OFF 2
41 /* For interface shutdown configuration. */
42 #define IF_ZEBRA_SHUTDOWN_OFF 0
43 #define IF_ZEBRA_SHUTDOWN_ON 1
45 #if defined(HAVE_RTADV)
46 /* Router advertisement parameter. From RFC4861, RFC6275 and RFC4191. */
48 /* A flag indicating whether or not the router sends periodic Router
49 Advertisements and responds to Router Solicitations.
51 int AdvSendAdvertisements
;
53 /* The maximum time allowed between sending unsolicited multicast
54 Router Advertisements from the interface, in milliseconds.
55 MUST be no less than 70 ms [RFC6275 7.5] and no greater
56 than 1800000 ms [RFC4861 6.2.1].
58 Default: 600000 milliseconds */
59 int MaxRtrAdvInterval
;
60 #define RTADV_MAX_RTR_ADV_INTERVAL 600000
62 /* The minimum time allowed between sending unsolicited multicast
63 Router Advertisements from the interface, in milliseconds.
64 MUST be no less than 30 ms [RFC6275 7.5].
65 MUST be no greater than .75 * MaxRtrAdvInterval.
67 Default: 0.33 * MaxRtrAdvInterval */
68 int MinRtrAdvInterval
; /* This field is currently unused. */
69 #define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)
71 /* Unsolicited Router Advertisements' interval timer. */
74 /* The true/false value to be placed in the "Managed address
75 configuration" flag field in the Router Advertisement. See
82 /* The true/false value to be placed in the "Other stateful
83 configuration" flag field in the Router Advertisement. See
87 int AdvOtherConfigFlag
;
89 /* The value to be placed in MTU options sent by the router. A
90 value of zero indicates that no MTU options are sent.
96 /* The value to be placed in the Reachable Time field in the Router
97 Advertisement messages sent by the router. The value zero means
98 unspecified (by this router). MUST be no greater than 3,600,000
99 milliseconds (1 hour).
102 uint32_t AdvReachableTime
;
103 #define RTADV_MAX_REACHABLE_TIME 3600000
105 /* The value to be placed in the Retrans Timer field in the Router
106 Advertisement messages sent by the router. The value zero means
107 unspecified (by this router).
112 /* The default value to be placed in the Cur Hop Limit field in the
113 Router Advertisement messages sent by the router. The value
114 should be set to that current diameter of the Internet. The
115 value zero means unspecified (by this router).
117 Default: The value specified in the "Assigned Numbers" RFC
118 [ASSIGNED] that was in effect at the time of implementation. */
121 /* The value to be placed in the Router Lifetime field of Router
122 Advertisements sent from the interface, in seconds. MUST be
123 either zero or between MaxRtrAdvInterval and 9000 seconds. A
124 value of zero indicates that the router is not to be used as a
127 Default: 3 * MaxRtrAdvInterval */
128 int AdvDefaultLifetime
;
129 #define RTADV_MAX_RTRLIFETIME 9000 /* 2.5 hours */
131 /* A list of prefixes to be placed in Prefix Information options in
132 Router Advertisement messages sent from the interface.
134 Default: all prefixes that the router advertises via routing
135 protocols as being on-link for the interface from which the
136 advertisement is sent. The link-local prefix SHOULD NOT be
137 included in the list of advertised prefixes. */
138 struct list
*AdvPrefixList
;
140 /* The true/false value to be placed in the "Home agent"
141 flag field in the Router Advertisement. See [RFC6275 7.1].
144 int AdvHomeAgentFlag
;
145 #ifndef ND_RA_FLAG_HOME_AGENT
146 #define ND_RA_FLAG_HOME_AGENT 0x20
149 /* The value to be placed in Home Agent Information option if Home
152 int HomeAgentPreference
;
154 /* The value to be placed in Home Agent Information option if Home
155 Flag is set. Lifetime (seconds) MUST not be greater than 18.2
157 The value 0 has special meaning: use of AdvDefaultLifetime value.
160 int HomeAgentLifetime
;
161 #define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */
163 /* The true/false value to insert or not an Advertisement Interval
164 option. See [RFC 6275 7.3]
167 int AdvIntervalOption
;
169 /* The value to be placed in the Default Router Preference field of
170 a router advertisement. See [RFC 4191 2.1 & 2.2]
172 Default: 0 (medium) */
173 int DefaultPreference
;
174 #define RTADV_PREF_MEDIUM 0x0 /* Per RFC4191. */
177 * List of recursive DNS servers to include in the RDNSS option.
180 * Default: empty list; do not emit RDNSS option
182 struct list
*AdvRDNSSList
;
185 * List of DNS search domains to include in the DNSSL option.
188 * Default: empty list; do not emit DNSSL option
190 struct list
*AdvDNSSLList
;
192 uint8_t inFastRexmit
; /* True if we're rexmits faster than usual */
194 /* Track if RA was configured by BGP or by the Operator or both */
195 uint8_t ra_configured
; /* Was RA configured? */
196 #define BGP_RA_CONFIGURED (1<<0) /* BGP configured RA? */
197 #define VTY_RA_CONFIGURED (1<<1) /* Operator configured RA? */
198 #define VTY_RA_INTERVAL_CONFIGURED (1<<2) /* Operator configured RA interval */
199 int NumFastReXmitsRemain
; /* Loaded first with number of fast
202 #define RTADV_FAST_REXMIT_PERIOD 1 /* 1 sec */
203 #define RTADV_NUM_FAST_REXMITS 4 /* Fast Rexmit RA 4 times on certain events */
207 /* Address of recursive DNS server to advertise */
208 struct in6_addr addr
;
211 * Lifetime in seconds; all-ones means infinity, zero
216 /* If lifetime not set, use a default of 3*MaxRtrAdvInterval */
221 * [RFC1035 2.3.4] sets the maximum length of a domain name (a sequence of
222 * labels, each prefixed by a length octet) at 255 octets.
224 #define RTADV_MAX_ENCODED_DOMAIN_NAME 255
227 /* Domain name without trailing root zone dot (NUL-terminated) */
228 char name
[RTADV_MAX_ENCODED_DOMAIN_NAME
- 1];
230 /* Name encoded as in [RFC1035 3.1] */
231 uint8_t encoded_name
[RTADV_MAX_ENCODED_DOMAIN_NAME
];
233 /* Actual length of encoded_name */
236 /* Lifetime as for RDNSS */
241 #endif /* HAVE_RTADV */
243 /* Zebra interface type - ones of interest. */
245 ZEBRA_IF_OTHER
= 0, /* Anything else */
246 ZEBRA_IF_VXLAN
, /* VxLAN interface */
247 ZEBRA_IF_VRF
, /* VRF device */
248 ZEBRA_IF_BRIDGE
, /* bridge device */
249 ZEBRA_IF_VLAN
, /* VLAN sub-interface */
250 ZEBRA_IF_MACVLAN
, /* MAC VLAN interface*/
251 ZEBRA_IF_VETH
, /* VETH interface*/
252 ZEBRA_IF_BOND
, /* Bond */
253 ZEBRA_IF_BOND_SLAVE
, /* Bond */
256 /* Zebra "slave" interface type */
258 ZEBRA_IF_SLAVE_NONE
, /* Not a slave */
259 ZEBRA_IF_SLAVE_VRF
, /* Member of a VRF */
260 ZEBRA_IF_SLAVE_BRIDGE
, /* Member of a bridge */
261 ZEBRA_IF_SLAVE_BOND
, /* Bond member */
262 ZEBRA_IF_SLAVE_OTHER
, /* Something else - e.g., bond slave */
263 } zebra_slave_iftype_t
;
265 struct irdp_interface
;
267 /* `zebra' daemon local interface structure. */
269 /* Shutdown configuration. */
272 /* Multicast configuration. */
275 /* Router advertise configuration. */
276 uint8_t rtadv_enable
;
278 /* Installed addresses chains tree. */
279 struct route_table
*ipv4_subnets
;
281 /* Nexthops pointing to this interface */
283 * Any nexthop that we get should have an
284 * interface. When an interface goes down,
285 * we will use this list to update the nexthops
286 * pointing to it with that info.
288 struct nhg_connected_tree_head nhg_dependents
;
290 /* Information about up/down changes */
291 unsigned int up_count
;
292 char up_last
[QUAGGA_TIMESTAMP_LEN
];
293 unsigned int down_count
;
294 char down_last
[QUAGGA_TIMESTAMP_LEN
];
296 #if defined(HAVE_RTADV)
297 struct rtadvconf rtadv
;
298 unsigned int ra_sent
, ra_rcvd
;
299 #endif /* HAVE_RTADV */
301 struct irdp_interface
*irdp
;
303 #ifdef HAVE_STRUCT_SOCKADDR_DL
305 /* note that sdl_storage is never accessed, it only exists to
307 * all actual uses refer to sdl - but use sizeof(sdl_storage)!
309 * best with C aliasing rules. */
310 struct sockaddr_dl sdl
;
311 struct sockaddr_storage sdl_storage
;
316 /* the real IFF_UP state of the primary interface.
317 * need this to differentiate between all interfaces being
318 * down (but primary still plumbed) and primary having gone
319 * ~IFF_UP, and all addresses gone.
321 uint8_t primary_state
;
324 /* ptm enable configuration */
327 /* Zebra interface and "slave" interface type */
328 zebra_iftype_t zif_type
;
329 zebra_slave_iftype_t zif_slave_type
;
331 /* Additional L2 info, depends on zif_type */
332 union zebra_l2if_info l2info
;
334 /* For members of a bridge, link to bridge. */
335 /* Note: If additional fields become necessary, this can be modified to
336 * be a pointer to a dynamically allocd struct.
338 struct zebra_l2info_brslave brslave_info
;
340 struct zebra_l2info_bondslave bondslave_info
;
342 /* Link fields - for sub-interfaces. */
343 ifindex_t link_ifindex
;
344 struct interface
*link
;
346 struct thread
*speed_update
;
349 * Does this interface have a v6 to v4 ll neighbor entry
350 * for bgp unnumbered?
352 bool v6_2_v4_ll_neigh_entry
;
354 struct in6_addr v6_2_v4_ll_addr6
;
356 /* The description of the interface */
360 DECLARE_HOOK(zebra_if_extra_info
, (struct vty
* vty
, struct interface
*ifp
),
362 DECLARE_HOOK(zebra_if_config_wr
, (struct vty
* vty
, struct interface
*ifp
),
365 static inline void zebra_if_set_ziftype(struct interface
*ifp
,
366 zebra_iftype_t zif_type
,
367 zebra_slave_iftype_t zif_slave_type
)
369 struct zebra_if
*zif
;
371 zif
= (struct zebra_if
*)ifp
->info
;
372 zif
->zif_type
= zif_type
;
373 zif
->zif_slave_type
= zif_slave_type
;
376 #define IS_ZEBRA_IF_VRF(ifp) \
377 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VRF)
379 #define IS_ZEBRA_IF_BRIDGE(ifp) \
380 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BRIDGE)
382 #define IS_ZEBRA_IF_VLAN(ifp) \
383 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VLAN)
385 #define IS_ZEBRA_IF_VXLAN(ifp) \
386 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VXLAN)
388 #define IS_ZEBRA_IF_MACVLAN(ifp) \
389 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_MACVLAN)
391 #define IS_ZEBRA_IF_VETH(ifp) \
392 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VETH)
394 #define IS_ZEBRA_IF_BRIDGE_SLAVE(ifp) \
395 (((struct zebra_if *)(ifp->info))->zif_slave_type \
396 == ZEBRA_IF_SLAVE_BRIDGE)
398 #define IS_ZEBRA_IF_VRF_SLAVE(ifp) \
399 (((struct zebra_if *)(ifp->info))->zif_slave_type == ZEBRA_IF_SLAVE_VRF)
401 #define IS_ZEBRA_IF_BOND_SLAVE(ifp) \
402 (((struct zebra_if *)(ifp->info))->zif_slave_type \
403 == ZEBRA_IF_SLAVE_BOND)
405 extern void zebra_if_init(void);
407 extern struct interface
*if_lookup_by_index_per_ns(struct zebra_ns
*, uint32_t);
408 extern struct interface
*if_lookup_by_name_per_ns(struct zebra_ns
*,
410 extern struct interface
*if_link_per_ns(struct zebra_ns
*, struct interface
*);
411 extern const char *ifindex2ifname_per_ns(struct zebra_ns
*, unsigned int);
413 extern void if_unlink_per_ns(struct interface
*);
414 extern void if_nbr_mac_to_ipv4ll_neigh_update(struct interface
*fip
,
416 struct in6_addr
*address
,
418 extern void if_nbr_ipv6ll_to_ipv4ll_neigh_update(struct interface
*ifp
,
419 struct in6_addr
*address
,
421 extern void if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(struct interface
*ifp
);
422 extern void if_delete_update(struct interface
*ifp
);
423 extern void if_add_update(struct interface
*ifp
);
424 extern void if_up(struct interface
*);
425 extern void if_down(struct interface
*);
426 extern void if_refresh(struct interface
*);
427 extern void if_flags_update(struct interface
*, uint64_t);
428 extern int if_subnet_add(struct interface
*, struct connected
*);
429 extern int if_subnet_delete(struct interface
*, struct connected
*);
430 extern int ipv6_address_configured(struct interface
*ifp
);
431 extern void if_handle_vrf_change(struct interface
*ifp
, vrf_id_t vrf_id
);
432 extern void zebra_if_update_link(struct interface
*ifp
, ifindex_t link_ifindex
,
434 extern void zebra_if_update_all_links(void);
435 extern void zebra_if_set_protodown(struct interface
*ifp
, bool down
);
437 /* Nexthop group connected functions */
438 extern void if_nhg_dependents_add(struct interface
*ifp
,
439 struct nhg_hash_entry
*nhe
);
440 extern void if_nhg_dependents_del(struct interface
*ifp
,
441 struct nhg_hash_entry
*nhe
);
442 extern unsigned int if_nhg_dependents_count(const struct interface
*ifp
);
443 extern bool if_nhg_dependents_is_empty(const struct interface
*ifp
);
445 extern void vrf_add_update(struct vrf
*vrfp
);
447 #ifdef HAVE_PROC_NET_DEV
448 extern void ifstat_update_proc(void);
449 #endif /* HAVE_PROC_NET_DEV */
450 #ifdef HAVE_NET_RT_IFLIST
451 extern void ifstat_update_sysctl(void);
453 #endif /* HAVE_NET_RT_IFLIST */
454 #ifdef HAVE_PROC_NET_DEV
455 extern int interface_list_proc(void);
456 #endif /* HAVE_PROC_NET_DEV */
457 #ifdef HAVE_PROC_NET_IF_INET6
458 extern int ifaddr_proc_ipv6(void);
459 #endif /* HAVE_PROC_NET_IF_INET6 */
465 #endif /* _ZEBRA_INTERFACE_H */