fs/cifs/dfs_cache.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * DFS referral cache routines
   4  *
   5  * Copyright (c) 2018-2019 Paulo Alcantara <palcantara@suse.de>
   6  */
   7
   8 #include <linux/jhash.h>
   9 #include <linux/ktime.h>
  10 #include <linux/slab.h>
  11 #include <linux/proc_fs.h>
  12 #include <linux/nls.h>
  13 #include <linux/workqueue.h>
  14 #include "cifsglob.h"
  15 #include "smb2pdu.h"
  16 #include "smb2proto.h"
  17 #include "cifsproto.h"
  18 #include "cifs_debug.h"
  19 #include "cifs_unicode.h"
  20 #include "smb2glob.h"
  21 #include "fs_context.h"
  22
  23 #include "dfs_cache.h"
  24
  25 #define CACHE_HTABLE_SIZE 32
  26 #define CACHE_MAX_ENTRIES 64
  27
  28 #define IS_INTERLINK_SET(v) ((v) & (DFSREF_REFERRAL_SERVER | \
  29                                     DFSREF_STORAGE_SERVER))
  30
  31 struct cache_dfs_tgt {
  32         char *name;
  33         int path_consumed;
  34         struct list_head list;
  35 };
  36
  37 struct cache_entry {
  38         struct hlist_node hlist;
  39         const char *path;
  40         int ttl;
  41         int srvtype;
  42         int flags;
  43         struct timespec64 etime;
  44         int path_consumed;
  45         int numtgts;
  46         struct list_head tlist;
  47         struct cache_dfs_tgt *tgthint;
  48 };
  49
  50 struct vol_info {
  51         char *fullpath;
  52         spinlock_t ctx_lock;
  53         struct smb3_fs_context ctx;
  54         char *mntdata;
  55         struct list_head list;
  56         struct list_head rlist;
  57         struct kref refcnt;
  58 };
  59
  60 static struct kmem_cache *cache_slab __read_mostly;
  61 static struct workqueue_struct *dfscache_wq __read_mostly;
  62
  63 static int cache_ttl;
  64 static DEFINE_SPINLOCK(cache_ttl_lock);
  65
  66 static struct nls_table *cache_nlsc;
  67
  68 /*
  69  * Number of entries in the cache
  70  */
  71 static atomic_t cache_count;
  72
  73 static struct hlist_head cache_htable[CACHE_HTABLE_SIZE];
  74 static DECLARE_RWSEM(htable_rw_lock);
  75
  76 static LIST_HEAD(vol_list);
  77 static DEFINE_SPINLOCK(vol_list_lock);
  78
  79 static void refresh_cache_worker(struct work_struct *work);
  80
  81 static DECLARE_DELAYED_WORK(refresh_task, refresh_cache_worker);
  82
  83 static int get_normalized_path(const char *path, char **npath)
  84 {
  85         if (!path || strlen(path) < 3 || (*path != '\\' && *path != '/'))
  86                 return -EINVAL;
  87
  88         if (*path == '\\') {
  89                 *npath = (char *)path;
  90         } else {
  91                 *npath = kstrndup(path, strlen(path), GFP_KERNEL);
  92                 if (!*npath)
  93                         return -ENOMEM;
  94                 convert_delimiter(*npath, '\\');
  95         }
  96         return 0;
  97 }
  98
  99 static inline void free_normalized_path(const char *path, char *npath)
 100 {
 101         if (path != npath)
 102                 kfree(npath);
 103 }
 104
 105 static inline bool cache_entry_expired(const struct cache_entry *ce)
 106 {
 107         struct timespec64 ts;
 108
 109         ktime_get_coarse_real_ts64(&ts);
 110         return timespec64_compare(&ts, &ce->etime) >= 0;
 111 }
 112
 113 static inline void free_tgts(struct cache_entry *ce)
 114 {
 115         struct cache_dfs_tgt *t, *n;
 116
 117         list_for_each_entry_safe(t, n, &ce->tlist, list) {
 118                 list_del(&t->list);
 119                 kfree(t->name);
 120                 kfree(t);
 121         }
 122 }
 123
 124 static inline void flush_cache_ent(struct cache_entry *ce)
 125 {
 126         hlist_del_init(&ce->hlist);
 127         kfree(ce->path);
 128         free_tgts(ce);
 129         atomic_dec(&cache_count);
 130         kmem_cache_free(cache_slab, ce);
 131 }
 132
 133 static void flush_cache_ents(void)
 134 {
 135         int i;
 136
 137         for (i = 0; i < CACHE_HTABLE_SIZE; i++) {
 138                 struct hlist_head *l = &cache_htable[i];
 139                 struct hlist_node *n;
 140                 struct cache_entry *ce;
 141
 142                 hlist_for_each_entry_safe(ce, n, l, hlist) {
 143                         if (!hlist_unhashed(&ce->hlist))
 144                                 flush_cache_ent(ce);
 145                 }
 146         }
 147 }
 148
 149 /*
 150  * dfs cache /proc file
 151  */
 152 static int dfscache_proc_show(struct seq_file *m, void *v)
 153 {
 154         int i;
 155         struct cache_entry *ce;
 156         struct cache_dfs_tgt *t;
 157
 158         seq_puts(m, "DFS cache\n---------\n");
 159
 160         down_read(&htable_rw_lock);
 161         for (i = 0; i < CACHE_HTABLE_SIZE; i++) {
 162                 struct hlist_head *l = &cache_htable[i];
 163
 164                 hlist_for_each_entry(ce, l, hlist) {
 165                         if (hlist_unhashed(&ce->hlist))
 166                                 continue;
 167
 168                         seq_printf(m,
 169                                    "cache entry: path=%s,type=%s,ttl=%d,etime=%ld,"
 170                                    "interlink=%s,path_consumed=%d,expired=%s\n",
 171                                    ce->path,
 172                                    ce->srvtype == DFS_TYPE_ROOT ? "root" : "link",
 173                                    ce->ttl, ce->etime.tv_nsec,
 174                                    IS_INTERLINK_SET(ce->flags) ? "yes" : "no",
 175                                    ce->path_consumed,
 176                                    cache_entry_expired(ce) ? "yes" : "no");
 177
 178                         list_for_each_entry(t, &ce->tlist, list) {
 179                                 seq_printf(m, "  %s%s\n",
 180                                            t->name,
 181                                            ce->tgthint == t ? " (target hint)" : "");
 182                         }
 183                 }
 184         }
 185         up_read(&htable_rw_lock);
 186
 187         return 0;
 188 }
 189
 190 static ssize_t dfscache_proc_write(struct file *file, const char __user *buffer,
 191                                    size_t count, loff_t *ppos)
 192 {
 193         char c;
 194         int rc;
 195
 196         rc = get_user(c, buffer);
 197         if (rc)
 198                 return rc;
 199
 200         if (c != '0')
 201                 return -EINVAL;
 202
 203         cifs_dbg(FYI, "clearing dfs cache\n");
 204
 205         down_write(&htable_rw_lock);
 206         flush_cache_ents();
 207         up_write(&htable_rw_lock);
 208
 209         return count;
 210 }
 211
 212 static int dfscache_proc_open(struct inode *inode, struct file *file)
 213 {
 214         return single_open(file, dfscache_proc_show, NULL);
 215 }
 216
 217 const struct proc_ops dfscache_proc_ops = {
 218         .proc_open      = dfscache_proc_open,
 219         .proc_read      = seq_read,
 220         .proc_lseek     = seq_lseek,
 221         .proc_release   = single_release,
 222         .proc_write     = dfscache_proc_write,
 223 };
 224
 225 #ifdef CONFIG_CIFS_DEBUG2
 226 static inline void dump_tgts(const struct cache_entry *ce)
 227 {
 228         struct cache_dfs_tgt *t;
 229
 230         cifs_dbg(FYI, "target list:\n");
 231         list_for_each_entry(t, &ce->tlist, list) {
 232                 cifs_dbg(FYI, "  %s%s\n", t->name,
 233                          ce->tgthint == t ? " (target hint)" : "");
 234         }
 235 }
 236
 237 static inline void dump_ce(const struct cache_entry *ce)
 238 {
 239         cifs_dbg(FYI, "cache entry: path=%s,type=%s,ttl=%d,etime=%ld,interlink=%s,path_consumed=%d,expired=%s\n",
 240                  ce->path,
 241                  ce->srvtype == DFS_TYPE_ROOT ? "root" : "link", ce->ttl,
 242                  ce->etime.tv_nsec,
 243                  IS_INTERLINK_SET(ce->flags) ? "yes" : "no",
 244                  ce->path_consumed,
 245                  cache_entry_expired(ce) ? "yes" : "no");
 246         dump_tgts(ce);
 247 }
 248
 249 static inline void dump_refs(const struct dfs_info3_param *refs, int numrefs)
 250 {
 251         int i;
 252
 253         cifs_dbg(FYI, "DFS referrals returned by the server:\n");
 254         for (i = 0; i < numrefs; i++) {
 255                 const struct dfs_info3_param *ref = &refs[i];
 256
 257                 cifs_dbg(FYI,
 258                          "\n"
 259                          "flags:         0x%x\n"
 260                          "path_consumed: %d\n"
 261                          "server_type:   0x%x\n"
 262                          "ref_flag:      0x%x\n"
 263                          "path_name:     %s\n"
 264                          "node_name:     %s\n"
 265                          "ttl:           %d (%dm)\n",
 266                          ref->flags, ref->path_consumed, ref->server_type,
 267                          ref->ref_flag, ref->path_name, ref->node_name,
 268                          ref->ttl, ref->ttl / 60);
 269         }
 270 }
 271 #else
 272 #define dump_tgts(e)
 273 #define dump_ce(e)
 274 #define dump_refs(r, n)
 275 #endif
 276
 277 /**
 278  * dfs_cache_init - Initialize DFS referral cache.
 279  *
 280  * Return zero if initialized successfully, otherwise non-zero.
 281  */
 282 int dfs_cache_init(void)
 283 {
 284         int rc;
 285         int i;
 286
 287         dfscache_wq = alloc_workqueue("cifs-dfscache",
 288                                       WQ_FREEZABLE | WQ_MEM_RECLAIM, 1);
 289         if (!dfscache_wq)
 290                 return -ENOMEM;
 291
 292         cache_slab = kmem_cache_create("cifs_dfs_cache",
 293                                        sizeof(struct cache_entry), 0,
 294                                        SLAB_HWCACHE_ALIGN, NULL);
 295         if (!cache_slab) {
 296                 rc = -ENOMEM;
 297                 goto out_destroy_wq;
 298         }
 299
 300         for (i = 0; i < CACHE_HTABLE_SIZE; i++)
 301                 INIT_HLIST_HEAD(&cache_htable[i]);
 302
 303         atomic_set(&cache_count, 0);
 304         cache_nlsc = load_nls_default();
 305
 306         cifs_dbg(FYI, "%s: initialized DFS referral cache\n", __func__);
 307         return 0;
 308
 309 out_destroy_wq:
 310         destroy_workqueue(dfscache_wq);
 311         return rc;
 312 }
 313
 314 static inline unsigned int cache_entry_hash(const void *data, int size)
 315 {
 316         unsigned int h;
 317
 318         h = jhash(data, size, 0);
 319         return h & (CACHE_HTABLE_SIZE - 1);
 320 }
 321
 322 /* Check whether second path component of @path is SYSVOL or NETLOGON */
 323 static inline bool is_sysvol_or_netlogon(const char *path)
 324 {
 325         const char *s;
 326         char sep = path[0];
 327
 328         s = strchr(path + 1, sep) + 1;
 329         return !strncasecmp(s, "sysvol", strlen("sysvol")) ||
 330                 !strncasecmp(s, "netlogon", strlen("netlogon"));
 331 }
 332
 333 /* Return target hint of a DFS cache entry */
 334 static inline char *get_tgt_name(const struct cache_entry *ce)
 335 {
 336         struct cache_dfs_tgt *t = ce->tgthint;
 337
 338         return t ? t->name : ERR_PTR(-ENOENT);
 339 }
 340
 341 /* Return expire time out of a new entry's TTL */
 342 static inline struct timespec64 get_expire_time(int ttl)
 343 {
 344         struct timespec64 ts = {
 345                 .tv_sec = ttl,
 346                 .tv_nsec = 0,
 347         };
 348         struct timespec64 now;
 349
 350         ktime_get_coarse_real_ts64(&now);
 351         return timespec64_add(now, ts);
 352 }
 353
 354 /* Allocate a new DFS target */
 355 static struct cache_dfs_tgt *alloc_target(const char *name, int path_consumed)
 356 {
 357         struct cache_dfs_tgt *t;
 358
 359         t = kmalloc(sizeof(*t), GFP_ATOMIC);
 360         if (!t)
 361                 return ERR_PTR(-ENOMEM);
 362         t->name = kstrndup(name, strlen(name), GFP_ATOMIC);
 363         if (!t->name) {
 364                 kfree(t);
 365                 return ERR_PTR(-ENOMEM);
 366         }
 367         t->path_consumed = path_consumed;
 368         INIT_LIST_HEAD(&t->list);
 369         return t;
 370 }
 371
 372 /*
 373  * Copy DFS referral information to a cache entry and conditionally update
 374  * target hint.
 375  */
 376 static int copy_ref_data(const struct dfs_info3_param *refs, int numrefs,
 377                          struct cache_entry *ce, const char *tgthint)
 378 {
 379         int i;
 380
 381         ce->ttl = refs[0].ttl;
 382         ce->etime = get_expire_time(ce->ttl);
 383         ce->srvtype = refs[0].server_type;
 384         ce->flags = refs[0].ref_flag;
 385         ce->path_consumed = refs[0].path_consumed;
 386
 387         for (i = 0; i < numrefs; i++) {
 388                 struct cache_dfs_tgt *t;
 389
 390                 t = alloc_target(refs[i].node_name, refs[i].path_consumed);
 391                 if (IS_ERR(t)) {
 392                         free_tgts(ce);
 393                         return PTR_ERR(t);
 394                 }
 395                 if (tgthint && !strcasecmp(t->name, tgthint)) {
 396                         list_add(&t->list, &ce->tlist);
 397                         tgthint = NULL;
 398                 } else {
 399                         list_add_tail(&t->list, &ce->tlist);
 400                 }
 401                 ce->numtgts++;
 402         }
 403
 404         ce->tgthint = list_first_entry_or_null(&ce->tlist,
 405                                                struct cache_dfs_tgt, list);
 406
 407         return 0;
 408 }
 409
 410 /* Allocate a new cache entry */
 411 static struct cache_entry *alloc_cache_entry(const char *path,
 412                                              const struct dfs_info3_param *refs,
 413                                              int numrefs)
 414 {
 415         struct cache_entry *ce;
 416         int rc;
 417
 418         ce = kmem_cache_zalloc(cache_slab, GFP_KERNEL);
 419         if (!ce)
 420                 return ERR_PTR(-ENOMEM);
 421
 422         ce->path = kstrndup(path, strlen(path), GFP_KERNEL);
 423         if (!ce->path) {
 424                 kmem_cache_free(cache_slab, ce);
 425                 return ERR_PTR(-ENOMEM);
 426         }
 427         INIT_HLIST_NODE(&ce->hlist);
 428         INIT_LIST_HEAD(&ce->tlist);
 429
 430         rc = copy_ref_data(refs, numrefs, ce, NULL);
 431         if (rc) {
 432                 kfree(ce->path);
 433                 kmem_cache_free(cache_slab, ce);
 434                 ce = ERR_PTR(rc);
 435         }
 436         return ce;
 437 }
 438
 439 /* Must be called with htable_rw_lock held */
 440 static void remove_oldest_entry(void)
 441 {
 442         int i;
 443         struct cache_entry *ce;
 444         struct cache_entry *to_del = NULL;
 445
 446         for (i = 0; i < CACHE_HTABLE_SIZE; i++) {
 447                 struct hlist_head *l = &cache_htable[i];
 448
 449                 hlist_for_each_entry(ce, l, hlist) {
 450                         if (hlist_unhashed(&ce->hlist))
 451                                 continue;
 452                         if (!to_del || timespec64_compare(&ce->etime,
 453                                                           &to_del->etime) < 0)
 454                                 to_del = ce;
 455                 }
 456         }
 457
 458         if (!to_del) {
 459                 cifs_dbg(FYI, "%s: no entry to remove\n", __func__);
 460                 return;
 461         }
 462
 463         cifs_dbg(FYI, "%s: removing entry\n", __func__);
 464         dump_ce(to_del);
 465         flush_cache_ent(to_del);
 466 }
 467
 468 /* Add a new DFS cache entry */
 469 static int add_cache_entry(const char *path, unsigned int hash,
 470                            struct dfs_info3_param *refs, int numrefs)
 471 {
 472         struct cache_entry *ce;
 473
 474         ce = alloc_cache_entry(path, refs, numrefs);
 475         if (IS_ERR(ce))
 476                 return PTR_ERR(ce);
 477
 478         spin_lock(&cache_ttl_lock);
 479         if (!cache_ttl) {
 480                 cache_ttl = ce->ttl;
 481                 queue_delayed_work(dfscache_wq, &refresh_task, cache_ttl * HZ);
 482         } else {
 483                 cache_ttl = min_t(int, cache_ttl, ce->ttl);
 484                 mod_delayed_work(dfscache_wq, &refresh_task, cache_ttl * HZ);
 485         }
 486         spin_unlock(&cache_ttl_lock);
 487
 488         down_write(&htable_rw_lock);
 489         hlist_add_head(&ce->hlist, &cache_htable[hash]);
 490         dump_ce(ce);
 491         up_write(&htable_rw_lock);
 492
 493         return 0;
 494 }
 495
 496 static struct cache_entry *__lookup_cache_entry(const char *path)
 497 {
 498         struct cache_entry *ce;
 499         unsigned int h;
 500         bool found = false;
 501
 502         h = cache_entry_hash(path, strlen(path));
 503
 504         hlist_for_each_entry(ce, &cache_htable[h], hlist) {
 505                 if (!strcasecmp(path, ce->path)) {
 506                         found = true;
 507                         dump_ce(ce);
 508                         break;
 509                 }
 510         }
 511
 512         if (!found)
 513                 ce = ERR_PTR(-ENOENT);
 514         return ce;
 515 }
 516
 517 /*
 518  * Find a DFS cache entry in hash table and optionally check prefix path against
 519  * @path.
 520  * Use whole path components in the match.
 521  * Must be called with htable_rw_lock held.
 522  *
 523  * Return ERR_PTR(-ENOENT) if the entry is not found.
 524  */
 525 static struct cache_entry *lookup_cache_entry(const char *path, unsigned int *hash)
 526 {
 527         struct cache_entry *ce = ERR_PTR(-ENOENT);
 528         unsigned int h;
 529         int cnt = 0;
 530         char *npath;
 531         char *s, *e;
 532         char sep;
 533
 534         npath = kstrndup(path, strlen(path), GFP_KERNEL);
 535         if (!npath)
 536                 return ERR_PTR(-ENOMEM);
 537
 538         s = npath;
 539         sep = *npath;
 540         while ((s = strchr(s, sep)) && ++cnt < 3)
 541                 s++;
 542
 543         if (cnt < 3) {
 544                 h = cache_entry_hash(path, strlen(path));
 545                 ce = __lookup_cache_entry(path);
 546                 goto out;
 547         }
 548         /*
 549          * Handle paths that have more than two path components and are a complete prefix of the DFS
 550          * referral request path (@path).
 551          *
 552          * See MS-DFSC 3.2.5.5 "Receiving a Root Referral Request or Link Referral Request".
 553          */
 554         h = cache_entry_hash(npath, strlen(npath));
 555         e = npath + strlen(npath) - 1;
 556         while (e > s) {
 557                 char tmp;
 558
 559                 /* skip separators */
 560                 while (e > s && *e == sep)
 561                         e--;
 562                 if (e == s)
 563                         goto out;
 564
 565                 tmp = *(e+1);
 566                 *(e+1) = 0;
 567
 568                 ce = __lookup_cache_entry(npath);
 569                 if (!IS_ERR(ce)) {
 570                         h = cache_entry_hash(npath, strlen(npath));
 571                         break;
 572                 }
 573
 574                 *(e+1) = tmp;
 575                 /* backward until separator */
 576                 while (e > s && *e != sep)
 577                         e--;
 578         }
 579 out:
 580         if (hash)
 581                 *hash = h;
 582         kfree(npath);
 583         return ce;
 584 }
 585
 586 static void __vol_release(struct vol_info *vi)
 587 {
 588         kfree(vi->fullpath);
 589         kfree(vi->mntdata);
 590         smb3_cleanup_fs_context_contents(&vi->ctx);
 591         kfree(vi);
 592 }
 593
 594 static void vol_release(struct kref *kref)
 595 {
 596         struct vol_info *vi = container_of(kref, struct vol_info, refcnt);
 597
 598         spin_lock(&vol_list_lock);
 599         list_del(&vi->list);
 600         spin_unlock(&vol_list_lock);
 601         __vol_release(vi);
 602 }
 603
 604 static inline void free_vol_list(void)
 605 {
 606         struct vol_info *vi, *nvi;
 607
 608         list_for_each_entry_safe(vi, nvi, &vol_list, list) {
 609                 list_del_init(&vi->list);
 610                 __vol_release(vi);
 611         }
 612 }
 613
 614 /**
 615  * dfs_cache_destroy - destroy DFS referral cache
 616  */
 617 void dfs_cache_destroy(void)
 618 {
 619         cancel_delayed_work_sync(&refresh_task);
 620         unload_nls(cache_nlsc);
 621         free_vol_list();
 622         flush_cache_ents();
 623         kmem_cache_destroy(cache_slab);
 624         destroy_workqueue(dfscache_wq);
 625
 626         cifs_dbg(FYI, "%s: destroyed DFS referral cache\n", __func__);
 627 }
 628
 629 /* Must be called with htable_rw_lock held */
 630 static int __update_cache_entry(const char *path,
 631                                 const struct dfs_info3_param *refs,
 632                                 int numrefs)
 633 {
 634         int rc;
 635         struct cache_entry *ce;
 636         char *s, *th = NULL;
 637
 638         ce = lookup_cache_entry(path, NULL);
 639         if (IS_ERR(ce))
 640                 return PTR_ERR(ce);
 641
 642         if (ce->tgthint) {
 643                 s = ce->tgthint->name;
 644                 th = kstrndup(s, strlen(s), GFP_ATOMIC);
 645                 if (!th)
 646                         return -ENOMEM;
 647         }
 648
 649         free_tgts(ce);
 650         ce->numtgts = 0;
 651
 652         rc = copy_ref_data(refs, numrefs, ce, th);
 653
 654         kfree(th);
 655
 656         return rc;
 657 }
 658
 659 static int get_dfs_referral(const unsigned int xid, struct cifs_ses *ses,
 660                             const struct nls_table *nls_codepage, int remap,
 661                             const char *path,  struct dfs_info3_param **refs,
 662                             int *numrefs)
 663 {
 664         cifs_dbg(FYI, "%s: get an DFS referral for %s\n", __func__, path);
 665
 666         if (!ses || !ses->server || !ses->server->ops->get_dfs_refer)
 667                 return -EOPNOTSUPP;
 668         if (unlikely(!nls_codepage))
 669                 return -EINVAL;
 670
 671         *refs = NULL;
 672         *numrefs = 0;
 673
 674         return ses->server->ops->get_dfs_refer(xid, ses, path, refs, numrefs,
 675                                                nls_codepage, remap);
 676 }
 677
 678 /* Update an expired cache entry by getting a new DFS referral from server */
 679 static int update_cache_entry(const char *path,
 680                               const struct dfs_info3_param *refs,
 681                               int numrefs)
 682 {
 683
 684         int rc;
 685
 686         down_write(&htable_rw_lock);
 687         rc = __update_cache_entry(path, refs, numrefs);
 688         up_write(&htable_rw_lock);
 689
 690         return rc;
 691 }
 692
 693 /*
 694  * Find, create or update a DFS cache entry.
 695  *
 696  * If the entry wasn't found, it will create a new one. Or if it was found but
 697  * expired, then it will update the entry accordingly.
 698  *
 699  * For interlinks, __cifs_dfs_mount() and expand_dfs_referral() are supposed to
 700  * handle them properly.
 701  */
 702 static int __dfs_cache_find(const unsigned int xid, struct cifs_ses *ses,
 703                             const struct nls_table *nls_codepage, int remap,
 704                             const char *path, bool noreq)
 705 {
 706         int rc;
 707         unsigned int hash;
 708         struct cache_entry *ce;
 709         struct dfs_info3_param *refs = NULL;
 710         int numrefs = 0;
 711         bool newent = false;
 712
 713         cifs_dbg(FYI, "%s: search path: %s\n", __func__, path);
 714
 715         down_read(&htable_rw_lock);
 716
 717         ce = lookup_cache_entry(path, &hash);
 718
 719         /*
 720          * If @noreq is set, no requests will be sent to the server. Just return
 721          * the cache entry.
 722          */
 723         if (noreq) {
 724                 up_read(&htable_rw_lock);
 725                 return PTR_ERR_OR_ZERO(ce);
 726         }
 727
 728         if (!IS_ERR(ce)) {
 729                 if (!cache_entry_expired(ce)) {
 730                         dump_ce(ce);
 731                         up_read(&htable_rw_lock);
 732                         return 0;
 733                 }
 734         } else {
 735                 newent = true;
 736         }
 737
 738         up_read(&htable_rw_lock);
 739
 740         /*
 741          * No entry was found.
 742          *
 743          * Request a new DFS referral in order to create a new cache entry, or
 744          * updating an existing one.
 745          */
 746         rc = get_dfs_referral(xid, ses, nls_codepage, remap, path,
 747                               &refs, &numrefs);
 748         if (rc)
 749                 return rc;
 750
 751         dump_refs(refs, numrefs);
 752
 753         if (!newent) {
 754                 rc = update_cache_entry(path, refs, numrefs);
 755                 goto out_free_refs;
 756         }
 757
 758         if (atomic_read(&cache_count) >= CACHE_MAX_ENTRIES) {
 759                 cifs_dbg(FYI, "%s: reached max cache size (%d)\n",
 760                          __func__, CACHE_MAX_ENTRIES);
 761                 down_write(&htable_rw_lock);
 762                 remove_oldest_entry();
 763                 up_write(&htable_rw_lock);
 764         }
 765
 766         rc = add_cache_entry(path, hash, refs, numrefs);
 767         if (!rc)
 768                 atomic_inc(&cache_count);
 769
 770 out_free_refs:
 771         free_dfs_info_array(refs, numrefs);
 772         return rc;
 773 }
 774
 775 /*
 776  * Set up a DFS referral from a given cache entry.
 777  *
 778  * Must be called with htable_rw_lock held.
 779  */
 780 static int setup_referral(const char *path, struct cache_entry *ce,
 781                           struct dfs_info3_param *ref, const char *target)
 782 {
 783         int rc;
 784
 785         cifs_dbg(FYI, "%s: set up new ref\n", __func__);
 786
 787         memset(ref, 0, sizeof(*ref));
 788
 789         ref->path_name = kstrndup(path, strlen(path), GFP_ATOMIC);
 790         if (!ref->path_name)
 791                 return -ENOMEM;
 792
 793         ref->node_name = kstrndup(target, strlen(target), GFP_ATOMIC);
 794         if (!ref->node_name) {
 795                 rc = -ENOMEM;
 796                 goto err_free_path;
 797         }
 798
 799         ref->path_consumed = ce->path_consumed;
 800         ref->ttl = ce->ttl;
 801         ref->server_type = ce->srvtype;
 802         ref->ref_flag = ce->flags;
 803
 804         return 0;
 805
 806 err_free_path:
 807         kfree(ref->path_name);
 808         ref->path_name = NULL;
 809         return rc;
 810 }
 811
 812 /* Return target list of a DFS cache entry */
 813 static int get_targets(struct cache_entry *ce, struct dfs_cache_tgt_list *tl)
 814 {
 815         int rc;
 816         struct list_head *head = &tl->tl_list;
 817         struct cache_dfs_tgt *t;
 818         struct dfs_cache_tgt_iterator *it, *nit;
 819
 820         memset(tl, 0, sizeof(*tl));
 821         INIT_LIST_HEAD(head);
 822
 823         list_for_each_entry(t, &ce->tlist, list) {
 824                 it = kzalloc(sizeof(*it), GFP_ATOMIC);
 825                 if (!it) {
 826                         rc = -ENOMEM;
 827                         goto err_free_it;
 828                 }
 829
 830                 it->it_name = kstrndup(t->name, strlen(t->name), GFP_ATOMIC);
 831                 if (!it->it_name) {
 832                         kfree(it);
 833                         rc = -ENOMEM;
 834                         goto err_free_it;
 835                 }
 836                 it->it_path_consumed = t->path_consumed;
 837
 838                 if (ce->tgthint == t)
 839                         list_add(&it->it_list, head);
 840                 else
 841                         list_add_tail(&it->it_list, head);
 842         }
 843
 844         tl->tl_numtgts = ce->numtgts;
 845
 846         return 0;
 847
 848 err_free_it:
 849         list_for_each_entry_safe(it, nit, head, it_list) {
 850                 kfree(it->it_name);
 851                 kfree(it);
 852         }
 853         return rc;
 854 }
 855
 856 /**
 857  * dfs_cache_find - find a DFS cache entry
 858  *
 859  * If it doesn't find the cache entry, then it will get a DFS referral
 860  * for @path and create a new entry.
 861  *
 862  * In case the cache entry exists but expired, it will get a DFS referral
 863  * for @path and then update the respective cache entry.
 864  *
 865  * These parameters are passed down to the get_dfs_refer() call if it
 866  * needs to be issued:
 867  * @xid: syscall xid
 868  * @ses: smb session to issue the request on
 869  * @nls_codepage: charset conversion
 870  * @remap: path character remapping type
 871  * @path: path to lookup in DFS referral cache.
 872  *
 873  * @ref: when non-NULL, store single DFS referral result in it.
 874  * @tgt_list: when non-NULL, store complete DFS target list in it.
 875  *
 876  * Return zero if the target was found, otherwise non-zero.
 877  */
 878 int dfs_cache_find(const unsigned int xid, struct cifs_ses *ses,
 879                    const struct nls_table *nls_codepage, int remap,
 880                    const char *path, struct dfs_info3_param *ref,
 881                    struct dfs_cache_tgt_list *tgt_list)
 882 {
 883         int rc;
 884         char *npath;
 885         struct cache_entry *ce;
 886
 887         rc = get_normalized_path(path, &npath);
 888         if (rc)
 889                 return rc;
 890
 891         rc = __dfs_cache_find(xid, ses, nls_codepage, remap, npath, false);
 892         if (rc)
 893                 goto out_free_path;
 894
 895         down_read(&htable_rw_lock);
 896
 897         ce = lookup_cache_entry(npath, NULL);
 898         if (IS_ERR(ce)) {
 899                 up_read(&htable_rw_lock);
 900                 rc = PTR_ERR(ce);
 901                 goto out_free_path;
 902         }
 903
 904         if (ref)
 905                 rc = setup_referral(path, ce, ref, get_tgt_name(ce));
 906         else
 907                 rc = 0;
 908         if (!rc && tgt_list)
 909                 rc = get_targets(ce, tgt_list);
 910
 911         up_read(&htable_rw_lock);
 912
 913 out_free_path:
 914         free_normalized_path(path, npath);
 915         return rc;
 916 }
 917
 918 /**
 919  * dfs_cache_noreq_find - find a DFS cache entry without sending any requests to
 920  * the currently connected server.
 921  *
 922  * NOTE: This function will neither update a cache entry in case it was
 923  * expired, nor create a new cache entry if @path hasn't been found. It heavily
 924  * relies on an existing cache entry.
 925  *
 926  * @path: path to lookup in the DFS referral cache.
 927  * @ref: when non-NULL, store single DFS referral result in it.
 928  * @tgt_list: when non-NULL, store complete DFS target list in it.
 929  *
 930  * Return 0 if successful.
 931  * Return -ENOENT if the entry was not found.
 932  * Return non-zero for other errors.
 933  */
 934 int dfs_cache_noreq_find(const char *path, struct dfs_info3_param *ref,
 935                          struct dfs_cache_tgt_list *tgt_list)
 936 {
 937         int rc;
 938         char *npath;
 939         struct cache_entry *ce;
 940
 941         rc = get_normalized_path(path, &npath);
 942         if (rc)
 943                 return rc;
 944
 945         cifs_dbg(FYI, "%s: path: %s\n", __func__, npath);
 946
 947         down_read(&htable_rw_lock);
 948
 949         ce = lookup_cache_entry(npath, NULL);
 950         if (IS_ERR(ce)) {
 951                 rc = PTR_ERR(ce);
 952                 goto out_unlock;
 953         }
 954
 955         if (ref)
 956                 rc = setup_referral(path, ce, ref, get_tgt_name(ce));
 957         else
 958                 rc = 0;
 959         if (!rc && tgt_list)
 960                 rc = get_targets(ce, tgt_list);
 961
 962 out_unlock:
 963         up_read(&htable_rw_lock);
 964         free_normalized_path(path, npath);
 965
 966         return rc;
 967 }
 968
 969 /**
 970  * dfs_cache_update_tgthint - update target hint of a DFS cache entry
 971  *
 972  * If it doesn't find the cache entry, then it will get a DFS referral for @path
 973  * and create a new entry.
 974  *
 975  * In case the cache entry exists but expired, it will get a DFS referral
 976  * for @path and then update the respective cache entry.
 977  *
 978  * @xid: syscall id
 979  * @ses: smb session
 980  * @nls_codepage: charset conversion
 981  * @remap: type of character remapping for paths
 982  * @path: path to lookup in DFS referral cache.
 983  * @it: DFS target iterator
 984  *
 985  * Return zero if the target hint was updated successfully, otherwise non-zero.
 986  */
 987 int dfs_cache_update_tgthint(const unsigned int xid, struct cifs_ses *ses,
 988                              const struct nls_table *nls_codepage, int remap,
 989                              const char *path,
 990                              const struct dfs_cache_tgt_iterator *it)
 991 {
 992         int rc;
 993         char *npath;
 994         struct cache_entry *ce;
 995         struct cache_dfs_tgt *t;
 996
 997         rc = get_normalized_path(path, &npath);
 998         if (rc)
 999                 return rc;
1000
1001         cifs_dbg(FYI, "%s: update target hint - path: %s\n", __func__, npath);
1002
1003         rc = __dfs_cache_find(xid, ses, nls_codepage, remap, npath, false);
1004         if (rc)
1005                 goto out_free_path;
1006
1007         down_write(&htable_rw_lock);
1008
1009         ce = lookup_cache_entry(npath, NULL);
1010         if (IS_ERR(ce)) {
1011                 rc = PTR_ERR(ce);
1012                 goto out_unlock;
1013         }
1014
1015         t = ce->tgthint;
1016
1017         if (likely(!strcasecmp(it->it_name, t->name)))
1018                 goto out_unlock;
1019
1020         list_for_each_entry(t, &ce->tlist, list) {
1021                 if (!strcasecmp(t->name, it->it_name)) {
1022                         ce->tgthint = t;
1023                         cifs_dbg(FYI, "%s: new target hint: %s\n", __func__,
1024                                  it->it_name);
1025                         break;
1026                 }
1027         }
1028
1029 out_unlock:
1030         up_write(&htable_rw_lock);
1031 out_free_path:
1032         free_normalized_path(path, npath);
1033
1034         return rc;
1035 }
1036
1037 /**
1038  * dfs_cache_noreq_update_tgthint - update target hint of a DFS cache entry
1039  * without sending any requests to the currently connected server.
1040  *
1041  * NOTE: This function will neither update a cache entry in case it was
1042  * expired, nor create a new cache entry if @path hasn't been found. It heavily
1043  * relies on an existing cache entry.
1044  *
1045  * @path: path to lookup in DFS referral cache.
1046  * @it: target iterator which contains the target hint to update the cache
1047  * entry with.
1048  *
1049  * Return zero if the target hint was updated successfully, otherwise non-zero.
1050  */
1051 int dfs_cache_noreq_update_tgthint(const char *path,
1052                                    const struct dfs_cache_tgt_iterator *it)
1053 {
1054         int rc;
1055         char *npath;
1056         struct cache_entry *ce;
1057         struct cache_dfs_tgt *t;
1058
1059         if (!it)
1060                 return -EINVAL;
1061
1062         rc = get_normalized_path(path, &npath);
1063         if (rc)
1064                 return rc;
1065
1066         cifs_dbg(FYI, "%s: path: %s\n", __func__, npath);
1067
1068         down_write(&htable_rw_lock);
1069
1070         ce = lookup_cache_entry(npath, NULL);
1071         if (IS_ERR(ce)) {
1072                 rc = PTR_ERR(ce);
1073                 goto out_unlock;
1074         }
1075
1076         rc = 0;
1077         t = ce->tgthint;
1078
1079         if (unlikely(!strcasecmp(it->it_name, t->name)))
1080                 goto out_unlock;
1081
1082         list_for_each_entry(t, &ce->tlist, list) {
1083                 if (!strcasecmp(t->name, it->it_name)) {
1084                         ce->tgthint = t;
1085                         cifs_dbg(FYI, "%s: new target hint: %s\n", __func__,
1086                                  it->it_name);
1087                         break;
1088                 }
1089         }
1090
1091 out_unlock:
1092         up_write(&htable_rw_lock);
1093         free_normalized_path(path, npath);
1094
1095         return rc;
1096 }
1097
1098 /**
1099  * dfs_cache_get_tgt_referral - returns a DFS referral (@ref) from a given
1100  * target iterator (@it).
1101  *
1102  * @path: path to lookup in DFS referral cache.
1103  * @it: DFS target iterator.
1104  * @ref: DFS referral pointer to set up the gathered information.
1105  *
1106  * Return zero if the DFS referral was set up correctly, otherwise non-zero.
1107  */
1108 int dfs_cache_get_tgt_referral(const char *path,
1109                                const struct dfs_cache_tgt_iterator *it,
1110                                struct dfs_info3_param *ref)
1111 {
1112         int rc;
1113         char *npath;
1114         struct cache_entry *ce;
1115
1116         if (!it || !ref)
1117                 return -EINVAL;
1118
1119         rc = get_normalized_path(path, &npath);
1120         if (rc)
1121                 return rc;
1122
1123         cifs_dbg(FYI, "%s: path: %s\n", __func__, npath);
1124
1125         down_read(&htable_rw_lock);
1126
1127         ce = lookup_cache_entry(npath, NULL);
1128         if (IS_ERR(ce)) {
1129                 rc = PTR_ERR(ce);
1130                 goto out_unlock;
1131         }
1132
1133         cifs_dbg(FYI, "%s: target name: %s\n", __func__, it->it_name);
1134
1135         rc = setup_referral(path, ce, ref, it->it_name);
1136
1137 out_unlock:
1138         up_read(&htable_rw_lock);
1139         free_normalized_path(path, npath);
1140
1141         return rc;
1142 }
1143
1144 /**
1145  * dfs_cache_add_vol - add a cifs context during mount() that will be handled by
1146  * DFS cache refresh worker.
1147  *
1148  * @mntdata: mount data.
1149  * @ctx: cifs context.
1150  * @fullpath: origin full path.
1151  *
1152  * Return zero if context was set up correctly, otherwise non-zero.
1153  */
1154 int dfs_cache_add_vol(char *mntdata, struct smb3_fs_context *ctx, const char *fullpath)
1155 {
1156         int rc;
1157         struct vol_info *vi;
1158
1159         if (!ctx || !fullpath || !mntdata)
1160                 return -EINVAL;
1161
1162         cifs_dbg(FYI, "%s: fullpath: %s\n", __func__, fullpath);
1163
1164         vi = kzalloc(sizeof(*vi), GFP_KERNEL);
1165         if (!vi)
1166                 return -ENOMEM;
1167
1168         vi->fullpath = kstrndup(fullpath, strlen(fullpath), GFP_KERNEL);
1169         if (!vi->fullpath) {
1170                 rc = -ENOMEM;
1171                 goto err_free_vi;
1172         }
1173
1174         rc = smb3_fs_context_dup(&vi->ctx, ctx);
1175         if (rc)
1176                 goto err_free_fullpath;
1177
1178         vi->mntdata = mntdata;
1179         spin_lock_init(&vi->ctx_lock);
1180         kref_init(&vi->refcnt);
1181
1182         spin_lock(&vol_list_lock);
1183         list_add_tail(&vi->list, &vol_list);
1184         spin_unlock(&vol_list_lock);
1185
1186         return 0;
1187
1188 err_free_fullpath:
1189         kfree(vi->fullpath);
1190 err_free_vi:
1191         kfree(vi);
1192         return rc;
1193 }
1194
1195 /* Must be called with vol_list_lock held */
1196 static struct vol_info *find_vol(const char *fullpath)
1197 {
1198         struct vol_info *vi;
1199
1200         list_for_each_entry(vi, &vol_list, list) {
1201                 cifs_dbg(FYI, "%s: vi->fullpath: %s\n", __func__, vi->fullpath);
1202                 if (!strcasecmp(vi->fullpath, fullpath))
1203                         return vi;
1204         }
1205         return ERR_PTR(-ENOENT);
1206 }
1207
1208 /**
1209  * dfs_cache_update_vol - update vol info in DFS cache after failover
1210  *
1211  * @fullpath: fullpath to look up in volume list.
1212  * @server: TCP ses pointer.
1213  *
1214  * Return zero if volume was updated, otherwise non-zero.
1215  */
1216 int dfs_cache_update_vol(const char *fullpath, struct TCP_Server_Info *server)
1217 {
1218         struct vol_info *vi;
1219
1220         if (!fullpath || !server)
1221                 return -EINVAL;
1222
1223         cifs_dbg(FYI, "%s: fullpath: %s\n", __func__, fullpath);
1224
1225         spin_lock(&vol_list_lock);
1226         vi = find_vol(fullpath);
1227         if (IS_ERR(vi)) {
1228                 spin_unlock(&vol_list_lock);
1229                 return PTR_ERR(vi);
1230         }
1231         kref_get(&vi->refcnt);
1232         spin_unlock(&vol_list_lock);
1233
1234         cifs_dbg(FYI, "%s: updating volume info\n", __func__);
1235         spin_lock(&vi->ctx_lock);
1236         memcpy(&vi->ctx.dstaddr, &server->dstaddr,
1237                sizeof(vi->ctx.dstaddr));
1238         spin_unlock(&vi->ctx_lock);
1239
1240         kref_put(&vi->refcnt, vol_release);
1241
1242         return 0;
1243 }
1244
1245 /**
1246  * dfs_cache_del_vol - remove volume info in DFS cache during umount()
1247  *
1248  * @fullpath: fullpath to look up in volume list.
1249  */
1250 void dfs_cache_del_vol(const char *fullpath)
1251 {
1252         struct vol_info *vi;
1253
1254         if (!fullpath || !*fullpath)
1255                 return;
1256
1257         cifs_dbg(FYI, "%s: fullpath: %s\n", __func__, fullpath);
1258
1259         spin_lock(&vol_list_lock);
1260         vi = find_vol(fullpath);
1261         spin_unlock(&vol_list_lock);
1262
1263         kref_put(&vi->refcnt, vol_release);
1264 }
1265
1266 /**
1267  * dfs_cache_get_tgt_share - parse a DFS target
1268  *
1269  * @path: DFS full path
1270  * @it: DFS target iterator.
1271  * @share: tree name.
1272  * @prefix: prefix path.
1273  *
1274  * Return zero if target was parsed correctly, otherwise non-zero.
1275  */
1276 int dfs_cache_get_tgt_share(char *path, const struct dfs_cache_tgt_iterator *it,
1277                             char **share, char **prefix)
1278 {
1279         char *s, sep, *p;
1280         size_t len;
1281         size_t plen1, plen2;
1282
1283         if (!it || !path || !share || !prefix || strlen(path) < it->it_path_consumed)
1284                 return -EINVAL;
1285
1286         *share = NULL;
1287         *prefix = NULL;
1288
1289         sep = it->it_name[0];
1290         if (sep != '\\' && sep != '/')
1291                 return -EINVAL;
1292
1293         s = strchr(it->it_name + 1, sep);
1294         if (!s)
1295                 return -EINVAL;
1296
1297         /* point to prefix in target node */
1298         s = strchrnul(s + 1, sep);
1299
1300         /* extract target share */
1301         *share = kstrndup(it->it_name, s - it->it_name, GFP_KERNEL);
1302         if (!*share)
1303                 return -ENOMEM;
1304
1305         /* skip separator */
1306         if (*s)
1307                 s++;
1308         /* point to prefix in DFS path */
1309         p = path + it->it_path_consumed;
1310         if (*p == sep)
1311                 p++;
1312
1313         /* merge prefix paths from DFS path and target node */
1314         plen1 = it->it_name + strlen(it->it_name) - s;
1315         plen2 = path + strlen(path) - p;
1316         if (plen1 || plen2) {
1317                 len = plen1 + plen2 + 2;
1318                 *prefix = kmalloc(len, GFP_KERNEL);
1319                 if (!*prefix) {
1320                         kfree(*share);
1321                         *share = NULL;
1322                         return -ENOMEM;
1323                 }
1324                 if (plen1)
1325                         scnprintf(*prefix, len, "%.*s%c%.*s", (int)plen1, s, sep, (int)plen2, p);
1326                 else
1327                         strscpy(*prefix, p, len);
1328         }
1329         return 0;
1330 }
1331
1332 /* Get all tcons that are within a DFS namespace and can be refreshed */
1333 static void get_tcons(struct TCP_Server_Info *server, struct list_head *head)
1334 {
1335         struct cifs_ses *ses;
1336         struct cifs_tcon *tcon;
1337
1338         INIT_LIST_HEAD(head);
1339
1340         spin_lock(&cifs_tcp_ses_lock);
1341         list_for_each_entry(ses, &server->smb_ses_list, smb_ses_list) {
1342                 list_for_each_entry(tcon, &ses->tcon_list, tcon_list) {
1343                         if (!tcon->need_reconnect && !tcon->need_reopen_files &&
1344                             tcon->dfs_path) {
1345                                 tcon->tc_count++;
1346                                 list_add_tail(&tcon->ulist, head);
1347                         }
1348                 }
1349                 if (ses->tcon_ipc && !ses->tcon_ipc->need_reconnect &&
1350                     ses->tcon_ipc->dfs_path) {
1351                         list_add_tail(&ses->tcon_ipc->ulist, head);
1352                 }
1353         }
1354         spin_unlock(&cifs_tcp_ses_lock);
1355 }
1356
1357 static bool is_dfs_link(const char *path)
1358 {
1359         char *s;
1360
1361         s = strchr(path + 1, '\\');
1362         if (!s)
1363                 return false;
1364         return !!strchr(s + 1, '\\');
1365 }
1366
1367 static char *get_dfs_root(const char *path)
1368 {
1369         char *s, *npath;
1370
1371         s = strchr(path + 1, '\\');
1372         if (!s)
1373                 return ERR_PTR(-EINVAL);
1374
1375         s = strchr(s + 1, '\\');
1376         if (!s)
1377                 return ERR_PTR(-EINVAL);
1378
1379         npath = kstrndup(path, s - path, GFP_KERNEL);
1380         if (!npath)
1381                 return ERR_PTR(-ENOMEM);
1382
1383         return npath;
1384 }
1385
1386 static inline void put_tcp_server(struct TCP_Server_Info *server)
1387 {
1388         cifs_put_tcp_session(server, 0);
1389 }
1390
1391 static struct TCP_Server_Info *get_tcp_server(struct smb3_fs_context *ctx)
1392 {
1393         struct TCP_Server_Info *server;
1394
1395         server = cifs_find_tcp_session(ctx);
1396         if (IS_ERR_OR_NULL(server))
1397                 return NULL;
1398
1399         spin_lock(&GlobalMid_Lock);
1400         if (server->tcpStatus != CifsGood) {
1401                 spin_unlock(&GlobalMid_Lock);
1402                 put_tcp_server(server);
1403                 return NULL;
1404         }
1405         spin_unlock(&GlobalMid_Lock);
1406
1407         return server;
1408 }
1409
1410 /* Find root SMB session out of a DFS link path */
1411 static struct cifs_ses *find_root_ses(struct vol_info *vi,
1412                                       struct cifs_tcon *tcon,
1413                                       const char *path)
1414 {
1415         char *rpath;
1416         int rc;
1417         struct cache_entry *ce;
1418         struct dfs_info3_param ref = {0};
1419         char *mdata = NULL;
1420         struct TCP_Server_Info *server;
1421         struct cifs_ses *ses;
1422         struct smb3_fs_context ctx = {NULL};
1423
1424         rpath = get_dfs_root(path);
1425         if (IS_ERR(rpath))
1426                 return ERR_CAST(rpath);
1427
1428         down_read(&htable_rw_lock);
1429
1430         ce = lookup_cache_entry(rpath, NULL);
1431         if (IS_ERR(ce)) {
1432                 up_read(&htable_rw_lock);
1433                 ses = ERR_CAST(ce);
1434                 goto out;
1435         }
1436
1437         rc = setup_referral(path, ce, &ref, get_tgt_name(ce));
1438         if (rc) {
1439                 up_read(&htable_rw_lock);
1440                 ses = ERR_PTR(rc);
1441                 goto out;
1442         }
1443
1444         up_read(&htable_rw_lock);
1445
1446         mdata = cifs_compose_mount_options(vi->mntdata, rpath, &ref);
1447         free_dfs_info_param(&ref);
1448
1449         if (IS_ERR(mdata)) {
1450                 ses = ERR_CAST(mdata);
1451                 mdata = NULL;
1452                 goto out;
1453         }
1454
1455         rc = cifs_setup_volume_info(&ctx);
1456
1457         if (rc) {
1458                 ses = ERR_PTR(rc);
1459                 goto out;
1460         }
1461
1462         server = get_tcp_server(&ctx);
1463         if (!server) {
1464                 ses = ERR_PTR(-EHOSTDOWN);
1465                 goto out;
1466         }
1467
1468         ses = cifs_get_smb_ses(server, &ctx);
1469
1470 out:
1471         smb3_cleanup_fs_context_contents(&ctx);
1472         kfree(mdata);
1473         kfree(rpath);
1474
1475         return ses;
1476 }
1477
1478 /* Refresh DFS cache entry from a given tcon */
1479 static int refresh_tcon(struct vol_info *vi, struct cifs_tcon *tcon)
1480 {
1481         int rc = 0;
1482         unsigned int xid;
1483         char *path, *npath;
1484         struct cache_entry *ce;
1485         struct cifs_ses *root_ses = NULL, *ses;
1486         struct dfs_info3_param *refs = NULL;
1487         int numrefs = 0;
1488
1489         xid = get_xid();
1490
1491         path = tcon->dfs_path + 1;
1492
1493         rc = get_normalized_path(path, &npath);
1494         if (rc)
1495                 goto out_free_xid;
1496
1497         down_read(&htable_rw_lock);
1498
1499         ce = lookup_cache_entry(npath, NULL);
1500         if (IS_ERR(ce)) {
1501                 rc = PTR_ERR(ce);
1502                 up_read(&htable_rw_lock);
1503                 goto out_free_path;
1504         }
1505
1506         if (!cache_entry_expired(ce)) {
1507                 up_read(&htable_rw_lock);
1508                 goto out_free_path;
1509         }
1510
1511         up_read(&htable_rw_lock);
1512
1513         /* If it's a DFS Link, then use root SMB session for refreshing it */
1514         if (is_dfs_link(npath)) {
1515                 ses = root_ses = find_root_ses(vi, tcon, npath);
1516                 if (IS_ERR(ses)) {
1517                         rc = PTR_ERR(ses);
1518                         root_ses = NULL;
1519                         goto out_free_path;
1520                 }
1521         } else {
1522                 ses = tcon->ses;
1523         }
1524
1525         rc = get_dfs_referral(xid, ses, cache_nlsc, tcon->remap, npath, &refs,
1526                               &numrefs);
1527         if (!rc) {
1528                 dump_refs(refs, numrefs);
1529                 rc = update_cache_entry(npath, refs, numrefs);
1530                 free_dfs_info_array(refs, numrefs);
1531         }
1532
1533         if (root_ses)
1534                 cifs_put_smb_ses(root_ses);
1535
1536 out_free_path:
1537         free_normalized_path(path, npath);
1538
1539 out_free_xid:
1540         free_xid(xid);
1541         return rc;
1542 }
1543
1544 /*
1545  * Worker that will refresh DFS cache based on lowest TTL value from a DFS
1546  * referral.
1547  */
1548 static void refresh_cache_worker(struct work_struct *work)
1549 {
1550         struct vol_info *vi, *nvi;
1551         struct TCP_Server_Info *server;
1552         LIST_HEAD(vols);
1553         LIST_HEAD(tcons);
1554         struct cifs_tcon *tcon, *ntcon;
1555         int rc;
1556
1557         /*
1558          * Find SMB volumes that are eligible (server->tcpStatus == CifsGood)
1559          * for refreshing.
1560          */
1561         spin_lock(&vol_list_lock);
1562         list_for_each_entry(vi, &vol_list, list) {
1563                 server = get_tcp_server(&vi->ctx);
1564                 if (!server)
1565                         continue;
1566
1567                 kref_get(&vi->refcnt);
1568                 list_add_tail(&vi->rlist, &vols);
1569                 put_tcp_server(server);
1570         }
1571         spin_unlock(&vol_list_lock);
1572
1573         /* Walk through all TCONs and refresh any expired cache entry */
1574         list_for_each_entry_safe(vi, nvi, &vols, rlist) {
1575                 spin_lock(&vi->ctx_lock);
1576                 server = get_tcp_server(&vi->ctx);
1577                 spin_unlock(&vi->ctx_lock);
1578
1579                 if (!server)
1580                         goto next_vol;
1581
1582                 get_tcons(server, &tcons);
1583                 rc = 0;
1584
1585                 list_for_each_entry_safe(tcon, ntcon, &tcons, ulist) {
1586                         /*
1587                          * Skip tcp server if any of its tcons failed to refresh
1588                          * (possibily due to reconnects).
1589                          */
1590                         if (!rc)
1591                                 rc = refresh_tcon(vi, tcon);
1592
1593                         list_del_init(&tcon->ulist);
1594                         cifs_put_tcon(tcon);
1595                 }
1596
1597                 put_tcp_server(server);
1598
1599 next_vol:
1600                 list_del_init(&vi->rlist);
1601                 kref_put(&vi->refcnt, vol_release);
1602         }
1603
1604         spin_lock(&cache_ttl_lock);
1605         queue_delayed_work(dfscache_wq, &refresh_task, cache_ttl * HZ);
1606         spin_unlock(&cache_ttl_lock);
1607 }