root/fs/smb/client/smb2proto.h
/* SPDX-License-Identifier: LGPL-2.1 */
/*
 *
 *   Copyright (c) International Business Machines  Corp., 2002, 2011
 *                 Etersoft, 2012
 *   Author(s): Steve French (sfrench@us.ibm.com)
 *              Pavel Shilovsky (pshilovsky@samba.org) 2012
 *
 */
#ifndef _SMB2PROTO_H
#define _SMB2PROTO_H

#include <linux/nls.h>
#include <linux/key-type.h>
#include "cached_dir.h"

struct statfs;
struct smb_rqst;

/*
 *****************************************************************
 * All Prototypes
 *****************************************************************
 */
int map_smb2_to_linux_error(char *buf, bool log_err);
int smb2_init_maperror(void);
int smb2_check_message(char *buf, unsigned int pdu_len, unsigned int len,
                       struct TCP_Server_Info *server);
unsigned int smb2_calc_size(void *buf);
char *smb2_get_data_area_len(int *off, int *len, struct smb2_hdr *shdr);
__le16 *cifs_convert_path_to_utf16(const char *from,
                                   struct cifs_sb_info *cifs_sb);

int smb2_verify_signature(struct smb_rqst *rqst,
                          struct TCP_Server_Info *server);
int smb2_check_receive(struct mid_q_entry *mid, struct TCP_Server_Info *server,
                       bool log_error);
struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
                                       struct TCP_Server_Info *server,
                                       struct smb_rqst *rqst);
struct mid_q_entry *smb2_setup_async_request(struct TCP_Server_Info *server,
                                             struct smb_rqst *rqst);
struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
                                     __u64 ses_id, __u32  tid);
__le32 smb2_get_lease_state(struct cifsInodeInfo *cinode, unsigned int oplock);
bool smb2_is_valid_oplock_break(char *buffer, struct TCP_Server_Info *server);
int smb3_handle_read_data(struct TCP_Server_Info *server,
                          struct mid_q_entry *mid);
struct inode *smb2_create_reparse_inode(struct cifs_open_info_data *data,
                                        struct super_block *sb,
                                        const unsigned int xid,
                                        struct cifs_tcon *tcon,
                                        const char *full_path, bool directory,
                                        struct kvec *reparse_iov,
                                        struct kvec *xattr_iov);
int smb2_query_reparse_point(const unsigned int xid, struct cifs_tcon *tcon,
                             struct cifs_sb_info *cifs_sb,
                             const char *full_path, u32 *tag, struct kvec *rsp,
                             int *rsp_buftype);
int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon,
                         struct cifs_sb_info *cifs_sb, const char *full_path,
                         struct cifs_open_info_data *data);
int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
                       const char *full_path, __u64 size,
                       struct cifs_sb_info *cifs_sb, bool set_alloc,
                       struct dentry *dentry);
int smb2_set_file_info(struct inode *inode, const char *full_path,
                       FILE_BASIC_INFO *buf, const unsigned int xid);
int smb311_posix_mkdir(const unsigned int xid, struct inode *inode,
                       umode_t mode, struct cifs_tcon *tcon,
                       const char *full_path, struct cifs_sb_info *cifs_sb);
int smb2_mkdir(const unsigned int xid, struct inode *parent_inode,
               umode_t mode, struct cifs_tcon *tcon, const char *name,
               struct cifs_sb_info *cifs_sb);
void smb2_mkdir_setinfo(struct inode *inode, const char *name,
                        struct cifs_sb_info *cifs_sb, struct cifs_tcon *tcon,
                        const unsigned int xid);
int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
               const char *name, struct cifs_sb_info *cifs_sb);
int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
                const char *name, struct cifs_sb_info *cifs_sb,
                struct dentry *dentry);
int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon,
                     struct dentry *source_dentry, const char *from_name,
                     const char *to_name, struct cifs_sb_info *cifs_sb);
int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon,
                         struct dentry *source_dentry, const char *from_name,
                         const char *to_name, struct cifs_sb_info *cifs_sb);
int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
                           struct cifs_sb_info *cifs_sb,
                           const unsigned char *path, char *pbuf,
                           unsigned int *pbytes_written);
int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
                          struct cifs_sb_info *cifs_sb,
                          const unsigned char *path, char *pbuf,
                          unsigned int *pbytes_read);
