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