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