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