ctree.h 67.1 KB
Newer Older
Chris Mason's avatar
Chris Mason committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/*
 * Copyright (C) 2007 Oracle.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License v2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 */

Chris Mason's avatar
Chris Mason committed
19
20
#ifndef __BTRFS_CTREE__
#define __BTRFS_CTREE__
21

22
#include <linux/version.h>
23
24
#include <linux/mm.h>
#include <linux/highmem.h>
Chris Mason's avatar
Chris Mason committed
25
#include <linux/fs.h>
26
#include <linux/completion.h>
Chris Mason's avatar
Chris Mason committed
27
#include <linux/backing-dev.h>
28
#include <linux/wait.h>
29
#include <asm/kmap_types.h>
30
#include "extent_io.h"
31
#include "extent_map.h"
32
#include "async-thread.h"
Chris Mason's avatar
Chris Mason committed
33

34
struct btrfs_trans_handle;
Chris Mason's avatar
Chris Mason committed
35
struct btrfs_transaction;
36
37
38
extern struct kmem_cache *btrfs_trans_handle_cachep;
extern struct kmem_cache *btrfs_transaction_cachep;
extern struct kmem_cache *btrfs_bit_radix_cachep;
Chris Mason's avatar
Chris Mason committed
39
extern struct kmem_cache *btrfs_path_cachep;
40
struct btrfs_ordered_sum;
41

42
#define BTRFS_MAGIC "_BHRfS_M"
43

Josef Bacik's avatar
Josef Bacik committed
44
45
#define BTRFS_ACL_NOT_CACHED    ((void *)-1)

46
47
48
49
50
#ifdef CONFIG_LOCKDEP
# define BTRFS_MAX_LEVEL 7
#else
# define BTRFS_MAX_LEVEL 8
#endif
51
52

/* holds pointers to all of the tree roots */
53
#define BTRFS_ROOT_TREE_OBJECTID 1ULL
54
55

/* stores information about which extents are in use, and reference counts */
Chris Mason's avatar
Chris Mason committed
56
#define BTRFS_EXTENT_TREE_OBJECTID 2ULL
57
58
59
60
61

/*
 * chunk tree stores translations from logical -> physical block numbering
 * the super block points to the chunk tree
 */
62
#define BTRFS_CHUNK_TREE_OBJECTID 3ULL
63
64
65
66
67

/*
 * stores information about which areas of a given device are in use.
 * one per device.  The tree of tree roots points to the device tree
 */
68
69
70
71
72
73
74
#define BTRFS_DEV_TREE_OBJECTID 4ULL

/* one per subvolume, storing files and directories */
#define BTRFS_FS_TREE_OBJECTID 5ULL

/* directory objectid inside the root tree */
#define BTRFS_ROOT_TREE_DIR_OBJECTID 6ULL
75

76
77
78
/* holds checksums of all the data extents */
#define BTRFS_CSUM_TREE_OBJECTID 7ULL

79
80
81
/* orhpan objectid for tracking unlinked/truncated files */
#define BTRFS_ORPHAN_OBJECTID -5ULL

82
83
84
85
/* does write ahead logging to speed up fsyncs */
#define BTRFS_TREE_LOG_OBJECTID -6ULL
#define BTRFS_TREE_LOG_FIXUP_OBJECTID -7ULL

Zheng Yan's avatar
Zheng Yan committed
86
87
88
89
/* for space balancing */
#define BTRFS_TREE_RELOC_OBJECTID -8ULL
#define BTRFS_DATA_RELOC_TREE_OBJECTID -9ULL

90
91
92
93
94
95
96
/*
 * extent checksums all have this objectid
 * this allows them to share the logging tree
 * for fsyncs
 */
#define BTRFS_EXTENT_CSUM_OBJECTID -10ULL

Zheng Yan's avatar
Zheng Yan committed
97
98
99
/* dummy objectid represents multiple objectids */
#define BTRFS_MULTIPLE_OBJECTIDS -255ULL

100
/*
101
 * All files have objectids in this range.
102
 */
103
#define BTRFS_FIRST_FREE_OBJECTID 256ULL
104
#define BTRFS_LAST_FREE_OBJECTID -256ULL
105
#define BTRFS_FIRST_CHUNK_TREE_OBJECTID 256ULL
106

107
108
109
110
111
112
113

/*
 * the device items go into the chunk tree.  The key is in the form
 * [ 1 BTRFS_DEV_ITEM_KEY device_id ]
 */
#define BTRFS_DEV_ITEMS_OBJECTID 1ULL

Chris Mason's avatar
Chris Mason committed
114
115
116
117
118
119
/*
 * we can actually store much bigger names, but lets not confuse the rest
 * of linux
 */
#define BTRFS_NAME_LEN 255

Chris Mason's avatar
Chris Mason committed
120
121
/* 32 bytes in various csum fields */
#define BTRFS_CSUM_SIZE 32
122
123
124
125
126
127

/* csum types */
#define BTRFS_CSUM_TYPE_CRC32	0

static int btrfs_csum_sizes[] = { 4, 0 };

