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