LXR linux/fs/xfs/xfs

   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_defer_ops;
  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_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 */
  76static 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 */
  82static 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 */
  92static 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 */
 103static inline xfs_fsize_t
 104xfs_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 */
 116static inline void
 117__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
 118{
 119        ip->i_flags |= flags;
 120}
 121
 122static inline void
 123xfs_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
 130static inline void
 131xfs_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
 138static inline int
 139__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
 140{
 141        return (ip->i_flags & flags);
 142}
 143
 144static inline int
 145xfs_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
 154static inline int
 155xfs_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
 167static inline int
 168xfs_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 */
 185static inline prid_t
 186xfs_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
 191static inline void
 192xfs_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
 199static inline prid_t
 200xfs_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
 208static 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#define XFS_ICOWBLOCKS          (1 << 12)/* has the cowblocks tag set */
 236
 237/*
 238 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
 239 * inode lookup. This prevents unintended behaviour on the new inode from
 240 * ocurring.
 241 */
 242#define XFS_IRECLAIM_RESET_FLAGS        \
 243        (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
 244         XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
 245
 246/*
 247 * Synchronize processes attempting to flush the in-core inode back to disk.
 248 */
 249
 250static inline int xfs_isiflocked(struct xfs_inode *ip)
 251{
 252        return xfs_iflags_test(ip, XFS_IFLOCK);
 253}
 254
 255extern void __xfs_iflock(struct xfs_inode *ip);
 256
 257static inline int xfs_iflock_nowait(struct xfs_inode *ip)
 258{
 259        return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
 260}
 261
 262static inline void xfs_iflock(struct xfs_inode *ip)
 263{
 264        if (!xfs_iflock_nowait(ip))
 265                __xfs_iflock(ip);
 266}
 267
 268static inline void xfs_ifunlock(struct xfs_inode *ip)
 269{
 270        ASSERT(xfs_isiflocked(ip));
 271        xfs_iflags_clear(ip, XFS_IFLOCK);
 272        smp_mb();
 273        wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
 274}
 275
 276/*
 277 * Flags for inode locking.
 278 * Bit ranges:  1<<1  - 1<<16-1 -- iolock/ilock modes (bitfield)
 279 *              1<<16 - 1<<32-1 -- lockdep annotation (integers)
 280 */
 281#define XFS_IOLOCK_EXCL         (1<<0)
 282#define XFS_IOLOCK_SHARED       (1<<1)
 283#define XFS_ILOCK_EXCL          (1<<2)
 284#define XFS_ILOCK_SHARED        (1<<3)
 285#define XFS_MMAPLOCK_EXCL       (1<<4)
 286#define XFS_MMAPLOCK_SHARED     (1<<5)
 287
 288#define XFS_LOCK_MASK           (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
 289                                | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
 290                                | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
 291
 292#define XFS_LOCK_FLAGS \
 293        { XFS_IOLOCK_EXCL,      "IOLOCK_EXCL" }, \
 294        { XFS_IOLOCK_SHARED,    "IOLOCK_SHARED" }, \
 295        { XFS_ILOCK_EXCL,       "ILOCK_EXCL" }, \
 296        { XFS_ILOCK_SHARED,     "ILOCK_SHARED" }, \
 297        { XFS_MMAPLOCK_EXCL,    "MMAPLOCK_EXCL" }, \
 298        { XFS_MMAPLOCK_SHARED,  "MMAPLOCK_SHARED" }
 299
 300
 301/*
 302 * Flags for lockdep annotations.
 303 *
 304 * XFS_LOCK_PARENT - for directory operations that require locking a
 305 * parent directory inode and a child entry inode. IOLOCK requires nesting,
 306 * MMAPLOCK does not support this class, ILOCK requires a single subclass
 307 * to differentiate parent from child.
 308 *
 309 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
 310 * inodes do not participate in the normal lock order, and thus have their
 311 * own subclasses.
 312 *
 313 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
 314 * with xfs_lock_inodes().  This flag is used as the starting subclass
 315 * and each subsequent lock acquired will increment the subclass by one.
 316 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
 317 * limited to the subclasses we can represent via nesting. We need at least
 318 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
 319 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
 320 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
 321 * 8 subclasses supported by lockdep.
 322 *
 323 * This also means we have to number the sub-classes in the lowest bits of
 324 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
 325 * mask and we can't use bit-masking to build the subclasses. What a mess.
 326 *
 327 * Bit layout:
 328 *
 329 * Bit          Lock Region
 330 * 16-19        XFS_IOLOCK_SHIFT dependencies
 331 * 20-23        XFS_MMAPLOCK_SHIFT dependencies
 332 * 24-31        XFS_ILOCK_SHIFT dependencies
 333 *
 334 * IOLOCK values
 335 *
 336 * 0-3          subclass value
 337 * 4-7          unused
 338 *
 339 * MMAPLOCK values
 340 *
 341 * 0-3          subclass value
 342 * 4-7          unused
 343 *
 344 * ILOCK values
 345 * 0-4          subclass values
 346 * 5            PARENT subclass (not nestable)
 347 * 6            RTBITMAP subclass (not nestable)
 348 * 7            RTSUM subclass (not nestable)
 349 * 
 350 */
 351#define XFS_IOLOCK_SHIFT                16
 352#define XFS_IOLOCK_MAX_SUBCLASS         3
 353#define XFS_IOLOCK_DEP_MASK             0x000f0000
 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
 390int             xfs_release(struct xfs_inode *ip);
 391void            xfs_inactive(struct xfs_inode *ip);
 392int             xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
 393                           struct xfs_inode **ipp, struct xfs_name *ci_name);
 394int             xfs_create(struct xfs_inode *dp, struct xfs_name *name,
 395                           umode_t mode, dev_t rdev, struct xfs_inode **ipp);
 396int             xfs_create_tmpfile(struct xfs_inode *dp, umode_t mode,
 397                           struct xfs_inode **ipp);
 398int             xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
 399                           struct xfs_inode *ip);
 400int             xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
 401                         struct xfs_name *target_name);
 402int             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
 407void            xfs_ilock(xfs_inode_t *, uint);
 408int             xfs_ilock_nowait(xfs_inode_t *, uint);
 409void            xfs_iunlock(xfs_inode_t *, uint);
 410void            xfs_ilock_demote(xfs_inode_t *, uint);
 411int             xfs_isilocked(xfs_inode_t *, uint);
 412uint            xfs_ilock_data_map_shared(struct xfs_inode *);
 413uint            xfs_ilock_attr_map_shared(struct xfs_inode *);
 414
 415uint            xfs_ip2xflags(struct xfs_inode *);
 416int             xfs_ifree(struct xfs_trans *, xfs_inode_t *,
 417                           struct xfs_defer_ops *);
 418int             xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *,
 419                                      int, xfs_fsize_t);
 420void            xfs_iext_realloc(xfs_inode_t *, int, int);
 421
 422void            xfs_iunpin_wait(xfs_inode_t *);
 423#define xfs_ipincount(ip)       ((unsigned int) atomic_read(&ip->i_pincount))
 424
 425int             xfs_iflush(struct xfs_inode *, struct xfs_buf **);
 426void            xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
 427                                struct xfs_inode *ip1, uint ip1_mode);
 428
 429xfs_extlen_t    xfs_get_extsz_hint(struct xfs_inode *ip);
 430xfs_extlen_t    xfs_get_cowextsz_hint(struct xfs_inode *ip);
 431
 432int             xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
 433                               xfs_nlink_t, dev_t, prid_t,
 434                               struct xfs_inode **);
 435
 436/* from xfs_file.c */
 437enum xfs_prealloc_flags {
 438        XFS_PREALLOC_SET        = (1 << 1),
 439        XFS_PREALLOC_CLEAR      = (1 << 2),
 440        XFS_PREALLOC_SYNC       = (1 << 3),
 441        XFS_PREALLOC_INVISIBLE  = (1 << 4),
 442};
 443
 444int     xfs_update_prealloc_flags(struct xfs_inode *ip,
 445                                  enum xfs_prealloc_flags flags);
 446
 447/* from xfs_iops.c */
 448extern void xfs_setup_inode(struct xfs_inode *ip);
 449extern void xfs_setup_iops(struct xfs_inode *ip);
 450
 451/*
 452 * When setting up a newly allocated inode, we need to call
 453 * xfs_finish_inode_setup() once the inode is fully instantiated at
 454 * the VFS level to prevent the rest of the world seeing the inode
 455 * before we've completed instantiation. Otherwise we can do it
 456 * the moment the inode lookup is complete.
 457 */
 458static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
 459{
 460        xfs_iflags_clear(ip, XFS_INEW);
 461        barrier();
 462        unlock_new_inode(VFS_I(ip));
 463        wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
 464}
 465
 466static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
 467{
 468        xfs_setup_inode(ip);
 469        xfs_setup_iops(ip);
 470        xfs_finish_inode_setup(ip);
 471}
 472
 473#define IHOLD(ip) \
 474do { \
 475        ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
 476        ihold(VFS_I(ip)); \
 477        trace_xfs_ihold(ip, _THIS_IP_); \
 478} while (0)
 479
 480#define IRELE(ip) \
 481do { \
 482        trace_xfs_irele(ip, _THIS_IP_); \
 483        iput(VFS_I(ip)); \
 484} while (0)
 485
 486extern struct kmem_zone *xfs_inode_zone;
 487
 488/* The default CoW extent size hint. */
 489#define XFS_DEFAULT_COWEXTSZ_HINT 32
 490
 491bool xfs_inode_verify_forks(struct xfs_inode *ip);
 492
 493#endif  /* __XFS_INODE_H__ */
 494