]> git.ipfire.org Git - people/ms/linux.git/blame - fs/cifs/smb2proto.h
Merge branch 'for-6.0/dax' into libnvdimm-fixes
[people/ms/linux.git] / fs / cifs / smb2proto.h
CommitLineData
929be906 1/* SPDX-License-Identifier: LGPL-2.1 */
ddfbefbd 2/*
ddfbefbd
SF
3 *
4 * Copyright (c) International Business Machines Corp., 2002, 2011
5 * Etersoft, 2012
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
8 *
ddfbefbd
SF
9 */
10#ifndef _SMB2PROTO_H
11#define _SMB2PROTO_H
12#include <linux/nls.h>
13#include <linux/key-type.h>
14
15struct statfs;
0b688cfc 16struct smb_rqst;
ddfbefbd
SF
17
18/*
19 *****************************************************************
20 * All Prototypes
21 *****************************************************************
22 */
23extern int map_smb2_to_linux_error(char *buf, bool log_err);
373512ec
SF
24extern int smb2_check_message(char *buf, unsigned int length,
25 struct TCP_Server_Info *server);
68ed1449 26extern unsigned int smb2_calc_size(void *buf);
e4dc31fe 27extern char *smb2_get_data_area_len(int *off, int *len,
0d35e382 28 struct smb2_hdr *shdr);
2503a0db
PS
29extern __le16 *cifs_convert_path_to_utf16(const char *from,
30 struct cifs_sb_info *cifs_sb);
ddfbefbd 31
0b688cfc 32extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
2dc7e1c0
PS
33extern int smb2_check_receive(struct mid_q_entry *mid,
34 struct TCP_Server_Info *server, bool log_error);
fec344e3 35extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
f780bd3f
AA
36 struct TCP_Server_Info *,
37 struct smb_rqst *rqst);
fec344e3
JL
38extern struct mid_q_entry *smb2_setup_async_request(
39 struct TCP_Server_Info *server, struct smb_rqst *rqst);
38bd4906
SP
40extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
41 __u64 ses_id);
42extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
43 __u64 ses_id, __u32 tid);
38107d45 44extern int smb2_calc_signature(struct smb_rqst *rqst,
eda1c54f
LL
45 struct TCP_Server_Info *server,
46 bool allocate_crypto);
38107d45 47extern int smb3_calc_signature(struct smb_rqst *rqst,
eda1c54f
LL
48 struct TCP_Server_Info *server,
49 bool allocate_crypto);
c95b8eed 50extern void smb2_echo_request(struct work_struct *work);
0822f514 51extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
983c88a4
PS
52extern bool smb2_is_valid_oplock_break(char *buffer,
53 struct TCP_Server_Info *srv);
4326ed2f
PS
54extern int smb3_handle_read_data(struct TCP_Server_Info *server,
55 struct mid_q_entry *mid);
2dc7e1c0 56
f0df737e
PS
57extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
58 struct smb2_file_all_info *src);
2e4564b3
SF
59extern int smb2_query_reparse_tag(const unsigned int xid, struct cifs_tcon *tcon,
60 struct cifs_sb_info *cifs_sb, const char *path,
61 __u32 *reparse_tag);
be4cb9e3
PS
62extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
63 struct cifs_sb_info *cifs_sb,
64 const char *full_path, FILE_ALL_INFO *data,
eb85d94b 65 bool *adjust_tz, bool *symlink);
c839ff24
PS
66extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
67 const char *full_path, __u64 size,
68 struct cifs_sb_info *cifs_sb, bool set_alloc);
1feeaac7
PS
69extern int smb2_set_file_info(struct inode *inode, const char *full_path,
70 FILE_BASIC_INFO *buf, const unsigned int xid);
bea851b8
SF
71extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode,
72 umode_t mode, struct cifs_tcon *tcon,
73 const char *full_path,
74 struct cifs_sb_info *cifs_sb);
c3ca78e2
SF
75extern int smb2_mkdir(const unsigned int xid, struct inode *inode,
76 umode_t mode, struct cifs_tcon *tcon,
a0e73183
PS
77 const char *name, struct cifs_sb_info *cifs_sb);
78extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
79 struct cifs_sb_info *cifs_sb,
80 struct cifs_tcon *tcon, const unsigned int xid);
1a500f01
PS
81extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
82 const char *name, struct cifs_sb_info *cifs_sb);
cbe6f439
PS
83extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
84 const char *name, struct cifs_sb_info *cifs_sb);
35143eb5
PS
85extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
86 const char *from_name, const char *to_name,
87 struct cifs_sb_info *cifs_sb);
568798cc
PS
88extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
89 const char *from_name, const char *to_name,
90 struct cifs_sb_info *cifs_sb);
5ab97578
SF
91extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
92 struct cifs_sb_info *cifs_sb, const unsigned char *path,
93 char *pbuf, unsigned int *pbytes_written);
c22870ea
SF
94extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
95 struct cifs_sb_info *cifs_sb,
96 const unsigned char *path, char *pbuf,
97 unsigned int *pbytes_read);
226730b4
PS
98extern int smb2_open_file(const unsigned int xid,
99 struct cifs_open_parms *oparms,
100 __u32 *oplock, FILE_ALL_INFO *buf);
f7ba7fe6
PS
101extern int smb2_unlock_range(struct cifsFileInfo *cfile,
102 struct file_lock *flock, const unsigned int xid);
b140799a 103extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
53e0e11e 104extern void smb2_reconnect_server(struct work_struct *work);
026e93dc 105extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
81f39f95
RS
106extern unsigned long smb_rqst_len(struct TCP_Server_Info *server,
107 struct smb_rqst *rqst);
e77fe73c
RS
108extern void smb2_set_next_command(struct cifs_tcon *tcon,
109 struct smb_rqst *rqst);
c5a5f38f 110extern void smb2_set_related(struct smb_rqst *rqst);
f0df737e 111
ec2e4523
PS
112/*
113 * SMB2 Worker functions - most of protocol specific implementation details
114 * are contained within these calls.
115 */
f486ef8e
SP
116extern int SMB2_negotiate(const unsigned int xid,
117 struct cifs_ses *ses,
118 struct TCP_Server_Info *server);
5478f9ba 119extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
f486ef8e 120 struct TCP_Server_Info *server,
5478f9ba
PS
121 const struct nls_table *nls_cp);
122extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
faaf946a
PS
123extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
124 const char *tree, struct cifs_tcon *tcon,
125 const struct nls_table *);
126extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
064f6047
PS
127extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
128 __le16 *path, __u8 *oplock,
b42bf888 129 struct smb2_file_all_info *buf,
69dda305 130 struct create_posix_rsp *posix,
9d874c36 131 struct kvec *err_iov, int *resp_buftype);
352d96f3
AA
132extern int SMB2_open_init(struct cifs_tcon *tcon,
133 struct TCP_Server_Info *server,
134 struct smb_rqst *rqst,
1eb9fb52
RS
135 __u8 *oplock, struct cifs_open_parms *oparms,
136 __le16 *path);
137extern void SMB2_open_free(struct smb_rqst *rqst);
4a72dafa
SF
138extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
139 u64 persistent_fid, u64 volatile_fid, u32 opcode,
400d0ad6 140 char *in_data, u32 indatalen, u32 maxoutlen,
4a72dafa 141 char **out_data, u32 *plen /* returned data len */);
352d96f3
AA
142extern int SMB2_ioctl_init(struct cifs_tcon *tcon,
143 struct TCP_Server_Info *server,
144 struct smb_rqst *rqst,
ccdc77a3 145 u64 persistent_fid, u64 volatile_fid, u32 opcode,
400d0ad6 146 char *in_data, u32 indatalen,
153322f7 147 __u32 max_response_size);
ccdc77a3 148extern void SMB2_ioctl_free(struct smb_rqst *rqst);
52870d50
SF
149extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon,
150 u64 persistent_fid, u64 volatile_fid, bool watch_tree,
151 u32 completion_filter);
152
43f8a6a7
SF
153extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
154 u64 persistent_fid, u64 volatile_fid,
155 struct smb2_file_network_open_info *pbuf);
2503a0db
PS
156extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
157 u64 persistent_file_id, u64 volatile_file_id);
352d96f3
AA
158extern int SMB2_close_init(struct cifs_tcon *tcon,
159 struct TCP_Server_Info *server,
160 struct smb_rqst *rqst,
161 u64 persistent_fid, u64 volatile_fid,
162 bool query_attrs);
8eb4ecfa 163extern void SMB2_close_free(struct smb_rqst *rqst);
7a5cfb19
PS
164extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
165 u64 persistent_file_id, u64 volatile_file_id);
86e14e12
RS
166extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst,
167 struct cifs_tcon *tcon,
352d96f3 168 struct TCP_Server_Info *server,
86e14e12
RS
169 u64 persistent_file_id, u64 volatile_file_id);
170extern void SMB2_flush_free(struct smb_rqst *rqst);
b1bc1874
SF
171extern int SMB311_posix_query_info(const unsigned int xid, struct cifs_tcon *tcon,
172 u64 persistent_fid, u64 volatile_fid, struct smb311_posix_qinfo *data, u32 *plen);
be4cb9e3
PS
173extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
174 u64 persistent_file_id, u64 volatile_file_id,
175 struct smb2_file_all_info *data);
352d96f3
AA
176extern int SMB2_query_info_init(struct cifs_tcon *tcon,
177 struct TCP_Server_Info *server,
178 struct smb_rqst *rqst,
296ecbae
RS
179 u64 persistent_fid, u64 volatile_fid,
180 u8 info_class, u8 info_type,
f5b05d62
RS
181 u32 additional_info, size_t output_len,
182 size_t input_len, void *input);
296ecbae 183extern void SMB2_query_info_free(struct smb_rqst *rqst);
42c493c1 184extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
3970acf7
BP
185 u64 persistent_file_id, u64 volatile_file_id,
186 void **data, unsigned int *plen, u32 info);
f0df737e
PS
187extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
188 u64 persistent_fid, u64 volatile_fid,
189 __le64 *uniqueid);
09a4707e 190extern int smb2_async_readv(struct cifs_readdata *rdata);
d8e05039
PS
191extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
192 unsigned int *nbytes, char **buf, int *buf_type);
4a5c80d7
SF
193extern int smb2_async_writev(struct cifs_writedata *wdata,
194 void (*release)(struct kref *kref));
009d3443
PS
195extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
196 unsigned int *nbytes, struct kvec *iov, int n_vec);
9094fad1 197extern int SMB2_echo(struct TCP_Server_Info *server);
d324f08d
PS
198extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
199 u64 persistent_fid, u64 volatile_fid, int index,
200 struct cifs_search_info *srch_inf);
0a17799c 201extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon,
352d96f3 202 struct TCP_Server_Info *server,
0a17799c
RS
203 struct smb_rqst *rqst,
204 u64 persistent_fid, u64 volatile_fid,
205 int index, int info_level);
206extern void SMB2_query_directory_free(struct smb_rqst *rqst);
c839ff24
PS
207extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
208 u64 persistent_fid, u64 volatile_fid, u32 pid,
3764cbd1 209 __le64 *eof);
352d96f3
AA
210extern int SMB2_set_info_init(struct cifs_tcon *tcon,
211 struct TCP_Server_Info *server,
212 struct smb_rqst *rqst,
ba8ca116
RS
213 u64 persistent_fid, u64 volatile_fid, u32 pid,
214 u8 info_class, u8 info_type, u32 additional_info,
215 void **data, unsigned int *size);
216extern void SMB2_set_info_free(struct smb_rqst *rqst);
dac95340
SP
217extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
218 u64 persistent_fid, u64 volatile_fid,
219 struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
5517554e
RS
220extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
221 u64 persistent_fid, u64 volatile_fid,
222 struct smb2_file_full_ea_info *buf, int len);
64a5cfa6
SF
223extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
224 u64 persistent_fid, u64 volatile_fid);
983c88a4
PS
225extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
226 const u64 persistent_fid, const u64 volatile_fid,
227 const __u8 oplock_level);
9150c3ad
PS
228extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon,
229 __u64 persistent_fid,
230 __u64 volatile_fid);
04ad69c3 231extern int smb2_handle_cancelled_mid(struct mid_q_entry *mid, struct TCP_Server_Info *server);
38bd4906 232void smb2_cancelled_close_fid(struct work_struct *work);
6fc05c25
PS
233extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
234 u64 persistent_file_id, u64 volatile_file_id,
235 struct kstatfs *FSData);
2d304217
SF
236extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon,
237 u64 persistent_file_id, u64 volatile_file_id,
238 struct kstatfs *FSData);
34f62640 239extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
2167114c 240 u64 persistent_file_id, u64 volatile_file_id, int lvl);
f7ba7fe6
PS
241extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
242 const __u64 persist_fid, const __u64 volatile_fid,
243 const __u32 pid, const __u64 length, const __u64 offset,
244 const __u32 lockFlags, const bool wait);
245extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
246 const __u64 persist_fid, const __u64 volatile_fid,
247 const __u32 pid, const __u32 num_lock,
248 struct smb2_lock_element *buf);
0822f514
PS
249extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
250 __u8 *lease_key, const __le32 lease_state);
ff1c038a 251extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
ec2e4523 252
ef65aaed
SP
253extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
254 enum securityEnum);
89a5bfa3
SF
255extern void smb2_parse_contexts(struct TCP_Server_Info *server,
256 struct smb2_create_rsp *rsp,
257 unsigned int *epoch, char *lease_key,
69dda305
AA
258 __u8 *oplock, struct smb2_file_all_info *buf,
259 struct create_posix_rsp *posix);
730928c8
RS
260extern int smb3_encryption_required(const struct cifs_tcon *tcon);
261extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length,
262 struct kvec *iov, unsigned int min_buf_size);
c5a5f38f
RS
263extern int smb2_validate_and_copy_iov(unsigned int offset,
264 unsigned int buffer_length,
265 struct kvec *iov,
266 unsigned int minbufsize, char *data);
730928c8
RS
267extern void smb2_copy_fs_info_to_kstatfs(
268 struct smb2_fs_full_size_info *pfs_inf,
269 struct kstatfs *kst);
5fcd7f3f 270extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server);
8bd68c6e 271extern int smb311_update_preauth_hash(struct cifs_ses *ses,
f486ef8e 272 struct TCP_Server_Info *server,
8bd68c6e 273 struct kvec *iov, int nvec);
f9793b6f
RS
274extern int smb2_query_info_compound(const unsigned int xid,
275 struct cifs_tcon *tcon,
5e0c969e 276 const char *path, u32 desired_access,
f9793b6f
RS
277 u32 class, u32 type, u32 output_len,
278 struct kvec *rsp, int *buftype,
279 struct cifs_sb_info *cifs_sb);
6a5f6592
SF
280/* query path info from the server using SMB311 POSIX extensions*/
281extern int smb311_posix_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
282 struct cifs_sb_info *sb, const char *path, struct smb311_posix_qinfo *qinf,
283 bool *adjust_tx, bool *symlink);
349e13ad
AA
284int posix_info_parse(const void *beg, const void *end,
285 struct smb2_posix_info_parsed *out);
69dda305 286int posix_info_sid_size(const void *beg, const void *end);
ddfbefbd 287#endif /* _SMB2PROTO_H */