libses.h revision 275c9da86e89f8abf71135cf63d9fc23671b2e60
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey/*
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * CDDL HEADER START
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey *
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * The contents of this file are subject to the terms of the
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * Common Development and Distribution License (the "License").
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * You may not use this file except in compliance with the License.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey *
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * or http://www.opensolaris.org/os/licensing.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * See the License for the specific language governing permissions
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * and limitations under the License.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey *
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * When distributing Covered Code, include this CDDL HEADER in each
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * If applicable, add the following below this CDDL HEADER, with the
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * fields enclosed by brackets "[]" replaced with your own identifying
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * information: Portions Copyright [yyyy] [name of copyright owner]
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey *
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * CDDL HEADER END
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey/*
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskey * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey * Use is subject to license terms.
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#ifndef _LIBSES_H
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#define _LIBSES_H
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#pragma ident "%Z%%M% %I% %E% SMI"
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#ifdef __cplusplus
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern "C" {
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskey#endif
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#include <sys/types.h>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#include <stdarg.h>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#include <libnvpair.h>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#include <pthread.h>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#include <scsi/libscsi.h>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#include <scsi/plugins/ses/framework/ses2.h>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#include <scsi/plugins/ses/framework/libses.h>
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#define LIBSES_VERSION 1
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytypedef enum ses_node_type {
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_NODE_NONE = 0x0,
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_NODE_TARGET = 0x1,
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_NODE_ENCLOSURE = 0x2,
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_NODE_AGGREGATE = 0x4,
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_NODE_ELEMENT = 0x8
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey} ses_node_type_t;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytypedef enum ses_errno {
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_NONE, /* no error */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_NOMEM, /* no memory */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_ZERO_LENGTH, /* zero-length allocation requested */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_VERSION, /* library version mismatch */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_NVL, /* nvlist manipulation error */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_BAD_NODE, /* bad node */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_INVALID_OP, /* invalid operation */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_RANGE, /* value out of range */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_INVALID_PROP, /* nonexistent or immutable property */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_BAD_TYPE, /* incorrect property type */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_BAD_PAGE, /* bad page number */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_BAD_RESPONSE, /* bad response from target */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_BUSY, /* target busy */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_TOOMUCHCHANGE, /* target configuration changing too rapidly */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_LIBSCSI, /* SCSI error */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_NOTSUP, /* operation not supported */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_UNKNOWN, /* error of unknown type */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_CHANGED, /* generation count has changed */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_PLUGIN, /* invalid or missing plugin */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey ESES_MAX /* maximum libses errno value */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey} ses_errno_t;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeystruct ses_target;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytypedef struct ses_target ses_target_t;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeystruct ses_snap;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytypedef struct ses_snap ses_snap_t;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeystruct ses_node;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytypedef struct ses_node ses_node_t;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_target_t *ses_open(uint_t, const char *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_target_t *ses_open_scsi(uint_t, libscsi_target_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern void ses_close(ses_target_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern libscsi_target_t *ses_scsi_target(ses_target_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytypedef enum ses_walk_action {
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_WALK_ACTION_CONTINUE,
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_WALK_ACTION_PRUNE,
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey SES_WALK_ACTION_TERMINATE
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey} ses_walk_action_t;
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeytypedef ses_walk_action_t (*ses_walk_f)(ses_node_t *, void *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern uint64_t ses_node_id(ses_node_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_node_t *ses_node_lookup(ses_snap_t *, uint64_t);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_node_t *ses_root_node(ses_snap_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_node_t *ses_node_sibling(ses_node_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_node_t *ses_node_prev_sibling(ses_node_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_node_t *ses_node_child(ses_node_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_node_t *ses_node_parent(ses_node_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern int ses_walk(ses_snap_t *, ses_walk_f, void *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_snap_t *ses_snap_hold(ses_target_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern void ses_snap_rele(ses_snap_t *);
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskeyextern ses_snap_t *ses_snap_new(ses_target_t *);
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskeyextern uint32_t ses_snap_generation(ses_snap_t *);
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_node_type_t ses_node_type(ses_node_t *);
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskeyextern nvlist_t *ses_node_props(ses_node_t *);
f6da83d4178694e7113b71d1e452f15b296f73d8Anurag S. Maskeyextern int ses_node_ctl(ses_node_t *, const char *, nvlist_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_snap_t *ses_node_snapshot(ses_node_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_target_t *ses_node_target(ses_node_t *);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern ses_errno_t ses_errno(void);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern const char *ses_errmsg(void);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern const char *ses_strerror(ses_errno_t);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskeyextern const char *ses_nv_error_member(void);
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#ifdef __cplusplus
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey}
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#endif
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey#endif /* _LIBSES_H */
6ba597c56d749c61b4f783157f63196d7b2445f0Anurag S. Maskey