xref: /openbsd/share/man/man5/acct.5 (revision 4bdff4be)
1.\"	$OpenBSD: acct.5,v 1.26 2022/02/22 17:22:29 deraadt Exp $
2.\"	$NetBSD: acct.5,v 1.4 1995/10/22 01:40:10 ghudson Exp $
3.\"
4.\" Copyright (c) 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     @(#)acct.5	8.1 (Berkeley) 6/5/93
32.\"
33.Dd $Mdocdate: February 22 2022 $
34.Dt ACCT 5
35.Os
36.Sh NAME
37.Nm acct
38.Nd execution accounting file
39.Sh SYNOPSIS
40.In sys/acct.h
41.Sh DESCRIPTION
42The kernel maintains the following
43.Fa acct
44information structure for all
45processes.
46If a process terminates or misbehaves in specific ways,
47and accounting is enabled, the kernel calls the
48.Xr acct 2
49function call to prepare and append the record
50to the accounting file.
51.Bd -literal
52/*
53 * Accounting structures; these use a comp_t type which is a 3 bits base 8
54 * exponent, 13 bit fraction floating point number.  Units are 1/AHZ
55 * seconds.
56 */
57typedef u_int16_t comp_t;
58
59struct acct {
60	char	  ac_comm[24];	/* command name, incl NUL */
61	comp_t	  ac_utime;	/* user time */
62	comp_t	  ac_stime;	/* system time */
63	comp_t	  ac_etime;	/* elapsed time */
64	comp_t	  ac_io;	/* count of IO blocks */
65	time_t	  ac_btime;	/* starting time */
66	uid_t	  ac_uid;	/* user id */
67	gid_t	  ac_gid;	/* group id */
68	u_int32_t ac_mem;	/* average memory usage */
69	dev_t	  ac_tty;	/* controlling tty, or -1 */
70	pid_t	  ac_pid;	/* process id */
71
72#define	AFORK	0x01		/* fork'd but not exec'd */
73#define	AMAP	0x04		/* system call or stack mapping violation */
74#define	ACORE	0x08		/* dumped core */
75#define	AXSIG	0x10		/* killed by a signal */
76#define	APLEDGE	0x20		/* killed due to pledge violation */
77#define	ATRAP	0x40		/* memory access violation */
78#define	AUNVEIL	0x80		/* unveil access violation */
79	u_int32_t ac_flag;	/* accounting flags */
80};
81
82/*
83 * 1/AHZ is the granularity of the data encoded in the comp_t fields.
84 * This is not necessarily equal to hz.
85 */
86#define	AHZ	64
87
88#ifdef _KERNEL
89int	acct_process(struct proc *p);
90int	acct_shutdown(void);
91#endif
92.Ed
93.Pp
94If a terminated or misbehaving process was created by an
95.Xr execve 2 ,
96the name of the executed file (at most ten characters of it)
97is saved in the field
98.Fa ac_comm
99and its status is saved by setting one or more of the following flags in
100.Fa ac_flag :
101.Bl -tag -width "AUNVEIL"
102.It Dv AFORK
103A new process was created via
104.Xr fork 2
105that was not followed by a call to
106.Xr execve 2 .
107.It Dv AMAP
108The process terminated abnormally due to a system call or stack mapping
109violation.
110.It Dv ACORE
111The process terminated abnormally due to a signal and dumped
112.Xr core 5 .
113.It Dv AXSIG
114The process was killed by a
115.Xr signal 3 .
116.It Dv APLEDGE
117The process was killed due to a
118.Xr pledge 2
119violation.
120.It Dv ATRAP
121The process was killed due to a memory access violation
122detected by a processor trap.
123.It Dv AUNVEIL
124The process attempted a file access that was prevented by
125.Xr unveil 2
126restrictions.
127Note that this does not cause the process to terminate.
128.El
129.Sh SEE ALSO
130.Xr lastcomm 1 ,
131.Xr acct 2 ,
132.Xr execve 2 ,
133.Xr pledge 2 ,
134.Xr unveil 2 ,
135.Xr signal 3 ,
136.Xr core 5 ,
137.Xr accton 8 ,
138.Xr sa 8
139.Sh HISTORY
140An
141.Nm
142file format first appeared in
143.At v7 .
144