]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/cifs/cifsglob.h
Merge branch 'x86-microcode-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[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>
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
d38d8c74 40#define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
1da177e4
LT
41#define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
42 termination then *2 for unicode versions */
4ff67b72 43#define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
1da177e4
LT
44
45#define CIFS_MIN_RCV_POOL 4
46
6d20e840
SJ
47/*
48 * default attribute cache timeout (jiffies)
49 */
50#define CIFS_DEF_ACTIMEO (1 * HZ)
51
52/*
53 * max attribute cache timeout (jiffies) - 2^30
54 */
55#define CIFS_MAX_ACTIMEO (1 << 30)
56
1da177e4
LT
57/*
58 * MAX_REQ is the maximum number of requests that WE will send
af901ca1 59 * on one socket concurrently. It also matches the most common
d38d8c74 60 * value of max multiplex returned by servers. We may
1da177e4
LT
61 * eventually want to use the negotiated value (in case
62 * future servers can handle more) when we are more confident that
63 * we will not have problems oveloading the socket with pending
64 * write data.
65 */
d38d8c74 66#define CIFS_MAX_REQ 50
1da177e4 67
8ecaf67a
JL
68#define RFC1001_NAME_LEN 15
69#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
70
71/* currently length of NIP6_FMT */
72#define SERVER_NAME_LENGTH 40
1da177e4
LT
73#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
74
75/* used to define string lengths for reversing unicode strings */
76/* (256+1)*2 = 514 */
77/* (max path length + 1 for null) * 2 for unicode */
78#define MAX_NAME 514
79
80#include "cifspdu.h"
81
1da177e4
LT
82#ifndef XATTR_DOS_ATTRIB
83#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
84#endif
85
1da177e4
LT
86/*
87 * CIFS vfs client Status information (based on what we know.)
88 */
89
6c0f6218 90/* associated with each tcp and smb session */
1da177e4
LT
91enum statusEnum {
92 CifsNew = 0,
93 CifsGood,
94 CifsExiting,
95 CifsNeedReconnect
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
158struct TCP_Server_Info {
3b795210
SF
159 struct list_head tcp_ses_list;
160 struct list_head smb_ses_list;
e7ddee90 161 int srv_count; /* reference counter */
a10faeb2 162 /* 15 character server name + 0x20 16th byte indicating type = srv */
8ecaf67a 163 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
c3dccf48 164 enum statusEnum tcpStatus; /* what we think the status is */
c359cf3c 165 char *hostname; /* hostname portion of UNC string */
1da177e4 166 struct socket *ssocket;
a9f1b85e 167 struct sockaddr_storage dstaddr;
3eb9a889 168 struct sockaddr_storage srcaddr; /* locally bind to this IP */
f1d0c998
RL
169#ifdef CONFIG_NET_NS
170 struct net *net;
171#endif
d38d8c74 172 wait_queue_head_t response_q;
1da177e4
LT
173 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
174 struct list_head pending_mid_q;
edf1ae40
SF
175 bool noblocksnd; /* use blocking sendmsg */
176 bool noautotune; /* do not autotune send buf sizes */
6a5fa236 177 bool tcp_nodelay;
1da177e4 178 atomic_t inFlight; /* number of requests on the wire to server */
72ca545b 179 struct mutex srv_mutex;
1da177e4
LT
180 struct task_struct *tsk;
181 char server_GUID[16];
182 char secMode;
c3dccf48
JL
183 bool session_estab; /* mark when very first sess is established */
184 u16 dialect; /* dialect index that server chose */
1da177e4
LT
185 enum securityEnum secType;
186 unsigned int maxReq; /* Clients should submit no more */
187 /* than maxReq distinct unanswered SMBs to the server when using */
188 /* multiplexed reads or writes */
189 unsigned int maxBuf; /* maxBuf specifies the maximum */
190 /* message size the server can send or receive for non-raw SMBs */
7e90d705
SF
191 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
192 /* when socket is setup (and during reconnect) before NegProt sent */
eca6acf9 193 unsigned int max_rw; /* maxRw specifies the maximum */
1da177e4
LT
194 /* message size the server can send or receive for */
195 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
eca6acf9
SF
196 unsigned int max_vcs; /* maximum number of smb sessions, at least
197 those that can be specified uniquely with
198 vcnumbers */
1da177e4 199 int capabilities; /* allow selective disabling of caps by smb sess */
de7ed55d 200 int timeAdj; /* Adjust for difference in server time zone in sec */
1982c344 201 __u16 CurrentMid; /* multiplex id - rotating counter */
d3ba50b1 202 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
a10faeb2 203 /* 16th byte of RFC1001 workstation name is always null */
8ecaf67a 204 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
a0f8b4fb 205 __u32 sequence_number; /* for signing, protected by srv_mutex */
5f98ca9a 206 struct session_key session_key;
3a5ff61c 207 unsigned long lstrp; /* when we got last response from this server */
d2b91521 208 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
26efa0ba 209 /* extended security flavors that server supports */
c3dccf48
JL
210 bool sec_ntlmssp; /* supports NTLMSSP */
211 bool sec_kerberosu2u; /* supports U2U Kerberos */
26efa0ba
JL
212 bool sec_kerberos; /* supports plain Kerberos */
213 bool sec_mskerberos; /* supports legacy MS Kerberos */
c74093b6 214 struct delayed_work echo; /* echo ping workqueue job */
488f1d2d
SJ
215#ifdef CONFIG_CIFS_FSCACHE
216 struct fscache_cookie *fscache; /* client index cache cookie */
217#endif
c3dccf48
JL
218#ifdef CONFIG_CIFS_STATS2
219 atomic_t inSend; /* requests trying to send */
220 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
221#endif
1da177e4
LT
222};
223
f1d0c998
RL
224/*
225 * Macros to allow the TCP_Server_Info->net field and related code to drop out
226 * when CONFIG_NET_NS isn't set.
227 */
228
229#ifdef CONFIG_NET_NS
230
231static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
232{
233 return srv->net;
234}
235
236static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
237{
238 srv->net = net;
239}
240
241#else
242
243static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
244{
245 return &init_net;
246}
247
248static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
249{
250}
251
252#endif
253
1da177e4
LT
254/*
255 * Session structure. One of these for each uid session with a particular host
256 */
257struct cifsSesInfo {
14fbf50d 258 struct list_head smb_ses_list;
3b795210 259 struct list_head tcon_list;
d7b619cf 260 struct mutex session_mutex;
1da177e4 261 struct TCP_Server_Info *server; /* pointer to server info */
14fbf50d 262 int ses_count; /* reference counter */
1da177e4 263 enum statusEnum status;
750d1151 264 unsigned overrideSecFlg; /* if non-zero override global sec flags */
1da177e4
LT
265 __u16 ipc_tid; /* special tid for connection to IPC share */
266 __u16 flags;
eca6acf9 267 __u16 vcnum;
ad009ac9
SF
268 char *serverOS; /* name of operating system underlying server */
269 char *serverNOS; /* name of network operating system of server */
1da177e4
LT
270 char *serverDomain; /* security realm of server */
271 int Suid; /* remote smb uid */
3e4b3e1f
JL
272 uid_t linux_uid; /* overriding owner of files on the mount */
273 uid_t cred_uid; /* owner of credentials */
1da177e4 274 int capabilities;
d38d8c74 275 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
ad009ac9 276 TCP names - will ipv6 and sctp addresses fit? */
1da177e4 277 char userName[MAX_USERNAME_SIZE + 1];
d38d8c74
SF
278 char *domainName;
279 char *password;
5d0d2882 280 struct session_key auth_key;
d3686d54 281 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
3b795210 282 bool need_reconnect:1; /* connection reset, uid now invalid */
1da177e4 283};
9ac00b7d 284/* no more than one of the following three session flags may be set */
1da177e4 285#define CIFS_SES_NT4 1
9ac00b7d
SF
286#define CIFS_SES_OS2 2
287#define CIFS_SES_W9X 4
288/* following flag is set for old servers such as OS2 (and Win95?)
289 which do not negotiate NTLM or POSIX dialects, but instead
290 negotiate one of the older LANMAN dialects */
291#define CIFS_SES_LANMAN 8
1da177e4
LT
292/*
293 * there is one of these for each connection to a resource on a particular
d38d8c74 294 * session
1da177e4
LT
295 */
296struct cifsTconInfo {
f1987b44
JL
297 struct list_head tcon_list;
298 int tc_count;
1da177e4 299 struct list_head openFileList;
1da177e4 300 struct cifsSesInfo *ses; /* pointer to session associated with */
254e55ed 301 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1da177e4 302 char *nativeFileSystem;
00e485b0 303 char *password; /* for share-level security */
1da177e4
LT
304 __u16 tid; /* The 2 byte tree id */
305 __u16 Flags; /* optional support bits */
306 enum statusEnum tidStatus;
1da177e4
LT
307#ifdef CONFIG_CIFS_STATS
308 atomic_t num_smbs_sent;
309 atomic_t num_writes;
310 atomic_t num_reads;
b298f223 311 atomic_t num_flushes;
1da177e4
LT
312 atomic_t num_oplock_brks;
313 atomic_t num_opens;
a5a2b489 314 atomic_t num_closes;
1da177e4
LT
315 atomic_t num_deletes;
316 atomic_t num_mkdirs;
65bc98b0
SF
317 atomic_t num_posixopens;
318 atomic_t num_posixmkdirs;
1da177e4
LT
319 atomic_t num_rmdirs;
320 atomic_t num_renames;
321 atomic_t num_t2renames;
dfb7533b
SF
322 atomic_t num_ffirst;
323 atomic_t num_fnext;
324 atomic_t num_fclose;
a5a2b489
SF
325 atomic_t num_hardlinks;
326 atomic_t num_symlinks;
327 atomic_t num_locks;
0a4b92c0
SF
328 atomic_t num_acl_get;
329 atomic_t num_acl_set;
a5a2b489
SF
330#ifdef CONFIG_CIFS_STATS2
331 unsigned long long time_writes;
332 unsigned long long time_reads;
333 unsigned long long time_opens;
334 unsigned long long time_deletes;
335 unsigned long long time_closes;
336 unsigned long long time_mkdirs;
337 unsigned long long time_rmdirs;
338 unsigned long long time_renames;
339 unsigned long long time_t2renames;
340 unsigned long long time_ffirst;
341 unsigned long long time_fnext;
342 unsigned long long time_fclose;
343#endif /* CONFIG_CIFS_STATS2 */
1da177e4
LT
344 __u64 bytes_read;
345 __u64 bytes_written;
346 spinlock_t stat_lock;
a5a2b489 347#endif /* CONFIG_CIFS_STATS */
1da177e4 348 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
254e55ed 349 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1da177e4 350 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
4b18f2a9
SF
351 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
352 bool retry:1;
353 bool nocase:1;
95b1cb90 354 bool seal:1; /* transport encryption for this mounted share */
4b18f2a9 355 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
c18c842b 356 for this mount even if server would support */
84210e91 357 bool local_lease:1; /* check leases (only) on local system not remote */
64cc2c63 358 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
3b795210 359 bool need_reconnect:1; /* connection reset, tid now invalid */
d03382ce
SJ
360#ifdef CONFIG_CIFS_FSCACHE
361 u64 resource_id; /* server resource id */
362 struct fscache_cookie *fscache; /* cookie for share */
363#endif
c18c842b 364 /* BB add field for back pointer to sb struct(s)? */
1da177e4
LT
365};
366
7ffec372
JL
367/*
368 * This is a refcounted and timestamped container for a tcon pointer. The
369 * container holds a tcon reference. It is considered safe to free one of
370 * these when the tl_count goes to 0. The tl_time is the time of the last
371 * "get" on the container.
372 */
373struct tcon_link {
b647c35f
JL
374 struct rb_node tl_rbnode;
375 uid_t tl_uid;
9d002df4
JL
376 unsigned long tl_flags;
377#define TCON_LINK_MASTER 0
378#define TCON_LINK_PENDING 1
379#define TCON_LINK_IN_TREE 2
380 unsigned long tl_time;
381 atomic_t tl_count;
7ffec372
JL
382 struct cifsTconInfo *tl_tcon;
383};
384
9d002df4 385extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
7ffec372
JL
386
387static inline struct cifsTconInfo *
388tlink_tcon(struct tcon_link *tlink)
389{
9d002df4 390 return tlink->tl_tcon;
7ffec372
JL
391}
392
9d002df4 393extern void cifs_put_tlink(struct tcon_link *tlink);
7ffec372 394
13cfb733
JL
395static inline struct tcon_link *
396cifs_get_tlink(struct tcon_link *tlink)
397{
9d002df4
JL
398 if (tlink && !IS_ERR(tlink))
399 atomic_inc(&tlink->tl_count);
13cfb733
JL
400 return tlink;
401}
402
7ffec372 403/* This function is always expected to succeed */
9d002df4 404extern struct cifsTconInfo *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
7ffec372 405
1da177e4 406/*
7ee1af76
JA
407 * This info hangs off the cifsFileInfo structure, pointed to by llist.
408 * This is used to track byte stream locks on the file
1da177e4
LT
409 */
410struct cifsLockInfo {
7ee1af76
JA
411 struct list_head llist; /* pointer to next cifsLockInfo */
412 __u64 offset;
413 __u64 length;
414 __u8 type;
1da177e4
LT
415};
416
417/*
418 * One of these for each open instance of a file
419 */
420struct cifs_search_info {
421 loff_t index_of_last_entry;
422 __u16 entries_in_buffer;
423 __u16 info_level;
424 __u32 resume_key;
d38d8c74
SF
425 char *ntwrk_buf_start;
426 char *srch_entries_start;
0752f152 427 char *last_entry;
d38d8c74 428 char *presume_name;
1da177e4 429 unsigned int resume_name_len;
4b18f2a9
SF
430 bool endOfSearch:1;
431 bool emptyDir:1;
432 bool unicode:1;
433 bool smallBuf:1; /* so we know which buf_release function to call */
1da177e4
LT
434};
435
436struct cifsFileInfo {
437 struct list_head tlist; /* pointer to next fid owned by tcon */
438 struct list_head flist; /* next fid (file instance) for this inode */
439 unsigned int uid; /* allows finding which FileInfo structure */
440 __u32 pid; /* process id who opened file */
441 __u16 netfid; /* file id from remote */
442 /* BB add lock scope info here if needed */ ;
443 /* lock scope id (0 if none) */
a5e18bc3 444 struct dentry *dentry;
15886177 445 unsigned int f_flags;
13cfb733 446 struct tcon_link *tlink;
796e5661 447 struct mutex lock_mutex;
7ee1af76 448 struct list_head llist; /* list of byte range locks we have. */
4b18f2a9 449 bool invalidHandle:1; /* file closed via session abend */
3bc303c2 450 bool oplock_break_cancelled:1;
6c0f6218 451 int count; /* refcount protected by cifs_file_list_lock */
a6ce4932 452 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1da177e4 453 struct cifs_search_info srch_inf;
9b646972 454 struct work_struct oplock_break; /* work for oplock breaks */
1da177e4
LT
455};
456
5f6dbc9e
JL
457/*
458 * Take a reference on the file private data. Must be called with
459 * cifs_file_list_lock held.
460 */
6ab409b5
DK
461static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
462{
5f6dbc9e 463 ++cifs_file->count;
6ab409b5
DK
464}
465
b33879aa 466void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
6ab409b5 467
1da177e4
LT
468/*
469 * One of these for each file inode
470 */
471
472struct cifsInodeInfo {
473 struct list_head lockList;
d38d8c74 474 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1da177e4 475 struct list_head openFileList;
1da177e4 476 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
aae62fdb
JL
477 bool clientCanCacheRead; /* read oplock */
478 bool clientCanCacheAll; /* read and writebehind oplock */
479 bool delete_pending; /* DELETE_ON_CLOSE is set */
480 bool invalid_mapping; /* pagecache is invalid */
481 unsigned long time; /* jiffies of last update of inode */
fbec9ab9 482 u64 server_eof; /* current file size on server */
cc0bad75 483 u64 uniqueid; /* server inode number */
20054bd6 484 u64 createtime; /* creation time on server */
9451a9a5
SJ
485#ifdef CONFIG_CIFS_FSCACHE
486 struct fscache_cookie *fscache;
487#endif
1da177e4
LT
488 struct inode vfs_inode;
489};
490
491static inline struct cifsInodeInfo *
492CIFS_I(struct inode *inode)
493{
494 return container_of(inode, struct cifsInodeInfo, vfs_inode);
495}
496
497static inline struct cifs_sb_info *
498CIFS_SB(struct super_block *sb)
499{
500 return sb->s_fs_info;
501}
502
ab2f218f 503static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
ac67055e
JA
504{
505 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
506 return '/';
507 else
508 return '\\';
509}
1da177e4 510
a4544347
SF
511#ifdef CONFIG_CIFS_STATS
512#define cifs_stats_inc atomic_inc
513
514static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
515 unsigned int bytes)
516{
517 if (bytes) {
518 spin_lock(&tcon->stat_lock);
519 tcon->bytes_written += bytes;
520 spin_unlock(&tcon->stat_lock);
521 }
522}
523
524static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
525 unsigned int bytes)
526{
527 spin_lock(&tcon->stat_lock);
528 tcon->bytes_read += bytes;
529 spin_unlock(&tcon->stat_lock);
530}
531#else
532
d38d8c74
SF
533#define cifs_stats_inc(field) do {} while (0)
534#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
535#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
a4544347
SF
536
537#endif
538
2b84a36c
JL
539struct mid_q_entry;
540
541/*
542 * This is the prototype for the mid callback function. When creating one,
543 * take special care to avoid deadlocks. Things to bear in mind:
544 *
545 * - it will be called by cifsd
546 * - the GlobalMid_Lock will be held
547 * - the mid will be removed from the pending_mid_q list
548 */
549typedef void (mid_callback_t)(struct mid_q_entry *mid);
550
1da177e4
LT
551/* one of these for every pending CIFS request to the server */
552struct mid_q_entry {
553 struct list_head qhead; /* mids waiting on reply from this server */
554 __u16 mid; /* multiplex id */
555 __u16 pid; /* process id */
556 __u32 sequence_number; /* for CIFS signing */
1047abc1
SF
557 unsigned long when_alloc; /* when mid was created */
558#ifdef CONFIG_CIFS_STATS2
559 unsigned long when_sent; /* time when smb send finished */
560 unsigned long when_received; /* when demux complete (taken off wire) */
561#endif
2b84a36c
JL
562 mid_callback_t *callback; /* call completion callback */
563 void *callback_data; /* general purpose pointer for callback */
1da177e4
LT
564 struct smb_hdr *resp_buf; /* response buffer */
565 int midState; /* wish this were enum but can not pass to wait_event */
c81156dd 566 __u8 command; /* smb command code */
4b18f2a9
SF
567 bool largeBuf:1; /* if valid response, is pointer to large buf */
568 bool multiRsp:1; /* multiple trans2 responses for one request */
569 bool multiEnd:1; /* both received */
1da177e4
LT
570};
571
572struct oplock_q_entry {
573 struct list_head qhead;
d38d8c74
SF
574 struct inode *pinode;
575 struct cifsTconInfo *tcon;
1da177e4
LT
576 __u16 netfid;
577};
578
ff5dbd9e
SF
579/* for pending dnotify requests */
580struct dir_notify_req {
13cd4b7f
SF
581 struct list_head lhead;
582 __le16 Pid;
583 __le16 PidHigh;
584 __u16 Mid;
585 __u16 Tid;
586 __u16 Uid;
587 __u16 netfid;
588 __u32 filter; /* CompletionFilter (for multishot) */
589 int multishot;
590 struct file *pfile;
ff5dbd9e
SF
591};
592
366781c1
SF
593struct dfs_info3_param {
594 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
8aad018b 595 int path_consumed;
366781c1
SF
596 int server_type;
597 int ref_flag;
598 char *path_name;
599 char *node_name;
600};
601
cc0bad75
JL
602/*
603 * common struct for holding inode info when searching for or updating an
604 * inode with new info
605 */
606
607#define CIFS_FATTR_DFS_REFERRAL 0x1
0b8f18e3
JL
608#define CIFS_FATTR_DELETE_PENDING 0x2
609#define CIFS_FATTR_NEED_REVAL 0x4
3d694380 610#define CIFS_FATTR_INO_COLLISION 0x8
cc0bad75
JL
611
612struct cifs_fattr {
613 u32 cf_flags;
614 u32 cf_cifsattrs;
615 u64 cf_uniqueid;
616 u64 cf_eof;
617 u64 cf_bytes;
20054bd6 618 u64 cf_createtime;
cc0bad75
JL
619 uid_t cf_uid;
620 gid_t cf_gid;
621 umode_t cf_mode;
622 dev_t cf_rdev;
623 unsigned int cf_nlink;
624 unsigned int cf_dtype;
625 struct timespec cf_atime;
626 struct timespec cf_mtime;
627 struct timespec cf_ctime;
628};
629
366781c1
SF
630static inline void free_dfs_info_param(struct dfs_info3_param *param)
631{
632 if (param) {
633 kfree(param->path_name);
634 kfree(param->node_name);
635 kfree(param);
636 }
637}
638
639static inline void free_dfs_info_array(struct dfs_info3_param *param,
640 int number_of_items)
641{
642 int i;
643 if ((number_of_items == 0) || (param == NULL))
644 return;
645 for (i = 0; i < number_of_items; i++) {
646 kfree(param[i].path_name);
647 kfree(param[i].node_name);
648 }
649 kfree(param);
650}
651
1da177e4
LT
652#define MID_FREE 0
653#define MID_REQUEST_ALLOCATED 1
654#define MID_REQUEST_SUBMITTED 2
655#define MID_RESPONSE_RECEIVED 4
656#define MID_RETRY_NEEDED 8 /* session closed while this request out */
71823baf 657#define MID_RESPONSE_MALFORMED 0x10
ec637e3f
SF
658
659/* Types of response buffer returned from SendReceive2 */
660#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
661#define CIFS_SMALL_BUFFER 1
662#define CIFS_LARGE_BUFFER 2
663#define CIFS_IOVEC 4 /* array of response buffers */
1da177e4 664
133672ef 665/* Type of Request to SendReceive2 */
7749981e
JL
666#define CIFS_BLOCKING_OP 1 /* operation can block */
667#define CIFS_ASYNC_OP 2 /* do not wait for response */
668#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
133672ef
SF
669#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
670#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
671#define CIFS_NO_RESP 0x040 /* no response buffer required */
672
3979877e
SF
673/* Security Flags: indicate type of session setup needed */
674#define CIFSSEC_MAY_SIGN 0x00001
675#define CIFSSEC_MAY_NTLM 0x00002
676#define CIFSSEC_MAY_NTLMV2 0x00004
677#define CIFSSEC_MAY_KRB5 0x00008
678#ifdef CONFIG_CIFS_WEAK_PW_HASH
679#define CIFSSEC_MAY_LANMAN 0x00010
680#define CIFSSEC_MAY_PLNTXT 0x00020
516897a2
SF
681#else
682#define CIFSSEC_MAY_LANMAN 0
683#define CIFSSEC_MAY_PLNTXT 0
3979877e
SF
684#endif /* weak passwords */
685#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
ac683924 686#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
3979877e
SF
687
688#define CIFSSEC_MUST_SIGN 0x01001
689/* note that only one of the following can be set so the
690result of setting MUST flags more than once will be to
691require use of the stronger protocol */
692#define CIFSSEC_MUST_NTLM 0x02002
693#define CIFSSEC_MUST_NTLMV2 0x04004
694#define CIFSSEC_MUST_KRB5 0x08008
695#ifdef CONFIG_CIFS_WEAK_PW_HASH
696#define CIFSSEC_MUST_LANMAN 0x10010
697#define CIFSSEC_MUST_PLNTXT 0x20020
0d3a01fa 698#ifdef CONFIG_CIFS_UPCALL
20d1752f 699#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
0d3a01fa 700#else
20d1752f 701#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
016ec75f 702#endif /* UPCALL */
0d3a01fa
JL
703#else /* do not allow weak pw hash */
704#ifdef CONFIG_CIFS_UPCALL
ac683924 705#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
d38d8c74 706#else
ac683924 707#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
016ec75f 708#endif /* UPCALL */
3979877e
SF
709#endif /* WEAK_PW_HASH */
710#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
ac683924 711#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
3979877e 712
ef571cad
SP
713#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
714#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
ac683924 715#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1da177e4
LT
716/*
717 *****************************************************************
718 * All constants go here
719 *****************************************************************
720 */
721
722#define UID_HASH (16)
723
724/*
725 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
726 * following to be declared.
727 */
728
729/****************************************************************************
730 * Locking notes. All updates to global variables and lists should be
731 * protected by spinlocks or semaphores.
732 *
733 * Spinlocks
734 * ---------
735 * GlobalMid_Lock protects:
736 * list operations on pending_mid_q and oplockQ
737 * updates to XID counters, multiplex id and SMB sequence numbers
6573e9b7 738 * cifs_file_list_lock protects:
1da177e4
LT
739 * list operations on tcp and SMB session lists and tCon lists
740 * f_owner.lock protects certain per file struct operations
741 * mapping->page_lock protects certain per page operations
742 *
743 * Semaphores
744 * ----------
745 * sesSem operations on smb session
746 * tconSem operations on tree connection
d38d8c74 747 * fh_sem file handle reconnection operations
1da177e4
LT
748 *
749 ****************************************************************************/
750
751#ifdef DECLARE_GLOBALS_HERE
752#define GLOBAL_EXTERN
753#else
754#define GLOBAL_EXTERN extern
755#endif
756
e7ddee90
JL
757/*
758 * the list of TCP_Server_Info structures, ie each of the sockets
fb396016 759 * connecting our client to a distinct server (ip address), is
e7ddee90 760 * chained together by cifs_tcp_ses_list. The list of all our SMB
fb396016 761 * sessions (and from that the tree connections) can be found
e7ddee90
JL
762 * by iterating over cifs_tcp_ses_list
763 */
764GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
765
f1987b44
JL
766/*
767 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
768 * tcp session, and the list of tcon's per smb session. It also protects
769 * the reference counters for the server, smb session, and tcon. Finally,
770 * changes to the tcon->tidStatus should be done while holding this lock.
771 */
3f9bcca7 772GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
ddb4cbfc
SF
773
774/*
775 * This lock protects the cifs_file->llist and cifs_file->flist
776 * list operations, and updates to some flags (cifs_file->invalidHandle)
777 * It will be moved to either use the tcon->stat_lock or equivalent later.
778 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
779 * the cifs_tcp_ses_lock must be grabbed first and released last.
780 */
4477288a 781GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1da177e4 782
99ee4dbd
SF
783/* Outstanding dir notify requests */
784GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
785/* DirNotify response queue */
786GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
ff5dbd9e 787
1da177e4
LT
788/*
789 * Global transaction id (XID) information
790 */
791GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
254e55ed 792GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1da177e4 793GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
254e55ed
SF
794GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
795 /* on midQ entries */
1da177e4
LT
796/*
797 * Global counters, updated atomically
798 */
799GLOBAL_EXTERN atomic_t sesInfoAllocCount;
800GLOBAL_EXTERN atomic_t tconInfoAllocCount;
801GLOBAL_EXTERN atomic_t tcpSesAllocCount;
802GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
803GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
804
aaa9bbe0 805/* Various Debug counters */
4498eed5
SF
806GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
807#ifdef CONFIG_CIFS_STATS2
808GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
809GLOBAL_EXTERN atomic_t totSmBufAllocCount;
810#endif
811GLOBAL_EXTERN atomic_t smBufAllocCount;
1da177e4
LT
812GLOBAL_EXTERN atomic_t midCount;
813
814/* Misc globals */
254e55ed 815GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
1da177e4 816 to be established on existing mount if we
d38d8c74 817 have the uid/password or Kerberos credential
1da177e4
LT
818 or equivalent for current user */
819GLOBAL_EXTERN unsigned int oplockEnabled;
820GLOBAL_EXTERN unsigned int experimEnabled;
821GLOBAL_EXTERN unsigned int lookupCacheEnabled;
04912d6a 822GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1da177e4 823 with more secure ntlmssp2 challenge/resp */
1da177e4
LT
824GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
825GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
826GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
827GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
828GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
829GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
830
fda35943
SF
831/* reconnect after this many failed echo attempts */
832GLOBAL_EXTERN unsigned short echo_retries;
833
9b646972
TH
834void cifs_oplock_break(struct work_struct *work);
835void cifs_oplock_break_get(struct cifsFileInfo *cfile);
836void cifs_oplock_break_put(struct cifsFileInfo *cfile);
3b7433b8 837
3bc303c2 838extern const struct slow_work_ops cifs_oplock_break_ops;
abd2e44d
SJ
839
840#endif /* _CIFS_GLOB_H */