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         int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
 388 };
 389
 390 struct smb_version_values {
 391         char            *version_string;
 392         __u16           protocol_id;
 393         __u32           req_capabilities;
 394         __u32           large_lock_type;
 395         __u32           exclusive_lock_type;
 396         __u32           shared_lock_type;
 397         __u32           unlock_lock_type;
 398         size_t          header_size;
 399         size_t          max_header_size;
 400         size_t          read_rsp_size;
 401         __le16          lock_cmd;
 402         unsigned int    cap_unix;
 403         unsigned int    cap_nt_find;
 404         unsigned int    cap_large_files;
 405         __u16           signing_enabled;
 406         __u16           signing_required;
 407         size_t          create_lease_size;
 408 };
 409
 410 #define HEADER_SIZE(server) (server->vals->header_size)
 411 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
 412
 413 struct smb_vol {
 414         char *username;
 415         char *password;
 416         char *domainname;
 417         char *UNC;
 418         char *iocharset;  /* local code page for mapping to and from Unicode */
 419         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
 420         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
 421         kuid_t cred_uid;
 422         kuid_t linux_uid;
 423         kgid_t linux_gid;
 424         kuid_t backupuid;
 425         kgid_t backupgid;
 426         umode_t file_mode;
 427         umode_t dir_mode;
 428         enum securityEnum sectype; /* sectype requested via mnt opts */
 429         bool sign; /* was signing requested via mnt opts? */
 430         bool retry:1;
 431         bool intr:1;
 432         bool setuids:1;
 433         bool override_uid:1;
 434         bool override_gid:1;
 435         bool dynperm:1;
 436         bool noperm:1;
 437         bool no_psx_acl:1; /* set if posix acl support should be disabled */
 438         bool cifs_acl:1;
 439         bool backupuid_specified; /* mount option  backupuid  is specified */
 440         bool backupgid_specified; /* mount option  backupgid  is specified */
 441         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
 442         bool server_ino:1; /* use inode numbers from server ie UniqueId */
 443         bool direct_io:1;
 444         bool strict_io:1; /* strict cache behavior */
 445         bool remap:1;      /* set to remap seven reserved chars in filenames */
 446         bool posix_paths:1; /* unset to not ask for posix pathnames. */
 447         bool no_linux_ext:1;
 448         bool sfu_emul:1;
 449         bool nullauth:1;   /* attempt to authenticate with null user */
 450         bool nocase:1;     /* request case insensitive filenames */
 451         bool nobrl:1;      /* disable sending byte range locks to srv */
 452         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
 453         bool seal:1;       /* request transport encryption on share */
 454         bool nodfs:1;      /* Do not request DFS, even if available */
 455         bool local_lease:1; /* check leases only on local system, not remote */
 456         bool noblocksnd:1;
 457         bool noautotune:1;
 458         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
 459         bool fsc:1;     /* enable fscache */
 460         bool mfsymlinks:1; /* use Minshall+French Symlinks */
 461         bool multiuser:1;
 462         bool rwpidforward:1; /* pid forward for read/write operations */
 463         bool nosharesock;
 464         unsigned int rsize;
 465         unsigned int wsize;
 466         bool sockopt_tcp_nodelay:1;
 467         unsigned long actimeo; /* attribute cache timeout (jiffies) */
 468         struct smb_version_operations *ops;
 469         struct smb_version_values *vals;
 470         char *prepath;
 471         struct sockaddr_storage dstaddr; /* destination address */
 472         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
 473         struct nls_table *local_nls;
 474 };
 475
 476 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
 477                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
 478                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
 479                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
 480                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
 481                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
 482                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
 483                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
 484                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
 485                          CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
 486
 487 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
 488                       MS_NODEV | MS_SYNCHRONOUS)
 489
 490 struct cifs_mnt_data {
 491         struct cifs_sb_info *cifs_sb;
 492         struct smb_vol *vol;
 493         int flags;
 494 };
 495
 496 static inline unsigned int
 497 get_rfc1002_length(void *buf)
 498 {
 499         return be32_to_cpu(*((__be32 *)buf));
 500 }
 501
 502 static inline void
 503 inc_rfc1001_len(void *buf, int count)
 504 {
 505         be32_add_cpu((__be32 *)buf, count);
 506 }
 507
 508 struct TCP_Server_Info {
 509         struct list_head tcp_ses_list;
 510         struct list_head smb_ses_list;
 511         int srv_count; /* reference counter */
 512         /* 15 character server name + 0x20 16th byte indicating type = srv */
 513         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 514         struct smb_version_operations   *ops;
 515         struct smb_version_values       *vals;
 516         enum statusEnum tcpStatus; /* what we think the status is */
 517         char *hostname; /* hostname portion of UNC string */
 518         struct socket *ssocket;
 519         struct sockaddr_storage dstaddr;
 520         struct sockaddr_storage srcaddr; /* locally bind to this IP */
 521 #ifdef CONFIG_NET_NS
 522         struct net *net;
 523 #endif
 524         wait_queue_head_t response_q;
 525         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
 526         struct list_head pending_mid_q;
 527         bool noblocksnd;                /* use blocking sendmsg */
 528         bool noautotune;                /* do not autotune send buf sizes */
 529         bool tcp_nodelay;
 530         int credits;  /* send no more requests at once */
 531         unsigned int in_flight;  /* number of requests on the wire to server */
 532         spinlock_t req_lock;  /* protect the two values above */
 533         struct mutex srv_mutex;
 534         struct task_struct *tsk;
 535         char server_GUID[16];
 536         __u16 sec_mode;
 537         bool sign; /* is signing enabled on this connection? */
 538         bool session_estab; /* mark when very first sess is established */
 539 #ifdef CONFIG_CIFS_SMB2
 540         int echo_credits;  /* echo reserved slots */
 541         int oplock_credits;  /* oplock break reserved slots */
 542         bool echoes:1; /* enable echoes */
 543 #endif
 544         u16 dialect; /* dialect index that server chose */
 545         bool oplocks:1; /* enable oplocks */
 546         unsigned int maxReq;    /* Clients should submit no more */
 547         /* than maxReq distinct unanswered SMBs to the server when using  */
 548         /* multiplexed reads or writes */
 549         unsigned int maxBuf;    /* maxBuf specifies the maximum */
 550         /* message size the server can send or receive for non-raw SMBs */
 551         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
 552         /* when socket is setup (and during reconnect) before NegProt sent */
 553         unsigned int max_rw;    /* maxRw specifies the maximum */
 554         /* message size the server can send or receive for */
 555         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
 556         unsigned int capabilities; /* selective disabling of caps by smb sess */
 557         int timeAdj;  /* Adjust for difference in server time zone in sec */
 558         __u64 CurrentMid;         /* multiplex id - rotating counter */
 559         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
 560         /* 16th byte of RFC1001 workstation name is always null */
 561         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 562         __u32 sequence_number; /* for signing, protected by srv_mutex */
 563         struct session_key session_key;
 564         unsigned long lstrp; /* when we got last response from this server */
 565         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
 566 #define CIFS_NEGFLAVOR_LANMAN   0       /* wct == 13, LANMAN */
 567 #define CIFS_NEGFLAVOR_UNENCAP  1       /* wct == 17, but no ext_sec */
 568 #define CIFS_NEGFLAVOR_EXTENDED 2       /* wct == 17, ext_sec bit set */
 569         char    negflavor;      /* NEGOTIATE response flavor */
 570         /* extended security flavors that server supports */
 571         bool    sec_ntlmssp;            /* supports NTLMSSP */
 572         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
 573         bool    sec_kerberos;           /* supports plain Kerberos */
 574         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
 575         bool    large_buf;              /* is current buffer large? */
 576         struct delayed_work     echo; /* echo ping workqueue job */
 577         struct kvec *iov;       /* reusable kvec array for receives */
 578         unsigned int nr_iov;    /* number of kvecs in array */
 579         char    *smallbuf;      /* pointer to current "small" buffer */
 580         char    *bigbuf;        /* pointer to current "big" buffer */
 581         unsigned int total_read; /* total amount of data read in this pass */
 582 #ifdef CONFIG_CIFS_FSCACHE
 583         struct fscache_cookie   *fscache; /* client index cache cookie */
 584 #endif
 585 #ifdef CONFIG_CIFS_STATS2
 586         atomic_t in_send; /* requests trying to send */
 587         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
 588 #endif
 589 #ifdef CONFIG_CIFS_SMB2
 590         unsigned int    max_read;
 591         unsigned int    max_write;
 592 #endif /* CONFIG_CIFS_SMB2 */
 593 };
 594
 595 static inline unsigned int
 596 in_flight(struct TCP_Server_Info *server)
 597 {
 598         unsigned int num;
 599         spin_lock(&server->req_lock);
 600         num = server->in_flight;
 601         spin_unlock(&server->req_lock);
 602         return num;
 603 }
 604
 605 static inline bool
 606 has_credits(struct TCP_Server_Info *server, int *credits)
 607 {
 608         int num;
 609         spin_lock(&server->req_lock);
 610         num = *credits;
 611         spin_unlock(&server->req_lock);
 612         return num > 0;
 613 }
 614
 615 static inline void
 616 add_credits(struct TCP_Server_Info *server, const unsigned int add,
 617             const int optype)
 618 {
 619         server->ops->add_credits(server, add, optype);
 620 }
 621
 622 static inline void
 623 set_credits(struct TCP_Server_Info *server, const int val)
 624 {
 625         server->ops->set_credits(server, val);
 626 }
 627
 628 static inline __u64
 629 get_next_mid64(struct TCP_Server_Info *server)
 630 {
 631         return server->ops->get_next_mid(server);
 632 }
 633
 634 static inline __le16
 635 get_next_mid(struct TCP_Server_Info *server)
 636 {
 637         __u16 mid = get_next_mid64(server);
 638         /*
 639          * The value in the SMB header should be little endian for easy
 640          * on-the-wire decoding.
 641          */
 642         return cpu_to_le16(mid);
 643 }
 644
 645 static inline __u16
 646 get_mid(const struct smb_hdr *smb)
 647 {
 648         return le16_to_cpu(smb->Mid);
 649 }
 650
 651 static inline bool
 652 compare_mid(__u16 mid, const struct smb_hdr *smb)
 653 {
 654         return mid == le16_to_cpu(smb->Mid);
 655 }
 656
 657 /*
 658  * When the server supports very large reads and writes via POSIX extensions,
 659  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
 660  * including the RFC1001 length.
 661  *
 662  * Note that this might make for "interesting" allocation problems during
 663  * writeback however as we have to allocate an array of pointers for the
 664  * pages. A 16M write means ~32kb page array with PAGE_CACHE_SIZE == 4096.
 665  *
 666  * For reads, there is a similar problem as we need to allocate an array
 667  * of kvecs to handle the receive, though that should only need to be done
 668  * once.
 669  */
 670 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
 671 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
 672
 673 /*
 674  * When the server doesn't allow large posix writes, only allow a rsize/wsize
 675  * of 2^17-1 minus the size of the call header. That allows for a read or
 676  * write up to the maximum size described by RFC1002.
 677  */
 678 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
 679 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
 680
 681 /*
 682  * The default wsize is 1M. find_get_pages seems to return a maximum of 256
 683  * pages in a single call. With PAGE_CACHE_SIZE == 4k, this means we can fill
 684  * a single wsize request with a single call.
 685  */
 686 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
 687
 688 /*
 689  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
 690  * those values when posix extensions aren't in force. In actuality here, we
 691  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
 692  * to be ok with the extra byte even though Windows doesn't send writes that
 693  * are that large.
 694  *
 695  * Citation:
 696  *
 697  * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
 698  */
 699 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
 700 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
 701
 702 /*
 703  * Macros to allow the TCP_Server_Info->net field and related code to drop out
 704  * when CONFIG_NET_NS isn't set.
 705  */
 706
 707 #ifdef CONFIG_NET_NS
 708
 709 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 710 {
 711         return srv->net;
 712 }
 713
 714 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 715 {
 716         srv->net = net;
 717 }
 718
 719 #else
 720
 721 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 722 {
 723         return &init_net;
 724 }
 725
 726 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 727 {
 728 }
 729
 730 #endif
 731
 732 /*
 733  * Session structure.  One of these for each uid session with a particular host
 734  */
 735 struct cifs_ses {
 736         struct list_head smb_ses_list;
 737         struct list_head tcon_list;
 738         struct mutex session_mutex;
 739         struct TCP_Server_Info *server; /* pointer to server info */
 740         int ses_count;          /* reference counter */
 741         enum statusEnum status;
 742         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
 743         __u16 ipc_tid;          /* special tid for connection to IPC share */
 744         char *serverOS;         /* name of operating system underlying server */
 745         char *serverNOS;        /* name of network operating system of server */
 746         char *serverDomain;     /* security realm of server */
 747         __u64 Suid;             /* remote smb uid  */
 748         kuid_t linux_uid;       /* overriding owner of files on the mount */
 749         kuid_t cred_uid;        /* owner of credentials */
 750         unsigned int capabilities;
 751         char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
 752                                 TCP names - will ipv6 and sctp addresses fit? */
 753         char *user_name;        /* must not be null except during init of sess
 754                                    and after mount option parsing we fill it */
 755         char *domainName;
 756         char *password;
 757         struct session_key auth_key;
 758         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
 759         enum securityEnum sectype; /* what security flavor was specified? */
 760         bool sign;              /* is signing required? */
 761         bool need_reconnect:1; /* connection reset, uid now invalid */
 762 #ifdef CONFIG_CIFS_SMB2
 763         __u16 session_flags;
 764         char smb3signingkey[SMB3_SIGN_KEY_SIZE]; /* for signing smb3 packets */
 765 #endif /* CONFIG_CIFS_SMB2 */
 766 };
 767
 768 static inline bool
 769 cap_unix(struct cifs_ses *ses)
 770 {
 771         return ses->server->vals->cap_unix & ses->capabilities;
 772 }
 773
 774 /*
 775  * there is one of these for each connection to a resource on a particular
 776  * session
 777  */
 778 struct cifs_tcon {
 779         struct list_head tcon_list;
 780         int tc_count;
 781         struct list_head openFileList;
 782         struct cifs_ses *ses;   /* pointer to session associated with */
 783         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
 784         char *nativeFileSystem;
 785         char *password;         /* for share-level security */
 786         __u32 tid;              /* The 4 byte tree id */
 787         __u16 Flags;            /* optional support bits */
 788         enum statusEnum tidStatus;
 789 #ifdef CONFIG_CIFS_STATS
 790         atomic_t num_smbs_sent;
 791         union {
 792                 struct {
 793                         atomic_t num_writes;
 794                         atomic_t num_reads;
 795                         atomic_t num_flushes;
 796                         atomic_t num_oplock_brks;
 797                         atomic_t num_opens;
 798                         atomic_t num_closes;
 799                         atomic_t num_deletes;
 800                         atomic_t num_mkdirs;
 801                         atomic_t num_posixopens;
 802                         atomic_t num_posixmkdirs;
 803                         atomic_t num_rmdirs;
 804                         atomic_t num_renames;
 805                         atomic_t num_t2renames;
 806                         atomic_t num_ffirst;
 807                         atomic_t num_fnext;
 808                         atomic_t num_fclose;
 809                         atomic_t num_hardlinks;
 810                         atomic_t num_symlinks;
 811                         atomic_t num_locks;
 812                         atomic_t num_acl_get;
 813                         atomic_t num_acl_set;
 814                 } cifs_stats;
 815 #ifdef CONFIG_CIFS_SMB2
 816                 struct {
 817                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
 818                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
 819                 } smb2_stats;
 820 #endif /* CONFIG_CIFS_SMB2 */
 821         } stats;
 822 #ifdef CONFIG_CIFS_STATS2
 823         unsigned long long time_writes;
 824         unsigned long long time_reads;
 825         unsigned long long time_opens;
 826         unsigned long long time_deletes;
 827         unsigned long long time_closes;
 828         unsigned long long time_mkdirs;
 829         unsigned long long time_rmdirs;
 830         unsigned long long time_renames;
 831         unsigned long long time_t2renames;
 832         unsigned long long time_ffirst;
 833         unsigned long long time_fnext;
 834         unsigned long long time_fclose;
 835 #endif /* CONFIG_CIFS_STATS2 */
 836         __u64    bytes_read;
 837         __u64    bytes_written;
 838         spinlock_t stat_lock;
 839 #endif /* CONFIG_CIFS_STATS */
 840         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
 841         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
 842         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
 843         bool ipc:1;             /* set if connection to IPC$ eg for RPC/PIPES */
 844         bool retry:1;
 845         bool nocase:1;
 846         bool seal:1;      /* transport encryption for this mounted share */
 847         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
 848                                 for this mount even if server would support */
 849         bool local_lease:1; /* check leases (only) on local system not remote */
 850         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
 851         bool need_reconnect:1; /* connection reset, tid now invalid */
 852 #ifdef CONFIG_CIFS_SMB2
 853         bool print:1;           /* set if connection to printer share */
 854         bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
 855         __le32 capabilities;
 856         __u32 share_flags;
 857         __u32 maximal_access;
 858         __u32 vol_serial_number;
 859         __le64 vol_create_time;
 860         __u32 ss_flags;         /* sector size flags */
 861         __u32 perf_sector_size; /* best sector size for perf */
 862         __u32 max_chunks;
 863         __u32 max_bytes_chunk;
 864         __u32 max_bytes_copy;
 865 #endif /* CONFIG_CIFS_SMB2 */
 866 #ifdef CONFIG_CIFS_FSCACHE
 867         u64 resource_id;                /* server resource id */
 868         struct fscache_cookie *fscache; /* cookie for share */
 869 #endif
 870         struct list_head pending_opens; /* list of incomplete opens */
 871         /* BB add field for back pointer to sb struct(s)? */
 872 };
 873
 874 /*
 875  * This is a refcounted and timestamped container for a tcon pointer. The
 876  * container holds a tcon reference. It is considered safe to free one of
 877  * these when the tl_count goes to 0. The tl_time is the time of the last
 878  * "get" on the container.
 879  */
 880 struct tcon_link {
 881         struct rb_node          tl_rbnode;
 882         kuid_t                  tl_uid;
 883         unsigned long           tl_flags;
 884 #define TCON_LINK_MASTER        0
 885 #define TCON_LINK_PENDING       1
 886 #define TCON_LINK_IN_TREE       2
 887         unsigned long           tl_time;
 888         atomic_t                tl_count;
 889         struct cifs_tcon        *tl_tcon;
 890 };
 891
 892 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
 893
 894 static inline struct cifs_tcon *
 895 tlink_tcon(struct tcon_link *tlink)
 896 {
 897         return tlink->tl_tcon;
 898 }
 899
 900 extern void cifs_put_tlink(struct tcon_link *tlink);
 901
 902 static inline struct tcon_link *
 903 cifs_get_tlink(struct tcon_link *tlink)
 904 {
 905         if (tlink && !IS_ERR(tlink))
 906                 atomic_inc(&tlink->tl_count);
 907         return tlink;
 908 }
 909
 910 /* This function is always expected to succeed */
 911 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
 912
 913 #define CIFS_OPLOCK_NO_CHANGE 0xfe
 914
 915 struct cifs_pending_open {
 916         struct list_head olist;
 917         struct tcon_link *tlink;
 918         __u8 lease_key[16];
 919         __u32 oplock;
 920 };
 921
 922 /*
 923  * This info hangs off the cifsFileInfo structure, pointed to by llist.
 924  * This is used to track byte stream locks on the file
 925  */
 926 struct cifsLockInfo {
 927         struct list_head llist; /* pointer to next cifsLockInfo */
 928         struct list_head blist; /* pointer to locks blocked on this */
 929         wait_queue_head_t block_q;
 930         __u64 offset;
 931         __u64 length;
 932         __u32 pid;
 933         __u32 type;
 934 };
 935
 936 /*
 937  * One of these for each open instance of a file
 938  */
 939 struct cifs_search_info {
 940         loff_t index_of_last_entry;
 941         __u16 entries_in_buffer;
 942         __u16 info_level;
 943         __u32 resume_key;
 944         char *ntwrk_buf_start;
 945         char *srch_entries_start;
 946         char *last_entry;
 947         const char *presume_name;
 948         unsigned int resume_name_len;
 949         bool endOfSearch:1;
 950         bool emptyDir:1;
 951         bool unicode:1;
 952         bool smallBuf:1; /* so we know which buf_release function to call */
 953 };
 954
 955 struct cifs_open_parms {
 956         struct cifs_tcon *tcon;
 957         struct cifs_sb_info *cifs_sb;
 958         int disposition;
 959         int desired_access;
 960         int create_options;
 961         const char *path;
 962         struct cifs_fid *fid;
 963         bool reconnect:1;
 964 };
 965
 966 struct cifs_fid {
 967         __u16 netfid;
 968 #ifdef CONFIG_CIFS_SMB2
 969         __u64 persistent_fid;   /* persist file id for smb2 */
 970         __u64 volatile_fid;     /* volatile file id for smb2 */
 971         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for smb2 */
 972 #endif
 973         struct cifs_pending_open *pending_open;
 974         unsigned int epoch;
 975         bool purge_cache;
 976 };
 977
 978 struct cifs_fid_locks {
 979         struct list_head llist;
 980         struct cifsFileInfo *cfile;     /* fid that owns locks */
 981         struct list_head locks;         /* locks held by fid above */
 982 };
 983
 984 struct cifsFileInfo {
 985         struct list_head tlist; /* pointer to next fid owned by tcon */
 986         struct list_head flist; /* next fid (file instance) for this inode */
 987         struct cifs_fid_locks *llist;   /* brlocks held by this fid */
 988         kuid_t uid;             /* allows finding which FileInfo structure */
 989         __u32 pid;              /* process id who opened file */
 990         struct cifs_fid fid;    /* file id from remote */
 991         /* BB add lock scope info here if needed */ ;
 992         /* lock scope id (0 if none) */
 993         struct dentry *dentry;
 994         unsigned int f_flags;
 995         struct tcon_link *tlink;
 996         bool invalidHandle:1;   /* file closed via session abend */
 997         bool oplock_break_cancelled:1;
 998         int count;              /* refcount protected by cifs_file_list_lock */
 999         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1000         struct cifs_search_info srch_inf;
1001         struct work_struct oplock_break; /* work for oplock breaks */
1002 };
1003
1004 struct cifs_io_parms {
1005         __u16 netfid;
1006 #ifdef CONFIG_CIFS_SMB2
1007         __u64 persistent_fid;   /* persist file id for smb2 */
1008         __u64 volatile_fid;     /* volatile file id for smb2 */
1009 #endif
1010         __u32 pid;
1011         __u64 offset;
1012         unsigned int length;
1013         struct cifs_tcon *tcon;
1014 };
1015
1016 struct cifs_readdata;
1017
1018 /* asynchronous read support */
1019 struct cifs_readdata {
1020         struct kref                     refcount;
1021         struct list_head                list;
1022         struct completion               done;
1023         struct cifsFileInfo             *cfile;
1024         struct address_space            *mapping;
1025         __u64                           offset;
1026         unsigned int                    bytes;
1027         pid_t                           pid;
1028         int                             result;
1029         struct work_struct              work;
1030         int (*read_into_pages)(struct TCP_Server_Info *server,
1031                                 struct cifs_readdata *rdata,
1032                                 unsigned int len);
1033         struct kvec                     iov;
1034         unsigned int                    pagesz;
1035         unsigned int                    tailsz;
1036         unsigned int                    nr_pages;
1037         struct page                     *pages[];
1038 };
1039
1040 struct cifs_writedata;
1041
1042 /* asynchronous write support */
1043 struct cifs_writedata {
1044         struct kref                     refcount;
1045         struct list_head                list;
1046         struct completion               done;
1047         enum writeback_sync_modes       sync_mode;
1048         struct work_struct              work;
1049         struct cifsFileInfo             *cfile;
1050         __u64                           offset;
1051         pid_t                           pid;
1052         unsigned int                    bytes;
1053         int                             result;
1054         unsigned int                    pagesz;
1055         unsigned int                    tailsz;
1056         unsigned int                    nr_pages;
1057         struct page                     *pages[1];
1058 };
1059
1060 /*
1061  * Take a reference on the file private data. Must be called with
1062  * cifs_file_list_lock held.
1063  */
1064 static inline void
1065 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1066 {
1067         ++cifs_file->count;
1068 }
1069
1070 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1071 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1072
1073 #define CIFS_CACHE_READ_FLG     1
1074 #define CIFS_CACHE_HANDLE_FLG   2
1075 #define CIFS_CACHE_RH_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1076 #define CIFS_CACHE_WRITE_FLG    4
1077 #define CIFS_CACHE_RW_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1078 #define CIFS_CACHE_RHW_FLG      (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1079
1080 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1081 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1082 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1083
1084 /*
1085  * One of these for each file inode
1086  */
1087
1088 struct cifsInodeInfo {
1089         bool can_cache_brlcks;
1090         struct list_head llist; /* locks helb by this inode */
1091         struct rw_semaphore lock_sem;   /* protect the fields above */
1092         /* BB add in lists for dirty pages i.e. write caching info for oplock */
1093         struct list_head openFileList;
1094         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1095         unsigned int oplock;            /* oplock/lease level we have */
1096         unsigned int epoch;             /* used to track lease state changes */
1097         bool delete_pending;            /* DELETE_ON_CLOSE is set */
1098         bool invalid_mapping;           /* pagecache is invalid */
1099         unsigned long time;             /* jiffies of last update of inode */
1100         u64  server_eof;                /* current file size on server -- protected by i_lock */
1101         u64  uniqueid;                  /* server inode number */
1102         u64  createtime;                /* creation time on server */
1103 #ifdef CONFIG_CIFS_SMB2
1104         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for this inode */
1105 #endif
1106 #ifdef CONFIG_CIFS_FSCACHE
1107         struct fscache_cookie *fscache;
1108 #endif
1109         struct inode vfs_inode;
1110 };
1111
1112 static inline struct cifsInodeInfo *
1113 CIFS_I(struct inode *inode)
1114 {
1115         return container_of(inode, struct cifsInodeInfo, vfs_inode);
1116 }
1117
1118 static inline struct cifs_sb_info *
1119 CIFS_SB(struct super_block *sb)
1120 {
1121         return sb->s_fs_info;
1122 }
1123
1124 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1125 {
1126         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1127                 return '/';
1128         else
1129                 return '\\';
1130 }
1131
1132 static inline void
1133 convert_delimiter(char *path, char delim)
1134 {
1135         char old_delim, *pos;
1136
1137         if (delim == '/')
1138                 old_delim = '\\';
1139         else
1140                 old_delim = '/';
1141
1142         pos = path;
1143         while ((pos = strchr(pos, old_delim)))
1144                 *pos = delim;
1145 }
1146
1147 #ifdef CONFIG_CIFS_STATS
1148 #define cifs_stats_inc atomic_inc
1149
1150 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1151                                             unsigned int bytes)
1152 {
1153         if (bytes) {
1154                 spin_lock(&tcon->stat_lock);
1155                 tcon->bytes_written += bytes;
1156                 spin_unlock(&tcon->stat_lock);
1157         }
1158 }
1159
1160 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1161                                          unsigned int bytes)
1162 {
1163         spin_lock(&tcon->stat_lock);
1164         tcon->bytes_read += bytes;
1165         spin_unlock(&tcon->stat_lock);
1166 }
1167 #else
1168
1169 #define  cifs_stats_inc(field) do {} while (0)
1170 #define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1171 #define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1172
1173 #endif
1174
1175
1176 /*
1177  * This is the prototype for the mid receive function. This function is for
1178  * receiving the rest of the SMB frame, starting with the WordCount (which is
1179  * just after the MID in struct smb_hdr). Note:
1180  *
1181  * - This will be called by cifsd, with no locks held.
1182  * - The mid will still be on the pending_mid_q.
1183  * - mid->resp_buf will point to the current buffer.
1184  *
1185  * Returns zero on a successful receive, or an error. The receive state in
1186  * the TCP_Server_Info will also be updated.
1187  */
1188 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1189                             struct mid_q_entry *mid);
1190
1191 /*
1192  * This is the prototype for the mid callback function. This is called once the
1193  * mid has been received off of the socket. When creating one, take special
1194  * care to avoid deadlocks. Things to bear in mind:
1195  *
1196  * - it will be called by cifsd, with no locks held
1197  * - the mid will be removed from any lists
1198  */
1199 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1200
1201 /* one of these for every pending CIFS request to the server */
1202 struct mid_q_entry {
1203         struct list_head qhead; /* mids waiting on reply from this server */
1204         struct TCP_Server_Info *server; /* server corresponding to this mid */
1205         __u64 mid;              /* multiplex id */
1206         __u32 pid;              /* process id */
1207         __u32 sequence_number;  /* for CIFS signing */
1208         unsigned long when_alloc;  /* when mid was created */
1209 #ifdef CONFIG_CIFS_STATS2
1210         unsigned long when_sent; /* time when smb send finished */
1211         unsigned long when_received; /* when demux complete (taken off wire) */
1212 #endif
1213         mid_receive_t *receive; /* call receive callback */
1214         mid_callback_t *callback; /* call completion callback */
1215         void *callback_data;      /* general purpose pointer for callback */
1216         void *resp_buf;         /* pointer to received SMB header */
1217         int mid_state;  /* wish this were enum but can not pass to wait_event */
1218         __le16 command;         /* smb command code */
1219         bool large_buf:1;       /* if valid response, is pointer to large buf */
1220         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1221         bool multiEnd:1;        /* both received */
1222 };
1223
1224 /*      Make code in transport.c a little cleaner by moving
1225         update of optional stats into function below */
1226 #ifdef CONFIG_CIFS_STATS2
1227
1228 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1229 {
1230         atomic_inc(&server->in_send);
1231 }
1232
1233 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1234 {
1235         atomic_dec(&server->in_send);
1236 }
1237
1238 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1239 {
1240         atomic_inc(&server->num_waiters);
1241 }
1242
1243 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1244 {
1245         atomic_dec(&server->num_waiters);
1246 }
1247
1248 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1249 {
1250         mid->when_sent = jiffies;
1251 }
1252 #else
1253 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1254 {
1255 }
1256 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1257 {
1258 }
1259
1260 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1261 {
1262 }
1263
1264 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1265 {
1266 }
1267
1268 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1269 {
1270 }
1271 #endif
1272
1273 /* for pending dnotify requests */
1274 struct dir_notify_req {
1275         struct list_head lhead;
1276         __le16 Pid;
1277         __le16 PidHigh;
1278         __u16 Mid;
1279         __u16 Tid;
1280         __u16 Uid;
1281         __u16 netfid;
1282         __u32 filter; /* CompletionFilter (for multishot) */
1283         int multishot;
1284         struct file *pfile;
1285 };
1286
1287 struct dfs_info3_param {
1288         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1289         int path_consumed;
1290         int server_type;
1291         int ref_flag;
1292         char *path_name;
1293         char *node_name;
1294 };
1295
1296 /*
1297  * common struct for holding inode info when searching for or updating an
1298  * inode with new info
1299  */
1300
1301 #define CIFS_FATTR_DFS_REFERRAL         0x1
1302 #define CIFS_FATTR_DELETE_PENDING       0x2
1303 #define CIFS_FATTR_NEED_REVAL           0x4
1304 #define CIFS_FATTR_INO_COLLISION        0x8
1305 #define CIFS_FATTR_UNKNOWN_NLINK        0x10
1306
1307 struct cifs_fattr {
1308         u32             cf_flags;
1309         u32             cf_cifsattrs;
1310         u64             cf_uniqueid;
1311         u64             cf_eof;
1312         u64             cf_bytes;
1313         u64             cf_createtime;
1314         kuid_t          cf_uid;
1315         kgid_t          cf_gid;
1316         umode_t         cf_mode;
1317         dev_t           cf_rdev;
1318         unsigned int    cf_nlink;
1319         unsigned int    cf_dtype;
1320         struct timespec cf_atime;
1321         struct timespec cf_mtime;
1322         struct timespec cf_ctime;
1323 };
1324
1325 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1326 {
1327         if (param) {
1328                 kfree(param->path_name);
1329                 kfree(param->node_name);
1330                 kfree(param);
1331         }
1332 }
1333
1334 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1335                                        int number_of_items)
1336 {
1337         int i;
1338         if ((number_of_items == 0) || (param == NULL))
1339                 return;
1340         for (i = 0; i < number_of_items; i++) {
1341                 kfree(param[i].path_name);
1342                 kfree(param[i].node_name);
1343         }
1344         kfree(param);
1345 }
1346
1347 #define   MID_FREE 0
1348 #define   MID_REQUEST_ALLOCATED 1
1349 #define   MID_REQUEST_SUBMITTED 2
1350 #define   MID_RESPONSE_RECEIVED 4
1351 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1352 #define   MID_RESPONSE_MALFORMED 0x10
1353 #define   MID_SHUTDOWN           0x20
1354
1355 /* Types of response buffer returned from SendReceive2 */
1356 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1357 #define   CIFS_SMALL_BUFFER     1
1358 #define   CIFS_LARGE_BUFFER     2
1359 #define   CIFS_IOVEC            4    /* array of response buffers */
1360
1361 /* Type of Request to SendReceive2 */
1362 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1363 #define   CIFS_ASYNC_OP         2    /* do not wait for response */
1364 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1365 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1366 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1367 #define   CIFS_NO_RESP      0x040    /* no response buffer required */
1368
1369 /* Type of request operation */
1370 #define   CIFS_ECHO_OP      0x080    /* echo request */
1371 #define   CIFS_OBREAK_OP   0x0100    /* oplock break request */
1372 #define   CIFS_NEG_OP      0x0200    /* negotiate request */
1373 #define   CIFS_OP_MASK     0x0380    /* mask request type */
1374
1375 /* Security Flags: indicate type of session setup needed */
1376 #define   CIFSSEC_MAY_SIGN      0x00001
1377 #define   CIFSSEC_MAY_NTLM      0x00002
1378 #define   CIFSSEC_MAY_NTLMV2    0x00004
1379 #define   CIFSSEC_MAY_KRB5      0x00008
1380 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1381 #define   CIFSSEC_MAY_LANMAN    0x00010
1382 #define   CIFSSEC_MAY_PLNTXT    0x00020
1383 #else
1384 #define   CIFSSEC_MAY_LANMAN    0
1385 #define   CIFSSEC_MAY_PLNTXT    0
1386 #endif /* weak passwords */
1387 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
1388 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
1389
1390 #define   CIFSSEC_MUST_SIGN     0x01001
1391 /* note that only one of the following can be set so the
1392 result of setting MUST flags more than once will be to
1393 require use of the stronger protocol */
1394 #define   CIFSSEC_MUST_NTLM     0x02002
1395 #define   CIFSSEC_MUST_NTLMV2   0x04004
1396 #define   CIFSSEC_MUST_KRB5     0x08008
1397 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1398 #define   CIFSSEC_MUST_LANMAN   0x10010
1399 #define   CIFSSEC_MUST_PLNTXT   0x20020
1400 #ifdef CONFIG_CIFS_UPCALL
1401 #define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
1402 #else
1403 #define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
1404 #endif /* UPCALL */
1405 #else /* do not allow weak pw hash */
1406 #define   CIFSSEC_MUST_LANMAN   0
1407 #define   CIFSSEC_MUST_PLNTXT   0
1408 #ifdef CONFIG_CIFS_UPCALL
1409 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1410 #else
1411 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1412 #endif /* UPCALL */
1413 #endif /* WEAK_PW_HASH */
1414 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
1415 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
1416
1417 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1418 #define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1419 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1420 /*
1421  *****************************************************************
1422  * All constants go here
1423  *****************************************************************
1424  */
1425
1426 #define UID_HASH (16)
1427
1428 /*
1429  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1430  * following to be declared.
1431  */
1432
1433 /****************************************************************************
1434  *  Locking notes.  All updates to global variables and lists should be
1435  *                  protected by spinlocks or semaphores.
1436  *
1437  *  Spinlocks
1438  *  ---------
1439  *  GlobalMid_Lock protects:
1440  *      list operations on pending_mid_q and oplockQ
1441  *      updates to XID counters, multiplex id  and SMB sequence numbers
1442  *  cifs_file_list_lock protects:
1443  *      list operations on tcp and SMB session lists and tCon lists
1444  *  f_owner.lock protects certain per file struct operations
1445  *  mapping->page_lock protects certain per page operations
1446  *
1447  *  Semaphores
1448  *  ----------
1449  *  sesSem     operations on smb session
1450  *  tconSem    operations on tree connection
1451  *  fh_sem      file handle reconnection operations
1452  *
1453  ****************************************************************************/
1454
1455 #ifdef DECLARE_GLOBALS_HERE
1456 #define GLOBAL_EXTERN
1457 #else
1458 #define GLOBAL_EXTERN extern
1459 #endif
1460
1461 /*
1462  * the list of TCP_Server_Info structures, ie each of the sockets
1463  * connecting our client to a distinct server (ip address), is
1464  * chained together by cifs_tcp_ses_list. The list of all our SMB
1465  * sessions (and from that the tree connections) can be found
1466  * by iterating over cifs_tcp_ses_list
1467  */
1468 GLOBAL_EXTERN struct list_head          cifs_tcp_ses_list;
1469
1470 /*
1471  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1472  * tcp session, and the list of tcon's per smb session. It also protects
1473  * the reference counters for the server, smb session, and tcon. Finally,
1474  * changes to the tcon->tidStatus should be done while holding this lock.
1475  */
1476 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
1477
1478 /*
1479  * This lock protects the cifs_file->llist and cifs_file->flist
1480  * list operations, and updates to some flags (cifs_file->invalidHandle)
1481  * It will be moved to either use the tcon->stat_lock or equivalent later.
1482  * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1483  * the cifs_tcp_ses_lock must be grabbed first and released last.
1484  */
1485 GLOBAL_EXTERN spinlock_t        cifs_file_list_lock;
1486
1487 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1488 /* Outstanding dir notify requests */
1489 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1490 /* DirNotify response queue */
1491 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1492 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1493
1494 /*
1495  * Global transaction id (XID) information
1496  */
1497 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
1498 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1499 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
1500 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
1501                                           /* on midQ entries */
1502 /*
1503  *  Global counters, updated atomically
1504  */
1505 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1506 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1507 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1508 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1509 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1510
1511 /* Various Debug counters */
1512 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
1513 #ifdef CONFIG_CIFS_STATS2
1514 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1515 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1516 #endif
1517 GLOBAL_EXTERN atomic_t smBufAllocCount;
1518 GLOBAL_EXTERN atomic_t midCount;
1519
1520 /* Misc globals */
1521 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1522 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1523 GLOBAL_EXTERN unsigned int global_secflags;     /* if on, session setup sent
1524                                 with more secure ntlmssp2 challenge/resp */
1525 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
1526 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1527 GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
1528 GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
1529 GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
1530 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1531
1532 #ifdef CONFIG_CIFS_ACL
1533 GLOBAL_EXTERN struct rb_root uidtree;
1534 GLOBAL_EXTERN struct rb_root gidtree;
1535 GLOBAL_EXTERN spinlock_t siduidlock;
1536 GLOBAL_EXTERN spinlock_t sidgidlock;
1537 GLOBAL_EXTERN struct rb_root siduidtree;
1538 GLOBAL_EXTERN struct rb_root sidgidtree;
1539 GLOBAL_EXTERN spinlock_t uidsidlock;
1540 GLOBAL_EXTERN spinlock_t gidsidlock;
1541 #endif /* CONFIG_CIFS_ACL */
1542
1543 void cifs_oplock_break(struct work_struct *work);
1544
1545 extern const struct slow_work_ops cifs_oplock_break_ops;
1546 extern struct workqueue_struct *cifsiod_wq;
1547
1548 extern mempool_t *cifs_mid_poolp;
1549
1550 /* Operations for different SMB versions */
1551 #define SMB1_VERSION_STRING     "1.0"
1552 extern struct smb_version_operations smb1_operations;
1553 extern struct smb_version_values smb1_values;
1554 #define SMB20_VERSION_STRING    "2.0"
1555 extern struct smb_version_operations smb20_operations;
1556 extern struct smb_version_values smb20_values;
1557 #define SMB21_VERSION_STRING    "2.1"
1558 extern struct smb_version_operations smb21_operations;
1559 extern struct smb_version_values smb21_values;
1560 #define SMB30_VERSION_STRING    "3.0"
1561 extern struct smb_version_operations smb30_operations;
1562 extern struct smb_version_values smb30_values;
1563 #define SMB302_VERSION_STRING   "3.02"
1564 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1565 extern struct smb_version_values smb302_values;
1566 #endif  /* _CIFS_GLOB_H */