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