cifsglob.h 47.5 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/mempool.h>
26
#include <linux/workqueue.h>
L
Linus Torvalds 已提交
27
#include "cifs_fs_sb.h"
28
#include "cifsacl.h"
29 30
#include <crypto/internal/hash.h>
#include <linux/scatterlist.h>
31 32 33
#ifdef CONFIG_CIFS_SMB2
#include "smb2pdu.h"
#endif
34

35 36
#define CIFS_MAGIC_NUMBER 0xFF534D42      /* the first four bytes of SMB PDUs */

L
Linus Torvalds 已提交
37 38 39 40 41 42 43
/*
 * The sizes of various internal tables and strings
 */
#define MAX_UID_INFO 16
#define MAX_SES_INFO 2
#define MAX_TCON_INFO 4

44
#define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
L
Linus Torvalds 已提交
45
#define MAX_SERVER_SIZE 15
S
Steve French 已提交
46
#define MAX_SHARE_SIZE 80
47 48
#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 已提交
49 50 51

#define CIFS_MIN_RCV_POOL 4

52
#define MAX_REOPEN_ATT	5 /* these many maximum attempts to reopen a file */
53 54 55 56 57 58 59 60 61 62
/*
 * 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 已提交
63 64
/*
 * MAX_REQ is the maximum number of requests that WE will send
65
 * on one socket concurrently.
L
Linus Torvalds 已提交
66
 */
67
#define CIFS_MAX_REQ 32767
L
Linus Torvalds 已提交
68

69 70 71 72 73
#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 已提交
74 75 76 77 78 79 80
#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

81 82 83
/* SMB echo "timeout" -- FIXME: tunable? */
#define SMB_ECHO_INTERVAL (60 * HZ)

L
Linus Torvalds 已提交
84 85 86 87 88 89 90 91 92 93
#include "cifspdu.h"

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

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

94
/* associated with each tcp and smb session */
L
Linus Torvalds 已提交
95 96 97 98
enum statusEnum {
	CifsNew = 0,
	CifsGood,
	CifsExiting,
99 100
	CifsNeedReconnect,
	CifsNeedNegotiate
L
Linus Torvalds 已提交
101 102 103
};

enum securityEnum {
104
	LANMAN = 0,			/* Legacy LANMAN auth */
105
	NTLM,			/* Legacy NTLM012 auth with NTLM hash */
L
Linus Torvalds 已提交
106
	NTLMv2,			/* Legacy NTLM auth with NTLMv2 hash */
107
	RawNTLMSSP,		/* NTLMSSP without SPNEGO, NTLMv2 hash */
108
/*	NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
109
	Kerberos,		/* Kerberos via SPNEGO */
L
Linus Torvalds 已提交
110 111 112
};

enum protocolEnum {
113
	TCP = 0,
L
Linus Torvalds 已提交
114 115 116 117
	SCTP
	/* Netbios frames protocol not supported at this time */
};

118
struct session_key {
119
	unsigned int len;
120
	char *response;
121 122
};

123 124 125 126 127 128
/* crypto security descriptor definition */
struct sdesc {
	struct shash_desc shash;
	char ctx[];
};

129
/* crypto hashing related structure/fields, not specific to a sec mech */
130 131 132
struct cifs_secmech {
	struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
	struct crypto_shash *md5; /* md5 hash function */
P
Pavel Shilovsky 已提交
133
	struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
134 135
	struct sdesc *sdeschmacmd5;  /* ctxt to generate ntlmv2 hash, CR1 */
	struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
P
Pavel Shilovsky 已提交
136
	struct sdesc *sdeschmacsha256;  /* ctxt to generate smb2 signature */
137 138
};

139
/* per smb session structure/fields */
140 141 142 143
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 */
144
	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
145 146
};

147 148 149 150 151 152 153 154 155 156 157
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 已提交
158 159 160 161 162 163 164
/*
 *****************************************************************
 * Except the CIFS PDUs themselves all the
 * globally interesting structs should go here
 *****************************************************************
 */

165 166 167 168 169 170 171 172 173 174 175 176 177 178
/*
 * A smb_rqst represents a complete request to be issued to a server. It's
 * formed by a kvec array, followed by an array of pages. Page data is assumed
 * to start at the beginning of the first page.
 */
struct smb_rqst {
	struct kvec	*rq_iov;	/* array of kvecs */
	unsigned int	rq_nvec;	/* number of kvecs in array */
	struct page	**rq_pages;	/* pointer to array of page ptrs */
	unsigned int	rq_npages;	/* number pages in array */
	unsigned int	rq_pagesz;	/* page size to use */
	unsigned int	rq_tailsz;	/* length of last page */
};

179 180
enum smb_version {
	Smb_1 = 1,
181
	Smb_21,
182 183
};

184 185
struct mid_q_entry;
struct TCP_Server_Info;
186
struct cifsFileInfo;
187
struct cifs_ses;
188
struct cifs_tcon;
189
struct dfs_info3_param;
190
struct cifs_fattr;
191
struct smb_vol;
192
struct cifs_fid;
193
struct cifs_readdata;
194
struct cifs_writedata;
195
struct cifs_io_parms;
196
struct cifs_search_info;
197
struct cifsInodeInfo;
198

