xref: /freebsd/usr.bin/systat/ifstat.c (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
1 /*
2  * Copyright (c) 2003, Trent Nelson, <trent@arpa.com>.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTIFSTAT_ERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #include <sys/types.h>
32 #include <sys/socket.h>
33 #include <sys/sysctl.h>
34 #include <net/if.h>
35 #include <net/if_mib.h>
36 
37 #include <stdlib.h>
38 #include <string.h>
39 #include <err.h>
40 #include <errno.h>
41 
42 #include "systat.h"
43 #include "extern.h"
44 #include "convtbl.h"
45 
46 				/* Column numbers */
47 
48 #define C1	0		/*  0-19 */
49 #define C2	20		/* 20-39 */
50 #define C3	40		/* 40-59 */
51 #define C4	60		/* 60-80 */
52 #define C5	80		/* Used for label positioning. */
53 
54 static const int col0 = 0;
55 static const int col1 = C1;
56 static const int col2 = C2;
57 static const int col3 = C3;
58 static const int col4 = C4;
59 static const int col5 = C5;
60 
61 
62 SLIST_HEAD(, if_stat)		curlist;
63 SLIST_HEAD(, if_stat_disp)	displist;
64 
65 struct if_stat {
66 	SLIST_ENTRY(if_stat)	 link;
67 	char	if_name[IF_NAMESIZE];
68 	struct	ifmibdata if_mib;
69 	struct	timeval tv;
70 	struct	timeval tv_lastchanged;
71 	u_long	if_in_curtraffic;
72 	u_long	if_out_curtraffic;
73 	u_long	if_in_traffic_peak;
74 	u_long	if_out_traffic_peak;
75 	u_int	if_row;			/* Index into ifmib sysctl */
76 	u_int	if_ypos;		/* 0 if not being displayed */
77 	u_int	display;
78 };
79 
80 extern	 u_int curscale;
81 
82 static	 void  right_align_string(struct if_stat *);
83 static	 void  getifmibdata(const int, struct ifmibdata *);
84 static	 void  sort_interface_list(void);
85 static	 u_int getifnum(void);
86 
87 #define IFSTAT_ERR(n, s)	do {					\
88 	putchar('');							\
89 	closeifstat(wnd);						\
90 	err((n), (s));							\
91 } while (0)
92 
93 #define TOPLINE 3
94 #define TOPLABEL \
95 "      Interface           Traffic               Peak                Total"
96 
97 #define STARTING_ROW	(TOPLINE + 1)
98 #define ROW_SPACING	(3)
99 
100 #define CLEAR_LINE(y, x)	do {					\
101 	wmove(wnd, y, x);						\
102 	wclrtoeol(wnd);							\
103 } while (0)
104 
105 #define IN_col2		(ifp->if_in_curtraffic)
106 #define OUT_col2	(ifp->if_out_curtraffic)
107 #define IN_col3		(ifp->if_in_traffic_peak)
108 #define OUT_col3	(ifp->if_out_traffic_peak)
109 #define IN_col4		(ifp->if_mib.ifmd_data.ifi_ibytes)
110 #define OUT_col4	(ifp->if_mib.ifmd_data.ifi_obytes)
111 
112 #define EMPTY_COLUMN 	"                    "
113 #define CLEAR_COLUMN(y, x)	mvprintw((y), (x), "%20s", EMPTY_COLUMN);
114 
115 #define DOPUTRATE(c, r, d)	do {					\
116 	CLEAR_COLUMN(r, c);						\
117 	mvprintw(r, (c), "%10.3f %s%s  ",				\
118 		 convert(d##_##c, curscale),				\
119 		 get_string(d##_##c, curscale),				\
120 		 "/s");							\
121 } while (0)
122 
123 #define DOPUTTOTAL(c, r, d)	do {					\
124 	CLEAR_COLUMN((r), (c));						\
125 	mvprintw((r), (c), "%12.3f %s  ",				\
126 		 convert(d##_##c, SC_AUTO),				\
127 		 get_string(d##_##c, SC_AUTO));				\
128 } while (0)
129 
130 #define PUTRATE(c, r)	do {						\
131 	DOPUTRATE(c, (r), IN);						\
132 	DOPUTRATE(c, (r)+1, OUT);					\
133 } while (0)
134 
135 #define PUTTOTAL(c, r)	do {						\
136 	DOPUTTOTAL(c, (r), IN);						\
137 	DOPUTTOTAL(c, (r)+1, OUT);					\
138 } while (0)
139 
140 #define PUTNAME(p) do {							\
141 	mvprintw(p->if_ypos, 0, "%s", p->if_name);			\
142 	mvprintw(p->if_ypos, col2-3, "%s", (const char *)"in");		\
143 	mvprintw(p->if_ypos+1, col2-3, "%s", (const char *)"out");	\
144 } while (0)
145 
146 
147 WINDOW *
148 openifstat(void)
149 {
150 	return (subwin(stdscr, LINES-3-1, 0, MAINWIN_ROW, 0));
151 }
152 
153 void
154 closeifstat(WINDOW *w)
155 {
156 	struct if_stat	*node = NULL;
157 
158 	while (!SLIST_EMPTY(&curlist)) {
159 		node = SLIST_FIRST(&curlist);
160 		SLIST_REMOVE_HEAD(&curlist, link);
161 		free(node);
162 	}
163 
164 	if (w != NULL) {
165 		wclear(w);
166 		wrefresh(w);
167 		delwin(w);
168 	}
169 
170 	return;
171 }
172 
173 
174 void
175 labelifstat(void)
176 {
177 
178 	wmove(wnd, TOPLINE, 0);
179 	wclrtoeol(wnd);
180 	mvprintw(TOPLINE, 0, "%s", TOPLABEL);
181 
182 	return;
183 }
184 
185 void
186 showifstat(void)
187 {
188 	struct	if_stat *ifp = NULL;
189 	SLIST_FOREACH(ifp, &curlist, link) {
190 		if (ifp->display == 0)
191 			continue;
192 		PUTNAME(ifp);
193 		PUTRATE(col2, ifp->if_ypos);
194 		PUTRATE(col3, ifp->if_ypos);
195 		PUTTOTAL(col4, ifp->if_ypos);
196 	}
197 
198 	return;
199 }
200 
201 int
202 initifstat(void)
203 {
204 	struct   if_stat *p = NULL;
205 	u_int	 n = 0, i = 0;
206 
207 	n = getifnum();
208 	if (n <= 0)
209 		return -1;
210 
211 	SLIST_INIT(&curlist);
212 
213 	for (i = 0; i < n; i++) {
214 		p = (struct if_stat *)calloc(1, sizeof(struct if_stat));
215 		if (p == NULL)
216 			IFSTAT_ERR(1, "out of memory");
217 		SLIST_INSERT_HEAD(&curlist, p, link);
218 		p->if_row = i+1;
219 		getifmibdata(p->if_row, &p->if_mib);
220 		right_align_string(p);
221 
222 		/*
223 		 * Initially, we only display interfaces that have
224 		 * received some traffic.
225 		 */
226 		if (p->if_mib.ifmd_data.ifi_ibytes != 0)
227 			p->display = 1;
228 	}
229 
230 	sort_interface_list();
231 
232 	return 1;
233 }
234 
235 void
236 fetchifstat(void)
237 {
238 	struct	if_stat *ifp = NULL;
239 	struct	timeval tv, new_tv, old_tv;
240 	double	elapsed = 0.0;
241 	u_int	new_inb, new_outb, old_inb, old_outb = 0;
242 	u_int	we_need_to_sort_interface_list = 0;
243 
244 	SLIST_FOREACH(ifp, &curlist, link) {
245 		/*
246 		 * Grab a copy of the old input/output values before we
247 		 * call getifmibdata().
248 		 */
249 		old_inb = ifp->if_mib.ifmd_data.ifi_ibytes;
250 		old_outb = ifp->if_mib.ifmd_data.ifi_obytes;
251 		ifp->tv_lastchanged = ifp->if_mib.ifmd_data.ifi_lastchange;
252 
253 		if (gettimeofday(&new_tv, (struct timezone *)0) != 0)
254 			IFSTAT_ERR(2, "error getting time of day");
255 		(void)getifmibdata(ifp->if_row, &ifp->if_mib);
256 
257 
258 		new_inb = ifp->if_mib.ifmd_data.ifi_ibytes;
259 		new_outb = ifp->if_mib.ifmd_data.ifi_obytes;
260 
261 		/* Display interface if it's received some traffic. */
262 		if (new_inb > 0 && old_inb == 0) {
263 			ifp->display = 1;
264 			we_need_to_sort_interface_list++;
265 		}
266 
267 		/*
268 		 * The rest is pretty trivial.  Calculate the new values
269 		 * for our current traffic rates, and while we're there,
270 		 * see if we have new peak rates.
271 		 */
272 		old_tv = ifp->tv;
273 		timersub(&new_tv, &old_tv, &tv);
274 		elapsed = tv.tv_sec + (tv.tv_usec * 1e-6);
275 
276 		ifp->if_in_curtraffic = new_inb - old_inb;
277 		ifp->if_out_curtraffic = new_outb - old_outb;
278 
279 		/*
280 		 * Rather than divide by the time specified on the comm-
281 		 * and line, we divide by ``elapsed'' as this is likely
282 		 * to be more accurate.
283 		 */
284 		ifp->if_in_curtraffic /= elapsed;
285 		ifp->if_out_curtraffic /= elapsed;
286 
287 		if (ifp->if_in_curtraffic > ifp->if_in_traffic_peak)
288 			ifp->if_in_traffic_peak = ifp->if_in_curtraffic;
289 
290 		if (ifp->if_out_curtraffic > ifp->if_out_traffic_peak)
291 			ifp->if_out_traffic_peak = ifp->if_out_curtraffic;
292 
293 		ifp->tv.tv_sec = new_tv.tv_sec;
294 		ifp->tv.tv_usec = new_tv.tv_usec;
295 
296 	}
297 
298 	if (we_need_to_sort_interface_list)
299 		sort_interface_list();
300 
301 	return;
302 }
303 
304 /*
305  * We want to right justify our interface names against the first column
306  * (first sixteen or so characters), so we need to do some alignment.
307  */
308 static void
309 right_align_string(struct if_stat *ifp)
310 {
311 	int	 str_len = 0, pad_len = 0;
312 	char	*newstr = NULL, *ptr = NULL;
313 
314 	if (ifp == NULL || ifp->if_mib.ifmd_name == NULL)
315 		return;
316 	else {
317 		/* string length + '\0' */
318 		str_len = strlen(ifp->if_mib.ifmd_name)+1;
319 		pad_len = IF_NAMESIZE-(str_len);
320 
321 		newstr = ifp->if_name;
322 		ptr = newstr + pad_len;
323 		(void)memset((void *)newstr, (int)' ', IF_NAMESIZE);
324 		(void)strncpy(ptr, (const char *)&ifp->if_mib.ifmd_name,
325 			      str_len);
326 	}
327 
328 	return;
329 }
330 
331 /*
332  * This function iterates through our list of interfaces, identifying
333  * those that are to be displayed (ifp->display = 1).  For each interf-
334  * rface that we're displaying, we generate an appropriate position for
335  * it on the screen (ifp->if_ypos).
336  *
337  * This function is called any time a change is made to an interface's
338  * ``display'' state.
339  */
340 void
341 sort_interface_list(void)
342 {
343 	struct	if_stat	*ifp = NULL;
344 	u_int	y = 0;
345 
346 	y = STARTING_ROW;
347 	SLIST_FOREACH(ifp, &curlist, link) {
348 		if (ifp->display) {
349 			ifp->if_ypos = y;
350 			y += ROW_SPACING;
351 		}
352 	}
353 }
354 
355 static
356 unsigned int
357 getifnum(void)
358 {
359 	u_int	data    = 0;
360 	size_t	datalen = 0;
361 	static	int name[] = { CTL_NET,
362 			       PF_LINK,
363 			       NETLINK_GENERIC,
364 			       IFMIB_SYSTEM,
365 			       IFMIB_IFCOUNT };
366 
367 	datalen = sizeof(data);
368 	if (sysctl(name, 5, (void *)&data, (size_t *)&datalen, (void *)NULL,
369 	    (size_t)0) != 0)
370 		IFSTAT_ERR(1, "sysctl error");
371 	return data;
372 }
373 
374 static void
375 getifmibdata(int row, struct ifmibdata *data)
376 {
377 	size_t	datalen = 0;
378 	static	int name[] = { CTL_NET,
379 			       PF_LINK,
380 			       NETLINK_GENERIC,
381 			       IFMIB_IFDATA,
382 			       0,
383 			       IFDATA_GENERAL };
384 	datalen = sizeof(*data);
385 	name[4] = row;
386 
387 	if ((sysctl(name, 6, (void *)data, (size_t *)&datalen, (void *)NULL,
388 	    (size_t)0) != 0) && (errno != ENOENT))
389 		IFSTAT_ERR(2, "sysctl error getting interface data");
390 }
391 
392 int
393 cmdifstat(const char *cmd, const char *args)
394 {
395 	int	retval = 0;
396 
397 	retval = ifcmd(cmd, args);
398 	/* ifcmd() returns 1 on success */
399 	if (retval == 1) {
400 		showifstat();
401 		refresh();
402 	}
403 
404 	return retval;
405 }
406