~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/fs/cifs/cifsglob.h

Version: ~ [ linux-5.16-rc3 ] ~ [ linux-5.15.5 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.82 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.162 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.218 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.256 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.291 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.293 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp