schemes/cpu/cpu.c

	cpu.c revision 918a0d8ae0916c29c35aae9b95c22b02a0c6e390
/*
 * 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 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

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

#include <sys/types.h>
#include <sys/processor.h>
#include <fm/fmd_fmri.h>
#include <fm/libtopo.h>

#include <strings.h>
#include <errno.h>
#include <kstat.h>


/*
 * The scheme plugin for cpu FMRIs.
 */

ssize_t
fmd_fmri_nvl2str(nvlist_t *nvl, char *buf, size_t buflen)
{
    int err;
    uint8_t version, type;
    uint32_t cpuid, index, way;
    uint64_t serint;
    char *serstr = NULL;

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

    if (version == CPU_SCHEME_VERSION0) {
        if (nvlist_lookup_uint32(nvl, FM_FMRI_CPU_ID, &cpuid) != 0 ||
            nvlist_lookup_uint64(nvl, FM_FMRI_CPU_SERIAL_ID, &serint)
            != 0)
            return (fmd_fmri_set_errno(EINVAL));

        return (snprintf(buf, buflen, "cpu:///%s=%u/%s=%llX",
            FM_FMRI_CPU_ID, cpuid, FM_FMRI_CPU_SERIAL_ID,
            (u_longlong_t)serint));

    } else if (version == CPU_SCHEME_VERSION1) {
        if (nvlist_lookup_uint32(nvl, FM_FMRI_CPU_ID, &cpuid) != 0)
            return (fmd_fmri_set_errno(EINVAL));

        /*
         * Serial number is an optional element
         */
        if ((err = nvlist_lookup_string(nvl, FM_FMRI_CPU_SERIAL_ID,
            &serstr)) != 0)

            if (err != ENOENT)
                return (fmd_fmri_set_errno(EINVAL));

        /*
         * Cache index, way and type are optional elements
         * But if we have one of them, we must have them all.
         */
        err = nvlist_lookup_uint32(nvl, FM_FMRI_CPU_CACHE_INDEX,
            &index);
        err |= nvlist_lookup_uint32(nvl, FM_FMRI_CPU_CACHE_WAY, &way);
        err |= nvlist_lookup_uint8(nvl, FM_FMRI_CPU_CACHE_TYPE, &type);

        /* Insure there were no errors accessing the nvl */
        if (err != 0 && err != ENOENT)
            return (fmd_fmri_set_errno(EINVAL));

        if (serstr == NULL) {
            /* If we have a serial string and no cache info */
            if (err == ENOENT)
                return (snprintf(buf, buflen, "cpu:///%s=%u",
                    FM_FMRI_CPU_ID, cpuid));
            else {
                return (snprintf(buf, buflen,
                    "cpu:///%s=%u/%s=%u/%s=%u/%s=%d",
                    FM_FMRI_CPU_ID, cpuid,
                    FM_FMRI_CPU_CACHE_INDEX, index,
                    FM_FMRI_CPU_CACHE_WAY, way,
                    FM_FMRI_CPU_CACHE_TYPE, type));
            }
        } else {
            if (err == ENOENT) {
                return (snprintf(buf, buflen,
                    "cpu:///%s=%u/%s=%s",
                    FM_FMRI_CPU_ID, cpuid,
                    FM_FMRI_CPU_SERIAL_ID, serstr));
            } else {
                return (snprintf(buf, buflen,
                    "cpu:///%s=%u/%s=%s/%s=%u/%s=%u/%s=%d",
                    FM_FMRI_CPU_ID, cpuid,
                    FM_FMRI_CPU_SERIAL_ID, serstr,
                    FM_FMRI_CPU_CACHE_INDEX, index,
                    FM_FMRI_CPU_CACHE_WAY, way,
                    FM_FMRI_CPU_CACHE_TYPE, type));
            }
        }
    } else
        return (fmd_fmri_set_errno(EINVAL));
}

/*
 * Determine if a cpuid is present.
 */
/*ARGSUSED*/
static int
cpu_cpuid_present(uint32_t cpuid)
{
#ifdef  sparc
    /*
     * For SPARC, use kstats to see if the cpuid is present.
     * Note that this may need to change for sun4v.
     */
    kstat_ctl_t *kc;
    kstat_t *ksp = NULL;
    if ((kc = kstat_open()) == NULL)
        return (-1); /* errno is set for us */
    ksp = kstat_lookup(kc, "cpu_info", cpuid, NULL);
    (void) kstat_close(kc);
    return ((ksp == NULL) ? 0 : 1);
#else   /* sparc */
    /*
     * For x64, just return true.
     */
    return (1);
#endif  /* sparc */
}

