fs/cifs/cifsglob.h

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