cifs: add server param
[linux-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
SF
57extern int smb2_calc_signature(struct smb_rqst *rqst,
58 struct TCP_Server_Info *server);
59extern int smb3_calc_signature(struct smb_rqst *rqst,
60 struct TCP_Server_Info *server);
c95b8eed 61extern void smb2_echo_request(struct work_struct *work);
0822f514 62extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
983c88a4
PS
63extern bool smb2_is_valid_oplock_break(char *buffer,
64 struct TCP_Server_Info *srv);
026e93dc
PS
65extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
66 __u64 ses_id);
4326ed2f
PS
67extern int smb3_handle_read_data(struct TCP_Server_Info *server,
68 struct mid_q_entry *mid);
2dc7e1c0 69
3d4ef9a1
SF
70extern int open_shroot(unsigned int xid, struct cifs_tcon *tcon,
71 struct cifs_fid *pfid);
9da6ec77 72extern void close_shroot(struct cached_fid *cfid);
f0df737e
PS
73extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
74 struct smb2_file_all_info *src);
be4cb9e3
PS
75extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
76 struct cifs_sb_info *cifs_sb,
77 const char *full_path, FILE_ALL_INFO *data,
eb85d94b 78 bool *adjust_tz, bool *symlink);
c839ff24
PS
79extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
80 const char *full_path, __u64 size,
81 struct cifs_sb_info *cifs_sb, bool set_alloc);
1feeaac7
PS
82extern int smb2_set_file_info(struct inode *inode, const char *full_path,
83 FILE_BASIC_INFO *buf, const unsigned int xid);
bea851b8
SF
84extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode,
85 umode_t mode, struct cifs_tcon *tcon,
86 const char *full_path,
87 struct cifs_sb_info *cifs_sb);
c3ca78e2
SF
88extern int smb2_mkdir(const unsigned int xid, struct inode *inode,
89 umode_t mode, struct cifs_tcon *tcon,
a0e73183
PS
90 const char *name, struct cifs_sb_info *cifs_sb);
91extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
92 struct cifs_sb_info *cifs_sb,
93 struct cifs_tcon *tcon, const unsigned int xid);
1a500f01
PS
94extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
95 const char *name, struct cifs_sb_info *cifs_sb);
cbe6f439
PS
96extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
97 const char *name, struct cifs_sb_info *cifs_sb);
35143eb5
PS
98extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
99 const char *from_name, const char *to_name,
100 struct cifs_sb_info *cifs_sb);
568798cc
PS
101extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
102 const char *from_name, const char *to_name,
103 struct cifs_sb_info *cifs_sb);
5ab97578
SF
104extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
105 struct cifs_sb_info *cifs_sb, const unsigned char *path,
106 char *pbuf, unsigned int *pbytes_written);
c22870ea
SF
107extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
108 struct cifs_sb_info *cifs_sb,
109 const unsigned char *path, char *pbuf,
110 unsigned int *pbytes_read);
226730b4
PS
111extern int smb2_open_file(const unsigned int xid,
112 struct cifs_open_parms *oparms,
113 __u32 *oplock, FILE_ALL_INFO *buf);
f7ba7fe6
PS
114extern int smb2_unlock_range(struct cifsFileInfo *cfile,
115 struct file_lock *flock, const unsigned int xid);
b140799a 116extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
53e0e11e 117extern void smb2_reconnect_server(struct work_struct *work);
026e93dc 118extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
81f39f95
RS
119extern unsigned long smb_rqst_len(struct TCP_Server_Info *server,
120 struct smb_rqst *rqst);
e77fe73c
RS
121extern void smb2_set_next_command(struct cifs_tcon *tcon,
122 struct smb_rqst *rqst);
c5a5f38f 123extern void smb2_set_related(struct smb_rqst *rqst);
f0df737e 124
ec2e4523
PS
125/*
126 * SMB2 Worker functions - most of protocol specific implementation details
127 * are contained within these calls.
128 */
129extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
5478f9ba
PS
130extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
131 const struct nls_table *nls_cp);
132extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
faaf946a
PS
133extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
134 const char *tree, struct cifs_tcon *tcon,
135 const struct nls_table *);
136extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
064f6047
PS
137extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
138 __le16 *path, __u8 *oplock,
b42bf888 139 struct smb2_file_all_info *buf,
9d874c36 140 struct kvec *err_iov, int *resp_buftype);
1eb9fb52
RS
141extern int SMB2_open_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
142 __u8 *oplock, struct cifs_open_parms *oparms,
143 __le16 *path);
144extern void SMB2_open_free(struct smb_rqst *rqst);
4a72dafa
SF
145extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
146 u64 persistent_fid, u64 volatile_fid, u32 opcode,
153322f7 147 bool is_fsctl, char *in_data, u32 indatalen, u32 maxoutlen,
4a72dafa 148 char **out_data, u32 *plen /* returned data len */);
ccdc77a3
RS
149extern int SMB2_ioctl_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
150 u64 persistent_fid, u64 volatile_fid, u32 opcode,
153322f7
SF
151 bool is_fsctl, char *in_data, u32 indatalen,
152 __u32 max_response_size);
ccdc77a3 153extern void SMB2_ioctl_free(struct smb_rqst *rqst);
52870d50
SF
154extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon,
155 u64 persistent_fid, u64 volatile_fid, bool watch_tree,
156 u32 completion_filter);
157
2503a0db
PS
158extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
159 u64 persistent_file_id, u64 volatile_file_id);
97ca1762
RS
160extern int SMB2_close_flags(const unsigned int xid, struct cifs_tcon *tcon,
161 u64 persistent_fid, u64 volatile_fid, int flags);
8eb4ecfa
RS
162extern int SMB2_close_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
163 u64 persistent_file_id, u64 volatile_file_id);
164extern void SMB2_close_free(struct smb_rqst *rqst);
7a5cfb19
PS
165extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
166 u64 persistent_file_id, u64 volatile_file_id);
86e14e12
RS
167extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst,
168 struct cifs_tcon *tcon,
169 u64 persistent_file_id, u64 volatile_file_id);
170extern void SMB2_flush_free(struct smb_rqst *rqst);
be4cb9e3
PS
171extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
172 u64 persistent_file_id, u64 volatile_file_id,
173 struct smb2_file_all_info *data);
296ecbae
RS
174extern int SMB2_query_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
175 u64 persistent_fid, u64 volatile_fid,
176 u8 info_class, u8 info_type,
f5b05d62
RS
177 u32 additional_info, size_t output_len,
178 size_t input_len, void *input);
296ecbae 179extern void SMB2_query_info_free(struct smb_rqst *rqst);
42c493c1
SP
180extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
181 u64 persistent_file_id, u64 volatile_file_id,
182 void **data, unsigned int *plen);
f0df737e
PS
183extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
184 u64 persistent_fid, u64 volatile_fid,
185 __le64 *uniqueid);
09a4707e 186extern int smb2_async_readv(struct cifs_readdata *rdata);
d8e05039
PS
187extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
188 unsigned int *nbytes, char **buf, int *buf_type);
4a5c80d7
SF
189extern int smb2_async_writev(struct cifs_writedata *wdata,
190 void (*release)(struct kref *kref));
009d3443
PS
191extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
192 unsigned int *nbytes, struct kvec *iov, int n_vec);
9094fad1 193extern int SMB2_echo(struct TCP_Server_Info *server);
d324f08d
PS
194extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
195 u64 persistent_fid, u64 volatile_fid, int index,
196 struct cifs_search_info *srch_inf);
c839ff24
PS
197extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
198 u64 persistent_fid, u64 volatile_fid, u32 pid,
3764cbd1 199 __le64 *eof);
ba8ca116
RS
200extern int SMB2_set_info_init(struct cifs_tcon *tcon, struct smb_rqst *rqst,
201 u64 persistent_fid, u64 volatile_fid, u32 pid,
202 u8 info_class, u8 info_type, u32 additional_info,
203 void **data, unsigned int *size);
204extern void SMB2_set_info_free(struct smb_rqst *rqst);
dac95340
SP
205extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
206 u64 persistent_fid, u64 volatile_fid,
207 struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
5517554e
RS
208extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
209 u64 persistent_fid, u64 volatile_fid,
210 struct smb2_file_full_ea_info *buf, int len);
64a5cfa6
SF
211extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
212 u64 persistent_fid, u64 volatile_fid);
983c88a4
PS
213extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
214 const u64 persistent_fid, const u64 volatile_fid,
215 const __u8 oplock_level);
9150c3ad
PS
216extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon,
217 __u64 persistent_fid,
218 __u64 volatile_fid);
38bd4906
SP
219extern int smb2_handle_cancelled_mid(char *buffer,
220 struct TCP_Server_Info *server);
221void smb2_cancelled_close_fid(struct work_struct *work);
6fc05c25
PS
222extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
223 u64 persistent_file_id, u64 volatile_file_id,
224 struct kstatfs *FSData);
2d304217
SF
225extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon,
226 u64 persistent_file_id, u64 volatile_file_id,
227 struct kstatfs *FSData);
34f62640 228extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
2167114c 229 u64 persistent_file_id, u64 volatile_file_id, int lvl);
f7ba7fe6
PS
230extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
231 const __u64 persist_fid, const __u64 volatile_fid,
232 const __u32 pid, const __u64 length, const __u64 offset,
233 const __u32 lockFlags, const bool wait);
234extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
235 const __u64 persist_fid, const __u64 volatile_fid,
236 const __u32 pid, const __u32 num_lock,
237 struct smb2_lock_element *buf);
0822f514
PS
238extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
239 __u8 *lease_key, const __le32 lease_state);
ff1c038a 240extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
ec2e4523 241
ef65aaed
SP
242extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
243 enum securityEnum);
89a5bfa3
SF
244extern void smb2_parse_contexts(struct TCP_Server_Info *server,
245 struct smb2_create_rsp *rsp,
246 unsigned int *epoch, char *lease_key,
247 __u8 *oplock, struct smb2_file_all_info *buf);
730928c8
RS
248extern int smb3_encryption_required(const struct cifs_tcon *tcon);
249extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length,
250 struct kvec *iov, unsigned int min_buf_size);
c5a5f38f
RS
251extern int smb2_validate_and_copy_iov(unsigned int offset,
252 unsigned int buffer_length,
253 struct kvec *iov,
254 unsigned int minbufsize, char *data);
730928c8
RS
255extern void smb2_copy_fs_info_to_kstatfs(
256 struct smb2_fs_full_size_info *pfs_inf,
257 struct kstatfs *kst);
5fcd7f3f 258extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server);
8bd68c6e
AA
259extern int smb311_update_preauth_hash(struct cifs_ses *ses,
260 struct kvec *iov, int nvec);
f9793b6f
RS
261extern int smb2_query_info_compound(const unsigned int xid,
262 struct cifs_tcon *tcon,
263 __le16 *utf16_path, u32 desired_access,
264 u32 class, u32 type, u32 output_len,
265 struct kvec *rsp, int *buftype,
266 struct cifs_sb_info *cifs_sb);
ddfbefbd 267#endif /* _SMB2PROTO_H */