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