2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation.
9 * 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.
14 * 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
18 #ifndef __XFS_INODE_H__
19 #define __XFS_INODE_H__
28 #define XFS_DATA_FORK 0
29 #define XFS_ATTR_FORK 1
32 * 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.
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.
50 typedef struct xfs_ext_irec
{
51 xfs_bmbt_rec_host_t
*er_extbuf
; /* block of extent records */
52 xfs_extnum_t er_extoff
; /* extent offset in file */
53 xfs_extnum_t er_extcount
; /* number of extents in page/block */
57 * File incore extent information, present for each of data & attr forks.
59 #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
63 typedef struct xfs_ifork
{
64 int if_bytes
; /* bytes in if_u1 */
65 int if_real_bytes
; /* bytes allocated in if_u1 */
66 struct xfs_btree_block
*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 */
72 xfs_bmbt_rec_host_t
*if_extents
;/* linear map file exts */
73 xfs_ext_irec_t
*if_ext_irec
; /* irec map file exts */
74 char *if_data
; /* inline file data */
77 xfs_bmbt_rec_host_t if_inline_ext
[XFS_INLINE_EXTS
];
78 /* 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 */
87 * 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.
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 */
97 * This is the xfs in-core inode structure.
98 * Most of the on-disk inode is embedded in the i_d field.
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.
108 * Other state kept in the in-core inode is used for identification,
109 * locking, transactional updating, etc of the inode.
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.
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.
119 typedef struct xfs_ictimestamp
{
120 __int32_t t_sec
; /* timestamp seconds */
121 __int32_t t_nsec
; /* timestamp nanoseconds */
125 * NOTE: This structure must be kept identical to struct xfs_dinode
126 * in xfs_dinode.h except for the endianness annotations.
128 typedef 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 */
157 * Flags for xfs_ichgtime().
159 #define XFS_ICHGTIME_MOD 0x1 /* data fork modification timestamp */
160 #define XFS_ICHGTIME_CHG 0x2 /* inode field change timestamp */
163 * Per-fork incore inode flags.
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 */
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))
177 #define XFS_IFORK_PTR(ip,w) \
178 ((w) == XFS_DATA_FORK ? \
181 #define XFS_IFORK_DSIZE(ip) \
183 XFS_IFORK_BOFF(ip) : \
184 XFS_LITINO((ip)->i_mount))
185 #define XFS_IFORK_ASIZE(ip) \
187 XFS_LITINO((ip)->i_mount) - XFS_IFORK_BOFF(ip) : \
189 #define XFS_IFORK_SIZE(ip,w) \
190 ((w) == XFS_DATA_FORK ? \
191 XFS_IFORK_DSIZE(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)))
217 struct xfs_bmap_free
;
218 struct xfs_bmbt_irec
;
219 struct xfs_inode_log_item
;
224 typedef struct dm_attrs_s
{
225 __uint32_t da_dmevmask
; /* DMIG event mask */
226 __uint16_t da_dmstate
; /* DMIG state info */
227 __uint16_t da_pad
; /* DMIG extra padding */
230 typedef struct xfs_inode
{
231 /* Inode linking and identification information. */
232 struct xfs_mount
*i_mount
; /* fs mount struct ptr */
233 struct xfs_dquot
*i_udquot
; /* user dquot */
234 struct xfs_dquot
*i_gdquot
; /* group dquot */
236 /* Inode location stuff */
237 xfs_ino_t i_ino
; /* inode number (agno/agino)*/
238 struct xfs_imap i_imap
; /* location for xfs_imap() */
240 /* Extent information. */
241 xfs_ifork_t
*i_afp
; /* attribute fork pointer */
242 xfs_ifork_t i_df
; /* data fork */
244 /* Transaction and locking information. */
245 struct xfs_trans
*i_transp
; /* ptr to owning transaction*/
246 struct xfs_inode_log_item
*i_itemp
; /* logging information */
247 mrlock_t i_lock
; /* inode lock */
248 mrlock_t i_iolock
; /* inode IO lock */
249 struct completion i_flush
; /* inode flush completion q */
250 atomic_t i_pincount
; /* inode pin count */
251 wait_queue_head_t i_ipin_wait
; /* inode pinning wait queue */
252 spinlock_t i_flags_lock
; /* inode i_flags lock */
253 /* Miscellaneous state. */
254 unsigned short i_flags
; /* see defined flags below */
255 unsigned char i_update_core
; /* timestamps/size is dirty */
256 unsigned int i_delayed_blks
; /* count of delay alloc blks */
258 xfs_icdinode_t i_d
; /* most of ondisk inode */
260 xfs_fsize_t i_size
; /* in-memory size */
261 xfs_fsize_t i_new_size
; /* size when write completes */
262 atomic_t i_iocount
; /* outstanding I/O count */
265 struct inode i_vnode
; /* embedded VFS inode */
268 #define XFS_ISIZE(ip) (((ip)->i_d.di_mode & S_IFMT) == S_IFREG) ? \
269 (ip)->i_size : (ip)->i_d.di_size;
271 /* Convert from vfs inode to xfs inode */
272 static inline struct xfs_inode
*XFS_I(struct inode
*inode
)
274 return container_of(inode
, struct xfs_inode
, i_vnode
);
277 /* convert from xfs inode to vfs inode */
278 static inline struct inode
*VFS_I(struct xfs_inode
*ip
)
284 * i_flags helper functions
287 __xfs_iflags_set(xfs_inode_t
*ip
, unsigned short flags
)
289 ip
->i_flags
|= flags
;
293 xfs_iflags_set(xfs_inode_t
*ip
, unsigned short flags
)
295 spin_lock(&ip
->i_flags_lock
);
296 __xfs_iflags_set(ip
, flags
);
297 spin_unlock(&ip
->i_flags_lock
);
301 xfs_iflags_clear(xfs_inode_t
*ip
, unsigned short flags
)
303 spin_lock(&ip
->i_flags_lock
);
304 ip
->i_flags
&= ~flags
;
305 spin_unlock(&ip
->i_flags_lock
);
309 __xfs_iflags_test(xfs_inode_t
*ip
, unsigned short flags
)
311 return (ip
->i_flags
& flags
);
315 xfs_iflags_test(xfs_inode_t
*ip
, unsigned short flags
)
318 spin_lock(&ip
->i_flags_lock
);
319 ret
= __xfs_iflags_test(ip
, flags
);
320 spin_unlock(&ip
->i_flags_lock
);
325 xfs_iflags_test_and_clear(xfs_inode_t
*ip
, unsigned short flags
)
329 spin_lock(&ip
->i_flags_lock
);
330 ret
= ip
->i_flags
& flags
;
332 ip
->i_flags
&= ~flags
;
333 spin_unlock(&ip
->i_flags_lock
);
338 * Manage the i_flush queue embedded in the inode. This completion
339 * queue synchronizes processes attempting to flush the in-core
340 * inode back to disk.
342 static inline void xfs_iflock(xfs_inode_t
*ip
)
344 wait_for_completion(&ip
->i_flush
);
347 static inline int xfs_iflock_nowait(xfs_inode_t
*ip
)
349 return try_wait_for_completion(&ip
->i_flush
);
352 static inline void xfs_ifunlock(xfs_inode_t
*ip
)
354 complete(&ip
->i_flush
);
358 * In-core inode flags.
360 #define XFS_IRECLAIM 0x0001 /* we have started reclaiming this inode */
361 #define XFS_ISTALE 0x0002 /* inode has been staled */
362 #define XFS_IRECLAIMABLE 0x0004 /* inode can be reclaimed */
363 #define XFS_INEW 0x0008 /* inode has just been allocated */
364 #define XFS_IFILESTREAM 0x0010 /* inode is in a filestream directory */
365 #define XFS_ITRUNCATED 0x0020 /* truncated down so flush-on-close */
368 * Flags for inode locking.
369 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
370 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
372 #define XFS_IOLOCK_EXCL (1<<0)
373 #define XFS_IOLOCK_SHARED (1<<1)
374 #define XFS_ILOCK_EXCL (1<<2)
375 #define XFS_ILOCK_SHARED (1<<3)
376 #define XFS_IUNLOCK_NONOTIFY (1<<4)
378 #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
379 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED)
381 #define XFS_LOCK_FLAGS \
382 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
383 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
384 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
385 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
386 { XFS_IUNLOCK_NONOTIFY, "IUNLOCK_NONOTIFY" }
390 * Flags for lockdep annotations.
392 * XFS_I[O]LOCK_PARENT - for operations that require locking two inodes
393 * (ie directory operations that require locking a directory inode and
394 * an entry inode). The first inode gets locked with this flag so it
395 * gets a lockdep subclass of 1 and the second lock will have a lockdep
398 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
399 * with xfs_lock_inodes(). This flag is used as the starting subclass
400 * and each subsequent lock acquired will increment the subclass by one.
401 * So the first lock acquired will have a lockdep subclass of 2, the
402 * second lock will have a lockdep subclass of 3, and so on. It is
403 * the responsibility of the class builder to shift this to the correct
404 * portion of the lock_mode lockdep mask.
406 #define XFS_LOCK_PARENT 1
407 #define XFS_LOCK_INUMORDER 2
409 #define XFS_IOLOCK_SHIFT 16
410 #define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)
412 #define XFS_ILOCK_SHIFT 24
413 #define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
415 #define XFS_IOLOCK_DEP_MASK 0x00ff0000
416 #define XFS_ILOCK_DEP_MASK 0xff000000
417 #define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK)
419 #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT)
420 #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT)
423 * Flags for xfs_itruncate_start().
425 #define XFS_ITRUNC_DEFINITE 0x1
426 #define XFS_ITRUNC_MAYBE 0x2
428 #define XFS_ITRUNC_FLAGS \
429 { XFS_ITRUNC_DEFINITE, "DEFINITE" }, \
430 { XFS_ITRUNC_MAYBE, "MAYBE" }
433 * For multiple groups support: if S_ISGID bit is set in the parent
434 * directory, group of new file is set to that of the parent, and
435 * new subdirectory gets S_ISGID bit from parent.
437 #define XFS_INHERIT_GID(pip) \
438 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
439 ((pip)->i_d.di_mode & S_ISGID))
442 * xfs_iget.c prototypes.
444 int xfs_iget(struct xfs_mount
*, struct xfs_trans
*, xfs_ino_t
,
445 uint
, uint
, xfs_inode_t
**, xfs_daddr_t
);
446 void xfs_iput(xfs_inode_t
*, uint
);
447 void xfs_iput_new(xfs_inode_t
*, uint
);
448 void xfs_ilock(xfs_inode_t
*, uint
);
449 int xfs_ilock_nowait(xfs_inode_t
*, uint
);
450 void xfs_iunlock(xfs_inode_t
*, uint
);
451 void xfs_ilock_demote(xfs_inode_t
*, uint
);
452 int xfs_isilocked(xfs_inode_t
*, uint
);
453 uint
xfs_ilock_map_shared(xfs_inode_t
*);
454 void xfs_iunlock_map_shared(xfs_inode_t
*, uint
);
455 void xfs_ireclaim(xfs_inode_t
*);
458 * xfs_inode.c prototypes.
460 int xfs_ialloc(struct xfs_trans
*, xfs_inode_t
*, mode_t
,
461 xfs_nlink_t
, xfs_dev_t
, cred_t
*, xfs_prid_t
,
462 int, struct xfs_buf
**, boolean_t
*, xfs_inode_t
**);
464 uint
xfs_ip2xflags(struct xfs_inode
*);
465 uint
xfs_dic2xflags(struct xfs_dinode
*);
466 int xfs_ifree(struct xfs_trans
*, xfs_inode_t
*,
467 struct xfs_bmap_free
*);
468 int xfs_itruncate_start(xfs_inode_t
*, uint
, xfs_fsize_t
);
469 int xfs_itruncate_finish(struct xfs_trans
**, xfs_inode_t
*,
470 xfs_fsize_t
, int, int);
471 int xfs_iunlink(struct xfs_trans
*, xfs_inode_t
*);
473 void xfs_iext_realloc(xfs_inode_t
*, int, int);
474 void xfs_iunpin_wait(xfs_inode_t
*);
475 int xfs_iflush(xfs_inode_t
*, uint
);
476 void xfs_ichgtime(xfs_inode_t
*, int);
477 void xfs_lock_inodes(xfs_inode_t
**, int, uint
);
478 void xfs_lock_two_inodes(xfs_inode_t
*, xfs_inode_t
*, uint
);
480 void xfs_synchronize_times(xfs_inode_t
*);
481 void xfs_mark_inode_dirty(xfs_inode_t
*);
482 void xfs_mark_inode_dirty_sync(xfs_inode_t
*);
486 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
487 atomic_inc(&(VFS_I(ip)->i_count)); \
488 trace_xfs_ihold(ip, _THIS_IP_); \
493 trace_xfs_irele(ip, _THIS_IP_); \
497 #endif /* __KERNEL__ */
500 * Flags for xfs_iget()
502 #define XFS_IGET_CREATE 0x1
503 #define XFS_IGET_BULKSTAT 0x2
505 int xfs_inotobp(struct xfs_mount
*, struct xfs_trans
*,
506 xfs_ino_t
, struct xfs_dinode
**,
507 struct xfs_buf
**, int *, uint
);
508 int xfs_itobp(struct xfs_mount
*, struct xfs_trans
*,
509 struct xfs_inode
*, struct xfs_dinode
**,
510 struct xfs_buf
**, uint
);
511 int xfs_iread(struct xfs_mount
*, struct xfs_trans
*,
512 struct xfs_inode
*, xfs_daddr_t
, uint
);
513 void xfs_dinode_to_disk(struct xfs_dinode
*,
514 struct xfs_icdinode
*);
515 void xfs_idestroy_fork(struct xfs_inode
*, int);
516 void xfs_idata_realloc(struct xfs_inode
*, int, int);
517 void xfs_iroot_realloc(struct xfs_inode
*, int, int);
518 int xfs_iread_extents(struct xfs_trans
*, struct xfs_inode
*, int);
519 int xfs_iextents_copy(struct xfs_inode
*, xfs_bmbt_rec_t
*, int);
521 xfs_bmbt_rec_host_t
*xfs_iext_get_ext(xfs_ifork_t
*, xfs_extnum_t
);
522 void xfs_iext_insert(xfs_inode_t
*, xfs_extnum_t
, xfs_extnum_t
,
523 xfs_bmbt_irec_t
*, int);
524 void xfs_iext_add(xfs_ifork_t
*, xfs_extnum_t
, int);
525 void xfs_iext_add_indirect_multi(xfs_ifork_t
*, int, xfs_extnum_t
, int);
526 void xfs_iext_remove(xfs_inode_t
*, xfs_extnum_t
, int, int);
527 void xfs_iext_remove_inline(xfs_ifork_t
*, xfs_extnum_t
, int);
528 void xfs_iext_remove_direct(xfs_ifork_t
*, xfs_extnum_t
, int);
529 void xfs_iext_remove_indirect(xfs_ifork_t
*, xfs_extnum_t
, int);
530 void xfs_iext_realloc_direct(xfs_ifork_t
*, int);
531 void xfs_iext_direct_to_inline(xfs_ifork_t
*, xfs_extnum_t
);
532 void xfs_iext_inline_to_direct(xfs_ifork_t
*, int);
533 void xfs_iext_destroy(xfs_ifork_t
*);
534 xfs_bmbt_rec_host_t
*xfs_iext_bno_to_ext(xfs_ifork_t
*, xfs_fileoff_t
, int *);
535 xfs_ext_irec_t
*xfs_iext_bno_to_irec(xfs_ifork_t
*, xfs_fileoff_t
, int *);
536 xfs_ext_irec_t
*xfs_iext_idx_to_irec(xfs_ifork_t
*, xfs_extnum_t
*, int *, int);
537 void xfs_iext_irec_init(xfs_ifork_t
*);
538 xfs_ext_irec_t
*xfs_iext_irec_new(xfs_ifork_t
*, int);
539 void xfs_iext_irec_remove(xfs_ifork_t
*, int);
540 void xfs_iext_irec_compact(xfs_ifork_t
*);
541 void xfs_iext_irec_compact_pages(xfs_ifork_t
*);
542 void xfs_iext_irec_compact_full(xfs_ifork_t
*);
543 void xfs_iext_irec_update_extoffs(xfs_ifork_t
*, int, int);
545 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
548 void xfs_isize_check(struct xfs_mount
*, struct xfs_inode
*,
551 #define xfs_isize_check(mp, ip, isize)
555 void xfs_inobp_check(struct xfs_mount
*, struct xfs_buf
*);
557 #define xfs_inobp_check(mp, bp)
560 extern struct kmem_zone
*xfs_ifork_zone
;
561 extern struct kmem_zone
*xfs_inode_zone
;
562 extern struct kmem_zone
*xfs_ili_zone
;
564 #endif /* __XFS_INODE_H__ */