static int
cpu_get_serialid_kstat(uint32_t cpuid, uint64_t *serialidp)
{
    kstat_named_t *kn;
    kstat_ctl_t *kc;
    kstat_t *ksp;
    int i;

    if ((kc = kstat_open()) == NULL)
        return (-1); /* errno is set for us */

    if ((ksp = kstat_lookup(kc, "cpu_info", cpuid, NULL)) == NULL) {
        (void) kstat_close(kc);
        return (fmd_fmri_set_errno(ENOENT));
    }

    if (kstat_read(kc, ksp, NULL) == -1) {
        int oserr = errno;
        (void) kstat_close(kc);
        return (fmd_fmri_set_errno(oserr));
    }

    for (kn = ksp->ks_data, i = 0; i < ksp->ks_ndata; i++, kn++) {
        if (strcmp(kn->name, "device_ID") == 0) {
            *serialidp = kn->value.ui64;
            (void) kstat_close(kc);
            return (0);
        }
    }

    (void) kstat_close(kc);
    return (fmd_fmri_set_errno(ENOENT));
}

static int
cpu_get_serialid_V1(uint32_t cpuid, char *serbuf, size_t len)
{
    int err;
    uint64_t serial = 0;

    err = cpu_get_serialid_kstat(cpuid, &serial);

    (void) snprintf(serbuf, len, "%llX", (u_longlong_t)serial);
    return (err);
}

static int
cpu_get_serialid_V0(uint32_t cpuid, uint64_t *serialidp)
{
    return (cpu_get_serialid_kstat(cpuid, serialidp));
}

int
fmd_fmri_expand(nvlist_t *nvl)
{
    uint8_t version;
    uint32_t cpuid;
    uint64_t serialid;
    char *serstr, serbuf[21]; /* sizeof (UINT64_MAX) + '\0' */
    int rc, err;
    topo_hdl_t *thp;

    if (nvlist_lookup_uint8(nvl, FM_VERSION, &version) != 0 ||
        nvlist_lookup_uint32(nvl, FM_FMRI_CPU_ID, &cpuid) != 0)
        return (fmd_fmri_set_errno(EINVAL));

    /*
     * If the cpu-scheme topology exports this method expand(), invoke it.
     */
    if ((thp = fmd_fmri_topo_hold(TOPO_VERSION)) == NULL)
        return (fmd_fmri_set_errno(EINVAL));

    rc = topo_fmri_expand(thp, nvl, &err);
    fmd_fmri_topo_rele(thp);
    if (err != ETOPO_METHOD_NOTSUP)
        return (rc);

    if (version == CPU_SCHEME_VERSION0) {
        if ((rc = nvlist_lookup_uint64(nvl, FM_FMRI_CPU_SERIAL_ID,
            &serialid)) != 0) {
            if (rc != ENOENT)
                return (fmd_fmri_set_errno(rc));

            if (cpu_get_serialid_V0(cpuid, &serialid) != 0)
                return (-1); /* errno is set for us */

            if ((rc = nvlist_add_uint64(nvl, FM_FMRI_CPU_SERIAL_ID,
                serialid)) != 0)
                return (fmd_fmri_set_errno(rc));
        }
    } else if (version == CPU_SCHEME_VERSION1) {
        if ((rc = nvlist_lookup_string(nvl, FM_FMRI_CPU_SERIAL_ID,
            &serstr)) != 0) {
            if (rc != ENOENT)
                return (fmd_fmri_set_errno(rc));

            if (cpu_get_serialid_V1(cpuid, serbuf, 21) != 0)
                return (0); /* Serial number is optional */

            if ((rc = nvlist_add_string(nvl, FM_FMRI_CPU_SERIAL_ID,
                serbuf)) != 0)
                return (fmd_fmri_set_errno(rc));
        }
    } else {
        return (fmd_fmri_set_errno(EINVAL));
    }

    return (0);
}

int
fmd_fmri_present(nvlist_t *nvl)
{
    int rc, err;
    uint8_t version;
    uint32_t cpuid;
    uint64_t nvlserid, curserid;
    char *nvlserstr, curserbuf[21]; /* sizeof (UINT64_MAX) + '\0' */
    topo_hdl_t *thp;

    if (nvlist_lookup_uint8(nvl, FM_VERSION, &version) != 0 ||
        nvlist_lookup_uint32(nvl, FM_FMRI_CPU_ID, &cpuid) != 0)
        return (fmd_fmri_set_errno(EINVAL));

    /*
     * If the cpu-scheme topology exports this method present(), invoke it.
     */
    if ((thp = fmd_fmri_topo_hold(TOPO_VERSION)) == NULL)
        return (fmd_fmri_set_errno(EINVAL));
    rc = topo_fmri_present(thp, nvl, &err);
    fmd_fmri_topo_rele(thp);
    if (err != ETOPO_METHOD_NOTSUP)
        return (rc);

    if (version == CPU_SCHEME_VERSION0) {
        if (nvlist_lookup_uint64(nvl, FM_FMRI_CPU_SERIAL_ID,
            &nvlserid) != 0)
            return (fmd_fmri_set_errno(EINVAL));
        if (cpu_get_serialid_V0(cpuid, &curserid) != 0)
            return (errno == ENOENT ? 0 : -1);

        return (curserid == nvlserid);

    } else if (version == CPU_SCHEME_VERSION1) {
        if ((rc = nvlist_lookup_string(nvl, FM_FMRI_CPU_SERIAL_ID,
            &nvlserstr)) != 0)
            if (rc != ENOENT)
                return (fmd_fmri_set_errno(EINVAL));

        /*
         * If serial id is not available, just check if the cpuid
         * is present.
         */
        if (cpu_get_serialid_V1(cpuid, curserbuf, 21) != 0)
            return (cpu_cpuid_present(cpuid));

        return (strcmp(curserbuf, nvlserstr) == 0 ? 1 : 0);

    } else {
        return (fmd_fmri_set_errno(EINVAL));
    }
}

