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