fs/xfs/linux/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 spinlock_t vnumber_lock = SPIN_LOCK_UNLOCKED;
  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         printk("Allocated VNODE_TRACE at 0x%p\n", vp->v_trace);
 160 #endif  /* XFS_VNODE_TRACE */
 161
 162         vn_trace_exit(vp, "vn_initialize", (inst_t *)__return_address);
 163         return vp;
 164 }
 165
 166 /*
 167  * Get a reference on a vnode.
 168  */
 169 vnode_t *
 170 vn_get(
 171         struct vnode    *vp,
 172         vmap_t          *vmap)
 173 {
 174         struct inode    *inode;
 175
 176         XFS_STATS_INC(vn_get);
 177         inode = LINVFS_GET_IP(vp);
 178         if (inode->i_state & I_FREEING)
 179                 return NULL;
 180
 181         inode = ilookup(vmap->v_vfsp->vfs_super, vmap->v_ino);
 182         if (!inode)     /* Inode not present */
 183                 return NULL;
 184
 185         vn_trace_exit(vp, "vn_get", (inst_t *)__return_address);
 186
 187         return vp;
 188 }
 189
 190 /*
 191  * Revalidate the Linux inode from the vnode.
 192  */
 193 int
 194 vn_revalidate(
 195         struct vnode    *vp)
 196 {
 197         struct inode    *inode;
 198         vattr_t         va;
 199         int             error;
 200
 201         vn_trace_entry(vp, "vn_revalidate", (inst_t *)__return_address);
 202         ASSERT(vp->v_fbhv != NULL);
 203
 204         va.va_mask = XFS_AT_STAT|XFS_AT_XFLAGS;
 205         VOP_GETATTR(vp, &va, 0, NULL, error);
 206         if (!error) {
 207                 inode = LINVFS_GET_IP(vp);
 208                 inode->i_mode       = VTTOIF(va.va_type) | va.va_mode;
 209                 inode->i_nlink      = va.va_nlink;
 210                 inode->i_uid        = va.va_uid;
 211                 inode->i_gid        = va.va_gid;
 212                 inode->i_blocks     = va.va_nblocks;
 213                 inode->i_mtime      = va.va_mtime;
 214                 inode->i_ctime      = va.va_ctime;
 215                 inode->i_atime      = va.va_atime;
 216                 if (va.va_xflags & XFS_XFLAG_IMMUTABLE)
 217                         inode->i_flags |= S_IMMUTABLE;
 218                 else
 219                         inode->i_flags &= ~S_IMMUTABLE;
 220                 if (va.va_xflags & XFS_XFLAG_APPEND)
 221                         inode->i_flags |= S_APPEND;
 222                 else
 223                         inode->i_flags &= ~S_APPEND;
 224                 if (va.va_xflags & XFS_XFLAG_SYNC)
 225                         inode->i_flags |= S_SYNC;
 226                 else
 227                         inode->i_flags &= ~S_SYNC;
 228                 if (va.va_xflags & XFS_XFLAG_NOATIME)
 229                         inode->i_flags |= S_NOATIME;
 230                 else
 231                         inode->i_flags &= ~S_NOATIME;
 232                 VUNMODIFY(vp);
 233         }
 234         return -error;
 235 }
 236
 237 /*
 238  * purge a vnode from the cache
 239  * At this point the vnode is guaranteed to have no references (vn_count == 0)
 240  * The caller has to make sure that there are no ways someone could
 241  * get a handle (via vn_get) on the vnode (usually done via a mount/vfs lock).
 242  */
 243 void
 244 vn_purge(
 245         struct vnode    *vp,
 246         vmap_t          *vmap)
 247 {
 248         vn_trace_entry(vp, "vn_purge", (inst_t *)__return_address);
 249
 250 again:
 251         /*
 252          * Check whether vp has already been reclaimed since our caller
 253          * sampled its version while holding a filesystem cache lock that
 254          * its VOP_RECLAIM function acquires.
 255          */
 256         VN_LOCK(vp);
 257         if (vp->v_number != vmap->v_number) {
 258                 VN_UNLOCK(vp, 0);
 259                 return;
 260         }
 261
 262         /*
 263          * If vp is being reclaimed or inactivated, wait until it is inert,
 264          * then proceed.  Can't assume that vnode is actually reclaimed
 265          * just because the reclaimed flag is asserted -- a vn_alloc
 266          * reclaim can fail.
 267          */
 268         if (vp->v_flag & (VINACT | VRECLM)) {
 269                 ASSERT(vn_count(vp) == 0);
 270                 vp->v_flag |= VWAIT;
 271                 sv_wait(vptosync(vp), PINOD, &vp->v_lock, 0);
 272                 goto again;
 273         }
 274
 275         /*
 276          * Another process could have raced in and gotten this vnode...
 277          */
 278         if (vn_count(vp) > 0) {
 279                 VN_UNLOCK(vp, 0);
 280                 return;
 281         }
 282
 283         XFS_STATS_DEC(vn_active);
 284         vp->v_flag |= VRECLM;
 285         VN_UNLOCK(vp, 0);
 286
 287         /*
 288          * Call VOP_RECLAIM and clean vp. The FSYNC_INVAL flag tells
 289          * vp's filesystem to flush and invalidate all cached resources.
 290          * When vn_reclaim returns, vp should have no private data,
 291          * either in a system cache or attached to v_data.
 292          */
 293         if (vn_reclaim(vp) != 0)
 294                 panic("vn_purge: cannot reclaim");
 295
 296         /*
 297          * Wakeup anyone waiting for vp to be reclaimed.
 298          */
 299         vn_wakeup(vp);
 300 }
 301
 302 /*
 303  * Add a reference to a referenced vnode.
 304  */
 305 struct vnode *
 306 vn_hold(
 307         struct vnode    *vp)
 308 {
 309         struct inode    *inode;
 310
 311         XFS_STATS_INC(vn_hold);
 312
 313         VN_LOCK(vp);
 314         inode = igrab(LINVFS_GET_IP(vp));
 315         ASSERT(inode);
 316         VN_UNLOCK(vp, 0);
 317
 318         return vp;
 319 }
 320
 321 /*
 322  *  Call VOP_INACTIVE on last reference.
 323  */
 324 void
 325 vn_rele(
 326         struct vnode    *vp)
 327 {
 328         int             vcnt;
 329         int             cache;
 330
 331         XFS_STATS_INC(vn_rele);
 332
 333         VN_LOCK(vp);
 334
 335         vn_trace_entry(vp, "vn_rele", (inst_t *)__return_address);
 336         vcnt = vn_count(vp);
 337
 338         /*
 339          * Since we always get called from put_inode we know
 340          * that i_count won't be decremented after we
 341          * return.
 342          */
 343         if (!vcnt) {
 344                 /*
 345                  * As soon as we turn this on, noone can find us in vn_get
 346                  * until we turn off VINACT or VRECLM
 347                  */
 348                 vp->v_flag |= VINACT;
 349                 VN_UNLOCK(vp, 0);
 350
 351                 /*
 352                  * Do not make the VOP_INACTIVE call if there
 353                  * are no behaviors attached to the vnode to call.
 354                  */
 355                 if (vp->v_fbhv)
 356                         VOP_INACTIVE(vp, NULL, cache);
 357
 358                 VN_LOCK(vp);
 359                 if (vp->v_flag & VWAIT)
 360                         sv_broadcast(vptosync(vp));
 361
 362                 vp->v_flag &= ~(VINACT|VWAIT|VRECLM|VMODIFIED);
 363         }
 364
 365         VN_UNLOCK(vp, 0);
 366
 367         vn_trace_exit(vp, "vn_rele", (inst_t *)__return_address);
 368 }
 369
 370 /*
 371  * Finish the removal of a vnode.
 372  */
 373 void
 374 vn_remove(
 375         struct vnode    *vp)
 376 {
 377         vmap_t          vmap;
 378
 379         /* Make sure we don't do this to the same vnode twice */
 380         if (!(vp->v_fbhv))
 381                 return;
 382
 383         XFS_STATS_INC(vn_remove);
 384         vn_trace_exit(vp, "vn_remove", (inst_t *)__return_address);
 385
 386         /*
 387          * After the following purge the vnode
 388          * will no longer exist.
 389          */
 390         VMAP(vp, vmap);
 391         vn_purge(vp, &vmap);
 392 }
 393
 394
 395 #ifdef  XFS_VNODE_TRACE
 396
 397 #define KTRACE_ENTER(vp, vk, s, line, ra)                       \
 398         ktrace_enter(   (vp)->v_trace,                          \
 399 /*  0 */                (void *)(__psint_t)(vk),                \
 400 /*  1 */                (void *)(s),                            \
 401 /*  2 */                (void *)(__psint_t) line,               \
 402 /*  3 */                (void *)(vn_count(vp)), \
 403 /*  4 */                (void *)(ra),                           \
 404 /*  5 */                (void *)(__psunsigned_t)(vp)->v_flag,   \
 405 /*  6 */                (void *)(__psint_t)smp_processor_id(),  \
 406 /*  7 */                (void *)(__psint_t)(current->pid),      \
 407 /*  8 */                (void *)__return_address,               \
 408 /*  9 */                0, 0, 0, 0, 0, 0, 0)
 409
 410 /*
 411  * Vnode tracing code.
 412  */
 413 void
 414 vn_trace_entry(vnode_t *vp, char *func, inst_t *ra)
 415 {
 416         KTRACE_ENTER(vp, VNODE_KTRACE_ENTRY, func, 0, ra);
 417 }
 418
 419 void
 420 vn_trace_exit(vnode_t *vp, char *func, inst_t *ra)
 421 {
 422         KTRACE_ENTER(vp, VNODE_KTRACE_EXIT, func, 0, ra);
 423 }
 424
 425 void
 426 vn_trace_hold(vnode_t *vp, char *file, int line, inst_t *ra)
 427 {
 428         KTRACE_ENTER(vp, VNODE_KTRACE_HOLD, file, line, ra);
 429 }
 430
 431 void
 432 vn_trace_ref(vnode_t *vp, char *file, int line, inst_t *ra)
 433 {
 434         KTRACE_ENTER(vp, VNODE_KTRACE_REF, file, line, ra);
 435 }
 436
 437 void
 438 vn_trace_rele(vnode_t *vp, char *file, int line, inst_t *ra)
 439 {
 440         KTRACE_ENTER(vp, VNODE_KTRACE_RELE, file, line, ra);
 441 }
 442 #endif  /* XFS_VNODE_TRACE */