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