cifsglob.h 32.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 *   fs/cifs/cifsglob.h
 *
S
Steve French 已提交
4
 *   Copyright (C) International Business Machines  Corp., 2002,2008
L
Linus Torvalds 已提交
5
 *   Author(s): Steve French (sfrench@us.ibm.com)
J
[CIFS]  
Jeremy Allison 已提交
6
 *              Jeremy Allison (jra@samba.org)
L
Linus Torvalds 已提交
7 8 9 10 11 12 13 14 15 16
 *
 *   This library is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published
 *   by the Free Software Foundation; either version 2.1 of the License, or
 *   (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
 *   the GNU Lesser General Public License for more details.
S
Steve French 已提交
17
 *
L
Linus Torvalds 已提交
18
 */
19 20 21
#ifndef _CIFS_GLOB_H
#define _CIFS_GLOB_H

L
Linus Torvalds 已提交
22 23
#include <linux/in.h>
#include <linux/in6.h>
24
#include <linux/slab.h>
25
#include <linux/workqueue.h>
L
Linus Torvalds 已提交
26
#include "cifs_fs_sb.h"
27
#include "cifsacl.h"
28 29 30
#include <crypto/internal/hash.h>
#include <linux/scatterlist.h>

L
Linus Torvalds 已提交
31 32 33 34 35 36 37
/*
 * The sizes of various internal tables and strings
 */
#define MAX_UID_INFO 16
#define MAX_SES_INFO 2
#define MAX_TCON_INFO 4

38
#define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
L
Linus Torvalds 已提交
39
#define MAX_SERVER_SIZE 15
S
Steve French 已提交
40
#define MAX_SHARE_SIZE 80
41 42
#define MAX_USERNAME_SIZE 256	/* reasonable maximum for current servers */
#define MAX_PASSWORD_SIZE 512	/* max for windows seems to be 256 wide chars */
L
Linus Torvalds 已提交
43 44 45

#define CIFS_MIN_RCV_POOL 4

46 47 48 49 50 51 52 53 54 55
/*
 * default attribute cache timeout (jiffies)
 */
#define CIFS_DEF_ACTIMEO (1 * HZ)

/*
 * max attribute cache timeout (jiffies) - 2^30
 */
#define CIFS_MAX_ACTIMEO (1 << 30)

L
Linus Torvalds 已提交
56 57
/*
 * MAX_REQ is the maximum number of requests that WE will send
58
 * on one socket concurrently.
L
Linus Torvalds 已提交
59
 */
60
#define CIFS_MAX_REQ 32767
L
Linus Torvalds 已提交
61

62 63 64 65 66
#define RFC1001_NAME_LEN 15
#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)

/* currently length of NIP6_FMT */
#define SERVER_NAME_LENGTH 40
L
Linus Torvalds 已提交
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
#define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)

/* used to define string lengths for reversing unicode strings */
/*         (256+1)*2 = 514                                     */
/*           (max path length + 1 for null) * 2 for unicode    */
#define MAX_NAME 514

#include "cifspdu.h"

#ifndef XATTR_DOS_ATTRIB
#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
#endif

/*
 * CIFS vfs client Status information (based on what we know.)
 */

84
/* associated with each tcp and smb session */
L
Linus Torvalds 已提交
85 86 87 88
enum statusEnum {
	CifsNew = 0,
	CifsGood,
	CifsExiting,
89 90
	CifsNeedReconnect,
	CifsNeedNegotiate
L
Linus Torvalds 已提交
91 92 93
};

enum securityEnum {
94
	LANMAN = 0,			/* Legacy LANMAN auth */
95
	NTLM,			/* Legacy NTLM012 auth with NTLM hash */
L
Linus Torvalds 已提交
96
	NTLMv2,			/* Legacy NTLM auth with NTLMv2 hash */
97
	RawNTLMSSP,		/* NTLMSSP without SPNEGO, NTLMv2 hash */
98
/*	NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
99
	Kerberos,		/* Kerberos via SPNEGO */
L
Linus Torvalds 已提交
100 101 102
};

enum protocolEnum {
103
	TCP = 0,
L
Linus Torvalds 已提交
104 105 106 107
	SCTP
	/* Netbios frames protocol not supported at this time */
};

108
struct session_key {
109
	unsigned int len;
110
	char *response;
111 112
};

113 114 115 116 117 118
/* crypto security descriptor definition */
struct sdesc {
	struct shash_desc shash;
	char ctx[];
};

119
/* crypto hashing related structure/fields, not specific to a sec mech */
120 121 122 123 124 125 126
struct cifs_secmech {
	struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
	struct crypto_shash *md5; /* md5 hash function */
	struct sdesc *sdeschmacmd5;  /* ctxt to generate ntlmv2 hash, CR1 */
	struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
};

127
/* per smb session structure/fields */
128 129 130 131
struct ntlmssp_auth {
	__u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
	__u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
	unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
132
	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
133 134
};

135 136 137 138 139 140 141 142 143 144 145
struct cifs_cred {
	int uid;
	int gid;
	int mode;
	int cecount;
	struct cifs_sid osid;
	struct cifs_sid gsid;
	struct cifs_ntace *ntaces;
	struct cifs_ace *aces;
};

L
Linus Torvalds 已提交
146 147 148 149 150 151 152
/*
 *****************************************************************
 * Except the CIFS PDUs themselves all the
 * globally interesting structs should go here
 *****************************************************************
 */

153 154 155 156 157 158 159 160 161 162 163 164
struct smb_vol {
	char *username;
	char *password;
	char *domainname;
	char *UNC;
	char *UNCip;
	char *iocharset;  /* local code page for mapping to and from Unicode */
	char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
	char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
	uid_t cred_uid;
	uid_t linux_uid;
	gid_t linux_gid;
165 166
	uid_t backupuid;
	gid_t backupgid;
A
Al Viro 已提交
167 168
	umode_t file_mode;
	umode_t dir_mode;
169 170 171 172 173 174 175 176 177 178
	unsigned secFlg;
	bool retry:1;
	bool intr:1;
	bool setuids:1;
	bool override_uid:1;
	bool override_gid:1;
	bool dynperm:1;
	bool noperm:1;
	bool no_psx_acl:1; /* set if posix acl support should be disabled */
	bool cifs_acl:1;
179 180
	bool backupuid_specified; /* mount option  backupuid  is specified */
	bool backupgid_specified; /* mount option  backupgid  is specified */
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
	bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
	bool server_ino:1; /* use inode numbers from server ie UniqueId */
	bool direct_io:1;
	bool strict_io:1; /* strict cache behavior */
	bool remap:1;      /* set to remap seven reserved chars in filenames */
	bool posix_paths:1; /* unset to not ask for posix pathnames. */
	bool no_linux_ext:1;
	bool sfu_emul:1;
	bool nullauth:1;   /* attempt to authenticate with null user */
	bool nocase:1;     /* request case insensitive filenames */
	bool nobrl:1;      /* disable sending byte range locks to srv */
	bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
	bool seal:1;       /* request transport encryption on share */
	bool nodfs:1;      /* Do not request DFS, even if available */
	bool local_lease:1; /* check leases only on local system, not remote */
	bool noblocksnd:1;
	bool noautotune:1;
	bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
	bool fsc:1;	/* enable fscache */
	bool mfsymlinks:1; /* use Minshall+French Symlinks */
	bool multiuser:1;
202
	bool rwpidforward:1; /* pid forward for read/write operations */
203 204 205 206 207 208 209 210 211 212
	unsigned int rsize;
	unsigned int wsize;
	bool sockopt_tcp_nodelay:1;
	unsigned short int port;
	unsigned long actimeo; /* attribute cache timeout (jiffies) */
	char *prepath;
	struct sockaddr_storage srcaddr; /* allow binding to a local IP */
	struct nls_table *local_nls;
};

213 214 215 216 217 218 219 220
#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
			 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
			 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
			 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
			 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
			 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
			 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
			 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
221 222
			 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
			 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
223 224 225 226 227 228 229 230 231 232

#define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
		      MS_NODEV | MS_SYNCHRONOUS)

