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