xref: /titanic_41/usr/src/lib/libdiskmgt/common/libdiskmgt.h (revision 8eea8e29cc4374d1ee24c25a07f45af132db3499)
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 2004 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _LIBDISKMGT_H
28 #define	_LIBDISKMGT_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 #include <libnvpair.h>
37 
38 /* typedef void  *dm_descriptor_t; */
39 typedef uint64_t  dm_descriptor_t;
40 
41 typedef enum {
42     DM_DRIVE = 0,
43     DM_CONTROLLER,
44     DM_MEDIA,
45     DM_SLICE,
46     DM_PARTITION,
47     DM_PATH,
48     DM_ALIAS,
49     DM_BUS
50 } dm_desc_type_t;
51 
52 
53 typedef enum {
54     DM_DT_UNKNOWN = 0,
55     DM_DT_FIXED,
56     DM_DT_ZIP,
57     DM_DT_JAZ,
58     DM_DT_FLOPPY,
59     DM_DT_MO_ERASABLE,
60     DM_DT_MO_WRITEONCE,
61     DM_DT_AS_MO,
62     DM_DT_CDROM,
63     DM_DT_CDR,
64     DM_DT_CDRW,
65     DM_DT_DVDROM,
66     DM_DT_DVDR,
67     DM_DT_DVDRAM,
68     DM_DT_DVDRW,
69     DM_DT_DDCDROM,
70     DM_DT_DDCDR,
71     DM_DT_DDCDRW
72 } dm_drive_type_t;
73 
74 typedef enum {
75     DM_MT_UNKNOWN = 0,
76     DM_MT_FIXED,
77     DM_MT_FLOPPY,
78     DM_MT_CDROM,
79     DM_MT_ZIP,
80     DM_MT_JAZ,
81     DM_MT_CDR,
82     DM_MT_CDRW,
83     DM_MT_DVDROM,
84     DM_MT_DVDR,
85     DM_MT_DVDRAM,
86     DM_MT_MO_ERASABLE,
87     DM_MT_MO_WRITEONCE,
88     DM_MT_AS_MO
89 } dm_media_type_t;
90 
91 #define	DM_FILTER_END	-1
92 
93 /* drive stat name */
94 typedef enum {
95     DM_DRV_STAT_PERFORMANCE = 0,
96     DM_DRV_STAT_DIAGNOSTIC,
97     DM_DRV_STAT_TEMPERATURE
98 } dm_drive_stat_t;
99 
100 /* slice stat name */
101 typedef enum {
102     DM_SLICE_STAT_USE = 0
103 } dm_slice_stat_t;
104 
105 /* attribute definitions */
106 
107 /* drive */
108 #define	DM_DISK_UP		1
109 #define	DM_DISK_DOWN		0
110 
111 #define	DM_CLUSTERED		"clustered"
112 #define	DM_DRVTYPE		"drvtype"
113 #define	DM_FAILING		"failing"
114 #define	DM_LOADED		"loaded"	/* also in media */
115 #define	DM_NDNRERRS		"ndevice_not_ready_errors"
116 #define	DM_NBYTESREAD		"nbytes_read"
117 #define	DM_NBYTESWRITTEN	"nbytes_written"
118 #define	DM_NHARDERRS		"nhard_errors"
119 #define	DM_NILLREQERRS		"nillegal_req_errors"
120 #define	DM_NMEDIAERRS		"nmedia_errors"
121 #define	DM_NNODEVERRS		"nno_dev_errors"
122 #define	DM_NREADOPS		"nread_ops"
123 #define	DM_NRECOVERRS		"nrecoverable_errors"
124 #define	DM_NSOFTERRS		"nsoft_errors"
125 #define	DM_NTRANSERRS		"ntransport_errors"
126 #define	DM_NWRITEOPS		"nwrite_ops"
127 #define	DM_OPATH		"opath"
128 #define	DM_PRODUCT_ID		"product_id"
129 #define	DM_REMOVABLE		"removable"	/* also in media */
130 #define	DM_RPM			"rpm"
131 #define	DM_STATUS		"status"
132 #define	DM_SYNC_SPEED		"sync_speed"
133 #define	DM_TEMPERATURE		"temperature"
134 #define	DM_VENDOR_ID		"vendor_id"
135 #define	DM_WIDE			"wide"		/* also on controller */
136 #define	DM_WWN			"wwn"
137 
138 /* bus */
139 #define	DM_BTYPE		"btype"
140 #define	DM_CLOCK		"clock"		/* also on controller */
141 #define	DM_PNAME		"pname"
142 
143 /* controller */
144 #define	DM_FAST			"fast"
145 #define	DM_FAST20		"fast20"
146 #define	DM_FAST40		"fast40"
147 #define	DM_FAST80		"fast80"
148 #define	DM_MULTIPLEX		"multiplex"
149 #define	DM_PATH_STATE		"path_state"
150 
151 #define	DM_CTYPE_ATA		"ata"
152 #define	DM_CTYPE_SCSI		"scsi"
153 #define	DM_CTYPE_FIBRE		"fibre channel"
154 #define	DM_CTYPE_USB		"usb"
155 #define	DM_CTYPE_UNKNOWN	"unknown"
156 
157 /* media */
158 #define	DM_BLOCKSIZE		"blocksize"
159 #define	DM_FDISK		"fdisk"
160 #define	DM_MTYPE		"mtype"
161 #define	DM_NACTUALCYLINDERS	"nactual_cylinders"
162 #define	DM_NALTCYLINDERS	"nalt_cylinders"
163 #define	DM_NCYLINDERS		"ncylinders"
164 #define	DM_NHEADS		"nheads"
165 #define	DM_NPHYSCYLINDERS	"nphys_cylinders"
166 #define	DM_NSECTORS		"nsectors"	/* also in partition */
167 #define	DM_SIZE			"size"		/* also in slice */
168 #define	DM_NACCESSIBLE		"naccessible"
169 #define	DM_LABEL		"label"
170 
171 /* partition */
172 #define	DM_BCYL			"bcyl"
173 #define	DM_BHEAD		"bhead"
174 #define	DM_BOOTID		"bootid"
175 #define	DM_BSECT		"bsect"
176 #define	DM_ECYL			"ecyl"
177 #define	DM_EHEAD		"ehead"
178 #define	DM_ESECT		"esect"
179 #define	DM_PTYPE		"ptype"
180 #define	DM_RELSECT		"relsect"
181 
182 /* slice */
183 #define	DM_DEVICEID		"deviceid"
184 #define	DM_DEVT			"devt"
185 #define	DM_INDEX		"index"
186 #define	DM_EFI_NAME		"name"
187 #define	DM_MOUNTPOINT		"mountpoint"
188 #define	DM_LOCALNAME		"localname"
189 #define	DM_START		"start"
190 #define	DM_TAG			"tag"
191 #define	DM_FLAG			"flag"
192 #define	DM_EFI			"efi"	/* also on media */
193 #define	DM_USED_BY		"used_by"
194 #define	DM_USED_NAME		"used_name"
195 #define	DM_USE_MOUNT		"mount"
196 #define	DM_USE_SVM		"svm"
197 #define	DM_USE_LU		"lu"
198 #define	DM_USE_DUMP		"dump"
199 #define	DM_USE_VXVM		"vxvm"
200 #define	DM_USE_FS		"fs"
201 #define	DM_USE_VFSTAB		"vfstab"
202 
203 /* event */
204 #define	DM_EV_NAME		"name"
205 #define	DM_EV_DTYPE		"edtype"
206 #define	DM_EV_TYPE		"evtype"
207 #define	DM_EV_TADD		"add"
208 #define	DM_EV_TREMOVE		"remove"
209 #define	DM_EV_TCHANGE		"change"
210 
211 /* findisks */
212 #define	DM_CTYPE		"ctype"
213 #define	DM_LUN			"lun"
214 #define	DM_TARGET		"target"
215 
216 void			dm_free_descriptors(dm_descriptor_t *desc_list);
217 void			dm_free_descriptor(dm_descriptor_t desc);
218 void			dm_free_name(char *name);
219 
220 dm_descriptor_t		*dm_get_descriptors(dm_desc_type_t type, int filter[],
221 			    int *errp);
222 dm_descriptor_t		*dm_get_associated_descriptors(dm_descriptor_t desc,
223 			    dm_desc_type_t type, int *errp);
224 dm_desc_type_t		*dm_get_associated_types(dm_desc_type_t type);
225 dm_descriptor_t		dm_get_descriptor_by_name(dm_desc_type_t desc_type,
226 			    char *name, int *errp);
227 char			*dm_get_name(dm_descriptor_t desc, int *errp);
228 dm_desc_type_t		dm_get_type(dm_descriptor_t desc);
229 nvlist_t		*dm_get_attributes(dm_descriptor_t desc, int *errp);
230 nvlist_t		*dm_get_stats(dm_descriptor_t desc, int stat_type,
231 			    int *errp);
232 void			dm_init_event_queue(void(*callback)(nvlist_t *, int),
233 			    int *errp);
234 nvlist_t		*dm_get_event(int *errp);
235 
236 #ifdef __cplusplus
237 }
238 #endif
239 
240 #endif /* _LIBDISKMGT_H */
241