xref: /linux/fs/smb/server/vfs_cache.h (revision 6b375be0b4e1be89e9a817880515311503a19114)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *   Copyright (C) 2019 Samsung Electronics Co., Ltd.
4  */
5 
6 #ifndef __VFS_CACHE_H__
7 #define __VFS_CACHE_H__
8 
9 #include <linux/file.h>
10 #include <linux/fs.h>
11 #include <linux/mutex.h>
12 #include <linux/rwsem.h>
13 #include <linux/spinlock.h>
14 #include <linux/idr.h>
15 #include <linux/workqueue.h>
16 
17 #include "vfs.h"
18 #include "mgmt/share_config.h"
19 
20 /* Windows style file permissions for extended response */
21 #define	FILE_GENERIC_ALL	0x1F01FF
22 #define	FILE_GENERIC_READ	0x120089
23 #define	FILE_GENERIC_WRITE	0x120116
24 #define	FILE_GENERIC_EXECUTE	0X1200a0
25 
26 /*
27  * Start volatile/persistent file id allocation at 1. A file id of 0 yields an
28  * SMB2 FileId of {0, 0}, which clients (e.g. Windows, Samba) treat as a null
29  * handle and never close, leaking the open on the server.
30  */
31 #define KSMBD_START_FID		1
32 #define KSMBD_NO_FID		(INT_MAX)
33 #define SMB2_NO_FID		(0xFFFFFFFFFFFFFFFFULL)
34 
35 struct ksmbd_conn;
36 struct ksmbd_session;
37 
38 struct ksmbd_lock {
39 	struct file_lock *fl;
40 	struct ksmbd_conn *conn;
41 	struct list_head clist;
42 	struct list_head flist;
43 	struct list_head llist;
44 	unsigned int flags;
45 	int cmd;
46 	int zero_len;
47 	unsigned long long start;
48 	unsigned long long end;
49 };
50 
51 struct stream {
52 	char *name;
53 	ssize_t size;
54 	loff_t pos;
55 };
56 
57 struct ksmbd_inode {
58 	struct rw_semaphore		m_lock;
59 	atomic_t			m_count;
60 	atomic_t			op_count;
61 	/* opinfo count for streams */
62 	atomic_t			sop_count;
63 	struct dentry			*m_de;
64 	unsigned int			m_flags;
65 	struct hlist_node		m_hash;
66 	struct list_head		m_fp_list;
67 	struct list_head		m_op_list;
68 	struct oplock_info		*m_opinfo;
69 	__le32				m_fattr;
70 };
71 
72 enum {
73 	FP_NEW = 0,
74 	FP_INITED,
75 	FP_CLOSED
76 };
77 
78 /* Owner information for durable handle reconnect */
79 struct durable_owner {
80 	unsigned int uid;
81 	unsigned int gid;
82 	char *name;
83 };
84 
85 struct ksmbd_file {
86 	struct file			*filp;
87 	u64				persistent_id;
88 	u64				volatile_id;
89 	u64				durable_volatile_id;
90 
91 	spinlock_t			f_lock;
92 
93 	struct ksmbd_inode		*f_ci;
94 	struct ksmbd_inode		*f_parent_ci;
95 	struct oplock_info __rcu	*f_opinfo;
96 	struct ksmbd_conn		*conn;
97 	struct ksmbd_tree_connect	*tcon;
98 
99 	atomic_t			refcount;
100 	__le32				daccess;
101 	__le32				saccess;
102 	__le32				coption;
103 	__le32				cdoption;
104 	__u64				create_time;
105 	__u64				change_time;
106 	__u64				allocation_size;
107 	__u64				itime;
108 
109 	bool				is_nt_open;
110 	bool				attrib_only;
111 
112 	char				client_guid[16];
113 	char				create_guid[16];
114 	char				app_instance_id[16];
115 
116 	struct stream			stream;
117 	struct list_head		node;
118 	struct list_head		blocked_works;
119 	struct list_head		lock_list;
120 
121 	unsigned int			durable_timeout;
122 	unsigned int			durable_scavenger_timeout;
123 
124 	/* if ls is happening on directory, below is valid*/
125 	struct ksmbd_readdir_data	readdir_data;
126 	struct mutex			readdir_lock;
127 	int				dot_dotdot[2];
128 	unsigned int			f_state;
129 	bool				reserve_lease_break;
130 	bool				is_durable;
131 	bool				is_persistent;
132 	bool				is_resilient;
133 	bool				durable_reconnect_disabled;
134 
135 	bool                            is_posix_ctxt;
136 	struct durable_owner		owner;
137 };
138 
139 static inline void set_ctx_actor(struct dir_context *ctx,
140 				 filldir_t actor)
141 {
142 	ctx->actor = actor;
143 }
144 
145 #define KSMBD_NR_OPEN_DEFAULT BITS_PER_LONG
146 
147 struct ksmbd_file_table {
148 	rwlock_t		lock;
149 	struct idr		*idr;
150 };
151 
152 static inline bool has_file_id(u64 id)
153 {
154 	return id < KSMBD_NO_FID;
155 }
156 
157 static inline bool ksmbd_stream_fd(struct ksmbd_file *fp)
158 {
159 	return fp->stream.name != NULL;
160 }
161 
162 int ksmbd_init_file_table(struct ksmbd_file_table *ft);
163 void ksmbd_destroy_file_table(struct ksmbd_session *sess);
164 int ksmbd_close_fd(struct ksmbd_work *work, u64 id);
165 struct ksmbd_file *ksmbd_lookup_fd_fast(struct ksmbd_work *work, u64 id);
166 struct ksmbd_file *ksmbd_lookup_foreign_fd(struct ksmbd_work *work, u64 id);
167 struct ksmbd_file *ksmbd_lookup_fd_slow(struct ksmbd_work *work, u64 id,
168 					u64 pid);
169 void ksmbd_fd_put(struct ksmbd_work *work, struct ksmbd_file *fp);
170 struct ksmbd_inode *ksmbd_inode_lookup_lock(struct dentry *d);
171 void ksmbd_inode_put(struct ksmbd_inode *ci);
172 bool ksmbd_close_disconnected_durable_delete_on_close(struct dentry *dentry);
173 struct ksmbd_file *ksmbd_lookup_global_fd(unsigned long long id);
174 struct ksmbd_file *ksmbd_lookup_durable_fd(unsigned long long id);
175 void ksmbd_put_durable_fd(struct ksmbd_file *fp);
176 int ksmbd_invalidate_durable_fd(unsigned long long id);
177 bool ksmbd_has_other_active_fd(struct ksmbd_file *fp);
178 bool ksmbd_has_stream_without_delete_share(struct ksmbd_file *fp);
179 int ksmbd_close_fd_app_instance_id(char *app_instance_id);
180 struct ksmbd_file *ksmbd_lookup_fd_cguid(char *cguid);
181 struct ksmbd_file *ksmbd_lookup_fd_inode(struct dentry *dentry);
182 bool ksmbd_has_open_files(struct dentry *dentry);
183 unsigned int ksmbd_open_durable_fd(struct ksmbd_file *fp);
184 struct ksmbd_file *ksmbd_open_fd(struct ksmbd_work *work, struct file *filp);
185 void ksmbd_launch_ksmbd_durable_scavenger(void);
186 void ksmbd_stop_durable_scavenger(void);
187 void ksmbd_close_tree_conn_fds(struct ksmbd_work *work);
188 void ksmbd_close_session_fds(struct ksmbd_work *work);
189 int ksmbd_close_inode_fds(struct ksmbd_work *work, struct inode *inode);
190 int ksmbd_init_global_file_table(void);
191 void ksmbd_free_global_file_table(void);
192 void ksmbd_set_fd_limit(unsigned long limit);
193 int ksmbd_update_fstate(struct ksmbd_file_table *ft, struct ksmbd_file *fp,
194 			unsigned int state);
195 bool ksmbd_vfs_compare_durable_owner(struct ksmbd_file *fp,
196 		struct ksmbd_user *user);
197 
198 /*
199  * INODE hash
200  */
201 int __init ksmbd_inode_hash_init(void);
202 void ksmbd_release_inode_hash(void);
203 
204 enum KSMBD_INODE_STATUS {
205 	KSMBD_INODE_STATUS_OK,
206 	KSMBD_INODE_STATUS_UNKNOWN,
207 	KSMBD_INODE_STATUS_PENDING_DELETE,
208 };
209 
210 int ksmbd_query_inode_status(struct dentry *dentry);
211 bool ksmbd_inode_pending_delete(struct ksmbd_file *fp);
212 void ksmbd_set_inode_pending_delete(struct ksmbd_file *fp);
213 void ksmbd_clear_inode_pending_delete(struct ksmbd_file *fp);
214 void ksmbd_fd_set_delete_on_close(struct ksmbd_file *fp,
215 				  int file_info);
216 int ksmbd_reopen_durable_fd(struct ksmbd_work *work, struct ksmbd_file *fp);
217 int ksmbd_validate_name_reconnect(struct ksmbd_share_config *share,
218 				  struct ksmbd_file *fp, char *name);
219 int ksmbd_init_file_cache(void);
220 void ksmbd_exit_file_cache(void);
221 #endif /* __VFS_CACHE_H__ */
222