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