route.h
上传用户:luoyougen
上传日期:2008-05-12
资源大小:23136k
文件大小:13k
源码类别:

VxWorks

开发平台:

C/C++

  1. /* route.h - routing table header file */
  2. /* Copyright 1984 - 2001 Wind River Systems, Inc. */
  3. /*
  4.  * Copyright (c) 1980, 1986, 1993
  5.  * The Regents of the University of California.  All rights reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 1. Redistributions of source code must retain the above copyright
  11.  *    notice, this list of conditions and the following disclaimer.
  12.  * 2. Redistributions in binary form must reproduce the above copyright
  13.  *    notice, this list of conditions and the following disclaimer in the
  14.  *    documentation and/or other materials provided with the distribution.
  15.  * 3. All advertising materials mentioning features or use of this software
  16.  *    must display the following acknowledgement:
  17.  * This product includes software developed by the University of
  18.  * California, Berkeley and its contributors.
  19.  * 4. Neither the name of the University nor the names of its contributors
  20.  *    may be used to endorse or promote products derived from this software
  21.  *    without specific prior written permission.
  22.  *
  23.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33.  * SUCH DAMAGE.
  34.  *
  35.  * @(#)route.h 8.3 (Berkeley) 4/19/94
  36.  */
  37. /*
  38. modification history
  39. --------------------
  40. 01g,10oct01,rae  merge from truestack (ROUTER_STACK additions)
  41. 01f,07jul97,rjc  revised rt_metrics structure to gain 6 bytes.
  42. 01e,02jul97,vin  added declarations for rtxxMsgHooks removed unnessary global
  43.  declarations
  44. 01d,01jul97,rjc  restored old rtentry structure
  45. 01c,12feb97,rjc  ospf changes.
  46. 01b,05feb97,rjc  tos routing changes.
  47. 01a,03mar96,vin  created from BSD4.4 stuff,integrated with 02i.
  48. */
  49. #ifndef __INCrouteh
  50. #define __INCrouteh
  51. #ifdef __cplusplus
  52. extern "C" {
  53. #endif
  54. #include "net/socketvar.h"
  55. #include "net/radix.h"
  56. #include "net/mbuf.h"
  57. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  58. #pragma align 1                 /* tell gcc960 not to optimize alignments */
  59. #endif /* CPU_FAMILY==I960 */
  60. /*
  61.  * Kernel resident routing tables.
  62.  *
  63.  * The routing tables are initialized when interface addresses
  64.  * are set by making entries for all directly connected interfaces.
  65.  */
  66. /*
  67.  * A route consists of a destination address and a reference
  68.  * to a routing entry.  These are often held by protocols
  69.  * in their control blocks, e.g. inpcb.
  70.  */
  71. struct route
  72.     {
  73.     struct rtentry *ro_rt;
  74.     struct sockaddr ro_dst;
  75.     };
  76. /*
  77.  * These numbers are used by reliable protocols for determining
  78.  * retransmission behavior and are included in the routing structure.
  79.  */
  80. struct rt_metrics {
  81. u_long rmx_locks; /* Kernel must leave these values alone */
  82. u_long rmx_mtu; /* MTU for this path */
  83. u_long rmx_expire; /* lifetime for route, e.g. redirect */
  84. u_long rmx_recvpipe; /* inbound delay-bandwith product */
  85. u_long rmx_sendpipe; /* outbound delay-bandwith product */
  86. u_long rmx_ssthresh; /* outbound gateway buffer limit */
  87. u_long rmx_rtt; /* estimated round trip time */
  88. u_long rmx_rttvar; /* estimated rtt variance */
  89. u_short rmx_hopcount; /* max hops expected */
  90.         u_short rmx_mss;  /* TCP maximum segment size from peer */
  91.         /* Additional WRN metrics for routing protocols */
  92.         long  value1;
  93.         long  value2;
  94.         long  value3;
  95.         long  value4;
  96.         long  value5;
  97.         long  routeTag;
  98.         u_char  weight;
  99. };
  100. /*
  101.  * This expanded "gateway" structure contains the address of the next-hop
  102.  * router and all the new metrics for a route, as well as the protocol
  103.  * identifier which created it. The RTM_GETALL routing socket message
  104.  * contains a list of these structures.
  105.  */
  106. struct sockaddr_gate
  107.     {
  108.     u_char         gate_len;
  109.     u_char         gate_family;
  110.     u_char         routeProto;
  111.     u_char         weight;
  112.     u_long         gate_addr;
  113.     long           value1;
  114.     long           value2;
  115.     long           value3;
  116.     long           value4;
  117.     long           value5;
  118.     long           routeTag;
  119.     };
  120. /*
  121.  * rmx_rtt and rmx_rttvar are stored as microseconds;
  122.  * RTTTOPRHZ(rtt) converts to a value suitable for use
  123.  * by a protocol slowtimo counter.
  124.  */
  125. #define RTM_RTTUNIT 1000000 /* units for rtt, rttvar, as units per sec */
  126. #define RTTTOPRHZ(r) ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
  127. /*
  128.  * We distinguish between routes to hosts and routes to networks,
  129.  * preferring the former if available.  For each route we infer
  130.  * the interface to use from the gateway address supplied when
  131.  * the route was entered.  Routes that forward packets through
  132.  * gateways are marked so that the output routines know to address the
  133.  * gateway rather than the ultimate destination.
  134.  */
  135. #ifndef RNF_NORMAL
  136. #include <net/radix.h>
  137. #endif
  138. struct rtentry {
  139. struct radix_node rt_nodes[2]; /* tree glue, and other values */
  140. #define rt_key(r) ((struct sockaddr *)((r)->rt_nodes->rn_key))
  141. #define rt_mask(r) ((struct sockaddr *)((r)->rt_nodes->rn_mask))
  142. struct sockaddr *rt_gateway; /* value */
  143. short rt_flags; /* up/down?, host/net */
  144. short rt_refcnt; /* # held references */
  145. u_long rt_use; /* raw # packets forwarded */
  146. struct ifnet *rt_ifp; /* the answer: interface to use */
  147. struct ifaddr *rt_ifa; /* the answer: interface to use */
  148. struct sockaddr *rt_genmask; /* for generation of cloned routes */
  149. caddr_t rt_llinfo; /* pointer to link level info cache */
  150. struct rtentry *rt_gwroute; /* implied entry for gatewayed routes */
  151.         int rt_mod; /* last modified XXX */ 
  152. struct rt_metrics rt_rmx; /* metrics used by rx'ing protocols */
  153.         struct  rtentry *rt_parent;     /* parent of route (if cloned) */
  154. };
  155. /*
  156.  * Following structure necessary for 4.3 compatibility;
  157.  * We should eventually move it to a compat file.
  158.  */
  159. struct ortentry {
  160. u_long rt_hash; /* to speed lookups */
  161. struct sockaddr rt_dst; /* key */
  162. struct sockaddr rt_gateway; /* value */
  163. short rt_flags; /* up/down?, host/net */
  164. short rt_refcnt; /* # held references */
  165. u_long rt_use; /* raw # packets forwarded */
  166. struct ifnet *rt_ifp; /* the answer: interface to use */
  167.         int rt_mod; /* last modified */
  168. };
  169. #define RTF_UP 0x1 /* route usable */
  170. #define RTF_GATEWAY 0x2 /* destination is a gateway */
  171. #define RTF_HOST 0x4 /* host entry (net otherwise) */
  172. #define RTF_REJECT 0x8 /* host or net unreachable */
  173. #define RTF_DYNAMIC 0x10 /* created dynamically (by redirect) */
  174. #define RTF_MODIFIED 0x20 /* modified dynamically (by redirect) */
  175. #define RTF_DONE 0x40 /* message confirmed */
  176. #define RTF_MASK 0x80 /* subnet mask present */
  177. #define RTF_CLONING 0x100 /* generate new routes on use */
  178. #define RTF_XRESOLVE 0x200 /* external daemon resolves name */
  179. #define RTF_LLINFO 0x400 /* generated by ARP or ESIS */
  180. #define RTF_STATIC 0x800 /* manually added */
  181. #define RTF_BLACKHOLE 0x1000 /* just discard pkts (during updates) */
  182. #define RTF_PROTO2 0x4000 /* protocol specific routing flag */
  183. #define RTF_PROTO1 0x8000 /* protocol specific routing flag */
  184. #define RTF_MGMT 0x2000 /* modfied by managment proto */
  185. #define RTF_REP_NODE    0x4000         /* Representative Node in the Pat tree */
  186. #define RTF_CLONED RTF_PROTO1     /* Child route holding path MTU results */
  187. #define RTF_DELETE RTF_PROTO2     /* Unused route scheduled for deletion */
  188. /* Routing statistics. */
  189. struct rtstat
  190.     {
  191.     short rts_badredirect; /* bogus redirect calls */
  192.     short rts_dynamic; /* routes created by redirects */
  193.     short rts_newgateway; /* routes modified by redirects */
  194.     short rts_unreach; /* lookups which failed */
  195.     short rts_wildcard; /* lookups satisfied by a wildcard */
  196.     };
  197. /*
  198.  * Structures for routing messages.
  199.  */
  200. struct rt_msghdr {
  201. u_short rtm_msglen; /* to skip over non-understood messages */
  202. u_char rtm_version; /* future binary compatibility */
  203. u_char rtm_type; /* message type */
  204. u_short rtm_index; /* index for associated ifp */
  205. int rtm_flags; /* flags, incl. kern & message, e.g. DONE */
  206. int rtm_addrs; /* bitmask identifying sockaddrs in msg */
  207. pid_t rtm_pid; /* identify sender */
  208. int rtm_seq; /* for sender to identify action */
  209. int rtm_errno; /* why failed */
  210. int rtm_use; /* from rtentry */
  211. u_long rtm_inits; /* which metrics we are initializing */
  212. struct rt_metrics rtm_rmx; /* metrics themselves */
  213. };
  214. #define RTM_VERSION 3 /* Up the ante and ignore older versions */
  215. #define RTM_ADD 0x1 /* Add Route */
  216. #define RTM_DELETE 0x2 /* Delete Route */
  217. #define RTM_CHANGE 0x3 /* Change Metrics or flags */
  218. #define RTM_GET 0x4 /* Report Metrics */
  219. #define RTM_LOSING 0x5 /* Kernel Suspects Partitioning */
  220. #define RTM_REDIRECT 0x6 /* Told to use different route */
  221. #define RTM_MISS 0x7 /* Lookup failed on this address */
  222. #define RTM_LOCK 0x8 /* fix specified metrics */
  223. #define RTM_OLDADD 0x9 /* caused by SIOCADDRT */
  224. #define RTM_OLDDEL 0xa /* caused by SIOCDELRT */
  225. #define RTM_RESOLVE 0xb /* req to resolve dst to LL addr */
  226. #define RTM_NEWADDR 0xc /* address being added to iface */
  227. #define RTM_DELADDR 0xd /* address being removed from iface */
  228. #define RTM_IFINFO 0xe /* iface going up/down etc. */
  229. #ifdef ROUTER_STACK
  230. /* New WRN messages */
  231. #define RTM_ADDEXTRA    0xf     /* Report creation of duplicate route */
  232. #define RTM_DELEXTRA    0x10    /* Report deletion of duplicate route */
  233. #define RTM_NEWCHANGE   0x11    /* Change gateway of duplicate route */
  234. #define RTM_NEWGET      0x12    /* Find any route with gateway */
  235. #define RTM_GETALL  0x13  /* Get IP route to dst and any duplicates */
  236. #define RTM_NEWIPROUTE  0x14  /* Replacement for deleted primary IP route */
  237. #define RTM_OLDIPROUTE  0x15  /* Demoted IP route replaced with new entry */
  238. #endif /* ROUTER_STACK */
  239. #define RTV_MTU 0x1 /* init or lock _mtu */
  240. #define RTV_HOPCOUNT 0x2 /* init or lock _hopcount */
  241. #define RTV_EXPIRE 0x4 /* init or lock _expire */
  242. #define RTV_RPIPE 0x8 /* init or lock _recvpipe */
  243. #define RTV_SPIPE 0x10 /* init or lock _sendpipe */
  244. #define RTV_SSTHRESH 0x20 /* init or lock _ssthresh */
  245. #define RTV_RTT 0x40 /* init or lock _rtt */
  246. #define RTV_RTTVAR 0x80 /* init or lock _rttvar */
  247. #ifdef ROUTER_STACK
  248.     /* New flag values for additional metrics */
  249. #define RTV_VALUE1  0x100 /* assign or lock first additional metric */
  250. #define RTV_VALUE2   0x200 /* assign or lock second additional metric */
  251. #define RTV_VALUE3  0x400  /* assign or lock third additional metric */
  252. #define RTV_VALUE4  0x800  /* assign or lock fourth additional metric */
  253. #define RTV_VALUE5  0x1000  /* assign or lock fifth additional metric */
  254. #define RTV_ROUTETAG  0x2000  /* assign or lock route tag value */
  255. #define RTV_WEIGHT  0x4000  /* assign or lock administrative weight */
  256. #endif /* ROUTER_STACK */
  257. /*
  258.  * Bitmask values for rtm_addr.
  259.  */
  260. #define RTA_DST 0x1 /* destination sockaddr present */
  261. #define RTA_GATEWAY 0x2 /* gateway sockaddr present */
  262. #define RTA_NETMASK 0x4 /* netmask sockaddr present */
  263. #define RTA_GENMASK 0x8 /* cloning mask sockaddr present */
  264. #define RTA_IFP 0x10 /* interface name sockaddr present */
  265. #define RTA_IFA 0x20 /* interface addr sockaddr present */
  266. #define RTA_AUTHOR 0x40 /* sockaddr for author of redirect */
  267. #define RTA_BRD 0x80 /* for NEWADDR, broadcast or p-p dest addr */
  268. /*
  269.  * Index offsets for sockaddr array for alternate internal encoding.
  270.  */
  271. #define RTAX_DST 0 /* destination sockaddr present */
  272. #define RTAX_GATEWAY 1 /* gateway sockaddr present */
  273. #define RTAX_NETMASK 2 /* netmask sockaddr present */
  274. #define RTAX_GENMASK 3 /* cloning mask sockaddr present */
  275. #define RTAX_IFP 4 /* interface name sockaddr present */
  276. #define RTAX_IFA 5 /* interface addr sockaddr present */
  277. #define RTAX_AUTHOR 6 /* sockaddr for author of redirect */
  278. #define RTAX_BRD 7 /* for NEWADDR, broadcast or p-p dest addr */
  279. #define RTAX_MAX 8 /* size of array to allocate */
  280. struct rt_addrinfo {
  281. int rti_addrs;
  282. struct sockaddr *rti_info[RTAX_MAX];
  283. };
  284. struct route_cb {
  285. int ip_count;
  286. int ns_count;
  287. int iso_count;
  288. int any_count;
  289. };
  290. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  291. #pragma align 0                 /* turn off alignment requirement */
  292. #endif /* CPU_FAMILY==I960 */
  293. #define RTFREE(rt) 
  294. if ((rt)->rt_refcnt <= 1) 
  295. rtfree(rt); 
  296. else 
  297. (rt)->rt_refcnt--;
  298. extern struct rtstat rtstat;
  299. extern struct radix_node_head *rt_tables[];
  300. extern  int rtmodified; 
  301. #ifdef VIRTUAL_STACK
  302. STATUS  routeStorageCreate (void);
  303. #else
  304. int  route_init (void);
  305. #endif
  306. void  rt_maskedcopy (struct sockaddr *,
  307.     struct sockaddr *, struct sockaddr *);
  308. int  rt_setgate (struct rtentry *,
  309.     struct sockaddr *, struct sockaddr *);
  310. void  rtable_init (void **);
  311. void  rtalloc (struct route *);
  312. struct rtentry *
  313.  rtalloc1 (struct sockaddr *, int);
  314. void  rtfree (struct rtentry *);
  315. int  rtinit (struct ifaddr *, int, int);
  316. int  rtioctl (int, caddr_t);
  317. int  rtredirect (struct sockaddr *, struct sockaddr *,
  318.     struct sockaddr *, int, struct sockaddr *, struct rtentry **);
  319. int  rtrequest (int, struct sockaddr *,
  320.     struct sockaddr *, struct sockaddr *, int, struct rtentry **);
  321. #ifdef __cplusplus
  322. }
  323. #endif
  324. #endif /* __INCrouteh */