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