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