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