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 */ 27 struct xfs_dinode; 28 struct xfs_inode; 29 struct xfs_buf; 30 struct xfs_defer_ops; 31 struct xfs_bmbt_irec; 32 struct xfs_inode_log_item; 33 struct xfs_mount; 34 struct xfs_trans; 35 struct xfs_dquot; 36 37 typedef 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_cowfp; /* copy on write extents */ 51 xfs_ifork_t i_df; /* data fork */ 52 53 /* operations vectors */ 54 const struct xfs_dir_ops *d_ops; /* directory ops vector */ 55 56 /* Transaction and locking information. */ 57 struct xfs_inode_log_item *i_itemp; /* logging information */ 58 mrlock_t i_lock; /* inode 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 struct xfs_icdinode i_d; /* most of ondisk inode */ 67 68 xfs_extnum_t i_cnextents; /* # of extents in cow fork */ 69 unsigned int i_cformat; /* format of cow fork */ 70 71 /* VFS inode */ 72 struct inode i_vnode; /* embedded VFS inode */ 73 } xfs_inode_t; 74 75 /* Convert from vfs inode to xfs inode */ 76 static inline struct xfs_inode *XFS_I(struct inode *inode) 77 { 78 return container_of(inode, struct xfs_inode, i_vnode); 79 } 80 81 /* convert from xfs inode to vfs inode */ 82 static inline struct inode *VFS_I(struct xfs_inode *ip) 83 { 84 return &ip->i_vnode; 85 } 86 87 /* 88 * For regular files we only update the on-disk filesize when actually 89 * writing data back to disk. Until then only the copy in the VFS inode 90 * is uptodate. 91 */ 92 static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip) 93 { 94 if (S_ISREG(VFS_I(ip)->i_mode)) 95 return i_size_read(VFS_I(ip)); 96 return ip->i_d.di_size; 97 } 98 99 /* 100 * If this I/O goes past the on-disk inode size update it unless it would 101 * be past the current in-core inode size. 102 */ 103 static inline xfs_fsize_t 104 xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size) 105 { 106 xfs_fsize_t i_size = i_size_read(VFS_I(ip)); 107 108 if (new_size > i_size || new_size < 0) 109 new_size = i_size; 110 return new_size > ip->i_d.di_size ? new_size : 0; 111 } 112 113 /* 114 * i_flags helper functions 115 */ 116 static inline void 117 __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) 118 { 119 ip->i_flags |= flags; 120 } 121 122 static inline void 123 xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) 124 { 125 spin_lock(&ip->i_flags_lock); 126 __xfs_iflags_set(ip, flags); 127 spin_unlock(&ip->i_flags_lock); 128 } 129 130 static inline void 131 xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags) 132 { 133 spin_lock(&ip->i_flags_lock); 134 ip->i_flags &= ~flags; 135 spin_unlock(&ip->i_flags_lock); 136 } 137 138 static inline int 139 __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) 140 { 141 return (ip->i_flags & flags); 142 } 143 144 static inline int 145 xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) 146 { 147 int ret; 148 spin_lock(&ip->i_flags_lock); 149 ret = __xfs_iflags_test(ip, flags); 150 spin_unlock(&ip->i_flags_lock); 151 return ret; 152 } 153 154 static inline int 155 xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags) 156 { 157 int ret; 158 159 spin_lock(&ip->i_flags_lock); 160 ret = ip->i_flags & flags; 161 if (ret) 162 ip->i_flags &= ~flags; 163 spin_unlock(&ip->i_flags_lock); 164 return ret; 165 } 166 167 static inline int 168 xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags) 169 { 170 int ret; 171 172 spin_lock(&ip->i_flags_lock); 173 ret = ip->i_flags & flags; 174 if (!ret) 175 ip->i_flags |= flags; 176 spin_unlock(&ip->i_flags_lock); 177 return ret; 178 } 179 180 /* 181 * Project quota id helpers (previously projid was 16bit only 182 * and using two 16bit values to hold new 32bit projid was chosen 183 * to retain compatibility with "old" filesystems). 184 */ 185 static inline prid_t 186 xfs_get_projid(struct xfs_inode *ip) 187 { 188 return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo; 189 } 190 191 static inline void 192 xfs_set_projid(struct xfs_inode *ip, 193 prid_t projid) 194 { 195 ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16); 196 ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff); 197 } 198 199 static inline prid_t 200 xfs_get_initial_prid(struct xfs_inode *dp) 201 { 202 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT) 203 return xfs_get_projid(dp); 204 205 return XFS_PROJID_DEFAULT; 206 } 207 208 static inline bool xfs_is_reflink_inode(struct xfs_inode *ip) 209 { 210 return ip->i_d.di_flags2 & XFS_DIFLAG2_REFLINK; 211 } 212 213 /* 214 * In-core inode flags. 215 */ 216 #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */ 217 #define XFS_ISTALE (1 << 1) /* inode has been staled */ 218 #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */ 219 #define __XFS_INEW_BIT 3 /* inode has just been allocated */ 220 #define XFS_INEW (1 << __XFS_INEW_BIT) 221 #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */ 222 #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */ 223 #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */ 224 #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT) 225 #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */ 226 #define XFS_IPINNED (1 << __XFS_IPINNED_BIT) 227 #define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */ 228 #define XFS_IEOFBLOCKS (1 << 10)/* has the preallocblocks tag set */ 229 /* 230 * If this unlinked inode is in the middle of recovery, don't let drop_inode 231 * truncate and free the inode. This can happen if we iget the inode during 232 * log recovery to replay a bmap operation on the inode. 233 */ 234 #define XFS_IRECOVERY (1 << 11) 235 236 /* 237 * Per-lifetime flags need to be reset when re-using a reclaimable inode during 238 * inode lookup. This prevents unintended behaviour on the new inode from 239 * ocurring. 240 */ 241 #define XFS_IRECLAIM_RESET_FLAGS \ 242 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \ 243 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED) 244 245 /* 246 * Synchronize processes attempting to flush the in-core inode back to disk. 247 */ 248 249 static inline int xfs_isiflocked(struct xfs_inode *ip) 250 { 251 return xfs_iflags_test(ip, XFS_IFLOCK); 252 } 253 254 extern void __xfs_iflock(struct xfs_inode *ip); 255 256 static inline int xfs_iflock_nowait(struct xfs_inode *ip) 257 { 258 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK); 259 } 260 261 static inline void xfs_iflock(struct xfs_inode *ip) 262 { 263 if (!xfs_iflock_nowait(ip)) 264 __xfs_iflock(ip); 265 } 266 267 static inline void xfs_ifunlock(struct xfs_inode *ip) 268 { 269 ASSERT(xfs_isiflocked(ip)); 270 xfs_iflags_clear(ip, XFS_IFLOCK); 271 smp_mb(); 272 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT); 273 } 274 275 /* 276 * Flags for inode locking. 277 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield) 278 * 1<<16 - 1<<32-1 -- lockdep annotation (integers) 279 */ 280 #define XFS_IOLOCK_EXCL (1<<0) 281 #define XFS_IOLOCK_SHARED (1<<1) 282 #define XFS_ILOCK_EXCL (1<<2) 283 #define XFS_ILOCK_SHARED (1<<3) 284 #define XFS_MMAPLOCK_EXCL (1<<4) 285 #define XFS_MMAPLOCK_SHARED (1<<5) 286 287 #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \ 288 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \ 289 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED) 290 291 #define XFS_LOCK_FLAGS \ 292 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \ 293 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \ 294 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \ 295 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \ 296 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \ 297 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" } 298 299 300 /* 301 * Flags for lockdep annotations. 302 * 303 * XFS_LOCK_PARENT - for directory operations that require locking a 304 * parent directory inode and a child entry inode. IOLOCK requires nesting, 305 * MMAPLOCK does not support this class, ILOCK requires a single subclass 306 * to differentiate parent from child. 307 * 308 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary 309 * inodes do not participate in the normal lock order, and thus have their 310 * own subclasses. 311 * 312 * XFS_LOCK_INUMORDER - for locking several inodes at the some time 313 * with xfs_lock_inodes(). This flag is used as the starting subclass 314 * and each subsequent lock acquired will increment the subclass by one. 315 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly 316 * limited to the subclasses we can represent via nesting. We need at least 317 * 5 inodes nest depth for the ILOCK through rename, and we also have to support 318 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP 319 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all 320 * 8 subclasses supported by lockdep. 321 * 322 * This also means we have to number the sub-classes in the lowest bits of 323 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep 324 * mask and we can't use bit-masking to build the subclasses. What a mess. 325 * 326 * Bit layout: 327 * 328 * Bit Lock Region 329 * 16-19 XFS_IOLOCK_SHIFT dependencies 330 * 20-23 XFS_MMAPLOCK_SHIFT dependencies 331 * 24-31 XFS_ILOCK_SHIFT dependencies 332 * 333 * IOLOCK values 334 * 335 * 0-3 subclass value 336 * 4-7 unused 337 * 338 * MMAPLOCK values 339 * 340 * 0-3 subclass value 341 * 4-7 unused 342 * 343 * ILOCK values 344 * 0-4 subclass values 345 * 5 PARENT subclass (not nestable) 346 * 6 RTBITMAP subclass (not nestable) 347 * 7 RTSUM subclass (not nestable) 348 * 349 */ 350 #define XFS_IOLOCK_SHIFT 16 351 #define XFS_IOLOCK_MAX_SUBCLASS 3 352 #define XFS_IOLOCK_DEP_MASK 0x000f0000 353 354 #define XFS_MMAPLOCK_SHIFT 20 355 #define XFS_MMAPLOCK_NUMORDER 0 356 #define XFS_MMAPLOCK_MAX_SUBCLASS 3 357 #define XFS_MMAPLOCK_DEP_MASK 0x00f00000 358 359 #define XFS_ILOCK_SHIFT 24 360 #define XFS_ILOCK_PARENT_VAL 5 361 #define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1) 362 #define XFS_ILOCK_RTBITMAP_VAL 6 363 #define XFS_ILOCK_RTSUM_VAL 7 364 #define XFS_ILOCK_DEP_MASK 0xff000000 365 #define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT) 366 #define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT) 367 #define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT) 368 369 #define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \ 370 XFS_MMAPLOCK_DEP_MASK | \ 371 XFS_ILOCK_DEP_MASK) 372 373 #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \ 374 >> XFS_IOLOCK_SHIFT) 375 #define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \ 376 >> XFS_MMAPLOCK_SHIFT) 377 #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \ 378 >> XFS_ILOCK_SHIFT) 379 380 /* 381 * For multiple groups support: if S_ISGID bit is set in the parent 382 * directory, group of new file is set to that of the parent, and 383 * new subdirectory gets S_ISGID bit from parent. 384 */ 385 #define XFS_INHERIT_GID(pip) \ 386 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \ 387 (VFS_I(pip)->i_mode & S_ISGID)) 388 389 int xfs_release(struct xfs_inode *ip); 390 void xfs_inactive(struct xfs_inode *ip); 391 int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name, 392 struct xfs_inode **ipp, struct xfs_name *ci_name); 393 int xfs_create(struct xfs_inode *dp, struct xfs_name *name, 394 umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp); 395 int xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry, 396 umode_t mode, struct xfs_inode **ipp); 397 int xfs_remove(struct xfs_inode *dp, struct xfs_name *name, 398 struct xfs_inode *ip); 399 int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip, 400 struct xfs_name *target_name); 401 int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name, 402 struct xfs_inode *src_ip, struct xfs_inode *target_dp, 403 struct xfs_name *target_name, 404 struct xfs_inode *target_ip, unsigned int flags); 405 406 void xfs_ilock(xfs_inode_t *, uint); 407 int xfs_ilock_nowait(xfs_inode_t *, uint); 408 void xfs_iunlock(xfs_inode_t *, uint); 409 void xfs_ilock_demote(xfs_inode_t *, uint); 410 int xfs_isilocked(xfs_inode_t *, uint); 411 uint xfs_ilock_data_map_shared(struct xfs_inode *); 412 uint xfs_ilock_attr_map_shared(struct xfs_inode *); 413 414 uint xfs_ip2xflags(struct xfs_inode *); 415 int xfs_ifree(struct xfs_trans *, xfs_inode_t *, 416 struct xfs_defer_ops *); 417 int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *, 418 int, xfs_fsize_t); 419 void xfs_iext_realloc(xfs_inode_t *, int, int); 420 421 void xfs_iunpin_wait(xfs_inode_t *); 422 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount)) 423 424 int xfs_iflush(struct xfs_inode *, struct xfs_buf **); 425 void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint); 426 427 xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip); 428 xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip); 429 430 int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t, 431 xfs_nlink_t, xfs_dev_t, prid_t, int, 432 struct xfs_inode **, int *); 433 434 /* from xfs_file.c */ 435 enum xfs_prealloc_flags { 436 XFS_PREALLOC_SET = (1 << 1), 437 XFS_PREALLOC_CLEAR = (1 << 2), 438 XFS_PREALLOC_SYNC = (1 << 3), 439 XFS_PREALLOC_INVISIBLE = (1 << 4), 440 }; 441 442 int xfs_update_prealloc_flags(struct xfs_inode *ip, 443 enum xfs_prealloc_flags flags); 444 int xfs_zero_eof(struct xfs_inode *ip, xfs_off_t offset, 445 xfs_fsize_t isize, bool *did_zeroing); 446 int xfs_zero_range(struct xfs_inode *ip, xfs_off_t pos, xfs_off_t count, 447 bool *did_zero); 448 loff_t __xfs_seek_hole_data(struct inode *inode, loff_t start, 449 loff_t eof, int whence); 450 451 452 /* from xfs_iops.c */ 453 extern void xfs_setup_inode(struct xfs_inode *ip); 454 extern void xfs_setup_iops(struct xfs_inode *ip); 455 456 /* 457 * When setting up a newly allocated inode, we need to call 458 * xfs_finish_inode_setup() once the inode is fully instantiated at 459 * the VFS level to prevent the rest of the world seeing the inode 460 * before we've completed instantiation. Otherwise we can do it 461 * the moment the inode lookup is complete. 462 */ 463 static inline void xfs_finish_inode_setup(struct xfs_inode *ip) 464 { 465 xfs_iflags_clear(ip, XFS_INEW); 466 barrier(); 467 unlock_new_inode(VFS_I(ip)); 468 wake_up_bit(&ip->i_flags, __XFS_INEW_BIT); 469 } 470 471 static inline void xfs_setup_existing_inode(struct xfs_inode *ip) 472 { 473 xfs_setup_inode(ip); 474 xfs_setup_iops(ip); 475 xfs_finish_inode_setup(ip); 476 } 477 478 #define IHOLD(ip) \ 479 do { \ 480 ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \ 481 ihold(VFS_I(ip)); \ 482 trace_xfs_ihold(ip, _THIS_IP_); \ 483 } while (0) 484 485 #define IRELE(ip) \ 486 do { \ 487 trace_xfs_irele(ip, _THIS_IP_); \ 488 iput(VFS_I(ip)); \ 489 } while (0) 490 491 extern struct kmem_zone *xfs_inode_zone; 492 493 /* The default CoW extent size hint. */ 494 #define XFS_DEFAULT_COWEXTSZ_HINT 32 495 496 #endif /* __XFS_INODE_H__ */ 497