source: rtems/c/src/exec/libnetworking/net/route.h @ 60a2d689

4.104.114.84.95
Last change on this file since 60a2d689 was 60a2d689, checked in by Joel Sherrill <joel.sherrill@…>, on 01/04/99 at 16:28:49

Patch from D. V. Henkel-Wallace <gumby@…> to make macro nest properly in conditionals

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