1/* 2 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc. 3 * All Rights Reserved. 4 * 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. 8 * 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. 13 * 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 17 */ 18#ifndef __XFS_INODE_H__ 19#define __XFS_INODE_H__ 20 21#include "xfs_inode_buf.h" 22#include "xfs_inode_fork.h" 23 24/* 25 * Kernel only inode definitions 26 */ 27struct xfs_dinode; 28struct xfs_inode; 29struct xfs_buf; 30struct xfs_bmap_free; 31struct xfs_bmbt_irec; 32struct xfs_inode_log_item; 33struct xfs_mount; 34struct xfs_trans; 35struct xfs_dquot; 36 37typedef struct xfs_inode { 38 /* Inode linking and identification information. */ 39 struct xfs_mount *i_mount; /* fs mount struct ptr */ 40 struct xfs_dquot *i_udquot; /* user dquot */ 41 struct xfs_dquot *i_gdquot; /* group dquot */ 42 struct xfs_dquot *i_pdquot; /* project dquot */ 43 44 /* Inode location stuff */ 45 xfs_ino_t i_ino; /* inode number (agno/agino)*/ 46 struct xfs_imap i_imap; /* location for xfs_imap() */ 47 48 /* Extent information. */ 49 xfs_ifork_t *i_afp; /* attribute fork pointer */ 50 xfs_ifork_t i_df; /* data fork */ 51 52 /* operations vectors */ 53 const struct xfs_dir_ops *d_ops; /* directory ops vector */ 54 55 /* Transaction and locking information. */ 56 struct xfs_inode_log_item *i_itemp; /* logging information */ 57 mrlock_t i_lock; /* inode lock */ 58 mrlock_t i_iolock; /* inode IO lock */ 59 mrlock_t i_mmaplock; /* inode mmap IO lock */ 60 atomic_t i_pincount; /* inode pin count */ 61 spinlock_t i_flags_lock; /* inode i_flags lock */ 62 /* Miscellaneous state. */ 63 unsigned long i_flags; /* see defined flags below */ 64 unsigned int i_delayed_blks; /* count of delay alloc blks */ 65 66 xfs_icdinode_t i_d; /* most of ondisk inode */ 67 68 /* VFS inode */ 69 struct inode i_vnode; /* embedded VFS inode */ 70} xfs_inode_t; 71 72/* Convert from vfs inode to xfs inode */ 73static inline struct xfs_inode *XFS_I(struct inode *inode) 74{ 75 return container_of(inode, struct xfs_inode, i_vnode); 76} 77 78/* convert from xfs inode to vfs inode */ 79static inline struct inode *VFS_I(struct xfs_inode *ip) 80{ 81 return &ip->i_vnode; 82} 83 84/* 85 * For regular files we only update the on-disk filesize when actually 86 * writing data back to disk. Until then only the copy in the VFS inode 87 * is uptodate. 88 */ 89static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip) 90{ 91 if (S_ISREG(ip->i_d.di_mode)) 92 return i_size_read(VFS_I(ip)); 93 return ip->i_d.di_size; 94} 95 96/* 97 * If this I/O goes past the on-disk inode size update it unless it would 98 * be past the current in-core inode size. 99 */ 100static inline xfs_fsize_t 101xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size) 102{ 103 xfs_fsize_t i_size = i_size_read(VFS_I(ip)); 104 105 if (new_size > i_size || new_size < 0) 106 new_size = i_size; 107 return new_size > ip->i_d.di_size ? new_size : 0; 108} 109 110/* 111 * i_flags helper functions 112 */ 113static inline void 114__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) 115{ 116 ip->i_flags |= flags; 117} 118 119static inline void 120xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) 121{ 122 spin_lock(&ip->i_flags_lock); 123 __xfs_iflags_set(ip, flags); 124 spin_unlock(&ip->i_flags_lock); 125} 126 127static inline void 128xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags) 129{ 130 spin_lock(&ip->i_flags_lock); 131 ip->i_flags &= ~flags; 132 spin_unlock(&ip->i_flags_lock); 133} 134 135static inline int 136__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) 137{ 138 return (ip->i_flags & flags); 139} 140 141static inline int 142xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) 143{ 144 int ret; 145 spin_lock(&ip->i_flags_lock); 146 ret = __xfs_iflags_test(ip, flags); 147 spin_unlock(&ip->i_flags_lock); 148 return ret; 149} 150 151static inline int 152xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags) 153{ 154 int ret; 155 156 spin_lock(&ip->i_flags_lock); 157 ret = ip->i_flags & flags; 158 if (ret) 159 ip->i_flags &= ~flags; 160 spin_unlock(&ip->i_flags_lock); 161 return ret; 162} 163 164static inline int 165xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags) 166{ 167 int ret; 168 169 spin_lock(&ip->i_flags_lock); 170 ret = ip->i_flags & flags; 171 if (!ret) 172 ip->i_flags |= flags; 173 spin_unlock(&ip->i_flags_lock); 174 return ret; 175} 176 177/* 178 * Project quota id helpers (previously projid was 16bit only 179 * and using two 16bit values to hold new 32bit projid was chosen 180 * to retain compatibility with "old" filesystems). 181 */ 182static inline prid_t 183xfs_get_projid(struct xfs_inode *ip) 184{ 185 return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo; 186} 187 188static inline void 189xfs_set_projid(struct xfs_inode *ip, 190 prid_t projid) 191{ 192 ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16); 193 ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff); 194} 195 196static inline prid_t 197xfs_get_initial_prid(struct xfs_inode *dp) 198{ 199 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT) 200 return xfs_get_projid(dp); 201 202 return XFS_PROJID_DEFAULT; 203} 204 205/* 206 * In-core inode flags. 207 */ 208#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */ 209#define XFS_ISTALE (1 << 1) /* inode has been staled */ 210#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */ 211#define XFS_INEW (1 << 3) /* inode has just been allocated */ 212#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */ 213#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */ 214#define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */ 215#define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT) 216#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */ 217#define XFS_IPINNED (1 << __XFS_IPINNED_BIT) 218#define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */ 219 220/* 221 * Per-lifetime flags need to be reset when re-using a reclaimable inode during 222 * inode lookup. This prevents unintended behaviour on the new inode from 223 * ocurring. 224 */ 225#define XFS_IRECLAIM_RESET_FLAGS \ 226 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \ 227 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED) 228 229/* 230 * Synchronize processes attempting to flush the in-core inode back to disk. 231 */ 232 233extern void __xfs_iflock(struct xfs_inode *ip); 234 235static inline int xfs_iflock_nowait(struct xfs_inode *ip) 236{ 237 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK); 238} 239 240static inline void xfs_iflock(struct xfs_inode *ip) 241{ 242 if (!xfs_iflock_nowait(ip)) 243 __xfs_iflock(ip); 244} 245 246static inline void xfs_ifunlock(struct xfs_inode *ip) 247{ 248 xfs_iflags_clear(ip, XFS_IFLOCK); 249 smp_mb(); 250 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT); 251} 252 253static inline int xfs_isiflocked(struct xfs_inode *ip) 254{ 255 return xfs_iflags_test(ip, XFS_IFLOCK); 256} 257 258/* 259 * Flags for inode locking. 260 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield) 261 * 1<<16 - 1<<32-1 -- lockdep annotation (integers) 262 */ 263#define XFS_IOLOCK_EXCL (1<<0) 264#define XFS_IOLOCK_SHARED (1<<1) 265#define XFS_ILOCK_EXCL (1<<2) 266#define XFS_ILOCK_SHARED (1<<3) 267#define XFS_MMAPLOCK_EXCL (1<<4) 268#define XFS_MMAPLOCK_SHARED (1<<5) 269 270#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \ 271 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \ 272 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED) 273 274#define XFS_LOCK_FLAGS \ 275 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \ 276 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \ 277 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \ 278 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \ 279 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \ 280 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" } 281 282 283/* 284 * Flags for lockdep annotations. 285 * 286 * XFS_LOCK_PARENT - for directory operations that require locking a 287 * parent directory inode and a child entry inode. The parent gets locked 288 * with this flag so it gets a lockdep subclass of 1 and the child entry 289 * lock will have a lockdep subclass of 0. 290 * 291 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary 292 * inodes do not participate in the normal lock order, and thus have their 293 * own subclasses. 294 * 295 * XFS_LOCK_INUMORDER - for locking several inodes at the some time 296 * with xfs_lock_inodes(). This flag is used as the starting subclass 297 * and each subsequent lock acquired will increment the subclass by one. 298 * So the first lock acquired will have a lockdep subclass of 4, the 299 * second lock will have a lockdep subclass of 5, and so on. It is 300 * the responsibility of the class builder to shift this to the correct 301 * portion of the lock_mode lockdep mask. 302 */ 303#define XFS_LOCK_PARENT 1 304#define XFS_LOCK_RTBITMAP 2 305#define XFS_LOCK_RTSUM 3 306#define XFS_LOCK_INUMORDER 4 307 308#define XFS_IOLOCK_SHIFT 16 309#define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT) 310 311#define XFS_MMAPLOCK_SHIFT 20 312 313#define XFS_ILOCK_SHIFT 24 314#define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT) 315#define XFS_ILOCK_RTBITMAP (XFS_LOCK_RTBITMAP << XFS_ILOCK_SHIFT) 316#define XFS_ILOCK_RTSUM (XFS_LOCK_RTSUM << XFS_ILOCK_SHIFT) 317 318#define XFS_IOLOCK_DEP_MASK 0x000f0000 319#define XFS_MMAPLOCK_DEP_MASK 0x00f00000 320#define XFS_ILOCK_DEP_MASK 0xff000000 321#define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | \ 322 XFS_MMAPLOCK_DEP_MASK | \ 323 XFS_ILOCK_DEP_MASK) 324 325#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \ 326 >> XFS_IOLOCK_SHIFT) 327#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \ 328 >> XFS_MMAPLOCK_SHIFT) 329#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \ 330 >> XFS_ILOCK_SHIFT) 331 332/* 333 * For multiple groups support: if S_ISGID bit is set in the parent 334 * directory, group of new file is set to that of the parent, and 335 * new subdirectory gets S_ISGID bit from parent. 336 */ 337#define XFS_INHERIT_GID(pip) \ 338 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \ 339 ((pip)->i_d.di_mode & S_ISGID)) 340 341int xfs_release(struct xfs_inode *ip); 342void xfs_inactive(struct xfs_inode *ip); 343int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name, 344 struct xfs_inode **ipp, struct xfs_name *ci_name); 345int xfs_create(struct xfs_inode *dp, struct xfs_name *name, 346 umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp); 347int xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry, 348 umode_t mode, struct xfs_inode **ipp); 349int xfs_remove(struct xfs_inode *dp, struct xfs_name *name, 350 struct xfs_inode *ip); 351int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip, 352 struct xfs_name *target_name); 353int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name, 354 struct xfs_inode *src_ip, struct xfs_inode *target_dp, 355 struct xfs_name *target_name, 356 struct xfs_inode *target_ip, unsigned int flags); 357 358void xfs_ilock(xfs_inode_t *, uint); 359int xfs_ilock_nowait(xfs_inode_t *, uint); 360void xfs_iunlock(xfs_inode_t *, uint); 361void xfs_ilock_demote(xfs_inode_t *, uint); 362int xfs_isilocked(xfs_inode_t *, uint); 363uint xfs_ilock_data_map_shared(struct xfs_inode *); 364uint xfs_ilock_attr_map_shared(struct xfs_inode *); 365int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, umode_t, 366 xfs_nlink_t, xfs_dev_t, prid_t, int, 367 struct xfs_buf **, xfs_inode_t **); 368 369uint xfs_ip2xflags(struct xfs_inode *); 370uint xfs_dic2xflags(struct xfs_dinode *); 371int xfs_ifree(struct xfs_trans *, xfs_inode_t *, 372 struct xfs_bmap_free *); 373int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *, 374 int, xfs_fsize_t); 375int xfs_iunlink(struct xfs_trans *, xfs_inode_t *); 376 377void xfs_iext_realloc(xfs_inode_t *, int, int); 378 379void xfs_iunpin_wait(xfs_inode_t *); 380#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount)) 381 382int xfs_iflush(struct xfs_inode *, struct xfs_buf **); 383void xfs_lock_inodes(xfs_inode_t **, int, uint); 384void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint); 385 386xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip); 387 388int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t, 389 xfs_nlink_t, xfs_dev_t, prid_t, int, 390 struct xfs_inode **, int *); 391int xfs_droplink(struct xfs_trans *, struct xfs_inode *); 392int xfs_bumplink(struct xfs_trans *, struct xfs_inode *); 393 394/* from xfs_file.c */ 395enum xfs_prealloc_flags { 396 XFS_PREALLOC_SET = (1 << 1), 397 XFS_PREALLOC_CLEAR = (1 << 2), 398 XFS_PREALLOC_SYNC = (1 << 3), 399 XFS_PREALLOC_INVISIBLE = (1 << 4), 400}; 401 402int xfs_update_prealloc_flags(struct xfs_inode *ip, 403 enum xfs_prealloc_flags flags); 404int xfs_zero_eof(struct xfs_inode *ip, xfs_off_t offset, 405 xfs_fsize_t isize, bool *did_zeroing); 406int xfs_iozero(struct xfs_inode *ip, loff_t pos, size_t count); 407 408 409/* from xfs_iops.c */ 410/* 411 * When setting up a newly allocated inode, we need to call 412 * xfs_finish_inode_setup() once the inode is fully instantiated at 413 * the VFS level to prevent the rest of the world seeing the inode 414 * before we've completed instantiation. Otherwise we can do it 415 * the moment the inode lookup is complete. 416 */ 417extern void xfs_setup_inode(struct xfs_inode *ip); 418static inline void xfs_finish_inode_setup(struct xfs_inode *ip) 419{ 420 xfs_iflags_clear(ip, XFS_INEW); 421 barrier(); 422 unlock_new_inode(VFS_I(ip)); 423} 424 425static inline void xfs_setup_existing_inode(struct xfs_inode *ip) 426{ 427 xfs_setup_inode(ip); 428 xfs_finish_inode_setup(ip); 429} 430 431#define IHOLD(ip) \ 432do { \ 433 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \ 434 ihold(VFS_I(ip)); \ 435 trace_xfs_ihold(ip, _THIS_IP_); \ 436} while (0) 437 438#define IRELE(ip) \ 439do { \ 440 trace_xfs_irele(ip, _THIS_IP_); \ 441 iput(VFS_I(ip)); \ 442} while (0) 443 444extern struct kmem_zone *xfs_inode_zone; 445 446/* 447 * Flags for read/write calls 448 */ 449#define XFS_IO_ISDIRECT 0x00001 /* bypass page cache */ 450#define XFS_IO_INVIS 0x00002 /* don't update inode timestamps */ 451 452#define XFS_IO_FLAGS \ 453 { XFS_IO_ISDIRECT, "DIRECT" }, \ 454 { XFS_IO_INVIS, "INVIS"} 455 456#endif /* __XFS_INODE_H__ */ 457