xref: /freebsd/usr.bin/w/w.c (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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 #ifndef lint
35 static const char copyright[] =
36 "@(#) Copyright (c) 1980, 1991, 1993, 1994\n\
37 	The Regents of the University of California.  All rights reserved.\n";
38 #endif /* not lint */
39 
40 #ifndef lint
41 #if 0
42 static char sccsid[] = "@(#)w.c	8.4 (Berkeley) 4/16/94";
43 #endif
44 static const char rcsid[] =
45   "$FreeBSD$";
46 #endif /* not lint */
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 
68 #include <ctype.h>
69 #include <err.h>
70 #include <errno.h>
71 #include <fcntl.h>
72 #include <kvm.h>
73 #include <netdb.h>
74 #include <nlist.h>
75 #include <paths.h>
76 #include <stdio.h>
77 #include <stdlib.h>
78 #include <string.h>
79 #include <unistd.h>
80 #include <utmp.h>
81 #include <vis.h>
82 #include <locale.h>
83 
84 #include <arpa/nameser.h>
85 #include <resolv.h>
86 
87 #include "extern.h"
88 
89 struct timeval	boottime;
90 struct utmp	utmp;
91 struct winsize	ws;
92 kvm_t	       *kd;
93 time_t		now;		/* the current time of day */
94 time_t		uptime;		/* time of last reboot & elapsed time since */
95 int		ttywidth;	/* width of tty */
96 int		argwidth;	/* width of tty */
97 int		header = 1;	/* true if -h flag: don't print heading */
98 int		nflag;		/* true if -n flag: don't convert addrs */
99 int		dflag;		/* true if -d flag: output debug info */
100 int		sortidle;	/* sort by idle time */
101 char	      **sel_users;	/* login array of particular users selected */
102 char		domain[MAXHOSTNAMELEN];
103 
104 /*
105  * One of these per active utmp entry.
106  */
107 struct	entry {
108 	struct	entry *next;
109 	struct	utmp utmp;
110 	dev_t	tdev;			/* dev_t of terminal */
111 	time_t	idle;			/* idle time of terminal in seconds */
112 	struct	kinfo_proc *kp;		/* `most interesting' proc */
113 	char	*args;			/* arg list of interesting process */
114 	struct	kinfo_proc *dkp;	/* debug option proc list */
115 } *ep, *ehead = NULL, **nextp = &ehead;
116 
117 #define debugproc(p) *((struct kinfo_proc **)&(p)->kp_eproc.e_spare[0])
118 
119 static void		 pr_header __P((time_t *, int));
120 static struct stat	*ttystat __P((char *, int));
121 static void		 usage __P((int));
122 static int		 this_is_uptime __P((const char *s));
123 
124 char *fmt_argv __P((char **, char *, int));	/* ../../bin/ps/fmt.c */
125 
126 int
127 main(argc, argv)
128 	int argc;
129 	char **argv;
130 {
131 	struct kinfo_proc *kp;
132 	struct kinfo_proc *dkp;
133 	struct hostent *hp;
134 	struct stat *stp;
135 	FILE *ut;
136 	u_long l;
137 	int ch, i, nentries, nusers, wcmd, longidle, dropgid;
138 	char *memf, *nlistf, *p, *x;
139 	char buf[MAXHOSTNAMELEN], errbuf[256];
140 
141 	(void)setlocale(LC_ALL, "");
142 
143 	/* Are we w(1) or uptime(1)? */
144 	if (this_is_uptime(argv[0]) == 0) {
145 		wcmd = 0;
146 		p = "";
147 	} else {
148 		wcmd = 1;
149 		p = "dhiflM:N:nsuw";
150 	}
151 
152 	dropgid = 0;
153 	memf = nlistf = _PATH_DEVNULL;
154 	while ((ch = getopt(argc, argv, p)) != -1)
155 		switch (ch) {
156 		case 'd':
157 			dflag = 1;
158 			break;
159 		case 'h':
160 			header = 0;
161 			break;
162 		case 'i':
163 			sortidle = 1;
164 			break;
165 		case 'M':
166 			header = 0;
167 			memf = optarg;
168 			dropgid = 1;
169 			break;
170 		case 'N':
171 			nlistf = optarg;
172 			dropgid = 1;
173 			break;
174 		case 'n':
175 			nflag = 1;
176 			break;
177 		case 'f': case 'l': case 's': case 'u': case 'w':
178 			warnx("[-flsuw] no longer supported");
179 			/* FALLTHROUGH */
180 		case '?':
181 		default:
182 			usage(wcmd);
183 		}
184 	argc -= optind;
185 	argv += optind;
186 
187 	if (!(_res.options & RES_INIT))
188 		res_init();
189 	_res.retrans = 2;	/* resolver timeout to 2 seconds per try */
190 	_res.retry = 1;		/* only try once.. */
191 
192 	/*
193 	 * Discard setgid privileges if not the running kernel so that bad
194 	 * guys can't print interesting stuff from kernel memory.
195 	 */
196 	if (dropgid)
197 		setgid(getgid());
198 
199 	if ((kd = kvm_openfiles(nlistf, memf, NULL, O_RDONLY, errbuf)) == NULL)
200 		errx(1, "%s", errbuf);
201 
202 	(void)time(&now);
203 	if ((ut = fopen(_PATH_UTMP, "r")) == NULL)
204 		err(1, "%s", _PATH_UTMP);
205 
206 	if (*argv)
207 		sel_users = argv;
208 
209 	for (nusers = 0; fread(&utmp, sizeof(utmp), 1, ut);) {
210 		if (utmp.ut_name[0] == '\0')
211 			continue;
212 		if (!(stp = ttystat(utmp.ut_line, UT_LINESIZE)))
213 			continue;	/* corrupted record */
214 		++nusers;
215 		if (wcmd == 0)
216 			continue;
217 		if (sel_users) {
218 			int usermatch;
219 			char **user;
220 
221 			usermatch = 0;
222 			for (user = sel_users; !usermatch && *user; user++)
223 				if (!strncmp(utmp.ut_name, *user, UT_NAMESIZE))
224 					usermatch = 1;
225 			if (!usermatch)
226 				continue;
227 		}
228 		if ((ep = calloc(1, sizeof(struct entry))) == NULL)
229 			errx(1, "calloc");
230 		*nextp = ep;
231 		nextp = &ep->next;
232 		memmove(&ep->utmp, &utmp, sizeof(struct utmp));
233 		ep->tdev = stp->st_rdev;
234 #ifdef CPU_CONSDEV
235 		/*
236 		 * If this is the console device, attempt to ascertain
237 		 * the true console device dev_t.
238 		 */
239 		if (ep->tdev == 0) {
240 			int mib[2];
241 			size_t size;
242 
243 			mib[0] = CTL_MACHDEP;
244 			mib[1] = CPU_CONSDEV;
245 			size = sizeof(dev_t);
246 			(void)sysctl(mib, 2, &ep->tdev, &size, NULL, 0);
247 		}
248 #endif
249 		if ((ep->idle = now - stp->st_atime) < 0)
250 			ep->idle = 0;
251 	}
252 	(void)fclose(ut);
253 
254 	if (header || wcmd == 0) {
255 		pr_header(&now, nusers);
256 		if (wcmd == 0)
257 			exit(0);
258 
259 #define HEADER_USER		"USER"
260 #define HEADER_TTY		"TTY"
261 #define HEADER_FROM		"FROM"
262 #define HEADER_LOGIN_IDLE	"LOGIN@  IDLE "
263 #define HEADER_WHAT		"WHAT\n"
264 #define WUSED  (UT_NAMESIZE + UT_LINESIZE + UT_HOSTSIZE + \
265 		sizeof(HEADER_LOGIN_IDLE) + 3)	/* header width incl. spaces */
266 		(void)printf("%-*.*s %-*.*s %-*.*s  %s",
267 				UT_NAMESIZE, UT_NAMESIZE, HEADER_USER,
268 				UT_LINESIZE, UT_LINESIZE, HEADER_TTY,
269 				UT_HOSTSIZE, UT_HOSTSIZE, HEADER_FROM,
270 				HEADER_LOGIN_IDLE HEADER_WHAT);
271 	}
272 
273 	if ((kp = kvm_getprocs(kd, KERN_PROC_ALL, 0, &nentries)) == NULL)
274 		err(1, "%s", kvm_geterr(kd));
275 	for (i = 0; i < nentries; i++, kp++) {
276 		struct proc *pr = &kp->kp_proc;
277 		struct eproc *e;
278 
279 		if (pr->p_stat == SIDL || pr->p_stat == SZOMB)
280 			continue;
281 		e = &kp->kp_eproc;
282 		for (ep = ehead; ep != NULL; ep = ep->next) {
283 			if (ep->tdev == e->e_tdev) {
284 				/*
285 				 * proc is associated with this terminal
286 				 */
287 				if (ep->kp == NULL && e->e_pgid == e->e_tpgid) {
288 					/*
289 					 * Proc is 'most interesting'
290 					 */
291 					if (proc_compare(&ep->kp->kp_proc, pr))
292 						ep->kp = kp;
293 				}
294 				/*
295 				 * Proc debug option info; add to debug
296 				 * list using kinfo_proc kp_eproc.e_spare
297 				 * as next pointer; ptr to ptr avoids the
298 				 * ptr = long assumption.
299 				 */
300 				dkp = ep->dkp;
301 				ep->dkp = kp;
302 				debugproc(kp) = dkp;
303 			}
304 		}
305 	}
306 	if ((ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == -1 &&
307 	     ioctl(STDERR_FILENO, TIOCGWINSZ, &ws) == -1 &&
308 	     ioctl(STDIN_FILENO, TIOCGWINSZ, &ws) == -1) || ws.ws_col == 0)
309 	       ttywidth = 79;
310         else
311 	       ttywidth = ws.ws_col - 1;
312 	argwidth = ttywidth - WUSED;
313 	if (argwidth < 4)
314 		argwidth = 8;
315 	for (ep = ehead; ep != NULL; ep = ep->next) {
316 		if (ep->kp == NULL) {
317 			ep->args = "-";
318 			continue;
319 		}
320 		ep->args = fmt_argv(kvm_getargv(kd, ep->kp, argwidth),
321 		    ep->kp->kp_proc.p_comm, MAXCOMLEN);
322 		if (ep->args == NULL)
323 			err(1, NULL);
324 	}
325 	/* sort by idle time */
326 	if (sortidle && ehead != NULL) {
327 		struct entry *from, *save;
328 
329 		from = ehead;
330 		ehead = NULL;
331 		while (from != NULL) {
332 			for (nextp = &ehead;
333 			    (*nextp) && from->idle >= (*nextp)->idle;
334 			    nextp = &(*nextp)->next)
335 				continue;
336 			save = from;
337 			from = from->next;
338 			save->next = *nextp;
339 			*nextp = save;
340 		}
341 	}
342 
343 	if (!nflag) {
344 		if (gethostname(domain, sizeof(domain) - 1) < 0 ||
345 		    (p = strchr(domain, '.')) == NULL)
346 			domain[0] = '\0';
347 		else {
348 			domain[sizeof(domain) - 1] = '\0';
349 			memmove(domain, p, strlen(p) + 1);
350 		}
351 	}
352 
353 	for (ep = ehead; ep != NULL; ep = ep->next) {
354 		char host_buf[UT_HOSTSIZE + 1];
355 
356 		host_buf[UT_HOSTSIZE] = '\0';
357 		strncpy(host_buf, ep->utmp.ut_host, UT_HOSTSIZE);
358 		p = *host_buf ? host_buf : "-";
359 		if ((x = strchr(p, ':')) != NULL)
360 			*x++ = '\0';
361 		if (!nflag && isdigit(*p) && (l = inet_addr(p)) != -1 &&
362 		    (hp = gethostbyaddr((char *)&l, sizeof(l), AF_INET))) {
363 			if (domain[0] != '\0') {
364 				p = hp->h_name;
365 				p += strlen(hp->h_name);
366 				p -= strlen(domain);
367 				if (p > hp->h_name && strcmp(p, domain) == 0)
368 					*p = '\0';
369 			}
370 			p = hp->h_name;
371 		}
372 		if (nflag && *p && strcmp(p, "-") &&
373 		    inet_addr(p) == INADDR_NONE) {
374 			hp = gethostbyname(p);
375 
376 			if (hp != NULL) {
377 				struct in_addr in;
378 
379 				memmove(&in, hp->h_addr, sizeof(in));
380 				p = inet_ntoa(in);
381 			}
382 		}
383 		if (x) {
384 			(void)snprintf(buf, sizeof(buf), "%s:%s", p, x);
385 			p = buf;
386 		}
387 		if (dflag) {
388 			for (dkp = ep->dkp; dkp != NULL; dkp = debugproc(dkp)) {
389 				char *ptr;
390 
391 				ptr = fmt_argv(kvm_getargv(kd, dkp, argwidth),
392 				    dkp->kp_proc.p_comm, MAXCOMLEN);
393 				if (ptr == NULL)
394 					ptr = "-";
395 				(void)printf("\t\t%-9d %s\n",
396 				    dkp->kp_proc.p_pid, ptr);
397 			}
398 		}
399 		(void)printf("%-*.*s %-*.*s %-*.*s ",
400 		    UT_NAMESIZE, UT_NAMESIZE, ep->utmp.ut_name,
401 		    UT_LINESIZE, UT_LINESIZE,
402 		    strncmp(ep->utmp.ut_line, "tty", 3) &&
403 		    strncmp(ep->utmp.ut_line, "cua", 3) ?
404 		    ep->utmp.ut_line : ep->utmp.ut_line + 3,
405 		    UT_HOSTSIZE, UT_HOSTSIZE, *p ? p : "-");
406 		pr_attime(&ep->utmp.ut_time, &now);
407 		longidle = pr_idle(ep->idle);
408 		(void)printf("%.*s\n", argwidth - longidle, ep->args);
409 	}
410 	exit(0);
411 }
412 
413 static void
414 pr_header(nowp, nusers)
415 	time_t *nowp;
416 	int nusers;
417 {
418 	double avenrun[3];
419 	time_t uptime;
420 	int days, hrs, i, mins, secs;
421 	int mib[2];
422 	size_t size;
423 	char buf[256];
424 
425 	/*
426 	 * Print time of day.
427 	 */
428 	(void)strftime(buf, sizeof(buf) - 1, "%l:%M%p", localtime(nowp));
429 	buf[sizeof(buf) - 1] = '\0';
430 	(void)printf("%s ", buf);
431 
432 	/*
433 	 * Print how long system has been up.
434 	 * (Found by looking getting "boottime" from the kernel)
435 	 */
436 	mib[0] = CTL_KERN;
437 	mib[1] = KERN_BOOTTIME;
438 	size = sizeof(boottime);
439 	if (sysctl(mib, 2, &boottime, &size, NULL, 0) != -1 &&
440 	    boottime.tv_sec != 0) {
441 		uptime = now - boottime.tv_sec;
442 		uptime += 30;
443 		days = uptime / 86400;
444 		uptime %= 86400;
445 		hrs = uptime / 3600;
446 		uptime %= 3600;
447 		mins = uptime / 60;
448 		secs = uptime % 60;
449 		(void)printf(" up");
450 		if (days > 0)
451 			(void)printf(" %d day%s,", days, days > 1 ? "s" : "");
452 		if (hrs > 0 && mins > 0)
453 			(void)printf(" %2d:%02d,", hrs, mins);
454 		else if (hrs > 0)
455 			(void)printf(" %d hr%s,", hrs, hrs > 1 ? "s" : "");
456 		else if (mins > 0)
457 			(void)printf(" %d min%s,", mins, mins > 1 ? "s" : "");
458 		else
459 			(void)printf(" %d sec%s,", secs, secs > 1 ? "s" : "");
460 	}
461 
462 	/* Print number of users logged in to system */
463 	(void)printf(" %d user%s", nusers, nusers == 1 ? "" : "s");
464 
465 	/*
466 	 * Print 1, 5, and 15 minute load averages.
467 	 */
468 	if (getloadavg(avenrun, sizeof(avenrun) / sizeof(avenrun[0])) == -1)
469 		(void)printf(", no load average information available\n");
470 	else {
471 		(void)printf(", load averages:");
472 		for (i = 0; i < (sizeof(avenrun) / sizeof(avenrun[0])); i++)
473 			(void)printf("%s %.2f", i > 0 ? "," : "", avenrun[i]);
474 		(void)printf("\n");
475 	}
476 }
477 
478 static struct stat *
479 ttystat(line, sz)
480 	char *line;
481 	int sz;
482 {
483 	static struct stat sb;
484 	char ttybuf[MAXPATHLEN];
485 
486 	(void)snprintf(ttybuf, sizeof(ttybuf), "%s%.*s", _PATH_DEV, sz, line);
487 	if (stat(ttybuf, &sb)) {
488 		warn("%s", ttybuf);
489 		return (NULL);
490 	}
491 	return (&sb);
492 }
493 
494 static void
495 usage(wcmd)
496 	int wcmd;
497 {
498 	if (wcmd)
499 		(void)fprintf(stderr,
500 		    "usage: w [-dhin] [-M core] [-N system] [user ...]\n");
501 	else
502 		(void)fprintf(stderr, "usage: uptime\n");
503 	exit(1);
504 }
505 
506 static int
507 this_is_uptime(s)
508 	const char *s;
509 {
510 	const char *u;
511 
512 	if ((u = strrchr(s, '/')) != NULL)
513 		++u;
514 	else
515 		u = s;
516 	if (strcmp(u, "uptime") == 0)
517 		return (0);
518 	return (-1);
519 }
520