2 * Copyright (c) 2000-2003 Silicon Graphics, Inc. All Rights Reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it would be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * Further, this software is distributed without any warranty that it is
13 * free of the rightful claim of any third person regarding infringement
14 * or the like. Any license provided herein, whether implied or
15 * otherwise, applies only to this software file. Patent licenses, if
16 * any, provided herein do not apply to combinations of this program with
17 * other software, or any other product whatsoever.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write the Free Software Foundation, Inc., 59
21 * Temple Place - Suite 330, Boston MA 02111-1307, USA.
23 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
24 * Mountain View, CA 94043, or:
28 * For further information regarding this notice, see:
30 * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
32 #ifndef __XFS_INODE_H__
33 #define __XFS_INODE_H__
36 * File incore extent information, present for each of data & attr forks.
38 #define XFS_INLINE_EXTS 2
39 #define XFS_INLINE_DATA 32
40 typedef struct xfs_ifork
{
41 int if_bytes
; /* bytes in if_u1 */
42 int if_real_bytes
; /* bytes allocated in if_u1 */
43 xfs_bmbt_block_t
*if_broot
; /* file's incore btree root */
44 short if_broot_bytes
; /* bytes allocated for root */
45 unsigned char if_flags
; /* per-fork flags */
46 unsigned char if_ext_max
; /* max # of extent records */
47 xfs_extnum_t if_lastex
; /* last if_extents used */
49 xfs_bmbt_rec_t
*if_extents
; /* linear map file exts */
50 char *if_data
; /* inline file data */
53 xfs_bmbt_rec_t if_inline_ext
[XFS_INLINE_EXTS
];
54 /* very small file extents */
55 char if_inline_data
[XFS_INLINE_DATA
];
56 /* very small file data */
57 xfs_dev_t if_rdev
; /* dev number if special */
58 uuid_t if_uuid
; /* mount point value */
63 * Flags for xfs_ichgtime().
65 #define XFS_ICHGTIME_MOD 0x1 /* data fork modification timestamp */
66 #define XFS_ICHGTIME_ACC 0x2 /* data fork access timestamp */
67 #define XFS_ICHGTIME_CHG 0x4 /* inode field change timestamp */
70 * Per-fork incore inode flags.
72 #define XFS_IFINLINE 0x0001 /* Inline data is read in */
73 #define XFS_IFEXTENTS 0x0002 /* All extent pointers are read in */
74 #define XFS_IFBROOT 0x0004 /* i_broot points to the bmap b-tree root */
77 * Flags for xfs_imap() and xfs_dilocate().
79 #define XFS_IMAP_LOOKUP 0x1
82 * Maximum number of extent pointers in if_u1.if_extents.
84 #define XFS_MAX_INCORE_EXTENTS 32768
95 struct xfs_bmbt_block
;
97 struct xfs_inode_log_item
;
102 #if defined(XFS_ILOCK_TRACE)
103 #define XFS_ILOCK_KTRACE_SIZE 32
104 extern ktrace_t
*xfs_ilock_trace_buf
;
105 extern void xfs_ilock_trace(struct xfs_inode
*, int, unsigned int, inst_t
*);
107 #define xfs_ilock_trace(i,n,f,ra)
111 * This structure is used to communicate which extents of a file
112 * were holes when a write started from xfs_write_file() to
113 * xfs_strat_read(). This is necessary so that we can know which
114 * blocks need to be zeroed when they are read in in xfs_strat_read()
115 * if they weren\'t allocated when the buffer given to xfs_strat_read()
118 * We keep a list of these attached to the inode. The list is
119 * protected by the inode lock and the fact that the io lock is
120 * held exclusively by writers.
122 typedef struct xfs_gap
{
123 struct xfs_gap
*xg_next
;
124 xfs_fileoff_t xg_offset_fsb
;
125 xfs_extlen_t xg_count_fsb
;
128 typedef struct dm_attrs_s
{
129 __uint32_t da_dmevmask
; /* DMIG event mask */
130 __uint16_t da_dmstate
; /* DMIG state info */
131 __uint16_t da_pad
; /* DMIG extra padding */
134 typedef struct xfs_iocore
{
135 void *io_obj
; /* pointer to container
136 * inode or dcxvn structure */
137 struct xfs_mount
*io_mount
; /* fs mount struct ptr */
139 mrlock_t
*io_lock
; /* inode IO lock */
140 mrlock_t
*io_iolock
; /* inode IO lock */
144 xfs_fsize_t io_new_size
; /* sz when write completes */
146 /* Miscellaneous state. */
147 unsigned int io_flags
; /* IO related flags */
150 dm_attrs_t io_dmattrs
;
154 #define io_dmevmask io_dmattrs.da_dmevmask
155 #define io_dmstate io_dmattrs.da_dmstate
157 #define XFS_IO_INODE(io) ((xfs_inode_t *) ((io)->io_obj))
158 #define XFS_IO_DCXVN(io) ((dcxvn_t *) ((io)->io_obj))
161 * Flags in the flags field
164 #define XFS_IOCORE_RT 0x1
167 * xfs_iocore prototypes
170 extern void xfs_iocore_inode_init(struct xfs_inode
*);
171 extern void xfs_iocore_inode_reinit(struct xfs_inode
*);
175 * This is the type used in the xfs inode hash table.
176 * An array of these is allocated for each mounted
177 * file system to hash the inodes for that file system.
179 typedef struct xfs_ihash
{
180 struct xfs_inode
*ih_next
;
185 #define XFS_IHASH(mp,ino) ((mp)->m_ihash + (((uint)(ino)) % (mp)->m_ihsize))
188 * This is the xfs inode cluster hash. This hash is used by xfs_iflush to
189 * find inodes that share a cluster and can be flushed to disk at the same
192 typedef struct xfs_chashlist
{
193 struct xfs_chashlist
*chl_next
;
194 struct xfs_inode
*chl_ip
;
195 xfs_daddr_t chl_blkno
; /* starting block number of
197 struct xfs_buf
*chl_buf
; /* the inode buffer */
200 typedef struct xfs_chash
{
201 xfs_chashlist_t
*ch_list
;
205 #define XFS_CHASH(mp,blk) ((mp)->m_chash + (((uint)blk) % (mp)->m_chsize))
209 * This is the xfs in-core inode structure.
210 * Most of the on-disk inode is embedded in the i_d field.
212 * The extent pointers/inline file space, however, are managed
213 * separately. The memory for this information is pointed to by
214 * the if_u1 unions depending on the type of the data.
215 * This is used to linearize the array of extents for fast in-core
216 * access. This is used until the file's number of extents
217 * surpasses XFS_MAX_INCORE_EXTENTS, at which point all extent pointers
218 * are accessed through the buffer cache.
220 * Other state kept in the in-core inode is used for identification,
221 * locking, transactional updating, etc of the inode.
223 * Generally, we do not want to hold the i_rlock while holding the
224 * i_ilock. Hierarchy is i_iolock followed by i_rlock.
226 * xfs_iptr_t contains all the inode fields upto and including the
227 * i_mnext and i_mprev fields, it is used as a marker in the inode
228 * chain off the mount structure by xfs_sync calls.
232 struct xfs_ihash
*ip_hash
; /* pointer to hash header */
233 struct xfs_inode
*ip_next
; /* inode hash link forw */
234 struct xfs_inode
*ip_mnext
; /* next inode in mount list */
235 struct xfs_inode
*ip_mprev
; /* ptr to prev inode */
236 struct xfs_inode
**ip_prevp
; /* ptr to prev i_next */
237 struct xfs_mount
*ip_mount
; /* fs mount struct ptr */
240 typedef struct xfs_inode
{
241 /* Inode linking and identification information. */
242 struct xfs_ihash
*i_hash
; /* pointer to hash header */
243 struct xfs_inode
*i_next
; /* inode hash link forw */
244 struct xfs_inode
*i_mnext
; /* next inode in mount list */
245 struct xfs_inode
*i_mprev
; /* ptr to prev inode */
246 struct xfs_inode
**i_prevp
; /* ptr to prev i_next */
247 struct xfs_mount
*i_mount
; /* fs mount struct ptr */
248 struct list_head i_reclaim
; /* reclaim list */
249 struct bhv_desc i_bhv_desc
; /* inode behavior descriptor*/
250 struct xfs_dquot
*i_udquot
; /* user dquot */
251 struct xfs_dquot
*i_gdquot
; /* group dquot */
253 /* Inode location stuff */
254 xfs_ino_t i_ino
; /* inode number (agno/agino)*/
255 xfs_daddr_t i_blkno
; /* blkno of inode buffer */
256 ushort i_len
; /* len of inode buffer */
257 ushort i_boffset
; /* off of inode in buffer */
259 /* Extent information. */
260 xfs_ifork_t
*i_afp
; /* attribute fork pointer */
261 xfs_ifork_t i_df
; /* data fork */
263 /* Transaction and locking information. */
264 struct xfs_trans
*i_transp
; /* ptr to owning transaction*/
265 struct xfs_inode_log_item
*i_itemp
; /* logging information */
266 mrlock_t i_lock
; /* inode lock */
267 mrlock_t i_iolock
; /* inode IO lock */
268 sema_t i_flock
; /* inode flush lock */
269 atomic_t i_pincount
; /* inode pin count */
270 wait_queue_head_t i_ipin_wait
; /* inode pinning wait queue */
272 struct xfs_inode
**i_refcache
; /* ptr to entry in ref cache */
273 struct xfs_inode
*i_release
; /* inode to unref */
276 xfs_iocore_t i_iocore
; /* I/O core */
278 /* Miscellaneous state. */
279 unsigned short i_flags
; /* see defined flags below */
280 unsigned char i_update_core
; /* timestamps/size is dirty */
281 unsigned char i_update_size
; /* di_size field is dirty */
282 unsigned int i_gen
; /* generation count */
283 unsigned int i_delayed_blks
; /* count of delay alloc blks */
285 xfs_dinode_core_t i_d
; /* most of ondisk inode */
286 xfs_chashlist_t
*i_chash
; /* cluster hash list header */
287 struct xfs_inode
*i_cnext
; /* cluster hash link forward */
288 struct xfs_inode
*i_cprev
; /* cluster hash link backward */
290 /* Trace buffers per inode. */
291 #ifdef XFS_BMAP_TRACE
292 struct ktrace
*i_xtrace
; /* inode extent list trace */
294 #ifdef XFS_BMBT_TRACE
295 struct ktrace
*i_btrace
; /* inode bmap btree trace */
298 struct ktrace
*i_rwtrace
; /* inode read/write trace */
300 #ifdef XFS_ILOCK_TRACE
301 struct ktrace
*i_lock_trace
; /* inode lock/unlock trace */
303 #ifdef XFS_DIR2_TRACE
304 struct ktrace
*i_dir_trace
; /* inode directory trace */
308 #endif /* __KERNEL__ */
314 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_PTR)
315 xfs_ifork_t
*xfs_ifork_ptr(xfs_inode_t
*ip
, int w
);
316 #define XFS_IFORK_PTR(ip,w) xfs_ifork_ptr(ip,w)
318 #define XFS_IFORK_PTR(ip,w) ((w) == XFS_DATA_FORK ? &(ip)->i_df : (ip)->i_afp)
320 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_Q)
321 int xfs_ifork_q(xfs_inode_t
*ip
);
322 #define XFS_IFORK_Q(ip) xfs_ifork_q(ip)
324 #define XFS_IFORK_Q(ip) XFS_CFORK_Q(&(ip)->i_d)
326 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_DSIZE)
327 int xfs_ifork_dsize(xfs_inode_t
*ip
);
328 #define XFS_IFORK_DSIZE(ip) xfs_ifork_dsize(ip)
330 #define XFS_IFORK_DSIZE(ip) XFS_CFORK_DSIZE(&ip->i_d, ip->i_mount)
332 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_ASIZE)
333 int xfs_ifork_asize(xfs_inode_t
*ip
);
334 #define XFS_IFORK_ASIZE(ip) xfs_ifork_asize(ip)
336 #define XFS_IFORK_ASIZE(ip) XFS_CFORK_ASIZE(&ip->i_d, ip->i_mount)
338 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_SIZE)
339 int xfs_ifork_size(xfs_inode_t
*ip
, int w
);
340 #define XFS_IFORK_SIZE(ip,w) xfs_ifork_size(ip,w)
342 #define XFS_IFORK_SIZE(ip,w) XFS_CFORK_SIZE(&ip->i_d, ip->i_mount, w)
344 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_FORMAT)
345 int xfs_ifork_format(xfs_inode_t
*ip
, int w
);
346 #define XFS_IFORK_FORMAT(ip,w) xfs_ifork_format(ip,w)
348 #define XFS_IFORK_FORMAT(ip,w) XFS_CFORK_FORMAT(&ip->i_d, w)
350 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_FMT_SET)
351 void xfs_ifork_fmt_set(xfs_inode_t
*ip
, int w
, int n
);
352 #define XFS_IFORK_FMT_SET(ip,w,n) xfs_ifork_fmt_set(ip,w,n)
354 #define XFS_IFORK_FMT_SET(ip,w,n) XFS_CFORK_FMT_SET(&ip->i_d, w, n)
356 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_NEXTENTS)
357 int xfs_ifork_nextents(xfs_inode_t
*ip
, int w
);
358 #define XFS_IFORK_NEXTENTS(ip,w) xfs_ifork_nextents(ip,w)
360 #define XFS_IFORK_NEXTENTS(ip,w) XFS_CFORK_NEXTENTS(&ip->i_d, w)
362 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_IFORK_NEXT_SET)
363 void xfs_ifork_next_set(xfs_inode_t
*ip
, int w
, int n
);
364 #define XFS_IFORK_NEXT_SET(ip,w,n) xfs_ifork_next_set(ip,w,n)
366 #define XFS_IFORK_NEXT_SET(ip,w,n) XFS_CFORK_NEXT_SET(&ip->i_d, w, n)
373 * In-core inode flags.
375 #define XFS_IGRIO 0x0001 /* inode used for guaranteed rate i/o */
376 #define XFS_IUIOSZ 0x0002 /* inode i/o sizes have been explicitly set */
377 #define XFS_IQUIESCE 0x0004 /* we have started quiescing for this inode */
378 #define XFS_IRECLAIM 0x0008 /* we have started reclaiming this inode */
379 #define XFS_ISTALE 0x0010 /* inode has been staled */
380 #define XFS_IRECLAIMABLE 0x0020 /* inode can be reclaimed */
381 #define XFS_INEW 0x0040
384 * Flags for inode locking.
386 #define XFS_IOLOCK_EXCL 0x001
387 #define XFS_IOLOCK_SHARED 0x002
388 #define XFS_ILOCK_EXCL 0x004
389 #define XFS_ILOCK_SHARED 0x008
390 #define XFS_IUNLOCK_NONOTIFY 0x010
391 #define XFS_EXTENT_TOKEN_RD 0x040
392 #define XFS_SIZE_TOKEN_RD 0x080
393 #define XFS_EXTSIZE_RD (XFS_EXTENT_TOKEN_RD|XFS_SIZE_TOKEN_RD)
394 #define XFS_WILLLEND 0x100 /* Always acquire tokens for lending */
395 #define XFS_EXTENT_TOKEN_WR (XFS_EXTENT_TOKEN_RD | XFS_WILLLEND)
396 #define XFS_SIZE_TOKEN_WR (XFS_SIZE_TOKEN_RD | XFS_WILLLEND)
397 #define XFS_EXTSIZE_WR (XFS_EXTSIZE_RD | XFS_WILLLEND)
400 #define XFS_LOCK_MASK \
401 (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL | \
402 XFS_ILOCK_SHARED | XFS_EXTENT_TOKEN_RD | XFS_SIZE_TOKEN_RD | \
406 * Flags for xfs_iflush()
408 #define XFS_IFLUSH_DELWRI_ELSE_SYNC 1
409 #define XFS_IFLUSH_DELWRI_ELSE_ASYNC 2
410 #define XFS_IFLUSH_SYNC 3
411 #define XFS_IFLUSH_ASYNC 4
412 #define XFS_IFLUSH_DELWRI 5
415 * Flags for xfs_itruncate_start().
417 #define XFS_ITRUNC_DEFINITE 0x1
418 #define XFS_ITRUNC_MAYBE 0x2
420 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ITOV)
421 struct vnode
*xfs_itov(xfs_inode_t
*ip
);
422 #define XFS_ITOV(ip) xfs_itov(ip)
424 #define XFS_ITOV(ip) BHV_TO_VNODE(XFS_ITOBHV(ip))
426 #define XFS_ITOV_NULL(ip) BHV_TO_VNODE_NULL(XFS_ITOBHV(ip))
427 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ITOBHV)
428 struct bhv_desc
*xfs_itobhv(xfs_inode_t
*ip
);
429 #define XFS_ITOBHV(ip) xfs_itobhv(ip)
431 #define XFS_ITOBHV(ip) ((struct bhv_desc *)(&((ip)->i_bhv_desc)))
433 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_BHVTOI)
434 xfs_inode_t
*xfs_bhvtoi(struct bhv_desc
*bhvp
);
435 #define XFS_BHVTOI(bhvp) xfs_bhvtoi(bhvp)
437 #define XFS_BHVTOI(bhvp) \
438 ((xfs_inode_t *)((char *)(bhvp) - \
439 (char *)&(((xfs_inode_t *)0)->i_bhv_desc)))
442 #define BHV_IS_XFS(bdp) (BHV_OPS(bdp) == &xfs_vnodeops)
445 * For multiple groups support: if S_ISGID bit is set in the parent
446 * directory, group of new file is set to that of the parent, and
447 * new subdirectory gets S_ISGID bit from parent.
449 #define XFS_INHERIT_GID(pip, vfsp) \
450 (((vfsp)->vfs_flag & VFS_GRPID) || ((pip)->i_d.di_mode & S_ISGID))
453 * xfs_iget.c prototypes.
456 #define IGET_CREATE 1
458 void xfs_ihash_init(struct xfs_mount
*);
459 void xfs_ihash_free(struct xfs_mount
*);
460 void xfs_chash_init(struct xfs_mount
*);
461 void xfs_chash_free(struct xfs_mount
*);
462 xfs_inode_t
*xfs_inode_incore(struct xfs_mount
*, xfs_ino_t
,
464 void xfs_inode_lock_init(xfs_inode_t
*, struct vnode
*);
465 int xfs_iget(struct xfs_mount
*, struct xfs_trans
*, xfs_ino_t
,
466 uint
, uint
, xfs_inode_t
**, xfs_daddr_t
);
467 void xfs_iput(xfs_inode_t
*, uint
);
468 void xfs_iput_new(xfs_inode_t
*, uint
);
469 void xfs_ilock(xfs_inode_t
*, uint
);
470 int xfs_ilock_nowait(xfs_inode_t
*, uint
);
471 void xfs_iunlock(xfs_inode_t
*, uint
);
472 void xfs_ilock_demote(xfs_inode_t
*, uint
);
473 void xfs_iflock(xfs_inode_t
*);
474 int xfs_iflock_nowait(xfs_inode_t
*);
475 uint
xfs_ilock_map_shared(xfs_inode_t
*);
476 void xfs_iunlock_map_shared(xfs_inode_t
*, uint
);
477 void xfs_ifunlock(xfs_inode_t
*);
478 void xfs_ireclaim(xfs_inode_t
*);
479 int xfs_finish_reclaim(xfs_inode_t
*, int, int);
480 int xfs_finish_reclaim_all(struct xfs_mount
*, int);
483 * xfs_inode.c prototypes.
485 int xfs_itobp(struct xfs_mount
*, struct xfs_trans
*,
486 xfs_inode_t
*, xfs_dinode_t
**, struct xfs_buf
**,
488 int xfs_iread(struct xfs_mount
*, struct xfs_trans
*, xfs_ino_t
,
489 xfs_inode_t
**, xfs_daddr_t
);
490 int xfs_iread_extents(struct xfs_trans
*, xfs_inode_t
*, int);
491 int xfs_ialloc(struct xfs_trans
*, xfs_inode_t
*, mode_t
,
492 xfs_nlink_t
, xfs_dev_t
, struct cred
*, xfs_prid_t
,
493 int, struct xfs_buf
**, boolean_t
*, xfs_inode_t
**);
494 void xfs_xlate_dinode_core(xfs_caddr_t
, struct xfs_dinode_core
*,
496 uint
xfs_ip2xflags(struct xfs_inode
*);
497 uint
xfs_dic2xflags(struct xfs_dinode_core
*);
498 int xfs_ifree(struct xfs_trans
*, xfs_inode_t
*,
499 struct xfs_bmap_free
*);
500 void xfs_itruncate_start(xfs_inode_t
*, uint
, xfs_fsize_t
);
501 int xfs_itruncate_finish(struct xfs_trans
**, xfs_inode_t
*,
502 xfs_fsize_t
, int, int);
503 int xfs_iunlink(struct xfs_trans
*, xfs_inode_t
*);
504 int xfs_igrow_start(xfs_inode_t
*, xfs_fsize_t
, struct cred
*);
505 void xfs_igrow_finish(struct xfs_trans
*, xfs_inode_t
*,
508 void xfs_idestroy_fork(xfs_inode_t
*, int);
509 void xfs_idestroy(xfs_inode_t
*);
510 void xfs_idata_realloc(xfs_inode_t
*, int, int);
511 void xfs_iextract(xfs_inode_t
*);
512 void xfs_iext_realloc(xfs_inode_t
*, int, int);
513 void xfs_iroot_realloc(xfs_inode_t
*, int, int);
514 void xfs_ipin(xfs_inode_t
*);
515 void xfs_iunpin(xfs_inode_t
*);
516 int xfs_iextents_copy(xfs_inode_t
*, xfs_bmbt_rec_t
*, int);
517 int xfs_iflush(xfs_inode_t
*, uint
);
518 void xfs_iflush_all(struct xfs_mount
*);
519 int xfs_iaccess(xfs_inode_t
*, mode_t
, cred_t
*);
520 uint
xfs_iroundup(uint
);
521 void xfs_ichgtime(xfs_inode_t
*, int);
522 xfs_fsize_t
xfs_file_last_byte(xfs_inode_t
*);
523 void xfs_lock_inodes(xfs_inode_t
**, int, int, uint
);
525 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
528 void xfs_isize_check(struct xfs_mount
*, xfs_inode_t
*, xfs_fsize_t
);
530 #define xfs_isize_check(mp, ip, isize)
534 void xfs_inobp_check(struct xfs_mount
*, struct xfs_buf
*);
536 #define xfs_inobp_check(mp, bp)
539 extern struct kmem_zone
*xfs_chashlist_zone
;
540 extern struct kmem_zone
*xfs_ifork_zone
;
541 extern struct kmem_zone
*xfs_inode_zone
;
542 extern struct kmem_zone
*xfs_ili_zone
;
543 extern struct vnodeops xfs_vnodeops
;
545 #endif /* __KERNEL__ */
547 #endif /* __XFS_INODE_H__ */