xref: /OK3568_Linux_fs/kernel/fs/cifs/dfs_cache.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * DFS referral cache routines
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (c) 2018-2019 Paulo Alcantara <palcantara@suse.de>
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #ifndef _CIFS_DFS_CACHE_H
9*4882a593Smuzhiyun #define _CIFS_DFS_CACHE_H
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/nls.h>
12*4882a593Smuzhiyun #include <linux/list.h>
13*4882a593Smuzhiyun #include "cifsglob.h"
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun struct dfs_cache_tgt_list {
16*4882a593Smuzhiyun 	int tl_numtgts;
17*4882a593Smuzhiyun 	struct list_head tl_list;
18*4882a593Smuzhiyun };
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun struct dfs_cache_tgt_iterator {
21*4882a593Smuzhiyun 	char *it_name;
22*4882a593Smuzhiyun 	int it_path_consumed;
23*4882a593Smuzhiyun 	struct list_head it_list;
24*4882a593Smuzhiyun };
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun extern int dfs_cache_init(void);
27*4882a593Smuzhiyun extern void dfs_cache_destroy(void);
28*4882a593Smuzhiyun extern const struct proc_ops dfscache_proc_ops;
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun extern int dfs_cache_find(const unsigned int xid, struct cifs_ses *ses,
31*4882a593Smuzhiyun 			  const struct nls_table *nls_codepage, int remap,
32*4882a593Smuzhiyun 			  const char *path, struct dfs_info3_param *ref,
33*4882a593Smuzhiyun 			  struct dfs_cache_tgt_list *tgt_list);
34*4882a593Smuzhiyun extern int dfs_cache_noreq_find(const char *path, struct dfs_info3_param *ref,
35*4882a593Smuzhiyun 				struct dfs_cache_tgt_list *tgt_list);
36*4882a593Smuzhiyun extern int dfs_cache_update_tgthint(const unsigned int xid,
37*4882a593Smuzhiyun 				    struct cifs_ses *ses,
38*4882a593Smuzhiyun 				    const struct nls_table *nls_codepage,
39*4882a593Smuzhiyun 				    int remap, const char *path,
40*4882a593Smuzhiyun 				    const struct dfs_cache_tgt_iterator *it);
41*4882a593Smuzhiyun extern int
42*4882a593Smuzhiyun dfs_cache_noreq_update_tgthint(const char *path,
43*4882a593Smuzhiyun 			       const struct dfs_cache_tgt_iterator *it);
44*4882a593Smuzhiyun extern int dfs_cache_get_tgt_referral(const char *path,
45*4882a593Smuzhiyun 				      const struct dfs_cache_tgt_iterator *it,
46*4882a593Smuzhiyun 				      struct dfs_info3_param *ref);
47*4882a593Smuzhiyun extern int dfs_cache_add_vol(char *mntdata, struct smb_vol *vol,
48*4882a593Smuzhiyun 			const char *fullpath);
49*4882a593Smuzhiyun extern int dfs_cache_update_vol(const char *fullpath,
50*4882a593Smuzhiyun 				struct TCP_Server_Info *server);
51*4882a593Smuzhiyun extern void dfs_cache_del_vol(const char *fullpath);
52*4882a593Smuzhiyun extern int dfs_cache_get_tgt_share(char *path, const struct dfs_cache_tgt_iterator *it,
53*4882a593Smuzhiyun 				   char **share, char **prefix);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun static inline struct dfs_cache_tgt_iterator *
dfs_cache_get_next_tgt(struct dfs_cache_tgt_list * tl,struct dfs_cache_tgt_iterator * it)56*4882a593Smuzhiyun dfs_cache_get_next_tgt(struct dfs_cache_tgt_list *tl,
57*4882a593Smuzhiyun 		       struct dfs_cache_tgt_iterator *it)
58*4882a593Smuzhiyun {
59*4882a593Smuzhiyun 	if (!tl || list_empty(&tl->tl_list) || !it ||
60*4882a593Smuzhiyun 	    list_is_last(&it->it_list, &tl->tl_list))
61*4882a593Smuzhiyun 		return NULL;
62*4882a593Smuzhiyun 	return list_next_entry(it, it_list);
63*4882a593Smuzhiyun }
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun static inline struct dfs_cache_tgt_iterator *
dfs_cache_get_tgt_iterator(struct dfs_cache_tgt_list * tl)66*4882a593Smuzhiyun dfs_cache_get_tgt_iterator(struct dfs_cache_tgt_list *tl)
67*4882a593Smuzhiyun {
68*4882a593Smuzhiyun 	if (!tl)
69*4882a593Smuzhiyun 		return NULL;
70*4882a593Smuzhiyun 	return list_first_entry_or_null(&tl->tl_list,
71*4882a593Smuzhiyun 					struct dfs_cache_tgt_iterator,
72*4882a593Smuzhiyun 					it_list);
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun 
dfs_cache_free_tgts(struct dfs_cache_tgt_list * tl)75*4882a593Smuzhiyun static inline void dfs_cache_free_tgts(struct dfs_cache_tgt_list *tl)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun 	struct dfs_cache_tgt_iterator *it, *nit;
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun 	if (!tl || list_empty(&tl->tl_list))
80*4882a593Smuzhiyun 		return;
81*4882a593Smuzhiyun 	list_for_each_entry_safe(it, nit, &tl->tl_list, it_list) {
82*4882a593Smuzhiyun 		list_del(&it->it_list);
83*4882a593Smuzhiyun 		kfree(it->it_name);
84*4882a593Smuzhiyun 		kfree(it);
85*4882a593Smuzhiyun 	}
86*4882a593Smuzhiyun 	tl->tl_numtgts = 0;
87*4882a593Smuzhiyun }
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun static inline const char *
dfs_cache_get_tgt_name(const struct dfs_cache_tgt_iterator * it)90*4882a593Smuzhiyun dfs_cache_get_tgt_name(const struct dfs_cache_tgt_iterator *it)
91*4882a593Smuzhiyun {
92*4882a593Smuzhiyun 	return it ? it->it_name : NULL;
93*4882a593Smuzhiyun }
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun static inline int
dfs_cache_get_nr_tgts(const struct dfs_cache_tgt_list * tl)96*4882a593Smuzhiyun dfs_cache_get_nr_tgts(const struct dfs_cache_tgt_list *tl)
97*4882a593Smuzhiyun {
98*4882a593Smuzhiyun 	return tl ? tl->tl_numtgts : 0;
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun #endif /* _CIFS_DFS_CACHE_H */
102