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