struct cifs_mnt_data {
	struct cifs_sb_info *cifs_sb;
	struct smb_vol *vol;
	int flags;
};

L
Linus Torvalds 已提交
233
struct TCP_Server_Info {
S
Steve French 已提交
234 235
	struct list_head tcp_ses_list;
	struct list_head smb_ses_list;
236
	int srv_count; /* reference counter */
237
	/* 15 character server name + 0x20 16th byte indicating type = srv */
238
	char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
J
Jeff Layton 已提交
239
	enum statusEnum tcpStatus; /* what we think the status is */
240
	char *hostname; /* hostname portion of UNC string */
L
Linus Torvalds 已提交
241
	struct socket *ssocket;
242
	struct sockaddr_storage dstaddr;
243
	struct sockaddr_storage srcaddr; /* locally bind to this IP */
244 245 246
#ifdef CONFIG_NET_NS
	struct net *net;
#endif
S
Steve French 已提交
247
	wait_queue_head_t response_q;
L
Linus Torvalds 已提交
248 249
	wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
	struct list_head pending_mid_q;
250 251
	bool noblocksnd;		/* use blocking sendmsg */
	bool noautotune;		/* do not autotune send buf sizes */
252
	bool tcp_nodelay;
253
	int credits;  /* send no more requests at once */
P
Pavel Shilovsky 已提交
254
	unsigned int in_flight;  /* number of requests on the wire to server */
255
	spinlock_t req_lock;  /* protect the two values above */
J
Jeff Layton 已提交
256
	struct mutex srv_mutex;
L
Linus Torvalds 已提交
257 258
	struct task_struct *tsk;
	char server_GUID[16];
259
	char sec_mode;
J
Jeff Layton 已提交
260 261
	bool session_estab; /* mark when very first sess is established */
	u16 dialect; /* dialect index that server chose */
L
Linus Torvalds 已提交
262
	enum securityEnum secType;
263
	bool oplocks:1; /* enable oplocks */
L
Linus Torvalds 已提交
264 265 266 267 268
	unsigned int maxReq;	/* Clients should submit no more */
	/* than maxReq distinct unanswered SMBs to the server when using  */
	/* multiplexed reads or writes */
	unsigned int maxBuf;	/* maxBuf specifies the maximum */
	/* message size the server can send or receive for non-raw SMBs */
269 270
	/* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
	/* when socket is setup (and during reconnect) before NegProt sent */
271
	unsigned int max_rw;	/* maxRw specifies the maximum */
L
Linus Torvalds 已提交
272 273
	/* message size the server can send or receive for */
	/* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
274 275 276
	unsigned int max_vcs;	/* maximum number of smb sessions, at least
				   those that can be specified uniquely with
				   vcnumbers */
L
Linus Torvalds 已提交
277
	int capabilities; /* allow selective disabling of caps by smb sess */
278
	int timeAdj;  /* Adjust for difference in server time zone in sec */
279
	__u16 CurrentMid;         /* multiplex id - rotating counter */
280
	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
281
	/* 16th byte of RFC1001 workstation name is always null */
282
	char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
283
	__u32 sequence_number; /* for signing, protected by srv_mutex */
284
	struct session_key session_key;
285
	unsigned long lstrp; /* when we got last response from this server */
286
	struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
287
	/* extended security flavors that server supports */
J
Jeff Layton 已提交
288 289
	bool	sec_ntlmssp;		/* supports NTLMSSP */
	bool	sec_kerberosu2u;	/* supports U2U Kerberos */
290 291
	bool	sec_kerberos;		/* supports plain Kerberos */
	bool	sec_mskerberos;		/* supports legacy MS Kerberos */
292
	bool	large_buf;		/* is current buffer large? */
293
	struct delayed_work	echo; /* echo ping workqueue job */
294 295
	struct kvec *iov;	/* reusable kvec array for receives */
	unsigned int nr_iov;	/* number of kvecs in array */
296 297 298
	char	*smallbuf;	/* pointer to current "small" buffer */
	char	*bigbuf;	/* pointer to current "big" buffer */
	unsigned int total_read; /* total amount of data read in this pass */
299 300 301
#ifdef CONFIG_CIFS_FSCACHE
	struct fscache_cookie   *fscache; /* client index cache cookie */
#endif
J
Jeff Layton 已提交
302
#ifdef CONFIG_CIFS_STATS2
303
	atomic_t in_send; /* requests trying to send */
J
Jeff Layton 已提交
304 305
	atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
#endif
L
Linus Torvalds 已提交
306 307
};

