fsys_zfs.h revision 2dd5848fa9da42f374782814f362e0afda124ecd
1b1b8ab3lling/*
2b1b8ab3lling *  GRUB  --  GRand Unified Bootloader
3b1b8ab3lling *  Copyright (C) 1999,2000,2001,2002,2003,2004  Free Software Foundation, Inc.
4b1b8ab3lling *
5b1b8ab3lling *  This program is free software; you can redistribute it and/or modify
6b1b8ab3lling *  it under the terms of the GNU General Public License as published by
7b1b8ab3lling *  the Free Software Foundation; either version 2 of the License, or
8b1b8ab3lling *  (at your option) any later version.
9b1b8ab3lling *
10b1b8ab3lling *  This program is distributed in the hope that it will be useful,
11b1b8ab3lling *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12b1b8ab3lling *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13b1b8ab3lling *  GNU General Public License for more details.
14b1b8ab3lling *
15b1b8ab3lling *  You should have received a copy of the GNU General Public License
16b1b8ab3lling *  along with this program; if not, write to the Free Software
17b1b8ab3lling *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18b1b8ab3lling */
19b1b8ab3lling/*
206e1f5caNeil Perrin * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
21b1b8ab3lling * Use is subject to license terms.
22b1b8ab3lling */
23b1b8ab3lling#ifndef _FSYS_ZFS_H
24b1b8ab3lling#define	_FSYS_ZFS_H
25b1b8ab3lling
26b1b8ab3lling#ifdef	FSYS_ZFS
27b1b8ab3lling
282dd5848Mark Johnson#ifndef	FSIMAGE
29b1b8ab3llingtypedef unsigned long long uint64_t;
30b1b8ab3llingtypedef unsigned int uint32_t;
31b1b8ab3llingtypedef unsigned short uint16_t;
32b1b8ab3llingtypedef unsigned char uint8_t;
33b1b8ab3llingtypedef unsigned char uchar_t;
34b1b8ab3lling
35b1b8ab3lling#if defined(_LP64) || defined(_I32LPx)
36b1b8ab3llingtypedef	unsigned long size_t;
37b1b8ab3lling#else
38b1b8ab3llingtypedef	unsigned int size_t;
39b1b8ab3lling#endif
402dd5848Mark Johnson#else
412dd5848Mark Johnson#include "fsi_zfs.h"
422dd5848Mark Johnson#endif	/* !FSIMAGE */
43b1b8ab3lling
44b1b8ab3lling#include <zfs-include/zfs.h>
45b1b8ab3lling#include <zfs-include/dmu.h>
46b1b8ab3lling#include <zfs-include/spa.h>
47b1b8ab3lling#include <zfs-include/zio.h>
48b1b8ab3lling#include <zfs-include/zio_checksum.h>
49b1b8ab3lling#include <zfs-include/vdev_impl.h>
50b1b8ab3lling#include <zfs-include/zap_impl.h>
51b1b8ab3lling#include <zfs-include/zap_leaf.h>
52b1b8ab3lling#include <zfs-include/uberblock_impl.h>
53b1b8ab3lling#include <zfs-include/dnode.h>
54b1b8ab3lling#include <zfs-include/dsl_dir.h>
55b1b8ab3lling#include <zfs-include/zfs_acl.h>
56b1b8ab3lling#include <zfs-include/zfs_znode.h>
57b1b8ab3lling#include <zfs-include/dsl_dataset.h>
58b1b8ab3lling#include <zfs-include/zil.h>
59b1b8ab3lling#include <zfs-include/dmu_objset.h>
600a586ceMark Shellenbaum#include <zfs-include/sa_impl.h>
61b1b8ab3lling
62b1b8ab3lling/*
63b1b8ab3lling * Global Memory addresses to store MOS and DNODE data
64b1b8ab3lling */
65843e198johnlev#define	MOS		((dnode_phys_t *)\
66bc896b5johnlev	(RAW_ADDR((mbi.mem_upper << 10) + 0x100000) - ZFS_SCRATCH_SIZE))
67ae8180dlling#define	DNODE		(MOS+1) /* move sizeof(dnode_phys_t) bytes */
68ae8180dlling#define	ZFS_SCRATCH	((char *)(DNODE+1))
69b1b8ab3lling
70b1b8ab3lling/*
71b1b8ab3lling * Verify dnode type.
72b1b8ab3lling * Can only be used in functions returning non-0 for failure.
73b1b8ab3lling */
74b1b8ab3lling#define	VERIFY_DN_TYPE(dnp, type) \
75b1b8ab3lling	if (type && (dnp)->dn_type != type) { \
76b1b8ab3lling		return (ERR_FSYS_CORRUPT); \
77b1b8ab3lling	}
78b1b8ab3lling
79b1b8ab3lling/*
80b1b8ab3lling * Verify object set type.
81b1b8ab3lling * Can only be used in functions returning 0 for failure.
82b1b8ab3lling */
83b1b8ab3lling#define	VERIFY_OS_TYPE(osp, type) \
84b1b8ab3lling	if (type && (osp)->os_type != type) { \
85b1b8ab3lling		errnum = ERR_FSYS_CORRUPT; \
86b1b8ab3lling		return (0); \
87b1b8ab3lling	}
88b1b8ab3lling
89b1b8ab3lling#define	ZPOOL_PROP_BOOTFS		"bootfs"
90b1b8ab3lling
91b1b8ab3lling/* General macros */
92b1b8ab3lling#define	BSWAP_8(x)	((x) & 0xff)
93b1b8ab3lling#define	BSWAP_16(x)	((BSWAP_8(x) << 8) | BSWAP_8((x) >> 8))
94b1b8ab3lling#define	BSWAP_32(x)	((BSWAP_16(x) << 16) | BSWAP_16((x) >> 16))
95b1b8ab3lling#define	BSWAP_64(x)	((BSWAP_32(x) << 32) | BSWAP_32((x) >> 32))
96b1b8ab3lling#define	P2ROUNDUP(x, align)	(-(-(x) & -(align)))
97b1b8ab3lling
98b1b8ab3lling/*
99b1b8ab3lling * XXX Match these macro up with real zfs once we have nvlist support so that we
100b1b8ab3lling * can support large sector disks.
101b1b8ab3lling */
102b1b8ab3lling#define	UBERBLOCK_SIZE		(1ULL << UBERBLOCK_SHIFT)
103b1b8ab3lling#undef	offsetof
104b1b8ab3lling#define	offsetof(t, m)   ((int)&(((t *)0)->m))
105b1b8ab3lling#define	VDEV_UBERBLOCK_SHIFT	UBERBLOCK_SHIFT
106b1b8ab3lling#define	VDEV_UBERBLOCK_OFFSET(n) \
107b1b8ab3llingoffsetof(vdev_label_t, vl_uberblock[(n) << VDEV_UBERBLOCK_SHIFT])
108b1b8ab3lling
109b1b8ab3llingtypedef struct uberblock uberblock_t;
110b1b8ab3lling
111b1b8ab3lling/* XXX Uberblock_phys_t is no longer in the kernel zfs */
112b1b8ab3llingtypedef struct uberblock_phys {
113b1b8ab3lling	uberblock_t	ubp_uberblock;
114b1b8ab3lling	char		ubp_pad[UBERBLOCK_SIZE - sizeof (uberblock_t) -
1156e1f5caNeil Perrin				sizeof (zio_eck_t)];
1166e1f5caNeil Perrin	zio_eck_t	ubp_zec;
117b1b8ab3lling} uberblock_phys_t;
118b1b8ab3lling
119b1b8ab3lling/*
120b1b8ab3lling * Macros to get fields in a bp or DVA.
121b1b8ab3lling */
122b1b8ab3lling#define	P2PHASE(x, align)		((x) & ((align) - 1))
123b1b8ab3lling#define	DVA_OFFSET_TO_PHYS_SECTOR(offset) \
124b1b8ab3lling	((offset + VDEV_LABEL_START_SIZE) >> SPA_MINBLOCKSHIFT)
125b1b8ab3lling
126b1b8ab3lling/*
127e23347bEric Taylor * return x rounded down to an align boundary
128e23347bEric Taylor * eg, P2ALIGN(1200, 1024) == 1024 (1*align)
129e23347bEric Taylor * eg, P2ALIGN(1024, 1024) == 1024 (1*align)
130e23347bEric Taylor * eg, P2ALIGN(0x1234, 0x100) == 0x1200 (0x12*align)
131e23347bEric Taylor * eg, P2ALIGN(0x5600, 0x100) == 0x5600 (0x56*align)
132e23347bEric Taylor */
133e23347bEric Taylor#define	P2ALIGN(x, align)		((x) & -(align))
134e23347bEric Taylor
135e23347bEric Taylor/*
136b1b8ab3lling * For nvlist manipulation. (from nvpair.h)
137b1b8ab3lling */
138b1b8ab3lling#define	NV_ENCODE_NATIVE	0
139b1b8ab3lling#define	NV_ENCODE_XDR		1
140b1b8ab3lling#define	HOST_ENDIAN		1	/* for x86 machine */
141b1b8ab3lling#define	DATA_TYPE_UINT64	8
142b1b8ab3lling#define	DATA_TYPE_STRING	9
143e7cbe64gw#define	DATA_TYPE_NVLIST	19
144e7cbe64gw#define	DATA_TYPE_NVLIST_ARRAY	20
145b1b8ab3lling
146b1b8ab3lling/*
147b1b8ab3lling * Decompression Entry - lzjb
148b1b8ab3lling */
149b1b8ab3lling#ifndef	NBBY
150b1b8ab3lling#define	NBBY	8
151b1b8ab3lling#endif
152b1b8ab3lling
153b1b8ab3llingtypedef int zfs_decomp_func_t(void *s_start, void *d_start, size_t s_len,
154b1b8ab3lling			size_t d_len);
155b1b8ab3llingtypedef struct decomp_entry {
156b1b8ab3lling	char *name;
157b1b8ab3lling	zfs_decomp_func_t *decomp_func;
158b1b8ab3lling} decomp_entry_t;
159b1b8ab3lling
160b1b8ab3lling/*
161b1b8ab3lling * FAT ZAP data structures
162b1b8ab3lling */
163b1b8ab3lling#define	ZFS_CRC64_POLY 0xC96C5795D7870F42ULL /* ECMA-182, reflected form */
164b1b8ab3lling#define	ZAP_HASH_IDX(hash, n)	(((n) == 0) ? 0 : ((hash) >> (64 - (n))))
165b1b8ab3lling#define	CHAIN_END	0xffff	/* end of the chunk chain */
166b1b8ab3lling
167b1b8ab3lling/*
168b1b8ab3lling * The amount of space within the chunk available for the array is:
169b1b8ab3lling * chunk size - space for type (1) - space for next pointer (2)
170b1b8ab3lling */
171b1b8ab3lling#define	ZAP_LEAF_ARRAY_BYTES (ZAP_LEAF_CHUNKSIZE - 3)
172b1b8ab3lling
173b1b8ab3lling#define	ZAP_LEAF_HASH_SHIFT(bs)	(bs - 5)
174b1b8ab3lling#define	ZAP_LEAF_HASH_NUMENTRIES(bs) (1 << ZAP_LEAF_HASH_SHIFT(bs))
175b1b8ab3lling#define	LEAF_HASH(bs, h) \
176b1b8ab3lling	((ZAP_LEAF_HASH_NUMENTRIES(bs)-1) & \
177b1b8ab3lling	((h) >> (64 - ZAP_LEAF_HASH_SHIFT(bs)-l->l_hdr.lh_prefix_len)))
178b1b8ab3lling
179b1b8ab3lling/*
180b1b8ab3lling * The amount of space available for chunks is:
181b1b8ab3lling * block size shift - hash entry size (2) * number of hash
182b1b8ab3lling * entries - header space (2*chunksize)
183b1b8ab3lling */
184b1b8ab3lling#define	ZAP_LEAF_NUMCHUNKS(bs) \
185b1b8ab3lling	(((1<<bs) - 2*ZAP_LEAF_HASH_NUMENTRIES(bs)) / \
186b1b8ab3lling	ZAP_LEAF_CHUNKSIZE - 2)
187b1b8ab3lling
188b1b8ab3lling/*
189b1b8ab3lling * The chunks start immediately after the hash table.  The end of the
190b1b8ab3lling * hash table is at l_hash + HASH_NUMENTRIES, which we simply cast to a
191b1b8ab3lling * chunk_t.
192b1b8ab3lling */
193b1b8ab3lling#define	ZAP_LEAF_CHUNK(l, bs, idx) \
194b1b8ab3lling	((zap_leaf_chunk_t *)(l->l_hash + ZAP_LEAF_HASH_NUMENTRIES(bs)))[idx]
195b1b8ab3lling#define	ZAP_LEAF_ENTRY(l, bs, idx) (&ZAP_LEAF_CHUNK(l, bs, idx).l_entry)
196b1b8ab3lling
197b1b8ab3llingextern void fletcher_2_native(const void *, uint64_t, zio_cksum_t *);
198b1b8ab3llingextern void fletcher_2_byteswap(const void *, uint64_t, zio_cksum_t *);
199b1b8ab3llingextern void fletcher_4_native(const void *, uint64_t, zio_cksum_t *);
200b1b8ab3llingextern void fletcher_4_byteswap(const void *, uint64_t, zio_cksum_t *);
201b1b8ab3llingextern void zio_checksum_SHA256(const void *, uint64_t, zio_cksum_t *);
202b1b8ab3llingextern int lzjb_decompress(void *, void *, size_t, size_t);
203b1b8ab3lling
204b1b8ab3lling#endif	/* FSYS_ZFS */
205b1b8ab3lling
206b1b8ab3lling#endif /* !_FSYS_ZFS_H */
207