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