199
struct smb_version_operations {
200 201
	int (*send_cancel)(struct TCP_Server_Info *, void *,
			   struct mid_q_entry *);
202
	bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
203
	/* setup request: allocate mid, sign message */
204 205
	struct mid_q_entry *(*setup_request)(struct cifs_ses *,
						struct smb_rqst *);
206
	/* setup async request: allocate mid, sign message */
207 208
	struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
						struct smb_rqst *);
209 210 211
	/* check response: verify signature, map error */
	int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
			     bool);
212 213
	void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
			    const int);
214
	void (*set_credits)(struct TCP_Server_Info *, const int);
215 216
	int * (*get_credits_field)(struct TCP_Server_Info *, const int);
	unsigned int (*get_credits)(struct mid_q_entry *);
217
	__u64 (*get_next_mid)(struct TCP_Server_Info *);
218 219 220 221 222 223
	/* data offset from read response message */
	unsigned int (*read_data_offset)(char *);
	/* data length from read response message */
	unsigned int (*read_data_length)(char *);
	/* map smb to linux error */
	int (*map_error)(char *, bool);
224 225 226
	/* find mid corresponding to the response message */
	struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
	void (*dump_detail)(void *);
227 228
	void (*clear_stats)(struct cifs_tcon *);
	void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
229 230 231
	/* verify the message */
	int (*check_message)(char *, unsigned int);
	bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
232 233 234
	/* process transaction2 response */
	bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
			     char *, int);
235 236 237 238
	/* check if we need to negotiate */
	bool (*need_neg)(struct TCP_Server_Info *);
	/* negotiate to the server */
	int (*negotiate)(const unsigned int, struct cifs_ses *);
239 240 241 242
	/* set negotiated write size */
	unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
	/* set negotiated read size */
	unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
243 244 245 246 247
	/* setup smb sessionn */
	int (*sess_setup)(const unsigned int, struct cifs_ses *,
			  const struct nls_table *);
	/* close smb session */
	int (*logoff)(const unsigned int, struct cifs_ses *);
248 249 250 251 252
	/* connect to a server share */
	int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
			    struct cifs_tcon *, const struct nls_table *);
	/* close tree connecion */
	int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
253 254 255 256
	/* get DFS referrals */
	int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
			     const char *, struct dfs_info3_param **,
			     unsigned int *, const struct nls_table *, int);
257 258
	/* informational QFS call */
	void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
259 260 261
	/* check if a path is accessible or not */
	int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
				  struct cifs_sb_info *, const char *);
262 263 264 265
	/* query path data from the server */
	int (*query_path_info)(const unsigned int, struct cifs_tcon *,
			       struct cifs_sb_info *, const char *,
			       FILE_ALL_INFO *, bool *);
266 267 268
	/* query file data from the server */
	int (*query_file_info)(const unsigned int, struct cifs_tcon *,
			       struct cifs_fid *, FILE_ALL_INFO *);
269 270 271 272
	/* get server index number */
	int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
			    struct cifs_sb_info *, const char *,
			    u64 *uniqueid, FILE_ALL_INFO *);
273 274 275 276 277 278
	/* set size by path */
	int (*set_path_size)(const unsigned int, struct cifs_tcon *,
			     const char *, __u64, struct cifs_sb_info *, bool);
	/* set size by file handle */
	int (*set_file_size)(const unsigned int, struct cifs_tcon *,
			     struct cifsFileInfo *, __u64, bool);
279 280 281
	/* set attributes */
	int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
			     const unsigned int);
282 283 284
	/* build a full path to the root of the mount */
	char * (*build_path_to_root)(struct smb_vol *, struct cifs_sb_info *,
				     struct cifs_tcon *);
285 286 287 288
	/* check if we can send an echo or nor */
	bool (*can_echo)(struct TCP_Server_Info *);
	/* send echo request */
	int (*echo)(struct TCP_Server_Info *);
289 290 291 292 293 294 295
	/* create directory */
	int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
		     struct cifs_sb_info *);
	/* set info on created directory */
	void (*mkdir_setinfo)(struct inode *, const char *,
			      struct cifs_sb_info *, struct cifs_tcon *,
			      const unsigned int);
296 297 298
	/* remove directory */
	int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
		     struct cifs_sb_info *);
299 300 301 302 303 304
	/* unlink file */
	int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
		      struct cifs_sb_info *);
	/* open, rename and delete file */
	int (*rename_pending_delete)(const char *, struct dentry *,
				     const unsigned int);
305 306 307
	/* send rename request */
	int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
		      const char *, struct cifs_sb_info *);
S
Steve French 已提交
308 309 310 311
	/* send create hardlink request */
	int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
			       const char *, const char *,
			       struct cifs_sb_info *);
312 313 314 315 316 317
	/* open a file for non-posix mounts */
	int (*open)(const unsigned int, struct cifs_tcon *, const char *, int,
		    int, int, struct cifs_fid *, __u32 *, FILE_ALL_INFO *,
		    struct cifs_sb_info *);
	/* set fid protocol-specific info */
	void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
318 319
	/* close a file */
	int (*close)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
320 321
	/* send a flush request to the server */
	int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
322 323
	/* async read from the server */
	int (*async_readv)(struct cifs_readdata *);
324 325
	/* async write to the server */
	int (*async_writev)(struct cifs_writedata *);
326 327 328 329
	/* sync read from the server */
	int (*sync_read)(const unsigned int, struct cifsFileInfo *,
			 struct cifs_io_parms *, unsigned int *, char **,
			 int *);
