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