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