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