[mirror_frr.git] / zebra / interface.h

/* Interface function header.
 * Copyright (C) 1999 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 GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.  
 */

#ifndef _ZEBRA_INTERFACE_H
#define _ZEBRA_INTERFACE_H

#include "redistribute.h"

#ifdef HAVE_IRDP
#include "zebra/irdp.h"
#endif

/* For interface multicast configuration. */
#define IF_ZEBRA_MULTICAST_UNSPEC 0
#define IF_ZEBRA_MULTICAST_ON     1
#define IF_ZEBRA_MULTICAST_OFF    2

/* For interface shutdown configuration. */
#define IF_ZEBRA_SHUTDOWN_UNSPEC 0
#define IF_ZEBRA_SHUTDOWN_ON     1
#define IF_ZEBRA_SHUTDOWN_OFF    2

/* Router advertisement feature. */
#if (defined(LINUX_IPV6) && (defined(__GLIBC__) && __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 1)) || defined(KAME)
  #ifdef HAVE_RTADV
    #define RTADV
  #endif
#endif

#ifdef RTADV
/* Router advertisement parameter.  From RFC2461 and RFC3775. */
struct rtadvconf
{
  /* A flag indicating whether or not the router sends periodic Router
     Advertisements and responds to Router Solicitations.
     Default: FALSE */
  int AdvSendAdvertisements;

  /* The maximum time allowed between sending unsolicited multicast
     Router Advertisements from the interface, in milliseconds.
     MUST be no less than 70 ms (RFC3775, section 7.4) and no greater 
     than 1800000 ms (See RFC2461).

     Default: 600000 milliseconds */
  int MaxRtrAdvInterval;
#define RTADV_MAX_RTR_ADV_INTERVAL 600000

  /* The minimum time allowed between sending unsolicited multicast
     Router Advertisements from the interface, in milliseconds.
     MUST be no less than 30 ms (See RFC3775, section 7.4). 
     MUST be no greater than .75 * MaxRtrAdvInterval.

     Default: 0.33 * MaxRtrAdvInterval */
  int MinRtrAdvInterval;
#define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)

  /* Unsolicited Router Advertisements' interval timer. */
  int AdvIntervalTimer;

  /* The TRUE/FALSE value to be placed in the "Managed address
     configuration" flag field in the Router Advertisement.  See
     [ADDRCONF].
 
     Default: FALSE */
  int AdvManagedFlag;


  /* The TRUE/FALSE value to be placed in the "Other stateful
     configuration" flag field in the Router Advertisement.  See
     [ADDRCONF].

     Default: FALSE */
  int AdvOtherConfigFlag;

  /* The value to be placed in MTU options sent by the router.  A
     value of zero indicates that no MTU options are sent.

     Default: 0 */
  int AdvLinkMTU;


  /* The value to be placed in the Reachable Time field in the Router
     Advertisement messages sent by the router.  The value zero means
     unspecified (by this router).  MUST be no greater than 3,600,000
     milliseconds (1 hour).

     Default: 0 */
  u_int32_t AdvReachableTime;
#define RTADV_MAX_REACHABLE_TIME 3600000


  /* The value to be placed in the Retrans Timer field in the Router
     Advertisement messages sent by the router.  The value zero means
     unspecified (by this router).

     Default: 0 */
  int AdvRetransTimer;

  /* The default value to be placed in the Cur Hop Limit field in the
     Router Advertisement messages sent by the router.  The value
     should be set to that current diameter of the Internet.  The
     value zero means unspecified (by this router).

     Default: The value specified in the "Assigned Numbers" RFC
     [ASSIGNED] that was in effect at the time of implementation. */
  int AdvCurHopLimit;

  /* The value to be placed in the Router Lifetime field of Router
     Advertisements sent from the interface, in seconds.  MUST be
     either zero or between MaxRtrAdvInterval and 9000 seconds.  A
     value of zero indicates that the router is not to be used as a
     default router.

     Default: 3 * MaxRtrAdvInterval */
  int AdvDefaultLifetime;
#define RTADV_ADV_DEFAULT_LIFETIME (3 * RTADV_MAX_RTR_ADV_INTERVAL)


