]> git.proxmox.com Git - mirror_frr.git/blame - zebra/interface.h
Merge pull request #4897 from sworleys/zebra_nhg_add
[mirror_frr.git] / zebra / interface.h
CommitLineData
b9368db9 1
718e3744 2/* Interface function header.
3 * Copyright (C) 1999 Kunihiro Ishiguro
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 *
896014f4
DL
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
718e3744 20 */
21
5b73a671 22#ifndef _ZEBRA_INTERFACE_H
23#define _ZEBRA_INTERFACE_H
24
25#include "redistribute.h"
12f6fb97 26#include "vrf.h"
2eb27eec 27#include "hook.h"
ca776988 28
6675513d 29#include "zebra/zebra_l2.h"
5948f013 30#include "zebra/zebra_nhg_private.h"
6675513d 31
51e94aa7
EDP
32#ifdef __cplusplus
33extern "C" {
34#endif
35
718e3744 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
40
41/* For interface shutdown configuration. */
bfac8dcd 42#define IF_ZEBRA_SHUTDOWN_OFF 0
718e3744 43#define IF_ZEBRA_SHUTDOWN_ON 1
718e3744 44
d62a17ae 45#if defined(HAVE_RTADV)
6eb0c5ab 46/* Router advertisement parameter. From RFC4861, RFC6275 and RFC4191. */
d62a17ae 47struct rtadvconf {
48 /* A flag indicating whether or not the router sends periodic Router
49 Advertisements and responds to Router Solicitations.
2951a7a4 50 Default: false */
d62a17ae 51 int AdvSendAdvertisements;
52
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].
57
58 Default: 600000 milliseconds */
59 int MaxRtrAdvInterval;
7cee1bb1 60#define RTADV_MAX_RTR_ADV_INTERVAL 600000
718e3744 61
d62a17ae 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.
718e3744 66
d62a17ae 67 Default: 0.33 * MaxRtrAdvInterval */
68 int MinRtrAdvInterval; /* This field is currently unused. */
718e3744 69#define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)
70
d62a17ae 71 /* Unsolicited Router Advertisements' interval timer. */
72 int AdvIntervalTimer;
718e3744 73
2951a7a4 74 /* The true/false value to be placed in the "Managed address
d62a17ae 75 configuration" flag field in the Router Advertisement. See
76 [ADDRCONF].
718e3744 77
2951a7a4 78 Default: false */
d62a17ae 79 int AdvManagedFlag;
718e3744 80
718e3744 81
2951a7a4 82 /* The true/false value to be placed in the "Other stateful
d62a17ae 83 configuration" flag field in the Router Advertisement. See
84 [ADDRCONF].
718e3744 85
2951a7a4 86 Default: false */
d62a17ae 87 int AdvOtherConfigFlag;
718e3744 88
d62a17ae 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.
718e3744 91
d62a17ae 92 Default: 0 */
93 int AdvLinkMTU;
718e3744 94
718e3744 95
d62a17ae 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).
718e3744 100
d62a17ae 101 Default: 0 */
d7c0a89a 102 uint32_t AdvReachableTime;
d62a17ae 103#define RTADV_MAX_REACHABLE_TIME 3600000
718e3744 104
d62a17ae 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).
718e3744 108
d62a17ae 109 Default: 0 */
110 int AdvRetransTimer;
718e3744 111
d62a17ae 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).
718e3744 116
d62a17ae 117 Default: The value specified in the "Assigned Numbers" RFC
118 [ASSIGNED] that was in effect at the time of implementation. */
119 int AdvCurHopLimit;
718e3744 120
d62a17ae 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
125 default router.
718e3744 126
d62a17ae 127 Default: 3 * MaxRtrAdvInterval */
128 int AdvDefaultLifetime;
d660f698 129#define RTADV_MAX_RTRLIFETIME 9000 /* 2.5 hours */
718e3744 130
d62a17ae 131 /* A list of prefixes to be placed in Prefix Information options in
132 Router Advertisement messages sent from the interface.
718e3744 133
d62a17ae 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;
7cee1bb1 139
2951a7a4 140 /* The true/false value to be placed in the "Home agent"
d62a17ae 141 flag field in the Router Advertisement. See [RFC6275 7.1].
7cee1bb1 142
2951a7a4 143 Default: false */
d62a17ae 144 int AdvHomeAgentFlag;
7cee1bb1 145#ifndef ND_RA_FLAG_HOME_AGENT
146#define ND_RA_FLAG_HOME_AGENT 0x20
147#endif
148
d62a17ae 149 /* The value to be placed in Home Agent Information option if Home
150 Flag is set.
151 Default: 0 */
152 int HomeAgentPreference;
153
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
156 hours.
157 The value 0 has special meaning: use of AdvDefaultLifetime value.
158
159 Default: 0 */
160 int HomeAgentLifetime;
7cee1bb1 161#define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */
162
2951a7a4 163 /* The true/false value to insert or not an Advertisement Interval
d62a17ae 164 option. See [RFC 6275 7.3]
7cee1bb1 165
2951a7a4 166 Default: false */
d62a17ae 167 int AdvIntervalOption;
b60668d0 168
d62a17ae 169 /* The value to be placed in the Default Router Preference field of
170 a router advertisement. See [RFC 4191 2.1 & 2.2]
b60668d0 171
d62a17ae 172 Default: 0 (medium) */
173 int DefaultPreference;
b60668d0 174#define RTADV_PREF_MEDIUM 0x0 /* Per RFC4191. */
6c9678b4 175
3eb4fbb0
LS
176 /*
177 * List of recursive DNS servers to include in the RDNSS option.
178 * See [RFC8106 5.1]
179 *
180 * Default: empty list; do not emit RDNSS option
181 */
182 struct list *AdvRDNSSList;
183
184 /*
185 * List of DNS search domains to include in the DNSSL option.
186 * See [RFC8106 5.2]
187 *
188 * Default: empty list; do not emit DNSSL option
189 */
190 struct list *AdvDNSSLList;
191
d7c0a89a 192 uint8_t inFastRexmit; /* True if we're rexmits faster than usual */
3ea48364
DS
193
194 /* Track if RA was configured by BGP or by the Operator or both */
d7c0a89a 195 uint8_t ra_configured; /* Was RA configured? */
3ea48364
DS
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 */
996c9314
LB
199 int NumFastReXmitsRemain; /* Loaded first with number of fast
200 rexmits to do */
6c9678b4
DD
201
202#define RTADV_FAST_REXMIT_PERIOD 1 /* 1 sec */
203#define RTADV_NUM_FAST_REXMITS 4 /* Fast Rexmit RA 4 times on certain events */
718e3744 204};
205
3eb4fbb0
LS
206struct rtadv_rdnss {
207 /* Address of recursive DNS server to advertise */
208 struct in6_addr addr;
209
210 /*
211 * Lifetime in seconds; all-ones means infinity, zero
212 * stop using it.
213 */
214 uint32_t lifetime;
215
216 /* If lifetime not set, use a default of 3*MaxRtrAdvInterval */
217 int lifetime_set;
218};
219
220/*
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.
223 */
224#define RTADV_MAX_ENCODED_DOMAIN_NAME 255
225
226struct rtadv_dnssl {
227 /* Domain name without trailing root zone dot (NUL-terminated) */
228 char name[RTADV_MAX_ENCODED_DOMAIN_NAME - 1];
229
230 /* Name encoded as in [RFC1035 3.1] */
231 uint8_t encoded_name[RTADV_MAX_ENCODED_DOMAIN_NAME];
232
233 /* Actual length of encoded_name */
234 size_t encoded_len;
235
236 /* Lifetime as for RDNSS */
237 uint32_t lifetime;
238 int lifetime_set;
239};
240
8da4e946 241#endif /* HAVE_RTADV */
718e3744 242
6675513d 243/* Zebra interface type - ones of interest. */
d62a17ae 244typedef enum {
7a38782a
DL
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*/
0e4864ea 251 ZEBRA_IF_VETH, /* VETH interface*/
b9368db9
DD
252 ZEBRA_IF_BOND, /* Bond */
253 ZEBRA_IF_BOND_SLAVE, /* Bond */
6675513d 254} zebra_iftype_t;
255
256/* Zebra "slave" interface type */
d62a17ae 257typedef enum {
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 */
b9368db9 261 ZEBRA_IF_SLAVE_BOND, /* Bond member */
d62a17ae 262 ZEBRA_IF_SLAVE_OTHER, /* Something else - e.g., bond slave */
6675513d 263} zebra_slave_iftype_t;
264
2eb27eec
DL
265struct irdp_interface;
266
718e3744 267/* `zebra' daemon local interface structure. */
d62a17ae 268struct zebra_if {
269 /* Shutdown configuration. */
d7c0a89a 270 uint8_t shutdown;
718e3744 271
d62a17ae 272 /* Multicast configuration. */
d7c0a89a 273 uint8_t multicast;
718e3744 274
d62a17ae 275 /* Router advertise configuration. */
d7c0a89a 276 uint8_t rtadv_enable;
718e3744 277
d62a17ae 278 /* Installed addresses chains tree. */
279 struct route_table *ipv4_subnets;
eef1fe11 280
fe593b78 281 /* Nexthops pointing to this interface */
602fea61
SW
282 /**
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.
287 */
37c6708b 288 struct nhg_connected_tree_head nhg_dependents;
602fea61 289
d62a17ae 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];
55ce4d3a 295
8da4e946 296#if defined(HAVE_RTADV)
d62a17ae 297 struct rtadvconf rtadv;
298 unsigned int ra_sent, ra_rcvd;
8da4e946 299#endif /* HAVE_RTADV */
ca776988 300
2eb27eec 301 struct irdp_interface *irdp;
ca776988 302
8ccc7e80 303#ifdef HAVE_STRUCT_SOCKADDR_DL
d62a17ae 304 union {
305 /* note that sdl_storage is never accessed, it only exists to
306 * make space.
307 * all actual uses refer to sdl - but use sizeof(sdl_storage)!
308 * this fits
309 * best with C aliasing rules. */
310 struct sockaddr_dl sdl;
311 struct sockaddr_storage sdl_storage;
312 };
8ccc7e80
TT
313#endif
314
5c78b3d0 315#ifdef SUNOS_5
d62a17ae 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.
320 */
d7c0a89a 321 uint8_t primary_state;
5c78b3d0 322#endif /* SUNOS_5 */
986aa00f 323
d62a17ae 324 /* ptm enable configuration */
d7c0a89a 325 uint8_t ptm_enable;
6675513d 326
d62a17ae 327 /* Zebra interface and "slave" interface type */
328 zebra_iftype_t zif_type;
329 zebra_slave_iftype_t zif_slave_type;
6675513d 330
d62a17ae 331 /* Additional L2 info, depends on zif_type */
332 union zebra_l2if_info l2info;
6675513d 333
d62a17ae 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.
337 */
338 struct zebra_l2info_brslave brslave_info;
6675513d 339
b9368db9
DD
340 struct zebra_l2info_bondslave bondslave_info;
341
d62a17ae 342 /* Link fields - for sub-interfaces. */
343 ifindex_t link_ifindex;
344 struct interface *link;
dc7b3cae
DS
345
346 struct thread *speed_update;
20089ae2
DS
347
348 /*
349 * Does this interface have a v6 to v4 ll neighbor entry
350 * for bgp unnumbered?
351 */
352 bool v6_2_v4_ll_neigh_entry;
ee98d1f1 353 char neigh_mac[6];
20089ae2 354 struct in6_addr v6_2_v4_ll_addr6;
ba5165ec
DS
355
356 /* The description of the interface */
357 char *desc;
718e3744 358};
359
996c9314
LB
360DECLARE_HOOK(zebra_if_extra_info, (struct vty * vty, struct interface *ifp),
361 (vty, ifp))
362DECLARE_HOOK(zebra_if_config_wr, (struct vty * vty, struct interface *ifp),
363 (vty, ifp))
2eb27eec 364
d62a17ae 365static inline void zebra_if_set_ziftype(struct interface *ifp,
366 zebra_iftype_t zif_type,
367 zebra_slave_iftype_t zif_slave_type)
6675513d 368{
d62a17ae 369 struct zebra_if *zif;
6675513d 370
d62a17ae 371 zif = (struct zebra_if *)ifp->info;
372 zif->zif_type = zif_type;
373 zif->zif_slave_type = zif_slave_type;
6675513d 374}
375
d62a17ae 376#define IS_ZEBRA_IF_VRF(ifp) \
377 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VRF)
378
379#define IS_ZEBRA_IF_BRIDGE(ifp) \
380 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BRIDGE)
381
382#define IS_ZEBRA_IF_VLAN(ifp) \
383 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VLAN)
384
385#define IS_ZEBRA_IF_VXLAN(ifp) \
386 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VXLAN)
387
1a98c087
MK
388#define IS_ZEBRA_IF_MACVLAN(ifp) \
389 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_MACVLAN)
390
0e4864ea
PG
391#define IS_ZEBRA_IF_VETH(ifp) \
392 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VETH)
393
394#define IS_ZEBRA_IF_BRIDGE_SLAVE(ifp) \
d62a17ae 395 (((struct zebra_if *)(ifp->info))->zif_slave_type \
396 == ZEBRA_IF_SLAVE_BRIDGE)
397
398#define IS_ZEBRA_IF_VRF_SLAVE(ifp) \
399 (((struct zebra_if *)(ifp->info))->zif_slave_type == ZEBRA_IF_SLAVE_VRF)
400
b9368db9
DD
401#define IS_ZEBRA_IF_BOND_SLAVE(ifp) \
402 (((struct zebra_if *)(ifp->info))->zif_slave_type \
403 == ZEBRA_IF_SLAVE_BOND)
404
05f7f5db
DS
405extern void zebra_if_init(void);
406
d7c0a89a 407extern struct interface *if_lookup_by_index_per_ns(struct zebra_ns *, uint32_t);
d62a17ae 408extern struct interface *if_lookup_by_name_per_ns(struct zebra_ns *,
409 const char *);
410extern struct interface *if_link_per_ns(struct zebra_ns *, struct interface *);
411extern const char *ifindex2ifname_per_ns(struct zebra_ns *, unsigned int);
412
413extern void if_unlink_per_ns(struct interface *);
ee98d1f1
DS
414extern void if_nbr_mac_to_ipv4ll_neigh_update(struct interface *fip,
415 char mac[6],
416 struct in6_addr *address,
417 int add);
d62a17ae 418extern void if_nbr_ipv6ll_to_ipv4ll_neigh_update(struct interface *ifp,
419 struct in6_addr *address,
420 int add);
421extern void if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(struct interface *ifp);
422extern void if_delete_update(struct interface *ifp);
423extern void if_add_update(struct interface *ifp);
424extern void if_up(struct interface *);
425extern void if_down(struct interface *);
426extern void if_refresh(struct interface *);
427extern void if_flags_update(struct interface *, uint64_t);
428extern int if_subnet_add(struct interface *, struct connected *);
429extern int if_subnet_delete(struct interface *, struct connected *);
430extern int ipv6_address_configured(struct interface *ifp);
431extern void if_handle_vrf_change(struct interface *ifp, vrf_id_t vrf_id);
680c278f
PG
432extern void zebra_if_update_link(struct interface *ifp, ifindex_t link_ifindex,
433 ns_id_t ns_id);
520ebf72 434extern void zebra_if_update_all_links(void);
c3bd894e 435extern void zebra_if_set_protodown(struct interface *ifp, bool down);
d62a17ae 436
fe593b78
SW
437/* Nexthop group connected functions */
438extern void if_nhg_dependents_add(struct interface *ifp,
439 struct nhg_hash_entry *nhe);
440extern void if_nhg_dependents_del(struct interface *ifp,
441 struct nhg_hash_entry *nhe);
442extern unsigned int if_nhg_dependents_count(const struct interface *ifp);
443extern bool if_nhg_dependents_is_empty(const struct interface *ifp);
602fea61 444
d62a17ae 445extern void vrf_add_update(struct vrf *vrfp);
12f6fb97 446
718e3744 447#ifdef HAVE_PROC_NET_DEV
d62a17ae 448extern void ifstat_update_proc(void);
718e3744 449#endif /* HAVE_PROC_NET_DEV */
450#ifdef HAVE_NET_RT_IFLIST
d62a17ae 451extern void ifstat_update_sysctl(void);
718e3744 452
453#endif /* HAVE_NET_RT_IFLIST */
454#ifdef HAVE_PROC_NET_DEV
d62a17ae 455extern int interface_list_proc(void);
718e3744 456#endif /* HAVE_PROC_NET_DEV */
457#ifdef HAVE_PROC_NET_IF_INET6
d62a17ae 458extern int ifaddr_proc_ipv6(void);
718e3744 459#endif /* HAVE_PROC_NET_IF_INET6 */
460
51e94aa7
EDP
461#ifdef __cplusplus
462}
463#endif
464
5b73a671 465#endif /* _ZEBRA_INTERFACE_H */