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