  /* A list of prefixes to be placed in Prefix Information options in
     Router Advertisement messages sent from the interface.

     Default: all prefixes that the router advertises via routing
     protocols as being on-link for the interface from which the
     advertisement is sent. The link-local prefix SHOULD NOT be
     included in the list of advertised prefixes. */
  struct list *AdvPrefixList;

  /* The TRUE/FALSE value to be placed in the "Home agent"
     flag field in the Router Advertisement.  See [RFC3775 7.1].

     Default: FALSE */
  int AdvHomeAgentFlag;
#ifndef ND_RA_FLAG_HOME_AGENT
#define ND_RA_FLAG_HOME_AGENT 	0x20
#endif

  /* The value to be placed in Home Agent Information option if Home 
     Flag is set.
     Default: 0 */
  int HomeAgentPreference;

  /* The value to be placed in Home Agent Information option if Home 
     Flag is set. Lifetime (seconds) MUST not be greater than 18.2 
     hours. 
     The value 0 has special meaning: use of AdvDefaultLifetime value.
     
     Default: 0 */
  int HomeAgentLifetime;
#define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */

  /* The TRUE/FALSE value to insert or not an Advertisement Interval
     option. See [RFC 3775 7.3]

     Default: FALSE */
  int AdvIntervalOption;
};

#endif /* RTADV */

/* `zebra' daemon local interface structure. */
struct zebra_if
{
  /* Shutdown configuration. */
  u_char shutdown;

  /* Multicast configuration. */
  u_char multicast;

  /* Router advertise configuration. */
  u_char rtadv_enable;

  /* Interface's address. */
  struct list *address;

  /* Installed addresses chains tree. */
  struct route_table *ipv4_subnets;

#ifdef RTADV
  struct rtadvconf rtadv;
#endif /* RTADV */

#ifdef HAVE_IRDP
  struct irdp_interface irdp;
#endif

};

extern void if_delete_update (struct interface *ifp);
extern void if_add_update (struct interface *ifp);
extern void if_up (struct interface *);
extern void if_down (struct interface *);
extern void if_refresh (struct interface *);
extern int if_subnet_add (struct interface *, struct connected *);
extern int if_subnet_delete (struct interface *, struct connected *);

#ifdef HAVE_PROC_NET_DEV
extern int ifstat_update_proc (void);
#endif /* HAVE_PROC_NET_DEV */
#ifdef HAVE_NET_RT_IFLIST
extern void ifstat_update_sysctl (void);

#endif /* HAVE_NET_RT_IFLIST */
#ifdef HAVE_PROC_NET_DEV
extern int interface_list_proc (void);
#endif /* HAVE_PROC_NET_DEV */
#ifdef HAVE_PROC_NET_IF_INET6
extern int ifaddr_proc_ipv6 (void);
#endif /* HAVE_PROC_NET_IF_INET6 */

#ifdef BSDI
extern int if_kvm_get_mtu (struct interface *);
#endif /* BSDI */

#endif /* _ZEBRA_INTERFACE_H */
Commit	Line	Data
718e3744	1	/* Interface function header.
	2	* Copyright (C) 1999 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 it
	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2, or (at your option) any
	9	* 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
	17	* along with GNU Zebra; see the file COPYING. If not, write to the Free
	18	* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
	19	* 02111-1307, USA.
	20	*/
	21
5b73a671	22	#ifndef _ZEBRA_INTERFACE_H
	23	#define _ZEBRA_INTERFACE_H
	24
	25	#include "redistribute.h"
	26
ca776988	27	#ifdef HAVE_IRDP
	28	#include "zebra/irdp.h"
	29	#endif
	30
718e3744	31	/* For interface multicast configuration. */
	32	#define IF_ZEBRA_MULTICAST_UNSPEC 0
	33	#define IF_ZEBRA_MULTICAST_ON 1
	34	#define IF_ZEBRA_MULTICAST_OFF 2
	35
	36	/* For interface shutdown configuration. */
	37	#define IF_ZEBRA_SHUTDOWN_UNSPEC 0
	38	#define IF_ZEBRA_SHUTDOWN_ON 1
	39	#define IF_ZEBRA_SHUTDOWN_OFF 2
	40
	41	/* Router advertisement feature. */
	42	#if (defined(LINUX_IPV6) && (defined(__GLIBC__) && __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 1)) \|\| defined(KAME)
