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