2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2013 Gleb Smirnoff <glebius@FreeBSD.org>
5 * Copyright (c) 1983, 1988, 1993
6 * The Regents of the University of California. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/param.h>
34 #include <sys/protosw.h>
35 #include <sys/socket.h>
36 #include <sys/socketvar.h>
40 #include <net/if_dl.h>
41 #include <net/if_types.h>
42 #include <net/ethernet.h>
43 #include <netinet/in.h>
44 #include <netinet/in_var.h>
45 #include <arpa/inet.h>
47 #include <net/pfvar.h>
48 #include <net/if_pfsync.h>
70 static void sidewaysintpr(void);
73 static const char* pfsyncacts[] = {
74 /* PFSYNC_ACT_CLR */ "clear all request",
75 /* PFSYNC_ACT_INS_1301 */ "13.1 state insert",
76 /* PFSYNC_ACT_INS_ACK */ "state inserted ack",
77 /* PFSYNC_ACT_UPD_1301 */ "13.1 state update",
78 /* PFSYNC_ACT_UPD_C */ "compressed state update",
79 /* PFSYNC_ACT_UPD_REQ */ "uncompressed state request",
80 /* PFSYNC_ACT_DEL */ "state delete",
81 /* PFSYNC_ACT_DEL_C */ "compressed state delete",
82 /* PFSYNC_ACT_INS_F */ "fragment insert",
83 /* PFSYNC_ACT_DEL_F */ "fragment delete",
84 /* PFSYNC_ACT_BUS */ "bulk update mark",
85 /* PFSYNC_ACT_TDB */ "TDB replay counter update",
86 /* PFSYNC_ACT_EOF */ "end of frame mark",
87 /* PFSYNC_ACT_INS_1400 */ "state insert",
88 /* PFSYNC_ACT_UPD_1400 */ "state update",
91 static const char* pfsyncacts_name[] = {
92 /* PFSYNC_ACT_CLR */ "clear-all-request",
93 /* PFSYNC_ACT_INS_1301 */ "state-insert-1301",
94 /* PFSYNC_ACT_INS_ACK */ "state-inserted-ack",
95 /* PFSYNC_ACT_UPD_1301 */ "state-update-1301",
96 /* PFSYNC_ACT_UPD_C */ "compressed-state-update",
97 /* PFSYNC_ACT_UPD_REQ */ "uncompressed-state-request",
98 /* PFSYNC_ACT_DEL */ "state-delete",
99 /* PFSYNC_ACT_DEL_C */ "compressed-state-delete",
100 /* PFSYNC_ACT_INS_F */ "fragment-insert",
101 /* PFSYNC_ACT_DEL_F */ "fragment-delete",
102 /* PFSYNC_ACT_BUS */ "bulk-update-mark",
103 /* PFSYNC_ACT_TDB */ "TDB-replay-counter-update",
104 /* PFSYNC_ACT_EOF */ "end-of-frame-mark",
105 /* PFSYNC_ACT_INS_1400 */ "state-insert",
106 /* PFSYNC_ACT_UPD_1400 */ "state-update",
110 pfsync_acts_stats(const char *list, const char *desc, uint64_t *a)
115 for (i = 0; i < PFSYNC_ACT_MAX; i++, a++) {
116 if (*a || sflag <= 1) {
117 xo_open_instance(list);
118 xo_emit("\t\t{e:name}{:count/%ju} {N:/%s%s %s}\n",
119 pfsyncacts_name[i], (uintmax_t)(*a),
120 pfsyncacts[i], plural(*a), desc);
121 xo_close_instance(list);
128 * Dump pfsync statistics structure.
131 pfsync_stats(u_long off, const char *name, int af1 __unused, int proto __unused)
133 struct pfsyncstats pfsyncstat;
135 if (fetch_stats("net.pfsync.stats", off, &pfsyncstat,
136 sizeof(pfsyncstat), kread) != 0)
139 xo_emit("{T:/%s}:\n", name);
140 xo_open_container(name);
142 #define p(f, m) if (pfsyncstat.f || sflag <= 1) \
143 xo_emit(m, (uintmax_t)pfsyncstat.f, plural(pfsyncstat.f))
145 p(pfsyncs_ipackets, "\t{:received-inet-packets/%ju} "
146 "{N:/packet%s received (IPv4)}\n");
147 p(pfsyncs_ipackets6, "\t{:received-inet6-packets/%ju} "
148 "{N:/packet%s received (IPv6)}\n");
149 pfsync_acts_stats("input-histogram", "received",
150 &pfsyncstat.pfsyncs_iacts[0]);
151 p(pfsyncs_badif, "\t\t{:dropped-bad-interface/%ju} "
152 "{N:/packet%s discarded for bad interface}\n");
153 p(pfsyncs_badttl, "\t\t{:dropped-bad-ttl/%ju} "
154 "{N:/packet%s discarded for bad ttl}\n");
155 p(pfsyncs_hdrops, "\t\t{:dropped-short-header/%ju} "
156 "{N:/packet%s shorter than header}\n");
157 p(pfsyncs_badver, "\t\t{:dropped-bad-version/%ju} "
158 "{N:/packet%s discarded for bad version}\n");
159 p(pfsyncs_badauth, "\t\t{:dropped-bad-auth/%ju} "
160 "{N:/packet%s discarded for bad HMAC}\n");
161 p(pfsyncs_badact,"\t\t{:dropped-bad-action/%ju} "
162 "{N:/packet%s discarded for bad action}\n");
163 p(pfsyncs_badlen, "\t\t{:dropped-short/%ju} "
164 "{N:/packet%s discarded for short packet}\n");
165 p(pfsyncs_badval, "\t\t{:dropped-bad-values/%ju} "
166 "{N:/state%s discarded for bad values}\n");
167 p(pfsyncs_stale, "\t\t{:dropped-stale-state/%ju} "
168 "{N:/stale state%s}\n");
169 p(pfsyncs_badstate, "\t\t{:dropped-failed-lookup/%ju} "
170 "{N:/failed state lookup\\/insert%s}\n");
171 p(pfsyncs_opackets, "\t{:sent-inet-packets/%ju} "
172 "{N:/packet%s sent (IPv4})\n");
173 p(pfsyncs_opackets6, "\t{:send-inet6-packets/%ju} "
174 "{N:/packet%s sent (IPv6})\n");
175 pfsync_acts_stats("output-histogram", "sent",
176 &pfsyncstat.pfsyncs_oacts[0]);
177 p(pfsyncs_onomem, "\t\t{:discarded-no-memory/%ju} "
178 "{N:/failure%s due to mbuf memory error}\n");
179 p(pfsyncs_oerrors, "\t\t{:send-errors/%ju} "
180 "{N:/send error%s}\n");
182 xo_close_container(name);
187 * Display a formatted value, or a '-' in the same space.
190 show_stat(const char *fmt, int width, const char *name,
191 u_long value, short showvalue, int div1000)
193 const char *lsep, *rsep;
197 if (strncmp(fmt, "LS", 2) == 0) {
202 if (strncmp(fmt, "NRS", 3) == 0) {
206 if (showvalue == 0) {
207 /* Print just dash. */
208 xo_emit("{P:/%s}{D:/%*s}{P:/%s}", lsep, width, "-", rsep);
213 * XXX: workaround {P:} modifier can't be empty and doesn't seem to
214 * take args... so we need to conditionally include it in the format.
216 #define maybe_pad(pad) do { \
218 snprintf(newfmt, sizeof(newfmt), "{P:%s}", pad); \
226 /* Format in human readable form. */
227 humanize_number(buf, sizeof(buf), (int64_t)value, "",
228 HN_AUTOSCALE, HN_NOSPACE | HN_DECIMAL | \
229 ((div1000) ? HN_DIVISOR_1000 : 0));
231 snprintf(newfmt, sizeof(newfmt), "{:%s/%%%ds}", name, width);
232 xo_emit(newfmt, buf);
235 /* Construct the format string. */
237 snprintf(newfmt, sizeof(newfmt), "{:%s/%%%d%s}",
239 xo_emit(newfmt, value);
245 * Find next multiaddr for a given interface name.
247 static struct ifmaddrs *
248 next_ifma(struct ifmaddrs *ifma, const char *name, const sa_family_t family)
251 for(; ifma != NULL; ifma = ifma->ifma_next) {
252 struct sockaddr_dl *sdl;
254 sdl = (struct sockaddr_dl *)ifma->ifma_name;
255 if (ifma->ifma_addr->sa_family == family &&
256 strcmp(sdl->sdl_data, name) == 0)
263 enum process_op { MEASURE, EMIT };
266 process_ifa_addr(enum process_op op, struct ifaddrs *ifa, int *max_net_len,
267 int *max_addr_len, bool *network, bool *link)
269 int net_len, addr_len;
273 net_len = *max_net_len;
274 addr_len = *max_addr_len;
277 switch (ifa->ifa_addr->sa_family) {
280 net_len = strlen("none");
281 addr_len = strlen("none");
283 xo_emit("{:network/%-*.*s} ", net_len, net_len,
285 xo_emit("{:address/%-*.*s} ", addr_len, addr_len,
293 nn = netname(ifa->ifa_addr, ifa->ifa_netmask);
294 rn = routename(ifa->ifa_addr, numeric_addr);
296 net_len = strlen(nn);
297 addr_len = strlen(rn);
299 xo_emit("{t:network/%-*s} ", net_len, nn);
300 xo_emit("{t:address/%-*s} ", addr_len, rn);
308 struct sockaddr_dl *sdl;
309 char linknum[sizeof("<Link#32767>")];
311 sdl = (struct sockaddr_dl *)ifa->ifa_addr;
312 snprintf(linknum, sizeof(linknum), "<Link#%d>", sdl->sdl_index);
314 net_len = strlen(linknum);
315 if (sdl->sdl_nlen == 0 &&
316 sdl->sdl_alen == 0 &&
320 addr_len = strlen(routename(ifa->ifa_addr, 1));
322 xo_emit("{t:network/%-*.*s} ", net_len, net_len,
324 if (sdl->sdl_nlen == 0 &&
325 sdl->sdl_alen == 0 &&
327 xo_emit("{P:/%*s} ", addr_len, "");
329 xo_emit("{t:address/%-*.*s} ", addr_len,
330 addr_len, routename(ifa->ifa_addr, 1));
339 if (net_len > *max_net_len)
340 *max_net_len = net_len;
341 if (addr_len > *max_addr_len)
342 *max_addr_len = addr_len;
347 max_num_len(int max_len, u_long num)
349 int len = 2; /* include space */
351 for (; num > 10; len++)
353 return (MAX(max_len, len));
357 * Print a description of the network interfaces.
360 intpr(void (*pfunc)(char *), int af)
362 struct ifaddrs *ifap, *ifa;
363 struct ifmaddrs *ifmap, *ifma;
364 u_int ifn_len_max = 5, ifn_len;
365 u_int net_len = strlen("Network "), addr_len = strlen("Address ");
366 u_int npkt_len = 8, nbyte_len = 10, nerr_len = 5;
369 return sidewaysintpr();
371 if (getifaddrs(&ifap) != 0)
372 err(EX_OSERR, "getifaddrs");
373 if (aflag && getifmaddrs(&ifmap) != 0)
374 err(EX_OSERR, "getifmaddrs");
376 for (ifa = ifap; ifa; ifa = ifa->ifa_next) {
377 if (interface != NULL &&
378 strcmp(ifa->ifa_name, interface) != 0)
380 if (af != AF_UNSPEC && ifa->ifa_addr->sa_family != af)
382 ifn_len = strlen(ifa->ifa_name);
383 if ((ifa->ifa_flags & IFF_UP) == 0)
385 ifn_len_max = MAX(ifn_len_max, ifn_len);
386 process_ifa_addr(MEASURE, ifa, &net_len, &addr_len,
389 #define IFA_STAT(s) (((struct if_data *)ifa->ifa_data)->ifi_ ## s)
391 npkt_len = max_num_len(npkt_len, IFA_STAT(ipackets));
392 npkt_len = max_num_len(npkt_len, IFA_STAT(opackets));
393 nerr_len = max_num_len(nerr_len, IFA_STAT(ierrors));
394 nerr_len = max_num_len(nerr_len, IFA_STAT(iqdrops));
395 nerr_len = max_num_len(nerr_len, IFA_STAT(collisions));
397 nerr_len = max_num_len(nerr_len,
400 nbyte_len = max_num_len(nbyte_len,
402 nbyte_len = max_num_len(nbyte_len,
408 xo_open_list("interface");
410 xo_emit("{T:/%-*.*s}", ifn_len_max, ifn_len_max, "Name");
411 xo_emit(" {T:/%5.5s} {T:/%-*.*s} {T:/%-*.*s} {T:/%*.*s} "
412 "{T:/%*.*s} {T:/%*.*s}",
413 "Mtu", net_len, net_len, "Network", addr_len, addr_len,
414 "Address", npkt_len, npkt_len, "Ipkts",
415 nerr_len, nerr_len, "Ierrs", nerr_len, nerr_len, "Idrop");
417 xo_emit(" {T:/%*.*s}", nbyte_len, nbyte_len, "Ibytes");
418 xo_emit(" {T:/%*.*s} {T:/%*.*s}", npkt_len, npkt_len, "Opkts",
419 nerr_len, nerr_len, "Oerrs");
421 xo_emit(" {T:/%*.*s}", nbyte_len, nbyte_len, "Obytes");
422 xo_emit(" {T:/%*s}", nerr_len, "Coll");
424 xo_emit(" {T:/%*.*s}", nerr_len, nerr_len, "Drop");
428 for (ifa = ifap; ifa; ifa = ifa->ifa_next) {
429 bool network = false, link = false;
430 char *name, *xname, buf[IFNAMSIZ+1];
432 if (interface != NULL && strcmp(ifa->ifa_name, interface) != 0)
435 name = ifa->ifa_name;
442 * Skip all ifaddrs belonging to same interface.
444 while(ifa->ifa_next != NULL &&
445 (strcmp(ifa->ifa_next->ifa_name, name) == 0)) {
451 if (af != AF_UNSPEC && ifa->ifa_addr->sa_family != af)
454 xo_open_instance("interface");
456 if ((ifa->ifa_flags & IFF_UP) == 0) {
457 xname = stpcpy(buf, name);
464 xo_emit("{d:/%-*.*s}{etk:name}{eq:flags/0x%x}",
465 ifn_len_max, ifn_len_max, xname, name, ifa->ifa_flags);
467 #define IFA_MTU(ifa) (((struct if_data *)(ifa)->ifa_data)->ifi_mtu)
468 show_stat("lu", 6, "mtu", IFA_MTU(ifa), IFA_MTU(ifa), 0);
471 process_ifa_addr(EMIT, ifa, &net_len, &addr_len,
474 show_stat("lu", npkt_len, "received-packets",
475 IFA_STAT(ipackets), link|network, 1);
476 show_stat("lu", nerr_len, "received-errors", IFA_STAT(ierrors),
478 show_stat("lu", nerr_len, "dropped-packets", IFA_STAT(iqdrops),
481 show_stat("lu", nbyte_len, "received-bytes",
482 IFA_STAT(ibytes), link|network, 0);
483 show_stat("lu", npkt_len, "sent-packets", IFA_STAT(opackets),
485 show_stat("lu", nerr_len, "send-errors", IFA_STAT(oerrors),
488 show_stat("lu", nbyte_len, "sent-bytes",
489 IFA_STAT(obytes), link|network, 0);
490 show_stat("NRSlu", nerr_len, "collisions", IFA_STAT(collisions),
493 show_stat("LSlu", nerr_len, "dropped-packets",
494 IFA_STAT(oqdrops), link, 1);
498 xo_close_instance("interface");
503 * Print family's multicast addresses.
505 xo_open_list("multicast-address");
506 for (ifma = next_ifma(ifmap, ifa->ifa_name,
507 ifa->ifa_addr->sa_family);
509 ifma = next_ifma(ifma, ifa->ifa_name,
510 ifa->ifa_addr->sa_family)) {
511 const char *fmt = NULL;
513 xo_open_instance("multicast-address");
514 switch (ifma->ifma_addr->sa_family) {
517 struct sockaddr_dl *sdl;
519 sdl = (struct sockaddr_dl *)ifma->ifma_addr;
520 if (sdl->sdl_type != IFT_ETHER &&
521 sdl->sdl_type != IFT_FDDI)
529 fmt = routename(ifma->ifma_addr, numeric_addr);
535 "{t:address/%-17s/}", "", fmt);
538 "{t:address/%-17.17s/}", "", fmt);
539 if (ifma->ifma_addr->sa_family == AF_LINK) {
540 xo_emit(" {:received-packets/%8lu}",
542 xo_emit("{P:/%*s}", bflag? 17 : 6, "");
543 xo_emit(" {:sent-packets/%8lu}",
548 xo_close_instance("multicast-address");
549 ifma = ifma->ifma_next;
551 xo_close_list("multicast-address");
552 xo_close_instance("interface");
554 xo_close_list("interface");
562 u_long ift_ip; /* input packets */
563 u_long ift_ie; /* input errors */
564 u_long ift_id; /* input drops */
565 u_long ift_op; /* output packets */
566 u_long ift_oe; /* output errors */
567 u_long ift_od; /* output drops */
568 u_long ift_co; /* collisions */
569 u_long ift_ib; /* input bytes */
570 u_long ift_ob; /* output bytes */
574 * Obtain stats for interface(s).
577 fill_iftot(struct iftot *st)
579 struct ifaddrs *ifap, *ifa;
582 if (getifaddrs(&ifap) != 0)
583 xo_err(EX_OSERR, "getifaddrs");
585 bzero(st, sizeof(*st));
587 for (ifa = ifap; ifa; ifa = ifa->ifa_next) {
588 if (ifa->ifa_addr->sa_family != AF_LINK)
591 if (strcmp(ifa->ifa_name, interface) == 0)
597 st->ift_ip += IFA_STAT(ipackets);
598 st->ift_ie += IFA_STAT(ierrors);
599 st->ift_id += IFA_STAT(iqdrops);
600 st->ift_ib += IFA_STAT(ibytes);
601 st->ift_op += IFA_STAT(opackets);
602 st->ift_oe += IFA_STAT(oerrors);
603 st->ift_od += IFA_STAT(oqdrops);
604 st->ift_ob += IFA_STAT(obytes);
605 st->ift_co += IFA_STAT(collisions);
608 if (interface && found == false)
609 xo_err(EX_DATAERR, "interface %s not found", interface);
615 * Set a flag to indicate that a signal from the periodic itimer has been
618 static sig_atomic_t signalled;
620 catchalarm(int signo __unused)
626 * Print a running summary of interface statistics.
627 * Repeat display every interval seconds, showing statistics
628 * collected over that interval. Assumes that interval is non-zero.
629 * First line printed at top of screen is always cumulative.
634 struct iftot ift[2], *new, *old;
635 struct itimerval interval_it;
642 (void)signal(SIGALRM, catchalarm);
644 interval_it.it_interval.tv_sec = interval;
645 interval_it.it_interval.tv_usec = 0;
646 interval_it.it_value = interval_it.it_interval;
647 setitimer(ITIMER_REAL, &interval_it, NULL);
648 xo_open_list("interface-statistics");
651 xo_emit("{T:/%17s} {T:/%14s} {T:/%16s}\n", "input",
652 interface != NULL ? interface : "(Total)", "output");
653 xo_emit("{T:/%10s} {T:/%5s} {T:/%5s} {T:/%10s} {T:/%10s} {T:/%5s} "
654 "{T:/%10s} {T:/%5s}",
655 "packets", "errs", "idrops", "bytes", "packets", "errs", "bytes",
658 xo_emit(" {T:/%5.5s}", "drops");
664 if ((noutputs != 0) && (--noutputs == 0)) {
665 xo_close_list("interface-statistics");
668 oldmask = sigblock(sigmask(SIGALRM));
677 xo_open_instance("stats");
678 show_stat("lu", 10, "received-packets",
679 new->ift_ip - old->ift_ip, 1, 1);
680 show_stat("lu", 5, "received-errors",
681 new->ift_ie - old->ift_ie, 1, 1);
682 show_stat("lu", 5, "dropped-packets",
683 new->ift_id - old->ift_id, 1, 1);
684 show_stat("lu", 10, "received-bytes",
685 new->ift_ib - old->ift_ib, 1, 0);
686 show_stat("lu", 10, "sent-packets",
687 new->ift_op - old->ift_op, 1, 1);
688 show_stat("lu", 5, "send-errors",
689 new->ift_oe - old->ift_oe, 1, 1);
690 show_stat("lu", 10, "sent-bytes",
691 new->ift_ob - old->ift_ob, 1, 0);
692 show_stat("NRSlu", 5, "collisions",
693 new->ift_co - old->ift_co, 1, 1);
695 show_stat("LSlu", 5, "dropped-packets",
696 new->ift_od - old->ift_od, 1, 1);
697 xo_close_instance("stats");
701 if (new == &ift[0]) {