330 331 332 333
	/* sync write to the server */
	int (*sync_write)(const unsigned int, struct cifsFileInfo *,
			  struct cifs_io_parms *, unsigned int *, struct kvec *,
			  unsigned long);
334 335 336 337 338 339 340 341 342 343 344 345 346 347
	/* open dir, start readdir */
	int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
			       const char *, struct cifs_sb_info *,
			       struct cifs_fid *, __u16,
			       struct cifs_search_info *);
	/* continue readdir */
	int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
			      struct cifs_fid *,
			      __u16, struct cifs_search_info *srch_inf);
	/* close dir */
	int (*close_dir)(const unsigned int, struct cifs_tcon *,
			 struct cifs_fid *);
	/* calculate a size of SMB message */
	unsigned int (*calc_smb_size)(void *);
P
Pavel Shilovsky 已提交
348 349
	/* check for STATUS_PENDING and process it in a positive case */
	bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
350 351 352
	/* send oplock break response */
	int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
			       struct cifsInodeInfo *);
353 354 355
	/* query remote filesystem */
	int (*queryfs)(const unsigned int, struct cifs_tcon *,
		       struct kstatfs *);
356 357 358 359 360 361 362 363
	/* send mandatory brlock to the server */
	int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
			 __u64, __u32, int, int, bool);
	/* unlock range of mandatory locks */
	int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
				 const unsigned int);
	/* push brlocks from the cache to the server */
	int (*push_mand_locks)(struct cifsFileInfo *);
364 365 366 367
};

struct smb_version_values {
	char		*version_string;
368 369 370 371
	__u32		large_lock_type;
	__u32		exclusive_lock_type;
	__u32		shared_lock_type;
	__u32		unlock_lock_type;
372 373
	size_t		header_size;
	size_t		max_header_size;
374
	size_t		read_rsp_size;
375
	__le16		lock_cmd;
376 377 378
	unsigned int	cap_unix;
	unsigned int	cap_nt_find;
	unsigned int	cap_large_files;
379 380
};

381 382 383
#define HEADER_SIZE(server) (server->vals->header_size)
#define MAX_HEADER_SIZE(server) (server->vals->max_header_size)

384 385 386 387 388 389 390 391 392 393 394 395
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;
396 397
	uid_t backupuid;
	gid_t backupgid;
A
Al Viro 已提交
398 399
	umode_t file_mode;
	umode_t dir_mode;
400 401 402 403 404 405 406 407 408 409
	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;
410 411
	bool backupuid_specified; /* mount option  backupuid  is specified */
	bool backupgid_specified; /* mount option  backupgid  is specified */
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
	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;
433
	bool rwpidforward:1; /* pid forward for read/write operations */
434 435 436 437 438
	unsigned int rsize;
	unsigned int wsize;
	bool sockopt_tcp_nodelay:1;
	unsigned short int port;
	unsigned long actimeo; /* attribute cache timeout (jiffies) */
439 440
	struct smb_version_operations *ops;
	struct smb_version_values *vals;
441 442 443 444 445
	char *prepath;
	struct sockaddr_storage srcaddr; /* allow binding to a local IP */
	struct nls_table *local_nls;
};

446 447 448 449 450 451 452 453
#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 | \
454 455
			 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
			 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
456 457 458 459 460 461 462 463 464 465

#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;
};

466 467 468 469 470 471
static inline unsigned int
get_rfc1002_length(void *buf)
{
	return be32_to_cpu(*((__be32 *)buf));
}

472 473 474 475 476 477
static inline void
inc_rfc1001_len(void *buf, int count)
{
	be32_add_cpu((__be32 *)buf, count);
}