128
/* four bytes for CRC32 */
129
//#define BTRFS_CRC32_SIZE 4
130
#define BTRFS_EMPTY_DIR_SIZE 0
Chris Mason's avatar
Chris Mason committed
131

Chris Mason's avatar
Chris Mason committed
132
133
134
135
136
137
138
139
#define BTRFS_FT_UNKNOWN	0
#define BTRFS_FT_REG_FILE	1
#define BTRFS_FT_DIR		2
#define BTRFS_FT_CHRDEV		3
#define BTRFS_FT_BLKDEV		4
#define BTRFS_FT_FIFO		5
#define BTRFS_FT_SOCK		6
#define BTRFS_FT_SYMLINK	7
Josef Bacik's avatar
Josef Bacik committed
140
141
#define BTRFS_FT_XATTR		8
#define BTRFS_FT_MAX		9
Chris Mason's avatar
Chris Mason committed
142

143
144
145
146
147
148
149
150
151
/*
 * 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.
Chris Mason's avatar
Chris Mason committed
152
153
154
155
 *
 * 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)
156
 */
Chris Mason's avatar
Chris Mason committed
157
158
struct btrfs_disk_key {
	__le64 objectid;
159
	u8 type;
160
	__le64 offset;
Chris Mason's avatar
Chris Mason committed
161
162
163
} __attribute__ ((__packed__));

struct btrfs_key {
164
	u64 objectid;
165
	u8 type;
166
	u64 offset;
167
168
} __attribute__ ((__packed__));

169
170
171
172
struct btrfs_mapping_tree {
	struct extent_map_tree map_tree;
};

173
#define BTRFS_UUID_SIZE 16
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
struct btrfs_dev_item {
	/* the internal btrfs device id */
	__le64 devid;

	/* size of the device */
	__le64 total_bytes;

	/* bytes used */
	__le64 bytes_used;

	/* optimal io alignment for this device */
	__le32 io_align;

	/* optimal io width for this device */
	__le32 io_width;

	/* minimal io size for this device */
	__le32 sector_size;

	/* type and info about this device */
	__le64 type;

Yan Zheng's avatar
Yan Zheng committed
196
197
198
	/* expected generation for this device */
	__le64 generation;

199
200
201
202
203
204
205
206
207
	/* grouping information for allocation decisions */
	__le32 dev_group;

	/* seek speed 0-100 where 100 is fastest */
	u8 seek_speed;

	/* bandwidth 0-100 where 100 is fastest */
	u8 bandwidth;

208
	/* btrfs generated uuid for this device */
209
	u8 uuid[BTRFS_UUID_SIZE];
Yan Zheng's avatar
Yan Zheng committed
210
211
212

	/* uuid of FS who owns this device */
	u8 fsid[BTRFS_UUID_SIZE];
213
214
215
216
217
} __attribute__ ((__packed__));

struct btrfs_stripe {
	__le64 devid;
	__le64 offset;
218
	u8 dev_uuid[BTRFS_UUID_SIZE];
219
220
221
} __attribute__ ((__packed__));

struct btrfs_chunk {
222
223
224
225
	/* size of this chunk in bytes */
	__le64 length;

	/* objectid of the root referencing this chunk */
226
	__le64 owner;
227

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
	__le64 stripe_len;
	__le64 type;

	/* optimal io alignment for this chunk */
	__le32 io_align;

	/* optimal io width for this chunk */
	__le32 io_width;

	/* minimal io size for this chunk */
	__le32 sector_size;

	/* 2^16 stripes is quite a lot, a second limit is the size of a single
	 * item in the btree
	 */
	__le16 num_stripes;
Chris Mason's avatar
Chris Mason committed
244
245
246

	/* sub stripes only matter for raid10 */
	__le16 sub_stripes;
247
248
249
250
251
252
253
254
255
256
257
	struct btrfs_stripe stripe;
	/* additional stripes go here */
} __attribute__ ((__packed__));

static inline unsigned long btrfs_chunk_item_size(int num_stripes)
{
	BUG_ON(num_stripes == 0);
	return sizeof(struct btrfs_chunk) +
		sizeof(struct btrfs_stripe) * (num_stripes - 1);
}

258
#define BTRFS_FSID_SIZE 16
259
260
#define BTRFS_HEADER_FLAG_WRITTEN (1 << 0)

261
262
263
/*
 * every tree block (leaf or node) starts with this header.
 */
264
struct btrfs_header {
265
	/* these first four must match the super block */
Chris Mason's avatar
Chris Mason committed
266
	u8 csum[BTRFS_CSUM_SIZE];
267
	u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
268
	__le64 bytenr; /* which block this node is supposed to live in */
269
	__le64 flags;
270
271
272

	/* allowed to be different from the super from here on down */
	u8 chunk_tree_uuid[BTRFS_UUID_SIZE];
273
	__le64 generation;
274
	__le64 owner;
275
	__le32 nritems;
276
	u8 level;
277
278
} __attribute__ ((__packed__));

279
#define BTRFS_NODEPTRS_PER_BLOCK(r) (((r)->nodesize - \
280
			        sizeof(struct btrfs_header)) / \
