fs/cifs/cifsglob.h

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