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