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