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