sys/contrib/openzfs/include/sys/vdev.h

   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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
  25  * Copyright (c) 2017, Intel Corporation.
  26  * Copyright (c) 2019, Datto Inc. All rights reserved.
  27  */
  28
  29 #ifndef _SYS_VDEV_H
  30 #define _SYS_VDEV_H
  31
  32 #include <sys/spa.h>
  33 #include <sys/zio.h>
  34 #include <sys/dmu.h>
  35 #include <sys/space_map.h>
  36 #include <sys/fs/zfs.h>
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 typedef enum vdev_dtl_type {
  43         DTL_MISSING,    /* 0% replication: no copies of the data */
  44         DTL_PARTIAL,    /* less than 100% replication: some copies missing */
  45         DTL_SCRUB,      /* unable to fully repair during scrub/resilver */
  46         DTL_OUTAGE,     /* temporarily missing (used to attempt detach) */
  47         DTL_TYPES
  48 } vdev_dtl_type_t;
  49
  50 extern int zfs_nocacheflush;
  51
  52 extern void vdev_dbgmsg(vdev_t *vd, const char *fmt, ...);
  53 extern void vdev_dbgmsg_print_tree(vdev_t *, int);
  54 extern int vdev_open(vdev_t *);
  55 extern void vdev_open_children(vdev_t *);
  56 extern int vdev_validate(vdev_t *);
  57 extern int vdev_copy_path_strict(vdev_t *, vdev_t *);
  58 extern void vdev_copy_path_relaxed(vdev_t *, vdev_t *);
  59 extern void vdev_close(vdev_t *);
  60 extern int vdev_create(vdev_t *, uint64_t txg, boolean_t isreplace);
  61 extern void vdev_reopen(vdev_t *);
  62 extern int vdev_validate_aux(vdev_t *vd);
  63 extern zio_t *vdev_probe(vdev_t *vd, zio_t *pio);
  64 extern boolean_t vdev_is_concrete(vdev_t *vd);
  65 extern boolean_t vdev_is_bootable(vdev_t *vd);
  66 extern vdev_t *vdev_lookup_top(spa_t *spa, uint64_t vdev);
  67 extern vdev_t *vdev_lookup_by_guid(vdev_t *vd, uint64_t guid);
  68 extern int vdev_count_leaves(spa_t *spa);
  69 extern void vdev_dtl_dirty(vdev_t *vd, vdev_dtl_type_t d,
  70     uint64_t txg, uint64_t size);
  71 extern boolean_t vdev_dtl_contains(vdev_t *vd, vdev_dtl_type_t d,
  72     uint64_t txg, uint64_t size);
  73 extern boolean_t vdev_dtl_empty(vdev_t *vd, vdev_dtl_type_t d);
  74 extern boolean_t vdev_dtl_need_resilver(vdev_t *vd, uint64_t off, size_t size);
  75 extern void vdev_dtl_reassess(vdev_t *vd, uint64_t txg, uint64_t scrub_txg,
  76     boolean_t scrub_done, boolean_t rebuild_done);
  77 extern boolean_t vdev_dtl_required(vdev_t *vd);
  78 extern boolean_t vdev_resilver_needed(vdev_t *vd,
  79     uint64_t *minp, uint64_t *maxp);
  80 extern void vdev_destroy_unlink_zap(vdev_t *vd, uint64_t zapobj,
  81     dmu_tx_t *tx);
  82 extern uint64_t vdev_create_link_zap(vdev_t *vd, dmu_tx_t *tx);
  83 extern void vdev_construct_zaps(vdev_t *vd, dmu_tx_t *tx);
  84 extern void vdev_destroy_spacemaps(vdev_t *vd, dmu_tx_t *tx);
  85 extern void vdev_indirect_mark_obsolete(vdev_t *vd, uint64_t offset,
  86     uint64_t size);
  87 extern void spa_vdev_indirect_mark_obsolete(spa_t *spa, uint64_t vdev,
  88     uint64_t offset, uint64_t size, dmu_tx_t *tx);
  89 extern boolean_t vdev_replace_in_progress(vdev_t *vdev);
  90
  91 extern void vdev_hold(vdev_t *);
  92 extern void vdev_rele(vdev_t *);
  93
  94 extern int vdev_metaslab_init(vdev_t *vd, uint64_t txg);
  95 extern void vdev_metaslab_fini(vdev_t *vd);
  96 extern void vdev_metaslab_set_size(vdev_t *);
  97 extern void vdev_expand(vdev_t *vd, uint64_t txg);
  98 extern void vdev_split(vdev_t *vd);
  99 extern void vdev_deadman(vdev_t *vd, char *tag);
 100 extern void vdev_xlate(vdev_t *vd, const range_seg64_t *logical_rs,
 101     range_seg64_t *physical_rs);
 102
 103 extern void vdev_get_stats_ex(vdev_t *vd, vdev_stat_t *vs, vdev_stat_ex_t *vsx);
 104 extern void vdev_get_stats(vdev_t *vd, vdev_stat_t *vs);
 105 extern void vdev_clear_stats(vdev_t *vd);
 106 extern void vdev_stat_update(zio_t *zio, uint64_t psize);
 107 extern void vdev_scan_stat_init(vdev_t *vd);
 108 extern void vdev_propagate_state(vdev_t *vd);
 109 extern void vdev_set_state(vdev_t *vd, boolean_t isopen, vdev_state_t state,
 110     vdev_aux_t aux);
 111 extern boolean_t vdev_children_are_offline(vdev_t *vd);
 112
 113 extern void vdev_space_update(vdev_t *vd,
 114     int64_t alloc_delta, int64_t defer_delta, int64_t space_delta);
 115
 116 extern int64_t vdev_deflated_space(vdev_t *vd, int64_t space);
 117
 118 extern uint64_t vdev_psize_to_asize(vdev_t *vd, uint64_t psize);
 119
 120 extern int vdev_fault(spa_t *spa, uint64_t guid, vdev_aux_t aux);
 121 extern int vdev_degrade(spa_t *spa, uint64_t guid, vdev_aux_t aux);
 122 extern int vdev_online(spa_t *spa, uint64_t guid, uint64_t flags,
 123     vdev_state_t *);
 124 extern int vdev_offline(spa_t *spa, uint64_t guid, uint64_t flags);
 125 extern void vdev_clear(spa_t *spa, vdev_t *vd);
 126
 127 extern boolean_t vdev_is_dead(vdev_t *vd);
 128 extern boolean_t vdev_readable(vdev_t *vd);
 129 extern boolean_t vdev_writeable(vdev_t *vd);
 130 extern boolean_t vdev_allocatable(vdev_t *vd);
 131 extern boolean_t vdev_accessible(vdev_t *vd, zio_t *zio);
 132 extern boolean_t vdev_is_spacemap_addressable(vdev_t *vd);
 133
 134 extern void vdev_cache_init(vdev_t *vd);
 135 extern void vdev_cache_fini(vdev_t *vd);
 136 extern boolean_t vdev_cache_read(zio_t *zio);
 137 extern void vdev_cache_write(zio_t *zio);
 138 extern void vdev_cache_purge(vdev_t *vd);
 139
 140 extern void vdev_queue_init(vdev_t *vd);
 141 extern void vdev_queue_fini(vdev_t *vd);
 142 extern zio_t *vdev_queue_io(zio_t *zio);
 143 extern void vdev_queue_io_done(zio_t *zio);
 144 extern void vdev_queue_change_io_priority(zio_t *zio, zio_priority_t priority);
 145
 146 extern int vdev_queue_length(vdev_t *vd);
 147 extern uint64_t vdev_queue_last_offset(vdev_t *vd);
 148
 149 extern void vdev_config_dirty(vdev_t *vd);
 150 extern void vdev_config_clean(vdev_t *vd);
 151 extern int vdev_config_sync(vdev_t **svd, int svdcount, uint64_t txg);
 152
 153 extern void vdev_state_dirty(vdev_t *vd);
 154 extern void vdev_state_clean(vdev_t *vd);
 155
 156 extern void vdev_defer_resilver(vdev_t *vd);
 157 extern boolean_t vdev_clear_resilver_deferred(vdev_t *vd, dmu_tx_t *tx);
 158
 159 typedef enum vdev_config_flag {
 160         VDEV_CONFIG_SPARE = 1 << 0,
 161         VDEV_CONFIG_L2CACHE = 1 << 1,
 162         VDEV_CONFIG_REMOVING = 1 << 2,
 163         VDEV_CONFIG_MOS = 1 << 3,
 164         VDEV_CONFIG_MISSING = 1 << 4
 165 } vdev_config_flag_t;
 166
 167 extern void vdev_top_config_generate(spa_t *spa, nvlist_t *config);
 168 extern nvlist_t *vdev_config_generate(spa_t *spa, vdev_t *vd,
 169     boolean_t getstats, vdev_config_flag_t flags);
 170
 171 /*
 172  * Label routines
 173  */
 174 struct uberblock;
 175 extern uint64_t vdev_label_offset(uint64_t psize, int l, uint64_t offset);
 176 extern int vdev_label_number(uint64_t psise, uint64_t offset);
 177 extern nvlist_t *vdev_label_read_config(vdev_t *vd, uint64_t txg);
 178 extern void vdev_uberblock_load(vdev_t *, struct uberblock *, nvlist_t **);
 179 extern void vdev_config_generate_stats(vdev_t *vd, nvlist_t *nv);
 180 extern void vdev_label_write(zio_t *zio, vdev_t *vd, int l, abd_t *buf, uint64_t
 181     offset, uint64_t size, zio_done_func_t *done, void *priv, int flags);
 182 extern int vdev_label_read_bootenv(vdev_t *, nvlist_t *);
 183 extern int vdev_label_write_bootenv(vdev_t *, nvlist_t *);
 184
 185 typedef enum {
 186         VDEV_LABEL_CREATE,      /* create/add a new device */
 187         VDEV_LABEL_REPLACE,     /* replace an existing device */
 188         VDEV_LABEL_SPARE,       /* add a new hot spare */
 189         VDEV_LABEL_REMOVE,      /* remove an existing device */
 190         VDEV_LABEL_L2CACHE,     /* add an L2ARC cache device */
 191         VDEV_LABEL_SPLIT        /* generating new label for split-off dev */
 192 } vdev_labeltype_t;
 193
 194 extern int vdev_label_init(vdev_t *vd, uint64_t txg, vdev_labeltype_t reason);
 195
 196 #ifdef  __cplusplus
 197 }
 198 #endif
 199
 200 #endif  /* _SYS_VDEV_H */