dm_impl.h revision cee0fb94c0d4227de0a00efc162fb2739844b641
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk/*
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * CDDL HEADER START
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk *
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * The contents of this file are subject to the terms of the
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * Common Development and Distribution License (the "License").
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * You may not use this file except in compliance with the License.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk *
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * or http://www.opensolaris.org/os/licensing.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * See the License for the specific language governing permissions
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * and limitations under the License.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk *
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * When distributing Covered Code, include this CDDL HEADER in each
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * If applicable, add the following below this CDDL HEADER, with the
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * fields enclosed by brackets "[]" replaced with your own identifying
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * information: Portions Copyright [yyyy] [name of copyright owner]
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk *
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * CDDL HEADER END
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk *
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * Use is subject to license terms.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#ifndef __DM_IMPL_H
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define __DM_IMPL_H
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#ifdef __cplusplus
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenkextern "C" {
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#endif
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <sys/types.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <sys/ksynch.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <netdb.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <mms_network.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <dmd_impl.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <mms_parser.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <dm_drive.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#include <mms_sock.h>
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenktypedef struct dm_wka {
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk uint64_t dm_flags;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int dm_counter;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pid_t dm_pid; /* drive manager's pid */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pid_t dm_app_pid; /* targ opend by this app */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int dm_drm_fd; /* drive manager dev fd */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk /*
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * dm_drm_path is the pseudo device the DM opens for its own use.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_drm_path; /* drive manager path */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk /* /devices/pseudo/dmd0:1drm */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk major_t dm_drm_major; /* major of dm_drm_path */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk minor_t dm_drm_minor; /* minor of dm_drm_path */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk /*
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * dm_targ_base_major and dm_targ_base_minor are major and minor
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * numbers of the target base device, i.e. /dev/rmt/x.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_target_base; /* base device of target */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk major_t dm_targ_base_major; /* major of target base */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk minor_t dm_targ_base_minor; /* minor of target base */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk /*
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * dm_targ_hdl is the pathname DM returns to the client.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_targ_hdl; /* target handle for client */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk /*
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * dm_hdl_major and dm_hdl_id are major and minor device numbers
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * of dm_targ_hdl.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * dm_hdl_major is the same as dm_drm_major.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * dm_hdl_minor is a unique id which is used as the minor device number
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * and is mapped to (dm_drm_minor + 1).
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk major_t dm_hdl_major; /* handle major */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk minor_t dm_hdl_minor; /* handle minor == handle id */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_host;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_port;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_passwd;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_mm_passwd;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int dm_ssl_enabled;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_ssl_cert_file;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_ssl_pass;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_ssl_pass_file;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_ssl_crl_file;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_ssl_peer_file;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_ssl_cipher;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk void *dm_ssl_data;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_hdl_prefix;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char dm_local_hostname[MAXHOSTNAMELEN + 1];
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk /* local hostname */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk mms_t dm_mms_conn; /* mm connection */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk void *dm_default_lib_hdl;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk void *dm_dev_lib_hdl;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int dm_msg_level;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int dm_cmd_dispatchable;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk mms_list_t dm_cmd_queue; /* active cmd queue */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk mms_list_t dm_pend_ack_queue; /* cmds not accepted yet */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_cond_t dm_accept_cv;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_dev_lib;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_mutex_t dm_io_mutex; /* lock for I/O */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk drm_request_t *dm_request;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk drm_request_t dm_reqbuf;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *dm_pwbuf; /* _SC_GETPW_R_SIZE_MAX */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int dm_pwbuf_size;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk /*
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * If both dm_queue_mutex and dm_worker_mutex must be held,
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * lock dm_queue_mutex first before locking dm_worker_mutex.
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_mutex_t dm_queue_mutex; /* lock for cmd queues */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_mutex_t dm_worker_mutex; /* lock for worker thread */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_cond_t dm_work_cv;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_mutex_t dm_tdv_close_mutex;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_cond_t dm_tdv_close_cv;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int dm_work_todo; /* work todo flag */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk struct timeval dm_mnt_start; /* mount start time */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk struct timeval dm_mnt_done; /* mount done time */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk struct timeval dm_mnt_time; /* mount time */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk} dm_wka_t;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk/*
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk * DM flags
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_SILENT (1LL << 0) /* Silent - no mms_trace */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_OPENED (1LL << 1) /* File opened */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_ENABLED (1LL << 2) /* DM is enabled */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_SEND_CAPACITY (1LL << 3) /* Send capacity */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_HAVE_SESSION (1LL << 4) /* Opened session with MM */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_NOT_USED (1LL << 5) /* Not used */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_SEND_EOF_POS (1LL << 6)
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_PREEMPT_RSV (1LL << 7)
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_ASK_PREEMPT_RSV (1LL << 8) /* ask if DM_PREEMPT_RSV */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_RESERVE_DRIVE (1LL << 9) /* Issue reserve drive */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_USE_PRSV (1LL << 10) /* Use persistent reserve out */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_DEV_LIB_LOADED (1LL << 11) /* device lib loaded */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_DFLT_LIB_LOADED (1LL << 12) /* default lib loaded */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_EXIT_NORESTART (1LL << 13) /* DM is terminating */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenktypedef struct dm_command {
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk mms_list_node_t cmd_next;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int cmd_flags;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int cmd_state; /* Continue from state */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int cmd_rc; /* return code from send */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk mms_par_node_t *cmd_root; /* command root node */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *cmd_task; /* task string */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk int (*cmd_func)(struct dm_command *);
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk char *cmd_textcmd;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_cond_t cmd_done_cv;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk pthread_mutex_t cmd_done_mutex;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk} dm_command_t;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define CMD_DISPATCHABLE 0x01
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define CMD_INCOMING 0x02
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define CMD_COMPLETE 0x04
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_OPEN_RETRIES 30
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_OPEN_INTERVAL 3 /* number of seconds between attempts */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_CONNECT_INTERVAL 3 /* number of seconds between attempts */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_WRITE_ACCEPT 1
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_DEV_LIB_DIR "/usr/lib/mms/dm"
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_TRACE_DIR "/var/log/mms/dm"
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define MMS_AUTHNAME "solaris.mms.io.*"
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_COMPLETE 1 /* command completed */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_CONTINUE 2 /* will continue */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_NOT_COMPLETE 3 /* not complete yet */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_ERROR (-1)
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_PARTIAL_WRITE (-2)
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_RESTART 2
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_NO_RESTART 1
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenkextern dm_wka_t *wka;
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_RESPONDED "1000" /* Response message id */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_UNATTNDED "1001" /* Unattended message id */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_ERROR (-1)
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_YES 0x01
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_NO 0x02
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_UNATTENDED 0x04
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_STRING 0x08
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_ABORT 0x10
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_REP_RETRY 0x20
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_FAILED 0x01
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#define DM_EXIT(code) dm_exit(code, _SrcFile, __LINE__)
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#ifdef __cplusplus
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk}
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#endif
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk#endif /* __DM_IMPL_H */
2a9ee4116a7df31d9482821f64c837315c8e2aa0jeff.schenk