[mirror_frr.git] / lib / if.h

/* Interface related header.
 * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_IF_H
#define _ZEBRA_IF_H

#include "zebra.h"
#include "linklist.h"
#include "memory.h"
#include "qobj.h"
#include "hook.h"

DECLARE_MTYPE(IF)
DECLARE_MTYPE(CONNECTED_LABEL)

/* Interface link-layer type, if known. Derived from:
 *
 * net/if_arp.h on various platforms - Linux especially.
 * http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
 *
 * Some of the more obviously defunct technologies left out.
 */
enum zebra_link_type {
	ZEBRA_LLT_UNKNOWN = 0,
	ZEBRA_LLT_ETHER,
	ZEBRA_LLT_EETHER,
	ZEBRA_LLT_AX25,
	ZEBRA_LLT_PRONET,
	ZEBRA_LLT_IEEE802,
	ZEBRA_LLT_ARCNET,
	ZEBRA_LLT_APPLETLK,
	ZEBRA_LLT_DLCI,
	ZEBRA_LLT_ATM,
	ZEBRA_LLT_METRICOM,
	ZEBRA_LLT_IEEE1394,
	ZEBRA_LLT_EUI64,
	ZEBRA_LLT_INFINIBAND,
	ZEBRA_LLT_SLIP,
	ZEBRA_LLT_CSLIP,
	ZEBRA_LLT_SLIP6,
	ZEBRA_LLT_CSLIP6,
	ZEBRA_LLT_RSRVD,
	ZEBRA_LLT_ADAPT,
	ZEBRA_LLT_ROSE,
	ZEBRA_LLT_X25,
	ZEBRA_LLT_PPP,
	ZEBRA_LLT_CHDLC,
	ZEBRA_LLT_LAPB,
	ZEBRA_LLT_RAWHDLC,
	ZEBRA_LLT_IPIP,
	ZEBRA_LLT_IPIP6,
	ZEBRA_LLT_FRAD,
	ZEBRA_LLT_SKIP,
	ZEBRA_LLT_LOOPBACK,
	ZEBRA_LLT_LOCALTLK,
	ZEBRA_LLT_FDDI,
	ZEBRA_LLT_SIT,
	ZEBRA_LLT_IPDDP,
	ZEBRA_LLT_IPGRE,
	ZEBRA_LLT_IP6GRE,
	ZEBRA_LLT_PIMREG,
	ZEBRA_LLT_HIPPI,
	ZEBRA_LLT_ECONET,
	ZEBRA_LLT_IRDA,
	ZEBRA_LLT_FCPP,
	ZEBRA_LLT_FCAL,
	ZEBRA_LLT_FCPL,
	ZEBRA_LLT_FCFABRIC,
	ZEBRA_LLT_IEEE802_TR,
	ZEBRA_LLT_IEEE80211,
	ZEBRA_LLT_IEEE80211_RADIOTAP,
	ZEBRA_LLT_IEEE802154,
	ZEBRA_LLT_IEEE802154_PHY,
};

/*
  Interface name length.

   Linux define value in /usr/include/linux/if.h.
   #define IFNAMSIZ        16

   FreeBSD define value in /usr/include/net/if.h.
   #define IFNAMSIZ        16
*/

#define INTERFACE_NAMSIZ      20
#define INTERFACE_HWADDR_MAX  20

typedef signed int ifindex_t;

#ifdef HAVE_PROC_NET_DEV
struct if_stats {
	unsigned long rx_packets;   /* total packets received       */
	unsigned long tx_packets;   /* total packets transmitted    */
	unsigned long rx_bytes;     /* total bytes received         */
	unsigned long tx_bytes;     /* total bytes transmitted      */
	unsigned long rx_errors;    /* bad packets received         */
	unsigned long tx_errors;    /* packet transmit problems     */
	unsigned long rx_dropped;   /* no space in linux buffers    */
	unsigned long tx_dropped;   /* no space available in linux  */
	unsigned long rx_multicast; /* multicast packets received   */
	unsigned long rx_compressed;
	unsigned long tx_compressed;
	unsigned long collisions;

	/* detailed rx_errors: */
	unsigned long rx_length_errors;
	unsigned long rx_over_errors;   /* receiver ring buff overflow  */
	unsigned long rx_crc_errors;    /* recved pkt with crc error    */
	unsigned long rx_frame_errors;  /* recv'd frame alignment error */
	unsigned long rx_fifo_errors;   /* recv'r fifo overrun          */
	unsigned long rx_missed_errors; /* receiver missed packet     */
	/* detailed tx_errors */
	unsigned long tx_aborted_errors;
	unsigned long tx_carrier_errors;
	unsigned long tx_fifo_errors;
	unsigned long tx_heartbeat_errors;
	unsigned long tx_window_errors;
};
#endif /* HAVE_PROC_NET_DEV */

