2 * VFS module to provide a sorted directory list.
4 * Copyright (C) Andy Kelk (andy@mopoke.co.uk), 2009
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 #include "smbd/smbd.h"
23 #include "system/filesys.h"
25 static int compare_dirent (const struct dirent
*da
, const struct dirent
*db
)
27 return strcasecmp_m(da
->d_name
, db
->d_name
);
30 struct dirsort_privates
{
31 struct dirsort_privates
*prev
, *next
;
33 struct dirent
*directory_list
;
34 unsigned int number_of_entries
;
35 struct timespec mtime
;
36 DIR *source_directory
;
37 files_struct
*fsp
; /* If open via FDOPENDIR. */
38 struct smb_filename
*smb_fname
; /* If open via OPENDIR */
41 static bool get_sorted_dir_mtime(vfs_handle_struct
*handle
,
42 struct dirsort_privates
*data
,
43 struct timespec
*ret_mtime
)
46 struct timespec mtime
;
50 status
= vfs_stat_fsp(data
->fsp
);
51 if (!NT_STATUS_IS_OK(status
)) {
54 mtime
= data
->fsp
->fsp_name
->st
.st_ex_mtime
;
56 ret
= SMB_VFS_STAT(handle
->conn
, data
->smb_fname
);
60 mtime
= data
->smb_fname
->st
.st_ex_mtime
;
68 static bool open_and_sort_dir(vfs_handle_struct
*handle
,
69 struct dirsort_privates
*data
)
71 uint32_t total_count
= 0;
72 /* This should be enough for most use cases */
73 uint32_t dirent_allocated
= 64;
76 data
->number_of_entries
= 0;
78 if (get_sorted_dir_mtime(handle
, data
, &data
->mtime
) == false) {
82 dp
= SMB_VFS_NEXT_READDIR(handle
,
84 data
->source_directory
,
90 /* Set up an array and read the directory entries into it */
91 TALLOC_FREE(data
->directory_list
); /* destroy previous cache if needed */
92 data
->directory_list
= talloc_zero_array(data
,
95 if (data
->directory_list
== NULL
) {
100 if (total_count
>= dirent_allocated
) {
101 struct dirent
*dlist
;
104 * Be memory friendly.
106 * We should not double the amount of memory. With a lot
107 * of files we reach easily 50MB, and doubling will
108 * get much bigger just for a few files more.
110 * For 200k files this means 50 memory reallocations.
112 dirent_allocated
+= 4096;
114 dlist
= talloc_realloc(data
,
115 data
->directory_list
,
121 data
->directory_list
= dlist
;
123 data
->directory_list
[total_count
] = *dp
;
126 dp
= SMB_VFS_NEXT_READDIR(handle
,
128 data
->source_directory
,
130 } while (dp
!= NULL
);
132 data
->number_of_entries
= total_count
;
134 /* Sort the directory entries by name */
135 TYPESAFE_QSORT(data
->directory_list
, data
->number_of_entries
, compare_dirent
);
139 static DIR *dirsort_fdopendir(vfs_handle_struct
*handle
,
144 struct dirsort_privates
*list_head
= NULL
;
145 struct dirsort_privates
*data
= NULL
;
147 if (SMB_VFS_HANDLE_TEST_DATA(handle
)) {
148 /* Find the list head of all open directories. */
149 SMB_VFS_HANDLE_GET_DATA(handle
, list_head
, struct dirsort_privates
,
153 /* set up our private data about this directory */
154 data
= talloc_zero(handle
->conn
, struct dirsort_privates
);
161 /* Open the underlying directory and count the number of entries */
162 data
->source_directory
= SMB_VFS_NEXT_FDOPENDIR(handle
, fsp
, mask
,
165 if (data
->source_directory
== NULL
) {
170 if (!open_and_sort_dir(handle
, data
)) {
171 SMB_VFS_NEXT_CLOSEDIR(handle
,data
->source_directory
);
173 /* fd is now closed. */
178 /* Add to the private list of all open directories. */
179 DLIST_ADD(list_head
, data
);
180 SMB_VFS_HANDLE_SET_DATA(handle
, list_head
, NULL
,
181 struct dirsort_privates
, return NULL
);
183 return data
->source_directory
;
186 static struct dirent
*dirsort_readdir(vfs_handle_struct
*handle
,
187 struct files_struct
*dirfsp
,
189 SMB_STRUCT_STAT
*sbuf
)
191 struct dirsort_privates
*data
= NULL
;
192 struct timespec current_mtime
;
194 SMB_VFS_HANDLE_GET_DATA(handle
, data
, struct dirsort_privates
,
197 while(data
&& (data
->source_directory
!= dirp
)) {
204 if (get_sorted_dir_mtime(handle
, data
, ¤t_mtime
) == false) {
208 /* throw away cache and re-read the directory if we've changed */
209 if (timespec_compare(¤t_mtime
, &data
->mtime
)) {
210 SMB_VFS_NEXT_REWINDDIR(handle
, data
->source_directory
);
211 open_and_sort_dir(handle
, data
);
214 if (data
->pos
>= data
->number_of_entries
) {
218 return &data
->directory_list
[data
->pos
++];
221 static void dirsort_seekdir(vfs_handle_struct
*handle
, DIR *dirp
,
224 struct timespec current_mtime
;
225 struct dirsort_privates
*data
= NULL
;
227 SMB_VFS_HANDLE_GET_DATA(handle
, data
, struct dirsort_privates
, return);
229 /* Find the entry holding dirp. */
230 while(data
&& (data
->source_directory
!= dirp
)) {
236 if (offset
>= data
->number_of_entries
) {
241 if (get_sorted_dir_mtime(handle
, data
, ¤t_mtime
) == false) {
245 if (timespec_compare(¤t_mtime
, &data
->mtime
)) {
246 /* Directory changed. We must re-read the
247 cache and search for the name that was
248 previously stored at the offset being
249 requested, otherwise after the re-sort
250 we will point to the wrong entry. The
251 OS/2 incremental delete code relies on
254 char *wanted_name
= talloc_strdup(handle
->conn
,
255 data
->directory_list
[offset
].d_name
);
256 if (wanted_name
== NULL
) {
259 SMB_VFS_NEXT_REWINDDIR(handle
, data
->source_directory
);
260 open_and_sort_dir(handle
, data
);
261 /* Now search for where we were. */
263 for (i
= 0; i
< data
->number_of_entries
; i
++) {
264 if(strcmp(wanted_name
, data
->directory_list
[i
].d_name
) == 0) {
269 TALLOC_FREE(wanted_name
);
273 static long dirsort_telldir(vfs_handle_struct
*handle
, DIR *dirp
)
275 struct dirsort_privates
*data
= NULL
;
276 SMB_VFS_HANDLE_GET_DATA(handle
, data
, struct dirsort_privates
,
279 /* Find the entry holding dirp. */
280 while(data
&& (data
->source_directory
!= dirp
)) {
289 static void dirsort_rewinddir(vfs_handle_struct
*handle
, DIR *dirp
)
291 struct dirsort_privates
*data
= NULL
;
292 SMB_VFS_HANDLE_GET_DATA(handle
, data
, struct dirsort_privates
, return);
294 /* Find the entry holding dirp. */
295 while(data
&& (data
->source_directory
!= dirp
)) {
304 static int dirsort_closedir(vfs_handle_struct
*handle
, DIR *dirp
)
306 struct dirsort_privates
*list_head
= NULL
;
307 struct dirsort_privates
*data
= NULL
;
310 SMB_VFS_HANDLE_GET_DATA(handle
, list_head
, struct dirsort_privates
, return -1);
311 /* Find the entry holding dirp. */
312 for(data
= list_head
; data
&& (data
->source_directory
!= dirp
); data
= data
->next
) {
318 /* Remove from the list and re-store the list head. */
319 DLIST_REMOVE(list_head
, data
);
320 SMB_VFS_HANDLE_SET_DATA(handle
, list_head
, NULL
,
321 struct dirsort_privates
, return -1);
323 ret
= SMB_VFS_NEXT_CLOSEDIR(handle
, dirp
);
328 static struct vfs_fn_pointers vfs_dirsort_fns
= {
329 .fdopendir_fn
= dirsort_fdopendir
,
330 .readdir_fn
= dirsort_readdir
,
331 .seekdir_fn
= dirsort_seekdir
,
332 .telldir_fn
= dirsort_telldir
,
333 .rewind_dir_fn
= dirsort_rewinddir
,
334 .closedir_fn
= dirsort_closedir
,
338 NTSTATUS
vfs_dirsort_init(TALLOC_CTX
*ctx
)
340 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "dirsort",