fs/cifs/readdir.c

   1 // SPDX-License-Identifier: LGPL-2.1
   2 /*
   3  *   fs/cifs/readdir.c
   4  *
   5  *   Directory search handling
   6  *
   7  *   Copyright (C) International Business Machines  Corp., 2004, 2008
   8  *   Copyright (C) Red Hat, Inc., 2011
   9  *   Author(s): Steve French ([email protected])
  10  *
  11  */
  12 #include <linux/fs.h>
  13 #include <linux/pagemap.h>
  14 #include <linux/slab.h>
  15 #include <linux/stat.h>
  16 #include "cifspdu.h"
  17 #include "cifsglob.h"
  18 #include "cifsproto.h"
  19 #include "cifs_unicode.h"
  20 #include "cifs_debug.h"
  21 #include "cifs_fs_sb.h"
  22 #include "cifsfs.h"
  23 #include "smb2proto.h"
  24 #include "fs_context.h"
  25
  26 /*
  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
  29  * characters.
  30  */
  31 #define UNICODE_NAME_MAX ((4 * NAME_MAX) + 2)
  32
  33 #ifdef CONFIG_CIFS_DEBUG2
  34 static void dump_cifs_file_struct(struct file *file, char *label)
  35 {
  36         struct cifsFileInfo *cf;
  37
  38         if (file) {
  39                 cf = file->private_data;
  40                 if (cf == NULL) {
  41                         cifs_dbg(FYI, "empty cifs private file data\n");
  42                         return;
  43                 }
  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");
  50         }
  51 }
  52 #else
  53 static inline void dump_cifs_file_struct(struct file *file, char *label)
  54 {
  55 }
  56 #endif /* DEBUG2 */
  57
  58 /*
  59  * Attempt to preload the dcache with the results from the FIND_FIRST/NEXT
  60  *
  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.
  64  */
  65 static void
  66 cifs_prime_dcache(struct dentry *parent, struct qstr *name,
  67                     struct cifs_fattr *fattr)
  68 {
  69         struct dentry *dentry, *alias;
  70         struct inode *inode;
  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);
  74
  75         cifs_dbg(FYI, "%s: for %s\n", __func__, name->name);
  76
  77         dentry = d_hash_and_lookup(parent, name);
  78         if (!dentry) {
  79                 /*
  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.
  84                  */
  85                 if (fattr->cf_flags & CIFS_FATTR_NEED_REVAL)
  86                         return;
  87 retry:
  88                 dentry = d_alloc_parallel(parent, name, &wq);
  89         }
  90         if (IS_ERR(dentry))
  91                 return;
  92         if (!d_in_lookup(dentry)) {
  93                 inode = d_inode(dentry);
  94                 if (inode) {
  95                         if (d_mountpoint(dentry)) {
  96                                 dput(dentry);
  97                                 return;
  98                         }
  99                         /*
 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.
 103                          */
 104                         if (!(cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM))
 105                                 fattr->cf_uniqueid = CIFS_I(inode)->uniqueid;
 106
 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) {
 111                                 dput(dentry);
 112                                 return;
 113                         }
 114                 }
 115                 d_invalidate(dentry);
 116                 dput(dentry);
 117                 goto retry;
 118         } else {
 119                 inode = cifs_iget(sb, fattr);
 120                 if (!inode)
 121                         inode = ERR_PTR(-ENOMEM);
 122                 alias = d_splice_alias(inode, dentry);
 123                 d_lookup_done(dentry);
 124                 if (alias && !IS_ERR(alias))
 125                         dput(alias);
 126         }
 127         dput(dentry);
 128 }
 129
 130 static bool reparse_file_needs_reval(const struct cifs_fattr *fattr)
 131 {
 132         if (!(fattr->cf_cifsattrs & ATTR_REPARSE))
 133                 return false;
 134         /*
 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.
 137          *
 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.
 140          */
 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 0:
 147                 return true;
 148         }
 149         return false;
 150 }
 151
 152 static void
 153 cifs_fill_common_info(struct cifs_fattr *fattr, struct cifs_sb_info *cifs_sb)
 154 {
 155         fattr->cf_uid = cifs_sb->ctx->linux_uid;
 156         fattr->cf_gid = cifs_sb->ctx->linux_gid;
 157
 158         /*
 159          * The IO_REPARSE_TAG_LX_ tags originally were used by WSL but they
 160          * are preferred by the Linux client in some cases since, unlike
 161          * the NFS reparse tag (or EAs), they don't require an extra query
 162          * to determine which type of special file they represent.
 163          * TODO: go through all documented  reparse tags to see if we can
 164          * reasonably map some of them to directories vs. files vs. symlinks
 165          */
 166         if (fattr->cf_cifsattrs & ATTR_DIRECTORY) {
 167                 fattr->cf_mode = S_IFDIR | cifs_sb->ctx->dir_mode;
 168                 fattr->cf_dtype = DT_DIR;
 169         } else if (fattr->cf_cifstag == IO_REPARSE_TAG_LX_SYMLINK) {
 170                 fattr->cf_mode |= S_IFLNK | cifs_sb->ctx->file_mode;
 171                 fattr->cf_dtype = DT_LNK;
 172         } else if (fattr->cf_cifstag == IO_REPARSE_TAG_LX_FIFO) {
 173                 fattr->cf_mode |= S_IFIFO | cifs_sb->ctx->file_mode;
 174                 fattr->cf_dtype = DT_FIFO;
 175         } else if (fattr->cf_cifstag == IO_REPARSE_TAG_AF_UNIX) {
 176                 fattr->cf_mode |= S_IFSOCK | cifs_sb->ctx->file_mode;
 177                 fattr->cf_dtype = DT_SOCK;
 178         } else if (fattr->cf_cifstag == IO_REPARSE_TAG_LX_CHR) {
 179                 fattr->cf_mode |= S_IFCHR | cifs_sb->ctx->file_mode;
 180                 fattr->cf_dtype = DT_CHR;
 181         } else if (fattr->cf_cifstag == IO_REPARSE_TAG_LX_BLK) {
 182                 fattr->cf_mode |= S_IFBLK | cifs_sb->ctx->file_mode;
 183                 fattr->cf_dtype = DT_BLK;
 184         } else { /* TODO: should we mark some other reparse points (like DFSR) as directories? */
 185                 fattr->cf_mode = S_IFREG | cifs_sb->ctx->file_mode;
 186                 fattr->cf_dtype = DT_REG;
 187         }
 188
 189         /*
 190          * We need to revalidate it further to make a decision about whether it
 191          * is a symbolic link, DFS referral or a reparse point with a direct
 192          * access like junctions, deduplicated files, NFS symlinks.
 193          */
 194         if (reparse_file_needs_reval(fattr))
 195                 fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
 196
 197         /* non-unix readdir doesn't provide nlink */
 198         fattr->cf_flags |= CIFS_FATTR_UNKNOWN_NLINK;
 199
 200         if (fattr->cf_cifsattrs & ATTR_READONLY)
 201                 fattr->cf_mode &= ~S_IWUGO;
 202
 203         /*
 204          * We of course don't get ACL info in FIND_FIRST/NEXT results, so
 205          * mark it for revalidation so that "ls -l" will look right. It might
 206          * be super-slow, but if we don't do this then the ownership of files
 207          * may look wrong since the inodes may not have timed out by the time
 208          * "ls" does a stat() call on them.
 209          */
 210         if ((cifs_sb->mnt_cifs_flags & CIFS_MOUNT_CIFS_ACL) ||
 211             (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_MODE_FROM_SID))
 212                 fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
 213
 214         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_UNX_EMUL &&
 215             fattr->cf_cifsattrs & ATTR_SYSTEM) {
 216                 if (fattr->cf_eof == 0)  {
 217                         fattr->cf_mode &= ~S_IFMT;
 218                         fattr->cf_mode |= S_IFIFO;
 219                         fattr->cf_dtype = DT_FIFO;
 220                 } else {
 221                         /*
 222                          * trying to get the type and mode via SFU can be slow,
 223                          * so just call those regular files for now, and mark
 224                          * for reval
 225                          */
 226                         fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
 227                 }
 228         }
 229 }
 230
 231 /* Fill a cifs_fattr struct with info from SMB_FIND_FILE_POSIX_INFO. */
 232 static void
 233 cifs_posix_to_fattr(struct cifs_fattr *fattr, struct smb2_posix_info *info,
 234                     struct cifs_sb_info *cifs_sb)
 235 {
 236         struct smb2_posix_info_parsed parsed;
 237
 238         posix_info_parse(info, NULL, &parsed);
 239
 240         memset(fattr, 0, sizeof(*fattr));
 241         fattr->cf_uniqueid = le64_to_cpu(info->Inode);
 242         fattr->cf_bytes = le64_to_cpu(info->AllocationSize);
 243         fattr->cf_eof = le64_to_cpu(info->EndOfFile);
 244
 245         fattr->cf_atime = cifs_NTtimeToUnix(info->LastAccessTime);
 246         fattr->cf_mtime = cifs_NTtimeToUnix(info->LastWriteTime);
 247         fattr->cf_ctime = cifs_NTtimeToUnix(info->CreationTime);
 248
 249         fattr->cf_nlink = le32_to_cpu(info->HardLinks);
 250         fattr->cf_cifsattrs = le32_to_cpu(info->DosAttributes);
 251
 252         /*
 253          * Since we set the inode type below we need to mask off
 254          * to avoid strange results if bits set above.
 255          * XXX: why not make server&client use the type bits?
 256          */
 257         fattr->cf_mode = le32_to_cpu(info->Mode) & ~S_IFMT;
 258
 259         cifs_dbg(FYI, "posix fattr: dev %d, reparse %d, mode %o\n",
 260                  le32_to_cpu(info->DeviceId),
 261                  le32_to_cpu(info->ReparseTag),
 262                  le32_to_cpu(info->Mode));
 263
 264         if (fattr->cf_cifsattrs & ATTR_DIRECTORY) {
 265                 fattr->cf_mode |= S_IFDIR;
 266                 fattr->cf_dtype = DT_DIR;
 267         } else {
 268                 /*
 269                  * mark anything that is not a dir as regular
 270                  * file. special files should have the REPARSE
 271                  * attribute and will be marked as needing revaluation
 272                  */
 273                 fattr->cf_mode |= S_IFREG;
 274                 fattr->cf_dtype = DT_REG;
 275         }
 276
 277         if (reparse_file_needs_reval(fattr))
 278                 fattr->cf_flags |= CIFS_FATTR_NEED_REVAL;
 279
 280         sid_to_id(cifs_sb, &parsed.owner, fattr, SIDOWNER);
 281         sid_to_id(cifs_sb, &parsed.group, fattr, SIDGROUP);
 282 }
 283
 284 static void __dir_info_to_fattr(struct cifs_fattr *fattr, const void *info)
 285 {
 286         const FILE_DIRECTORY_INFO *fi = info;
 287
 288         memset(fattr, 0, sizeof(*fattr));
 289         fattr->cf_cifsattrs = le32_to_cpu(fi->ExtFileAttributes);
 290         fattr->cf_eof = le64_to_cpu(fi->EndOfFile);
 291         fattr->cf_bytes = le64_to_cpu(fi->AllocationSize);
 292         fattr->cf_createtime = le64_to_cpu(fi->CreationTime);
 293         fattr->cf_atime = cifs_NTtimeToUnix(fi->LastAccessTime);
 294         fattr->cf_ctime = cifs_NTtimeToUnix(fi->ChangeTime);
 295         fattr->cf_mtime = cifs_NTtimeToUnix(fi->LastWriteTime);
 296 }
 297
 298 void
 299 cifs_dir_info_to_fattr(struct cifs_fattr *fattr, FILE_DIRECTORY_INFO *info,
 300                        struct cifs_sb_info *cifs_sb)
 301 {
 302         __dir_info_to_fattr(fattr, info);
 303         cifs_fill_common_info(fattr, cifs_sb);
 304 }
 305
 306 static void cifs_fulldir_info_to_fattr(struct cifs_fattr *fattr,
 307                                        SEARCH_ID_FULL_DIR_INFO *info,
 308                                        struct cifs_sb_info *cifs_sb)
 309 {
 310         __dir_info_to_fattr(fattr, info);
 311
 312         /* See MS-FSCC 2.4.19 FileIdFullDirectoryInformation */
 313         if (fattr->cf_cifsattrs & ATTR_REPARSE)
 314                 fattr->cf_cifstag = le32_to_cpu(info->EaSize);
 315         cifs_fill_common_info(fattr, cifs_sb);
 316 }
 317
 318 static void
 319 cifs_std_info_to_fattr(struct cifs_fattr *fattr, FIND_FILE_STANDARD_INFO *info,
 320                        struct cifs_sb_info *cifs_sb)
 321 {
 322         int offset = cifs_sb_master_tcon(cifs_sb)->ses->server->timeAdj;
 323
 324         memset(fattr, 0, sizeof(*fattr));
 325         fattr->cf_atime = cnvrtDosUnixTm(info->LastAccessDate,
 326                                             info->LastAccessTime, offset);
 327         fattr->cf_ctime = cnvrtDosUnixTm(info->LastWriteDate,
 328                                             info->LastWriteTime, offset);
 329         fattr->cf_mtime = cnvrtDosUnixTm(info->LastWriteDate,
 330                                             info->LastWriteTime, offset);
 331
 332         fattr->cf_cifsattrs = le16_to_cpu(info->Attributes);
 333         fattr->cf_bytes = le32_to_cpu(info->AllocationSize);
 334         fattr->cf_eof = le32_to_cpu(info->DataSize);
 335
 336         cifs_fill_common_info(fattr, cifs_sb);
 337 }
 338
 339 /* BB eventually need to add the following helper function to
 340       resolve NT_STATUS_STOPPED_ON_SYMLINK return code when
 341       we try to do FindFirst on (NTFS) directory symlinks */
 342 /*
 343 int get_symlink_reparse_path(char *full_path, struct cifs_sb_info *cifs_sb,
 344                              unsigned int xid)
 345 {
 346         __u16 fid;
 347         int len;
 348         int oplock = 0;
 349         int rc;
 350         struct cifs_tcon *ptcon = cifs_sb_tcon(cifs_sb);
 351         char *tmpbuffer;
 352
 353         rc = CIFSSMBOpen(xid, ptcon, full_path, FILE_OPEN, GENERIC_READ,
 354                         OPEN_REPARSE_POINT, &fid, &oplock, NULL,
 355                         cifs_sb->local_nls,
 356                         cifs_remap(cifs_sb);
 357         if (!rc) {
 358                 tmpbuffer = kmalloc(maxpath);
 359                 rc = CIFSSMBQueryReparseLinkInfo(xid, ptcon, full_path,
 360                                 tmpbuffer,
 361                                 maxpath -1,
 362                                 fid,
 363                                 cifs_sb->local_nls);
 364                 if (CIFSSMBClose(xid, ptcon, fid)) {
 365                         cifs_dbg(FYI, "Error closing temporary reparsepoint open\n");
 366                 }
 367         }
 368 }
 369  */
 370
 371 static int
 372 initiate_cifs_search(const unsigned int xid, struct file *file,
 373                      const char *full_path)
 374 {
 375         __u16 search_flags;
 376         int rc = 0;
 377         struct cifsFileInfo *cifsFile;
 378         struct cifs_sb_info *cifs_sb = CIFS_FILE_SB(file);
 379         struct tcon_link *tlink = NULL;
 380         struct cifs_tcon *tcon;
 381         struct TCP_Server_Info *server;
 382
 383         if (file->private_data == NULL) {
 384                 tlink = cifs_sb_tlink(cifs_sb);
 385                 if (IS_ERR(tlink))
 386                         return PTR_ERR(tlink);
 387
 388                 cifsFile = kzalloc(sizeof(struct cifsFileInfo), GFP_KERNEL);
 389                 if (cifsFile == NULL) {
 390                         rc = -ENOMEM;
 391                         goto error_exit;
 392                 }
 393                 spin_lock_init(&cifsFile->file_info_lock);
 394                 file->private_data = cifsFile;
 395                 cifsFile->tlink = cifs_get_tlink(tlink);
 396                 tcon = tlink_tcon(tlink);
 397         } else {
 398                 cifsFile = file->private_data;
 399                 tcon = tlink_tcon(cifsFile->tlink);
 400         }
 401
 402         server = tcon->ses->server;
 403
 404         if (!server->ops->query_dir_first) {
 405                 rc = -ENOSYS;
 406                 goto error_exit;
 407         }
 408
 409         cifsFile->invalidHandle = true;
 410         cifsFile->srch_inf.endOfSearch = false;
 411
 412         cifs_dbg(FYI, "Full path: %s start at: %lld\n", full_path, file->f_pos);
 413
 414 ffirst_retry:
 415         /* test for Unix extensions */
 416         /* but now check for them on the share/mount not on the SMB session */
 417         /* if (cap_unix(tcon->ses) { */
 418         if (tcon->unix_ext)
 419                 cifsFile->srch_inf.info_level = SMB_FIND_FILE_UNIX;
 420         else if (tcon->posix_extensions)
 421                 cifsFile->srch_inf.info_level = SMB_FIND_FILE_POSIX_INFO;
 422         else if ((tcon->ses->capabilities &
 423                   tcon->ses->server->vals->cap_nt_find) == 0) {
 424                 cifsFile->srch_inf.info_level = SMB_FIND_FILE_INFO_STANDARD;
 425         } else if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM) {
 426                 cifsFile->srch_inf.info_level = SMB_FIND_FILE_ID_FULL_DIR_INFO;
 427         } else /* not srvinos - BB fixme add check for backlevel? */ {
 428                 cifsFile->srch_inf.info_level = SMB_FIND_FILE_DIRECTORY_INFO;
 429         }
 430
 431         search_flags = CIFS_SEARCH_CLOSE_AT_END | CIFS_SEARCH_RETURN_RESUME;
 432         if (backup_cred(cifs_sb))
 433                 search_flags |= CIFS_SEARCH_BACKUP_SEARCH;
 434
 435         rc = server->ops->query_dir_first(xid, tcon, full_path, cifs_sb,
 436                                           &cifsFile->fid, search_flags,
 437                                           &cifsFile->srch_inf);
 438
 439         if (rc == 0)
 440                 cifsFile->invalidHandle = false;
 441         /* BB add following call to handle readdir on new NTFS symlink errors
 442         else if STATUS_STOPPED_ON_SYMLINK
 443                 call get_symlink_reparse_path and retry with new path */
 444         else if ((rc == -EOPNOTSUPP) &&
 445                 (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM)) {
 446                 cifs_sb->mnt_cifs_flags &= ~CIFS_MOUNT_SERVER_INUM;
 447                 goto ffirst_retry;
 448         }
 449 error_exit:
 450         cifs_put_tlink(tlink);
 451         return rc;
 452 }
 453
 454 /* return length of unicode string in bytes */
 455 static int cifs_unicode_bytelen(const char *str)
 456 {
 457         int len;
 458         const __le16 *ustr = (const __le16 *)str;
 459
 460         for (len = 0; len <= PATH_MAX; len++) {
 461                 if (ustr[len] == 0)
 462                         return len << 1;
 463         }
 464         cifs_dbg(FYI, "Unicode string longer than PATH_MAX found\n");
 465         return len << 1;
 466 }
 467
 468 static char *nxt_dir_entry(char *old_entry, char *end_of_smb, int level)
 469 {
 470         char *new_entry;
 471         FILE_DIRECTORY_INFO *pDirInfo = (FILE_DIRECTORY_INFO *)old_entry;
 472
 473         if (level == SMB_FIND_FILE_INFO_STANDARD) {
 474                 FIND_FILE_STANDARD_INFO *pfData;
 475                 pfData = (FIND_FILE_STANDARD_INFO *)pDirInfo;
 476
 477                 new_entry = old_entry + sizeof(FIND_FILE_STANDARD_INFO) +
 478                                 pfData->FileNameLength;
 479         } else {
 480                 u32 next_offset = le32_to_cpu(pDirInfo->NextEntryOffset);
 481
 482                 if (old_entry + next_offset < old_entry) {
 483                         cifs_dbg(VFS, "Invalid offset %u\n", next_offset);
 484                         return NULL;
 485                 }
 486                 new_entry = old_entry + next_offset;
 487         }
 488         cifs_dbg(FYI, "new entry %p old entry %p\n", new_entry, old_entry);
 489         /* validate that new_entry is not past end of SMB */
 490         if (new_entry >= end_of_smb) {
 491                 cifs_dbg(VFS, "search entry %p began after end of SMB %p old entry %p\n",
 492                          new_entry, end_of_smb, old_entry);
 493                 return NULL;
 494         } else if (((level == SMB_FIND_FILE_INFO_STANDARD) &&
 495                     (new_entry + sizeof(FIND_FILE_STANDARD_INFO) > end_of_smb))
 496                   || ((level != SMB_FIND_FILE_INFO_STANDARD) &&
 497                    (new_entry + sizeof(FILE_DIRECTORY_INFO) > end_of_smb)))  {
 498                 cifs_dbg(VFS, "search entry %p extends after end of SMB %p\n",
 499                          new_entry, end_of_smb);
 500                 return NULL;
 501         } else
 502                 return new_entry;
 503
 504 }
 505
 506 struct cifs_dirent {
 507         const char      *name;
 508         size_t          namelen;
 509         u32             resume_key;
 510         u64             ino;
 511 };
 512
 513 static void cifs_fill_dirent_posix(struct cifs_dirent *de,
 514                                    const struct smb2_posix_info *info)
 515 {
 516         struct smb2_posix_info_parsed parsed;
 517
 518         /* payload should have already been checked at this point */
 519         if (posix_info_parse(info, NULL, &parsed) < 0) {
 520                 cifs_dbg(VFS, "Invalid POSIX info payload\n");
 521                 return;
 522         }
 523
 524         de->name = parsed.name;
 525         de->namelen = parsed.name_len;
 526         de->resume_key = info->Ignored;
 527         de->ino = le64_to_cpu(info->Inode);
 528 }
 529
 530 static void cifs_fill_dirent_unix(struct cifs_dirent *de,
 531                 const FILE_UNIX_INFO *info, bool is_unicode)
 532 {
 533         de->name = &info->FileName[0];
 534         if (is_unicode)
 535                 de->namelen = cifs_unicode_bytelen(de->name);
 536         else
 537                 de->namelen = strnlen(de->name, PATH_MAX);
 538         de->resume_key = info->ResumeKey;
 539         de->ino = le64_to_cpu(info->basic.UniqueId);
 540 }
 541
 542 static void cifs_fill_dirent_dir(struct cifs_dirent *de,
 543                 const FILE_DIRECTORY_INFO *info)
 544 {
 545         de->name = &info->FileName[0];
 546         de->namelen = le32_to_cpu(info->FileNameLength);
 547         de->resume_key = info->FileIndex;
 548 }
 549
 550 static void cifs_fill_dirent_full(struct cifs_dirent *de,
 551                 const FILE_FULL_DIRECTORY_INFO *info)
 552 {
 553         de->name = &info->FileName[0];
 554         de->namelen = le32_to_cpu(info->FileNameLength);
 555         de->resume_key = info->FileIndex;
 556 }
 557
 558 static void cifs_fill_dirent_search(struct cifs_dirent *de,
 559                 const SEARCH_ID_FULL_DIR_INFO *info)
 560 {
 561         de->name = &info->FileName[0];
 562         de->namelen = le32_to_cpu(info->FileNameLength);
 563         de->resume_key = info->FileIndex;
 564         de->ino = le64_to_cpu(info->UniqueId);
 565 }
 566
 567 static void cifs_fill_dirent_both(struct cifs_dirent *de,
 568                 const FILE_BOTH_DIRECTORY_INFO *info)
 569 {
 570         de->name = &info->FileName[0];
 571         de->namelen = le32_to_cpu(info->FileNameLength);
 572         de->resume_key = info->FileIndex;
 573 }
 574
 575 static void cifs_fill_dirent_std(struct cifs_dirent *de,
 576                 const FIND_FILE_STANDARD_INFO *info)
 577 {
 578         de->name = &info->FileName[0];
 579         /* one byte length, no endianess conversion */
 580         de->namelen = info->FileNameLength;
 581         de->resume_key = info->ResumeKey;
 582 }
 583
 584 static int cifs_fill_dirent(struct cifs_dirent *de, const void *info,
 585                 u16 level, bool is_unicode)
 586 {
 587         memset(de, 0, sizeof(*de));
 588
 589         switch (level) {
 590         case SMB_FIND_FILE_POSIX_INFO:
 591                 cifs_fill_dirent_posix(de, info);
 592                 break;
 593         case SMB_FIND_FILE_UNIX:
 594                 cifs_fill_dirent_unix(de, info, is_unicode);
 595                 break;
 596         case SMB_FIND_FILE_DIRECTORY_INFO:
 597                 cifs_fill_dirent_dir(de, info);
 598                 break;
 599         case SMB_FIND_FILE_FULL_DIRECTORY_INFO:
 600                 cifs_fill_dirent_full(de, info);
 601                 break;
 602         case SMB_FIND_FILE_ID_FULL_DIR_INFO:
 603                 cifs_fill_dirent_search(de, info);
 604                 break;
 605         case SMB_FIND_FILE_BOTH_DIRECTORY_INFO:
 606                 cifs_fill_dirent_both(de, info);
 607                 break;
 608         case SMB_FIND_FILE_INFO_STANDARD:
 609                 cifs_fill_dirent_std(de, info);
 610                 break;
 611         default:
 612                 cifs_dbg(FYI, "Unknown findfirst level %d\n", level);
 613                 return -EINVAL;
 614         }
 615
 616         return 0;
 617 }
 618
 619 #define UNICODE_DOT cpu_to_le16(0x2e)
 620
 621 /* return 0 if no match and 1 for . (current directory) and 2 for .. (parent) */
 622 static int cifs_entry_is_dot(struct cifs_dirent *de, bool is_unicode)
 623 {
 624         int rc = 0;
 625
 626         if (!de->name)
 627                 return 0;
 628
 629         if (is_unicode) {
 630                 __le16 *ufilename = (__le16 *)de->name;
 631                 if (de->namelen == 2) {
 632                         /* check for . */
 633                         if (ufilename[0] == UNICODE_DOT)
 634                                 rc = 1;
 635                 } else if (de->namelen == 4) {
 636                         /* check for .. */
 637                         if (ufilename[0] == UNICODE_DOT &&
 638                             ufilename[1] == UNICODE_DOT)
 639                                 rc = 2;
 640                 }
 641         } else /* ASCII */ {
 642                 if (de->namelen == 1) {
 643                         if (de->name[0] == '.')
 644                                 rc = 1;
 645                 } else if (de->namelen == 2) {
 646                         if (de->name[0] == '.' && de->name[1] == '.')
 647                                 rc = 2;
 648                 }
 649         }
 650
 651         return rc;
 652 }
 653
 654 /* Check if directory that we are searching has changed so we can decide
 655    whether we can use the cached search results from the previous search */
 656 static int is_dir_changed(struct file *file)
 657 {
 658         struct inode *inode = file_inode(file);
 659         struct cifsInodeInfo *cifsInfo = CIFS_I(inode);
 660
 661         if (cifsInfo->time == 0)
 662                 return 1; /* directory was changed, perhaps due to unlink */
 663         else
 664                 return 0;
 665
 666 }
 667
 668 static int cifs_save_resume_key(const char *current_entry,
 669         struct cifsFileInfo *file_info)
 670 {
 671         struct cifs_dirent de;
 672         int rc;
 673
 674         rc = cifs_fill_dirent(&de, current_entry, file_info->srch_inf.info_level,
 675                               file_info->srch_inf.unicode);
 676         if (!rc) {
 677                 file_info->srch_inf.presume_name = de.name;
 678                 file_info->srch_inf.resume_name_len = de.namelen;
 679                 file_info->srch_inf.resume_key = de.resume_key;
 680         }
 681         return rc;
 682 }
 683
 684 /*
 685  * Find the corresponding entry in the search. Note that the SMB server returns
 686  * search entries for . and .. which complicates logic here if we choose to
 687  * parse for them and we do not assume that they are located in the findfirst
 688  * return buffer. We start counting in the buffer with entry 2 and increment for
 689  * every entry (do not increment for . or .. entry).
 690  */
 691 static int
 692 find_cifs_entry(const unsigned int xid, struct cifs_tcon *tcon, loff_t pos,
 693                 struct file *file, const char *full_path,
 694                 char **current_entry, int *num_to_ret)
 695 {
 696         __u16 search_flags;
 697         int rc = 0;
 698         int pos_in_buf = 0;
 699         loff_t first_entry_in_buffer;
 700         loff_t index_to_find = pos;
 701         struct cifsFileInfo *cfile = file->private_data;
 702         struct cifs_sb_info *cifs_sb = CIFS_FILE_SB(file);
 703         struct TCP_Server_Info *server = tcon->ses->server;
 704         /* check if index in the buffer */
 705
 706         if (!server->ops->query_dir_first || !server->ops->query_dir_next)
 707                 return -ENOSYS;
 708
 709         if ((cfile == NULL) || (current_entry == NULL) || (num_to_ret == NULL))
 710                 return -ENOENT;
 711
 712         *current_entry = NULL;
 713         first_entry_in_buffer = cfile->srch_inf.index_of_last_entry -
 714                                         cfile->srch_inf.entries_in_buffer;
 715
 716         /*
 717          * If first entry in buf is zero then is first buffer
 718          * in search response data which means it is likely . and ..
 719          * will be in this buffer, although some servers do not return
 720          * . and .. for the root of a drive and for those we need
 721          * to start two entries earlier.
 722          */
 723
 724         dump_cifs_file_struct(file, "In fce ");
 725         if (((index_to_find < cfile->srch_inf.index_of_last_entry) &&
 726              is_dir_changed(file)) || (index_to_find < first_entry_in_buffer)) {
 727                 /* close and restart search */
 728                 cifs_dbg(FYI, "search backing up - close and restart search\n");
 729                 spin_lock(&cfile->file_info_lock);
 730                 if (server->ops->dir_needs_close(cfile)) {
 731                         cfile->invalidHandle = true;
 732                         spin_unlock(&cfile->file_info_lock);
 733                         if (server->ops->close_dir)
 734                                 server->ops->close_dir(xid, tcon, &cfile->fid);
 735                 } else
 736                         spin_unlock(&cfile->file_info_lock);
 737                 if (cfile->srch_inf.ntwrk_buf_start) {
 738                         cifs_dbg(FYI, "freeing SMB ff cache buf on search rewind\n");
 739                         if (cfile->srch_inf.smallBuf)
 740                                 cifs_small_buf_release(cfile->srch_inf.
 741                                                 ntwrk_buf_start);
 742                         else
 743                                 cifs_buf_release(cfile->srch_inf.
 744                                                 ntwrk_buf_start);
 745                         cfile->srch_inf.ntwrk_buf_start = NULL;
 746                 }
 747                 rc = initiate_cifs_search(xid, file, full_path);
 748                 if (rc) {
 749                         cifs_dbg(FYI, "error %d reinitiating a search on rewind\n",
 750                                  rc);
 751                         return rc;
 752                 }
 753                 /* FindFirst/Next set last_entry to NULL on malformed reply */
 754                 if (cfile->srch_inf.last_entry)
 755                         cifs_save_resume_key(cfile->srch_inf.last_entry, cfile);
 756         }
 757
 758         search_flags = CIFS_SEARCH_CLOSE_AT_END | CIFS_SEARCH_RETURN_RESUME;
 759         if (backup_cred(cifs_sb))
 760                 search_flags |= CIFS_SEARCH_BACKUP_SEARCH;
 761
 762         while ((index_to_find >= cfile->srch_inf.index_of_last_entry) &&
 763                (rc == 0) && !cfile->srch_inf.endOfSearch) {
 764                 cifs_dbg(FYI, "calling findnext2\n");
 765                 rc = server->ops->query_dir_next(xid, tcon, &cfile->fid,
 766                                                  search_flags,
 767                                                  &cfile->srch_inf);
 768                 /* FindFirst/Next set last_entry to NULL on malformed reply */
 769                 if (cfile->srch_inf.last_entry)
 770                         cifs_save_resume_key(cfile->srch_inf.last_entry, cfile);
 771                 if (rc)
 772                         return -ENOENT;
 773         }
 774         if (index_to_find < cfile->srch_inf.index_of_last_entry) {
 775                 /* we found the buffer that contains the entry */
 776                 /* scan and find it */
 777                 int i;
 778                 char *cur_ent;
 779                 char *end_of_smb;
 780
 781                 if (cfile->srch_inf.ntwrk_buf_start == NULL) {
 782                         cifs_dbg(VFS, "ntwrk_buf_start is NULL during readdir\n");
 783                         return -EIO;
 784                 }
 785
 786                 end_of_smb = cfile->srch_inf.ntwrk_buf_start +
 787                         server->ops->calc_smb_size(
 788                                         cfile->srch_inf.ntwrk_buf_start,
 789                                         server);
 790
 791                 cur_ent = cfile->srch_inf.srch_entries_start;
 792                 first_entry_in_buffer = cfile->srch_inf.index_of_last_entry
 793                                         - cfile->srch_inf.entries_in_buffer;
 794                 pos_in_buf = index_to_find - first_entry_in_buffer;
 795                 cifs_dbg(FYI, "found entry - pos_in_buf %d\n", pos_in_buf);
 796
 797                 for (i = 0; (i < (pos_in_buf)) && (cur_ent != NULL); i++) {
 798                         /* go entry by entry figuring out which is first */
 799                         cur_ent = nxt_dir_entry(cur_ent, end_of_smb,
 800                                                 cfile->srch_inf.info_level);
 801                 }
 802                 if ((cur_ent == NULL) && (i < pos_in_buf)) {
 803                         /* BB fixme - check if we should flag this error */
 804                         cifs_dbg(VFS, "reached end of buf searching for pos in buf %d index to find %lld rc %d\n",
 805                                  pos_in_buf, index_to_find, rc);
 806                 }
 807                 rc = 0;
 808                 *current_entry = cur_ent;
 809         } else {
 810                 cifs_dbg(FYI, "index not in buffer - could not findnext into it\n");
 811                 return 0;
 812         }
 813
 814         if (pos_in_buf >= cfile->srch_inf.entries_in_buffer) {
 815                 cifs_dbg(FYI, "can not return entries pos_in_buf beyond last\n");
 816                 *num_to_ret = 0;
 817         } else
 818                 *num_to_ret = cfile->srch_inf.entries_in_buffer - pos_in_buf;
 819
 820         return rc;
 821 }
 822
 823 static int cifs_filldir(char *find_entry, struct file *file,
 824                 struct dir_context *ctx,
 825                 char *scratch_buf, unsigned int max_len)
 826 {
 827         struct cifsFileInfo *file_info = file->private_data;
 828         struct super_block *sb = file_inode(file)->i_sb;
 829         struct cifs_sb_info *cifs_sb = CIFS_SB(sb);
 830         struct cifs_dirent de = { NULL, };
 831         struct cifs_fattr fattr;
 832         struct qstr name;
 833         int rc = 0;
 834         ino_t ino;
 835
 836         rc = cifs_fill_dirent(&de, find_entry, file_info->srch_inf.info_level,
 837                               file_info->srch_inf.unicode);
 838         if (rc)
 839                 return rc;
 840
 841         if (de.namelen > max_len) {
 842                 cifs_dbg(VFS, "bad search response length %zd past smb end\n",
 843                          de.namelen);
 844                 return -EINVAL;
 845         }
 846
 847         /* skip . and .. since we added them first */
 848         if (cifs_entry_is_dot(&de, file_info->srch_inf.unicode))
 849                 return 0;
 850
 851         if (file_info->srch_inf.unicode) {
 852                 struct nls_table *nlt = cifs_sb->local_nls;
 853                 int map_type;
 854
 855                 map_type = cifs_remap(cifs_sb);
 856                 name.name = scratch_buf;
 857                 name.len =
 858                         cifs_from_utf16((char *)name.name, (__le16 *)de.name,
 859                                         UNICODE_NAME_MAX,
 860                                         min_t(size_t, de.namelen,
 861                                               (size_t)max_len), nlt, map_type);
 862                 name.len -= nls_nullsize(nlt);
 863         } else {
 864                 name.name = de.name;
 865                 name.len = de.namelen;
 866         }
 867
 868         switch (file_info->srch_inf.info_level) {
 869         case SMB_FIND_FILE_POSIX_INFO:
 870                 cifs_posix_to_fattr(&fattr,
 871                                     (struct smb2_posix_info *)find_entry,
 872                                     cifs_sb);
 873                 break;
 874         case SMB_FIND_FILE_UNIX:
 875                 cifs_unix_basic_to_fattr(&fattr,
 876                                          &((FILE_UNIX_INFO *)find_entry)->basic,
 877                                          cifs_sb);
 878                 break;
 879         case SMB_FIND_FILE_INFO_STANDARD:
 880                 cifs_std_info_to_fattr(&fattr,
 881                                        (FIND_FILE_STANDARD_INFO *)find_entry,
 882                                        cifs_sb);
 883                 break;
 884         case SMB_FIND_FILE_ID_FULL_DIR_INFO:
 885                 cifs_fulldir_info_to_fattr(&fattr,
 886                                            (SEARCH_ID_FULL_DIR_INFO *)find_entry,
 887                                            cifs_sb);
 888                 break;
 889         default:
 890                 cifs_dir_info_to_fattr(&fattr,
 891                                        (FILE_DIRECTORY_INFO *)find_entry,
 892                                        cifs_sb);
 893                 break;
 894         }
 895
 896         if (de.ino && (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM)) {
 897                 fattr.cf_uniqueid = de.ino;
 898         } else {
 899                 fattr.cf_uniqueid = iunique(sb, ROOT_I);
 900                 cifs_autodisable_serverino(cifs_sb);
 901         }
 902
 903         if ((cifs_sb->mnt_cifs_flags & CIFS_MOUNT_MF_SYMLINKS) &&
 904             couldbe_mf_symlink(&fattr))
 905                 /*
 906                  * trying to get the type and mode can be slow,
 907                  * so just call those regular files for now, and mark
 908                  * for reval
 909                  */
 910                 fattr.cf_flags |= CIFS_FATTR_NEED_REVAL;
 911
 912         cifs_prime_dcache(file_dentry(file), &name, &fattr);
 913
 914         ino = cifs_uniqueid_to_ino_t(fattr.cf_uniqueid);
 915         return !dir_emit(ctx, name.name, name.len, ino, fattr.cf_dtype);
 916 }
 917
 918
 919 int cifs_readdir(struct file *file, struct dir_context *ctx)
 920 {
 921         int rc = 0;
 922         unsigned int xid;
 923         int i;
 924         struct cifs_tcon *tcon;
 925         struct cifsFileInfo *cifsFile = NULL;
 926         char *current_entry;
 927         int num_to_fill = 0;
 928         char *tmp_buf = NULL;
 929         char *end_of_smb;
 930         unsigned int max_len;
 931         const char *full_path;
 932         void *page = alloc_dentry_path();
 933
 934         xid = get_xid();
 935
 936         full_path = build_path_from_dentry(file_dentry(file), page);
 937         if (IS_ERR(full_path)) {
 938                 rc = PTR_ERR(full_path);
 939                 goto rddir2_exit;
 940         }
 941
 942         /*
 943          * Ensure FindFirst doesn't fail before doing filldir() for '.' and
 944          * '..'. Otherwise we won't be able to notify VFS in case of failure.
 945          */
 946         if (file->private_data == NULL) {
 947                 rc = initiate_cifs_search(xid, file, full_path);
 948                 cifs_dbg(FYI, "initiate cifs search rc %d\n", rc);
 949                 if (rc)
 950                         goto rddir2_exit;
 951         }
 952
 953         if (!dir_emit_dots(file, ctx))
 954                 goto rddir2_exit;
 955
 956         /* 1) If search is active,
 957                 is in current search buffer?
 958                 if it before then restart search
 959                 if after then keep searching till find it */
 960
 961         cifsFile = file->private_data;
 962         if (cifsFile->srch_inf.endOfSearch) {
 963                 if (cifsFile->srch_inf.emptyDir) {
 964                         cifs_dbg(FYI, "End of search, empty dir\n");
 965                         rc = 0;
 966                         goto rddir2_exit;
 967                 }
 968         } /* else {
 969                 cifsFile->invalidHandle = true;
 970                 tcon->ses->server->close(xid, tcon, &cifsFile->fid);
 971         } */
 972
 973         tcon = tlink_tcon(cifsFile->tlink);
 974         rc = find_cifs_entry(xid, tcon, ctx->pos, file, full_path,
 975                              &current_entry, &num_to_fill);
 976         if (rc) {
 977                 cifs_dbg(FYI, "fce error %d\n", rc);
 978                 goto rddir2_exit;
 979         } else if (current_entry != NULL) {
 980                 cifs_dbg(FYI, "entry %lld found\n", ctx->pos);
 981         } else {
 982                 cifs_dbg(FYI, "Could not find entry\n");
 983                 goto rddir2_exit;
 984         }
 985         cifs_dbg(FYI, "loop through %d times filling dir for net buf %p\n",
 986                  num_to_fill, cifsFile->srch_inf.ntwrk_buf_start);
 987         max_len = tcon->ses->server->ops->calc_smb_size(
 988                         cifsFile->srch_inf.ntwrk_buf_start,
 989                         tcon->ses->server);
 990         end_of_smb = cifsFile->srch_inf.ntwrk_buf_start + max_len;
 991
 992         tmp_buf = kmalloc(UNICODE_NAME_MAX, GFP_KERNEL);
 993         if (tmp_buf == NULL) {
 994                 rc = -ENOMEM;
 995                 goto rddir2_exit;
 996         }
 997
 998         for (i = 0; i < num_to_fill; i++) {
 999                 if (current_entry == NULL) {
1000                         /* evaluate whether this case is an error */
1001                         cifs_dbg(VFS, "past SMB end,  num to fill %d i %d\n",
1002                                  num_to_fill, i);
1003                         break;
1004                 }
1005                 /*
1006                  * if buggy server returns . and .. late do we want to
1007                  * check for that here?
1008                  */
1009                 *tmp_buf = 0;
1010                 rc = cifs_filldir(current_entry, file, ctx,
1011                                   tmp_buf, max_len);
1012                 if (rc) {
1013                         if (rc > 0)
1014                                 rc = 0;
1015                         break;
1016                 }
1017
1018                 ctx->pos++;
1019                 if (ctx->pos ==
1020                         cifsFile->srch_inf.index_of_last_entry) {
1021                         cifs_dbg(FYI, "last entry in buf at pos %lld %s\n",
1022                                  ctx->pos, tmp_buf);
1023                         cifs_save_resume_key(current_entry, cifsFile);
1024                         break;
1025                 } else
1026                         current_entry =
1027                                 nxt_dir_entry(current_entry, end_of_smb,
1028                                         cifsFile->srch_inf.info_level);
1029         }
1030         kfree(tmp_buf);
1031
1032 rddir2_exit:
1033         free_dentry_path(page);
1034         free_xid(xid);
1035         return rc;
1036 }