P
Pavel Shilovsky 已提交
308 309 310 311 312 313 314 315 316 317
static inline unsigned int
in_flight(struct TCP_Server_Info *server)
{
	unsigned int num;
	spin_lock(&server->req_lock);
	num = server->in_flight;
	spin_unlock(&server->req_lock);
	return num;
}

318 319
static inline bool
has_credits(struct TCP_Server_Info *server)
P
Pavel Shilovsky 已提交
320
{
321
	int num;
P
Pavel Shilovsky 已提交
322
	spin_lock(&server->req_lock);
323
	num = server->credits;
P
Pavel Shilovsky 已提交
324
	spin_unlock(&server->req_lock);
325
	return num > 0;
P
Pavel Shilovsky 已提交
326 327
}

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
/*
 * Macros to allow the TCP_Server_Info->net field and related code to drop out
 * when CONFIG_NET_NS isn't set.
 */

#ifdef CONFIG_NET_NS

static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
{
	return srv->net;
}

static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
{
	srv->net = net;
}

#else

static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
{
	return &init_net;
}

static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
{
}

#endif

L
Linus Torvalds 已提交
358 359 360
/*
 * Session structure.  One of these for each uid session with a particular host
 */
361
struct cifs_ses {
362
	struct list_head smb_ses_list;
S
Steve French 已提交
363
	struct list_head tcon_list;
364
	struct mutex session_mutex;
L
Linus Torvalds 已提交
365
	struct TCP_Server_Info *server;	/* pointer to server info */
366
	int ses_count;		/* reference counter */
L
Linus Torvalds 已提交
367
	enum statusEnum status;
368
	unsigned overrideSecFlg;  /* if non-zero override global sec flags */
L
Linus Torvalds 已提交
369 370
	__u16 ipc_tid;		/* special tid for connection to IPC share */
	__u16 flags;
371
	__u16 vcnum;
372 373
	char *serverOS;		/* name of operating system underlying server */
	char *serverNOS;	/* name of network operating system of server */
L
Linus Torvalds 已提交
374 375
	char *serverDomain;	/* security realm of server */
	int Suid;		/* remote smb uid  */
376 377
	uid_t linux_uid;        /* overriding owner of files on the mount */
	uid_t cred_uid;		/* owner of credentials */
L
Linus Torvalds 已提交
378
	int capabilities;
S
Steve French 已提交
379
	char serverName[SERVER_NAME_LEN_WITH_NULL * 2];	/* BB make bigger for
380
				TCP names - will ipv6 and sctp addresses fit? */
381 382
	char *user_name;	/* must not be null except during init of sess
				   and after mount option parsing we fill it */
S
Steve French 已提交
383 384
	char *domainName;
	char *password;
385
	struct session_key auth_key;
386
	struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
S
Steve French 已提交
387
	bool need_reconnect:1; /* connection reset, uid now invalid */
L
Linus Torvalds 已提交
388
};
389
/* no more than one of the following three session flags may be set */
L
Linus Torvalds 已提交
390
#define CIFS_SES_NT4 1
391 392 393 394 395 396
#define CIFS_SES_OS2 2
#define CIFS_SES_W9X 4
/* following flag is set for old servers such as OS2 (and Win95?)
   which do not negotiate NTLM or POSIX dialects, but instead
   negotiate one of the older LANMAN dialects */
