usr/src/lib/fm/libdiskstatus/common/libdiskstatus.h

   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 #pragma ident   "%Z%%M% %I%     %E% SMI"
  30
  31 #include <libnvpair.h>
  32 #include <sys/types.h>
  33
  34 #ifdef  __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 typedef struct disk_status disk_status_t;
  39
  40 /*
  41  * Error definitions
  42  */
  43 #define EDS_BASE        2000
  44
  45 enum {
  46         EDS_NOMEM = EDS_BASE,           /* memory allocation failure */
  47         EDS_CANT_OPEN,                  /* failed to open device */
  48         EDS_NO_TRANSPORT,               /* no supported transport */
  49         EDS_NOT_SUPPORTED,              /* status information not supported */
  50         EDS_NOT_SIMULATOR,              /* not a valid simulator file */
  51         EDS_IO                          /* I/O error */
  52 };
  53
  54 /*
  55  * Basic library functions
  56  */
  57 extern disk_status_t *disk_status_open(const char *, int *);
  58 extern void disk_status_close(disk_status_t *);
  59 extern const char *disk_status_errmsg(int);
  60 extern void disk_status_set_debug(boolean_t);
  61 extern int disk_status_errno(disk_status_t *);
  62
  63 /*
  64  * Miscellaneous functions.
  65  */
  66 extern const char *disk_status_path(disk_status_t *);
  67
  68 /*
  69  * Main entry point.
  70  */
  71 extern nvlist_t *disk_status_get(disk_status_t *);
  72
  73 /*
  74  * Utility function to simulate predictive failure (device-specific).
  75  */
  76 extern int disk_status_test_predfail(disk_status_t *);
  77
  78 #ifdef  __cplusplus
  79 }
  80 #endif
  81
  82 #endif  /* _LIBDISKSTATUS_H */