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