sys/net/route.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1980, 1986, 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   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 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.
  18  *
  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
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)route.c     8.3.1.1 (Berkeley) 2/23/95
  32  * $FreeBSD$
  33  */
  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  ***********************************************************************/
  38
  39 #include "opt_inet.h"
  40 #include "opt_inet6.h"
  41 #include "opt_mrouting.h"
  42 #include "opt_route.h"
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/malloc.h>
  47 #include <sys/mbuf.h>
  48 #include <sys/socket.h>
  49 #include <sys/sysctl.h>
  50 #include <sys/syslog.h>
  51 #include <sys/sysproto.h>
  52 #include <sys/proc.h>
  53 #include <sys/domain.h>
  54 #include <sys/eventhandler.h>
  55 #include <sys/kernel.h>
  56 #include <sys/lock.h>
  57 #include <sys/rmlock.h>
  58
  59 #include <net/if.h>
  60 #include <net/if_var.h>
  61 #include <net/if_dl.h>
  62 #include <net/route.h>
  63 #include <net/route/route_ctl.h>
  64 #include <net/route/route_var.h>
  65 #include <net/route/nhop.h>
  66 #include <net/vnet.h>
  67
  68 #include <netinet/in.h>
  69 #include <netinet/ip_mroute.h>
  70
  71 VNET_PCPUSTAT_DEFINE(struct rtstat, rtstat);
  72
  73 VNET_PCPUSTAT_SYSINIT(rtstat);
  74 #ifdef VIMAGE
  75 VNET_PCPUSTAT_SYSUNINIT(rtstat);
  76 #endif
  77
  78 EVENTHANDLER_LIST_DEFINE(rt_addrmsg);
  79
  80 static int rt_ifdelroute(const struct rtentry *rt, const struct nhop_object *,
  81     void *arg);
  82 static int rt_exportinfo(struct rtentry *rt, struct nhop_object *nh,
  83     struct rt_addrinfo *info, int flags);
  84
  85 /*
  86  * route initialization must occur before ip6_init2(), which happenas at
  87  * SI_ORDER_MIDDLE.
  88  */
  89 static void
  90 route_init(void)
  91 {
  92
  93         nhops_init();
  94 }
  95 SYSINIT(route_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_THIRD, route_init, NULL);
  96
  97 struct rib_head *
  98 rt_table_init(int offset, int family, u_int fibnum)
  99 {
 100         struct rib_head *rh;
 101
 102         rh = malloc(sizeof(struct rib_head), M_RTABLE, M_WAITOK | M_ZERO);
 103
 104         /* TODO: These details should be hidded inside radix.c */
 105         /* Init masks tree */
 106         rn_inithead_internal(&rh->head, rh->rnh_nodes, offset);
 107         rn_inithead_internal(&rh->rmhead.head, rh->rmhead.mask_nodes, 0);
 108         rh->head.rnh_masks = &rh->rmhead;
 109
 110         /* Save metadata associated with this routing table. */
 111         rh->rib_family = family;
 112         rh->rib_fibnum = fibnum;
 113 #ifdef VIMAGE
 114         rh->rib_vnet = curvnet;
 115 #endif
 116
 117         tmproutes_init(rh);
 118
 119         /* Init locks */
 120         RIB_LOCK_INIT(rh);
 121
 122         nhops_init_rib(rh);
 123
 124         /* Init subscription system */
 125         rib_init_subscriptions(rh);
 126
 127         /* Finally, set base callbacks */
 128         rh->rnh_addaddr = rn_addroute;
 129         rh->rnh_deladdr = rn_delete;
 130         rh->rnh_matchaddr = rn_match;
 131         rh->rnh_lookup = rn_lookup;
 132         rh->rnh_walktree = rn_walktree;
 133         rh->rnh_walktree_from = rn_walktree_from;
 134
 135         return (rh);
 136 }
 137
 138 static int
 139 rt_freeentry(struct radix_node *rn, void *arg)
 140 {
 141         struct radix_head * const rnh = arg;
 142         struct radix_node *x;
 143
 144         x = (struct radix_node *)rn_delete(rn + 2, NULL, rnh);
 145         if (x != NULL)
 146                 R_Free(x);
 147         return (0);
 148 }
 149
 150 void
 151 rt_table_destroy(struct rib_head *rh)
 152 {
 153
 154         RIB_WLOCK(rh);
 155         rh->rib_dying = true;
 156         RIB_WUNLOCK(rh);
 157
 158 #ifdef FIB_ALGO
 159         fib_destroy_rib(rh);
 160 #endif
 161
 162         tmproutes_destroy(rh);
 163
 164         rn_walktree(&rh->rmhead.head, rt_freeentry, &rh->rmhead.head);
 165
 166         nhops_destroy_rib(rh);
 167
 168         rib_destroy_subscriptions(rh);
 169
 170         /* Assume table is already empty */
 171         RIB_LOCK_DESTROY(rh);
 172         free(rh, M_RTABLE);
 173 }
 174
 175 /*
 176  * Adds a temporal redirect entry to the routing table.
 177  * @fibnum: fib number
 178  * @dst: destination to install redirect to
 179  * @gateway: gateway to go via
 180  * @author: sockaddr of originating router, can be NULL
 181  * @ifp: interface to use for the redirected route
 182  * @flags: set of flags to add. Allowed: RTF_GATEWAY
 183  * @lifetime_sec: time in seconds to expire this redirect.
 184  *
 185  * Retuns 0 on success, errno otherwise.
 186  */
 187 int
 188 rib_add_redirect(u_int fibnum, struct sockaddr *dst, struct sockaddr *gateway,
 189     struct sockaddr *author, struct ifnet *ifp, int flags, int lifetime_sec)
 190 {
 191         struct route_nhop_data rnd = { .rnd_weight = RT_DEFAULT_WEIGHT };
 192         struct rib_cmd_info rc;
 193         struct ifaddr *ifa;
 194         int error;
 195
 196         NET_EPOCH_ASSERT();
 197
 198         if (rt_tables_get_rnh(fibnum, dst->sa_family) == NULL)
 199                 return (EAFNOSUPPORT);
 200
 201         /* Verify the allowed flag mask. */
 202         KASSERT(((flags & ~(RTF_GATEWAY)) == 0),
 203             ("invalid redirect flags: %x", flags));
 204         flags |= RTF_HOST | RTF_DYNAMIC;
 205
 206         /* Get the best ifa for the given interface and gateway. */
 207         if ((ifa = ifaof_ifpforaddr(gateway, ifp)) == NULL)
 208                 return (ENETUNREACH);
 209
 210         struct nhop_object *nh = nhop_alloc(fibnum, dst->sa_family);
 211         if (nh == NULL)
 212                 return (ENOMEM);
 213
 214         nhop_set_gw(nh, gateway, flags & RTF_GATEWAY);
 215         nhop_set_transmit_ifp(nh, ifp);
 216         nhop_set_src(nh, ifa);
 217         nhop_set_pxtype_flag(nh, NHF_HOST);
 218         nhop_set_expire(nh, lifetime_sec + time_uptime);
 219         nhop_set_redirect(nh, true);
 220         nhop_set_origin(nh, NH_ORIGIN_REDIRECT);
 221         rnd.rnd_nhop = nhop_get_nhop(nh, &error);
 222         if (error == 0) {
 223                 error = rib_add_route_px(fibnum, dst, -1,
 224                     &rnd, RTM_F_CREATE, &rc);
 225         }
 226
 227         if (error != 0) {
 228                 /* TODO: add per-fib redirect stats. */
 229                 return (error);
 230         }
 231
 232         RTSTAT_INC(rts_dynamic);
 233
 234         /* Send notification of a route addition to userland. */
 235         struct rt_addrinfo info = {
 236                 .rti_info[RTAX_DST] = dst,
 237                 .rti_info[RTAX_GATEWAY] = gateway,
 238                 .rti_info[RTAX_AUTHOR] = author,
 239         };
 240         rt_missmsg_fib(RTM_REDIRECT, &info, flags | RTF_UP, error, fibnum);
 241
 242         return (0);
 243 }
 244
 245 /*
 246  * Routing table ioctl interface.
 247  */
 248 int
 249 rtioctl_fib(u_long req, caddr_t data, u_int fibnum)
 250 {
 251
 252         /*
 253          * If more ioctl commands are added here, make sure the proper
 254          * super-user checks are being performed because it is possible for
 255          * prison-root to make it this far if raw sockets have been enabled
 256          * in jails.
 257          */
 258 #ifdef INET
 259         /* Multicast goop, grrr... */
 260         return mrt_ioctl ? mrt_ioctl(req, data, fibnum) : EOPNOTSUPP;
 261 #else /* INET */
 262         return ENXIO;
 263 #endif /* INET */
 264 }
 265
 266 struct ifaddr *
 267 ifa_ifwithroute(int flags, const struct sockaddr *dst,
 268     const struct sockaddr *gateway, u_int fibnum)
 269 {
 270         struct ifaddr *ifa;
 271
 272         NET_EPOCH_ASSERT();
 273         if ((flags & RTF_GATEWAY) == 0) {
 274                 /*
 275                  * If we are adding a route to an interface,
 276                  * and the interface is a pt to pt link
 277                  * we should search for the destination
 278                  * as our clue to the interface.  Otherwise
 279                  * we can use the local address.
 280                  */
 281                 ifa = NULL;
 282                 if (flags & RTF_HOST)
 283                         ifa = ifa_ifwithdstaddr(dst, fibnum);
 284                 if (ifa == NULL)
 285                         ifa = ifa_ifwithaddr(gateway);
 286         } else {
 287                 /*
 288                  * If we are adding a route to a remote net
 289                  * or host, the gateway may still be on the
 290                  * other end of a pt to pt link.
 291                  */
 292                 ifa = ifa_ifwithdstaddr(gateway, fibnum);
 293         }
 294         if (ifa == NULL)
 295                 ifa = ifa_ifwithnet(gateway, 0, fibnum);
 296         if (ifa == NULL) {
 297                 struct nhop_object *nh;
 298
 299                 nh = rib_lookup(fibnum, gateway, NHR_NONE, 0);
 300
 301                 /*
 302                  * dismiss a gateway that is reachable only
 303                  * through the default router
 304                  */
 305                 if ((nh == NULL) || (nh->nh_flags & NHF_DEFAULT))
 306                         return (NULL);
 307                 ifa = nh->nh_ifa;
 308         }
 309         if (ifa->ifa_addr->sa_family != dst->sa_family) {
 310                 struct ifaddr *oifa = ifa;
 311                 ifa = ifaof_ifpforaddr(dst, ifa->ifa_ifp);
 312                 if (ifa == NULL)
 313                         ifa = oifa;
 314         }
 315
 316         return (ifa);
 317 }
 318
 319 /*
 320  * Copy most of @rt data into @info.
 321  *
 322  * If @flags contains NHR_COPY, copies dst,netmask and gw to the
 323  * pointers specified by @info structure. Assume such pointers
 324  * are zeroed sockaddr-like structures with sa_len field initialized
 325  * to reflect size of the provided buffer. if no NHR_COPY is specified,
 326  * point dst,netmask and gw @info fields to appropriate @rt values.
 327  *
 328  * if @flags contains NHR_REF, do refcouting on rt_ifp and rt_ifa.
 329  *
 330  * Returns 0 on success.
 331  */
 332 static int
 333 rt_exportinfo(struct rtentry *rt, struct nhop_object *nh,
 334     struct rt_addrinfo *info, int flags)
 335 {
 336         struct rt_metrics *rmx;
 337         struct sockaddr *src, *dst;
 338         int sa_len;
 339
 340         if (flags & NHR_COPY) {
 341                 /* Copy destination if dst is non-zero */
 342                 src = rt_key(rt);
 343                 dst = info->rti_info[RTAX_DST];
 344                 sa_len = src->sa_len;
 345                 if (dst != NULL) {
 346                         if (src->sa_len > dst->sa_len)
 347                                 return (ENOMEM);
 348                         memcpy(dst, src, src->sa_len);
 349                         info->rti_addrs |= RTA_DST;
 350                 }
 351
 352                 /* Copy mask if set && dst is non-zero */
 353                 src = rt_mask(rt);
 354                 dst = info->rti_info[RTAX_NETMASK];
 355                 if (src != NULL && dst != NULL) {
 356                         /*
 357                          * Radix stores different value in sa_len,
 358                          * assume rt_mask() to have the same length
 359                          * as rt_key()
 360                          */
 361                         if (sa_len > dst->sa_len)
 362                                 return (ENOMEM);
 363                         memcpy(dst, src, src->sa_len);
 364                         info->rti_addrs |= RTA_NETMASK;
 365                 }
 366
 367                 /* Copy gateway is set && dst is non-zero */
 368                 src = &nh->gw_sa;
 369                 dst = info->rti_info[RTAX_GATEWAY];
 370                 if ((nhop_get_rtflags(nh) & RTF_GATEWAY) &&
 371                     src != NULL && dst != NULL) {
 372                         if (src->sa_len > dst->sa_len)
 373                                 return (ENOMEM);
 374                         memcpy(dst, src, src->sa_len);
 375                         info->rti_addrs |= RTA_GATEWAY;
 376                 }
 377         } else {
 378                 info->rti_info[RTAX_DST] = rt_key(rt);
 379                 info->rti_addrs |= RTA_DST;
 380                 if (rt_mask(rt) != NULL) {
 381                         info->rti_info[RTAX_NETMASK] = rt_mask(rt);
 382                         info->rti_addrs |= RTA_NETMASK;
 383                 }
 384                 if (nhop_get_rtflags(nh) & RTF_GATEWAY) {
 385                         info->rti_info[RTAX_GATEWAY] = &nh->gw_sa;
 386                         info->rti_addrs |= RTA_GATEWAY;
 387                 }
 388         }
 389
 390         rmx = info->rti_rmx;
 391         if (rmx != NULL) {
 392                 info->rti_mflags |= RTV_MTU;
 393                 rmx->rmx_mtu = nh->nh_mtu;
 394         }
 395
 396         info->rti_flags = rt->rte_flags | nhop_get_rtflags(nh);
 397         info->rti_ifp = nh->nh_ifp;
 398         info->rti_ifa = nh->nh_ifa;
 399         if (flags & NHR_REF) {
 400                 if_ref(info->rti_ifp);
 401                 ifa_ref(info->rti_ifa);
 402         }
 403
 404         return (0);
 405 }
 406
 407 /*
 408  * Lookups up route entry for @dst in RIB database for fib @fibnum.
 409  * Exports entry data to @info using rt_exportinfo().
 410  *
 411  * If @flags contains NHR_REF, refcouting is performed on rt_ifp and rt_ifa.
 412  * All references can be released later by calling rib_free_info().
 413  *
 414  * Returns 0 on success.
 415  * Returns ENOENT for lookup failure, ENOMEM for export failure.
 416  */
 417 int
 418 rib_lookup_info(uint32_t fibnum, const struct sockaddr *dst, uint32_t flags,
 419     uint32_t flowid, struct rt_addrinfo *info)
 420 {
 421         RIB_RLOCK_TRACKER;
 422         struct rib_head *rh;
 423         struct radix_node *rn;
 424         struct rtentry *rt;
 425         struct nhop_object *nh;
 426         int error;
 427
 428         KASSERT((fibnum < rt_numfibs), ("rib_lookup_rte: bad fibnum"));
 429         rh = rt_tables_get_rnh(fibnum, dst->sa_family);
 430         if (rh == NULL)
 431                 return (ENOENT);
 432
 433         RIB_RLOCK(rh);
 434         rn = rh->rnh_matchaddr(__DECONST(void *, dst), &rh->head);
 435         if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
 436                 rt = RNTORT(rn);
 437                 nh = nhop_select(rt->rt_nhop, flowid);
 438                 /* Ensure route & ifp is UP */
 439                 if (RT_LINK_IS_UP(nh->nh_ifp)) {
 440                         flags = (flags & NHR_REF) | NHR_COPY;
 441                         error = rt_exportinfo(rt, nh, info, flags);
 442                         RIB_RUNLOCK(rh);
 443
 444                         return (error);
 445                 }
 446         }
 447         RIB_RUNLOCK(rh);
 448
 449         return (ENOENT);
 450 }
 451
 452 /*
 453  * Releases all references acquired by rib_lookup_info() when
 454  * called with NHR_REF flags.
 455  */
 456 void
 457 rib_free_info(struct rt_addrinfo *info)
 458 {
 459
 460         ifa_free(info->rti_ifa);
 461         if_rele(info->rti_ifp);
 462 }
 463
 464 /*
 465  * Delete Routes for a Network Interface
 466  *
 467  * Called for each routing entry via the rnh->rnh_walktree() call above
 468  * to delete all route entries referencing a detaching network interface.
 469  *
 470  * Arguments:
 471  *      rt      pointer to rtentry
 472  *      nh      pointer to nhop
 473  *      arg     argument passed to rnh->rnh_walktree() - detaching interface
 474  *
 475  * Returns:
 476  *      0       successful
 477  *      errno   failed - reason indicated
 478  */
 479 static int
 480 rt_ifdelroute(const struct rtentry *rt, const struct nhop_object *nh, void *arg)
 481 {
 482         struct ifnet    *ifp = arg;
 483
 484         if (nh->nh_ifp != ifp)
 485                 return (0);
 486
 487         /*
 488          * Protect (sorta) against walktree recursion problems
 489          * with cloned routes
 490          */
 491         if ((rt->rte_flags & RTF_UP) == 0)
 492                 return (0);
 493
 494         return (1);
 495 }
 496
 497 void
 498 rt_flushifroutes(struct ifnet *ifp)
 499 {
 500
 501         rib_foreach_table_walk_del(AF_UNSPEC, rt_ifdelroute, ifp);
 502 }
 503
 504 /*
 505  * Tries to extract interface from RTAX_IFP passed in rt_addrinfo.
 506  * Interface can be specified ether as interface index (sdl_index) or
 507  * the interface name (sdl_data).
 508  *
 509  * Returns found ifp or NULL
 510  */
 511 static struct ifnet *
 512 info_get_ifp(struct rt_addrinfo *info)
 513 {
 514         const struct sockaddr_dl *sdl;
 515
 516         sdl = (const struct sockaddr_dl *)info->rti_info[RTAX_IFP];
 517         if (sdl->sdl_family != AF_LINK)
 518                 return (NULL);
 519
 520         if (sdl->sdl_index != 0)
 521                 return (ifnet_byindex(sdl->sdl_index));
 522         if (sdl->sdl_nlen > 0) {
 523                 char if_name[IF_NAMESIZE];
 524                 if (sdl->sdl_nlen + offsetof(struct sockaddr_dl, sdl_data) > sdl->sdl_len)
 525                         return (NULL);
 526                 if (sdl->sdl_nlen >= IF_NAMESIZE)
 527                         return (NULL);
 528                 bzero(if_name, sizeof(if_name));
 529                 memcpy(if_name, sdl->sdl_data, sdl->sdl_nlen);
 530                 return (ifunit(if_name));
 531         }
 532
 533         return (NULL);
 534 }
 535
 536 /*
 537  * Calculates proper ifa/ifp for the cases when gateway AF is different
 538  * from dst AF.
 539  *
 540  * Returns 0 on success.
 541  */
 542 __noinline static int
 543 rt_getifa_family(struct rt_addrinfo *info, uint32_t fibnum)
 544 {
 545         if (info->rti_ifp == NULL) {
 546                 struct ifaddr *ifa = NULL;
 547                 /*
 548                  * No transmit interface specified. Guess it by checking gw sa.
 549                  */
 550                 const struct sockaddr *gw = info->rti_info[RTAX_GATEWAY];
 551                 ifa = ifa_ifwithroute(RTF_GATEWAY, gw, gw, fibnum);
 552                 if (ifa == NULL)
 553                         return (ENETUNREACH);
 554                 info->rti_ifp = ifa->ifa_ifp;
 555         }
 556
 557         /* Prefer address from outgoing interface */
 558         info->rti_ifa = ifaof_ifpforaddr(info->rti_info[RTAX_DST], info->rti_ifp);
 559 #ifdef INET
 560         if (info->rti_ifa == NULL) {
 561                 /* Use first found IPv4 address */
 562                 bool loopback_ok = info->rti_ifp->if_flags & IFF_LOOPBACK;
 563                 info->rti_ifa = (struct ifaddr *)in_findlocal(fibnum, loopback_ok);
 564         }
 565 #endif
 566         if (info->rti_ifa == NULL)
 567                 return (ENETUNREACH);
 568         return (0);
 569 }
 570
 571 /*
 572  * Fills in rti_ifp and rti_ifa for the provided fib.
 573  *
 574  * Assume basic consistency checks are executed by callers:
 575  * RTAX_DST exists, if RTF_GATEWAY is set, RTAX_GATEWAY exists as well.
 576  */
 577 int
 578 rt_getifa_fib(struct rt_addrinfo *info, u_int fibnum)
 579 {
 580         const struct sockaddr *dst, *gateway, *ifaaddr;
 581         int error, flags;
 582
 583         dst = info->rti_info[RTAX_DST];
 584         gateway = info->rti_info[RTAX_GATEWAY];
 585         ifaaddr = info->rti_info[RTAX_IFA];
 586         flags = info->rti_flags;
 587
 588         /*
 589          * ifp may be specified by sockaddr_dl
 590          * when protocol address is ambiguous.
 591          */
 592         error = 0;
 593
 594         /* If we have interface specified by RTAX_IFP address, try to use it */
 595         if ((info->rti_ifp == NULL) && (info->rti_info[RTAX_IFP] != NULL))
 596                 info->rti_ifp = info_get_ifp(info);
 597         /*
 598          * If we have source address specified, try to find it
 599          * TODO: avoid enumerating all ifas on all interfaces.
 600          */
 601         if (info->rti_ifa == NULL && ifaaddr != NULL)
 602                 info->rti_ifa = ifa_ifwithaddr(ifaaddr);
 603         if ((info->rti_ifa == NULL) && ((info->rti_flags & RTF_GATEWAY) != 0) &&
 604             (gateway->sa_family != dst->sa_family))
 605                 return (rt_getifa_family(info, fibnum));
 606         if (info->rti_ifa == NULL) {
 607                 const struct sockaddr *sa;
 608
 609                 /*
 610                  * Most common use case for the userland-supplied routes.
 611                  *
 612                  * Choose sockaddr to select ifa.
 613                  * -- if ifp is set --
 614                  * Order of preference:
 615                  * 1) IFA address
 616                  * 2) gateway address
 617                  *   Note: for interface routes link-level gateway address
 618                  *     is specified to indicate the interface index without
 619                  *     specifying RTF_GATEWAY. In this case, ignore gateway
 620                  *   Note: gateway AF may be different from dst AF. In this case,
 621                  *   ignore gateway
 622                  * 3) final destination.
 623                  * 4) if all of these fails, try to get at least link-level ifa.
 624                  * -- else --
 625                  * try to lookup gateway or dst in the routing table to get ifa
 626                  */
 627                 if (info->rti_info[RTAX_IFA] != NULL)
 628                         sa = info->rti_info[RTAX_IFA];
 629                 else if ((info->rti_flags & RTF_GATEWAY) != 0 &&
 630                     gateway->sa_family == dst->sa_family)
 631                         sa = gateway;
 632                 else
 633                         sa = dst;
 634                 if (info->rti_ifp != NULL) {
 635                         info->rti_ifa = ifaof_ifpforaddr(sa, info->rti_ifp);
 636                         /* Case 4 */
 637                         if (info->rti_ifa == NULL && gateway != NULL)
 638                                 info->rti_ifa = ifaof_ifpforaddr(gateway, info->rti_ifp);
 639                 } else if (dst != NULL && gateway != NULL)
 640                         info->rti_ifa = ifa_ifwithroute(flags, dst, gateway,
 641                                                         fibnum);
 642                 else if (sa != NULL)
 643                         info->rti_ifa = ifa_ifwithroute(flags, sa, sa,
 644                                                         fibnum);
 645         }
 646         if (info->rti_ifa != NULL) {
 647                 if (info->rti_ifp == NULL)
 648                         info->rti_ifp = info->rti_ifa->ifa_ifp;
 649         } else
 650                 error = ENETUNREACH;
 651         return (error);
 652 }
 653
 654 void
 655 rt_updatemtu(struct ifnet *ifp)
 656 {
 657         struct rib_head *rnh;
 658         int mtu;
 659         int i, j;
 660
 661         /*
 662          * Try to update rt_mtu for all routes using this interface
 663          * Unfortunately the only way to do this is to traverse all
 664          * routing tables in all fibs/domains.
 665          */
 666         for (i = 1; i <= AF_MAX; i++) {
 667                 mtu = if_getmtu_family(ifp, i);
 668                 for (j = 0; j < rt_numfibs; j++) {
 669                         rnh = rt_tables_get_rnh(j, i);
 670                         if (rnh == NULL)
 671                                 continue;
 672                         nhops_update_ifmtu(rnh, ifp, mtu);
 673                 }
 674         }
 675 }
 676
 677 #if 0
 678 int p_sockaddr(char *buf, int buflen, struct sockaddr *s);
 679 int rt_print(char *buf, int buflen, struct rtentry *rt);
 680
 681 int
 682 p_sockaddr(char *buf, int buflen, struct sockaddr *s)
 683 {
 684         void *paddr = NULL;
 685
 686         switch (s->sa_family) {
 687         case AF_INET:
 688                 paddr = &((struct sockaddr_in *)s)->sin_addr;
 689                 break;
 690         case AF_INET6:
 691                 paddr = &((struct sockaddr_in6 *)s)->sin6_addr;
 692                 break;
 693         }
 694
 695         if (paddr == NULL)
 696                 return (0);
 697
 698         if (inet_ntop(s->sa_family, paddr, buf, buflen) == NULL)
 699                 return (0);
 700
 701         return (strlen(buf));
 702 }
 703
 704 int
 705 rt_print(char *buf, int buflen, struct rtentry *rt)
 706 {
 707         struct sockaddr *addr, *mask;
 708         int i = 0;
 709
 710         addr = rt_key(rt);
 711         mask = rt_mask(rt);
 712
 713         i = p_sockaddr(buf, buflen, addr);
 714         if (!(rt->rt_flags & RTF_HOST)) {
 715                 buf[i++] = '/';
 716                 i += p_sockaddr(buf + i, buflen - i, mask);
 717         }
 718
 719         if (rt->rt_flags & RTF_GATEWAY) {
 720                 buf[i++] = '>';
 721                 i += p_sockaddr(buf + i, buflen - i, &rt->rt_nhop->gw_sa);
 722         }
 723
 724         return (i);
 725 }
 726 #endif
 727
 728 void
 729 rt_maskedcopy(const struct sockaddr *src, struct sockaddr *dst,
 730     const struct sockaddr *netmask)
 731 {
 732         const u_char *cp1 = (const u_char *)src;
 733         u_char *cp2 = (u_char *)dst;
 734         const u_char *cp3 = (const u_char *)netmask;
 735         u_char *cplim = cp2 + *cp3;
 736         u_char *cplim2 = cp2 + *cp1;
 737
 738         *cp2++ = *cp1++; *cp2++ = *cp1++; /* copies sa_len & sa_family */
 739         cp3 += 2;
 740         if (cplim > cplim2)
 741                 cplim = cplim2;
 742         while (cp2 < cplim)
 743                 *cp2++ = *cp1++ & *cp3++;
 744         if (cp2 < cplim2)
 745                 bzero((caddr_t)cp2, (unsigned)(cplim2 - cp2));
 746 }
 747
 748 /*
 749  * Announce interface address arrival/withdraw
 750  * Returns 0 on success.
 751  */
 752 int
 753 rt_addrmsg(int cmd, struct ifaddr *ifa, int fibnum)
 754 {
 755
 756         KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE,
 757             ("unexpected cmd %d", cmd));
 758         KASSERT((fibnum >= 0 && fibnum < rt_numfibs),
 759             ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
 760
 761         EVENTHANDLER_DIRECT_INVOKE(rt_addrmsg, ifa, cmd);
 762
 763         if (V_rt_add_addr_allfibs)
 764                 fibnum = RT_ALL_FIBS;
 765         return (rtsock_addrmsg(cmd, ifa, fibnum));
 766 }
 767
 768 /*
 769  * Announce kernel-originated route addition/removal to rtsock based on @rt data.
 770  * cmd: RTM_ cmd
 771  * @rt: valid rtentry
 772  * @nh: nhop object to announce
 773  * @fibnum: fib id or RT_ALL_FIBS
 774  *
 775  * Returns 0 on success.
 776  */
 777 int
 778 rt_routemsg(int cmd, struct rtentry *rt, struct nhop_object *nh,
 779     int fibnum)
 780 {
 781
 782         KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE || cmd == RTM_CHANGE,
 783             ("unexpected cmd %d", cmd));
 784
 785         KASSERT(fibnum == RT_ALL_FIBS || (fibnum >= 0 && fibnum < rt_numfibs),
 786             ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
 787
 788         KASSERT(rt_key(rt) != NULL, (":%s: rt_key must be supplied", __func__));
 789
 790         return (rtsock_routemsg(cmd, rt, nh, fibnum));
 791 }
 792
 793 /*
 794  * Announce kernel-originated route addition/removal to rtsock based on @rt data.
 795  * cmd: RTM_ cmd
 796  * @info: addrinfo structure with valid data.
 797  * @fibnum: fib id or RT_ALL_FIBS
 798  *
 799  * Returns 0 on success.
 800  */
 801 int
 802 rt_routemsg_info(int cmd, struct rt_addrinfo *info, int fibnum)
 803 {
 804
 805         KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE || cmd == RTM_CHANGE,
 806             ("unexpected cmd %d", cmd));
 807
 808         KASSERT(fibnum == RT_ALL_FIBS || (fibnum >= 0 && fibnum < rt_numfibs),
 809             ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
 810
 811         KASSERT(info->rti_info[RTAX_DST] != NULL, (":%s: RTAX_DST must be supplied", __func__));
 812
 813         return (rtsock_routemsg_info(cmd, info, fibnum));
 814 }
 815
 816 void
 817 rt_ifmsg(struct ifnet *ifp)
 818 {
 819         rt_ifmsg_14(ifp, 0);
 820 }
 821
 822 void
 823 rt_ifmsg_14(struct ifnet *ifp, int if_flags_mask)
 824 {
 825         rtsock_callback_p->ifmsg_f(ifp, if_flags_mask);
 826         netlink_callback_p->ifmsg_f(ifp, if_flags_mask);
 827 }
 828
 829 /* Netlink-related callbacks needed to glue rtsock, netlink and linuxolator */
 830 static void
 831 ignore_route_event(uint32_t fibnum, const struct rib_cmd_info *rc)
 832 {
 833 }
 834
 835 static void
 836 ignore_ifmsg_event(struct ifnet *ifp, int if_flags_mask)
 837 {
 838 }
 839
 840 static struct rtbridge ignore_cb = {
 841         .route_f = ignore_route_event,
 842         .ifmsg_f = ignore_ifmsg_event,
 843 };
 844
 845 void *linux_netlink_p = NULL; /* Callback pointer for Linux translator functions */
 846 struct rtbridge *rtsock_callback_p = &ignore_cb;
 847 struct rtbridge *netlink_callback_p = &ignore_cb;