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 enum smb_version {
 199         Smb_1 = 1,
 200         Smb_20,
 201         Smb_21,
 202         Smb_30,
 203         Smb_302,
 204         Smb_311,
 205         Smb_3any,
 206         Smb_default,
 207         Smb_version_err
 208 };
 209
 210 struct mid_q_entry;
 211 struct TCP_Server_Info;
 212 struct cifsFileInfo;
 213 struct cifs_ses;
 214 struct cifs_tcon;
 215 struct dfs_info3_param;
 216 struct cifs_fattr;
 217 struct smb_vol;
 218 struct cifs_fid;
 219 struct cifs_readdata;
 220 struct cifs_writedata;
 221 struct cifs_io_parms;
 222 struct cifs_search_info;
 223 struct cifsInodeInfo;
 224 struct cifs_open_parms;
 225 struct cifs_credits;
 226
 227 struct smb_version_operations {
 228         int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
 229                            struct mid_q_entry *);
 230         bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
 231         /* setup request: allocate mid, sign message */
 232         struct mid_q_entry *(*setup_request)(struct cifs_ses *,
 233                                                 struct smb_rqst *);
 234         /* setup async request: allocate mid, sign message */
 235         struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
 236                                                 struct smb_rqst *);
 237         /* check response: verify signature, map error */
 238         int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
 239                              bool);
 240         void (*add_credits)(struct TCP_Server_Info *server,
 241                             const struct cifs_credits *credits,
 242                             const int optype);
 243         void (*set_credits)(struct TCP_Server_Info *, const int);
 244         int * (*get_credits_field)(struct TCP_Server_Info *, const int);
 245         unsigned int (*get_credits)(struct mid_q_entry *);
 246         __u64 (*get_next_mid)(struct TCP_Server_Info *);
 247         void (*revert_current_mid)(struct TCP_Server_Info *server,
 248                                    const unsigned int val);
 249         /* data offset from read response message */
 250         unsigned int (*read_data_offset)(char *);
 251         /*
 252          * Data length from read response message
 253          * When in_remaining is true, the returned data length is in
 254          * message field DataRemaining for out-of-band data read (e.g through
 255          * Memory Registration RDMA write in SMBD).
 256          * Otherwise, the returned data length is in message field DataLength.
 257          */
 258         unsigned int (*read_data_length)(char *, bool in_remaining);
 259         /* map smb to linux error */
 260         int (*map_error)(char *, bool);
 261         /* find mid corresponding to the response message */
 262         struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
 263         void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
 264         void (*clear_stats)(struct cifs_tcon *);
 265         void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
 266         void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
 267         /* verify the message */
 268         int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
 269         bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
 270         int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
 271         void (*downgrade_oplock)(struct TCP_Server_Info *,
 272                                         struct cifsInodeInfo *, bool);
 273         /* process transaction2 response */
 274         bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
 275                              char *, int);
 276         /* check if we need to negotiate */
 277         bool (*need_neg)(struct TCP_Server_Info *);
 278         /* negotiate to the server */
 279         int (*negotiate)(const unsigned int, struct cifs_ses *);
 280         /* set negotiated write size */
 281         unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
 282         /* set negotiated read size */
 283         unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
 284         /* setup smb sessionn */
 285         int (*sess_setup)(const unsigned int, struct cifs_ses *,
 286                           const struct nls_table *);
 287         /* close smb session */
 288         int (*logoff)(const unsigned int, struct cifs_ses *);
 289         /* connect to a server share */
 290         int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
 291                             struct cifs_tcon *, const struct nls_table *);
 292         /* close tree connecion */
 293         int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
 294         /* get DFS referrals */
 295         int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
 296                              const char *, struct dfs_info3_param **,
 297                              unsigned int *, const struct nls_table *, int);
 298         /* informational QFS call */
 299         void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
 300         /* check if a path is accessible or not */
 301         int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
 302                                   struct cifs_sb_info *, const char *);
 303         /* query path data from the server */
 304         int (*query_path_info)(const unsigned int, struct cifs_tcon *,
 305                                struct cifs_sb_info *, const char *,
 306                                FILE_ALL_INFO *, bool *, bool *);
 307         /* query file data from the server */
 308         int (*query_file_info)(const unsigned int, struct cifs_tcon *,
 309                                struct cifs_fid *, FILE_ALL_INFO *);
 310         /* get server index number */
 311         int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
 312                             struct cifs_sb_info *, const char *,
 313                             u64 *uniqueid, FILE_ALL_INFO *);
 314         /* set size by path */
 315         int (*set_path_size)(const unsigned int, struct cifs_tcon *,
 316                              const char *, __u64, struct cifs_sb_info *, bool);
 317         /* set size by file handle */
 318         int (*set_file_size)(const unsigned int, struct cifs_tcon *,
 319                              struct cifsFileInfo *, __u64, bool);
 320         /* set attributes */
 321         int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
 322                              const unsigned int);
 323         int (*set_compression)(const unsigned int, struct cifs_tcon *,
 324                                struct cifsFileInfo *);
 325         /* check if we can send an echo or nor */
 326         bool (*can_echo)(struct TCP_Server_Info *);
 327         /* send echo request */
 328         int (*echo)(struct TCP_Server_Info *);
 329         /* create directory */
 330         int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
 331                         umode_t mode, struct cifs_tcon *tcon,
 332                         const char *full_path,
 333                         struct cifs_sb_info *cifs_sb);
 334         int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
 335                      struct cifs_sb_info *);
 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         /* send a flush request to the server */
 369         int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
 370         /* async read from the server */
 371         int (*async_readv)(struct cifs_readdata *);
 372         /* async write to the server */
 373         int (*async_writev)(struct cifs_writedata *,
 374                             void (*release)(struct kref *));
 375         /* sync read from the server */
 376         int (*sync_read)(const unsigned int, struct cifs_fid *,
 377                          struct cifs_io_parms *, unsigned int *, char **,
 378                          int *);
 379         /* sync write to the server */
 380         int (*sync_write)(const unsigned int, struct cifs_fid *,
 381                           struct cifs_io_parms *, unsigned int *, struct kvec *,
 382                           unsigned long);
 383         /* open dir, start readdir */
 384         int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
 385                                const char *, struct cifs_sb_info *,
 386                                struct cifs_fid *, __u16,
 387                                struct cifs_search_info *);
 388         /* continue readdir */
 389         int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
 390                               struct cifs_fid *,
 391                               __u16, struct cifs_search_info *srch_inf);
 392         /* close dir */
 393         int (*close_dir)(const unsigned int, struct cifs_tcon *,
 394                          struct cifs_fid *);
 395         /* calculate a size of SMB message */
 396         unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
 397         /* check for STATUS_PENDING and process the response if yes */
 398         bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
 399         /* check for STATUS_NETWORK_SESSION_EXPIRED */
 400         bool (*is_session_expired)(char *);
 401         /* send oplock break response */
 402         int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
 403                                struct cifsInodeInfo *);
 404         /* query remote filesystem */
 405         int (*queryfs)(const unsigned int, struct cifs_tcon *,
 406                        struct kstatfs *);
 407         /* send mandatory brlock to the server */
 408         int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
 409                          __u64, __u32, int, int, bool);
 410         /* unlock range of mandatory locks */
 411         int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
 412                                  const unsigned int);
 413         /* push brlocks from the cache to the server */
 414         int (*push_mand_locks)(struct cifsFileInfo *);
 415         /* get lease key of the inode */
 416         void (*get_lease_key)(struct inode *, struct cifs_fid *);
 417         /* set lease key of the inode */
 418         void (*set_lease_key)(struct inode *, struct cifs_fid *);
 419         /* generate new lease key */
 420         void (*new_lease_key)(struct cifs_fid *);
 421         int (*generate_signingkey)(struct cifs_ses *);
 422         int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
 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 (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
 428                                 struct cifs_sb_info *, const unsigned char *,
 429                                 char *, unsigned int *);
 430         int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
 431                                  struct cifs_sb_info *, const unsigned char *,
 432                                  char *, unsigned int *);
 433         /* if we can do cache read operations */
 434         bool (*is_read_op)(__u32);
 435         /* set oplock level for the inode */
 436         void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
 437                                  bool *);
 438         /* create lease context buffer for CREATE request */
 439         char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
 440         /* parse lease context buffer and return oplock/epoch info */
 441         __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
 442         ssize_t (*copychunk_range)(const unsigned int,
 443                         struct cifsFileInfo *src_file,
 444                         struct cifsFileInfo *target_file,
 445                         u64 src_off, u64 len, u64 dest_off);
 446         int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
 447                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
 448                         u64 dest_off);
 449         int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
 450         ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
 451                         const unsigned char *, const unsigned char *, char *,
 452                         size_t, struct cifs_sb_info *);
 453         int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
 454                         const char *, const void *, const __u16,
 455                         const struct nls_table *, struct cifs_sb_info *);
 456         struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
 457                         const char *, u32 *);
 458         struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
 459                         const struct cifs_fid *, u32 *);
 460         int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
 461                         int);
 462         /* writepages retry size */
 463         unsigned int (*wp_retry_size)(struct inode *);
 464         /* get mtu credits */
 465         int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
 466                                 unsigned int *, struct cifs_credits *);
 467         /* adjust previously taken mtu credits to request size */
 468         int (*adjust_credits)(struct TCP_Server_Info *server,
 469                               struct cifs_credits *credits,
 470                               const unsigned int payload_size);
 471         /* check if we need to issue closedir */
 472         bool (*dir_needs_close)(struct cifsFileInfo *);
 473         long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
 474                           loff_t);
 475         /* init transform request - used for encryption for now */
 476         int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
 477                                  struct smb_rqst *, struct smb_rqst *);
 478         int (*is_transform_hdr)(void *buf);
 479         int (*receive_transform)(struct TCP_Server_Info *,
 480                                  struct mid_q_entry **, char **, int *);
 481         enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
 482                             enum securityEnum);
 483         int (*next_header)(char *);
 484         /* ioctl passthrough for query_info */
 485         int (*ioctl_query_info)(const unsigned int xid,
 486                                 struct cifs_tcon *tcon,
 487                                 __le16 *path, int is_dir,
 488                                 unsigned long p);
 489         /* make unix special files (block, char, fifo, socket) */
 490         int (*make_node)(unsigned int xid,
 491                          struct inode *inode,
 492                          struct dentry *dentry,
 493                          struct cifs_tcon *tcon,
 494                          char *full_path,
 495                          umode_t mode,
 496                          dev_t device_number);
 497         /* version specific fiemap implementation */
 498         int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
 499                       struct fiemap_extent_info *, u64, u64);
 500         /* version specific llseek implementation */
 501         loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
 502 };
 503
 504 struct smb_version_values {
 505         char            *version_string;
 506         __u16           protocol_id;
 507         __u32           req_capabilities;
 508         __u32           large_lock_type;
 509         __u32           exclusive_lock_type;
 510         __u32           shared_lock_type;
 511         __u32           unlock_lock_type;
 512         size_t          header_preamble_size;
 513         size_t          header_size;
 514         size_t          max_header_size;
 515         size_t          read_rsp_size;
 516         __le16          lock_cmd;
 517         unsigned int    cap_unix;
 518         unsigned int    cap_nt_find;
 519         unsigned int    cap_large_files;
 520         __u16           signing_enabled;
 521         __u16           signing_required;
 522         size_t          create_lease_size;
 523 };
 524
 525 #define HEADER_SIZE(server) (server->vals->header_size)
 526 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
 527
 528 struct smb_vol {
 529         char *username;
 530         char *password;
 531         char *domainname;
 532         char *UNC;
 533         char *iocharset;  /* local code page for mapping to and from Unicode */
 534         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
 535         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
 536         kuid_t cred_uid;
 537         kuid_t linux_uid;
 538         kgid_t linux_gid;
 539         kuid_t backupuid;
 540         kgid_t backupgid;
 541         umode_t file_mode;
 542         umode_t dir_mode;
 543         enum securityEnum sectype; /* sectype requested via mnt opts */
 544         bool sign; /* was signing requested via mnt opts? */
 545         bool retry:1;
 546         bool intr:1;
 547         bool setuids:1;
 548         bool setuidfromacl:1;
 549         bool override_uid:1;
 550         bool override_gid:1;
 551         bool dynperm:1;
 552         bool noperm:1;
 553         bool no_psx_acl:1; /* set if posix acl support should be disabled */
 554         bool cifs_acl:1;
 555         bool backupuid_specified; /* mount option  backupuid  is specified */
 556         bool backupgid_specified; /* mount option  backupgid  is specified */
 557         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
 558         bool server_ino:1; /* use inode numbers from server ie UniqueId */
 559         bool direct_io:1;
 560         bool strict_io:1; /* strict cache behavior */
 561         bool remap:1;      /* set to remap seven reserved chars in filenames */
 562         bool sfu_remap:1;  /* remap seven reserved chars ala SFU */
 563         bool posix_paths:1; /* unset to not ask for posix pathnames. */
 564         bool no_linux_ext:1;
 565         bool linux_ext:1;
 566         bool sfu_emul:1;
 567         bool nullauth:1;   /* attempt to authenticate with null user */
 568         bool nocase:1;     /* request case insensitive filenames */
 569         bool nobrl:1;      /* disable sending byte range locks to srv */
 570         bool nohandlecache:1; /* disable caching dir handles if srvr probs */
 571         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
 572         bool seal:1;       /* request transport encryption on share */
 573         bool nodfs:1;      /* Do not request DFS, even if available */
 574         bool local_lease:1; /* check leases only on local system, not remote */
 575         bool noblocksnd:1;
 576         bool noautotune:1;
 577         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
 578         bool fsc:1;     /* enable fscache */
 579         bool mfsymlinks:1; /* use Minshall+French Symlinks */
 580         bool multiuser:1;
 581         bool rwpidforward:1; /* pid forward for read/write operations */
 582         bool nosharesock:1;
 583         bool persistent:1;
 584         bool nopersistent:1;
 585         bool resilient:1; /* noresilient not required since not fored for CA */
 586         bool domainauto:1;
 587         bool rdma:1;
 588         unsigned int bsize;
 589         unsigned int rsize;
 590         unsigned int wsize;
 591         bool sockopt_tcp_nodelay:1;
 592         unsigned long actimeo; /* attribute cache timeout (jiffies) */
 593         struct smb_version_operations *ops;
 594         struct smb_version_values *vals;
 595         char *prepath;
 596         struct sockaddr_storage dstaddr; /* destination address */
 597         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
 598         struct nls_table *local_nls;
 599         unsigned int echo_interval; /* echo interval in secs */
 600         __u64 snapshot_time; /* needed for timewarp tokens */
 601         __u32 handle_timeout; /* persistent and durable handle timeout in ms */
 602         unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
 603 };
 604
 605 /**
 606  * CIFS superblock mount flags (mnt_cifs_flags) to consider when
 607  * trying to reuse existing superblock for a new mount
 608  */
 609 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
 610                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
 611                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
 612                          CIFS_MOUNT_MAP_SFM_CHR | \
 613                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
 614                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
 615                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
 616                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
 617                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
 618                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
 619                          CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
 620                          CIFS_MOUNT_NO_DFS)
 621
 622 /**
 623  * Generic VFS superblock mount flags (s_flags) to consider when
 624  * trying to reuse existing superblock for a new mount
 625  */
 626 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
 627                       SB_NODEV | SB_SYNCHRONOUS)
 628
 629 struct cifs_mnt_data {
 630         struct cifs_sb_info *cifs_sb;
 631         struct smb_vol *vol;
 632         int flags;
 633 };
 634
 635 static inline unsigned int
 636 get_rfc1002_length(void *buf)
 637 {
 638         return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
 639 }
 640
 641 static inline void
 642 inc_rfc1001_len(void *buf, int count)
 643 {
 644         be32_add_cpu((__be32 *)buf, count);
 645 }
 646
 647 struct TCP_Server_Info {
 648         struct list_head tcp_ses_list;
 649         struct list_head smb_ses_list;
 650         int srv_count; /* reference counter */
 651         /* 15 character server name + 0x20 16th byte indicating type = srv */
 652         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 653         struct smb_version_operations   *ops;
 654         struct smb_version_values       *vals;
 655         enum statusEnum tcpStatus; /* what we think the status is */
 656         char *hostname; /* hostname portion of UNC string */
 657         struct socket *ssocket;
 658         struct sockaddr_storage dstaddr;
 659         struct sockaddr_storage srcaddr; /* locally bind to this IP */
 660 #ifdef CONFIG_NET_NS
 661         struct net *net;
 662 #endif
 663         wait_queue_head_t response_q;
 664         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
 665         struct list_head pending_mid_q;
 666         bool noblocksnd;                /* use blocking sendmsg */
 667         bool noautotune;                /* do not autotune send buf sizes */
 668         bool tcp_nodelay;
 669         unsigned int credits;  /* send no more requests at once */
 670         unsigned int max_credits; /* can override large 32000 default at mnt */
 671         unsigned int in_flight;  /* number of requests on the wire to server */
 672         spinlock_t req_lock;  /* protect the two values above */
 673         struct mutex srv_mutex;
 674         struct task_struct *tsk;
 675         char server_GUID[16];
 676         __u16 sec_mode;
 677         bool sign; /* is signing enabled on this connection? */
 678         bool session_estab; /* mark when very first sess is established */
 679         int echo_credits;  /* echo reserved slots */
 680         int oplock_credits;  /* oplock break reserved slots */
 681         bool echoes:1; /* enable echoes */
 682         __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
 683         u16 dialect; /* dialect index that server chose */
 684         bool oplocks:1; /* enable oplocks */
 685         unsigned int maxReq;    /* Clients should submit no more */
 686         /* than maxReq distinct unanswered SMBs to the server when using  */
 687         /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
 688         unsigned int maxBuf;    /* maxBuf specifies the maximum */
 689         /* message size the server can send or receive for non-raw SMBs */
 690         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
 691         /* when socket is setup (and during reconnect) before NegProt sent */
 692         unsigned int max_rw;    /* maxRw specifies the maximum */
 693         /* message size the server can send or receive for */
 694         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
 695         unsigned int capabilities; /* selective disabling of caps by smb sess */
 696         int timeAdj;  /* Adjust for difference in server time zone in sec */
 697         __u64 CurrentMid;         /* multiplex id - rotating counter */
 698         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
 699         /* 16th byte of RFC1001 workstation name is always null */
 700         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 701         __u32 sequence_number; /* for signing, protected by srv_mutex */
 702         __u32 reconnect_instance; /* incremented on each reconnect */
 703         struct session_key session_key;
 704         unsigned long lstrp; /* when we got last response from this server */
 705         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
 706 #define CIFS_NEGFLAVOR_LANMAN   0       /* wct == 13, LANMAN */
 707 #define CIFS_NEGFLAVOR_UNENCAP  1       /* wct == 17, but no ext_sec */
 708 #define CIFS_NEGFLAVOR_EXTENDED 2       /* wct == 17, ext_sec bit set */
 709         char    negflavor;      /* NEGOTIATE response flavor */
 710         /* extended security flavors that server supports */
 711         bool    sec_ntlmssp;            /* supports NTLMSSP */
 712         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
 713         bool    sec_kerberos;           /* supports plain Kerberos */
 714         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
 715         bool    large_buf;              /* is current buffer large? */
 716         /* use SMBD connection instead of socket */
 717         bool    rdma;
 718         /* point to the SMBD connection if RDMA is used instead of socket */
 719         struct smbd_connection *smbd_conn;
 720         struct delayed_work     echo; /* echo ping workqueue job */
 721         char    *smallbuf;      /* pointer to current "small" buffer */
 722         char    *bigbuf;        /* pointer to current "big" buffer */
 723         /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
 724         unsigned int pdu_size;
 725         unsigned int total_read; /* total amount of data read in this pass */
 726 #ifdef CONFIG_CIFS_FSCACHE
 727         struct fscache_cookie   *fscache; /* client index cache cookie */
 728 #endif
 729 #ifdef CONFIG_CIFS_STATS2
 730         atomic_t in_send; /* requests trying to send */
 731         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
 732         atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
 733         atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
 734         __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
 735         __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
 736         __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
 737 #endif /* STATS2 */
 738         unsigned int    max_read;
 739         unsigned int    max_write;
 740         __le16  compress_algorithm;
 741         __le16  cipher_type;
 742          /* save initital negprot hash */
 743         __u8    preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
 744         bool    posix_ext_supported;
 745         struct delayed_work reconnect; /* reconnect workqueue job */
 746         struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
 747         unsigned long echo_interval;
 748
 749         /*
 750          * Number of targets available for reconnect. The more targets
 751          * the more tasks have to wait to let the demultiplex thread
 752          * reconnect.
 753          */
 754         int nr_targets;
 755 };
 756
 757 struct cifs_credits {
 758         unsigned int value;
 759         unsigned int instance;
 760 };
 761
 762 static inline unsigned int
 763 in_flight(struct TCP_Server_Info *server)
 764 {
 765         unsigned int num;
 766         spin_lock(&server->req_lock);
 767         num = server->in_flight;
 768         spin_unlock(&server->req_lock);
 769         return num;
 770 }
 771
 772 static inline bool
 773 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
 774 {
 775         int num;
 776         spin_lock(&server->req_lock);
 777         num = *credits;
 778         spin_unlock(&server->req_lock);
 779         return num >= num_credits;
 780 }
 781
 782 static inline void
 783 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
 784             const int optype)
 785 {
 786         server->ops->add_credits(server, credits, optype);
 787 }
 788
 789 static inline void
 790 add_credits_and_wake_if(struct TCP_Server_Info *server,
 791                         const struct cifs_credits *credits, const int optype)
 792 {
 793         if (credits->value) {
 794                 server->ops->add_credits(server, credits, optype);
 795                 wake_up(&server->request_q);
 796         }
 797 }
 798
 799 static inline void
 800 set_credits(struct TCP_Server_Info *server, const int val)
 801 {
 802         server->ops->set_credits(server, val);
 803 }
 804
 805 static inline int
 806 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
 807                const unsigned int payload_size)
 808 {
 809         return server->ops->adjust_credits ?
 810                 server->ops->adjust_credits(server, credits, payload_size) : 0;
 811 }
 812
 813 static inline __le64
 814 get_next_mid64(struct TCP_Server_Info *server)
 815 {
 816         return cpu_to_le64(server->ops->get_next_mid(server));
 817 }
 818
 819 static inline __le16
 820 get_next_mid(struct TCP_Server_Info *server)
 821 {
 822         __u16 mid = server->ops->get_next_mid(server);
 823         /*
 824          * The value in the SMB header should be little endian for easy
 825          * on-the-wire decoding.
 826          */
 827         return cpu_to_le16(mid);
 828 }
 829
 830 static inline void
 831 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
 832 {
 833         if (server->ops->revert_current_mid)
 834                 server->ops->revert_current_mid(server, val);
 835 }
 836
 837 static inline void
 838 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
 839                             const struct smb2_sync_hdr *shdr)
 840 {
 841         unsigned int num = le16_to_cpu(shdr->CreditCharge);
 842
 843         return revert_current_mid(server, num > 0 ? num : 1);
 844 }
 845
 846 static inline __u16
 847 get_mid(const struct smb_hdr *smb)
 848 {
 849         return le16_to_cpu(smb->Mid);
 850 }
 851
 852 static inline bool
 853 compare_mid(__u16 mid, const struct smb_hdr *smb)
 854 {
 855         return mid == le16_to_cpu(smb->Mid);
 856 }
 857
 858 /*
 859  * When the server supports very large reads and writes via POSIX extensions,
 860  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
 861  * including the RFC1001 length.
 862  *
 863  * Note that this might make for "interesting" allocation problems during
 864  * writeback however as we have to allocate an array of pointers for the
 865  * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
 866  *
 867  * For reads, there is a similar problem as we need to allocate an array
 868  * of kvecs to handle the receive, though that should only need to be done
 869  * once.
 870  */
 871 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
 872 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
 873
 874 /*
 875  * When the server doesn't allow large posix writes, only allow a rsize/wsize
 876  * of 2^17-1 minus the size of the call header. That allows for a read or
 877  * write up to the maximum size described by RFC1002.
 878  */
 879 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
 880 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
 881
 882 /*
 883  * The default wsize is 1M. find_get_pages seems to return a maximum of 256
 884  * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
 885  * a single wsize request with a single call.
 886  */
 887 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
 888 #define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
 889
 890 /*
 891  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
 892  * those values when posix extensions aren't in force. In actuality here, we
 893  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
 894  * to be ok with the extra byte even though Windows doesn't send writes that
 895  * are that large.
 896  *
 897  * Citation:
 898  *
 899  * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
 900  */
 901 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
 902 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
 903
 904 /*
 905  * Macros to allow the TCP_Server_Info->net field and related code to drop out
 906  * when CONFIG_NET_NS isn't set.
 907  */
 908
 909 #ifdef CONFIG_NET_NS
 910
 911 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 912 {
 913         return srv->net;
 914 }
 915
 916 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 917 {
 918         srv->net = net;
 919 }
 920
 921 #else
 922
 923 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 924 {
 925         return &init_net;
 926 }
 927
 928 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 929 {
 930 }
 931
 932 #endif
 933
 934 struct cifs_server_iface {
 935         size_t speed;
 936         unsigned int rdma_capable : 1;
 937         unsigned int rss_capable : 1;
 938         struct sockaddr_storage sockaddr;
 939 };
 940
 941 /*
 942  * Session structure.  One of these for each uid session with a particular host
 943  */
 944 struct cifs_ses {
 945         struct list_head smb_ses_list;
 946         struct list_head tcon_list;
 947         struct cifs_tcon *tcon_ipc;
 948         struct mutex session_mutex;
 949         struct TCP_Server_Info *server; /* pointer to server info */
 950         int ses_count;          /* reference counter */
 951         enum statusEnum status;
 952         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
 953         char *serverOS;         /* name of operating system underlying server */
 954         char *serverNOS;        /* name of network operating system of server */
 955         char *serverDomain;     /* security realm of server */
 956         __u64 Suid;             /* remote smb uid  */
 957         kuid_t linux_uid;       /* overriding owner of files on the mount */
 958         kuid_t cred_uid;        /* owner of credentials */
 959         unsigned int capabilities;
 960         char serverName[SERVER_NAME_LEN_WITH_NULL];
 961         char *user_name;        /* must not be null except during init of sess
 962                                    and after mount option parsing we fill it */
 963         char *domainName;
 964         char *password;
 965         struct session_key auth_key;
 966         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
 967         enum securityEnum sectype; /* what security flavor was specified? */
 968         bool sign;              /* is signing required? */
 969         bool need_reconnect:1; /* connection reset, uid now invalid */
 970         bool domainAuto:1;
 971         __u16 session_flags;
 972         __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
 973         __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
 974         __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
 975         __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
 976
 977         /*
 978          * Network interfaces available on the server this session is
 979          * connected to.
 980          *
 981          * Other channels can be opened by connecting and binding this
 982          * session to interfaces from this list.
 983          *
 984          * iface_lock should be taken when accessing any of these fields
 985          */
 986         spinlock_t iface_lock;
 987         struct cifs_server_iface *iface_list;
 988         size_t iface_count;
 989         unsigned long iface_last_update; /* jiffies */
 990 };
 991
 992 static inline bool
 993 cap_unix(struct cifs_ses *ses)
 994 {
 995         return ses->server->vals->cap_unix & ses->capabilities;
 996 }
 997
 998 struct cached_fid {
 999         bool is_valid:1;        /* Do we have a useable root fid */
1000         bool file_all_info_is_valid:1;
1001
1002         struct kref refcount;
1003         struct cifs_fid *fid;
1004         struct mutex fid_mutex;
1005         struct cifs_tcon *tcon;
1006         struct work_struct lease_break;
1007         struct smb2_file_all_info file_all_info;
1008 };
1009
1010 /*
1011  * there is one of these for each connection to a resource on a particular
1012  * session
1013  */
1014 struct cifs_tcon {
1015         struct list_head tcon_list;
1016         int tc_count;
1017         struct list_head rlist; /* reconnect list */
1018         atomic_t num_local_opens;  /* num of all opens including disconnected */
1019         atomic_t num_remote_opens; /* num of all network opens on server */
1020         struct list_head openFileList;
1021         spinlock_t open_file_lock; /* protects list above */
1022         struct cifs_ses *ses;   /* pointer to session associated with */
1023         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1024         char *nativeFileSystem;
1025         char *password;         /* for share-level security */
1026         __u32 tid;              /* The 4 byte tree id */
1027         __u16 Flags;            /* optional support bits */
1028         enum statusEnum tidStatus;
1029         atomic_t num_smbs_sent;
1030         union {
1031                 struct {
1032                         atomic_t num_writes;
1033                         atomic_t num_reads;
1034                         atomic_t num_flushes;
1035                         atomic_t num_oplock_brks;
1036                         atomic_t num_opens;
1037                         atomic_t num_closes;
1038                         atomic_t num_deletes;
1039                         atomic_t num_mkdirs;
1040                         atomic_t num_posixopens;
1041                         atomic_t num_posixmkdirs;
1042                         atomic_t num_rmdirs;
1043                         atomic_t num_renames;
1044                         atomic_t num_t2renames;
1045                         atomic_t num_ffirst;
1046                         atomic_t num_fnext;
1047                         atomic_t num_fclose;
1048                         atomic_t num_hardlinks;
1049                         atomic_t num_symlinks;
1050                         atomic_t num_locks;
1051                         atomic_t num_acl_get;
1052                         atomic_t num_acl_set;
1053                 } cifs_stats;
1054                 struct {
1055                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1056                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1057                 } smb2_stats;
1058         } stats;
1059         __u64    bytes_read;
1060         __u64    bytes_written;
1061         spinlock_t stat_lock;  /* protects the two fields above */
1062         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1063         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1064         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1065         bool ipc:1;   /* set if connection to IPC$ share (always also pipe) */
1066         bool pipe:1;  /* set if connection to pipe share */
1067         bool print:1; /* set if connection to printer share */
1068         bool retry:1;
1069         bool nocase:1;
1070         bool nohandlecache:1; /* if strange server resource prob can turn off */
1071         bool seal:1;      /* transport encryption for this mounted share */
1072         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
1073                                 for this mount even if server would support */
1074         bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1075         bool local_lease:1; /* check leases (only) on local system not remote */
1076         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1077         bool broken_sparse_sup; /* if server or share does not support sparse */
1078         bool need_reconnect:1; /* connection reset, tid now invalid */
1079         bool need_reopen_files:1; /* need to reopen tcon file handles */
1080         bool use_resilient:1; /* use resilient instead of durable handles */
1081         bool use_persistent:1; /* use persistent instead of durable handles */
1082         __le32 capabilities;
1083         __u32 share_flags;
1084         __u32 maximal_access;
1085         __u32 vol_serial_number;
1086         __le64 vol_create_time;
1087         __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1088         __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1089         __u32 ss_flags;         /* sector size flags */
1090         __u32 perf_sector_size; /* best sector size for perf */
1091         __u32 max_chunks;
1092         __u32 max_bytes_chunk;
1093         __u32 max_bytes_copy;
1094 #ifdef CONFIG_CIFS_FSCACHE
1095         u64 resource_id;                /* server resource id */
1096         struct fscache_cookie *fscache; /* cookie for share */
1097 #endif
1098         struct list_head pending_opens; /* list of incomplete opens */
1099         struct cached_fid crfid; /* Cached root fid */
1100         /* BB add field for back pointer to sb struct(s)? */
1101 #ifdef CONFIG_CIFS_DFS_UPCALL
1102         char *dfs_path;
1103         int remap:2;
1104         struct list_head ulist; /* cache update list */
1105 #endif
1106 };
1107
1108 /*
1109  * This is a refcounted and timestamped container for a tcon pointer. The
1110  * container holds a tcon reference. It is considered safe to free one of
1111  * these when the tl_count goes to 0. The tl_time is the time of the last
1112  * "get" on the container.
1113  */
1114 struct tcon_link {
1115         struct rb_node          tl_rbnode;
1116         kuid_t                  tl_uid;
1117         unsigned long           tl_flags;
1118 #define TCON_LINK_MASTER        0
1119 #define TCON_LINK_PENDING       1
1120 #define TCON_LINK_IN_TREE       2
1121         unsigned long           tl_time;
1122         atomic_t                tl_count;
1123         struct cifs_tcon        *tl_tcon;
1124 };
1125
1126 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1127 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1128
1129 static inline struct cifs_tcon *
1130 tlink_tcon(struct tcon_link *tlink)
1131 {
1132         return tlink->tl_tcon;
1133 }
1134
1135 static inline struct tcon_link *
1136 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1137 {
1138         return cifs_sb->master_tlink;
1139 }
1140
1141 extern void cifs_put_tlink(struct tcon_link *tlink);
1142
1143 static inline struct tcon_link *
1144 cifs_get_tlink(struct tcon_link *tlink)
1145 {
1146         if (tlink && !IS_ERR(tlink))
1147                 atomic_inc(&tlink->tl_count);
1148         return tlink;
1149 }
1150
1151 /* This function is always expected to succeed */
1152 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1153
1154 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1155
1156 struct cifs_pending_open {
1157         struct list_head olist;
1158         struct tcon_link *tlink;
1159         __u8 lease_key[16];
1160         __u32 oplock;
1161 };
1162
1163 /*
1164  * This info hangs off the cifsFileInfo structure, pointed to by llist.
1165  * This is used to track byte stream locks on the file
1166  */
1167 struct cifsLockInfo {
1168         struct list_head llist; /* pointer to next cifsLockInfo */
1169         struct list_head blist; /* pointer to locks blocked on this */
1170         wait_queue_head_t block_q;
1171         __u64 offset;
1172         __u64 length;
1173         __u32 pid;
1174         __u16 type;
1175         __u16 flags;
1176 };
1177
1178 /*
1179  * One of these for each open instance of a file
1180  */
1181 struct cifs_search_info {
1182         loff_t index_of_last_entry;
1183         __u16 entries_in_buffer;
1184         __u16 info_level;
1185         __u32 resume_key;
1186         char *ntwrk_buf_start;
1187         char *srch_entries_start;
1188         char *last_entry;
1189         const char *presume_name;
1190         unsigned int resume_name_len;
1191         bool endOfSearch:1;
1192         bool emptyDir:1;
1193         bool unicode:1;
1194         bool smallBuf:1; /* so we know which buf_release function to call */
1195 };
1196
1197 struct cifs_open_parms {
1198         struct cifs_tcon *tcon;
1199         struct cifs_sb_info *cifs_sb;
1200         int disposition;
1201         int desired_access;
1202         int create_options;
1203         const char *path;
1204         struct cifs_fid *fid;
1205         umode_t mode;
1206         bool reconnect:1;
1207 };
1208
1209 struct cifs_fid {
1210         __u16 netfid;
1211         __u64 persistent_fid;   /* persist file id for smb2 */
1212         __u64 volatile_fid;     /* volatile file id for smb2 */
1213         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for smb2 */
1214         __u8 create_guid[16];
1215         struct cifs_pending_open *pending_open;
1216         unsigned int epoch;
1217 #ifdef CONFIG_CIFS_DEBUG2
1218         __u64 mid;
1219 #endif /* CIFS_DEBUG2 */
1220         bool purge_cache;
1221 };
1222
1223 struct cifs_fid_locks {
1224         struct list_head llist;
1225         struct cifsFileInfo *cfile;     /* fid that owns locks */
1226         struct list_head locks;         /* locks held by fid above */
1227 };
1228
1229 struct cifsFileInfo {
1230         /* following two lists are protected by tcon->open_file_lock */
1231         struct list_head tlist; /* pointer to next fid owned by tcon */
1232         struct list_head flist; /* next fid (file instance) for this inode */
1233         /* lock list below protected by cifsi->lock_sem */
1234         struct cifs_fid_locks *llist;   /* brlocks held by this fid */
1235         kuid_t uid;             /* allows finding which FileInfo structure */
1236         __u32 pid;              /* process id who opened file */
1237         struct cifs_fid fid;    /* file id from remote */
1238         struct list_head rlist; /* reconnect list */
1239         /* BB add lock scope info here if needed */ ;
1240         /* lock scope id (0 if none) */
1241         struct dentry *dentry;
1242         struct tcon_link *tlink;
1243         unsigned int f_flags;
1244         bool invalidHandle:1;   /* file closed via session abend */
1245         bool oplock_break_cancelled:1;
1246         int count;
1247         spinlock_t file_info_lock; /* protects four flag/count fields above */
1248         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1249         struct cifs_search_info srch_inf;
1250         struct work_struct oplock_break; /* work for oplock breaks */
1251 };
1252
1253 struct cifs_io_parms {
1254         __u16 netfid;
1255         __u64 persistent_fid;   /* persist file id for smb2 */
1256         __u64 volatile_fid;     /* volatile file id for smb2 */
1257         __u32 pid;
1258         __u64 offset;
1259         unsigned int length;
1260         struct cifs_tcon *tcon;
1261 };
1262
1263 struct cifs_aio_ctx {
1264         struct kref             refcount;
1265         struct list_head        list;
1266         struct mutex            aio_mutex;
1267         struct completion       done;
1268         struct iov_iter         iter;
1269         struct kiocb            *iocb;
1270         struct cifsFileInfo     *cfile;
1271         struct bio_vec          *bv;
1272         loff_t                  pos;
1273         unsigned int            npages;
1274         ssize_t                 rc;
1275         unsigned int            len;
1276         unsigned int            total_len;
1277         bool                    should_dirty;
1278         /*
1279          * Indicates if this aio_ctx is for direct_io,
1280          * If yes, iter is a copy of the user passed iov_iter
1281          */
1282         bool                    direct_io;
1283 };
1284
1285 struct cifs_readdata;
1286
1287 /* asynchronous read support */
1288 struct cifs_readdata {
1289         struct kref                     refcount;
1290         struct list_head                list;
1291         struct completion               done;
1292         struct cifsFileInfo             *cfile;
1293         struct address_space            *mapping;
1294         struct cifs_aio_ctx             *ctx;
1295         __u64                           offset;
1296         unsigned int                    bytes;
1297         unsigned int                    got_bytes;
1298         pid_t                           pid;
1299         int                             result;
1300         struct work_struct              work;
1301         int (*read_into_pages)(struct TCP_Server_Info *server,
1302                                 struct cifs_readdata *rdata,
1303                                 unsigned int len);
1304         int (*copy_into_pages)(struct TCP_Server_Info *server,
1305                                 struct cifs_readdata *rdata,
1306                                 struct iov_iter *iter);
1307         struct kvec                     iov[2];
1308 #ifdef CONFIG_CIFS_SMB_DIRECT
1309         struct smbd_mr                  *mr;
1310 #endif
1311         unsigned int                    pagesz;
1312         unsigned int                    page_offset;
1313         unsigned int                    tailsz;
1314         struct cifs_credits             credits;
1315         unsigned int                    nr_pages;
1316         struct page                     **pages;
1317 };
1318
1319 struct cifs_writedata;
1320
1321 /* asynchronous write support */
1322 struct cifs_writedata {
1323         struct kref                     refcount;
1324         struct list_head                list;
1325         struct completion               done;
1326         enum writeback_sync_modes       sync_mode;
1327         struct work_struct              work;
1328         struct cifsFileInfo             *cfile;
1329         struct cifs_aio_ctx             *ctx;
1330         __u64                           offset;
1331         pid_t                           pid;
1332         unsigned int                    bytes;
1333         int                             result;
1334 #ifdef CONFIG_CIFS_SMB_DIRECT
1335         struct smbd_mr                  *mr;
1336 #endif
1337         unsigned int                    pagesz;
1338         unsigned int                    page_offset;
1339         unsigned int                    tailsz;
1340         struct cifs_credits             credits;
1341         unsigned int                    nr_pages;
1342         struct page                     **pages;
1343 };
1344
1345 /*
1346  * Take a reference on the file private data. Must be called with
1347  * cfile->file_info_lock held.
1348  */
1349 static inline void
1350 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1351 {
1352         ++cifs_file->count;
1353 }
1354
1355 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1356 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr);
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)
1367 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1368 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
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         struct rw_semaphore lock_sem;   /* protect the fields above */
1378         /* BB add in lists for dirty pages i.e. write caching info for oplock */
1379         struct list_head openFileList;
1380         spinlock_t      open_file_lock; /* protects openFileList */
1381         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1382         unsigned int oplock;            /* oplock/lease level we have */
1383         unsigned int epoch;             /* used to track lease state changes */
1384 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1385 #define CIFS_INODE_PENDING_WRITERS        (1) /* Writes in progress */
1386 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1387 #define CIFS_INO_DELETE_PENDING           (3) /* delete pending on server */
1388 #define CIFS_INO_INVALID_MAPPING          (4) /* pagecache is invalid */
1389 #define CIFS_INO_LOCK                     (5) /* lock bit for synchronization */
1390         unsigned long flags;
1391         spinlock_t writers_lock;
1392         unsigned int writers;           /* Number of writers on this inode */
1393         unsigned long time;             /* jiffies of last update of inode */
1394         u64  server_eof;                /* current file size on server -- protected by i_lock */
1395         u64  uniqueid;                  /* server inode number */
1396         u64  createtime;                /* creation time on server */
1397         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for this inode */
1398 #ifdef CONFIG_CIFS_FSCACHE
1399         struct fscache_cookie *fscache;
1400 #endif
1401         struct inode vfs_inode;
1402 };
1403
1404 static inline struct cifsInodeInfo *
1405 CIFS_I(struct inode *inode)
1406 {
1407         return container_of(inode, struct cifsInodeInfo, vfs_inode);
1408 }
1409
1410 static inline struct cifs_sb_info *
1411 CIFS_SB(struct super_block *sb)
1412 {
1413         return sb->s_fs_info;
1414 }
1415
1416 static inline struct cifs_sb_info *
1417 CIFS_FILE_SB(struct file *file)
1418 {
1419         return CIFS_SB(file_inode(file)->i_sb);
1420 }
1421
1422 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1423 {
1424         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1425                 return '/';
1426         else
1427                 return '\\';
1428 }
1429
1430 static inline void
1431 convert_delimiter(char *path, char delim)
1432 {
1433         char old_delim, *pos;
1434
1435         if (delim == '/')
1436                 old_delim = '\\';
1437         else
1438                 old_delim = '/';
1439
1440         pos = path;
1441         while ((pos = strchr(pos, old_delim)))
1442                 *pos = delim;
1443 }
1444
1445 #define cifs_stats_inc atomic_inc
1446
1447 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1448                                             unsigned int bytes)
1449 {
1450         if (bytes) {
1451                 spin_lock(&tcon->stat_lock);
1452                 tcon->bytes_written += bytes;
1453                 spin_unlock(&tcon->stat_lock);
1454         }
1455 }
1456
1457 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1458                                          unsigned int bytes)
1459 {
1460         spin_lock(&tcon->stat_lock);
1461         tcon->bytes_read += bytes;
1462         spin_unlock(&tcon->stat_lock);
1463 }
1464
1465
1466 /*
1467  * This is the prototype for the mid receive function. This function is for
1468  * receiving the rest of the SMB frame, starting with the WordCount (which is
1469  * just after the MID in struct smb_hdr). Note:
1470  *
1471  * - This will be called by cifsd, with no locks held.
1472  * - The mid will still be on the pending_mid_q.
1473  * - mid->resp_buf will point to the current buffer.
1474  *
1475  * Returns zero on a successful receive, or an error. The receive state in
1476  * the TCP_Server_Info will also be updated.
1477  */
1478 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1479                             struct mid_q_entry *mid);
1480
1481 /*
1482  * This is the prototype for the mid callback function. This is called once the
1483  * mid has been received off of the socket. When creating one, take special
1484  * care to avoid deadlocks. Things to bear in mind:
1485  *
1486  * - it will be called by cifsd, with no locks held
1487  * - the mid will be removed from any lists
1488  */
1489 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1490
1491 /*
1492  * This is the protopyte for mid handle function. This is called once the mid
1493  * has been recognized after decryption of the message.
1494  */
1495 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1496                             struct mid_q_entry *mid);
1497
1498 /* one of these for every pending CIFS request to the server */
1499 struct mid_q_entry {
1500         struct list_head qhead; /* mids waiting on reply from this server */
1501         struct kref refcount;
1502         struct TCP_Server_Info *server; /* server corresponding to this mid */
1503         __u64 mid;              /* multiplex id */
1504         __u16 credits;          /* number of credits consumed by this mid */
1505         __u32 pid;              /* process id */
1506         __u32 sequence_number;  /* for CIFS signing */
1507         unsigned long when_alloc;  /* when mid was created */
1508 #ifdef CONFIG_CIFS_STATS2
1509         unsigned long when_sent; /* time when smb send finished */
1510         unsigned long when_received; /* when demux complete (taken off wire) */
1511 #endif
1512         mid_receive_t *receive; /* call receive callback */
1513         mid_callback_t *callback; /* call completion callback */
1514         mid_handle_t *handle; /* call handle mid callback */
1515         void *callback_data;      /* general purpose pointer for callback */
1516         void *resp_buf;         /* pointer to received SMB header */
1517         unsigned int resp_buf_size;
1518         int mid_state;  /* wish this were enum but can not pass to wait_event */
1519         unsigned int mid_flags;
1520         __le16 command;         /* smb command code */
1521         unsigned int optype;    /* operation type */
1522         bool large_buf:1;       /* if valid response, is pointer to large buf */
1523         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1524         bool multiEnd:1;        /* both received */
1525         bool decrypted:1;       /* decrypted entry */
1526 };
1527
1528 struct close_cancelled_open {
1529         struct cifs_fid         fid;
1530         struct cifs_tcon        *tcon;
1531         struct work_struct      work;
1532 };
1533
1534 /*      Make code in transport.c a little cleaner by moving
1535         update of optional stats into function below */
1536 #ifdef CONFIG_CIFS_STATS2
1537
1538 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1539 {
1540         atomic_inc(&server->in_send);
1541 }
1542
1543 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1544 {
1545         atomic_dec(&server->in_send);
1546 }
1547
1548 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1549 {
1550         atomic_inc(&server->num_waiters);
1551 }
1552
1553 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1554 {
1555         atomic_dec(&server->num_waiters);
1556 }
1557
1558 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1559 {
1560         mid->when_sent = jiffies;
1561 }
1562 #else
1563 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1564 {
1565 }
1566 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1567 {
1568 }
1569
1570 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1571 {
1572 }
1573
1574 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1575 {
1576 }
1577
1578 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1579 {
1580 }
1581 #endif
1582
1583 /* for pending dnotify requests */
1584 struct dir_notify_req {
1585         struct list_head lhead;
1586         __le16 Pid;
1587         __le16 PidHigh;
1588         __u16 Mid;
1589         __u16 Tid;
1590         __u16 Uid;
1591         __u16 netfid;
1592         __u32 filter; /* CompletionFilter (for multishot) */
1593         int multishot;
1594         struct file *pfile;
1595 };
1596
1597 struct dfs_info3_param {
1598         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1599         int path_consumed;
1600         int server_type;
1601         int ref_flag;
1602         char *path_name;
1603         char *node_name;
1604         int ttl;
1605 };
1606
1607 /*
1608  * common struct for holding inode info when searching for or updating an
1609  * inode with new info
1610  */
1611
1612 #define CIFS_FATTR_DFS_REFERRAL         0x1
1613 #define CIFS_FATTR_DELETE_PENDING       0x2
1614 #define CIFS_FATTR_NEED_REVAL           0x4
1615 #define CIFS_FATTR_INO_COLLISION        0x8
1616 #define CIFS_FATTR_UNKNOWN_NLINK        0x10
1617 #define CIFS_FATTR_FAKE_ROOT_INO        0x20
1618
1619 struct cifs_fattr {
1620         u32             cf_flags;
1621         u32             cf_cifsattrs;
1622         u64             cf_uniqueid;
1623         u64             cf_eof;
1624         u64             cf_bytes;
1625         u64             cf_createtime;
1626         kuid_t          cf_uid;
1627         kgid_t          cf_gid;
1628         umode_t         cf_mode;
1629         dev_t           cf_rdev;
1630         unsigned int    cf_nlink;
1631         unsigned int    cf_dtype;
1632         struct timespec64 cf_atime;
1633         struct timespec64 cf_mtime;
1634         struct timespec64 cf_ctime;
1635 };
1636
1637 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1638 {
1639         if (param) {
1640                 kfree(param->path_name);
1641                 kfree(param->node_name);
1642         }
1643 }
1644
1645 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1646                                        int number_of_items)
1647 {
1648         int i;
1649         if ((number_of_items == 0) || (param == NULL))
1650                 return;
1651         for (i = 0; i < number_of_items; i++) {
1652                 kfree(param[i].path_name);
1653                 kfree(param[i].node_name);
1654         }
1655         kfree(param);
1656 }
1657
1658 static inline bool is_interrupt_error(int error)
1659 {
1660         switch (error) {
1661         case -EINTR:
1662         case -ERESTARTSYS:
1663         case -ERESTARTNOHAND:
1664         case -ERESTARTNOINTR:
1665                 return true;
1666         }
1667         return false;
1668 }
1669
1670 static inline bool is_retryable_error(int error)
1671 {
1672         if (is_interrupt_error(error) || error == -EAGAIN)
1673                 return true;
1674         return false;
1675 }
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. Finally,
1819  * changes to the tcon->tidStatus should be done while holding this lock.
1820  * generally the locks should be taken in order tcp_ses_lock before
1821  * tcon->open_file_lock and that before file->file_info_lock since the
1822  * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1823  */
1824 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
1825
1826 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1827 /* Outstanding dir notify requests */
1828 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1829 /* DirNotify response queue */
1830 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1831 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1832
1833 /*
1834  * Global transaction id (XID) information
1835  */
1836 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
1837 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1838 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
1839 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
1840                                           /* on midQ entries */
1841 /*
1842  *  Global counters, updated atomically
1843  */
1844 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1845 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1846 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1847 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1848 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1849
1850 /* Various Debug counters */
1851 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
1852 #ifdef CONFIG_CIFS_STATS2
1853 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1854 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1855 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
1856 #endif
1857 GLOBAL_EXTERN atomic_t smBufAllocCount;
1858 GLOBAL_EXTERN atomic_t midCount;
1859
1860 /* Misc globals */
1861 extern bool enable_oplocks; /* enable or disable oplocks */
1862 extern bool lookupCacheEnabled;
1863 extern unsigned int global_secflags;    /* if on, session setup sent
1864                                 with more secure ntlmssp2 challenge/resp */
1865 extern unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
1866 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1867 extern unsigned int CIFSMaxBufSize;  /* max size not including hdr */
1868 extern unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
1869 extern unsigned int cifs_min_small;  /* min size of small buf pool */
1870 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1871 extern bool disable_legacy_dialects;  /* forbid vers=1.0 and vers=2.0 mounts */
1872
1873 #ifdef CONFIG_CIFS_ACL
1874 GLOBAL_EXTERN struct rb_root uidtree;
1875 GLOBAL_EXTERN struct rb_root gidtree;
1876 GLOBAL_EXTERN spinlock_t siduidlock;
1877 GLOBAL_EXTERN spinlock_t sidgidlock;
1878 GLOBAL_EXTERN struct rb_root siduidtree;
1879 GLOBAL_EXTERN struct rb_root sidgidtree;
1880 GLOBAL_EXTERN spinlock_t uidsidlock;
1881 GLOBAL_EXTERN spinlock_t gidsidlock;
1882 #endif /* CONFIG_CIFS_ACL */
1883
1884 void cifs_oplock_break(struct work_struct *work);
1885 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
1886
1887 extern const struct slow_work_ops cifs_oplock_break_ops;
1888 extern struct workqueue_struct *cifsiod_wq;
1889 extern struct workqueue_struct *cifsoplockd_wq;
1890 extern __u32 cifs_lock_secret;
1891
1892 extern mempool_t *cifs_mid_poolp;
1893
1894 /* Operations for different SMB versions */
1895 #define SMB1_VERSION_STRING     "1.0"
1896 extern struct smb_version_operations smb1_operations;
1897 extern struct smb_version_values smb1_values;
1898 #define SMB20_VERSION_STRING    "2.0"
1899 extern struct smb_version_operations smb20_operations;
1900 extern struct smb_version_values smb20_values;
1901 #define SMB21_VERSION_STRING    "2.1"
1902 extern struct smb_version_operations smb21_operations;
1903 extern struct smb_version_values smb21_values;
1904 #define SMBDEFAULT_VERSION_STRING "default"
1905 extern struct smb_version_values smbdefault_values;
1906 #define SMB3ANY_VERSION_STRING "3"
1907 extern struct smb_version_values smb3any_values;
1908 #define SMB30_VERSION_STRING    "3.0"
1909 extern struct smb_version_operations smb30_operations;
1910 extern struct smb_version_values smb30_values;
1911 #define SMB302_VERSION_STRING   "3.02"
1912 #define ALT_SMB302_VERSION_STRING "3.0.2"
1913 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1914 extern struct smb_version_values smb302_values;
1915 #define SMB311_VERSION_STRING   "3.1.1"
1916 #define ALT_SMB311_VERSION_STRING "3.11"
1917 extern struct smb_version_operations smb311_operations;
1918 extern struct smb_version_values smb311_values;
1919 #endif  /* _CIFS_GLOB_H */