xref: /illumos-gate/usr/src/lib/fm/libdiskstatus/common/libdiskstatus.h (revision e3ae4b35c024af1196582063ecee3ab79367227d)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_LIBDISKSTATUS_H
27 #define	_LIBDISKSTATUS_H
28 
29 #include <libnvpair.h>
30 #include <sys/types.h>
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 typedef struct disk_status disk_status_t;
37 
38 /*
39  * Error definitions
40  */
41 #define	EDS_BASE	2000
42 
43 enum {
44 	EDS_NOMEM = EDS_BASE,		/* memory allocation failure */
45 	EDS_CANT_OPEN,			/* failed to open device */
46 	EDS_NO_TRANSPORT,		/* no supported transport */
47 	EDS_NOT_SUPPORTED,		/* status information not supported */
48 	EDS_NOT_SIMULATOR,		/* not a valid simulator file */
49 	EDS_IO				/* I/O error */
50 };
51 
52 /*
53  * Basic library functions
54  */
55 extern disk_status_t *disk_status_open(const char *, int *);
56 extern void disk_status_close(disk_status_t *);
57 extern const char *disk_status_errmsg(int);
58 extern void disk_status_set_debug(boolean_t);
59 extern int disk_status_errno(disk_status_t *);
60 
61 /*
62  * Miscellaneous functions.
63  */
64 extern const char *disk_status_path(disk_status_t *);
65 
66 /*
67  * Main entry point.
68  */
69 extern nvlist_t *disk_status_get(disk_status_t *);
70 
71 /*
72  * Utility function to simulate predictive failure (device-specific).
73  */
74 extern int disk_status_test_predfail(disk_status_t *);
75 
76 #ifdef	__cplusplus
77 }
78 #endif
79 
80 #endif	/* _LIBDISKSTATUS_H */
81