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