fs/smb/client/cifsglob.h

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