epoc32/include/stdapis/net/route.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*-
     2  * 
     3  * Copyright (c) 1980, 1986, 1993
     4  *	The Regents of the University of California.  All rights reserved.
     5  * Redistribution and use in source and binary forms, with or without
     6  * modification, are permitted provided that the following conditions
     7  * are met:
     8  * 1. Redistributions of source code must retain the above copyright
     9  *    notice, this list of conditions and the following disclaimer.
    10  * 2. Redistributions in binary form must reproduce the above copyright
    11  *    notice, this list of conditions and the following disclaimer in the
    12  *    documentation and/or other materials provided with the distribution.
    13  * 4. Neither the name of the University nor the names of its contributors
    14  *    may be used to endorse or promote products derived from this software
    15  *    without specific prior written permission.
    16  *
    17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    27  * SUCH DAMAGE.
    28  *
    29  * Portions Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
    30  *	@(#)route.h	8.4 (Berkeley) 1/9/95
    31  * $FreeBSD: src/sys/net/route.h,v 1.63 2005/01/07 01:45:35 imp Exp $
    32  */
    33 
    34 #ifndef _NET_ROUTE_H_
    35 #define _NET_ROUTE_H_
    36 
    37 #ifndef __SYMBIAN32__
    38 /*
    39  * Kernel resident routing tables.
    40  *
    41  * The routing tables are initialized when interface addresses
    42  * are set by making entries for all directly connected interfaces.
    43  */
    44 
    45 /*
    46  * A route consists of a destination address and a reference
    47  * to a routing entry.  These are often held by protocols
    48  * in their control blocks, e.g. inpcb.
    49  */
    50 struct route {
    51 	struct	rtentry *ro_rt;
    52 	struct	sockaddr ro_dst;
    53 };
    54 #endif //__SYMBIAN32__
    55 /*
    56  * These numbers are used by reliable protocols for determining
    57  * retransmission behavior and are included in the routing structure.
    58  */
    59 struct rt_metrics_lite {
    60 	u_long	rmx_mtu;	/* MTU for this path */
    61 	u_long	rmx_expire;	/* lifetime for route, e.g. redirect */
    62 	u_long	rmx_pksent;	/* packets sent using this route */
    63 };
    64 
    65 struct rt_metrics {
    66 	u_long	rmx_locks;	/* Kernel must leave these values alone */
    67 	u_long	rmx_mtu;	/* MTU for this path */
    68 	u_long	rmx_hopcount;	/* max hops expected */
    69 	u_long	rmx_expire;	/* lifetime for route, e.g. redirect */
    70 	u_long	rmx_recvpipe;	/* inbound delay-bandwidth product */
    71 	u_long	rmx_sendpipe;	/* outbound delay-bandwidth product */
    72 	u_long	rmx_ssthresh;	/* outbound gateway buffer limit */
    73 	u_long	rmx_rtt;	/* estimated round trip time */
    74 	u_long	rmx_rttvar;	/* estimated rtt variance */
    75 	u_long	rmx_pksent;	/* packets sent using this route */
    76 	u_long	rmx_filler[4];	/* will be used for T/TCP later */
    77 };
    78 
    79 /*
    80  * rmx_rtt and rmx_rttvar are stored as microseconds;
    81  * RTTTOPRHZ(rtt) converts to a value suitable for use
    82  * by a protocol slowtimo counter.
    83  */
    84 #define	RTM_RTTUNIT	1000000	/* units for rtt, rttvar, as units per sec */
    85 #define	RTTTOPRHZ(r)	((r) / (RTM_RTTUNIT / PR_SLOWHZ))
    86 
    87 /*
    88  * XXX kernel function pointer `rt_output' is visible to applications.
    89  */
    90 struct mbuf;
    91 
    92 /*
    93  * We distinguish between routes to hosts and routes to networks,
    94  * preferring the former if available.  For each route we infer
    95  * the interface to use from the gateway address supplied when
    96  * the route was entered.  Routes that forward packets through
    97  * gateways are marked so that the output routines know to address the
    98  * gateway rather than the ultimate destination.
    99  */
   100 #ifndef RNF_NORMAL
   101 #include <stdapis/net/radix.h>
   102 #endif
   103 struct rtentry {
   104 	struct	radix_node rt_nodes[2];	/* tree glue, and other values */
   105 	/*
   106 	 * XXX struct rtentry must begin with a struct radix_node (or two!)
   107 	 * because the code does some casts of a 'struct radix_node *'
   108 	 * to a 'struct rtentry *'
   109 	 */
   110 #define	rt_key(r)	(*((struct sockaddr **)(&(r)->rt_nodes->rn_key)))
   111 #define	rt_mask(r)	(*((struct sockaddr **)(&(r)->rt_nodes->rn_mask)))
   112 #ifndef __SYMBIAN32__	 
   113 	struct	sockaddr *rt_gateway;	/* value */
   114 #endif //__SYMBIAN32__	 
   115 	u_long	rt_flags;		/* up/down?, host/net */
   116 	struct	ifnet *rt_ifp;		/* the answer: interface to use */
   117 	struct	ifaddr *rt_ifa;		/* the answer: interface address to use */
   118 	struct	rt_metrics_lite rt_rmx;	/* metrics used by rx'ing protocols */
   119 	long	rt_refcnt;		/* # held references */
   120 #ifndef __SYMBIAN32__
   121 	struct	sockaddr *rt_genmask;	/* for generation of cloned routes */
   122 #endif	
   123 	caddr_t	rt_llinfo;		/* pointer to link level info cache */
   124 	struct	rtentry *rt_gwroute;	/* implied entry for gatewayed routes */
   125 	struct	rtentry *rt_parent; 	/* cloning parent of this route */
   126 #ifdef _KERNEL
   127 	/* XXX ugly, user apps use this definition but don't have a mtx def */
   128 	struct	mtx rt_mtx;		/* mutex for routing entry */
   129 #endif
   130 
   131 /*to be compatible with linux */
   132 #ifdef __SYMBIAN32__
   133     struct sockaddr rt_gateway;     /* Gateway addr (RTF_GATEWAY).  */
   134     char *rt_dev;           /* Forcing the device at add.  */		    
   135 	struct sockaddr rt_genmask;     /* Target network mask (IP).  */    
   136 	short int rt_metric;        /* +1 for binary compatibility!  */    
   137     struct sockaddr rt_dst;     /* Target address.  */
   138 #endif //__SYMBIAN32__  
   139 };
   140 
   141 #define	RTF_UP		0x1		/* route usable */
   142 #define	RTF_GATEWAY	0x2		/* destination is a gateway */
   143 #define	RTF_HOST	0x4		/* host entry (net otherwise) */
   144 #define	RTF_DYNAMIC	0x10		/* created dynamically (by redirect) */
   145 #define RTF_STATIC	0x800		/* manually added */
   146 
   147 #ifndef __SYMBIAN32__
   148 /*
   149  * Following structure necessary for 4.3 compatibility;
   150  * We should eventually move it to a compat file.
   151  */
   152 struct ortentry {
   153 	u_long	rt_hash;		/* to speed lookups */
   154 	struct	sockaddr rt_dst;	/* key */
   155 	struct	sockaddr rt_gateway;	/* value */
   156 	short	rt_flags;		/* up/down?, host/net */
   157 	short	rt_refcnt;		/* # held references */
   158 	u_long	rt_use;			/* raw # packets forwarded */
   159 	struct	ifnet *rt_ifp;		/* the answer: interface to use */
   160 };
   161 
   162 #define rt_use rt_rmx.rmx_pksent
   163 
   164 #define	RTF_UP		0x1		/* route usable */
   165 #define	RTF_GATEWAY	0x2		/* destination is a gateway */
   166 #define	RTF_HOST	0x4		/* host entry (net otherwise) */
   167 #define	RTF_REJECT	0x8		/* host or net unreachable */
   168 #define	RTF_DYNAMIC	0x10		/* created dynamically (by redirect) */
   169 #define	RTF_MODIFIED	0x20		/* modified dynamically (by redirect) */
   170 #define RTF_DONE	0x40		/* message confirmed */
   171 /*			0x80		   unused, was RTF_DELCLONE */
   172 #define RTF_CLONING	0x100		/* generate new routes on use */
   173 #define RTF_XRESOLVE	0x200		/* external daemon resolves name */
   174 #define RTF_LLINFO	0x400		/* generated by link layer (e.g. ARP) */
   175 #define RTF_STATIC	0x800		/* manually added */
   176 #define RTF_BLACKHOLE	0x1000		/* just discard pkts (during updates) */
   177 #define RTF_PROTO2	0x4000		/* protocol specific routing flag */
   178 #define RTF_PROTO1	0x8000		/* protocol specific routing flag */
   179 
   180 /* XXX: temporary to stay API/ABI compatible with userland */
   181 #ifndef _KERNEL
   182 #define RTF_PRCLONING	0x10000		/* unused, for compatibility */
   183 #endif
   184 
   185 #define RTF_WASCLONED	0x20000		/* route generated through cloning */
   186 #define RTF_PROTO3	0x40000		/* protocol specific routing flag */
   187 /*			0x80000		   unused */
   188 #define RTF_PINNED	0x100000	/* future use */
   189 #define	RTF_LOCAL	0x200000 	/* route represents a local address */
   190 #define	RTF_BROADCAST	0x400000	/* route represents a bcast address */
   191 #define	RTF_MULTICAST	0x800000	/* route represents a mcast address */
   192 					/* 0x1000000 and up unassigned */
   193 
   194 /*
   195  * Routing statistics.
   196  */
   197 struct	rtstat {
   198 	short	rts_badredirect;	/* bogus redirect calls */
   199 	short	rts_dynamic;		/* routes created by redirects */
   200 	short	rts_newgateway;		/* routes modified by redirects */
   201 	short	rts_unreach;		/* lookups which failed */
   202 	short	rts_wildcard;		/* lookups satisfied by a wildcard */
   203 };
   204 /*
   205  * Structures for routing messages.
   206  */
   207 struct rt_msghdr {
   208 	u_short	rtm_msglen;	/* to skip over non-understood messages */
   209 	u_char	rtm_version;	/* future binary compatibility */
   210 	u_char	rtm_type;	/* message type */
   211 	u_short	rtm_index;	/* index for associated ifp */
   212 	int	rtm_flags;	/* flags, incl. kern & message, e.g. DONE */
   213 	int	rtm_addrs;	/* bitmask identifying sockaddrs in msg */
   214 	pid_t	rtm_pid;	/* identify sender */
   215 	int	rtm_seq;	/* for sender to identify action */
   216 	int	rtm_errno;	/* why failed */
   217 	int	rtm_use;	/* from rtentry */
   218 	u_long	rtm_inits;	/* which metrics we are initializing */
   219 	struct	rt_metrics rtm_rmx; /* metrics themselves */
   220 };
   221 
   222 #define RTM_VERSION	5	/* Up the ante and ignore older versions */
   223 
   224 /*
   225  * Message types.
   226  */
   227 #define RTM_ADD		0x1	/* Add Route */
   228 #define RTM_DELETE	0x2	/* Delete Route */
   229 #define RTM_CHANGE	0x3	/* Change Metrics or flags */
   230 #define RTM_GET		0x4	/* Report Metrics */
   231 #define RTM_LOSING	0x5	/* Kernel Suspects Partitioning */
   232 #define RTM_REDIRECT	0x6	/* Told to use different route */
   233 #define RTM_MISS	0x7	/* Lookup failed on this address */
   234 #define RTM_LOCK	0x8	/* fix specified metrics */
   235 #define RTM_OLDADD	0x9	/* caused by SIOCADDRT */
   236 #define RTM_OLDDEL	0xa	/* caused by SIOCDELRT */
   237 #define RTM_RESOLVE	0xb	/* req to resolve dst to LL addr */
   238 #define RTM_NEWADDR	0xc	/* address being added to iface */
   239 #define RTM_DELADDR	0xd	/* address being removed from iface */
   240 #define RTM_IFINFO	0xe	/* iface going up/down etc. */
   241 #define	RTM_NEWMADDR	0xf	/* mcast group membership being added to if */
   242 #define	RTM_DELMADDR	0x10	/* mcast group membership being deleted */
   243 #define	RTM_IFANNOUNCE	0x11	/* iface arrival/departure */
   244 #define	RTM_IEEE80211	0x12	/* IEEE80211 wireless event */
   245 
   246 /*
   247  * Bitmask values for rtm_inits and rmx_locks.
   248  */
   249 #define RTV_MTU		0x1	/* init or lock _mtu */
   250 #define RTV_HOPCOUNT	0x2	/* init or lock _hopcount */
   251 #define RTV_EXPIRE	0x4	/* init or lock _expire */
   252 #define RTV_RPIPE	0x8	/* init or lock _recvpipe */
   253 #define RTV_SPIPE	0x10	/* init or lock _sendpipe */
   254 #define RTV_SSTHRESH	0x20	/* init or lock _ssthresh */
   255 #define RTV_RTT		0x40	/* init or lock _rtt */
   256 #define RTV_RTTVAR	0x80	/* init or lock _rttvar */
   257 
   258 /*
   259  * Bitmask values for rtm_addrs.
   260  */
   261 #define RTA_DST		0x1	/* destination sockaddr present */
   262 #define RTA_GATEWAY	0x2	/* gateway sockaddr present */
   263 #define RTA_NETMASK	0x4	/* netmask sockaddr present */
   264 #define RTA_GENMASK	0x8	/* cloning mask sockaddr present */
   265 #define RTA_IFP		0x10	/* interface name sockaddr present */
   266 #define RTA_IFA		0x20	/* interface addr sockaddr present */
   267 #define RTA_AUTHOR	0x40	/* sockaddr for author of redirect */
   268 #define RTA_BRD		0x80	/* for NEWADDR, broadcast or p-p dest addr */
   269 
   270 /*
   271  * Index offsets for sockaddr array for alternate internal encoding.
   272  */
   273 #define RTAX_DST	0	/* destination sockaddr present */
   274 #define RTAX_GATEWAY	1	/* gateway sockaddr present */
   275 #define RTAX_NETMASK	2	/* netmask sockaddr present */
   276 #define RTAX_GENMASK	3	/* cloning mask sockaddr present */
   277 #define RTAX_IFP	4	/* interface name sockaddr present */
   278 #define RTAX_IFA	5	/* interface addr sockaddr present */
   279 #define RTAX_AUTHOR	6	/* sockaddr for author of redirect */
   280 #define RTAX_BRD	7	/* for NEWADDR, broadcast or p-p dest addr */
   281 #define RTAX_MAX	8	/* size of array to allocate */
   282 
   283 struct rt_addrinfo {
   284 	int	rti_addrs;
   285 	struct	sockaddr *rti_info[RTAX_MAX];
   286 	int	rti_flags;
   287 	struct	ifaddr *rti_ifa;
   288 	struct	ifnet *rti_ifp;
   289 };
   290 
   291 /*
   292  * This macro returns the size of a struct sockaddr when passed
   293  * through a routing socket. Basically we round up sa_len to
   294  * a multiple of sizeof(long), with a minimum of sizeof(long).
   295  * The check for a NULL pointer is just a convenience, probably never used.
   296  * The case sa_len == 0 should only apply to empty structures.
   297  */
   298 #define SA_SIZE(sa)						\
   299     (  (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ?	\
   300 	sizeof(long)		:				\
   301 	1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) )
   302 
   303 #ifdef _KERNEL
   304 
   305 #define	RT_LOCK_INIT(_rt) \
   306 	mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK)
   307 #define	RT_LOCK(_rt)		mtx_lock(&(_rt)->rt_mtx)
   308 #define	RT_UNLOCK(_rt)		mtx_unlock(&(_rt)->rt_mtx)
   309 #define	RT_LOCK_DESTROY(_rt)	mtx_destroy(&(_rt)->rt_mtx)
   310 #define	RT_LOCK_ASSERT(_rt)	mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
   311 
   312 #define	RT_ADDREF(_rt)	do {					\
   313 	RT_LOCK_ASSERT(_rt);					\
   314 	KASSERT((_rt)->rt_refcnt >= 0,				\
   315 		("negative refcnt %ld", (_rt)->rt_refcnt));	\
   316 	(_rt)->rt_refcnt++;					\
   317 } while (0);
   318 #define	RT_REMREF(_rt)	do {					\
   319 	RT_LOCK_ASSERT(_rt);					\
   320 	KASSERT((_rt)->rt_refcnt > 0,				\
   321 		("bogus refcnt %ld", (_rt)->rt_refcnt));	\
   322 	(_rt)->rt_refcnt--;					\
   323 } while (0);
   324 
   325 #define	RTFREE_LOCKED(_rt) do {					\
   326 		if ((_rt)->rt_refcnt <= 1)			\
   327 			rtfree(_rt);				\
   328 		else {						\
   329 			RT_REMREF(_rt);				\
   330 			RT_UNLOCK(_rt);				\
   331 		}						\
   332 		/* guard against invalid refs */		\
   333 		_rt = 0;					\
   334 	} while (0)
   335 #define	RTFREE(_rt) do {					\
   336 		RT_LOCK(_rt);					\
   337 		RTFREE_LOCKED(_rt);				\
   338 	} while (0)
   339 
   340 extern struct radix_node_head *rt_tables[AF_MAX+1];
   341 
   342 struct ifmultiaddr;
   343 
   344 #endif
   345 #endif //__SYMBIAN32__
   346 #endif