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