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