5 #include "kerncompat.h"
7 struct btrfs_trans_handle;
9 #define BTRFS_MAGIC "_BtRfS_M"
11 #define BTRFS_ROOT_TREE_OBJECTID 1
12 #define BTRFS_EXTENT_TREE_OBJECTID 2
13 #define BTRFS_INODE_MAP_OBJECTID 3
14 #define BTRFS_FS_TREE_OBJECTID 4
17 * the key defines the order in the tree, and so it also defines (optimal)
18 * block layout. objectid corresonds to the inode number. The flags
19 * tells us things about the object, and is a kind of stream selector.
20 * so for a given inode, keys with flags of 1 might refer to the inode
21 * data, flags of 2 may point to file data in the btree and flags == 3
22 * may point to extents.
24 * offset is the starting byte offset for this key in the stream.
26 * btrfs_disk_key is in disk byte order. struct btrfs_key is always
27 * in cpu native order. Otherwise they are identical and their sizes
28 * should be the same (ie both packed)
30 struct btrfs_disk_key {
34 } __attribute__ ((__packed__));
40 } __attribute__ ((__packed__));
43 * every tree block (leaf or node) starts with this header.
46 u8 fsid[16]; /* FS specific uuid */
47 __le64 blocknr; /* which block this node is supposed to live in */
48 __le64 parentid; /* objectid of the tree root */
53 /* generation flags to be added */
54 } __attribute__ ((__packed__));
56 #define BTRFS_MAX_LEVEL 8
57 #define BTRFS_NODEPTRS_PER_BLOCK(r) (((r)->blocksize - \
58 sizeof(struct btrfs_header)) / \
59 (sizeof(struct btrfs_disk_key) + sizeof(u64)))
60 #define __BTRFS_LEAF_DATA_SIZE(bs) ((bs) - sizeof(struct btrfs_header))
61 #define BTRFS_LEAF_DATA_SIZE(r) (__BTRFS_LEAF_DATA_SIZE(r->blocksize))
65 * the super block basically lists the main trees of the FS
66 * it currently lacks any block count etc etc
68 struct btrfs_super_block {
69 u8 fsid[16]; /* FS specific uuid */
70 __le64 blocknr; /* this block number */
78 } __attribute__ ((__packed__));
81 * A leaf is full of items. offset and size tell us where to find
82 * the item in the leaf (relative to the start of the data area)
85 struct btrfs_disk_key key;
88 } __attribute__ ((__packed__));
91 * leaves have an item area and a data area:
92 * [item0, item1....itemN] [free space] [dataN...data1, data0]
94 * The data is separate from the items to get the keys closer together
98 struct btrfs_header header;
99 struct btrfs_item items[];
100 } __attribute__ ((__packed__));
103 * all non-leaf blocks are nodes, they hold only keys and pointers to
106 struct btrfs_key_ptr {
107 struct btrfs_disk_key key;
109 } __attribute__ ((__packed__));
112 struct btrfs_header header;
113 struct btrfs_key_ptr ptrs[];
114 } __attribute__ ((__packed__));
117 * btrfs_paths remember the path taken from the root down to the leaf.
118 * level 0 is always the leaf, and nodes[1...BTRFS_MAX_LEVEL] will point
119 * to any other levels that are present.
121 * The slots array records the index of the item or block pointer
122 * used while walking the tree.
125 struct btrfs_buffer *nodes[BTRFS_MAX_LEVEL];
126 int slots[BTRFS_MAX_LEVEL];
130 * items in the extent btree are used to record the objectid of the
131 * owner of the block and the number of references
133 struct btrfs_extent_item {
136 } __attribute__ ((__packed__));
138 struct btrfs_inode_timespec {
141 } __attribute__ ((__packed__));
144 * there is no padding here on purpose. If you want to extent the inode,
145 * make a new item type
147 struct btrfs_inode_item {
158 struct btrfs_inode_timespec atime;
159 struct btrfs_inode_timespec ctime;
160 struct btrfs_inode_timespec mtime;
161 struct btrfs_inode_timespec otime;
162 } __attribute__ ((__packed__));
164 /* inline data is just a blob of bytes */
165 struct btrfs_inline_data_item {
167 } __attribute__ ((__packed__));
169 struct btrfs_dir_item {
174 } __attribute__ ((__packed__));
176 struct btrfs_root_item {
182 } __attribute__ ((__packed__));
184 struct btrfs_file_extent_item {
186 * disk space consumed by the extent, checksum blocks are included
190 __le64 disk_num_blocks;
192 * the logical offset in file bytes (no csums)
193 * this extent record is for. This allows a file extent to point
194 * into the middle of an existing extent on disk, sharing it
195 * between two snapshots (useful if some bytes in the middle of the
196 * extent have changed
200 * the logical number of file blocks (no csums included)
203 } __attribute__ ((__packed__));
205 struct btrfs_inode_map_item {
206 struct btrfs_disk_key key;
207 } __attribute__ ((__packed__));
209 struct btrfs_fs_info {
210 struct btrfs_root *fs_root;
211 struct btrfs_root *extent_root;
212 struct btrfs_root *tree_root;
213 struct btrfs_root *inode_root;
214 struct btrfs_key current_insert;
215 struct btrfs_key last_insert;
216 struct radix_tree_root cache_radix;
217 struct radix_tree_root pinned_radix;
218 struct list_head trans;
219 struct list_head cache;
220 u64 last_inode_alloc;
221 u64 last_inode_alloc_dirid;
225 struct btrfs_trans_handle *running_transaction;
229 * in ram representation of the tree. extent_root is used for all allocations
230 * and for the extent tree extent_root root. current_insert is used
231 * only for the extent tree.
234 struct btrfs_buffer *node;
235 struct btrfs_buffer *commit_root;
236 struct btrfs_root_item root_item;
237 struct btrfs_key root_key;
238 struct btrfs_fs_info *fs_info;
244 /* the lower bits in the key flags defines the item type */
245 #define BTRFS_KEY_TYPE_MAX 256
246 #define BTRFS_KEY_TYPE_MASK (BTRFS_KEY_TYPE_MAX - 1)
249 * inode items have the data typically returned from stat and store other
250 * info about object characteristics. There is one for every file and dir in
253 #define BTRFS_INODE_ITEM_KEY 1
256 * dir items are the name -> inode pointers in a directory. There is one
257 * for every name in a directory.
259 #define BTRFS_DIR_ITEM_KEY 2
261 * inline data is file data that fits in the btree.
263 #define BTRFS_INLINE_DATA_KEY 3
265 * extent data is for data that can't fit in the btree. It points to
266 * a (hopefully) huge chunk of disk
268 #define BTRFS_EXTENT_DATA_KEY 4
270 * root items point to tree roots. There are typically in the root
271 * tree used by the super block to find all the other trees
273 #define BTRFS_ROOT_ITEM_KEY 5
275 * extent items are in the extent map tree. These record which blocks
276 * are used, and how many references there are to each block
278 #define BTRFS_EXTENT_ITEM_KEY 6
281 * the inode map records which inode numbers are in use and where
282 * they actually live on disk
284 #define BTRFS_INODE_MAP_ITEM_KEY 7
286 * string items are for debugging. They just store a short string of
289 #define BTRFS_STRING_ITEM_KEY 8
291 static inline u64 btrfs_inode_generation(struct btrfs_inode_item *i)
293 return le64_to_cpu(i->generation);
296 static inline void btrfs_set_inode_generation(struct btrfs_inode_item *i,
299 i->generation = cpu_to_le64(val);
302 static inline u64 btrfs_inode_size(struct btrfs_inode_item *i)
304 return le64_to_cpu(i->size);
307 static inline void btrfs_set_inode_size(struct btrfs_inode_item *i, u64 val)
309 i->size = cpu_to_le64(val);
312 static inline u64 btrfs_inode_nblocks(struct btrfs_inode_item *i)
314 return le64_to_cpu(i->nblocks);
317 static inline void btrfs_set_inode_nblocks(struct btrfs_inode_item *i, u64 val)
319 i->nblocks = cpu_to_le64(val);
322 static inline u32 btrfs_inode_nlink(struct btrfs_inode_item *i)
324 return le32_to_cpu(i->nlink);
327 static inline void btrfs_set_inode_nlink(struct btrfs_inode_item *i, u32 val)
329 i->nlink = cpu_to_le32(val);
332 static inline u32 btrfs_inode_uid(struct btrfs_inode_item *i)
334 return le32_to_cpu(i->uid);
337 static inline void btrfs_set_inode_uid(struct btrfs_inode_item *i, u32 val)
339 i->uid = cpu_to_le32(val);
342 static inline u32 btrfs_inode_gid(struct btrfs_inode_item *i)
344 return le32_to_cpu(i->gid);
347 static inline void btrfs_set_inode_gid(struct btrfs_inode_item *i, u32 val)
349 i->gid = cpu_to_le32(val);
352 static inline u32 btrfs_inode_mode(struct btrfs_inode_item *i)
354 return le32_to_cpu(i->mode);
357 static inline void btrfs_set_inode_mode(struct btrfs_inode_item *i, u32 val)
359 i->mode = cpu_to_le32(val);
362 static inline u32 btrfs_inode_rdev(struct btrfs_inode_item *i)
364 return le32_to_cpu(i->rdev);
367 static inline void btrfs_set_inode_rdev(struct btrfs_inode_item *i, u32 val)
369 i->rdev = cpu_to_le32(val);
372 static inline u16 btrfs_inode_flags(struct btrfs_inode_item *i)
374 return le16_to_cpu(i->flags);
377 static inline void btrfs_set_inode_flags(struct btrfs_inode_item *i, u16 val)
379 i->flags = cpu_to_le16(val);
382 static inline u16 btrfs_inode_compat_flags(struct btrfs_inode_item *i)
384 return le16_to_cpu(i->compat_flags);
387 static inline void btrfs_set_inode_compat_flags(struct btrfs_inode_item *i,
390 i->compat_flags = cpu_to_le16(val);
394 static inline u64 btrfs_extent_owner(struct btrfs_extent_item *ei)
396 return le64_to_cpu(ei->owner);
399 static inline void btrfs_set_extent_owner(struct btrfs_extent_item *ei, u64 val)
401 ei->owner = cpu_to_le64(val);
404 static inline u32 btrfs_extent_refs(struct btrfs_extent_item *ei)
406 return le32_to_cpu(ei->refs);
409 static inline void btrfs_set_extent_refs(struct btrfs_extent_item *ei, u32 val)
411 ei->refs = cpu_to_le32(val);
414 static inline u64 btrfs_node_blockptr(struct btrfs_node *n, int nr)
416 return le64_to_cpu(n->ptrs[nr].blockptr);
419 static inline void btrfs_set_node_blockptr(struct btrfs_node *n, int nr,
422 n->ptrs[nr].blockptr = cpu_to_le64(val);
425 static inline u32 btrfs_item_offset(struct btrfs_item *item)
427 return le32_to_cpu(item->offset);
430 static inline void btrfs_set_item_offset(struct btrfs_item *item, u32 val)
432 item->offset = cpu_to_le32(val);
435 static inline u32 btrfs_item_end(struct btrfs_item *item)
437 return le32_to_cpu(item->offset) + le16_to_cpu(item->size);
440 static inline u16 btrfs_item_size(struct btrfs_item *item)
442 return le16_to_cpu(item->size);
445 static inline void btrfs_set_item_size(struct btrfs_item *item, u16 val)
447 item->size = cpu_to_le16(val);
450 static inline u64 btrfs_dir_objectid(struct btrfs_dir_item *d)
452 return le64_to_cpu(d->objectid);
455 static inline void btrfs_set_dir_objectid(struct btrfs_dir_item *d, u64 val)
457 d->objectid = cpu_to_le64(val);
460 static inline u16 btrfs_dir_flags(struct btrfs_dir_item *d)
462 return le16_to_cpu(d->flags);
465 static inline void btrfs_set_dir_flags(struct btrfs_dir_item *d, u16 val)
467 d->flags = cpu_to_le16(val);
470 static inline u8 btrfs_dir_type(struct btrfs_dir_item *d)
475 static inline void btrfs_set_dir_type(struct btrfs_dir_item *d, u8 val)
480 static inline u16 btrfs_dir_name_len(struct btrfs_dir_item *d)
482 return le16_to_cpu(d->name_len);
485 static inline void btrfs_set_dir_name_len(struct btrfs_dir_item *d, u16 val)
487 d->name_len = cpu_to_le16(val);
490 static inline void btrfs_disk_key_to_cpu(struct btrfs_key *cpu,
491 struct btrfs_disk_key *disk)
493 cpu->offset = le64_to_cpu(disk->offset);
494 cpu->flags = le32_to_cpu(disk->flags);
495 cpu->objectid = le64_to_cpu(disk->objectid);
498 static inline void btrfs_cpu_key_to_disk(struct btrfs_disk_key *disk,
499 struct btrfs_key *cpu)
501 disk->offset = cpu_to_le64(cpu->offset);
502 disk->flags = cpu_to_le32(cpu->flags);
503 disk->objectid = cpu_to_le64(cpu->objectid);
506 static inline u64 btrfs_disk_key_objectid(struct btrfs_disk_key *disk)
508 return le64_to_cpu(disk->objectid);
511 static inline void btrfs_set_disk_key_objectid(struct btrfs_disk_key *disk,
514 disk->objectid = cpu_to_le64(val);
517 static inline u64 btrfs_disk_key_offset(struct btrfs_disk_key *disk)
519 return le64_to_cpu(disk->offset);
522 static inline void btrfs_set_disk_key_offset(struct btrfs_disk_key *disk,
525 disk->offset = cpu_to_le64(val);
528 static inline u32 btrfs_disk_key_flags(struct btrfs_disk_key *disk)
530 return le32_to_cpu(disk->flags);
533 static inline void btrfs_set_disk_key_flags(struct btrfs_disk_key *disk,
536 disk->flags = cpu_to_le32(val);
539 static inline u32 btrfs_key_type(struct btrfs_key *key)
541 return key->flags & BTRFS_KEY_TYPE_MASK;
544 static inline u32 btrfs_disk_key_type(struct btrfs_disk_key *key)
546 return le32_to_cpu(key->flags) & BTRFS_KEY_TYPE_MASK;
549 static inline void btrfs_set_key_type(struct btrfs_key *key, u32 type)
551 BUG_ON(type >= BTRFS_KEY_TYPE_MAX);
552 key->flags = (key->flags & ~((u64)BTRFS_KEY_TYPE_MASK)) | type;
555 static inline void btrfs_set_disk_key_type(struct btrfs_disk_key *key, u32 type)
557 u32 flags = btrfs_disk_key_flags(key);
558 BUG_ON(type >= BTRFS_KEY_TYPE_MAX);
559 flags = (flags & ~((u64)BTRFS_KEY_TYPE_MASK)) | type;
560 btrfs_set_disk_key_flags(key, flags);
563 static inline u64 btrfs_header_blocknr(struct btrfs_header *h)
565 return le64_to_cpu(h->blocknr);
568 static inline void btrfs_set_header_blocknr(struct btrfs_header *h, u64 blocknr)
570 h->blocknr = cpu_to_le64(blocknr);
573 static inline u64 btrfs_header_parentid(struct btrfs_header *h)
575 return le64_to_cpu(h->parentid);
578 static inline void btrfs_set_header_parentid(struct btrfs_header *h,
581 h->parentid = cpu_to_le64(parentid);
584 static inline u16 btrfs_header_nritems(struct btrfs_header *h)
586 return le16_to_cpu(h->nritems);
589 static inline void btrfs_set_header_nritems(struct btrfs_header *h, u16 val)
591 h->nritems = cpu_to_le16(val);
594 static inline u16 btrfs_header_flags(struct btrfs_header *h)
596 return le16_to_cpu(h->flags);
599 static inline void btrfs_set_header_flags(struct btrfs_header *h, u16 val)
601 h->flags = cpu_to_le16(val);
604 static inline int btrfs_header_level(struct btrfs_header *h)
606 return btrfs_header_flags(h) & (BTRFS_MAX_LEVEL - 1);
609 static inline void btrfs_set_header_level(struct btrfs_header *h, int level)
612 BUG_ON(level > BTRFS_MAX_LEVEL);
613 flags = btrfs_header_flags(h) & ~(BTRFS_MAX_LEVEL - 1);
614 btrfs_set_header_flags(h, flags | level);
617 static inline int btrfs_is_leaf(struct btrfs_node *n)
619 return (btrfs_header_level(&n->header) == 0);
622 static inline u64 btrfs_root_blocknr(struct btrfs_root_item *item)
624 return le64_to_cpu(item->blocknr);
627 static inline void btrfs_set_root_blocknr(struct btrfs_root_item *item, u64 val)
629 item->blocknr = cpu_to_le64(val);
632 static inline u32 btrfs_root_refs(struct btrfs_root_item *item)
634 return le32_to_cpu(item->refs);
637 static inline void btrfs_set_root_refs(struct btrfs_root_item *item, u32 val)
639 item->refs = cpu_to_le32(val);
642 static inline u64 btrfs_super_blocknr(struct btrfs_super_block *s)
644 return le64_to_cpu(s->blocknr);
647 static inline void btrfs_set_super_blocknr(struct btrfs_super_block *s, u64 val)
649 s->blocknr = cpu_to_le64(val);
652 static inline u64 btrfs_super_root(struct btrfs_super_block *s)
654 return le64_to_cpu(s->root);
657 static inline void btrfs_set_super_root(struct btrfs_super_block *s, u64 val)
659 s->root = cpu_to_le64(val);
662 static inline u64 btrfs_super_total_blocks(struct btrfs_super_block *s)
664 return le64_to_cpu(s->total_blocks);
667 static inline void btrfs_set_super_total_blocks(struct btrfs_super_block *s,
670 s->total_blocks = cpu_to_le64(val);
673 static inline u64 btrfs_super_blocks_used(struct btrfs_super_block *s)
675 return le64_to_cpu(s->blocks_used);
678 static inline void btrfs_set_super_blocks_used(struct btrfs_super_block *s,
681 s->blocks_used = cpu_to_le64(val);
684 static inline u32 btrfs_super_blocksize(struct btrfs_super_block *s)
686 return le32_to_cpu(s->blocksize);
689 static inline void btrfs_set_super_blocksize(struct btrfs_super_block *s,
692 s->blocksize = cpu_to_le32(val);
695 static inline u8 *btrfs_leaf_data(struct btrfs_leaf *l)
697 return (u8 *)l->items;
700 static inline u64 btrfs_file_extent_disk_blocknr(struct btrfs_file_extent_item
703 return le64_to_cpu(e->disk_blocknr);
706 static inline void btrfs_set_file_extent_disk_blocknr(struct
707 btrfs_file_extent_item
710 e->disk_blocknr = cpu_to_le64(val);
713 static inline u64 btrfs_file_extent_disk_num_blocks(struct
714 btrfs_file_extent_item *e)
716 return le64_to_cpu(e->disk_num_blocks);
719 static inline void btrfs_set_file_extent_disk_num_blocks(struct
720 btrfs_file_extent_item
723 e->disk_num_blocks = cpu_to_le64(val);
726 static inline u64 btrfs_file_extent_offset(struct btrfs_file_extent_item *e)
728 return le64_to_cpu(e->offset);
731 static inline void btrfs_set_file_extent_offset(struct btrfs_file_extent_item
734 e->offset = cpu_to_le64(val);
737 static inline u64 btrfs_file_extent_num_blocks(struct btrfs_file_extent_item
740 return le64_to_cpu(e->num_blocks);
743 static inline void btrfs_set_file_extent_num_blocks(struct
744 btrfs_file_extent_item *e,
747 e->num_blocks = cpu_to_le64(val);
750 /* helper function to cast into the data area of the leaf. */
751 #define btrfs_item_ptr(leaf, slot, type) \
752 ((type *)(btrfs_leaf_data(leaf) + \
753 btrfs_item_offset((leaf)->items + (slot))))
755 struct btrfs_buffer *btrfs_alloc_free_block(struct btrfs_trans_handle *trans,
756 struct btrfs_root *root);
757 int btrfs_inc_ref(struct btrfs_trans_handle *trans, struct btrfs_root *root,
758 struct btrfs_buffer *buf);
759 int btrfs_free_extent(struct btrfs_trans_handle *trans, struct btrfs_root
760 *root, u64 blocknr, u64 num_blocks, int pin);
761 int btrfs_search_slot(struct btrfs_trans_handle *trans, struct btrfs_root
762 *root, struct btrfs_key *key, struct btrfs_path *p, int
764 void btrfs_release_path(struct btrfs_root *root, struct btrfs_path *p);
765 void btrfs_init_path(struct btrfs_path *p);
766 int btrfs_del_item(struct btrfs_trans_handle *trans, struct btrfs_root *root,
767 struct btrfs_path *path);
768 int btrfs_insert_item(struct btrfs_trans_handle *trans, struct btrfs_root
769 *root, struct btrfs_key *key, void *data, u32 data_size);
770 int btrfs_insert_empty_item(struct btrfs_trans_handle *trans, struct btrfs_root
771 *root, struct btrfs_path *path, struct btrfs_key
772 *cpu_key, u32 data_size);
773 int btrfs_next_leaf(struct btrfs_root *root, struct btrfs_path *path);
774 int btrfs_leaf_free_space(struct btrfs_root *root, struct btrfs_leaf *leaf);
775 int btrfs_drop_snapshot(struct btrfs_trans_handle *trans, struct btrfs_root
776 *root, struct btrfs_buffer *snap);
777 int btrfs_finish_extent_commit(struct btrfs_trans_handle *trans, struct
779 int btrfs_del_root(struct btrfs_trans_handle *trans, struct btrfs_root *root,
780 struct btrfs_key *key);
781 int btrfs_insert_root(struct btrfs_trans_handle *trans, struct btrfs_root
782 *root, struct btrfs_key *key, struct btrfs_root_item
784 int btrfs_update_root(struct btrfs_trans_handle *trans, struct btrfs_root
785 *root, struct btrfs_key *key, struct btrfs_root_item
787 int btrfs_find_last_root(struct btrfs_root *root, u64 objectid, struct
788 btrfs_root_item *item, struct btrfs_key *key);
789 int btrfs_insert_dir_item(struct btrfs_trans_handle *trans, struct btrfs_root
790 *root, char *name, int name_len, u64 dir, u64
792 int btrfs_lookup_dir_item(struct btrfs_trans_handle *trans, struct btrfs_root
793 *root, struct btrfs_path *path, u64 dir, char *name,
794 int name_len, int mod);
795 int btrfs_match_dir_item_name(struct btrfs_root *root, struct btrfs_path *path,
796 char *name, int name_len);
797 int btrfs_find_free_objectid(struct btrfs_trans_handle *trans,
798 struct btrfs_root *fs_root,
799 u64 dirid, u64 *objectid);
800 int btrfs_insert_inode_map(struct btrfs_trans_handle *trans,
801 struct btrfs_root *root,
802 u64 objectid, struct btrfs_key *location);
803 int btrfs_lookup_inode_map(struct btrfs_trans_handle *trans,
804 struct btrfs_root *root, struct btrfs_path *path,
805 u64 objectid, int mod);
806 int btrfs_insert_inode(struct btrfs_trans_handle *trans, struct btrfs_root
807 *root, u64 objectid, struct btrfs_inode_item
809 int btrfs_lookup_inode(struct btrfs_trans_handle *trans, struct btrfs_root
810 *root, struct btrfs_path *path, u64 objectid, int mod);