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