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