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