1 /* Interface related header.
2 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
4 * This file is part of GNU Zebra.
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.
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.
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
35 DECLARE_MTYPE(CONNECTED_LABEL
)
37 /* Interface link-layer type, if known. Derived from:
39 * net/if_arp.h on various platforms - Linux especially.
40 * http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
42 * Some of the more obviously defunct technologies left out.
44 enum zebra_link_type
{
45 ZEBRA_LLT_UNKNOWN
= 0,
92 ZEBRA_LLT_IEEE80211_RADIOTAP
,
94 ZEBRA_LLT_IEEE802154_PHY
,
98 Interface name length.
100 Linux define value in /usr/include/linux/if.h.
103 FreeBSD define value in /usr/include/net/if.h.
107 #define INTERFACE_NAMSIZ 20
108 #define INTERFACE_HWADDR_MAX 20
110 typedef signed int ifindex_t
;
112 #ifdef HAVE_PROC_NET_DEV
114 unsigned long rx_packets
; /* total packets received */
115 unsigned long tx_packets
; /* total packets transmitted */
116 unsigned long rx_bytes
; /* total bytes received */
117 unsigned long tx_bytes
; /* total bytes transmitted */
118 unsigned long rx_errors
; /* bad packets received */
119 unsigned long tx_errors
; /* packet transmit problems */
120 unsigned long rx_dropped
; /* no space in linux buffers */
121 unsigned long tx_dropped
; /* no space available in linux */
122 unsigned long rx_multicast
; /* multicast packets received */
123 unsigned long rx_compressed
;
124 unsigned long tx_compressed
;
125 unsigned long collisions
;
127 /* detailed rx_errors: */
128 unsigned long rx_length_errors
;
129 unsigned long rx_over_errors
; /* receiver ring buff overflow */
130 unsigned long rx_crc_errors
; /* recved pkt with crc error */
131 unsigned long rx_frame_errors
; /* recv'd frame alignment error */
132 unsigned long rx_fifo_errors
; /* recv'r fifo overrun */
133 unsigned long rx_missed_errors
; /* receiver missed packet */
134 /* detailed tx_errors */
135 unsigned long tx_aborted_errors
;
136 unsigned long tx_carrier_errors
;
137 unsigned long tx_fifo_errors
;
138 unsigned long tx_heartbeat_errors
;
139 unsigned long tx_window_errors
;
141 #endif /* HAVE_PROC_NET_DEV */
143 /* Here are "non-official" architectural constants. */
144 #define TE_EXT_MASK 0x0FFFFFFF
145 #define TE_EXT_ANORMAL 0x80000000
146 #define LOSS_PRECISION 0.000003
147 #define TE_KILO_BIT 1000
149 #define DEFAULT_BANDWIDTH 10000
150 #define MAX_CLASS_TYPE 8
151 #define MAX_PKT_LOSS 50.331642
154 * Link Parameters Status:
156 * different from 0: set
158 #define LP_UNSET 0x0000
159 #define LP_TE_METRIC 0x0001
160 #define LP_MAX_BW 0x0002
161 #define LP_MAX_RSV_BW 0x0004
162 #define LP_UNRSV_BW 0x0008
163 #define LP_ADM_GRP 0x0010
164 #define LP_RMT_AS 0x0020
165 #define LP_DELAY 0x0040
166 #define LP_MM_DELAY 0x0080
167 #define LP_DELAY_VAR 0x0100
168 #define LP_PKT_LOSS 0x0200
169 #define LP_RES_BW 0x0400
170 #define LP_AVA_BW 0x0800
171 #define LP_USE_BW 0x1000
173 #define IS_PARAM_UNSET(lp, st) !(lp->lp_status & st)
174 #define IS_PARAM_SET(lp, st) (lp->lp_status & st)
175 #define IS_LINK_PARAMS_SET(lp) (lp->lp_status != LP_UNSET)
177 #define SET_PARAM(lp, st) (lp->lp_status) |= (st)
178 #define UNSET_PARAM(lp, st) (lp->lp_status) &= ~(st)
179 #define RESET_LINK_PARAM(lp) (lp->lp_status = LP_UNSET)
181 /* Link Parameters for Traffic Engineering */
182 struct if_link_params
{
183 uint32_t lp_status
; /* Status of Link Parameters: */
184 uint32_t te_metric
; /* Traffic Engineering metric */
186 float max_bw
; /* Maximum Bandwidth */
187 float max_rsv_bw
; /* Maximum Reservable Bandwidth */
188 float unrsv_bw
[MAX_CLASS_TYPE
]; /* Unreserved Bandwidth per Class Type
190 uint32_t admin_grp
; /* Administrative group */
191 uint32_t rmt_as
; /* Remote AS number */
192 struct in_addr rmt_ip
; /* Remote IP address */
193 uint32_t av_delay
; /* Link Average Delay */
194 uint32_t min_delay
; /* Link Min Delay */
195 uint32_t max_delay
; /* Link Max Delay */
196 uint32_t delay_var
; /* Link Delay Variation */
197 float pkt_loss
; /* Link Packet Loss */
198 float res_bw
; /* Residual Bandwidth */
199 float ava_bw
; /* Available Bandwidth */
200 float use_bw
; /* Utilized Bandwidth */
203 #define INTERFACE_LINK_PARAMS_SIZE sizeof(struct if_link_params)
204 #define HAS_LINK_PARAMS(ifp) ((ifp)->link_params != NULL)
206 /* Interface structure */
208 RB_ENTRY(interface
) name_entry
, index_entry
;
210 /* Interface name. This should probably never be changed after the
211 interface is created, because the configuration info for this
213 is associated with this structure. For that reason, the interface
214 should also never be deleted (to avoid losing configuration info).
215 To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
216 interface does not exist in the kernel.
218 char name
[INTERFACE_NAMSIZ
];
220 /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
222 WARNING: the ifindex needs to be changed using the if_set_index()
223 function. Failure to respect this will cause corruption in the data
224 structure used to store the interfaces and if_lookup_by_index() will
225 not work as expected.
228 #define IFINDEX_INTERNAL 0
230 /* Zebra internal interface status */
232 #define ZEBRA_INTERFACE_ACTIVE (1 << 0)
233 #define ZEBRA_INTERFACE_SUB (1 << 1)
234 #define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
235 #define ZEBRA_INTERFACE_VRF_LOOPBACK (1 << 3)
237 /* Interface flags. */
240 /* Interface metric */
243 /* Interface Speed in Mb/s */
247 unsigned int mtu
; /* IPv4 MTU */
249 mtu6
; /* IPv6 MTU - probably, but not neccessarily same as mtu
252 /* Link-layer information and hardware address */
253 enum zebra_link_type ll_type
;
254 uint8_t hw_addr
[INTERFACE_HWADDR_MAX
];
257 /* interface bandwidth, kbits */
258 unsigned int bandwidth
;
260 /* Link parameters for Traffic Engineering */
261 struct if_link_params
*link_params
;
263 /* description of the interface. */
266 /* Distribute list. */
268 void *distribute_out
;
270 /* Connected address list. */
271 struct list
*connected
;
273 /* Neighbor connected address list. */
274 struct list
*nbr_connected
;
276 /* Daemon specific interface data pointer. */
279 char ptm_enable
; /* Should we look at ptm_status ? */
282 /* Statistics fileds. */
283 #ifdef HAVE_PROC_NET_DEV
284 struct if_stats stats
;
285 #endif /* HAVE_PROC_NET_DEV */
286 #ifdef HAVE_NET_RT_IFLIST
287 struct if_data stats
;
288 #endif /* HAVE_NET_RT_IFLIST */
290 struct route_node
*node
;
296 RB_HEAD(if_name_head
, interface
);
297 RB_PROTOTYPE(if_name_head
, interface
, name_entry
, if_cmp_func
)
298 RB_HEAD(if_index_head
, interface
);
299 RB_PROTOTYPE(if_index_head
, interface
, index_entry
, if_cmp_func
)
300 DECLARE_QOBJ_TYPE(interface
)
302 #define IFNAME_RB_INSERT(vrf, ifp) \
303 if (RB_INSERT(if_name_head, &vrf->ifaces_by_name, (ifp))) \
304 flog_err(EC_LIB_INTERFACE, \
305 "%s(%s): corruption detected -- interface with this " \
306 "name exists already in VRF %u!", \
307 __func__, (ifp)->name, (ifp)->vrf_id);
309 #define IFNAME_RB_REMOVE(vrf, ifp) \
310 if (RB_REMOVE(if_name_head, &vrf->ifaces_by_name, (ifp)) == NULL) \
311 flog_err(EC_LIB_INTERFACE, \
312 "%s(%s): corruption detected -- interface with this " \
313 "name doesn't exist in VRF %u!", \
314 __func__, (ifp)->name, (ifp)->vrf_id);
316 #define IFINDEX_RB_INSERT(vrf, ifp) \
317 if (RB_INSERT(if_index_head, &vrf->ifaces_by_index, (ifp))) \
318 flog_err(EC_LIB_INTERFACE, \
319 "%s(%u): corruption detected -- interface with this " \
320 "ifindex exists already in VRF %u!", \
321 __func__, (ifp)->ifindex, (ifp)->vrf_id);
323 #define IFINDEX_RB_REMOVE(vrf, ifp) \
324 if (RB_REMOVE(if_index_head, &vrf->ifaces_by_index, (ifp)) == NULL) \
325 flog_err(EC_LIB_INTERFACE, \
326 "%s(%u): corruption detected -- interface with this " \
327 "ifindex doesn't exist in VRF %u!", \
328 __func__, (ifp)->ifindex, (ifp)->vrf_id);
330 #define FOR_ALL_INTERFACES(vrf, ifp) \
332 RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name)
334 #define FOR_ALL_INTERFACES_ADDRESSES(ifp, connected, node) \
335 for (ALL_LIST_ELEMENTS_RO(ifp->connected, node, connected))
337 /* called from the library code whenever interfaces are created/deleted
338 * note: interfaces may not be fully realized at that point; also they
339 * may not exist in the system (ifindex = IFINDEX_INTERNAL)
341 * priority values are important here, daemons should be at 0 while modules
342 * can use 1000+ so they run after the daemon has initialised daemon-specific
345 DECLARE_HOOK(if_add
, (struct interface
* ifp
), (ifp
))
346 DECLARE_KOOH(if_del
, (struct interface
* ifp
), (ifp
))
348 #define METRIC_MAX (~0)
350 /* Connected address structure. */
352 /* Attached interface. */
353 struct interface
*ifp
;
355 /* Flags for configuration. */
357 #define ZEBRA_IFC_REAL (1 << 0)
358 #define ZEBRA_IFC_CONFIGURED (1 << 1)
359 #define ZEBRA_IFC_QUEUED (1 << 2)
361 The ZEBRA_IFC_REAL flag should be set if and only if this address
362 exists in the kernel and is actually usable. (A case where it exists
364 is not yet usable would be IPv6 with DAD)
365 The ZEBRA_IFC_CONFIGURED flag should be set if and only if this
367 was configured by the user from inside quagga.
368 The ZEBRA_IFC_QUEUED flag should be set if and only if the address
370 in the kernel. It may and should be set although the address might
372 usable yet. (compare with ZEBRA_IFC_REAL)
375 /* Flags for connected address. */
377 #define ZEBRA_IFA_SECONDARY (1 << 0)
378 #define ZEBRA_IFA_PEER (1 << 1)
379 #define ZEBRA_IFA_UNNUMBERED (1 << 2)
380 /* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
381 a peer address has been configured. If this flag is set,
382 the destination field must contain the peer address.
383 Otherwise, if this flag is not set, the destination address
384 will either contain a broadcast address or be NULL.
387 /* Address of connected network. */
388 struct prefix
*address
;
390 /* Peer or Broadcast address, depending on whether ZEBRA_IFA_PEER is
392 Note: destination may be NULL if ZEBRA_IFA_PEER is not set. */
393 struct prefix
*destination
;
395 /* Label for Linux 2.2.X and upper. */
399 * Used for setting the connected route's cost. If the metric
400 * here is set to METRIC_MAX the connected route falls back to
406 /* Nbr Connected address structure. */
407 struct nbr_connected
{
408 /* Attached interface. */
409 struct interface
*ifp
;
411 /* Address of connected network. */
412 struct prefix
*address
;
415 /* Does the destination field contain a peer address? */
416 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
418 /* Prefix to insert into the RIB */
419 #define CONNECTED_PREFIX(C) \
420 (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
422 /* Identifying address. We guess that if there's a peer address, but the
423 local address is in the same prefix, then the local address may be unique. */
424 #define CONNECTED_ID(C) \
425 ((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address)) \
429 /* There are some interface flags which are only supported by some
432 #ifndef IFF_NOTRAILERS
433 #define IFF_NOTRAILERS 0x0
434 #endif /* IFF_NOTRAILERS */
436 #define IFF_OACTIVE 0x0
437 #endif /* IFF_OACTIVE */
439 #define IFF_SIMPLEX 0x0
440 #endif /* IFF_SIMPLEX */
442 #define IFF_LINK0 0x0
443 #endif /* IFF_LINK0 */
445 #define IFF_LINK1 0x0
446 #endif /* IFF_LINK1 */
448 #define IFF_LINK2 0x0
449 #endif /* IFF_LINK2 */
451 #define IFF_NOXMIT 0x0
452 #endif /* IFF_NOXMIT */
454 #define IFF_NORTEXCH 0x0
455 #endif /* IFF_NORTEXCH */
458 #endif /* IFF_IPV4 */
461 #endif /* IFF_IPV6 */
463 #define IFF_VIRTUAL 0x0
464 #endif /* IFF_VIRTUAL */
467 extern int if_cmp_name_func(const char *p1
, const char *p2
);
470 * Passing in VRF_UNKNOWN is a valid thing to do, unless we
471 * are creating a new interface.
473 * This is useful for vrf route-leaking. So more than anything
474 * else think before you use VRF_UNKNOWN
476 extern void if_update_to_new_vrf(struct interface
*, vrf_id_t vrf_id
);
477 extern struct interface
*if_create(const char *name
, 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_exact_address(void *matchaddr
, int family
,
481 extern struct connected
*if_lookup_address(void *matchaddr
, int family
,
483 extern struct interface
*if_lookup_prefix(struct prefix
*prefix
,
485 size_t if_lookup_by_hwaddr(const uint8_t *hw_addr
, size_t addrsz
,
486 struct interface
***result
, vrf_id_t vrf_id
);
488 /* These 3 functions are to be used when the ifname argument is terminated
489 by a '\0' character: */
490 extern struct interface
*if_lookup_by_name_all_vrf(const char *ifname
);
491 extern struct interface
*if_lookup_by_name(const char *ifname
, vrf_id_t vrf_id
);
492 extern struct interface
*if_get_by_name(const char *ifname
, vrf_id_t vrf_id
);
493 extern void if_set_index(struct interface
*ifp
, ifindex_t ifindex
);
495 /* Delete the interface, but do not free the structure, and leave it in the
496 interface list. It is often advisable to leave the pseudo interface
497 structure because there may be configuration information attached. */
498 extern void if_delete_retain(struct interface
*);
500 /* Delete and free the interface structure: calls if_delete_retain and then
501 deletes it from the interface list and frees the structure. */
502 extern void if_delete(struct interface
*);
504 extern int if_is_up(const struct interface
*ifp
);
505 extern int if_is_running(const struct interface
*ifp
);
506 extern int if_is_operative(const struct interface
*ifp
);
507 extern int if_is_no_ptm_operative(const struct interface
*ifp
);
508 extern int if_is_loopback(const struct interface
*ifp
);
509 extern int if_is_vrf(const struct interface
*ifp
);
510 extern bool if_is_loopback_or_vrf(const struct interface
*ifp
);
511 extern int if_is_broadcast(const struct interface
*ifp
);
512 extern int if_is_pointopoint(const struct interface
*ifp
);
513 extern int if_is_multicast(const struct interface
*ifp
);
515 extern void if_terminate(struct vrf
*vrf
);
516 extern void if_dump_all(void);
517 extern const char *if_flag_dump(unsigned long);
518 extern const char *if_link_type_str(enum zebra_link_type
);
520 /* Please use ifindex2ifname instead of if_indextoname where possible;
521 ifindex2ifname uses internal interface info, whereas if_indextoname must
522 make a system call. */
523 extern const char *ifindex2ifname(ifindex_t
, vrf_id_t vrf_id
);
525 /* Please use ifname2ifindex instead of if_nametoindex where possible;
526 ifname2ifindex uses internal interface info, whereas if_nametoindex must
527 make a system call. */
528 extern ifindex_t
ifname2ifindex(const char *ifname
, vrf_id_t vrf_id
);
530 /* Connected address functions. */
531 extern struct connected
*connected_new(void);
532 extern void connected_free(struct connected
*);
533 extern void connected_add(struct interface
*, struct connected
*);
534 extern struct connected
*
535 connected_add_by_prefix(struct interface
*, struct prefix
*, struct prefix
*);
536 extern struct connected
*connected_delete_by_prefix(struct interface
*,
538 extern struct connected
*connected_lookup_prefix(struct interface
*,
540 extern struct connected
*connected_lookup_prefix_exact(struct interface
*,
542 extern struct nbr_connected
*nbr_connected_new(void);
543 extern void nbr_connected_free(struct nbr_connected
*);
544 struct nbr_connected
*nbr_connected_check(struct interface
*, struct prefix
*);
546 /* link parameters */
547 struct if_link_params
*if_link_params_get(struct interface
*);
548 void if_link_params_free(struct interface
*);
551 extern void if_cmd_init(void);
552 extern const struct frr_yang_module_info frr_interface_info
;
558 #endif /* _ZEBRA_IF_H */