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