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