281
			        sizeof(struct btrfs_key_ptr))
282
#define __BTRFS_LEAF_DATA_SIZE(bs) ((bs) - sizeof(struct btrfs_header))
283
#define BTRFS_LEAF_DATA_SIZE(r) (__BTRFS_LEAF_DATA_SIZE(r->leafsize))
284
285
286
#define BTRFS_MAX_INLINE_DATA_SIZE(r) (BTRFS_LEAF_DATA_SIZE(r) - \
					sizeof(struct btrfs_item) - \
					sizeof(struct btrfs_file_extent_item))
287

Yan Zheng's avatar
Yan Zheng committed
288
#define BTRFS_SUPER_FLAG_SEEDING (1ULL << 32)
289
290
291
292
293
294

/*
 * this is a very generous portion of the super block, giving us
 * room to translate 14 chunks with 3 stripes each.
 */
#define BTRFS_SYSTEM_CHUNK_ARRAY_SIZE 2048
295
#define BTRFS_LABEL_SIZE 256
296

297
298
299
300
/*
 * the super block basically lists the main trees of the FS
 * it currently lacks any block count etc etc
 */
301
struct btrfs_super_block {
Chris Mason's avatar
Chris Mason committed
302
	u8 csum[BTRFS_CSUM_SIZE];
303
	/* the first 4 fields must match struct btrfs_header */
Yan Zheng's avatar
Yan Zheng committed
304
	u8 fsid[BTRFS_FSID_SIZE];    /* FS specific uuid */
305
	__le64 bytenr; /* this block number */
306
	__le64 flags;
307
308

	/* allowed to be different from the btrfs_header from here own down */
309
310
311
	__le64 magic;
	__le64 generation;
	__le64 root;
312
	__le64 chunk_root;
313
	__le64 log_root;
314
315
	__le64 total_bytes;
	__le64 bytes_used;
316
	__le64 root_dir_objectid;
317
	__le64 num_devices;
318
319
320
	__le32 sectorsize;
	__le32 nodesize;
	__le32 leafsize;
321
	__le32 stripesize;
322
	__le32 sys_chunk_array_size;
323
	__le64 chunk_root_generation;
324
325
326
	__le64 compat_flags;
	__le64 compat_ro_flags;
	__le64 incompat_flags;
327
	__le16 csum_type;
328
	u8 root_level;
329
	u8 chunk_root_level;
330
	u8 log_root_level;
331
	struct btrfs_dev_item dev_item;
332
	char label[BTRFS_LABEL_SIZE];
333
	u8 sys_chunk_array[BTRFS_SYSTEM_CHUNK_ARRAY_SIZE];
Chris Mason's avatar
Chris Mason committed
334
335
} __attribute__ ((__packed__));

336
337
338
339
340
341
342
343
/*
 * Compat flags that we support.  If any incompat flags are set other than the
 * ones specified below then we will fail to mount
 */
#define BTRFS_FEATURE_COMPAT_SUPP	0x0
#define BTRFS_FEATURE_COMPAT_RO_SUPP	0x0
#define BTRFS_FEATURE_INCOMPAT_SUPP	0x0

344
/*
345
 * A leaf is full of items. offset and size tell us where to find
346
347
 * the item in the leaf (relative to the start of the data area)
 */
Chris Mason's avatar
Chris Mason committed
348
struct btrfs_item {
Chris Mason's avatar
Chris Mason committed
349
	struct btrfs_disk_key key;
350
	__le32 offset;
351
	__le32 size;
352
353
} __attribute__ ((__packed__));

354
355
356
357
358
359
360
/*
 * 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.
 */
361
struct btrfs_leaf {
362
	struct btrfs_header header;
363
	struct btrfs_item items[];
364
365
} __attribute__ ((__packed__));

366
367
368
369
/*
 * all non-leaf blocks are nodes, they hold only keys and pointers to
 * other blocks
 */
370
371
372
struct btrfs_key_ptr {
	struct btrfs_disk_key key;
	__le64 blockptr;
373
	__le64 generation;
374
375
} __attribute__ ((__packed__));

376
struct btrfs_node {
377
	struct btrfs_header header;
378
	struct btrfs_key_ptr ptrs[];
379
380
} __attribute__ ((__packed__));

381
/*
382
383
 * 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
384
385
386
387
388
 * to any other levels that are present.
 *
 * The slots array records the index of the item or block pointer
 * used while walking the tree.
 */
389
struct btrfs_path {
390
	struct extent_buffer *nodes[BTRFS_MAX_LEVEL];
391
	int slots[BTRFS_MAX_LEVEL];
392
393
	/* if there is real range locking, this locks field will change */
	int locks[BTRFS_MAX_LEVEL];
394
	int reada;
395
396
	/* keep some upper locks as we walk down */
	int keep_locks;
397
	int skip_locking;
398
	int lowest_level;
399
};
Chris Mason's avatar
Chris Mason committed
400

