source4/lib/replace/repdir_getdirentries.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Andrew Tridgell 2005
   5
   6      ** NOTE! The following LGPL license applies to the replace
   7      ** library. This does NOT imply that all of Samba is released
   8      ** under the LGPL
   9
  10    This library is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU Lesser General Public
  12    License as published by the Free Software Foundation; either
  13    version 2 of the License, or (at your option) any later version.
  14
  15    This library is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    Lesser General Public License for more details.
  19
  20    You should have received a copy of the GNU Lesser General Public
  21    License along with this library; if not, write to the Free Software
  22    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23 */
  24 /*
  25   a replacement for opendir/readdir/telldir/seekdir/closedir for BSD
  26   systems using getdirentries
  27
  28   This is needed because the existing directory handling in FreeBSD
  29   and OpenBSD (and possibly NetBSD) doesn't correctly handle unlink()
  30   on files in a directory where telldir() has been used. On a block
  31   boundary it will occasionally miss a file when seekdir() is used to
  32   return to a position previously recorded with telldir().
  33
  34   This also fixes a severe performance and memory usage problem with
  35   telldir() on BSD systems. Each call to telldir() in BSD adds an
  36   entry to a linked list, and those entries are cleaned up on
  37   closedir(). This means with a large directory closedir() can take an
  38   arbitrary amount of time, causing network timeouts as millions of
  39   telldir() entries are freed
  40
  41   Note! This replacement code is not portable. It relies on
  42   getdirentries() always leaving the file descriptor at a seek offset
  43   that is a multiple of DIR_BUF_SIZE. If the code detects that this
  44   doesn't happen then it will abort(). It also does not handle
  45   directories with offsets larger than can be stored in a long,
  46
  47   This code is available under other free software licenses as
  48   well. Contact the author.
  49 */
  50
  51 #include "replace.h"
  52 #include <stdlib.h>
  53 #include <sys/stat.h>
  54 #include <unistd.h>
  55 #include <sys/types.h>
  56 #include <errno.h>
  57 #include <fcntl.h>
  58 #include <dirent.h>
  59
  60 #define DIR_BUF_BITS 9
  61 #define DIR_BUF_SIZE (1<<DIR_BUF_BITS)
  62
  63 struct dir_buf {
  64         int fd;
  65         int nbytes, ofs;
  66         off_t seekpos;
  67         char buf[DIR_BUF_SIZE];
  68 };
  69
  70 DIR *opendir(const char *dname)
  71 {
  72         struct dir_buf *d;
  73         d = malloc(sizeof(*d));
  74         if (d == NULL) {
  75                 errno = ENOMEM;
  76                 return NULL;
  77         }
  78         d->fd = open(dname, O_RDONLY);
  79         if (d->fd == -1) {
  80                 free(d);
  81                 return NULL;
  82         }
  83         d->ofs = 0;
  84         d->seekpos = 0;
  85         d->nbytes = 0;
  86         return (DIR *)d;
  87 }
  88
  89 struct dirent *readdir(DIR *dir)
  90 {
  91         struct dir_buf *d = (struct dir_buf *)dir;
  92         struct dirent *de;
  93
  94         if (d->ofs >= d->nbytes) {
  95                 long pos;
  96                 d->nbytes = getdirentries(d->fd, d->buf, DIR_BUF_SIZE, &pos);
  97                 d->seekpos = pos;
  98                 d->ofs = 0;
  99         }
 100         if (d->ofs >= d->nbytes) {
 101                 return NULL;
 102         }
 103         de = (struct dirent *)&d->buf[d->ofs];
 104         d->ofs += de->d_reclen;
 105         return de;
 106 }
 107
 108 #ifdef TELLDIR_TAKES_CONST_DIR
 109 long telldir(const DIR *dir)
 110 #else
 111 long telldir(DIR *dir)
 112 #endif
 113 {
 114         struct dir_buf *d = (struct dir_buf *)dir;
 115         if (d->ofs >= d->nbytes) {
 116                 d->seekpos = lseek(d->fd, 0, SEEK_CUR);
 117                 d->ofs = 0;
 118                 d->nbytes = 0;
 119         }
 120         /* this relies on seekpos always being a multiple of
 121            DIR_BUF_SIZE. Is that always true on BSD systems? */
 122         if (d->seekpos & (DIR_BUF_SIZE-1)) {
 123                 abort();
 124         }
 125         return d->seekpos + d->ofs;
 126 }
 127
 128 #ifdef SEEKDIR_RETURNS_INT
 129 int seekdir(DIR *dir, long ofs)
 130 #else
 131 void seekdir(DIR *dir, long ofs)
 132 #endif
 133 {
 134         struct dir_buf *d = (struct dir_buf *)dir;
 135         long pos;
 136         d->seekpos = lseek(d->fd, ofs & ~(DIR_BUF_SIZE-1), SEEK_SET);
 137         d->nbytes = getdirentries(d->fd, d->buf, DIR_BUF_SIZE, &pos);
 138         d->ofs = 0;
 139         while (d->ofs < (ofs & (DIR_BUF_SIZE-1))) {
 140                 if (readdir(dir) == NULL) break;
 141         }
 142 #ifdef SEEKDIR_RETURNS_INT
 143         return -1;
 144 #endif
 145 }
 146
 147 void rewinddir(DIR *dir)
 148 {
 149         seekdir(dir, 0);
 150 }
 151
 152 int closedir(DIR *dir)
 153 {
 154         struct dir_buf *d = (struct dir_buf *)dir;
 155         int r = close(d->fd);
 156         if (r != 0) {
 157                 return r;
 158         }
 159         free(d);
 160         return 0;
 161 }
 162
 163 #ifndef dirfd
 164 /* darn, this is a macro on some systems. */
 165 int dirfd(DIR *dir)
 166 {
 167         struct dir_buf *d = (struct dir_buf *)dir;
 168         return d->fd;
 169 }
 170 #endif
 171
 172