blob: f0e4d79833e19dcb272dfd4b19c8000c0e344497 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Nathan Scott7b718762005-11-02 14:58:39 +11002 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Nathan Scott7b718762005-11-02 14:58:39 +11005 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * published by the Free Software Foundation.
8 *
Nathan Scott7b718762005-11-02 14:58:39 +11009 * This program is distributed in the hope that it would be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
Nathan Scott7b718762005-11-02 14:58:39 +110014 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write the Free Software Foundation,
16 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 */
18#ifndef __XFS_INODE_H__
19#define __XFS_INODE_H__
20
Christoph Hellwig347d1c02007-08-28 13:57:51 +100021struct xfs_dinode;
Barry Naujok847fff52008-10-30 17:05:38 +110022struct xfs_inode;
Christoph Hellwig347d1c02007-08-28 13:57:51 +100023
Linus Torvalds1da177e2005-04-16 15:20:36 -070024/*
Nathan Scotta844f452005-11-02 14:38:42 +110025 * Fork identifiers.
26 */
27#define XFS_DATA_FORK 0
28#define XFS_ATTR_FORK 1
29
30/*
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110031 * The following xfs_ext_irec_t struct introduces a second (top) level
32 * to the in-core extent allocation scheme. These structs are allocated
33 * in a contiguous block, creating an indirection array where each entry
34 * (irec) contains a pointer to a buffer of in-core extent records which
35 * it manages. Each extent buffer is 4k in size, since 4k is the system
36 * page size on Linux i386 and systems with larger page sizes don't seem
37 * to gain much, if anything, by using their native page size as the
38 * extent buffer size. Also, using 4k extent buffers everywhere provides
39 * a consistent interface for CXFS across different platforms.
40 *
41 * There is currently no limit on the number of irec's (extent lists)
42 * allowed, so heavily fragmented files may require an indirection array
43 * which spans multiple system pages of memory. The number of extents
44 * which would require this amount of contiguous memory is very large
45 * and should not cause problems in the foreseeable future. However,
46 * if the memory needed for the contiguous array ever becomes a problem,
47 * it is possible that a third level of indirection may be required.
48 */
49typedef struct xfs_ext_irec {
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100050 xfs_bmbt_rec_host_t *er_extbuf; /* block of extent records */
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110051 xfs_extnum_t er_extoff; /* extent offset in file */
52 xfs_extnum_t er_extcount; /* number of extents in page/block */
53} xfs_ext_irec_t;
54
55/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 * File incore extent information, present for each of data & attr forks.
57 */
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110058#define XFS_IEXT_BUFSZ 4096
59#define XFS_LINEAR_EXTS (XFS_IEXT_BUFSZ / (uint)sizeof(xfs_bmbt_rec_t))
60#define XFS_INLINE_EXTS 2
61#define XFS_INLINE_DATA 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070062typedef struct xfs_ifork {
63 int if_bytes; /* bytes in if_u1 */
64 int if_real_bytes; /* bytes allocated in if_u1 */
Christoph Hellwig7cc95a82008-10-30 17:14:34 +110065 struct xfs_btree_block *if_broot; /* file's incore btree root */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 short if_broot_bytes; /* bytes allocated for root */
67 unsigned char if_flags; /* per-fork flags */
68 unsigned char if_ext_max; /* max # of extent records */
69 xfs_extnum_t if_lastex; /* last if_extents used */
70 union {
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100071 xfs_bmbt_rec_host_t *if_extents;/* linear map file exts */
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110072 xfs_ext_irec_t *if_ext_irec; /* irec map file exts */
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 char *if_data; /* inline file data */
74 } if_u1;
75 union {
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100076 xfs_bmbt_rec_host_t if_inline_ext[XFS_INLINE_EXTS];
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 /* very small file extents */
78 char if_inline_data[XFS_INLINE_DATA];
79 /* very small file data */
80 xfs_dev_t if_rdev; /* dev number if special */
81 uuid_t if_uuid; /* mount point value */
82 } if_u2;
83} xfs_ifork_t;
84
85/*
Christoph Hellwig92bfc6e2008-11-28 14:23:41 +110086 * Inode location information. Stored in the inode and passed to
87 * xfs_imap_to_bp() to get a buffer and dinode for a given inode.
88 */
89struct xfs_imap {
90 xfs_daddr_t im_blkno; /* starting BB of inode chunk */
91 ushort im_len; /* length in BBs of inode chunk */
92 ushort im_boffset; /* inode offset in block in bytes */
93};
94
95/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * This is the xfs in-core inode structure.
97 * Most of the on-disk inode is embedded in the i_d field.
98 *
99 * The extent pointers/inline file space, however, are managed
100 * separately. The memory for this information is pointed to by
101 * the if_u1 unions depending on the type of the data.
102 * This is used to linearize the array of extents for fast in-core
103 * access. This is used until the file's number of extents
104 * surpasses XFS_MAX_INCORE_EXTENTS, at which point all extent pointers
105 * are accessed through the buffer cache.
106 *
107 * Other state kept in the in-core inode is used for identification,
108 * locking, transactional updating, etc of the inode.
109 *
110 * Generally, we do not want to hold the i_rlock while holding the
111 * i_ilock. Hierarchy is i_iolock followed by i_rlock.
112 *
113 * xfs_iptr_t contains all the inode fields upto and including the
114 * i_mnext and i_mprev fields, it is used as a marker in the inode
115 * chain off the mount structure by xfs_sync calls.
116 */
117
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000118typedef struct xfs_ictimestamp {
119 __int32_t t_sec; /* timestamp seconds */
120 __int32_t t_nsec; /* timestamp nanoseconds */
121} xfs_ictimestamp_t;
122
123/*
Christoph Hellwig81591fe2008-11-28 14:23:39 +1100124 * NOTE: This structure must be kept identical to struct xfs_dinode
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000125 * in xfs_dinode.h except for the endianess annotations.
126 */
127typedef struct xfs_icdinode {
128 __uint16_t di_magic; /* inode magic # = XFS_DINODE_MAGIC */
129 __uint16_t di_mode; /* mode and type of file */
130 __int8_t di_version; /* inode version */
131 __int8_t di_format; /* format of di_c data */
132 __uint16_t di_onlink; /* old number of links to file */
133 __uint32_t di_uid; /* owner's user id */
134 __uint32_t di_gid; /* owner's group id */
135 __uint32_t di_nlink; /* number of links to file */
136 __uint16_t di_projid; /* owner's project id */
137 __uint8_t di_pad[8]; /* unused, zeroed space */
138 __uint16_t di_flushiter; /* incremented on flush */
139 xfs_ictimestamp_t di_atime; /* time last accessed */
140 xfs_ictimestamp_t di_mtime; /* time last modified */
141 xfs_ictimestamp_t di_ctime; /* time created/inode modified */
142 xfs_fsize_t di_size; /* number of bytes in file */
143 xfs_drfsbno_t di_nblocks; /* # of direct & btree blocks used */
144 xfs_extlen_t di_extsize; /* basic/minimum extent size for file */
145 xfs_extnum_t di_nextents; /* number of extents in data fork */
146 xfs_aextnum_t di_anextents; /* number of extents in attribute fork*/
147 __uint8_t di_forkoff; /* attr fork offs, <<3 for 64b align */
148 __int8_t di_aformat; /* format of attr fork's data */
149 __uint32_t di_dmevmask; /* DMIG event mask */
150 __uint16_t di_dmstate; /* DMIG state info */
151 __uint16_t di_flags; /* random flags, XFS_DIFLAG_... */
152 __uint32_t di_gen; /* generation number */
153} xfs_icdinode_t;
154
Barry Naujok847fff52008-10-30 17:05:38 +1100155/*
156 * Flags for xfs_ichgtime().
157 */
158#define XFS_ICHGTIME_MOD 0x1 /* data fork modification timestamp */
159#define XFS_ICHGTIME_CHG 0x2 /* inode field change timestamp */
160
161/*
162 * Per-fork incore inode flags.
163 */
164#define XFS_IFINLINE 0x01 /* Inline data is read in */
165#define XFS_IFEXTENTS 0x02 /* All extent pointers are read in */
166#define XFS_IFBROOT 0x04 /* i_broot points to the bmap b-tree root */
167#define XFS_IFEXTIREC 0x08 /* Indirection array of extent blocks */
168
169/*
Barry Naujok847fff52008-10-30 17:05:38 +1100170 * Fork handling.
171 */
172
173#define XFS_IFORK_Q(ip) ((ip)->i_d.di_forkoff != 0)
174#define XFS_IFORK_BOFF(ip) ((int)((ip)->i_d.di_forkoff << 3))
175
176#define XFS_IFORK_PTR(ip,w) \
177 ((w) == XFS_DATA_FORK ? \
178 &(ip)->i_df : \
179 (ip)->i_afp)
180#define XFS_IFORK_DSIZE(ip) \
181 (XFS_IFORK_Q(ip) ? \
182 XFS_IFORK_BOFF(ip) : \
183 XFS_LITINO((ip)->i_mount))
184#define XFS_IFORK_ASIZE(ip) \
185 (XFS_IFORK_Q(ip) ? \
186 XFS_LITINO((ip)->i_mount) - XFS_IFORK_BOFF(ip) : \
187 0)
188#define XFS_IFORK_SIZE(ip,w) \
189 ((w) == XFS_DATA_FORK ? \
190 XFS_IFORK_DSIZE(ip) : \
191 XFS_IFORK_ASIZE(ip))
192#define XFS_IFORK_FORMAT(ip,w) \
193 ((w) == XFS_DATA_FORK ? \
194 (ip)->i_d.di_format : \
195 (ip)->i_d.di_aformat)
196#define XFS_IFORK_FMT_SET(ip,w,n) \
197 ((w) == XFS_DATA_FORK ? \
198 ((ip)->i_d.di_format = (n)) : \
199 ((ip)->i_d.di_aformat = (n)))
200#define XFS_IFORK_NEXTENTS(ip,w) \
201 ((w) == XFS_DATA_FORK ? \
202 (ip)->i_d.di_nextents : \
203 (ip)->i_d.di_anextents)
204#define XFS_IFORK_NEXT_SET(ip,w,n) \
205 ((w) == XFS_DATA_FORK ? \
206 ((ip)->i_d.di_nextents = (n)) : \
207 ((ip)->i_d.di_anextents = (n)))
208
209
210
211#ifdef __KERNEL__
212
213struct bhv_desc;
214struct cred;
215struct ktrace;
216struct xfs_buf;
217struct xfs_bmap_free;
218struct xfs_bmbt_irec;
Barry Naujok847fff52008-10-30 17:05:38 +1100219struct xfs_inode_log_item;
220struct xfs_mount;
221struct xfs_trans;
222struct xfs_dquot;
223
224#if defined(XFS_ILOCK_TRACE)
225#define XFS_ILOCK_KTRACE_SIZE 32
Barry Naujok847fff52008-10-30 17:05:38 +1100226extern void xfs_ilock_trace(struct xfs_inode *, int, unsigned int, inst_t *);
227#else
228#define xfs_ilock_trace(i,n,f,ra)
229#endif
230
231typedef struct dm_attrs_s {
232 __uint32_t da_dmevmask; /* DMIG event mask */
233 __uint16_t da_dmstate; /* DMIG state info */
234 __uint16_t da_pad; /* DMIG extra padding */
235} dm_attrs_t;
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237typedef struct xfs_inode {
238 /* Inode linking and identification information. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 struct xfs_mount *i_mount; /* fs mount struct ptr */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 struct xfs_dquot *i_udquot; /* user dquot */
241 struct xfs_dquot *i_gdquot; /* group dquot */
242
243 /* Inode location stuff */
244 xfs_ino_t i_ino; /* inode number (agno/agino)*/
Christoph Hellwig92bfc6e2008-11-28 14:23:41 +1100245 struct xfs_imap i_imap; /* location for xfs_imap() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
247 /* Extent information. */
248 xfs_ifork_t *i_afp; /* attribute fork pointer */
249 xfs_ifork_t i_df; /* data fork */
250
251 /* Transaction and locking information. */
252 struct xfs_trans *i_transp; /* ptr to owning transaction*/
253 struct xfs_inode_log_item *i_itemp; /* logging information */
254 mrlock_t i_lock; /* inode lock */
255 mrlock_t i_iolock; /* inode IO lock */
David Chinnerc63942d2008-08-13 16:41:16 +1000256 struct completion i_flush; /* inode flush completion q */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 atomic_t i_pincount; /* inode pin count */
258 wait_queue_head_t i_ipin_wait; /* inode pinning wait queue */
David Chinnerf273ab82006-09-28 11:06:03 +1000259 spinlock_t i_flags_lock; /* inode i_flags lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 /* Miscellaneous state. */
261 unsigned short i_flags; /* see defined flags below */
262 unsigned char i_update_core; /* timestamps/size is dirty */
263 unsigned char i_update_size; /* di_size field is dirty */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 unsigned int i_delayed_blks; /* count of delay alloc blks */
265
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000266 xfs_icdinode_t i_d; /* most of ondisk inode */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Lachlan McIlroyba87ea62007-05-08 13:49:46 +1000268 xfs_fsize_t i_size; /* in-memory size */
Christoph Hellwig613d7042007-10-11 17:44:08 +1000269 xfs_fsize_t i_new_size; /* size when write completes */
Christoph Hellwigb677c212007-08-29 11:46:28 +1000270 atomic_t i_iocount; /* outstanding I/O count */
David Chinnerbf904242008-10-30 17:36:14 +1100271
272 /* VFS inode */
273 struct inode i_vnode; /* embedded VFS inode */
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 /* Trace buffers per inode. */
Lachlan McIlroycf441ee2008-02-07 16:42:19 +1100276#ifdef XFS_INODE_TRACE
Christoph Hellwig1543d792007-08-29 11:46:47 +1000277 struct ktrace *i_trace; /* general inode trace */
278#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279#ifdef XFS_BMAP_TRACE
280 struct ktrace *i_xtrace; /* inode extent list trace */
281#endif
Christoph Hellwig8c4ed632008-10-30 16:55:13 +1100282#ifdef XFS_BTREE_TRACE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 struct ktrace *i_btrace; /* inode bmap btree trace */
284#endif
285#ifdef XFS_RW_TRACE
286 struct ktrace *i_rwtrace; /* inode read/write trace */
287#endif
288#ifdef XFS_ILOCK_TRACE
289 struct ktrace *i_lock_trace; /* inode lock/unlock trace */
290#endif
291#ifdef XFS_DIR2_TRACE
292 struct ktrace *i_dir_trace; /* inode directory trace */
293#endif
294} xfs_inode_t;
295
Lachlan McIlroyba87ea62007-05-08 13:49:46 +1000296#define XFS_ISIZE(ip) (((ip)->i_d.di_mode & S_IFMT) == S_IFREG) ? \
297 (ip)->i_size : (ip)->i_d.di_size;
David Chinner7a18c382006-11-11 18:04:54 +1100298
David Chinner01651642008-08-13 15:45:15 +1000299/* Convert from vfs inode to xfs inode */
300static inline struct xfs_inode *XFS_I(struct inode *inode)
301{
David Chinnerbf904242008-10-30 17:36:14 +1100302 return container_of(inode, struct xfs_inode, i_vnode);
David Chinner01651642008-08-13 15:45:15 +1000303}
304
David Chinner01651642008-08-13 15:45:15 +1000305/* convert from xfs inode to vfs inode */
306static inline struct inode *VFS_I(struct xfs_inode *ip)
307{
David Chinnerbf904242008-10-30 17:36:14 +1100308 return &ip->i_vnode;
David Chinner01651642008-08-13 15:45:15 +1000309}
David Chinner01651642008-08-13 15:45:15 +1000310
David Chinner7a18c382006-11-11 18:04:54 +1100311/*
Christoph Hellwig9ed04512008-10-30 18:26:04 +1100312 * Get rid of a partially initialized inode.
313 *
314 * We have to go through destroy_inode to make sure allocations
315 * from init_inode_always like the security data are undone.
316 *
317 * We mark the inode bad so that it takes the short cut in
318 * the reclaim path instead of going through the flush path
319 * which doesn't make sense for an inode that has never seen the
320 * light of day.
321 */
322static inline void xfs_destroy_inode(struct xfs_inode *ip)
323{
324 make_bad_inode(VFS_I(ip));
325 return destroy_inode(VFS_I(ip));
326}
327
328/*
David Chinner7a18c382006-11-11 18:04:54 +1100329 * i_flags helper functions
330 */
331static inline void
332__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
333{
334 ip->i_flags |= flags;
335}
336
337static inline void
338xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
339{
340 spin_lock(&ip->i_flags_lock);
341 __xfs_iflags_set(ip, flags);
342 spin_unlock(&ip->i_flags_lock);
343}
344
345static inline void
346xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
347{
348 spin_lock(&ip->i_flags_lock);
349 ip->i_flags &= ~flags;
350 spin_unlock(&ip->i_flags_lock);
351}
352
353static inline int
354__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
355{
356 return (ip->i_flags & flags);
357}
358
359static inline int
360xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
361{
362 int ret;
363 spin_lock(&ip->i_flags_lock);
364 ret = __xfs_iflags_test(ip, flags);
365 spin_unlock(&ip->i_flags_lock);
366 return ret;
367}
Christoph Hellwig09262b432007-08-29 11:44:50 +1000368
369static inline int
370xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
371{
372 int ret;
373
374 spin_lock(&ip->i_flags_lock);
375 ret = ip->i_flags & flags;
376 if (ret)
377 ip->i_flags &= ~flags;
378 spin_unlock(&ip->i_flags_lock);
379 return ret;
380}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382/*
Barry Naujok847fff52008-10-30 17:05:38 +1100383 * Manage the i_flush queue embedded in the inode. This completion
384 * queue synchronizes processes attempting to flush the in-core
385 * inode back to disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 */
Barry Naujok847fff52008-10-30 17:05:38 +1100387static inline void xfs_iflock(xfs_inode_t *ip)
388{
389 wait_for_completion(&ip->i_flush);
390}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Barry Naujok847fff52008-10-30 17:05:38 +1100392static inline int xfs_iflock_nowait(xfs_inode_t *ip)
393{
394 return try_wait_for_completion(&ip->i_flush);
395}
Christoph Hellwig45ba5982007-12-07 14:07:20 +1100396
Barry Naujok847fff52008-10-30 17:05:38 +1100397static inline void xfs_ifunlock(xfs_inode_t *ip)
398{
399 complete(&ip->i_flush);
400}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402/*
403 * In-core inode flags.
404 */
Christoph Hellwig6bd16ff2008-12-03 12:20:32 +0100405#define XFS_IRECLAIM 0x0001 /* we have started reclaiming this inode */
406#define XFS_ISTALE 0x0002 /* inode has been staled */
407#define XFS_IRECLAIMABLE 0x0004 /* inode can be reclaimed */
408#define XFS_INEW 0x0008 /* inode has just been allocated */
409#define XFS_IFILESTREAM 0x0010 /* inode is in a filestream directory */
410#define XFS_ITRUNCATED 0x0020 /* truncated down so flush-on-close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412/*
413 * Flags for inode locking.
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000414 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
415 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 */
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000417#define XFS_IOLOCK_EXCL (1<<0)
418#define XFS_IOLOCK_SHARED (1<<1)
419#define XFS_ILOCK_EXCL (1<<2)
420#define XFS_ILOCK_SHARED (1<<3)
421#define XFS_IUNLOCK_NONOTIFY (1<<4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000423#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000424 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000425
426/*
427 * Flags for lockdep annotations.
428 *
429 * XFS_I[O]LOCK_PARENT - for operations that require locking two inodes
430 * (ie directory operations that require locking a directory inode and
431 * an entry inode). The first inode gets locked with this flag so it
432 * gets a lockdep subclass of 1 and the second lock will have a lockdep
433 * subclass of 0.
434 *
David Chinner0f1145c2007-06-29 17:26:09 +1000435 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000436 * with xfs_lock_inodes(). This flag is used as the starting subclass
437 * and each subsequent lock acquired will increment the subclass by one.
438 * So the first lock acquired will have a lockdep subclass of 2, the
David Chinner0f1145c2007-06-29 17:26:09 +1000439 * second lock will have a lockdep subclass of 3, and so on. It is
440 * the responsibility of the class builder to shift this to the correct
441 * portion of the lock_mode lockdep mask.
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000442 */
David Chinner0f1145c2007-06-29 17:26:09 +1000443#define XFS_LOCK_PARENT 1
444#define XFS_LOCK_INUMORDER 2
445
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000446#define XFS_IOLOCK_SHIFT 16
David Chinner0f1145c2007-06-29 17:26:09 +1000447#define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000448
449#define XFS_ILOCK_SHIFT 24
David Chinner0f1145c2007-06-29 17:26:09 +1000450#define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000451
452#define XFS_IOLOCK_DEP_MASK 0x00ff0000
453#define XFS_ILOCK_DEP_MASK 0xff000000
454#define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK)
455
456#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT)
457#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459/*
460 * Flags for xfs_iflush()
461 */
462#define XFS_IFLUSH_DELWRI_ELSE_SYNC 1
463#define XFS_IFLUSH_DELWRI_ELSE_ASYNC 2
464#define XFS_IFLUSH_SYNC 3
465#define XFS_IFLUSH_ASYNC 4
466#define XFS_IFLUSH_DELWRI 5
David Chinnera3f74ff2008-03-06 13:43:42 +1100467#define XFS_IFLUSH_ASYNC_NOBLOCK 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 * Flags for xfs_itruncate_start().
471 */
472#define XFS_ITRUNC_DEFINITE 0x1
473#define XFS_ITRUNC_MAYBE 0x2
474
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475/*
476 * For multiple groups support: if S_ISGID bit is set in the parent
477 * directory, group of new file is set to that of the parent, and
478 * new subdirectory gets S_ISGID bit from parent.
479 */
Christoph Hellwigbd186aa2007-08-30 17:21:12 +1000480#define XFS_INHERIT_GID(pip) \
481 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
482 ((pip)->i_d.di_mode & S_ISGID))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
484/*
485 * xfs_iget.c prototypes.
486 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487xfs_inode_t *xfs_inode_incore(struct xfs_mount *, xfs_ino_t,
488 struct xfs_trans *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489int xfs_iget(struct xfs_mount *, struct xfs_trans *, xfs_ino_t,
490 uint, uint, xfs_inode_t **, xfs_daddr_t);
491void xfs_iput(xfs_inode_t *, uint);
492void xfs_iput_new(xfs_inode_t *, uint);
493void xfs_ilock(xfs_inode_t *, uint);
494int xfs_ilock_nowait(xfs_inode_t *, uint);
495void xfs_iunlock(xfs_inode_t *, uint);
496void xfs_ilock_demote(xfs_inode_t *, uint);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000497int xfs_isilocked(xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498uint xfs_ilock_map_shared(xfs_inode_t *);
499void xfs_iunlock_map_shared(xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500void xfs_ireclaim(xfs_inode_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
502/*
503 * xfs_inode.c prototypes.
504 */
Nathan Scott31b084a2005-05-05 13:25:00 -0700505int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, mode_t,
506 xfs_nlink_t, xfs_dev_t, struct cred *, xfs_prid_t,
507 int, struct xfs_buf **, boolean_t *, xfs_inode_t **);
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509uint xfs_ip2xflags(struct xfs_inode *);
Christoph Hellwig45ba5982007-12-07 14:07:20 +1100510uint xfs_dic2xflags(struct xfs_dinode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
512 struct xfs_bmap_free *);
Lachlan McIlroyd3cf20942007-05-08 13:49:27 +1000513int xfs_itruncate_start(xfs_inode_t *, uint, xfs_fsize_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514int xfs_itruncate_finish(struct xfs_trans **, xfs_inode_t *,
515 xfs_fsize_t, int, int);
516int xfs_iunlink(struct xfs_trans *, xfs_inode_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518void xfs_iext_realloc(xfs_inode_t *, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519void xfs_ipin(xfs_inode_t *);
520void xfs_iunpin(xfs_inode_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521int xfs_iflush(xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522void xfs_ichgtime(xfs_inode_t *, int);
523xfs_fsize_t xfs_file_last_byte(xfs_inode_t *);
Christoph Hellwigcfa853e2008-04-22 17:34:06 +1000524void xfs_lock_inodes(xfs_inode_t **, int, uint);
Christoph Hellwige1cccd92008-08-13 16:18:07 +1000525void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Christoph Hellwig42fe2b12006-01-11 15:35:17 +1100527void xfs_synchronize_atime(xfs_inode_t *);
David Chinner5d51eff2007-11-23 16:29:18 +1100528void xfs_mark_inode_dirty_sync(xfs_inode_t *);
Christoph Hellwig42fe2b12006-01-11 15:35:17 +1100529
Christoph Hellwig5a8d0f32008-12-03 12:20:40 +0100530#if defined(XFS_INODE_TRACE)
531
532#define INODE_TRACE_SIZE 16 /* number of trace entries */
533#define INODE_KTRACE_ENTRY 1
534#define INODE_KTRACE_EXIT 2
535#define INODE_KTRACE_HOLD 3
536#define INODE_KTRACE_REF 4
537#define INODE_KTRACE_RELE 5
538
539extern void _xfs_itrace_entry(struct xfs_inode *, const char *, inst_t *);
540extern void _xfs_itrace_exit(struct xfs_inode *, const char *, inst_t *);
541extern void xfs_itrace_hold(struct xfs_inode *, char *, int, inst_t *);
542extern void _xfs_itrace_ref(struct xfs_inode *, char *, int, inst_t *);
543extern void xfs_itrace_rele(struct xfs_inode *, char *, int, inst_t *);
544#define xfs_itrace_entry(ip) \
545 _xfs_itrace_entry(ip, __func__, (inst_t *)__return_address)
546#define xfs_itrace_exit(ip) \
547 _xfs_itrace_exit(ip, __func__, (inst_t *)__return_address)
548#define xfs_itrace_exit_tag(ip, tag) \
549 _xfs_itrace_exit(ip, tag, (inst_t *)__return_address)
550#define xfs_itrace_ref(ip) \
551 _xfs_itrace_ref(ip, __FILE__, __LINE__, (inst_t *)__return_address)
552
553#else
554#define xfs_itrace_entry(a)
555#define xfs_itrace_exit(a)
556#define xfs_itrace_exit_tag(a, b)
557#define xfs_itrace_hold(a, b, c, d)
558#define xfs_itrace_ref(a)
559#define xfs_itrace_rele(a, b, c, d)
560#endif
561
562#define IHOLD(ip) \
563do { \
564 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
565 atomic_inc(&(VFS_I(ip)->i_count)); \
566 xfs_itrace_hold((ip), __FILE__, __LINE__, (inst_t *)__return_address); \
567} while (0)
568
569#define IRELE(ip) \
570do { \
571 xfs_itrace_rele((ip), __FILE__, __LINE__, (inst_t *)__return_address); \
572 iput(VFS_I(ip)); \
573} while (0)
574
Barry Naujok847fff52008-10-30 17:05:38 +1100575#endif /* __KERNEL__ */
576
Christoph Hellwig6d73cf12008-12-09 04:47:32 -0500577/*
578 * Flags for xfs_iget()
579 */
580#define XFS_IGET_CREATE 0x1
581#define XFS_IGET_BULKSTAT 0x2
582
Christoph Hellwigc679eef2008-10-30 18:04:13 +1100583int xfs_inotobp(struct xfs_mount *, struct xfs_trans *,
584 xfs_ino_t, struct xfs_dinode **,
585 struct xfs_buf **, int *, uint);
Barry Naujok847fff52008-10-30 17:05:38 +1100586int xfs_itobp(struct xfs_mount *, struct xfs_trans *,
587 struct xfs_inode *, struct xfs_dinode **,
Christoph Hellwig76d8b272008-11-28 14:23:40 +1100588 struct xfs_buf **, uint);
Christoph Hellwig6d73cf12008-12-09 04:47:32 -0500589int xfs_iread(struct xfs_mount *, struct xfs_trans *,
590 struct xfs_inode *, xfs_daddr_t, uint);
Barry Naujok847fff52008-10-30 17:05:38 +1100591void xfs_dinode_from_disk(struct xfs_icdinode *,
Christoph Hellwig81591fe2008-11-28 14:23:39 +1100592 struct xfs_dinode *);
593void xfs_dinode_to_disk(struct xfs_dinode *,
Barry Naujok847fff52008-10-30 17:05:38 +1100594 struct xfs_icdinode *);
595void xfs_idestroy_fork(struct xfs_inode *, int);
596void xfs_idata_realloc(struct xfs_inode *, int, int);
597void xfs_iroot_realloc(struct xfs_inode *, int, int);
598int xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
599int xfs_iextents_copy(struct xfs_inode *, xfs_bmbt_rec_t *, int);
600
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000601xfs_bmbt_rec_host_t *xfs_iext_get_ext(xfs_ifork_t *, xfs_extnum_t);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100602void xfs_iext_insert(xfs_ifork_t *, xfs_extnum_t, xfs_extnum_t,
603 xfs_bmbt_irec_t *);
604void xfs_iext_add(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100605void xfs_iext_add_indirect_multi(xfs_ifork_t *, int, xfs_extnum_t, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100606void xfs_iext_remove(xfs_ifork_t *, xfs_extnum_t, int);
607void xfs_iext_remove_inline(xfs_ifork_t *, xfs_extnum_t, int);
608void xfs_iext_remove_direct(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100609void xfs_iext_remove_indirect(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100610void xfs_iext_realloc_direct(xfs_ifork_t *, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100611void xfs_iext_realloc_indirect(xfs_ifork_t *, int);
612void xfs_iext_indirect_to_direct(xfs_ifork_t *);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100613void xfs_iext_direct_to_inline(xfs_ifork_t *, xfs_extnum_t);
614void xfs_iext_inline_to_direct(xfs_ifork_t *, int);
615void xfs_iext_destroy(xfs_ifork_t *);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000616xfs_bmbt_rec_host_t *xfs_iext_bno_to_ext(xfs_ifork_t *, xfs_fileoff_t, int *);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100617xfs_ext_irec_t *xfs_iext_bno_to_irec(xfs_ifork_t *, xfs_fileoff_t, int *);
618xfs_ext_irec_t *xfs_iext_idx_to_irec(xfs_ifork_t *, xfs_extnum_t *, int *, int);
619void xfs_iext_irec_init(xfs_ifork_t *);
620xfs_ext_irec_t *xfs_iext_irec_new(xfs_ifork_t *, int);
621void xfs_iext_irec_remove(xfs_ifork_t *, int);
622void xfs_iext_irec_compact(xfs_ifork_t *);
623void xfs_iext_irec_compact_pages(xfs_ifork_t *);
624void xfs_iext_irec_compact_full(xfs_ifork_t *);
625void xfs_iext_irec_update_extoffs(xfs_ifork_t *, int, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
628
629#ifdef DEBUG
Barry Naujok847fff52008-10-30 17:05:38 +1100630void xfs_isize_check(struct xfs_mount *, struct xfs_inode *,
631 xfs_fsize_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632#else /* DEBUG */
633#define xfs_isize_check(mp, ip, isize)
634#endif /* DEBUG */
635
636#if defined(DEBUG)
637void xfs_inobp_check(struct xfs_mount *, struct xfs_buf *);
638#else
639#define xfs_inobp_check(mp, bp)
640#endif /* DEBUG */
641
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642extern struct kmem_zone *xfs_ifork_zone;
643extern struct kmem_zone *xfs_inode_zone;
644extern struct kmem_zone *xfs_ili_zone;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646#endif /* __XFS_INODE_H__ */