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 2007 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _VDSK_COMMON_H 28 #define _VDSK_COMMON_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif 35 36 /* 37 * This header file contains the private LDoms Virtual Disk (vDisk) definitions 38 * common to both the server (vds) and the client (vdc) 39 */ 40 41 #include <sys/efi_partition.h> 42 #include <sys/machparam.h> 43 #include <sys/vtoc.h> 44 45 #include <sys/ldc.h> 46 #include <sys/vio_common.h> 47 #include <sys/vio_mailbox.h> 48 49 /* 50 * vDisk definitions 51 */ 52 53 /* 54 * The number of Descriptor Ring entries 55 * 56 * Constraints: 57 * - overall DRing size must be greater than 8K (MMU_PAGESIZE) 58 * - overall DRing size should be 8K aligned (desirable but not enforced) 59 * - DRing entry must be 8 byte aligned 60 */ 61 #define VD_DRING_LEN 512 62 63 /* 64 * 65 */ 66 #define VD_DRING_ENTRY_SZ (sizeof (vd_dring_entry_t) + \ 67 (sizeof (ldc_mem_cookie_t) * (VD_MAX_COOKIES - 1))) 68 69 /* 70 * The maximum block size we can transmit using one Descriptor Ring entry 71 * 72 * Currently no FS uses more than 128K and it doesn't look like they 73 * will either as there is no perf gain to be had by larger values. 74 * ( see ZFS comment at definition of SPA_MAXBLOCKSIZE ). 75 * 76 * We choose 256K to give us some headroom. 77 */ 78 #define VD_MAX_BLOCK_SIZE (256 * 1024) 79 80 #define VD_MAX_COOKIES ((VD_MAX_BLOCK_SIZE / PAGESIZE) + 1) 81 #define VD_USEC_TIMEOUT 20000 82 #define VD_LDC_IDS_PROP "ldc-ids" 83 #define VD_LDC_MTU 256 84 85 /* 86 * Flags used by ioctl routines to indicate if a copyin/copyout is needed 87 */ 88 #define VD_COPYOUT 0x1 89 #define VD_COPYIN 0x2 90 91 /* 92 * vDisk operations on physical devices 93 */ 94 #define VD_OP_BREAD 0x01 /* Block Read */ 95 #define VD_OP_BWRITE 0x02 /* Block Write */ 96 #define VD_OP_FLUSH 0x03 /* Flush disk write cache contents */ 97 #define VD_OP_GET_WCE 0x04 /* Get disk W$ status */ 98 #define VD_OP_SET_WCE 0x05 /* Enable/Disable disk W$ */ 99 #define VD_OP_GET_VTOC 0x06 /* Get VTOC */ 100 #define VD_OP_SET_VTOC 0x07 /* Set VTOC */ 101 #define VD_OP_GET_DISKGEOM 0x08 /* Get disk geometry */ 102 #define VD_OP_SET_DISKGEOM 0x09 /* Set disk geometry */ 103 #define VD_OP_SCSICMD 0x0a /* SCSI control command */ 104 #define VD_OP_GET_DEVID 0x0b /* Get device id */ 105 #define VD_OP_GET_EFI 0x0c /* Get EFI */ 106 #define VD_OP_SET_EFI 0x0d /* Set EFI */ 107 #define VD_OP_RESET 0x0e /* Reset disk */ 108 #define VD_OP_GET_ACCESS 0x0f /* Get disk access */ 109 #define VD_OP_SET_ACCESS 0x10 /* Set disk access */ 110 #define VD_OP_GET_CAPACITY 0x11 /* Get disk capacity */ 111 #define VD_OP_MASK 0xFF /* mask of all possible operations */ 112 #define VD_OP_COUNT 0x11 /* Number of operations */ 113 114 /* 115 * Status for the VD_OP_GET_ACCESS operation 116 */ 117 #define VD_ACCESS_DENIED 0x00 /* access is not allowed */ 118 #define VD_ACCESS_ALLOWED 0x01 /* access is allowed */ 119 120 /* 121 * Flags for the VD_OP_SET_ACCESS operation 122 */ 123 #define VD_ACCESS_SET_CLEAR 0x00 /* clear exclusive access rights */ 124 #define VD_ACCESS_SET_EXCLUSIVE 0x01 /* set exclusive access rights */ 125 #define VD_ACCESS_SET_PREEMPT 0x02 /* forcefully set access rights */ 126 #define VD_ACCESS_SET_PRESERVE 0x04 /* preserve access rights */ 127 128 /* 129 * This is a mask of all the basic operations supported by all 130 * disk types (v1.0). 131 */ 132 #define VD_OP_MASK_READ \ 133 ((1 << VD_OP_BREAD) | \ 134 (1 << VD_OP_GET_WCE) | \ 135 (1 << VD_OP_GET_VTOC) | \ 136 (1 << VD_OP_GET_DISKGEOM) | \ 137 (1 << VD_OP_GET_DEVID) | \ 138 (1 << VD_OP_GET_EFI)) 139 140 #define VD_OP_MASK_WRITE \ 141 ((1 << VD_OP_BWRITE) | \ 142 (1 << VD_OP_FLUSH) | \ 143 (1 << VD_OP_SET_WCE) | \ 144 (1 << VD_OP_SET_VTOC) | \ 145 (1 << VD_OP_SET_DISKGEOM) | \ 146 (1 << VD_OP_SET_EFI)) 147 148 /* 149 * Mask for additional operations provided for SCSI disks (v1.1) 150 */ 151 #define VD_OP_MASK_SCSI \ 152 ((1 << VD_OP_SCSICMD) | \ 153 (1 << VD_OP_RESET) | \ 154 (1 << VD_OP_GET_ACCESS) | \ 155 (1 << VD_OP_SET_ACCESS) | \ 156 (1 << VD_OP_GET_CAPACITY)) 157 158 /* 159 * macro to check if the operation 'op' is supported by checking the list 160 * of operations supported which is exported by the vDisk server. 161 */ 162 #define VD_OP_SUPPORTED(ops_bitmask, op) ((ops_bitmask) & (1 << (op))) 163 164 /* 165 * Slice for absolute disk transaction. 166 */ 167 #define VD_SLICE_NONE 0xFF 168 169 /* 170 * EFI disks do not have a slice 7. Actually that slice is used to represent 171 * the whole disk. 172 */ 173 #define VD_EFI_WD_SLICE 7 174 175 /* 176 * Definitions of the various ways vds can export disk support to vdc. 177 */ 178 typedef enum vd_disk_type { 179 VD_DISK_TYPE_UNK = 0, /* Unknown device type */ 180 VD_DISK_TYPE_SLICE, /* slice in block device */ 181 VD_DISK_TYPE_DISK /* entire disk (slice 2) */ 182 } vd_disk_type_t; 183 184 /* 185 * Definitions of the various disk label that vDisk supports. 186 */ 187 typedef enum vd_disk_label { 188 VD_DISK_LABEL_UNK = 0, /* Unknown disk label */ 189 VD_DISK_LABEL_VTOC, /* VTOC disk label */ 190 VD_DISK_LABEL_EFI /* EFI disk label */ 191 } vd_disk_label_t; 192 193 /* 194 * vDisk Descriptor payload 195 */ 196 typedef struct vd_dring_payload { 197 uint64_t req_id; /* The request ID being processed */ 198 uint8_t operation; /* operation for server to perform */ 199 uint8_t slice; /* The disk slice being accessed */ 200 uint16_t resv1; /* padding */ 201 uint32_t status; /* "errno" of server operation */ 202 uint64_t addr; /* LP64 diskaddr_t (block I/O) */ 203 uint64_t nbytes; /* LP64 size_t */ 204 uint32_t ncookies; /* Number of cookies used */ 205 uint32_t resv2; /* padding */ 206 207 ldc_mem_cookie_t cookie[1]; /* variable sized array */ 208 } vd_dring_payload_t; 209 210 211 /* 212 * vDisk Descriptor entry 213 */ 214 typedef struct vd_dring_entry { 215 vio_dring_entry_hdr_t hdr; /* common header */ 216 vd_dring_payload_t payload; /* disk specific data */ 217 } vd_dring_entry_t; 218 219 220 /* 221 * vDisk control operation structures 222 */ 223 224 /* 225 * vDisk geometry definition (VD_OP_GET_DISKGEOM and VD_OP_SET_DISKGEOM) 226 */ 227 typedef struct vd_geom { 228 uint16_t ncyl; /* number of data cylinders */ 229 uint16_t acyl; /* number of alternate cylinders */ 230 uint16_t bcyl; /* cyl offset for fixed head area */ 231 uint16_t nhead; /* number of heads */ 232 uint16_t nsect; /* number of data sectors per track */ 233 uint16_t intrlv; /* interleave factor */ 234 uint16_t apc; /* alternates per cyl (SCSI only) */ 235 uint16_t rpm; /* revolutions per minute */ 236 uint16_t pcyl; /* number of physical cylinders */ 237 uint16_t write_reinstruct; /* # sectors to skip, writes */ 238 uint16_t read_reinstruct; /* # sectors to skip, reads */ 239 } vd_geom_t; 240 241 242 /* 243 * vDisk partition definition 244 */ 245 typedef struct vd_partition { 246 uint16_t id_tag; /* ID tag of partition */ 247 uint16_t perm; /* permission flags for partition */ 248 uint32_t reserved; /* padding */ 249 uint64_t start; /* block number of partition start */ 250 uint64_t nblocks; /* number of blocks in partition */ 251 } vd_partition_t; 252 253 /* 254 * vDisk VTOC definition (VD_OP_GET_VTOC and VD_OP_SET_VTOC) 255 */ 256 #define VD_VOLNAME_LEN 8 /* length of volume_name field */ 257 #define VD_ASCIILABEL_LEN 128 /* length of ascii_label field */ 258 typedef struct vd_vtoc { 259 char volume_name[VD_VOLNAME_LEN]; /* volume name */ 260 uint16_t sector_size; /* sector size in bytes */ 261 uint16_t num_partitions; /* number of partitions */ 262 char ascii_label[VD_ASCIILABEL_LEN]; /* ASCII label */ 263 vd_partition_t partition[V_NUMPAR]; /* partition headers */ 264 } vd_vtoc_t; 265 266 267 /* 268 * vDisk EFI definition (VD_OP_GET_EFI and VD_OP_SET_EFI) 269 */ 270 typedef struct vd_efi { 271 uint64_t lba; /* lba of the request */ 272 uint64_t length; /* length of data */ 273 char data[1]; /* data of the request */ 274 } vd_efi_t; 275 276 277 /* 278 * vDisk DEVID definition (VD_OP_GET_DEVID) 279 */ 280 #define VD_DEVID_SIZE(l) (sizeof (vd_devid_t) - 1 + l) 281 #define VD_DEVID_DEFAULT_LEN 128 282 283 typedef struct vd_devid { 284 uint16_t reserved; /* padding */ 285 uint16_t type; /* type of device id */ 286 uint32_t length; /* length the device id */ 287 char id[1]; /* device id */ 288 } vd_devid_t; 289 290 /* 291 * vDisk CAPACITY definition (VD_OP_GET_CAPACITY) 292 */ 293 typedef struct vd_capacity { 294 uint32_t vdisk_block_size; /* block size in bytes */ 295 uint32_t reserved; /* reserved */ 296 uint64_t vdisk_size; /* disk size in blocks */ 297 } vd_capacity_t; 298 299 /* Identifier for unknown disk size */ 300 #define VD_SIZE_UNKNOWN -1 301 302 /* 303 * vDisk SCSI definition (VD_OP_SCSICMD) 304 */ 305 typedef struct vd_scsi { 306 uint8_t cmd_status; /* command completion status */ 307 uint8_t sense_status; /* sense command completion status */ 308 uint8_t task_attribute; /* task attribute */ 309 uint8_t task_priority; /* task priority */ 310 uint8_t crn; /* command reference number */ 311 uint8_t reserved; /* reserved */ 312 uint16_t timeout; /* command timeout */ 313 uint64_t options; /* options */ 314 uint64_t cdb_len; /* CDB data length */ 315 uint64_t sense_len; /* sense request length */ 316 uint64_t datain_len; /* data in buffer length */ 317 uint64_t dataout_len; /* data out buffer length */ 318 char data[1]; /* data (CDB, sense, data in/out */ 319 } vd_scsi_t; 320 321 /* Minimum size of the vd_scsi structure */ 322 #define VD_SCSI_SIZE (sizeof (vd_scsi_t) - sizeof (uint64_t)) 323 324 /* 325 * Macros to access data buffers in a vd_scsi structure. When using these 326 * macros, the vd_scsi structure needs to be populated with the sizes of 327 * data buffers allocated in the structure. 328 */ 329 #define VD_SCSI_DATA_CDB(vscsi) \ 330 ((union scsi_cdb *)(uintptr_t)((vscsi)->data)) 331 332 #define VD_SCSI_DATA_SENSE(vscsi) \ 333 ((struct scsi_extended_sense *)(uintptr_t)((vscsi)->data + \ 334 P2ROUNDUP((vscsi)->cdb_len, sizeof (uint64_t)))) 335 336 #define VD_SCSI_DATA_IN(vscsi) \ 337 ((uintptr_t)((vscsi)->data + \ 338 P2ROUNDUP((vscsi)->cdb_len, sizeof (uint64_t)) + \ 339 P2ROUNDUP((vscsi)->sense_len, sizeof (uint64_t)))) 340 341 #define VD_SCSI_DATA_OUT(vscsi) \ 342 ((uintptr_t)((vscsi)->data + \ 343 P2ROUNDUP((vscsi)->cdb_len, sizeof (uint64_t)) + \ 344 P2ROUNDUP((vscsi)->sense_len, sizeof (uint64_t)) + \ 345 P2ROUNDUP((vscsi)->datain_len, sizeof (uint64_t)))) 346 347 /* vDisk SCSI task attribute */ 348 #define VD_SCSI_TASK_SIMPLE 0x01 /* simple task */ 349 #define VD_SCSI_TASK_ORDERED 0x02 /* ordered task */ 350 #define VD_SCSI_TASK_HQUEUE 0x03 /* head of queue task */ 351 #define VD_SCSI_TASK_ACA 0x04 /* ACA task */ 352 353 /* vDisk SCSI options */ 354 #define VD_SCSI_OPT_CRN 0x01 /* request has a CRN */ 355 #define VD_SCSI_OPT_NORETRY 0x02 /* do not attempt any retry */ 356 357 /* 358 * Copy the contents of a vd_geom_t to the contents of a dk_geom struct 359 */ 360 #define VD_GEOM2DK_GEOM(vd_geom, dk_geom) \ 361 { \ 362 bzero((dk_geom), sizeof (*(dk_geom))); \ 363 (dk_geom)->dkg_ncyl = (vd_geom)->ncyl; \ 364 (dk_geom)->dkg_acyl = (vd_geom)->acyl; \ 365 (dk_geom)->dkg_bcyl = (vd_geom)->bcyl; \ 366 (dk_geom)->dkg_nhead = (vd_geom)->nhead; \ 367 (dk_geom)->dkg_nsect = (vd_geom)->nsect; \ 368 (dk_geom)->dkg_intrlv = (vd_geom)->intrlv; \ 369 (dk_geom)->dkg_apc = (vd_geom)->apc; \ 370 (dk_geom)->dkg_rpm = (vd_geom)->rpm; \ 371 (dk_geom)->dkg_pcyl = (vd_geom)->pcyl; \ 372 (dk_geom)->dkg_write_reinstruct = (vd_geom)->write_reinstruct; \ 373 (dk_geom)->dkg_read_reinstruct = (vd_geom)->read_reinstruct; \ 374 } 375 376 /* 377 * Copy the contents of a vd_vtoc_t to the contents of a vtoc struct 378 */ 379 #define VD_VTOC2VTOC(vd_vtoc, vtoc) \ 380 { \ 381 bzero((vtoc), sizeof (*(vtoc))); \ 382 bcopy((vd_vtoc)->volume_name, (vtoc)->v_volume, \ 383 MIN(sizeof ((vd_vtoc)->volume_name), \ 384 sizeof ((vtoc)->v_volume))); \ 385 bcopy((vd_vtoc)->ascii_label, (vtoc)->v_asciilabel, \ 386 MIN(sizeof ((vd_vtoc)->ascii_label), \ 387 sizeof ((vtoc)->v_asciilabel))); \ 388 (vtoc)->v_sanity = VTOC_SANE; \ 389 (vtoc)->v_version = V_VERSION; \ 390 (vtoc)->v_sectorsz = (vd_vtoc)->sector_size; \ 391 (vtoc)->v_nparts = (vd_vtoc)->num_partitions; \ 392 for (int i = 0; i < (vd_vtoc)->num_partitions; i++) { \ 393 (vtoc)->v_part[i].p_tag = (vd_vtoc)->partition[i].id_tag; \ 394 (vtoc)->v_part[i].p_flag = (vd_vtoc)->partition[i].perm; \ 395 (vtoc)->v_part[i].p_start = (vd_vtoc)->partition[i].start; \ 396 (vtoc)->v_part[i].p_size = (vd_vtoc)->partition[i].nblocks; \ 397 } \ 398 } 399 400 /* 401 * Copy the contents of a dk_geom struct to the contents of a vd_geom_t 402 */ 403 #define DK_GEOM2VD_GEOM(dk_geom, vd_geom) \ 404 { \ 405 bzero((vd_geom), sizeof (*(vd_geom))); \ 406 (vd_geom)->ncyl = (dk_geom)->dkg_ncyl; \ 407 (vd_geom)->acyl = (dk_geom)->dkg_acyl; \ 408 (vd_geom)->bcyl = (dk_geom)->dkg_bcyl; \ 409 (vd_geom)->nhead = (dk_geom)->dkg_nhead; \ 410 (vd_geom)->nsect = (dk_geom)->dkg_nsect; \ 411 (vd_geom)->intrlv = (dk_geom)->dkg_intrlv; \ 412 (vd_geom)->apc = (dk_geom)->dkg_apc; \ 413 (vd_geom)->rpm = (dk_geom)->dkg_rpm; \ 414 (vd_geom)->pcyl = (dk_geom)->dkg_pcyl; \ 415 (vd_geom)->write_reinstruct = (dk_geom)->dkg_write_reinstruct; \ 416 (vd_geom)->read_reinstruct = (dk_geom)->dkg_read_reinstruct; \ 417 } 418 419 /* 420 * Copy the contents of a vtoc struct to the contents of a vd_vtoc_t 421 */ 422 #define VTOC2VD_VTOC(vtoc, vd_vtoc) \ 423 { \ 424 bzero((vd_vtoc), sizeof (*(vd_vtoc))); \ 425 bcopy((vtoc)->v_volume, (vd_vtoc)->volume_name, \ 426 MIN(sizeof ((vtoc)->v_volume), \ 427 sizeof ((vd_vtoc)->volume_name))); \ 428 bcopy((vtoc)->v_asciilabel, (vd_vtoc)->ascii_label, \ 429 MIN(sizeof ((vtoc)->v_asciilabel), \ 430 sizeof ((vd_vtoc)->ascii_label))); \ 431 (vd_vtoc)->sector_size = (vtoc)->v_sectorsz; \ 432 (vd_vtoc)->num_partitions = (vtoc)->v_nparts; \ 433 for (int i = 0; i < (vtoc)->v_nparts; i++) { \ 434 (vd_vtoc)->partition[i].id_tag = (vtoc)->v_part[i].p_tag; \ 435 (vd_vtoc)->partition[i].perm = (vtoc)->v_part[i].p_flag; \ 436 (vd_vtoc)->partition[i].start = (vtoc)->v_part[i].p_start; \ 437 (vd_vtoc)->partition[i].nblocks = (vtoc)->v_part[i].p_size; \ 438 } \ 439 } 440 441 /* 442 * Copy the contents of a vd_efi_t to the contents of a dk_efi_t. 443 * Note that (dk_efi)->dki_data and (vd_efi)->data should be correctly 444 * initialized prior to using this macro. 445 */ 446 #define VD_EFI2DK_EFI(vd_efi, dk_efi) \ 447 { \ 448 (dk_efi)->dki_lba = (vd_efi)->lba; \ 449 (dk_efi)->dki_length = (vd_efi)->length; \ 450 bcopy((vd_efi)->data, (dk_efi)->dki_data, (dk_efi)->dki_length); \ 451 } 452 453 /* 454 * Copy the contents of dk_efi_t to the contents of vd_efi_t. 455 * Note that (dk_efi)->dki_data and (vd_efi)->data should be correctly 456 * initialized prior to using this macro. 457 */ 458 #define DK_EFI2VD_EFI(dk_efi, vd_efi) \ 459 { \ 460 (vd_efi)->lba = (dk_efi)->dki_lba; \ 461 (vd_efi)->length = (dk_efi)->dki_length; \ 462 bcopy((dk_efi)->dki_data, (vd_efi)->data, (vd_efi)->length); \ 463 } 464 465 #define VD_MEDIATYPE2DK_MEDIATYPE(mt) \ 466 ((mt) == VD_MEDIA_FIXED ? DK_FIXED_DISK : \ 467 (mt) == VD_MEDIA_CD ? DK_CDROM : \ 468 (mt) == VD_MEDIA_DVD ? DK_DVDROM : \ 469 DK_UNKNOWN) 470 471 #define DK_MEDIATYPE2VD_MEDIATYPE(mt) \ 472 ((mt) == DK_REMOVABLE_DISK ? VD_MEDIA_FIXED : \ 473 (mt) == DK_MO_ERASABLE ? VD_MEDIA_FIXED : \ 474 (mt) == DK_MO_WRITEONCE ? VD_MEDIA_FIXED : \ 475 (mt) == DK_AS_MO ? VD_MEDIA_FIXED : \ 476 (mt) == DK_CDROM ? VD_MEDIA_CD : \ 477 (mt) == DK_CDR ? VD_MEDIA_CD : \ 478 (mt) == DK_CDRW ? VD_MEDIA_CD : \ 479 (mt) == DK_DVDROM ? VD_MEDIA_DVD : \ 480 (mt) == DK_DVDR ? VD_MEDIA_DVD : \ 481 (mt) == DK_DVDRAM ? VD_MEDIA_DVD : \ 482 (mt) == DK_FIXED_DISK ? VD_MEDIA_FIXED : \ 483 (mt) == DK_FLOPPY ? VD_MEDIA_FIXED : \ 484 (mt) == DK_ZIP ? VD_MEDIA_FIXED : \ 485 (mt) == DK_JAZ ? VD_MEDIA_FIXED : \ 486 VD_MEDIA_FIXED) 487 488 /* 489 * Hooks for EFI support 490 */ 491 492 /* 493 * The EFI alloc_and_read() function will use some ioctls to get EFI data 494 * but the device reference we will use is different depending if the command 495 * is issued from the vDisk server side (vds) or from the vDisk client side 496 * (vdc). From the server side (vds), we will have a layered device reference 497 * (ldi_handle_t) while on the client side (vdc) we will have a regular device 498 * reference (dev_t). 499 */ 500 #ifdef _SUN4V_VDS 501 int vds_efi_alloc_and_read(ldi_handle_t dev, struct dk_gpt **vtoc, 502 size_t *vtoc_len); 503 #else 504 void vdc_efi_init(int (*func)(dev_t, int, caddr_t, int)); 505 void vdc_efi_fini(void); 506 int vdc_efi_alloc_and_read(dev_t dev, struct dk_gpt **vtoc, 507 size_t *vtoc_len); 508 #endif 509 510 void vd_efi_free(struct dk_gpt *ptr, size_t length); 511 void vd_efi_to_vtoc(struct dk_gpt *efi, struct vtoc *vtoc); 512 513 #ifdef __cplusplus 514 } 515 #endif 516 517 #endif /* _VDSK_COMMON_H */ 518