fs/cifs/cifsglob.h

   1 /* SPDX-License-Identifier: LGPL-2.1 */
   2 /*
   3  *
   4  *   Copyright (C) International Business Machines  Corp., 2002,2008
   5  *   Author(s): Steve French (sfrench@us.ibm.com)
   6  *              Jeremy Allison (jra@samba.org)
   7  *
   8  */
   9 #ifndef _CIFS_GLOB_H
  10 #define _CIFS_GLOB_H
  11
  12 #include <linux/in.h>
  13 #include <linux/in6.h>
  14 #include <linux/inet.h>
  15 #include <linux/slab.h>
  16 #include <linux/scatterlist.h>
  17 #include <linux/mm.h>
  18 #include <linux/mempool.h>
  19 #include <linux/workqueue.h>
  20 #include <linux/utsname.h>
  21 #include <linux/sched/mm.h>
  22 #include <linux/netfs.h>
  23 #include "cifs_fs_sb.h"
  24 #include "cifsacl.h"
  25 #include <crypto/internal/hash.h>
  26 #include <uapi/linux/cifs/cifs_mount.h>
  27 #include "../smbfs_common/smb2pdu.h"
  28 #include "smb2pdu.h"
  29
  30 #define SMB_PATH_MAX 260
  31 #define CIFS_PORT 445
  32 #define RFC1001_PORT 139
  33
  34 /*
  35  * The sizes of various internal tables and strings
  36  */
  37 #define MAX_UID_INFO 16
  38 #define MAX_SES_INFO 2
  39 #define MAX_TCON_INFO 4
  40
  41 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
  42
  43 #define CIFS_MIN_RCV_POOL 4
  44
  45 #define MAX_REOPEN_ATT  5 /* these many maximum attempts to reopen a file */
  46 /*
  47  * default attribute cache timeout (jiffies)
  48  */
  49 #define CIFS_DEF_ACTIMEO (1 * HZ)
  50
  51 /*
  52  * max attribute cache timeout (jiffies) - 2^30
  53  */
  54 #define CIFS_MAX_ACTIMEO (1 << 30)
  55
  56 /*
  57  * Max persistent and resilient handle timeout (milliseconds).
  58  * Windows durable max was 960000 (16 minutes)
  59  */
  60 #define SMB3_MAX_HANDLE_TIMEOUT 960000
  61
  62 /*
  63  * MAX_REQ is the maximum number of requests that WE will send
  64  * on one socket concurrently.
  65  */
  66 #define CIFS_MAX_REQ 32767
  67
  68 #define RFC1001_NAME_LEN 15
  69 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
  70
  71 /* maximum length of ip addr as a string (including ipv6 and sctp) */
  72 #define SERVER_NAME_LENGTH 80
  73 #define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)
  74
  75 /* echo interval in seconds */
  76 #define SMB_ECHO_INTERVAL_MIN 1
  77 #define SMB_ECHO_INTERVAL_MAX 600
  78 #define SMB_ECHO_INTERVAL_DEFAULT 60
  79
  80 /* dns resolution intervals in seconds */
  81 #define SMB_DNS_RESOLVE_INTERVAL_MIN     120
  82 #define SMB_DNS_RESOLVE_INTERVAL_DEFAULT 600
  83
  84 /* smb multichannel query server interfaces interval in seconds */
  85 #define SMB_INTERFACE_POLL_INTERVAL     600
  86
  87 /* maximum number of PDUs in one compound */
  88 #define MAX_COMPOUND 5
  89
  90 /*
  91  * Default number of credits to keep available for SMB3.
  92  * This value is chosen somewhat arbitrarily. The Windows client
  93  * defaults to 128 credits, the Windows server allows clients up to
  94  * 512 credits (or 8K for later versions), and the NetApp server
  95  * does not limit clients at all.  Choose a high enough default value
  96  * such that the client shouldn't limit performance, but allow mount
  97  * to override (until you approach 64K, where we limit credits to 65000
  98  * to reduce possibility of seeing more server credit overflow bugs.
  99  */
 100 #define SMB2_MAX_CREDITS_AVAILABLE 32000
 101
 102 #include "cifspdu.h"
 103
 104 #ifndef XATTR_DOS_ATTRIB
 105 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
 106 #endif
 107
 108 #define CIFS_MAX_WORKSTATION_LEN  (__NEW_UTS_LEN + 1)  /* reasonable max for client */
 109
 110 #define CIFS_DFS_ROOT_SES(ses) ((ses)->dfs_root_ses ?: (ses))
 111
 112 /*
 113  * CIFS vfs client Status information (based on what we know.)
 114  */
 115
 116 /* associated with each connection */
 117 enum statusEnum {
 118         CifsNew = 0,
 119         CifsGood,
 120         CifsExiting,
 121         CifsNeedReconnect,
 122         CifsNeedNegotiate,
 123         CifsInNegotiate,
 124 };
 125
 126 /* associated with each smb session */
 127 enum ses_status_enum {
 128         SES_NEW = 0,
 129         SES_GOOD,
 130         SES_EXITING,
 131         SES_NEED_RECON,
 132         SES_IN_SETUP
 133 };
 134
 135 /* associated with each tree connection to the server */
 136 enum tid_status_enum {
 137         TID_NEW = 0,
 138         TID_GOOD,
 139         TID_EXITING,
 140         TID_NEED_RECON,
 141         TID_NEED_TCON,
 142         TID_IN_TCON,
 143         TID_NEED_FILES_INVALIDATE, /* currently unused */
 144         TID_IN_FILES_INVALIDATE
 145 };
 146
 147 enum securityEnum {
 148         Unspecified = 0,        /* not specified */
 149         NTLMv2,                 /* Legacy NTLM auth with NTLMv2 hash */
 150         RawNTLMSSP,             /* NTLMSSP without SPNEGO, NTLMv2 hash */
 151         Kerberos,               /* Kerberos via SPNEGO */
 152 };
 153
 154 struct session_key {
 155         unsigned int len;
 156         char *response;
 157 };
 158
 159 /* crypto hashing related structure/fields, not specific to a sec mech */
 160 struct cifs_secmech {
 161         struct shash_desc *hmacmd5; /* hmacmd5 hash function, for NTLMv2/CR1 hashes */
 162         struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */
 163         struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */
 164         struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */
 165         struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */
 166
 167         struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */
 168         struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */
 169 };
 170
 171 /* per smb session structure/fields */
 172 struct ntlmssp_auth {
 173         bool sesskey_per_smbsess; /* whether session key is per smb session */
 174         __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
 175         __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
 176         unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
 177         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
 178 };
 179
 180 struct cifs_cred {
 181         int uid;
 182         int gid;
 183         int mode;
 184         int cecount;
 185         struct cifs_sid osid;
 186         struct cifs_sid gsid;
 187         struct cifs_ntace *ntaces;
 188         struct cifs_ace *aces;
 189 };
 190
 191 struct cifs_open_info_data {
 192         char *symlink_target;
 193         union {
 194                 struct smb2_file_all_info fi;
 195                 struct smb311_posix_qinfo posix_fi;
 196         };
 197 };
 198
 199 static inline void cifs_free_open_info(struct cifs_open_info_data *data)
 200 {
 201         kfree(data->symlink_target);
 202 }
 203
 204 /*
 205  *****************************************************************
 206  * Except the CIFS PDUs themselves all the
 207  * globally interesting structs should go here
 208  *****************************************************************
 209  */
 210
 211 /*
 212  * A smb_rqst represents a complete request to be issued to a server. It's
 213  * formed by a kvec array, followed by an array of pages. Page data is assumed
 214  * to start at the beginning of the first page.
 215  */
 216 struct smb_rqst {
 217         struct kvec     *rq_iov;        /* array of kvecs */
 218         unsigned int    rq_nvec;        /* number of kvecs in array */
 219         struct page     **rq_pages;     /* pointer to array of page ptrs */
 220         unsigned int    rq_offset;      /* the offset to the 1st page */
 221         unsigned int    rq_npages;      /* number pages in array */
 222         unsigned int    rq_pagesz;      /* page size to use */
 223         unsigned int    rq_tailsz;      /* length of last page */
 224 };
 225
 226 struct mid_q_entry;
 227 struct TCP_Server_Info;
 228 struct cifsFileInfo;
 229 struct cifs_ses;
 230 struct cifs_tcon;
 231 struct dfs_info3_param;
 232 struct cifs_fattr;
 233 struct smb3_fs_context;
 234 struct cifs_fid;
 235 struct cifs_readdata;
 236 struct cifs_writedata;
 237 struct cifs_io_parms;
 238 struct cifs_search_info;
 239 struct cifsInodeInfo;
 240 struct cifs_open_parms;
 241 struct cifs_credits;
 242
 243 struct smb_version_operations {
 244         int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
 245                            struct mid_q_entry *);
 246         bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
 247         /* setup request: allocate mid, sign message */
 248         struct mid_q_entry *(*setup_request)(struct cifs_ses *,
 249                                              struct TCP_Server_Info *,
 250                                              struct smb_rqst *);
 251         /* setup async request: allocate mid, sign message */
 252         struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
 253                                                 struct smb_rqst *);
 254         /* check response: verify signature, map error */
 255         int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
 256                              bool);
 257         void (*add_credits)(struct TCP_Server_Info *server,
 258                             const struct cifs_credits *credits,
 259                             const int optype);
 260         void (*set_credits)(struct TCP_Server_Info *, const int);
 261         int * (*get_credits_field)(struct TCP_Server_Info *, const int);
 262         unsigned int (*get_credits)(struct mid_q_entry *);
 263         __u64 (*get_next_mid)(struct TCP_Server_Info *);
 264         void (*revert_current_mid)(struct TCP_Server_Info *server,
 265                                    const unsigned int val);
 266         /* data offset from read response message */
 267         unsigned int (*read_data_offset)(char *);
 268         /*
 269          * Data length from read response message
 270          * When in_remaining is true, the returned data length is in
 271          * message field DataRemaining for out-of-band data read (e.g through
 272          * Memory Registration RDMA write in SMBD).
 273          * Otherwise, the returned data length is in message field DataLength.
 274          */
 275         unsigned int (*read_data_length)(char *, bool in_remaining);
 276         /* map smb to linux error */
 277         int (*map_error)(char *, bool);
 278         /* find mid corresponding to the response message */
 279         struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
 280         void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
 281         void (*clear_stats)(struct cifs_tcon *);
 282         void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
 283         void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
 284         /* verify the message */
 285         int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
 286         bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
 287         int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *);
 288         void (*downgrade_oplock)(struct TCP_Server_Info *server,
 289                                  struct cifsInodeInfo *cinode, __u32 oplock,
 290                                  unsigned int epoch, bool *purge_cache);
 291         /* process transaction2 response */
 292         bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
 293                              char *, int);
 294         /* check if we need to negotiate */
 295         bool (*need_neg)(struct TCP_Server_Info *);
 296         /* negotiate to the server */
 297         int (*negotiate)(const unsigned int xid,
 298                          struct cifs_ses *ses,
 299                          struct TCP_Server_Info *server);
 300         /* set negotiated write size */
 301         unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
 302         /* set negotiated read size */
 303         unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
 304         /* setup smb sessionn */
 305         int (*sess_setup)(const unsigned int, struct cifs_ses *,
 306                           struct TCP_Server_Info *server,
 307                           const struct nls_table *);
 308         /* close smb session */
 309         int (*logoff)(const unsigned int, struct cifs_ses *);
 310         /* connect to a server share */
 311         int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
 312                             struct cifs_tcon *, const struct nls_table *);
 313         /* close tree connecion */
 314         int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
 315         /* get DFS referrals */
 316         int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
 317                              const char *, struct dfs_info3_param **,
 318                              unsigned int *, const struct nls_table *, int);
 319         /* informational QFS call */
 320         void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
 321                          struct cifs_sb_info *);
 322         /* check if a path is accessible or not */
 323         int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
 324                                   struct cifs_sb_info *, const char *);
 325         /* query path data from the server */
 326         int (*query_path_info)(const unsigned int xid, struct cifs_tcon *tcon,
 327                                struct cifs_sb_info *cifs_sb, const char *full_path,
 328                                struct cifs_open_info_data *data, bool *adjust_tz, bool *reparse);
 329         /* query file data from the server */
 330         int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon,
 331                                struct cifsFileInfo *cfile, struct cifs_open_info_data *data);
 332         /* query reparse tag from srv to determine which type of special file */
 333         int (*query_reparse_tag)(const unsigned int xid, struct cifs_tcon *tcon,
 334                                 struct cifs_sb_info *cifs_sb, const char *path,
 335                                 __u32 *reparse_tag);
 336         /* get server index number */
 337         int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon,
 338                             struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid,
 339                             struct cifs_open_info_data *data);
 340         /* set size by path */
 341         int (*set_path_size)(const unsigned int, struct cifs_tcon *,
 342                              const char *, __u64, struct cifs_sb_info *, bool);
 343         /* set size by file handle */
 344         int (*set_file_size)(const unsigned int, struct cifs_tcon *,
 345                              struct cifsFileInfo *, __u64, bool);
 346         /* set attributes */
 347         int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
 348                              const unsigned int);
 349         int (*set_compression)(const unsigned int, struct cifs_tcon *,
 350                                struct cifsFileInfo *);
 351         /* check if we can send an echo or nor */
 352         bool (*can_echo)(struct TCP_Server_Info *);
 353         /* send echo request */
 354         int (*echo)(struct TCP_Server_Info *);
 355         /* create directory */
 356         int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
 357                         umode_t mode, struct cifs_tcon *tcon,
 358                         const char *full_path,
 359                         struct cifs_sb_info *cifs_sb);
 360         int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
 361                      struct cifs_tcon *tcon, const char *name,
 362                      struct cifs_sb_info *sb);
 363         /* set info on created directory */
 364         void (*mkdir_setinfo)(struct inode *, const char *,
 365                               struct cifs_sb_info *, struct cifs_tcon *,
 366                               const unsigned int);
 367         /* remove directory */
 368         int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
 369                      struct cifs_sb_info *);
 370         /* unlink file */
 371         int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
 372                       struct cifs_sb_info *);
 373         /* open, rename and delete file */
 374         int (*rename_pending_delete)(const char *, struct dentry *,
 375                                      const unsigned int);
 376         /* send rename request */
 377         int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
 378                       const char *, struct cifs_sb_info *);
 379         /* send create hardlink request */
 380         int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
 381                                const char *, const char *,
 382                                struct cifs_sb_info *);
 383         /* query symlink target */
 384         int (*query_symlink)(const unsigned int, struct cifs_tcon *,
 385                              struct cifs_sb_info *, const char *,
 386                              char **, bool);
 387         /* open a file for non-posix mounts */
 388         int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
 389                     void *buf);
 390         /* set fid protocol-specific info */
 391         void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
 392         /* close a file */
 393         void (*close)(const unsigned int, struct cifs_tcon *,
 394                       struct cifs_fid *);
 395         /* close a file, returning file attributes and timestamps */
 396         void (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
 397                       struct cifsFileInfo *pfile_info);
 398         /* send a flush request to the server */
 399         int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
 400         /* async read from the server */
 401         int (*async_readv)(struct cifs_readdata *);
 402         /* async write to the server */
 403         int (*async_writev)(struct cifs_writedata *,
 404                             void (*release)(struct kref *));
 405         /* sync read from the server */
 406         int (*sync_read)(const unsigned int, struct cifs_fid *,
 407                          struct cifs_io_parms *, unsigned int *, char **,
 408                          int *);
 409         /* sync write to the server */
 410         int (*sync_write)(const unsigned int, struct cifs_fid *,
 411                           struct cifs_io_parms *, unsigned int *, struct kvec *,
 412                           unsigned long);
 413         /* open dir, start readdir */
 414         int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
 415                                const char *, struct cifs_sb_info *,
 416                                struct cifs_fid *, __u16,
 417                                struct cifs_search_info *);
 418         /* continue readdir */
 419         int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
 420                               struct cifs_fid *,
 421                               __u16, struct cifs_search_info *srch_inf);
 422         /* close dir */
 423         int (*close_dir)(const unsigned int, struct cifs_tcon *,
 424                          struct cifs_fid *);
 425         /* calculate a size of SMB message */
 426         unsigned int (*calc_smb_size)(void *buf);
 427         /* check for STATUS_PENDING and process the response if yes */
 428         bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
 429         /* check for STATUS_NETWORK_SESSION_EXPIRED */
 430         bool (*is_session_expired)(char *);
 431         /* send oplock break response */
 432         int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
 433                                struct cifsInodeInfo *);
 434         /* query remote filesystem */
 435         int (*queryfs)(const unsigned int, struct cifs_tcon *,
 436                        struct cifs_sb_info *, struct kstatfs *);
 437         /* send mandatory brlock to the server */
 438         int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
 439                          __u64, __u32, int, int, bool);
 440         /* unlock range of mandatory locks */
 441         int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
 442                                  const unsigned int);
 443         /* push brlocks from the cache to the server */
 444         int (*push_mand_locks)(struct cifsFileInfo *);
 445         /* get lease key of the inode */
 446         void (*get_lease_key)(struct inode *, struct cifs_fid *);
 447         /* set lease key of the inode */
 448         void (*set_lease_key)(struct inode *, struct cifs_fid *);
 449         /* generate new lease key */
 450         void (*new_lease_key)(struct cifs_fid *);
 451         int (*generate_signingkey)(struct cifs_ses *ses,
 452                                    struct TCP_Server_Info *server);
 453         int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
 454                                 bool allocate_crypto);
 455         int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
 456                              struct cifsFileInfo *src_file);
 457         int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
 458                              struct cifsFileInfo *src_file, void __user *);
 459         int (*notify)(const unsigned int xid, struct file *pfile,
 460                              void __user *pbuf, bool return_changes);
 461         int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
 462                                 struct cifs_sb_info *, const unsigned char *,
 463                                 char *, unsigned int *);
 464         int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
 465                                  struct cifs_sb_info *, const unsigned char *,
 466                                  char *, unsigned int *);
 467         /* if we can do cache read operations */
 468         bool (*is_read_op)(__u32);
 469         /* set oplock level for the inode */
 470         void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
 471                                  bool *);
 472         /* create lease context buffer for CREATE request */
 473         char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
 474         /* parse lease context buffer and return oplock/epoch info */
 475         __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
 476         ssize_t (*copychunk_range)(const unsigned int,
 477                         struct cifsFileInfo *src_file,
 478                         struct cifsFileInfo *target_file,
 479                         u64 src_off, u64 len, u64 dest_off);
 480         int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
 481                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
 482                         u64 dest_off);
 483         int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
 484         ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
 485                         const unsigned char *, const unsigned char *, char *,
 486                         size_t, struct cifs_sb_info *);
 487         int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
 488                         const char *, const void *, const __u16,
 489                         const struct nls_table *, struct cifs_sb_info *);
 490         struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
 491                         const char *, u32 *, u32);
 492         struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
 493                         const struct cifs_fid *, u32 *, u32);
 494         int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
 495                         int);
 496         /* writepages retry size */
 497         unsigned int (*wp_retry_size)(struct inode *);
 498         /* get mtu credits */
 499         int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
 500                                 unsigned int *, struct cifs_credits *);
 501         /* adjust previously taken mtu credits to request size */
 502         int (*adjust_credits)(struct TCP_Server_Info *server,
 503                               struct cifs_credits *credits,
 504                               const unsigned int payload_size);
 505         /* check if we need to issue closedir */
 506         bool (*dir_needs_close)(struct cifsFileInfo *);
 507         long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
 508                           loff_t);
 509         /* init transform request - used for encryption for now */
 510         int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
 511                                  struct smb_rqst *, struct smb_rqst *);
 512         int (*is_transform_hdr)(void *buf);
 513         int (*receive_transform)(struct TCP_Server_Info *,
 514                                  struct mid_q_entry **, char **, int *);
 515         enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
 516                             enum securityEnum);
 517         int (*next_header)(char *);
 518         /* ioctl passthrough for query_info */
 519         int (*ioctl_query_info)(const unsigned int xid,
 520                                 struct cifs_tcon *tcon,
 521                                 struct cifs_sb_info *cifs_sb,
 522                                 __le16 *path, int is_dir,
 523                                 unsigned long p);
 524         /* make unix special files (block, char, fifo, socket) */
 525         int (*make_node)(unsigned int xid,
 526                          struct inode *inode,
 527                          struct dentry *dentry,
 528                          struct cifs_tcon *tcon,
 529                          const char *full_path,
 530                          umode_t mode,
 531                          dev_t device_number);
 532         /* version specific fiemap implementation */
 533         int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
 534                       struct fiemap_extent_info *, u64, u64);
 535         /* version specific llseek implementation */
 536         loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
 537         /* Check for STATUS_IO_TIMEOUT */
 538         bool (*is_status_io_timeout)(char *buf);
 539         /* Check for STATUS_NETWORK_NAME_DELETED */
 540         void (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv);
 541 };
 542
 543 struct smb_version_values {
 544         char            *version_string;
 545         __u16           protocol_id;
 546         __u32           req_capabilities;
 547         __u32           large_lock_type;
 548         __u32           exclusive_lock_type;
 549         __u32           shared_lock_type;
 550         __u32           unlock_lock_type;
 551         size_t          header_preamble_size;
 552         size_t          header_size;
 553         size_t          max_header_size;
 554         size_t          read_rsp_size;
 555         __le16          lock_cmd;
 556         unsigned int    cap_unix;
 557         unsigned int    cap_nt_find;
 558         unsigned int    cap_large_files;
 559         __u16           signing_enabled;
 560         __u16           signing_required;
 561         size_t          create_lease_size;
 562 };
 563
 564 #define HEADER_SIZE(server) (server->vals->header_size)
 565 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
 566 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size)
 567 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server))
 568
 569 /**
 570  * CIFS superblock mount flags (mnt_cifs_flags) to consider when
 571  * trying to reuse existing superblock for a new mount
 572  */
 573 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
 574                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
 575                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
 576                          CIFS_MOUNT_MAP_SFM_CHR | \
 577                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
 578                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
 579                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
 580                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
 581                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
 582                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
 583                          CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
 584                          CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
 585                          CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
 586                          CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
 587
 588 /**
 589  * Generic VFS superblock mount flags (s_flags) to consider when
 590  * trying to reuse existing superblock for a new mount
 591  */
 592 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
 593                       SB_NODEV | SB_SYNCHRONOUS)
 594
 595 struct cifs_mnt_data {
 596         struct cifs_sb_info *cifs_sb;
 597         struct smb3_fs_context *ctx;
 598         int flags;
 599 };
 600
 601 static inline unsigned int
 602 get_rfc1002_length(void *buf)
 603 {
 604         return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
 605 }
 606
 607 static inline void
 608 inc_rfc1001_len(void *buf, int count)
 609 {
 610         be32_add_cpu((__be32 *)buf, count);
 611 }
 612
 613 struct TCP_Server_Info {
 614         struct list_head tcp_ses_list;
 615         struct list_head smb_ses_list;
 616         spinlock_t srv_lock;  /* protect anything here that is not protected */
 617         __u64 conn_id; /* connection identifier (useful for debugging) */
 618         int srv_count; /* reference counter */
 619         /* 15 character server name + 0x20 16th byte indicating type = srv */
 620         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 621         struct smb_version_operations   *ops;
 622         struct smb_version_values       *vals;
 623         /* updates to tcpStatus protected by cifs_tcp_ses_lock */
 624         enum statusEnum tcpStatus; /* what we think the status is */
 625         char *hostname; /* hostname portion of UNC string */
 626         struct socket *ssocket;
 627         struct sockaddr_storage dstaddr;
 628         struct sockaddr_storage srcaddr; /* locally bind to this IP */
 629 #ifdef CONFIG_NET_NS
 630         struct net *net;
 631 #endif
 632         wait_queue_head_t response_q;
 633         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
 634         spinlock_t mid_lock;  /* protect mid queue and it's entries */
 635         struct list_head pending_mid_q;
 636         bool noblocksnd;                /* use blocking sendmsg */
 637         bool noautotune;                /* do not autotune send buf sizes */
 638         bool nosharesock;
 639         bool tcp_nodelay;
 640         unsigned int credits;  /* send no more requests at once */
 641         unsigned int max_credits; /* can override large 32000 default at mnt */
 642         unsigned int in_flight;  /* number of requests on the wire to server */
 643         unsigned int max_in_flight; /* max number of requests that were on wire */
 644         spinlock_t req_lock;  /* protect the two values above */
 645         struct mutex _srv_mutex;
 646         unsigned int nofs_flag;
 647         struct task_struct *tsk;
 648         char server_GUID[16];
 649         __u16 sec_mode;
 650         bool sign; /* is signing enabled on this connection? */
 651         bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
 652         bool session_estab; /* mark when very first sess is established */
 653         int echo_credits;  /* echo reserved slots */
 654         int oplock_credits;  /* oplock break reserved slots */
 655         bool echoes:1; /* enable echoes */
 656         __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
 657         u16 dialect; /* dialect index that server chose */
 658         bool oplocks:1; /* enable oplocks */
 659         unsigned int maxReq;    /* Clients should submit no more */
 660         /* than maxReq distinct unanswered SMBs to the server when using  */
 661         /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
 662         unsigned int maxBuf;    /* maxBuf specifies the maximum */
 663         /* message size the server can send or receive for non-raw SMBs */
 664         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
 665         /* when socket is setup (and during reconnect) before NegProt sent */
 666         unsigned int max_rw;    /* maxRw specifies the maximum */
 667         /* message size the server can send or receive for */
 668         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
 669         unsigned int capabilities; /* selective disabling of caps by smb sess */
 670         int timeAdj;  /* Adjust for difference in server time zone in sec */
 671         __u64 CurrentMid;         /* multiplex id - rotating counter, protected by GlobalMid_Lock */
 672         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
 673         /* 16th byte of RFC1001 workstation name is always null */
 674         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 675         __u32 sequence_number; /* for signing, protected by srv_mutex */
 676         __u32 reconnect_instance; /* incremented on each reconnect */
 677         struct session_key session_key;
 678         unsigned long lstrp; /* when we got last response from this server */
 679         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
 680 #define CIFS_NEGFLAVOR_UNENCAP  1       /* wct == 17, but no ext_sec */
 681 #define CIFS_NEGFLAVOR_EXTENDED 2       /* wct == 17, ext_sec bit set */
 682         char    negflavor;      /* NEGOTIATE response flavor */
 683         /* extended security flavors that server supports */
 684         bool    sec_ntlmssp;            /* supports NTLMSSP */
 685         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
 686         bool    sec_kerberos;           /* supports plain Kerberos */
 687         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
 688         bool    large_buf;              /* is current buffer large? */
 689         /* use SMBD connection instead of socket */
 690         bool    rdma;
 691         /* point to the SMBD connection if RDMA is used instead of socket */
 692         struct smbd_connection *smbd_conn;
 693         struct delayed_work     echo; /* echo ping workqueue job */
 694         struct delayed_work     resolve; /* dns resolution workqueue job */
 695         char    *smallbuf;      /* pointer to current "small" buffer */
 696         char    *bigbuf;        /* pointer to current "big" buffer */
 697         /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
 698         unsigned int pdu_size;
 699         unsigned int total_read; /* total amount of data read in this pass */
 700         atomic_t in_send; /* requests trying to send */
 701         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
 702 #ifdef CONFIG_CIFS_STATS2
 703         atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
 704         atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
 705         __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
 706         __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
 707         __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
 708 #endif /* STATS2 */
 709         unsigned int    max_read;
 710         unsigned int    max_write;
 711         unsigned int    min_offload;
 712         __le16  compress_algorithm;
 713         __u16   signing_algorithm;
 714         __le16  cipher_type;
 715          /* save initital negprot hash */
 716         __u8    preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
 717         bool    signing_negotiated; /* true if valid signing context rcvd from server */
 718         bool    posix_ext_supported;
 719         struct delayed_work reconnect; /* reconnect workqueue job */
 720         struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
 721         unsigned long echo_interval;
 722
 723         /*
 724          * Number of targets available for reconnect. The more targets
 725          * the more tasks have to wait to let the demultiplex thread
 726          * reconnect.
 727          */
 728         int nr_targets;
 729         bool noblockcnt; /* use non-blocking connect() */
 730
 731         /*
 732          * If this is a session channel,
 733          * primary_server holds the ref-counted
 734          * pointer to primary channel connection for the session.
 735          */
 736 #define CIFS_SERVER_IS_CHAN(server)     (!!(server)->primary_server)
 737         struct TCP_Server_Info *primary_server;
 738
 739 #ifdef CONFIG_CIFS_SWN_UPCALL
 740         bool use_swn_dstaddr;
 741         struct sockaddr_storage swn_dstaddr;
 742 #endif
 743         struct mutex refpath_lock; /* protects leaf_fullpath */
 744         /*
 745          * Canonical DFS full paths that were used to chase referrals in mount and reconnect.
 746          *
 747          * origin_fullpath: first or original referral path
 748          * leaf_fullpath: last referral path (might be changed due to nested links in reconnect)
 749          *
 750          * current_fullpath: pointer to either origin_fullpath or leaf_fullpath
 751          * NOTE: cannot be accessed outside cifs_reconnect() and smb2_reconnect()
 752          *
 753          * format: \\HOST\SHARE\[OPTIONAL PATH]
 754          */
 755         char *origin_fullpath, *leaf_fullpath, *current_fullpath;
 756 };
 757
 758 static inline bool is_smb1(struct TCP_Server_Info *server)
 759 {
 760         return HEADER_PREAMBLE_SIZE(server) != 0;
 761 }
 762
 763 static inline void cifs_server_lock(struct TCP_Server_Info *server)
 764 {
 765         unsigned int nofs_flag = memalloc_nofs_save();
 766
 767         mutex_lock(&server->_srv_mutex);
 768         server->nofs_flag = nofs_flag;
 769 }
 770
 771 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
 772 {
 773         unsigned int nofs_flag = server->nofs_flag;
 774
 775         mutex_unlock(&server->_srv_mutex);
 776         memalloc_nofs_restore(nofs_flag);
 777 }
 778
 779 struct cifs_credits {
 780         unsigned int value;
 781         unsigned int instance;
 782 };
 783
 784 static inline unsigned int
 785 in_flight(struct TCP_Server_Info *server)
 786 {
 787         unsigned int num;
 788
 789         spin_lock(&server->req_lock);
 790         num = server->in_flight;
 791         spin_unlock(&server->req_lock);
 792         return num;
 793 }
 794
 795 static inline bool
 796 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
 797 {
 798         int num;
 799
 800         spin_lock(&server->req_lock);
 801         num = *credits;
 802         spin_unlock(&server->req_lock);
 803         return num >= num_credits;
 804 }
 805
 806 static inline void
 807 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
 808             const int optype)
 809 {
 810         server->ops->add_credits(server, credits, optype);
 811 }
 812
 813 static inline void
 814 add_credits_and_wake_if(struct TCP_Server_Info *server,
 815                         const struct cifs_credits *credits, const int optype)
 816 {
 817         if (credits->value) {
 818                 server->ops->add_credits(server, credits, optype);
 819                 wake_up(&server->request_q);
 820         }
 821 }
 822
 823 static inline void
 824 set_credits(struct TCP_Server_Info *server, const int val)
 825 {
 826         server->ops->set_credits(server, val);
 827 }
 828
 829 static inline int
 830 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
 831                const unsigned int payload_size)
 832 {
 833         return server->ops->adjust_credits ?
 834                 server->ops->adjust_credits(server, credits, payload_size) : 0;
 835 }
 836
 837 static inline __le64
 838 get_next_mid64(struct TCP_Server_Info *server)
 839 {
 840         return cpu_to_le64(server->ops->get_next_mid(server));
 841 }
 842
 843 static inline __le16
 844 get_next_mid(struct TCP_Server_Info *server)
 845 {
 846         __u16 mid = server->ops->get_next_mid(server);
 847         /*
 848          * The value in the SMB header should be little endian for easy
 849          * on-the-wire decoding.
 850          */
 851         return cpu_to_le16(mid);
 852 }
 853
 854 static inline void
 855 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
 856 {
 857         if (server->ops->revert_current_mid)
 858                 server->ops->revert_current_mid(server, val);
 859 }
 860
 861 static inline void
 862 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
 863                             const struct smb2_hdr *shdr)
 864 {
 865         unsigned int num = le16_to_cpu(shdr->CreditCharge);
 866
 867         return revert_current_mid(server, num > 0 ? num : 1);
 868 }
 869
 870 static inline __u16
 871 get_mid(const struct smb_hdr *smb)
 872 {
 873         return le16_to_cpu(smb->Mid);
 874 }
 875
 876 static inline bool
 877 compare_mid(__u16 mid, const struct smb_hdr *smb)
 878 {
 879         return mid == le16_to_cpu(smb->Mid);
 880 }
 881
 882 /*
 883  * When the server supports very large reads and writes via POSIX extensions,
 884  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
 885  * including the RFC1001 length.
 886  *
 887  * Note that this might make for "interesting" allocation problems during
 888  * writeback however as we have to allocate an array of pointers for the
 889  * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
 890  *
 891  * For reads, there is a similar problem as we need to allocate an array
 892  * of kvecs to handle the receive, though that should only need to be done
 893  * once.
 894  */
 895 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
 896 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
 897
 898 /*
 899  * When the server doesn't allow large posix writes, only allow a rsize/wsize
 900  * of 2^17-1 minus the size of the call header. That allows for a read or
 901  * write up to the maximum size described by RFC1002.
 902  */
 903 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
 904 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
 905
 906 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
 907
 908 /*
 909  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
 910  * those values when posix extensions aren't in force. In actuality here, we
 911  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
 912  * to be ok with the extra byte even though Windows doesn't send writes that
 913  * are that large.
 914  *
 915  * Citation:
 916  *
 917  * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
 918  */
 919 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
 920 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
 921
 922 /*
 923  * Macros to allow the TCP_Server_Info->net field and related code to drop out
 924  * when CONFIG_NET_NS isn't set.
 925  */
 926
 927 #ifdef CONFIG_NET_NS
 928
 929 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 930 {
 931         return srv->net;
 932 }
 933
 934 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 935 {
 936         srv->net = net;
 937 }
 938
 939 #else
 940
 941 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 942 {
 943         return &init_net;
 944 }
 945
 946 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 947 {
 948 }
 949
 950 #endif
 951
 952 struct cifs_server_iface {
 953         struct list_head iface_head;
 954         struct kref refcount;
 955         size_t speed;
 956         unsigned int rdma_capable : 1;
 957         unsigned int rss_capable : 1;
 958         unsigned int is_active : 1; /* unset if non existent */
 959         struct sockaddr_storage sockaddr;
 960 };
 961
 962 /* release iface when last ref is dropped */
 963 static inline void
 964 release_iface(struct kref *ref)
 965 {
 966         struct cifs_server_iface *iface = container_of(ref,
 967                                                        struct cifs_server_iface,
 968                                                        refcount);
 969         list_del_init(&iface->iface_head);
 970         kfree(iface);
 971 }
 972
 973 /*
 974  * compare two interfaces a and b
 975  * return 0 if everything matches.
 976  * return 1 if a has higher link speed, or rdma capable, or rss capable
 977  * return -1 otherwise.
 978  */
 979 static inline int
 980 iface_cmp(struct cifs_server_iface *a, struct cifs_server_iface *b)
 981 {
 982         int cmp_ret = 0;
 983
 984         WARN_ON(!a || !b);
 985         if (a->speed == b->speed) {
 986                 if (a->rdma_capable == b->rdma_capable) {
 987                         if (a->rss_capable == b->rss_capable) {
 988                                 cmp_ret = memcmp(&a->sockaddr, &b->sockaddr,
 989                                                  sizeof(a->sockaddr));
 990                                 if (!cmp_ret)
 991                                         return 0;
 992                                 else if (cmp_ret > 0)
 993                                         return 1;
 994                                 else
 995                                         return -1;
 996                         } else if (a->rss_capable > b->rss_capable)
 997                                 return 1;
 998                         else
 999                                 return -1;
1000                 } else if (a->rdma_capable > b->rdma_capable)
1001                         return 1;
1002                 else
1003                         return -1;
1004         } else if (a->speed > b->speed)
1005                 return 1;
1006         else
1007                 return -1;
1008 }
1009
1010 struct cifs_chan {
1011         unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
1012         struct TCP_Server_Info *server;
1013         struct cifs_server_iface *iface; /* interface in use */
1014         __u8 signkey[SMB3_SIGN_KEY_SIZE];
1015 };
1016
1017 /*
1018  * Session structure.  One of these for each uid session with a particular host
1019  */
1020 struct cifs_ses {
1021         struct list_head smb_ses_list;
1022         struct list_head rlist; /* reconnect list */
1023         struct list_head tcon_list;
1024         struct cifs_tcon *tcon_ipc;
1025         spinlock_t ses_lock;  /* protect anything here that is not protected */
1026         struct mutex session_mutex;
1027         struct TCP_Server_Info *server; /* pointer to server info */
1028         int ses_count;          /* reference counter */
1029         enum ses_status_enum ses_status;  /* updates protected by cifs_tcp_ses_lock */
1030         unsigned int overrideSecFlg; /* if non-zero override global sec flags */
1031         char *serverOS;         /* name of operating system underlying server */
1032         char *serverNOS;        /* name of network operating system of server */
1033         char *serverDomain;     /* security realm of server */
1034         __u64 Suid;             /* remote smb uid  */
1035         kuid_t linux_uid;       /* overriding owner of files on the mount */
1036         kuid_t cred_uid;        /* owner of credentials */
1037         unsigned int capabilities;
1038         char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1039         char *user_name;        /* must not be null except during init of sess
1040                                    and after mount option parsing we fill it */
1041         char *domainName;
1042         char *password;
1043         char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1044         struct session_key auth_key;
1045         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1046         enum securityEnum sectype; /* what security flavor was specified? */
1047         bool sign;              /* is signing required? */
1048         bool domainAuto:1;
1049         __u16 session_flags;
1050         __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1051         __u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1052         __u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1053         __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1054
1055         /*
1056          * Network interfaces available on the server this session is
1057          * connected to.
1058          *
1059          * Other channels can be opened by connecting and binding this
1060          * session to interfaces from this list.
1061          *
1062          * iface_lock should be taken when accessing any of these fields
1063          */
1064         spinlock_t iface_lock;
1065         /* ========= begin: protected by iface_lock ======== */
1066         struct list_head iface_list;
1067         size_t iface_count;
1068         unsigned long iface_last_update; /* jiffies */
1069         /* ========= end: protected by iface_lock ======== */
1070
1071         spinlock_t chan_lock;
1072         /* ========= begin: protected by chan_lock ======== */
1073 #define CIFS_MAX_CHANNELS 16
1074 #define CIFS_ALL_CHANNELS_SET(ses)      \
1075         ((1UL << (ses)->chan_count) - 1)
1076 #define CIFS_ALL_CHANS_GOOD(ses)                \
1077         (!(ses)->chans_need_reconnect)
1078 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses)      \
1079         ((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1080 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses)  \
1081         ((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1082 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index)   \
1083         test_bit((index), &(ses)->chans_need_reconnect)
1084 #define CIFS_CHAN_IN_RECONNECT(ses, index)      \
1085         ((ses)->chans[(index)].in_reconnect)
1086
1087         struct cifs_chan chans[CIFS_MAX_CHANNELS];
1088         size_t chan_count;
1089         size_t chan_max;
1090         atomic_t chan_seq; /* round robin state */
1091
1092         /*
1093          * chans_need_reconnect is a bitmap indicating which of the channels
1094          * under this smb session needs to be reconnected.
1095          * If not multichannel session, only one bit will be used.
1096          *
1097          * We will ask for sess and tcon reconnection only if all the
1098          * channels are marked for needing reconnection. This will
1099          * enable the sessions on top to continue to live till any
1100          * of the channels below are active.
1101          */
1102         unsigned long chans_need_reconnect;
1103         /* ========= end: protected by chan_lock ======== */
1104         struct cifs_ses *dfs_root_ses;
1105 };
1106
1107 static inline bool
1108 cap_unix(struct cifs_ses *ses)
1109 {
1110         return ses->server->vals->cap_unix & ses->capabilities;
1111 }
1112
1113 /*
1114  * common struct for holding inode info when searching for or updating an
1115  * inode with new info
1116  */
1117
1118 #define CIFS_FATTR_DFS_REFERRAL         0x1
1119 #define CIFS_FATTR_DELETE_PENDING       0x2
1120 #define CIFS_FATTR_NEED_REVAL           0x4
1121 #define CIFS_FATTR_INO_COLLISION        0x8
1122 #define CIFS_FATTR_UNKNOWN_NLINK        0x10
1123 #define CIFS_FATTR_FAKE_ROOT_INO        0x20
1124
1125 struct cifs_fattr {
1126         u32             cf_flags;
1127         u32             cf_cifsattrs;
1128         u64             cf_uniqueid;
1129         u64             cf_eof;
1130         u64             cf_bytes;
1131         u64             cf_createtime;
1132         kuid_t          cf_uid;
1133         kgid_t          cf_gid;
1134         umode_t         cf_mode;
1135         dev_t           cf_rdev;
1136         unsigned int    cf_nlink;
1137         unsigned int    cf_dtype;
1138         struct timespec64 cf_atime;
1139         struct timespec64 cf_mtime;
1140         struct timespec64 cf_ctime;
1141         u32             cf_cifstag;
1142         char            *cf_symlink_target;
1143 };
1144
1145 /*
1146  * there is one of these for each connection to a resource on a particular
1147  * session
1148  */
1149 struct cifs_tcon {
1150         struct list_head tcon_list;
1151         int tc_count;
1152         struct list_head rlist; /* reconnect list */
1153         spinlock_t tc_lock;  /* protect anything here that is not protected */
1154         atomic_t num_local_opens;  /* num of all opens including disconnected */
1155         atomic_t num_remote_opens; /* num of all network opens on server */
1156         struct list_head openFileList;
1157         spinlock_t open_file_lock; /* protects list above */
1158         struct cifs_ses *ses;   /* pointer to session associated with */
1159         char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1160         char *nativeFileSystem;
1161         char *password;         /* for share-level security */
1162         __u32 tid;              /* The 4 byte tree id */
1163         __u16 Flags;            /* optional support bits */
1164         enum tid_status_enum status;
1165         atomic_t num_smbs_sent;
1166         union {
1167                 struct {
1168                         atomic_t num_writes;
1169                         atomic_t num_reads;
1170                         atomic_t num_flushes;
1171                         atomic_t num_oplock_brks;
1172                         atomic_t num_opens;
1173                         atomic_t num_closes;
1174                         atomic_t num_deletes;
1175                         atomic_t num_mkdirs;
1176                         atomic_t num_posixopens;
1177                         atomic_t num_posixmkdirs;
1178                         atomic_t num_rmdirs;
1179                         atomic_t num_renames;
1180                         atomic_t num_t2renames;
1181                         atomic_t num_ffirst;
1182                         atomic_t num_fnext;
1183                         atomic_t num_fclose;
1184                         atomic_t num_hardlinks;
1185                         atomic_t num_symlinks;
1186                         atomic_t num_locks;
1187                         atomic_t num_acl_get;
1188                         atomic_t num_acl_set;
1189                 } cifs_stats;
1190                 struct {
1191                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1192                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1193                 } smb2_stats;
1194         } stats;
1195         __u64    bytes_read;
1196         __u64    bytes_written;
1197         spinlock_t stat_lock;  /* protects the two fields above */
1198         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1199         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1200         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1201         bool ipc:1;   /* set if connection to IPC$ share (always also pipe) */
1202         bool pipe:1;  /* set if connection to pipe share */
1203         bool print:1; /* set if connection to printer share */
1204         bool retry:1;
1205         bool nocase:1;
1206         bool nohandlecache:1; /* if strange server resource prob can turn off */
1207         bool nodelete:1;
1208         bool seal:1;      /* transport encryption for this mounted share */
1209         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
1210                                 for this mount even if server would support */
1211         bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1212         bool local_lease:1; /* check leases (only) on local system not remote */
1213         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1214         bool broken_sparse_sup; /* if server or share does not support sparse */
1215         bool need_reconnect:1; /* connection reset, tid now invalid */
1216         bool need_reopen_files:1; /* need to reopen tcon file handles */
1217         bool use_resilient:1; /* use resilient instead of durable handles */
1218         bool use_persistent:1; /* use persistent instead of durable handles */
1219         bool no_lease:1;    /* Do not request leases on files or directories */
1220         bool use_witness:1; /* use witness protocol */
1221         __le32 capabilities;
1222         __u32 share_flags;
1223         __u32 maximal_access;
1224         __u32 vol_serial_number;
1225         __le64 vol_create_time;
1226         __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1227         __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1228         __u32 ss_flags;         /* sector size flags */
1229         __u32 perf_sector_size; /* best sector size for perf */
1230         __u32 max_chunks;
1231         __u32 max_bytes_chunk;
1232         __u32 max_bytes_copy;
1233 #ifdef CONFIG_CIFS_FSCACHE
1234         u64 resource_id;                /* server resource id */
1235         struct fscache_volume *fscache; /* cookie for share */
1236 #endif
1237         struct list_head pending_opens; /* list of incomplete opens */
1238         struct cached_fids *cfids;
1239         /* BB add field for back pointer to sb struct(s)? */
1240 #ifdef CONFIG_CIFS_DFS_UPCALL
1241         struct list_head ulist; /* cache update list */
1242 #endif
1243         struct delayed_work     query_interfaces; /* query interfaces workqueue job */
1244 };
1245
1246 /*
1247  * This is a refcounted and timestamped container for a tcon pointer. The
1248  * container holds a tcon reference. It is considered safe to free one of
1249  * these when the tl_count goes to 0. The tl_time is the time of the last
1250  * "get" on the container.
1251  */
1252 struct tcon_link {
1253         struct rb_node          tl_rbnode;
1254         kuid_t                  tl_uid;
1255         unsigned long           tl_flags;
1256 #define TCON_LINK_MASTER        0
1257 #define TCON_LINK_PENDING       1
1258 #define TCON_LINK_IN_TREE       2
1259         unsigned long           tl_time;
1260         atomic_t                tl_count;
1261         struct cifs_tcon        *tl_tcon;
1262 };
1263
1264 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1265 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1266
1267 static inline struct cifs_tcon *
1268 tlink_tcon(struct tcon_link *tlink)
1269 {
1270         return tlink->tl_tcon;
1271 }
1272
1273 static inline struct tcon_link *
1274 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1275 {
1276         return cifs_sb->master_tlink;
1277 }
1278
1279 extern void cifs_put_tlink(struct tcon_link *tlink);
1280
1281 static inline struct tcon_link *
1282 cifs_get_tlink(struct tcon_link *tlink)
1283 {
1284         if (tlink && !IS_ERR(tlink))
1285                 atomic_inc(&tlink->tl_count);
1286         return tlink;
1287 }
1288
1289 /* This function is always expected to succeed */
1290 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1291
1292 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1293
1294 struct cifs_pending_open {
1295         struct list_head olist;
1296         struct tcon_link *tlink;
1297         __u8 lease_key[16];
1298         __u32 oplock;
1299 };
1300
1301 struct cifs_deferred_close {
1302         struct list_head dlist;
1303         struct tcon_link *tlink;
1304         __u16  netfid;
1305         __u64  persistent_fid;
1306         __u64  volatile_fid;
1307 };
1308
1309 /*
1310  * This info hangs off the cifsFileInfo structure, pointed to by llist.
1311  * This is used to track byte stream locks on the file
1312  */
1313 struct cifsLockInfo {
1314         struct list_head llist; /* pointer to next cifsLockInfo */
1315         struct list_head blist; /* pointer to locks blocked on this */
1316         wait_queue_head_t block_q;
1317         __u64 offset;
1318         __u64 length;
1319         __u32 pid;
1320         __u16 type;
1321         __u16 flags;
1322 };
1323
1324 /*
1325  * One of these for each open instance of a file
1326  */
1327 struct cifs_search_info {
1328         loff_t index_of_last_entry;
1329         __u16 entries_in_buffer;
1330         __u16 info_level;
1331         __u32 resume_key;
1332         char *ntwrk_buf_start;
1333         char *srch_entries_start;
1334         char *last_entry;
1335         const char *presume_name;
1336         unsigned int resume_name_len;
1337         bool endOfSearch:1;
1338         bool emptyDir:1;
1339         bool unicode:1;
1340         bool smallBuf:1; /* so we know which buf_release function to call */
1341 };
1342
1343 #define ACL_NO_MODE     ((umode_t)(-1))
1344 struct cifs_open_parms {
1345         struct cifs_tcon *tcon;
1346         struct cifs_sb_info *cifs_sb;
1347         int disposition;
1348         int desired_access;
1349         int create_options;
1350         const char *path;
1351         struct cifs_fid *fid;
1352         umode_t mode;
1353         bool reconnect:1;
1354 };
1355
1356 struct cifs_fid {
1357         __u16 netfid;
1358         __u64 persistent_fid;   /* persist file id for smb2 */
1359         __u64 volatile_fid;     /* volatile file id for smb2 */
1360         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for smb2 */
1361         __u8 create_guid[16];
1362         __u32 access;
1363         struct cifs_pending_open *pending_open;
1364         unsigned int epoch;
1365 #ifdef CONFIG_CIFS_DEBUG2
1366         __u64 mid;
1367 #endif /* CIFS_DEBUG2 */
1368         bool purge_cache;
1369 };
1370
1371 struct cifs_fid_locks {
1372         struct list_head llist;
1373         struct cifsFileInfo *cfile;     /* fid that owns locks */
1374         struct list_head locks;         /* locks held by fid above */
1375 };
1376
1377 struct cifsFileInfo {
1378         /* following two lists are protected by tcon->open_file_lock */
1379         struct list_head tlist; /* pointer to next fid owned by tcon */
1380         struct list_head flist; /* next fid (file instance) for this inode */
1381         /* lock list below protected by cifsi->lock_sem */
1382         struct cifs_fid_locks *llist;   /* brlocks held by this fid */
1383         kuid_t uid;             /* allows finding which FileInfo structure */
1384         __u32 pid;              /* process id who opened file */
1385         struct cifs_fid fid;    /* file id from remote */
1386         struct list_head rlist; /* reconnect list */
1387         /* BB add lock scope info here if needed */
1388         /* lock scope id (0 if none) */
1389         struct dentry *dentry;
1390         struct tcon_link *tlink;
1391         unsigned int f_flags;
1392         bool invalidHandle:1;   /* file closed via session abend */
1393         bool swapfile:1;
1394         bool oplock_break_cancelled:1;
1395         unsigned int oplock_epoch; /* epoch from the lease break */
1396         __u32 oplock_level; /* oplock/lease level from the lease break */
1397         int count;
1398         spinlock_t file_info_lock; /* protects four flag/count fields above */
1399         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1400         struct cifs_search_info srch_inf;
1401         struct work_struct oplock_break; /* work for oplock breaks */
1402         struct work_struct put; /* work for the final part of _put */
1403         struct delayed_work deferred;
1404         bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1405         char *symlink_target;
1406 };
1407
1408 struct cifs_io_parms {
1409         __u16 netfid;
1410         __u64 persistent_fid;   /* persist file id for smb2 */
1411         __u64 volatile_fid;     /* volatile file id for smb2 */
1412         __u32 pid;
1413         __u64 offset;
1414         unsigned int length;
1415         struct cifs_tcon *tcon;
1416         struct TCP_Server_Info *server;
1417 };
1418
1419 struct cifs_aio_ctx {
1420         struct kref             refcount;
1421         struct list_head        list;
1422         struct mutex            aio_mutex;
1423         struct completion       done;
1424         struct iov_iter         iter;
1425         struct kiocb            *iocb;
1426         struct cifsFileInfo     *cfile;
1427         struct bio_vec          *bv;
1428         loff_t                  pos;
1429         unsigned int            npages;
1430         ssize_t                 rc;
1431         unsigned int            len;
1432         unsigned int            total_len;
1433         bool                    should_dirty;
1434         /*
1435          * Indicates if this aio_ctx is for direct_io,
1436          * If yes, iter is a copy of the user passed iov_iter
1437          */
1438         bool                    direct_io;
1439 };
1440
1441 /* asynchronous read support */
1442 struct cifs_readdata {
1443         struct kref                     refcount;
1444         struct list_head                list;
1445         struct completion               done;
1446         struct cifsFileInfo             *cfile;
1447         struct address_space            *mapping;
1448         struct cifs_aio_ctx             *ctx;
1449         __u64                           offset;
1450         unsigned int                    bytes;
1451         unsigned int                    got_bytes;
1452         pid_t                           pid;
1453         int                             result;
1454         struct work_struct              work;
1455         int (*read_into_pages)(struct TCP_Server_Info *server,
1456                                 struct cifs_readdata *rdata,
1457                                 unsigned int len);
1458         int (*copy_into_pages)(struct TCP_Server_Info *server,
1459                                 struct cifs_readdata *rdata,
1460                                 struct iov_iter *iter);
1461         struct kvec                     iov[2];
1462         struct TCP_Server_Info          *server;
1463 #ifdef CONFIG_CIFS_SMB_DIRECT
1464         struct smbd_mr                  *mr;
1465 #endif
1466         unsigned int                    pagesz;
1467         unsigned int                    page_offset;
1468         unsigned int                    tailsz;
1469         struct cifs_credits             credits;
1470         unsigned int                    nr_pages;
1471         struct page                     **pages;
1472 };
1473
1474 /* asynchronous write support */
1475 struct cifs_writedata {
1476         struct kref                     refcount;
1477         struct list_head                list;
1478         struct completion               done;
1479         enum writeback_sync_modes       sync_mode;
1480         struct work_struct              work;
1481         struct cifsFileInfo             *cfile;
1482         struct cifs_aio_ctx             *ctx;
1483         __u64                           offset;
1484         pid_t                           pid;
1485         unsigned int                    bytes;
1486         int                             result;
1487         struct TCP_Server_Info          *server;
1488 #ifdef CONFIG_CIFS_SMB_DIRECT
1489         struct smbd_mr                  *mr;
1490 #endif
1491         unsigned int                    pagesz;
1492         unsigned int                    page_offset;
1493         unsigned int                    tailsz;
1494         struct cifs_credits             credits;
1495         unsigned int                    nr_pages;
1496         struct page                     **pages;
1497 };
1498
1499 /*
1500  * Take a reference on the file private data. Must be called with
1501  * cfile->file_info_lock held.
1502  */
1503 static inline void
1504 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1505 {
1506         ++cifs_file->count;
1507 }
1508
1509 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1510 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1511                        bool offload);
1512 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1513
1514 #define CIFS_CACHE_READ_FLG     1
1515 #define CIFS_CACHE_HANDLE_FLG   2
1516 #define CIFS_CACHE_RH_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1517 #define CIFS_CACHE_WRITE_FLG    4
1518 #define CIFS_CACHE_RW_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1519 #define CIFS_CACHE_RHW_FLG      (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1520
1521 #define CIFS_CACHE_READ(cinode) ((cinode->oplock & CIFS_CACHE_READ_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RO_CACHE))
1522 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1523 #define CIFS_CACHE_WRITE(cinode) ((cinode->oplock & CIFS_CACHE_WRITE_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RW_CACHE))
1524
1525 /*
1526  * One of these for each file inode
1527  */
1528
1529 struct cifsInodeInfo {
1530         struct netfs_inode netfs; /* Netfslib context and vfs inode */
1531         bool can_cache_brlcks;
1532         struct list_head llist; /* locks helb by this inode */
1533         /*
1534          * NOTE: Some code paths call down_read(lock_sem) twice, so
1535          * we must always use cifs_down_write() instead of down_write()
1536          * for this semaphore to avoid deadlocks.
1537          */
1538         struct rw_semaphore lock_sem;   /* protect the fields above */
1539         /* BB add in lists for dirty pages i.e. write caching info for oplock */
1540         struct list_head openFileList;
1541         spinlock_t      open_file_lock; /* protects openFileList */
1542         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1543         unsigned int oplock;            /* oplock/lease level we have */
1544         unsigned int epoch;             /* used to track lease state changes */
1545 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1546 #define CIFS_INODE_PENDING_WRITERS        (1) /* Writes in progress */
1547 #define CIFS_INODE_FLAG_UNUSED            (2) /* Unused flag */
1548 #define CIFS_INO_DELETE_PENDING           (3) /* delete pending on server */
1549 #define CIFS_INO_INVALID_MAPPING          (4) /* pagecache is invalid */
1550 #define CIFS_INO_LOCK                     (5) /* lock bit for synchronization */
1551 #define CIFS_INO_MODIFIED_ATTR            (6) /* Indicate change in mtime/ctime */
1552 #define CIFS_INO_CLOSE_ON_LOCK            (7) /* Not to defer the close when lock is set */
1553         unsigned long flags;
1554         spinlock_t writers_lock;
1555         unsigned int writers;           /* Number of writers on this inode */
1556         unsigned long time;             /* jiffies of last update of inode */
1557         u64  server_eof;                /* current file size on server -- protected by i_lock */
1558         u64  uniqueid;                  /* server inode number */
1559         u64  createtime;                /* creation time on server */
1560         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for this inode */
1561         struct list_head deferred_closes; /* list of deferred closes */
1562         spinlock_t deferred_lock; /* protection on deferred list */
1563         bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1564         char *symlink_target;
1565 };
1566
1567 static inline struct cifsInodeInfo *
1568 CIFS_I(struct inode *inode)
1569 {
1570         return container_of(inode, struct cifsInodeInfo, netfs.inode);
1571 }
1572
1573 static inline struct cifs_sb_info *
1574 CIFS_SB(struct super_block *sb)
1575 {
1576         return sb->s_fs_info;
1577 }
1578
1579 static inline struct cifs_sb_info *
1580 CIFS_FILE_SB(struct file *file)
1581 {
1582         return CIFS_SB(file_inode(file)->i_sb);
1583 }
1584
1585 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1586 {
1587         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1588                 return '/';
1589         else
1590                 return '\\';
1591 }
1592
1593 static inline void
1594 convert_delimiter(char *path, char delim)
1595 {
1596         char old_delim, *pos;
1597
1598         if (delim == '/')
1599                 old_delim = '\\';
1600         else
1601                 old_delim = '/';
1602
1603         pos = path;
1604         while ((pos = strchr(pos, old_delim)))
1605                 *pos = delim;
1606 }
1607
1608 #define cifs_stats_inc atomic_inc
1609
1610 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1611                                             unsigned int bytes)
1612 {
1613         if (bytes) {
1614                 spin_lock(&tcon->stat_lock);
1615                 tcon->bytes_written += bytes;
1616                 spin_unlock(&tcon->stat_lock);
1617         }
1618 }
1619
1620 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1621                                          unsigned int bytes)
1622 {
1623         spin_lock(&tcon->stat_lock);
1624         tcon->bytes_read += bytes;
1625         spin_unlock(&tcon->stat_lock);
1626 }
1627
1628
1629 /*
1630  * This is the prototype for the mid receive function. This function is for
1631  * receiving the rest of the SMB frame, starting with the WordCount (which is
1632  * just after the MID in struct smb_hdr). Note:
1633  *
1634  * - This will be called by cifsd, with no locks held.
1635  * - The mid will still be on the pending_mid_q.
1636  * - mid->resp_buf will point to the current buffer.
1637  *
1638  * Returns zero on a successful receive, or an error. The receive state in
1639  * the TCP_Server_Info will also be updated.
1640  */
1641 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1642                             struct mid_q_entry *mid);
1643
1644 /*
1645  * This is the prototype for the mid callback function. This is called once the
1646  * mid has been received off of the socket. When creating one, take special
1647  * care to avoid deadlocks. Things to bear in mind:
1648  *
1649  * - it will be called by cifsd, with no locks held
1650  * - the mid will be removed from any lists
1651  */
1652 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1653
1654 /*
1655  * This is the protopyte for mid handle function. This is called once the mid
1656  * has been recognized after decryption of the message.
1657  */
1658 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1659                             struct mid_q_entry *mid);
1660
1661 /* one of these for every pending CIFS request to the server */
1662 struct mid_q_entry {
1663         struct list_head qhead; /* mids waiting on reply from this server */
1664         struct kref refcount;
1665         struct TCP_Server_Info *server; /* server corresponding to this mid */
1666         __u64 mid;              /* multiplex id */
1667         __u16 credits;          /* number of credits consumed by this mid */
1668         __u16 credits_received; /* number of credits from the response */
1669         __u32 pid;              /* process id */
1670         __u32 sequence_number;  /* for CIFS signing */
1671         unsigned long when_alloc;  /* when mid was created */
1672 #ifdef CONFIG_CIFS_STATS2
1673         unsigned long when_sent; /* time when smb send finished */
1674         unsigned long when_received; /* when demux complete (taken off wire) */
1675 #endif
1676         mid_receive_t *receive; /* call receive callback */
1677         mid_callback_t *callback; /* call completion callback */
1678         mid_handle_t *handle; /* call handle mid callback */
1679         void *callback_data;      /* general purpose pointer for callback */
1680         struct task_struct *creator;
1681         void *resp_buf;         /* pointer to received SMB header */
1682         unsigned int resp_buf_size;
1683         int mid_state;  /* wish this were enum but can not pass to wait_event */
1684         unsigned int mid_flags;
1685         __le16 command;         /* smb command code */
1686         unsigned int optype;    /* operation type */
1687         bool large_buf:1;       /* if valid response, is pointer to large buf */
1688         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1689         bool multiEnd:1;        /* both received */
1690         bool decrypted:1;       /* decrypted entry */
1691 };
1692
1693 struct close_cancelled_open {
1694         struct cifs_fid         fid;
1695         struct cifs_tcon        *tcon;
1696         struct work_struct      work;
1697         __u64 mid;
1698         __u16 cmd;
1699 };
1700
1701 /*      Make code in transport.c a little cleaner by moving
1702         update of optional stats into function below */
1703 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1704 {
1705         atomic_inc(&server->in_send);
1706 }
1707
1708 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1709 {
1710         atomic_dec(&server->in_send);
1711 }
1712
1713 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1714 {
1715         atomic_inc(&server->num_waiters);
1716 }
1717
1718 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1719 {
1720         atomic_dec(&server->num_waiters);
1721 }
1722
1723 #ifdef CONFIG_CIFS_STATS2
1724 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1725 {
1726         mid->when_sent = jiffies;
1727 }
1728 #else
1729 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1730 {
1731 }
1732 #endif
1733
1734 /* for pending dnotify requests */
1735 struct dir_notify_req {
1736         struct list_head lhead;
1737         __le16 Pid;
1738         __le16 PidHigh;
1739         __u16 Mid;
1740         __u16 Tid;
1741         __u16 Uid;
1742         __u16 netfid;
1743         __u32 filter; /* CompletionFilter (for multishot) */
1744         int multishot;
1745         struct file *pfile;
1746 };
1747
1748 struct dfs_info3_param {
1749         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1750         int path_consumed;
1751         int server_type;
1752         int ref_flag;
1753         char *path_name;
1754         char *node_name;
1755         int ttl;
1756 };
1757
1758 struct file_list {
1759         struct list_head list;
1760         struct cifsFileInfo *cfile;
1761 };
1762
1763 struct cifs_mount_ctx {
1764         struct cifs_sb_info *cifs_sb;
1765         struct smb3_fs_context *fs_ctx;
1766         unsigned int xid;
1767         struct TCP_Server_Info *server;
1768         struct cifs_ses *ses;
1769         struct cifs_tcon *tcon;
1770         struct cifs_ses *root_ses;
1771         uuid_t mount_id;
1772         char *origin_fullpath, *leaf_fullpath;
1773 };
1774
1775 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1776 {
1777         if (param) {
1778                 kfree(param->path_name);
1779                 kfree(param->node_name);
1780         }
1781 }
1782
1783 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1784                                        int number_of_items)
1785 {
1786         int i;
1787
1788         if ((number_of_items == 0) || (param == NULL))
1789                 return;
1790         for (i = 0; i < number_of_items; i++) {
1791                 kfree(param[i].path_name);
1792                 kfree(param[i].node_name);
1793         }
1794         kfree(param);
1795 }
1796
1797 static inline bool is_interrupt_error(int error)
1798 {
1799         switch (error) {
1800         case -EINTR:
1801         case -ERESTARTSYS:
1802         case -ERESTARTNOHAND:
1803         case -ERESTARTNOINTR:
1804                 return true;
1805         }
1806         return false;
1807 }
1808
1809 static inline bool is_retryable_error(int error)
1810 {
1811         if (is_interrupt_error(error) || error == -EAGAIN)
1812                 return true;
1813         return false;
1814 }
1815
1816
1817 /* cifs_get_writable_file() flags */
1818 #define FIND_WR_ANY         0
1819 #define FIND_WR_FSUID_ONLY  1
1820 #define FIND_WR_WITH_DELETE 2
1821
1822 #define   MID_FREE 0
1823 #define   MID_REQUEST_ALLOCATED 1
1824 #define   MID_REQUEST_SUBMITTED 2
1825 #define   MID_RESPONSE_RECEIVED 4
1826 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1827 #define   MID_RESPONSE_MALFORMED 0x10
1828 #define   MID_SHUTDOWN           0x20
1829
1830 /* Flags */
1831 #define   MID_WAIT_CANCELLED     1 /* Cancelled while waiting for response */
1832 #define   MID_DELETED            2 /* Mid has been dequeued/deleted */
1833
1834 /* Types of response buffer returned from SendReceive2 */
1835 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1836 #define   CIFS_SMALL_BUFFER     1
1837 #define   CIFS_LARGE_BUFFER     2
1838 #define   CIFS_IOVEC            4    /* array of response buffers */
1839
1840 /* Type of Request to SendReceive2 */
1841 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1842 #define   CIFS_NON_BLOCKING     2    /* do not block waiting for credits */
1843 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1844 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1845 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1846 #define   CIFS_NO_RSP_BUF   0x040    /* no response buffer required */
1847
1848 /* Type of request operation */
1849 #define   CIFS_ECHO_OP            0x080  /* echo request */
1850 #define   CIFS_OBREAK_OP          0x0100 /* oplock break request */
1851 #define   CIFS_NEG_OP             0x0200 /* negotiate request */
1852 #define   CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1853 /* Lower bitmask values are reserved by others below. */
1854 #define   CIFS_SESS_OP            0x2000 /* session setup request */
1855 #define   CIFS_OP_MASK            0x2780 /* mask request type */
1856
1857 #define   CIFS_HAS_CREDITS        0x0400 /* already has credits */
1858 #define   CIFS_TRANSFORM_REQ      0x0800 /* transform request before sending */
1859 #define   CIFS_NO_SRV_RSP         0x1000 /* there is no server response */
1860
1861 /* Security Flags: indicate type of session setup needed */
1862 #define   CIFSSEC_MAY_SIGN      0x00001
1863 #define   CIFSSEC_MAY_NTLMV2    0x00004
1864 #define   CIFSSEC_MAY_KRB5      0x00008
1865 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
1866 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
1867
1868 #define   CIFSSEC_MUST_SIGN     0x01001
1869 /* note that only one of the following can be set so the
1870 result of setting MUST flags more than once will be to
1871 require use of the stronger protocol */
1872 #define   CIFSSEC_MUST_NTLMV2   0x04004
1873 #define   CIFSSEC_MUST_KRB5     0x08008
1874 #ifdef CONFIG_CIFS_UPCALL
1875 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1876 #else
1877 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1878 #endif /* UPCALL */
1879 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
1880 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
1881
1882 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1883 #define   CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2)
1884 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1885 /*
1886  *****************************************************************
1887  * All constants go here
1888  *****************************************************************
1889  */
1890
1891 #define UID_HASH (16)
1892
1893 /*
1894  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1895  * following to be declared.
1896  */
1897
1898 /****************************************************************************
1899  * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1900  * to the locking order. i.e. if two locks are to be held together, the lock that
1901  * appears higher in this list needs to be taken before the other.
1902  *
1903  * If you hold a lock that is lower in this list, and you need to take a higher lock
1904  * (or if you think that one of the functions that you're calling may need to), first
1905  * drop the lock you hold, pick up the higher lock, then the lower one. This will
1906  * ensure that locks are picked up only in one direction in the below table
1907  * (top to bottom).
1908  *
1909  * Also, if you expect a function to be called with a lock held, explicitly document
1910  * this in the comments on top of your function definition.
1911  *
1912  * And also, try to keep the critical sections (lock hold time) to be as minimal as
1913  * possible. Blocking / calling other functions with a lock held always increase
1914  * the risk of a possible deadlock.
1915  *
1916  * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1917  * debug. Also, any new lock that you introduce, please add to this list in the correct
1918  * order.
1919  *
1920  * Please populate this list whenever you introduce new locks in your changes. Or in
1921  * case I've missed some existing locks. Please ensure that it's added in the list
1922  * based on the locking order expected.
1923  *
1924  * =====================================================================================
1925  * Lock                         Protects                        Initialization fn
1926  * =====================================================================================
1927  * vol_list_lock
1928  * vol_info->ctx_lock           vol_info->ctx
1929  * cifs_sb_info->tlink_tree_lock        cifs_sb_info->tlink_tree        cifs_setup_cifs_sb
1930  * TCP_Server_Info->            TCP_Server_Info                 cifs_get_tcp_session
1931  * reconnect_mutex
1932  * TCP_Server_Info->srv_mutex   TCP_Server_Info                 cifs_get_tcp_session
1933  * cifs_ses->session_mutex              cifs_ses                sesInfoAlloc
1934  *                              cifs_tcon
1935  * cifs_tcon->open_file_lock    cifs_tcon->openFileList         tconInfoAlloc
1936  *                              cifs_tcon->pending_opens
1937  * cifs_tcon->stat_lock         cifs_tcon->bytes_read           tconInfoAlloc
1938  *                              cifs_tcon->bytes_written
1939  * cifs_tcp_ses_lock            cifs_tcp_ses_list               sesInfoAlloc
1940  * GlobalMid_Lock               GlobalMaxActiveXid              init_cifs
1941  *                              GlobalCurrentXid
1942  *                              GlobalTotalActiveXid
1943  * TCP_Server_Info->srv_lock    (anything in struct not protected by another lock and can change)
1944  * TCP_Server_Info->mid_lock    TCP_Server_Info->pending_mid_q  cifs_get_tcp_session
1945  *                              ->CurrentMid
1946  *                              (any changes in mid_q_entry fields)
1947  * TCP_Server_Info->req_lock    TCP_Server_Info->in_flight      cifs_get_tcp_session
1948  *                              ->credits
1949  *                              ->echo_credits
1950  *                              ->oplock_credits
1951  *                              ->reconnect_instance
1952  * cifs_ses->ses_lock           (anything that is not protected by another lock and can change)
1953  * cifs_ses->iface_lock         cifs_ses->iface_list            sesInfoAlloc
1954  *                              ->iface_count
1955  *                              ->iface_last_update
1956  * cifs_ses->chan_lock          cifs_ses->chans
1957  *                              ->chans_need_reconnect
1958  *                              ->chans_in_reconnect
1959  * cifs_tcon->tc_lock           (anything that is not protected by another lock and can change)
1960  * cifsInodeInfo->open_file_lock        cifsInodeInfo->openFileList     cifs_alloc_inode
1961  * cifsInodeInfo->writers_lock  cifsInodeInfo->writers          cifsInodeInfo_alloc
1962  * cifsInodeInfo->lock_sem      cifsInodeInfo->llist            cifs_init_once
1963  *                              ->can_cache_brlcks
1964  * cifsInodeInfo->deferred_lock cifsInodeInfo->deferred_closes  cifsInodeInfo_alloc
1965  * cached_fid->fid_mutex                cifs_tcon->crfid                tconInfoAlloc
1966  * cifsFileInfo->fh_mutex               cifsFileInfo                    cifs_new_fileinfo
1967  * cifsFileInfo->file_info_lock cifsFileInfo->count             cifs_new_fileinfo
1968  *                              ->invalidHandle                 initiate_cifs_search
1969  *                              ->oplock_break_cancelled
1970  * cifs_aio_ctx->aio_mutex              cifs_aio_ctx                    cifs_aio_ctx_alloc
1971  ****************************************************************************/
1972
1973 #ifdef DECLARE_GLOBALS_HERE
1974 #define GLOBAL_EXTERN
1975 #else
1976 #define GLOBAL_EXTERN extern
1977 #endif
1978
1979 /*
1980  * the list of TCP_Server_Info structures, ie each of the sockets
1981  * connecting our client to a distinct server (ip address), is
1982  * chained together by cifs_tcp_ses_list. The list of all our SMB
1983  * sessions (and from that the tree connections) can be found
1984  * by iterating over cifs_tcp_ses_list
1985  */
1986 extern struct list_head         cifs_tcp_ses_list;
1987
1988 /*
1989  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1990  * tcp session, and the list of tcon's per smb session. It also protects
1991  * the reference counters for the server, smb session, and tcon.
1992  * generally the locks should be taken in order tcp_ses_lock before
1993  * tcon->open_file_lock and that before file->file_info_lock since the
1994  * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1995  */
1996 extern spinlock_t               cifs_tcp_ses_lock;
1997
1998 /*
1999  * Global transaction id (XID) information
2000  */
2001 extern unsigned int GlobalCurrentXid;   /* protected by GlobalMid_Sem */
2002 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
2003 extern unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
2004 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
2005
2006 /*
2007  *  Global counters, updated atomically
2008  */
2009 extern atomic_t sesInfoAllocCount;
2010 extern atomic_t tconInfoAllocCount;
2011 extern atomic_t tcpSesNextId;
2012 extern atomic_t tcpSesAllocCount;
2013 extern atomic_t tcpSesReconnectCount;
2014 extern atomic_t tconInfoReconnectCount;
2015
2016 /* Various Debug counters */
2017 extern atomic_t buf_alloc_count;        /* current number allocated  */
2018 extern atomic_t small_buf_alloc_count;
2019 #ifdef CONFIG_CIFS_STATS2
2020 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2021 extern atomic_t total_small_buf_alloc_count;
2022 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2023 #endif
2024
2025 /* Misc globals */
2026 extern bool enable_oplocks; /* enable or disable oplocks */
2027 extern bool lookupCacheEnabled;
2028 extern unsigned int global_secflags;    /* if on, session setup sent
2029                                 with more secure ntlmssp2 challenge/resp */
2030 extern unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
2031 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2032 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2033 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2034 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2035 extern unsigned int CIFSMaxBufSize;  /* max size not including hdr */
2036 extern unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
2037 extern unsigned int cifs_min_small;  /* min size of small buf pool */
2038 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2039 extern bool disable_legacy_dialects;  /* forbid vers=1.0 and vers=2.0 mounts */
2040 extern atomic_t mid_count;
2041
2042 void cifs_oplock_break(struct work_struct *work);
2043 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2044 void smb2_deferred_work_close(struct work_struct *work);
2045
2046 extern const struct slow_work_ops cifs_oplock_break_ops;
2047 extern struct workqueue_struct *cifsiod_wq;
2048 extern struct workqueue_struct *decrypt_wq;
2049 extern struct workqueue_struct *fileinfo_put_wq;
2050 extern struct workqueue_struct *cifsoplockd_wq;
2051 extern struct workqueue_struct *deferredclose_wq;
2052 extern __u32 cifs_lock_secret;
2053
2054 extern mempool_t *cifs_mid_poolp;
2055
2056 /* Operations for different SMB versions */
2057 #define SMB1_VERSION_STRING     "1.0"
2058 #define SMB20_VERSION_STRING    "2.0"
2059 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2060 extern struct smb_version_operations smb1_operations;
2061 extern struct smb_version_values smb1_values;
2062 extern struct smb_version_operations smb20_operations;
2063 extern struct smb_version_values smb20_values;
2064 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2065 #define SMB21_VERSION_STRING    "2.1"
2066 extern struct smb_version_operations smb21_operations;
2067 extern struct smb_version_values smb21_values;
2068 #define SMBDEFAULT_VERSION_STRING "default"
2069 extern struct smb_version_values smbdefault_values;
2070 #define SMB3ANY_VERSION_STRING "3"
2071 extern struct smb_version_values smb3any_values;
2072 #define SMB30_VERSION_STRING    "3.0"
2073 extern struct smb_version_operations smb30_operations;
2074 extern struct smb_version_values smb30_values;
2075 #define SMB302_VERSION_STRING   "3.02"
2076 #define ALT_SMB302_VERSION_STRING "3.0.2"
2077 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2078 extern struct smb_version_values smb302_values;
2079 #define SMB311_VERSION_STRING   "3.1.1"
2080 #define ALT_SMB311_VERSION_STRING "3.11"
2081 extern struct smb_version_operations smb311_operations;
2082 extern struct smb_version_values smb311_values;
2083
2084 static inline char *get_security_type_str(enum securityEnum sectype)
2085 {
2086         switch (sectype) {
2087         case RawNTLMSSP:
2088                 return "RawNTLMSSP";
2089         case Kerberos:
2090                 return "Kerberos";
2091         case NTLMv2:
2092                 return "NTLMv2";
2093         default:
2094                 return "Unknown";
2095         }
2096 }
2097
2098 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2099 {
2100         return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2101 }
2102
2103 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2104 {
2105         /*
2106          * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2107          * Subsystem Notifies That a Share Is a DFS Share.
2108          *
2109          * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2110          * Application Updates a Share.
2111          */
2112         if (!tcon || !tcon->ses || !tcon->ses->server)
2113                 return false;
2114         return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2115                 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2116 }
2117
2118 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2119                                            const struct dfs_info3_param *ref)
2120 {
2121         /*
2122          * Check if all targets are capable of handling DFS referrals as per
2123          * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2124          */
2125         return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2126 }
2127
2128 static inline u64 cifs_flock_len(const struct file_lock *fl)
2129 {
2130         return (u64)fl->fl_end - fl->fl_start + 1;
2131 }
2132
2133 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2134 {
2135         if (WARN_ON_ONCE(!ses || !ses->server))
2136                 return 0;
2137         /*
2138          * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2139          * servers do require it during NTLMSSP.
2140          */
2141         if (ses->server->dialect <= SMB20_PROT_ID)
2142                 return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2143         return sizeof(ses->workstation_name);
2144 }
2145
2146 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2147 {
2148         memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2149         dst->AccessFlags = src->AccessFlags;
2150         dst->CurrentByteOffset = src->CurrentByteOffset;
2151         dst->Mode = src->Mode;
2152         dst->AlignmentRequirement = src->AlignmentRequirement;
2153         dst->FileNameLength = src->FileNameLength;
2154 }
2155
2156 static inline unsigned int cifs_get_num_sgs(const struct smb_rqst *rqst,
2157                                             int num_rqst,
2158                                             const u8 *sig)
2159 {
2160         unsigned int len, skip;
2161         unsigned int nents = 0;
2162         unsigned long addr;
2163         int i, j;
2164
2165         /*
2166          * The first rqst has a transform header where the first 20 bytes are
2167          * not part of the encrypted blob.
2168          */
2169         skip = 20;
2170
2171         /* Assumes the first rqst has a transform header as the first iov.
2172          * I.e.
2173          * rqst[0].rq_iov[0]  is transform header
2174          * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2175          * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2176          */
2177         for (i = 0; i < num_rqst; i++) {
2178                 for (j = 0; j < rqst[i].rq_nvec; j++) {
2179                         struct kvec *iov = &rqst[i].rq_iov[j];
2180
2181                         addr = (unsigned long)iov->iov_base + skip;
2182                         if (unlikely(is_vmalloc_addr((void *)addr))) {
2183                                 len = iov->iov_len - skip;
2184                                 nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2185                                                       PAGE_SIZE);
2186                         } else {
2187                                 nents++;
2188                         }
2189                         skip = 0;
2190                 }
2191                 nents += rqst[i].rq_npages;
2192         }
2193         nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2194         return nents;
2195 }
2196
2197 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2198  * stack object as buf.
2199  */
2200 static inline struct scatterlist *cifs_sg_set_buf(struct scatterlist *sg,
2201                                                   const void *buf,
2202                                                   unsigned int buflen)
2203 {
2204         unsigned long addr = (unsigned long)buf;
2205         unsigned int off = offset_in_page(addr);
2206
2207         addr &= PAGE_MASK;
2208         if (unlikely(is_vmalloc_addr((void *)addr))) {
2209                 do {
2210                         unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2211
2212                         sg_set_page(sg++, vmalloc_to_page((void *)addr), len, off);
2213
2214                         off = 0;
2215                         addr += PAGE_SIZE;
2216                         buflen -= len;
2217                 } while (buflen);
2218         } else {
2219                 sg_set_page(sg++, virt_to_page(addr), buflen, off);
2220         }
2221         return sg;
2222 }
2223
2224 #endif  /* _CIFS_GLOB_H */