Remove some uses of the SCARG macro.
[dragonfly.git] / sys / kern / kern_acct.c
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: src/sys/kern/kern_acct.c,v 1.23.2.1 2002/07/24 18:33:55 johan Exp $
41  * $DragonFly: src/sys/kern/kern_acct.c,v 1.17 2005/03/29 00:35:55 drhodus Exp $
42  */
43
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/sysproto.h>
47 #include <sys/proc.h>
48 #include <sys/mount.h>
49 #include <sys/vnode.h>
50 #include <sys/fcntl.h>
51 #include <sys/syslog.h>
52 #include <sys/kernel.h>
53 #include <sys/sysent.h>
54 #include <sys/sysctl.h>
55 #include <sys/nlookup.h>
56 #include <sys/acct.h>
57 #include <sys/resourcevar.h>
58 #include <sys/tty.h>
59
60 #include <vm/vm_zone.h>
61
62 /*
63  * The routines implemented in this file are described in:
64  *      Leffler, et al.: The Design and Implementation of the 4.3BSD
65  *          UNIX Operating System (Addison Welley, 1989)
66  * on pages 62-63.
67  *
68  * Arguably, to simplify accounting operations, this mechanism should
69  * be replaced by one in which an accounting log file (similar to /dev/klog)
70  * is read by a user process, etc.  However, that has its own problems.
71  */
72
73 /*
74  * Internal accounting functions.
75  * The former's operation is described in Leffler, et al., and the latter
76  * was provided by UCB with the 4.4BSD-Lite release
77  */
78 static comp_t   encode_comp_t (u_long, u_long);
79 static void     acctwatch (void *);
80
81 /*
82  * Accounting callout handle used for periodic scheduling of
83  * acctwatch.
84  */
85 static struct   callout acctwatch_handle;
86
87 /*
88  * Accounting vnode pointer, and saved vnode pointer.
89  */
90 static struct   vnode *acctp;
91 static struct   vnode *savacctp;
92
93 /*
94  * Values associated with enabling and disabling accounting
95  */
96 static int acctsuspend = 2;     /* stop accounting when < 2% free space left */
97 SYSCTL_INT(_kern, OID_AUTO, acct_suspend, CTLFLAG_RW,
98         &acctsuspend, 0, "Percentage of free disk space below which accounting will be suspended");
99
100 static int acctresume = 4;      /* resume when free space risen to > 4% */
101 SYSCTL_INT(_kern, OID_AUTO, acct_resume, CTLFLAG_RW,
102         &acctresume, 0, "Minimum percentage of free disk space needed to resume accounting");
103
104 static int acctchkfreq = 15;    /* frequency (in seconds) to check space */
105 SYSCTL_INT(_kern, OID_AUTO, acct_chkfreq, CTLFLAG_RW,
106         &acctchkfreq, 0, "Frequency (in seconds) of free disk space checking");
107
108 static void
109 acct_init(void *arg __unused)
110 {
111         callout_init(&acctwatch_handle);
112 }
113 SYSINIT(acct, SI_SUB_DRIVERS, SI_ORDER_ANY, acct_init, NULL);
114
115 /*
116  * Accounting system call.  Written based on the specification and
117  * previous implementation done by Mark Tinguely.
118  */
119 int
120 acct(uap)
121         struct acct_args /* {
122                 syscallarg(char *) path;
123         } */ *uap;
124 {
125         struct thread *td = curthread;
126         struct nlookupdata nd;
127         struct vnode *vp;
128         int error;
129
130         /* Make sure that the caller is root. */
131         error = suser(td);
132         if (error)
133                 return (error);
134
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 (uap->path != NULL) {
140                 error = nlookup_init(&nd, uap->path, UIO_USERSPACE,
141                                         NLC_LOCKVP);
142                 if (error == 0)
143                         error = vn_open(&nd, NULL, FWRITE | O_APPEND, 0);
144                 if (error == 0 && nd.nl_open_vp->v_type != VREG) 
145                         error = EACCES;
146                 if (error) {
147                         nlookup_done(&nd);
148                         return (error);
149                 }
150                 vp = nd.nl_open_vp;
151                 nd.nl_open_vp = NULL;
152                 nlookup_done(&nd);
153
154                 VOP_UNLOCK(vp, 0, td);
155         } else {
156                 vp = NULL;
157         }
158
159         /*
160          * If accounting was previously enabled, kill the old space-watcher,
161          * close the file.
162          */
163         if (acctp != NULLVP || savacctp != NULLVP) {
164                 callout_stop(&acctwatch_handle);
165                 error = vn_close((acctp != NULLVP ? acctp : savacctp),
166                                 FWRITE | O_APPEND, td);
167                 acctp = savacctp = NULLVP;
168         }
169
170         /*
171          * If no new file opened then leave.  We never did an nlookup so
172          * don't try cleaning it up.
173          */
174         if (uap->path == NULL)
175                 return (error);
176
177         /*
178          * Save the new accounting file vnode, and schedule the new
179          * free space watcher.
180          */
181         acctp = vp;
182         acctwatch(NULL);
183         return (error);
184 }
185
186 /*
187  * Write out process accounting information, on process exit.
188  * Data to be written out is specified in Leffler, et al.
189  * and are enumerated below.  (They're also noted in the system
190  * "acct.h" header file.)
191  */
192
193 int
194 acct_process(struct proc *p)
195 {
196         struct acct acct;
197         struct rusage *r;
198         struct timeval ut, st, tmp;
199         int t;
200         struct vnode *vp;
201         struct thread *td = p->p_thread;
202
203         /* If accounting isn't enabled, don't bother */
204         vp = acctp;
205         if (vp == NULLVP)
206                 return (0);
207
208         /*
209          * Get process accounting information.
210          */
211
212         /* (1) The name of the command that ran */
213         bcopy(p->p_comm, acct.ac_comm, sizeof acct.ac_comm);
214
215         /* (2) The amount of user and system time that was used */
216         calcru(p, &ut, &st, NULL);
217         acct.ac_utime = encode_comp_t(ut.tv_sec, ut.tv_usec);
218         acct.ac_stime = encode_comp_t(st.tv_sec, st.tv_usec);
219
220         /* (3) The elapsed time the commmand ran (and its starting time) */
221         acct.ac_btime = p->p_thread->td_start.tv_sec;
222         microtime(&tmp);
223         timevalsub(&tmp, &p->p_thread->td_start);
224         acct.ac_etime = encode_comp_t(tmp.tv_sec, tmp.tv_usec);
225
226         /* (4) The average amount of memory used */
227         r = &p->p_stats->p_ru;
228         tmp = ut;
229         timevaladd(&tmp, &st);
230         t = tmp.tv_sec * hz + tmp.tv_usec / tick;
231         if (t)
232                 acct.ac_mem = (r->ru_ixrss + r->ru_idrss + r->ru_isrss) / t;
233         else
234                 acct.ac_mem = 0;
235
236         /* (5) The number of disk I/O operations done */
237         acct.ac_io = encode_comp_t(r->ru_inblock + r->ru_oublock, 0);
238
239         /* (6) The UID and GID of the process */
240         acct.ac_uid = p->p_ucred->cr_ruid;
241         acct.ac_gid = p->p_ucred->cr_rgid;
242
243         /* (7) The terminal from which the process was started */
244         if ((p->p_flag & P_CONTROLT) && p->p_pgrp->pg_session->s_ttyp)
245                 acct.ac_tty = dev2udev(p->p_pgrp->pg_session->s_ttyp->t_dev);
246         else
247                 acct.ac_tty = NOUDEV;
248
249         /* (8) The boolean flags that tell how the process terminated, etc. */
250         acct.ac_flag = p->p_acflag;
251
252         /*
253          * Eliminate any file size rlimit.
254          */
255         if (p->p_limit->p_refcnt > 1 &&
256             (p->p_limit->p_lflags & PL_SHAREMOD) == 0) {
257                 p->p_limit->p_refcnt--;
258                 p->p_limit = limcopy(p->p_limit);
259         } 
260         p->p_rlimit[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
261
262         /*
263          * Write the accounting information to the file.
264          */
265         VOP_LEASE(vp, td, p->p_ucred, LEASE_WRITE);
266         return (vn_rdwr(UIO_WRITE, vp, (caddr_t)&acct, sizeof (acct),
267             (off_t)0, UIO_SYSSPACE, IO_APPEND|IO_UNIT, p->p_ucred,
268             (int *)0, td));
269 }
270
271 /*
272  * Encode_comp_t converts from ticks in seconds and microseconds
273  * to ticks in 1/AHZ seconds.  The encoding is described in
274  * Leffler, et al., on page 63.
275  */
276
277 #define MANTSIZE        13                      /* 13 bit mantissa. */
278 #define EXPSIZE         3                       /* Base 8 (3 bit) exponent. */
279 #define MAXFRACT        ((1 << MANTSIZE) - 1)   /* Maximum fractional value. */
280
281 static comp_t
282 encode_comp_t(s, us)
283         u_long s, us;
284 {
285         int exp, rnd;
286
287         exp = 0;
288         rnd = 0;
289         s *= AHZ;
290         s += us / (1000000 / AHZ);      /* Maximize precision. */
291
292         while (s > MAXFRACT) {
293         rnd = s & (1 << (EXPSIZE - 1)); /* Round up? */
294                 s >>= EXPSIZE;          /* Base 8 exponent == 3 bit shift. */
295                 exp++;
296         }
297
298         /* If we need to round up, do it (and handle overflow correctly). */
299         if (rnd && (++s > MAXFRACT)) {
300                 s >>= EXPSIZE;
301                 exp++;
302         }
303
304         /* Clean it up and polish it off. */
305         exp <<= MANTSIZE;               /* Shift the exponent into place */
306         exp += s;                       /* and add on the mantissa. */
307         return (exp);
308 }
309
310 /*
311  * Periodically check the file system to see if accounting
312  * should be turned on or off.  Beware the case where the vnode
313  * has been vgone()'d out from underneath us, e.g. when the file
314  * system containing the accounting file has been forcibly unmounted.
315  */
316 /* ARGSUSED */
317 static void
318 acctwatch(a)
319         void *a;
320 {
321         struct statfs sb;
322
323         if (savacctp != NULLVP) {
324                 if (savacctp->v_type == VBAD) {
325                         (void) vn_close(savacctp, FWRITE | O_APPEND, NULL);
326                         savacctp = NULLVP;
327                         return;
328                 }
329                 (void)VFS_STATFS(savacctp->v_mount, &sb, NULL);
330                 if (sb.f_bavail > acctresume * sb.f_blocks / 100) {
331                         acctp = savacctp;
332                         savacctp = NULLVP;
333                         log(LOG_NOTICE, "Accounting resumed\n");
334                 }
335         } else {
336                 if (acctp == NULLVP)
337                         return;
338                 if (acctp->v_type == VBAD) {
339                         (void) vn_close(acctp, FWRITE | O_APPEND, NULL);
340                         acctp = NULLVP;
341                         return;
342                 }
343                 (void)VFS_STATFS(acctp->v_mount, &sb, NULL);
344                 if (sb.f_bavail <= acctsuspend * sb.f_blocks / 100) {
345                         savacctp = acctp;
346                         acctp = NULLVP;
347                         log(LOG_NOTICE, "Accounting suspended\n");
348                 }
349         }
350         callout_reset(&acctwatch_handle, acctchkfreq * hz, acctwatch, NULL);
351 }