2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License (the "License").
2N/A * You may not use this file except in compliance with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A */
2N/A
2N/A/*
2N/A * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved.
2N/A */
2N/A
2N/A#include <limits.h>
2N/A#include <strings.h>
2N/A#include <unistd.h>
2N/A#include <alloca.h>
2N/A#include <libnvpair.h>
2N/A#include <fm/topo_mod.h>
2N/A#include <sys/fm/protocol.h>
2N/A
2N/A#include <fcntl.h>
2N/A#include <sys/types.h>
2N/A#include <sys/stat.h>
2N/A#include <sys/objfs.h>
2N/A#include <sys/modctl.h>
2N/A#include <libelf.h>
2N/A#include <gelf.h>
2N/A
2N/A#include <topo_method.h>
2N/A#include <topo_module.h>
2N/A#include <topo_subr.h>
2N/A#include <mod.h>
2N/A
2N/Astatic int mod_enum(topo_mod_t *, tnode_t *, const char *, topo_instance_t,
2N/A topo_instance_t, void *, void *);
2N/Astatic void mod_release(topo_mod_t *, tnode_t *);
2N/Astatic int mod_fmri_create_meth(topo_mod_t *, tnode_t *, topo_version_t,
2N/A nvlist_t *, nvlist_t **);
2N/Astatic int mod_fmri_nvl2str(topo_mod_t *, tnode_t *, topo_version_t,
2N/A nvlist_t *, nvlist_t **);
2N/Astatic int mod_fmri_str2nvl(topo_mod_t *, tnode_t *, topo_version_t,
2N/A nvlist_t *, nvlist_t **);
2N/A
2N/Astatic const topo_method_t mod_methods[] = {
2N/A { TOPO_METH_FMRI, TOPO_METH_FMRI_DESC, TOPO_METH_FMRI_VERSION,
2N/A TOPO_STABILITY_INTERNAL, mod_fmri_create_meth },
2N/A { TOPO_METH_NVL2STR, TOPO_METH_NVL2STR_DESC, TOPO_METH_NVL2STR_VERSION,
2N/A TOPO_STABILITY_INTERNAL, mod_fmri_nvl2str },
2N/A { TOPO_METH_STR2NVL, TOPO_METH_STR2NVL_DESC, TOPO_METH_STR2NVL_VERSION,
2N/A TOPO_STABILITY_INTERNAL, mod_fmri_str2nvl },
2N/A { NULL }
2N/A};
2N/A
2N/Astatic const topo_modops_t mod_modops =
2N/A { mod_enum, mod_release };
2N/Astatic const topo_modinfo_t mod_info =
2N/A { "mod", FM_FMRI_SCHEME_MOD, MOD_VERSION, &mod_modops };
2N/A
2N/Aint
2N/Amod_init(topo_mod_t *mod, topo_version_t version)
2N/A{
2N/A if (getenv("TOPOMODDEBUG"))
2N/A topo_mod_setdebug(mod);
2N/A topo_mod_dprintf(mod, "initializing mod builtin\n");
2N/A
2N/A if (version != MOD_VERSION)
2N/A return (topo_mod_seterrno(mod, EMOD_VER_NEW));
2N/A
2N/A if (topo_mod_register(mod, &mod_info, TOPO_VERSION) != 0) {
2N/A topo_mod_dprintf(mod, "failed to register mod_info: "
2N/A "%s\n", topo_mod_errmsg(mod));
2N/A return (-1); /* mod errno already set */
2N/A }
2N/A
2N/A return (0);
2N/A}
2N/A
2N/Avoid
2N/Amod_fini(topo_mod_t *mod)
2N/A{
2N/A topo_mod_unregister(mod);
2N/A}
2N/A
2N/A/*ARGSUSED*/
2N/Astatic int
2N/Amod_enum(topo_mod_t *mod, tnode_t *pnode, const char *name,
2N/A topo_instance_t min, topo_instance_t max, void *notused1, void *notused2)
2N/A{
2N/A /*
2N/A * Methods are registered, but there is no enumeration. Should
2N/A * enumeration be added be sure to cater for global vs non-global
2N/A * zones.
2N/A */
2N/A (void) topo_method_register(mod, pnode, mod_methods);
2N/A return (0);
2N/A}
2N/A
2N/Astatic void
2N/Amod_release(topo_mod_t *mod, tnode_t *node)
2N/A{
2N/A topo_method_unregister_all(mod, node);
2N/A}
2N/A
2N/Astatic int
2N/Amod_binary_path_get(topo_mod_t *mp, const char *objpath)
2N/A{
2N/A Elf *elf = NULL;
2N/A Elf_Scn *scn = NULL;
2N/A GElf_Ehdr ehdr;
2N/A GElf_Shdr shdr;
2N/A int fd;
2N/A
2N/A if ((fd = open(objpath, O_RDONLY)) < 0) {
2N/A topo_mod_dprintf(mp, "unable to open %s\n", objpath);
2N/A return (-1);
2N/A }
2N/A
2N/A if (elf_version(EV_CURRENT) == EV_NONE) {
2N/A topo_mod_dprintf(mp, "Elf version out of whack\n");
2N/A goto mbpg_bail;
2N/A }
2N/A if ((elf = elf_begin(fd, ELF_C_READ, NULL)) == NULL) {
2N/A topo_mod_dprintf(mp, "elf_begin failed\n");
2N/A goto mbpg_bail;
2N/A }
2N/A if ((gelf_getehdr(elf, &ehdr)) == NULL) {
2N/A topo_mod_dprintf(mp, "gelf_getehdr failed\n");
2N/A goto mbpg_bail;
2N/A }
2N/A scn = elf_getscn(elf, 0); /* "seek" to start of sections */
2N/A while ((scn = elf_nextscn(elf, scn)) != NULL) {
2N/A const char *sh_name;
2N/A if (gelf_getshdr(scn, &shdr) == NULL) {
2N/A topo_mod_dprintf(mp, "gelf_getshdr failed\n");
2N/A goto mbpg_bail;
2N/A }
2N/A if ((shdr.sh_type != SHT_PROGBITS) ||
2N/A (shdr.sh_flags & SHF_SUNW_ABSENT))
2N/A continue;
2N/A sh_name = elf_strptr(elf,
2N/A ehdr.e_shstrndx, (size_t)shdr.sh_name);
2N/A if (strcmp(sh_name, ".filename") != 0)
2N/A continue;
2N/A if (elf_getdata(scn, NULL) == NULL) {
2N/A topo_mod_dprintf(mp, "no filename data");
2N/A break;
2N/A }
2N/A break;
2N/A }
2N/A (void) elf_end(elf);
2N/A (void) close(fd);
2N/A return (0);
2N/A
2N/Ambpg_bail:
2N/A if (elf != NULL)
2N/A (void) elf_end(elf);
2N/A if (fd >= 0)
2N/A (void) close(fd);
2N/A (void) topo_mod_seterrno(mp, EMOD_METHOD_INVAL);
2N/A return (-1);
2N/A}
2N/A
2N/Astatic int
2N/Amod_nvl_data(topo_mod_t *mp, nvlist_t *out, const char *path)
2N/A{
2N/A struct modinfo mi;
2N/A struct stat64 s;
2N/A int id, e;
2N/A
2N/A if (stat64(path, &s) < 0) {
2N/A topo_mod_dprintf(mp,
2N/A "No system object file for driver %s", path);
2N/A return (topo_mod_seterrno(mp, EMOD_METHOD_INVAL));
2N/A }
2N/A
2N/A id = OBJFS_MODID(s.st_ino);
2N/A mi.mi_id = mi.mi_nextid = id;
2N/A mi.mi_info = MI_INFO_ONE | MI_INFO_NOBASE;
2N/A if (modctl(MODINFO, id, &mi) < 0) {
2N/A return (topo_mod_seterrno(mp, EMOD_METHOD_INVAL));
2N/A }
2N/A mi.mi_name[MODMAXNAMELEN - 1] = '\0';
2N/A mi.mi_msinfo[0].msi_linkinfo[MODMAXNAMELEN - 1] = '\0';
2N/A e = nvlist_add_string(out, FM_FMRI_SCHEME, FM_FMRI_SCHEME_MOD);
2N/A e |= nvlist_add_uint8(out, FM_VERSION, FM_MOD_SCHEME_VERSION);
2N/A e |= nvlist_add_string(out, FM_FMRI_MOD_NAME, mi.mi_name);
2N/A e |= nvlist_add_string(out,
2N/A FM_FMRI_MOD_DESC, mi.mi_msinfo[0].msi_linkinfo);
2N/A if (e != 0)
2N/A return (topo_mod_seterrno(mp, EMOD_FMRI_NVL));
2N/A
2N/A return (0);
2N/A}
2N/A
2N/Astatic nvlist_t *
2N/Amod_fmri_create(topo_mod_t *mp, const char *driver)
2N/A{
2N/A nvlist_t *out = NULL;
2N/A char objpath[PATH_MAX];
2N/A
2N/A if (topo_mod_nvalloc(mp, &out, NV_UNIQUE_NAME) != 0) {
2N/A (void) topo_mod_seterrno(mp, EMOD_FMRI_NVL);
2N/A goto mfc_bail;
2N/A }
2N/A
2N/A (void) snprintf(objpath, PATH_MAX, "%s/%s/object", OBJFS_ROOT, driver);
2N/A
2N/A /*
2N/A * Validate the module object ELF header if possible
2N/A */
2N/A if (mod_binary_path_get(mp, objpath) < 0)
2N/A goto mfc_bail;
2N/A
2N/A if (mod_nvl_data(mp, out, objpath) < 0) {
2N/A topo_mod_dprintf(mp, "failed to get modinfo for %s", driver);
2N/A goto mfc_bail;
2N/A }
2N/A
2N/A return (out);
2N/A
2N/Amfc_bail:
2N/A nvlist_free(out);
2N/A return (NULL);
2N/A}
2N/A
2N/A/*ARGSUSED*/
2N/Astatic int
2N/Amod_fmri_create_meth(topo_mod_t *mp, tnode_t *node, topo_version_t version,
2N/A nvlist_t *in, nvlist_t **out)
2N/A{
2N/A nvlist_t *args;
2N/A nvlist_t *modnvl;
2N/A char *driver;
2N/A
2N/A if (version > TOPO_METH_FMRI_VERSION)
2N/A return (topo_mod_seterrno(mp, EMOD_VER_NEW));
2N/A
2N/A if (nvlist_lookup_nvlist(in, TOPO_METH_FMRI_ARG_NVL, &args) != 0 ||
2N/A nvlist_lookup_string(args, "DRIVER", &driver) != 0) {
2N/A topo_mod_dprintf(mp, "no DRIVER string in method argument\n");
2N/A return (topo_mod_seterrno(mp, EMOD_METHOD_INVAL));
2N/A }
2N/A
2N/A modnvl = mod_fmri_create(mp, driver);
2N/A if (modnvl == NULL) {
2N/A *out = NULL;
2N/A topo_mod_dprintf(mp, "failed to create contained mod FMRI\n");
2N/A return (-1);
2N/A }
2N/A *out = modnvl;
2N/A return (0);
2N/A}
2N/A
2N/A#define MAXINTSTR 11
2N/A
2N/Astatic ssize_t
2N/Afmri_nvl2str(nvlist_t *nvl, char *buf, size_t buflen)
2N/A{
2N/A nvlist_t *anvl = NULL;
2N/A nvpair_t *apair;
2N/A uint8_t version;
2N/A ssize_t size = 0;
2N/A char *modname = NULL, *aname, *aval;
2N/A int err;
2N/A
2N/A if (nvlist_lookup_uint8(nvl, FM_VERSION, &version) != 0 ||
2N/A version > FM_MOD_SCHEME_VERSION)
2N/A return (-1);
2N/A
2N/A /* Get authority, if present */
2N/A err = nvlist_lookup_nvlist(nvl, FM_FMRI_AUTHORITY, &anvl);
2N/A if (err != 0 && err != ENOENT)
2N/A return (-1);
2N/A
2N/A /*
2N/A * For brevity, we only include the module name and id
2N/A * present in the FMRI in our output string. The FMRI
2N/A * also has data on the package containing the module.
2N/A */
2N/A
2N/A /* There must be a module name */
2N/A err = nvlist_lookup_string(nvl, FM_FMRI_MOD_NAME, &modname);
2N/A if (err != 0 || modname == NULL)
2N/A return (-1);
2N/A
2N/A /* mod:// */
2N/A topo_fmristr_build(&size, buf, buflen, FM_FMRI_SCHEME_MOD, NULL, "://");
2N/A
2N/A /* authority, if any */
2N/A if (anvl != NULL) {
2N/A for (apair = nvlist_next_nvpair(anvl, NULL);
2N/A apair != NULL; apair = nvlist_next_nvpair(anvl, apair)) {
2N/A if (nvpair_type(apair) != DATA_TYPE_STRING ||
2N/A nvpair_value_string(apair, &aval) != 0)
2N/A continue;
2N/A aname = nvpair_name(apair);
2N/A /* omit chassis alias */
2N/A if (strcmp(aname, FM_FMRI_AUTH_V1_CHASSIS_ALIAS) == 0)
2N/A continue;
2N/A topo_fmristr_build(&size, buf, buflen, ":", NULL, NULL);
2N/A topo_fmristr_build(&size, buf, buflen, "=",
2N/A aname, aval);
2N/A }
2N/A }
2N/A
2N/A /* module parts */
2N/A topo_fmristr_build(&size, buf, buflen, modname,
2N/A "/" FM_FMRI_MOD_NAME "=", "/");
2N/A
2N/A return (size);
2N/A}
2N/A
2N/A/*ARGSUSED*/
2N/Astatic int
2N/Amod_fmri_nvl2str(topo_mod_t *mod, tnode_t *node, topo_version_t version,
2N/A nvlist_t *nvl, nvlist_t **out)
2N/A{
2N/A ssize_t len;
2N/A char *name = NULL;
2N/A nvlist_t *fmristr;
2N/A
2N/A if (version > TOPO_METH_NVL2STR_VERSION)
2N/A return (topo_mod_seterrno(mod, EMOD_VER_NEW));
2N/A
2N/A if ((len = fmri_nvl2str(nvl, NULL, 0)) == 0 ||
2N/A (name = topo_mod_alloc(mod, len + 1)) == NULL ||
2N/A fmri_nvl2str(nvl, name, len + 1) == 0) {
2N/A if (name != NULL)
2N/A topo_mod_free(mod, name, len + 1);
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
2N/A }
2N/A
2N/A if (topo_mod_nvalloc(mod, &fmristr, NV_UNIQUE_NAME) != 0)
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
2N/A if (nvlist_add_string(fmristr, "fmri-string", name) != 0) {
2N/A topo_mod_free(mod, name, len + 1);
2N/A nvlist_free(fmristr);
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
2N/A }
2N/A topo_mod_free(mod, name, len + 1);
2N/A *out = fmristr;
2N/A
2N/A return (0);
2N/A}
2N/A
2N/A/*ARGSUSED*/
2N/Astatic int
2N/Amod_fmri_str2nvl(topo_mod_t *mod, tnode_t *node, topo_version_t version,
2N/A nvlist_t *in, nvlist_t **out)
2N/A{
2N/A nvlist_t *fmri;
2N/A char *mod_name = NULL;
2N/A char *str, *tmpstr;
2N/A int err, len;
2N/A
2N/A if (version > TOPO_METH_STR2NVL_VERSION)
2N/A return (topo_mod_seterrno(mod, EMOD_VER_NEW));
2N/A
2N/A if (nvlist_lookup_string(in, "fmri-string", &str) != 0)
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
2N/A
2N/A /* We're expecting a string version of a mod scheme FMRI */
2N/A if (strncmp(str, "mod:///", 7) != 0)
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_MALFORM));
2N/A
2N/A /*
2N/A * Try to parse the module name.
2N/A */
2N/A tmpstr = str + 7;
2N/A if (strncmp(tmpstr, FM_FMRI_MOD_NAME "=", 9) == 0) {
2N/A char *n;
2N/A
2N/A n = strchr(tmpstr + 9, '/');
2N/A if (n == NULL)
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_MALFORM));
2N/A len = n - (tmpstr + 9);
2N/A mod_name = alloca(len + 1);
2N/A (void) memcpy(mod_name, tmpstr + 9, len);
2N/A mod_name[len] = 0;
2N/A tmpstr = n + 1;
2N/A }
2N/A
2N/A if (topo_mod_nvalloc(mod, &fmri, NV_UNIQUE_NAME) != 0)
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
2N/A
2N/A err = nvlist_add_uint8(fmri, FM_VERSION, FM_DEV_SCHEME_VERSION);
2N/A err |= nvlist_add_string(fmri, FM_FMRI_SCHEME, FM_FMRI_SCHEME_MOD);
2N/A if (mod_name)
2N/A err |= nvlist_add_string(fmri, FM_FMRI_MOD_NAME, mod_name);
2N/A
2N/A if (err != 0) {
2N/A nvlist_free(fmri);
2N/A return (topo_mod_seterrno(mod, EMOD_FMRI_NVL));
2N/A }
2N/A *out = fmri;
2N/A
2N/A return (0);
2N/A}