#define CIFS_SES_LANMAN 8
L
Linus Torvalds 已提交
397 398
/*
 * there is one of these for each connection to a resource on a particular
S
Steve French 已提交
399
 * session
L
Linus Torvalds 已提交
400
 */
401
struct cifs_tcon {
402 403
	struct list_head tcon_list;
	int tc_count;
L
Linus Torvalds 已提交
404
	struct list_head openFileList;
405
	struct cifs_ses *ses;	/* pointer to session associated with */
406
	char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
L
Linus Torvalds 已提交
407
	char *nativeFileSystem;
J
Jeff Layton 已提交
408
	char *password;		/* for share-level security */
L
Linus Torvalds 已提交
409 410 411 412 413 414 415
	__u16 tid;		/* The 2 byte tree id */
	__u16 Flags;		/* optional support bits */
	enum statusEnum tidStatus;
#ifdef CONFIG_CIFS_STATS
	atomic_t num_smbs_sent;
	atomic_t num_writes;
	atomic_t num_reads;
416
	atomic_t num_flushes;
L
Linus Torvalds 已提交
417 418
	atomic_t num_oplock_brks;
	atomic_t num_opens;
419
	atomic_t num_closes;
L
Linus Torvalds 已提交
420 421
	atomic_t num_deletes;
	atomic_t num_mkdirs;
422 423
	atomic_t num_posixopens;
	atomic_t num_posixmkdirs;
L
Linus Torvalds 已提交
424 425 426
	atomic_t num_rmdirs;
	atomic_t num_renames;
	atomic_t num_t2renames;
427 428 429
	atomic_t num_ffirst;
	atomic_t num_fnext;
	atomic_t num_fclose;
430 431 432
	atomic_t num_hardlinks;
	atomic_t num_symlinks;
	atomic_t num_locks;
433 434
	atomic_t num_acl_get;
	atomic_t num_acl_set;
435 436 437 438 439 440 441 442 443 444 445 446 447 448
#ifdef CONFIG_CIFS_STATS2
	unsigned long long time_writes;
	unsigned long long time_reads;
	unsigned long long time_opens;
	unsigned long long time_deletes;
	unsigned long long time_closes;
	unsigned long long time_mkdirs;
	unsigned long long time_rmdirs;
	unsigned long long time_renames;
	unsigned long long time_t2renames;
	unsigned long long time_ffirst;
	unsigned long long time_fnext;
	unsigned long long time_fclose;
#endif /* CONFIG_CIFS_STATS2 */
L
Linus Torvalds 已提交
449 450 451
	__u64    bytes_read;
	__u64    bytes_written;
	spinlock_t stat_lock;
452
#endif /* CONFIG_CIFS_STATS */
L
Linus Torvalds 已提交
453
	FILE_SYSTEM_DEVICE_INFO fsDevInfo;
454
	FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
L
Linus Torvalds 已提交
455
	FILE_SYSTEM_UNIX_INFO fsUnixInfo;
456 457 458
	bool ipc:1;		/* set if connection to IPC$ eg for RPC/PIPES */
	bool retry:1;
	bool nocase:1;
459
	bool seal:1;      /* transport encryption for this mounted share */
460
	bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
461
				for this mount even if server would support */
S
Steve French 已提交
462
	bool local_lease:1; /* check leases (only) on local system not remote */
463
	bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
S
Steve French 已提交
464
	bool need_reconnect:1; /* connection reset, tid now invalid */
465 466 467 468
#ifdef CONFIG_CIFS_FSCACHE
	u64 resource_id;		/* server resource id */
	struct fscache_cookie *fscache;	/* cookie for share */
#endif
469
	/* BB add field for back pointer to sb struct(s)? */
L
Linus Torvalds 已提交
470 471
};

472 473 474 475 476 477 478
/*
 * This is a refcounted and timestamped container for a tcon pointer. The
 * container holds a tcon reference. It is considered safe to free one of
 * these when the tl_count goes to 0. The tl_time is the time of the last
 * "get" on the container.
 */
struct tcon_link {
J
Jeff Layton 已提交
479 480
	struct rb_node		tl_rbnode;
	uid_t			tl_uid;
481 482 483 484 485 486
	unsigned long		tl_flags;
#define TCON_LINK_MASTER	0
#define TCON_LINK_PENDING	1
#define TCON_LINK_IN_TREE	2
	unsigned long		tl_time;
	atomic_t		tl_count;
487
	struct cifs_tcon	*tl_tcon;
488 489
};

490
extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
491

492
static inline struct cifs_tcon *
493 494
tlink_tcon(struct tcon_link *tlink)
{
495
	return tlink->tl_tcon;
496 497
}

