[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"

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)

/* 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)

/* Interface hook sort. */
#define IF_NEW_HOOK   0
#define IF_DELETE_HOOK 1

/* 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_add_hook (int, int (*)(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"
4a1ab8e4 DL	28
	29	DECLARE_MTYPE(IF)
	30	DECLARE_MTYPE(CONNECTED_LABEL)
718e3744	31
8ccc7e80 TT	32	/* Interface link-layer type, if known. Derived from:
	33	*
	34	* net/if_arp.h on various platforms - Linux especially.
	35	* http://www.iana.org/assignments/arp-parameters/arp-parameters.xhtml
	36	*
	37	* Some of the more obviously defunct technologies left out.
	38	*/
	39	enum zebra_link_type {
	40	ZEBRA_LLT_UNKNOWN = 0,
	41	ZEBRA_LLT_ETHER,
	42	ZEBRA_LLT_EETHER,
	43	ZEBRA_LLT_AX25,
	44	ZEBRA_LLT_PRONET,
	45	ZEBRA_LLT_IEEE802,
	46	ZEBRA_LLT_ARCNET,
	47	ZEBRA_LLT_APPLETLK,
	48	ZEBRA_LLT_DLCI,
	49	ZEBRA_LLT_ATM,
	50	ZEBRA_LLT_METRICOM,
	51	ZEBRA_LLT_IEEE1394,
	52	ZEBRA_LLT_EUI64,
	53	ZEBRA_LLT_INFINIBAND,
	54	ZEBRA_LLT_SLIP,
	55	ZEBRA_LLT_CSLIP,
	56	ZEBRA_LLT_SLIP6,
	57	ZEBRA_LLT_CSLIP6,
	58	ZEBRA_LLT_RSRVD,
	59	ZEBRA_LLT_ADAPT,
	60	ZEBRA_LLT_ROSE,
	61	ZEBRA_LLT_X25,
	62	ZEBRA_LLT_PPP,
	63	ZEBRA_LLT_CHDLC,
	64	ZEBRA_LLT_LAPB,
	65	ZEBRA_LLT_RAWHDLC,
	66	ZEBRA_LLT_IPIP,
	67	ZEBRA_LLT_IPIP6,
	68	ZEBRA_LLT_FRAD,
	69	ZEBRA_LLT_SKIP,
	70	ZEBRA_LLT_LOOPBACK,
	71	ZEBRA_LLT_LOCALTLK,
	72	ZEBRA_LLT_FDDI,
	73	ZEBRA_LLT_SIT,
	74	ZEBRA_LLT_IPDDP,
	75	ZEBRA_LLT_IPGRE,
	76	ZEBRA_LLT_IP6GRE,
	77	ZEBRA_LLT_PIMREG,
	78	ZEBRA_LLT_HIPPI,
	79	ZEBRA_LLT_ECONET,
	80	ZEBRA_LLT_IRDA,
	81	ZEBRA_LLT_FCPP,
	82	ZEBRA_LLT_FCAL,
	83	ZEBRA_LLT_FCPL,
	84	ZEBRA_LLT_FCFABRIC,
	85	ZEBRA_LLT_IEEE802_TR,
	86	ZEBRA_LLT_IEEE80211,
	87	ZEBRA_LLT_IEEE80211_RADIOTAP,
	88	ZEBRA_LLT_IEEE802154,
	89	ZEBRA_LLT_IEEE802154_PHY,
	90	};
	91
718e3744	92	/*
	93	Interface name length.
	94
	95	Linux define value in /usr/include/linux/if.h.
	96	#define IFNAMSIZ 16
	97
	98	FreeBSD define value in /usr/include/net/if.h.
	99	#define IFNAMSIZ 16
	100	*/
	101
	102	#define INTERFACE_NAMSIZ 20
	103	#define INTERFACE_HWADDR_MAX 20
	104