/* Here are "non-official" architectural constants. */
#define TE_EXT_MASK             0x0FFFFFFF
#define TE_EXT_ANORMAL          0x80000000
#define LOSS_PRECISION          0.000003
#define TE_KILO_BIT             1000
#define TE_BYTE                 8
#define DEFAULT_BANDWIDTH       10000
#define MAX_CLASS_TYPE          8
#define MAX_PKT_LOSS            50.331642

/*
 * Link Parameters Status:
 *  equal to 0: unset
 *  different from 0: set
 */
#define LP_UNSET                0x0000
#define LP_TE_METRIC            0x0001
#define LP_MAX_BW               0x0002
#define LP_MAX_RSV_BW           0x0004
#define LP_UNRSV_BW             0x0008
#define LP_ADM_GRP              0x0010
#define LP_RMT_AS               0x0020
#define LP_DELAY                0x0040
#define LP_MM_DELAY             0x0080
#define LP_DELAY_VAR            0x0100
#define LP_PKT_LOSS             0x0200
#define LP_RES_BW               0x0400
#define LP_AVA_BW               0x0800
#define LP_USE_BW               0x1000

#define IS_PARAM_UNSET(lp, st) !(lp->lp_status & st)
#define IS_PARAM_SET(lp, st) (lp->lp_status & st)
#define IS_LINK_PARAMS_SET(lp) (lp->lp_status != LP_UNSET)

#define SET_PARAM(lp, st) (lp->lp_status) |= (st)
#define UNSET_PARAM(lp, st) (lp->lp_status) &= ~(st)
#define RESET_LINK_PARAM(lp) (lp->lp_status = LP_UNSET)

/* Link Parameters for Traffic Engineering */
struct if_link_params {
	u_int32_t lp_status; /* Status of Link Parameters: */
	u_int32_t te_metric; /* Traffic Engineering metric */
	float default_bw;
	float max_bw;			/* Maximum Bandwidth */
	float max_rsv_bw;		/* Maximum Reservable Bandwidth */
	float unrsv_bw[MAX_CLASS_TYPE]; /* Unreserved Bandwidth per Class Type
					   (8) */
	u_int32_t admin_grp;		/* Administrative group */
	u_int32_t rmt_as;		/* Remote AS number */
	struct in_addr rmt_ip;		/* Remote IP address */
	u_int32_t av_delay;		/* Link Average Delay */
	u_int32_t min_delay;		/* Link Min Delay */
	u_int32_t max_delay;		/* Link Max Delay */
	u_int32_t delay_var;		/* Link Delay Variation */
	float pkt_loss;			/* Link Packet Loss */
	float res_bw;			/* Residual Bandwidth */
	float ava_bw;			/* Available Bandwidth */
	float use_bw;			/* Utilized Bandwidth */
};

#define INTERFACE_LINK_PARAMS_SIZE   sizeof(struct if_link_params)
#define HAS_LINK_PARAMS(ifp)  ((ifp)->link_params != NULL)

/* Interface structure */
struct interface {
	/* Interface name.  This should probably never be changed after the
	   interface is created, because the configuration info for this
	   interface
	   is associated with this structure.  For that reason, the interface
	   should also never be deleted (to avoid losing configuration info).
	   To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
	   interface does not exist in the kernel.
	 */
	char name[INTERFACE_NAMSIZ + 1];

	/* Interface index (should be IFINDEX_INTERNAL for non-kernel or
	   deleted interfaces). */
	ifindex_t ifindex;
#define IFINDEX_INTERNAL	0
#define IFINDEX_DELETED         INT_MAX

	/* Zebra internal interface status */
	u_char status;
#define ZEBRA_INTERFACE_ACTIVE     (1 << 0)
#define ZEBRA_INTERFACE_SUB        (1 << 1)
#define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
#define ZEBRA_INTERFACE_VRF_LOOPBACK (1 << 3)

	/* Interface flags. */
	uint64_t flags;

	/* Interface metric */
	uint32_t metric;

	/* Interface Speed in Mb/s */
	uint32_t speed;

	/* Interface MTU. */
	unsigned int mtu; /* IPv4 MTU */
	unsigned int
		mtu6; /* IPv6 MTU - probably, but not neccessarily same as mtu
			 */

	/* Link-layer information and hardware address */
	enum zebra_link_type ll_type;
	u_char hw_addr[INTERFACE_HWADDR_MAX];
	int hw_addr_len;