L
Linus Torvalds 已提交
478
struct TCP_Server_Info {
S
Steve French 已提交
479 480
	struct list_head tcp_ses_list;
	struct list_head smb_ses_list;
481
	int srv_count; /* reference counter */
482
	/* 15 character server name + 0x20 16th byte indicating type = srv */
483
	char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
484 485
	struct smb_version_operations	*ops;
	struct smb_version_values	*vals;
J
Jeff Layton 已提交
486
	enum statusEnum tcpStatus; /* what we think the status is */
487
	char *hostname; /* hostname portion of UNC string */
L
Linus Torvalds 已提交
488
	struct socket *ssocket;
489
	struct sockaddr_storage dstaddr;
490
	struct sockaddr_storage srcaddr; /* locally bind to this IP */
491 492 493
#ifdef CONFIG_NET_NS
	struct net *net;
#endif
S
Steve French 已提交
494
	wait_queue_head_t response_q;
L
Linus Torvalds 已提交
495 496
	wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
	struct list_head pending_mid_q;
497 498
	bool noblocksnd;		/* use blocking sendmsg */
	bool noautotune;		/* do not autotune send buf sizes */
499
	bool tcp_nodelay;
500
	int credits;  /* send no more requests at once */
P
Pavel Shilovsky 已提交
501
	unsigned int in_flight;  /* number of requests on the wire to server */
502
	spinlock_t req_lock;  /* protect the two values above */
J
Jeff Layton 已提交
503
	struct mutex srv_mutex;
L
Linus Torvalds 已提交
504 505
	struct task_struct *tsk;
	char server_GUID[16];
506
	__u16 sec_mode;
J
Jeff Layton 已提交
507
	bool session_estab; /* mark when very first sess is established */
P
Pavel Shilovsky 已提交
508 509 510 511 512
#ifdef CONFIG_CIFS_SMB2
	int echo_credits;  /* echo reserved slots */
	int oplock_credits;  /* oplock break reserved slots */
	bool echoes:1; /* enable echoes */
#endif
J
Jeff Layton 已提交
513
	u16 dialect; /* dialect index that server chose */
L
Linus Torvalds 已提交
514
	enum securityEnum secType;
515
	bool oplocks:1; /* enable oplocks */
L
Linus Torvalds 已提交
516 517 518 519 520
	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 */
521 522
	/* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
	/* when socket is setup (and during reconnect) before NegProt sent */
523
	unsigned int max_rw;	/* maxRw specifies the maximum */
L
Linus Torvalds 已提交
524 525
	/* message size the server can send or receive for */
	/* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
526 527 528
	unsigned int max_vcs;	/* maximum number of smb sessions, at least
				   those that can be specified uniquely with
				   vcnumbers */
529
	unsigned int capabilities; /* selective disabling of caps by smb sess */
530
	int timeAdj;  /* Adjust for difference in server time zone in sec */
P
Pavel Shilovsky 已提交
531
	__u64 CurrentMid;         /* multiplex id - rotating counter */
532
	char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
533
	/* 16th byte of RFC1001 workstation name is always null */
534
	char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
535
	__u32 sequence_number; /* for signing, protected by srv_mutex */
536
	struct session_key session_key;
537
	unsigned long lstrp; /* when we got last response from this server */
538
	struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
539
	/* extended security flavors that server supports */
J
Jeff Layton 已提交
540 541
	bool	sec_ntlmssp;		/* supports NTLMSSP */
	bool	sec_kerberosu2u;	/* supports U2U Kerberos */
542 543
	bool	sec_kerberos;		/* supports plain Kerberos */
	bool	sec_mskerberos;		/* supports legacy MS Kerberos */
544
	bool	large_buf;		/* is current buffer large? */
545
	struct delayed_work	echo; /* echo ping workqueue job */
546 547
	struct kvec *iov;	/* reusable kvec array for receives */
	unsigned int nr_iov;	/* number of kvecs in array */
548 549 550
	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 */
551 552 553
#ifdef CONFIG_CIFS_FSCACHE
	struct fscache_cookie   *fscache; /* client index cache cookie */
#endif
J
Jeff Layton 已提交
554
#ifdef CONFIG_CIFS_STATS2
555
	atomic_t in_send; /* requests trying to send */
J
Jeff Layton 已提交
556 557
	atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
#endif
558 559 560 561
#ifdef CONFIG_CIFS_SMB2
	unsigned int	max_read;
	unsigned int	max_write;
#endif /* CONFIG_CIFS_SMB2 */
L
Linus Torvalds 已提交
562 563
};

P
Pavel Shilovsky 已提交
564 565 566 567 568 569 570 571 572 573
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;
}

574
static inline bool
575
has_credits(struct TCP_Server_Info *server, int *credits)
P
Pavel Shilovsky 已提交
576
{
577
	int num;
P
Pavel Shilovsky 已提交
578
	spin_lock(&server->req_lock);
579
	num = *credits;
P
Pavel Shilovsky 已提交
580
	spin_unlock(&server->req_lock);
581
	return num > 0;
P
Pavel Shilovsky 已提交
582 583
}

584
static inline void
585 586
add_credits(struct TCP_Server_Info *server, const unsigned int add,
	    const int optype)
587
{
588
	server->ops->add_credits(server, add, optype);
589 590 591 592 593 594 595 596
}

static inline void
set_credits(struct TCP_Server_Info *server, const int val)
{
	server->ops->set_credits(server, val);
}

597 598 599 600 601 602
static inline __u64
get_next_mid(struct TCP_Server_Info *server)
{
	return server->ops->get_next_mid(server);
}

603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
/*
 * When the server supports very large reads and writes via POSIX extensions,
 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
 * including the RFC1001 length.
 *
 * Note that this might make for "interesting" allocation problems during
 * writeback however as we have to allocate an array of pointers for the
 * pages. A 16M write means ~32kb page array with PAGE_CACHE_SIZE == 4096.
 *
 * For reads, there is a similar problem as we need to allocate an array
 * of kvecs to handle the receive, though that should only need to be done
 * once.
 */
#define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
#define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)

/*
 * When the server doesn't allow large posix writes, only allow a rsize/wsize
 * of 2^17-1 minus the size of the call header. That allows for a read or
 * write up to the maximum size described by RFC1002.
 */
#define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
#define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)

/*
 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
 * pages in a single call. With PAGE_CACHE_SIZE == 4k, this means we can fill
 * a single wsize request with a single call.
 */
#define CIFS_DEFAULT_IOSIZE (1024 * 1024)

/*
 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
 * those values when posix extensions aren't in force. In actuality here, we
 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
 * to be ok with the extra byte even though Windows doesn't send writes that
 * are that large.
 *
 * Citation:
 *
 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
 */
#define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
#define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)

648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
/*
 * 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 已提交
678 679 680
/*
 * Session structure.  One of these for each uid session with a particular host
 */
