fs/cifs/cifsglob.h

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