1 /*- 2 * Copyright (c) 1994 Christopher G. Demetriou 3 * Copyright (c) 1982, 1986, 1989, 1993 4 * The Regents of the University of California. All rights reserved. 5 * (c) UNIX System Laboratories, Inc. 6 * All or some portions of this file are derived from material licensed 7 * to the University of California by American Telephone and Telegraph 8 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 9 * the permission of UNIX System Laboratories, Inc. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the University of 22 * California, Berkeley and its contributors. 23 * 4. 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. 26 * 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 37 * SUCH DAMAGE. 38 * 39 * @(#)kern_acct.c 8.1 (Berkeley) 6/14/93 40 * $FreeBSD$ 41 */ 42 43 #include <sys/param.h> 44 #include <sys/systm.h> 45 #include <sys/lock.h> 46 #include <sys/mutex.h> 47 #include <sys/sysproto.h> 48 #include <sys/proc.h> 49 #include <sys/mount.h> 50 #include <sys/vnode.h> 51 #include <sys/fcntl.h> 52 #include <sys/syslog.h> 53 #include <sys/kernel.h> 54 #include <sys/sysent.h> 55 #include <sys/sysctl.h> 56 #include <sys/namei.h> 57 #include <sys/acct.h> 58 #include <sys/resourcevar.h> 59 #include <sys/tty.h> 60 61 /* 62 * The routines implemented in this file are described in: 63 * Leffler, et al.: The Design and Implementation of the 4.3BSD 64 * UNIX Operating System (Addison Welley, 1989) 65 * on pages 62-63. 66 * 67 * Arguably, to simplify accounting operations, this mechanism should 68 * be replaced by one in which an accounting log file (similar to /dev/klog) 69 * is read by a user process, etc. However, that has its own problems. 70 */ 71 72 /* 73 * Internal accounting functions. 74 * The former's operation is described in Leffler, et al., and the latter 75 * was provided by UCB with the 4.4BSD-Lite release 76 */ 77 static comp_t encode_comp_t(u_long, u_long); 78 static void acctwatch(void *); 79 80 /* 81 * Accounting callout used for periodic scheduling of acctwatch. 82 */ 83 static struct callout acctwatch_callout; 84 85 /* 86 * Accounting vnode pointer, saved vnode pointer, and flags for each. 87 */ 88 static struct vnode *acctp; 89 static struct ucred *acctcred; 90 static int acctflags; 91 static struct vnode *savacctp; 92 static struct ucred *savacctcred; 93 static int savacctflags; 94 95 static struct mtx acct_mtx; 96 MTX_SYSINIT(acct, &acct_mtx, "accounting", MTX_DEF); 97 98 /* 99 * Values associated with enabling and disabling accounting 100 */ 101 static int acctsuspend = 2; /* stop accounting when < 2% free space left */ 102 SYSCTL_INT(_kern, OID_AUTO, acct_suspend, CTLFLAG_RW, 103 &acctsuspend, 0, "percentage of free disk space below which accounting stops"); 104 105 static int acctresume = 4; /* resume when free space risen to > 4% */ 106 SYSCTL_INT(_kern, OID_AUTO, acct_resume, CTLFLAG_RW, 107 &acctresume, 0, "percentage of free disk space above which accounting resumes"); 108 109 static int acctchkfreq = 15; /* frequency (in seconds) to check space */ 110 SYSCTL_INT(_kern, OID_AUTO, acct_chkfreq, CTLFLAG_RW, 111 &acctchkfreq, 0, "frequency for checking the free space"); 112 113 /* 114 * Accounting system call. Written based on the specification and 115 * previous implementation done by Mark Tinguely. 116 * 117 * MPSAFE 118 */ 119 int 120 acct(td, uap) 121 struct thread *td; 122 struct acct_args /* { 123 syscallarg(char *) path; 124 } */ *uap; 125 { 126 struct nameidata nd; 127 int error, flags; 128 129 /* Make sure that the caller is root. */ 130 error = suser(td); 131 if (error) 132 return (error); 133 134 mtx_lock(&Giant); 135 /* 136 * If accounting is to be started to a file, open that file for 137 * appending and make sure it's a 'normal'. 138 */ 139 if (SCARG(uap, path) != NULL) { 140 NDINIT(&nd, LOOKUP, NOFOLLOW, UIO_USERSPACE, SCARG(uap, path), 141 td); 142 flags = FWRITE | O_APPEND; 143 error = vn_open(&nd, &flags, 0); 144 if (error) 145 goto done2; 146 NDFREE(&nd, NDF_ONLY_PNBUF); 147 VOP_UNLOCK(nd.ni_vp, 0, td); 148 if (nd.ni_vp->v_type != VREG) { 149 vn_close(nd.ni_vp, flags, td->td_ucred, td); 150 error = EACCES; 151 goto done2; 152 } 153 } 154 155 /* 156 * If accounting was previously enabled, kill the old space-watcher, 157 * close the file, and (if no new file was specified, leave). 158 */ 159 160 /* 161 * XXX arr: Should not hold lock over vnode operation. 162 */ 163 164 mtx_lock(&acct_mtx); 165 if (acctp != NULLVP || savacctp != NULLVP) { 166 callout_stop(&acctwatch_callout); 167 error = vn_close((acctp != NULLVP ? acctp : savacctp), 168 (acctp != NULLVP ? acctflags : savacctflags), 169 (acctcred != NOCRED ? acctcred : savacctcred), td); 170 acctp = savacctp = NULLVP; 171 crfree(acctcred != NOCRED ? acctcred : savacctcred); 172 acctcred = savacctcred = NOCRED; 173 } 174 if (SCARG(uap, path) == NULL) { 175 mtx_unlock(&acct_mtx); 176 goto done2; 177 } 178 179 /* 180 * Save the new accounting file vnode, and schedule the new 181 * free space watcher. 182 */ 183 acctp = nd.ni_vp; 184 acctcred = crhold(td->td_ucred); 185 acctflags = flags; 186 callout_init(&acctwatch_callout, 0); 187 mtx_unlock(&acct_mtx); 188 acctwatch(NULL); 189 done2: 190 mtx_unlock(&Giant); 191 return (error); 192 } 193 194 /* 195 * Write out process accounting information, on process exit. 196 * Data to be written out is specified in Leffler, et al. 197 * and are enumerated below. (They're also noted in the system 198 * "acct.h" header file.) 199 */ 200 201 int 202 acct_process(td) 203 struct thread *td; 204 { 205 struct proc *p = td->td_proc; 206 struct acct acct; 207 struct rusage *r; 208 struct timeval ut, st, tmp; 209 int t, ret; 210 struct vnode *vp; 211 struct ucred *uc; 212 213 mtx_lock(&acct_mtx); 214 215 /* If accounting isn't enabled, don't bother */ 216 vp = acctp; 217 if (vp == NULLVP) { 218 mtx_unlock(&acct_mtx); 219 return (0); 220 } 221 222 /* 223 * Get process accounting information. 224 */ 225 226 /* (1) The name of the command that ran */ 227 bcopy(p->p_comm, acct.ac_comm, sizeof acct.ac_comm); 228 229 /* (2) The amount of user and system time that was used */ 230 mtx_lock_spin(&sched_lock); 231 calcru(p, &ut, &st, NULL); 232 mtx_unlock_spin(&sched_lock); 233 acct.ac_utime = encode_comp_t(ut.tv_sec, ut.tv_usec); 234 acct.ac_stime = encode_comp_t(st.tv_sec, st.tv_usec); 235 236 /* (3) The elapsed time the commmand ran (and its starting time) */ 237 acct.ac_btime = p->p_stats->p_start.tv_sec; 238 microtime(&tmp); 239 timevalsub(&tmp, &p->p_stats->p_start); 240 acct.ac_etime = encode_comp_t(tmp.tv_sec, tmp.tv_usec); 241 242 /* (4) The average amount of memory used */ 243 r = &p->p_stats->p_ru; 244 tmp = ut; 245 timevaladd(&tmp, &st); 246 t = tmp.tv_sec * hz + tmp.tv_usec / tick; 247 if (t) 248 acct.ac_mem = (r->ru_ixrss + r->ru_idrss + r->ru_isrss) / t; 249 else 250 acct.ac_mem = 0; 251 252 /* (5) The number of disk I/O operations done */ 253 acct.ac_io = encode_comp_t(r->ru_inblock + r->ru_oublock, 0); 254 255 /* (6) The UID and GID of the process */ 256 acct.ac_uid = p->p_ucred->cr_ruid; 257 acct.ac_gid = p->p_ucred->cr_rgid; 258 259 /* (7) The terminal from which the process was started */ 260 PROC_LOCK(p); 261 SESS_LOCK(p->p_session); 262 if ((p->p_flag & P_CONTROLT) && p->p_pgrp->pg_session->s_ttyp) 263 acct.ac_tty = dev2udev(p->p_pgrp->pg_session->s_ttyp->t_dev); 264 else 265 acct.ac_tty = NOUDEV; 266 SESS_UNLOCK(p->p_session); 267 PROC_UNLOCK(p); 268 269 /* (8) The boolean flags that tell how the process terminated, etc. */ 270 acct.ac_flag = p->p_acflag; 271 272 /* 273 * Eliminate any file size rlimit. 274 */ 275 if (p->p_limit->p_refcnt > 1 && 276 (p->p_limit->p_lflags & PL_SHAREMOD) == 0) { 277 p->p_limit->p_refcnt--; 278 p->p_limit = limcopy(p->p_limit); 279 } 280 p->p_rlimit[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY; 281 282 /* 283 * Write the accounting information to the file. 284 */ 285 uc = crhold(acctcred); 286 vref(vp); 287 mtx_unlock(&acct_mtx); 288 VOP_LEASE(vp, td, uc, LEASE_WRITE); 289 ret = vn_rdwr(UIO_WRITE, vp, (caddr_t)&acct, sizeof (acct), 290 (off_t)0, UIO_SYSSPACE, IO_APPEND|IO_UNIT, uc, NOCRED, 291 (int *)0, td); 292 vrele(vp); 293 crfree(uc); 294 return (ret); 295 } 296 297 /* 298 * Encode_comp_t converts from ticks in seconds and microseconds 299 * to ticks in 1/AHZ seconds. The encoding is described in 300 * Leffler, et al., on page 63. 301 */ 302 303 #define MANTSIZE 13 /* 13 bit mantissa. */ 304 #define EXPSIZE 3 /* Base 8 (3 bit) exponent. */ 305 #define MAXFRACT ((1 << MANTSIZE) - 1) /* Maximum fractional value. */ 306 307 static comp_t 308 encode_comp_t(s, us) 309 u_long s, us; 310 { 311 int exp, rnd; 312 313 exp = 0; 314 rnd = 0; 315 s *= AHZ; 316 s += us / (1000000 / AHZ); /* Maximize precision. */ 317 318 while (s > MAXFRACT) { 319 rnd = s & (1 << (EXPSIZE - 1)); /* Round up? */ 320 s >>= EXPSIZE; /* Base 8 exponent == 3 bit shift. */ 321 exp++; 322 } 323 324 /* If we need to round up, do it (and handle overflow correctly). */ 325 if (rnd && (++s > MAXFRACT)) { 326 s >>= EXPSIZE; 327 exp++; 328 } 329 330 /* Clean it up and polish it off. */ 331 exp <<= MANTSIZE; /* Shift the exponent into place */ 332 exp += s; /* and add on the mantissa. */ 333 return (exp); 334 } 335 336 /* 337 * Periodically check the filesystem to see if accounting 338 * should be turned on or off. Beware the case where the vnode 339 * has been vgone()'d out from underneath us, e.g. when the file 340 * system containing the accounting file has been forcibly unmounted. 341 */ 342 /* ARGSUSED */ 343 static void 344 acctwatch(a) 345 void *a; 346 { 347 struct statfs sb; 348 349 mtx_lock(&acct_mtx); 350 351 /* 352 * XXX arr: Need to fix the issue of holding acct_mtx over 353 * the below vnode operations. 354 */ 355 356 if (savacctp != NULLVP) { 357 if (savacctp->v_type == VBAD) { 358 (void) vn_close(savacctp, savacctflags, savacctcred, 359 NULL); 360 savacctp = NULLVP; 361 savacctcred = NOCRED; 362 mtx_unlock(&acct_mtx); 363 return; 364 } 365 (void)VFS_STATFS(savacctp->v_mount, &sb, (struct thread *)0); 366 if (sb.f_bavail > acctresume * sb.f_blocks / 100) { 367 acctp = savacctp; 368 acctcred = savacctcred; 369 acctflags = savacctflags; 370 savacctp = NULLVP; 371 savacctcred = NOCRED; 372 log(LOG_NOTICE, "Accounting resumed\n"); 373 } 374 } else { 375 if (acctp == NULLVP) { 376 mtx_unlock(&acct_mtx); 377 return; 378 } 379 if (acctp->v_type == VBAD) { 380 (void) vn_close(acctp, acctflags, acctcred, NULL); 381 acctp = NULLVP; 382 crfree(acctcred); 383 acctcred = NOCRED; 384 mtx_unlock(&acct_mtx); 385 return; 386 } 387 (void)VFS_STATFS(acctp->v_mount, &sb, (struct thread *)0); 388 if (sb.f_bavail <= acctsuspend * sb.f_blocks / 100) { 389 savacctp = acctp; 390 savacctflags = acctflags; 391 savacctcred = acctcred; 392 acctp = NULLVP; 393 acctcred = NOCRED; 394 log(LOG_NOTICE, "Accounting suspended\n"); 395 } 396 } 397 callout_reset(&acctwatch_callout, acctchkfreq * hz, acctwatch, NULL); 398 mtx_unlock(&acct_mtx); 399 } 400