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