fs/xfs/linux-2.6/xfs_vnode.c

   1 /*
   2  * Copyright (c) 2000-2003 Silicon Graphics, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it would be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Further, this software is distributed without any warranty that it is
  13  * free of the rightful claim of any third person regarding infringement
  14  * or the like.  Any license provided herein, whether implied or
  15  * otherwise, applies only to this software file.  Patent licenses, if
  16  * any, provided herein do not apply to combinations of this program with
  17  * other software, or any other product whatsoever.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write the Free Software Foundation, Inc., 59
  21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  22  *
  23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  24  * Mountain View, CA  94043, or:
  25  *
  26  * http://www.sgi.com
  27  *
  28  * For further information regarding this notice, see:
  29  *
  30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  31  */
  32
  33 #include "xfs.h"
  34
  35
  36 uint64_t vn_generation;         /* vnode generation number */
  37 DEFINE_SPINLOCK(vnumber_lock);
  38
  39 /*
  40  * Dedicated vnode inactive/reclaim sync semaphores.
  41  * Prime number of hash buckets since address is used as the key.
  42  */
  43 #define NVSYNC                  37
  44 #define vptosync(v)             (&vsync[((unsigned long)v) % NVSYNC])
  45 sv_t vsync[NVSYNC];
  46
  47 /*
  48  * Translate stat(2) file types to vnode types and vice versa.
  49  * Aware of numeric order of S_IFMT and vnode type values.
  50  */
  51 enum vtype iftovt_tab[] = {
  52         VNON, VFIFO, VCHR, VNON, VDIR, VNON, VBLK, VNON,
  53         VREG, VNON, VLNK, VNON, VSOCK, VNON, VNON, VNON
  54 };
  55
  56 u_short vttoif_tab[] = {
  57         0, S_IFREG, S_IFDIR, S_IFBLK, S_IFCHR, S_IFLNK, S_IFIFO, 0, S_IFSOCK
  58 };
  59
  60
  61 void
  62 vn_init(void)
  63 {
  64         register sv_t *svp;
  65         register int i;
  66
  67         for (svp = vsync, i = 0; i < NVSYNC; i++, svp++)
  68                 init_sv(svp, SV_DEFAULT, "vsy", i);
  69 }
  70
  71 /*
  72  * Clean a vnode of filesystem-specific data and prepare it for reuse.
  73  */
  74 STATIC int
  75 vn_reclaim(
  76         struct vnode    *vp)
  77 {
  78         int             error;
  79
  80         XFS_STATS_INC(vn_reclaim);
  81         vn_trace_entry(vp, "vn_reclaim", (inst_t *)__return_address);
  82
  83         /*
  84          * Only make the VOP_RECLAIM call if there are behaviors
  85          * to call.
  86          */
  87         if (vp->v_fbhv) {
  88                 VOP_RECLAIM(vp, error);
  89                 if (error)
  90                         return -error;
  91         }
  92         ASSERT(vp->v_fbhv == NULL);
  93
  94         VN_LOCK(vp);
  95         vp->v_flag &= (VRECLM|VWAIT);
  96         VN_UNLOCK(vp, 0);
  97
  98         vp->v_type = VNON;
  99         vp->v_fbhv = NULL;
 100
 101 #ifdef XFS_VNODE_TRACE
 102         ktrace_free(vp->v_trace);
 103         vp->v_trace = NULL;
 104 #endif
 105
 106         return 0;
 107 }
 108
 109 STATIC void
 110 vn_wakeup(
 111         struct vnode    *vp)
 112 {
 113         VN_LOCK(vp);
 114         if (vp->v_flag & VWAIT)
 115                 sv_broadcast(vptosync(vp));
 116         vp->v_flag &= ~(VRECLM|VWAIT|VMODIFIED);
 117         VN_UNLOCK(vp, 0);
 118 }
 119
 120 int
 121 vn_wait(
 122         struct vnode    *vp)
 123 {
 124         VN_LOCK(vp);
 125         if (vp->v_flag & (VINACT | VRECLM)) {
 126                 vp->v_flag |= VWAIT;
 127                 sv_wait(vptosync(vp), PINOD, &vp->v_lock, 0);
 128                 return 1;
 129         }
 130         VN_UNLOCK(vp, 0);
 131         return 0;
 132 }
 133
 134 struct vnode *
 135 vn_initialize(
 136         struct inode    *inode)
 137 {
 138         struct vnode    *vp = LINVFS_GET_VP(inode);
 139
 140         XFS_STATS_INC(vn_active);
 141         XFS_STATS_INC(vn_alloc);
 142
 143         vp->v_flag = VMODIFIED;
 144         spinlock_init(&vp->v_lock, "v_lock");
 145
 146         spin_lock(&vnumber_lock);
 147         if (!++vn_generation)   /* v_number shouldn't be zero */
 148                 vn_generation++;
 149         vp->v_number = vn_generation;
 150         spin_unlock(&vnumber_lock);
 151
 152         ASSERT(VN_CACHED(vp) == 0);
 153
 154         /* Initialize the first behavior and the behavior chain head. */
 155         vn_bhv_head_init(VN_BHV_HEAD(vp), "vnode");
 156
 157 #ifdef  XFS_VNODE_TRACE
 158         vp->v_trace = ktrace_alloc(VNODE_TRACE_SIZE, KM_SLEEP);
 159 #endif  /* XFS_VNODE_TRACE */
 160
 161         vn_trace_exit(vp, "vn_initialize", (inst_t *)__return_address);
 162         return vp;
 163 }
 164
 165 /*
 166  * Get a reference on a vnode.
 167  */
 168 vnode_t *
 169 vn_get(
 170         struct vnode    *vp,
 171         vmap_t          *vmap)
 172 {
 173         struct inode    *inode;
 174
 175         XFS_STATS_INC(vn_get);
 176         inode = LINVFS_GET_IP(vp);
 177         if (inode->i_state & I_FREEING)
 178                 return NULL;
 179
 180         inode = ilookup(vmap->v_vfsp->vfs_super, vmap->v_ino);
 181         if (!inode)     /* Inode not present */
 182                 return NULL;
 183
 184         vn_trace_exit(vp, "vn_get", (inst_t *)__return_address);
 185
 186         return vp;
 187 }
 188
 189 /*
 190  * Revalidate the Linux inode from the vattr.
 191  * Note: i_size _not_ updated; we must hold the inode
 192  * semaphore when doing that - callers responsibility.
 193  */
 194 void
 195 vn_revalidate_core(
 196         struct vnode    *vp,
 197         vattr_t         *vap)
 198 {
 199         struct inode    *inode = LINVFS_GET_IP(vp);
 200
 201         inode->i_mode       = VTTOIF(vap->va_type) | vap->va_mode;
 202         inode->i_nlink      = vap->va_nlink;
 203         inode->i_uid        = vap->va_uid;
 204         inode->i_gid        = vap->va_gid;
 205         inode->i_xid        = vap->va_xid;
 206         inode->i_blocks     = vap->va_nblocks;
 207         inode->i_mtime      = vap->va_mtime;
 208         inode->i_ctime      = vap->va_ctime;
 209         inode->i_atime      = vap->va_atime;
 210         if (vap->va_xflags & XFS_XFLAG_IMMUTABLE)
 211                 inode->i_flags |= S_IMMUTABLE;
 212         else
 213                 inode->i_flags &= ~S_IMMUTABLE;
 214         if (vap->va_xflags & XFS_XFLAG_IUNLINK)
 215                 inode->i_flags |= S_IUNLINK;
 216         else
 217                 inode->i_flags &= ~S_IUNLINK;
 218         if (vap->va_xflags & XFS_XFLAG_BARRIER)
 219                 inode->i_flags |= S_BARRIER;
 220         else
 221                 inode->i_flags &= ~S_BARRIER;
 222         if (vap->va_xflags & XFS_XFLAG_APPEND)
 223                 inode->i_flags |= S_APPEND;
 224         else
 225                 inode->i_flags &= ~S_APPEND;
 226         if (vap->va_xflags & XFS_XFLAG_SYNC)
 227                 inode->i_flags |= S_SYNC;
 228         else
 229                 inode->i_flags &= ~S_SYNC;
 230         if (vap->va_xflags & XFS_XFLAG_NOATIME)
 231                 inode->i_flags |= S_NOATIME;
 232         else
 233                 inode->i_flags &= ~S_NOATIME;
 234 }
 235
 236 /*
 237  * Revalidate the Linux inode from the vnode.
 238  */
 239 int
 240 vn_revalidate(
 241         struct vnode    *vp)
 242 {
 243         vattr_t         va;
 244         int             error;
 245
 246         vn_trace_entry(vp, "vn_revalidate", (inst_t *)__return_address);
 247         ASSERT(vp->v_fbhv != NULL);
 248
 249         va.va_mask = XFS_AT_STAT|XFS_AT_XFLAGS;
 250         VOP_GETATTR(vp, &va, 0, NULL, error);
 251         if (!error) {
 252                 vn_revalidate_core(vp, &va);
 253                 VUNMODIFY(vp);
 254         }
 255         return -error;
 256 }
 257
 258 /*
 259  * purge a vnode from the cache
 260  * At this point the vnode is guaranteed to have no references (vn_count == 0)
 261  * The caller has to make sure that there are no ways someone could
 262  * get a handle (via vn_get) on the vnode (usually done via a mount/vfs lock).
 263  */
 264 void
 265 vn_purge(
 266         struct vnode    *vp,
 267         vmap_t          *vmap)
 268 {
 269         vn_trace_entry(vp, "vn_purge", (inst_t *)__return_address);
 270
 271 again:
 272         /*
 273          * Check whether vp has already been reclaimed since our caller
 274          * sampled its version while holding a filesystem cache lock that
 275          * its VOP_RECLAIM function acquires.
 276          */
 277         VN_LOCK(vp);
 278         if (vp->v_number != vmap->v_number) {
 279                 VN_UNLOCK(vp, 0);
 280                 return;
 281         }
 282
 283         /*
 284          * If vp is being reclaimed or inactivated, wait until it is inert,
 285          * then proceed.  Can't assume that vnode is actually reclaimed
 286          * just because the reclaimed flag is asserted -- a vn_alloc
 287          * reclaim can fail.
 288          */
 289         if (vp->v_flag & (VINACT | VRECLM)) {
 290                 ASSERT(vn_count(vp) == 0);
 291                 vp->v_flag |= VWAIT;
 292                 sv_wait(vptosync(vp), PINOD, &vp->v_lock, 0);
 293                 goto again;
 294         }
 295
 296         /*
 297          * Another process could have raced in and gotten this vnode...
 298          */
 299         if (vn_count(vp) > 0) {
 300                 VN_UNLOCK(vp, 0);
 301                 return;
 302         }
 303
 304         XFS_STATS_DEC(vn_active);
 305         vp->v_flag |= VRECLM;
 306         VN_UNLOCK(vp, 0);
 307
 308         /*
 309          * Call VOP_RECLAIM and clean vp. The FSYNC_INVAL flag tells
 310          * vp's filesystem to flush and invalidate all cached resources.
 311          * When vn_reclaim returns, vp should have no private data,
 312          * either in a system cache or attached to v_data.
 313          */
 314         if (vn_reclaim(vp) != 0)
 315                 panic("vn_purge: cannot reclaim");
 316
 317         /*
 318          * Wakeup anyone waiting for vp to be reclaimed.
 319          */
 320         vn_wakeup(vp);
 321 }
 322
 323 /*
 324  * Add a reference to a referenced vnode.
 325  */
 326 struct vnode *
 327 vn_hold(
 328         struct vnode    *vp)
 329 {
 330         struct inode    *inode;
 331
 332         XFS_STATS_INC(vn_hold);
 333
 334         VN_LOCK(vp);
 335         inode = igrab(LINVFS_GET_IP(vp));
 336         ASSERT(inode);
 337         VN_UNLOCK(vp, 0);
 338
 339         return vp;
 340 }
 341
 342 /*
 343  *  Call VOP_INACTIVE on last reference.
 344  */
 345 void
 346 vn_rele(
 347         struct vnode    *vp)
 348 {
 349         int             vcnt;
 350         int             cache;
 351
 352         XFS_STATS_INC(vn_rele);
 353
 354         VN_LOCK(vp);
 355
 356         vn_trace_entry(vp, "vn_rele", (inst_t *)__return_address);
 357         vcnt = vn_count(vp);
 358
 359         /*
 360          * Since we always get called from put_inode we know
 361          * that i_count won't be decremented after we
 362          * return.
 363          */
 364         if (!vcnt) {
 365                 /*
 366                  * As soon as we turn this on, noone can find us in vn_get
 367                  * until we turn off VINACT or VRECLM
 368                  */
 369                 vp->v_flag |= VINACT;
 370                 VN_UNLOCK(vp, 0);
 371
 372                 /*
 373                  * Do not make the VOP_INACTIVE call if there
 374                  * are no behaviors attached to the vnode to call.
 375                  */
 376                 if (vp->v_fbhv)
 377                         VOP_INACTIVE(vp, NULL, cache);
 378
 379                 VN_LOCK(vp);
 380                 if (vp->v_flag & VWAIT)
 381                         sv_broadcast(vptosync(vp));
 382
 383                 vp->v_flag &= ~(VINACT|VWAIT|VRECLM|VMODIFIED);
 384         }
 385
 386         VN_UNLOCK(vp, 0);
 387
 388         vn_trace_exit(vp, "vn_rele", (inst_t *)__return_address);
 389 }
 390
 391 /*
 392  * Finish the removal of a vnode.
 393  */
 394 void
 395 vn_remove(
 396         struct vnode    *vp)
 397 {
 398         vmap_t          vmap;
 399
 400         /* Make sure we don't do this to the same vnode twice */
 401         if (!(vp->v_fbhv))
 402                 return;
 403
 404         XFS_STATS_INC(vn_remove);
 405         vn_trace_exit(vp, "vn_remove", (inst_t *)__return_address);
 406
 407         /*
 408          * After the following purge the vnode
 409          * will no longer exist.
 410          */
 411         VMAP(vp, vmap);
 412         vn_purge(vp, &vmap);
 413 }
 414
 415
 416 #ifdef  XFS_VNODE_TRACE
 417
 418 #define KTRACE_ENTER(vp, vk, s, line, ra)                       \
 419         ktrace_enter(   (vp)->v_trace,                          \
 420 /*  0 */                (void *)(__psint_t)(vk),                \
 421 /*  1 */                (void *)(s),                            \
 422 /*  2 */                (void *)(__psint_t) line,               \
 423 /*  3 */                (void *)(vn_count(vp)), \
 424 /*  4 */                (void *)(ra),                           \
 425 /*  5 */                (void *)(__psunsigned_t)(vp)->v_flag,   \
 426 /*  6 */                (void *)(__psint_t)current_cpu(),       \
 427 /*  7 */                (void *)(__psint_t)current_pid(),       \
 428 /*  8 */                (void *)__return_address,               \
 429 /*  9 */                0, 0, 0, 0, 0, 0, 0)
 430
 431 /*
 432  * Vnode tracing code.
 433  */
 434 void
 435 vn_trace_entry(vnode_t *vp, const char *func, inst_t *ra)
 436 {
 437         KTRACE_ENTER(vp, VNODE_KTRACE_ENTRY, func, 0, ra);
 438 }
 439
 440 void
 441 vn_trace_exit(vnode_t *vp, const char *func, inst_t *ra)
 442 {
 443         KTRACE_ENTER(vp, VNODE_KTRACE_EXIT, func, 0, ra);
 444 }
 445
 446 void
 447 vn_trace_hold(vnode_t *vp, char *file, int line, inst_t *ra)
 448 {
 449         KTRACE_ENTER(vp, VNODE_KTRACE_HOLD, file, line, ra);
 450 }
 451
 452 void
 453 vn_trace_ref(vnode_t *vp, char *file, int line, inst_t *ra)
 454 {
 455         KTRACE_ENTER(vp, VNODE_KTRACE_REF, file, line, ra);
 456 }
 457
 458 void
 459 vn_trace_rele(vnode_t *vp, char *file, int line, inst_t *ra)
 460 {
 461         KTRACE_ENTER(vp, VNODE_KTRACE_RELE, file, line, ra);
 462 }
 463 #endif  /* XFS_VNODE_TRACE */