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