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