681
struct cifs_ses {
682
	struct list_head smb_ses_list;
S
Steve French 已提交
683
	struct list_head tcon_list;
684
	struct mutex session_mutex;
L
Linus Torvalds 已提交
685
	struct TCP_Server_Info *server;	/* pointer to server info */
686
	int ses_count;		/* reference counter */
L
Linus Torvalds 已提交
687
	enum statusEnum status;
688
	unsigned overrideSecFlg;  /* if non-zero override global sec flags */
L
Linus Torvalds 已提交
689 690
	__u16 ipc_tid;		/* special tid for connection to IPC share */
	__u16 flags;
691
	__u16 vcnum;
692 693
	char *serverOS;		/* name of operating system underlying server */
	char *serverNOS;	/* name of network operating system of server */
L
Linus Torvalds 已提交
694
	char *serverDomain;	/* security realm of server */
695
	__u64 Suid;		/* remote smb uid  */
696 697
	uid_t linux_uid;        /* overriding owner of files on the mount */
	uid_t cred_uid;		/* owner of credentials */
698
	unsigned int capabilities;
S
Steve French 已提交
699
	char serverName[SERVER_NAME_LEN_WITH_NULL * 2];	/* BB make bigger for
700
				TCP names - will ipv6 and sctp addresses fit? */
701 702
	char *user_name;	/* must not be null except during init of sess
				   and after mount option parsing we fill it */
S
Steve French 已提交
703 704
	char *domainName;
	char *password;
705
	struct session_key auth_key;
706
	struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
S
Steve French 已提交
707
	bool need_reconnect:1; /* connection reset, uid now invalid */
708 709 710
#ifdef CONFIG_CIFS_SMB2
	__u16 session_flags;
#endif /* CONFIG_CIFS_SMB2 */
L
Linus Torvalds 已提交
711
};
712
/* no more than one of the following three session flags may be set */
L
Linus Torvalds 已提交
713
#define CIFS_SES_NT4 1
714 715 716 717 718 719
#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
720 721 722 723 724 725 726

static inline bool
cap_unix(struct cifs_ses *ses)
{
	return ses->server->vals->cap_unix & ses->capabilities;
}

L
Linus Torvalds 已提交
727 728
/*
 * there is one of these for each connection to a resource on a particular
S
Steve French 已提交
729
 * session
L
Linus Torvalds 已提交
730
 */
731
struct cifs_tcon {
732 733
	struct list_head tcon_list;
	int tc_count;
L
Linus Torvalds 已提交
734
	struct list_head openFileList;
735
	struct cifs_ses *ses;	/* pointer to session associated with */
736
	char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
L
Linus Torvalds 已提交
737
	char *nativeFileSystem;
J
Jeff Layton 已提交
738
	char *password;		/* for share-level security */
739
	__u32 tid;		/* The 4 byte tree id */
L
Linus Torvalds 已提交
740 741 742 743
	__u16 Flags;		/* optional support bits */
	enum statusEnum tidStatus;
#ifdef CONFIG_CIFS_STATS
	atomic_t num_smbs_sent;
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
	union {
		struct {
			atomic_t num_writes;
			atomic_t num_reads;
			atomic_t num_flushes;
			atomic_t num_oplock_brks;
			atomic_t num_opens;
			atomic_t num_closes;
			atomic_t num_deletes;
			atomic_t num_mkdirs;
			atomic_t num_posixopens;
			atomic_t num_posixmkdirs;
			atomic_t num_rmdirs;
			atomic_t num_renames;
			atomic_t num_t2renames;
			atomic_t num_ffirst;
			atomic_t num_fnext;
			atomic_t num_fclose;
			atomic_t num_hardlinks;
			atomic_t num_symlinks;
			atomic_t num_locks;
			atomic_t num_acl_get;
			atomic_t num_acl_set;
		} cifs_stats;
768 769 770 771 772 773
#ifdef CONFIG_CIFS_SMB2
		struct {
			atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
			atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
		} smb2_stats;
#endif /* CONFIG_CIFS_SMB2 */
774
	} stats;
775 776 777 778 779 780 781 782 783 784 785 786 787 788
#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 已提交
789 790 791
	__u64    bytes_read;
	__u64    bytes_written;
	spinlock_t stat_lock;
792
#endif /* CONFIG_CIFS_STATS */
L
Linus Torvalds 已提交
793
	FILE_SYSTEM_DEVICE_INFO fsDevInfo;
794
	FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
L
Linus Torvalds 已提交
795
	FILE_SYSTEM_UNIX_INFO fsUnixInfo;
796 797 798
	bool ipc:1;		/* set if connection to IPC$ eg for RPC/PIPES */
	bool retry:1;
	bool nocase:1;
799
	bool seal:1;      /* transport encryption for this mounted share */
800
	bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
801
				for this mount even if server would support */
S
Steve French 已提交
802
	bool local_lease:1; /* check leases (only) on local system not remote */
803
	bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
S
Steve French 已提交
804
	bool need_reconnect:1; /* connection reset, tid now invalid */
805 806 807 808 809 810 811 812 813
#ifdef CONFIG_CIFS_SMB2
	bool print:1;		/* set if connection to printer share */
	bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
	__u32 capabilities;
	__u32 share_flags;
	__u32 maximal_access;
	__u32 vol_serial_number;
	__le64 vol_create_time;
#endif /* CONFIG_CIFS_SMB2 */
814 815 816 817
#ifdef CONFIG_CIFS_FSCACHE
	u64 resource_id;		/* server resource id */
	struct fscache_cookie *fscache;	/* cookie for share */
#endif
818
	/* BB add field for back pointer to sb struct(s)? */
L
Linus Torvalds 已提交
819 820
};

