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_bmap_free;
  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_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         atomic_t                i_pincount;     /* inode pin count */
  60         spinlock_t              i_flags_lock;   /* inode i_flags lock */
  61         /* Miscellaneous state. */
  62         unsigned long           i_flags;        /* see defined flags below */
  63         unsigned int            i_delayed_blks; /* count of delay alloc blks */
  64
  65         xfs_icdinode_t          i_d;            /* most of ondisk inode */
  66
  67         /* VFS inode */
  68         struct inode            i_vnode;        /* embedded VFS inode */
  69 } xfs_inode_t;
  70
  71 /* Convert from vfs inode to xfs inode */
  72 static inline struct xfs_inode *XFS_I(struct inode *inode)
  73 {
  74         return container_of(inode, struct xfs_inode, i_vnode);
  75 }
  76
  77 /* convert from xfs inode to vfs inode */
  78 static inline struct inode *VFS_I(struct xfs_inode *ip)
  79 {
  80         return &ip->i_vnode;
  81 }
  82
  83 /*
  84  * For regular files we only update the on-disk filesize when actually
  85  * writing data back to disk.  Until then only the copy in the VFS inode
  86  * is uptodate.
  87  */
  88 static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
  89 {
  90         if (S_ISREG(ip->i_d.di_mode))
  91                 return i_size_read(VFS_I(ip));
  92         return ip->i_d.di_size;
  93 }
  94
  95 /*
  96  * If this I/O goes past the on-disk inode size update it unless it would
  97  * be past the current in-core inode size.
  98  */
  99 static inline xfs_fsize_t
 100 xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
 101 {
 102         xfs_fsize_t i_size = i_size_read(VFS_I(ip));
 103
 104         if (new_size > i_size)
 105                 new_size = i_size;
 106         return new_size > ip->i_d.di_size ? new_size : 0;
 107 }
 108
 109 /*
 110  * i_flags helper functions
 111  */
 112 static inline void
 113 __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
 114 {
 115         ip->i_flags |= flags;
 116 }
 117
 118 static inline void
 119 xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
 120 {
 121         spin_lock(&ip->i_flags_lock);
 122         __xfs_iflags_set(ip, flags);
 123         spin_unlock(&ip->i_flags_lock);
 124 }
 125
 126 static inline void
 127 xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
 128 {
 129         spin_lock(&ip->i_flags_lock);
 130         ip->i_flags &= ~flags;
 131         spin_unlock(&ip->i_flags_lock);
 132 }
 133
 134 static inline int
 135 __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
 136 {
 137         return (ip->i_flags & flags);
 138 }
 139
 140 static inline int
 141 xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
 142 {
 143         int ret;
 144         spin_lock(&ip->i_flags_lock);
 145         ret = __xfs_iflags_test(ip, flags);
 146         spin_unlock(&ip->i_flags_lock);
 147         return ret;
 148 }
 149
 150 static inline int
 151 xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
 152 {
 153         int ret;
 154
 155         spin_lock(&ip->i_flags_lock);
 156         ret = ip->i_flags & flags;
 157         if (ret)
 158                 ip->i_flags &= ~flags;
 159         spin_unlock(&ip->i_flags_lock);
 160         return ret;
 161 }
 162
 163 static inline int
 164 xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
 165 {
 166         int ret;
 167
 168         spin_lock(&ip->i_flags_lock);
 169         ret = ip->i_flags & flags;
 170         if (!ret)
 171                 ip->i_flags |= flags;
 172         spin_unlock(&ip->i_flags_lock);
 173         return ret;
 174 }
 175
 176 /*
 177  * Project quota id helpers (previously projid was 16bit only
 178  * and using two 16bit values to hold new 32bit projid was chosen
 179  * to retain compatibility with "old" filesystems).
 180  */
 181 static inline prid_t
 182 xfs_get_projid(struct xfs_inode *ip)
 183 {
 184         return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo;
 185 }
 186
 187 static inline void
 188 xfs_set_projid(struct xfs_inode *ip,
 189                 prid_t projid)
 190 {
 191         ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16);
 192         ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff);
 193 }
 194
 195 /*
 196  * In-core inode flags.
 197  */
 198 #define XFS_IRECLAIM            (1 << 0) /* started reclaiming this inode */
 199 #define XFS_ISTALE              (1 << 1) /* inode has been staled */
 200 #define XFS_IRECLAIMABLE        (1 << 2) /* inode can be reclaimed */
 201 #define XFS_INEW                (1 << 3) /* inode has just been allocated */
 202 #define XFS_IFILESTREAM         (1 << 4) /* inode is in a filestream dir. */
 203 #define XFS_ITRUNCATED          (1 << 5) /* truncated down so flush-on-close */
 204 #define XFS_IDIRTY_RELEASE      (1 << 6) /* dirty release already seen */
 205 #define __XFS_IFLOCK_BIT        7        /* inode is being flushed right now */
 206 #define XFS_IFLOCK              (1 << __XFS_IFLOCK_BIT)
 207 #define __XFS_IPINNED_BIT       8        /* wakeup key for zero pin count */
 208 #define XFS_IPINNED             (1 << __XFS_IPINNED_BIT)
 209 #define XFS_IDONTCACHE          (1 << 9) /* don't cache the inode long term */
 210
 211 /*
 212  * Per-lifetime flags need to be reset when re-using a reclaimable inode during
 213  * inode lookup. This prevents unintended behaviour on the new inode from
 214  * ocurring.
 215  */
 216 #define XFS_IRECLAIM_RESET_FLAGS        \
 217         (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
 218          XFS_IDIRTY_RELEASE | XFS_ITRUNCATED | \
 219          XFS_IFILESTREAM);
 220
 221 /*
 222  * Synchronize processes attempting to flush the in-core inode back to disk.
 223  */
 224
 225 extern void __xfs_iflock(struct xfs_inode *ip);
 226
 227 static inline int xfs_iflock_nowait(struct xfs_inode *ip)
 228 {
 229         return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
 230 }
 231
 232 static inline void xfs_iflock(struct xfs_inode *ip)
 233 {
 234         if (!xfs_iflock_nowait(ip))
 235                 __xfs_iflock(ip);
 236 }
 237
 238 static inline void xfs_ifunlock(struct xfs_inode *ip)
 239 {
 240         xfs_iflags_clear(ip, XFS_IFLOCK);
 241         smp_mb();
 242         wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
 243 }
 244
 245 static inline int xfs_isiflocked(struct xfs_inode *ip)
 246 {
 247         return xfs_iflags_test(ip, XFS_IFLOCK);
 248 }
 249
 250 /*
 251  * Flags for inode locking.
 252  * Bit ranges:  1<<1  - 1<<16-1 -- iolock/ilock modes (bitfield)
 253  *              1<<16 - 1<<32-1 -- lockdep annotation (integers)
 254  */
 255 #define XFS_IOLOCK_EXCL         (1<<0)
 256 #define XFS_IOLOCK_SHARED       (1<<1)
 257 #define XFS_ILOCK_EXCL          (1<<2)
 258 #define XFS_ILOCK_SHARED        (1<<3)
 259
 260 #define XFS_LOCK_MASK           (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
 261                                 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED)
 262
 263 #define XFS_LOCK_FLAGS \
 264         { XFS_IOLOCK_EXCL,      "IOLOCK_EXCL" }, \
 265         { XFS_IOLOCK_SHARED,    "IOLOCK_SHARED" }, \
 266         { XFS_ILOCK_EXCL,       "ILOCK_EXCL" }, \
 267         { XFS_ILOCK_SHARED,     "ILOCK_SHARED" }
 268
 269
 270 /*
 271  * Flags for lockdep annotations.
 272  *
 273  * XFS_LOCK_PARENT - for directory operations that require locking a
 274  * parent directory inode and a child entry inode.  The parent gets locked
 275  * with this flag so it gets a lockdep subclass of 1 and the child entry
 276  * lock will have a lockdep subclass of 0.
 277  *
 278  * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
 279  * inodes do not participate in the normal lock order, and thus have their
 280  * own subclasses.
 281  *
 282  * XFS_LOCK_INUMORDER - for locking several inodes at the some time
 283  * with xfs_lock_inodes().  This flag is used as the starting subclass
 284  * and each subsequent lock acquired will increment the subclass by one.
 285  * So the first lock acquired will have a lockdep subclass of 4, the
 286  * second lock will have a lockdep subclass of 5, and so on. It is
 287  * the responsibility of the class builder to shift this to the correct
 288  * portion of the lock_mode lockdep mask.
 289  */
 290 #define XFS_LOCK_PARENT         1
 291 #define XFS_LOCK_RTBITMAP       2
 292 #define XFS_LOCK_RTSUM          3
 293 #define XFS_LOCK_INUMORDER      4
 294
 295 #define XFS_IOLOCK_SHIFT        16
 296 #define XFS_IOLOCK_PARENT       (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT)
 297
 298 #define XFS_ILOCK_SHIFT         24
 299 #define XFS_ILOCK_PARENT        (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT)
 300 #define XFS_ILOCK_RTBITMAP      (XFS_LOCK_RTBITMAP << XFS_ILOCK_SHIFT)
 301 #define XFS_ILOCK_RTSUM         (XFS_LOCK_RTSUM << XFS_ILOCK_SHIFT)
 302
 303 #define XFS_IOLOCK_DEP_MASK     0x00ff0000
 304 #define XFS_ILOCK_DEP_MASK      0xff000000
 305 #define XFS_LOCK_DEP_MASK       (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK)
 306
 307 #define XFS_IOLOCK_DEP(flags)   (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT)
 308 #define XFS_ILOCK_DEP(flags)    (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT)
 309
 310 /*
 311  * For multiple groups support: if S_ISGID bit is set in the parent
 312  * directory, group of new file is set to that of the parent, and
 313  * new subdirectory gets S_ISGID bit from parent.
 314  */
 315 #define XFS_INHERIT_GID(pip)    \
 316         (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
 317          ((pip)->i_d.di_mode & S_ISGID))
 318
 319
 320 int             xfs_release(struct xfs_inode *ip);
 321 void            xfs_inactive(struct xfs_inode *ip);
 322 int             xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
 323                            struct xfs_inode **ipp, struct xfs_name *ci_name);
 324 int             xfs_create(struct xfs_inode *dp, struct xfs_name *name,
 325                            umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp);
 326 int             xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
 327                            struct xfs_inode *ip);
 328 int             xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
 329                          struct xfs_name *target_name);
 330 int             xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
 331                            struct xfs_inode *src_ip, struct xfs_inode *target_dp,
 332                            struct xfs_name *target_name,
 333                            struct xfs_inode *target_ip);
 334
 335 void            xfs_ilock(xfs_inode_t *, uint);
 336 int             xfs_ilock_nowait(xfs_inode_t *, uint);
 337 void            xfs_iunlock(xfs_inode_t *, uint);
 338 void            xfs_ilock_demote(xfs_inode_t *, uint);
 339 int             xfs_isilocked(xfs_inode_t *, uint);
 340 uint            xfs_ilock_map_shared(xfs_inode_t *);
 341 void            xfs_iunlock_map_shared(xfs_inode_t *, uint);
 342 int             xfs_ialloc(struct xfs_trans *, xfs_inode_t *, umode_t,
 343                            xfs_nlink_t, xfs_dev_t, prid_t, int,
 344                            struct xfs_buf **, xfs_inode_t **);
 345
 346 uint            xfs_ip2xflags(struct xfs_inode *);
 347 uint            xfs_dic2xflags(struct xfs_dinode *);
 348 int             xfs_ifree(struct xfs_trans *, xfs_inode_t *,
 349                            struct xfs_bmap_free *);
 350 int             xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *,
 351                                       int, xfs_fsize_t);
 352 int             xfs_iunlink(struct xfs_trans *, xfs_inode_t *);
 353
 354 void            xfs_iext_realloc(xfs_inode_t *, int, int);
 355
 356 void            xfs_iunpin_wait(xfs_inode_t *);
 357 #define xfs_ipincount(ip)       ((unsigned int) atomic_read(&ip->i_pincount))
 358
 359 int             xfs_iflush(struct xfs_inode *, struct xfs_buf **);
 360 void            xfs_lock_inodes(xfs_inode_t **, int, uint);
 361 void            xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint);
 362
 363 xfs_extlen_t    xfs_get_extsz_hint(struct xfs_inode *ip);
 364
 365 int             xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
 366                                xfs_nlink_t, xfs_dev_t, prid_t, int,
 367                                struct xfs_inode **, int *);
 368 int             xfs_droplink(struct xfs_trans *, struct xfs_inode *);
 369 int             xfs_bumplink(struct xfs_trans *, struct xfs_inode *);
 370 void            xfs_bump_ino_vers2(struct xfs_trans *, struct xfs_inode *);
 371
 372 /* from xfs_file.c */
 373 int             xfs_zero_eof(struct xfs_inode *, xfs_off_t, xfs_fsize_t);
 374 int             xfs_iozero(struct xfs_inode *, loff_t, size_t);
 375
 376
 377 #define IHOLD(ip) \
 378 do { \
 379         ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \
 380         ihold(VFS_I(ip)); \
 381         trace_xfs_ihold(ip, _THIS_IP_); \
 382 } while (0)
 383
 384 #define IRELE(ip) \
 385 do { \
 386         trace_xfs_irele(ip, _THIS_IP_); \
 387         iput(VFS_I(ip)); \
 388 } while (0)
 389
 390 extern struct kmem_zone *xfs_inode_zone;
 391
 392 #endif  /* __XFS_INODE_H__ */