2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1983, 1988, 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
34 static char sccsid[] = "From: @(#)route.c 8.6 (Berkeley) 4/28/95";
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/protosw.h>
43 #include <sys/socket.h>
44 #include <sys/socketvar.h>
45 #include <sys/sysctl.h>
48 #include <net/ethernet.h>
50 #include <net/if_dl.h>
51 #include <net/if_types.h>
52 #include <net/route.h>
54 #include <netinet/in.h>
55 #include <netgraph/ng_socket.h>
57 #include <arpa/inet.h>
75 * Definitions for showing gateway flags.
82 { RTF_UP, 'U', "up" },
83 { RTF_GATEWAY, 'G', "gateway" },
84 { RTF_HOST, 'H', "host" },
85 { RTF_REJECT, 'R', "reject" },
86 { RTF_DYNAMIC, 'D', "dynamic" },
87 { RTF_MODIFIED, 'M', "modified" },
88 { RTF_DONE, 'd', "done" }, /* Completed -- for routing msgs only */
89 { RTF_XRESOLVE, 'X', "xresolve" },
90 { RTF_STATIC, 'S', "static" },
91 { RTF_PROTO1, '1', "proto1" },
92 { RTF_PROTO2, '2', "proto2" },
93 { RTF_PROTO3, '3', "proto3" },
94 { RTF_BLACKHOLE,'B', "blackhole" },
95 { RTF_BROADCAST,'b', "broadcast" },
97 { RTF_LLINFO, 'L', "llinfo" },
103 char ifname[IFNAMSIZ];
105 static struct ifmap_entry *ifmap;
106 static int ifmap_size;
107 static struct timespec uptime;
109 static const char *netname4(in_addr_t, in_addr_t);
111 static const char *netname6(struct sockaddr_in6 *, struct sockaddr_in6 *);
113 static void p_rtable_sysctl(int, int);
114 static void p_rtentry_sysctl(const char *name, struct rt_msghdr *);
115 static int p_sockaddr(const char *name, struct sockaddr *, struct sockaddr *,
117 static const char *fmt_sockaddr(struct sockaddr *sa, struct sockaddr *mask,
119 static void p_flags(int, const char *);
120 static const char *fmt_flags(int f);
121 static void domask(char *, size_t, u_long);
125 * Print routing tables.
128 routepr(int fibnum, int af)
136 intsize = sizeof(int);
138 sysctlbyname("net.my_fibnum", &fibnum, &intsize, NULL, 0) == -1)
140 if (sysctlbyname("net.fibs", &numfibs, &intsize, NULL, 0) == -1)
142 if (fibnum < 0 || fibnum > numfibs - 1)
143 errx(EX_USAGE, "%d: invalid fib", fibnum);
145 * Since kernel & userland use different timebase
146 * (time_uptime vs time_second) and we are reading kernel memory
147 * directly we should do rt_expire --> expire_time conversion.
149 if (clock_gettime(CLOCK_UPTIME, &uptime) < 0)
150 err(EX_OSERR, "clock_gettime() failed");
152 xo_open_container("route-information");
153 xo_emit("{T:Routing tables}");
155 xo_emit(" ({L:fib}: {:fib/%d})", fibnum);
157 p_rtable_sysctl(fibnum, af);
158 xo_close_container("route-information");
163 * Print address family header before a section of the routing table.
176 afname = "Internet6";
193 xo_emit("\n{k:address-family/%s}:\n", afname);
195 xo_emit("\n{L:Protocol Family} {k:address-family/%d}:\n", af1);
198 /* column widths; each followed by one space */
200 #define WID_DST_DEFAULT(af) 18 /* width of destination column */
201 #define WID_GW_DEFAULT(af) 18 /* width of gateway column */
202 #define WID_IF_DEFAULT(af) (Wflag ? 10 : 8) /* width of netif column */
204 #define WID_DST_DEFAULT(af) \
205 ((af) == AF_INET6 ? (numeric_addr ? 33: 18) : 18)
206 #define WID_GW_DEFAULT(af) \
207 ((af) == AF_INET6 ? (numeric_addr ? 29 : 18) : 18)
208 #define WID_IF_DEFAULT(af) ((af) == AF_INET6 ? 8 : (Wflag ? 10 : 8))
213 static int wid_flags;
214 static int wid_pksent;
217 static int wid_expire;
220 * Print header for routing table columns.
223 pr_rthdr(int af1 __unused)
227 xo_emit("{T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%*.*s} "
228 "{T:/%*.*s} {T:/%*.*s} {T:/%*s}\n",
229 wid_dst, wid_dst, "Destination",
230 wid_gw, wid_gw, "Gateway",
231 wid_flags, wid_flags, "Flags",
232 wid_pksent, wid_pksent, "Use",
233 wid_mtu, wid_mtu, "Mtu",
234 wid_if, wid_if, "Netif",
235 wid_expire, "Expire");
237 xo_emit("{T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%*.*s} "
239 wid_dst, wid_dst, "Destination",
240 wid_gw, wid_gw, "Gateway",
241 wid_flags, wid_flags, "Flags",
242 wid_if, wid_if, "Netif",
243 wid_expire, "Expire");
248 p_rtable_sysctl(int fibnum, int af)
252 char *buf, *next, *lim;
253 struct rt_msghdr *rtm;
255 int fam = AF_UNSPEC, ifindex = 0, size;
256 int need_table_close = false;
258 struct ifaddrs *ifap, *ifa;
259 struct sockaddr_dl *sdl;
262 * Retrieve interface list at first
263 * since we need #ifindex -> if_xname match
265 if (getifaddrs(&ifap) != 0)
266 err(EX_OSERR, "getifaddrs");
268 for (ifa = ifap; ifa; ifa = ifa->ifa_next) {
270 if (ifa->ifa_addr->sa_family != AF_LINK)
273 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
274 ifindex = sdl->sdl_index;
276 if (ifindex >= ifmap_size) {
277 size = roundup(ifindex + 1, 32) *
278 sizeof(struct ifmap_entry);
279 if ((ifmap = realloc(ifmap, size)) == NULL)
280 errx(2, "realloc(%d) failed", size);
281 memset(&ifmap[ifmap_size], 0,
283 sizeof(struct ifmap_entry));
285 ifmap_size = roundup(ifindex + 1, 32);
288 if (*ifmap[ifindex].ifname != '\0')
291 strlcpy(ifmap[ifindex].ifname, ifa->ifa_name, IFNAMSIZ);
300 mib[4] = NET_RT_DUMP;
303 if (sysctl(mib, nitems(mib), NULL, &needed, NULL, 0) < 0)
304 err(EX_OSERR, "sysctl: net.route.0.%d.dump.%d estimate", af,
306 if ((buf = malloc(needed)) == NULL)
307 errx(2, "malloc(%lu)", (unsigned long)needed);
308 if (sysctl(mib, nitems(mib), buf, &needed, NULL, 0) < 0)
309 err(1, "sysctl: net.route.0.%d.dump.%d", af, fibnum);
311 xo_open_container("route-table");
312 xo_open_list("rt-family");
313 for (next = buf; next < lim; next += rtm->rtm_msglen) {
314 rtm = (struct rt_msghdr *)next;
315 if (rtm->rtm_version != RTM_VERSION)
318 * Peek inside header to determine AF
320 sa = (struct sockaddr *)(rtm + 1);
321 /* Only print family first time. */
322 if (fam != sa->sa_family) {
323 if (need_table_close) {
324 xo_close_list("rt-entry");
325 xo_close_instance("rt-family");
327 need_table_close = true;
330 wid_dst = WID_DST_DEFAULT(fam);
331 wid_gw = WID_GW_DEFAULT(fam);
335 wid_if = WID_IF_DEFAULT(fam);
337 xo_open_instance("rt-family");
339 xo_open_list("rt-entry");
343 p_rtentry_sysctl("rt-entry", rtm);
345 if (need_table_close) {
346 xo_close_list("rt-entry");
347 xo_close_instance("rt-family");
349 xo_close_list("rt-family");
350 xo_close_container("route-table");
355 p_rtentry_sysctl(const char *name, struct rt_msghdr *rtm)
357 struct sockaddr *sa, *addr[RTAX_MAX];
359 char prettyname[128];
362 xo_open_instance(name);
363 sa = (struct sockaddr *)(rtm + 1);
364 for (i = 0; i < RTAX_MAX; i++) {
365 if (rtm->rtm_addrs & (1 << i)) {
367 sa = (struct sockaddr *)((char *)sa + SA_SIZE(sa));
371 protrusion = p_sockaddr("destination", addr[RTAX_DST],
373 rtm->rtm_flags, wid_dst);
374 protrusion = p_sockaddr("gateway", addr[RTAX_GATEWAY], NULL, RTF_HOST,
375 wid_gw - protrusion);
376 snprintf(buffer, sizeof(buffer), "{[:-%d}{:flags/%%s}{]:} ",
377 wid_flags - protrusion);
378 p_flags(rtm->rtm_flags, buffer);
380 xo_emit("{t:use/%*lu} ", wid_pksent, rtm->rtm_rmx.rmx_pksent);
382 if (rtm->rtm_rmx.rmx_mtu != 0)
383 xo_emit("{t:mtu/%*lu} ", wid_mtu, rtm->rtm_rmx.rmx_mtu);
385 xo_emit("{P:/%*s} ", wid_mtu, "");
388 memset(prettyname, 0, sizeof(prettyname));
389 if (rtm->rtm_index < ifmap_size) {
390 strlcpy(prettyname, ifmap[rtm->rtm_index].ifname,
392 if (*prettyname == '\0')
393 strlcpy(prettyname, "---", sizeof(prettyname));
397 xo_emit("{t:interface-name/%*s}", wid_if, prettyname);
399 xo_emit("{t:interface-name/%*.*s}", wid_if, wid_if,
401 if (rtm->rtm_rmx.rmx_expire) {
404 if ((expire_time = rtm->rtm_rmx.rmx_expire - uptime.tv_sec) > 0)
405 xo_emit(" {:expire-time/%*d}", wid_expire,
410 xo_close_instance(name);
414 p_sockaddr(const char *name, struct sockaddr *sa, struct sockaddr *mask,
415 int flags, int width)
421 cp = fmt_sockaddr(sa, mask, flags);
424 snprintf(buf, sizeof(buf), "{:%s/%%s} ", name);
428 if (Wflag != 0 || numeric_addr) {
429 snprintf(buf, sizeof(buf), "{[:%d}{:%s/%%s}{]:} ",
432 protrusion = strlen(cp) - width;
436 snprintf(buf, sizeof(buf), "{[:%d}{:%s/%%-.*s}{]:} ",
438 xo_emit(buf, width, cp);
446 fmt_sockaddr(struct sockaddr *sa, struct sockaddr *mask, int flags)
448 static char buf[128];
454 switch(sa->sa_family) {
458 * The sa6->sin6_scope_id must be filled here because
459 * this sockaddr is extracted from kmem(4) directly
460 * and has KAME-specific embedded scope id in
461 * sa6->sin6_addr.s6_addr[2].
463 in6_fillscopeid(satosin6(sa));
467 if (flags & RTF_HOST)
468 cp = routename(sa, numeric_addr);
470 cp = netname(sa, mask);
472 cp = netname(sa, NULL);
476 strlcpy(buf, ((struct sockaddr_ng *)sa)->sg_data,
484 struct sockaddr_dl *sdl = (struct sockaddr_dl *)sa;
486 /* Interface route. */
491 cp = routename(sa, 1);
496 u_char *s = (u_char *)sa->sa_data, *slim;
500 slim = sa->sa_len + (u_char *) sa;
501 cqlim = cq + sizeof(buf) - sizeof(" ffff");
502 snprintf(cq, sizeof(buf), "(%d)", sa->sa_family);
504 while (s < slim && cq < cqlim) {
505 snprintf(cq, sizeof(" ff"), " %02x", *s++);
508 snprintf(cq, sizeof("ff"), "%02x", *s++);
520 p_flags(int f, const char *format)
524 xo_emit(format, fmt_flags(f));
526 xo_open_list("flags_pretty");
527 for (p = bits; p->b_mask; p++)
529 xo_emit("{le:flags_pretty/%s}", p->b_name);
530 xo_close_list("flags_pretty");
536 static char name[33];
538 struct bits *p = bits;
540 for (flags = name; p->b_mask; p++)
548 routename(struct sockaddr *sa, int flags)
550 static char line[NI_MAXHOST];
553 f = (flags) ? NI_NUMERICHOST : 0;
554 error = getnameinfo(sa, sa->sa_len, line, sizeof(line),
558 switch (sa->sa_family) {
561 src = &satosin(sa)->sin_addr;
566 src = &satosin6(sa)->sin6_addr;
572 inet_ntop(sa->sa_family, src, line, sizeof(line) - 1);
575 trimdomain(line, strlen(line));
580 #define NSHIFT(m) ( \
581 (m) == IN_CLASSA_NET ? IN_CLASSA_NSHIFT : \
582 (m) == IN_CLASSB_NET ? IN_CLASSB_NSHIFT : \
583 (m) == IN_CLASSC_NET ? IN_CLASSC_NSHIFT : \
587 domask(char *dst, size_t buflen, u_long mask)
596 for (b = 0; b < 32; b++)
597 if (mask & (1 << b)) {
601 for (bb = b+1; bb < 32; bb++)
602 if (!(mask & (1 << bb))) {
603 i = -1; /* noncontig */
609 snprintf(dst, buflen, "&0x%lx", mask);
611 snprintf(dst, buflen, "/%d", 32-i);
615 * Return the name of the network whose address is given.
618 netname(struct sockaddr *sa, struct sockaddr *mask)
620 switch (sa->sa_family) {
623 return (netname4(satosin(sa)->sin_addr.s_addr,
624 satosin(mask)->sin_addr.s_addr));
626 return (netname4(satosin(sa)->sin_addr.s_addr,
631 return (netname6(satosin6(sa), satosin6(mask)));
639 netname4(in_addr_t in, in_addr_t mask)
642 static char line[MAXHOSTNAMELEN + sizeof("&0xffffffff")];
643 char nline[INET_ADDRSTRLEN];
644 struct netent *np = 0;
647 if (in == INADDR_ANY && mask == 0) {
648 strlcpy(line, "default", sizeof(line));
652 /* It is ok to supply host address. */
656 if (!numeric_addr && i) {
657 np = getnetbyaddr(i >> NSHIFT(ntohl(mask)), AF_INET);
660 trimdomain(cp, strlen(cp));
664 strlcpy(line, cp, sizeof(line));
666 inet_ntop(AF_INET, &in, nline, sizeof(nline));
667 strlcpy(line, nline, sizeof(line));
668 domask(line + strlen(line), sizeof(line) - strlen(line), ntohl(mask));
678 in6_fillscopeid(struct sockaddr_in6 *sa6)
680 #if defined(__KAME__)
682 * XXX: This is a special workaround for KAME kernels.
683 * sin6_scope_id field of SA should be set in the future.
685 if (IN6_IS_ADDR_LINKLOCAL(&sa6->sin6_addr) ||
686 IN6_IS_ADDR_MC_NODELOCAL(&sa6->sin6_addr) ||
687 IN6_IS_ADDR_MC_LINKLOCAL(&sa6->sin6_addr)) {
688 if (sa6->sin6_scope_id == 0)
690 ntohs(*(u_int16_t *)&sa6->sin6_addr.s6_addr[2]);
691 sa6->sin6_addr.s6_addr[2] = sa6->sin6_addr.s6_addr[3] = 0;
696 /* Mask to length table. To check an invalid value, (length + 1) is used. */
697 static const u_char masktolen[256] = {
710 netname6(struct sockaddr_in6 *sa6, struct sockaddr_in6 *mask)
712 static char line[NI_MAXHOST + sizeof("/xxx") - 1];
713 struct sockaddr_in6 addr;
714 char nline[NI_MAXHOST];
715 char maskbuf[sizeof("/xxx")];
719 bool illegal = false;
722 p = (u_char *)&mask->sin6_addr;
723 for (masklen = 0, lim = p + 16; p < lim; p++) {
724 if (masktolen[*p] > 0) {
725 /* -1 is required. */
726 masklen += (masktolen[*p] - 1);
731 xo_error("illegal prefixlen\n");
733 memcpy(&addr, sa6, sizeof(addr));
734 for (i = 0; i < 16; ++i)
735 addr.sin6_addr.s6_addr[i] &=
736 mask->sin6_addr.s6_addr[i];
742 if (masklen == 0 && IN6_IS_ADDR_UNSPECIFIED(&sa6->sin6_addr))
745 getnameinfo((struct sockaddr *)sa6, sa6->sin6_len, nline, sizeof(nline),
746 NULL, 0, NI_NUMERICHOST);
748 strlcpy(line, nline, sizeof(line));
750 getnameinfo((struct sockaddr *)sa6, sa6->sin6_len, line,
751 sizeof(line), NULL, 0, 0);
752 if (numeric_addr || strcmp(line, nline) == 0) {
753 snprintf(maskbuf, sizeof(maskbuf), "/%d", masklen);
754 strlcat(line, maskbuf, sizeof(line));
762 * Print routing statistics
767 struct rtstat rtstat;
768 u_long rtsaddr, rttaddr;
771 if ((rtsaddr = nl[N_RTSTAT].n_value) == 0) {
772 xo_emit("{W:rtstat: symbol not in namelist}\n");
775 if ((rttaddr = nl[N_RTTRASH].n_value) == 0) {
776 xo_emit("{W:rttrash: symbol not in namelist}\n");
779 kread(rtsaddr, (char *)&rtstat, sizeof (rtstat));
780 kread(rttaddr, (char *)&rttrash, sizeof (rttrash));
781 xo_emit("{T:routing}:\n");
783 #define p(f, m) if (rtstat.f || sflag <= 1) \
784 xo_emit(m, rtstat.f, plural(rtstat.f))
786 p(rts_badredirect, "\t{:bad-redirects/%hu} "
787 "{N:/bad routing redirect%s}\n");
788 p(rts_dynamic, "\t{:dynamically-created/%hu} "
789 "{N:/dynamically created route%s}\n");
790 p(rts_newgateway, "\t{:new-gateways/%hu} "
791 "{N:/new gateway%s due to redirects}\n");
792 p(rts_unreach, "\t{:unreachable-destination/%hu} "
793 "{N:/destination%s found unreachable}\n");
794 p(rts_wildcard, "\t{:wildcard-uses/%hu} "
795 "{N:/use%s of a wildcard route}\n");
798 if (rttrash || sflag <= 1)
799 xo_emit("\t{:unused-but-not-freed/%u} "
800 "{N:/route%s not in table but not freed}\n",
801 rttrash, plural(rttrash));