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