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 extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
  64                                           __u64 ses_id);
  65 extern int smb3_handle_read_data(struct TCP_Server_Info *server,
  66                                  struct mid_q_entry *mid);
  67
  68 extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
  69                                    struct smb2_file_all_info *src);
  70 extern int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
  71                                 struct cifs_sb_info *cifs_sb,
  72                                 const char *full_path, FILE_ALL_INFO *data,
  73                                 bool *adjust_tz, bool *symlink);
  74 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
  75                               const char *full_path, __u64 size,
  76                               struct cifs_sb_info *cifs_sb, bool set_alloc);
  77 extern int smb2_set_file_info(struct inode *inode, const char *full_path,
  78                               FILE_BASIC_INFO *buf, const unsigned int xid);
  79 extern int smb2_mkdir(const unsigned int xid, struct cifs_tcon *tcon,
  80                       const char *name, struct cifs_sb_info *cifs_sb);
  81 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
  82                                struct cifs_sb_info *cifs_sb,
  83                                struct cifs_tcon *tcon, const unsigned int xid);
  84 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
  85                       const char *name, struct cifs_sb_info *cifs_sb);
  86 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
  87                        const char *name, struct cifs_sb_info *cifs_sb);
  88 extern int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
  89                             const char *from_name, const char *to_name,
  90                             struct cifs_sb_info *cifs_sb);
  91 extern int smb2_create_hardlink(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 smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
  95                         struct cifs_sb_info *cifs_sb, const unsigned char *path,
  96                         char *pbuf, unsigned int *pbytes_written);
  97 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
  98                           struct cifs_sb_info *cifs_sb,
  99                           const unsigned char *path, char *pbuf,
 100                           unsigned int *pbytes_read);
 101 extern int smb2_open_file(const unsigned int xid,
 102                           struct cifs_open_parms *oparms,
 103                           __u32 *oplock, FILE_ALL_INFO *buf);
 104 extern int smb2_unlock_range(struct cifsFileInfo *cfile,
 105                              struct file_lock *flock, const unsigned int xid);
 106 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
 107 extern void smb2_reconnect_server(struct work_struct *work);
 108 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
 109
 110 /*
 111  * SMB2 Worker functions - most of protocol specific implementation details
 112  * are contained within these calls.
 113  */
 114 extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
 115 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
 116                            const struct nls_table *nls_cp);
 117 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
 118 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
 119                      const char *tree, struct cifs_tcon *tcon,
 120                      const struct nls_table *);
 121 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
 122 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
 123                      __le16 *path, __u8 *oplock,
 124                      struct smb2_file_all_info *buf,
 125                      struct smb2_err_rsp **err_buf);
 126 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
 127                      u64 persistent_fid, u64 volatile_fid, u32 opcode,
 128                      bool is_fsctl, bool use_ipc,
 129                      char *in_data, u32 indatalen,
 130                      char **out_data, u32 *plen /* returned data len */);
 131 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
 132                       u64 persistent_file_id, u64 volatile_file_id);
 133 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
 134                       u64 persistent_file_id, u64 volatile_file_id);
 135 extern int SMB2_query_eas(const unsigned int xid, struct cifs_tcon *tcon,
 136                           u64 persistent_file_id, u64 volatile_file_id,
 137                           struct smb2_file_full_ea_info *data);
 138 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
 139                            u64 persistent_file_id, u64 volatile_file_id,
 140                            struct smb2_file_all_info *data);
 141 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
 142                            u64 persistent_file_id, u64 volatile_file_id,
 143                            void **data, unsigned int *plen);
 144 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
 145                             u64 persistent_fid, u64 volatile_fid,
 146                             __le64 *uniqueid);
 147 extern int smb2_async_readv(struct cifs_readdata *rdata);
 148 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
 149                      unsigned int *nbytes, char **buf, int *buf_type);
 150 extern int smb2_async_writev(struct cifs_writedata *wdata,
 151                              void (*release)(struct kref *kref));
 152 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
 153                       unsigned int *nbytes, struct kvec *iov, int n_vec);
 154 extern int SMB2_echo(struct TCP_Server_Info *server);
 155 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
 156                                 u64 persistent_fid, u64 volatile_fid, int index,
 157                                 struct cifs_search_info *srch_inf);
 158 extern int SMB2_rename(const unsigned int xid, struct cifs_tcon *tcon,
 159                        u64 persistent_fid, u64 volatile_fid,
 160                        __le16 *target_file);
 161 extern int SMB2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
 162                       u64 persistent_fid, u64 volatile_fid);
 163 extern int SMB2_set_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
 164                              u64 persistent_fid, u64 volatile_fid,
 165                              __le16 *target_file);
 166 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
 167                         u64 persistent_fid, u64 volatile_fid, u32 pid,
 168                         __le64 *eof, bool is_fallocate);
 169 extern int SMB2_set_info(const unsigned int xid, struct cifs_tcon *tcon,
 170                          u64 persistent_fid, u64 volatile_fid,
 171                          FILE_BASIC_INFO *buf);
 172 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
 173                         u64 persistent_fid, u64 volatile_fid,
 174                         struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
 175 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
 176                        u64 persistent_fid, u64 volatile_fid,
 177                        struct smb2_file_full_ea_info *buf, int len);
 178 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
 179                                 u64 persistent_fid, u64 volatile_fid);
 180 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
 181                              const u64 persistent_fid, const u64 volatile_fid,
 182                              const __u8 oplock_level);
 183 extern int smb2_handle_cancelled_mid(char *buffer,
 184                                         struct TCP_Server_Info *server);
 185 void smb2_cancelled_close_fid(struct work_struct *work);
 186 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
 187                          u64 persistent_file_id, u64 volatile_file_id,
 188                          struct kstatfs *FSData);
 189 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
 190                          u64 persistent_file_id, u64 volatile_file_id, int lvl);
 191 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
 192                      const __u64 persist_fid, const __u64 volatile_fid,
 193                      const __u32 pid, const __u64 length, const __u64 offset,
 194                      const __u32 lockFlags, const bool wait);
 195 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
 196                       const __u64 persist_fid, const __u64 volatile_fid,
 197                       const __u32 pid, const __u32 num_lock,
 198                       struct smb2_lock_element *buf);
 199 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
 200                             __u8 *lease_key, const __le32 lease_state);
 201 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
 202
 203 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
 204                                         enum securityEnum);
 205 #endif                  /* _SMB2PROTO_H */