fs/cifs/cifsglob.h

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