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
34 DECLARE_MTYPE(CONNECTED_LABEL
)
36 /* Interface link-layer type, if known. Derived from:
38 * net/if_arp.h on various platforms - Linux especially.
39 * http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
41 * Some of the more obviously defunct technologies left out.
43 enum zebra_link_type
{
44 ZEBRA_LLT_UNKNOWN
= 0,
91 ZEBRA_LLT_IEEE80211_RADIOTAP
,
93 ZEBRA_LLT_IEEE802154_PHY
,
97 Interface name length.
99 Linux define value in /usr/include/linux/if.h.
102 FreeBSD define value in /usr/include/net/if.h.
106 #define INTERFACE_NAMSIZ 20
107 #define INTERFACE_HWADDR_MAX 20
109 typedef signed int ifindex_t
;
111 #ifdef HAVE_PROC_NET_DEV
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
;
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
;
140 #endif /* HAVE_PROC_NET_DEV */
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
148 #define DEFAULT_BANDWIDTH 10000
149 #define MAX_CLASS_TYPE 8
150 #define MAX_PKT_LOSS 50.331642
153 * Link Parameters Status:
155 * different from 0: set
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
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 struct if_link_params
{
182 uint32_t lp_status
; /* Status of Link Parameters: */
183 uint32_t te_metric
; /* Traffic Engineering metric */
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
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 */
202 #define INTERFACE_LINK_PARAMS_SIZE sizeof(struct if_link_params)
203 #define HAS_LINK_PARAMS(ifp) ((ifp)->link_params != NULL)
205 /* Interface structure */
207 RB_ENTRY(interface
) name_entry
, index_entry
;
209 /* Interface name. This should probably never be changed after the
210 interface is created, because the configuration info for this
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.
217 char name
[INTERFACE_NAMSIZ
];
219 /* Interface index (should be IFINDEX_INTERNAL for non-kernel or
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.
228 * ifindex of parent interface, if any
230 ifindex_t link_ifindex
;
231 #define IFINDEX_INTERNAL 0
233 /* Zebra internal interface 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)
240 /* Interface flags. */
243 /* Interface metric */
246 /* Interface Speed in Mb/s */
250 unsigned int mtu
; /* IPv4 MTU */
252 mtu6
; /* IPv6 MTU - probably, but not neccessarily same as mtu
255 /* Link-layer information and hardware address */
256 enum zebra_link_type ll_type
;
257 uint8_t hw_addr
[INTERFACE_HWADDR_MAX
];
260 /* interface bandwidth, kbits */
261 unsigned int bandwidth
;
263 /* Link parameters for Traffic Engineering */
264 struct if_link_params
*link_params
;
266 /* description of the interface. */
269 /* Distribute list. */
271 void *distribute_out
;
273 /* Connected address list. */
274 struct list
*connected
;
276 /* Neighbor connected address list. */
277 struct list
*nbr_connected
;
279 /* Daemon specific interface data pointer. */
282 char ptm_enable
; /* Should we look at ptm_status ? */
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 */
293 struct route_node
*node
;
297 * Has the end users entered `interface XXXX` from the cli in some
305 RB_HEAD(if_name_head
, interface
);
306 RB_PROTOTYPE(if_name_head
, interface
, name_entry
, if_cmp_func
)
307 RB_HEAD(if_index_head
, interface
);
308 RB_PROTOTYPE(if_index_head
, interface
, index_entry
, if_cmp_index_func
)
309 DECLARE_QOBJ_TYPE(interface
)
311 #define IFNAME_RB_INSERT(vrf, ifp) \
312 if (RB_INSERT(if_name_head, &vrf->ifaces_by_name, (ifp))) \
313 flog_err(EC_LIB_INTERFACE, \
314 "%s(%s): corruption detected -- interface with this " \
315 "name exists already in VRF %u!", \
316 __func__, (ifp)->name, (ifp)->vrf_id);
318 #define IFNAME_RB_REMOVE(vrf, ifp) \
319 if (RB_REMOVE(if_name_head, &vrf->ifaces_by_name, (ifp)) == NULL) \
320 flog_err(EC_LIB_INTERFACE, \
321 "%s(%s): corruption detected -- interface with this " \
322 "name doesn't exist in VRF %u!", \
323 __func__, (ifp)->name, (ifp)->vrf_id);
325 #define IFINDEX_RB_INSERT(vrf, ifp) \
326 if (RB_INSERT(if_index_head, &vrf->ifaces_by_index, (ifp))) \
327 flog_err(EC_LIB_INTERFACE, \
328 "%s(%u): corruption detected -- interface with this " \
329 "ifindex exists already in VRF %u!", \
330 __func__, (ifp)->ifindex, (ifp)->vrf_id);
332 #define IFINDEX_RB_REMOVE(vrf, ifp) \
333 if (RB_REMOVE(if_index_head, &vrf->ifaces_by_index, (ifp)) == NULL) \
334 flog_err(EC_LIB_INTERFACE, \
335 "%s(%u): corruption detected -- interface with this " \
336 "ifindex doesn't exist in VRF %u!", \
337 __func__, (ifp)->ifindex, (ifp)->vrf_id);
339 #define FOR_ALL_INTERFACES(vrf, ifp) \
341 RB_FOREACH (ifp, if_name_head, &vrf->ifaces_by_name)
343 #define FOR_ALL_INTERFACES_ADDRESSES(ifp, connected, node) \
344 for (ALL_LIST_ELEMENTS_RO(ifp->connected, node, connected))
346 /* called from the library code whenever interfaces are created/deleted
347 * note: interfaces may not be fully realized at that point; also they
348 * may not exist in the system (ifindex = IFINDEX_INTERNAL)
350 * priority values are important here, daemons should be at 0 while modules
351 * can use 1000+ so they run after the daemon has initialised daemon-specific
354 DECLARE_HOOK(if_add
, (struct interface
* ifp
), (ifp
))
355 DECLARE_KOOH(if_del
, (struct interface
* ifp
), (ifp
))
357 #define METRIC_MAX (~0)
359 /* Connected address structure. */
361 /* Attached interface. */
362 struct interface
*ifp
;
364 /* Flags for configuration. */
366 #define ZEBRA_IFC_REAL (1 << 0)
367 #define ZEBRA_IFC_CONFIGURED (1 << 1)
368 #define ZEBRA_IFC_QUEUED (1 << 2)
370 The ZEBRA_IFC_REAL flag should be set if and only if this address
371 exists in the kernel and is actually usable. (A case where it exists
373 is not yet usable would be IPv6 with DAD)
374 The ZEBRA_IFC_CONFIGURED flag should be set if and only if this
376 was configured by the user from inside quagga.
377 The ZEBRA_IFC_QUEUED flag should be set if and only if the address
379 in the kernel. It may and should be set although the address might
381 usable yet. (compare with ZEBRA_IFC_REAL)
384 /* Flags for connected address. */
386 #define ZEBRA_IFA_SECONDARY (1 << 0)
387 #define ZEBRA_IFA_PEER (1 << 1)
388 #define ZEBRA_IFA_UNNUMBERED (1 << 2)
389 /* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
390 a peer address has been configured. If this flag is set,
391 the destination field must contain the peer address.
394 /* Address of connected network. */
395 struct prefix
*address
;
397 /* Peer address, if ZEBRA_IFA_PEER is set, otherwise NULL */
398 struct prefix
*destination
;
400 /* Label for Linux 2.2.X and upper. */
404 * Used for setting the connected route's cost. If the metric
405 * here is set to METRIC_MAX the connected route falls back to
411 /* Nbr Connected address structure. */
412 struct nbr_connected
{
413 /* Attached interface. */
414 struct interface
*ifp
;
416 /* Address of connected network. */
417 struct prefix
*address
;
420 /* Does the destination field contain a peer address? */
421 #define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
423 /* Prefix to insert into the RIB */
424 #define CONNECTED_PREFIX(C) \
425 (CONNECTED_PEER(C) ? (C)->destination : (C)->address)
427 /* Identifying address. We guess that if there's a peer address, but the
428 local address is in the same prefix, then the local address may be unique. */
429 #define CONNECTED_ID(C) \
430 ((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address)) \
434 /* There are some interface flags which are only supported by some
437 #ifndef IFF_NOTRAILERS
438 #define IFF_NOTRAILERS 0x0
439 #endif /* IFF_NOTRAILERS */
441 #define IFF_OACTIVE 0x0
442 #endif /* IFF_OACTIVE */
444 #define IFF_SIMPLEX 0x0
445 #endif /* IFF_SIMPLEX */
447 #define IFF_LINK0 0x0
448 #endif /* IFF_LINK0 */
450 #define IFF_LINK1 0x0
451 #endif /* IFF_LINK1 */
453 #define IFF_LINK2 0x0
454 #endif /* IFF_LINK2 */
456 #define IFF_NOXMIT 0x0
457 #endif /* IFF_NOXMIT */
459 #define IFF_NORTEXCH 0x0
460 #endif /* IFF_NORTEXCH */
463 #endif /* IFF_IPV4 */
466 #endif /* IFF_IPV6 */
468 #define IFF_VIRTUAL 0x0
469 #endif /* IFF_VIRTUAL */
472 extern int if_cmp_name_func(const char *p1
, const char *p2
);
475 * Passing in VRF_UNKNOWN is a valid thing to do, unless we
476 * are creating a new interface.
478 * This is useful for vrf route-leaking. So more than anything
479 * else think before you use VRF_UNKNOWN
481 extern void if_update_to_new_vrf(struct interface
*, vrf_id_t vrf_id
);
483 /* Create new interface, adds to name list only */
484 extern struct interface
*if_create_name(const char *name
, vrf_id_t vrf_id
);
486 /* Create new interface, adds to index list only */
487 extern struct interface
*if_create_ifindex(ifindex_t ifindex
, vrf_id_t vrf_id
);
488 extern struct interface
*if_lookup_by_index(ifindex_t
, vrf_id_t vrf_id
);
489 extern struct interface
*if_lookup_by_index_all_vrf(ifindex_t
);
490 extern struct interface
*if_lookup_exact_address(void *matchaddr
, int family
,
492 extern struct connected
*if_lookup_address(void *matchaddr
, int family
,
494 extern struct interface
*if_lookup_prefix(struct prefix
*prefix
,
496 size_t if_lookup_by_hwaddr(const uint8_t *hw_addr
, size_t addrsz
,
497 struct interface
***result
, vrf_id_t vrf_id
);
499 extern struct interface
*if_lookup_by_name_all_vrf(const char *ifname
);
500 extern struct interface
*if_lookup_by_name(const char *ifname
, vrf_id_t vrf_id
);
501 extern struct interface
*if_get_by_name(const char *ifname
, vrf_id_t vrf_id
);
502 extern struct interface
*if_get_by_ifindex(ifindex_t ifindex
, vrf_id_t vrf_id
);
504 /* Sets the index and adds to index list */
505 extern void if_set_index(struct interface
*ifp
, ifindex_t ifindex
);
506 /* Sets the name and adds to name list */
507 extern void if_set_name(struct interface
*ifp
, const char *name
);
509 /* Delete the interface, but do not free the structure, and leave it in the
510 interface list. It is often advisable to leave the pseudo interface
511 structure because there may be configuration information attached. */
512 extern void if_delete_retain(struct interface
*);
514 /* Delete and free the interface structure: calls if_delete_retain and then
515 deletes it from the interface list and frees the structure. */
516 extern void if_delete(struct interface
*);
518 extern int if_is_up(const struct interface
*ifp
);
519 extern int if_is_running(const struct interface
*ifp
);
520 extern int if_is_operative(const struct interface
*ifp
);
521 extern int if_is_no_ptm_operative(const struct interface
*ifp
);
522 extern int if_is_loopback(const struct interface
*ifp
);
523 extern int if_is_vrf(const struct interface
*ifp
);
524 extern bool if_is_loopback_or_vrf(const struct interface
*ifp
);
525 extern int if_is_broadcast(const struct interface
*ifp
);
526 extern int if_is_pointopoint(const struct interface
*ifp
);
527 extern int if_is_multicast(const struct interface
*ifp
);
529 extern void if_terminate(struct vrf
*vrf
);
530 extern void if_dump_all(void);
531 extern const char *if_flag_dump(unsigned long);
532 extern const char *if_link_type_str(enum zebra_link_type
);
534 /* Please use ifindex2ifname instead of if_indextoname where possible;
535 ifindex2ifname uses internal interface info, whereas if_indextoname must
536 make a system call. */
537 extern const char *ifindex2ifname(ifindex_t
, vrf_id_t vrf_id
);
539 /* Please use ifname2ifindex instead of if_nametoindex where possible;
540 ifname2ifindex uses internal interface info, whereas if_nametoindex must
541 make a system call. */
542 extern ifindex_t
ifname2ifindex(const char *ifname
, vrf_id_t vrf_id
);
544 /* Connected address functions. */
545 extern struct connected
*connected_new(void);
546 extern void connected_free(struct connected
**connected
);
547 extern void connected_add(struct interface
*, struct connected
*);
548 extern struct connected
*
549 connected_add_by_prefix(struct interface
*, struct prefix
*, struct prefix
*);
550 extern struct connected
*connected_delete_by_prefix(struct interface
*,
552 extern struct connected
*connected_lookup_prefix(struct interface
*,
554 extern struct connected
*connected_lookup_prefix_exact(struct interface
*,
556 extern unsigned int connected_count_by_family(struct interface
*, int family
);
557 extern struct nbr_connected
*nbr_connected_new(void);
558 extern void nbr_connected_free(struct nbr_connected
*);
559 struct nbr_connected
*nbr_connected_check(struct interface
*, struct prefix
*);
560 struct connected
*connected_get_linklocal(struct interface
*ifp
);
562 /* link parameters */
563 struct if_link_params
*if_link_params_get(struct interface
*);
564 void if_link_params_free(struct interface
*);
567 extern void if_cmd_init(void);
568 extern void if_zapi_callbacks(int (*create
)(struct interface
*ifp
),
569 int (*up
)(struct interface
*ifp
),
570 int (*down
)(struct interface
*ifp
),
571 int (*destroy
)(struct interface
*ifp
));
573 extern void if_new_via_zapi(struct interface
*ifp
);
574 extern void if_up_via_zapi(struct interface
*ifp
);
575 extern void if_down_via_zapi(struct interface
*ifp
);
576 extern void if_destroy_via_zapi(struct interface
*ifp
);
578 extern const struct frr_yang_module_info frr_interface_info
;
584 #endif /* _ZEBRA_IF_H */