lib/libc/gen/telldir.c

   1 /*
   2  * Copyright (c) 1983, 1993
   3  *      The Regents of the University of California.  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  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * $FreeBSD: src/lib/libc/gen/telldir.c,v 1.4.12.1 2001/03/05 09:39:59 obrien Exp $
  34  * $DragonFly: src/lib/libc/gen/telldir.c,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35  *
  36  * @(#)telldir.c        8.1 (Berkeley) 6/4/93
  37  */
  38
  39 #include <sys/param.h>
  40 #include <dirent.h>
  41 #include <stdlib.h>
  42 #include <unistd.h>
  43
  44 /*
  45  * The option SINGLEUSE may be defined to say that a telldir
  46  * cookie may be used only once before it is freed. This option
  47  * is used to avoid having memory usage grow without bound.
  48  */
  49 #define SINGLEUSE
  50
  51 /*
  52  * One of these structures is malloced to describe the current directory
  53  * position each time telldir is called. It records the current magic
  54  * cookie returned by getdirentries and the offset within the buffer
  55  * associated with that return value.
  56  */
  57 struct ddloc {
  58         struct  ddloc *loc_next;/* next structure in list */
  59         long    loc_index;      /* key associated with structure */
  60         long    loc_seek;       /* magic cookie returned by getdirentries */
  61         long    loc_loc;        /* offset of entry in buffer */
  62         const DIR* loc_dirp;    /* directory which used this entry */
  63 };
  64
  65 #define NDIRHASH        32      /* Num of hash lists, must be a power of 2 */
  66 #define LOCHASH(i)      ((i)&(NDIRHASH-1))
  67
  68 static long     dd_loccnt;      /* Index of entry for sequential readdir's */
  69 static struct   ddloc *dd_hash[NDIRHASH];   /* Hash list heads for ddlocs */
  70
  71 /*
  72  * return a pointer into a directory
  73  */
  74 long
  75 telldir(dirp)
  76         const DIR *dirp;
  77 {
  78         int index;
  79         struct ddloc *lp;
  80
  81         if ((lp = (struct ddloc *)malloc(sizeof(struct ddloc))) == NULL)
  82                 return (-1);
  83         index = dd_loccnt++;
  84         lp->loc_index = index;
  85         lp->loc_seek = dirp->dd_seek;
  86         lp->loc_loc = dirp->dd_loc;
  87         lp->loc_dirp = dirp;
  88         lp->loc_next = dd_hash[LOCHASH(index)];
  89         dd_hash[LOCHASH(index)] = lp;
  90         return (index);
  91 }
  92
  93 /*
  94  * seek to an entry in a directory.
  95  * Only values returned by "telldir" should be passed to seekdir.
  96  */
  97 void
  98 _seekdir(dirp, loc)
  99         DIR *dirp;
 100         long loc;
 101 {
 102         struct ddloc *lp;
 103         struct ddloc **prevlp;
 104         struct dirent *dp;
 105
 106         prevlp = &dd_hash[LOCHASH(loc)];
 107         lp = *prevlp;
 108         while (lp != NULL) {
 109                 if (lp->loc_index == loc)
 110                         break;
 111                 prevlp = &lp->loc_next;
 112                 lp = lp->loc_next;
 113         }
 114         if (lp == NULL)
 115                 return;
 116         if (lp->loc_loc == dirp->dd_loc && lp->loc_seek == dirp->dd_seek)
 117                 goto found;
 118         (void) lseek(dirp->dd_fd, (off_t)lp->loc_seek, SEEK_SET);
 119         dirp->dd_seek = lp->loc_seek;
 120         dirp->dd_loc = 0;
 121         while (dirp->dd_loc < lp->loc_loc) {
 122                 dp = readdir(dirp);
 123                 if (dp == NULL)
 124                         break;
 125         }
 126 found:
 127 #ifdef SINGLEUSE
 128         *prevlp = lp->loc_next;
 129         free((caddr_t)lp);
 130 #endif
 131 }
 132
 133 /*
 134  * Reclaim memory for telldir cookies which weren't used.
 135  */
 136 void
 137 _reclaim_telldir(dirp)
 138         const DIR *dirp;
 139 {
 140         struct ddloc *lp;
 141         struct ddloc **prevlp;
 142         int i;
 143
 144         for (i = 0; i < NDIRHASH; i++) {
 145                 prevlp = &dd_hash[i];
 146                 lp = *prevlp;
 147                 while (lp != NULL) {
 148                         if (lp->loc_dirp == dirp) {
 149                                 *prevlp = lp->loc_next;
 150                                 free((caddr_t)lp);
 151                                 lp = *prevlp;
 152                                 continue;
 153                         }
 154                         prevlp = &lp->loc_next;
 155                         lp = lp->loc_next;
 156                 }
 157         }
 158 }