fs/cifs/cifsglob.h

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