1 /*
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
36 #define SMB_PATH_MAX 260
37 #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 /*
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 /* 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 */
112 enum statusEnum {
113 CifsNew = 0,
114 CifsGood,
115 CifsExiting,
116 CifsNeedReconnect,
117 CifsNeedNegotiate
118 };
119
120 enum 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
129 struct session_key {
130 unsigned int len;
131 char *response;
132 };
133
134 /* crypto security descriptor definition */
135 struct sdesc {
136 struct shash_desc shash;
137 char ctx[];
138 };
139
140 /* crypto hashing related structure/fields, not specific to a sec mech */
141 struct 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 */
157 struct 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
165 struct 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 */
188 struct 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
198 struct mid_q_entry;
199 struct TCP_Server_Info;
200 struct cifsFileInfo;
201 struct cifs_ses;
202 struct cifs_tcon;
203 struct dfs_info3_param;
204 struct cifs_fattr;
205 struct smb_vol;
206 struct cifs_fid;
207 struct cifs_readdata;
208 struct cifs_writedata;
209 struct cifs_io_parms;
210 struct cifs_search_info;
211 struct cifsInodeInfo;
212 struct cifs_open_parms;
213 struct cifs_credits;
214
215 struct smb_version_operations {
216 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
217 struct mid_q_entry *);
218 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
219 /* setup request: allocate mid, sign message */
220 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
221 struct TCP_Server_Info *,
222 struct smb_rqst *);
223 /* setup async request: allocate mid, sign message */
224 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
225 struct smb_rqst *);
226 /* check response: verify signature, map error */
227 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
228 bool);
229 void (*add_credits)(struct TCP_Server_Info *server,
230 const struct cifs_credits *credits,
231 const int optype);
232 void (*set_credits)(struct TCP_Server_Info *, const int);
233 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
234 unsigned int (*get_credits)(struct mid_q_entry *);
235 __u64 (*get_next_mid)(struct TCP_Server_Info *);
236 void (*revert_current_mid)(struct TCP_Server_Info *server,
237 const unsigned int val);
238 /* data offset from read response message */
239 unsigned int (*read_data_offset)(char *);
240 /*
241 * Data length from read response message
242 * When in_remaining is true, the returned data length is in
243 * message field DataRemaining for out-of-band data read (e.g through
244 * Memory Registration RDMA write in SMBD).
245 * Otherwise, the returned data length is in message field DataLength.
246 */
247 unsigned int (*read_data_length)(char *, bool in_remaining);
248 /* map smb to linux error */
249 int (*map_error)(char *, bool);
250 /* find mid corresponding to the response message */
251 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
252 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
253 void (*clear_stats)(struct cifs_tcon *);
254 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
255 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
256 /* verify the message */
257 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
258 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
259 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
260 void (*downgrade_oplock)(struct TCP_Server_Info *server,
261 struct cifsInodeInfo *cinode, __u32 oplock,
262 unsigned int epoch, bool *purge_cache);
263 /* process transaction2 response */
264 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
265 char *, int);
266 /* check if we need to negotiate */
267 bool (*need_neg)(struct TCP_Server_Info *);
268 /* negotiate to the server */
269 int (*negotiate)(const unsigned int, struct cifs_ses *);
270 /* set negotiated write size */
271 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
272 /* set negotiated read size */
273 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
274 /* setup smb sessionn */
275 int (*sess_setup)(const unsigned int, struct cifs_ses *,
276 const struct nls_table *);
277 /* close smb session */
278 int (*logoff)(const unsigned int, struct cifs_ses *);
279 /* connect to a server share */
280 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
281 struct cifs_tcon *, const struct nls_table *);
282 /* close tree connecion */
283 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
284 /* get DFS referrals */
285 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
286 const char *, struct dfs_info3_param **,
287 unsigned int *, const struct nls_table *, int);
288 /* informational QFS call */
289 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *,
290 struct cifs_sb_info *);
291 /* check if a path is accessible or not */
292 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
293 struct cifs_sb_info *, const char *);
294 /* query path data from the server */
295 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
296 struct cifs_sb_info *, const char *,
297 FILE_ALL_INFO *, bool *, bool *);
298 /* query file data from the server */
299 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
300 struct cifs_fid *, FILE_ALL_INFO *);
301 /* query reparse tag from srv to determine which type of special file */
302 int (*query_reparse_tag)(const unsigned int xid, struct cifs_tcon *tcon,
303 struct cifs_sb_info *cifs_sb, const char *path,
304 __u32 *reparse_tag);
305 /* get server index number */
306 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
307 struct cifs_sb_info *, const char *,
308 u64 *uniqueid, FILE_ALL_INFO *);
309 /* set size by path */
310 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
311 const char *, __u64, struct cifs_sb_info *, bool);
312 /* set size by file handle */
313 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
314 struct cifsFileInfo *, __u64, bool);
315 /* set attributes */
316 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
317 const unsigned int);
318 int (*set_compression)(const unsigned int, struct cifs_tcon *,
319 struct cifsFileInfo *);
320 /* check if we can send an echo or nor */
321 bool (*can_echo)(struct TCP_Server_Info *);
322 /* send echo request */
323 int (*echo)(struct TCP_Server_Info *);
324 /* create directory */
325 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
326 umode_t mode, struct cifs_tcon *tcon,
327 const char *full_path,
328 struct cifs_sb_info *cifs_sb);
329 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
330 struct cifs_tcon *tcon, const char *name,
331 struct cifs_sb_info *sb);
332 /* set info on created directory */
333 void (*mkdir_setinfo)(struct inode *, const char *,
334 struct cifs_sb_info *, struct cifs_tcon *,
335 const unsigned int);
336 /* remove directory */
337 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
338 struct cifs_sb_info *);
339 /* unlink file */
340 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
341 struct cifs_sb_info *);
342 /* open, rename and delete file */
343 int (*rename_pending_delete)(const char *, struct dentry *,
344 const unsigned int);
345 /* send rename request */
346 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
347 const char *, struct cifs_sb_info *);
348 /* send create hardlink request */
349 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
350 const char *, const char *,
351 struct cifs_sb_info *);
352 /* query symlink target */
353 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
354 struct cifs_sb_info *, const char *,
355 char **, bool);
356 /* open a file for non-posix mounts */
357 int (*open)(const unsigned int, struct cifs_open_parms *,
358 __u32 *, FILE_ALL_INFO *);
359 /* set fid protocol-specific info */
360 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
361 /* close a file */
362 void (*close)(const unsigned int, struct cifs_tcon *,
363 struct cifs_fid *);
364 /* close a file, returning file attributes and timestamps */
365 void (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon,
366 struct cifsFileInfo *pfile_info);
367 /* send a flush request to the server */
368 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
369 /* async read from the server */
370 int (*async_readv)(struct cifs_readdata *);
371 /* async write to the server */
372 int (*async_writev)(struct cifs_writedata *,
373 void (*release)(struct kref *));
374 /* sync read from the server */
375 int (*sync_read)(const unsigned int, struct cifs_fid *,
376 struct cifs_io_parms *, unsigned int *, char **,
377 int *);
378 /* sync write to the server */
379 int (*sync_write)(const unsigned int, struct cifs_fid *,
380 struct cifs_io_parms *, unsigned int *, struct kvec *,
381 unsigned long);
382 /* open dir, start readdir */
383 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
384 const char *, struct cifs_sb_info *,
385 struct cifs_fid *, __u16,
386 struct cifs_search_info *);
387 /* continue readdir */
388 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
389 struct cifs_fid *,
390 __u16, struct cifs_search_info *srch_inf);
391 /* close dir */
392 int (*close_dir)(const unsigned int, struct cifs_tcon *,
393 struct cifs_fid *);
394 /* calculate a size of SMB message */
395 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
396 /* check for STATUS_PENDING and process the response if yes */
397 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
398 /* check for STATUS_NETWORK_SESSION_EXPIRED */
399 bool (*is_session_expired)(char *);
400 /* send oplock break response */
401 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
402 struct cifsInodeInfo *);
403 /* query remote filesystem */
404 int (*queryfs)(const unsigned int, struct cifs_tcon *,
405 struct cifs_sb_info *, struct kstatfs *);
406 /* send mandatory brlock to the server */
407 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
408 __u64, __u32, int, int, bool);
409 /* unlock range of mandatory locks */
410 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
411 const unsigned int);
412 /* push brlocks from the cache to the server */
413 int (*push_mand_locks)(struct cifsFileInfo *);
414 /* get lease key of the inode */
415 void (*get_lease_key)(struct inode *, struct cifs_fid *);
416 /* set lease key of the inode */
417 void (*set_lease_key)(struct inode *, struct cifs_fid *);
418 /* generate new lease key */
419 void (*new_lease_key)(struct cifs_fid *);
420 int (*generate_signingkey)(struct cifs_ses *);
421 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *,
422 bool allocate_crypto);
423 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
424 struct cifsFileInfo *src_file);
425 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
426 struct cifsFileInfo *src_file, void __user *);
427 int (*notify)(const unsigned int xid, struct file *pfile,
428 void __user *pbuf);
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,
468 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);
473 /* 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 *);
486 /* ioctl passthrough for query_info */
487 int (*ioctl_query_info)(const unsigned int xid,
488 struct cifs_tcon *tcon,
489 struct cifs_sb_info *cifs_sb,
490 __le16 *path, int is_dir,
491 unsigned long p);
492 /* make unix special files (block, char, fifo, socket) */
493 int (*make_node)(unsigned int xid,
494 struct inode *inode,
495 struct dentry *dentry,
496 struct cifs_tcon *tcon,
497 char *full_path,
498 umode_t mode,
499 dev_t device_number);
500 /* version specific fiemap implementation */
501 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
502 struct fiemap_extent_info *, u64, u64);
503 /* version specific llseek implementation */
504 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
505 /* Check for STATUS_IO_TIMEOUT */
506 bool (*is_status_io_timeout)(char *buf);
507 };
508
509 struct smb_version_values {
510 char *version_string;
511 __u16 protocol_id;
512 __u32 req_capabilities;
513 __u32 large_lock_type;
514 __u32 exclusive_lock_type;
515 __u32 shared_lock_type;
516 __u32 unlock_lock_type;
517 size_t header_preamble_size;
518 size_t header_size;
519 size_t max_header_size;
520 size_t read_rsp_size;
521 __le16 lock_cmd;
522 unsigned int cap_unix;
523 unsigned int cap_nt_find;
524 unsigned int cap_large_files;
525 __u16 signing_enabled;
526 __u16 signing_required;
527 size_t create_lease_size;
528 };
529
530 #define HEADER_SIZE(server) (server->vals->header_size)
531 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
532
533 struct smb_vol {
534 char *username;
535 char *password;
536 char *domainname;
537 char *UNC;
538 char *iocharset; /* local code page for mapping to and from Unicode */
539 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
540 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
541 kuid_t cred_uid;
542 kuid_t linux_uid;
543 kgid_t linux_gid;
544 kuid_t backupuid;
545 kgid_t backupgid;
546 umode_t file_mode;
547 umode_t dir_mode;
548 enum securityEnum sectype; /* sectype requested via mnt opts */
549 bool sign; /* was signing requested via mnt opts? */
550 bool ignore_signature:1;
551 bool retry:1;
552 bool intr:1;
553 bool setuids:1;
554 bool setuidfromacl:1;
555 bool override_uid:1;
556 bool override_gid:1;
557 bool dynperm:1;
558 bool noperm:1;
559 bool nodelete:1;
560 bool mode_ace:1;
561 bool no_psx_acl:1; /* set if posix acl support should be disabled */
562 bool cifs_acl:1;
563 bool backupuid_specified; /* mount option backupuid is specified */
564 bool backupgid_specified; /* mount option backupgid is specified */
565 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
566 bool server_ino:1; /* use inode numbers from server ie UniqueId */
567 bool direct_io:1;
568 bool strict_io:1; /* strict cache behavior */
569 bool cache_ro:1;
570 bool cache_rw:1;
571 bool remap:1; /* set to remap seven reserved chars in filenames */
572 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
573 bool posix_paths:1; /* unset to not ask for posix pathnames. */
574 bool no_linux_ext:1;
575 bool linux_ext:1;
576 bool sfu_emul:1;
577 bool nullauth:1; /* attempt to authenticate with null user */
578 bool nocase:1; /* request case insensitive filenames */
579 bool nobrl:1; /* disable sending byte range locks to srv */
580 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
581 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
582 bool seal:1; /* request transport encryption on share */
583 bool nodfs:1; /* Do not request DFS, even if available */
584 bool local_lease:1; /* check leases only on local system, not remote */
585 bool noblocksnd:1;
586 bool noautotune:1;
587 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
588 bool no_lease:1; /* disable requesting leases */
589 bool fsc:1; /* enable fscache */
590 bool mfsymlinks:1; /* use Minshall+French Symlinks */
591 bool multiuser:1;
592 bool rwpidforward:1; /* pid forward for read/write operations */
593 bool nosharesock:1;
594 bool persistent:1;
595 bool nopersistent:1;
596 bool resilient:1; /* noresilient not required since not fored for CA */
597 bool domainauto:1;
598 bool rdma:1;
599 bool multichannel:1;
600 bool use_client_guid:1;
601 /* reuse existing guid for multichannel */
602 u8 client_guid[SMB2_CLIENT_GUID_SIZE];
603 unsigned int bsize;
604 unsigned int rsize;
605 unsigned int wsize;
606 unsigned int min_offload;
607 bool sockopt_tcp_nodelay:1;
608 unsigned long actimeo; /* attribute cache timeout (jiffies) */
609 struct smb_version_operations *ops;
610 struct smb_version_values *vals;
611 char *prepath;
612 struct sockaddr_storage dstaddr; /* destination address */
613 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
614 struct nls_table *local_nls;
615 unsigned int echo_interval; /* echo interval in secs */
616 __u64 snapshot_time; /* needed for timewarp tokens */
617 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
618 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
619 unsigned int max_channels;
620 __u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
621 bool rootfs:1; /* if it's a SMB root file system */
622 };
623
624 /**
625 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
626 * trying to reuse existing superblock for a new mount
627 */
628 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
629 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
630 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
631 CIFS_MOUNT_MAP_SFM_CHR | \
632 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
633 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
634 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
635 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
636 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
637 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
638 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
639 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
640 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
641 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
642
643 /**
644 * Generic VFS superblock mount flags (s_flags) to consider when
645 * trying to reuse existing superblock for a new mount
646 */
647 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
648 SB_NODEV | SB_SYNCHRONOUS)
649
650 struct cifs_mnt_data {
651 struct cifs_sb_info *cifs_sb;
652 struct smb_vol *vol;
653 int flags;
654 };
655
656 static inline unsigned int
get_rfc1002_length(void * buf)657 get_rfc1002_length(void *buf)
658 {
659 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
660 }
661
662 static inline void
inc_rfc1001_len(void * buf,int count)663 inc_rfc1001_len(void *buf, int count)
664 {
665 be32_add_cpu((__be32 *)buf, count);
666 }
667
668 struct TCP_Server_Info {
669 struct list_head tcp_ses_list;
670 struct list_head smb_ses_list;
671 int srv_count; /* reference counter */
672 /* 15 character server name + 0x20 16th byte indicating type = srv */
673 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
674 struct smb_version_operations *ops;
675 struct smb_version_values *vals;
676 enum statusEnum tcpStatus; /* what we think the status is */
677 char *hostname; /* hostname portion of UNC string */
678 struct socket *ssocket;
679 struct sockaddr_storage dstaddr;
680 struct sockaddr_storage srcaddr; /* locally bind to this IP */
681 #ifdef CONFIG_NET_NS
682 struct net *net;
683 #endif
684 wait_queue_head_t response_q;
685 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
686 struct list_head pending_mid_q;
687 bool noblocksnd; /* use blocking sendmsg */
688 bool noautotune; /* do not autotune send buf sizes */
689 bool tcp_nodelay;
690 unsigned int credits; /* send no more requests at once */
691 unsigned int max_credits; /* can override large 32000 default at mnt */
692 unsigned int in_flight; /* number of requests on the wire to server */
693 unsigned int max_in_flight; /* max number of requests that were on wire */
694 spinlock_t req_lock; /* protect the two values above */
695 struct mutex srv_mutex;
696 struct task_struct *tsk;
697 char server_GUID[16];
698 __u16 sec_mode;
699 bool sign; /* is signing enabled on this connection? */
700 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
701 bool session_estab; /* mark when very first sess is established */
702 int echo_credits; /* echo reserved slots */
703 int oplock_credits; /* oplock break reserved slots */
704 bool echoes:1; /* enable echoes */
705 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
706 u16 dialect; /* dialect index that server chose */
707 bool oplocks:1; /* enable oplocks */
708 unsigned int maxReq; /* Clients should submit no more */
709 /* than maxReq distinct unanswered SMBs to the server when using */
710 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
711 unsigned int maxBuf; /* maxBuf specifies the maximum */
712 /* message size the server can send or receive for non-raw SMBs */
713 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
714 /* when socket is setup (and during reconnect) before NegProt sent */
715 unsigned int max_rw; /* maxRw specifies the maximum */
716 /* message size the server can send or receive for */
717 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
718 unsigned int capabilities; /* selective disabling of caps by smb sess */
719 int timeAdj; /* Adjust for difference in server time zone in sec */
720 __u64 CurrentMid; /* multiplex id - rotating counter */
721 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
722 /* 16th byte of RFC1001 workstation name is always null */
723 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
724 __u32 sequence_number; /* for signing, protected by srv_mutex */
725 __u32 reconnect_instance; /* incremented on each reconnect */
726 struct session_key session_key;
727 unsigned long lstrp; /* when we got last response from this server */
728 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
729 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
730 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
731 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
732 char negflavor; /* NEGOTIATE response flavor */
733 /* extended security flavors that server supports */
734 bool sec_ntlmssp; /* supports NTLMSSP */
735 bool sec_kerberosu2u; /* supports U2U Kerberos */
736 bool sec_kerberos; /* supports plain Kerberos */
737 bool sec_mskerberos; /* supports legacy MS Kerberos */
738 bool large_buf; /* is current buffer large? */
739 /* use SMBD connection instead of socket */
740 bool rdma;
741 /* point to the SMBD connection if RDMA is used instead of socket */
742 struct smbd_connection *smbd_conn;
743 struct delayed_work echo; /* echo ping workqueue job */
744 char *smallbuf; /* pointer to current "small" buffer */
745 char *bigbuf; /* pointer to current "big" buffer */
746 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
747 unsigned int pdu_size;
748 unsigned int total_read; /* total amount of data read in this pass */
749 atomic_t in_send; /* requests trying to send */
750 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
751 #ifdef CONFIG_CIFS_FSCACHE
752 struct fscache_cookie *fscache; /* client index cache cookie */
753 #endif
754 #ifdef CONFIG_CIFS_STATS2
755 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
756 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
757 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
758 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
759 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
760 #endif /* STATS2 */
761 unsigned int max_read;
762 unsigned int max_write;
763 unsigned int min_offload;
764 __le16 compress_algorithm;
765 __le16 cipher_type;
766 /* save initital negprot hash */
767 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
768 bool posix_ext_supported;
769 struct delayed_work reconnect; /* reconnect workqueue job */
770 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
771 unsigned long echo_interval;
772
773 /*
774 * Number of targets available for reconnect. The more targets
775 * the more tasks have to wait to let the demultiplex thread
776 * reconnect.
777 */
778 int nr_targets;
779 bool noblockcnt; /* use non-blocking connect() */
780 bool is_channel; /* if a session channel */
781 };
782
783 struct cifs_credits {
784 unsigned int value;
785 unsigned int instance;
786 };
787
788 static inline unsigned int
in_flight(struct TCP_Server_Info * server)789 in_flight(struct TCP_Server_Info *server)
790 {
791 unsigned int num;
792 spin_lock(&server->req_lock);
793 num = server->in_flight;
794 spin_unlock(&server->req_lock);
795 return num;
796 }
797
798 static inline bool
has_credits(struct TCP_Server_Info * server,int * credits,int num_credits)799 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
800 {
801 int num;
802 spin_lock(&server->req_lock);
803 num = *credits;
804 spin_unlock(&server->req_lock);
805 return num >= num_credits;
806 }
807
808 static inline void
add_credits(struct TCP_Server_Info * server,const struct cifs_credits * credits,const int optype)809 add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
810 const int optype)
811 {
812 server->ops->add_credits(server, credits, optype);
813 }
814
815 static inline void
add_credits_and_wake_if(struct TCP_Server_Info * server,const struct cifs_credits * credits,const int optype)816 add_credits_and_wake_if(struct TCP_Server_Info *server,
817 const struct cifs_credits *credits, const int optype)
818 {
819 if (credits->value) {
820 server->ops->add_credits(server, credits, optype);
821 wake_up(&server->request_q);
822 }
823 }
824
825 static inline void
set_credits(struct TCP_Server_Info * server,const int val)826 set_credits(struct TCP_Server_Info *server, const int val)
827 {
828 server->ops->set_credits(server, val);
829 }
830
831 static inline int
adjust_credits(struct TCP_Server_Info * server,struct cifs_credits * credits,const unsigned int payload_size)832 adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
833 const unsigned int payload_size)
834 {
835 return server->ops->adjust_credits ?
836 server->ops->adjust_credits(server, credits, payload_size) : 0;
837 }
838
839 static inline __le64
get_next_mid64(struct TCP_Server_Info * server)840 get_next_mid64(struct TCP_Server_Info *server)
841 {
842 return cpu_to_le64(server->ops->get_next_mid(server));
843 }
844
845 static inline __le16
get_next_mid(struct TCP_Server_Info * server)846 get_next_mid(struct TCP_Server_Info *server)
847 {
848 __u16 mid = server->ops->get_next_mid(server);
849 /*
850 * The value in the SMB header should be little endian for easy
851 * on-the-wire decoding.
852 */
853 return cpu_to_le16(mid);
854 }
855
856 static inline void
revert_current_mid(struct TCP_Server_Info * server,const unsigned int val)857 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
858 {
859 if (server->ops->revert_current_mid)
860 server->ops->revert_current_mid(server, val);
861 }
862
863 static inline void
revert_current_mid_from_hdr(struct TCP_Server_Info * server,const struct smb2_sync_hdr * shdr)864 revert_current_mid_from_hdr(struct TCP_Server_Info *server,
865 const struct smb2_sync_hdr *shdr)
866 {
867 unsigned int num = le16_to_cpu(shdr->CreditCharge);
868
869 return revert_current_mid(server, num > 0 ? num : 1);
870 }
871
872 static inline __u16
get_mid(const struct smb_hdr * smb)873 get_mid(const struct smb_hdr *smb)
874 {
875 return le16_to_cpu(smb->Mid);
876 }
877
878 static inline bool
compare_mid(__u16 mid,const struct smb_hdr * smb)879 compare_mid(__u16 mid, const struct smb_hdr *smb)
880 {
881 return mid == le16_to_cpu(smb->Mid);
882 }
883
884 /*
885 * When the server supports very large reads and writes via POSIX extensions,
886 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
887 * including the RFC1001 length.
888 *
889 * Note that this might make for "interesting" allocation problems during
890 * writeback however as we have to allocate an array of pointers for the
891 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
892 *
893 * For reads, there is a similar problem as we need to allocate an array
894 * of kvecs to handle the receive, though that should only need to be done
895 * once.
896 */
897 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
898 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
899
900 /*
901 * When the server doesn't allow large posix writes, only allow a rsize/wsize
902 * of 2^17-1 minus the size of the call header. That allows for a read or
903 * write up to the maximum size described by RFC1002.
904 */
905 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
906 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
907
908 /*
909 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
910 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
911 * a single wsize request with a single call.
912 */
913 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
914 #define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
915
916 /*
917 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
918 * those values when posix extensions aren't in force. In actuality here, we
919 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
920 * to be ok with the extra byte even though Windows doesn't send writes that
921 * are that large.
922 *
923 * Citation:
924 *
925 * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
926 */
927 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
928 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
929
930 /*
931 * Macros to allow the TCP_Server_Info->net field and related code to drop out
932 * when CONFIG_NET_NS isn't set.
933 */
934
935 #ifdef CONFIG_NET_NS
936
cifs_net_ns(struct TCP_Server_Info * srv)937 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
938 {
939 return srv->net;
940 }
941
cifs_set_net_ns(struct TCP_Server_Info * srv,struct net * net)942 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
943 {
944 srv->net = net;
945 }
946
947 #else
948
cifs_net_ns(struct TCP_Server_Info * srv)949 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
950 {
951 return &init_net;
952 }
953
cifs_set_net_ns(struct TCP_Server_Info * srv,struct net * net)954 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
955 {
956 }
957
958 #endif
959
960 struct cifs_server_iface {
961 size_t speed;
962 unsigned int rdma_capable : 1;
963 unsigned int rss_capable : 1;
964 struct sockaddr_storage sockaddr;
965 };
966
967 struct cifs_chan {
968 struct TCP_Server_Info *server;
969 __u8 signkey[SMB3_SIGN_KEY_SIZE];
970 };
971
972 /*
973 * Session structure. One of these for each uid session with a particular host
974 */
975 struct cifs_ses {
976 struct list_head smb_ses_list;
977 struct list_head tcon_list;
978 struct cifs_tcon *tcon_ipc;
979 struct mutex session_mutex;
980 struct TCP_Server_Info *server; /* pointer to server info */
981 int ses_count; /* reference counter */
982 enum statusEnum status;
983 unsigned overrideSecFlg; /* if non-zero override global sec flags */
984 char *serverOS; /* name of operating system underlying server */
985 char *serverNOS; /* name of network operating system of server */
986 char *serverDomain; /* security realm of server */
987 __u64 Suid; /* remote smb uid */
988 kuid_t linux_uid; /* overriding owner of files on the mount */
989 kuid_t cred_uid; /* owner of credentials */
990 unsigned int capabilities;
991 char serverName[SERVER_NAME_LEN_WITH_NULL];
992 char *user_name; /* must not be null except during init of sess
993 and after mount option parsing we fill it */
994 char *domainName;
995 char *password;
996 struct session_key auth_key;
997 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
998 enum securityEnum sectype; /* what security flavor was specified? */
999 bool sign; /* is signing required? */
1000 bool need_reconnect:1; /* connection reset, uid now invalid */
1001 bool domainAuto:1;
1002 bool binding:1; /* are we binding the session? */
1003 __u16 session_flags;
1004 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
1005 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
1006 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
1007 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1008
1009 __u8 binding_preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
1010
1011 /*
1012 * Network interfaces available on the server this session is
1013 * connected to.
1014 *
1015 * Other channels can be opened by connecting and binding this
1016 * session to interfaces from this list.
1017 *
1018 * iface_lock should be taken when accessing any of these fields
1019 */
1020 spinlock_t iface_lock;
1021 struct cifs_server_iface *iface_list;
1022 size_t iface_count;
1023 unsigned long iface_last_update; /* jiffies */
1024
1025 #define CIFS_MAX_CHANNELS 16
1026 struct cifs_chan chans[CIFS_MAX_CHANNELS];
1027 struct cifs_chan *binding_chan;
1028 size_t chan_count;
1029 size_t chan_max;
1030 atomic_t chan_seq; /* round robin state */
1031 };
1032
1033 /*
1034 * When binding a new channel, we need to access the channel which isn't fully
1035 * established yet.
1036 */
1037
1038 static inline
cifs_ses_binding_channel(struct cifs_ses * ses)1039 struct cifs_chan *cifs_ses_binding_channel(struct cifs_ses *ses)
1040 {
1041 if (ses->binding)
1042 return ses->binding_chan;
1043 else
1044 return NULL;
1045 }
1046
1047 /*
1048 * Returns the server pointer of the session. When binding a new
1049 * channel this returns the last channel which isn't fully established
1050 * yet.
1051 *
1052 * This function should be use for negprot/sess.setup codepaths. For
1053 * the other requests see cifs_pick_channel().
1054 */
1055 static inline
cifs_ses_server(struct cifs_ses * ses)1056 struct TCP_Server_Info *cifs_ses_server(struct cifs_ses *ses)
1057 {
1058 if (ses->binding)
1059 return ses->binding_chan->server;
1060 else
1061 return ses->server;
1062 }
1063
1064 static inline bool
cap_unix(struct cifs_ses * ses)1065 cap_unix(struct cifs_ses *ses)
1066 {
1067 return ses->server->vals->cap_unix & ses->capabilities;
1068 }
1069
1070 struct cached_fid {
1071 bool is_valid:1; /* Do we have a useable root fid */
1072 bool file_all_info_is_valid:1;
1073 bool has_lease:1;
1074 struct kref refcount;
1075 struct cifs_fid *fid;
1076 struct mutex fid_mutex;
1077 struct cifs_tcon *tcon;
1078 struct work_struct lease_break;
1079 struct smb2_file_all_info file_all_info;
1080 };
1081
1082 /*
1083 * there is one of these for each connection to a resource on a particular
1084 * session
1085 */
1086 struct cifs_tcon {
1087 struct list_head tcon_list;
1088 int tc_count;
1089 struct list_head rlist; /* reconnect list */
1090 atomic_t num_local_opens; /* num of all opens including disconnected */
1091 atomic_t num_remote_opens; /* num of all network opens on server */
1092 struct list_head openFileList;
1093 spinlock_t open_file_lock; /* protects list above */
1094 struct cifs_ses *ses; /* pointer to session associated with */
1095 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
1096 char *nativeFileSystem;
1097 char *password; /* for share-level security */
1098 __u32 tid; /* The 4 byte tree id */
1099 __u16 Flags; /* optional support bits */
1100 enum statusEnum tidStatus;
1101 atomic_t num_smbs_sent;
1102 union {
1103 struct {
1104 atomic_t num_writes;
1105 atomic_t num_reads;
1106 atomic_t num_flushes;
1107 atomic_t num_oplock_brks;
1108 atomic_t num_opens;
1109 atomic_t num_closes;
1110 atomic_t num_deletes;
1111 atomic_t num_mkdirs;
1112 atomic_t num_posixopens;
1113 atomic_t num_posixmkdirs;
1114 atomic_t num_rmdirs;
1115 atomic_t num_renames;
1116 atomic_t num_t2renames;
1117 atomic_t num_ffirst;
1118 atomic_t num_fnext;
1119 atomic_t num_fclose;
1120 atomic_t num_hardlinks;
1121 atomic_t num_symlinks;
1122 atomic_t num_locks;
1123 atomic_t num_acl_get;
1124 atomic_t num_acl_set;
1125 } cifs_stats;
1126 struct {
1127 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1128 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1129 } smb2_stats;
1130 } stats;
1131 __u64 bytes_read;
1132 __u64 bytes_written;
1133 spinlock_t stat_lock; /* protects the two fields above */
1134 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
1135 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
1136 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
1137 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1138 bool pipe:1; /* set if connection to pipe share */
1139 bool print:1; /* set if connection to printer share */
1140 bool retry:1;
1141 bool nocase:1;
1142 bool nohandlecache:1; /* if strange server resource prob can turn off */
1143 bool nodelete:1;
1144 bool seal:1; /* transport encryption for this mounted share */
1145 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
1146 for this mount even if server would support */
1147 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
1148 bool local_lease:1; /* check leases (only) on local system not remote */
1149 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
1150 bool broken_sparse_sup; /* if server or share does not support sparse */
1151 bool need_reconnect:1; /* connection reset, tid now invalid */
1152 bool need_reopen_files:1; /* need to reopen tcon file handles */
1153 bool use_resilient:1; /* use resilient instead of durable handles */
1154 bool use_persistent:1; /* use persistent instead of durable handles */
1155 bool no_lease:1; /* Do not request leases on files or directories */
1156 __le32 capabilities;
1157 __u32 share_flags;
1158 __u32 maximal_access;
1159 __u32 vol_serial_number;
1160 __le64 vol_create_time;
1161 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
1162 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
1163 __u32 ss_flags; /* sector size flags */
1164 __u32 perf_sector_size; /* best sector size for perf */
1165 __u32 max_chunks;
1166 __u32 max_bytes_chunk;
1167 __u32 max_bytes_copy;
1168 #ifdef CONFIG_CIFS_FSCACHE
1169 u64 resource_id; /* server resource id */
1170 struct fscache_cookie *fscache; /* cookie for share */
1171 #endif
1172 struct list_head pending_opens; /* list of incomplete opens */
1173 struct cached_fid crfid; /* Cached root fid */
1174 /* BB add field for back pointer to sb struct(s)? */
1175 #ifdef CONFIG_CIFS_DFS_UPCALL
1176 char *dfs_path;
1177 int remap:2;
1178 struct list_head ulist; /* cache update list */
1179 #endif
1180 };
1181
1182 /*
1183 * This is a refcounted and timestamped container for a tcon pointer. The
1184 * container holds a tcon reference. It is considered safe to free one of
1185 * these when the tl_count goes to 0. The tl_time is the time of the last
1186 * "get" on the container.
1187 */
1188 struct tcon_link {
1189 struct rb_node tl_rbnode;
1190 kuid_t tl_uid;
1191 unsigned long tl_flags;
1192 #define TCON_LINK_MASTER 0
1193 #define TCON_LINK_PENDING 1
1194 #define TCON_LINK_IN_TREE 2
1195 unsigned long tl_time;
1196 atomic_t tl_count;
1197 struct cifs_tcon *tl_tcon;
1198 };
1199
1200 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
1201 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
1202
1203 static inline struct cifs_tcon *
tlink_tcon(struct tcon_link * tlink)1204 tlink_tcon(struct tcon_link *tlink)
1205 {
1206 return tlink->tl_tcon;
1207 }
1208
1209 static inline struct tcon_link *
cifs_sb_master_tlink(struct cifs_sb_info * cifs_sb)1210 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1211 {
1212 return cifs_sb->master_tlink;
1213 }
1214
1215 extern void cifs_put_tlink(struct tcon_link *tlink);
1216
1217 static inline struct tcon_link *
cifs_get_tlink(struct tcon_link * tlink)1218 cifs_get_tlink(struct tcon_link *tlink)
1219 {
1220 if (tlink && !IS_ERR(tlink))
1221 atomic_inc(&tlink->tl_count);
1222 return tlink;
1223 }
1224
1225 /* This function is always expected to succeed */
1226 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
1227
1228 #define CIFS_OPLOCK_NO_CHANGE 0xfe
1229
1230 struct cifs_pending_open {
1231 struct list_head olist;
1232 struct tcon_link *tlink;
1233 __u8 lease_key[16];
1234 __u32 oplock;
1235 };
1236
1237 /*
1238 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1239 * This is used to track byte stream locks on the file
1240 */
1241 struct cifsLockInfo {
1242 struct list_head llist; /* pointer to next cifsLockInfo */
1243 struct list_head blist; /* pointer to locks blocked on this */
1244 wait_queue_head_t block_q;
1245 __u64 offset;
1246 __u64 length;
1247 __u32 pid;
1248 __u16 type;
1249 __u16 flags;
1250 };
1251
1252 /*
1253 * One of these for each open instance of a file
1254 */
1255 struct cifs_search_info {
1256 loff_t index_of_last_entry;
1257 __u16 entries_in_buffer;
1258 __u16 info_level;
1259 __u32 resume_key;
1260 char *ntwrk_buf_start;
1261 char *srch_entries_start;
1262 char *last_entry;
1263 const char *presume_name;
1264 unsigned int resume_name_len;
1265 bool endOfSearch:1;
1266 bool emptyDir:1;
1267 bool unicode:1;
1268 bool smallBuf:1; /* so we know which buf_release function to call */
1269 };
1270
1271 #define ACL_NO_MODE ((umode_t)(-1))
1272 struct cifs_open_parms {
1273 struct cifs_tcon *tcon;
1274 struct cifs_sb_info *cifs_sb;
1275 int disposition;
1276 int desired_access;
1277 int create_options;
1278 const char *path;
1279 struct cifs_fid *fid;
1280 umode_t mode;
1281 bool reconnect:1;
1282 };
1283
1284 struct cifs_fid {
1285 __u16 netfid;
1286 __u64 persistent_fid; /* persist file id for smb2 */
1287 __u64 volatile_fid; /* volatile file id for smb2 */
1288 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
1289 __u8 create_guid[16];
1290 __u32 access;
1291 struct cifs_pending_open *pending_open;
1292 unsigned int epoch;
1293 #ifdef CONFIG_CIFS_DEBUG2
1294 __u64 mid;
1295 #endif /* CIFS_DEBUG2 */
1296 bool purge_cache;
1297 };
1298
1299 struct cifs_fid_locks {
1300 struct list_head llist;
1301 struct cifsFileInfo *cfile; /* fid that owns locks */
1302 struct list_head locks; /* locks held by fid above */
1303 };
1304
1305 struct cifsFileInfo {
1306 /* following two lists are protected by tcon->open_file_lock */
1307 struct list_head tlist; /* pointer to next fid owned by tcon */
1308 struct list_head flist; /* next fid (file instance) for this inode */
1309 /* lock list below protected by cifsi->lock_sem */
1310 struct cifs_fid_locks *llist; /* brlocks held by this fid */
1311 kuid_t uid; /* allows finding which FileInfo structure */
1312 __u32 pid; /* process id who opened file */
1313 struct cifs_fid fid; /* file id from remote */
1314 struct list_head rlist; /* reconnect list */
1315 /* BB add lock scope info here if needed */ ;
1316 /* lock scope id (0 if none) */
1317 struct dentry *dentry;
1318 struct tcon_link *tlink;
1319 unsigned int f_flags;
1320 bool invalidHandle:1; /* file closed via session abend */
1321 bool swapfile:1;
1322 bool oplock_break_cancelled:1;
1323 unsigned int oplock_epoch; /* epoch from the lease break */
1324 __u32 oplock_level; /* oplock/lease level from the lease break */
1325 int count;
1326 spinlock_t file_info_lock; /* protects four flag/count fields above */
1327 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1328 struct cifs_search_info srch_inf;
1329 struct work_struct oplock_break; /* work for oplock breaks */
1330 struct work_struct put; /* work for the final part of _put */
1331 };
1332
1333 struct cifs_io_parms {
1334 __u16 netfid;
1335 __u64 persistent_fid; /* persist file id for smb2 */
1336 __u64 volatile_fid; /* volatile file id for smb2 */
1337 __u32 pid;
1338 __u64 offset;
1339 unsigned int length;
1340 struct cifs_tcon *tcon;
1341 struct TCP_Server_Info *server;
1342 };
1343
1344 struct cifs_aio_ctx {
1345 struct kref refcount;
1346 struct list_head list;
1347 struct mutex aio_mutex;
1348 struct completion done;
1349 struct iov_iter iter;
1350 struct kiocb *iocb;
1351 struct cifsFileInfo *cfile;
1352 struct bio_vec *bv;
1353 loff_t pos;
1354 unsigned int npages;
1355 ssize_t rc;
1356 unsigned int len;
1357 unsigned int total_len;
1358 bool should_dirty;
1359 /*
1360 * Indicates if this aio_ctx is for direct_io,
1361 * If yes, iter is a copy of the user passed iov_iter
1362 */
1363 bool direct_io;
1364 };
1365
1366 struct cifs_readdata;
1367
1368 /* asynchronous read support */
1369 struct cifs_readdata {
1370 struct kref refcount;
1371 struct list_head list;
1372 struct completion done;
1373 struct cifsFileInfo *cfile;
1374 struct address_space *mapping;
1375 struct cifs_aio_ctx *ctx;
1376 __u64 offset;
1377 unsigned int bytes;
1378 unsigned int got_bytes;
1379 pid_t pid;
1380 int result;
1381 struct work_struct work;
1382 int (*read_into_pages)(struct TCP_Server_Info *server,
1383 struct cifs_readdata *rdata,
1384 unsigned int len);
1385 int (*copy_into_pages)(struct TCP_Server_Info *server,
1386 struct cifs_readdata *rdata,
1387 struct iov_iter *iter);
1388 struct kvec iov[2];
1389 struct TCP_Server_Info *server;
1390 #ifdef CONFIG_CIFS_SMB_DIRECT
1391 struct smbd_mr *mr;
1392 #endif
1393 unsigned int pagesz;
1394 unsigned int page_offset;
1395 unsigned int tailsz;
1396 struct cifs_credits credits;
1397 unsigned int nr_pages;
1398 struct page **pages;
1399 };
1400
1401 struct cifs_writedata;
1402
1403 /* asynchronous write support */
1404 struct cifs_writedata {
1405 struct kref refcount;
1406 struct list_head list;
1407 struct completion done;
1408 enum writeback_sync_modes sync_mode;
1409 struct work_struct work;
1410 struct cifsFileInfo *cfile;
1411 struct cifs_aio_ctx *ctx;
1412 __u64 offset;
1413 pid_t pid;
1414 unsigned int bytes;
1415 int result;
1416 struct TCP_Server_Info *server;
1417 #ifdef CONFIG_CIFS_SMB_DIRECT
1418 struct smbd_mr *mr;
1419 #endif
1420 unsigned int pagesz;
1421 unsigned int page_offset;
1422 unsigned int tailsz;
1423 struct cifs_credits credits;
1424 unsigned int nr_pages;
1425 struct page **pages;
1426 };
1427
1428 /*
1429 * Take a reference on the file private data. Must be called with
1430 * cfile->file_info_lock held.
1431 */
1432 static inline void
cifsFileInfo_get_locked(struct cifsFileInfo * cifs_file)1433 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1434 {
1435 ++cifs_file->count;
1436 }
1437
1438 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1439 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr,
1440 bool offload);
1441 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1442
1443 #define CIFS_CACHE_READ_FLG 1
1444 #define CIFS_CACHE_HANDLE_FLG 2
1445 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1446 #define CIFS_CACHE_WRITE_FLG 4
1447 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1448 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1449
1450 #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))
1451 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1452 #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))
1453
1454 /*
1455 * One of these for each file inode
1456 */
1457
1458 struct cifsInodeInfo {
1459 bool can_cache_brlcks;
1460 struct list_head llist; /* locks helb by this inode */
1461 /*
1462 * NOTE: Some code paths call down_read(lock_sem) twice, so
1463 * we must always use cifs_down_write() instead of down_write()
1464 * for this semaphore to avoid deadlocks.
1465 */
1466 struct rw_semaphore lock_sem; /* protect the fields above */
1467 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1468 struct list_head openFileList;
1469 spinlock_t open_file_lock; /* protects openFileList */
1470 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1471 unsigned int oplock; /* oplock/lease level we have */
1472 unsigned int epoch; /* used to track lease state changes */
1473 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1474 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1475 #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */
1476 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1477 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
1478 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */
1479 unsigned long flags;
1480 spinlock_t writers_lock;
1481 unsigned int writers; /* Number of writers on this inode */
1482 unsigned long time; /* jiffies of last update of inode */
1483 u64 server_eof; /* current file size on server -- protected by i_lock */
1484 u64 uniqueid; /* server inode number */
1485 u64 createtime; /* creation time on server */
1486 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1487 #ifdef CONFIG_CIFS_FSCACHE
1488 struct fscache_cookie *fscache;
1489 #endif
1490 struct inode vfs_inode;
1491 };
1492
1493 static inline struct cifsInodeInfo *
CIFS_I(struct inode * inode)1494 CIFS_I(struct inode *inode)
1495 {
1496 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1497 }
1498
1499 static inline struct cifs_sb_info *
CIFS_SB(struct super_block * sb)1500 CIFS_SB(struct super_block *sb)
1501 {
1502 return sb->s_fs_info;
1503 }
1504
1505 static inline struct cifs_sb_info *
CIFS_FILE_SB(struct file * file)1506 CIFS_FILE_SB(struct file *file)
1507 {
1508 return CIFS_SB(file_inode(file)->i_sb);
1509 }
1510
CIFS_DIR_SEP(const struct cifs_sb_info * cifs_sb)1511 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1512 {
1513 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1514 return '/';
1515 else
1516 return '\\';
1517 }
1518
1519 static inline void
convert_delimiter(char * path,char delim)1520 convert_delimiter(char *path, char delim)
1521 {
1522 char old_delim, *pos;
1523
1524 if (delim == '/')
1525 old_delim = '\\';
1526 else
1527 old_delim = '/';
1528
1529 pos = path;
1530 while ((pos = strchr(pos, old_delim)))
1531 *pos = delim;
1532 }
1533
1534 #define cifs_stats_inc atomic_inc
1535
cifs_stats_bytes_written(struct cifs_tcon * tcon,unsigned int bytes)1536 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1537 unsigned int bytes)
1538 {
1539 if (bytes) {
1540 spin_lock(&tcon->stat_lock);
1541 tcon->bytes_written += bytes;
1542 spin_unlock(&tcon->stat_lock);
1543 }
1544 }
1545
cifs_stats_bytes_read(struct cifs_tcon * tcon,unsigned int bytes)1546 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1547 unsigned int bytes)
1548 {
1549 spin_lock(&tcon->stat_lock);
1550 tcon->bytes_read += bytes;
1551 spin_unlock(&tcon->stat_lock);
1552 }
1553
1554
1555 /*
1556 * This is the prototype for the mid receive function. This function is for
1557 * receiving the rest of the SMB frame, starting with the WordCount (which is
1558 * just after the MID in struct smb_hdr). Note:
1559 *
1560 * - This will be called by cifsd, with no locks held.
1561 * - The mid will still be on the pending_mid_q.
1562 * - mid->resp_buf will point to the current buffer.
1563 *
1564 * Returns zero on a successful receive, or an error. The receive state in
1565 * the TCP_Server_Info will also be updated.
1566 */
1567 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1568 struct mid_q_entry *mid);
1569
1570 /*
1571 * This is the prototype for the mid callback function. This is called once the
1572 * mid has been received off of the socket. When creating one, take special
1573 * care to avoid deadlocks. Things to bear in mind:
1574 *
1575 * - it will be called by cifsd, with no locks held
1576 * - the mid will be removed from any lists
1577 */
1578 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1579
1580 /*
1581 * This is the protopyte for mid handle function. This is called once the mid
1582 * has been recognized after decryption of the message.
1583 */
1584 typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1585 struct mid_q_entry *mid);
1586
1587 /* one of these for every pending CIFS request to the server */
1588 struct mid_q_entry {
1589 struct list_head qhead; /* mids waiting on reply from this server */
1590 struct kref refcount;
1591 struct TCP_Server_Info *server; /* server corresponding to this mid */
1592 __u64 mid; /* multiplex id */
1593 __u16 credits; /* number of credits consumed by this mid */
1594 __u16 credits_received; /* number of credits from the response */
1595 __u32 pid; /* process id */
1596 __u32 sequence_number; /* for CIFS signing */
1597 unsigned long when_alloc; /* when mid was created */
1598 #ifdef CONFIG_CIFS_STATS2
1599 unsigned long when_sent; /* time when smb send finished */
1600 unsigned long when_received; /* when demux complete (taken off wire) */
1601 #endif
1602 mid_receive_t *receive; /* call receive callback */
1603 mid_callback_t *callback; /* call completion callback */
1604 mid_handle_t *handle; /* call handle mid callback */
1605 void *callback_data; /* general purpose pointer for callback */
1606 struct task_struct *creator;
1607 void *resp_buf; /* pointer to received SMB header */
1608 unsigned int resp_buf_size;
1609 int mid_state; /* wish this were enum but can not pass to wait_event */
1610 unsigned int mid_flags;
1611 __le16 command; /* smb command code */
1612 unsigned int optype; /* operation type */
1613 bool large_buf:1; /* if valid response, is pointer to large buf */
1614 bool multiRsp:1; /* multiple trans2 responses for one request */
1615 bool multiEnd:1; /* both received */
1616 bool decrypted:1; /* decrypted entry */
1617 };
1618
1619 struct close_cancelled_open {
1620 struct cifs_fid fid;
1621 struct cifs_tcon *tcon;
1622 struct work_struct work;
1623 __u64 mid;
1624 __u16 cmd;
1625 };
1626
1627 /* Make code in transport.c a little cleaner by moving
1628 update of optional stats into function below */
cifs_in_send_inc(struct TCP_Server_Info * server)1629 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1630 {
1631 atomic_inc(&server->in_send);
1632 }
1633
cifs_in_send_dec(struct TCP_Server_Info * server)1634 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1635 {
1636 atomic_dec(&server->in_send);
1637 }
1638
cifs_num_waiters_inc(struct TCP_Server_Info * server)1639 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1640 {
1641 atomic_inc(&server->num_waiters);
1642 }
1643
cifs_num_waiters_dec(struct TCP_Server_Info * server)1644 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1645 {
1646 atomic_dec(&server->num_waiters);
1647 }
1648
1649 #ifdef CONFIG_CIFS_STATS2
cifs_save_when_sent(struct mid_q_entry * mid)1650 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1651 {
1652 mid->when_sent = jiffies;
1653 }
1654 #else
cifs_save_when_sent(struct mid_q_entry * mid)1655 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1656 {
1657 }
1658 #endif
1659
1660 /* for pending dnotify requests */
1661 struct dir_notify_req {
1662 struct list_head lhead;
1663 __le16 Pid;
1664 __le16 PidHigh;
1665 __u16 Mid;
1666 __u16 Tid;
1667 __u16 Uid;
1668 __u16 netfid;
1669 __u32 filter; /* CompletionFilter (for multishot) */
1670 int multishot;
1671 struct file *pfile;
1672 };
1673
1674 struct dfs_info3_param {
1675 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1676 int path_consumed;
1677 int server_type;
1678 int ref_flag;
1679 char *path_name;
1680 char *node_name;
1681 int ttl;
1682 };
1683
1684 /*
1685 * common struct for holding inode info when searching for or updating an
1686 * inode with new info
1687 */
1688
1689 #define CIFS_FATTR_DFS_REFERRAL 0x1
1690 #define CIFS_FATTR_DELETE_PENDING 0x2
1691 #define CIFS_FATTR_NEED_REVAL 0x4
1692 #define CIFS_FATTR_INO_COLLISION 0x8
1693 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1694 #define CIFS_FATTR_FAKE_ROOT_INO 0x20
1695
1696 struct cifs_fattr {
1697 u32 cf_flags;
1698 u32 cf_cifsattrs;
1699 u64 cf_uniqueid;
1700 u64 cf_eof;
1701 u64 cf_bytes;
1702 u64 cf_createtime;
1703 kuid_t cf_uid;
1704 kgid_t cf_gid;
1705 umode_t cf_mode;
1706 dev_t cf_rdev;
1707 unsigned int cf_nlink;
1708 unsigned int cf_dtype;
1709 struct timespec64 cf_atime;
1710 struct timespec64 cf_mtime;
1711 struct timespec64 cf_ctime;
1712 u32 cf_cifstag;
1713 };
1714
free_dfs_info_param(struct dfs_info3_param * param)1715 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1716 {
1717 if (param) {
1718 kfree(param->path_name);
1719 kfree(param->node_name);
1720 }
1721 }
1722
free_dfs_info_array(struct dfs_info3_param * param,int number_of_items)1723 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1724 int number_of_items)
1725 {
1726 int i;
1727 if ((number_of_items == 0) || (param == NULL))
1728 return;
1729 for (i = 0; i < number_of_items; i++) {
1730 kfree(param[i].path_name);
1731 kfree(param[i].node_name);
1732 }
1733 kfree(param);
1734 }
1735
is_interrupt_error(int error)1736 static inline bool is_interrupt_error(int error)
1737 {
1738 switch (error) {
1739 case -EINTR:
1740 case -ERESTARTSYS:
1741 case -ERESTARTNOHAND:
1742 case -ERESTARTNOINTR:
1743 return true;
1744 }
1745 return false;
1746 }
1747
is_retryable_error(int error)1748 static inline bool is_retryable_error(int error)
1749 {
1750 if (is_interrupt_error(error) || error == -EAGAIN)
1751 return true;
1752 return false;
1753 }
1754
1755
1756 /* cifs_get_writable_file() flags */
1757 #define FIND_WR_ANY 0
1758 #define FIND_WR_FSUID_ONLY 1
1759 #define FIND_WR_WITH_DELETE 2
1760
1761 #define MID_FREE 0
1762 #define MID_REQUEST_ALLOCATED 1
1763 #define MID_REQUEST_SUBMITTED 2
1764 #define MID_RESPONSE_RECEIVED 4
1765 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1766 #define MID_RESPONSE_MALFORMED 0x10
1767 #define MID_SHUTDOWN 0x20
1768
1769 /* Flags */
1770 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1771 #define MID_DELETED 2 /* Mid has been dequeued/deleted */
1772
1773 /* Types of response buffer returned from SendReceive2 */
1774 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1775 #define CIFS_SMALL_BUFFER 1
1776 #define CIFS_LARGE_BUFFER 2
1777 #define CIFS_IOVEC 4 /* array of response buffers */
1778
1779 /* Type of Request to SendReceive2 */
1780 #define CIFS_BLOCKING_OP 1 /* operation can block */
1781 #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
1782 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1783 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1784 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1785 #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
1786
1787 /* Type of request operation */
1788 #define CIFS_ECHO_OP 0x080 /* echo request */
1789 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1790 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1791 #define CIFS_OP_MASK 0x0380 /* mask request type */
1792
1793 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */
1794 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
1795 #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
1796
1797 /* Security Flags: indicate type of session setup needed */
1798 #define CIFSSEC_MAY_SIGN 0x00001
1799 #define CIFSSEC_MAY_NTLM 0x00002
1800 #define CIFSSEC_MAY_NTLMV2 0x00004
1801 #define CIFSSEC_MAY_KRB5 0x00008
1802 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1803 #define CIFSSEC_MAY_LANMAN 0x00010
1804 #define CIFSSEC_MAY_PLNTXT 0x00020
1805 #else
1806 #define CIFSSEC_MAY_LANMAN 0
1807 #define CIFSSEC_MAY_PLNTXT 0
1808 #endif /* weak passwords */
1809 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1810 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1811
1812 #define CIFSSEC_MUST_SIGN 0x01001
1813 /* note that only one of the following can be set so the
1814 result of setting MUST flags more than once will be to
1815 require use of the stronger protocol */
1816 #define CIFSSEC_MUST_NTLM 0x02002
1817 #define CIFSSEC_MUST_NTLMV2 0x04004
1818 #define CIFSSEC_MUST_KRB5 0x08008
1819 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1820 #define CIFSSEC_MUST_LANMAN 0x10010
1821 #define CIFSSEC_MUST_PLNTXT 0x20020
1822 #ifdef CONFIG_CIFS_UPCALL
1823 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1824 #else
1825 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1826 #endif /* UPCALL */
1827 #else /* do not allow weak pw hash */
1828 #define CIFSSEC_MUST_LANMAN 0
1829 #define CIFSSEC_MUST_PLNTXT 0
1830 #ifdef CONFIG_CIFS_UPCALL
1831 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1832 #else
1833 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1834 #endif /* UPCALL */
1835 #endif /* WEAK_PW_HASH */
1836 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1837 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1838
1839 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1840 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1841 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1842 /*
1843 *****************************************************************
1844 * All constants go here
1845 *****************************************************************
1846 */
1847
1848 #define UID_HASH (16)
1849
1850 /*
1851 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1852 * following to be declared.
1853 */
1854
1855 /****************************************************************************
1856 * Locking notes. All updates to global variables and lists should be
1857 * protected by spinlocks or semaphores.
1858 *
1859 * Spinlocks
1860 * ---------
1861 * GlobalMid_Lock protects:
1862 * list operations on pending_mid_q and oplockQ
1863 * updates to XID counters, multiplex id and SMB sequence numbers
1864 * list operations on global DnotifyReqList
1865 * tcp_ses_lock protects:
1866 * list operations on tcp and SMB session lists
1867 * tcon->open_file_lock protects the list of open files hanging off the tcon
1868 * inode->open_file_lock protects the openFileList hanging off the inode
1869 * cfile->file_info_lock protects counters and fields in cifs file struct
1870 * f_owner.lock protects certain per file struct operations
1871 * mapping->page_lock protects certain per page operations
1872 *
1873 * Note that the cifs_tcon.open_file_lock should be taken before
1874 * not after the cifsInodeInfo.open_file_lock
1875 *
1876 * Semaphores
1877 * ----------
1878 * sesSem operations on smb session
1879 * tconSem operations on tree connection
1880 * fh_sem file handle reconnection operations
1881 *
1882 ****************************************************************************/
1883
1884 #ifdef DECLARE_GLOBALS_HERE
1885 #define GLOBAL_EXTERN
1886 #else
1887 #define GLOBAL_EXTERN extern
1888 #endif
1889
1890 /*
1891 * the list of TCP_Server_Info structures, ie each of the sockets
1892 * connecting our client to a distinct server (ip address), is
1893 * chained together by cifs_tcp_ses_list. The list of all our SMB
1894 * sessions (and from that the tree connections) can be found
1895 * by iterating over cifs_tcp_ses_list
1896 */
1897 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1898
1899 /*
1900 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1901 * tcp session, and the list of tcon's per smb session. It also protects
1902 * the reference counters for the server, smb session, and tcon. It also
1903 * protects some fields in the TCP_Server_Info struct such as dstaddr. Finally,
1904 * changes to the tcon->tidStatus should be done while holding this lock.
1905 * generally the locks should be taken in order tcp_ses_lock before
1906 * tcon->open_file_lock and that before file->file_info_lock since the
1907 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
1908 */
1909 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1910
1911 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1912 /* Outstanding dir notify requests */
1913 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1914 /* DirNotify response queue */
1915 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1916 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1917
1918 /*
1919 * Global transaction id (XID) information
1920 */
1921 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1922 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1923 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1924 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1925 /* on midQ entries */
1926 /*
1927 * Global counters, updated atomically
1928 */
1929 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1930 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1931 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1932 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1933 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1934
1935 /* Various Debug counters */
1936 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1937 #ifdef CONFIG_CIFS_STATS2
1938 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1939 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1940 extern unsigned int slow_rsp_threshold; /* number of secs before logging */
1941 #endif
1942 GLOBAL_EXTERN atomic_t smBufAllocCount;
1943 GLOBAL_EXTERN atomic_t midCount;
1944
1945 /* Misc globals */
1946 extern bool enable_oplocks; /* enable or disable oplocks */
1947 extern bool lookupCacheEnabled;
1948 extern unsigned int global_secflags; /* if on, session setup sent
1949 with more secure ntlmssp2 challenge/resp */
1950 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1951 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */
1952 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */
1953 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1954 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1955 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1956 extern unsigned int cifs_min_small; /* min size of small buf pool */
1957 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1958 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
1959
1960 GLOBAL_EXTERN struct rb_root uidtree;
1961 GLOBAL_EXTERN struct rb_root gidtree;
1962 GLOBAL_EXTERN spinlock_t siduidlock;
1963 GLOBAL_EXTERN spinlock_t sidgidlock;
1964 GLOBAL_EXTERN struct rb_root siduidtree;
1965 GLOBAL_EXTERN struct rb_root sidgidtree;
1966 GLOBAL_EXTERN spinlock_t uidsidlock;
1967 GLOBAL_EXTERN spinlock_t gidsidlock;
1968
1969 void cifs_oplock_break(struct work_struct *work);
1970 void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
1971
1972 extern const struct slow_work_ops cifs_oplock_break_ops;
1973 extern struct workqueue_struct *cifsiod_wq;
1974 extern struct workqueue_struct *decrypt_wq;
1975 extern struct workqueue_struct *fileinfo_put_wq;
1976 extern struct workqueue_struct *cifsoplockd_wq;
1977 extern __u32 cifs_lock_secret;
1978
1979 extern mempool_t *cifs_mid_poolp;
1980
1981 /* Operations for different SMB versions */
1982 #define SMB1_VERSION_STRING "1.0"
1983 extern struct smb_version_operations smb1_operations;
1984 extern struct smb_version_values smb1_values;
1985 #define SMB20_VERSION_STRING "2.0"
1986 extern struct smb_version_operations smb20_operations;
1987 extern struct smb_version_values smb20_values;
1988 #define SMB21_VERSION_STRING "2.1"
1989 extern struct smb_version_operations smb21_operations;
1990 extern struct smb_version_values smb21_values;
1991 #define SMBDEFAULT_VERSION_STRING "default"
1992 extern struct smb_version_values smbdefault_values;
1993 #define SMB3ANY_VERSION_STRING "3"
1994 extern struct smb_version_values smb3any_values;
1995 #define SMB30_VERSION_STRING "3.0"
1996 extern struct smb_version_operations smb30_operations;
1997 extern struct smb_version_values smb30_values;
1998 #define SMB302_VERSION_STRING "3.02"
1999 #define ALT_SMB302_VERSION_STRING "3.0.2"
2000 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
2001 extern struct smb_version_values smb302_values;
2002 #define SMB311_VERSION_STRING "3.1.1"
2003 #define ALT_SMB311_VERSION_STRING "3.11"
2004 extern struct smb_version_operations smb311_operations;
2005 extern struct smb_version_values smb311_values;
2006
get_security_type_str(enum securityEnum sectype)2007 static inline char *get_security_type_str(enum securityEnum sectype)
2008 {
2009 switch (sectype) {
2010 case RawNTLMSSP:
2011 return "RawNTLMSSP";
2012 case Kerberos:
2013 return "Kerberos";
2014 case NTLMv2:
2015 return "NTLMv2";
2016 case NTLM:
2017 return "NTLM";
2018 case LANMAN:
2019 return "LANMAN";
2020 default:
2021 return "Unknown";
2022 }
2023 }
2024
is_smb1_server(struct TCP_Server_Info * server)2025 static inline bool is_smb1_server(struct TCP_Server_Info *server)
2026 {
2027 return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0;
2028 }
2029
is_tcon_dfs(struct cifs_tcon * tcon)2030 static inline bool is_tcon_dfs(struct cifs_tcon *tcon)
2031 {
2032 /*
2033 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS
2034 * Subsystem Notifies That a Share Is a DFS Share.
2035 *
2036 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server
2037 * Application Updates a Share.
2038 */
2039 if (!tcon || !tcon->ses || !tcon->ses->server)
2040 return false;
2041 return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS :
2042 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT);
2043 }
2044
2045 #endif /* _CIFS_GLOB_H */
2046
