1fcf3ce44SJohn Forte /* 2fcf3ce44SJohn Forte * CDDL HEADER START 3fcf3ce44SJohn Forte * 4fcf3ce44SJohn Forte * The contents of this file are subject to the terms of the 5fcf3ce44SJohn Forte * Common Development and Distribution License (the "License"). 6fcf3ce44SJohn Forte * You may not use this file except in compliance with the License. 7fcf3ce44SJohn Forte * 8fcf3ce44SJohn Forte * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fcf3ce44SJohn Forte * or http://www.opensolaris.org/os/licensing. 10fcf3ce44SJohn Forte * See the License for the specific language governing permissions 11fcf3ce44SJohn Forte * and limitations under the License. 12fcf3ce44SJohn Forte * 13fcf3ce44SJohn Forte * When distributing Covered Code, include this CDDL HEADER in each 14fcf3ce44SJohn Forte * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fcf3ce44SJohn Forte * If applicable, add the following below this CDDL HEADER, with the 16fcf3ce44SJohn Forte * fields enclosed by brackets "[]" replaced with your own identifying 17fcf3ce44SJohn Forte * information: Portions Copyright [yyyy] [name of copyright owner] 18fcf3ce44SJohn Forte * 19fcf3ce44SJohn Forte * CDDL HEADER END 20fcf3ce44SJohn Forte */ 21fcf3ce44SJohn Forte /* 22*8fe96085Stim szeto * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23fcf3ce44SJohn Forte * Use is subject to license terms. 24fcf3ce44SJohn Forte */ 25fcf3ce44SJohn Forte 26fcf3ce44SJohn Forte #ifndef _STMF_SBD_H 27fcf3ce44SJohn Forte #define _STMF_SBD_H 28fcf3ce44SJohn Forte 29fcf3ce44SJohn Forte #ifdef __cplusplus 30fcf3ce44SJohn Forte extern "C" { 31fcf3ce44SJohn Forte #endif 32fcf3ce44SJohn Forte 33*8fe96085Stim szeto typedef stmf_status_t sbd_status_t; 34*8fe96085Stim szeto extern char sbd_vendor_id[]; 35*8fe96085Stim szeto extern char sbd_product_id[]; 36*8fe96085Stim szeto extern char sbd_revision[]; 37*8fe96085Stim szeto /* 38*8fe96085Stim szeto * Error codes 39*8fe96085Stim szeto */ 40*8fe96085Stim szeto #define SBD_SUCCESS STMF_SUCCESS 41fcf3ce44SJohn Forte #define SBD_FAILURE STMF_LU_FAILURE 42*8fe96085Stim szeto 43*8fe96085Stim szeto #define SBD_ALREADY (SBD_FAILURE | STMF_FSC(1)) 44*8fe96085Stim szeto #define SBD_NOT_SUPPORTED (SBD_FAILURE | STMF_FSC(2)) 45*8fe96085Stim szeto #define SBD_META_CORRUPTED (SBD_FAILURE | STMF_FSC(3)) 46*8fe96085Stim szeto #define SBD_INVALID_ARG (SBD_FAILURE | STMF_FSC(4)) 47*8fe96085Stim szeto #define SBD_NOT_FOUND (SBD_FAILURE | STMF_FSC(5)) 48*8fe96085Stim szeto #define SBD_ALLOC_FAILURE (SBD_FAILURE | STMF_FSC(6)) 49*8fe96085Stim szeto #define SBD_FILEIO_FAILURE (SBD_FAILURE | STMF_FSC(7)) 50*8fe96085Stim szeto #define SBD_IO_PAST_EOF (SBD_FAILURE | STMF_FSC(8)) 51*8fe96085Stim szeto #define SBD_BUSY (SBD_FAILURE | STMF_FSC(9)) 52*8fe96085Stim szeto 53*8fe96085Stim szeto #define SHARED_META_DATA_SIZE 65536 54*8fe96085Stim szeto #define SBD_META_OFFSET 4096 55*8fe96085Stim szeto #define SBD_MIN_LU_SIZE (1024 * 1024) 56fcf3ce44SJohn Forte 57fcf3ce44SJohn Forte /* 58*8fe96085Stim szeto * sms endianess 59fcf3ce44SJohn Forte */ 60*8fe96085Stim szeto #define SMS_BIG_ENDIAN 0x00 61*8fe96085Stim szeto #define SMS_LITTLE_ENDIAN 0xFF 62fcf3ce44SJohn Forte 63*8fe96085Stim szeto #ifdef _BIG_ENDIAN 64*8fe96085Stim szeto #define SMS_DATA_ORDER SMS_BIG_ENDIAN 65*8fe96085Stim szeto #else 66*8fe96085Stim szeto #define SMS_DATA_ORDER SMS_LITTLE_ENDIAN 67*8fe96085Stim szeto #endif 68fcf3ce44SJohn Forte 69*8fe96085Stim szeto #define SBD_MAGIC 0x53554e5342444c55 70fcf3ce44SJohn Forte 71*8fe96085Stim szeto #define SBD_VER_MAJOR 1 72*8fe96085Stim szeto #define SBD_VER_MINOR 1 73*8fe96085Stim szeto #define SBD_VER_SUBMINOR 0 74fcf3ce44SJohn Forte 75*8fe96085Stim szeto #if 0 76*8fe96085Stim szeto typedef struct sbd_meta_start { 77*8fe96085Stim szeto uint64_t sm_magic; 78*8fe96085Stim szeto uint64_t sm_meta_size; 79*8fe96085Stim szeto uint64_t sm_meta_size_used; 80*8fe96085Stim szeto uint64_t sm_rsvd1; /* Defaults to zero */ 81*8fe96085Stim szeto uint64_t sm_rsvd2; 82*8fe96085Stim szeto uint16_t sm_ver_major; 83*8fe96085Stim szeto uint16_t sm_ver_minor; 84*8fe96085Stim szeto uint16_t sm_ver_subminor; 85*8fe96085Stim szeto uint8_t sm_flags; 86*8fe96085Stim szeto uint8_t sm_chksum; 87*8fe96085Stim szeto } sbd_meta_start_t; 88*8fe96085Stim szeto #endif 89*8fe96085Stim szeto 90*8fe96085Stim szeto typedef struct sm_section_hdr { 91*8fe96085Stim szeto uint64_t sms_offset; /* Offset of this section */ 92*8fe96085Stim szeto uint32_t sms_size; /* Includes the header and padding */ 93*8fe96085Stim szeto uint16_t sms_id; /* Section identifier */ 94*8fe96085Stim szeto uint8_t sms_data_order; /* 0x00 or 0xff */ 95*8fe96085Stim szeto uint8_t sms_chksum; 96*8fe96085Stim szeto } sm_section_hdr_t; 97fcf3ce44SJohn Forte 98fcf3ce44SJohn Forte /* 99*8fe96085Stim szeto * sbd meta section identifiers 100fcf3ce44SJohn Forte */ 101*8fe96085Stim szeto #define SMS_ID_LU_INFO_1_0 0 102*8fe96085Stim szeto #define SMS_ID_LU_INFO_1_1 1 103*8fe96085Stim szeto #define SMS_ID_PGR_INFO 2 104*8fe96085Stim szeto #define SMS_ID_UNUSED 0x1000 105fcf3ce44SJohn Forte 106*8fe96085Stim szeto typedef struct sbd_lu_info_1_0 { 107*8fe96085Stim szeto sm_section_hdr_t sli_sms_header; 108*8fe96085Stim szeto uint64_t sli_total_store_size; 109*8fe96085Stim szeto uint64_t sli_total_meta_size; 110*8fe96085Stim szeto uint64_t sli_lu_data_offset; 111*8fe96085Stim szeto uint64_t sli_lu_data_size; 112*8fe96085Stim szeto uint32_t sli_flags; 113*8fe96085Stim szeto uint16_t sli_blocksize; 114*8fe96085Stim szeto uint8_t sli_data_order; 115*8fe96085Stim szeto uint8_t rsvd1; 116*8fe96085Stim szeto uint8_t sli_lu_devid[20]; 117*8fe96085Stim szeto uint32_t rsvd2; 118*8fe96085Stim szeto } sbd_lu_info_1_0_t; 119fcf3ce44SJohn Forte 120*8fe96085Stim szeto typedef struct sbd_lu_info_1_1 { 121*8fe96085Stim szeto sm_section_hdr_t sli_sms_header; 122*8fe96085Stim szeto uint32_t sli_flags; 123*8fe96085Stim szeto char sli_rev[4]; 124*8fe96085Stim szeto char sli_vid[8]; 125*8fe96085Stim szeto char sli_pid[16]; 126*8fe96085Stim szeto uint64_t sli_lu_size; /* Read capacity size */ 127fcf3ce44SJohn Forte 128fcf3ce44SJohn Forte /* 129*8fe96085Stim szeto * Essetially zfs volume name for zvols to verify that the 130*8fe96085Stim szeto * metadata is coming in from the correct zvol and not from a 131*8fe96085Stim szeto * clone. Has no meaning in any other case. 132fcf3ce44SJohn Forte */ 133*8fe96085Stim szeto uint16_t sli_meta_fname_offset; 134fcf3ce44SJohn Forte 135*8fe96085Stim szeto /* 136*8fe96085Stim szeto * Data filename or the media filename when the metadata is in 137*8fe96085Stim szeto * a separate file. Its not needed if the metadata is shared 138*8fe96085Stim szeto * with data as the user supplied name is the data filename. 139*8fe96085Stim szeto */ 140*8fe96085Stim szeto uint64_t sli_data_fname_offset; 141*8fe96085Stim szeto uint64_t sli_serial_offset; 142*8fe96085Stim szeto uint64_t sli_alias_offset; 143*8fe96085Stim szeto uint8_t sli_data_blocksize_shift; 144*8fe96085Stim szeto uint8_t sli_data_order; 145*8fe96085Stim szeto uint8_t sli_serial_size; 146*8fe96085Stim szeto uint8_t sli_rsvd1; 147*8fe96085Stim szeto uint8_t sli_device_id[20]; 148*8fe96085Stim szeto uint8_t sli_rsvd2[256]; 149*8fe96085Stim szeto 150*8fe96085Stim szeto /* 151*8fe96085Stim szeto * In case there is no separate meta, sli_meta_fname_offset wont 152*8fe96085Stim szeto * be valid. The same is true for zfs based metadata. The data_fname 153*8fe96085Stim szeto * is the zvol. 154*8fe96085Stim szeto */ 155*8fe96085Stim szeto uint8_t sli_buf[8]; 156*8fe96085Stim szeto } sbd_lu_info_1_1_t; 157*8fe96085Stim szeto 158*8fe96085Stim szeto /* 159*8fe96085Stim szeto * sli flags 160*8fe96085Stim szeto */ 161*8fe96085Stim szeto #define SLI_SEPARATE_META 0x0001 162*8fe96085Stim szeto #define SLI_WRITE_PROTECTED 0x0002 163*8fe96085Stim szeto #define SLI_VID_VALID 0x0004 164*8fe96085Stim szeto #define SLI_PID_VALID 0x0008 165*8fe96085Stim szeto #define SLI_REV_VALID 0x0010 166*8fe96085Stim szeto #define SLI_META_FNAME_VALID 0x0020 167*8fe96085Stim szeto #define SLI_DATA_FNAME_VALID 0x0040 168*8fe96085Stim szeto #define SLI_SERIAL_VALID 0x0080 169*8fe96085Stim szeto #define SLI_ALIAS_VALID 0x0100 170*8fe96085Stim szeto #define SLI_WRITEBACK_CACHE_DISABLE 0x0200 171*8fe96085Stim szeto #define SLI_ZFS_META 0x0400 172*8fe96085Stim szeto 173*8fe96085Stim szeto struct sbd_it_data; 174*8fe96085Stim szeto 175*8fe96085Stim szeto typedef struct sbd_lu { 176*8fe96085Stim szeto struct sbd_lu *sl_next; 177*8fe96085Stim szeto stmf_lu_t *sl_lu; 178*8fe96085Stim szeto uint32_t sl_alloc_size; 179*8fe96085Stim szeto 180*8fe96085Stim szeto /* Current LU state */ 181*8fe96085Stim szeto kmutex_t sl_lock; 182*8fe96085Stim szeto uint32_t sl_flags; 183*8fe96085Stim szeto uint8_t sl_trans_op; 184*8fe96085Stim szeto uint8_t sl_state:7, 185*8fe96085Stim szeto sl_state_not_acked:1; 186*8fe96085Stim szeto 187*8fe96085Stim szeto char *sl_name; /* refers to meta or data */ 188*8fe96085Stim szeto 189*8fe96085Stim szeto /* Metadata */ 190*8fe96085Stim szeto char *sl_alias; 191*8fe96085Stim szeto char *sl_meta_filename; /* If applicable */ 192*8fe96085Stim szeto vnode_t *sl_meta_vp; 193*8fe96085Stim szeto vtype_t sl_meta_vtype; 194*8fe96085Stim szeto uint8_t sl_device_id[20]; /* 4(hdr) + 16(GUID) */ 195*8fe96085Stim szeto uint8_t sl_meta_blocksize_shift; /* Left shift multiplier */ 196*8fe96085Stim szeto uint8_t sl_data_blocksize_shift; 197*8fe96085Stim szeto uint8_t sl_data_fs_nbits; 198*8fe96085Stim szeto uint8_t sl_serial_no_size; 199*8fe96085Stim szeto uint64_t sl_total_meta_size; 200*8fe96085Stim szeto uint64_t sl_meta_size_used; 201*8fe96085Stim szeto uint8_t *sl_serial_no; /* optional */ 202*8fe96085Stim szeto char sl_vendor_id[8]; 203*8fe96085Stim szeto char sl_product_id[16]; 204*8fe96085Stim szeto char sl_revision[4]; 205*8fe96085Stim szeto uint32_t sl_data_fname_alloc_size; /* for an explicit alloc */ 206*8fe96085Stim szeto uint32_t sl_alias_alloc_size; 207*8fe96085Stim szeto uint8_t sl_serial_no_alloc_size; 208*8fe96085Stim szeto 209*8fe96085Stim szeto /* zfs metadata */ 210*8fe96085Stim szeto vnode_t *sl_zfs_meta_vp; 211*8fe96085Stim szeto 212*8fe96085Stim szeto /* Backing store */ 213*8fe96085Stim szeto char *sl_data_filename; 214*8fe96085Stim szeto vnode_t *sl_data_vp; 215*8fe96085Stim szeto vtype_t sl_data_vtype; 216*8fe96085Stim szeto uint64_t sl_total_data_size; 217*8fe96085Stim szeto uint64_t sl_data_readable_size; /* read() fails after this */ 218*8fe96085Stim szeto uint64_t sl_data_offset; /* After the metadata,if any */ 219*8fe96085Stim szeto uint64_t sl_lu_size; /* READ CAPACITY size */ 220*8fe96085Stim szeto 221*8fe96085Stim szeto struct sbd_it_data *sl_it_list; 222*8fe96085Stim szeto struct sbd_pgr *sl_pgr; 223*8fe96085Stim szeto uint64_t sl_rs_owner_session_id; 224*8fe96085Stim szeto } sbd_lu_t; 225*8fe96085Stim szeto 226*8fe96085Stim szeto /* 227*8fe96085Stim szeto * sl_flags 228*8fe96085Stim szeto */ 229*8fe96085Stim szeto #define SL_LINKED 0x00001 230*8fe96085Stim szeto #define SL_META_OPENED 0x00002 231*8fe96085Stim szeto #define SL_REGISTERED 0x00004 232*8fe96085Stim szeto #define SL_META_NEEDS_FLUSH 0x00008 233*8fe96085Stim szeto #define SL_DATA_NEEDS_FLUSH 0x00010 234*8fe96085Stim szeto #define SL_VID_VALID 0x00020 235*8fe96085Stim szeto #define SL_PID_VALID 0x00040 236*8fe96085Stim szeto #define SL_REV_VALID 0x00080 237*8fe96085Stim szeto #define SL_WRITE_PROTECTED 0x00100 238*8fe96085Stim szeto #define SL_MEDIA_LOADED 0x00200 239*8fe96085Stim szeto #define SL_LU_HAS_SCSI2_RESERVATION 0x00400 240*8fe96085Stim szeto #define SL_WRITEBACK_CACHE_DISABLE 0x00800 241*8fe96085Stim szeto #define SL_SAVED_WRITE_CACHE_DISABLE 0x01000 242*8fe96085Stim szeto #define SL_MEDIUM_REMOVAL_PREVENTED 0x02000 243*8fe96085Stim szeto #define SL_NO_DATA_DKIOFLUSH 0x04000 244*8fe96085Stim szeto #define SL_SHARED_META 0x08000 245*8fe96085Stim szeto #define SL_ZFS_META 0x10000 246*8fe96085Stim szeto #define SL_WRITEBACK_CACHE_SET_UNSUPPORTED 0x20000 247*8fe96085Stim szeto #define SL_FLUSH_ON_DISABLED_WRITECACHE 0x40000 248*8fe96085Stim szeto 249*8fe96085Stim szeto /* 250*8fe96085Stim szeto * sl_trans_op. LU is undergoing some transition and this field 251*8fe96085Stim szeto * tells what kind of transition that is. 252*8fe96085Stim szeto */ 253*8fe96085Stim szeto #define SL_OP_NONE 0 254*8fe96085Stim szeto #define SL_OP_CREATE_REGISTER_LU 1 255*8fe96085Stim szeto #define SL_OP_IMPORT_LU 2 256*8fe96085Stim szeto #define SL_OP_DELETE_LU 3 257*8fe96085Stim szeto #define SL_OP_MODIFY_LU 4 258*8fe96085Stim szeto #define SL_OP_LU_PROPS 5 259*8fe96085Stim szeto 260*8fe96085Stim szeto sbd_status_t sbd_data_read(sbd_lu_t *sl, uint64_t offset, uint64_t size, 261*8fe96085Stim szeto uint8_t *buf); 262*8fe96085Stim szeto sbd_status_t sbd_data_write(sbd_lu_t *sl, uint64_t offset, uint64_t size, 263*8fe96085Stim szeto uint8_t *buf); 264*8fe96085Stim szeto stmf_status_t sbd_task_alloc(struct scsi_task *task); 265*8fe96085Stim szeto void sbd_new_task(struct scsi_task *task, struct stmf_data_buf *initial_dbuf); 266*8fe96085Stim szeto void sbd_dbuf_xfer_done(struct scsi_task *task, struct stmf_data_buf *dbuf); 267*8fe96085Stim szeto void sbd_send_status_done(struct scsi_task *task); 268*8fe96085Stim szeto void sbd_task_free(struct scsi_task *task); 269*8fe96085Stim szeto stmf_status_t sbd_abort(struct stmf_lu *lu, int abort_cmd, void *arg, 270*8fe96085Stim szeto uint32_t flags); 271*8fe96085Stim szeto void sbd_ctl(struct stmf_lu *lu, int cmd, void *arg); 272*8fe96085Stim szeto stmf_status_t sbd_info(uint32_t cmd, stmf_lu_t *lu, void *arg, uint8_t *buf, 273*8fe96085Stim szeto uint32_t *bufsizep); 274*8fe96085Stim szeto sbd_status_t sbd_write_lu_info(sbd_lu_t *sl); 275*8fe96085Stim szeto sbd_status_t sbd_flush_data_cache(sbd_lu_t *sl, int fsync_done); 276*8fe96085Stim szeto sbd_status_t sbd_wcd_set(int wcd, sbd_lu_t *sl); 277*8fe96085Stim szeto void sbd_wcd_get(int *wcd, sbd_lu_t *sl); 278fcf3ce44SJohn Forte 279fcf3ce44SJohn Forte #ifdef __cplusplus 280fcf3ce44SJohn Forte } 281fcf3ce44SJohn Forte #endif 282fcf3ce44SJohn Forte 283fcf3ce44SJohn Forte #endif /* _STMF_SBD_H */ 284