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
32 #include <sys/cdefs.h>
33 #include <sys/param.h>
34 #include <sys/protosw.h>
35 #include <sys/socket.h>
36 #include <sys/socketvar.h>
37 #include <sys/sysctl.h>
40 #include <net/ethernet.h>
42 #include <net/if_dl.h>
43 #include <net/if_types.h>
44 #include <net/route.h>
45 #include <net/route/nhop.h>
47 #include <netinet/in.h>
48 #include <netgraph/ng_socket.h>
50 #include <arpa/inet.h>
67 /* column widths; each followed by one space */
69 #define WID_DST_DEFAULT(af) 18 /* width of destination column */
70 #define WID_GW_DEFAULT(af) 18 /* width of gateway column */
71 #define WID_IF_DEFAULT(af) (Wflag ? 10 : 8) /* width of netif column */
73 #define WID_DST_DEFAULT(af) \
74 ((af) == AF_INET6 ? (numeric_addr ? 33: 18) : 18)
75 #define WID_GW_DEFAULT(af) \
76 ((af) == AF_INET6 ? (numeric_addr ? 29 : 18) : 18)
77 #define WID_IF_DEFAULT(af) ((af) == AF_INET6 ? 8 : (Wflag ? 10 : 8))
82 static int wid_pksent;
86 static int wid_nhtype;
87 static int wid_refcnt;
88 static int wid_prepend;
90 static struct bits nh_bits[] = {
91 { NHF_REJECT, 'R', "reject" },
92 { NHF_BLACKHOLE,'B', "blackhole" },
93 { NHF_REDIRECT, 'r', "redirect" },
94 { NHF_GATEWAY, 'G', "gateway" },
95 { NHF_DEFAULT, 'd', "default" },
96 { NHF_BROADCAST,'b', "broadcast" },
100 static char *nh_types[] = {
102 "v4/resolve", /* 1 */
110 char ifname[IFNAMSIZ];
114 struct nhop_entry *ptr;
117 static struct nhop_map global_nhop_map;
119 static struct nhop_entry *nhop_get(struct nhop_map *map, uint32_t idx);
122 static struct ifmap_entry *ifmap;
123 static size_t ifmap_size;
126 print_sockaddr_buf(char *buf, size_t bufsize, const struct sockaddr *sa)
129 switch (sa->sa_family) {
131 inet_ntop(AF_INET, &((struct sockaddr_in *)sa)->sin_addr,
135 inet_ntop(AF_INET6, &((struct sockaddr_in6 *)sa)->sin6_addr,
139 snprintf(buf, bufsize, "unknown:%d", sa->sa_family);
145 print_addr(const char *name, const char *addr, int width)
151 snprintf(buf, sizeof(buf), "{:%s/%%s} ", name);
155 if (Wflag != 0 || numeric_addr) {
156 snprintf(buf, sizeof(buf), "{[:%d}{:%s/%%s}{]:} ",
159 protrusion = strlen(addr) - width;
163 snprintf(buf, sizeof(buf), "{[:%d}{:%s/%%-.*s}{]:} ",
165 xo_emit(buf, width, addr);
174 print_nhop_header(int af1 __unused)
178 xo_emit("{T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%*.*s} "
179 "{T:/%*.*s} {T:/%-*.*s} {T:/%*.*s} {T:/%*.*s} {T:/%*.*s} {T:/%*s}\n",
180 wid_nhidx, wid_nhidx, "Idx",
181 wid_nhtype, wid_nhtype, "Type",
182 wid_dst, wid_dst, "IFA",
183 wid_gw, wid_gw, "Gateway",
184 wid_flags, wid_flags, "Flags",
185 wid_pksent, wid_pksent, "Use",
186 wid_mtu, wid_mtu, "Mtu",
187 wid_if, wid_if, "Netif",
188 wid_if, wid_if, "Addrif",
189 wid_refcnt, wid_refcnt, "Refcnt",
190 wid_prepend, "Prepend");
192 xo_emit("{T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%-*.*s} {T:/%*.*s} "
194 wid_nhidx, wid_nhidx, "Idx",
195 wid_dst, wid_dst, "IFA",
196 wid_gw, wid_gw, "Gateway",
197 wid_flags, wid_flags, "Flags",
198 wid_if, wid_if, "Netif",
199 wid_prepend, "Refcnt");
204 nhop_map_update(struct nhop_map *map, uint32_t idx, char *gw, char *ifname)
206 if (idx >= map->size) {
212 new_size = map->size * 2;
214 new_size = roundup2(idx + 1, 32);
216 sz = new_size * (sizeof(struct nhop_entry));
217 if ((map->ptr = realloc(map->ptr, sz)) == NULL)
218 errx(2, "realloc(%zu) failed", sz);
220 memset(&map->ptr[map->size], 0, (new_size - map->size) * sizeof(struct nhop_entry));
221 map->size = new_size;
224 strlcpy(map->ptr[idx].ifname, ifname, sizeof(map->ptr[idx].ifname));
225 strlcpy(map->ptr[idx].gw, gw, sizeof(map->ptr[idx].gw));
228 static struct nhop_entry *
229 nhop_get(struct nhop_map *map, uint32_t idx)
232 if (idx >= map->size)
234 if (*map->ptr[idx].ifname == '\0')
236 return &map->ptr[idx];
240 print_nhop_entry_sysctl(const char *name, struct rt_msghdr *rtm, struct nhop_external *nh)
243 char iface_name[128];
246 struct nhop_addrs *na;
247 struct sockaddr *sa_gw, *sa_ifa;
249 xo_open_instance(name);
251 snprintf(buffer, sizeof(buffer), "{[:-%d}{:index/%%lu}{]:} ", wid_nhidx);
252 //xo_emit("{t:index/%-lu} ", wid_nhidx, nh->nh_idx);
253 xo_emit(buffer, nh->nh_idx);
256 char *cp = nh_types[nh->nh_type];
257 xo_emit("{t:type_str/%*s} ", wid_nhtype, cp);
259 memset(iface_name, 0, sizeof(iface_name));
260 if (nh->ifindex < (uint32_t)ifmap_size) {
261 strlcpy(iface_name, ifmap[nh->ifindex].ifname,
263 if (*iface_name == '\0')
264 strlcpy(iface_name, "---", sizeof(iface_name));
267 na = (struct nhop_addrs *)((char *)nh + nh->nh_len);
268 //inet_ntop(nh->nh_family, &nh->nh_src, src_addr, sizeof(src_addr));
269 //protrusion = p_addr("ifa", src_addr, wid_dst);
270 sa_gw = (struct sockaddr *)((char *)na + na->gw_sa_off);
271 sa_ifa = (struct sockaddr *)((char *)na + na->src_sa_off);
272 protrusion = p_sockaddr("ifa", sa_ifa, NULL, RTF_HOST, wid_dst);
274 if (nh->nh_flags & NHF_GATEWAY) {
276 cp = fmt_sockaddr(sa_gw, NULL, RTF_HOST);
277 strlcpy(gw_addr, cp, sizeof(gw_addr));
279 snprintf(gw_addr, sizeof(gw_addr), "%s/resolve", iface_name);
280 protrusion = print_addr("gateway", gw_addr, wid_dst - protrusion);
282 nhop_map_update(&global_nhop_map, nh->nh_idx, gw_addr, iface_name);
284 snprintf(buffer, sizeof(buffer), "{[:-%d}{:flags/%%s}{]:} ",
285 wid_flags - protrusion);
287 //p_nhflags(nh->nh_flags, buffer);
288 print_flags_generic(rtm->rtm_flags, rt_bits, buffer, "rt_flags_pretty");
291 xo_emit("{t:use/%*lu} ", wid_pksent, nh->nh_pksent);
292 xo_emit("{t:mtu/%*lu} ", wid_mtu, nh->nh_mtu);
294 //printf("IDX: %d IFACE: %s FAMILY: %d TYPE: %d FLAGS: %X GW \n");
297 xo_emit("{t:interface-name/%*s}", wid_if, iface_name);
299 xo_emit("{t:interface-name/%*.*s}", wid_if, wid_if, iface_name);
301 memset(iface_name, 0, sizeof(iface_name));
302 if (nh->aifindex < (uint32_t)ifmap_size && nh->ifindex != nh->aifindex) {
303 strlcpy(iface_name, ifmap[nh->aifindex].ifname,
305 if (*iface_name == '\0')
306 strlcpy(iface_name, "---", sizeof(iface_name));
309 xo_emit("{t:address-interface-name/%*s}", wid_if, iface_name);
311 xo_emit("{t:refcount/%*lu} ", wid_refcnt, nh->nh_refcount);
312 if (Wflag && nh->prepend_len) {
313 int max_bytes = MIN(nh->prepend_len, sizeof(buffer) / 2 - 1);
314 for (int i = 0; i < max_bytes; i++)
315 snprintf(&buffer[i * 2], 3, "%02X", nh->nh_prepend[i]);
316 xo_emit(" {:nhop-prepend/%*s}", wid_prepend, buffer);
320 xo_close_instance(name);
324 cmp_nh_idx(const void *_a, const void *_b)
326 const struct nhops_map *a, *b;
333 else if (a->idx < b->idx)
339 dump_nhops_sysctl(int fibnum, int af, struct nhops_dump *nd)
343 char *buf, *next, *lim;
344 struct rt_msghdr *rtm;
345 struct nhop_external *nh;
346 struct nhops_map *nh_map;
347 size_t nh_count, nh_size;
353 mib[4] = NET_RT_NHOP;
356 if (sysctl(mib, nitems(mib), NULL, &needed, NULL, 0) < 0)
357 err(EX_OSERR, "sysctl: net.route.0.%d.nhdump.%d estimate", af,
359 if ((buf = malloc(needed)) == NULL)
360 errx(2, "malloc(%lu)", (unsigned long)needed);
361 if (sysctl(mib, nitems(mib), buf, &needed, NULL, 0) < 0)
362 err(1, "sysctl: net.route.0.%d.nhdump.%d", af, fibnum);
366 * nexhops are received unsorted. Collect everything first, sort and then display
371 nh_map = calloc(nh_size, sizeof(struct nhops_map));
372 for (next = buf; next < lim; next += rtm->rtm_msglen) {
373 rtm = (struct rt_msghdr *)next;
374 if (rtm->rtm_version != RTM_VERSION)
377 if (nh_count >= nh_size) {
379 nh_map = realloc(nh_map, nh_size * sizeof(struct nhops_map));
382 nh = (struct nhop_external *)(rtm + 1);
383 nh_map[nh_count].idx = nh->nh_idx;
384 nh_map[nh_count].rtm = rtm;
389 qsort(nh_map, nh_count, sizeof(struct nhops_map), cmp_nh_idx);
391 nd->nh_count = nh_count;
396 print_nhops_sysctl(int fibnum, int af)
398 struct nhops_dump nd;
399 struct nhop_external *nh;
401 struct rt_msghdr *rtm;
403 dump_nhops_sysctl(fibnum, af, &nd);
405 xo_open_container("nhop-table");
406 xo_open_list("rt-family");
407 if (nd.nh_count > 0) {
408 nh = (struct nhop_external *)(nd.nh_map[0].rtm + 1);
411 wid_dst = WID_GW_DEFAULT(fam);
412 wid_gw = WID_GW_DEFAULT(fam);
419 wid_if = WID_IF_DEFAULT(fam);
420 xo_open_instance("rt-family");
422 xo_open_list("nh-entry");
424 print_nhop_header(fam);
426 for (size_t i = 0; i < nd.nh_count; i++) {
427 rtm = nd.nh_map[i].rtm;
428 nh = (struct nhop_external *)(rtm + 1);
429 print_nhop_entry_sysctl("nh-entry", rtm, nh);
432 xo_close_list("nh-entry");
433 xo_close_instance("rt-family");
435 xo_close_list("rt-family");
436 xo_close_container("nhop-table");
441 p_nhflags(int f, const char *format)
444 char *pretty_name = "nh_flags_pretty";
446 xo_emit(format, fmt_flags(nh_bits, f));
448 xo_open_list(pretty_name);
449 for (p = nh_bits; p->b_mask; p++)
451 xo_emit("{le:nh_flags_pretty/%s}", p->b_name);
452 xo_close_list(pretty_name);
456 nhops_print(int fibnum, int af)
461 intsize = sizeof(int);
463 sysctlbyname("net.my_fibnum", &fibnum, &intsize, NULL, 0) == -1)
465 if (sysctlbyname("net.fibs", &numfibs, &intsize, NULL, 0) == -1)
467 if (fibnum < 0 || fibnum > numfibs - 1)
468 errx(EX_USAGE, "%d: invalid fib", fibnum);
470 ifmap = prepare_ifmap(&ifmap_size);
472 xo_open_container("route-nhop-information");
473 xo_emit("{T:Nexthop data}");
475 xo_emit(" ({L:fib}: {:fib/%d})", fibnum);
477 print_nhops_sysctl(fibnum, af);
478 xo_close_container("route-nhop-information");