]> git.proxmox.com Git - mirror_frr.git/blame - zebra/interface.h
zebra: Try to move non zapi cli commands from zserv.c
[mirror_frr.git] / zebra / interface.h
CommitLineData
718e3744 1/* Interface function header.
2 * Copyright (C) 1999 Kunihiro Ishiguro
3 *
4 * This file is part of GNU Zebra.
5 *
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
9 * later version.
10 *
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.
15 *
896014f4
DL
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
718e3744 19 */
20
5b73a671 21#ifndef _ZEBRA_INTERFACE_H
22#define _ZEBRA_INTERFACE_H
23
24#include "redistribute.h"
12f6fb97 25#include "vrf.h"
2eb27eec 26#include "hook.h"
ca776988 27
6675513d 28#include "zebra/zebra_l2.h"
29
718e3744 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
34
35/* For interface shutdown configuration. */
bfac8dcd 36#define IF_ZEBRA_SHUTDOWN_OFF 0
718e3744 37#define IF_ZEBRA_SHUTDOWN_ON 1
718e3744 38
d62a17ae 39#if defined(HAVE_RTADV)
6eb0c5ab 40/* Router advertisement parameter. From RFC4861, RFC6275 and RFC4191. */
d62a17ae 41struct rtadvconf {
42 /* A flag indicating whether or not the router sends periodic Router
43 Advertisements and responds to Router Solicitations.
44 Default: FALSE */
45 int AdvSendAdvertisements;
46
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].
51
52 Default: 600000 milliseconds */
53 int MaxRtrAdvInterval;
7cee1bb1 54#define RTADV_MAX_RTR_ADV_INTERVAL 600000
718e3744 55
d62a17ae 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.
718e3744 60
d62a17ae 61 Default: 0.33 * MaxRtrAdvInterval */
62 int MinRtrAdvInterval; /* This field is currently unused. */
63 /* $FRR indent$ */
64 /* clang-format off */
718e3744 65#define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)
66
d62a17ae 67 /* Unsolicited Router Advertisements' interval timer. */
68 int AdvIntervalTimer;
718e3744 69
d62a17ae 70 /* The TRUE/FALSE value to be placed in the "Managed address
71 configuration" flag field in the Router Advertisement. See
72 [ADDRCONF].
718e3744 73
d62a17ae 74 Default: FALSE */
75 int AdvManagedFlag;
718e3744 76
718e3744 77
d62a17ae 78 /* The TRUE/FALSE value to be placed in the "Other stateful
79 configuration" flag field in the Router Advertisement. See
80 [ADDRCONF].
718e3744 81
d62a17ae 82 Default: FALSE */
83 int AdvOtherConfigFlag;
718e3744 84
d62a17ae 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.
718e3744 87
d62a17ae 88 Default: 0 */
89 int AdvLinkMTU;
718e3744 90
718e3744 91
d62a17ae 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).
718e3744 96
d62a17ae 97 Default: 0 */
98 u_int32_t AdvReachableTime;
99#define RTADV_MAX_REACHABLE_TIME 3600000
718e3744 100
d62a17ae 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).
718e3744 104
d62a17ae 105 Default: 0 */
106 int AdvRetransTimer;
718e3744 107
d62a17ae 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).
718e3744 112
d62a17ae 113 Default: The value specified in the "Assigned Numbers" RFC
114 [ASSIGNED] that was in effect at the time of implementation. */
115 int AdvCurHopLimit;
718e3744 116
d62a17ae 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
121 default router.
718e3744 122
d62a17ae 123 Default: 3 * MaxRtrAdvInterval */
124 int AdvDefaultLifetime;
d660f698 125#define RTADV_MAX_RTRLIFETIME 9000 /* 2.5 hours */
718e3744 126
d62a17ae 127 /* A list of prefixes to be placed in Prefix Information options in
128 Router Advertisement messages sent from the interface.
718e3744 129
d62a17ae 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;
7cee1bb1 135
d62a17ae 136 /* The TRUE/FALSE value to be placed in the "Home agent"
137 flag field in the Router Advertisement. See [RFC6275 7.1].
7cee1bb1 138
d62a17ae 139 Default: FALSE */
140 int AdvHomeAgentFlag;
7cee1bb1 141#ifndef ND_RA_FLAG_HOME_AGENT
142#define ND_RA_FLAG_HOME_AGENT 0x20
143#endif
144
d62a17ae 145 /* The value to be placed in Home Agent Information option if Home
146 Flag is set.
147 Default: 0 */
148 int HomeAgentPreference;
149
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
152 hours.
153 The value 0 has special meaning: use of AdvDefaultLifetime value.
154
155 Default: 0 */
156 int HomeAgentLifetime;
7cee1bb1 157#define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */
158
d62a17ae 159 /* The TRUE/FALSE value to insert or not an Advertisement Interval
160 option. See [RFC 6275 7.3]
7cee1bb1 161
d62a17ae 162 Default: FALSE */
163 int AdvIntervalOption;
b60668d0 164
d62a17ae 165 /* The value to be placed in the Default Router Preference field of
166 a router advertisement. See [RFC 4191 2.1 & 2.2]
b60668d0 167
d62a17ae 168 Default: 0 (medium) */
169 int DefaultPreference;
b60668d0 170#define RTADV_PREF_MEDIUM 0x0 /* Per RFC4191. */
6c9678b4 171
9d303b37 172 u_char inFastRexmit; /* True if we're rexmits faster than usual */
3ea48364
DS
173
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 */
9d303b37
DL
179 int
180 NumFastReXmitsRemain; /* Loaded first with number of fast
181 rexmits to do */
6c9678b4
DD
182
183#define RTADV_FAST_REXMIT_PERIOD 1 /* 1 sec */
184#define RTADV_NUM_FAST_REXMITS 4 /* Fast Rexmit RA 4 times on certain events */
718e3744 185};
186
8da4e946 187#endif /* HAVE_RTADV */
718e3744 188
6675513d 189/* Zebra interface type - ones of interest. */
d62a17ae 190typedef enum {
7a38782a
DL
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*/
6675513d 197} zebra_iftype_t;
198
199/* Zebra "slave" interface type */
d62a17ae 200typedef enum {
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 */
6675513d 205} zebra_slave_iftype_t;
206
2eb27eec
DL
207struct irdp_interface;
208
718e3744 209/* `zebra' daemon local interface structure. */
d62a17ae 210struct zebra_if {
211 /* Shutdown configuration. */
212 u_char shutdown;
718e3744 213
d62a17ae 214 /* Multicast configuration. */
215 u_char multicast;
718e3744 216
d62a17ae 217 /* Router advertise configuration. */
218 u_char rtadv_enable;
718e3744 219
d62a17ae 220 /* Installed addresses chains tree. */
221 struct route_table *ipv4_subnets;
eef1fe11 222
d62a17ae 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];
55ce4d3a 228
8da4e946 229#if defined(HAVE_RTADV)
d62a17ae 230 struct rtadvconf rtadv;
231 unsigned int ra_sent, ra_rcvd;
8da4e946 232#endif /* HAVE_RTADV */
ca776988 233
2eb27eec 234 struct irdp_interface *irdp;
ca776988 235
8ccc7e80 236#ifdef HAVE_STRUCT_SOCKADDR_DL
d62a17ae 237 union {
238 /* note that sdl_storage is never accessed, it only exists to
239 * make space.
240 * all actual uses refer to sdl - but use sizeof(sdl_storage)!
241 * this fits
242 * best with C aliasing rules. */
243 struct sockaddr_dl sdl;
244 struct sockaddr_storage sdl_storage;
245 };
8ccc7e80
TT
246#endif
247
5c78b3d0 248#ifdef SUNOS_5
d62a17ae 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.
253 */
254 u_char primary_state;
5c78b3d0 255#endif /* SUNOS_5 */
986aa00f 256
d62a17ae 257 /* ptm enable configuration */
258 u_char ptm_enable;
6675513d 259
d62a17ae 260 /* Zebra interface and "slave" interface type */
261 zebra_iftype_t zif_type;
262 zebra_slave_iftype_t zif_slave_type;
6675513d 263
d62a17ae 264 /* Additional L2 info, depends on zif_type */
265 union zebra_l2if_info l2info;
6675513d 266
d62a17ae 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.
270 */
271 struct zebra_l2info_brslave brslave_info;
6675513d 272
d62a17ae 273 /* Link fields - for sub-interfaces. */
274 ifindex_t link_ifindex;
275 struct interface *link;
718e3744 276};
277
2eb27eec
DL
278DECLARE_HOOK(zebra_if_extra_info, (struct vty *vty, struct interface *ifp),
279 (vty, ifp))
280DECLARE_HOOK(zebra_if_config_wr, (struct vty *vty, struct interface *ifp),
281 (vty, ifp))
282
d62a17ae 283static inline void zebra_if_set_ziftype(struct interface *ifp,
284 zebra_iftype_t zif_type,
285 zebra_slave_iftype_t zif_slave_type)
6675513d 286{
d62a17ae 287 struct zebra_if *zif;
6675513d 288
d62a17ae 289 zif = (struct zebra_if *)ifp->info;
290 zif->zif_type = zif_type;
291 zif->zif_slave_type = zif_slave_type;
6675513d 292}
293
d62a17ae 294#define IS_ZEBRA_IF_VRF(ifp) \
295 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VRF)
296
297#define IS_ZEBRA_IF_BRIDGE(ifp) \
298 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_BRIDGE)
299
300#define IS_ZEBRA_IF_VLAN(ifp) \
301 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VLAN)
302
303#define IS_ZEBRA_IF_VXLAN(ifp) \
304 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_VXLAN)
305
1a98c087
MK
306#define IS_ZEBRA_IF_MACVLAN(ifp) \
307 (((struct zebra_if *)(ifp->info))->zif_type == ZEBRA_IF_MACVLAN)
308
d62a17ae 309#define IS_ZEBRA_IF_BRIDGE_SLAVE(ifp) \
310 (((struct zebra_if *)(ifp->info))->zif_slave_type \
311 == ZEBRA_IF_SLAVE_BRIDGE)
312
313#define IS_ZEBRA_IF_VRF_SLAVE(ifp) \
314 (((struct zebra_if *)(ifp->info))->zif_slave_type == ZEBRA_IF_SLAVE_VRF)
315
316extern struct interface *if_lookup_by_index_per_ns(struct zebra_ns *,
317 u_int32_t);
318extern struct interface *if_lookup_by_name_per_ns(struct zebra_ns *,
319 const char *);
320extern struct interface *if_link_per_ns(struct zebra_ns *, struct interface *);
321extern const char *ifindex2ifname_per_ns(struct zebra_ns *, unsigned int);
322
323extern void if_unlink_per_ns(struct interface *);
324extern void if_nbr_ipv6ll_to_ipv4ll_neigh_update(struct interface *ifp,
325 struct in6_addr *address,
326 int add);
327extern void if_nbr_ipv6ll_to_ipv4ll_neigh_del_all(struct interface *ifp);
328extern void if_delete_update(struct interface *ifp);
329extern void if_add_update(struct interface *ifp);
330extern void if_up(struct interface *);
331extern void if_down(struct interface *);
332extern void if_refresh(struct interface *);
333extern void if_flags_update(struct interface *, uint64_t);
334extern int if_subnet_add(struct interface *, struct connected *);
335extern int if_subnet_delete(struct interface *, struct connected *);
336extern int ipv6_address_configured(struct interface *ifp);
337extern void if_handle_vrf_change(struct interface *ifp, vrf_id_t vrf_id);
338extern void zebra_if_update_link(struct interface *ifp, ifindex_t link_ifindex);
339
340extern void vrf_add_update(struct vrf *vrfp);
12f6fb97 341
718e3744 342#ifdef HAVE_PROC_NET_DEV
d62a17ae 343extern void ifstat_update_proc(void);
718e3744 344#endif /* HAVE_PROC_NET_DEV */
345#ifdef HAVE_NET_RT_IFLIST
d62a17ae 346extern void ifstat_update_sysctl(void);
718e3744 347
348#endif /* HAVE_NET_RT_IFLIST */
349#ifdef HAVE_PROC_NET_DEV
d62a17ae 350extern int interface_list_proc(void);
718e3744 351#endif /* HAVE_PROC_NET_DEV */
352#ifdef HAVE_PROC_NET_IF_INET6
d62a17ae 353extern int ifaddr_proc_ipv6(void);
718e3744 354#endif /* HAVE_PROC_NET_IF_INET6 */
355
5b73a671 356#endif /* _ZEBRA_INTERFACE_H */