fs/xfs/xfs_inode.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
   4  * All Rights Reserved.
   5  */
   6 #ifndef __XFS_INODE_H__
   7 #define __XFS_INODE_H__
   8
   9 #include "xfs_inode_buf.h"
  10 #include "xfs_inode_fork.h"
  11
  12 /*
  13  * Kernel only inode definitions
  14  */
  15 struct xfs_dinode;
  16 struct xfs_inode;
  17 struct xfs_buf;
  18 struct xfs_bmbt_irec;
  19 struct xfs_inode_log_item;
  20 struct xfs_mount;
  21 struct xfs_trans;
  22 struct xfs_dquot;
  23
  24 typedef struct xfs_inode {
  25         /* Inode linking and identification information. */
  26         struct xfs_mount        *i_mount;       /* fs mount struct ptr */
  27         struct xfs_dquot        *i_udquot;      /* user dquot */
  28         struct xfs_dquot        *i_gdquot;      /* group dquot */
  29         struct xfs_dquot        *i_pdquot;      /* project dquot */
  30
  31         /* Inode location stuff */
  32         xfs_ino_t               i_ino;          /* inode number (agno/agino)*/
  33         struct xfs_imap         i_imap;         /* location for xfs_imap() */
  34
  35         /* Extent information. */
  36         struct xfs_ifork        *i_afp;         /* attribute fork pointer */
  37         struct xfs_ifork        *i_cowfp;       /* copy on write extents */
  38         struct xfs_ifork        i_df;           /* data fork */
  39
  40         /* Transaction and locking information. */
  41         struct xfs_inode_log_item *i_itemp;     /* logging information */
  42         mrlock_t                i_lock;         /* inode lock */
  43         mrlock_t                i_mmaplock;     /* inode mmap IO lock */
  44         atomic_t                i_pincount;     /* inode pin count */
  45
  46         /*
  47          * Bitsets of inode metadata that have been checked and/or are sick.
  48          * Callers must hold i_flags_lock before accessing this field.
  49          */
  50         uint16_t                i_checked;
  51         uint16_t                i_sick;
  52
  53         spinlock_t              i_flags_lock;   /* inode i_flags lock */
  54         /* Miscellaneous state. */
  55         unsigned long           i_flags;        /* see defined flags below */
  56         uint64_t                i_delayed_blks; /* count of delay alloc blks */
  57
  58         struct xfs_icdinode     i_d;            /* most of ondisk inode */
  59
  60         /* VFS inode */
  61         struct inode            i_vnode;        /* embedded VFS inode */
  62
  63         /* pending io completions */
  64         spinlock_t              i_ioend_lock;
  65         struct work_struct      i_ioend_work;
  66         struct list_head        i_ioend_list;
  67 } xfs_inode_t;
  68
  69 /* Convert from vfs inode to xfs inode */
  70 static inline struct xfs_inode *XFS_I(struct inode *inode)
  71 {
  72         return container_of(inode, struct xfs_inode, i_vnode);
  73 }
  74
  75 /* convert from xfs inode to vfs inode */
  76 static inline struct inode *VFS_I(struct xfs_inode *ip)
  77 {
  78         return &ip->i_vnode;
  79 }
  80
  81 /*
  82  * For regular files we only update the on-disk filesize when actually
  83  * writing data back to disk.  Until then only the copy in the VFS inode
  84  * is uptodate.
  85  */
  86 static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
  87 {
  88         if (S_ISREG(VFS_I(ip)->i_mode))
  89                 return i_size_read(VFS_I(ip));
  90         return ip->i_d.di_size;
  91 }
  92
  93 /*
  94  * If this I/O goes past the on-disk inode size update it unless it would
  95  * be past the current in-core inode size.
  96  */
  97 static inline xfs_fsize_t
  98 xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
  99 {
 100         xfs_fsize_t i_size = i_size_read(VFS_I(ip));
 101
 102         if (new_size > i_size || new_size < 0)
 103                 new_size = i_size;
 104         return new_size > ip->i_d.di_size ? new_size : 0;
 105 }
 106
 107 /*
 108  * i_flags helper functions
 109  */
 110 static inline void
 111 __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
 112 {
 113         ip->i_flags |= flags;
 114 }
 115
 116 static inline void
 117 xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
 118 {
 119         spin_lock(&ip->i_flags_lock);
 120         __xfs_iflags_set(ip, flags);
 121         spin_unlock(&ip->i_flags_lock);
 122 }
 123
 124 static inline void
 125 xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
 126 {
 127         spin_lock(&ip->i_flags_lock);
 128         ip->i_flags &= ~flags;
 129         spin_unlock(&ip->i_flags_lock);
 130 }
 131
 132 static inline int
 133 __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
 134 {
 135         return (ip->i_flags & flags);
 136 }
 137
 138 static inline int
 139 xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
 140 {
 141         int ret;
 142         spin_lock(&ip->i_flags_lock);
 143         ret = __xfs_iflags_test(ip, flags);
 144         spin_unlock(&ip->i_flags_lock);
 145         return ret;
 146 }
 147
 148 static inline int
 149 xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
 150 {
 151         int ret;
 152
 153         spin_lock(&ip->i_flags_lock);
 154         ret = ip->i_flags & flags;
 155         if (ret)
 156                 ip->i_flags &= ~flags;
 157         spin_unlock(&ip->i_flags_lock);
 158         return ret;
 159 }
 160
 161 static inline int
 162 xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
 163 {
 164         int ret;
 165
 166         spin_lock(&ip->i_flags_lock);
 167         ret = ip->i_flags & flags;
 168         if (!ret)
 169                 ip->i_flags |= flags;
 170         spin_unlock(&ip->i_flags_lock);
 171         return ret;
 172 }
 173
 174 static inline prid_t
 175 xfs_get_initial_prid(struct xfs_inode *dp)
 176 {
 177         if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
 178                 return dp->i_d.di_projid;
 179
 180         return XFS_PROJID_DEFAULT;
 181 }
 182
 183 static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
 184 {
 185         return ip->i_d.di_flags2 & XFS_DIFLAG2_REFLINK;
 186 }
 187
 188 /*
 189  * Check if an inode has any data in the COW fork.  This might be often false
 190  * even for inodes with the reflink flag when there is no pending COW operation.
 191  */
 192 static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
 193 {
 194         return ip->i_cowfp && ip->i_cowfp->if_bytes;
 195 }
 196
 197 /*
 198  * Return the buftarg used for data allocations on a given inode.
 199  */
 200 #define xfs_inode_buftarg(ip) \
 201         (XFS_IS_REALTIME_INODE(ip) ? \
 202                 (ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)
 203
 204 /*
 205  * In-core inode flags.
 206  */
 207 #define XFS_IRECLAIM            (1 << 0) /* started reclaiming this inode */
 208 #define XFS_ISTALE              (1 << 1) /* inode has been staled */
 209 #define XFS_IRECLAIMABLE        (1 << 2) /* inode can be reclaimed */
 210 #define __XFS_INEW_BIT          3        /* inode has just been allocated */
 211 #define XFS_INEW                (1 << __XFS_INEW_BIT)
 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_IFLUSHING           (1 << 7) /* inode is being flushed */
 215 #define __XFS_IPINNED_BIT       8        /* wakeup key for zero pin count */
 216 #define XFS_IPINNED             (1 << __XFS_IPINNED_BIT)
 217 #define XFS_IEOFBLOCKS          (1 << 9) /* has the preallocblocks tag set */
 218 /*
 219  * If this unlinked inode is in the middle of recovery, don't let drop_inode
 220  * truncate and free the inode.  This can happen if we iget the inode during
 221  * log recovery to replay a bmap operation on the inode.
 222  */
 223 #define XFS_IRECOVERY           (1 << 11)
 224 #define XFS_ICOWBLOCKS          (1 << 12)/* has the cowblocks tag set */
 225
 226 /*
 227  * Per-lifetime flags need to be reset when re-using a reclaimable inode during
 228  * inode lookup. This prevents unintended behaviour on the new inode from
 229  * ocurring.
 230  */
 231 #define XFS_IRECLAIM_RESET_FLAGS        \
 232         (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
 233          XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
 234
 235 /*
 236  * Flags for inode locking.
 237  * Bit ranges:  1<<1  - 1<<16-1 -- iolock/ilock modes (bitfield)
 238  *              1<<16 - 1<<32-1 -- lockdep annotation (integers)
 239  */
 240 #define XFS_IOLOCK_EXCL         (1<<0)
 241 #define XFS_IOLOCK_SHARED       (1<<1)
 242 #define XFS_ILOCK_EXCL          (1<<2)
 243 #define XFS_ILOCK_SHARED        (1<<3)
 244 #define XFS_MMAPLOCK_EXCL       (1<<4)
 245 #define XFS_MMAPLOCK_SHARED     (1<<5)
 246
 247 #define XFS_LOCK_MASK           (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
 248                                 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
 249                                 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
 250
 251 #define XFS_LOCK_FLAGS \
 252         { XFS_IOLOCK_EXCL,      "IOLOCK_EXCL" }, \
 253         { XFS_IOLOCK_SHARED,    "IOLOCK_SHARED" }, \
 254         { XFS_ILOCK_EXCL,       "ILOCK_EXCL" }, \
 255         { XFS_ILOCK_SHARED,     "ILOCK_SHARED" }, \
 256         { XFS_MMAPLOCK_EXCL,    "MMAPLOCK_EXCL" }, \
 257         { XFS_MMAPLOCK_SHARED,  "MMAPLOCK_SHARED" }
 258
 259
 260 /*
 261  * Flags for lockdep annotations.
 262  *
 263  * XFS_LOCK_PARENT - for directory operations that require locking a
 264  * parent directory inode and a child entry inode. IOLOCK requires nesting,
 265  * MMAPLOCK does not support this class, ILOCK requires a single subclass
 266  * to differentiate parent from child.
 267  *
 268  * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
 269  * inodes do not participate in the normal lock order, and thus have their
 270  * own subclasses.
 271  *
 272  * XFS_LOCK_INUMORDER - for locking several inodes at the some time
 273  * with xfs_lock_inodes().  This flag is used as the starting subclass
 274  * and each subsequent lock acquired will increment the subclass by one.
 275  * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
 276  * limited to the subclasses we can represent via nesting. We need at least
 277  * 5 inodes nest depth for the ILOCK through rename, and we also have to support
 278  * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
 279  * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
 280  * 8 subclasses supported by lockdep.
 281  *
 282  * This also means we have to number the sub-classes in the lowest bits of
 283  * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
 284  * mask and we can't use bit-masking to build the subclasses. What a mess.
 285  *
 286  * Bit layout:
 287  *
 288  * Bit          Lock Region
 289  * 16-19        XFS_IOLOCK_SHIFT dependencies
 290  * 20-23        XFS_MMAPLOCK_SHIFT dependencies
 291  * 24-31        XFS_ILOCK_SHIFT dependencies
 292  *
 293  * IOLOCK values
 294  *
 295  * 0-3          subclass value
 296  * 4-7          unused
 297  *
 298  * MMAPLOCK values
 299  *
 300  * 0-3          subclass value
 301  * 4-7          unused
 302  *
 303  * ILOCK values
 304  * 0-4          subclass values
 305  * 5            PARENT subclass (not nestable)
 306  * 6            RTBITMAP subclass (not nestable)
 307  * 7            RTSUM subclass (not nestable)
 308  *
 309  */
 310 #define XFS_IOLOCK_SHIFT                16
 311 #define XFS_IOLOCK_MAX_SUBCLASS         3
 312 #define XFS_IOLOCK_DEP_MASK             0x000f0000
 313
 314 #define XFS_MMAPLOCK_SHIFT              20
 315 #define XFS_MMAPLOCK_NUMORDER           0
 316 #define XFS_MMAPLOCK_MAX_SUBCLASS       3
 317 #define XFS_MMAPLOCK_DEP_MASK           0x00f00000
 318
 319 #define XFS_ILOCK_SHIFT                 24
 320 #define XFS_ILOCK_PARENT_VAL            5
 321 #define XFS_ILOCK_MAX_SUBCLASS          (XFS_ILOCK_PARENT_VAL - 1)
 322 #define XFS_ILOCK_RTBITMAP_VAL          6
 323 #define XFS_ILOCK_RTSUM_VAL             7
 324 #define XFS_ILOCK_DEP_MASK              0xff000000
 325 #define XFS_ILOCK_PARENT                (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
 326 #define XFS_ILOCK_RTBITMAP              (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
 327 #define XFS_ILOCK_RTSUM                 (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
 328
 329 #define XFS_LOCK_SUBCLASS_MASK  (XFS_IOLOCK_DEP_MASK | \
 330                                  XFS_MMAPLOCK_DEP_MASK | \
 331                                  XFS_ILOCK_DEP_MASK)
 332
 333 #define XFS_IOLOCK_DEP(flags)   (((flags) & XFS_IOLOCK_DEP_MASK) \
 334                                         >> XFS_IOLOCK_SHIFT)
 335 #define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
 336                                         >> XFS_MMAPLOCK_SHIFT)
 337 #define XFS_ILOCK_DEP(flags)    (((flags) & XFS_ILOCK_DEP_MASK) \
 338                                         >> XFS_ILOCK_SHIFT)
 339
 340 /*
 341  * Layouts are broken in the BREAK_WRITE case to ensure that
 342  * layout-holders do not collide with local writes. Additionally,
 343  * layouts are broken in the BREAK_UNMAP case to make sure the
 344  * layout-holder has a consistent view of the file's extent map. While
 345  * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
 346  * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
 347  * go idle.
 348  */
 349 enum layout_break_reason {
 350         BREAK_WRITE,
 351         BREAK_UNMAP,
 352 };
 353
 354 /*
 355  * For multiple groups support: if S_ISGID bit is set in the parent
 356  * directory, group of new file is set to that of the parent, and
 357  * new subdirectory gets S_ISGID bit from parent.
 358  */
 359 #define XFS_INHERIT_GID(pip)    \
 360         (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
 361          (VFS_I(pip)->i_mode & S_ISGID))
 362
 363 int             xfs_release(struct xfs_inode *ip);
 364 void            xfs_inactive(struct xfs_inode *ip);
 365 int             xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
 366                            struct xfs_inode **ipp, struct xfs_name *ci_name);
 367 int             xfs_create(struct xfs_inode *dp, struct xfs_name *name,
 368                            umode_t mode, dev_t rdev, struct xfs_inode **ipp);
 369 int             xfs_create_tmpfile(struct xfs_inode *dp, umode_t mode,
 370                            struct xfs_inode **ipp);
 371 int             xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
 372                            struct xfs_inode *ip);
 373 int             xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
 374                          struct xfs_name *target_name);
 375 int             xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
 376                            struct xfs_inode *src_ip, struct xfs_inode *target_dp,
 377                            struct xfs_name *target_name,
 378                            struct xfs_inode *target_ip, unsigned int flags);
 379
 380 void            xfs_ilock(xfs_inode_t *, uint);
 381 int             xfs_ilock_nowait(xfs_inode_t *, uint);
 382 void            xfs_iunlock(xfs_inode_t *, uint);
 383 void            xfs_ilock_demote(xfs_inode_t *, uint);
 384 int             xfs_isilocked(xfs_inode_t *, uint);
 385 uint            xfs_ilock_data_map_shared(struct xfs_inode *);
 386 uint            xfs_ilock_attr_map_shared(struct xfs_inode *);
 387
 388 uint            xfs_ip2xflags(struct xfs_inode *);
 389 int             xfs_ifree(struct xfs_trans *, struct xfs_inode *);
 390 int             xfs_itruncate_extents_flags(struct xfs_trans **,
 391                                 struct xfs_inode *, int, xfs_fsize_t, int);
 392 void            xfs_iext_realloc(xfs_inode_t *, int, int);
 393
 394 int             xfs_log_force_inode(struct xfs_inode *ip);
 395 void            xfs_iunpin_wait(xfs_inode_t *);
 396 #define xfs_ipincount(ip)       ((unsigned int) atomic_read(&ip->i_pincount))
 397
 398 int             xfs_iflush_cluster(struct xfs_buf *);
 399 void            xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
 400                                 struct xfs_inode *ip1, uint ip1_mode);
 401
 402 xfs_extlen_t    xfs_get_extsz_hint(struct xfs_inode *ip);
 403 xfs_extlen_t    xfs_get_cowextsz_hint(struct xfs_inode *ip);
 404
 405 int             xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
 406                                xfs_nlink_t, dev_t, prid_t,
 407                                struct xfs_inode **);
 408
 409 static inline int
 410 xfs_itruncate_extents(
 411         struct xfs_trans        **tpp,
 412         struct xfs_inode        *ip,
 413         int                     whichfork,
 414         xfs_fsize_t             new_size)
 415 {
 416         return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
 417 }
 418
 419 /* from xfs_file.c */
 420 enum xfs_prealloc_flags {
 421         XFS_PREALLOC_SET        = (1 << 1),
 422         XFS_PREALLOC_CLEAR      = (1 << 2),
 423         XFS_PREALLOC_SYNC       = (1 << 3),
 424         XFS_PREALLOC_INVISIBLE  = (1 << 4),
 425 };
 426
 427 int     xfs_update_prealloc_flags(struct xfs_inode *ip,
 428                                   enum xfs_prealloc_flags flags);
 429 int     xfs_break_layouts(struct inode *inode, uint *iolock,
 430                 enum layout_break_reason reason);
 431
 432 /* from xfs_iops.c */
 433 extern void xfs_setup_inode(struct xfs_inode *ip);
 434 extern void xfs_setup_iops(struct xfs_inode *ip);
 435 extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);
 436
 437 /*
 438  * When setting up a newly allocated inode, we need to call
 439  * xfs_finish_inode_setup() once the inode is fully instantiated at
 440  * the VFS level to prevent the rest of the world seeing the inode
 441  * before we've completed instantiation. Otherwise we can do it
 442  * the moment the inode lookup is complete.
 443  */
 444 static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
 445 {
 446         xfs_iflags_clear(ip, XFS_INEW);
 447         barrier();
 448         unlock_new_inode(VFS_I(ip));
 449         wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
 450 }
 451
 452 static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
 453 {
 454         xfs_setup_inode(ip);
 455         xfs_setup_iops(ip);
 456         xfs_finish_inode_setup(ip);
 457 }
 458
 459 void xfs_irele(struct xfs_inode *ip);
 460
 461 extern struct kmem_zone *xfs_inode_zone;
 462
 463 /* The default CoW extent size hint. */
 464 #define XFS_DEFAULT_COWEXTSZ_HINT 32
 465
 466 int xfs_iunlink_init(struct xfs_perag *pag);
 467 void xfs_iunlink_destroy(struct xfs_perag *pag);
 468
 469 void xfs_end_io(struct work_struct *work);
 470
 471 int xfs_ilock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
 472 void xfs_iunlock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
 473
 474 #endif  /* __XFS_INODE_H__ */