int smb2_fix_symlink_target_type(char **target, bool directory,
                                 struct cifs_sb_info *cifs_sb);
int smb2_parse_native_symlink(char **target, const char *buf, unsigned int len,
                              bool relative, const char *full_path,
                              struct cifs_sb_info *cifs_sb);
int smb2_parse_symlink_response(struct cifs_sb_info *cifs_sb,
                                const struct kvec *iov, const char *full_path,
                                char **path);
int smb2_open_file(const unsigned int xid, struct cifs_open_parms *oparms,
                   __u32 *oplock, void *buf);
int smb2_unlock_range(struct cifsFileInfo *cfile, struct file_lock *flock,
                      const unsigned int xid);
int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
void smb2_reconnect_server(struct work_struct *work);
int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
unsigned long smb_rqst_len(struct TCP_Server_Info *server,
                           struct smb_rqst *rqst);
void smb2_set_next_command(struct cifs_tcon *tcon, struct smb_rqst *rqst);
void smb2_set_related(struct smb_rqst *rqst);
void smb2_set_replay(struct TCP_Server_Info *server, struct smb_rqst *rqst);
bool smb2_should_replay(struct cifs_tcon *tcon, int *pretries,
                        int *pcur_sleep);

/*
 * SMB2 Worker functions - most of protocol specific implementation details
 * are contained within these calls.
 */
int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses,
                   struct TCP_Server_Info *server);
int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
                    struct TCP_Server_Info *server,
                    const struct nls_table *nls_cp);
int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses, const char *tree,
              struct cifs_tcon *tcon, const struct nls_table *cp);
int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
              __le16 *path, __u8 *oplock, struct smb2_file_all_info *buf,
              struct create_posix_rsp *posix, struct kvec *err_iov,
              int *buftype);
int SMB2_open_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server,
                   struct smb_rqst *rqst, __u8 *oplock,
                   struct cifs_open_parms *oparms, __le16 *path);
void SMB2_open_free(struct smb_rqst *rqst);
int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
               u64 persistent_fid, u64 volatile_fid, u32 opcode, char *in_data,
               u32 indatalen, u32 max_out_data_len, char **out_data,
               u32 *plen /* returned data len */);
int SMB2_ioctl_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server,
                    struct smb_rqst *rqst, u64 persistent_fid,
                    u64 volatile_fid, u32 opcode, char *in_data, u32 indatalen,
                    __u32 max_response_size);
void SMB2_ioctl_free(struct smb_rqst *rqst);
int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon,
                       u64 persistent_fid, u64 volatile_fid, bool watch_tree,
                       u32 completion_filter, u32 max_out_data_len,
                       char **out_data, u32 *plen /* returned data len */);

int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
                 u64 persistent_fid, u64 volatile_fid,
                 struct smb2_file_network_open_info *pbuf);
int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
               u64 persistent_fid, u64 volatile_fid);
int SMB2_close_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server,
                    struct smb_rqst *rqst, u64 persistent_fid,
                    u64 volatile_fid, bool query_attrs);
void SMB2_close_free(struct smb_rqst *rqst);
int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
               u64 persistent_fid, u64 volatile_fid);
int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst,
                    struct cifs_tcon *tcon, struct TCP_Server_Info *server,
                    u64 persistent_fid, u64 volatile_fid);
void SMB2_flush_free(struct smb_rqst *rqst);
int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
                    u64 persistent_fid, u64 volatile_fid,
                    struct smb2_file_all_info *data);
int SMB2_query_info_init(struct cifs_tcon *tcon,
                         struct TCP_Server_Info *server, struct smb_rqst *rqst,
                         u64 persistent_fid, u64 volatile_fid, u8 info_class,
                         u8 info_type, u32 additional_info, size_t output_len,
                         size_t input_len, void *input);
void SMB2_query_info_free(struct smb_rqst *rqst);
int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
                   u64 persistent_fid, u64 volatile_fid, void **data,
                   u32 *plen, u32 extra_info);
int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
                     u64 persistent_fid, u64 volatile_fid, __le64 *uniqueid);
int smb2_async_readv(struct cifs_io_subrequest *rdata);
int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
              unsigned int *nbytes, char **buf, int *buf_type);
