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