GNU Linux-libre 4.4.289-gnu1
[releases.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         /* check for STATUS_NETWORK_SESSION_EXPIRED */
355         bool (*is_session_expired)(char *);
356         /* send oplock break response */
357         int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
358                                struct cifsInodeInfo *);
359         /* query remote filesystem */
360         int (*queryfs)(const unsigned int, struct cifs_tcon *,
361                        struct kstatfs *);
362         /* send mandatory brlock to the server */
363         int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
364                          __u64, __u32, int, int, bool);
365         /* unlock range of mandatory locks */
366         int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
367                                  const unsigned int);
368         /* push brlocks from the cache to the server */
369         int (*push_mand_locks)(struct cifsFileInfo *);
370         /* get lease key of the inode */
371         void (*get_lease_key)(struct inode *, struct cifs_fid *);
372         /* set lease key of the inode */
373         void (*set_lease_key)(struct inode *, struct cifs_fid *);
374         /* generate new lease key */
375         void (*new_lease_key)(struct cifs_fid *);
376         int (*generate_signingkey)(struct cifs_ses *);
377         int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
378         int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
379                              struct cifsFileInfo *src_file);
380         int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
381                                 struct cifs_sb_info *, const unsigned char *,
382                                 char *, unsigned int *);
383         int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
384                                  struct cifs_sb_info *, const unsigned char *,
385                                  char *, unsigned int *);
386         /* if we can do cache read operations */
387         bool (*is_read_op)(__u32);
388         /* set oplock level for the inode */
389         void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
390                                  bool *);
391         /* create lease context buffer for CREATE request */
392         char * (*create_lease_buf)(u8 *, u8);
393         /* parse lease context buffer and return oplock/epoch info */
394         __u8 (*parse_lease_buf)(void *, unsigned int *);
395         int (*clone_range)(const unsigned int, struct cifsFileInfo *src_file,
396                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
397                         u64 dest_off);
398         int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
399                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
400                         u64 dest_off);
401         int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
402         ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
403                         const unsigned char *, const unsigned char *, char *,
404                         size_t, const struct nls_table *, int);
405         int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
406                         const char *, const void *, const __u16,
407                         const struct nls_table *, int);
408         struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
409                         const char *, u32 *);
410         struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
411                         const struct cifs_fid *, u32 *);
412         int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
413                         int);
414         /* writepages retry size */
415         unsigned int (*wp_retry_size)(struct inode *);
416         /* get mtu credits */
417         int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
418                                 unsigned int *, unsigned int *);
419         /* check if we need to issue closedir */
420         bool (*dir_needs_close)(struct cifsFileInfo *);
421         long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
422                           loff_t);
423 };
424
425 struct smb_version_values {
426         char            *version_string;
427         __u16           protocol_id;
428         __u32           req_capabilities;
429         __u32           large_lock_type;
430         __u32           exclusive_lock_type;
431         __u32           shared_lock_type;
432         __u32           unlock_lock_type;
433         size_t          header_size;
434         size_t          max_header_size;
435         size_t          read_rsp_size;
436         __le16          lock_cmd;
437         unsigned int    cap_unix;
438         unsigned int    cap_nt_find;
439         unsigned int    cap_large_files;
440         __u16           signing_enabled;
441         __u16           signing_required;
442         size_t          create_lease_size;
443 };
444
445 #define HEADER_SIZE(server) (server->vals->header_size)
446 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
447
448 struct smb_vol {
449         char *username;
450         char *password;
451         char *domainname;
452         char *UNC;
453         char *iocharset;  /* local code page for mapping to and from Unicode */
454         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
455         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
456         kuid_t cred_uid;
457         kuid_t linux_uid;
458         kgid_t linux_gid;
459         kuid_t backupuid;
460         kgid_t backupgid;
461         umode_t file_mode;
462         umode_t dir_mode;
463         enum securityEnum sectype; /* sectype requested via mnt opts */
464         bool sign; /* was signing requested via mnt opts? */
465         bool retry:1;
466         bool intr:1;
467         bool setuids:1;
468         bool override_uid:1;
469         bool override_gid:1;
470         bool dynperm:1;
471         bool noperm:1;
472         bool no_psx_acl:1; /* set if posix acl support should be disabled */
473         bool cifs_acl:1;
474         bool backupuid_specified; /* mount option  backupuid  is specified */
475         bool backupgid_specified; /* mount option  backupgid  is specified */
476         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
477         bool server_ino:1; /* use inode numbers from server ie UniqueId */
478         bool direct_io:1;
479         bool strict_io:1; /* strict cache behavior */
480         bool remap:1;      /* set to remap seven reserved chars in filenames */
481         bool sfu_remap:1;  /* remap seven reserved chars ala SFU */
482         bool posix_paths:1; /* unset to not ask for posix pathnames. */
483         bool no_linux_ext:1;
484         bool sfu_emul:1;
485         bool nullauth:1;   /* attempt to authenticate with null user */
486         bool nocase:1;     /* request case insensitive filenames */
487         bool nobrl:1;      /* disable sending byte range locks to srv */
488         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
489         bool seal:1;       /* request transport encryption on share */
490         bool nodfs:1;      /* Do not request DFS, even if available */
491         bool local_lease:1; /* check leases only on local system, not remote */
492         bool noblocksnd:1;
493         bool noautotune:1;
494         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
495         bool fsc:1;     /* enable fscache */
496         bool mfsymlinks:1; /* use Minshall+French Symlinks */
497         bool multiuser:1;
498         bool rwpidforward:1; /* pid forward for read/write operations */
499         bool nosharesock:1;
500         bool persistent:1;
501         bool nopersistent:1;
502         bool resilient:1; /* noresilient not required since not fored for CA */
503         unsigned int rsize;
504         unsigned int wsize;
505         bool sockopt_tcp_nodelay:1;
506         unsigned long actimeo; /* attribute cache timeout (jiffies) */
507         struct smb_version_operations *ops;
508         struct smb_version_values *vals;
509         char *prepath;
510         struct sockaddr_storage dstaddr; /* destination address */
511         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
512         struct nls_table *local_nls;
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         struct kvec *iov;       /* reusable kvec array for receives */
619         unsigned int nr_iov;    /* number of kvecs in array */
620         char    *smallbuf;      /* pointer to current "small" buffer */
621         char    *bigbuf;        /* pointer to current "big" buffer */
622         unsigned int total_read; /* total amount of data read in this pass */
623 #ifdef CONFIG_CIFS_FSCACHE
624         struct fscache_cookie   *fscache; /* client index cache cookie */
625 #endif
626 #ifdef CONFIG_CIFS_STATS2
627         atomic_t in_send; /* requests trying to send */
628         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
629 #endif
630 #ifdef CONFIG_CIFS_SMB2
631         unsigned int    max_read;
632         unsigned int    max_write;
633         struct delayed_work reconnect; /* reconnect workqueue job */
634         struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
635 #endif /* CONFIG_CIFS_SMB2 */
636 };
637
638 static inline unsigned int
639 in_flight(struct TCP_Server_Info *server)
640 {
641         unsigned int num;
642         spin_lock(&server->req_lock);
643         num = server->in_flight;
644         spin_unlock(&server->req_lock);
645         return num;
646 }
647
648 static inline bool
649 has_credits(struct TCP_Server_Info *server, int *credits)
650 {
651         int num;
652         spin_lock(&server->req_lock);
653         num = *credits;
654         spin_unlock(&server->req_lock);
655         return num > 0;
656 }
657
658 static inline void
659 add_credits(struct TCP_Server_Info *server, const unsigned int add,
660             const int optype)
661 {
662         server->ops->add_credits(server, add, optype);
663 }
664
665 static inline void
666 add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
667                         const int optype)
668 {
669         if (add) {
670                 server->ops->add_credits(server, add, optype);
671                 wake_up(&server->request_q);
672         }
673 }
674
675 static inline void
676 set_credits(struct TCP_Server_Info *server, const int val)
677 {
678         server->ops->set_credits(server, val);
679 }
680
681 static inline __le64
682 get_next_mid64(struct TCP_Server_Info *server)
683 {
684         return cpu_to_le64(server->ops->get_next_mid(server));
685 }
686
687 static inline __le16
688 get_next_mid(struct TCP_Server_Info *server)
689 {
690         __u16 mid = server->ops->get_next_mid(server);
691         /*
692          * The value in the SMB header should be little endian for easy
693          * on-the-wire decoding.
694          */
695         return cpu_to_le16(mid);
696 }
697
698 static inline __u16
699 get_mid(const struct smb_hdr *smb)
700 {
701         return le16_to_cpu(smb->Mid);
702 }
703
704 static inline bool
705 compare_mid(__u16 mid, const struct smb_hdr *smb)
706 {
707         return mid == le16_to_cpu(smb->Mid);
708 }
709
710 /*
711  * When the server supports very large reads and writes via POSIX extensions,
712  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
713  * including the RFC1001 length.
714  *
715  * Note that this might make for "interesting" allocation problems during
716  * writeback however as we have to allocate an array of pointers for the
717  * pages. A 16M write means ~32kb page array with PAGE_CACHE_SIZE == 4096.
718  *
719  * For reads, there is a similar problem as we need to allocate an array
720  * of kvecs to handle the receive, though that should only need to be done
721  * once.
722  */
723 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
724 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
725
726 /*
727  * When the server doesn't allow large posix writes, only allow a rsize/wsize
728  * of 2^17-1 minus the size of the call header. That allows for a read or
729  * write up to the maximum size described by RFC1002.
730  */
731 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
732 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
733
734 /*
735  * The default wsize is 1M. find_get_pages seems to return a maximum of 256
736  * pages in a single call. With PAGE_CACHE_SIZE == 4k, this means we can fill
737  * a single wsize request with a single call.
738  */
739 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
740
741 /*
742  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
743  * those values when posix extensions aren't in force. In actuality here, we
744  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
745  * to be ok with the extra byte even though Windows doesn't send writes that
746  * are that large.
747  *
748  * Citation:
749  *
750  * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
751  */
752 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
753 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
754
755 /*
756  * Macros to allow the TCP_Server_Info->net field and related code to drop out
757  * when CONFIG_NET_NS isn't set.
758  */
759
760 #ifdef CONFIG_NET_NS
761
762 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
763 {
764         return srv->net;
765 }
766
767 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
768 {
769         srv->net = net;
770 }
771
772 #else
773
774 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
775 {
776         return &init_net;
777 }
778
779 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
780 {
781 }
782
783 #endif
784
785 /*
786  * Session structure.  One of these for each uid session with a particular host
787  */
788 struct cifs_ses {
789         struct list_head smb_ses_list;
790         struct list_head tcon_list;
791         struct mutex session_mutex;
792         struct TCP_Server_Info *server; /* pointer to server info */
793         int ses_count;          /* reference counter */
794         enum statusEnum status;
795         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
796         __u16 ipc_tid;          /* special tid for connection to IPC share */
797         char *serverOS;         /* name of operating system underlying server */
798         char *serverNOS;        /* name of network operating system of server */
799         char *serverDomain;     /* security realm of server */
800         __u64 Suid;             /* remote smb uid  */
801         kuid_t linux_uid;       /* overriding owner of files on the mount */
802         kuid_t cred_uid;        /* owner of credentials */
803         unsigned int capabilities;
804         char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
805                                 TCP names - will ipv6 and sctp addresses fit? */
806         char *user_name;        /* must not be null except during init of sess
807                                    and after mount option parsing we fill it */
808         char *domainName;
809         char *password;
810         struct session_key auth_key;
811         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
812         enum securityEnum sectype; /* what security flavor was specified? */
813         bool sign;              /* is signing required? */
814         bool need_reconnect:1; /* connection reset, uid now invalid */
815 #ifdef CONFIG_CIFS_SMB2
816         __u16 session_flags;
817         char smb3signingkey[SMB3_SIGN_KEY_SIZE]; /* for signing smb3 packets */
818 #endif /* CONFIG_CIFS_SMB2 */
819 };
820
821 static inline bool
822 cap_unix(struct cifs_ses *ses)
823 {
824         return ses->server->vals->cap_unix & ses->capabilities;
825 }
826
827 /*
828  * there is one of these for each connection to a resource on a particular
829  * session
830  */
831 struct cifs_tcon {
832         struct list_head tcon_list;
833         int tc_count;
834         struct list_head rlist; /* reconnect list */
835         struct list_head openFileList;
836         spinlock_t open_file_lock; /* protects list above */
837         struct cifs_ses *ses;   /* pointer to session associated with */
838         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
839         char *nativeFileSystem;
840         char *password;         /* for share-level security */
841         __u32 tid;              /* The 4 byte tree id */
842         __u16 Flags;            /* optional support bits */
843         enum statusEnum tidStatus;
844 #ifdef CONFIG_CIFS_STATS
845         atomic_t num_smbs_sent;
846         union {
847                 struct {
848                         atomic_t num_writes;
849                         atomic_t num_reads;
850                         atomic_t num_flushes;
851                         atomic_t num_oplock_brks;
852                         atomic_t num_opens;
853                         atomic_t num_closes;
854                         atomic_t num_deletes;
855                         atomic_t num_mkdirs;
856                         atomic_t num_posixopens;
857                         atomic_t num_posixmkdirs;
858                         atomic_t num_rmdirs;
859                         atomic_t num_renames;
860                         atomic_t num_t2renames;
861                         atomic_t num_ffirst;
862                         atomic_t num_fnext;
863                         atomic_t num_fclose;
864                         atomic_t num_hardlinks;
865                         atomic_t num_symlinks;
866                         atomic_t num_locks;
867                         atomic_t num_acl_get;
868                         atomic_t num_acl_set;
869                 } cifs_stats;
870 #ifdef CONFIG_CIFS_SMB2
871                 struct {
872                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
873                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
874                 } smb2_stats;
875 #endif /* CONFIG_CIFS_SMB2 */
876         } stats;
877 #ifdef CONFIG_CIFS_STATS2
878         unsigned long long time_writes;
879         unsigned long long time_reads;
880         unsigned long long time_opens;
881         unsigned long long time_deletes;
882         unsigned long long time_closes;
883         unsigned long long time_mkdirs;
884         unsigned long long time_rmdirs;
885         unsigned long long time_renames;
886         unsigned long long time_t2renames;
887         unsigned long long time_ffirst;
888         unsigned long long time_fnext;
889         unsigned long long time_fclose;
890 #endif /* CONFIG_CIFS_STATS2 */
891         __u64    bytes_read;
892         __u64    bytes_written;
893         spinlock_t stat_lock;  /* protects the two fields above */
894 #endif /* CONFIG_CIFS_STATS */
895         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
896         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
897         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
898         bool ipc:1;             /* set if connection to IPC$ eg for RPC/PIPES */
899         bool retry:1;
900         bool nocase:1;
901         bool seal:1;      /* transport encryption for this mounted share */
902         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
903                                 for this mount even if server would support */
904         bool local_lease:1; /* check leases (only) on local system not remote */
905         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
906         bool broken_sparse_sup; /* if server or share does not support sparse */
907         bool need_reconnect:1; /* connection reset, tid now invalid */
908         bool use_resilient:1; /* use resilient instead of durable handles */
909         bool use_persistent:1; /* use persistent instead of durable handles */
910 #ifdef CONFIG_CIFS_SMB2
911         bool print:1;           /* set if connection to printer share */
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         /* following two lists are protected by tcon->open_file_lock */
1044         struct list_head tlist; /* pointer to next fid owned by tcon */
1045         struct list_head flist; /* next fid (file instance) for this inode */
1046         /* lock list below protected by cifsi->lock_sem */
1047         struct cifs_fid_locks *llist;   /* brlocks held by this fid */
1048         kuid_t uid;             /* allows finding which FileInfo structure */
1049         __u32 pid;              /* process id who opened file */
1050         struct cifs_fid fid;    /* file id from remote */
1051         /* BB add lock scope info here if needed */ ;
1052         /* lock scope id (0 if none) */
1053         struct dentry *dentry;
1054         struct tcon_link *tlink;
1055         unsigned int f_flags;
1056         bool invalidHandle:1;   /* file closed via session abend */
1057         bool oplock_break_cancelled:1;
1058         int count;
1059         spinlock_t file_info_lock; /* protects four flag/count fields above */
1060         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1061         struct cifs_search_info srch_inf;
1062         struct work_struct oplock_break; /* work for oplock breaks */
1063 };
1064
1065 struct cifs_io_parms {
1066         __u16 netfid;
1067 #ifdef CONFIG_CIFS_SMB2
1068         __u64 persistent_fid;   /* persist file id for smb2 */
1069         __u64 volatile_fid;     /* volatile file id for smb2 */
1070 #endif
1071         __u32 pid;
1072         __u64 offset;
1073         unsigned int length;
1074         struct cifs_tcon *tcon;
1075 };
1076
1077 struct cifs_readdata;
1078
1079 /* asynchronous read support */
1080 struct cifs_readdata {
1081         struct kref                     refcount;
1082         struct list_head                list;
1083         struct completion               done;
1084         struct cifsFileInfo             *cfile;
1085         struct address_space            *mapping;
1086         __u64                           offset;
1087         unsigned int                    bytes;
1088         unsigned int                    got_bytes;
1089         pid_t                           pid;
1090         int                             result;
1091         struct work_struct              work;
1092         int (*read_into_pages)(struct TCP_Server_Info *server,
1093                                 struct cifs_readdata *rdata,
1094                                 unsigned int len);
1095         struct kvec                     iov;
1096         unsigned int                    pagesz;
1097         unsigned int                    tailsz;
1098         unsigned int                    credits;
1099         unsigned int                    nr_pages;
1100         struct page                     *pages[];
1101 };
1102
1103 struct cifs_writedata;
1104
1105 /* asynchronous write support */
1106 struct cifs_writedata {
1107         struct kref                     refcount;
1108         struct list_head                list;
1109         struct completion               done;
1110         enum writeback_sync_modes       sync_mode;
1111         struct work_struct              work;
1112         struct cifsFileInfo             *cfile;
1113         __u64                           offset;
1114         pid_t                           pid;
1115         unsigned int                    bytes;
1116         int                             result;
1117         unsigned int                    pagesz;
1118         unsigned int                    tailsz;
1119         unsigned int                    credits;
1120         unsigned int                    nr_pages;
1121         struct page                     *pages[];
1122 };
1123
1124 /*
1125  * Take a reference on the file private data. Must be called with
1126  * cfile->file_info_lock held.
1127  */
1128 static inline void
1129 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1130 {
1131         ++cifs_file->count;
1132 }
1133
1134 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1135 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1136
1137 #define CIFS_CACHE_READ_FLG     1
1138 #define CIFS_CACHE_HANDLE_FLG   2
1139 #define CIFS_CACHE_RH_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1140 #define CIFS_CACHE_WRITE_FLG    4
1141 #define CIFS_CACHE_RW_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1142 #define CIFS_CACHE_RHW_FLG      (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1143
1144 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1145 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1146 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1147
1148 /*
1149  * One of these for each file inode
1150  */
1151
1152 struct cifsInodeInfo {
1153         bool can_cache_brlcks;
1154         struct list_head llist; /* locks helb by this inode */
1155         /*
1156          * NOTE: Some code paths call down_read(lock_sem) twice, so
1157          * we must always use use cifs_down_write() instead of down_write()
1158          * for this semaphore to avoid deadlocks.
1159          */
1160         struct rw_semaphore lock_sem;   /* protect the fields above */
1161         /* BB add in lists for dirty pages i.e. write caching info for oplock */
1162         struct list_head openFileList;
1163         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1164         unsigned int oplock;            /* oplock/lease level we have */
1165         unsigned int epoch;             /* used to track lease state changes */
1166 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1167 #define CIFS_INODE_PENDING_WRITERS        (1) /* Writes in progress */
1168 #define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
1169 #define CIFS_INO_DELETE_PENDING           (3) /* delete pending on server */
1170 #define CIFS_INO_INVALID_MAPPING          (4) /* pagecache is invalid */
1171 #define CIFS_INO_LOCK                     (5) /* lock bit for synchronization */
1172         unsigned long flags;
1173         spinlock_t writers_lock;
1174         unsigned int writers;           /* Number of writers on this inode */
1175         unsigned long time;             /* jiffies of last update of inode */
1176         u64  server_eof;                /* current file size on server -- protected by i_lock */
1177         u64  uniqueid;                  /* server inode number */
1178         u64  createtime;                /* creation time on server */
1179 #ifdef CONFIG_CIFS_SMB2
1180         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for this inode */
1181 #endif
1182 #ifdef CONFIG_CIFS_FSCACHE
1183         struct fscache_cookie *fscache;
1184 #endif
1185         struct inode vfs_inode;
1186 };
1187
1188 static inline struct cifsInodeInfo *
1189 CIFS_I(struct inode *inode)
1190 {
1191         return container_of(inode, struct cifsInodeInfo, vfs_inode);
1192 }
1193
1194 static inline struct cifs_sb_info *
1195 CIFS_SB(struct super_block *sb)
1196 {
1197         return sb->s_fs_info;
1198 }
1199
1200 static inline struct cifs_sb_info *
1201 CIFS_FILE_SB(struct file *file)
1202 {
1203         return CIFS_SB(file_inode(file)->i_sb);
1204 }
1205
1206 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1207 {
1208         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1209                 return '/';
1210         else
1211                 return '\\';
1212 }
1213
1214 static inline void
1215 convert_delimiter(char *path, char delim)
1216 {
1217         char old_delim, *pos;
1218
1219         if (delim == '/')
1220                 old_delim = '\\';
1221         else
1222                 old_delim = '/';
1223
1224         pos = path;
1225         while ((pos = strchr(pos, old_delim)))
1226                 *pos = delim;
1227 }
1228
1229 #ifdef CONFIG_CIFS_STATS
1230 #define cifs_stats_inc atomic_inc
1231
1232 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1233                                             unsigned int bytes)
1234 {
1235         if (bytes) {
1236                 spin_lock(&tcon->stat_lock);
1237                 tcon->bytes_written += bytes;
1238                 spin_unlock(&tcon->stat_lock);
1239         }
1240 }
1241
1242 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1243                                          unsigned int bytes)
1244 {
1245         spin_lock(&tcon->stat_lock);
1246         tcon->bytes_read += bytes;
1247         spin_unlock(&tcon->stat_lock);
1248 }
1249 #else
1250
1251 #define  cifs_stats_inc(field) do {} while (0)
1252 #define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1253 #define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1254
1255 #endif
1256
1257
1258 /*
1259  * This is the prototype for the mid receive function. This function is for
1260  * receiving the rest of the SMB frame, starting with the WordCount (which is
1261  * just after the MID in struct smb_hdr). Note:
1262  *
1263  * - This will be called by cifsd, with no locks held.
1264  * - The mid will still be on the pending_mid_q.
1265  * - mid->resp_buf will point to the current buffer.
1266  *
1267  * Returns zero on a successful receive, or an error. The receive state in
1268  * the TCP_Server_Info will also be updated.
1269  */
1270 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1271                             struct mid_q_entry *mid);
1272
1273 /*
1274  * This is the prototype for the mid callback function. This is called once the
1275  * mid has been received off of the socket. When creating one, take special
1276  * care to avoid deadlocks. Things to bear in mind:
1277  *
1278  * - it will be called by cifsd, with no locks held
1279  * - the mid will be removed from any lists
1280  */
1281 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1282
1283 /* one of these for every pending CIFS request to the server */
1284 struct mid_q_entry {
1285         struct list_head qhead; /* mids waiting on reply from this server */
1286         struct TCP_Server_Info *server; /* server corresponding to this mid */
1287         __u64 mid;              /* multiplex id */
1288         __u32 pid;              /* process id */
1289         __u32 sequence_number;  /* for CIFS signing */
1290         unsigned long when_alloc;  /* when mid was created */
1291 #ifdef CONFIG_CIFS_STATS2
1292         unsigned long when_sent; /* time when smb send finished */
1293         unsigned long when_received; /* when demux complete (taken off wire) */
1294 #endif
1295         mid_receive_t *receive; /* call receive callback */
1296         mid_callback_t *callback; /* call completion callback */
1297         void *callback_data;      /* general purpose pointer for callback */
1298         void *resp_buf;         /* pointer to received SMB header */
1299         int mid_state;  /* wish this were enum but can not pass to wait_event */
1300         unsigned int mid_flags;
1301         __le16 command;         /* smb command code */
1302         bool large_buf:1;       /* if valid response, is pointer to large buf */
1303         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1304         bool multiEnd:1;        /* both received */
1305 };
1306
1307 struct close_cancelled_open {
1308         struct cifs_fid         fid;
1309         struct cifs_tcon        *tcon;
1310         struct work_struct      work;
1311 };
1312
1313 /*      Make code in transport.c a little cleaner by moving
1314         update of optional stats into function below */
1315 #ifdef CONFIG_CIFS_STATS2
1316
1317 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1318 {
1319         atomic_inc(&server->in_send);
1320 }
1321
1322 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1323 {
1324         atomic_dec(&server->in_send);
1325 }
1326
1327 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1328 {
1329         atomic_inc(&server->num_waiters);
1330 }
1331
1332 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1333 {
1334         atomic_dec(&server->num_waiters);
1335 }
1336
1337 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1338 {
1339         mid->when_sent = jiffies;
1340 }
1341 #else
1342 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1343 {
1344 }
1345 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1346 {
1347 }
1348
1349 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1350 {
1351 }
1352
1353 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1354 {
1355 }
1356
1357 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1358 {
1359 }
1360 #endif
1361
1362 /* for pending dnotify requests */
1363 struct dir_notify_req {
1364         struct list_head lhead;
1365         __le16 Pid;
1366         __le16 PidHigh;
1367         __u16 Mid;
1368         __u16 Tid;
1369         __u16 Uid;
1370         __u16 netfid;
1371         __u32 filter; /* CompletionFilter (for multishot) */
1372         int multishot;
1373         struct file *pfile;
1374 };
1375
1376 struct dfs_info3_param {
1377         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1378         int path_consumed;
1379         int server_type;
1380         int ref_flag;
1381         char *path_name;
1382         char *node_name;
1383 };
1384
1385 /*
1386  * common struct for holding inode info when searching for or updating an
1387  * inode with new info
1388  */
1389
1390 #define CIFS_FATTR_DFS_REFERRAL         0x1
1391 #define CIFS_FATTR_DELETE_PENDING       0x2
1392 #define CIFS_FATTR_NEED_REVAL           0x4
1393 #define CIFS_FATTR_INO_COLLISION        0x8
1394 #define CIFS_FATTR_UNKNOWN_NLINK        0x10
1395
1396 struct cifs_fattr {
1397         u32             cf_flags;
1398         u32             cf_cifsattrs;
1399         u64             cf_uniqueid;
1400         u64             cf_eof;
1401         u64             cf_bytes;
1402         u64             cf_createtime;
1403         kuid_t          cf_uid;
1404         kgid_t          cf_gid;
1405         umode_t         cf_mode;
1406         dev_t           cf_rdev;
1407         unsigned int    cf_nlink;
1408         unsigned int    cf_dtype;
1409         struct timespec cf_atime;
1410         struct timespec cf_mtime;
1411         struct timespec cf_ctime;
1412 };
1413
1414 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1415 {
1416         if (param) {
1417                 kfree(param->path_name);
1418                 kfree(param->node_name);
1419                 kfree(param);
1420         }
1421 }
1422
1423 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1424                                        int number_of_items)
1425 {
1426         int i;
1427         if ((number_of_items == 0) || (param == NULL))
1428                 return;
1429         for (i = 0; i < number_of_items; i++) {
1430                 kfree(param[i].path_name);
1431                 kfree(param[i].node_name);
1432         }
1433         kfree(param);
1434 }
1435
1436 #define   MID_FREE 0
1437 #define   MID_REQUEST_ALLOCATED 1
1438 #define   MID_REQUEST_SUBMITTED 2
1439 #define   MID_RESPONSE_RECEIVED 4
1440 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1441 #define   MID_RESPONSE_MALFORMED 0x10
1442 #define   MID_SHUTDOWN           0x20
1443
1444 /* Flags */
1445 #define   MID_WAIT_CANCELLED     1 /* Cancelled while waiting for response */
1446
1447 /* Types of response buffer returned from SendReceive2 */
1448 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1449 #define   CIFS_SMALL_BUFFER     1
1450 #define   CIFS_LARGE_BUFFER     2
1451 #define   CIFS_IOVEC            4    /* array of response buffers */
1452
1453 /* Type of Request to SendReceive2 */
1454 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1455 #define   CIFS_ASYNC_OP         2    /* do not wait for response */
1456 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1457 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1458 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1459 #define   CIFS_NO_RESP      0x040    /* no response buffer required */
1460
1461 /* Type of request operation */
1462 #define   CIFS_ECHO_OP      0x080    /* echo request */
1463 #define   CIFS_OBREAK_OP   0x0100    /* oplock break request */
1464 #define   CIFS_NEG_OP      0x0200    /* negotiate request */
1465 #define   CIFS_OP_MASK     0x0380    /* mask request type */
1466 #define   CIFS_HAS_CREDITS 0x0400    /* already has credits */
1467
1468 /* Security Flags: indicate type of session setup needed */
1469 #define   CIFSSEC_MAY_SIGN      0x00001
1470 #define   CIFSSEC_MAY_NTLM      0x00002
1471 #define   CIFSSEC_MAY_NTLMV2    0x00004
1472 #define   CIFSSEC_MAY_KRB5      0x00008
1473 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1474 #define   CIFSSEC_MAY_LANMAN    0x00010
1475 #define   CIFSSEC_MAY_PLNTXT    0x00020
1476 #else
1477 #define   CIFSSEC_MAY_LANMAN    0
1478 #define   CIFSSEC_MAY_PLNTXT    0
1479 #endif /* weak passwords */
1480 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
1481 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
1482
1483 #define   CIFSSEC_MUST_SIGN     0x01001
1484 /* note that only one of the following can be set so the
1485 result of setting MUST flags more than once will be to
1486 require use of the stronger protocol */
1487 #define   CIFSSEC_MUST_NTLM     0x02002
1488 #define   CIFSSEC_MUST_NTLMV2   0x04004
1489 #define   CIFSSEC_MUST_KRB5     0x08008
1490 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1491 #define   CIFSSEC_MUST_LANMAN   0x10010
1492 #define   CIFSSEC_MUST_PLNTXT   0x20020
1493 #ifdef CONFIG_CIFS_UPCALL
1494 #define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
1495 #else
1496 #define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
1497 #endif /* UPCALL */
1498 #else /* do not allow weak pw hash */
1499 #define   CIFSSEC_MUST_LANMAN   0
1500 #define   CIFSSEC_MUST_PLNTXT   0
1501 #ifdef CONFIG_CIFS_UPCALL
1502 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1503 #else
1504 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1505 #endif /* UPCALL */
1506 #endif /* WEAK_PW_HASH */
1507 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
1508 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
1509
1510 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1511 #define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1512 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1513 /*
1514  *****************************************************************
1515  * All constants go here
1516  *****************************************************************
1517  */
1518
1519 #define UID_HASH (16)
1520
1521 /*
1522  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1523  * following to be declared.
1524  */
1525
1526 /****************************************************************************
1527  *  Locking notes.  All updates to global variables and lists should be
1528  *                  protected by spinlocks or semaphores.
1529  *
1530  *  Spinlocks
1531  *  ---------
1532  *  GlobalMid_Lock protects:
1533  *      list operations on pending_mid_q and oplockQ
1534  *      updates to XID counters, multiplex id  and SMB sequence numbers
1535  *  tcp_ses_lock protects:
1536  *      list operations on tcp and SMB session lists
1537  *  tcon->open_file_lock protects the list of open files hanging off the tcon
1538  *  cfile->file_info_lock protects counters and fields in cifs file struct
1539  *  f_owner.lock protects certain per file struct operations
1540  *  mapping->page_lock protects certain per page operations
1541  *
1542  *  Semaphores
1543  *  ----------
1544  *  sesSem     operations on smb session
1545  *  tconSem    operations on tree connection
1546  *  fh_sem      file handle reconnection operations
1547  *
1548  ****************************************************************************/
1549
1550 #ifdef DECLARE_GLOBALS_HERE
1551 #define GLOBAL_EXTERN
1552 #else
1553 #define GLOBAL_EXTERN extern
1554 #endif
1555
1556 /*
1557  * the list of TCP_Server_Info structures, ie each of the sockets
1558  * connecting our client to a distinct server (ip address), is
1559  * chained together by cifs_tcp_ses_list. The list of all our SMB
1560  * sessions (and from that the tree connections) can be found
1561  * by iterating over cifs_tcp_ses_list
1562  */
1563 GLOBAL_EXTERN struct list_head          cifs_tcp_ses_list;
1564
1565 /*
1566  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1567  * tcp session, and the list of tcon's per smb session. It also protects
1568  * the reference counters for the server, smb session, and tcon. Finally,
1569  * changes to the tcon->tidStatus should be done while holding this lock.
1570  * generally the locks should be taken in order tcp_ses_lock before
1571  * tcon->open_file_lock and that before file->file_info_lock since the
1572  * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1573  */
1574 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
1575
1576 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1577 /* Outstanding dir notify requests */
1578 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1579 /* DirNotify response queue */
1580 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1581 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1582
1583 /*
1584  * Global transaction id (XID) information
1585  */
1586 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
1587 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1588 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
1589 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
1590                                           /* on midQ entries */
1591 /*
1592  *  Global counters, updated atomically
1593  */
1594 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1595 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1596 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1597 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1598 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1599
1600 /* Various Debug counters */
1601 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
1602 #ifdef CONFIG_CIFS_STATS2
1603 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1604 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1605 #endif
1606 GLOBAL_EXTERN atomic_t smBufAllocCount;
1607 GLOBAL_EXTERN atomic_t midCount;
1608
1609 /* Misc globals */
1610 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1611 GLOBAL_EXTERN bool lookupCacheEnabled;
1612 GLOBAL_EXTERN unsigned int global_secflags;     /* if on, session setup sent
1613                                 with more secure ntlmssp2 challenge/resp */
1614 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
1615 GLOBAL_EXTERN bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1616 GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
1617 GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
1618 GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
1619 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1620
1621 #ifdef CONFIG_CIFS_ACL
1622 GLOBAL_EXTERN struct rb_root uidtree;
1623 GLOBAL_EXTERN struct rb_root gidtree;
1624 GLOBAL_EXTERN spinlock_t siduidlock;
1625 GLOBAL_EXTERN spinlock_t sidgidlock;
1626 GLOBAL_EXTERN struct rb_root siduidtree;
1627 GLOBAL_EXTERN struct rb_root sidgidtree;
1628 GLOBAL_EXTERN spinlock_t uidsidlock;
1629 GLOBAL_EXTERN spinlock_t gidsidlock;
1630 #endif /* CONFIG_CIFS_ACL */
1631
1632 void cifs_oplock_break(struct work_struct *work);
1633
1634 extern const struct slow_work_ops cifs_oplock_break_ops;
1635 extern struct workqueue_struct *cifsiod_wq;
1636
1637 extern mempool_t *cifs_mid_poolp;
1638
1639 /* Operations for different SMB versions */
1640 #define SMB1_VERSION_STRING     "1.0"
1641 extern struct smb_version_operations smb1_operations;
1642 extern struct smb_version_values smb1_values;
1643 #define SMB20_VERSION_STRING    "2.0"
1644 extern struct smb_version_operations smb20_operations;
1645 extern struct smb_version_values smb20_values;
1646 #define SMB21_VERSION_STRING    "2.1"
1647 extern struct smb_version_operations smb21_operations;
1648 extern struct smb_version_values smb21_values;
1649 #define SMB30_VERSION_STRING    "3.0"
1650 extern struct smb_version_operations smb30_operations;
1651 extern struct smb_version_values smb30_values;
1652 #define SMB302_VERSION_STRING   "3.02"
1653 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1654 extern struct smb_version_values smb302_values;
1655 #define SMB311_VERSION_STRING   "3.1.1"
1656 #define ALT_SMB311_VERSION_STRING "3.11"
1657 extern struct smb_version_operations smb311_operations;
1658 extern struct smb_version_values smb311_values;
1659 #endif  /* _CIFS_GLOB_H */