ctree.h 12.8 KB
Newer Older
C
Chris Mason 已提交
1 2
#ifndef __BTRFS__
#define __BTRFS__
3

4
#include "list.h"
C
Chris Mason 已提交
5
#include "kerncompat.h"
6

7
#define BTRFS_MAGIC "_BtRfS_M"
8

9 10 11 12
#define BTRFS_ROOT_TREE_OBJECTID 1
#define BTRFS_EXTENT_TREE_OBJECTID 2
#define BTRFS_FS_TREE_OBJECTID 3

13 14 15 16 17 18 19 20 21
/*
 * the key defines the order in the tree, and so it also defines (optimal)
 * block layout.  objectid corresonds to the inode number.  The flags
 * tells us things about the object, and is a kind of stream selector.
 * so for a given inode, keys with flags of 1 might refer to the inode
 * data, flags of 2 may point to file data in the btree and flags == 3
 * may point to extents.
 *
 * offset is the starting byte offset for this key in the stream.
C
Chris Mason 已提交
22 23 24 25
 *
 * btrfs_disk_key is in disk byte order.  struct btrfs_key is always
 * in cpu native order.  Otherwise they are identical and their sizes
 * should be the same (ie both packed)
26
 */
C
Chris Mason 已提交
27 28 29
struct btrfs_disk_key {
	__le64 objectid;
	__le64 offset;
30
	__le32 flags;
C
Chris Mason 已提交
31 32 33
} __attribute__ ((__packed__));

struct btrfs_key {
34 35
	u64 objectid;
	u64 offset;
36
	u32 flags;
37 38
} __attribute__ ((__packed__));

39 40 41
/*
 * every tree block (leaf or node) starts with this header.
 */
42
struct btrfs_header {
43
	u8 fsid[16]; /* FS specific uuid */
44 45 46 47 48 49
	__le64 blocknr; /* which block this node is supposed to live in */
	__le64 parentid; /* objectid of the tree root */
	__le32 csum;
	__le32 ham;
	__le16 nritems;
	__le16 flags;
50
	/* generation flags to be added */
51 52
} __attribute__ ((__packed__));

C
Chris Mason 已提交
53
#define BTRFS_MAX_LEVEL 8
C
Chris Mason 已提交
54 55 56 57 58
#define BTRFS_NODEPTRS_PER_BLOCK(r) (((r)->blocksize - \
			        sizeof(struct btrfs_header)) / \
			       (sizeof(struct btrfs_disk_key) + sizeof(u64)))
#define __BTRFS_LEAF_DATA_SIZE(bs) ((bs) - sizeof(struct btrfs_header))
#define BTRFS_LEAF_DATA_SIZE(r) (__BTRFS_LEAF_DATA_SIZE(r->blocksize))
59

C
Chris Mason 已提交
60
struct btrfs_buffer;
61 62 63 64
/*
 * the super block basically lists the main trees of the FS
 * it currently lacks any block count etc etc
 */
C
Chris Mason 已提交
65
struct btrfs_super_block {
66 67 68 69
	u8 fsid[16];    /* FS specific uuid */
	__le64 blocknr; /* this block number */
	__le32 csum;
	__le64 magic;
C
Chris Mason 已提交
70
	__le32 blocksize;
71 72 73 74
	__le64 generation;
	__le64 root;
	__le64 total_blocks;
	__le64 blocks_used;
C
Chris Mason 已提交
75 76
} __attribute__ ((__packed__));

77
/*
78
 * A leaf is full of items. offset and size tell us where to find
79 80
 * the item in the leaf (relative to the start of the data area)
 */
C
Chris Mason 已提交
81
struct btrfs_item {
C
Chris Mason 已提交
82
	struct btrfs_disk_key key;
C
Chris Mason 已提交
83
	__le32 offset;
C
Chris Mason 已提交
84
	__le16 size;
85 86
} __attribute__ ((__packed__));

87 88 89 90 91 92 93
/*
 * leaves have an item area and a data area:
 * [item0, item1....itemN] [free space] [dataN...data1, data0]
 *
 * The data is separate from the items to get the keys closer together
 * during searches.
 */
