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