401
402
403
404
405
406
/*
 * 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;
407
408
409
410
411
412
} __attribute__ ((__packed__));

struct btrfs_extent_ref {
	__le64 root;
	__le64 generation;
	__le64 objectid;
Zheng Yan's avatar
Zheng Yan committed
413
	__le32 num_refs;
414
415
} __attribute__ ((__packed__));

416
417
/* dev extents record free space on individual devices.  The owner
 * field points back to the chunk allocation mapping tree that allocated
418
 * the extent.  The chunk tree uuid field is a way to double check the owner
419
420
 */
struct btrfs_dev_extent {
421
422
423
	__le64 chunk_tree;
	__le64 chunk_objectid;
	__le64 chunk_offset;
424
	__le64 length;
425
	u8 chunk_tree_uuid[BTRFS_UUID_SIZE];
426
427
} __attribute__ ((__packed__));

428
struct btrfs_inode_ref {
429
	__le64 index;
430
431
432
433
	__le16 name_len;
	/* name goes here */
} __attribute__ ((__packed__));

434
struct btrfs_timespec {
Chris Mason's avatar
Chris Mason committed
435
	__le64 sec;
Chris Mason's avatar
Chris Mason committed
436
437
438
	__le32 nsec;
} __attribute__ ((__packed__));

439
440
441
442
443
444
445
446
447
448
449
450
typedef enum {
	BTRFS_COMPRESS_NONE = 0,
	BTRFS_COMPRESS_ZLIB = 1,
	BTRFS_COMPRESS_LAST = 2,
} btrfs_compression_type;

/* we don't understand any encryption methods right now */
typedef enum {
	BTRFS_ENCRYPTION_NONE = 0,
	BTRFS_ENCRYPTION_LAST = 1,
} btrfs_encryption_type;

Chris Mason's avatar
Chris Mason committed
451
struct btrfs_inode_item {
452
	/* nfs style generation number */
Chris Mason's avatar
Chris Mason committed
453
	__le64 generation;
454
455
	/* transid that last touched this inode */
	__le64 transid;
Chris Mason's avatar
Chris Mason committed
456
	__le64 size;
457
	__le64 nbytes;
458
	__le64 block_group;
Chris Mason's avatar
Chris Mason committed
459
460
461
462
	__le32 nlink;
	__le32 uid;
	__le32 gid;
	__le32 mode;
463
	__le64 rdev;
464
	__le64 flags;
465

466
467
468
469
	struct btrfs_timespec atime;
	struct btrfs_timespec ctime;
	struct btrfs_timespec mtime;
	struct btrfs_timespec otime;
Chris Mason's avatar
Chris Mason committed
470
471
} __attribute__ ((__packed__));

472
473
474
475
struct btrfs_dir_log_item {
	__le64 end;
} __attribute__ ((__packed__));

476
struct btrfs_dir_item {
477
	struct btrfs_disk_key location;
478
	__le64 transid;
Josef Bacik's avatar
Josef Bacik committed
479
	__le16 data_len;
480
	__le16 name_len;
481
482
483
484
	u8 type;
} __attribute__ ((__packed__));

struct btrfs_root_item {
485
	struct btrfs_inode_item inode;
486
	__le64 generation;
487
	__le64 root_dirid;
488
489
490
	__le64 bytenr;
	__le64 byte_limit;
	__le64 bytes_used;
Yan Zheng's avatar
Yan Zheng committed
491
	__le64 last_snapshot;
492
	__le64 flags;
493
	__le32 refs;
494
495
	struct btrfs_disk_key drop_progress;
	u8 drop_level;
496
	u8 level;
497
} __attribute__ ((__packed__));
498

499
500
501
502
503
504
505
506
507
/*
 * this is used for both forward and backward root refs
 */
struct btrfs_root_ref {
	__le64 dirid;
	__le64 sequence;
	__le16 name_len;
} __attribute__ ((__packed__));

Yan Zheng's avatar
Yan Zheng committed
508
509
510
#define BTRFS_FILE_EXTENT_INLINE 0
#define BTRFS_FILE_EXTENT_REG 1
#define BTRFS_FILE_EXTENT_PREALLOC 2
511

512
struct btrfs_file_extent_item {
513
514
515
	/*
	 * transaction id that created this extent
	 */
516
	__le64 generation;
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
	/*
	 * max number of bytes to hold this extent in ram
	 * when we split a compressed extent we can't know how big
	 * each of the resulting pieces will be.  So, this is
	 * an upper limit on the size of the extent in ram instead of
	 * an exact limit.
	 */
	__le64 ram_bytes;

	/*
	 * 32 bits for the various ways we might encode the data,
	 * including compression and encryption.  If any of these
	 * are set to something a given disk format doesn't understand
	 * it is treated like an incompat flag for reading and writing,
	 * but not for stat.
	 */
	u8 compression;
	u8 encryption;
	__le16 other_encoding; /* spare for later use */

