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"
30 #include "zebra/zebra_l2.h"
31 #include "zebra/zebra_nhg_private.h"
32 #include "zebra/zebra_router.h"
33 #include "zebra/rtadv.h"
39 /* For interface multicast configuration. */
40 #define IF_ZEBRA_MULTICAST_UNSPEC 0
41 #define IF_ZEBRA_MULTICAST_ON 1
42 #define IF_ZEBRA_MULTICAST_OFF 2
44 /* For interface shutdown configuration. */
45 #define IF_ZEBRA_SHUTDOWN_OFF 0
46 #define IF_ZEBRA_SHUTDOWN_ON 1
48 #define IF_VLAN_BITMAP_MAX 4096
50 /* Zebra interface type - ones of interest. */
52 ZEBRA_IF_OTHER
= 0, /* Anything else */
53 ZEBRA_IF_VXLAN
, /* VxLAN interface */
54 ZEBRA_IF_VRF
, /* VRF device */
55 ZEBRA_IF_BRIDGE
, /* bridge device */
56 ZEBRA_IF_VLAN
, /* VLAN sub-interface */
57 ZEBRA_IF_MACVLAN
, /* MAC VLAN interface*/
58 ZEBRA_IF_VETH
, /* VETH interface*/
59 ZEBRA_IF_BOND
, /* Bond */
60 ZEBRA_IF_BOND_SLAVE
, /* Bond */
61 ZEBRA_IF_GRE
, /* GRE interface */
64 /* Zebra "slave" interface type */
65 enum zebra_slave_iftype
{
66 ZEBRA_IF_SLAVE_NONE
, /* Not a slave */
67 ZEBRA_IF_SLAVE_VRF
, /* Member of a VRF */
68 ZEBRA_IF_SLAVE_BRIDGE
, /* Member of a bridge */
69 ZEBRA_IF_SLAVE_BOND
, /* Bond member */
70 ZEBRA_IF_SLAVE_OTHER
, /* Something else - e.g., bond slave */
73 struct irdp_interface
;
75 /* Ethernet segment info used for setting up EVPN multihoming */
77 struct zebra_es_if_info
{
78 /* type-3 esi config */
79 struct ethaddr sysmac
;
80 uint32_t lid
; /* local-id; has to be unique per-ES-sysmac */
86 #define ZIF_CFG_ES_FLAG_BYPASS (1 << 0)
88 struct zebra_evpn_es
*es
; /* local ES */
92 /* device has been configured as an uplink for
95 ZIF_FLAG_EVPN_MH_UPLINK
= (1 << 0),
96 ZIF_FLAG_EVPN_MH_UPLINK_OPER_UP
= (1 << 1),
98 /* Dataplane protodown-on */
99 ZIF_FLAG_PROTODOWN
= (1 << 2),
100 /* Dataplane protodown-on Queued to the dplane */
101 ZIF_FLAG_SET_PROTODOWN
= (1 << 3),
102 /* Dataplane protodown-off Queued to the dplane */
103 ZIF_FLAG_UNSET_PROTODOWN
= (1 << 4),
105 /* LACP bypass state is set by the dataplane on a bond member
106 * and inherited by the bond (if one or more bond members are in
107 * a bypass state the bond is placed in a bypass state)
109 ZIF_FLAG_LACP_BYPASS
= (1 << 5)
112 #define ZEBRA_IF_IS_PROTODOWN(zif) ((zif)->flags & ZIF_FLAG_PROTODOWN)
113 #define ZEBRA_IF_IS_PROTODOWN_ONLY_EXTERNAL(zif) \
114 ((zif)->protodown_rc == ZEBRA_PROTODOWN_EXTERNAL)
116 /* `zebra' daemon local interface structure. */
118 /* back pointer to the interface */
119 struct interface
*ifp
;
121 enum zebra_if_flags flags
;
123 /* Shutdown configuration. */
126 /* Multicast configuration. */
132 /* Router advertise configuration. */
133 uint8_t rtadv_enable
;
135 /* Installed addresses chains tree. */
136 struct route_table
*ipv4_subnets
;
138 /* Nexthops pointing to this interface */
140 * Any nexthop that we get should have an
141 * interface. When an interface goes down,
142 * we will use this list to update the nexthops
143 * pointing to it with that info.
145 struct nhg_connected_tree_head nhg_dependents
;
147 /* Information about up/down changes */
148 unsigned int up_count
;
149 char up_last
[FRR_TIMESTAMP_LEN
];
150 unsigned int down_count
;
151 char down_last
[FRR_TIMESTAMP_LEN
];
153 struct rtadvconf rtadv
;
154 unsigned int ra_sent
, ra_rcvd
;
156 struct irdp_interface
*irdp
;
158 #ifdef HAVE_STRUCT_SOCKADDR_DL
160 /* note that sdl_storage is never accessed, it only exists to
162 * all actual uses refer to sdl - but use sizeof(sdl_storage)!
164 * best with C aliasing rules. */
165 struct sockaddr_dl sdl
;
166 struct sockaddr_storage sdl_storage
;
170 /* ptm enable configuration */
173 /* Zebra interface and "slave" interface type */
174 enum zebra_iftype zif_type
;
175 enum zebra_slave_iftype zif_slave_type
;
177 /* Additional L2 info, depends on zif_type */
178 union zebra_l2if_info l2info
;
180 /* For members of a bridge, link to bridge. */
181 /* Note: If additional fields become necessary, this can be modified to
182 * be a pointer to a dynamically allocd struct.
184 struct zebra_l2info_brslave brslave_info
;
186 struct zebra_l2info_bondslave bondslave_info
;
187 struct zebra_l2info_bond bond_info
;
189 /* ethernet segment */
190 struct zebra_es_if_info es_info
;
192 /* bitmap of vlans associated with this interface */
193 bitfield_t vlan_bitmap
;
195 /* An interface can be error-disabled if a protocol (such as EVPN or
196 * VRRP) detects a problem with keeping it operationally-up.
197 * If any of the protodown bits are set protodown-on is programmed
198 * in the dataplane. This results in a carrier/L1 down on the
201 uint32_t protodown_rc
;
203 /* list of zebra_mac entries using this interface as destination */
204 struct list
*mac_list
;
206 /* Link fields - for sub-interfaces. */
207 ifindex_t link_ifindex
;
208 struct interface
*link
;
210 uint8_t speed_update_count
;
211 struct thread
*speed_update
;
214 * Does this interface have a v6 to v4 ll neighbor entry
215 * for bgp unnumbered?
217 bool v6_2_v4_ll_neigh_entry
;
219 struct in6_addr v6_2_v4_ll_addr6
;
221 /* The description of the interface */
225 DECLARE_HOOK(zebra_if_extra_info
, (struct vty
* vty
, struct interface
*ifp
),
227 DECLARE_HOOK(zebra_if_config_wr
, (struct vty
* vty
, struct interface
*ifp
),
230 #define IS_ZEBRA_IF_VRF(ifp) \
231 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VRF)
233 #define IS_ZEBRA_IF_BRIDGE(ifp) \
234 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BRIDGE)
236 #define IS_ZEBRA_IF_VLAN(ifp) \
237 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VLAN)
239 #define IS_ZEBRA_IF_VXLAN(ifp) \
240 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VXLAN)
242 #define IS_ZEBRA_IF_MACVLAN(ifp) \
243 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_MACVLAN)
245 #define IS_ZEBRA_IF_VETH(ifp) \
246 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VETH)
248 #define IS_ZEBRA_IF_BOND(ifp) \
249 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BOND)
251 #define IS_ZEBRA_IF_GRE(ifp) \
252 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_GRE)
254 #define IS_ZEBRA_IF_BRIDGE_SLAVE(ifp) \
255 (((struct zebra_if *)(ifp->info))->zif_slave_type \
256 == ZEBRA_IF_SLAVE_BRIDGE)
258 #define IS_ZEBRA_IF_VRF_SLAVE(ifp) \
259 (((struct zebra_if *)(ifp->info))->zif_slave_type == ZEBRA_IF_SLAVE_VRF)
261 #define IS_ZEBRA_IF_BOND_SLAVE(ifp) \
262 (((struct zebra_if *)(ifp->info))->zif_slave_type \
263 == ZEBRA_IF_SLAVE_BOND)
265 extern void zebra_if_init(void);
267 extern struct interface
*if_lookup_by_index_per_ns(struct zebra_ns
*, uint32_t);
268 extern struct interface
*if_lookup_by_name_per_ns(struct zebra_ns
*,
270 extern struct interface
*if_link_per_ns(struct zebra_ns
*, struct interface
*);
271 extern const char *ifindex2ifname_per_ns(struct zebra_ns
*, unsigned int);
273 extern void if_unlink_per_ns(struct interface
*);
274 extern void if_nbr_mac_to_ipv4ll_neigh_update(struct interface
*fip
,
276 struct in6_addr
*address
,
278 extern void if_nbr_ipv6ll_to_ipv4ll_neigh_update(struct interface
*ifp
,
279 struct in6_addr
*address
,
281 extern void if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(struct interface
*ifp
);
282 extern void if_delete_update(struct interface
**ifp
);
283 extern void if_add_update(struct interface
*ifp
);
284 extern void if_up(struct interface
*ifp
, bool install_connected
);
285 extern void if_down(struct interface
*);
286 extern void if_refresh(struct interface
*);
287 extern void if_flags_update(struct interface
*, uint64_t);
288 extern int if_subnet_add(struct interface
*, struct connected
*);
289 extern int if_subnet_delete(struct interface
*, struct connected
*);
290 extern int ipv6_address_configured(struct interface
*ifp
);
291 extern void if_handle_vrf_change(struct interface
*ifp
, vrf_id_t vrf_id
);
292 extern void zebra_if_update_link(struct interface
*ifp
, ifindex_t link_ifindex
,
294 extern void zebra_if_update_all_links(struct zebra_ns
*zns
);
296 * Directly update entire protodown & reason code bitfield.
298 extern int zebra_if_update_protodown_rc(struct interface
*ifp
, bool new_down
,
299 uint32_t new_protodown_rc
);
301 * Set protodown with single reason.
303 extern int zebra_if_set_protodown(struct interface
*ifp
, bool down
,
304 enum protodown_reasons new_reason
);
305 extern int if_ip_address_install(struct interface
*ifp
, struct prefix
*prefix
,
306 const char *label
, struct prefix
*pp
);
307 extern int if_ipv6_address_install(struct interface
*ifp
, struct prefix
*prefix
,
309 extern int if_ip_address_uinstall(struct interface
*ifp
, struct prefix
*prefix
);
310 extern int if_shutdown(struct interface
*ifp
);
311 extern int if_no_shutdown(struct interface
*ifp
);
312 extern int if_multicast_set(struct interface
*ifp
);
313 extern int if_multicast_unset(struct interface
*ifp
);
314 extern int if_linkdetect(struct interface
*ifp
, bool detect
);
315 extern void if_addr_wakeup(struct interface
*ifp
);
317 /* Nexthop group connected functions */
318 extern void if_nhg_dependents_add(struct interface
*ifp
,
319 struct nhg_hash_entry
*nhe
);
320 extern void if_nhg_dependents_del(struct interface
*ifp
,
321 struct nhg_hash_entry
*nhe
);
322 extern unsigned int if_nhg_dependents_count(const struct interface
*ifp
);
323 extern bool if_nhg_dependents_is_empty(const struct interface
*ifp
);
325 extern void vrf_add_update(struct vrf
*vrfp
);
326 extern void zebra_l2_map_slave_to_bond(struct zebra_if
*zif
, vrf_id_t vrf
);
327 extern void zebra_l2_unmap_slave_from_bond(struct zebra_if
*zif
);
328 extern const char *zebra_protodown_rc_str(uint32_t protodown_rc
, char *pd_buf
,
329 uint32_t pd_buf_len
);
330 void zebra_if_dplane_result(struct zebra_dplane_ctx
*ctx
);
332 #ifdef HAVE_PROC_NET_DEV
333 extern void ifstat_update_proc(void);
334 #endif /* HAVE_PROC_NET_DEV */
335 #ifdef HAVE_NET_RT_IFLIST
336 extern void ifstat_update_sysctl(void);
338 #endif /* HAVE_NET_RT_IFLIST */
339 #ifdef HAVE_PROC_NET_DEV
340 extern int interface_list_proc(void);
341 #endif /* HAVE_PROC_NET_DEV */
342 #ifdef HAVE_PROC_NET_IF_INET6
343 extern int ifaddr_proc_ipv6(void);
344 #endif /* HAVE_PROC_NET_IF_INET6 */
350 #endif /* _ZEBRA_INTERFACE_H */