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