xref: /freebsd/usr.bin/w/w.c (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
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 <timeconv.h>
86 #include <unistd.h>
87 #include <utmp.h>
88 #include <vis.h>
89 
90 #include "extern.h"
91 
92 struct timeval	boottime;
93 struct utmp	utmp;
94 struct winsize	ws;
95 kvm_t	       *kd;
96 time_t		now;		/* the current time of day */
97 int		ttywidth;	/* width of tty */
98 int		argwidth;	/* width of tty */
99 int		header = 1;	/* true if -h flag: don't print heading */
100 int		nflag;		/* true if -n flag: don't convert addrs */
101 int		dflag;		/* true if -d flag: output debug info */
102 int		sortidle;	/* sort by idle time */
103 int		use_ampm;	/* use AM/PM time */
104 int             use_comma;      /* use comma as floats separator */
105 char	      **sel_users;	/* login array of particular users selected */
106 
107 /*
108  * One of these per active utmp entry.
109  */
110 struct	entry {
111 	struct	entry *next;
112 	struct	utmp utmp;
113 	dev_t	tdev;			/* dev_t of terminal */
114 	time_t	idle;			/* idle time of terminal in seconds */
115 	struct	kinfo_proc *kp;		/* `most interesting' proc */
116 	char	*args;			/* arg list of interesting process */
117 	struct	kinfo_proc *dkp;	/* debug option proc list */
118 } *ep, *ehead = NULL, **nextp = &ehead;
119 
120 #define	debugproc(p) *((struct kinfo_proc **)&(p)->ki_udata)
121 
122 /* W_DISPHOSTSIZE should not be greater than UT_HOSTSIZE */
123 #define	W_DISPHOSTSIZE	16
124 
125 static void		 pr_header(time_t *, int);
126 static struct stat	*ttystat(char *, int);
127 static void		 usage(int);
128 static int		 this_is_uptime(const char *s);
129 
130 char *fmt_argv(char **, char *, int);	/* ../../bin/ps/fmt.c */
131 
132 int
133 main(int argc, char *argv[])
134 {
135 	struct kinfo_proc *kp;
136 	struct kinfo_proc *dkp;
137 	struct stat *stp;
138 	FILE *ut;
139 	time_t touched;
140 	int ch, i, nentries, nusers, wcmd, longidle, dropgid;
141 	const char *memf, *nlistf, *p;
142 	char *x_suffix;
143 	char buf[MAXHOSTNAMELEN], errbuf[_POSIX2_LINE_MAX];
144 	char fn[MAXHOSTNAMELEN];
145 	char *dot;
146 
147 	(void)setlocale(LC_ALL, "");
148 	use_ampm = (*nl_langinfo(T_FMT_AMPM) != '\0');
149 	use_comma = (*nl_langinfo(RADIXCHAR) != ',');
150 
151 	/* Are we w(1) or uptime(1)? */
152 	if (this_is_uptime(argv[0]) == 0) {
153 		wcmd = 0;
154 		p = "";
155 	} else {
156 		wcmd = 1;
157 		p = "dhiflM:N:nsuw";
158 	}
159 
160 	dropgid = 0;
161 	memf = nlistf = _PATH_DEVNULL;
162 	while ((ch = getopt(argc, argv, p)) != -1)
163 		switch (ch) {
164 		case 'd':
165 			dflag = 1;
166 			break;
167 		case 'h':
168 			header = 0;
169 			break;
170 		case 'i':
171 			sortidle = 1;
172 			break;
173 		case 'M':
174 			header = 0;
175 			memf = optarg;
176 			dropgid = 1;
177 			break;
178 		case 'N':
179 			nlistf = optarg;
180 			dropgid = 1;
181 			break;
182 		case 'n':
183 			nflag = 1;
184 			break;
185 		case 'f': case 'l': case 's': case 'u': case 'w':
186 			warnx("[-flsuw] no longer supported");
187 			/* FALLTHROUGH */
188 		case '?':
189 		default:
190 			usage(wcmd);
191 		}
192 	argc -= optind;
193 	argv += optind;
194 
195 	if (!(_res.options & RES_INIT))
196 		res_init();
197 	_res.retrans = 2;	/* resolver timeout to 2 seconds per try */
198 	_res.retry = 1;		/* only try once.. */
199 
200 	/*
201 	 * Discard setgid privileges if not the running kernel so that bad
202 	 * guys can't print interesting stuff from kernel memory.
203 	 */
204 	if (dropgid)
205 		setgid(getgid());
206 
207 	if ((kd = kvm_openfiles(nlistf, memf, NULL, O_RDONLY, errbuf)) == NULL)
208 		errx(1, "%s", errbuf);
209 
210 	(void)time(&now);
211 	if ((ut = fopen(_PATH_UTMP, "r")) == NULL)
212 		err(1, "%s", _PATH_UTMP);
213 
214 	if (*argv)
215 		sel_users = argv;
216 
217 	for (nusers = 0; fread(&utmp, sizeof(utmp), 1, ut);) {
218 		if (utmp.ut_name[0] == '\0')
219 			continue;
220 		if (!(stp = ttystat(utmp.ut_line, UT_LINESIZE)))
221 			continue;	/* corrupted record */
222 		++nusers;
223 		if (wcmd == 0)
224 			continue;
225 		if (sel_users) {
226 			int usermatch;
227 			char **user;
228 
229 			usermatch = 0;
230 			for (user = sel_users; !usermatch && *user; user++)
231 				if (!strncmp(utmp.ut_name, *user, UT_NAMESIZE))
232 					usermatch = 1;
233 			if (!usermatch)
234 				continue;
235 		}
236 		if ((ep = calloc(1, sizeof(struct entry))) == NULL)
237 			errx(1, "calloc");
238 		*nextp = ep;
239 		nextp = &ep->next;
240 		memmove(&ep->utmp, &utmp, sizeof(struct utmp));
241 		ep->tdev = stp->st_rdev;
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 			size_t size;
248 
249 			size = sizeof(dev_t);
250 			(void)sysctlbyname("machdep.consdev", &ep->tdev, &size, NULL, 0);
251 		}
252 		touched = stp->st_atime;
253 		if (touched < ep->utmp.ut_time) {
254 			/* tty untouched since before login */
255 			touched = ep->utmp.ut_time;
256 		}
257 		if ((ep->idle = now - touched) < 0)
258 			ep->idle = 0;
259 	}
260 	(void)fclose(ut);
261 
262 	if (header || wcmd == 0) {
263 		pr_header(&now, nusers);
264 		if (wcmd == 0) {
265 			(void)kvm_close(kd);
266 			exit(0);
267 		}
268 
269 #define HEADER_USER		"USER"
270 #define HEADER_TTY		"TTY"
271 #define HEADER_FROM		"FROM"
272 #define HEADER_LOGIN_IDLE	"LOGIN@  IDLE "
273 #define HEADER_WHAT		"WHAT\n"
274 #define WUSED  (UT_NAMESIZE + UT_LINESIZE + W_DISPHOSTSIZE + \
275 		sizeof(HEADER_LOGIN_IDLE) + 3)	/* header width incl. spaces */
276 		(void)printf("%-*.*s %-*.*s %-*.*s  %s",
277 				UT_NAMESIZE, UT_NAMESIZE, HEADER_USER,
278 				UT_LINESIZE, UT_LINESIZE, HEADER_TTY,
279 				W_DISPHOSTSIZE, W_DISPHOSTSIZE, HEADER_FROM,
280 				HEADER_LOGIN_IDLE HEADER_WHAT);
281 	}
282 
283 	if ((kp = kvm_getprocs(kd, KERN_PROC_ALL, 0, &nentries)) == NULL)
284 		err(1, "%s", kvm_geterr(kd));
285 	for (i = 0; i < nentries; i++, kp++) {
286 		if (kp->ki_stat == SIDL || kp->ki_stat == SZOMB)
287 			continue;
288 		for (ep = ehead; ep != NULL; ep = ep->next) {
289 			if (ep->tdev == kp->ki_tdev) {
290 				/*
291 				 * proc is associated with this terminal
292 				 */
293 				if (ep->kp == NULL && kp->ki_pgid == kp->ki_tpgid) {
294 					/*
295 					 * Proc is 'most interesting'
296 					 */
297 					if (proc_compare(ep->kp, kp))
298 						ep->kp = kp;
299 				}
300 				/*
301 				 * Proc debug option info; add to debug
302 				 * list using kinfo_proc ki_spare[0]
303 				 * as next pointer; ptr to ptr avoids the
304 				 * ptr = long assumption.
305 				 */
306 				dkp = ep->dkp;
307 				ep->dkp = kp;
308 				debugproc(kp) = dkp;
309 			}
310 		}
311 	}
312 	if ((ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == -1 &&
313 	     ioctl(STDERR_FILENO, TIOCGWINSZ, &ws) == -1 &&
314 	     ioctl(STDIN_FILENO, TIOCGWINSZ, &ws) == -1) || ws.ws_col == 0)
315 	       ttywidth = 79;
316         else
317 	       ttywidth = ws.ws_col - 1;
318 	argwidth = ttywidth - WUSED;
319 	if (argwidth < 4)
320 		argwidth = 8;
321 	for (ep = ehead; ep != NULL; ep = ep->next) {
322 		if (ep->kp == NULL) {
323 			ep->args = strdup("-");
324 			continue;
325 		}
326 		ep->args = fmt_argv(kvm_getargv(kd, ep->kp, argwidth),
327 		    ep->kp->ki_comm, MAXCOMLEN);
328 		if (ep->args == NULL)
329 			err(1, NULL);
330 	}
331 	/* sort by idle time */
332 	if (sortidle && ehead != NULL) {
333 		struct entry *from, *save;
334 
335 		from = ehead;
336 		ehead = NULL;
337 		while (from != NULL) {
338 			for (nextp = &ehead;
339 			    (*nextp) && from->idle >= (*nextp)->idle;
340 			    nextp = &(*nextp)->next)
341 				continue;
342 			save = from;
343 			from = from->next;
344 			save->next = *nextp;
345 			*nextp = save;
346 		}
347 	}
348 
349 	for (ep = ehead; ep != NULL; ep = ep->next) {
350 		char host_buf[UT_HOSTSIZE + 1];
351 		struct sockaddr_storage ss;
352 		struct sockaddr *sa = (struct sockaddr *)&ss;
353 		struct sockaddr_in *lsin = (struct sockaddr_in *)&ss;
354 		struct sockaddr_in6 *lsin6 = (struct sockaddr_in6 *)&ss;
355 		time_t t;
356 		int isaddr;
357 
358 		host_buf[UT_HOSTSIZE] = '\0';
359 		strncpy(host_buf, ep->utmp.ut_host, UT_HOSTSIZE);
360 		p = *host_buf ? host_buf : "-";
361 		if ((x_suffix = strrchr(p, ':')) != NULL) {
362 			if ((dot = strchr(x_suffix, '.')) != NULL &&
363 			    strchr(dot+1, '.') == NULL)
364 				*x_suffix++ = '\0';
365 			else
366 				x_suffix = NULL;
367 		}
368 		if (!nflag) {
369 			/* Attempt to change an IP address into a name */
370 			isaddr = 0;
371 			memset(&ss, '\0', sizeof(ss));
372 			if (inet_pton(AF_INET6, p, &lsin6->sin6_addr) == 1) {
373 				lsin6->sin6_len = sizeof(*lsin6);
374 				lsin6->sin6_family = AF_INET6;
375 				isaddr = 1;
376 			} else if (inet_pton(AF_INET, p, &lsin->sin_addr) == 1) {
377 				lsin->sin_len = sizeof(*lsin);
378 				lsin->sin_family = AF_INET;
379 				isaddr = 1;
380 			}
381 			if (isaddr && realhostname_sa(fn, sizeof(fn), sa,
382 			    sa->sa_len) == HOSTNAME_FOUND)
383 				p = fn;
384 		}
385 		if (x_suffix) {
386 			(void)snprintf(buf, sizeof(buf), "%s:%s", p, x_suffix);
387 			p = buf;
388 		}
389 		if (dflag) {
390 			for (dkp = ep->dkp; dkp != NULL; dkp = debugproc(dkp)) {
391 				const char *ptr;
392 
393 				ptr = fmt_argv(kvm_getargv(kd, dkp, argwidth),
394 				    dkp->ki_comm, MAXCOMLEN);
395 				if (ptr == NULL)
396 					ptr = "-";
397 				(void)printf("\t\t%-9d %s\n",
398 				    dkp->ki_pid, ptr);
399 			}
400 		}
401 		(void)printf("%-*.*s %-*.*s %-*.*s ",
402 		    UT_NAMESIZE, UT_NAMESIZE, ep->utmp.ut_name,
403 		    UT_LINESIZE, UT_LINESIZE,
404 		    strncmp(ep->utmp.ut_line, "tty", 3) &&
405 		    strncmp(ep->utmp.ut_line, "cua", 3) ?
406 		    ep->utmp.ut_line : ep->utmp.ut_line + 3,
407 		    W_DISPHOSTSIZE, W_DISPHOSTSIZE, *p ? p : "-");
408 		t = _time_to_time32(ep->utmp.ut_time);
409 		pr_attime(&t, &now);
410 		longidle = pr_idle(ep->idle);
411 		(void)printf("%.*s\n", argwidth - longidle, ep->args);
412 	}
413 	(void)kvm_close(kd);
414 	exit(0);
415 }
416 
417 static void
418 pr_header(time_t *nowp, int nusers)
419 {
420 	double avenrun[3];
421 	time_t uptime;
422 	struct timespec tp;
423 	int days, hrs, i, mins, secs;
424 	char buf[256];
425 
426 	/*
427 	 * Print time of day.
428 	 */
429 	if (strftime(buf, sizeof(buf),
430 	    use_ampm ? "%l:%M%p" : "%k:%M", localtime(nowp)) != 0)
431 		(void)printf("%s ", buf);
432 	/*
433 	 * Print how long system has been up.
434 	 */
435 	if (clock_gettime(CLOCK_MONOTONIC, &tp) != -1) {
436 		uptime = tp.tv_sec;
437 		if (uptime > 60)
438 			uptime += 30;
439 		days = uptime / 86400;
440 		uptime %= 86400;
441 		hrs = uptime / 3600;
442 		uptime %= 3600;
443 		mins = uptime / 60;
444 		secs = uptime % 60;
445 		(void)printf(" up");
446 		if (days > 0)
447 			(void)printf(" %d day%s,", days, days > 1 ? "s" : "");
448 		if (hrs > 0 && mins > 0)
449 			(void)printf(" %2d:%02d,", hrs, mins);
450 		else if (hrs > 0)
451 			(void)printf(" %d hr%s,", hrs, hrs > 1 ? "s" : "");
452 		else if (mins > 0)
453 			(void)printf(" %d min%s,", mins, mins > 1 ? "s" : "");
454 		else
455 			(void)printf(" %d sec%s,", secs, secs > 1 ? "s" : "");
456 	}
457 
458 	/* Print number of users logged in to system */
459 	(void)printf(" %d user%s", nusers, nusers == 1 ? "" : "s");
460 
461 	/*
462 	 * Print 1, 5, and 15 minute load averages.
463 	 */
464 	if (getloadavg(avenrun, sizeof(avenrun) / sizeof(avenrun[0])) == -1)
465 		(void)printf(", no load average information available\n");
466 	else {
467 		(void)printf(", load averages:");
468 		for (i = 0; i < (int)(sizeof(avenrun) / sizeof(avenrun[0])); i++) {
469 			if (use_comma && i > 0)
470 				(void)printf(",");
471 			(void)printf(" %.2f", avenrun[i]);
472 		}
473 		(void)printf("\n");
474 	}
475 }
476 
477 static struct stat *
478 ttystat(char *line, int sz)
479 {
480 	static struct stat sb;
481 	char ttybuf[MAXPATHLEN];
482 
483 	(void)snprintf(ttybuf, sizeof(ttybuf), "%s%.*s", _PATH_DEV, sz, line);
484 	if (stat(ttybuf, &sb) == 0) {
485 		return (&sb);
486 	} else
487 		return (NULL);
488 }
489 
490 static void
491 usage(int wcmd)
492 {
493 	if (wcmd)
494 		(void)fprintf(stderr,
495 		    "usage: w [-dhin] [-M core] [-N system] [user ...]\n");
496 	else
497 		(void)fprintf(stderr, "usage: uptime\n");
498 	exit(1);
499 }
500 
501 static int
502 this_is_uptime(const char *s)
503 {
504 	const char *u;
505 
506 	if ((u = strrchr(s, '/')) != NULL)
507 		++u;
508 	else
509 		u = s;
510 	if (strcmp(u, "uptime") == 0)
511 		return (0);
512 	return (-1);
513 }
514