libdiskstatus/common/libdiskstatus.c

24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock/*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * CDDL HEADER START
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * The contents of this file are subject to the terms of the
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * Common Development and Distribution License (the "License").
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * You may not use this file except in compliance with the License.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * or http://www.opensolaris.org/os/licensing.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * See the License for the specific language governing permissions
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * and limitations under the License.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * When distributing Covered Code, include this CDDL HEADER in each
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * If applicable, add the following below this CDDL HEADER, with the
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * fields enclosed by brackets "[]" replaced with your own identifying
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * information: Portions Copyright [yyyy] [name of copyright owner]
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * CDDL HEADER END
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock/*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * Use is subject to license terms.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#pragma ident   "%Z%%M% %I% %E% SMI"
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock/*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * Disk status library
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * This library is responsible for querying health and other status information
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * from disk drives.  It is intended to be a generic interface, however only
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * SCSI (and therefore SATA) disks are currently supported.  The library is
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * capable of detecting the following status conditions:
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *  - Predictive failure
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *  - Overtemp
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock *  - Self-test failure
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <assert.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <errno.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <fcntl.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <libdevinfo.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <libdiskstatus.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <stdlib.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <string.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <sys/fm/io/scsi.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <sys/stat.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include <unistd.h>
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include "ds_impl.h"
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#include "ds_scsi.h"
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockstatic ds_transport_t *ds_transports[] = {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    &ds_scsi_sim_transport,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    &ds_scsi_uscsi_transport
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock};
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock#define NTRANSPORTS (sizeof (ds_transports) / sizeof (ds_transports[0]))
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock/*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * Open a handle to a disk.  This will fail if the device cannot be opened, or
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * if no suitable transport exists for communicating with the device.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockdisk_status_t *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockdisk_status_open(const char *path, int *error)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock{
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    disk_status_t *dsp;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    ds_transport_t *t;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    int i;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if ((dsp = calloc(sizeof (disk_status_t), 1)) == NULL) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        *error = EDS_NOMEM;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if ((dsp->ds_fd = open(path, O_RDWR)) < 0) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        *error = EDS_CANT_OPEN;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        free(dsp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if ((dsp->ds_path = strdup(path)) == NULL) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        *error = EDS_NOMEM;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        disk_status_close(dsp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    for (i = 0; i < NTRANSPORTS; i++) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        t = ds_transports[i];
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        dsp->ds_transport = t;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        nvlist_free(dsp->ds_state);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        dsp->ds_state = NULL;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        if (nvlist_alloc(&dsp->ds_state, NV_UNIQUE_NAME, 0) != 0) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            *error = EDS_NOMEM;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            disk_status_close(dsp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        if ((dsp->ds_data = t->dt_open(dsp)) == NULL) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            if (dsp->ds_error != EDS_NO_TRANSPORT) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock                *error = dsp->ds_error;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock                disk_status_close(dsp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock                return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        } else {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            dsp->ds_error = 0;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            break;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if (dsp->ds_error == EDS_NO_TRANSPORT) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        *error = dsp->ds_error;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        disk_status_close(dsp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    return (dsp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock}
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock/*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * Close a handle to a disk.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockvoid
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockdisk_status_close(disk_status_t *dsp)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock{
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(dsp->ds_state);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(dsp->ds_predfail);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(dsp->ds_overtemp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(dsp->ds_testfail);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if (dsp->ds_data)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        dsp->ds_transport->dt_close(dsp->ds_data);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    (void) close(dsp->ds_fd);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    free(dsp->ds_path);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    free(dsp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock}
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockvoid
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockdisk_status_set_debug(boolean_t value)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock{
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    ds_debug = value;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock}
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock/*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock * Query basic information
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockconst char *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockdisk_status_path(disk_status_t *dsp)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock{
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    return (dsp->ds_path);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock}
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockint
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockdisk_status_errno(disk_status_t *dsp)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock{
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    return (dsp->ds_error);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock}
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrocknvlist_t *
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrockdisk_status_get(disk_status_t *dsp)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock{
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_t *nvl = NULL;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_t *faults = NULL;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    int err;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    /*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock     * Scan (or rescan) the current device.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock     */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(dsp->ds_testfail);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(dsp->ds_predfail);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(dsp->ds_overtemp);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    dsp->ds_testfail = dsp->ds_overtemp = dsp->ds_predfail = NULL;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    dsp->ds_faults = 0;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    /*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock     * Even if there is an I/O failure when trying to scan the device, we
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock     * can still return the current state.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock     */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if (dsp->ds_transport->dt_scan(dsp->ds_data) != 0 &&
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        dsp->ds_error != EDS_IO)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if ((err = nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0)) != 0)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        goto nverror;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if ((err = nvlist_add_string(nvl, "protocol", "scsi")) != 0 ||
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        (err = nvlist_add_nvlist(nvl, "status", dsp->ds_state)) != 0)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        goto nverror;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    /*
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock     * Construct the list of faults.
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock     */
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if ((err = nvlist_alloc(&faults, NV_UNIQUE_NAME, 0)) != 0)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        goto nverror;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if (dsp->ds_predfail != NULL) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        if ((err = nvlist_add_boolean_value(faults,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            FM_EREPORT_SCSI_PREDFAIL,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            (dsp->ds_faults & DS_FAULT_PREDFAIL) != 0)) != 0 ||
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            (err = nvlist_add_nvlist(nvl, FM_EREPORT_SCSI_PREDFAIL,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            dsp->ds_predfail)) != 0)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            goto nverror;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if (dsp->ds_testfail != NULL) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        if ((err = nvlist_add_boolean_value(faults,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            FM_EREPORT_SCSI_TESTFAIL,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            (dsp->ds_faults & DS_FAULT_TESTFAIL) != 0)) != 0 ||
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            (err = nvlist_add_nvlist(nvl, FM_EREPORT_SCSI_TESTFAIL,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            dsp->ds_testfail)) != 0)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            goto nverror;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if (dsp->ds_overtemp != NULL) {
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        if ((err = nvlist_add_boolean_value(faults,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            FM_EREPORT_SCSI_OVERTEMP,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            (dsp->ds_faults & DS_FAULT_OVERTEMP) != 0)) != 0 ||
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            (err = nvlist_add_nvlist(nvl, FM_EREPORT_SCSI_OVERTEMP,
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            dsp->ds_overtemp)) != 0)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock            goto nverror;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    }
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    if ((err = nvlist_add_nvlist(nvl, "faults", faults)) != 0)
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock        goto nverror;
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(faults);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    return (nvl);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrocknverror:
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    assert(err == ENOMEM);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(nvl);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    nvlist_free(faults);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    (void) ds_set_errno(dsp, EDS_NOMEM);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock    return (NULL);
24db46411fd54f70c35b94bb952eb7ba040e43b4eschrock}