2 * Copyright (c) 1983, 1988, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 static char sccsid[] = "From: @(#)route.c 8.6 (Berkeley) 4/28/95";
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include <sys/param.h>
40 #include <sys/protosw.h>
41 #include <sys/socket.h>
42 #include <sys/socketvar.h>
43 #include <sys/sysctl.h>
46 #include <net/ethernet.h>
48 #include <net/if_dl.h>
49 #include <net/if_types.h>
50 #include <net/route.h>
52 #include <netinet/in.h>
53 #include <netgraph/ng_socket.h>
55 #include <arpa/inet.h>
73 * Definitions for showing gateway flags.
80 { RTF_UP, 'U', "up" },
81 { RTF_GATEWAY, 'G', "gateway" },
82 { RTF_HOST, 'H', "host" },
83 { RTF_REJECT, 'R', "reject" },
84 { RTF_DYNAMIC, 'D', "dynamic" },
85 { RTF_MODIFIED, 'M', "modified" },
86 { RTF_DONE, 'd', "done" }, /* Completed -- for routing msgs only */
87 { RTF_XRESOLVE, 'X', "xresolve" },
88 { RTF_STATIC, 'S', "static" },
89 { RTF_PROTO1, '1', "proto1" },
90 { RTF_PROTO2, '2', "proto2" },
91 { RTF_PROTO3, '3', "proto3" },
92 { RTF_BLACKHOLE,'B', "blackhole" },
93 { RTF_BROADCAST,'b', "broadcast" },
95 { RTF_LLINFO, 'L', "llinfo" },
101 char ifname[IFNAMSIZ];
103 static struct ifmap_entry *ifmap;
104 static int ifmap_size;
105 static struct timespec uptime;
107 static const char *netname4(in_addr_t, in_addr_t);
108 static const char *netname6(struct sockaddr_in6 *, struct sockaddr_in6 *);
109 static void p_rtable_sysctl(int, int);
110 static void p_rtentry_sysctl(const char *name, struct rt_msghdr *);
111 static int p_sockaddr(const char *name, struct sockaddr *, struct sockaddr *,
113 static const char *fmt_sockaddr(struct sockaddr *sa, struct sockaddr *mask,
115 static void p_flags(int, const char *);
116 static const char *fmt_flags(int f);
117 static void domask(char *, size_t, u_long);
121 * Print routing tables.
124 routepr(int fibnum, int af)
132 intsize = sizeof(int);
134 sysctlbyname("net.my_fibnum", &fibnum, &intsize, NULL, 0) == -1)
136 if (sysctlbyname("net.fibs", &numfibs, &intsize, NULL, 0) == -1)
138 if (fibnum < 0 || fibnum > numfibs - 1)
139 errx(EX_USAGE, "%d: invalid fib", fibnum);
141 * Since kernel & userland use different timebase
142 * (time_uptime vs time_second) and we are reading kernel memory
143 * directly we should do rt_expire --> expire_time conversion.
145 if (clock_gettime(CLOCK_UPTIME, &uptime) < 0)
146 err(EX_OSERR, "clock_gettime() failed");
148 xo_open_container("route-information");
149 xo_emit("{T:Routing tables}");
151 xo_emit(" ({L:fib}: {:fib/%d})", fibnum);
153 p_rtable_sysctl(fibnum, af);
154 xo_close_container("route-information");
159 * Print address family header before a section of the routing table.
172 afname = "Internet6";
189 xo_emit("\n{k:address-family/%s}:\n", afname);
191 xo_emit("\n{L:Protocol Family} {k:address-family/%d}:\n", af1);
194 /* column widths; each followed by one space */
196 #define WID_DST_DEFAULT(af) 18 /* width of destination column */
197 #define WID_GW_DEFAULT(af) 18 /* width of gateway column */
198 #define WID_IF_DEFAULT(af) (Wflag ? 10 : 8) /* width of netif column */
200 #define WID_DST_DEFAULT(af) \
201 ((af) == AF_INET6 ? (numeric_addr ? 33: 18) : 18)
202 #define WID_GW_DEFAULT(af) \
203 ((af) == AF_INET6 ? (numeric_addr ? 29 : 18) : 18)
204 #define WID_IF_DEFAULT(af) ((af) == AF_INET6 ? 8 : (Wflag ? 10 : 8))
209 static int wid_flags;
210 static int wid_pksent;
213 static int wid_expire;
216 * Print header for routing table columns.
219 pr_rthdr(int af1 __unused)
223 xo_emit("{T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%*.*s} "
224 "{T:/%*.*s} {T:/%*.*s} {T:/%*s}\n",
225 wid_dst, wid_dst, "Destination",
226 wid_gw, wid_gw, "Gateway",
227 wid_flags, wid_flags, "Flags",
228 wid_pksent, wid_pksent, "Use",
229 wid_mtu, wid_mtu, "Mtu",
230 wid_if, wid_if, "Netif",
231 wid_expire, "Expire");
233 xo_emit("{T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%*.*s} "
235 wid_dst, wid_dst, "Destination",
236 wid_gw, wid_gw, "Gateway",
237 wid_flags, wid_flags, "Flags",
238 wid_if, wid_if, "Netif",
239 wid_expire, "Expire");
244 p_rtable_sysctl(int fibnum, int af)
248 char *buf, *next, *lim;
249 struct rt_msghdr *rtm;
251 int fam = AF_UNSPEC, ifindex = 0, size;
252 int need_table_close = false;
254 struct ifaddrs *ifap, *ifa;
255 struct sockaddr_dl *sdl;
258 * Retrieve interface list at first
259 * since we need #ifindex -> if_xname match
261 if (getifaddrs(&ifap) != 0)
262 err(EX_OSERR, "getifaddrs");
264 for (ifa = ifap; ifa; ifa = ifa->ifa_next) {
266 if (ifa->ifa_addr->sa_family != AF_LINK)
269 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
270 ifindex = sdl->sdl_index;
272 if (ifindex >= ifmap_size) {
273 size = roundup(ifindex + 1, 32) *
274 sizeof(struct ifmap_entry);
275 if ((ifmap = realloc(ifmap, size)) == NULL)
276 errx(2, "realloc(%d) failed", size);
277 memset(&ifmap[ifmap_size], 0,
279 sizeof(struct ifmap_entry));
281 ifmap_size = roundup(ifindex + 1, 32);
284 if (*ifmap[ifindex].ifname != '\0')
287 strlcpy(ifmap[ifindex].ifname, ifa->ifa_name, IFNAMSIZ);
296 mib[4] = NET_RT_DUMP;
299 if (sysctl(mib, nitems(mib), NULL, &needed, NULL, 0) < 0)
300 err(EX_OSERR, "sysctl: net.route.0.%d.dump.%d estimate", af,
302 if ((buf = malloc(needed)) == NULL)
303 errx(2, "malloc(%lu)", (unsigned long)needed);
304 if (sysctl(mib, nitems(mib), buf, &needed, NULL, 0) < 0)
305 err(1, "sysctl: net.route.0.%d.dump.%d", af, fibnum);
307 xo_open_container("route-table");
308 xo_open_list("rt-family");
309 for (next = buf; next < lim; next += rtm->rtm_msglen) {
310 rtm = (struct rt_msghdr *)next;
311 if (rtm->rtm_version != RTM_VERSION)
314 * Peek inside header to determine AF
316 sa = (struct sockaddr *)(rtm + 1);
317 /* Only print family first time. */
318 if (fam != sa->sa_family) {
319 if (need_table_close) {
320 xo_close_list("rt-entry");
321 xo_close_instance("rt-family");
323 need_table_close = true;
326 wid_dst = WID_DST_DEFAULT(fam);
327 wid_gw = WID_GW_DEFAULT(fam);
331 wid_if = WID_IF_DEFAULT(fam);
333 xo_open_instance("rt-family");
335 xo_open_list("rt-entry");
339 p_rtentry_sysctl("rt-entry", rtm);
341 if (need_table_close) {
342 xo_close_list("rt-entry");
343 xo_close_instance("rt-family");
345 xo_close_list("rt-family");
346 xo_close_container("route-table");
351 p_rtentry_sysctl(const char *name, struct rt_msghdr *rtm)
353 struct sockaddr *sa, *addr[RTAX_MAX];
355 char prettyname[128];
358 xo_open_instance(name);
359 sa = (struct sockaddr *)(rtm + 1);
360 for (i = 0; i < RTAX_MAX; i++) {
361 if (rtm->rtm_addrs & (1 << i))
363 sa = (struct sockaddr *)((char *)sa + SA_SIZE(sa));
366 protrusion = p_sockaddr("destination", addr[RTAX_DST],
368 rtm->rtm_flags, wid_dst);
369 protrusion = p_sockaddr("gateway", addr[RTAX_GATEWAY], NULL, RTF_HOST,
370 wid_gw - protrusion);
371 snprintf(buffer, sizeof(buffer), "{[:-%d}{:flags/%%s}{]:} ",
372 wid_flags - protrusion);
373 p_flags(rtm->rtm_flags, buffer);
375 xo_emit("{t:use/%*lu} ", wid_pksent, rtm->rtm_rmx.rmx_pksent);
377 if (rtm->rtm_rmx.rmx_mtu != 0)
378 xo_emit("{t:mtu/%*lu} ", wid_mtu, rtm->rtm_rmx.rmx_mtu);
380 xo_emit("{P:/%*s} ", wid_mtu, "");
383 memset(prettyname, 0, sizeof(prettyname));
384 if (rtm->rtm_index < ifmap_size) {
385 strlcpy(prettyname, ifmap[rtm->rtm_index].ifname,
387 if (*prettyname == '\0')
388 strlcpy(prettyname, "---", sizeof(prettyname));
392 xo_emit("{t:interface-name/%*s}", wid_if, prettyname);
394 xo_emit("{t:interface-name/%*.*s}", wid_if, wid_if,
396 if (rtm->rtm_rmx.rmx_expire) {
399 if ((expire_time = rtm->rtm_rmx.rmx_expire - uptime.tv_sec) > 0)
400 xo_emit(" {:expire-time/%*d}", wid_expire,
405 xo_close_instance(name);
409 p_sockaddr(const char *name, struct sockaddr *sa, struct sockaddr *mask,
410 int flags, int width)
416 cp = fmt_sockaddr(sa, mask, flags);
419 snprintf(buf, sizeof(buf), "{:%s/%%s} ", name);
423 if (Wflag != 0 || numeric_addr) {
424 snprintf(buf, sizeof(buf), "{[:%d}{:%s/%%s}{]:} ",
427 protrusion = strlen(cp) - width;
431 snprintf(buf, sizeof(buf), "{[:%d}{:%s/%%-.*s}{]:} ",
433 xo_emit(buf, width, cp);
441 fmt_sockaddr(struct sockaddr *sa, struct sockaddr *mask, int flags)
443 static char buf[128];
449 switch(sa->sa_family) {
453 * The sa6->sin6_scope_id must be filled here because
454 * this sockaddr is extracted from kmem(4) directly
455 * and has KAME-specific embedded scope id in
456 * sa6->sin6_addr.s6_addr[2].
458 in6_fillscopeid(satosin6(sa));
462 if (flags & RTF_HOST)
463 cp = routename(sa, numeric_addr);
465 cp = netname(sa, mask);
467 cp = netname(sa, NULL);
471 strlcpy(buf, ((struct sockaddr_ng *)sa)->sg_data,
479 struct sockaddr_dl *sdl = (struct sockaddr_dl *)sa;
481 /* Interface route. */
486 cp = routename(sa, 1);
491 u_char *s = (u_char *)sa->sa_data, *slim;
495 slim = sa->sa_len + (u_char *) sa;
496 cqlim = cq + sizeof(buf) - sizeof(" ffff");
497 snprintf(cq, sizeof(buf), "(%d)", sa->sa_family);
499 while (s < slim && cq < cqlim) {
500 snprintf(cq, sizeof(" ff"), " %02x", *s++);
503 snprintf(cq, sizeof("ff"), "%02x", *s++);
515 p_flags(int f, const char *format)
519 xo_emit(format, fmt_flags(f));
521 xo_open_list("flags_pretty");
522 for (p = bits; p->b_mask; p++)
524 xo_emit("{le:flags_pretty/%s}", p->b_name);
525 xo_close_list("flags_pretty");
531 static char name[33];
533 struct bits *p = bits;
535 for (flags = name; p->b_mask; p++)
543 routename(struct sockaddr *sa, int flags)
545 static char line[NI_MAXHOST];
548 f = (flags) ? NI_NUMERICHOST : 0;
549 error = getnameinfo(sa, sa->sa_len, line, sizeof(line),
553 switch (sa->sa_family) {
556 src = &satosin(sa)->sin_addr;
561 src = &satosin6(sa)->sin6_addr;
567 inet_ntop(sa->sa_family, src, line, sizeof(line) - 1);
570 trimdomain(line, strlen(line));
575 #define NSHIFT(m) ( \
576 (m) == IN_CLASSA_NET ? IN_CLASSA_NSHIFT : \
577 (m) == IN_CLASSB_NET ? IN_CLASSB_NSHIFT : \
578 (m) == IN_CLASSC_NET ? IN_CLASSC_NSHIFT : \
582 domask(char *dst, size_t buflen, u_long mask)
591 for (b = 0; b < 32; b++)
592 if (mask & (1 << b)) {
596 for (bb = b+1; bb < 32; bb++)
597 if (!(mask & (1 << bb))) {
598 i = -1; /* noncontig */
604 snprintf(dst, buflen, "&0x%lx", mask);
606 snprintf(dst, buflen, "/%d", 32-i);
610 * Return the name of the network whose address is given.
613 netname(struct sockaddr *sa, struct sockaddr *mask)
615 switch (sa->sa_family) {
618 return (netname4(satosin(sa)->sin_addr.s_addr,
619 satosin(mask)->sin_addr.s_addr));
621 return (netname4(satosin(sa)->sin_addr.s_addr,
626 return (netname6(satosin6(sa), satosin6(mask)));
634 netname4(in_addr_t in, in_addr_t mask)
637 static char line[MAXHOSTNAMELEN + sizeof("&0xffffffff")];
638 char nline[INET_ADDRSTRLEN];
639 struct netent *np = 0;
642 if (in == INADDR_ANY && mask == 0) {
643 strlcpy(line, "default", sizeof(line));
647 /* It is ok to supply host address. */
651 if (!numeric_addr && i) {
652 np = getnetbyaddr(i >> NSHIFT(ntohl(mask)), AF_INET);
655 trimdomain(cp, strlen(cp));
659 strlcpy(line, cp, sizeof(line));
661 inet_ntop(AF_INET, &in, nline, sizeof(nline));
662 strlcpy(line, nline, sizeof(line));
663 domask(line + strlen(line), sizeof(line) - strlen(line), ntohl(mask));
673 in6_fillscopeid(struct sockaddr_in6 *sa6)
675 #if defined(__KAME__)
677 * XXX: This is a special workaround for KAME kernels.
678 * sin6_scope_id field of SA should be set in the future.
680 if (IN6_IS_ADDR_LINKLOCAL(&sa6->sin6_addr) ||
681 IN6_IS_ADDR_MC_NODELOCAL(&sa6->sin6_addr) ||
682 IN6_IS_ADDR_MC_LINKLOCAL(&sa6->sin6_addr)) {
683 if (sa6->sin6_scope_id == 0)
685 ntohs(*(u_int16_t *)&sa6->sin6_addr.s6_addr[2]);
686 sa6->sin6_addr.s6_addr[2] = sa6->sin6_addr.s6_addr[3] = 0;
691 /* Mask to length table. To check an invalid value, (length + 1) is used. */
692 static const u_char masktolen[256] = {
705 netname6(struct sockaddr_in6 *sa6, struct sockaddr_in6 *mask)
707 static char line[NI_MAXHOST + sizeof("/xxx") - 1];
708 struct sockaddr_in6 addr;
709 char nline[NI_MAXHOST];
710 char maskbuf[sizeof("/xxx")];
714 bool illegal = false;
717 p = (u_char *)&mask->sin6_addr;
718 for (masklen = 0, lim = p + 16; p < lim; p++) {
719 if (masktolen[*p] > 0) {
720 /* -1 is required. */
721 masklen += (masktolen[*p] - 1);
726 xo_error("illegal prefixlen\n");
728 memcpy(&addr, sa6, sizeof(addr));
729 for (i = 0; i < 16; ++i)
730 addr.sin6_addr.s6_addr[i] &=
731 mask->sin6_addr.s6_addr[i];
737 if (masklen == 0 && IN6_IS_ADDR_UNSPECIFIED(&sa6->sin6_addr))
740 getnameinfo((struct sockaddr *)sa6, sa6->sin6_len, nline, sizeof(nline),
741 NULL, 0, NI_NUMERICHOST);
743 strlcpy(line, nline, sizeof(line));
745 getnameinfo((struct sockaddr *)sa6, sa6->sin6_len, line,
746 sizeof(line), NULL, 0, 0);
747 if (numeric_addr || strcmp(line, nline) == 0) {
748 snprintf(maskbuf, sizeof(maskbuf), "/%d", masklen);
749 strlcat(line, maskbuf, sizeof(line));
757 * Print routing statistics
762 struct rtstat rtstat;
763 u_long rtsaddr, rttaddr;
766 if ((rtsaddr = nl[N_RTSTAT].n_value) == 0) {
767 xo_emit("{W:rtstat: symbol not in namelist}\n");
770 if ((rttaddr = nl[N_RTTRASH].n_value) == 0) {
771 xo_emit("{W:rttrash: symbol not in namelist}\n");
774 kread(rtsaddr, (char *)&rtstat, sizeof (rtstat));
775 kread(rttaddr, (char *)&rttrash, sizeof (rttrash));
776 xo_emit("{T:routing}:\n");
778 #define p(f, m) if (rtstat.f || sflag <= 1) \
779 xo_emit(m, rtstat.f, plural(rtstat.f))
781 p(rts_badredirect, "\t{:bad-redirects/%hu} "
782 "{N:/bad routing redirect%s}\n");
783 p(rts_dynamic, "\t{:dynamically-created/%hu} "
784 "{N:/dynamically created route%s}\n");
785 p(rts_newgateway, "\t{:new-gateways/%hu} "
786 "{N:/new gateway%s due to redirects}\n");
787 p(rts_unreach, "\t{:unreachable-destination/%hu} "
788 "{N:/destination%s found unreachable}\n");
789 p(rts_wildcard, "\t{:wildcard-uses/%hu} "
790 "{N:/use%s of a wildcard route}\n");
793 if (rttrash || sflag <= 1)
794 xo_emit("\t{:unused-but-not-freed/%u} "
795 "{N:/route%s not in table but not freed}\n",
796 rttrash, plural(rttrash));