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