2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 1982, 1986, 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * Copyright (c) 2005 Robert N. M. Watson
10 * All or some portions of this file are derived from material licensed
11 * to the University of California by American Telephone and Telegraph
12 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
13 * the permission of UNIX System Laboratories, Inc.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * Copyright (c) 1994 Christopher G. Demetriou
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
44 * 1. Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
49 * 3. All advertising materials mentioning features or use of this software
50 * must display the following acknowledgement:
51 * This product includes software developed by the University of
52 * California, Berkeley and its contributors.
53 * 4. Neither the name of the University nor the names of its contributors
54 * may be used to endorse or promote products derived from this software
55 * without specific prior written permission.
57 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
58 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
61 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
62 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
63 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
65 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * @(#)kern_acct.c 8.1 (Berkeley) 6/14/93
72 #include <sys/cdefs.h>
73 __FBSDID("$FreeBSD$");
75 #include <sys/param.h>
76 #include <sys/systm.h>
78 #include <sys/fcntl.h>
79 #include <sys/kernel.h>
80 #include <sys/kthread.h>
81 #include <sys/limits.h>
83 #include <sys/malloc.h>
84 #include <sys/mount.h>
85 #include <sys/mutex.h>
86 #include <sys/namei.h>
89 #include <sys/resourcevar.h>
90 #include <sys/sched.h>
92 #include <sys/sysctl.h>
93 #include <sys/sysent.h>
94 #include <sys/syslog.h>
95 #include <sys/sysproto.h>
97 #include <sys/vnode.h>
99 #include <security/mac/mac_framework.h>
101 _Static_assert(sizeof(struct acctv3) - offsetof(struct acctv3, ac_trailer) ==
102 sizeof(struct acctv2) - offsetof(struct acctv2, ac_trailer), "trailer");
103 _Static_assert(sizeof(struct acctv3) - offsetof(struct acctv3, ac_len2) ==
104 sizeof(struct acctv2) - offsetof(struct acctv2, ac_len2), "len2");
107 * The routines implemented in this file are described in:
108 * Leffler, et al.: The Design and Implementation of the 4.3BSD
109 * UNIX Operating System (Addison Welley, 1989)
111 * On May 2007 the historic 3 bits base 8 exponent, 13 bit fraction
112 * compt_t representation described in the above reference was replaced
113 * with that of IEEE-754 floats.
115 * Arguably, to simplify accounting operations, this mechanism should
116 * be replaced by one in which an accounting log file (similar to /dev/klog)
117 * is read by a user process, etc. However, that has its own problems.
120 /* Floating point definitions from <float.h>. */
121 #define FLT_MANT_DIG 24 /* p */
122 #define FLT_MAX_EXP 128 /* emax */
125 * Internal accounting functions.
126 * The former's operation is described in Leffler, et al., and the latter
127 * was provided by UCB with the 4.4BSD-Lite release
129 static uint32_t encode_timeval(struct timeval);
130 static uint32_t encode_long(long);
131 static void acctwatch(void);
132 static void acct_thread(void *);
133 static int acct_disable(struct thread *, int);
136 * Accounting vnode pointer, saved vnode pointer, and flags for each.
137 * acct_sx protects against changes to the active vnode and credentials
138 * while accounting records are being committed to disk.
140 static int acct_configured;
141 static int acct_suspended;
142 static struct vnode *acct_vp;
143 static struct ucred *acct_cred;
144 static int acct_flags;
145 static struct sx acct_sx;
147 SX_SYSINIT(acct, &acct_sx, "acct_sx");
150 * State of the accounting kthread.
152 static int acct_state;
154 #define ACCT_RUNNING 1 /* Accounting kthread is running. */
155 #define ACCT_EXITREQ 2 /* Accounting kthread should exit. */
158 * Values associated with enabling and disabling accounting
160 static int acctsuspend = 2; /* stop accounting when < 2% free space left */
161 SYSCTL_INT(_kern, OID_AUTO, acct_suspend, CTLFLAG_RW,
162 &acctsuspend, 0, "percentage of free disk space below which accounting stops");
164 static int acctresume = 4; /* resume when free space risen to > 4% */
165 SYSCTL_INT(_kern, OID_AUTO, acct_resume, CTLFLAG_RW,
166 &acctresume, 0, "percentage of free disk space above which accounting resumes");
168 static int acctchkfreq = 15; /* frequency (in seconds) to check space */
171 sysctl_acct_chkfreq(SYSCTL_HANDLER_ARGS)
175 /* Write out the old value. */
176 error = SYSCTL_OUT(req, &acctchkfreq, sizeof(int));
177 if (error || req->newptr == NULL)
180 /* Read in and verify the new value. */
181 error = SYSCTL_IN(req, &value, sizeof(int));
189 SYSCTL_PROC(_kern, OID_AUTO, acct_chkfreq,
190 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_NEEDGIANT, &acctchkfreq, 0,
191 sysctl_acct_chkfreq, "I",
192 "frequency for checking the free space");
194 SYSCTL_INT(_kern, OID_AUTO, acct_configured, CTLFLAG_RD, &acct_configured, 0,
195 "Accounting configured or not");
197 SYSCTL_INT(_kern, OID_AUTO, acct_suspended, CTLFLAG_RD, &acct_suspended, 0,
198 "Accounting suspended or not");
201 * Accounting system call. Written based on the specification and previous
202 * implementation done by Mark Tinguely.
205 sys_acct(struct thread *td, struct acct_args *uap)
208 int error, flags, replacing;
210 error = priv_check(td, PRIV_ACCT);
215 * If accounting is to be started to a file, open that file for
216 * appending and make sure it's a 'normal'.
218 if (uap->path != NULL) {
219 NDINIT(&nd, LOOKUP, NOFOLLOW | AUDITVNODE1,
220 UIO_USERSPACE, uap->path, td);
221 flags = FWRITE | O_APPEND;
222 error = vn_open(&nd, &flags, 0, NULL);
225 NDFREE(&nd, NDF_ONLY_PNBUF);
227 error = mac_system_check_acct(td->td_ucred, nd.ni_vp);
229 VOP_UNLOCK(nd.ni_vp);
230 vn_close(nd.ni_vp, flags, td->td_ucred, td);
234 VOP_UNLOCK(nd.ni_vp);
235 if (nd.ni_vp->v_type != VREG) {
236 vn_close(nd.ni_vp, flags, td->td_ucred, td);
241 error = mac_system_check_acct(td->td_ucred, NULL);
248 * Disallow concurrent access to the accounting vnode while we swap
249 * it out, in order to prevent access after close.
254 * Don't log spurious disable/enable messages if we are
255 * switching from one accounting file to another due to log
258 replacing = (acct_vp != NULL && uap->path != NULL);
261 * If accounting was previously enabled, kill the old space-watcher,
262 * close the file, and (if no new file was specified, leave). Reset
263 * the suspended state regardless of whether accounting remains
268 error = acct_disable(td, !replacing);
269 if (uap->path == NULL) {
270 if (acct_state & ACCT_RUNNING) {
271 acct_state |= ACCT_EXITREQ;
274 sx_xunlock(&acct_sx);
279 * Save the new accounting file vnode, and schedule the new
280 * free space watcher.
283 acct_cred = crhold(td->td_ucred);
285 if (acct_state & ACCT_RUNNING)
286 acct_state &= ~ACCT_EXITREQ;
289 * Try to start up an accounting kthread. We may start more
290 * than one, but if so the extras will commit suicide as
291 * soon as they start up.
293 error = kproc_create(acct_thread, NULL, NULL, 0, 0,
296 (void) acct_disable(td, 0);
297 sx_xunlock(&acct_sx);
298 log(LOG_NOTICE, "Unable to start accounting thread\n");
303 sx_xunlock(&acct_sx);
305 log(LOG_NOTICE, "Accounting enabled\n");
310 * Disable currently in-progress accounting by closing the vnode, dropping
311 * our reference to the credential, and clearing the vnode's flags.
314 acct_disable(struct thread *td, int logging)
318 sx_assert(&acct_sx, SX_XLOCKED);
319 error = vn_close(acct_vp, acct_flags, acct_cred, td);
326 log(LOG_NOTICE, "Accounting disabled\n");
331 * Write out process accounting information, on process exit.
332 * Data to be written out is specified in Leffler, et al.
333 * and are enumerated below. (They're also noted in the system
334 * "acct.h" header file.)
337 acct_process(struct thread *td)
340 struct timeval ut, st, tmp;
346 * Lockless check of accounting condition before doing the hard
349 if (acct_vp == NULL || acct_suspended)
352 memset(&acct, 0, sizeof(acct));
357 * If accounting isn't enabled, don't bother. Have to check again
358 * once we own the lock in case we raced with disabling of accounting
361 if (acct_vp == NULL || acct_suspended) {
362 sx_sunlock(&acct_sx);
367 td->td_pflags2 |= TDP2_ACCT;
370 * Get process accounting information.
373 sx_slock(&proctree_lock);
376 /* (1) The terminal from which the process was started */
377 if ((p->p_flag & P_CONTROLT) && p->p_pgrp->pg_session->s_ttyp)
378 acct.ac_tty = tty_udev(p->p_pgrp->pg_session->s_ttyp);
381 sx_sunlock(&proctree_lock);
383 /* (2) The name of the command that ran */
384 bcopy(p->p_comm, acct.ac_comm, sizeof acct.ac_comm);
386 /* (3) The amount of user and system time that was used */
387 rufetchcalc(p, &ru, &ut, &st);
388 acct.ac_utime = encode_timeval(ut);
389 acct.ac_stime = encode_timeval(st);
391 /* (4) The elapsed time the command ran (and its starting time) */
393 timevaladd(&tmp, &p->p_stats->p_start);
394 acct.ac_btime = tmp.tv_sec;
396 timevalsub(&tmp, &p->p_stats->p_start);
397 acct.ac_etime = encode_timeval(tmp);
399 /* (5) The average amount of memory used */
401 timevaladd(&tmp, &st);
402 /* Convert tmp (i.e. u + s) into hz units to match ru_i*. */
403 t = tmp.tv_sec * hz + tmp.tv_usec / tick;
405 acct.ac_mem = encode_long((ru.ru_ixrss + ru.ru_idrss +
410 /* (6) The number of disk I/O operations done */
411 acct.ac_io = encode_long(ru.ru_inblock + ru.ru_oublock);
413 /* (7) The UID and GID of the process */
414 acct.ac_uid = p->p_ucred->cr_ruid;
415 acct.ac_gid = p->p_ucred->cr_rgid;
417 /* (8) The boolean flags that tell how the process terminated, etc. */
418 acct.ac_flagx = p->p_acflag;
422 /* Setup ancillary structure fields. */
423 acct.ac_flagx |= ANVER;
426 acct.ac_len = acct.ac_len2 = sizeof(acct);
429 * Write the accounting information to the file.
431 ret = vn_rdwr(UIO_WRITE, acct_vp, (caddr_t)&acct, sizeof (acct),
432 (off_t)0, UIO_SYSSPACE, IO_APPEND|IO_UNIT, acct_cred, NOCRED,
434 sx_sunlock(&acct_sx);
435 td->td_pflags2 &= ~TDP2_ACCT;
439 /* FLOAT_CONVERSION_START (Regression testing; don't remove this line.) */
441 /* Convert timevals and longs into IEEE-754 bit patterns. */
443 /* Mantissa mask (MSB is implied, so subtract 1). */
444 #define MANT_MASK ((1 << (FLT_MANT_DIG - 1)) - 1)
447 * We calculate integer values to a precision of approximately
449 * This is high-enough precision to fill the 24 float bits
450 * and low-enough to avoid overflowing the 32 int bits.
454 /* log_2(1000000). */
458 * Convert the elements of a timeval into a 32-bit word holding
459 * the bits of a IEEE-754 float.
460 * The float value represents the timeval's value in microsecond units.
463 encode_timeval(struct timeval tv)
466 int val, exp; /* Unnormalized value and exponent */
467 int norm_exp; /* Normalized exponent */
471 * First calculate value and exponent to about CALC_BITS precision.
472 * Note that the following conditionals have been ordered so that
473 * the most common cases appear first.
475 if (tv.tv_sec == 0) {
482 * Calculate the value to a precision of approximately
485 log2_s = fls(tv.tv_sec) - 1;
486 if (log2_s + LOG2_1M < CALC_BITS) {
488 val = 1000000 * tv.tv_sec + tv.tv_usec;
490 exp = log2_s + LOG2_1M - CALC_BITS;
491 val = (unsigned int)(((uint64_t)1000000 * tv.tv_sec +
495 /* Now normalize and pack the value into an IEEE-754 float. */
496 norm_exp = fls(val) - 1;
497 shift = FLT_MANT_DIG - norm_exp - 1;
499 printf("val=%d exp=%d shift=%d log2(val)=%d\n",
500 val, exp, shift, norm_exp);
501 printf("exp=%x mant=%x\n", FLT_MAX_EXP - 1 + exp + norm_exp,
502 ((shift > 0 ? (val << shift) : (val >> -shift)) & MANT_MASK));
504 return (((FLT_MAX_EXP - 1 + exp + norm_exp) << (FLT_MANT_DIG - 1)) |
505 ((shift > 0 ? val << shift : val >> -shift) & MANT_MASK));
509 * Convert a non-negative long value into the bit pattern of
510 * an IEEE-754 float value.
513 encode_long(long val)
515 int norm_exp; /* Normalized exponent */
522 "encode_long: negative value %ld in accounting record\n",
526 norm_exp = fls(val) - 1;
527 shift = FLT_MANT_DIG - norm_exp - 1;
529 printf("val=%d shift=%d log2(val)=%d\n",
530 val, shift, norm_exp);
531 printf("exp=%x mant=%x\n", FLT_MAX_EXP - 1 + exp + norm_exp,
532 ((shift > 0 ? (val << shift) : (val >> -shift)) & MANT_MASK));
534 return (((FLT_MAX_EXP - 1 + norm_exp) << (FLT_MANT_DIG - 1)) |
535 ((shift > 0 ? val << shift : val >> -shift) & MANT_MASK));
538 /* FLOAT_CONVERSION_END (Regression testing; don't remove this line.) */
541 * Periodically check the filesystem to see if accounting
542 * should be turned on or off. Beware the case where the vnode
543 * has been vgone()'d out from underneath us, e.g. when the file
544 * system containing the accounting file has been forcibly unmounted.
552 sx_assert(&acct_sx, SX_XLOCKED);
555 * If accounting was disabled before our kthread was scheduled,
556 * then acct_vp might be NULL. If so, just ask our kthread to
559 if (acct_vp == NULL) {
560 acct_state |= ACCT_EXITREQ;
565 * If our vnode is no longer valid, tear it down and signal the
566 * accounting thread to die.
568 if (acct_vp->v_type == VBAD) {
569 (void) acct_disable(NULL, 1);
570 acct_state |= ACCT_EXITREQ;
575 * Stopping here is better than continuing, maybe it will be VBAD
578 sp = malloc(sizeof(struct statfs), M_STATFS, M_WAITOK);
579 if (VFS_STATFS(acct_vp->v_mount, sp) < 0) {
583 if (acct_suspended) {
584 if (sp->f_bavail > (int64_t)(acctresume * sp->f_blocks /
587 log(LOG_NOTICE, "Accounting resumed\n");
590 if (sp->f_bavail <= (int64_t)(acctsuspend * sp->f_blocks /
593 log(LOG_NOTICE, "Accounting suspended\n");
600 * The main loop for the dedicated kernel thread that periodically calls
604 acct_thread(void *dummy)
608 /* This is a low-priority kernel thread. */
610 thread_lock(curthread);
611 sched_prio(curthread, pri);
612 thread_unlock(curthread);
614 /* If another accounting kthread is already running, just die. */
616 if (acct_state & ACCT_RUNNING) {
617 sx_xunlock(&acct_sx);
620 acct_state |= ACCT_RUNNING;
622 /* Loop until we are asked to exit. */
623 while (!(acct_state & ACCT_EXITREQ)) {
624 /* Perform our periodic checks. */
628 * We check this flag again before sleeping since the
629 * acctwatch() might have shut down accounting and asked us
632 if (!(acct_state & ACCT_EXITREQ)) {
633 sx_sleep(&acct_state, &acct_sx, 0, "-",
639 * Acknowledge the exit request and shutdown. We clear both the
640 * exit request and running flags.
643 sx_xunlock(&acct_sx);