fs/cifs/cifsglob.h

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