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