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