libtopo/common/fmd.c

b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh/*
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh *
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * CDDL HEADER START
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh *
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * The contents of this file are subject to the terms of the
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * Common Development and Distribution License (the "License").
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * You may not use this file except in compliance with the License.
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh *
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * or http://www.opensolaris.org/os/licensing.
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * See the License for the specific language governing permissions
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * and limitations under the License.
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh *
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * When distributing Covered Code, include this CDDL HEADER in each
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * If applicable, add the following below this CDDL HEADER, with the
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * fields enclosed by brackets "[]" replaced with your own identifying
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * information: Portions Copyright [yyyy] [name of copyright owner]
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh *
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh * CDDL HEADER END
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh */
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh/*
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh */
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <stdio.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <stdlib.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <string.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <errno.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <ctype.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <alloca.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <limits.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <fm/topo_mod.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <sys/param.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <sys/systeminfo.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <sys/fm/protocol.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <sys/stat.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <topo_method.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <topo_subr.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh#include <fmd.h>
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic int fmd_enum(topo_mod_t *, tnode_t *, const char *, topo_instance_t,
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    topo_instance_t, void *, void *);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic void fmd_release(topo_mod_t *, tnode_t *);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic int fmd_fmri_nvl2str(topo_mod_t *, tnode_t *, topo_version_t,
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    nvlist_t *, nvlist_t **);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhconst topo_method_t fmd_methods[] = {
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    { TOPO_METH_NVL2STR, TOPO_METH_NVL2STR_DESC, TOPO_METH_NVL2STR_VERSION,
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        TOPO_STABILITY_INTERNAL, fmd_fmri_nvl2str },
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    { NULL }
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh};
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic const topo_modops_t fmd_ops =
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    { fmd_enum, fmd_release };
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic const topo_modinfo_t fmd_info =
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    { FMD, FM_FMRI_SCHEME_FMD, FMD_VERSION, &fmd_ops };
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhint
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhfmd_init(topo_mod_t *mod, topo_version_t version)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh{
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    /*
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh     * Turn on module debugging output
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh     */
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if (getenv("TOPOFMDDEBUG"))
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        topo_mod_setdebug(mod);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    topo_mod_dprintf(mod, "initializing fmd builtin\n");
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if (version != FMD_VERSION)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        return (topo_mod_seterrno(mod, EMOD_VER_NEW));
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if (topo_mod_register(mod, &fmd_info, TOPO_VERSION) != 0) {
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        topo_mod_dprintf(mod, "failed to register fmd: "
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh            "%s\n", topo_mod_errmsg(mod));
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        return (-1); /* mod errno already set */
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    }
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    return (0);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh}
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhvoid
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhfmd_fini(topo_mod_t *mod)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh{
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    topo_mod_unregister(mod);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh}
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh/*ARGSUSED*/
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhint
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhfmd_enum(topo_mod_t *mod, tnode_t *pnode, const char *name, topo_instance_t min,
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    topo_instance_t max, void *notused1, void *notused2)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh{
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    /*
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby     * Methods are registered, but there is no enumeration.  Should
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby     * enumeration be added be sure to cater for global vs non-global
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby     * zones.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby     */
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    (void) topo_method_register(mod, pnode, fmd_methods);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    return (0);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh}
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh/*ARGSUSED*/
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic void
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhfmd_release(topo_mod_t *mp, tnode_t *node)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh{
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    topo_method_unregister_all(mp, node);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh}
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic ssize_t
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhfmri_nvl2str(nvlist_t *nvl, char *buf, size_t buflen)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh{
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    char *name;
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if (nvlist_lookup_string(nvl, FM_FMRI_FMD_NAME, &name) != 0)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        return (0);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    return (snprintf(buf, buflen,
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        "%s:///module/%s", FM_FMRI_SCHEME_FMD, name));
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh}
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh/*ARGSUSED*/
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhstatic int
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephhfmd_fmri_nvl2str(topo_mod_t *mod, tnode_t *node, topo_version_t version,
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    nvlist_t *nvl, nvlist_t **out)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh{
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    ssize_t len;
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    char *name = NULL;
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    nvlist_t *fmristr;
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if (version > TOPO_METH_NVL2STR_VERSION)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        return (topo_mod_seterrno(mod, EMOD_VER_NEW));
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if ((len = fmri_nvl2str(nvl, NULL, 0)) == 0 ||
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        (name = topo_mod_alloc(mod, len + 1)) == NULL ||
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        fmri_nvl2str(nvl, name, len + 1) == 0) {
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        if (name != NULL)
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh            topo_mod_free(mod, name, len + 1);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    }
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if (topo_mod_nvalloc(mod, &fmristr, NV_UNIQUE_NAME) != 0) {
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        topo_mod_free(mod, name, len + 1);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    }
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    if (nvlist_add_string(fmristr, "fmri-string", name) != 0) {
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        topo_mod_free(mod, name, len + 1);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        nvlist_free(fmristr);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh        return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    }
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    topo_mod_free(mod, name, len + 1);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    *out = fmristr;
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh    return (0);
b7d3956b92a285d8dac2c7f5f7e28d2ef5347ef8stephh}