source: rtems/cpukit/libnetworking/net/route.h @ b3f8c9e1

4.104.115
Last change on this file since b3f8c9e1 was fc2f722, checked in by Ralf Corsepius <ralf.corsepius@…>, on 12/11/08 at 17:28:33

Include <sys/socket.h> to make header self contained.
  • Property mode set to 100644
File size: 11.2 KB
Line 
1/*
2 * Copyright (c) 1980, 1986, 1993
3 *      The Regents of the University of California.  All rights reserved.
4 *
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 *      @(#)route.h     8.4 (Berkeley) 1/9/95
30 * $FreeBSD: src/sys/net/route.h,v 1.65 2006/03/15 19:39:09 andre Exp $
31 */
32
33/*
34 * $Id$
35 */
36
37#ifndef _NET_ROUTE_H_
38#define _NET_ROUTE_H_
39
40#include <sys/socket.h> /* struct sockaddr */
41/*
42 * Kernel resident routing tables.
43 *
44 * The routing tables are initialized when interface addresses
45 * are set by making entries for all directly connected interfaces.
46 */
47
48/*
49 * A route consists of a destination address and a reference
50 * to a routing entry.  These are often held by protocols
51 * in their control blocks, e.g. inpcb.
52 */
53struct route {
54        struct  rtentry *ro_rt;
55        struct  sockaddr ro_dst;
56};
57
58/*
59 * These numbers are used by reliable protocols for determining
60 * retransmission behavior and are included in the routing structure.
61 */
62struct rt_metrics_lite {
63        u_long  rmx_mtu;        /* MTU for this path */
64        u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
65        u_long  rmx_pksent;     /* packets sent using this route */
66};
67
68struct rt_metrics {
69        u_long  rmx_locks;      /* Kernel must leave these values alone */
70        u_long  rmx_mtu;        /* MTU for this path */
71        u_long  rmx_hopcount;   /* max hops expected */
72        u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
73        u_long  rmx_recvpipe;   /* inbound delay-bandwidth product */
74        u_long  rmx_sendpipe;   /* outbound delay-bandwidth product */
75        u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
76        u_long  rmx_rtt;        /* estimated round trip time */
77        u_long  rmx_rttvar;     /* estimated rtt variance */
78        u_long  rmx_pksent;     /* packets sent using this route */
79        u_long  rmx_filler[4];  /* will be used for T/TCP later */
80};
81
82/*
83 * rmx_rtt and rmx_rttvar are stored as microseconds;
84 * RTTTOPRHZ(rtt) converts to a value suitable for use
85 * by a protocol slowtimo counter.
86 */
87#define RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
88#define RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
89
90/*
91 * XXX kernel function pointer `rt_output' is visible to applications.
92 */
93struct mbuf;
94
95/*
96 * We distinguish between routes to hosts and routes to networks,
97 * preferring the former if available.  For each route we infer
98 * the interface to use from the gateway address supplied when
99 * the route was entered.  Routes that forward packets through
100 * gateways are marked so that the output routines know to address the
101 * gateway rather than the ultimate destination.
102 */
103#ifndef RNF_NORMAL
104#include <net/radix.h>
105#endif
106struct rtentry {
107        struct  radix_node rt_nodes[2]; /* tree glue, and other values */
108#define rt_key(r)       ((struct sockaddr *)((r)->rt_nodes->rn_key))
109#define rt_mask(r)      ((struct sockaddr *)((r)->rt_nodes->rn_mask))
110        struct  sockaddr *rt_gateway;   /* value */
111        u_long  rt_flags;               /* up/down?, host/net */
112        struct  ifnet *rt_ifp;          /* the answer: interface to use */
113        struct  ifaddr *rt_ifa;         /* the answer: interface address to use */
114        struct  rt_metrics rt_rmx;      /* metrics used by rx'ing protocols */
115        long    rt_refcnt;              /* # held references */
116        struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
117        caddr_t rt_llinfo;              /* pointer to link level info cache */
118        struct  rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
119        struct  rtentry *rt_parent;     /* cloning parent of this route */
120};
121
122/*
123 * Following structure necessary for 4.3 compatibility;
124 * We should eventually move it to a compat file.
125 */
126struct ortentry {
127        u_long  rt_hash;                /* to speed lookups */
128        struct  sockaddr rt_dst;        /* key */
129        struct  sockaddr rt_gateway;    /* value */
130        short   rt_flags;               /* up/down?, host/net */
131        short   rt_refcnt;              /* # held references */
132        u_long  rt_use;                 /* raw # packets forwarded */
133        struct  ifnet *rt_ifp;          /* the answer: interface to use */
134};
135
136#define rt_use rt_rmx.rmx_pksent
137
138#define RTF_UP          0x1             /* route usable */
139#define RTF_GATEWAY     0x2             /* destination is a gateway */
140#define RTF_HOST        0x4             /* host entry (net otherwise) */
141#define RTF_REJECT      0x8             /* host or net unreachable */
142#define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
143#define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
144#define RTF_DONE        0x40            /* message confirmed */
145/*                      0x80               unused, was RTF_DELCLONE */
146#define RTF_CLONING     0x100           /* generate new routes on use */
147#define RTF_XRESOLVE    0x200           /* external daemon resolves name */
148#define RTF_LLINFO      0x400           /* generated by link layer (e.g. ARP) */
149#define RTF_STATIC      0x800           /* manually added */
150#define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
151#define RTF_PROTO2      0x4000          /* protocol specific routing flag */
152#define RTF_PROTO1      0x8000          /* protocol specific routing flag */
153
154#define RTF_PRCLONING   0x10000         /* protocol requires cloning */
155#define RTF_WASCLONED   0x20000         /* route generated through cloning */
156#define RTF_PROTO3      0x40000         /* protocol specific routing flag */
157/*                      0x80000            unused */
158#define RTF_PINNED      0x100000        /* future use */
159#define RTF_LOCAL       0x200000        /* route represents a local address */
160#define RTF_BROADCAST   0x400000        /* route represents a bcast address */
161#define RTF_MULTICAST   0x800000        /* route represents a mcast address */
162                                        /* 0x1000000 and up unassigned */
163
164/*
165 * Routing statistics.
166 */
167struct  rtstat {
168        short   rts_badredirect;        /* bogus redirect calls */
169        short   rts_dynamic;            /* routes created by redirects */
170        short   rts_newgateway;         /* routes modified by redirects */
171        short   rts_unreach;            /* lookups which failed */
172        short   rts_wildcard;           /* lookups satisfied by a wildcard */
173};
174/*
175 * Structures for routing messages.
176 */
177struct rt_msghdr {
178        u_short rtm_msglen;     /* to skip over non-understood messages */
179        u_char  rtm_version;    /* future binary compatibility */
180        u_char  rtm_type;       /* message type */
181        u_short rtm_index;      /* index for associated ifp */
182        int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
183        int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
184        pid_t   rtm_pid;        /* identify sender */
185        int     rtm_seq;        /* for sender to identify action */
186        int     rtm_errno;      /* why failed */
187        int     rtm_use;        /* from rtentry */
188        u_long  rtm_inits;      /* which metrics we are initializing */
189        struct  rt_metrics rtm_rmx; /* metrics themselves */
190};
191
192#define RTM_VERSION     5       /* Up the ante and ignore older versions */
193
194/*
195 * Message types.
196 */
197#define RTM_ADD         0x1     /* Add Route */
198#define RTM_DELETE      0x2     /* Delete Route */
199#define RTM_CHANGE      0x3     /* Change Metrics or flags */
200#define RTM_GET         0x4     /* Report Metrics */
201#define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
202#define RTM_REDIRECT    0x6     /* Told to use different route */
203#define RTM_MISS        0x7     /* Lookup failed on this address */
204#define RTM_LOCK        0x8     /* fix specified metrics */
205#define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
206#define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
207#define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
208#define RTM_NEWADDR     0xc     /* address being added to iface */
209#define RTM_DELADDR     0xd     /* address being removed from iface */
210#define RTM_IFINFO      0xe     /* iface going up/down etc. */
211#define RTM_NEWMADDR    0xf     /* mcast group membership being added to if */
212#define RTM_DELMADDR    0x10    /* mcast group membership being deleted */
213#define RTM_IFANNOUNCE  0x11    /* iface arrival/departure */
214#define RTM_IEEE80211   0x12    /* IEEE80211 wireless event */
215
216/*
217 * Bitmask values for rtm_inits and rmx_locks.
218 */
219#define RTV_MTU         0x1     /* init or lock _mtu */
220#define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
221#define RTV_EXPIRE      0x4     /* init or lock _expire */
222#define RTV_RPIPE       0x8     /* init or lock _recvpipe */
223#define RTV_SPIPE       0x10    /* init or lock _sendpipe */
224#define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
225#define RTV_RTT         0x40    /* init or lock _rtt */
226#define RTV_RTTVAR      0x80    /* init or lock _rttvar */
227
228/*
229 * Bitmask values for rtm_addrs.
230 */
231#define RTA_DST         0x1     /* destination sockaddr present */
232#define RTA_GATEWAY     0x2     /* gateway sockaddr present */
233#define RTA_NETMASK     0x4     /* netmask sockaddr present */
234#define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
235#define RTA_IFP         0x10    /* interface name sockaddr present */
236#define RTA_IFA         0x20    /* interface addr sockaddr present */
237#define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
238#define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
239
240/*
241 * Index offsets for sockaddr array for alternate internal encoding.
242 */
243#define RTAX_DST        0       /* destination sockaddr present */
244#define RTAX_GATEWAY    1       /* gateway sockaddr present */
245#define RTAX_NETMASK    2       /* netmask sockaddr present */
246#define RTAX_GENMASK    3       /* cloning mask sockaddr present */
247#define RTAX_IFP        4       /* interface name sockaddr present */
248#define RTAX_IFA        5       /* interface addr sockaddr present */
249#define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
250#define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
251#define RTAX_MAX        8       /* size of array to allocate */
252
253struct rt_addrinfo {
254        int     rti_addrs;
255        struct  sockaddr *rti_info[RTAX_MAX];
256};
257
258struct route_cb {
259        int     ip_count;
260        int     ipx_count;
261        int     ns_count;
262        int     iso_count;
263        int     any_count;
264};
265
266#ifdef _KERNEL
267#define RTFREE(rt) \
268        do { \
269          if ((rt)->rt_refcnt <= 1) \
270                rtfree(rt); \
271          else \
272                (rt)->rt_refcnt--; \
273        } while (0)
274
275extern struct route_cb route_cb;
276extern struct radix_node_head *rt_tables[AF_MAX+1];
277
278void     route_init(void);
279void     rt_ifmsg(struct ifnet *);
280void     rt_missmsg(int, struct rt_addrinfo *, int, int);
281void     rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
282int      rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
283void     rtalloc_ign(struct route *, unsigned long);
284void     rtalloc(struct route *ro); /* XXX deprecated, use rtalloc_ign(ro, 0) */
285struct rtentry *
286         rtalloc1(struct sockaddr *, int, unsigned long);
287void     rtfree(struct rtentry *);
288int      rtinit(struct ifaddr *, int, int);
289int      rtioctl(int, caddr_t, struct proc *);
290void     rtredirect(struct sockaddr *, struct sockaddr *,
291            struct sockaddr *, int, struct sockaddr *, struct rtentry **);
292int      rtrequest(int, struct sockaddr *,
293            struct sockaddr *, struct sockaddr *, int, struct rtentry **);
294#endif
295
296#endif
Note: See TracBrowser for help on using the repository browser.