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);
  40extern char *smb2_get_data_area_len(int *off, int *len, struct smb2_hdr *hdr);
  41extern __le16 *cifs_convert_path_to_utf16(const char *from,
  42                                          struct cifs_sb_info *cifs_sb);
  43
  44extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
  45extern int smb2_check_receive(struct mid_q_entry *mid,
  46                              struct TCP_Server_Info *server, bool log_error);
  47extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
  48                              struct smb_rqst *rqst);
  49extern struct mid_q_entry *smb2_setup_async_request(
  50                        struct TCP_Server_Info *server, struct smb_rqst *rqst);
  51extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
  52                                           __u64 ses_id);
  53extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
  54                                                __u64 ses_id, __u32  tid);
  55extern int smb2_calc_signature(struct smb_rqst *rqst,
  56                                struct TCP_Server_Info *server);
  57extern int smb3_calc_signature(struct smb_rqst *rqst,
  58                                struct TCP_Server_Info *server);
  59extern void smb2_echo_request(struct work_struct *work);
  60extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
  61extern bool smb2_is_valid_oplock_break(char *buffer,
  62                                       struct TCP_Server_Info *srv);
  63extern struct cifs_ses *smb2_find_smb_ses(struct TCP_Server_Info *server,
  64                                          __u64 ses_id);
  65extern int smb3_handle_read_data(struct TCP_Server_Info *server,
  66                                 struct mid_q_entry *mid);
  67
  68extern void move_smb2_info_to_cifs(FILE_ALL_INFO *dst,
  69                                   struct smb2_file_all_info *src);
  70extern 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);
  74extern 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);
  77extern int smb2_set_file_info(struct inode *inode, const char *full_path,
  78                              FILE_BASIC_INFO *buf, const unsigned int xid);
  79extern int smb2_mkdir(const unsigned int xid, struct cifs_tcon *tcon,
  80                      const char *name, struct cifs_sb_info *cifs_sb);
  81extern 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);
  84extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
  85                      const char *name, struct cifs_sb_info *cifs_sb);
  86extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
  87                       const char *name, struct cifs_sb_info *cifs_sb);
  88extern 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);
  91extern 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);
  94extern 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);
  97extern 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);
 101extern int smb2_open_file(const unsigned int xid,
 102                          struct cifs_open_parms *oparms,
 103                          __u32 *oplock, FILE_ALL_INFO *buf);
 104extern int smb2_unlock_range(struct cifsFileInfo *cfile,
 105                             struct file_lock *flock, const unsigned int xid);
 106extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
 107extern void smb2_reconnect_server(struct work_struct *work);
 108extern 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 */
 114extern int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses);
 115extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
 116                           const struct nls_table *nls_cp);
 117extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
 118extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
 119                     const char *tree, struct cifs_tcon *tcon,
 120                     const struct nls_table *);
 121extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
 122extern 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);
 126extern 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 */);
 131extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
 132                      u64 persistent_file_id, u64 volatile_file_id);
 133extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
 134                      u64 persistent_file_id, u64 volatile_file_id);
 135extern int SMB2_query_eas(const unsigned int xid, struct cifs_tcon *tcon,
 136                          u64 persistent_file_id, u64 volatile_file_id,
 137                          int ea_buf_size,
 138                          struct smb2_file_full_ea_info *data);
 139extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
 140                           u64 persistent_file_id, u64 volatile_file_id,
 141                           struct smb2_file_all_info *data);
 142extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
 143                           u64 persistent_file_id, u64 volatile_file_id,
 144                           void **data, unsigned int *plen);
 145extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
 146                            u64 persistent_fid, u64 volatile_fid,
 147                            __le64 *uniqueid);
 148extern int smb2_async_readv(struct cifs_readdata *rdata);
 149extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
 150                     unsigned int *nbytes, char **buf, int *buf_type);
 151extern int smb2_async_writev(struct cifs_writedata *wdata,
 152                             void (*release)(struct kref *kref));
 153extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
 154                      unsigned int *nbytes, struct kvec *iov, int n_vec);
 155extern int SMB2_echo(struct TCP_Server_Info *server);
 156extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
 157                                u64 persistent_fid, u64 volatile_fid, int index,
 158                                struct cifs_search_info *srch_inf);
 159extern int SMB2_rename(const unsigned int xid, struct cifs_tcon *tcon,
 160                       u64 persistent_fid, u64 volatile_fid,
 161                       __le16 *target_file);
 162extern int SMB2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
 163                      u64 persistent_fid, u64 volatile_fid);
 164extern int SMB2_set_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
 165                             u64 persistent_fid, u64 volatile_fid,
 166                             __le16 *target_file);
 167extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
 168                        u64 persistent_fid, u64 volatile_fid, u32 pid,
 169                        __le64 *eof, bool is_fallocate);
 170extern int SMB2_set_info(const unsigned int xid, struct cifs_tcon *tcon,
 171                         u64 persistent_fid, u64 volatile_fid,
 172                         FILE_BASIC_INFO *buf);
 173extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
 174                        u64 persistent_fid, u64 volatile_fid,
 175                        struct cifs_ntsd *pnntsd, int pacllen, int aclflag);
 176extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
 177                       u64 persistent_fid, u64 volatile_fid,
 178                       struct smb2_file_full_ea_info *buf, int len);
 179extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
 180                                u64 persistent_fid, u64 volatile_fid);
 181extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
 182                             const u64 persistent_fid, const u64 volatile_fid,
 183                             const __u8 oplock_level);
 184extern int smb2_handle_cancelled_mid(char *buffer,
 185                                        struct TCP_Server_Info *server);
 186void smb2_cancelled_close_fid(struct work_struct *work);
 187extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
 188                         u64 persistent_file_id, u64 volatile_file_id,
 189                         struct kstatfs *FSData);
 190extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
 191                         u64 persistent_file_id, u64 volatile_file_id, int lvl);
 192extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
 193                     const __u64 persist_fid, const __u64 volatile_fid,
 194                     const __u32 pid, const __u64 length, const __u64 offset,
 195                     const __u32 lockFlags, const bool wait);
 196extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
 197                      const __u64 persist_fid, const __u64 volatile_fid,
 198                      const __u32 pid, const __u32 num_lock,
 199                      struct smb2_lock_element *buf);
 200extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
 201                            __u8 *lease_key, const __le32 lease_state);
 202extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
 203
 204extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
 205                                        enum securityEnum);
 206#endif                  /* _SMB2PROTO_H */
 207