sl@0: /*-
sl@0:  * 
sl@0:  * Copyright (c) 1980, 1986, 1993
sl@0:  *	The Regents of the University of California.  All rights reserved.
sl@0:  * Redistribution and use in source and binary forms, with or without
sl@0:  * modification, are permitted provided that the following conditions
sl@0:  * are met:
sl@0:  * 1. Redistributions of source code must retain the above copyright
sl@0:  *    notice, this list of conditions and the following disclaimer.
sl@0:  * 2. Redistributions in binary form must reproduce the above copyright
sl@0:  *    notice, this list of conditions and the following disclaimer in the
sl@0:  *    documentation and/or other materials provided with the distribution.
sl@0:  * 4. Neither the name of the University nor the names of its contributors
sl@0:  *    may be used to endorse or promote products derived from this software
sl@0:  *    without specific prior written permission.
sl@0:  *
sl@0:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
sl@0:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
sl@0:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
sl@0:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
sl@0:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
sl@0:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
sl@0:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
sl@0:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
sl@0:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
sl@0:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
sl@0:  * SUCH DAMAGE.
sl@0:  *
sl@0:  * Portions Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
sl@0:  *	@(#)route.h	8.4 (Berkeley) 1/9/95
sl@0:  * $FreeBSD: src/sys/net/route.h,v 1.63 2005/01/07 01:45:35 imp Exp $
sl@0:  */
sl@0: 
sl@0: #ifndef _NET_ROUTE_H_
sl@0: #define _NET_ROUTE_H_
sl@0: 
sl@0: #ifndef __SYMBIAN32__
sl@0: /*
sl@0:  * Kernel resident routing tables.
sl@0:  *
sl@0:  * The routing tables are initialized when interface addresses
sl@0:  * are set by making entries for all directly connected interfaces.
sl@0:  */
sl@0: 
sl@0: /*
sl@0:  * A route consists of a destination address and a reference
sl@0:  * to a routing entry.  These are often held by protocols
sl@0:  * in their control blocks, e.g. inpcb.
sl@0:  */
sl@0: struct route {
sl@0: 	struct	rtentry *ro_rt;
sl@0: 	struct	sockaddr ro_dst;
sl@0: };
sl@0: #endif //__SYMBIAN32__
sl@0: /*
sl@0:  * These numbers are used by reliable protocols for determining
sl@0:  * retransmission behavior and are included in the routing structure.
sl@0:  */
sl@0: struct rt_metrics_lite {
sl@0: 	u_long	rmx_mtu;	/* MTU for this path */
sl@0: 	u_long	rmx_expire;	/* lifetime for route, e.g. redirect */
sl@0: 	u_long	rmx_pksent;	/* packets sent using this route */
sl@0: };
sl@0: 
sl@0: struct rt_metrics {
sl@0: 	u_long	rmx_locks;	/* Kernel must leave these values alone */
sl@0: 	u_long	rmx_mtu;	/* MTU for this path */
sl@0: 	u_long	rmx_hopcount;	/* max hops expected */
sl@0: 	u_long	rmx_expire;	/* lifetime for route, e.g. redirect */
sl@0: 	u_long	rmx_recvpipe;	/* inbound delay-bandwidth product */
sl@0: 	u_long	rmx_sendpipe;	/* outbound delay-bandwidth product */
sl@0: 	u_long	rmx_ssthresh;	/* outbound gateway buffer limit */
sl@0: 	u_long	rmx_rtt;	/* estimated round trip time */
sl@0: 	u_long	rmx_rttvar;	/* estimated rtt variance */
sl@0: 	u_long	rmx_pksent;	/* packets sent using this route */
sl@0: 	u_long	rmx_filler[4];	/* will be used for T/TCP later */
sl@0: };
sl@0: 
sl@0: /*
sl@0:  * rmx_rtt and rmx_rttvar are stored as microseconds;
sl@0:  * RTTTOPRHZ(rtt) converts to a value suitable for use
sl@0:  * by a protocol slowtimo counter.
sl@0:  */
sl@0: #define	RTM_RTTUNIT	1000000	/* units for rtt, rttvar, as units per sec */
sl@0: #define	RTTTOPRHZ(r)	((r) / (RTM_RTTUNIT / PR_SLOWHZ))
sl@0: 
sl@0: /*
sl@0:  * XXX kernel function pointer `rt_output' is visible to applications.
sl@0:  */
sl@0: struct mbuf;
sl@0: 
sl@0: /*
sl@0:  * We distinguish between routes to hosts and routes to networks,
sl@0:  * preferring the former if available.  For each route we infer
sl@0:  * the interface to use from the gateway address supplied when
sl@0:  * the route was entered.  Routes that forward packets through
sl@0:  * gateways are marked so that the output routines know to address the
sl@0:  * gateway rather than the ultimate destination.
sl@0:  */
sl@0: #ifndef RNF_NORMAL
sl@0: #include <stdapis/net/radix.h>
sl@0: #endif
sl@0: struct rtentry {
sl@0: 	struct	radix_node rt_nodes[2];	/* tree glue, and other values */
sl@0: 	/*
sl@0: 	 * XXX struct rtentry must begin with a struct radix_node (or two!)
sl@0: 	 * because the code does some casts of a 'struct radix_node *'
sl@0: 	 * to a 'struct rtentry *'
sl@0: 	 */
sl@0: #define	rt_key(r)	(*((struct sockaddr **)(&(r)->rt_nodes->rn_key)))
sl@0: #define	rt_mask(r)	(*((struct sockaddr **)(&(r)->rt_nodes->rn_mask)))
sl@0: #ifndef __SYMBIAN32__	 
sl@0: 	struct	sockaddr *rt_gateway;	/* value */
sl@0: #endif //__SYMBIAN32__	 
sl@0: 	u_long	rt_flags;		/* up/down?, host/net */
sl@0: 	struct	ifnet *rt_ifp;		/* the answer: interface to use */
sl@0: 	struct	ifaddr *rt_ifa;		/* the answer: interface address to use */
sl@0: 	struct	rt_metrics_lite rt_rmx;	/* metrics used by rx'ing protocols */
sl@0: 	long	rt_refcnt;		/* # held references */
sl@0: #ifndef __SYMBIAN32__
sl@0: 	struct	sockaddr *rt_genmask;	/* for generation of cloned routes */
sl@0: #endif	
sl@0: 	caddr_t	rt_llinfo;		/* pointer to link level info cache */
sl@0: 	struct	rtentry *rt_gwroute;	/* implied entry for gatewayed routes */
sl@0: 	struct	rtentry *rt_parent; 	/* cloning parent of this route */
sl@0: #ifdef _KERNEL
sl@0: 	/* XXX ugly, user apps use this definition but don't have a mtx def */
sl@0: 	struct	mtx rt_mtx;		/* mutex for routing entry */
sl@0: #endif
sl@0: 
sl@0: /*to be compatible with linux */
sl@0: #ifdef __SYMBIAN32__
sl@0:     struct sockaddr rt_gateway;     /* Gateway addr (RTF_GATEWAY).  */
sl@0:     char *rt_dev;           /* Forcing the device at add.  */		    
sl@0: 	struct sockaddr rt_genmask;     /* Target network mask (IP).  */    
sl@0: 	short int rt_metric;        /* +1 for binary compatibility!  */    
sl@0:     struct sockaddr rt_dst;     /* Target address.  */
sl@0: #endif //__SYMBIAN32__  
sl@0: };
sl@0: 
sl@0: #define	RTF_UP		0x1		/* route usable */
sl@0: #define	RTF_GATEWAY	0x2		/* destination is a gateway */
sl@0: #define	RTF_HOST	0x4		/* host entry (net otherwise) */
sl@0: #define	RTF_DYNAMIC	0x10		/* created dynamically (by redirect) */
sl@0: #define RTF_STATIC	0x800		/* manually added */
sl@0: 
sl@0: #ifndef __SYMBIAN32__
sl@0: /*
sl@0:  * Following structure necessary for 4.3 compatibility;
sl@0:  * We should eventually move it to a compat file.
sl@0:  */
sl@0: struct ortentry {
sl@0: 	u_long	rt_hash;		/* to speed lookups */
sl@0: 	struct	sockaddr rt_dst;	/* key */
sl@0: 	struct	sockaddr rt_gateway;	/* value */
sl@0: 	short	rt_flags;		/* up/down?, host/net */
sl@0: 	short	rt_refcnt;		/* # held references */
sl@0: 	u_long	rt_use;			/* raw # packets forwarded */
sl@0: 	struct	ifnet *rt_ifp;		/* the answer: interface to use */
sl@0: };
sl@0: 
sl@0: #define rt_use rt_rmx.rmx_pksent
sl@0: 
sl@0: #define	RTF_UP		0x1		/* route usable */
sl@0: #define	RTF_GATEWAY	0x2		/* destination is a gateway */
sl@0: #define	RTF_HOST	0x4		/* host entry (net otherwise) */
sl@0: #define	RTF_REJECT	0x8		/* host or net unreachable */
sl@0: #define	RTF_DYNAMIC	0x10		/* created dynamically (by redirect) */
sl@0: #define	RTF_MODIFIED	0x20		/* modified dynamically (by redirect) */
sl@0: #define RTF_DONE	0x40		/* message confirmed */
sl@0: /*			0x80		   unused, was RTF_DELCLONE */
sl@0: #define RTF_CLONING	0x100		/* generate new routes on use */
sl@0: #define RTF_XRESOLVE	0x200		/* external daemon resolves name */
sl@0: #define RTF_LLINFO	0x400		/* generated by link layer (e.g. ARP) */
sl@0: #define RTF_STATIC	0x800		/* manually added */
sl@0: #define RTF_BLACKHOLE	0x1000		/* just discard pkts (during updates) */
sl@0: #define RTF_PROTO2	0x4000		/* protocol specific routing flag */
sl@0: #define RTF_PROTO1	0x8000		/* protocol specific routing flag */
sl@0: 
sl@0: /* XXX: temporary to stay API/ABI compatible with userland */
sl@0: #ifndef _KERNEL
sl@0: #define RTF_PRCLONING	0x10000		/* unused, for compatibility */
sl@0: #endif
sl@0: 
sl@0: #define RTF_WASCLONED	0x20000		/* route generated through cloning */
sl@0: #define RTF_PROTO3	0x40000		/* protocol specific routing flag */
sl@0: /*			0x80000		   unused */
sl@0: #define RTF_PINNED	0x100000	/* future use */
sl@0: #define	RTF_LOCAL	0x200000 	/* route represents a local address */
sl@0: #define	RTF_BROADCAST	0x400000	/* route represents a bcast address */
sl@0: #define	RTF_MULTICAST	0x800000	/* route represents a mcast address */
sl@0: 					/* 0x1000000 and up unassigned */
sl@0: 
sl@0: /*
sl@0:  * Routing statistics.
sl@0:  */
sl@0: struct	rtstat {
sl@0: 	short	rts_badredirect;	/* bogus redirect calls */
sl@0: 	short	rts_dynamic;		/* routes created by redirects */
sl@0: 	short	rts_newgateway;		/* routes modified by redirects */
sl@0: 	short	rts_unreach;		/* lookups which failed */
sl@0: 	short	rts_wildcard;		/* lookups satisfied by a wildcard */
sl@0: };
sl@0: /*
sl@0:  * Structures for routing messages.
sl@0:  */
sl@0: struct rt_msghdr {
sl@0: 	u_short	rtm_msglen;	/* to skip over non-understood messages */
sl@0: 	u_char	rtm_version;	/* future binary compatibility */
sl@0: 	u_char	rtm_type;	/* message type */
sl@0: 	u_short	rtm_index;	/* index for associated ifp */
sl@0: 	int	rtm_flags;	/* flags, incl. kern & message, e.g. DONE */
sl@0: 	int	rtm_addrs;	/* bitmask identifying sockaddrs in msg */
sl@0: 	pid_t	rtm_pid;	/* identify sender */
sl@0: 	int	rtm_seq;	/* for sender to identify action */
sl@0: 	int	rtm_errno;	/* why failed */
sl@0: 	int	rtm_use;	/* from rtentry */
sl@0: 	u_long	rtm_inits;	/* which metrics we are initializing */
sl@0: 	struct	rt_metrics rtm_rmx; /* metrics themselves */
sl@0: };
sl@0: 
sl@0: #define RTM_VERSION	5	/* Up the ante and ignore older versions */
sl@0: 
sl@0: /*
sl@0:  * Message types.
sl@0:  */
sl@0: #define RTM_ADD		0x1	/* Add Route */
sl@0: #define RTM_DELETE	0x2	/* Delete Route */
sl@0: #define RTM_CHANGE	0x3	/* Change Metrics or flags */
sl@0: #define RTM_GET		0x4	/* Report Metrics */
sl@0: #define RTM_LOSING	0x5	/* Kernel Suspects Partitioning */
sl@0: #define RTM_REDIRECT	0x6	/* Told to use different route */
sl@0: #define RTM_MISS	0x7	/* Lookup failed on this address */
sl@0: #define RTM_LOCK	0x8	/* fix specified metrics */
sl@0: #define RTM_OLDADD	0x9	/* caused by SIOCADDRT */
sl@0: #define RTM_OLDDEL	0xa	/* caused by SIOCDELRT */
sl@0: #define RTM_RESOLVE	0xb	/* req to resolve dst to LL addr */
sl@0: #define RTM_NEWADDR	0xc	/* address being added to iface */
sl@0: #define RTM_DELADDR	0xd	/* address being removed from iface */
sl@0: #define RTM_IFINFO	0xe	/* iface going up/down etc. */
sl@0: #define	RTM_NEWMADDR	0xf	/* mcast group membership being added to if */
sl@0: #define	RTM_DELMADDR	0x10	/* mcast group membership being deleted */
sl@0: #define	RTM_IFANNOUNCE	0x11	/* iface arrival/departure */
sl@0: #define	RTM_IEEE80211	0x12	/* IEEE80211 wireless event */
sl@0: 
sl@0: /*
sl@0:  * Bitmask values for rtm_inits and rmx_locks.
sl@0:  */
sl@0: #define RTV_MTU		0x1	/* init or lock _mtu */
sl@0: #define RTV_HOPCOUNT	0x2	/* init or lock _hopcount */
sl@0: #define RTV_EXPIRE	0x4	/* init or lock _expire */
sl@0: #define RTV_RPIPE	0x8	/* init or lock _recvpipe */
sl@0: #define RTV_SPIPE	0x10	/* init or lock _sendpipe */
sl@0: #define RTV_SSTHRESH	0x20	/* init or lock _ssthresh */
sl@0: #define RTV_RTT		0x40	/* init or lock _rtt */
sl@0: #define RTV_RTTVAR	0x80	/* init or lock _rttvar */
sl@0: 
sl@0: /*
sl@0:  * Bitmask values for rtm_addrs.
sl@0:  */
sl@0: #define RTA_DST		0x1	/* destination sockaddr present */
sl@0: #define RTA_GATEWAY	0x2	/* gateway sockaddr present */
sl@0: #define RTA_NETMASK	0x4	/* netmask sockaddr present */
sl@0: #define RTA_GENMASK	0x8	/* cloning mask sockaddr present */
sl@0: #define RTA_IFP		0x10	/* interface name sockaddr present */
sl@0: #define RTA_IFA		0x20	/* interface addr sockaddr present */
sl@0: #define RTA_AUTHOR	0x40	/* sockaddr for author of redirect */
sl@0: #define RTA_BRD		0x80	/* for NEWADDR, broadcast or p-p dest addr */
sl@0: 
sl@0: /*
sl@0:  * Index offsets for sockaddr array for alternate internal encoding.
sl@0:  */
sl@0: #define RTAX_DST	0	/* destination sockaddr present */
sl@0: #define RTAX_GATEWAY	1	/* gateway sockaddr present */
sl@0: #define RTAX_NETMASK	2	/* netmask sockaddr present */
sl@0: #define RTAX_GENMASK	3	/* cloning mask sockaddr present */
sl@0: #define RTAX_IFP	4	/* interface name sockaddr present */
sl@0: #define RTAX_IFA	5	/* interface addr sockaddr present */
sl@0: #define RTAX_AUTHOR	6	/* sockaddr for author of redirect */
sl@0: #define RTAX_BRD	7	/* for NEWADDR, broadcast or p-p dest addr */
sl@0: #define RTAX_MAX	8	/* size of array to allocate */
sl@0: 
sl@0: struct rt_addrinfo {
sl@0: 	int	rti_addrs;
sl@0: 	struct	sockaddr *rti_info[RTAX_MAX];
sl@0: 	int	rti_flags;
sl@0: 	struct	ifaddr *rti_ifa;
sl@0: 	struct	ifnet *rti_ifp;
sl@0: };
sl@0: 
sl@0: /*
sl@0:  * This macro returns the size of a struct sockaddr when passed
sl@0:  * through a routing socket. Basically we round up sa_len to
sl@0:  * a multiple of sizeof(long), with a minimum of sizeof(long).
sl@0:  * The check for a NULL pointer is just a convenience, probably never used.
sl@0:  * The case sa_len == 0 should only apply to empty structures.
sl@0:  */
sl@0: #define SA_SIZE(sa)						\
sl@0:     (  (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ?	\
sl@0: 	sizeof(long)		:				\
sl@0: 	1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) )
sl@0: 
sl@0: #ifdef _KERNEL
sl@0: 
sl@0: #define	RT_LOCK_INIT(_rt) \
sl@0: 	mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK)
sl@0: #define	RT_LOCK(_rt)		mtx_lock(&(_rt)->rt_mtx)
sl@0: #define	RT_UNLOCK(_rt)		mtx_unlock(&(_rt)->rt_mtx)
sl@0: #define	RT_LOCK_DESTROY(_rt)	mtx_destroy(&(_rt)->rt_mtx)
sl@0: #define	RT_LOCK_ASSERT(_rt)	mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
sl@0: 
sl@0: #define	RT_ADDREF(_rt)	do {					\
sl@0: 	RT_LOCK_ASSERT(_rt);					\
sl@0: 	KASSERT((_rt)->rt_refcnt >= 0,				\
sl@0: 		("negative refcnt %ld", (_rt)->rt_refcnt));	\
sl@0: 	(_rt)->rt_refcnt++;					\
sl@0: } while (0);
sl@0: #define	RT_REMREF(_rt)	do {					\
sl@0: 	RT_LOCK_ASSERT(_rt);					\
sl@0: 	KASSERT((_rt)->rt_refcnt > 0,				\
sl@0: 		("bogus refcnt %ld", (_rt)->rt_refcnt));	\
sl@0: 	(_rt)->rt_refcnt--;					\
sl@0: } while (0);
sl@0: 
sl@0: #define	RTFREE_LOCKED(_rt) do {					\
sl@0: 		if ((_rt)->rt_refcnt <= 1)			\
sl@0: 			rtfree(_rt);				\
sl@0: 		else {						\
sl@0: 			RT_REMREF(_rt);				\
sl@0: 			RT_UNLOCK(_rt);				\
sl@0: 		}						\
sl@0: 		/* guard against invalid refs */		\
sl@0: 		_rt = 0;					\
sl@0: 	} while (0)
sl@0: #define	RTFREE(_rt) do {					\
sl@0: 		RT_LOCK(_rt);					\
sl@0: 		RTFREE_LOCKED(_rt);				\
sl@0: 	} while (0)
sl@0: 
sl@0: extern struct radix_node_head *rt_tables[AF_MAX+1];
sl@0: 
sl@0: struct ifmultiaddr;
sl@0: 
sl@0: #endif
sl@0: #endif //__SYMBIAN32__
sl@0: #endif