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