498
extern void cifs_put_tlink(struct tcon_link *tlink);
499

500 501 502
static inline struct tcon_link *
cifs_get_tlink(struct tcon_link *tlink)
{
503 504
	if (tlink && !IS_ERR(tlink))
		atomic_inc(&tlink->tl_count);
505 506 507
	return tlink;
}

508
/* This function is always expected to succeed */
509
extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
510

L
Linus Torvalds 已提交
511
/*
J
[CIFS]  
Jeremy Allison 已提交
512 513
 * This info hangs off the cifsFileInfo structure, pointed to by llist.
 * This is used to track byte stream locks on the file
L
Linus Torvalds 已提交
514 515
 */
struct cifsLockInfo {
J
[CIFS]  
Jeremy Allison 已提交
516
	struct list_head llist;	/* pointer to next cifsLockInfo */
517 518
	struct list_head blist; /* pointer to locks blocked on this */
	wait_queue_head_t block_q;
J
[CIFS]  
Jeremy Allison 已提交
519 520
	__u64 offset;
	__u64 length;
521
	__u32 pid;
J
[CIFS]  
Jeremy Allison 已提交
522
	__u8 type;
523
	__u16 netfid;
L
Linus Torvalds 已提交
524 525 526 527 528 529 530 531 532 533
};

/*
 * One of these for each open instance of a file
 */
struct cifs_search_info {
	loff_t index_of_last_entry;
	__u16 entries_in_buffer;
	__u16 info_level;
	__u32 resume_key;
S
Steve French 已提交
534 535
	char *ntwrk_buf_start;
	char *srch_entries_start;
536
	char *last_entry;
537
	const char *presume_name;
L
Linus Torvalds 已提交
538
	unsigned int resume_name_len;
539 540 541 542
	bool endOfSearch:1;
	bool emptyDir:1;
	bool unicode:1;
	bool smallBuf:1; /* so we know which buf_release function to call */
L
Linus Torvalds 已提交
543 544 545 546 547 548 549 550 551 552
};

struct cifsFileInfo {
	struct list_head tlist;	/* pointer to next fid owned by tcon */
	struct list_head flist;	/* next fid (file instance) for this inode */
	unsigned int uid;	/* allows finding which FileInfo structure */
	__u32 pid;		/* process id who opened file */
	__u16 netfid;		/* file id from remote */
	/* BB add lock scope info here if needed */ ;
	/* lock scope id (0 if none) */
553
	struct dentry *dentry;
J
Jeff Layton 已提交
554
	unsigned int f_flags;
555
	struct tcon_link *tlink;
556
	bool invalidHandle:1;	/* file closed via session abend */
557
	bool oplock_break_cancelled:1;
558
	int count;		/* refcount protected by cifs_file_list_lock */
559
	struct mutex fh_mutex; /* prevents reopen race after dead ses*/
L
Linus Torvalds 已提交
560
	struct cifs_search_info srch_inf;
561
	struct work_struct oplock_break; /* work for oplock breaks */
L
Linus Torvalds 已提交
562 563
};

564 565 566 567 568
struct cifs_io_parms {
	__u16 netfid;
	__u32 pid;
	__u64 offset;
	unsigned int length;
569
	struct cifs_tcon *tcon;
570 571
};

572 573 574 575
/*
 * Take a reference on the file private data. Must be called with
 * cifs_file_list_lock held.
 */
576 577
static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
{
578
	++cifs_file->count;
579 580
}

581
void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
582

L
Linus Torvalds 已提交
583 584 585 586 587
/*
 * One of these for each file inode
 */

struct cifsInodeInfo {
588 589 590
	struct list_head llist;		/* brlocks for this inode */
	bool can_cache_brlcks;
	struct mutex lock_mutex;	/* protect two fields above */
S
Steve French 已提交
591
	/* BB add in lists for dirty pages i.e. write caching info for oplock */
L
Linus Torvalds 已提交
592 593
	struct list_head openFileList;
	__u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
594 595 596 597 598
	bool clientCanCacheRead;	/* read oplock */
	bool clientCanCacheAll;		/* read and writebehind oplock */
	bool delete_pending;		/* DELETE_ON_CLOSE is set */
	bool invalid_mapping;		/* pagecache is invalid */
	unsigned long time;		/* jiffies of last update of inode */
599
	u64  server_eof;		/* current file size on server */
600
	u64  uniqueid;			/* server inode number */
601
	u64  createtime;		/* creation time on server */
602 603 604
#ifdef CONFIG_CIFS_FSCACHE
	struct fscache_cookie *fscache;
#endif
L
Linus Torvalds 已提交
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
	struct inode vfs_inode;
};

static inline struct cifsInodeInfo *
CIFS_I(struct inode *inode)
{
	return container_of(inode, struct cifsInodeInfo, vfs_inode);
}

static inline struct cifs_sb_info *
CIFS_SB(struct super_block *sb)
{
	return sb->s_fs_info;
}

