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