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