275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock/*
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * CDDL HEADER START
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock *
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * The contents of this file are subject to the terms of the
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * Common Development and Distribution License (the "License").
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * You may not use this file except in compliance with the License.
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock *
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * or http://www.opensolaris.org/os/licensing.
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * See the License for the specific language governing permissions
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * and limitations under the License.
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock *
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * When distributing Covered Code, include this CDDL HEADER in each
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * If applicable, add the following below this CDDL HEADER, with the
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * fields enclosed by brackets "[]" replaced with your own identifying
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * information: Portions Copyright [yyyy] [name of copyright owner]
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock *
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * CDDL HEADER END
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock/*
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * Use is subject to license terms.
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#ifndef _SES_IMPL_H
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define _SES_IMPL_H
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#pragma ident "%Z%%M% %I% %E% SMI"
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#ifdef __cplusplus
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern "C" {
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#endif
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <alloca.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <errno.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <assert.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <dirent.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <dlfcn.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <limits.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <pthread.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <stdarg.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <stddef.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <stdio.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <stdlib.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <string.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <strings.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <libnvpair.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <unistd.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <sys/mman.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <sys/types.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <sys/sysmacros.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <sys/systeminfo.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <scsi/libscsi.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <scsi/libses_plugin.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#include <scsi/plugins/ses/framework/ses2_impl.h>
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define LIBSES_ERRMSGLEN 512
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define LIBSES_DEFAULT_PLUGINDIR "/usr/lib/scsi/plugins/ses"
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define LIBSES_PLUGIN_FRAMEWORK "framework"
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define LIBSES_PLUGIN_VENDOR "vendor"
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define LIBSES_PLUGIN_EXT ".so"
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockstruct ses_plugin {
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_plugin *sp_next; /* next plugin in list */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_plugin *sp_prev; /* previous plugin in list */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock uint64_t sp_priority; /* plugin priority */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_target *sp_target; /* corresponding target */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock void *sp_object; /* shared object */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock void *sp_data; /* module-specific data */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock boolean_t sp_initialized; /* successfully initialized */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock ses_pagedesc_t *sp_pages; /* pages */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock int (*sp_init)(ses_plugin_t *); /* plugin init */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock void (*sp_fini)(ses_plugin_t *); /* plugin fini */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock int (*sp_node_parse)(ses_plugin_t *, ses_node_t *); /* parse node */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock int (*sp_node_ctl)(ses_plugin_t *, ses_node_t *, const char *,
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock nvlist_t *); /* node control */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock};
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockstruct ses_target {
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock libscsi_hdl_t *st_scsi_hdl;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock libscsi_target_t *st_target;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_plugin *st_plugin_first;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_plugin *st_plugin_last;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_snap *st_snapshots;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock boolean_t st_closescsi;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock boolean_t st_truncate;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock pthread_mutex_t st_lock;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock};
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock/*
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * Maximum number of snapshot retries triggered by generation count changes
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define LIBSES_MAX_GC_RETRIES 10
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock/*
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * Maximum number of Enclosure Busy retries
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define LIBSES_MAX_BUSY_RETRIES 3
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrocktypedef struct ses_snap_page {
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock ses2_diag_page_t ssp_num;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock boolean_t ssp_control;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock boolean_t ssp_initialized;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock size_t ssp_alloc;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock size_t ssp_len;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock void *ssp_page;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock char *ssp_mmap_base;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock size_t ssp_mmap_len;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_snap_page *ssp_next;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_snap_page *ssp_unique;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock} ses_snap_page_t;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockstruct ses_snap {
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_target *ss_target;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock uint32_t ss_generation;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock hrtime_t ss_time;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_node *ss_root;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock size_t ss_n_elem;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock ses_snap_page_t *ss_pages;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock size_t ss_n_nodes;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_node **ss_nodes;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_snap *ss_next;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_snap *ss_prev;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock uint32_t ss_refcnt;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock};
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockstruct ses_node {
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock ses_node_type_t sn_type;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock uint64_t sn_rootidx; /* Relative index for enclosure/aggregate */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock size_t sn_id; /* Unique global ID */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock uint64_t sn_enc_num;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_snap *sn_snapshot;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_node *sn_parent;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_node *sn_next_sibling;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_node *sn_prev_sibling;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_node *sn_first_child;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock struct ses_node *sn_last_child;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock nvlist_t *sn_props;
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock};
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int ses_fill_snap(ses_snap_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern void ses_node_teardown(ses_node_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern ses_snap_page_t *ses_snap_find_page(ses_snap_t *, ses2_diag_page_t,
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock boolean_t);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern ses_snap_page_t *ses_snap_ctl_page(ses_snap_t *,
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock ses2_diag_page_t, size_t, boolean_t);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int ses_snap_do_ctl(ses_snap_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int ses_libscsi_error(libscsi_hdl_t *, const char *, ...);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int ses_scsi_error(libscsi_action_t *, const char *, ...);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int ses_plugin_load(ses_target_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern void ses_plugin_unload(ses_target_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern ses_pagedesc_t *ses_get_pagedesc(ses_target_t *, int, ses_pagetype_t);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int ses_fill_node(ses_node_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int enc_parse_ed(ses2_ed_impl_t *, nvlist_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrockextern int enc_parse_td(ses2_td_hdr_impl_t *, const char *, nvlist_t *);
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#ifdef __cplusplus
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock}
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#endif
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#endif /* _SES_IMPL_H */