blob: 57453226469dd9cc33d745268d4372e797869917 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/cifs/cifsglob.h
3 *
Steve French366781c2008-01-25 10:12:41 +00004 * Copyright (C) International Business Machines Corp., 2002,2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Author(s): Steve French (sfrench@us.ibm.com)
Jeremy Allison7ee1af72006-08-02 21:56:33 +00006 * Jeremy Allison (jra@samba.org)
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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.
Steve Frenchd38d8c72007-06-28 19:44:13 +000017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 */
Suresh Jayaramanabd2e442010-06-22 20:52:50 +053019#ifndef _CIFS_GLOB_H
20#define _CIFS_GLOB_H
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/in.h>
23#include <linux/in6.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +040025#include <linux/mempool.h>
Tejun Heo9b646972010-07-20 22:09:02 +020026#include <linux/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include "cifs_fs_sb.h"
Steve French442aa312007-09-24 20:25:46 +000028#include "cifsacl.h"
Shirish Pargaonkard2b91522010-10-21 14:25:08 -050029#include <crypto/internal/hash.h>
30#include <linux/scatterlist.h>
Scott Lovenberg8c3a2b42013-08-09 08:47:17 -040031#include <uapi/linux/cifs/cifs_mount.h>
Pavel Shilovskyd60622e2012-05-28 15:19:39 +040032#include "smb2pdu.h"
Shirish Pargaonkard2b91522010-10-21 14:25:08 -050033
Pavel Shilovsky76ec5e32012-09-18 16:20:33 -070034#define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */
35
Ronnie Sahlberg8d8b26e2018-10-17 05:47:58 +100036#define SMB_PATH_MAX 260
Aurelien Aptele2292432018-06-14 15:43:16 +020037#define CIFS_PORT 445
38#define RFC1001_PORT 139
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040/*
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
Scott Lovenbergcdf12462013-08-09 08:47:19 -040047#define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49#define CIFS_MIN_RCV_POOL 4
50
Shirish Pargaonkar2c0c2a02012-05-21 09:20:12 -050051#define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
Suresh Jayaraman6d20e842010-12-01 14:42:28 +053053 * 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/*
Steve Frenchca567eb2019-03-29 16:31:07 -050063 * 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/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 * MAX_REQ is the maximum number of requests that WE will send
Pavel Shilovsky10b9b982012-03-20 12:55:09 +030070 * on one socket concurrently.
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 */
Pavel Shilovsky10b9b982012-03-20 12:55:09 +030072#define CIFS_MAX_REQ 32767
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Jeff Layton8ecaf672008-12-01 15:23:50 -050074#define RFC1001_NAME_LEN 15
75#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
76
Aurelien Aptelb327a712018-01-24 13:46:10 +010077/* maximum length of ip addr as a string (including ipv6 and sctp) */
78#define SERVER_NAME_LENGTH 80
Linus Torvalds1da177e2005-04-16 15:20:36 -070079#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
80
Steve Frenchadfeb3e2015-12-18 12:31:36 -060081/* 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
Pavel Shilovsky9094fad2012-07-12 18:30:44 +040085
Ronnie Sahlbergb24df3e2018-08-08 15:07:45 +100086/* maximum number of PDUs in one compound */
87#define MAX_COMPOUND 5
88
Steve French141891f2016-09-23 00:44:16 -050089/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#include "cifspdu.h"
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103#ifndef XATTR_DOS_ATTRIB
104#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
105#endif
106
107/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 * CIFS vfs client Status information (based on what we know.)
109 */
110
Steve French6c0f6212010-10-23 16:51:40 +0000111/* associated with each tcp and smb session */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112enum statusEnum {
113 CifsNew = 0,
114 CifsGood,
115 CifsExiting,
Steve Frenchfd88ce92011-04-12 01:01:14 +0000116 CifsNeedReconnect,
117 CifsNeedNegotiate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118};
119
120enum securityEnum {
Jeff Layton515d82f2013-05-26 07:00:58 -0400121 Unspecified = 0, /* not specified */
122 LANMAN, /* Legacy LANMAN auth */
Steve French39798772006-05-31 22:40:51 +0000123 NTLM, /* Legacy NTLM012 auth with NTLM hash */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
Steve Frenchac683922009-05-06 04:16:04 +0000125 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
Steve Frenchc16fefa2008-08-19 19:35:33 +0000126 Kerberos, /* Kerberos via SPNEGO */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500129struct session_key {
Steve Frenchb609f062007-07-09 07:55:14 +0000130 unsigned int len;
Shirish Pargaonkar21e73392010-10-21 06:42:55 -0500131 char *response;
Steve Frenchb609f062007-07-09 07:55:14 +0000132};
133
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500134/* crypto security descriptor definition */
135struct sdesc {
136 struct shash_desc shash;
137 char ctx[];
138};
139
Shirish Pargaonkarf7c5445a2010-10-26 18:10:24 -0500140/* crypto hashing related structure/fields, not specific to a sec mech */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500141struct cifs_secmech {
142 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
143 struct crypto_shash *md5; /* md5 hash function */
Pavel Shilovsky3c1bf7e2012-09-18 16:20:30 -0700144 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
Steve French429b46f2013-06-26 23:45:05 -0500145 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
Aurelien Aptel5fcd7f32018-02-16 19:19:28 +0100146 struct crypto_shash *sha512; /* sha512 hash function */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500147 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
148 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
Pavel Shilovsky3c1bf7e2012-09-18 16:20:30 -0700149 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
Steve French429b46f2013-06-26 23:45:05 -0500150 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
Aurelien Aptel5fcd7f32018-02-16 19:19:28 +0100151 struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */
Pavel Shilovsky026e93d2016-11-03 16:47:37 -0700152 struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */
153 struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500154};
155
Shirish Pargaonkard3686d52010-10-28 09:53:07 -0500156/* per smb session structure/fields */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500157struct ntlmssp_auth {
Shirish Pargaonkar5c234aa2013-08-29 08:35:10 -0500158 bool sesskey_per_smbsess; /* whether session key is per smb session */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500159 __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 */
Shirish Pargaonkard3686d52010-10-28 09:53:07 -0500162 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500163};
164
Steve French442aa312007-09-24 20:25:46 +0000165struct 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176/*
177 *****************************************************************
178 * Except the CIFS PDUs themselves all the
179 * globally interesting structs should go here
180 *****************************************************************
181 */
182
Jeff Laytonbf5ea0e2012-09-18 16:20:34 -0700183/*
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 */
Long Li57a929a2018-05-30 12:47:53 -0700192 unsigned int rq_offset; /* the offset to the 1st page */
Jeff Laytonbf5ea0e2012-09-18 16:20:34 -0700193 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
Jeff Layton23db65f2012-05-15 12:20:51 -0400198enum smb_version {
199 Smb_1 = 1,
Steve Frenchdd446b12012-11-28 23:21:06 -0600200 Smb_20,
Steve French1080ef72011-02-24 18:07:19 +0000201 Smb_21,
Steve Frenche4aa25e2012-10-01 12:26:22 -0500202 Smb_30,
Steve French20b6d8b2013-06-12 22:48:41 -0500203 Smb_302,
Steve French5f7fbf72014-12-17 22:52:58 -0600204 Smb_311,
Steve French9764c022017-09-17 10:41:35 -0500205 Smb_3any,
206 Smb_default,
Steve French5f7fbf72014-12-17 22:52:58 -0600207 Smb_version_err
Jeff Layton23db65f2012-05-15 12:20:51 -0400208};
209
Jeff Layton121b0462012-05-15 12:21:10 -0400210struct mid_q_entry;
211struct TCP_Server_Info;
Pavel Shilovsky55157df2012-02-28 14:04:17 +0300212struct cifsFileInfo;
Pavel Shilovsky082d0642012-05-17 12:18:21 +0400213struct cifs_ses;
Pavel Shilovsky2e6e02a2012-05-25 11:11:39 +0400214struct cifs_tcon;
Pavel Shilovskyb669f332012-05-27 20:21:53 +0400215struct dfs_info3_param;
Pavel Shilovsky1208ef12012-05-27 17:34:43 +0400216struct cifs_fattr;
Pavel Shilovsky9224dfc2012-05-27 20:39:52 +0400217struct smb_vol;
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700218struct cifs_fid;
Pavel Shilovskyfc9c5962012-09-18 16:20:28 -0700219struct cifs_readdata;
Pavel Shilovskyc9de5c82012-09-18 16:20:29 -0700220struct cifs_writedata;
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700221struct cifs_io_parms;
Pavel Shilovsky92fc65a2012-09-18 16:20:32 -0700222struct cifs_search_info;
Pavel Shilovsky95a3f2f2012-09-18 16:20:33 -0700223struct cifsInodeInfo;
Pavel Shilovsky226730b2013-07-05 12:00:30 +0400224struct cifs_open_parms;
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800225struct cifs_credits;
Jeff Layton121b0462012-05-15 12:21:10 -0400226
Jeff Layton23db65f2012-05-15 12:20:51 -0400227struct smb_version_operations {
Pavel Shilovskyfb2036d2016-11-23 15:08:14 -0800228 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *,
Jeff Layton121b0462012-05-15 12:21:10 -0400229 struct mid_q_entry *);
Pavel Shilovsky55157df2012-02-28 14:04:17 +0300230 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
Pavel Shilovsky082d0642012-05-17 12:18:21 +0400231 /* setup request: allocate mid, sign message */
Jeff Laytonfec344e2012-09-18 16:20:35 -0700232 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
233 struct smb_rqst *);
Pavel Shilovsky45740842012-06-01 14:26:18 +0400234 /* setup async request: allocate mid, sign message */
Jeff Laytonfec344e2012-09-18 16:20:35 -0700235 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
236 struct smb_rqst *);
Pavel Shilovsky082d0642012-05-17 12:18:21 +0400237 /* check response: verify signature, map error */
238 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
239 bool);
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800240 void (*add_credits)(struct TCP_Server_Info *server,
241 const struct cifs_credits *credits,
242 const int optype);
Pavel Shilovsky45275782012-05-17 17:53:29 +0400243 void (*set_credits)(struct TCP_Server_Info *, const int);
Pavel Shilovskya891f0f2012-05-23 16:14:34 +0400244 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
245 unsigned int (*get_credits)(struct mid_q_entry *);
Pavel Shilovsky88257362012-05-23 14:01:59 +0400246 __u64 (*get_next_mid)(struct TCP_Server_Info *);
Pavel Shilovskyc781af72019-03-04 14:02:50 -0800247 void (*revert_current_mid)(struct TCP_Server_Info *server,
248 const unsigned int val);
Pavel Shilovskyeb378712012-05-17 13:02:51 +0400249 /* data offset from read response message */
250 unsigned int (*read_data_offset)(char *);
Long Li74dcf412017-11-22 17:38:46 -0700251 /*
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);
Pavel Shilovskyeb378712012-05-17 13:02:51 +0400259 /* map smb to linux error */
260 int (*map_error)(char *, bool);
Pavel Shilovsky8aa26f32012-05-17 13:25:35 +0400261 /* find mid corresponding to the response message */
262 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
Ronnie Sahlberg14547f72018-04-22 14:45:53 -0600263 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info);
Pavel Shilovsky44c58182012-05-28 14:16:31 +0400264 void (*clear_stats)(struct cifs_tcon *);
265 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
Steve French769ee6a2013-06-19 14:15:30 -0500266 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
Pavel Shilovsky8aa26f32012-05-17 13:25:35 +0400267 /* verify the message */
Steve French373512e2015-12-18 13:05:30 -0600268 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
Pavel Shilovsky8aa26f32012-05-17 13:25:35 +0400269 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
Sachin Prabhu38bd4902017-03-03 15:41:38 -0800270 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
Sachin Prabhuc11f1df2014-03-11 16:11:47 +0000271 void (*downgrade_oplock)(struct TCP_Server_Info *,
272 struct cifsInodeInfo *, bool);
Pavel Shilovsky316cf942012-05-23 14:31:03 +0400273 /* process transaction2 response */
274 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
275 char *, int);
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400276 /* check if we need to negotiate */
277 bool (*need_neg)(struct TCP_Server_Info *);
278 /* negotiate to the server */
279 int (*negotiate)(const unsigned int, struct cifs_ses *);
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700280 /* set negotiated write size */
281 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
282 /* set negotiated read size */
283 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
Pavel Shilovsky58c45c52012-05-25 10:54:49 +0400284 /* setup smb sessionn */
285 int (*sess_setup)(const unsigned int, struct cifs_ses *,
286 const struct nls_table *);
287 /* close smb session */
288 int (*logoff)(const unsigned int, struct cifs_ses *);
Pavel Shilovsky2e6e02a2012-05-25 11:11:39 +0400289 /* connect to a server share */
290 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
291 struct cifs_tcon *, const struct nls_table *);
292 /* close tree connecion */
293 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
Pavel Shilovskyb669f332012-05-27 20:21:53 +0400294 /* get DFS referrals */
295 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
296 const char *, struct dfs_info3_param **,
297 unsigned int *, const struct nls_table *, int);
Pavel Shilovskyaf4281d2012-05-27 20:48:35 +0400298 /* informational QFS call */
299 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
Pavel Shilovsky68889f22012-05-25 14:40:22 +0400300 /* check if a path is accessible or not */
301 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
302 struct cifs_sb_info *, const char *);
Pavel Shilovsky1208ef12012-05-27 17:34:43 +0400303 /* query path data from the server */
304 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
305 struct cifs_sb_info *, const char *,
Pavel Shilovskyeb85d94b2013-10-23 17:49:47 +0400306 FILE_ALL_INFO *, bool *, bool *);
Pavel Shilovsky4ad65042012-09-18 16:20:26 -0700307 /* query file data from the server */
308 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
309 struct cifs_fid *, FILE_ALL_INFO *);
Pavel Shilovsky1208ef12012-05-27 17:34:43 +0400310 /* get server index number */
311 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
312 struct cifs_sb_info *, const char *,
313 u64 *uniqueid, FILE_ALL_INFO *);
Pavel Shilovskyd1433412012-09-18 16:20:31 -0700314 /* set size by path */
315 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
316 const char *, __u64, struct cifs_sb_info *, bool);
317 /* set size by file handle */
318 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
319 struct cifsFileInfo *, __u64, bool);
Pavel Shilovsky6bdf6db2012-09-18 16:20:32 -0700320 /* set attributes */
321 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
322 const unsigned int);
Steve French64a5cfa2013-10-14 15:31:32 -0500323 int (*set_compression)(const unsigned int, struct cifs_tcon *,
324 struct cifsFileInfo *);
Pavel Shilovskyf6d76172012-05-25 14:47:16 +0400325 /* check if we can send an echo or nor */
326 bool (*can_echo)(struct TCP_Server_Info *);
327 /* send echo request */
328 int (*echo)(struct TCP_Server_Info *);
Pavel Shilovskyf4367202012-03-17 11:41:12 +0300329 /* create directory */
Steve Frenchbea851b2018-06-14 21:56:32 -0500330 int (*posix_mkdir)(const unsigned int xid, struct inode *inode,
331 umode_t mode, struct cifs_tcon *tcon,
332 const char *full_path,
333 struct cifs_sb_info *cifs_sb);
Steve Frenchc3ca78e2019-09-25 00:32:13 -0500334 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode,
335 struct cifs_tcon *tcon, const char *name,
336 struct cifs_sb_info *sb);
Pavel Shilovskyf4367202012-03-17 11:41:12 +0300337 /* set info on created directory */
338 void (*mkdir_setinfo)(struct inode *, const char *,
339 struct cifs_sb_info *, struct cifs_tcon *,
340 const unsigned int);
Pavel Shilovskyf958ca52012-07-10 16:14:18 +0400341 /* remove directory */
342 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
343 struct cifs_sb_info *);
Pavel Shilovskyed6875e2012-09-18 16:20:25 -0700344 /* unlink file */
345 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
346 struct cifs_sb_info *);
347 /* open, rename and delete file */
348 int (*rename_pending_delete)(const char *, struct dentry *,
349 const unsigned int);
Pavel Shilovsky8ceb9842012-09-18 16:20:30 -0700350 /* send rename request */
351 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
352 const char *, struct cifs_sb_info *);
Steve Frenchd6e906f2012-09-18 16:20:31 -0700353 /* send create hardlink request */
354 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
355 const char *, const char *,
356 struct cifs_sb_info *);
Pavel Shilovskyb42bf882013-08-14 19:25:21 +0400357 /* query symlink target */
358 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
Ronnie Sahlbergebaf5462019-04-10 08:44:46 +1000359 struct cifs_sb_info *, const char *,
360 char **, bool);
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700361 /* open a file for non-posix mounts */
Pavel Shilovsky226730b2013-07-05 12:00:30 +0400362 int (*open)(const unsigned int, struct cifs_open_parms *,
363 __u32 *, FILE_ALL_INFO *);
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700364 /* set fid protocol-specific info */
365 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
Pavel Shilovsky0ff78a22012-09-18 16:20:26 -0700366 /* close a file */
Pavel Shilovsky760ad0c2012-09-25 11:00:07 +0400367 void (*close)(const unsigned int, struct cifs_tcon *,
368 struct cifs_fid *);
Pavel Shilovsky1d8c4c02012-09-18 16:20:27 -0700369 /* send a flush request to the server */
370 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
Pavel Shilovskyfc9c5962012-09-18 16:20:28 -0700371 /* async read from the server */
372 int (*async_readv)(struct cifs_readdata *);
Pavel Shilovskyc9de5c82012-09-18 16:20:29 -0700373 /* async write to the server */
Steve French4a5c80d2014-02-07 20:45:12 -0600374 int (*async_writev)(struct cifs_writedata *,
375 void (*release)(struct kref *));
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700376 /* sync read from the server */
Steve Frenchdb8b6312014-09-22 05:13:55 -0500377 int (*sync_read)(const unsigned int, struct cifs_fid *,
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700378 struct cifs_io_parms *, unsigned int *, char **,
379 int *);
Pavel Shilovskyba9ad7252012-09-18 16:20:30 -0700380 /* sync write to the server */
Steve Frenchdb8b6312014-09-22 05:13:55 -0500381 int (*sync_write)(const unsigned int, struct cifs_fid *,
Pavel Shilovskyba9ad7252012-09-18 16:20:30 -0700382 struct cifs_io_parms *, unsigned int *, struct kvec *,
383 unsigned long);
Pavel Shilovsky92fc65a2012-09-18 16:20:32 -0700384 /* open dir, start readdir */
385 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
386 const char *, struct cifs_sb_info *,
387 struct cifs_fid *, __u16,
388 struct cifs_search_info *);
389 /* continue readdir */
390 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
391 struct cifs_fid *,
392 __u16, struct cifs_search_info *srch_inf);
393 /* close dir */
394 int (*close_dir)(const unsigned int, struct cifs_tcon *,
395 struct cifs_fid *);
396 /* calculate a size of SMB message */
Ronnie Sahlberg9ec672b2018-04-22 15:30:12 -0600397 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
Pavel Shilovsky66265f12019-01-23 17:11:16 -0800398 /* check for STATUS_PENDING and process the response if yes */
399 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
Pavel Shilovsky511c54a2017-07-08 14:32:00 -0700400 /* check for STATUS_NETWORK_SESSION_EXPIRED */
401 bool (*is_session_expired)(char *);
Pavel Shilovsky95a3f2f2012-09-18 16:20:33 -0700402 /* send oplock break response */
403 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
404 struct cifsInodeInfo *);
Pavel Shilovsky76ec5e32012-09-18 16:20:33 -0700405 /* query remote filesystem */
406 int (*queryfs)(const unsigned int, struct cifs_tcon *,
407 struct kstatfs *);
Pavel Shilovskyd39a4f72012-09-19 06:22:43 -0700408 /* send mandatory brlock to the server */
409 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
410 __u64, __u32, int, int, bool);
411 /* unlock range of mandatory locks */
412 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
413 const unsigned int);
414 /* push brlocks from the cache to the server */
415 int (*push_mand_locks)(struct cifsFileInfo *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700416 /* get lease key of the inode */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400417 void (*get_lease_key)(struct inode *, struct cifs_fid *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700418 /* set lease key of the inode */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400419 void (*set_lease_key)(struct inode *, struct cifs_fid *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700420 /* generate new lease key */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400421 void (*new_lease_key)(struct cifs_fid *);
Shirish Pargaonkar32811d22013-08-29 08:35:11 -0500422 int (*generate_signingkey)(struct cifs_ses *);
Pavel Shilovsky53ef1012013-09-05 16:11:28 +0400423 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
Steve Frenchb3152e22015-06-24 03:17:02 -0500424 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
425 struct cifsFileInfo *src_file);
Steve French834170c2016-09-30 21:14:26 -0500426 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
427 struct cifsFileInfo *src_file, void __user *);
Sachin Prabhub5be1a12013-11-25 17:09:49 +0000428 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
429 struct cifs_sb_info *, const unsigned char *,
430 char *, unsigned int *);
Sachin Prabhucbb0aba2013-11-25 17:09:52 +0000431 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
432 struct cifs_sb_info *, const unsigned char *,
433 char *, unsigned int *);
Pavel Shilovsky53ef1012013-09-05 16:11:28 +0400434 /* if we can do cache read operations */
435 bool (*is_read_op)(__u32);
436 /* set oplock level for the inode */
Pavel Shilovsky42873b02013-09-05 21:30:16 +0400437 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
438 bool *);
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400439 /* create lease context buffer for CREATE request */
Stefano Brivio729c0c92018-07-05 15:10:02 +0200440 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
Pavel Shilovsky42873b02013-09-05 21:30:16 +0400441 /* parse lease context buffer and return oplock/epoch info */
Ronnie Sahlberg96164ab2018-04-26 08:10:18 -0600442 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
Sachin Prabhu620d8742017-02-10 16:03:51 +0530443 ssize_t (*copychunk_range)(const unsigned int,
Sachin Prabhu312bbc52017-04-04 02:12:04 -0500444 struct cifsFileInfo *src_file,
Sachin Prabhu620d8742017-02-10 16:03:51 +0530445 struct cifsFileInfo *target_file,
446 u64 src_off, u64 len, u64 dest_off);
Steve French02b16662015-06-27 21:18:36 -0700447 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
448 struct cifsFileInfo *target_file, u64 src_off, u64 len,
449 u64 dest_off);
Steve Frenchff1c0382013-11-19 23:44:46 -0600450 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
Steve French666753c2014-01-26 23:53:43 -0600451 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
452 const unsigned char *, const unsigned char *, char *,
Steve French67b4c882017-05-12 20:59:10 -0500453 size_t, struct cifs_sb_info *);
Steve French666753c2014-01-26 23:53:43 -0600454 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
455 const char *, const void *, const __u16,
Ronnie Sahlberg55175542017-08-24 11:24:56 +1000456 const struct nls_table *, struct cifs_sb_info *);
Steve French83e3bc22014-02-02 23:31:47 -0600457 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
458 const char *, u32 *);
Steve French42eacf92014-02-10 14:08:16 -0600459 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
460 const struct cifs_fid *, u32 *);
Steve French83e3bc22014-02-02 23:31:47 -0600461 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
462 int);
Pavel Shilovsky7f6c5002014-06-22 11:03:22 +0400463 /* writepages retry size */
464 unsigned int (*wp_retry_size)(struct inode *);
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400465 /* get mtu credits */
466 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800467 unsigned int *, struct cifs_credits *);
Pavel Shilovsky9a1c67e2019-01-23 18:15:52 -0800468 /* adjust previously taken mtu credits to request size */
469 int (*adjust_credits)(struct TCP_Server_Info *server,
470 struct cifs_credits *credits,
471 const unsigned int payload_size);
Pavel Shilovsky52755802014-08-18 20:49:57 +0400472 /* check if we need to issue closedir */
473 bool (*dir_needs_close)(struct cifsFileInfo *);
Steve French31742c52014-08-17 08:38:47 -0500474 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
475 loff_t);
Pavel Shilovsky7fb89862016-10-31 13:49:30 -0700476 /* init transform request - used for encryption for now */
Ronnie Sahlbergb2c96de2018-08-01 09:26:11 +1000477 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
478 struct smb_rqst *, struct smb_rqst *);
Pavel Shilovsky9bb17e02016-11-17 15:24:34 -0800479 int (*is_transform_hdr)(void *buf);
480 int (*receive_transform)(struct TCP_Server_Info *,
Ronnie Sahlbergb24df3e2018-08-08 15:07:45 +1000481 struct mid_q_entry **, char **, int *);
Sachin Prabhuef65aae2017-01-18 15:35:57 +0530482 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
483 enum securityEnum);
Ronnie Sahlberg8ce79ec2018-06-01 10:53:08 +1000484 int (*next_header)(char *);
Ronnie Sahlbergf5b05d62018-10-07 19:19:58 -0500485 /* ioctl passthrough for query_info */
486 int (*ioctl_query_info)(const unsigned int xid,
Ronnie Sahlberg8d8b26e2018-10-17 05:47:58 +1000487 struct cifs_tcon *tcon,
488 __le16 *path, int is_dir,
Ronnie Sahlbergf5b05d62018-10-07 19:19:58 -0500489 unsigned long p);
Aurelien Aptelc847dcc2019-03-14 00:29:17 -0500490 /* make unix special files (block, char, fifo, socket) */
491 int (*make_node)(unsigned int xid,
492 struct inode *inode,
493 struct dentry *dentry,
494 struct cifs_tcon *tcon,
495 char *full_path,
496 umode_t mode,
497 dev_t device_number);
Ronnie Sahlberg2f3ebab2019-04-25 16:45:29 +1000498 /* version specific fiemap implementation */
499 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
500 struct fiemap_extent_info *, u64, u64);
Ronnie Sahlbergdece44e2019-05-15 07:17:02 +1000501 /* version specific llseek implementation */
502 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
Jeff Layton23db65f2012-05-15 12:20:51 -0400503};
504
505struct smb_version_values {
506 char *version_string;
Steve Frenche4aa25e2012-10-01 12:26:22 -0500507 __u16 protocol_id;
508 __u32 req_capabilities;
Pavel Shilovsky106dc532012-02-28 14:23:34 +0300509 __u32 large_lock_type;
510 __u32 exclusive_lock_type;
511 __u32 shared_lock_type;
512 __u32 unlock_lock_type;
Ronnie Sahlberg93012bf2018-03-31 11:45:31 +1100513 size_t header_preamble_size;
Pavel Shilovsky1887f602012-05-17 12:45:31 +0400514 size_t header_size;
515 size_t max_header_size;
Pavel Shilovskyeb378712012-05-17 13:02:51 +0400516 size_t read_rsp_size;
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +0400517 __le16 lock_cmd;
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400518 unsigned int cap_unix;
519 unsigned int cap_nt_find;
520 unsigned int cap_large_files;
Jeff Layton502858822013-06-27 12:45:00 -0400521 __u16 signing_enabled;
522 __u16 signing_required;
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400523 size_t create_lease_size;
Jeff Layton23db65f2012-05-15 12:20:51 -0400524};
525
Pavel Shilovsky1887f602012-05-17 12:45:31 +0400526#define HEADER_SIZE(server) (server->vals->header_size)
527#define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
528
Steve Frenchf87d39d2011-05-27 03:50:55 +0000529struct smb_vol {
530 char *username;
531 char *password;
532 char *domainname;
533 char *UNC;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000534 char *iocharset; /* local code page for mapping to and from Unicode */
535 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
536 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
Eric W. Biederman3da46562013-02-06 01:37:39 -0800537 kuid_t cred_uid;
538 kuid_t linux_uid;
539 kgid_t linux_gid;
540 kuid_t backupuid;
541 kgid_t backupgid;
Al Viro5206efd2011-07-26 03:22:14 -0400542 umode_t file_mode;
543 umode_t dir_mode;
Jeff Layton1e3cc572013-06-10 17:12:23 -0500544 enum securityEnum sectype; /* sectype requested via mnt opts */
545 bool sign; /* was signing requested via mnt opts? */
Steve French4f5c10f2019-09-03 21:18:49 -0500546 bool ignore_signature:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000547 bool retry:1;
548 bool intr:1;
549 bool setuids:1;
Steve French95932652016-09-23 01:36:34 -0500550 bool setuidfromacl:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000551 bool override_uid:1;
552 bool override_gid:1;
553 bool dynperm:1;
554 bool noperm:1;
Steve French412094a2019-06-24 02:01:42 -0500555 bool mode_ace:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000556 bool no_psx_acl:1; /* set if posix acl support should be disabled */
557 bool cifs_acl:1;
Shirish Pargaonkar3d3ea8e2011-09-26 09:56:44 -0500558 bool backupuid_specified; /* mount option backupuid is specified */
559 bool backupgid_specified; /* mount option backupgid is specified */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000560 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
561 bool server_ino:1; /* use inode numbers from server ie UniqueId */
562 bool direct_io:1;
563 bool strict_io:1; /* strict cache behavior */
Steve French83bbfa72019-08-27 23:58:54 -0500564 bool cache_ro:1;
Steve French41e033f2019-08-30 02:12:41 -0500565 bool cache_rw:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000566 bool remap:1; /* set to remap seven reserved chars in filenames */
Steve French2baa2682014-09-27 02:19:01 -0500567 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000568 bool posix_paths:1; /* unset to not ask for posix pathnames. */
569 bool no_linux_ext:1;
Steve Frenchb3266142018-05-20 23:41:10 -0500570 bool linux_ext:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000571 bool sfu_emul:1;
572 bool nullauth:1; /* attempt to authenticate with null user */
573 bool nocase:1; /* request case insensitive filenames */
574 bool nobrl:1; /* disable sending byte range locks to srv */
Steve French3d4ef9a2018-04-25 22:19:09 -0500575 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000576 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
577 bool seal:1; /* request transport encryption on share */
578 bool nodfs:1; /* Do not request DFS, even if available */
579 bool local_lease:1; /* check leases only on local system, not remote */
580 bool noblocksnd:1;
581 bool noautotune:1;
582 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
Steve French3e7a02d2019-09-11 21:46:20 -0500583 bool no_lease:1; /* disable requesting leases */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000584 bool fsc:1; /* enable fscache */
585 bool mfsymlinks:1; /* use Minshall+French Symlinks */
586 bool multiuser:1;
Pavel Shilovskyd4ffff12011-05-26 06:02:00 +0000587 bool rwpidforward:1; /* pid forward for read/write operations */
Steve Frenchb2a30772015-09-29 21:49:28 -0500588 bool nosharesock:1;
589 bool persistent:1;
590 bool nopersistent:1;
Steve French592fafe2015-11-03 10:08:53 -0600591 bool resilient:1; /* noresilient not required since not fored for CA */
Germano Percossi39566442016-12-15 12:31:18 +0530592 bool domainauto:1;
Long Li8339dd32017-11-07 01:54:55 -0700593 bool rdma:1;
Steve Frenche8506d22019-02-28 21:32:15 -0600594 unsigned int bsize;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000595 unsigned int rsize;
596 unsigned int wsize;
Steve French563317e2019-09-08 23:22:02 -0500597 unsigned int min_offload;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000598 bool sockopt_tcp_nodelay:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000599 unsigned long actimeo; /* attribute cache timeout (jiffies) */
Jeff Layton23db65f2012-05-15 12:20:51 -0400600 struct smb_version_operations *ops;
601 struct smb_version_values *vals;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000602 char *prepath;
Jeff Laytonb979aaa2012-11-26 11:09:55 -0500603 struct sockaddr_storage dstaddr; /* destination address */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000604 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
605 struct nls_table *local_nls;
Steve Frenchadfeb3e2015-12-18 12:31:36 -0600606 unsigned int echo_interval; /* echo interval in secs */
Steve French8b217fe2016-11-11 22:36:20 -0600607 __u64 snapshot_time; /* needed for timewarp tokens */
Steve Frenchca567eb2019-03-29 16:31:07 -0500608 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
Steve French141891f2016-09-23 00:44:16 -0500609 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
Steve French9fe5ff12019-06-24 20:39:04 -0500610 __u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
Paulo Alcantara (SUSE)8eecd1c2019-07-16 19:04:50 -0300611 bool rootfs:1; /* if it's a SMB root file system */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000612};
613
Aurelien Apteld070f9d2019-04-02 13:00:33 +0200614/**
615 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
616 * trying to reuse existing superblock for a new mount
617 */
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400618#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
619 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
620 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
Steve French2baa2682014-09-27 02:19:01 -0500621 CIFS_MOUNT_MAP_SFM_CHR | \
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400622 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
623 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
624 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
625 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
626 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
Shirish Pargaonkar3d3ea8e2011-09-26 09:56:44 -0500627 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
Aurelien Apteld070f9d2019-04-02 13:00:33 +0200628 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
Steve French6552d6a2019-06-24 01:19:52 -0500629 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
Steve French83bbfa72019-08-27 23:58:54 -0500630 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
Steve French41e033f2019-08-30 02:12:41 -0500631 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE)
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400632
Aurelien Apteld070f9d2019-04-02 13:00:33 +0200633/**
634 * Generic VFS superblock mount flags (s_flags) to consider when
635 * trying to reuse existing superblock for a new mount
636 */
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800637#define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
638 SB_NODEV | SB_SYNCHRONOUS)
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400639
640struct cifs_mnt_data {
641 struct cifs_sb_info *cifs_sb;
642 struct smb_vol *vol;
643 int flags;
644};
645
Pavel Shilovsky792af7b2012-03-23 14:28:02 -0400646static inline unsigned int
647get_rfc1002_length(void *buf)
648{
Jeff Laytondca1c8d2014-02-22 19:35:38 -0500649 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
Pavel Shilovsky792af7b2012-03-23 14:28:02 -0400650}
651
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400652static inline void
653inc_rfc1001_len(void *buf, int count)
654{
655 be32_add_cpu((__be32 *)buf, count);
656}
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000659 struct list_head tcp_ses_list;
660 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500661 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700662 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500663 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Layton23db65f2012-05-15 12:20:51 -0400664 struct smb_version_operations *ops;
665 struct smb_version_values *vals;
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500666 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Laytonc359cf32007-11-16 22:22:06 +0000667 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 struct socket *ssocket;
Pavel Shilovskya9f1b852010-12-13 19:08:35 +0300669 struct sockaddr_storage dstaddr;
Ben Greear3eb9a882010-09-01 17:06:02 -0700670 struct sockaddr_storage srcaddr; /* locally bind to this IP */
Rob Landleyf1d0c992011-01-22 15:44:05 -0600671#ifdef CONFIG_NET_NS
672 struct net *net;
673#endif
Steve Frenchd38d8c72007-06-28 19:44:13 +0000674 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
676 struct list_head pending_mid_q;
Steve Frenchedf1ae42008-10-29 00:47:57 +0000677 bool noblocksnd; /* use blocking sendmsg */
678 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000679 bool tcp_nodelay;
Steve French141891f2016-09-23 00:44:16 -0500680 unsigned int credits; /* send no more requests at once */
681 unsigned int max_credits; /* can override large 32000 default at mnt */
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300682 unsigned int in_flight; /* number of requests on the wire to server */
Steve French1b63f182019-09-09 22:57:11 -0500683 unsigned int max_in_flight; /* max number of requests that were on wire */
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400684 spinlock_t req_lock; /* protect the two values above */
Jeff Layton72ca5452008-12-01 07:09:36 -0500685 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 struct task_struct *tsk;
687 char server_GUID[16];
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400688 __u16 sec_mode;
Jeff Layton38d77c52013-05-26 07:01:00 -0400689 bool sign; /* is signing enabled on this connection? */
Steve French4f5c10f2019-09-03 21:18:49 -0500690 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500691 bool session_estab; /* mark when very first sess is established */
Pavel Shilovsky28ea5292012-05-23 16:18:00 +0400692 int echo_credits; /* echo reserved slots */
693 int oplock_credits; /* oplock break reserved slots */
694 bool echoes:1; /* enable echoes */
Sachin Prabhu39552ea2014-05-13 00:48:12 +0100695 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500696 u16 dialect; /* dialect index that server chose */
Pavel Shilovsky10b9b982012-03-20 12:55:09 +0300697 bool oplocks:1; /* enable oplocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 unsigned int maxReq; /* Clients should submit no more */
699 /* than maxReq distinct unanswered SMBs to the server when using */
Steve French11911b92018-05-24 02:09:20 -0500700 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 unsigned int maxBuf; /* maxBuf specifies the maximum */
702 /* message size the server can send or receive for non-raw SMBs */
Steve French7e90d702011-02-08 23:52:32 +0000703 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
704 /* when socket is setup (and during reconnect) before NegProt sent */
Steve Frencheca6acf2009-02-20 05:43:09 +0000705 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 /* message size the server can send or receive for */
707 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400708 unsigned int capabilities; /* selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000709 int timeAdj; /* Adjust for difference in server time zone in sec */
Pavel Shilovsky243d04b2012-03-23 14:28:03 -0400710 __u64 CurrentMid; /* multiplex id - rotating counter */
Shirish Pargaonkard3ba50b2010-10-27 15:20:36 -0500711 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
Steve Frencha10faeb22005-08-22 21:38:31 -0700712 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500713 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytona0f8b4f2011-01-07 11:30:28 -0500714 __u32 sequence_number; /* for signing, protected by srv_mutex */
Steve French9e1a37d2018-09-19 02:38:17 -0500715 __u32 reconnect_instance; /* incremented on each reconnect */
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500716 struct session_key session_key;
Steve French3a5ff612006-07-14 22:37:11 +0000717 unsigned long lstrp; /* when we got last response from this server */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500718 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
Jeff Laytone598d1d82013-05-26 07:00:59 -0400719#define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
720#define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
721#define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
722 char negflavor; /* NEGOTIATE response flavor */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400723 /* extended security flavors that server supports */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500724 bool sec_ntlmssp; /* supports NTLMSSP */
725 bool sec_kerberosu2u; /* supports U2U Kerberos */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400726 bool sec_kerberos; /* supports plain Kerberos */
727 bool sec_mskerberos; /* supports legacy MS Kerberos */
Jeff Layton2a37ef92011-10-19 15:29:23 -0400728 bool large_buf; /* is current buffer large? */
Long Li8339dd32017-11-07 01:54:55 -0700729 /* use SMBD connection instead of socket */
730 bool rdma;
731 /* point to the SMBD connection if RDMA is used instead of socket */
732 struct smbd_connection *smbd_conn;
Jeff Laytonc74093b2011-01-11 07:24:23 -0500733 struct delayed_work echo; /* echo ping workqueue job */
Jeff Layton2a37ef92011-10-19 15:29:23 -0400734 char *smallbuf; /* pointer to current "small" buffer */
735 char *bigbuf; /* pointer to current "big" buffer */
Ronnie Sahlberg2e964672018-04-09 18:06:26 +1000736 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
737 unsigned int pdu_size;
Jeff Layton2a37ef92011-10-19 15:29:23 -0400738 unsigned int total_read; /* total amount of data read in this pass */
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530739#ifdef CONFIG_CIFS_FSCACHE
740 struct fscache_cookie *fscache; /* client index cache cookie */
741#endif
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500742#ifdef CONFIG_CIFS_STATS2
Steve French789e6662011-08-09 18:44:44 +0000743 atomic_t in_send; /* requests trying to send */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500744 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
Steve French433b8dd2019-03-26 13:53:21 -0500745 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
Steve French468d6772018-08-04 05:24:34 -0500746 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
Steve French433b8dd2019-03-26 13:53:21 -0500747 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
748 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
749 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
Steve French468d6772018-08-04 05:24:34 -0500750#endif /* STATS2 */
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400751 unsigned int max_read;
752 unsigned int max_write;
Steve French563317e2019-09-08 23:22:02 -0500753 unsigned int min_offload;
Steve French26ea8882019-04-26 20:36:08 -0700754 __le16 compress_algorithm;
Steve French5100d8a2018-04-09 10:47:14 -0500755 __le16 cipher_type;
Aurelien Aptel8bd68c62018-02-16 19:19:29 +0100756 /* save initital negprot hash */
757 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
Steve Frenchfcef0db2018-05-19 20:45:27 -0500758 bool posix_ext_supported;
Pavel Shilovsky53e0e112016-11-04 11:50:31 -0700759 struct delayed_work reconnect; /* reconnect workqueue job */
760 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
Steve Frenchadfeb3e2015-12-18 12:31:36 -0600761 unsigned long echo_interval;
Paulo Alcantara93d5cb52018-11-14 17:13:25 -0200762
763 /*
764 * Number of targets available for reconnect. The more targets
765 * the more tasks have to wait to let the demultiplex thread
766 * reconnect.
767 */
768 int nr_targets;
Paulo Alcantara (SUSE)8eecd1c2019-07-16 19:04:50 -0300769 bool noblockcnt; /* use non-blocking connect() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770};
771
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800772struct cifs_credits {
773 unsigned int value;
774 unsigned int instance;
775};
776
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300777static inline unsigned int
778in_flight(struct TCP_Server_Info *server)
779{
780 unsigned int num;
781 spin_lock(&server->req_lock);
782 num = server->in_flight;
783 spin_unlock(&server->req_lock);
784 return num;
785}
786
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400787static inline bool
Ronnie Sahlbergb227d212019-03-08 12:58:20 +1000788has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300789{
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400790 int num;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300791 spin_lock(&server->req_lock);
Pavel Shilovskybc205ed2012-03-15 13:22:27 +0300792 num = *credits;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300793 spin_unlock(&server->req_lock);
Ronnie Sahlbergb227d212019-03-08 12:58:20 +1000794 return num >= num_credits;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300795}
796
Pavel Shilovsky45275782012-05-17 17:53:29 +0400797static inline void
Pavel Shilovsky34f4deb2019-01-16 11:22:29 -0800798add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
Pavel Shilovskya891f0f2012-05-23 16:14:34 +0400799 const int optype)
Pavel Shilovsky45275782012-05-17 17:53:29 +0400800{
Pavel Shilovsky34f4deb2019-01-16 11:22:29 -0800801 server->ops->add_credits(server, credits, optype);
Pavel Shilovsky45275782012-05-17 17:53:29 +0400802}
803
804static inline void
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800805add_credits_and_wake_if(struct TCP_Server_Info *server,
806 const struct cifs_credits *credits, const int optype)
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400807{
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800808 if (credits->value) {
809 server->ops->add_credits(server, credits, optype);
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400810 wake_up(&server->request_q);
811 }
812}
813
814static inline void
Pavel Shilovsky45275782012-05-17 17:53:29 +0400815set_credits(struct TCP_Server_Info *server, const int val)
816{
817 server->ops->set_credits(server, val);
818}
819
Pavel Shilovsky9a1c67e2019-01-23 18:15:52 -0800820static inline int
821adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
822 const unsigned int payload_size)
823{
824 return server->ops->adjust_credits ?
825 server->ops->adjust_credits(server, credits, payload_size) : 0;
826}
827
Sachin Prabhu9235d092014-12-09 17:37:00 +0000828static inline __le64
Tim Gardner3d378d32013-11-02 12:50:34 -0500829get_next_mid64(struct TCP_Server_Info *server)
Pavel Shilovsky88257362012-05-23 14:01:59 +0400830{
Sachin Prabhu9235d092014-12-09 17:37:00 +0000831 return cpu_to_le64(server->ops->get_next_mid(server));
Pavel Shilovsky88257362012-05-23 14:01:59 +0400832}
833
Tim Gardner3d378d32013-11-02 12:50:34 -0500834static inline __le16
835get_next_mid(struct TCP_Server_Info *server)
836{
Sachin Prabhu9235d092014-12-09 17:37:00 +0000837 __u16 mid = server->ops->get_next_mid(server);
Tim Gardner3d378d32013-11-02 12:50:34 -0500838 /*
839 * The value in the SMB header should be little endian for easy
840 * on-the-wire decoding.
841 */
842 return cpu_to_le16(mid);
843}
844
Pavel Shilovskyc781af72019-03-04 14:02:50 -0800845static inline void
846revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
847{
848 if (server->ops->revert_current_mid)
849 server->ops->revert_current_mid(server, val);
850}
851
852static inline void
853revert_current_mid_from_hdr(struct TCP_Server_Info *server,
854 const struct smb2_sync_hdr *shdr)
855{
856 unsigned int num = le16_to_cpu(shdr->CreditCharge);
857
858 return revert_current_mid(server, num > 0 ? num : 1);
859}
860
Tim Gardner3d378d32013-11-02 12:50:34 -0500861static inline __u16
862get_mid(const struct smb_hdr *smb)
863{
864 return le16_to_cpu(smb->Mid);
865}
866
867static inline bool
868compare_mid(__u16 mid, const struct smb_hdr *smb)
869{
870 return mid == le16_to_cpu(smb->Mid);
871}
872
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873/*
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700874 * When the server supports very large reads and writes via POSIX extensions,
875 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
876 * including the RFC1001 length.
877 *
878 * Note that this might make for "interesting" allocation problems during
879 * writeback however as we have to allocate an array of pointers for the
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300880 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700881 *
882 * For reads, there is a similar problem as we need to allocate an array
883 * of kvecs to handle the receive, though that should only need to be done
884 * once.
885 */
886#define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
887#define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
888
889/*
890 * When the server doesn't allow large posix writes, only allow a rsize/wsize
891 * of 2^17-1 minus the size of the call header. That allows for a read or
892 * write up to the maximum size described by RFC1002.
893 */
894#define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
895#define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
896
897/*
898 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300899 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700900 * a single wsize request with a single call.
901 */
902#define CIFS_DEFAULT_IOSIZE (1024 * 1024)
Steve French3d621232018-09-25 15:33:47 -0500903#define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700904
905/*
906 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
907 * those values when posix extensions aren't in force. In actuality here, we
908 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
909 * to be ok with the extra byte even though Windows doesn't send writes that
910 * are that large.
911 *
912 * Citation:
913 *
914 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
915 */
916#define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
917#define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
918
919/*
Rob Landleyf1d0c992011-01-22 15:44:05 -0600920 * Macros to allow the TCP_Server_Info->net field and related code to drop out
921 * when CONFIG_NET_NS isn't set.
922 */
923
924#ifdef CONFIG_NET_NS
925
926static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
927{
928 return srv->net;
929}
930
931static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
932{
933 srv->net = net;
934}
935
936#else
937
938static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
939{
940 return &init_net;
941}
942
943static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
944{
945}
946
947#endif
948
Aurelien Aptelb6f0dd52018-06-14 15:43:18 +0200949struct cifs_server_iface {
950 size_t speed;
951 unsigned int rdma_capable : 1;
952 unsigned int rss_capable : 1;
953 struct sockaddr_storage sockaddr;
954};
955
Rob Landleyf1d0c992011-01-22 15:44:05 -0600956/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 * Session structure. One of these for each uid session with a particular host
958 */
Steve French96daf2b2011-05-27 04:34:02 +0000959struct cifs_ses {
Jeff Layton14fbf502008-11-14 13:53:46 -0500960 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000961 struct list_head tcon_list;
Aurelien Aptelb327a712018-01-24 13:46:10 +0100962 struct cifs_tcon *tcon_ipc;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000963 struct mutex session_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500965 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000967 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Steve Frenchad009ac2005-04-28 22:41:05 -0700968 char *serverOS; /* name of operating system underlying server */
969 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 char *serverDomain; /* security realm of server */
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400971 __u64 Suid; /* remote smb uid */
Eric W. Biederman64ed39d2013-02-06 02:30:39 -0800972 kuid_t linux_uid; /* overriding owner of files on the mount */
973 kuid_t cred_uid; /* owner of credentials */
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400974 unsigned int capabilities;
Aurelien Aptelb327a712018-01-24 13:46:10 +0100975 char serverName[SERVER_NAME_LEN_WITH_NULL];
Steve French34c87902011-03-01 05:02:57 +0000976 char *user_name; /* must not be null except during init of sess
977 and after mount option parsing we fill it */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000978 char *domainName;
979 char *password;
Shirish Pargaonkar5d0d2882010-10-13 18:15:00 -0500980 struct session_key auth_key;
Shirish Pargaonkard3686d52010-10-28 09:53:07 -0500981 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
Jeff Layton28e11bd2013-05-26 07:01:00 -0400982 enum securityEnum sectype; /* what security flavor was specified? */
983 bool sign; /* is signing required? */
Steve French3b795212008-11-13 19:45:32 +0000984 bool need_reconnect:1; /* connection reset, uid now invalid */
Germano Percossi39566442016-12-15 12:31:18 +0530985 bool domainAuto:1;
Pavel Shilovsky5478f9b2011-12-27 16:22:00 +0400986 __u16 session_flags;
Steve French373512e2015-12-18 13:05:30 -0600987 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
988 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
989 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
Aurelien Aptel8bd68c62018-02-16 19:19:29 +0100990 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
Aurelien Aptelb6f0dd52018-06-14 15:43:18 +0200991
992 /*
993 * Network interfaces available on the server this session is
994 * connected to.
995 *
996 * Other channels can be opened by connecting and binding this
997 * session to interfaces from this list.
998 *
999 * iface_lock should be taken when accessing any of these fields
1000 */
1001 spinlock_t iface_lock;
1002 struct cifs_server_iface *iface_list;
1003 size_t iface_count;
1004 unsigned long iface_last_update; /* jiffies */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005};
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001006
Pavel Shilovsky29e20f92012-07-13 13:58:14 +04001007static inline bool
1008cap_unix(struct cifs_ses *ses)
1009{
1010 return ses->server->vals->cap_unix & ses->capabilities;
1011}
1012
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001013struct cached_fid {
1014 bool is_valid:1; /* Do we have a useable root fid */
Ronnie Sahlbergb0f6df72019-03-12 13:58:31 +10001015 bool file_all_info_is_valid:1;
1016
Ronnie Sahlberg9da6ec72018-07-31 08:48:22 +10001017 struct kref refcount;
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001018 struct cifs_fid *fid;
1019 struct mutex fid_mutex;
1020 struct cifs_tcon *tcon;
1021 struct work_struct lease_break;
Ronnie Sahlbergb0f6df72019-03-12 13:58:31 +10001022 struct smb2_file_all_info file_all_info;
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001023};
1024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025/*
1026 * there is one of these for each connection to a resource on a particular
Steve Frenchd38d8c72007-06-28 19:44:13 +00001027 * session
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 */
Steve French96daf2b2011-05-27 04:34:02 +00001029struct cifs_tcon {
Jeff Laytonf1987b42008-11-15 11:12:47 -05001030 struct list_head tcon_list;
1031 int tc_count;
Pavel Shilovsky53e0e112016-11-04 11:50:31 -07001032 struct list_head rlist; /* reconnect list */
Steve Frenchfae80442018-10-19 17:14:32 -05001033 atomic_t num_local_opens; /* num of all opens including disconnected */
1034 atomic_t num_remote_opens; /* num of all network opens on server */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 struct list_head openFileList;
Steve French3afca262016-09-22 18:58:16 -05001036 spinlock_t open_file_lock; /* protects list above */
Steve French96daf2b2011-05-27 04:34:02 +00001037 struct cifs_ses *ses; /* pointer to session associated with */
Steve French254e55e2006-06-04 05:53:15 +00001038 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 char *nativeFileSystem;
Jeff Layton00e485b2008-12-05 20:41:21 -05001040 char *password; /* for share-level security */
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +04001041 __u32 tid; /* The 4 byte tree id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 __u16 Flags; /* optional support bits */
1043 enum statusEnum tidStatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 atomic_t num_smbs_sent;
Pavel Shilovsky44c58182012-05-28 14:16:31 +04001045 union {
1046 struct {
1047 atomic_t num_writes;
1048 atomic_t num_reads;
1049 atomic_t num_flushes;
1050 atomic_t num_oplock_brks;
1051 atomic_t num_opens;
1052 atomic_t num_closes;
1053 atomic_t num_deletes;
1054 atomic_t num_mkdirs;
1055 atomic_t num_posixopens;
1056 atomic_t num_posixmkdirs;
1057 atomic_t num_rmdirs;
1058 atomic_t num_renames;
1059 atomic_t num_t2renames;
1060 atomic_t num_ffirst;
1061 atomic_t num_fnext;
1062 atomic_t num_fclose;
1063 atomic_t num_hardlinks;
1064 atomic_t num_symlinks;
1065 atomic_t num_locks;
1066 atomic_t num_acl_get;
1067 atomic_t num_acl_set;
1068 } cifs_stats;
Pavel Shilovskyd60622e2012-05-28 15:19:39 +04001069 struct {
1070 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1071 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1072 } smb2_stats;
Pavel Shilovsky44c58182012-05-28 14:16:31 +04001073 } stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 __u64 bytes_read;
1075 __u64 bytes_written;
Steve French3afca262016-09-22 18:58:16 -05001076 spinlock_t stat_lock; /* protects the two fields above */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +00001078 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Aurelien Aptelb327a712018-01-24 13:46:10 +01001080 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1081 bool pipe:1; /* set if connection to pipe share */
1082 bool print:1; /* set if connection to printer share */
Steve French4b18f2a2008-04-29 00:06:05 +00001083 bool retry:1;
1084 bool nocase:1;
Steve French3d4ef9a2018-04-25 22:19:09 -05001085 bool nohandlecache:1; /* if strange server resource prob can turn off */
Steve French95b1cb92008-05-15 16:44:38 +00001086 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +00001087 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +00001088 for this mount even if server would support */
Steve Frenchb3266142018-05-20 23:41:10 -05001089 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
Steve French84210e92008-10-23 04:42:37 +00001090 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French64cc2c62009-03-04 19:54:08 +00001091 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
Steve French3d1a3742014-08-11 21:05:25 -05001092 bool broken_sparse_sup; /* if server or share does not support sparse */
Steve French3b795212008-11-13 19:45:32 +00001093 bool need_reconnect:1; /* connection reset, tid now invalid */
Pavel Shilovsky96a988f2016-11-29 11:31:23 -08001094 bool need_reopen_files:1; /* need to reopen tcon file handles */
Steve French592fafe2015-11-03 10:08:53 -06001095 bool use_resilient:1; /* use resilient instead of durable handles */
Steve Frenchb618f002015-11-03 09:15:03 -06001096 bool use_persistent:1; /* use persistent instead of durable handles */
Steve French3e7a02d2019-09-11 21:46:20 -05001097 bool no_lease:1; /* Do not request leases on files or directories */
Steve French769ee6a2013-06-19 14:15:30 -05001098 __le32 capabilities;
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +04001099 __u32 share_flags;
1100 __u32 maximal_access;
1101 __u32 vol_serial_number;
1102 __le64 vol_create_time;
Steve French8b217fe2016-11-11 22:36:20 -06001103 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
Steve Frenchca567eb2019-03-29 16:31:07 -05001104 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
Steven Frenchaf6a12e2013-10-09 20:55:53 -05001105 __u32 ss_flags; /* sector size flags */
1106 __u32 perf_sector_size; /* best sector size for perf */
Steve Frenchde9f68df2013-11-15 11:26:24 -06001107 __u32 max_chunks;
1108 __u32 max_bytes_chunk;
1109 __u32 max_bytes_copy;
Suresh Jayaramand03382c2010-07-05 18:12:27 +05301110#ifdef CONFIG_CIFS_FSCACHE
1111 u64 resource_id; /* server resource id */
1112 struct fscache_cookie *fscache; /* cookie for share */
1113#endif
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001114 struct list_head pending_opens; /* list of incomplete opens */
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001115 struct cached_fid crfid; /* Cached root fid */
Steve Frenchc18c8422007-07-18 23:21:09 +00001116 /* BB add field for back pointer to sb struct(s)? */
Paulo Alcantara54be1f62018-11-14 16:01:21 -02001117#ifdef CONFIG_CIFS_DFS_UPCALL
1118 char *dfs_path;
1119 int remap:2;
1120 struct list_head ulist; /* cache update list */
1121#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122};
1123
1124/*
Jeff Layton7ffec372010-09-29 19:51:11 -04001125 * This is a refcounted and timestamped container for a tcon pointer. The
1126 * container holds a tcon reference. It is considered safe to free one of
1127 * these when the tl_count goes to 0. The tl_time is the time of the last
1128 * "get" on the container.
1129 */
1130struct tcon_link {
Jeff Laytonb647c352010-10-28 11:16:44 -04001131 struct rb_node tl_rbnode;
Eric W. Biederman6d4a0832013-02-06 01:48:56 -08001132 kuid_t tl_uid;
Jeff Layton9d002df2010-10-06 19:51:11 -04001133 unsigned long tl_flags;
1134#define TCON_LINK_MASTER 0
1135#define TCON_LINK_PENDING 1
1136#define TCON_LINK_IN_TREE 2
1137 unsigned long tl_time;
1138 atomic_t tl_count;
Steve French96daf2b2011-05-27 04:34:02 +00001139 struct cifs_tcon *tl_tcon;
Jeff Layton7ffec372010-09-29 19:51:11 -04001140};
1141
Jeff Layton9d002df2010-10-06 19:51:11 -04001142extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
Ronnie Sahlbergb2c96de2018-08-01 09:26:11 +10001143extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
Jeff Layton7ffec372010-09-29 19:51:11 -04001144
Steve French96daf2b2011-05-27 04:34:02 +00001145static inline struct cifs_tcon *
Jeff Layton7ffec372010-09-29 19:51:11 -04001146tlink_tcon(struct tcon_link *tlink)
1147{
Jeff Layton9d002df2010-10-06 19:51:11 -04001148 return tlink->tl_tcon;
Jeff Layton7ffec372010-09-29 19:51:11 -04001149}
1150
Aurelien Aptel8ddecf52018-06-04 22:29:35 +02001151static inline struct tcon_link *
1152cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1153{
1154 return cifs_sb->master_tlink;
1155}
1156
Jeff Layton9d002df2010-10-06 19:51:11 -04001157extern void cifs_put_tlink(struct tcon_link *tlink);
Jeff Layton7ffec372010-09-29 19:51:11 -04001158
Jeff Layton13cfb732010-09-29 19:51:11 -04001159static inline struct tcon_link *
1160cifs_get_tlink(struct tcon_link *tlink)
1161{
Jeff Layton9d002df2010-10-06 19:51:11 -04001162 if (tlink && !IS_ERR(tlink))
1163 atomic_inc(&tlink->tl_count);
Jeff Layton13cfb732010-09-29 19:51:11 -04001164 return tlink;
1165}
1166
Jeff Layton7ffec372010-09-29 19:51:11 -04001167/* This function is always expected to succeed */
Steve French96daf2b2011-05-27 04:34:02 +00001168extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
Jeff Layton7ffec372010-09-29 19:51:11 -04001169
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001170#define CIFS_OPLOCK_NO_CHANGE 0xfe
1171
1172struct cifs_pending_open {
1173 struct list_head olist;
1174 struct tcon_link *tlink;
1175 __u8 lease_key[16];
1176 __u32 oplock;
1177};
1178
Jeff Layton7ffec372010-09-29 19:51:11 -04001179/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001180 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1181 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 */
1183struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001184 struct list_head llist; /* pointer to next cifsLockInfo */
Pavel Shilovsky85160e02011-10-22 15:33:29 +04001185 struct list_head blist; /* pointer to locks blocked on this */
1186 wait_queue_head_t block_q;
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001187 __u64 offset;
1188 __u64 length;
Pavel Shilovsky03776f42010-08-17 11:26:00 +04001189 __u32 pid;
Ronnie Sahlberg96457592018-10-04 09:24:38 +10001190 __u16 type;
1191 __u16 flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192};
1193
1194/*
1195 * One of these for each open instance of a file
1196 */
1197struct cifs_search_info {
1198 loff_t index_of_last_entry;
1199 __u16 entries_in_buffer;
1200 __u16 info_level;
1201 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +00001202 char *ntwrk_buf_start;
1203 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +00001204 char *last_entry;
Christoph Hellwigeaf35b12011-07-16 15:24:37 -04001205 const char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +00001207 bool endOfSearch:1;
1208 bool emptyDir:1;
1209 bool unicode:1;
1210 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211};
1212
Steve Frenchd0959b02019-10-05 10:53:58 -05001213#define ACL_NO_MODE ((umode_t)(-1))
Pavel Shilovsky226730b2013-07-05 12:00:30 +04001214struct cifs_open_parms {
1215 struct cifs_tcon *tcon;
1216 struct cifs_sb_info *cifs_sb;
1217 int disposition;
1218 int desired_access;
1219 int create_options;
1220 const char *path;
1221 struct cifs_fid *fid;
Steve Frenchce558b02018-05-31 19:16:54 -05001222 umode_t mode;
Pavel Shilovsky9cbc0b72013-07-09 18:40:58 +04001223 bool reconnect:1;
Pavel Shilovsky226730b2013-07-05 12:00:30 +04001224};
1225
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001226struct cifs_fid {
1227 __u16 netfid;
Pavel Shilovskyf0df7372012-09-18 16:20:26 -07001228 __u64 persistent_fid; /* persist file id for smb2 */
1229 __u64 volatile_fid; /* volatile file id for smb2 */
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -07001230 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
Steve Frenchb56eae42015-11-03 09:26:27 -06001231 __u8 create_guid[16];
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001232 struct cifs_pending_open *pending_open;
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001233 unsigned int epoch;
Steve Frenchdfe33f92018-10-30 19:50:31 -05001234#ifdef CONFIG_CIFS_DEBUG2
1235 __u64 mid;
1236#endif /* CIFS_DEBUG2 */
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001237 bool purge_cache;
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001238};
1239
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001240struct cifs_fid_locks {
1241 struct list_head llist;
1242 struct cifsFileInfo *cfile; /* fid that owns locks */
1243 struct list_head locks; /* locks held by fid above */
1244};
1245
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246struct cifsFileInfo {
Steve French3afca262016-09-22 18:58:16 -05001247 /* following two lists are protected by tcon->open_file_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 struct list_head tlist; /* pointer to next fid owned by tcon */
1249 struct list_head flist; /* next fid (file instance) for this inode */
Steve French3afca262016-09-22 18:58:16 -05001250 /* lock list below protected by cifsi->lock_sem */
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001251 struct cifs_fid_locks *llist; /* brlocks held by this fid */
Eric W. Biedermanfef59fd2013-02-06 02:23:02 -08001252 kuid_t uid; /* allows finding which FileInfo structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 __u32 pid; /* process id who opened file */
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001254 struct cifs_fid fid; /* file id from remote */
Pavel Shilovskyf2cca6a2016-10-07 17:26:36 -07001255 struct list_head rlist; /* reconnect list */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 /* BB add lock scope info here if needed */ ;
1257 /* lock scope id (0 if none) */
Jeff Laytona5e18bc2010-10-11 15:07:18 -04001258 struct dentry *dentry;
Jeff Layton13cfb732010-09-29 19:51:11 -04001259 struct tcon_link *tlink;
Steve French3afca262016-09-22 18:58:16 -05001260 unsigned int f_flags;
Steve French4b18f2a2008-04-29 00:06:05 +00001261 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -04001262 bool oplock_break_cancelled:1;
Steve French3afca262016-09-22 18:58:16 -05001263 int count;
1264 spinlock_t file_info_lock; /* protects four flag/count fields above */
Steve Frencha6ce4932009-04-09 01:14:32 +00001265 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 struct cifs_search_info srch_inf;
Tejun Heo9b646972010-07-20 22:09:02 +02001267 struct work_struct oplock_break; /* work for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268};
1269
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001270struct cifs_io_parms {
1271 __u16 netfid;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001272 __u64 persistent_fid; /* persist file id for smb2 */
1273 __u64 volatile_fid; /* volatile file id for smb2 */
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001274 __u32 pid;
1275 __u64 offset;
1276 unsigned int length;
Steve French96daf2b2011-05-27 04:34:02 +00001277 struct cifs_tcon *tcon;
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001278};
1279
Pavel Shilovskyccf7f402017-04-25 11:52:29 -07001280struct cifs_aio_ctx {
1281 struct kref refcount;
1282 struct list_head list;
1283 struct mutex aio_mutex;
1284 struct completion done;
1285 struct iov_iter iter;
1286 struct kiocb *iocb;
1287 struct cifsFileInfo *cfile;
1288 struct bio_vec *bv;
Pavel Shilovskyc610c4b2017-04-25 11:52:31 -07001289 loff_t pos;
Pavel Shilovskyccf7f402017-04-25 11:52:29 -07001290 unsigned int npages;
1291 ssize_t rc;
1292 unsigned int len;
1293 unsigned int total_len;
1294 bool should_dirty;
Long Li6e6e2b82018-10-31 22:13:09 +00001295 /*
1296 * Indicates if this aio_ctx is for direct_io,
1297 * If yes, iter is a copy of the user passed iov_iter
1298 */
1299 bool direct_io;
Pavel Shilovskyccf7f402017-04-25 11:52:29 -07001300};
1301
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001302struct cifs_readdata;
1303
1304/* asynchronous read support */
1305struct cifs_readdata {
1306 struct kref refcount;
1307 struct list_head list;
1308 struct completion done;
1309 struct cifsFileInfo *cfile;
1310 struct address_space *mapping;
Pavel Shilovsky6685c5e2017-04-25 11:52:30 -07001311 struct cifs_aio_ctx *ctx;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001312 __u64 offset;
1313 unsigned int bytes;
Pavel Shilovsky34a54d62014-07-10 10:03:29 +04001314 unsigned int got_bytes;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001315 pid_t pid;
1316 int result;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001317 struct work_struct work;
Jeff Layton8321fec2012-09-19 06:22:32 -07001318 int (*read_into_pages)(struct TCP_Server_Info *server,
1319 struct cifs_readdata *rdata,
1320 unsigned int len);
Pavel Shilovskyd70b9102016-11-17 16:20:18 -08001321 int (*copy_into_pages)(struct TCP_Server_Info *server,
1322 struct cifs_readdata *rdata,
1323 struct iov_iter *iter);
Pavel Shilovsky738f9de2016-11-23 15:14:57 -08001324 struct kvec iov[2];
Long Li74dcf412017-11-22 17:38:46 -07001325#ifdef CONFIG_CIFS_SMB_DIRECT
1326 struct smbd_mr *mr;
1327#endif
Jeff Layton8321fec2012-09-19 06:22:32 -07001328 unsigned int pagesz;
Long Li57a929a2018-05-30 12:47:53 -07001329 unsigned int page_offset;
Jeff Layton8321fec2012-09-19 06:22:32 -07001330 unsigned int tailsz;
Pavel Shilovsky335b7b62019-01-16 11:12:41 -08001331 struct cifs_credits credits;
Jeff Laytonc5fab6f2012-09-19 06:22:30 -07001332 unsigned int nr_pages;
Long Lif9f5aca2018-05-30 12:47:54 -07001333 struct page **pages;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001334};
1335
Pavel Shilovsky33319142012-09-18 16:20:29 -07001336struct cifs_writedata;
1337
1338/* asynchronous write support */
1339struct cifs_writedata {
1340 struct kref refcount;
1341 struct list_head list;
1342 struct completion done;
1343 enum writeback_sync_modes sync_mode;
1344 struct work_struct work;
1345 struct cifsFileInfo *cfile;
Pavel Shilovskyc610c4b2017-04-25 11:52:31 -07001346 struct cifs_aio_ctx *ctx;
Pavel Shilovsky33319142012-09-18 16:20:29 -07001347 __u64 offset;
1348 pid_t pid;
1349 unsigned int bytes;
1350 int result;
Long Lidb223a52017-11-22 17:38:45 -07001351#ifdef CONFIG_CIFS_SMB_DIRECT
1352 struct smbd_mr *mr;
1353#endif
Jeff Laytoneddb0792012-09-18 16:20:35 -07001354 unsigned int pagesz;
Long Li57a929a2018-05-30 12:47:53 -07001355 unsigned int page_offset;
Jeff Laytoneddb0792012-09-18 16:20:35 -07001356 unsigned int tailsz;
Pavel Shilovsky335b7b62019-01-16 11:12:41 -08001357 struct cifs_credits credits;
Pavel Shilovsky33319142012-09-18 16:20:29 -07001358 unsigned int nr_pages;
Long Li8e7360f2018-05-30 12:47:56 -07001359 struct page **pages;
Pavel Shilovsky33319142012-09-18 16:20:29 -07001360};
1361
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001362/*
1363 * Take a reference on the file private data. Must be called with
Steve French3afca262016-09-22 18:58:16 -05001364 * cfile->file_info_lock held.
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001365 */
Jeff Layton764a1b12012-07-25 14:59:54 -04001366static inline void
1367cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001368{
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001369 ++cifs_file->count;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001370}
1371
Jeff Layton764a1b12012-07-25 14:59:54 -04001372struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
Aurelien Aptelb98749c2019-03-29 10:49:12 +01001373void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr);
Jeff Laytonb33879a2010-10-15 15:34:04 -04001374void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001375
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001376#define CIFS_CACHE_READ_FLG 1
1377#define CIFS_CACHE_HANDLE_FLG 2
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001378#define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001379#define CIFS_CACHE_WRITE_FLG 4
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001380#define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1381#define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001382
Steve French83bbfa72019-08-27 23:58:54 -05001383#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))
Pavel Shilovsky53ef1012013-09-05 16:11:28 +04001384#define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
Steve French41e033f2019-08-30 02:12:41 -05001385#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))
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001386
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387/*
1388 * One of these for each file inode
1389 */
1390
1391struct cifsInodeInfo {
Pavel Shilovskyd59dad22011-09-22 09:53:59 +04001392 bool can_cache_brlcks;
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001393 struct list_head llist; /* locks helb by this inode */
Dave Wysochanskid46b0da2019-10-23 05:02:33 -04001394 /*
1395 * NOTE: Some code paths call down_read(lock_sem) twice, so
1396 * we must always use use cifs_down_write() instead of down_write()
1397 * for this semaphore to avoid deadlocks.
1398 */
Pavel Shilovsky1b4b55a2012-09-19 06:22:44 -07001399 struct rw_semaphore lock_sem; /* protect the fields above */
Steve Frenchd38d8c72007-06-28 19:44:13 +00001400 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 struct list_head openFileList;
Ronnie Sahlberg487317c2019-06-05 10:38:38 +10001402 spinlock_t open_file_lock; /* protects openFileList */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001404 unsigned int oplock; /* oplock/lease level we have */
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001405 unsigned int epoch; /* used to track lease state changes */
Sachin Prabhuc11f1df2014-03-11 16:11:47 +00001406#define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1407#define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1408#define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
Jeff Laytonaff8d5c2014-04-30 09:31:45 -04001409#define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1410#define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
Jeff Layton4f73c7d2014-04-30 09:31:47 -04001411#define CIFS_INO_LOCK (5) /* lock bit for synchronization */
Jeff Laytonaff8d5c2014-04-30 09:31:45 -04001412 unsigned long flags;
Sachin Prabhuc11f1df2014-03-11 16:11:47 +00001413 spinlock_t writers_lock;
1414 unsigned int writers; /* Number of writers on this inode */
Jeff Laytonaae62fd2011-01-20 13:36:50 -05001415 unsigned long time; /* jiffies of last update of inode */
Jeff Layton597b0272012-03-23 14:40:56 -04001416 u64 server_eof; /* current file size on server -- protected by i_lock */
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001417 u64 uniqueid; /* server inode number */
Jeff Layton20054bd2011-01-07 11:30:27 -05001418 u64 createtime; /* creation time on server */
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -07001419 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +05301420#ifdef CONFIG_CIFS_FSCACHE
1421 struct fscache_cookie *fscache;
1422#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 struct inode vfs_inode;
1424};
1425
1426static inline struct cifsInodeInfo *
1427CIFS_I(struct inode *inode)
1428{
1429 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1430}
1431
1432static inline struct cifs_sb_info *
1433CIFS_SB(struct super_block *sb)
1434{
1435 return sb->s_fs_info;
1436}
1437
Al Viro7119e222014-10-22 00:25:12 -04001438static inline struct cifs_sb_info *
1439CIFS_FILE_SB(struct file *file)
1440{
1441 return CIFS_SB(file_inode(file)->i_sb);
1442}
1443
Steve Frenchab2f2182005-09-15 20:44:50 -07001444static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -07001445{
1446 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1447 return '/';
1448 else
1449 return '\\';
1450}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Steve Frenchf87d39d2011-05-27 03:50:55 +00001452static inline void
1453convert_delimiter(char *path, char delim)
1454{
Steve French1cc9bd62012-11-29 18:07:51 -06001455 char old_delim, *pos;
Steve Frenchf87d39d2011-05-27 03:50:55 +00001456
1457 if (delim == '/')
1458 old_delim = '\\';
1459 else
1460 old_delim = '/';
1461
Steve French1cc9bd62012-11-29 18:07:51 -06001462 pos = path;
1463 while ((pos = strchr(pos, old_delim)))
1464 *pos = delim;
Steve Frenchf87d39d2011-05-27 03:50:55 +00001465}
1466
Steve Frencha4544342005-08-24 13:59:35 -07001467#define cifs_stats_inc atomic_inc
1468
Steve French96daf2b2011-05-27 04:34:02 +00001469static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
Steve Frencha4544342005-08-24 13:59:35 -07001470 unsigned int bytes)
1471{
1472 if (bytes) {
1473 spin_lock(&tcon->stat_lock);
1474 tcon->bytes_written += bytes;
1475 spin_unlock(&tcon->stat_lock);
1476 }
1477}
1478
Steve French96daf2b2011-05-27 04:34:02 +00001479static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
Steve Frencha4544342005-08-24 13:59:35 -07001480 unsigned int bytes)
1481{
1482 spin_lock(&tcon->stat_lock);
1483 tcon->bytes_read += bytes;
1484 spin_unlock(&tcon->stat_lock);
1485}
Steve Frencha4544342005-08-24 13:59:35 -07001486
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001487
1488/*
Jeff Layton44d22d82011-10-19 15:29:49 -04001489 * This is the prototype for the mid receive function. This function is for
1490 * receiving the rest of the SMB frame, starting with the WordCount (which is
1491 * just after the MID in struct smb_hdr). Note:
1492 *
1493 * - This will be called by cifsd, with no locks held.
1494 * - The mid will still be on the pending_mid_q.
1495 * - mid->resp_buf will point to the current buffer.
1496 *
1497 * Returns zero on a successful receive, or an error. The receive state in
1498 * the TCP_Server_Info will also be updated.
1499 */
1500typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1501 struct mid_q_entry *mid);
1502
1503/*
1504 * This is the prototype for the mid callback function. This is called once the
1505 * mid has been received off of the socket. When creating one, take special
1506 * care to avoid deadlocks. Things to bear in mind:
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001507 *
Jeff Layton3c1105d2011-05-22 07:09:13 -04001508 * - it will be called by cifsd, with no locks held
1509 * - the mid will be removed from any lists
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001510 */
1511typedef void (mid_callback_t)(struct mid_q_entry *mid);
1512
Pavel Shilovsky9b7c18a2016-11-16 14:06:17 -08001513/*
1514 * This is the protopyte for mid handle function. This is called once the mid
1515 * has been recognized after decryption of the message.
1516 */
1517typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1518 struct mid_q_entry *mid);
1519
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520/* one of these for every pending CIFS request to the server */
1521struct mid_q_entry {
1522 struct list_head qhead; /* mids waiting on reply from this server */
Lars Persson696e4202018-06-25 14:05:25 +02001523 struct kref refcount;
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +04001524 struct TCP_Server_Info *server; /* server corresponding to this mid */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001525 __u64 mid; /* multiplex id */
Pavel Shilovskyc781af72019-03-04 14:02:50 -08001526 __u16 credits; /* number of credits consumed by this mid */
Pavel Shilovsky86a79642019-11-21 11:35:13 -08001527 __u16 credits_received; /* number of credits from the response */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001528 __u32 pid; /* process id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -07001530 unsigned long when_alloc; /* when mid was created */
1531#ifdef CONFIG_CIFS_STATS2
1532 unsigned long when_sent; /* time when smb send finished */
1533 unsigned long when_received; /* when demux complete (taken off wire) */
1534#endif
Jeff Layton44d22d82011-10-19 15:29:49 -04001535 mid_receive_t *receive; /* call receive callback */
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001536 mid_callback_t *callback; /* call completion callback */
Pavel Shilovsky9b7c18a2016-11-16 14:06:17 -08001537 mid_handle_t *handle; /* call handle mid callback */
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001538 void *callback_data; /* general purpose pointer for callback */
Pavel Shilovskyd4e48542012-03-23 14:28:02 -04001539 void *resp_buf; /* pointer to received SMB header */
Ronnie Sahlberge19b2bc2018-04-09 18:06:28 +10001540 unsigned int resp_buf_size;
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001541 int mid_state; /* wish this were enum but can not pass to wait_event */
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001542 unsigned int mid_flags;
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001543 __le16 command; /* smb command code */
Pavel Shilovsky8a26f0f2019-01-03 16:45:27 -08001544 unsigned int optype; /* operation type */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001545 bool large_buf:1; /* if valid response, is pointer to large buf */
Steve French4b18f2a2008-04-29 00:06:05 +00001546 bool multiRsp:1; /* multiple trans2 responses for one request */
1547 bool multiEnd:1; /* both received */
Pavel Shilovsky4326ed22016-11-17 15:24:46 -08001548 bool decrypted:1; /* decrypted entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549};
1550
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001551struct close_cancelled_open {
1552 struct cifs_fid fid;
1553 struct cifs_tcon *tcon;
1554 struct work_struct work;
Ronnie Sahlberg87bc2372019-11-14 12:32:12 -06001555 __u64 mid;
1556 __u16 cmd;
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001557};
1558
Steve French789e6662011-08-09 18:44:44 +00001559/* Make code in transport.c a little cleaner by moving
1560 update of optional stats into function below */
1561#ifdef CONFIG_CIFS_STATS2
1562
1563static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1564{
1565 atomic_inc(&server->in_send);
1566}
1567
1568static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1569{
1570 atomic_dec(&server->in_send);
1571}
1572
1573static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1574{
1575 atomic_inc(&server->num_waiters);
1576}
1577
1578static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1579{
1580 atomic_dec(&server->num_waiters);
1581}
1582
1583static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1584{
1585 mid->when_sent = jiffies;
1586}
1587#else
1588static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1589{
1590}
1591static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1592{
1593}
1594
1595static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1596{
1597}
1598
1599static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1600{
1601}
1602
1603static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1604{
1605}
1606#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
Steve Frenchff5dbd92005-08-24 17:10:36 -07001608/* for pending dnotify requests */
1609struct dir_notify_req {
Steve French13cd4b72010-10-07 18:46:32 +00001610 struct list_head lhead;
1611 __le16 Pid;
1612 __le16 PidHigh;
1613 __u16 Mid;
1614 __u16 Tid;
1615 __u16 Uid;
1616 __u16 netfid;
1617 __u32 filter; /* CompletionFilter (for multishot) */
1618 int multishot;
1619 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -07001620};
1621
Steve French366781c2008-01-25 10:12:41 +00001622struct dfs_info3_param {
1623 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +00001624 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +00001625 int server_type;
1626 int ref_flag;
1627 char *path_name;
1628 char *node_name;
Paulo Alcantarae7b602f2018-11-14 15:38:51 -02001629 int ttl;
Steve French366781c2008-01-25 10:12:41 +00001630};
1631
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001632/*
1633 * common struct for holding inode info when searching for or updating an
1634 * inode with new info
1635 */
1636
1637#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -04001638#define CIFS_FATTR_DELETE_PENDING 0x2
1639#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -04001640#define CIFS_FATTR_INO_COLLISION 0x8
Jim McDonough74d290d2013-09-21 10:36:10 -05001641#define CIFS_FATTR_UNKNOWN_NLINK 0x10
Steve French7ea884c2018-03-31 18:13:38 -05001642#define CIFS_FATTR_FAKE_ROOT_INO 0x20
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001643
1644struct cifs_fattr {
1645 u32 cf_flags;
1646 u32 cf_cifsattrs;
1647 u64 cf_uniqueid;
1648 u64 cf_eof;
1649 u64 cf_bytes;
Jeff Layton20054bd2011-01-07 11:30:27 -05001650 u64 cf_createtime;
Eric W. Biederman4a2c8cf2013-02-06 01:53:25 -08001651 kuid_t cf_uid;
1652 kgid_t cf_gid;
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001653 umode_t cf_mode;
1654 dev_t cf_rdev;
1655 unsigned int cf_nlink;
1656 unsigned int cf_dtype;
Arnd Bergmann95390202018-06-19 17:27:58 +02001657 struct timespec64 cf_atime;
1658 struct timespec64 cf_mtime;
1659 struct timespec64 cf_ctime;
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001660};
1661
Steve French366781c2008-01-25 10:12:41 +00001662static inline void free_dfs_info_param(struct dfs_info3_param *param)
1663{
1664 if (param) {
1665 kfree(param->path_name);
1666 kfree(param->node_name);
Steve French366781c2008-01-25 10:12:41 +00001667 }
1668}
1669
1670static inline void free_dfs_info_array(struct dfs_info3_param *param,
1671 int number_of_items)
1672{
1673 int i;
1674 if ((number_of_items == 0) || (param == NULL))
1675 return;
1676 for (i = 0; i < number_of_items; i++) {
1677 kfree(param[i].path_name);
1678 kfree(param[i].node_name);
1679 }
1680 kfree(param);
1681}
1682
Pavel Shilovsky9a663962019-01-08 11:15:28 -08001683static inline bool is_interrupt_error(int error)
1684{
1685 switch (error) {
1686 case -EINTR:
1687 case -ERESTARTSYS:
1688 case -ERESTARTNOHAND:
1689 case -ERESTARTNOINTR:
1690 return true;
1691 }
1692 return false;
1693}
1694
1695static inline bool is_retryable_error(int error)
1696{
1697 if (is_interrupt_error(error) || error == -EAGAIN)
1698 return true;
1699 return false;
1700}
1701
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702#define MID_FREE 0
1703#define MID_REQUEST_ALLOCATED 1
1704#define MID_REQUEST_SUBMITTED 2
1705#define MID_RESPONSE_RECEIVED 4
1706#define MID_RETRY_NEEDED 8 /* session closed while this request out */
Jeff Layton71823ba2011-02-10 08:03:50 -05001707#define MID_RESPONSE_MALFORMED 0x10
Jeff Layton3c1105d2011-05-22 07:09:13 -04001708#define MID_SHUTDOWN 0x20
Steve Frenchec637e32005-12-12 20:53:18 -08001709
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001710/* Flags */
1711#define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
Ronnie Sahlbergddf83af2018-08-30 10:12:59 +10001712#define MID_DELETED 2 /* Mid has been dequeued/deleted */
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001713
Steve Frenchec637e32005-12-12 20:53:18 -08001714/* Types of response buffer returned from SendReceive2 */
1715#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1716#define CIFS_SMALL_BUFFER 1
1717#define CIFS_LARGE_BUFFER 2
1718#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719
Steve French133672e2007-11-13 22:41:37 +00001720/* Type of Request to SendReceive2 */
Jeff Layton77499812011-01-11 07:24:23 -05001721#define CIFS_BLOCKING_OP 1 /* operation can block */
Ronnie Sahlberg392e1c52019-05-06 10:00:02 +10001722#define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
Jeff Layton77499812011-01-11 07:24:23 -05001723#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
Steve French133672e2007-11-13 22:41:37 +00001724#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1725#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
Ronnie Sahlberg392e1c52019-05-06 10:00:02 +10001726#define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
Steve French133672e2007-11-13 22:41:37 +00001727
Pavel Shilovskya891f0f2012-05-23 16:14:34 +04001728/* Type of request operation */
1729#define CIFS_ECHO_OP 0x080 /* echo request */
1730#define CIFS_OBREAK_OP 0x0100 /* oplock break request */
Pavel Shilovskyec2e4522011-12-27 16:12:43 +04001731#define CIFS_NEG_OP 0x0200 /* negotiate request */
1732#define CIFS_OP_MASK 0x0380 /* mask request type */
Pavel Shilovsky7fb89862016-10-31 13:49:30 -07001733
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +04001734#define CIFS_HAS_CREDITS 0x0400 /* already has credits */
Pavel Shilovsky7fb89862016-10-31 13:49:30 -07001735#define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
Ronnie Sahlbergd69cb722019-05-01 12:03:41 +10001736#define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
Pavel Shilovskya891f0f2012-05-23 16:14:34 +04001737
Steve French39798772006-05-31 22:40:51 +00001738/* Security Flags: indicate type of session setup needed */
1739#define CIFSSEC_MAY_SIGN 0x00001
1740#define CIFSSEC_MAY_NTLM 0x00002
1741#define CIFSSEC_MAY_NTLMV2 0x00004
1742#define CIFSSEC_MAY_KRB5 0x00008
1743#ifdef CONFIG_CIFS_WEAK_PW_HASH
1744#define CIFSSEC_MAY_LANMAN 0x00010
1745#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +00001746#else
1747#define CIFSSEC_MAY_LANMAN 0
1748#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +00001749#endif /* weak passwords */
1750#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +00001751#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +00001752
Steve French39798772006-05-31 22:40:51 +00001753#define CIFSSEC_MUST_SIGN 0x01001
1754/* note that only one of the following can be set so the
1755result of setting MUST flags more than once will be to
1756require use of the stronger protocol */
1757#define CIFSSEC_MUST_NTLM 0x02002
1758#define CIFSSEC_MUST_NTLMV2 0x04004
1759#define CIFSSEC_MUST_KRB5 0x08008
1760#ifdef CONFIG_CIFS_WEAK_PW_HASH
1761#define CIFSSEC_MUST_LANMAN 0x10010
1762#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001763#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -04001764#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +00001765#else
Chuck Ebbert20d17522009-09-15 01:53:21 -04001766#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +00001767#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001768#else /* do not allow weak pw hash */
Steve French88a44122012-01-18 17:13:47 -06001769#define CIFSSEC_MUST_LANMAN 0
1770#define CIFSSEC_MUST_PLNTXT 0
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001771#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +00001772#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001773#else
Steve Frenchac683922009-05-06 04:16:04 +00001774#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +00001775#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +00001776#endif /* WEAK_PW_HASH */
1777#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +00001778#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +00001779
Jeff Layton896a8fc2013-05-26 07:01:01 -04001780#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +00001781#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +00001782#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783/*
1784 *****************************************************************
1785 * All constants go here
1786 *****************************************************************
1787 */
1788
1789#define UID_HASH (16)
1790
1791/*
1792 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1793 * following to be declared.
1794 */
1795
1796/****************************************************************************
1797 * Locking notes. All updates to global variables and lists should be
1798 * protected by spinlocks or semaphores.
1799 *
1800 * Spinlocks
1801 * ---------
1802 * GlobalMid_Lock protects:
1803 * list operations on pending_mid_q and oplockQ
1804 * updates to XID counters, multiplex id and SMB sequence numbers
Steve French65525802019-03-13 18:21:38 -05001805 * list operations on global DnotifyReqList
Steve French3afca262016-09-22 18:58:16 -05001806 * tcp_ses_lock protects:
1807 * list operations on tcp and SMB session lists
1808 * tcon->open_file_lock protects the list of open files hanging off the tcon
Ronnie Sahlberg487317c2019-06-05 10:38:38 +10001809 * inode->open_file_lock protects the openFileList hanging off the inode
Steve French3afca262016-09-22 18:58:16 -05001810 * cfile->file_info_lock protects counters and fields in cifs file struct
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 * f_owner.lock protects certain per file struct operations
1812 * mapping->page_lock protects certain per page operations
1813 *
Ronnie Sahlberg487317c2019-06-05 10:38:38 +10001814 * Note that the cifs_tcon.open_file_lock should be taken before
1815 * not after the cifsInodeInfo.open_file_lock
1816 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 * Semaphores
1818 * ----------
1819 * sesSem operations on smb session
1820 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +00001821 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 *
1823 ****************************************************************************/
1824
1825#ifdef DECLARE_GLOBALS_HERE
1826#define GLOBAL_EXTERN
1827#else
1828#define GLOBAL_EXTERN extern
1829#endif
1830
Jeff Laytone7ddee92008-11-14 13:44:38 -05001831/*
1832 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +00001833 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -05001834 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +00001835 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -05001836 * by iterating over cifs_tcp_ses_list
1837 */
1838GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1839
Jeff Laytonf1987b42008-11-15 11:12:47 -05001840/*
1841 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1842 * tcp session, and the list of tcon's per smb session. It also protects
1843 * the reference counters for the server, smb session, and tcon. Finally,
1844 * changes to the tcon->tidStatus should be done while holding this lock.
Steve French3afca262016-09-22 18:58:16 -05001845 * generally the locks should be taken in order tcp_ses_lock before
1846 * tcon->open_file_lock and that before file->file_info_lock since the
1847 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
Jeff Laytonf1987b42008-11-15 11:12:47 -05001848 */
Suresh Jayaraman3f9bcca2010-10-18 23:29:37 +05301849GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +00001850
Steve French0eff0e22011-02-24 05:39:23 +00001851#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
Steve French99ee4db2007-02-27 05:35:17 +00001852/* Outstanding dir notify requests */
1853GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1854/* DirNotify response queue */
1855GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve French0eff0e22011-02-24 05:39:23 +00001856#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
Steve Frenchff5dbd92005-08-24 17:10:36 -07001857
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858/*
1859 * Global transaction id (XID) information
1860 */
1861GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +00001862GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +00001864GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1865 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866/*
1867 * Global counters, updated atomically
1868 */
1869GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1870GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1871GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1872GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1873GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1874
Steve Frenchaaa9bbe2008-05-23 17:38:32 +00001875/* Various Debug counters */
Steve French4498eed52005-12-03 13:58:57 -08001876GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1877#ifdef CONFIG_CIFS_STATS2
1878GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1879GLOBAL_EXTERN atomic_t totSmBufAllocCount;
Steve French00778e22018-09-18 14:05:18 -05001880extern unsigned int slow_rsp_threshold; /* number of secs before logging */
Steve French4498eed52005-12-03 13:58:57 -08001881#endif
1882GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883GLOBAL_EXTERN atomic_t midCount;
1884
1885/* Misc globals */
Steve Frenchf92a7202018-05-24 04:11:07 -05001886extern bool enable_oplocks; /* enable or disable oplocks */
1887extern bool lookupCacheEnabled;
1888extern unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 with more secure ntlmssp2 challenge/resp */
Steve Frenchf92a7202018-05-24 04:11:07 -05001890extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1891extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1892extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1893extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1894extern unsigned int cifs_min_small; /* min size of small buf pool */
1895extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1896extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897
Shirish Pargaonkar4d79dba2011-04-27 23:34:35 -05001898GLOBAL_EXTERN struct rb_root uidtree;
1899GLOBAL_EXTERN struct rb_root gidtree;
1900GLOBAL_EXTERN spinlock_t siduidlock;
1901GLOBAL_EXTERN spinlock_t sidgidlock;
Shirish Pargaonkar21fed0d2011-08-09 14:30:48 -05001902GLOBAL_EXTERN struct rb_root siduidtree;
1903GLOBAL_EXTERN struct rb_root sidgidtree;
1904GLOBAL_EXTERN spinlock_t uidsidlock;
1905GLOBAL_EXTERN spinlock_t gidsidlock;
Shirish Pargaonkar4d79dba2011-04-27 23:34:35 -05001906
Tejun Heo9b646972010-07-20 22:09:02 +02001907void cifs_oplock_break(struct work_struct *work);
Aurelien Aptelb98749c2019-03-29 10:49:12 +01001908void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
Linus Torvalds3b7433b2010-08-07 12:42:58 -07001909
Jeff Layton3bc303c2009-09-21 06:47:50 -04001910extern const struct slow_work_ops cifs_oplock_break_ops;
Jeff Laytonda472fc2012-03-23 14:40:53 -04001911extern struct workqueue_struct *cifsiod_wq;
Steve French35cf94a2019-09-07 01:09:49 -05001912extern struct workqueue_struct *decrypt_wq;
Rabin Vincent3998e6b82017-05-03 17:54:01 +02001913extern struct workqueue_struct *cifsoplockd_wq;
Jeff Layton3d224622016-05-24 06:27:44 -04001914extern __u32 cifs_lock_secret;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +05301915
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +04001916extern mempool_t *cifs_mid_poolp;
1917
Jeff Layton23db65f2012-05-15 12:20:51 -04001918/* Operations for different SMB versions */
1919#define SMB1_VERSION_STRING "1.0"
1920extern struct smb_version_operations smb1_operations;
1921extern struct smb_version_values smb1_values;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001922#define SMB20_VERSION_STRING "2.0"
Pavel Shilovsky53ef1012013-09-05 16:11:28 +04001923extern struct smb_version_operations smb20_operations;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001924extern struct smb_version_values smb20_values;
Steve French1080ef72011-02-24 18:07:19 +00001925#define SMB21_VERSION_STRING "2.1"
1926extern struct smb_version_operations smb21_operations;
1927extern struct smb_version_values smb21_values;
Steve French9764c022017-09-17 10:41:35 -05001928#define SMBDEFAULT_VERSION_STRING "default"
1929extern struct smb_version_values smbdefault_values;
1930#define SMB3ANY_VERSION_STRING "3"
1931extern struct smb_version_values smb3any_values;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001932#define SMB30_VERSION_STRING "3.0"
Steve French38107d42012-12-08 22:08:06 -06001933extern struct smb_version_operations smb30_operations;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001934extern struct smb_version_values smb30_values;
Steve French20b6d8b2013-06-12 22:48:41 -05001935#define SMB302_VERSION_STRING "3.02"
Kenneth D'souza4a3b38a2018-11-17 10:33:30 +05301936#define ALT_SMB302_VERSION_STRING "3.0.2"
Steve French20b6d8b2013-06-12 22:48:41 -05001937/*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1938extern struct smb_version_values smb302_values;
Steve French5f7fbf72014-12-17 22:52:58 -06001939#define SMB311_VERSION_STRING "3.1.1"
Steve Frenchaab18932015-06-23 23:37:11 -05001940#define ALT_SMB311_VERSION_STRING "3.11"
1941extern struct smb_version_operations smb311_operations;
Steve French5f7fbf72014-12-17 22:52:58 -06001942extern struct smb_version_values smb311_values;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +05301943#endif /* _CIFS_GLOB_H */