fs/cifs/cifsglob.h

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