S
Steve French 已提交
620
static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
621 622 623 624 625 626
{
	if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
		return '/';
	else
		return '\\';
}
L
Linus Torvalds 已提交
627

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
static inline void
convert_delimiter(char *path, char delim)
{
	int i;
	char old_delim;

	if (path == NULL)
		return;

	if (delim == '/')
		old_delim = '\\';
	else
		old_delim = '/';

	for (i = 0; path[i] != '\0'; i++) {
		if (path[i] == old_delim)
			path[i] = delim;
	}
}

648 649 650
#ifdef CONFIG_CIFS_STATS
#define cifs_stats_inc atomic_inc

651
static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
652 653 654 655 656 657 658 659 660
					    unsigned int bytes)
{
	if (bytes) {
		spin_lock(&tcon->stat_lock);
		tcon->bytes_written += bytes;
		spin_unlock(&tcon->stat_lock);
	}
}

661
static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
662 663 664 665 666 667 668 669
					 unsigned int bytes)
{
	spin_lock(&tcon->stat_lock);
	tcon->bytes_read += bytes;
	spin_unlock(&tcon->stat_lock);
}
#else

S
Steve French 已提交
670 671 672
#define  cifs_stats_inc(field) do {} while (0)
#define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
#define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
673 674 675

#endif

676 677 678
struct mid_q_entry;

/*
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
 * This is the prototype for the mid receive function. This function is for
 * receiving the rest of the SMB frame, starting with the WordCount (which is
 * just after the MID in struct smb_hdr). Note:
 *
 * - This will be called by cifsd, with no locks held.
 * - The mid will still be on the pending_mid_q.
 * - mid->resp_buf will point to the current buffer.
 *
 * Returns zero on a successful receive, or an error. The receive state in
 * the TCP_Server_Info will also be updated.
 */
typedef int (mid_receive_t)(struct TCP_Server_Info *server,
			    struct mid_q_entry *mid);

/*
 * This is the prototype for the mid callback function. This is called once the
 * mid has been received off of the socket. When creating one, take special
 * care to avoid deadlocks. Things to bear in mind:
697
 *
698 699
 * - it will be called by cifsd, with no locks held
 * - the mid will be removed from any lists
700 701 702
 */
typedef void (mid_callback_t)(struct mid_q_entry *mid);

L
Linus Torvalds 已提交
703 704 705 706 707 708
/* one of these for every pending CIFS request to the server */
struct mid_q_entry {
	struct list_head qhead;	/* mids waiting on reply from this server */
	__u16 mid;		/* multiplex id */
	__u16 pid;		/* process id */
	__u32 sequence_number;  /* for CIFS signing */
S
Steve French 已提交
709 710 711 712 713
	unsigned long when_alloc;  /* when mid was created */
#ifdef CONFIG_CIFS_STATS2
	unsigned long when_sent; /* time when smb send finished */
	unsigned long when_received; /* when demux complete (taken off wire) */
#endif
714
	mid_receive_t *receive; /* call receive callback */
715 716
	mid_callback_t *callback; /* call completion callback */
	void *callback_data;	  /* general purpose pointer for callback */
717
	struct smb_hdr *resp_buf;	/* pointer to received SMB header */
L
Linus Torvalds 已提交
718
	int midState;	/* wish this were enum but can not pass to wait_event */
719
	__u8 command;	/* smb command code */
720 721 722
	bool largeBuf:1;	/* if valid response, is pointer to large buf */
	bool multiRsp:1;	/* multiple trans2 responses for one request  */
	bool multiEnd:1;	/* both received */
L
Linus Torvalds 已提交
723 724
};

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
/*	Make code in transport.c a little cleaner by moving
	update of optional stats into function below */
#ifdef CONFIG_CIFS_STATS2

static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
{
	atomic_inc(&server->in_send);
}

static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
{
	atomic_dec(&server->in_send);
}

static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
{
	atomic_inc(&server->num_waiters);
}

static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
{
	atomic_dec(&server->num_waiters);
}

static inline void cifs_save_when_sent(struct mid_q_entry *mid)
{
	mid->when_sent = jiffies;
}
#else
static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
{
}
static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
{
}

static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
{
}

static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
{
}

static inline void cifs_save_when_sent(struct mid_q_entry *mid)
{
}
#endif
L
Linus Torvalds 已提交
773

774 775
/* for pending dnotify requests */
struct dir_notify_req {
776 777 778 779 780 781 782 783 784 785
	struct list_head lhead;
	__le16 Pid;
	__le16 PidHigh;
	__u16 Mid;
	__u16 Tid;
	__u16 Uid;
	__u16 netfid;
	__u32 filter; /* CompletionFilter (for multishot) */
	int multishot;
	struct file *pfile;
786 787
};

S
Steve French 已提交
788 789
struct dfs_info3_param {
	int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
790
	int path_consumed;
S
Steve French 已提交
791 792 793 794 795 796
	int server_type;
	int ref_flag;
	char *path_name;
	char *node_name;
};

797 798 799 800 801 802
/*
 * common struct for holding inode info when searching for or updating an
 * inode with new info
 */

#define CIFS_FATTR_DFS_REFERRAL		0x1
803 804
#define CIFS_FATTR_DELETE_PENDING	0x2
#define CIFS_FATTR_NEED_REVAL		0x4
805
#define CIFS_FATTR_INO_COLLISION	0x8
806 807 808 809 810 811 812