821 822 823 824 825 826 827
/*
 * 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 已提交
828 829
	struct rb_node		tl_rbnode;
	uid_t			tl_uid;
830 831 832 833 834 835
	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;
836
	struct cifs_tcon	*tl_tcon;
837 838
};

839
extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
840

841
static inline struct cifs_tcon *
842 843
tlink_tcon(struct tcon_link *tlink)
{
844
	return tlink->tl_tcon;
845 846
}

847
extern void cifs_put_tlink(struct tcon_link *tlink);
848

849 850 851
static inline struct tcon_link *
cifs_get_tlink(struct tcon_link *tlink)
{
852 853
	if (tlink && !IS_ERR(tlink))
		atomic_inc(&tlink->tl_count);
854 855 856
	return tlink;
}

857
/* This function is always expected to succeed */
858
extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
859

L
Linus Torvalds 已提交
860
/*
J
[CIFS]  
Jeremy Allison 已提交
861 862
 * 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 已提交
863 864
 */
struct cifsLockInfo {
J
[CIFS]  
Jeremy Allison 已提交
865
	struct list_head llist;	/* pointer to next cifsLockInfo */
866 867
	struct list_head blist; /* pointer to locks blocked on this */
	wait_queue_head_t block_q;
J
[CIFS]  
Jeremy Allison 已提交
868 869
	__u64 offset;
	__u64 length;
870
	__u32 pid;
871
	__u32 type;
L
Linus Torvalds 已提交
872 873 874 875 876 877 878 879 880 881
};

/*
 * 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 已提交
882 883
	char *ntwrk_buf_start;
	char *srch_entries_start;
884
	char *last_entry;
885
	const char *presume_name;
L
Linus Torvalds 已提交
886
	unsigned int resume_name_len;
887 888 889 890
	bool endOfSearch:1;
	bool emptyDir:1;
	bool unicode:1;
	bool smallBuf:1; /* so we know which buf_release function to call */
L
Linus Torvalds 已提交
891 892
};

893 894
struct cifs_fid {
	__u16 netfid;
895 896 897 898
#ifdef CONFIG_CIFS_SMB2
	__u64 persistent_fid;	/* persist file id for smb2 */
	__u64 volatile_fid;	/* volatile file id for smb2 */
#endif
899 900
};

901 902 903 904 905 906
struct cifs_fid_locks {
	struct list_head llist;
	struct cifsFileInfo *cfile;	/* fid that owns locks */
	struct list_head locks;		/* locks held by fid above */
};

L
Linus Torvalds 已提交
907 908 909
struct cifsFileInfo {
	struct list_head tlist;	/* pointer to next fid owned by tcon */
	struct list_head flist;	/* next fid (file instance) for this inode */
910
	struct cifs_fid_locks *llist;	/* brlocks held by this fid */
L
Linus Torvalds 已提交
911 912
	unsigned int uid;	/* allows finding which FileInfo structure */
	__u32 pid;		/* process id who opened file */
913
	struct cifs_fid fid;	/* file id from remote */
L
Linus Torvalds 已提交
914 915
	/* BB add lock scope info here if needed */ ;
	/* lock scope id (0 if none) */
916
	struct dentry *dentry;
J
Jeff Layton 已提交
917
	unsigned int f_flags;
918
	struct tcon_link *tlink;
919
	bool invalidHandle:1;	/* file closed via session abend */
920
	bool oplock_break_cancelled:1;
921
	int count;		/* refcount protected by cifs_file_list_lock */
922
	struct mutex fh_mutex; /* prevents reopen race after dead ses*/
L
Linus Torvalds 已提交
923
	struct cifs_search_info srch_inf;
924
	struct work_struct oplock_break; /* work for oplock breaks */
L
Linus Torvalds 已提交
925 926
};

927 928
struct cifs_io_parms {
	__u16 netfid;
929 930 931 932
#ifdef CONFIG_CIFS_SMB2
	__u64 persistent_fid;	/* persist file id for smb2 */
	__u64 volatile_fid;	/* volatile file id for smb2 */
#endif
933 934 935
	__u32 pid;
	__u64 offset;
	unsigned int length;
936
	struct cifs_tcon *tcon;
937 938
};

939 940 941 942 943 944 945 946 947 948 949 950 951 952
struct cifs_readdata;

/* asynchronous read support */
struct cifs_readdata {
	struct kref			refcount;
	struct list_head		list;
	struct completion		done;
	struct cifsFileInfo		*cfile;
	struct address_space		*mapping;
	__u64				offset;
	unsigned int			bytes;
	pid_t				pid;
	int				result;
	struct work_struct		work;
953 954 955
	int (*read_into_pages)(struct TCP_Server_Info *server,
				struct cifs_readdata *rdata,
				unsigned int len);
956
	struct kvec			iov;
957 958
	unsigned int			pagesz;
	unsigned int			tailsz;
959 960
	unsigned int			nr_pages;
	struct page			*pages[];
961 962
};

963 964 965 966 967 968 969 970 971 972 973 974 975 976
struct cifs_writedata;

/* asynchronous write support */
struct cifs_writedata {
	struct kref			refcount;
	struct list_head		list;
	struct completion		done;
	enum writeback_sync_modes	sync_mode;
	struct work_struct		work;
	struct cifsFileInfo		*cfile;
	__u64				offset;
	pid_t				pid;
	unsigned int			bytes;
	int				result;
977 978
	unsigned int			pagesz;
	unsigned int			tailsz;
979 980 981 982
	unsigned int			nr_pages;
	struct page			*pages[1];
};