	/* are we inline data or a real extent? */
538
	u8 type;
539

540
541
542
543
	/*
	 * disk space consumed by the extent, checksum blocks are included
	 * in these numbers
	 */
544
545
	__le64 disk_bytenr;
	__le64 disk_num_bytes;
546
	/*
Chris Mason's avatar
Chris Mason committed
547
	 * the logical offset in file blocks (no csums)
548
549
550
551
552
553
554
	 * this extent record is for.  This allows a file extent to point
	 * into the middle of an existing extent on disk, sharing it
	 * between two snapshots (useful if some bytes in the middle of the
	 * extent have changed
	 */
	__le64 offset;
	/*
555
556
	 * the logical number of file blocks (no csums included).  This
	 * always reflects the size uncompressed and without encoding.
557
	 */
558
	__le64 num_bytes;
559

560
561
} __attribute__ ((__packed__));

Chris Mason's avatar
Chris Mason committed
562
struct btrfs_csum_item {
563
	u8 csum;
Chris Mason's avatar
Chris Mason committed
564
565
} __attribute__ ((__packed__));

566
567
568
569
/* different types of block groups (and chunks) */
#define BTRFS_BLOCK_GROUP_DATA     (1 << 0)
#define BTRFS_BLOCK_GROUP_SYSTEM   (1 << 1)
#define BTRFS_BLOCK_GROUP_METADATA (1 << 2)
570
#define BTRFS_BLOCK_GROUP_RAID0    (1 << 3)
571
#define BTRFS_BLOCK_GROUP_RAID1    (1 << 4)
572
#define BTRFS_BLOCK_GROUP_DUP	   (1 << 5)
Chris Mason's avatar
Chris Mason committed
573
#define BTRFS_BLOCK_GROUP_RAID10   (1 << 6)
Chris Mason's avatar
Chris Mason committed
574

Chris Mason's avatar
Chris Mason committed
575
576
struct btrfs_block_group_item {
	__le64 used;
577
578
	__le64 chunk_objectid;
	__le64 flags;
Chris Mason's avatar
Chris Mason committed
579
580
} __attribute__ ((__packed__));

581
582
583
584
585
struct btrfs_space_info {
	u64 flags;
	u64 total_bytes;
	u64 bytes_used;
	u64 bytes_pinned;
586
	u64 bytes_reserved;
587
	u64 bytes_readonly;
588
	int full;
589
	int force_alloc;
590
	struct list_head list;
591
592
593
594

	/* for block groups in our same type */
	struct list_head block_groups;
	spinlock_t lock;
595
	struct rw_semaphore groups_sem;
596
597
598
599
600
601
602
};

struct btrfs_free_space {
	struct rb_node bytes_index;
	struct rb_node offset_index;
	u64 offset;
	u64 bytes;
603
604
};

Chris Mason's avatar
Chris Mason committed
605
606
607
struct btrfs_block_group_cache {
	struct btrfs_key key;
	struct btrfs_block_group_item item;
608
	spinlock_t lock;
609
	struct mutex alloc_mutex;
610
	struct mutex cache_mutex;
611
	u64 pinned;
612
	u64 reserved;
613
614
	u64 flags;
	int cached;
615
	int ro;
616
617
618
619
620
621
622
623
624
625
626
627
628
	int dirty;

	struct btrfs_space_info *space_info;

	/* free space cache stuff */
	struct rb_root free_space_bytes;
	struct rb_root free_space_offset;

	/* block group cache stuff */
	struct rb_node cache_node;

	/* for block groups in the same raid type */
	struct list_head list;
Chris Mason's avatar
Chris Mason committed
629
};
630

Zheng Yan's avatar
Zheng Yan committed
631
632
633
634
635
636
struct btrfs_leaf_ref_tree {
	struct rb_root root;
	struct list_head list;
	spinlock_t lock;
};

637
struct btrfs_device;
638
struct btrfs_fs_devices;
639
struct btrfs_fs_info {
640
	u8 fsid[BTRFS_FSID_SIZE];
641
	u8 chunk_tree_uuid[BTRFS_UUID_SIZE];
642
643
	struct btrfs_root *extent_root;
	struct btrfs_root *tree_root;
644
645
	struct btrfs_root *chunk_root;
	struct btrfs_root *dev_root;
646
	struct btrfs_root *fs_root;
647
	struct btrfs_root *csum_root;
648
649
650

