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