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