]> git.ipfire.org Git - thirdparty/linux.git/blame - fs/cifs/smb2proto.h
Merge tag 'pm-5.8-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm
[thirdparty/linux.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,
0f060936 73 struct cifs_sb_info *cifs_sb, struct cifs_fid *pfid);
9da6ec77 74extern void close_shroot(struct cached_fid *cfid);
d9191319
PS
75extern void close_shroot_lease(struct cached_fid *cfid);
76extern void close_shroot_lease_locked(struct cached_fid *cfid);
f0df737e
PS
77extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
78 struct smb2_file_all_info *src);
be4cb9e3
PS
79extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
80 struct cifs_sb_info *cifs_sb,
81 const char *full_path, FILE_ALL_INFO *data,
eb85d94b 82 bool *adjust_tz, bool *symlink);
c839ff24
PS
83extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
84 const char *full_path, __u64 size,
85 struct cifs_sb_info *cifs_sb, bool set_alloc);
1feeaac7
PS
86extern int smb2_set_file_info(struct inode *inode, const char *full_path,
87 FILE_BASIC_INFO *buf, const unsigned int xid);
bea851b8
SF
88extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode,
89 umode_t mode, struct cifs_tcon *tcon,
90 const char *full_path,
91 struct cifs_sb_info *cifs_sb);
c3ca78e2
SF
92extern int smb2_mkdir(const unsigned int xid, struct inode *inode,
93 umode_t mode, struct cifs_tcon *tcon,
a0e73183
PS
94 const char *name, struct cifs_sb_info *cifs_sb);
95extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
96 struct cifs_sb_info *cifs_sb,
97 struct cifs_tcon *tcon, const unsigned int xid);
1a500f01
PS
98extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
99 const char *name, struct cifs_sb_info *cifs_sb);
cbe6f439
PS
100extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
101 const char *name, struct cifs_sb_info *cifs_sb);
35143eb5
PS
102extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
103 const char *from_name, const char *to_name,
104 struct cifs_sb_info *cifs_sb);
568798cc
PS
105extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
106 const char *from_name, const char *to_name,
107 struct cifs_sb_info *cifs_sb);
5ab97578
SF
108extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
109 struct cifs_sb_info *cifs_sb, const unsigned char *path,
110 char *pbuf, unsigned int *pbytes_written);
c22870ea
SF
111extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
112 struct cifs_sb_info *cifs_sb,
113 const unsigned char *path, char *pbuf,
114 unsigned int *pbytes_read);
226730b4
PS
115extern int smb2_open_file(const unsigned int xid,
116 struct cifs_open_parms *oparms,
117 __u32 *oplock, FILE_ALL_INFO *buf);
f7ba7fe6
PS
118extern int smb2_unlock_range(struct cifsFileInfo *cfile,
119 struct file_lock *flock, const unsigned int xid);
b140799a 120extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
53e0e11e 121extern void smb2_reconnect_server(struct work_struct *work);
026e93dc 122extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
81f39f95
RS
123extern unsigned long smb_rqst_len(struct TCP_Server_Info *server,
124 struct smb_rqst *rqst);
e77fe73c
RS
125extern void smb2_set_next_command(struct cifs_tcon *tcon,
126 struct smb_rqst *rqst);
c5a5f38f 127extern void smb2_set_related(struct smb_rqst *rqst);
f0df737e 128
ec2e4523
PS
129/*
130 * SMB2 Worker functions - most of protocol specific implementation details
131 * are contained within these calls.
132 */
133extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
5478f9ba
PS
134extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
135 const struct nls_table *nls_cp);
136extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
faaf946a
PS
137extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
138 const char *tree, struct cifs_tcon *tcon,
139 const struct nls_table *);
140extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
064f6047
PS
141extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
142 __le16 *path, __u8 *oplock,
b42bf888 143 struct smb2_file_all_info *buf,
69dda305 144 struct create_posix_rsp *posix,
9d874c36 145 struct kvec *err_iov, int *resp_buftype);
1eb9fb52
RS
146extern int SMB2_open_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
147 __u8 *oplock, struct cifs_open_parms *oparms,
148 __le16 *path);
149extern void SMB2_open_free(struct smb_rqst *rqst);
4a72dafa
SF
150extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
151 u64 persistent_fid, u64 volatile_fid, u32 opcode,
153322f7 152 bool is_fsctl, char *in_data, u32 indatalen, u32 maxoutlen,
4a72dafa 153 char **out_data, u32 *plen /* returned data len */);
ccdc77a3
RS
154extern int SMB2_ioctl_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
155 u64 persistent_fid, u64 volatile_fid, u32 opcode,
153322f7
SF
156 bool is_fsctl, char *in_data, u32 indatalen,
157 __u32 max_response_size);
ccdc77a3 158extern void SMB2_ioctl_free(struct smb_rqst *rqst);
52870d50
SF
159extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon,
160 u64 persistent_fid, u64 volatile_fid, bool watch_tree,
161 u32 completion_filter);
162
43f8a6a7
SF
163extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
164 u64 persistent_fid, u64 volatile_fid,
165 struct smb2_file_network_open_info *pbuf);
2503a0db
PS
166extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
167 u64 persistent_file_id, u64 volatile_file_id);
8eb4ecfa 168extern int SMB2_close_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
43f8a6a7 169 u64 persistent_fid, u64 volatile_fid, bool query_attrs);
8eb4ecfa 170extern void SMB2_close_free(struct smb_rqst *rqst);
7a5cfb19
PS
171extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
172 u64 persistent_file_id, u64 volatile_file_id);
86e14e12
RS
173extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst,
174 struct cifs_tcon *tcon,
175 u64 persistent_file_id, u64 volatile_file_id);
176extern void SMB2_flush_free(struct smb_rqst *rqst);
be4cb9e3
PS
177extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
178 u64 persistent_file_id, u64 volatile_file_id,
179 struct smb2_file_all_info *data);
296ecbae
RS
180extern int SMB2_query_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
181 u64 persistent_fid, u64 volatile_fid,
182 u8 info_class, u8 info_type,
f5b05d62
RS
183 u32 additional_info, size_t output_len,
184 size_t input_len, void *input);
296ecbae 185extern void SMB2_query_info_free(struct smb_rqst *rqst);
42c493c1
SP
186extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
187 u64 persistent_file_id, u64 volatile_file_id,
188 void **data, unsigned int *plen);
f0df737e
PS
189extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
190 u64 persistent_fid, u64 volatile_fid,
191 __le64 *uniqueid);
09a4707e 192extern int smb2_async_readv(struct cifs_readdata *rdata);
d8e05039
PS
193extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
194 unsigned int *nbytes, char **buf, int *buf_type);
4a5c80d7
SF
195extern int smb2_async_writev(struct cifs_writedata *wdata,
196 void (*release)(struct kref *kref));
009d3443
PS
197extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
198 unsigned int *nbytes, struct kvec *iov, int n_vec);
9094fad1 199extern int SMB2_echo(struct TCP_Server_Info *server);
d324f08d
PS
200extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
201 u64 persistent_fid, u64 volatile_fid, int index,
202 struct cifs_search_info *srch_inf);
0a17799c
RS
203extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon,
204 struct smb_rqst *rqst,
205 u64 persistent_fid, u64 volatile_fid,
206 int index, int info_level);
207extern void SMB2_query_directory_free(struct smb_rqst *rqst);
c839ff24
PS
208extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
209 u64 persistent_fid, u64 volatile_fid, u32 pid,
3764cbd1 210 __le64 *eof);
ba8ca116
RS
211extern int SMB2_set_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
212 u64 persistent_fid, u64 volatile_fid, u32 pid,
213 u8 info_class, u8 info_type, u32 additional_info,
214 void **data, unsigned int *size);
215extern void SMB2_set_info_free(struct smb_rqst *rqst);
dac95340
SP
216extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
217 u64 persistent_fid, u64 volatile_fid,
218 struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
5517554e
RS
219extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
220 u64 persistent_fid, u64 volatile_fid,
221 struct smb2_file_full_ea_info *buf, int len);
64a5cfa6
SF
222extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
223 u64 persistent_fid, u64 volatile_fid);
983c88a4
PS
224extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
225 const u64 persistent_fid, const u64 volatile_fid,
226 const __u8 oplock_level);
9150c3ad
PS
227extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon,
228 __u64 persistent_fid,
229 __u64 volatile_fid);
38bd4906
SP
230extern int smb2_handle_cancelled_mid(char *buffer,
231 struct TCP_Server_Info *server);
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
AA
271extern int smb311_update_preauth_hash(struct cifs_ses *ses,
272 struct kvec *iov, int nvec);
f9793b6f
RS
273extern int smb2_query_info_compound(const unsigned int xid,
274 struct cifs_tcon *tcon,
275 __le16 *utf16_path, u32 desired_access,
276 u32 class, u32 type, u32 output_len,
277 struct kvec *rsp, int *buftype,
278 struct cifs_sb_info *cifs_sb);
349e13ad
AA
279int posix_info_parse(const void *beg, const void *end,
280 struct smb2_posix_info_parsed *out);
69dda305 281int posix_info_sid_size(const void *beg, const void *end);
ddfbefbd 282#endif /* _SMB2PROTO_H */