2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * Copyright (c) 2005 Robert N. M. Watson
8 * All or some portions of this file are derived from material licensed
9 * to the University of California by American Telephone and Telegraph
10 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
11 * the permission of UNIX System Laboratories, Inc.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 4. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Copyright (c) 1994 Christopher G. Demetriou
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
42 * 1. Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * 2. Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in the
46 * documentation and/or other materials provided with the distribution.
47 * 3. All advertising materials mentioning features or use of this software
48 * must display the following acknowledgement:
49 * This product includes software developed by the University of
50 * California, Berkeley and its contributors.
51 * 4. Neither the name of the University nor the names of its contributors
52 * may be used to endorse or promote products derived from this software
53 * without specific prior written permission.
55 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
56 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
57 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
58 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
59 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
60 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
61 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
62 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
63 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
64 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67 * @(#)kern_acct.c 8.1 (Berkeley) 6/14/93
70 #include <sys/cdefs.h>
71 __FBSDID("$FreeBSD$");
73 #include <sys/param.h>
74 #include <sys/systm.h>
76 #include <sys/fcntl.h>
77 #include <sys/kernel.h>
78 #include <sys/kthread.h>
79 #include <sys/limits.h>
81 #include <sys/mount.h>
82 #include <sys/mutex.h>
83 #include <sys/namei.h>
86 #include <sys/resourcevar.h>
87 #include <sys/sched.h>
89 #include <sys/sysctl.h>
90 #include <sys/sysent.h>
91 #include <sys/syslog.h>
92 #include <sys/sysproto.h>
94 #include <sys/vnode.h>
96 #include <security/mac/mac_framework.h>
99 * The routines implemented in this file are described in:
100 * Leffler, et al.: The Design and Implementation of the 4.3BSD
101 * UNIX Operating System (Addison Welley, 1989)
103 * On May 2007 the historic 3 bits base 8 exponent, 13 bit fraction
104 * compt_t representation described in the above reference was replaced
105 * with that of IEEE-754 floats.
107 * Arguably, to simplify accounting operations, this mechanism should
108 * be replaced by one in which an accounting log file (similar to /dev/klog)
109 * is read by a user process, etc. However, that has its own problems.
112 /* Floating point definitions from <float.h>. */
113 #define FLT_MANT_DIG 24 /* p */
114 #define FLT_MAX_EXP 128 /* emax */
117 * Internal accounting functions.
118 * The former's operation is described in Leffler, et al., and the latter
119 * was provided by UCB with the 4.4BSD-Lite release
121 static uint32_t encode_timeval(struct timeval);
122 static uint32_t encode_long(long);
123 static void acctwatch(void);
124 static void acct_thread(void *);
125 static int acct_disable(struct thread *, int);
128 * Accounting vnode pointer, saved vnode pointer, and flags for each.
129 * acct_sx protects against changes to the active vnode and credentials
130 * while accounting records are being committed to disk.
132 static int acct_configured;
133 static int acct_suspended;
134 static struct vnode *acct_vp;
135 static struct ucred *acct_cred;
136 static int acct_flags;
137 static struct sx acct_sx;
139 SX_SYSINIT(acct, &acct_sx, "acct_sx");
142 * State of the accounting kthread.
144 static int acct_state;
146 #define ACCT_RUNNING 1 /* Accounting kthread is running. */
147 #define ACCT_EXITREQ 2 /* Accounting kthread should exit. */
150 * Values associated with enabling and disabling accounting
152 static int acctsuspend = 2; /* stop accounting when < 2% free space left */
153 SYSCTL_INT(_kern, OID_AUTO, acct_suspend, CTLFLAG_RW,
154 &acctsuspend, 0, "percentage of free disk space below which accounting stops");
156 static int acctresume = 4; /* resume when free space risen to > 4% */
157 SYSCTL_INT(_kern, OID_AUTO, acct_resume, CTLFLAG_RW,
158 &acctresume, 0, "percentage of free disk space above which accounting resumes");
160 static int acctchkfreq = 15; /* frequency (in seconds) to check space */
163 sysctl_acct_chkfreq(SYSCTL_HANDLER_ARGS)
167 /* Write out the old value. */
168 error = SYSCTL_OUT(req, &acctchkfreq, sizeof(int));
169 if (error || req->newptr == NULL)
172 /* Read in and verify the new value. */
173 error = SYSCTL_IN(req, &value, sizeof(int));
181 SYSCTL_PROC(_kern, OID_AUTO, acct_chkfreq, CTLTYPE_INT|CTLFLAG_RW,
182 &acctchkfreq, 0, sysctl_acct_chkfreq, "I",
183 "frequency for checking the free space");
185 SYSCTL_INT(_kern, OID_AUTO, acct_configured, CTLFLAG_RD, &acct_configured, 0,
186 "Accounting configured or not");
188 SYSCTL_INT(_kern, OID_AUTO, acct_suspended, CTLFLAG_RD, &acct_suspended, 0,
189 "Accounting suspended or not");
192 * Accounting system call. Written based on the specification and previous
193 * implementation done by Mark Tinguely.
196 acct(struct thread *td, struct acct_args *uap)
199 int error, flags, vfslocked, replacing;
201 error = priv_check(td, PRIV_ACCT);
206 * If accounting is to be started to a file, open that file for
207 * appending and make sure it's a 'normal'.
209 if (uap->path != NULL) {
210 NDINIT(&nd, LOOKUP, NOFOLLOW | MPSAFE | AUDITVNODE1,
211 UIO_USERSPACE, uap->path, td);
212 flags = FWRITE | O_APPEND;
213 error = vn_open(&nd, &flags, 0, NULL);
216 vfslocked = NDHASGIANT(&nd);
217 NDFREE(&nd, NDF_ONLY_PNBUF);
219 error = mac_system_check_acct(td->td_ucred, nd.ni_vp);
221 VOP_UNLOCK(nd.ni_vp, 0);
222 vn_close(nd.ni_vp, flags, td->td_ucred, td);
223 VFS_UNLOCK_GIANT(vfslocked);
227 VOP_UNLOCK(nd.ni_vp, 0);
228 if (nd.ni_vp->v_type != VREG) {
229 vn_close(nd.ni_vp, flags, td->td_ucred, td);
230 VFS_UNLOCK_GIANT(vfslocked);
233 VFS_UNLOCK_GIANT(vfslocked);
236 error = mac_system_check_acct(td->td_ucred, NULL);
243 * Disallow concurrent access to the accounting vnode while we swap
244 * it out, in order to prevent access after close.
249 * Don't log spurious disable/enable messages if we are
250 * switching from one accounting file to another due to log
253 replacing = (acct_vp != NULL && uap->path != NULL);
256 * If accounting was previously enabled, kill the old space-watcher,
257 * close the file, and (if no new file was specified, leave). Reset
258 * the suspended state regardless of whether accounting remains
262 if (acct_vp != NULL) {
263 vfslocked = VFS_LOCK_GIANT(acct_vp->v_mount);
264 error = acct_disable(td, !replacing);
265 VFS_UNLOCK_GIANT(vfslocked);
267 if (uap->path == NULL) {
268 if (acct_state & ACCT_RUNNING) {
269 acct_state |= ACCT_EXITREQ;
272 sx_xunlock(&acct_sx);
277 * Save the new accounting file vnode, and schedule the new
278 * free space watcher.
281 acct_cred = crhold(td->td_ucred);
283 if (acct_state & ACCT_RUNNING)
284 acct_state &= ~ACCT_EXITREQ;
287 * Try to start up an accounting kthread. We may start more
288 * than one, but if so the extras will commit suicide as
289 * soon as they start up.
291 error = kproc_create(acct_thread, NULL, NULL, 0, 0,
294 vfslocked = VFS_LOCK_GIANT(acct_vp->v_mount);
295 (void) vn_close(acct_vp, acct_flags, acct_cred, td);
296 VFS_UNLOCK_GIANT(vfslocked);
302 sx_xunlock(&acct_sx);
303 log(LOG_NOTICE, "Unable to start accounting thread\n");
308 sx_xunlock(&acct_sx);
310 log(LOG_NOTICE, "Accounting enabled\n");
315 * Disable currently in-progress accounting by closing the vnode, dropping
316 * our reference to the credential, and clearing the vnode's flags.
319 acct_disable(struct thread *td, int logging)
323 sx_assert(&acct_sx, SX_XLOCKED);
324 error = vn_close(acct_vp, acct_flags, acct_cred, td);
331 log(LOG_NOTICE, "Accounting disabled\n");
336 * Write out process accounting information, on process exit.
337 * Data to be written out is specified in Leffler, et al.
338 * and are enumerated below. (They're also noted in the system
339 * "acct.h" header file.)
342 acct_process(struct thread *td)
345 struct timeval ut, st, tmp;
346 struct plimit *newlim, *oldlim;
349 int t, ret, vfslocked;
352 * Lockless check of accounting condition before doing the hard
355 if (acct_vp == NULL || acct_suspended)
361 * If accounting isn't enabled, don't bother. Have to check again
362 * once we own the lock in case we raced with disabling of accounting
365 if (acct_vp == NULL || acct_suspended) {
366 sx_sunlock(&acct_sx);
373 * Get process accounting information.
376 sx_slock(&proctree_lock);
379 /* (1) The terminal from which the process was started */
380 if ((p->p_flag & P_CONTROLT) && p->p_pgrp->pg_session->s_ttyp)
381 acct.ac_tty = tty_udev(p->p_pgrp->pg_session->s_ttyp);
384 sx_sunlock(&proctree_lock);
386 /* (2) The name of the command that ran */
387 bcopy(p->p_comm, acct.ac_comm, sizeof acct.ac_comm);
389 /* (3) The amount of user and system time that was used */
390 rufetchcalc(p, &ru, &ut, &st);
391 acct.ac_utime = encode_timeval(ut);
392 acct.ac_stime = encode_timeval(st);
394 /* (4) The elapsed time the command ran (and its starting time) */
396 timevaladd(&tmp, &p->p_stats->p_start);
397 acct.ac_btime = tmp.tv_sec;
399 timevalsub(&tmp, &p->p_stats->p_start);
400 acct.ac_etime = encode_timeval(tmp);
402 /* (5) The average amount of memory used */
404 timevaladd(&tmp, &st);
405 /* Convert tmp (i.e. u + s) into hz units to match ru_i*. */
406 t = tmp.tv_sec * hz + tmp.tv_usec / tick;
408 acct.ac_mem = encode_long((ru.ru_ixrss + ru.ru_idrss +
413 /* (6) The number of disk I/O operations done */
414 acct.ac_io = encode_long(ru.ru_inblock + ru.ru_oublock);
416 /* (7) The UID and GID of the process */
417 acct.ac_uid = p->p_ucred->cr_ruid;
418 acct.ac_gid = p->p_ucred->cr_rgid;
420 /* (8) The boolean flags that tell how the process terminated, etc. */
421 acct.ac_flagx = p->p_acflag;
424 /* Setup ancillary structure fields. */
425 acct.ac_flagx |= ANVER;
428 acct.ac_len = acct.ac_len2 = sizeof(acct);
431 * Eliminate any file size rlimit.
433 newlim = lim_alloc();
436 lim_copy(newlim, oldlim);
437 newlim->pl_rlimit[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
443 * Write the accounting information to the file.
445 vfslocked = VFS_LOCK_GIANT(acct_vp->v_mount);
446 ret = vn_rdwr(UIO_WRITE, acct_vp, (caddr_t)&acct, sizeof (acct),
447 (off_t)0, UIO_SYSSPACE, IO_APPEND|IO_UNIT, acct_cred, NOCRED,
449 VFS_UNLOCK_GIANT(vfslocked);
450 sx_sunlock(&acct_sx);
454 /* FLOAT_CONVERSION_START (Regression testing; don't remove this line.) */
456 /* Convert timevals and longs into IEEE-754 bit patterns. */
458 /* Mantissa mask (MSB is implied, so subtract 1). */
459 #define MANT_MASK ((1 << (FLT_MANT_DIG - 1)) - 1)
462 * We calculate integer values to a precision of approximately
464 * This is high-enough precision to fill the 24 float bits
465 * and low-enough to avoid overflowing the 32 int bits.
469 /* log_2(1000000). */
473 * Convert the elements of a timeval into a 32-bit word holding
474 * the bits of a IEEE-754 float.
475 * The float value represents the timeval's value in microsecond units.
478 encode_timeval(struct timeval tv)
481 int val, exp; /* Unnormalized value and exponent */
482 int norm_exp; /* Normalized exponent */
486 * First calculate value and exponent to about CALC_BITS precision.
487 * Note that the following conditionals have been ordered so that
488 * the most common cases appear first.
490 if (tv.tv_sec == 0) {
497 * Calculate the value to a precision of approximately
500 log2_s = fls(tv.tv_sec) - 1;
501 if (log2_s + LOG2_1M < CALC_BITS) {
503 val = 1000000 * tv.tv_sec + tv.tv_usec;
505 exp = log2_s + LOG2_1M - CALC_BITS;
506 val = (unsigned int)(((u_int64_t)1000000 * tv.tv_sec +
510 /* Now normalize and pack the value into an IEEE-754 float. */
511 norm_exp = fls(val) - 1;
512 shift = FLT_MANT_DIG - norm_exp - 1;
514 printf("val=%d exp=%d shift=%d log2(val)=%d\n",
515 val, exp, shift, norm_exp);
516 printf("exp=%x mant=%x\n", FLT_MAX_EXP - 1 + exp + norm_exp,
517 ((shift > 0 ? (val << shift) : (val >> -shift)) & MANT_MASK));
519 return (((FLT_MAX_EXP - 1 + exp + norm_exp) << (FLT_MANT_DIG - 1)) |
520 ((shift > 0 ? val << shift : val >> -shift) & MANT_MASK));
524 * Convert a non-negative long value into the bit pattern of
525 * an IEEE-754 float value.
528 encode_long(long val)
530 int norm_exp; /* Normalized exponent */
537 "encode_long: negative value %ld in accounting record\n",
541 norm_exp = fls(val) - 1;
542 shift = FLT_MANT_DIG - norm_exp - 1;
544 printf("val=%d shift=%d log2(val)=%d\n",
545 val, shift, norm_exp);
546 printf("exp=%x mant=%x\n", FLT_MAX_EXP - 1 + exp + norm_exp,
547 ((shift > 0 ? (val << shift) : (val >> -shift)) & MANT_MASK));
549 return (((FLT_MAX_EXP - 1 + norm_exp) << (FLT_MANT_DIG - 1)) |
550 ((shift > 0 ? val << shift : val >> -shift) & MANT_MASK));
553 /* FLOAT_CONVERSION_END (Regression testing; don't remove this line.) */
556 * Periodically check the filesystem to see if accounting
557 * should be turned on or off. Beware the case where the vnode
558 * has been vgone()'d out from underneath us, e.g. when the file
559 * system containing the accounting file has been forcibly unmounted.
568 sx_assert(&acct_sx, SX_XLOCKED);
571 * If accounting was disabled before our kthread was scheduled,
572 * then acct_vp might be NULL. If so, just ask our kthread to
575 if (acct_vp == NULL) {
576 acct_state |= ACCT_EXITREQ;
581 * If our vnode is no longer valid, tear it down and signal the
582 * accounting thread to die.
584 vfslocked = VFS_LOCK_GIANT(acct_vp->v_mount);
585 if (acct_vp->v_type == VBAD) {
586 (void) acct_disable(NULL, 1);
587 VFS_UNLOCK_GIANT(vfslocked);
588 acct_state |= ACCT_EXITREQ;
593 * Stopping here is better than continuing, maybe it will be VBAD
596 if (VFS_STATFS(acct_vp->v_mount, &sb) < 0) {
597 VFS_UNLOCK_GIANT(vfslocked);
600 VFS_UNLOCK_GIANT(vfslocked);
601 if (acct_suspended) {
602 if (sb.f_bavail > (int64_t)(acctresume * sb.f_blocks /
605 log(LOG_NOTICE, "Accounting resumed\n");
608 if (sb.f_bavail <= (int64_t)(acctsuspend * sb.f_blocks /
611 log(LOG_NOTICE, "Accounting suspended\n");
617 * The main loop for the dedicated kernel thread that periodically calls
621 acct_thread(void *dummy)
625 /* This is a low-priority kernel thread. */
627 thread_lock(curthread);
628 sched_prio(curthread, pri);
629 thread_unlock(curthread);
631 /* If another accounting kthread is already running, just die. */
633 if (acct_state & ACCT_RUNNING) {
634 sx_xunlock(&acct_sx);
637 acct_state |= ACCT_RUNNING;
639 /* Loop until we are asked to exit. */
640 while (!(acct_state & ACCT_EXITREQ)) {
642 /* Perform our periodic checks. */
646 * We check this flag again before sleeping since the
647 * acctwatch() might have shut down accounting and asked us
650 if (!(acct_state & ACCT_EXITREQ)) {
651 sx_sleep(&acct_state, &acct_sx, 0, "-",
657 * Acknowledge the exit request and shutdown. We clear both the
658 * exit request and running flags.
661 sx_xunlock(&acct_sx);