1 /* SPDX-License-Identifier: LGPL-2.1 */
2 /*
3 *
4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
7 *
8 */
9 #ifndef _CIFS_GLOB_H
10 #define _CIFS_GLOB_H
11
12 #include <linux/in.h>
13 #include <linux/in6.h>
14 #include <linux/inet.h>
15 #include <linux/slab.h>
16 #include <linux/scatterlist.h>
17 #include <linux/mm.h>
18 #include <linux/mempool.h>
19 #include <linux/workqueue.h>
20 #include <linux/utsname.h>
21 #include <linux/sched/mm.h>
22 #include <linux/netfs.h>
23 #include "cifs_fs_sb.h"
24 #include "cifsacl.h"
25 #include <crypto/internal/hash.h>
26 #include <uapi/linux/cifs/cifs_mount.h>
27 #include "../common/smb2pdu.h"
28 #include "smb2pdu.h"
29 #include <linux/filelock.h>
30
31 #define SMB_PATH_MAX 260
32 #define CIFS_PORT 445
33 #define RFC1001_PORT 139
34
35 /*
36 * The sizes of various internal tables and strings
37 */
38 #define MAX_UID_INFO 16
39 #define MAX_SES_INFO 2
40 #define MAX_TCON_INFO 4
41
42 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
43
44 #define CIFS_MIN_RCV_POOL 4
45
46 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
47 /*
48 * default attribute cache timeout (jiffies)
49 */
50 #define CIFS_DEF_ACTIMEO (1 * HZ)
51
52 /*
53 * max sleep time before retry to server
54 */
55 #define CIFS_MAX_SLEEP 2000
56
57 /*
58 * max attribute cache timeout (jiffies) - 2^30
59 */
60 #define CIFS_MAX_ACTIMEO (1 << 30)
61
62 /*
63 * Max persistent and resilient handle timeout (milliseconds).
64 * Windows durable max was 960000 (16 minutes)
65 */
66 #define SMB3_MAX_HANDLE_TIMEOUT 960000
67
68 /*
69 * MAX_REQ is the maximum number of requests that WE will send
70 * on one socket concurrently.
71 */
72 #define CIFS_MAX_REQ 32767
73
74 #define RFC1001_NAME_LEN 15
75 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
76
77 /* maximum length of ip addr as a string (including ipv6 and sctp) */
78 #define SERVER_NAME_LENGTH 80
79 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
80
81 /* echo interval in seconds */
82 #define SMB_ECHO_INTERVAL_MIN 1
83 #define SMB_ECHO_INTERVAL_MAX 600
84 #define SMB_ECHO_INTERVAL_DEFAULT 60
85
86 /* smb multichannel query server interfaces interval in seconds */
87 #define SMB_INTERFACE_POLL_INTERVAL 600
88
89 /* maximum number of PDUs in one compound */
90 #define MAX_COMPOUND 7
91
92 /*
93 * Default number of credits to keep available for SMB3.
94 * This value is chosen somewhat arbitrarily. The Windows client
95 * defaults to 128 credits, the Windows server allows clients up to
96 * 512 credits (or 8K for later versions), and the NetApp server
97 * does not limit clients at all. Choose a high enough default value
98 * such that the client shouldn't limit performance, but allow mount
99 * to override (until you approach 64K, where we limit credits to 65000
100 * to reduce possibility of seeing more server credit overflow bugs.
101 */
102 #define SMB2_MAX_CREDITS_AVAILABLE 32000
103
104 #include "cifspdu.h"
105
106 #ifndef XATTR_DOS_ATTRIB
107 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
108 #endif
109
110 #define CIFS_MAX_WORKSTATION_LEN (__NEW_UTS_LEN + 1) /* reasonable max for client */
111
112 #define CIFS_DFS_ROOT_SES(ses) ((ses)->dfs_root_ses ?: (ses))
113
114 /*
115 * CIFS vfs client Status information (based on what we know.)
116 */
117
118 /* associated with each connection */
119 enum statusEnum {
120 CifsNew = 0,
121 CifsGood,
122 CifsExiting,
123 CifsNeedReconnect,
124 CifsNeedNegotiate,
125 CifsInNegotiate,
126 };
127
128 /* associated with each smb session */
129 enum ses_status_enum {
130 SES_NEW = 0,
131 SES_GOOD,
132 SES_EXITING,
133 SES_NEED_RECON,
134 SES_IN_SETUP
135 };
136
137 /* associated with each tree connection to the server */
138 enum tid_status_enum {
139 TID_NEW = 0,
140 TID_GOOD,
141 TID_EXITING,
142 TID_NEED_RECON,
143 TID_NEED_TCON,
144 TID_IN_TCON,
145 TID_NEED_FILES_INVALIDATE, /* currently unused */
146 TID_IN_FILES_INVALIDATE
147 };
148
149 enum securityEnum {
150 Unspecified = 0, /* not specified */
151 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
152 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
153 Kerberos, /* Kerberos via SPNEGO */
154 IAKerb, /* Kerberos proxy */
155 };
156
157 enum upcall_target_enum {
158 UPTARGET_UNSPECIFIED, /* not specified, defaults to app */
159 UPTARGET_MOUNT, /* upcall to the mount namespace */
160 UPTARGET_APP, /* upcall to the application namespace which did the mount */
161 };
162
163 enum cifs_reparse_type {
164 CIFS_REPARSE_TYPE_NONE,
165 CIFS_REPARSE_TYPE_NFS,
166 CIFS_REPARSE_TYPE_WSL,
167 CIFS_REPARSE_TYPE_DEFAULT = CIFS_REPARSE_TYPE_NFS,
168 };
169
cifs_reparse_type_str(enum cifs_reparse_type type)170 static inline const char *cifs_reparse_type_str(enum cifs_reparse_type type)
171 {
172 switch (type) {
173 case CIFS_REPARSE_TYPE_NONE:
174 return "none";
175 case CIFS_REPARSE_TYPE_NFS:
176 return "nfs";
177 case CIFS_REPARSE_TYPE_WSL:
178 return "wsl";
179 default:
180 return "unknown";
181 }
182 }
183
184 enum cifs_symlink_type {
185 CIFS_SYMLINK_TYPE_DEFAULT,
186 CIFS_SYMLINK_TYPE_NONE,
187 CIFS_SYMLINK_TYPE_NATIVE,
188 CIFS_SYMLINK_TYPE_UNIX,
189 CIFS_SYMLINK_TYPE_MFSYMLINKS,
190 CIFS_SYMLINK_TYPE_SFU,
191 CIFS_SYMLINK_TYPE_NFS,
192 CIFS_SYMLINK_TYPE_WSL,
193 };
194
cifs_symlink_type_str(enum cifs_symlink_type type)195 static inline const char *cifs_symlink_type_str(enum cifs_symlink_type type)
196 {
197 switch (type) {
198 case CIFS_SYMLINK_TYPE_NONE:
199 return "none";
200 case CIFS_SYMLINK_TYPE_NATIVE:
201 return "native";
202 case CIFS_SYMLINK_TYPE_UNIX:
203 return "unix";
204 case CIFS_SYMLINK_TYPE_MFSYMLINKS:
205 return "mfsymlinks";
206 case CIFS_SYMLINK_TYPE_SFU:
207 return "sfu";
208 case CIFS_SYMLINK_TYPE_NFS:
209 return "nfs";
210 case CIFS_SYMLINK_TYPE_WSL:
211 return "wsl";
212 default:
213 return "unknown";
214 }
215 }
216
217 struct session_key {
218 unsigned int len;
219 char *response;
220 };
221
222 /* crypto hashing related structure/fields, not specific to a sec mech */
223 struct cifs_secmech {
224 struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */
225 struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */
226 struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */
227 struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */
228
229 struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */
230 struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */
231 };
232
233 /* per smb session structure/fields */
234 struct ntlmssp_auth {
235 bool sesskey_per_smbsess; /* whether session key is per smb session */
236 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
237 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
238 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
239 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
240 };
241
242 struct cifs_cred {
243 int uid;
244 int gid;
245 int mode;
246 int cecount;
247 struct smb_sid osid;
248 struct smb_sid gsid;
249 struct cifs_ntace *ntaces;
250 struct smb_ace *aces;
251 };
252
253 struct cifs_open_info_data {
254 bool adjust_tz;
255 bool reparse_point;
256 bool contains_posix_file_info;
257 struct {
258 /* ioctl response buffer */
259 struct {
260 int buftype;
261 struct kvec iov;
262 } io;
263 __u32 tag;
264 struct reparse_data_buffer *buf;
265 } reparse;
266 struct {
267 __u8 eas[SMB2_WSL_MAX_QUERY_EA_RESP_SIZE];
268 unsigned int eas_len;
269 } wsl;
270 char *symlink_target;
271 struct smb_sid posix_owner;
272 struct smb_sid posix_group;
273 union {
274 struct smb2_file_all_info fi;
275 struct smb311_posix_qinfo posix_fi;
276 };
277 };
278
279 /*
280 *****************************************************************
281 * Except the CIFS PDUs themselves all the
282 * globally interesting structs should go here
283 *****************************************************************
284 */
285
286 /*
287 * A smb_rqst represents a complete request to be issued to a server. It's
288 * formed by a kvec array, followed by an array of pages. Page data is assumed
289 * to start at the beginning of the first page.
290 */
291 struct smb_rqst {
292 struct kvec *rq_iov; /* array of kvecs */
293 unsigned int rq_nvec; /* number of kvecs in array */
294 struct iov_iter rq_iter; /* Data iterator */
295 struct folio_queue *rq_buffer; /* Buffer for encryption */
296 };
297
298 struct mid_q_entry;
299 struct TCP_Server_Info;
300 struct cifsFileInfo;
301 struct cifs_ses;
302 struct cifs_tcon;
303 struct dfs_info3_param;
304 struct cifs_fattr;
305 struct smb3_fs_context;
306 struct cifs_fid;
307 struct cifs_io_subrequest;
308 struct cifs_io_parms;
309 struct cifs_search_info;
310 struct cifsInodeInfo;
311 struct cifs_open_parms;
312 struct cifs_credits;
313
314 struct smb_version_operations {
315 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
316 struct mid_q_entry *);
317 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
318 /* setup request: allocate mid, sign message */
319 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
320 struct TCP_Server_Info *,
321 struct smb_rqst *);
322 /* setup async request: allocate mid, sign message */
323 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
324 struct smb_rqst *);
325 /* check response: verify signature, map error */
326 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
327 bool);
328 void (*add_credits)(struct TCP_Server_Info *server,
329 struct cifs_credits *credits,
330 const int optype);
331 void (*set_credits)(struct TCP_Server_Info *, const int);
332 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
333 unsigned int (*get_credits)(struct mid_q_entry *);
334 __u64 (*get_next_mid)(struct TCP_Server_Info *);
335 void (*revert_current_mid)(struct TCP_Server_Info *server,
336 const unsigned int val);
337 /* data offset from read response message */
338 unsigned int (*read_data_offset)(char *);
339 /*
340 * Data length from read response message
341 * When in_remaining is true, the returned data length is in
342 * message field DataRemaining for out-of-band data read (e.g through
343 * Memory Registration RDMA write in SMBD).
344 * Otherwise, the returned data length is in message field DataLength.
345 */
346 unsigned int (*read_data_length)(char *, bool in_remaining);
347 /* map smb to linux error */
348 int (*map_error)(char *, bool);
349 /* find mid corresponding to the response message */
350 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
351 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
352 void (*clear_stats)(struct cifs_tcon *);
353 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
354 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
355 /* verify the message */
356 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
357 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
358 int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *);
359 void (*downgrade_oplock)(struct TCP_Server_Info *server,
360 struct cifsInodeInfo *cinode, __u32 oplock,
361 __u16 epoch, bool *purge_cache);
362 /* process transaction2 response */
363 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
364 char *, int);
365 /* check if we need to negotiate */
366 bool (*need_neg)(struct TCP_Server_Info *);
367 /* negotiate to the server */
368 int (*negotiate)(const unsigned int xid,
369 struct cifs_ses *ses,
370 struct TCP_Server_Info *server);
371 /* set negotiated write size */
372 unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
373 /* set negotiated read size */
374 unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx);
375 /* setup smb sessionn */
376 int (*sess_setup)(const unsigned int, struct cifs_ses *,
377 struct TCP_Server_Info *server,
378 const struct nls_table *);
379 /* close smb session */
380 int (*logoff)(const unsigned int, struct cifs_ses *);
381 /* connect to a server share */
382 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
383 struct cifs_tcon *, const struct nls_table *);
384 /* close tree connection */
385 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
386 /* get DFS referrals */
387 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
388 const char *, struct dfs_info3_param **,
389 unsigned int *, const struct nls_table *, int);
390 /* informational QFS call */
391 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
392 struct cifs_sb_info *);
393 /* query for server interfaces */
394 int (*query_server_interfaces)(const unsigned int, struct cifs_tcon *,
395 bool);
396 /* check if a path is accessible or not */
397 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
398 struct cifs_sb_info *, const char *);
399 /* query path data from the server */
400 int (*query_path_info)(const unsigned int xid,
401 struct cifs_tcon *tcon,
402 struct cifs_sb_info *cifs_sb,
403 const char *full_path,
404 struct cifs_open_info_data *data);
405 /* query file data from the server */
406 int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon,
407 struct cifsFileInfo *cfile, struct cifs_open_info_data *data);
408 /* query reparse point to determine which type of special file */
409 int (*query_reparse_point)(const unsigned int xid,
410 struct cifs_tcon *tcon,
411 struct cifs_sb_info *cifs_sb,
412 const char *full_path,
413 u32 *tag, struct kvec *rsp,
414 int *rsp_buftype);
415 /* get server index number */
416 int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon,
417 struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid,
418 struct cifs_open_info_data *data);
419 /* set size by path */
420 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
421 const char *, __u64, struct cifs_sb_info *, bool,
422 struct dentry *);
423 /* set size by file handle */
424 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
425 struct cifsFileInfo *, __u64, bool);
426 /* set attributes */
427 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
428 const unsigned int);
429 int (*set_compression)(const unsigned int, struct cifs_tcon *,
430 struct cifsFileInfo *);
431 /* check if we can send an echo or nor */
432 bool (*can_echo)(struct TCP_Server_Info *);
433 /* send echo request */
434 int (*echo)(struct TCP_Server_Info *);
435 /* create directory */
436 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
437 umode_t mode, struct cifs_tcon *tcon,
438 const char *full_path,
439 struct cifs_sb_info *cifs_sb);
440 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
441 struct cifs_tcon *tcon, const char *name,
442 struct cifs_sb_info *sb);
443 /* set info on created directory */
444 void (*mkdir_setinfo)(struct inode *, const char *,
445 struct cifs_sb_info *, struct cifs_tcon *,
446 const unsigned int);
447 /* remove directory */
448 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
449 struct cifs_sb_info *);
450 /* unlink file */
451 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
452 struct cifs_sb_info *, struct dentry *);
453 /* open, rename and delete file */
454 int (*rename_pending_delete)(const char *, struct dentry *,
455 const unsigned int);
456 /* send rename request */
457 int (*rename)(const unsigned int xid,
458 struct cifs_tcon *tcon,
459 struct dentry *source_dentry,
460 const char *from_name, const char *to_name,
461 struct cifs_sb_info *cifs_sb);
462 /* send create hardlink request */
463 int (*create_hardlink)(const unsigned int xid,
464 struct cifs_tcon *tcon,
465 struct dentry *source_dentry,
466 const char *from_name, const char *to_name,
467 struct cifs_sb_info *cifs_sb);
468 /* query symlink target */
469 int (*query_symlink)(const unsigned int xid,
470 struct cifs_tcon *tcon,
471 struct cifs_sb_info *cifs_sb,
472 const char *full_path,
473 char **target_path);
474 /* open a file for non-posix mounts */
475 int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
476 void *buf);
477 /* set fid protocol-specific info */
478 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
479 /* close a file */
480 int (*close)(const unsigned int, struct cifs_tcon *,
481 struct cifs_fid *);
482 /* close a file, returning file attributes and timestamps */
483 int (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
484 struct cifsFileInfo *pfile_info);
485 /* send a flush request to the server */
486 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
487 /* async read from the server */
488 int (*async_readv)(struct cifs_io_subrequest *);
489 /* async write to the server */
490 void (*async_writev)(struct cifs_io_subrequest *);
491 /* sync read from the server */
492 int (*sync_read)(const unsigned int, struct cifs_fid *,
493 struct cifs_io_parms *, unsigned int *, char **,
494 int *);
495 /* sync write to the server */
496 int (*sync_write)(const unsigned int, struct cifs_fid *,
497 struct cifs_io_parms *, unsigned int *, struct kvec *,
498 unsigned long);
499 /* open dir, start readdir */
500 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
501 const char *, struct cifs_sb_info *,
502 struct cifs_fid *, __u16,
503 struct cifs_search_info *);
504 /* continue readdir */
505 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
506 struct cifs_fid *,
507 __u16, struct cifs_search_info *srch_inf);
508 /* close dir */
509 int (*close_dir)(const unsigned int, struct cifs_tcon *,
510 struct cifs_fid *);
511 /* calculate a size of SMB message */
512 unsigned int (*calc_smb_size)(void *buf);
513 /* check for STATUS_PENDING and process the response if yes */
514 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
515 /* check for STATUS_NETWORK_SESSION_EXPIRED */
516 bool (*is_session_expired)(char *);
517 /* send oplock break response */
518 int (*oplock_response)(struct cifs_tcon *tcon, __u64 persistent_fid, __u64 volatile_fid,
519 __u16 net_fid, struct cifsInodeInfo *cifs_inode);
520 /* query remote filesystem */
521 int (*queryfs)(const unsigned int, struct cifs_tcon *,
522 const char *, struct cifs_sb_info *, struct kstatfs *);
523 /* send mandatory brlock to the server */
524 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
525 __u64, __u32, int, int, bool);
526 /* unlock range of mandatory locks */
527 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
528 const unsigned int);
529 /* push brlocks from the cache to the server */
530 int (*push_mand_locks)(struct cifsFileInfo *);
531 /* get lease key of the inode */
532 void (*get_lease_key)(struct inode *, struct cifs_fid *);
533 /* set lease key of the inode */
534 void (*set_lease_key)(struct inode *, struct cifs_fid *);
535 /* generate new lease key */
536 void (*new_lease_key)(struct cifs_fid *);
537 int (*generate_signingkey)(struct cifs_ses *ses,
538 struct TCP_Server_Info *server);
539 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
540 bool allocate_crypto);
541 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
542 struct cifsFileInfo *src_file);
543 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
544 struct cifsFileInfo *src_file, void __user *);
545 int (*notify)(const unsigned int xid, struct file *pfile,
546 void __user *pbuf, bool return_changes);
547 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
548 struct cifs_sb_info *, const unsigned char *,
549 char *, unsigned int *);
550 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
551 struct cifs_sb_info *, const unsigned char *,
552 char *, unsigned int *);
553 /* if we can do cache read operations */
554 bool (*is_read_op)(__u32);
555 /* set oplock level for the inode */
556 void (*set_oplock_level)(struct cifsInodeInfo *cinode, __u32 oplock, __u16 epoch,
557 bool *purge_cache);
558 /* create lease context buffer for CREATE request */
559 char * (*create_lease_buf)(u8 *lease_key, u8 oplock, u8 *parent_lease_key, __le32 le_flags);
560 /* parse lease context buffer and return oplock/epoch info */
561 __u8 (*parse_lease_buf)(void *buf, __u16 *epoch, char *lkey);
562 ssize_t (*copychunk_range)(const unsigned int,
563 struct cifsFileInfo *src_file,
564 struct cifsFileInfo *target_file,
565 u64 src_off, u64 len, u64 dest_off);
566 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
567 struct cifsFileInfo *target_file, u64 src_off, u64 len,
568 u64 dest_off);
569 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
570 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
571 const unsigned char *, const unsigned char *, char *,
572 size_t, struct cifs_sb_info *);
573 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
574 const char *, const void *, const __u16,
575 const struct nls_table *, struct cifs_sb_info *);
576 struct smb_ntsd * (*get_acl)(struct cifs_sb_info *cifssb, struct inode *ino,
577 const char *patch, u32 *plen, u32 info);
578 struct smb_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *cifssmb,
579 const struct cifs_fid *pfid, u32 *plen, u32 info);
580 int (*set_acl)(struct smb_ntsd *pntsd, __u32 len, struct inode *ino, const char *path,
581 int flag);
582 /* writepages retry size */
583 unsigned int (*wp_retry_size)(struct inode *);
584 /* get mtu credits */
585 int (*wait_mtu_credits)(struct TCP_Server_Info *, size_t,
586 size_t *, struct cifs_credits *);
587 /* adjust previously taken mtu credits to request size */
588 int (*adjust_credits)(struct TCP_Server_Info *server,
589 struct cifs_io_subrequest *subreq,
590 unsigned int /*enum smb3_rw_credits_trace*/ trace);
591 /* check if we need to issue closedir */
592 bool (*dir_needs_close)(struct cifsFileInfo *);
593 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
594 loff_t);
595 /* init transform (compress/encrypt) request */
596 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
597 struct smb_rqst *, struct smb_rqst *);
598 int (*is_transform_hdr)(void *buf);
599 int (*receive_transform)(struct TCP_Server_Info *,
600 struct mid_q_entry **, char **, int *);
601 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
602 enum securityEnum);
603 int (*next_header)(struct TCP_Server_Info *server, char *buf,
604 unsigned int *noff);
605 /* ioctl passthrough for query_info */
606 int (*ioctl_query_info)(const unsigned int xid,
607 struct cifs_tcon *tcon,
608 struct cifs_sb_info *cifs_sb,
609 __le16 *path, int is_dir,
610 unsigned long p);
611 /* make unix special files (block, char, fifo, socket) */
612 int (*make_node)(unsigned int xid,
613 struct inode *inode,
614 struct dentry *dentry,
615 struct cifs_tcon *tcon,
616 const char *full_path,
617 umode_t mode,
618 dev_t device_number);
619 /* version specific fiemap implementation */
620 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
621 struct fiemap_extent_info *, u64, u64);
622 /* version specific llseek implementation */
623 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
624 /* Check for STATUS_IO_TIMEOUT */
625 bool (*is_status_io_timeout)(char *buf);
626 /* Check for STATUS_NETWORK_NAME_DELETED */
627 bool (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv);
628 struct reparse_data_buffer * (*get_reparse_point_buffer)(const struct kvec *rsp_iov,
629 u32 *plen);
630 int (*create_reparse_symlink)(const unsigned int xid,
631 struct inode *inode,
632 struct dentry *dentry,
633 struct cifs_tcon *tcon,
634 const char *full_path,
635 const char *symname);
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 static inline void
inc_rfc1001_len(void * buf,int count)704 inc_rfc1001_len(void *buf, int count)
705 {
706 be32_add_cpu((__be32 *)buf, count);
707 }
708
709 struct TCP_Server_Info {
710 struct list_head tcp_ses_list;
711 struct list_head smb_ses_list;
712 struct list_head rlist; /* reconnect list */
713 spinlock_t srv_lock; /* protect anything here that is not protected */
714 __u64 conn_id; /* connection identifier (useful for debugging) */
715 int srv_count; /* reference counter */
716 int rfc1001_sessinit; /* whether to estasblish netbios session */
717 bool with_rfc1001; /* if netbios session is used */
718 /* 15 character server name + 0x20 16th byte indicating type = srv */
719 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
720 struct smb_version_operations *ops;
721 struct smb_version_values *vals;
722 /* updates to tcpStatus protected by cifs_tcp_ses_lock */
723 enum statusEnum tcpStatus; /* what we think the status is */
724 char *hostname; /* hostname portion of UNC string */
725 struct socket *ssocket;
726 struct sockaddr_storage dstaddr;
727 struct sockaddr_storage srcaddr; /* locally bind to this IP */
728 #ifdef CONFIG_NET_NS
729 struct net *net;
730 #endif
731 wait_queue_head_t response_q;
732 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
733 spinlock_t mid_lock; /* protect mid queue and it's entries */
734 struct list_head pending_mid_q;
735 bool noblocksnd; /* use blocking sendmsg */
736 bool noautotune; /* do not autotune send buf sizes */
737 bool nosharesock;
738 bool tcp_nodelay;
739 bool terminate;
740 unsigned int credits; /* send no more requests at once */
741 unsigned int max_credits; /* can override large 32000 default at mnt */
742 unsigned int in_flight; /* number of requests on the wire to server */
743 unsigned int max_in_flight; /* max number of requests that were on wire */
744 spinlock_t req_lock; /* protect the two values above */
745 struct mutex _srv_mutex;
746 unsigned int nofs_flag;
747 struct task_struct *tsk;
748 char server_GUID[16];
749 __u16 sec_mode;
750 bool sign; /* is signing enabled on this connection? */
751 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
752 bool session_estab; /* mark when very first sess is established */
753 int echo_credits; /* echo reserved slots */
754 int oplock_credits; /* oplock break reserved slots */
755 bool echoes:1; /* enable echoes */
756 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
757 u16 dialect; /* dialect index that server chose */
758 bool oplocks:1; /* enable oplocks */
759 unsigned int maxReq; /* Clients should submit no more */
760 /* than maxReq distinct unanswered SMBs to the server when using */
761 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
762 unsigned int maxBuf; /* maxBuf specifies the maximum */
763 /* message size the server can send or receive for non-raw SMBs */
764 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
765 /* when socket is setup (and during reconnect) before NegProt sent */
766 unsigned int max_rw; /* maxRw specifies the maximum */
767 /* message size the server can send or receive for */
768 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
769 unsigned int capabilities; /* selective disabling of caps by smb sess */
770 int timeAdj; /* Adjust for difference in server time zone in sec */
771 __u64 CurrentMid; /* multiplex id - rotating counter, protected by GlobalMid_Lock */
772 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
773 /* 16th byte of RFC1001 workstation name is always null */
774 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
775 __u32 sequence_number; /* for signing, protected by srv_mutex */
776 __u32 reconnect_instance; /* incremented on each reconnect */
777 __le32 session_key_id; /* retrieved from negotiate response and send in session setup request */
778 struct session_key session_key;
779 unsigned long lstrp; /* when we got last response from this server */
780 unsigned long neg_start; /* when negotiate started (jiffies) */
781 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
782 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
783 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
784 char negflavor; /* NEGOTIATE response flavor */
785 /* extended security flavors that server supports */
786 bool sec_ntlmssp; /* supports NTLMSSP */
787 bool sec_kerberosu2u; /* supports U2U Kerberos */
788 bool sec_kerberos; /* supports plain Kerberos */
789 bool sec_mskerberos; /* supports legacy MS Kerberos */
790 bool sec_iakerb; /* supports pass-through auth for Kerberos (krb5 proxy) */
791 bool large_buf; /* is current buffer large? */
792 /* use SMBD connection instead of socket */
793 bool rdma;
794 /* point to the SMBD connection if RDMA is used instead of socket */
795 struct smbd_connection *smbd_conn;
796 struct delayed_work echo; /* echo ping workqueue job */
797 char *smallbuf; /* pointer to current "small" buffer */
798 char *bigbuf; /* pointer to current "big" buffer */
799 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
800 unsigned int pdu_size;
801 unsigned int total_read; /* total amount of data read in this pass */
802 atomic_t in_send; /* requests trying to send */
803 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
804 #ifdef CONFIG_CIFS_STATS2
805 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
806 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
807 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
808 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
809 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
810 #endif /* STATS2 */
811 unsigned int max_read;
812 unsigned int max_write;
813 unsigned int min_offload;
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 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
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 smbd_mr *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
1560 #define CIFS_CACHE_READ_FLG 1
1561 #define CIFS_CACHE_HANDLE_FLG 2
1562 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1563 #define CIFS_CACHE_WRITE_FLG 4
1564 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1565 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1566
1567 #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))
1568 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1569 #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))
1570
1571 /*
1572 * One of these for each file inode
1573 */
1574
1575 struct cifsInodeInfo {
1576 struct netfs_inode netfs; /* Netfslib context and vfs inode */
1577 bool can_cache_brlcks;
1578 struct list_head llist; /* locks helb by this inode */
1579 /*
1580 * NOTE: Some code paths call down_read(lock_sem) twice, so
1581 * we must always use cifs_down_write() instead of down_write()
1582 * for this semaphore to avoid deadlocks.
1583 */
1584 struct rw_semaphore lock_sem; /* protect the fields above */
1585 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1586 struct list_head openFileList;
1587 spinlock_t open_file_lock; /* protects openFileList */
1588 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1589 unsigned int oplock; /* oplock/lease level we have */
1590 __u16 epoch; /* used to track lease state changes */
1591 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1592 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1593 #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */
1594 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1595 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1596 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1597 #define CIFS_INO_CLOSE_ON_LOCK (7) /* Not to defer the close when lock is set */
1598 unsigned long flags;
1599 spinlock_t writers_lock;
1600 unsigned int writers; /* Number of writers on this inode */
1601 unsigned long time; /* jiffies of last update of inode */
1602 u64 uniqueid; /* server inode number */
1603 u64 createtime; /* creation time on server */
1604 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1605 struct list_head deferred_closes; /* list of deferred closes */
1606 spinlock_t deferred_lock; /* protection on deferred list */
1607 bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */
1608 char *symlink_target;
1609 __u32 reparse_tag;
1610 };
1611
1612 static inline struct cifsInodeInfo *
CIFS_I(struct inode * inode)1613 CIFS_I(struct inode *inode)
1614 {
1615 return container_of(inode, struct cifsInodeInfo, netfs.inode);
1616 }
1617
1618 static inline struct cifs_sb_info *
CIFS_SB(struct super_block * sb)1619 CIFS_SB(struct super_block *sb)
1620 {
1621 return sb->s_fs_info;
1622 }
1623
1624 static inline struct cifs_sb_info *
CIFS_FILE_SB(struct file * file)1625 CIFS_FILE_SB(struct file *file)
1626 {
1627 return CIFS_SB(file_inode(file)->i_sb);
1628 }
1629
CIFS_DIR_SEP(const struct cifs_sb_info * cifs_sb)1630 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1631 {
1632 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1633 return '/';
1634 else
1635 return '\\';
1636 }
1637
1638 static inline void
convert_delimiter(char * path,char delim)1639 convert_delimiter(char *path, char delim)
1640 {
1641 char old_delim, *pos;
1642
1643 if (delim == '/')
1644 old_delim = '\\';
1645 else
1646 old_delim = '/';
1647
1648 pos = path;
1649 while ((pos = strchr(pos, old_delim)))
1650 *pos = delim;
1651 }
1652
1653 #define cifs_stats_inc atomic_inc
1654
cifs_stats_bytes_written(struct cifs_tcon * tcon,unsigned int bytes)1655 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1656 unsigned int bytes)
1657 {
1658 if (bytes) {
1659 spin_lock(&tcon->stat_lock);
1660 tcon->bytes_written += bytes;
1661 spin_unlock(&tcon->stat_lock);
1662 }
1663 }
1664
cifs_stats_bytes_read(struct cifs_tcon * tcon,unsigned int bytes)1665 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1666 unsigned int bytes)
1667 {
1668 spin_lock(&tcon->stat_lock);
1669 tcon->bytes_read += bytes;
1670 spin_unlock(&tcon->stat_lock);
1671 }
1672
1673
1674 /*
1675 * This is the prototype for the mid receive function. This function is for
1676 * receiving the rest of the SMB frame, starting with the WordCount (which is
1677 * just after the MID in struct smb_hdr). Note:
1678 *
1679 * - This will be called by cifsd, with no locks held.
1680 * - The mid will still be on the pending_mid_q.
1681 * - mid->resp_buf will point to the current buffer.
1682 *
1683 * Returns zero on a successful receive, or an error. The receive state in
1684 * the TCP_Server_Info will also be updated.
1685 */
1686 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1687 struct mid_q_entry *mid);
1688
1689 /*
1690 * This is the prototype for the mid callback function. This is called once the
1691 * mid has been received off of the socket. When creating one, take special
1692 * care to avoid deadlocks. Things to bear in mind:
1693 *
1694 * - it will be called by cifsd, with no locks held
1695 * - the mid will be removed from any lists
1696 */
1697 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1698
1699 /*
1700 * This is the protopyte for mid handle function. This is called once the mid
1701 * has been recognized after decryption of the message.
1702 */
1703 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1704 struct mid_q_entry *mid);
1705
1706 /* one of these for every pending CIFS request to the server */
1707 struct mid_q_entry {
1708 struct list_head qhead; /* mids waiting on reply from this server */
1709 struct kref refcount;
1710 struct TCP_Server_Info *server; /* server corresponding to this mid */
1711 __u64 mid; /* multiplex id */
1712 __u16 credits; /* number of credits consumed by this mid */
1713 __u16 credits_received; /* number of credits from the response */
1714 __u32 pid; /* process id */
1715 __u32 sequence_number; /* for CIFS signing */
1716 unsigned long when_alloc; /* when mid was created */
1717 #ifdef CONFIG_CIFS_STATS2
1718 unsigned long when_sent; /* time when smb send finished */
1719 unsigned long when_received; /* when demux complete (taken off wire) */
1720 #endif
1721 mid_receive_t *receive; /* call receive callback */
1722 mid_callback_t *callback; /* call completion callback */
1723 mid_handle_t *handle; /* call handle mid callback */
1724 void *callback_data; /* general purpose pointer for callback */
1725 struct task_struct *creator;
1726 void *resp_buf; /* pointer to received SMB header */
1727 unsigned int resp_buf_size;
1728 int mid_state; /* wish this were enum but can not pass to wait_event */
1729 int mid_rc; /* rc for MID_RC */
1730 unsigned int mid_flags;
1731 __le16 command; /* smb command code */
1732 unsigned int optype; /* operation type */
1733 bool large_buf:1; /* if valid response, is pointer to large buf */
1734 bool multiRsp:1; /* multiple trans2 responses for one request */
1735 bool multiEnd:1; /* both received */
1736 bool decrypted:1; /* decrypted entry */
1737 };
1738
1739 struct close_cancelled_open {
1740 struct cifs_fid fid;
1741 struct cifs_tcon *tcon;
1742 struct work_struct work;
1743 __u64 mid;
1744 __u16 cmd;
1745 };
1746
1747 /* Make code in transport.c a little cleaner by moving
1748 update of optional stats into function below */
cifs_in_send_inc(struct TCP_Server_Info * server)1749 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1750 {
1751 atomic_inc(&server->in_send);
1752 }
1753
cifs_in_send_dec(struct TCP_Server_Info * server)1754 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1755 {
1756 atomic_dec(&server->in_send);
1757 }
1758
cifs_num_waiters_inc(struct TCP_Server_Info * server)1759 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1760 {
1761 atomic_inc(&server->num_waiters);
1762 }
1763
cifs_num_waiters_dec(struct TCP_Server_Info * server)1764 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1765 {
1766 atomic_dec(&server->num_waiters);
1767 }
1768
1769 #ifdef CONFIG_CIFS_STATS2
cifs_save_when_sent(struct mid_q_entry * mid)1770 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1771 {
1772 mid->when_sent = jiffies;
1773 }
1774 #else
cifs_save_when_sent(struct mid_q_entry * mid)1775 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1776 {
1777 }
1778 #endif
1779
1780 /* for pending dnotify requests */
1781 struct dir_notify_req {
1782 struct list_head lhead;
1783 __le16 Pid;
1784 __le16 PidHigh;
1785 __u16 Mid;
1786 __u16 Tid;
1787 __u16 Uid;
1788 __u16 netfid;
1789 __u32 filter; /* CompletionFilter (for multishot) */
1790 int multishot;
1791 struct file *pfile;
1792 };
1793
1794 struct dfs_info3_param {
1795 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1796 int path_consumed;
1797 int server_type;
1798 int ref_flag;
1799 char *path_name;
1800 char *node_name;
1801 int ttl;
1802 };
1803
1804 struct file_list {
1805 struct list_head list;
1806 struct cifsFileInfo *cfile;
1807 };
1808
1809 struct cifs_mount_ctx {
1810 struct cifs_sb_info *cifs_sb;
1811 struct smb3_fs_context *fs_ctx;
1812 unsigned int xid;
1813 struct TCP_Server_Info *server;
1814 struct cifs_ses *ses;
1815 struct cifs_tcon *tcon;
1816 };
1817
__free_dfs_info_param(struct dfs_info3_param * param)1818 static inline void __free_dfs_info_param(struct dfs_info3_param *param)
1819 {
1820 kfree(param->path_name);
1821 kfree(param->node_name);
1822 }
1823
free_dfs_info_param(struct dfs_info3_param * param)1824 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1825 {
1826 if (param)
1827 __free_dfs_info_param(param);
1828 }
1829
zfree_dfs_info_param(struct dfs_info3_param * param)1830 static inline void zfree_dfs_info_param(struct dfs_info3_param *param)
1831 {
1832 if (param) {
1833 __free_dfs_info_param(param);
1834 memset(param, 0, sizeof(*param));
1835 }
1836 }
1837
free_dfs_info_array(struct dfs_info3_param * param,int number_of_items)1838 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1839 int number_of_items)
1840 {
1841 int i;
1842
1843 if ((number_of_items == 0) || (param == NULL))
1844 return;
1845 for (i = 0; i < number_of_items; i++) {
1846 kfree(param[i].path_name);
1847 kfree(param[i].node_name);
1848 }
1849 kfree(param);
1850 }
1851
is_interrupt_error(int error)1852 static inline bool is_interrupt_error(int error)
1853 {
1854 switch (error) {
1855 case -EINTR:
1856 case -ERESTARTSYS:
1857 case -ERESTARTNOHAND:
1858 case -ERESTARTNOINTR:
1859 return true;
1860 }
1861 return false;
1862 }
1863
is_retryable_error(int error)1864 static inline bool is_retryable_error(int error)
1865 {
1866 if (is_interrupt_error(error) || error == -EAGAIN)
1867 return true;
1868 return false;
1869 }
1870
is_replayable_error(int error)1871 static inline bool is_replayable_error(int error)
1872 {
1873 if (error == -EAGAIN || error == -ECONNABORTED)
1874 return true;
1875 return false;
1876 }
1877
1878
1879 /* cifs_get_writable_file() flags */
1880 #define FIND_WR_ANY 0
1881 #define FIND_WR_FSUID_ONLY 1
1882 #define FIND_WR_WITH_DELETE 2
1883
1884 #define MID_FREE 0
1885 #define MID_REQUEST_ALLOCATED 1
1886 #define MID_REQUEST_SUBMITTED 2
1887 #define MID_RESPONSE_RECEIVED 4
1888 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1889 #define MID_RESPONSE_MALFORMED 0x10
1890 #define MID_SHUTDOWN 0x20
1891 #define MID_RESPONSE_READY 0x40 /* ready for other process handle the rsp */
1892 #define MID_RC 0x80 /* mid_rc contains custom rc */
1893
1894 /* Flags */
1895 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1896 #define MID_DELETED 2 /* Mid has been dequeued/deleted */
1897
1898 /* Types of response buffer returned from SendReceive2 */
1899 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1900 #define CIFS_SMALL_BUFFER 1
1901 #define CIFS_LARGE_BUFFER 2
1902 #define CIFS_IOVEC 4 /* array of response buffers */
1903
1904 /* Type of Request to SendReceive2 */
1905 #define CIFS_BLOCKING_OP 1 /* operation can block */
1906 #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
1907 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1908 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1909 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1910 #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
1911
1912 /* Type of request operation */
1913 #define CIFS_ECHO_OP 0x080 /* echo request */
1914 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1915 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1916 #define CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */
1917 /* Lower bitmask values are reserved by others below. */
1918 #define CIFS_SESS_OP 0x2000 /* session setup request */
1919 #define CIFS_OP_MASK 0x2780 /* mask request type */
1920
1921 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1922 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1923 #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
1924 #define CIFS_COMPRESS_REQ 0x4000 /* compress request before sending */
1925
1926 /* Security Flags: indicate type of session setup needed */
1927 #define CIFSSEC_MAY_SIGN 0x00001
1928 #define CIFSSEC_MAY_NTLMV2 0x00004
1929 #define CIFSSEC_MAY_KRB5 0x00008
1930 #define CIFSSEC_MAY_SEAL 0x00040
1931 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1932
1933 #define CIFSSEC_MUST_SIGN 0x01001
1934 /* note that only one of the following can be set so the
1935 result of setting MUST flags more than once will be to
1936 require use of the stronger protocol */
1937 #define CIFSSEC_MUST_NTLMV2 0x04004
1938 #define CIFSSEC_MUST_KRB5 0x08008
1939 #ifdef CONFIG_CIFS_UPCALL
1940 #define CIFSSEC_MASK 0xCF0CF /* flags supported if no weak allowed */
1941 #else
1942 #define CIFSSEC_MASK 0xC70C7 /* flags supported if no weak allowed */
1943 #endif /* UPCALL */
1944 #define CIFSSEC_MUST_SEAL 0x40040
1945 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1946
1947 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP | CIFSSEC_MAY_SEAL)
1948 #define CIFSSEC_MAX (CIFSSEC_MAY_SIGN | CIFSSEC_MUST_KRB5 | CIFSSEC_MAY_SEAL)
1949 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1950 /*
1951 *****************************************************************
1952 * All constants go here
1953 *****************************************************************
1954 */
1955
1956 #define UID_HASH (16)
1957
1958 /*
1959 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1960 * following to be declared.
1961 */
1962
1963 /****************************************************************************
1964 * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according
1965 * to the locking order. i.e. if two locks are to be held together, the lock that
1966 * appears higher in this list needs to be taken before the other.
1967 *
1968 * If you hold a lock that is lower in this list, and you need to take a higher lock
1969 * (or if you think that one of the functions that you're calling may need to), first
1970 * drop the lock you hold, pick up the higher lock, then the lower one. This will
1971 * ensure that locks are picked up only in one direction in the below table
1972 * (top to bottom).
1973 *
1974 * Also, if you expect a function to be called with a lock held, explicitly document
1975 * this in the comments on top of your function definition.
1976 *
1977 * And also, try to keep the critical sections (lock hold time) to be as minimal as
1978 * possible. Blocking / calling other functions with a lock held always increase
1979 * the risk of a possible deadlock.
1980 *
1981 * Following this rule will avoid unnecessary deadlocks, which can get really hard to
1982 * debug. Also, any new lock that you introduce, please add to this list in the correct
1983 * order.
1984 *
1985 * Please populate this list whenever you introduce new locks in your changes. Or in
1986 * case I've missed some existing locks. Please ensure that it's added in the list
1987 * based on the locking order expected.
1988 *
1989 * =====================================================================================
1990 * Lock Protects Initialization fn
1991 * =====================================================================================
1992 * vol_list_lock
1993 * vol_info->ctx_lock vol_info->ctx
1994 * cifs_sb_info->tlink_tree_lock cifs_sb_info->tlink_tree cifs_setup_cifs_sb
1995 * TCP_Server_Info-> TCP_Server_Info cifs_get_tcp_session
1996 * reconnect_mutex
1997 * TCP_Server_Info->srv_mutex TCP_Server_Info cifs_get_tcp_session
1998 * cifs_ses->session_mutex cifs_ses sesInfoAlloc
1999 * cifs_tcon->open_file_lock cifs_tcon->openFileList tconInfoAlloc
2000 * cifs_tcon->pending_opens
2001 * cifs_tcon->stat_lock cifs_tcon->bytes_read tconInfoAlloc
2002 * cifs_tcon->bytes_written
2003 * cifs_tcp_ses_lock cifs_tcp_ses_list sesInfoAlloc
2004 * GlobalMid_Lock GlobalMaxActiveXid init_cifs
2005 * GlobalCurrentXid
2006 * GlobalTotalActiveXid
2007 * TCP_Server_Info->srv_lock (anything in struct not protected by another lock and can change)
2008 * TCP_Server_Info->mid_lock TCP_Server_Info->pending_mid_q cifs_get_tcp_session
2009 * ->CurrentMid
2010 * (any changes in mid_q_entry fields)
2011 * TCP_Server_Info->req_lock TCP_Server_Info->in_flight cifs_get_tcp_session
2012 * ->credits
2013 * ->echo_credits
2014 * ->oplock_credits
2015 * ->reconnect_instance
2016 * cifs_ses->ses_lock (anything that is not protected by another lock and can change)
2017 * sesInfoAlloc
2018 * cifs_ses->iface_lock cifs_ses->iface_list sesInfoAlloc
2019 * ->iface_count
2020 * ->iface_last_update
2021 * cifs_ses->chan_lock cifs_ses->chans sesInfoAlloc
2022 * ->chans_need_reconnect
2023 * ->chans_in_reconnect
2024 * cifs_tcon->tc_lock (anything that is not protected by another lock and can change)
2025 * tcon_info_alloc
2026 * inode->i_rwsem, taken by fs/netfs/locking.c e.g. should be taken before cifsInodeInfo locks
2027 * cifsInodeInfo->open_file_lock cifsInodeInfo->openFileList cifs_alloc_inode
2028 * cifsInodeInfo->writers_lock cifsInodeInfo->writers cifsInodeInfo_alloc
2029 * cifsInodeInfo->lock_sem cifsInodeInfo->llist cifs_init_once
2030 * ->can_cache_brlcks
2031 * cifsInodeInfo->deferred_lock cifsInodeInfo->deferred_closes cifsInodeInfo_alloc
2032 * cached_fids->cfid_list_lock cifs_tcon->cfids->entries init_cached_dirs
2033 * cached_fid->fid_lock (anything that is not protected by another lock and can change)
2034 * init_cached_dir
2035 * cifsFileInfo->fh_mutex cifsFileInfo cifs_new_fileinfo
2036 * cifsFileInfo->file_info_lock cifsFileInfo->count cifs_new_fileinfo
2037 * ->invalidHandle initiate_cifs_search
2038 * ->oplock_break_cancelled
2039 ****************************************************************************/
2040
2041 #ifdef DECLARE_GLOBALS_HERE
2042 #define GLOBAL_EXTERN
2043 #else
2044 #define GLOBAL_EXTERN extern
2045 #endif
2046
2047 /*
2048 * the list of TCP_Server_Info structures, ie each of the sockets
2049 * connecting our client to a distinct server (ip address), is
2050 * chained together by cifs_tcp_ses_list. The list of all our SMB
2051 * sessions (and from that the tree connections) can be found
2052 * by iterating over cifs_tcp_ses_list
2053 */
2054 extern struct list_head cifs_tcp_ses_list;
2055
2056 /*
2057 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
2058 * tcp session, and the list of tcon's per smb session. It also protects
2059 * the reference counters for the server, smb session, and tcon.
2060 * generally the locks should be taken in order tcp_ses_lock before
2061 * tcon->open_file_lock and that before file->file_info_lock since the
2062 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
2063 */
2064 extern spinlock_t cifs_tcp_ses_lock;
2065
2066 /*
2067 * Global transaction id (XID) information
2068 */
2069 extern unsigned int GlobalCurrentXid; /* protected by GlobalMid_Lock */
2070 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Lock */
2071 extern unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Lock */
2072 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */
2073
2074 /*
2075 * Global counters, updated atomically
2076 */
2077 extern atomic_t sesInfoAllocCount;
2078 extern atomic_t tconInfoAllocCount;
2079 extern atomic_t tcpSesNextId;
2080 extern atomic_t tcpSesAllocCount;
2081 extern atomic_t tcpSesReconnectCount;
2082 extern atomic_t tconInfoReconnectCount;
2083
2084 /* Various Debug counters */
2085 extern atomic_t buf_alloc_count; /* current number allocated */
2086 extern atomic_t small_buf_alloc_count;
2087 #ifdef CONFIG_CIFS_STATS2
2088 extern atomic_t total_buf_alloc_count; /* total allocated over all time */
2089 extern atomic_t total_small_buf_alloc_count;
2090 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
2091 #endif
2092
2093 /* Misc globals */
2094 extern bool enable_oplocks; /* enable or disable oplocks */
2095 extern bool lookupCacheEnabled;
2096 extern unsigned int global_secflags; /* if on, session setup sent
2097 with more secure ntlmssp2 challenge/resp */
2098 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
2099 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
2100 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
2101 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */
2102 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
2103 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
2104 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
2105 extern unsigned int cifs_min_small; /* min size of small buf pool */
2106 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
2107 extern unsigned int dir_cache_timeout; /* max time for directory lease caching of dir */
2108 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
2109 extern atomic_t mid_count;
2110
2111 void cifs_oplock_break(struct work_struct *work);
2112 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
2113 void smb2_deferred_work_close(struct work_struct *work);
2114
2115 extern const struct slow_work_ops cifs_oplock_break_ops;
2116 extern struct workqueue_struct *cifsiod_wq;
2117 extern struct workqueue_struct *decrypt_wq;
2118 extern struct workqueue_struct *fileinfo_put_wq;
2119 extern struct workqueue_struct *cifsoplockd_wq;
2120 extern struct workqueue_struct *deferredclose_wq;
2121 extern struct workqueue_struct *serverclose_wq;
2122 extern struct workqueue_struct *cfid_put_wq;
2123 extern __u32 cifs_lock_secret;
2124
2125 extern mempool_t *cifs_sm_req_poolp;
2126 extern mempool_t *cifs_req_poolp;
2127 extern mempool_t *cifs_mid_poolp;
2128 extern mempool_t cifs_io_request_pool;
2129 extern mempool_t cifs_io_subrequest_pool;
2130
2131 /* Operations for different SMB versions */
2132 #define SMB1_VERSION_STRING "1.0"
2133 #define SMB20_VERSION_STRING "2.0"
2134 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY
2135 extern struct smb_version_operations smb1_operations;
2136 extern struct smb_version_values smb1_values;
2137 extern struct smb_version_operations smb20_operations;
2138 extern struct smb_version_values smb20_values;
2139 #endif /* CIFS_ALLOW_INSECURE_LEGACY */
2140 #define SMB21_VERSION_STRING "2.1"
2141 extern struct smb_version_operations smb21_operations;
2142 extern struct smb_version_values smb21_values;
2143 #define SMBDEFAULT_VERSION_STRING "default"
2144 extern struct smb_version_values smbdefault_values;
2145 #define SMB3ANY_VERSION_STRING "3"
2146 extern struct smb_version_values smb3any_values;
2147 #define SMB30_VERSION_STRING "3.0"
2148 extern struct smb_version_operations smb30_operations;
2149 extern struct smb_version_values smb30_values;
2150 #define SMB302_VERSION_STRING "3.02"
2151 #define ALT_SMB302_VERSION_STRING "3.0.2"
2152 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2153 extern struct smb_version_values smb302_values;
2154 #define SMB311_VERSION_STRING "3.1.1"
2155 #define ALT_SMB311_VERSION_STRING "3.11"
2156 extern struct smb_version_operations smb311_operations;
2157 extern struct smb_version_values smb311_values;
2158
get_security_type_str(enum securityEnum sectype)2159 static inline char *get_security_type_str(enum securityEnum sectype)
2160 {
2161 switch (sectype) {
2162 case RawNTLMSSP:
2163 return "RawNTLMSSP";
2164 case Kerberos:
2165 return "Kerberos";
2166 case NTLMv2:
2167 return "NTLMv2";
2168 case IAKerb:
2169 return "IAKerb";
2170 default:
2171 return "Unknown";
2172 }
2173 }
2174
is_smb1_server(struct TCP_Server_Info * server)2175 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2176 {
2177 return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2178 }
2179
is_tcon_dfs(struct cifs_tcon * tcon)2180 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2181 {
2182 /*
2183 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2184 * Subsystem Notifies That a Share Is a DFS Share.
2185 *
2186 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2187 * Application Updates a Share.
2188 */
2189 if (!tcon || !tcon->ses || !tcon->ses->server)
2190 return false;
2191 return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2192 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2193 }
2194
cifs_is_referral_server(struct cifs_tcon * tcon,const struct dfs_info3_param * ref)2195 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon,
2196 const struct dfs_info3_param *ref)
2197 {
2198 /*
2199 * Check if all targets are capable of handling DFS referrals as per
2200 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL.
2201 */
2202 return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER));
2203 }
2204
cifs_flock_len(const struct file_lock * fl)2205 static inline u64 cifs_flock_len(const struct file_lock *fl)
2206 {
2207 return (u64)fl->fl_end - fl->fl_start + 1;
2208 }
2209
ntlmssp_workstation_name_size(const struct cifs_ses * ses)2210 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses)
2211 {
2212 if (WARN_ON_ONCE(!ses || !ses->server))
2213 return 0;
2214 /*
2215 * Make workstation name no more than 15 chars when using insecure dialects as some legacy
2216 * servers do require it during NTLMSSP.
2217 */
2218 if (ses->server->dialect <= SMB20_PROT_ID)
2219 return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL);
2220 return sizeof(ses->workstation_name);
2221 }
2222
move_cifs_info_to_smb2(struct smb2_file_all_info * dst,const FILE_ALL_INFO * src)2223 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src)
2224 {
2225 memcpy(dst, src, (size_t)((u8 *)&src->EASize - (u8 *)src));
2226 dst->IndexNumber = 0;
2227 dst->EASize = src->EASize;
2228 dst->AccessFlags = 0;
2229 dst->CurrentByteOffset = 0;
2230 dst->Mode = 0;
2231 dst->AlignmentRequirement = 0;
2232 dst->FileNameLength = src->FileNameLength;
2233 }
2234
cifs_get_num_sgs(const struct smb_rqst * rqst,int num_rqst,const u8 * sig)2235 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst,
2236 int num_rqst,
2237 const u8 *sig)
2238 {
2239 unsigned int len, skip;
2240 unsigned int nents = 0;
2241 unsigned long addr;
2242 size_t data_size;
2243 int i, j;
2244
2245 /*
2246 * The first rqst has a transform header where the first 20 bytes are
2247 * not part of the encrypted blob.
2248 */
2249 skip = 20;
2250
2251 /* Assumes the first rqst has a transform header as the first iov.
2252 * I.e.
2253 * rqst[0].rq_iov[0] is transform header
2254 * rqst[0].rq_iov[1+] data to be encrypted/decrypted
2255 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted
2256 */
2257 for (i = 0; i < num_rqst; i++) {
2258 data_size = iov_iter_count(&rqst[i].rq_iter);
2259
2260 /* We really don't want a mixture of pinned and unpinned pages
2261 * in the sglist. It's hard to keep track of which is what.
2262 * Instead, we convert to a BVEC-type iterator higher up.
2263 */
2264 if (data_size &&
2265 WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter)))
2266 return -EIO;
2267
2268 /* We also don't want to have any extra refs or pins to clean
2269 * up in the sglist.
2270 */
2271 if (data_size &&
2272 WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter)))
2273 return -EIO;
2274
2275 for (j = 0; j < rqst[i].rq_nvec; j++) {
2276 struct kvec *iov = &rqst[i].rq_iov[j];
2277
2278 addr = (unsigned long)iov->iov_base + skip;
2279 if (is_vmalloc_or_module_addr((void *)addr)) {
2280 len = iov->iov_len - skip;
2281 nents += DIV_ROUND_UP(offset_in_page(addr) + len,
2282 PAGE_SIZE);
2283 } else {
2284 nents++;
2285 }
2286 skip = 0;
2287 }
2288 if (data_size)
2289 nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX);
2290 }
2291 nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE);
2292 return nents;
2293 }
2294
2295 /* We can not use the normal sg_set_buf() as we will sometimes pass a
2296 * stack object as buf.
2297 */
cifs_sg_set_buf(struct sg_table * sgtable,const void * buf,unsigned int buflen)2298 static inline void cifs_sg_set_buf(struct sg_table *sgtable,
2299 const void *buf,
2300 unsigned int buflen)
2301 {
2302 unsigned long addr = (unsigned long)buf;
2303 unsigned int off = offset_in_page(addr);
2304
2305 addr &= PAGE_MASK;
2306 if (is_vmalloc_or_module_addr((void *)addr)) {
2307 do {
2308 unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off);
2309
2310 sg_set_page(&sgtable->sgl[sgtable->nents++],
2311 vmalloc_to_page((void *)addr), len, off);
2312
2313 off = 0;
2314 addr += PAGE_SIZE;
2315 buflen -= len;
2316 } while (buflen);
2317 } else {
2318 sg_set_page(&sgtable->sgl[sgtable->nents++],
2319 virt_to_page((void *)addr), buflen, off);
2320 }
2321 }
2322
2323 #define CIFS_OPARMS(_cifs_sb, _tcon, _path, _da, _cd, _co, _mode) \
2324 ((struct cifs_open_parms) { \
2325 .tcon = _tcon, \
2326 .path = _path, \
2327 .desired_access = (_da), \
2328 .disposition = (_cd), \
2329 .create_options = cifs_create_options(_cifs_sb, (_co)), \
2330 .mode = (_mode), \
2331 .cifs_sb = _cifs_sb, \
2332 })
2333
2334 struct smb2_compound_vars {
2335 struct cifs_open_parms oparms;
2336 struct kvec rsp_iov[MAX_COMPOUND];
2337 struct smb_rqst rqst[MAX_COMPOUND];
2338 struct kvec open_iov[SMB2_CREATE_IOV_SIZE];
2339 struct kvec qi_iov;
2340 struct kvec io_iov[SMB2_IOCTL_IOV_SIZE];
2341 struct kvec si_iov[SMB2_SET_INFO_IOV_SIZE];
2342 struct kvec close_iov;
2343 struct smb2_file_rename_info_hdr rename_info;
2344 struct smb2_file_link_info_hdr link_info;
2345 struct kvec ea_iov;
2346 };
2347
cifs_ses_exiting(struct cifs_ses * ses)2348 static inline bool cifs_ses_exiting(struct cifs_ses *ses)
2349 {
2350 bool ret;
2351
2352 spin_lock(&ses->ses_lock);
2353 ret = ses->ses_status == SES_EXITING;
2354 spin_unlock(&ses->ses_lock);
2355 return ret;
2356 }
2357
cifs_netbios_name(const char * name,size_t namelen)2358 static inline bool cifs_netbios_name(const char *name, size_t namelen)
2359 {
2360 bool ret = false;
2361 size_t i;
2362
2363 if (namelen >= 1 && namelen <= RFC1001_NAME_LEN) {
2364 for (i = 0; i < namelen; i++) {
2365 const unsigned char c = name[i];
2366
2367 if (c == '\\' || c == '/' || c == ':' || c == '*' ||
2368 c == '?' || c == '"' || c == '<' || c == '>' ||
2369 c == '|' || c == '.')
2370 return false;
2371 if (!ret && isalpha(c))
2372 ret = true;
2373 }
2374 }
2375 return ret;
2376 }
2377
2378 #endif /* _CIFS_GLOB_H */
2379