blob: 9c0e348cb00f7f4e29d23c965921d84d255464f6 [file] [log] [blame]
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001/*
2 * fs/cifs/cifsglob.h
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 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
17 *
18 */
19#ifndef _CIFS_GLOB_H
20#define _CIFS_GLOB_H
21
22#include <linux/in.h>
23#include <linux/in6.h>
24#include <linux/slab.h>
25#include <linux/mempool.h>
26#include <linux/workqueue.h>
27#include "cifs_fs_sb.h"
28#include "cifsacl.h"
29#include <crypto/internal/hash.h>
30#include <linux/scatterlist.h>
31#include <uapi/linux/cifs/cifs_mount.h>
32#include "smb2pdu.h"
33
34#define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */
35
David Brazdil0f672f62019-12-10 10:32:29 +000036#define SMB_PATH_MAX 260
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000037#define CIFS_PORT 445
38#define RFC1001_PORT 139
39
40/*
41 * The sizes of various internal tables and strings
42 */
43#define MAX_UID_INFO 16
44#define MAX_SES_INFO 2
45#define MAX_TCON_INFO 4
46
47#define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
48
49#define CIFS_MIN_RCV_POOL 4
50
51#define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
52/*
53 * default attribute cache timeout (jiffies)
54 */
55#define CIFS_DEF_ACTIMEO (1 * HZ)
56
57/*
58 * max attribute cache timeout (jiffies) - 2^30
59 */
60#define CIFS_MAX_ACTIMEO (1 << 30)
61
62/*
David Brazdil0f672f62019-12-10 10:32:29 +000063 * 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/*
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000069 * 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/* maximum number of PDUs in one compound */
87#define MAX_COMPOUND 5
88
89/*
90 * Default number of credits to keep available for SMB3.
91 * This value is chosen somewhat arbitrarily. The Windows client
92 * defaults to 128 credits, the Windows server allows clients up to
93 * 512 credits (or 8K for later versions), and the NetApp server
94 * does not limit clients at all. Choose a high enough default value
95 * such that the client shouldn't limit performance, but allow mount
96 * to override (until you approach 64K, where we limit credits to 65000
97 * to reduce possibility of seeing more server credit overflow bugs.
98 */
99#define SMB2_MAX_CREDITS_AVAILABLE 32000
100
101#include "cifspdu.h"
102
103#ifndef XATTR_DOS_ATTRIB
104#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
105#endif
106
107/*
108 * CIFS vfs client Status information (based on what we know.)
109 */
110
111/* associated with each tcp and smb session */
112enum statusEnum {
113 CifsNew = 0,
114 CifsGood,
115 CifsExiting,
116 CifsNeedReconnect,
117 CifsNeedNegotiate
118};
119
120enum securityEnum {
121 Unspecified = 0, /* not specified */
122 LANMAN, /* Legacy LANMAN auth */
123 NTLM, /* Legacy NTLM012 auth with NTLM hash */
124 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
125 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
126 Kerberos, /* Kerberos via SPNEGO */
127};
128
129struct session_key {
130 unsigned int len;
131 char *response;
132};
133
134/* crypto security descriptor definition */
135struct sdesc {
136 struct shash_desc shash;
137 char ctx[];
138};
139
140/* crypto hashing related structure/fields, not specific to a sec mech */
141struct cifs_secmech {
142 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
143 struct crypto_shash *md5; /* md5 hash function */
144 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
145 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
146 struct crypto_shash *sha512; /* sha512 hash function */
147 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
148 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
149 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
150 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
151 struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */
152 struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */
153 struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */
154};
155
156/* per smb session structure/fields */
157struct ntlmssp_auth {
158 bool sesskey_per_smbsess; /* whether session key is per smb session */
159 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
160 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
161 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
162 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
163};
164
165struct cifs_cred {
166 int uid;
167 int gid;
168 int mode;
169 int cecount;
170 struct cifs_sid osid;
171 struct cifs_sid gsid;
172 struct cifs_ntace *ntaces;
173 struct cifs_ace *aces;
174};
175
176/*
177 *****************************************************************
178 * Except the CIFS PDUs themselves all the
179 * globally interesting structs should go here
180 *****************************************************************
181 */
182
183/*
184 * A smb_rqst represents a complete request to be issued to a server. It's
185 * formed by a kvec array, followed by an array of pages. Page data is assumed
186 * to start at the beginning of the first page.
187 */
188struct smb_rqst {
189 struct kvec *rq_iov; /* array of kvecs */
190 unsigned int rq_nvec; /* number of kvecs in array */
191 struct page **rq_pages; /* pointer to array of page ptrs */
192 unsigned int rq_offset; /* the offset to the 1st page */
193 unsigned int rq_npages; /* number pages in array */
194 unsigned int rq_pagesz; /* page size to use */
195 unsigned int rq_tailsz; /* length of last page */
196};
197
198enum smb_version {
199 Smb_1 = 1,
200 Smb_20,
201 Smb_21,
202 Smb_30,
203 Smb_302,
204 Smb_311,
205 Smb_3any,
206 Smb_default,
207 Smb_version_err
208};
209
210struct mid_q_entry;
211struct TCP_Server_Info;
212struct cifsFileInfo;
213struct cifs_ses;
214struct cifs_tcon;
215struct dfs_info3_param;
216struct cifs_fattr;
217struct smb_vol;
218struct cifs_fid;
219struct cifs_readdata;
220struct cifs_writedata;
221struct cifs_io_parms;
222struct cifs_search_info;
223struct cifsInodeInfo;
224struct cifs_open_parms;
David Brazdil0f672f62019-12-10 10:32:29 +0000225struct cifs_credits;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000226
227struct smb_version_operations {
228 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
229 struct mid_q_entry *);
230 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
231 /* setup request: allocate mid, sign message */
232 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
233 struct smb_rqst *);
234 /* setup async request: allocate mid, sign message */
235 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
236 struct smb_rqst *);
237 /* check response: verify signature, map error */
238 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
239 bool);
David Brazdil0f672f62019-12-10 10:32:29 +0000240 void (*add_credits)(struct TCP_Server_Info *server,
241 const struct cifs_credits *credits,
242 const int optype);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000243 void (*set_credits)(struct TCP_Server_Info *, const int);
244 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
245 unsigned int (*get_credits)(struct mid_q_entry *);
246 __u64 (*get_next_mid)(struct TCP_Server_Info *);
David Brazdil0f672f62019-12-10 10:32:29 +0000247 void (*revert_current_mid)(struct TCP_Server_Info *server,
248 const unsigned int val);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000249 /* data offset from read response message */
250 unsigned int (*read_data_offset)(char *);
251 /*
252 * Data length from read response message
253 * When in_remaining is true, the returned data length is in
254 * message field DataRemaining for out-of-band data read (e.g through
255 * Memory Registration RDMA write in SMBD).
256 * Otherwise, the returned data length is in message field DataLength.
257 */
258 unsigned int (*read_data_length)(char *, bool in_remaining);
259 /* map smb to linux error */
260 int (*map_error)(char *, bool);
261 /* find mid corresponding to the response message */
262 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
263 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
264 void (*clear_stats)(struct cifs_tcon *);
265 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
266 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
267 /* verify the message */
268 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
269 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
270 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
Olivier Deprez0e641232021-09-23 10:07:05 +0200271 void (*downgrade_oplock)(struct TCP_Server_Info *server,
272 struct cifsInodeInfo *cinode, __u32 oplock,
273 unsigned int epoch, bool *purge_cache);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000274 /* process transaction2 response */
275 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
276 char *, int);
277 /* check if we need to negotiate */
278 bool (*need_neg)(struct TCP_Server_Info *);
279 /* negotiate to the server */
280 int (*negotiate)(const unsigned int, struct cifs_ses *);
281 /* set negotiated write size */
282 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
283 /* set negotiated read size */
284 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
285 /* setup smb sessionn */
286 int (*sess_setup)(const unsigned int, struct cifs_ses *,
287 const struct nls_table *);
288 /* close smb session */
289 int (*logoff)(const unsigned int, struct cifs_ses *);
290 /* connect to a server share */
291 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
292 struct cifs_tcon *, const struct nls_table *);
293 /* close tree connecion */
294 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
295 /* get DFS referrals */
296 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
297 const char *, struct dfs_info3_param **,
298 unsigned int *, const struct nls_table *, int);
299 /* informational QFS call */
300 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
301 /* check if a path is accessible or not */
302 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
303 struct cifs_sb_info *, const char *);
304 /* query path data from the server */
305 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
306 struct cifs_sb_info *, const char *,
307 FILE_ALL_INFO *, bool *, bool *);
308 /* query file data from the server */
309 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
310 struct cifs_fid *, FILE_ALL_INFO *);
311 /* get server index number */
312 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
313 struct cifs_sb_info *, const char *,
314 u64 *uniqueid, FILE_ALL_INFO *);
315 /* set size by path */
316 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
317 const char *, __u64, struct cifs_sb_info *, bool);
318 /* set size by file handle */
319 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
320 struct cifsFileInfo *, __u64, bool);
321 /* set attributes */
322 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
323 const unsigned int);
324 int (*set_compression)(const unsigned int, struct cifs_tcon *,
325 struct cifsFileInfo *);
326 /* check if we can send an echo or nor */
327 bool (*can_echo)(struct TCP_Server_Info *);
328 /* send echo request */
329 int (*echo)(struct TCP_Server_Info *);
330 /* create directory */
331 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
332 umode_t mode, struct cifs_tcon *tcon,
333 const char *full_path,
334 struct cifs_sb_info *cifs_sb);
David Brazdil0f672f62019-12-10 10:32:29 +0000335 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
336 struct cifs_tcon *tcon, const char *name,
337 struct cifs_sb_info *sb);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000338 /* set info on created directory */
339 void (*mkdir_setinfo)(struct inode *, const char *,
340 struct cifs_sb_info *, struct cifs_tcon *,
341 const unsigned int);
342 /* remove directory */
343 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
344 struct cifs_sb_info *);
345 /* unlink file */
346 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
347 struct cifs_sb_info *);
348 /* open, rename and delete file */
349 int (*rename_pending_delete)(const char *, struct dentry *,
350 const unsigned int);
351 /* send rename request */
352 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
353 const char *, struct cifs_sb_info *);
354 /* send create hardlink request */
355 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
356 const char *, const char *,
357 struct cifs_sb_info *);
358 /* query symlink target */
359 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
David Brazdil0f672f62019-12-10 10:32:29 +0000360 struct cifs_sb_info *, const char *,
361 char **, bool);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000362 /* open a file for non-posix mounts */
363 int (*open)(const unsigned int, struct cifs_open_parms *,
364 __u32 *, FILE_ALL_INFO *);
365 /* set fid protocol-specific info */
366 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
367 /* close a file */
368 void (*close)(const unsigned int, struct cifs_tcon *,
369 struct cifs_fid *);
370 /* send a flush request to the server */
371 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
372 /* async read from the server */
373 int (*async_readv)(struct cifs_readdata *);
374 /* async write to the server */
375 int (*async_writev)(struct cifs_writedata *,
376 void (*release)(struct kref *));
377 /* sync read from the server */
378 int (*sync_read)(const unsigned int, struct cifs_fid *,
379 struct cifs_io_parms *, unsigned int *, char **,
380 int *);
381 /* sync write to the server */
382 int (*sync_write)(const unsigned int, struct cifs_fid *,
383 struct cifs_io_parms *, unsigned int *, struct kvec *,
384 unsigned long);
385 /* open dir, start readdir */
386 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
387 const char *, struct cifs_sb_info *,
388 struct cifs_fid *, __u16,
389 struct cifs_search_info *);
390 /* continue readdir */
391 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
392 struct cifs_fid *,
393 __u16, struct cifs_search_info *srch_inf);
394 /* close dir */
395 int (*close_dir)(const unsigned int, struct cifs_tcon *,
396 struct cifs_fid *);
397 /* calculate a size of SMB message */
398 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
David Brazdil0f672f62019-12-10 10:32:29 +0000399 /* check for STATUS_PENDING and process the response if yes */
400 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000401 /* check for STATUS_NETWORK_SESSION_EXPIRED */
402 bool (*is_session_expired)(char *);
403 /* send oplock break response */
404 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
405 struct cifsInodeInfo *);
406 /* query remote filesystem */
407 int (*queryfs)(const unsigned int, struct cifs_tcon *,
408 struct kstatfs *);
409 /* send mandatory brlock to the server */
410 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
411 __u64, __u32, int, int, bool);
412 /* unlock range of mandatory locks */
413 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
414 const unsigned int);
415 /* push brlocks from the cache to the server */
416 int (*push_mand_locks)(struct cifsFileInfo *);
417 /* get lease key of the inode */
418 void (*get_lease_key)(struct inode *, struct cifs_fid *);
419 /* set lease key of the inode */
420 void (*set_lease_key)(struct inode *, struct cifs_fid *);
421 /* generate new lease key */
422 void (*new_lease_key)(struct cifs_fid *);
423 int (*generate_signingkey)(struct cifs_ses *);
424 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
425 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
426 struct cifsFileInfo *src_file);
427 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
428 struct cifsFileInfo *src_file, void __user *);
429 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
430 struct cifs_sb_info *, const unsigned char *,
431 char *, unsigned int *);
432 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
433 struct cifs_sb_info *, const unsigned char *,
434 char *, unsigned int *);
435 /* if we can do cache read operations */
436 bool (*is_read_op)(__u32);
437 /* set oplock level for the inode */
438 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
439 bool *);
440 /* create lease context buffer for CREATE request */
441 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
442 /* parse lease context buffer and return oplock/epoch info */
443 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
444 ssize_t (*copychunk_range)(const unsigned int,
445 struct cifsFileInfo *src_file,
446 struct cifsFileInfo *target_file,
447 u64 src_off, u64 len, u64 dest_off);
448 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
449 struct cifsFileInfo *target_file, u64 src_off, u64 len,
450 u64 dest_off);
451 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
452 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
453 const unsigned char *, const unsigned char *, char *,
454 size_t, struct cifs_sb_info *);
455 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
456 const char *, const void *, const __u16,
457 const struct nls_table *, struct cifs_sb_info *);
458 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
459 const char *, u32 *);
460 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
461 const struct cifs_fid *, u32 *);
462 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
463 int);
464 /* writepages retry size */
465 unsigned int (*wp_retry_size)(struct inode *);
466 /* get mtu credits */
467 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
David Brazdil0f672f62019-12-10 10:32:29 +0000468 unsigned int *, struct cifs_credits *);
469 /* adjust previously taken mtu credits to request size */
470 int (*adjust_credits)(struct TCP_Server_Info *server,
471 struct cifs_credits *credits,
472 const unsigned int payload_size);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000473 /* check if we need to issue closedir */
474 bool (*dir_needs_close)(struct cifsFileInfo *);
475 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
476 loff_t);
477 /* init transform request - used for encryption for now */
478 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
479 struct smb_rqst *, struct smb_rqst *);
480 int (*is_transform_hdr)(void *buf);
481 int (*receive_transform)(struct TCP_Server_Info *,
482 struct mid_q_entry **, char **, int *);
483 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
484 enum securityEnum);
485 int (*next_header)(char *);
David Brazdil0f672f62019-12-10 10:32:29 +0000486 /* ioctl passthrough for query_info */
487 int (*ioctl_query_info)(const unsigned int xid,
488 struct cifs_tcon *tcon,
489 __le16 *path, int is_dir,
490 unsigned long p);
491 /* make unix special files (block, char, fifo, socket) */
492 int (*make_node)(unsigned int xid,
493 struct inode *inode,
494 struct dentry *dentry,
495 struct cifs_tcon *tcon,
496 char *full_path,
497 umode_t mode,
498 dev_t device_number);
499 /* version specific fiemap implementation */
500 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
501 struct fiemap_extent_info *, u64, u64);
502 /* version specific llseek implementation */
503 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000504};
505
506struct smb_version_values {
507 char *version_string;
508 __u16 protocol_id;
509 __u32 req_capabilities;
510 __u32 large_lock_type;
511 __u32 exclusive_lock_type;
512 __u32 shared_lock_type;
513 __u32 unlock_lock_type;
514 size_t header_preamble_size;
515 size_t header_size;
516 size_t max_header_size;
517 size_t read_rsp_size;
518 __le16 lock_cmd;
519 unsigned int cap_unix;
520 unsigned int cap_nt_find;
521 unsigned int cap_large_files;
522 __u16 signing_enabled;
523 __u16 signing_required;
524 size_t create_lease_size;
525};
526
527#define HEADER_SIZE(server) (server->vals->header_size)
528#define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
529
530struct smb_vol {
531 char *username;
532 char *password;
533 char *domainname;
534 char *UNC;
535 char *iocharset; /* local code page for mapping to and from Unicode */
536 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
537 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
538 kuid_t cred_uid;
539 kuid_t linux_uid;
540 kgid_t linux_gid;
541 kuid_t backupuid;
542 kgid_t backupgid;
543 umode_t file_mode;
544 umode_t dir_mode;
545 enum securityEnum sectype; /* sectype requested via mnt opts */
546 bool sign; /* was signing requested via mnt opts? */
David Brazdil0f672f62019-12-10 10:32:29 +0000547 bool ignore_signature:1;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000548 bool retry:1;
549 bool intr:1;
550 bool setuids:1;
551 bool setuidfromacl:1;
552 bool override_uid:1;
553 bool override_gid:1;
554 bool dynperm:1;
555 bool noperm:1;
David Brazdil0f672f62019-12-10 10:32:29 +0000556 bool mode_ace:1;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000557 bool no_psx_acl:1; /* set if posix acl support should be disabled */
558 bool cifs_acl:1;
559 bool backupuid_specified; /* mount option backupuid is specified */
560 bool backupgid_specified; /* mount option backupgid is specified */
561 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
562 bool server_ino:1; /* use inode numbers from server ie UniqueId */
563 bool direct_io:1;
564 bool strict_io:1; /* strict cache behavior */
David Brazdil0f672f62019-12-10 10:32:29 +0000565 bool cache_ro:1;
566 bool cache_rw:1;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000567 bool remap:1; /* set to remap seven reserved chars in filenames */
568 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
569 bool posix_paths:1; /* unset to not ask for posix pathnames. */
570 bool no_linux_ext:1;
571 bool linux_ext:1;
572 bool sfu_emul:1;
573 bool nullauth:1; /* attempt to authenticate with null user */
574 bool nocase:1; /* request case insensitive filenames */
575 bool nobrl:1; /* disable sending byte range locks to srv */
576 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
577 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
578 bool seal:1; /* request transport encryption on share */
579 bool nodfs:1; /* Do not request DFS, even if available */
580 bool local_lease:1; /* check leases only on local system, not remote */
581 bool noblocksnd:1;
582 bool noautotune:1;
583 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
David Brazdil0f672f62019-12-10 10:32:29 +0000584 bool no_lease:1; /* disable requesting leases */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000585 bool fsc:1; /* enable fscache */
586 bool mfsymlinks:1; /* use Minshall+French Symlinks */
587 bool multiuser:1;
588 bool rwpidforward:1; /* pid forward for read/write operations */
589 bool nosharesock:1;
590 bool persistent:1;
591 bool nopersistent:1;
592 bool resilient:1; /* noresilient not required since not fored for CA */
593 bool domainauto:1;
594 bool rdma:1;
David Brazdil0f672f62019-12-10 10:32:29 +0000595 unsigned int bsize;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000596 unsigned int rsize;
597 unsigned int wsize;
David Brazdil0f672f62019-12-10 10:32:29 +0000598 unsigned int min_offload;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000599 bool sockopt_tcp_nodelay:1;
600 unsigned long actimeo; /* attribute cache timeout (jiffies) */
601 struct smb_version_operations *ops;
602 struct smb_version_values *vals;
603 char *prepath;
604 struct sockaddr_storage dstaddr; /* destination address */
605 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
606 struct nls_table *local_nls;
607 unsigned int echo_interval; /* echo interval in secs */
608 __u64 snapshot_time; /* needed for timewarp tokens */
David Brazdil0f672f62019-12-10 10:32:29 +0000609 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000610 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
David Brazdil0f672f62019-12-10 10:32:29 +0000611 __u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
612 bool rootfs:1; /* if it's a SMB root file system */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000613};
614
David Brazdil0f672f62019-12-10 10:32:29 +0000615/**
616 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
617 * trying to reuse existing superblock for a new mount
618 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000619#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
620 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
621 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
622 CIFS_MOUNT_MAP_SFM_CHR | \
623 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
624 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
625 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
626 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
627 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
628 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
David Brazdil0f672f62019-12-10 10:32:29 +0000629 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
630 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
631 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
632 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000633
David Brazdil0f672f62019-12-10 10:32:29 +0000634/**
635 * Generic VFS superblock mount flags (s_flags) to consider when
636 * trying to reuse existing superblock for a new mount
637 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000638#define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
639 SB_NODEV | SB_SYNCHRONOUS)
640
641struct cifs_mnt_data {
642 struct cifs_sb_info *cifs_sb;
643 struct smb_vol *vol;
644 int flags;
645};
646
647static inline unsigned int
648get_rfc1002_length(void *buf)
649{
650 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
651}
652
653static inline void
654inc_rfc1001_len(void *buf, int count)
655{
656 be32_add_cpu((__be32 *)buf, count);
657}
658
659struct TCP_Server_Info {
660 struct list_head tcp_ses_list;
661 struct list_head smb_ses_list;
662 int srv_count; /* reference counter */
663 /* 15 character server name + 0x20 16th byte indicating type = srv */
664 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
665 struct smb_version_operations *ops;
666 struct smb_version_values *vals;
667 enum statusEnum tcpStatus; /* what we think the status is */
668 char *hostname; /* hostname portion of UNC string */
669 struct socket *ssocket;
670 struct sockaddr_storage dstaddr;
671 struct sockaddr_storage srcaddr; /* locally bind to this IP */
672#ifdef CONFIG_NET_NS
673 struct net *net;
674#endif
675 wait_queue_head_t response_q;
676 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
677 struct list_head pending_mid_q;
678 bool noblocksnd; /* use blocking sendmsg */
679 bool noautotune; /* do not autotune send buf sizes */
680 bool tcp_nodelay;
681 unsigned int credits; /* send no more requests at once */
682 unsigned int max_credits; /* can override large 32000 default at mnt */
683 unsigned int in_flight; /* number of requests on the wire to server */
David Brazdil0f672f62019-12-10 10:32:29 +0000684 unsigned int max_in_flight; /* max number of requests that were on wire */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000685 spinlock_t req_lock; /* protect the two values above */
686 struct mutex srv_mutex;
687 struct task_struct *tsk;
688 char server_GUID[16];
689 __u16 sec_mode;
690 bool sign; /* is signing enabled on this connection? */
David Brazdil0f672f62019-12-10 10:32:29 +0000691 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000692 bool session_estab; /* mark when very first sess is established */
693 int echo_credits; /* echo reserved slots */
694 int oplock_credits; /* oplock break reserved slots */
695 bool echoes:1; /* enable echoes */
696 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
697 u16 dialect; /* dialect index that server chose */
698 bool oplocks:1; /* enable oplocks */
699 unsigned int maxReq; /* Clients should submit no more */
700 /* than maxReq distinct unanswered SMBs to the server when using */
701 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
702 unsigned int maxBuf; /* maxBuf specifies the maximum */
703 /* message size the server can send or receive for non-raw SMBs */
704 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
705 /* when socket is setup (and during reconnect) before NegProt sent */
706 unsigned int max_rw; /* maxRw specifies the maximum */
707 /* message size the server can send or receive for */
708 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
709 unsigned int capabilities; /* selective disabling of caps by smb sess */
710 int timeAdj; /* Adjust for difference in server time zone in sec */
711 __u64 CurrentMid; /* multiplex id - rotating counter */
712 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
713 /* 16th byte of RFC1001 workstation name is always null */
714 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
715 __u32 sequence_number; /* for signing, protected by srv_mutex */
David Brazdil0f672f62019-12-10 10:32:29 +0000716 __u32 reconnect_instance; /* incremented on each reconnect */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000717 struct session_key session_key;
718 unsigned long lstrp; /* when we got last response from this server */
719 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
720#define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
721#define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
722#define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
723 char negflavor; /* NEGOTIATE response flavor */
724 /* extended security flavors that server supports */
725 bool sec_ntlmssp; /* supports NTLMSSP */
726 bool sec_kerberosu2u; /* supports U2U Kerberos */
727 bool sec_kerberos; /* supports plain Kerberos */
728 bool sec_mskerberos; /* supports legacy MS Kerberos */
729 bool large_buf; /* is current buffer large? */
730 /* use SMBD connection instead of socket */
731 bool rdma;
732 /* point to the SMBD connection if RDMA is used instead of socket */
733 struct smbd_connection *smbd_conn;
734 struct delayed_work echo; /* echo ping workqueue job */
735 char *smallbuf; /* pointer to current "small" buffer */
736 char *bigbuf; /* pointer to current "big" buffer */
737 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
738 unsigned int pdu_size;
739 unsigned int total_read; /* total amount of data read in this pass */
740#ifdef CONFIG_CIFS_FSCACHE
741 struct fscache_cookie *fscache; /* client index cache cookie */
742#endif
743#ifdef CONFIG_CIFS_STATS2
744 atomic_t in_send; /* requests trying to send */
745 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
David Brazdil0f672f62019-12-10 10:32:29 +0000746 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000747 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
David Brazdil0f672f62019-12-10 10:32:29 +0000748 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
749 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
750 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000751#endif /* STATS2 */
752 unsigned int max_read;
753 unsigned int max_write;
David Brazdil0f672f62019-12-10 10:32:29 +0000754 unsigned int min_offload;
755 __le16 compress_algorithm;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000756 __le16 cipher_type;
757 /* save initital negprot hash */
758 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
759 bool posix_ext_supported;
760 struct delayed_work reconnect; /* reconnect workqueue job */
761 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
762 unsigned long echo_interval;
David Brazdil0f672f62019-12-10 10:32:29 +0000763
764 /*
765 * Number of targets available for reconnect. The more targets
766 * the more tasks have to wait to let the demultiplex thread
767 * reconnect.
768 */
769 int nr_targets;
770 bool noblockcnt; /* use non-blocking connect() */
771};
772
773struct cifs_credits {
774 unsigned int value;
775 unsigned int instance;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000776};
777
778static inline unsigned int
779in_flight(struct TCP_Server_Info *server)
780{
781 unsigned int num;
782 spin_lock(&server->req_lock);
783 num = server->in_flight;
784 spin_unlock(&server->req_lock);
785 return num;
786}
787
788static inline bool
David Brazdil0f672f62019-12-10 10:32:29 +0000789has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000790{
791 int num;
792 spin_lock(&server->req_lock);
793 num = *credits;
794 spin_unlock(&server->req_lock);
David Brazdil0f672f62019-12-10 10:32:29 +0000795 return num >= num_credits;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000796}
797
798static inline void
David Brazdil0f672f62019-12-10 10:32:29 +0000799add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000800 const int optype)
801{
David Brazdil0f672f62019-12-10 10:32:29 +0000802 server->ops->add_credits(server, credits, optype);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000803}
804
805static inline void
David Brazdil0f672f62019-12-10 10:32:29 +0000806add_credits_and_wake_if(struct TCP_Server_Info *server,
807 const struct cifs_credits *credits, const int optype)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000808{
David Brazdil0f672f62019-12-10 10:32:29 +0000809 if (credits->value) {
810 server->ops->add_credits(server, credits, optype);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000811 wake_up(&server->request_q);
812 }
813}
814
815static inline void
816set_credits(struct TCP_Server_Info *server, const int val)
817{
818 server->ops->set_credits(server, val);
819}
820
David Brazdil0f672f62019-12-10 10:32:29 +0000821static inline int
822adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
823 const unsigned int payload_size)
824{
825 return server->ops->adjust_credits ?
826 server->ops->adjust_credits(server, credits, payload_size) : 0;
827}
828
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000829static inline __le64
830get_next_mid64(struct TCP_Server_Info *server)
831{
832 return cpu_to_le64(server->ops->get_next_mid(server));
833}
834
835static inline __le16
836get_next_mid(struct TCP_Server_Info *server)
837{
838 __u16 mid = server->ops->get_next_mid(server);
839 /*
840 * The value in the SMB header should be little endian for easy
841 * on-the-wire decoding.
842 */
843 return cpu_to_le16(mid);
844}
845
David Brazdil0f672f62019-12-10 10:32:29 +0000846static inline void
847revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
848{
849 if (server->ops->revert_current_mid)
850 server->ops->revert_current_mid(server, val);
851}
852
853static inline void
854revert_current_mid_from_hdr(struct TCP_Server_Info *server,
855 const struct smb2_sync_hdr *shdr)
856{
857 unsigned int num = le16_to_cpu(shdr->CreditCharge);
858
859 return revert_current_mid(server, num > 0 ? num : 1);
860}
861
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000862static inline __u16
863get_mid(const struct smb_hdr *smb)
864{
865 return le16_to_cpu(smb->Mid);
866}
867
868static inline bool
869compare_mid(__u16 mid, const struct smb_hdr *smb)
870{
871 return mid == le16_to_cpu(smb->Mid);
872}
873
874/*
875 * When the server supports very large reads and writes via POSIX extensions,
876 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
877 * including the RFC1001 length.
878 *
879 * Note that this might make for "interesting" allocation problems during
880 * writeback however as we have to allocate an array of pointers for the
881 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
882 *
883 * For reads, there is a similar problem as we need to allocate an array
884 * of kvecs to handle the receive, though that should only need to be done
885 * once.
886 */
887#define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
888#define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
889
890/*
891 * When the server doesn't allow large posix writes, only allow a rsize/wsize
892 * of 2^17-1 minus the size of the call header. That allows for a read or
893 * write up to the maximum size described by RFC1002.
894 */
895#define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
896#define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
897
898/*
899 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
900 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
901 * a single wsize request with a single call.
902 */
903#define CIFS_DEFAULT_IOSIZE (1024 * 1024)
David Brazdil0f672f62019-12-10 10:32:29 +0000904#define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000905
906/*
907 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
908 * those values when posix extensions aren't in force. In actuality here, we
909 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
910 * to be ok with the extra byte even though Windows doesn't send writes that
911 * are that large.
912 *
913 * Citation:
914 *
915 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
916 */
917#define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
918#define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
919
920/*
921 * Macros to allow the TCP_Server_Info->net field and related code to drop out
922 * when CONFIG_NET_NS isn't set.
923 */
924
925#ifdef CONFIG_NET_NS
926
927static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
928{
929 return srv->net;
930}
931
932static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
933{
934 srv->net = net;
935}
936
937#else
938
939static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
940{
941 return &init_net;
942}
943
944static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
945{
946}
947
948#endif
949
950struct cifs_server_iface {
951 size_t speed;
952 unsigned int rdma_capable : 1;
953 unsigned int rss_capable : 1;
954 struct sockaddr_storage sockaddr;
955};
956
957/*
958 * Session structure. One of these for each uid session with a particular host
959 */
960struct cifs_ses {
961 struct list_head smb_ses_list;
962 struct list_head tcon_list;
963 struct cifs_tcon *tcon_ipc;
964 struct mutex session_mutex;
965 struct TCP_Server_Info *server; /* pointer to server info */
966 int ses_count; /* reference counter */
Olivier Deprez0e641232021-09-23 10:07:05 +0200967 enum statusEnum status; /* updates protected by GlobalMid_Lock */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000968 unsigned overrideSecFlg; /* if non-zero override global sec flags */
969 char *serverOS; /* name of operating system underlying server */
970 char *serverNOS; /* name of network operating system of server */
971 char *serverDomain; /* security realm of server */
972 __u64 Suid; /* remote smb uid */
973 kuid_t linux_uid; /* overriding owner of files on the mount */
974 kuid_t cred_uid; /* owner of credentials */
975 unsigned int capabilities;
976 char serverName[SERVER_NAME_LEN_WITH_NULL];
977 char *user_name; /* must not be null except during init of sess
978 and after mount option parsing we fill it */
979 char *domainName;
980 char *password;
981 struct session_key auth_key;
982 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
983 enum securityEnum sectype; /* what security flavor was specified? */
984 bool sign; /* is signing required? */
985 bool need_reconnect:1; /* connection reset, uid now invalid */
986 bool domainAuto:1;
987 __u16 session_flags;
988 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
989 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
990 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
991 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
992
993 /*
994 * Network interfaces available on the server this session is
995 * connected to.
996 *
997 * Other channels can be opened by connecting and binding this
998 * session to interfaces from this list.
999 *
1000 * iface_lock should be taken when accessing any of these fields
1001 */
1002 spinlock_t iface_lock;
1003 struct cifs_server_iface *iface_list;
1004 size_t iface_count;
1005 unsigned long iface_last_update; /* jiffies */
1006};
1007
1008static inline bool
1009cap_unix(struct cifs_ses *ses)
1010{
1011 return ses->server->vals->cap_unix & ses->capabilities;
1012}
1013
1014struct cached_fid {
1015 bool is_valid:1; /* Do we have a useable root fid */
David Brazdil0f672f62019-12-10 10:32:29 +00001016 bool file_all_info_is_valid:1;
1017
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001018 struct kref refcount;
1019 struct cifs_fid *fid;
1020 struct mutex fid_mutex;
1021 struct cifs_tcon *tcon;
1022 struct work_struct lease_break;
David Brazdil0f672f62019-12-10 10:32:29 +00001023 struct smb2_file_all_info file_all_info;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001024};
1025
1026/*
1027 * there is one of these for each connection to a resource on a particular
1028 * session
1029 */
1030struct cifs_tcon {
1031 struct list_head tcon_list;
1032 int tc_count;
1033 struct list_head rlist; /* reconnect list */
David Brazdil0f672f62019-12-10 10:32:29 +00001034 atomic_t num_local_opens; /* num of all opens including disconnected */
1035 atomic_t num_remote_opens; /* num of all network opens on server */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001036 struct list_head openFileList;
1037 spinlock_t open_file_lock; /* protects list above */
1038 struct cifs_ses *ses; /* pointer to session associated with */
1039 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1040 char *nativeFileSystem;
1041 char *password; /* for share-level security */
1042 __u32 tid; /* The 4 byte tree id */
1043 __u16 Flags; /* optional support bits */
1044 enum statusEnum tidStatus;
1045 atomic_t num_smbs_sent;
1046 union {
1047 struct {
1048 atomic_t num_writes;
1049 atomic_t num_reads;
1050 atomic_t num_flushes;
1051 atomic_t num_oplock_brks;
1052 atomic_t num_opens;
1053 atomic_t num_closes;
1054 atomic_t num_deletes;
1055 atomic_t num_mkdirs;
1056 atomic_t num_posixopens;
1057 atomic_t num_posixmkdirs;
1058 atomic_t num_rmdirs;
1059 atomic_t num_renames;
1060 atomic_t num_t2renames;
1061 atomic_t num_ffirst;
1062 atomic_t num_fnext;
1063 atomic_t num_fclose;
1064 atomic_t num_hardlinks;
1065 atomic_t num_symlinks;
1066 atomic_t num_locks;
1067 atomic_t num_acl_get;
1068 atomic_t num_acl_set;
1069 } cifs_stats;
1070 struct {
1071 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1072 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1073 } smb2_stats;
1074 } stats;
1075 __u64 bytes_read;
1076 __u64 bytes_written;
1077 spinlock_t stat_lock; /* protects the two fields above */
1078 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1079 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1080 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1081 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1082 bool pipe:1; /* set if connection to pipe share */
1083 bool print:1; /* set if connection to printer share */
1084 bool retry:1;
1085 bool nocase:1;
1086 bool nohandlecache:1; /* if strange server resource prob can turn off */
1087 bool seal:1; /* transport encryption for this mounted share */
1088 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
1089 for this mount even if server would support */
1090 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1091 bool local_lease:1; /* check leases (only) on local system not remote */
1092 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1093 bool broken_sparse_sup; /* if server or share does not support sparse */
1094 bool need_reconnect:1; /* connection reset, tid now invalid */
1095 bool need_reopen_files:1; /* need to reopen tcon file handles */
1096 bool use_resilient:1; /* use resilient instead of durable handles */
1097 bool use_persistent:1; /* use persistent instead of durable handles */
David Brazdil0f672f62019-12-10 10:32:29 +00001098 bool no_lease:1; /* Do not request leases on files or directories */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001099 __le32 capabilities;
1100 __u32 share_flags;
1101 __u32 maximal_access;
1102 __u32 vol_serial_number;
1103 __le64 vol_create_time;
1104 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
David Brazdil0f672f62019-12-10 10:32:29 +00001105 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001106 __u32 ss_flags; /* sector size flags */
1107 __u32 perf_sector_size; /* best sector size for perf */
1108 __u32 max_chunks;
1109 __u32 max_bytes_chunk;
1110 __u32 max_bytes_copy;
1111#ifdef CONFIG_CIFS_FSCACHE
1112 u64 resource_id; /* server resource id */
1113 struct fscache_cookie *fscache; /* cookie for share */
1114#endif
1115 struct list_head pending_opens; /* list of incomplete opens */
1116 struct cached_fid crfid; /* Cached root fid */
1117 /* BB add field for back pointer to sb struct(s)? */
David Brazdil0f672f62019-12-10 10:32:29 +00001118#ifdef CONFIG_CIFS_DFS_UPCALL
1119 char *dfs_path;
1120 int remap:2;
1121 struct list_head ulist; /* cache update list */
1122#endif
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001123};
1124
1125/*
1126 * This is a refcounted and timestamped container for a tcon pointer. The
1127 * container holds a tcon reference. It is considered safe to free one of
1128 * these when the tl_count goes to 0. The tl_time is the time of the last
1129 * "get" on the container.
1130 */
1131struct tcon_link {
1132 struct rb_node tl_rbnode;
1133 kuid_t tl_uid;
1134 unsigned long tl_flags;
1135#define TCON_LINK_MASTER 0
1136#define TCON_LINK_PENDING 1
1137#define TCON_LINK_IN_TREE 2
1138 unsigned long tl_time;
1139 atomic_t tl_count;
1140 struct cifs_tcon *tl_tcon;
1141};
1142
1143extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1144extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1145
1146static inline struct cifs_tcon *
1147tlink_tcon(struct tcon_link *tlink)
1148{
1149 return tlink->tl_tcon;
1150}
1151
1152static inline struct tcon_link *
1153cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1154{
1155 return cifs_sb->master_tlink;
1156}
1157
1158extern void cifs_put_tlink(struct tcon_link *tlink);
1159
1160static inline struct tcon_link *
1161cifs_get_tlink(struct tcon_link *tlink)
1162{
1163 if (tlink && !IS_ERR(tlink))
1164 atomic_inc(&tlink->tl_count);
1165 return tlink;
1166}
1167
1168/* This function is always expected to succeed */
1169extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1170
1171#define CIFS_OPLOCK_NO_CHANGE 0xfe
1172
1173struct cifs_pending_open {
1174 struct list_head olist;
1175 struct tcon_link *tlink;
1176 __u8 lease_key[16];
1177 __u32 oplock;
1178};
1179
1180/*
1181 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1182 * This is used to track byte stream locks on the file
1183 */
1184struct cifsLockInfo {
1185 struct list_head llist; /* pointer to next cifsLockInfo */
1186 struct list_head blist; /* pointer to locks blocked on this */
1187 wait_queue_head_t block_q;
1188 __u64 offset;
1189 __u64 length;
1190 __u32 pid;
David Brazdil0f672f62019-12-10 10:32:29 +00001191 __u16 type;
1192 __u16 flags;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001193};
1194
1195/*
1196 * One of these for each open instance of a file
1197 */
1198struct cifs_search_info {
1199 loff_t index_of_last_entry;
1200 __u16 entries_in_buffer;
1201 __u16 info_level;
1202 __u32 resume_key;
1203 char *ntwrk_buf_start;
1204 char *srch_entries_start;
1205 char *last_entry;
1206 const char *presume_name;
1207 unsigned int resume_name_len;
1208 bool endOfSearch:1;
1209 bool emptyDir:1;
1210 bool unicode:1;
1211 bool smallBuf:1; /* so we know which buf_release function to call */
1212};
1213
David Brazdil0f672f62019-12-10 10:32:29 +00001214#define ACL_NO_MODE ((umode_t)(-1))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001215struct cifs_open_parms {
1216 struct cifs_tcon *tcon;
1217 struct cifs_sb_info *cifs_sb;
1218 int disposition;
1219 int desired_access;
1220 int create_options;
1221 const char *path;
1222 struct cifs_fid *fid;
1223 umode_t mode;
1224 bool reconnect:1;
1225};
1226
1227struct cifs_fid {
1228 __u16 netfid;
1229 __u64 persistent_fid; /* persist file id for smb2 */
1230 __u64 volatile_fid; /* volatile file id for smb2 */
1231 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1232 __u8 create_guid[16];
Olivier Deprez0e641232021-09-23 10:07:05 +02001233 __u32 access;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001234 struct cifs_pending_open *pending_open;
1235 unsigned int epoch;
David Brazdil0f672f62019-12-10 10:32:29 +00001236#ifdef CONFIG_CIFS_DEBUG2
1237 __u64 mid;
1238#endif /* CIFS_DEBUG2 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001239 bool purge_cache;
1240};
1241
1242struct cifs_fid_locks {
1243 struct list_head llist;
1244 struct cifsFileInfo *cfile; /* fid that owns locks */
1245 struct list_head locks; /* locks held by fid above */
1246};
1247
1248struct cifsFileInfo {
1249 /* following two lists are protected by tcon->open_file_lock */
1250 struct list_head tlist; /* pointer to next fid owned by tcon */
1251 struct list_head flist; /* next fid (file instance) for this inode */
1252 /* lock list below protected by cifsi->lock_sem */
1253 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1254 kuid_t uid; /* allows finding which FileInfo structure */
1255 __u32 pid; /* process id who opened file */
1256 struct cifs_fid fid; /* file id from remote */
1257 struct list_head rlist; /* reconnect list */
1258 /* BB add lock scope info here if needed */ ;
1259 /* lock scope id (0 if none) */
1260 struct dentry *dentry;
1261 struct tcon_link *tlink;
1262 unsigned int f_flags;
1263 bool invalidHandle:1; /* file closed via session abend */
1264 bool oplock_break_cancelled:1;
Olivier Deprez0e641232021-09-23 10:07:05 +02001265 unsigned int oplock_epoch; /* epoch from the lease break */
1266 __u32 oplock_level; /* oplock/lease level from the lease break */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001267 int count;
1268 spinlock_t file_info_lock; /* protects four flag/count fields above */
1269 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1270 struct cifs_search_info srch_inf;
1271 struct work_struct oplock_break; /* work for oplock breaks */
Olivier Deprez0e641232021-09-23 10:07:05 +02001272 struct work_struct put; /* work for the final part of _put */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001273};
1274
1275struct cifs_io_parms {
1276 __u16 netfid;
1277 __u64 persistent_fid; /* persist file id for smb2 */
1278 __u64 volatile_fid; /* volatile file id for smb2 */
1279 __u32 pid;
1280 __u64 offset;
1281 unsigned int length;
1282 struct cifs_tcon *tcon;
1283};
1284
1285struct cifs_aio_ctx {
1286 struct kref refcount;
1287 struct list_head list;
1288 struct mutex aio_mutex;
1289 struct completion done;
1290 struct iov_iter iter;
1291 struct kiocb *iocb;
1292 struct cifsFileInfo *cfile;
1293 struct bio_vec *bv;
1294 loff_t pos;
1295 unsigned int npages;
1296 ssize_t rc;
1297 unsigned int len;
1298 unsigned int total_len;
1299 bool should_dirty;
David Brazdil0f672f62019-12-10 10:32:29 +00001300 /*
1301 * Indicates if this aio_ctx is for direct_io,
1302 * If yes, iter is a copy of the user passed iov_iter
1303 */
1304 bool direct_io;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001305};
1306
1307struct cifs_readdata;
1308
1309/* asynchronous read support */
1310struct cifs_readdata {
1311 struct kref refcount;
1312 struct list_head list;
1313 struct completion done;
1314 struct cifsFileInfo *cfile;
1315 struct address_space *mapping;
1316 struct cifs_aio_ctx *ctx;
1317 __u64 offset;
1318 unsigned int bytes;
1319 unsigned int got_bytes;
1320 pid_t pid;
1321 int result;
1322 struct work_struct work;
1323 int (*read_into_pages)(struct TCP_Server_Info *server,
1324 struct cifs_readdata *rdata,
1325 unsigned int len);
1326 int (*copy_into_pages)(struct TCP_Server_Info *server,
1327 struct cifs_readdata *rdata,
1328 struct iov_iter *iter);
1329 struct kvec iov[2];
1330#ifdef CONFIG_CIFS_SMB_DIRECT
1331 struct smbd_mr *mr;
1332#endif
1333 unsigned int pagesz;
1334 unsigned int page_offset;
1335 unsigned int tailsz;
David Brazdil0f672f62019-12-10 10:32:29 +00001336 struct cifs_credits credits;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001337 unsigned int nr_pages;
1338 struct page **pages;
1339};
1340
1341struct cifs_writedata;
1342
1343/* asynchronous write support */
1344struct cifs_writedata {
1345 struct kref refcount;
1346 struct list_head list;
1347 struct completion done;
1348 enum writeback_sync_modes sync_mode;
1349 struct work_struct work;
1350 struct cifsFileInfo *cfile;
1351 struct cifs_aio_ctx *ctx;
1352 __u64 offset;
1353 pid_t pid;
1354 unsigned int bytes;
1355 int result;
1356#ifdef CONFIG_CIFS_SMB_DIRECT
1357 struct smbd_mr *mr;
1358#endif
1359 unsigned int pagesz;
1360 unsigned int page_offset;
1361 unsigned int tailsz;
David Brazdil0f672f62019-12-10 10:32:29 +00001362 struct cifs_credits credits;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001363 unsigned int nr_pages;
1364 struct page **pages;
1365};
1366
1367/*
1368 * Take a reference on the file private data. Must be called with
1369 * cfile->file_info_lock held.
1370 */
1371static inline void
1372cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1373{
1374 ++cifs_file->count;
1375}
1376
1377struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
Olivier Deprez0e641232021-09-23 10:07:05 +02001378void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1379 bool offload);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001380void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1381
1382#define CIFS_CACHE_READ_FLG 1
1383#define CIFS_CACHE_HANDLE_FLG 2
1384#define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1385#define CIFS_CACHE_WRITE_FLG 4
1386#define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1387#define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1388
David Brazdil0f672f62019-12-10 10:32:29 +00001389#define CIFS_CACHE_READ(cinode) ((cinode->oplock & CIFS_CACHE_READ_FLG) || (CIFS_SB(cinode->vfs_inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RO_CACHE))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001390#define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
David Brazdil0f672f62019-12-10 10:32:29 +00001391#define CIFS_CACHE_WRITE(cinode) ((cinode->oplock & CIFS_CACHE_WRITE_FLG) || (CIFS_SB(cinode->vfs_inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RW_CACHE))
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001392
1393/*
1394 * One of these for each file inode
1395 */
1396
1397struct cifsInodeInfo {
1398 bool can_cache_brlcks;
1399 struct list_head llist; /* locks helb by this inode */
David Brazdil0f672f62019-12-10 10:32:29 +00001400 /*
1401 * NOTE: Some code paths call down_read(lock_sem) twice, so
1402 * we must always use use cifs_down_write() instead of down_write()
1403 * for this semaphore to avoid deadlocks.
1404 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001405 struct rw_semaphore lock_sem; /* protect the fields above */
1406 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1407 struct list_head openFileList;
David Brazdil0f672f62019-12-10 10:32:29 +00001408 spinlock_t open_file_lock; /* protects openFileList */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001409 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1410 unsigned int oplock; /* oplock/lease level we have */
1411 unsigned int epoch; /* used to track lease state changes */
1412#define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1413#define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
Olivier Deprez0e641232021-09-23 10:07:05 +02001414#define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001415#define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1416#define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1417#define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1418 unsigned long flags;
1419 spinlock_t writers_lock;
1420 unsigned int writers; /* Number of writers on this inode */
1421 unsigned long time; /* jiffies of last update of inode */
1422 u64 server_eof; /* current file size on server -- protected by i_lock */
1423 u64 uniqueid; /* server inode number */
1424 u64 createtime; /* creation time on server */
1425 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1426#ifdef CONFIG_CIFS_FSCACHE
1427 struct fscache_cookie *fscache;
1428#endif
1429 struct inode vfs_inode;
1430};
1431
1432static inline struct cifsInodeInfo *
1433CIFS_I(struct inode *inode)
1434{
1435 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1436}
1437
1438static inline struct cifs_sb_info *
1439CIFS_SB(struct super_block *sb)
1440{
1441 return sb->s_fs_info;
1442}
1443
1444static inline struct cifs_sb_info *
1445CIFS_FILE_SB(struct file *file)
1446{
1447 return CIFS_SB(file_inode(file)->i_sb);
1448}
1449
1450static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1451{
1452 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1453 return '/';
1454 else
1455 return '\\';
1456}
1457
1458static inline void
1459convert_delimiter(char *path, char delim)
1460{
1461 char old_delim, *pos;
1462
1463 if (delim == '/')
1464 old_delim = '\\';
1465 else
1466 old_delim = '/';
1467
1468 pos = path;
1469 while ((pos = strchr(pos, old_delim)))
1470 *pos = delim;
1471}
1472
1473#define cifs_stats_inc atomic_inc
1474
1475static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1476 unsigned int bytes)
1477{
1478 if (bytes) {
1479 spin_lock(&tcon->stat_lock);
1480 tcon->bytes_written += bytes;
1481 spin_unlock(&tcon->stat_lock);
1482 }
1483}
1484
1485static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1486 unsigned int bytes)
1487{
1488 spin_lock(&tcon->stat_lock);
1489 tcon->bytes_read += bytes;
1490 spin_unlock(&tcon->stat_lock);
1491}
1492
1493
1494/*
1495 * This is the prototype for the mid receive function. This function is for
1496 * receiving the rest of the SMB frame, starting with the WordCount (which is
1497 * just after the MID in struct smb_hdr). Note:
1498 *
1499 * - This will be called by cifsd, with no locks held.
1500 * - The mid will still be on the pending_mid_q.
1501 * - mid->resp_buf will point to the current buffer.
1502 *
1503 * Returns zero on a successful receive, or an error. The receive state in
1504 * the TCP_Server_Info will also be updated.
1505 */
1506typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1507 struct mid_q_entry *mid);
1508
1509/*
1510 * This is the prototype for the mid callback function. This is called once the
1511 * mid has been received off of the socket. When creating one, take special
1512 * care to avoid deadlocks. Things to bear in mind:
1513 *
1514 * - it will be called by cifsd, with no locks held
1515 * - the mid will be removed from any lists
1516 */
1517typedef void (mid_callback_t)(struct mid_q_entry *mid);
1518
1519/*
1520 * This is the protopyte for mid handle function. This is called once the mid
1521 * has been recognized after decryption of the message.
1522 */
1523typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1524 struct mid_q_entry *mid);
1525
1526/* one of these for every pending CIFS request to the server */
1527struct mid_q_entry {
1528 struct list_head qhead; /* mids waiting on reply from this server */
1529 struct kref refcount;
1530 struct TCP_Server_Info *server; /* server corresponding to this mid */
1531 __u64 mid; /* multiplex id */
David Brazdil0f672f62019-12-10 10:32:29 +00001532 __u16 credits; /* number of credits consumed by this mid */
Olivier Deprez0e641232021-09-23 10:07:05 +02001533 __u16 credits_received; /* number of credits from the response */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001534 __u32 pid; /* process id */
1535 __u32 sequence_number; /* for CIFS signing */
1536 unsigned long when_alloc; /* when mid was created */
1537#ifdef CONFIG_CIFS_STATS2
1538 unsigned long when_sent; /* time when smb send finished */
1539 unsigned long when_received; /* when demux complete (taken off wire) */
1540#endif
1541 mid_receive_t *receive; /* call receive callback */
1542 mid_callback_t *callback; /* call completion callback */
1543 mid_handle_t *handle; /* call handle mid callback */
1544 void *callback_data; /* general purpose pointer for callback */
Olivier Deprez0e641232021-09-23 10:07:05 +02001545 struct task_struct *creator;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001546 void *resp_buf; /* pointer to received SMB header */
1547 unsigned int resp_buf_size;
1548 int mid_state; /* wish this were enum but can not pass to wait_event */
1549 unsigned int mid_flags;
1550 __le16 command; /* smb command code */
David Brazdil0f672f62019-12-10 10:32:29 +00001551 unsigned int optype; /* operation type */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001552 bool large_buf:1; /* if valid response, is pointer to large buf */
1553 bool multiRsp:1; /* multiple trans2 responses for one request */
1554 bool multiEnd:1; /* both received */
1555 bool decrypted:1; /* decrypted entry */
1556};
1557
1558struct close_cancelled_open {
1559 struct cifs_fid fid;
1560 struct cifs_tcon *tcon;
1561 struct work_struct work;
1562};
1563
1564/* Make code in transport.c a little cleaner by moving
1565 update of optional stats into function below */
1566#ifdef CONFIG_CIFS_STATS2
1567
1568static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1569{
1570 atomic_inc(&server->in_send);
1571}
1572
1573static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1574{
1575 atomic_dec(&server->in_send);
1576}
1577
1578static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1579{
1580 atomic_inc(&server->num_waiters);
1581}
1582
1583static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1584{
1585 atomic_dec(&server->num_waiters);
1586}
1587
1588static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1589{
1590 mid->when_sent = jiffies;
1591}
1592#else
1593static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1594{
1595}
1596static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1597{
1598}
1599
1600static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1601{
1602}
1603
1604static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1605{
1606}
1607
1608static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1609{
1610}
1611#endif
1612
1613/* for pending dnotify requests */
1614struct dir_notify_req {
1615 struct list_head lhead;
1616 __le16 Pid;
1617 __le16 PidHigh;
1618 __u16 Mid;
1619 __u16 Tid;
1620 __u16 Uid;
1621 __u16 netfid;
1622 __u32 filter; /* CompletionFilter (for multishot) */
1623 int multishot;
1624 struct file *pfile;
1625};
1626
1627struct dfs_info3_param {
1628 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1629 int path_consumed;
1630 int server_type;
1631 int ref_flag;
1632 char *path_name;
1633 char *node_name;
David Brazdil0f672f62019-12-10 10:32:29 +00001634 int ttl;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001635};
1636
1637/*
1638 * common struct for holding inode info when searching for or updating an
1639 * inode with new info
1640 */
1641
1642#define CIFS_FATTR_DFS_REFERRAL 0x1
1643#define CIFS_FATTR_DELETE_PENDING 0x2
1644#define CIFS_FATTR_NEED_REVAL 0x4
1645#define CIFS_FATTR_INO_COLLISION 0x8
1646#define CIFS_FATTR_UNKNOWN_NLINK 0x10
1647#define CIFS_FATTR_FAKE_ROOT_INO 0x20
1648
1649struct cifs_fattr {
1650 u32 cf_flags;
1651 u32 cf_cifsattrs;
1652 u64 cf_uniqueid;
1653 u64 cf_eof;
1654 u64 cf_bytes;
1655 u64 cf_createtime;
1656 kuid_t cf_uid;
1657 kgid_t cf_gid;
1658 umode_t cf_mode;
1659 dev_t cf_rdev;
1660 unsigned int cf_nlink;
1661 unsigned int cf_dtype;
1662 struct timespec64 cf_atime;
1663 struct timespec64 cf_mtime;
1664 struct timespec64 cf_ctime;
1665};
1666
1667static inline void free_dfs_info_param(struct dfs_info3_param *param)
1668{
1669 if (param) {
1670 kfree(param->path_name);
1671 kfree(param->node_name);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001672 }
1673}
1674
1675static inline void free_dfs_info_array(struct dfs_info3_param *param,
1676 int number_of_items)
1677{
1678 int i;
1679 if ((number_of_items == 0) || (param == NULL))
1680 return;
1681 for (i = 0; i < number_of_items; i++) {
1682 kfree(param[i].path_name);
1683 kfree(param[i].node_name);
1684 }
1685 kfree(param);
1686}
1687
David Brazdil0f672f62019-12-10 10:32:29 +00001688static inline bool is_interrupt_error(int error)
1689{
1690 switch (error) {
1691 case -EINTR:
1692 case -ERESTARTSYS:
1693 case -ERESTARTNOHAND:
1694 case -ERESTARTNOINTR:
1695 return true;
1696 }
1697 return false;
1698}
1699
1700static inline bool is_retryable_error(int error)
1701{
1702 if (is_interrupt_error(error) || error == -EAGAIN)
1703 return true;
1704 return false;
1705}
1706
Olivier Deprez0e641232021-09-23 10:07:05 +02001707
1708/* cifs_get_writable_file() flags */
1709#define FIND_WR_ANY 0
1710#define FIND_WR_FSUID_ONLY 1
1711#define FIND_WR_WITH_DELETE 2
1712
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001713#define MID_FREE 0
1714#define MID_REQUEST_ALLOCATED 1
1715#define MID_REQUEST_SUBMITTED 2
1716#define MID_RESPONSE_RECEIVED 4
1717#define MID_RETRY_NEEDED 8 /* session closed while this request out */
1718#define MID_RESPONSE_MALFORMED 0x10
1719#define MID_SHUTDOWN 0x20
1720
1721/* Flags */
1722#define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1723#define MID_DELETED 2 /* Mid has been dequeued/deleted */
1724
1725/* Types of response buffer returned from SendReceive2 */
1726#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1727#define CIFS_SMALL_BUFFER 1
1728#define CIFS_LARGE_BUFFER 2
1729#define CIFS_IOVEC 4 /* array of response buffers */
1730
1731/* Type of Request to SendReceive2 */
1732#define CIFS_BLOCKING_OP 1 /* operation can block */
David Brazdil0f672f62019-12-10 10:32:29 +00001733#define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001734#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1735#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1736#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
David Brazdil0f672f62019-12-10 10:32:29 +00001737#define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001738
1739/* Type of request operation */
1740#define CIFS_ECHO_OP 0x080 /* echo request */
1741#define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1742#define CIFS_NEG_OP 0x0200 /* negotiate request */
1743#define CIFS_OP_MASK 0x0380 /* mask request type */
1744
1745#define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1746#define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
David Brazdil0f672f62019-12-10 10:32:29 +00001747#define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001748
1749/* Security Flags: indicate type of session setup needed */
1750#define CIFSSEC_MAY_SIGN 0x00001
1751#define CIFSSEC_MAY_NTLM 0x00002
1752#define CIFSSEC_MAY_NTLMV2 0x00004
1753#define CIFSSEC_MAY_KRB5 0x00008
1754#ifdef CONFIG_CIFS_WEAK_PW_HASH
1755#define CIFSSEC_MAY_LANMAN 0x00010
1756#define CIFSSEC_MAY_PLNTXT 0x00020
1757#else
1758#define CIFSSEC_MAY_LANMAN 0
1759#define CIFSSEC_MAY_PLNTXT 0
1760#endif /* weak passwords */
1761#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1762#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1763
1764#define CIFSSEC_MUST_SIGN 0x01001
1765/* note that only one of the following can be set so the
1766result of setting MUST flags more than once will be to
1767require use of the stronger protocol */
1768#define CIFSSEC_MUST_NTLM 0x02002
1769#define CIFSSEC_MUST_NTLMV2 0x04004
1770#define CIFSSEC_MUST_KRB5 0x08008
1771#ifdef CONFIG_CIFS_WEAK_PW_HASH
1772#define CIFSSEC_MUST_LANMAN 0x10010
1773#define CIFSSEC_MUST_PLNTXT 0x20020
1774#ifdef CONFIG_CIFS_UPCALL
1775#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1776#else
1777#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1778#endif /* UPCALL */
1779#else /* do not allow weak pw hash */
1780#define CIFSSEC_MUST_LANMAN 0
1781#define CIFSSEC_MUST_PLNTXT 0
1782#ifdef CONFIG_CIFS_UPCALL
1783#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1784#else
1785#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1786#endif /* UPCALL */
1787#endif /* WEAK_PW_HASH */
1788#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1789#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1790
1791#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1792#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1793#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1794/*
1795 *****************************************************************
1796 * All constants go here
1797 *****************************************************************
1798 */
1799
1800#define UID_HASH (16)
1801
1802/*
1803 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1804 * following to be declared.
1805 */
1806
1807/****************************************************************************
1808 * Locking notes. All updates to global variables and lists should be
1809 * protected by spinlocks or semaphores.
1810 *
1811 * Spinlocks
1812 * ---------
1813 * GlobalMid_Lock protects:
1814 * list operations on pending_mid_q and oplockQ
1815 * updates to XID counters, multiplex id and SMB sequence numbers
David Brazdil0f672f62019-12-10 10:32:29 +00001816 * list operations on global DnotifyReqList
Olivier Deprez0e641232021-09-23 10:07:05 +02001817 * updates to ses->status
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001818 * tcp_ses_lock protects:
1819 * list operations on tcp and SMB session lists
1820 * tcon->open_file_lock protects the list of open files hanging off the tcon
David Brazdil0f672f62019-12-10 10:32:29 +00001821 * inode->open_file_lock protects the openFileList hanging off the inode
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001822 * cfile->file_info_lock protects counters and fields in cifs file struct
1823 * f_owner.lock protects certain per file struct operations
1824 * mapping->page_lock protects certain per page operations
1825 *
David Brazdil0f672f62019-12-10 10:32:29 +00001826 * Note that the cifs_tcon.open_file_lock should be taken before
1827 * not after the cifsInodeInfo.open_file_lock
1828 *
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001829 * Semaphores
1830 * ----------
1831 * sesSem operations on smb session
1832 * tconSem operations on tree connection
1833 * fh_sem file handle reconnection operations
1834 *
1835 ****************************************************************************/
1836
1837#ifdef DECLARE_GLOBALS_HERE
1838#define GLOBAL_EXTERN
1839#else
1840#define GLOBAL_EXTERN extern
1841#endif
1842
1843/*
1844 * the list of TCP_Server_Info structures, ie each of the sockets
1845 * connecting our client to a distinct server (ip address), is
1846 * chained together by cifs_tcp_ses_list. The list of all our SMB
1847 * sessions (and from that the tree connections) can be found
1848 * by iterating over cifs_tcp_ses_list
1849 */
1850GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1851
1852/*
1853 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1854 * tcp session, and the list of tcon's per smb session. It also protects
1855 * the reference counters for the server, smb session, and tcon. Finally,
1856 * changes to the tcon->tidStatus should be done while holding this lock.
1857 * generally the locks should be taken in order tcp_ses_lock before
1858 * tcon->open_file_lock and that before file->file_info_lock since the
1859 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1860 */
1861GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1862
1863#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1864/* Outstanding dir notify requests */
1865GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1866/* DirNotify response queue */
1867GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1868#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1869
1870/*
1871 * Global transaction id (XID) information
1872 */
1873GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1874GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1875GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1876GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1877 /* on midQ entries */
1878/*
1879 * Global counters, updated atomically
1880 */
1881GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1882GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1883GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1884GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1885GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1886
1887/* Various Debug counters */
1888GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1889#ifdef CONFIG_CIFS_STATS2
1890GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1891GLOBAL_EXTERN atomic_t totSmBufAllocCount;
David Brazdil0f672f62019-12-10 10:32:29 +00001892extern unsigned int slow_rsp_threshold; /* number of secs before logging */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001893#endif
1894GLOBAL_EXTERN atomic_t smBufAllocCount;
1895GLOBAL_EXTERN atomic_t midCount;
1896
1897/* Misc globals */
1898extern bool enable_oplocks; /* enable or disable oplocks */
1899extern bool lookupCacheEnabled;
1900extern unsigned int global_secflags; /* if on, session setup sent
1901 with more secure ntlmssp2 challenge/resp */
1902extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1903extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1904extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1905extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1906extern unsigned int cifs_min_small; /* min size of small buf pool */
1907extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1908extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
1909
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001910GLOBAL_EXTERN struct rb_root uidtree;
1911GLOBAL_EXTERN struct rb_root gidtree;
1912GLOBAL_EXTERN spinlock_t siduidlock;
1913GLOBAL_EXTERN spinlock_t sidgidlock;
1914GLOBAL_EXTERN struct rb_root siduidtree;
1915GLOBAL_EXTERN struct rb_root sidgidtree;
1916GLOBAL_EXTERN spinlock_t uidsidlock;
1917GLOBAL_EXTERN spinlock_t gidsidlock;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001918
1919void cifs_oplock_break(struct work_struct *work);
David Brazdil0f672f62019-12-10 10:32:29 +00001920void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001921
1922extern const struct slow_work_ops cifs_oplock_break_ops;
1923extern struct workqueue_struct *cifsiod_wq;
David Brazdil0f672f62019-12-10 10:32:29 +00001924extern struct workqueue_struct *decrypt_wq;
Olivier Deprez0e641232021-09-23 10:07:05 +02001925extern struct workqueue_struct *fileinfo_put_wq;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001926extern struct workqueue_struct *cifsoplockd_wq;
1927extern __u32 cifs_lock_secret;
1928
1929extern mempool_t *cifs_mid_poolp;
1930
1931/* Operations for different SMB versions */
1932#define SMB1_VERSION_STRING "1.0"
1933extern struct smb_version_operations smb1_operations;
1934extern struct smb_version_values smb1_values;
1935#define SMB20_VERSION_STRING "2.0"
1936extern struct smb_version_operations smb20_operations;
1937extern struct smb_version_values smb20_values;
1938#define SMB21_VERSION_STRING "2.1"
1939extern struct smb_version_operations smb21_operations;
1940extern struct smb_version_values smb21_values;
1941#define SMBDEFAULT_VERSION_STRING "default"
1942extern struct smb_version_values smbdefault_values;
1943#define SMB3ANY_VERSION_STRING "3"
1944extern struct smb_version_values smb3any_values;
1945#define SMB30_VERSION_STRING "3.0"
1946extern struct smb_version_operations smb30_operations;
1947extern struct smb_version_values smb30_values;
1948#define SMB302_VERSION_STRING "3.02"
David Brazdil0f672f62019-12-10 10:32:29 +00001949#define ALT_SMB302_VERSION_STRING "3.0.2"
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00001950/*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1951extern struct smb_version_values smb302_values;
1952#define SMB311_VERSION_STRING "3.1.1"
1953#define ALT_SMB311_VERSION_STRING "3.11"
1954extern struct smb_version_operations smb311_operations;
1955extern struct smb_version_values smb311_values;
1956#endif /* _CIFS_GLOB_H */