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