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