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__
24 #define XFS_DATA_FORK 0
25 #define XFS_ATTR_FORK 1
28 * File incore extent information, present for each of data & attr forks.
30 #define XFS_INLINE_EXTS 2
31 #define XFS_INLINE_DATA 32
32 typedef struct xfs_ifork {
33 int if_bytes; /* bytes in if_u1 */
34 int if_real_bytes; /* bytes allocated in if_u1 */
35 xfs_bmbt_block_t *if_broot; /* file's incore btree root */
36 short if_broot_bytes; /* bytes allocated for root */
37 unsigned char if_flags; /* per-fork flags */
38 unsigned char if_ext_max; /* max # of extent records */
39 xfs_extnum_t if_lastex; /* last if_extents used */
41 xfs_bmbt_rec_t *if_extents; /* linear map file exts */
42 char *if_data; /* inline file data */
45 xfs_bmbt_rec_t if_inline_ext[XFS_INLINE_EXTS];
46 /* very small file extents */
47 char if_inline_data[XFS_INLINE_DATA];
48 /* very small file data */
49 xfs_dev_t if_rdev; /* dev number if special */
50 uuid_t if_uuid; /* mount point value */
55 * Flags for xfs_ichgtime().
57 #define XFS_ICHGTIME_MOD 0x1 /* data fork modification timestamp */
58 #define XFS_ICHGTIME_ACC 0x2 /* data fork access timestamp */
59 #define XFS_ICHGTIME_CHG 0x4 /* inode field change timestamp */
62 * Per-fork incore inode flags.
64 #define XFS_IFINLINE 0x0001 /* Inline data is read in */
65 #define XFS_IFEXTENTS 0x0002 /* All extent pointers are read in */
66 #define XFS_IFBROOT 0x0004 /* i_broot points to the bmap b-tree root */
69 * Flags for xfs_imap() and xfs_dilocate().
71 #define XFS_IMAP_LOOKUP 0x1
74 * Maximum number of extent pointers in if_u1.if_extents.
76 #define XFS_MAX_INCORE_EXTENTS 32768
87 struct xfs_bmbt_block;
89 struct xfs_inode_log_item;
94 #if defined(XFS_ILOCK_TRACE)
95 #define XFS_ILOCK_KTRACE_SIZE 32
96 extern ktrace_t *xfs_ilock_trace_buf;
97 extern void xfs_ilock_trace(struct xfs_inode *, int, unsigned int, inst_t *);
99 #define xfs_ilock_trace(i,n,f,ra)
103 * This structure is used to communicate which extents of a file
104 * were holes when a write started from xfs_write_file() to
105 * xfs_strat_read(). This is necessary so that we can know which
106 * blocks need to be zeroed when they are read in in xfs_strat_read()
107 * if they weren\'t allocated when the buffer given to xfs_strat_read()
110 * We keep a list of these attached to the inode. The list is
111 * protected by the inode lock and the fact that the io lock is
112 * held exclusively by writers.
114 typedef struct xfs_gap {
115 struct xfs_gap *xg_next;
116 xfs_fileoff_t xg_offset_fsb;
117 xfs_extlen_t xg_count_fsb;
120 typedef struct dm_attrs_s {
121 __uint32_t da_dmevmask; /* DMIG event mask */
122 __uint16_t da_dmstate; /* DMIG state info */
123 __uint16_t da_pad; /* DMIG extra padding */
126 typedef struct xfs_iocore {
127 void *io_obj; /* pointer to container
128 * inode or dcxvn structure */
129 struct xfs_mount *io_mount; /* fs mount struct ptr */
131 mrlock_t *io_lock; /* inode IO lock */
132 mrlock_t *io_iolock; /* inode IO lock */
136 xfs_fsize_t io_new_size; /* sz when write completes */
138 /* Miscellaneous state. */
139 unsigned int io_flags; /* IO related flags */
142 dm_attrs_t io_dmattrs;
146 #define io_dmevmask io_dmattrs.da_dmevmask
147 #define io_dmstate io_dmattrs.da_dmstate
149 #define XFS_IO_INODE(io) ((xfs_inode_t *) ((io)->io_obj))
150 #define XFS_IO_DCXVN(io) ((dcxvn_t *) ((io)->io_obj))
153 * Flags in the flags field
156 #define XFS_IOCORE_RT 0x1
159 * xfs_iocore prototypes
162 extern void xfs_iocore_inode_init(struct xfs_inode *);
163 extern void xfs_iocore_inode_reinit(struct xfs_inode *);
167 * This is the type used in the xfs inode hash table.
168 * An array of these is allocated for each mounted
169 * file system to hash the inodes for that file system.
171 typedef struct xfs_ihash {
172 struct xfs_inode *ih_next;
177 #define XFS_IHASH(mp,ino) ((mp)->m_ihash + (((uint)(ino)) % (mp)->m_ihsize))
180 * This is the xfs inode cluster hash. This hash is used by xfs_iflush to
181 * find inodes that share a cluster and can be flushed to disk at the same
184 typedef struct xfs_chashlist {
185 struct xfs_chashlist *chl_next;
186 struct xfs_inode *chl_ip;
187 xfs_daddr_t chl_blkno; /* starting block number of
189 struct xfs_buf *chl_buf; /* the inode buffer */
192 typedef struct xfs_chash {
193 xfs_chashlist_t *ch_list;
197 #define XFS_CHASH(mp,blk) ((mp)->m_chash + (((uint)blk) % (mp)->m_chsize))
201 * This is the xfs in-core inode structure.
202 * Most of the on-disk inode is embedded in the i_d field.
204 * The extent pointers/inline file space, however, are managed
205 * separately. The memory for this information is pointed to by
206 * the if_u1 unions depending on the type of the data.
207 * This is used to linearize the array of extents for fast in-core
208 * access. This is used until the file's number of extents
209 * surpasses XFS_MAX_INCORE_EXTENTS, at which point all extent pointers
210 * are accessed through the buffer cache.
212 * Other state kept in the in-core inode is used for identification,
213 * locking, transactional updating, etc of the inode.
215 * Generally, we do not want to hold the i_rlock while holding the
216 * i_ilock. Hierarchy is i_iolock followed by i_rlock.
218 * xfs_iptr_t contains all the inode fields upto and including the
219 * i_mnext and i_mprev fields, it is used as a marker in the inode
220 * chain off the mount structure by xfs_sync calls.
224 struct xfs_ihash *ip_hash; /* pointer to hash header */
225 struct xfs_inode *ip_next; /* inode hash link forw */
226 struct xfs_inode *ip_mnext; /* next inode in mount list */
227 struct xfs_inode *ip_mprev; /* ptr to prev inode */
228 struct xfs_inode **ip_prevp; /* ptr to prev i_next */
229 struct xfs_mount *ip_mount; /* fs mount struct ptr */
232 typedef struct xfs_inode {
233 /* Inode linking and identification information. */
234 struct xfs_ihash *i_hash; /* pointer to hash header */
235 struct xfs_inode *i_next; /* inode hash link forw */
236 struct xfs_inode *i_mnext; /* next inode in mount list */
237 struct xfs_inode *i_mprev; /* ptr to prev inode */
238 struct xfs_inode **i_prevp; /* ptr to prev i_next */
239 struct xfs_mount *i_mount; /* fs mount struct ptr */
240 struct list_head i_reclaim; /* reclaim list */
241 struct bhv_desc i_bhv_desc; /* inode behavior descriptor*/
242 struct xfs_dquot *i_udquot; /* user dquot */
243 struct xfs_dquot *i_gdquot; /* group dquot */
245 /* Inode location stuff */
246 xfs_ino_t i_ino; /* inode number (agno/agino)*/
247 xfs_daddr_t i_blkno; /* blkno of inode buffer */
248 ushort i_len; /* len of inode buffer */
249 ushort i_boffset; /* off of inode in buffer */
251 /* Extent information. */
252 xfs_ifork_t *i_afp; /* attribute fork pointer */
253 xfs_ifork_t i_df; /* data fork */
255 /* Transaction and locking information. */
256 struct xfs_trans *i_transp; /* ptr to owning transaction*/
257 struct xfs_inode_log_item *i_itemp; /* logging information */
258 mrlock_t i_lock; /* inode lock */
259 mrlock_t i_iolock; /* inode IO lock */
260 sema_t i_flock; /* inode flush lock */
261 atomic_t i_pincount; /* inode pin count */
262 wait_queue_head_t i_ipin_wait; /* inode pinning wait queue */
264 struct xfs_inode **i_refcache; /* ptr to entry in ref cache */
265 struct xfs_inode *i_release; /* inode to unref */
268 xfs_iocore_t i_iocore; /* I/O core */
270 /* Miscellaneous state. */
271 unsigned short i_flags; /* see defined flags below */
272 unsigned char i_update_core; /* timestamps/size is dirty */
273 unsigned char i_update_size; /* di_size field is dirty */
274 unsigned int i_gen; /* generation count */
275 unsigned int i_delayed_blks; /* count of delay alloc blks */
277 xfs_dinode_core_t i_d; /* most of ondisk inode */
278 xfs_chashlist_t *i_chash; /* cluster hash list header */
279 struct xfs_inode *i_cnext; /* cluster hash link forward */
280 struct xfs_inode *i_cprev; /* cluster hash link backward */
282 /* Trace buffers per inode. */
283 #ifdef XFS_BMAP_TRACE
284 struct ktrace *i_xtrace; /* inode extent list trace */
286 #ifdef XFS_BMBT_TRACE
287 struct ktrace *i_btrace; /* inode bmap btree trace */
290 struct ktrace *i_rwtrace; /* inode read/write trace */
292 #ifdef XFS_ILOCK_TRACE
293 struct ktrace *i_lock_trace; /* inode lock/unlock trace */
295 #ifdef XFS_DIR2_TRACE
296 struct ktrace *i_dir_trace; /* inode directory trace */
300 #endif /* __KERNEL__ */
306 #define XFS_IFORK_PTR(ip,w) \
307 ((w) == XFS_DATA_FORK ? &(ip)->i_df : (ip)->i_afp)
308 #define XFS_IFORK_Q(ip) XFS_CFORK_Q(&(ip)->i_d)
309 #define XFS_IFORK_DSIZE(ip) XFS_CFORK_DSIZE(&ip->i_d, ip->i_mount)
310 #define XFS_IFORK_ASIZE(ip) XFS_CFORK_ASIZE(&ip->i_d, ip->i_mount)
311 #define XFS_IFORK_SIZE(ip,w) XFS_CFORK_SIZE(&ip->i_d, ip->i_mount, w)
312 #define XFS_IFORK_FORMAT(ip,w) XFS_CFORK_FORMAT(&ip->i_d, w)
313 #define XFS_IFORK_FMT_SET(ip,w,n) XFS_CFORK_FMT_SET(&ip->i_d, w, n)
314 #define XFS_IFORK_NEXTENTS(ip,w) XFS_CFORK_NEXTENTS(&ip->i_d, w)
315 #define XFS_IFORK_NEXT_SET(ip,w,n) XFS_CFORK_NEXT_SET(&ip->i_d, w, n)
321 * In-core inode flags.
323 #define XFS_IGRIO 0x0001 /* inode used for guaranteed rate i/o */
324 #define XFS_IUIOSZ 0x0002 /* inode i/o sizes have been explicitly set */
325 #define XFS_IQUIESCE 0x0004 /* we have started quiescing for this inode */
326 #define XFS_IRECLAIM 0x0008 /* we have started reclaiming this inode */
327 #define XFS_ISTALE 0x0010 /* inode has been staled */
328 #define XFS_IRECLAIMABLE 0x0020 /* inode can be reclaimed */
329 #define XFS_INEW 0x0040
332 * Flags for inode locking.
334 #define XFS_IOLOCK_EXCL 0x001
335 #define XFS_IOLOCK_SHARED 0x002
336 #define XFS_ILOCK_EXCL 0x004
337 #define XFS_ILOCK_SHARED 0x008
338 #define XFS_IUNLOCK_NONOTIFY 0x010
339 /* XFS_IOLOCK_NESTED 0x020 */
340 #define XFS_EXTENT_TOKEN_RD 0x040
341 #define XFS_SIZE_TOKEN_RD 0x080
342 #define XFS_EXTSIZE_RD (XFS_EXTENT_TOKEN_RD|XFS_SIZE_TOKEN_RD)
343 #define XFS_WILLLEND 0x100 /* Always acquire tokens for lending */
344 #define XFS_EXTENT_TOKEN_WR (XFS_EXTENT_TOKEN_RD | XFS_WILLLEND)
345 #define XFS_SIZE_TOKEN_WR (XFS_SIZE_TOKEN_RD | XFS_WILLLEND)
346 #define XFS_EXTSIZE_WR (XFS_EXTSIZE_RD | XFS_WILLLEND)
347 /* XFS_SIZE_TOKEN_WANT 0x200 */
349 #define XFS_LOCK_MASK \
350 (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL | \
351 XFS_ILOCK_SHARED | XFS_EXTENT_TOKEN_RD | XFS_SIZE_TOKEN_RD | \
355 * Flags for xfs_iflush()
357 #define XFS_IFLUSH_DELWRI_ELSE_SYNC 1
358 #define XFS_IFLUSH_DELWRI_ELSE_ASYNC 2
359 #define XFS_IFLUSH_SYNC 3
360 #define XFS_IFLUSH_ASYNC 4
361 #define XFS_IFLUSH_DELWRI 5
364 * Flags for xfs_itruncate_start().
366 #define XFS_ITRUNC_DEFINITE 0x1
367 #define XFS_ITRUNC_MAYBE 0x2
369 #define XFS_ITOV(ip) BHV_TO_VNODE(XFS_ITOBHV(ip))
370 #define XFS_ITOV_NULL(ip) BHV_TO_VNODE_NULL(XFS_ITOBHV(ip))
371 #define XFS_ITOBHV(ip) ((struct bhv_desc *)(&((ip)->i_bhv_desc)))
372 #define XFS_BHVTOI(bhvp) ((xfs_inode_t *)((char *)(bhvp) - \
373 (char *)&(((xfs_inode_t *)0)->i_bhv_desc)))
374 #define BHV_IS_XFS(bdp) (BHV_OPS(bdp) == &xfs_vnodeops)
377 * For multiple groups support: if S_ISGID bit is set in the parent
378 * directory, group of new file is set to that of the parent, and
379 * new subdirectory gets S_ISGID bit from parent.
381 #define XFS_INHERIT_GID(pip, vfsp) \
382 (((vfsp)->vfs_flag & VFS_GRPID) || ((pip)->i_d.di_mode & S_ISGID))
385 * xfs_iget.c prototypes.
388 #define IGET_CREATE 1
390 void xfs_ihash_init(struct xfs_mount *);
391 void xfs_ihash_free(struct xfs_mount *);
392 void xfs_chash_init(struct xfs_mount *);
393 void xfs_chash_free(struct xfs_mount *);
394 xfs_inode_t *xfs_inode_incore(struct xfs_mount *, xfs_ino_t,
396 void xfs_inode_lock_init(xfs_inode_t *, struct vnode *);
397 int xfs_iget(struct xfs_mount *, struct xfs_trans *, xfs_ino_t,
398 uint, uint, xfs_inode_t **, xfs_daddr_t);
399 void xfs_iput(xfs_inode_t *, uint);
400 void xfs_iput_new(xfs_inode_t *, uint);
401 void xfs_ilock(xfs_inode_t *, uint);
402 int xfs_ilock_nowait(xfs_inode_t *, uint);
403 void xfs_iunlock(xfs_inode_t *, uint);
404 void xfs_ilock_demote(xfs_inode_t *, uint);
405 void xfs_iflock(xfs_inode_t *);
406 int xfs_iflock_nowait(xfs_inode_t *);
407 uint xfs_ilock_map_shared(xfs_inode_t *);
408 void xfs_iunlock_map_shared(xfs_inode_t *, uint);
409 void xfs_ifunlock(xfs_inode_t *);
410 void xfs_ireclaim(xfs_inode_t *);
411 int xfs_finish_reclaim(xfs_inode_t *, int, int);
412 int xfs_finish_reclaim_all(struct xfs_mount *, int);
415 * xfs_inode.c prototypes.
417 int xfs_itobp(struct xfs_mount *, struct xfs_trans *,
418 xfs_inode_t *, xfs_dinode_t **, struct xfs_buf **,
420 int xfs_iread(struct xfs_mount *, struct xfs_trans *, xfs_ino_t,
421 xfs_inode_t **, xfs_daddr_t);
422 int xfs_iread_extents(struct xfs_trans *, xfs_inode_t *, int);
423 int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, mode_t,
424 xfs_nlink_t, xfs_dev_t, struct cred *, xfs_prid_t,
425 int, struct xfs_buf **, boolean_t *, xfs_inode_t **);
426 void xfs_xlate_dinode_core(xfs_caddr_t, struct xfs_dinode_core *,
428 uint xfs_ip2xflags(struct xfs_inode *);
429 uint xfs_dic2xflags(struct xfs_dinode_core *);
430 int xfs_ifree(struct xfs_trans *, xfs_inode_t *,
431 struct xfs_bmap_free *);
432 void xfs_itruncate_start(xfs_inode_t *, uint, xfs_fsize_t);
433 int xfs_itruncate_finish(struct xfs_trans **, xfs_inode_t *,
434 xfs_fsize_t, int, int);
435 int xfs_iunlink(struct xfs_trans *, xfs_inode_t *);
436 int xfs_igrow_start(xfs_inode_t *, xfs_fsize_t, struct cred *);
437 void xfs_igrow_finish(struct xfs_trans *, xfs_inode_t *,
440 void xfs_idestroy_fork(xfs_inode_t *, int);
441 void xfs_idestroy(xfs_inode_t *);
442 void xfs_idata_realloc(xfs_inode_t *, int, int);
443 void xfs_iextract(xfs_inode_t *);
444 void xfs_iext_realloc(xfs_inode_t *, int, int);
445 void xfs_iroot_realloc(xfs_inode_t *, int, int);
446 void xfs_ipin(xfs_inode_t *);
447 void xfs_iunpin(xfs_inode_t *);
448 int xfs_iextents_copy(xfs_inode_t *, xfs_bmbt_rec_t *, int);
449 int xfs_iflush(xfs_inode_t *, uint);
450 void xfs_iflush_all(struct xfs_mount *);
451 int xfs_iaccess(xfs_inode_t *, mode_t, cred_t *);
452 uint xfs_iroundup(uint);
453 void xfs_ichgtime(xfs_inode_t *, int);
454 xfs_fsize_t xfs_file_last_byte(xfs_inode_t *);
455 void xfs_lock_inodes(xfs_inode_t **, int, int, uint);
457 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
460 void xfs_isize_check(struct xfs_mount *, xfs_inode_t *, xfs_fsize_t);
462 #define xfs_isize_check(mp, ip, isize)
466 void xfs_inobp_check(struct xfs_mount *, struct xfs_buf *);
468 #define xfs_inobp_check(mp, bp)
471 extern struct kmem_zone *xfs_chashlist_zone;
472 extern struct kmem_zone *xfs_ifork_zone;
473 extern struct kmem_zone *xfs_inode_zone;
474 extern struct kmem_zone *xfs_ili_zone;
475 extern struct vnodeops xfs_vnodeops;
477 #endif /* __KERNEL__ */
479 #endif /* __XFS_INODE_H__ */