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