xref: /illumos-gate/usr/src/lib/libfstyp/common/libfstyp_module.h (revision 3893cb7fe5bfa1c9a4f7954517a917367f6cf081)
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 (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_LIBFSTYP_MODULE_H
27 #define	_LIBFSTYP_MODULE_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 /*
32  * libfstyp: module interface
33  */
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 #include <stdio.h>
39 #include <sys/types.h>
40 #include <libnvpair.h>
41 #include <libfstyp.h>
42 
43 typedef struct fstyp_mod_handle *fstyp_mod_handle_t;
44 
45 /*
46  * Modules are must to export these functions.
47  * fstyp_mod_dump() is optional.
48  */
49 int fstyp_mod_init(int fd, off64_t offset, fstyp_mod_handle_t *handle);
50 void fstyp_mod_fini(fstyp_mod_handle_t handle);
51 int fstyp_mod_ident(fstyp_mod_handle_t handle);
52 int fstyp_mod_get_attr(fstyp_mod_handle_t handle, nvlist_t **attr);
53 int fstyp_mod_dump(fstyp_mod_handle_t handle, FILE *fout, FILE *ferr);
54 
55 #ifdef __cplusplus
56 }
57 #endif
58 
59 #endif /* _LIBFSTYP_MODULE_H */
60