	/* the log root tree is a directory of all the other log roots */
	struct btrfs_root *log_root_tree;
651
	struct radix_tree_root fs_roots_radix;
652

653
654
655
656
	/* block group cache stuff */
	spinlock_t block_group_cache_lock;
	struct rb_root block_group_cache_tree;

657
658
659
	struct extent_io_tree pinned_extents;
	struct extent_io_tree pending_del;
	struct extent_io_tree extent_ins;
660

661
662
663
	/* logical->physical extent mapping */
	struct btrfs_mapping_tree mapping_tree;

664
	u64 generation;
665
	u64 last_trans_committed;
666
	u64 last_trans_new_blockgroup;
667
	u64 open_ioctl_trans;
668
	unsigned long mount_opt;
669
	u64 max_extent;
670
	u64 max_inline;
671
	u64 alloc_start;
Chris Mason's avatar
Chris Mason committed
672
	struct btrfs_transaction *running_transaction;
673
	wait_queue_head_t transaction_throttle;
674
	wait_queue_head_t transaction_wait;
675

676
	wait_queue_head_t async_submit_wait;
677
678
	wait_queue_head_t tree_log_wait;

679
	struct btrfs_super_block super_copy;
680
	struct btrfs_super_block super_for_commit;
681
	struct block_device *__bdev;
Chris Mason's avatar
Chris Mason committed
682
	struct super_block *sb;
683
	struct inode *btree_inode;
Chris Mason's avatar
Chris Mason committed
684
	struct backing_dev_info bdi;
685
	spinlock_t hash_lock;
Chris Mason's avatar
Chris Mason committed
686
	struct mutex trans_mutex;
687
	struct mutex tree_log_mutex;
688
689
	struct mutex transaction_kthread_mutex;
	struct mutex cleaner_mutex;
690
691
	struct mutex extent_ins_mutex;
	struct mutex pinned_mutex;
692
	struct mutex chunk_mutex;
693
	struct mutex drop_mutex;
694
	struct mutex volume_mutex;
Zheng Yan's avatar
Zheng Yan committed
695
	struct mutex tree_reloc_mutex;
Chris Mason's avatar
Chris Mason committed
696
	struct list_head trans_list;
697
	struct list_head hashers;
698
	struct list_head dead_roots;
699

700
	atomic_t nr_async_submits;
701
	atomic_t async_submit_draining;
702
	atomic_t nr_async_bios;
703
	atomic_t async_delalloc_pages;
704
705
706
707
	atomic_t tree_log_writers;
	atomic_t tree_log_commit;
	unsigned long tree_log_batch;
	u64 tree_log_transid;
708

709
710
711
712
713
714
	/*
	 * this is used by the balancing code to wait for all the pending
	 * ordered extents
	 */
	spinlock_t ordered_extent_lock;
	struct list_head ordered_extents;
715
	struct list_head delalloc_inodes;
716

717
718
719
720
721
722
	/*
	 * there is a pool of worker threads for checksumming during writes
	 * and a pool for checksumming after reads.  This is because readers
	 * can run with FS locks held, and the writers may be waiting for
	 * those locks.  We don't want ordering in the pending list to cause
	 * deadlocks, and so the two are serviced separately.
723
724
725
	 *
	 * A third pool does submit_bio to avoid deadlocking with the other
	 * two
726
727
	 */
	struct btrfs_workers workers;
728
	struct btrfs_workers delalloc_workers;
729
	struct btrfs_workers endio_workers;
730
	struct btrfs_workers endio_meta_workers;
731
	struct btrfs_workers endio_write_workers;
732
	struct btrfs_workers submit_workers;
733
734
735
736
737
738
	/*
	 * fixup workers take dirty pages that didn't properly go through
	 * the cow mechanism and make them safe to write.  It happens
	 * for the sys_munmap function call path
	 */
	struct btrfs_workers fixup_workers;
739
740
	struct task_struct *transaction_kthread;
	struct task_struct *cleaner_kthread;
741
	int thread_pool_size;
742

Zheng Yan's avatar
Zheng Yan committed
743
744
745
	/* tree relocation relocated fields */
	struct list_head dead_reloc_roots;
	struct btrfs_leaf_ref_tree reloc_ref_tree;
Zheng Yan's avatar
Zheng Yan committed
746
747
	struct btrfs_leaf_ref_tree shared_ref_tree;

748
749
	struct kobject super_kobj;
	struct completion kobj_unregister;
750
	int do_barriers;
751
	int closing;
752
	int log_root_recovering;
753
	atomic_t throttles;
754
	atomic_t throttle_gen;
755

756
	u64 total_pinned;
757
758
	struct list_head dirty_cowonly_roots;

759
	struct btrfs_fs_devices *fs_devices;
760
	struct list_head space_info;
761
	spinlock_t delalloc_lock;
762
	spinlock_t new_trans_lock;
763
	u64 delalloc_bytes;
764
	u64 last_alloc;
765
	u64 last_data_alloc;
766

Yan Zheng's avatar
Yan Zheng committed
767
768
769
	spinlock_t ref_cache_lock;
	u64 total_ref_cache_size;

770
771
772
773
774
775
	u64 avail_data_alloc_bits;
	u64 avail_metadata_alloc_bits;
	u64 avail_system_alloc_bits;
	u64 data_alloc_profile;
	u64 metadata_alloc_profile;
	u64 system_alloc_profile;
776
777

	void *bdev_holder;
778
};
779

780
781
/*
 * in ram representation of the tree.  extent_root is used for all allocations
782
 * and for the extent tree extent_root root.
783
 */
784
struct btrfs_dirty_root;
785
struct btrfs_root {
786
	struct extent_buffer *node;
787
788
789
790