struct cifs_fattr {
	u32		cf_flags;
	u32		cf_cifsattrs;
	u64		cf_uniqueid;
	u64		cf_eof;
	u64		cf_bytes;
813
	u64		cf_createtime;
814 815 816 817 818 819 820 821 822 823 824
	uid_t		cf_uid;
	gid_t		cf_gid;
	umode_t		cf_mode;
	dev_t		cf_rdev;
	unsigned int	cf_nlink;
	unsigned int	cf_dtype;
	struct timespec	cf_atime;
	struct timespec	cf_mtime;
	struct timespec	cf_ctime;
};

S
Steve French 已提交
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
static inline void free_dfs_info_param(struct dfs_info3_param *param)
{
	if (param) {
		kfree(param->path_name);
		kfree(param->node_name);
		kfree(param);
	}
}

static inline void free_dfs_info_array(struct dfs_info3_param *param,
				       int number_of_items)
{
	int i;
	if ((number_of_items == 0) || (param == NULL))
		return;
	for (i = 0; i < number_of_items; i++) {
		kfree(param[i].path_name);
		kfree(param[i].node_name);
	}
	kfree(param);
}

L
Linus Torvalds 已提交
847 848 849 850 851
#define   MID_FREE 0
#define   MID_REQUEST_ALLOCATED 1
#define   MID_REQUEST_SUBMITTED 2
#define   MID_RESPONSE_RECEIVED 4
#define   MID_RETRY_NEEDED      8 /* session closed while this request out */
852
#define   MID_RESPONSE_MALFORMED 0x10
853
#define   MID_SHUTDOWN		 0x20
854 855 856 857 858 859

/* Types of response buffer returned from SendReceive2 */
#define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
#define   CIFS_SMALL_BUFFER     1
#define   CIFS_LARGE_BUFFER     2
#define   CIFS_IOVEC            4    /* array of response buffers */
L
Linus Torvalds 已提交
860

861
/* Type of Request to SendReceive2 */
862 863 864
#define   CIFS_BLOCKING_OP      1    /* operation can block */
#define   CIFS_ASYNC_OP         2    /* do not wait for response */
#define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
865 866 867 868
#define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
#define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
#define   CIFS_NO_RESP      0x040    /* no response buffer required */

869 870 871 872 873 874 875 876
/* Security Flags: indicate type of session setup needed */
#define   CIFSSEC_MAY_SIGN	0x00001
#define   CIFSSEC_MAY_NTLM	0x00002
#define   CIFSSEC_MAY_NTLMV2	0x00004
#define   CIFSSEC_MAY_KRB5	0x00008
#ifdef CONFIG_CIFS_WEAK_PW_HASH
#define   CIFSSEC_MAY_LANMAN	0x00010
#define   CIFSSEC_MAY_PLNTXT	0x00020
877 878 879
#else
#define   CIFSSEC_MAY_LANMAN    0
#define   CIFSSEC_MAY_PLNTXT    0
880 881
#endif /* weak passwords */
#define   CIFSSEC_MAY_SEAL	0x00040 /* not supported yet */
882
#define   CIFSSEC_MAY_NTLMSSP	0x00080 /* raw ntlmssp with ntlmv2 */
883 884 885 886 887 888 889 890 891 892 893

#define   CIFSSEC_MUST_SIGN	0x01001
/* note that only one of the following can be set so the
result of setting MUST flags more than once will be to
require use of the stronger protocol */
#define   CIFSSEC_MUST_NTLM	0x02002
#define   CIFSSEC_MUST_NTLMV2	0x04004
#define   CIFSSEC_MUST_KRB5	0x08008
#ifdef CONFIG_CIFS_WEAK_PW_HASH
#define   CIFSSEC_MUST_LANMAN	0x10010
#define   CIFSSEC_MUST_PLNTXT	0x20020
894
#ifdef CONFIG_CIFS_UPCALL
C
Chuck Ebbert 已提交
895
#define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
896
#else
C
Chuck Ebbert 已提交
897
#define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
898
#endif /* UPCALL */
899
#else /* do not allow weak pw hash */
900 901
#define   CIFSSEC_MUST_LANMAN	0
#define   CIFSSEC_MUST_PLNTXT	0
902
#ifdef CONFIG_CIFS_UPCALL
903
#define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
S
Steve French 已提交
904
#else
905
#define	  CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
906
#endif /* UPCALL */
907 908
#endif /* WEAK_PW_HASH */
#define   CIFSSEC_MUST_SEAL	0x40040 /* not supported yet */
909
#define   CIFSSEC_MUST_NTLMSSP	0x80080 /* raw ntlmssp with ntlmv2 */
910

911 912
#define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
#define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
913
#define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
L
Linus Torvalds 已提交
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
/*
 *****************************************************************
 * All constants go here
 *****************************************************************
 */

#define UID_HASH (16)

/*
 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
 * following to be declared.
 */

