blob: c8bb1a818a52380e4042a1770f76d7e10c139ea1 [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;
22struct xfs_dinode_core;
23
24
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 */
66 xfs_bmbt_block_t *if_broot; /* file's incore btree root */
67 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/*
87 * Flags for xfs_ichgtime().
88 */
89#define XFS_ICHGTIME_MOD 0x1 /* data fork modification timestamp */
90#define XFS_ICHGTIME_ACC 0x2 /* data fork access timestamp */
91#define XFS_ICHGTIME_CHG 0x4 /* inode field change timestamp */
92
93/*
94 * Per-fork incore inode flags.
95 */
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +110096#define XFS_IFINLINE 0x01 /* Inline data is read in */
97#define XFS_IFEXTENTS 0x02 /* All extent pointers are read in */
98#define XFS_IFBROOT 0x04 /* i_broot points to the bmap b-tree root */
99#define XFS_IFEXTIREC 0x08 /* Indirection array of extent blocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101/*
Nathan Scottb12dd342006-03-17 17:26:04 +1100102 * Flags for xfs_itobp(), xfs_imap() and xfs_dilocate().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 */
Nathan Scottb12dd342006-03-17 17:26:04 +1100104#define XFS_IMAP_LOOKUP 0x1
105#define XFS_IMAP_BULKSTAT 0x2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107#ifdef __KERNEL__
108struct bhv_desc;
Nathan Scott67fcaa72006-06-09 17:00:52 +1000109struct bhv_vnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110struct cred;
111struct ktrace;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112struct xfs_buf;
113struct xfs_bmap_free;
114struct xfs_bmbt_irec;
115struct xfs_bmbt_block;
116struct xfs_inode;
117struct xfs_inode_log_item;
118struct xfs_mount;
119struct xfs_trans;
120struct xfs_dquot;
121
122#if defined(XFS_ILOCK_TRACE)
123#define XFS_ILOCK_KTRACE_SIZE 32
124extern ktrace_t *xfs_ilock_trace_buf;
125extern void xfs_ilock_trace(struct xfs_inode *, int, unsigned int, inst_t *);
126#else
127#define xfs_ilock_trace(i,n,f,ra)
128#endif
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130typedef struct dm_attrs_s {
131 __uint32_t da_dmevmask; /* DMIG event mask */
132 __uint16_t da_dmstate; /* DMIG state info */
133 __uint16_t da_pad; /* DMIG extra padding */
134} dm_attrs_t;
135
136typedef struct xfs_iocore {
137 void *io_obj; /* pointer to container
138 * inode or dcxvn structure */
139 struct xfs_mount *io_mount; /* fs mount struct ptr */
140#ifdef DEBUG
141 mrlock_t *io_lock; /* inode IO lock */
142 mrlock_t *io_iolock; /* inode IO lock */
143#endif
144
145 /* I/O state */
146 xfs_fsize_t io_new_size; /* sz when write completes */
147
148 /* Miscellaneous state. */
149 unsigned int io_flags; /* IO related flags */
150
151 /* DMAPI state */
152 dm_attrs_t io_dmattrs;
153
154} xfs_iocore_t;
155
156#define io_dmevmask io_dmattrs.da_dmevmask
157#define io_dmstate io_dmattrs.da_dmstate
158
159#define XFS_IO_INODE(io) ((xfs_inode_t *) ((io)->io_obj))
160#define XFS_IO_DCXVN(io) ((dcxvn_t *) ((io)->io_obj))
161
162/*
163 * Flags in the flags field
164 */
165
166#define XFS_IOCORE_RT 0x1
167
168/*
169 * xfs_iocore prototypes
170 */
171
172extern void xfs_iocore_inode_init(struct xfs_inode *);
173extern void xfs_iocore_inode_reinit(struct xfs_inode *);
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175/*
David Chinnerda353b02007-08-28 14:00:13 +1000176 * This is the xfs inode cluster structure. This structure is used by
177 * xfs_iflush to find inodes that share a cluster and can be flushed to disk at
178 * the same time.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 */
David Chinnerda353b02007-08-28 14:00:13 +1000180typedef struct xfs_icluster {
181 struct hlist_head icl_inodes; /* list of inodes on cluster */
182 xfs_daddr_t icl_blkno; /* starting block number of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 * the cluster */
David Chinnerda353b02007-08-28 14:00:13 +1000184 struct xfs_buf *icl_buf; /* the inode buffer */
185 lock_t icl_lock; /* inode list lock */
186} xfs_icluster_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188/*
189 * This is the xfs in-core inode structure.
190 * Most of the on-disk inode is embedded in the i_d field.
191 *
192 * The extent pointers/inline file space, however, are managed
193 * separately. The memory for this information is pointed to by
194 * the if_u1 unions depending on the type of the data.
195 * This is used to linearize the array of extents for fast in-core
196 * access. This is used until the file's number of extents
197 * surpasses XFS_MAX_INCORE_EXTENTS, at which point all extent pointers
198 * are accessed through the buffer cache.
199 *
200 * Other state kept in the in-core inode is used for identification,
201 * locking, transactional updating, etc of the inode.
202 *
203 * Generally, we do not want to hold the i_rlock while holding the
204 * i_ilock. Hierarchy is i_iolock followed by i_rlock.
205 *
206 * xfs_iptr_t contains all the inode fields upto and including the
207 * i_mnext and i_mprev fields, it is used as a marker in the inode
208 * chain off the mount structure by xfs_sync calls.
209 */
210
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000211typedef struct xfs_ictimestamp {
212 __int32_t t_sec; /* timestamp seconds */
213 __int32_t t_nsec; /* timestamp nanoseconds */
214} xfs_ictimestamp_t;
215
216/*
217 * NOTE: This structure must be kept identical to struct xfs_dinode_core
218 * in xfs_dinode.h except for the endianess annotations.
219 */
220typedef struct xfs_icdinode {
221 __uint16_t di_magic; /* inode magic # = XFS_DINODE_MAGIC */
222 __uint16_t di_mode; /* mode and type of file */
223 __int8_t di_version; /* inode version */
224 __int8_t di_format; /* format of di_c data */
225 __uint16_t di_onlink; /* old number of links to file */
226 __uint32_t di_uid; /* owner's user id */
227 __uint32_t di_gid; /* owner's group id */
228 __uint32_t di_nlink; /* number of links to file */
229 __uint16_t di_projid; /* owner's project id */
230 __uint8_t di_pad[8]; /* unused, zeroed space */
231 __uint16_t di_flushiter; /* incremented on flush */
232 xfs_ictimestamp_t di_atime; /* time last accessed */
233 xfs_ictimestamp_t di_mtime; /* time last modified */
234 xfs_ictimestamp_t di_ctime; /* time created/inode modified */
235 xfs_fsize_t di_size; /* number of bytes in file */
236 xfs_drfsbno_t di_nblocks; /* # of direct & btree blocks used */
237 xfs_extlen_t di_extsize; /* basic/minimum extent size for file */
238 xfs_extnum_t di_nextents; /* number of extents in data fork */
239 xfs_aextnum_t di_anextents; /* number of extents in attribute fork*/
240 __uint8_t di_forkoff; /* attr fork offs, <<3 for 64b align */
241 __int8_t di_aformat; /* format of attr fork's data */
242 __uint32_t di_dmevmask; /* DMIG event mask */
243 __uint16_t di_dmstate; /* DMIG state info */
244 __uint16_t di_flags; /* random flags, XFS_DIFLAG_... */
245 __uint32_t di_gen; /* generation number */
246} xfs_icdinode_t;
247
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248typedef struct {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 struct xfs_inode *ip_mnext; /* next inode in mount list */
250 struct xfs_inode *ip_mprev; /* ptr to prev inode */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 struct xfs_mount *ip_mount; /* fs mount struct ptr */
252} xfs_iptr_t;
253
254typedef struct xfs_inode {
255 /* Inode linking and identification information. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 struct xfs_inode *i_mnext; /* next inode in mount list */
257 struct xfs_inode *i_mprev; /* ptr to prev inode */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 struct xfs_mount *i_mount; /* fs mount struct ptr */
259 struct list_head i_reclaim; /* reclaim list */
Christoph Hellwig739bfb22007-08-29 10:58:01 +1000260 struct bhv_vnode *i_vnode; /* vnode backpointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 struct xfs_dquot *i_udquot; /* user dquot */
262 struct xfs_dquot *i_gdquot; /* group dquot */
263
264 /* Inode location stuff */
265 xfs_ino_t i_ino; /* inode number (agno/agino)*/
266 xfs_daddr_t i_blkno; /* blkno of inode buffer */
267 ushort i_len; /* len of inode buffer */
268 ushort i_boffset; /* off of inode in buffer */
269
270 /* Extent information. */
271 xfs_ifork_t *i_afp; /* attribute fork pointer */
272 xfs_ifork_t i_df; /* data fork */
273
274 /* Transaction and locking information. */
275 struct xfs_trans *i_transp; /* ptr to owning transaction*/
276 struct xfs_inode_log_item *i_itemp; /* logging information */
277 mrlock_t i_lock; /* inode lock */
278 mrlock_t i_iolock; /* inode IO lock */
279 sema_t i_flock; /* inode flush lock */
280 atomic_t i_pincount; /* inode pin count */
281 wait_queue_head_t i_ipin_wait; /* inode pinning wait queue */
David Chinnerf273ab82006-09-28 11:06:03 +1000282 spinlock_t i_flags_lock; /* inode i_flags lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283#ifdef HAVE_REFCACHE
284 struct xfs_inode **i_refcache; /* ptr to entry in ref cache */
285 struct xfs_inode *i_release; /* inode to unref */
286#endif
287 /* I/O state */
288 xfs_iocore_t i_iocore; /* I/O core */
289
290 /* Miscellaneous state. */
291 unsigned short i_flags; /* see defined flags below */
292 unsigned char i_update_core; /* timestamps/size is dirty */
293 unsigned char i_update_size; /* di_size field is dirty */
294 unsigned int i_gen; /* generation count */
295 unsigned int i_delayed_blks; /* count of delay alloc blks */
296
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000297 xfs_icdinode_t i_d; /* most of ondisk inode */
David Chinnerda353b02007-08-28 14:00:13 +1000298 xfs_icluster_t *i_cluster; /* cluster list header */
299 struct hlist_node i_cnode; /* cluster link node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Lachlan McIlroyba87ea62007-05-08 13:49:46 +1000301 xfs_fsize_t i_size; /* in-memory size */
Christoph Hellwigb677c212007-08-29 11:46:28 +1000302 atomic_t i_iocount; /* outstanding I/O count */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 /* Trace buffers per inode. */
304#ifdef XFS_BMAP_TRACE
305 struct ktrace *i_xtrace; /* inode extent list trace */
306#endif
307#ifdef XFS_BMBT_TRACE
308 struct ktrace *i_btrace; /* inode bmap btree trace */
309#endif
310#ifdef XFS_RW_TRACE
311 struct ktrace *i_rwtrace; /* inode read/write trace */
312#endif
313#ifdef XFS_ILOCK_TRACE
314 struct ktrace *i_lock_trace; /* inode lock/unlock trace */
315#endif
316#ifdef XFS_DIR2_TRACE
317 struct ktrace *i_dir_trace; /* inode directory trace */
318#endif
319} xfs_inode_t;
320
Lachlan McIlroyba87ea62007-05-08 13:49:46 +1000321#define XFS_ISIZE(ip) (((ip)->i_d.di_mode & S_IFMT) == S_IFREG) ? \
322 (ip)->i_size : (ip)->i_d.di_size;
David Chinner7a18c382006-11-11 18:04:54 +1100323
324/*
325 * i_flags helper functions
326 */
327static inline void
328__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
329{
330 ip->i_flags |= flags;
331}
332
333static inline void
334xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
335{
336 spin_lock(&ip->i_flags_lock);
337 __xfs_iflags_set(ip, flags);
338 spin_unlock(&ip->i_flags_lock);
339}
340
341static inline void
342xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
343{
344 spin_lock(&ip->i_flags_lock);
345 ip->i_flags &= ~flags;
346 spin_unlock(&ip->i_flags_lock);
347}
348
349static inline int
350__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
351{
352 return (ip->i_flags & flags);
353}
354
355static inline int
356xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
357{
358 int ret;
359 spin_lock(&ip->i_flags_lock);
360 ret = __xfs_iflags_test(ip, flags);
361 spin_unlock(&ip->i_flags_lock);
362 return ret;
363}
Christoph Hellwig09262b42007-08-29 11:44:50 +1000364
365static inline int
366xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
367{
368 int ret;
369
370 spin_lock(&ip->i_flags_lock);
371 ret = ip->i_flags & flags;
372 if (ret)
373 ip->i_flags &= ~flags;
374 spin_unlock(&ip->i_flags_lock);
375 return ret;
376}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377#endif /* __KERNEL__ */
378
379
380/*
381 * Fork handling.
382 */
Nathan Scotta844f452005-11-02 14:38:42 +1100383#define XFS_IFORK_PTR(ip,w) \
384 ((w) == XFS_DATA_FORK ? &(ip)->i_df : (ip)->i_afp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385#define XFS_IFORK_Q(ip) XFS_CFORK_Q(&(ip)->i_d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386#define XFS_IFORK_DSIZE(ip) XFS_CFORK_DSIZE(&ip->i_d, ip->i_mount)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387#define XFS_IFORK_ASIZE(ip) XFS_CFORK_ASIZE(&ip->i_d, ip->i_mount)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388#define XFS_IFORK_SIZE(ip,w) XFS_CFORK_SIZE(&ip->i_d, ip->i_mount, w)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389#define XFS_IFORK_FORMAT(ip,w) XFS_CFORK_FORMAT(&ip->i_d, w)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390#define XFS_IFORK_FMT_SET(ip,w,n) XFS_CFORK_FMT_SET(&ip->i_d, w, n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391#define XFS_IFORK_NEXTENTS(ip,w) XFS_CFORK_NEXTENTS(&ip->i_d, w)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392#define XFS_IFORK_NEXT_SET(ip,w,n) XFS_CFORK_NEXT_SET(&ip->i_d, w, n)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394
395#ifdef __KERNEL__
396
397/*
398 * In-core inode flags.
399 */
400#define XFS_IGRIO 0x0001 /* inode used for guaranteed rate i/o */
401#define XFS_IUIOSZ 0x0002 /* inode i/o sizes have been explicitly set */
402#define XFS_IQUIESCE 0x0004 /* we have started quiescing for this inode */
403#define XFS_IRECLAIM 0x0008 /* we have started reclaiming this inode */
404#define XFS_ISTALE 0x0010 /* inode has been staled */
405#define XFS_IRECLAIMABLE 0x0020 /* inode can be reclaimed */
406#define XFS_INEW 0x0040
David Chinner2a82b8b2007-07-11 11:09:12 +1000407#define XFS_IFILESTREAM 0x0080 /* inode is in a filestream directory */
Christoph Hellwigb3aea4e2007-08-29 11:44:37 +1000408#define XFS_IMODIFIED 0x0100 /* XFS inode state possibly differs */
409 /* to the Linux inode state. */
410#define XFS_ITRUNCATED 0x0200 /* 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)
422/* #define XFS_IOLOCK_NESTED (1<<5) */
423#define XFS_EXTENT_TOKEN_RD (1<<6)
424#define XFS_SIZE_TOKEN_RD (1<<7)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425#define XFS_EXTSIZE_RD (XFS_EXTENT_TOKEN_RD|XFS_SIZE_TOKEN_RD)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000426#define XFS_WILLLEND (1<<8) /* Always acquire tokens for lending */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427#define XFS_EXTENT_TOKEN_WR (XFS_EXTENT_TOKEN_RD | XFS_WILLLEND)
428#define XFS_SIZE_TOKEN_WR (XFS_SIZE_TOKEN_RD | XFS_WILLLEND)
429#define XFS_EXTSIZE_WR (XFS_EXTSIZE_RD | XFS_WILLLEND)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000430/* TODO:XFS_SIZE_TOKEN_WANT (1<<9) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000432#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
433 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
434 | XFS_EXTENT_TOKEN_RD | XFS_SIZE_TOKEN_RD \
435 | XFS_WILLLEND)
436
437/*
438 * Flags for lockdep annotations.
439 *
440 * XFS_I[O]LOCK_PARENT - for operations that require locking two inodes
441 * (ie directory operations that require locking a directory inode and
442 * an entry inode). The first inode gets locked with this flag so it
443 * gets a lockdep subclass of 1 and the second lock will have a lockdep
444 * subclass of 0.
445 *
David Chinner0f1145c2007-06-29 17:26:09 +1000446 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000447 * with xfs_lock_inodes(). This flag is used as the starting subclass
448 * and each subsequent lock acquired will increment the subclass by one.
449 * So the first lock acquired will have a lockdep subclass of 2, the
David Chinner0f1145c2007-06-29 17:26:09 +1000450 * second lock will have a lockdep subclass of 3, and so on. It is
451 * the responsibility of the class builder to shift this to the correct
452 * portion of the lock_mode lockdep mask.
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000453 */
David Chinner0f1145c2007-06-29 17:26:09 +1000454#define XFS_LOCK_PARENT 1
455#define XFS_LOCK_INUMORDER 2
456
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000457#define XFS_IOLOCK_SHIFT 16
David Chinner0f1145c2007-06-29 17:26:09 +1000458#define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000459
460#define XFS_ILOCK_SHIFT 24
David Chinner0f1145c2007-06-29 17:26:09 +1000461#define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
Lachlan McIlroyf7c66ce2007-05-08 13:50:19 +1000462
463#define XFS_IOLOCK_DEP_MASK 0x00ff0000
464#define XFS_ILOCK_DEP_MASK 0xff000000
465#define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK)
466
467#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT)
468#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
470/*
471 * Flags for xfs_iflush()
472 */
473#define XFS_IFLUSH_DELWRI_ELSE_SYNC 1
474#define XFS_IFLUSH_DELWRI_ELSE_ASYNC 2
475#define XFS_IFLUSH_SYNC 3
476#define XFS_IFLUSH_ASYNC 4
477#define XFS_IFLUSH_DELWRI 5
478
479/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 * Flags for xfs_itruncate_start().
481 */
482#define XFS_ITRUNC_DEFINITE 0x1
483#define XFS_ITRUNC_MAYBE 0x2
484
Christoph Hellwig739bfb22007-08-29 10:58:01 +1000485#define XFS_ITOV(ip) ((ip)->i_vnode)
486#define XFS_ITOV_NULL(ip) ((ip)->i_vnode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
488/*
489 * For multiple groups support: if S_ISGID bit is set in the parent
490 * directory, group of new file is set to that of the parent, and
491 * new subdirectory gets S_ISGID bit from parent.
492 */
493#define XFS_INHERIT_GID(pip, vfsp) \
494 (((vfsp)->vfs_flag & VFS_GRPID) || ((pip)->i_d.di_mode & S_ISGID))
495
496/*
Nathan Scott745b1f472006-09-28 11:02:23 +1000497 * Flags for xfs_iget()
498 */
499#define XFS_IGET_CREATE 0x1
500#define XFS_IGET_BULKSTAT 0x2
501
502/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 * xfs_iget.c prototypes.
504 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505void xfs_ihash_init(struct xfs_mount *);
506void xfs_ihash_free(struct xfs_mount *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507xfs_inode_t *xfs_inode_incore(struct xfs_mount *, xfs_ino_t,
508 struct xfs_trans *);
Nathan Scott67fcaa72006-06-09 17:00:52 +1000509void xfs_inode_lock_init(xfs_inode_t *, struct bhv_vnode *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510int xfs_iget(struct xfs_mount *, struct xfs_trans *, xfs_ino_t,
511 uint, uint, xfs_inode_t **, xfs_daddr_t);
512void xfs_iput(xfs_inode_t *, uint);
513void xfs_iput_new(xfs_inode_t *, uint);
514void xfs_ilock(xfs_inode_t *, uint);
515int xfs_ilock_nowait(xfs_inode_t *, uint);
516void xfs_iunlock(xfs_inode_t *, uint);
517void xfs_ilock_demote(xfs_inode_t *, uint);
518void xfs_iflock(xfs_inode_t *);
519int xfs_iflock_nowait(xfs_inode_t *);
520uint xfs_ilock_map_shared(xfs_inode_t *);
521void xfs_iunlock_map_shared(xfs_inode_t *, uint);
522void xfs_ifunlock(xfs_inode_t *);
523void xfs_ireclaim(xfs_inode_t *);
524int xfs_finish_reclaim(xfs_inode_t *, int, int);
525int xfs_finish_reclaim_all(struct xfs_mount *, int);
526
527/*
528 * xfs_inode.c prototypes.
529 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530int xfs_itobp(struct xfs_mount *, struct xfs_trans *,
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000531 xfs_inode_t *, struct xfs_dinode **, struct xfs_buf **,
Nathan Scottb12dd342006-03-17 17:26:04 +1100532 xfs_daddr_t, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533int xfs_iread(struct xfs_mount *, struct xfs_trans *, xfs_ino_t,
Nathan Scott745b1f472006-09-28 11:02:23 +1000534 xfs_inode_t **, xfs_daddr_t, uint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535int xfs_iread_extents(struct xfs_trans *, xfs_inode_t *, int);
Nathan Scott31b084a2005-05-05 13:25:00 -0700536int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, mode_t,
537 xfs_nlink_t, xfs_dev_t, struct cred *, xfs_prid_t,
538 int, struct xfs_buf **, boolean_t *, xfs_inode_t **);
Christoph Hellwig347d1c02007-08-28 13:57:51 +1000539void xfs_dinode_from_disk(struct xfs_icdinode *,
540 struct xfs_dinode_core *);
541void xfs_dinode_to_disk(struct xfs_dinode_core *,
542 struct xfs_icdinode *);
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544uint xfs_ip2xflags(struct xfs_inode *);
545uint xfs_dic2xflags(struct xfs_dinode_core *);
546int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
547 struct xfs_bmap_free *);
Lachlan McIlroyd3cf2092007-05-08 13:49:27 +1000548int xfs_itruncate_start(xfs_inode_t *, uint, xfs_fsize_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549int xfs_itruncate_finish(struct xfs_trans **, xfs_inode_t *,
550 xfs_fsize_t, int, int);
551int xfs_iunlink(struct xfs_trans *, xfs_inode_t *);
552int xfs_igrow_start(xfs_inode_t *, xfs_fsize_t, struct cred *);
553void xfs_igrow_finish(struct xfs_trans *, xfs_inode_t *,
554 xfs_fsize_t, int);
555
556void xfs_idestroy_fork(xfs_inode_t *, int);
557void xfs_idestroy(xfs_inode_t *);
558void xfs_idata_realloc(xfs_inode_t *, int, int);
559void xfs_iextract(xfs_inode_t *);
560void xfs_iext_realloc(xfs_inode_t *, int, int);
561void xfs_iroot_realloc(xfs_inode_t *, int, int);
562void xfs_ipin(xfs_inode_t *);
563void xfs_iunpin(xfs_inode_t *);
564int xfs_iextents_copy(xfs_inode_t *, xfs_bmbt_rec_t *, int);
565int xfs_iflush(xfs_inode_t *, uint);
Christoph Hellwigefa80272005-06-21 15:37:17 +1000566void xfs_iflush_all(struct xfs_mount *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567int xfs_iaccess(xfs_inode_t *, mode_t, cred_t *);
568uint xfs_iroundup(uint);
569void xfs_ichgtime(xfs_inode_t *, int);
570xfs_fsize_t xfs_file_last_byte(xfs_inode_t *);
571void xfs_lock_inodes(xfs_inode_t **, int, int, uint);
572
Christoph Hellwig42fe2b12006-01-11 15:35:17 +1100573void xfs_synchronize_atime(xfs_inode_t *);
574
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000575xfs_bmbt_rec_host_t *xfs_iext_get_ext(xfs_ifork_t *, xfs_extnum_t);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100576void xfs_iext_insert(xfs_ifork_t *, xfs_extnum_t, xfs_extnum_t,
577 xfs_bmbt_irec_t *);
578void xfs_iext_add(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100579void xfs_iext_add_indirect_multi(xfs_ifork_t *, int, xfs_extnum_t, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100580void xfs_iext_remove(xfs_ifork_t *, xfs_extnum_t, int);
581void xfs_iext_remove_inline(xfs_ifork_t *, xfs_extnum_t, int);
582void xfs_iext_remove_direct(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100583void xfs_iext_remove_indirect(xfs_ifork_t *, xfs_extnum_t, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100584void xfs_iext_realloc_direct(xfs_ifork_t *, int);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100585void xfs_iext_realloc_indirect(xfs_ifork_t *, int);
586void xfs_iext_indirect_to_direct(xfs_ifork_t *);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100587void xfs_iext_direct_to_inline(xfs_ifork_t *, xfs_extnum_t);
588void xfs_iext_inline_to_direct(xfs_ifork_t *, int);
589void xfs_iext_destroy(xfs_ifork_t *);
Christoph Hellwiga6f64d42007-08-16 16:23:40 +1000590xfs_bmbt_rec_host_t *xfs_iext_bno_to_ext(xfs_ifork_t *, xfs_fileoff_t, int *);
Mandy Kirkconnell0293ce32006-03-14 13:30:23 +1100591xfs_ext_irec_t *xfs_iext_bno_to_irec(xfs_ifork_t *, xfs_fileoff_t, int *);
592xfs_ext_irec_t *xfs_iext_idx_to_irec(xfs_ifork_t *, xfs_extnum_t *, int *, int);
593void xfs_iext_irec_init(xfs_ifork_t *);
594xfs_ext_irec_t *xfs_iext_irec_new(xfs_ifork_t *, int);
595void xfs_iext_irec_remove(xfs_ifork_t *, int);
596void xfs_iext_irec_compact(xfs_ifork_t *);
597void xfs_iext_irec_compact_pages(xfs_ifork_t *);
598void xfs_iext_irec_compact_full(xfs_ifork_t *);
599void xfs_iext_irec_update_extoffs(xfs_ifork_t *, int, int);
Mandy Kirkconnell4eea22f2006-03-14 13:29:52 +1100600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
602
603#ifdef DEBUG
604void xfs_isize_check(struct xfs_mount *, xfs_inode_t *, xfs_fsize_t);
605#else /* DEBUG */
606#define xfs_isize_check(mp, ip, isize)
607#endif /* DEBUG */
608
609#if defined(DEBUG)
610void xfs_inobp_check(struct xfs_mount *, struct xfs_buf *);
611#else
612#define xfs_inobp_check(mp, bp)
613#endif /* DEBUG */
614
David Chinnerda353b02007-08-28 14:00:13 +1000615extern struct kmem_zone *xfs_icluster_zone;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616extern struct kmem_zone *xfs_ifork_zone;
617extern struct kmem_zone *xfs_inode_zone;
618extern struct kmem_zone *xfs_ili_zone;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620#endif /* __KERNEL__ */
621
622#endif /* __XFS_INODE_H__ */