1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Interface related header.
3 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
14 #include "admin_group.h"
20 DECLARE_MTYPE(CONNECTED_LABEL
);
22 /* Interface link-layer type, if known. Derived from:
24 * net/if_arp.h on various platforms - Linux especially.
25 * http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
27 * Some of the more obviously defunct technologies left out.
29 enum zebra_link_type
{
30 ZEBRA_LLT_UNKNOWN
= 0,
77 ZEBRA_LLT_IEEE80211_RADIOTAP
,
79 ZEBRA_LLT_IEEE802154_PHY
,
83 Interface name length.
85 Linux define value in /usr/include/linux/if.h.
88 FreeBSD define value in /usr/include/net/if.h.
92 #define INTERFACE_NAMSIZ IFNAMSIZ
93 #define INTERFACE_HWADDR_MAX 20
95 typedef signed int ifindex_t
;
97 #ifdef HAVE_PROC_NET_DEV
99 unsigned long rx_packets
; /* total packets received */
100 unsigned long tx_packets
; /* total packets transmitted */
101 unsigned long rx_bytes
; /* total bytes received */
102 unsigned long tx_bytes
; /* total bytes transmitted */
103 unsigned long rx_errors
; /* bad packets received */
104 unsigned long tx_errors
; /* packet transmit problems */
105 unsigned long rx_dropped
; /* no space in linux buffers */
106 unsigned long tx_dropped
; /* no space available in linux */
107 unsigned long rx_multicast
; /* multicast packets received */
108 unsigned long rx_compressed
;
109 unsigned long tx_compressed
;
110 unsigned long collisions
;
112 /* detailed rx_errors: */
113 unsigned long rx_length_errors
;
114 unsigned long rx_over_errors
; /* receiver ring buff overflow */
115 unsigned long rx_crc_errors
; /* recved pkt with crc error */
116 unsigned long rx_frame_errors
; /* recv'd frame alignment error */
117 unsigned long rx_fifo_errors
; /* recv'r fifo overrun */
118 unsigned long rx_missed_errors
; /* receiver missed packet */
119 /* detailed tx_errors */
120 unsigned long tx_aborted_errors
;
121 unsigned long tx_carrier_errors
;
122 unsigned long tx_fifo_errors
;
123 unsigned long tx_heartbeat_errors
;
124 unsigned long tx_window_errors
;
126 #endif /* HAVE_PROC_NET_DEV */
128 /* Here are "non-official" architectural constants. */
129 #define TE_EXT_MASK 0x00FFFFFF
130 #define TE_EXT_ANORMAL 0x80000000
131 #define LOSS_PRECISION 0.000003
132 /* TE_MEGA_BIT and TE_BYTE are utilized to convert TE bandwidth */
133 #define TE_MEGA_BIT 1000000
135 /* Default TE bandwidth when no value in config.
136 * The value is in Mbps (will be multiplied by TE_BYTE)
138 #define DEFAULT_BANDWIDTH 10
139 #define MAX_CLASS_TYPE 8
140 #define MAX_PKT_LOSS 50.331642
143 /* RFC7308 Extended Administrative group */
144 AFFINITY_MODE_EXTENDED
= 0,
145 /* RFC3630/RFC5305/RFC5329 Administrative group */
146 AFFINITY_MODE_STANDARD
= 1,
147 /* Standard and Extended Administrative group */
148 AFFINITY_MODE_BOTH
= 2,
152 * Link Parameters Status:
154 * different from 0: set
156 #define LP_UNSET 0x0000
157 #define LP_TE_METRIC 0x0001
158 #define LP_MAX_BW 0x0002
159 #define LP_MAX_RSV_BW 0x0004
160 #define LP_UNRSV_BW 0x0008
161 #define LP_ADM_GRP 0x0010
162 #define LP_RMT_AS 0x0020
163 #define LP_DELAY 0x0040
164 #define LP_MM_DELAY 0x0080
165 #define LP_DELAY_VAR 0x0100
166 #define LP_PKT_LOSS 0x0200
167 #define LP_RES_BW 0x0400
168 #define LP_AVA_BW 0x0800
169 #define LP_USE_BW 0x1000
170 #define LP_EXTEND_ADM_GRP 0x2000
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)
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)
180 /* Link Parameters for Traffic Engineering
181 * Do not forget to update if_link_params_copy()
182 * and if_link_params_cmp() when updating the structure
184 struct if_link_params
{
185 uint32_t lp_status
; /* Status of Link Parameters: */
186 uint32_t te_metric
; /* Traffic Engineering metric */
188 float max_bw
; /* Maximum Bandwidth */
189 float max_rsv_bw
; /* Maximum Reservable Bandwidth */
190 float unrsv_bw
[MAX_CLASS_TYPE
]; /* Unreserved Bandwidth per Class Type
192 uint32_t admin_grp
; /* RFC5305/RFC5329 Administrative group */
193 struct admin_group ext_admin_grp
; /* RFC7308 Extended Admin group */
194 uint32_t rmt_as
; /* Remote AS number */
195 struct in_addr rmt_ip
; /* Remote IP address */
196 uint32_t av_delay
; /* Link Average Delay */
197 uint32_t min_delay
; /* Link Min Delay */
198 uint32_t max_delay
; /* Link Max Delay */
199 uint32_t delay_var
; /* Link Delay Variation */
200 float pkt_loss
; /* Link Packet Loss */
201 float res_bw
; /* Residual Bandwidth */
202 float ava_bw
; /* Available Bandwidth */
203 float use_bw
; /* Utilized Bandwidth */
206 #define INTERFACE_LINK_PARAMS_SIZE sizeof(struct if_link_params)
207 #define HAS_LINK_PARAMS(ifp) ((ifp)->link_params != NULL)
209 /* Interface structure */
211 RB_ENTRY(interface
) name_entry
, index_entry
;
213 /* Interface name. This should probably never be changed after the
214 interface is created, because the configuration info for this
216 is associated with this structure. For that reason, the interface
217 should also never be deleted (to avoid losing configuration info).
218 To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
219 interface does not exist in the kernel.
221 char name
[INTERFACE_NAMSIZ
];
223 /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
225 WARNING: the ifindex needs to be changed using the if_set_index()
226 function. Failure to respect this will cause corruption in the data
227 structure used to store the interfaces and if_lookup_by_index() will
228 not work as expected.
231 ifindex_t oldifindex
;
234 * ifindex of parent interface, if any
236 ifindex_t link_ifindex
;
237 #define IFINDEX_INTERNAL 0
239 /* Zebra internal interface status */
241 #define ZEBRA_INTERFACE_ACTIVE (1 << 0)
242 #define ZEBRA_INTERFACE_SUB (1 << 1)
243 #define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
244 #define ZEBRA_INTERFACE_VRF_LOOPBACK (1 << 3)
246 /* Interface flags. */
249 /* Interface metric */
252 /* Interface Speed in Mb/s */
256 unsigned int mtu
; /* IPv4 MTU */
258 mtu6
; /* IPv6 MTU - probably, but not necessarily same as mtu
261 /* Link-layer information and hardware address */
262 enum zebra_link_type ll_type
;
263 uint8_t hw_addr
[INTERFACE_HWADDR_MAX
];
266 /* interface bandwidth, kbits */
267 unsigned int bandwidth
;
269 /* Link parameters for Traffic Engineering */
270 struct if_link_params
*link_params
;
272 /* description of the interface. */
275 /* Distribute list. */
277 void *distribute_out
;
279 /* Connected address list. */
280 struct list
*connected
;
282 /* Neighbor connected address list. */
283 struct list
*nbr_connected
;
285 /* Daemon specific interface data pointer. */
288 char ptm_enable
; /* Should we look at ptm_status ? */
291 /* Statistics fileds. */
292 #ifdef HAVE_PROC_NET_DEV
293 struct if_stats stats
;
294 #endif /* HAVE_PROC_NET_DEV */
295 #ifdef HAVE_NET_RT_IFLIST
296 struct if_data stats
;
297 #endif /* HAVE_NET_RT_IFLIST */
299 struct route_node
*node
;
304 * Has the end users entered `interface XXXX` from the cli in some
312 RB_HEAD(if_name_head
, interface
);
313 RB_PROTOTYPE(if_name_head
, interface
, name_entry
, if_cmp_func
)
314 RB_HEAD(if_index_head
, interface
);
315 RB_PROTOTYPE(if_index_head
, interface
, index_entry
, if_cmp_index_func
)
316 DECLARE_QOBJ_TYPE(interface
);
318 #define IFNAME_RB_INSERT(v, ifp) \
320 struct interface *_iz = \
321 RB_INSERT(if_name_head, &v->ifaces_by_name, (ifp)); \
325 "%s(%s): corruption detected -- interface with this " \
326 "name exists already in VRF %s!", \
327 __func__, (ifp)->name, (ifp)->vrf->name); \
331 #define IFNAME_RB_REMOVE(v, ifp) \
333 struct interface *_iz = \
334 RB_REMOVE(if_name_head, &v->ifaces_by_name, (ifp)); \
338 "%s(%s): corruption detected -- interface with this " \
339 "name doesn't exist in VRF %s!", \
340 __func__, (ifp)->name, (ifp)->vrf->name); \
345 #define IFINDEX_RB_INSERT(v, ifp) \
347 struct interface *_iz = \
348 RB_INSERT(if_index_head, &v->ifaces_by_index, (ifp)); \
352 "%s(%u): corruption detected -- interface with this " \
353 "ifindex exists already in VRF %s!", \
354 __func__, (ifp)->ifindex, (ifp)->vrf->name); \
358 #define IFINDEX_RB_REMOVE(v, ifp) \
360 struct interface *_iz = \
361 RB_REMOVE(if_index_head, &v->ifaces_by_index, (ifp)); \
365 "%s(%u): corruption detected -- interface with this " \
366 "ifindex doesn't exist in VRF %s!", \
367 __func__, (ifp)->ifindex, (ifp)->vrf->name); \
371 #define FOR_ALL_INTERFACES(vrf, ifp) \
373 RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name)
375 #define FOR_ALL_INTERFACES_ADDRESSES(ifp, connected, node) \
376 for (ALL_LIST_ELEMENTS_RO(ifp->connected, node, connected))
378 /* called from the library code whenever interfaces are created/deleted
379 * note: interfaces may not be fully realized at that point; also they
380 * may not exist in the system (ifindex = IFINDEX_INTERNAL)
382 * priority values are important here, daemons should be at 0 while modules
383 * can use 1000+ so they run after the daemon has initialised daemon-specific
386 DECLARE_HOOK(if_add
, (struct interface
* ifp
), (ifp
));
387 DECLARE_KOOH(if_del
, (struct interface
* ifp
), (ifp
));
389 #define METRIC_MAX (~0)
391 /* Connected address structure. */
393 /* Attached interface. */
394 struct interface
*ifp
;
396 /* Flags for configuration. */
398 #define ZEBRA_IFC_REAL (1 << 0)
399 #define ZEBRA_IFC_CONFIGURED (1 << 1)
400 #define ZEBRA_IFC_QUEUED (1 << 2)
401 #define ZEBRA_IFC_DOWN (1 << 3)
403 The ZEBRA_IFC_REAL flag should be set if and only if this address
404 exists in the kernel and is actually usable. (A case where it exists
405 but is not yet usable would be IPv6 with DAD)
406 The ZEBRA_IFC_CONFIGURED flag should be set if and only if this
407 address was configured by the user from inside frr.
408 The ZEBRA_IFC_QUEUED flag should be set if and only if the address
409 exists in the kernel. It may and should be set although the
410 address might not be usable yet. (compare with ZEBRA_IFC_REAL)
411 The ZEBRA_IFC_DOWN flag is used to record that an address is
412 present, but down/unavailable.
415 /* Flags for connected address. */
417 #define ZEBRA_IFA_SECONDARY (1 << 0)
418 #define ZEBRA_IFA_PEER (1 << 1)
419 #define ZEBRA_IFA_UNNUMBERED (1 << 2)
420 /* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
421 a peer address has been configured. If this flag is set,
422 the destination field must contain the peer address.
425 /* Address of connected network. */
426 struct prefix
*address
;
428 /* Peer address, if ZEBRA_IFA_PEER is set, otherwise NULL */
429 struct prefix
*destination
;
431 /* Label for Linux 2.2.X and upper. */
435 * Used for setting the connected route's cost. If the metric
436 * here is set to METRIC_MAX the connected route falls back to
442 /* Nbr Connected address structure. */
443 struct nbr_connected
{
444 /* Attached interface. */
445 struct interface
*ifp
;
447 /* Address of connected network. */
448 struct prefix
*address
;
451 /* Does the destination field contain a peer address? */
452 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
454 /* Prefix to insert into the RIB */
455 #define CONNECTED_PREFIX(C) \
456 (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
458 /* Identifying address. We guess that if there's a peer address, but the
459 local address is in the same prefix, then the local address may be unique. */
460 #define CONNECTED_ID(C) \
461 ((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address)) \
465 /* There are some interface flags which are only supported by some
468 #ifndef IFF_NOTRAILERS
469 #define IFF_NOTRAILERS 0x0
470 #endif /* IFF_NOTRAILERS */
472 #define IFF_OACTIVE 0x0
473 #endif /* IFF_OACTIVE */
475 #define IFF_SIMPLEX 0x0
476 #endif /* IFF_SIMPLEX */
478 #define IFF_LINK0 0x0
479 #endif /* IFF_LINK0 */
481 #define IFF_LINK1 0x0
482 #endif /* IFF_LINK1 */
484 #define IFF_LINK2 0x0
485 #endif /* IFF_LINK2 */
487 #define IFF_NOXMIT 0x0
488 #endif /* IFF_NOXMIT */
490 #define IFF_NORTEXCH 0x0
491 #endif /* IFF_NORTEXCH */
494 #endif /* IFF_IPV4 */
497 #endif /* IFF_IPV6 */
499 #define IFF_VIRTUAL 0x0
500 #endif /* IFF_VIRTUAL */
503 extern int if_cmp_name_func(const char *p1
, const char *p2
);
506 * Passing in VRF_UNKNOWN is a valid thing to do, unless we
507 * are creating a new interface.
509 * This is useful for vrf route-leaking. So more than anything
510 * else think before you use VRF_UNKNOWN
512 extern void if_update_to_new_vrf(struct interface
*, vrf_id_t vrf_id
);
514 extern struct interface
*if_lookup_by_index(ifindex_t
, vrf_id_t vrf_id
);
515 extern struct interface
*if_vrf_lookup_by_index_next(ifindex_t ifindex
,
517 extern struct interface
*if_lookup_address_local(const void *matchaddr
,
518 int family
, vrf_id_t vrf_id
);
519 extern struct connected
*if_lookup_address(const void *matchaddr
, int family
,
521 extern struct interface
*if_lookup_prefix(const struct prefix
*prefix
,
523 size_t if_lookup_by_hwaddr(const uint8_t *hw_addr
, size_t addrsz
,
524 struct interface
***result
, vrf_id_t vrf_id
);
526 static inline bool if_address_is_local(const void *matchaddr
, int family
,
529 return if_lookup_address_local(matchaddr
, family
, vrf_id
) != NULL
;
533 extern struct interface
*if_lookup_by_name_vrf(const char *name
, struct vrf
*vrf
);
534 extern struct interface
*if_lookup_by_name(const char *ifname
, vrf_id_t vrf_id
);
535 extern struct interface
*if_get_vrf_loopback(vrf_id_t vrf_id
);
536 extern struct interface
*if_get_by_name(const char *ifname
, vrf_id_t vrf_id
,
537 const char *vrf_name
);
539 /* Sets the index and adds to index list */
540 extern int if_set_index(struct interface
*ifp
, ifindex_t ifindex
);
542 /* Delete the interface, but do not free the structure, and leave it in the
543 interface list. It is often advisable to leave the pseudo interface
544 structure because there may be configuration information attached. */
545 extern void if_delete_retain(struct interface
*);
547 /* Delete and free the interface structure: calls if_delete_retain and then
548 deletes it from the interface list and frees the structure. */
549 extern void if_delete(struct interface
**ifp
);
551 extern int if_is_up(const struct interface
*ifp
);
552 extern int if_is_running(const struct interface
*ifp
);
553 extern int if_is_operative(const struct interface
*ifp
);
554 extern int if_is_no_ptm_operative(const struct interface
*ifp
);
555 extern int if_is_loopback_exact(const struct interface
*ifp
);
556 extern int if_is_vrf(const struct interface
*ifp
);
557 extern bool if_is_loopback(const struct interface
*ifp
);
558 extern int if_is_broadcast(const struct interface
*ifp
);
559 extern int if_is_pointopoint(const struct interface
*ifp
);
560 extern int if_is_multicast(const struct interface
*ifp
);
561 extern void if_terminate(struct vrf
*vrf
);
562 extern void if_dump_all(void);
563 extern const char *if_flag_dump(unsigned long);
564 extern const char *if_link_type_str(enum zebra_link_type
);
566 /* Please use ifindex2ifname instead of if_indextoname where possible;
567 ifindex2ifname uses internal interface info, whereas if_indextoname must
568 make a system call. */
569 extern const char *ifindex2ifname(ifindex_t
, vrf_id_t vrf_id
);
571 /* Please use ifname2ifindex instead of if_nametoindex where possible;
572 ifname2ifindex uses internal interface info, whereas if_nametoindex must
573 make a system call. */
574 extern ifindex_t
ifname2ifindex(const char *ifname
, vrf_id_t vrf_id
);
576 /* Connected address functions. */
577 extern struct connected
*connected_new(void);
578 extern void connected_free(struct connected
**connected
);
579 extern void connected_add(struct interface
*, struct connected
*);
580 extern struct connected
*
581 connected_add_by_prefix(struct interface
*, struct prefix
*, struct prefix
*);
582 extern struct connected
*connected_delete_by_prefix(struct interface
*,
584 extern struct connected
*connected_lookup_prefix(struct interface
*,
585 const struct prefix
*);
586 extern struct connected
*connected_lookup_prefix_exact(struct interface
*,
587 const struct prefix
*);
588 extern unsigned int connected_count_by_family(struct interface
*, int family
);
589 extern struct nbr_connected
*nbr_connected_new(void);
590 extern void nbr_connected_free(struct nbr_connected
*);
591 struct nbr_connected
*nbr_connected_check(struct interface
*, struct prefix
*);
592 struct connected
*connected_get_linklocal(struct interface
*ifp
);
594 /* link parameters */
595 bool if_link_params_cmp(struct if_link_params
*iflp1
,
596 struct if_link_params
*iflp2
);
597 void if_link_params_copy(struct if_link_params
*dst
,
598 struct if_link_params
*src
);
599 struct if_link_params
*if_link_params_get(struct interface
*);
600 struct if_link_params
*if_link_params_enable(struct interface
*ifp
);
601 struct if_link_params
*if_link_params_init(struct interface
*ifp
);
602 void if_link_params_free(struct interface
*);
606 extern void if_vty_config_start(struct vty
*vty
, struct interface
*ifp
);
607 extern void if_vty_config_end(struct vty
*vty
);
608 extern void if_cmd_init(int (*config_write
)(struct vty
*));
609 extern void if_cmd_init_default(void);
610 extern void if_zapi_callbacks(int (*create
)(struct interface
*ifp
),
611 int (*up
)(struct interface
*ifp
),
612 int (*down
)(struct interface
*ifp
),
613 int (*destroy
)(struct interface
*ifp
));
615 extern void if_new_via_zapi(struct interface
*ifp
);
616 extern void if_up_via_zapi(struct interface
*ifp
);
617 extern void if_down_via_zapi(struct interface
*ifp
);
618 extern void if_destroy_via_zapi(struct interface
*ifp
);
620 extern const struct frr_yang_module_info frr_interface_info
;
626 #endif /* _ZEBRA_IF_H */