xref: /openbsd/share/man/man5/acct.5 (revision 097a140d)
1.\"	$OpenBSD: acct.5,v 1.24 2021/02/04 02:03:53 rob 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 4 2021 $
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[10];	/* command name */
61	comp_t	  ac_utime;	/* user time */
62	comp_t	  ac_stime;	/* system time */
63	comp_t	  ac_etime;	/* elapsed time */
64	time_t	  ac_btime;	/* starting time */
65	uid_t	  ac_uid;	/* user id */
66	gid_t	  ac_gid;	/* group id */
67	u_int16_t ac_mem;	/* average memory usage */
68	comp_t	  ac_io;	/* count of IO blocks */
69	dev_t	  ac_tty;	/* controlling tty */
70
71#define	AFORK	0x01		/* fork'd but not exec'd */
72#define	AMAP	0x04		/* system call or stack mapping violation */
73#define	ACORE	0x08		/* dumped core */
74#define	AXSIG	0x10		/* killed by a signal */
75#define	APLEDGE	0x20		/* killed due to pledge violation */
76#define	ATRAP	0x40		/* memory access violation */
77#define	AUNVEIL	0x80		/* unveil access violation */
78	u_int8_t  ac_flag;	/* accounting flags */
79};
80
81/*
82 * 1/AHZ is the granularity of the data encoded in the comp_t fields.
83 * This is not necessarily equal to hz.
84 */
85#define	AHZ	64
86
87#ifdef _KERNEL
88int	acct_process(struct proc *p);
89int	acct_shutdown(void);
90#endif
91.Ed
92.Pp
93If a terminated or misbehaving process was created by an
94.Xr execve 2 ,
95the name of the executed file (at most ten characters of it)
96is saved in the field
97.Fa ac_comm
98and its status is saved by setting one or more of the following flags in
99.Fa ac_flag :
100.Bl -tag -width "AUNVEIL"
101.It Dv AFORK
102A new process was created via
103.Xr fork 2
104that was not followed by a call to
105.Xr execve 2 .
106.It Dv AMAP
107The process terminated abnormally due to a system call or stack mapping
108violation.
109.It Dv ACORE
110The process terminated abnormally due to a signal and dumped
111.Xr core 5 .
112.It Dv AXSIG
113The process was killed by a
114.Xr signal 3 .
115.It Dv APLEDGE
116The process was killed due to a
117.Xr pledge 2
118violation.
119.It Dv ATRAP
120The process was killed due to a memory access violation
121detected by a processor trap.
122.It Dv AUNVEIL
123The process attempted a file access that was prevented by
124.Xr unveil 2
125restrictions.
126Note that this does not cause the process to terminate.
127.El
128.Sh SEE ALSO
129.Xr lastcomm 1 ,
130.Xr acct 2 ,
131.Xr execve 2 ,
132.Xr pledge 2 ,
133.Xr unveil 2 ,
134.Xr signal 3 ,
135.Xr core 5 ,
136.Xr accton 8 ,
137.Xr sa 8
138.Sh HISTORY
139An
140.Nm
141file format first appeared in
142.At v7 .
143