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