726f9b2b	43	#ifdef HAVE_RTADV
	44	#define RTADV
	45	#endif
718e3744	46	#endif
	47
	48	#ifdef RTADV
7cee1bb1	49	/* Router advertisement parameter. From RFC2461 and RFC3775. */
718e3744	50	struct rtadvconf
	51	{
	52	/* A flag indicating whether or not the router sends periodic Router
	53	Advertisements and responds to Router Solicitations.
	54	Default: FALSE */
	55	int AdvSendAdvertisements;
	56
	57	/* The maximum time allowed between sending unsolicited multicast
7cee1bb1	58	Router Advertisements from the interface, in milliseconds.
	59	MUST be no less than 70 ms (RFC3775, section 7.4) and no greater
	60	than 1800000 ms (See RFC2461).
718e3744	61
7cee1bb1	62	Default: 600000 milliseconds */
718e3744	63	int MaxRtrAdvInterval;
7cee1bb1	64	#define RTADV_MAX_RTR_ADV_INTERVAL 600000
718e3744	65
718e3744	66	/* The minimum time allowed between sending unsolicited multicast
7cee1bb1	67	Router Advertisements from the interface, in milliseconds.
	68	MUST be no less than 30 ms (See RFC3775, section 7.4).
	69	MUST be no greater than .75 * MaxRtrAdvInterval.
718e3744	70
	71	Default: 0.33 * MaxRtrAdvInterval */
	72	int MinRtrAdvInterval;
	73	#define RTADV_MIN_RTR_ADV_INTERVAL (0.33 * RTADV_MAX_RTR_ADV_INTERVAL)
	74
	75	/* Unsolicited Router Advertisements' interval timer. */
	76	int AdvIntervalTimer;
	77
	78	/* The TRUE/FALSE value to be placed in the "Managed address
	79	configuration" flag field in the Router Advertisement. See
	80	[ADDRCONF].
	81
	82	Default: FALSE */
	83	int AdvManagedFlag;
	84
	85
	86	/* The TRUE/FALSE value to be placed in the "Other stateful
	87	configuration" flag field in the Router Advertisement. See
	88	[ADDRCONF].
	89
	90	Default: FALSE */
	91	int AdvOtherConfigFlag;
	92
	93	/* The value to be placed in MTU options sent by the router. A
	94	value of zero indicates that no MTU options are sent.
	95
	96	Default: 0 */
	97	int AdvLinkMTU;
	98
	99
	100	/* The value to be placed in the Reachable Time field in the Router
	101	Advertisement messages sent by the router. The value zero means
	102	unspecified (by this router). MUST be no greater than 3,600,000
	103	milliseconds (1 hour).
	104
	105	Default: 0 */
	106	u_int32_t AdvReachableTime;
	107	#define RTADV_MAX_REACHABLE_TIME 3600000
	108
	109
	110	/* The value to be placed in the Retrans Timer field in the Router
	111	Advertisement messages sent by the router. The value zero means
	112	unspecified (by this router).
	113
	114	Default: 0 */
	115	int AdvRetransTimer;
	116
	117	/* The default value to be placed in the Cur Hop Limit field in the
	118	Router Advertisement messages sent by the router. The value
	119	should be set to that current diameter of the Internet. The
	120	value zero means unspecified (by this router).
	121
	122	Default: The value specified in the "Assigned Numbers" RFC
	123	[ASSIGNED] that was in effect at the time of implementation. */
	124	int AdvCurHopLimit;
	125
	126	/* The value to be placed in the Router Lifetime field of Router
	127	Advertisements sent from the interface, in seconds. MUST be
	128	either zero or between MaxRtrAdvInterval and 9000 seconds. A
	129	value of zero indicates that the router is not to be used as a
	130	default router.
	131
	132	Default: 3 * MaxRtrAdvInterval */
	133	int AdvDefaultLifetime;
134	#define RTADV_ADV_DEFAULT_LIFETIME (3 * RTADV_MAX_RTR_ADV_INTERVAL)
135
136
137	/* A list of prefixes to be placed in Prefix Information options in
138	Router Advertisement messages sent from the interface.
139
140	Default: all prefixes that the router advertises via routing
141	protocols as being on-link for the interface from which the
142	advertisement is sent. The link-local prefix SHOULD NOT be
143	included in the list of advertised prefixes. */
52dc7ee6	144	struct list *AdvPrefixList;
7cee1bb1	145
	146	/* The TRUE/FALSE value to be placed in the "Home agent"
	147	flag field in the Router Advertisement. See [RFC3775 7.1].
	148
	149	Default: FALSE */
	150	int AdvHomeAgentFlag;
	151	#ifndef ND_RA_FLAG_HOME_AGENT
	152	#define ND_RA_FLAG_HOME_AGENT 0x20
	153	#endif
	154
	155	/* The value to be placed in Home Agent Information option if Home
	156	Flag is set.
	157	Default: 0 */
	158	int HomeAgentPreference;
	159
	160	/* The value to be placed in Home Agent Information option if Home
	161	Flag is set. Lifetime (seconds) MUST not be greater than 18.2
	162	hours.
	163	The value 0 has special meaning: use of AdvDefaultLifetime value.
	164
	165	Default: 0 */
	166	int HomeAgentLifetime;
	167	#define RTADV_MAX_HALIFETIME 65520 /* 18.2 hours */
	168
	169	/* The TRUE/FALSE value to insert or not an Advertisement Interval
	170	option. See [RFC 3775 7.3]
	171
	172	Default: FALSE */
	173	int AdvIntervalOption;
718e3744	174	};
	175
	176	#endif /* RTADV */
	177
	178	/* `zebra' daemon local interface structure. */
	179	struct zebra_if
	180	{
	181	/* Shutdown configuration. */
	182	u_char shutdown;
	183
	184	/* Multicast configuration. */
	185	u_char multicast;
	186
	187	/* Router advertise configuration. */
	188	u_char rtadv_enable;
	189
	190	/* Interface's address. */
52dc7ee6	191	struct list *address;
718e3744	192
eef1fe11	193	/* Installed addresses chains tree. */
	194	struct route_table *ipv4_subnets;
	195
718e3744	196	#ifdef RTADV
	197	struct rtadvconf rtadv;
	198	#endif /* RTADV */
ca776988	199
	200	#ifdef HAVE_IRDP
	201	struct irdp_interface irdp;
	202	#endif
	203
718e3744	204	};
718e3744	205
a1ac18c4	206	extern void if_delete_update (struct interface *ifp);
	207	extern void if_add_update (struct interface *ifp);
	208	extern void if_up (struct interface *);
	209	extern void if_down (struct interface *);
	210	extern void if_refresh (struct interface *);
	211	extern int if_subnet_add (struct interface , struct connected );
	212	extern int if_subnet_delete (struct interface , struct connected );
718e3744	213
718e3744	214	#ifdef HAVE_PROC_NET_DEV
a1ac18c4	215	extern int ifstat_update_proc (void);
718e3744	216	#endif /* HAVE_PROC_NET_DEV */
718e3744	217	#ifdef HAVE_NET_RT_IFLIST
a1ac18c4	218	extern void ifstat_update_sysctl (void);
718e3744	219
	220	#endif /* HAVE_NET_RT_IFLIST */
	221	#ifdef HAVE_PROC_NET_DEV
a1ac18c4	222	extern int interface_list_proc (void);
718e3744	223	#endif /* HAVE_PROC_NET_DEV */
718e3744	224	#ifdef HAVE_PROC_NET_IF_INET6
a1ac18c4	225	extern int ifaddr_proc_ipv6 (void);
718e3744	226	#endif /* HAVE_PROC_NET_IF_INET6 */
	227
	228	#ifdef BSDI
a1ac18c4	229	extern int if_kvm_get_mtu (struct interface *);
718e3744	230	#endif /* BSDI */
5b73a671	231
5b73a671	232	#endif /* _ZEBRA_INTERFACE_H */