Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc
[linux] / fs / cifs / smb2proto.h
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
28 struct statfs;
29 struct smb_rqst;
30
31 /*
32  *****************************************************************
33  * All Prototypes
34  *****************************************************************
35  */
36 extern int map_smb2_to_linux_error(char *buf, bool log_err);
37 extern int smb2_check_message(char *buf, unsigned int length,
38                               struct TCP_Server_Info *server);
39 extern unsigned int smb2_calc_size(void *buf, struct TCP_Server_Info *server);
40 extern char *smb2_get_data_area_len(int *off, int *len,
41                                     struct smb2_sync_hdr *shdr);
42 extern __le16 *cifs_convert_path_to_utf16(const char *from,
43                                           struct cifs_sb_info *cifs_sb);
44
45 extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
46 extern int smb2_check_receive(struct mid_q_entry *mid,
47                               struct TCP_Server_Info *server, bool log_error);
48 extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
49                               struct smb_rqst *rqst);
50 extern struct mid_q_entry *smb2_setup_async_request(
51                         struct TCP_Server_Info *server, struct smb_rqst *rqst);
52 extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
53                                            __u64 ses_id);
54 extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
55                                                 __u64 ses_id, __u32  tid);
56 extern int smb2_calc_signature(struct smb_rqst *rqst,
57                                 struct TCP_Server_Info *server);
58 extern int smb3_calc_signature(struct smb_rqst *rqst,
59                                 struct TCP_Server_Info *server);
60 extern void smb2_echo_request(struct work_struct *work);
61 extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
62 extern bool smb2_is_valid_oplock_break(char *buffer,
63                                        struct TCP_Server_Info *srv);
64 extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
65                                           __u64 ses_id);
66 extern int smb3_handle_read_data(struct TCP_Server_Info *server,
67                                  struct mid_q_entry *mid);
68
69 extern int open_shroot(unsigned int xid, struct cifs_tcon *tcon,
70                         struct cifs_fid *pfid);
71 extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
72                                    struct smb2_file_all_info *src);
73 extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
74                                 struct cifs_sb_info *cifs_sb,
75                                 const char *full_path, FILE_ALL_INFO *data,
76                                 bool *adjust_tz, bool *symlink);
77 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
78                               const char *full_path, __u64 size,
79                               struct cifs_sb_info *cifs_sb, bool set_alloc);
80 extern int smb2_set_file_info(struct inode *inode, const char *full_path,
81                               FILE_BASIC_INFO *buf, const unsigned int xid);
82 extern int smb2_mkdir(const unsigned int xid, struct cifs_tcon *tcon,
83                       const char *name, struct cifs_sb_info *cifs_sb);
84 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
85                                struct cifs_sb_info *cifs_sb,
86                                struct cifs_tcon *tcon, const unsigned int xid);
87 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
88                       const char *name, struct cifs_sb_info *cifs_sb);
89 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
90                        const char *name, struct cifs_sb_info *cifs_sb);
91 extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
92                             const char *from_name, const char *to_name,
93                             struct cifs_sb_info *cifs_sb);
94 extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
95                                 const char *from_name, const char *to_name,
96                                 struct cifs_sb_info *cifs_sb);
97 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
98                         struct cifs_sb_info *cifs_sb, const unsigned char *path,
99                         char *pbuf, unsigned int *pbytes_written);
100 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
101                           struct cifs_sb_info *cifs_sb,
102                           const unsigned char *path, char *pbuf,
103                           unsigned int *pbytes_read);
104 extern int smb2_open_file(const unsigned int xid,
105                           struct cifs_open_parms *oparms,
106                           __u32 *oplock, FILE_ALL_INFO *buf);
107 extern int smb2_unlock_range(struct cifsFileInfo *cfile,
108                              struct file_lock *flock, const unsigned int xid);
109 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
110 extern void smb2_reconnect_server(struct work_struct *work);
111 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
112
113 /*
114  * SMB2 Worker functions - most of protocol specific implementation details
115  * are contained within these calls.
116  */
117 extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
118 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
119                            const struct nls_table *nls_cp);
120 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
121 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
122                      const char *tree, struct cifs_tcon *tcon,
123                      const struct nls_table *);
124 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
125 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
126                      __le16 *path, __u8 *oplock,
127                      struct smb2_file_all_info *buf,
128                      struct kvec *err_iov);
129 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
130                      u64 persistent_fid, u64 volatile_fid, u32 opcode,
131                      bool is_fsctl, char *in_data, u32 indatalen,
132                      char **out_data, u32 *plen /* returned data len */);
133 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
134                       u64 persistent_file_id, u64 volatile_file_id);
135 extern int SMB2_close_flags(const unsigned int xid, struct cifs_tcon *tcon,
136                             u64 persistent_fid, u64 volatile_fid, int flags);
137 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
138                       u64 persistent_file_id, u64 volatile_file_id);
139 extern int SMB2_query_eas(const unsigned int xid, struct cifs_tcon *tcon,
140                           u64 persistent_file_id, u64 volatile_file_id,
141                           int ea_buf_size,
142                           struct smb2_file_full_ea_info *data);
143 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
144                            u64 persistent_file_id, u64 volatile_file_id,
145                            struct smb2_file_all_info *data);
146 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
147                            u64 persistent_file_id, u64 volatile_file_id,
148                            void **data, unsigned int *plen);
149 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
150                             u64 persistent_fid, u64 volatile_fid,
151                             __le64 *uniqueid);
152 extern int smb2_async_readv(struct cifs_readdata *rdata);
153 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
154                      unsigned int *nbytes, char **buf, int *buf_type);
155 extern int smb2_async_writev(struct cifs_writedata *wdata,
156                              void (*release)(struct kref *kref));
157 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
158                       unsigned int *nbytes, struct kvec *iov, int n_vec);
159 extern int SMB2_echo(struct TCP_Server_Info *server);
160 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
161                                 u64 persistent_fid, u64 volatile_fid, int index,
162                                 struct cifs_search_info *srch_inf);
163 extern int SMB2_rename(const unsigned int xid, struct cifs_tcon *tcon,
164                        u64 persistent_fid, u64 volatile_fid,
165                        __le16 *target_file);
166 extern int SMB2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
167                       u64 persistent_fid, u64 volatile_fid);
168 extern int SMB2_set_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
169                              u64 persistent_fid, u64 volatile_fid,
170                              __le16 *target_file);
171 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
172                         u64 persistent_fid, u64 volatile_fid, u32 pid,
173                         __le64 *eof, bool is_fallocate);
174 extern int SMB2_set_info(const unsigned int xid, struct cifs_tcon *tcon,
175                          u64 persistent_fid, u64 volatile_fid,
176                          FILE_BASIC_INFO *buf);
177 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
178                         u64 persistent_fid, u64 volatile_fid,
179                         struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
180 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
181                        u64 persistent_fid, u64 volatile_fid,
182                        struct smb2_file_full_ea_info *buf, int len);
183 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
184                                 u64 persistent_fid, u64 volatile_fid);
185 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
186                              const u64 persistent_fid, const u64 volatile_fid,
187                              const __u8 oplock_level);
188 extern int smb2_handle_cancelled_mid(char *buffer,
189                                         struct TCP_Server_Info *server);
190 void smb2_cancelled_close_fid(struct work_struct *work);
191 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
192                          u64 persistent_file_id, u64 volatile_file_id,
193                          struct kstatfs *FSData);
194 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
195                          u64 persistent_file_id, u64 volatile_file_id, int lvl);
196 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
197                      const __u64 persist_fid, const __u64 volatile_fid,
198                      const __u32 pid, const __u64 length, const __u64 offset,
199                      const __u32 lockFlags, const bool wait);
200 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
201                       const __u64 persist_fid, const __u64 volatile_fid,
202                       const __u32 pid, const __u32 num_lock,
203                       struct smb2_lock_element *buf);
204 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
205                             __u8 *lease_key, const __le32 lease_state);
206 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
207
208 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
209                                         enum securityEnum);
210 #ifdef CONFIG_CIFS_SMB311
211 extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server);
212 extern int smb311_update_preauth_hash(struct cifs_ses *ses,
213                                       struct kvec *iov, int nvec);
214 #endif
215 #endif                  /* _SMB2PROTO_H */