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