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