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