ipfw3: Fix several comments and error messages
[dragonfly.git] / sys / net / route.c
1 /*
2  * Copyright (c) 2004, 2005 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Jeffrey M. Hsu.
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. Neither the name of The DragonFly Project nor the names of its
16  *    contributors may be used to endorse or promote products derived
17  *    from this software without specific, prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32
33 /*
34  * Copyright (c) 1980, 1986, 1991, 1993
35  *      The Regents of the University of California.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. Neither the name of the University nor the names of its contributors
46  *    may be used to endorse or promote products derived from this software
47  *    without specific prior written permission.
48  *
49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59  * SUCH DAMAGE.
60  *
61  *      @(#)route.c     8.3 (Berkeley) 1/9/95
62  * $FreeBSD: src/sys/net/route.c,v 1.59.2.10 2003/01/17 08:04:00 ru Exp $
63  */
64
65 #include "opt_inet.h"
66 #include "opt_mpls.h"
67
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/malloc.h>
71 #include <sys/mbuf.h>
72 #include <sys/socket.h>
73 #include <sys/domain.h>
74 #include <sys/kernel.h>
75 #include <sys/sysctl.h>
76 #include <sys/globaldata.h>
77 #include <sys/thread.h>
78
79 #include <net/if.h>
80 #include <net/if_var.h>
81 #include <net/route.h>
82 #include <net/netisr.h>
83
84 #include <netinet/in.h>
85 #include <net/ip_mroute/ip_mroute.h>
86
87 #include <sys/thread2.h>
88 #include <sys/msgport2.h>
89 #include <net/netmsg2.h>
90 #include <net/netisr2.h>
91
92 #ifdef MPLS
93 #include <netproto/mpls/mpls.h>
94 #endif
95
96 static struct rtstatistics rtstatistics_percpu[MAXCPU] __cachealign;
97 #define rtstat  rtstatistics_percpu[mycpuid]
98
99 struct radix_node_head *rt_tables[MAXCPU][AF_MAX+1];
100
101 static void     rt_maskedcopy (struct sockaddr *, struct sockaddr *,
102                                struct sockaddr *);
103 static void rtable_init(void);
104 static void rtinit_rtrequest_callback(int, int, struct rt_addrinfo *,
105                                       struct rtentry *, void *);
106
107 static void rtredirect_msghandler(netmsg_t msg);
108 static void rtrequest1_msghandler(netmsg_t msg);
109 static void rtsearch_msghandler(netmsg_t msg);
110 static void rtmask_add_msghandler(netmsg_t msg);
111
112 static int rt_setshims(struct rtentry *, struct sockaddr **);
113
114 SYSCTL_NODE(_net, OID_AUTO, route, CTLFLAG_RW, 0, "Routing");
115
116 #ifdef ROUTE_DEBUG
117 static int route_debug = 1;
118 SYSCTL_INT(_net_route, OID_AUTO, route_debug, CTLFLAG_RW,
119            &route_debug, 0, "");
120 #endif
121
122 u_long route_kmalloc_limit = 0;
123 TUNABLE_ULONG("net.route.kmalloc_limit", &route_kmalloc_limit);
124
125 /*
126  * Initialize the route table(s) for protocol domains and
127  * create a helper thread which will be responsible for updating
128  * route table entries on each cpu.
129  */
130 void
131 route_init(void)
132 {
133         int cpu;
134
135         if (route_kmalloc_limit)
136                 kmalloc_raise_limit(M_RTABLE, route_kmalloc_limit);
137
138         for (cpu = 0; cpu < netisr_ncpus; ++cpu)
139                 bzero(&rtstatistics_percpu[cpu], sizeof(struct rtstatistics));
140         rn_init();      /* initialize all zeroes, all ones, mask table */
141         rtable_init();  /* call dom_rtattach() on each cpu */
142 }
143
144 static void
145 rtable_init_oncpu(netmsg_t msg)
146 {
147         struct domain *dom;
148         int cpu = mycpuid;
149
150         ASSERT_NETISR_NCPUS(cpu);
151
152         SLIST_FOREACH(dom, &domains, dom_next) {
153                 if (dom->dom_rtattach) {
154                         dom->dom_rtattach(
155                                 (void **)&rt_tables[cpu][dom->dom_family],
156                                 dom->dom_rtoffset);
157                 }
158         }
159         netisr_forwardmsg(&msg->base, cpu + 1);
160 }
161
162 static void
163 rtable_init(void)
164 {
165         struct netmsg_base msg;
166
167         netmsg_init(&msg, NULL, &curthread->td_msgport, 0, rtable_init_oncpu);
168         netisr_domsg_global(&msg);
169 }
170
171 /*
172  * Routing statistics.
173  */
174 static int
175 sysctl_rtstatistics(SYSCTL_HANDLER_ARGS)
176 {
177         int cpu, error = 0;
178
179         for (cpu = 0; cpu < netisr_ncpus; ++cpu) {
180                 if ((error = SYSCTL_OUT(req, &rtstatistics_percpu[cpu],
181                                         sizeof(struct rtstatistics))))
182                                 break;
183                 if ((error = SYSCTL_IN(req, &rtstatistics_percpu[cpu],
184                                         sizeof(struct rtstatistics))))
185                                 break;
186         }
187
188         return (error);
189 }
190 SYSCTL_PROC(_net_route, OID_AUTO, stats, (CTLTYPE_OPAQUE|CTLFLAG_RW),
191         0, 0, sysctl_rtstatistics, "S,rtstatistics", "Routing statistics");
192
193 /*
194  * Packet routing routines.
195  */
196
197 /*
198  * Look up and fill in the "ro_rt" rtentry field in a route structure given
199  * an address in the "ro_dst" field.  Always send a report on a miss and
200  * always clone routes.
201  */
202 void
203 rtalloc(struct route *ro)
204 {
205         rtalloc_ign(ro, 0UL);
206 }
207
208 /*
209  * Look up and fill in the "ro_rt" rtentry field in a route structure given
210  * an address in the "ro_dst" field.  Always send a report on a miss and
211  * optionally clone routes when RTF_CLONING or RTF_PRCLONING are not being
212  * ignored.
213  */
214 void
215 rtalloc_ign(struct route *ro, u_long ignoreflags)
216 {
217         if (ro->ro_rt != NULL) {
218                 if (ro->ro_rt->rt_ifp != NULL && ro->ro_rt->rt_flags & RTF_UP)
219                         return;
220                 rtfree(ro->ro_rt);
221                 ro->ro_rt = NULL;
222         }
223         ro->ro_rt = _rtlookup(&ro->ro_dst, ignoreflags);
224 }
225
226 /*
227  * Look up the route that matches the given "dst" address.
228  *
229  * Route lookup can have the side-effect of creating and returning
230  * a cloned route instead when "dst" matches a cloning route and the
231  * RTF_CLONING and RTF_PRCLONING flags are not being ignored.
232  *
233  * Any route returned has its reference count incremented.
234  */
235 struct rtentry *
236 _rtlookup(struct sockaddr *dst, u_long ignore)
237 {
238         struct radix_node_head *rnh = rt_tables[mycpuid][dst->sa_family];
239         struct rtentry *rt;
240
241         ASSERT_NETISR_NCPUS(mycpuid);
242
243         if (rnh == NULL)
244                 goto unreach;
245
246         /*
247          * Look up route in the radix tree.
248          */
249         rt = (struct rtentry *) rnh->rnh_matchaddr((char *)dst, rnh);
250         if (rt == NULL)
251                 goto unreach;
252
253         /*
254          * Handle cloning routes.
255          */
256         if ((rt->rt_flags & ~ignore & (RTF_CLONING | RTF_PRCLONING)) != 0) {
257                 struct rtentry *clonedroute;
258                 int error;
259
260                 clonedroute = rt;       /* copy in/copy out parameter */
261                 error = rtrequest(RTM_RESOLVE, dst, NULL, NULL, 0,
262                                   &clonedroute);        /* clone the route */
263                 if (error != 0) {       /* cloning failed */
264                         rt_dstmsg(RTM_MISS, dst, error);
265                         rt->rt_refcnt++;
266                         return (rt);    /* return the uncloned route */
267                 }
268                 if (clonedroute->rt_flags & RTF_XRESOLVE)
269                         rt_dstmsg(RTM_RESOLVE, dst, 0);
270                 return (clonedroute);   /* return cloned route */
271         }
272
273         /*
274          * Increment the reference count of the matched route and return.
275          */
276         rt->rt_refcnt++;
277         return (rt);
278
279 unreach:
280         rtstat.rts_unreach++;
281         rt_dstmsg(RTM_MISS, dst, 0);
282         return (NULL);
283 }
284
285 void
286 rtfree(struct rtentry *rt)
287 {
288
289         ASSERT_NETISR_NCPUS(rt->rt_cpuid);
290         KASSERT(rt->rt_refcnt > 0, ("rtfree: rt_refcnt %ld", rt->rt_refcnt));
291
292         --rt->rt_refcnt;
293         if (rt->rt_refcnt == 0) {
294                 struct radix_node_head *rnh =
295                     rt_tables[mycpuid][rt_key(rt)->sa_family];
296
297                 if (rnh->rnh_close)
298                         rnh->rnh_close((struct radix_node *)rt, rnh);
299                 if (!(rt->rt_flags & RTF_UP)) {
300                         /* deallocate route */
301                         if (rt->rt_ifa != NULL)
302                                 IFAFREE(rt->rt_ifa);
303                         if (rt->rt_parent != NULL)
304                                 RTFREE(rt->rt_parent);  /* recursive call! */
305                         Free(rt_key(rt));
306                         Free(rt);
307                 }
308         }
309 }
310
311 static void
312 rtfree_async_dispatch(netmsg_t msg)
313 {
314         struct rtentry *rt = msg->lmsg.u.ms_resultp;
315
316         rtfree(rt);
317         netisr_replymsg(&msg->base, 0);
318 }
319
320 void
321 rtfree_async(struct rtentry *rt)
322 {
323         struct netmsg_base *msg;
324
325         if (IN_NETISR_NCPUS(rt->rt_cpuid)) {
326                 rtfree(rt);
327                 return;
328         }
329
330         KASSERT(rt->rt_refcnt > 0,
331             ("rtfree_async: rt_refcnt %ld", rt->rt_refcnt));
332
333         msg = kmalloc(sizeof(*msg), M_LWKTMSG, M_INTWAIT);
334         netmsg_init(msg, NULL, &netisr_afree_rport, 0, rtfree_async_dispatch);
335         msg->lmsg.u.ms_resultp = rt;
336
337         netisr_sendmsg(msg, rt->rt_cpuid);
338 }
339
340 int
341 rtredirect_oncpu(struct sockaddr *dst, struct sockaddr *gateway,
342                  struct sockaddr *netmask, int flags, struct sockaddr *src)
343 {
344         struct rtentry *rt = NULL;
345         struct rt_addrinfo rtinfo;
346         struct ifaddr *ifa;
347         u_long *stat = NULL;
348         int error;
349
350         ASSERT_NETISR_NCPUS(mycpuid);
351
352         /* verify the gateway is directly reachable */
353         if ((ifa = ifa_ifwithnet(gateway)) == NULL) {
354                 error = ENETUNREACH;
355                 goto out;
356         }
357
358         /*
359          * If the redirect isn't from our current router for this destination,
360          * it's either old or wrong.
361          */
362         if (!(flags & RTF_DONE) &&              /* XXX JH */
363             (rt = rtpurelookup(dst)) != NULL &&
364             (!sa_equal(src, rt->rt_gateway) || rt->rt_ifa != ifa)) {
365                 error = EINVAL;
366                 goto done;
367         }
368
369         /*
370          * If it redirects us to ourselves, we have a routing loop,
371          * perhaps as a result of an interface going down recently.
372          */
373         if (ifa_ifwithaddr(gateway)) {
374                 error = EHOSTUNREACH;
375                 goto done;
376         }
377
378         /*
379          * Create a new entry if the lookup failed or if we got back
380          * a wildcard entry for the default route.  This is necessary
381          * for hosts which use routing redirects generated by smart
382          * gateways to dynamically build the routing tables.
383          */
384         if (rt == NULL)
385                 goto create;
386         if ((rt_mask(rt) != NULL && rt_mask(rt)->sa_len < 2)) {
387                 rtfree(rt);
388                 goto create;
389         }
390
391         /* Ignore redirects for directly connected hosts. */
392         if (!(rt->rt_flags & RTF_GATEWAY)) {
393                 error = EHOSTUNREACH;
394                 goto done;
395         }
396
397         if (!(rt->rt_flags & RTF_HOST) && (flags & RTF_HOST)) {
398                 /*
399                  * Changing from a network route to a host route.
400                  * Create a new host route rather than smashing the
401                  * network route.
402                  */
403 create:
404                 flags |=  RTF_GATEWAY | RTF_DYNAMIC;
405                 bzero(&rtinfo, sizeof(struct rt_addrinfo));
406                 rtinfo.rti_info[RTAX_DST] = dst;
407                 rtinfo.rti_info[RTAX_GATEWAY] = gateway;
408                 rtinfo.rti_info[RTAX_NETMASK] = netmask;
409                 rtinfo.rti_flags = flags;
410                 rtinfo.rti_ifa = ifa;
411                 rt = NULL;      /* copy-in/copy-out parameter */
412                 error = rtrequest1(RTM_ADD, &rtinfo, &rt);
413                 if (rt != NULL)
414                         flags = rt->rt_flags;
415                 stat = &rtstat.rts_dynamic;
416         } else {
417                 /*
418                  * Smash the current notion of the gateway to this destination.
419                  * Should check about netmask!!!
420                  */
421                 rt->rt_flags |= RTF_MODIFIED;
422                 flags |= RTF_MODIFIED;
423
424                 /* We only need to report rtmsg on CPU0 */
425                 rt_setgate(rt, rt_key(rt), gateway);
426                 if (mycpuid == 0)
427                         rt_rtmsg(RTM_CHANGE, rt, rt->rt_ifp, 0);
428                 error = 0;
429                 stat = &rtstat.rts_newgateway;
430         }
431
432 done:
433         if (rt != NULL)
434                 rtfree(rt);
435 out:
436         if (error != 0)
437                 rtstat.rts_badredirect++;
438         else if (stat != NULL)
439                 (*stat)++;
440
441         return error;
442 }
443
444 struct netmsg_rtredirect {
445         struct netmsg_base base;
446         struct sockaddr *dst;
447         struct sockaddr *gateway;
448         struct sockaddr *netmask;
449         int             flags;
450         struct sockaddr *src;
451 };
452
453 /*
454  * Force a routing table entry to the specified
455  * destination to go through the given gateway.
456  * Normally called as a result of a routing redirect
457  * message from the network layer.
458  */
459 void
460 rtredirect(struct sockaddr *dst, struct sockaddr *gateway,
461            struct sockaddr *netmask, int flags, struct sockaddr *src)
462 {
463         struct rt_addrinfo rtinfo;
464         int error;
465         struct netmsg_rtredirect msg;
466
467         netmsg_init(&msg.base, NULL, &curthread->td_msgport,
468                     0, rtredirect_msghandler);
469         msg.dst = dst;
470         msg.gateway = gateway;
471         msg.netmask = netmask;
472         msg.flags = flags;
473         msg.src = src;
474         error = netisr_domsg_global(&msg.base);
475
476         bzero(&rtinfo, sizeof(struct rt_addrinfo));
477         rtinfo.rti_info[RTAX_DST] = dst;
478         rtinfo.rti_info[RTAX_GATEWAY] = gateway;
479         rtinfo.rti_info[RTAX_NETMASK] = netmask;
480         rtinfo.rti_info[RTAX_AUTHOR] = src;
481         rt_missmsg(RTM_REDIRECT, &rtinfo, flags, error);
482 }
483
484 static void
485 rtredirect_msghandler(netmsg_t msg)
486 {
487         struct netmsg_rtredirect *rmsg = (void *)msg;
488
489         rtredirect_oncpu(rmsg->dst, rmsg->gateway, rmsg->netmask,
490                          rmsg->flags, rmsg->src);
491         netisr_forwardmsg(&msg->base, mycpuid + 1);
492 }
493
494 /*
495 * Routing table ioctl interface.
496 */
497 int
498 rtioctl(u_long req, caddr_t data, struct ucred *cred)
499 {
500 #ifdef INET
501         /* Multicast goop, grrr... */
502         return mrt_ioctl ? mrt_ioctl(req, data) : EOPNOTSUPP;
503 #else
504         return ENXIO;
505 #endif
506 }
507
508 struct ifaddr *
509 ifa_ifwithroute(int flags, struct sockaddr *dst, struct sockaddr *gateway)
510 {
511         struct ifaddr *ifa;
512
513         if (!(flags & RTF_GATEWAY)) {
514                 /*
515                  * If we are adding a route to an interface,
516                  * and the interface is a point-to-point link,
517                  * we should search for the destination
518                  * as our clue to the interface.  Otherwise
519                  * we can use the local address.
520                  */
521                 ifa = NULL;
522                 if (flags & RTF_HOST) {
523                         ifa = ifa_ifwithdstaddr(dst);
524                 }
525                 if (ifa == NULL)
526                         ifa = ifa_ifwithaddr(gateway);
527         } else {
528                 /*
529                  * If we are adding a route to a remote net
530                  * or host, the gateway may still be on the
531                  * other end of a pt to pt link.
532                  */
533                 ifa = ifa_ifwithdstaddr(gateway);
534         }
535         if (ifa == NULL)
536                 ifa = ifa_ifwithnet(gateway);
537         if (ifa == NULL) {
538                 struct rtentry *rt;
539
540                 rt = rtpurelookup(gateway);
541                 if (rt == NULL)
542                         return (NULL);
543                 rt->rt_refcnt--;
544                 if ((ifa = rt->rt_ifa) == NULL)
545                         return (NULL);
546         }
547         if (ifa->ifa_addr->sa_family != dst->sa_family) {
548                 struct ifaddr *oldifa = ifa;
549
550                 ifa = ifaof_ifpforaddr(dst, ifa->ifa_ifp);
551                 if (ifa == NULL)
552                         ifa = oldifa;
553         }
554         return (ifa);
555 }
556
557 static int rt_fixdelete (struct radix_node *, void *);
558 static int rt_fixchange (struct radix_node *, void *);
559
560 struct rtfc_arg {
561         struct rtentry *rt0;
562         struct radix_node_head *rnh;
563 };
564
565 /*
566  * Set rtinfo->rti_ifa and rtinfo->rti_ifp.
567  */
568 int
569 rt_getifa(struct rt_addrinfo *rtinfo)
570 {
571         struct sockaddr *gateway = rtinfo->rti_info[RTAX_GATEWAY];
572         struct sockaddr *dst = rtinfo->rti_info[RTAX_DST];
573         struct sockaddr *ifaaddr = rtinfo->rti_info[RTAX_IFA];
574         int flags = rtinfo->rti_flags;
575
576         /*
577          * ifp may be specified by sockaddr_dl
578          * when protocol address is ambiguous.
579          */
580         if (rtinfo->rti_ifp == NULL) {
581                 struct sockaddr *ifpaddr;
582
583                 ifpaddr = rtinfo->rti_info[RTAX_IFP];
584                 if (ifpaddr != NULL && ifpaddr->sa_family == AF_LINK) {
585                         struct ifaddr *ifa;
586
587                         ifa = ifa_ifwithnet(ifpaddr);
588                         if (ifa != NULL)
589                                 rtinfo->rti_ifp = ifa->ifa_ifp;
590                 }
591         }
592
593         if (rtinfo->rti_ifa == NULL && ifaaddr != NULL)
594                 rtinfo->rti_ifa = ifa_ifwithaddr(ifaaddr);
595         if (rtinfo->rti_ifa == NULL) {
596                 struct sockaddr *sa;
597
598                 sa = ifaaddr != NULL ? ifaaddr :
599                     (gateway != NULL ? gateway : dst);
600                 if (sa != NULL && rtinfo->rti_ifp != NULL)
601                         rtinfo->rti_ifa = ifaof_ifpforaddr(sa, rtinfo->rti_ifp);
602                 else if (dst != NULL && gateway != NULL)
603                         rtinfo->rti_ifa = ifa_ifwithroute(flags, dst, gateway);
604                 else if (sa != NULL)
605                         rtinfo->rti_ifa = ifa_ifwithroute(flags, sa, sa);
606         }
607         if (rtinfo->rti_ifa == NULL)
608                 return (ENETUNREACH);
609
610         if (rtinfo->rti_ifp == NULL)
611                 rtinfo->rti_ifp = rtinfo->rti_ifa->ifa_ifp;
612         return (0);
613 }
614
615 /*
616  * Do appropriate manipulations of a routing tree given
617  * all the bits of info needed
618  */
619 int
620 rtrequest(
621         int req,
622         struct sockaddr *dst,
623         struct sockaddr *gateway,
624         struct sockaddr *netmask,
625         int flags,
626         struct rtentry **ret_nrt)
627 {
628         struct rt_addrinfo rtinfo;
629
630         bzero(&rtinfo, sizeof(struct rt_addrinfo));
631         rtinfo.rti_info[RTAX_DST] = dst;
632         rtinfo.rti_info[RTAX_GATEWAY] = gateway;
633         rtinfo.rti_info[RTAX_NETMASK] = netmask;
634         rtinfo.rti_flags = flags;
635         return rtrequest1(req, &rtinfo, ret_nrt);
636 }
637
638 int
639 rtrequest_global(
640         int req,
641         struct sockaddr *dst,
642         struct sockaddr *gateway,
643         struct sockaddr *netmask,
644         int flags)
645 {
646         struct rt_addrinfo rtinfo;
647
648         bzero(&rtinfo, sizeof(struct rt_addrinfo));
649         rtinfo.rti_info[RTAX_DST] = dst;
650         rtinfo.rti_info[RTAX_GATEWAY] = gateway;
651         rtinfo.rti_info[RTAX_NETMASK] = netmask;
652         rtinfo.rti_flags = flags;
653         return rtrequest1_global(req, &rtinfo, NULL, NULL, RTREQ_PRIO_NORM);
654 }
655
656 struct netmsg_rtq {
657         struct netmsg_base      base;
658         int                     req;
659         struct rt_addrinfo      *rtinfo;
660         rtrequest1_callback_func_t callback;
661         void                    *arg;
662 };
663
664 int
665 rtrequest1_global(int req, struct rt_addrinfo *rtinfo,
666     rtrequest1_callback_func_t callback, void *arg, boolean_t req_prio)
667 {
668         struct netmsg_rtq msg;
669         int flags = 0;
670
671         if (req_prio)
672                 flags = MSGF_PRIORITY;
673         netmsg_init(&msg.base, NULL, &curthread->td_msgport, flags,
674             rtrequest1_msghandler);
675         msg.base.lmsg.ms_error = -1;
676         msg.req = req;
677         msg.rtinfo = rtinfo;
678         msg.callback = callback;
679         msg.arg = arg;
680         return (netisr_domsg_global(&msg.base));
681 }
682
683 /*
684  * Handle a route table request on the current cpu.  Since the route table's
685  * are supposed to be identical on each cpu, an error occuring later in the
686  * message chain is considered system-fatal.
687  */
688 static void
689 rtrequest1_msghandler(netmsg_t msg)
690 {
691         struct netmsg_rtq *rmsg = (void *)msg;
692         struct rt_addrinfo rtinfo;
693         struct rtentry *rt = NULL;
694         int error;
695
696         /*
697          * Copy the rtinfo.  We need to make sure that the original
698          * rtinfo, which is setup by the caller, in the netmsg will
699          * _not_ be changed; else the next CPU on the netmsg forwarding
700          * path will see a different rtinfo than what this CPU has seen.
701          */
702         rtinfo = *rmsg->rtinfo;
703
704         error = rtrequest1(rmsg->req, &rtinfo, &rt);
705         if (rt)
706                 --rt->rt_refcnt;
707         if (rmsg->callback)
708                 rmsg->callback(rmsg->req, error, &rtinfo, rt, rmsg->arg);
709
710         /*
711          * RTM_DELETE's are propogated even if an error occurs, since a
712          * cloned route might be undergoing deletion and cloned routes
713          * are not necessarily replicated.  An overall error is returned
714          * only if no cpus have the route in question.
715          */
716         if (rmsg->base.lmsg.ms_error < 0 || error == 0)
717                 rmsg->base.lmsg.ms_error = error;
718
719         if (error && rmsg->req != RTM_DELETE) {
720                 if (mycpuid != 0) {
721                         panic("rtrequest1_msghandler: rtrequest table req %d, "
722                             "failed on cpu%d, error %d\n",
723                             rmsg->req, mycpuid, error);
724                 }
725                 netisr_replymsg(&rmsg->base, error);
726         } else {
727                 netisr_forwardmsg_error(&rmsg->base, mycpuid + 1,
728                     rmsg->base.lmsg.ms_error);
729         }
730 }
731
732 int
733 rtrequest1(int req, struct rt_addrinfo *rtinfo, struct rtentry **ret_nrt)
734 {
735         struct sockaddr *dst = rtinfo->rti_info[RTAX_DST];
736         struct rtentry *rt;
737         struct radix_node *rn;
738         struct radix_node_head *rnh;
739         struct ifaddr *ifa;
740         struct sockaddr *ndst;
741         int error = 0;
742
743         ASSERT_NETISR_NCPUS(mycpuid);
744
745 #define gotoerr(x) { error = x ; goto bad; }
746
747 #ifdef ROUTE_DEBUG
748         if (route_debug)
749                 rt_addrinfo_print(req, rtinfo);
750 #endif
751
752         crit_enter();
753         /*
754          * Find the correct routing tree to use for this Address Family
755          */
756         if ((rnh = rt_tables[mycpuid][dst->sa_family]) == NULL)
757                 gotoerr(EAFNOSUPPORT);
758
759         /*
760          * If we are adding a host route then we don't want to put
761          * a netmask in the tree, nor do we want to clone it.
762          */
763         if (rtinfo->rti_flags & RTF_HOST) {
764                 rtinfo->rti_info[RTAX_NETMASK] = NULL;
765                 rtinfo->rti_flags &= ~(RTF_CLONING | RTF_PRCLONING);
766         }
767
768         switch (req) {
769         case RTM_DELETE:
770                 /* Remove the item from the tree. */
771                 rn = rnh->rnh_deladdr((char *)rtinfo->rti_info[RTAX_DST],
772                                       (char *)rtinfo->rti_info[RTAX_NETMASK],
773                                       rnh);
774                 if (rn == NULL)
775                         gotoerr(ESRCH);
776                 KASSERT(!(rn->rn_flags & (RNF_ACTIVE | RNF_ROOT)),
777                         ("rnh_deladdr returned flags 0x%x", rn->rn_flags));
778                 rt = (struct rtentry *)rn;
779
780                 /* ref to prevent a deletion race */
781                 ++rt->rt_refcnt;
782
783                 /* Free any routes cloned from this one. */
784                 if ((rt->rt_flags & (RTF_CLONING | RTF_PRCLONING)) &&
785                     rt_mask(rt) != NULL) {
786                         rnh->rnh_walktree_from(rnh, (char *)rt_key(rt),
787                                                (char *)rt_mask(rt),
788                                                rt_fixdelete, rt);
789                 }
790
791                 if (rt->rt_gwroute != NULL) {
792                         RTFREE(rt->rt_gwroute);
793                         rt->rt_gwroute = NULL;
794                 }
795
796                 /*
797                  * NB: RTF_UP must be set during the search above,
798                  * because we might delete the last ref, causing
799                  * rt to get freed prematurely.
800                  */
801                 rt->rt_flags &= ~RTF_UP;
802
803 #ifdef ROUTE_DEBUG
804                 if (route_debug)
805                         rt_print(rtinfo, rt);
806 #endif
807
808                 /* Give the protocol a chance to keep things in sync. */
809                 if ((ifa = rt->rt_ifa) && ifa->ifa_rtrequest)
810                         ifa->ifa_rtrequest(RTM_DELETE, rt);
811
812                 /*
813                  * If the caller wants it, then it can have it,
814                  * but it's up to it to free the rtentry as we won't be
815                  * doing it.
816                  */
817                 KASSERT(rt->rt_refcnt >= 0,
818                         ("rtrequest1(DELETE): refcnt %ld", rt->rt_refcnt));
819                 if (ret_nrt != NULL) {
820                         /* leave ref intact for return */
821                         *ret_nrt = rt;
822                 } else {
823                         /* deref / attempt to destroy */
824                         rtfree(rt);
825                 }
826                 break;
827
828         case RTM_RESOLVE:
829                 if (ret_nrt == NULL || (rt = *ret_nrt) == NULL)
830                         gotoerr(EINVAL);
831
832                 if (!(rt->rt_ifp->if_flags & IFF_UP))
833                         gotoerr(ENETDOWN);
834
835                 KASSERT(rt->rt_cpuid == mycpuid,
836                     ("rt resolve rt_cpuid %d, mycpuid %d",
837                      rt->rt_cpuid, mycpuid));
838
839                 ifa = rt->rt_ifa;
840                 rtinfo->rti_flags =
841                     rt->rt_flags & ~(RTF_CLONING | RTF_PRCLONING | RTF_STATIC);
842                 rtinfo->rti_flags |= RTF_WASCLONED;
843                 rtinfo->rti_info[RTAX_GATEWAY] = rt->rt_gateway;
844                 if ((rtinfo->rti_info[RTAX_NETMASK] = rt->rt_genmask) == NULL)
845                         rtinfo->rti_flags |= RTF_HOST;
846                 rtinfo->rti_info[RTAX_MPLS1] = rt->rt_shim[0];
847                 rtinfo->rti_info[RTAX_MPLS2] = rt->rt_shim[1];
848                 rtinfo->rti_info[RTAX_MPLS3] = rt->rt_shim[2];
849                 goto makeroute;
850
851         case RTM_ADD:
852                 KASSERT(!(rtinfo->rti_flags & RTF_GATEWAY) ||
853                         rtinfo->rti_info[RTAX_GATEWAY] != NULL,
854                     ("rtrequest: GATEWAY but no gateway"));
855
856                 if (rtinfo->rti_ifa == NULL && (error = rt_getifa(rtinfo)))
857                         gotoerr(error);
858                 ifa = rtinfo->rti_ifa;
859 makeroute:
860                 R_Malloc(rt, struct rtentry *, sizeof(struct rtentry));
861                 if (rt == NULL) {
862                         if (req == RTM_ADD) {
863                                 kprintf("rtrequest1: alloc rtentry failed on "
864                                     "cpu%d\n", mycpuid);
865                         }
866                         gotoerr(ENOBUFS);
867                 }
868                 bzero(rt, sizeof(struct rtentry));
869                 rt->rt_flags = RTF_UP | rtinfo->rti_flags;
870                 rt->rt_cpuid = mycpuid;
871
872                 error = rt_setgate(rt, dst, rtinfo->rti_info[RTAX_GATEWAY]);
873                 if (error != 0) {
874                         Free(rt);
875                         gotoerr(error);
876                 }
877
878                 ndst = rt_key(rt);
879                 if (rtinfo->rti_info[RTAX_NETMASK] != NULL)
880                         rt_maskedcopy(dst, ndst,
881                                       rtinfo->rti_info[RTAX_NETMASK]);
882                 else
883                         bcopy(dst, ndst, dst->sa_len);
884
885                 if (rtinfo->rti_info[RTAX_MPLS1] != NULL)
886                         rt_setshims(rt, rtinfo->rti_info);
887
888                 /*
889                  * Note that we now have a reference to the ifa.
890                  * This moved from below so that rnh->rnh_addaddr() can
891                  * examine the ifa and  ifa->ifa_ifp if it so desires.
892                  */
893                 IFAREF(ifa);
894                 rt->rt_ifa = ifa;
895                 rt->rt_ifp = ifa->ifa_ifp;
896                 /* XXX mtu manipulation will be done in rnh_addaddr -- itojun */
897
898                 rn = rnh->rnh_addaddr((char *)ndst,
899                                       (char *)rtinfo->rti_info[RTAX_NETMASK],
900                                       rnh, rt->rt_nodes);
901                 if (rn == NULL) {
902                         struct rtentry *oldrt;
903
904                         /*
905                          * We already have one of these in the tree.
906                          * We do a special hack: if the old route was
907                          * cloned, then we blow it away and try
908                          * re-inserting the new one.
909                          */
910                         oldrt = rtpurelookup(ndst);
911                         if (oldrt != NULL) {
912                                 --oldrt->rt_refcnt;
913                                 if (oldrt->rt_flags & RTF_WASCLONED) {
914                                         rtrequest(RTM_DELETE, rt_key(oldrt),
915                                                   oldrt->rt_gateway,
916                                                   rt_mask(oldrt),
917                                                   oldrt->rt_flags, NULL);
918                                         rn = rnh->rnh_addaddr((char *)ndst,
919                                             (char *)
920                                                 rtinfo->rti_info[RTAX_NETMASK],
921                                             rnh, rt->rt_nodes);
922                                 }
923                         }
924                 }
925                 /* NOTE: rt_ifa may have been changed */
926                 ifa = rt->rt_ifa;
927
928                 /*
929                  * If it still failed to go into the tree,
930                  * then un-make it (this should be a function).
931                  */
932                 if (rn == NULL) {
933                         if (rt->rt_gwroute != NULL)
934                                 rtfree(rt->rt_gwroute);
935                         IFAFREE(ifa);
936                         Free(rt_key(rt));
937                         Free(rt);
938                         gotoerr(EEXIST);
939                 }
940
941                 /*
942                  * If we got here from RESOLVE, then we are cloning
943                  * so clone the rest, and note that we
944                  * are a clone (and increment the parent's references)
945                  */
946                 if (req == RTM_RESOLVE) {
947                         rt->rt_rmx = (*ret_nrt)->rt_rmx;    /* copy metrics */
948                         rt->rt_rmx.rmx_pksent = 0;  /* reset packet counter */
949                         if ((*ret_nrt)->rt_flags &
950                                        (RTF_CLONING | RTF_PRCLONING)) {
951                                 rt->rt_parent = *ret_nrt;
952                                 (*ret_nrt)->rt_refcnt++;
953                         }
954                 }
955
956                 /*
957                  * if this protocol has something to add to this then
958                  * allow it to do that as well.
959                  */
960                 if (ifa->ifa_rtrequest != NULL)
961                         ifa->ifa_rtrequest(req, rt);
962
963                 /*
964                  * We repeat the same procedure from rt_setgate() here because
965                  * it doesn't fire when we call it there because the node
966                  * hasn't been added to the tree yet.
967                  */
968                 if (req == RTM_ADD && !(rt->rt_flags & RTF_HOST) &&
969                     rt_mask(rt) != NULL) {
970                         struct rtfc_arg arg = { rt, rnh };
971
972                         rnh->rnh_walktree_from(rnh, (char *)rt_key(rt),
973                                                (char *)rt_mask(rt),
974                                                rt_fixchange, &arg);
975                 }
976
977 #ifdef ROUTE_DEBUG
978                 if (route_debug)
979                         rt_print(rtinfo, rt);
980 #endif
981                 /*
982                  * Return the resulting rtentry,
983                  * increasing the number of references by one.
984                  */
985                 if (ret_nrt != NULL) {
986                         rt->rt_refcnt++;
987                         *ret_nrt = rt;
988                 }
989                 break;
990         case RTM_GET:
991                 /* Get the item from the tree. */
992                 rn = rnh->rnh_lookup((char *)rtinfo->rti_info[RTAX_DST],
993                                      (char *)rtinfo->rti_info[RTAX_NETMASK],
994                                       rnh);
995                 if (rn == NULL)
996                         gotoerr(ESRCH);
997                 if (ret_nrt != NULL) {
998                         rt = (struct rtentry *)rn;
999                         rt->rt_refcnt++;
1000                         *ret_nrt = rt;
1001                 }
1002                 break;
1003         default:
1004                 error = EOPNOTSUPP;
1005         }
1006 bad:
1007 #ifdef ROUTE_DEBUG
1008         if (route_debug) {
1009                 if (error)
1010                         kprintf("rti %p failed error %d\n", rtinfo, error);
1011                 else
1012                         kprintf("rti %p succeeded\n", rtinfo);
1013         }
1014 #endif
1015         crit_exit();
1016         return (error);
1017 }
1018
1019 /*
1020  * Called from rtrequest(RTM_DELETE, ...) to fix up the route's ``family''
1021  * (i.e., the routes related to it by the operation of cloning).  This
1022  * routine is iterated over all potential former-child-routes by way of
1023  * rnh->rnh_walktree_from() above, and those that actually are children of
1024  * the late parent (passed in as VP here) are themselves deleted.
1025  */
1026 static int
1027 rt_fixdelete(struct radix_node *rn, void *vp)
1028 {
1029         struct rtentry *rt = (struct rtentry *)rn;
1030         struct rtentry *rt0 = vp;
1031
1032         if (rt->rt_parent == rt0 &&
1033             !(rt->rt_flags & (RTF_PINNED | RTF_CLONING | RTF_PRCLONING))) {
1034                 return rtrequest(RTM_DELETE, rt_key(rt), NULL, rt_mask(rt),
1035                                  rt->rt_flags, NULL);
1036         }
1037         return 0;
1038 }
1039
1040 /*
1041  * This routine is called from rt_setgate() to do the analogous thing for
1042  * adds and changes.  There is the added complication in this case of a
1043  * middle insert; i.e., insertion of a new network route between an older
1044  * network route and (cloned) host routes.  For this reason, a simple check
1045  * of rt->rt_parent is insufficient; each candidate route must be tested
1046  * against the (mask, value) of the new route (passed as before in vp)
1047  * to see if the new route matches it.
1048  *
1049  * XXX - it may be possible to do fixdelete() for changes and reserve this
1050  * routine just for adds.  I'm not sure why I thought it was necessary to do
1051  * changes this way.
1052  */
1053 #ifdef DEBUG
1054 static int rtfcdebug = 0;
1055 #endif
1056
1057 static int
1058 rt_fixchange(struct radix_node *rn, void *vp)
1059 {
1060         struct rtentry *rt = (struct rtentry *)rn;
1061         struct rtfc_arg *ap = vp;
1062         struct rtentry *rt0 = ap->rt0;
1063         struct radix_node_head *rnh = ap->rnh;
1064         u_char *xk1, *xm1, *xk2, *xmp;
1065         int i, len, mlen;
1066
1067 #ifdef DEBUG
1068         if (rtfcdebug)
1069                 kprintf("rt_fixchange: rt %p, rt0 %p\n", rt, rt0);
1070 #endif
1071
1072         if (rt->rt_parent == NULL ||
1073             (rt->rt_flags & (RTF_PINNED | RTF_CLONING | RTF_PRCLONING))) {
1074 #ifdef DEBUG
1075                 if (rtfcdebug) kprintf("no parent, pinned or cloning\n");
1076 #endif
1077                 return 0;
1078         }
1079
1080         if (rt->rt_parent == rt0) {
1081 #ifdef DEBUG
1082                 if (rtfcdebug) kprintf("parent match\n");
1083 #endif
1084                 return rtrequest(RTM_DELETE, rt_key(rt), NULL, rt_mask(rt),
1085                                  rt->rt_flags, NULL);
1086         }
1087
1088         /*
1089          * There probably is a function somewhere which does this...
1090          * if not, there should be.
1091          */
1092         len = imin(rt_key(rt0)->sa_len, rt_key(rt)->sa_len);
1093
1094         xk1 = (u_char *)rt_key(rt0);
1095         xm1 = (u_char *)rt_mask(rt0);
1096         xk2 = (u_char *)rt_key(rt);
1097
1098         /* avoid applying a less specific route */
1099         xmp = (u_char *)rt_mask(rt->rt_parent);
1100         mlen = rt_key(rt->rt_parent)->sa_len;
1101         if (mlen > rt_key(rt0)->sa_len) {
1102 #ifdef DEBUG
1103                 if (rtfcdebug)
1104                         kprintf("rt_fixchange: inserting a less "
1105                                "specific route\n");
1106 #endif
1107                 return 0;
1108         }
1109         for (i = rnh->rnh_treetop->rn_offset; i < mlen; i++) {
1110                 if ((xmp[i] & ~(xmp[i] ^ xm1[i])) != xmp[i]) {
1111 #ifdef DEBUG
1112                         if (rtfcdebug)
1113                                 kprintf("rt_fixchange: inserting a less "
1114                                        "specific route\n");
1115 #endif
1116                         return 0;
1117                 }
1118         }
1119
1120         for (i = rnh->rnh_treetop->rn_offset; i < len; i++) {
1121                 if ((xk2[i] & xm1[i]) != xk1[i]) {
1122 #ifdef DEBUG
1123                         if (rtfcdebug) kprintf("no match\n");
1124 #endif
1125                         return 0;
1126                 }
1127         }
1128
1129         /*
1130          * OK, this node is a clone, and matches the node currently being
1131          * changed/added under the node's mask.  So, get rid of it.
1132          */
1133 #ifdef DEBUG
1134         if (rtfcdebug) kprintf("deleting\n");
1135 #endif
1136         return rtrequest(RTM_DELETE, rt_key(rt), NULL, rt_mask(rt),
1137                          rt->rt_flags, NULL);
1138 }
1139
1140 int
1141 rt_setgate(struct rtentry *rt0, struct sockaddr *dst, struct sockaddr *gate)
1142 {
1143         char *space, *oldspace;
1144         int dlen = RT_ROUNDUP(dst->sa_len), glen = RT_ROUNDUP(gate->sa_len);
1145         struct rtentry *rt = rt0;
1146         struct radix_node_head *rnh = rt_tables[mycpuid][dst->sa_family];
1147
1148         ASSERT_NETISR_NCPUS(mycpuid);
1149
1150         /*
1151          * A host route with the destination equal to the gateway
1152          * will interfere with keeping LLINFO in the routing
1153          * table, so disallow it.
1154          */
1155         if (((rt0->rt_flags & (RTF_HOST | RTF_GATEWAY | RTF_LLINFO)) ==
1156                               (RTF_HOST | RTF_GATEWAY)) &&
1157             dst->sa_len == gate->sa_len &&
1158             sa_equal(dst, gate)) {
1159                 /*
1160                  * The route might already exist if this is an RTM_CHANGE
1161                  * or a routing redirect, so try to delete it.
1162                  */
1163                 if (rt_key(rt0) != NULL)
1164                         rtrequest(RTM_DELETE, rt_key(rt0), rt0->rt_gateway,
1165                                   rt_mask(rt0), rt0->rt_flags, NULL);
1166                 return EADDRNOTAVAIL;
1167         }
1168
1169         /*
1170          * Both dst and gateway are stored in the same malloc'ed chunk
1171          * (If I ever get my hands on....)
1172          * if we need to malloc a new chunk, then keep the old one around
1173          * till we don't need it any more.
1174          */
1175         if (rt->rt_gateway == NULL ||
1176             glen > RT_ROUNDUP(rt->rt_gateway->sa_len)) {
1177                 oldspace = (char *)rt_key(rt);
1178                 R_Malloc(space, char *, dlen + glen);
1179                 if (space == NULL)
1180                         return ENOBUFS;
1181                 rt->rt_nodes->rn_key = space;
1182         } else {
1183                 space = (char *)rt_key(rt);     /* Just use the old space. */
1184                 oldspace = NULL;
1185         }
1186
1187         /* Set the gateway value. */
1188         rt->rt_gateway = (struct sockaddr *)(space + dlen);
1189         bcopy(gate, rt->rt_gateway, glen);
1190
1191         if (oldspace != NULL) {
1192                 /*
1193                  * If we allocated a new chunk, preserve the original dst.
1194                  * This way, rt_setgate() really just sets the gate
1195                  * and leaves the dst field alone.
1196                  */
1197                 bcopy(dst, space, dlen);
1198                 Free(oldspace);
1199         }
1200
1201         /*
1202          * If there is already a gwroute, it's now almost definitely wrong
1203          * so drop it.
1204          */
1205         if (rt->rt_gwroute != NULL) {
1206                 RTFREE(rt->rt_gwroute);
1207                 rt->rt_gwroute = NULL;
1208         }
1209         if (rt->rt_flags & RTF_GATEWAY) {
1210                 /*
1211                  * Cloning loop avoidance: In the presence of
1212                  * protocol-cloning and bad configuration, it is
1213                  * possible to get stuck in bottomless mutual recursion
1214                  * (rtrequest rt_setgate rtlookup).  We avoid this
1215                  * by not allowing protocol-cloning to operate for
1216                  * gateways (which is probably the correct choice
1217                  * anyway), and avoid the resulting reference loops
1218                  * by disallowing any route to run through itself as
1219                  * a gateway.  This is obviously mandatory when we
1220                  * get rt->rt_output().
1221                  *
1222                  * This breaks TTCP for hosts outside the gateway!  XXX JH
1223                  */
1224                 rt->rt_gwroute = _rtlookup(gate, RTF_PRCLONING);
1225                 if (rt->rt_gwroute == rt) {
1226                         rt->rt_gwroute = NULL;
1227                         --rt->rt_refcnt;
1228                         return EDQUOT; /* failure */
1229                 }
1230         }
1231
1232         /*
1233          * This isn't going to do anything useful for host routes, so
1234          * don't bother.  Also make sure we have a reasonable mask
1235          * (we don't yet have one during adds).
1236          */
1237         if (!(rt->rt_flags & RTF_HOST) && rt_mask(rt) != NULL) {
1238                 struct rtfc_arg arg = { rt, rnh };
1239
1240                 rnh->rnh_walktree_from(rnh, (char *)rt_key(rt),
1241                                        (char *)rt_mask(rt),
1242                                        rt_fixchange, &arg);
1243         }
1244
1245         return 0;
1246 }
1247
1248 static void
1249 rt_maskedcopy(
1250         struct sockaddr *src,
1251         struct sockaddr *dst,
1252         struct sockaddr *netmask)
1253 {
1254         u_char *cp1 = (u_char *)src;
1255         u_char *cp2 = (u_char *)dst;
1256         u_char *cp3 = (u_char *)netmask;
1257         u_char *cplim = cp2 + *cp3;
1258         u_char *cplim2 = cp2 + *cp1;
1259
1260         *cp2++ = *cp1++; *cp2++ = *cp1++; /* copies sa_len & sa_family */
1261         cp3 += 2;
1262         if (cplim > cplim2)
1263                 cplim = cplim2;
1264         while (cp2 < cplim)
1265                 *cp2++ = *cp1++ & *cp3++;
1266         if (cp2 < cplim2)
1267                 bzero(cp2, cplim2 - cp2);
1268 }
1269
1270 int
1271 rt_llroute(struct sockaddr *dst, struct rtentry *rt0, struct rtentry **drt)
1272 {
1273         struct rtentry *up_rt, *rt;
1274
1275         ASSERT_NETISR_NCPUS(mycpuid);
1276
1277         if (!(rt0->rt_flags & RTF_UP)) {
1278                 up_rt = rtlookup(dst);
1279                 if (up_rt == NULL)
1280                         return (EHOSTUNREACH);
1281                 up_rt->rt_refcnt--;
1282         } else
1283                 up_rt = rt0;
1284         if (up_rt->rt_flags & RTF_GATEWAY) {
1285                 if (up_rt->rt_gwroute == NULL) {
1286                         up_rt->rt_gwroute = rtlookup(up_rt->rt_gateway);
1287                         if (up_rt->rt_gwroute == NULL)
1288                                 return (EHOSTUNREACH);
1289                 } else if (!(up_rt->rt_gwroute->rt_flags & RTF_UP)) {
1290                         rtfree(up_rt->rt_gwroute);
1291                         up_rt->rt_gwroute = rtlookup(up_rt->rt_gateway);
1292                         if (up_rt->rt_gwroute == NULL)
1293                                 return (EHOSTUNREACH);
1294                 }
1295                 rt = up_rt->rt_gwroute;
1296         } else
1297                 rt = up_rt;
1298         if (rt->rt_flags & RTF_REJECT &&
1299             (rt->rt_rmx.rmx_expire == 0 ||              /* rt doesn't expire */
1300              time_uptime < rt->rt_rmx.rmx_expire))      /* rt not expired */
1301                 return (rt->rt_flags & RTF_HOST ?  EHOSTDOWN : EHOSTUNREACH);
1302         *drt = rt;
1303         return 0;
1304 }
1305
1306 struct rt_purgecloned_arg {
1307         struct ifnet    *ifp;
1308         int             family;
1309 };
1310
1311 static int
1312 rt_purgecloned_callback(struct radix_node *rn, void *xap)
1313 {
1314         struct rtentry *rt = (struct rtentry *)rn;
1315         struct rt_purgecloned_arg *arg = xap;
1316
1317         if (rt->rt_ifp == arg->ifp && rt->rt_flags & RTF_WASCLONED)
1318                 rtrequest(RTM_DELETE, rt_key(rt), NULL, rt_mask(rt), 0, NULL);
1319         return 0;
1320 }
1321
1322 void
1323 rt_purgecloned(struct ifnet *ifp, int af)
1324 {
1325         struct radix_node_head *rnh;
1326         struct rt_purgecloned_arg arg = {
1327                 .ifp = ifp,
1328                 .family = af,
1329         };
1330
1331         ASSERT_NETISR0;
1332
1333         if ((rnh = rt_tables[mycpuid][af]) != NULL)
1334                 rnh->rnh_walktree(rnh, rt_purgecloned_callback, &arg);
1335 }
1336
1337 static int
1338 rt_setshims(struct rtentry *rt, struct sockaddr **rt_shim){
1339         int i;
1340         
1341         for (i=0; i<3; i++) {
1342                 struct sockaddr *shim = rt_shim[RTAX_MPLS1 + i];
1343                 int shimlen;
1344
1345                 if (shim == NULL)
1346                         break;
1347
1348                 shimlen = RT_ROUNDUP(shim->sa_len);
1349                 R_Malloc(rt->rt_shim[i], struct sockaddr *, shimlen);
1350                 bcopy(shim, rt->rt_shim[i], shimlen);
1351         }
1352
1353         return 0;
1354 }
1355
1356 #ifdef ROUTE_DEBUG
1357
1358 /*
1359  * Print out a route table entry
1360  */
1361 void
1362 rt_print(struct rt_addrinfo *rtinfo, struct rtentry *rn)
1363 {
1364         kprintf("rti %p cpu %d route %p flags %08lx: ", 
1365                 rtinfo, mycpuid, rn, rn->rt_flags);
1366         sockaddr_print(rt_key(rn));
1367         kprintf(" mask ");
1368         sockaddr_print(rt_mask(rn));
1369         kprintf(" gw ");
1370         sockaddr_print(rn->rt_gateway);
1371         kprintf(" ifc \"%s\"", rn->rt_ifp ? rn->rt_ifp->if_dname : "?");
1372         kprintf(" ifa %p\n", rn->rt_ifa);
1373 }
1374
1375 void
1376 rt_addrinfo_print(int cmd, struct rt_addrinfo *rti)
1377 {
1378         int didit = 0;
1379         int i;
1380
1381 #ifdef ROUTE_DEBUG
1382         if (cmd == RTM_DELETE && route_debug > 1)
1383                 print_backtrace(-1);
1384 #endif
1385
1386         switch(cmd) {
1387         case RTM_ADD:
1388                 kprintf("ADD ");
1389                 break;
1390         case RTM_RESOLVE:
1391                 kprintf("RES ");
1392                 break;
1393         case RTM_DELETE:
1394                 kprintf("DEL ");
1395                 break;
1396         default:
1397                 kprintf("C%02d ", cmd);
1398                 break;
1399         }
1400         kprintf("rti %p cpu %d ", rti, mycpuid);
1401         for (i = 0; i < rti->rti_addrs; ++i) {
1402                 if (rti->rti_info[i] == NULL)
1403                         continue;
1404                 if (didit)
1405                         kprintf(" ,");
1406                 switch(i) {
1407                 case RTAX_DST:
1408                         kprintf("(DST ");
1409                         break;
1410                 case RTAX_GATEWAY:
1411                         kprintf("(GWY ");
1412                         break;
1413                 case RTAX_NETMASK:
1414                         kprintf("(MSK ");
1415                         break;
1416                 case RTAX_GENMASK:
1417                         kprintf("(GEN ");
1418                         break;
1419                 case RTAX_IFP:
1420                         kprintf("(IFP ");
1421                         break;
1422                 case RTAX_IFA:
1423                         kprintf("(IFA ");
1424                         break;
1425                 case RTAX_AUTHOR:
1426                         kprintf("(AUT ");
1427                         break;
1428                 case RTAX_BRD:
1429                         kprintf("(BRD ");
1430                         break;
1431                 default:
1432                         kprintf("(?%02d ", i);
1433                         break;
1434                 }
1435                 sockaddr_print(rti->rti_info[i]);
1436                 kprintf(")");
1437                 didit = 1;
1438         }
1439         kprintf("\n");
1440 }
1441
1442 void
1443 sockaddr_print(const struct sockaddr *sa)
1444 {
1445         const struct sockaddr_in *sa4;
1446         const struct sockaddr_in6 *sa6;
1447         int len;
1448         int i;
1449
1450         if (sa == NULL) {
1451                 kprintf("NULL");
1452                 return;
1453         }
1454
1455         len = sa->sa_len - offsetof(struct sockaddr, sa_data[0]);
1456
1457         switch(sa->sa_family) {
1458         case AF_INET:
1459         case AF_INET6:
1460         default:
1461                 switch(sa->sa_family) {
1462                 case AF_INET:
1463                         sa4 = (const struct sockaddr_in *)sa;
1464                         kprintf("INET %d %d.%d.%d.%d",
1465                                 ntohs(sa4->sin_port),
1466                                 (ntohl(sa4->sin_addr.s_addr) >> 24) & 255,
1467                                 (ntohl(sa4->sin_addr.s_addr) >> 16) & 255,
1468                                 (ntohl(sa4->sin_addr.s_addr) >> 8) & 255,
1469                                 (ntohl(sa4->sin_addr.s_addr) >> 0) & 255
1470                         );
1471                         break;
1472                 case AF_INET6:
1473                         sa6 = (const struct sockaddr_in6 *)sa;
1474                         kprintf("INET6 %d %04x:%04x%04x:%04x:%04x:%04x:%04x:%04x",
1475                                 ntohs(sa6->sin6_port),
1476                                 ntohs(sa6->sin6_addr.s6_addr16[0]),
1477                                 ntohs(sa6->sin6_addr.s6_addr16[1]),
1478                                 ntohs(sa6->sin6_addr.s6_addr16[2]),
1479                                 ntohs(sa6->sin6_addr.s6_addr16[3]),
1480                                 ntohs(sa6->sin6_addr.s6_addr16[4]),
1481                                 ntohs(sa6->sin6_addr.s6_addr16[5]),
1482                                 ntohs(sa6->sin6_addr.s6_addr16[6]),
1483                                 ntohs(sa6->sin6_addr.s6_addr16[7])
1484                         );
1485                         break;
1486                 default:
1487                         kprintf("AF%d ", sa->sa_family);
1488                         while (len > 0 && sa->sa_data[len-1] == 0)
1489                                 --len;
1490
1491                         for (i = 0; i < len; ++i) {
1492                                 if (i)
1493                                         kprintf(".");
1494                                 kprintf("%d", (unsigned char)sa->sa_data[i]);
1495                         }
1496                         break;
1497                 }
1498         }
1499 }
1500
1501 #endif
1502
1503 /*
1504  * Set up a routing table entry, normally for an interface.
1505  */
1506 int
1507 rtinit(struct ifaddr *ifa, int cmd, int flags)
1508 {
1509         struct sockaddr *dst, *deldst, *netmask;
1510         struct mbuf *m = NULL;
1511         struct radix_node_head *rnh;
1512         struct radix_node *rn;
1513         struct rt_addrinfo rtinfo;
1514         int error;
1515
1516         ASSERT_NETISR0;
1517
1518         if (flags & RTF_HOST) {
1519                 dst = ifa->ifa_dstaddr;
1520                 netmask = NULL;
1521         } else {
1522                 dst = ifa->ifa_addr;
1523                 netmask = ifa->ifa_netmask;
1524         }
1525         /*
1526          * If it's a delete, check that if it exists, it's on the correct
1527          * interface or we might scrub a route to another ifa which would
1528          * be confusing at best and possibly worse.
1529          */
1530         if (cmd == RTM_DELETE) {
1531                 /*
1532                  * It's a delete, so it should already exist..
1533                  * If it's a net, mask off the host bits
1534                  * (Assuming we have a mask)
1535                  */
1536                 if (netmask != NULL) {
1537                         m = m_get(M_NOWAIT, MT_SONAME);
1538                         if (m == NULL)
1539                                 return (ENOBUFS);
1540                         mbuftrackid(m, 34);
1541                         deldst = mtod(m, struct sockaddr *);
1542                         rt_maskedcopy(dst, deldst, netmask);
1543                         dst = deldst;
1544                 }
1545                 /*
1546                  * Look up an rtentry that is in the routing tree and
1547                  * contains the correct info.
1548                  */
1549                 if ((rnh = rt_tables[mycpuid][dst->sa_family]) == NULL ||
1550                     (rn = rnh->rnh_lookup((char *)dst,
1551                                           (char *)netmask, rnh)) == NULL ||
1552                     ((struct rtentry *)rn)->rt_ifa != ifa ||
1553                     !sa_equal((struct sockaddr *)rn->rn_key, dst)) {
1554                         if (m != NULL)
1555                                 m_free(m);
1556                         return (flags & RTF_HOST ? EHOSTUNREACH : ENETUNREACH);
1557                 }
1558                 /* XXX */
1559 #if 0
1560                 else {
1561                         /*
1562                          * One would think that as we are deleting, and we know
1563                          * it doesn't exist, we could just return at this point
1564                          * with an "ELSE" clause, but apparently not..
1565                          */
1566                         return (flags & RTF_HOST ? EHOSTUNREACH : ENETUNREACH);
1567                 }
1568 #endif
1569         }
1570         /*
1571          * Do the actual request
1572          */
1573         bzero(&rtinfo, sizeof(struct rt_addrinfo));
1574         rtinfo.rti_info[RTAX_DST] = dst;
1575         rtinfo.rti_info[RTAX_GATEWAY] = ifa->ifa_addr;
1576         rtinfo.rti_info[RTAX_NETMASK] = netmask;
1577         rtinfo.rti_flags = flags | ifa->ifa_flags;
1578         rtinfo.rti_ifa = ifa;
1579         error = rtrequest1_global(cmd, &rtinfo, rtinit_rtrequest_callback, ifa,
1580             RTREQ_PRIO_HIGH);
1581         if (m != NULL)
1582                 m_free(m);
1583         return (error);
1584 }
1585
1586 static void
1587 rtinit_rtrequest_callback(int cmd, int error,
1588                           struct rt_addrinfo *rtinfo, struct rtentry *rt,
1589                           void *arg)
1590 {
1591         struct ifaddr *ifa = arg;
1592
1593         if (error == 0 && rt) {
1594                 if (mycpuid == 0)
1595                         rt_newaddrmsg(cmd, ifa, error, rt);
1596                 if (cmd == RTM_DELETE) {
1597                         if (rt->rt_refcnt == 0) {
1598                                 ++rt->rt_refcnt;
1599                                 rtfree(rt);
1600                         }
1601                 }
1602         }
1603 }
1604
1605 struct netmsg_rts {
1606         struct netmsg_base      base;
1607         int                     req;
1608         struct rt_addrinfo      *rtinfo;
1609         rtsearch_callback_func_t callback;
1610         void                    *arg;
1611         boolean_t               exact_match;
1612         int                     found_cnt;
1613 };
1614
1615 int
1616 rtsearch_global(int req, struct rt_addrinfo *rtinfo,
1617     rtsearch_callback_func_t callback, void *arg, boolean_t exact_match,
1618     boolean_t req_prio)
1619 {
1620         struct netmsg_rts msg;
1621         int flags = 0;
1622
1623         if (req_prio)
1624                 flags = MSGF_PRIORITY;
1625         netmsg_init(&msg.base, NULL, &curthread->td_msgport, flags,
1626             rtsearch_msghandler);
1627         msg.req = req;
1628         msg.rtinfo = rtinfo;
1629         msg.callback = callback;
1630         msg.arg = arg;
1631         msg.exact_match = exact_match;
1632         msg.found_cnt = 0;
1633         return (netisr_domsg_global(&msg.base));
1634 }
1635
1636 static void
1637 rtsearch_msghandler(netmsg_t msg)
1638 {
1639         struct netmsg_rts *rmsg = (void *)msg;
1640         struct rt_addrinfo rtinfo;
1641         struct radix_node_head *rnh;
1642         struct rtentry *rt;
1643         int error;
1644
1645         ASSERT_NETISR_NCPUS(mycpuid);
1646
1647         /*
1648          * Copy the rtinfo.  We need to make sure that the original
1649          * rtinfo, which is setup by the caller, in the netmsg will
1650          * _not_ be changed; else the next CPU on the netmsg forwarding
1651          * path will see a different rtinfo than what this CPU has seen.
1652          */
1653         rtinfo = *rmsg->rtinfo;
1654
1655         /*
1656          * Find the correct routing tree to use for this Address Family
1657          */
1658         if ((rnh = rt_tables[mycpuid][rtinfo.rti_dst->sa_family]) == NULL) {
1659                 if (mycpuid != 0)
1660                         panic("partially initialized routing tables");
1661                 netisr_replymsg(&rmsg->base, EAFNOSUPPORT);
1662                 return;
1663         }
1664
1665         /*
1666          * Correct rtinfo for the host route searching.
1667          */
1668         if (rtinfo.rti_flags & RTF_HOST) {
1669                 rtinfo.rti_netmask = NULL;
1670                 rtinfo.rti_flags &= ~(RTF_CLONING | RTF_PRCLONING);
1671         }
1672
1673         rt = (struct rtentry *)
1674              rnh->rnh_lookup((char *)rtinfo.rti_dst,
1675                              (char *)rtinfo.rti_netmask, rnh);
1676
1677         /*
1678          * If we are asked to do the "exact match", we need to make sure
1679          * that host route searching got a host route while a network
1680          * route searching got a network route.
1681          */
1682         if (rt != NULL && rmsg->exact_match &&
1683             ((rt->rt_flags ^ rtinfo.rti_flags) & RTF_HOST))
1684                 rt = NULL;
1685
1686         if (rt == NULL) {
1687                 /*
1688                  * No matching routes have been found, don't count this
1689                  * as a critical error (here, we set 'error' to 0), just
1690                  * keep moving on, since at least prcloned routes are not
1691                  * duplicated onto each CPU.
1692                  */
1693                 error = 0;
1694         } else {
1695                 rmsg->found_cnt++;
1696
1697                 rt->rt_refcnt++;
1698                 error = rmsg->callback(rmsg->req, &rtinfo, rt, rmsg->arg,
1699                                       rmsg->found_cnt);
1700                 rt->rt_refcnt--;
1701
1702                 if (error == EJUSTRETURN) {
1703                         netisr_replymsg(&rmsg->base, 0);
1704                         return;
1705                 }
1706         }
1707
1708         if (error) {
1709                 KKASSERT(rmsg->found_cnt > 0);
1710
1711                 /*
1712                  * Under following cases, unrecoverable error has
1713                  * not occured:
1714                  * o  Request is RTM_GET
1715                  * o  The first time that we find the route, but the
1716                  *    modification fails.
1717                  */
1718                 if (rmsg->req != RTM_GET && rmsg->found_cnt > 1) {
1719                         panic("rtsearch_msghandler: unrecoverable error "
1720                               "cpu %d", mycpuid);
1721                 }
1722                 netisr_replymsg(&rmsg->base, error);
1723         } else {
1724                 if (rmsg->found_cnt == 0) {
1725                         /* The requested route has not been seen ... */
1726                         error = ESRCH;
1727                 }
1728                 netisr_forwardmsg_error(&rmsg->base, mycpuid + 1, error);
1729         }
1730 }
1731
1732 int
1733 rtmask_add_global(struct sockaddr *mask, boolean_t req_prio)
1734 {
1735         struct netmsg_base msg;
1736         int flags = 0;
1737
1738         if (req_prio)
1739                 flags = MSGF_PRIORITY;
1740         netmsg_init(&msg, NULL, &curthread->td_msgport, flags,
1741             rtmask_add_msghandler);
1742         msg.lmsg.u.ms_resultp = mask;
1743
1744         return (netisr_domsg_global(&msg));
1745 }
1746
1747 struct sockaddr *
1748 _rtmask_lookup(struct sockaddr *mask, boolean_t search)
1749 {
1750         struct radix_node *n;
1751
1752 #define clen(s) (*(u_char *)(s))
1753         n = rn_addmask((char *)mask, search, 1, rn_cpumaskhead(mycpuid));
1754         if (n != NULL &&
1755             mask->sa_len >= clen(n->rn_key) &&
1756             bcmp((char *)mask + 1,
1757                  (char *)n->rn_key + 1, clen(n->rn_key) - 1) == 0) {
1758                 return (struct sockaddr *)n->rn_key;
1759         } else {
1760                 return NULL;
1761         }
1762 #undef clen
1763 }
1764
1765 static void
1766 rtmask_add_msghandler(netmsg_t msg)
1767 {
1768         struct sockaddr *mask = msg->lmsg.u.ms_resultp;
1769
1770         ASSERT_NETISR_NCPUS(mycpuid);
1771
1772         if (rtmask_lookup(mask) == NULL) {
1773                 netisr_replymsg(&msg->base, ENOBUFS);
1774                 return;
1775         }
1776         netisr_forwardmsg(&msg->base, mycpuid + 1);
1777 }
1778
1779 /* This must be before ip6_init2(), which is now SI_ORDER_MIDDLE */
1780 SYSINIT(route, SI_SUB_PROTO_DOMAIN, SI_ORDER_THIRD, route_init, 0);
1781
1782 struct rtchange_arg {
1783         struct ifaddr   *old_ifa;
1784         struct ifaddr   *new_ifa;
1785         struct rtentry  *rt;
1786         int             changed;
1787 };
1788
1789 static void
1790 rtchange_ifa(struct rtentry *rt, struct rtchange_arg *ap)
1791 {
1792         if (rt->rt_ifa->ifa_rtrequest != NULL)
1793                 rt->rt_ifa->ifa_rtrequest(RTM_DELETE, rt);
1794         IFAFREE(rt->rt_ifa);
1795
1796         IFAREF(ap->new_ifa);
1797         rt->rt_ifa = ap->new_ifa;
1798         rt->rt_ifp = ap->new_ifa->ifa_ifp;
1799         if (rt->rt_ifa->ifa_rtrequest != NULL)
1800                 rt->rt_ifa->ifa_rtrequest(RTM_ADD, rt);
1801
1802         ap->changed = 1;
1803 }
1804
1805 static int
1806 rtchange_callback(struct radix_node *rn, void *xap)
1807 {
1808         struct rtchange_arg *ap = xap;
1809         struct rtentry *rt = (struct rtentry *)rn;
1810
1811         if (rt->rt_ifa == ap->old_ifa) {
1812                 if (rt->rt_flags & (RTF_CLONING | RTF_PRCLONING)) {
1813                         /*
1814                          * We could saw the branch off when we are
1815                          * still sitting on it, if the ifa_rtrequest
1816                          * DEL/ADD are called directly from here.
1817                          */
1818                         ap->rt = rt;
1819                         return EJUSTRETURN;
1820                 }
1821                 rtchange_ifa(rt, ap);
1822         }
1823         return 0;
1824 }
1825
1826 struct netmsg_rtchange {
1827         struct netmsg_base      base;
1828         struct ifaddr           *old_ifa;
1829         struct ifaddr           *new_ifa;
1830         int                     changed;
1831 };
1832
1833 static void
1834 rtchange_dispatch(netmsg_t msg)
1835 {
1836         struct netmsg_rtchange *rmsg = (void *)msg;
1837         struct radix_node_head *rnh;
1838         struct rtchange_arg arg;
1839         int cpu;
1840
1841         cpu = mycpuid;
1842         ASSERT_NETISR_NCPUS(cpu);
1843
1844         memset(&arg, 0, sizeof(arg));
1845         arg.old_ifa = rmsg->old_ifa;
1846         arg.new_ifa = rmsg->new_ifa;
1847
1848         rnh = rt_tables[cpu][AF_INET];
1849         for (;;) {
1850                 int error;
1851
1852                 KKASSERT(arg.rt == NULL);
1853                 error = rnh->rnh_walktree(rnh, rtchange_callback, &arg);
1854                 if (arg.rt != NULL) {
1855                         struct rtentry *rt;
1856
1857                         rt = arg.rt;
1858                         arg.rt = NULL;
1859                         rtchange_ifa(rt, &arg);
1860                 } else {
1861                         break;
1862                 }
1863         }
1864         if (arg.changed)
1865                 rmsg->changed = 1;
1866
1867         netisr_forwardmsg(&rmsg->base, cpu + 1);
1868 }
1869
1870 int
1871 rtchange(struct ifaddr *old_ifa, struct ifaddr *new_ifa)
1872 {
1873         struct netmsg_rtchange msg;
1874
1875         /*
1876          * XXX individual requests are not independantly chained,
1877          * which means that the per-cpu route tables will not be
1878          * consistent in the middle of the operation.  If routes
1879          * related to the interface are manipulated while we are
1880          * doing this the inconsistancy could trigger a panic.
1881          */
1882         netmsg_init(&msg.base, NULL, &curthread->td_msgport, MSGF_PRIORITY,
1883             rtchange_dispatch);
1884         msg.old_ifa = old_ifa;
1885         msg.new_ifa = new_ifa;
1886         msg.changed = 0;
1887         netisr_domsg_global(&msg.base);
1888
1889         if (msg.changed) {
1890                 old_ifa->ifa_flags &= ~IFA_ROUTE;
1891                 new_ifa->ifa_flags |= IFA_ROUTE;
1892                 return 0;
1893         } else {
1894                 return ENOENT;
1895         }
1896 }