xref: /freebsd/usr.sbin/sa/main.c (revision 94942af266ac119ede0ca836f9aa5a5ac0582938)
1 /*
2  * Copyright (c) 1994 Christopher G. Demetriou
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. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by Christopher G. Demetriou.
16  * 4. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #if 0
32 #ifndef lint
33 static const char copyright[] =
34 "@(#) Copyright (c) 1994 Christopher G. Demetriou\n\
35  All rights reserved.\n";
36 #endif
37 #endif
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
40 
41 /*
42  * sa:	system accounting
43  */
44 
45 #include <sys/types.h>
46 #include <sys/acct.h>
47 #include <ctype.h>
48 #include <err.h>
49 #include <fcntl.h>
50 #include <signal.h>
51 #include <stdint.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <string.h>
55 #include <unistd.h>
56 #include "extern.h"
57 #include "pathnames.h"
58 
59 static int	acct_load(const char *, int);
60 static u_quad_t	decode_comp_t(comp_t);
61 static int	cmp_comm(const char *, const char *);
62 static int	cmp_usrsys(const DBT *, const DBT *);
63 static int	cmp_avgusrsys(const DBT *, const DBT *);
64 static int	cmp_dkio(const DBT *, const DBT *);
65 static int	cmp_avgdkio(const DBT *, const DBT *);
66 static int	cmp_cpumem(const DBT *, const DBT *);
67 static int	cmp_avgcpumem(const DBT *, const DBT *);
68 static int	cmp_calls(const DBT *, const DBT *);
69 static void	usage(void);
70 
71 int aflag, bflag, cflag, dflag, Dflag, fflag, iflag, jflag, kflag;
72 int Kflag, lflag, mflag, qflag, rflag, sflag, tflag, uflag, vflag;
73 u_quad_t cutoff = 1;
74 const char *pdb_file = _PATH_SAVACCT;
75 const char *usrdb_file = _PATH_USRACCT;
76 
77 static char	*dfltargv[] = { NULL };
78 static int	dfltargc = (sizeof dfltargv/sizeof(char *));
79 
80 /* default to comparing by sum of user + system time */
81 cmpf_t   sa_cmp = cmp_usrsys;
82 
83 int
84 main(int argc, char **argv)
85 {
86 	char pathacct[] = _PATH_ACCT;
87 	int ch, error = 0;
88 
89 	dfltargv[0] = pathacct;
90 
91 	while ((ch = getopt(argc, argv, "abcdDfijkKlmnP:qrstuU:v:")) != -1)
92 		switch (ch) {
93 			case 'a':
94 				/* print all commands */
95 				aflag = 1;
96 				break;
97 			case 'b':
98 				/* sort by per-call user/system time average */
99 				bflag = 1;
100 				sa_cmp = cmp_avgusrsys;
101 				break;
102 			case 'c':
103 				/* print percentage total time */
104 				cflag = 1;
105 				break;
106 			case 'd':
107 				/* sort by averge number of disk I/O ops */
108 				dflag = 1;
109 				sa_cmp = cmp_avgdkio;
110 				break;
111 			case 'D':
112 				/* print and sort by total disk I/O ops */
113 				Dflag = 1;
114 				sa_cmp = cmp_dkio;
115 				break;
116 			case 'f':
117 				/* force no interactive threshold comprison */
118 				fflag = 1;
119 				break;
120 			case 'i':
121 				/* do not read in summary file */
122 				iflag = 1;
123 				break;
124 			case 'j':
125 				/* instead of total minutes, give sec/call */
126 				jflag = 1;
127 				break;
128 			case 'k':
129 				/* sort by cpu-time average memory usage */
130 				kflag = 1;
131 				sa_cmp = cmp_avgcpumem;
132 				break;
133 			case 'K':
134 				/* print and sort by cpu-storage integral */
135 				sa_cmp = cmp_cpumem;
136 				Kflag = 1;
137 				break;
138 			case 'l':
139 				/* separate system and user time */
140 				lflag = 1;
141 				break;
142 			case 'm':
143 				/* print procs and time per-user */
144 				mflag = 1;
145 				break;
146 			case 'n':
147 				/* sort by number of calls */
148 				sa_cmp = cmp_calls;
149 				break;
150 			case 'P':
151 				/* specify program database summary file */
152 				pdb_file = optarg;
153 				break;
154 			case 'q':
155 				/* quiet; error messages only */
156 				qflag = 1;
157 				break;
158 			case 'r':
159 				/* reverse order of sort */
160 				rflag = 1;
161 				break;
162 			case 's':
163 				/* merge accounting file into summaries */
164 				sflag = 1;
165 				break;
166 			case 't':
167 				/* report ratio of user and system times */
168 				tflag = 1;
169 				break;
170 			case 'u':
171 				/* first, print uid and command name */
172 				uflag = 1;
173 				break;
174 			case 'U':
175 				/* specify user database summary file */
176 				usrdb_file = optarg;
177 				break;
178 			case 'v':
179 				/* cull junk */
180 				vflag = 1;
181 				cutoff = atoi(optarg);
182 				break;
183 			case '?':
184 	                default:
185 				usage();
186 		}
187 
188 	argc -= optind;
189 	argv += optind;
190 
191 	/* various argument checking */
192 	if (fflag && !vflag)
193 		errx(1, "only one of -f requires -v");
194 	if (fflag && aflag)
195 		errx(1, "only one of -a and -v may be specified");
196 	/* XXX need more argument checking */
197 
198 	if (!uflag) {
199 		/* initialize tables */
200 		if ((sflag || (!mflag && !qflag)) && pacct_init() != 0)
201 			errx(1, "process accounting initialization failed");
202 		if ((sflag || (mflag && !qflag)) && usracct_init() != 0)
203 			errx(1, "user accounting initialization failed");
204 	}
205 
206 	if (argc == 0) {
207 		argc = dfltargc;
208 		argv = dfltargv;
209 	}
210 
211 	/* for each file specified */
212 	for (; argc > 0; argc--, argv++) {
213 		int	fd;
214 
215 		/*
216 		 * load the accounting data from the file.
217 		 * if it fails, go on to the next file.
218 		 */
219 		fd = acct_load(argv[0], sflag);
220 		if (fd < 0)
221 			continue;
222 
223 		if (!uflag && sflag) {
224 #ifndef DEBUG
225 			sigset_t nmask, omask;
226 			int unmask = 1;
227 
228 			/*
229 			 * block most signals so we aren't interrupted during
230 			 * the update.
231 			 */
232 			if (sigfillset(&nmask) == -1) {
233 				warn("sigfillset");
234 				unmask = 0;
235 				error = 1;
236 			}
237 			if (unmask &&
238 			    (sigprocmask(SIG_BLOCK, &nmask, &omask) == -1)) {
239 				warn("couldn't set signal mask");
240 				unmask = 0;
241 				error = 1;
242 			}
243 #endif /* DEBUG */
244 
245 			/*
246 			 * truncate the accounting data file ASAP, to avoid
247 			 * losing data.  don't worry about errors in updating
248 			 * the saved stats; better to underbill than overbill,
249 			 * but we want every accounting record intact.
250 			 */
251 			if (ftruncate(fd, 0) == -1) {
252 				warn("couldn't truncate %s", *argv);
253 				error = 1;
254 			}
255 
256 			/*
257 			 * update saved user and process accounting data.
258 			 * note errors for later.
259 			 */
260 			if (pacct_update() != 0 || usracct_update() != 0)
261 				error = 1;
262 
263 #ifndef DEBUG
264 			/*
265 			 * restore signals
266 			 */
267 			if (unmask &&
268 			    (sigprocmask(SIG_SETMASK, &omask, NULL) == -1)) {
269 				warn("couldn't restore signal mask");
270 				error = 1;
271 			}
272 #endif /* DEBUG */
273 		}
274 
275 		/*
276 		 * close the opened accounting file
277 		 */
278 		if (close(fd) == -1) {
279 			warn("close %s", *argv);
280 			error = 1;
281 		}
282 	}
283 
284 	if (!uflag && !qflag) {
285 		/* print any results we may have obtained. */
286 		if (!mflag)
287 			pacct_print();
288 		else
289 			usracct_print();
290 	}
291 
292 	if (!uflag) {
293 		/* finally, deallocate databases */
294 		if (sflag || (!mflag && !qflag))
295 			pacct_destroy();
296 		if (sflag || (mflag && !qflag))
297 			usracct_destroy();
298 	}
299 
300 	exit(error);
301 }
302 
303 static void
304 usage()
305 {
306 	(void)fprintf(stderr,
307 		"usage: sa [-abcdDfijkKlmnqrstu] [-P file] [-U file] [-v cutoff] [file ...]\n");
308 	exit(1);
309 }
310 
311 static int
312 acct_load(const char *pn, int wr)
313 {
314 	struct acct ac;
315 	struct cmdinfo ci;
316 	ssize_t rv;
317 	int fd, i;
318 
319 	/*
320 	 * open the file
321 	 */
322 	fd = open(pn, wr ? O_RDWR : O_RDONLY, 0);
323 	if (fd == -1) {
324 		warn("open %s %s", pn, wr ? "for read/write" : "read-only");
325 		return (-1);
326 	}
327 
328 	/*
329 	 * read all we can; don't stat and open because more processes
330 	 * could exit, and we'd miss them
331 	 */
332 	while (1) {
333 		/* get one accounting entry and punt if there's an error */
334 		rv = read(fd, &ac, sizeof(struct acct));
335 		if (rv == -1)
336 			warn("error reading %s", pn);
337 		else if (rv > 0 && rv < (int)sizeof(struct acct))
338 			warnx("short read of accounting data in %s", pn);
339 		if (rv != sizeof(struct acct))
340 			break;
341 
342 		/* decode it */
343 		ci.ci_calls = 1;
344 		for (i = 0; i < (int)sizeof ac.ac_comm && ac.ac_comm[i] != '\0';
345 		    i++) {
346 			char c = ac.ac_comm[i];
347 
348 			if (!isascii(c) || iscntrl(c)) {
349 				ci.ci_comm[i] = '?';
350 				ci.ci_flags |= CI_UNPRINTABLE;
351 			} else
352 				ci.ci_comm[i] = c;
353 		}
354 		if (ac.ac_flag & AFORK)
355 			ci.ci_comm[i++] = '*';
356 		ci.ci_comm[i++] = '\0';
357 		ci.ci_etime = decode_comp_t(ac.ac_etime);
358 		ci.ci_utime = decode_comp_t(ac.ac_utime);
359 		ci.ci_stime = decode_comp_t(ac.ac_stime);
360 		ci.ci_uid = ac.ac_uid;
361 		ci.ci_mem = ac.ac_mem;
362 		ci.ci_io = decode_comp_t(ac.ac_io) / AHZ;
363 
364 		if (!uflag) {
365 			/* and enter it into the usracct and pacct databases */
366 			if (sflag || (!mflag && !qflag))
367 				pacct_add(&ci);
368 			if (sflag || (mflag && !qflag))
369 				usracct_add(&ci);
370 		} else if (!qflag)
371 			printf("%6lu %12.2f cpu %12juk mem %12ju io %s\n",
372 			    ci.ci_uid,
373 			    (ci.ci_utime + ci.ci_stime) / (double) AHZ,
374 			    (uintmax_t)ci.ci_mem, (uintmax_t)ci.ci_io,
375 			    ci.ci_comm);
376 	}
377 
378 	/* finally, return the file descriptor for possible truncation */
379 	return (fd);
380 }
381 
382 static u_quad_t
383 decode_comp_t(comp_t comp)
384 {
385 	u_quad_t rv;
386 
387 	/*
388 	 * for more info on the comp_t format, see:
389 	 *	/usr/src/sys/kern/kern_acct.c
390 	 *	/usr/src/sys/sys/acct.h
391 	 *	/usr/src/usr.bin/lastcomm/lastcomm.c
392 	 */
393 	rv = comp & 0x1fff;	/* 13 bit fraction */
394 	comp >>= 13;		/* 3 bit base-8 exponent */
395 	while (comp--)
396 		rv <<= 3;
397 
398 	return (rv);
399 }
400 
401 /* sort commands, doing the right thing in terms of reversals */
402 static int
403 cmp_comm(const char *s1, const char *s2)
404 {
405 	int rv;
406 
407 	rv = strcmp(s1, s2);
408 	if (rv == 0)
409 		rv = -1;
410 	return (rflag ? rv : -rv);
411 }
412 
413 /* sort by total user and system time */
414 static int
415 cmp_usrsys(const DBT *d1, const DBT *d2)
416 {
417 	struct cmdinfo c1, c2;
418 	u_quad_t t1, t2;
419 
420 	memcpy(&c1, d1->data, sizeof(c1));
421 	memcpy(&c2, d2->data, sizeof(c2));
422 
423 	t1 = c1.ci_utime + c1.ci_stime;
424 	t2 = c2.ci_utime + c2.ci_stime;
425 
426 	if (t1 < t2)
427 		return -1;
428 	else if (t1 == t2)
429 		return (cmp_comm(c1.ci_comm, c2.ci_comm));
430 	else
431 		return 1;
432 }
433 
434 /* sort by average user and system time */
435 static int
436 cmp_avgusrsys(const DBT *d1, const DBT *d2)
437 {
438 	struct cmdinfo c1, c2;
439 	double t1, t2;
440 
441 	memcpy(&c1, d1->data, sizeof(c1));
442 	memcpy(&c2, d2->data, sizeof(c2));
443 
444 	t1 = c1.ci_utime + c1.ci_stime;
445 	t1 /= (double) (c1.ci_calls ? c1.ci_calls : 1);
446 
447 	t2 = c2.ci_utime + c2.ci_stime;
448 	t2 /= (double) (c2.ci_calls ? c2.ci_calls : 1);
449 
450 	if (t1 < t2)
451 		return -1;
452 	else if (t1 == t2)
453 		return (cmp_comm(c1.ci_comm, c2.ci_comm));
454 	else
455 		return 1;
456 }
457 
458 /* sort by total number of disk I/O operations */
459 static int
460 cmp_dkio(const DBT *d1, const DBT *d2)
461 {
462 	struct cmdinfo c1, c2;
463 
464 	memcpy(&c1, d1->data, sizeof(c1));
465 	memcpy(&c2, d2->data, sizeof(c2));
466 
467 	if (c1.ci_io < c2.ci_io)
468 		return -1;
469 	else if (c1.ci_io == c2.ci_io)
470 		return (cmp_comm(c1.ci_comm, c2.ci_comm));
471 	else
472 		return 1;
473 }
474 
475 /* sort by average number of disk I/O operations */
476 static int
477 cmp_avgdkio(const DBT *d1, const DBT *d2)
478 {
479 	struct cmdinfo c1, c2;
480 	double n1, n2;
481 
482 	memcpy(&c1, d1->data, sizeof(c1));
483 	memcpy(&c2, d2->data, sizeof(c2));
484 
485 	n1 = (double) c1.ci_io / (double) (c1.ci_calls ? c1.ci_calls : 1);
486 	n2 = (double) c2.ci_io / (double) (c2.ci_calls ? c2.ci_calls : 1);
487 
488 	if (n1 < n2)
489 		return -1;
490 	else if (n1 == n2)
491 		return (cmp_comm(c1.ci_comm, c2.ci_comm));
492 	else
493 		return 1;
494 }
495 
496 /* sort by the cpu-storage integral */
497 static int
498 cmp_cpumem(const DBT *d1, const DBT *d2)
499 {
500 	struct cmdinfo c1, c2;
501 
502 	memcpy(&c1, d1->data, sizeof(c1));
503 	memcpy(&c2, d2->data, sizeof(c2));
504 
505 	if (c1.ci_mem < c2.ci_mem)
506 		return -1;
507 	else if (c1.ci_mem == c2.ci_mem)
508 		return (cmp_comm(c1.ci_comm, c2.ci_comm));
509 	else
510 		return 1;
511 }
512 
513 /* sort by the cpu-time average memory usage */
514 static int
515 cmp_avgcpumem(const DBT *d1, const DBT *d2)
516 {
517 	struct cmdinfo c1, c2;
518 	u_quad_t t1, t2;
519 	double n1, n2;
520 
521 	memcpy(&c1, d1->data, sizeof(c1));
522 	memcpy(&c2, d2->data, sizeof(c2));
523 
524 	t1 = c1.ci_utime + c1.ci_stime;
525 	t2 = c2.ci_utime + c2.ci_stime;
526 
527 	n1 = (double) c1.ci_mem / (double) (t1 ? t1 : 1);
528 	n2 = (double) c2.ci_mem / (double) (t2 ? t2 : 1);
529 
530 	if (n1 < n2)
531 		return -1;
532 	else if (n1 == n2)
533 		return (cmp_comm(c1.ci_comm, c2.ci_comm));
534 	else
535 		return 1;
536 }
537 
538 /* sort by the number of invocations */
539 static int
540 cmp_calls(const DBT *d1, const DBT *d2)
541 {
542 	struct cmdinfo c1, c2;
543 
544 	memcpy(&c1, d1->data, sizeof(c1));
545 	memcpy(&c2, d2->data, sizeof(c2));
546 
547 	if (c1.ci_calls < c2.ci_calls)
548 		return -1;
549 	else if (c1.ci_calls == c2.ci_calls)
550 		return (cmp_comm(c1.ci_comm, c2.ci_comm));
551 	else
552 		return 1;
553 }
554