983 984 985 986
/*
 * Take a reference on the file private data. Must be called with
 * cifs_file_list_lock held.
 */
987 988
static inline void
cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
989
{
990
	++cifs_file->count;
991 992
}

993
struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
994
void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
995

L
Linus Torvalds 已提交
996 997 998 999 1000
/*
 * One of these for each file inode
 */

struct cifsInodeInfo {
1001
	bool can_cache_brlcks;
1002
	struct list_head llist;	/* locks helb by this inode */
1003
	struct rw_semaphore lock_sem;	/* protect the fields above */
S
Steve French 已提交
1004
	/* BB add in lists for dirty pages i.e. write caching info for oplock */
L
Linus Torvalds 已提交
1005 1006
	struct list_head openFileList;
	__u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1007 1008 1009 1010 1011
	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 */
1012
	u64  server_eof;		/* current file size on server -- protected by i_lock */
1013
	u64  uniqueid;			/* server inode number */
1014
	u64  createtime;		/* creation time on server */
1015 1016 1017
#ifdef CONFIG_CIFS_FSCACHE
	struct fscache_cookie *fscache;
#endif
L
Linus Torvalds 已提交
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
	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 已提交
1033
static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1034 1035 1036 1037 1038 1039
{
	if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
		return '/';
	else
		return '\\';
}
L
Linus Torvalds 已提交
1040

1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
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;
	}
}

1061 1062 1063 1064 1065 1066 1067 1068 1069
static inline char *
build_path_to_root(struct smb_vol *vol, struct cifs_sb_info *cifs_sb,
		   struct cifs_tcon *tcon)
{
	if (!vol->ops->build_path_to_root)
		return NULL;
	return vol->ops->build_path_to_root(vol, cifs_sb, tcon);
}

1070 1071 1072
#ifdef CONFIG_CIFS_STATS
#define cifs_stats_inc atomic_inc

1073
static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1074 1075 1076 1077 1078 1079 1080 1081 1082
					    unsigned int bytes)
{
	if (bytes) {
		spin_lock(&tcon->stat_lock);
		tcon->bytes_written += bytes;
		spin_unlock(&tcon->stat_lock);
	}
}

1083
static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1084 1085 1086 1087 1088 1089 1090 1091
					 unsigned int bytes)
{
	spin_lock(&tcon->stat_lock);
	tcon->bytes_read += bytes;
	spin_unlock(&tcon->stat_lock);
}
#else

S
Steve French 已提交
1092 1093 1094
#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)
1095 1096 1097

#endif

1098 1099

/*
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
 * 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:
1118
 *
1119 1120
 * - it will be called by cifsd, with no locks held
 * - the mid will be removed from any lists
1121 1122 1123
 */
typedef void (mid_callback_t)(struct mid_q_entry *mid);

L
Linus Torvalds 已提交
1124 1125 1126
/* 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 */
1127
	struct TCP_Server_Info *server;	/* server corresponding to this mid */
1128 1129
	__u64 mid;		/* multiplex id */
	__u32 pid;		/* process id */
L
Linus Torvalds 已提交
1130
	__u32 sequence_number;  /* for CIFS signing */
S
Steve French 已提交
1131 1132 1133 1134 1135
	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
1136
	mid_receive_t *receive; /* call receive callback */
1137 1138
	mid_callback_t *callback; /* call completion callback */
	void *callback_data;	  /* general purpose pointer for callback */
1139
	void *resp_buf;		/* pointer to received SMB header */
1140 1141 1142
	int mid_state;	/* wish this were enum but can not pass to wait_event */
	__le16 command;		/* smb command code */
	bool large_buf:1;	/* if valid response, is pointer to large buf */
1143 1144
	bool multiRsp:1;	/* multiple trans2 responses for one request  */
	bool multiEnd:1;	/* both received */
L
Linus Torvalds 已提交
1145 1146
};

1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
/*	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 已提交
1195

1196 1197
/* for pending dnotify requests */
struct dir_notify_req {
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
	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;
1208 1209
};

S
Steve French 已提交
1210 1211
struct dfs_info3_param {
	int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1212
	int path_consumed;
S
Steve French 已提交
1213 1214 1215 1216 1217 1218
	int server_type;
	int ref_flag;
	char *path_name;
	char *node_name;
};

1219 1220 1221 1222 1223 1224
/*
 * common struct for holding inode info when searching for or updating an
 * inode with new info
 */

#define CIFS_FATTR_DFS_REFERRAL		0x1
1225 1226
#define CIFS_FATTR_DELETE_PENDING	0x2
#define CIFS_FATTR_NEED_REVAL		0x4
1227
#define CIFS_FATTR_INO_COLLISION	0x8
1228 1229 1230 1231 1232 1233 1234

