blob: 0b38b9a869ece2136bf798a5329d2a38b8bf98ea [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 Hellwigef14f0c2009-06-10 17:07:47 +020021struct posix_acl;
Christoph Hellwig347d1c02007-08-28 13:57:51 +100022struct xfs_dinode;
Barry Naujok847fff52008-10-30 17:05:38 +110023struct xfs_inode;
Christoph Hellwig347d1c02007-08-28 13:57:51 +100024
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/*
Nathan Scotta844f452005-11-02 14:38:42 +110026 * Fork identifiers.
27 */
28#define XFS_DATA_FORK 0
29#define XFS_ATTR_FORK 1
30
31/*
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110032 * The following xfs_ext_irec_t struct introduces a second (top) level
33 * to the in-core extent allocation scheme. These structs are allocated
34 * in a contiguous block, creating an indirection array where each entry
35 * (irec) contains a pointer to a buffer of in-core extent records which
36 * it manages. Each extent buffer is 4k in size, since 4k is the system
37 * page size on Linux i386 and systems with larger page sizes don't seem
38 * to gain much, if anything, by using their native page size as the
39 * extent buffer size. Also, using 4k extent buffers everywhere provides
40 * a consistent interface for CXFS across different platforms.
41 *
42 * There is currently no limit on the number of irec's (extent lists)
43 * allowed, so heavily fragmented files may require an indirection array
44 * which spans multiple system pages of memory. The number of extents
45 * which would require this amount of contiguous memory is very large
46 * and should not cause problems in the foreseeable future. However,
47 * if the memory needed for the contiguous array ever becomes a problem,
48 * it is possible that a third level of indirection may be required.
49 */
50typedef struct xfs_ext_irec {
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100051 xfs_bmbt_rec_host_t *er_extbuf; /* block of extent records */
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110052 xfs_extnum_t er_extoff; /* extent offset in file */
53 xfs_extnum_t er_extcount; /* number of extents in page/block */
54} xfs_ext_irec_t;
55
56/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * File incore extent information, present for each of data & attr forks.
58 */
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110059#define XFS_IEXT_BUFSZ 4096
60#define XFS_LINEAR_EXTS (XFS_IEXT_BUFSZ / (uint)sizeof(xfs_bmbt_rec_t))
61#define XFS_INLINE_EXTS 2
62#define XFS_INLINE_DATA 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070063typedef struct xfs_ifork {
64 int if_bytes; /* bytes in if_u1 */
65 int if_real_bytes; /* bytes allocated in if_u1 */
Christoph Hellwig7cc95a82008-10-30 17:14:34 +110066 struct xfs_btree_block *if_broot; /* file's incore btree root */
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 short if_broot_bytes; /* bytes allocated for root */
68 unsigned char if_flags; /* per-fork flags */
69 unsigned char if_ext_max; /* max # of extent records */
70 xfs_extnum_t if_lastex; /* last if_extents used */
71 union {
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100072 xfs_bmbt_rec_host_t *if_extents;/* linear map file exts */
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110073 xfs_ext_irec_t *if_ext_irec; /* irec map file exts */
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 char *if_data; /* inline file data */
75 } if_u1;
76 union {
Christoph Hellwiga6f64d42007-08-16 16:23:40 +100077 xfs_bmbt_rec_host_t if_inline_ext[XFS_INLINE_EXTS];
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 /* very small file extents */
79 char if_inline_data[XFS_INLINE_DATA];
80 /* very small file data */
81 xfs_dev_t if_rdev; /* dev number if special */
82 uuid_t if_uuid; /* mount point value */
83 } if_u2;
84} xfs_ifork_t;
85
86/*
Christoph Hellwig92bfc6e2008-11-28 14:23:41 +110087 * Inode location information. Stored in the inode and passed to
88 * xfs_imap_to_bp() to get a buffer and dinode for a given inode.
89 */
90struct xfs_imap {
91 xfs_daddr_t im_blkno; /* starting BB of inode chunk */
92 ushort im_len; /* length in BBs of inode chunk */
93 ushort im_boffset; /* inode offset in block in bytes */
94};
95
96/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 * This is the xfs in-core inode structure.
98 * Most of the on-disk inode is embedded in the i_d field.
99 *
100 * The extent pointers/inline file space, however, are managed
101 * separately. The memory for this information is pointed to by
102 * the if_u1 unions depending on the type of the data.
103 * This is used to linearize the array of extents for fast in-core
104 * access. This is used until the file's number of extents
105 * surpasses XFS_MAX_INCORE_EXTENTS, at which point all extent pointers
106 * are accessed through the buffer cache.
107 *
108 * Other state kept in the in-core inode is used for identification,
109 * locking, transactional updating, etc of the inode.
110 *
111 * Generally, we do not want to hold the i_rlock while holding the
112 * i_ilock. Hierarchy is i_iolock followed by i_rlock.
113 *
114 * xfs_iptr_t contains all the inode fields upto and including the
115 * i_mnext and i_mprev fields, it is used as a marker in the inode
116 * chain off the mount structure by xfs_sync calls.
117 */
118
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000119typedef struct xfs_ictimestamp {
120 __int32_t t_sec; /* timestamp seconds */
121 __int32_t t_nsec; /* timestamp nanoseconds */
122} xfs_ictimestamp_t;
123
124/*
Christoph Hellwig81591fe2008-11-28 14:23:39 +1100125 * NOTE: This structure must be kept identical to struct xfs_dinode
Malcolm Parsons9da096f2009-03-29 09:55:42 +0200126 * in xfs_dinode.h except for the endianness annotations.
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000127 */
128typedef struct xfs_icdinode {
129 __uint16_t di_magic; /* inode magic # = XFS_DINODE_MAGIC */
130 __uint16_t di_mode; /* mode and type of file */
131 __int8_t di_version; /* inode version */
132 __int8_t di_format; /* format of di_c data */
133 __uint16_t di_onlink; /* old number of links to file */
134 __uint32_t di_uid; /* owner's user id */
135 __uint32_t di_gid; /* owner's group id */
136 __uint32_t di_nlink; /* number of links to file */
137 __uint16_t di_projid; /* owner's project id */
138 __uint8_t di_pad[8]; /* unused, zeroed space */
139 __uint16_t di_flushiter; /* incremented on flush */
140 xfs_ictimestamp_t di_atime; /* time last accessed */
141 xfs_ictimestamp_t di_mtime; /* time last modified */
142 xfs_ictimestamp_t di_ctime; /* time created/inode modified */
143 xfs_fsize_t di_size; /* number of bytes in file */
144 xfs_drfsbno_t di_nblocks; /* # of direct & btree blocks used */
145 xfs_extlen_t di_extsize; /* basic/minimum extent size for file */
146 xfs_extnum_t di_nextents; /* number of extents in data fork */
147 xfs_aextnum_t di_anextents; /* number of extents in attribute fork*/
148 __uint8_t di_forkoff; /* attr fork offs, <<3 for 64b align */
149 __int8_t di_aformat; /* format of attr fork's data */
150 __uint32_t di_dmevmask; /* DMIG event mask */
151 __uint16_t di_dmstate; /* DMIG state info */
152 __uint16_t di_flags; /* random flags, XFS_DIFLAG_... */
153 __uint32_t di_gen; /* generation number */
154} xfs_icdinode_t;
155
Barry Naujok847fff52008-10-30 17:05:38 +1100156/*
157 * Flags for xfs_ichgtime().
158 */
159#define XFS_ICHGTIME_MOD 0x1 /* data fork modification timestamp */
160#define XFS_ICHGTIME_CHG 0x2 /* inode field change timestamp */
161
162/*
163 * Per-fork incore inode flags.
164 */
165#define XFS_IFINLINE 0x01 /* Inline data is read in */
166#define XFS_IFEXTENTS 0x02 /* All extent pointers are read in */
167#define XFS_IFBROOT 0x04 /* i_broot points to the bmap b-tree root */
168#define XFS_IFEXTIREC 0x08 /* Indirection array of extent blocks */
169
170/*
Barry Naujok847fff52008-10-30 17:05:38 +1100171 * Fork handling.
172 */
173
174#define XFS_IFORK_Q(ip) ((ip)->i_d.di_forkoff != 0)
175#define XFS_IFORK_BOFF(ip) ((int)((ip)->i_d.di_forkoff << 3))
176
177#define XFS_IFORK_PTR(ip,w) \
178 ((w) == XFS_DATA_FORK ? \
179 &(ip)->i_df : \
180 (ip)->i_afp)
181#define XFS_IFORK_DSIZE(ip) \
182 (XFS_IFORK_Q(ip) ? \
183 XFS_IFORK_BOFF(ip) : \
184 XFS_LITINO((ip)->i_mount))
185#define XFS_IFORK_ASIZE(ip) \
186 (XFS_IFORK_Q(ip) ? \
187 XFS_LITINO((ip)->i_mount) - XFS_IFORK_BOFF(ip) : \
188 0)
189#define XFS_IFORK_SIZE(ip,w) \
190 ((w) == XFS_DATA_FORK ? \
191 XFS_IFORK_DSIZE(ip) : \
192 XFS_IFORK_ASIZE(ip))
193#define XFS_IFORK_FORMAT(ip,w) \
194 ((w) == XFS_DATA_FORK ? \
195 (ip)->i_d.di_format : \
196 (ip)->i_d.di_aformat)
197#define XFS_IFORK_FMT_SET(ip,w,n) \
198 ((w) == XFS_DATA_FORK ? \
199 ((ip)->i_d.di_format = (n)) : \
200 ((ip)->i_d.di_aformat = (n)))
201#define XFS_IFORK_NEXTENTS(ip,w) \
202 ((w) == XFS_DATA_FORK ? \
203 (ip)->i_d.di_nextents : \
204 (ip)->i_d.di_anextents)
205#define XFS_IFORK_NEXT_SET(ip,w,n) \
206 ((w) == XFS_DATA_FORK ? \
207 ((ip)->i_d.di_nextents = (n)) : \
208 ((ip)->i_d.di_anextents = (n)))
209
210
211
212#ifdef __KERNEL__
213
214struct bhv_desc;
215struct cred;
216struct ktrace;
217struct xfs_buf;
218struct xfs_bmap_free;
219struct xfs_bmbt_irec;
Barry Naujok847fff52008-10-30 17:05:38 +1100220struct xfs_inode_log_item;
221struct xfs_mount;
222struct xfs_trans;
223struct xfs_dquot;
224
225#if defined(XFS_ILOCK_TRACE)
226#define XFS_ILOCK_KTRACE_SIZE 32
Barry Naujok847fff52008-10-30 17:05:38 +1100227extern void xfs_ilock_trace(struct xfs_inode *, int, unsigned int, inst_t *);
228#else
229#define xfs_ilock_trace(i,n,f,ra)
230#endif
231
232typedef struct dm_attrs_s {
233 __uint32_t da_dmevmask; /* DMIG event mask */
234 __uint16_t da_dmstate; /* DMIG state info */
235 __uint16_t da_pad; /* DMIG extra padding */
236} dm_attrs_t;
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238typedef struct xfs_inode {
239 /* Inode linking and identification information. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 struct xfs_mount *i_mount; /* fs mount struct ptr */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 struct xfs_dquot *i_udquot; /* user dquot */
242 struct xfs_dquot *i_gdquot; /* group dquot */
243
244 /* Inode location stuff */
245 xfs_ino_t i_ino; /* inode number (agno/agino)*/
Christoph Hellwig92bfc6e2008-11-28 14:23:41 +1100246 struct xfs_imap i_imap; /* location for xfs_imap() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 /* Extent information. */
249 xfs_ifork_t *i_afp; /* attribute fork pointer */
250 xfs_ifork_t i_df; /* data fork */
251
252 /* Transaction and locking information. */
253 struct xfs_trans *i_transp; /* ptr to owning transaction*/
254 struct xfs_inode_log_item *i_itemp; /* logging information */
255 mrlock_t i_lock; /* inode lock */
256 mrlock_t i_iolock; /* inode IO lock */
David Chinnerc63942d2008-08-13 16:41:16 +1000257 struct completion i_flush; /* inode flush completion q */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 atomic_t i_pincount; /* inode pin count */
259 wait_queue_head_t i_ipin_wait; /* inode pinning wait queue */
David Chinnerf273ab82006-09-28 11:06:03 +1000260 spinlock_t i_flags_lock; /* inode i_flags lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 /* Miscellaneous state. */
262 unsigned short i_flags; /* see defined flags below */
263 unsigned char i_update_core; /* timestamps/size 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/*
312 * i_flags helper functions
313 */
314static inline void
315__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
316{
317 ip->i_flags |= flags;
318}
319
320static inline void
321xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
322{
323 spin_lock(&ip->i_flags_lock);
324 __xfs_iflags_set(ip, flags);
325 spin_unlock(&ip->i_flags_lock);
326}
327
328static inline void
329xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
330{
331 spin_lock(&ip->i_flags_lock);
332 ip->i_flags &= ~flags;
333 spin_unlock(&ip->i_flags_lock);
334}
335
336static inline int
337__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
338{
339 return (ip->i_flags & flags);
340}
341
342static inline int
343xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
344{
345 int ret;
346 spin_lock(&ip->i_flags_lock);
347 ret = __xfs_iflags_test(ip, flags);
348 spin_unlock(&ip->i_flags_lock);
349 return ret;
350}
Christoph Hellwig09262b42007-08-29 11:44:50 +1000351
352static inline int
353xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
354{
355 int ret;
356
357 spin_lock(&ip->i_flags_lock);
358 ret = ip->i_flags & flags;
359 if (ret)
360 ip->i_flags &= ~flags;
361 spin_unlock(&ip->i_flags_lock);
362 return ret;
363}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365/*
Barry Naujok847fff52008-10-30 17:05:38 +1100366 * Manage the i_flush queue embedded in the inode. This completion
367 * queue synchronizes processes attempting to flush the in-core
368 * inode back to disk.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 */
Barry Naujok847fff52008-10-30 17:05:38 +1100370static inline void xfs_iflock(xfs_inode_t *ip)
371{
372 wait_for_completion(&ip->i_flush);
373}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Barry Naujok847fff52008-10-30 17:05:38 +1100375static inline int xfs_iflock_nowait(xfs_inode_t *ip)
376{
377 return try_wait_for_completion(&ip->i_flush);
378}
Christoph Hellwig45ba5982007-12-07 14:07:20 +1100379
Barry Naujok847fff52008-10-30 17:05:38 +1100380static inline void xfs_ifunlock(xfs_inode_t *ip)
381{
382 complete(&ip->i_flush);
383}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385/*
386 * In-core inode flags.
387 */
Christoph Hellwig6bd16ff2008-12-03 12:20:32 +0100388#define XFS_IRECLAIM 0x0001 /* we have started reclaiming this inode */
389#define XFS_ISTALE 0x0002 /* inode has been staled */
390#define XFS_IRECLAIMABLE 0x0004 /* inode can be reclaimed */
391#define XFS_INEW 0x0008 /* inode has just been allocated */
392#define XFS_IFILESTREAM 0x0010 /* inode is in a filestream directory */
393#define XFS_ITRUNCATED 0x0020 /* truncated down so flush-on-close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395/*
396 * Flags for inode locking.
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000397 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
398 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 */
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000400#define XFS_IOLOCK_EXCL (1<<0)
401#define XFS_IOLOCK_SHARED (1<<1)
402#define XFS_ILOCK_EXCL (1<<2)
403#define XFS_ILOCK_SHARED (1<<3)
404#define XFS_IUNLOCK_NONOTIFY (1<<4)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000406#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000407 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000408
409/*
410 * Flags for lockdep annotations.
411 *
412 * XFS_I[O]LOCK_PARENT - for operations that require locking two inodes
413 * (ie directory operations that require locking a directory inode and
414 * an entry inode). The first inode gets locked with this flag so it
415 * gets a lockdep subclass of 1 and the second lock will have a lockdep
416 * subclass of 0.
417 *
David Chinner0f1145c2007-06-29 17:26:09 +1000418 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000419 * with xfs_lock_inodes(). This flag is used as the starting subclass
420 * and each subsequent lock acquired will increment the subclass by one.
421 * So the first lock acquired will have a lockdep subclass of 2, the
David Chinner0f1145c2007-06-29 17:26:09 +1000422 * second lock will have a lockdep subclass of 3, and so on. It is
423 * the responsibility of the class builder to shift this to the correct
424 * portion of the lock_mode lockdep mask.
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000425 */
David Chinner0f1145c2007-06-29 17:26:09 +1000426#define XFS_LOCK_PARENT 1
427#define XFS_LOCK_INUMORDER 2
428
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000429#define XFS_IOLOCK_SHIFT 16
David Chinner0f1145c2007-06-29 17:26:09 +1000430#define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000431
432#define XFS_ILOCK_SHIFT 24
David Chinner0f1145c2007-06-29 17:26:09 +1000433#define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000434
435#define XFS_IOLOCK_DEP_MASK 0x00ff0000
436#define XFS_ILOCK_DEP_MASK 0xff000000
437#define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK)
438
439#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT)
440#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442/*
443 * Flags for xfs_iflush()
444 */
445#define XFS_IFLUSH_DELWRI_ELSE_SYNC 1
446#define XFS_IFLUSH_DELWRI_ELSE_ASYNC 2
447#define XFS_IFLUSH_SYNC 3
448#define XFS_IFLUSH_ASYNC 4
449#define XFS_IFLUSH_DELWRI 5
David Chinnera3f74ff2008-03-06 13:43:42 +1100450#define XFS_IFLUSH_ASYNC_NOBLOCK 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 * Flags for xfs_itruncate_start().
454 */
455#define XFS_ITRUNC_DEFINITE 0x1
456#define XFS_ITRUNC_MAYBE 0x2
457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458/*
459 * For multiple groups support: if S_ISGID bit is set in the parent
460 * directory, group of new file is set to that of the parent, and
461 * new subdirectory gets S_ISGID bit from parent.
462 */
Christoph Hellwigbd186aa2007-08-30 17:21:12 +1000463#define XFS_INHERIT_GID(pip) \
464 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
465 ((pip)->i_d.di_mode & S_ISGID))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
467/*
468 * xfs_iget.c prototypes.
469 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470int xfs_iget(struct xfs_mount *, struct xfs_trans *, xfs_ino_t,
471 uint, uint, xfs_inode_t **, xfs_daddr_t);
472void xfs_iput(xfs_inode_t *, uint);
473void xfs_iput_new(xfs_inode_t *, uint);
474void xfs_ilock(xfs_inode_t *, uint);
475int xfs_ilock_nowait(xfs_inode_t *, uint);
476void xfs_iunlock(xfs_inode_t *, uint);
477void xfs_ilock_demote(xfs_inode_t *, uint);
Christoph Hellwig579aa9c2008-04-22 17:34:00 +1000478int xfs_isilocked(xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479uint xfs_ilock_map_shared(xfs_inode_t *);
480void xfs_iunlock_map_shared(xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481void xfs_ireclaim(xfs_inode_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483/*
484 * xfs_inode.c prototypes.
485 */
Nathan Scott31b084a2005-05-05 13:25:00 -0700486int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, mode_t,
David Howellsb6dff3e2008-11-14 10:39:16 +1100487 xfs_nlink_t, xfs_dev_t, cred_t *, xfs_prid_t,
Nathan Scott31b084a2005-05-05 13:25:00 -0700488 int, struct xfs_buf **, boolean_t *, xfs_inode_t **);
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490uint xfs_ip2xflags(struct xfs_inode *);
Christoph Hellwig45ba5982007-12-07 14:07:20 +1100491uint xfs_dic2xflags(struct xfs_dinode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
493 struct xfs_bmap_free *);
Lachlan McIlroyd3cf2092007-05-08 13:49:27 +1000494int xfs_itruncate_start(xfs_inode_t *, uint, xfs_fsize_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495int xfs_itruncate_finish(struct xfs_trans **, xfs_inode_t *,
496 xfs_fsize_t, int, int);
497int xfs_iunlink(struct xfs_trans *, xfs_inode_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499void xfs_iext_realloc(xfs_inode_t *, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500void xfs_ipin(xfs_inode_t *);
501void xfs_iunpin(xfs_inode_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502int xfs_iflush(xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503void xfs_ichgtime(xfs_inode_t *, int);
Christoph Hellwigcfa853e2008-04-22 17:34:06 +1000504void xfs_lock_inodes(xfs_inode_t **, int, uint);
Christoph Hellwige1cccd92008-08-13 16:18:07 +1000505void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Christoph Hellwig42fe2b12006-01-11 15:35:17 +1100507void xfs_synchronize_atime(xfs_inode_t *);
David Chinner5d51eff2007-11-23 16:29:18 +1100508void xfs_mark_inode_dirty_sync(xfs_inode_t *);
Christoph Hellwig42fe2b12006-01-11 15:35:17 +1100509
Christoph Hellwig5a8d0f32008-12-03 12:20:40 +0100510#if defined(XFS_INODE_TRACE)
511
512#define INODE_TRACE_SIZE 16 /* number of trace entries */
513#define INODE_KTRACE_ENTRY 1
514#define INODE_KTRACE_EXIT 2
515#define INODE_KTRACE_HOLD 3
516#define INODE_KTRACE_REF 4
517#define INODE_KTRACE_RELE 5
518
519extern void _xfs_itrace_entry(struct xfs_inode *, const char *, inst_t *);
520extern void _xfs_itrace_exit(struct xfs_inode *, const char *, inst_t *);
521extern void xfs_itrace_hold(struct xfs_inode *, char *, int, inst_t *);
522extern void _xfs_itrace_ref(struct xfs_inode *, char *, int, inst_t *);
523extern void xfs_itrace_rele(struct xfs_inode *, char *, int, inst_t *);
524#define xfs_itrace_entry(ip) \
525 _xfs_itrace_entry(ip, __func__, (inst_t *)__return_address)
526#define xfs_itrace_exit(ip) \
527 _xfs_itrace_exit(ip, __func__, (inst_t *)__return_address)
528#define xfs_itrace_exit_tag(ip, tag) \
529 _xfs_itrace_exit(ip, tag, (inst_t *)__return_address)
530#define xfs_itrace_ref(ip) \
531 _xfs_itrace_ref(ip, __FILE__, __LINE__, (inst_t *)__return_address)
532
533#else
534#define xfs_itrace_entry(a)
535#define xfs_itrace_exit(a)
536#define xfs_itrace_exit_tag(a, b)
537#define xfs_itrace_hold(a, b, c, d)
538#define xfs_itrace_ref(a)
539#define xfs_itrace_rele(a, b, c, d)
540#endif
541
542#define IHOLD(ip) \
543do { \
544 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
545 atomic_inc(&(VFS_I(ip)->i_count)); \
546 xfs_itrace_hold((ip), __FILE__, __LINE__, (inst_t *)__return_address); \
547} while (0)
548
549#define IRELE(ip) \
550do { \
551 xfs_itrace_rele((ip), __FILE__, __LINE__, (inst_t *)__return_address); \
552 iput(VFS_I(ip)); \
553} while (0)
554
Barry Naujok847fff52008-10-30 17:05:38 +1100555#endif /* __KERNEL__ */
556
Christoph Hellwig6d73cf12008-12-09 04:47:32 -0500557/*
558 * Flags for xfs_iget()
559 */
560#define XFS_IGET_CREATE 0x1
561#define XFS_IGET_BULKSTAT 0x2
562
Christoph Hellwigc679eef2008-10-30 18:04:13 +1100563int xfs_inotobp(struct xfs_mount *, struct xfs_trans *,
564 xfs_ino_t, struct xfs_dinode **,
565 struct xfs_buf **, int *, uint);
Barry Naujok847fff52008-10-30 17:05:38 +1100566int xfs_itobp(struct xfs_mount *, struct xfs_trans *,
567 struct xfs_inode *, struct xfs_dinode **,
Christoph Hellwig76d8b272008-11-28 14:23:40 +1100568 struct xfs_buf **, uint);
Christoph Hellwig6d73cf12008-12-09 04:47:32 -0500569int xfs_iread(struct xfs_mount *, struct xfs_trans *,
570 struct xfs_inode *, xfs_daddr_t, uint);
Christoph Hellwig81591fe2008-11-28 14:23:39 +1100571void xfs_dinode_to_disk(struct xfs_dinode *,
Barry Naujok847fff52008-10-30 17:05:38 +1100572 struct xfs_icdinode *);
573void xfs_idestroy_fork(struct xfs_inode *, int);
574void xfs_idata_realloc(struct xfs_inode *, int, int);
575void xfs_iroot_realloc(struct xfs_inode *, int, int);
576int xfs_iread_extents(struct xfs_trans *, struct xfs_inode *, int);
577int xfs_iextents_copy(struct xfs_inode *, xfs_bmbt_rec_t *, int);
578
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000579xfs_bmbt_rec_host_t *xfs_iext_get_ext(xfs_ifork_t *, xfs_extnum_t);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100580void xfs_iext_insert(xfs_ifork_t *, xfs_extnum_t, xfs_extnum_t,
581 xfs_bmbt_irec_t *);
582void xfs_iext_add(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100583void xfs_iext_add_indirect_multi(xfs_ifork_t *, int, xfs_extnum_t, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100584void xfs_iext_remove(xfs_ifork_t *, xfs_extnum_t, int);
585void xfs_iext_remove_inline(xfs_ifork_t *, xfs_extnum_t, int);
586void xfs_iext_remove_direct(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100587void xfs_iext_remove_indirect(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100588void xfs_iext_realloc_direct(xfs_ifork_t *, int);
589void xfs_iext_direct_to_inline(xfs_ifork_t *, xfs_extnum_t);
590void xfs_iext_inline_to_direct(xfs_ifork_t *, int);
591void xfs_iext_destroy(xfs_ifork_t *);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000592xfs_bmbt_rec_host_t *xfs_iext_bno_to_ext(xfs_ifork_t *, xfs_fileoff_t, int *);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100593xfs_ext_irec_t *xfs_iext_bno_to_irec(xfs_ifork_t *, xfs_fileoff_t, int *);
594xfs_ext_irec_t *xfs_iext_idx_to_irec(xfs_ifork_t *, xfs_extnum_t *, int *, int);
595void xfs_iext_irec_init(xfs_ifork_t *);
596xfs_ext_irec_t *xfs_iext_irec_new(xfs_ifork_t *, int);
597void xfs_iext_irec_remove(xfs_ifork_t *, int);
598void xfs_iext_irec_compact(xfs_ifork_t *);
599void xfs_iext_irec_compact_pages(xfs_ifork_t *);
600void xfs_iext_irec_compact_full(xfs_ifork_t *);
601void xfs_iext_irec_update_extoffs(xfs_ifork_t *, int, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
604
605#ifdef DEBUG
Barry Naujok847fff52008-10-30 17:05:38 +1100606void xfs_isize_check(struct xfs_mount *, struct xfs_inode *,
607 xfs_fsize_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608#else /* DEBUG */
609#define xfs_isize_check(mp, ip, isize)
610#endif /* DEBUG */
611
612#if defined(DEBUG)
613void xfs_inobp_check(struct xfs_mount *, struct xfs_buf *);
614#else
615#define xfs_inobp_check(mp, bp)
616#endif /* DEBUG */
617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618extern struct kmem_zone *xfs_ifork_zone;
619extern struct kmem_zone *xfs_inode_zone;
620extern struct kmem_zone *xfs_ili_zone;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622#endif /* __XFS_INODE_H__ */