xref: /freebsd/sys/net/route.c (revision d485c77f203fb0f4cdc08dea5ff81631b51d8809)
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 rib_cmd_info rc;
192 	int error;
193 	struct rt_addrinfo info;
194 	struct rt_metrics rti_rmx;
195 	struct ifaddr *ifa;
196 
197 	NET_EPOCH_ASSERT();
198 
199 	if (rt_tables_get_rnh(fibnum, dst->sa_family) == NULL)
200 		return (EAFNOSUPPORT);
201 
202 	/* Verify the allowed flag mask. */
203 	KASSERT(((flags & ~(RTF_GATEWAY)) == 0),
204 	    ("invalid redirect flags: %x", flags));
205 	flags |= RTF_HOST | RTF_DYNAMIC;
206 
207 	/* Get the best ifa for the given interface and gateway. */
208 	if ((ifa = ifaof_ifpforaddr(gateway, ifp)) == NULL)
209 		return (ENETUNREACH);
210 	ifa_ref(ifa);
211 
212 	bzero(&info, sizeof(info));
213 	info.rti_info[RTAX_DST] = dst;
214 	info.rti_info[RTAX_GATEWAY] = gateway;
215 	info.rti_ifa = ifa;
216 	info.rti_ifp = ifp;
217 	info.rti_flags = flags;
218 
219 	/* Setup route metrics to define expire time. */
220 	bzero(&rti_rmx, sizeof(rti_rmx));
221 	/* Set expire time as absolute. */
222 	rti_rmx.rmx_expire = lifetime_sec + time_second;
223 	info.rti_mflags |= RTV_EXPIRE;
224 	info.rti_rmx = &rti_rmx;
225 
226 	error = rib_action(fibnum, RTM_ADD, &info, &rc);
227 	ifa_free(ifa);
228 
229 	if (error != 0) {
230 		/* TODO: add per-fib redirect stats. */
231 		return (error);
232 	}
233 
234 	RTSTAT_INC(rts_dynamic);
235 
236 	/* Send notification of a route addition to userland. */
237 	bzero(&info, sizeof(info));
238 	info.rti_info[RTAX_DST] = dst;
239 	info.rti_info[RTAX_GATEWAY] = gateway;
240 	info.rti_info[RTAX_AUTHOR] = author;
241 	rt_missmsg_fib(RTM_REDIRECT, &info, flags | RTF_UP, error, fibnum);
242 
243 	return (0);
244 }
245 
246 /*
247  * Routing table ioctl interface.
248  */
249 int
250 rtioctl_fib(u_long req, caddr_t data, u_int fibnum)
251 {
252 
253 	/*
254 	 * If more ioctl commands are added here, make sure the proper
255 	 * super-user checks are being performed because it is possible for
256 	 * prison-root to make it this far if raw sockets have been enabled
257 	 * in jails.
258 	 */
259 #ifdef INET
260 	/* Multicast goop, grrr... */
261 	return mrt_ioctl ? mrt_ioctl(req, data, fibnum) : EOPNOTSUPP;
262 #else /* INET */
263 	return ENXIO;
264 #endif /* INET */
265 }
266 
267 struct ifaddr *
268 ifa_ifwithroute(int flags, const struct sockaddr *dst,
269     const struct sockaddr *gateway, u_int fibnum)
270 {
271 	struct ifaddr *ifa;
272 
273 	NET_EPOCH_ASSERT();
274 	if ((flags & RTF_GATEWAY) == 0) {
275 		/*
276 		 * If we are adding a route to an interface,
277 		 * and the interface is a pt to pt link
278 		 * we should search for the destination
279 		 * as our clue to the interface.  Otherwise
280 		 * we can use the local address.
281 		 */
282 		ifa = NULL;
283 		if (flags & RTF_HOST)
284 			ifa = ifa_ifwithdstaddr(dst, fibnum);
285 		if (ifa == NULL)
286 			ifa = ifa_ifwithaddr(gateway);
287 	} else {
288 		/*
289 		 * If we are adding a route to a remote net
290 		 * or host, the gateway may still be on the
291 		 * other end of a pt to pt link.
292 		 */
293 		ifa = ifa_ifwithdstaddr(gateway, fibnum);
294 	}
295 	if (ifa == NULL)
296 		ifa = ifa_ifwithnet(gateway, 0, fibnum);
297 	if (ifa == NULL) {
298 		struct nhop_object *nh;
299 
300 		nh = rib_lookup(fibnum, gateway, NHR_NONE, 0);
301 
302 		/*
303 		 * dismiss a gateway that is reachable only
304 		 * through the default router
305 		 */
306 		if ((nh == NULL) || (nh->nh_flags & NHF_DEFAULT))
307 			return (NULL);
308 		ifa = nh->nh_ifa;
309 	}
310 	if (ifa->ifa_addr->sa_family != dst->sa_family) {
311 		struct ifaddr *oifa = ifa;
312 		ifa = ifaof_ifpforaddr(dst, ifa->ifa_ifp);
313 		if (ifa == NULL)
314 			ifa = oifa;
315 	}
316 
317 	return (ifa);
318 }
319 
320 /*
321  * Copy most of @rt data into @info.
322  *
323  * If @flags contains NHR_COPY, copies dst,netmask and gw to the
324  * pointers specified by @info structure. Assume such pointers
325  * are zeroed sockaddr-like structures with sa_len field initialized
326  * to reflect size of the provided buffer. if no NHR_COPY is specified,
327  * point dst,netmask and gw @info fields to appropriate @rt values.
328  *
329  * if @flags contains NHR_REF, do refcouting on rt_ifp and rt_ifa.
330  *
331  * Returns 0 on success.
332  */
333 static int
334 rt_exportinfo(struct rtentry *rt, struct nhop_object *nh,
335     struct rt_addrinfo *info, int flags)
336 {
337 	struct rt_metrics *rmx;
338 	struct sockaddr *src, *dst;
339 	int sa_len;
340 
341 	if (flags & NHR_COPY) {
342 		/* Copy destination if dst is non-zero */
343 		src = rt_key(rt);
344 		dst = info->rti_info[RTAX_DST];
345 		sa_len = src->sa_len;
346 		if (dst != NULL) {
347 			if (src->sa_len > dst->sa_len)
348 				return (ENOMEM);
349 			memcpy(dst, src, src->sa_len);
350 			info->rti_addrs |= RTA_DST;
351 		}
352 
353 		/* Copy mask if set && dst is non-zero */
354 		src = rt_mask(rt);
355 		dst = info->rti_info[RTAX_NETMASK];
356 		if (src != NULL && dst != NULL) {
357 			/*
358 			 * Radix stores different value in sa_len,
359 			 * assume rt_mask() to have the same length
360 			 * as rt_key()
361 			 */
362 			if (sa_len > dst->sa_len)
363 				return (ENOMEM);
364 			memcpy(dst, src, src->sa_len);
365 			info->rti_addrs |= RTA_NETMASK;
366 		}
367 
368 		/* Copy gateway is set && dst is non-zero */
369 		src = &nh->gw_sa;
370 		dst = info->rti_info[RTAX_GATEWAY];
371 		if ((nhop_get_rtflags(nh) & RTF_GATEWAY) &&
372 		    src != NULL && dst != NULL) {
373 			if (src->sa_len > dst->sa_len)
374 				return (ENOMEM);
375 			memcpy(dst, src, src->sa_len);
376 			info->rti_addrs |= RTA_GATEWAY;
377 		}
378 	} else {
379 		info->rti_info[RTAX_DST] = rt_key(rt);
380 		info->rti_addrs |= RTA_DST;
381 		if (rt_mask(rt) != NULL) {
382 			info->rti_info[RTAX_NETMASK] = rt_mask(rt);
383 			info->rti_addrs |= RTA_NETMASK;
384 		}
385 		if (nhop_get_rtflags(nh) & RTF_GATEWAY) {
386 			info->rti_info[RTAX_GATEWAY] = &nh->gw_sa;
387 			info->rti_addrs |= RTA_GATEWAY;
388 		}
389 	}
390 
391 	rmx = info->rti_rmx;
392 	if (rmx != NULL) {
393 		info->rti_mflags |= RTV_MTU;
394 		rmx->rmx_mtu = nh->nh_mtu;
395 	}
396 
397 	info->rti_flags = rt->rte_flags | nhop_get_rtflags(nh);
398 	info->rti_ifp = nh->nh_ifp;
399 	info->rti_ifa = nh->nh_ifa;
400 	if (flags & NHR_REF) {
401 		if_ref(info->rti_ifp);
402 		ifa_ref(info->rti_ifa);
403 	}
404 
405 	return (0);
406 }
407 
408 /*
409  * Lookups up route entry for @dst in RIB database for fib @fibnum.
410  * Exports entry data to @info using rt_exportinfo().
411  *
412  * If @flags contains NHR_REF, refcouting is performed on rt_ifp and rt_ifa.
413  * All references can be released later by calling rib_free_info().
414  *
415  * Returns 0 on success.
416  * Returns ENOENT for lookup failure, ENOMEM for export failure.
417  */
418 int
419 rib_lookup_info(uint32_t fibnum, const struct sockaddr *dst, uint32_t flags,
420     uint32_t flowid, struct rt_addrinfo *info)
421 {
422 	RIB_RLOCK_TRACKER;
423 	struct rib_head *rh;
424 	struct radix_node *rn;
425 	struct rtentry *rt;
426 	struct nhop_object *nh;
427 	int error;
428 
429 	KASSERT((fibnum < rt_numfibs), ("rib_lookup_rte: bad fibnum"));
430 	rh = rt_tables_get_rnh(fibnum, dst->sa_family);
431 	if (rh == NULL)
432 		return (ENOENT);
433 
434 	RIB_RLOCK(rh);
435 	rn = rh->rnh_matchaddr(__DECONST(void *, dst), &rh->head);
436 	if (rn != NULL && ((rn->rn_flags & RNF_ROOT) == 0)) {
437 		rt = RNTORT(rn);
438 		nh = nhop_select(rt->rt_nhop, flowid);
439 		/* Ensure route & ifp is UP */
440 		if (RT_LINK_IS_UP(nh->nh_ifp)) {
441 			flags = (flags & NHR_REF) | NHR_COPY;
442 			error = rt_exportinfo(rt, nh, info, flags);
443 			RIB_RUNLOCK(rh);
444 
445 			return (error);
446 		}
447 	}
448 	RIB_RUNLOCK(rh);
449 
450 	return (ENOENT);
451 }
452 
453 /*
454  * Releases all references acquired by rib_lookup_info() when
455  * called with NHR_REF flags.
456  */
457 void
458 rib_free_info(struct rt_addrinfo *info)
459 {
460 
461 	ifa_free(info->rti_ifa);
462 	if_rele(info->rti_ifp);
463 }
464 
465 /*
466  * Delete Routes for a Network Interface
467  *
468  * Called for each routing entry via the rnh->rnh_walktree() call above
469  * to delete all route entries referencing a detaching network interface.
470  *
471  * Arguments:
472  *	rt	pointer to rtentry
473  *	nh	pointer to nhop
474  *	arg	argument passed to rnh->rnh_walktree() - detaching interface
475  *
476  * Returns:
477  *	0	successful
478  *	errno	failed - reason indicated
479  */
480 static int
481 rt_ifdelroute(const struct rtentry *rt, const struct nhop_object *nh, void *arg)
482 {
483 	struct ifnet	*ifp = arg;
484 
485 	if (nh->nh_ifp != ifp)
486 		return (0);
487 
488 	/*
489 	 * Protect (sorta) against walktree recursion problems
490 	 * with cloned routes
491 	 */
492 	if ((rt->rte_flags & RTF_UP) == 0)
493 		return (0);
494 
495 	return (1);
496 }
497 
498 /*
499  * Delete all remaining routes using this interface
500  * Unfortuneatly the only way to do this is to slog through
501  * the entire routing table looking for routes which point
502  * to this interface...oh well...
503  */
504 void
505 rt_flushifroutes_af(struct ifnet *ifp, int af)
506 {
507 	KASSERT((af >= 1 && af <= AF_MAX), ("%s: af %d not >= 1 and <= %d",
508 	    __func__, af, AF_MAX));
509 
510 	rib_foreach_table_walk_del(af, rt_ifdelroute, ifp);
511 }
512 
513 void
514 rt_flushifroutes(struct ifnet *ifp)
515 {
516 
517 	rib_foreach_table_walk_del(AF_UNSPEC, rt_ifdelroute, ifp);
518 }
519 
520 /*
521  * Look up rt_addrinfo for a specific fib.  Note that if rti_ifa is defined,
522  * it will be referenced so the caller must free it.
523  *
524  * Assume basic consistency checks are executed by callers:
525  * RTAX_DST exists, if RTF_GATEWAY is set, RTAX_GATEWAY exists as well.
526  */
527 int
528 rt_getifa_fib(struct rt_addrinfo *info, u_int fibnum)
529 {
530 	const struct sockaddr *dst, *gateway, *ifpaddr, *ifaaddr;
531 	struct epoch_tracker et;
532 	int needref, error, flags;
533 
534 	dst = info->rti_info[RTAX_DST];
535 	gateway = info->rti_info[RTAX_GATEWAY];
536 	ifpaddr = info->rti_info[RTAX_IFP];
537 	ifaaddr = info->rti_info[RTAX_IFA];
538 	flags = info->rti_flags;
539 
540 	/*
541 	 * ifp may be specified by sockaddr_dl
542 	 * when protocol address is ambiguous.
543 	 */
544 	error = 0;
545 	needref = (info->rti_ifa == NULL);
546 	NET_EPOCH_ENTER(et);
547 
548 	/* If we have interface specified by the ifindex in the address, use it */
549 	if (info->rti_ifp == NULL && ifpaddr != NULL &&
550 	    ifpaddr->sa_family == AF_LINK) {
551 	    const struct sockaddr_dl *sdl = (const struct sockaddr_dl *)ifpaddr;
552 	    if (sdl->sdl_index != 0)
553 		    info->rti_ifp = ifnet_byindex(sdl->sdl_index);
554 	}
555 	/*
556 	 * If we have source address specified, try to find it
557 	 * TODO: avoid enumerating all ifas on all interfaces.
558 	 */
559 	if (info->rti_ifa == NULL && ifaaddr != NULL)
560 		info->rti_ifa = ifa_ifwithaddr(ifaaddr);
561 	if (info->rti_ifa == NULL) {
562 		const struct sockaddr *sa;
563 
564 		/*
565 		 * Most common use case for the userland-supplied routes.
566 		 *
567 		 * Choose sockaddr to select ifa.
568 		 * -- if ifp is set --
569 		 * Order of preference:
570 		 * 1) IFA address
571 		 * 2) gateway address
572 		 *   Note: for interface routes link-level gateway address
573 		 *     is specified to indicate the interface index without
574 		 *     specifying RTF_GATEWAY. In this case, ignore gateway
575 		 *   Note: gateway AF may be different from dst AF. In this case,
576 		 *   ignore gateway
577 		 * 3) final destination.
578 		 * 4) if all of these fails, try to get at least link-level ifa.
579 		 * -- else --
580 		 * try to lookup gateway or dst in the routing table to get ifa
581 		 */
582 		if (info->rti_info[RTAX_IFA] != NULL)
583 			sa = info->rti_info[RTAX_IFA];
584 		else if ((info->rti_flags & RTF_GATEWAY) != 0 &&
585 		    gateway->sa_family == dst->sa_family)
586 			sa = gateway;
587 		else
588 			sa = dst;
589 		if (info->rti_ifp != NULL) {
590 			info->rti_ifa = ifaof_ifpforaddr(sa, info->rti_ifp);
591 			/* Case 4 */
592 			if (info->rti_ifa == NULL && gateway != NULL)
593 				info->rti_ifa = ifaof_ifpforaddr(gateway, info->rti_ifp);
594 		} else if (dst != NULL && gateway != NULL)
595 			info->rti_ifa = ifa_ifwithroute(flags, dst, gateway,
596 							fibnum);
597 		else if (sa != NULL)
598 			info->rti_ifa = ifa_ifwithroute(flags, sa, sa,
599 							fibnum);
600 	}
601 	if (needref && info->rti_ifa != NULL) {
602 		if (info->rti_ifp == NULL)
603 			info->rti_ifp = info->rti_ifa->ifa_ifp;
604 		ifa_ref(info->rti_ifa);
605 	} else
606 		error = ENETUNREACH;
607 	NET_EPOCH_EXIT(et);
608 	return (error);
609 }
610 
611 void
612 rt_updatemtu(struct ifnet *ifp)
613 {
614 	struct rib_head *rnh;
615 	int mtu;
616 	int i, j;
617 
618 	/*
619 	 * Try to update rt_mtu for all routes using this interface
620 	 * Unfortunately the only way to do this is to traverse all
621 	 * routing tables in all fibs/domains.
622 	 */
623 	for (i = 1; i <= AF_MAX; i++) {
624 		mtu = if_getmtu_family(ifp, i);
625 		for (j = 0; j < rt_numfibs; j++) {
626 			rnh = rt_tables_get_rnh(j, i);
627 			if (rnh == NULL)
628 				continue;
629 			nhops_update_ifmtu(rnh, ifp, mtu);
630 		}
631 	}
632 }
633 
634 #if 0
635 int p_sockaddr(char *buf, int buflen, struct sockaddr *s);
636 int rt_print(char *buf, int buflen, struct rtentry *rt);
637 
638 int
639 p_sockaddr(char *buf, int buflen, struct sockaddr *s)
640 {
641 	void *paddr = NULL;
642 
643 	switch (s->sa_family) {
644 	case AF_INET:
645 		paddr = &((struct sockaddr_in *)s)->sin_addr;
646 		break;
647 	case AF_INET6:
648 		paddr = &((struct sockaddr_in6 *)s)->sin6_addr;
649 		break;
650 	}
651 
652 	if (paddr == NULL)
653 		return (0);
654 
655 	if (inet_ntop(s->sa_family, paddr, buf, buflen) == NULL)
656 		return (0);
657 
658 	return (strlen(buf));
659 }
660 
661 int
662 rt_print(char *buf, int buflen, struct rtentry *rt)
663 {
664 	struct sockaddr *addr, *mask;
665 	int i = 0;
666 
667 	addr = rt_key(rt);
668 	mask = rt_mask(rt);
669 
670 	i = p_sockaddr(buf, buflen, addr);
671 	if (!(rt->rt_flags & RTF_HOST)) {
672 		buf[i++] = '/';
673 		i += p_sockaddr(buf + i, buflen - i, mask);
674 	}
675 
676 	if (rt->rt_flags & RTF_GATEWAY) {
677 		buf[i++] = '>';
678 		i += p_sockaddr(buf + i, buflen - i, &rt->rt_nhop->gw_sa);
679 	}
680 
681 	return (i);
682 }
683 #endif
684 
685 void
686 rt_maskedcopy(struct sockaddr *src, struct sockaddr *dst, struct sockaddr *netmask)
687 {
688 	u_char *cp1 = (u_char *)src;
689 	u_char *cp2 = (u_char *)dst;
690 	u_char *cp3 = (u_char *)netmask;
691 	u_char *cplim = cp2 + *cp3;
692 	u_char *cplim2 = cp2 + *cp1;
693 
694 	*cp2++ = *cp1++; *cp2++ = *cp1++; /* copies sa_len & sa_family */
695 	cp3 += 2;
696 	if (cplim > cplim2)
697 		cplim = cplim2;
698 	while (cp2 < cplim)
699 		*cp2++ = *cp1++ & *cp3++;
700 	if (cp2 < cplim2)
701 		bzero((caddr_t)cp2, (unsigned)(cplim2 - cp2));
702 }
703 
704 /*
705  * Announce interface address arrival/withdraw
706  * Returns 0 on success.
707  */
708 int
709 rt_addrmsg(int cmd, struct ifaddr *ifa, int fibnum)
710 {
711 
712 	KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE,
713 	    ("unexpected cmd %d", cmd));
714 	KASSERT((fibnum >= 0 && fibnum < rt_numfibs),
715 	    ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
716 
717 	EVENTHANDLER_DIRECT_INVOKE(rt_addrmsg, ifa, cmd);
718 
719 	if (V_rt_add_addr_allfibs)
720 		fibnum = RT_ALL_FIBS;
721 	return (rtsock_addrmsg(cmd, ifa, fibnum));
722 }
723 
724 /*
725  * Announce kernel-originated route addition/removal to rtsock based on @rt data.
726  * cmd: RTM_ cmd
727  * @rt: valid rtentry
728  * @nh: nhop object to announce
729  * @fibnum: fib id or RT_ALL_FIBS
730  *
731  * Returns 0 on success.
732  */
733 int
734 rt_routemsg(int cmd, struct rtentry *rt, struct nhop_object *nh,
735     int fibnum)
736 {
737 
738 	KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE,
739 	    ("unexpected cmd %d", cmd));
740 
741 	KASSERT(fibnum == RT_ALL_FIBS || (fibnum >= 0 && fibnum < rt_numfibs),
742 	    ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
743 
744 	KASSERT(rt_key(rt) != NULL, (":%s: rt_key must be supplied", __func__));
745 
746 	return (rtsock_routemsg(cmd, rt, nh, fibnum));
747 }
748 
749 /*
750  * Announce kernel-originated route addition/removal to rtsock based on @rt data.
751  * cmd: RTM_ cmd
752  * @info: addrinfo structure with valid data.
753  * @fibnum: fib id or RT_ALL_FIBS
754  *
755  * Returns 0 on success.
756  */
757 int
758 rt_routemsg_info(int cmd, struct rt_addrinfo *info, int fibnum)
759 {
760 
761 	KASSERT(cmd == RTM_ADD || cmd == RTM_DELETE || cmd == RTM_CHANGE,
762 	    ("unexpected cmd %d", cmd));
763 
764 	KASSERT(fibnum == RT_ALL_FIBS || (fibnum >= 0 && fibnum < rt_numfibs),
765 	    ("%s: fib out of range 0 <=%d<%d", __func__, fibnum, rt_numfibs));
766 
767 	KASSERT(info->rti_info[RTAX_DST] != NULL, (":%s: RTAX_DST must be supplied", __func__));
768 
769 	return (rtsock_routemsg_info(cmd, info, fibnum));
770 }
771