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