struct cifs_fattr {
	u32		cf_flags;
	u32		cf_cifsattrs;
	u64		cf_uniqueid;
	u64		cf_eof;
	u64		cf_bytes;
1235
	u64		cf_createtime;
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
	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 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
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 已提交
1269 1270 1271 1272 1273
#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 */
1274
#define   MID_RESPONSE_MALFORMED 0x10
1275
#define   MID_SHUTDOWN		 0x20
1276 1277 1278 1279 1280 1281

/* 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 已提交
1282

1283
/* Type of Request to SendReceive2 */
1284 1285 1286
#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 */
1287 1288 1289 1290
#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 */

1291 1292 1293
/* Type of request operation */
#define   CIFS_ECHO_OP      0x080    /* echo request */
#define   CIFS_OBREAK_OP   0x0100    /* oplock break request */
1294 1295
#define   CIFS_NEG_OP      0x0200    /* negotiate request */
#define   CIFS_OP_MASK     0x0380    /* mask request type */
1296

1297 1298 1299 1300 1301 1302 1303 1304
/* 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
1305 1306 1307
#else
#define   CIFSSEC_MAY_LANMAN    0
#define   CIFSSEC_MAY_PLNTXT    0
1308 1309
#endif /* weak passwords */
#define   CIFSSEC_MAY_SEAL	0x00040 /* not supported yet */
1310
#define   CIFSSEC_MAY_NTLMSSP	0x00080 /* raw ntlmssp with ntlmv2 */
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321

#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
1322
#ifdef CONFIG_CIFS_UPCALL
C
Chuck Ebbert 已提交
1323
#define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
1324
#else
C
Chuck Ebbert 已提交
1325
#define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
1326
#endif /* UPCALL */
1327
#else /* do not allow weak pw hash */
1328 1329
#define   CIFSSEC_MUST_LANMAN	0
#define   CIFSSEC_MUST_PLNTXT	0
1330
#ifdef CONFIG_CIFS_UPCALL
1331
#define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
S
Steve French 已提交
1332
#else
1333
#define	  CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1334
#endif /* UPCALL */
1335 1336
#endif /* WEAK_PW_HASH */
#define   CIFSSEC_MUST_SEAL	0x40040 /* not supported yet */
1337
#define   CIFSSEC_MUST_NTLMSSP	0x80080 /* raw ntlmssp with ntlmv2 */
1338

1339
#define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1340
#define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1341
#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 已提交
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
/*
 *****************************************************************
 * 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
1364
 *  cifs_file_list_lock protects:
L
Linus Torvalds 已提交
1365 1366 1367 1368 1369 1370 1371 1372
 *	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 已提交
1373
 *  fh_sem      file handle reconnection operations
L
Linus Torvalds 已提交
1374 1375 1376 1377 1378 1379 1380 1381 1382
 *
 ****************************************************************************/

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

1383 1384
/*
 * the list of TCP_Server_Info structures, ie each of the sockets
1385
 * connecting our client to a distinct server (ip address), is
1386
 * chained together by cifs_tcp_ses_list. The list of all our SMB
1387
 * sessions (and from that the tree connections) can be found
1388 1389 1390 1391
 * by iterating over cifs_tcp_ses_list
 */
GLOBAL_EXTERN struct list_head		cifs_tcp_ses_list;

1392 1393 1394 1395 1396 1397
/*
 * 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.
 */
1398
GLOBAL_EXTERN spinlock_t		cifs_tcp_ses_lock;
1399 1400 1401 1402 1403 1404 1405 1406

/*
 * 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.
 */
1407
GLOBAL_EXTERN spinlock_t	cifs_file_list_lock;
L
Linus Torvalds 已提交
1408

1409
#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1410 1411 1412 1413
/* Outstanding dir notify requests */
GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
/* DirNotify response queue */
GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1414
#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1415

L
Linus Torvalds 已提交
1416 1417 1418 1419
/*
 * Global transaction id (XID) information
 */
GLOBAL_EXTERN unsigned int GlobalCurrentXid;	/* protected by GlobalMid_Sem */
1420
GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
L
Linus Torvalds 已提交
1421
GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;	/* prot by GlobalMid_Sem */
1422 1423
GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
					  /* on midQ entries */
L
Linus Torvalds 已提交
1424 1425 1426 1427 1428 1429 1430 1431 1432
/*
 *  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 已提交
1433
/* Various Debug counters */
1434 1435 1436 1437 1438 1439
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 已提交
1440 1441 1442
GLOBAL_EXTERN atomic_t midCount;

/* Misc globals */
1443
GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
L
Linus Torvalds 已提交
1444
GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1445
GLOBAL_EXTERN unsigned int global_secflags;	/* if on, session setup sent
L
Linus Torvalds 已提交
1446 1447 1448 1449 1450 1451 1452 1453
				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*/

1454
#ifdef CONFIG_CIFS_ACL
1455 1456 1457 1458
GLOBAL_EXTERN struct rb_root uidtree;
GLOBAL_EXTERN struct rb_root gidtree;
GLOBAL_EXTERN spinlock_t siduidlock;
GLOBAL_EXTERN spinlock_t sidgidlock;
1459 1460 1461 1462 1463
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 */
1464

1465
void cifs_oplock_break(struct work_struct *work);
1466

1467
extern const struct slow_work_ops cifs_oplock_break_ops;
J
Jeff Layton 已提交
1468
extern struct workqueue_struct *cifsiod_wq;
1469

1470 1471
extern mempool_t *cifs_mid_poolp;

1472 1473 1474 1475
/* Operations for different SMB versions */
#define SMB1_VERSION_STRING	"1.0"
extern struct smb_version_operations smb1_operations;
extern struct smb_version_values smb1_values;
1476 1477 1478
#define SMB21_VERSION_STRING	"2.1"
extern struct smb_version_operations smb21_operations;
extern struct smb_version_values smb21_values;
1479
#endif	/* _CIFS_GLOB_H */