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