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