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