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