	/* interface bandwidth, kbits */
	unsigned int bandwidth;

	/* Link parameters for Traffic Engineering */
	struct if_link_params *link_params;

	/* description of the interface. */
	char *desc;

	/* Distribute list. */
	void *distribute_in;
	void *distribute_out;

	/* Connected address list. */
	struct list *connected;

	/* Neighbor connected address list. */
	struct list *nbr_connected;

	/* Daemon specific interface data pointer. */
	void *info;

	char ptm_enable; /* Should we look at ptm_status ? */
	char ptm_status;

/* Statistics fileds. */
#ifdef HAVE_PROC_NET_DEV
	struct if_stats stats;
#endif /* HAVE_PROC_NET_DEV */
#ifdef HAVE_NET_RT_IFLIST
	struct if_data stats;
#endif /* HAVE_NET_RT_IFLIST */

	struct route_node *node;
	vrf_id_t vrf_id;

	QOBJ_FIELDS
};
DECLARE_QOBJ_TYPE(interface)

/* called from the library code whenever interfaces are created/deleted
 * note: interfaces may not be fully realized at that point; also they
 * may not exist in the system (ifindex = IFINDEX_INTERNAL)
 *
 * priority values are important here, daemons should be at 0 while modules
 * can use 1000+ so they run after the daemon has initialised daemon-specific
 * interface data
 */
DECLARE_HOOK(if_add, (struct interface *ifp), (ifp))
DECLARE_KOOH(if_del, (struct interface *ifp), (ifp))

/* Connected address structure. */
struct connected {
	/* Attached interface. */
	struct interface *ifp;

	/* Flags for configuration. */
	u_char conf;
#define ZEBRA_IFC_REAL         (1 << 0)
#define ZEBRA_IFC_CONFIGURED   (1 << 1)
#define ZEBRA_IFC_QUEUED       (1 << 2)
	/*
	   The ZEBRA_IFC_REAL flag should be set if and only if this address
	   exists in the kernel and is actually usable. (A case where it exists
	   but
	   is not yet usable would be IPv6 with DAD)
	   The ZEBRA_IFC_CONFIGURED flag should be set if and only if this
	   address
	   was configured by the user from inside quagga.
	   The ZEBRA_IFC_QUEUED flag should be set if and only if the address
	   exists
	   in the kernel. It may and should be set although the address might
	   not be
	   usable yet. (compare with ZEBRA_IFC_REAL)
	 */

	/* Flags for connected address. */
	u_char flags;
#define ZEBRA_IFA_SECONDARY    (1 << 0)
#define ZEBRA_IFA_PEER         (1 << 1)
#define ZEBRA_IFA_UNNUMBERED   (1 << 2)
	/* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
	   a peer address has been configured.  If this flag is set,
	   the destination field must contain the peer address.
	   Otherwise, if this flag is not set, the destination address
	   will either contain a broadcast address or be NULL.
	 */

	/* Address of connected network. */
	struct prefix *address;

	/* Peer or Broadcast address, depending on whether ZEBRA_IFA_PEER is
	   set.
	   Note: destination may be NULL if ZEBRA_IFA_PEER is not set. */
	struct prefix *destination;

	/* Label for Linux 2.2.X and upper. */
	char *label;
};

/* Nbr Connected address structure. */
struct nbr_connected {
	/* Attached interface. */
	struct interface *ifp;

	/* Address of connected network. */
	struct prefix *address;
};

/* Does the destination field contain a peer address? */
#define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)

/* Prefix to insert into the RIB */
#define CONNECTED_PREFIX(C)                                                    \
	(CONNECTED_PEER(C) ? (C)->destination : (C)->address)

/* Identifying address.  We guess that if there's a peer address, but the
   local address is in the same prefix, then the local address may be unique. */
#define CONNECTED_ID(C)                                                        \
	((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address))  \
		 ? (C)->destination                                            \
		 : (C)->address)

/* There are some interface flags which are only supported by some
   operating system. */

