2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1980, 1986, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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 University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * @(#)route.c 8.3.1.1 (Berkeley) 2/23/95
34 /************************************************************************
35 * Note: In this file a 'fib' is a "forwarding information base" *
36 * Which is the new name for an in kernel routing (next hop) table. *
37 ***********************************************************************/
40 #include "opt_inet6.h"
41 #include "opt_route.h"
43 #include "opt_mrouting.h"
44 #include "opt_mpath.h"
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/malloc.h>
50 #include <sys/socket.h>
51 #include <sys/sysctl.h>
52 #include <sys/syslog.h>
53 #include <sys/sysproto.h>
55 #include <sys/domain.h>
56 #include <sys/kernel.h>
58 #include <sys/rmlock.h>
61 #include <net/if_var.h>
62 #include <net/if_dl.h>
63 #include <net/route.h>
64 #include <net/route_var.h>
68 #include <net/radix_mpath.h>
71 #include <netinet/in.h>
72 #include <netinet/ip_mroute.h>
76 #define RT_MAXFIBS UINT16_MAX
78 /* Kernel config default option. */
81 #error "ROUTETABLES defined too low"
83 #if ROUTETABLES > RT_MAXFIBS
84 #error "ROUTETABLES defined too big"
86 #define RT_NUMFIBS ROUTETABLES
87 #endif /* ROUTETABLES */
88 /* Initialize to default if not otherwise set. */
93 #if defined(INET) || defined(INET6)
95 extern void sctp_addr_change(struct ifaddr *ifa, int cmd);
100 /* This is read-only.. */
101 u_int rt_numfibs = RT_NUMFIBS;
102 SYSCTL_UINT(_net, OID_AUTO, fibs, CTLFLAG_RDTUN, &rt_numfibs, 0, "");
105 * By default add routes to all fibs for new interfaces.
106 * Once this is set to 0 then only allocate routes on interface
107 * changes for the FIB of the caller when adding a new set of addresses
108 * to an interface. XXX this is a shotgun aproach to a problem that needs
109 * a more fine grained solution.. that will come.
110 * XXX also has the problems getting the FIB from curthread which will not
111 * always work given the fib can be overridden and prefixes can be added
112 * from the network stack context.
114 VNET_DEFINE(u_int, rt_add_addr_allfibs) = 1;
115 SYSCTL_UINT(_net, OID_AUTO, add_addr_allfibs, CTLFLAG_RWTUN | CTLFLAG_VNET,
116 &VNET_NAME(rt_add_addr_allfibs), 0, "");
118 VNET_DEFINE(struct rtstat, rtstat);
119 #define V_rtstat VNET(rtstat)
121 VNET_DEFINE(struct rib_head *, rt_tables);
122 #define V_rt_tables VNET(rt_tables)
124 VNET_DEFINE(int, rttrash); /* routes not in table but not freed */
125 #define V_rttrash VNET(rttrash)
129 * Convert a 'struct radix_node *' to a 'struct rtentry *'.
130 * The operation can be done safely (in this code) because a
131 * 'struct rtentry' starts with two 'struct radix_node''s, the first
132 * one representing leaf nodes in the routing tree, which is
133 * what the code in radix.c passes us as a 'struct radix_node'.
135 * But because there are a lot of assumptions in this conversion,
136 * do not cast explicitly, but always use the macro below.
138 #define RNTORT(p) ((struct rtentry *)(p))
140 VNET_DEFINE_STATIC(uma_zone_t, rtzone); /* Routing table UMA zone. */
141 #define V_rtzone VNET(rtzone)
143 static int rtrequest1_fib_change(struct rib_head *, struct rt_addrinfo *,
144 struct rtentry **, u_int);
145 static void rt_setmetrics(const struct rt_addrinfo *, struct rtentry *);
146 static int rt_ifdelroute(const struct rtentry *rt, void *arg);
147 static struct rtentry *rt_unlinkrte(struct rib_head *rnh,
148 struct rt_addrinfo *info, int *perror);
149 static void rt_notifydelete(struct rtentry *rt, struct rt_addrinfo *info);
151 static struct radix_node *rt_mpath_unlink(struct rib_head *rnh,
152 struct rt_addrinfo *info, struct rtentry *rto, int *perror);
154 static int rt_exportinfo(struct rtentry *rt, struct rt_addrinfo *info,
163 static int if_updatemtu_cb(struct radix_node *, void *);
166 * handler for net.my_fibnum
169 sysctl_my_fibnum(SYSCTL_HANDLER_ARGS)
174 fibnum = curthread->td_proc->p_fibnum;
175 error = sysctl_handle_int(oidp, &fibnum, 0, req);
179 SYSCTL_PROC(_net, OID_AUTO, my_fibnum, CTLTYPE_INT|CTLFLAG_RD,
180 NULL, 0, &sysctl_my_fibnum, "I", "default FIB of caller");
182 static __inline struct rib_head **
183 rt_tables_get_rnh_ptr(int table, int fam)
185 struct rib_head **rnh;
187 KASSERT(table >= 0 && table < rt_numfibs, ("%s: table out of bounds.",
189 KASSERT(fam >= 0 && fam < (AF_MAX+1), ("%s: fam out of bounds.",
192 /* rnh is [fib=0][af=0]. */
193 rnh = (struct rib_head **)V_rt_tables;
194 /* Get the offset to the requested table and fam. */
195 rnh += table * (AF_MAX+1) + fam;
201 rt_tables_get_rnh(int table, int fam)
204 return (*rt_tables_get_rnh_ptr(table, fam));
208 rt_tables_get_gen(int table, int fam)
210 struct rib_head *rnh;
212 rnh = *rt_tables_get_rnh_ptr(table, fam);
213 KASSERT(rnh != NULL, ("%s: NULL rib_head pointer table %d fam %d",
214 __func__, table, fam));
215 return (rnh->rnh_gen);
220 * route initialization must occur before ip6_init2(), which happenas at
227 /* whack the tunable ints into line. */
228 if (rt_numfibs > RT_MAXFIBS)
229 rt_numfibs = RT_MAXFIBS;
233 SYSINIT(route_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_THIRD, route_init, NULL);
236 rtentry_zinit(void *mem, int size, int how)
238 struct rtentry *rt = mem;
240 rt->rt_pksent = counter_u64_alloc(how);
241 if (rt->rt_pksent == NULL)
250 rtentry_zfini(void *mem, int size)
252 struct rtentry *rt = mem;
255 counter_u64_free(rt->rt_pksent);
259 rtentry_ctor(void *mem, int size, void *arg, int how)
261 struct rtentry *rt = mem;
263 bzero(rt, offsetof(struct rtentry, rt_endzero));
264 counter_u64_zero(rt->rt_pksent);
271 rtentry_dtor(void *mem, int size, void *arg)
273 struct rtentry *rt = mem;
279 vnet_route_init(const void *unused __unused)
282 struct rib_head **rnh;
286 V_rt_tables = malloc(rt_numfibs * (AF_MAX+1) *
287 sizeof(struct rib_head *), M_RTABLE, M_WAITOK|M_ZERO);
289 V_rtzone = uma_zcreate("rtentry", sizeof(struct rtentry),
290 rtentry_ctor, rtentry_dtor,
291 rtentry_zinit, rtentry_zfini, UMA_ALIGN_PTR, 0);
292 for (dom = domains; dom; dom = dom->dom_next) {
293 if (dom->dom_rtattach == NULL)
296 for (table = 0; table < rt_numfibs; table++) {
297 fam = dom->dom_family;
298 if (table != 0 && fam != AF_INET6 && fam != AF_INET)
301 rnh = rt_tables_get_rnh_ptr(table, fam);
303 panic("%s: rnh NULL", __func__);
304 dom->dom_rtattach((void **)rnh, 0);
308 VNET_SYSINIT(vnet_route_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_FOURTH,
313 vnet_route_uninit(const void *unused __unused)
318 struct rib_head **rnh;
320 for (dom = domains; dom; dom = dom->dom_next) {
321 if (dom->dom_rtdetach == NULL)
324 for (table = 0; table < rt_numfibs; table++) {
325 fam = dom->dom_family;
327 if (table != 0 && fam != AF_INET6 && fam != AF_INET)
330 rnh = rt_tables_get_rnh_ptr(table, fam);
332 panic("%s: rnh NULL", __func__);
333 dom->dom_rtdetach((void **)rnh, 0);
337 free(V_rt_tables, M_RTABLE);
338 uma_zdestroy(V_rtzone);
340 VNET_SYSUNINIT(vnet_route_uninit, SI_SUB_PROTO_DOMAIN, SI_ORDER_FIRST,
341 vnet_route_uninit, 0);
345 rt_table_init(int offset)
349 rh = malloc(sizeof(struct rib_head), M_RTABLE, M_WAITOK | M_ZERO);
351 /* TODO: These details should be hidded inside radix.c */
352 /* Init masks tree */
353 rn_inithead_internal(&rh->head, rh->rnh_nodes, offset);
354 rn_inithead_internal(&rh->rmhead.head, rh->rmhead.mask_nodes, 0);
355 rh->head.rnh_masks = &rh->rmhead;
360 /* Finally, set base callbacks */
361 rh->rnh_addaddr = rn_addroute;
362 rh->rnh_deladdr = rn_delete;
363 rh->rnh_matchaddr = rn_match;
364 rh->rnh_lookup = rn_lookup;
365 rh->rnh_walktree = rn_walktree;
366 rh->rnh_walktree_from = rn_walktree_from;
372 rt_freeentry(struct radix_node *rn, void *arg)
374 struct radix_head * const rnh = arg;
375 struct radix_node *x;
377 x = (struct radix_node *)rn_delete(rn + 2, NULL, rnh);
384 rt_table_destroy(struct rib_head *rh)
387 rn_walktree(&rh->rmhead.head, rt_freeentry, &rh->rmhead.head);
389 /* Assume table is already empty */
390 RIB_LOCK_DESTROY(rh);
395 #ifndef _SYS_SYSPROTO_H_
401 sys_setfib(struct thread *td, struct setfib_args *uap)
403 if (uap->fibnum < 0 || uap->fibnum >= rt_numfibs)
405 td->td_proc->p_fibnum = uap->fibnum;
410 * Packet routing routines.
413 rtalloc_ign_fib(struct route *ro, u_long ignore, u_int fibnum)
417 if ((rt = ro->ro_rt) != NULL) {
418 if (rt->rt_ifp != NULL && rt->rt_flags & RTF_UP)
423 ro->ro_rt = rtalloc1_fib(&ro->ro_dst, 1, ignore, fibnum);
425 RT_UNLOCK(ro->ro_rt);
429 * Look up the route that matches the address given
430 * Or, at least try.. Create a cloned route if needed.
432 * The returned route, if any, is locked.
435 rtalloc1(struct sockaddr *dst, int report, u_long ignflags)
438 return (rtalloc1_fib(dst, report, ignflags, RT_DEFAULT_FIB));
442 rtalloc1_fib(struct sockaddr *dst, int report, u_long ignflags,
447 struct radix_node *rn;
448 struct rtentry *newrt;
449 struct rt_addrinfo info;
450 int err = 0, msgtype = RTM_MISS;
452 KASSERT((fibnum < rt_numfibs), ("rtalloc1_fib: bad fibnum"));
453 rh = rt_tables_get_rnh(fibnum, dst->sa_family);
459 * Look up the address in the table for that Address Family
461 if ((ignflags & RTF_RNH_LOCKED) == 0)
467 rn = rh->rnh_matchaddr(dst, &rh->head);
468 if (rn && ((rn->rn_flags & RNF_ROOT) == 0)) {
472 if ((ignflags & RTF_RNH_LOCKED) == 0)
476 } else if ((ignflags & RTF_RNH_LOCKED) == 0)
479 * Either we hit the root or could not find any match,
480 * which basically means: "cannot get there from here".
483 V_rtstat.rts_unreach++;
487 * If required, report the failure to the supervising
489 * For a delete, this is not an error. (report == 0)
491 bzero(&info, sizeof(info));
492 info.rti_info[RTAX_DST] = dst;
493 rt_missmsg_fib(msgtype, &info, 0, err, fibnum);
499 * Remove a reference count from an rtentry.
500 * If the count gets low enough, take it out of the routing table
503 rtfree(struct rtentry *rt)
505 struct rib_head *rnh;
507 KASSERT(rt != NULL,("%s: NULL rt", __func__));
508 rnh = rt_tables_get_rnh(rt->rt_fibnum, rt_key(rt)->sa_family);
509 KASSERT(rnh != NULL,("%s: NULL rnh", __func__));
514 * The callers should use RTFREE_LOCKED() or RTFREE(), so
515 * we should come here exactly with the last reference.
518 if (rt->rt_refcnt > 0) {
519 log(LOG_DEBUG, "%s: %p has %d refs\n", __func__, rt, rt->rt_refcnt);
524 * On last reference give the "close method" a chance
525 * to cleanup private state. This also permits (for
526 * IPv4 and IPv6) a chance to decide if the routing table
527 * entry should be purged immediately or at a later time.
528 * When an immediate purge is to happen the close routine
529 * typically calls rtexpunge which clears the RTF_UP flag
530 * on the entry so that the code below reclaims the storage.
532 if (rt->rt_refcnt == 0 && rnh->rnh_close)
533 rnh->rnh_close((struct radix_node *)rt, &rnh->head);
536 * If we are no longer "up" (and ref == 0)
537 * then we can free the resources associated
540 if ((rt->rt_flags & RTF_UP) == 0) {
541 if (rt->rt_nodes->rn_flags & (RNF_ACTIVE | RNF_ROOT))
544 * the rtentry must have been removed from the routing table
545 * so it is represented in rttrash.. remove that now.
549 if (rt->rt_refcnt < 0) {
550 printf("rtfree: %p not freed (neg refs)\n", rt);
555 * release references on items we hold them on..
556 * e.g other routes and ifaddrs.
559 ifa_free(rt->rt_ifa);
561 * The key is separatly alloc'd so free it (see rt_setgate()).
562 * This also frees the gateway, as they are always malloc'd
568 * and the rtentry itself of course
570 uma_zfree(V_rtzone, rt);
579 * Force a routing table entry to the specified
580 * destination to go through the given gateway.
581 * Normally called as a result of a routing redirect
582 * message from the network layer.
585 rtredirect_fib(struct sockaddr *dst,
586 struct sockaddr *gateway,
587 struct sockaddr *netmask,
589 struct sockaddr *src,
595 struct rt_addrinfo info;
597 struct rib_head *rnh;
601 rnh = rt_tables_get_rnh(fibnum, dst->sa_family);
603 error = EAFNOSUPPORT;
606 /* verify the gateway is directly reachable */
607 if ((ifa = ifa_ifwithnet(gateway, 0, fibnum)) == NULL) {
611 rt = rtalloc1_fib(dst, 0, 0UL, fibnum); /* NB: rt is locked */
613 * If the redirect isn't from our current router for this dst,
614 * it's either old or wrong. If it redirects us to ourselves,
615 * we have a routing loop, perhaps as a result of an interface
616 * going down recently.
618 if (!(flags & RTF_DONE) && rt) {
619 if (!sa_equal(src, rt->rt_gateway)) {
623 if (rt->rt_ifa != ifa && ifa->ifa_addr->sa_family != AF_LINK) {
628 if ((flags & RTF_GATEWAY) && ifa_ifwithaddr_check(gateway)) {
629 error = EHOSTUNREACH;
633 * Create a new entry if we just got back a wildcard entry
634 * or the lookup failed. This is necessary for hosts
635 * which use routing redirects generated by smart gateways
636 * to dynamically build the routing tables.
638 if (rt == NULL || (rt_mask(rt) && rt_mask(rt)->sa_len < 2))
641 * Don't listen to the redirect if it's
642 * for a route to an interface.
644 if (rt->rt_flags & RTF_GATEWAY) {
645 if (((rt->rt_flags & RTF_HOST) == 0) && (flags & RTF_HOST)) {
647 * Changing from route to net => route to host.
648 * Create new route, rather than smashing route to net.
654 flags |= RTF_DYNAMIC;
655 bzero((caddr_t)&info, sizeof(info));
656 info.rti_info[RTAX_DST] = dst;
657 info.rti_info[RTAX_GATEWAY] = gateway;
658 info.rti_info[RTAX_NETMASK] = netmask;
661 info.rti_flags = flags;
662 error = rtrequest1_fib(RTM_ADD, &info, &rt, fibnum);
665 flags = rt->rt_flags;
668 stat = &V_rtstat.rts_dynamic;
672 * Smash the current notion of the gateway to
673 * this destination. Should check about netmask!!!
675 if ((flags & RTF_GATEWAY) == 0)
676 rt->rt_flags &= ~RTF_GATEWAY;
677 rt->rt_flags |= RTF_MODIFIED;
678 flags |= RTF_MODIFIED;
679 stat = &V_rtstat.rts_newgateway;
681 * add the key and gateway (in one malloc'd chunk).
686 rt_setgate(rt, rt_key(rt), gateway);
690 error = EHOSTUNREACH;
697 V_rtstat.rts_badredirect++;
698 else if (stat != NULL)
700 bzero((caddr_t)&info, sizeof(info));
701 info.rti_info[RTAX_DST] = dst;
702 info.rti_info[RTAX_GATEWAY] = gateway;
703 info.rti_info[RTAX_NETMASK] = netmask;
704 info.rti_info[RTAX_AUTHOR] = src;
705 rt_missmsg_fib(RTM_REDIRECT, &info, flags, error, fibnum);
709 * Routing table ioctl interface.
712 rtioctl_fib(u_long req, caddr_t data, u_int fibnum)
716 * If more ioctl commands are added here, make sure the proper
717 * super-user checks are being performed because it is possible for
718 * prison-root to make it this far if raw sockets have been enabled
722 /* Multicast goop, grrr... */
723 return mrt_ioctl ? mrt_ioctl(req, data, fibnum) : EOPNOTSUPP;
730 ifa_ifwithroute(int flags, const struct sockaddr *dst, struct sockaddr *gateway,
736 MPASS(in_epoch(net_epoch_preempt));
737 if ((flags & RTF_GATEWAY) == 0) {
739 * If we are adding a route to an interface,
740 * and the interface is a pt to pt link
741 * we should search for the destination
742 * as our clue to the interface. Otherwise
743 * we can use the local address.
746 if (flags & RTF_HOST)
747 ifa = ifa_ifwithdstaddr(dst, fibnum);
749 ifa = ifa_ifwithaddr(gateway);
752 * If we are adding a route to a remote net
753 * or host, the gateway may still be on the
754 * other end of a pt to pt link.
756 ifa = ifa_ifwithdstaddr(gateway, fibnum);
759 ifa = ifa_ifwithnet(gateway, 0, fibnum);
763 rt = rtalloc1_fib(gateway, 0, flags, fibnum);
767 * dismiss a gateway that is reachable only
768 * through the default router
770 switch (gateway->sa_family) {
772 if (satosin(rt_key(rt))->sin_addr.s_addr == INADDR_ANY)
776 if (IN6_IS_ADDR_UNSPECIFIED(&satosin6(rt_key(rt))->sin6_addr))
782 if (!not_found && rt->rt_ifa != NULL) {
787 if (not_found || ifa == NULL)
790 if (ifa->ifa_addr->sa_family != dst->sa_family) {
791 struct ifaddr *oifa = ifa;
792 ifa = ifaof_ifpforaddr(dst, ifa->ifa_ifp);
801 * Do appropriate manipulations of a routing tree given
802 * all the bits of info needed
805 rtrequest_fib(int req,
806 struct sockaddr *dst,
807 struct sockaddr *gateway,
808 struct sockaddr *netmask,
810 struct rtentry **ret_nrt,
813 struct rt_addrinfo info;
815 if (dst->sa_len == 0)
818 bzero((caddr_t)&info, sizeof(info));
819 info.rti_flags = flags;
820 info.rti_info[RTAX_DST] = dst;
821 info.rti_info[RTAX_GATEWAY] = gateway;
822 info.rti_info[RTAX_NETMASK] = netmask;
823 return rtrequest1_fib(req, &info, ret_nrt, fibnum);
828 * Copy most of @rt data into @info.
830 * If @flags contains NHR_COPY, copies dst,netmask and gw to the
831 * pointers specified by @info structure. Assume such pointers
832 * are zeroed sockaddr-like structures with sa_len field initialized
833 * to reflect size of the provided buffer. if no NHR_COPY is specified,
834 * point dst,netmask and gw @info fields to appropriate @rt values.
836 * if @flags contains NHR_REF, do refcouting on rt_ifp.
838 * Returns 0 on success.
841 rt_exportinfo(struct rtentry *rt, struct rt_addrinfo *info, int flags)
843 struct rt_metrics *rmx;
844 struct sockaddr *src, *dst;
847 if (flags & NHR_COPY) {
848 /* Copy destination if dst is non-zero */
850 dst = info->rti_info[RTAX_DST];
851 sa_len = src->sa_len;
853 if (src->sa_len > dst->sa_len)
855 memcpy(dst, src, src->sa_len);
856 info->rti_addrs |= RTA_DST;
859 /* Copy mask if set && dst is non-zero */
861 dst = info->rti_info[RTAX_NETMASK];
862 if (src != NULL && dst != NULL) {
865 * Radix stores different value in sa_len,
866 * assume rt_mask() to have the same length
869 if (sa_len > dst->sa_len)
871 memcpy(dst, src, src->sa_len);
872 info->rti_addrs |= RTA_NETMASK;
875 /* Copy gateway is set && dst is non-zero */
876 src = rt->rt_gateway;
877 dst = info->rti_info[RTAX_GATEWAY];
878 if ((rt->rt_flags & RTF_GATEWAY) && src != NULL && dst != NULL){
879 if (src->sa_len > dst->sa_len)
881 memcpy(dst, src, src->sa_len);
882 info->rti_addrs |= RTA_GATEWAY;
885 info->rti_info[RTAX_DST] = rt_key(rt);
886 info->rti_addrs |= RTA_DST;
887 if (rt_mask(rt) != NULL) {
888 info->rti_info[RTAX_NETMASK] = rt_mask(rt);
889 info->rti_addrs |= RTA_NETMASK;
891 if (rt->rt_flags & RTF_GATEWAY) {
892 info->rti_info[RTAX_GATEWAY] = rt->rt_gateway;
893 info->rti_addrs |= RTA_GATEWAY;
899 info->rti_mflags |= RTV_MTU;
900 rmx->rmx_mtu = rt->rt_mtu;
903 info->rti_flags = rt->rt_flags;
904 info->rti_ifp = rt->rt_ifp;
905 info->rti_ifa = rt->rt_ifa;
906 ifa_ref(info->rti_ifa);
907 if (flags & NHR_REF) {
908 /* Do 'traditional' refcouting */
909 if_ref(info->rti_ifp);
916 * Lookups up route entry for @dst in RIB database for fib @fibnum.
917 * Exports entry data to @info using rt_exportinfo().
919 * if @flags contains NHR_REF, refcouting is performed on rt_ifp.
920 * All references can be released later by calling rib_free_info()
922 * Returns 0 on success.
923 * Returns ENOENT for lookup failure, ENOMEM for export failure.
926 rib_lookup_info(uint32_t fibnum, const struct sockaddr *dst, uint32_t flags,
927 uint32_t flowid, struct rt_addrinfo *info)
931 struct radix_node *rn;
935 KASSERT((fibnum < rt_numfibs), ("rib_lookup_rte: bad fibnum"));
936 rh = rt_tables_get_rnh(fibnum, dst->sa_family);
941 rn = rh->rnh_matchaddr(__DECONST(void *, dst), &rh->head);
942 if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
944 /* Ensure route & ifp is UP */
945 if (RT_LINK_IS_UP(rt->rt_ifp)) {
946 flags = (flags & NHR_REF) | NHR_COPY;
947 error = rt_exportinfo(rt, info, flags);
959 * Releases all references acquired by rib_lookup_info() when
960 * called with NHR_REF flags.
963 rib_free_info(struct rt_addrinfo *info)
966 if_rele(info->rti_ifp);
970 * Iterates over all existing fibs in system calling
971 * @setwa_f function prior to traversing each fib.
972 * Calls @wa_f function for each element in current fib.
973 * If af is not AF_UNSPEC, iterates over fibs in particular
977 rt_foreach_fib_walk(int af, rt_setwarg_t *setwa_f, rt_walktree_f_t *wa_f,
980 struct rib_head *rnh;
984 for (fibnum = 0; fibnum < rt_numfibs; fibnum++) {
985 /* Do we want some specific family? */
986 if (af != AF_UNSPEC) {
987 rnh = rt_tables_get_rnh(fibnum, af);
991 setwa_f(rnh, fibnum, af, arg);
994 rnh->rnh_walktree(&rnh->head, (walktree_f_t *)wa_f,arg);
999 for (i = 1; i <= AF_MAX; i++) {
1000 rnh = rt_tables_get_rnh(fibnum, i);
1003 if (setwa_f != NULL)
1004 setwa_f(rnh, fibnum, i, arg);
1007 rnh->rnh_walktree(&rnh->head, (walktree_f_t *)wa_f,arg);
1015 struct rt_addrinfo info;
1016 struct rib_head *rnh;
1017 struct rtentry *head;
1021 * Conditionally unlinks @rn from radix tree based
1022 * on info data passed in @arg.
1025 rt_checkdelroute(struct radix_node *rn, void *arg)
1027 struct rt_delinfo *di;
1028 struct rt_addrinfo *info;
1032 di = (struct rt_delinfo *)arg;
1033 rt = (struct rtentry *)rn;
1037 info->rti_info[RTAX_DST] = rt_key(rt);
1038 info->rti_info[RTAX_NETMASK] = rt_mask(rt);
1039 info->rti_info[RTAX_GATEWAY] = rt->rt_gateway;
1041 rt = rt_unlinkrte(di->rnh, info, &error);
1043 /* Either not allowed or not matched. Skip entry */
1047 /* Entry was unlinked. Add to the list and return */
1048 rt->rt_chain = di->head;
1055 * Iterates over all existing fibs in system.
1056 * Deletes each element for which @filter_f function returned
1058 * If @af is not AF_UNSPEC, iterates over fibs in particular
1062 rt_foreach_fib_walk_del(int af, rt_filter_f_t *filter_f, void *arg)
1064 struct rib_head *rnh;
1065 struct rt_delinfo di;
1070 bzero(&di, sizeof(di));
1071 di.info.rti_filter = filter_f;
1072 di.info.rti_filterdata = arg;
1074 for (fibnum = 0; fibnum < rt_numfibs; fibnum++) {
1075 /* Do we want some specific family? */
1076 if (af != AF_UNSPEC) {
1084 for (i = start; i <= end; i++) {
1085 rnh = rt_tables_get_rnh(fibnum, i);
1091 rnh->rnh_walktree(&rnh->head, rt_checkdelroute, &di);
1094 if (di.head == NULL)
1097 /* We might have something to reclaim */
1098 while (di.head != NULL) {
1100 di.head = rt->rt_chain;
1101 rt->rt_chain = NULL;
1103 /* TODO std rt -> rt_addrinfo export */
1104 di.info.rti_info[RTAX_DST] = rt_key(rt);
1105 di.info.rti_info[RTAX_NETMASK] = rt_mask(rt);
1107 rt_notifydelete(rt, &di.info);
1116 * Delete Routes for a Network Interface
1118 * Called for each routing entry via the rnh->rnh_walktree() call above
1119 * to delete all route entries referencing a detaching network interface.
1122 * rt pointer to rtentry
1123 * arg argument passed to rnh->rnh_walktree() - detaching interface
1127 * errno failed - reason indicated
1130 rt_ifdelroute(const struct rtentry *rt, void *arg)
1132 struct ifnet *ifp = arg;
1134 if (rt->rt_ifp != ifp)
1138 * Protect (sorta) against walktree recursion problems
1139 * with cloned routes
1141 if ((rt->rt_flags & RTF_UP) == 0)
1148 * Delete all remaining routes using this interface
1149 * Unfortuneatly the only way to do this is to slog through
1150 * the entire routing table looking for routes which point
1151 * to this interface...oh well...
1154 rt_flushifroutes_af(struct ifnet *ifp, int af)
1156 KASSERT((af >= 1 && af <= AF_MAX), ("%s: af %d not >= 1 and <= %d",
1157 __func__, af, AF_MAX));
1159 rt_foreach_fib_walk_del(af, rt_ifdelroute, ifp);
1163 rt_flushifroutes(struct ifnet *ifp)
1166 rt_foreach_fib_walk_del(AF_UNSPEC, rt_ifdelroute, ifp);
1170 * Conditionally unlinks rtentry matching data inside @info from @rnh.
1171 * Returns unlinked, locked and referenced @rtentry on success,
1172 * Returns NULL and sets @perror to:
1173 * ESRCH - if prefix was not found,
1174 * EADDRINUSE - if trying to delete PINNED route without appropriate flag.
1175 * ENOENT - if supplied filter function returned 0 (not matched).
1177 static struct rtentry *
1178 rt_unlinkrte(struct rib_head *rnh, struct rt_addrinfo *info, int *perror)
1180 struct sockaddr *dst, *netmask;
1182 struct radix_node *rn;
1184 dst = info->rti_info[RTAX_DST];
1185 netmask = info->rti_info[RTAX_NETMASK];
1187 rt = (struct rtentry *)rnh->rnh_lookup(dst, netmask, &rnh->head);
1193 if ((info->rti_flags & RTF_PINNED) == 0) {
1194 /* Check if target route can be deleted */
1195 if (rt->rt_flags & RTF_PINNED) {
1196 *perror = EADDRINUSE;
1201 if (info->rti_filter != NULL) {
1202 if (info->rti_filter(rt, info->rti_filterdata) == 0) {
1209 * Filter function requested rte deletion.
1210 * Ease the caller work by filling in remaining info
1211 * from that particular entry.
1213 info->rti_info[RTAX_GATEWAY] = rt->rt_gateway;
1217 * Remove the item from the tree and return it.
1218 * Complain if it is not there and do no more processing.
1222 if (rt_mpath_capable(rnh))
1223 rn = rt_mpath_unlink(rnh, info, rt, perror);
1226 rn = rnh->rnh_deladdr(dst, netmask, &rnh->head);
1230 if (rn->rn_flags & (RNF_ACTIVE | RNF_ROOT))
1231 panic ("rtrequest delete");
1236 rt->rt_flags &= ~RTF_UP;
1244 rt_notifydelete(struct rtentry *rt, struct rt_addrinfo *info)
1249 * give the protocol a chance to keep things in sync.
1252 if (ifa != NULL && ifa->ifa_rtrequest != NULL)
1253 ifa->ifa_rtrequest(RTM_DELETE, rt, info);
1256 * One more rtentry floating around that is not
1257 * linked to the routing table. rttrash will be decremented
1258 * when RTFREE(rt) is eventually called.
1265 * These (questionable) definitions of apparent local variables apply
1266 * to the next two functions. XXXXXX!!!
1268 #define dst info->rti_info[RTAX_DST]
1269 #define gateway info->rti_info[RTAX_GATEWAY]
1270 #define netmask info->rti_info[RTAX_NETMASK]
1271 #define ifaaddr info->rti_info[RTAX_IFA]
1272 #define ifpaddr info->rti_info[RTAX_IFP]
1273 #define flags info->rti_flags
1276 * Look up rt_addrinfo for a specific fib. Note that if rti_ifa is defined,
1277 * it will be referenced so the caller must free it.
1280 rt_getifa_fib(struct rt_addrinfo *info, u_int fibnum)
1286 * ifp may be specified by sockaddr_dl
1287 * when protocol address is ambiguous.
1290 needref = (info->rti_ifa == NULL);
1292 if (info->rti_ifp == NULL && ifpaddr != NULL &&
1293 ifpaddr->sa_family == AF_LINK &&
1294 (ifa = ifa_ifwithnet(ifpaddr, 0, fibnum)) != NULL) {
1295 info->rti_ifp = ifa->ifa_ifp;
1297 if (info->rti_ifa == NULL && ifaaddr != NULL)
1298 info->rti_ifa = ifa_ifwithaddr(ifaaddr);
1299 if (info->rti_ifa == NULL) {
1300 struct sockaddr *sa;
1302 sa = ifaaddr != NULL ? ifaaddr :
1303 (gateway != NULL ? gateway : dst);
1304 if (sa != NULL && info->rti_ifp != NULL)
1305 info->rti_ifa = ifaof_ifpforaddr(sa, info->rti_ifp);
1306 else if (dst != NULL && gateway != NULL)
1307 info->rti_ifa = ifa_ifwithroute(flags, dst, gateway,
1309 else if (sa != NULL)
1310 info->rti_ifa = ifa_ifwithroute(flags, sa, sa,
1313 if (needref && info->rti_ifa != NULL) {
1314 if (info->rti_ifp == NULL)
1315 info->rti_ifp = info->rti_ifa->ifa_ifp;
1316 ifa_ref(info->rti_ifa);
1318 error = ENETUNREACH;
1324 if_updatemtu_cb(struct radix_node *rn, void *arg)
1327 struct if_mtuinfo *ifmtu;
1329 rt = (struct rtentry *)rn;
1330 ifmtu = (struct if_mtuinfo *)arg;
1332 if (rt->rt_ifp != ifmtu->ifp)
1335 if (rt->rt_mtu >= ifmtu->mtu) {
1336 /* We have to decrease mtu regardless of flags */
1337 rt->rt_mtu = ifmtu->mtu;
1342 * New MTU is bigger. Check if are allowed to alter it
1344 if ((rt->rt_flags & (RTF_FIXEDMTU | RTF_GATEWAY | RTF_HOST)) != 0) {
1347 * Skip routes with user-supplied MTU and
1348 * non-interface routes
1353 /* We are safe to update route MTU */
1354 rt->rt_mtu = ifmtu->mtu;
1360 rt_updatemtu(struct ifnet *ifp)
1362 struct if_mtuinfo ifmtu;
1363 struct rib_head *rnh;
1369 * Try to update rt_mtu for all routes using this interface
1370 * Unfortunately the only way to do this is to traverse all
1371 * routing tables in all fibs/domains.
1373 for (i = 1; i <= AF_MAX; i++) {
1374 ifmtu.mtu = if_getmtu_family(ifp, i);
1375 for (j = 0; j < rt_numfibs; j++) {
1376 rnh = rt_tables_get_rnh(j, i);
1380 rnh->rnh_walktree(&rnh->head, if_updatemtu_cb, &ifmtu);
1388 int p_sockaddr(char *buf, int buflen, struct sockaddr *s);
1389 int rt_print(char *buf, int buflen, struct rtentry *rt);
1392 p_sockaddr(char *buf, int buflen, struct sockaddr *s)
1396 switch (s->sa_family) {
1398 paddr = &((struct sockaddr_in *)s)->sin_addr;
1401 paddr = &((struct sockaddr_in6 *)s)->sin6_addr;
1408 if (inet_ntop(s->sa_family, paddr, buf, buflen) == NULL)
1411 return (strlen(buf));
1415 rt_print(char *buf, int buflen, struct rtentry *rt)
1417 struct sockaddr *addr, *mask;
1423 i = p_sockaddr(buf, buflen, addr);
1424 if (!(rt->rt_flags & RTF_HOST)) {
1426 i += p_sockaddr(buf + i, buflen - i, mask);
1429 if (rt->rt_flags & RTF_GATEWAY) {
1431 i += p_sockaddr(buf + i, buflen - i, rt->rt_gateway);
1440 * Deletes key for single-path routes, unlinks rtentry with
1441 * gateway specified in @info from multi-path routes.
1443 * Returnes unlinked entry. In case of failure, returns NULL
1444 * and sets @perror to ESRCH.
1446 static struct radix_node *
1447 rt_mpath_unlink(struct rib_head *rnh, struct rt_addrinfo *info,
1448 struct rtentry *rto, int *perror)
1451 * if we got multipath routes, we require users to specify
1452 * a matching RTAX_GATEWAY.
1454 struct rtentry *rt; // *rto = NULL;
1455 struct radix_node *rn;
1456 struct sockaddr *gw;
1458 gw = info->rti_info[RTAX_GATEWAY];
1459 rt = rt_mpath_matchgate(rto, gw);
1466 * this is the first entry in the chain
1469 rn = rn_mpath_next((struct radix_node *)rt);
1471 * there is another entry, now it's active
1476 rto->rt_flags |= RTF_UP;
1478 } else if (rt->rt_flags & RTF_GATEWAY) {
1480 * For gateway routes, we need to
1481 * make sure that we we are deleting
1482 * the correct gateway.
1483 * rt_mpath_matchgate() does not
1484 * check the case when there is only
1485 * one route in the chain.
1488 (rt->rt_gateway->sa_len != gw->sa_len ||
1489 memcmp(rt->rt_gateway, gw, gw->sa_len))) {
1496 * use the normal delete code to remove
1499 rn = rnh->rnh_deladdr(dst, netmask, &rnh->head);
1505 * if the entry is 2nd and on up
1507 if (rt_mpath_deldup(rto, rt) == 0)
1508 panic ("rtrequest1: rt_mpath_deldup");
1510 rn = (struct radix_node *)rt;
1516 rtrequest1_fib(int req, struct rt_addrinfo *info, struct rtentry **ret_nrt,
1520 struct rtentry *rt, *rt_old;
1521 struct radix_node *rn;
1522 struct rib_head *rnh;
1524 struct sockaddr *ndst;
1525 struct sockaddr_storage mdst;
1527 KASSERT((fibnum < rt_numfibs), ("rtrequest1_fib: bad fibnum"));
1528 KASSERT((flags & RTF_RNH_LOCKED) == 0, ("rtrequest1_fib: locked"));
1529 switch (dst->sa_family) {
1532 /* We support multiple FIBs. */
1535 fibnum = RT_DEFAULT_FIB;
1540 * Find the correct routing tree to use for this Address Family
1542 rnh = rt_tables_get_rnh(fibnum, dst->sa_family);
1544 return (EAFNOSUPPORT);
1547 * If we are adding a host route then we don't want to put
1548 * a netmask in the tree, nor do we want to clone it.
1550 if (flags & RTF_HOST)
1556 rt_maskedcopy(dst, (struct sockaddr *)&mdst, netmask);
1557 dst = (struct sockaddr *)&mdst;
1561 rt = rt_unlinkrte(rnh, info, &error);
1566 rt_notifydelete(rt, info);
1569 * If the caller wants it, then it can have it,
1570 * but it's up to it to free the rtentry as we won't be
1581 * resolve was only used for route cloning
1586 if ((flags & RTF_GATEWAY) && !gateway)
1588 if (dst && gateway && (dst->sa_family != gateway->sa_family) &&
1589 (gateway->sa_family != AF_UNSPEC) && (gateway->sa_family != AF_LINK))
1592 if (info->rti_ifa == NULL) {
1593 error = rt_getifa_fib(info, fibnum);
1597 rt = uma_zalloc(V_rtzone, M_NOWAIT);
1601 rt->rt_flags = RTF_UP | flags;
1602 rt->rt_fibnum = fibnum;
1604 * Add the gateway. Possibly re-malloc-ing the storage for it.
1606 if ((error = rt_setgate(rt, dst, gateway)) != 0) {
1607 uma_zfree(V_rtzone, rt);
1612 * point to the (possibly newly malloc'd) dest address.
1614 ndst = (struct sockaddr *)rt_key(rt);
1617 * make sure it contains the value we want (masked if needed).
1620 rt_maskedcopy(dst, ndst, netmask);
1622 bcopy(dst, ndst, dst->sa_len);
1625 * We use the ifa reference returned by rt_getifa_fib().
1626 * This moved from below so that rnh->rnh_addaddr() can
1627 * examine the ifa and ifa->ifa_ifp if it so desires.
1629 ifa = info->rti_ifa;
1632 rt->rt_ifp = ifa->ifa_ifp;
1635 rt_setmetrics(info, rt);
1640 /* do not permit exactly the same dst/mask/gw pair */
1641 if (rt_mpath_capable(rnh) &&
1642 rt_mpath_conflict(rnh, rt, netmask)) {
1645 ifa_free(rt->rt_ifa);
1647 uma_zfree(V_rtzone, rt);
1652 /* XXX mtu manipulation will be done in rnh_addaddr -- itojun */
1653 rn = rnh->rnh_addaddr(ndst, netmask, &rnh->head, rt->rt_nodes);
1656 if (rn == NULL && (info->rti_flags & RTF_PINNED) != 0) {
1659 * Force removal and re-try addition
1660 * TODO: better multipath&pinned support
1662 struct sockaddr *info_dst = info->rti_info[RTAX_DST];
1663 info->rti_info[RTAX_DST] = ndst;
1664 /* Do not delete existing PINNED(interface) routes */
1665 info->rti_flags &= ~RTF_PINNED;
1666 rt_old = rt_unlinkrte(rnh, info, &error);
1667 info->rti_flags |= RTF_PINNED;
1668 info->rti_info[RTAX_DST] = info_dst;
1670 rn = rnh->rnh_addaddr(ndst, netmask, &rnh->head,
1679 * If it still failed to go into the tree,
1680 * then un-make it (this should be a function)
1683 ifa_free(rt->rt_ifa);
1685 uma_zfree(V_rtzone, rt);
1689 if (rt_old != NULL) {
1690 rt_notifydelete(rt_old, info);
1695 * If this protocol has something to add to this then
1696 * allow it to do that as well.
1698 if (ifa->ifa_rtrequest)
1699 ifa->ifa_rtrequest(req, rt, info);
1702 * actually return a resultant rtentry and
1703 * give the caller a single reference.
1709 rnh->rnh_gen++; /* Routing table updated */
1714 error = rtrequest1_fib_change(rnh, info, ret_nrt, fibnum);
1732 rtrequest1_fib_change(struct rib_head *rnh, struct rt_addrinfo *info,
1733 struct rtentry **ret_nrt, u_int fibnum)
1735 struct rtentry *rt = NULL;
1739 struct if_mtuinfo ifmtu;
1741 RIB_WLOCK_ASSERT(rnh);
1743 rt = (struct rtentry *)rnh->rnh_lookup(info->rti_info[RTAX_DST],
1744 info->rti_info[RTAX_NETMASK], &rnh->head);
1751 * If we got multipath routes,
1752 * we require users to specify a matching RTAX_GATEWAY.
1754 if (rt_mpath_capable(rnh)) {
1755 rt = rt_mpath_matchgate(rt, info->rti_info[RTAX_GATEWAY]);
1763 rt_setmetrics(info, rt);
1766 * New gateway could require new ifaddr, ifp;
1767 * flags may also be different; ifp may be specified
1768 * by ll sockaddr when protocol address is ambiguous
1770 if (((rt->rt_flags & RTF_GATEWAY) &&
1771 info->rti_info[RTAX_GATEWAY] != NULL) ||
1772 info->rti_info[RTAX_IFP] != NULL ||
1773 (info->rti_info[RTAX_IFA] != NULL &&
1774 !sa_equal(info->rti_info[RTAX_IFA], rt->rt_ifa->ifa_addr))) {
1776 * XXX: Temporarily set RTF_RNH_LOCKED flag in the rti_flags
1777 * to avoid rlock in the ifa_ifwithroute().
1779 info->rti_flags |= RTF_RNH_LOCKED;
1780 error = rt_getifa_fib(info, fibnum);
1781 info->rti_flags &= ~RTF_RNH_LOCKED;
1782 if (info->rti_ifa != NULL)
1789 /* Check if outgoing interface has changed */
1790 if (info->rti_ifa != NULL && info->rti_ifa != rt->rt_ifa &&
1791 rt->rt_ifa != NULL) {
1792 if (rt->rt_ifa->ifa_rtrequest != NULL)
1793 rt->rt_ifa->ifa_rtrequest(RTM_DELETE, rt, info);
1794 ifa_free(rt->rt_ifa);
1797 /* Update gateway address */
1798 if (info->rti_info[RTAX_GATEWAY] != NULL) {
1799 error = rt_setgate(rt, rt_key(rt), info->rti_info[RTAX_GATEWAY]);
1803 rt->rt_flags &= ~RTF_GATEWAY;
1804 rt->rt_flags |= (RTF_GATEWAY & info->rti_flags);
1807 if (info->rti_ifa != NULL && info->rti_ifa != rt->rt_ifa) {
1808 ifa_ref(info->rti_ifa);
1809 rt->rt_ifa = info->rti_ifa;
1810 rt->rt_ifp = info->rti_ifp;
1812 /* Allow some flags to be toggled on change. */
1813 rt->rt_flags &= ~RTF_FMASK;
1814 rt->rt_flags |= info->rti_flags & RTF_FMASK;
1816 if (rt->rt_ifa && rt->rt_ifa->ifa_rtrequest != NULL)
1817 rt->rt_ifa->ifa_rtrequest(RTM_ADD, rt, info);
1819 /* Alter route MTU if necessary */
1820 if (rt->rt_ifp != NULL) {
1821 family = info->rti_info[RTAX_DST]->sa_family;
1822 mtu = if_getmtu_family(rt->rt_ifp, family);
1823 /* Set default MTU */
1824 if (rt->rt_mtu == 0)
1826 if (rt->rt_mtu != mtu) {
1827 /* Check if we really need to update */
1828 ifmtu.ifp = rt->rt_ifp;
1830 if_updatemtu_cb(rt->rt_nodes, &ifmtu);
1835 * This route change may have modified the route's gateway. In that
1836 * case, any inpcbs that have cached this route need to invalidate their
1847 if (free_ifa != 0) {
1848 ifa_free(info->rti_ifa);
1849 info->rti_ifa = NULL;
1855 rt_setmetrics(const struct rt_addrinfo *info, struct rtentry *rt)
1858 if (info->rti_mflags & RTV_MTU) {
1859 if (info->rti_rmx->rmx_mtu != 0) {
1862 * MTU was explicitly provided by user.
1865 rt->rt_flags |= RTF_FIXEDMTU;
1869 * User explicitly sets MTU to 0.
1870 * Assume rollback to default.
1872 rt->rt_flags &= ~RTF_FIXEDMTU;
1874 rt->rt_mtu = info->rti_rmx->rmx_mtu;
1876 if (info->rti_mflags & RTV_WEIGHT)
1877 rt->rt_weight = info->rti_rmx->rmx_weight;
1878 /* Kernel -> userland timebase conversion. */
1879 if (info->rti_mflags & RTV_EXPIRE)
1880 rt->rt_expire = info->rti_rmx->rmx_expire ?
1881 info->rti_rmx->rmx_expire - time_second + time_uptime : 0;
1885 rt_setgate(struct rtentry *rt, struct sockaddr *dst, struct sockaddr *gate)
1887 /* XXX dst may be overwritten, can we move this to below */
1888 int dlen = SA_SIZE(dst), glen = SA_SIZE(gate);
1891 * Prepare to store the gateway in rt->rt_gateway.
1892 * Both dst and gateway are stored one after the other in the same
1893 * malloc'd chunk. If we have room, we can reuse the old buffer,
1894 * rt_gateway already points to the right place.
1895 * Otherwise, malloc a new block and update the 'dst' address.
1897 if (rt->rt_gateway == NULL || glen > SA_SIZE(rt->rt_gateway)) {
1900 R_Malloc(new, caddr_t, dlen + glen);
1904 * XXX note, we copy from *dst and not *rt_key(rt) because
1905 * rt_setgate() can be called to initialize a newly
1906 * allocated route entry, in which case rt_key(rt) == NULL
1907 * (and also rt->rt_gateway == NULL).
1908 * Free()/free() handle a NULL argument just fine.
1910 bcopy(dst, new, dlen);
1911 R_Free(rt_key(rt)); /* free old block, if any */
1912 rt_key(rt) = (struct sockaddr *)new;
1913 rt->rt_gateway = (struct sockaddr *)(new + dlen);
1917 * Copy the new gateway value into the memory chunk.
1919 bcopy(gate, rt->rt_gateway, glen);
1925 rt_maskedcopy(struct sockaddr *src, struct sockaddr *dst, struct sockaddr *netmask)
1927 u_char *cp1 = (u_char *)src;
1928 u_char *cp2 = (u_char *)dst;
1929 u_char *cp3 = (u_char *)netmask;
1930 u_char *cplim = cp2 + *cp3;
1931 u_char *cplim2 = cp2 + *cp1;
1933 *cp2++ = *cp1++; *cp2++ = *cp1++; /* copies sa_len & sa_family */
1938 *cp2++ = *cp1++ & *cp3++;
1940 bzero((caddr_t)cp2, (unsigned)(cplim2 - cp2));
1944 * Set up a routing table entry, normally
1947 #define _SOCKADDR_TMPSIZE 128 /* Not too big.. kernel stack size is limited */
1949 rtinit1(struct ifaddr *ifa, int cmd, int flags, int fibnum)
1952 struct sockaddr *dst;
1953 struct sockaddr *netmask;
1954 struct rtentry *rt = NULL;
1955 struct rt_addrinfo info;
1957 int startfib, endfib;
1958 char tempbuf[_SOCKADDR_TMPSIZE];
1961 static struct sockaddr_dl null_sdl = {sizeof(null_sdl), AF_LINK};
1962 struct rib_head *rnh;
1964 if (flags & RTF_HOST) {
1965 dst = ifa->ifa_dstaddr;
1968 dst = ifa->ifa_addr;
1969 netmask = ifa->ifa_netmask;
1971 if (dst->sa_len == 0)
1973 switch (dst->sa_family) {
1976 /* We support multiple FIBs. */
1979 fibnum = RT_DEFAULT_FIB;
1982 if (fibnum == RT_ALL_FIBS) {
1983 if (V_rt_add_addr_allfibs == 0 && cmd == (int)RTM_ADD)
1984 startfib = endfib = ifa->ifa_ifp->if_fib;
1987 endfib = rt_numfibs - 1;
1990 KASSERT((fibnum < rt_numfibs), ("rtinit1: bad fibnum"));
1996 * If it's a delete, check that if it exists,
1997 * it's on the correct interface or we might scrub
1998 * a route to another ifa which would
1999 * be confusing at best and possibly worse.
2001 if (cmd == RTM_DELETE) {
2003 * It's a delete, so it should already exist..
2004 * If it's a net, mask off the host bits
2005 * (Assuming we have a mask)
2006 * XXX this is kinda inet specific..
2008 if (netmask != NULL) {
2009 rt_maskedcopy(dst, (struct sockaddr *)tempbuf, netmask);
2010 dst = (struct sockaddr *)tempbuf;
2014 * Now go through all the requested tables (fibs) and do the
2015 * requested action. Realistically, this will either be fib 0
2016 * for protocols that don't do multiple tables or all the
2017 * tables for those that do.
2019 for ( fibnum = startfib; fibnum <= endfib; fibnum++) {
2020 if (cmd == RTM_DELETE) {
2021 struct radix_node *rn;
2023 * Look up an rtentry that is in the routing tree and
2024 * contains the correct info.
2026 rnh = rt_tables_get_rnh(fibnum, dst->sa_family);
2028 /* this table doesn't exist but others might */
2031 rn = rnh->rnh_lookup(dst, netmask, &rnh->head);
2033 if (rt_mpath_capable(rnh)) {
2040 * for interface route the
2041 * rt->rt_gateway is sockaddr_intf
2042 * for cloning ARP entries, so
2043 * rt_mpath_matchgate must use the
2046 rt = rt_mpath_matchgate(rt,
2053 error = (rn == NULL ||
2054 (rn->rn_flags & RNF_ROOT) ||
2055 RNTORT(rn)->rt_ifa != ifa);
2058 /* this is only an error if bad on ALL tables */
2063 * Do the actual request
2065 bzero((caddr_t)&info, sizeof(info));
2068 info.rti_flags = flags |
2069 (ifa->ifa_flags & ~IFA_RTSELF) | RTF_PINNED;
2070 info.rti_info[RTAX_DST] = dst;
2072 * doing this for compatibility reasons
2075 info.rti_info[RTAX_GATEWAY] =
2076 (struct sockaddr *)&null_sdl;
2078 info.rti_info[RTAX_GATEWAY] = ifa->ifa_addr;
2079 info.rti_info[RTAX_NETMASK] = netmask;
2080 error = rtrequest1_fib(cmd, &info, &rt, fibnum);
2082 if (error == 0 && rt != NULL) {
2084 * notify any listening routing agents of the change
2089 * in case address alias finds the first address
2090 * e.g. ifconfig bge0 192.0.2.246/24
2091 * e.g. ifconfig bge0 192.0.2.247/24
2092 * the address set in the route is 192.0.2.246
2093 * so we need to replace it with 192.0.2.247
2095 if (memcmp(rt->rt_ifa->ifa_addr,
2096 ifa->ifa_addr, ifa->ifa_addr->sa_len)) {
2097 ifa_free(rt->rt_ifa);
2099 rt->rt_ifp = ifa->ifa_ifp;
2104 * doing this for compatibility reasons
2106 if (cmd == RTM_ADD) {
2107 ((struct sockaddr_dl *)rt->rt_gateway)->sdl_type =
2108 rt->rt_ifp->if_type;
2109 ((struct sockaddr_dl *)rt->rt_gateway)->sdl_index =
2110 rt->rt_ifp->if_index;
2114 rt_newaddrmsg_fib(cmd, ifa, error, rt, fibnum);
2117 if (cmd == RTM_DELETE) {
2119 * If we are deleting, and we found an entry,
2120 * then it's been removed from the tree..
2121 * now throw it away.
2125 if (cmd == RTM_ADD) {
2127 * We just wanted to add it..
2128 * we don't actually need a reference.
2139 if (cmd == RTM_DELETE) {
2143 /* we only give an error if it wasn't in any table */
2144 error = ((flags & RTF_HOST) ?
2145 EHOSTUNREACH : ENETUNREACH);
2149 /* return an error if any of them failed */
2157 * Set up a routing table entry, normally
2161 rtinit(struct ifaddr *ifa, int cmd, int flags)
2163 struct sockaddr *dst;
2164 int fib = RT_DEFAULT_FIB;
2166 if (flags & RTF_HOST) {
2167 dst = ifa->ifa_dstaddr;
2169 dst = ifa->ifa_addr;
2172 switch (dst->sa_family) {
2175 /* We do support multiple FIBs. */
2179 return (rtinit1(ifa, cmd, flags, fib));
2183 * Announce interface address arrival/withdraw
2184 * Returns 0 on success.
2187 rt_addrmsg(int cmd, struct ifaddr *ifa, int fibnum)
2190 KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE,
2191 ("unexpected cmd %d", cmd));
2193 KASSERT(fibnum == RT_ALL_FIBS || (fibnum >= 0 && fibnum < rt_numfibs),
2194 ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
2196 #if defined(INET) || defined(INET6)
2199 * notify the SCTP stack
2200 * this will only get called when an address is added/deleted
2201 * XXX pass the ifaddr struct instead if ifa->ifa_addr...
2203 sctp_addr_change(ifa, cmd);
2206 return (rtsock_addrmsg(cmd, ifa, fibnum));
2210 * Announce route addition/removal.
2211 * Users of this function MUST validate input data BEFORE calling.
2212 * However we have to be able to handle invalid data:
2213 * if some userland app sends us "invalid" route message (invalid mask,
2214 * no dst, wrong address families, etc...) we need to pass it back
2215 * to app (and any other rtsock consumers) with rtm_errno field set to
2217 * Returns 0 on success.
2220 rt_routemsg(int cmd, struct ifnet *ifp, int error, struct rtentry *rt,
2224 KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE,
2225 ("unexpected cmd %d", cmd));
2227 KASSERT(fibnum == RT_ALL_FIBS || (fibnum >= 0 && fibnum < rt_numfibs),
2228 ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
2230 KASSERT(rt_key(rt) != NULL, (":%s: rt_key must be supplied", __func__));
2232 return (rtsock_routemsg(cmd, ifp, error, rt, fibnum));
2236 rt_newaddrmsg(int cmd, struct ifaddr *ifa, int error, struct rtentry *rt)
2239 rt_newaddrmsg_fib(cmd, ifa, error, rt, RT_ALL_FIBS);
2243 * This is called to generate messages from the routing socket
2244 * indicating a network interface has had addresses associated with it.
2247 rt_newaddrmsg_fib(int cmd, struct ifaddr *ifa, int error, struct rtentry *rt,
2251 KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE,
2252 ("unexpected cmd %u", cmd));
2253 KASSERT(fibnum == RT_ALL_FIBS || (fibnum >= 0 && fibnum < rt_numfibs),
2254 ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
2256 if (cmd == RTM_ADD) {
2257 rt_addrmsg(cmd, ifa, fibnum);
2259 rt_routemsg(cmd, ifa->ifa_ifp, error, rt, fibnum);
2262 rt_routemsg(cmd, ifa->ifa_ifp, error, rt, fibnum);
2263 rt_addrmsg(cmd, ifa, fibnum);