Pileus Git - ~andy/linux/blob - fs/cifs/cifsglob.h

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