/****************************************************************************
 *  Locking notes.  All updates to global variables and lists should be
 *                  protected by spinlocks or semaphores.
 *
 *  Spinlocks
 *  ---------
 *  GlobalMid_Lock protects:
 *	list operations on pending_mid_q and oplockQ
 *      updates to XID counters, multiplex id  and SMB sequence numbers
936
 *  cifs_file_list_lock protects:
L
Linus Torvalds 已提交
937 938 939 940 941 942 943 944
 *	list operations on tcp and SMB session lists and tCon lists
 *  f_owner.lock protects certain per file struct operations
 *  mapping->page_lock protects certain per page operations
 *
 *  Semaphores
 *  ----------
 *  sesSem     operations on smb session
 *  tconSem    operations on tree connection
S
Steve French 已提交
945
 *  fh_sem      file handle reconnection operations
L
Linus Torvalds 已提交
946 947 948 949 950 951 952 953 954
 *
 ****************************************************************************/

#ifdef DECLARE_GLOBALS_HERE
#define GLOBAL_EXTERN
#else
#define GLOBAL_EXTERN extern
#endif

955 956
/*
 * the list of TCP_Server_Info structures, ie each of the sockets
957
 * connecting our client to a distinct server (ip address), is
958
 * chained together by cifs_tcp_ses_list. The list of all our SMB
959
 * sessions (and from that the tree connections) can be found
960 961 962 963
 * by iterating over cifs_tcp_ses_list
 */
GLOBAL_EXTERN struct list_head		cifs_tcp_ses_list;

964 965 966 967 968 969
/*
 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
 * tcp session, and the list of tcon's per smb session. It also protects
 * the reference counters for the server, smb session, and tcon. Finally,
 * changes to the tcon->tidStatus should be done while holding this lock.
 */
970
GLOBAL_EXTERN spinlock_t		cifs_tcp_ses_lock;
971 972 973 974 975 976 977 978

/*
 * This lock protects the cifs_file->llist and cifs_file->flist
 * list operations, and updates to some flags (cifs_file->invalidHandle)
 * It will be moved to either use the tcon->stat_lock or equivalent later.
 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
 * the cifs_tcp_ses_lock must be grabbed first and released last.
 */
979
GLOBAL_EXTERN spinlock_t	cifs_file_list_lock;
L
Linus Torvalds 已提交
980

981
#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
982 983 984 985
/* Outstanding dir notify requests */
GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
/* DirNotify response queue */
GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
986
#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
987

L
Linus Torvalds 已提交
988 989 990 991
/*
 * Global transaction id (XID) information
 */
GLOBAL_EXTERN unsigned int GlobalCurrentXid;	/* protected by GlobalMid_Sem */
992
GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
L
Linus Torvalds 已提交
993
GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;	/* prot by GlobalMid_Sem */
994 995
GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
					  /* on midQ entries */
L
Linus Torvalds 已提交
996 997 998 999 1000 1001 1002 1003 1004
/*
 *  Global counters, updated atomically
 */
GLOBAL_EXTERN atomic_t sesInfoAllocCount;
GLOBAL_EXTERN atomic_t tconInfoAllocCount;
GLOBAL_EXTERN atomic_t tcpSesAllocCount;
GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
GLOBAL_EXTERN atomic_t tconInfoReconnectCount;

S
Steve French 已提交
1005
/* Various Debug counters */
1006 1007 1008 1009 1010 1011
GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
#ifdef CONFIG_CIFS_STATS2
GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
GLOBAL_EXTERN atomic_t totSmBufAllocCount;
#endif
GLOBAL_EXTERN atomic_t smBufAllocCount;
L
Linus Torvalds 已提交
1012 1013 1014
GLOBAL_EXTERN atomic_t midCount;

/* Misc globals */
1015
GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
L
Linus Torvalds 已提交
1016
				to be established on existing mount if we
S
Steve French 已提交
1017
				have the uid/password or Kerberos credential
L
Linus Torvalds 已提交
1018
				or equivalent for current user */
1019 1020
/* enable or disable oplocks */
GLOBAL_EXTERN bool enable_oplocks;
L
Linus Torvalds 已提交
1021
GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1022
GLOBAL_EXTERN unsigned int global_secflags;	/* if on, session setup sent
L
Linus Torvalds 已提交
1023 1024 1025 1026 1027 1028 1029 1030
				with more secure ntlmssp2 challenge/resp */
GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/

1031 1032 1033
/* reconnect after this many failed echo attempts */
GLOBAL_EXTERN unsigned short echo_retries;

1034
#ifdef CONFIG_CIFS_ACL
1035 1036 1037 1038
GLOBAL_EXTERN struct rb_root uidtree;
GLOBAL_EXTERN struct rb_root gidtree;
GLOBAL_EXTERN spinlock_t siduidlock;
GLOBAL_EXTERN spinlock_t sidgidlock;
1039 1040 1041 1042 1043
GLOBAL_EXTERN struct rb_root siduidtree;
GLOBAL_EXTERN struct rb_root sidgidtree;
GLOBAL_EXTERN spinlock_t uidsidlock;
GLOBAL_EXTERN spinlock_t gidsidlock;
#endif /* CONFIG_CIFS_ACL */
1044

1045
void cifs_oplock_break(struct work_struct *work);
1046

1047
extern const struct slow_work_ops cifs_oplock_break_ops;
1048 1049

#endif	/* _CIFS_GLOB_H */