C
Chris Mason 已提交
94
struct btrfs_leaf {
95
	struct btrfs_header header;
C
Chris Mason 已提交
96
	struct btrfs_item items[];
97 98
} __attribute__ ((__packed__));

99 100 101 102
/*
 * all non-leaf blocks are nodes, they hold only keys and pointers to
 * other blocks
 */
C
Chris Mason 已提交
103 104 105 106 107
struct btrfs_key_ptr {
	struct btrfs_disk_key key;
	__le64 blockptr;
} __attribute__ ((__packed__));

C
Chris Mason 已提交
108
struct btrfs_node {
109
	struct btrfs_header header;
C
Chris Mason 已提交
110
	struct btrfs_key_ptr ptrs[];
111 112
} __attribute__ ((__packed__));

113
/*
C
Chris Mason 已提交
114 115
 * btrfs_paths remember the path taken from the root down to the leaf.
 * level 0 is always the leaf, and nodes[1...BTRFS_MAX_LEVEL] will point
116 117 118 119 120
 * to any other levels that are present.
 *
 * The slots array records the index of the item or block pointer
 * used while walking the tree.
 */
C
Chris Mason 已提交
121 122 123
struct btrfs_path {
	struct btrfs_buffer *nodes[BTRFS_MAX_LEVEL];
	int slots[BTRFS_MAX_LEVEL];
124
};
C
Chris Mason 已提交
125

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/*
 * items in the extent btree are used to record the objectid of the
 * owner of the block and the number of references
 */
struct btrfs_extent_item {
	__le32 refs;
	__le64 owner;
} __attribute__ ((__packed__));

struct btrfs_dir_item {
	__le64 objectid;
	__le16 flags;
	u8 type;
} __attribute__ ((__packed__));

struct btrfs_root_item {
	__le64 blocknr;
	__le32 flags;
	__le64 block_limit;
	__le64 blocks_used;
	__le32 refs;
};

/*
 * in ram representation of the tree.  extent_root is used for all allocations
 * and for the extent tree extent_root root.  current_insert is used
 * only for the extent tree.
 */
struct btrfs_root {
	struct btrfs_buffer *node;
	struct btrfs_buffer *commit_root;
	struct btrfs_root *extent_root;
	struct btrfs_root *tree_root;
	struct btrfs_key current_insert;
	struct btrfs_key last_insert;
	int fp;
	struct radix_tree_root cache_radix;
	struct radix_tree_root pinned_radix;
	struct list_head trans;
	struct list_head cache;
	int cache_size;
	int ref_cows;
	struct btrfs_root_item root_item;
	struct btrfs_key root_key;
	u32 blocksize;
};


/* the lower bits in the key flags defines the item type */
#define BTRFS_KEY_TYPE_MAX	256
#define BTRFS_KEY_TYPE_MASK	(BTRFS_KEY_TYPE_MAX - 1)
#define BTRFS_INODE_ITEM_KEY	1
#define BTRFS_DIR_ITEM_KEY	2
#define BTRFS_ROOT_ITEM_KEY	3
#define BTRFS_EXTENT_ITEM_KEY	4
#define BTRFS_STRING_ITEM_KEY	5

static inline u64 btrfs_dir_objectid(struct btrfs_dir_item *d)
{
	return le64_to_cpu(d->objectid);
}

static inline void btrfs_set_dir_objectid(struct btrfs_dir_item *d, u64 val)
{
	d->objectid = cpu_to_le64(val);
}

static inline u16 btrfs_dir_flags(struct btrfs_dir_item *d)
{
	return le16_to_cpu(d->flags);
}

static inline void btrfs_set_dir_flags(struct btrfs_dir_item *d, u16 val)
{
	d->flags = cpu_to_le16(val);
}

static inline u8 btrfs_dir_type(struct btrfs_dir_item *d)
{
	return d->type;
}

static inline void btrfs_set_dir_type(struct btrfs_dir_item *d, u8 val)
{
	d->type = val;
}


C
Chris Mason 已提交
214
static inline u64 btrfs_extent_owner(struct btrfs_extent_item *ei)
C
Chris Mason 已提交
215 216 217 218
{
	return le64_to_cpu(ei->owner);
}

