fs/cifs/cifsglob.h

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