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