void smb2_async_writev(struct cifs_io_subrequest *wdata);
int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
               unsigned int *nbytes, struct kvec *iov, int n_vec);
int SMB2_echo(struct TCP_Server_Info *server);
int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
                         u64 persistent_fid, u64 volatile_fid, int index,
                         struct cifs_search_info *srch_inf);
int SMB2_query_directory_init(const unsigned int xid, struct cifs_tcon *tcon,
                              struct TCP_Server_Info *server,
                              struct smb_rqst *rqst, u64 persistent_fid,
                              u64 volatile_fid, int index, int info_level);
void SMB2_query_directory_free(struct smb_rqst *rqst);
int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
                 u64 persistent_fid, u64 volatile_fid, u32 pid,
                 loff_t new_eof);
int SMB2_set_info_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server,
                       struct smb_rqst *rqst, u64 persistent_fid,
                       u64 volatile_fid, u32 pid, u8 info_class, u8 info_type,
                       u32 additional_info, void **data, unsigned int *size);
void SMB2_set_info_free(struct smb_rqst *rqst);
int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
                 u64 persistent_fid, u64 volatile_fid, struct smb_ntsd *pnntsd,
                 int pacllen, int aclflag);
int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
                u64 persistent_fid, u64 volatile_fid,
                struct smb2_file_full_ea_info *buf, int len);
int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
                         u64 persistent_fid, u64 volatile_fid);
int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
                      const u64 persistent_fid, const u64 volatile_fid,
                      __u8 oplock_level);
int smb2_handle_cancelled_close(struct cifs_tcon *tcon, __u64 persistent_fid,
                                __u64 volatile_fid);
int smb2_handle_cancelled_mid(struct mid_q_entry *mid,
                              struct TCP_Server_Info *server);
void smb2_cancelled_close_fid(struct work_struct *work);
int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon,
                          u64 persistent_fid, u64 volatile_fid,
                          struct kstatfs *fsdata);
int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
                  u64 persistent_fid, u64 volatile_fid, int level);
int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
              const __u64 persist_fid, const __u64 volatile_fid,
              const __u32 pid, const __u64 length, const __u64 offset,
              const __u32 lock_flags, const bool wait);
int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
               const __u64 persist_fid, const __u64 volatile_fid,
               const __u32 pid, const __u32 num_lock,
               struct smb2_lock_element *buf);
int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
                     __u8 *lease_key, const __le32 lease_state);
int smb3_validate_negotiate(const unsigned int xid, struct cifs_tcon *tcon);

enum securityEnum smb2_select_sectype(struct TCP_Server_Info *server,
                                      enum securityEnum requested);
int smb2_parse_contexts(struct TCP_Server_Info *server, struct kvec *rsp_iov,
                        __u16 *epoch, char *lease_key, __u8 *oplock,
                        struct smb2_file_all_info *buf,
                        struct create_posix_rsp *posix);

int smb3_encryption_required(const struct cifs_tcon *tcon);
int smb2_validate_iov(unsigned int offset, unsigned int buffer_length,
                      struct kvec *iov, unsigned int min_buf_size);
int smb2_validate_and_copy_iov(unsigned int offset, unsigned int buffer_length,
                               struct kvec *iov, unsigned int minbufsize,
                               char *data);
void smb2_copy_fs_info_to_kstatfs(struct smb2_fs_full_size_info *pfs_inf,
                                  struct kstatfs *kst);
int smb3_crypto_shash_allocate(struct TCP_Server_Info *server);
void smb311_update_preauth_hash(struct cifs_ses *ses,
                                struct TCP_Server_Info *server,
                                struct kvec *iov, int nvec);
int smb2_query_info_compound(const unsigned int xid, struct cifs_tcon *tcon,
                             const char *path, u32 desired_access, u32 class,
                             u32 type, u32 output_len, struct kvec *rsp,
                             int *buftype, struct cifs_sb_info *cifs_sb);
/* query path info from the server using SMB311 POSIX extensions*/
int posix_info_parse(const void *beg, const void *end,
                     struct smb2_posix_info_parsed *out);
int posix_info_sid_size(const void *beg, const void *end);
int smb2_rename_pending_delete(const char *full_path, struct dentry *dentry,
                               const unsigned int xid);

#endif                  /* _SMB2PROTO_H */