fs/cifs/cifsglob.h

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