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