3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling/*
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * CDDL HEADER START
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling *
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * The contents of this file are subject to the terms of the
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * Common Development and Distribution License (the "License").
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * You may not use this file except in compliance with the License.
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling *
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * or http://www.opensolaris.org/os/licensing.
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * See the License for the specific language governing permissions
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * and limitations under the License.
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling *
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * When distributing Covered Code, include this CDDL HEADER in each
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * If applicable, add the following below this CDDL HEADER, with the
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * fields enclosed by brackets "[]" replaced with your own identifying
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * information: Portions Copyright [yyyy] [name of copyright owner]
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling *
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * CDDL HEADER END
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling/*
7802d7bf98dec568dadf72286893b1fe5abd8602Matthew Ahrens * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#ifndef _LIBSES_H
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#define _LIBSES_H
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#ifdef __cplusplus
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern "C" {
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#endif
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <sys/types.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <stdarg.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <libnvpair.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <pthread.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <scsi/libscsi.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <scsi/plugins/ses/framework/ses2.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#include <scsi/plugins/ses/framework/libses.h>
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#define LIBSES_VERSION 1
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling/*
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * element type prop can be created by any plugin. The ses2 plugin created
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling * SES-2 defined element types and SUN plugin defines vendor specific types.
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#define SES_PROP_ELEMENT_TYPE "ses-element-type"
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingtypedef enum ses_node_type {
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling SES_NODE_NONE = 0x0,
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling SES_NODE_TARGET = 0x1,
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling SES_NODE_ENCLOSURE = 0x2,
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling SES_NODE_AGGREGATE = 0x4,
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling SES_NODE_ELEMENT = 0x8
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling} ses_node_type_t;
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingtypedef enum ses_errno {
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_NONE, /* no error */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_NOMEM, /* no memory */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_ZERO_LENGTH, /* zero-length allocation requested */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_VERSION, /* library version mismatch */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_NVL, /* nvlist manipulation error */
7802d7bf98dec568dadf72286893b1fe5abd8602Matthew Ahrens ESES_BAD_NODE, /* bad node */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_INVALID_OP, /* invalid operation */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_RANGE, /* value out of range */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_INVALID_PROP, /* nonexistent or immutable property */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_BAD_TYPE, /* incorrect property type */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_BAD_PAGE, /* bad page number */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_BAD_RESPONSE, /* bad response from target */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_BUSY, /* target busy */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_TOOMUCHCHANGE, /* target configuration changing too rapidly */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling ESES_LIBSCSI, /* SCSI error */
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson ESES_NOTSUP, /* operation not supported */
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson ESES_UNKNOWN, /* error of unknown type */
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson ESES_CHANGED, /* generation count has changed */
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson ESES_PLUGIN, /* invalid or missing plugin */
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson ESES_MAX /* maximum libses errno value */
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson} ses_errno_t;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonstruct ses_target;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsontypedef struct ses_target ses_target_t;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonstruct ses_snap;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsontypedef struct ses_snap ses_snap_t;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonstruct ses_node;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsontypedef struct ses_node ses_node_t;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonextern ses_target_t *ses_open(uint_t, const char *);
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonextern ses_target_t *ses_open_scsi(uint_t, libscsi_target_t *);
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonextern void ses_close(ses_target_t *);
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonextern libscsi_target_t *ses_scsi_target(ses_target_t *);
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsontypedef enum ses_walk_action {
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson SES_WALK_ACTION_CONTINUE,
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson SES_WALK_ACTION_PRUNE,
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson SES_WALK_ACTION_TERMINATE
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson} ses_walk_action_t;
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsontypedef ses_walk_action_t (*ses_walk_f)(ses_node_t *, void *);
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilson
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern uint64_t ses_node_id(ses_node_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_node_t *ses_node_lookup(ses_snap_t *, uint64_t);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_node_t *ses_root_node(ses_snap_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_node_t *ses_node_sibling(ses_node_t *);
b4952e17e8858d3225793b28788278de9fe6038dGeorge Wilsonextern ses_node_t *ses_node_prev_sibling(ses_node_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_node_t *ses_node_child(ses_node_t *);
cde58dbc6a23d4d38db7c8866312be83221c765fMatthew Ahrensextern ses_node_t *ses_node_parent(ses_node_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern int ses_walk(ses_snap_t *, ses_walk_f, void *);
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Siden
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Sidenextern ses_snap_t *ses_snap_hold(ses_target_t *);
4a92375985c37d61406d66cd2b10ee642eb1f5e7George Wilsonextern void ses_snap_rele(ses_snap_t *);
7fd05ac4dec0c343d2f68f310d3718b715ecfbafMatthew Ahrensextern ses_snap_t *ses_snap_new(ses_target_t *);
ad135b5d644628e791c3188a6ecbd9c257961ef8Christopher Sidenextern uint32_t ses_snap_generation(ses_snap_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_node_type_t ses_node_type(ses_node_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern nvlist_t *ses_node_props(ses_node_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern int ses_node_ctl(ses_node_t *, const char *, nvlist_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_snap_t *ses_node_snapshot(ses_node_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_target_t *ses_node_target(ses_node_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_errno_t ses_errno(void);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern const char *ses_errmsg(void);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern const char *ses_strerror(ses_errno_t);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern const char *ses_nv_error_member(void);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Lingextern ses_node_t *ses_snap_primary_enclosure(ses_snap_t *);
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#ifdef __cplusplus
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling}
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#endif
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling#endif /* _LIBSES_H */
3f9d6ad73e45c6823b409f93b0c8d4f62861d2d5Lin Ling