]> git.proxmox.com Git - mirror_frr.git/blob - lib/if.h
Merge pull request #4847 from vivek-cumulus/evpn-route-import-fix
[mirror_frr.git] / lib / if.h
1 /* Interface related header.
2 * Copyright (C) 1997, 98, 99 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
7 * it under the terms of the GNU General Public License as published
8 * by the Free Software Foundation; either version 2, or (at your
9 * option) any 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 *
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
19 */
20
21 #ifndef _ZEBRA_IF_H
22 #define _ZEBRA_IF_H
23
24 #include "zebra.h"
25 #include "linklist.h"
26 #include "memory.h"
27 #include "qobj.h"
28 #include "hook.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 DECLARE_MTYPE(CONNECTED_LABEL)
35
36 /* Interface link-layer type, if known. Derived from:
37 *
38 * net/if_arp.h on various platforms - Linux especially.
39 * http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
40 *
41 * Some of the more obviously defunct technologies left out.
42 */
43 enum zebra_link_type {
44 ZEBRA_LLT_UNKNOWN = 0,
45 ZEBRA_LLT_ETHER,
46 ZEBRA_LLT_EETHER,
47 ZEBRA_LLT_AX25,
48 ZEBRA_LLT_PRONET,
49 ZEBRA_LLT_IEEE802,
50 ZEBRA_LLT_ARCNET,
51 ZEBRA_LLT_APPLETLK,
52 ZEBRA_LLT_DLCI,
53 ZEBRA_LLT_ATM,
54 ZEBRA_LLT_METRICOM,
55 ZEBRA_LLT_IEEE1394,
56 ZEBRA_LLT_EUI64,
57 ZEBRA_LLT_INFINIBAND,
58 ZEBRA_LLT_SLIP,
59 ZEBRA_LLT_CSLIP,
60 ZEBRA_LLT_SLIP6,
61 ZEBRA_LLT_CSLIP6,
62 ZEBRA_LLT_RSRVD,
63 ZEBRA_LLT_ADAPT,
64 ZEBRA_LLT_ROSE,
65 ZEBRA_LLT_X25,
66 ZEBRA_LLT_PPP,
67 ZEBRA_LLT_CHDLC,
68 ZEBRA_LLT_LAPB,
69 ZEBRA_LLT_RAWHDLC,
70 ZEBRA_LLT_IPIP,
71 ZEBRA_LLT_IPIP6,
72 ZEBRA_LLT_FRAD,
73 ZEBRA_LLT_SKIP,
74 ZEBRA_LLT_LOOPBACK,
75 ZEBRA_LLT_LOCALTLK,
76 ZEBRA_LLT_FDDI,
77 ZEBRA_LLT_SIT,
78 ZEBRA_LLT_IPDDP,
79 ZEBRA_LLT_IPGRE,
80 ZEBRA_LLT_IP6GRE,
81 ZEBRA_LLT_PIMREG,
82 ZEBRA_LLT_HIPPI,
83 ZEBRA_LLT_ECONET,
84 ZEBRA_LLT_IRDA,
85 ZEBRA_LLT_FCPP,
86 ZEBRA_LLT_FCAL,
87 ZEBRA_LLT_FCPL,
88 ZEBRA_LLT_FCFABRIC,
89 ZEBRA_LLT_IEEE802_TR,
90 ZEBRA_LLT_IEEE80211,
91 ZEBRA_LLT_IEEE80211_RADIOTAP,
92 ZEBRA_LLT_IEEE802154,
93 ZEBRA_LLT_IEEE802154_PHY,
94 };
95
96 /*
97 Interface name length.
98
99 Linux define value in /usr/include/linux/if.h.
100 #define IFNAMSIZ 16
101
102 FreeBSD define value in /usr/include/net/if.h.
103 #define IFNAMSIZ 16
104 */
105
106 #define INTERFACE_NAMSIZ 20
107 #define INTERFACE_HWADDR_MAX 20
108
109 typedef signed int ifindex_t;
110
111 #ifdef HAVE_PROC_NET_DEV
112 struct if_stats {
113 unsigned long rx_packets; /* total packets received */
114 unsigned long tx_packets; /* total packets transmitted */
115 unsigned long rx_bytes; /* total bytes received */
116 unsigned long tx_bytes; /* total bytes transmitted */
117 unsigned long rx_errors; /* bad packets received */
118 unsigned long tx_errors; /* packet transmit problems */
119 unsigned long rx_dropped; /* no space in linux buffers */
120 unsigned long tx_dropped; /* no space available in linux */
121 unsigned long rx_multicast; /* multicast packets received */
122 unsigned long rx_compressed;
123 unsigned long tx_compressed;
124 unsigned long collisions;
125
126 /* detailed rx_errors: */
127 unsigned long rx_length_errors;
128 unsigned long rx_over_errors; /* receiver ring buff overflow */
129 unsigned long rx_crc_errors; /* recved pkt with crc error */
130 unsigned long rx_frame_errors; /* recv'd frame alignment error */
131 unsigned long rx_fifo_errors; /* recv'r fifo overrun */
132 unsigned long rx_missed_errors; /* receiver missed packet */
133 /* detailed tx_errors */
134 unsigned long tx_aborted_errors;
135 unsigned long tx_carrier_errors;
136 unsigned long tx_fifo_errors;
137 unsigned long tx_heartbeat_errors;
138 unsigned long tx_window_errors;
139 };
140 #endif /* HAVE_PROC_NET_DEV */
141
142 /* Here are "non-official" architectural constants. */
143 #define TE_EXT_MASK 0x0FFFFFFF
144 #define TE_EXT_ANORMAL 0x80000000
145 #define LOSS_PRECISION 0.000003
146 #define TE_KILO_BIT 1000
147 #define TE_BYTE 8
148 #define DEFAULT_BANDWIDTH 10000
149 #define MAX_CLASS_TYPE 8
150 #define MAX_PKT_LOSS 50.331642
151
152 /*
153 * Link Parameters Status:
154 * equal to 0: unset
155 * different from 0: set
156 */
157 #define LP_UNSET 0x0000
158 #define LP_TE_METRIC 0x0001
159 #define LP_MAX_BW 0x0002
160 #define LP_MAX_RSV_BW 0x0004
161 #define LP_UNRSV_BW 0x0008
162 #define LP_ADM_GRP 0x0010
163 #define LP_RMT_AS 0x0020
164 #define LP_DELAY 0x0040
165 #define LP_MM_DELAY 0x0080
166 #define LP_DELAY_VAR 0x0100
167 #define LP_PKT_LOSS 0x0200
168 #define LP_RES_BW 0x0400
169 #define LP_AVA_BW 0x0800
170 #define LP_USE_BW 0x1000
171
172 #define IS_PARAM_UNSET(lp, st) !(lp->lp_status & st)
173 #define IS_PARAM_SET(lp, st) (lp->lp_status & st)
174 #define IS_LINK_PARAMS_SET(lp) (lp->lp_status != LP_UNSET)
175
176 #define SET_PARAM(lp, st) (lp->lp_status) |= (st)
177 #define UNSET_PARAM(lp, st) (lp->lp_status) &= ~(st)
178 #define RESET_LINK_PARAM(lp) (lp->lp_status = LP_UNSET)
179
180 /* Link Parameters for Traffic Engineering */
181 struct if_link_params {
182 uint32_t lp_status; /* Status of Link Parameters: */
183 uint32_t te_metric; /* Traffic Engineering metric */
184 float default_bw;
185 float max_bw; /* Maximum Bandwidth */
186 float max_rsv_bw; /* Maximum Reservable Bandwidth */
187 float unrsv_bw[MAX_CLASS_TYPE]; /* Unreserved Bandwidth per Class Type
188 (8) */
189 uint32_t admin_grp; /* Administrative group */
190 uint32_t rmt_as; /* Remote AS number */
191 struct in_addr rmt_ip; /* Remote IP address */
192 uint32_t av_delay; /* Link Average Delay */
193 uint32_t min_delay; /* Link Min Delay */
194 uint32_t max_delay; /* Link Max Delay */
195 uint32_t delay_var; /* Link Delay Variation */
196 float pkt_loss; /* Link Packet Loss */
197 float res_bw; /* Residual Bandwidth */
198 float ava_bw; /* Available Bandwidth */
199 float use_bw; /* Utilized Bandwidth */
200 };
201
202 #define INTERFACE_LINK_PARAMS_SIZE sizeof(struct if_link_params)
203 #define HAS_LINK_PARAMS(ifp) ((ifp)->link_params != NULL)
204
205 /* Interface structure */
206 struct interface {
207 RB_ENTRY(interface) name_entry, index_entry;
208
209 /* Interface name. This should probably never be changed after the
210 interface is created, because the configuration info for this
211 interface
212 is associated with this structure. For that reason, the interface
213 should also never be deleted (to avoid losing configuration info).
214 To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
215 interface does not exist in the kernel.
216 */
217 char name[INTERFACE_NAMSIZ];
218
219 /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
220 deleted interfaces).
221 WARNING: the ifindex needs to be changed using the if_set_index()
222 function. Failure to respect this will cause corruption in the data
223 structure used to store the interfaces and if_lookup_by_index() will
224 not work as expected.
225 */
226 ifindex_t ifindex;
227 /*
228 * ifindex of parent interface, if any
229 */
230 ifindex_t link_ifindex;
231 #define IFINDEX_INTERNAL 0
232
233 /* Zebra internal interface status */
234 uint8_t status;
235 #define ZEBRA_INTERFACE_ACTIVE (1 << 0)
236 #define ZEBRA_INTERFACE_SUB (1 << 1)
237 #define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
238 #define ZEBRA_INTERFACE_VRF_LOOPBACK (1 << 3)
239
240 /* Interface flags. */
241 uint64_t flags;
242
243 /* Interface metric */
244 uint32_t metric;
245
246 /* Interface Speed in Mb/s */
247 uint32_t speed;
248
249 /* Interface MTU. */
250 unsigned int mtu; /* IPv4 MTU */
251 unsigned int
252 mtu6; /* IPv6 MTU - probably, but not neccessarily same as mtu
253 */
254
255 /* Link-layer information and hardware address */
256 enum zebra_link_type ll_type;
257 uint8_t hw_addr[INTERFACE_HWADDR_MAX];
258 int hw_addr_len;
259
260 /* interface bandwidth, kbits */
261 unsigned int bandwidth;
262
263 /* Link parameters for Traffic Engineering */
264 struct if_link_params *link_params;
265
266 /* description of the interface. */
267 char *desc;
268
269 /* Distribute list. */
270 void *distribute_in;
271 void *distribute_out;
272
273 /* Connected address list. */
274 struct list *connected;
275
276 /* Neighbor connected address list. */
277 struct list *nbr_connected;
278
279 /* Daemon specific interface data pointer. */
280 void *info;
281
282 char ptm_enable; /* Should we look at ptm_status ? */
283 char ptm_status;
284
285 /* Statistics fileds. */
286 #ifdef HAVE_PROC_NET_DEV
287 struct if_stats stats;
288 #endif /* HAVE_PROC_NET_DEV */
289 #ifdef HAVE_NET_RT_IFLIST
290 struct if_data stats;
291 #endif /* HAVE_NET_RT_IFLIST */
292
293 struct route_node *node;
294 vrf_id_t vrf_id;
295
296 QOBJ_FIELDS
297 };
298
299 RB_HEAD(if_name_head, interface);
300 RB_PROTOTYPE(if_name_head, interface, name_entry, if_cmp_func)
301 RB_HEAD(if_index_head, interface);
302 RB_PROTOTYPE(if_index_head, interface, index_entry, if_cmp_func)
303 DECLARE_QOBJ_TYPE(interface)
304
305 #define IFNAME_RB_INSERT(vrf, ifp) \
306 if (RB_INSERT(if_name_head, &vrf->ifaces_by_name, (ifp))) \
307 flog_err(EC_LIB_INTERFACE, \
308 "%s(%s): corruption detected -- interface with this " \
309 "name exists already in VRF %u!", \
310 __func__, (ifp)->name, (ifp)->vrf_id);
311
312 #define IFNAME_RB_REMOVE(vrf, ifp) \
313 if (RB_REMOVE(if_name_head, &vrf->ifaces_by_name, (ifp)) == NULL) \
314 flog_err(EC_LIB_INTERFACE, \
315 "%s(%s): corruption detected -- interface with this " \
316 "name doesn't exist in VRF %u!", \
317 __func__, (ifp)->name, (ifp)->vrf_id);
318
319 #define IFINDEX_RB_INSERT(vrf, ifp) \
320 if (RB_INSERT(if_index_head, &vrf->ifaces_by_index, (ifp))) \
321 flog_err(EC_LIB_INTERFACE, \
322 "%s(%u): corruption detected -- interface with this " \
323 "ifindex exists already in VRF %u!", \
324 __func__, (ifp)->ifindex, (ifp)->vrf_id);
325
326 #define IFINDEX_RB_REMOVE(vrf, ifp) \
327 if (RB_REMOVE(if_index_head, &vrf->ifaces_by_index, (ifp)) == NULL) \
328 flog_err(EC_LIB_INTERFACE, \
329 "%s(%u): corruption detected -- interface with this " \
330 "ifindex doesn't exist in VRF %u!", \
331 __func__, (ifp)->ifindex, (ifp)->vrf_id);
332
333 #define FOR_ALL_INTERFACES(vrf, ifp) \
334 if (vrf) \
335 RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name)
336
337 #define FOR_ALL_INTERFACES_ADDRESSES(ifp, connected, node) \
338 for (ALL_LIST_ELEMENTS_RO(ifp->connected, node, connected))
339
340 /* called from the library code whenever interfaces are created/deleted
341 * note: interfaces may not be fully realized at that point; also they
342 * may not exist in the system (ifindex = IFINDEX_INTERNAL)
343 *
344 * priority values are important here, daemons should be at 0 while modules
345 * can use 1000+ so they run after the daemon has initialised daemon-specific
346 * interface data
347 */
348 DECLARE_HOOK(if_add, (struct interface * ifp), (ifp))
349 DECLARE_KOOH(if_del, (struct interface * ifp), (ifp))
350
351 #define METRIC_MAX (~0)
352
353 /* Connected address structure. */
354 struct connected {
355 /* Attached interface. */
356 struct interface *ifp;
357
358 /* Flags for configuration. */
359 uint8_t conf;
360 #define ZEBRA_IFC_REAL (1 << 0)
361 #define ZEBRA_IFC_CONFIGURED (1 << 1)
362 #define ZEBRA_IFC_QUEUED (1 << 2)
363 /*
364 The ZEBRA_IFC_REAL flag should be set if and only if this address
365 exists in the kernel and is actually usable. (A case where it exists
366 but
367 is not yet usable would be IPv6 with DAD)
368 The ZEBRA_IFC_CONFIGURED flag should be set if and only if this
369 address
370 was configured by the user from inside quagga.
371 The ZEBRA_IFC_QUEUED flag should be set if and only if the address
372 exists
373 in the kernel. It may and should be set although the address might
374 not be
375 usable yet. (compare with ZEBRA_IFC_REAL)
376 */
377
378 /* Flags for connected address. */
379 uint8_t flags;
380 #define ZEBRA_IFA_SECONDARY (1 << 0)
381 #define ZEBRA_IFA_PEER (1 << 1)
382 #define ZEBRA_IFA_UNNUMBERED (1 << 2)
383 /* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
384 a peer address has been configured. If this flag is set,
385 the destination field must contain the peer address.
386 */
387
388 /* Address of connected network. */
389 struct prefix *address;
390
391 /* Peer address, if ZEBRA_IFA_PEER is set, otherwise NULL */
392 struct prefix *destination;
393
394 /* Label for Linux 2.2.X and upper. */
395 char *label;
396
397 /*
398 * Used for setting the connected route's cost. If the metric
399 * here is set to METRIC_MAX the connected route falls back to
400 * "struct interface"
401 */
402 uint32_t metric;
403 };
404
405 /* Nbr Connected address structure. */
406 struct nbr_connected {
407 /* Attached interface. */
408 struct interface *ifp;
409
410 /* Address of connected network. */
411 struct prefix *address;
412 };
413
414 /* Does the destination field contain a peer address? */
415 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
416
417 /* Prefix to insert into the RIB */
418 #define CONNECTED_PREFIX(C) \
419 (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
420
421 /* Identifying address. We guess that if there's a peer address, but the
422 local address is in the same prefix, then the local address may be unique. */
423 #define CONNECTED_ID(C) \
424 ((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address)) \
425 ? (C)->destination \
426 : (C)->address)
427
428 /* There are some interface flags which are only supported by some
429 operating system. */
430
431 #ifndef IFF_NOTRAILERS
432 #define IFF_NOTRAILERS 0x0
433 #endif /* IFF_NOTRAILERS */
434 #ifndef IFF_OACTIVE
435 #define IFF_OACTIVE 0x0
436 #endif /* IFF_OACTIVE */
437 #ifndef IFF_SIMPLEX
438 #define IFF_SIMPLEX 0x0
439 #endif /* IFF_SIMPLEX */
440 #ifndef IFF_LINK0
441 #define IFF_LINK0 0x0
442 #endif /* IFF_LINK0 */
443 #ifndef IFF_LINK1
444 #define IFF_LINK1 0x0
445 #endif /* IFF_LINK1 */
446 #ifndef IFF_LINK2
447 #define IFF_LINK2 0x0
448 #endif /* IFF_LINK2 */
449 #ifndef IFF_NOXMIT
450 #define IFF_NOXMIT 0x0
451 #endif /* IFF_NOXMIT */
452 #ifndef IFF_NORTEXCH
453 #define IFF_NORTEXCH 0x0
454 #endif /* IFF_NORTEXCH */
455 #ifndef IFF_IPV4
456 #define IFF_IPV4 0x0
457 #endif /* IFF_IPV4 */
458 #ifndef IFF_IPV6
459 #define IFF_IPV6 0x0
460 #endif /* IFF_IPV6 */
461 #ifndef IFF_VIRTUAL
462 #define IFF_VIRTUAL 0x0
463 #endif /* IFF_VIRTUAL */
464
465 /* Prototypes. */
466 extern int if_cmp_name_func(const char *p1, const char *p2);
467
468 /*
469 * Passing in VRF_UNKNOWN is a valid thing to do, unless we
470 * are creating a new interface.
471 *
472 * This is useful for vrf route-leaking. So more than anything
473 * else think before you use VRF_UNKNOWN
474 */
475 extern void if_update_to_new_vrf(struct interface *, vrf_id_t vrf_id);
476 extern struct interface *if_create(const char *name, vrf_id_t vrf_id);
477 extern struct interface *if_create_ifindex(ifindex_t ifindex, vrf_id_t vrf_id);
478 extern struct interface *if_lookup_by_index(ifindex_t, vrf_id_t vrf_id);
479 extern struct interface *if_lookup_by_index_all_vrf(ifindex_t);
480 extern struct interface *if_lookup_exact_address(void *matchaddr, int family,
481 vrf_id_t vrf_id);
482 extern struct connected *if_lookup_address(void *matchaddr, int family,
483 vrf_id_t vrf_id);
484 extern struct interface *if_lookup_prefix(struct prefix *prefix,
485 vrf_id_t vrf_id);
486 size_t if_lookup_by_hwaddr(const uint8_t *hw_addr, size_t addrsz,
487 struct interface ***result, vrf_id_t vrf_id);
488
489 /* These 3 functions are to be used when the ifname argument is terminated
490 by a '\0' character: */
491 extern struct interface *if_lookup_by_name_all_vrf(const char *ifname);
492 extern struct interface *if_lookup_by_name(const char *ifname, vrf_id_t vrf_id);
493 extern struct interface *if_get_by_name(const char *ifname, vrf_id_t vrf_id);
494 extern struct interface *if_get_by_ifindex(ifindex_t ifindex, vrf_id_t vrf_id);
495 extern void if_set_index(struct interface *ifp, ifindex_t ifindex);
496
497 /* Delete the interface, but do not free the structure, and leave it in the
498 interface list. It is often advisable to leave the pseudo interface
499 structure because there may be configuration information attached. */
500 extern void if_delete_retain(struct interface *);
501
502 /* Delete and free the interface structure: calls if_delete_retain and then
503 deletes it from the interface list and frees the structure. */
504 extern void if_delete(struct interface *);
505
506 extern int if_is_up(const struct interface *ifp);
507 extern int if_is_running(const struct interface *ifp);
508 extern int if_is_operative(const struct interface *ifp);
509 extern int if_is_no_ptm_operative(const struct interface *ifp);
510 extern int if_is_loopback(const struct interface *ifp);
511 extern int if_is_vrf(const struct interface *ifp);
512 extern bool if_is_loopback_or_vrf(const struct interface *ifp);
513 extern int if_is_broadcast(const struct interface *ifp);
514 extern int if_is_pointopoint(const struct interface *ifp);
515 extern int if_is_multicast(const struct interface *ifp);
516 struct vrf;
517 extern void if_terminate(struct vrf *vrf);
518 extern void if_dump_all(void);
519 extern const char *if_flag_dump(unsigned long);
520 extern const char *if_link_type_str(enum zebra_link_type);
521
522 /* Please use ifindex2ifname instead of if_indextoname where possible;
523 ifindex2ifname uses internal interface info, whereas if_indextoname must
524 make a system call. */
525 extern const char *ifindex2ifname(ifindex_t, vrf_id_t vrf_id);
526
527 /* Please use ifname2ifindex instead of if_nametoindex where possible;
528 ifname2ifindex uses internal interface info, whereas if_nametoindex must
529 make a system call. */
530 extern ifindex_t ifname2ifindex(const char *ifname, vrf_id_t vrf_id);
531
532 /* Connected address functions. */
533 extern struct connected *connected_new(void);
534 extern void connected_free(struct connected *);
535 extern void connected_add(struct interface *, struct connected *);
536 extern struct connected *
537 connected_add_by_prefix(struct interface *, struct prefix *, struct prefix *);
538 extern struct connected *connected_delete_by_prefix(struct interface *,
539 struct prefix *);
540 extern struct connected *connected_lookup_prefix(struct interface *,
541 struct prefix *);
542 extern struct connected *connected_lookup_prefix_exact(struct interface *,
543 struct prefix *);
544 extern struct nbr_connected *nbr_connected_new(void);
545 extern void nbr_connected_free(struct nbr_connected *);
546 struct nbr_connected *nbr_connected_check(struct interface *, struct prefix *);
547 struct connected *connected_get_linklocal(struct interface *ifp);
548
549 /* link parameters */
550 struct if_link_params *if_link_params_get(struct interface *);
551 void if_link_params_free(struct interface *);
552
553 /* Northbound. */
554 extern void if_cmd_init(void);
555 extern const struct frr_yang_module_info frr_interface_info;
556
557 #ifdef __cplusplus
558 }
559 #endif
560
561 #endif /* _ZEBRA_IF_H */