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