C
Chris Mason 已提交
219
static inline void btrfs_set_extent_owner(struct btrfs_extent_item *ei, u64 val)
C
Chris Mason 已提交
220 221 222 223
{
	ei->owner = cpu_to_le64(val);
}

C
Chris Mason 已提交
224
static inline u32 btrfs_extent_refs(struct btrfs_extent_item *ei)
C
Chris Mason 已提交
225 226 227 228
{
	return le32_to_cpu(ei->refs);
}

C
Chris Mason 已提交
229
static inline void btrfs_set_extent_refs(struct btrfs_extent_item *ei, u32 val)
C
Chris Mason 已提交
230 231 232 233
{
	ei->refs = cpu_to_le32(val);
}

C
Chris Mason 已提交
234
static inline u64 btrfs_node_blockptr(struct btrfs_node *n, int nr)
235
{
C
Chris Mason 已提交
236
	return le64_to_cpu(n->ptrs[nr].blockptr);
237 238
}

C
Chris Mason 已提交
239 240
static inline void btrfs_set_node_blockptr(struct btrfs_node *n, int nr,
					   u64 val)
241
{
C
Chris Mason 已提交
242
	n->ptrs[nr].blockptr = cpu_to_le64(val);
243 244
}

C
Chris Mason 已提交
245
static inline u32 btrfs_item_offset(struct btrfs_item *item)
C
Chris Mason 已提交
246
{
C
Chris Mason 已提交
247
	return le32_to_cpu(item->offset);
C
Chris Mason 已提交
248 249
}

C
Chris Mason 已提交
250
static inline void btrfs_set_item_offset(struct btrfs_item *item, u32 val)
C
Chris Mason 已提交
251
{
C
Chris Mason 已提交
252
	item->offset = cpu_to_le32(val);
C
Chris Mason 已提交
253 254
}

C
Chris Mason 已提交
255
static inline u32 btrfs_item_end(struct btrfs_item *item)
C
Chris Mason 已提交
256
{
C
Chris Mason 已提交
257
	return le32_to_cpu(item->offset) + le16_to_cpu(item->size);
C
Chris Mason 已提交
258 259 260 261 262 263 264 265 266 267 268 269
}

static inline u16 btrfs_item_size(struct btrfs_item *item)
{
	return le16_to_cpu(item->size);
}

static inline void btrfs_set_item_size(struct btrfs_item *item, u16 val)
{
	item->size = cpu_to_le16(val);
}

C
Chris Mason 已提交
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
static inline void btrfs_disk_key_to_cpu(struct btrfs_key *cpu,
					 struct btrfs_disk_key *disk)
{
	cpu->offset = le64_to_cpu(disk->offset);
	cpu->flags = le32_to_cpu(disk->flags);
	cpu->objectid = le64_to_cpu(disk->objectid);
}

static inline void btrfs_cpu_key_to_disk(struct btrfs_disk_key *disk,
					 struct btrfs_key *cpu)
{
	disk->offset = cpu_to_le64(cpu->offset);
	disk->flags = cpu_to_le32(cpu->flags);
	disk->objectid = cpu_to_le64(cpu->objectid);
}

286
static inline u64 btrfs_disk_key_objectid(struct btrfs_disk_key *disk)
C
Chris Mason 已提交
287 288 289 290
{
	return le64_to_cpu(disk->objectid);
}

291 292
static inline void btrfs_set_disk_key_objectid(struct btrfs_disk_key *disk,
					       u64 val)
C
Chris Mason 已提交
293 294 295 296
{
	disk->objectid = cpu_to_le64(val);
}

297
static inline u64 btrfs_disk_key_offset(struct btrfs_disk_key *disk)
C
Chris Mason 已提交
298 299 300 301
{
	return le64_to_cpu(disk->offset);
}

302 303
static inline void btrfs_set_disk_key_offset(struct btrfs_disk_key *disk,
					     u64 val)
C
Chris Mason 已提交
304 305 306 307
{
	disk->offset = cpu_to_le64(val);
}

