schemes/hc/scheme.c

	scheme.c revision 724365f7556fc4201fdb11766ebc6bd918523130
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident   "%Z%%M% %I% %E% SMI"

#include <fm/topo_mod.h>
#include <fm/fmd_fmri.h>
#include <fm/libtopo.h>

typedef struct hc_walk_arg {
    void    *p;
    int *resultp;
} hc_walk_arg_t;

static topo_hdl_t   *HC_thp = NULL;
static char     *HC_uuid = NULL;

int
fmd_fmri_init(void)
{
    int err;

    if ((HC_thp = topo_open(TOPO_VERSION, NULL, &err)) == NULL)
        return (-1);

    return (0);
}

void
fmd_fmri_fini(void)
{
    if (HC_uuid) {
        topo_snap_release(HC_thp);
        topo_hdl_strfree(HC_thp, HC_uuid);
        HC_uuid = NULL;
    }
    topo_close(HC_thp);
}

static int
hc_update_topology(void)
{
    static uint64_t lastgen = 0;
    int err;
    uint64_t curgen;

    if (HC_uuid == NULL ||
        (curgen = fmd_fmri_get_drgen()) > lastgen) {

        lastgen = curgen;

        if (HC_uuid) {
            topo_snap_release(HC_thp);
            topo_hdl_strfree(HC_thp, HC_uuid);
            HC_uuid = NULL;
        }

        if ((HC_uuid = topo_snap_hold(HC_thp, NULL, &err)) == NULL) {
            return (-1);
        }
    }
    return (0);
}

static int
hc_topo_walk(topo_walk_cb_t fn, void *arg, int *resultp)
{
    int err, rv;
    topo_walk_t *twp;
    hc_walk_arg_t hcarg;

    hcarg.p = arg;
    hcarg.resultp = resultp;

    if ((twp = topo_walk_init(HC_thp, FM_FMRI_SCHEME_HC, fn,
        &hcarg, &err)) == NULL)
        return (-1);

    rv = (topo_walk_step(twp, TOPO_WALK_CHILD) == TOPO_WALK_ERR)
        ? -1 : 0;

    topo_walk_fini(twp);
    return (rv);
}

/*
 * buf_append -- Append str to buf (if it's non-NULL).  Place prepend
 * in buf in front of str and append behind it (if they're non-NULL).
 * Continue to update size even if we run out of space to actually
 * stuff characters in the buffer.
 */
static void
buf_append(ssize_t *sz, char *buf, size_t buflen, char *str,
    char *prepend, char *append)
{
    ssize_t left;

    if (str == NULL)
        return;

    if (buflen == 0 || (left = buflen - *sz) < 0)
        left = 0;

    if (buf != NULL && left != 0)
        buf += *sz;

    if (prepend == NULL && append == NULL)
        *sz += snprintf(buf, left, "%s", str);
    else if (append == NULL)
        *sz += snprintf(buf, left, "%s%s", prepend, str);
    else if (prepend == NULL)
        *sz += snprintf(buf, left, "%s%s", str, append);
    else
        *sz += snprintf(buf, left, "%s%s%s", prepend, str, append);
}

