fs/cifs/cifsglob.h

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