net/mlx4: Fix firmware command timeout during interrupt test
[cascardo/linux.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/mempool.h>
26 #include <linux/workqueue.h>
27 #include "cifs_fs_sb.h"
28 #include "cifsacl.h"
29 #include <crypto/internal/hash.h>
30 #include <linux/scatterlist.h>
31 #include <uapi/linux/cifs/cifs_mount.h>
32 #ifdef CONFIG_CIFS_SMB2
33 #include "smb2pdu.h"
34 #endif
35
36 #define CIFS_MAGIC_NUMBER 0xFF534D42      /* the first four bytes of SMB PDUs */
37
38 /*
39  * The sizes of various internal tables and strings
40  */
41 #define MAX_UID_INFO 16
42 #define MAX_SES_INFO 2
43 #define MAX_TCON_INFO 4
44
45 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
46
47 #define CIFS_MIN_RCV_POOL 4
48
49 #define MAX_REOPEN_ATT  5 /* these many maximum attempts to reopen a file */
50 /*
51  * default attribute cache timeout (jiffies)
52  */
53 #define CIFS_DEF_ACTIMEO (1 * HZ)
54
55 /*
56  * max attribute cache timeout (jiffies) - 2^30
57  */
58 #define CIFS_MAX_ACTIMEO (1 << 30)
59
60 /*
61  * MAX_REQ is the maximum number of requests that WE will send
62  * on one socket concurrently.
63  */
64 #define CIFS_MAX_REQ 32767
65
66 #define RFC1001_NAME_LEN 15
67 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
68
69 /* currently length of NIP6_FMT */
70 #define SERVER_NAME_LENGTH 40
71 #define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)
72
73 /* echo interval in seconds */
74 #define SMB_ECHO_INTERVAL_MIN 1
75 #define SMB_ECHO_INTERVAL_MAX 600
76 #define SMB_ECHO_INTERVAL_DEFAULT 60
77
78 #include "cifspdu.h"
79
80 #ifndef XATTR_DOS_ATTRIB
81 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
82 #endif
83
84 /*
85  * CIFS vfs client Status information (based on what we know.)
86  */
87
88 /* associated with each tcp and smb session */
89 enum statusEnum {
90         CifsNew = 0,
91         CifsGood,
92         CifsExiting,
93         CifsNeedReconnect,
94         CifsNeedNegotiate
95 };
96
97 enum securityEnum {
98         Unspecified = 0,        /* not specified */
99         LANMAN,                 /* Legacy LANMAN auth */
100         NTLM,                   /* Legacy NTLM012 auth with NTLM hash */
101         NTLMv2,                 /* Legacy NTLM auth with NTLMv2 hash */
102         RawNTLMSSP,             /* NTLMSSP without SPNEGO, NTLMv2 hash */
103         Kerberos,               /* Kerberos via SPNEGO */
104 };
105
106 struct session_key {
107         unsigned int len;
108         char *response;
109 };
110
111 /* crypto security descriptor definition */
112 struct sdesc {
113         struct shash_desc shash;
114         char ctx[];
115 };
116
117 /* crypto hashing related structure/fields, not specific to a sec mech */
118 struct cifs_secmech {
119         struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
120         struct crypto_shash *md5; /* md5 hash function */
121         struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
122         struct crypto_shash *cmacaes; /* block-cipher based MAC function */
123         struct sdesc *sdeschmacmd5;  /* ctxt to generate ntlmv2 hash, CR1 */
124         struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
125         struct sdesc *sdeschmacsha256;  /* ctxt to generate smb2 signature */
126         struct sdesc *sdesccmacaes;  /* ctxt to generate smb3 signature */
127 };
128
129 /* per smb session structure/fields */
130 struct ntlmssp_auth {
131         bool sesskey_per_smbsess; /* whether session key is per smb session */
132         __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
133         __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
134         unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
135         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
136 };
137
138 struct cifs_cred {
139         int uid;
140         int gid;
141         int mode;
142         int cecount;
143         struct cifs_sid osid;
144         struct cifs_sid gsid;
145         struct cifs_ntace *ntaces;
146         struct cifs_ace *aces;
147 };
148
149 /*
150  *****************************************************************
151  * Except the CIFS PDUs themselves all the
152  * globally interesting structs should go here
153  *****************************************************************
154  */
155
156 /*
157  * A smb_rqst represents a complete request to be issued to a server. It's
158  * formed by a kvec array, followed by an array of pages. Page data is assumed
159  * to start at the beginning of the first page.
160  */
161 struct smb_rqst {
162         struct kvec     *rq_iov;        /* array of kvecs */
163         unsigned int    rq_nvec;        /* number of kvecs in array */
164         struct page     **rq_pages;     /* pointer to array of page ptrs */
165         unsigned int    rq_npages;      /* number pages in array */
166         unsigned int    rq_pagesz;      /* page size to use */
167         unsigned int    rq_tailsz;      /* length of last page */
168 };
169
170 enum smb_version {
171         Smb_1 = 1,
172         Smb_20,
173         Smb_21,
174         Smb_30,
175         Smb_302,
176 #ifdef CONFIG_CIFS_SMB311
177         Smb_311,
178 #endif /* SMB311 */
179         Smb_version_err
180 };
181
182 struct mid_q_entry;
183 struct TCP_Server_Info;
184 struct cifsFileInfo;
185 struct cifs_ses;
186 struct cifs_tcon;
187 struct dfs_info3_param;
188 struct cifs_fattr;
189 struct smb_vol;
190 struct cifs_fid;
191 struct cifs_readdata;
192 struct cifs_writedata;
193 struct cifs_io_parms;
194 struct cifs_search_info;
195 struct cifsInodeInfo;
196 struct cifs_open_parms;
197
198 struct smb_version_operations {
199         int (*send_cancel)(struct TCP_Server_Info *, void *,
200                            struct mid_q_entry *);
201         bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
202         /* setup request: allocate mid, sign message */
203         struct mid_q_entry *(*setup_request)(struct cifs_ses *,
204                                                 struct smb_rqst *);
205         /* setup async request: allocate mid, sign message */
206         struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
207                                                 struct smb_rqst *);
208         /* check response: verify signature, map error */
209         int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
210                              bool);
211         void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
212                             const int);
213         void (*set_credits)(struct TCP_Server_Info *, const int);
214         int * (*get_credits_field)(struct TCP_Server_Info *, const int);
215         unsigned int (*get_credits)(struct mid_q_entry *);
216         __u64 (*get_next_mid)(struct TCP_Server_Info *);
217         /* data offset from read response message */
218         unsigned int (*read_data_offset)(char *);
219         /* data length from read response message */
220         unsigned int (*read_data_length)(char *);
221         /* map smb to linux error */
222         int (*map_error)(char *, bool);
223         /* find mid corresponding to the response message */
224         struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
225         void (*dump_detail)(void *);
226         void (*clear_stats)(struct cifs_tcon *);
227         void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
228         void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
229         /* verify the message */
230         int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
231         bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
232         void (*downgrade_oplock)(struct TCP_Server_Info *,
233                                         struct cifsInodeInfo *, bool);
234         /* process transaction2 response */
235         bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
236                              char *, int);
237         /* check if we need to negotiate */
238         bool (*need_neg)(struct TCP_Server_Info *);
239         /* negotiate to the server */
240         int (*negotiate)(const unsigned int, struct cifs_ses *);
241         /* set negotiated write size */
242         unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
243         /* set negotiated read size */
244         unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
245         /* setup smb sessionn */
246         int (*sess_setup)(const unsigned int, struct cifs_ses *,
247                           const struct nls_table *);
248         /* close smb session */
249         int (*logoff)(const unsigned int, struct cifs_ses *);
250         /* connect to a server share */
251         int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
252                             struct cifs_tcon *, const struct nls_table *);
253         /* close tree connecion */
254         int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
255         /* get DFS referrals */
256         int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
257                              const char *, struct dfs_info3_param **,
258                              unsigned int *, const struct nls_table *, int);
259         /* informational QFS call */
260         void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
261         /* check if a path is accessible or not */
262         int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
263                                   struct cifs_sb_info *, const char *);
264         /* query path data from the server */
265         int (*query_path_info)(const unsigned int, struct cifs_tcon *,
266                                struct cifs_sb_info *, const char *,
267                                FILE_ALL_INFO *, bool *, bool *);
268         /* query file data from the server */
269         int (*query_file_info)(const unsigned int, struct cifs_tcon *,
270                                struct cifs_fid *, FILE_ALL_INFO *);
271         /* get server index number */
272         int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
273                             struct cifs_sb_info *, const char *,
274                             u64 *uniqueid, FILE_ALL_INFO *);
275         /* set size by path */
276         int (*set_path_size)(const unsigned int, struct cifs_tcon *,
277                              const char *, __u64, struct cifs_sb_info *, bool);
278         /* set size by file handle */
279         int (*set_file_size)(const unsigned int, struct cifs_tcon *,
280                              struct cifsFileInfo *, __u64, bool);
281         /* set attributes */
282         int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
283                              const unsigned int);
284         int (*set_compression)(const unsigned int, struct cifs_tcon *,
285                                struct cifsFileInfo *);
286         /* check if we can send an echo or nor */
287         bool (*can_echo)(struct TCP_Server_Info *);
288         /* send echo request */
289         int (*echo)(struct TCP_Server_Info *);
290         /* create directory */
291         int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
292                      struct cifs_sb_info *);
293         /* set info on created directory */
294         void (*mkdir_setinfo)(struct inode *, const char *,
295                               struct cifs_sb_info *, struct cifs_tcon *,
296                               const unsigned int);
297         /* remove directory */
298         int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
299                      struct cifs_sb_info *);
300         /* unlink file */
301         int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
302                       struct cifs_sb_info *);
303         /* open, rename and delete file */
304         int (*rename_pending_delete)(const char *, struct dentry *,
305                                      const unsigned int);
306         /* send rename request */
307         int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
308                       const char *, struct cifs_sb_info *);
309         /* send create hardlink request */
310         int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
311                                const char *, const char *,
312                                struct cifs_sb_info *);
313         /* query symlink target */
314         int (*query_symlink)(const unsigned int, struct cifs_tcon *,
315                              const char *, char **, struct cifs_sb_info *);
316         /* open a file for non-posix mounts */
317         int (*open)(const unsigned int, struct cifs_open_parms *,
318                     __u32 *, FILE_ALL_INFO *);
319         /* set fid protocol-specific info */
320         void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
321         /* close a file */
322         void (*close)(const unsigned int, struct cifs_tcon *,
323                       struct cifs_fid *);
324         /* send a flush request to the server */
325         int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
326         /* async read from the server */
327         int (*async_readv)(struct cifs_readdata *);
328         /* async write to the server */
329         int (*async_writev)(struct cifs_writedata *,
330                             void (*release)(struct kref *));
331         /* sync read from the server */
332         int (*sync_read)(const unsigned int, struct cifs_fid *,
333                          struct cifs_io_parms *, unsigned int *, char **,
334                          int *);
335         /* sync write to the server */
336         int (*sync_write)(const unsigned int, struct cifs_fid *,
337                           struct cifs_io_parms *, unsigned int *, struct kvec *,
338                           unsigned long);
339         /* open dir, start readdir */
340         int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
341                                const char *, struct cifs_sb_info *,
342                                struct cifs_fid *, __u16,
343                                struct cifs_search_info *);
344         /* continue readdir */
345         int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
346                               struct cifs_fid *,
347                               __u16, struct cifs_search_info *srch_inf);
348         /* close dir */
349         int (*close_dir)(const unsigned int, struct cifs_tcon *,
350                          struct cifs_fid *);
351         /* calculate a size of SMB message */
352         unsigned int (*calc_smb_size)(void *);
353         /* check for STATUS_PENDING and process it in a positive case */
354         bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
355         /* send oplock break response */
356         int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
357                                struct cifsInodeInfo *);
358         /* query remote filesystem */
359         int (*queryfs)(const unsigned int, struct cifs_tcon *,
360                        struct kstatfs *);
361         /* send mandatory brlock to the server */
362         int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
363                          __u64, __u32, int, int, bool);
364         /* unlock range of mandatory locks */
365         int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
366                                  const unsigned int);
367         /* push brlocks from the cache to the server */
368         int (*push_mand_locks)(struct cifsFileInfo *);
369         /* get lease key of the inode */
370         void (*get_lease_key)(struct inode *, struct cifs_fid *);
371         /* set lease key of the inode */
372         void (*set_lease_key)(struct inode *, struct cifs_fid *);
373         /* generate new lease key */
374         void (*new_lease_key)(struct cifs_fid *);
375         int (*generate_signingkey)(struct cifs_ses *);
376         int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
377         int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
378                              struct cifsFileInfo *src_file);
379         int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
380                                 struct cifs_sb_info *, const unsigned char *,
381                                 char *, unsigned int *);
382         int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
383                                  struct cifs_sb_info *, const unsigned char *,
384                                  char *, unsigned int *);
385         /* if we can do cache read operations */
386         bool (*is_read_op)(__u32);
387         /* set oplock level for the inode */
388         void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
389                                  bool *);
390         /* create lease context buffer for CREATE request */
391         char * (*create_lease_buf)(u8 *, u8);
392         /* parse lease context buffer and return oplock/epoch info */
393         __u8 (*parse_lease_buf)(void *, unsigned int *);
394         int (*clone_range)(const unsigned int, struct cifsFileInfo *src_file,
395                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
396                         u64 dest_off);
397         int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
398                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
399                         u64 dest_off);
400         int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
401         ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
402                         const unsigned char *, const unsigned char *, char *,
403                         size_t, const struct nls_table *, int);
404         int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
405                         const char *, const void *, const __u16,
406                         const struct nls_table *, int);
407         struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
408                         const char *, u32 *);
409         struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
410                         const struct cifs_fid *, u32 *);
411         int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
412                         int);
413         /* writepages retry size */
414         unsigned int (*wp_retry_size)(struct inode *);
415         /* get mtu credits */
416         int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
417                                 unsigned int *, unsigned int *);
418         /* check if we need to issue closedir */
419         bool (*dir_needs_close)(struct cifsFileInfo *);
420         long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
421                           loff_t);
422 };
423
424 struct smb_version_values {
425         char            *version_string;
426         __u16           protocol_id;
427         __u32           req_capabilities;
428         __u32           large_lock_type;
429         __u32           exclusive_lock_type;
430         __u32           shared_lock_type;
431         __u32           unlock_lock_type;
432         size_t          header_size;
433         size_t          max_header_size;
434         size_t          read_rsp_size;
435         __le16          lock_cmd;
436         unsigned int    cap_unix;
437         unsigned int    cap_nt_find;
438         unsigned int    cap_large_files;
439         __u16           signing_enabled;
440         __u16           signing_required;
441         size_t          create_lease_size;
442 };
443
444 #define HEADER_SIZE(server) (server->vals->header_size)
445 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
446
447 struct smb_vol {
448         char *username;
449         char *password;
450         char *domainname;
451         char *UNC;
452         char *iocharset;  /* local code page for mapping to and from Unicode */
453         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
454         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
455         kuid_t cred_uid;
456         kuid_t linux_uid;
457         kgid_t linux_gid;
458         kuid_t backupuid;
459         kgid_t backupgid;
460         umode_t file_mode;
461         umode_t dir_mode;
462         enum securityEnum sectype; /* sectype requested via mnt opts */
463         bool sign; /* was signing requested via mnt opts? */
464         bool retry:1;
465         bool intr:1;
466         bool setuids:1;
467         bool override_uid:1;
468         bool override_gid:1;
469         bool dynperm:1;
470         bool noperm:1;
471         bool no_psx_acl:1; /* set if posix acl support should be disabled */
472         bool cifs_acl:1;
473         bool backupuid_specified; /* mount option  backupuid  is specified */
474         bool backupgid_specified; /* mount option  backupgid  is specified */
475         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
476         bool server_ino:1; /* use inode numbers from server ie UniqueId */
477         bool direct_io:1;
478         bool strict_io:1; /* strict cache behavior */
479         bool remap:1;      /* set to remap seven reserved chars in filenames */
480         bool sfu_remap:1;  /* remap seven reserved chars ala SFU */
481         bool posix_paths:1; /* unset to not ask for posix pathnames. */
482         bool no_linux_ext:1;
483         bool sfu_emul:1;
484         bool nullauth:1;   /* attempt to authenticate with null user */
485         bool nocase:1;     /* request case insensitive filenames */
486         bool nobrl:1;      /* disable sending byte range locks to srv */
487         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
488         bool seal:1;       /* request transport encryption on share */
489         bool nodfs:1;      /* Do not request DFS, even if available */
490         bool local_lease:1; /* check leases only on local system, not remote */
491         bool noblocksnd:1;
492         bool noautotune:1;
493         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
494         bool fsc:1;     /* enable fscache */
495         bool mfsymlinks:1; /* use Minshall+French Symlinks */
496         bool multiuser:1;
497         bool rwpidforward:1; /* pid forward for read/write operations */
498         bool nosharesock:1;
499         bool persistent:1;
500         bool nopersistent:1;
501         bool resilient:1; /* noresilient not required since not fored for CA */
502         unsigned int rsize;
503         unsigned int wsize;
504         bool sockopt_tcp_nodelay:1;
505         unsigned long actimeo; /* attribute cache timeout (jiffies) */
506         struct smb_version_operations *ops;
507         struct smb_version_values *vals;
508         char *prepath;
509         struct sockaddr_storage dstaddr; /* destination address */
510         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
511         struct nls_table *local_nls;
512         unsigned int echo_interval; /* echo interval in secs */
513 };
514
515 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
516                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
517                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
518                          CIFS_MOUNT_MAP_SFM_CHR | \
519                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
520                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
521                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
522                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
523                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
524                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
525                          CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
526
527 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
528                       MS_NODEV | MS_SYNCHRONOUS)
529
530 struct cifs_mnt_data {
531         struct cifs_sb_info *cifs_sb;
532         struct smb_vol *vol;
533         int flags;
534 };
535
536 static inline unsigned int
537 get_rfc1002_length(void *buf)
538 {
539         return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
540 }
541
542 static inline void
543 inc_rfc1001_len(void *buf, int count)
544 {
545         be32_add_cpu((__be32 *)buf, count);
546 }
547
548 struct TCP_Server_Info {
549         struct list_head tcp_ses_list;
550         struct list_head smb_ses_list;
551         int srv_count; /* reference counter */
552         /* 15 character server name + 0x20 16th byte indicating type = srv */
553         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
554         struct smb_version_operations   *ops;
555         struct smb_version_values       *vals;
556         enum statusEnum tcpStatus; /* what we think the status is */
557         char *hostname; /* hostname portion of UNC string */
558         struct socket *ssocket;
559         struct sockaddr_storage dstaddr;
560         struct sockaddr_storage srcaddr; /* locally bind to this IP */
561 #ifdef CONFIG_NET_NS
562         struct net *net;
563 #endif
564         wait_queue_head_t response_q;
565         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
566         struct list_head pending_mid_q;
567         bool noblocksnd;                /* use blocking sendmsg */
568         bool noautotune;                /* do not autotune send buf sizes */
569         bool tcp_nodelay;
570         int credits;  /* send no more requests at once */
571         unsigned int in_flight;  /* number of requests on the wire to server */
572         spinlock_t req_lock;  /* protect the two values above */
573         struct mutex srv_mutex;
574         struct task_struct *tsk;
575         char server_GUID[16];
576         __u16 sec_mode;
577         bool sign; /* is signing enabled on this connection? */
578         bool session_estab; /* mark when very first sess is established */
579 #ifdef CONFIG_CIFS_SMB2
580         int echo_credits;  /* echo reserved slots */
581         int oplock_credits;  /* oplock break reserved slots */
582         bool echoes:1; /* enable echoes */
583         __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
584 #endif
585         u16 dialect; /* dialect index that server chose */
586         bool oplocks:1; /* enable oplocks */
587         unsigned int maxReq;    /* Clients should submit no more */
588         /* than maxReq distinct unanswered SMBs to the server when using  */
589         /* multiplexed reads or writes */
590         unsigned int maxBuf;    /* maxBuf specifies the maximum */
591         /* message size the server can send or receive for non-raw SMBs */
592         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
593         /* when socket is setup (and during reconnect) before NegProt sent */
594         unsigned int max_rw;    /* maxRw specifies the maximum */
595         /* message size the server can send or receive for */
596         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
597         unsigned int capabilities; /* selective disabling of caps by smb sess */
598         int timeAdj;  /* Adjust for difference in server time zone in sec */
599         __u64 CurrentMid;         /* multiplex id - rotating counter */
600         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
601         /* 16th byte of RFC1001 workstation name is always null */
602         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
603         __u32 sequence_number; /* for signing, protected by srv_mutex */
604         struct session_key session_key;
605         unsigned long lstrp; /* when we got last response from this server */
606         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
607 #define CIFS_NEGFLAVOR_LANMAN   0       /* wct == 13, LANMAN */
608 #define CIFS_NEGFLAVOR_UNENCAP  1       /* wct == 17, but no ext_sec */
609 #define CIFS_NEGFLAVOR_EXTENDED 2       /* wct == 17, ext_sec bit set */
610         char    negflavor;      /* NEGOTIATE response flavor */
611         /* extended security flavors that server supports */
612         bool    sec_ntlmssp;            /* supports NTLMSSP */
613         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
614         bool    sec_kerberos;           /* supports plain Kerberos */
615         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
616         bool    large_buf;              /* is current buffer large? */
617         struct delayed_work     echo; /* echo ping workqueue job */
618         char    *smallbuf;      /* pointer to current "small" buffer */
619         char    *bigbuf;        /* pointer to current "big" buffer */
620         unsigned int total_read; /* total amount of data read in this pass */
621 #ifdef CONFIG_CIFS_FSCACHE
622         struct fscache_cookie   *fscache; /* client index cache cookie */
623 #endif
624 #ifdef CONFIG_CIFS_STATS2
625         atomic_t in_send; /* requests trying to send */
626         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
627 #endif
628 #ifdef CONFIG_CIFS_SMB2
629         unsigned int    max_read;
630         unsigned int    max_write;
631         __u8            preauth_hash[512];
632 #endif /* CONFIG_CIFS_SMB2 */
633         unsigned long echo_interval;
634 };
635
636 static inline unsigned int
637 in_flight(struct TCP_Server_Info *server)
638 {
639         unsigned int num;
640         spin_lock(&server->req_lock);
641         num = server->in_flight;
642         spin_unlock(&server->req_lock);
643         return num;
644 }
645
646 static inline bool
647 has_credits(struct TCP_Server_Info *server, int *credits)
648 {
649         int num;
650         spin_lock(&server->req_lock);
651         num = *credits;
652         spin_unlock(&server->req_lock);
653         return num > 0;
654 }
655
656 static inline void
657 add_credits(struct TCP_Server_Info *server, const unsigned int add,
658             const int optype)
659 {
660         server->ops->add_credits(server, add, optype);
661 }
662
663 static inline void
664 add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
665                         const int optype)
666 {
667         if (add) {
668                 server->ops->add_credits(server, add, optype);
669                 wake_up(&server->request_q);
670         }
671 }
672
673 static inline void
674 set_credits(struct TCP_Server_Info *server, const int val)
675 {
676         server->ops->set_credits(server, val);
677 }
678
679 static inline __le64
680 get_next_mid64(struct TCP_Server_Info *server)
681 {
682         return cpu_to_le64(server->ops->get_next_mid(server));
683 }
684
685 static inline __le16
686 get_next_mid(struct TCP_Server_Info *server)
687 {
688         __u16 mid = server->ops->get_next_mid(server);
689         /*
690          * The value in the SMB header should be little endian for easy
691          * on-the-wire decoding.
692          */
693         return cpu_to_le16(mid);
694 }
695
696 static inline __u16
697 get_mid(const struct smb_hdr *smb)
698 {
699         return le16_to_cpu(smb->Mid);
700 }
701
702 static inline bool
703 compare_mid(__u16 mid, const struct smb_hdr *smb)
704 {
705         return mid == le16_to_cpu(smb->Mid);
706 }
707
708 /*
709  * When the server supports very large reads and writes via POSIX extensions,
710  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
711  * including the RFC1001 length.
712  *
713  * Note that this might make for "interesting" allocation problems during
714  * writeback however as we have to allocate an array of pointers for the
715  * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
716  *
717  * For reads, there is a similar problem as we need to allocate an array
718  * of kvecs to handle the receive, though that should only need to be done
719  * once.
720  */
721 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
722 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
723
724 /*
725  * When the server doesn't allow large posix writes, only allow a rsize/wsize
726  * of 2^17-1 minus the size of the call header. That allows for a read or
727  * write up to the maximum size described by RFC1002.
728  */
729 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
730 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
731
732 /*
733  * The default wsize is 1M. find_get_pages seems to return a maximum of 256
734  * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
735  * a single wsize request with a single call.
736  */
737 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
738
739 /*
740  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
741  * those values when posix extensions aren't in force. In actuality here, we
742  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
743  * to be ok with the extra byte even though Windows doesn't send writes that
744  * are that large.
745  *
746  * Citation:
747  *
748  * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
749  */
750 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
751 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
752
753 /*
754  * Macros to allow the TCP_Server_Info->net field and related code to drop out
755  * when CONFIG_NET_NS isn't set.
756  */
757
758 #ifdef CONFIG_NET_NS
759
760 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
761 {
762         return srv->net;
763 }
764
765 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
766 {
767         srv->net = net;
768 }
769
770 #else
771
772 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
773 {
774         return &init_net;
775 }
776
777 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
778 {
779 }
780
781 #endif
782
783 /*
784  * Session structure.  One of these for each uid session with a particular host
785  */
786 struct cifs_ses {
787         struct list_head smb_ses_list;
788         struct list_head tcon_list;
789         struct mutex session_mutex;
790         struct TCP_Server_Info *server; /* pointer to server info */
791         int ses_count;          /* reference counter */
792         enum statusEnum status;
793         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
794         __u16 ipc_tid;          /* special tid for connection to IPC share */
795         char *serverOS;         /* name of operating system underlying server */
796         char *serverNOS;        /* name of network operating system of server */
797         char *serverDomain;     /* security realm of server */
798         __u64 Suid;             /* remote smb uid  */
799         kuid_t linux_uid;       /* overriding owner of files on the mount */
800         kuid_t cred_uid;        /* owner of credentials */
801         unsigned int capabilities;
802         char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
803                                 TCP names - will ipv6 and sctp addresses fit? */
804         char *user_name;        /* must not be null except during init of sess
805                                    and after mount option parsing we fill it */
806         char *domainName;
807         char *password;
808         struct session_key auth_key;
809         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
810         enum securityEnum sectype; /* what security flavor was specified? */
811         bool sign;              /* is signing required? */
812         bool need_reconnect:1; /* connection reset, uid now invalid */
813 #ifdef CONFIG_CIFS_SMB2
814         __u16 session_flags;
815         __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
816         __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
817         __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
818         __u8 preauth_hash[512];
819 #endif /* CONFIG_CIFS_SMB2 */
820 };
821
822 static inline bool
823 cap_unix(struct cifs_ses *ses)
824 {
825         return ses->server->vals->cap_unix & ses->capabilities;
826 }
827
828 /*
829  * there is one of these for each connection to a resource on a particular
830  * session
831  */
832 struct cifs_tcon {
833         struct list_head tcon_list;
834         int tc_count;
835         struct list_head openFileList;
836         struct cifs_ses *ses;   /* pointer to session associated with */
837         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
838         char *nativeFileSystem;
839         char *password;         /* for share-level security */
840         __u32 tid;              /* The 4 byte tree id */
841         __u16 Flags;            /* optional support bits */
842         enum statusEnum tidStatus;
843 #ifdef CONFIG_CIFS_STATS
844         atomic_t num_smbs_sent;
845         union {
846                 struct {
847                         atomic_t num_writes;
848                         atomic_t num_reads;
849                         atomic_t num_flushes;
850                         atomic_t num_oplock_brks;
851                         atomic_t num_opens;
852                         atomic_t num_closes;
853                         atomic_t num_deletes;
854                         atomic_t num_mkdirs;
855                         atomic_t num_posixopens;
856                         atomic_t num_posixmkdirs;
857                         atomic_t num_rmdirs;
858                         atomic_t num_renames;
859                         atomic_t num_t2renames;
860                         atomic_t num_ffirst;
861                         atomic_t num_fnext;
862                         atomic_t num_fclose;
863                         atomic_t num_hardlinks;
864                         atomic_t num_symlinks;
865                         atomic_t num_locks;
866                         atomic_t num_acl_get;
867                         atomic_t num_acl_set;
868                 } cifs_stats;
869 #ifdef CONFIG_CIFS_SMB2
870                 struct {
871                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
872                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
873                 } smb2_stats;
874 #endif /* CONFIG_CIFS_SMB2 */
875         } stats;
876 #ifdef CONFIG_CIFS_STATS2
877         unsigned long long time_writes;
878         unsigned long long time_reads;
879         unsigned long long time_opens;
880         unsigned long long time_deletes;
881         unsigned long long time_closes;
882         unsigned long long time_mkdirs;
883         unsigned long long time_rmdirs;
884         unsigned long long time_renames;
885         unsigned long long time_t2renames;
886         unsigned long long time_ffirst;
887         unsigned long long time_fnext;
888         unsigned long long time_fclose;
889 #endif /* CONFIG_CIFS_STATS2 */
890         __u64    bytes_read;
891         __u64    bytes_written;
892         spinlock_t stat_lock;
893 #endif /* CONFIG_CIFS_STATS */
894         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
895         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
896         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
897         bool ipc:1;             /* set if connection to IPC$ eg for RPC/PIPES */
898         bool retry:1;
899         bool nocase:1;
900         bool seal:1;      /* transport encryption for this mounted share */
901         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
902                                 for this mount even if server would support */
903         bool local_lease:1; /* check leases (only) on local system not remote */
904         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
905         bool broken_sparse_sup; /* if server or share does not support sparse */
906         bool need_reconnect:1; /* connection reset, tid now invalid */
907         bool use_resilient:1; /* use resilient instead of durable handles */
908         bool use_persistent:1; /* use persistent instead of durable handles */
909 #ifdef CONFIG_CIFS_SMB2
910         bool print:1;           /* set if connection to printer share */
911         bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
912         __le32 capabilities;
913         __u32 share_flags;
914         __u32 maximal_access;
915         __u32 vol_serial_number;
916         __le64 vol_create_time;
917         __u32 ss_flags;         /* sector size flags */
918         __u32 perf_sector_size; /* best sector size for perf */
919         __u32 max_chunks;
920         __u32 max_bytes_chunk;
921         __u32 max_bytes_copy;
922 #endif /* CONFIG_CIFS_SMB2 */
923 #ifdef CONFIG_CIFS_FSCACHE
924         u64 resource_id;                /* server resource id */
925         struct fscache_cookie *fscache; /* cookie for share */
926 #endif
927         struct list_head pending_opens; /* list of incomplete opens */
928         /* BB add field for back pointer to sb struct(s)? */
929 };
930
931 /*
932  * This is a refcounted and timestamped container for a tcon pointer. The
933  * container holds a tcon reference. It is considered safe to free one of
934  * these when the tl_count goes to 0. The tl_time is the time of the last
935  * "get" on the container.
936  */
937 struct tcon_link {
938         struct rb_node          tl_rbnode;
939         kuid_t                  tl_uid;
940         unsigned long           tl_flags;
941 #define TCON_LINK_MASTER        0
942 #define TCON_LINK_PENDING       1
943 #define TCON_LINK_IN_TREE       2
944         unsigned long           tl_time;
945         atomic_t                tl_count;
946         struct cifs_tcon        *tl_tcon;
947 };
948
949 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
950
951 static inline struct cifs_tcon *
952 tlink_tcon(struct tcon_link *tlink)
953 {
954         return tlink->tl_tcon;
955 }
956
957 extern void cifs_put_tlink(struct tcon_link *tlink);
958
959 static inline struct tcon_link *
960 cifs_get_tlink(struct tcon_link *tlink)
961 {
962         if (tlink && !IS_ERR(tlink))
963                 atomic_inc(&tlink->tl_count);
964         return tlink;
965 }
966
967 /* This function is always expected to succeed */
968 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
969
970 #define CIFS_OPLOCK_NO_CHANGE 0xfe
971
972 struct cifs_pending_open {
973         struct list_head olist;
974         struct tcon_link *tlink;
975         __u8 lease_key[16];
976         __u32 oplock;
977 };
978
979 /*
980  * This info hangs off the cifsFileInfo structure, pointed to by llist.
981  * This is used to track byte stream locks on the file
982  */
983 struct cifsLockInfo {
984         struct list_head llist; /* pointer to next cifsLockInfo */
985         struct list_head blist; /* pointer to locks blocked on this */
986         wait_queue_head_t block_q;
987         __u64 offset;
988         __u64 length;
989         __u32 pid;
990         __u32 type;
991 };
992
993 /*
994  * One of these for each open instance of a file
995  */
996 struct cifs_search_info {
997         loff_t index_of_last_entry;
998         __u16 entries_in_buffer;
999         __u16 info_level;
1000         __u32 resume_key;
1001         char *ntwrk_buf_start;
1002         char *srch_entries_start;
1003         char *last_entry;
1004         const char *presume_name;
1005         unsigned int resume_name_len;
1006         bool endOfSearch:1;
1007         bool emptyDir:1;
1008         bool unicode:1;
1009         bool smallBuf:1; /* so we know which buf_release function to call */
1010 };
1011
1012 struct cifs_open_parms {
1013         struct cifs_tcon *tcon;
1014         struct cifs_sb_info *cifs_sb;
1015         int disposition;
1016         int desired_access;
1017         int create_options;
1018         const char *path;
1019         struct cifs_fid *fid;
1020         bool reconnect:1;
1021 };
1022
1023 struct cifs_fid {
1024         __u16 netfid;
1025 #ifdef CONFIG_CIFS_SMB2
1026         __u64 persistent_fid;   /* persist file id for smb2 */
1027         __u64 volatile_fid;     /* volatile file id for smb2 */
1028         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for smb2 */
1029         __u8 create_guid[16];
1030 #endif
1031         struct cifs_pending_open *pending_open;
1032         unsigned int epoch;
1033         bool purge_cache;
1034 };
1035
1036 struct cifs_fid_locks {
1037         struct list_head llist;
1038         struct cifsFileInfo *cfile;     /* fid that owns locks */
1039         struct list_head locks;         /* locks held by fid above */
1040 };
1041
1042 struct cifsFileInfo {
1043         struct list_head tlist; /* pointer to next fid owned by tcon */
1044         struct list_head flist; /* next fid (file instance) for this inode */
1045         struct cifs_fid_locks *llist;   /* brlocks held by this fid */
1046         kuid_t uid;             /* allows finding which FileInfo structure */
1047         __u32 pid;              /* process id who opened file */
1048         struct cifs_fid fid;    /* file id from remote */
1049         /* BB add lock scope info here if needed */ ;
1050         /* lock scope id (0 if none) */
1051         struct dentry *dentry;
1052         unsigned int f_flags;
1053         struct tcon_link *tlink;
1054         bool invalidHandle:1;   /* file closed via session abend */
1055         bool oplock_break_cancelled:1;
1056         int count;              /* refcount protected by cifs_file_list_lock */
1057         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1058         struct cifs_search_info srch_inf;
1059         struct work_struct oplock_break; /* work for oplock breaks */
1060 };
1061
1062 struct cifs_io_parms {
1063         __u16 netfid;
1064 #ifdef CONFIG_CIFS_SMB2
1065         __u64 persistent_fid;   /* persist file id for smb2 */
1066         __u64 volatile_fid;     /* volatile file id for smb2 */
1067 #endif
1068         __u32 pid;
1069         __u64 offset;
1070         unsigned int length;
1071         struct cifs_tcon *tcon;
1072 };
1073
1074 struct cifs_readdata;
1075
1076 /* asynchronous read support */
1077 struct cifs_readdata {
1078         struct kref                     refcount;
1079         struct list_head                list;
1080         struct completion               done;
1081         struct cifsFileInfo             *cfile;
1082         struct address_space            *mapping;
1083         __u64                           offset;
1084         unsigned int                    bytes;
1085         unsigned int                    got_bytes;
1086         pid_t                           pid;
1087         int                             result;
1088         struct work_struct              work;
1089         int (*read_into_pages)(struct TCP_Server_Info *server,
1090                                 struct cifs_readdata *rdata,
1091                                 unsigned int len);
1092         struct kvec                     iov;
1093         unsigned int                    pagesz;
1094         unsigned int                    tailsz;
1095         unsigned int                    credits;
1096         unsigned int                    nr_pages;
1097         struct page                     *pages[];
1098 };
1099
1100 struct cifs_writedata;
1101
1102 /* asynchronous write support */
1103 struct cifs_writedata {
1104         struct kref                     refcount;
1105         struct list_head                list;
1106         struct completion               done;
1107         enum writeback_sync_modes       sync_mode;
1108         struct work_struct              work;
1109         struct cifsFileInfo             *cfile;
1110         __u64                           offset;
1111         pid_t                           pid;
1112         unsigned int                    bytes;
1113         int                             result;
1114         unsigned int                    pagesz;
1115         unsigned int                    tailsz;
1116         unsigned int                    credits;
1117         unsigned int                    nr_pages;
1118         struct page                     *pages[];
1119 };
1120
1121 /*
1122  * Take a reference on the file private data. Must be called with
1123  * cifs_file_list_lock held.
1124  */
1125 static inline void
1126 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1127 {
1128         ++cifs_file->count;
1129 }
1130
1131 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1132 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1133
1134 #define CIFS_CACHE_READ_FLG     1
1135 #define CIFS_CACHE_HANDLE_FLG   2
1136 #define CIFS_CACHE_RH_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1137 #define CIFS_CACHE_WRITE_FLG    4
1138 #define CIFS_CACHE_RW_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1139 #define CIFS_CACHE_RHW_FLG      (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1140
1141 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1142 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1143 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1144
1145 /*
1146  * One of these for each file inode
1147  */
1148
1149 struct cifsInodeInfo {
1150         bool can_cache_brlcks;
1151         struct list_head llist; /* locks helb by this inode */
1152         struct rw_semaphore lock_sem;   /* protect the fields above */
1153         /* BB add in lists for dirty pages i.e. write caching info for oplock */
1154         struct list_head openFileList;
1155         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1156         unsigned int oplock;            /* oplock/lease level we have */
1157         unsigned int epoch;             /* used to track lease state changes */
1158 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1159 #define CIFS_INODE_PENDING_WRITERS        (1) /* Writes in progress */
1160 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1161 #define CIFS_INO_DELETE_PENDING           (3) /* delete pending on server */
1162 #define CIFS_INO_INVALID_MAPPING          (4) /* pagecache is invalid */
1163 #define CIFS_INO_LOCK                     (5) /* lock bit for synchronization */
1164         unsigned long flags;
1165         spinlock_t writers_lock;
1166         unsigned int writers;           /* Number of writers on this inode */
1167         unsigned long time;             /* jiffies of last update of inode */
1168         u64  server_eof;                /* current file size on server -- protected by i_lock */
1169         u64  uniqueid;                  /* server inode number */
1170         u64  createtime;                /* creation time on server */
1171 #ifdef CONFIG_CIFS_SMB2
1172         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for this inode */
1173 #endif
1174 #ifdef CONFIG_CIFS_FSCACHE
1175         struct fscache_cookie *fscache;
1176 #endif
1177         struct inode vfs_inode;
1178 };
1179
1180 static inline struct cifsInodeInfo *
1181 CIFS_I(struct inode *inode)
1182 {
1183         return container_of(inode, struct cifsInodeInfo, vfs_inode);
1184 }
1185
1186 static inline struct cifs_sb_info *
1187 CIFS_SB(struct super_block *sb)
1188 {
1189         return sb->s_fs_info;
1190 }
1191
1192 static inline struct cifs_sb_info *
1193 CIFS_FILE_SB(struct file *file)
1194 {
1195         return CIFS_SB(file_inode(file)->i_sb);
1196 }
1197
1198 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1199 {
1200         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1201                 return '/';
1202         else
1203                 return '\\';
1204 }
1205
1206 static inline void
1207 convert_delimiter(char *path, char delim)
1208 {
1209         char old_delim, *pos;
1210
1211         if (delim == '/')
1212                 old_delim = '\\';
1213         else
1214                 old_delim = '/';
1215
1216         pos = path;
1217         while ((pos = strchr(pos, old_delim)))
1218                 *pos = delim;
1219 }
1220
1221 #ifdef CONFIG_CIFS_STATS
1222 #define cifs_stats_inc atomic_inc
1223
1224 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1225                                             unsigned int bytes)
1226 {
1227         if (bytes) {
1228                 spin_lock(&tcon->stat_lock);
1229                 tcon->bytes_written += bytes;
1230                 spin_unlock(&tcon->stat_lock);
1231         }
1232 }
1233
1234 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1235                                          unsigned int bytes)
1236 {
1237         spin_lock(&tcon->stat_lock);
1238         tcon->bytes_read += bytes;
1239         spin_unlock(&tcon->stat_lock);
1240 }
1241 #else
1242
1243 #define  cifs_stats_inc(field) do {} while (0)
1244 #define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1245 #define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1246
1247 #endif
1248
1249
1250 /*
1251  * This is the prototype for the mid receive function. This function is for
1252  * receiving the rest of the SMB frame, starting with the WordCount (which is
1253  * just after the MID in struct smb_hdr). Note:
1254  *
1255  * - This will be called by cifsd, with no locks held.
1256  * - The mid will still be on the pending_mid_q.
1257  * - mid->resp_buf will point to the current buffer.
1258  *
1259  * Returns zero on a successful receive, or an error. The receive state in
1260  * the TCP_Server_Info will also be updated.
1261  */
1262 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1263                             struct mid_q_entry *mid);
1264
1265 /*
1266  * This is the prototype for the mid callback function. This is called once the
1267  * mid has been received off of the socket. When creating one, take special
1268  * care to avoid deadlocks. Things to bear in mind:
1269  *
1270  * - it will be called by cifsd, with no locks held
1271  * - the mid will be removed from any lists
1272  */
1273 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1274
1275 /* one of these for every pending CIFS request to the server */
1276 struct mid_q_entry {
1277         struct list_head qhead; /* mids waiting on reply from this server */
1278         struct TCP_Server_Info *server; /* server corresponding to this mid */
1279         __u64 mid;              /* multiplex id */
1280         __u32 pid;              /* process id */
1281         __u32 sequence_number;  /* for CIFS signing */
1282         unsigned long when_alloc;  /* when mid was created */
1283 #ifdef CONFIG_CIFS_STATS2
1284         unsigned long when_sent; /* time when smb send finished */
1285         unsigned long when_received; /* when demux complete (taken off wire) */
1286 #endif
1287         mid_receive_t *receive; /* call receive callback */
1288         mid_callback_t *callback; /* call completion callback */
1289         void *callback_data;      /* general purpose pointer for callback */
1290         void *resp_buf;         /* pointer to received SMB header */
1291         int mid_state;  /* wish this were enum but can not pass to wait_event */
1292         __le16 command;         /* smb command code */
1293         bool large_buf:1;       /* if valid response, is pointer to large buf */
1294         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1295         bool multiEnd:1;        /* both received */
1296 };
1297
1298 /*      Make code in transport.c a little cleaner by moving
1299         update of optional stats into function below */
1300 #ifdef CONFIG_CIFS_STATS2
1301
1302 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1303 {
1304         atomic_inc(&server->in_send);
1305 }
1306
1307 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1308 {
1309         atomic_dec(&server->in_send);
1310 }
1311
1312 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1313 {
1314         atomic_inc(&server->num_waiters);
1315 }
1316
1317 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1318 {
1319         atomic_dec(&server->num_waiters);
1320 }
1321
1322 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1323 {
1324         mid->when_sent = jiffies;
1325 }
1326 #else
1327 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1328 {
1329 }
1330 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1331 {
1332 }
1333
1334 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1335 {
1336 }
1337
1338 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1339 {
1340 }
1341
1342 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1343 {
1344 }
1345 #endif
1346
1347 /* for pending dnotify requests */
1348 struct dir_notify_req {
1349         struct list_head lhead;
1350         __le16 Pid;
1351         __le16 PidHigh;
1352         __u16 Mid;
1353         __u16 Tid;
1354         __u16 Uid;
1355         __u16 netfid;
1356         __u32 filter; /* CompletionFilter (for multishot) */
1357         int multishot;
1358         struct file *pfile;
1359 };
1360
1361 struct dfs_info3_param {
1362         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1363         int path_consumed;
1364         int server_type;
1365         int ref_flag;
1366         char *path_name;
1367         char *node_name;
1368 };
1369
1370 /*
1371  * common struct for holding inode info when searching for or updating an
1372  * inode with new info
1373  */
1374
1375 #define CIFS_FATTR_DFS_REFERRAL         0x1
1376 #define CIFS_FATTR_DELETE_PENDING       0x2
1377 #define CIFS_FATTR_NEED_REVAL           0x4
1378 #define CIFS_FATTR_INO_COLLISION        0x8
1379 #define CIFS_FATTR_UNKNOWN_NLINK        0x10
1380
1381 struct cifs_fattr {
1382         u32             cf_flags;
1383         u32             cf_cifsattrs;
1384         u64             cf_uniqueid;
1385         u64             cf_eof;
1386         u64             cf_bytes;
1387         u64             cf_createtime;
1388         kuid_t          cf_uid;
1389         kgid_t          cf_gid;
1390         umode_t         cf_mode;
1391         dev_t           cf_rdev;
1392         unsigned int    cf_nlink;
1393         unsigned int    cf_dtype;
1394         struct timespec cf_atime;
1395         struct timespec cf_mtime;
1396         struct timespec cf_ctime;
1397 };
1398
1399 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1400 {
1401         if (param) {
1402                 kfree(param->path_name);
1403                 kfree(param->node_name);
1404                 kfree(param);
1405         }
1406 }
1407
1408 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1409                                        int number_of_items)
1410 {
1411         int i;
1412         if ((number_of_items == 0) || (param == NULL))
1413                 return;
1414         for (i = 0; i < number_of_items; i++) {
1415                 kfree(param[i].path_name);
1416                 kfree(param[i].node_name);
1417         }
1418         kfree(param);
1419 }
1420
1421 #define   MID_FREE 0
1422 #define   MID_REQUEST_ALLOCATED 1
1423 #define   MID_REQUEST_SUBMITTED 2
1424 #define   MID_RESPONSE_RECEIVED 4
1425 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1426 #define   MID_RESPONSE_MALFORMED 0x10
1427 #define   MID_SHUTDOWN           0x20
1428
1429 /* Types of response buffer returned from SendReceive2 */
1430 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1431 #define   CIFS_SMALL_BUFFER     1
1432 #define   CIFS_LARGE_BUFFER     2
1433 #define   CIFS_IOVEC            4    /* array of response buffers */
1434
1435 /* Type of Request to SendReceive2 */
1436 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1437 #define   CIFS_ASYNC_OP         2    /* do not wait for response */
1438 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1439 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1440 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1441 #define   CIFS_NO_RESP      0x040    /* no response buffer required */
1442
1443 /* Type of request operation */
1444 #define   CIFS_ECHO_OP      0x080    /* echo request */
1445 #define   CIFS_OBREAK_OP   0x0100    /* oplock break request */
1446 #define   CIFS_NEG_OP      0x0200    /* negotiate request */
1447 #define   CIFS_OP_MASK     0x0380    /* mask request type */
1448 #define   CIFS_HAS_CREDITS 0x0400    /* already has credits */
1449
1450 /* Security Flags: indicate type of session setup needed */
1451 #define   CIFSSEC_MAY_SIGN      0x00001
1452 #define   CIFSSEC_MAY_NTLM      0x00002
1453 #define   CIFSSEC_MAY_NTLMV2    0x00004
1454 #define   CIFSSEC_MAY_KRB5      0x00008
1455 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1456 #define   CIFSSEC_MAY_LANMAN    0x00010
1457 #define   CIFSSEC_MAY_PLNTXT    0x00020
1458 #else
1459 #define   CIFSSEC_MAY_LANMAN    0
1460 #define   CIFSSEC_MAY_PLNTXT    0
1461 #endif /* weak passwords */
1462 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
1463 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
1464
1465 #define   CIFSSEC_MUST_SIGN     0x01001
1466 /* note that only one of the following can be set so the
1467 result of setting MUST flags more than once will be to
1468 require use of the stronger protocol */
1469 #define   CIFSSEC_MUST_NTLM     0x02002
1470 #define   CIFSSEC_MUST_NTLMV2   0x04004
1471 #define   CIFSSEC_MUST_KRB5     0x08008
1472 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1473 #define   CIFSSEC_MUST_LANMAN   0x10010
1474 #define   CIFSSEC_MUST_PLNTXT   0x20020
1475 #ifdef CONFIG_CIFS_UPCALL
1476 #define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
1477 #else
1478 #define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
1479 #endif /* UPCALL */
1480 #else /* do not allow weak pw hash */
1481 #define   CIFSSEC_MUST_LANMAN   0
1482 #define   CIFSSEC_MUST_PLNTXT   0
1483 #ifdef CONFIG_CIFS_UPCALL
1484 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1485 #else
1486 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1487 #endif /* UPCALL */
1488 #endif /* WEAK_PW_HASH */
1489 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
1490 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
1491
1492 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1493 #define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1494 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1495 /*
1496  *****************************************************************
1497  * All constants go here
1498  *****************************************************************
1499  */
1500
1501 #define UID_HASH (16)
1502
1503 /*
1504  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1505  * following to be declared.
1506  */
1507
1508 /****************************************************************************
1509  *  Locking notes.  All updates to global variables and lists should be
1510  *                  protected by spinlocks or semaphores.
1511  *
1512  *  Spinlocks
1513  *  ---------
1514  *  GlobalMid_Lock protects:
1515  *      list operations on pending_mid_q and oplockQ
1516  *      updates to XID counters, multiplex id  and SMB sequence numbers
1517  *  cifs_file_list_lock protects:
1518  *      list operations on tcp and SMB session lists and tCon lists
1519  *  f_owner.lock protects certain per file struct operations
1520  *  mapping->page_lock protects certain per page operations
1521  *
1522  *  Semaphores
1523  *  ----------
1524  *  sesSem     operations on smb session
1525  *  tconSem    operations on tree connection
1526  *  fh_sem      file handle reconnection operations
1527  *
1528  ****************************************************************************/
1529
1530 #ifdef DECLARE_GLOBALS_HERE
1531 #define GLOBAL_EXTERN
1532 #else
1533 #define GLOBAL_EXTERN extern
1534 #endif
1535
1536 /*
1537  * the list of TCP_Server_Info structures, ie each of the sockets
1538  * connecting our client to a distinct server (ip address), is
1539  * chained together by cifs_tcp_ses_list. The list of all our SMB
1540  * sessions (and from that the tree connections) can be found
1541  * by iterating over cifs_tcp_ses_list
1542  */
1543 GLOBAL_EXTERN struct list_head          cifs_tcp_ses_list;
1544
1545 /*
1546  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1547  * tcp session, and the list of tcon's per smb session. It also protects
1548  * the reference counters for the server, smb session, and tcon. Finally,
1549  * changes to the tcon->tidStatus should be done while holding this lock.
1550  */
1551 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
1552
1553 /*
1554  * This lock protects the cifs_file->llist and cifs_file->flist
1555  * list operations, and updates to some flags (cifs_file->invalidHandle)
1556  * It will be moved to either use the tcon->stat_lock or equivalent later.
1557  * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1558  * the cifs_tcp_ses_lock must be grabbed first and released last.
1559  */
1560 GLOBAL_EXTERN spinlock_t        cifs_file_list_lock;
1561
1562 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1563 /* Outstanding dir notify requests */
1564 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1565 /* DirNotify response queue */
1566 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1567 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1568
1569 /*
1570  * Global transaction id (XID) information
1571  */
1572 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
1573 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1574 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
1575 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
1576                                           /* on midQ entries */
1577 /*
1578  *  Global counters, updated atomically
1579  */
1580 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1581 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1582 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1583 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1584 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1585
1586 /* Various Debug counters */
1587 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
1588 #ifdef CONFIG_CIFS_STATS2
1589 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1590 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1591 #endif
1592 GLOBAL_EXTERN atomic_t smBufAllocCount;
1593 GLOBAL_EXTERN atomic_t midCount;
1594
1595 /* Misc globals */
1596 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1597 GLOBAL_EXTERN bool lookupCacheEnabled;
1598 GLOBAL_EXTERN unsigned int global_secflags;     /* if on, session setup sent
1599                                 with more secure ntlmssp2 challenge/resp */
1600 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
1601 GLOBAL_EXTERN bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1602 GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
1603 GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
1604 GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
1605 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1606
1607 #ifdef CONFIG_CIFS_ACL
1608 GLOBAL_EXTERN struct rb_root uidtree;
1609 GLOBAL_EXTERN struct rb_root gidtree;
1610 GLOBAL_EXTERN spinlock_t siduidlock;
1611 GLOBAL_EXTERN spinlock_t sidgidlock;
1612 GLOBAL_EXTERN struct rb_root siduidtree;
1613 GLOBAL_EXTERN struct rb_root sidgidtree;
1614 GLOBAL_EXTERN spinlock_t uidsidlock;
1615 GLOBAL_EXTERN spinlock_t gidsidlock;
1616 #endif /* CONFIG_CIFS_ACL */
1617
1618 void cifs_oplock_break(struct work_struct *work);
1619
1620 extern const struct slow_work_ops cifs_oplock_break_ops;
1621 extern struct workqueue_struct *cifsiod_wq;
1622 extern __u32 cifs_lock_secret;
1623
1624 extern mempool_t *cifs_mid_poolp;
1625
1626 /* Operations for different SMB versions */
1627 #define SMB1_VERSION_STRING     "1.0"
1628 extern struct smb_version_operations smb1_operations;
1629 extern struct smb_version_values smb1_values;
1630 #define SMB20_VERSION_STRING    "2.0"
1631 extern struct smb_version_operations smb20_operations;
1632 extern struct smb_version_values smb20_values;
1633 #define SMB21_VERSION_STRING    "2.1"
1634 extern struct smb_version_operations smb21_operations;
1635 extern struct smb_version_values smb21_values;
1636 #define SMB30_VERSION_STRING    "3.0"
1637 extern struct smb_version_operations smb30_operations;
1638 extern struct smb_version_values smb30_values;
1639 #define SMB302_VERSION_STRING   "3.02"
1640 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1641 extern struct smb_version_values smb302_values;
1642 #define SMB311_VERSION_STRING   "3.1.1"
1643 #define ALT_SMB311_VERSION_STRING "3.11"
1644 extern struct smb_version_operations smb311_operations;
1645 extern struct smb_version_values smb311_values;
1646 #endif  /* _CIFS_GLOB_H */