fs/xfs/xfs_inode.h

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