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