CIFS: Fix SMB2 mounts so they don't try to set or get xattrs via cifs
[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);
23db65f5
JL
379};
380
381struct smb_version_values {
382 char *version_string;
e4aa25e7
SF
383 __u16 protocol_id;
384 __u32 req_capabilities;
106dc538
PS
385 __u32 large_lock_type;
386 __u32 exclusive_lock_type;
387 __u32 shared_lock_type;
388 __u32 unlock_lock_type;
1887f601
PS
389 size_t header_size;
390 size_t max_header_size;
eb378711 391 size_t read_rsp_size;
2dc7e1c0 392 __le16 lock_cmd;
29e20f9c
PS
393 unsigned int cap_unix;
394 unsigned int cap_nt_find;
395 unsigned int cap_large_files;
63b7d3a4 396 unsigned int oplock_read;
23db65f5
JL
397};
398
1887f601
PS
399#define HEADER_SIZE(server) (server->vals->header_size)
400#define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
401
f87d39d9
SF
402struct smb_vol {
403 char *username;
404 char *password;
405 char *domainname;
406 char *UNC;
f87d39d9
SF
407 char *iocharset; /* local code page for mapping to and from Unicode */
408 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
409 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
3da46565
EB
410 kuid_t cred_uid;
411 kuid_t linux_uid;
412 kgid_t linux_gid;
413 kuid_t backupuid;
414 kgid_t backupgid;
5206efd6
AV
415 umode_t file_mode;
416 umode_t dir_mode;
f87d39d9
SF
417 unsigned secFlg;
418 bool retry:1;
419 bool intr:1;
420 bool setuids:1;
421 bool override_uid:1;
422 bool override_gid:1;
423 bool dynperm:1;
424 bool noperm:1;
425 bool no_psx_acl:1; /* set if posix acl support should be disabled */
426 bool cifs_acl:1;
3d3ea8e6
SP
427 bool backupuid_specified; /* mount option backupuid is specified */
428 bool backupgid_specified; /* mount option backupgid is specified */
f87d39d9
SF
429 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
430 bool server_ino:1; /* use inode numbers from server ie UniqueId */
431 bool direct_io:1;
432 bool strict_io:1; /* strict cache behavior */
433 bool remap:1; /* set to remap seven reserved chars in filenames */
434 bool posix_paths:1; /* unset to not ask for posix pathnames. */
435 bool no_linux_ext:1;
436 bool sfu_emul:1;
437 bool nullauth:1; /* attempt to authenticate with null user */
438 bool nocase:1; /* request case insensitive filenames */
439 bool nobrl:1; /* disable sending byte range locks to srv */
440 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
441 bool seal:1; /* request transport encryption on share */
442 bool nodfs:1; /* Do not request DFS, even if available */
443 bool local_lease:1; /* check leases only on local system, not remote */
444 bool noblocksnd:1;
445 bool noautotune:1;
446 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
447 bool fsc:1; /* enable fscache */
448 bool mfsymlinks:1; /* use Minshall+French Symlinks */
449 bool multiuser:1;
d4ffff1f 450 bool rwpidforward:1; /* pid forward for read/write operations */
f87d39d9
SF
451 unsigned int rsize;
452 unsigned int wsize;
453 bool sockopt_tcp_nodelay:1;
f87d39d9 454 unsigned long actimeo; /* attribute cache timeout (jiffies) */
23db65f5
JL
455 struct smb_version_operations *ops;
456 struct smb_version_values *vals;
f87d39d9 457 char *prepath;
b979aaa1 458 struct sockaddr_storage dstaddr; /* destination address */
f87d39d9
SF
459 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
460 struct nls_table *local_nls;
461};
462
25c7f41e
PS
463#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
464 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
465 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
466 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
467 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
468 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
469 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
470 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
3d3ea8e6
SP
471 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
472 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
25c7f41e
PS
473
474#define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
475 MS_NODEV | MS_SYNCHRONOUS)
476
477struct cifs_mnt_data {
478 struct cifs_sb_info *cifs_sb;
479 struct smb_vol *vol;
480 int flags;
481};
482
792af7b0
PS
483static inline unsigned int
484get_rfc1002_length(void *buf)
485{
486 return be32_to_cpu(*((__be32 *)buf));
487}
488
ec2e4523
PS
489static inline void
490inc_rfc1001_len(void *buf, int count)
491{
492 be32_add_cpu((__be32 *)buf, count);
493}
494
1da177e4 495struct TCP_Server_Info {
3b795210
SF
496 struct list_head tcp_ses_list;
497 struct list_head smb_ses_list;
e7ddee90 498 int srv_count; /* reference counter */
a10faeb2 499 /* 15 character server name + 0x20 16th byte indicating type = srv */
8ecaf67a 500 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
23db65f5
JL
501 struct smb_version_operations *ops;
502 struct smb_version_values *vals;
c3dccf48 503 enum statusEnum tcpStatus; /* what we think the status is */
c359cf3c 504 char *hostname; /* hostname portion of UNC string */
1da177e4 505 struct socket *ssocket;
a9f1b85e 506 struct sockaddr_storage dstaddr;
3eb9a889 507 struct sockaddr_storage srcaddr; /* locally bind to this IP */
f1d0c998
RL
508#ifdef CONFIG_NET_NS
509 struct net *net;
510#endif
d38d8c74 511 wait_queue_head_t response_q;
1da177e4
LT
512 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
513 struct list_head pending_mid_q;
edf1ae40
SF
514 bool noblocksnd; /* use blocking sendmsg */
515 bool noautotune; /* do not autotune send buf sizes */
6a5fa236 516 bool tcp_nodelay;
2d86dbc9 517 int credits; /* send no more requests at once */
fc40f9cf 518 unsigned int in_flight; /* number of requests on the wire to server */
2d86dbc9 519 spinlock_t req_lock; /* protect the two values above */
72ca545b 520 struct mutex srv_mutex;
1da177e4
LT
521 struct task_struct *tsk;
522 char server_GUID[16];
286170aa 523 __u16 sec_mode;
c3dccf48 524 bool session_estab; /* mark when very first sess is established */
28ea5290
PS
525#ifdef CONFIG_CIFS_SMB2
526 int echo_credits; /* echo reserved slots */
527 int oplock_credits; /* oplock break reserved slots */
528 bool echoes:1; /* enable echoes */
529#endif
c3dccf48 530 u16 dialect; /* dialect index that server chose */
1da177e4 531 enum securityEnum secType;
10b9b98e 532 bool oplocks:1; /* enable oplocks */
1da177e4
LT
533 unsigned int maxReq; /* Clients should submit no more */
534 /* than maxReq distinct unanswered SMBs to the server when using */
535 /* multiplexed reads or writes */
536 unsigned int maxBuf; /* maxBuf specifies the maximum */
537 /* message size the server can send or receive for non-raw SMBs */
7e90d705
SF
538 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
539 /* when socket is setup (and during reconnect) before NegProt sent */
eca6acf9 540 unsigned int max_rw; /* maxRw specifies the maximum */
1da177e4
LT
541 /* message size the server can send or receive for */
542 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
eca6acf9
SF
543 unsigned int max_vcs; /* maximum number of smb sessions, at least
544 those that can be specified uniquely with
545 vcnumbers */
29e20f9c 546 unsigned int capabilities; /* selective disabling of caps by smb sess */
de7ed55d 547 int timeAdj; /* Adjust for difference in server time zone in sec */
243d04b6 548 __u64 CurrentMid; /* multiplex id - rotating counter */
d3ba50b1 549 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
a10faeb2 550 /* 16th byte of RFC1001 workstation name is always null */
8ecaf67a 551 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
a0f8b4fb 552 __u32 sequence_number; /* for signing, protected by srv_mutex */
5f98ca9a 553 struct session_key session_key;
3a5ff61c 554 unsigned long lstrp; /* when we got last response from this server */
d2b91521 555 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
26efa0ba 556 /* extended security flavors that server supports */
c3dccf48
JL
557 bool sec_ntlmssp; /* supports NTLMSSP */
558 bool sec_kerberosu2u; /* supports U2U Kerberos */
26efa0ba
JL
559 bool sec_kerberos; /* supports plain Kerberos */
560 bool sec_mskerberos; /* supports legacy MS Kerberos */
2a37ef94 561 bool large_buf; /* is current buffer large? */
c74093b6 562 struct delayed_work echo; /* echo ping workqueue job */
1041e3f9
JL
563 struct kvec *iov; /* reusable kvec array for receives */
564 unsigned int nr_iov; /* number of kvecs in array */
2a37ef94
JL
565 char *smallbuf; /* pointer to current "small" buffer */
566 char *bigbuf; /* pointer to current "big" buffer */
567 unsigned int total_read; /* total amount of data read in this pass */
488f1d2d
SJ
568#ifdef CONFIG_CIFS_FSCACHE
569 struct fscache_cookie *fscache; /* client index cache cookie */
570#endif
c3dccf48 571#ifdef CONFIG_CIFS_STATS2
789e6661 572 atomic_t in_send; /* requests trying to send */
c3dccf48
JL
573 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
574#endif
ec2e4523
PS
575#ifdef CONFIG_CIFS_SMB2
576 unsigned int max_read;
577 unsigned int max_write;
578#endif /* CONFIG_CIFS_SMB2 */
1da177e4
LT
579};
580
fc40f9cf
PS
581static inline unsigned int
582in_flight(struct TCP_Server_Info *server)
583{
584 unsigned int num;
585 spin_lock(&server->req_lock);
586 num = server->in_flight;
587 spin_unlock(&server->req_lock);
588 return num;
589}
590
2d86dbc9 591static inline bool
bc205ed1 592has_credits(struct TCP_Server_Info *server, int *credits)
fc40f9cf 593{
2d86dbc9 594 int num;
fc40f9cf 595 spin_lock(&server->req_lock);
bc205ed1 596 num = *credits;
fc40f9cf 597 spin_unlock(&server->req_lock);
2d86dbc9 598 return num > 0;
fc40f9cf
PS
599}
600
45275789 601static inline void
a891f0f8
PS
602add_credits(struct TCP_Server_Info *server, const unsigned int add,
603 const int optype)
45275789 604{
a891f0f8 605 server->ops->add_credits(server, add, optype);
45275789
PS
606}
607
608static inline void
609set_credits(struct TCP_Server_Info *server, const int val)
610{
611 server->ops->set_credits(server, val);
612}
613
88257360
PS
614static inline __u64
615get_next_mid(struct TCP_Server_Info *server)
616{
617 return server->ops->get_next_mid(server);
618}
619
24985c53
PS
620/*
621 * When the server supports very large reads and writes via POSIX extensions,
622 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
623 * including the RFC1001 length.
624 *
625 * Note that this might make for "interesting" allocation problems during
626 * writeback however as we have to allocate an array of pointers for the
627 * pages. A 16M write means ~32kb page array with PAGE_CACHE_SIZE == 4096.
628 *
629 * For reads, there is a similar problem as we need to allocate an array
630 * of kvecs to handle the receive, though that should only need to be done
631 * once.
632 */
633#define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
634#define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
635
636/*
637 * When the server doesn't allow large posix writes, only allow a rsize/wsize
638 * of 2^17-1 minus the size of the call header. That allows for a read or
639 * write up to the maximum size described by RFC1002.
640 */
641#define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
642#define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
643
644/*
645 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
646 * pages in a single call. With PAGE_CACHE_SIZE == 4k, this means we can fill
647 * a single wsize request with a single call.
648 */
649#define CIFS_DEFAULT_IOSIZE (1024 * 1024)
650
651/*
652 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
653 * those values when posix extensions aren't in force. In actuality here, we
654 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
655 * to be ok with the extra byte even though Windows doesn't send writes that
656 * are that large.
657 *
658 * Citation:
659 *
660 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
661 */
662#define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
663#define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
664
f1d0c998
RL
665/*
666 * Macros to allow the TCP_Server_Info->net field and related code to drop out
667 * when CONFIG_NET_NS isn't set.
668 */
669
670#ifdef CONFIG_NET_NS
671
672static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
673{
674 return srv->net;
675}
676
677static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
678{
679 srv->net = net;
680}
681
682#else
683
684static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
685{
686 return &init_net;
687}
688
689static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
690{
691}
692
693#endif
694
1da177e4
LT
695/*
696 * Session structure. One of these for each uid session with a particular host
697 */
96daf2b0 698struct cifs_ses {
14fbf50d 699 struct list_head smb_ses_list;
3b795210 700 struct list_head tcon_list;
d7b619cf 701 struct mutex session_mutex;
1da177e4 702 struct TCP_Server_Info *server; /* pointer to server info */
14fbf50d 703 int ses_count; /* reference counter */
1da177e4 704 enum statusEnum status;
750d1151 705 unsigned overrideSecFlg; /* if non-zero override global sec flags */
1da177e4
LT
706 __u16 ipc_tid; /* special tid for connection to IPC share */
707 __u16 flags;
eca6acf9 708 __u16 vcnum;
ad009ac9
SF
709 char *serverOS; /* name of operating system underlying server */
710 char *serverNOS; /* name of network operating system of server */
1da177e4 711 char *serverDomain; /* security realm of server */
286170aa 712 __u64 Suid; /* remote smb uid */
64ed39dd
EB
713 kuid_t linux_uid; /* overriding owner of files on the mount */
714 kuid_t cred_uid; /* owner of credentials */
29e20f9c 715 unsigned int capabilities;
d38d8c74 716 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
ad009ac9 717 TCP names - will ipv6 and sctp addresses fit? */
34c87901
SF
718 char *user_name; /* must not be null except during init of sess
719 and after mount option parsing we fill it */
d38d8c74
SF
720 char *domainName;
721 char *password;
5d0d2882 722 struct session_key auth_key;
d3686d54 723 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
3b795210 724 bool need_reconnect:1; /* connection reset, uid now invalid */
5478f9ba
PS
725#ifdef CONFIG_CIFS_SMB2
726 __u16 session_flags;
727#endif /* CONFIG_CIFS_SMB2 */
1da177e4 728};
233839b1 729
9ac00b7d 730/* no more than one of the following three session flags may be set */
1da177e4 731#define CIFS_SES_NT4 1
9ac00b7d
SF
732#define CIFS_SES_OS2 2
733#define CIFS_SES_W9X 4
734/* following flag is set for old servers such as OS2 (and Win95?)
735 which do not negotiate NTLM or POSIX dialects, but instead
736 negotiate one of the older LANMAN dialects */
737#define CIFS_SES_LANMAN 8
29e20f9c
PS
738
739static inline bool
740cap_unix(struct cifs_ses *ses)
741{
742 return ses->server->vals->cap_unix & ses->capabilities;
743}
744
1da177e4
LT
745/*
746 * there is one of these for each connection to a resource on a particular
d38d8c74 747 * session
1da177e4 748 */
96daf2b0 749struct cifs_tcon {
f1987b44
JL
750 struct list_head tcon_list;
751 int tc_count;
1da177e4 752 struct list_head openFileList;
96daf2b0 753 struct cifs_ses *ses; /* pointer to session associated with */
254e55ed 754 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1da177e4 755 char *nativeFileSystem;
00e485b0 756 char *password; /* for share-level security */
faaf946a 757 __u32 tid; /* The 4 byte tree id */
1da177e4
LT
758 __u16 Flags; /* optional support bits */
759 enum statusEnum tidStatus;
1da177e4
LT
760#ifdef CONFIG_CIFS_STATS
761 atomic_t num_smbs_sent;
44c58186
PS
762 union {
763 struct {
764 atomic_t num_writes;
765 atomic_t num_reads;
766 atomic_t num_flushes;
767 atomic_t num_oplock_brks;
768 atomic_t num_opens;
769 atomic_t num_closes;
770 atomic_t num_deletes;
771 atomic_t num_mkdirs;
772 atomic_t num_posixopens;
773 atomic_t num_posixmkdirs;
774 atomic_t num_rmdirs;
775 atomic_t num_renames;
776 atomic_t num_t2renames;
777 atomic_t num_ffirst;
778 atomic_t num_fnext;
779 atomic_t num_fclose;
780 atomic_t num_hardlinks;
781 atomic_t num_symlinks;
782 atomic_t num_locks;
783 atomic_t num_acl_get;
784 atomic_t num_acl_set;
785 } cifs_stats;
d60622eb
PS
786#ifdef CONFIG_CIFS_SMB2
787 struct {
788 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
789 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
790 } smb2_stats;
791#endif /* CONFIG_CIFS_SMB2 */
44c58186 792 } stats;
a5a2b489
SF
793#ifdef CONFIG_CIFS_STATS2
794 unsigned long long time_writes;
795 unsigned long long time_reads;
796 unsigned long long time_opens;
797 unsigned long long time_deletes;
798 unsigned long long time_closes;
799 unsigned long long time_mkdirs;
800 unsigned long long time_rmdirs;
801 unsigned long long time_renames;
802 unsigned long long time_t2renames;
803 unsigned long long time_ffirst;
804 unsigned long long time_fnext;
805 unsigned long long time_fclose;
806#endif /* CONFIG_CIFS_STATS2 */
1da177e4
LT
807 __u64 bytes_read;
808 __u64 bytes_written;
809 spinlock_t stat_lock;
a5a2b489 810#endif /* CONFIG_CIFS_STATS */
1da177e4 811 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
254e55ed 812 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1da177e4 813 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
4b18f2a9
SF
814 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
815 bool retry:1;
816 bool nocase:1;
95b1cb90 817 bool seal:1; /* transport encryption for this mounted share */
4b18f2a9 818 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
c18c842b 819 for this mount even if server would support */
84210e91 820 bool local_lease:1; /* check leases (only) on local system not remote */
64cc2c63 821 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
3b795210 822 bool need_reconnect:1; /* connection reset, tid now invalid */
faaf946a
PS
823#ifdef CONFIG_CIFS_SMB2
824 bool print:1; /* set if connection to printer share */
825 bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
826 __u32 capabilities;
827 __u32 share_flags;
828 __u32 maximal_access;
829 __u32 vol_serial_number;
830 __le64 vol_create_time;
831#endif /* CONFIG_CIFS_SMB2 */
d03382ce
SJ
832#ifdef CONFIG_CIFS_FSCACHE
833 u64 resource_id; /* server resource id */
834 struct fscache_cookie *fscache; /* cookie for share */
835#endif
233839b1 836 struct list_head pending_opens; /* list of incomplete opens */
c18c842b 837 /* BB add field for back pointer to sb struct(s)? */
1da177e4
LT
838};
839
7ffec372
JL
840/*
841 * This is a refcounted and timestamped container for a tcon pointer. The
842 * container holds a tcon reference. It is considered safe to free one of
843 * these when the tl_count goes to 0. The tl_time is the time of the last
844 * "get" on the container.
845 */
846struct tcon_link {
b647c35f 847 struct rb_node tl_rbnode;
6d4a0832 848 kuid_t tl_uid;
9d002df4
JL
849 unsigned long tl_flags;
850#define TCON_LINK_MASTER 0
851#define TCON_LINK_PENDING 1
852#define TCON_LINK_IN_TREE 2
853 unsigned long tl_time;
854 atomic_t tl_count;
96daf2b0 855 struct cifs_tcon *tl_tcon;
7ffec372
JL
856};
857
9d002df4 858extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
7ffec372 859
96daf2b0 860static inline struct cifs_tcon *
7ffec372
JL
861tlink_tcon(struct tcon_link *tlink)
862{
9d002df4 863 return tlink->tl_tcon;
7ffec372
JL
864}
865
9d002df4 866extern void cifs_put_tlink(struct tcon_link *tlink);
7ffec372 867
13cfb733
JL
868static inline struct tcon_link *
869cifs_get_tlink(struct tcon_link *tlink)
870{
9d002df4
JL
871 if (tlink && !IS_ERR(tlink))
872 atomic_inc(&tlink->tl_count);
13cfb733
JL
873 return tlink;
874}
875
7ffec372 876/* This function is always expected to succeed */
96daf2b0 877extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
7ffec372 878
233839b1
PS
879#define CIFS_OPLOCK_NO_CHANGE 0xfe
880
881struct cifs_pending_open {
882 struct list_head olist;
883 struct tcon_link *tlink;
884 __u8 lease_key[16];
885 __u32 oplock;
886};
887
1da177e4 888/*
7ee1af76
JA
889 * This info hangs off the cifsFileInfo structure, pointed to by llist.
890 * This is used to track byte stream locks on the file
1da177e4
LT
891 */
892struct cifsLockInfo {
7ee1af76 893 struct list_head llist; /* pointer to next cifsLockInfo */
85160e03
PS
894 struct list_head blist; /* pointer to locks blocked on this */
895 wait_queue_head_t block_q;
7ee1af76
JA
896 __u64 offset;
897 __u64 length;
03776f45 898 __u32 pid;
04a6aa8a 899 __u32 type;
1da177e4
LT
900};
901
902/*
903 * One of these for each open instance of a file
904 */
905struct cifs_search_info {
906 loff_t index_of_last_entry;
907 __u16 entries_in_buffer;
908 __u16 info_level;
909 __u32 resume_key;
d38d8c74
SF
910 char *ntwrk_buf_start;
911 char *srch_entries_start;
0752f152 912 char *last_entry;
eaf35b1e 913 const char *presume_name;
1da177e4 914 unsigned int resume_name_len;
4b18f2a9
SF
915 bool endOfSearch:1;
916 bool emptyDir:1;
917 bool unicode:1;
918 bool smallBuf:1; /* so we know which buf_release function to call */
1da177e4
LT
919};
920
4b4de76e
PS
921struct cifs_fid {
922 __u16 netfid;
f0df737e
PS
923#ifdef CONFIG_CIFS_SMB2
924 __u64 persistent_fid; /* persist file id for smb2 */
925 __u64 volatile_fid; /* volatile file id for smb2 */
b8c32dbb 926 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
f0df737e 927#endif
233839b1 928 struct cifs_pending_open *pending_open;
4b4de76e
PS
929};
930
f45d3416
PS
931struct cifs_fid_locks {
932 struct list_head llist;
933 struct cifsFileInfo *cfile; /* fid that owns locks */
934 struct list_head locks; /* locks held by fid above */
935};
936
1da177e4
LT
937struct cifsFileInfo {
938 struct list_head tlist; /* pointer to next fid owned by tcon */
939 struct list_head flist; /* next fid (file instance) for this inode */
f45d3416 940 struct cifs_fid_locks *llist; /* brlocks held by this fid */
fef59fd7 941 kuid_t uid; /* allows finding which FileInfo structure */
1da177e4 942 __u32 pid; /* process id who opened file */
4b4de76e 943 struct cifs_fid fid; /* file id from remote */
1da177e4
LT
944 /* BB add lock scope info here if needed */ ;
945 /* lock scope id (0 if none) */
a5e18bc3 946 struct dentry *dentry;
15886177 947 unsigned int f_flags;
13cfb733 948 struct tcon_link *tlink;
4b18f2a9 949 bool invalidHandle:1; /* file closed via session abend */
3bc303c2 950 bool oplock_break_cancelled:1;
6c0f6218 951 int count; /* refcount protected by cifs_file_list_lock */
a6ce4932 952 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1da177e4 953 struct cifs_search_info srch_inf;
9b646972 954 struct work_struct oplock_break; /* work for oplock breaks */
1da177e4
LT
955};
956
fa2989f4
PS
957struct cifs_io_parms {
958 __u16 netfid;
09a4707e
PS
959#ifdef CONFIG_CIFS_SMB2
960 __u64 persistent_fid; /* persist file id for smb2 */
961 __u64 volatile_fid; /* volatile file id for smb2 */
962#endif
fa2989f4
PS
963 __u32 pid;
964 __u64 offset;
965 unsigned int length;
96daf2b0 966 struct cifs_tcon *tcon;
fa2989f4
PS
967};
968
09a4707e
PS
969struct cifs_readdata;
970
971/* asynchronous read support */
972struct cifs_readdata {
973 struct kref refcount;
974 struct list_head list;
975 struct completion done;
976 struct cifsFileInfo *cfile;
977 struct address_space *mapping;
978 __u64 offset;
979 unsigned int bytes;
980 pid_t pid;
981 int result;
09a4707e 982 struct work_struct work;
8321fec4
JL
983 int (*read_into_pages)(struct TCP_Server_Info *server,
984 struct cifs_readdata *rdata,
985 unsigned int len);
5819575e 986 struct kvec iov;
8321fec4
JL
987 unsigned int pagesz;
988 unsigned int tailsz;
c5fab6f4
JL
989 unsigned int nr_pages;
990 struct page *pages[];
09a4707e
PS
991};
992
33319141
PS
993struct cifs_writedata;
994
995/* asynchronous write support */
996struct cifs_writedata {
997 struct kref refcount;
998 struct list_head list;
999 struct completion done;
1000 enum writeback_sync_modes sync_mode;
1001 struct work_struct work;
1002 struct cifsFileInfo *cfile;
1003 __u64 offset;
1004 pid_t pid;
1005 unsigned int bytes;
1006 int result;
eddb079d
JL
1007 unsigned int pagesz;
1008 unsigned int tailsz;
33319141
PS
1009 unsigned int nr_pages;
1010 struct page *pages[1];
1011};
1012
5f6dbc9e
JL
1013/*
1014 * Take a reference on the file private data. Must be called with
1015 * cifs_file_list_lock held.
1016 */
764a1b1a
JL
1017static inline void
1018cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
6ab409b5 1019{
5f6dbc9e 1020 ++cifs_file->count;
6ab409b5
DK
1021}
1022
764a1b1a 1023struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
b33879aa 1024void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
6ab409b5 1025
1da177e4
LT
1026/*
1027 * One of these for each file inode
1028 */
1029
1030struct cifsInodeInfo {
d59dad2b 1031 bool can_cache_brlcks;
f45d3416 1032 struct list_head llist; /* locks helb by this inode */
1b4b55a1 1033 struct rw_semaphore lock_sem; /* protect the fields above */
d38d8c74 1034 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1da177e4 1035 struct list_head openFileList;
1da177e4 1036 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
aae62fdb
JL
1037 bool clientCanCacheRead; /* read oplock */
1038 bool clientCanCacheAll; /* read and writebehind oplock */
1039 bool delete_pending; /* DELETE_ON_CLOSE is set */
1040 bool invalid_mapping; /* pagecache is invalid */
1041 unsigned long time; /* jiffies of last update of inode */
597b027f 1042 u64 server_eof; /* current file size on server -- protected by i_lock */
cc0bad75 1043 u64 uniqueid; /* server inode number */
20054bd6 1044 u64 createtime; /* creation time on server */
b8c32dbb
PS
1045#ifdef CONFIG_CIFS_SMB2
1046 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1047#endif
9451a9a5
SJ
1048#ifdef CONFIG_CIFS_FSCACHE
1049 struct fscache_cookie *fscache;
1050#endif
1da177e4
LT
1051 struct inode vfs_inode;
1052};
1053
1054static inline struct cifsInodeInfo *
1055CIFS_I(struct inode *inode)
1056{
1057 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1058}
1059
1060static inline struct cifs_sb_info *
1061CIFS_SB(struct super_block *sb)
1062{
1063 return sb->s_fs_info;
1064}
1065
ab2f218f 1066static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
ac67055e
JA
1067{
1068 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1069 return '/';
1070 else
1071 return '\\';
1072}
1da177e4 1073
f87d39d9
SF
1074static inline void
1075convert_delimiter(char *path, char delim)
1076{
1cc9bd68 1077 char old_delim, *pos;
f87d39d9
SF
1078
1079 if (delim == '/')
1080 old_delim = '\\';
1081 else
1082 old_delim = '/';
1083
1cc9bd68
SF
1084 pos = path;
1085 while ((pos = strchr(pos, old_delim)))
1086 *pos = delim;
f87d39d9
SF
1087}
1088
a4544347
SF
1089#ifdef CONFIG_CIFS_STATS
1090#define cifs_stats_inc atomic_inc
1091
96daf2b0 1092static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
a4544347
SF
1093 unsigned int bytes)
1094{
1095 if (bytes) {
1096 spin_lock(&tcon->stat_lock);
1097 tcon->bytes_written += bytes;
1098 spin_unlock(&tcon->stat_lock);
1099 }
1100}
1101
96daf2b0 1102static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
a4544347
SF
1103 unsigned int bytes)
1104{
1105 spin_lock(&tcon->stat_lock);
1106 tcon->bytes_read += bytes;
1107 spin_unlock(&tcon->stat_lock);
1108}
1109#else
1110
d38d8c74
SF
1111#define cifs_stats_inc(field) do {} while (0)
1112#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1113#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
a4544347
SF
1114
1115#endif
1116
2b84a36c
JL
1117
1118/*
44d22d84
JL
1119 * This is the prototype for the mid receive function. This function is for
1120 * receiving the rest of the SMB frame, starting with the WordCount (which is
1121 * just after the MID in struct smb_hdr). Note:
1122 *
1123 * - This will be called by cifsd, with no locks held.
1124 * - The mid will still be on the pending_mid_q.
1125 * - mid->resp_buf will point to the current buffer.
1126 *
1127 * Returns zero on a successful receive, or an error. The receive state in
1128 * the TCP_Server_Info will also be updated.
1129 */
1130typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1131 struct mid_q_entry *mid);
1132
1133/*
1134 * This is the prototype for the mid callback function. This is called once the
1135 * mid has been received off of the socket. When creating one, take special
1136 * care to avoid deadlocks. Things to bear in mind:
2b84a36c 1137 *
3c1105df
JL
1138 * - it will be called by cifsd, with no locks held
1139 * - the mid will be removed from any lists
2b84a36c
JL
1140 */
1141typedef void (mid_callback_t)(struct mid_q_entry *mid);
1142
1da177e4
LT
1143/* one of these for every pending CIFS request to the server */
1144struct mid_q_entry {
1145 struct list_head qhead; /* mids waiting on reply from this server */
2dc7e1c0 1146 struct TCP_Server_Info *server; /* server corresponding to this mid */
7c9421e1
PS
1147 __u64 mid; /* multiplex id */
1148 __u32 pid; /* process id */
1da177e4 1149 __u32 sequence_number; /* for CIFS signing */
1047abc1
SF
1150 unsigned long when_alloc; /* when mid was created */
1151#ifdef CONFIG_CIFS_STATS2
1152 unsigned long when_sent; /* time when smb send finished */
1153 unsigned long when_received; /* when demux complete (taken off wire) */
1154#endif
44d22d84 1155 mid_receive_t *receive; /* call receive callback */
2b84a36c
JL
1156 mid_callback_t *callback; /* call completion callback */
1157 void *callback_data; /* general purpose pointer for callback */
d4e4854f 1158 void *resp_buf; /* pointer to received SMB header */
7c9421e1
PS
1159 int mid_state; /* wish this were enum but can not pass to wait_event */
1160 __le16 command; /* smb command code */
1161 bool large_buf:1; /* if valid response, is pointer to large buf */
4b18f2a9
SF
1162 bool multiRsp:1; /* multiple trans2 responses for one request */
1163 bool multiEnd:1; /* both received */
1da177e4
LT
1164};
1165
789e6661
SF
1166/* Make code in transport.c a little cleaner by moving
1167 update of optional stats into function below */
1168#ifdef CONFIG_CIFS_STATS2
1169
1170static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1171{
1172 atomic_inc(&server->in_send);
1173}
1174
1175static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1176{
1177 atomic_dec(&server->in_send);
1178}
1179
1180static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1181{
1182 atomic_inc(&server->num_waiters);
1183}
1184
1185static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1186{
1187 atomic_dec(&server->num_waiters);
1188}
1189
1190static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1191{
1192 mid->when_sent = jiffies;
1193}
1194#else
1195static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1196{
1197}
1198static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1199{
1200}
1201
1202static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1203{
1204}
1205
1206static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1207{
1208}
1209
1210static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1211{
1212}
1213#endif
1da177e4 1214
ff5dbd9e
SF
1215/* for pending dnotify requests */
1216struct dir_notify_req {
13cd4b7f
SF
1217 struct list_head lhead;
1218 __le16 Pid;
1219 __le16 PidHigh;
1220 __u16 Mid;
1221 __u16 Tid;
1222 __u16 Uid;
1223 __u16 netfid;
1224 __u32 filter; /* CompletionFilter (for multishot) */
1225 int multishot;
1226 struct file *pfile;
ff5dbd9e
SF
1227};
1228
366781c1
SF
1229struct dfs_info3_param {
1230 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
8aad018b 1231 int path_consumed;
366781c1
SF
1232 int server_type;
1233 int ref_flag;
1234 char *path_name;
1235 char *node_name;
1236};
1237
cc0bad75
JL
1238/*
1239 * common struct for holding inode info when searching for or updating an
1240 * inode with new info
1241 */
1242
1243#define CIFS_FATTR_DFS_REFERRAL 0x1
0b8f18e3
JL
1244#define CIFS_FATTR_DELETE_PENDING 0x2
1245#define CIFS_FATTR_NEED_REVAL 0x4
3d694380 1246#define CIFS_FATTR_INO_COLLISION 0x8
cc0bad75
JL
1247
1248struct cifs_fattr {
1249 u32 cf_flags;
1250 u32 cf_cifsattrs;
1251 u64 cf_uniqueid;
1252 u64 cf_eof;
1253 u64 cf_bytes;
20054bd6 1254 u64 cf_createtime;
4a2c8cf5
EB
1255 kuid_t cf_uid;
1256 kgid_t cf_gid;
cc0bad75
JL
1257 umode_t cf_mode;
1258 dev_t cf_rdev;
1259 unsigned int cf_nlink;
1260 unsigned int cf_dtype;
1261 struct timespec cf_atime;
1262 struct timespec cf_mtime;
1263 struct timespec cf_ctime;
1264};
1265
366781c1
SF
1266static inline void free_dfs_info_param(struct dfs_info3_param *param)
1267{
1268 if (param) {
1269 kfree(param->path_name);
1270 kfree(param->node_name);
1271 kfree(param);
1272 }
1273}
1274
1275static inline void free_dfs_info_array(struct dfs_info3_param *param,
1276 int number_of_items)
1277{
1278 int i;
1279 if ((number_of_items == 0) || (param == NULL))
1280 return;
1281 for (i = 0; i < number_of_items; i++) {
1282 kfree(param[i].path_name);
1283 kfree(param[i].node_name);
1284 }
1285 kfree(param);
1286}
1287
1da177e4
LT
1288#define MID_FREE 0
1289#define MID_REQUEST_ALLOCATED 1
1290#define MID_REQUEST_SUBMITTED 2
1291#define MID_RESPONSE_RECEIVED 4
1292#define MID_RETRY_NEEDED 8 /* session closed while this request out */
71823baf 1293#define MID_RESPONSE_MALFORMED 0x10
3c1105df 1294#define MID_SHUTDOWN 0x20
ec637e3f
SF
1295
1296/* Types of response buffer returned from SendReceive2 */
1297#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1298#define CIFS_SMALL_BUFFER 1
1299#define CIFS_LARGE_BUFFER 2
1300#define CIFS_IOVEC 4 /* array of response buffers */
1da177e4 1301
133672ef 1302/* Type of Request to SendReceive2 */
7749981e
JL
1303#define CIFS_BLOCKING_OP 1 /* operation can block */
1304#define CIFS_ASYNC_OP 2 /* do not wait for response */
1305#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
133672ef
SF
1306#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1307#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1308#define CIFS_NO_RESP 0x040 /* no response buffer required */
1309
a891f0f8
PS
1310/* Type of request operation */
1311#define CIFS_ECHO_OP 0x080 /* echo request */
1312#define CIFS_OBREAK_OP 0x0100 /* oplock break request */
ec2e4523
PS
1313#define CIFS_NEG_OP 0x0200 /* negotiate request */
1314#define CIFS_OP_MASK 0x0380 /* mask request type */
a891f0f8 1315
3979877e
SF
1316/* Security Flags: indicate type of session setup needed */
1317#define CIFSSEC_MAY_SIGN 0x00001
1318#define CIFSSEC_MAY_NTLM 0x00002
1319#define CIFSSEC_MAY_NTLMV2 0x00004
1320#define CIFSSEC_MAY_KRB5 0x00008
1321#ifdef CONFIG_CIFS_WEAK_PW_HASH
1322#define CIFSSEC_MAY_LANMAN 0x00010
1323#define CIFSSEC_MAY_PLNTXT 0x00020
516897a2
SF
1324#else
1325#define CIFSSEC_MAY_LANMAN 0
1326#define CIFSSEC_MAY_PLNTXT 0
3979877e
SF
1327#endif /* weak passwords */
1328#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
ac683924 1329#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
3979877e
SF
1330
1331#define CIFSSEC_MUST_SIGN 0x01001
1332/* note that only one of the following can be set so the
1333result of setting MUST flags more than once will be to
1334require use of the stronger protocol */
1335#define CIFSSEC_MUST_NTLM 0x02002
1336#define CIFSSEC_MUST_NTLMV2 0x04004
1337#define CIFSSEC_MUST_KRB5 0x08008
1338#ifdef CONFIG_CIFS_WEAK_PW_HASH
1339#define CIFSSEC_MUST_LANMAN 0x10010
1340#define CIFSSEC_MUST_PLNTXT 0x20020
0d3a01fa 1341#ifdef CONFIG_CIFS_UPCALL
20d1752f 1342#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
0d3a01fa 1343#else
20d1752f 1344#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
016ec75f 1345#endif /* UPCALL */
0d3a01fa 1346#else /* do not allow weak pw hash */
88a4412b
SF
1347#define CIFSSEC_MUST_LANMAN 0
1348#define CIFSSEC_MUST_PLNTXT 0
0d3a01fa 1349#ifdef CONFIG_CIFS_UPCALL
ac683924 1350#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
d38d8c74 1351#else
ac683924 1352#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
016ec75f 1353#endif /* UPCALL */
3979877e
SF
1354#endif /* WEAK_PW_HASH */
1355#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
ac683924 1356#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
3979877e 1357
81bcd8b7 1358#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMSSP)
ef571cad 1359#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
ac683924 1360#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1da177e4
LT
1361/*
1362 *****************************************************************
1363 * All constants go here
1364 *****************************************************************
1365 */
1366
1367#define UID_HASH (16)
1368
1369/*
1370 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1371 * following to be declared.
1372 */
1373
1374/****************************************************************************
1375 * Locking notes. All updates to global variables and lists should be
1376 * protected by spinlocks or semaphores.
1377 *
1378 * Spinlocks
1379 * ---------
1380 * GlobalMid_Lock protects:
1381 * list operations on pending_mid_q and oplockQ
1382 * updates to XID counters, multiplex id and SMB sequence numbers
6573e9b7 1383 * cifs_file_list_lock protects:
1da177e4
LT
1384 * list operations on tcp and SMB session lists and tCon lists
1385 * f_owner.lock protects certain per file struct operations
1386 * mapping->page_lock protects certain per page operations
1387 *
1388 * Semaphores
1389 * ----------
1390 * sesSem operations on smb session
1391 * tconSem operations on tree connection
d38d8c74 1392 * fh_sem file handle reconnection operations
1da177e4
LT
1393 *
1394 ****************************************************************************/
1395
1396#ifdef DECLARE_GLOBALS_HERE
1397#define GLOBAL_EXTERN
1398#else
1399#define GLOBAL_EXTERN extern
1400#endif
1401
e7ddee90
JL
1402/*
1403 * the list of TCP_Server_Info structures, ie each of the sockets
fb396016 1404 * connecting our client to a distinct server (ip address), is
e7ddee90 1405 * chained together by cifs_tcp_ses_list. The list of all our SMB
fb396016 1406 * sessions (and from that the tree connections) can be found
e7ddee90
JL
1407 * by iterating over cifs_tcp_ses_list
1408 */
1409GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1410
f1987b44
JL
1411/*
1412 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1413 * tcp session, and the list of tcon's per smb session. It also protects
1414 * the reference counters for the server, smb session, and tcon. Finally,
1415 * changes to the tcon->tidStatus should be done while holding this lock.
1416 */
3f9bcca7 1417GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
ddb4cbfc
SF
1418
1419/*
1420 * This lock protects the cifs_file->llist and cifs_file->flist
1421 * list operations, and updates to some flags (cifs_file->invalidHandle)
1422 * It will be moved to either use the tcon->stat_lock or equivalent later.
1423 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1424 * the cifs_tcp_ses_lock must be grabbed first and released last.
1425 */
4477288a 1426GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1da177e4 1427
0eff0e26 1428#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
99ee4dbd
SF
1429/* Outstanding dir notify requests */
1430GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1431/* DirNotify response queue */
1432GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
0eff0e26 1433#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
ff5dbd9e 1434
1da177e4
LT
1435/*
1436 * Global transaction id (XID) information
1437 */
1438GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
254e55ed 1439GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1da177e4 1440GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
254e55ed
SF
1441GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1442 /* on midQ entries */
1da177e4
LT
1443/*
1444 * Global counters, updated atomically
1445 */
1446GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1447GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1448GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1449GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1450GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1451
aaa9bbe0 1452/* Various Debug counters */
4498eed5
SF
1453GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1454#ifdef CONFIG_CIFS_STATS2
1455GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1456GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1457#endif
1458GLOBAL_EXTERN atomic_t smBufAllocCount;
1da177e4
LT
1459GLOBAL_EXTERN atomic_t midCount;
1460
1461/* Misc globals */
5e500ed1 1462GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1da177e4 1463GLOBAL_EXTERN unsigned int lookupCacheEnabled;
04912d6a 1464GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1da177e4 1465 with more secure ntlmssp2 challenge/resp */
1da177e4
LT
1466GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1467GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1468GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1469GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1470GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1471GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1472
21fed0d5 1473#ifdef CONFIG_CIFS_ACL
4d79dba0
SP
1474GLOBAL_EXTERN struct rb_root uidtree;
1475GLOBAL_EXTERN struct rb_root gidtree;
1476GLOBAL_EXTERN spinlock_t siduidlock;
1477GLOBAL_EXTERN spinlock_t sidgidlock;
21fed0d5
SP
1478GLOBAL_EXTERN struct rb_root siduidtree;
1479GLOBAL_EXTERN struct rb_root sidgidtree;
1480GLOBAL_EXTERN spinlock_t uidsidlock;
1481GLOBAL_EXTERN spinlock_t gidsidlock;
1482#endif /* CONFIG_CIFS_ACL */
4d79dba0 1483
9b646972 1484void cifs_oplock_break(struct work_struct *work);
3b7433b8 1485
3bc303c2 1486extern const struct slow_work_ops cifs_oplock_break_ops;
da472fc8 1487extern struct workqueue_struct *cifsiod_wq;
abd2e44d 1488
2dc7e1c0
PS
1489extern mempool_t *cifs_mid_poolp;
1490
23db65f5
JL
1491/* Operations for different SMB versions */
1492#define SMB1_VERSION_STRING "1.0"
1493extern struct smb_version_operations smb1_operations;
1494extern struct smb_version_values smb1_values;
e4aa25e7
SF
1495#define SMB20_VERSION_STRING "2.0"
1496/*extern struct smb_version_operations smb20_operations; */ /* not needed yet */
1497extern struct smb_version_values smb20_values;
1080ef75
SF
1498#define SMB21_VERSION_STRING "2.1"
1499extern struct smb_version_operations smb21_operations;
1500extern struct smb_version_values smb21_values;
e4aa25e7 1501#define SMB30_VERSION_STRING "3.0"
38107d45 1502extern struct smb_version_operations smb30_operations;
e4aa25e7 1503extern struct smb_version_values smb30_values;
abd2e44d 1504#endif /* _CIFS_GLOB_H */