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