xref: /openbmc/linux/fs/btrfs/btrfs_inode.h (revision 54cbac81)
1 /*
2  * Copyright (C) 2007 Oracle.  All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public
6  * License v2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public
14  * License along with this program; if not, write to the
15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16  * Boston, MA 021110-1307, USA.
17  */
18 
19 #ifndef __BTRFS_I__
20 #define __BTRFS_I__
21 
22 #include "extent_map.h"
23 #include "extent_io.h"
24 #include "ordered-data.h"
25 #include "delayed-inode.h"
26 
27 /*
28  * ordered_data_close is set by truncate when a file that used
29  * to have good data has been truncated to zero.  When it is set
30  * the btrfs file release call will add this inode to the
31  * ordered operations list so that we make sure to flush out any
32  * new data the application may have written before commit.
33  */
34 #define BTRFS_INODE_ORDERED_DATA_CLOSE		0
35 #define BTRFS_INODE_ORPHAN_META_RESERVED	1
36 #define BTRFS_INODE_DUMMY			2
37 #define BTRFS_INODE_IN_DEFRAG			3
38 #define BTRFS_INODE_DELALLOC_META_RESERVED	4
39 #define BTRFS_INODE_HAS_ORPHAN_ITEM		5
40 #define BTRFS_INODE_HAS_ASYNC_EXTENT		6
41 #define BTRFS_INODE_NEEDS_FULL_SYNC		7
42 #define BTRFS_INODE_COPY_EVERYTHING		8
43 
44 /* in memory btrfs inode */
45 struct btrfs_inode {
46 	/* which subvolume this inode belongs to */
47 	struct btrfs_root *root;
48 
49 	/* key used to find this inode on disk.  This is used by the code
50 	 * to read in roots of subvolumes
51 	 */
52 	struct btrfs_key location;
53 
54 	/* Lock for counters */
55 	spinlock_t lock;
56 
57 	/* the extent_tree has caches of all the extent mappings to disk */
58 	struct extent_map_tree extent_tree;
59 
60 	/* the io_tree does range state (DIRTY, LOCKED etc) */
61 	struct extent_io_tree io_tree;
62 
63 	/* special utility tree used to record which mirrors have already been
64 	 * tried when checksums fail for a given block
65 	 */
66 	struct extent_io_tree io_failure_tree;
67 
68 	/* held while logging the inode in tree-log.c */
69 	struct mutex log_mutex;
70 
71 	/* held while doing delalloc reservations */
72 	struct mutex delalloc_mutex;
73 
74 	/* used to order data wrt metadata */
75 	struct btrfs_ordered_inode_tree ordered_tree;
76 
77 	/* list of all the delalloc inodes in the FS.  There are times we need
78 	 * to write all the delalloc pages to disk, and this list is used
79 	 * to walk them all.
80 	 */
81 	struct list_head delalloc_inodes;
82 
83 	/*
84 	 * list for tracking inodes that must be sent to disk before a
85 	 * rename or truncate commit
86 	 */
87 	struct list_head ordered_operations;
88 
89 	/* node for the red-black tree that links inodes in subvolume root */
90 	struct rb_node rb_node;
91 
92 	unsigned long runtime_flags;
93 
94 	/* Keep track of who's O_SYNC/fsycing currently */
95 	atomic_t sync_writers;
96 
97 	/* full 64 bit generation number, struct vfs_inode doesn't have a big
98 	 * enough field for this.
99 	 */
100 	u64 generation;
101 
102 	/*
103 	 * transid of the trans_handle that last modified this inode
104 	 */
105 	u64 last_trans;
106 
107 	/*
108 	 * log transid when this inode was last modified
109 	 */
110 	u64 last_sub_trans;
111 
112 	/*
113 	 * transid that last logged this inode
114 	 */
115 	u64 logged_trans;
116 
117 	/* total number of bytes pending delalloc, used by stat to calc the
118 	 * real block usage of the file
119 	 */
120 	u64 delalloc_bytes;
121 
122 	/*
123 	 * the size of the file stored in the metadata on disk.  data=ordered
124 	 * means the in-memory i_size might be larger than the size on disk
125 	 * because not all the blocks are written yet.
126 	 */
127 	u64 disk_i_size;
128 
129 	/*
130 	 * if this is a directory then index_cnt is the counter for the index
131 	 * number for new files that are created
132 	 */
133 	u64 index_cnt;
134 
135 	/* the fsync log has some corner cases that mean we have to check
136 	 * directories to see if any unlinks have been done before
137 	 * the directory was logged.  See tree-log.c for all the
138 	 * details
139 	 */
140 	u64 last_unlink_trans;
141 
142 	/*
143 	 * Number of bytes outstanding that are going to need csums.  This is
144 	 * used in ENOSPC accounting.
145 	 */
146 	u64 csum_bytes;
147 
148 	/* flags field from the on disk inode */
149 	u32 flags;
150 
151 	/* a local copy of root's last_log_commit */
152 	unsigned long last_log_commit;
153 
154 	/*
155 	 * Counters to keep track of the number of extent item's we may use due
156 	 * to delalloc and such.  outstanding_extents is the number of extent
157 	 * items we think we'll end up using, and reserved_extents is the number
158 	 * of extent items we've reserved metadata for.
159 	 */
160 	unsigned outstanding_extents;
161 	unsigned reserved_extents;
162 
163 	/*
164 	 * always compress this one file
165 	 */
166 	unsigned force_compress;
167 
168 	struct btrfs_delayed_node *delayed_node;
169 
170 	struct inode vfs_inode;
171 };
172 
173 extern unsigned char btrfs_filetype_table[];
174 
175 static inline struct btrfs_inode *BTRFS_I(struct inode *inode)
176 {
177 	return container_of(inode, struct btrfs_inode, vfs_inode);
178 }
179 
180 static inline u64 btrfs_ino(struct inode *inode)
181 {
182 	u64 ino = BTRFS_I(inode)->location.objectid;
183 
184 	/*
185 	 * !ino: btree_inode
186 	 * type == BTRFS_ROOT_ITEM_KEY: subvol dir
187 	 */
188 	if (!ino || BTRFS_I(inode)->location.type == BTRFS_ROOT_ITEM_KEY)
189 		ino = inode->i_ino;
190 	return ino;
191 }
192 
193 static inline void btrfs_i_size_write(struct inode *inode, u64 size)
194 {
195 	i_size_write(inode, size);
196 	BTRFS_I(inode)->disk_i_size = size;
197 }
198 
199 static inline bool btrfs_is_free_space_inode(struct inode *inode)
200 {
201 	struct btrfs_root *root = BTRFS_I(inode)->root;
202 
203 	if (root == root->fs_info->tree_root &&
204 	    btrfs_ino(inode) != BTRFS_BTREE_INODE_OBJECTID)
205 		return true;
206 	if (BTRFS_I(inode)->location.objectid == BTRFS_FREE_INO_OBJECTID)
207 		return true;
208 	return false;
209 }
210 
211 static inline int btrfs_inode_in_log(struct inode *inode, u64 generation)
212 {
213 	if (BTRFS_I(inode)->logged_trans == generation &&
214 	    BTRFS_I(inode)->last_sub_trans <= BTRFS_I(inode)->last_log_commit)
215 		return 1;
216 	return 0;
217 }
218 
219 #endif
220