cifs: clean up check_rfc1002_header
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / fs / cifs / cifsglob.h
CommitLineData
1da177e4
LT
1/*
2 * fs/cifs/cifsglob.h
3 *
366781c1 4 * Copyright (C) International Business Machines Corp., 2002,2008
1da177e4 5 * Author(s): Steve French (sfrench@us.ibm.com)
7ee1af76 6 * Jeremy Allison (jra@samba.org)
1da177e4
LT
7 *
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
d38d8c74 17 *
1da177e4 18 */
abd2e44d
SJ
19#ifndef _CIFS_GLOB_H
20#define _CIFS_GLOB_H
21
1da177e4
LT
22#include <linux/in.h>
23#include <linux/in6.h>
5a0e3ad6 24#include <linux/slab.h>
9b646972 25#include <linux/workqueue.h>
1da177e4 26#include "cifs_fs_sb.h"
442aa310 27#include "cifsacl.h"
d2b91521
SP
28#include <crypto/internal/hash.h>
29#include <linux/scatterlist.h>
30
1da177e4
LT
31/*
32 * The sizes of various internal tables and strings
33 */
34#define MAX_UID_INFO 16
35#define MAX_SES_INFO 2
36#define MAX_TCON_INFO 4
37
ef571cad 38#define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
1da177e4 39#define MAX_SERVER_SIZE 15
2e325d59 40#define MAX_SHARE_SIZE 80
8727c8a8
SF
41#define MAX_USERNAME_SIZE 256 /* reasonable maximum for current servers */
42#define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
1da177e4
LT
43
44#define CIFS_MIN_RCV_POOL 4
45
6d20e840
SJ
46/*
47 * default attribute cache timeout (jiffies)
48 */
49#define CIFS_DEF_ACTIMEO (1 * HZ)
50
51/*
52 * max attribute cache timeout (jiffies) - 2^30
53 */
54#define CIFS_MAX_ACTIMEO (1 << 30)
55
1da177e4
LT
56/*
57 * MAX_REQ is the maximum number of requests that WE will send
af901ca1 58 * on one socket concurrently. It also matches the most common
d38d8c74 59 * value of max multiplex returned by servers. We may
1da177e4
LT
60 * eventually want to use the negotiated value (in case
61 * future servers can handle more) when we are more confident that
62 * we will not have problems oveloading the socket with pending
63 * write data.
64 */
d38d8c74 65#define CIFS_MAX_REQ 50
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
79#include "cifspdu.h"
80
1da177e4
LT
81#ifndef XATTR_DOS_ATTRIB
82#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
83#endif
84
1da177e4
LT
85/*
86 * CIFS vfs client Status information (based on what we know.)
87 */
88
6c0f6218 89/* associated with each tcp and smb session */
1da177e4
LT
90enum statusEnum {
91 CifsNew = 0,
92 CifsGood,
93 CifsExiting,
fd88ce93
SF
94 CifsNeedReconnect,
95 CifsNeedNegotiate
1da177e4
LT
96};
97
98enum securityEnum {
daf5b0b6 99 LANMAN = 0, /* Legacy LANMAN auth */
3979877e 100 NTLM, /* Legacy NTLM012 auth with NTLM hash */
1da177e4 101 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
ac683924 102 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
f46c7234 103/* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
c16fefa5 104 Kerberos, /* Kerberos via SPNEGO */
1da177e4
LT
105};
106
107enum protocolEnum {
3ec332ef 108 TCP = 0,
1da177e4
LT
109 SCTP
110 /* Netbios frames protocol not supported at this time */
111};
112
5f98ca9a 113struct session_key {
b609f06a 114 unsigned int len;
21e73393 115 char *response;
b609f06a
SF
116};
117
d2b91521
SP
118/* crypto security descriptor definition */
119struct sdesc {
120 struct shash_desc shash;
121 char ctx[];
122};
123
f7c5445a 124/* crypto hashing related structure/fields, not specific to a sec mech */
d2b91521
SP
125struct cifs_secmech {
126 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
127 struct crypto_shash *md5; /* md5 hash function */
128 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
129 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
130};
131
d3686d54 132/* per smb session structure/fields */
d2b91521
SP
133struct ntlmssp_auth {
134 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
135 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
136 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
d3686d54 137 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
d2b91521
SP
138};
139
442aa310
SF
140struct cifs_cred {
141 int uid;
142 int gid;
143 int mode;
144 int cecount;
145 struct cifs_sid osid;
146 struct cifs_sid gsid;
147 struct cifs_ntace *ntaces;
148 struct cifs_ace *aces;
149};
150
1da177e4
LT
151/*
152 *****************************************************************
153 * Except the CIFS PDUs themselves all the
154 * globally interesting structs should go here
155 *****************************************************************
156 */
157
f87d39d9
SF
158struct smb_vol {
159 char *username;
160 char *password;
161 char *domainname;
162 char *UNC;
163 char *UNCip;
164 char *iocharset; /* local code page for mapping to and from Unicode */
165 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
166 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
167 uid_t cred_uid;
168 uid_t linux_uid;
169 gid_t linux_gid;
3d3ea8e6
SP
170 uid_t backupuid;
171 gid_t backupgid;
f87d39d9
SF
172 mode_t file_mode;
173 mode_t dir_mode;
174 unsigned secFlg;
175 bool retry:1;
176 bool intr:1;
177 bool setuids:1;
178 bool override_uid:1;
179 bool override_gid:1;
180 bool dynperm:1;
181 bool noperm:1;
182 bool no_psx_acl:1; /* set if posix acl support should be disabled */
183 bool cifs_acl:1;
3d3ea8e6
SP
184 bool backupuid_specified; /* mount option backupuid is specified */
185 bool backupgid_specified; /* mount option backupgid is specified */
f87d39d9
SF
186 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
187 bool server_ino:1; /* use inode numbers from server ie UniqueId */
188 bool direct_io:1;
189 bool strict_io:1; /* strict cache behavior */
190 bool remap:1; /* set to remap seven reserved chars in filenames */
191 bool posix_paths:1; /* unset to not ask for posix pathnames. */
192 bool no_linux_ext:1;
193 bool sfu_emul:1;
194 bool nullauth:1; /* attempt to authenticate with null user */
195 bool nocase:1; /* request case insensitive filenames */
196 bool nobrl:1; /* disable sending byte range locks to srv */
197 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
198 bool seal:1; /* request transport encryption on share */
199 bool nodfs:1; /* Do not request DFS, even if available */
200 bool local_lease:1; /* check leases only on local system, not remote */
201 bool noblocksnd:1;
202 bool noautotune:1;
203 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
204 bool fsc:1; /* enable fscache */
205 bool mfsymlinks:1; /* use Minshall+French Symlinks */
206 bool multiuser:1;
d4ffff1f 207 bool rwpidforward:1; /* pid forward for read/write operations */
f87d39d9
SF
208 unsigned int rsize;
209 unsigned int wsize;
210 bool sockopt_tcp_nodelay:1;
211 unsigned short int port;
212 unsigned long actimeo; /* attribute cache timeout (jiffies) */
213 char *prepath;
214 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
215 struct nls_table *local_nls;
216};
217
25c7f41e
PS
218#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
219 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
220 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
221 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
222 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
223 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
224 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
225 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
3d3ea8e6
SP
226 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
227 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
25c7f41e
PS
228
229#define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
230 MS_NODEV | MS_SYNCHRONOUS)
231
232struct cifs_mnt_data {
233 struct cifs_sb_info *cifs_sb;
234 struct smb_vol *vol;
235 int flags;
236};
237
1da177e4 238struct TCP_Server_Info {
3b795210
SF
239 struct list_head tcp_ses_list;
240 struct list_head smb_ses_list;
e7ddee90 241 int srv_count; /* reference counter */
a10faeb2 242 /* 15 character server name + 0x20 16th byte indicating type = srv */
8ecaf67a 243 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
c3dccf48 244 enum statusEnum tcpStatus; /* what we think the status is */
c359cf3c 245 char *hostname; /* hostname portion of UNC string */
1da177e4 246 struct socket *ssocket;
a9f1b85e 247 struct sockaddr_storage dstaddr;
3eb9a889 248 struct sockaddr_storage srcaddr; /* locally bind to this IP */
f1d0c998
RL
249#ifdef CONFIG_NET_NS
250 struct net *net;
251#endif
d38d8c74 252 wait_queue_head_t response_q;
1da177e4
LT
253 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
254 struct list_head pending_mid_q;
edf1ae40
SF
255 bool noblocksnd; /* use blocking sendmsg */
256 bool noautotune; /* do not autotune send buf sizes */
6a5fa236 257 bool tcp_nodelay;
1da177e4 258 atomic_t inFlight; /* number of requests on the wire to server */
72ca545b 259 struct mutex srv_mutex;
1da177e4
LT
260 struct task_struct *tsk;
261 char server_GUID[16];
96daf2b0 262 char sec_mode;
c3dccf48
JL
263 bool session_estab; /* mark when very first sess is established */
264 u16 dialect; /* dialect index that server chose */
1da177e4
LT
265 enum securityEnum secType;
266 unsigned int maxReq; /* Clients should submit no more */
267 /* than maxReq distinct unanswered SMBs to the server when using */
268 /* multiplexed reads or writes */
269 unsigned int maxBuf; /* maxBuf specifies the maximum */
270 /* message size the server can send or receive for non-raw SMBs */
7e90d705
SF
271 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
272 /* when socket is setup (and during reconnect) before NegProt sent */
eca6acf9 273 unsigned int max_rw; /* maxRw specifies the maximum */
1da177e4
LT
274 /* message size the server can send or receive for */
275 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
eca6acf9
SF
276 unsigned int max_vcs; /* maximum number of smb sessions, at least
277 those that can be specified uniquely with
278 vcnumbers */
1da177e4 279 int capabilities; /* allow selective disabling of caps by smb sess */
de7ed55d 280 int timeAdj; /* Adjust for difference in server time zone in sec */
1982c344 281 __u16 CurrentMid; /* multiplex id - rotating counter */
d3ba50b1 282 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
a10faeb2 283 /* 16th byte of RFC1001 workstation name is always null */
8ecaf67a 284 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
a0f8b4fb 285 __u32 sequence_number; /* for signing, protected by srv_mutex */
5f98ca9a 286 struct session_key session_key;
3a5ff61c 287 unsigned long lstrp; /* when we got last response from this server */
d2b91521 288 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
26efa0ba 289 /* extended security flavors that server supports */
c3dccf48
JL
290 bool sec_ntlmssp; /* supports NTLMSSP */
291 bool sec_kerberosu2u; /* supports U2U Kerberos */
26efa0ba
JL
292 bool sec_kerberos; /* supports plain Kerberos */
293 bool sec_mskerberos; /* supports legacy MS Kerberos */
c74093b6 294 struct delayed_work echo; /* echo ping workqueue job */
488f1d2d
SJ
295#ifdef CONFIG_CIFS_FSCACHE
296 struct fscache_cookie *fscache; /* client index cache cookie */
297#endif
c3dccf48 298#ifdef CONFIG_CIFS_STATS2
789e6661 299 atomic_t in_send; /* requests trying to send */
c3dccf48
JL
300 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
301#endif
1da177e4
LT
302};
303
f1d0c998
RL
304/*
305 * Macros to allow the TCP_Server_Info->net field and related code to drop out
306 * when CONFIG_NET_NS isn't set.
307 */
308
309#ifdef CONFIG_NET_NS
310
311static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
312{
313 return srv->net;
314}
315
316static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
317{
318 srv->net = net;
319}
320
321#else
322
323static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
324{
325 return &init_net;
326}
327
328static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
329{
330}
331
332#endif
333
1da177e4
LT
334/*
335 * Session structure. One of these for each uid session with a particular host
336 */
96daf2b0 337struct cifs_ses {
14fbf50d 338 struct list_head smb_ses_list;
3b795210 339 struct list_head tcon_list;
d7b619cf 340 struct mutex session_mutex;
1da177e4 341 struct TCP_Server_Info *server; /* pointer to server info */
14fbf50d 342 int ses_count; /* reference counter */
1da177e4 343 enum statusEnum status;
750d1151 344 unsigned overrideSecFlg; /* if non-zero override global sec flags */
1da177e4
LT
345 __u16 ipc_tid; /* special tid for connection to IPC share */
346 __u16 flags;
eca6acf9 347 __u16 vcnum;
ad009ac9
SF
348 char *serverOS; /* name of operating system underlying server */
349 char *serverNOS; /* name of network operating system of server */
1da177e4
LT
350 char *serverDomain; /* security realm of server */
351 int Suid; /* remote smb uid */
3e4b3e1f
JL
352 uid_t linux_uid; /* overriding owner of files on the mount */
353 uid_t cred_uid; /* owner of credentials */
1da177e4 354 int capabilities;
d38d8c74 355 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
ad009ac9 356 TCP names - will ipv6 and sctp addresses fit? */
34c87901
SF
357 char *user_name; /* must not be null except during init of sess
358 and after mount option parsing we fill it */
d38d8c74
SF
359 char *domainName;
360 char *password;
5d0d2882 361 struct session_key auth_key;
d3686d54 362 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
3b795210 363 bool need_reconnect:1; /* connection reset, uid now invalid */
1da177e4 364};
9ac00b7d 365/* no more than one of the following three session flags may be set */
1da177e4 366#define CIFS_SES_NT4 1
9ac00b7d
SF
367#define CIFS_SES_OS2 2
368#define CIFS_SES_W9X 4
369/* following flag is set for old servers such as OS2 (and Win95?)
370 which do not negotiate NTLM or POSIX dialects, but instead
371 negotiate one of the older LANMAN dialects */
372#define CIFS_SES_LANMAN 8
1da177e4
LT
373/*
374 * there is one of these for each connection to a resource on a particular
d38d8c74 375 * session
1da177e4 376 */
96daf2b0 377struct cifs_tcon {
f1987b44
JL
378 struct list_head tcon_list;
379 int tc_count;
1da177e4 380 struct list_head openFileList;
96daf2b0 381 struct cifs_ses *ses; /* pointer to session associated with */
254e55ed 382 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1da177e4 383 char *nativeFileSystem;
00e485b0 384 char *password; /* for share-level security */
1da177e4
LT
385 __u16 tid; /* The 2 byte tree id */
386 __u16 Flags; /* optional support bits */
387 enum statusEnum tidStatus;
1da177e4
LT
388#ifdef CONFIG_CIFS_STATS
389 atomic_t num_smbs_sent;
390 atomic_t num_writes;
391 atomic_t num_reads;
b298f223 392 atomic_t num_flushes;
1da177e4
LT
393 atomic_t num_oplock_brks;
394 atomic_t num_opens;
a5a2b489 395 atomic_t num_closes;
1da177e4
LT
396 atomic_t num_deletes;
397 atomic_t num_mkdirs;
65bc98b0
SF
398 atomic_t num_posixopens;
399 atomic_t num_posixmkdirs;
1da177e4
LT
400 atomic_t num_rmdirs;
401 atomic_t num_renames;
402 atomic_t num_t2renames;
dfb7533b
SF
403 atomic_t num_ffirst;
404 atomic_t num_fnext;
405 atomic_t num_fclose;
a5a2b489
SF
406 atomic_t num_hardlinks;
407 atomic_t num_symlinks;
408 atomic_t num_locks;
0a4b92c0
SF
409 atomic_t num_acl_get;
410 atomic_t num_acl_set;
a5a2b489
SF
411#ifdef CONFIG_CIFS_STATS2
412 unsigned long long time_writes;
413 unsigned long long time_reads;
414 unsigned long long time_opens;
415 unsigned long long time_deletes;
416 unsigned long long time_closes;
417 unsigned long long time_mkdirs;
418 unsigned long long time_rmdirs;
419 unsigned long long time_renames;
420 unsigned long long time_t2renames;
421 unsigned long long time_ffirst;
422 unsigned long long time_fnext;
423 unsigned long long time_fclose;
424#endif /* CONFIG_CIFS_STATS2 */
1da177e4
LT
425 __u64 bytes_read;
426 __u64 bytes_written;
427 spinlock_t stat_lock;
a5a2b489 428#endif /* CONFIG_CIFS_STATS */
1da177e4 429 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
254e55ed 430 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1da177e4 431 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
4b18f2a9
SF
432 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
433 bool retry:1;
434 bool nocase:1;
95b1cb90 435 bool seal:1; /* transport encryption for this mounted share */
4b18f2a9 436 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
c18c842b 437 for this mount even if server would support */
84210e91 438 bool local_lease:1; /* check leases (only) on local system not remote */
64cc2c63 439 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
3b795210 440 bool need_reconnect:1; /* connection reset, tid now invalid */
d03382ce
SJ
441#ifdef CONFIG_CIFS_FSCACHE
442 u64 resource_id; /* server resource id */
443 struct fscache_cookie *fscache; /* cookie for share */
444#endif
c18c842b 445 /* BB add field for back pointer to sb struct(s)? */
1da177e4
LT
446};
447
7ffec372
JL
448/*
449 * This is a refcounted and timestamped container for a tcon pointer. The
450 * container holds a tcon reference. It is considered safe to free one of
451 * these when the tl_count goes to 0. The tl_time is the time of the last
452 * "get" on the container.
453 */
454struct tcon_link {
b647c35f
JL
455 struct rb_node tl_rbnode;
456 uid_t tl_uid;
9d002df4
JL
457 unsigned long tl_flags;
458#define TCON_LINK_MASTER 0
459#define TCON_LINK_PENDING 1
460#define TCON_LINK_IN_TREE 2
461 unsigned long tl_time;
462 atomic_t tl_count;
96daf2b0 463 struct cifs_tcon *tl_tcon;
7ffec372
JL
464};
465
9d002df4 466extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
7ffec372 467
96daf2b0 468static inline struct cifs_tcon *
7ffec372
JL
469tlink_tcon(struct tcon_link *tlink)
470{
9d002df4 471 return tlink->tl_tcon;
7ffec372
JL
472}
473
9d002df4 474extern void cifs_put_tlink(struct tcon_link *tlink);
7ffec372 475
13cfb733
JL
476static inline struct tcon_link *
477cifs_get_tlink(struct tcon_link *tlink)
478{
9d002df4
JL
479 if (tlink && !IS_ERR(tlink))
480 atomic_inc(&tlink->tl_count);
13cfb733
JL
481 return tlink;
482}
483
7ffec372 484/* This function is always expected to succeed */
96daf2b0 485extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
7ffec372 486
1da177e4 487/*
7ee1af76
JA
488 * This info hangs off the cifsFileInfo structure, pointed to by llist.
489 * This is used to track byte stream locks on the file
1da177e4
LT
490 */
491struct cifsLockInfo {
7ee1af76
JA
492 struct list_head llist; /* pointer to next cifsLockInfo */
493 __u64 offset;
494 __u64 length;
03776f45 495 __u32 pid;
7ee1af76 496 __u8 type;
1da177e4
LT
497};
498
499/*
500 * One of these for each open instance of a file
501 */
502struct cifs_search_info {
503 loff_t index_of_last_entry;
504 __u16 entries_in_buffer;
505 __u16 info_level;
506 __u32 resume_key;
d38d8c74
SF
507 char *ntwrk_buf_start;
508 char *srch_entries_start;
0752f152 509 char *last_entry;
eaf35b1e 510 const char *presume_name;
1da177e4 511 unsigned int resume_name_len;
4b18f2a9
SF
512 bool endOfSearch:1;
513 bool emptyDir:1;
514 bool unicode:1;
515 bool smallBuf:1; /* so we know which buf_release function to call */
1da177e4
LT
516};
517
518struct cifsFileInfo {
519 struct list_head tlist; /* pointer to next fid owned by tcon */
520 struct list_head flist; /* next fid (file instance) for this inode */
521 unsigned int uid; /* allows finding which FileInfo structure */
522 __u32 pid; /* process id who opened file */
523 __u16 netfid; /* file id from remote */
524 /* BB add lock scope info here if needed */ ;
525 /* lock scope id (0 if none) */
a5e18bc3 526 struct dentry *dentry;
15886177 527 unsigned int f_flags;
13cfb733 528 struct tcon_link *tlink;
796e5661 529 struct mutex lock_mutex;
7ee1af76 530 struct list_head llist; /* list of byte range locks we have. */
4b18f2a9 531 bool invalidHandle:1; /* file closed via session abend */
3bc303c2 532 bool oplock_break_cancelled:1;
6c0f6218 533 int count; /* refcount protected by cifs_file_list_lock */
a6ce4932 534 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1da177e4 535 struct cifs_search_info srch_inf;
9b646972 536 struct work_struct oplock_break; /* work for oplock breaks */
1da177e4
LT
537};
538
fa2989f4
PS
539struct cifs_io_parms {
540 __u16 netfid;
541 __u32 pid;
542 __u64 offset;
543 unsigned int length;
96daf2b0 544 struct cifs_tcon *tcon;
fa2989f4
PS
545};
546
5f6dbc9e
JL
547/*
548 * Take a reference on the file private data. Must be called with
549 * cifs_file_list_lock held.
550 */
6ab409b5
DK
551static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
552{
5f6dbc9e 553 ++cifs_file->count;
6ab409b5
DK
554}
555
b33879aa 556void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
6ab409b5 557
1da177e4
LT
558/*
559 * One of these for each file inode
560 */
561
562struct cifsInodeInfo {
563 struct list_head lockList;
d38d8c74 564 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1da177e4 565 struct list_head openFileList;
1da177e4 566 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
aae62fdb
JL
567 bool clientCanCacheRead; /* read oplock */
568 bool clientCanCacheAll; /* read and writebehind oplock */
569 bool delete_pending; /* DELETE_ON_CLOSE is set */
570 bool invalid_mapping; /* pagecache is invalid */
571 unsigned long time; /* jiffies of last update of inode */
fbec9ab9 572 u64 server_eof; /* current file size on server */
cc0bad75 573 u64 uniqueid; /* server inode number */
20054bd6 574 u64 createtime; /* creation time on server */
9451a9a5
SJ
575#ifdef CONFIG_CIFS_FSCACHE
576 struct fscache_cookie *fscache;
577#endif
1da177e4
LT
578 struct inode vfs_inode;
579};
580
581static inline struct cifsInodeInfo *
582CIFS_I(struct inode *inode)
583{
584 return container_of(inode, struct cifsInodeInfo, vfs_inode);
585}
586
587static inline struct cifs_sb_info *
588CIFS_SB(struct super_block *sb)
589{
590 return sb->s_fs_info;
591}
592
ab2f218f 593static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
ac67055e
JA
594{
595 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
596 return '/';
597 else
598 return '\\';
599}
1da177e4 600
f87d39d9
SF
601static inline void
602convert_delimiter(char *path, char delim)
603{
604 int i;
605 char old_delim;
606
607 if (path == NULL)
608 return;
609
610 if (delim == '/')
611 old_delim = '\\';
612 else
613 old_delim = '/';
614
615 for (i = 0; path[i] != '\0'; i++) {
616 if (path[i] == old_delim)
617 path[i] = delim;
618 }
619}
620
a4544347
SF
621#ifdef CONFIG_CIFS_STATS
622#define cifs_stats_inc atomic_inc
623
96daf2b0 624static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
a4544347
SF
625 unsigned int bytes)
626{
627 if (bytes) {
628 spin_lock(&tcon->stat_lock);
629 tcon->bytes_written += bytes;
630 spin_unlock(&tcon->stat_lock);
631 }
632}
633
96daf2b0 634static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
a4544347
SF
635 unsigned int bytes)
636{
637 spin_lock(&tcon->stat_lock);
638 tcon->bytes_read += bytes;
639 spin_unlock(&tcon->stat_lock);
640}
641#else
642
d38d8c74
SF
643#define cifs_stats_inc(field) do {} while (0)
644#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
645#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
a4544347
SF
646
647#endif
648
2b84a36c
JL
649struct mid_q_entry;
650
651/*
652 * This is the prototype for the mid callback function. When creating one,
653 * take special care to avoid deadlocks. Things to bear in mind:
654 *
3c1105df
JL
655 * - it will be called by cifsd, with no locks held
656 * - the mid will be removed from any lists
2b84a36c
JL
657 */
658typedef void (mid_callback_t)(struct mid_q_entry *mid);
659
1da177e4
LT
660/* one of these for every pending CIFS request to the server */
661struct mid_q_entry {
662 struct list_head qhead; /* mids waiting on reply from this server */
663 __u16 mid; /* multiplex id */
664 __u16 pid; /* process id */
665 __u32 sequence_number; /* for CIFS signing */
1047abc1
SF
666 unsigned long when_alloc; /* when mid was created */
667#ifdef CONFIG_CIFS_STATS2
668 unsigned long when_sent; /* time when smb send finished */
669 unsigned long when_received; /* when demux complete (taken off wire) */
670#endif
2b84a36c
JL
671 mid_callback_t *callback; /* call completion callback */
672 void *callback_data; /* general purpose pointer for callback */
1da177e4
LT
673 struct smb_hdr *resp_buf; /* response buffer */
674 int midState; /* wish this were enum but can not pass to wait_event */
c81156dd 675 __u8 command; /* smb command code */
4b18f2a9
SF
676 bool largeBuf:1; /* if valid response, is pointer to large buf */
677 bool multiRsp:1; /* multiple trans2 responses for one request */
678 bool multiEnd:1; /* both received */
1da177e4
LT
679};
680
789e6661
SF
681/* Make code in transport.c a little cleaner by moving
682 update of optional stats into function below */
683#ifdef CONFIG_CIFS_STATS2
684
685static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
686{
687 atomic_inc(&server->in_send);
688}
689
690static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
691{
692 atomic_dec(&server->in_send);
693}
694
695static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
696{
697 atomic_inc(&server->num_waiters);
698}
699
700static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
701{
702 atomic_dec(&server->num_waiters);
703}
704
705static inline void cifs_save_when_sent(struct mid_q_entry *mid)
706{
707 mid->when_sent = jiffies;
708}
709#else
710static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
711{
712}
713static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
714{
715}
716
717static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
718{
719}
720
721static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
722{
723}
724
725static inline void cifs_save_when_sent(struct mid_q_entry *mid)
726{
727}
728#endif
1da177e4 729
ff5dbd9e
SF
730/* for pending dnotify requests */
731struct dir_notify_req {
13cd4b7f
SF
732 struct list_head lhead;
733 __le16 Pid;
734 __le16 PidHigh;
735 __u16 Mid;
736 __u16 Tid;
737 __u16 Uid;
738 __u16 netfid;
739 __u32 filter; /* CompletionFilter (for multishot) */
740 int multishot;
741 struct file *pfile;
ff5dbd9e
SF
742};
743
366781c1
SF
744struct dfs_info3_param {
745 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
8aad018b 746 int path_consumed;
366781c1
SF
747 int server_type;
748 int ref_flag;
749 char *path_name;
750 char *node_name;
751};
752
cc0bad75
JL
753/*
754 * common struct for holding inode info when searching for or updating an
755 * inode with new info
756 */
757
758#define CIFS_FATTR_DFS_REFERRAL 0x1
0b8f18e3
JL
759#define CIFS_FATTR_DELETE_PENDING 0x2
760#define CIFS_FATTR_NEED_REVAL 0x4
3d694380 761#define CIFS_FATTR_INO_COLLISION 0x8
cc0bad75
JL
762
763struct cifs_fattr {
764 u32 cf_flags;
765 u32 cf_cifsattrs;
766 u64 cf_uniqueid;
767 u64 cf_eof;
768 u64 cf_bytes;
20054bd6 769 u64 cf_createtime;
cc0bad75
JL
770 uid_t cf_uid;
771 gid_t cf_gid;
772 umode_t cf_mode;
773 dev_t cf_rdev;
774 unsigned int cf_nlink;
775 unsigned int cf_dtype;
776 struct timespec cf_atime;
777 struct timespec cf_mtime;
778 struct timespec cf_ctime;
779};
780
366781c1
SF
781static inline void free_dfs_info_param(struct dfs_info3_param *param)
782{
783 if (param) {
784 kfree(param->path_name);
785 kfree(param->node_name);
786 kfree(param);
787 }
788}
789
790static inline void free_dfs_info_array(struct dfs_info3_param *param,
791 int number_of_items)
792{
793 int i;
794 if ((number_of_items == 0) || (param == NULL))
795 return;
796 for (i = 0; i < number_of_items; i++) {
797 kfree(param[i].path_name);
798 kfree(param[i].node_name);
799 }
800 kfree(param);
801}
802
1da177e4
LT
803#define MID_FREE 0
804#define MID_REQUEST_ALLOCATED 1
805#define MID_REQUEST_SUBMITTED 2
806#define MID_RESPONSE_RECEIVED 4
807#define MID_RETRY_NEEDED 8 /* session closed while this request out */
71823baf 808#define MID_RESPONSE_MALFORMED 0x10
3c1105df 809#define MID_SHUTDOWN 0x20
ec637e3f
SF
810
811/* Types of response buffer returned from SendReceive2 */
812#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
813#define CIFS_SMALL_BUFFER 1
814#define CIFS_LARGE_BUFFER 2
815#define CIFS_IOVEC 4 /* array of response buffers */
1da177e4 816
133672ef 817/* Type of Request to SendReceive2 */
7749981e
JL
818#define CIFS_BLOCKING_OP 1 /* operation can block */
819#define CIFS_ASYNC_OP 2 /* do not wait for response */
820#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
133672ef
SF
821#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
822#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
823#define CIFS_NO_RESP 0x040 /* no response buffer required */
824
3979877e
SF
825/* Security Flags: indicate type of session setup needed */
826#define CIFSSEC_MAY_SIGN 0x00001
827#define CIFSSEC_MAY_NTLM 0x00002
828#define CIFSSEC_MAY_NTLMV2 0x00004
829#define CIFSSEC_MAY_KRB5 0x00008
830#ifdef CONFIG_CIFS_WEAK_PW_HASH
831#define CIFSSEC_MAY_LANMAN 0x00010
832#define CIFSSEC_MAY_PLNTXT 0x00020
516897a2
SF
833#else
834#define CIFSSEC_MAY_LANMAN 0
835#define CIFSSEC_MAY_PLNTXT 0
3979877e
SF
836#endif /* weak passwords */
837#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
ac683924 838#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
3979877e
SF
839
840#define CIFSSEC_MUST_SIGN 0x01001
841/* note that only one of the following can be set so the
842result of setting MUST flags more than once will be to
843require use of the stronger protocol */
844#define CIFSSEC_MUST_NTLM 0x02002
845#define CIFSSEC_MUST_NTLMV2 0x04004
846#define CIFSSEC_MUST_KRB5 0x08008
847#ifdef CONFIG_CIFS_WEAK_PW_HASH
848#define CIFSSEC_MUST_LANMAN 0x10010
849#define CIFSSEC_MUST_PLNTXT 0x20020
0d3a01fa 850#ifdef CONFIG_CIFS_UPCALL
20d1752f 851#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
0d3a01fa 852#else
20d1752f 853#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
016ec75f 854#endif /* UPCALL */
0d3a01fa
JL
855#else /* do not allow weak pw hash */
856#ifdef CONFIG_CIFS_UPCALL
ac683924 857#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
d38d8c74 858#else
ac683924 859#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
016ec75f 860#endif /* UPCALL */
3979877e
SF
861#endif /* WEAK_PW_HASH */
862#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
ac683924 863#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
3979877e 864
ef571cad
SP
865#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
866#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
ac683924 867#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1da177e4
LT
868/*
869 *****************************************************************
870 * All constants go here
871 *****************************************************************
872 */
873
874#define UID_HASH (16)
875
876/*
877 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
878 * following to be declared.
879 */
880
881/****************************************************************************
882 * Locking notes. All updates to global variables and lists should be
883 * protected by spinlocks or semaphores.
884 *
885 * Spinlocks
886 * ---------
887 * GlobalMid_Lock protects:
888 * list operations on pending_mid_q and oplockQ
889 * updates to XID counters, multiplex id and SMB sequence numbers
6573e9b7 890 * cifs_file_list_lock protects:
1da177e4
LT
891 * list operations on tcp and SMB session lists and tCon lists
892 * f_owner.lock protects certain per file struct operations
893 * mapping->page_lock protects certain per page operations
894 *
895 * Semaphores
896 * ----------
897 * sesSem operations on smb session
898 * tconSem operations on tree connection
d38d8c74 899 * fh_sem file handle reconnection operations
1da177e4
LT
900 *
901 ****************************************************************************/
902
903#ifdef DECLARE_GLOBALS_HERE
904#define GLOBAL_EXTERN
905#else
906#define GLOBAL_EXTERN extern
907#endif
908
e7ddee90
JL
909/*
910 * the list of TCP_Server_Info structures, ie each of the sockets
fb396016 911 * connecting our client to a distinct server (ip address), is
e7ddee90 912 * chained together by cifs_tcp_ses_list. The list of all our SMB
fb396016 913 * sessions (and from that the tree connections) can be found
e7ddee90
JL
914 * by iterating over cifs_tcp_ses_list
915 */
916GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
917
f1987b44
JL
918/*
919 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
920 * tcp session, and the list of tcon's per smb session. It also protects
921 * the reference counters for the server, smb session, and tcon. Finally,
922 * changes to the tcon->tidStatus should be done while holding this lock.
923 */
3f9bcca7 924GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
ddb4cbfc
SF
925
926/*
927 * This lock protects the cifs_file->llist and cifs_file->flist
928 * list operations, and updates to some flags (cifs_file->invalidHandle)
929 * It will be moved to either use the tcon->stat_lock or equivalent later.
930 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
931 * the cifs_tcp_ses_lock must be grabbed first and released last.
932 */
4477288a 933GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1da177e4 934
0eff0e26 935#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
99ee4dbd
SF
936/* Outstanding dir notify requests */
937GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
938/* DirNotify response queue */
939GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
0eff0e26 940#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
ff5dbd9e 941
1da177e4
LT
942/*
943 * Global transaction id (XID) information
944 */
945GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
254e55ed 946GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1da177e4 947GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
254e55ed
SF
948GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
949 /* on midQ entries */
1da177e4
LT
950/*
951 * Global counters, updated atomically
952 */
953GLOBAL_EXTERN atomic_t sesInfoAllocCount;
954GLOBAL_EXTERN atomic_t tconInfoAllocCount;
955GLOBAL_EXTERN atomic_t tcpSesAllocCount;
956GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
957GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
958
aaa9bbe0 959/* Various Debug counters */
4498eed5
SF
960GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
961#ifdef CONFIG_CIFS_STATS2
962GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
963GLOBAL_EXTERN atomic_t totSmBufAllocCount;
964#endif
965GLOBAL_EXTERN atomic_t smBufAllocCount;
1da177e4
LT
966GLOBAL_EXTERN atomic_t midCount;
967
968/* Misc globals */
254e55ed 969GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
1da177e4 970 to be established on existing mount if we
d38d8c74 971 have the uid/password or Kerberos credential
1da177e4 972 or equivalent for current user */
e7504734
SF
973/* enable or disable oplocks */
974GLOBAL_EXTERN bool enable_oplocks;
1da177e4 975GLOBAL_EXTERN unsigned int lookupCacheEnabled;
04912d6a 976GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1da177e4 977 with more secure ntlmssp2 challenge/resp */
1da177e4
LT
978GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
979GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
980GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
981GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
982GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
983GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
984
fda35943
SF
985/* reconnect after this many failed echo attempts */
986GLOBAL_EXTERN unsigned short echo_retries;
987
21fed0d5 988#ifdef CONFIG_CIFS_ACL
4d79dba0
SP
989GLOBAL_EXTERN struct rb_root uidtree;
990GLOBAL_EXTERN struct rb_root gidtree;
991GLOBAL_EXTERN spinlock_t siduidlock;
992GLOBAL_EXTERN spinlock_t sidgidlock;
21fed0d5
SP
993GLOBAL_EXTERN struct rb_root siduidtree;
994GLOBAL_EXTERN struct rb_root sidgidtree;
995GLOBAL_EXTERN spinlock_t uidsidlock;
996GLOBAL_EXTERN spinlock_t gidsidlock;
997#endif /* CONFIG_CIFS_ACL */
4d79dba0 998
9b646972 999void cifs_oplock_break(struct work_struct *work);
3b7433b8 1000
3bc303c2 1001extern const struct slow_work_ops cifs_oplock_break_ops;
abd2e44d
SJ
1002
1003#endif /* _CIFS_GLOB_H */