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