308
static inline u32 btrfs_disk_key_flags(struct btrfs_disk_key *disk)
C
Chris Mason 已提交
309 310 311 312
{
	return le32_to_cpu(disk->flags);
}

313 314
static inline void btrfs_set_disk_key_flags(struct btrfs_disk_key *disk,
					    u32 val)
C
Chris Mason 已提交
315 316 317 318
{
	disk->flags = cpu_to_le32(val);
}

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
static inline u32 btrfs_key_type(struct btrfs_key *key)
{
	return key->flags & BTRFS_KEY_TYPE_MASK;
}

static inline u32 btrfs_disk_key_type(struct btrfs_disk_key *key)
{
	return le32_to_cpu(key->flags) & BTRFS_KEY_TYPE_MASK;
}

static inline void btrfs_set_key_type(struct btrfs_key *key, u32 type)
{
	BUG_ON(type >= BTRFS_KEY_TYPE_MAX);
	key->flags = (key->flags & ~((u64)BTRFS_KEY_TYPE_MASK)) | type;
}

static inline void btrfs_set_disk_key_type(struct btrfs_disk_key *key, u32 type)
{
	u32 flags = btrfs_disk_key_flags(key);
	BUG_ON(type >= BTRFS_KEY_TYPE_MAX);
	flags = (flags & ~((u64)BTRFS_KEY_TYPE_MASK)) | type;
	btrfs_set_disk_key_flags(key, flags);
}



345
static inline u64 btrfs_header_blocknr(struct btrfs_header *h)
346
{
347
	return le64_to_cpu(h->blocknr);
348 349
}

350
static inline void btrfs_set_header_blocknr(struct btrfs_header *h, u64 blocknr)
351
{
352
	h->blocknr = cpu_to_le64(blocknr);
353 354
}

355
static inline u64 btrfs_header_parentid(struct btrfs_header *h)
356
{
357
	return le64_to_cpu(h->parentid);
358 359
}

360 361
static inline void btrfs_set_header_parentid(struct btrfs_header *h,
					     u64 parentid)
362
{
363
	h->parentid = cpu_to_le64(parentid);
364 365
}

366
static inline u16 btrfs_header_nritems(struct btrfs_header *h)
367
{
368
	return le16_to_cpu(h->nritems);
369 370
}

371
static inline void btrfs_set_header_nritems(struct btrfs_header *h, u16 val)
372
{
373
	h->nritems = cpu_to_le16(val);
374 375
}

376
static inline u16 btrfs_header_flags(struct btrfs_header *h)
377
{
378
	return le16_to_cpu(h->flags);
379 380
}

381
static inline void btrfs_set_header_flags(struct btrfs_header *h, u16 val)
382
{
383
	h->flags = cpu_to_le16(val);
384 385
}

386
static inline int btrfs_header_level(struct btrfs_header *h)
387
{
C
Chris Mason 已提交
388
	return btrfs_header_flags(h) & (BTRFS_MAX_LEVEL - 1);
389 390
}

391
static inline void btrfs_set_header_level(struct btrfs_header *h, int level)
392
{
393
	u16 flags;
C
Chris Mason 已提交
394 395
	BUG_ON(level > BTRFS_MAX_LEVEL);
	flags = btrfs_header_flags(h) & ~(BTRFS_MAX_LEVEL - 1);
396 397 398
	btrfs_set_header_flags(h, flags | level);
}

C
Chris Mason 已提交
399
static inline int btrfs_is_leaf(struct btrfs_node *n)
400 401 402 403
{
	return (btrfs_header_level(&n->header) == 0);
}

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
static inline u64 btrfs_root_blocknr(struct btrfs_root_item *item)
{
	return le64_to_cpu(item->blocknr);
}

static inline void btrfs_set_root_blocknr(struct btrfs_root_item *item, u64 val)
{
	item->blocknr = cpu_to_le64(val);
}

static inline u32 btrfs_root_refs(struct btrfs_root_item *item)
{
	return le32_to_cpu(item->refs);
}

static inline void btrfs_set_root_refs(struct btrfs_root_item *item, u32 val)
{
	item->refs = cpu_to_le32(val);
}

