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