Clean up the networking code before I parallelize the routing code.
[dragonfly.git] / sys / net / route.c
1 /*
2  * Copyright (c) 1980, 1986, 1991, 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.c     8.3 (Berkeley) 1/9/95
34  * $FreeBSD: src/sys/net/route.c,v 1.59.2.10 2003/01/17 08:04:00 ru Exp $
35  * $DragonFly: src/sys/net/route.c,v 1.11 2004/12/28 08:09:59 hsu Exp $
36  */
37
38 #include "opt_inet.h"
39
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/malloc.h>
43 #include <sys/mbuf.h>
44 #include <sys/socket.h>
45 #include <sys/domain.h>
46 #include <sys/kernel.h>
47
48 #include <net/if.h>
49 #include <net/route.h>
50
51 #include <netinet/in.h>
52 #include <net/ip_mroute/ip_mroute.h>
53
54 static struct rtstat rtstat;
55 struct radix_node_head *rt_tables[AF_MAX+1];
56
57 static void     rt_maskedcopy (struct sockaddr *, struct sockaddr *,
58                                struct sockaddr *);
59 static void     rtable_init (void **);
60
61 static void
62 rtable_init(void **table)
63 {
64         struct domain *dom;
65
66         for (dom = domains; dom; dom = dom->dom_next)
67                 if (dom->dom_rtattach)
68                         dom->dom_rtattach(&table[dom->dom_family],
69                                           dom->dom_rtoffset);
70 }
71
72 void
73 route_init()
74 {
75         rn_init();      /* initialize all zeroes, all ones, mask table */
76         rtable_init((void **)rt_tables);
77 }
78
79 /*
80  * Packet routing routines.
81  */
82
83 /*
84  * Lookup and fill in the "ro_rt" rtentry field in a route structure given
85  * an address in the ro_dst field.  Always send a report and always
86  * clone routes.
87  */
88 void
89 rtalloc(struct route *ro)
90 {
91         rtalloc_ign(ro, 0UL);
92 }
93
94 /*
95  * Lookup and fill in the "ro_rt" rtentry field in a route structure given
96  * an address in the ro_dst field.  Always send a report and optionally
97  * clone routes when RTF_CLONING or RTF_PRCLONING are not being ignored.
98  */
99 void
100 rtalloc_ign(struct route *ro, u_long ignore)
101 {
102         if (ro->ro_rt != NULL) {
103                 if (ro->ro_rt->rt_ifp != NULL && ro->ro_rt->rt_flags & RTF_UP)
104                         return;
105                 rtfree(ro->ro_rt);
106                 ro->ro_rt = NULL;
107         }
108         ro->ro_rt = rtlookup(&ro->ro_dst, 1, ignore);
109 }
110
111 /*
112  * Look up the route that matches the given "dst" address.
113  *
114  * Create and return a cloned route if "dst" matches a cloning route
115  * and the RTF_CLONING and RTF_PRCLONING flags are not being ignored.
116  *
117  * Any route returned has its refcnt incremented.
118  */
119 struct rtentry *
120 rtlookup(struct sockaddr *dst, int report, u_long ignflags)
121 {
122         struct radix_node_head *rnh = rt_tables[dst->sa_family];
123         struct rtentry *rt;
124         struct radix_node *rn;
125         struct rt_addrinfo info;
126         u_long nflags;
127         int s, err, msgtype;
128
129         s = splnet();
130         if (rnh != NULL && (rn = rnh->rnh_matchaddr((char *)dst, rnh))) {
131                 rt = (struct rtentry *)rn;
132                 nflags = rt->rt_flags & ~ignflags;
133                 if (report && (nflags & (RTF_CLONING | RTF_PRCLONING))) {
134                         struct rtentry *clonedroute;
135
136                         clonedroute = rt;  /* value used in rtrequest()! */
137                         err = rtrequest(RTM_RESOLVE, dst, NULL, NULL, 0,
138                                         &clonedroute);
139                         if (err != 0) {
140                                 /* use master cloning route on clone failure */
141                                 rt->rt_refcnt++;
142                                 goto reportmiss;
143                         }
144                         rt = clonedroute;  /* return cloned route to caller */
145                         if (clonedroute->rt_flags & RTF_XRESOLVE) {
146                                 /* Cloned route needs external resolution. */
147                                 msgtype = RTM_RESOLVE;
148                                 goto reportmsg;
149                         }
150                         /* Inform listeners of the new route. */
151                         bzero(&info, sizeof(info));
152                         info.rti_info[RTAX_DST] = rt_key(clonedroute);
153                         info.rti_info[RTAX_NETMASK] = rt_mask(clonedroute);
154                         info.rti_info[RTAX_GATEWAY] = clonedroute->rt_gateway;
155                         if (clonedroute->rt_ifp != NULL) {
156                                 info.rti_info[RTAX_IFP] =
157                                     TAILQ_FIRST(&clonedroute->rt_ifp
158                                                 ->if_addrhead)->ifa_addr;
159                                 info.rti_info[RTAX_IFA] =
160                                     clonedroute->rt_ifa->ifa_addr;
161                         }
162                         rt_missmsg(RTM_ADD, &info, clonedroute->rt_flags, 0);
163                 } else
164                         rt->rt_refcnt++;        /* most common case */
165         } else {
166                 rt = NULL;
167                 rtstat.rts_unreach++;
168                 if (report) {
169                         err = 0;
170 reportmiss:
171                         msgtype = RTM_MISS;
172 reportmsg:
173                         bzero(&info, sizeof(info));
174                         info.rti_info[RTAX_DST] = dst;
175                         rt_missmsg(msgtype, &info, 0, err);
176                 }
177         }
178         splx(s);
179         return (rt);
180 }
181
182 void
183 rtfree(struct rtentry *rt)
184 {
185         struct radix_node_head *rnh = rt_tables[rt_key(rt)->sa_family];
186
187         --rt->rt_refcnt;
188         if (rnh->rnh_close && rt->rt_refcnt == 0)
189                 rnh->rnh_close((struct radix_node *)rt, rnh);
190         if (rt->rt_refcnt <= 0 && !(rt->rt_flags & RTF_UP)) {
191                 KASSERT(!(rt->rt_nodes->rn_flags & (RNF_ACTIVE | RNF_ROOT)),
192                         ("rtfree: rn_flags 0x%x ", rt->rt_nodes->rn_flags));
193                 KASSERT(rt->rt_refcnt == 0,
194                         ("rtfree: rt_refcnt %ld", rt->rt_refcnt));
195                 if (rt->rt_ifa != NULL)
196                         IFAFREE(rt->rt_ifa);
197                 if (rt->rt_parent != NULL)
198                         RTFREE(rt->rt_parent);
199                 Free(rt_key(rt));  /* Also frees gateway.  See rt_setgate(). */
200                 Free(rt);
201         }
202 }
203
204 #define sa_equal(a1, a2) (bcmp((a1), (a2), (a1)->sa_len) == 0)
205
206 /*
207  * Force a routing table entry to the specified
208  * destination to go through the given gateway.
209  * Normally called as a result of a routing redirect
210  * message from the network layer.
211  *
212  * N.B.: must be called at splnet
213  *
214  */
215 void
216 rtredirect(
217         struct sockaddr *dst,
218         struct sockaddr *gateway,
219         struct sockaddr *netmask,
220         int flags,
221         struct sockaddr *src,
222         struct rtentry **rtp)
223 {
224         struct rtentry *rt;
225         struct rt_addrinfo info;
226         struct ifaddr *ifa;
227         short *stat = NULL;
228         int error;
229
230         /* verify the gateway is directly reachable */
231         if ((ifa = ifa_ifwithnet(gateway)) == NULL) {
232                 error = ENETUNREACH;
233                 goto out;
234         }
235
236         /*
237          * If the redirect isn't from our current router for this dst,
238          * it's either old or wrong.  If it redirects us to ourselves,
239          * we have a routing loop, perhaps as a result of an interface
240          * going down recently.
241          */
242         if (!(flags & RTF_DONE) &&
243             (rt = rtlookup(dst, 0, 0UL)) != NULL &&
244             (!sa_equal(src, rt->rt_gateway) || rt->rt_ifa != ifa)) {
245                 error = EINVAL;
246                 goto done;
247         } else if (ifa_ifwithaddr(gateway)) {
248                 error = EHOSTUNREACH;
249                 goto done;
250         }
251
252         /*
253          * Create a new entry if we just got back a wildcard entry
254          * or the the lookup failed.  This is necessary for hosts
255          * which use routing redirects generated by smart gateways
256          * to dynamically build the routing tables.
257          */
258         if (rt == NULL || (rt_mask(rt) != NULL && rt_mask(rt)->sa_len < 2))
259                 goto create;
260
261         /*
262          * Don't listen to the redirect if it's for a route to an interface.
263          */
264         if (rt->rt_flags & RTF_GATEWAY) {
265                 if ((!(rt->rt_flags & RTF_HOST)) && (flags & RTF_HOST)) {
266                         /*
267                          * Changing from route to net => route to host.
268                          * Create new route, rather than smashing route to net.
269                          */
270 create:
271                         if (rt != NULL)
272                                 rtfree(rt);
273                         flags |=  RTF_GATEWAY | RTF_DYNAMIC;
274                         bzero(&info, sizeof(info));
275                         info.rti_info[RTAX_DST] = dst;
276                         info.rti_info[RTAX_GATEWAY] = gateway;
277                         info.rti_info[RTAX_NETMASK] = netmask;
278                         info.rti_ifa = ifa;
279                         info.rti_flags = flags;
280                         rt = NULL;
281                         error = rtrequest1(RTM_ADD, &info, &rt);
282                         if (rt != NULL)
283                                 flags = rt->rt_flags;
284                         stat = &rtstat.rts_dynamic;
285                 } else {
286                         /*
287                          * Smash the current notion of the gateway to
288                          * this destination.  Should check about netmask!!!
289                          */
290                         rt->rt_flags |= RTF_MODIFIED;
291                         flags |= RTF_MODIFIED;
292                         stat = &rtstat.rts_newgateway;
293                         /* Add the key and gateway (in one malloc'ed chunk). */
294                         rt_setgate(rt, rt_key(rt), gateway);
295                         error = 0;
296                 }
297         } else {
298                 error = EHOSTUNREACH;
299         }
300
301 done:
302         if (rt != NULL) {
303                 if (rtp != NULL && error == 0)
304                         *rtp = rt;
305                 else
306                         rtfree(rt);
307         }
308
309 out:
310         if (error != 0)
311                 rtstat.rts_badredirect++;
312         else if (stat != NULL)
313                 (*stat)++;
314
315         bzero(&info, sizeof(info));
316         info.rti_info[RTAX_DST] = dst;
317         info.rti_info[RTAX_GATEWAY] = gateway;
318         info.rti_info[RTAX_NETMASK] = netmask;
319         info.rti_info[RTAX_AUTHOR] = src;
320         rt_missmsg(RTM_REDIRECT, &info, flags, error);
321 }
322
323 /*
324 * Routing table ioctl interface.
325 */
326 int
327 rtioctl(u_long req, caddr_t data, struct thread *td)
328 {
329 #ifdef INET
330         /* Multicast goop, grrr... */
331         return mrt_ioctl ? mrt_ioctl(req, data) : EOPNOTSUPP;
332 #else
333         return ENXIO;
334 #endif
335 }
336
337 struct ifaddr *
338 ifa_ifwithroute(int flags, struct sockaddr *dst, struct sockaddr *gateway)
339 {
340         struct ifaddr *ifa;
341
342         if (!(flags & RTF_GATEWAY)) {
343                 /*
344                  * If we are adding a route to an interface,
345                  * and the interface is a point-to-point link,
346                  * we should search for the destination
347                  * as our clue to the interface.  Otherwise
348                  * we can use the local address.
349                  */
350                 ifa = NULL;
351                 if (flags & RTF_HOST) {
352                         ifa = ifa_ifwithdstaddr(dst);
353                 }
354                 if (ifa == NULL)
355                         ifa = ifa_ifwithaddr(gateway);
356         } else {
357                 /*
358                  * If we are adding a route to a remote net
359                  * or host, the gateway may still be on the
360                  * other end of a pt to pt link.
361                  */
362                 ifa = ifa_ifwithdstaddr(gateway);
363         }
364         if (ifa == NULL)
365                 ifa = ifa_ifwithnet(gateway);
366         if (ifa == NULL) {
367                 struct rtentry *rt = rtlookup(gateway, 0, 0UL);
368
369                 if (rt == NULL)
370                         return (NULL);
371                 rt->rt_refcnt--;
372                 if ((ifa = rt->rt_ifa) == NULL)
373                         return (NULL);
374         }
375         if (ifa->ifa_addr->sa_family != dst->sa_family) {
376                 struct ifaddr *oifa = ifa;
377
378                 ifa = ifaof_ifpforaddr(dst, ifa->ifa_ifp);
379                 if (ifa == NULL)
380                         ifa = oifa;
381         }
382         return (ifa);
383 }
384
385 static int rt_fixdelete (struct radix_node *, void *);
386 static int rt_fixchange (struct radix_node *, void *);
387
388 struct rtfc_arg {
389         struct rtentry *rt0;
390         struct radix_node_head *rnh;
391 };
392
393 int
394 rt_getifa(struct rt_addrinfo *info)
395 {
396         struct sockaddr *gateway = info->rti_info[RTAX_GATEWAY];
397         struct sockaddr *dst = info->rti_info[RTAX_DST];
398         struct sockaddr *ifaaddr = info->rti_info[RTAX_IFA];
399         struct sockaddr *ifpaddr = info->rti_info[RTAX_IFP];
400         int flags = info->rti_flags;
401         struct ifaddr *ifa;
402         int error = 0;
403
404         /*
405          * ifp may be specified by sockaddr_dl
406          * when protocol address is ambiguous.
407          */
408         if (info->rti_ifp == NULL && ifpaddr != NULL &&
409             ifpaddr->sa_family == AF_LINK &&
410             (ifa = ifa_ifwithnet(ifpaddr)) != NULL)
411                 info->rti_ifp = ifa->ifa_ifp;
412         if (info->rti_ifa == NULL && ifaaddr != NULL)
413                 info->rti_ifa = ifa_ifwithaddr(ifaaddr);
414         if (info->rti_ifa == NULL) {
415                 struct sockaddr *sa;
416
417                 sa = ifaaddr != NULL ? ifaaddr :
418                     (gateway != NULL ? gateway : dst);
419                 if (sa != NULL && info->rti_ifp != NULL)
420                         info->rti_ifa = ifaof_ifpforaddr(sa, info->rti_ifp);
421                 else if (dst != NULL && gateway != NULL)
422                         info->rti_ifa = ifa_ifwithroute(flags, dst, gateway);
423                 else if (sa != NULL)
424                         info->rti_ifa = ifa_ifwithroute(flags, sa, sa);
425         }
426         if ((ifa = info->rti_ifa) != NULL) {
427                 if (info->rti_ifp == NULL)
428                         info->rti_ifp = ifa->ifa_ifp;
429         } else
430                 error = ENETUNREACH;
431         return (error);
432 }
433
434 /*
435  * Do appropriate manipulations of a routing tree given
436  * all the bits of info needed
437  */
438 int
439 rtrequest(
440         int req,
441         struct sockaddr *dst,
442         struct sockaddr *gateway,
443         struct sockaddr *netmask,
444         int flags,
445         struct rtentry **ret_nrt)
446 {
447         struct rt_addrinfo info;
448
449         bzero(&info, sizeof info);
450         info.rti_flags = flags;
451         info.rti_info[RTAX_DST] = dst;
452         info.rti_info[RTAX_GATEWAY] = gateway;
453         info.rti_info[RTAX_NETMASK] = netmask;
454         return rtrequest1(req, &info, ret_nrt);
455 }
456
457 int
458 rtrequest1(int req, struct rt_addrinfo *info, struct rtentry **ret_nrt)
459 {
460         struct sockaddr *dst = info->rti_info[RTAX_DST];
461         struct rtentry *rt;
462         struct radix_node *rn;
463         struct radix_node_head *rnh;
464         struct ifaddr *ifa;
465         struct sockaddr *ndst;
466         int error = 0;
467         int s;
468
469 #define gotoerr(x) { error = x ; goto bad; }
470
471         s = splnet();
472         /*
473          * Find the correct routing tree to use for this Address Family
474          */
475         if ((rnh = rt_tables[dst->sa_family]) == NULL)
476                 gotoerr(EAFNOSUPPORT);
477
478         /*
479          * If we are adding a host route then we don't want to put
480          * a netmask in the tree, nor do we want to clone it.
481          */
482         if (info->rti_flags & RTF_HOST) {
483                 info->rti_info[RTAX_NETMASK] = NULL;
484                 info->rti_flags &= ~(RTF_CLONING | RTF_PRCLONING);
485         }
486
487         switch (req) {
488         case RTM_DELETE:
489                 /* Remove the item from the tree. */
490                 rn = rnh->rnh_deladdr((char *)info->rti_info[RTAX_DST],
491                                       (char *)info->rti_info[RTAX_NETMASK],
492                                       rnh);
493                 if (rn == NULL)
494                         gotoerr(ESRCH);
495                 KASSERT(!(rn->rn_flags & (RNF_ACTIVE | RNF_ROOT)),
496                         ("rnh_deladdr returned flags 0x%x", rn->rn_flags));
497                 rt = (struct rtentry *)rn;
498
499                 /* Free any routes cloned from this one. */
500                 if ((rt->rt_flags & (RTF_CLONING | RTF_PRCLONING)) &&
501                     rt_mask(rt) != NULL) {
502                         rnh->rnh_walktree_from(rnh, (char *)rt_key(rt),
503                                                (char *)rt_mask(rt),
504                                                rt_fixdelete, rt);
505                 }
506
507                 if (rt->rt_gwroute != NULL) {
508                         RTFREE(rt->rt_gwroute);
509                         rt->rt_gwroute = NULL;
510                 }
511
512                 /*
513                  * NB: RTF_UP must be set during the search above,
514                  * because we might delete the last ref, causing
515                  * rt to get freed prematurely.
516                  */
517                 rt->rt_flags &= ~RTF_UP;
518
519                 /* Give the protocol a chance to keep things in sync. */
520                 if ((ifa = rt->rt_ifa) && ifa->ifa_rtrequest)
521                         ifa->ifa_rtrequest(RTM_DELETE, rt, info);
522
523                 /*
524                  * If the caller wants it, then it can have it,
525                  * but it's up to it to free the rtentry as we won't be
526                  * doing it.
527                  */
528                 if (ret_nrt != NULL) {
529                         *ret_nrt = rt;
530                 } else if (rt->rt_refcnt <= 0) {
531                         rt->rt_refcnt++;  /* refcnt > 0 required for rtfree() */
532                         rtfree(rt);
533                 }
534                 break;
535
536         case RTM_RESOLVE:
537                 if (ret_nrt == NULL || (rt = *ret_nrt) == NULL)
538                         gotoerr(EINVAL);
539                 ifa = rt->rt_ifa;
540                 info->rti_flags = rt->rt_flags &
541                     ~(RTF_CLONING | RTF_PRCLONING | RTF_STATIC);
542                 info->rti_flags |= RTF_WASCLONED;
543                 info->rti_info[RTAX_GATEWAY] = rt->rt_gateway;
544                 if ((info->rti_info[RTAX_NETMASK] = rt->rt_genmask) == NULL)
545                         info->rti_flags |= RTF_HOST;
546                 goto makeroute;
547
548         case RTM_ADD:
549                 KASSERT(!(info->rti_flags & RTF_GATEWAY) ||
550                         info->rti_info[RTAX_GATEWAY] != NULL,
551                     ("rtrequest: GATEWAY but no gateway"));
552
553                 if (info->rti_ifa == NULL && (error = rt_getifa(info)))
554                         gotoerr(error);
555                 ifa = info->rti_ifa;
556 makeroute:
557                 R_Malloc(rt, struct rtentry *, sizeof *rt);
558                 if (rt == NULL)
559                         gotoerr(ENOBUFS);
560                 bzero(rt, sizeof *rt);
561                 rt->rt_flags = RTF_UP | info->rti_flags;
562                 error = rt_setgate(rt, dst, info->rti_info[RTAX_GATEWAY]);
563                 if (error != 0) {
564                         Free(rt);
565                         gotoerr(error);
566                 }
567
568                 ndst = rt_key(rt);
569                 if (info->rti_info[RTAX_NETMASK] != NULL)
570                         rt_maskedcopy(dst, ndst, info->rti_info[RTAX_NETMASK]);
571                 else
572                         bcopy(dst, ndst, dst->sa_len);
573
574                 /*
575                  * Note that we now have a reference to the ifa.
576                  * This moved from below so that rnh->rnh_addaddr() can
577                  * examine the ifa and  ifa->ifa_ifp if it so desires.
578                  */
579                 IFAREF(ifa);
580                 rt->rt_ifa = ifa;
581                 rt->rt_ifp = ifa->ifa_ifp;
582                 /* XXX mtu manipulation will be done in rnh_addaddr -- itojun */
583
584                 rn = rnh->rnh_addaddr((char *)ndst,
585                                       (char *)info->rti_info[RTAX_NETMASK],
586                                       rnh, rt->rt_nodes);
587                 if (rn == NULL) {
588                         struct rtentry *oldrt;
589
590                         /*
591                          * We already have one of these in the tree.
592                          * We do a special hack: if the old route was
593                          * cloned, then we blow it away and try
594                          * re-inserting the new one.
595                          */
596                         oldrt = rtlookup(ndst, 0, RTF_CLONING | RTF_PRCLONING);
597                         if (oldrt != NULL) {
598                                 --oldrt->rt_refcnt;
599                                 if (oldrt->rt_flags & RTF_WASCLONED) {
600                                         rtrequest(RTM_DELETE, rt_key(oldrt),
601                                                   oldrt->rt_gateway,
602                                                   rt_mask(oldrt),
603                                                   oldrt->rt_flags, NULL);
604                                         rn = rnh->rnh_addaddr((char *)ndst,
605                                                   (char *)
606                                                   info->rti_info[RTAX_NETMASK],
607                                                   rnh, rt->rt_nodes);
608                                 }
609                         }
610                 }
611
612                 /*
613                  * If it still failed to go into the tree,
614                  * then un-make it (this should be a function).
615                  */
616                 if (rn == NULL) {
617                         if (rt->rt_gwroute != NULL)
618                                 rtfree(rt->rt_gwroute);
619                         IFAFREE(ifa);
620                         Free(rt_key(rt));
621                         Free(rt);
622                         gotoerr(EEXIST);
623                 }
624
625                 /*
626                  * If we got here from RESOLVE, then we are cloning
627                  * so clone the rest, and note that we
628                  * are a clone (and increment the parent's references)
629                  */
630                 if (req == RTM_RESOLVE) {
631                         rt->rt_rmx = (*ret_nrt)->rt_rmx;    /* copy metrics */
632                         rt->rt_rmx.rmx_pksent = 0;  /* reset packet counter */
633                         if ((*ret_nrt)->rt_flags &
634                                        (RTF_CLONING | RTF_PRCLONING)) {
635                                 rt->rt_parent = *ret_nrt;
636                                 (*ret_nrt)->rt_refcnt++;
637                         }
638                 }
639
640                 /*
641                  * if this protocol has something to add to this then
642                  * allow it to do that as well.
643                  */
644                 if (ifa->ifa_rtrequest != NULL)
645                         ifa->ifa_rtrequest(req, rt, info);
646
647                 /*
648                  * We repeat the same procedure from rt_setgate() here because
649                  * it doesn't fire when we call it there because the node
650                  * hasn't been added to the tree yet.
651                  */
652                 if (req == RTM_ADD && !(rt->rt_flags & RTF_HOST) &&
653                     rt_mask(rt) != NULL) {
654                         struct rtfc_arg arg = { rt, rnh };
655
656                         rnh->rnh_walktree_from(rnh, (char *)rt_key(rt),
657                                                (char *)rt_mask(rt),
658                                                rt_fixchange, &arg);
659                 }
660
661                 /*
662                  * Return the resulting rtentry,
663                  * increasing the number of references by one.
664                  */
665                 if (ret_nrt != NULL) {
666                         rt->rt_refcnt++;
667                         *ret_nrt = rt;
668                 }
669                 break;
670         default:
671                 error = EOPNOTSUPP;
672         }
673 bad:
674         splx(s);
675         return (error);
676 }
677
678 /*
679  * Called from rtrequest(RTM_DELETE, ...) to fix up the route's ``family''
680  * (i.e., the routes related to it by the operation of cloning).  This
681  * routine is iterated over all potential former-child-routes by way of
682  * rnh->rnh_walktree_from() above, and those that actually are children of
683  * the late parent (passed in as VP here) are themselves deleted.
684  */
685 static int
686 rt_fixdelete(struct radix_node *rn, void *vp)
687 {
688         struct rtentry *rt = (struct rtentry *)rn;
689         struct rtentry *rt0 = vp;
690
691         if (rt->rt_parent == rt0 &&
692             !(rt->rt_flags & (RTF_PINNED | RTF_CLONING | RTF_PRCLONING))) {
693                 return rtrequest(RTM_DELETE, rt_key(rt), NULL, rt_mask(rt),
694                                  rt->rt_flags, NULL);
695         }
696         return 0;
697 }
698
699 /*
700  * This routine is called from rt_setgate() to do the analogous thing for
701  * adds and changes.  There is the added complication in this case of a
702  * middle insert; i.e., insertion of a new network route between an older
703  * network route and (cloned) host routes.  For this reason, a simple check
704  * of rt->rt_parent is insufficient; each candidate route must be tested
705  * against the (mask, value) of the new route (passed as before in vp)
706  * to see if the new route matches it.
707  *
708  * XXX - it may be possible to do fixdelete() for changes and reserve this
709  * routine just for adds.  I'm not sure why I thought it was necessary to do
710  * changes this way.
711  */
712 #ifdef DEBUG
713 static int rtfcdebug = 0;
714 #endif
715
716 static int
717 rt_fixchange(struct radix_node *rn, void *vp)
718 {
719         struct rtentry *rt = (struct rtentry *)rn;
720         struct rtfc_arg *ap = vp;
721         struct rtentry *rt0 = ap->rt0;
722         struct radix_node_head *rnh = ap->rnh;
723         u_char *xk1, *xm1, *xk2, *xmp;
724         int i, len, mlen;
725
726 #ifdef DEBUG
727         if (rtfcdebug)
728                 printf("rt_fixchange: rt %p, rt0 %p\n", rt, rt0);
729 #endif
730
731         if (rt->rt_parent == NULL ||
732             (rt->rt_flags & (RTF_PINNED | RTF_CLONING | RTF_PRCLONING))) {
733 #ifdef DEBUG
734                 if (rtfcdebug) printf("no parent, pinned or cloning\n");
735 #endif
736                 return 0;
737         }
738
739         if (rt->rt_parent == rt0) {
740 #ifdef DEBUG
741                 if (rtfcdebug) printf("parent match\n");
742 #endif
743                 return rtrequest(RTM_DELETE, rt_key(rt), NULL, rt_mask(rt),
744                                  rt->rt_flags, NULL);
745         }
746
747         /*
748          * There probably is a function somewhere which does this...
749          * if not, there should be.
750          */
751         len = imin(rt_key(rt0)->sa_len, rt_key(rt)->sa_len);
752
753         xk1 = (u_char *)rt_key(rt0);
754         xm1 = (u_char *)rt_mask(rt0);
755         xk2 = (u_char *)rt_key(rt);
756
757         /* avoid applying a less specific route */
758         xmp = (u_char *)rt_mask(rt->rt_parent);
759         mlen = rt_key(rt->rt_parent)->sa_len;
760         if (mlen > rt_key(rt0)->sa_len) {
761 #ifdef DEBUG
762                 if (rtfcdebug)
763                         printf("rt_fixchange: inserting a less "
764                                "specific route\n");
765 #endif
766                 return 0;
767         }
768         for (i = rnh->rnh_treetop->rn_offset; i < mlen; i++) {
769                 if ((xmp[i] & ~(xmp[i] ^ xm1[i])) != xmp[i]) {
770 #ifdef DEBUG
771                         if (rtfcdebug)
772                                 printf("rt_fixchange: inserting a less "
773                                        "specific route\n");
774 #endif
775                         return 0;
776                 }
777         }
778
779         for (i = rnh->rnh_treetop->rn_offset; i < len; i++) {
780                 if ((xk2[i] & xm1[i]) != xk1[i]) {
781 #ifdef DEBUG
782                         if (rtfcdebug) printf("no match\n");
783 #endif
784                         return 0;
785                 }
786         }
787
788         /*
789          * OK, this node is a clone, and matches the node currently being
790          * changed/added under the node's mask.  So, get rid of it.
791          */
792 #ifdef DEBUG
793         if (rtfcdebug) printf("deleting\n");
794 #endif
795         return rtrequest(RTM_DELETE, rt_key(rt), NULL, rt_mask(rt),
796                          rt->rt_flags, NULL);
797 }
798
799 #define ROUNDUP(a) (a>0 ? (1 + (((a) - 1) | (sizeof(long) - 1))) : sizeof(long))
800
801 int
802 rt_setgate(struct rtentry *rt0, struct sockaddr *dst, struct sockaddr *gate)
803 {
804         char *space, *oldspace;
805         int dlen = ROUNDUP(dst->sa_len), glen = ROUNDUP(gate->sa_len);
806         struct rtentry *rt = rt0;
807         struct radix_node_head *rnh = rt_tables[dst->sa_family];
808
809         /*
810          * A host route with the destination equal to the gateway
811          * will interfere with keeping LLINFO in the routing
812          * table, so disallow it.
813          */
814         if (((rt0->rt_flags & (RTF_HOST | RTF_GATEWAY | RTF_LLINFO)) ==
815                               (RTF_HOST | RTF_GATEWAY)) &&
816             dst->sa_len == gate->sa_len &&
817             sa_equal(dst, gate)) {
818                 /*
819                  * The route might already exist if this is an RTM_CHANGE
820                  * or a routing redirect, so try to delete it.
821                  */
822                 if (rt_key(rt0) != NULL)
823                         rtrequest(RTM_DELETE, rt_key(rt0), rt0->rt_gateway,
824                                   rt_mask(rt0), rt0->rt_flags, NULL);
825                 return EADDRNOTAVAIL;
826         }
827
828         /*
829          * Both dst and gateway are stored in the same malloc'ed chunk
830          * (If I ever get my hands on....)
831          * if we need to malloc a new chunk, then keep the old one around
832          * till we don't need it any more.
833          */
834         if (rt->rt_gateway == NULL || glen > ROUNDUP(rt->rt_gateway->sa_len)) {
835                 oldspace = (char *)rt_key(rt);
836                 R_Malloc(space, char *, dlen + glen);
837                 if (space == NULL)
838                         return ENOBUFS;
839                 rt->rt_nodes->rn_key = space;
840         } else {
841                 space = (char *)rt_key(rt);     /* Just use the old space. */
842                 oldspace = NULL;
843         }
844
845         /* Set the gateway value. */
846         rt->rt_gateway = (struct sockaddr *)(space + dlen);
847         bcopy(gate, rt->rt_gateway, glen);
848
849         if (oldspace != NULL) {
850                 /*
851                  * If we allocated a new chunk, preserve the original dst.
852                  * This way, rt_setgate() really just sets the gate
853                  * and leaves the dst field alone.
854                  */
855                 bcopy(dst, space, dlen);
856                 Free(oldspace);
857         }
858
859         /*
860          * If there is already a gwroute, it's now almost definitely wrong
861          * so drop it.
862          */
863         if (rt->rt_gwroute != NULL) {
864                 RTFREE(rt->rt_gwroute);
865                 rt->rt_gwroute = NULL;
866         }
867         if (rt->rt_flags & RTF_GATEWAY) {
868                 /*
869                  * Cloning loop avoidance: In the presence of
870                  * protocol-cloning and bad configuration, it is
871                  * possible to get stuck in bottomless mutual recursion
872                  * (rtrequest rt_setgate rtlookup).  We avoid this
873                  * by not allowing protocol-cloning to operate for
874                  * gateways (which is probably the correct choice
875                  * anyway), and avoid the resulting reference loops
876                  * by disallowing any route to run through itself as
877                  * a gateway.  This is obviously mandatory when we
878                  * get rt->rt_output().
879                  *
880                  * This breaks TTCP!  XXX JH
881                  */
882                 rt->rt_gwroute = rtlookup(gate, 1, RTF_PRCLONING);
883                 if (rt->rt_gwroute == rt) {
884                         rt->rt_gwroute = NULL;
885                         --rt->rt_refcnt;
886                         return EDQUOT; /* failure */
887                 }
888         }
889
890         /*
891          * This isn't going to do anything useful for host routes, so
892          * don't bother.  Also make sure we have a reasonable mask
893          * (we don't yet have one during adds).
894          */
895         if (!(rt->rt_flags & RTF_HOST) && rt_mask(rt) != NULL) {
896                 struct rtfc_arg arg = { rt, rnh };
897
898                 rnh->rnh_walktree_from(rnh, (char *)rt_key(rt),
899                                        (char *)rt_mask(rt),
900                                        rt_fixchange, &arg);
901         }
902
903         return 0;
904 }
905
906 static void
907 rt_maskedcopy(
908         struct sockaddr *src,
909         struct sockaddr *dst,
910         struct sockaddr *netmask)
911 {
912         u_char *cp1 = (u_char *)src;
913         u_char *cp2 = (u_char *)dst;
914         u_char *cp3 = (u_char *)netmask;
915         u_char *cplim = cp2 + *cp3;
916         u_char *cplim2 = cp2 + *cp1;
917
918         *cp2++ = *cp1++; *cp2++ = *cp1++; /* copies sa_len & sa_family */
919         cp3 += 2;
920         if (cplim > cplim2)
921                 cplim = cplim2;
922         while (cp2 < cplim)
923                 *cp2++ = *cp1++ & *cp3++;
924         if (cp2 < cplim2)
925                 bzero(cp2, cplim2 - cp2);
926 }
927
928 int
929 rt_llroute(struct sockaddr *dst, struct rtentry *rt0, struct rtentry **drt)
930 {
931         struct rtentry *up_rt, *rt;
932
933         if (!(rt0->rt_flags & RTF_UP)) {
934                 up_rt = rtlookup(dst, 1, 0UL);
935                 if (up_rt == NULL)
936                         return (EHOSTUNREACH);
937                 up_rt->rt_refcnt--;
938         } else
939                 up_rt = rt0;
940         if (up_rt->rt_flags & RTF_GATEWAY) {
941                 if (up_rt->rt_gwroute == NULL) {
942                         up_rt->rt_gwroute = rtlookup(up_rt->rt_gateway, 1, 0UL);
943                         if (up_rt->rt_gwroute == NULL)
944                                 return (EHOSTUNREACH);
945                 } else if (!(up_rt->rt_gwroute->rt_flags & RTF_UP)) {
946                         rtfree(up_rt->rt_gwroute);
947                         up_rt->rt_gwroute = rtlookup(up_rt->rt_gateway, 1, 0UL);
948                         if (up_rt->rt_gwroute == NULL)
949                                 return (EHOSTUNREACH);
950                 }
951                 rt = up_rt->rt_gwroute;
952         } else
953                 rt = up_rt;
954         if (rt->rt_flags & RTF_REJECT &&
955             (rt->rt_rmx.rmx_expire == 0 ||              /* rt doesn't expire */
956              time_second < rt->rt_rmx.rmx_expire))      /* rt not expired */
957                 return (rt->rt_flags & RTF_HOST ?  EHOSTDOWN : EHOSTUNREACH);
958         *drt = rt;
959         return 0;
960 }
961
962 /*
963  * Set up a routing table entry, normally
964  * for an interface.
965  */
966 int
967 rtinit(struct ifaddr *ifa, int cmd, int flags)
968 {
969         struct sockaddr *dst, *deldst, *netmask;
970         struct rtentry *rt;
971         struct rtentry *nrt = NULL;
972         struct mbuf *m = NULL;
973         struct radix_node_head *rnh;
974         struct radix_node *rn;
975         struct rt_addrinfo info;
976         int error;
977
978         if (flags & RTF_HOST) {
979                 dst = ifa->ifa_dstaddr;
980                 netmask = NULL;
981         } else {
982                 dst = ifa->ifa_addr;
983                 netmask = ifa->ifa_netmask;
984         }
985         /*
986          * If it's a delete, check that if it exists, it's on the correct
987          * interface or we might scrub a route to another ifa which would
988          * be confusing at best and possibly worse.
989          */
990         if (cmd == RTM_DELETE) {
991                 /*
992                  * It's a delete, so it should already exist..
993                  * If it's a net, mask off the host bits
994                  * (Assuming we have a mask)
995                  */
996                 if (netmask != NULL) {
997                         m = m_get(MB_DONTWAIT, MT_SONAME);
998                         if (m == NULL)
999                                 return (ENOBUFS);
1000                         deldst = mtod(m, struct sockaddr *);
1001                         rt_maskedcopy(dst, deldst, netmask);
1002                         dst = deldst;
1003                 }
1004                 /*
1005                  * Look up an rtentry that is in the routing tree and
1006                  * contains the correct info.
1007                  */
1008                 if ((rnh = rt_tables[dst->sa_family]) == NULL ||
1009                     (rn = rnh->rnh_lookup((char *)dst,
1010                                           (char *)netmask, rnh)) == NULL ||
1011                     ((struct rtentry *)rn)->rt_ifa != ifa ||
1012                     !sa_equal((struct sockaddr *)rn->rn_key, dst)) {
1013                         if (m != NULL)
1014                                 m_free(m);
1015                         return (flags & RTF_HOST ? EHOSTUNREACH : ENETUNREACH);
1016                 }
1017                 /* XXX */
1018 #if 0
1019                 else {
1020                         /*
1021                          * One would think that as we are deleting, and we know
1022                          * it doesn't exist, we could just return at this point
1023                          * with an "ELSE" clause, but apparently not..
1024                          */
1025                         return (flags & RTF_HOST ? EHOSTUNREACH : ENETUNREACH);
1026                 }
1027 #endif
1028         }
1029         /*
1030          * Do the actual request
1031          */
1032         bzero(&info, sizeof(info));
1033         info.rti_ifa = ifa;
1034         info.rti_flags = flags | ifa->ifa_flags;
1035         info.rti_info[RTAX_DST] = dst;
1036         info.rti_info[RTAX_GATEWAY] = ifa->ifa_addr;
1037         info.rti_info[RTAX_NETMASK] = netmask;
1038         error = rtrequest1(cmd, &info, &nrt);
1039         if (error == 0 && (rt = nrt) != NULL) {
1040                 /*
1041                  * notify any listening routing agents of the change
1042                  */
1043                 rt_newaddrmsg(cmd, ifa, error, rt);
1044                 if (cmd == RTM_DELETE) {
1045                         /*
1046                          * If we are deleting, and we found an entry, then
1047                          * it's been removed from the tree.. now throw it away.
1048                          */
1049                         if (rt->rt_refcnt <= 0) {
1050                                 rt->rt_refcnt++; /* make a 1->0 transition */
1051                                 rtfree(rt);
1052                         }
1053                 } else if (cmd == RTM_ADD) {
1054                         /*
1055                          * We just wanted to add it.. we don't actually
1056                          * need a reference.
1057                          */
1058                         rt->rt_refcnt--;
1059                 }
1060         }
1061         if (m != NULL)
1062                 m_free(m);
1063         return (error);
1064 }
1065
1066 /* This must be before ip6_init2(), which is now SI_ORDER_MIDDLE */
1067 SYSINIT(route, SI_SUB_PROTO_DOMAIN, SI_ORDER_THIRD, route_init, 0);