	/* the node lock is held while changing the node pointer */
	spinlock_t node_lock;

791
	struct extent_buffer *commit_root;
Yan Zheng's avatar
Yan Zheng committed
792
	struct btrfs_leaf_ref_tree *ref_tree;
793
	struct btrfs_leaf_ref_tree ref_tree_struct;
794
	struct btrfs_dirty_root *dirty_root;
795
	struct btrfs_root *log_root;
Zheng Yan's avatar
Zheng Yan committed
796
	struct btrfs_root *reloc_root;
Yan Zheng's avatar
Yan Zheng committed
797

798
799
	struct btrfs_root_item root_item;
	struct btrfs_key root_key;
800
	struct btrfs_fs_info *fs_info;
801
802
	struct extent_io_tree dirty_log_pages;

803
804
	struct kobject root_kobj;
	struct completion kobj_unregister;
805
	struct mutex objectid_mutex;
806
	struct mutex log_mutex;
807

808
809
	u64 objectid;
	u64 last_trans;
810
811
812
813
814
815
816
817
818
819

	/* data allocations are done in sectorsize units */
	u32 sectorsize;

	/* node allocations are done in nodesize units */
	u32 nodesize;

	/* leaf allocations are done in leafsize units */
	u32 leafsize;

820
821
	u32 stripesize;

822
	u32 type;
Chris Mason's avatar
Chris Mason committed
823
824
	u64 highest_inode;
	u64 last_inode_alloc;
825
	int ref_cows;
826
	int track_dirty;
827
	u64 defrag_trans_start;
828
	struct btrfs_key defrag_progress;
829
	struct btrfs_key defrag_max;
830
831
	int defrag_running;
	int defrag_level;
832
	char *name;
833
	int in_sysfs;
834
835
836

	/* the dirty list is only used by non-reference counted roots */
	struct list_head dirty_list;
837

838
839
	spinlock_t list_lock;
	struct list_head dead_list;
840
	struct list_head orphan_list;
841
842
843
844
845
846

	/*
	 * right now this just gets used so that a root has its own devid
	 * for stat.  It may be used for more later
	 */
	struct super_block anon_super;
847
848
};

Chris Mason's avatar
Chris Mason committed
849
/*
850

Chris Mason's avatar
Chris Mason committed
851
852
853
854
 * inode items have the data typically returned from stat and store other
 * info about object characteristics.  There is one for every file and dir in
 * the FS
 */
Chris Mason's avatar
Chris Mason committed
855
#define BTRFS_INODE_ITEM_KEY		1
856
857
858
#define BTRFS_INODE_REF_KEY		12
#define BTRFS_XATTR_ITEM_KEY		24
#define BTRFS_ORPHAN_ITEM_KEY		48
Chris Mason's avatar
Chris Mason committed
859
/* reserve 2-15 close to the inode for later flexibility */
Chris Mason's avatar
Chris Mason committed
860
861
862
863
864

/*
 * dir items are the name -> inode pointers in a directory.  There is one
 * for every name in a directory.
 */
865
866
867
868
#define BTRFS_DIR_LOG_ITEM_KEY  60
#define BTRFS_DIR_LOG_INDEX_KEY 72
#define BTRFS_DIR_ITEM_KEY	84
#define BTRFS_DIR_INDEX_KEY	96
Chris Mason's avatar
Chris Mason committed
869
/*
Chris Mason's avatar
Chris Mason committed
870
 * extent data is for file data
Chris Mason's avatar
Chris Mason committed
871
 */
872
#define BTRFS_EXTENT_DATA_KEY	108
873

Chris Mason's avatar
Chris Mason committed
874
/*
875
876
 * extent csums are stored in a separate tree and hold csums for
 * an entire extent on disk.
Chris Mason's avatar
Chris Mason committed
877
 */
878
#define BTRFS_EXTENT_CSUM_KEY	128
Chris Mason's avatar
Chris Mason committed
879

Chris Mason's avatar
Chris Mason committed
880
881
882
883
/*
 * root items point to tree roots.  There are typically in the root
 * tree used by the super block to find all the other trees
 */
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
#define BTRFS_ROOT_ITEM_KEY	132

/*
 * root backrefs tie subvols and snapshots to the directory entries that
 * reference them
 */
#define BTRFS_ROOT_BACKREF_KEY	144

/*
 * root refs make a fast index for listing all of the snapshots and
 * subvolumes referenced by a given root.  They point directly to the
 * directory item in the root that references the subvol
 */
#define BTRFS_ROOT_REF_KEY	156

Chris Mason's avatar
Chris Mason committed
899
900
901
902
/*
 * extent items are in the extent map tree.  These record which blocks
 * are used, and how many references there are to each block
 */
903
904
#define BTRFS_EXTENT_ITEM_KEY	168
#define BTRFS_EXTENT_REF_KEY	180
Chris Mason's avatar
Chris Mason committed
905
906
907
908
909

/*
 * block groups give us hints into the extent allocation trees.  Which
 * blocks are free etc etc
 */
910
#define BTRFS_BLOCK_GROUP_ITEM_KEY 192
911

912
913
914
#define BTRFS_DEV_EXTENT_KEY	204
#define BTRFS_DEV_ITEM_KEY	216
#define BTRFS_CHUNK_ITEM_KEY	228
915

Chris Mason's avatar
Chris Mason committed
916
917
918
919
/*
 * string items are for debugging.  They just store a short string of
 * data in the FS
 */
Chris Mason's avatar
Chris Mason committed
920
921
#define BTRFS_STRING_ITEM_KEY	253