static inline u64 btrfs_super_blocknr(struct btrfs_super_block *s)
{
	return le64_to_cpu(s->blocknr);
}

static inline void btrfs_set_super_blocknr(struct btrfs_super_block *s, u64 val)
{
	s->blocknr = cpu_to_le64(val);
}

static inline u64 btrfs_super_root(struct btrfs_super_block *s)
{
	return le64_to_cpu(s->root);
}

static inline void btrfs_set_super_root(struct btrfs_super_block *s, u64 val)
{
	s->root = cpu_to_le64(val);
}

static inline u64 btrfs_super_total_blocks(struct btrfs_super_block *s)
{
	return le64_to_cpu(s->total_blocks);
}

static inline void btrfs_set_super_total_blocks(struct btrfs_super_block *s,
						u64 val)
{
	s->total_blocks = cpu_to_le64(val);
}

static inline u64 btrfs_super_blocks_used(struct btrfs_super_block *s)
{
	return le64_to_cpu(s->blocks_used);
}

static inline void btrfs_set_super_blocks_used(struct btrfs_super_block *s,
						u64 val)
{
	s->blocks_used = cpu_to_le64(val);
}

C
Chris Mason 已提交
466
static inline u32 btrfs_super_blocksize(struct btrfs_super_block *s)
467
{
C
Chris Mason 已提交
468
	return le32_to_cpu(s->blocksize);
469 470 471
}

static inline void btrfs_set_super_blocksize(struct btrfs_super_block *s,
C
Chris Mason 已提交
472 473 474 475 476 477
						u32 val)
{
	s->blocksize = cpu_to_le32(val);
}

static inline u8 *btrfs_leaf_data(struct btrfs_leaf *l)
478
{
C
Chris Mason 已提交
479
	return (u8 *)l->items;
480
}
481 482
/* helper function to cast into the data area of the leaf. */
#define btrfs_item_ptr(leaf, slot, type) \
C
Chris Mason 已提交
483 484
	((type *)(btrfs_leaf_data(leaf) + \
	btrfs_item_offset((leaf)->items + (slot))))
485

C
Chris Mason 已提交
486 487 488 489 490 491 492 493 494
struct btrfs_buffer *btrfs_alloc_free_block(struct btrfs_root *root);
int btrfs_inc_ref(struct btrfs_root *root, struct btrfs_buffer *buf);
int btrfs_free_extent(struct btrfs_root *root, u64 blocknr, u64 num_blocks);
int btrfs_search_slot(struct btrfs_root *root, struct btrfs_key *key,
		struct btrfs_path *p, int ins_len, int cow);
void btrfs_release_path(struct btrfs_root *root, struct btrfs_path *p);
void btrfs_init_path(struct btrfs_path *p);
int btrfs_del_item(struct btrfs_root *root, struct btrfs_path *path);
int btrfs_insert_item(struct btrfs_root *root, struct btrfs_key *key,
495 496 497
		void *data, u32 data_size);
int btrfs_insert_empty_item(struct btrfs_root *root, struct btrfs_path *path,
			    struct btrfs_key *cpu_key, u32 data_size);
C
Chris Mason 已提交
498
int btrfs_next_leaf(struct btrfs_root *root, struct btrfs_path *path);
C
Chris Mason 已提交
499
int btrfs_leaf_free_space(struct btrfs_root *root, struct btrfs_leaf *leaf);
C
Chris Mason 已提交
500 501
int btrfs_drop_snapshot(struct btrfs_root *root, struct btrfs_buffer *snap);
int btrfs_finish_extent_commit(struct btrfs_root *root);
502 503 504 505 506 507 508
int btrfs_del_root(struct btrfs_root *root, struct btrfs_key *key);
int btrfs_insert_root(struct btrfs_root *root, struct btrfs_key *key,
		      struct btrfs_root_item *item);
int btrfs_update_root(struct btrfs_root *root, struct btrfs_key *key,
		      struct btrfs_root_item *item);
int btrfs_find_last_root(struct btrfs_root *root, u64 objectid,
			struct btrfs_root_item *item, struct btrfs_key *key);
509
#endif