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