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