sys/cddl/contrib/opensolaris/uts/common/fs/zfs/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, 2014 by Delphix. All rights reserved.
  24  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
  25  * Copyright 2013 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
  26  */
  27
  28 #ifndef _SYS_SPA_IMPL_H
  29 #define _SYS_SPA_IMPL_H
  30
  31 #include <sys/spa.h>
  32 #include <sys/vdev.h>
  33 #include <sys/metaslab.h>
  34 #include <sys/dmu.h>
  35 #include <sys/dsl_pool.h>
  36 #include <sys/uberblock_impl.h>
  37 #include <sys/zfs_context.h>
  38 #include <sys/avl.h>
  39 #include <sys/refcount.h>
  40 #include <sys/bplist.h>
  41 #include <sys/bpobj.h>
  42 #include <sys/zfeature.h>
  43 #include <zfeature_common.h>
  44
  45 #ifdef  __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 typedef struct spa_error_entry {
  50         zbookmark_phys_t        se_bookmark;
  51         char                    *se_name;
  52         avl_node_t              se_avl;
  53 } spa_error_entry_t;
  54
  55 typedef struct spa_history_phys {
  56         uint64_t sh_pool_create_len;    /* ending offset of zpool create */
  57         uint64_t sh_phys_max_off;       /* physical EOF */
  58         uint64_t sh_bof;                /* logical BOF */
  59         uint64_t sh_eof;                /* logical EOF */
  60         uint64_t sh_records_lost;       /* num of records overwritten */
  61 } spa_history_phys_t;
  62
  63 struct spa_aux_vdev {
  64         uint64_t        sav_object;             /* MOS object for device list */
  65         nvlist_t        *sav_config;            /* cached device config */
  66         vdev_t          **sav_vdevs;            /* devices */
  67         int             sav_count;              /* number devices */
  68         boolean_t       sav_sync;               /* sync the device list */
  69         nvlist_t        **sav_pending;          /* pending device additions */
  70         uint_t          sav_npending;           /* # pending devices */
  71 };
  72
  73 typedef struct spa_config_lock {
  74         kmutex_t        scl_lock;
  75         kthread_t       *scl_writer;
  76         int             scl_write_wanted;
  77         kcondvar_t      scl_cv;
  78         refcount_t      scl_count;
  79 } spa_config_lock_t;
  80
  81 typedef struct spa_config_dirent {
  82         list_node_t     scd_link;
  83         char            *scd_path;
  84 } spa_config_dirent_t;
  85
  86 typedef enum zio_taskq_type {
  87         ZIO_TASKQ_ISSUE = 0,
  88         ZIO_TASKQ_ISSUE_HIGH,
  89         ZIO_TASKQ_INTERRUPT,
  90         ZIO_TASKQ_INTERRUPT_HIGH,
  91         ZIO_TASKQ_TYPES
  92 } zio_taskq_type_t;
  93
  94 /*
  95  * State machine for the zpool-poolname process.  The states transitions
  96  * are done as follows:
  97  *
  98  *      From               To                   Routine
  99  *      PROC_NONE       -> PROC_CREATED         spa_activate()
 100  *      PROC_CREATED    -> PROC_ACTIVE          spa_thread()
 101  *      PROC_ACTIVE     -> PROC_DEACTIVATE      spa_deactivate()
 102  *      PROC_DEACTIVATE -> PROC_GONE            spa_thread()
 103  *      PROC_GONE       -> PROC_NONE            spa_deactivate()
 104  */
 105 typedef enum spa_proc_state {
 106         SPA_PROC_NONE,          /* spa_proc = &p0, no process created */
 107         SPA_PROC_CREATED,       /* spa_activate() has proc, is waiting */
 108         SPA_PROC_ACTIVE,        /* taskqs created, spa_proc set */
 109         SPA_PROC_DEACTIVATE,    /* spa_deactivate() requests process exit */
 110         SPA_PROC_GONE           /* spa_thread() is exiting, spa_proc = &p0 */
 111 } spa_proc_state_t;
 112
 113 typedef struct spa_taskqs {
 114         uint_t stqs_count;
 115         taskq_t **stqs_taskq;
 116 } spa_taskqs_t;
 117
 118 struct spa {
 119         /*
 120          * Fields protected by spa_namespace_lock.
 121          */
 122         char            spa_name[MAXNAMELEN];   /* pool name */
 123         char            *spa_comment;           /* comment */
 124         avl_node_t      spa_avl;                /* node in spa_namespace_avl */
 125         nvlist_t        *spa_config;            /* last synced config */
 126         nvlist_t        *spa_config_syncing;    /* currently syncing config */
 127         nvlist_t        *spa_config_splitting;  /* config for splitting */
 128         nvlist_t        *spa_load_info;         /* info and errors from load */
 129         uint64_t        spa_config_txg;         /* txg of last config change */
 130         int             spa_sync_pass;          /* iterate-to-convergence */
 131         pool_state_t    spa_state;              /* pool state */
 132         int             spa_inject_ref;         /* injection references */
 133         uint8_t         spa_sync_on;            /* sync threads are running */
 134         spa_load_state_t spa_load_state;        /* current load operation */
 135         uint64_t        spa_import_flags;       /* import specific flags */
 136         spa_taskqs_t    spa_zio_taskq[ZIO_TYPES][ZIO_TASKQ_TYPES];
 137         dsl_pool_t      *spa_dsl_pool;
 138         boolean_t       spa_is_initializing;    /* true while opening pool */
 139         metaslab_class_t *spa_normal_class;     /* normal data class */
 140         metaslab_class_t *spa_log_class;        /* intent log data class */
 141         uint64_t        spa_first_txg;          /* first txg after spa_open() */
 142         uint64_t        spa_final_txg;          /* txg of export/destroy */
 143         uint64_t        spa_freeze_txg;         /* freeze pool at this txg */
 144         uint64_t        spa_load_max_txg;       /* best initial ub_txg */
 145         uint64_t        spa_claim_max_txg;      /* highest claimed birth txg */
 146         timespec_t      spa_loaded_ts;          /* 1st successful open time */
 147         objset_t        *spa_meta_objset;       /* copy of dp->dp_meta_objset */
 148         txg_list_t      spa_vdev_txg_list;      /* per-txg dirty vdev list */
 149         vdev_t          *spa_root_vdev;         /* top-level vdev container */
 150         uint64_t        spa_config_guid;        /* config pool guid */
 151         uint64_t        spa_load_guid;          /* spa_load initialized guid */
 152         uint64_t        spa_last_synced_guid;   /* last synced guid */
 153         list_t          spa_config_dirty_list;  /* vdevs with dirty config */
 154         list_t          spa_state_dirty_list;   /* vdevs with dirty state */
 155         spa_aux_vdev_t  spa_spares;             /* hot spares */
 156         spa_aux_vdev_t  spa_l2cache;            /* L2ARC cache devices */
 157         nvlist_t        *spa_label_features;    /* Features for reading MOS */
 158         uint64_t        spa_config_object;      /* MOS object for pool config */
 159         uint64_t        spa_config_generation;  /* config generation number */
 160         uint64_t        spa_syncing_txg;        /* txg currently syncing */
 161         bpobj_t         spa_deferred_bpobj;     /* deferred-free bplist */
 162         bplist_t        spa_free_bplist[TXG_SIZE]; /* bplist of stuff to free */
 163         uberblock_t     spa_ubsync;             /* last synced uberblock */
 164         uberblock_t     spa_uberblock;          /* current uberblock */
 165         boolean_t       spa_extreme_rewind;     /* rewind past deferred frees */
 166         uint64_t        spa_last_io;            /* lbolt of last non-scan I/O */
 167         kmutex_t        spa_scrub_lock;         /* resilver/scrub lock */
 168         uint64_t        spa_scrub_inflight;     /* in-flight scrub I/Os */
 169         kcondvar_t      spa_scrub_io_cv;        /* scrub I/O completion */
 170         uint8_t         spa_scrub_active;       /* active or suspended? */
 171         uint8_t         spa_scrub_type;         /* type of scrub we're doing */
 172         uint8_t         spa_scrub_finished;     /* indicator to rotate logs */
 173         uint8_t         spa_scrub_started;      /* started since last boot */
 174         uint8_t         spa_scrub_reopen;       /* scrub doing vdev_reopen */
 175         uint64_t        spa_scan_pass_start;    /* start time per pass/reboot */
 176         uint64_t        spa_scan_pass_exam;     /* examined bytes per pass */
 177         kmutex_t        spa_async_lock;         /* protect async state */
 178         kthread_t       *spa_async_thread;      /* thread doing async task */
 179         kthread_t       *spa_async_thread_vd;   /* thread doing vd async task */
 180         int             spa_async_suspended;    /* async tasks suspended */
 181         kcondvar_t      spa_async_cv;           /* wait for thread_exit() */
 182         uint16_t        spa_async_tasks;        /* async task mask */
 183         char            *spa_root;              /* alternate root directory */
 184         uint64_t        spa_ena;                /* spa-wide ereport ENA */
 185         int             spa_last_open_failed;   /* error if last open failed */
 186         uint64_t        spa_last_ubsync_txg;    /* "best" uberblock txg */
 187         uint64_t        spa_last_ubsync_txg_ts; /* timestamp from that ub */
 188         uint64_t        spa_load_txg;           /* ub txg that loaded */
 189         uint64_t        spa_load_txg_ts;        /* timestamp from that ub */
 190         uint64_t        spa_load_meta_errors;   /* verify metadata err count */
 191         uint64_t        spa_load_data_errors;   /* verify data err count */
 192         uint64_t        spa_verify_min_txg;     /* start txg of verify scrub */
 193         kmutex_t        spa_errlog_lock;        /* error log lock */
 194         uint64_t        spa_errlog_last;        /* last error log object */
 195         uint64_t        spa_errlog_scrub;       /* scrub error log object */
 196         kmutex_t        spa_errlist_lock;       /* error list/ereport lock */
 197         avl_tree_t      spa_errlist_last;       /* last error list */
 198         avl_tree_t      spa_errlist_scrub;      /* scrub error list */
 199         uint64_t        spa_deflate;            /* should we deflate? */
 200         uint64_t        spa_history;            /* history object */
 201         kmutex_t        spa_history_lock;       /* history lock */
 202         vdev_t          *spa_pending_vdev;      /* pending vdev additions */
 203         kmutex_t        spa_props_lock;         /* property lock */
 204         uint64_t        spa_pool_props_object;  /* object for properties */
 205         uint64_t        spa_bootfs;             /* default boot filesystem */
 206         uint64_t        spa_failmode;           /* failure mode for the pool */
 207         uint64_t        spa_delegation;         /* delegation on/off */
 208         list_t          spa_config_list;        /* previous cache file(s) */
 209         zio_t           *spa_async_zio_root;    /* root of all async I/O */
 210         zio_t           *spa_suspend_zio_root;  /* root of all suspended I/O */
 211         kmutex_t        spa_suspend_lock;       /* protects suspend_zio_root */
 212         kcondvar_t      spa_suspend_cv;         /* notification of resume */
 213         uint8_t         spa_suspended;          /* pool is suspended */
 214         uint8_t         spa_claiming;           /* pool is doing zil_claim() */
 215         boolean_t       spa_debug;              /* debug enabled? */
 216         boolean_t       spa_is_root;            /* pool is root */
 217         int             spa_minref;             /* num refs when first opened */
 218         int             spa_mode;               /* FREAD | FWRITE */
 219         spa_log_state_t spa_log_state;          /* log state */
 220         uint64_t        spa_autoexpand;         /* lun expansion on/off */
 221         ddt_t           *spa_ddt[ZIO_CHECKSUM_FUNCTIONS]; /* in-core DDTs */
 222         uint64_t        spa_ddt_stat_object;    /* DDT statistics */
 223         uint64_t        spa_dedup_ditto;        /* dedup ditto threshold */
 224         uint64_t        spa_dedup_checksum;     /* default dedup checksum */
 225         uint64_t        spa_dspace;             /* dspace in normal class */
 226         kmutex_t        spa_vdev_top_lock;      /* dueling offline/remove */
 227         kmutex_t        spa_proc_lock;          /* protects spa_proc* */
 228         kcondvar_t      spa_proc_cv;            /* spa_proc_state transitions */
 229         spa_proc_state_t spa_proc_state;        /* see definition */
 230         struct proc     *spa_proc;              /* "zpool-poolname" process */
 231         uint64_t        spa_did;                /* if procp != p0, did of t1 */
 232         kthread_t       *spa_trim_thread;       /* thread sending TRIM I/Os */
 233         kmutex_t        spa_trim_lock;          /* protects spa_trim_cv */
 234         kcondvar_t      spa_trim_cv;            /* used to notify TRIM thread */
 235         boolean_t       spa_autoreplace;        /* autoreplace set in open */
 236         int             spa_vdev_locks;         /* locks grabbed */
 237         uint64_t        spa_creation_version;   /* version at pool creation */
 238         uint64_t        spa_prev_software_version; /* See ub_software_version */
 239         uint64_t        spa_feat_for_write_obj; /* required to write to pool */
 240         uint64_t        spa_feat_for_read_obj;  /* required to read from pool */
 241         uint64_t        spa_feat_desc_obj;      /* Feature descriptions */
 242         uint64_t        spa_feat_enabled_txg_obj; /* Feature enabled txg */
 243         /* cache feature refcounts */
 244         uint64_t        spa_feat_refcount_cache[SPA_FEATURES];
 245 #ifdef illumos
 246         cyclic_id_t     spa_deadman_cycid;      /* cyclic id */
 247 #else   /* FreeBSD */
 248 #ifdef _KERNEL
 249         struct callout  spa_deadman_cycid;      /* callout id */
 250 #endif
 251 #endif  /* illumos */
 252         uint64_t        spa_deadman_calls;      /* number of deadman calls */
 253         hrtime_t        spa_sync_starttime;     /* starting time fo spa_sync */
 254         uint64_t        spa_deadman_synctime;   /* deadman expiration timer */
 255 #ifdef illumos
 256         /*
 257          * spa_iokstat_lock protects spa_iokstat and
 258          * spa_queue_stats[].
 259          */
 260         kmutex_t        spa_iokstat_lock;
 261         struct kstat    *spa_iokstat;           /* kstat of io to this pool */
 262         struct {
 263                 int spa_active;
 264                 int spa_queued;
 265         } spa_queue_stats[ZIO_PRIORITY_NUM_QUEUEABLE];
 266 #endif
 267         hrtime_t        spa_ccw_fail_time;      /* Conf cache write fail time */
 268
 269         /*
 270          * spa_refcount & spa_config_lock must be the last elements
 271          * because refcount_t changes size based on compilation options.
 272          * In order for the MDB module to function correctly, the other
 273          * fields must remain in the same location.
 274          */
 275         spa_config_lock_t spa_config_lock[SCL_LOCKS]; /* config changes */
 276         refcount_t      spa_refcount;           /* number of opens */
 277 #ifndef sun
 278         boolean_t       spa_splitting_newspa;   /* creating new spa in split */
 279 #endif
 280 };
 281
 282 extern const char *spa_config_path;
 283
 284 extern void spa_taskq_dispatch_ent(spa_t *spa, zio_type_t t, zio_taskq_type_t q,
 285     task_func_t *func, void *arg, uint_t flags, taskq_ent_t *ent);
 286
 287 #ifdef  __cplusplus
 288 }
 289 #endif
 290
 291 #endif  /* _SYS_SPA_IMPL_H */