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.
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.
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]
23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
28 #include <sys/spa_impl.h>
30 #include <sys/dsl_synctask.h>
31 #include <sys/dmu_tx.h>
32 #include <sys/dmu_objset.h>
33 #include <sys/utsname.h>
34 #include <sys/cmn_err.h>
35 #include <sys/sunddi.h>
41 * Routines to manage the on-disk history log.
43 * The history log is stored as a dmu object containing
44 * <packed record length, record nvlist> tuples.
46 * Where "record nvlist" is a nvlist containing uint64_ts and strings, and
47 * "packed record length" is the packed length of the "record nvlist" stored
48 * as a little endian uint64_t.
50 * The log is implemented as a ring buffer, though the original creation
51 * of the pool ('zpool create') is never overwritten.
53 * The history log is tracked as object 'spa_t::spa_history'. The bonus buffer
54 * of 'spa_history' stores the offsets for logging/retrieving history as
55 * 'spa_history_phys_t'. 'sh_pool_create_len' is the ending offset in bytes of
56 * where the 'zpool create' record is stored. This allows us to never
57 * overwrite the original creation of the pool. 'sh_phys_max_off' is the
58 * physical ending offset in bytes of the log. This tells you the length of
59 * the buffer. 'sh_eof' is the logical EOF (in bytes). Whenever a record
60 * is added, 'sh_eof' is incremented by the the size of the record.
61 * 'sh_eof' is never decremented. 'sh_bof' is the logical BOF (in bytes).
62 * This is where the consumer should start reading from after reading in
63 * the 'zpool create' portion of the log.
65 * 'sh_records_lost' keeps track of how many records have been overwritten
66 * and permanently lost.
69 /* convert a logical offset to physical */
71 spa_history_log_to_phys(uint64_t log_off
, spa_history_phys_t
*shpp
)
75 phys_len
= shpp
->sh_phys_max_off
- shpp
->sh_pool_create_len
;
76 return ((log_off
- shpp
->sh_pool_create_len
) % phys_len
77 + shpp
->sh_pool_create_len
);
81 spa_history_create_obj(spa_t
*spa
, dmu_tx_t
*tx
)
84 spa_history_phys_t
*shpp
;
85 objset_t
*mos
= spa
->spa_meta_objset
;
87 ASSERT(spa
->spa_history
== 0);
88 spa
->spa_history
= dmu_object_alloc(mos
, DMU_OT_SPA_HISTORY
,
89 SPA_MAXBLOCKSIZE
, DMU_OT_SPA_HISTORY_OFFSETS
,
90 sizeof (spa_history_phys_t
), tx
);
92 VERIFY(zap_add(mos
, DMU_POOL_DIRECTORY_OBJECT
,
93 DMU_POOL_HISTORY
, sizeof (uint64_t), 1,
94 &spa
->spa_history
, tx
) == 0);
96 VERIFY(0 == dmu_bonus_hold(mos
, spa
->spa_history
, FTAG
, &dbp
));
97 ASSERT(dbp
->db_size
>= sizeof (spa_history_phys_t
));
100 dmu_buf_will_dirty(dbp
, tx
);
103 * Figure out maximum size of history log. We set it at
104 * 1% of pool size, with a max of 32MB and min of 128KB.
106 shpp
->sh_phys_max_off
= spa_get_dspace(spa
) / 100;
107 shpp
->sh_phys_max_off
= MIN(shpp
->sh_phys_max_off
, 32<<20);
108 shpp
->sh_phys_max_off
= MAX(shpp
->sh_phys_max_off
, 128<<10);
110 dmu_buf_rele(dbp
, FTAG
);
114 * Change 'sh_bof' to the beginning of the next record.
117 spa_history_advance_bof(spa_t
*spa
, spa_history_phys_t
*shpp
)
119 objset_t
*mos
= spa
->spa_meta_objset
;
120 uint64_t firstread
, reclen
, phys_bof
;
121 char buf
[sizeof (reclen
)];
124 phys_bof
= spa_history_log_to_phys(shpp
->sh_bof
, shpp
);
125 firstread
= MIN(sizeof (reclen
), shpp
->sh_phys_max_off
- phys_bof
);
127 if ((err
= dmu_read(mos
, spa
->spa_history
, phys_bof
, firstread
,
128 buf
, DMU_READ_PREFETCH
)) != 0)
130 if (firstread
!= sizeof (reclen
)) {
131 if ((err
= dmu_read(mos
, spa
->spa_history
,
132 shpp
->sh_pool_create_len
, sizeof (reclen
) - firstread
,
133 buf
+ firstread
, DMU_READ_PREFETCH
)) != 0)
137 reclen
= LE_64(*((uint64_t *)buf
));
138 shpp
->sh_bof
+= reclen
+ sizeof (reclen
);
139 shpp
->sh_records_lost
++;
144 spa_history_write(spa_t
*spa
, void *buf
, uint64_t len
, spa_history_phys_t
*shpp
,
147 uint64_t firstwrite
, phys_eof
;
148 objset_t
*mos
= spa
->spa_meta_objset
;
151 ASSERT(MUTEX_HELD(&spa
->spa_history_lock
));
153 /* see if we need to reset logical BOF */
154 while (shpp
->sh_phys_max_off
- shpp
->sh_pool_create_len
-
155 (shpp
->sh_eof
- shpp
->sh_bof
) <= len
) {
156 if ((err
= spa_history_advance_bof(spa
, shpp
)) != 0) {
161 phys_eof
= spa_history_log_to_phys(shpp
->sh_eof
, shpp
);
162 firstwrite
= MIN(len
, shpp
->sh_phys_max_off
- phys_eof
);
164 dmu_write(mos
, spa
->spa_history
, phys_eof
, firstwrite
, buf
, tx
);
168 /* write out the rest at the beginning of physical file */
169 dmu_write(mos
, spa
->spa_history
, shpp
->sh_pool_create_len
,
170 len
, (char *)buf
+ firstwrite
, tx
);
180 return (curproc
->p_zone
->zone_name
);
187 * Write out a history event.
190 spa_history_log_sync(void *arg1
, void *arg2
, cred_t
*cr
, dmu_tx_t
*tx
)
193 history_arg_t
*hap
= arg2
;
194 const char *history_str
= hap
->ha_history_str
;
195 objset_t
*mos
= spa
->spa_meta_objset
;
197 spa_history_phys_t
*shpp
;
201 char *record_packed
= NULL
;
205 * If we have an older pool that doesn't have a command
206 * history object, create it now.
208 mutex_enter(&spa
->spa_history_lock
);
209 if (!spa
->spa_history
)
210 spa_history_create_obj(spa
, tx
);
211 mutex_exit(&spa
->spa_history_lock
);
214 * Get the offset of where we need to write via the bonus buffer.
215 * Update the offset when the write completes.
217 VERIFY(0 == dmu_bonus_hold(mos
, spa
->spa_history
, FTAG
, &dbp
));
220 dmu_buf_will_dirty(dbp
, tx
);
224 dmu_object_info_t doi
;
225 dmu_object_info_from_db(dbp
, &doi
);
226 ASSERT3U(doi
.doi_bonus_type
, ==, DMU_OT_SPA_HISTORY_OFFSETS
);
230 VERIFY(nvlist_alloc(&nvrecord
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
231 VERIFY(nvlist_add_uint64(nvrecord
, ZPOOL_HIST_TIME
,
232 gethrestime_sec()) == 0);
233 VERIFY(nvlist_add_uint64(nvrecord
, ZPOOL_HIST_WHO
,
234 (uint64_t)crgetuid(cr
)) == 0);
235 if (hap
->ha_zone
[0] != '\0')
236 VERIFY(nvlist_add_string(nvrecord
, ZPOOL_HIST_ZONE
,
239 VERIFY(nvlist_add_string(nvrecord
, ZPOOL_HIST_HOST
,
240 utsname
.nodename
) == 0);
242 if (hap
->ha_log_type
== LOG_CMD_POOL_CREATE
||
243 hap
->ha_log_type
== LOG_CMD_NORMAL
) {
244 VERIFY(nvlist_add_string(nvrecord
, ZPOOL_HIST_CMD
,
247 VERIFY(nvlist_add_uint64(nvrecord
, ZPOOL_HIST_INT_EVENT
,
248 hap
->ha_event
) == 0);
249 VERIFY(nvlist_add_uint64(nvrecord
, ZPOOL_HIST_TXG
,
251 VERIFY(nvlist_add_string(nvrecord
, ZPOOL_HIST_INT_STR
,
255 VERIFY(nvlist_size(nvrecord
, &reclen
, NV_ENCODE_XDR
) == 0);
256 record_packed
= kmem_alloc(reclen
, KM_SLEEP
);
258 VERIFY(nvlist_pack(nvrecord
, &record_packed
, &reclen
,
259 NV_ENCODE_XDR
, KM_SLEEP
) == 0);
261 mutex_enter(&spa
->spa_history_lock
);
262 if (hap
->ha_log_type
== LOG_CMD_POOL_CREATE
)
263 VERIFY(shpp
->sh_eof
== shpp
->sh_pool_create_len
);
265 /* write out the packed length as little endian */
266 le_len
= LE_64((uint64_t)reclen
);
267 ret
= spa_history_write(spa
, &le_len
, sizeof (le_len
), shpp
, tx
);
269 ret
= spa_history_write(spa
, record_packed
, reclen
, shpp
, tx
);
271 if (!ret
&& hap
->ha_log_type
== LOG_CMD_POOL_CREATE
) {
272 shpp
->sh_pool_create_len
+= sizeof (le_len
) + reclen
;
273 shpp
->sh_bof
= shpp
->sh_pool_create_len
;
276 mutex_exit(&spa
->spa_history_lock
);
277 nvlist_free(nvrecord
);
278 kmem_free(record_packed
, reclen
);
279 dmu_buf_rele(dbp
, FTAG
);
281 if (hap
->ha_log_type
== LOG_INTERNAL
) {
282 kmem_free((void*)hap
->ha_history_str
, HIS_MAX_RECORD_LEN
);
283 kmem_free(hap
, sizeof (history_arg_t
));
288 * Write out a history event.
291 spa_history_log(spa_t
*spa
, const char *history_str
, history_log_type_t what
)
295 ASSERT(what
!= LOG_INTERNAL
);
297 ha
.ha_history_str
= history_str
;
298 ha
.ha_log_type
= what
;
299 (void) strlcpy(ha
.ha_zone
, spa_history_zone(), sizeof (ha
.ha_zone
));
300 return (dsl_sync_task_do(spa_get_dsl(spa
), NULL
, spa_history_log_sync
,
305 * Read out the command history.
308 spa_history_get(spa_t
*spa
, uint64_t *offp
, uint64_t *len
, char *buf
)
310 objset_t
*mos
= spa
->spa_meta_objset
;
312 uint64_t read_len
, phys_read_off
, phys_eof
;
313 uint64_t leftover
= 0;
314 spa_history_phys_t
*shpp
;
318 * If the command history doesn't exist (older pool),
319 * that's ok, just return ENOENT.
321 if (!spa
->spa_history
)
324 if ((err
= dmu_bonus_hold(mos
, spa
->spa_history
, FTAG
, &dbp
)) != 0)
330 dmu_object_info_t doi
;
331 dmu_object_info_from_db(dbp
, &doi
);
332 ASSERT3U(doi
.doi_bonus_type
, ==, DMU_OT_SPA_HISTORY_OFFSETS
);
336 mutex_enter(&spa
->spa_history_lock
);
337 phys_eof
= spa_history_log_to_phys(shpp
->sh_eof
, shpp
);
339 if (*offp
< shpp
->sh_pool_create_len
) {
340 /* read in just the zpool create history */
341 phys_read_off
= *offp
;
342 read_len
= MIN(*len
, shpp
->sh_pool_create_len
-
346 * Need to reset passed in offset to BOF if the passed in
347 * offset has since been overwritten.
349 *offp
= MAX(*offp
, shpp
->sh_bof
);
350 phys_read_off
= spa_history_log_to_phys(*offp
, shpp
);
353 * Read up to the minimum of what the user passed down or
354 * the EOF (physical or logical). If we hit physical EOF,
355 * use 'leftover' to read from the physical BOF.
357 if (phys_read_off
<= phys_eof
) {
358 read_len
= MIN(*len
, phys_eof
- phys_read_off
);
361 shpp
->sh_phys_max_off
- phys_read_off
);
362 if (phys_read_off
+ *len
> shpp
->sh_phys_max_off
) {
363 leftover
= MIN(*len
- read_len
,
364 phys_eof
- shpp
->sh_pool_create_len
);
369 /* offset for consumer to use next */
370 *offp
+= read_len
+ leftover
;
372 /* tell the consumer how much you actually read */
373 *len
= read_len
+ leftover
;
376 mutex_exit(&spa
->spa_history_lock
);
377 dmu_buf_rele(dbp
, FTAG
);
381 err
= dmu_read(mos
, spa
->spa_history
, phys_read_off
, read_len
, buf
,
383 if (leftover
&& err
== 0) {
384 err
= dmu_read(mos
, spa
->spa_history
, shpp
->sh_pool_create_len
,
385 leftover
, buf
+ read_len
, DMU_READ_PREFETCH
);
387 mutex_exit(&spa
->spa_history_lock
);
389 dmu_buf_rele(dbp
, FTAG
);
394 spa_history_internal_log(history_internal_events_t event
, spa_t
*spa
,
395 dmu_tx_t
*tx
, cred_t
*cr
, const char *fmt
, ...)
402 * If this is part of creating a pool, not everything is
403 * initialized yet, so don't bother logging the internal events.
405 if (tx
->tx_txg
== TXG_INITIAL
)
408 hap
= kmem_alloc(sizeof (history_arg_t
), KM_SLEEP
);
409 str
= kmem_alloc(HIS_MAX_RECORD_LEN
, KM_SLEEP
);
412 (void) vsnprintf(str
, HIS_MAX_RECORD_LEN
, fmt
, adx
);
415 hap
->ha_log_type
= LOG_INTERNAL
;
416 hap
->ha_history_str
= str
;
417 hap
->ha_event
= event
;
418 hap
->ha_zone
[0] = '\0';
420 if (dmu_tx_is_syncing(tx
)) {
421 spa_history_log_sync(spa
, hap
, cr
, tx
);
423 dsl_sync_task_do_nowait(spa_get_dsl(spa
), NULL
,
424 spa_history_log_sync
, spa
, hap
, 0, tx
);
426 /* spa_history_log_sync() will free hap and str */