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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
2N/A */
2N/A
2N/A/*
2N/A * libfmd_agent contains the low-level operations that needed by the fmd
2N/A * agents, such as page operations (status/retire/unretire), cpu operations
2N/A * (status/online/offline), etc.
2N/A *
2N/A * Some operations are implemented by /dev/fm ioctls. Those ioctls are
2N/A * heavily versioned to allow userland patching without requiring a reboot
2N/A * to get a matched /dev/fm. All the ioctls use packed nvlist to interact
2N/A * between userland and kernel. (see fmd_agent_nvl_ioctl()).
2N/A */
2N/A
2N/A#include <fcntl.h>
2N/A#include <errno.h>
2N/A#include <unistd.h>
2N/A#include <strings.h>
2N/A#include <libnvpair.h>
2N/A#include <string.h>
2N/A#include <sys/types.h>
2N/A#include <sys/devfm.h>
2N/A#include <fmd_agent_impl.h>
2N/A
2N/Aint
2N/Afmd_agent_errno(fmd_agent_hdl_t *hdl)
2N/A{
2N/A return (hdl->agent_errno);
2N/A}
2N/A
2N/Aint
2N/Afmd_agent_seterrno(fmd_agent_hdl_t *hdl, int err)
2N/A{
2N/A hdl->agent_errno = err;
2N/A return (-1);
2N/A}
2N/A
2N/Aconst char *
2N/Afmd_agent_strerr(int err)
2N/A{
2N/A return (strerror(err));
2N/A}
2N/A
2N/Aconst char *
2N/Afmd_agent_errmsg(fmd_agent_hdl_t *hdl)
2N/A{
2N/A return (fmd_agent_strerr(hdl->agent_errno));
2N/A}
2N/A
2N/Astatic int
2N/Acleanup_set_errno(fmd_agent_hdl_t *hdl, nvlist_t *innvl, nvlist_t *outnvl,
2N/A int err)
2N/A{
2N/A if (innvl != NULL)
2N/A nvlist_free(innvl);
2N/A if (outnvl != NULL)
2N/A nvlist_free(outnvl);
2N/A return (fmd_agent_seterrno(hdl, err));
2N/A}
2N/A
2N/A/*
2N/A * Perform /dev/fm ioctl. The input and output data are represented by
2N/A * name-value lists (nvlists).
2N/A */
2N/Aint
2N/Afmd_agent_nvl_ioctl(fmd_agent_hdl_t *hdl, int cmd, uint32_t ver,
2N/A nvlist_t *innvl, nvlist_t **outnvlp)
2N/A{
2N/A fm_ioc_data_t fid;
2N/A int err = 0;
2N/A char *inbuf = NULL, *outbuf = NULL;
2N/A size_t insz = 0, outsz = 0;
2N/A
2N/A if (innvl != NULL) {
2N/A if ((err = nvlist_size(innvl, &insz, NV_ENCODE_NATIVE)) != 0)
2N/A return (err);
2N/A if (insz > FM_IOC_MAXBUFSZ)
2N/A return (ENAMETOOLONG);
2N/A if ((inbuf = umem_alloc(insz, UMEM_DEFAULT)) == NULL)
2N/A return (errno);
2N/A
2N/A if ((err = nvlist_pack(innvl, &inbuf, &insz,
2N/A NV_ENCODE_NATIVE, 0)) != 0) {
2N/A umem_free(inbuf, insz);
2N/A return (err);
2N/A }
2N/A }
2N/A
2N/A if (outnvlp != NULL) {
2N/A outsz = FM_IOC_OUT_BUFSZ;
2N/A }
2N/A for (;;) {
2N/A if (outnvlp != NULL) {
2N/A outbuf = umem_alloc(outsz, UMEM_DEFAULT);
2N/A if (outbuf == NULL) {
2N/A err = errno;
2N/A break;
2N/A }
2N/A }
2N/A
2N/A fid.fid_version = ver;
2N/A fid.fid_insz = insz;
2N/A fid.fid_inbuf = inbuf;
2N/A fid.fid_outsz = outsz;
2N/A fid.fid_outbuf = outbuf;
2N/A
2N/A if (ioctl(hdl->agent_devfd, cmd, &fid) < 0) {
2N/A if (errno == ENAMETOOLONG && outsz != 0 &&
2N/A outsz < FM_IOC_OUT_MAXBUFSZ) {
2N/A umem_free(outbuf, outsz);
2N/A outsz *= 2;
2N/A outbuf = NULL;
2N/A } else {
2N/A err = errno;
2N/A break;
2N/A }
2N/A } else if (outnvlp != NULL) {
2N/A err = nvlist_unpack(fid.fid_outbuf, fid.fid_outsz,
2N/A outnvlp, 0);
2N/A break;
2N/A } else {
2N/A break;
2N/A }
2N/A }
2N/A
2N/A if (inbuf != NULL)
2N/A umem_free(inbuf, insz);
2N/A if (outbuf != NULL)
2N/A umem_free(outbuf, outsz);
2N/A
2N/A return (err);
2N/A}
2N/A
2N/A/*
2N/A * Open /dev/fm and return a handle. ver is the overall interface version.
2N/A */
2N/Astatic fmd_agent_hdl_t *
2N/Afmd_agent_open_dev(int ver, int mode)
2N/A{
2N/A fmd_agent_hdl_t *hdl;
2N/A int fd, err;
2N/A nvlist_t *nvl;
2N/A
2N/A if ((fd = open("/dev/fm", mode)) < 0)
2N/A return (NULL); /* errno is set for us */
2N/A
2N/A if ((hdl = umem_alloc(sizeof (fmd_agent_hdl_t),
2N/A UMEM_DEFAULT)) == NULL) {
2N/A err = errno;
2N/A (void) close(fd);
2N/A errno = err;
2N/A return (NULL);
2N/A }
2N/A
2N/A hdl->agent_devfd = fd;
2N/A hdl->agent_version = ver;
2N/A
2N/A /*
2N/A * Get the individual interface versions.
2N/A */
2N/A if ((err = fmd_agent_nvl_ioctl(hdl, FM_IOC_VERSIONS, ver, NULL, &nvl))
2N/A < 0) {
2N/A (void) close(fd);
2N/A umem_free(hdl, sizeof (fmd_agent_hdl_t));
2N/A errno = err;
2N/A return (NULL);
2N/A }
2N/A
2N/A hdl->agent_ioc_versions = nvl;
2N/A return (hdl);
2N/A}
2N/A
2N/Afmd_agent_hdl_t *
2N/Afmd_agent_open(int ver)
2N/A{
2N/A if (ver > FMD_AGENT_VERSION) {
2N/A errno = ENOTSUP;
2N/A return (NULL);
2N/A }
2N/A return (fmd_agent_open_dev(ver, O_RDONLY));
2N/A}
2N/A
2N/Avoid
2N/Afmd_agent_close(fmd_agent_hdl_t *hdl)
2N/A{
2N/A (void) close(hdl->agent_devfd);
2N/A nvlist_free(hdl->agent_ioc_versions);
2N/A umem_free(hdl, sizeof (fmd_agent_hdl_t));
2N/A}
2N/A
2N/A/*
2N/A * Given a interface name, return the kernel interface version.
2N/A */
2N/Aint
2N/Afmd_agent_version(fmd_agent_hdl_t *hdl, const char *op, uint32_t *verp)
2N/A{
2N/A int err;
2N/A
2N/A err = nvlist_lookup_uint32(hdl->agent_ioc_versions,
2N/A op, verp);
2N/A
2N/A if (err != 0) {
2N/A errno = err;
2N/A return (-1);
2N/A }
2N/A return (0);
2N/A}
2N/A
2N/Astatic int
2N/Afmd_agent_pageop_v1(fmd_agent_hdl_t *hdl, int cmd, nvlist_t *fmri)
2N/A{
2N/A int err;
2N/A nvlist_t *nvl = NULL;
2N/A
2N/A if ((err = nvlist_alloc(&nvl, NV_UNIQUE_NAME_TYPE, 0)) != 0 ||
2N/A (err = nvlist_add_nvlist(nvl, FM_PAGE_RETIRE_FMRI, fmri)) != 0 ||
2N/A (err = fmd_agent_nvl_ioctl(hdl, cmd, 1, nvl, NULL)) != 0)
2N/A return (cleanup_set_errno(hdl, nvl, NULL, err));
2N/A
2N/A nvlist_free(nvl);
2N/A return (0);
2N/A}
2N/A
2N/Astatic int
2N/Afmd_agent_pageop(fmd_agent_hdl_t *hdl, int cmd, nvlist_t *fmri)
2N/A{
2N/A uint32_t ver;
2N/A
2N/A if (fmd_agent_version(hdl, FM_PAGE_OP_VERSION, &ver) == -1)
2N/A return (fmd_agent_seterrno(hdl, errno));
2N/A
2N/A switch (ver) {
2N/A case 1:
2N/A return (fmd_agent_pageop_v1(hdl, cmd, fmri));
2N/A
2N/A default:
2N/A return (fmd_agent_seterrno(hdl, ENOTSUP));
2N/A }
2N/A}
2N/A
2N/Aint
2N/Afmd_agent_page_retire(fmd_agent_hdl_t *hdl, nvlist_t *fmri)
2N/A{
2N/A int rc = fmd_agent_pageop(hdl, FM_IOC_PAGE_RETIRE, fmri);
2N/A int err = fmd_agent_errno(hdl);
2N/A
2N/A /*
2N/A * FM_IOC_PAGE_RETIRE ioctl returns:
2N/A * 0 - success in retiring page
2N/A * -1, errno = EIO - page is already retired
2N/A * -1, errno = EAGAIN - page is scheduled for retirement
2N/A * -1, errno = EINVAL - page fmri is invalid
2N/A * -1, errno = any else - error
2N/A */
2N/A if (rc == 0 || err == EIO || err == EINVAL) {
2N/A if (rc == 0)
2N/A (void) fmd_agent_seterrno(hdl, 0);
2N/A return (FMD_AGENT_RETIRE_DONE);
2N/A }
2N/A if (err == EAGAIN)
2N/A return (FMD_AGENT_RETIRE_ASYNC);
2N/A
2N/A return (FMD_AGENT_RETIRE_FAIL);
2N/A}
2N/A
2N/Aint
2N/Afmd_agent_page_unretire(fmd_agent_hdl_t *hdl, nvlist_t *fmri)
2N/A{
2N/A int rc = fmd_agent_pageop(hdl, FM_IOC_PAGE_UNRETIRE, fmri);
2N/A int err = fmd_agent_errno(hdl);
2N/A
2N/A /*
2N/A * FM_IOC_PAGE_UNRETIRE ioctl returns:
2N/A * 0 - success in unretiring page
2N/A * -1, errno = EIO - page is already unretired
2N/A * -1, errno = EAGAIN - page couldn't be locked, still retired
2N/A * -1, errno = EINVAL - page fmri is invalid
2N/A * -1, errno = any else - error
2N/A */
2N/A if (rc == 0 || err == EIO || err == EINVAL) {
2N/A if (rc == 0)
2N/A (void) fmd_agent_seterrno(hdl, 0);
2N/A return (FMD_AGENT_RETIRE_DONE);
2N/A }
2N/A
2N/A return (FMD_AGENT_RETIRE_FAIL);
2N/A}
2N/A
2N/Aint
2N/Afmd_agent_page_isretired(fmd_agent_hdl_t *hdl, nvlist_t *fmri)
2N/A{
2N/A int rc = fmd_agent_pageop(hdl, FM_IOC_PAGE_STATUS, fmri);
2N/A int err = fmd_agent_errno(hdl);
2N/A
2N/A /*
2N/A * FM_IOC_PAGE_STATUS returns:
2N/A * 0 - page is retired
2N/A * -1, errno = EAGAIN - page is scheduled for retirement
2N/A * -1, errno = EIO - page not scheduled for retirement
2N/A * -1, errno = EINVAL - page fmri is invalid
2N/A * -1, errno = any else - error
2N/A */
2N/A if (rc == 0 || err == EINVAL) {
2N/A if (rc == 0)
2N/A (void) fmd_agent_seterrno(hdl, 0);
2N/A return (FMD_AGENT_RETIRE_DONE);
2N/A }
2N/A if (err == EAGAIN)
2N/A return (FMD_AGENT_RETIRE_ASYNC);
2N/A
2N/A return (FMD_AGENT_RETIRE_FAIL);
2N/A}