xref: /linux/fs/smb/client/cifsproto.h (revision 62b5a46999c74497fe10eabd7d19701c505b23e3)
1 /* SPDX-License-Identifier: LGPL-2.1 */
2 /*
3  *
4  *   Copyright (c) International Business Machines  Corp., 2002,2008
5  *   Author(s): Steve French (sfrench@us.ibm.com)
6  *
7  */
8 #ifndef _CIFSPROTO_H
9 #define _CIFSPROTO_H
10 #include <linux/nls.h>
11 #include <linux/ctype.h>
12 #include "trace.h"
13 #ifdef CONFIG_CIFS_DFS_UPCALL
14 #include "dfs_cache.h"
15 #endif
16 
17 struct statfs;
18 struct smb_rqst;
19 struct smb3_fs_context;
20 
21 /*
22  *****************************************************************
23  * All Prototypes
24  *****************************************************************
25  */
26 
27 extern struct smb_hdr *cifs_buf_get(void);
28 extern void cifs_buf_release(void *);
29 extern struct smb_hdr *cifs_small_buf_get(void);
30 extern void cifs_small_buf_release(void *);
31 extern void free_rsp_buf(int, void *);
32 extern int smb_send(struct TCP_Server_Info *, struct smb_hdr *,
33 			unsigned int /* length */);
34 extern unsigned int _get_xid(void);
35 extern void _free_xid(unsigned int);
36 #define get_xid()							\
37 ({									\
38 	unsigned int __xid = _get_xid();				\
39 	cifs_dbg(FYI, "VFS: in %s as Xid: %u with uid: %d\n",		\
40 		 __func__, __xid,					\
41 		 from_kuid(&init_user_ns, current_fsuid()));		\
42 	trace_smb3_enter(__xid, __func__);				\
43 	__xid;								\
44 })
45 
46 #define free_xid(curr_xid)						\
47 do {									\
48 	_free_xid(curr_xid);						\
49 	cifs_dbg(FYI, "VFS: leaving %s (xid = %u) rc = %d\n",		\
50 		 __func__, curr_xid, (int)rc);				\
51 	if (rc)								\
52 		trace_smb3_exit_err(curr_xid, __func__, (int)rc);	\
53 	else								\
54 		trace_smb3_exit_done(curr_xid, __func__);		\
55 } while (0)
56 extern int init_cifs_idmap(void);
57 extern void exit_cifs_idmap(void);
58 extern int init_cifs_spnego(void);
59 extern void exit_cifs_spnego(void);
60 extern const char *build_path_from_dentry(struct dentry *, void *);
61 char *__build_path_from_dentry_optional_prefix(struct dentry *direntry, void *page,
62 					       const char *tree, int tree_len,
63 					       bool prefix);
64 extern char *build_path_from_dentry_optional_prefix(struct dentry *direntry,
65 						    void *page, bool prefix);
alloc_dentry_path(void)66 static inline void *alloc_dentry_path(void)
67 {
68 	return __getname();
69 }
70 
free_dentry_path(void * page)71 static inline void free_dentry_path(void *page)
72 {
73 	if (page)
74 		__putname(page);
75 }
76 
77 extern char *cifs_build_path_to_root(struct smb3_fs_context *ctx,
78 				     struct cifs_sb_info *cifs_sb,
79 				     struct cifs_tcon *tcon,
80 				     int add_treename);
81 extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
82 char *cifs_build_devname(char *nodename, const char *prepath);
83 extern void delete_mid(struct mid_q_entry *mid);
84 void __release_mid(struct kref *refcount);
85 extern void cifs_wake_up_task(struct mid_q_entry *mid);
86 extern int cifs_handle_standard(struct TCP_Server_Info *server,
87 				struct mid_q_entry *mid);
88 extern char *smb3_fs_context_fullpath(const struct smb3_fs_context *ctx,
89 				      char dirsep);
90 extern int smb3_parse_devname(const char *devname, struct smb3_fs_context *ctx);
91 extern int smb3_parse_opt(const char *options, const char *key, char **val);
92 extern int cifs_ipaddr_cmp(struct sockaddr *srcaddr, struct sockaddr *rhs);
93 extern bool cifs_match_ipaddr(struct sockaddr *srcaddr, struct sockaddr *rhs);
94 extern int cifs_discard_remaining_data(struct TCP_Server_Info *server);
95 extern int cifs_call_async(struct TCP_Server_Info *server,
96 			struct smb_rqst *rqst,
97 			mid_receive_t *receive, mid_callback_t *callback,
98 			mid_handle_t *handle, void *cbdata, const int flags,
99 			const struct cifs_credits *exist_credits);
100 extern struct TCP_Server_Info *cifs_pick_channel(struct cifs_ses *ses);
101 extern int cifs_send_recv(const unsigned int xid, struct cifs_ses *ses,
102 			  struct TCP_Server_Info *server,
103 			  struct smb_rqst *rqst, int *resp_buf_type,
104 			  const int flags, struct kvec *resp_iov);
105 extern int compound_send_recv(const unsigned int xid, struct cifs_ses *ses,
106 			      struct TCP_Server_Info *server,
107 			      const int flags, const int num_rqst,
108 			      struct smb_rqst *rqst, int *resp_buf_type,
109 			      struct kvec *resp_iov);
110 extern int SendReceive(const unsigned int /* xid */ , struct cifs_ses *,
111 			struct smb_hdr * /* input */ ,
112 			struct smb_hdr * /* out */ ,
113 			int * /* bytes returned */ , const int);
114 extern int SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
115 			    char *in_buf, int flags);
116 extern struct mid_q_entry *cifs_setup_request(struct cifs_ses *,
117 				struct TCP_Server_Info *,
118 				struct smb_rqst *);
119 extern struct mid_q_entry *cifs_setup_async_request(struct TCP_Server_Info *,
120 						struct smb_rqst *);
121 extern int cifs_check_receive(struct mid_q_entry *mid,
122 			struct TCP_Server_Info *server, bool log_error);
123 extern int cifs_wait_mtu_credits(struct TCP_Server_Info *server,
124 				 size_t size, size_t *num,
125 				 struct cifs_credits *credits);
126 extern int SendReceive2(const unsigned int /* xid */ , struct cifs_ses *,
127 			struct kvec *, int /* nvec to send */,
128 			int * /* type of buf returned */, const int flags,
129 			struct kvec * /* resp vec */);
130 extern int SendReceiveBlockingLock(const unsigned int xid,
131 			struct cifs_tcon *ptcon,
132 			struct smb_hdr *in_buf,
133 			struct smb_hdr *out_buf,
134 			int *bytes_returned);
135 
136 void
137 cifs_signal_cifsd_for_reconnect(struct TCP_Server_Info *server,
138 				      bool all_channels);
139 void
140 cifs_mark_tcp_ses_conns_for_reconnect(struct TCP_Server_Info *server,
141 				      bool mark_smb_session);
142 extern int cifs_reconnect(struct TCP_Server_Info *server,
143 			  bool mark_smb_session);
144 extern int checkSMB(char *buf, unsigned int len, struct TCP_Server_Info *srvr);
145 extern bool is_valid_oplock_break(char *, struct TCP_Server_Info *);
146 extern bool backup_cred(struct cifs_sb_info *);
147 extern bool is_size_safe_to_change(struct cifsInodeInfo *cifsInode, __u64 eof,
148 				   bool from_readdir);
149 extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
150 			    unsigned int bytes_written);
151 void cifs_write_subrequest_terminated(struct cifs_io_subrequest *wdata, ssize_t result,
152 				      bool was_async);
153 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, int);
154 extern int cifs_get_writable_file(struct cifsInodeInfo *cifs_inode,
155 				  int flags,
156 				  struct cifsFileInfo **ret_file);
157 extern int cifs_get_writable_path(struct cifs_tcon *tcon, const char *name,
158 				  int flags,
159 				  struct cifsFileInfo **ret_file);
160 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
161 extern int cifs_get_readable_path(struct cifs_tcon *tcon, const char *name,
162 				  struct cifsFileInfo **ret_file);
163 extern unsigned int smbCalcSize(void *buf);
164 extern int decode_negTokenInit(unsigned char *security_blob, int length,
165 			struct TCP_Server_Info *server);
166 extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
167 extern void cifs_set_port(struct sockaddr *addr, const unsigned short int port);
168 extern int map_smb_to_linux_error(char *buf, bool logErr);
169 extern int map_and_check_smb_error(struct mid_q_entry *mid, bool logErr);
170 extern void header_assemble(struct smb_hdr *, char /* command */ ,
171 			    const struct cifs_tcon *, int /* length of
172 			    fixed section (word count) in two byte units */);
173 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
174 				struct cifs_ses *ses,
175 				void **request_buf);
176 extern enum securityEnum select_sectype(struct TCP_Server_Info *server,
177 				enum securityEnum requested);
178 extern int CIFS_SessSetup(const unsigned int xid, struct cifs_ses *ses,
179 			  struct TCP_Server_Info *server,
180 			  const struct nls_table *nls_cp);
181 extern struct timespec64 cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
182 extern u64 cifs_UnixTimeToNT(struct timespec64);
183 extern struct timespec64 cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
184 				      int offset);
185 extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
186 extern int cifs_get_writer(struct cifsInodeInfo *cinode);
187 extern void cifs_put_writer(struct cifsInodeInfo *cinode);
188 extern void cifs_done_oplock_break(struct cifsInodeInfo *cinode);
189 extern int cifs_unlock_range(struct cifsFileInfo *cfile,
190 			     struct file_lock *flock, const unsigned int xid);
191 extern int cifs_push_mandatory_locks(struct cifsFileInfo *cfile);
192 
193 extern void cifs_down_write(struct rw_semaphore *sem);
194 struct cifsFileInfo *cifs_new_fileinfo(struct cifs_fid *fid, struct file *file,
195 				       struct tcon_link *tlink, __u32 oplock,
196 				       const char *symlink_target);
197 extern int cifs_posix_open(const char *full_path, struct inode **inode,
198 			   struct super_block *sb, int mode,
199 			   unsigned int f_flags, __u32 *oplock, __u16 *netfid,
200 			   unsigned int xid);
201 void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
202 extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
203 				     FILE_UNIX_BASIC_INFO *info,
204 				     struct cifs_sb_info *cifs_sb);
205 extern void cifs_dir_info_to_fattr(struct cifs_fattr *, FILE_DIRECTORY_INFO *,
206 					struct cifs_sb_info *);
207 extern int cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr,
208 			       bool from_readdir);
209 extern struct inode *cifs_iget(struct super_block *sb,
210 			       struct cifs_fattr *fattr);
211 
212 int cifs_get_inode_info(struct inode **inode, const char *full_path,
213 			struct cifs_open_info_data *data, struct super_block *sb, int xid,
214 			const struct cifs_fid *fid);
215 extern int smb311_posix_get_inode_info(struct inode **inode,
216 				       const char *full_path,
217 				       struct cifs_open_info_data *data,
218 				       struct super_block *sb,
219 				       const unsigned int xid);
220 extern int cifs_get_inode_info_unix(struct inode **pinode,
221 			const unsigned char *search_path,
222 			struct super_block *sb, unsigned int xid);
223 extern int cifs_set_file_info(struct inode *inode, struct iattr *attrs,
224 			      unsigned int xid, const char *full_path, __u32 dosattr);
225 extern int cifs_rename_pending_delete(const char *full_path,
226 				      struct dentry *dentry,
227 				      const unsigned int xid);
228 extern int sid_to_id(struct cifs_sb_info *cifs_sb, struct smb_sid *psid,
229 				struct cifs_fattr *fattr, uint sidtype);
230 extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
231 			      struct cifs_fattr *fattr, struct inode *inode,
232 			      bool get_mode_from_special_sid,
233 			      const char *path, const struct cifs_fid *pfid);
234 extern int id_mode_to_cifs_acl(struct inode *inode, const char *path, __u64 *pnmode,
235 					kuid_t uid, kgid_t gid);
236 extern struct smb_ntsd *get_cifs_acl(struct cifs_sb_info *cifssmb, struct inode *ino,
237 				      const char *path, u32 *plen, u32 info);
238 extern struct smb_ntsd *get_cifs_acl_by_fid(struct cifs_sb_info *cifssb,
239 				const struct cifs_fid *pfid, u32 *plen, u32 info);
240 extern struct posix_acl *cifs_get_acl(struct mnt_idmap *idmap,
241 				      struct dentry *dentry, int type);
242 extern int cifs_set_acl(struct mnt_idmap *idmap,
243 			struct dentry *dentry, struct posix_acl *acl, int type);
244 extern int set_cifs_acl(struct smb_ntsd *pntsd, __u32 len, struct inode *ino,
245 				const char *path, int flag);
246 extern unsigned int setup_authusers_ACE(struct smb_ace *pace);
247 extern unsigned int setup_special_mode_ACE(struct smb_ace *pace,
248 					   bool posix,
249 					   __u64 nmode);
250 extern unsigned int setup_special_user_owner_ACE(struct smb_ace *pace);
251 
252 extern void dequeue_mid(struct mid_q_entry *mid, bool malformed);
253 extern int cifs_read_from_socket(struct TCP_Server_Info *server, char *buf,
254 			         unsigned int to_read);
255 extern ssize_t cifs_discard_from_socket(struct TCP_Server_Info *server,
256 					size_t to_read);
257 int cifs_read_iter_from_socket(struct TCP_Server_Info *server,
258 			       struct iov_iter *iter,
259 			       unsigned int to_read);
260 extern int cifs_setup_cifs_sb(struct cifs_sb_info *cifs_sb);
261 void cifs_mount_put_conns(struct cifs_mount_ctx *mnt_ctx);
262 int cifs_mount_get_session(struct cifs_mount_ctx *mnt_ctx);
263 int cifs_is_path_remote(struct cifs_mount_ctx *mnt_ctx);
264 int cifs_mount_get_tcon(struct cifs_mount_ctx *mnt_ctx);
265 extern int cifs_match_super(struct super_block *, void *);
266 extern int cifs_mount(struct cifs_sb_info *cifs_sb, struct smb3_fs_context *ctx);
267 extern void cifs_umount(struct cifs_sb_info *);
268 extern void cifs_mark_open_files_invalid(struct cifs_tcon *tcon);
269 extern void cifs_reopen_persistent_handles(struct cifs_tcon *tcon);
270 
271 extern bool cifs_find_lock_conflict(struct cifsFileInfo *cfile, __u64 offset,
272 				    __u64 length, __u8 type, __u16 flags,
273 				    struct cifsLockInfo **conf_lock,
274 				    int rw_check);
275 extern void cifs_add_pending_open(struct cifs_fid *fid,
276 				  struct tcon_link *tlink,
277 				  struct cifs_pending_open *open);
278 extern void cifs_add_pending_open_locked(struct cifs_fid *fid,
279 					 struct tcon_link *tlink,
280 					 struct cifs_pending_open *open);
281 extern void cifs_del_pending_open(struct cifs_pending_open *open);
282 
283 extern bool cifs_is_deferred_close(struct cifsFileInfo *cfile,
284 				struct cifs_deferred_close **dclose);
285 
286 extern void cifs_add_deferred_close(struct cifsFileInfo *cfile,
287 				struct cifs_deferred_close *dclose);
288 
289 extern void cifs_del_deferred_close(struct cifsFileInfo *cfile);
290 
291 extern void cifs_close_deferred_file(struct cifsInodeInfo *cifs_inode);
292 
293 extern void cifs_close_all_deferred_files(struct cifs_tcon *cifs_tcon);
294 
295 extern void cifs_close_deferred_file_under_dentry(struct cifs_tcon *cifs_tcon,
296 				const char *path);
297 
298 extern void cifs_mark_open_handles_for_deleted_file(struct inode *inode,
299 				const char *path);
300 
301 extern struct TCP_Server_Info *
302 cifs_get_tcp_session(struct smb3_fs_context *ctx,
303 		     struct TCP_Server_Info *primary_server);
304 extern void cifs_put_tcp_session(struct TCP_Server_Info *server,
305 				 int from_reconnect);
306 extern void cifs_put_tcon(struct cifs_tcon *tcon, enum smb3_tcon_ref_trace trace);
307 
308 extern void cifs_release_automount_timer(void);
309 
310 void cifs_proc_init(void);
311 void cifs_proc_clean(void);
312 
313 extern void cifs_move_llist(struct list_head *source, struct list_head *dest);
314 extern void cifs_free_llist(struct list_head *llist);
315 extern void cifs_del_lock_waiters(struct cifsLockInfo *lock);
316 
317 int cifs_tree_connect(const unsigned int xid, struct cifs_tcon *tcon);
318 
319 extern int cifs_negotiate_protocol(const unsigned int xid,
320 				   struct cifs_ses *ses,
321 				   struct TCP_Server_Info *server);
322 extern int cifs_setup_session(const unsigned int xid, struct cifs_ses *ses,
323 			      struct TCP_Server_Info *server,
324 			      struct nls_table *nls_info);
325 extern int cifs_enable_signing(struct TCP_Server_Info *server, bool mnt_sign_required);
326 extern int CIFSSMBNegotiate(const unsigned int xid,
327 			    struct cifs_ses *ses,
328 			    struct TCP_Server_Info *server);
329 
330 extern int CIFSTCon(const unsigned int xid, struct cifs_ses *ses,
331 		    const char *tree, struct cifs_tcon *tcon,
332 		    const struct nls_table *);
333 
334 extern int CIFSFindFirst(const unsigned int xid, struct cifs_tcon *tcon,
335 		const char *searchName, struct cifs_sb_info *cifs_sb,
336 		__u16 *searchHandle, __u16 search_flags,
337 		struct cifs_search_info *psrch_inf,
338 		bool msearch);
339 
340 extern int CIFSFindNext(const unsigned int xid, struct cifs_tcon *tcon,
341 		__u16 searchHandle, __u16 search_flags,
342 		struct cifs_search_info *psrch_inf);
343 
344 extern int CIFSFindClose(const unsigned int xid, struct cifs_tcon *tcon,
345 			const __u16 search_handle);
346 
347 extern int CIFSSMBQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
348 			u16 netfid, FILE_ALL_INFO *pFindData);
349 extern int CIFSSMBQPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
350 			    const char *search_Name, FILE_ALL_INFO *data,
351 			    int legacy /* whether to use old info level */,
352 			    const struct nls_table *nls_codepage, int remap);
353 extern int SMBQueryInformation(const unsigned int xid, struct cifs_tcon *tcon,
354 			       const char *search_name, FILE_ALL_INFO *data,
355 			       const struct nls_table *nls_codepage, int remap);
356 
357 extern int CIFSSMBUnixQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
358 			u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
359 extern int CIFSSMBUnixQPathInfo(const unsigned int xid,
360 			struct cifs_tcon *tcon,
361 			const unsigned char *searchName,
362 			FILE_UNIX_BASIC_INFO *pFindData,
363 			const struct nls_table *nls_codepage, int remap);
364 
365 extern int CIFSGetDFSRefer(const unsigned int xid, struct cifs_ses *ses,
366 			   const char *search_name,
367 			   struct dfs_info3_param **target_nodes,
368 			   unsigned int *num_of_nodes,
369 			   const struct nls_table *nls_codepage, int remap);
370 
371 extern int parse_dfs_referrals(struct get_dfs_referral_rsp *rsp, u32 rsp_size,
372 			       unsigned int *num_of_nodes,
373 			       struct dfs_info3_param **target_nodes,
374 			       const struct nls_table *nls_codepage, int remap,
375 			       const char *searchName, bool is_unicode);
376 extern void reset_cifs_unix_caps(unsigned int xid, struct cifs_tcon *tcon,
377 				 struct cifs_sb_info *cifs_sb,
378 				 struct smb3_fs_context *ctx);
379 extern int CIFSSMBQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
380 			struct kstatfs *FSData);
381 extern int SMBOldQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
382 			struct kstatfs *FSData);
383 extern int CIFSSMBSetFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon,
384 			__u64 cap);
385 
386 extern int CIFSSMBQFSAttributeInfo(const unsigned int xid,
387 			struct cifs_tcon *tcon);
388 extern int CIFSSMBQFSDeviceInfo(const unsigned int xid, struct cifs_tcon *tcon);
389 extern int CIFSSMBQFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon);
390 extern int CIFSSMBQFSPosixInfo(const unsigned int xid, struct cifs_tcon *tcon,
391 			struct kstatfs *FSData);
392 
393 extern int CIFSSMBSetPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
394 			const char *fileName, const FILE_BASIC_INFO *data,
395 			const struct nls_table *nls_codepage,
396 			struct cifs_sb_info *cifs_sb);
397 extern int CIFSSMBSetFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
398 			const FILE_BASIC_INFO *data, __u16 fid,
399 			__u32 pid_of_opener);
400 extern int CIFSSMBSetFileDisposition(const unsigned int xid,
401 				     struct cifs_tcon *tcon,
402 				     bool delete_file, __u16 fid,
403 				     __u32 pid_of_opener);
404 extern int CIFSSMBSetEOF(const unsigned int xid, struct cifs_tcon *tcon,
405 			 const char *file_name, __u64 size,
406 			 struct cifs_sb_info *cifs_sb, bool set_allocation,
407 			 struct dentry *dentry);
408 extern int CIFSSMBSetFileSize(const unsigned int xid, struct cifs_tcon *tcon,
409 			      struct cifsFileInfo *cfile, __u64 size,
410 			      bool set_allocation);
411 
412 struct cifs_unix_set_info_args {
413 	__u64	ctime;
414 	__u64	atime;
415 	__u64	mtime;
416 	__u64	mode;
417 	kuid_t	uid;
418 	kgid_t	gid;
419 	dev_t	device;
420 };
421 
422 extern int CIFSSMBUnixSetFileInfo(const unsigned int xid,
423 				  struct cifs_tcon *tcon,
424 				  const struct cifs_unix_set_info_args *args,
425 				  u16 fid, u32 pid_of_opener);
426 
427 extern int CIFSSMBUnixSetPathInfo(const unsigned int xid,
428 				  struct cifs_tcon *tcon, const char *file_name,
429 				  const struct cifs_unix_set_info_args *args,
430 				  const struct nls_table *nls_codepage,
431 				  int remap);
432 
433 extern int CIFSSMBMkDir(const unsigned int xid, struct inode *inode,
434 			umode_t mode, struct cifs_tcon *tcon,
435 			const char *name, struct cifs_sb_info *cifs_sb);
436 extern int CIFSSMBRmDir(const unsigned int xid, struct cifs_tcon *tcon,
437 			const char *name, struct cifs_sb_info *cifs_sb);
438 extern int CIFSPOSIXDelFile(const unsigned int xid, struct cifs_tcon *tcon,
439 			const char *name, __u16 type,
440 			const struct nls_table *nls_codepage,
441 			int remap_special_chars);
442 extern int CIFSSMBDelFile(const unsigned int xid, struct cifs_tcon *tcon,
443 			  const char *name, struct cifs_sb_info *cifs_sb,
444 			  struct dentry *dentry);
445 int CIFSSMBRename(const unsigned int xid, struct cifs_tcon *tcon,
446 		  struct dentry *source_dentry,
447 		  const char *from_name, const char *to_name,
448 		  struct cifs_sb_info *cifs_sb);
449 extern int CIFSSMBRenameOpenFile(const unsigned int xid, struct cifs_tcon *tcon,
450 				 int netfid, const char *target_name,
451 				 const struct nls_table *nls_codepage,
452 				 int remap_special_chars);
453 int CIFSCreateHardLink(const unsigned int xid,
454 		       struct cifs_tcon *tcon,
455 		       struct dentry *source_dentry,
456 		       const char *from_name, const char *to_name,
457 		       struct cifs_sb_info *cifs_sb);
458 extern int CIFSUnixCreateHardLink(const unsigned int xid,
459 			struct cifs_tcon *tcon,
460 			const char *fromName, const char *toName,
461 			const struct nls_table *nls_codepage,
462 			int remap_special_chars);
463 extern int CIFSUnixCreateSymLink(const unsigned int xid,
464 			struct cifs_tcon *tcon,
465 			const char *fromName, const char *toName,
466 			const struct nls_table *nls_codepage, int remap);
467 extern int CIFSSMBUnixQuerySymLink(const unsigned int xid,
468 			struct cifs_tcon *tcon,
469 			const unsigned char *searchName, char **syminfo,
470 			const struct nls_table *nls_codepage, int remap);
471 extern int cifs_query_reparse_point(const unsigned int xid,
472 				    struct cifs_tcon *tcon,
473 				    struct cifs_sb_info *cifs_sb,
474 				    const char *full_path,
475 				    u32 *tag, struct kvec *rsp,
476 				    int *rsp_buftype);
477 extern int CIFSSMBQuerySymLink(const unsigned int xid, struct cifs_tcon *tcon,
478 			       __u16 fid, char **symlinkinfo,
479 			       const struct nls_table *nls_codepage);
480 extern int CIFSSMB_set_compression(const unsigned int xid,
481 				   struct cifs_tcon *tcon, __u16 fid);
482 extern int CIFS_open(const unsigned int xid, struct cifs_open_parms *oparms,
483 		     int *oplock, FILE_ALL_INFO *buf);
484 extern int SMBLegacyOpen(const unsigned int xid, struct cifs_tcon *tcon,
485 			const char *fileName, const int disposition,
486 			const int access_flags, const int omode,
487 			__u16 *netfid, int *pOplock, FILE_ALL_INFO *,
488 			const struct nls_table *nls_codepage, int remap);
489 extern int CIFSPOSIXCreate(const unsigned int xid, struct cifs_tcon *tcon,
490 			u32 posix_flags, __u64 mode, __u16 *netfid,
491 			FILE_UNIX_BASIC_INFO *pRetData,
492 			__u32 *pOplock, const char *name,
493 			const struct nls_table *nls_codepage, int remap);
494 extern int CIFSSMBClose(const unsigned int xid, struct cifs_tcon *tcon,
495 			const int smb_file_id);
496 
497 extern int CIFSSMBFlush(const unsigned int xid, struct cifs_tcon *tcon,
498 			const int smb_file_id);
499 
500 extern int CIFSSMBRead(const unsigned int xid, struct cifs_io_parms *io_parms,
501 			unsigned int *nbytes, char **buf,
502 			int *return_buf_type);
503 extern int CIFSSMBWrite(const unsigned int xid, struct cifs_io_parms *io_parms,
504 			unsigned int *nbytes, const char *buf);
505 extern int CIFSSMBWrite2(const unsigned int xid, struct cifs_io_parms *io_parms,
506 			unsigned int *nbytes, struct kvec *iov, const int nvec);
507 extern int CIFSGetSrvInodeNumber(const unsigned int xid, struct cifs_tcon *tcon,
508 				 const char *search_name, __u64 *inode_number,
509 				 const struct nls_table *nls_codepage,
510 				 int remap);
511 
512 extern int cifs_lockv(const unsigned int xid, struct cifs_tcon *tcon,
513 		      const __u16 netfid, const __u8 lock_type,
514 		      const __u32 num_unlock, const __u32 num_lock,
515 		      LOCKING_ANDX_RANGE *buf);
516 extern int CIFSSMBLock(const unsigned int xid, struct cifs_tcon *tcon,
517 			const __u16 netfid, const __u32 netpid, const __u64 len,
518 			const __u64 offset, const __u32 numUnlock,
519 			const __u32 numLock, const __u8 lockType,
520 			const bool waitFlag, const __u8 oplock_level);
521 extern int CIFSSMBPosixLock(const unsigned int xid, struct cifs_tcon *tcon,
522 			const __u16 smb_file_id, const __u32 netpid,
523 			const loff_t start_offset, const __u64 len,
524 			struct file_lock *, const __u16 lock_type,
525 			const bool waitFlag);
526 extern int CIFSSMBTDis(const unsigned int xid, struct cifs_tcon *tcon);
527 extern int CIFSSMBEcho(struct TCP_Server_Info *server);
528 extern int CIFSSMBLogoff(const unsigned int xid, struct cifs_ses *ses);
529 
530 extern struct cifs_ses *sesInfoAlloc(void);
531 extern void sesInfoFree(struct cifs_ses *);
532 extern struct cifs_tcon *tcon_info_alloc(bool dir_leases_enabled,
533 					 enum smb3_tcon_ref_trace trace);
534 extern void tconInfoFree(struct cifs_tcon *tcon, enum smb3_tcon_ref_trace trace);
535 
536 extern int cifs_sign_rqst(struct smb_rqst *rqst, struct TCP_Server_Info *server,
537 		   __u32 *pexpected_response_sequence_number);
538 extern int cifs_sign_smbv(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
539 			  __u32 *);
540 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
541 extern int cifs_verify_signature(struct smb_rqst *rqst,
542 				 struct TCP_Server_Info *server,
543 				__u32 expected_sequence_number);
544 extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
545 extern void cifs_crypto_secmech_release(struct TCP_Server_Info *server);
546 extern int calc_seckey(struct cifs_ses *);
547 extern int generate_smb30signingkey(struct cifs_ses *ses,
548 				    struct TCP_Server_Info *server);
549 extern int generate_smb311signingkey(struct cifs_ses *ses,
550 				     struct TCP_Server_Info *server);
551 
552 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
553 extern ssize_t CIFSSMBQAllEAs(const unsigned int xid, struct cifs_tcon *tcon,
554 			const unsigned char *searchName,
555 			const unsigned char *ea_name, char *EAData,
556 			size_t bufsize, struct cifs_sb_info *cifs_sb);
557 extern int CIFSSMBSetEA(const unsigned int xid, struct cifs_tcon *tcon,
558 		const char *fileName, const char *ea_name,
559 		const void *ea_value, const __u16 ea_value_len,
560 		const struct nls_table *nls_codepage,
561 		struct cifs_sb_info *cifs_sb);
562 extern int CIFSSMBGetCIFSACL(const unsigned int xid, struct cifs_tcon *tcon,
563 			__u16 fid, struct smb_ntsd **acl_inf, __u32 *buflen);
564 extern int CIFSSMBSetCIFSACL(const unsigned int, struct cifs_tcon *, __u16,
565 			struct smb_ntsd *pntsd, __u32 len, int aclflag);
566 extern int cifs_do_get_acl(const unsigned int xid, struct cifs_tcon *tcon,
567 			   const unsigned char *searchName,
568 			   struct posix_acl **acl, const int acl_type,
569 			   const struct nls_table *nls_codepage, int remap);
570 extern int cifs_do_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
571 			   const unsigned char *fileName,
572 			   const struct posix_acl *acl, const int acl_type,
573 			   const struct nls_table *nls_codepage, int remap);
574 extern int CIFSGetExtAttr(const unsigned int xid, struct cifs_tcon *tcon,
575 			const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
576 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
577 extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
578 extern bool couldbe_mf_symlink(const struct cifs_fattr *fattr);
579 extern int check_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
580 			      struct cifs_sb_info *cifs_sb,
581 			      struct cifs_fattr *fattr,
582 			      const unsigned char *path);
583 extern int E_md4hash(const unsigned char *passwd, unsigned char *p16,
584 			const struct nls_table *codepage);
585 
586 extern struct TCP_Server_Info *
587 cifs_find_tcp_session(struct smb3_fs_context *ctx);
588 
589 void __cifs_put_smb_ses(struct cifs_ses *ses);
590 
591 extern struct cifs_ses *
592 cifs_get_smb_ses(struct TCP_Server_Info *server, struct smb3_fs_context *ctx);
593 
594 int cifs_async_readv(struct cifs_io_subrequest *rdata);
595 int cifs_readv_receive(struct TCP_Server_Info *server, struct mid_q_entry *mid);
596 
597 void cifs_async_writev(struct cifs_io_subrequest *wdata);
598 void cifs_writev_complete(struct work_struct *work);
599 int cifs_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
600 			  struct cifs_sb_info *cifs_sb,
601 			  const unsigned char *path, char *pbuf,
602 			  unsigned int *pbytes_read);
603 int cifs_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
604 			   struct cifs_sb_info *cifs_sb,
605 			   const unsigned char *path, char *pbuf,
606 			   unsigned int *pbytes_written);
607 int __cifs_calc_signature(struct smb_rqst *rqst,
608 			struct TCP_Server_Info *server, char *signature,
609 			struct shash_desc *shash);
610 enum securityEnum cifs_select_sectype(struct TCP_Server_Info *,
611 					enum securityEnum);
612 
613 int cifs_alloc_hash(const char *name, struct shash_desc **sdesc);
614 void cifs_free_hash(struct shash_desc **sdesc);
615 
616 int cifs_try_adding_channels(struct cifs_ses *ses);
617 bool is_server_using_iface(struct TCP_Server_Info *server,
618 			   struct cifs_server_iface *iface);
619 bool is_ses_using_iface(struct cifs_ses *ses, struct cifs_server_iface *iface);
620 void cifs_ses_mark_for_reconnect(struct cifs_ses *ses);
621 
622 int
623 cifs_ses_get_chan_index(struct cifs_ses *ses,
624 			struct TCP_Server_Info *server);
625 void
626 cifs_chan_set_in_reconnect(struct cifs_ses *ses,
627 			     struct TCP_Server_Info *server);
628 void
629 cifs_chan_clear_in_reconnect(struct cifs_ses *ses,
630 			       struct TCP_Server_Info *server);
631 void
632 cifs_chan_set_need_reconnect(struct cifs_ses *ses,
633 			     struct TCP_Server_Info *server);
634 void
635 cifs_chan_clear_need_reconnect(struct cifs_ses *ses,
636 			       struct TCP_Server_Info *server);
637 bool
638 cifs_chan_needs_reconnect(struct cifs_ses *ses,
639 			  struct TCP_Server_Info *server);
640 bool
641 cifs_chan_is_iface_active(struct cifs_ses *ses,
642 			  struct TCP_Server_Info *server);
643 void
644 cifs_disable_secondary_channels(struct cifs_ses *ses);
645 void
646 cifs_chan_update_iface(struct cifs_ses *ses, struct TCP_Server_Info *server);
647 int
648 SMB3_request_interfaces(const unsigned int xid, struct cifs_tcon *tcon, bool in_mount);
649 
650 void extract_unc_hostname(const char *unc, const char **h, size_t *len);
651 int copy_path_name(char *dst, const char *src);
652 int smb2_parse_query_directory(struct cifs_tcon *tcon, struct kvec *rsp_iov,
653 			       int resp_buftype,
654 			       struct cifs_search_info *srch_inf);
655 
656 struct super_block *cifs_get_dfs_tcon_super(struct cifs_tcon *tcon);
657 void cifs_put_tcp_super(struct super_block *sb);
658 int cifs_update_super_prepath(struct cifs_sb_info *cifs_sb, char *prefix);
659 char *extract_hostname(const char *unc);
660 char *extract_sharename(const char *unc);
661 int parse_reparse_point(struct reparse_data_buffer *buf,
662 			u32 plen, struct cifs_sb_info *cifs_sb,
663 			const char *full_path,
664 			bool unicode, struct cifs_open_info_data *data);
665 int __cifs_sfu_make_node(unsigned int xid, struct inode *inode,
666 			 struct dentry *dentry, struct cifs_tcon *tcon,
667 			 const char *full_path, umode_t mode, dev_t dev,
668 			 const char *symname);
669 int cifs_sfu_make_node(unsigned int xid, struct inode *inode,
670 		       struct dentry *dentry, struct cifs_tcon *tcon,
671 		       const char *full_path, umode_t mode, dev_t dev);
672 umode_t wire_mode_to_posix(u32 wire, bool is_dir);
673 
674 #ifdef CONFIG_CIFS_DFS_UPCALL
get_dfs_path(const unsigned int xid,struct cifs_ses * ses,const char * old_path,const struct nls_table * nls_codepage,struct dfs_info3_param * referral,int remap)675 static inline int get_dfs_path(const unsigned int xid, struct cifs_ses *ses,
676 			       const char *old_path,
677 			       const struct nls_table *nls_codepage,
678 			       struct dfs_info3_param *referral, int remap)
679 {
680 	return dfs_cache_find(xid, ses, nls_codepage, remap, old_path,
681 			      referral, NULL);
682 }
683 
684 int match_target_ip(struct TCP_Server_Info *server,
685 		    const char *share, size_t share_len,
686 		    bool *result);
687 int cifs_inval_name_dfs_link_error(const unsigned int xid,
688 				   struct cifs_tcon *tcon,
689 				   struct cifs_sb_info *cifs_sb,
690 				   const char *full_path,
691 				   bool *islink);
692 #else
cifs_inval_name_dfs_link_error(const unsigned int xid,struct cifs_tcon * tcon,struct cifs_sb_info * cifs_sb,const char * full_path,bool * islink)693 static inline int cifs_inval_name_dfs_link_error(const unsigned int xid,
694 				   struct cifs_tcon *tcon,
695 				   struct cifs_sb_info *cifs_sb,
696 				   const char *full_path,
697 				   bool *islink)
698 {
699 	*islink = false;
700 	return 0;
701 }
702 #endif
703 
cifs_create_options(struct cifs_sb_info * cifs_sb,int options)704 static inline int cifs_create_options(struct cifs_sb_info *cifs_sb, int options)
705 {
706 	if (cifs_sb && (backup_cred(cifs_sb)))
707 		return options | CREATE_OPEN_BACKUP_INTENT;
708 	else
709 		return options;
710 }
711 
712 int cifs_wait_for_server_reconnect(struct TCP_Server_Info *server, bool retry);
713 
cifs_put_smb_ses(struct cifs_ses * ses)714 static inline void cifs_put_smb_ses(struct cifs_ses *ses)
715 {
716 	__cifs_put_smb_ses(ses);
717 }
718 
719 /* Get an active reference of @ses and its children.
720  *
721  * NOTE: make sure to call this function when incrementing reference count of
722  * @ses to ensure that any DFS root session attached to it (@ses->dfs_root_ses)
723  * will also get its reference count incremented.
724  *
725  * cifs_put_smb_ses() will put all references, so call it when you're done.
726  */
cifs_smb_ses_inc_refcount(struct cifs_ses * ses)727 static inline void cifs_smb_ses_inc_refcount(struct cifs_ses *ses)
728 {
729 	lockdep_assert_held(&cifs_tcp_ses_lock);
730 	ses->ses_count++;
731 }
732 
dfs_src_pathname_equal(const char * s1,const char * s2)733 static inline bool dfs_src_pathname_equal(const char *s1, const char *s2)
734 {
735 	if (strlen(s1) != strlen(s2))
736 		return false;
737 	for (; *s1; s1++, s2++) {
738 		if (*s1 == '/' || *s1 == '\\') {
739 			if (*s2 != '/' && *s2 != '\\')
740 				return false;
741 		} else if (tolower(*s1) != tolower(*s2))
742 			return false;
743 	}
744 	return true;
745 }
746 
release_mid(struct mid_q_entry * mid)747 static inline void release_mid(struct mid_q_entry *mid)
748 {
749 	kref_put(&mid->refcount, __release_mid);
750 }
751 
cifs_free_open_info(struct cifs_open_info_data * data)752 static inline void cifs_free_open_info(struct cifs_open_info_data *data)
753 {
754 	kfree(data->symlink_target);
755 	free_rsp_buf(data->reparse.io.buftype, data->reparse.io.iov.iov_base);
756 	memset(data, 0, sizeof(*data));
757 }
758 
759 #endif			/* _CIFSPROTO_H */
760