b892f1dd PJ	105	typedef signed int ifindex_t;
b892f1dd PJ	106
718e3744	107	#ifdef HAVE_PROC_NET_DEV
	108	struct if_stats
	109	{
	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;
	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 {
	179	u_int32_t lp_status; /* Status of Link Parameters: */
	180	u_int32_t te_metric; /* Traffic Engineering metric */
b6a9e7b4	181	float default_bw;
16f1b9ee OD	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 (8) */
	185	u_int32_t admin_grp; /* Administrative group */
	186	u_int32_t rmt_as; /* Remote AS number */
	187	struct in_addr rmt_ip; /* Remote IP address */
	188	u_int32_t av_delay; /* Link Average Delay */
	189	u_int32_t min_delay; /* Link Min Delay */
	190	u_int32_t max_delay; /* Link Max Delay */
	191	u_int32_t delay_var; /* Link Delay Variation */
	192	float pkt_loss; /* Link Packet Loss */
	193	float res_bw; /* Residual Bandwidth */
	194	float ava_bw; /* Available Bandwidth */
	195	float use_bw; /* Utilized Bandwidth */
	196	};
	197
	198	#define INTERFACE_LINK_PARAMS_SIZE sizeof(struct if_link_params)
	199	#define HAS_LINK_PARAMS(ifp) ((ifp)->link_params != NULL)
	200
718e3744	201	/* Interface structure */
	202	struct interface
	203	{
d2fc8896	204	/* Interface name. This should probably never be changed after the
	205	interface is created, because the configuration info for this interface
	206	is associated with this structure. For that reason, the interface
	207	should also never be deleted (to avoid losing configuration info).
	208	To delete, just set ifindex to IFINDEX_INTERNAL to indicate that the
	209	interface does not exist in the kernel.
	210	*/
718e3744	211	char name[INTERFACE_NAMSIZ + 1];
718e3744	212
d2fc8896	213	/* Interface index (should be IFINDEX_INTERNAL for non-kernel or
d2fc8896	214	deleted interfaces). */
b892f1dd	215	ifindex_t ifindex;
d2fc8896	216	#define IFINDEX_INTERNAL 0
b892f1dd	217	#define IFINDEX_DELETED INT_MAX
718e3744	218
	219	/* Zebra internal interface status */
	220	u_char status;
	221	#define ZEBRA_INTERFACE_ACTIVE (1 << 0)
	222	#define ZEBRA_INTERFACE_SUB (1 << 1)
2e3b2e47	223	#define ZEBRA_INTERFACE_LINKDETECTION (1 << 2)
c23af4d3	224	#define ZEBRA_INTERFACE_VRF_LOOPBACK (1 << 3)
525c1839	225
718e3744	226	/* Interface flags. */
c77d4546	227	uint64_t flags;
718e3744	228
718e3744	229	/* Interface metric */
d92c729b	230	uint32_t metric;
718e3744	231
eb649b7f	232	/* Interface Speed in Mb/s */
2d7f0d76 DS	233	uint32_t speed;
2d7f0d76 DS	234
718e3744	235	/* Interface MTU. */
c9eca01b	236	unsigned int mtu; /* IPv4 MTU */
c9eca01b	237	unsigned int mtu6; /* IPv6 MTU - probably, but not neccessarily same as mtu */
718e3744	238
8ccc7e80 TT	239	/* Link-layer information and hardware address */
8ccc7e80 TT	240	enum zebra_link_type ll_type;
718e3744	241	u_char hw_addr[INTERFACE_HWADDR_MAX];
718e3744	242	int hw_addr_len;
718e3744	243
	244	/* interface bandwidth, kbits */
	245	unsigned int bandwidth;
	246
16f1b9ee OD	247	/* Link parameters for Traffic Engineering */
	248	struct if_link_params *link_params;
	249
718e3744	250	/* description of the interface. */
	251	char *desc;
	252
	253	/* Distribute list. */
	254	void *distribute_in;
	255	void *distribute_out;
	256
	257	/* Connected address list. */
52dc7ee6	258	struct list *connected;
718e3744	259
a80beece DS	260	/* Neighbor connected address list. */
	261	struct list *nbr_connected;
	262
718e3744	263	/* Daemon specific interface data pointer. */
	264	void *info;
	265
244c1cdc DS	266	char ptm_enable; /* Should we look at ptm_status ? */
	267	char ptm_status;
	268
718e3744	269	/* Statistics fileds. */
	270	#ifdef HAVE_PROC_NET_DEV
	271	struct if_stats stats;
	272	#endif /* HAVE_PROC_NET_DEV */
	273	#ifdef HAVE_NET_RT_IFLIST
	274	struct if_data stats;
	275	#endif /* HAVE_NET_RT_IFLIST */
3968dbf8	276
f93e3f69	277	struct route_node *node;
3968dbf8	278	vrf_id_t vrf_id;
e80e7cce DL	279
e80e7cce DL	280	QOBJ_FIELDS
718e3744	281	};
e80e7cce	282	DECLARE_QOBJ_TYPE(interface)
718e3744	283
	284	/* Connected address structure. */
	285	struct connected
	286	{
	287	/* Attached interface. */
	288	struct interface *ifp;
	289
	290	/* Flags for configuration. */
	291	u_char conf;
	292	#define ZEBRA_IFC_REAL (1 << 0)
	293	#define ZEBRA_IFC_CONFIGURED (1 << 1)
f7f740fe	294	#define ZEBRA_IFC_QUEUED (1 << 2)
9c37851e AS	295	/*
9c37851e AS	296	The ZEBRA_IFC_REAL flag should be set if and only if this address
f7f740fe CF	297	exists in the kernel and is actually usable. (A case where it exists but
f7f740fe CF	298	is not yet usable would be IPv6 with DAD)
9c37851e AS	299	The ZEBRA_IFC_CONFIGURED flag should be set if and only if this address
9c37851e AS	300	was configured by the user from inside quagga.
f7f740fe CF	301	The ZEBRA_IFC_QUEUED flag should be set if and only if the address exists
	302	in the kernel. It may and should be set although the address might not be
	303	usable yet. (compare with ZEBRA_IFC_REAL)
9c37851e	304	*/
718e3744	305
	306	/* Flags for connected address. */
	307	u_char flags;
e4529636 AS	308	#define ZEBRA_IFA_SECONDARY (1 << 0)
e4529636 AS	309	#define ZEBRA_IFA_PEER (1 << 1)
525c1839	310	#define ZEBRA_IFA_UNNUMBERED (1 << 2)
e4529636 AS	311	/* N.B. the ZEBRA_IFA_PEER flag should be set if and only if
	312	a peer address has been configured. If this flag is set,
	313	the destination field must contain the peer address.
	314	Otherwise, if this flag is not set, the destination address
	315	will either contain a broadcast address or be NULL.
	316	*/
718e3744	317
	318	/* Address of connected network. */
	319	struct prefix *address;
e4529636 AS	320
	321	/* Peer or Broadcast address, depending on whether ZEBRA_IFA_PEER is set.
	322	Note: destination may be NULL if ZEBRA_IFA_PEER is not set. */
	323	struct prefix *destination;
718e3744	324
	325	/* Label for Linux 2.2.X and upper. */
	326	char *label;
	327	};
	328
a80beece DS	329	/* Nbr Connected address structure. */
	330	struct nbr_connected
	331	{
	332	/* Attached interface. */
	333	struct interface *ifp;
	334
	335	/* Address of connected network. */
	336	struct prefix *address;
	337	};
	338
e4529636 AS	339	/* Does the destination field contain a peer address? */
	340	#define CONNECTED_PEER(C) CHECK_FLAG((C)->flags, ZEBRA_IFA_PEER)
	341
	342	/* Prefix to insert into the RIB */
	343	#define CONNECTED_PREFIX(C) \
	344	(CONNECTED_PEER(C) ? (C)->destination : (C)->address)
3fb9cd6e	345
e4529636 AS	346	/* Identifying address. We guess that if there's a peer address, but the
	347	local address is in the same prefix, then the local address may be unique. */
	348	#define CONNECTED_ID(C) \
	349	((CONNECTED_PEER(C) && !prefix_match((C)->destination, (C)->address)) ?\
	350	(C)->destination : (C)->address)
3fb9cd6e	351
718e3744	352	/* Interface hook sort. */
	353	#define IF_NEW_HOOK 0
	354	#define IF_DELETE_HOOK 1
	355
	356	/* There are some interface flags which are only supported by some
	357	operating system. */
	358
	359	#ifndef IFF_NOTRAILERS
	360	#define IFF_NOTRAILERS 0x0
	361	#endif /* IFF_NOTRAILERS */
	362	#ifndef IFF_OACTIVE
	363	#define IFF_OACTIVE 0x0
	364	#endif /* IFF_OACTIVE */
	365	#ifndef IFF_SIMPLEX
	366	#define IFF_SIMPLEX 0x0
	367	#endif /* IFF_SIMPLEX */
	368	#ifndef IFF_LINK0
	369	#define IFF_LINK0 0x0
	370	#endif /* IFF_LINK0 */
	371	#ifndef IFF_LINK1
	372	#define IFF_LINK1 0x0
	373	#endif /* IFF_LINK1 */
	374	#ifndef IFF_LINK2
	375	#define IFF_LINK2 0x0
	376	#endif /* IFF_LINK2 */
4ba9b924	377	#ifndef IFF_NOXMIT
	378	#define IFF_NOXMIT 0x0
	379	#endif /* IFF_NOXMIT */
	380	#ifndef IFF_NORTEXCH
	381	#define IFF_NORTEXCH 0x0
	382	#endif /* IFF_NORTEXCH */
	383	#ifndef IFF_IPV4
	384	#define IFF_IPV4 0x0
	385	#endif /* IFF_IPV4 */
	386	#ifndef IFF_IPV6
	387	#define IFF_IPV6 0x0
	388	#endif /* IFF_IPV6 */
	389	#ifndef IFF_VIRTUAL
	390	#define IFF_VIRTUAL 0x0
	391	#endif /* IFF_VIRTUAL */
718e3744	392
718e3744	393	/* Prototypes. */
974fc9d2	394	extern int if_cmp_name_func (char , char );
a349198f	395
16895dbf	396	extern void if_update_to_new_vrf (struct interface *, vrf_id_t vrf_id);
4e5266b8 DS	397	extern struct interface if_create (const char name, int namelen,
4e5266b8 DS	398	vrf_id_t vrf_id);
7e2b7603	399	extern struct interface *if_lookup_by_index (ifindex_t, vrf_id_t vrf_id);
c5e2cb11	400	extern struct interface if_lookup_exact_address (void matchaddr, int family,
95af5f13 DS	401	vrf_id_t vrf_id);
	402	extern struct connected if_lookup_address (void matchaddr, int family,
	403	vrf_id_t vrf_id);
a90607a4	404	extern struct interface if_lookup_prefix (struct prefix prefix,
8736158a FL	405	vrf_id_t vrf_id);
8736158a FL	406
92a57eb2	407	/* These 3 functions are to be used when the ifname argument is terminated
08dbfb69	408	by a '\0' character: */
f8962871	409	extern struct interface if_lookup_by_name_all_vrf (const char ifname);
1306c09a DS	410	extern struct interface if_lookup_by_name (const char ifname,
1306c09a DS	411	vrf_id_t vrf_id);
92a57eb2	412	extern struct interface if_get_by_name (const char ifname,
8736158a FL	413	vrf_id_t vrf_id);
8736158a FL	414
08dbfb69	415	/* For these 2 functions, the namelen argument should be the precise length
	416	of the ifname string (not counting any optional trailing '\0' character).
	417	In most cases, strnlen should be used to calculate the namelen value. */
fa787f91 DS	418	extern struct interface if_lookup_by_name_len(const char ifname,
fa787f91 DS	419	size_t namelen, vrf_id_t vrf_id);
07a112a1	420	extern struct interface if_get_by_name_len(const char ifname,
85f9da7f	421	size_t namelen, vrf_id_t vrf_id, int vty);
a349198f	422
a349198f	423
d2fc8896	424	/* Delete the interface, but do not free the structure, and leave it in the
	425	interface list. It is often advisable to leave the pseudo interface
	426	structure because there may be configuration information attached. */
	427	extern void if_delete_retain (struct interface *);
	428
	429	/* Delete and free the interface structure: calls if_delete_retain and then
	430	deletes it from the interface list and frees the structure. */
	431	extern void if_delete (struct interface *);
	432
8cc4198f	433	extern int if_is_up (struct interface *);
	434	extern int if_is_running (struct interface *);
	435	extern int if_is_operative (struct interface *);
244c1cdc	436	extern int if_is_no_ptm_operative (struct interface *);
8cc4198f	437	extern int if_is_loopback (struct interface *);
	438	extern int if_is_broadcast (struct interface *);
	439	extern int if_is_pointopoint (struct interface *);
	440	extern int if_is_multicast (struct interface *);
	441	extern void if_add_hook (int, int ()(struct interface ));
b2d7c082	442	extern void if_init (struct list **);
0b84f294	443	extern void if_cmd_init (void);
b2d7c082	444	extern void if_terminate (struct list **);
8cc4198f	445	extern void if_dump_all (void);
847947f2	446	extern const char *if_flag_dump(unsigned long);
8ccc7e80	447	extern const char *if_link_type_str (enum zebra_link_type);
718e3744	448
d2fc8896	449	/* Please use ifindex2ifname instead of if_indextoname where possible;
	450	ifindex2ifname uses internal interface info, whereas if_indextoname must
	451	make a system call. */
baaea325	452	extern const char *ifindex2ifname (ifindex_t, vrf_id_t vrf_id);
d2fc8896	453
	454	/* Please use ifname2ifindex instead of if_nametoindex where possible;
	455	ifname2ifindex uses internal interface info, whereas if_nametoindex must
	456	make a system call. */
128c2be2	457	extern ifindex_t ifname2ifindex(const char *ifname, vrf_id_t vrf_id);
d2fc8896	458
718e3744	459	/* Connected address functions. */
8cc4198f	460	extern struct connected *connected_new (void);
	461	extern void connected_free (struct connected *);
	462	extern void connected_add (struct interface , struct connected );
	463	extern struct connected connected_add_by_prefix (struct interface ,
4a7aac1b	464	struct prefix *,
4a7aac1b	465	struct prefix *);
8cc4198f	466	extern struct connected connected_delete_by_prefix (struct interface ,
4a7aac1b	467	struct prefix *);
bd40c341 DS	468	extern struct connected connected_lookup_prefix (struct interface ,
bd40c341 DS	469	struct prefix *);
38485402 DS	470	extern struct connected connected_lookup_prefix_exact (struct interface ,
38485402 DS	471	struct prefix *);
a80beece DS	472	extern struct nbr_connected *nbr_connected_new (void);
	473	extern void nbr_connected_free (struct nbr_connected *);
	474	struct nbr_connected nbr_connected_check (struct interface , struct prefix *);
718e3744	475
16f1b9ee OD	476	/* link parameters */
	477	struct if_link_params if_link_params_get (struct interface );
	478	void if_link_params_free (struct interface *);
	479
718e3744	480	#endif /* _ZEBRA_IF_H */