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