1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport/*
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * CDDL HEADER START
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport *
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * The contents of this file are subject to the terms of the
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * Common Development and Distribution License (the "License").
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * You may not use this file except in compliance with the License.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport *
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * or http://www.opensolaris.org/os/licensing.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * See the License for the specific language governing permissions
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * and limitations under the License.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport *
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * When distributing Covered Code, include this CDDL HEADER in each
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * If applicable, add the following below this CDDL HEADER, with the
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * fields enclosed by brackets "[]" replaced with your own identifying
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * information: Portions Copyright [yyyy] [name of copyright owner]
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport *
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * CDDL HEADER END
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport */
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport/*
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * Use is subject to license terms.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport */
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#ifndef _GMEM_FMRI_H
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#define _GMEM_FMRI_H
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport/*
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * Each general-purpose state structure is named by an FMRI - the FMRI of the
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * piece of hardware being described. FMRIs are nvlists, and thus require
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * special handling if they are to be persisted along with the general-purpose
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * buffer. The gmem_fmri_t manages the FMRI, both in packed (persistable) and
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * unpacked formats. The packed FMRI is stored in a separate buffer (named by
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * the fmri_packnm member), from which it can be unpacked on restore.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport *
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * Data structures:
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport *
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * ,--------.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * |G.P. |
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * |buffer |
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * |,-------| ,-------------.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * ||fmri_t | ----> |packed nvlist|
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * |`-------| `-------------'
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * `--------'
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport *
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * The buffer for the general purpose buffer is named and stored independently.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * This subsystem creates and manages the packed nvlist buffer, using a name
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport * provided by the caller.
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport */
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#include <libnvpair.h>
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#include <fm/fmd_api.h>
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#include <sys/types.h>
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#include <gmem_state.h>
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#ifdef __cplusplus
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenportextern "C" {
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#endif
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenporttypedef struct gmem_fmri {
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport nvlist_t *fmri_nvl; /* The unpacked FMRI FMRI */
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport char *fmri_packbuf; /* In-core packed nvlist buffer */
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport size_t fmri_packsz; /* Size of packed nvlist buffer */
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport char fmri_packnm[GMEM_BUFNMLEN]; /* Persistent buffer name for FMRI */
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport} gmem_fmri_t;
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenportextern void gmem_fmri_init(fmd_hdl_t *, gmem_fmri_t *, nvlist_t *,
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport const char *, ...);
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenportextern void gmem_fmri_fini(fmd_hdl_t *, gmem_fmri_t *, int);
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenportextern void gmem_fmri_restore(fmd_hdl_t *, gmem_fmri_t *);
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenportextern void gmem_fmri_write(fmd_hdl_t *, gmem_fmri_t *);
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#ifdef __cplusplus
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport}
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#endif
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport
1529f529004c61fcfd0d95ab79b0f257d6ad4451Scott Davenport#endif /* _GMEM_FMRI_H */