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