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