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