fs/cifs/cifsglob.h

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