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