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