fs/cifs/cifsglob.h

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