fs/cifs/cifsglob.h

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