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