xref: /freebsd/usr.bin/w/w.c (revision 71fe318b852b8dfb3e799cb12ef184750f7f8eac)
1 /*-
2  * Copyright (c) 1980, 1991, 1993, 1994
3  *	The Regents of the University of California.  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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #include <sys/cdefs.h>
35 
36 __FBSDID("$FreeBSD$");
37 
38 #ifndef lint
39 static const char copyright[] =
40 "@(#) Copyright (c) 1980, 1991, 1993, 1994\n\
41 	The Regents of the University of California.  All rights reserved.\n";
42 #endif
43 
44 #ifndef lint
45 static const char sccsid[] = "@(#)w.c	8.4 (Berkeley) 4/16/94";
46 #endif
47 
48 /*
49  * w - print system status (who and what)
50  *
51  * This program is similar to the systat command on Tenex/Tops 10/20
52  *
53  */
54 #include <sys/param.h>
55 #include <sys/time.h>
56 #include <sys/stat.h>
57 #include <sys/sysctl.h>
58 #include <sys/proc.h>
59 #include <sys/user.h>
60 #include <sys/ioctl.h>
61 #include <sys/socket.h>
62 #include <sys/tty.h>
63 
64 #include <machine/cpu.h>
65 #include <netinet/in.h>
66 #include <arpa/inet.h>
67 #include <arpa/nameser.h>
68 
69 #include <ctype.h>
70 #include <err.h>
71 #include <errno.h>
72 #include <fcntl.h>
73 #include <kvm.h>
74 #include <langinfo.h>
75 #include <libutil.h>
76 #include <limits.h>
77 #include <locale.h>
78 #include <netdb.h>
79 #include <nlist.h>
80 #include <paths.h>
81 #include <resolv.h>
82 #include <stdio.h>
83 #include <stdlib.h>
84 #include <string.h>
85 #include <unistd.h>
86 #include <utmp.h>
87 #include <vis.h>
88 
89 #include "extern.h"
90 
91 struct timeval	boottime;
92 struct utmp	utmp;
93 struct winsize	ws;
94 kvm_t	       *kd;
95 time_t		now;		/* the current time of day */
96 int		ttywidth;	/* width of tty */
97 int		argwidth;	/* width of tty */
98 int		header = 1;	/* true if -h flag: don't print heading */
99 int		nflag;		/* true if -n flag: don't convert addrs */
100 int		dflag;		/* true if -d flag: output debug info */
101 int		sortidle;	/* sort by idle time */
102 int		use_ampm;	/* use AM/PM time */
103 int             use_comma;      /* use comma as floats separator */
104 char	      **sel_users;	/* login array of particular users selected */
105 
106 /*
107  * One of these per active utmp entry.
108  */
109 struct	entry {
110 	struct	entry *next;
111 	struct	utmp utmp;
112 	dev_t	tdev;			/* dev_t of terminal */
113 	time_t	idle;			/* idle time of terminal in seconds */
114 	struct	kinfo_proc *kp;		/* `most interesting' proc */
115 	char	*args;			/* arg list of interesting process */
116 	struct	kinfo_proc *dkp;	/* debug option proc list */
117 } *ep, *ehead = NULL, **nextp = &ehead;
118 
119 #define debugproc(p) *((struct kinfo_proc **)&(p)->ki_spare[0])
120 
121 /* W_DISPHOSTSIZE should not be greater than UT_HOSTSIZE */
122 #define	W_DISPHOSTSIZE	16
123 
124 static void		 pr_header(time_t *, int);
125 static struct stat	*ttystat(char *, int);
126 static void		 usage(int);
127 static int		 this_is_uptime(const char *s);
128 
129 char *fmt_argv(char **, char *, int);	/* ../../bin/ps/fmt.c */
130 
131 int
132 main(int argc, char *argv[])
133 {
134 	struct kinfo_proc *kp;
135 	struct kinfo_proc *dkp;
136 	struct stat *stp;
137 	FILE *ut;
138 	time_t touched;
139 	int ch, i, nentries, nusers, wcmd, longidle, dropgid;
140 	const char *memf, *nlistf, *p;
141 	char *x_suffix;
142 	char buf[MAXHOSTNAMELEN], errbuf[_POSIX2_LINE_MAX];
143 	char fn[MAXHOSTNAMELEN];
144 	char *dot;
145 
146 	(void)setlocale(LC_ALL, "");
147 	use_ampm = (*nl_langinfo(T_FMT_AMPM) != '\0');
148 	use_comma = (*nl_langinfo(RADIXCHAR) != ',');
149 
150 	/* Are we w(1) or uptime(1)? */
151 	if (this_is_uptime(argv[0]) == 0) {
152 		wcmd = 0;
153 		p = "";
154 	} else {
155 		wcmd = 1;
156 		p = "dhiflM:N:nsuw";
157 	}
158 
159 	dropgid = 0;
160 	memf = nlistf = _PATH_DEVNULL;
161 	while ((ch = getopt(argc, argv, p)) != -1)
162 		switch (ch) {
163 		case 'd':
164 			dflag = 1;
165 			break;
166 		case 'h':
167 			header = 0;
168 			break;
169 		case 'i':
170 			sortidle = 1;
171 			break;
172 		case 'M':
173 			header = 0;
174 			memf = optarg;
175 			dropgid = 1;
176 			break;
177 		case 'N':
178 			nlistf = optarg;
179 			dropgid = 1;
180 			break;
181 		case 'n':
182 			nflag = 1;
183 			break;
184 		case 'f': case 'l': case 's': case 'u': case 'w':
185 			warnx("[-flsuw] no longer supported");
186 			/* FALLTHROUGH */
187 		case '?':
188 		default:
189 			usage(wcmd);
190 		}
191 	argc -= optind;
192 	argv += optind;
193 
194 	if (!(_res.options & RES_INIT))
195 		res_init();
196 	_res.retrans = 2;	/* resolver timeout to 2 seconds per try */
197 	_res.retry = 1;		/* only try once.. */
198 
199 	/*
200 	 * Discard setgid privileges if not the running kernel so that bad
201 	 * guys can't print interesting stuff from kernel memory.
202 	 */
203 	if (dropgid)
204 		setgid(getgid());
205 
206 	if ((kd = kvm_openfiles(nlistf, memf, NULL, O_RDONLY, errbuf)) == NULL)
207 		errx(1, "%s", errbuf);
208 
209 	(void)time(&now);
210 	if ((ut = fopen(_PATH_UTMP, "r")) == NULL)
211 		err(1, "%s", _PATH_UTMP);
212 
213 	if (*argv)
214 		sel_users = argv;
215 
216 	for (nusers = 0; fread(&utmp, sizeof(utmp), 1, ut);) {
217 		if (utmp.ut_name[0] == '\0')
218 			continue;
219 		if (!(stp = ttystat(utmp.ut_line, UT_LINESIZE)))
220 			continue;	/* corrupted record */
221 		++nusers;
222 		if (wcmd == 0)
223 			continue;
224 		if (sel_users) {
225 			int usermatch;
226 			char **user;
227 
228 			usermatch = 0;
229 			for (user = sel_users; !usermatch && *user; user++)
230 				if (!strncmp(utmp.ut_name, *user, UT_NAMESIZE))
231 					usermatch = 1;
232 			if (!usermatch)
233 				continue;
234 		}
235 		if ((ep = calloc(1, sizeof(struct entry))) == NULL)
236 			errx(1, "calloc");
237 		*nextp = ep;
238 		nextp = &ep->next;
239 		memmove(&ep->utmp, &utmp, sizeof(struct utmp));
240 		ep->tdev = stp->st_rdev;
241 #ifdef CPU_CONSDEV
242 		/*
243 		 * If this is the console device, attempt to ascertain
244 		 * the true console device dev_t.
245 		 */
246 		if (ep->tdev == 0) {
247 			int mib[2];
248 			size_t size;
249 
250 			mib[0] = CTL_MACHDEP;
251 			mib[1] = CPU_CONSDEV;
252 			size = sizeof(dev_t);
253 			(void)sysctl(mib, 2, &ep->tdev, &size, NULL, 0);
254 		}
255 #endif
256 		touched = stp->st_atime;
257 		if (touched < ep->utmp.ut_time) {
258 			/* tty untouched since before login */
259 			touched = ep->utmp.ut_time;
260 		}
261 		if ((ep->idle = now - touched) < 0)
262 			ep->idle = 0;
263 	}
264 	(void)fclose(ut);
265 
266 	if (header || wcmd == 0) {
267 		pr_header(&now, nusers);
268 		if (wcmd == 0) {
269 			(void)kvm_close(kd);
270 			exit(0);
271 		}
272 
273 #define HEADER_USER		"USER"
274 #define HEADER_TTY		"TTY"
275 #define HEADER_FROM		"FROM"
276 #define HEADER_LOGIN_IDLE	"LOGIN@  IDLE "
277 #define HEADER_WHAT		"WHAT\n"
278 #define WUSED  (UT_NAMESIZE + UT_LINESIZE + W_DISPHOSTSIZE + \
279 		sizeof(HEADER_LOGIN_IDLE) + 3)	/* header width incl. spaces */
280 		(void)printf("%-*.*s %-*.*s %-*.*s  %s",
281 				UT_NAMESIZE, UT_NAMESIZE, HEADER_USER,
282 				UT_LINESIZE, UT_LINESIZE, HEADER_TTY,
283 				W_DISPHOSTSIZE, W_DISPHOSTSIZE, HEADER_FROM,
284 				HEADER_LOGIN_IDLE HEADER_WHAT);
285 	}
286 
287 	if ((kp = kvm_getprocs(kd, KERN_PROC_ALL, 0, &nentries)) == NULL)
288 		err(1, "%s", kvm_geterr(kd));
289 	for (i = 0; i < nentries; i++, kp++) {
290 		if (kp->ki_stat == SIDL || kp->ki_stat == SZOMB)
291 			continue;
292 		for (ep = ehead; ep != NULL; ep = ep->next) {
293 			if (ep->tdev == kp->ki_tdev) {
294 				/*
295 				 * proc is associated with this terminal
296 				 */
297 				if (ep->kp == NULL && kp->ki_pgid == kp->ki_tpgid) {
298 					/*
299 					 * Proc is 'most interesting'
300 					 */
301 					if (proc_compare(ep->kp, kp))
302 						ep->kp = kp;
303 				}
304 				/*
305 				 * Proc debug option info; add to debug
306 				 * list using kinfo_proc ki_spare[0]
307 				 * as next pointer; ptr to ptr avoids the
308 				 * ptr = long assumption.
309 				 */
310 				dkp = ep->dkp;
311 				ep->dkp = kp;
312 				debugproc(kp) = dkp;
313 			}
314 		}
315 	}
316 	if ((ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == -1 &&
317 	     ioctl(STDERR_FILENO, TIOCGWINSZ, &ws) == -1 &&
318 	     ioctl(STDIN_FILENO, TIOCGWINSZ, &ws) == -1) || ws.ws_col == 0)
319 	       ttywidth = 79;
320         else
321 	       ttywidth = ws.ws_col - 1;
322 	argwidth = ttywidth - WUSED;
323 	if (argwidth < 4)
324 		argwidth = 8;
325 	for (ep = ehead; ep != NULL; ep = ep->next) {
326 		if (ep->kp == NULL) {
327 			ep->args = strdup("-");
328 			continue;
329 		}
330 		ep->args = fmt_argv(kvm_getargv(kd, ep->kp, argwidth),
331 		    ep->kp->ki_comm, MAXCOMLEN);
332 		if (ep->args == NULL)
333 			err(1, NULL);
334 	}
335 	/* sort by idle time */
336 	if (sortidle && ehead != NULL) {
337 		struct entry *from, *save;
338 
339 		from = ehead;
340 		ehead = NULL;
341 		while (from != NULL) {
342 			for (nextp = &ehead;
343 			    (*nextp) && from->idle >= (*nextp)->idle;
344 			    nextp = &(*nextp)->next)
345 				continue;
346 			save = from;
347 			from = from->next;
348 			save->next = *nextp;
349 			*nextp = save;
350 		}
351 	}
352 
353 	for (ep = ehead; ep != NULL; ep = ep->next) {
354 		char host_buf[UT_HOSTSIZE + 1];
355 		struct sockaddr_storage ss;
356 		struct sockaddr *sa = (struct sockaddr *)&ss;
357 		struct sockaddr_in *lsin = (struct sockaddr_in *)&ss;
358 		struct sockaddr_in6 *lsin6 = (struct sockaddr_in6 *)&ss;
359 		int isaddr;
360 
361 		host_buf[UT_HOSTSIZE] = '\0';
362 		strncpy(host_buf, ep->utmp.ut_host, UT_HOSTSIZE);
363 		p = *host_buf ? host_buf : "-";
364 		if ((x_suffix = strrchr(p, ':')) != NULL) {
365 			if ((dot = strchr(x_suffix, '.')) != NULL &&
366 			    strchr(dot+1, '.') == NULL)
367 				*x_suffix++ = '\0';
368 			else
369 				x_suffix = NULL;
370 		}
371 		if (!nflag) {
372 			/* Attempt to change an IP address into a name */
373 			isaddr = 0;
374 			memset(&ss, '\0', sizeof(ss));
375 			if (inet_pton(AF_INET6, p, &lsin6->sin6_addr) == 1) {
376 				lsin6->sin6_len = sizeof(*lsin6);
377 				lsin6->sin6_family = AF_INET6;
378 				isaddr = 1;
379 			} else if (inet_pton(AF_INET, p, &lsin->sin_addr) == 1) {
380 				lsin->sin_len = sizeof(*lsin);
381 				lsin->sin_family = AF_INET;
382 				isaddr = 1;
383 			}
384 			if (isaddr && realhostname_sa(fn, sizeof(fn), sa,
385 			    sa->sa_len) == HOSTNAME_FOUND)
386 				p = fn;
387 		}
388 		if (x_suffix) {
389 			(void)snprintf(buf, sizeof(buf), "%s:%s", p, x_suffix);
390 			p = buf;
391 		}
392 		if (dflag) {
393 			for (dkp = ep->dkp; dkp != NULL; dkp = debugproc(dkp)) {
394 				const char *ptr;
395 
396 				ptr = fmt_argv(kvm_getargv(kd, dkp, argwidth),
397 				    dkp->ki_comm, MAXCOMLEN);
398 				if (ptr == NULL)
399 					ptr = "-";
400 				(void)printf("\t\t%-9d %s\n",
401 				    dkp->ki_pid, ptr);
402 			}
403 		}
404 		(void)printf("%-*.*s %-*.*s %-*.*s ",
405 		    UT_NAMESIZE, UT_NAMESIZE, ep->utmp.ut_name,
406 		    UT_LINESIZE, UT_LINESIZE,
407 		    strncmp(ep->utmp.ut_line, "tty", 3) &&
408 		    strncmp(ep->utmp.ut_line, "cua", 3) ?
409 		    ep->utmp.ut_line : ep->utmp.ut_line + 3,
410 		    W_DISPHOSTSIZE, W_DISPHOSTSIZE, *p ? p : "-");
411 		pr_attime(&ep->utmp.ut_time, &now);
412 		longidle = pr_idle(ep->idle);
413 		(void)printf("%.*s\n", argwidth - longidle, ep->args);
414 	}
415 	(void)kvm_close(kd);
416 	exit(0);
417 }
418 
419 static void
420 pr_header(time_t *nowp, int nusers)
421 {
422 	double avenrun[3];
423 	time_t uptime;
424 	int days, hrs, i, mins, secs;
425 	int mib[2];
426 	size_t size;
427 	char buf[256];
428 
429 	/*
430 	 * Print time of day.
431 	 */
432 	(void)strftime(buf, sizeof(buf)	- 1,
433 		       use_ampm	? "%l:%M%p" : "%k:%M", localtime(nowp));
434 	buf[sizeof(buf) - 1] = '\0';
435 	(void)printf("%s ", buf);
436 
437 	/*
438 	 * Print how long system has been up.
439 	 * (Found by looking getting "boottime" from the kernel)
440 	 */
441 	mib[0] = CTL_KERN;
442 	mib[1] = KERN_BOOTTIME;
443 	size = sizeof(boottime);
444 	if (sysctl(mib, 2, &boottime, &size, NULL, 0) != -1 &&
445 	    boottime.tv_sec != 0) {
446 		uptime = now - boottime.tv_sec;
447 		if (uptime > 60)
448 			uptime += 30;
449 		days = uptime / 86400;
450 		uptime %= 86400;
451 		hrs = uptime / 3600;
452 		uptime %= 3600;
453 		mins = uptime / 60;
454 		secs = uptime % 60;
455 		(void)printf(" up");
456 		if (days > 0)
457 			(void)printf(" %d day%s,", days, days > 1 ? "s" : "");
458 		if (hrs > 0 && mins > 0)
459 			(void)printf(" %2d:%02d,", hrs, mins);
460 		else if (hrs > 0)
461 			(void)printf(" %d hr%s,", hrs, hrs > 1 ? "s" : "");
462 		else if (mins > 0)
463 			(void)printf(" %d min%s,", mins, mins > 1 ? "s" : "");
464 		else
465 			(void)printf(" %d sec%s,", secs, secs > 1 ? "s" : "");
466 	}
467 
468 	/* Print number of users logged in to system */
469 	(void)printf(" %d user%s", nusers, nusers == 1 ? "" : "s");
470 
471 	/*
472 	 * Print 1, 5, and 15 minute load averages.
473 	 */
474 	if (getloadavg(avenrun, sizeof(avenrun) / sizeof(avenrun[0])) == -1)
475 		(void)printf(", no load average information available\n");
476 	else {
477 		(void)printf(", load averages:");
478 		for (i = 0; i < (int)(sizeof(avenrun) / sizeof(avenrun[0])); i++) {
479 			if (use_comma && i > 0)
480 				(void)printf(",");
481 			(void)printf(" %.2f", avenrun[i]);
482 		}
483 		(void)printf("\n");
484 	}
485 }
486 
487 static struct stat *
488 ttystat(char *line, int sz)
489 {
490 	static struct stat sb;
491 	char ttybuf[MAXPATHLEN];
492 
493 	(void)snprintf(ttybuf, sizeof(ttybuf), "%s%.*s", _PATH_DEV, sz, line);
494 	if (stat(ttybuf, &sb) == 0) {
495 		return (&sb);
496 	} else
497 		return (NULL);
498 }
499 
500 static void
501 usage(int wcmd)
502 {
503 	if (wcmd)
504 		(void)fprintf(stderr,
505 		    "usage: w [-dhin] [-M core] [-N system] [user ...]\n");
506 	else
507 		(void)fprintf(stderr, "usage: uptime\n");
508 	exit(1);
509 }
510 
511 static int
512 this_is_uptime(const char *s)
513 {
514 	const char *u;
515 
516 	if ((u = strrchr(s, '/')) != NULL)
517 		++u;
518 	else
519 		u = s;
520 	if (strcmp(u, "uptime") == 0)
521 		return (0);
522 	return (-1);
523 }
524