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