1 // SPDX-License-Identifier: LGPL-2.1
4 * Directory search handling
6 * Copyright (C) International Business Machines Corp., 2004, 2008
7 * Copyright (C) Red Hat, Inc., 2011
8 * Author(s): Steve French (sfrench@us.ibm.com)
12 #include <linux/pagemap.h>
13 #include <linux/slab.h>
14 #include <linux/stat.h>
17 #include "cifsproto.h"
18 #include "cifs_unicode.h"
19 #include "cifs_debug.h"
20 #include "cifs_fs_sb.h"
22 #include "smb2proto.h"
23 #include "fs_context.h"
24 #include "cached_dir.h"
27 * To be safe - for UCS to UTF-8 with strings loaded with the rare long
28 * characters alloc more to account for such multibyte target UTF-8
31 #define UNICODE_NAME_MAX ((4 * NAME_MAX) + 2)
33 #ifdef CONFIG_CIFS_DEBUG2
34 static void dump_cifs_file_struct(struct file *file, char *label)
36 struct cifsFileInfo *cf;
39 cf = file->private_data;
41 cifs_dbg(FYI, "empty cifs private file data\n");
44 if (cf->invalidHandle)
45 cifs_dbg(FYI, "Invalid handle\n");
46 if (cf->srch_inf.endOfSearch)
47 cifs_dbg(FYI, "end of search\n");
48 if (cf->srch_inf.emptyDir)
49 cifs_dbg(FYI, "empty dir\n");
53 static inline void dump_cifs_file_struct(struct file *file, char *label)
59 * Attempt to preload the dcache with the results from the FIND_FIRST/NEXT
61 * Find the dentry that matches "name". If there isn't one, create one. If it's
62 * a negative dentry or the uniqueid or filetype(mode) changed,
63 * then drop it and recreate it.
66 cifs_prime_dcache(struct dentry *parent, struct qstr *name,
67 struct cifs_fattr *fattr)
69 struct dentry *dentry, *alias;
71 struct super_block *sb = parent->d_sb;
72 struct cifs_sb_info *cifs_sb = CIFS_SB(sb);
73 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wq);
75 cifs_dbg(FYI, "%s: for %s\n", __func__, name->name);
77 dentry = d_hash_and_lookup(parent, name);
80 * If we know that the inode will need to be revalidated
81 * immediately, then don't create a new dentry for it.
82 * We'll end up doing an on the wire call either way and
83 * this spares us an invalidation.
85 if (fattr->cf_flags & CIFS_FATTR_NEED_REVAL)
88 dentry = d_alloc_parallel(parent, name, &wq);
92 if (!d_in_lookup(dentry)) {
93 inode = d_inode(dentry);
95 if (d_mountpoint(dentry)) {
100 * If we're generating inode numbers, then we don't
101 * want to clobber the existing one with the one that
102 * the readdir code created.
104 if (!(cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM))
105 fattr->cf_uniqueid = CIFS_I(inode)->uniqueid;
107 /* update inode in place
108 * if both i_ino and i_mode didn't change */
109 if (CIFS_I(inode)->uniqueid == fattr->cf_uniqueid &&
110 cifs_fattr_to_inode(inode, fattr) == 0) {
115 d_invalidate(dentry);
119 inode = cifs_iget(sb, fattr);
121 inode = ERR_PTR(-ENOMEM);
122 alias = d_splice_alias(inode, dentry);
123 d_lookup_done(dentry);
124 if (alias && !IS_ERR(alias))
130 static bool reparse_file_needs_reval(const struct cifs_fattr *fattr)
132 if (!(fattr->cf_cifsattrs & ATTR_REPARSE))
135 * The DFS tags should be only intepreted by server side as per
136 * MS-FSCC 2.1.2.1, but let's include them anyway.
138 * Besides, if cf_cifstag is unset (0), then we still need it to be
139 * revalidated to know exactly what reparse point it is.
141 switch (fattr->cf_cifstag) {
142 case IO_REPARSE_TAG_DFS:
143 case IO_REPARSE_TAG_DFSR:
144 case IO_REPARSE_TAG_SYMLINK:
145 case IO_REPARSE_TAG_NFS:
146 case IO_REPARSE_TAG_MOUNT_POINT:
154 cifs_fill_common_info(struct cifs_fattr *fattr, struct cifs_sb_info *cifs_sb)
156 struct cifs_open_info_data data = {
157 .reparse = { .tag = fattr->cf_cifstag, },
160 fattr->cf_uid = cifs_sb->ctx->linux_uid;
161 fattr->cf_gid = cifs_sb->ctx->linux_gid;
164 * The IO_REPARSE_TAG_LX_ tags originally were used by WSL but they
165 * are preferred by the Linux client in some cases since, unlike
166 * the NFS reparse tag (or EAs), they don't require an extra query
167 * to determine which type of special file they represent.
168 * TODO: go through all documented reparse tags to see if we can
169 * reasonably map some of them to directories vs. files vs. symlinks
171 if ((fattr->cf_cifsattrs & ATTR_REPARSE) &&
172 cifs_reparse_point_to_fattr(cifs_sb, fattr, &data))
175 if (fattr->cf_cifsattrs & ATTR_DIRECTORY) {
176 fattr->cf_mode = S_IFDIR | cifs_sb->ctx->dir_mode;
177 fattr->cf_dtype = DT_DIR;
179 fattr->cf_mode = S_IFREG | cifs_sb->ctx->file_mode;
180 fattr->cf_dtype = DT_REG;
185 * We need to revalidate it further to make a decision about whether it
186 * is a symbolic link, DFS referral or a reparse point with a direct
187 * access like junctions, deduplicated files, NFS symlinks.
189 if (reparse_file_needs_reval(fattr))
190 fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
192 /* non-unix readdir doesn't provide nlink */
193 fattr->cf_flags |= CIFS_FATTR_UNKNOWN_NLINK;
195 if (fattr->cf_cifsattrs & ATTR_READONLY)
196 fattr->cf_mode &= ~S_IWUGO;
199 * We of course don't get ACL info in FIND_FIRST/NEXT results, so
200 * mark it for revalidation so that "ls -l" will look right. It might
201 * be super-slow, but if we don't do this then the ownership of files
202 * may look wrong since the inodes may not have timed out by the time
203 * "ls" does a stat() call on them.
205 if ((cifs_sb->mnt_cifs_flags & CIFS_MOUNT_CIFS_ACL) ||
206 (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_MODE_FROM_SID))
207 fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
209 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_UNX_EMUL &&
210 fattr->cf_cifsattrs & ATTR_SYSTEM) {
211 if (fattr->cf_eof == 0) {
212 fattr->cf_mode &= ~S_IFMT;
213 fattr->cf_mode |= S_IFIFO;
214 fattr->cf_dtype = DT_FIFO;
217 * trying to get the type and mode via SFU can be slow,
218 * so just call those regular files for now, and mark
221 fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
226 /* Fill a cifs_fattr struct with info from SMB_FIND_FILE_POSIX_INFO. */
228 cifs_posix_to_fattr(struct cifs_fattr *fattr, struct smb2_posix_info *info,
229 struct cifs_sb_info *cifs_sb)
231 struct smb2_posix_info_parsed parsed;
233 posix_info_parse(info, NULL, &parsed);
235 memset(fattr, 0, sizeof(*fattr));
236 fattr->cf_uniqueid = le64_to_cpu(info->Inode);
237 fattr->cf_bytes = le64_to_cpu(info->AllocationSize);
238 fattr->cf_eof = le64_to_cpu(info->EndOfFile);
240 fattr->cf_atime = cifs_NTtimeToUnix(info->LastAccessTime);
241 fattr->cf_mtime = cifs_NTtimeToUnix(info->LastWriteTime);
242 fattr->cf_ctime = cifs_NTtimeToUnix(info->CreationTime);
244 fattr->cf_nlink = le32_to_cpu(info->HardLinks);
245 fattr->cf_cifsattrs = le32_to_cpu(info->DosAttributes);
248 * Since we set the inode type below we need to mask off
249 * to avoid strange results if bits set above.
250 * XXX: why not make server&client use the type bits?
252 fattr->cf_mode = le32_to_cpu(info->Mode) & ~S_IFMT;
254 cifs_dbg(FYI, "posix fattr: dev %d, reparse %d, mode %o\n",
255 le32_to_cpu(info->DeviceId),
256 le32_to_cpu(info->ReparseTag),
257 le32_to_cpu(info->Mode));
259 if (fattr->cf_cifsattrs & ATTR_DIRECTORY) {
260 fattr->cf_mode |= S_IFDIR;
261 fattr->cf_dtype = DT_DIR;
264 * mark anything that is not a dir as regular
265 * file. special files should have the REPARSE
266 * attribute and will be marked as needing revaluation
268 fattr->cf_mode |= S_IFREG;
269 fattr->cf_dtype = DT_REG;
272 if (reparse_file_needs_reval(fattr))
273 fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
275 sid_to_id(cifs_sb, &parsed.owner, fattr, SIDOWNER);
276 sid_to_id(cifs_sb, &parsed.group, fattr, SIDGROUP);
279 static void __dir_info_to_fattr(struct cifs_fattr *fattr, const void *info)
281 const FILE_DIRECTORY_INFO *fi = info;
283 memset(fattr, 0, sizeof(*fattr));
284 fattr->cf_cifsattrs = le32_to_cpu(fi->ExtFileAttributes);
285 fattr->cf_eof = le64_to_cpu(fi->EndOfFile);
286 fattr->cf_bytes = le64_to_cpu(fi->AllocationSize);
287 fattr->cf_createtime = le64_to_cpu(fi->CreationTime);
288 fattr->cf_atime = cifs_NTtimeToUnix(fi->LastAccessTime);
289 fattr->cf_ctime = cifs_NTtimeToUnix(fi->ChangeTime);
290 fattr->cf_mtime = cifs_NTtimeToUnix(fi->LastWriteTime);
294 cifs_dir_info_to_fattr(struct cifs_fattr *fattr, FILE_DIRECTORY_INFO *info,
295 struct cifs_sb_info *cifs_sb)
297 __dir_info_to_fattr(fattr, info);
298 cifs_fill_common_info(fattr, cifs_sb);
301 static void cifs_fulldir_info_to_fattr(struct cifs_fattr *fattr,
302 SEARCH_ID_FULL_DIR_INFO *info,
303 struct cifs_sb_info *cifs_sb)
305 __dir_info_to_fattr(fattr, info);
307 /* See MS-FSCC 2.4.19 FileIdFullDirectoryInformation */
308 if (fattr->cf_cifsattrs & ATTR_REPARSE)
309 fattr->cf_cifstag = le32_to_cpu(info->EaSize);
310 cifs_fill_common_info(fattr, cifs_sb);
314 cifs_std_info_to_fattr(struct cifs_fattr *fattr, FIND_FILE_STANDARD_INFO *info,
315 struct cifs_sb_info *cifs_sb)
317 int offset = cifs_sb_master_tcon(cifs_sb)->ses->server->timeAdj;
319 memset(fattr, 0, sizeof(*fattr));
320 fattr->cf_atime = cnvrtDosUnixTm(info->LastAccessDate,
321 info->LastAccessTime, offset);
322 fattr->cf_ctime = cnvrtDosUnixTm(info->LastWriteDate,
323 info->LastWriteTime, offset);
324 fattr->cf_mtime = cnvrtDosUnixTm(info->LastWriteDate,
325 info->LastWriteTime, offset);
327 fattr->cf_cifsattrs = le16_to_cpu(info->Attributes);
328 fattr->cf_bytes = le32_to_cpu(info->AllocationSize);
329 fattr->cf_eof = le32_to_cpu(info->DataSize);
331 cifs_fill_common_info(fattr, cifs_sb);
334 /* BB eventually need to add the following helper function to
335 resolve NT_STATUS_STOPPED_ON_SYMLINK return code when
336 we try to do FindFirst on (NTFS) directory symlinks */
338 int get_symlink_reparse_path(char *full_path, struct cifs_sb_info *cifs_sb,
345 struct cifs_tcon *ptcon = cifs_sb_tcon(cifs_sb);
348 rc = CIFSSMBOpen(xid, ptcon, full_path, FILE_OPEN, GENERIC_READ,
349 OPEN_REPARSE_POINT, &fid, &oplock, NULL,
353 tmpbuffer = kmalloc(maxpath);
354 rc = CIFSSMBQueryReparseLinkInfo(xid, ptcon, full_path,
359 if (CIFSSMBClose(xid, ptcon, fid)) {
360 cifs_dbg(FYI, "Error closing temporary reparsepoint open\n");
367 _initiate_cifs_search(const unsigned int xid, struct file *file,
368 const char *full_path)
372 struct cifsFileInfo *cifsFile;
373 struct cifs_sb_info *cifs_sb = CIFS_FILE_SB(file);
374 struct tcon_link *tlink = NULL;
375 struct cifs_tcon *tcon;
376 struct TCP_Server_Info *server;
378 if (file->private_data == NULL) {
379 tlink = cifs_sb_tlink(cifs_sb);
381 return PTR_ERR(tlink);
383 cifsFile = kzalloc(sizeof(struct cifsFileInfo), GFP_KERNEL);
384 if (cifsFile == NULL) {
388 spin_lock_init(&cifsFile->file_info_lock);
389 file->private_data = cifsFile;
390 cifsFile->tlink = cifs_get_tlink(tlink);
391 tcon = tlink_tcon(tlink);
393 cifsFile = file->private_data;
394 tcon = tlink_tcon(cifsFile->tlink);
397 server = tcon->ses->server;
399 if (!server->ops->query_dir_first) {
404 cifsFile->invalidHandle = true;
405 cifsFile->srch_inf.endOfSearch = false;
407 cifs_dbg(FYI, "Full path: %s start at: %lld\n", full_path, file->f_pos);
410 /* test for Unix extensions */
411 /* but now check for them on the share/mount not on the SMB session */
412 /* if (cap_unix(tcon->ses) { */
414 cifsFile->srch_inf.info_level = SMB_FIND_FILE_UNIX;
415 else if (tcon->posix_extensions)
416 cifsFile->srch_inf.info_level = SMB_FIND_FILE_POSIX_INFO;
417 else if ((tcon->ses->capabilities &
418 tcon->ses->server->vals->cap_nt_find) == 0) {
419 cifsFile->srch_inf.info_level = SMB_FIND_FILE_INFO_STANDARD;
420 } else if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM) {
421 cifsFile->srch_inf.info_level = SMB_FIND_FILE_ID_FULL_DIR_INFO;
422 } else /* not srvinos - BB fixme add check for backlevel? */ {
423 cifsFile->srch_inf.info_level = SMB_FIND_FILE_DIRECTORY_INFO;
426 search_flags = CIFS_SEARCH_CLOSE_AT_END | CIFS_SEARCH_RETURN_RESUME;
427 if (backup_cred(cifs_sb))
428 search_flags |= CIFS_SEARCH_BACKUP_SEARCH;
430 rc = server->ops->query_dir_first(xid, tcon, full_path, cifs_sb,
431 &cifsFile->fid, search_flags,
432 &cifsFile->srch_inf);
435 cifsFile->invalidHandle = false;
436 /* BB add following call to handle readdir on new NTFS symlink errors
437 else if STATUS_STOPPED_ON_SYMLINK
438 call get_symlink_reparse_path and retry with new path */
439 else if ((rc == -EOPNOTSUPP) &&
440 (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM)) {
441 cifs_sb->mnt_cifs_flags &= ~CIFS_MOUNT_SERVER_INUM;
445 cifs_put_tlink(tlink);
450 initiate_cifs_search(const unsigned int xid, struct file *file,
451 const char *full_path)
453 int rc, retry_count = 0;
456 rc = _initiate_cifs_search(xid, file, full_path);
458 * If we don't have enough credits to start reading the
459 * directory just try again after short wait.
464 usleep_range(512, 2048);
465 } while (retry_count++ < 5);
470 /* return length of unicode string in bytes */
471 static int cifs_unicode_bytelen(const char *str)
474 const __le16 *ustr = (const __le16 *)str;
476 for (len = 0; len <= PATH_MAX; len++) {
480 cifs_dbg(FYI, "Unicode string longer than PATH_MAX found\n");
484 static char *nxt_dir_entry(char *old_entry, char *end_of_smb, int level)
487 FILE_DIRECTORY_INFO *pDirInfo = (FILE_DIRECTORY_INFO *)old_entry;
489 if (level == SMB_FIND_FILE_INFO_STANDARD) {
490 FIND_FILE_STANDARD_INFO *pfData;
491 pfData = (FIND_FILE_STANDARD_INFO *)pDirInfo;
493 new_entry = old_entry + sizeof(FIND_FILE_STANDARD_INFO) + 1 +
494 pfData->FileNameLength;
496 u32 next_offset = le32_to_cpu(pDirInfo->NextEntryOffset);
498 if (old_entry + next_offset < old_entry) {
499 cifs_dbg(VFS, "Invalid offset %u\n", next_offset);
502 new_entry = old_entry + next_offset;
504 cifs_dbg(FYI, "new entry %p old entry %p\n", new_entry, old_entry);
505 /* validate that new_entry is not past end of SMB */
506 if (new_entry >= end_of_smb) {
507 cifs_dbg(VFS, "search entry %p began after end of SMB %p old entry %p\n",
508 new_entry, end_of_smb, old_entry);
510 } else if (((level == SMB_FIND_FILE_INFO_STANDARD) &&
511 (new_entry + sizeof(FIND_FILE_STANDARD_INFO) + 1 > end_of_smb))
512 || ((level != SMB_FIND_FILE_INFO_STANDARD) &&
513 (new_entry + sizeof(FILE_DIRECTORY_INFO) + 1 > end_of_smb))) {
514 cifs_dbg(VFS, "search entry %p extends after end of SMB %p\n",
515 new_entry, end_of_smb);
529 static void cifs_fill_dirent_posix(struct cifs_dirent *de,
530 const struct smb2_posix_info *info)
532 struct smb2_posix_info_parsed parsed;
534 /* payload should have already been checked at this point */
535 if (posix_info_parse(info, NULL, &parsed) < 0) {
536 cifs_dbg(VFS, "Invalid POSIX info payload\n");
540 de->name = parsed.name;
541 de->namelen = parsed.name_len;
542 de->resume_key = info->Ignored;
543 de->ino = le64_to_cpu(info->Inode);
546 static void cifs_fill_dirent_unix(struct cifs_dirent *de,
547 const FILE_UNIX_INFO *info, bool is_unicode)
549 de->name = &info->FileName[0];
551 de->namelen = cifs_unicode_bytelen(de->name);
553 de->namelen = strnlen(de->name, PATH_MAX);
554 de->resume_key = info->ResumeKey;
555 de->ino = le64_to_cpu(info->basic.UniqueId);
558 static void cifs_fill_dirent_dir(struct cifs_dirent *de,
559 const FILE_DIRECTORY_INFO *info)
561 de->name = &info->FileName[0];
562 de->namelen = le32_to_cpu(info->FileNameLength);
563 de->resume_key = info->FileIndex;
566 static void cifs_fill_dirent_full(struct cifs_dirent *de,
567 const FILE_FULL_DIRECTORY_INFO *info)
569 de->name = &info->FileName[0];
570 de->namelen = le32_to_cpu(info->FileNameLength);
571 de->resume_key = info->FileIndex;
574 static void cifs_fill_dirent_search(struct cifs_dirent *de,
575 const SEARCH_ID_FULL_DIR_INFO *info)
577 de->name = &info->FileName[0];
578 de->namelen = le32_to_cpu(info->FileNameLength);
579 de->resume_key = info->FileIndex;
580 de->ino = le64_to_cpu(info->UniqueId);
583 static void cifs_fill_dirent_both(struct cifs_dirent *de,
584 const FILE_BOTH_DIRECTORY_INFO *info)
586 de->name = &info->FileName[0];
587 de->namelen = le32_to_cpu(info->FileNameLength);
588 de->resume_key = info->FileIndex;
591 static void cifs_fill_dirent_std(struct cifs_dirent *de,
592 const FIND_FILE_STANDARD_INFO *info)
594 de->name = &info->FileName[0];
595 /* one byte length, no endianess conversion */
596 de->namelen = info->FileNameLength;
597 de->resume_key = info->ResumeKey;
600 static int cifs_fill_dirent(struct cifs_dirent *de, const void *info,
601 u16 level, bool is_unicode)
603 memset(de, 0, sizeof(*de));
606 case SMB_FIND_FILE_POSIX_INFO:
607 cifs_fill_dirent_posix(de, info);
609 case SMB_FIND_FILE_UNIX:
610 cifs_fill_dirent_unix(de, info, is_unicode);
612 case SMB_FIND_FILE_DIRECTORY_INFO:
613 cifs_fill_dirent_dir(de, info);
615 case SMB_FIND_FILE_FULL_DIRECTORY_INFO:
616 cifs_fill_dirent_full(de, info);
618 case SMB_FIND_FILE_ID_FULL_DIR_INFO:
619 cifs_fill_dirent_search(de, info);
621 case SMB_FIND_FILE_BOTH_DIRECTORY_INFO:
622 cifs_fill_dirent_both(de, info);
624 case SMB_FIND_FILE_INFO_STANDARD:
625 cifs_fill_dirent_std(de, info);
628 cifs_dbg(FYI, "Unknown findfirst level %d\n", level);
635 #define UNICODE_DOT cpu_to_le16(0x2e)
637 /* return 0 if no match and 1 for . (current directory) and 2 for .. (parent) */
638 static int cifs_entry_is_dot(struct cifs_dirent *de, bool is_unicode)
646 __le16 *ufilename = (__le16 *)de->name;
647 if (de->namelen == 2) {
649 if (ufilename[0] == UNICODE_DOT)
651 } else if (de->namelen == 4) {
653 if (ufilename[0] == UNICODE_DOT &&
654 ufilename[1] == UNICODE_DOT)
658 if (de->namelen == 1) {
659 if (de->name[0] == '.')
661 } else if (de->namelen == 2) {
662 if (de->name[0] == '.' && de->name[1] == '.')
670 /* Check if directory that we are searching has changed so we can decide
671 whether we can use the cached search results from the previous search */
672 static int is_dir_changed(struct file *file)
674 struct inode *inode = file_inode(file);
675 struct cifsInodeInfo *cifsInfo = CIFS_I(inode);
677 if (cifsInfo->time == 0)
678 return 1; /* directory was changed, perhaps due to unlink */
684 static int cifs_save_resume_key(const char *current_entry,
685 struct cifsFileInfo *file_info)
687 struct cifs_dirent de;
690 rc = cifs_fill_dirent(&de, current_entry, file_info->srch_inf.info_level,
691 file_info->srch_inf.unicode);
693 file_info->srch_inf.presume_name = de.name;
694 file_info->srch_inf.resume_name_len = de.namelen;
695 file_info->srch_inf.resume_key = de.resume_key;
701 * Find the corresponding entry in the search. Note that the SMB server returns
702 * search entries for . and .. which complicates logic here if we choose to
703 * parse for them and we do not assume that they are located in the findfirst
704 * return buffer. We start counting in the buffer with entry 2 and increment for
705 * every entry (do not increment for . or .. entry).
708 find_cifs_entry(const unsigned int xid, struct cifs_tcon *tcon, loff_t pos,
709 struct file *file, const char *full_path,
710 char **current_entry, int *num_to_ret)
715 loff_t first_entry_in_buffer;
716 loff_t index_to_find = pos;
717 struct cifsFileInfo *cfile = file->private_data;
718 struct cifs_sb_info *cifs_sb = CIFS_FILE_SB(file);
719 struct TCP_Server_Info *server = tcon->ses->server;
720 /* check if index in the buffer */
722 if (!server->ops->query_dir_first || !server->ops->query_dir_next)
725 if ((cfile == NULL) || (current_entry == NULL) || (num_to_ret == NULL))
728 *current_entry = NULL;
729 first_entry_in_buffer = cfile->srch_inf.index_of_last_entry -
730 cfile->srch_inf.entries_in_buffer;
733 * If first entry in buf is zero then is first buffer
734 * in search response data which means it is likely . and ..
735 * will be in this buffer, although some servers do not return
736 * . and .. for the root of a drive and for those we need
737 * to start two entries earlier.
740 dump_cifs_file_struct(file, "In fce ");
741 if (((index_to_find < cfile->srch_inf.index_of_last_entry) &&
742 is_dir_changed(file)) || (index_to_find < first_entry_in_buffer)) {
743 /* close and restart search */
744 cifs_dbg(FYI, "search backing up - close and restart search\n");
745 spin_lock(&cfile->file_info_lock);
746 if (server->ops->dir_needs_close(cfile)) {
747 cfile->invalidHandle = true;
748 spin_unlock(&cfile->file_info_lock);
749 if (server->ops->close_dir)
750 server->ops->close_dir(xid, tcon, &cfile->fid);
752 spin_unlock(&cfile->file_info_lock);
753 if (cfile->srch_inf.ntwrk_buf_start) {
754 cifs_dbg(FYI, "freeing SMB ff cache buf on search rewind\n");
755 if (cfile->srch_inf.smallBuf)
756 cifs_small_buf_release(cfile->srch_inf.
759 cifs_buf_release(cfile->srch_inf.
761 cfile->srch_inf.ntwrk_buf_start = NULL;
763 rc = initiate_cifs_search(xid, file, full_path);
765 cifs_dbg(FYI, "error %d reinitiating a search on rewind\n",
769 /* FindFirst/Next set last_entry to NULL on malformed reply */
770 if (cfile->srch_inf.last_entry)
771 cifs_save_resume_key(cfile->srch_inf.last_entry, cfile);
774 search_flags = CIFS_SEARCH_CLOSE_AT_END | CIFS_SEARCH_RETURN_RESUME;
775 if (backup_cred(cifs_sb))
776 search_flags |= CIFS_SEARCH_BACKUP_SEARCH;
778 while ((index_to_find >= cfile->srch_inf.index_of_last_entry) &&
779 (rc == 0) && !cfile->srch_inf.endOfSearch) {
780 cifs_dbg(FYI, "calling findnext2\n");
781 rc = server->ops->query_dir_next(xid, tcon, &cfile->fid,
784 /* FindFirst/Next set last_entry to NULL on malformed reply */
785 if (cfile->srch_inf.last_entry)
786 cifs_save_resume_key(cfile->srch_inf.last_entry, cfile);
790 if (index_to_find < cfile->srch_inf.index_of_last_entry) {
791 /* we found the buffer that contains the entry */
792 /* scan and find it */
797 if (cfile->srch_inf.ntwrk_buf_start == NULL) {
798 cifs_dbg(VFS, "ntwrk_buf_start is NULL during readdir\n");
802 end_of_smb = cfile->srch_inf.ntwrk_buf_start +
803 server->ops->calc_smb_size(
804 cfile->srch_inf.ntwrk_buf_start);
806 cur_ent = cfile->srch_inf.srch_entries_start;
807 first_entry_in_buffer = cfile->srch_inf.index_of_last_entry
808 - cfile->srch_inf.entries_in_buffer;
809 pos_in_buf = index_to_find - first_entry_in_buffer;
810 cifs_dbg(FYI, "found entry - pos_in_buf %d\n", pos_in_buf);
812 for (i = 0; (i < (pos_in_buf)) && (cur_ent != NULL); i++) {
813 /* go entry by entry figuring out which is first */
814 cur_ent = nxt_dir_entry(cur_ent, end_of_smb,
815 cfile->srch_inf.info_level);
817 if ((cur_ent == NULL) && (i < pos_in_buf)) {
818 /* BB fixme - check if we should flag this error */
819 cifs_dbg(VFS, "reached end of buf searching for pos in buf %d index to find %lld rc %d\n",
820 pos_in_buf, index_to_find, rc);
823 *current_entry = cur_ent;
825 cifs_dbg(FYI, "index not in buffer - could not findnext into it\n");
829 if (pos_in_buf >= cfile->srch_inf.entries_in_buffer) {
830 cifs_dbg(FYI, "can not return entries pos_in_buf beyond last\n");
833 *num_to_ret = cfile->srch_inf.entries_in_buffer - pos_in_buf;
838 static bool emit_cached_dirents(struct cached_dirents *cde,
839 struct dir_context *ctx)
841 struct cached_dirent *dirent;
844 list_for_each_entry(dirent, &cde->entries, entry) {
846 * Skip all early entries prior to the current lseek()
849 if (ctx->pos > dirent->pos)
852 * We recorded the current ->pos value for the dirent
853 * when we stored it in the cache.
854 * However, this sequence of ->pos values may have holes
855 * in it, for example dot-dirs returned from the server
857 * Handle this bu forcing ctx->pos to be the same as the
858 * ->pos of the current dirent we emit from the cache.
859 * This means that when we emit these entries from the cache
860 * we now emit them with the same ->pos value as in the
863 ctx->pos = dirent->pos;
864 rc = dir_emit(ctx, dirent->name, dirent->namelen,
865 dirent->fattr.cf_uniqueid,
866 dirent->fattr.cf_dtype);
874 static void update_cached_dirents_count(struct cached_dirents *cde,
875 struct dir_context *ctx)
879 if (cde->is_valid || cde->is_failed)
885 static void finished_cached_dirents_count(struct cached_dirents *cde,
886 struct dir_context *ctx)
890 if (cde->is_valid || cde->is_failed)
892 if (ctx->pos != cde->pos)
898 static void add_cached_dirent(struct cached_dirents *cde,
899 struct dir_context *ctx,
900 const char *name, int namelen,
901 struct cifs_fattr *fattr)
903 struct cached_dirent *de;
907 if (cde->is_valid || cde->is_failed)
909 if (ctx->pos != cde->pos) {
913 de = kzalloc(sizeof(*de), GFP_ATOMIC);
918 de->namelen = namelen;
919 de->name = kstrndup(name, namelen, GFP_ATOMIC);
920 if (de->name == NULL) {
927 memcpy(&de->fattr, fattr, sizeof(struct cifs_fattr));
929 list_add_tail(&de->entry, &cde->entries);
932 static bool cifs_dir_emit(struct dir_context *ctx,
933 const char *name, int namelen,
934 struct cifs_fattr *fattr,
935 struct cached_fid *cfid)
938 ino_t ino = cifs_uniqueid_to_ino_t(fattr->cf_uniqueid);
940 rc = dir_emit(ctx, name, namelen, ino, fattr->cf_dtype);
945 mutex_lock(&cfid->dirents.de_mutex);
946 add_cached_dirent(&cfid->dirents, ctx, name, namelen,
948 mutex_unlock(&cfid->dirents.de_mutex);
954 static int cifs_filldir(char *find_entry, struct file *file,
955 struct dir_context *ctx,
956 char *scratch_buf, unsigned int max_len,
957 struct cached_fid *cfid)
959 struct cifsFileInfo *file_info = file->private_data;
960 struct super_block *sb = file_inode(file)->i_sb;
961 struct cifs_sb_info *cifs_sb = CIFS_SB(sb);
962 struct cifs_dirent de = { NULL, };
963 struct cifs_fattr fattr;
967 rc = cifs_fill_dirent(&de, find_entry, file_info->srch_inf.info_level,
968 file_info->srch_inf.unicode);
972 if (de.namelen > max_len) {
973 cifs_dbg(VFS, "bad search response length %zd past smb end\n",
978 /* skip . and .. since we added them first */
979 if (cifs_entry_is_dot(&de, file_info->srch_inf.unicode))
982 if (file_info->srch_inf.unicode) {
983 struct nls_table *nlt = cifs_sb->local_nls;
986 map_type = cifs_remap(cifs_sb);
987 name.name = scratch_buf;
989 cifs_from_utf16((char *)name.name, (__le16 *)de.name,
991 min_t(size_t, de.namelen,
992 (size_t)max_len), nlt, map_type);
993 name.len -= nls_nullsize(nlt);
996 name.len = de.namelen;
999 switch (file_info->srch_inf.info_level) {
1000 case SMB_FIND_FILE_POSIX_INFO:
1001 cifs_posix_to_fattr(&fattr,
1002 (struct smb2_posix_info *)find_entry,
1005 case SMB_FIND_FILE_UNIX:
1006 cifs_unix_basic_to_fattr(&fattr,
1007 &((FILE_UNIX_INFO *)find_entry)->basic,
1009 if (S_ISLNK(fattr.cf_mode))
1010 fattr.cf_flags |= CIFS_FATTR_NEED_REVAL;
1012 case SMB_FIND_FILE_INFO_STANDARD:
1013 cifs_std_info_to_fattr(&fattr,
1014 (FIND_FILE_STANDARD_INFO *)find_entry,
1017 case SMB_FIND_FILE_ID_FULL_DIR_INFO:
1018 cifs_fulldir_info_to_fattr(&fattr,
1019 (SEARCH_ID_FULL_DIR_INFO *)find_entry,
1023 cifs_dir_info_to_fattr(&fattr,
1024 (FILE_DIRECTORY_INFO *)find_entry,
1029 if (de.ino && (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM)) {
1030 fattr.cf_uniqueid = de.ino;
1032 fattr.cf_uniqueid = iunique(sb, ROOT_I);
1033 cifs_autodisable_serverino(cifs_sb);
1036 if ((cifs_sb->mnt_cifs_flags & CIFS_MOUNT_MF_SYMLINKS) &&
1037 couldbe_mf_symlink(&fattr))
1039 * trying to get the type and mode can be slow,
1040 * so just call those regular files for now, and mark
1043 fattr.cf_flags |= CIFS_FATTR_NEED_REVAL;
1045 cifs_prime_dcache(file_dentry(file), &name, &fattr);
1047 return !cifs_dir_emit(ctx, name.name, name.len,
1052 int cifs_readdir(struct file *file, struct dir_context *ctx)
1057 struct tcon_link *tlink = NULL;
1058 struct cifs_tcon *tcon;
1059 struct cifsFileInfo *cifsFile;
1060 char *current_entry;
1061 int num_to_fill = 0;
1062 char *tmp_buf = NULL;
1064 unsigned int max_len;
1065 const char *full_path;
1066 void *page = alloc_dentry_path();
1067 struct cached_fid *cfid = NULL;
1068 struct cifs_sb_info *cifs_sb = CIFS_FILE_SB(file);
1072 full_path = build_path_from_dentry(file_dentry(file), page);
1073 if (IS_ERR(full_path)) {
1074 rc = PTR_ERR(full_path);
1078 if (file->private_data == NULL) {
1079 tlink = cifs_sb_tlink(cifs_sb);
1081 goto cache_not_found;
1082 tcon = tlink_tcon(tlink);
1084 cifsFile = file->private_data;
1085 tcon = tlink_tcon(cifsFile->tlink);
1088 rc = open_cached_dir(xid, tcon, full_path, cifs_sb, false, &cfid);
1089 cifs_put_tlink(tlink);
1091 goto cache_not_found;
1093 mutex_lock(&cfid->dirents.de_mutex);
1095 * If this was reading from the start of the directory
1096 * we need to initialize scanning and storing the
1097 * directory content.
1099 if (ctx->pos == 0 && cfid->dirents.ctx == NULL) {
1100 cfid->dirents.ctx = ctx;
1101 cfid->dirents.pos = 2;
1104 * If we already have the entire directory cached then
1105 * we can just serve the cache.
1107 if (cfid->dirents.is_valid) {
1108 if (!dir_emit_dots(file, ctx)) {
1109 mutex_unlock(&cfid->dirents.de_mutex);
1112 emit_cached_dirents(&cfid->dirents, ctx);
1113 mutex_unlock(&cfid->dirents.de_mutex);
1116 mutex_unlock(&cfid->dirents.de_mutex);
1118 /* Drop the cache while calling initiate_cifs_search and
1119 * find_cifs_entry in case there will be reconnects during
1122 close_cached_dir(cfid);
1127 * Ensure FindFirst doesn't fail before doing filldir() for '.' and
1128 * '..'. Otherwise we won't be able to notify VFS in case of failure.
1130 if (file->private_data == NULL) {
1131 rc = initiate_cifs_search(xid, file, full_path);
1132 cifs_dbg(FYI, "initiate cifs search rc %d\n", rc);
1137 if (!dir_emit_dots(file, ctx))
1140 /* 1) If search is active,
1141 is in current search buffer?
1142 if it before then restart search
1143 if after then keep searching till find it */
1144 cifsFile = file->private_data;
1145 if (cifsFile->srch_inf.endOfSearch) {
1146 if (cifsFile->srch_inf.emptyDir) {
1147 cifs_dbg(FYI, "End of search, empty dir\n");
1152 cifsFile->invalidHandle = true;
1153 tcon->ses->server->close(xid, tcon, &cifsFile->fid);
1156 tcon = tlink_tcon(cifsFile->tlink);
1157 rc = find_cifs_entry(xid, tcon, ctx->pos, file, full_path,
1158 ¤t_entry, &num_to_fill);
1159 open_cached_dir(xid, tcon, full_path, cifs_sb, false, &cfid);
1161 cifs_dbg(FYI, "fce error %d\n", rc);
1163 } else if (current_entry != NULL) {
1164 cifs_dbg(FYI, "entry %lld found\n", ctx->pos);
1167 mutex_lock(&cfid->dirents.de_mutex);
1168 finished_cached_dirents_count(&cfid->dirents, ctx);
1169 mutex_unlock(&cfid->dirents.de_mutex);
1171 cifs_dbg(FYI, "Could not find entry\n");
1174 cifs_dbg(FYI, "loop through %d times filling dir for net buf %p\n",
1175 num_to_fill, cifsFile->srch_inf.ntwrk_buf_start);
1176 max_len = tcon->ses->server->ops->calc_smb_size(
1177 cifsFile->srch_inf.ntwrk_buf_start);
1178 end_of_smb = cifsFile->srch_inf.ntwrk_buf_start + max_len;
1180 tmp_buf = kmalloc(UNICODE_NAME_MAX, GFP_KERNEL);
1181 if (tmp_buf == NULL) {
1186 for (i = 0; i < num_to_fill; i++) {
1187 if (current_entry == NULL) {
1188 /* evaluate whether this case is an error */
1189 cifs_dbg(VFS, "past SMB end, num to fill %d i %d\n",
1194 * if buggy server returns . and .. late do we want to
1195 * check for that here?
1198 rc = cifs_filldir(current_entry, file, ctx,
1199 tmp_buf, max_len, cfid);
1208 mutex_lock(&cfid->dirents.de_mutex);
1209 update_cached_dirents_count(&cfid->dirents, ctx);
1210 mutex_unlock(&cfid->dirents.de_mutex);
1214 cifsFile->srch_inf.index_of_last_entry) {
1215 cifs_dbg(FYI, "last entry in buf at pos %lld %s\n",
1217 cifs_save_resume_key(current_entry, cifsFile);
1221 nxt_dir_entry(current_entry, end_of_smb,
1222 cifsFile->srch_inf.info_level);
1228 close_cached_dir(cfid);
1229 free_dentry_path(page);