xref: /illumos-gate/usr/src/cmd/rcap/rcapd/rcapd_rfd.h (revision 2a8bcb4efb45d99ac41c94a75c396b362c414f7f)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _RCAPD_RFD_H
28 #define	_RCAPD_RFD_H
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 #include <sys/types.h>
35 #include "rcapd.h"
36 
37 /*
38  * Classes of cached, revocable file descriptors
39  */
40 typedef enum {
41 	RFD_PAGEDATA = 1,	/* pagedata is always preferred over psinfo */
42 	RFD_PSINFO,		/* psinfo, at least one of which is */
43 				/* cached at any time */
44 	RFD_XMAP,		/* xmap */
45 	RFD_RESERVED		/* opened for use by external consumers */
46 } rfd_class_t;
47 
48 /*
49  * Revocable file descriptor
50  */
51 typedef struct rfd {
52 	int rfd_fd;				/* cached descriptor */
53 	rfd_class_t rfd_class;			/* class of descriptor */
54 	void(*rfd_revoke)(struct rfd *);	/* revocation function */
55 	void *rfd_data;				/* supplied data */
56 
57 	struct rfd *rfd_next;			/* list */
58 	struct rfd *rfd_prev;
59 
60 	struct rfd *rfd_prev_class;		/* link to previous of same */
61 						/* class */
62 } rfd_t;
63 
64 int rfd_close(int);
65 int rfd_open(char *, int, rfd_class_t, void(*)(struct rfd *), void *, int,
66     mode_t);
67 int rfd_reserve(int);
68 
69 #ifdef	__cplusplus
70 }
71 #endif
72 
73 #endif /* _RCAPD_RFD_H */
74