#ifndef IFF_NOTRAILERS
#define IFF_NOTRAILERS 0x0
#endif /* IFF_NOTRAILERS */
#ifndef IFF_OACTIVE
#define IFF_OACTIVE 0x0
#endif /* IFF_OACTIVE */
#ifndef IFF_SIMPLEX
#define IFF_SIMPLEX 0x0
#endif /* IFF_SIMPLEX */
#ifndef IFF_LINK0
#define IFF_LINK0 0x0
#endif /* IFF_LINK0 */
#ifndef IFF_LINK1
#define IFF_LINK1 0x0
#endif /* IFF_LINK1 */
#ifndef IFF_LINK2
#define IFF_LINK2 0x0
#endif /* IFF_LINK2 */
#ifndef IFF_NOXMIT
#define IFF_NOXMIT 0x0
#endif /* IFF_NOXMIT */
#ifndef IFF_NORTEXCH
#define IFF_NORTEXCH 0x0
#endif /* IFF_NORTEXCH */
#ifndef IFF_IPV4
#define IFF_IPV4 0x0
#endif /* IFF_IPV4 */
#ifndef IFF_IPV6
#define IFF_IPV6 0x0
#endif /* IFF_IPV6 */
#ifndef IFF_VIRTUAL
#define IFF_VIRTUAL 0x0
#endif /* IFF_VIRTUAL */

/* Prototypes. */
extern int if_cmp_name_func(char *, char *);

extern void if_update_to_new_vrf(struct interface *, vrf_id_t vrf_id);
extern struct interface *if_create(const char *name, int namelen,
				   vrf_id_t vrf_id);
extern struct interface *if_lookup_by_index(ifindex_t, vrf_id_t vrf_id);
extern struct interface *if_lookup_exact_address(void *matchaddr, int family,
						 vrf_id_t vrf_id);
extern struct connected *if_lookup_address(void *matchaddr, int family,
					   vrf_id_t vrf_id);
extern struct interface *if_lookup_prefix(struct prefix *prefix,
					  vrf_id_t vrf_id);

/* These 3 functions are to be used when the ifname argument is terminated
   by a '\0' character: */
extern struct interface *if_lookup_by_name_all_vrf(const char *ifname);
extern struct interface *if_lookup_by_name(const char *ifname, vrf_id_t vrf_id);
extern struct interface *if_get_by_name(const char *ifname, vrf_id_t vrf_id);

/* For these 2 functions, the namelen argument should be the precise length
   of the ifname string (not counting any optional trailing '\0' character).
   In most cases, strnlen should be used to calculate the namelen value. */
extern struct interface *if_lookup_by_name_len(const char *ifname,
					       size_t namelen, vrf_id_t vrf_id);
extern struct interface *if_get_by_name_len(const char *ifname, size_t namelen,
					    vrf_id_t vrf_id, int vty);


/* Delete the interface, but do not free the structure, and leave it in the
   interface list.  It is often advisable to leave the pseudo interface
   structure because there may be configuration information attached. */
extern void if_delete_retain(struct interface *);

/* Delete and free the interface structure: calls if_delete_retain and then
   deletes it from the interface list and frees the structure. */
extern void if_delete(struct interface *);

extern int if_is_up(struct interface *);
extern int if_is_running(struct interface *);
extern int if_is_operative(struct interface *);
extern int if_is_no_ptm_operative(struct interface *);
extern int if_is_loopback(struct interface *);
extern int if_is_broadcast(struct interface *);
extern int if_is_pointopoint(struct interface *);
extern int if_is_multicast(struct interface *);
extern void if_init(struct list **);
extern void if_cmd_init(void);
extern void if_terminate(struct list **);
extern void if_dump_all(void);
extern const char *if_flag_dump(unsigned long);
extern const char *if_link_type_str(enum zebra_link_type);

/* Please use ifindex2ifname instead of if_indextoname where possible;
   ifindex2ifname uses internal interface info, whereas if_indextoname must
   make a system call. */
extern const char *ifindex2ifname(ifindex_t, vrf_id_t vrf_id);

/* Please use ifname2ifindex instead of if_nametoindex where possible;
   ifname2ifindex uses internal interface info, whereas if_nametoindex must
   make a system call. */
extern ifindex_t ifname2ifindex(const char *ifname, vrf_id_t vrf_id);

/* Connected address functions. */
extern struct connected *connected_new(void);
extern void connected_free(struct connected *);
extern void connected_add(struct interface *, struct connected *);
extern struct connected *
connected_add_by_prefix(struct interface *, struct prefix *, struct prefix *);
extern struct connected *connected_delete_by_prefix(struct interface *,
						    struct prefix *);
extern struct connected *connected_lookup_prefix(struct interface *,
						 struct prefix *);
extern struct connected *connected_lookup_prefix_exact(struct interface *,
						       struct prefix *);
extern struct nbr_connected *nbr_connected_new(void);
extern void nbr_connected_free(struct nbr_connected *);
struct nbr_connected *nbr_connected_check(struct interface *, struct prefix *);

/* link parameters */
struct if_link_params *if_link_params_get(struct interface *);
void if_link_params_free(struct interface *);

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