xref: /freebsd/sys/sys/acct.h (revision 29363fb446372cb3f10bc98664e9767c53fbb457)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  * (c) UNIX System Laboratories, Inc.
7  * All or some portions of this file are derived from material licensed
8  * to the University of California by American Telephone and Telegraph
9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10  * the permission of UNIX System Laboratories, Inc.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #ifndef _SYS_ACCT_H_
38 #define _SYS_ACCT_H_
39 
40 #ifdef _KERNEL
41 #define float uint32_t
42 #else
43 #include <sys/types.h>
44 #endif
45 
46 #define AC_COMM_LEN 16
47 
48 /*
49  * Accounting structure version 3 (current).
50  * The first byte is always zero.
51  * Time units are microseconds.
52  */
53 
54 struct acctv3 {
55 	uint8_t   ac_zero;		/* zero identifies new version */
56 	uint8_t   ac_version;		/* record version number */
57 	uint16_t  ac_len;		/* record length */
58 
59 	char	  ac_comm[AC_COMM_LEN];	/* command name */
60 	float	  ac_utime;		/* user time */
61 	float	  ac_stime;		/* system time */
62 	float	  ac_etime;		/* elapsed time */
63 	time_t	  ac_btime;		/* starting time */
64 	uid_t	  ac_uid;		/* user id */
65 	gid_t	  ac_gid;		/* group id */
66 	float	  ac_mem;		/* average memory usage */
67 	float	  ac_io;		/* count of IO blocks */
68 	__dev_t   ac_tty;		/* controlling tty */
69 	uint32_t  ac_pad0;
70 	uint16_t  ac_len2;		/* record length */
71 	union {
72 		uint32_t  ac_align;	/* force v1 compatible alignment */
73 
74 #define	AFORK	0x01			/* forked but not exec'ed */
75 /* ASU is no longer supported */
76 #define	ASU	0x02			/* used super-user permissions */
77 #define	ACOMPAT	0x04			/* used compatibility mode */
78 #define	ACORE	0x08			/* dumped core */
79 #define	AXSIG	0x10			/* killed by a signal */
80 #define ANVER	0x20			/* new record version */
81 
82 		uint8_t   ac_flag;	/* accounting flags */
83 	} ac_trailer;
84 
85 #define ac_flagx ac_trailer.ac_flag
86 };
87 
88 struct acctv2 {
89 	uint8_t   ac_zero;		/* zero identifies new version */
90 	uint8_t   ac_version;		/* record version number */
91 	uint16_t  ac_len;		/* record length */
92 
93 	char	  ac_comm[AC_COMM_LEN];	/* command name */
94 	float	  ac_utime;		/* user time */
95 	float	  ac_stime;		/* system time */
96 	float	  ac_etime;		/* elapsed time */
97 	time_t	  ac_btime;		/* starting time */
98 	uid_t	  ac_uid;		/* user id */
99 	gid_t	  ac_gid;		/* group id */
100 	float	  ac_mem;		/* average memory usage */
101 	float	  ac_io;		/* count of IO blocks */
102 	uint32_t  ac_tty;		/* controlling tty */
103 
104 	uint16_t  ac_len2;		/* record length */
105 	union {
106 		uint32_t   ac_align;	/* force v1 compatible alignment */
107 		uint8_t   ac_flag;	/* accounting flags */
108 	} ac_trailer;
109 };
110 
111 /*
112  * Legacy accounting structure (rev. 1.5-1.18).
113  * The first byte is always non-zero.
114  * Some fields use a comp_t type which is a 3 bits base 8
115  * exponent, 13 bit fraction ``floating point'' number.
116  * Units are 1/AHZV1 seconds.
117  */
118 
119 typedef uint16_t comp_t;
120 
121 struct acctv1 {
122 	char	  ac_comm[AC_COMM_LEN];	/* command name */
123 	comp_t	  ac_utime;		/* user time */
124 	comp_t	  ac_stime;		/* system time */
125 	comp_t	  ac_etime;		/* elapsed time */
126 	time_t	  ac_btime;		/* starting time */
127 	uid_t	  ac_uid;		/* user id */
128 	gid_t	  ac_gid;		/* group id */
129 	uint16_t  ac_mem;		/* average memory usage */
130 	comp_t	  ac_io;		/* count of IO blocks */
131 	uint32_t  ac_tty;		/* controlling tty */
132 	uint8_t   ac_flag;		/* accounting flags */
133 };
134 
135 /*
136  * 1/AHZV1 is the granularity of the data encoded in the comp_t fields.
137  * This is not necessarily equal to hz.
138  */
139 #define	AHZV1	64
140 
141 #ifdef _KERNEL
142 struct thread;
143 
144 int	acct_process(struct thread *td);
145 #undef float
146 #endif
147 
148 #endif /* !_SYS_ACCT_H_ */
149