1 // SPDX-License-Identifier: GPL-2.0+
4 * ZFS filesystem ported to u-boot by
5 * Jorgen Lundman <lundman at lundman.net>
7 * GRUB -- GRand Unified Bootloader
8 * Copyright (C) 1999,2000,2001,2002,2003,2004
9 * Free Software Foundation, Inc.
10 * Copyright 2004 Sun Microsystems, Inc.
15 #include <linux/stat.h>
16 #include <linux/time.h>
17 #include <linux/ctype.h>
18 #include <asm/byteorder.h>
19 #include "zfs_common.h"
22 struct blk_desc *zfs_dev_desc;
25 * The zfs plug-in routines for GRUB are:
27 * zfs_mount() - locates a valid uberblock of the root pool and reads
28 * in its MOS at the memory address MOS.
30 * zfs_open() - locates a plain file object by following the MOS
31 * and places its dnode at the memory address DNODE.
33 * zfs_read() - read in the data blocks pointed by the DNODE.
39 #include <zfs/dnode.h>
40 #include <zfs/uberblock_impl.h>
41 #include <zfs/vdev_impl.h>
42 #include <zfs/zio_checksum.h>
43 #include <zfs/zap_impl.h>
44 #include <zfs/zap_leaf.h>
45 #include <zfs/zfs_znode.h>
47 #include <zfs/dmu_objset.h>
48 #include <zfs/sa_impl.h>
49 #include <zfs/dsl_dir.h>
50 #include <zfs/dsl_dataset.h>
53 #define ZPOOL_PROP_BOOTFS "bootfs"
57 * For nvlist manipulation. (from nvpair.h)
59 #define NV_ENCODE_NATIVE 0
60 #define NV_ENCODE_XDR 1
61 #define NV_BIG_ENDIAN 0
62 #define NV_LITTLE_ENDIAN 1
63 #define DATA_TYPE_UINT64 8
64 #define DATA_TYPE_STRING 9
65 #define DATA_TYPE_NVLIST 19
66 #define DATA_TYPE_NVLIST_ARRAY 20
70 * Macros to get fields in a bp or DVA.
72 #define P2PHASE(x, align) ((x) & ((align) - 1))
73 #define DVA_OFFSET_TO_PHYS_SECTOR(offset) \
74 ((offset + VDEV_LABEL_START_SIZE) >> SPA_MINBLOCKSHIFT)
77 * return x rounded down to an align boundary
78 * eg, P2ALIGN(1200, 1024) == 1024 (1*align)
79 * eg, P2ALIGN(1024, 1024) == 1024 (1*align)
80 * eg, P2ALIGN(0x1234, 0x100) == 0x1200 (0x12*align)
81 * eg, P2ALIGN(0x5600, 0x100) == 0x5600 (0x56*align)
83 #define P2ALIGN(x, align) ((x) & -(align))
86 * FAT ZAP data structures
88 #define ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */
89 #define ZAP_HASH_IDX(hash, n) (((n) == 0) ? 0 : ((hash) >> (64 - (n))))
90 #define CHAIN_END 0xffff /* end of the chunk chain */
93 * The amount of space within the chunk available for the array is:
94 * chunk size - space for type (1) - space for next pointer (2)
96 #define ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3)
98 #define ZAP_LEAF_HASH_SHIFT(bs) (bs - 5)
99 #define ZAP_LEAF_HASH_NUMENTRIES(bs) (1 << ZAP_LEAF_HASH_SHIFT(bs))
100 #define LEAF_HASH(bs, h) \
101 ((ZAP_LEAF_HASH_NUMENTRIES(bs)-1) & \
102 ((h) >> (64 - ZAP_LEAF_HASH_SHIFT(bs)-l->l_hdr.lh_prefix_len)))
105 * The amount of space available for chunks is:
106 * block size shift - hash entry size (2) * number of hash
107 * entries - header space (2*chunksize)
109 #define ZAP_LEAF_NUMCHUNKS(bs) \
110 (((1<<bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(bs)) / \
111 ZAP_LEAF_CHUNKSIZE - 2)
114 * The chunks start immediately after the hash table. The end of the
115 * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a
118 #define ZAP_LEAF_CHUNK(l, bs, idx) \
119 ((zap_leaf_chunk_t *)(l->l_hash + ZAP_LEAF_HASH_NUMENTRIES(bs)))[idx]
120 #define ZAP_LEAF_ENTRY(l, bs, idx) (&ZAP_LEAF_CHUNK(l, bs, idx).l_entry)
124 * Decompression Entry - lzjb
132 typedef int zfs_decomp_func_t(void *s_start, void *d_start,
133 uint32_t s_len, uint32_t d_len);
134 typedef struct decomp_entry {
136 zfs_decomp_func_t *decomp_func;
139 typedef struct dnode_end {
145 /* cache for a file block of the currently zfs_open()-ed file */
150 /* XXX: ashift is per vdev, not per pool. We currently only ever touch
151 * a single vdev, but when/if raid-z or stripes are supported, this
154 uint64_t vdev_ashift;
158 /* cache for a dnode block */
159 dnode_phys_t *dnode_buf;
160 dnode_phys_t *dnode_mdn;
161 uint64_t dnode_start;
163 zfs_endian_t dnode_endian;
165 uberblock_t current_uberblock;
171 uint64_t vdev_phys_sector;
173 int (*userhook)(const char *, const struct zfs_dirhook_info *);
174 struct zfs_dirhook_info *dirinfo;
182 zlib_decompress(void *s, void *d,
183 uint32_t slen, uint32_t dlen)
185 if (zlib_decompress(s, d, slen, dlen) < 0)
186 return ZFS_ERR_BAD_FS;
190 static decomp_entry_t decomp_table[ZIO_COMPRESS_FUNCTIONS] = {
191 {"inherit", NULL}, /* ZIO_COMPRESS_INHERIT */
192 {"on", lzjb_decompress}, /* ZIO_COMPRESS_ON */
193 {"off", NULL}, /* ZIO_COMPRESS_OFF */
194 {"lzjb", lzjb_decompress}, /* ZIO_COMPRESS_LZJB */
195 {"empty", NULL}, /* ZIO_COMPRESS_EMPTY */
196 {"gzip-1", zlib_decompress}, /* ZIO_COMPRESS_GZIP1 */
197 {"gzip-2", zlib_decompress}, /* ZIO_COMPRESS_GZIP2 */
198 {"gzip-3", zlib_decompress}, /* ZIO_COMPRESS_GZIP3 */
199 {"gzip-4", zlib_decompress}, /* ZIO_COMPRESS_GZIP4 */
200 {"gzip-5", zlib_decompress}, /* ZIO_COMPRESS_GZIP5 */
201 {"gzip-6", zlib_decompress}, /* ZIO_COMPRESS_GZIP6 */
202 {"gzip-7", zlib_decompress}, /* ZIO_COMPRESS_GZIP7 */
203 {"gzip-8", zlib_decompress}, /* ZIO_COMPRESS_GZIP8 */
204 {"gzip-9", zlib_decompress}, /* ZIO_COMPRESS_GZIP9 */
209 static int zio_read_data(blkptr_t *bp, zfs_endian_t endian,
210 void *buf, struct zfs_data *data);
213 zio_read(blkptr_t *bp, zfs_endian_t endian, void **buf,
214 size_t *size, struct zfs_data *data);
217 * Our own version of log2(). Same thing as highbit()-1.
220 zfs_log2(uint64_t num)
233 /* Checksum Functions */
235 zio_checksum_off(const void *buf __attribute__ ((unused)),
236 uint64_t size __attribute__ ((unused)),
237 zfs_endian_t endian __attribute__ ((unused)),
240 ZIO_SET_CHECKSUM(zcp, 0, 0, 0, 0);
243 /* Checksum Table and Values */
244 static zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS] = {
245 {NULL, 0, 0, "inherit"},
247 {zio_checksum_off, 0, 0, "off"},
248 {zio_checksum_SHA256, 1, 1, "label"},
249 {zio_checksum_SHA256, 1, 1, "gang_header"},
250 {NULL, 0, 0, "zilog"},
251 {fletcher_2_endian, 0, 0, "fletcher2"},
252 {fletcher_4_endian, 1, 0, "fletcher4"},
253 {zio_checksum_SHA256, 1, 0, "SHA256"},
254 {NULL, 0, 0, "zilog2"},
258 * zio_checksum_verify: Provides support for checksum verification.
260 * Fletcher2, Fletcher4, and SHA256 are supported.
264 zio_checksum_verify(zio_cksum_t zc, uint32_t checksum,
265 zfs_endian_t endian, char *buf, int size)
267 zio_eck_t *zec = (zio_eck_t *) (buf + size) - 1;
268 zio_checksum_info_t *ci = &zio_checksum_table[checksum];
269 zio_cksum_t actual_cksum, expected_cksum;
271 if (checksum >= ZIO_CHECKSUM_FUNCTIONS || ci->ci_func == NULL) {
272 printf("zfs unknown checksum function %d\n", checksum);
273 return ZFS_ERR_NOT_IMPLEMENTED_YET;
277 expected_cksum = zec->zec_cksum;
279 ci->ci_func(buf, size, endian, &actual_cksum);
280 zec->zec_cksum = expected_cksum;
283 ci->ci_func(buf, size, endian, &actual_cksum);
286 if ((actual_cksum.zc_word[0] != zc.zc_word[0])
287 || (actual_cksum.zc_word[1] != zc.zc_word[1])
288 || (actual_cksum.zc_word[2] != zc.zc_word[2])
289 || (actual_cksum.zc_word[3] != zc.zc_word[3])) {
290 return ZFS_ERR_BAD_FS;
297 * vdev_uberblock_compare takes two uberblock structures and returns an integer
298 * indicating the more recent of the two.
299 * Return Value = 1 if ub2 is more recent
300 * Return Value = -1 if ub1 is more recent
301 * The most recent uberblock is determined using its transaction number and
302 * timestamp. The uberblock with the highest transaction number is
303 * considered "newer". If the transaction numbers of the two blocks match, the
304 * timestamps are compared to determine the "newer" of the two.
307 vdev_uberblock_compare(uberblock_t *ub1, uberblock_t *ub2)
309 zfs_endian_t ub1_endian, ub2_endian;
310 if (zfs_to_cpu64(ub1->ub_magic, LITTLE_ENDIAN) == UBERBLOCK_MAGIC)
311 ub1_endian = LITTLE_ENDIAN;
313 ub1_endian = BIG_ENDIAN;
314 if (zfs_to_cpu64(ub2->ub_magic, LITTLE_ENDIAN) == UBERBLOCK_MAGIC)
315 ub2_endian = LITTLE_ENDIAN;
317 ub2_endian = BIG_ENDIAN;
319 if (zfs_to_cpu64(ub1->ub_txg, ub1_endian)
320 < zfs_to_cpu64(ub2->ub_txg, ub2_endian))
322 if (zfs_to_cpu64(ub1->ub_txg, ub1_endian)
323 > zfs_to_cpu64(ub2->ub_txg, ub2_endian))
326 if (zfs_to_cpu64(ub1->ub_timestamp, ub1_endian)
327 < zfs_to_cpu64(ub2->ub_timestamp, ub2_endian))
329 if (zfs_to_cpu64(ub1->ub_timestamp, ub1_endian)
330 > zfs_to_cpu64(ub2->ub_timestamp, ub2_endian))
337 * Three pieces of information are needed to verify an uberblock: the magic
338 * number, the version number, and the checksum.
340 * Currently Implemented: version number, magic number, label txg
341 * Need to Implement: checksum
345 uberblock_verify(uberblock_t *uber, int offset, struct zfs_data *data)
348 zfs_endian_t endian = UNKNOWN_ENDIAN;
351 if (uber->ub_txg < data->label_txg) {
352 debug("ignoring partially written label: uber_txg < label_txg %llu %llu\n",
353 uber->ub_txg, data->label_txg);
354 return ZFS_ERR_BAD_FS;
357 if (zfs_to_cpu64(uber->ub_magic, LITTLE_ENDIAN) == UBERBLOCK_MAGIC
358 && zfs_to_cpu64(uber->ub_version, LITTLE_ENDIAN) > 0
359 && zfs_to_cpu64(uber->ub_version, LITTLE_ENDIAN) <= SPA_VERSION)
360 endian = LITTLE_ENDIAN;
362 if (zfs_to_cpu64(uber->ub_magic, BIG_ENDIAN) == UBERBLOCK_MAGIC
363 && zfs_to_cpu64(uber->ub_version, BIG_ENDIAN) > 0
364 && zfs_to_cpu64(uber->ub_version, BIG_ENDIAN) <= SPA_VERSION)
367 if (endian == UNKNOWN_ENDIAN) {
368 printf("invalid uberblock magic\n");
369 return ZFS_ERR_BAD_FS;
372 memset(&zc, 0, sizeof(zc));
373 zc.zc_word[0] = cpu_to_zfs64(offset, endian);
374 err = zio_checksum_verify(zc, ZIO_CHECKSUM_LABEL, endian,
375 (char *) uber, UBERBLOCK_SIZE(data->vdev_ashift));
378 /* Check that the data pointed by the rootbp is usable. */
381 err = zio_read(&uber->ub_rootbp, endian, &osp, &ospsize, data);
384 if (!err && ospsize < OBJSET_PHYS_SIZE_V14) {
385 printf("uberblock rootbp points to invalid data\n");
386 return ZFS_ERR_BAD_FS;
394 * Find the best uberblock.
396 * Success - Pointer to the best uberblock.
399 static uberblock_t *find_bestub(char *ub_array, struct zfs_data *data)
401 const uint64_t sector = data->vdev_phys_sector;
402 uberblock_t *ubbest = NULL;
404 unsigned int i, offset, pickedub = 0;
405 int err = ZFS_ERR_NONE;
407 const unsigned int UBCOUNT = UBERBLOCK_COUNT(data->vdev_ashift);
408 const uint64_t UBBYTES = UBERBLOCK_SIZE(data->vdev_ashift);
410 for (i = 0; i < UBCOUNT; i++) {
411 ubnext = (uberblock_t *) (i * UBBYTES + ub_array);
412 offset = (sector << SPA_MINBLOCKSHIFT) + VDEV_PHYS_SIZE + (i * UBBYTES);
414 err = uberblock_verify(ubnext, offset, data);
418 if (ubbest == NULL || vdev_uberblock_compare(ubnext, ubbest) > 0) {
425 debug("zfs Found best uberblock at idx %d, txg %llu\n",
426 pickedub, (unsigned long long) ubbest->ub_txg);
432 get_psize(blkptr_t *bp, zfs_endian_t endian)
434 return (((zfs_to_cpu64((bp)->blk_prop, endian) >> 16) & 0xffff) + 1)
435 << SPA_MINBLOCKSHIFT;
439 dva_get_offset(dva_t *dva, zfs_endian_t endian)
441 return zfs_to_cpu64((dva)->dva_word[1],
442 endian) << SPA_MINBLOCKSHIFT;
446 * Read a block of data based on the gang block address dva,
447 * and put its data in buf.
451 zio_read_gang(blkptr_t *bp, zfs_endian_t endian, dva_t *dva, void *buf,
452 struct zfs_data *data)
454 zio_gbh_phys_t *zio_gb;
455 uint64_t offset, sector;
460 memset(&zc, 0, sizeof(zc));
462 zio_gb = malloc(SPA_GANGBLOCKSIZE);
464 return ZFS_ERR_OUT_OF_MEMORY;
466 offset = dva_get_offset(dva, endian);
467 sector = DVA_OFFSET_TO_PHYS_SECTOR(offset);
469 /* read in the gang block header */
470 err = zfs_devread(sector, 0, SPA_GANGBLOCKSIZE, (char *) zio_gb);
478 /* self checksuming the gang block header */
479 ZIO_SET_CHECKSUM(&zc, DVA_GET_VDEV(dva),
480 dva_get_offset(dva, endian), bp->blk_birth, 0);
481 err = zio_checksum_verify(zc, ZIO_CHECKSUM_GANG_HEADER, endian,
482 (char *) zio_gb, SPA_GANGBLOCKSIZE);
488 endian = (zfs_to_cpu64(bp->blk_prop, endian) >> 63) & 1;
490 for (i = 0; i < SPA_GBH_NBLKPTRS; i++) {
491 if (zio_gb->zg_blkptr[i].blk_birth == 0)
494 err = zio_read_data(&zio_gb->zg_blkptr[i], endian, buf, data);
499 buf = (char *) buf + get_psize(&zio_gb->zg_blkptr[i], endian);
506 * Read in a block of raw data to buf.
509 zio_read_data(blkptr_t *bp, zfs_endian_t endian, void *buf,
510 struct zfs_data *data)
513 int err = ZFS_ERR_NONE;
515 psize = get_psize(bp, endian);
517 /* pick a good dva from the block pointer */
518 for (i = 0; i < SPA_DVAS_PER_BP; i++) {
519 uint64_t offset, sector;
521 if (bp->blk_dva[i].dva_word[0] == 0 && bp->blk_dva[i].dva_word[1] == 0)
524 if ((zfs_to_cpu64(bp->blk_dva[i].dva_word[1], endian)>>63) & 1) {
525 err = zio_read_gang(bp, endian, &bp->blk_dva[i], buf, data);
527 /* read in a data block */
528 offset = dva_get_offset(&bp->blk_dva[i], endian);
529 sector = DVA_OFFSET_TO_PHYS_SECTOR(offset);
531 err = zfs_devread(sector, 0, psize, buf);
535 /*Check the underlying checksum before we rule this DVA as "good"*/
536 uint32_t checkalgo = (zfs_to_cpu64((bp)->blk_prop, endian) >> 40) & 0xff;
538 err = zio_checksum_verify(bp->blk_cksum, checkalgo, endian, buf, psize);
543 /* If read failed or checksum bad, reset the error. Hopefully we've got some more DVA's to try.*/
547 printf("couldn't find a valid DVA\n");
548 err = ZFS_ERR_BAD_FS;
555 * Read in a block of data, verify its checksum, decompress if needed,
556 * and put the uncompressed data in buf.
559 zio_read(blkptr_t *bp, zfs_endian_t endian, void **buf,
560 size_t *size, struct zfs_data *data)
564 char *compbuf = NULL;
569 comp = (zfs_to_cpu64((bp)->blk_prop, endian)>>32) & 0xff;
570 lsize = (BP_IS_HOLE(bp) ? 0 :
571 (((zfs_to_cpu64((bp)->blk_prop, endian) & 0xffff) + 1)
572 << SPA_MINBLOCKSHIFT));
573 psize = get_psize(bp, endian);
578 if (comp >= ZIO_COMPRESS_FUNCTIONS) {
579 printf("compression algorithm %u not supported\n", (unsigned int) comp);
580 return ZFS_ERR_NOT_IMPLEMENTED_YET;
583 if (comp != ZIO_COMPRESS_OFF && decomp_table[comp].decomp_func == NULL) {
584 printf("compression algorithm %s not supported\n", decomp_table[comp].name);
585 return ZFS_ERR_NOT_IMPLEMENTED_YET;
588 if (comp != ZIO_COMPRESS_OFF) {
589 compbuf = malloc(psize);
591 return ZFS_ERR_OUT_OF_MEMORY;
593 compbuf = *buf = malloc(lsize);
596 err = zio_read_data(bp, endian, compbuf, data);
603 if (comp != ZIO_COMPRESS_OFF) {
604 *buf = malloc(lsize);
607 return ZFS_ERR_OUT_OF_MEMORY;
610 err = decomp_table[comp].decomp_func(compbuf, *buf, psize, lsize);
623 * Get the block from a block id.
624 * push the block onto the stack.
628 dmu_read(dnode_end_t *dn, uint64_t blkid, void **buf,
629 zfs_endian_t *endian_out, struct zfs_data *data)
632 blkptr_t *bp_array = dn->dn.dn_blkptr;
633 int epbs = dn->dn.dn_indblkshift - SPA_BLKPTRSHIFT;
637 int err = ZFS_ERR_NONE;
639 bp = malloc(sizeof(blkptr_t));
641 return ZFS_ERR_OUT_OF_MEMORY;
644 for (level = dn->dn.dn_nlevels - 1; level >= 0; level--) {
645 idx = (blkid >> (epbs * level)) & ((1 << epbs) - 1);
647 if (bp_array != dn->dn.dn_blkptr) {
652 if (BP_IS_HOLE(bp)) {
653 size_t size = zfs_to_cpu16(dn->dn.dn_datablkszsec,
655 << SPA_MINBLOCKSHIFT;
658 err = ZFS_ERR_OUT_OF_MEMORY;
661 memset(*buf, 0, size);
662 endian = (zfs_to_cpu64(bp->blk_prop, endian) >> 63) & 1;
666 err = zio_read(bp, endian, buf, 0, data);
667 endian = (zfs_to_cpu64(bp->blk_prop, endian) >> 63) & 1;
670 err = zio_read(bp, endian, &tmpbuf, 0, data);
671 endian = (zfs_to_cpu64(bp->blk_prop, endian) >> 63) & 1;
676 if (bp_array != dn->dn.dn_blkptr)
679 *endian_out = endian;
686 * mzap_lookup: Looks up property described by "name" and returns the value
690 mzap_lookup(mzap_phys_t *zapobj, zfs_endian_t endian,
691 int objsize, char *name, uint64_t * value)
694 mzap_ent_phys_t *mzap_ent = zapobj->mz_chunk;
696 chunks = objsize / MZAP_ENT_LEN - 1;
697 for (i = 0; i < chunks; i++) {
698 if (strcmp(mzap_ent[i].mze_name, name) == 0) {
699 *value = zfs_to_cpu64(mzap_ent[i].mze_value, endian);
704 printf("couldn't find '%s'\n", name);
705 return ZFS_ERR_FILE_NOT_FOUND;
709 mzap_iterate(mzap_phys_t *zapobj, zfs_endian_t endian, int objsize,
710 int (*hook)(const char *name,
712 struct zfs_data *data),
713 struct zfs_data *data)
716 mzap_ent_phys_t *mzap_ent = zapobj->mz_chunk;
718 chunks = objsize / MZAP_ENT_LEN - 1;
719 for (i = 0; i < chunks; i++) {
720 if (hook(mzap_ent[i].mze_name,
721 zfs_to_cpu64(mzap_ent[i].mze_value, endian),
730 zap_hash(uint64_t salt, const char *name)
732 static uint64_t table[256];
737 if (table[128] == 0) {
740 for (i = 0; i < 256; i++) {
741 for (ct = table + i, *ct = i, j = 8; j > 0; j--)
742 *ct = (*ct >> 1) ^ (-(*ct & 1) & ZFS_CRC64_POLY);
746 for (cp = (const uint8_t *) name; (c = *cp) != '\0'; cp++)
747 crc = (crc >> 8) ^ table[(crc ^ c) & 0xFF];
750 * Only use 28 bits, since we need 4 bits in the cookie for the
751 * collision differentiator. We MUST use the high bits, since
752 * those are the onces that we first pay attention to when
753 * chosing the bucket.
755 crc &= ~((1ULL << (64 - ZAP_HASHBITS)) - 1);
761 * Only to be used on 8-bit arrays.
762 * array_len is actual len in bytes (not encoded le_value_length).
763 * buf is null-terminated.
767 zap_leaf_array_equal(zap_leaf_phys_t *l, zfs_endian_t endian,
768 int blksft, int chunk, int array_len, const char *buf)
772 while (bseen < array_len) {
773 struct zap_leaf_array *la = &ZAP_LEAF_CHUNK(l, blksft, chunk).l_array;
774 int toread = min(array_len - bseen, ZAP_LEAF_ARRAY_BYTES);
776 if (chunk >= ZAP_LEAF_NUMCHUNKS(blksft))
779 if (memcmp(la->la_array, buf + bseen, toread) != 0)
781 chunk = zfs_to_cpu16(la->la_next, endian);
784 return (bseen == array_len);
789 zap_leaf_array_get(zap_leaf_phys_t *l, zfs_endian_t endian, int blksft,
790 int chunk, int array_len, char *buf)
794 while (bseen < array_len) {
795 struct zap_leaf_array *la = &ZAP_LEAF_CHUNK(l, blksft, chunk).l_array;
796 int toread = min(array_len - bseen, ZAP_LEAF_ARRAY_BYTES);
798 if (chunk >= ZAP_LEAF_NUMCHUNKS(blksft))
799 /* Don't use errno because this error is to be ignored. */
800 return ZFS_ERR_BAD_FS;
802 memcpy(buf + bseen, la->la_array, toread);
803 chunk = zfs_to_cpu16(la->la_next, endian);
811 * Given a zap_leaf_phys_t, walk thru the zap leaf chunks to get the
812 * value for the property "name".
817 zap_leaf_lookup(zap_leaf_phys_t *l, zfs_endian_t endian,
818 int blksft, uint64_t h,
819 const char *name, uint64_t *value)
822 struct zap_leaf_entry *le;
824 /* Verify if this is a valid leaf block */
825 if (zfs_to_cpu64(l->l_hdr.lh_block_type, endian) != ZBT_LEAF) {
826 printf("invalid leaf type\n");
827 return ZFS_ERR_BAD_FS;
829 if (zfs_to_cpu32(l->l_hdr.lh_magic, endian) != ZAP_LEAF_MAGIC) {
830 printf("invalid leaf magic\n");
831 return ZFS_ERR_BAD_FS;
834 for (chunk = zfs_to_cpu16(l->l_hash[LEAF_HASH(blksft, h)], endian);
835 chunk != CHAIN_END; chunk = le->le_next) {
837 if (chunk >= ZAP_LEAF_NUMCHUNKS(blksft)) {
838 printf("invalid chunk number\n");
839 return ZFS_ERR_BAD_FS;
842 le = ZAP_LEAF_ENTRY(l, blksft, chunk);
844 /* Verify the chunk entry */
845 if (le->le_type != ZAP_CHUNK_ENTRY) {
846 printf("invalid chunk entry\n");
847 return ZFS_ERR_BAD_FS;
850 if (zfs_to_cpu64(le->le_hash, endian) != h)
853 if (zap_leaf_array_equal(l, endian, blksft,
854 zfs_to_cpu16(le->le_name_chunk, endian),
855 zfs_to_cpu16(le->le_name_length, endian),
857 struct zap_leaf_array *la;
859 if (le->le_int_size != 8 || le->le_value_length != 1) {
860 printf("invalid leaf chunk entry\n");
861 return ZFS_ERR_BAD_FS;
863 /* get the uint64_t property value */
864 la = &ZAP_LEAF_CHUNK(l, blksft, le->le_value_chunk).l_array;
866 *value = be64_to_cpu(la->la_array64);
872 printf("couldn't find '%s'\n", name);
873 return ZFS_ERR_FILE_NOT_FOUND;
877 /* Verify if this is a fat zap header block */
879 zap_verify(zap_phys_t *zap)
881 if (zap->zap_magic != (uint64_t) ZAP_MAGIC) {
882 printf("bad ZAP magic\n");
883 return ZFS_ERR_BAD_FS;
886 if (zap->zap_flags != 0) {
887 printf("bad ZAP flags\n");
888 return ZFS_ERR_BAD_FS;
891 if (zap->zap_salt == 0) {
892 printf("bad ZAP salt\n");
893 return ZFS_ERR_BAD_FS;
905 fzap_lookup(dnode_end_t *zap_dnode, zap_phys_t *zap,
906 char *name, uint64_t *value, struct zfs_data *data)
909 uint64_t hash, idx, blkid;
910 int blksft = zfs_log2(zfs_to_cpu16(zap_dnode->dn.dn_datablkszsec,
911 zap_dnode->endian) << DNODE_SHIFT);
913 zfs_endian_t leafendian;
915 err = zap_verify(zap);
919 hash = zap_hash(zap->zap_salt, name);
921 /* get block id from index */
922 if (zap->zap_ptrtbl.zt_numblks != 0) {
923 printf("external pointer tables not supported\n");
924 return ZFS_ERR_NOT_IMPLEMENTED_YET;
926 idx = ZAP_HASH_IDX(hash, zap->zap_ptrtbl.zt_shift);
927 blkid = ((uint64_t *) zap)[idx + (1 << (blksft - 3 - 1))];
929 /* Get the leaf block */
930 if ((1U << blksft) < sizeof(zap_leaf_phys_t)) {
931 printf("ZAP leaf is too small\n");
932 return ZFS_ERR_BAD_FS;
934 err = dmu_read(zap_dnode, blkid, &l, &leafendian, data);
938 err = zap_leaf_lookup(l, leafendian, blksft, hash, name, value);
945 fzap_iterate(dnode_end_t *zap_dnode, zap_phys_t *zap,
946 int (*hook)(const char *name,
948 struct zfs_data *data),
949 struct zfs_data *data)
955 int blksft = zfs_log2(zfs_to_cpu16(zap_dnode->dn.dn_datablkszsec,
956 zap_dnode->endian) << DNODE_SHIFT);
963 /* get block id from index */
964 if (zap->zap_ptrtbl.zt_numblks != 0) {
965 printf("external pointer tables not supported\n");
968 /* Get the leaf block */
969 if ((1U << blksft) < sizeof(zap_leaf_phys_t)) {
970 printf("ZAP leaf is too small\n");
973 for (idx = 0; idx < zap->zap_ptrtbl.zt_numblks; idx++) {
974 blkid = ((uint64_t *) zap)[idx + (1 << (blksft - 3 - 1))];
976 err = dmu_read(zap_dnode, blkid, &l_in, &endian, data);
981 /* Verify if this is a valid leaf block */
982 if (zfs_to_cpu64(l->l_hdr.lh_block_type, endian) != ZBT_LEAF) {
986 if (zfs_to_cpu32(l->l_hdr.lh_magic, endian) != ZAP_LEAF_MAGIC) {
991 for (chunk = 0; chunk < ZAP_LEAF_NUMCHUNKS(blksft); chunk++) {
993 struct zap_leaf_array *la;
994 struct zap_leaf_entry *le;
996 le = ZAP_LEAF_ENTRY(l, blksft, chunk);
998 /* Verify the chunk entry */
999 if (le->le_type != ZAP_CHUNK_ENTRY)
1002 buf = malloc(zfs_to_cpu16(le->le_name_length, endian)
1004 if (zap_leaf_array_get(l, endian, blksft, le->le_name_chunk,
1005 le->le_name_length, buf)) {
1009 buf[le->le_name_length] = 0;
1011 if (le->le_int_size != 8
1012 || zfs_to_cpu16(le->le_value_length, endian) != 1)
1015 /* get the uint64_t property value */
1016 la = &ZAP_LEAF_CHUNK(l, blksft, le->le_value_chunk).l_array;
1017 val = be64_to_cpu(la->la_array64);
1018 if (hook(buf, val, data))
1028 * Read in the data of a zap object and find the value for a matching
1033 zap_lookup(dnode_end_t *zap_dnode, char *name, uint64_t *val,
1034 struct zfs_data *data)
1036 uint64_t block_type;
1040 zfs_endian_t endian;
1042 /* Read in the first block of the zap object data. */
1043 size = zfs_to_cpu16(zap_dnode->dn.dn_datablkszsec,
1044 zap_dnode->endian) << SPA_MINBLOCKSHIFT;
1045 err = dmu_read(zap_dnode, 0, &zapbuf, &endian, data);
1048 block_type = zfs_to_cpu64(*((uint64_t *) zapbuf), endian);
1050 if (block_type == ZBT_MICRO) {
1051 err = (mzap_lookup(zapbuf, endian, size, name, val));
1054 } else if (block_type == ZBT_HEADER) {
1055 /* this is a fat zap */
1056 err = (fzap_lookup(zap_dnode, zapbuf, name, val, data));
1061 printf("unknown ZAP type\n");
1063 return ZFS_ERR_BAD_FS;
1067 zap_iterate(dnode_end_t *zap_dnode,
1068 int (*hook)(const char *name, uint64_t val,
1069 struct zfs_data *data),
1070 struct zfs_data *data)
1072 uint64_t block_type;
1077 zfs_endian_t endian;
1079 /* Read in the first block of the zap object data. */
1080 size = zfs_to_cpu16(zap_dnode->dn.dn_datablkszsec, zap_dnode->endian) << SPA_MINBLOCKSHIFT;
1081 err = dmu_read(zap_dnode, 0, &zapbuf, &endian, data);
1084 block_type = zfs_to_cpu64(*((uint64_t *) zapbuf), endian);
1086 if (block_type == ZBT_MICRO) {
1087 ret = mzap_iterate(zapbuf, endian, size, hook, data);
1090 } else if (block_type == ZBT_HEADER) {
1091 /* this is a fat zap */
1092 ret = fzap_iterate(zap_dnode, zapbuf, hook, data);
1096 printf("unknown ZAP type\n");
1103 * Get the dnode of an object number from the metadnode of an object set.
1106 * mdn - metadnode to get the object dnode
1107 * objnum - object number for the object dnode
1108 * buf - data buffer that holds the returning dnode
1111 dnode_get(dnode_end_t *mdn, uint64_t objnum, uint8_t type,
1112 dnode_end_t *buf, struct zfs_data *data)
1114 uint64_t blkid, blksz; /* the block id this object dnode is in */
1115 int epbs; /* shift of number of dnodes in a block */
1116 int idx; /* index within a block */
1119 zfs_endian_t endian;
1121 blksz = zfs_to_cpu16(mdn->dn.dn_datablkszsec,
1122 mdn->endian) << SPA_MINBLOCKSHIFT;
1124 epbs = zfs_log2(blksz) - DNODE_SHIFT;
1125 blkid = objnum >> epbs;
1126 idx = objnum & ((1 << epbs) - 1);
1128 if (data->dnode_buf != NULL && memcmp(data->dnode_mdn, mdn,
1130 && objnum >= data->dnode_start && objnum < data->dnode_end) {
1131 memmove(&(buf->dn), &(data->dnode_buf)[idx], DNODE_SIZE);
1132 buf->endian = data->dnode_endian;
1133 if (type && buf->dn.dn_type != type) {
1134 printf("incorrect dnode type: %02X != %02x\n", buf->dn.dn_type, type);
1135 return ZFS_ERR_BAD_FS;
1137 return ZFS_ERR_NONE;
1140 err = dmu_read(mdn, blkid, &dnbuf, &endian, data);
1144 free(data->dnode_buf);
1145 free(data->dnode_mdn);
1146 data->dnode_mdn = malloc(sizeof(*mdn));
1147 if (!data->dnode_mdn) {
1148 data->dnode_buf = 0;
1150 memcpy(data->dnode_mdn, mdn, sizeof(*mdn));
1151 data->dnode_buf = dnbuf;
1152 data->dnode_start = blkid << epbs;
1153 data->dnode_end = (blkid + 1) << epbs;
1154 data->dnode_endian = endian;
1157 memmove(&(buf->dn), (dnode_phys_t *) dnbuf + idx, DNODE_SIZE);
1158 buf->endian = endian;
1159 if (type && buf->dn.dn_type != type) {
1160 printf("incorrect dnode type\n");
1161 return ZFS_ERR_BAD_FS;
1164 return ZFS_ERR_NONE;
1168 * Get the file dnode for a given file name where mdn is the meta dnode
1169 * for this ZFS object set. When found, place the file dnode in dn.
1170 * The 'path' argument will be mangled.
1174 dnode_get_path(dnode_end_t *mdn, const char *path_in, dnode_end_t *dn,
1175 struct zfs_data *data)
1177 uint64_t objnum, version;
1179 int err = ZFS_ERR_NONE;
1180 char *path, *path_buf;
1181 struct dnode_chain {
1182 struct dnode_chain *next;
1185 struct dnode_chain *dnode_path = 0, *dn_new, *root;
1187 dn_new = malloc(sizeof(*dn_new));
1189 return ZFS_ERR_OUT_OF_MEMORY;
1191 dnode_path = root = dn_new;
1193 err = dnode_get(mdn, MASTER_NODE_OBJ, DMU_OT_MASTER_NODE,
1194 &(dnode_path->dn), data);
1200 err = zap_lookup(&(dnode_path->dn), ZPL_VERSION_STR, &version, data);
1205 if (version > ZPL_VERSION) {
1207 printf("too new ZPL version\n");
1208 return ZFS_ERR_NOT_IMPLEMENTED_YET;
1211 err = zap_lookup(&(dnode_path->dn), ZFS_ROOT_OBJ, &objnum, data);
1217 err = dnode_get(mdn, objnum, 0, &(dnode_path->dn), data);
1223 path = path_buf = strdup(path_in);
1226 return ZFS_ERR_OUT_OF_MEMORY;
1230 /* skip leading slashes */
1231 while (*path == '/')
1235 /* get the next component name */
1237 while (*path && *path != '/')
1240 if (cname + 1 == path && cname[0] == '.')
1242 /* Handle double dot. */
1243 if (cname + 2 == path && cname[0] == '.' && cname[1] == '.') {
1245 dn_new = dnode_path;
1246 dnode_path = dn_new->next;
1249 printf("can't resolve ..\n");
1250 err = ZFS_ERR_FILE_NOT_FOUND;
1257 *path = 0; /* ensure null termination */
1259 if (dnode_path->dn.dn.dn_type != DMU_OT_DIRECTORY_CONTENTS) {
1261 printf("not a directory\n");
1262 return ZFS_ERR_BAD_FILE_TYPE;
1264 err = zap_lookup(&(dnode_path->dn), cname, &objnum, data);
1268 dn_new = malloc(sizeof(*dn_new));
1270 err = ZFS_ERR_OUT_OF_MEMORY;
1273 dn_new->next = dnode_path;
1274 dnode_path = dn_new;
1276 objnum = ZFS_DIRENT_OBJ(objnum);
1277 err = dnode_get(mdn, objnum, 0, &(dnode_path->dn), data);
1285 memcpy(dn, &(dnode_path->dn), sizeof(*dn));
1287 while (dnode_path) {
1288 dn_new = dnode_path->next;
1290 dnode_path = dn_new;
1298 * Given a MOS metadnode, get the metadnode of a given filesystem name (fsname),
1299 * e.g. pool/rootfs, or a given object number (obj), e.g. the object number
1302 * If no fsname and no obj are given, return the DSL_DIR metadnode.
1303 * If fsname is given, return its metadnode and its matching object number.
1304 * If only obj is given, return the metadnode for this object number.
1308 get_filesystem_dnode(dnode_end_t *mosmdn, char *fsname,
1309 dnode_end_t *mdn, struct zfs_data *data)
1314 err = dnode_get(mosmdn, DMU_POOL_DIRECTORY_OBJECT,
1315 DMU_OT_OBJECT_DIRECTORY, mdn, data);
1319 err = zap_lookup(mdn, DMU_POOL_ROOT_DATASET, &objnum, data);
1323 err = dnode_get(mosmdn, objnum, DMU_OT_DSL_DIR, mdn, data);
1331 while (*fsname == '/')
1334 if (!*fsname || *fsname == '@')
1338 while (*fsname && !isspace(*fsname) && *fsname != '/')
1343 childobj = zfs_to_cpu64((((dsl_dir_phys_t *) DN_BONUS(&mdn->dn)))->dd_child_dir_zapobj, mdn->endian);
1344 err = dnode_get(mosmdn, childobj,
1345 DMU_OT_DSL_DIR_CHILD_MAP, mdn, data);
1349 err = zap_lookup(mdn, cname, &objnum, data);
1353 err = dnode_get(mosmdn, objnum, DMU_OT_DSL_DIR, mdn, data);
1359 return ZFS_ERR_NONE;
1363 make_mdn(dnode_end_t *mdn, struct zfs_data *data)
1370 bp = &(((dsl_dataset_phys_t *) DN_BONUS(&mdn->dn))->ds_bp);
1371 err = zio_read(bp, mdn->endian, &osp, &ospsize, data);
1374 if (ospsize < OBJSET_PHYS_SIZE_V14) {
1376 printf("too small osp\n");
1377 return ZFS_ERR_BAD_FS;
1380 mdn->endian = (zfs_to_cpu64(bp->blk_prop, mdn->endian)>>63) & 1;
1381 memmove((char *) &(mdn->dn),
1382 (char *) &((objset_phys_t *) osp)->os_meta_dnode, DNODE_SIZE);
1384 return ZFS_ERR_NONE;
1388 dnode_get_fullpath(const char *fullpath, dnode_end_t *mdn,
1389 uint64_t *mdnobj, dnode_end_t *dn, int *isfs,
1390 struct zfs_data *data)
1392 char *fsname, *snapname;
1393 const char *ptr_at, *filename;
1397 ptr_at = strchr(fullpath, '@');
1402 fsname = strdup(fullpath);
1404 const char *ptr_slash = strchr(ptr_at, '/');
1407 fsname = malloc(ptr_at - fullpath + 1);
1409 return ZFS_ERR_OUT_OF_MEMORY;
1410 memcpy(fsname, fullpath, ptr_at - fullpath);
1411 fsname[ptr_at - fullpath] = 0;
1412 if (ptr_at[1] && ptr_at[1] != '/') {
1413 snapname = malloc(ptr_slash - ptr_at);
1416 return ZFS_ERR_OUT_OF_MEMORY;
1418 memcpy(snapname, ptr_at + 1, ptr_slash - ptr_at - 1);
1419 snapname[ptr_slash - ptr_at - 1] = 0;
1424 filename = ptr_slash;
1427 printf("zfs fsname = '%s' snapname='%s' filename = '%s'\n",
1428 fsname, snapname, filename);
1432 err = get_filesystem_dnode(&(data->mos), fsname, dn, data);
1440 headobj = zfs_to_cpu64(((dsl_dir_phys_t *) DN_BONUS(&dn->dn))->dd_head_dataset_obj, dn->endian);
1442 err = dnode_get(&(data->mos), headobj, DMU_OT_DSL_DATASET, mdn, data);
1452 snapobj = zfs_to_cpu64(((dsl_dataset_phys_t *) DN_BONUS(&mdn->dn))->ds_snapnames_zapobj, mdn->endian);
1454 err = dnode_get(&(data->mos), snapobj,
1455 DMU_OT_DSL_DS_SNAP_MAP, mdn, data);
1457 err = zap_lookup(mdn, snapname, &headobj, data);
1459 err = dnode_get(&(data->mos), headobj, DMU_OT_DSL_DATASET, mdn, data);
1470 make_mdn(mdn, data);
1475 return ZFS_ERR_NONE;
1477 err = dnode_get_path(mdn, filename, dn, data);
1484 * For a given XDR packed nvlist, verify the first 4 bytes and move on.
1486 * An XDR packed nvlist is encoded as (comments from nvs_xdr_create) :
1488 * encoding method/host endian (4 bytes)
1489 * nvl_version (4 bytes)
1490 * nvl_nvflag (4 bytes)
1492 * encoded size of the nvpair (4 bytes)
1493 * decoded size of the nvpair (4 bytes)
1494 * name string size (4 bytes)
1495 * name string data (sizeof(NV_ALIGN4(string))
1496 * data type (4 bytes)
1497 * # of elements in the nvpair (4 bytes)
1499 * 2 zero's for the last nvpair
1500 * (end of the entire list) (8 bytes)
1505 nvlist_find_value(char *nvlist, char *name, int valtype, char **val,
1506 size_t *size_out, size_t *nelm_out)
1508 int name_len, type, encode_size;
1509 char *nvpair, *nvp_name;
1511 /* Verify if the 1st and 2nd byte in the nvlist are valid. */
1512 /* NOTE: independently of what endianness header announces all
1513 subsequent values are big-endian. */
1514 if (nvlist[0] != NV_ENCODE_XDR || (nvlist[1] != NV_LITTLE_ENDIAN
1515 && nvlist[1] != NV_BIG_ENDIAN)) {
1516 printf("zfs incorrect nvlist header\n");
1517 return ZFS_ERR_BAD_FS;
1520 /* skip the header, nvl_version, and nvl_nvflag */
1521 nvlist = nvlist + 4 * 3;
1523 * Loop thru the nvpair list
1524 * The XDR representation of an integer is in big-endian byte order.
1526 while ((encode_size = be32_to_cpu(*(uint32_t *) nvlist))) {
1529 nvpair = nvlist + 4 * 2; /* skip the encode/decode size */
1531 name_len = be32_to_cpu(*(uint32_t *) nvpair);
1535 nvpair = nvpair + ((name_len + 3) & ~3); /* align */
1537 type = be32_to_cpu(*(uint32_t *) nvpair);
1540 nelm = be32_to_cpu(*(uint32_t *) nvpair);
1542 printf("empty nvpair\n");
1543 return ZFS_ERR_BAD_FS;
1548 if ((strncmp(nvp_name, name, name_len) == 0) && type == valtype) {
1550 *size_out = encode_size;
1556 nvlist += encode_size; /* goto the next nvpair */
1562 zfs_nvlist_lookup_uint64(char *nvlist, char *name, uint64_t *out)
1568 found = nvlist_find_value(nvlist, name, DATA_TYPE_UINT64, &nvpair, &size, 0);
1571 if (size < sizeof(uint64_t)) {
1572 printf("invalid uint64\n");
1573 return ZFS_ERR_BAD_FS;
1576 *out = be64_to_cpu(*(uint64_t *) nvpair);
1581 zfs_nvlist_lookup_string(char *nvlist, char *name)
1589 found = nvlist_find_value(nvlist, name, DATA_TYPE_STRING, &nvpair, &size, 0);
1593 printf("invalid string\n");
1596 slen = be32_to_cpu(*(uint32_t *) nvpair);
1597 if (slen > size - 4)
1599 ret = malloc(slen + 1);
1602 memcpy(ret, nvpair + 4, slen);
1608 zfs_nvlist_lookup_nvlist(char *nvlist, char *name)
1615 found = nvlist_find_value(nvlist, name, DATA_TYPE_NVLIST, &nvpair,
1619 ret = calloc(1, size + 3 * sizeof(uint32_t));
1622 memcpy(ret, nvlist, sizeof(uint32_t));
1624 memcpy(ret + sizeof(uint32_t), nvpair, size);
1629 zfs_nvlist_lookup_nvlist_array_get_nelm(char *nvlist, char *name)
1635 found = nvlist_find_value(nvlist, name, DATA_TYPE_NVLIST, &nvpair,
1643 zfs_nvlist_lookup_nvlist_array(char *nvlist, char *name,
1646 char *nvpair, *nvpairptr;
1653 found = nvlist_find_value(nvlist, name, DATA_TYPE_NVLIST, &nvpair,
1657 if (index >= nelm) {
1658 printf("trying to lookup past nvlist array\n");
1664 for (i = 0; i < index; i++) {
1665 uint32_t encode_size;
1667 /* skip the header, nvl_version, and nvl_nvflag */
1668 nvpairptr = nvpairptr + 4 * 2;
1670 while (nvpairptr < nvpair + size
1671 && (encode_size = be32_to_cpu(*(uint32_t *) nvpairptr)))
1672 nvlist += encode_size; /* goto the next nvpair */
1674 nvlist = nvlist + 4 * 2; /* skip the ending 2 zeros - 8 bytes */
1677 if (nvpairptr >= nvpair + size
1678 || nvpairptr + be32_to_cpu(*(uint32_t *) (nvpairptr + 4 * 2))
1680 printf("incorrect nvlist array\n");
1684 ret = calloc(1, be32_to_cpu(*(uint32_t *) (nvpairptr + 4 * 2))
1685 + 3 * sizeof(uint32_t));
1688 memcpy(ret, nvlist, sizeof(uint32_t));
1690 memcpy(ret + sizeof(uint32_t), nvpairptr, size);
1695 int_zfs_fetch_nvlist(struct zfs_data *data, char **nvlist)
1699 *nvlist = malloc(VDEV_PHYS_SIZE);
1700 /* Read in the vdev name-value pair list (112K). */
1701 err = zfs_devread(data->vdev_phys_sector, 0, VDEV_PHYS_SIZE, *nvlist);
1707 return ZFS_ERR_NONE;
1711 * Check the disk label information and retrieve needed vdev name-value pairs.
1715 check_pool_label(struct zfs_data *data)
1717 uint64_t pool_state;
1718 char *nvlist; /* for the pool */
1719 char *vdevnvlist; /* for the vdev */
1725 err = int_zfs_fetch_nvlist(data, &nvlist);
1729 found = zfs_nvlist_lookup_uint64(nvlist, ZPOOL_CONFIG_POOL_STATE,
1733 printf("zfs pool state not found\n");
1734 return ZFS_ERR_BAD_FS;
1737 if (pool_state == POOL_STATE_DESTROYED) {
1739 printf("zpool is marked as destroyed\n");
1740 return ZFS_ERR_BAD_FS;
1743 data->label_txg = 0;
1744 found = zfs_nvlist_lookup_uint64(nvlist, ZPOOL_CONFIG_POOL_TXG,
1748 printf("zfs pool txg not found\n");
1749 return ZFS_ERR_BAD_FS;
1752 /* not an active device */
1753 if (data->label_txg == 0) {
1755 printf("zpool is not active\n");
1756 return ZFS_ERR_BAD_FS;
1759 found = zfs_nvlist_lookup_uint64(nvlist, ZPOOL_CONFIG_VERSION,
1763 printf("zpool config version not found\n");
1764 return ZFS_ERR_BAD_FS;
1767 if (version > SPA_VERSION) {
1769 printf("SPA version too new %llu > %llu\n",
1770 (unsigned long long) version,
1771 (unsigned long long) SPA_VERSION);
1772 return ZFS_ERR_NOT_IMPLEMENTED_YET;
1775 vdevnvlist = zfs_nvlist_lookup_nvlist(nvlist, ZPOOL_CONFIG_VDEV_TREE);
1778 printf("ZFS config vdev tree not found\n");
1779 return ZFS_ERR_BAD_FS;
1782 found = zfs_nvlist_lookup_uint64(vdevnvlist, ZPOOL_CONFIG_ASHIFT,
1783 &data->vdev_ashift);
1787 printf("ZPOOL config ashift not found\n");
1788 return ZFS_ERR_BAD_FS;
1791 found = zfs_nvlist_lookup_uint64(nvlist, ZPOOL_CONFIG_GUID, &diskguid);
1794 printf("ZPOOL config guid not found\n");
1795 return ZFS_ERR_BAD_FS;
1798 found = zfs_nvlist_lookup_uint64(nvlist, ZPOOL_CONFIG_POOL_GUID, &data->pool_guid);
1801 printf("ZPOOL config pool guid not found\n");
1802 return ZFS_ERR_BAD_FS;
1807 printf("ZFS Pool GUID: %llu (%016llx) Label: GUID: %llu (%016llx), txg: %llu, SPA v%llu, ashift: %llu\n",
1808 (unsigned long long) data->pool_guid,
1809 (unsigned long long) data->pool_guid,
1810 (unsigned long long) diskguid,
1811 (unsigned long long) diskguid,
1812 (unsigned long long) data->label_txg,
1813 (unsigned long long) version,
1814 (unsigned long long) data->vdev_ashift);
1816 return ZFS_ERR_NONE;
1820 * vdev_label_start returns the physical disk offset (in bytes) of
1823 static uint64_t vdev_label_start(uint64_t psize, int l)
1825 return (l * sizeof(vdev_label_t) + (l < VDEV_LABELS / 2 ?
1827 VDEV_LABELS * sizeof(vdev_label_t)));
1831 zfs_unmount(struct zfs_data *data)
1833 free(data->dnode_buf);
1834 free(data->dnode_mdn);
1835 free(data->file_buf);
1840 * zfs_mount() locates a valid uberblock of the root pool and read in its MOS
1841 * to the memory address MOS.
1845 zfs_mount(device_t dev)
1847 struct zfs_data *data = 0;
1848 int label = 0, bestlabel = -1;
1850 uberblock_t *ubbest;
1851 uberblock_t *ubcur = NULL;
1856 data = malloc(sizeof(*data));
1859 memset(data, 0, sizeof(*data));
1861 ub_array = malloc(VDEV_UBERBLOCK_RING);
1867 ubbest = malloc(sizeof(*ubbest));
1873 memset(ubbest, 0, sizeof(*ubbest));
1876 * some eltorito stacks don't give us a size and
1877 * we end up setting the size to MAXUINT, further
1878 * some of these devices stop working once a single
1879 * read past the end has been issued. Checking
1880 * for a maximum part_length and skipping the backup
1881 * labels at the end of the slice/partition/device
1882 * avoids breaking down on such devices.
1885 dev->part_length == 0 ?
1886 VDEV_LABELS / 2 : VDEV_LABELS;
1888 /* Size in bytes of the device (disk or partition) aligned to label size*/
1889 uint64_t device_size =
1890 dev->part_length << SECTOR_BITS;
1892 const uint64_t alignedbytes =
1893 P2ALIGN(device_size, (uint64_t) sizeof(vdev_label_t));
1895 for (label = 0; label < vdevnum; label++) {
1896 uint64_t labelstartbytes = vdev_label_start(alignedbytes, label);
1897 uint64_t labelstart = labelstartbytes >> SECTOR_BITS;
1899 debug("zfs reading label %d at sector %llu (byte %llu)\n",
1900 label, (unsigned long long) labelstart,
1901 (unsigned long long) labelstartbytes);
1903 data->vdev_phys_sector = labelstart +
1904 ((VDEV_SKIP_SIZE + VDEV_BOOT_HEADER_SIZE) >> SECTOR_BITS);
1906 err = check_pool_label(data);
1908 printf("zfs error checking label %d\n", label);
1912 /* Read in the uberblock ring (128K). */
1913 err = zfs_devread(data->vdev_phys_sector +
1914 (VDEV_PHYS_SIZE >> SECTOR_BITS),
1915 0, VDEV_UBERBLOCK_RING, ub_array);
1917 printf("zfs error reading uberblock ring for label %d\n", label);
1921 ubcur = find_bestub(ub_array, data);
1923 printf("zfs No good uberblocks found in label %d\n", label);
1927 if (vdev_uberblock_compare(ubcur, ubbest) > 0) {
1928 /* Looks like the block is good, so use it.*/
1929 memcpy(ubbest, ubcur, sizeof(*ubbest));
1931 debug("zfs Current best uberblock found in label %d\n", label);
1936 /* We zero'd the structure to begin with. If we never assigned to it,
1937 magic will still be zero. */
1938 if (!ubbest->ub_magic) {
1939 printf("couldn't find a valid ZFS label\n");
1945 debug("zfs ubbest %p in label %d\n", ubbest, bestlabel);
1947 zfs_endian_t ub_endian =
1948 zfs_to_cpu64(ubbest->ub_magic, LITTLE_ENDIAN) == UBERBLOCK_MAGIC
1949 ? LITTLE_ENDIAN : BIG_ENDIAN;
1951 debug("zfs endian set to %s\n", !ub_endian ? "big" : "little");
1953 err = zio_read(&ubbest->ub_rootbp, ub_endian, &osp, &ospsize, data);
1956 printf("couldn't zio_read object directory\n");
1963 if (ospsize < OBJSET_PHYS_SIZE_V14) {
1964 printf("osp too small\n");
1971 /* Got the MOS. Save it at the memory addr MOS. */
1972 memmove(&(data->mos.dn), &((objset_phys_t *) osp)->os_meta_dnode, DNODE_SIZE);
1974 (zfs_to_cpu64(ubbest->ub_rootbp.blk_prop, ub_endian) >> 63) & 1;
1975 memmove(&(data->current_uberblock), ubbest, sizeof(uberblock_t));
1984 zfs_fetch_nvlist(device_t dev, char **nvlist)
1986 struct zfs_data *zfs;
1989 zfs = zfs_mount(dev);
1991 return ZFS_ERR_BAD_FS;
1992 err = int_zfs_fetch_nvlist(zfs, nvlist);
1998 * zfs_open() locates a file in the rootpool by following the
1999 * MOS and places the dnode of the file in the memory address DNODE.
2002 zfs_open(struct zfs_file *file, const char *fsfilename)
2004 struct zfs_data *data;
2008 data = zfs_mount(file->device);
2010 return ZFS_ERR_BAD_FS;
2012 err = dnode_get_fullpath(fsfilename, &(data->mdn), 0,
2013 &(data->dnode), &isfs, data);
2021 printf("Missing @ or / separator\n");
2022 return ZFS_ERR_FILE_NOT_FOUND;
2025 /* We found the dnode for this file. Verify if it is a plain file. */
2026 if (data->dnode.dn.dn_type != DMU_OT_PLAIN_FILE_CONTENTS) {
2028 printf("not a file\n");
2029 return ZFS_ERR_BAD_FILE_TYPE;
2032 /* get the file size and set the file position to 0 */
2035 * For DMU_OT_SA we will need to locate the SIZE attribute
2036 * attribute, which could be either in the bonus buffer
2037 * or the "spill" block.
2039 if (data->dnode.dn.dn_bonustype == DMU_OT_SA) {
2043 if (data->dnode.dn.dn_bonuslen != 0) {
2044 sahdrp = (sa_hdr_phys_t *) DN_BONUS(&data->dnode.dn);
2045 } else if (data->dnode.dn.dn_flags & DNODE_FLAG_SPILL_BLKPTR) {
2046 blkptr_t *bp = &data->dnode.dn.dn_spill;
2048 err = zio_read(bp, data->dnode.endian, &sahdrp, NULL, data);
2052 printf("filesystem is corrupt :(\n");
2053 return ZFS_ERR_BAD_FS;
2056 hdrsize = SA_HDR_SIZE(((sa_hdr_phys_t *) sahdrp));
2057 file->size = *(uint64_t *) ((char *) sahdrp + hdrsize + SA_SIZE_OFFSET);
2058 if ((data->dnode.dn.dn_bonuslen == 0) &&
2059 (data->dnode.dn.dn_flags & DNODE_FLAG_SPILL_BLKPTR))
2062 file->size = zfs_to_cpu64(((znode_phys_t *) DN_BONUS(&data->dnode.dn))->zp_size, data->dnode.endian);
2068 return ZFS_ERR_NONE;
2072 zfs_read(zfs_file_t file, char *buf, uint64_t len)
2074 struct zfs_data *data = (struct zfs_data *) file->data;
2075 int blksz, movesize;
2080 if (data->file_buf == NULL) {
2081 data->file_buf = malloc(SPA_MAXBLOCKSIZE);
2082 if (!data->file_buf)
2084 data->file_start = data->file_end = 0;
2088 * If offset is in memory, move it into the buffer provided and return.
2090 if (file->offset >= data->file_start
2091 && file->offset + len <= data->file_end) {
2092 memmove(buf, data->file_buf + file->offset - data->file_start,
2097 blksz = zfs_to_cpu16(data->dnode.dn.dn_datablkszsec,
2098 data->dnode.endian) << SPA_MINBLOCKSHIFT;
2101 * Entire Dnode is too big to fit into the space available. We
2102 * will need to read it in chunks. This could be optimized to
2103 * read in as large a chunk as there is space available, but for
2104 * now, this only reads in one data block at a time.
2111 * Find requested blkid and the offset within that block.
2113 uint64_t blkid = file->offset + red;
2114 blkid = do_div(blkid, blksz);
2115 free(data->file_buf);
2118 err = dmu_read(&(data->dnode), blkid, &t,
2124 data->file_start = blkid * blksz;
2125 data->file_end = data->file_start + blksz;
2127 movesize = min(length, data->file_end - (int)file->offset - red);
2129 memmove(buf, data->file_buf + file->offset + red
2130 - data->file_start, movesize);
2140 zfs_close(zfs_file_t file)
2142 zfs_unmount((struct zfs_data *) file->data);
2143 return ZFS_ERR_NONE;
2147 zfs_getmdnobj(device_t dev, const char *fsfilename,
2150 struct zfs_data *data;
2154 data = zfs_mount(dev);
2156 return ZFS_ERR_BAD_FS;
2158 err = dnode_get_fullpath(fsfilename, &(data->mdn), mdnobj,
2159 &(data->dnode), &isfs, data);
2165 fill_fs_info(struct zfs_dirhook_info *info,
2166 dnode_end_t mdn, struct zfs_data *data)
2173 memset(info, 0, sizeof(*info));
2177 if (mdn.dn.dn_type == DMU_OT_DSL_DIR) {
2178 headobj = zfs_to_cpu64(((dsl_dir_phys_t *) DN_BONUS(&mdn.dn))->dd_head_dataset_obj, mdn.endian);
2180 err = dnode_get(&(data->mos), headobj, DMU_OT_DSL_DATASET, &mdn, data);
2182 printf("zfs failed here 1\n");
2186 make_mdn(&mdn, data);
2187 err = dnode_get(&mdn, MASTER_NODE_OBJ, DMU_OT_MASTER_NODE,
2190 printf("zfs failed here 2\n");
2194 err = zap_lookup(&dn, ZFS_ROOT_OBJ, &objnum, data);
2196 printf("zfs failed here 3\n");
2200 err = dnode_get(&mdn, objnum, 0, &dn, data);
2202 printf("zfs failed here 4\n");
2207 info->mtime = zfs_to_cpu64(((znode_phys_t *) DN_BONUS(&dn.dn))->zp_mtime[0], dn.endian);
2212 static int iterate_zap(const char *name, uint64_t val, struct zfs_data *data)
2214 struct zfs_dirhook_info info;
2217 memset(&info, 0, sizeof(info));
2219 dnode_get(&(data->mdn), val, 0, &dn, data);
2221 info.mtime = zfs_to_cpu64(((znode_phys_t *) DN_BONUS(&dn.dn))->zp_mtime[0], dn.endian);
2222 info.dir = (dn.dn.dn_type == DMU_OT_DIRECTORY_CONTENTS);
2223 debug("zfs type=%d, name=%s\n",
2224 (int)dn.dn.dn_type, (char *)name);
2225 if (!data->userhook)
2227 return data->userhook(name, &info);
2230 static int iterate_zap_fs(const char *name, uint64_t val, struct zfs_data *data)
2232 struct zfs_dirhook_info info;
2235 err = dnode_get(&(data->mos), val, 0, &mdn, data);
2238 if (mdn.dn.dn_type != DMU_OT_DSL_DIR)
2241 fill_fs_info(&info, mdn, data);
2243 if (!data->userhook)
2245 return data->userhook(name, &info);
2248 static int iterate_zap_snap(const char *name, uint64_t val, struct zfs_data *data)
2250 struct zfs_dirhook_info info;
2256 err = dnode_get(&(data->mos), val, 0, &mdn, data);
2260 if (mdn.dn.dn_type != DMU_OT_DSL_DATASET)
2263 fill_fs_info(&info, mdn, data);
2265 name2 = malloc(strlen(name) + 2);
2267 memcpy(name2 + 1, name, strlen(name) + 1);
2269 ret = data->userhook(name2, &info);
2275 zfs_ls(device_t device, const char *path,
2276 int (*hook)(const char *, const struct zfs_dirhook_info *))
2278 struct zfs_data *data;
2282 data = zfs_mount(device);
2284 return ZFS_ERR_BAD_FS;
2286 data->userhook = hook;
2288 err = dnode_get_fullpath(path, &(data->mdn), 0, &(data->dnode), &isfs, data);
2294 uint64_t childobj, headobj;
2297 struct zfs_dirhook_info info;
2299 fill_fs_info(&info, data->dnode, data);
2302 childobj = zfs_to_cpu64(((dsl_dir_phys_t *) DN_BONUS(&data->dnode.dn))->dd_child_dir_zapobj, data->dnode.endian);
2303 headobj = zfs_to_cpu64(((dsl_dir_phys_t *) DN_BONUS(&data->dnode.dn))->dd_head_dataset_obj, data->dnode.endian);
2304 err = dnode_get(&(data->mos), childobj,
2305 DMU_OT_DSL_DIR_CHILD_MAP, &dn, data);
2312 zap_iterate(&dn, iterate_zap_fs, data);
2314 err = dnode_get(&(data->mos), headobj, DMU_OT_DSL_DATASET, &dn, data);
2320 snapobj = zfs_to_cpu64(((dsl_dataset_phys_t *) DN_BONUS(&dn.dn))->ds_snapnames_zapobj, dn.endian);
2322 err = dnode_get(&(data->mos), snapobj,
2323 DMU_OT_DSL_DS_SNAP_MAP, &dn, data);
2329 zap_iterate(&dn, iterate_zap_snap, data);
2331 if (data->dnode.dn.dn_type != DMU_OT_DIRECTORY_CONTENTS) {
2333 printf("not a directory\n");
2334 return ZFS_ERR_BAD_FILE_TYPE;
2336 zap_iterate(&(data->dnode), iterate_zap, data);
2339 return ZFS_ERR_NONE;