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 /* 228956713aSEric Schrock * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23ea8dc4b6Seschrock * Use is subject to license terms. 24ea8dc4b6Seschrock */ 25ea8dc4b6Seschrock 26ea8dc4b6Seschrock /* 27ea8dc4b6Seschrock * ZFS fault injection 28ea8dc4b6Seschrock * 29ea8dc4b6Seschrock * To handle fault injection, we keep track of a series of zinject_record_t 30ea8dc4b6Seschrock * structures which describe which logical block(s) should be injected with a 31ea8dc4b6Seschrock * fault. These are kept in a global list. Each record corresponds to a given 32ea8dc4b6Seschrock * spa_t and maintains a special hold on the spa_t so that it cannot be deleted 33ea8dc4b6Seschrock * or exported while the injection record exists. 34ea8dc4b6Seschrock * 35ea8dc4b6Seschrock * Device level injection is done using the 'zi_guid' field. If this is set, it 36ea8dc4b6Seschrock * means that the error is destined for a particular device, not a piece of 37ea8dc4b6Seschrock * data. 38ea8dc4b6Seschrock * 39ea8dc4b6Seschrock * This is a rather poor data structure and algorithm, but we don't expect more 40ea8dc4b6Seschrock * than a few faults at any one time, so it should be sufficient for our needs. 41ea8dc4b6Seschrock */ 42ea8dc4b6Seschrock 43ea8dc4b6Seschrock #include <sys/arc.h> 44ea8dc4b6Seschrock #include <sys/zio_impl.h> 45ea8dc4b6Seschrock #include <sys/zfs_ioctl.h> 46ea8dc4b6Seschrock #include <sys/spa_impl.h> 47ea8dc4b6Seschrock #include <sys/vdev_impl.h> 4821bf64a7Sgw #include <sys/fs/zfs.h> 49ea8dc4b6Seschrock 50ea8dc4b6Seschrock uint32_t zio_injection_enabled; 51ea8dc4b6Seschrock 52ea8dc4b6Seschrock typedef struct inject_handler { 53ea8dc4b6Seschrock int zi_id; 54ea8dc4b6Seschrock spa_t *zi_spa; 55ea8dc4b6Seschrock zinject_record_t zi_record; 56ea8dc4b6Seschrock list_node_t zi_link; 57ea8dc4b6Seschrock } inject_handler_t; 58ea8dc4b6Seschrock 59ea8dc4b6Seschrock static list_t inject_handlers; 60ea8dc4b6Seschrock static krwlock_t inject_lock; 61ea8dc4b6Seschrock static int inject_next_id = 1; 62ea8dc4b6Seschrock 63ea8dc4b6Seschrock /* 64ea8dc4b6Seschrock * Returns true if the given record matches the I/O in progress. 65ea8dc4b6Seschrock */ 66ea8dc4b6Seschrock static boolean_t 67ea8dc4b6Seschrock zio_match_handler(zbookmark_t *zb, uint64_t type, 68ea8dc4b6Seschrock zinject_record_t *record, int error) 69ea8dc4b6Seschrock { 70ea8dc4b6Seschrock /* 71ea8dc4b6Seschrock * Check for a match against the MOS, which is based on type 72ea8dc4b6Seschrock */ 73ea8dc4b6Seschrock if (zb->zb_objset == 0 && record->zi_objset == 0 && 74ea8dc4b6Seschrock record->zi_object == 0) { 75ea8dc4b6Seschrock if (record->zi_type == DMU_OT_NONE || 76ea8dc4b6Seschrock type == record->zi_type) 77ea8dc4b6Seschrock return (record->zi_freq == 0 || 78ea8dc4b6Seschrock spa_get_random(100) < record->zi_freq); 79ea8dc4b6Seschrock else 80ea8dc4b6Seschrock return (B_FALSE); 81ea8dc4b6Seschrock } 82ea8dc4b6Seschrock 83ea8dc4b6Seschrock /* 84ea8dc4b6Seschrock * Check for an exact match. 85ea8dc4b6Seschrock */ 86ea8dc4b6Seschrock if (zb->zb_objset == record->zi_objset && 87ea8dc4b6Seschrock zb->zb_object == record->zi_object && 88ea8dc4b6Seschrock zb->zb_level == record->zi_level && 89ea8dc4b6Seschrock zb->zb_blkid >= record->zi_start && 90ea8dc4b6Seschrock zb->zb_blkid <= record->zi_end && 91ea8dc4b6Seschrock error == record->zi_error) 92ea8dc4b6Seschrock return (record->zi_freq == 0 || 93ea8dc4b6Seschrock spa_get_random(100) < record->zi_freq); 94ea8dc4b6Seschrock 95ea8dc4b6Seschrock return (B_FALSE); 96ea8dc4b6Seschrock } 97ea8dc4b6Seschrock 98*88ecc943SGeorge Wilson /* 99*88ecc943SGeorge Wilson * Panic the system when a config change happens in the function 100*88ecc943SGeorge Wilson * specified by tag. 101*88ecc943SGeorge Wilson */ 102*88ecc943SGeorge Wilson void 103*88ecc943SGeorge Wilson zio_handle_panic_injection(spa_t *spa, char *tag) 104*88ecc943SGeorge Wilson { 105*88ecc943SGeorge Wilson inject_handler_t *handler; 106*88ecc943SGeorge Wilson 107*88ecc943SGeorge Wilson rw_enter(&inject_lock, RW_READER); 108*88ecc943SGeorge Wilson 109*88ecc943SGeorge Wilson for (handler = list_head(&inject_handlers); handler != NULL; 110*88ecc943SGeorge Wilson handler = list_next(&inject_handlers, handler)) { 111*88ecc943SGeorge Wilson 112*88ecc943SGeorge Wilson if (spa != handler->zi_spa) 113*88ecc943SGeorge Wilson continue; 114*88ecc943SGeorge Wilson 115*88ecc943SGeorge Wilson if (strcmp(tag, handler->zi_record.zi_func) == 0) 116*88ecc943SGeorge Wilson panic("Panic requested in function %s\n", tag); 117*88ecc943SGeorge Wilson } 118*88ecc943SGeorge Wilson 119*88ecc943SGeorge Wilson rw_exit(&inject_lock); 120*88ecc943SGeorge Wilson } 121*88ecc943SGeorge Wilson 122ea8dc4b6Seschrock /* 123ea8dc4b6Seschrock * Determine if the I/O in question should return failure. Returns the errno 124ea8dc4b6Seschrock * to be returned to the caller. 125ea8dc4b6Seschrock */ 126ea8dc4b6Seschrock int 127ea8dc4b6Seschrock zio_handle_fault_injection(zio_t *zio, int error) 128ea8dc4b6Seschrock { 129ea8dc4b6Seschrock int ret = 0; 130ea8dc4b6Seschrock inject_handler_t *handler; 131ea8dc4b6Seschrock 132ea8dc4b6Seschrock /* 133ea8dc4b6Seschrock * Ignore I/O not associated with any logical data. 134ea8dc4b6Seschrock */ 135ea8dc4b6Seschrock if (zio->io_logical == NULL) 136ea8dc4b6Seschrock return (0); 137ea8dc4b6Seschrock 138ea8dc4b6Seschrock /* 139ea8dc4b6Seschrock * Currently, we only support fault injection on reads. 140ea8dc4b6Seschrock */ 141ea8dc4b6Seschrock if (zio->io_type != ZIO_TYPE_READ) 142ea8dc4b6Seschrock return (0); 143ea8dc4b6Seschrock 144ea8dc4b6Seschrock rw_enter(&inject_lock, RW_READER); 145ea8dc4b6Seschrock 146ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 147ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) { 148ea8dc4b6Seschrock 149ea8dc4b6Seschrock /* Ignore errors not destined for this pool */ 150ea8dc4b6Seschrock if (zio->io_spa != handler->zi_spa) 151ea8dc4b6Seschrock continue; 152ea8dc4b6Seschrock 153*88ecc943SGeorge Wilson /* Ignore device errors and panic injection */ 154*88ecc943SGeorge Wilson if (handler->zi_record.zi_guid != 0 || 155*88ecc943SGeorge Wilson handler->zi_record.zi_func[0] != '\0') 156ea8dc4b6Seschrock continue; 157ea8dc4b6Seschrock 158ea8dc4b6Seschrock /* If this handler matches, return EIO */ 159ea8dc4b6Seschrock if (zio_match_handler(&zio->io_logical->io_bookmark, 160ea8dc4b6Seschrock zio->io_bp ? BP_GET_TYPE(zio->io_bp) : DMU_OT_NONE, 161ea8dc4b6Seschrock &handler->zi_record, error)) { 162ea8dc4b6Seschrock ret = error; 163ea8dc4b6Seschrock break; 164ea8dc4b6Seschrock } 165ea8dc4b6Seschrock } 166ea8dc4b6Seschrock 167ea8dc4b6Seschrock rw_exit(&inject_lock); 168ea8dc4b6Seschrock 169ea8dc4b6Seschrock return (ret); 170ea8dc4b6Seschrock } 171ea8dc4b6Seschrock 17221bf64a7Sgw /* 17321bf64a7Sgw * Determine if the zio is part of a label update and has an injection 17421bf64a7Sgw * handler associated with that portion of the label. Currently, we 17521bf64a7Sgw * allow error injection in either the nvlist or the uberblock region of 17621bf64a7Sgw * of the vdev label. 17721bf64a7Sgw */ 17821bf64a7Sgw int 17921bf64a7Sgw zio_handle_label_injection(zio_t *zio, int error) 18021bf64a7Sgw { 18121bf64a7Sgw inject_handler_t *handler; 18221bf64a7Sgw vdev_t *vd = zio->io_vd; 18321bf64a7Sgw uint64_t offset = zio->io_offset; 18421bf64a7Sgw int label; 18521bf64a7Sgw int ret = 0; 18621bf64a7Sgw 18721bf64a7Sgw if (offset + zio->io_size > VDEV_LABEL_START_SIZE && 18821bf64a7Sgw offset < vd->vdev_psize - VDEV_LABEL_END_SIZE) 18921bf64a7Sgw return (0); 19021bf64a7Sgw 19121bf64a7Sgw rw_enter(&inject_lock, RW_READER); 19221bf64a7Sgw 19321bf64a7Sgw for (handler = list_head(&inject_handlers); handler != NULL; 19421bf64a7Sgw handler = list_next(&inject_handlers, handler)) { 19521bf64a7Sgw uint64_t start = handler->zi_record.zi_start; 19621bf64a7Sgw uint64_t end = handler->zi_record.zi_end; 19721bf64a7Sgw 198*88ecc943SGeorge Wilson /* Ignore device only faults or panic injection */ 199*88ecc943SGeorge Wilson if (handler->zi_record.zi_start == 0 || 200*88ecc943SGeorge Wilson handler->zi_record.zi_func[0] != '\0') 20121bf64a7Sgw continue; 20221bf64a7Sgw 20321bf64a7Sgw /* 20421bf64a7Sgw * The injection region is the relative offsets within a 20521bf64a7Sgw * vdev label. We must determine the label which is being 20621bf64a7Sgw * updated and adjust our region accordingly. 20721bf64a7Sgw */ 20821bf64a7Sgw label = vdev_label_number(vd->vdev_psize, offset); 20921bf64a7Sgw start = vdev_label_offset(vd->vdev_psize, label, start); 21021bf64a7Sgw end = vdev_label_offset(vd->vdev_psize, label, end); 21121bf64a7Sgw 21221bf64a7Sgw if (zio->io_vd->vdev_guid == handler->zi_record.zi_guid && 21321bf64a7Sgw (offset >= start && offset <= end)) { 21421bf64a7Sgw ret = error; 21521bf64a7Sgw break; 21621bf64a7Sgw } 21721bf64a7Sgw } 21821bf64a7Sgw rw_exit(&inject_lock); 21921bf64a7Sgw return (ret); 22021bf64a7Sgw } 22121bf64a7Sgw 22221bf64a7Sgw 223ea8dc4b6Seschrock int 2248956713aSEric Schrock zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error) 225ea8dc4b6Seschrock { 226ea8dc4b6Seschrock inject_handler_t *handler; 227ea8dc4b6Seschrock int ret = 0; 228ea8dc4b6Seschrock 229ea8dc4b6Seschrock rw_enter(&inject_lock, RW_READER); 230ea8dc4b6Seschrock 231ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 232ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) { 233ea8dc4b6Seschrock 234*88ecc943SGeorge Wilson /* Ignore label specific faults or panic injection */ 235*88ecc943SGeorge Wilson if (handler->zi_record.zi_start != 0 || 236*88ecc943SGeorge Wilson handler->zi_record.zi_func[0] != '\0') 23721bf64a7Sgw continue; 23821bf64a7Sgw 239ea8dc4b6Seschrock if (vd->vdev_guid == handler->zi_record.zi_guid) { 2408956713aSEric Schrock if (handler->zi_record.zi_failfast && 2418956713aSEric Schrock (zio == NULL || (zio->io_flags & 2428956713aSEric Schrock (ZIO_FLAG_IO_RETRY | ZIO_FLAG_TRYHARD)))) { 2438956713aSEric Schrock continue; 2448956713aSEric Schrock } 2458956713aSEric Schrock 246ea8dc4b6Seschrock if (handler->zi_record.zi_error == error) { 247ea8dc4b6Seschrock /* 248ea8dc4b6Seschrock * For a failed open, pretend like the device 249ea8dc4b6Seschrock * has gone away. 250ea8dc4b6Seschrock */ 251ea8dc4b6Seschrock if (error == ENXIO) 252ea8dc4b6Seschrock vd->vdev_stat.vs_aux = 253ea8dc4b6Seschrock VDEV_AUX_OPEN_FAILED; 254ea8dc4b6Seschrock ret = error; 255ea8dc4b6Seschrock break; 256ea8dc4b6Seschrock } 257ea8dc4b6Seschrock if (handler->zi_record.zi_error == ENXIO) { 258ea8dc4b6Seschrock ret = EIO; 259ea8dc4b6Seschrock break; 260ea8dc4b6Seschrock } 261ea8dc4b6Seschrock } 262ea8dc4b6Seschrock } 263ea8dc4b6Seschrock 264ea8dc4b6Seschrock rw_exit(&inject_lock); 265ea8dc4b6Seschrock 266ea8dc4b6Seschrock return (ret); 267ea8dc4b6Seschrock } 268ea8dc4b6Seschrock 269ea8dc4b6Seschrock /* 270ea8dc4b6Seschrock * Create a new handler for the given record. We add it to the list, adding 271ea8dc4b6Seschrock * a reference to the spa_t in the process. We increment zio_injection_enabled, 272ea8dc4b6Seschrock * which is the switch to trigger all fault injection. 273ea8dc4b6Seschrock */ 274ea8dc4b6Seschrock int 275ea8dc4b6Seschrock zio_inject_fault(char *name, int flags, int *id, zinject_record_t *record) 276ea8dc4b6Seschrock { 277ea8dc4b6Seschrock inject_handler_t *handler; 278ea8dc4b6Seschrock int error; 279ea8dc4b6Seschrock spa_t *spa; 280ea8dc4b6Seschrock 281ea8dc4b6Seschrock /* 282ea8dc4b6Seschrock * If this is pool-wide metadata, make sure we unload the corresponding 283ea8dc4b6Seschrock * spa_t, so that the next attempt to load it will trigger the fault. 284ea8dc4b6Seschrock * We call spa_reset() to unload the pool appropriately. 285ea8dc4b6Seschrock */ 286ea8dc4b6Seschrock if (flags & ZINJECT_UNLOAD_SPA) 287ea8dc4b6Seschrock if ((error = spa_reset(name)) != 0) 288ea8dc4b6Seschrock return (error); 289ea8dc4b6Seschrock 290ea8dc4b6Seschrock if (!(flags & ZINJECT_NULL)) { 291ea8dc4b6Seschrock /* 292ea8dc4b6Seschrock * spa_inject_ref() will add an injection reference, which will 293ea8dc4b6Seschrock * prevent the pool from being removed from the namespace while 294ea8dc4b6Seschrock * still allowing it to be unloaded. 295ea8dc4b6Seschrock */ 296ea8dc4b6Seschrock if ((spa = spa_inject_addref(name)) == NULL) 297ea8dc4b6Seschrock return (ENOENT); 298ea8dc4b6Seschrock 299ea8dc4b6Seschrock handler = kmem_alloc(sizeof (inject_handler_t), KM_SLEEP); 300ea8dc4b6Seschrock 301ea8dc4b6Seschrock rw_enter(&inject_lock, RW_WRITER); 302ea8dc4b6Seschrock 303ea8dc4b6Seschrock *id = handler->zi_id = inject_next_id++; 304ea8dc4b6Seschrock handler->zi_spa = spa; 305ea8dc4b6Seschrock handler->zi_record = *record; 306ea8dc4b6Seschrock list_insert_tail(&inject_handlers, handler); 307ea8dc4b6Seschrock atomic_add_32(&zio_injection_enabled, 1); 308ea8dc4b6Seschrock 309ea8dc4b6Seschrock rw_exit(&inject_lock); 310ea8dc4b6Seschrock } 311ea8dc4b6Seschrock 312ea8dc4b6Seschrock /* 313ea8dc4b6Seschrock * Flush the ARC, so that any attempts to read this data will end up 314ea8dc4b6Seschrock * going to the ZIO layer. Note that this is a little overkill, but 315ea8dc4b6Seschrock * we don't have the necessary ARC interfaces to do anything else, and 316ea8dc4b6Seschrock * fault injection isn't a performance critical path. 317ea8dc4b6Seschrock */ 318ea8dc4b6Seschrock if (flags & ZINJECT_FLUSH_ARC) 319874395d5Smaybee arc_flush(NULL); 320ea8dc4b6Seschrock 321ea8dc4b6Seschrock return (0); 322ea8dc4b6Seschrock } 323ea8dc4b6Seschrock 324ea8dc4b6Seschrock /* 325ea8dc4b6Seschrock * Returns the next record with an ID greater than that supplied to the 326ea8dc4b6Seschrock * function. Used to iterate over all handlers in the system. 327ea8dc4b6Seschrock */ 328ea8dc4b6Seschrock int 329ea8dc4b6Seschrock zio_inject_list_next(int *id, char *name, size_t buflen, 330ea8dc4b6Seschrock zinject_record_t *record) 331ea8dc4b6Seschrock { 332ea8dc4b6Seschrock inject_handler_t *handler; 333ea8dc4b6Seschrock int ret; 334ea8dc4b6Seschrock 335ea8dc4b6Seschrock mutex_enter(&spa_namespace_lock); 336ea8dc4b6Seschrock rw_enter(&inject_lock, RW_READER); 337ea8dc4b6Seschrock 338ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 339ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) 340ea8dc4b6Seschrock if (handler->zi_id > *id) 341ea8dc4b6Seschrock break; 342ea8dc4b6Seschrock 343ea8dc4b6Seschrock if (handler) { 344ea8dc4b6Seschrock *record = handler->zi_record; 345ea8dc4b6Seschrock *id = handler->zi_id; 346ea8dc4b6Seschrock (void) strncpy(name, spa_name(handler->zi_spa), buflen); 347ea8dc4b6Seschrock ret = 0; 348ea8dc4b6Seschrock } else { 349ea8dc4b6Seschrock ret = ENOENT; 350ea8dc4b6Seschrock } 351ea8dc4b6Seschrock 352ea8dc4b6Seschrock rw_exit(&inject_lock); 353ea8dc4b6Seschrock mutex_exit(&spa_namespace_lock); 354ea8dc4b6Seschrock 355ea8dc4b6Seschrock return (ret); 356ea8dc4b6Seschrock } 357ea8dc4b6Seschrock 358ea8dc4b6Seschrock /* 359ea8dc4b6Seschrock * Clear the fault handler with the given identifier, or return ENOENT if none 360ea8dc4b6Seschrock * exists. 361ea8dc4b6Seschrock */ 362ea8dc4b6Seschrock int 363ea8dc4b6Seschrock zio_clear_fault(int id) 364ea8dc4b6Seschrock { 365ea8dc4b6Seschrock inject_handler_t *handler; 366ea8dc4b6Seschrock int ret; 367ea8dc4b6Seschrock 368ea8dc4b6Seschrock rw_enter(&inject_lock, RW_WRITER); 369ea8dc4b6Seschrock 370ea8dc4b6Seschrock for (handler = list_head(&inject_handlers); handler != NULL; 371ea8dc4b6Seschrock handler = list_next(&inject_handlers, handler)) 372ea8dc4b6Seschrock if (handler->zi_id == id) 373ea8dc4b6Seschrock break; 374ea8dc4b6Seschrock 375ea8dc4b6Seschrock if (handler == NULL) { 376ea8dc4b6Seschrock ret = ENOENT; 377ea8dc4b6Seschrock } else { 378ea8dc4b6Seschrock list_remove(&inject_handlers, handler); 379ea8dc4b6Seschrock spa_inject_delref(handler->zi_spa); 380ea8dc4b6Seschrock kmem_free(handler, sizeof (inject_handler_t)); 381ea8dc4b6Seschrock atomic_add_32(&zio_injection_enabled, -1); 382ea8dc4b6Seschrock ret = 0; 383ea8dc4b6Seschrock } 384ea8dc4b6Seschrock 385ea8dc4b6Seschrock rw_exit(&inject_lock); 386ea8dc4b6Seschrock 387ea8dc4b6Seschrock return (ret); 388ea8dc4b6Seschrock } 389ea8dc4b6Seschrock 390ea8dc4b6Seschrock void 391ea8dc4b6Seschrock zio_inject_init(void) 392ea8dc4b6Seschrock { 3939b3f6b42SEric Kustarz rw_init(&inject_lock, NULL, RW_DEFAULT, NULL); 394ea8dc4b6Seschrock list_create(&inject_handlers, sizeof (inject_handler_t), 395ea8dc4b6Seschrock offsetof(inject_handler_t, zi_link)); 396ea8dc4b6Seschrock } 397ea8dc4b6Seschrock 398ea8dc4b6Seschrock void 399ea8dc4b6Seschrock zio_inject_fini(void) 400ea8dc4b6Seschrock { 401ea8dc4b6Seschrock list_destroy(&inject_handlers); 4029b3f6b42SEric Kustarz rw_destroy(&inject_lock); 403ea8dc4b6Seschrock } 404