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