1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _VDC_H 28 #define _VDC_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 /* 33 * Virtual disk client implementation definitions 34 */ 35 36 #include <sys/sysmacros.h> 37 #include <sys/note.h> 38 39 #include <sys/ldc.h> 40 #include <sys/vio_mailbox.h> 41 #include <sys/vdsk_mailbox.h> 42 #include <sys/vdsk_common.h> 43 44 #ifdef __cplusplus 45 extern "C" { 46 #endif 47 48 #define VDC_DRIVER_NAME "vdc" 49 50 /* 51 * Bit-field values to indicate if parts of the vdc driver are initialised. 52 */ 53 #define VDC_SOFT_STATE 0x0001 54 #define VDC_LOCKS 0x0002 55 #define VDC_MINOR 0x0004 56 #define VDC_THREAD 0x0008 57 #define VDC_LDC 0x0010 58 #define VDC_LDC_INIT 0x0020 59 #define VDC_LDC_CB 0x0040 60 #define VDC_LDC_OPEN 0x0080 61 #define VDC_DRING_INIT 0x0100 /* The DRing was created */ 62 #define VDC_DRING_BOUND 0x0200 /* The DRing was bound to an LDC channel */ 63 #define VDC_DRING_LOCAL 0x0400 /* The local private DRing was allocated */ 64 #define VDC_DRING_ENTRY 0x0800 /* At least one DRing entry was initialised */ 65 #define VDC_DRING (VDC_DRING_INIT | VDC_DRING_BOUND | \ 66 VDC_DRING_LOCAL | VDC_DRING_ENTRY) 67 #define VDC_HANDSHAKE 0x1000 /* Indicates if a handshake is in progress */ 68 #define VDC_HANDSHAKE_STOP 0x2000 /* stop further handshakes */ 69 70 /* 71 * Definitions of strings to be used to create device node properties. 72 * (vdc uses the capitalised versions of these properties as they are 64-bit) 73 */ 74 #define VDC_NBLOCKS_PROP_NAME "Nblocks" 75 #define VDC_SIZE_PROP_NAME "Size" 76 77 /* 78 * Definitions of MD nodes/properties. 79 */ 80 #define VDC_MD_CHAN_NAME "channel-endpoint" 81 #define VDC_MD_VDEV_NAME "virtual-device" 82 #define VDC_MD_DISK_NAME "disk" 83 #define VDC_MD_CFG_HDL "cfg-handle" 84 #define VDC_ID_PROP "id" 85 86 /* 87 * Definition of actions to be carried out when processing the sequence ID 88 * of a message received from the vDisk server. The function verifying the 89 * sequence number checks the 'seq_num_xxx' fields in the soft state and 90 * returns whether the message should be processed (VDC_SEQ_NUM_TODO) or 91 * whether it was it was previously processed (VDC_SEQ_NUM_SKIP). 92 */ 93 #define VDC_SEQ_NUM_INVALID -1 /* Error */ 94 #define VDC_SEQ_NUM_SKIP 0 /* Request already processed */ 95 #define VDC_SEQ_NUM_TODO 1 /* Request needs processing */ 96 97 /* 98 * Macros to get UNIT and PART number 99 */ 100 #define VDCUNIT_SHIFT 3 101 #define VDCPART_MASK 7 102 103 #define VDCUNIT(dev) (getminor((dev)) >> VDCUNIT_SHIFT) 104 #define VDCPART(dev) (getminor((dev)) & VDCPART_MASK) 105 106 /* 107 * Scheme to store the instance number and the slice number in the minor number. 108 * (NOTE: Uses the same format and definitions as the sd(7D) driver) 109 */ 110 #define VD_MAKE_DEV(instance, minor) ((instance << VDCUNIT_SHIFT) | minor) 111 112 /* 113 * variables controlling how long to wait before timing out and how many 114 * retries to attempt before giving up when communicating with vds. 115 * 116 * These values need to be sufficiently large so that a guest can survive 117 * the reboot of the service domain. 118 */ 119 #define VDC_RETRIES 10 120 121 #define VDC_USEC_TIMEOUT_MIN (30 * MICROSEC) /* 30 sec */ 122 123 /* 124 * This macro returns the number of Hz that the vdc driver should wait before 125 * a timeout is triggered. The 'timeout' parameter specifiecs the wait 126 * time in Hz. The 'mul' parameter allows for a multiplier to be 127 * specified allowing for a backoff to be implemented (e.g. using the 128 * retry number as a multiplier) where the wait time will get longer if 129 * there is no response on the previous retry. 130 */ 131 #define VD_GET_TIMEOUT_HZ(timeout, mul) \ 132 (ddi_get_lbolt() + ((timeout) * MAX(1, (mul)))) 133 134 /* 135 * Macros to manipulate Descriptor Ring variables in the soft state 136 * structure. 137 */ 138 #define VDC_GET_NEXT_REQ_ID(vdc) ((vdc)->req_id++) 139 140 #define VDC_GET_DRING_ENTRY_PTR(vdc, idx) \ 141 (vd_dring_entry_t *)((vdc)->dring_mem_info.vaddr + \ 142 (idx * (vdc)->dring_entry_size)) 143 144 #define VDC_MARK_DRING_ENTRY_FREE(vdc, idx) \ 145 { \ 146 vd_dring_entry_t *dep = NULL; \ 147 ASSERT(vdc != NULL); \ 148 ASSERT((idx >= 0) && (idx < vdc->dring_len)); \ 149 ASSERT(vdc->dring_mem_info.vaddr != NULL); \ 150 dep = (vd_dring_entry_t *)(vdc->dring_mem_info.vaddr + \ 151 (idx * vdc->dring_entry_size)); \ 152 ASSERT(dep != NULL); \ 153 dep->hdr.dstate = VIO_DESC_FREE; \ 154 } 155 156 /* Initialise the Session ID and Sequence Num in the DRing msg */ 157 #define VDC_INIT_DRING_DATA_MSG_IDS(dmsg, vdc) \ 158 ASSERT(vdc != NULL); \ 159 dmsg.tag.vio_sid = vdc->session_id; \ 160 dmsg.seq_num = vdc->seq_num; 161 162 /* 163 * The states that the read thread can be in. 164 */ 165 typedef enum vdc_rd_state { 166 VDC_READ_IDLE, /* idling - conn is not up */ 167 VDC_READ_WAITING, /* waiting for data */ 168 VDC_READ_PENDING, /* pending data avail for read */ 169 VDC_READ_RESET /* channel was reset - stop reads */ 170 } vdc_rd_state_t; 171 172 /* 173 * The states that the vdc-vds connection can be in. 174 */ 175 typedef enum vdc_state { 176 VDC_STATE_INIT, /* device is initialized */ 177 VDC_STATE_INIT_WAITING, /* waiting for ldc connection */ 178 VDC_STATE_NEGOTIATE, /* doing handshake negotiation */ 179 VDC_STATE_HANDLE_PENDING, /* handle requests in backup dring */ 180 VDC_STATE_RUNNING, /* running and accepting requests */ 181 VDC_STATE_DETACH, /* detaching */ 182 VDC_STATE_RESETTING /* resetting connection with vds */ 183 } vdc_state_t; 184 185 /* 186 * The states that the vdc instance can be in. 187 */ 188 typedef enum vdc_lc_state { 189 VDC_LC_ATTACHING, /* driver is attaching */ 190 VDC_LC_ONLINE, /* driver is attached and online */ 191 VDC_LC_DETACHING /* driver is detaching */ 192 } vdc_lc_state_t; 193 194 /* 195 * Local Descriptor Ring entry 196 * 197 * vdc creates a Local (private) descriptor ring the same size as the 198 * public descriptor ring it exports to vds. 199 */ 200 201 typedef enum { 202 VIO_read_dir, /* read data from server */ 203 VIO_write_dir, /* write data to server */ 204 VIO_both_dir /* transfer both in and out in same buffer */ 205 } vio_desc_direction_t; 206 207 typedef enum { 208 CB_STRATEGY, /* non-blocking strategy call */ 209 CB_SYNC /* synchronous operation */ 210 } vio_cb_type_t; 211 212 typedef struct vdc_local_desc { 213 boolean_t is_free; /* local state - inuse or not */ 214 215 int operation; /* VD_OP_xxx to be performed */ 216 caddr_t addr; /* addr passed in by consumer */ 217 int slice; 218 diskaddr_t offset; /* disk offset */ 219 size_t nbytes; 220 vio_cb_type_t cb_type; /* operation type blk/nonblk */ 221 void *cb_arg; /* buf passed to strategy() */ 222 vio_desc_direction_t dir; /* direction of transfer */ 223 224 caddr_t align_addr; /* used if addr non-aligned */ 225 ldc_mem_handle_t desc_mhdl; /* Mem handle of buf */ 226 vd_dring_entry_t *dep; /* public Dring Entry Pointer */ 227 228 } vdc_local_desc_t; 229 230 /* 231 * vdc soft state structure 232 */ 233 typedef struct vdc { 234 235 kmutex_t lock; /* protects next 2 sections of vars */ 236 kcondvar_t running_cv; /* signal when upper layers can send */ 237 kcondvar_t initwait_cv; /* signal when ldc conn is up */ 238 kcondvar_t dring_free_cv; /* signal when desc is avail */ 239 kcondvar_t membind_cv; /* signal when mem can be bound */ 240 boolean_t self_reset; 241 242 int initialized; /* keeps track of what's init'ed */ 243 vdc_lc_state_t lifecycle; /* Current state of the vdc instance */ 244 245 int hshake_cnt; /* number of failed handshakes */ 246 int open_count; /* count of outstanding opens */ 247 int dkio_flush_pending; /* # outstanding DKIO flushes */ 248 249 kthread_t *msg_proc_thr; /* main msg processing thread */ 250 251 kmutex_t read_lock; /* lock to protect read */ 252 kcondvar_t read_cv; /* cv to wait for READ events */ 253 vdc_rd_state_t read_state; /* current read state */ 254 255 uint32_t sync_op_cnt; /* num of active sync operations */ 256 boolean_t sync_op_pending; /* sync operation is pending */ 257 boolean_t sync_op_blocked; /* blocked waiting to do sync op */ 258 uint32_t sync_op_status; /* status of sync operation */ 259 kcondvar_t sync_pending_cv; /* cv wait for sync op to finish */ 260 kcondvar_t sync_blocked_cv; /* cv wait for other syncs to finish */ 261 262 uint64_t session_id; /* common ID sent with all messages */ 263 uint64_t seq_num; /* most recent sequence num generated */ 264 uint64_t seq_num_reply; /* Last seq num ACK/NACK'ed by vds */ 265 uint64_t req_id; /* Most recent Request ID generated */ 266 uint64_t req_id_proc; /* Last request ID processed by vdc */ 267 vdc_state_t state; /* Current disk client-server state */ 268 269 dev_info_t *dip; /* device info pointer */ 270 int instance; /* driver instance number */ 271 272 vio_ver_t ver; /* version number agreed with server */ 273 vd_disk_type_t vdisk_type; /* type of device/disk being imported */ 274 vd_disk_label_t vdisk_label; /* label type of device/disk imported */ 275 uint64_t vdisk_size; /* device size in blocks */ 276 uint64_t max_xfer_sz; /* maximum block size of a descriptor */ 277 uint64_t block_size; /* device block size used */ 278 struct dk_label *label; /* structure to store disk label */ 279 struct dk_cinfo *cinfo; /* structure to store DKIOCINFO data */ 280 struct dk_minfo *minfo; /* structure for DKIOCGMEDIAINFO data */ 281 struct vtoc *vtoc; /* structure to store VTOC data */ 282 ddi_devid_t devid; /* device id */ 283 284 ldc_mem_info_t dring_mem_info; /* dring information */ 285 uint_t dring_curr_idx; /* current index */ 286 uint32_t dring_len; /* dring length */ 287 uint32_t dring_max_cookies; /* dring max cookies */ 288 uint32_t dring_cookie_count; /* num cookies */ 289 uint32_t dring_entry_size; /* descriptor size */ 290 ldc_mem_cookie_t *dring_cookie; /* dring cookies */ 291 uint64_t dring_ident; /* dring ident */ 292 293 uint64_t threads_pending; /* num of threads */ 294 295 vdc_local_desc_t *local_dring; /* local dring */ 296 vdc_local_desc_t *local_dring_backup; /* local dring backup */ 297 int local_dring_backup_tail; /* backup dring tail */ 298 int local_dring_backup_len; /* backup dring len */ 299 300 uint64_t ldc_id; /* LDC channel id */ 301 ldc_status_t ldc_state; /* LDC channel state */ 302 ldc_handle_t ldc_handle; /* LDC handle */ 303 ldc_dring_handle_t ldc_dring_hdl; /* LDC dring handle */ 304 } vdc_t; 305 306 /* 307 * Debugging macros 308 */ 309 #ifdef DEBUG 310 extern int vdc_msglevel; 311 extern uint64_t vdc_matchinst; 312 313 #define DMSG(_vdc, err_level, format, ...) \ 314 do { \ 315 if (vdc_msglevel > err_level && \ 316 (vdc_matchinst & (1ull << (_vdc)->instance))) \ 317 cmn_err(CE_CONT, "?[%d,t@%p] %s: "format, \ 318 (_vdc)->instance, (void *)curthread, \ 319 __func__, __VA_ARGS__); \ 320 _NOTE(CONSTANTCONDITION) \ 321 } while (0); 322 323 #define DMSGX(err_level, format, ...) \ 324 do { \ 325 if (vdc_msglevel > err_level) \ 326 cmn_err(CE_CONT, "?%s: "format, __func__, __VA_ARGS__);\ 327 _NOTE(CONSTANTCONDITION) \ 328 } while (0); 329 330 #define VDC_DUMP_DRING_MSG(dmsgp) \ 331 DMSGX(0, "sq:%lu start:%d end:%d ident:%lu\n", \ 332 dmsgp->seq_num, dmsgp->start_idx, \ 333 dmsgp->end_idx, dmsgp->dring_ident); 334 335 #else /* !DEBUG */ 336 #define DMSG(err_level, ...) 337 #define DMSGX(err_level, format, ...) 338 #define VDC_DUMP_DRING_MSG(dmsgp) 339 340 #endif /* !DEBUG */ 341 342 #ifdef __cplusplus 343 } 344 #endif 345 346 #endif /* _VDC_H */ 347