xref: /onnv-gate/usr/src/head/exacct.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_EXACCT_H
28*0Sstevel@tonic-gate #define	_EXACCT_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate /*
33*0Sstevel@tonic-gate  * exacct item, group, and object definitions as well as structure manipulation
34*0Sstevel@tonic-gate  * and conversion routines are given in sys/exacct.h.
35*0Sstevel@tonic-gate  */
36*0Sstevel@tonic-gate #include <sys/exacct.h>
37*0Sstevel@tonic-gate #include <sys/exacct_catalog.h>
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifdef	__cplusplus
40*0Sstevel@tonic-gate extern "C" {
41*0Sstevel@tonic-gate #endif
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate /*
44*0Sstevel@tonic-gate  * ea_open positioning options:  passed in via the aflags argument, these flags
45*0Sstevel@tonic-gate  * determine whether the newly opened file is positioned for reading prior to
46*0Sstevel@tonic-gate  * its first record, or after its last.
47*0Sstevel@tonic-gate  */
48*0Sstevel@tonic-gate #define	EO_HEAD		0x0	/* open file positioned at first object */
49*0Sstevel@tonic-gate #define	EO_TAIL		0x1	/* open file positioned at last object */
50*0Sstevel@tonic-gate #define	EO_POSN_MSK	0x1
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate  * ea_open validation options:  passed in via the aflags argument, these flags
54*0Sstevel@tonic-gate  * specify whether the open operation should validate the header on the input
55*0Sstevel@tonic-gate  * file.  The EO_NO_VALID_HDR is useful in the case that no header is present on
56*0Sstevel@tonic-gate  * the file, but the version and file type checks are omitted, meaning that
57*0Sstevel@tonic-gate  * incompatibilities might not be caught immediately.
58*0Sstevel@tonic-gate  */
59*0Sstevel@tonic-gate #define	EO_VALID_HDR	0x0	/* validate header on opening file */
60*0Sstevel@tonic-gate #define	EO_NO_VALID_HDR	0x2	/* omit header validation */
61*0Sstevel@tonic-gate #define	EO_VALIDATE_MSK	0x2
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate typedef struct _ea_file {
64*0Sstevel@tonic-gate 	void		*ef_opaque_ptr[8];
65*0Sstevel@tonic-gate 	offset_t	ef_opaque_off[3];
66*0Sstevel@tonic-gate 	int		ef_opaque_int[6];
67*0Sstevel@tonic-gate } ea_file_t;
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate extern int ea_error(void);
70*0Sstevel@tonic-gate extern int ea_open(ea_file_t *, const char *, const char *, int, int, mode_t);
71*0Sstevel@tonic-gate extern int ea_fdopen(ea_file_t *, int, const char *, int, int);
72*0Sstevel@tonic-gate extern void ea_clear(ea_file_t *);
73*0Sstevel@tonic-gate extern int ea_close(ea_file_t *);
74*0Sstevel@tonic-gate extern int ea_match_object_catalog(ea_object_t *, ea_catalog_t);
75*0Sstevel@tonic-gate extern ea_object_type_t ea_next_object(ea_file_t *, ea_object_t *);
76*0Sstevel@tonic-gate extern ea_object_type_t ea_previous_object(ea_file_t *, ea_object_t *);
77*0Sstevel@tonic-gate extern ea_object_type_t ea_get_object(ea_file_t *, ea_object_t *);
78*0Sstevel@tonic-gate extern ea_object_type_t ea_unpack_object(ea_object_t **, int, void *, size_t);
79*0Sstevel@tonic-gate extern int ea_write_object(ea_file_t *, ea_object_t *);
80*0Sstevel@tonic-gate extern const char *ea_get_creator(ea_file_t *);
81*0Sstevel@tonic-gate extern const char *ea_get_hostname(ea_file_t *);
82*0Sstevel@tonic-gate extern ea_object_t *ea_copy_object(const ea_object_t *);
83*0Sstevel@tonic-gate extern ea_object_t *ea_copy_object_tree(const ea_object_t *);
84*0Sstevel@tonic-gate extern ea_object_t *ea_get_object_tree(ea_file_t *, uint32_t);
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate #ifdef	__cplusplus
87*0Sstevel@tonic-gate }
88*0Sstevel@tonic-gate #endif
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate #endif	/* _EXACCT_H */
91