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