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