17c478bd9Sstevel@tonic-gate /* 27c478bd9Sstevel@tonic-gate * CDDL HEADER START 37c478bd9Sstevel@tonic-gate * 47c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 599653d4eSeschrock * Common Development and Distribution License (the "License"). 699653d4eSeschrock * You may not use this file except in compliance with the License. 77c478bd9Sstevel@tonic-gate * 87c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 97c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 107c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 117c478bd9Sstevel@tonic-gate * and limitations under the License. 127c478bd9Sstevel@tonic-gate * 137c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 147c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 157c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 167c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 177c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 187c478bd9Sstevel@tonic-gate * 197c478bd9Sstevel@tonic-gate * CDDL HEADER END 207c478bd9Sstevel@tonic-gate */ 217c478bd9Sstevel@tonic-gate /* 222174cb7bSVirginia Wray * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 237c478bd9Sstevel@tonic-gate * Use is subject to license terms. 247c478bd9Sstevel@tonic-gate */ 257c478bd9Sstevel@tonic-gate 267c478bd9Sstevel@tonic-gate #ifndef _LIBDISKMGT_H 277c478bd9Sstevel@tonic-gate #define _LIBDISKMGT_H 287c478bd9Sstevel@tonic-gate 297c478bd9Sstevel@tonic-gate #ifdef __cplusplus 307c478bd9Sstevel@tonic-gate extern "C" { 317c478bd9Sstevel@tonic-gate #endif 327c478bd9Sstevel@tonic-gate 337c478bd9Sstevel@tonic-gate #include <libnvpair.h> 34181c2f42Smmusante #include <sys/swap.h> 3582d71480Ssjelinek 3682d71480Ssjelinek 373e1bd7a2Ssjelinek /* 383e1bd7a2Ssjelinek * Holds all the data regarding the device. 393e1bd7a2Ssjelinek * Private to libdiskmgt. Must use dm_xxx functions to set/get data. 403e1bd7a2Ssjelinek */ 417c478bd9Sstevel@tonic-gate typedef uint64_t dm_descriptor_t; 427c478bd9Sstevel@tonic-gate 437c478bd9Sstevel@tonic-gate typedef enum { 443e1bd7a2Ssjelinek DM_WHO_MKFS = 0, 453e1bd7a2Ssjelinek DM_WHO_ZPOOL, 4646a2abf2Seschrock DM_WHO_ZPOOL_FORCE, 473e1bd7a2Ssjelinek DM_WHO_FORMAT, 483e1bd7a2Ssjelinek DM_WHO_SWAP, 4946657f8dSmmusante DM_WHO_DUMP, 5046657f8dSmmusante DM_WHO_ZPOOL_SPARE 513e1bd7a2Ssjelinek } dm_who_type_t; 523e1bd7a2Ssjelinek 533e1bd7a2Ssjelinek typedef enum { 547c478bd9Sstevel@tonic-gate DM_DRIVE = 0, 557c478bd9Sstevel@tonic-gate DM_CONTROLLER, 567c478bd9Sstevel@tonic-gate DM_MEDIA, 577c478bd9Sstevel@tonic-gate DM_SLICE, 587c478bd9Sstevel@tonic-gate DM_PARTITION, 597c478bd9Sstevel@tonic-gate DM_PATH, 607c478bd9Sstevel@tonic-gate DM_ALIAS, 617c478bd9Sstevel@tonic-gate DM_BUS 627c478bd9Sstevel@tonic-gate } dm_desc_type_t; 637c478bd9Sstevel@tonic-gate 647c478bd9Sstevel@tonic-gate 657c478bd9Sstevel@tonic-gate typedef enum { 667c478bd9Sstevel@tonic-gate DM_DT_UNKNOWN = 0, 677c478bd9Sstevel@tonic-gate DM_DT_FIXED, 687c478bd9Sstevel@tonic-gate DM_DT_ZIP, 697c478bd9Sstevel@tonic-gate DM_DT_JAZ, 707c478bd9Sstevel@tonic-gate DM_DT_FLOPPY, 717c478bd9Sstevel@tonic-gate DM_DT_MO_ERASABLE, 727c478bd9Sstevel@tonic-gate DM_DT_MO_WRITEONCE, 737c478bd9Sstevel@tonic-gate DM_DT_AS_MO, 747c478bd9Sstevel@tonic-gate DM_DT_CDROM, 757c478bd9Sstevel@tonic-gate DM_DT_CDR, 767c478bd9Sstevel@tonic-gate DM_DT_CDRW, 777c478bd9Sstevel@tonic-gate DM_DT_DVDROM, 787c478bd9Sstevel@tonic-gate DM_DT_DVDR, 797c478bd9Sstevel@tonic-gate DM_DT_DVDRAM, 807c478bd9Sstevel@tonic-gate DM_DT_DVDRW, 817c478bd9Sstevel@tonic-gate DM_DT_DDCDROM, 827c478bd9Sstevel@tonic-gate DM_DT_DDCDR, 837c478bd9Sstevel@tonic-gate DM_DT_DDCDRW 847c478bd9Sstevel@tonic-gate } dm_drive_type_t; 857c478bd9Sstevel@tonic-gate 867c478bd9Sstevel@tonic-gate typedef enum { 877c478bd9Sstevel@tonic-gate DM_MT_UNKNOWN = 0, 887c478bd9Sstevel@tonic-gate DM_MT_FIXED, 897c478bd9Sstevel@tonic-gate DM_MT_FLOPPY, 907c478bd9Sstevel@tonic-gate DM_MT_CDROM, 917c478bd9Sstevel@tonic-gate DM_MT_ZIP, 927c478bd9Sstevel@tonic-gate DM_MT_JAZ, 937c478bd9Sstevel@tonic-gate DM_MT_CDR, 947c478bd9Sstevel@tonic-gate DM_MT_CDRW, 957c478bd9Sstevel@tonic-gate DM_MT_DVDROM, 967c478bd9Sstevel@tonic-gate DM_MT_DVDR, 977c478bd9Sstevel@tonic-gate DM_MT_DVDRAM, 987c478bd9Sstevel@tonic-gate DM_MT_MO_ERASABLE, 997c478bd9Sstevel@tonic-gate DM_MT_MO_WRITEONCE, 1007c478bd9Sstevel@tonic-gate DM_MT_AS_MO 1017c478bd9Sstevel@tonic-gate } dm_media_type_t; 1027c478bd9Sstevel@tonic-gate 1037c478bd9Sstevel@tonic-gate #define DM_FILTER_END -1 1047c478bd9Sstevel@tonic-gate 1057c478bd9Sstevel@tonic-gate /* drive stat name */ 1067c478bd9Sstevel@tonic-gate typedef enum { 1077c478bd9Sstevel@tonic-gate DM_DRV_STAT_PERFORMANCE = 0, 1087c478bd9Sstevel@tonic-gate DM_DRV_STAT_DIAGNOSTIC, 1097c478bd9Sstevel@tonic-gate DM_DRV_STAT_TEMPERATURE 1107c478bd9Sstevel@tonic-gate } dm_drive_stat_t; 1117c478bd9Sstevel@tonic-gate 1127c478bd9Sstevel@tonic-gate /* slice stat name */ 1137c478bd9Sstevel@tonic-gate typedef enum { 1147c478bd9Sstevel@tonic-gate DM_SLICE_STAT_USE = 0 1157c478bd9Sstevel@tonic-gate } dm_slice_stat_t; 1167c478bd9Sstevel@tonic-gate 1172174cb7bSVirginia Wray /* partition type */ 1182174cb7bSVirginia Wray typedef enum { 1192174cb7bSVirginia Wray DM_PRIMARY = 0, 1202174cb7bSVirginia Wray DM_EXTENDED, 1212174cb7bSVirginia Wray DM_LOGICAL 1222174cb7bSVirginia Wray } dm_partition_type_t; 1232174cb7bSVirginia Wray 1247c478bd9Sstevel@tonic-gate /* attribute definitions */ 1257c478bd9Sstevel@tonic-gate 1267c478bd9Sstevel@tonic-gate /* drive */ 1277c478bd9Sstevel@tonic-gate #define DM_DISK_UP 1 1287c478bd9Sstevel@tonic-gate #define DM_DISK_DOWN 0 1297c478bd9Sstevel@tonic-gate 1307c478bd9Sstevel@tonic-gate #define DM_CLUSTERED "clustered" 1317c478bd9Sstevel@tonic-gate #define DM_DRVTYPE "drvtype" 1327c478bd9Sstevel@tonic-gate #define DM_FAILING "failing" 1337c478bd9Sstevel@tonic-gate #define DM_LOADED "loaded" /* also in media */ 1347c478bd9Sstevel@tonic-gate #define DM_NDNRERRS "ndevice_not_ready_errors" 1357c478bd9Sstevel@tonic-gate #define DM_NBYTESREAD "nbytes_read" 1367c478bd9Sstevel@tonic-gate #define DM_NBYTESWRITTEN "nbytes_written" 1377c478bd9Sstevel@tonic-gate #define DM_NHARDERRS "nhard_errors" 1387c478bd9Sstevel@tonic-gate #define DM_NILLREQERRS "nillegal_req_errors" 1397c478bd9Sstevel@tonic-gate #define DM_NMEDIAERRS "nmedia_errors" 1407c478bd9Sstevel@tonic-gate #define DM_NNODEVERRS "nno_dev_errors" 1417c478bd9Sstevel@tonic-gate #define DM_NREADOPS "nread_ops" 1427c478bd9Sstevel@tonic-gate #define DM_NRECOVERRS "nrecoverable_errors" 1437c478bd9Sstevel@tonic-gate #define DM_NSOFTERRS "nsoft_errors" 1447c478bd9Sstevel@tonic-gate #define DM_NTRANSERRS "ntransport_errors" 1457c478bd9Sstevel@tonic-gate #define DM_NWRITEOPS "nwrite_ops" 1467c478bd9Sstevel@tonic-gate #define DM_OPATH "opath" 1477c478bd9Sstevel@tonic-gate #define DM_PRODUCT_ID "product_id" 1487c478bd9Sstevel@tonic-gate #define DM_REMOVABLE "removable" /* also in media */ 1497c478bd9Sstevel@tonic-gate #define DM_RPM "rpm" 150*59d8f100SGarrett D'Amore #define DM_SOLIDSTATE "solid_state" 1517c478bd9Sstevel@tonic-gate #define DM_STATUS "status" 1527c478bd9Sstevel@tonic-gate #define DM_SYNC_SPEED "sync_speed" 1537c478bd9Sstevel@tonic-gate #define DM_TEMPERATURE "temperature" 1547c478bd9Sstevel@tonic-gate #define DM_VENDOR_ID "vendor_id" 1557c478bd9Sstevel@tonic-gate #define DM_WIDE "wide" /* also on controller */ 1567c478bd9Sstevel@tonic-gate #define DM_WWN "wwn" 1577c478bd9Sstevel@tonic-gate 1587c478bd9Sstevel@tonic-gate /* bus */ 1597c478bd9Sstevel@tonic-gate #define DM_BTYPE "btype" 1607c478bd9Sstevel@tonic-gate #define DM_CLOCK "clock" /* also on controller */ 1617c478bd9Sstevel@tonic-gate #define DM_PNAME "pname" 1627c478bd9Sstevel@tonic-gate 1637c478bd9Sstevel@tonic-gate /* controller */ 1647c478bd9Sstevel@tonic-gate #define DM_FAST "fast" 1657c478bd9Sstevel@tonic-gate #define DM_FAST20 "fast20" 1667c478bd9Sstevel@tonic-gate #define DM_FAST40 "fast40" 1677c478bd9Sstevel@tonic-gate #define DM_FAST80 "fast80" 1687c478bd9Sstevel@tonic-gate #define DM_MULTIPLEX "multiplex" 1697c478bd9Sstevel@tonic-gate #define DM_PATH_STATE "path_state" 1707c478bd9Sstevel@tonic-gate 1717c478bd9Sstevel@tonic-gate #define DM_CTYPE_ATA "ata" 1727c478bd9Sstevel@tonic-gate #define DM_CTYPE_SCSI "scsi" 1737c478bd9Sstevel@tonic-gate #define DM_CTYPE_FIBRE "fibre channel" 1747c478bd9Sstevel@tonic-gate #define DM_CTYPE_USB "usb" 1757c478bd9Sstevel@tonic-gate #define DM_CTYPE_UNKNOWN "unknown" 1767c478bd9Sstevel@tonic-gate 1777c478bd9Sstevel@tonic-gate /* media */ 1787c478bd9Sstevel@tonic-gate #define DM_BLOCKSIZE "blocksize" 1797c478bd9Sstevel@tonic-gate #define DM_FDISK "fdisk" 1807c478bd9Sstevel@tonic-gate #define DM_MTYPE "mtype" 1817c478bd9Sstevel@tonic-gate #define DM_NACTUALCYLINDERS "nactual_cylinders" 1827c478bd9Sstevel@tonic-gate #define DM_NALTCYLINDERS "nalt_cylinders" 1837c478bd9Sstevel@tonic-gate #define DM_NCYLINDERS "ncylinders" 1847c478bd9Sstevel@tonic-gate #define DM_NHEADS "nheads" 1857c478bd9Sstevel@tonic-gate #define DM_NPHYSCYLINDERS "nphys_cylinders" 1867c478bd9Sstevel@tonic-gate #define DM_NSECTORS "nsectors" /* also in partition */ 1877c478bd9Sstevel@tonic-gate #define DM_SIZE "size" /* also in slice */ 1887c478bd9Sstevel@tonic-gate #define DM_NACCESSIBLE "naccessible" 1897c478bd9Sstevel@tonic-gate #define DM_LABEL "label" 1907c478bd9Sstevel@tonic-gate 1917c478bd9Sstevel@tonic-gate /* partition */ 1927c478bd9Sstevel@tonic-gate #define DM_BCYL "bcyl" 1937c478bd9Sstevel@tonic-gate #define DM_BHEAD "bhead" 1947c478bd9Sstevel@tonic-gate #define DM_BOOTID "bootid" 1957c478bd9Sstevel@tonic-gate #define DM_BSECT "bsect" 1967c478bd9Sstevel@tonic-gate #define DM_ECYL "ecyl" 1977c478bd9Sstevel@tonic-gate #define DM_EHEAD "ehead" 1987c478bd9Sstevel@tonic-gate #define DM_ESECT "esect" 1992174cb7bSVirginia Wray #define DM_PTYPE "ptype" /* this references the partition id */ 2002174cb7bSVirginia Wray #define DM_PARTITION_TYPE "part_type" /* primary, extended, logical */ 2017c478bd9Sstevel@tonic-gate #define DM_RELSECT "relsect" 2027c478bd9Sstevel@tonic-gate 2037c478bd9Sstevel@tonic-gate /* slice */ 2047c478bd9Sstevel@tonic-gate #define DM_DEVICEID "deviceid" 2057c478bd9Sstevel@tonic-gate #define DM_DEVT "devt" 2067c478bd9Sstevel@tonic-gate #define DM_INDEX "index" 2077c478bd9Sstevel@tonic-gate #define DM_EFI_NAME "name" 2087c478bd9Sstevel@tonic-gate #define DM_MOUNTPOINT "mountpoint" 2097c478bd9Sstevel@tonic-gate #define DM_LOCALNAME "localname" 2107c478bd9Sstevel@tonic-gate #define DM_START "start" 2117c478bd9Sstevel@tonic-gate #define DM_TAG "tag" 2127c478bd9Sstevel@tonic-gate #define DM_FLAG "flag" 2137c478bd9Sstevel@tonic-gate #define DM_EFI "efi" /* also on media */ 2147c478bd9Sstevel@tonic-gate #define DM_USED_BY "used_by" 2157c478bd9Sstevel@tonic-gate #define DM_USED_NAME "used_name" 2167c478bd9Sstevel@tonic-gate #define DM_USE_MOUNT "mount" 2177c478bd9Sstevel@tonic-gate #define DM_USE_SVM "svm" 2187c478bd9Sstevel@tonic-gate #define DM_USE_LU "lu" 2197c478bd9Sstevel@tonic-gate #define DM_USE_DUMP "dump" 2207c478bd9Sstevel@tonic-gate #define DM_USE_VXVM "vxvm" 2217c478bd9Sstevel@tonic-gate #define DM_USE_FS "fs" 2227c478bd9Sstevel@tonic-gate #define DM_USE_VFSTAB "vfstab" 22346a2abf2Seschrock #define DM_USE_EXPORTED_ZPOOL "exported_zpool" 22446a2abf2Seschrock #define DM_USE_ACTIVE_ZPOOL "active_zpool" 22599653d4eSeschrock #define DM_USE_SPARE_ZPOOL "spare_zpool" 226fa94a07fSbrendan #define DM_USE_L2CACHE_ZPOOL "l2cache_zpool" 2277c478bd9Sstevel@tonic-gate 2287c478bd9Sstevel@tonic-gate /* event */ 2297c478bd9Sstevel@tonic-gate #define DM_EV_NAME "name" 2307c478bd9Sstevel@tonic-gate #define DM_EV_DTYPE "edtype" 2317c478bd9Sstevel@tonic-gate #define DM_EV_TYPE "evtype" 2327c478bd9Sstevel@tonic-gate #define DM_EV_TADD "add" 2337c478bd9Sstevel@tonic-gate #define DM_EV_TREMOVE "remove" 2347c478bd9Sstevel@tonic-gate #define DM_EV_TCHANGE "change" 2357c478bd9Sstevel@tonic-gate 2367c478bd9Sstevel@tonic-gate /* findisks */ 2377c478bd9Sstevel@tonic-gate #define DM_CTYPE "ctype" 2387c478bd9Sstevel@tonic-gate #define DM_LUN "lun" 2397c478bd9Sstevel@tonic-gate #define DM_TARGET "target" 2407c478bd9Sstevel@tonic-gate 24182d71480Ssjelinek #define NOINUSE_SET getenv("NOINUSE_CHECK") != NULL 24282d71480Ssjelinek 2437c478bd9Sstevel@tonic-gate void dm_free_descriptors(dm_descriptor_t *desc_list); 2447c478bd9Sstevel@tonic-gate void dm_free_descriptor(dm_descriptor_t desc); 2457c478bd9Sstevel@tonic-gate void dm_free_name(char *name); 246181c2f42Smmusante void dm_free_swapentries(swaptbl_t *); 2477c478bd9Sstevel@tonic-gate 2487c478bd9Sstevel@tonic-gate dm_descriptor_t *dm_get_descriptors(dm_desc_type_t type, int filter[], 2497c478bd9Sstevel@tonic-gate int *errp); 2507c478bd9Sstevel@tonic-gate dm_descriptor_t *dm_get_associated_descriptors(dm_descriptor_t desc, 2517c478bd9Sstevel@tonic-gate dm_desc_type_t type, int *errp); 2527c478bd9Sstevel@tonic-gate dm_desc_type_t *dm_get_associated_types(dm_desc_type_t type); 2537c478bd9Sstevel@tonic-gate dm_descriptor_t dm_get_descriptor_by_name(dm_desc_type_t desc_type, 2547c478bd9Sstevel@tonic-gate char *name, int *errp); 2557c478bd9Sstevel@tonic-gate char *dm_get_name(dm_descriptor_t desc, int *errp); 2567c478bd9Sstevel@tonic-gate dm_desc_type_t dm_get_type(dm_descriptor_t desc); 2577c478bd9Sstevel@tonic-gate nvlist_t *dm_get_attributes(dm_descriptor_t desc, int *errp); 2587c478bd9Sstevel@tonic-gate nvlist_t *dm_get_stats(dm_descriptor_t desc, int stat_type, 2597c478bd9Sstevel@tonic-gate int *errp); 2607c478bd9Sstevel@tonic-gate void dm_init_event_queue(void(*callback)(nvlist_t *, int), 2617c478bd9Sstevel@tonic-gate int *errp); 2627c478bd9Sstevel@tonic-gate nvlist_t *dm_get_event(int *errp); 2633e1bd7a2Ssjelinek void dm_get_slices(char *drive, dm_descriptor_t **slices, 2643e1bd7a2Ssjelinek int *errp); 2653e1bd7a2Ssjelinek void dm_get_slice_stats(char *slice, nvlist_t **dev_stats, 2663e1bd7a2Ssjelinek int *errp); 267181c2f42Smmusante int dm_get_swapentries(swaptbl_t **, int *); 2683e1bd7a2Ssjelinek void dm_get_usage_string(char *who, char *data, char **msg); 2693e1bd7a2Ssjelinek int dm_inuse(char *dev_name, char **msg, dm_who_type_t who, 2703e1bd7a2Ssjelinek int *errp); 271181c2f42Smmusante int dm_inuse_swap(const char *dev_name, int *errp); 27246a2abf2Seschrock int dm_isoverlapping(char *dev_name, char **msg, int *errp); 2737c478bd9Sstevel@tonic-gate 2747c478bd9Sstevel@tonic-gate #ifdef __cplusplus 2757c478bd9Sstevel@tonic-gate } 2767c478bd9Sstevel@tonic-gate #endif 2777c478bd9Sstevel@tonic-gate 2787c478bd9Sstevel@tonic-gate #endif /* _LIBDISKMGT_H */ 279