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