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