ssize_t
fmd_fmri_nvl2str(nvlist_t *nvl, char *buf, size_t buflen)
{
    nvlist_t **hcprs = NULL;
    nvlist_t *anvl = NULL;
    uint8_t version;
    ssize_t size = 0;
    uint_t hcnprs;
    char *achas = NULL;
    char *adom = NULL;
    char *aprod = NULL;
    char *asrvr = NULL;
    char *ahost = NULL;
    char *serial = NULL;
    char *part = NULL;
    char *root = NULL;
    char *rev = NULL;
    int more_auth = 0;
    int err, i;

    if (nvlist_lookup_uint8(nvl, FM_VERSION, &version) != 0 ||
        version > FM_HC_SCHEME_VERSION)
        return (fmd_fmri_set_errno(EINVAL));

    /* Get authority, if present */
    err = nvlist_lookup_nvlist(nvl, FM_FMRI_AUTHORITY, &anvl);
    if (err != 0 && err != ENOENT)
        return (fmd_fmri_set_errno(err));

    if ((err = nvlist_lookup_string(nvl, FM_FMRI_HC_ROOT, &root)) != 0)
        return (fmd_fmri_set_errno(EINVAL));

    err = nvlist_lookup_nvlist_array(nvl, FM_FMRI_HC_LIST, &hcprs, &hcnprs);
    if (err != 0 || hcprs == NULL)
        return (fmd_fmri_set_errno(EINVAL));

    if (anvl != NULL) {
        (void) nvlist_lookup_string(anvl,
            FM_FMRI_AUTH_PRODUCT, &aprod);
        (void) nvlist_lookup_string(anvl,
            FM_FMRI_AUTH_CHASSIS, &achas);
        (void) nvlist_lookup_string(anvl,
            FM_FMRI_AUTH_DOMAIN, &adom);
        (void) nvlist_lookup_string(anvl,
            FM_FMRI_AUTH_SERVER, &asrvr);
        (void) nvlist_lookup_string(anvl,
            FM_FMRI_AUTH_HOST, &ahost);
        if (aprod != NULL)
            more_auth++;
        if (achas != NULL)
            more_auth++;
        if (adom != NULL)
            more_auth++;
        if (asrvr != NULL)
            more_auth++;
        if (ahost != NULL)
            more_auth++;
    }

    (void) nvlist_lookup_string(nvl, FM_FMRI_HC_SERIAL_ID, &serial);
    (void) nvlist_lookup_string(nvl, FM_FMRI_HC_PART, &part);
    (void) nvlist_lookup_string(nvl, FM_FMRI_HC_REVISION, &rev);

    /* hc:// */
    buf_append(&size, buf, buflen, FM_FMRI_SCHEME_HC, NULL, "://");

    /* authority, if any */
    if (aprod != NULL)
        buf_append(&size, buf, buflen, aprod, FM_FMRI_AUTH_PRODUCT "=",
            --more_auth > 0 ? "," : NULL);
    if (achas != NULL)
        buf_append(&size, buf, buflen, achas, FM_FMRI_AUTH_CHASSIS "=",
            --more_auth > 0 ? "," : NULL);
    if (adom != NULL)
        buf_append(&size, buf, buflen, adom, FM_FMRI_AUTH_DOMAIN "=",
            --more_auth > 0 ? "," : NULL);
    if (asrvr != NULL)
        buf_append(&size, buf, buflen, asrvr, FM_FMRI_AUTH_SERVER "=",
            --more_auth > 0 ? "," : NULL);
    if (ahost != NULL)
        buf_append(&size, buf, buflen, ahost, FM_FMRI_AUTH_HOST "=",
            NULL);

    /* separating slash */
    if (serial != NULL || part != NULL || rev != NULL)
        buf_append(&size, buf, buflen, "/", NULL, NULL);

    /* hardware-id part */
    buf_append(&size, buf, buflen, serial, ":" FM_FMRI_HC_SERIAL_ID "=",
        NULL);
    buf_append(&size, buf, buflen, part, ":" FM_FMRI_HC_PART "=", NULL);
    buf_append(&size, buf, buflen, rev, ":" FM_FMRI_HC_REVISION "=", NULL);

    /* separating slash */
    buf_append(&size, buf, buflen, "/", NULL, NULL);

    /* hc-root */
    buf_append(&size, buf, buflen, root, NULL, NULL);

    /* all the pairs */
    for (i = 0; i < hcnprs; i++) {
        char *nm = NULL;
        char *id = NULL;

        if (i > 0)
            buf_append(&size, buf, buflen, "/", NULL, NULL);
        (void) nvlist_lookup_string(hcprs[i], FM_FMRI_HC_NAME, &nm);
        (void) nvlist_lookup_string(hcprs[i], FM_FMRI_HC_ID, &id);
        if (nm == NULL || id == NULL)
            return (fmd_fmri_set_errno(EINVAL));
        buf_append(&size, buf, buflen, nm, NULL, "=");
        buf_append(&size, buf, buflen, id, NULL, NULL);
    }

    return (size);
}

/*ARGSUSED*/
static int
hc_topo_present(topo_hdl_t *thp, tnode_t *node, void *arg)
{
    int cmp, err;
    nvlist_t *out = NULL;
    nvlist_t *asru;
    hc_walk_arg_t *hcargp = (hc_walk_arg_t *)arg;

    if (topo_node_asru(node, &asru, NULL, &err) != 0 ||
        asru == NULL) {
        return (TOPO_WALK_NEXT);
    }

    /*
     * Check if the ASRU of this node matches the ASRU passed in
     */
    cmp = topo_fmri_compare(thp, asru, (nvlist_t *)hcargp->p, &err);

    nvlist_free(asru);

    if (cmp <= 0)
        return (TOPO_WALK_NEXT);

    /*
     * Yes, so try to execute the topo-present method.
     */
    cmp = topo_method_invoke(node, TOPO_METH_PRESENT,
        TOPO_METH_PRESENT_VERSION, (nvlist_t *)hcargp->p, &out, &err);

    if (out)
        nvlist_free(out);

    if (cmp == 1) {
        *(hcargp->resultp) = 1;
        return (TOPO_WALK_TERMINATE);
    } else if (cmp == 0) {
        *(hcargp->resultp) = 0;
        return (TOPO_WALK_TERMINATE);
    }

    return (TOPO_WALK_NEXT);
}


/*
 * fmd_fmri_present() is called by fmadm to determine if a faulty ASRU
 * is still present in the system.  In general we don't expect to get
 * ASRUs in this scheme, so it's unlikely this routine will get called.
 * In case it does, though, we just traverse our libtopo snapshot,
 * looking for a matching ASRU (minus the serial number information),
 * then invoke the "topo_present" method to determine presence.
 */
int
fmd_fmri_present(nvlist_t *nvl)
{
    int ispresent = 1;

    /*
     * If there's an error during the topology update, punt by
     * indicating presence.
     */
    if (hc_update_topology() < 0)
        return (1);

    (void) hc_topo_walk(hc_topo_present, nvl, &ispresent);

    return (ispresent);
}

/*
 * fmd_fmri_unusable() is called by fmadm to determine if a faulty ASRU
 * is usable.  In general we don't expect to get ASRUs in this scheme,
 * so it's unlikely this routine will get called.  In case it does,
 * though, we just return false by default, as we have no real way to
 * find the component or determine the component's usability.
 */
/*ARGSUSED*/
int
fmd_fmri_unusable(nvlist_t *nvl)
{
    return (0);
}