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