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;
49 ret = fsp_stat(data->fsp);
50 mtime = data->fsp->fsp_name->st.st_ex_mtime;
52 ret = SMB_VFS_STAT(handle->conn, data->smb_fname);
53 mtime = data->smb_fname->st.st_ex_mtime;
65 static bool open_and_sort_dir(vfs_handle_struct *handle,
66 struct dirsort_privates *data)
68 uint32_t total_count = 0;
69 /* This should be enough for most use cases */
70 uint32_t dirent_allocated = 64;
73 data->number_of_entries = 0;
75 if (get_sorted_dir_mtime(handle, data, &data->mtime) == false) {
79 dp = SMB_VFS_NEXT_READDIR(handle, data->source_directory, NULL);
84 /* Set up an array and read the directory entries into it */
85 TALLOC_FREE(data->directory_list); /* destroy previous cache if needed */
86 data->directory_list = talloc_zero_array(data,
89 if (data->directory_list == NULL) {
94 if (total_count >= dirent_allocated) {
100 * We should not double the amount of memory. With a lot
101 * of files we reach easily 50MB, and doubling will
102 * get much bigger just for a few files more.
104 * For 200k files this means 50 memory reallocations.
106 dirent_allocated += 4096;
108 dlist = talloc_realloc(data,
109 data->directory_list,
115 data->directory_list = dlist;
117 data->directory_list[total_count] = *dp;
120 dp = SMB_VFS_NEXT_READDIR(handle, data->source_directory, NULL);
121 } while (dp != NULL);
123 data->number_of_entries = total_count;
125 /* Sort the directory entries by name */
126 TYPESAFE_QSORT(data->directory_list, data->number_of_entries, compare_dirent);
130 static DIR *dirsort_opendir(vfs_handle_struct *handle,
131 const struct smb_filename *smb_fname,
135 struct dirsort_privates *list_head = NULL;
136 struct dirsort_privates *data = NULL;
138 if (SMB_VFS_HANDLE_TEST_DATA(handle)) {
139 /* Find the list head of all open directories. */
140 SMB_VFS_HANDLE_GET_DATA(handle, list_head, struct dirsort_privates,
144 /* set up our private data about this directory */
145 data = talloc_zero(handle->conn, struct dirsort_privates);
150 data->smb_fname = cp_smb_filename(data, smb_fname);
151 if (data->smb_fname == NULL) {
156 if (ISDOT(data->smb_fname->base_name)) {
157 struct smb_filename *cwd_fname = vfs_GetWd(data, handle->conn);
158 if (cwd_fname == NULL) {
162 TALLOC_FREE(data->smb_fname->base_name);
163 data->smb_fname->base_name = talloc_move(data->smb_fname,
164 &cwd_fname->base_name);
165 TALLOC_FREE(cwd_fname);
168 /* Open the underlying directory and count the number of entries */
169 data->source_directory = SMB_VFS_NEXT_OPENDIR(handle, smb_fname, mask,
172 if (data->source_directory == NULL) {
177 if (!open_and_sort_dir(handle, data)) {
178 SMB_VFS_NEXT_CLOSEDIR(handle,data->source_directory);
183 /* Add to the private list of all open directories. */
184 DLIST_ADD(list_head, data);
185 SMB_VFS_HANDLE_SET_DATA(handle, list_head, NULL,
186 struct dirsort_privates, return NULL);
188 return data->source_directory;
191 static DIR *dirsort_fdopendir(vfs_handle_struct *handle,
196 struct dirsort_privates *list_head = NULL;
197 struct dirsort_privates *data = NULL;
199 if (SMB_VFS_HANDLE_TEST_DATA(handle)) {
200 /* Find the list head of all open directories. */
201 SMB_VFS_HANDLE_GET_DATA(handle, list_head, struct dirsort_privates,
205 /* set up our private data about this directory */
206 data = talloc_zero(handle->conn, struct dirsort_privates);
213 /* Open the underlying directory and count the number of entries */
214 data->source_directory = SMB_VFS_NEXT_FDOPENDIR(handle, fsp, mask,
217 if (data->source_directory == NULL) {
222 if (!open_and_sort_dir(handle, data)) {
223 SMB_VFS_NEXT_CLOSEDIR(handle,data->source_directory);
225 /* fd is now closed. */
230 /* Add to the private list of all open directories. */
231 DLIST_ADD(list_head, data);
232 SMB_VFS_HANDLE_SET_DATA(handle, list_head, NULL,
233 struct dirsort_privates, return NULL);
235 return data->source_directory;
238 static struct dirent *dirsort_readdir(vfs_handle_struct *handle,
240 SMB_STRUCT_STAT *sbuf)
242 struct dirsort_privates *data = NULL;
243 struct timespec current_mtime;
245 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
248 while(data && (data->source_directory != dirp)) {
255 if (get_sorted_dir_mtime(handle, data, ¤t_mtime) == false) {
259 /* throw away cache and re-read the directory if we've changed */
260 if (timespec_compare(¤t_mtime, &data->mtime)) {
261 SMB_VFS_NEXT_REWINDDIR(handle, data->source_directory);
262 open_and_sort_dir(handle, data);
265 if (data->pos >= data->number_of_entries) {
269 return &data->directory_list[data->pos++];
272 static void dirsort_seekdir(vfs_handle_struct *handle, DIR *dirp,
275 struct timespec current_mtime;
276 struct dirsort_privates *data = NULL;
278 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
280 /* Find the entry holding dirp. */
281 while(data && (data->source_directory != dirp)) {
287 if (offset >= data->number_of_entries) {
292 if (get_sorted_dir_mtime(handle, data, ¤t_mtime) == false) {
296 if (timespec_compare(¤t_mtime, &data->mtime)) {
297 /* Directory changed. We must re-read the
298 cache and search for the name that was
299 previously stored at the offset being
300 requested, otherwise after the re-sort
301 we will point to the wrong entry. The
302 OS/2 incremental delete code relies on
305 char *wanted_name = talloc_strdup(handle->conn,
306 data->directory_list[offset].d_name);
307 if (wanted_name == NULL) {
310 SMB_VFS_NEXT_REWINDDIR(handle, data->source_directory);
311 open_and_sort_dir(handle, data);
312 /* Now search for where we were. */
314 for (i = 0; i < data->number_of_entries; i++) {
315 if(strcmp(wanted_name, data->directory_list[i].d_name) == 0) {
320 TALLOC_FREE(wanted_name);
324 static long dirsort_telldir(vfs_handle_struct *handle, DIR *dirp)
326 struct dirsort_privates *data = NULL;
327 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates,
330 /* Find the entry holding dirp. */
331 while(data && (data->source_directory != dirp)) {
340 static void dirsort_rewinddir(vfs_handle_struct *handle, DIR *dirp)
342 struct dirsort_privates *data = NULL;
343 SMB_VFS_HANDLE_GET_DATA(handle, data, struct dirsort_privates, return);
345 /* Find the entry holding dirp. */
346 while(data && (data->source_directory != dirp)) {
355 static int dirsort_closedir(vfs_handle_struct *handle, DIR *dirp)
357 struct dirsort_privates *list_head = NULL;
358 struct dirsort_privates *data = NULL;
361 SMB_VFS_HANDLE_GET_DATA(handle, list_head, struct dirsort_privates, return -1);
362 /* Find the entry holding dirp. */
363 for(data = list_head; data && (data->source_directory != dirp); data = data->next) {
369 /* Remove from the list and re-store the list head. */
370 DLIST_REMOVE(list_head, data);
371 SMB_VFS_HANDLE_SET_DATA(handle, list_head, NULL,
372 struct dirsort_privates, return -1);
374 ret = SMB_VFS_NEXT_CLOSEDIR(handle, dirp);
379 static struct vfs_fn_pointers vfs_dirsort_fns = {
380 .opendir_fn = dirsort_opendir,
381 .fdopendir_fn = dirsort_fdopendir,
382 .readdir_fn = dirsort_readdir,
383 .seekdir_fn = dirsort_seekdir,
384 .telldir_fn = dirsort_telldir,
385 .rewind_dir_fn = dirsort_rewinddir,
386 .closedir_fn = dirsort_closedir,
390 NTSTATUS vfs_dirsort_init(TALLOC_CTX *ctx)
392 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "dirsort",