smb: client: implement ->query_reparse_point() for SMB1
[sfrench/cifs-2.6.git] / fs / cifs / 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                                  u32 tag);
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 int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
237                                 const char *, int);
238 extern unsigned int setup_authusers_ACE(struct cifs_ace *pace);
239 extern unsigned int setup_special_mode_ACE(struct cifs_ace *pace, __u64 nmode);
240 extern unsigned int setup_special_user_owner_ACE(struct cifs_ace *pace);
241
242 extern void dequeue_mid(struct mid_q_entry *mid, bool malformed);
243 extern int cifs_read_from_socket(struct TCP_Server_Info *server, char *buf,
244                                  unsigned int to_read);
245 extern ssize_t cifs_discard_from_socket(struct TCP_Server_Info *server,
246                                         size_t to_read);
247 extern int cifs_read_page_from_socket(struct TCP_Server_Info *server,
248                                         struct page *page,
249                                         unsigned int page_offset,
250                                         unsigned int to_read);
251 int cifs_read_iter_from_socket(struct TCP_Server_Info *server,
252                                struct iov_iter *iter,
253                                unsigned int to_read);
254 extern int cifs_setup_cifs_sb(struct cifs_sb_info *cifs_sb);
255 void cifs_mount_put_conns(struct cifs_mount_ctx *mnt_ctx);
256 int cifs_mount_get_session(struct cifs_mount_ctx *mnt_ctx);
257 int cifs_is_path_remote(struct cifs_mount_ctx *mnt_ctx);
258 int cifs_mount_get_tcon(struct cifs_mount_ctx *mnt_ctx);
259 extern int cifs_match_super(struct super_block *, void *);
260 extern int cifs_mount(struct cifs_sb_info *cifs_sb, struct smb3_fs_context *ctx);
261 extern void cifs_umount(struct cifs_sb_info *);
262 extern void cifs_mark_open_files_invalid(struct cifs_tcon *tcon);
263 extern void cifs_reopen_persistent_handles(struct cifs_tcon *tcon);
264
265 extern bool cifs_find_lock_conflict(struct cifsFileInfo *cfile, __u64 offset,
266                                     __u64 length, __u8 type, __u16 flags,
267                                     struct cifsLockInfo **conf_lock,
268                                     int rw_check);
269 extern void cifs_add_pending_open(struct cifs_fid *fid,
270                                   struct tcon_link *tlink,
271                                   struct cifs_pending_open *open);
272 extern void cifs_add_pending_open_locked(struct cifs_fid *fid,
273                                          struct tcon_link *tlink,
274                                          struct cifs_pending_open *open);
275 extern void cifs_del_pending_open(struct cifs_pending_open *open);
276
277 extern bool cifs_is_deferred_close(struct cifsFileInfo *cfile,
278                                 struct cifs_deferred_close **dclose);
279
280 extern void cifs_add_deferred_close(struct cifsFileInfo *cfile,
281                                 struct cifs_deferred_close *dclose);
282
283 extern void cifs_del_deferred_close(struct cifsFileInfo *cfile);
284
285 extern void cifs_close_deferred_file(struct cifsInodeInfo *cifs_inode);
286
287 extern void cifs_close_all_deferred_files(struct cifs_tcon *cifs_tcon);
288
289 extern void cifs_close_deferred_file_under_dentry(struct cifs_tcon *cifs_tcon,
290                                 const char *path);
291 extern struct TCP_Server_Info *
292 cifs_get_tcp_session(struct smb3_fs_context *ctx,
293                      struct TCP_Server_Info *primary_server);
294 extern void cifs_put_tcp_session(struct TCP_Server_Info *server,
295                                  int from_reconnect);
296 extern void cifs_put_tcon(struct cifs_tcon *tcon);
297
298 extern void cifs_release_automount_timer(void);
299
300 void cifs_proc_init(void);
301 void cifs_proc_clean(void);
302
303 extern void cifs_move_llist(struct list_head *source, struct list_head *dest);
304 extern void cifs_free_llist(struct list_head *llist);
305 extern void cifs_del_lock_waiters(struct cifsLockInfo *lock);
306
307 extern int cifs_tree_connect(const unsigned int xid, struct cifs_tcon *tcon,
308                              const struct nls_table *nlsc);
309
310 extern int cifs_negotiate_protocol(const unsigned int xid,
311                                    struct cifs_ses *ses,
312                                    struct TCP_Server_Info *server);
313 extern int cifs_setup_session(const unsigned int xid, struct cifs_ses *ses,
314                               struct TCP_Server_Info *server,
315                               struct nls_table *nls_info);
316 extern int cifs_enable_signing(struct TCP_Server_Info *server, bool mnt_sign_required);
317 extern int CIFSSMBNegotiate(const unsigned int xid,
318                             struct cifs_ses *ses,
319                             struct TCP_Server_Info *server);
320
321 extern int CIFSTCon(const unsigned int xid, struct cifs_ses *ses,
322                     const char *tree, struct cifs_tcon *tcon,
323                     const struct nls_table *);
324
325 extern int CIFSFindFirst(const unsigned int xid, struct cifs_tcon *tcon,
326                 const char *searchName, struct cifs_sb_info *cifs_sb,
327                 __u16 *searchHandle, __u16 search_flags,
328                 struct cifs_search_info *psrch_inf,
329                 bool msearch);
330
331 extern int CIFSFindNext(const unsigned int xid, struct cifs_tcon *tcon,
332                 __u16 searchHandle, __u16 search_flags,
333                 struct cifs_search_info *psrch_inf);
334
335 extern int CIFSFindClose(const unsigned int xid, struct cifs_tcon *tcon,
336                         const __u16 search_handle);
337
338 extern int CIFSSMBQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
339                         u16 netfid, FILE_ALL_INFO *pFindData);
340 extern int CIFSSMBQPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
341                             const char *search_Name, FILE_ALL_INFO *data,
342                             int legacy /* whether to use old info level */,
343                             const struct nls_table *nls_codepage, int remap);
344 extern int SMBQueryInformation(const unsigned int xid, struct cifs_tcon *tcon,
345                                const char *search_name, FILE_ALL_INFO *data,
346                                const struct nls_table *nls_codepage, int remap);
347
348 extern int CIFSSMBUnixQFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
349                         u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
350 extern int CIFSSMBUnixQPathInfo(const unsigned int xid,
351                         struct cifs_tcon *tcon,
352                         const unsigned char *searchName,
353                         FILE_UNIX_BASIC_INFO *pFindData,
354                         const struct nls_table *nls_codepage, int remap);
355
356 extern int CIFSGetDFSRefer(const unsigned int xid, struct cifs_ses *ses,
357                            const char *search_name,
358                            struct dfs_info3_param **target_nodes,
359                            unsigned int *num_of_nodes,
360                            const struct nls_table *nls_codepage, int remap);
361
362 extern int parse_dfs_referrals(struct get_dfs_referral_rsp *rsp, u32 rsp_size,
363                                unsigned int *num_of_nodes,
364                                struct dfs_info3_param **target_nodes,
365                                const struct nls_table *nls_codepage, int remap,
366                                const char *searchName, bool is_unicode);
367 extern void reset_cifs_unix_caps(unsigned int xid, struct cifs_tcon *tcon,
368                                  struct cifs_sb_info *cifs_sb,
369                                  struct smb3_fs_context *ctx);
370 extern int CIFSSMBQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
371                         struct kstatfs *FSData);
372 extern int SMBOldQFSInfo(const unsigned int xid, struct cifs_tcon *tcon,
373                         struct kstatfs *FSData);
374 extern int CIFSSMBSetFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon,
375                         __u64 cap);
376
377 extern int CIFSSMBQFSAttributeInfo(const unsigned int xid,
378                         struct cifs_tcon *tcon);
379 extern int CIFSSMBQFSDeviceInfo(const unsigned int xid, struct cifs_tcon *tcon);
380 extern int CIFSSMBQFSUnixInfo(const unsigned int xid, struct cifs_tcon *tcon);
381 extern int CIFSSMBQFSPosixInfo(const unsigned int xid, struct cifs_tcon *tcon,
382                         struct kstatfs *FSData);
383
384 extern int CIFSSMBSetPathInfo(const unsigned int xid, struct cifs_tcon *tcon,
385                         const char *fileName, const FILE_BASIC_INFO *data,
386                         const struct nls_table *nls_codepage,
387                         struct cifs_sb_info *cifs_sb);
388 extern int CIFSSMBSetFileInfo(const unsigned int xid, struct cifs_tcon *tcon,
389                         const FILE_BASIC_INFO *data, __u16 fid,
390                         __u32 pid_of_opener);
391 extern int CIFSSMBSetFileDisposition(const unsigned int xid,
392                                      struct cifs_tcon *tcon,
393                                      bool delete_file, __u16 fid,
394                                      __u32 pid_of_opener);
395 extern int CIFSSMBSetEOF(const unsigned int xid, struct cifs_tcon *tcon,
396                          const char *file_name, __u64 size,
397                          struct cifs_sb_info *cifs_sb, bool set_allocation);
398 extern int CIFSSMBSetFileSize(const unsigned int xid, struct cifs_tcon *tcon,
399                               struct cifsFileInfo *cfile, __u64 size,
400                               bool set_allocation);
401
402 struct cifs_unix_set_info_args {
403         __u64   ctime;
404         __u64   atime;
405         __u64   mtime;
406         __u64   mode;
407         kuid_t  uid;
408         kgid_t  gid;
409         dev_t   device;
410 };
411
412 extern int CIFSSMBUnixSetFileInfo(const unsigned int xid,
413                                   struct cifs_tcon *tcon,
414                                   const struct cifs_unix_set_info_args *args,
415                                   u16 fid, u32 pid_of_opener);
416
417 extern int CIFSSMBUnixSetPathInfo(const unsigned int xid,
418                                   struct cifs_tcon *tcon, const char *file_name,
419                                   const struct cifs_unix_set_info_args *args,
420                                   const struct nls_table *nls_codepage,
421                                   int remap);
422
423 extern int CIFSSMBMkDir(const unsigned int xid, struct inode *inode,
424                         umode_t mode, struct cifs_tcon *tcon,
425                         const char *name, struct cifs_sb_info *cifs_sb);
426 extern int CIFSSMBRmDir(const unsigned int xid, struct cifs_tcon *tcon,
427                         const char *name, struct cifs_sb_info *cifs_sb);
428 extern int CIFSPOSIXDelFile(const unsigned int xid, struct cifs_tcon *tcon,
429                         const char *name, __u16 type,
430                         const struct nls_table *nls_codepage,
431                         int remap_special_chars);
432 extern int CIFSSMBDelFile(const unsigned int xid, struct cifs_tcon *tcon,
433                           const char *name, struct cifs_sb_info *cifs_sb);
434 extern int CIFSSMBRename(const unsigned int xid, struct cifs_tcon *tcon,
435                          const char *from_name, const char *to_name,
436                          struct cifs_sb_info *cifs_sb);
437 extern int CIFSSMBRenameOpenFile(const unsigned int xid, struct cifs_tcon *tcon,
438                                  int netfid, const char *target_name,
439                                  const struct nls_table *nls_codepage,
440                                  int remap_special_chars);
441 extern int CIFSCreateHardLink(const unsigned int xid, struct cifs_tcon *tcon,
442                               const char *from_name, const char *to_name,
443                               struct cifs_sb_info *cifs_sb);
444 extern int CIFSUnixCreateHardLink(const unsigned int xid,
445                         struct cifs_tcon *tcon,
446                         const char *fromName, const char *toName,
447                         const struct nls_table *nls_codepage,
448                         int remap_special_chars);
449 extern int CIFSUnixCreateSymLink(const unsigned int xid,
450                         struct cifs_tcon *tcon,
451                         const char *fromName, const char *toName,
452                         const struct nls_table *nls_codepage, int remap);
453 extern int CIFSSMBUnixQuerySymLink(const unsigned int xid,
454                         struct cifs_tcon *tcon,
455                         const unsigned char *searchName, char **syminfo,
456                         const struct nls_table *nls_codepage, int remap);
457 extern int cifs_query_reparse_point(const unsigned int xid,
458                                     struct cifs_tcon *tcon,
459                                     struct cifs_sb_info *cifs_sb,
460                                     const char *full_path,
461                                     u32 *tag, struct kvec *rsp,
462                                     int *rsp_buftype);
463 extern int CIFSSMBQuerySymLink(const unsigned int xid, struct cifs_tcon *tcon,
464                                __u16 fid, char **symlinkinfo,
465                                const struct nls_table *nls_codepage);
466 extern int CIFSSMB_set_compression(const unsigned int xid,
467                                    struct cifs_tcon *tcon, __u16 fid);
468 extern int CIFS_open(const unsigned int xid, struct cifs_open_parms *oparms,
469                      int *oplock, FILE_ALL_INFO *buf);
470 extern int SMBLegacyOpen(const unsigned int xid, struct cifs_tcon *tcon,
471                         const char *fileName, const int disposition,
472                         const int access_flags, const int omode,
473                         __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
474                         const struct nls_table *nls_codepage, int remap);
475 extern int CIFSPOSIXCreate(const unsigned int xid, struct cifs_tcon *tcon,
476                         u32 posix_flags, __u64 mode, __u16 *netfid,
477                         FILE_UNIX_BASIC_INFO *pRetData,
478                         __u32 *pOplock, const char *name,
479                         const struct nls_table *nls_codepage, int remap);
480 extern int CIFSSMBClose(const unsigned int xid, struct cifs_tcon *tcon,
481                         const int smb_file_id);
482
483 extern int CIFSSMBFlush(const unsigned int xid, struct cifs_tcon *tcon,
484                         const int smb_file_id);
485
486 extern int CIFSSMBRead(const unsigned int xid, struct cifs_io_parms *io_parms,
487                         unsigned int *nbytes, char **buf,
488                         int *return_buf_type);
489 extern int CIFSSMBWrite(const unsigned int xid, struct cifs_io_parms *io_parms,
490                         unsigned int *nbytes, const char *buf);
491 extern int CIFSSMBWrite2(const unsigned int xid, struct cifs_io_parms *io_parms,
492                         unsigned int *nbytes, struct kvec *iov, const int nvec);
493 extern int CIFSGetSrvInodeNumber(const unsigned int xid, struct cifs_tcon *tcon,
494                                  const char *search_name, __u64 *inode_number,
495                                  const struct nls_table *nls_codepage,
496                                  int remap);
497
498 extern int cifs_lockv(const unsigned int xid, struct cifs_tcon *tcon,
499                       const __u16 netfid, const __u8 lock_type,
500                       const __u32 num_unlock, const __u32 num_lock,
501                       LOCKING_ANDX_RANGE *buf);
502 extern int CIFSSMBLock(const unsigned int xid, struct cifs_tcon *tcon,
503                         const __u16 netfid, const __u32 netpid, const __u64 len,
504                         const __u64 offset, const __u32 numUnlock,
505                         const __u32 numLock, const __u8 lockType,
506                         const bool waitFlag, const __u8 oplock_level);
507 extern int CIFSSMBPosixLock(const unsigned int xid, struct cifs_tcon *tcon,
508                         const __u16 smb_file_id, const __u32 netpid,
509                         const loff_t start_offset, const __u64 len,
510                         struct file_lock *, const __u16 lock_type,
511                         const bool waitFlag);
512 extern int CIFSSMBTDis(const unsigned int xid, struct cifs_tcon *tcon);
513 extern int CIFSSMBEcho(struct TCP_Server_Info *server);
514 extern int CIFSSMBLogoff(const unsigned int xid, struct cifs_ses *ses);
515
516 extern struct cifs_ses *sesInfoAlloc(void);
517 extern void sesInfoFree(struct cifs_ses *);
518 extern struct cifs_tcon *tcon_info_alloc(bool dir_leases_enabled);
519 extern void tconInfoFree(struct cifs_tcon *);
520
521 extern int cifs_sign_rqst(struct smb_rqst *rqst, struct TCP_Server_Info *server,
522                    __u32 *pexpected_response_sequence_number);
523 extern int cifs_sign_smbv(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
524                           __u32 *);
525 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
526 extern int cifs_verify_signature(struct smb_rqst *rqst,
527                                  struct TCP_Server_Info *server,
528                                 __u32 expected_sequence_number);
529 extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
530 extern void cifs_crypto_secmech_release(struct TCP_Server_Info *server);
531 extern int calc_seckey(struct cifs_ses *);
532 extern int generate_smb30signingkey(struct cifs_ses *ses,
533                                     struct TCP_Server_Info *server);
534 extern int generate_smb311signingkey(struct cifs_ses *ses,
535                                      struct TCP_Server_Info *server);
536
537 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
538 extern int CIFSSMBCopy(unsigned int xid,
539                         struct cifs_tcon *source_tcon,
540                         const char *fromName,
541                         const __u16 target_tid,
542                         const char *toName, const int flags,
543                         const struct nls_table *nls_codepage,
544                         int remap_special_chars);
545 extern ssize_t CIFSSMBQAllEAs(const unsigned int xid, struct cifs_tcon *tcon,
546                         const unsigned char *searchName,
547                         const unsigned char *ea_name, char *EAData,
548                         size_t bufsize, struct cifs_sb_info *cifs_sb);
549 extern int CIFSSMBSetEA(const unsigned int xid, struct cifs_tcon *tcon,
550                 const char *fileName, const char *ea_name,
551                 const void *ea_value, const __u16 ea_value_len,
552                 const struct nls_table *nls_codepage,
553                 struct cifs_sb_info *cifs_sb);
554 extern int CIFSSMBGetCIFSACL(const unsigned int xid, struct cifs_tcon *tcon,
555                         __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
556 extern int CIFSSMBSetCIFSACL(const unsigned int, struct cifs_tcon *, __u16,
557                         struct cifs_ntsd *, __u32, int);
558 extern int CIFSSMBGetPosixACL(const unsigned int xid, struct cifs_tcon *tcon,
559                 const unsigned char *searchName,
560                 char *acl_inf, const int buflen, const int acl_type,
561                 const struct nls_table *nls_codepage, int remap_special_chars);
562 extern int CIFSSMBSetPosixACL(const unsigned int xid, struct cifs_tcon *tcon,
563                 const unsigned char *fileName,
564                 const char *local_acl, const int buflen, const int acl_type,
565                 const struct nls_table *nls_codepage, int remap_special_chars);
566 extern int CIFSGetExtAttr(const unsigned int xid, struct cifs_tcon *tcon,
567                         const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
568 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
569 extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
570 extern bool couldbe_mf_symlink(const struct cifs_fattr *fattr);
571 extern int check_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
572                               struct cifs_sb_info *cifs_sb,
573                               struct cifs_fattr *fattr,
574                               const unsigned char *path);
575 extern int E_md4hash(const unsigned char *passwd, unsigned char *p16,
576                         const struct nls_table *codepage);
577
578 extern struct TCP_Server_Info *
579 cifs_find_tcp_session(struct smb3_fs_context *ctx);
580
581 void __cifs_put_smb_ses(struct cifs_ses *ses);
582
583 extern struct cifs_ses *
584 cifs_get_smb_ses(struct TCP_Server_Info *server, struct smb3_fs_context *ctx);
585
586 void cifs_readdata_release(struct kref *refcount);
587 int cifs_async_readv(struct cifs_readdata *rdata);
588 int cifs_readv_receive(struct TCP_Server_Info *server, struct mid_q_entry *mid);
589
590 int cifs_async_writev(struct cifs_writedata *wdata,
591                       void (*release)(struct kref *kref));
592 void cifs_writev_complete(struct work_struct *work);
593 struct cifs_writedata *cifs_writedata_alloc(unsigned int nr_pages,
594                                                 work_func_t complete);
595 struct cifs_writedata *cifs_writedata_direct_alloc(struct page **pages,
596                                                 work_func_t complete);
597 void cifs_writedata_release(struct kref *refcount);
598 int cifs_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
599                           struct cifs_sb_info *cifs_sb,
600                           const unsigned char *path, char *pbuf,
601                           unsigned int *pbytes_read);
602 int cifs_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
603                            struct cifs_sb_info *cifs_sb,
604                            const unsigned char *path, char *pbuf,
605                            unsigned int *pbytes_written);
606 int __cifs_calc_signature(struct smb_rqst *rqst,
607                         struct TCP_Server_Info *server, char *signature,
608                         struct shash_desc *shash);
609 enum securityEnum cifs_select_sectype(struct TCP_Server_Info *,
610                                         enum securityEnum);
611 struct cifs_aio_ctx *cifs_aio_ctx_alloc(void);
612 void cifs_aio_ctx_release(struct kref *refcount);
613 int setup_aio_ctx_iter(struct cifs_aio_ctx *ctx, struct iov_iter *iter, int rw);
614
615 int cifs_alloc_hash(const char *name, struct shash_desc **sdesc);
616 void cifs_free_hash(struct shash_desc **sdesc);
617
618 void rqst_page_get_length(const struct smb_rqst *rqst, unsigned int page,
619                           unsigned int *len, unsigned int *offset);
620 struct cifs_chan *
621 cifs_ses_find_chan(struct cifs_ses *ses, struct TCP_Server_Info *server);
622 int cifs_try_adding_channels(struct cifs_ses *ses);
623 bool is_server_using_iface(struct TCP_Server_Info *server,
624                            struct cifs_server_iface *iface);
625 bool is_ses_using_iface(struct cifs_ses *ses, struct cifs_server_iface *iface);
626 void cifs_ses_mark_for_reconnect(struct cifs_ses *ses);
627
628 int
629 cifs_ses_get_chan_index(struct cifs_ses *ses,
630                         struct TCP_Server_Info *server);
631 void
632 cifs_chan_set_in_reconnect(struct cifs_ses *ses,
633                              struct TCP_Server_Info *server);
634 void
635 cifs_chan_clear_in_reconnect(struct cifs_ses *ses,
636                                struct TCP_Server_Info *server);
637 bool
638 cifs_chan_in_reconnect(struct cifs_ses *ses,
639                           struct TCP_Server_Info *server);
640 void
641 cifs_chan_set_need_reconnect(struct cifs_ses *ses,
642                              struct TCP_Server_Info *server);
643 void
644 cifs_chan_clear_need_reconnect(struct cifs_ses *ses,
645                                struct TCP_Server_Info *server);
646 bool
647 cifs_chan_needs_reconnect(struct cifs_ses *ses,
648                           struct TCP_Server_Info *server);
649 bool
650 cifs_chan_is_iface_active(struct cifs_ses *ses,
651                           struct TCP_Server_Info *server);
652 void
653 cifs_disable_secondary_channels(struct cifs_ses *ses);
654 int
655 cifs_chan_update_iface(struct cifs_ses *ses, struct TCP_Server_Info *server);
656 int
657 SMB3_request_interfaces(const unsigned int xid, struct cifs_tcon *tcon, bool in_mount);
658
659 void extract_unc_hostname(const char *unc, const char **h, size_t *len);
660 int copy_path_name(char *dst, const char *src);
661 int smb2_parse_query_directory(struct cifs_tcon *tcon, struct kvec *rsp_iov,
662                                int resp_buftype,
663                                struct cifs_search_info *srch_inf);
664
665 struct super_block *cifs_get_dfs_tcon_super(struct cifs_tcon *tcon);
666 void cifs_put_tcp_super(struct super_block *sb);
667 int cifs_update_super_prepath(struct cifs_sb_info *cifs_sb, char *prefix);
668 char *extract_hostname(const char *unc);
669 char *extract_sharename(const char *unc);
670 int parse_reparse_point(struct reparse_data_buffer *buf,
671                         u32 plen, struct cifs_sb_info *cifs_sb,
672                         bool unicode, char **target_path);
673
674 #ifdef CONFIG_CIFS_DFS_UPCALL
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
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
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 struct super_block *cifs_get_tcon_super(struct cifs_tcon *tcon);
713 void cifs_put_tcon_super(struct super_block *sb);
714 int cifs_wait_for_server_reconnect(struct TCP_Server_Info *server, bool retry);
715
716 /* Put references of @ses and @ses->dfs_root_ses */
717 static inline void cifs_put_smb_ses(struct cifs_ses *ses)
718 {
719         struct cifs_ses *rses = ses->dfs_root_ses;
720
721         __cifs_put_smb_ses(ses);
722         if (rses)
723                 __cifs_put_smb_ses(rses);
724 }
725
726 /* Get an active reference of @ses and @ses->dfs_root_ses.
727  *
728  * NOTE: make sure to call this function when incrementing reference count of
729  * @ses to ensure that any DFS root session attached to it (@ses->dfs_root_ses)
730  * will also get its reference count incremented.
731  *
732  * cifs_put_smb_ses() will put both references, so call it when you're done.
733  */
734 static inline void cifs_smb_ses_inc_refcount(struct cifs_ses *ses)
735 {
736         lockdep_assert_held(&cifs_tcp_ses_lock);
737
738         ses->ses_count++;
739         if (ses->dfs_root_ses)
740                 ses->dfs_root_ses->ses_count++;
741 }
742
743 static inline bool dfs_src_pathname_equal(const char *s1, const char *s2)
744 {
745         if (strlen(s1) != strlen(s2))
746                 return false;
747         for (; *s1; s1++, s2++) {
748                 if (*s1 == '/' || *s1 == '\\') {
749                         if (*s2 != '/' && *s2 != '\\')
750                                 return false;
751                 } else if (tolower(*s1) != tolower(*s2))
752                         return false;
753         }
754         return true;
755 }
756
757 static inline void release_mid(struct mid_q_entry *mid)
758 {
759         kref_put(&mid->refcount, __release_mid);
760 }
761
762 #endif                  /* _CIFSPROTO_H */