]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - fs/cifs/cifsglob.h
CIFS: keep FileInfo handle live during oplock break
[thirdparty/kernel/linux.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>
8c3a2b4c 31#include <uapi/linux/cifs/cifs_mount.h>
d60622eb 32#include "smb2pdu.h"
d2b91521 33
76ec5e33
PS
34#define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */
35
8d8b26e5 36#define SMB_PATH_MAX 260
e2292430
AA
37#define CIFS_PORT 445
38#define RFC1001_PORT 139
39
1da177e4
LT
40/*
41 * The sizes of various internal tables and strings
42 */
43#define MAX_UID_INFO 16
44#define MAX_SES_INFO 2
45#define MAX_TCON_INFO 4
46
cdf1246f 47#define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
1da177e4
LT
48
49#define CIFS_MIN_RCV_POOL 4
50
2c0c2a08 51#define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
6d20e840
SJ
52/*
53 * default attribute cache timeout (jiffies)
54 */
55#define CIFS_DEF_ACTIMEO (1 * HZ)
56
57/*
58 * max attribute cache timeout (jiffies) - 2^30
59 */
60#define CIFS_MAX_ACTIMEO (1 << 30)
61
ca567eb2
SF
62/*
63 * Max persistent and resilient handle timeout (milliseconds).
64 * Windows durable max was 960000 (16 minutes)
65 */
66#define SMB3_MAX_HANDLE_TIMEOUT 960000
67
1da177e4
LT
68/*
69 * MAX_REQ is the maximum number of requests that WE will send
10b9b98e 70 * on one socket concurrently.
1da177e4 71 */
10b9b98e 72#define CIFS_MAX_REQ 32767
1da177e4 73
8ecaf67a
JL
74#define RFC1001_NAME_LEN 15
75#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
76
b327a717
AA
77/* maximum length of ip addr as a string (including ipv6 and sctp) */
78#define SERVER_NAME_LENGTH 80
1da177e4
LT
79#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
80
adfeb3e0
SF
81/* echo interval in seconds */
82#define SMB_ECHO_INTERVAL_MIN 1
83#define SMB_ECHO_INTERVAL_MAX 600
84#define SMB_ECHO_INTERVAL_DEFAULT 60
9094fad1 85
b24df3e3
RS
86/* maximum number of PDUs in one compound */
87#define MAX_COMPOUND 5
88
141891f4
SF
89/*
90 * Default number of credits to keep available for SMB3.
91 * This value is chosen somewhat arbitrarily. The Windows client
92 * defaults to 128 credits, the Windows server allows clients up to
93 * 512 credits (or 8K for later versions), and the NetApp server
94 * does not limit clients at all. Choose a high enough default value
95 * such that the client shouldn't limit performance, but allow mount
96 * to override (until you approach 64K, where we limit credits to 65000
97 * to reduce possibility of seeing more server credit overflow bugs.
98 */
99#define SMB2_MAX_CREDITS_AVAILABLE 32000
100
1da177e4
LT
101#include "cifspdu.h"
102
1da177e4
LT
103#ifndef XATTR_DOS_ATTRIB
104#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
105#endif
106
1da177e4
LT
107/*
108 * CIFS vfs client Status information (based on what we know.)
109 */
110
6c0f6218 111/* associated with each tcp and smb session */
1da177e4
LT
112enum statusEnum {
113 CifsNew = 0,
114 CifsGood,
115 CifsExiting,
fd88ce93
SF
116 CifsNeedReconnect,
117 CifsNeedNegotiate
1da177e4
LT
118};
119
120enum securityEnum {
515d82ff
JL
121 Unspecified = 0, /* not specified */
122 LANMAN, /* Legacy LANMAN auth */
3979877e 123 NTLM, /* Legacy NTLM012 auth with NTLM hash */
1da177e4 124 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
ac683924 125 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
c16fefa5 126 Kerberos, /* Kerberos via SPNEGO */
1da177e4
LT
127};
128
5f98ca9a 129struct session_key {
b609f06a 130 unsigned int len;
21e73393 131 char *response;
b609f06a
SF
132};
133
d2b91521
SP
134/* crypto security descriptor definition */
135struct sdesc {
136 struct shash_desc shash;
137 char ctx[];
138};
139
f7c5445a 140/* crypto hashing related structure/fields, not specific to a sec mech */
d2b91521
SP
141struct cifs_secmech {
142 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
143 struct crypto_shash *md5; /* md5 hash function */
3c1bf7e4 144 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
429b46f4 145 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
5fcd7f3f 146 struct crypto_shash *sha512; /* sha512 hash function */
d2b91521
SP
147 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
148 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
3c1bf7e4 149 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
429b46f4 150 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
5fcd7f3f 151 struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */
026e93dc
PS
152 struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */
153 struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */
d2b91521
SP
154};
155
d3686d54 156/* per smb session structure/fields */
d2b91521 157struct ntlmssp_auth {
5c234aa5 158 bool sesskey_per_smbsess; /* whether session key is per smb session */
d2b91521
SP
159 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
160 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
161 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
d3686d54 162 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
d2b91521
SP
163};
164
442aa310
SF
165struct cifs_cred {
166 int uid;
167 int gid;
168 int mode;
169 int cecount;
170 struct cifs_sid osid;
171 struct cifs_sid gsid;
172 struct cifs_ntace *ntaces;
173 struct cifs_ace *aces;
174};
175
1da177e4
LT
176/*
177 *****************************************************************
178 * Except the CIFS PDUs themselves all the
179 * globally interesting structs should go here
180 *****************************************************************
181 */
182
bf5ea0e2
JL
183/*
184 * A smb_rqst represents a complete request to be issued to a server. It's
185 * formed by a kvec array, followed by an array of pages. Page data is assumed
186 * to start at the beginning of the first page.
187 */
188struct smb_rqst {
189 struct kvec *rq_iov; /* array of kvecs */
190 unsigned int rq_nvec; /* number of kvecs in array */
191 struct page **rq_pages; /* pointer to array of page ptrs */
57a929a6 192 unsigned int rq_offset; /* the offset to the 1st page */
bf5ea0e2
JL
193 unsigned int rq_npages; /* number pages in array */
194 unsigned int rq_pagesz; /* page size to use */
195 unsigned int rq_tailsz; /* length of last page */
196};
197
23db65f5
JL
198enum smb_version {
199 Smb_1 = 1,
dd446b16 200 Smb_20,
1080ef75 201 Smb_21,
e4aa25e7 202 Smb_30,
20b6d8b4 203 Smb_302,
5f7fbf73 204 Smb_311,
9764c02f
SF
205 Smb_3any,
206 Smb_default,
5f7fbf73 207 Smb_version_err
23db65f5
JL
208};
209
121b046a
JL
210struct mid_q_entry;
211struct TCP_Server_Info;
55157dfb 212struct cifsFileInfo;
082d0642 213struct cifs_ses;
2e6e02ab 214struct cifs_tcon;
b669f33c 215struct dfs_info3_param;
1208ef1f 216struct cifs_fattr;
9224dfc2 217struct smb_vol;
fb1214e4 218struct cifs_fid;
fc9c5966 219struct cifs_readdata;
c9de5c80 220struct cifs_writedata;
f9c6e234 221struct cifs_io_parms;
92fc65a7 222struct cifs_search_info;
95a3f2f3 223struct cifsInodeInfo;
226730b4 224struct cifs_open_parms;
335b7b62 225struct cifs_credits;
121b046a 226
23db65f5 227struct smb_version_operations {
fb2036d8 228 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
121b046a 229 struct mid_q_entry *);
55157dfb 230 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
082d0642 231 /* setup request: allocate mid, sign message */
fec344e3
JL
232 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
233 struct smb_rqst *);
45740847 234 /* setup async request: allocate mid, sign message */
fec344e3
JL
235 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
236 struct smb_rqst *);
082d0642
PS
237 /* check response: verify signature, map error */
238 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
239 bool);
335b7b62
PS
240 void (*add_credits)(struct TCP_Server_Info *server,
241 const struct cifs_credits *credits,
242 const int optype);
45275789 243 void (*set_credits)(struct TCP_Server_Info *, const int);
a891f0f8
PS
244 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
245 unsigned int (*get_credits)(struct mid_q_entry *);
88257360 246 __u64 (*get_next_mid)(struct TCP_Server_Info *);
c781af7e
PS
247 void (*revert_current_mid)(struct TCP_Server_Info *server,
248 const unsigned int val);
eb378711
PS
249 /* data offset from read response message */
250 unsigned int (*read_data_offset)(char *);
74dcf418
LL
251 /*
252 * Data length from read response message
253 * When in_remaining is true, the returned data length is in
254 * message field DataRemaining for out-of-band data read (e.g through
255 * Memory Registration RDMA write in SMBD).
256 * Otherwise, the returned data length is in message field DataLength.
257 */
258 unsigned int (*read_data_length)(char *, bool in_remaining);
eb378711
PS
259 /* map smb to linux error */
260 int (*map_error)(char *, bool);
8aa26f3e
PS
261 /* find mid corresponding to the response message */
262 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
14547f7d 263 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
44c58186
PS
264 void (*clear_stats)(struct cifs_tcon *);
265 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
769ee6a4 266 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
8aa26f3e 267 /* verify the message */
373512ec 268 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
8aa26f3e 269 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
38bd4906 270 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
c11f1df5
SP
271 void (*downgrade_oplock)(struct TCP_Server_Info *,
272 struct cifsInodeInfo *, bool);
316cf94a
PS
273 /* process transaction2 response */
274 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
275 char *, int);
286170aa
PS
276 /* check if we need to negotiate */
277 bool (*need_neg)(struct TCP_Server_Info *);
278 /* negotiate to the server */
279 int (*negotiate)(const unsigned int, struct cifs_ses *);
24985c53
PS
280 /* set negotiated write size */
281 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
282 /* set negotiated read size */
283 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
58c45c58
PS
284 /* setup smb sessionn */
285 int (*sess_setup)(const unsigned int, struct cifs_ses *,
286 const struct nls_table *);
287 /* close smb session */
288 int (*logoff)(const unsigned int, struct cifs_ses *);
2e6e02ab
PS
289 /* connect to a server share */
290 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
291 struct cifs_tcon *, const struct nls_table *);
292 /* close tree connecion */
293 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
b669f33c
PS
294 /* get DFS referrals */
295 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
296 const char *, struct dfs_info3_param **,
297 unsigned int *, const struct nls_table *, int);
af4281dc
PS
298 /* informational QFS call */
299 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
68889f26
PS
300 /* check if a path is accessible or not */
301 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
302 struct cifs_sb_info *, const char *);
1208ef1f
PS
303 /* query path data from the server */
304 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
305 struct cifs_sb_info *, const char *,
eb85d94b 306 FILE_ALL_INFO *, bool *, bool *);
4ad65044
PS
307 /* query file data from the server */
308 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
309 struct cifs_fid *, FILE_ALL_INFO *);
1208ef1f
PS
310 /* get server index number */
311 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
312 struct cifs_sb_info *, const char *,
313 u64 *uniqueid, FILE_ALL_INFO *);
d1433418
PS
314 /* set size by path */
315 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
316 const char *, __u64, struct cifs_sb_info *, bool);
317 /* set size by file handle */
318 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
319 struct cifsFileInfo *, __u64, bool);
6bdf6dbd
PS
320 /* set attributes */
321 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
322 const unsigned int);
64a5cfa6
SF
323 int (*set_compression)(const unsigned int, struct cifs_tcon *,
324 struct cifsFileInfo *);
f6d76178
PS
325 /* check if we can send an echo or nor */
326 bool (*can_echo)(struct TCP_Server_Info *);
327 /* send echo request */
328 int (*echo)(struct TCP_Server_Info *);
f436720e 329 /* create directory */
bea851b8
SF
330 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
331 umode_t mode, struct cifs_tcon *tcon,
332 const char *full_path,
333 struct cifs_sb_info *cifs_sb);
f436720e
PS
334 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
335 struct cifs_sb_info *);
336 /* set info on created directory */
337 void (*mkdir_setinfo)(struct inode *, const char *,
338 struct cifs_sb_info *, struct cifs_tcon *,
339 const unsigned int);
f958ca5d
PS
340 /* remove directory */
341 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
342 struct cifs_sb_info *);
ed6875e0
PS
343 /* unlink file */
344 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
345 struct cifs_sb_info *);
346 /* open, rename and delete file */
347 int (*rename_pending_delete)(const char *, struct dentry *,
348 const unsigned int);
8ceb9843
PS
349 /* send rename request */
350 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
351 const char *, struct cifs_sb_info *);
d6e906f1
SF
352 /* send create hardlink request */
353 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
354 const char *, const char *,
355 struct cifs_sb_info *);
b42bf888
PS
356 /* query symlink target */
357 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
358 const char *, char **, struct cifs_sb_info *);
fb1214e4 359 /* open a file for non-posix mounts */
226730b4
PS
360 int (*open)(const unsigned int, struct cifs_open_parms *,
361 __u32 *, FILE_ALL_INFO *);
fb1214e4
PS
362 /* set fid protocol-specific info */
363 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
0ff78a22 364 /* close a file */
760ad0ca
PS
365 void (*close)(const unsigned int, struct cifs_tcon *,
366 struct cifs_fid *);
1d8c4c00
PS
367 /* send a flush request to the server */
368 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
fc9c5966
PS
369 /* async read from the server */
370 int (*async_readv)(struct cifs_readdata *);
c9de5c80 371 /* async write to the server */
4a5c80d7
SF
372 int (*async_writev)(struct cifs_writedata *,
373 void (*release)(struct kref *));
f9c6e234 374 /* sync read from the server */
db8b631d 375 int (*sync_read)(const unsigned int, struct cifs_fid *,
f9c6e234
PS
376 struct cifs_io_parms *, unsigned int *, char **,
377 int *);
ba9ad725 378 /* sync write to the server */
db8b631d 379 int (*sync_write)(const unsigned int, struct cifs_fid *,
ba9ad725
PS
380 struct cifs_io_parms *, unsigned int *, struct kvec *,
381 unsigned long);
92fc65a7
PS
382 /* open dir, start readdir */
383 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
384 const char *, struct cifs_sb_info *,
385 struct cifs_fid *, __u16,
386 struct cifs_search_info *);
387 /* continue readdir */
388 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
389 struct cifs_fid *,
390 __u16, struct cifs_search_info *srch_inf);
391 /* close dir */
392 int (*close_dir)(const unsigned int, struct cifs_tcon *,
393 struct cifs_fid *);
394 /* calculate a size of SMB message */
9ec672bd 395 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
66265f13
PS
396 /* check for STATUS_PENDING and process the response if yes */
397 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
511c54a2
PS
398 /* check for STATUS_NETWORK_SESSION_EXPIRED */
399 bool (*is_session_expired)(char *);
95a3f2f3
PS
400 /* send oplock break response */
401 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
402 struct cifsInodeInfo *);
76ec5e33
PS
403 /* query remote filesystem */
404 int (*queryfs)(const unsigned int, struct cifs_tcon *,
405 struct kstatfs *);
d39a4f71
PS
406 /* send mandatory brlock to the server */
407 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
408 __u64, __u32, int, int, bool);
409 /* unlock range of mandatory locks */
410 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
411 const unsigned int);
412 /* push brlocks from the cache to the server */
413 int (*push_mand_locks)(struct cifsFileInfo *);
b8c32dbb 414 /* get lease key of the inode */
a41a28bd 415 void (*get_lease_key)(struct inode *, struct cifs_fid *);
b8c32dbb 416 /* set lease key of the inode */
a41a28bd 417 void (*set_lease_key)(struct inode *, struct cifs_fid *);
b8c32dbb 418 /* generate new lease key */
a41a28bd 419 void (*new_lease_key)(struct cifs_fid *);
32811d24 420 int (*generate_signingkey)(struct cifs_ses *);
53ef1016 421 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
b3152e2c
SF
422 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
423 struct cifsFileInfo *src_file);
834170c8
SF
424 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
425 struct cifsFileInfo *src_file, void __user *);
b5be1a1c
SP
426 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
427 struct cifs_sb_info *, const unsigned char *,
428 char *, unsigned int *);
cbb0aba6
SP
429 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
430 struct cifs_sb_info *, const unsigned char *,
431 char *, unsigned int *);
53ef1016
PS
432 /* if we can do cache read operations */
433 bool (*is_read_op)(__u32);
434 /* set oplock level for the inode */
42873b0a
PS
435 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
436 bool *);
a41a28bd 437 /* create lease context buffer for CREATE request */
729c0c9d 438 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
42873b0a 439 /* parse lease context buffer and return oplock/epoch info */
96164ab2 440 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
620d8745 441 ssize_t (*copychunk_range)(const unsigned int,
312bbc59 442 struct cifsFileInfo *src_file,
620d8745
SP
443 struct cifsFileInfo *target_file,
444 u64 src_off, u64 len, u64 dest_off);
02b16665
SF
445 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
446 struct cifsFileInfo *target_file, u64 src_off, u64 len,
447 u64 dest_off);
ff1c038a 448 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
666753c3
SF
449 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
450 const unsigned char *, const unsigned char *, char *,
67b4c889 451 size_t, struct cifs_sb_info *);
666753c3
SF
452 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
453 const char *, const void *, const __u16,
5517554e 454 const struct nls_table *, struct cifs_sb_info *);
83e3bc23
SF
455 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
456 const char *, u32 *);
42eacf9e
SF
457 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
458 const struct cifs_fid *, u32 *);
83e3bc23
SF
459 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
460 int);
7f6c5008
PS
461 /* writepages retry size */
462 unsigned int (*wp_retry_size)(struct inode *);
cb7e9eab
PS
463 /* get mtu credits */
464 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
335b7b62 465 unsigned int *, struct cifs_credits *);
9a1c67e8
PS
466 /* adjust previously taken mtu credits to request size */
467 int (*adjust_credits)(struct TCP_Server_Info *server,
468 struct cifs_credits *credits,
469 const unsigned int payload_size);
52755808
PS
470 /* check if we need to issue closedir */
471 bool (*dir_needs_close)(struct cifsFileInfo *);
31742c5a
SF
472 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
473 loff_t);
7fb8986e 474 /* init transform request - used for encryption for now */
b2c96de7
RS
475 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
476 struct smb_rqst *, struct smb_rqst *);
9bb17e09
PS
477 int (*is_transform_hdr)(void *buf);
478 int (*receive_transform)(struct TCP_Server_Info *,
b24df3e3 479 struct mid_q_entry **, char **, int *);
ef65aaed
SP
480 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
481 enum securityEnum);
8ce79ec3 482 int (*next_header)(char *);
f5b05d62
RS
483 /* ioctl passthrough for query_info */
484 int (*ioctl_query_info)(const unsigned int xid,
8d8b26e5
RS
485 struct cifs_tcon *tcon,
486 __le16 *path, int is_dir,
f5b05d62 487 unsigned long p);
c847dccf
AA
488 /* make unix special files (block, char, fifo, socket) */
489 int (*make_node)(unsigned int xid,
490 struct inode *inode,
491 struct dentry *dentry,
492 struct cifs_tcon *tcon,
493 char *full_path,
494 umode_t mode,
495 dev_t device_number);
23db65f5
JL
496};
497
498struct smb_version_values {
499 char *version_string;
e4aa25e7
SF
500 __u16 protocol_id;
501 __u32 req_capabilities;
106dc538
PS
502 __u32 large_lock_type;
503 __u32 exclusive_lock_type;
504 __u32 shared_lock_type;
505 __u32 unlock_lock_type;
93012bf9 506 size_t header_preamble_size;
1887f601
PS
507 size_t header_size;
508 size_t max_header_size;
eb378711 509 size_t read_rsp_size;
2dc7e1c0 510 __le16 lock_cmd;
29e20f9c
PS
511 unsigned int cap_unix;
512 unsigned int cap_nt_find;
513 unsigned int cap_large_files;
50285882
JL
514 __u16 signing_enabled;
515 __u16 signing_required;
a41a28bd 516 size_t create_lease_size;
23db65f5
JL
517};
518
1887f601
PS
519#define HEADER_SIZE(server) (server->vals->header_size)
520#define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
521
f87d39d9
SF
522struct smb_vol {
523 char *username;
524 char *password;
525 char *domainname;
526 char *UNC;
f87d39d9
SF
527 char *iocharset; /* local code page for mapping to and from Unicode */
528 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
529 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
3da46565
EB
530 kuid_t cred_uid;
531 kuid_t linux_uid;
532 kgid_t linux_gid;
533 kuid_t backupuid;
534 kgid_t backupgid;
5206efd6
AV
535 umode_t file_mode;
536 umode_t dir_mode;
1e3cc57e
JL
537 enum securityEnum sectype; /* sectype requested via mnt opts */
538 bool sign; /* was signing requested via mnt opts? */
f87d39d9
SF
539 bool retry:1;
540 bool intr:1;
541 bool setuids:1;
95932655 542 bool setuidfromacl:1;
f87d39d9
SF
543 bool override_uid:1;
544 bool override_gid:1;
545 bool dynperm:1;
546 bool noperm:1;
547 bool no_psx_acl:1; /* set if posix acl support should be disabled */
548 bool cifs_acl:1;
3d3ea8e6
SP
549 bool backupuid_specified; /* mount option backupuid is specified */
550 bool backupgid_specified; /* mount option backupgid is specified */
f87d39d9
SF
551 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
552 bool server_ino:1; /* use inode numbers from server ie UniqueId */
553 bool direct_io:1;
554 bool strict_io:1; /* strict cache behavior */
555 bool remap:1; /* set to remap seven reserved chars in filenames */
2baa2682 556 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
f87d39d9
SF
557 bool posix_paths:1; /* unset to not ask for posix pathnames. */
558 bool no_linux_ext:1;
b326614e 559 bool linux_ext:1;
f87d39d9
SF
560 bool sfu_emul:1;
561 bool nullauth:1; /* attempt to authenticate with null user */
562 bool nocase:1; /* request case insensitive filenames */
563 bool nobrl:1; /* disable sending byte range locks to srv */
3d4ef9a1 564 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
f87d39d9
SF
565 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
566 bool seal:1; /* request transport encryption on share */
567 bool nodfs:1; /* Do not request DFS, even if available */
568 bool local_lease:1; /* check leases only on local system, not remote */
569 bool noblocksnd:1;
570 bool noautotune:1;
571 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
572 bool fsc:1; /* enable fscache */
573 bool mfsymlinks:1; /* use Minshall+French Symlinks */
574 bool multiuser:1;
d4ffff1f 575 bool rwpidforward:1; /* pid forward for read/write operations */
b2a30774
SF
576 bool nosharesock:1;
577 bool persistent:1;
578 bool nopersistent:1;
592fafe6 579 bool resilient:1; /* noresilient not required since not fored for CA */
39566443 580 bool domainauto:1;
8339dd32 581 bool rdma:1;
e8506d25 582 unsigned int bsize;
f87d39d9
SF
583 unsigned int rsize;
584 unsigned int wsize;
585 bool sockopt_tcp_nodelay:1;
f87d39d9 586 unsigned long actimeo; /* attribute cache timeout (jiffies) */
23db65f5
JL
587 struct smb_version_operations *ops;
588 struct smb_version_values *vals;
f87d39d9 589 char *prepath;
b979aaa1 590 struct sockaddr_storage dstaddr; /* destination address */
f87d39d9
SF
591 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
592 struct nls_table *local_nls;
adfeb3e0 593 unsigned int echo_interval; /* echo interval in secs */
8b217fe7 594 __u64 snapshot_time; /* needed for timewarp tokens */
ca567eb2 595 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
141891f4 596 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
f87d39d9
SF
597};
598
25c7f41e
PS
599#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
600 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
601 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
2baa2682 602 CIFS_MOUNT_MAP_SFM_CHR | \
25c7f41e
PS
603 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
604 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
605 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
606 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
607 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
3d3ea8e6
SP
608 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
609 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
25c7f41e 610
1751e8a6
LT
611#define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
612 SB_NODEV | SB_SYNCHRONOUS)
25c7f41e
PS
613
614struct cifs_mnt_data {
615 struct cifs_sb_info *cifs_sb;
616 struct smb_vol *vol;
617 int flags;
618};
619
792af7b0
PS
620static inline unsigned int
621get_rfc1002_length(void *buf)
622{
dca1c8d1 623 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
792af7b0
PS
624}
625
ec2e4523
PS
626static inline void
627inc_rfc1001_len(void *buf, int count)
628{
629 be32_add_cpu((__be32 *)buf, count);
630}
631
1da177e4 632struct TCP_Server_Info {
3b795210
SF
633 struct list_head tcp_ses_list;
634 struct list_head smb_ses_list;
e7ddee90 635 int srv_count; /* reference counter */
a10faeb2 636 /* 15 character server name + 0x20 16th byte indicating type = srv */
8ecaf67a 637 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
23db65f5
JL
638 struct smb_version_operations *ops;
639 struct smb_version_values *vals;
c3dccf48 640 enum statusEnum tcpStatus; /* what we think the status is */
c359cf3c 641 char *hostname; /* hostname portion of UNC string */
1da177e4 642 struct socket *ssocket;
a9f1b85e 643 struct sockaddr_storage dstaddr;
3eb9a889 644 struct sockaddr_storage srcaddr; /* locally bind to this IP */
f1d0c998
RL
645#ifdef CONFIG_NET_NS
646 struct net *net;
647#endif
d38d8c74 648 wait_queue_head_t response_q;
1da177e4
LT
649 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
650 struct list_head pending_mid_q;
edf1ae40
SF
651 bool noblocksnd; /* use blocking sendmsg */
652 bool noautotune; /* do not autotune send buf sizes */
6a5fa236 653 bool tcp_nodelay;
141891f4
SF
654 unsigned int credits; /* send no more requests at once */
655 unsigned int max_credits; /* can override large 32000 default at mnt */
fc40f9cf 656 unsigned int in_flight; /* number of requests on the wire to server */
2d86dbc9 657 spinlock_t req_lock; /* protect the two values above */
72ca545b 658 struct mutex srv_mutex;
1da177e4
LT
659 struct task_struct *tsk;
660 char server_GUID[16];
286170aa 661 __u16 sec_mode;
38d77c50 662 bool sign; /* is signing enabled on this connection? */
c3dccf48 663 bool session_estab; /* mark when very first sess is established */
28ea5290
PS
664 int echo_credits; /* echo reserved slots */
665 int oplock_credits; /* oplock break reserved slots */
666 bool echoes:1; /* enable echoes */
39552ea8 667 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
c3dccf48 668 u16 dialect; /* dialect index that server chose */
10b9b98e 669 bool oplocks:1; /* enable oplocks */
1da177e4
LT
670 unsigned int maxReq; /* Clients should submit no more */
671 /* than maxReq distinct unanswered SMBs to the server when using */
11911b95 672 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
1da177e4
LT
673 unsigned int maxBuf; /* maxBuf specifies the maximum */
674 /* message size the server can send or receive for non-raw SMBs */
7e90d705
SF
675 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
676 /* when socket is setup (and during reconnect) before NegProt sent */
eca6acf9 677 unsigned int max_rw; /* maxRw specifies the maximum */
1da177e4
LT
678 /* message size the server can send or receive for */
679 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
29e20f9c 680 unsigned int capabilities; /* selective disabling of caps by smb sess */
de7ed55d 681 int timeAdj; /* Adjust for difference in server time zone in sec */
243d04b6 682 __u64 CurrentMid; /* multiplex id - rotating counter */
d3ba50b1 683 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
a10faeb2 684 /* 16th byte of RFC1001 workstation name is always null */
8ecaf67a 685 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
a0f8b4fb 686 __u32 sequence_number; /* for signing, protected by srv_mutex */
9e1a37da 687 __u32 reconnect_instance; /* incremented on each reconnect */
5f98ca9a 688 struct session_key session_key;
3a5ff61c 689 unsigned long lstrp; /* when we got last response from this server */
d2b91521 690 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
e598d1d8
JL
691#define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
692#define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
693#define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
694 char negflavor; /* NEGOTIATE response flavor */
26efa0ba 695 /* extended security flavors that server supports */
c3dccf48
JL
696 bool sec_ntlmssp; /* supports NTLMSSP */
697 bool sec_kerberosu2u; /* supports U2U Kerberos */
26efa0ba
JL
698 bool sec_kerberos; /* supports plain Kerberos */
699 bool sec_mskerberos; /* supports legacy MS Kerberos */
2a37ef94 700 bool large_buf; /* is current buffer large? */
8339dd32
LL
701 /* use SMBD connection instead of socket */
702 bool rdma;
703 /* point to the SMBD connection if RDMA is used instead of socket */
704 struct smbd_connection *smbd_conn;
c74093b6 705 struct delayed_work echo; /* echo ping workqueue job */
2a37ef94
JL
706 char *smallbuf; /* pointer to current "small" buffer */
707 char *bigbuf; /* pointer to current "big" buffer */
2e96467d
RS
708 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
709 unsigned int pdu_size;
2a37ef94 710 unsigned int total_read; /* total amount of data read in this pass */
488f1d2d
SJ
711#ifdef CONFIG_CIFS_FSCACHE
712 struct fscache_cookie *fscache; /* client index cache cookie */
713#endif
c3dccf48 714#ifdef CONFIG_CIFS_STATS2
789e6661 715 atomic_t in_send; /* requests trying to send */
c3dccf48 716 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
468d6779
SF
717 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
718#endif /* STATS2 */
ec2e4523
PS
719 unsigned int max_read;
720 unsigned int max_write;
5100d8a3 721 __le16 cipher_type;
8bd68c6e
AA
722 /* save initital negprot hash */
723 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
fcef0db6 724 bool posix_ext_supported;
53e0e11e
PS
725 struct delayed_work reconnect; /* reconnect workqueue job */
726 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
adfeb3e0 727 unsigned long echo_interval;
93d5cb51
PA
728
729 /*
730 * Number of targets available for reconnect. The more targets
731 * the more tasks have to wait to let the demultiplex thread
732 * reconnect.
733 */
734 int nr_targets;
1da177e4
LT
735};
736
335b7b62
PS
737struct cifs_credits {
738 unsigned int value;
739 unsigned int instance;
740};
741
fc40f9cf
PS
742static inline unsigned int
743in_flight(struct TCP_Server_Info *server)
744{
745 unsigned int num;
746 spin_lock(&server->req_lock);
747 num = server->in_flight;
748 spin_unlock(&server->req_lock);
749 return num;
750}
751
2d86dbc9 752static inline bool
b227d215 753has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
fc40f9cf 754{
2d86dbc9 755 int num;
fc40f9cf 756 spin_lock(&server->req_lock);
bc205ed1 757 num = *credits;
fc40f9cf 758 spin_unlock(&server->req_lock);
b227d215 759 return num >= num_credits;
fc40f9cf
PS
760}
761
45275789 762static inline void
34f4deb7 763add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
a891f0f8 764 const int optype)
45275789 765{
34f4deb7 766 server->ops->add_credits(server, credits, optype);
45275789
PS
767}
768
cb7e9eab 769static inline void
335b7b62
PS
770add_credits_and_wake_if(struct TCP_Server_Info *server,
771 const struct cifs_credits *credits, const int optype)
cb7e9eab 772{
335b7b62
PS
773 if (credits->value) {
774 server->ops->add_credits(server, credits, optype);
cb7e9eab
PS
775 wake_up(&server->request_q);
776 }
777}
778
45275789
PS
779static inline void
780set_credits(struct TCP_Server_Info *server, const int val)
781{
782 server->ops->set_credits(server, val);
783}
784
9a1c67e8
PS
785static inline int
786adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
787 const unsigned int payload_size)
788{
789 return server->ops->adjust_credits ?
790 server->ops->adjust_credits(server, credits, payload_size) : 0;
791}
792
9235d098 793static inline __le64
3d378d3f 794get_next_mid64(struct TCP_Server_Info *server)
88257360 795{
9235d098 796 return cpu_to_le64(server->ops->get_next_mid(server));
88257360
PS
797}
798
3d378d3f
TG
799static inline __le16
800get_next_mid(struct TCP_Server_Info *server)
801{
9235d098 802 __u16 mid = server->ops->get_next_mid(server);
3d378d3f
TG
803 /*
804 * The value in the SMB header should be little endian for easy
805 * on-the-wire decoding.
806 */
807 return cpu_to_le16(mid);
808}
809
c781af7e
PS
810static inline void
811revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
812{
813 if (server->ops->revert_current_mid)
814 server->ops->revert_current_mid(server, val);
815}
816
817static inline void
818revert_current_mid_from_hdr(struct TCP_Server_Info *server,
819 const struct smb2_sync_hdr *shdr)
820{
821 unsigned int num = le16_to_cpu(shdr->CreditCharge);
822
823 return revert_current_mid(server, num > 0 ? num : 1);
824}
825
3d378d3f
TG
826static inline __u16
827get_mid(const struct smb_hdr *smb)
828{
829 return le16_to_cpu(smb->Mid);
830}
831
832static inline bool
833compare_mid(__u16 mid, const struct smb_hdr *smb)
834{
835 return mid == le16_to_cpu(smb->Mid);
836}
837
24985c53
PS
838/*
839 * When the server supports very large reads and writes via POSIX extensions,
840 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
841 * including the RFC1001 length.
842 *
843 * Note that this might make for "interesting" allocation problems during
844 * writeback however as we have to allocate an array of pointers for the
ea1754a0 845 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
24985c53
PS
846 *
847 * For reads, there is a similar problem as we need to allocate an array
848 * of kvecs to handle the receive, though that should only need to be done
849 * once.
850 */
851#define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
852#define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
853
854/*
855 * When the server doesn't allow large posix writes, only allow a rsize/wsize
856 * of 2^17-1 minus the size of the call header. That allows for a read or
857 * write up to the maximum size described by RFC1002.
858 */
859#define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
860#define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
861
862/*
863 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
ea1754a0 864 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
24985c53
PS
865 * a single wsize request with a single call.
866 */
867#define CIFS_DEFAULT_IOSIZE (1024 * 1024)
3d621230 868#define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
24985c53
PS
869
870/*
871 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
872 * those values when posix extensions aren't in force. In actuality here, we
873 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
874 * to be ok with the extra byte even though Windows doesn't send writes that
875 * are that large.
876 *
877 * Citation:
878 *
879 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
880 */
881#define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
882#define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
883
f1d0c998
RL
884/*
885 * Macros to allow the TCP_Server_Info->net field and related code to drop out
886 * when CONFIG_NET_NS isn't set.
887 */
888
889#ifdef CONFIG_NET_NS
890
891static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
892{
893 return srv->net;
894}
895
896static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
897{
898 srv->net = net;
899}
900
901#else
902
903static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
904{
905 return &init_net;
906}
907
908static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
909{
910}
911
912#endif
913
b6f0dd5d
AA
914struct cifs_server_iface {
915 size_t speed;
916 unsigned int rdma_capable : 1;
917 unsigned int rss_capable : 1;
918 struct sockaddr_storage sockaddr;
919};
920
1da177e4
LT
921/*
922 * Session structure. One of these for each uid session with a particular host
923 */
96daf2b0 924struct cifs_ses {
14fbf50d 925 struct list_head smb_ses_list;
3b795210 926 struct list_head tcon_list;
b327a717 927 struct cifs_tcon *tcon_ipc;
d7b619cf 928 struct mutex session_mutex;
1da177e4 929 struct TCP_Server_Info *server; /* pointer to server info */
14fbf50d 930 int ses_count; /* reference counter */
1da177e4 931 enum statusEnum status;
750d1151 932 unsigned overrideSecFlg; /* if non-zero override global sec flags */
ad009ac9
SF
933 char *serverOS; /* name of operating system underlying server */
934 char *serverNOS; /* name of network operating system of server */
1da177e4 935 char *serverDomain; /* security realm of server */
286170aa 936 __u64 Suid; /* remote smb uid */
64ed39dd
EB
937 kuid_t linux_uid; /* overriding owner of files on the mount */
938 kuid_t cred_uid; /* owner of credentials */
29e20f9c 939 unsigned int capabilities;
b327a717 940 char serverName[SERVER_NAME_LEN_WITH_NULL];
34c87901
SF
941 char *user_name; /* must not be null except during init of sess
942 and after mount option parsing we fill it */
d38d8c74
SF
943 char *domainName;
944 char *password;
5d0d2882 945 struct session_key auth_key;
d3686d54 946 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
28e11bd8
JL
947 enum securityEnum sectype; /* what security flavor was specified? */
948 bool sign; /* is signing required? */
3b795210 949 bool need_reconnect:1; /* connection reset, uid now invalid */
39566443 950 bool domainAuto:1;
5478f9ba 951 __u16 session_flags;
373512ec
SF
952 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
953 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
954 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
8bd68c6e 955 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
b6f0dd5d
AA
956
957 /*
958 * Network interfaces available on the server this session is
959 * connected to.
960 *
961 * Other channels can be opened by connecting and binding this
962 * session to interfaces from this list.
963 *
964 * iface_lock should be taken when accessing any of these fields
965 */
966 spinlock_t iface_lock;
967 struct cifs_server_iface *iface_list;
968 size_t iface_count;
969 unsigned long iface_last_update; /* jiffies */
1da177e4 970};
233839b1 971
29e20f9c
PS
972static inline bool
973cap_unix(struct cifs_ses *ses)
974{
975 return ses->server->vals->cap_unix & ses->capabilities;
976}
977
a93864d9
RS
978struct cached_fid {
979 bool is_valid:1; /* Do we have a useable root fid */
b0f6df73
RS
980 bool file_all_info_is_valid:1;
981
9da6ec77 982 struct kref refcount;
a93864d9
RS
983 struct cifs_fid *fid;
984 struct mutex fid_mutex;
985 struct cifs_tcon *tcon;
986 struct work_struct lease_break;
b0f6df73 987 struct smb2_file_all_info file_all_info;
a93864d9
RS
988};
989
1da177e4
LT
990/*
991 * there is one of these for each connection to a resource on a particular
d38d8c74 992 * session
1da177e4 993 */
96daf2b0 994struct cifs_tcon {
f1987b44
JL
995 struct list_head tcon_list;
996 int tc_count;
53e0e11e 997 struct list_head rlist; /* reconnect list */
fae8044c
SF
998 atomic_t num_local_opens; /* num of all opens including disconnected */
999 atomic_t num_remote_opens; /* num of all network opens on server */
1da177e4 1000 struct list_head openFileList;
3afca265 1001 spinlock_t open_file_lock; /* protects list above */
96daf2b0 1002 struct cifs_ses *ses; /* pointer to session associated with */
254e55ed 1003 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1da177e4 1004 char *nativeFileSystem;
00e485b0 1005 char *password; /* for share-level security */
faaf946a 1006 __u32 tid; /* The 4 byte tree id */
1da177e4
LT
1007 __u16 Flags; /* optional support bits */
1008 enum statusEnum tidStatus;
1da177e4 1009 atomic_t num_smbs_sent;
44c58186
PS
1010 union {
1011 struct {
1012 atomic_t num_writes;
1013 atomic_t num_reads;
1014 atomic_t num_flushes;
1015 atomic_t num_oplock_brks;
1016 atomic_t num_opens;
1017 atomic_t num_closes;
1018 atomic_t num_deletes;
1019 atomic_t num_mkdirs;
1020 atomic_t num_posixopens;
1021 atomic_t num_posixmkdirs;
1022 atomic_t num_rmdirs;
1023 atomic_t num_renames;
1024 atomic_t num_t2renames;
1025 atomic_t num_ffirst;
1026 atomic_t num_fnext;
1027 atomic_t num_fclose;
1028 atomic_t num_hardlinks;
1029 atomic_t num_symlinks;
1030 atomic_t num_locks;
1031 atomic_t num_acl_get;
1032 atomic_t num_acl_set;
1033 } cifs_stats;
d60622eb
PS
1034 struct {
1035 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1036 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1037 } smb2_stats;
44c58186 1038 } stats;
1da177e4
LT
1039 __u64 bytes_read;
1040 __u64 bytes_written;
3afca265 1041 spinlock_t stat_lock; /* protects the two fields above */
1da177e4 1042 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
254e55ed 1043 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1da177e4 1044 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
b327a717
AA
1045 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1046 bool pipe:1; /* set if connection to pipe share */
1047 bool print:1; /* set if connection to printer share */
4b18f2a9
SF
1048 bool retry:1;
1049 bool nocase:1;
3d4ef9a1 1050 bool nohandlecache:1; /* if strange server resource prob can turn off */
95b1cb90 1051 bool seal:1; /* transport encryption for this mounted share */
4b18f2a9 1052 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
c18c842b 1053 for this mount even if server would support */
b326614e 1054 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
84210e91 1055 bool local_lease:1; /* check leases (only) on local system not remote */
64cc2c63 1056 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
3d1a3745 1057 bool broken_sparse_sup; /* if server or share does not support sparse */
3b795210 1058 bool need_reconnect:1; /* connection reset, tid now invalid */
96a988ff 1059 bool need_reopen_files:1; /* need to reopen tcon file handles */
592fafe6 1060 bool use_resilient:1; /* use resilient instead of durable handles */
b618f001 1061 bool use_persistent:1; /* use persistent instead of durable handles */
769ee6a4 1062 __le32 capabilities;
faaf946a
PS
1063 __u32 share_flags;
1064 __u32 maximal_access;
1065 __u32 vol_serial_number;
1066 __le64 vol_create_time;
8b217fe7 1067 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
ca567eb2 1068 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
af6a12ea
SF
1069 __u32 ss_flags; /* sector size flags */
1070 __u32 perf_sector_size; /* best sector size for perf */
de9f68df
SF
1071 __u32 max_chunks;
1072 __u32 max_bytes_chunk;
1073 __u32 max_bytes_copy;
d03382ce
SJ
1074#ifdef CONFIG_CIFS_FSCACHE
1075 u64 resource_id; /* server resource id */
1076 struct fscache_cookie *fscache; /* cookie for share */
1077#endif
233839b1 1078 struct list_head pending_opens; /* list of incomplete opens */
a93864d9 1079 struct cached_fid crfid; /* Cached root fid */
c18c842b 1080 /* BB add field for back pointer to sb struct(s)? */
54be1f6c
PA
1081#ifdef CONFIG_CIFS_DFS_UPCALL
1082 char *dfs_path;
1083 int remap:2;
1084 struct list_head ulist; /* cache update list */
1085#endif
1da177e4
LT
1086};
1087
7ffec372
JL
1088/*
1089 * This is a refcounted and timestamped container for a tcon pointer. The
1090 * container holds a tcon reference. It is considered safe to free one of
1091 * these when the tl_count goes to 0. The tl_time is the time of the last
1092 * "get" on the container.
1093 */
1094struct tcon_link {
b647c35f 1095 struct rb_node tl_rbnode;
6d4a0832 1096 kuid_t tl_uid;
9d002df4
JL
1097 unsigned long tl_flags;
1098#define TCON_LINK_MASTER 0
1099#define TCON_LINK_PENDING 1
1100#define TCON_LINK_IN_TREE 2
1101 unsigned long tl_time;
1102 atomic_t tl_count;
96daf2b0 1103 struct cifs_tcon *tl_tcon;
7ffec372
JL
1104};
1105
9d002df4 1106extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
b2c96de7 1107extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
7ffec372 1108
96daf2b0 1109static inline struct cifs_tcon *
7ffec372
JL
1110tlink_tcon(struct tcon_link *tlink)
1111{
9d002df4 1112 return tlink->tl_tcon;
7ffec372
JL
1113}
1114
8ddecf5f
AA
1115static inline struct tcon_link *
1116cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1117{
1118 return cifs_sb->master_tlink;
1119}
1120
9d002df4 1121extern void cifs_put_tlink(struct tcon_link *tlink);
7ffec372 1122
13cfb733
JL
1123static inline struct tcon_link *
1124cifs_get_tlink(struct tcon_link *tlink)
1125{
9d002df4
JL
1126 if (tlink && !IS_ERR(tlink))
1127 atomic_inc(&tlink->tl_count);
13cfb733
JL
1128 return tlink;
1129}
1130
7ffec372 1131/* This function is always expected to succeed */
96daf2b0 1132extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
7ffec372 1133
233839b1
PS
1134#define CIFS_OPLOCK_NO_CHANGE 0xfe
1135
1136struct cifs_pending_open {
1137 struct list_head olist;
1138 struct tcon_link *tlink;
1139 __u8 lease_key[16];
1140 __u32 oplock;
1141};
1142
1da177e4 1143/*
7ee1af76
JA
1144 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1145 * This is used to track byte stream locks on the file
1da177e4
LT
1146 */
1147struct cifsLockInfo {
7ee1af76 1148 struct list_head llist; /* pointer to next cifsLockInfo */
85160e03
PS
1149 struct list_head blist; /* pointer to locks blocked on this */
1150 wait_queue_head_t block_q;
7ee1af76
JA
1151 __u64 offset;
1152 __u64 length;
03776f45 1153 __u32 pid;
9645759c
RS
1154 __u16 type;
1155 __u16 flags;
1da177e4
LT
1156};
1157
1158/*
1159 * One of these for each open instance of a file
1160 */
1161struct cifs_search_info {
1162 loff_t index_of_last_entry;
1163 __u16 entries_in_buffer;
1164 __u16 info_level;
1165 __u32 resume_key;
d38d8c74
SF
1166 char *ntwrk_buf_start;
1167 char *srch_entries_start;
0752f152 1168 char *last_entry;
eaf35b1e 1169 const char *presume_name;
1da177e4 1170 unsigned int resume_name_len;
4b18f2a9
SF
1171 bool endOfSearch:1;
1172 bool emptyDir:1;
1173 bool unicode:1;
1174 bool smallBuf:1; /* so we know which buf_release function to call */
1da177e4
LT
1175};
1176
226730b4
PS
1177struct cifs_open_parms {
1178 struct cifs_tcon *tcon;
1179 struct cifs_sb_info *cifs_sb;
1180 int disposition;
1181 int desired_access;
1182 int create_options;
1183 const char *path;
1184 struct cifs_fid *fid;
ce558b0e 1185 umode_t mode;
9cbc0b73 1186 bool reconnect:1;
226730b4
PS
1187};
1188
4b4de76e
PS
1189struct cifs_fid {
1190 __u16 netfid;
f0df737e
PS
1191 __u64 persistent_fid; /* persist file id for smb2 */
1192 __u64 volatile_fid; /* volatile file id for smb2 */
b8c32dbb 1193 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
b56eae4d 1194 __u8 create_guid[16];
233839b1 1195 struct cifs_pending_open *pending_open;
42873b0a 1196 unsigned int epoch;
dfe33f9a
SF
1197#ifdef CONFIG_CIFS_DEBUG2
1198 __u64 mid;
1199#endif /* CIFS_DEBUG2 */
42873b0a 1200 bool purge_cache;
4b4de76e
PS
1201};
1202
f45d3416
PS
1203struct cifs_fid_locks {
1204 struct list_head llist;
1205 struct cifsFileInfo *cfile; /* fid that owns locks */
1206 struct list_head locks; /* locks held by fid above */
1207};
1208
1da177e4 1209struct cifsFileInfo {
3afca265 1210 /* following two lists are protected by tcon->open_file_lock */
1da177e4
LT
1211 struct list_head tlist; /* pointer to next fid owned by tcon */
1212 struct list_head flist; /* next fid (file instance) for this inode */
3afca265 1213 /* lock list below protected by cifsi->lock_sem */
f45d3416 1214 struct cifs_fid_locks *llist; /* brlocks held by this fid */
fef59fd7 1215 kuid_t uid; /* allows finding which FileInfo structure */
1da177e4 1216 __u32 pid; /* process id who opened file */
4b4de76e 1217 struct cifs_fid fid; /* file id from remote */
f2cca6a7 1218 struct list_head rlist; /* reconnect list */
1da177e4
LT
1219 /* BB add lock scope info here if needed */ ;
1220 /* lock scope id (0 if none) */
a5e18bc3 1221 struct dentry *dentry;
13cfb733 1222 struct tcon_link *tlink;
3afca265 1223 unsigned int f_flags;
4b18f2a9 1224 bool invalidHandle:1; /* file closed via session abend */
3bc303c2 1225 bool oplock_break_cancelled:1;
3afca265
SF
1226 int count;
1227 spinlock_t file_info_lock; /* protects four flag/count fields above */
a6ce4932 1228 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1da177e4 1229 struct cifs_search_info srch_inf;
9b646972 1230 struct work_struct oplock_break; /* work for oplock breaks */
1da177e4
LT
1231};
1232
fa2989f4
PS
1233struct cifs_io_parms {
1234 __u16 netfid;
09a4707e
PS
1235 __u64 persistent_fid; /* persist file id for smb2 */
1236 __u64 volatile_fid; /* volatile file id for smb2 */
fa2989f4
PS
1237 __u32 pid;
1238 __u64 offset;
1239 unsigned int length;
96daf2b0 1240 struct cifs_tcon *tcon;
fa2989f4
PS
1241};
1242
ccf7f408
PS
1243struct cifs_aio_ctx {
1244 struct kref refcount;
1245 struct list_head list;
1246 struct mutex aio_mutex;
1247 struct completion done;
1248 struct iov_iter iter;
1249 struct kiocb *iocb;
1250 struct cifsFileInfo *cfile;
1251 struct bio_vec *bv;
c610c4b6 1252 loff_t pos;
ccf7f408
PS
1253 unsigned int npages;
1254 ssize_t rc;
1255 unsigned int len;
1256 unsigned int total_len;
1257 bool should_dirty;
6e6e2b86
LL
1258 /*
1259 * Indicates if this aio_ctx is for direct_io,
1260 * If yes, iter is a copy of the user passed iov_iter
1261 */
1262 bool direct_io;
ccf7f408
PS
1263};
1264
09a4707e
PS
1265struct cifs_readdata;
1266
1267/* asynchronous read support */
1268struct cifs_readdata {
1269 struct kref refcount;
1270 struct list_head list;
1271 struct completion done;
1272 struct cifsFileInfo *cfile;
1273 struct address_space *mapping;
6685c5e2 1274 struct cifs_aio_ctx *ctx;
09a4707e
PS
1275 __u64 offset;
1276 unsigned int bytes;
34a54d61 1277 unsigned int got_bytes;
09a4707e
PS
1278 pid_t pid;
1279 int result;
09a4707e 1280 struct work_struct work;
8321fec4
JL
1281 int (*read_into_pages)(struct TCP_Server_Info *server,
1282 struct cifs_readdata *rdata,
1283 unsigned int len);
d70b9104
PS
1284 int (*copy_into_pages)(struct TCP_Server_Info *server,
1285 struct cifs_readdata *rdata,
1286 struct iov_iter *iter);
738f9de5 1287 struct kvec iov[2];
74dcf418
LL
1288#ifdef CONFIG_CIFS_SMB_DIRECT
1289 struct smbd_mr *mr;
1290#endif
8321fec4 1291 unsigned int pagesz;
57a929a6 1292 unsigned int page_offset;
8321fec4 1293 unsigned int tailsz;
335b7b62 1294 struct cifs_credits credits;
c5fab6f4 1295 unsigned int nr_pages;
f9f5aca1 1296 struct page **pages;
09a4707e
PS
1297};
1298
33319141
PS
1299struct cifs_writedata;
1300
1301/* asynchronous write support */
1302struct cifs_writedata {
1303 struct kref refcount;
1304 struct list_head list;
1305 struct completion done;
1306 enum writeback_sync_modes sync_mode;
1307 struct work_struct work;
1308 struct cifsFileInfo *cfile;
c610c4b6 1309 struct cifs_aio_ctx *ctx;
33319141
PS
1310 __u64 offset;
1311 pid_t pid;
1312 unsigned int bytes;
1313 int result;
db223a59
LL
1314#ifdef CONFIG_CIFS_SMB_DIRECT
1315 struct smbd_mr *mr;
1316#endif
eddb079d 1317 unsigned int pagesz;
57a929a6 1318 unsigned int page_offset;
eddb079d 1319 unsigned int tailsz;
335b7b62 1320 struct cifs_credits credits;
33319141 1321 unsigned int nr_pages;
8e7360f6 1322 struct page **pages;
33319141
PS
1323};
1324
5f6dbc9e
JL
1325/*
1326 * Take a reference on the file private data. Must be called with
3afca265 1327 * cfile->file_info_lock held.
5f6dbc9e 1328 */
764a1b1a
JL
1329static inline void
1330cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
6ab409b5 1331{
5f6dbc9e 1332 ++cifs_file->count;
6ab409b5
DK
1333}
1334
764a1b1a 1335struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
b98749ca 1336void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr);
b33879aa 1337void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
6ab409b5 1338
18cceb6a
PS
1339#define CIFS_CACHE_READ_FLG 1
1340#define CIFS_CACHE_HANDLE_FLG 2
42873b0a 1341#define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
18cceb6a 1342#define CIFS_CACHE_WRITE_FLG 4
42873b0a
PS
1343#define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1344#define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
18cceb6a
PS
1345
1346#define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
53ef1016 1347#define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
18cceb6a
PS
1348#define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1349
1da177e4
LT
1350/*
1351 * One of these for each file inode
1352 */
1353
1354struct cifsInodeInfo {
d59dad2b 1355 bool can_cache_brlcks;
f45d3416 1356 struct list_head llist; /* locks helb by this inode */
1b4b55a1 1357 struct rw_semaphore lock_sem; /* protect the fields above */
d38d8c74 1358 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1da177e4 1359 struct list_head openFileList;
1da177e4 1360 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
18cceb6a 1361 unsigned int oplock; /* oplock/lease level we have */
42873b0a 1362 unsigned int epoch; /* used to track lease state changes */
c11f1df5
SP
1363#define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1364#define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1365#define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
aff8d5ca
JL
1366#define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1367#define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
4f73c7d3 1368#define CIFS_INO_LOCK (5) /* lock bit for synchronization */
aff8d5ca 1369 unsigned long flags;
c11f1df5
SP
1370 spinlock_t writers_lock;
1371 unsigned int writers; /* Number of writers on this inode */
aae62fdb 1372 unsigned long time; /* jiffies of last update of inode */
597b027f 1373 u64 server_eof; /* current file size on server -- protected by i_lock */
cc0bad75 1374 u64 uniqueid; /* server inode number */
20054bd6 1375 u64 createtime; /* creation time on server */
b8c32dbb 1376 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
9451a9a5
SJ
1377#ifdef CONFIG_CIFS_FSCACHE
1378 struct fscache_cookie *fscache;
1379#endif
1da177e4
LT
1380 struct inode vfs_inode;
1381};
1382
1383static inline struct cifsInodeInfo *
1384CIFS_I(struct inode *inode)
1385{
1386 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1387}
1388
1389static inline struct cifs_sb_info *
1390CIFS_SB(struct super_block *sb)
1391{
1392 return sb->s_fs_info;
1393}
1394
7119e220
AV
1395static inline struct cifs_sb_info *
1396CIFS_FILE_SB(struct file *file)
1397{
1398 return CIFS_SB(file_inode(file)->i_sb);
1399}
1400
ab2f218f 1401static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
ac67055e
JA
1402{
1403 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1404 return '/';
1405 else
1406 return '\\';
1407}
1da177e4 1408
f87d39d9
SF
1409static inline void
1410convert_delimiter(char *path, char delim)
1411{
1cc9bd68 1412 char old_delim, *pos;
f87d39d9
SF
1413
1414 if (delim == '/')
1415 old_delim = '\\';
1416 else
1417 old_delim = '/';
1418
1cc9bd68
SF
1419 pos = path;
1420 while ((pos = strchr(pos, old_delim)))
1421 *pos = delim;
f87d39d9
SF
1422}
1423
a4544347
SF
1424#define cifs_stats_inc atomic_inc
1425
96daf2b0 1426static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
a4544347
SF
1427 unsigned int bytes)
1428{
1429 if (bytes) {
1430 spin_lock(&tcon->stat_lock);
1431 tcon->bytes_written += bytes;
1432 spin_unlock(&tcon->stat_lock);
1433 }
1434}
1435
96daf2b0 1436static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
a4544347
SF
1437 unsigned int bytes)
1438{
1439 spin_lock(&tcon->stat_lock);
1440 tcon->bytes_read += bytes;
1441 spin_unlock(&tcon->stat_lock);
1442}
a4544347 1443
2b84a36c
JL
1444
1445/*
44d22d84
JL
1446 * This is the prototype for the mid receive function. This function is for
1447 * receiving the rest of the SMB frame, starting with the WordCount (which is
1448 * just after the MID in struct smb_hdr). Note:
1449 *
1450 * - This will be called by cifsd, with no locks held.
1451 * - The mid will still be on the pending_mid_q.
1452 * - mid->resp_buf will point to the current buffer.
1453 *
1454 * Returns zero on a successful receive, or an error. The receive state in
1455 * the TCP_Server_Info will also be updated.
1456 */
1457typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1458 struct mid_q_entry *mid);
1459
1460/*
1461 * This is the prototype for the mid callback function. This is called once the
1462 * mid has been received off of the socket. When creating one, take special
1463 * care to avoid deadlocks. Things to bear in mind:
2b84a36c 1464 *
3c1105df
JL
1465 * - it will be called by cifsd, with no locks held
1466 * - the mid will be removed from any lists
2b84a36c
JL
1467 */
1468typedef void (mid_callback_t)(struct mid_q_entry *mid);
1469
9b7c18a2
PS
1470/*
1471 * This is the protopyte for mid handle function. This is called once the mid
1472 * has been recognized after decryption of the message.
1473 */
1474typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1475 struct mid_q_entry *mid);
1476
1da177e4
LT
1477/* one of these for every pending CIFS request to the server */
1478struct mid_q_entry {
1479 struct list_head qhead; /* mids waiting on reply from this server */
696e420b 1480 struct kref refcount;
2dc7e1c0 1481 struct TCP_Server_Info *server; /* server corresponding to this mid */
7c9421e1 1482 __u64 mid; /* multiplex id */
c781af7e 1483 __u16 credits; /* number of credits consumed by this mid */
7c9421e1 1484 __u32 pid; /* process id */
1da177e4 1485 __u32 sequence_number; /* for CIFS signing */
1047abc1
SF
1486 unsigned long when_alloc; /* when mid was created */
1487#ifdef CONFIG_CIFS_STATS2
1488 unsigned long when_sent; /* time when smb send finished */
1489 unsigned long when_received; /* when demux complete (taken off wire) */
1490#endif
44d22d84 1491 mid_receive_t *receive; /* call receive callback */
2b84a36c 1492 mid_callback_t *callback; /* call completion callback */
9b7c18a2 1493 mid_handle_t *handle; /* call handle mid callback */
2b84a36c 1494 void *callback_data; /* general purpose pointer for callback */
d4e4854f 1495 void *resp_buf; /* pointer to received SMB header */
e19b2bc0 1496 unsigned int resp_buf_size;
7c9421e1 1497 int mid_state; /* wish this were enum but can not pass to wait_event */
38bd4906 1498 unsigned int mid_flags;
7c9421e1 1499 __le16 command; /* smb command code */
8a26f0f7 1500 unsigned int optype; /* operation type */
7c9421e1 1501 bool large_buf:1; /* if valid response, is pointer to large buf */
4b18f2a9
SF
1502 bool multiRsp:1; /* multiple trans2 responses for one request */
1503 bool multiEnd:1; /* both received */
4326ed2f 1504 bool decrypted:1; /* decrypted entry */
1da177e4
LT
1505};
1506
38bd4906
SP
1507struct close_cancelled_open {
1508 struct cifs_fid fid;
1509 struct cifs_tcon *tcon;
1510 struct work_struct work;
1511};
1512
789e6661
SF
1513/* Make code in transport.c a little cleaner by moving
1514 update of optional stats into function below */
1515#ifdef CONFIG_CIFS_STATS2
1516
1517static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1518{
1519 atomic_inc(&server->in_send);
1520}
1521
1522static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1523{
1524 atomic_dec(&server->in_send);
1525}
1526
1527static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1528{
1529 atomic_inc(&server->num_waiters);
1530}
1531
1532static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1533{
1534 atomic_dec(&server->num_waiters);
1535}
1536
1537static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1538{
1539 mid->when_sent = jiffies;
1540}
1541#else
1542static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1543{
1544}
1545static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1546{
1547}
1548
1549static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1550{
1551}
1552
1553static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1554{
1555}
1556
1557static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1558{
1559}
1560#endif
1da177e4 1561
ff5dbd9e
SF
1562/* for pending dnotify requests */
1563struct dir_notify_req {
13cd4b7f
SF
1564 struct list_head lhead;
1565 __le16 Pid;
1566 __le16 PidHigh;
1567 __u16 Mid;
1568 __u16 Tid;
1569 __u16 Uid;
1570 __u16 netfid;
1571 __u32 filter; /* CompletionFilter (for multishot) */
1572 int multishot;
1573 struct file *pfile;
ff5dbd9e
SF
1574};
1575
366781c1
SF
1576struct dfs_info3_param {
1577 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
8aad018b 1578 int path_consumed;
366781c1
SF
1579 int server_type;
1580 int ref_flag;
1581 char *path_name;
1582 char *node_name;
e7b602f4 1583 int ttl;
366781c1
SF
1584};
1585
cc0bad75
JL
1586/*
1587 * common struct for holding inode info when searching for or updating an
1588 * inode with new info
1589 */
1590
1591#define CIFS_FATTR_DFS_REFERRAL 0x1
0b8f18e3
JL
1592#define CIFS_FATTR_DELETE_PENDING 0x2
1593#define CIFS_FATTR_NEED_REVAL 0x4
3d694380 1594#define CIFS_FATTR_INO_COLLISION 0x8
74d290da 1595#define CIFS_FATTR_UNKNOWN_NLINK 0x10
7ea884c7 1596#define CIFS_FATTR_FAKE_ROOT_INO 0x20
cc0bad75
JL
1597
1598struct cifs_fattr {
1599 u32 cf_flags;
1600 u32 cf_cifsattrs;
1601 u64 cf_uniqueid;
1602 u64 cf_eof;
1603 u64 cf_bytes;
20054bd6 1604 u64 cf_createtime;
4a2c8cf5
EB
1605 kuid_t cf_uid;
1606 kgid_t cf_gid;
cc0bad75
JL
1607 umode_t cf_mode;
1608 dev_t cf_rdev;
1609 unsigned int cf_nlink;
1610 unsigned int cf_dtype;
95390201
AB
1611 struct timespec64 cf_atime;
1612 struct timespec64 cf_mtime;
1613 struct timespec64 cf_ctime;
cc0bad75
JL
1614};
1615
366781c1
SF
1616static inline void free_dfs_info_param(struct dfs_info3_param *param)
1617{
1618 if (param) {
1619 kfree(param->path_name);
1620 kfree(param->node_name);
366781c1
SF
1621 }
1622}
1623
1624static inline void free_dfs_info_array(struct dfs_info3_param *param,
1625 int number_of_items)
1626{
1627 int i;
1628 if ((number_of_items == 0) || (param == NULL))
1629 return;
1630 for (i = 0; i < number_of_items; i++) {
1631 kfree(param[i].path_name);
1632 kfree(param[i].node_name);
1633 }
1634 kfree(param);
1635}
1636
9a66396f
PS
1637static inline bool is_interrupt_error(int error)
1638{
1639 switch (error) {
1640 case -EINTR:
1641 case -ERESTARTSYS:
1642 case -ERESTARTNOHAND:
1643 case -ERESTARTNOINTR:
1644 return true;
1645 }
1646 return false;
1647}
1648
1649static inline bool is_retryable_error(int error)
1650{
1651 if (is_interrupt_error(error) || error == -EAGAIN)
1652 return true;
1653 return false;
1654}
1655
1da177e4
LT
1656#define MID_FREE 0
1657#define MID_REQUEST_ALLOCATED 1
1658#define MID_REQUEST_SUBMITTED 2
1659#define MID_RESPONSE_RECEIVED 4
1660#define MID_RETRY_NEEDED 8 /* session closed while this request out */
71823baf 1661#define MID_RESPONSE_MALFORMED 0x10
3c1105df 1662#define MID_SHUTDOWN 0x20
ec637e3f 1663
38bd4906
SP
1664/* Flags */
1665#define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
ddf83afb 1666#define MID_DELETED 2 /* Mid has been dequeued/deleted */
38bd4906 1667
ec637e3f
SF
1668/* Types of response buffer returned from SendReceive2 */
1669#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1670#define CIFS_SMALL_BUFFER 1
1671#define CIFS_LARGE_BUFFER 2
1672#define CIFS_IOVEC 4 /* array of response buffers */
1da177e4 1673
133672ef 1674/* Type of Request to SendReceive2 */
7749981e
JL
1675#define CIFS_BLOCKING_OP 1 /* operation can block */
1676#define CIFS_ASYNC_OP 2 /* do not wait for response */
1677#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
133672ef
SF
1678#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1679#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1680#define CIFS_NO_RESP 0x040 /* no response buffer required */
1681
a891f0f8
PS
1682/* Type of request operation */
1683#define CIFS_ECHO_OP 0x080 /* echo request */
1684#define CIFS_OBREAK_OP 0x0100 /* oplock break request */
ec2e4523
PS
1685#define CIFS_NEG_OP 0x0200 /* negotiate request */
1686#define CIFS_OP_MASK 0x0380 /* mask request type */
7fb8986e 1687
cb7e9eab 1688#define CIFS_HAS_CREDITS 0x0400 /* already has credits */
7fb8986e 1689#define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
a891f0f8 1690
3979877e
SF
1691/* Security Flags: indicate type of session setup needed */
1692#define CIFSSEC_MAY_SIGN 0x00001
1693#define CIFSSEC_MAY_NTLM 0x00002
1694#define CIFSSEC_MAY_NTLMV2 0x00004
1695#define CIFSSEC_MAY_KRB5 0x00008
1696#ifdef CONFIG_CIFS_WEAK_PW_HASH
1697#define CIFSSEC_MAY_LANMAN 0x00010
1698#define CIFSSEC_MAY_PLNTXT 0x00020
516897a2
SF
1699#else
1700#define CIFSSEC_MAY_LANMAN 0
1701#define CIFSSEC_MAY_PLNTXT 0
3979877e
SF
1702#endif /* weak passwords */
1703#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
ac683924 1704#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
3979877e
SF
1705
1706#define CIFSSEC_MUST_SIGN 0x01001
1707/* note that only one of the following can be set so the
1708result of setting MUST flags more than once will be to
1709require use of the stronger protocol */
1710#define CIFSSEC_MUST_NTLM 0x02002
1711#define CIFSSEC_MUST_NTLMV2 0x04004
1712#define CIFSSEC_MUST_KRB5 0x08008
1713#ifdef CONFIG_CIFS_WEAK_PW_HASH
1714#define CIFSSEC_MUST_LANMAN 0x10010
1715#define CIFSSEC_MUST_PLNTXT 0x20020
0d3a01fa 1716#ifdef CONFIG_CIFS_UPCALL
20d1752f 1717#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
0d3a01fa 1718#else
20d1752f 1719#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
016ec75f 1720#endif /* UPCALL */
0d3a01fa 1721#else /* do not allow weak pw hash */
88a4412b
SF
1722#define CIFSSEC_MUST_LANMAN 0
1723#define CIFSSEC_MUST_PLNTXT 0
0d3a01fa 1724#ifdef CONFIG_CIFS_UPCALL
ac683924 1725#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
d38d8c74 1726#else
ac683924 1727#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
016ec75f 1728#endif /* UPCALL */
3979877e
SF
1729#endif /* WEAK_PW_HASH */
1730#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
ac683924 1731#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
3979877e 1732
896a8fc2 1733#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
ef571cad 1734#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
ac683924 1735#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1da177e4
LT
1736/*
1737 *****************************************************************
1738 * All constants go here
1739 *****************************************************************
1740 */
1741
1742#define UID_HASH (16)
1743
1744/*
1745 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1746 * following to be declared.
1747 */
1748
1749/****************************************************************************
1750 * Locking notes. All updates to global variables and lists should be
1751 * protected by spinlocks or semaphores.
1752 *
1753 * Spinlocks
1754 * ---------
1755 * GlobalMid_Lock protects:
1756 * list operations on pending_mid_q and oplockQ
1757 * updates to XID counters, multiplex id and SMB sequence numbers
65525802 1758 * list operations on global DnotifyReqList
3afca265
SF
1759 * tcp_ses_lock protects:
1760 * list operations on tcp and SMB session lists
1761 * tcon->open_file_lock protects the list of open files hanging off the tcon
1762 * cfile->file_info_lock protects counters and fields in cifs file struct
1da177e4
LT
1763 * f_owner.lock protects certain per file struct operations
1764 * mapping->page_lock protects certain per page operations
1765 *
1766 * Semaphores
1767 * ----------
1768 * sesSem operations on smb session
1769 * tconSem operations on tree connection
d38d8c74 1770 * fh_sem file handle reconnection operations
1da177e4
LT
1771 *
1772 ****************************************************************************/
1773
1774#ifdef DECLARE_GLOBALS_HERE
1775#define GLOBAL_EXTERN
1776#else
1777#define GLOBAL_EXTERN extern
1778#endif
1779
e7ddee90
JL
1780/*
1781 * the list of TCP_Server_Info structures, ie each of the sockets
fb396016 1782 * connecting our client to a distinct server (ip address), is
e7ddee90 1783 * chained together by cifs_tcp_ses_list. The list of all our SMB
fb396016 1784 * sessions (and from that the tree connections) can be found
e7ddee90
JL
1785 * by iterating over cifs_tcp_ses_list
1786 */
1787GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1788
f1987b44
JL
1789/*
1790 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1791 * tcp session, and the list of tcon's per smb session. It also protects
1792 * the reference counters for the server, smb session, and tcon. Finally,
1793 * changes to the tcon->tidStatus should be done while holding this lock.
3afca265
SF
1794 * generally the locks should be taken in order tcp_ses_lock before
1795 * tcon->open_file_lock and that before file->file_info_lock since the
1796 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
f1987b44 1797 */
3f9bcca7 1798GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
ddb4cbfc 1799
0eff0e26 1800#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
99ee4dbd
SF
1801/* Outstanding dir notify requests */
1802GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1803/* DirNotify response queue */
1804GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
0eff0e26 1805#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
ff5dbd9e 1806
1da177e4
LT
1807/*
1808 * Global transaction id (XID) information
1809 */
1810GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
254e55ed 1811GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1da177e4 1812GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
254e55ed
SF
1813GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1814 /* on midQ entries */
1da177e4
LT
1815/*
1816 * Global counters, updated atomically
1817 */
1818GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1819GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1820GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1821GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1822GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1823
aaa9bbe0 1824/* Various Debug counters */
4498eed5
SF
1825GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1826#ifdef CONFIG_CIFS_STATS2
1827GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1828GLOBAL_EXTERN atomic_t totSmBufAllocCount;
00778e22 1829extern unsigned int slow_rsp_threshold; /* number of secs before logging */
4498eed5
SF
1830#endif
1831GLOBAL_EXTERN atomic_t smBufAllocCount;
1da177e4
LT
1832GLOBAL_EXTERN atomic_t midCount;
1833
1834/* Misc globals */
f92a720e
SF
1835extern bool enable_oplocks; /* enable or disable oplocks */
1836extern bool lookupCacheEnabled;
1837extern unsigned int global_secflags; /* if on, session setup sent
1da177e4 1838 with more secure ntlmssp2 challenge/resp */
f92a720e
SF
1839extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1840extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1841extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1842extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1843extern unsigned int cifs_min_small; /* min size of small buf pool */
1844extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1845extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
1da177e4 1846
21fed0d5 1847#ifdef CONFIG_CIFS_ACL
4d79dba0
SP
1848GLOBAL_EXTERN struct rb_root uidtree;
1849GLOBAL_EXTERN struct rb_root gidtree;
1850GLOBAL_EXTERN spinlock_t siduidlock;
1851GLOBAL_EXTERN spinlock_t sidgidlock;
21fed0d5
SP
1852GLOBAL_EXTERN struct rb_root siduidtree;
1853GLOBAL_EXTERN struct rb_root sidgidtree;
1854GLOBAL_EXTERN spinlock_t uidsidlock;
1855GLOBAL_EXTERN spinlock_t gidsidlock;
1856#endif /* CONFIG_CIFS_ACL */
4d79dba0 1857
9b646972 1858void cifs_oplock_break(struct work_struct *work);
b98749ca 1859void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
3b7433b8 1860
3bc303c2 1861extern const struct slow_work_ops cifs_oplock_break_ops;
da472fc8 1862extern struct workqueue_struct *cifsiod_wq;
3998e6b8 1863extern struct workqueue_struct *cifsoplockd_wq;
3d22462a 1864extern __u32 cifs_lock_secret;
abd2e44d 1865
2dc7e1c0
PS
1866extern mempool_t *cifs_mid_poolp;
1867
23db65f5
JL
1868/* Operations for different SMB versions */
1869#define SMB1_VERSION_STRING "1.0"
1870extern struct smb_version_operations smb1_operations;
1871extern struct smb_version_values smb1_values;
e4aa25e7 1872#define SMB20_VERSION_STRING "2.0"
53ef1016 1873extern struct smb_version_operations smb20_operations;
e4aa25e7 1874extern struct smb_version_values smb20_values;
1080ef75
SF
1875#define SMB21_VERSION_STRING "2.1"
1876extern struct smb_version_operations smb21_operations;
1877extern struct smb_version_values smb21_values;
9764c02f
SF
1878#define SMBDEFAULT_VERSION_STRING "default"
1879extern struct smb_version_values smbdefault_values;
1880#define SMB3ANY_VERSION_STRING "3"
1881extern struct smb_version_values smb3any_values;
e4aa25e7 1882#define SMB30_VERSION_STRING "3.0"
38107d45 1883extern struct smb_version_operations smb30_operations;
e4aa25e7 1884extern struct smb_version_values smb30_values;
20b6d8b4 1885#define SMB302_VERSION_STRING "3.02"
4a3b38ae 1886#define ALT_SMB302_VERSION_STRING "3.0.2"
20b6d8b4
SF
1887/*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1888extern struct smb_version_values smb302_values;
5f7fbf73 1889#define SMB311_VERSION_STRING "3.1.1"
aab1893d
SF
1890#define ALT_SMB311_VERSION_STRING "3.11"
1891extern struct smb_version_operations smb311_operations;
5f7fbf73 1892extern struct smb_version_values smb311_values;
abd2e44d 1893#endif /* _CIFS_GLOB_H */