GNU Linux-libre 4.9.308-gnu1
[releases.git] / 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);
40 extern char *smb2_get_data_area_len(int *off, int *len, struct smb2_hdr *hdr);
41 extern __le16 *cifs_convert_path_to_utf16(const char *from,
42                                           struct cifs_sb_info *cifs_sb);
43
44 extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
45 extern int smb2_check_receive(struct mid_q_entry *mid,
46                               struct TCP_Server_Info *server, bool log_error);
47 extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
48                               struct smb_rqst *rqst);
49 extern struct mid_q_entry *smb2_setup_async_request(
50                         struct TCP_Server_Info *server, struct smb_rqst *rqst);
51 extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
52                                            __u64 ses_id);
53 extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
54                                                 __u64 ses_id, __u32  tid);
55 extern int smb2_calc_signature(struct smb_rqst *rqst,
56                                 struct TCP_Server_Info *server);
57 extern int smb3_calc_signature(struct smb_rqst *rqst,
58                                 struct TCP_Server_Info *server);
59 extern void smb2_echo_request(struct work_struct *work);
60 extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
61 extern bool smb2_is_valid_oplock_break(char *buffer,
62                                        struct TCP_Server_Info *srv);
63
64 extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
65                                    struct smb2_file_all_info *src);
66 extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
67                                 struct cifs_sb_info *cifs_sb,
68                                 const char *full_path, FILE_ALL_INFO *data,
69                                 bool *adjust_tz, bool *symlink);
70 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
71                               const char *full_path, __u64 size,
72                               struct cifs_sb_info *cifs_sb, bool set_alloc);
73 extern int smb2_set_file_info(struct inode *inode, const char *full_path,
74                               FILE_BASIC_INFO *buf, const unsigned int xid);
75 extern int smb2_mkdir(const unsigned int xid, struct cifs_tcon *tcon,
76                       const char *name, struct cifs_sb_info *cifs_sb);
77 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
78                                struct cifs_sb_info *cifs_sb,
79                                struct cifs_tcon *tcon, const unsigned int xid);
80 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
81                       const char *name, struct cifs_sb_info *cifs_sb);
82 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
83                        const char *name, struct cifs_sb_info *cifs_sb);
84 extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
85                             const char *from_name, const char *to_name,
86                             struct cifs_sb_info *cifs_sb);
87 extern int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
88                                 const char *from_name, const char *to_name,
89                                 struct cifs_sb_info *cifs_sb);
90 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
91                         struct cifs_sb_info *cifs_sb, const unsigned char *path,
92                         char *pbuf, unsigned int *pbytes_written);
93 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
94                           struct cifs_sb_info *cifs_sb,
95                           const unsigned char *path, char *pbuf,
96                           unsigned int *pbytes_read);
97 extern int smb2_open_file(const unsigned int xid,
98                           struct cifs_open_parms *oparms,
99                           __u32 *oplock, FILE_ALL_INFO *buf);
100 extern int smb2_unlock_range(struct cifsFileInfo *cfile,
101                              struct file_lock *flock, const unsigned int xid);
102 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
103 extern void smb2_reconnect_server(struct work_struct *work);
104
105 /*
106  * SMB2 Worker functions - most of protocol specific implementation details
107  * are contained within these calls.
108  */
109 extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
110 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
111                            const struct nls_table *nls_cp);
112 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
113 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
114                      const char *tree, struct cifs_tcon *tcon,
115                      const struct nls_table *);
116 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
117 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
118                      __le16 *path, __u8 *oplock,
119                      struct smb2_file_all_info *buf,
120                      struct smb2_err_rsp **err_buf);
121 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
122                      u64 persistent_fid, u64 volatile_fid, u32 opcode,
123                      bool is_fsctl, char *in_data, u32 indatalen,
124                      char **out_data, u32 *plen /* returned data len */);
125 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
126                       u64 persistent_file_id, u64 volatile_file_id);
127 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
128                       u64 persistent_file_id, u64 volatile_file_id);
129 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
130                            u64 persistent_file_id, u64 volatile_file_id,
131                            struct smb2_file_all_info *data);
132 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
133                             u64 persistent_fid, u64 volatile_fid,
134                             __le64 *uniqueid);
135 extern int smb2_async_readv(struct cifs_readdata *rdata);
136 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
137                      unsigned int *nbytes, char **buf, int *buf_type);
138 extern int smb2_async_writev(struct cifs_writedata *wdata,
139                              void (*release)(struct kref *kref));
140 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
141                       unsigned int *nbytes, struct kvec *iov, int n_vec);
142 extern int SMB2_echo(struct TCP_Server_Info *server);
143 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
144                                 u64 persistent_fid, u64 volatile_fid, int index,
145                                 struct cifs_search_info *srch_inf);
146 extern int SMB2_rename(const unsigned int xid, struct cifs_tcon *tcon,
147                        u64 persistent_fid, u64 volatile_fid,
148                        __le16 *target_file);
149 extern int SMB2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
150                       u64 persistent_fid, u64 volatile_fid);
151 extern int SMB2_set_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
152                              u64 persistent_fid, u64 volatile_fid,
153                              __le16 *target_file);
154 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
155                         u64 persistent_fid, u64 volatile_fid, u32 pid,
156                         __le64 *eof, bool is_fallocate);
157 extern int SMB2_set_info(const unsigned int xid, struct cifs_tcon *tcon,
158                          u64 persistent_fid, u64 volatile_fid,
159                          FILE_BASIC_INFO *buf);
160 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
161                                 u64 persistent_fid, u64 volatile_fid);
162 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
163                              const u64 persistent_fid, const u64 volatile_fid,
164                              const __u8 oplock_level);
165 extern int smb2_handle_cancelled_mid(char *buffer,
166                                         struct TCP_Server_Info *server);
167 void smb2_cancelled_close_fid(struct work_struct *work);
168 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
169                          u64 persistent_file_id, u64 volatile_file_id,
170                          struct kstatfs *FSData);
171 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
172                          u64 persistent_file_id, u64 volatile_file_id, int lvl);
173 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
174                      const __u64 persist_fid, const __u64 volatile_fid,
175                      const __u32 pid, const __u64 length, const __u64 offset,
176                      const __u32 lockFlags, const bool wait);
177 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
178                       const __u64 persist_fid, const __u64 volatile_fid,
179                       const __u32 pid, const __u32 num_lock,
180                       struct smb2_lock_element *buf);
181 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
182                             __u8 *lease_key, const __le32 lease_state);
183 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
184
185 #endif                  /* _SMB2PROTO_H */