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