fs/cifs/cifsglob.h

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