int
fmd_fmri_unusable(nvlist_t *nvl)
{
    int rc, err = 0;
    uint8_t version;
    uint32_t cpuid;
    topo_hdl_t *thp;

    if (nvlist_lookup_uint8(nvl, FM_VERSION, &version) != 0 ||
        version > FM_CPU_SCHEME_VERSION ||
        nvlist_lookup_uint32(nvl, FM_FMRI_CPU_ID, &cpuid) != 0)
        return (fmd_fmri_set_errno(EINVAL));

    /*
     * If the cpu-scheme topology exports this method unusable(), invoke it.
     */
    if ((thp = fmd_fmri_topo_hold(TOPO_VERSION)) == NULL)
        return (fmd_fmri_set_errno(EINVAL));
    rc = topo_fmri_unusable(thp, nvl, &err);
    fmd_fmri_topo_rele(thp);
    if (err != ETOPO_METHOD_NOTSUP)
        return (rc);

    return (p_online(cpuid, P_STATUS) == P_FAULTED);
}
int
fmd_fmri_contains(nvlist_t *er, nvlist_t *ee)
{
    int ret1, ret2;
    char *erserstr, *eeserstr;
    uint8_t  ertype, eetype, erversion, eeversion;
    uint64_t erserint, eeserint;
    uint32_t erval, eeval;
    size_t count;

    if (nvlist_lookup_uint32(er, FM_FMRI_CPU_ID, &erval) != 0)
        return (0);
    if (nvlist_lookup_uint32(ee, FM_FMRI_CPU_ID, &eeval) != 0)
        return (0);
    if (erval != eeval)
        return (0);

    if (nvlist_lookup_uint8(er, FM_VERSION, &erversion) != 0)
        return (0);

    if (nvlist_lookup_uint8(ee, FM_VERSION, &eeversion) != 0)
        return (0);

    if (erversion != eeversion)
        return (0);

    if (erversion == CPU_SCHEME_VERSION0) {
        if (nvlist_lookup_uint64(er, FM_FMRI_CPU_SERIAL_ID,
            &erserint) != 0)
            return (0);
        if (nvlist_lookup_uint64(ee, FM_FMRI_CPU_SERIAL_ID,
            &eeserint) != 0)
            return (0);
        if (erserint != eeserint)
            return (0);
    } else if (erversion == CPU_SCHEME_VERSION1) {
        /* Serial ID is an optional element */
        if ((ret1 = nvlist_lookup_string(er, FM_FMRI_CPU_SERIAL_ID,
            &erserstr)) != 0)
            if (ret1 != ENOENT)
                return (0);
        if ((ret2 = nvlist_lookup_string(ee, FM_FMRI_CPU_SERIAL_ID,
            &eeserstr)) != 0)
            if (ret2 != ENOENT)
                return (0);
        if (ret1 == 0 && ret2 == 0) {
            count = strlen(erserstr);
            if (strncmp(erserstr, eeserstr, count) != 0)
                return (0);
        }
    }
    if (nvlist_lookup_uint32(er, FM_FMRI_CPU_CACHE_INDEX, &erval) != 0)
        return (0);
    if (nvlist_lookup_uint32(ee, FM_FMRI_CPU_CACHE_INDEX, &eeval) != 0)
        return (0);

    if (erval != eeval)
        return (0);

    if (nvlist_lookup_uint32(er, FM_FMRI_CPU_CACHE_WAY, &erval) != 0)
        return (0);
    if (nvlist_lookup_uint32(ee, FM_FMRI_CPU_CACHE_WAY, &eeval) != 0)
        return (0);

    if (erval != eeval)
        return (0);

    if (nvlist_lookup_uint8(er, FM_FMRI_CPU_CACHE_TYPE, &ertype) != 0)
        return (0);
    if (nvlist_lookup_uint8(ee, FM_FMRI_CPU_CACHE_TYPE, &eetype) != 0)
        return (0);

    if (eetype != ertype)
        return (0);

    return (1);
}