1 // SPDX-License-Identifier: GPL-2.0
3 * DFS referral cache routines
5 * Copyright (c) 2018-2019 Paulo Alcantara <palcantara@suse.de>
8 #include <linux/rcupdate.h>
9 #include <linux/rculist.h>
10 #include <linux/jhash.h>
11 #include <linux/ktime.h>
12 #include <linux/slab.h>
13 #include <linux/nls.h>
14 #include <linux/workqueue.h>
17 #include "smb2proto.h"
18 #include "cifsproto.h"
19 #include "cifs_debug.h"
20 #include "cifs_unicode.h"
23 #include "dfs_cache.h"
25 #define DFS_CACHE_HTABLE_SIZE 32
26 #define DFS_CACHE_MAX_ENTRIES 64
28 #define IS_INTERLINK_SET(v) ((v) & (DFSREF_REFERRAL_SERVER | \
29 DFSREF_STORAGE_SERVER))
31 struct dfs_cache_tgt {
33 struct list_head t_list;
36 struct dfs_cache_entry {
37 struct hlist_node ce_hlist;
42 struct timespec64 ce_etime;
45 struct list_head ce_tlist;
46 struct dfs_cache_tgt *ce_tgthint;
47 struct rcu_head ce_rcu;
50 static struct kmem_cache *dfs_cache_slab __read_mostly;
52 struct dfs_cache_vol_info {
54 struct smb_vol vi_vol;
56 struct list_head vi_list;
61 struct nls_table *dc_nlsc;
62 struct list_head dc_vol_list;
64 struct delayed_work dc_refresh;
67 static struct dfs_cache dfs_cache;
70 * Number of entries in the cache
72 static size_t dfs_cache_count;
74 static DEFINE_MUTEX(dfs_cache_list_lock);
75 static struct hlist_head dfs_cache_htable[DFS_CACHE_HTABLE_SIZE];
77 static void refresh_cache_worker(struct work_struct *work);
79 static inline bool is_path_valid(const char *path)
81 return path && (strchr(path + 1, '\\') || strchr(path + 1, '/'));
84 static inline int get_normalized_path(const char *path, char **npath)
87 *npath = (char *)path;
89 *npath = kstrndup(path, strlen(path), GFP_KERNEL);
92 convert_delimiter(*npath, '\\');
97 static inline void free_normalized_path(const char *path, char *npath)
103 static inline bool cache_entry_expired(const struct dfs_cache_entry *ce)
105 struct timespec64 ts;
107 ktime_get_coarse_real_ts64(&ts);
108 return timespec64_compare(&ts, &ce->ce_etime) >= 0;
111 static inline void free_tgts(struct dfs_cache_entry *ce)
113 struct dfs_cache_tgt *t, *n;
115 list_for_each_entry_safe(t, n, &ce->ce_tlist, t_list) {
116 list_del(&t->t_list);
122 static void free_cache_entry(struct rcu_head *rcu)
124 struct dfs_cache_entry *ce = container_of(rcu, struct dfs_cache_entry,
126 kmem_cache_free(dfs_cache_slab, ce);
129 static inline void flush_cache_ent(struct dfs_cache_entry *ce)
131 if (hlist_unhashed(&ce->ce_hlist))
134 hlist_del_init_rcu(&ce->ce_hlist);
135 kfree_const(ce->ce_path);
138 call_rcu(&ce->ce_rcu, free_cache_entry);
141 static void flush_cache_ents(void)
146 for (i = 0; i < DFS_CACHE_HTABLE_SIZE; i++) {
147 struct hlist_head *l = &dfs_cache_htable[i];
148 struct dfs_cache_entry *ce;
150 hlist_for_each_entry_rcu(ce, l, ce_hlist)
157 * dfs cache /proc file
159 static int dfscache_proc_show(struct seq_file *m, void *v)
162 struct dfs_cache_entry *ce;
163 struct dfs_cache_tgt *t;
165 seq_puts(m, "DFS cache\n---------\n");
167 mutex_lock(&dfs_cache_list_lock);
170 hash_for_each_rcu(dfs_cache_htable, bucket, ce, ce_hlist) {
172 "cache entry: path=%s,type=%s,ttl=%d,etime=%ld,"
173 "interlink=%s,path_consumed=%d,expired=%s\n",
175 ce->ce_srvtype == DFS_TYPE_ROOT ? "root" : "link",
176 ce->ce_ttl, ce->ce_etime.tv_nsec,
177 IS_INTERLINK_SET(ce->ce_flags) ? "yes" : "no",
178 ce->ce_path_consumed,
179 cache_entry_expired(ce) ? "yes" : "no");
181 list_for_each_entry(t, &ce->ce_tlist, t_list) {
182 seq_printf(m, " %s%s\n",
184 ce->ce_tgthint == t ? " (target hint)" : "");
190 mutex_unlock(&dfs_cache_list_lock);
194 static ssize_t dfscache_proc_write(struct file *file, const char __user *buffer,
195 size_t count, loff_t *ppos)
200 rc = get_user(c, buffer);
207 cifs_dbg(FYI, "clearing dfs cache");
208 mutex_lock(&dfs_cache_list_lock);
210 mutex_unlock(&dfs_cache_list_lock);
215 static int dfscache_proc_open(struct inode *inode, struct file *file)
217 return single_open(file, dfscache_proc_show, NULL);
220 const struct file_operations dfscache_proc_fops = {
221 .open = dfscache_proc_open,
224 .release = single_release,
225 .write = dfscache_proc_write,
228 #ifdef CONFIG_CIFS_DEBUG2
229 static inline void dump_tgts(const struct dfs_cache_entry *ce)
231 struct dfs_cache_tgt *t;
233 cifs_dbg(FYI, "target list:\n");
234 list_for_each_entry(t, &ce->ce_tlist, t_list) {
235 cifs_dbg(FYI, " %s%s\n", t->t_name,
236 ce->ce_tgthint == t ? " (target hint)" : "");
240 static inline void dump_ce(const struct dfs_cache_entry *ce)
242 cifs_dbg(FYI, "cache entry: path=%s,type=%s,ttl=%d,etime=%ld,"
243 "interlink=%s,path_consumed=%d,expired=%s\n", ce->ce_path,
244 ce->ce_srvtype == DFS_TYPE_ROOT ? "root" : "link", ce->ce_ttl,
245 ce->ce_etime.tv_nsec,
246 IS_INTERLINK_SET(ce->ce_flags) ? "yes" : "no",
247 ce->ce_path_consumed,
248 cache_entry_expired(ce) ? "yes" : "no");
252 static inline void dump_refs(const struct dfs_info3_param *refs, int numrefs)
256 cifs_dbg(FYI, "DFS referrals returned by the server:\n");
257 for (i = 0; i < numrefs; i++) {
258 const struct dfs_info3_param *ref = &refs[i];
263 "path_consumed: %d\n"
264 "server_type: 0x%x\n"
269 ref->flags, ref->path_consumed, ref->server_type,
270 ref->ref_flag, ref->path_name, ref->node_name,
271 ref->ttl, ref->ttl / 60);
277 #define dump_refs(r, n)
281 * dfs_cache_init - Initialize DFS referral cache.
283 * Return zero if initialized successfully, otherwise non-zero.
285 int dfs_cache_init(void)
289 dfs_cache_slab = kmem_cache_create("cifs_dfs_cache",
290 sizeof(struct dfs_cache_entry), 0,
291 SLAB_HWCACHE_ALIGN, NULL);
295 for (i = 0; i < DFS_CACHE_HTABLE_SIZE; i++)
296 INIT_HLIST_HEAD(&dfs_cache_htable[i]);
298 INIT_LIST_HEAD(&dfs_cache.dc_vol_list);
299 mutex_init(&dfs_cache.dc_lock);
300 INIT_DELAYED_WORK(&dfs_cache.dc_refresh, refresh_cache_worker);
301 dfs_cache.dc_ttl = -1;
302 dfs_cache.dc_nlsc = load_nls_default();
304 cifs_dbg(FYI, "%s: initialized DFS referral cache\n", __func__);
308 static inline unsigned int cache_entry_hash(const void *data, int size)
312 h = jhash(data, size, 0);
313 return h & (DFS_CACHE_HTABLE_SIZE - 1);
316 /* Check whether second path component of @path is SYSVOL or NETLOGON */
317 static inline bool is_sysvol_or_netlogon(const char *path)
322 s = strchr(path + 1, sep) + 1;
323 return !strncasecmp(s, "sysvol", strlen("sysvol")) ||
324 !strncasecmp(s, "netlogon", strlen("netlogon"));
327 /* Return target hint of a DFS cache entry */
328 static inline char *get_tgt_name(const struct dfs_cache_entry *ce)
330 struct dfs_cache_tgt *t = ce->ce_tgthint;
332 return t ? t->t_name : ERR_PTR(-ENOENT);
335 /* Return expire time out of a new entry's TTL */
336 static inline struct timespec64 get_expire_time(int ttl)
338 struct timespec64 ts = {
342 struct timespec64 now;
344 ktime_get_coarse_real_ts64(&now);
345 return timespec64_add(now, ts);
348 /* Allocate a new DFS target */
349 static inline struct dfs_cache_tgt *alloc_tgt(const char *name)
351 struct dfs_cache_tgt *t;
353 t = kmalloc(sizeof(*t), GFP_KERNEL);
355 return ERR_PTR(-ENOMEM);
356 t->t_name = kstrndup(name, strlen(name), GFP_KERNEL);
359 return ERR_PTR(-ENOMEM);
361 INIT_LIST_HEAD(&t->t_list);
366 * Copy DFS referral information to a cache entry and conditionally update
369 static int copy_ref_data(const struct dfs_info3_param *refs, int numrefs,
370 struct dfs_cache_entry *ce, const char *tgthint)
374 ce->ce_ttl = refs[0].ttl;
375 ce->ce_etime = get_expire_time(ce->ce_ttl);
376 ce->ce_srvtype = refs[0].server_type;
377 ce->ce_flags = refs[0].ref_flag;
378 ce->ce_path_consumed = refs[0].path_consumed;
380 for (i = 0; i < numrefs; i++) {
381 struct dfs_cache_tgt *t;
383 t = alloc_tgt(refs[i].node_name);
388 if (tgthint && !strcasecmp(t->t_name, tgthint)) {
389 list_add(&t->t_list, &ce->ce_tlist);
392 list_add_tail(&t->t_list, &ce->ce_tlist);
397 ce->ce_tgthint = list_first_entry_or_null(&ce->ce_tlist,
398 struct dfs_cache_tgt, t_list);
403 /* Allocate a new cache entry */
404 static struct dfs_cache_entry *
405 alloc_cache_entry(const char *path, const struct dfs_info3_param *refs,
408 struct dfs_cache_entry *ce;
411 ce = kmem_cache_zalloc(dfs_cache_slab, GFP_KERNEL);
413 return ERR_PTR(-ENOMEM);
415 ce->ce_path = kstrdup_const(path, GFP_KERNEL);
417 kmem_cache_free(dfs_cache_slab, ce);
418 return ERR_PTR(-ENOMEM);
420 INIT_HLIST_NODE(&ce->ce_hlist);
421 INIT_LIST_HEAD(&ce->ce_tlist);
423 rc = copy_ref_data(refs, numrefs, ce, NULL);
425 kfree_const(ce->ce_path);
426 kmem_cache_free(dfs_cache_slab, ce);
432 static void remove_oldest_entry(void)
435 struct dfs_cache_entry *ce;
436 struct dfs_cache_entry *to_del = NULL;
439 hash_for_each_rcu(dfs_cache_htable, bucket, ce, ce_hlist) {
440 if (!to_del || timespec64_compare(&ce->ce_etime,
441 &to_del->ce_etime) < 0)
445 cifs_dbg(FYI, "%s: no entry to remove", __func__);
448 cifs_dbg(FYI, "%s: removing entry", __func__);
450 flush_cache_ent(to_del);
455 /* Add a new DFS cache entry */
456 static inline struct dfs_cache_entry *
457 add_cache_entry(unsigned int hash, const char *path,
458 const struct dfs_info3_param *refs, int numrefs)
460 struct dfs_cache_entry *ce;
462 ce = alloc_cache_entry(path, refs, numrefs);
466 hlist_add_head_rcu(&ce->ce_hlist, &dfs_cache_htable[hash]);
468 mutex_lock(&dfs_cache.dc_lock);
469 if (dfs_cache.dc_ttl < 0) {
470 dfs_cache.dc_ttl = ce->ce_ttl;
471 queue_delayed_work(cifsiod_wq, &dfs_cache.dc_refresh,
472 dfs_cache.dc_ttl * HZ);
474 dfs_cache.dc_ttl = min_t(int, dfs_cache.dc_ttl, ce->ce_ttl);
475 mod_delayed_work(cifsiod_wq, &dfs_cache.dc_refresh,
476 dfs_cache.dc_ttl * HZ);
478 mutex_unlock(&dfs_cache.dc_lock);
483 static struct dfs_cache_entry *__find_cache_entry(unsigned int hash,
486 struct dfs_cache_entry *ce;
490 hlist_for_each_entry_rcu(ce, &dfs_cache_htable[hash], ce_hlist) {
491 if (!strcasecmp(path, ce->ce_path)) {
492 #ifdef CONFIG_CIFS_DEBUG2
493 char *name = get_tgt_name(ce);
497 return ERR_CAST(name);
499 cifs_dbg(FYI, "%s: cache hit\n", __func__);
500 cifs_dbg(FYI, "%s: target hint: %s\n", __func__, name);
507 return found ? ce : ERR_PTR(-ENOENT);
511 * Find a DFS cache entry in hash table and optionally check prefix path against
513 * Use whole path components in the match.
514 * Return ERR_PTR(-ENOENT) if the entry is not found.
516 static inline struct dfs_cache_entry *find_cache_entry(const char *path,
519 *hash = cache_entry_hash(path, strlen(path));
520 return __find_cache_entry(*hash, path);
523 static inline void destroy_slab_cache(void)
526 kmem_cache_destroy(dfs_cache_slab);
529 static inline void free_vol(struct dfs_cache_vol_info *vi)
531 list_del(&vi->vi_list);
532 kfree(vi->vi_fullpath);
533 kfree(vi->vi_mntdata);
534 cifs_cleanup_volume_info_contents(&vi->vi_vol);
538 static inline void free_vol_list(void)
540 struct dfs_cache_vol_info *vi, *nvi;
542 list_for_each_entry_safe(vi, nvi, &dfs_cache.dc_vol_list, vi_list)
547 * dfs_cache_destroy - destroy DFS referral cache
549 void dfs_cache_destroy(void)
551 cancel_delayed_work_sync(&dfs_cache.dc_refresh);
552 unload_nls(dfs_cache.dc_nlsc);
554 mutex_destroy(&dfs_cache.dc_lock);
557 destroy_slab_cache();
558 mutex_destroy(&dfs_cache_list_lock);
560 cifs_dbg(FYI, "%s: destroyed DFS referral cache\n", __func__);
563 static inline struct dfs_cache_entry *
564 __update_cache_entry(const char *path, const struct dfs_info3_param *refs,
569 struct dfs_cache_entry *ce;
572 ce = find_cache_entry(path, &h);
576 if (ce->ce_tgthint) {
577 s = ce->ce_tgthint->t_name;
578 th = kstrndup(s, strlen(s), GFP_KERNEL);
580 return ERR_PTR(-ENOMEM);
586 rc = copy_ref_data(refs, numrefs, ce, th);
595 /* Update an expired cache entry by getting a new DFS referral from server */
596 static struct dfs_cache_entry *
597 update_cache_entry(const unsigned int xid, struct cifs_ses *ses,
598 const struct nls_table *nls_codepage, int remap,
599 const char *path, struct dfs_cache_entry *ce)
602 struct dfs_info3_param *refs = NULL;
605 cifs_dbg(FYI, "%s: update expired cache entry\n", __func__);
607 * Check if caller provided enough parameters to update an expired
610 if (!ses || !ses->server || !ses->server->ops->get_dfs_refer)
611 return ERR_PTR(-ETIME);
612 if (unlikely(!nls_codepage))
613 return ERR_PTR(-ETIME);
615 cifs_dbg(FYI, "%s: DFS referral request for %s\n", __func__, path);
617 rc = ses->server->ops->get_dfs_refer(xid, ses, path, &refs, &numrefs,
618 nls_codepage, remap);
622 ce = __update_cache_entry(path, refs, numrefs);
624 dump_refs(refs, numrefs);
625 free_dfs_info_array(refs, numrefs);
631 * Find, create or update a DFS cache entry.
633 * If the entry wasn't found, it will create a new one. Or if it was found but
634 * expired, then it will update the entry accordingly.
636 * For interlinks, __cifs_dfs_mount() and expand_dfs_referral() are supposed to
637 * handle them properly.
639 static struct dfs_cache_entry *
640 do_dfs_cache_find(const unsigned int xid, struct cifs_ses *ses,
641 const struct nls_table *nls_codepage, int remap,
642 const char *path, bool noreq)
646 struct dfs_cache_entry *ce;
647 struct dfs_info3_param *nrefs;
650 cifs_dbg(FYI, "%s: search path: %s\n", __func__, path);
652 ce = find_cache_entry(path, &h);
654 cifs_dbg(FYI, "%s: cache miss\n", __func__);
656 * If @noreq is set, no requests will be sent to the server for
657 * either updating or getting a new DFS referral.
662 * No cache entry was found, so check for valid parameters that
663 * will be required to get a new DFS referral and then create a
666 if (!ses || !ses->server || !ses->server->ops->get_dfs_refer) {
667 ce = ERR_PTR(-EOPNOTSUPP);
670 if (unlikely(!nls_codepage)) {
671 ce = ERR_PTR(-EINVAL);
678 cifs_dbg(FYI, "%s: DFS referral request for %s\n", __func__,
681 rc = ses->server->ops->get_dfs_refer(xid, ses, path, &nrefs,
682 &numnrefs, nls_codepage,
689 dump_refs(nrefs, numnrefs);
691 cifs_dbg(FYI, "%s: new cache entry\n", __func__);
693 if (dfs_cache_count >= DFS_CACHE_MAX_ENTRIES) {
694 cifs_dbg(FYI, "%s: reached max cache size (%d)",
695 __func__, DFS_CACHE_MAX_ENTRIES);
696 remove_oldest_entry();
698 ce = add_cache_entry(h, path, nrefs, numnrefs);
699 free_dfs_info_array(nrefs, numnrefs);
709 /* Just return the found cache entry in case @noreq is set */
713 if (cache_entry_expired(ce)) {
714 cifs_dbg(FYI, "%s: expired cache entry\n", __func__);
715 ce = update_cache_entry(xid, ses, nls_codepage, remap, path,
718 cifs_dbg(FYI, "%s: failed to update expired entry\n",
725 /* Set up a new DFS referral from a given cache entry */
726 static int setup_ref(const char *path, const struct dfs_cache_entry *ce,
727 struct dfs_info3_param *ref, const char *tgt)
731 cifs_dbg(FYI, "%s: set up new ref\n", __func__);
733 memset(ref, 0, sizeof(*ref));
735 ref->path_name = kstrndup(path, strlen(path), GFP_KERNEL);
739 ref->path_consumed = ce->ce_path_consumed;
741 ref->node_name = kstrndup(tgt, strlen(tgt), GFP_KERNEL);
742 if (!ref->node_name) {
747 ref->ttl = ce->ce_ttl;
748 ref->server_type = ce->ce_srvtype;
749 ref->ref_flag = ce->ce_flags;
754 kfree(ref->path_name);
755 ref->path_name = NULL;
759 /* Return target list of a DFS cache entry */
760 static int get_tgt_list(const struct dfs_cache_entry *ce,
761 struct dfs_cache_tgt_list *tl)
764 struct list_head *head = &tl->tl_list;
765 struct dfs_cache_tgt *t;
766 struct dfs_cache_tgt_iterator *it, *nit;
768 memset(tl, 0, sizeof(*tl));
769 INIT_LIST_HEAD(head);
771 list_for_each_entry(t, &ce->ce_tlist, t_list) {
772 it = kzalloc(sizeof(*it), GFP_KERNEL);
778 it->it_name = kstrndup(t->t_name, strlen(t->t_name),
786 if (ce->ce_tgthint == t)
787 list_add(&it->it_list, head);
789 list_add_tail(&it->it_list, head);
791 tl->tl_numtgts = ce->ce_numtgts;
796 list_for_each_entry_safe(it, nit, head, it_list) {
804 * dfs_cache_find - find a DFS cache entry
806 * If it doesn't find the cache entry, then it will get a DFS referral
807 * for @path and create a new entry.
809 * In case the cache entry exists but expired, it will get a DFS referral
810 * for @path and then update the respective cache entry.
812 * These parameters are passed down to the get_dfs_refer() call if it
813 * needs to be issued:
815 * @ses: smb session to issue the request on
816 * @nls_codepage: charset conversion
817 * @remap: path character remapping type
818 * @path: path to lookup in DFS referral cache.
820 * @ref: when non-NULL, store single DFS referral result in it.
821 * @tgt_list: when non-NULL, store complete DFS target list in it.
823 * Return zero if the target was found, otherwise non-zero.
825 int dfs_cache_find(const unsigned int xid, struct cifs_ses *ses,
826 const struct nls_table *nls_codepage, int remap,
827 const char *path, struct dfs_info3_param *ref,
828 struct dfs_cache_tgt_list *tgt_list)
832 struct dfs_cache_entry *ce;
834 if (unlikely(!is_path_valid(path)))
837 rc = get_normalized_path(path, &npath);
841 mutex_lock(&dfs_cache_list_lock);
842 ce = do_dfs_cache_find(xid, ses, nls_codepage, remap, npath, false);
845 rc = setup_ref(path, ce, ref, get_tgt_name(ce));
849 rc = get_tgt_list(ce, tgt_list);
853 mutex_unlock(&dfs_cache_list_lock);
854 free_normalized_path(path, npath);
859 * dfs_cache_noreq_find - find a DFS cache entry without sending any requests to
860 * the currently connected server.
862 * NOTE: This function will neither update a cache entry in case it was
863 * expired, nor create a new cache entry if @path hasn't been found. It heavily
864 * relies on an existing cache entry.
866 * @path: path to lookup in the DFS referral cache.
867 * @ref: when non-NULL, store single DFS referral result in it.
868 * @tgt_list: when non-NULL, store complete DFS target list in it.
870 * Return 0 if successful.
871 * Return -ENOENT if the entry was not found.
872 * Return non-zero for other errors.
874 int dfs_cache_noreq_find(const char *path, struct dfs_info3_param *ref,
875 struct dfs_cache_tgt_list *tgt_list)
879 struct dfs_cache_entry *ce;
881 if (unlikely(!is_path_valid(path)))
884 rc = get_normalized_path(path, &npath);
888 mutex_lock(&dfs_cache_list_lock);
889 ce = do_dfs_cache_find(0, NULL, NULL, 0, npath, true);
896 rc = setup_ref(path, ce, ref, get_tgt_name(ce));
900 rc = get_tgt_list(ce, tgt_list);
902 mutex_unlock(&dfs_cache_list_lock);
903 free_normalized_path(path, npath);
908 * dfs_cache_update_tgthint - update target hint of a DFS cache entry
910 * If it doesn't find the cache entry, then it will get a DFS referral for @path
911 * and create a new entry.
913 * In case the cache entry exists but expired, it will get a DFS referral
914 * for @path and then update the respective cache entry.
918 * @nls_codepage: charset conversion
919 * @remap: type of character remapping for paths
920 * @path: path to lookup in DFS referral cache.
921 * @it: DFS target iterator
923 * Return zero if the target hint was updated successfully, otherwise non-zero.
925 int dfs_cache_update_tgthint(const unsigned int xid, struct cifs_ses *ses,
926 const struct nls_table *nls_codepage, int remap,
928 const struct dfs_cache_tgt_iterator *it)
932 struct dfs_cache_entry *ce;
933 struct dfs_cache_tgt *t;
935 if (unlikely(!is_path_valid(path)))
938 rc = get_normalized_path(path, &npath);
942 cifs_dbg(FYI, "%s: path: %s\n", __func__, npath);
944 mutex_lock(&dfs_cache_list_lock);
945 ce = do_dfs_cache_find(xid, ses, nls_codepage, remap, npath, false);
955 if (likely(!strcasecmp(it->it_name, t->t_name)))
958 list_for_each_entry(t, &ce->ce_tlist, t_list) {
959 if (!strcasecmp(t->t_name, it->it_name)) {
961 cifs_dbg(FYI, "%s: new target hint: %s\n", __func__,
968 mutex_unlock(&dfs_cache_list_lock);
969 free_normalized_path(path, npath);
974 * dfs_cache_noreq_update_tgthint - update target hint of a DFS cache entry
975 * without sending any requests to the currently connected server.
977 * NOTE: This function will neither update a cache entry in case it was
978 * expired, nor create a new cache entry if @path hasn't been found. It heavily
979 * relies on an existing cache entry.
981 * @path: path to lookup in DFS referral cache.
982 * @it: target iterator which contains the target hint to update the cache
985 * Return zero if the target hint was updated successfully, otherwise non-zero.
987 int dfs_cache_noreq_update_tgthint(const char *path,
988 const struct dfs_cache_tgt_iterator *it)
992 struct dfs_cache_entry *ce;
993 struct dfs_cache_tgt *t;
995 if (unlikely(!is_path_valid(path)) || !it)
998 rc = get_normalized_path(path, &npath);
1002 cifs_dbg(FYI, "%s: path: %s\n", __func__, npath);
1004 mutex_lock(&dfs_cache_list_lock);
1006 ce = do_dfs_cache_find(0, NULL, NULL, 0, npath, true);
1016 if (unlikely(!strcasecmp(it->it_name, t->t_name)))
1019 list_for_each_entry(t, &ce->ce_tlist, t_list) {
1020 if (!strcasecmp(t->t_name, it->it_name)) {
1022 cifs_dbg(FYI, "%s: new target hint: %s\n", __func__,
1029 mutex_unlock(&dfs_cache_list_lock);
1030 free_normalized_path(path, npath);
1035 * dfs_cache_get_tgt_referral - returns a DFS referral (@ref) from a given
1036 * target iterator (@it).
1038 * @path: path to lookup in DFS referral cache.
1039 * @it: DFS target iterator.
1040 * @ref: DFS referral pointer to set up the gathered information.
1042 * Return zero if the DFS referral was set up correctly, otherwise non-zero.
1044 int dfs_cache_get_tgt_referral(const char *path,
1045 const struct dfs_cache_tgt_iterator *it,
1046 struct dfs_info3_param *ref)
1050 struct dfs_cache_entry *ce;
1055 if (unlikely(!is_path_valid(path)))
1058 rc = get_normalized_path(path, &npath);
1062 cifs_dbg(FYI, "%s: path: %s\n", __func__, npath);
1064 mutex_lock(&dfs_cache_list_lock);
1066 ce = find_cache_entry(npath, &h);
1072 cifs_dbg(FYI, "%s: target name: %s\n", __func__, it->it_name);
1074 rc = setup_ref(path, ce, ref, it->it_name);
1077 mutex_unlock(&dfs_cache_list_lock);
1078 free_normalized_path(path, npath);
1082 static int dup_vol(struct smb_vol *vol, struct smb_vol *new)
1084 memcpy(new, vol, sizeof(*new));
1086 if (vol->username) {
1087 new->username = kstrndup(vol->username, strlen(vol->username),
1092 if (vol->password) {
1093 new->password = kstrndup(vol->password, strlen(vol->password),
1096 goto err_free_username;
1099 cifs_dbg(FYI, "%s: vol->UNC: %s\n", __func__, vol->UNC);
1100 new->UNC = kstrndup(vol->UNC, strlen(vol->UNC), GFP_KERNEL);
1102 goto err_free_password;
1104 if (vol->domainname) {
1105 new->domainname = kstrndup(vol->domainname,
1106 strlen(vol->domainname), GFP_KERNEL);
1107 if (!new->domainname)
1110 if (vol->iocharset) {
1111 new->iocharset = kstrndup(vol->iocharset,
1112 strlen(vol->iocharset), GFP_KERNEL);
1113 if (!new->iocharset)
1114 goto err_free_domainname;
1117 cifs_dbg(FYI, "%s: vol->prepath: %s\n", __func__, vol->prepath);
1118 new->prepath = kstrndup(vol->prepath, strlen(vol->prepath),
1121 goto err_free_iocharset;
1127 kfree(new->iocharset);
1128 err_free_domainname:
1129 kfree(new->domainname);
1133 kzfree(new->password);
1135 kfree(new->username);
1141 * dfs_cache_add_vol - add a cifs volume during mount() that will be handled by
1142 * DFS cache refresh worker.
1144 * @mntdata: mount data.
1145 * @vol: cifs volume.
1146 * @fullpath: origin full path.
1148 * Return zero if volume was set up correctly, otherwise non-zero.
1150 int dfs_cache_add_vol(char *mntdata, struct smb_vol *vol, const char *fullpath)
1153 struct dfs_cache_vol_info *vi;
1155 if (!vol || !fullpath || !mntdata)
1158 cifs_dbg(FYI, "%s: fullpath: %s\n", __func__, fullpath);
1160 vi = kzalloc(sizeof(*vi), GFP_KERNEL);
1164 vi->vi_fullpath = kstrndup(fullpath, strlen(fullpath), GFP_KERNEL);
1165 if (!vi->vi_fullpath) {
1170 rc = dup_vol(vol, &vi->vi_vol);
1172 goto err_free_fullpath;
1174 vi->vi_mntdata = mntdata;
1176 mutex_lock(&dfs_cache.dc_lock);
1177 list_add_tail(&vi->vi_list, &dfs_cache.dc_vol_list);
1178 mutex_unlock(&dfs_cache.dc_lock);
1182 kfree(vi->vi_fullpath);
1188 static inline struct dfs_cache_vol_info *find_vol(const char *fullpath)
1190 struct dfs_cache_vol_info *vi;
1192 list_for_each_entry(vi, &dfs_cache.dc_vol_list, vi_list) {
1193 cifs_dbg(FYI, "%s: vi->vi_fullpath: %s\n", __func__,
1195 if (!strcasecmp(vi->vi_fullpath, fullpath))
1198 return ERR_PTR(-ENOENT);
1202 * dfs_cache_update_vol - update vol info in DFS cache after failover
1204 * @fullpath: fullpath to look up in volume list.
1205 * @server: TCP ses pointer.
1207 * Return zero if volume was updated, otherwise non-zero.
1209 int dfs_cache_update_vol(const char *fullpath, struct TCP_Server_Info *server)
1212 struct dfs_cache_vol_info *vi;
1214 if (!fullpath || !server)
1217 cifs_dbg(FYI, "%s: fullpath: %s\n", __func__, fullpath);
1219 mutex_lock(&dfs_cache.dc_lock);
1221 vi = find_vol(fullpath);
1227 cifs_dbg(FYI, "%s: updating volume info\n", __func__);
1228 memcpy(&vi->vi_vol.dstaddr, &server->dstaddr,
1229 sizeof(vi->vi_vol.dstaddr));
1233 mutex_unlock(&dfs_cache.dc_lock);
1238 * dfs_cache_del_vol - remove volume info in DFS cache during umount()
1240 * @fullpath: fullpath to look up in volume list.
1242 void dfs_cache_del_vol(const char *fullpath)
1244 struct dfs_cache_vol_info *vi;
1246 if (!fullpath || !*fullpath)
1249 cifs_dbg(FYI, "%s: fullpath: %s\n", __func__, fullpath);
1251 mutex_lock(&dfs_cache.dc_lock);
1252 vi = find_vol(fullpath);
1255 mutex_unlock(&dfs_cache.dc_lock);
1258 /* Get all tcons that are within a DFS namespace and can be refreshed */
1259 static void get_tcons(struct TCP_Server_Info *server, struct list_head *head)
1261 struct cifs_ses *ses;
1262 struct cifs_tcon *tcon;
1264 INIT_LIST_HEAD(head);
1266 spin_lock(&cifs_tcp_ses_lock);
1267 list_for_each_entry(ses, &server->smb_ses_list, smb_ses_list) {
1268 list_for_each_entry(tcon, &ses->tcon_list, tcon_list) {
1269 if (!tcon->need_reconnect && !tcon->need_reopen_files &&
1272 list_add_tail(&tcon->ulist, head);
1275 if (ses->tcon_ipc && !ses->tcon_ipc->need_reconnect &&
1276 ses->tcon_ipc->dfs_path) {
1277 list_add_tail(&ses->tcon_ipc->ulist, head);
1280 spin_unlock(&cifs_tcp_ses_lock);
1283 static inline bool is_dfs_link(const char *path)
1287 s = strchr(path + 1, '\\');
1290 return !!strchr(s + 1, '\\');
1293 static inline char *get_dfs_root(const char *path)
1297 s = strchr(path + 1, '\\');
1299 return ERR_PTR(-EINVAL);
1301 s = strchr(s + 1, '\\');
1303 return ERR_PTR(-EINVAL);
1305 npath = kstrndup(path, s - path, GFP_KERNEL);
1307 return ERR_PTR(-ENOMEM);
1312 /* Find root SMB session out of a DFS link path */
1313 static struct cifs_ses *find_root_ses(struct dfs_cache_vol_info *vi,
1314 struct cifs_tcon *tcon, const char *path)
1318 struct dfs_info3_param ref = {0};
1319 char *mdata = NULL, *devname = NULL;
1320 bool is_smb3 = tcon->ses->server->vals->header_preamble_size == 0;
1321 struct TCP_Server_Info *server;
1322 struct cifs_ses *ses;
1325 rpath = get_dfs_root(path);
1327 return ERR_CAST(rpath);
1329 memset(&vol, 0, sizeof(vol));
1331 rc = dfs_cache_noreq_find(rpath, &ref, NULL);
1337 mdata = cifs_compose_mount_options(vi->vi_mntdata, rpath, &ref,
1339 free_dfs_info_param(&ref);
1341 if (IS_ERR(mdata)) {
1342 ses = ERR_CAST(mdata);
1347 rc = cifs_setup_volume_info(&vol, mdata, devname, is_smb3);
1355 server = cifs_find_tcp_session(&vol);
1356 if (IS_ERR_OR_NULL(server)) {
1357 ses = ERR_PTR(-EHOSTDOWN);
1360 if (server->tcpStatus != CifsGood) {
1361 cifs_put_tcp_session(server, 0);
1362 ses = ERR_PTR(-EHOSTDOWN);
1366 ses = cifs_get_smb_ses(server, &vol);
1369 cifs_cleanup_volume_info_contents(&vol);
1376 /* Refresh DFS cache entry from a given tcon */
1377 static void do_refresh_tcon(struct dfs_cache *dc, struct dfs_cache_vol_info *vi,
1378 struct cifs_tcon *tcon)
1384 struct dfs_cache_entry *ce;
1385 struct dfs_info3_param *refs = NULL;
1387 struct cifs_ses *root_ses = NULL, *ses;
1391 path = tcon->dfs_path + 1;
1393 rc = get_normalized_path(path, &npath);
1397 mutex_lock(&dfs_cache_list_lock);
1398 ce = find_cache_entry(npath, &h);
1399 mutex_unlock(&dfs_cache_list_lock);
1406 if (!cache_entry_expired(ce))
1409 /* If it's a DFS Link, then use root SMB session for refreshing it */
1410 if (is_dfs_link(npath)) {
1411 ses = root_ses = find_root_ses(vi, tcon, npath);
1421 if (unlikely(!ses->server->ops->get_dfs_refer)) {
1424 rc = ses->server->ops->get_dfs_refer(xid, ses, path, &refs,
1425 &numrefs, dc->dc_nlsc,
1428 mutex_lock(&dfs_cache_list_lock);
1429 ce = __update_cache_entry(npath, refs, numrefs);
1430 mutex_unlock(&dfs_cache_list_lock);
1431 dump_refs(refs, numrefs);
1432 free_dfs_info_array(refs, numrefs);
1440 cifs_put_smb_ses(root_ses);
1443 free_normalized_path(path, npath);
1447 * Worker that will refresh DFS cache based on lowest TTL value from a DFS
1450 static void refresh_cache_worker(struct work_struct *work)
1452 struct dfs_cache *dc = container_of(work, struct dfs_cache,
1454 struct dfs_cache_vol_info *vi;
1455 struct TCP_Server_Info *server;
1457 struct cifs_tcon *tcon, *ntcon;
1459 mutex_lock(&dc->dc_lock);
1461 list_for_each_entry(vi, &dc->dc_vol_list, vi_list) {
1462 server = cifs_find_tcp_session(&vi->vi_vol);
1463 if (IS_ERR_OR_NULL(server))
1465 if (server->tcpStatus != CifsGood)
1467 get_tcons(server, &list);
1468 list_for_each_entry_safe(tcon, ntcon, &list, ulist) {
1469 do_refresh_tcon(dc, vi, tcon);
1470 list_del_init(&tcon->ulist);
1471 cifs_put_tcon(tcon);
1474 cifs_put_tcp_session(server, 0);
1476 queue_delayed_work(cifsiod_wq, &dc->dc_refresh, dc->dc_ttl * HZ);
1477 mutex_unlock(&dc->dc_lock);