fs/cifs/cifsglob.h

   1 /*
   2  *   fs/cifs/cifsglob.h
   3  *
   4  *   Copyright (C) International Business Machines  Corp., 2002,2008
   5  *   Author(s): Steve French (sfrench@us.ibm.com)
   6  *              Jeremy Allison (jra@samba.org)
   7  *
   8  *   This library is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU Lesser General Public License as published
  10  *   by the Free Software Foundation; either version 2.1 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This library is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  16  *   the GNU Lesser General Public License for more details.
  17  *
  18  */
  19 #ifndef _CIFS_GLOB_H
  20 #define _CIFS_GLOB_H
  21
  22 #include <linux/in.h>
  23 #include <linux/in6.h>
  24 #include <linux/slab.h>
  25 #include <linux/mempool.h>
  26 #include <linux/workqueue.h>
  27 #include "cifs_fs_sb.h"
  28 #include "cifsacl.h"
  29 #include <crypto/internal/hash.h>
  30 #include <linux/scatterlist.h>
  31 #include <uapi/linux/cifs/cifs_mount.h>
  32 #ifdef CONFIG_CIFS_SMB2
  33 #include "smb2pdu.h"
  34 #endif
  35
  36 #define CIFS_MAGIC_NUMBER 0xFF534D42      /* the first four bytes of SMB PDUs */
  37
  38 /*
  39  * The sizes of various internal tables and strings
  40  */
  41 #define MAX_UID_INFO 16
  42 #define MAX_SES_INFO 2
  43 #define MAX_TCON_INFO 4
  44
  45 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
  46
  47 #define CIFS_MIN_RCV_POOL 4
  48
  49 #define MAX_REOPEN_ATT  5 /* these many maximum attempts to reopen a file */
  50 /*
  51  * default attribute cache timeout (jiffies)
  52  */
  53 #define CIFS_DEF_ACTIMEO (1 * HZ)
  54
  55 /*
  56  * max attribute cache timeout (jiffies) - 2^30
  57  */
  58 #define CIFS_MAX_ACTIMEO (1 << 30)
  59
  60 /*
  61  * MAX_REQ is the maximum number of requests that WE will send
  62  * on one socket concurrently.
  63  */
  64 #define CIFS_MAX_REQ 32767
  65
  66 #define RFC1001_NAME_LEN 15
  67 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
  68
  69 /* currently length of NIP6_FMT */
  70 #define SERVER_NAME_LENGTH 40
  71 #define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)
  72
  73 /* used to define string lengths for reversing unicode strings */
  74 /*         (256+1)*2 = 514                                     */
  75 /*           (max path length + 1 for null) * 2 for unicode    */
  76 #define MAX_NAME 514
  77
  78 /* SMB echo "timeout" -- FIXME: tunable? */
  79 #define SMB_ECHO_INTERVAL (60 * HZ)
  80
  81 #include "cifspdu.h"
  82
  83 #ifndef XATTR_DOS_ATTRIB
  84 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
  85 #endif
  86
  87 /*
  88  * CIFS vfs client Status information (based on what we know.)
  89  */
  90
  91 /* associated with each tcp and smb session */
  92 enum statusEnum {
  93         CifsNew = 0,
  94         CifsGood,
  95         CifsExiting,
  96         CifsNeedReconnect,
  97         CifsNeedNegotiate
  98 };
  99
 100 enum securityEnum {
 101         Unspecified = 0,        /* not specified */
 102         LANMAN,                 /* Legacy LANMAN auth */
 103         NTLM,                   /* Legacy NTLM012 auth with NTLM hash */
 104         NTLMv2,                 /* Legacy NTLM auth with NTLMv2 hash */
 105         RawNTLMSSP,             /* NTLMSSP without SPNEGO, NTLMv2 hash */
 106         Kerberos,               /* Kerberos via SPNEGO */
 107 };
 108
 109 struct session_key {
 110         unsigned int len;
 111         char *response;
 112 };
 113
 114 /* crypto security descriptor definition */
 115 struct sdesc {
 116         struct shash_desc shash;
 117         char ctx[];
 118 };
 119
 120 /* crypto hashing related structure/fields, not specific to a sec mech */
 121 struct cifs_secmech {
 122         struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
 123         struct crypto_shash *md5; /* md5 hash function */
 124         struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
 125         struct crypto_shash *cmacaes; /* block-cipher based MAC function */
 126         struct sdesc *sdeschmacmd5;  /* ctxt to generate ntlmv2 hash, CR1 */
 127         struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
 128         struct sdesc *sdeschmacsha256;  /* ctxt to generate smb2 signature */
 129         struct sdesc *sdesccmacaes;  /* ctxt to generate smb3 signature */
 130 };
 131
 132 /* per smb session structure/fields */
 133 struct ntlmssp_auth {
 134         bool sesskey_per_smbsess; /* whether session key is per smb session */
 135         __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
 136         __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
 137         unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
 138         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
 139 };
 140
 141 struct cifs_cred {
 142         int uid;
 143         int gid;
 144         int mode;
 145         int cecount;
 146         struct cifs_sid osid;
 147         struct cifs_sid gsid;
 148         struct cifs_ntace *ntaces;
 149         struct cifs_ace *aces;
 150 };
 151
 152 /*
 153  *****************************************************************
 154  * Except the CIFS PDUs themselves all the
 155  * globally interesting structs should go here
 156  *****************************************************************
 157  */
 158
 159 /*
 160  * A smb_rqst represents a complete request to be issued to a server. It's
 161  * formed by a kvec array, followed by an array of pages. Page data is assumed
 162  * to start at the beginning of the first page.
 163  */
 164 struct smb_rqst {
 165         struct kvec     *rq_iov;        /* array of kvecs */
 166         unsigned int    rq_nvec;        /* number of kvecs in array */
 167         struct page     **rq_pages;     /* pointer to array of page ptrs */
 168         unsigned int    rq_npages;      /* number pages in array */
 169         unsigned int    rq_pagesz;      /* page size to use */
 170         unsigned int    rq_tailsz;      /* length of last page */
 171 };
 172
 173 enum smb_version {
 174         Smb_1 = 1,
 175         Smb_20,
 176         Smb_21,
 177         Smb_30,
 178         Smb_302,
 179 };
 180
 181 struct mid_q_entry;
 182 struct TCP_Server_Info;
 183 struct cifsFileInfo;
 184 struct cifs_ses;
 185 struct cifs_tcon;
 186 struct dfs_info3_param;
 187 struct cifs_fattr;
 188 struct smb_vol;
 189 struct cifs_fid;
 190 struct cifs_readdata;
 191 struct cifs_writedata;
 192 struct cifs_io_parms;
 193 struct cifs_search_info;
 194 struct cifsInodeInfo;
 195 struct cifs_open_parms;
 196
 197 struct smb_version_operations {
 198         int (*send_cancel)(struct TCP_Server_Info *, void *,
 199                            struct mid_q_entry *);
 200         bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
 201         /* setup request: allocate mid, sign message */
 202         struct mid_q_entry *(*setup_request)(struct cifs_ses *,
 203                                                 struct smb_rqst *);
 204         /* setup async request: allocate mid, sign message */
 205         struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
 206                                                 struct smb_rqst *);
 207         /* check response: verify signature, map error */
 208         int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
 209                              bool);
 210         void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
 211                             const int);
 212         void (*set_credits)(struct TCP_Server_Info *, const int);
 213         int * (*get_credits_field)(struct TCP_Server_Info *, const int);
 214         unsigned int (*get_credits)(struct mid_q_entry *);
 215         __u64 (*get_next_mid)(struct TCP_Server_Info *);
 216         /* data offset from read response message */
 217         unsigned int (*read_data_offset)(char *);
 218         /* data length from read response message */
 219         unsigned int (*read_data_length)(char *);
 220         /* map smb to linux error */
 221         int (*map_error)(char *, bool);
 222         /* find mid corresponding to the response message */
 223         struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
 224         void (*dump_detail)(void *);
 225         void (*clear_stats)(struct cifs_tcon *);
 226         void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
 227         void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
 228         /* verify the message */
 229         int (*check_message)(char *, unsigned int);
 230         bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
 231         /* process transaction2 response */
 232         bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
 233                              char *, int);
 234         /* check if we need to negotiate */
 235         bool (*need_neg)(struct TCP_Server_Info *);
 236         /* negotiate to the server */
 237         int (*negotiate)(const unsigned int, struct cifs_ses *);
 238         /* set negotiated write size */
 239         unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
 240         /* set negotiated read size */
 241         unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
 242         /* setup smb sessionn */
 243         int (*sess_setup)(const unsigned int, struct cifs_ses *,
 244                           const struct nls_table *);
 245         /* close smb session */
 246         int (*logoff)(const unsigned int, struct cifs_ses *);
 247         /* connect to a server share */
 248         int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
 249                             struct cifs_tcon *, const struct nls_table *);
 250         /* close tree connecion */
 251         int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
 252         /* get DFS referrals */
 253         int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
 254                              const char *, struct dfs_info3_param **,
 255                              unsigned int *, const struct nls_table *, int);
 256         /* informational QFS call */
 257         void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
 258         /* check if a path is accessible or not */
 259         int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
 260                                   struct cifs_sb_info *, const char *);
 261         /* query path data from the server */
 262         int (*query_path_info)(const unsigned int, struct cifs_tcon *,
 263                                struct cifs_sb_info *, const char *,
 264                                FILE_ALL_INFO *, bool *, bool *);
 265         /* query file data from the server */
 266         int (*query_file_info)(const unsigned int, struct cifs_tcon *,
 267                                struct cifs_fid *, FILE_ALL_INFO *);
 268         /* get server index number */
 269         int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
 270                             struct cifs_sb_info *, const char *,
 271                             u64 *uniqueid, FILE_ALL_INFO *);
 272         /* set size by path */
 273         int (*set_path_size)(const unsigned int, struct cifs_tcon *,
 274                              const char *, __u64, struct cifs_sb_info *, bool);
 275         /* set size by file handle */
 276         int (*set_file_size)(const unsigned int, struct cifs_tcon *,
 277                              struct cifsFileInfo *, __u64, bool);
 278         /* set attributes */
 279         int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
 280                              const unsigned int);
 281         int (*set_compression)(const unsigned int, struct cifs_tcon *,
 282                                struct cifsFileInfo *);
 283         /* check if we can send an echo or nor */
 284         bool (*can_echo)(struct TCP_Server_Info *);
 285         /* send echo request */
 286         int (*echo)(struct TCP_Server_Info *);
 287         /* create directory */
 288         int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
 289                      struct cifs_sb_info *);
 290         /* set info on created directory */
 291         void (*mkdir_setinfo)(struct inode *, const char *,
 292                               struct cifs_sb_info *, struct cifs_tcon *,
 293                               const unsigned int);
 294         /* remove directory */
 295         int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
 296                      struct cifs_sb_info *);
 297         /* unlink file */
 298         int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
 299                       struct cifs_sb_info *);
 300         /* open, rename and delete file */
 301         int (*rename_pending_delete)(const char *, struct dentry *,
 302                                      const unsigned int);
 303         /* send rename request */
 304         int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
 305                       const char *, struct cifs_sb_info *);
 306         /* send create hardlink request */
 307         int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
 308                                const char *, const char *,
 309                                struct cifs_sb_info *);
 310         /* query symlink target */
 311         int (*query_symlink)(const unsigned int, struct cifs_tcon *,
 312                              const char *, char **, struct cifs_sb_info *);
 313         /* open a file for non-posix mounts */
 314         int (*open)(const unsigned int, struct cifs_open_parms *,
 315                     __u32 *, FILE_ALL_INFO *);
 316         /* set fid protocol-specific info */
 317         void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
 318         /* close a file */
 319         void (*close)(const unsigned int, struct cifs_tcon *,
 320                       struct cifs_fid *);
 321         /* send a flush request to the server */
 322         int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
 323         /* async read from the server */
 324         int (*async_readv)(struct cifs_readdata *);
 325         /* async write to the server */
 326         int (*async_writev)(struct cifs_writedata *);
 327         /* sync read from the server */
 328         int (*sync_read)(const unsigned int, struct cifsFileInfo *,
 329                          struct cifs_io_parms *, unsigned int *, char **,
 330                          int *);
 331         /* sync write to the server */
 332         int (*sync_write)(const unsigned int, struct cifsFileInfo *,
 333                           struct cifs_io_parms *, unsigned int *, struct kvec *,
 334                           unsigned long);
 335         /* open dir, start readdir */
 336         int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
 337                                const char *, struct cifs_sb_info *,
 338                                struct cifs_fid *, __u16,
 339                                struct cifs_search_info *);
 340         /* continue readdir */
 341         int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
 342                               struct cifs_fid *,
 343                               __u16, struct cifs_search_info *srch_inf);
 344         /* close dir */
 345         int (*close_dir)(const unsigned int, struct cifs_tcon *,
 346                          struct cifs_fid *);
 347         /* calculate a size of SMB message */
 348         unsigned int (*calc_smb_size)(void *);
 349         /* check for STATUS_PENDING and process it in a positive case */
 350         bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
 351         /* send oplock break response */
 352         int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
 353                                struct cifsInodeInfo *);
 354         /* query remote filesystem */
 355         int (*queryfs)(const unsigned int, struct cifs_tcon *,
 356                        struct kstatfs *);
 357         /* send mandatory brlock to the server */
 358         int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
 359                          __u64, __u32, int, int, bool);
 360         /* unlock range of mandatory locks */
 361         int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
 362                                  const unsigned int);
 363         /* push brlocks from the cache to the server */
 364         int (*push_mand_locks)(struct cifsFileInfo *);
 365         /* get lease key of the inode */
 366         void (*get_lease_key)(struct inode *, struct cifs_fid *);
 367         /* set lease key of the inode */
 368         void (*set_lease_key)(struct inode *, struct cifs_fid *);
 369         /* generate new lease key */
 370         void (*new_lease_key)(struct cifs_fid *);
 371         int (*generate_signingkey)(struct cifs_ses *);
 372         int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
 373         int (*query_mf_symlink)(const unsigned char *, char *, unsigned int *,
 374                                 struct cifs_sb_info *, unsigned int);
 375         /* if we can do cache read operations */
 376         bool (*is_read_op)(__u32);
 377         /* set oplock level for the inode */
 378         void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
 379                                  bool *);
 380         /* create lease context buffer for CREATE request */
 381         char * (*create_lease_buf)(u8 *, u8);
 382         /* parse lease context buffer and return oplock/epoch info */
 383         __u8 (*parse_lease_buf)(void *, unsigned int *);
 384         int (*clone_range)(const unsigned int, struct cifsFileInfo *src_file,
 385                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
 386                         u64 dest_off);
 387 };
 388
 389 struct smb_version_values {
 390         char            *version_string;
 391         __u16           protocol_id;
 392         __u32           req_capabilities;
 393         __u32           large_lock_type;
 394         __u32           exclusive_lock_type;
 395         __u32           shared_lock_type;
 396         __u32           unlock_lock_type;
 397         size_t          header_size;
 398         size_t          max_header_size;
 399         size_t          read_rsp_size;
 400         __le16          lock_cmd;
 401         unsigned int    cap_unix;
 402         unsigned int    cap_nt_find;
 403         unsigned int    cap_large_files;
 404         __u16           signing_enabled;
 405         __u16           signing_required;
 406         size_t          create_lease_size;
 407 };
 408
 409 #define HEADER_SIZE(server) (server->vals->header_size)
 410 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
 411
 412 struct smb_vol {
 413         char *username;
 414         char *password;
 415         char *domainname;
 416         char *UNC;
 417         char *iocharset;  /* local code page for mapping to and from Unicode */
 418         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
 419         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
 420         kuid_t cred_uid;
 421         kuid_t linux_uid;
 422         kgid_t linux_gid;
 423         kuid_t backupuid;
 424         kgid_t backupgid;
 425         umode_t file_mode;
 426         umode_t dir_mode;
 427         enum securityEnum sectype; /* sectype requested via mnt opts */
 428         bool sign; /* was signing requested via mnt opts? */
 429         bool retry:1;
 430         bool intr:1;
 431         bool setuids:1;
 432         bool override_uid:1;
 433         bool override_gid:1;
 434         bool dynperm:1;
 435         bool noperm:1;
 436         bool no_psx_acl:1; /* set if posix acl support should be disabled */
 437         bool cifs_acl:1;
 438         bool backupuid_specified; /* mount option  backupuid  is specified */
 439         bool backupgid_specified; /* mount option  backupgid  is specified */
 440         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
 441         bool server_ino:1; /* use inode numbers from server ie UniqueId */
 442         bool direct_io:1;
 443         bool strict_io:1; /* strict cache behavior */
 444         bool remap:1;      /* set to remap seven reserved chars in filenames */
 445         bool posix_paths:1; /* unset to not ask for posix pathnames. */
 446         bool no_linux_ext:1;
 447         bool sfu_emul:1;
 448         bool nullauth:1;   /* attempt to authenticate with null user */
 449         bool nocase:1;     /* request case insensitive filenames */
 450         bool nobrl:1;      /* disable sending byte range locks to srv */
 451         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
 452         bool seal:1;       /* request transport encryption on share */
 453         bool nodfs:1;      /* Do not request DFS, even if available */
 454         bool local_lease:1; /* check leases only on local system, not remote */
 455         bool noblocksnd:1;
 456         bool noautotune:1;
 457         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
 458         bool fsc:1;     /* enable fscache */
 459         bool mfsymlinks:1; /* use Minshall+French Symlinks */
 460         bool multiuser:1;
 461         bool rwpidforward:1; /* pid forward for read/write operations */
 462         bool nosharesock;
 463         unsigned int rsize;
 464         unsigned int wsize;
 465         bool sockopt_tcp_nodelay:1;
 466         unsigned long actimeo; /* attribute cache timeout (jiffies) */
 467         struct smb_version_operations *ops;
 468         struct smb_version_values *vals;
 469         char *prepath;
 470         struct sockaddr_storage dstaddr; /* destination address */
 471         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
 472         struct nls_table *local_nls;
 473 };
 474
 475 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
 476                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
 477                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
 478                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
 479                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
 480                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
 481                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
 482                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
 483                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
 484                          CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
 485
 486 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
 487                       MS_NODEV | MS_SYNCHRONOUS)
 488
 489 struct cifs_mnt_data {
 490         struct cifs_sb_info *cifs_sb;
 491         struct smb_vol *vol;
 492         int flags;
 493 };
 494
 495 static inline unsigned int
 496 get_rfc1002_length(void *buf)
 497 {
 498         return be32_to_cpu(*((__be32 *)buf));
 499 }
 500
 501 static inline void
 502 inc_rfc1001_len(void *buf, int count)
 503 {
 504         be32_add_cpu((__be32 *)buf, count);
 505 }
 506
 507 struct TCP_Server_Info {
 508         struct list_head tcp_ses_list;
 509         struct list_head smb_ses_list;
 510         int srv_count; /* reference counter */
 511         /* 15 character server name + 0x20 16th byte indicating type = srv */
 512         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 513         struct smb_version_operations   *ops;
 514         struct smb_version_values       *vals;
 515         enum statusEnum tcpStatus; /* what we think the status is */
 516         char *hostname; /* hostname portion of UNC string */
 517         struct socket *ssocket;
 518         struct sockaddr_storage dstaddr;
 519         struct sockaddr_storage srcaddr; /* locally bind to this IP */
 520 #ifdef CONFIG_NET_NS
 521         struct net *net;
 522 #endif
 523         wait_queue_head_t response_q;
 524         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
 525         struct list_head pending_mid_q;
 526         bool noblocksnd;                /* use blocking sendmsg */
 527         bool noautotune;                /* do not autotune send buf sizes */
 528         bool tcp_nodelay;
 529         int credits;  /* send no more requests at once */
 530         unsigned int in_flight;  /* number of requests on the wire to server */
 531         spinlock_t req_lock;  /* protect the two values above */
 532         struct mutex srv_mutex;
 533         struct task_struct *tsk;
 534         char server_GUID[16];
 535         __u16 sec_mode;
 536         bool sign; /* is signing enabled on this connection? */
 537         bool session_estab; /* mark when very first sess is established */
 538 #ifdef CONFIG_CIFS_SMB2
 539         int echo_credits;  /* echo reserved slots */
 540         int oplock_credits;  /* oplock break reserved slots */
 541         bool echoes:1; /* enable echoes */
 542 #endif
 543         u16 dialect; /* dialect index that server chose */
 544         bool oplocks:1; /* enable oplocks */
 545         unsigned int maxReq;    /* Clients should submit no more */
 546         /* than maxReq distinct unanswered SMBs to the server when using  */
 547         /* multiplexed reads or writes */
 548         unsigned int maxBuf;    /* maxBuf specifies the maximum */
 549         /* message size the server can send or receive for non-raw SMBs */
 550         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
 551         /* when socket is setup (and during reconnect) before NegProt sent */
 552         unsigned int max_rw;    /* maxRw specifies the maximum */
 553         /* message size the server can send or receive for */
 554         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
 555         unsigned int capabilities; /* selective disabling of caps by smb sess */
 556         int timeAdj;  /* Adjust for difference in server time zone in sec */
 557         __u64 CurrentMid;         /* multiplex id - rotating counter */
 558         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
 559         /* 16th byte of RFC1001 workstation name is always null */
 560         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 561         __u32 sequence_number; /* for signing, protected by srv_mutex */
 562         struct session_key session_key;
 563         unsigned long lstrp; /* when we got last response from this server */
 564         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
 565 #define CIFS_NEGFLAVOR_LANMAN   0       /* wct == 13, LANMAN */
 566 #define CIFS_NEGFLAVOR_UNENCAP  1       /* wct == 17, but no ext_sec */
 567 #define CIFS_NEGFLAVOR_EXTENDED 2       /* wct == 17, ext_sec bit set */
 568         char    negflavor;      /* NEGOTIATE response flavor */
 569         /* extended security flavors that server supports */
 570         bool    sec_ntlmssp;            /* supports NTLMSSP */
 571         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
 572         bool    sec_kerberos;           /* supports plain Kerberos */
 573         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
 574         bool    large_buf;              /* is current buffer large? */
 575         struct delayed_work     echo; /* echo ping workqueue job */
 576         struct kvec *iov;       /* reusable kvec array for receives */
 577         unsigned int nr_iov;    /* number of kvecs in array */
 578         char    *smallbuf;      /* pointer to current "small" buffer */
 579         char    *bigbuf;        /* pointer to current "big" buffer */
 580         unsigned int total_read; /* total amount of data read in this pass */
 581 #ifdef CONFIG_CIFS_FSCACHE
 582         struct fscache_cookie   *fscache; /* client index cache cookie */
 583 #endif
 584 #ifdef CONFIG_CIFS_STATS2
 585         atomic_t in_send; /* requests trying to send */
 586         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
 587 #endif
 588 #ifdef CONFIG_CIFS_SMB2
 589         unsigned int    max_read;
 590         unsigned int    max_write;
 591 #endif /* CONFIG_CIFS_SMB2 */
 592 };
 593
 594 static inline unsigned int
 595 in_flight(struct TCP_Server_Info *server)
 596 {
 597         unsigned int num;
 598         spin_lock(&server->req_lock);
 599         num = server->in_flight;
 600         spin_unlock(&server->req_lock);
 601         return num;
 602 }
 603
 604 static inline bool
 605 has_credits(struct TCP_Server_Info *server, int *credits)
 606 {
 607         int num;
 608         spin_lock(&server->req_lock);
 609         num = *credits;
 610         spin_unlock(&server->req_lock);
 611         return num > 0;
 612 }
 613
 614 static inline void
 615 add_credits(struct TCP_Server_Info *server, const unsigned int add,
 616             const int optype)
 617 {
 618         server->ops->add_credits(server, add, optype);
 619 }
 620
 621 static inline void
 622 set_credits(struct TCP_Server_Info *server, const int val)
 623 {
 624         server->ops->set_credits(server, val);
 625 }
 626
 627 static inline __u64
 628 get_next_mid64(struct TCP_Server_Info *server)
 629 {
 630         return server->ops->get_next_mid(server);
 631 }
 632
 633 static inline __le16
 634 get_next_mid(struct TCP_Server_Info *server)
 635 {
 636         __u16 mid = get_next_mid64(server);
 637         /*
 638          * The value in the SMB header should be little endian for easy
 639          * on-the-wire decoding.
 640          */
 641         return cpu_to_le16(mid);
 642 }
 643
 644 static inline __u16
 645 get_mid(const struct smb_hdr *smb)
 646 {
 647         return le16_to_cpu(smb->Mid);
 648 }
 649
 650 static inline bool
 651 compare_mid(__u16 mid, const struct smb_hdr *smb)
 652 {
 653         return mid == le16_to_cpu(smb->Mid);
 654 }
 655
 656 /*
 657  * When the server supports very large reads and writes via POSIX extensions,
 658  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
 659  * including the RFC1001 length.
 660  *
 661  * Note that this might make for "interesting" allocation problems during
 662  * writeback however as we have to allocate an array of pointers for the
 663  * pages. A 16M write means ~32kb page array with PAGE_CACHE_SIZE == 4096.
 664  *
 665  * For reads, there is a similar problem as we need to allocate an array
 666  * of kvecs to handle the receive, though that should only need to be done
 667  * once.
 668  */
 669 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
 670 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
 671
 672 /*
 673  * When the server doesn't allow large posix writes, only allow a rsize/wsize
 674  * of 2^17-1 minus the size of the call header. That allows for a read or
 675  * write up to the maximum size described by RFC1002.
 676  */
 677 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
 678 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
 679
 680 /*
 681  * The default wsize is 1M. find_get_pages seems to return a maximum of 256
 682  * pages in a single call. With PAGE_CACHE_SIZE == 4k, this means we can fill
 683  * a single wsize request with a single call.
 684  */
 685 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
 686
 687 /*
 688  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
 689  * those values when posix extensions aren't in force. In actuality here, we
 690  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
 691  * to be ok with the extra byte even though Windows doesn't send writes that
 692  * are that large.
 693  *
 694  * Citation:
 695  *
 696  * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
 697  */
 698 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
 699 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
 700
 701 /*
 702  * Macros to allow the TCP_Server_Info->net field and related code to drop out
 703  * when CONFIG_NET_NS isn't set.
 704  */
 705
 706 #ifdef CONFIG_NET_NS
 707
 708 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 709 {
 710         return srv->net;
 711 }
 712
 713 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 714 {
 715         srv->net = net;
 716 }
 717
 718 #else
 719
 720 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 721 {
 722         return &init_net;
 723 }
 724
 725 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 726 {
 727 }
 728
 729 #endif
 730
 731 /*
 732  * Session structure.  One of these for each uid session with a particular host
 733  */
 734 struct cifs_ses {
 735         struct list_head smb_ses_list;
 736         struct list_head tcon_list;
 737         struct mutex session_mutex;
 738         struct TCP_Server_Info *server; /* pointer to server info */
 739         int ses_count;          /* reference counter */
 740         enum statusEnum status;
 741         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
 742         __u16 ipc_tid;          /* special tid for connection to IPC share */
 743         char *serverOS;         /* name of operating system underlying server */
 744         char *serverNOS;        /* name of network operating system of server */
 745         char *serverDomain;     /* security realm of server */
 746         __u64 Suid;             /* remote smb uid  */
 747         kuid_t linux_uid;       /* overriding owner of files on the mount */
 748         kuid_t cred_uid;        /* owner of credentials */
 749         unsigned int capabilities;
 750         char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
 751                                 TCP names - will ipv6 and sctp addresses fit? */
 752         char *user_name;        /* must not be null except during init of sess
 753                                    and after mount option parsing we fill it */
 754         char *domainName;
 755         char *password;
 756         struct session_key auth_key;
 757         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
 758         enum securityEnum sectype; /* what security flavor was specified? */
 759         bool sign;              /* is signing required? */
 760         bool need_reconnect:1; /* connection reset, uid now invalid */
 761 #ifdef CONFIG_CIFS_SMB2
 762         __u16 session_flags;
 763         char smb3signingkey[SMB3_SIGN_KEY_SIZE]; /* for signing smb3 packets */
 764 #endif /* CONFIG_CIFS_SMB2 */
 765 };
 766
 767 static inline bool
 768 cap_unix(struct cifs_ses *ses)
 769 {
 770         return ses->server->vals->cap_unix & ses->capabilities;
 771 }
 772
 773 /*
 774  * there is one of these for each connection to a resource on a particular
 775  * session
 776  */
 777 struct cifs_tcon {
 778         struct list_head tcon_list;
 779         int tc_count;
 780         struct list_head openFileList;
 781         struct cifs_ses *ses;   /* pointer to session associated with */
 782         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
 783         char *nativeFileSystem;
 784         char *password;         /* for share-level security */
 785         __u32 tid;              /* The 4 byte tree id */
 786         __u16 Flags;            /* optional support bits */
 787         enum statusEnum tidStatus;
 788 #ifdef CONFIG_CIFS_STATS
 789         atomic_t num_smbs_sent;
 790         union {
 791                 struct {
 792                         atomic_t num_writes;
 793                         atomic_t num_reads;
 794                         atomic_t num_flushes;
 795                         atomic_t num_oplock_brks;
 796                         atomic_t num_opens;
 797                         atomic_t num_closes;
 798                         atomic_t num_deletes;
 799                         atomic_t num_mkdirs;
 800                         atomic_t num_posixopens;
 801                         atomic_t num_posixmkdirs;
 802                         atomic_t num_rmdirs;
 803                         atomic_t num_renames;
 804                         atomic_t num_t2renames;
 805                         atomic_t num_ffirst;
 806                         atomic_t num_fnext;
 807                         atomic_t num_fclose;
 808                         atomic_t num_hardlinks;
 809                         atomic_t num_symlinks;
 810                         atomic_t num_locks;
 811                         atomic_t num_acl_get;
 812                         atomic_t num_acl_set;
 813                 } cifs_stats;
 814 #ifdef CONFIG_CIFS_SMB2
 815                 struct {
 816                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
 817                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
 818                 } smb2_stats;
 819 #endif /* CONFIG_CIFS_SMB2 */
 820         } stats;
 821 #ifdef CONFIG_CIFS_STATS2
 822         unsigned long long time_writes;
 823         unsigned long long time_reads;
 824         unsigned long long time_opens;
 825         unsigned long long time_deletes;
 826         unsigned long long time_closes;
 827         unsigned long long time_mkdirs;
 828         unsigned long long time_rmdirs;
 829         unsigned long long time_renames;
 830         unsigned long long time_t2renames;
 831         unsigned long long time_ffirst;
 832         unsigned long long time_fnext;
 833         unsigned long long time_fclose;
 834 #endif /* CONFIG_CIFS_STATS2 */
 835         __u64    bytes_read;
 836         __u64    bytes_written;
 837         spinlock_t stat_lock;
 838 #endif /* CONFIG_CIFS_STATS */
 839         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
 840         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
 841         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
 842         bool ipc:1;             /* set if connection to IPC$ eg for RPC/PIPES */
 843         bool retry:1;
 844         bool nocase:1;
 845         bool seal:1;      /* transport encryption for this mounted share */
 846         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
 847                                 for this mount even if server would support */
 848         bool local_lease:1; /* check leases (only) on local system not remote */
 849         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
 850         bool need_reconnect:1; /* connection reset, tid now invalid */
 851 #ifdef CONFIG_CIFS_SMB2
 852         bool print:1;           /* set if connection to printer share */
 853         bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
 854         __le32 capabilities;
 855         __u32 share_flags;
 856         __u32 maximal_access;
 857         __u32 vol_serial_number;
 858         __le64 vol_create_time;
 859         __u32 ss_flags;         /* sector size flags */
 860         __u32 perf_sector_size; /* best sector size for perf */
 861         __u32 max_chunks;
 862         __u32 max_bytes_chunk;
 863         __u32 max_bytes_copy;
 864 #endif /* CONFIG_CIFS_SMB2 */
 865 #ifdef CONFIG_CIFS_FSCACHE
 866         u64 resource_id;                /* server resource id */
 867         struct fscache_cookie *fscache; /* cookie for share */
 868 #endif
 869         struct list_head pending_opens; /* list of incomplete opens */
 870         /* BB add field for back pointer to sb struct(s)? */
 871 };
 872
 873 /*
 874  * This is a refcounted and timestamped container for a tcon pointer. The
 875  * container holds a tcon reference. It is considered safe to free one of
 876  * these when the tl_count goes to 0. The tl_time is the time of the last
 877  * "get" on the container.
 878  */
 879 struct tcon_link {
 880         struct rb_node          tl_rbnode;
 881         kuid_t                  tl_uid;
 882         unsigned long           tl_flags;
 883 #define TCON_LINK_MASTER        0
 884 #define TCON_LINK_PENDING       1
 885 #define TCON_LINK_IN_TREE       2
 886         unsigned long           tl_time;
 887         atomic_t                tl_count;
 888         struct cifs_tcon        *tl_tcon;
 889 };
 890
 891 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
 892
 893 static inline struct cifs_tcon *
 894 tlink_tcon(struct tcon_link *tlink)
 895 {
 896         return tlink->tl_tcon;
 897 }
 898
 899 extern void cifs_put_tlink(struct tcon_link *tlink);
 900
 901 static inline struct tcon_link *
 902 cifs_get_tlink(struct tcon_link *tlink)
 903 {
 904         if (tlink && !IS_ERR(tlink))
 905                 atomic_inc(&tlink->tl_count);
 906         return tlink;
 907 }
 908
 909 /* This function is always expected to succeed */
 910 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
 911
 912 #define CIFS_OPLOCK_NO_CHANGE 0xfe
 913
 914 struct cifs_pending_open {
 915         struct list_head olist;
 916         struct tcon_link *tlink;
 917         __u8 lease_key[16];
 918         __u32 oplock;
 919 };
 920
 921 /*
 922  * This info hangs off the cifsFileInfo structure, pointed to by llist.
 923  * This is used to track byte stream locks on the file
 924  */
 925 struct cifsLockInfo {
 926         struct list_head llist; /* pointer to next cifsLockInfo */
 927         struct list_head blist; /* pointer to locks blocked on this */
 928         wait_queue_head_t block_q;
 929         __u64 offset;
 930         __u64 length;
 931         __u32 pid;
 932         __u32 type;
 933 };
 934
 935 /*
 936  * One of these for each open instance of a file
 937  */
 938 struct cifs_search_info {
 939         loff_t index_of_last_entry;
 940         __u16 entries_in_buffer;
 941         __u16 info_level;
 942         __u32 resume_key;
 943         char *ntwrk_buf_start;
 944         char *srch_entries_start;
 945         char *last_entry;
 946         const char *presume_name;
 947         unsigned int resume_name_len;
 948         bool endOfSearch:1;
 949         bool emptyDir:1;
 950         bool unicode:1;
 951         bool smallBuf:1; /* so we know which buf_release function to call */
 952 };
 953
 954 struct cifs_open_parms {
 955         struct cifs_tcon *tcon;
 956         struct cifs_sb_info *cifs_sb;
 957         int disposition;
 958         int desired_access;
 959         int create_options;
 960         const char *path;
 961         struct cifs_fid *fid;
 962         bool reconnect:1;
 963 };
 964
 965 struct cifs_fid {
 966         __u16 netfid;
 967 #ifdef CONFIG_CIFS_SMB2
 968         __u64 persistent_fid;   /* persist file id for smb2 */
 969         __u64 volatile_fid;     /* volatile file id for smb2 */
 970         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for smb2 */
 971 #endif
 972         struct cifs_pending_open *pending_open;
 973         unsigned int epoch;
 974         bool purge_cache;
 975 };
 976
 977 struct cifs_fid_locks {
 978         struct list_head llist;
 979         struct cifsFileInfo *cfile;     /* fid that owns locks */
 980         struct list_head locks;         /* locks held by fid above */
 981 };
 982
 983 struct cifsFileInfo {
 984         struct list_head tlist; /* pointer to next fid owned by tcon */
 985         struct list_head flist; /* next fid (file instance) for this inode */
 986         struct cifs_fid_locks *llist;   /* brlocks held by this fid */
 987         kuid_t uid;             /* allows finding which FileInfo structure */
 988         __u32 pid;              /* process id who opened file */
 989         struct cifs_fid fid;    /* file id from remote */
 990         /* BB add lock scope info here if needed */ ;
 991         /* lock scope id (0 if none) */
 992         struct dentry *dentry;
 993         unsigned int f_flags;
 994         struct tcon_link *tlink;
 995         bool invalidHandle:1;   /* file closed via session abend */
 996         bool oplock_break_cancelled:1;
 997         int count;              /* refcount protected by cifs_file_list_lock */
 998         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
 999         struct cifs_search_info srch_inf;
1000         struct work_struct oplock_break; /* work for oplock breaks */
1001 };
1002
1003 struct cifs_io_parms {
1004         __u16 netfid;
1005 #ifdef CONFIG_CIFS_SMB2
1006         __u64 persistent_fid;   /* persist file id for smb2 */
1007         __u64 volatile_fid;     /* volatile file id for smb2 */
1008 #endif
1009         __u32 pid;
1010         __u64 offset;
1011         unsigned int length;
1012         struct cifs_tcon *tcon;
1013 };
1014
1015 struct cifs_readdata;
1016
1017 /* asynchronous read support */
1018 struct cifs_readdata {
1019         struct kref                     refcount;
1020         struct list_head                list;
1021         struct completion               done;
1022         struct cifsFileInfo             *cfile;
1023         struct address_space            *mapping;
1024         __u64                           offset;
1025         unsigned int                    bytes;
1026         pid_t                           pid;
1027         int                             result;
1028         struct work_struct              work;
1029         int (*read_into_pages)(struct TCP_Server_Info *server,
1030                                 struct cifs_readdata *rdata,
1031                                 unsigned int len);
1032         struct kvec                     iov;
1033         unsigned int                    pagesz;
1034         unsigned int                    tailsz;
1035         unsigned int                    nr_pages;
1036         struct page                     *pages[];
1037 };
1038
1039 struct cifs_writedata;
1040
1041 /* asynchronous write support */
1042 struct cifs_writedata {
1043         struct kref                     refcount;
1044         struct list_head                list;
1045         struct completion               done;
1046         enum writeback_sync_modes       sync_mode;
1047         struct work_struct              work;
1048         struct cifsFileInfo             *cfile;
1049         __u64                           offset;
1050         pid_t                           pid;
1051         unsigned int                    bytes;
1052         int                             result;
1053         unsigned int                    pagesz;
1054         unsigned int                    tailsz;
1055         unsigned int                    nr_pages;
1056         struct page                     *pages[1];
1057 };
1058
1059 /*
1060  * Take a reference on the file private data. Must be called with
1061  * cifs_file_list_lock held.
1062  */
1063 static inline void
1064 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1065 {
1066         ++cifs_file->count;
1067 }
1068
1069 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1070 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1071
1072 #define CIFS_CACHE_READ_FLG     1
1073 #define CIFS_CACHE_HANDLE_FLG   2
1074 #define CIFS_CACHE_RH_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1075 #define CIFS_CACHE_WRITE_FLG    4
1076 #define CIFS_CACHE_RW_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1077 #define CIFS_CACHE_RHW_FLG      (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1078
1079 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1080 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1081 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1082
1083 /*
1084  * One of these for each file inode
1085  */
1086
1087 struct cifsInodeInfo {
1088         bool can_cache_brlcks;
1089         struct list_head llist; /* locks helb by this inode */
1090         struct rw_semaphore lock_sem;   /* protect the fields above */
1091         /* BB add in lists for dirty pages i.e. write caching info for oplock */
1092         struct list_head openFileList;
1093         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1094         unsigned int oplock;            /* oplock/lease level we have */
1095         unsigned int epoch;             /* used to track lease state changes */
1096         bool delete_pending;            /* DELETE_ON_CLOSE is set */
1097         bool invalid_mapping;           /* pagecache is invalid */
1098         unsigned long time;             /* jiffies of last update of inode */
1099         u64  server_eof;                /* current file size on server -- protected by i_lock */
1100         u64  uniqueid;                  /* server inode number */
1101         u64  createtime;                /* creation time on server */
1102 #ifdef CONFIG_CIFS_SMB2
1103         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for this inode */
1104 #endif
1105 #ifdef CONFIG_CIFS_FSCACHE
1106         struct fscache_cookie *fscache;
1107 #endif
1108         struct inode vfs_inode;
1109 };
1110
1111 static inline struct cifsInodeInfo *
1112 CIFS_I(struct inode *inode)
1113 {
1114         return container_of(inode, struct cifsInodeInfo, vfs_inode);
1115 }
1116
1117 static inline struct cifs_sb_info *
1118 CIFS_SB(struct super_block *sb)
1119 {
1120         return sb->s_fs_info;
1121 }
1122
1123 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1124 {
1125         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1126                 return '/';
1127         else
1128                 return '\\';
1129 }
1130
1131 static inline void
1132 convert_delimiter(char *path, char delim)
1133 {
1134         char old_delim, *pos;
1135
1136         if (delim == '/')
1137                 old_delim = '\\';
1138         else
1139                 old_delim = '/';
1140
1141         pos = path;
1142         while ((pos = strchr(pos, old_delim)))
1143                 *pos = delim;
1144 }
1145
1146 #ifdef CONFIG_CIFS_STATS
1147 #define cifs_stats_inc atomic_inc
1148
1149 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1150                                             unsigned int bytes)
1151 {
1152         if (bytes) {
1153                 spin_lock(&tcon->stat_lock);
1154                 tcon->bytes_written += bytes;
1155                 spin_unlock(&tcon->stat_lock);
1156         }
1157 }
1158
1159 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1160                                          unsigned int bytes)
1161 {
1162         spin_lock(&tcon->stat_lock);
1163         tcon->bytes_read += bytes;
1164         spin_unlock(&tcon->stat_lock);
1165 }
1166 #else
1167
1168 #define  cifs_stats_inc(field) do {} while (0)
1169 #define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1170 #define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1171
1172 #endif
1173
1174
1175 /*
1176  * This is the prototype for the mid receive function. This function is for
1177  * receiving the rest of the SMB frame, starting with the WordCount (which is
1178  * just after the MID in struct smb_hdr). Note:
1179  *
1180  * - This will be called by cifsd, with no locks held.
1181  * - The mid will still be on the pending_mid_q.
1182  * - mid->resp_buf will point to the current buffer.
1183  *
1184  * Returns zero on a successful receive, or an error. The receive state in
1185  * the TCP_Server_Info will also be updated.
1186  */
1187 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1188                             struct mid_q_entry *mid);
1189
1190 /*
1191  * This is the prototype for the mid callback function. This is called once the
1192  * mid has been received off of the socket. When creating one, take special
1193  * care to avoid deadlocks. Things to bear in mind:
1194  *
1195  * - it will be called by cifsd, with no locks held
1196  * - the mid will be removed from any lists
1197  */
1198 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1199
1200 /* one of these for every pending CIFS request to the server */
1201 struct mid_q_entry {
1202         struct list_head qhead; /* mids waiting on reply from this server */
1203         struct TCP_Server_Info *server; /* server corresponding to this mid */
1204         __u64 mid;              /* multiplex id */
1205         __u32 pid;              /* process id */
1206         __u32 sequence_number;  /* for CIFS signing */
1207         unsigned long when_alloc;  /* when mid was created */
1208 #ifdef CONFIG_CIFS_STATS2
1209         unsigned long when_sent; /* time when smb send finished */
1210         unsigned long when_received; /* when demux complete (taken off wire) */
1211 #endif
1212         mid_receive_t *receive; /* call receive callback */
1213         mid_callback_t *callback; /* call completion callback */
1214         void *callback_data;      /* general purpose pointer for callback */
1215         void *resp_buf;         /* pointer to received SMB header */
1216         int mid_state;  /* wish this were enum but can not pass to wait_event */
1217         __le16 command;         /* smb command code */
1218         bool large_buf:1;       /* if valid response, is pointer to large buf */
1219         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1220         bool multiEnd:1;        /* both received */
1221 };
1222
1223 /*      Make code in transport.c a little cleaner by moving
1224         update of optional stats into function below */
1225 #ifdef CONFIG_CIFS_STATS2
1226
1227 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1228 {
1229         atomic_inc(&server->in_send);
1230 }
1231
1232 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1233 {
1234         atomic_dec(&server->in_send);
1235 }
1236
1237 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1238 {
1239         atomic_inc(&server->num_waiters);
1240 }
1241
1242 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1243 {
1244         atomic_dec(&server->num_waiters);
1245 }
1246
1247 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1248 {
1249         mid->when_sent = jiffies;
1250 }
1251 #else
1252 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1253 {
1254 }
1255 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1256 {
1257 }
1258
1259 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1260 {
1261 }
1262
1263 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1264 {
1265 }
1266
1267 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1268 {
1269 }
1270 #endif
1271
1272 /* for pending dnotify requests */
1273 struct dir_notify_req {
1274         struct list_head lhead;
1275         __le16 Pid;
1276         __le16 PidHigh;
1277         __u16 Mid;
1278         __u16 Tid;
1279         __u16 Uid;
1280         __u16 netfid;
1281         __u32 filter; /* CompletionFilter (for multishot) */
1282         int multishot;
1283         struct file *pfile;
1284 };
1285
1286 struct dfs_info3_param {
1287         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1288         int path_consumed;
1289         int server_type;
1290         int ref_flag;
1291         char *path_name;
1292         char *node_name;
1293 };
1294
1295 /*
1296  * common struct for holding inode info when searching for or updating an
1297  * inode with new info
1298  */
1299
1300 #define CIFS_FATTR_DFS_REFERRAL         0x1
1301 #define CIFS_FATTR_DELETE_PENDING       0x2
1302 #define CIFS_FATTR_NEED_REVAL           0x4
1303 #define CIFS_FATTR_INO_COLLISION        0x8
1304 #define CIFS_FATTR_UNKNOWN_NLINK        0x10
1305
1306 struct cifs_fattr {
1307         u32             cf_flags;
1308         u32             cf_cifsattrs;
1309         u64             cf_uniqueid;
1310         u64             cf_eof;
1311         u64             cf_bytes;
1312         u64             cf_createtime;
1313         kuid_t          cf_uid;
1314         kgid_t          cf_gid;
1315         umode_t         cf_mode;
1316         dev_t           cf_rdev;
1317         unsigned int    cf_nlink;
1318         unsigned int    cf_dtype;
1319         struct timespec cf_atime;
1320         struct timespec cf_mtime;
1321         struct timespec cf_ctime;
1322 };
1323
1324 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1325 {
1326         if (param) {
1327                 kfree(param->path_name);
1328                 kfree(param->node_name);
1329                 kfree(param);
1330         }
1331 }
1332
1333 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1334                                        int number_of_items)
1335 {
1336         int i;
1337         if ((number_of_items == 0) || (param == NULL))
1338                 return;
1339         for (i = 0; i < number_of_items; i++) {
1340                 kfree(param[i].path_name);
1341                 kfree(param[i].node_name);
1342         }
1343         kfree(param);
1344 }
1345
1346 #define   MID_FREE 0
1347 #define   MID_REQUEST_ALLOCATED 1
1348 #define   MID_REQUEST_SUBMITTED 2
1349 #define   MID_RESPONSE_RECEIVED 4
1350 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1351 #define   MID_RESPONSE_MALFORMED 0x10
1352 #define   MID_SHUTDOWN           0x20
1353
1354 /* Types of response buffer returned from SendReceive2 */
1355 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1356 #define   CIFS_SMALL_BUFFER     1
1357 #define   CIFS_LARGE_BUFFER     2
1358 #define   CIFS_IOVEC            4    /* array of response buffers */
1359
1360 /* Type of Request to SendReceive2 */
1361 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1362 #define   CIFS_ASYNC_OP         2    /* do not wait for response */
1363 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1364 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1365 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1366 #define   CIFS_NO_RESP      0x040    /* no response buffer required */
1367
1368 /* Type of request operation */
1369 #define   CIFS_ECHO_OP      0x080    /* echo request */
1370 #define   CIFS_OBREAK_OP   0x0100    /* oplock break request */
1371 #define   CIFS_NEG_OP      0x0200    /* negotiate request */
1372 #define   CIFS_OP_MASK     0x0380    /* mask request type */
1373
1374 /* Security Flags: indicate type of session setup needed */
1375 #define   CIFSSEC_MAY_SIGN      0x00001
1376 #define   CIFSSEC_MAY_NTLM      0x00002
1377 #define   CIFSSEC_MAY_NTLMV2    0x00004
1378 #define   CIFSSEC_MAY_KRB5      0x00008
1379 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1380 #define   CIFSSEC_MAY_LANMAN    0x00010
1381 #define   CIFSSEC_MAY_PLNTXT    0x00020
1382 #else
1383 #define   CIFSSEC_MAY_LANMAN    0
1384 #define   CIFSSEC_MAY_PLNTXT    0
1385 #endif /* weak passwords */
1386 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
1387 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
1388
1389 #define   CIFSSEC_MUST_SIGN     0x01001
1390 /* note that only one of the following can be set so the
1391 result of setting MUST flags more than once will be to
1392 require use of the stronger protocol */
1393 #define   CIFSSEC_MUST_NTLM     0x02002
1394 #define   CIFSSEC_MUST_NTLMV2   0x04004
1395 #define   CIFSSEC_MUST_KRB5     0x08008
1396 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1397 #define   CIFSSEC_MUST_LANMAN   0x10010
1398 #define   CIFSSEC_MUST_PLNTXT   0x20020
1399 #ifdef CONFIG_CIFS_UPCALL
1400 #define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
1401 #else
1402 #define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
1403 #endif /* UPCALL */
1404 #else /* do not allow weak pw hash */
1405 #define   CIFSSEC_MUST_LANMAN   0
1406 #define   CIFSSEC_MUST_PLNTXT   0
1407 #ifdef CONFIG_CIFS_UPCALL
1408 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1409 #else
1410 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1411 #endif /* UPCALL */
1412 #endif /* WEAK_PW_HASH */
1413 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
1414 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
1415
1416 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1417 #define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1418 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1419 /*
1420  *****************************************************************
1421  * All constants go here
1422  *****************************************************************
1423  */
1424
1425 #define UID_HASH (16)
1426
1427 /*
1428  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1429  * following to be declared.
1430  */
1431
1432 /****************************************************************************
1433  *  Locking notes.  All updates to global variables and lists should be
1434  *                  protected by spinlocks or semaphores.
1435  *
1436  *  Spinlocks
1437  *  ---------
1438  *  GlobalMid_Lock protects:
1439  *      list operations on pending_mid_q and oplockQ
1440  *      updates to XID counters, multiplex id  and SMB sequence numbers
1441  *  cifs_file_list_lock protects:
1442  *      list operations on tcp and SMB session lists and tCon lists
1443  *  f_owner.lock protects certain per file struct operations
1444  *  mapping->page_lock protects certain per page operations
1445  *
1446  *  Semaphores
1447  *  ----------
1448  *  sesSem     operations on smb session
1449  *  tconSem    operations on tree connection
1450  *  fh_sem      file handle reconnection operations
1451  *
1452  ****************************************************************************/
1453
1454 #ifdef DECLARE_GLOBALS_HERE
1455 #define GLOBAL_EXTERN
1456 #else
1457 #define GLOBAL_EXTERN extern
1458 #endif
1459
1460 /*
1461  * the list of TCP_Server_Info structures, ie each of the sockets
1462  * connecting our client to a distinct server (ip address), is
1463  * chained together by cifs_tcp_ses_list. The list of all our SMB
1464  * sessions (and from that the tree connections) can be found
1465  * by iterating over cifs_tcp_ses_list
1466  */
1467 GLOBAL_EXTERN struct list_head          cifs_tcp_ses_list;
1468
1469 /*
1470  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1471  * tcp session, and the list of tcon's per smb session. It also protects
1472  * the reference counters for the server, smb session, and tcon. Finally,
1473  * changes to the tcon->tidStatus should be done while holding this lock.
1474  */
1475 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
1476
1477 /*
1478  * This lock protects the cifs_file->llist and cifs_file->flist
1479  * list operations, and updates to some flags (cifs_file->invalidHandle)
1480  * It will be moved to either use the tcon->stat_lock or equivalent later.
1481  * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1482  * the cifs_tcp_ses_lock must be grabbed first and released last.
1483  */
1484 GLOBAL_EXTERN spinlock_t        cifs_file_list_lock;
1485
1486 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1487 /* Outstanding dir notify requests */
1488 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1489 /* DirNotify response queue */
1490 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1491 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1492
1493 /*
1494  * Global transaction id (XID) information
1495  */
1496 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
1497 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1498 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
1499 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
1500                                           /* on midQ entries */
1501 /*
1502  *  Global counters, updated atomically
1503  */
1504 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1505 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1506 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1507 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1508 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1509
1510 /* Various Debug counters */
1511 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
1512 #ifdef CONFIG_CIFS_STATS2
1513 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1514 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1515 #endif
1516 GLOBAL_EXTERN atomic_t smBufAllocCount;
1517 GLOBAL_EXTERN atomic_t midCount;
1518
1519 /* Misc globals */
1520 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1521 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1522 GLOBAL_EXTERN unsigned int global_secflags;     /* if on, session setup sent
1523                                 with more secure ntlmssp2 challenge/resp */
1524 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
1525 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1526 GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
1527 GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
1528 GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
1529 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1530
1531 #ifdef CONFIG_CIFS_ACL
1532 GLOBAL_EXTERN struct rb_root uidtree;
1533 GLOBAL_EXTERN struct rb_root gidtree;
1534 GLOBAL_EXTERN spinlock_t siduidlock;
1535 GLOBAL_EXTERN spinlock_t sidgidlock;
1536 GLOBAL_EXTERN struct rb_root siduidtree;
1537 GLOBAL_EXTERN struct rb_root sidgidtree;
1538 GLOBAL_EXTERN spinlock_t uidsidlock;
1539 GLOBAL_EXTERN spinlock_t gidsidlock;
1540 #endif /* CONFIG_CIFS_ACL */
1541
1542 void cifs_oplock_break(struct work_struct *work);
1543
1544 extern const struct slow_work_ops cifs_oplock_break_ops;
1545 extern struct workqueue_struct *cifsiod_wq;
1546
1547 extern mempool_t *cifs_mid_poolp;
1548
1549 /* Operations for different SMB versions */
1550 #define SMB1_VERSION_STRING     "1.0"
1551 extern struct smb_version_operations smb1_operations;
1552 extern struct smb_version_values smb1_values;
1553 #define SMB20_VERSION_STRING    "2.0"
1554 extern struct smb_version_operations smb20_operations;
1555 extern struct smb_version_values smb20_values;
1556 #define SMB21_VERSION_STRING    "2.1"
1557 extern struct smb_version_operations smb21_operations;
1558 extern struct smb_version_values smb21_values;
1559 #define SMB30_VERSION_STRING    "3.0"
1560 extern struct smb_version_operations smb30_operations;
1561 extern struct smb_version_values smb30_values;
1562 #define SMB302_VERSION_STRING   "3.02"
1563 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1564 extern struct smb_version_values smb302_values;
1565 #endif  /* _CIFS_GLOB_H */