922
923
924
#define BTRFS_MOUNT_NODATASUM		(1 << 0)
#define BTRFS_MOUNT_NODATACOW		(1 << 1)
#define BTRFS_MOUNT_NOBARRIER		(1 << 2)
925
#define BTRFS_MOUNT_SSD			(1 << 3)
926
#define BTRFS_MOUNT_DEGRADED		(1 << 4)
927
#define BTRFS_MOUNT_COMPRESS		(1 << 5)
928
929
930
931
932

#define btrfs_clear_opt(o, opt)		((o) &= ~BTRFS_MOUNT_##opt)
#define btrfs_set_opt(o, opt)		((o) |= BTRFS_MOUNT_##opt)
#define btrfs_test_opt(root, opt)	((root)->fs_info->mount_opt & \
					 BTRFS_MOUNT_##opt)
Yan's avatar
Yan committed
933
934
935
/*
 * Inode flags
 */
Yan's avatar
Yan committed
936
937
938
#define BTRFS_INODE_NODATASUM		(1 << 0)
#define BTRFS_INODE_NODATACOW		(1 << 1)
#define BTRFS_INODE_READONLY		(1 << 2)
939
#define BTRFS_INODE_NOCOMPRESS		(1 << 3)
Yan Zheng's avatar
Yan Zheng committed
940
#define BTRFS_INODE_PREALLOC		(1 << 4)
Yan's avatar
Yan committed
941
942
943
944
945
946
#define btrfs_clear_flag(inode, flag)	(BTRFS_I(inode)->flags &= \
					 ~BTRFS_INODE_##flag)
#define btrfs_set_flag(inode, flag)	(BTRFS_I(inode)->flags |= \
					 BTRFS_INODE_##flag)
#define btrfs_test_flag(inode, flag)	(BTRFS_I(inode)->flags & \
					 BTRFS_INODE_##flag)
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
/* some macros to generate set/get funcs for the struct fields.  This
 * assumes there is a lefoo_to_cpu for every type, so lets make a simple
 * one for u8:
 */
#define le8_to_cpu(v) (v)
#define cpu_to_le8(v) (v)
#define __le8 u8

#define read_eb_member(eb, ptr, type, member, result) (			\
	read_extent_buffer(eb, (char *)(result),			\
			   ((unsigned long)(ptr)) +			\
			    offsetof(type, member),			\
			   sizeof(((type *)0)->member)))

#define write_eb_member(eb, ptr, type, member, result) (		\
	write_extent_buffer(eb, (char *)(result),			\
			   ((unsigned long)(ptr)) +			\
			    offsetof(type, member),			\
			   sizeof(((type *)0)->member)))

967
#ifndef BTRFS_SETGET_FUNCS
968
#define BTRFS_SETGET_FUNCS(name, type, member, bits)			\
969
970
971
u##bits btrfs_##name(struct extent_buffer *eb, type *s);		\
void btrfs_set_##name(struct extent_buffer *eb, type *s, u##bits val);
#endif
972
973
974
975

#define BTRFS_SETGET_HEADER_FUNCS(name, type, member, bits)		\
static inline u##bits btrfs_##name(struct extent_buffer *eb)		\
{									\
David Miller's avatar
David Miller committed
976
977
978
	type *p = kmap_atomic(eb->first_page, KM_USER0);		\
	u##bits res = le##bits##_to_cpu(p->member);			\
	kunmap_atomic(p, KM_USER0);					\
979
	return res;							\
980
981
982
983
}									\
static inline void btrfs_set_##name(struct extent_buffer *eb,		\
				    u##bits val)			\
{									\
David Miller's avatar
David Miller committed
984
985
986
	type *p = kmap_atomic(eb->first_page, KM_USER0);		\
	p->member = cpu_to_le##bits(val);				\
	kunmap_atomic(p, KM_USER0);					\
987
}
Chris Mason's avatar
Chris Mason committed
988

989
990
991
992
993
994
995
996
#define BTRFS_SETGET_STACK_FUNCS(name, type, member, bits)		\
static inline u##bits btrfs_##name(type *s)				\
{									\
	return le##bits##_to_cpu(s->member);				\
}									\
static inline void btrfs_set_##name(type *s, u##bits val)		\
{									\
	s->member = cpu_to_le##bits(val);				\
Chris Mason's avatar
Chris Mason committed
997
998
}

999
1000
1001
1002
1003
1004
1005
BTRFS_SETGET_FUNCS(device_type, struct btrfs_dev_item, type, 64);
BTRFS_SETGET_FUNCS(device_total_bytes, struct btrfs_dev_item, total_bytes, 64);
BTRFS_SETGET_FUNCS(device_bytes_used, struct btrfs_dev_item, bytes_used, 64);
BTRFS_SETGET_FUNCS(device_io_align, struct btrfs_dev_item, io_align, 32);
BTRFS_SETGET_FUNCS(device_io_width, struct btrfs_dev_item, io_width, 32);
BTRFS_SETGET_FUNCS(device_sector_size, struct btrfs_dev_item, sector_size, 32);
BTRFS_SETGET_FUNCS(device_id, struct btrfs_dev_item, devid, 64);