The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/fs/pseudofs/pseudofs_vncache.c

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 2001 Dag-Erling Co´dan Sm°rgrav
    3  * All rights reserved.
    4  *
    5  * Redistribution and use in source and binary forms, with or without
    6  * modification, are permitted provided that the following conditions
    7  * are met:
    8  * 1. Redistributions of source code must retain the above copyright
    9  *    notice, this list of conditions and the following disclaimer
   10  *    in this position and unchanged.
   11  * 2. Redistributions in binary form must reproduce the above copyright
   12  *    notice, this list of conditions and the following disclaimer in the
   13  *    documentation and/or other materials provided with the distribution.
   14  * 3. The name of the author may not be used to endorse or promote products
   15  *    derived from this software without specific prior written permission.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   27  */
   28 
   29 #include <sys/cdefs.h>
   30 __FBSDID("$FreeBSD$");
   31 
   32 #include "opt_pseudofs.h"
   33 
   34 #include <sys/param.h>
   35 #include <sys/kernel.h>
   36 #include <sys/systm.h>
   37 #include <sys/eventhandler.h>
   38 #include <sys/lock.h>
   39 #include <sys/malloc.h>
   40 #include <sys/mutex.h>
   41 #include <sys/proc.h>
   42 #include <sys/sysctl.h>
   43 #include <sys/vnode.h>
   44 
   45 #include <fs/pseudofs/pseudofs.h>
   46 #include <fs/pseudofs/pseudofs_internal.h>
   47 
   48 static MALLOC_DEFINE(M_PFSVNCACHE, "pfs_vncache", "pseudofs vnode cache");
   49 
   50 static struct mtx pfs_vncache_mutex;
   51 static struct pfs_vdata *pfs_vncache;
   52 static eventhandler_tag pfs_exit_tag;
   53 static void pfs_exit(void *arg, struct proc *p);
   54 
   55 SYSCTL_NODE(_vfs_pfs, OID_AUTO, vncache, CTLFLAG_RW, 0,
   56     "pseudofs vnode cache");
   57 
   58 static int pfs_vncache_entries;
   59 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, entries, CTLFLAG_RD,
   60     &pfs_vncache_entries, 0,
   61     "number of entries in the vnode cache");
   62 
   63 static int pfs_vncache_maxentries;
   64 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, maxentries, CTLFLAG_RD,
   65     &pfs_vncache_maxentries, 0,
   66     "highest number of entries in the vnode cache");
   67 
   68 static int pfs_vncache_hits;
   69 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, hits, CTLFLAG_RD,
   70     &pfs_vncache_hits, 0,
   71     "number of cache hits since initialization");
   72 
   73 static int pfs_vncache_misses;
   74 SYSCTL_INT(_vfs_pfs_vncache, OID_AUTO, misses, CTLFLAG_RD,
   75     &pfs_vncache_misses, 0,
   76     "number of cache misses since initialization");
   77 
   78 extern struct vop_vector pfs_vnodeops;  /* XXX -> .h file */
   79 
   80 /*
   81  * Initialize vnode cache
   82  */
   83 void
   84 pfs_vncache_load(void)
   85 {
   86 
   87         mtx_assert(&Giant, MA_OWNED);
   88         mtx_init(&pfs_vncache_mutex, "pfs_vncache", NULL, MTX_DEF);
   89         pfs_exit_tag = EVENTHANDLER_REGISTER(process_exit, pfs_exit, NULL,
   90             EVENTHANDLER_PRI_ANY);
   91 }
   92 
   93 /*
   94  * Tear down vnode cache
   95  */
   96 void
   97 pfs_vncache_unload(void)
   98 {
   99 
  100         mtx_assert(&Giant, MA_OWNED);
  101         EVENTHANDLER_DEREGISTER(process_exit, pfs_exit_tag);
  102         KASSERT(pfs_vncache_entries == 0,
  103             ("%d vncache entries remaining", pfs_vncache_entries));
  104         mtx_destroy(&pfs_vncache_mutex);
  105 }
  106 
  107 /*
  108  * Allocate a vnode
  109  */
  110 int
  111 pfs_vncache_alloc(struct mount *mp, struct vnode **vpp,
  112                   struct pfs_node *pn, pid_t pid)
  113 {
  114         struct pfs_vdata *pvd, *pvd2;
  115         struct vnode *vp;
  116         int error;
  117 
  118         /*
  119          * See if the vnode is in the cache.
  120          * XXX linear search is not very efficient.
  121          */
  122 retry:
  123         mtx_lock(&pfs_vncache_mutex);
  124         for (pvd = pfs_vncache; pvd; pvd = pvd->pvd_next) {
  125                 if (pvd->pvd_pn == pn && pvd->pvd_pid == pid &&
  126                     pvd->pvd_vnode->v_mount == mp) {
  127                         vp = pvd->pvd_vnode;
  128                         VI_LOCK(vp);
  129                         mtx_unlock(&pfs_vncache_mutex);
  130                         if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK, curthread) == 0) {
  131                                 ++pfs_vncache_hits;
  132                                 *vpp = vp;
  133                                 /*
  134                                  * Some callers cache_enter(vp) later, so
  135                                  * we have to make sure it's not in the
  136                                  * VFS cache so it doesn't get entered
  137                                  * twice.  A better solution would be to
  138                                  * make pfs_vncache_alloc() responsible
  139                                  * for entering the vnode in the VFS
  140                                  * cache.
  141                                  */
  142                                 cache_purge(vp);
  143                                 return (0);
  144                         }
  145                         goto retry;
  146                 }
  147         }
  148         mtx_unlock(&pfs_vncache_mutex);
  149 
  150         /* nope, get a new one */
  151         pvd = malloc(sizeof *pvd, M_PFSVNCACHE, M_WAITOK);
  152         pvd->pvd_next = pvd->pvd_prev = NULL;
  153         error = getnewvnode("pseudofs", mp, &pfs_vnodeops, vpp);
  154         if (error) {
  155                 free(pvd, M_PFSVNCACHE);
  156                 return (error);
  157         }
  158         pvd->pvd_pn = pn;
  159         pvd->pvd_pid = pid;
  160         (*vpp)->v_data = pvd;
  161         switch (pn->pn_type) {
  162         case pfstype_root:
  163                 (*vpp)->v_vflag = VV_ROOT;
  164 #if 0
  165                 printf("root vnode allocated\n");
  166 #endif
  167                 /* fall through */
  168         case pfstype_dir:
  169         case pfstype_this:
  170         case pfstype_parent:
  171         case pfstype_procdir:
  172                 (*vpp)->v_type = VDIR;
  173                 break;
  174         case pfstype_file:
  175                 (*vpp)->v_type = VREG;
  176                 break;
  177         case pfstype_symlink:
  178                 (*vpp)->v_type = VLNK;
  179                 break;
  180         case pfstype_none:
  181                 KASSERT(0, ("pfs_vncache_alloc called for null node\n"));
  182         default:
  183                 panic("%s has unexpected type: %d", pn->pn_name, pn->pn_type);
  184         }
  185         /*
  186          * Propagate flag through to vnode so users know it can change
  187          * if the process changes (i.e. execve)
  188          */
  189         if ((pn->pn_flags & PFS_PROCDEP) != 0)
  190                 (*vpp)->v_vflag |= VV_PROCDEP;
  191         pvd->pvd_vnode = *vpp;
  192         VN_LOCK_AREC(*vpp);
  193         vn_lock(*vpp, LK_EXCLUSIVE | LK_RETRY);
  194         error = insmntque(*vpp, mp);
  195         if (error != 0) {
  196                 free(pvd, M_PFSVNCACHE);
  197                 *vpp = NULLVP;
  198                 return (error);
  199         }
  200 retry2:
  201         mtx_lock(&pfs_vncache_mutex);
  202         /*
  203          * Other thread may race with us, creating the entry we are
  204          * going to insert into the cache. Recheck after
  205          * pfs_vncache_mutex is reacquired.
  206          */
  207         for (pvd2 = pfs_vncache; pvd2; pvd2 = pvd2->pvd_next) {
  208                 if (pvd2->pvd_pn == pn && pvd2->pvd_pid == pid &&
  209                     pvd2->pvd_vnode->v_mount == mp) {
  210                         vp = pvd2->pvd_vnode;
  211                         VI_LOCK(vp);
  212                         mtx_unlock(&pfs_vncache_mutex);
  213                         if (vget(vp, LK_EXCLUSIVE | LK_INTERLOCK, curthread) == 0) {
  214                                 ++pfs_vncache_hits;
  215                                 vgone(*vpp);
  216                                 vput(*vpp);
  217                                 *vpp = vp;
  218                                 cache_purge(vp);
  219                                 return (0);
  220                         }
  221                         goto retry2;
  222                 }
  223         }
  224         ++pfs_vncache_misses;
  225         if (++pfs_vncache_entries > pfs_vncache_maxentries)
  226                 pfs_vncache_maxentries = pfs_vncache_entries;
  227         pvd->pvd_prev = NULL;
  228         pvd->pvd_next = pfs_vncache;
  229         if (pvd->pvd_next)
  230                 pvd->pvd_next->pvd_prev = pvd;
  231         pfs_vncache = pvd;
  232         mtx_unlock(&pfs_vncache_mutex);
  233         return (0);
  234 }
  235 
  236 /*
  237  * Free a vnode
  238  */
  239 int
  240 pfs_vncache_free(struct vnode *vp)
  241 {
  242         struct pfs_vdata *pvd;
  243 
  244         mtx_lock(&pfs_vncache_mutex);
  245         pvd = (struct pfs_vdata *)vp->v_data;
  246         KASSERT(pvd != NULL, ("pfs_vncache_free(): no vnode data\n"));
  247         if (pvd->pvd_next)
  248                 pvd->pvd_next->pvd_prev = pvd->pvd_prev;
  249         if (pvd->pvd_prev) {
  250                 pvd->pvd_prev->pvd_next = pvd->pvd_next;
  251                 --pfs_vncache_entries;
  252         } else if (pfs_vncache == pvd) {
  253                 pfs_vncache = pvd->pvd_next;
  254                 --pfs_vncache_entries;
  255         }
  256         mtx_unlock(&pfs_vncache_mutex);
  257 
  258         free(pvd, M_PFSVNCACHE);
  259         vp->v_data = NULL;
  260         return (0);
  261 }
  262 
  263 /*
  264  * Purge the cache of dead entries
  265  *
  266  * This is extremely inefficient due to the fact that vgone() not only
  267  * indirectly modifies the vnode cache, but may also sleep.  We can
  268  * neither hold pfs_vncache_mutex across a vgone() call, nor make any
  269  * assumptions about the state of the cache after vgone() returns.  In
  270  * consequence, we must start over after every vgone() call, and keep
  271  * trying until we manage to traverse the entire cache.
  272  *
  273  * The only way to improve this situation is to change the data structure
  274  * used to implement the cache.
  275  */
  276 static void
  277 pfs_purge_locked(struct pfs_node *pn)
  278 {
  279         struct pfs_vdata *pvd;
  280         struct vnode *vnp;
  281 
  282         mtx_assert(&pfs_vncache_mutex, MA_OWNED);
  283         pvd = pfs_vncache;
  284         while (pvd != NULL) {
  285                 if (pvd->pvd_dead || (pn != NULL && pvd->pvd_pn == pn)) {
  286                         vnp = pvd->pvd_vnode;
  287                         vhold(vnp);
  288                         mtx_unlock(&pfs_vncache_mutex);
  289                         VOP_LOCK(vnp, LK_EXCLUSIVE);
  290                         vgone(vnp);
  291                         VOP_UNLOCK(vnp, 0);
  292                         mtx_lock(&pfs_vncache_mutex);
  293                         vdrop(vnp);
  294                         pvd = pfs_vncache;
  295                 } else {
  296                         pvd = pvd->pvd_next;
  297                 }
  298         }
  299 }
  300 
  301 void
  302 pfs_purge(struct pfs_node *pn)
  303 {
  304 
  305         mtx_lock(&pfs_vncache_mutex);
  306         pfs_purge_locked(pn);
  307         mtx_unlock(&pfs_vncache_mutex);
  308 }
  309 
  310 /*
  311  * Free all vnodes associated with a defunct process
  312  */
  313 static void
  314 pfs_exit(void *arg, struct proc *p)
  315 {
  316         struct pfs_vdata *pvd;
  317         int dead;
  318 
  319         if (pfs_vncache == NULL)
  320                 return;
  321         mtx_lock(&pfs_vncache_mutex);
  322         for (pvd = pfs_vncache, dead = 0; pvd != NULL; pvd = pvd->pvd_next)
  323                 if (pvd->pvd_pid == p->p_pid)
  324                         dead = pvd->pvd_dead = 1;
  325         if (dead)
  326                 pfs_purge_locked(NULL);
  327         mtx_unlock(&pfs_vncache_mutex);
  328 }

Cache object: 4ad313ba54ae07df8b3264547794f535


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.