include/sys/spa_impl.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  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
  24  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
  25  * Copyright (c) 2014 Spectra Logic Corporation, All rights reserved.
  26  * Copyright 2013 Saso Kiselkov. All rights reserved.
  27  * Copyright (c) 2016 Actifio, Inc. All rights reserved.
  28  * Copyright (c) 2017 Datto Inc.
  29  */
  30
  31 #ifndef _SYS_SPA_IMPL_H
  32 #define _SYS_SPA_IMPL_H
  33
  34 #include <sys/spa.h>
  35 #include <sys/vdev.h>
  36 #include <sys/vdev_removal.h>
  37 #include <sys/metaslab.h>
  38 #include <sys/dmu.h>
  39 #include <sys/dsl_pool.h>
  40 #include <sys/uberblock_impl.h>
  41 #include <sys/zfs_context.h>
  42 #include <sys/avl.h>
  43 #include <sys/refcount.h>
  44 #include <sys/bplist.h>
  45 #include <sys/bpobj.h>
  46 #include <sys/dsl_crypt.h>
  47 #include <sys/zfeature.h>
  48 #include <sys/zthr.h>
  49 #include <zfeature_common.h>
  50
  51 #ifdef  __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 typedef struct spa_error_entry {
  56         zbookmark_phys_t        se_bookmark;
  57         char                    *se_name;
  58         avl_node_t              se_avl;
  59 } spa_error_entry_t;
  60
  61 typedef struct spa_history_phys {
  62         uint64_t sh_pool_create_len;    /* ending offset of zpool create */
  63         uint64_t sh_phys_max_off;       /* physical EOF */
  64         uint64_t sh_bof;                /* logical BOF */
  65         uint64_t sh_eof;                /* logical EOF */
  66         uint64_t sh_records_lost;       /* num of records overwritten */
  67 } spa_history_phys_t;
  68
  69 /*
  70  * All members must be uint64_t, for byteswap purposes.
  71  */
  72 typedef struct spa_removing_phys {
  73         uint64_t sr_state; /* dsl_scan_state_t */
  74
  75         /*
  76          * The vdev ID that we most recently attempted to remove,
  77          * or -1 if no removal has been attempted.
  78          */
  79         uint64_t sr_removing_vdev;
  80
  81         /*
  82          * The vdev ID that we most recently successfully removed,
  83          * or -1 if no devices have been removed.
  84          */
  85         uint64_t sr_prev_indirect_vdev;
  86
  87         uint64_t sr_start_time;
  88         uint64_t sr_end_time;
  89
  90         /*
  91          * Note that we can not use the space map's or indirect mapping's
  92          * accounting as a substitute for these values, because we need to
  93          * count frees of not-yet-copied data as though it did the copy.
  94          * Otherwise, we could get into a situation where copied > to_copy,
  95          * or we complete before copied == to_copy.
  96          */
  97         uint64_t sr_to_copy; /* bytes that need to be copied */
  98         uint64_t sr_copied; /* bytes that have been copied or freed */
  99 } spa_removing_phys_t;
 100
 101 /*
 102  * This struct is stored as an entry in the DMU_POOL_DIRECTORY_OBJECT
 103  * (with key DMU_POOL_CONDENSING_INDIRECT).  It is present if a condense
 104  * of an indirect vdev's mapping object is in progress.
 105  */
 106 typedef struct spa_condensing_indirect_phys {
 107         /*
 108          * The vdev ID of the indirect vdev whose indirect mapping is
 109          * being condensed.
 110          */
 111         uint64_t        scip_vdev;
 112
 113         /*
 114          * The vdev's old obsolete spacemap.  This spacemap's contents are
 115          * being integrated into the new mapping.
 116          */
 117         uint64_t        scip_prev_obsolete_sm_object;
 118
 119         /*
 120          * The new mapping object that is being created.
 121          */
 122         uint64_t        scip_next_mapping_object;
 123 } spa_condensing_indirect_phys_t;
 124
 125 struct spa_aux_vdev {
 126         uint64_t        sav_object;             /* MOS object for device list */
 127         nvlist_t        *sav_config;            /* cached device config */
 128         vdev_t          **sav_vdevs;            /* devices */
 129         int             sav_count;              /* number devices */
 130         boolean_t       sav_sync;               /* sync the device list */
 131         nvlist_t        **sav_pending;          /* pending device additions */
 132         uint_t          sav_npending;           /* # pending devices */
 133 };
 134
 135 typedef struct spa_config_lock {
 136         kmutex_t        scl_lock;
 137         kthread_t       *scl_writer;
 138         int             scl_write_wanted;
 139         kcondvar_t      scl_cv;
 140         refcount_t      scl_count;
 141 } spa_config_lock_t;
 142
 143 typedef struct spa_config_dirent {
 144         list_node_t     scd_link;
 145         char            *scd_path;
 146 } spa_config_dirent_t;
 147
 148 typedef enum zio_taskq_type {
 149         ZIO_TASKQ_ISSUE = 0,
 150         ZIO_TASKQ_ISSUE_HIGH,
 151         ZIO_TASKQ_INTERRUPT,
 152         ZIO_TASKQ_INTERRUPT_HIGH,
 153         ZIO_TASKQ_TYPES
 154 } zio_taskq_type_t;
 155
 156 /*
 157  * State machine for the zpool-poolname process.  The states transitions
 158  * are done as follows:
 159  *
 160  *      From               To                   Routine
 161  *      PROC_NONE       -> PROC_CREATED         spa_activate()
 162  *      PROC_CREATED    -> PROC_ACTIVE          spa_thread()
 163  *      PROC_ACTIVE     -> PROC_DEACTIVATE      spa_deactivate()
 164  *      PROC_DEACTIVATE -> PROC_GONE            spa_thread()
 165  *      PROC_GONE       -> PROC_NONE            spa_deactivate()
 166  */
 167 typedef enum spa_proc_state {
 168         SPA_PROC_NONE,          /* spa_proc = &p0, no process created */
 169         SPA_PROC_CREATED,       /* spa_activate() has proc, is waiting */
 170         SPA_PROC_ACTIVE,        /* taskqs created, spa_proc set */
 171         SPA_PROC_DEACTIVATE,    /* spa_deactivate() requests process exit */
 172         SPA_PROC_GONE           /* spa_thread() is exiting, spa_proc = &p0 */
 173 } spa_proc_state_t;
 174
 175 typedef struct spa_taskqs {
 176         uint_t stqs_count;
 177         taskq_t **stqs_taskq;
 178 } spa_taskqs_t;
 179
 180 typedef enum spa_all_vdev_zap_action {
 181         AVZ_ACTION_NONE = 0,
 182         AVZ_ACTION_DESTROY,     /* Destroy all per-vdev ZAPs and the AVZ. */
 183         AVZ_ACTION_REBUILD,     /* Populate the new AVZ, see spa_avz_rebuild */
 184         AVZ_ACTION_INITIALIZE
 185 } spa_avz_action_t;
 186
 187 typedef enum spa_config_source {
 188         SPA_CONFIG_SRC_NONE = 0,
 189         SPA_CONFIG_SRC_SCAN,            /* scan of path (default: /dev/dsk) */
 190         SPA_CONFIG_SRC_CACHEFILE,       /* any cachefile */
 191         SPA_CONFIG_SRC_TRYIMPORT,       /* returned from call to tryimport */
 192         SPA_CONFIG_SRC_SPLIT,           /* new pool in a pool split */
 193         SPA_CONFIG_SRC_MOS              /* MOS, but not always from right txg */
 194 } spa_config_source_t;
 195
 196 struct spa {
 197         /*
 198          * Fields protected by spa_namespace_lock.
 199          */
 200         char            spa_name[ZFS_MAX_DATASET_NAME_LEN];     /* pool name */
 201         char            *spa_comment;           /* comment */
 202         avl_node_t      spa_avl;                /* node in spa_namespace_avl */
 203         nvlist_t        *spa_config;            /* last synced config */
 204         nvlist_t        *spa_config_syncing;    /* currently syncing config */
 205         nvlist_t        *spa_config_splitting;  /* config for splitting */
 206         nvlist_t        *spa_load_info;         /* info and errors from load */
 207         uint64_t        spa_config_txg;         /* txg of last config change */
 208         int             spa_sync_pass;          /* iterate-to-convergence */
 209         pool_state_t    spa_state;              /* pool state */
 210         int             spa_inject_ref;         /* injection references */
 211         uint8_t         spa_sync_on;            /* sync threads are running */
 212         spa_load_state_t spa_load_state;        /* current load operation */
 213         boolean_t       spa_indirect_vdevs_loaded; /* mappings loaded? */
 214         boolean_t       spa_trust_config;       /* do we trust vdev tree? */
 215         spa_config_source_t spa_config_source;  /* where config comes from? */
 216         uint64_t        spa_import_flags;       /* import specific flags */
 217         spa_taskqs_t    spa_zio_taskq[ZIO_TYPES][ZIO_TASKQ_TYPES];
 218         dsl_pool_t      *spa_dsl_pool;
 219         boolean_t       spa_is_initializing;    /* true while opening pool */
 220         metaslab_class_t *spa_normal_class;     /* normal data class */
 221         metaslab_class_t *spa_log_class;        /* intent log data class */
 222         uint64_t        spa_first_txg;          /* first txg after spa_open() */
 223         uint64_t        spa_final_txg;          /* txg of export/destroy */
 224         uint64_t        spa_freeze_txg;         /* freeze pool at this txg */
 225         uint64_t        spa_load_max_txg;       /* best initial ub_txg */
 226         uint64_t        spa_claim_max_txg;      /* highest claimed birth txg */
 227         timespec_t      spa_loaded_ts;          /* 1st successful open time */
 228         objset_t        *spa_meta_objset;       /* copy of dp->dp_meta_objset */
 229         kmutex_t        spa_evicting_os_lock;   /* Evicting objset list lock */
 230         list_t          spa_evicting_os_list;   /* Objsets being evicted. */
 231         kcondvar_t      spa_evicting_os_cv;     /* Objset Eviction Completion */
 232         txg_list_t      spa_vdev_txg_list;      /* per-txg dirty vdev list */
 233         vdev_t          *spa_root_vdev;         /* top-level vdev container */
 234         int             spa_min_ashift;         /* of vdevs in normal class */
 235         int             spa_max_ashift;         /* of vdevs in normal class */
 236         uint64_t        spa_config_guid;        /* config pool guid */
 237         uint64_t        spa_load_guid;          /* spa_load initialized guid */
 238         uint64_t        spa_last_synced_guid;   /* last synced guid */
 239         list_t          spa_config_dirty_list;  /* vdevs with dirty config */
 240         list_t          spa_state_dirty_list;   /* vdevs with dirty state */
 241         kmutex_t        spa_alloc_lock;
 242         avl_tree_t      spa_alloc_tree;
 243         spa_aux_vdev_t  spa_spares;             /* hot spares */
 244         spa_aux_vdev_t  spa_l2cache;            /* L2ARC cache devices */
 245         nvlist_t        *spa_label_features;    /* Features for reading MOS */
 246         uint64_t        spa_config_object;      /* MOS object for pool config */
 247         uint64_t        spa_config_generation;  /* config generation number */
 248         uint64_t        spa_syncing_txg;        /* txg currently syncing */
 249         bpobj_t         spa_deferred_bpobj;     /* deferred-free bplist */
 250         bplist_t        spa_free_bplist[TXG_SIZE]; /* bplist of stuff to free */
 251         zio_cksum_salt_t spa_cksum_salt;        /* secret salt for cksum */
 252         /* checksum context templates */
 253         kmutex_t        spa_cksum_tmpls_lock;
 254         void            *spa_cksum_tmpls[ZIO_CHECKSUM_FUNCTIONS];
 255         uberblock_t     spa_ubsync;             /* last synced uberblock */
 256         uberblock_t     spa_uberblock;          /* current uberblock */
 257         boolean_t       spa_extreme_rewind;     /* rewind past deferred frees */
 258         kmutex_t        spa_scrub_lock;         /* resilver/scrub lock */
 259         uint64_t        spa_scrub_inflight;     /* in-flight scrub bytes */
 260         uint64_t        spa_load_verify_ios;    /* in-flight verification IOs */
 261         kcondvar_t      spa_scrub_io_cv;        /* scrub I/O completion */
 262         uint8_t         spa_scrub_active;       /* active or suspended? */
 263         uint8_t         spa_scrub_type;         /* type of scrub we're doing */
 264         uint8_t         spa_scrub_finished;     /* indicator to rotate logs */
 265         uint8_t         spa_scrub_started;      /* started since last boot */
 266         uint8_t         spa_scrub_reopen;       /* scrub doing vdev_reopen */
 267         uint64_t        spa_scan_pass_start;    /* start time per pass/reboot */
 268         uint64_t        spa_scan_pass_scrub_pause; /* scrub pause time */
 269         uint64_t        spa_scan_pass_scrub_spent_paused; /* total paused */
 270         uint64_t        spa_scan_pass_exam;     /* examined bytes per pass */
 271         uint64_t        spa_scan_pass_issued;   /* issued bytes per pass */
 272         kmutex_t        spa_async_lock;         /* protect async state */
 273         kthread_t       *spa_async_thread;      /* thread doing async task */
 274         int             spa_async_suspended;    /* async tasks suspended */
 275         kcondvar_t      spa_async_cv;           /* wait for thread_exit() */
 276         uint16_t        spa_async_tasks;        /* async task mask */
 277         uint64_t        spa_missing_tvds;       /* unopenable tvds on load */
 278         uint64_t        spa_missing_tvds_allowed; /* allow loading spa? */
 279
 280         spa_removing_phys_t spa_removing_phys;
 281         spa_vdev_removal_t *spa_vdev_removal;
 282
 283         spa_condensing_indirect_phys_t  spa_condensing_indirect_phys;
 284         spa_condensing_indirect_t       *spa_condensing_indirect;
 285         zthr_t          *spa_condense_zthr;     /* zthr doing condense. */
 286
 287         char            *spa_root;              /* alternate root directory */
 288         uint64_t        spa_ena;                /* spa-wide ereport ENA */
 289         int             spa_last_open_failed;   /* error if last open failed */
 290         uint64_t        spa_last_ubsync_txg;    /* "best" uberblock txg */
 291         uint64_t        spa_last_ubsync_txg_ts; /* timestamp from that ub */
 292         uint64_t        spa_load_txg;           /* ub txg that loaded */
 293         uint64_t        spa_load_txg_ts;        /* timestamp from that ub */
 294         uint64_t        spa_load_meta_errors;   /* verify metadata err count */
 295         uint64_t        spa_load_data_errors;   /* verify data err count */
 296         uint64_t        spa_verify_min_txg;     /* start txg of verify scrub */
 297         kmutex_t        spa_errlog_lock;        /* error log lock */
 298         uint64_t        spa_errlog_last;        /* last error log object */
 299         uint64_t        spa_errlog_scrub;       /* scrub error log object */
 300         kmutex_t        spa_errlist_lock;       /* error list/ereport lock */
 301         avl_tree_t      spa_errlist_last;       /* last error list */
 302         avl_tree_t      spa_errlist_scrub;      /* scrub error list */
 303         uint64_t        spa_deflate;            /* should we deflate? */
 304         uint64_t        spa_history;            /* history object */
 305         kmutex_t        spa_history_lock;       /* history lock */
 306         vdev_t          *spa_pending_vdev;      /* pending vdev additions */
 307         kmutex_t        spa_props_lock;         /* property lock */
 308         uint64_t        spa_pool_props_object;  /* object for properties */
 309         uint64_t        spa_bootfs;             /* default boot filesystem */
 310         uint64_t        spa_failmode;           /* failure mode for the pool */
 311         uint64_t        spa_deadman_failmode;   /* failure mode for deadman */
 312         uint64_t        spa_delegation;         /* delegation on/off */
 313         list_t          spa_config_list;        /* previous cache file(s) */
 314         /* per-CPU array of root of async I/O: */
 315         zio_t           **spa_async_zio_root;
 316         zio_t           *spa_suspend_zio_root;  /* root of all suspended I/O */
 317         zio_t           *spa_txg_zio[TXG_SIZE]; /* spa_sync() waits for this */
 318         kmutex_t        spa_suspend_lock;       /* protects suspend_zio_root */
 319         kcondvar_t      spa_suspend_cv;         /* notification of resume */
 320         zio_suspend_reason_t    spa_suspended;  /* pool is suspended */
 321         uint8_t         spa_claiming;           /* pool is doing zil_claim() */
 322         boolean_t       spa_is_root;            /* pool is root */
 323         int             spa_minref;             /* num refs when first opened */
 324         int             spa_mode;               /* FREAD | FWRITE */
 325         spa_log_state_t spa_log_state;          /* log state */
 326         uint64_t        spa_autoexpand;         /* lun expansion on/off */
 327         ddt_t           *spa_ddt[ZIO_CHECKSUM_FUNCTIONS]; /* in-core DDTs */
 328         uint64_t        spa_ddt_stat_object;    /* DDT statistics */
 329         uint64_t        spa_dedup_dspace;       /* Cache get_dedup_dspace() */
 330         uint64_t        spa_dedup_ditto;        /* dedup ditto threshold */
 331         uint64_t        spa_dedup_checksum;     /* default dedup checksum */
 332         uint64_t        spa_dspace;             /* dspace in normal class */
 333         kmutex_t        spa_vdev_top_lock;      /* dueling offline/remove */
 334         kmutex_t        spa_proc_lock;          /* protects spa_proc* */
 335         kcondvar_t      spa_proc_cv;            /* spa_proc_state transitions */
 336         spa_proc_state_t spa_proc_state;        /* see definition */
 337         proc_t          *spa_proc;              /* "zpool-poolname" process */
 338         uint64_t        spa_did;                /* if procp != p0, did of t1 */
 339         boolean_t       spa_autoreplace;        /* autoreplace set in open */
 340         int             spa_vdev_locks;         /* locks grabbed */
 341         uint64_t        spa_creation_version;   /* version at pool creation */
 342         uint64_t        spa_prev_software_version; /* See ub_software_version */
 343         uint64_t        spa_feat_for_write_obj; /* required to write to pool */
 344         uint64_t        spa_feat_for_read_obj;  /* required to read from pool */
 345         uint64_t        spa_feat_desc_obj;      /* Feature descriptions */
 346         uint64_t        spa_feat_enabled_txg_obj; /* Feature enabled txg */
 347         kmutex_t        spa_feat_stats_lock;    /* protects spa_feat_stats */
 348         nvlist_t        *spa_feat_stats;        /* Cache of enabled features */
 349         /* cache feature refcounts */
 350         uint64_t        spa_feat_refcount_cache[SPA_FEATURES];
 351         taskqid_t       spa_deadman_tqid;       /* Task id */
 352         uint64_t        spa_deadman_calls;      /* number of deadman calls */
 353         hrtime_t        spa_sync_starttime;     /* starting time of spa_sync */
 354         uint64_t        spa_deadman_synctime;   /* deadman sync expiration */
 355         uint64_t        spa_deadman_ziotime;    /* deadman zio expiration */
 356         uint64_t        spa_all_vdev_zaps;      /* ZAP of per-vd ZAP obj #s */
 357         spa_avz_action_t        spa_avz_action; /* destroy/rebuild AVZ? */
 358         uint64_t        spa_errata;             /* errata issues detected */
 359         spa_stats_t     spa_stats;              /* assorted spa statistics */
 360         spa_keystore_t  spa_keystore;           /* loaded crypto keys */
 361         hrtime_t        spa_ccw_fail_time;      /* Conf cache write fail time */
 362         taskq_t         *spa_zvol_taskq;        /* Taskq for minor management */
 363         taskq_t         *spa_prefetch_taskq;    /* Taskq for prefetch threads */
 364         uint64_t        spa_multihost;          /* multihost aware (mmp) */
 365         mmp_thread_t    spa_mmp;                /* multihost mmp thread */
 366
 367         /*
 368          * spa_refcount & spa_config_lock must be the last elements
 369          * because refcount_t changes size based on compilation options.
 370          * In order for the MDB module to function correctly, the other
 371          * fields must remain in the same location.
 372          */
 373         spa_config_lock_t spa_config_lock[SCL_LOCKS]; /* config changes */
 374         refcount_t      spa_refcount;           /* number of opens */
 375
 376         taskq_t         *spa_upgrade_taskq;     /* taskq for upgrade jobs */
 377 };
 378
 379 extern char *spa_config_path;
 380
 381 extern void spa_taskq_dispatch_ent(spa_t *spa, zio_type_t t, zio_taskq_type_t q,
 382     task_func_t *func, void *arg, uint_t flags, taskq_ent_t *ent);
 383 extern void spa_taskq_dispatch_sync(spa_t *, zio_type_t t, zio_taskq_type_t q,
 384     task_func_t *func, void *arg, uint_t flags);
 385 extern void spa_load_spares(spa_t *spa);
 386 extern void spa_load_l2cache(spa_t *spa);
 387 extern sysevent_t *spa_event_create(spa_t *spa, vdev_t *vd, nvlist_t *hist_nvl,
 388     const char *name);
 389 extern void spa_event_post(sysevent_t *ev);
 390
 391
 392 #ifdef  __cplusplus
 393 }
 394 #endif
 395
 396 #endif  /* _SYS_SPA_IMPL_H */