xref: /openbmc/linux/fs/btrfs/btrfs_inode.h (revision df0af1a5)
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 #define BTRFS_INODE_IN_DELALLOC_LIST		9
44 
45 /* in memory btrfs inode */
46 struct btrfs_inode {
47 	/* which subvolume this inode belongs to */
48 	struct btrfs_root *root;
49 
50 	/* key used to find this inode on disk.  This is used by the code
51 	 * to read in roots of subvolumes
52 	 */
53 	struct btrfs_key location;
54 
55 	/* Lock for counters */
56 	spinlock_t lock;
57 
58 	/* the extent_tree has caches of all the extent mappings to disk */
59 	struct extent_map_tree extent_tree;
60 
61 	/* the io_tree does range state (DIRTY, LOCKED etc) */
62 	struct extent_io_tree io_tree;
63 
64 	/* special utility tree used to record which mirrors have already been
65 	 * tried when checksums fail for a given block
66 	 */
67 	struct extent_io_tree io_failure_tree;
68 
69 	/* held while logging the inode in tree-log.c */
70 	struct mutex log_mutex;
71 
72 	/* held while doing delalloc reservations */
73 	struct mutex delalloc_mutex;
74 
75 	/* used to order data wrt metadata */
76 	struct btrfs_ordered_inode_tree ordered_tree;
77 
78 	/* list of all the delalloc inodes in the FS.  There are times we need
79 	 * to write all the delalloc pages to disk, and this list is used
80 	 * to walk them all.
81 	 */
82 	struct list_head delalloc_inodes;
83 
84 	/*
85 	 * list for tracking inodes that must be sent to disk before a
86 	 * rename or truncate commit
87 	 */
88 	struct list_head ordered_operations;
89 
90 	/* node for the red-black tree that links inodes in subvolume root */
91 	struct rb_node rb_node;
92 
93 	unsigned long runtime_flags;
94 
95 	/* Keep track of who's O_SYNC/fsycing currently */
96 	atomic_t sync_writers;
97 
98 	/* full 64 bit generation number, struct vfs_inode doesn't have a big
99 	 * enough field for this.
100 	 */
101 	u64 generation;
102 
103 	/*
104 	 * transid of the trans_handle that last modified this inode
105 	 */
106 	u64 last_trans;
107 
108 	/*
109 	 * log transid when this inode was last modified
110 	 */
111 	u64 last_sub_trans;
112 
113 	/*
114 	 * transid that last logged this inode
115 	 */
116 	u64 logged_trans;
117 
118 	/* total number of bytes pending delalloc, used by stat to calc the
119 	 * real block usage of the file
120 	 */
121 	u64 delalloc_bytes;
122 
123 	/*
124 	 * the size of the file stored in the metadata on disk.  data=ordered
125 	 * means the in-memory i_size might be larger than the size on disk
126 	 * because not all the blocks are written yet.
127 	 */
128 	u64 disk_i_size;
129 
130 	/*
131 	 * if this is a directory then index_cnt is the counter for the index
132 	 * number for new files that are created
133 	 */
134 	u64 index_cnt;
135 
136 	/* the fsync log has some corner cases that mean we have to check
137 	 * directories to see if any unlinks have been done before
138 	 * the directory was logged.  See tree-log.c for all the
139 	 * details
140 	 */
141 	u64 last_unlink_trans;
142 
143 	/*
144 	 * Number of bytes outstanding that are going to need csums.  This is
145 	 * used in ENOSPC accounting.
146 	 */
147 	u64 csum_bytes;
148 
149 	/* flags field from the on disk inode */
150 	u32 flags;
151 
152 	/* a local copy of root's last_log_commit */
153 	unsigned long last_log_commit;
154 
155 	/*
156 	 * Counters to keep track of the number of extent item's we may use due
157 	 * to delalloc and such.  outstanding_extents is the number of extent
158 	 * items we think we'll end up using, and reserved_extents is the number
159 	 * of extent items we've reserved metadata for.
160 	 */
161 	unsigned outstanding_extents;
162 	unsigned reserved_extents;
163 
164 	/*
165 	 * always compress this one file
166 	 */
167 	unsigned force_compress;
168 
169 	struct btrfs_delayed_node *delayed_node;
170 
171 	struct inode vfs_inode;
172 };
173 
174 extern unsigned char btrfs_filetype_table[];
175 
176 static inline struct btrfs_inode *BTRFS_I(struct inode *inode)
177 {
178 	return container_of(inode, struct btrfs_inode, vfs_inode);
179 }
180 
181 static inline u64 btrfs_ino(struct inode *inode)
182 {
183 	u64 ino = BTRFS_I(inode)->location.objectid;
184 
185 	/*
186 	 * !ino: btree_inode
187 	 * type == BTRFS_ROOT_ITEM_KEY: subvol dir
188 	 */
189 	if (!ino || BTRFS_I(inode)->location.type == BTRFS_ROOT_ITEM_KEY)
190 		ino = inode->i_ino;
191 	return ino;
192 }
193 
194 static inline void btrfs_i_size_write(struct inode *inode, u64 size)
195 {
196 	i_size_write(inode, size);
197 	BTRFS_I(inode)->disk_i_size = size;
198 }
199 
200 static inline bool btrfs_is_free_space_inode(struct inode *inode)
201 {
202 	struct btrfs_root *root = BTRFS_I(inode)->root;
203 
204 	if (root == root->fs_info->tree_root &&
205 	    btrfs_ino(inode) != BTRFS_BTREE_INODE_OBJECTID)
206 		return true;
207 	if (BTRFS_I(inode)->location.objectid == BTRFS_FREE_INO_OBJECTID)
208 		return true;
209 	return false;
210 }
211 
212 static inline int btrfs_inode_in_log(struct inode *inode, u64 generation)
213 {
214 	if (BTRFS_I(inode)->logged_trans == generation &&
215 	    BTRFS_I(inode)->last_sub_trans <= BTRFS_I(inode)->last_log_commit)
216 		return 1;
217 	return 0;
218 }
219 
220 #endif
221