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