4 #include <linux/radix-tree.h>
7 struct btrfs_trans_handle;
8 struct btrfs_transaction;
10 #define BTRFS_MAGIC "_BtRfS_M"
12 #define BTRFS_ROOT_TREE_OBJECTID 1
13 #define BTRFS_EXTENT_TREE_OBJECTID 2
14 #define BTRFS_INODE_MAP_OBJECTID 3
15 #define BTRFS_FS_TREE_OBJECTID 4
18 * we can actually store much bigger names, but lets not confuse the rest
21 #define BTRFS_NAME_LEN 255
24 * the key defines the order in the tree, and so it also defines (optimal)
25 * block layout. objectid corresonds to the inode number. The flags
26 * tells us things about the object, and is a kind of stream selector.
27 * so for a given inode, keys with flags of 1 might refer to the inode
28 * data, flags of 2 may point to file data in the btree and flags == 3
29 * may point to extents.
31 * offset is the starting byte offset for this key in the stream.
33 * btrfs_disk_key is in disk byte order. struct btrfs_key is always
34 * in cpu native order. Otherwise they are identical and their sizes
35 * should be the same (ie both packed)
37 struct btrfs_disk_key {
41 } __attribute__ ((__packed__));
47 } __attribute__ ((__packed__));
50 * every tree block (leaf or node) starts with this header.
53 u8 fsid[16]; /* FS specific uuid */
54 __le64 blocknr; /* which block this node is supposed to live in */
55 __le64 parentid; /* objectid of the tree root */
60 /* generation flags to be added */
61 } __attribute__ ((__packed__));
63 #define BTRFS_MAX_LEVEL 8
64 #define BTRFS_NODEPTRS_PER_BLOCK(r) (((r)->blocksize - \
65 sizeof(struct btrfs_header)) / \
66 (sizeof(struct btrfs_disk_key) + sizeof(u64)))
67 #define __BTRFS_LEAF_DATA_SIZE(bs) ((bs) - sizeof(struct btrfs_header))
68 #define BTRFS_LEAF_DATA_SIZE(r) (__BTRFS_LEAF_DATA_SIZE(r->blocksize))
72 * the super block basically lists the main trees of the FS
73 * it currently lacks any block count etc etc
75 struct btrfs_super_block {
76 u8 fsid[16]; /* FS specific uuid */
77 __le64 blocknr; /* this block number */
85 __le64 root_dir_objectid;
86 } __attribute__ ((__packed__));
89 * A leaf is full of items. offset and size tell us where to find
90 * the item in the leaf (relative to the start of the data area)
93 struct btrfs_disk_key key;
96 } __attribute__ ((__packed__));
99 * leaves have an item area and a data area:
100 * [item0, item1....itemN] [free space] [dataN...data1, data0]
102 * The data is separate from the items to get the keys closer together
106 struct btrfs_header header;
107 struct btrfs_item items[];
108 } __attribute__ ((__packed__));
111 * all non-leaf blocks are nodes, they hold only keys and pointers to
114 struct btrfs_key_ptr {
115 struct btrfs_disk_key key;
117 } __attribute__ ((__packed__));
120 struct btrfs_header header;
121 struct btrfs_key_ptr ptrs[];
122 } __attribute__ ((__packed__));
125 * btrfs_paths remember the path taken from the root down to the leaf.
126 * level 0 is always the leaf, and nodes[1...BTRFS_MAX_LEVEL] will point
127 * to any other levels that are present.
129 * The slots array records the index of the item or block pointer
130 * used while walking the tree.
133 struct buffer_head *nodes[BTRFS_MAX_LEVEL];
134 int slots[BTRFS_MAX_LEVEL];
138 * items in the extent btree are used to record the objectid of the
139 * owner of the block and the number of references
141 struct btrfs_extent_item {
144 } __attribute__ ((__packed__));
146 struct btrfs_inode_timespec {
149 } __attribute__ ((__packed__));
152 * there is no padding here on purpose. If you want to extent the inode,
153 * make a new item type
155 struct btrfs_inode_item {
166 struct btrfs_inode_timespec atime;
167 struct btrfs_inode_timespec ctime;
168 struct btrfs_inode_timespec mtime;
169 struct btrfs_inode_timespec otime;
170 } __attribute__ ((__packed__));
172 /* inline data is just a blob of bytes */
173 struct btrfs_inline_data_item {
175 } __attribute__ ((__packed__));
177 struct btrfs_dir_item {
182 } __attribute__ ((__packed__));
184 struct btrfs_root_item {
190 } __attribute__ ((__packed__));
192 struct btrfs_file_extent_item {
194 * disk space consumed by the extent, checksum blocks are included
198 __le64 disk_num_blocks;
200 * the logical offset in file bytes (no csums)
201 * this extent record is for. This allows a file extent to point
202 * into the middle of an existing extent on disk, sharing it
203 * between two snapshots (useful if some bytes in the middle of the
204 * extent have changed
208 * the logical number of file blocks (no csums included)
211 } __attribute__ ((__packed__));
213 struct btrfs_inode_map_item {
214 struct btrfs_disk_key key;
215 } __attribute__ ((__packed__));
217 struct btrfs_fs_info {
218 struct btrfs_root *fs_root;
219 struct btrfs_root *extent_root;
220 struct btrfs_root *tree_root;
221 struct btrfs_root *inode_root;
222 struct btrfs_key current_insert;
223 struct btrfs_key last_insert;
224 struct radix_tree_root pinned_radix;
225 u64 last_inode_alloc;
226 u64 last_inode_alloc_dirid;
228 struct btrfs_transaction *running_transaction;
229 struct btrfs_super_block *disk_super;
230 struct buffer_head *sb_buffer;
231 struct super_block *sb;
232 struct mutex trans_mutex;
236 * in ram representation of the tree. extent_root is used for all allocations
237 * and for the extent tree extent_root root. current_insert is used
238 * only for the extent tree.
241 struct buffer_head *node;
242 struct buffer_head *commit_root;
243 struct btrfs_root_item root_item;
244 struct btrfs_key root_key;
245 struct btrfs_fs_info *fs_info;
251 /* the lower bits in the key flags defines the item type */
252 #define BTRFS_KEY_TYPE_MAX 256
253 #define BTRFS_KEY_TYPE_MASK (BTRFS_KEY_TYPE_MAX - 1)
256 * inode items have the data typically returned from stat and store other
257 * info about object characteristics. There is one for every file and dir in
260 #define BTRFS_INODE_ITEM_KEY 1
263 * dir items are the name -> inode pointers in a directory. There is one
264 * for every name in a directory.
266 #define BTRFS_DIR_ITEM_KEY 2
268 * inline data is file data that fits in the btree.
270 #define BTRFS_INLINE_DATA_KEY 3
272 * extent data is for data that can't fit in the btree. It points to
273 * a (hopefully) huge chunk of disk
275 #define BTRFS_EXTENT_DATA_KEY 4
277 * root items point to tree roots. There are typically in the root
278 * tree used by the super block to find all the other trees
280 #define BTRFS_ROOT_ITEM_KEY 5
282 * extent items are in the extent map tree. These record which blocks
283 * are used, and how many references there are to each block
285 #define BTRFS_EXTENT_ITEM_KEY 6
288 * the inode map records which inode numbers are in use and where
289 * they actually live on disk
291 #define BTRFS_INODE_MAP_ITEM_KEY 7
293 * string items are for debugging. They just store a short string of
296 #define BTRFS_STRING_ITEM_KEY 8
298 static inline u64 btrfs_inode_generation(struct btrfs_inode_item *i)
300 return le64_to_cpu(i->generation);
303 static inline void btrfs_set_inode_generation(struct btrfs_inode_item *i,
306 i->generation = cpu_to_le64(val);
309 static inline u64 btrfs_inode_size(struct btrfs_inode_item *i)
311 return le64_to_cpu(i->size);
314 static inline void btrfs_set_inode_size(struct btrfs_inode_item *i, u64 val)
316 i->size = cpu_to_le64(val);
319 static inline u64 btrfs_inode_nblocks(struct btrfs_inode_item *i)
321 return le64_to_cpu(i->nblocks);
324 static inline void btrfs_set_inode_nblocks(struct btrfs_inode_item *i, u64 val)
326 i->nblocks = cpu_to_le64(val);
329 static inline u32 btrfs_inode_nlink(struct btrfs_inode_item *i)
331 return le32_to_cpu(i->nlink);
334 static inline void btrfs_set_inode_nlink(struct btrfs_inode_item *i, u32 val)
336 i->nlink = cpu_to_le32(val);
339 static inline u32 btrfs_inode_uid(struct btrfs_inode_item *i)
341 return le32_to_cpu(i->uid);
344 static inline void btrfs_set_inode_uid(struct btrfs_inode_item *i, u32 val)
346 i->uid = cpu_to_le32(val);
349 static inline u32 btrfs_inode_gid(struct btrfs_inode_item *i)
351 return le32_to_cpu(i->gid);
354 static inline void btrfs_set_inode_gid(struct btrfs_inode_item *i, u32 val)
356 i->gid = cpu_to_le32(val);
359 static inline u32 btrfs_inode_mode(struct btrfs_inode_item *i)
361 return le32_to_cpu(i->mode);
364 static inline void btrfs_set_inode_mode(struct btrfs_inode_item *i, u32 val)
366 i->mode = cpu_to_le32(val);
369 static inline u32 btrfs_inode_rdev(struct btrfs_inode_item *i)
371 return le32_to_cpu(i->rdev);
374 static inline void btrfs_set_inode_rdev(struct btrfs_inode_item *i, u32 val)
376 i->rdev = cpu_to_le32(val);
379 static inline u16 btrfs_inode_flags(struct btrfs_inode_item *i)
381 return le16_to_cpu(i->flags);
384 static inline void btrfs_set_inode_flags(struct btrfs_inode_item *i, u16 val)
386 i->flags = cpu_to_le16(val);
389 static inline u16 btrfs_inode_compat_flags(struct btrfs_inode_item *i)
391 return le16_to_cpu(i->compat_flags);
394 static inline void btrfs_set_inode_compat_flags(struct btrfs_inode_item *i,
397 i->compat_flags = cpu_to_le16(val);
400 static inline u32 btrfs_timespec_sec(struct btrfs_inode_timespec *ts)
402 return le32_to_cpu(ts->sec);
405 static inline void btrfs_set_timespec_sec(struct btrfs_inode_timespec *ts,
408 ts->sec = cpu_to_le32(val);
411 static inline u32 btrfs_timespec_nsec(struct btrfs_inode_timespec *ts)
413 return le32_to_cpu(ts->nsec);
416 static inline void btrfs_set_timespec_nsec(struct btrfs_inode_timespec *ts,
419 ts->nsec = cpu_to_le32(val);
424 static inline u64 btrfs_extent_owner(struct btrfs_extent_item *ei)
426 return le64_to_cpu(ei->owner);
429 static inline void btrfs_set_extent_owner(struct btrfs_extent_item *ei, u64 val)
431 ei->owner = cpu_to_le64(val);
434 static inline u32 btrfs_extent_refs(struct btrfs_extent_item *ei)
436 return le32_to_cpu(ei->refs);
439 static inline void btrfs_set_extent_refs(struct btrfs_extent_item *ei, u32 val)
441 ei->refs = cpu_to_le32(val);
444 static inline u64 btrfs_node_blockptr(struct btrfs_node *n, int nr)
446 return le64_to_cpu(n->ptrs[nr].blockptr);
449 static inline void btrfs_set_node_blockptr(struct btrfs_node *n, int nr,
452 n->ptrs[nr].blockptr = cpu_to_le64(val);
455 static inline u32 btrfs_item_offset(struct btrfs_item *item)
457 return le32_to_cpu(item->offset);
460 static inline void btrfs_set_item_offset(struct btrfs_item *item, u32 val)
462 item->offset = cpu_to_le32(val);
465 static inline u32 btrfs_item_end(struct btrfs_item *item)
467 return le32_to_cpu(item->offset) + le16_to_cpu(item->size);
470 static inline u16 btrfs_item_size(struct btrfs_item *item)
472 return le16_to_cpu(item->size);
475 static inline void btrfs_set_item_size(struct btrfs_item *item, u16 val)
477 item->size = cpu_to_le16(val);
480 static inline u64 btrfs_dir_objectid(struct btrfs_dir_item *d)
482 return le64_to_cpu(d->objectid);
485 static inline void btrfs_set_dir_objectid(struct btrfs_dir_item *d, u64 val)
487 d->objectid = cpu_to_le64(val);
490 static inline u16 btrfs_dir_flags(struct btrfs_dir_item *d)
492 return le16_to_cpu(d->flags);
495 static inline void btrfs_set_dir_flags(struct btrfs_dir_item *d, u16 val)
497 d->flags = cpu_to_le16(val);
500 static inline u8 btrfs_dir_type(struct btrfs_dir_item *d)
505 static inline void btrfs_set_dir_type(struct btrfs_dir_item *d, u8 val)
510 static inline u16 btrfs_dir_name_len(struct btrfs_dir_item *d)
512 return le16_to_cpu(d->name_len);
515 static inline void btrfs_set_dir_name_len(struct btrfs_dir_item *d, u16 val)
517 d->name_len = cpu_to_le16(val);
520 static inline void btrfs_disk_key_to_cpu(struct btrfs_key *cpu,
521 struct btrfs_disk_key *disk)
523 cpu->offset = le64_to_cpu(disk->offset);
524 cpu->flags = le32_to_cpu(disk->flags);
525 cpu->objectid = le64_to_cpu(disk->objectid);
528 static inline void btrfs_cpu_key_to_disk(struct btrfs_disk_key *disk,
529 struct btrfs_key *cpu)
531 disk->offset = cpu_to_le64(cpu->offset);
532 disk->flags = cpu_to_le32(cpu->flags);
533 disk->objectid = cpu_to_le64(cpu->objectid);
536 static inline u64 btrfs_disk_key_objectid(struct btrfs_disk_key *disk)
538 return le64_to_cpu(disk->objectid);
541 static inline void btrfs_set_disk_key_objectid(struct btrfs_disk_key *disk,
544 disk->objectid = cpu_to_le64(val);
547 static inline u64 btrfs_disk_key_offset(struct btrfs_disk_key *disk)
549 return le64_to_cpu(disk->offset);
552 static inline void btrfs_set_disk_key_offset(struct btrfs_disk_key *disk,
555 disk->offset = cpu_to_le64(val);
558 static inline u32 btrfs_disk_key_flags(struct btrfs_disk_key *disk)
560 return le32_to_cpu(disk->flags);
563 static inline void btrfs_set_disk_key_flags(struct btrfs_disk_key *disk,
566 disk->flags = cpu_to_le32(val);
569 static inline u32 btrfs_key_type(struct btrfs_key *key)
571 return key->flags & BTRFS_KEY_TYPE_MASK;
574 static inline u32 btrfs_disk_key_type(struct btrfs_disk_key *key)
576 return le32_to_cpu(key->flags) & BTRFS_KEY_TYPE_MASK;
579 static inline void btrfs_set_key_type(struct btrfs_key *key, u32 type)
581 BUG_ON(type >= BTRFS_KEY_TYPE_MAX);
582 key->flags = (key->flags & ~((u64)BTRFS_KEY_TYPE_MASK)) | type;
585 static inline void btrfs_set_disk_key_type(struct btrfs_disk_key *key, u32 type)
587 u32 flags = btrfs_disk_key_flags(key);
588 BUG_ON(type >= BTRFS_KEY_TYPE_MAX);
589 flags = (flags & ~((u64)BTRFS_KEY_TYPE_MASK)) | type;
590 btrfs_set_disk_key_flags(key, flags);
593 static inline u64 btrfs_header_blocknr(struct btrfs_header *h)
595 return le64_to_cpu(h->blocknr);
598 static inline void btrfs_set_header_blocknr(struct btrfs_header *h, u64 blocknr)
600 h->blocknr = cpu_to_le64(blocknr);
603 static inline u64 btrfs_header_parentid(struct btrfs_header *h)
605 return le64_to_cpu(h->parentid);
608 static inline void btrfs_set_header_parentid(struct btrfs_header *h,
611 h->parentid = cpu_to_le64(parentid);
614 static inline u16 btrfs_header_nritems(struct btrfs_header *h)
616 return le16_to_cpu(h->nritems);
619 static inline void btrfs_set_header_nritems(struct btrfs_header *h, u16 val)
621 h->nritems = cpu_to_le16(val);
624 static inline u16 btrfs_header_flags(struct btrfs_header *h)
626 return le16_to_cpu(h->flags);
629 static inline void btrfs_set_header_flags(struct btrfs_header *h, u16 val)
631 h->flags = cpu_to_le16(val);
634 static inline int btrfs_header_level(struct btrfs_header *h)
636 return btrfs_header_flags(h) & (BTRFS_MAX_LEVEL - 1);
639 static inline void btrfs_set_header_level(struct btrfs_header *h, int level)
642 BUG_ON(level > BTRFS_MAX_LEVEL);
643 flags = btrfs_header_flags(h) & ~(BTRFS_MAX_LEVEL - 1);
644 btrfs_set_header_flags(h, flags | level);
647 static inline int btrfs_is_leaf(struct btrfs_node *n)
649 return (btrfs_header_level(&n->header) == 0);
652 static inline u64 btrfs_root_blocknr(struct btrfs_root_item *item)
654 return le64_to_cpu(item->blocknr);
657 static inline void btrfs_set_root_blocknr(struct btrfs_root_item *item, u64 val)
659 item->blocknr = cpu_to_le64(val);
662 static inline u32 btrfs_root_refs(struct btrfs_root_item *item)
664 return le32_to_cpu(item->refs);
667 static inline void btrfs_set_root_refs(struct btrfs_root_item *item, u32 val)
669 item->refs = cpu_to_le32(val);
672 static inline u64 btrfs_super_blocknr(struct btrfs_super_block *s)
674 return le64_to_cpu(s->blocknr);
677 static inline void btrfs_set_super_blocknr(struct btrfs_super_block *s, u64 val)
679 s->blocknr = cpu_to_le64(val);
682 static inline u64 btrfs_super_root(struct btrfs_super_block *s)
684 return le64_to_cpu(s->root);
687 static inline void btrfs_set_super_root(struct btrfs_super_block *s, u64 val)
689 s->root = cpu_to_le64(val);
692 static inline u64 btrfs_super_total_blocks(struct btrfs_super_block *s)
694 return le64_to_cpu(s->total_blocks);
697 static inline void btrfs_set_super_total_blocks(struct btrfs_super_block *s,
700 s->total_blocks = cpu_to_le64(val);
703 static inline u64 btrfs_super_blocks_used(struct btrfs_super_block *s)
705 return le64_to_cpu(s->blocks_used);
708 static inline void btrfs_set_super_blocks_used(struct btrfs_super_block *s,
711 s->blocks_used = cpu_to_le64(val);
714 static inline u32 btrfs_super_blocksize(struct btrfs_super_block *s)
716 return le32_to_cpu(s->blocksize);
719 static inline void btrfs_set_super_blocksize(struct btrfs_super_block *s,
722 s->blocksize = cpu_to_le32(val);
725 static inline u64 btrfs_super_root_dir(struct btrfs_super_block *s)
727 return le64_to_cpu(s->root_dir_objectid);
730 static inline void btrfs_set_super_root_dir(struct btrfs_super_block *s, u64
733 s->root_dir_objectid = cpu_to_le64(val);
736 static inline u8 *btrfs_leaf_data(struct btrfs_leaf *l)
738 return (u8 *)l->items;
741 static inline u64 btrfs_file_extent_disk_blocknr(struct btrfs_file_extent_item
744 return le64_to_cpu(e->disk_blocknr);
747 static inline void btrfs_set_file_extent_disk_blocknr(struct
748 btrfs_file_extent_item
751 e->disk_blocknr = cpu_to_le64(val);
754 static inline u64 btrfs_file_extent_disk_num_blocks(struct
755 btrfs_file_extent_item *e)
757 return le64_to_cpu(e->disk_num_blocks);
760 static inline void btrfs_set_file_extent_disk_num_blocks(struct
761 btrfs_file_extent_item
764 e->disk_num_blocks = cpu_to_le64(val);
767 static inline u64 btrfs_file_extent_offset(struct btrfs_file_extent_item *e)
769 return le64_to_cpu(e->offset);
772 static inline void btrfs_set_file_extent_offset(struct btrfs_file_extent_item
775 e->offset = cpu_to_le64(val);
778 static inline u64 btrfs_file_extent_num_blocks(struct btrfs_file_extent_item
781 return le64_to_cpu(e->num_blocks);
784 static inline void btrfs_set_file_extent_num_blocks(struct
785 btrfs_file_extent_item *e,
788 e->num_blocks = cpu_to_le64(val);
791 static inline struct btrfs_root *btrfs_sb(struct super_block *sb)
793 return sb->s_fs_info;
796 /* helper function to cast into the data area of the leaf. */
797 #define btrfs_item_ptr(leaf, slot, type) \
798 ((type *)(btrfs_leaf_data(leaf) + \
799 btrfs_item_offset((leaf)->items + (slot))))
801 struct buffer_head *btrfs_alloc_free_block(struct btrfs_trans_handle *trans,
802 struct btrfs_root *root);
803 int btrfs_inc_ref(struct btrfs_trans_handle *trans, struct btrfs_root *root,
804 struct buffer_head *buf);
805 int btrfs_free_extent(struct btrfs_trans_handle *trans, struct btrfs_root
806 *root, u64 blocknr, u64 num_blocks, int pin);
807 int btrfs_search_slot(struct btrfs_trans_handle *trans, struct btrfs_root
808 *root, struct btrfs_key *key, struct btrfs_path *p, int
810 void btrfs_release_path(struct btrfs_root *root, struct btrfs_path *p);
811 void btrfs_init_path(struct btrfs_path *p);
812 int btrfs_del_item(struct btrfs_trans_handle *trans, struct btrfs_root *root,
813 struct btrfs_path *path);
814 int btrfs_insert_item(struct btrfs_trans_handle *trans, struct btrfs_root
815 *root, struct btrfs_key *key, void *data, u32 data_size);
816 int btrfs_insert_empty_item(struct btrfs_trans_handle *trans, struct btrfs_root
817 *root, struct btrfs_path *path, struct btrfs_key
818 *cpu_key, u32 data_size);
819 int btrfs_next_leaf(struct btrfs_root *root, struct btrfs_path *path);
820 int btrfs_leaf_free_space(struct btrfs_root *root, struct btrfs_leaf *leaf);
821 int btrfs_drop_snapshot(struct btrfs_trans_handle *trans, struct btrfs_root
822 *root, struct buffer_head *snap);
823 int btrfs_finish_extent_commit(struct btrfs_trans_handle *trans, struct
825 int btrfs_del_root(struct btrfs_trans_handle *trans, struct btrfs_root *root,
826 struct btrfs_key *key);
827 int btrfs_insert_root(struct btrfs_trans_handle *trans, struct btrfs_root
828 *root, struct btrfs_key *key, struct btrfs_root_item
830 int btrfs_update_root(struct btrfs_trans_handle *trans, struct btrfs_root
831 *root, struct btrfs_key *key, struct btrfs_root_item
833 int btrfs_find_last_root(struct btrfs_root *root, u64 objectid, struct
834 btrfs_root_item *item, struct btrfs_key *key);
835 int btrfs_insert_dir_item(struct btrfs_trans_handle *trans, struct btrfs_root
836 *root, const char *name, int name_len, u64 dir, u64
838 int btrfs_lookup_dir_item(struct btrfs_trans_handle *trans, struct btrfs_root
839 *root, struct btrfs_path *path, u64 dir,
840 const char *name, int name_len, int mod);
841 int btrfs_match_dir_item_name(struct btrfs_root *root, struct btrfs_path *path,
842 char *name, int name_len);
843 int btrfs_find_free_objectid(struct btrfs_trans_handle *trans,
844 struct btrfs_root *fs_root,
845 u64 dirid, u64 *objectid);
846 int btrfs_insert_inode_map(struct btrfs_trans_handle *trans,
847 struct btrfs_root *root,
848 u64 objectid, struct btrfs_key *location);
849 int btrfs_lookup_inode_map(struct btrfs_trans_handle *trans,
850 struct btrfs_root *root, struct btrfs_path *path,
851 u64 objectid, int mod);
852 int btrfs_insert_inode(struct btrfs_trans_handle *trans, struct btrfs_root
853 *root, u64 objectid, struct btrfs_inode_item
855 int btrfs_lookup_inode(struct btrfs_trans_handle *trans, struct btrfs_root
856 *root, struct btrfs_path *path, u64 objectid, int mod);