cifs: distribute channels across interfaces based on speed
[platform/kernel/linux-starfive.git] / fs / smb / client / cifsglob.h
1 /* SPDX-License-Identifier: LGPL-2.1 */
2 /*
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  */
9 #ifndef _CIFS_GLOB_H
10 #define _CIFS_GLOB_H
11
12 #include <linux/in.h>
13 #include <linux/in6.h>
14 #include <linux/inet.h>
15 #include <linux/slab.h>
16 #include <linux/scatterlist.h>
17 #include <linux/mm.h>
18 #include <linux/mempool.h>
19 #include <linux/workqueue.h>
20 #include <linux/utsname.h>
21 #include <linux/sched/mm.h>
22 #include <linux/netfs.h>
23 #include "cifs_fs_sb.h"
24 #include "cifsacl.h"
25 #include <crypto/internal/hash.h>
26 #include <linux/scatterlist.h>
27 #include <uapi/linux/cifs/cifs_mount.h>
28 #include "../common/smb2pdu.h"
29 #include "smb2pdu.h"
30
31 #define SMB_PATH_MAX 260
32 #define CIFS_PORT 445
33 #define RFC1001_PORT 139
34
35 /*
36  * The sizes of various internal tables and strings
37  */
38 #define MAX_UID_INFO 16
39 #define MAX_SES_INFO 2
40 #define MAX_TCON_INFO 4
41
42 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
43
44 #define CIFS_MIN_RCV_POOL 4
45
46 #define MAX_REOPEN_ATT  5 /* these many maximum attempts to reopen a file */
47 /*
48  * default attribute cache timeout (jiffies)
49  */
50 #define CIFS_DEF_ACTIMEO (1 * HZ)
51
52 /*
53  * max attribute cache timeout (jiffies) - 2^30
54  */
55 #define CIFS_MAX_ACTIMEO (1 << 30)
56
57 /*
58  * Max persistent and resilient handle timeout (milliseconds).
59  * Windows durable max was 960000 (16 minutes)
60  */
61 #define SMB3_MAX_HANDLE_TIMEOUT 960000
62
63 /*
64  * MAX_REQ is the maximum number of requests that WE will send
65  * on one socket concurrently.
66  */
67 #define CIFS_MAX_REQ 32767
68
69 #define RFC1001_NAME_LEN 15
70 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
71
72 /* maximum length of ip addr as a string (including ipv6 and sctp) */
73 #define SERVER_NAME_LENGTH 80
74 #define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)
75
76 /* echo interval in seconds */
77 #define SMB_ECHO_INTERVAL_MIN 1
78 #define SMB_ECHO_INTERVAL_MAX 600
79 #define SMB_ECHO_INTERVAL_DEFAULT 60
80
81 /* dns resolution intervals in seconds */
82 #define SMB_DNS_RESOLVE_INTERVAL_MIN     120
83 #define SMB_DNS_RESOLVE_INTERVAL_DEFAULT 600
84
85 /* smb multichannel query server interfaces interval in seconds */
86 #define SMB_INTERFACE_POLL_INTERVAL     600
87
88 /* maximum number of PDUs in one compound */
89 #define MAX_COMPOUND 5
90
91 /*
92  * Default number of credits to keep available for SMB3.
93  * This value is chosen somewhat arbitrarily. The Windows client
94  * defaults to 128 credits, the Windows server allows clients up to
95  * 512 credits (or 8K for later versions), and the NetApp server
96  * does not limit clients at all.  Choose a high enough default value
97  * such that the client shouldn't limit performance, but allow mount
98  * to override (until you approach 64K, where we limit credits to 65000
99  * to reduce possibility of seeing more server credit overflow bugs.
100  */
101 #define SMB2_MAX_CREDITS_AVAILABLE 32000
102
103 #include "cifspdu.h"
104
105 #ifndef XATTR_DOS_ATTRIB
106 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
107 #endif
108
109 #define CIFS_MAX_WORKSTATION_LEN  (__NEW_UTS_LEN + 1)  /* reasonable max for client */
110
111 /*
112  * CIFS vfs client Status information (based on what we know.)
113  */
114
115 /* associated with each connection */
116 enum statusEnum {
117         CifsNew = 0,
118         CifsGood,
119         CifsExiting,
120         CifsNeedReconnect,
121         CifsNeedNegotiate,
122         CifsInNegotiate,
123 };
124
125 /* associated with each smb session */
126 enum ses_status_enum {
127         SES_NEW = 0,
128         SES_GOOD,
129         SES_EXITING,
130         SES_NEED_RECON,
131         SES_IN_SETUP
132 };
133
134 /* associated with each tree connection to the server */
135 enum tid_status_enum {
136         TID_NEW = 0,
137         TID_GOOD,
138         TID_EXITING,
139         TID_NEED_RECON,
140         TID_NEED_TCON,
141         TID_IN_TCON,
142         TID_NEED_FILES_INVALIDATE, /* currently unused */
143         TID_IN_FILES_INVALIDATE
144 };
145
146 enum securityEnum {
147         Unspecified = 0,        /* not specified */
148         NTLMv2,                 /* Legacy NTLM auth with NTLMv2 hash */
149         RawNTLMSSP,             /* NTLMSSP without SPNEGO, NTLMv2 hash */
150         Kerberos,               /* Kerberos via SPNEGO */
151 };
152
153 struct session_key {
154         unsigned int len;
155         char *response;
156 };
157
158 /* crypto hashing related structure/fields, not specific to a sec mech */
159 struct cifs_secmech {
160         struct shash_desc *hmacmd5; /* hmacmd5 hash function, for NTLMv2/CR1 hashes */
161         struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */
162         struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */
163         struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */
164         struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */
165
166         struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */
167         struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */
168 };
169
170 /* per smb session structure/fields */
171 struct ntlmssp_auth {
172         bool sesskey_per_smbsess; /* whether session key is per smb session */
173         __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
174         __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
175         unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
176         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
177 };
178
179 struct cifs_cred {
180         int uid;
181         int gid;
182         int mode;
183         int cecount;
184         struct cifs_sid osid;
185         struct cifs_sid gsid;
186         struct cifs_ntace *ntaces;
187         struct cifs_ace *aces;
188 };
189
190 struct cifs_open_info_data {
191         char *symlink_target;
192         union {
193                 struct smb2_file_all_info fi;
194                 struct smb311_posix_qinfo posix_fi;
195         };
196 };
197
198 static inline void cifs_free_open_info(struct cifs_open_info_data *data)
199 {
200         kfree(data->symlink_target);
201 }
202
203 /*
204  *****************************************************************
205  * Except the CIFS PDUs themselves all the
206  * globally interesting structs should go here
207  *****************************************************************
208  */
209
210 /*
211  * A smb_rqst represents a complete request to be issued to a server. It's
212  * formed by a kvec array, followed by an array of pages. Page data is assumed
213  * to start at the beginning of the first page.
214  */
215 struct smb_rqst {
216         struct kvec     *rq_iov;        /* array of kvecs */
217         unsigned int    rq_nvec;        /* number of kvecs in array */
218         struct page     **rq_pages;     /* pointer to array of page ptrs */
219         unsigned int    rq_offset;      /* the offset to the 1st page */
220         unsigned int    rq_npages;      /* number pages in array */
221         unsigned int    rq_pagesz;      /* page size to use */
222         unsigned int    rq_tailsz;      /* length of last page */
223 };
224
225 struct mid_q_entry;
226 struct TCP_Server_Info;
227 struct cifsFileInfo;
228 struct cifs_ses;
229 struct cifs_tcon;
230 struct dfs_info3_param;
231 struct cifs_fattr;
232 struct smb3_fs_context;
233 struct cifs_fid;
234 struct cifs_readdata;
235 struct cifs_writedata;
236 struct cifs_io_parms;
237 struct cifs_search_info;
238 struct cifsInodeInfo;
239 struct cifs_open_parms;
240 struct cifs_credits;
241
242 struct smb_version_operations {
243         int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
244                            struct mid_q_entry *);
245         bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
246         /* setup request: allocate mid, sign message */
247         struct mid_q_entry *(*setup_request)(struct cifs_ses *,
248                                              struct TCP_Server_Info *,
249                                              struct smb_rqst *);
250         /* setup async request: allocate mid, sign message */
251         struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
252                                                 struct smb_rqst *);
253         /* check response: verify signature, map error */
254         int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
255                              bool);
256         void (*add_credits)(struct TCP_Server_Info *server,
257                             const struct cifs_credits *credits,
258                             const int optype);
259         void (*set_credits)(struct TCP_Server_Info *, const int);
260         int * (*get_credits_field)(struct TCP_Server_Info *, const int);
261         unsigned int (*get_credits)(struct mid_q_entry *);
262         __u64 (*get_next_mid)(struct TCP_Server_Info *);
263         void (*revert_current_mid)(struct TCP_Server_Info *server,
264                                    const unsigned int val);
265         /* data offset from read response message */
266         unsigned int (*read_data_offset)(char *);
267         /*
268          * Data length from read response message
269          * When in_remaining is true, the returned data length is in
270          * message field DataRemaining for out-of-band data read (e.g through
271          * Memory Registration RDMA write in SMBD).
272          * Otherwise, the returned data length is in message field DataLength.
273          */
274         unsigned int (*read_data_length)(char *, bool in_remaining);
275         /* map smb to linux error */
276         int (*map_error)(char *, bool);
277         /* find mid corresponding to the response message */
278         struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
279         void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
280         void (*clear_stats)(struct cifs_tcon *);
281         void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
282         void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
283         /* verify the message */
284         int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
285         bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
286         int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *);
287         void (*downgrade_oplock)(struct TCP_Server_Info *server,
288                                  struct cifsInodeInfo *cinode, __u32 oplock,
289                                  unsigned int epoch, bool *purge_cache);
290         /* process transaction2 response */
291         bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
292                              char *, int);
293         /* check if we need to negotiate */
294         bool (*need_neg)(struct TCP_Server_Info *);
295         /* negotiate to the server */
296         int (*negotiate)(const unsigned int xid,
297                          struct cifs_ses *ses,
298                          struct TCP_Server_Info *server);
299         /* set negotiated write size */
300         unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
301         /* set negotiated read size */
302         unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
303         /* setup smb sessionn */
304         int (*sess_setup)(const unsigned int, struct cifs_ses *,
305                           struct TCP_Server_Info *server,
306                           const struct nls_table *);
307         /* close smb session */
308         int (*logoff)(const unsigned int, struct cifs_ses *);
309         /* connect to a server share */
310         int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
311                             struct cifs_tcon *, const struct nls_table *);
312         /* close tree connecion */
313         int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
314         /* get DFS referrals */
315         int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
316                              const char *, struct dfs_info3_param **,
317                              unsigned int *, const struct nls_table *, int);
318         /* informational QFS call */
319         void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
320                          struct cifs_sb_info *);
321         /* check if a path is accessible or not */
322         int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
323                                   struct cifs_sb_info *, const char *);
324         /* query path data from the server */
325         int (*query_path_info)(const unsigned int xid, struct cifs_tcon *tcon,
326                                struct cifs_sb_info *cifs_sb, const char *full_path,
327                                struct cifs_open_info_data *data, bool *adjust_tz, bool *reparse);
328         /* query file data from the server */
329         int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon,
330                                struct cifsFileInfo *cfile, struct cifs_open_info_data *data);
331         /* query reparse tag from srv to determine which type of special file */
332         int (*query_reparse_tag)(const unsigned int xid, struct cifs_tcon *tcon,
333                                 struct cifs_sb_info *cifs_sb, const char *path,
334                                 __u32 *reparse_tag);
335         /* get server index number */
336         int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon,
337                             struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid,
338                             struct cifs_open_info_data *data);
339         /* set size by path */
340         int (*set_path_size)(const unsigned int, struct cifs_tcon *,
341                              const char *, __u64, struct cifs_sb_info *, bool);
342         /* set size by file handle */
343         int (*set_file_size)(const unsigned int, struct cifs_tcon *,
344                              struct cifsFileInfo *, __u64, bool);
345         /* set attributes */
346         int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
347                              const unsigned int);
348         int (*set_compression)(const unsigned int, struct cifs_tcon *,
349                                struct cifsFileInfo *);
350         /* check if we can send an echo or nor */
351         bool (*can_echo)(struct TCP_Server_Info *);
352         /* send echo request */
353         int (*echo)(struct TCP_Server_Info *);
354         /* create directory */
355         int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
356                         umode_t mode, struct cifs_tcon *tcon,
357                         const char *full_path,
358                         struct cifs_sb_info *cifs_sb);
359         int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
360                      struct cifs_tcon *tcon, const char *name,
361                      struct cifs_sb_info *sb);
362         /* set info on created directory */
363         void (*mkdir_setinfo)(struct inode *, const char *,
364                               struct cifs_sb_info *, struct cifs_tcon *,
365                               const unsigned int);
366         /* remove directory */
367         int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
368                      struct cifs_sb_info *);
369         /* unlink file */
370         int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
371                       struct cifs_sb_info *);
372         /* open, rename and delete file */
373         int (*rename_pending_delete)(const char *, struct dentry *,
374                                      const unsigned int);
375         /* send rename request */
376         int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
377                       const char *, struct cifs_sb_info *);
378         /* send create hardlink request */
379         int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
380                                const char *, const char *,
381                                struct cifs_sb_info *);
382         /* query symlink target */
383         int (*query_symlink)(const unsigned int, struct cifs_tcon *,
384                              struct cifs_sb_info *, const char *,
385                              char **, bool);
386         /* open a file for non-posix mounts */
387         int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
388                     void *buf);
389         /* set fid protocol-specific info */
390         void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
391         /* close a file */
392         void (*close)(const unsigned int, struct cifs_tcon *,
393                       struct cifs_fid *);
394         /* close a file, returning file attributes and timestamps */
395         void (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
396                       struct cifsFileInfo *pfile_info);
397         /* send a flush request to the server */
398         int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
399         /* async read from the server */
400         int (*async_readv)(struct cifs_readdata *);
401         /* async write to the server */
402         int (*async_writev)(struct cifs_writedata *,
403                             void (*release)(struct kref *));
404         /* sync read from the server */
405         int (*sync_read)(const unsigned int, struct cifs_fid *,
406                          struct cifs_io_parms *, unsigned int *, char **,
407                          int *);
408         /* sync write to the server */
409         int (*sync_write)(const unsigned int, struct cifs_fid *,
410                           struct cifs_io_parms *, unsigned int *, struct kvec *,
411                           unsigned long);
412         /* open dir, start readdir */
413         int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
414                                const char *, struct cifs_sb_info *,
415                                struct cifs_fid *, __u16,
416                                struct cifs_search_info *);
417         /* continue readdir */
418         int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
419                               struct cifs_fid *,
420                               __u16, struct cifs_search_info *srch_inf);
421         /* close dir */
422         int (*close_dir)(const unsigned int, struct cifs_tcon *,
423                          struct cifs_fid *);
424         /* calculate a size of SMB message */
425         unsigned int (*calc_smb_size)(void *buf);
426         /* check for STATUS_PENDING and process the response if yes */
427         bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
428         /* check for STATUS_NETWORK_SESSION_EXPIRED */
429         bool (*is_session_expired)(char *);
430         /* send oplock break response */
431         int (*oplock_response)(struct cifs_tcon *tcon, __u64 persistent_fid, __u64 volatile_fid,
432                         __u16 net_fid, struct cifsInodeInfo *cifs_inode);
433         /* query remote filesystem */
434         int (*queryfs)(const unsigned int, struct cifs_tcon *,
435                        struct cifs_sb_info *, struct kstatfs *);
436         /* send mandatory brlock to the server */
437         int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
438                          __u64, __u32, int, int, bool);
439         /* unlock range of mandatory locks */
440         int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
441                                  const unsigned int);
442         /* push brlocks from the cache to the server */
443         int (*push_mand_locks)(struct cifsFileInfo *);
444         /* get lease key of the inode */
445         void (*get_lease_key)(struct inode *, struct cifs_fid *);
446         /* set lease key of the inode */
447         void (*set_lease_key)(struct inode *, struct cifs_fid *);
448         /* generate new lease key */
449         void (*new_lease_key)(struct cifs_fid *);
450         int (*generate_signingkey)(struct cifs_ses *ses,
451                                    struct TCP_Server_Info *server);
452         int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
453                                 bool allocate_crypto);
454         int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
455                              struct cifsFileInfo *src_file);
456         int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
457                              struct cifsFileInfo *src_file, void __user *);
458         int (*notify)(const unsigned int xid, struct file *pfile,
459                              void __user *pbuf, bool return_changes);
460         int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
461                                 struct cifs_sb_info *, const unsigned char *,
462                                 char *, unsigned int *);
463         int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
464                                  struct cifs_sb_info *, const unsigned char *,
465                                  char *, unsigned int *);
466         /* if we can do cache read operations */
467         bool (*is_read_op)(__u32);
468         /* set oplock level for the inode */
469         void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
470                                  bool *);
471         /* create lease context buffer for CREATE request */
472         char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
473         /* parse lease context buffer and return oplock/epoch info */
474         __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
475         ssize_t (*copychunk_range)(const unsigned int,
476                         struct cifsFileInfo *src_file,
477                         struct cifsFileInfo *target_file,
478                         u64 src_off, u64 len, u64 dest_off);
479         int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
480                         struct cifsFileInfo *target_file, u64 src_off, u64 len,
481                         u64 dest_off);
482         int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
483         ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
484                         const unsigned char *, const unsigned char *, char *,
485                         size_t, struct cifs_sb_info *);
486         int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
487                         const char *, const void *, const __u16,
488                         const struct nls_table *, struct cifs_sb_info *);
489         struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
490                         const char *, u32 *, u32);
491         struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
492                         const struct cifs_fid *, u32 *, u32);
493         int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
494                         int);
495         /* writepages retry size */
496         unsigned int (*wp_retry_size)(struct inode *);
497         /* get mtu credits */
498         int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
499                                 unsigned int *, struct cifs_credits *);
500         /* adjust previously taken mtu credits to request size */
501         int (*adjust_credits)(struct TCP_Server_Info *server,
502                               struct cifs_credits *credits,
503                               const unsigned int payload_size);
504         /* check if we need to issue closedir */
505         bool (*dir_needs_close)(struct cifsFileInfo *);
506         long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
507                           loff_t);
508         /* init transform request - used for encryption for now */
509         int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
510                                  struct smb_rqst *, struct smb_rqst *);
511         int (*is_transform_hdr)(void *buf);
512         int (*receive_transform)(struct TCP_Server_Info *,
513                                  struct mid_q_entry **, char **, int *);
514         enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
515                             enum securityEnum);
516         int (*next_header)(char *);
517         /* ioctl passthrough for query_info */
518         int (*ioctl_query_info)(const unsigned int xid,
519                                 struct cifs_tcon *tcon,
520                                 struct cifs_sb_info *cifs_sb,
521                                 __le16 *path, int is_dir,
522                                 unsigned long p);
523         /* make unix special files (block, char, fifo, socket) */
524         int (*make_node)(unsigned int xid,
525                          struct inode *inode,
526                          struct dentry *dentry,
527                          struct cifs_tcon *tcon,
528                          const char *full_path,
529                          umode_t mode,
530                          dev_t device_number);
531         /* version specific fiemap implementation */
532         int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
533                       struct fiemap_extent_info *, u64, u64);
534         /* version specific llseek implementation */
535         loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
536         /* Check for STATUS_IO_TIMEOUT */
537         bool (*is_status_io_timeout)(char *buf);
538         /* Check for STATUS_NETWORK_NAME_DELETED */
539         void (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv);
540 };
541
542 struct smb_version_values {
543         char            *version_string;
544         __u16           protocol_id;
545         __u32           req_capabilities;
546         __u32           large_lock_type;
547         __u32           exclusive_lock_type;
548         __u32           shared_lock_type;
549         __u32           unlock_lock_type;
550         size_t          header_preamble_size;
551         size_t          header_size;
552         size_t          max_header_size;
553         size_t          read_rsp_size;
554         __le16          lock_cmd;
555         unsigned int    cap_unix;
556         unsigned int    cap_nt_find;
557         unsigned int    cap_large_files;
558         __u16           signing_enabled;
559         __u16           signing_required;
560         size_t          create_lease_size;
561 };
562
563 #define HEADER_SIZE(server) (server->vals->header_size)
564 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
565 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size)
566 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server))
567
568 /**
569  * CIFS superblock mount flags (mnt_cifs_flags) to consider when
570  * trying to reuse existing superblock for a new mount
571  */
572 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
573                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
574                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
575                          CIFS_MOUNT_MAP_SFM_CHR | \
576                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
577                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
578                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
579                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
580                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
581                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
582                          CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
583                          CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
584                          CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
585                          CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
586
587 /**
588  * Generic VFS superblock mount flags (s_flags) to consider when
589  * trying to reuse existing superblock for a new mount
590  */
591 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
592                       SB_NODEV | SB_SYNCHRONOUS)
593
594 struct cifs_mnt_data {
595         struct cifs_sb_info *cifs_sb;
596         struct smb3_fs_context *ctx;
597         int flags;
598 };
599
600 static inline unsigned int
601 get_rfc1002_length(void *buf)
602 {
603         return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
604 }
605
606 static inline void
607 inc_rfc1001_len(void *buf, int count)
608 {
609         be32_add_cpu((__be32 *)buf, count);
610 }
611
612 struct TCP_Server_Info {
613         struct list_head tcp_ses_list;
614         struct list_head smb_ses_list;
615         spinlock_t srv_lock;  /* protect anything here that is not protected */
616         __u64 conn_id; /* connection identifier (useful for debugging) */
617         int srv_count; /* reference counter */
618         /* 15 character server name + 0x20 16th byte indicating type = srv */
619         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
620         struct smb_version_operations   *ops;
621         struct smb_version_values       *vals;
622         /* updates to tcpStatus protected by cifs_tcp_ses_lock */
623         enum statusEnum tcpStatus; /* what we think the status is */
624         char *hostname; /* hostname portion of UNC string */
625         struct socket *ssocket;
626         struct sockaddr_storage dstaddr;
627         struct sockaddr_storage srcaddr; /* locally bind to this IP */
628 #ifdef CONFIG_NET_NS
629         struct net *net;
630 #endif
631         wait_queue_head_t response_q;
632         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
633         spinlock_t mid_lock;  /* protect mid queue and it's entries */
634         struct list_head pending_mid_q;
635         bool noblocksnd;                /* use blocking sendmsg */
636         bool noautotune;                /* do not autotune send buf sizes */
637         bool nosharesock;
638         bool tcp_nodelay;
639         unsigned int credits;  /* send no more requests at once */
640         unsigned int max_credits; /* can override large 32000 default at mnt */
641         unsigned int in_flight;  /* number of requests on the wire to server */
642         unsigned int max_in_flight; /* max number of requests that were on wire */
643         spinlock_t req_lock;  /* protect the two values above */
644         struct mutex _srv_mutex;
645         unsigned int nofs_flag;
646         struct task_struct *tsk;
647         char server_GUID[16];
648         __u16 sec_mode;
649         bool sign; /* is signing enabled on this connection? */
650         bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
651         bool session_estab; /* mark when very first sess is established */
652         int echo_credits;  /* echo reserved slots */
653         int oplock_credits;  /* oplock break reserved slots */
654         bool echoes:1; /* enable echoes */
655         __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
656         u16 dialect; /* dialect index that server chose */
657         bool oplocks:1; /* enable oplocks */
658         unsigned int maxReq;    /* Clients should submit no more */
659         /* than maxReq distinct unanswered SMBs to the server when using  */
660         /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
661         unsigned int maxBuf;    /* maxBuf specifies the maximum */
662         /* message size the server can send or receive for non-raw SMBs */
663         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
664         /* when socket is setup (and during reconnect) before NegProt sent */
665         unsigned int max_rw;    /* maxRw specifies the maximum */
666         /* message size the server can send or receive for */
667         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
668         unsigned int capabilities; /* selective disabling of caps by smb sess */
669         int timeAdj;  /* Adjust for difference in server time zone in sec */
670         __u64 CurrentMid;         /* multiplex id - rotating counter, protected by GlobalMid_Lock */
671         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
672         /* 16th byte of RFC1001 workstation name is always null */
673         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
674         __u32 sequence_number; /* for signing, protected by srv_mutex */
675         __u32 reconnect_instance; /* incremented on each reconnect */
676         struct session_key session_key;
677         unsigned long lstrp; /* when we got last response from this server */
678         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
679 #define CIFS_NEGFLAVOR_UNENCAP  1       /* wct == 17, but no ext_sec */
680 #define CIFS_NEGFLAVOR_EXTENDED 2       /* wct == 17, ext_sec bit set */
681         char    negflavor;      /* NEGOTIATE response flavor */
682         /* extended security flavors that server supports */
683         bool    sec_ntlmssp;            /* supports NTLMSSP */
684         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
685         bool    sec_kerberos;           /* supports plain Kerberos */
686         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
687         bool    large_buf;              /* is current buffer large? */
688         /* use SMBD connection instead of socket */
689         bool    rdma;
690         /* point to the SMBD connection if RDMA is used instead of socket */
691         struct smbd_connection *smbd_conn;
692         struct delayed_work     echo; /* echo ping workqueue job */
693         struct delayed_work     resolve; /* dns resolution workqueue job */
694         char    *smallbuf;      /* pointer to current "small" buffer */
695         char    *bigbuf;        /* pointer to current "big" buffer */
696         /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
697         unsigned int pdu_size;
698         unsigned int total_read; /* total amount of data read in this pass */
699         atomic_t in_send; /* requests trying to send */
700         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
701 #ifdef CONFIG_CIFS_STATS2
702         atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
703         atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
704         __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
705         __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
706         __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
707 #endif /* STATS2 */
708         unsigned int    max_read;
709         unsigned int    max_write;
710         unsigned int    min_offload;
711         __le16  compress_algorithm;
712         __u16   signing_algorithm;
713         __le16  cipher_type;
714          /* save initital negprot hash */
715         __u8    preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
716         bool    signing_negotiated; /* true if valid signing context rcvd from server */
717         bool    posix_ext_supported;
718         struct delayed_work reconnect; /* reconnect workqueue job */
719         struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
720         unsigned long echo_interval;
721
722         /*
723          * Number of targets available for reconnect. The more targets
724          * the more tasks have to wait to let the demultiplex thread
725          * reconnect.
726          */
727         int nr_targets;
728         bool noblockcnt; /* use non-blocking connect() */
729
730         /*
731          * If this is a session channel,
732          * primary_server holds the ref-counted
733          * pointer to primary channel connection for the session.
734          */
735 #define CIFS_SERVER_IS_CHAN(server)     (!!(server)->primary_server)
736         struct TCP_Server_Info *primary_server;
737         __u16 channel_sequence_num;  /* incremented on primary channel on each chan reconnect */
738
739 #ifdef CONFIG_CIFS_SWN_UPCALL
740         bool use_swn_dstaddr;
741         struct sockaddr_storage swn_dstaddr;
742 #endif
743 #ifdef CONFIG_CIFS_DFS_UPCALL
744         bool is_dfs_conn; /* if a dfs connection */
745         struct mutex refpath_lock; /* protects leaf_fullpath */
746         /*
747          * Canonical DFS full paths that were used to chase referrals in mount and reconnect.
748          *
749          * origin_fullpath: first or original referral path
750          * leaf_fullpath: last referral path (might be changed due to nested links in reconnect)
751          *
752          * current_fullpath: pointer to either origin_fullpath or leaf_fullpath
753          * NOTE: cannot be accessed outside cifs_reconnect() and smb2_reconnect()
754          *
755          * format: \\HOST\SHARE\[OPTIONAL PATH]
756          */
757         char *origin_fullpath, *leaf_fullpath, *current_fullpath;
758 #endif
759 };
760
761 static inline bool is_smb1(struct TCP_Server_Info *server)
762 {
763         return HEADER_PREAMBLE_SIZE(server) != 0;
764 }
765
766 static inline void cifs_server_lock(struct TCP_Server_Info *server)
767 {
768         unsigned int nofs_flag = memalloc_nofs_save();
769
770         mutex_lock(&server->_srv_mutex);
771         server->nofs_flag = nofs_flag;
772 }
773
774 static inline void cifs_server_unlock(struct TCP_Server_Info *server)
775 {
776         unsigned int nofs_flag = server->nofs_flag;
777
778         mutex_unlock(&server->_srv_mutex);
779         memalloc_nofs_restore(nofs_flag);
780 }
781
782 struct cifs_credits {
783         unsigned int value;
784         unsigned int instance;
785 };
786
787 static inline unsigned int
788 in_flight(struct TCP_Server_Info *server)
789 {
790         unsigned int num;
791
792         spin_lock(&server->req_lock);
793         num = server->in_flight;
794         spin_unlock(&server->req_lock);
795         return num;
796 }
797
798 static inline bool
799 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
800 {
801         int num;
802
803         spin_lock(&server->req_lock);
804         num = *credits;
805         spin_unlock(&server->req_lock);
806         return num >= num_credits;
807 }
808
809 static inline void
810 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
811             const int optype)
812 {
813         server->ops->add_credits(server, credits, optype);
814 }
815
816 static inline void
817 add_credits_and_wake_if(struct TCP_Server_Info *server,
818                         const struct cifs_credits *credits, const int optype)
819 {
820         if (credits->value) {
821                 server->ops->add_credits(server, credits, optype);
822                 wake_up(&server->request_q);
823         }
824 }
825
826 static inline void
827 set_credits(struct TCP_Server_Info *server, const int val)
828 {
829         server->ops->set_credits(server, val);
830 }
831
832 static inline int
833 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
834                const unsigned int payload_size)
835 {
836         return server->ops->adjust_credits ?
837                 server->ops->adjust_credits(server, credits, payload_size) : 0;
838 }
839
840 static inline __le64
841 get_next_mid64(struct TCP_Server_Info *server)
842 {
843         return cpu_to_le64(server->ops->get_next_mid(server));
844 }
845
846 static inline __le16
847 get_next_mid(struct TCP_Server_Info *server)
848 {
849         __u16 mid = server->ops->get_next_mid(server);
850         /*
851          * The value in the SMB header should be little endian for easy
852          * on-the-wire decoding.
853          */
854         return cpu_to_le16(mid);
855 }
856
857 static inline void
858 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
859 {
860         if (server->ops->revert_current_mid)
861                 server->ops->revert_current_mid(server, val);
862 }
863
864 static inline void
865 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
866                             const struct smb2_hdr *shdr)
867 {
868         unsigned int num = le16_to_cpu(shdr->CreditCharge);
869
870         return revert_current_mid(server, num > 0 ? num : 1);
871 }
872
873 static inline __u16
874 get_mid(const struct smb_hdr *smb)
875 {
876         return le16_to_cpu(smb->Mid);
877 }
878
879 static inline bool
880 compare_mid(__u16 mid, const struct smb_hdr *smb)
881 {
882         return mid == le16_to_cpu(smb->Mid);
883 }
884
885 /*
886  * When the server supports very large reads and writes via POSIX extensions,
887  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
888  * including the RFC1001 length.
889  *
890  * Note that this might make for "interesting" allocation problems during
891  * writeback however as we have to allocate an array of pointers for the
892  * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
893  *
894  * For reads, there is a similar problem as we need to allocate an array
895  * of kvecs to handle the receive, though that should only need to be done
896  * once.
897  */
898 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
899 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
900
901 /*
902  * When the server doesn't allow large posix writes, only allow a rsize/wsize
903  * of 2^17-1 minus the size of the call header. That allows for a read or
904  * write up to the maximum size described by RFC1002.
905  */
906 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
907 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
908
909 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
910
911 /*
912  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
913  * those values when posix extensions aren't in force. In actuality here, we
914  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
915  * to be ok with the extra byte even though Windows doesn't send writes that
916  * are that large.
917  *
918  * Citation:
919  *
920  * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
921  */
922 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
923 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
924
925 /*
926  * Macros to allow the TCP_Server_Info->net field and related code to drop out
927  * when CONFIG_NET_NS isn't set.
928  */
929
930 #ifdef CONFIG_NET_NS
931
932 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
933 {
934         return srv->net;
935 }
936
937 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
938 {
939         srv->net = net;
940 }
941
942 #else
943
944 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
945 {
946         return &init_net;
947 }
948
949 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
950 {
951 }
952
953 #endif
954
955 struct cifs_server_iface {
956         struct list_head iface_head;
957         struct kref refcount;
958         size_t speed;
959         size_t weight_fulfilled;
960         unsigned int num_channels;
961         unsigned int rdma_capable : 1;
962         unsigned int rss_capable : 1;
963         unsigned int is_active : 1; /* unset if non existent */
964         struct sockaddr_storage sockaddr;
965 };
966
967 /* release iface when last ref is dropped */
968 static inline void
969 release_iface(struct kref *ref)
970 {
971         struct cifs_server_iface *iface = container_of(ref,
972                                                        struct cifs_server_iface,
973                                                        refcount);
974         list_del_init(&iface->iface_head);
975         kfree(iface);
976 }
977
978 struct cifs_chan {
979         unsigned int in_reconnect : 1; /* if session setup in progress for this channel */
980         struct TCP_Server_Info *server;
981         struct cifs_server_iface *iface; /* interface in use */
982         __u8 signkey[SMB3_SIGN_KEY_SIZE];
983 };
984
985 /*
986  * Session structure.  One of these for each uid session with a particular host
987  */
988 struct cifs_ses {
989         struct list_head smb_ses_list;
990         struct list_head rlist; /* reconnect list */
991         struct list_head tcon_list;
992         struct cifs_tcon *tcon_ipc;
993         spinlock_t ses_lock;  /* protect anything here that is not protected */
994         struct mutex session_mutex;
995         struct TCP_Server_Info *server; /* pointer to server info */
996         int ses_count;          /* reference counter */
997         enum ses_status_enum ses_status;  /* updates protected by cifs_tcp_ses_lock */
998         unsigned int overrideSecFlg; /* if non-zero override global sec flags */
999         char *serverOS;         /* name of operating system underlying server */
1000         char *serverNOS;        /* name of network operating system of server */
1001         char *serverDomain;     /* security realm of server */
1002         __u64 Suid;             /* remote smb uid  */
1003         kuid_t linux_uid;       /* overriding owner of files on the mount */
1004         kuid_t cred_uid;        /* owner of credentials */
1005         unsigned int capabilities;
1006         char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */
1007         char *user_name;        /* must not be null except during init of sess
1008                                    and after mount option parsing we fill it */
1009         char *domainName;
1010         char *password;
1011         char workstation_name[CIFS_MAX_WORKSTATION_LEN];
1012         struct session_key auth_key;
1013         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
1014         enum securityEnum sectype; /* what security flavor was specified? */
1015         bool sign;              /* is signing required? */
1016         bool domainAuto:1;
1017         __u16 session_flags;
1018         __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1019         __u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1020         __u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE];
1021         __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1022
1023         /*
1024          * Network interfaces available on the server this session is
1025          * connected to.
1026          *
1027          * Other channels can be opened by connecting and binding this
1028          * session to interfaces from this list.
1029          *
1030          * iface_lock should be taken when accessing any of these fields
1031          */
1032         spinlock_t iface_lock;
1033         /* ========= begin: protected by iface_lock ======== */
1034         struct list_head iface_list;
1035         size_t iface_count;
1036         unsigned long iface_last_update; /* jiffies */
1037         /* ========= end: protected by iface_lock ======== */
1038
1039         spinlock_t chan_lock;
1040         /* ========= begin: protected by chan_lock ======== */
1041 #define CIFS_MAX_CHANNELS 16
1042 #define CIFS_ALL_CHANNELS_SET(ses)      \
1043         ((1UL << (ses)->chan_count) - 1)
1044 #define CIFS_ALL_CHANS_GOOD(ses)                \
1045         (!(ses)->chans_need_reconnect)
1046 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses)      \
1047         ((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses))
1048 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses)  \
1049         ((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses))
1050 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index)   \
1051         test_bit((index), &(ses)->chans_need_reconnect)
1052 #define CIFS_CHAN_IN_RECONNECT(ses, index)      \
1053         ((ses)->chans[(index)].in_reconnect)
1054
1055         struct cifs_chan chans[CIFS_MAX_CHANNELS];
1056         size_t chan_count;
1057         size_t chan_max;
1058         atomic_t chan_seq; /* round robin state */
1059
1060         /*
1061          * chans_need_reconnect is a bitmap indicating which of the channels
1062          * under this smb session needs to be reconnected.
1063          * If not multichannel session, only one bit will be used.
1064          *
1065          * We will ask for sess and tcon reconnection only if all the
1066          * channels are marked for needing reconnection. This will
1067          * enable the sessions on top to continue to live till any
1068          * of the channels below are active.
1069          */
1070         unsigned long chans_need_reconnect;
1071         /* ========= end: protected by chan_lock ======== */
1072 };
1073
1074 static inline bool
1075 cap_unix(struct cifs_ses *ses)
1076 {
1077         return ses->server->vals->cap_unix & ses->capabilities;
1078 }
1079
1080 /*
1081  * common struct for holding inode info when searching for or updating an
1082  * inode with new info
1083  */
1084
1085 #define CIFS_FATTR_DFS_REFERRAL         0x1
1086 #define CIFS_FATTR_DELETE_PENDING       0x2
1087 #define CIFS_FATTR_NEED_REVAL           0x4
1088 #define CIFS_FATTR_INO_COLLISION        0x8
1089 #define CIFS_FATTR_UNKNOWN_NLINK        0x10
1090 #define CIFS_FATTR_FAKE_ROOT_INO        0x20
1091
1092 struct cifs_fattr {
1093         u32             cf_flags;
1094         u32             cf_cifsattrs;
1095         u64             cf_uniqueid;
1096         u64             cf_eof;
1097         u64             cf_bytes;
1098         u64             cf_createtime;
1099         kuid_t          cf_uid;
1100         kgid_t          cf_gid;
1101         umode_t         cf_mode;
1102         dev_t           cf_rdev;
1103         unsigned int    cf_nlink;
1104         unsigned int    cf_dtype;
1105         struct timespec64 cf_atime;
1106         struct timespec64 cf_mtime;
1107         struct timespec64 cf_ctime;
1108         u32             cf_cifstag;
1109         char            *cf_symlink_target;
1110 };
1111
1112 /*
1113  * there is one of these for each connection to a resource on a particular
1114  * session
1115  */
1116 struct cifs_tcon {
1117         struct list_head tcon_list;
1118         int tc_count;
1119         struct list_head rlist; /* reconnect list */
1120         spinlock_t tc_lock;  /* protect anything here that is not protected */
1121         atomic_t num_local_opens;  /* num of all opens including disconnected */
1122         atomic_t num_remote_opens; /* num of all network opens on server */
1123         struct list_head openFileList;
1124         spinlock_t open_file_lock; /* protects list above */
1125         struct cifs_ses *ses;   /* pointer to session associated with */
1126         char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1127         char *nativeFileSystem;
1128         char *password;         /* for share-level security */
1129         __u32 tid;              /* The 4 byte tree id */
1130         __u16 Flags;            /* optional support bits */
1131         enum tid_status_enum status;
1132         atomic_t num_smbs_sent;
1133         union {
1134                 struct {
1135                         atomic_t num_writes;
1136                         atomic_t num_reads;
1137                         atomic_t num_flushes;
1138                         atomic_t num_oplock_brks;
1139                         atomic_t num_opens;
1140                         atomic_t num_closes;
1141                         atomic_t num_deletes;
1142                         atomic_t num_mkdirs;
1143                         atomic_t num_posixopens;
1144                         atomic_t num_posixmkdirs;
1145                         atomic_t num_rmdirs;
1146                         atomic_t num_renames;
1147                         atomic_t num_t2renames;
1148                         atomic_t num_ffirst;
1149                         atomic_t num_fnext;
1150                         atomic_t num_fclose;
1151                         atomic_t num_hardlinks;
1152                         atomic_t num_symlinks;
1153                         atomic_t num_locks;
1154                         atomic_t num_acl_get;
1155                         atomic_t num_acl_set;
1156                 } cifs_stats;
1157                 struct {
1158                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1159                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1160                 } smb2_stats;
1161         } stats;
1162         __u64    bytes_read;
1163         __u64    bytes_written;
1164         spinlock_t stat_lock;  /* protects the two fields above */
1165         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1166         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1167         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1168         bool ipc:1;   /* set if connection to IPC$ share (always also pipe) */
1169         bool pipe:1;  /* set if connection to pipe share */
1170         bool print:1; /* set if connection to printer share */
1171         bool retry:1;
1172         bool nocase:1;
1173         bool nohandlecache:1; /* if strange server resource prob can turn off */
1174         bool nodelete:1;
1175         bool seal:1;      /* transport encryption for this mounted share */
1176         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
1177                                 for this mount even if server would support */
1178         bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1179         bool local_lease:1; /* check leases (only) on local system not remote */
1180         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1181         bool broken_sparse_sup; /* if server or share does not support sparse */
1182         bool need_reconnect:1; /* connection reset, tid now invalid */
1183         bool need_reopen_files:1; /* need to reopen tcon file handles */
1184         bool use_resilient:1; /* use resilient instead of durable handles */
1185         bool use_persistent:1; /* use persistent instead of durable handles */
1186         bool no_lease:1;    /* Do not request leases on files or directories */
1187         bool use_witness:1; /* use witness protocol */
1188         __le32 capabilities;
1189         __u32 share_flags;
1190         __u32 maximal_access;
1191         __u32 vol_serial_number;
1192         __le64 vol_create_time;
1193         __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1194         __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1195         __u32 ss_flags;         /* sector size flags */
1196         __u32 perf_sector_size; /* best sector size for perf */
1197         __u32 max_chunks;
1198         __u32 max_bytes_chunk;
1199         __u32 max_bytes_copy;
1200 #ifdef CONFIG_CIFS_FSCACHE
1201         u64 resource_id;                /* server resource id */
1202         struct fscache_volume *fscache; /* cookie for share */
1203 #endif
1204         struct list_head pending_opens; /* list of incomplete opens */
1205         struct cached_fids *cfids;
1206         /* BB add field for back pointer to sb struct(s)? */
1207 #ifdef CONFIG_CIFS_DFS_UPCALL
1208         struct list_head ulist; /* cache update list */
1209 #endif
1210         struct delayed_work     query_interfaces; /* query interfaces workqueue job */
1211 };
1212
1213 /*
1214  * This is a refcounted and timestamped container for a tcon pointer. The
1215  * container holds a tcon reference. It is considered safe to free one of
1216  * these when the tl_count goes to 0. The tl_time is the time of the last
1217  * "get" on the container.
1218  */
1219 struct tcon_link {
1220         struct rb_node          tl_rbnode;
1221         kuid_t                  tl_uid;
1222         unsigned long           tl_flags;
1223 #define TCON_LINK_MASTER        0
1224 #define TCON_LINK_PENDING       1
1225 #define TCON_LINK_IN_TREE       2
1226         unsigned long           tl_time;
1227         atomic_t                tl_count;
1228         struct cifs_tcon        *tl_tcon;
1229 };
1230
1231 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1232 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1233
1234 static inline struct cifs_tcon *
1235 tlink_tcon(struct tcon_link *tlink)
1236 {
1237         return tlink->tl_tcon;
1238 }
1239
1240 static inline struct tcon_link *
1241 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1242 {
1243         return cifs_sb->master_tlink;
1244 }
1245
1246 extern void cifs_put_tlink(struct tcon_link *tlink);
1247
1248 static inline struct tcon_link *
1249 cifs_get_tlink(struct tcon_link *tlink)
1250 {
1251         if (tlink && !IS_ERR(tlink))
1252                 atomic_inc(&tlink->tl_count);
1253         return tlink;
1254 }
1255
1256 /* This function is always expected to succeed */
1257 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1258
1259 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1260
1261 struct cifs_pending_open {
1262         struct list_head olist;
1263         struct tcon_link *tlink;
1264         __u8 lease_key[16];
1265         __u32 oplock;
1266 };
1267
1268 struct cifs_deferred_close {
1269         struct list_head dlist;
1270         struct tcon_link *tlink;
1271         __u16  netfid;
1272         __u64  persistent_fid;
1273         __u64  volatile_fid;
1274 };
1275
1276 /*
1277  * This info hangs off the cifsFileInfo structure, pointed to by llist.
1278  * This is used to track byte stream locks on the file
1279  */
1280 struct cifsLockInfo {
1281         struct list_head llist; /* pointer to next cifsLockInfo */
1282         struct list_head blist; /* pointer to locks blocked on this */
1283         wait_queue_head_t block_q;
1284         __u64 offset;
1285         __u64 length;
1286         __u32 pid;
1287         __u16 type;
1288         __u16 flags;
1289 };
1290
1291 /*
1292  * One of these for each open instance of a file
1293  */
1294 struct cifs_search_info {
1295         loff_t index_of_last_entry;
1296         __u16 entries_in_buffer;
1297         __u16 info_level;
1298         __u32 resume_key;
1299         char *ntwrk_buf_start;
1300         char *srch_entries_start;
1301         char *last_entry;
1302         const char *presume_name;
1303         unsigned int resume_name_len;
1304         bool endOfSearch:1;
1305         bool emptyDir:1;
1306         bool unicode:1;
1307         bool smallBuf:1; /* so we know which buf_release function to call */
1308 };
1309
1310 #define ACL_NO_MODE     ((umode_t)(-1))
1311 struct cifs_open_parms {
1312         struct cifs_tcon *tcon;
1313         struct cifs_sb_info *cifs_sb;
1314         int disposition;
1315         int desired_access;
1316         int create_options;
1317         const char *path;
1318         struct cifs_fid *fid;
1319         umode_t mode;
1320         bool reconnect:1;
1321 };
1322
1323 struct cifs_fid {
1324         __u16 netfid;
1325         __u64 persistent_fid;   /* persist file id for smb2 */
1326         __u64 volatile_fid;     /* volatile file id for smb2 */
1327         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for smb2 */
1328         __u8 create_guid[16];
1329         __u32 access;
1330         struct cifs_pending_open *pending_open;
1331         unsigned int epoch;
1332 #ifdef CONFIG_CIFS_DEBUG2
1333         __u64 mid;
1334 #endif /* CIFS_DEBUG2 */
1335         bool purge_cache;
1336 };
1337
1338 struct cifs_fid_locks {
1339         struct list_head llist;
1340         struct cifsFileInfo *cfile;     /* fid that owns locks */
1341         struct list_head locks;         /* locks held by fid above */
1342 };
1343
1344 struct cifsFileInfo {
1345         /* following two lists are protected by tcon->open_file_lock */
1346         struct list_head tlist; /* pointer to next fid owned by tcon */
1347         struct list_head flist; /* next fid (file instance) for this inode */
1348         /* lock list below protected by cifsi->lock_sem */
1349         struct cifs_fid_locks *llist;   /* brlocks held by this fid */
1350         kuid_t uid;             /* allows finding which FileInfo structure */
1351         __u32 pid;              /* process id who opened file */
1352         struct cifs_fid fid;    /* file id from remote */
1353         struct list_head rlist; /* reconnect list */
1354         /* BB add lock scope info here if needed */
1355         /* lock scope id (0 if none) */
1356         struct dentry *dentry;
1357         struct tcon_link *tlink;
1358         unsigned int f_flags;
1359         bool invalidHandle:1;   /* file closed via session abend */
1360         bool swapfile:1;
1361         bool oplock_break_cancelled:1;
1362         unsigned int oplock_epoch; /* epoch from the lease break */
1363         __u32 oplock_level; /* oplock/lease level from the lease break */
1364         int count;
1365         spinlock_t file_info_lock; /* protects four flag/count fields above */
1366         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1367         struct cifs_search_info srch_inf;
1368         struct work_struct oplock_break; /* work for oplock breaks */
1369         struct work_struct put; /* work for the final part of _put */
1370         struct delayed_work deferred;
1371         bool deferred_close_scheduled; /* Flag to indicate close is scheduled */
1372         char *symlink_target;
1373 };
1374
1375 struct cifs_io_parms {
1376         __u16 netfid;
1377         __u64 persistent_fid;   /* persist file id for smb2 */
1378         __u64 volatile_fid;     /* volatile file id for smb2 */
1379         __u32 pid;
1380         __u64 offset;
1381         unsigned int length;
1382         struct cifs_tcon *tcon;
1383         struct TCP_Server_Info *server;
1384 };
1385
1386 struct cifs_aio_ctx {
1387         struct kref             refcount;
1388         struct list_head        list;
1389         struct mutex            aio_mutex;
1390         struct completion       done;
1391         struct iov_iter         iter;
1392         struct kiocb            *iocb;
1393         struct cifsFileInfo     *cfile;
1394         struct bio_vec          *bv;
1395         loff_t                  pos;
1396         unsigned int            npages;
1397         ssize_t                 rc;
1398         unsigned int            len;
1399         unsigned int            total_len;
1400         bool                    should_dirty;
1401         /*
1402          * Indicates if this aio_ctx is for direct_io,
1403          * If yes, iter is a copy of the user passed iov_iter
1404          */
1405         bool                    direct_io;
1406 };
1407
1408 /* asynchronous read support */
1409 struct cifs_readdata {
1410         struct kref                     refcount;
1411         struct list_head                list;
1412         struct completion               done;
1413         struct cifsFileInfo             *cfile;
1414         struct address_space            *mapping;
1415         struct cifs_aio_ctx             *ctx;
1416         __u64                           offset;
1417         unsigned int                    bytes;
1418         unsigned int                    got_bytes;
1419         pid_t                           pid;
1420         int                             result;
1421         struct work_struct              work;
1422         int (*read_into_pages)(struct TCP_Server_Info *server,
1423                                 struct cifs_readdata *rdata,
1424                                 unsigned int len);
1425         int (*copy_into_pages)(struct TCP_Server_Info *server,
1426                                 struct cifs_readdata *rdata,
1427                                 struct iov_iter *iter);
1428         struct kvec                     iov[2];
1429         struct TCP_Server_Info          *server;
1430 #ifdef CONFIG_CIFS_SMB_DIRECT
1431         struct smbd_mr                  *mr;
1432 #endif
1433         unsigned int                    pagesz;
1434         unsigned int                    page_offset;
1435         unsigned int                    tailsz;
1436         struct cifs_credits             credits;
1437         unsigned int                    nr_pages;
1438         struct page                     **pages;
1439 };
1440
1441 /* asynchronous write support */
1442 struct cifs_writedata {
1443         struct kref                     refcount;
1444         struct list_head                list;
1445         struct completion               done;
1446         enum writeback_sync_modes       sync_mode;
1447         struct work_struct              work;
1448         struct cifsFileInfo             *cfile;
1449         struct cifs_aio_ctx             *ctx;
1450         __u64                           offset;
1451         pid_t                           pid;
1452         unsigned int                    bytes;
1453         int                             result;
1454         struct TCP_Server_Info          *server;
1455 #ifdef CONFIG_CIFS_SMB_DIRECT
1456         struct smbd_mr                  *mr;
1457 #endif
1458         unsigned int                    pagesz;
1459         unsigned int                    page_offset;
1460         unsigned int                    tailsz;
1461         struct cifs_credits             credits;
1462         unsigned int                    nr_pages;
1463         struct page                     **pages;
1464 };
1465
1466 /*
1467  * Take a reference on the file private data. Must be called with
1468  * cfile->file_info_lock held.
1469  */
1470 static inline void
1471 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1472 {
1473         ++cifs_file->count;
1474 }
1475
1476 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1477 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1478                        bool offload);
1479 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1480
1481 #define CIFS_CACHE_READ_FLG     1
1482 #define CIFS_CACHE_HANDLE_FLG   2
1483 #define CIFS_CACHE_RH_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1484 #define CIFS_CACHE_WRITE_FLG    4
1485 #define CIFS_CACHE_RW_FLG       (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1486 #define CIFS_CACHE_RHW_FLG      (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1487
1488 #define CIFS_CACHE_READ(cinode) ((cinode->oplock & CIFS_CACHE_READ_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RO_CACHE))
1489 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1490 #define CIFS_CACHE_WRITE(cinode) ((cinode->oplock & CIFS_CACHE_WRITE_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RW_CACHE))
1491
1492 /*
1493  * One of these for each file inode
1494  */
1495
1496 struct cifsInodeInfo {
1497         struct netfs_inode netfs; /* Netfslib context and vfs inode */
1498         bool can_cache_brlcks;
1499         struct list_head llist; /* locks helb by this inode */
1500         /*
1501          * NOTE: Some code paths call down_read(lock_sem) twice, so
1502          * we must always use cifs_down_write() instead of down_write()
1503          * for this semaphore to avoid deadlocks.
1504          */
1505         struct rw_semaphore lock_sem;   /* protect the fields above */
1506         /* BB add in lists for dirty pages i.e. write caching info for oplock */
1507         struct list_head openFileList;
1508         spinlock_t      open_file_lock; /* protects openFileList */
1509         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1510         unsigned int oplock;            /* oplock/lease level we have */
1511         unsigned int epoch;             /* used to track lease state changes */
1512 #define CIFS_INODE_PENDING_OPLOCK_BREAK   (0) /* oplock break in progress */
1513 #define CIFS_INODE_PENDING_WRITERS        (1) /* Writes in progress */
1514 #define CIFS_INODE_FLAG_UNUSED            (2) /* Unused flag */
1515 #define CIFS_INO_DELETE_PENDING           (3) /* delete pending on server */
1516 #define CIFS_INO_INVALID_MAPPING          (4) /* pagecache is invalid */
1517 #define CIFS_INO_LOCK                     (5) /* lock bit for synchronization */
1518 #define CIFS_INO_MODIFIED_ATTR            (6) /* Indicate change in mtime/ctime */
1519 #define CIFS_INO_CLOSE_ON_LOCK            (7) /* Not to defer the close when lock is set */
1520         unsigned long flags;
1521         spinlock_t writers_lock;
1522         unsigned int writers;           /* Number of writers on this inode */
1523         unsigned long time;             /* jiffies of last update of inode */
1524         u64  server_eof;                /* current file size on server -- protected by i_lock */
1525         u64  uniqueid;                  /* server inode number */
1526         u64  createtime;                /* creation time on server */
1527         __u8 lease_key[SMB2_LEASE_KEY_SIZE];    /* lease key for this inode */
1528         struct list_head deferred_closes; /* list of deferred closes */
1529         spinlock_t deferred_lock; /* protection on deferred list */
1530         bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1531         char *symlink_target;
1532 };
1533
1534 static inline struct cifsInodeInfo *
1535 CIFS_I(struct inode *inode)
1536 {
1537         return container_of(inode, struct cifsInodeInfo, netfs.inode);
1538 }
1539
1540 static inline struct cifs_sb_info *
1541 CIFS_SB(struct super_block *sb)
1542 {
1543         return sb->s_fs_info;
1544 }
1545
1546 static inline struct cifs_sb_info *
1547 CIFS_FILE_SB(struct file *file)
1548 {
1549         return CIFS_SB(file_inode(file)->i_sb);
1550 }
1551
1552 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1553 {
1554         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1555                 return '/';
1556         else
1557                 return '\\';
1558 }
1559
1560 static inline void
1561 convert_delimiter(char *path, char delim)
1562 {
1563         char old_delim, *pos;
1564
1565         if (delim == '/')
1566                 old_delim = '\\';
1567         else
1568                 old_delim = '/';
1569
1570         pos = path;
1571         while ((pos = strchr(pos, old_delim)))
1572                 *pos = delim;
1573 }
1574
1575 #define cifs_stats_inc atomic_inc
1576
1577 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1578                                             unsigned int bytes)
1579 {
1580         if (bytes) {
1581                 spin_lock(&tcon->stat_lock);
1582                 tcon->bytes_written += bytes;
1583                 spin_unlock(&tcon->stat_lock);
1584         }
1585 }
1586
1587 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1588                                          unsigned int bytes)
1589 {
1590         spin_lock(&tcon->stat_lock);
1591         tcon->bytes_read += bytes;
1592         spin_unlock(&tcon->stat_lock);
1593 }
1594
1595
1596 /*
1597  * This is the prototype for the mid receive function. This function is for
1598  * receiving the rest of the SMB frame, starting with the WordCount (which is
1599  * just after the MID in struct smb_hdr). Note:
1600  *
1601  * - This will be called by cifsd, with no locks held.
1602  * - The mid will still be on the pending_mid_q.
1603  * - mid->resp_buf will point to the current buffer.
1604  *
1605  * Returns zero on a successful receive, or an error. The receive state in
1606  * the TCP_Server_Info will also be updated.
1607  */
1608 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1609                             struct mid_q_entry *mid);
1610
1611 /*
1612  * This is the prototype for the mid callback function. This is called once the
1613  * mid has been received off of the socket. When creating one, take special
1614  * care to avoid deadlocks. Things to bear in mind:
1615  *
1616  * - it will be called by cifsd, with no locks held
1617  * - the mid will be removed from any lists
1618  */
1619 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1620
1621 /*
1622  * This is the protopyte for mid handle function. This is called once the mid
1623  * has been recognized after decryption of the message.
1624  */
1625 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1626                             struct mid_q_entry *mid);
1627
1628 /* one of these for every pending CIFS request to the server */
1629 struct mid_q_entry {
1630         struct list_head qhead; /* mids waiting on reply from this server */
1631         struct kref refcount;
1632         struct TCP_Server_Info *server; /* server corresponding to this mid */
1633         __u64 mid;              /* multiplex id */
1634         __u16 credits;          /* number of credits consumed by this mid */
1635         __u16 credits_received; /* number of credits from the response */
1636         __u32 pid;              /* process id */
1637         __u32 sequence_number;  /* for CIFS signing */
1638         unsigned long when_alloc;  /* when mid was created */
1639 #ifdef CONFIG_CIFS_STATS2
1640         unsigned long when_sent; /* time when smb send finished */
1641         unsigned long when_received; /* when demux complete (taken off wire) */
1642 #endif
1643         mid_receive_t *receive; /* call receive callback */
1644         mid_callback_t *callback; /* call completion callback */
1645         mid_handle_t *handle; /* call handle mid callback */
1646         void *callback_data;      /* general purpose pointer for callback */
1647         struct task_struct *creator;
1648         void *resp_buf;         /* pointer to received SMB header */
1649         unsigned int resp_buf_size;
1650         int mid_state;  /* wish this were enum but can not pass to wait_event */
1651         unsigned int mid_flags;
1652         __le16 command;         /* smb command code */
1653         unsigned int optype;    /* operation type */
1654         bool large_buf:1;       /* if valid response, is pointer to large buf */
1655         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1656         bool multiEnd:1;        /* both received */
1657         bool decrypted:1;       /* decrypted entry */
1658 };
1659
1660 struct close_cancelled_open {
1661         struct cifs_fid         fid;
1662         struct cifs_tcon        *tcon;
1663         struct work_struct      work;
1664         __u64 mid;
1665         __u16 cmd;
1666 };
1667
1668 /*      Make code in transport.c a little cleaner by moving
1669         update of optional stats into function below */
1670 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1671 {
1672         atomic_inc(&server->in_send);
1673 }
1674
1675 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1676 {
1677         atomic_dec(&server->in_send);
1678 }
1679
1680 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1681 {
1682         atomic_inc(&server->num_waiters);
1683 }
1684
1685 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1686 {
1687         atomic_dec(&server->num_waiters);
1688 }
1689
1690 #ifdef CONFIG_CIFS_STATS2
1691 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1692 {
1693         mid->when_sent = jiffies;
1694 }
1695 #else
1696 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1697 {
1698 }
1699 #endif
1700
1701 /* for pending dnotify requests */
1702 struct dir_notify_req {
1703         struct list_head lhead;
1704         __le16 Pid;
1705         __le16 PidHigh;
1706         __u16 Mid;
1707         __u16 Tid;
1708         __u16 Uid;
1709         __u16 netfid;
1710         __u32 filter; /* CompletionFilter (for multishot) */
1711         int multishot;
1712         struct file *pfile;
1713 };
1714
1715 struct dfs_info3_param {
1716         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1717         int path_consumed;
1718         int server_type;
1719         int ref_flag;
1720         char *path_name;
1721         char *node_name;
1722         int ttl;
1723 };
1724
1725 struct file_list {
1726         struct list_head list;
1727         struct cifsFileInfo *cfile;
1728 };
1729
1730 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1731 {
1732         if (param) {
1733                 kfree(param->path_name);
1734                 kfree(param->node_name);
1735         }
1736 }
1737
1738 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1739                                        int number_of_items)
1740 {
1741         int i;
1742
1743         if ((number_of_items == 0) || (param == NULL))
1744                 return;
1745         for (i = 0; i < number_of_items; i++) {
1746                 kfree(param[i].path_name);
1747                 kfree(param[i].node_name);
1748         }
1749         kfree(param);
1750 }
1751
1752 static inline bool is_interrupt_error(int error)
1753 {
1754         switch (error) {
1755         case -EINTR:
1756         case -ERESTARTSYS:
1757         case -ERESTARTNOHAND:
1758         case -ERESTARTNOINTR:
1759                 return true;
1760         }
1761         return false;
1762 }
1763
1764 static inline bool is_retryable_error(int error)
1765 {
1766         if (is_interrupt_error(error) || error == -EAGAIN)
1767                 return true;
1768         return false;
1769 }
1770
1771
1772 /* cifs_get_writable_file() flags */
1773 #define FIND_WR_ANY         0
1774 #define FIND_WR_FSUID_ONLY  1
1775 #define FIND_WR_WITH_DELETE 2
1776
1777 #define   MID_FREE 0
1778 #define   MID_REQUEST_ALLOCATED 1
1779 #define   MID_REQUEST_SUBMITTED 2
1780 #define   MID_RESPONSE_RECEIVED 4
1781 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1782 #define   MID_RESPONSE_MALFORMED 0x10
1783 #define   MID_SHUTDOWN           0x20
1784 #define   MID_RESPONSE_READY 0x40 /* ready for other process handle the rsp */
1785
1786 /* Flags */
1787 #define   MID_WAIT_CANCELLED     1 /* Cancelled while waiting for response */
1788 #define   MID_DELETED            2 /* Mid has been dequeued/deleted */
1789
1790 /* Types of response buffer returned from SendReceive2 */
1791 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1792 #define   CIFS_SMALL_BUFFER     1
1793 #define   CIFS_LARGE_BUFFER     2
1794 #define   CIFS_IOVEC            4    /* array of response buffers */
1795
1796 /* Type of Request to SendReceive2 */
1797 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1798 #define   CIFS_NON_BLOCKING     2    /* do not block waiting for credits */
1799 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1800 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1801 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1802 #define   CIFS_NO_RSP_BUF   0x040    /* no response buffer required */
1803
1804 /* Type of request operation */
1805 #define   CIFS_ECHO_OP            0x080  /* echo request */
1806 #define   CIFS_OBREAK_OP          0x0100 /* oplock break request */
1807 #define   CIFS_NEG_OP             0x0200 /* negotiate request */
1808 #define   CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1809 /* Lower bitmask values are reserved by others below. */
1810 #define   CIFS_SESS_OP            0x2000 /* session setup request */
1811 #define   CIFS_OP_MASK            0x2780 /* mask request type */
1812
1813 #define   CIFS_HAS_CREDITS        0x0400 /* already has credits */
1814 #define   CIFS_TRANSFORM_REQ      0x0800 /* transform request before sending */
1815 #define   CIFS_NO_SRV_RSP         0x1000 /* there is no server response */
1816
1817 /* Security Flags: indicate type of session setup needed */
1818 #define   CIFSSEC_MAY_SIGN      0x00001
1819 #define   CIFSSEC_MAY_NTLMV2    0x00004
1820 #define   CIFSSEC_MAY_KRB5      0x00008
1821 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
1822 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
1823
1824 #define   CIFSSEC_MUST_SIGN     0x01001
1825 /* note that only one of the following can be set so the
1826 result of setting MUST flags more than once will be to
1827 require use of the stronger protocol */
1828 #define   CIFSSEC_MUST_NTLMV2   0x04004
1829 #define   CIFSSEC_MUST_KRB5     0x08008
1830 #ifdef CONFIG_CIFS_UPCALL
1831 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1832 #else
1833 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1834 #endif /* UPCALL */
1835 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
1836 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
1837
1838 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1839 #define   CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2)
1840 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1841 /*
1842  *****************************************************************
1843  * All constants go here
1844  *****************************************************************
1845  */
1846
1847 #define UID_HASH (16)
1848
1849 /*
1850  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1851  * following to be declared.
1852  */
1853
1854 /****************************************************************************
1855  * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1856  * to the locking order. i.e. if two locks are to be held together, the lock that
1857  * appears higher in this list needs to be taken before the other.
1858  *
1859  * If you hold a lock that is lower in this list, and you need to take a higher lock
1860  * (or if you think that one of the functions that you're calling may need to), first
1861  * drop the lock you hold, pick up the higher lock, then the lower one. This will
1862  * ensure that locks are picked up only in one direction in the below table
1863  * (top to bottom).
1864  *
1865  * Also, if you expect a function to be called with a lock held, explicitly document
1866  * this in the comments on top of your function definition.
1867  *
1868  * And also, try to keep the critical sections (lock hold time) to be as minimal as
1869  * possible. Blocking / calling other functions with a lock held always increase
1870  * the risk of a possible deadlock.
1871  *
1872  * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1873  * debug. Also, any new lock that you introduce, please add to this list in the correct
1874  * order.
1875  *
1876  * Please populate this list whenever you introduce new locks in your changes. Or in
1877  * case I've missed some existing locks. Please ensure that it's added in the list
1878  * based on the locking order expected.
1879  *
1880  * =====================================================================================
1881  * Lock                         Protects                        Initialization fn
1882  * =====================================================================================
1883  * vol_list_lock
1884  * vol_info->ctx_lock           vol_info->ctx
1885  * cifs_sb_info->tlink_tree_lock        cifs_sb_info->tlink_tree        cifs_setup_cifs_sb
1886  * TCP_Server_Info->            TCP_Server_Info                 cifs_get_tcp_session
1887  * reconnect_mutex
1888  * TCP_Server_Info->srv_mutex   TCP_Server_Info                 cifs_get_tcp_session
1889  * cifs_ses->session_mutex              cifs_ses                sesInfoAlloc
1890  *                              cifs_tcon
1891  * cifs_tcon->open_file_lock    cifs_tcon->openFileList         tconInfoAlloc
1892  *                              cifs_tcon->pending_opens
1893  * cifs_tcon->stat_lock         cifs_tcon->bytes_read           tconInfoAlloc
1894  *                              cifs_tcon->bytes_written
1895  * cifs_tcp_ses_lock            cifs_tcp_ses_list               sesInfoAlloc
1896  * GlobalMid_Lock               GlobalMaxActiveXid              init_cifs
1897  *                              GlobalCurrentXid
1898  *                              GlobalTotalActiveXid
1899  * TCP_Server_Info->srv_lock    (anything in struct not protected by another lock and can change)
1900  * TCP_Server_Info->mid_lock    TCP_Server_Info->pending_mid_q  cifs_get_tcp_session
1901  *                              ->CurrentMid
1902  *                              (any changes in mid_q_entry fields)
1903  * TCP_Server_Info->req_lock    TCP_Server_Info->in_flight      cifs_get_tcp_session
1904  *                              ->credits
1905  *                              ->echo_credits
1906  *                              ->oplock_credits
1907  *                              ->reconnect_instance
1908  * cifs_ses->ses_lock           (anything that is not protected by another lock and can change)
1909  * cifs_ses->iface_lock         cifs_ses->iface_list            sesInfoAlloc
1910  *                              ->iface_count
1911  *                              ->iface_last_update
1912  * cifs_ses->chan_lock          cifs_ses->chans
1913  *                              ->chans_need_reconnect
1914  *                              ->chans_in_reconnect
1915  * cifs_tcon->tc_lock           (anything that is not protected by another lock and can change)
1916  * cifsInodeInfo->open_file_lock        cifsInodeInfo->openFileList     cifs_alloc_inode
1917  * cifsInodeInfo->writers_lock  cifsInodeInfo->writers          cifsInodeInfo_alloc
1918  * cifsInodeInfo->lock_sem      cifsInodeInfo->llist            cifs_init_once
1919  *                              ->can_cache_brlcks
1920  * cifsInodeInfo->deferred_lock cifsInodeInfo->deferred_closes  cifsInodeInfo_alloc
1921  * cached_fid->fid_mutex                cifs_tcon->crfid                tconInfoAlloc
1922  * cifsFileInfo->fh_mutex               cifsFileInfo                    cifs_new_fileinfo
1923  * cifsFileInfo->file_info_lock cifsFileInfo->count             cifs_new_fileinfo
1924  *                              ->invalidHandle                 initiate_cifs_search
1925  *                              ->oplock_break_cancelled
1926  * cifs_aio_ctx->aio_mutex              cifs_aio_ctx                    cifs_aio_ctx_alloc
1927  ****************************************************************************/
1928
1929 #ifdef DECLARE_GLOBALS_HERE
1930 #define GLOBAL_EXTERN
1931 #else
1932 #define GLOBAL_EXTERN extern
1933 #endif
1934
1935 /*
1936  * the list of TCP_Server_Info structures, ie each of the sockets
1937  * connecting our client to a distinct server (ip address), is
1938  * chained together by cifs_tcp_ses_list. The list of all our SMB
1939  * sessions (and from that the tree connections) can be found
1940  * by iterating over cifs_tcp_ses_list
1941  */
1942 extern struct list_head         cifs_tcp_ses_list;
1943
1944 /*
1945  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1946  * tcp session, and the list of tcon's per smb session. It also protects
1947  * the reference counters for the server, smb session, and tcon.
1948  * generally the locks should be taken in order tcp_ses_lock before
1949  * tcon->open_file_lock and that before file->file_info_lock since the
1950  * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1951  */
1952 extern spinlock_t               cifs_tcp_ses_lock;
1953
1954 /*
1955  * Global transaction id (XID) information
1956  */
1957 extern unsigned int GlobalCurrentXid;   /* protected by GlobalMid_Sem */
1958 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1959 extern unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1960 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
1961
1962 /*
1963  *  Global counters, updated atomically
1964  */
1965 extern atomic_t sesInfoAllocCount;
1966 extern atomic_t tconInfoAllocCount;
1967 extern atomic_t tcpSesNextId;
1968 extern atomic_t tcpSesAllocCount;
1969 extern atomic_t tcpSesReconnectCount;
1970 extern atomic_t tconInfoReconnectCount;
1971
1972 /* Various Debug counters */
1973 extern atomic_t buf_alloc_count;        /* current number allocated  */
1974 extern atomic_t small_buf_alloc_count;
1975 #ifdef CONFIG_CIFS_STATS2
1976 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
1977 extern atomic_t total_small_buf_alloc_count;
1978 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
1979 #endif
1980
1981 /* Misc globals */
1982 extern bool enable_oplocks; /* enable or disable oplocks */
1983 extern bool lookupCacheEnabled;
1984 extern unsigned int global_secflags;    /* if on, session setup sent
1985                                 with more secure ntlmssp2 challenge/resp */
1986 extern unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
1987 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
1988 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
1989 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
1990 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1991 extern unsigned int CIFSMaxBufSize;  /* max size not including hdr */
1992 extern unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
1993 extern unsigned int cifs_min_small;  /* min size of small buf pool */
1994 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1995 extern bool disable_legacy_dialects;  /* forbid vers=1.0 and vers=2.0 mounts */
1996 extern atomic_t mid_count;
1997
1998 void cifs_oplock_break(struct work_struct *work);
1999 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2000 void smb2_deferred_work_close(struct work_struct *work);
2001
2002 extern const struct slow_work_ops cifs_oplock_break_ops;
2003 extern struct workqueue_struct *cifsiod_wq;
2004 extern struct workqueue_struct *decrypt_wq;
2005 extern struct workqueue_struct *fileinfo_put_wq;
2006 extern struct workqueue_struct *cifsoplockd_wq;
2007 extern struct workqueue_struct *deferredclose_wq;
2008 extern __u32 cifs_lock_secret;
2009
2010 extern mempool_t *cifs_mid_poolp;
2011
2012 /* Operations for different SMB versions */
2013 #define SMB1_VERSION_STRING     "1.0"
2014 #define SMB20_VERSION_STRING    "2.0"
2015 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2016 extern struct smb_version_operations smb1_operations;
2017 extern struct smb_version_values smb1_values;
2018 extern struct smb_version_operations smb20_operations;
2019 extern struct smb_version_values smb20_values;
2020 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2021 #define SMB21_VERSION_STRING    "2.1"
2022 extern struct smb_version_operations smb21_operations;
2023 extern struct smb_version_values smb21_values;
2024 #define SMBDEFAULT_VERSION_STRING "default"
2025 extern struct smb_version_values smbdefault_values;
2026 #define SMB3ANY_VERSION_STRING "3"
2027 extern struct smb_version_values smb3any_values;
2028 #define SMB30_VERSION_STRING    "3.0"
2029 extern struct smb_version_operations smb30_operations;
2030 extern struct smb_version_values smb30_values;
2031 #define SMB302_VERSION_STRING   "3.02"
2032 #define ALT_SMB302_VERSION_STRING "3.0.2"
2033 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2034 extern struct smb_version_values smb302_values;
2035 #define SMB311_VERSION_STRING   "3.1.1"
2036 #define ALT_SMB311_VERSION_STRING "3.11"
2037 extern struct smb_version_operations smb311_operations;
2038 extern struct smb_version_values smb311_values;
2039
2040 static inline char *get_security_type_str(enum securityEnum sectype)
2041 {
2042         switch (sectype) {
2043         case RawNTLMSSP:
2044                 return "RawNTLMSSP";
2045         case Kerberos:
2046                 return "Kerberos";
2047         case NTLMv2:
2048                 return "NTLMv2";
2049         default:
2050                 return "Unknown";
2051         }
2052 }
2053
2054 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2055 {
2056         return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2057 }
2058
2059 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2060 {
2061         /*
2062          * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2063          * Subsystem Notifies That a Share Is a DFS Share.
2064          *
2065          * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2066          * Application Updates a Share.
2067          */
2068         if (!tcon || !tcon->ses || !tcon->ses->server)
2069                 return false;
2070         return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2071                 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2072 }
2073
2074 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2075                                            const struct dfs_info3_param *ref)
2076 {
2077         /*
2078          * Check if all targets are capable of handling DFS referrals as per
2079          * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2080          */
2081         return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2082 }
2083
2084 static inline u64 cifs_flock_len(const struct file_lock *fl)
2085 {
2086         return (u64)fl->fl_end - fl->fl_start + 1;
2087 }
2088
2089 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2090 {
2091         if (WARN_ON_ONCE(!ses || !ses->server))
2092                 return 0;
2093         /*
2094          * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2095          * servers do require it during NTLMSSP.
2096          */
2097         if (ses->server->dialect <= SMB20_PROT_ID)
2098                 return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2099         return sizeof(ses->workstation_name);
2100 }
2101
2102 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2103 {
2104         memcpy(dst, src, (size_t)((u8 *)&src->AccessFlags - (u8 *)src));
2105         dst->AccessFlags = src->AccessFlags;
2106         dst->CurrentByteOffset = src->CurrentByteOffset;
2107         dst->Mode = src->Mode;
2108         dst->AlignmentRequirement = src->AlignmentRequirement;
2109         dst->FileNameLength = src->FileNameLength;
2110 }
2111
2112 static inline unsigned int cifs_get_num_sgs(const struct smb_rqst *rqst,
2113                                             int num_rqst,
2114                                             const u8 *sig)
2115 {
2116         unsigned int len, skip;
2117         unsigned int nents = 0;
2118         unsigned long addr;
2119         int i, j;
2120
2121         /* Assumes the first rqst has a transform header as the first iov.
2122          * I.e.
2123          * rqst[0].rq_iov[0]  is transform header
2124          * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2125          * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2126          */
2127         for (i = 0; i < num_rqst; i++) {
2128                 /*
2129                  * The first rqst has a transform header where the
2130                  * first 20 bytes are not part of the encrypted blob.
2131                  */
2132                 for (j = 0; j < rqst[i].rq_nvec; j++) {
2133                         struct kvec *iov = &rqst[i].rq_iov[j];
2134
2135                         skip = (i == 0) && (j == 0) ? 20 : 0;
2136                         addr = (unsigned long)iov->iov_base + skip;
2137                         if (unlikely(is_vmalloc_addr((void *)addr))) {
2138                                 len = iov->iov_len - skip;
2139                                 nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2140                                                       PAGE_SIZE);
2141                         } else {
2142                                 nents++;
2143                         }
2144                 }
2145                 nents += rqst[i].rq_npages;
2146         }
2147         nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2148         return nents;
2149 }
2150
2151 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2152  * stack object as buf.
2153  */
2154 static inline struct scatterlist *cifs_sg_set_buf(struct scatterlist *sg,
2155                                                   const void *buf,
2156                                                   unsigned int buflen)
2157 {
2158         unsigned long addr = (unsigned long)buf;
2159         unsigned int off = offset_in_page(addr);
2160
2161         addr &= PAGE_MASK;
2162         if (unlikely(is_vmalloc_addr((void *)addr))) {
2163                 do {
2164                         unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2165
2166                         sg_set_page(sg++, vmalloc_to_page((void *)addr), len, off);
2167
2168                         off = 0;
2169                         addr += PAGE_SIZE;
2170                         buflen -= len;
2171                 } while (buflen);
2172         } else {
2173                 sg_set_page(sg++, virt_to_page(addr), buflen, off);
2174         }
2175         return sg;
2176 }
2177
2178 #endif  /* _CIFS_GLOB_H */