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