Linux 6.7-rc7
[linux-modified.git] / fs / smb / client / cifsproto.h
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);
66 static inline void *alloc_dentry_path(void)
67 {
68         return __getname();
69 }
70
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                                  unsigned int size, unsigned int *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 *, __u64 eof);
148 extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
149                             unsigned int bytes_written);
150 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, int);
151 extern int cifs_get_writable_file(struct cifsInodeInfo *cifs_inode,
152                                   int flags,
153                                   struct cifsFileInfo **ret_file);
154 extern int cifs_get_writable_path(struct cifs_tcon *tcon, const char *name,
155                                   int flags,
156                                   struct cifsFileInfo **ret_file);
157 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
158 extern int cifs_get_readable_path(struct cifs_tcon *tcon, const char *name,
159                                   struct cifsFileInfo **ret_file);
160 extern unsigned int smbCalcSize(void *buf);
161 extern int decode_negTokenInit(unsigned char *security_blob, int length,
162                         struct TCP_Server_Info *server);
163 extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
164 extern void cifs_set_port(struct sockaddr *addr, const unsigned short int port);
165 extern int map_smb_to_linux_error(char *buf, bool logErr);
166 extern int map_and_check_smb_error(struct mid_q_entry *mid, bool logErr);
167 extern void header_assemble(struct smb_hdr *, char /* command */ ,
168                             const struct cifs_tcon *, int /* length of
169                             fixed section (word count) in two byte units */);
170 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
171                                 struct cifs_ses *ses,
172                                 void **request_buf);
173 extern enum securityEnum select_sectype(struct TCP_Server_Info *server,
174                                 enum securityEnum requested);
175 extern int CIFS_SessSetup(const unsigned int xid, struct cifs_ses *ses,
176                           struct TCP_Server_Info *server,
177                           const struct nls_table *nls_cp);
178 extern struct timespec64 cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
179 extern u64 cifs_UnixTimeToNT(struct timespec64);
180 extern struct timespec64 cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
181                                       int offset);
182 extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
183 extern int cifs_get_writer(struct cifsInodeInfo *cinode);
184 extern void cifs_put_writer(struct cifsInodeInfo *cinode);
185 extern void cifs_done_oplock_break(struct cifsInodeInfo *cinode);
186 extern int cifs_unlock_range(struct cifsFileInfo *cfile,
187                              struct file_lock *flock, const unsigned int xid);
188 extern int cifs_push_mandatory_locks(struct cifsFileInfo *cfile);
189
190 extern void cifs_down_write(struct rw_semaphore *sem);
191 struct cifsFileInfo *cifs_new_fileinfo(struct cifs_fid *fid, struct file *file,
192                                        struct tcon_link *tlink, __u32 oplock,
193                                        const char *symlink_target);
194 extern int cifs_posix_open(const char *full_path, struct inode **inode,
195                            struct super_block *sb, int mode,
196                            unsigned int f_flags, __u32 *oplock, __u16 *netfid,
197                            unsigned int xid);
198 void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
199 extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
200                                      FILE_UNIX_BASIC_INFO *info,
201                                      struct cifs_sb_info *cifs_sb);
202 extern void cifs_dir_info_to_fattr(struct cifs_fattr *, FILE_DIRECTORY_INFO *,
203                                         struct cifs_sb_info *);
204 extern int cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
205 extern struct inode *cifs_iget(struct super_block *sb,
206                                struct cifs_fattr *fattr);
207
208 int cifs_get_inode_info(struct inode **inode, const char *full_path,
209                         struct cifs_open_info_data *data, struct super_block *sb, int xid,
210                         const struct cifs_fid *fid);
211 bool cifs_reparse_point_to_fattr(struct cifs_sb_info *cifs_sb,
212                                  struct cifs_fattr *fattr,
213                                  struct cifs_open_info_data *data);
214 extern int smb311_posix_get_inode_info(struct inode **pinode, const char *search_path,
215                         struct super_block *sb, unsigned int xid);
216 extern int cifs_get_inode_info_unix(struct inode **pinode,
217                         const unsigned char *search_path,
218                         struct super_block *sb, unsigned int xid);
219 extern int cifs_set_file_info(struct inode *inode, struct iattr *attrs,
220                               unsigned int xid, const char *full_path, __u32 dosattr);
221 extern int cifs_rename_pending_delete(const char *full_path,
222                                       struct dentry *dentry,
223                                       const unsigned int xid);
224 extern int sid_to_id(struct cifs_sb_info *cifs_sb, struct cifs_sid *psid,
225                                 struct cifs_fattr *fattr, uint sidtype);
226 extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
227                               struct cifs_fattr *fattr, struct inode *inode,
228                               bool get_mode_from_special_sid,
229                               const char *path, const struct cifs_fid *pfid);
230 extern int id_mode_to_cifs_acl(struct inode *inode, const char *path, __u64 *pnmode,
231                                         kuid_t uid, kgid_t gid);
232 extern struct cifs_ntsd *get_cifs_acl(struct cifs_sb_info *, struct inode *,
233                                       const char *, u32 *, u32);
234 extern struct cifs_ntsd *get_cifs_acl_by_fid(struct cifs_sb_info *,
235                                 const struct cifs_fid *, u32 *, u32);
236 extern struct posix_acl *cifs_get_acl(struct mnt_idmap *idmap,
237                                       struct dentry *dentry, int type);
238 extern int cifs_set_acl(struct mnt_idmap *idmap,
239                         struct dentry *dentry, struct posix_acl *acl, int type);
240 extern int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
241                                 const char *, int);
242 extern unsigned int setup_authusers_ACE(struct cifs_ace *pace);
243 extern unsigned int setup_special_mode_ACE(struct cifs_ace *pace, __u64 nmode);
244 extern unsigned int setup_special_user_owner_ACE(struct cifs_ace *pace);
245
246 extern void dequeue_mid(struct mid_q_entry *mid, bool malformed);
247 extern int cifs_read_from_socket(struct TCP_Server_Info *server, char *buf,
248                                  unsigned int to_read);
249 extern ssize_t cifs_discard_from_socket(struct TCP_Server_Info *server,
250                                         size_t to_read);
251 extern int cifs_read_page_from_socket(struct TCP_Server_Info *server,
252                                         struct page *page,
253                                         unsigned int page_offset,
254                                         unsigned int to_read);
255 int cifs_read_iter_from_socket(struct TCP_Server_Info *server,
256                                struct iov_iter *iter,
257                                unsigned int to_read);
258 extern int cifs_setup_cifs_sb(struct cifs_sb_info *cifs_sb);
259 void cifs_mount_put_conns(struct cifs_mount_ctx *mnt_ctx);
260 int cifs_mount_get_session(struct cifs_mount_ctx *mnt_ctx);
261 int cifs_is_path_remote(struct cifs_mount_ctx *mnt_ctx);
262 int cifs_mount_get_tcon(struct cifs_mount_ctx *mnt_ctx);
263 extern int cifs_match_super(struct super_block *, void *);
264 extern int cifs_mount(struct cifs_sb_info *cifs_sb, struct smb3_fs_context *ctx);
265 extern void cifs_umount(struct cifs_sb_info *);
266 extern void cifs_mark_open_files_invalid(struct cifs_tcon *tcon);
267 extern void cifs_reopen_persistent_handles(struct cifs_tcon *tcon);
268
269 extern bool cifs_find_lock_conflict(struct cifsFileInfo *cfile, __u64 offset,
270                                     __u64 length, __u8 type, __u16 flags,
271                                     struct cifsLockInfo **conf_lock,
272                                     int rw_check);
273 extern void cifs_add_pending_open(struct cifs_fid *fid,
274                                   struct tcon_link *tlink,
275                                   struct cifs_pending_open *open);
276 extern void cifs_add_pending_open_locked(struct cifs_fid *fid,
277                                          struct tcon_link *tlink,
278                                          struct cifs_pending_open *open);
279 extern void cifs_del_pending_open(struct cifs_pending_open *open);
280
281 extern bool cifs_is_deferred_close(struct cifsFileInfo *cfile,
282                                 struct cifs_deferred_close **dclose);
283
284 extern void cifs_add_deferred_close(struct cifsFileInfo *cfile,
285                                 struct cifs_deferred_close *dclose);
286
287 extern void cifs_del_deferred_close(struct cifsFileInfo *cfile);
288
289 extern void cifs_close_deferred_file(struct cifsInodeInfo *cifs_inode);
290
291 extern void cifs_close_all_deferred_files(struct cifs_tcon *cifs_tcon);
292
293 extern void cifs_close_deferred_file_under_dentry(struct cifs_tcon *cifs_tcon,
294                                 const char *path);
295 extern struct TCP_Server_Info *
296 cifs_get_tcp_session(struct smb3_fs_context *ctx,
297                      struct TCP_Server_Info *primary_server);
298 extern void cifs_put_tcp_session(struct TCP_Server_Info *server,
299                                  int from_reconnect);
300 extern void cifs_put_tcon(struct cifs_tcon *tcon);
301
302 extern void cifs_release_automount_timer(void);
303
304 void cifs_proc_init(void);
305 void cifs_proc_clean(void);
306
307 extern void cifs_move_llist(struct list_head *source, struct list_head *dest);
308 extern void cifs_free_llist(struct list_head *llist);
309 extern void cifs_del_lock_waiters(struct cifsLockInfo *lock);
310
311 extern int cifs_tree_connect(const unsigned int xid, struct cifs_tcon *tcon,
312                              const struct nls_table *nlsc);
313
314 extern int cifs_negotiate_protocol(const unsigned int xid,
315                                    struct cifs_ses *ses,
316                                    struct TCP_Server_Info *server);
317 extern int cifs_setup_session(const unsigned int xid, struct cifs_ses *ses,
318                               struct TCP_Server_Info *server,
319                               struct nls_table *nls_info);
320 extern int cifs_enable_signing(struct TCP_Server_Info *server, bool mnt_sign_required);
321 extern int CIFSSMBNegotiate(const unsigned int xid,
322                             struct cifs_ses *ses,
323                             struct TCP_Server_Info *server);
324
325 extern int CIFSTCon(const unsigned int xid, struct cifs_ses *ses,
326                     const char *tree, struct cifs_tcon *tcon,
327                     const struct nls_table *);
328
329 extern int CIFSFindFirst(const unsigned int xid, struct cifs_tcon *tcon,
330                 const char *searchName, struct cifs_sb_info *cifs_sb,
331                 __u16 *searchHandle, __u16 search_flags,
332                 struct cifs_search_info *psrch_inf,
333                 bool msearch);
334
335 extern int CIFSFindNext(const unsigned int xid, struct cifs_tcon *tcon,
336                 __u16 searchHandle, __u16 search_flags,
337                 struct cifs_search_info *psrch_inf);
338
339 extern int CIFSFindClose(const unsigned int xid, struct cifs_tcon *tcon,
340                         const __u16 search_handle);
341
342 extern int CIFSSMBQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
343                         u16 netfid, FILE_ALL_INFO *pFindData);
344 extern int CIFSSMBQPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
345                             const char *search_Name, FILE_ALL_INFO *data,
346                             int legacy /* whether to use old info level */,
347                             const struct nls_table *nls_codepage, int remap);
348 extern int SMBQueryInformation(const unsigned int xid, struct cifs_tcon *tcon,
349                                const char *search_name, FILE_ALL_INFO *data,
350                                const struct nls_table *nls_codepage, int remap);
351
352 extern int CIFSSMBUnixQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
353                         u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
354 extern int CIFSSMBUnixQPathInfo(const unsigned int xid,
355                         struct cifs_tcon *tcon,
356                         const unsigned char *searchName,
357                         FILE_UNIX_BASIC_INFO *pFindData,
358                         const struct nls_table *nls_codepage, int remap);
359
360 extern int CIFSGetDFSRefer(const unsigned int xid, struct cifs_ses *ses,
361                            const char *search_name,
362                            struct dfs_info3_param **target_nodes,
363                            unsigned int *num_of_nodes,
364                            const struct nls_table *nls_codepage, int remap);
365
366 extern int parse_dfs_referrals(struct get_dfs_referral_rsp *rsp, u32 rsp_size,
367                                unsigned int *num_of_nodes,
368                                struct dfs_info3_param **target_nodes,
369                                const struct nls_table *nls_codepage, int remap,
370                                const char *searchName, bool is_unicode);
371 extern void reset_cifs_unix_caps(unsigned int xid, struct cifs_tcon *tcon,
372                                  struct cifs_sb_info *cifs_sb,
373                                  struct smb3_fs_context *ctx);
374 extern int CIFSSMBQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
375                         struct kstatfs *FSData);
376 extern int SMBOldQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
377                         struct kstatfs *FSData);
378 extern int CIFSSMBSetFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon,
379                         __u64 cap);
380
381 extern int CIFSSMBQFSAttributeInfo(const unsigned int xid,
382                         struct cifs_tcon *tcon);
383 extern int CIFSSMBQFSDeviceInfo(const unsigned int xid, struct cifs_tcon *tcon);
384 extern int CIFSSMBQFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon);
385 extern int CIFSSMBQFSPosixInfo(const unsigned int xid, struct cifs_tcon *tcon,
386                         struct kstatfs *FSData);
387
388 extern int CIFSSMBSetPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
389                         const char *fileName, const FILE_BASIC_INFO *data,
390                         const struct nls_table *nls_codepage,
391                         struct cifs_sb_info *cifs_sb);
392 extern int CIFSSMBSetFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
393                         const FILE_BASIC_INFO *data, __u16 fid,
394                         __u32 pid_of_opener);
395 extern int CIFSSMBSetFileDisposition(const unsigned int xid,
396                                      struct cifs_tcon *tcon,
397                                      bool delete_file, __u16 fid,
398                                      __u32 pid_of_opener);
399 extern int CIFSSMBSetEOF(const unsigned int xid, struct cifs_tcon *tcon,
400                          const char *file_name, __u64 size,
401                          struct cifs_sb_info *cifs_sb, bool set_allocation);
402 extern int CIFSSMBSetFileSize(const unsigned int xid, struct cifs_tcon *tcon,
403                               struct cifsFileInfo *cfile, __u64 size,
404                               bool set_allocation);
405
406 struct cifs_unix_set_info_args {
407         __u64   ctime;
408         __u64   atime;
409         __u64   mtime;
410         __u64   mode;
411         kuid_t  uid;
412         kgid_t  gid;
413         dev_t   device;
414 };
415
416 extern int CIFSSMBUnixSetFileInfo(const unsigned int xid,
417                                   struct cifs_tcon *tcon,
418                                   const struct cifs_unix_set_info_args *args,
419                                   u16 fid, u32 pid_of_opener);
420
421 extern int CIFSSMBUnixSetPathInfo(const unsigned int xid,
422                                   struct cifs_tcon *tcon, const char *file_name,
423                                   const struct cifs_unix_set_info_args *args,
424                                   const struct nls_table *nls_codepage,
425                                   int remap);
426
427 extern int CIFSSMBMkDir(const unsigned int xid, struct inode *inode,
428                         umode_t mode, struct cifs_tcon *tcon,
429                         const char *name, struct cifs_sb_info *cifs_sb);
430 extern int CIFSSMBRmDir(const unsigned int xid, struct cifs_tcon *tcon,
431                         const char *name, struct cifs_sb_info *cifs_sb);
432 extern int CIFSPOSIXDelFile(const unsigned int xid, struct cifs_tcon *tcon,
433                         const char *name, __u16 type,
434                         const struct nls_table *nls_codepage,
435                         int remap_special_chars);
436 extern int CIFSSMBDelFile(const unsigned int xid, struct cifs_tcon *tcon,
437                           const char *name, struct cifs_sb_info *cifs_sb);
438 extern int CIFSSMBRename(const unsigned int xid, struct cifs_tcon *tcon,
439                          const char *from_name, const char *to_name,
440                          struct cifs_sb_info *cifs_sb);
441 extern int CIFSSMBRenameOpenFile(const unsigned int xid, struct cifs_tcon *tcon,
442                                  int netfid, const char *target_name,
443                                  const struct nls_table *nls_codepage,
444                                  int remap_special_chars);
445 extern int CIFSCreateHardLink(const unsigned int xid, struct cifs_tcon *tcon,
446                               const char *from_name, const char *to_name,
447                               struct cifs_sb_info *cifs_sb);
448 extern int CIFSUnixCreateHardLink(const unsigned int xid,
449                         struct cifs_tcon *tcon,
450                         const char *fromName, const char *toName,
451                         const struct nls_table *nls_codepage,
452                         int remap_special_chars);
453 extern int CIFSUnixCreateSymLink(const unsigned int xid,
454                         struct cifs_tcon *tcon,
455                         const char *fromName, const char *toName,
456                         const struct nls_table *nls_codepage, int remap);
457 extern int CIFSSMBUnixQuerySymLink(const unsigned int xid,
458                         struct cifs_tcon *tcon,
459                         const unsigned char *searchName, char **syminfo,
460                         const struct nls_table *nls_codepage, int remap);
461 extern int cifs_query_reparse_point(const unsigned int xid,
462                                     struct cifs_tcon *tcon,
463                                     struct cifs_sb_info *cifs_sb,
464                                     const char *full_path,
465                                     u32 *tag, struct kvec *rsp,
466                                     int *rsp_buftype);
467 extern int CIFSSMBQuerySymLink(const unsigned int xid, struct cifs_tcon *tcon,
468                                __u16 fid, char **symlinkinfo,
469                                const struct nls_table *nls_codepage);
470 extern int CIFSSMB_set_compression(const unsigned int xid,
471                                    struct cifs_tcon *tcon, __u16 fid);
472 extern int CIFS_open(const unsigned int xid, struct cifs_open_parms *oparms,
473                      int *oplock, FILE_ALL_INFO *buf);
474 extern int SMBLegacyOpen(const unsigned int xid, struct cifs_tcon *tcon,
475                         const char *fileName, const int disposition,
476                         const int access_flags, const int omode,
477                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
478                         const struct nls_table *nls_codepage, int remap);
479 extern int CIFSPOSIXCreate(const unsigned int xid, struct cifs_tcon *tcon,
480                         u32 posix_flags, __u64 mode, __u16 *netfid,
481                         FILE_UNIX_BASIC_INFO *pRetData,
482                         __u32 *pOplock, const char *name,
483                         const struct nls_table *nls_codepage, int remap);
484 extern int CIFSSMBClose(const unsigned int xid, struct cifs_tcon *tcon,
485                         const int smb_file_id);
486
487 extern int CIFSSMBFlush(const unsigned int xid, struct cifs_tcon *tcon,
488                         const int smb_file_id);
489
490 extern int CIFSSMBRead(const unsigned int xid, struct cifs_io_parms *io_parms,
491                         unsigned int *nbytes, char **buf,
492                         int *return_buf_type);
493 extern int CIFSSMBWrite(const unsigned int xid, struct cifs_io_parms *io_parms,
494                         unsigned int *nbytes, const char *buf);
495 extern int CIFSSMBWrite2(const unsigned int xid, struct cifs_io_parms *io_parms,
496                         unsigned int *nbytes, struct kvec *iov, const int nvec);
497 extern int CIFSGetSrvInodeNumber(const unsigned int xid, struct cifs_tcon *tcon,
498                                  const char *search_name, __u64 *inode_number,
499                                  const struct nls_table *nls_codepage,
500                                  int remap);
501
502 extern int cifs_lockv(const unsigned int xid, struct cifs_tcon *tcon,
503                       const __u16 netfid, const __u8 lock_type,
504                       const __u32 num_unlock, const __u32 num_lock,
505                       LOCKING_ANDX_RANGE *buf);
506 extern int CIFSSMBLock(const unsigned int xid, struct cifs_tcon *tcon,
507                         const __u16 netfid, const __u32 netpid, const __u64 len,
508                         const __u64 offset, const __u32 numUnlock,
509                         const __u32 numLock, const __u8 lockType,
510                         const bool waitFlag, const __u8 oplock_level);
511 extern int CIFSSMBPosixLock(const unsigned int xid, struct cifs_tcon *tcon,
512                         const __u16 smb_file_id, const __u32 netpid,
513                         const loff_t start_offset, const __u64 len,
514                         struct file_lock *, const __u16 lock_type,
515                         const bool waitFlag);
516 extern int CIFSSMBTDis(const unsigned int xid, struct cifs_tcon *tcon);
517 extern int CIFSSMBEcho(struct TCP_Server_Info *server);
518 extern int CIFSSMBLogoff(const unsigned int xid, struct cifs_ses *ses);
519
520 extern struct cifs_ses *sesInfoAlloc(void);
521 extern void sesInfoFree(struct cifs_ses *);
522 extern struct cifs_tcon *tcon_info_alloc(bool dir_leases_enabled);
523 extern void tconInfoFree(struct cifs_tcon *);
524
525 extern int cifs_sign_rqst(struct smb_rqst *rqst, struct TCP_Server_Info *server,
526                    __u32 *pexpected_response_sequence_number);
527 extern int cifs_sign_smbv(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
528                           __u32 *);
529 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
530 extern int cifs_verify_signature(struct smb_rqst *rqst,
531                                  struct TCP_Server_Info *server,
532                                 __u32 expected_sequence_number);
533 extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
534 extern void cifs_crypto_secmech_release(struct TCP_Server_Info *server);
535 extern int calc_seckey(struct cifs_ses *);
536 extern int generate_smb30signingkey(struct cifs_ses *ses,
537                                     struct TCP_Server_Info *server);
538 extern int generate_smb311signingkey(struct cifs_ses *ses,
539                                      struct TCP_Server_Info *server);
540
541 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
542 extern int CIFSSMBCopy(unsigned int xid,
543                         struct cifs_tcon *source_tcon,
544                         const char *fromName,
545                         const __u16 target_tid,
546                         const char *toName, const int flags,
547                         const struct nls_table *nls_codepage,
548                         int remap_special_chars);
549 extern ssize_t CIFSSMBQAllEAs(const unsigned int xid, struct cifs_tcon *tcon,
550                         const unsigned char *searchName,
551                         const unsigned char *ea_name, char *EAData,
552                         size_t bufsize, struct cifs_sb_info *cifs_sb);
553 extern int CIFSSMBSetEA(const unsigned int xid, struct cifs_tcon *tcon,
554                 const char *fileName, const char *ea_name,
555                 const void *ea_value, const __u16 ea_value_len,
556                 const struct nls_table *nls_codepage,
557                 struct cifs_sb_info *cifs_sb);
558 extern int CIFSSMBGetCIFSACL(const unsigned int xid, struct cifs_tcon *tcon,
559                         __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
560 extern int CIFSSMBSetCIFSACL(const unsigned int, struct cifs_tcon *, __u16,
561                         struct cifs_ntsd *, __u32, int);
562 extern int cifs_do_get_acl(const unsigned int xid, struct cifs_tcon *tcon,
563                            const unsigned char *searchName,
564                            struct posix_acl **acl, const int acl_type,
565                            const struct nls_table *nls_codepage, int remap);
566 extern int cifs_do_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
567                            const unsigned char *fileName,
568                            const struct posix_acl *acl, const int acl_type,
569                            const struct nls_table *nls_codepage, int remap);
570 extern int CIFSGetExtAttr(const unsigned int xid, struct cifs_tcon *tcon,
571                         const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
572 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
573 extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
574 extern bool couldbe_mf_symlink(const struct cifs_fattr *fattr);
575 extern int check_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
576                               struct cifs_sb_info *cifs_sb,
577                               struct cifs_fattr *fattr,
578                               const unsigned char *path);
579 extern int E_md4hash(const unsigned char *passwd, unsigned char *p16,
580                         const struct nls_table *codepage);
581
582 extern struct TCP_Server_Info *
583 cifs_find_tcp_session(struct smb3_fs_context *ctx);
584
585 void __cifs_put_smb_ses(struct cifs_ses *ses);
586
587 extern struct cifs_ses *
588 cifs_get_smb_ses(struct TCP_Server_Info *server, struct smb3_fs_context *ctx);
589
590 void cifs_readdata_release(struct kref *refcount);
591 int cifs_async_readv(struct cifs_readdata *rdata);
592 int cifs_readv_receive(struct TCP_Server_Info *server, struct mid_q_entry *mid);
593
594 int cifs_async_writev(struct cifs_writedata *wdata,
595                       void (*release)(struct kref *kref));
596 void cifs_writev_complete(struct work_struct *work);
597 struct cifs_writedata *cifs_writedata_alloc(work_func_t complete);
598 void cifs_writedata_release(struct kref *refcount);
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 struct cifs_aio_ctx *cifs_aio_ctx_alloc(void);
613 void cifs_aio_ctx_release(struct kref *refcount);
614
615 int cifs_alloc_hash(const char *name, struct shash_desc **sdesc);
616 void cifs_free_hash(struct shash_desc **sdesc);
617
618 struct cifs_chan *
619 cifs_ses_find_chan(struct cifs_ses *ses, struct TCP_Server_Info *server);
620 int cifs_try_adding_channels(struct cifs_ses *ses);
621 bool is_server_using_iface(struct TCP_Server_Info *server,
622                            struct cifs_server_iface *iface);
623 bool is_ses_using_iface(struct cifs_ses *ses, struct cifs_server_iface *iface);
624 void cifs_ses_mark_for_reconnect(struct cifs_ses *ses);
625
626 int
627 cifs_ses_get_chan_index(struct cifs_ses *ses,
628                         struct TCP_Server_Info *server);
629 void
630 cifs_chan_set_in_reconnect(struct cifs_ses *ses,
631                              struct TCP_Server_Info *server);
632 void
633 cifs_chan_clear_in_reconnect(struct cifs_ses *ses,
634                                struct TCP_Server_Info *server);
635 bool
636 cifs_chan_in_reconnect(struct cifs_ses *ses,
637                           struct TCP_Server_Info *server);
638 void
639 cifs_chan_set_need_reconnect(struct cifs_ses *ses,
640                              struct TCP_Server_Info *server);
641 void
642 cifs_chan_clear_need_reconnect(struct cifs_ses *ses,
643                                struct TCP_Server_Info *server);
644 bool
645 cifs_chan_needs_reconnect(struct cifs_ses *ses,
646                           struct TCP_Server_Info *server);
647 bool
648 cifs_chan_is_iface_active(struct cifs_ses *ses,
649                           struct TCP_Server_Info *server);
650 void
651 cifs_disable_secondary_channels(struct cifs_ses *ses);
652 int
653 cifs_chan_update_iface(struct cifs_ses *ses, struct TCP_Server_Info *server);
654 int
655 SMB3_request_interfaces(const unsigned int xid, struct cifs_tcon *tcon, bool in_mount);
656
657 void extract_unc_hostname(const char *unc, const char **h, size_t *len);
658 int copy_path_name(char *dst, const char *src);
659 int smb2_parse_query_directory(struct cifs_tcon *tcon, struct kvec *rsp_iov,
660                                int resp_buftype,
661                                struct cifs_search_info *srch_inf);
662
663 struct super_block *cifs_get_dfs_tcon_super(struct cifs_tcon *tcon);
664 void cifs_put_tcp_super(struct super_block *sb);
665 int cifs_update_super_prepath(struct cifs_sb_info *cifs_sb, char *prefix);
666 char *extract_hostname(const char *unc);
667 char *extract_sharename(const char *unc);
668 int parse_reparse_point(struct reparse_data_buffer *buf,
669                         u32 plen, struct cifs_sb_info *cifs_sb,
670                         bool unicode, struct cifs_open_info_data *data);
671 int cifs_sfu_make_node(unsigned int xid, struct inode *inode,
672                        struct dentry *dentry, struct cifs_tcon *tcon,
673                        const char *full_path, umode_t mode, dev_t dev);
674
675 #ifdef CONFIG_CIFS_DFS_UPCALL
676 static inline int get_dfs_path(const unsigned int xid, struct cifs_ses *ses,
677                                const char *old_path,
678                                const struct nls_table *nls_codepage,
679                                struct dfs_info3_param *referral, int remap)
680 {
681         return dfs_cache_find(xid, ses, nls_codepage, remap, old_path,
682                               referral, NULL);
683 }
684
685 int match_target_ip(struct TCP_Server_Info *server,
686                     const char *share, size_t share_len,
687                     bool *result);
688 int cifs_inval_name_dfs_link_error(const unsigned int xid,
689                                    struct cifs_tcon *tcon,
690                                    struct cifs_sb_info *cifs_sb,
691                                    const char *full_path,
692                                    bool *islink);
693 #else
694 static inline int cifs_inval_name_dfs_link_error(const unsigned int xid,
695                                    struct cifs_tcon *tcon,
696                                    struct cifs_sb_info *cifs_sb,
697                                    const char *full_path,
698                                    bool *islink)
699 {
700         *islink = false;
701         return 0;
702 }
703 #endif
704
705 static inline int cifs_create_options(struct cifs_sb_info *cifs_sb, int options)
706 {
707         if (cifs_sb && (backup_cred(cifs_sb)))
708                 return options | CREATE_OPEN_BACKUP_INTENT;
709         else
710                 return options;
711 }
712
713 struct super_block *cifs_get_tcon_super(struct cifs_tcon *tcon);
714 void cifs_put_tcon_super(struct super_block *sb);
715 int cifs_wait_for_server_reconnect(struct TCP_Server_Info *server, bool retry);
716
717 /* Put references of @ses and @ses->dfs_root_ses */
718 static inline void cifs_put_smb_ses(struct cifs_ses *ses)
719 {
720         struct cifs_ses *rses = ses->dfs_root_ses;
721
722         __cifs_put_smb_ses(ses);
723         if (rses)
724                 __cifs_put_smb_ses(rses);
725 }
726
727 /* Get an active reference of @ses and @ses->dfs_root_ses.
728  *
729  * NOTE: make sure to call this function when incrementing reference count of
730  * @ses to ensure that any DFS root session attached to it (@ses->dfs_root_ses)
731  * will also get its reference count incremented.
732  *
733  * cifs_put_smb_ses() will put both references, so call it when you're done.
734  */
735 static inline void cifs_smb_ses_inc_refcount(struct cifs_ses *ses)
736 {
737         lockdep_assert_held(&cifs_tcp_ses_lock);
738
739         ses->ses_count++;
740         if (ses->dfs_root_ses)
741                 ses->dfs_root_ses->ses_count++;
742 }
743
744 static inline bool dfs_src_pathname_equal(const char *s1, const char *s2)
745 {
746         if (strlen(s1) != strlen(s2))
747                 return false;
748         for (; *s1; s1++, s2++) {
749                 if (*s1 == '/' || *s1 == '\\') {
750                         if (*s2 != '/' && *s2 != '\\')
751                                 return false;
752                 } else if (tolower(*s1) != tolower(*s2))
753                         return false;
754         }
755         return true;
756 }
757
758 static inline void release_mid(struct mid_q_entry *mid)
759 {
760         kref_put(&mid->refcount, __release_mid);
761 }
762
763 #endif                  /* _CIFSPROTO_H */