1ea8dc4b6Seschrock /* 2ea8dc4b6Seschrock * CDDL HEADER START 3ea8dc4b6Seschrock * 4ea8dc4b6Seschrock * The contents of this file are subject to the terms of the 5ea8dc4b6Seschrock * Common Development and Distribution License (the "License"). 6ea8dc4b6Seschrock * You may not use this file except in compliance with the License. 7ea8dc4b6Seschrock * 8ea8dc4b6Seschrock * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9ea8dc4b6Seschrock * or http://www.opensolaris.org/os/licensing. 10ea8dc4b6Seschrock * See the License for the specific language governing permissions 11ea8dc4b6Seschrock * and limitations under the License. 12ea8dc4b6Seschrock * 13ea8dc4b6Seschrock * When distributing Covered Code, include this CDDL HEADER in each 14ea8dc4b6Seschrock * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15ea8dc4b6Seschrock * If applicable, add the following below this CDDL HEADER, with the 16ea8dc4b6Seschrock * fields enclosed by brackets "[]" replaced with your own identifying 17ea8dc4b6Seschrock * information: Portions Copyright [yyyy] [name of copyright owner] 18ea8dc4b6Seschrock * 19ea8dc4b6Seschrock * CDDL HEADER END 20ea8dc4b6Seschrock */ 21ea8dc4b6Seschrock /* 22*21bf64a7Sgw * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23ea8dc4b6Seschrock * Use is subject to license terms. 24ea8dc4b6Seschrock */ 25ea8dc4b6Seschrock 26ea8dc4b6Seschrock #pragma ident "%Z%%M% %I% %E% SMI" 27ea8dc4b6Seschrock 28ea8dc4b6Seschrock /* 29ea8dc4b6Seschrock * ZFS fault injection 30ea8dc4b6Seschrock * 31ea8dc4b6Seschrock * To handle fault injection, we keep track of a series of zinject_record_t 32ea8dc4b6Seschrock * structures which describe which logical block(s) should be injected with a 33ea8dc4b6Seschrock * fault. These are kept in a global list. Each record corresponds to a given 34ea8dc4b6Seschrock * spa_t and maintains a special hold on the spa_t so that it cannot be deleted 35ea8dc4b6Seschrock * or exported while the injection record exists. 36ea8dc4b6Seschrock * 37ea8dc4b6Seschrock * Device level injection is done using the 'zi_guid' field. If this is set, it 38ea8dc4b6Seschrock * means that the error is destined for a particular device, not a piece of 39ea8dc4b6Seschrock * data. 40ea8dc4b6Seschrock * 41ea8dc4b6Seschrock * This is a rather poor data structure and algorithm, but we don't expect more 42ea8dc4b6Seschrock * than a few faults at any one time, so it should be sufficient for our needs. 43ea8dc4b6Seschrock */ 44ea8dc4b6Seschrock 45ea8dc4b6Seschrock #include <sys/arc.h> 46ea8dc4b6Seschrock #include <sys/zio_impl.h> 47ea8dc4b6Seschrock #include <sys/zfs_ioctl.h> 48ea8dc4b6Seschrock #include <sys/spa_impl.h> 49ea8dc4b6Seschrock #include <sys/vdev_impl.h> 50*21bf64a7Sgw #include <sys/fs/zfs.h> 51ea8dc4b6Seschrock 52ea8dc4b6Seschrock uint32_t zio_injection_enabled; 53ea8dc4b6Seschrock 54ea8dc4b6Seschrock typedef struct inject_handler { 55ea8dc4b6Seschrock int zi_id; 56ea8dc4b6Seschrock spa_t *zi_spa; 57ea8dc4b6Seschrock zinject_record_t zi_record; 58ea8dc4b6Seschrock list_node_t zi_link; 59ea8dc4b6Seschrock } inject_handler_t; 60ea8dc4b6Seschrock 61ea8dc4b6Seschrock static list_t inject_handlers; 62ea8dc4b6Seschrock static krwlock_t inject_lock; 63ea8dc4b6Seschrock static int inject_next_id = 1; 64ea8dc4b6Seschrock 65ea8dc4b6Seschrock /* 66ea8dc4b6Seschrock * Returns true if the given record matches the I/O in progress. 67ea8dc4b6Seschrock */ 68ea8dc4b6Seschrock static boolean_t 69ea8dc4b6Seschrock zio_match_handler(zbookmark_t *zb, uint64_t type, 70ea8dc4b6Seschrock zinject_record_t *record, int error) 71ea8dc4b6Seschrock { 72ea8dc4b6Seschrock /* 73ea8dc4b6Seschrock * Check for a match against the MOS, which is based on type 74ea8dc4b6Seschrock */ 75ea8dc4b6Seschrock if (zb->zb_objset == 0 && record->zi_objset == 0 && 76ea8dc4b6Seschrock record->zi_object == 0) { 77ea8dc4b6Seschrock if (record->zi_type == DMU_OT_NONE || 78ea8dc4b6Seschrock type == record->zi_type) 79ea8dc4b6Seschrock return (record->zi_freq == 0 || 80ea8dc4b6Seschrock spa_get_random(100) < record->zi_freq); 81ea8dc4b6Seschrock else 82ea8dc4b6Seschrock return (B_FALSE); 83ea8dc4b6Seschrock } 84ea8dc4b6Seschrock 85ea8dc4b6Seschrock /* 86ea8dc4b6Seschrock * Check for an exact match. 87ea8dc4b6Seschrock */ 88ea8dc4b6Seschrock if (zb->zb_objset == record->zi_objset && 89ea8dc4b6Seschrock zb->zb_object == record->zi_object && 90ea8dc4b6Seschrock zb->zb_level == record->zi_level && 91ea8dc4b6Seschrock zb->zb_blkid >= record->zi_start && 92ea8dc4b6Seschrock zb->zb_blkid <= record->zi_end && 93ea8dc4b6Seschrock error == record->zi_error) 94ea8dc4b6Seschrock return (record->zi_freq == 0 || 95ea8dc4b6Seschrock spa_get_random(100) < record->zi_freq); 96ea8dc4b6Seschrock 97ea8dc4b6Seschrock return (B_FALSE); 98ea8dc4b6Seschrock } 99ea8dc4b6Seschrock 100ea8dc4b6Seschrock /* 101ea8dc4b6Seschrock * Determine if the I/O in question should return failure. Returns the errno 102ea8dc4b6Seschrock * to be returned to the caller. 103ea8dc4b6Seschrock */ 104ea8dc4b6Seschrock int 105ea8dc4b6Seschrock zio_handle_fault_injection(zio_t *zio, int error) 106ea8dc4b6Seschrock { 107ea8dc4b6Seschrock int ret = 0; 108ea8dc4b6Seschrock inject_handler_t *handler; 109ea8dc4b6Seschrock 110ea8dc4b6Seschrock /* 111ea8dc4b6Seschrock * Ignore I/O not associated with any logical data. 112ea8dc4b6Seschrock */ 113ea8dc4b6Seschrock if (zio->io_logical == NULL) 114ea8dc4b6Seschrock return (0); 115ea8dc4b6Seschrock 116ea8dc4b6Seschrock /* 117ea8dc4b6Seschrock * Currently, we only support fault injection on reads. 118ea8dc4b6Seschrock */ 119ea8dc4b6Seschrock if (zio->io_type != ZIO_TYPE_READ) 120ea8dc4b6Seschrock return (0); 121ea8dc4b6Seschrock 122ea8dc4b6Seschrock rw_enter(&inject_lock, RW_READER); 123ea8dc4b6Seschrock 124ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 125ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) { 126ea8dc4b6Seschrock 127ea8dc4b6Seschrock /* Ignore errors not destined for this pool */ 128ea8dc4b6Seschrock if (zio->io_spa != handler->zi_spa) 129ea8dc4b6Seschrock continue; 130ea8dc4b6Seschrock 131ea8dc4b6Seschrock /* Ignore device errors */ 132ea8dc4b6Seschrock if (handler->zi_record.zi_guid != 0) 133ea8dc4b6Seschrock continue; 134ea8dc4b6Seschrock 135ea8dc4b6Seschrock /* If this handler matches, return EIO */ 136ea8dc4b6Seschrock if (zio_match_handler(&zio->io_logical->io_bookmark, 137ea8dc4b6Seschrock zio->io_bp ? BP_GET_TYPE(zio->io_bp) : DMU_OT_NONE, 138ea8dc4b6Seschrock &handler->zi_record, error)) { 139ea8dc4b6Seschrock ret = error; 140ea8dc4b6Seschrock break; 141ea8dc4b6Seschrock } 142ea8dc4b6Seschrock } 143ea8dc4b6Seschrock 144ea8dc4b6Seschrock rw_exit(&inject_lock); 145ea8dc4b6Seschrock 146ea8dc4b6Seschrock return (ret); 147ea8dc4b6Seschrock } 148ea8dc4b6Seschrock 149*21bf64a7Sgw /* 150*21bf64a7Sgw * Determine if the zio is part of a label update and has an injection 151*21bf64a7Sgw * handler associated with that portion of the label. Currently, we 152*21bf64a7Sgw * allow error injection in either the nvlist or the uberblock region of 153*21bf64a7Sgw * of the vdev label. 154*21bf64a7Sgw */ 155*21bf64a7Sgw int 156*21bf64a7Sgw zio_handle_label_injection(zio_t *zio, int error) 157*21bf64a7Sgw { 158*21bf64a7Sgw inject_handler_t *handler; 159*21bf64a7Sgw vdev_t *vd = zio->io_vd; 160*21bf64a7Sgw uint64_t offset = zio->io_offset; 161*21bf64a7Sgw int label; 162*21bf64a7Sgw int ret = 0; 163*21bf64a7Sgw 164*21bf64a7Sgw /* 165*21bf64a7Sgw * We only care about physical I/Os. 166*21bf64a7Sgw */ 167*21bf64a7Sgw if (!(zio->io_flags & ZIO_FLAG_PHYSICAL)) 168*21bf64a7Sgw return (0); 169*21bf64a7Sgw 170*21bf64a7Sgw if (offset + zio->io_size > VDEV_LABEL_START_SIZE && 171*21bf64a7Sgw offset < vd->vdev_psize - VDEV_LABEL_END_SIZE) 172*21bf64a7Sgw return (0); 173*21bf64a7Sgw 174*21bf64a7Sgw rw_enter(&inject_lock, RW_READER); 175*21bf64a7Sgw 176*21bf64a7Sgw for (handler = list_head(&inject_handlers); handler != NULL; 177*21bf64a7Sgw handler = list_next(&inject_handlers, handler)) { 178*21bf64a7Sgw uint64_t start = handler->zi_record.zi_start; 179*21bf64a7Sgw uint64_t end = handler->zi_record.zi_end; 180*21bf64a7Sgw 181*21bf64a7Sgw /* Ignore device only faults */ 182*21bf64a7Sgw if (handler->zi_record.zi_start == 0) 183*21bf64a7Sgw continue; 184*21bf64a7Sgw 185*21bf64a7Sgw /* 186*21bf64a7Sgw * The injection region is the relative offsets within a 187*21bf64a7Sgw * vdev label. We must determine the label which is being 188*21bf64a7Sgw * updated and adjust our region accordingly. 189*21bf64a7Sgw */ 190*21bf64a7Sgw label = vdev_label_number(vd->vdev_psize, offset); 191*21bf64a7Sgw start = vdev_label_offset(vd->vdev_psize, label, start); 192*21bf64a7Sgw end = vdev_label_offset(vd->vdev_psize, label, end); 193*21bf64a7Sgw 194*21bf64a7Sgw if (zio->io_vd->vdev_guid == handler->zi_record.zi_guid && 195*21bf64a7Sgw (offset >= start && offset <= end)) { 196*21bf64a7Sgw ret = error; 197*21bf64a7Sgw break; 198*21bf64a7Sgw } 199*21bf64a7Sgw } 200*21bf64a7Sgw rw_exit(&inject_lock); 201*21bf64a7Sgw return (ret); 202*21bf64a7Sgw } 203*21bf64a7Sgw 204*21bf64a7Sgw 205ea8dc4b6Seschrock int 206ea8dc4b6Seschrock zio_handle_device_injection(vdev_t *vd, int error) 207ea8dc4b6Seschrock { 208ea8dc4b6Seschrock inject_handler_t *handler; 209ea8dc4b6Seschrock int ret = 0; 210ea8dc4b6Seschrock 211ea8dc4b6Seschrock rw_enter(&inject_lock, RW_READER); 212ea8dc4b6Seschrock 213ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 214ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) { 215ea8dc4b6Seschrock 216*21bf64a7Sgw /* Ignore label specific faults */ 217*21bf64a7Sgw if (handler->zi_record.zi_start != 0) 218*21bf64a7Sgw continue; 219*21bf64a7Sgw 220ea8dc4b6Seschrock if (vd->vdev_guid == handler->zi_record.zi_guid) { 221ea8dc4b6Seschrock if (handler->zi_record.zi_error == error) { 222ea8dc4b6Seschrock /* 223ea8dc4b6Seschrock * For a failed open, pretend like the device 224ea8dc4b6Seschrock * has gone away. 225ea8dc4b6Seschrock */ 226ea8dc4b6Seschrock if (error == ENXIO) 227ea8dc4b6Seschrock vd->vdev_stat.vs_aux = 228ea8dc4b6Seschrock VDEV_AUX_OPEN_FAILED; 229ea8dc4b6Seschrock ret = error; 230ea8dc4b6Seschrock break; 231ea8dc4b6Seschrock } 232ea8dc4b6Seschrock if (handler->zi_record.zi_error == ENXIO) { 233ea8dc4b6Seschrock ret = EIO; 234ea8dc4b6Seschrock break; 235ea8dc4b6Seschrock } 236ea8dc4b6Seschrock } 237ea8dc4b6Seschrock } 238ea8dc4b6Seschrock 239ea8dc4b6Seschrock rw_exit(&inject_lock); 240ea8dc4b6Seschrock 241ea8dc4b6Seschrock return (ret); 242ea8dc4b6Seschrock } 243ea8dc4b6Seschrock 244ea8dc4b6Seschrock /* 245ea8dc4b6Seschrock * Create a new handler for the given record. We add it to the list, adding 246ea8dc4b6Seschrock * a reference to the spa_t in the process. We increment zio_injection_enabled, 247ea8dc4b6Seschrock * which is the switch to trigger all fault injection. 248ea8dc4b6Seschrock */ 249ea8dc4b6Seschrock int 250ea8dc4b6Seschrock zio_inject_fault(char *name, int flags, int *id, zinject_record_t *record) 251ea8dc4b6Seschrock { 252ea8dc4b6Seschrock inject_handler_t *handler; 253ea8dc4b6Seschrock int error; 254ea8dc4b6Seschrock spa_t *spa; 255ea8dc4b6Seschrock 256ea8dc4b6Seschrock /* 257ea8dc4b6Seschrock * If this is pool-wide metadata, make sure we unload the corresponding 258ea8dc4b6Seschrock * spa_t, so that the next attempt to load it will trigger the fault. 259ea8dc4b6Seschrock * We call spa_reset() to unload the pool appropriately. 260ea8dc4b6Seschrock */ 261ea8dc4b6Seschrock if (flags & ZINJECT_UNLOAD_SPA) 262ea8dc4b6Seschrock if ((error = spa_reset(name)) != 0) 263ea8dc4b6Seschrock return (error); 264ea8dc4b6Seschrock 265ea8dc4b6Seschrock if (!(flags & ZINJECT_NULL)) { 266ea8dc4b6Seschrock /* 267ea8dc4b6Seschrock * spa_inject_ref() will add an injection reference, which will 268ea8dc4b6Seschrock * prevent the pool from being removed from the namespace while 269ea8dc4b6Seschrock * still allowing it to be unloaded. 270ea8dc4b6Seschrock */ 271ea8dc4b6Seschrock if ((spa = spa_inject_addref(name)) == NULL) 272ea8dc4b6Seschrock return (ENOENT); 273ea8dc4b6Seschrock 274ea8dc4b6Seschrock handler = kmem_alloc(sizeof (inject_handler_t), KM_SLEEP); 275ea8dc4b6Seschrock 276ea8dc4b6Seschrock rw_enter(&inject_lock, RW_WRITER); 277ea8dc4b6Seschrock 278ea8dc4b6Seschrock *id = handler->zi_id = inject_next_id++; 279ea8dc4b6Seschrock handler->zi_spa = spa; 280ea8dc4b6Seschrock handler->zi_record = *record; 281ea8dc4b6Seschrock list_insert_tail(&inject_handlers, handler); 282ea8dc4b6Seschrock atomic_add_32(&zio_injection_enabled, 1); 283ea8dc4b6Seschrock 284ea8dc4b6Seschrock rw_exit(&inject_lock); 285ea8dc4b6Seschrock } 286ea8dc4b6Seschrock 287ea8dc4b6Seschrock /* 288ea8dc4b6Seschrock * Flush the ARC, so that any attempts to read this data will end up 289ea8dc4b6Seschrock * going to the ZIO layer. Note that this is a little overkill, but 290ea8dc4b6Seschrock * we don't have the necessary ARC interfaces to do anything else, and 291ea8dc4b6Seschrock * fault injection isn't a performance critical path. 292ea8dc4b6Seschrock */ 293ea8dc4b6Seschrock if (flags & ZINJECT_FLUSH_ARC) 294874395d5Smaybee arc_flush(NULL); 295ea8dc4b6Seschrock 296ea8dc4b6Seschrock return (0); 297ea8dc4b6Seschrock } 298ea8dc4b6Seschrock 299ea8dc4b6Seschrock /* 300ea8dc4b6Seschrock * Returns the next record with an ID greater than that supplied to the 301ea8dc4b6Seschrock * function. Used to iterate over all handlers in the system. 302ea8dc4b6Seschrock */ 303ea8dc4b6Seschrock int 304ea8dc4b6Seschrock zio_inject_list_next(int *id, char *name, size_t buflen, 305ea8dc4b6Seschrock zinject_record_t *record) 306ea8dc4b6Seschrock { 307ea8dc4b6Seschrock inject_handler_t *handler; 308ea8dc4b6Seschrock int ret; 309ea8dc4b6Seschrock 310ea8dc4b6Seschrock mutex_enter(&spa_namespace_lock); 311ea8dc4b6Seschrock rw_enter(&inject_lock, RW_READER); 312ea8dc4b6Seschrock 313ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 314ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) 315ea8dc4b6Seschrock if (handler->zi_id > *id) 316ea8dc4b6Seschrock break; 317ea8dc4b6Seschrock 318ea8dc4b6Seschrock if (handler) { 319ea8dc4b6Seschrock *record = handler->zi_record; 320ea8dc4b6Seschrock *id = handler->zi_id; 321ea8dc4b6Seschrock (void) strncpy(name, spa_name(handler->zi_spa), buflen); 322ea8dc4b6Seschrock ret = 0; 323ea8dc4b6Seschrock } else { 324ea8dc4b6Seschrock ret = ENOENT; 325ea8dc4b6Seschrock } 326ea8dc4b6Seschrock 327ea8dc4b6Seschrock rw_exit(&inject_lock); 328ea8dc4b6Seschrock mutex_exit(&spa_namespace_lock); 329ea8dc4b6Seschrock 330ea8dc4b6Seschrock return (ret); 331ea8dc4b6Seschrock } 332ea8dc4b6Seschrock 333ea8dc4b6Seschrock /* 334ea8dc4b6Seschrock * Clear the fault handler with the given identifier, or return ENOENT if none 335ea8dc4b6Seschrock * exists. 336ea8dc4b6Seschrock */ 337ea8dc4b6Seschrock int 338ea8dc4b6Seschrock zio_clear_fault(int id) 339ea8dc4b6Seschrock { 340ea8dc4b6Seschrock inject_handler_t *handler; 341ea8dc4b6Seschrock int ret; 342ea8dc4b6Seschrock 343ea8dc4b6Seschrock rw_enter(&inject_lock, RW_WRITER); 344ea8dc4b6Seschrock 345ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 346ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) 347ea8dc4b6Seschrock if (handler->zi_id == id) 348ea8dc4b6Seschrock break; 349ea8dc4b6Seschrock 350ea8dc4b6Seschrock if (handler == NULL) { 351ea8dc4b6Seschrock ret = ENOENT; 352ea8dc4b6Seschrock } else { 353ea8dc4b6Seschrock list_remove(&inject_handlers, handler); 354ea8dc4b6Seschrock spa_inject_delref(handler->zi_spa); 355ea8dc4b6Seschrock kmem_free(handler, sizeof (inject_handler_t)); 356ea8dc4b6Seschrock atomic_add_32(&zio_injection_enabled, -1); 357ea8dc4b6Seschrock ret = 0; 358ea8dc4b6Seschrock } 359ea8dc4b6Seschrock 360ea8dc4b6Seschrock rw_exit(&inject_lock); 361ea8dc4b6Seschrock 362ea8dc4b6Seschrock return (ret); 363ea8dc4b6Seschrock } 364ea8dc4b6Seschrock 365ea8dc4b6Seschrock void 366ea8dc4b6Seschrock zio_inject_init(void) 367ea8dc4b6Seschrock { 368ea8dc4b6Seschrock list_create(&inject_handlers, sizeof (inject_handler_t), 369ea8dc4b6Seschrock offsetof(inject_handler_t, zi_link)); 370ea8dc4b6Seschrock } 371ea8dc4b6Seschrock 372ea8dc4b6Seschrock void 373ea8dc4b6Seschrock zio_inject_fini(void) 374ea8dc4b6Seschrock { 375ea8dc4b6Seschrock list_destroy(&inject_handlers); 376ea8dc4b6Seschrock } 377