blob: 3f12da7f2f7f6e708f6e09fc8319a3a82099fa14 [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);
Pavel Shilovskyf4367202012-03-17 11:41:12 +0300334 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
335 struct cifs_sb_info *);
336 /* set info on created directory */
337 void (*mkdir_setinfo)(struct inode *, const char *,
338 struct cifs_sb_info *, struct cifs_tcon *,
339 const unsigned int);
Pavel Shilovskyf958ca52012-07-10 16:14:18 +0400340 /* remove directory */
341 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
342 struct cifs_sb_info *);
Pavel Shilovskyed6875e2012-09-18 16:20:25 -0700343 /* unlink file */
344 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
345 struct cifs_sb_info *);
346 /* open, rename and delete file */
347 int (*rename_pending_delete)(const char *, struct dentry *,
348 const unsigned int);
Pavel Shilovsky8ceb9842012-09-18 16:20:30 -0700349 /* send rename request */
350 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
351 const char *, struct cifs_sb_info *);
Steve Frenchd6e906f2012-09-18 16:20:31 -0700352 /* send create hardlink request */
353 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
354 const char *, const char *,
355 struct cifs_sb_info *);
Pavel Shilovskyb42bf882013-08-14 19:25:21 +0400356 /* query symlink target */
357 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
Ronnie Sahlbergebaf5462019-04-10 08:44:46 +1000358 struct cifs_sb_info *, const char *,
359 char **, bool);
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700360 /* open a file for non-posix mounts */
Pavel Shilovsky226730b2013-07-05 12:00:30 +0400361 int (*open)(const unsigned int, struct cifs_open_parms *,
362 __u32 *, FILE_ALL_INFO *);
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700363 /* set fid protocol-specific info */
364 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
Pavel Shilovsky0ff78a22012-09-18 16:20:26 -0700365 /* close a file */
Pavel Shilovsky760ad0c2012-09-25 11:00:07 +0400366 void (*close)(const unsigned int, struct cifs_tcon *,
367 struct cifs_fid *);
Pavel Shilovsky1d8c4c02012-09-18 16:20:27 -0700368 /* send a flush request to the server */
369 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
Pavel Shilovskyfc9c5962012-09-18 16:20:28 -0700370 /* async read from the server */
371 int (*async_readv)(struct cifs_readdata *);
Pavel Shilovskyc9de5c82012-09-18 16:20:29 -0700372 /* async write to the server */
Steve French4a5c80d2014-02-07 20:45:12 -0600373 int (*async_writev)(struct cifs_writedata *,
374 void (*release)(struct kref *));
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700375 /* sync read from the server */
Steve Frenchdb8b6312014-09-22 05:13:55 -0500376 int (*sync_read)(const unsigned int, struct cifs_fid *,
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700377 struct cifs_io_parms *, unsigned int *, char **,
378 int *);
Pavel Shilovskyba9ad7252012-09-18 16:20:30 -0700379 /* sync write to the server */
Steve Frenchdb8b6312014-09-22 05:13:55 -0500380 int (*sync_write)(const unsigned int, struct cifs_fid *,
Pavel Shilovskyba9ad7252012-09-18 16:20:30 -0700381 struct cifs_io_parms *, unsigned int *, struct kvec *,
382 unsigned long);
Pavel Shilovsky92fc65a2012-09-18 16:20:32 -0700383 /* open dir, start readdir */
384 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
385 const char *, struct cifs_sb_info *,
386 struct cifs_fid *, __u16,
387 struct cifs_search_info *);
388 /* continue readdir */
389 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
390 struct cifs_fid *,
391 __u16, struct cifs_search_info *srch_inf);
392 /* close dir */
393 int (*close_dir)(const unsigned int, struct cifs_tcon *,
394 struct cifs_fid *);
395 /* calculate a size of SMB message */
Ronnie Sahlberg9ec672b2018-04-22 15:30:12 -0600396 unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi);
Pavel Shilovsky66265f12019-01-23 17:11:16 -0800397 /* check for STATUS_PENDING and process the response if yes */
398 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server);
Pavel Shilovsky511c54a2017-07-08 14:32:00 -0700399 /* check for STATUS_NETWORK_SESSION_EXPIRED */
400 bool (*is_session_expired)(char *);
Pavel Shilovsky95a3f2f2012-09-18 16:20:33 -0700401 /* send oplock break response */
402 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
403 struct cifsInodeInfo *);
Pavel Shilovsky76ec5e32012-09-18 16:20:33 -0700404 /* query remote filesystem */
405 int (*queryfs)(const unsigned int, struct cifs_tcon *,
406 struct kstatfs *);
Pavel Shilovskyd39a4f72012-09-19 06:22:43 -0700407 /* send mandatory brlock to the server */
408 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
409 __u64, __u32, int, int, bool);
410 /* unlock range of mandatory locks */
411 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
412 const unsigned int);
413 /* push brlocks from the cache to the server */
414 int (*push_mand_locks)(struct cifsFileInfo *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700415 /* get lease key of the inode */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400416 void (*get_lease_key)(struct inode *, struct cifs_fid *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700417 /* set lease key of the inode */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400418 void (*set_lease_key)(struct inode *, struct cifs_fid *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700419 /* generate new lease key */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400420 void (*new_lease_key)(struct cifs_fid *);
Shirish Pargaonkar32811d22013-08-29 08:35:11 -0500421 int (*generate_signingkey)(struct cifs_ses *);
Pavel Shilovsky53ef1012013-09-05 16:11:28 +0400422 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
Steve Frenchb3152e22015-06-24 03:17:02 -0500423 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
424 struct cifsFileInfo *src_file);
Steve French834170c2016-09-30 21:14:26 -0500425 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
426 struct cifsFileInfo *src_file, void __user *);
Sachin Prabhub5be1a12013-11-25 17:09:49 +0000427 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
428 struct cifs_sb_info *, const unsigned char *,
429 char *, unsigned int *);
Sachin Prabhucbb0aba2013-11-25 17:09:52 +0000430 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
431 struct cifs_sb_info *, const unsigned char *,
432 char *, unsigned int *);
Pavel Shilovsky53ef1012013-09-05 16:11:28 +0400433 /* if we can do cache read operations */
434 bool (*is_read_op)(__u32);
435 /* set oplock level for the inode */
Pavel Shilovsky42873b02013-09-05 21:30:16 +0400436 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
437 bool *);
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400438 /* create lease context buffer for CREATE request */
Stefano Brivio729c0c92018-07-05 15:10:02 +0200439 char * (*create_lease_buf)(u8 *lease_key, u8 oplock);
Pavel Shilovsky42873b02013-09-05 21:30:16 +0400440 /* parse lease context buffer and return oplock/epoch info */
Ronnie Sahlberg96164ab2018-04-26 08:10:18 -0600441 __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey);
Sachin Prabhu620d8742017-02-10 16:03:51 +0530442 ssize_t (*copychunk_range)(const unsigned int,
Sachin Prabhu312bbc52017-04-04 02:12:04 -0500443 struct cifsFileInfo *src_file,
Sachin Prabhu620d8742017-02-10 16:03:51 +0530444 struct cifsFileInfo *target_file,
445 u64 src_off, u64 len, u64 dest_off);
Steve French02b16662015-06-27 21:18:36 -0700446 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
447 struct cifsFileInfo *target_file, u64 src_off, u64 len,
448 u64 dest_off);
Steve Frenchff1c0382013-11-19 23:44:46 -0600449 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
Steve French666753c2014-01-26 23:53:43 -0600450 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
451 const unsigned char *, const unsigned char *, char *,
Steve French67b4c882017-05-12 20:59:10 -0500452 size_t, struct cifs_sb_info *);
Steve French666753c2014-01-26 23:53:43 -0600453 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
454 const char *, const void *, const __u16,
Ronnie Sahlberg55175542017-08-24 11:24:56 +1000455 const struct nls_table *, struct cifs_sb_info *);
Steve French83e3bc22014-02-02 23:31:47 -0600456 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
457 const char *, u32 *);
Steve French42eacf92014-02-10 14:08:16 -0600458 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
459 const struct cifs_fid *, u32 *);
Steve French83e3bc22014-02-02 23:31:47 -0600460 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
461 int);
Pavel Shilovsky7f6c5002014-06-22 11:03:22 +0400462 /* writepages retry size */
463 unsigned int (*wp_retry_size)(struct inode *);
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400464 /* get mtu credits */
465 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800466 unsigned int *, struct cifs_credits *);
Pavel Shilovsky9a1c67e2019-01-23 18:15:52 -0800467 /* adjust previously taken mtu credits to request size */
468 int (*adjust_credits)(struct TCP_Server_Info *server,
469 struct cifs_credits *credits,
470 const unsigned int payload_size);
Pavel Shilovsky52755802014-08-18 20:49:57 +0400471 /* check if we need to issue closedir */
472 bool (*dir_needs_close)(struct cifsFileInfo *);
Steve French31742c52014-08-17 08:38:47 -0500473 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
474 loff_t);
Pavel Shilovsky7fb89862016-10-31 13:49:30 -0700475 /* init transform request - used for encryption for now */
Ronnie Sahlbergb2c96de2018-08-01 09:26:11 +1000476 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst,
477 struct smb_rqst *, struct smb_rqst *);
Pavel Shilovsky9bb17e02016-11-17 15:24:34 -0800478 int (*is_transform_hdr)(void *buf);
479 int (*receive_transform)(struct TCP_Server_Info *,
Ronnie Sahlbergb24df3e2018-08-08 15:07:45 +1000480 struct mid_q_entry **, char **, int *);
Sachin Prabhuef65aae2017-01-18 15:35:57 +0530481 enum securityEnum (*select_sectype)(struct TCP_Server_Info *,
482 enum securityEnum);
Ronnie Sahlberg8ce79ec2018-06-01 10:53:08 +1000483 int (*next_header)(char *);
Ronnie Sahlbergf5b05d62018-10-07 19:19:58 -0500484 /* ioctl passthrough for query_info */
485 int (*ioctl_query_info)(const unsigned int xid,
Ronnie Sahlberg8d8b26e2018-10-17 05:47:58 +1000486 struct cifs_tcon *tcon,
487 __le16 *path, int is_dir,
Ronnie Sahlbergf5b05d62018-10-07 19:19:58 -0500488 unsigned long p);
Aurelien Aptelc847dcc2019-03-14 00:29:17 -0500489 /* make unix special files (block, char, fifo, socket) */
490 int (*make_node)(unsigned int xid,
491 struct inode *inode,
492 struct dentry *dentry,
493 struct cifs_tcon *tcon,
494 char *full_path,
495 umode_t mode,
496 dev_t device_number);
Ronnie Sahlberg2f3ebab2019-04-25 16:45:29 +1000497 /* version specific fiemap implementation */
498 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *,
499 struct fiemap_extent_info *, u64, u64);
Ronnie Sahlbergdece44e2019-05-15 07:17:02 +1000500 /* version specific llseek implementation */
501 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int);
Jeff Layton23db65f2012-05-15 12:20:51 -0400502};
503
504struct smb_version_values {
505 char *version_string;
Steve Frenche4aa25e2012-10-01 12:26:22 -0500506 __u16 protocol_id;
507 __u32 req_capabilities;
Pavel Shilovsky106dc532012-02-28 14:23:34 +0300508 __u32 large_lock_type;
509 __u32 exclusive_lock_type;
510 __u32 shared_lock_type;
511 __u32 unlock_lock_type;
Ronnie Sahlberg93012bf2018-03-31 11:45:31 +1100512 size_t header_preamble_size;
Pavel Shilovsky1887f602012-05-17 12:45:31 +0400513 size_t header_size;
514 size_t max_header_size;
Pavel Shilovskyeb378712012-05-17 13:02:51 +0400515 size_t read_rsp_size;
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +0400516 __le16 lock_cmd;
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400517 unsigned int cap_unix;
518 unsigned int cap_nt_find;
519 unsigned int cap_large_files;
Jeff Layton502858822013-06-27 12:45:00 -0400520 __u16 signing_enabled;
521 __u16 signing_required;
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400522 size_t create_lease_size;
Jeff Layton23db65f2012-05-15 12:20:51 -0400523};
524
Pavel Shilovsky1887f602012-05-17 12:45:31 +0400525#define HEADER_SIZE(server) (server->vals->header_size)
526#define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
527
Steve Frenchf87d39d2011-05-27 03:50:55 +0000528struct smb_vol {
529 char *username;
530 char *password;
531 char *domainname;
532 char *UNC;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000533 char *iocharset; /* local code page for mapping to and from Unicode */
534 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
535 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
Eric W. Biederman3da46562013-02-06 01:37:39 -0800536 kuid_t cred_uid;
537 kuid_t linux_uid;
538 kgid_t linux_gid;
539 kuid_t backupuid;
540 kgid_t backupgid;
Al Viro5206efd2011-07-26 03:22:14 -0400541 umode_t file_mode;
542 umode_t dir_mode;
Jeff Layton1e3cc572013-06-10 17:12:23 -0500543 enum securityEnum sectype; /* sectype requested via mnt opts */
544 bool sign; /* was signing requested via mnt opts? */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000545 bool retry:1;
546 bool intr:1;
547 bool setuids:1;
Steve French95932652016-09-23 01:36:34 -0500548 bool setuidfromacl:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000549 bool override_uid:1;
550 bool override_gid:1;
551 bool dynperm:1;
552 bool noperm:1;
Steve French412094a2019-06-24 02:01:42 -0500553 bool mode_ace:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000554 bool no_psx_acl:1; /* set if posix acl support should be disabled */
555 bool cifs_acl:1;
Shirish Pargaonkar3d3ea8e2011-09-26 09:56:44 -0500556 bool backupuid_specified; /* mount option backupuid is specified */
557 bool backupgid_specified; /* mount option backupgid is specified */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000558 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
559 bool server_ino:1; /* use inode numbers from server ie UniqueId */
560 bool direct_io:1;
561 bool strict_io:1; /* strict cache behavior */
Steve French83bbfa72019-08-27 23:58:54 -0500562 bool cache_ro:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000563 bool remap:1; /* set to remap seven reserved chars in filenames */
Steve French2baa2682014-09-27 02:19:01 -0500564 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000565 bool posix_paths:1; /* unset to not ask for posix pathnames. */
566 bool no_linux_ext:1;
Steve Frenchb3266142018-05-20 23:41:10 -0500567 bool linux_ext:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000568 bool sfu_emul:1;
569 bool nullauth:1; /* attempt to authenticate with null user */
570 bool nocase:1; /* request case insensitive filenames */
571 bool nobrl:1; /* disable sending byte range locks to srv */
Steve French3d4ef9a2018-04-25 22:19:09 -0500572 bool nohandlecache:1; /* disable caching dir handles if srvr probs */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000573 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
574 bool seal:1; /* request transport encryption on share */
575 bool nodfs:1; /* Do not request DFS, even if available */
576 bool local_lease:1; /* check leases only on local system, not remote */
577 bool noblocksnd:1;
578 bool noautotune:1;
579 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
580 bool fsc:1; /* enable fscache */
581 bool mfsymlinks:1; /* use Minshall+French Symlinks */
582 bool multiuser:1;
Pavel Shilovskyd4ffff12011-05-26 06:02:00 +0000583 bool rwpidforward:1; /* pid forward for read/write operations */
Steve Frenchb2a30772015-09-29 21:49:28 -0500584 bool nosharesock:1;
585 bool persistent:1;
586 bool nopersistent:1;
Steve French592fafe2015-11-03 10:08:53 -0600587 bool resilient:1; /* noresilient not required since not fored for CA */
Germano Percossi39566442016-12-15 12:31:18 +0530588 bool domainauto:1;
Long Li8339dd32017-11-07 01:54:55 -0700589 bool rdma:1;
Steve Frenche8506d22019-02-28 21:32:15 -0600590 unsigned int bsize;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000591 unsigned int rsize;
592 unsigned int wsize;
593 bool sockopt_tcp_nodelay:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000594 unsigned long actimeo; /* attribute cache timeout (jiffies) */
Jeff Layton23db65f2012-05-15 12:20:51 -0400595 struct smb_version_operations *ops;
596 struct smb_version_values *vals;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000597 char *prepath;
Jeff Laytonb979aaa2012-11-26 11:09:55 -0500598 struct sockaddr_storage dstaddr; /* destination address */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000599 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
600 struct nls_table *local_nls;
Steve Frenchadfeb3e2015-12-18 12:31:36 -0600601 unsigned int echo_interval; /* echo interval in secs */
Steve French8b217fe2016-11-11 22:36:20 -0600602 __u64 snapshot_time; /* needed for timewarp tokens */
Steve Frenchca567eb2019-03-29 16:31:07 -0500603 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
Steve French141891f2016-09-23 00:44:16 -0500604 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
Steve French9fe5ff12019-06-24 20:39:04 -0500605 __u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000606};
607
Aurelien Apteld070f9d2019-04-02 13:00:33 +0200608/**
609 * CIFS superblock mount flags (mnt_cifs_flags) to consider when
610 * trying to reuse existing superblock for a new mount
611 */
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400612#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
613 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
614 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
Steve French2baa2682014-09-27 02:19:01 -0500615 CIFS_MOUNT_MAP_SFM_CHR | \
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400616 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
617 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
618 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
619 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
620 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
Shirish Pargaonkar3d3ea8e2011-09-26 09:56:44 -0500621 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
Aurelien Apteld070f9d2019-04-02 13:00:33 +0200622 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \
Steve French6552d6a2019-06-24 01:19:52 -0500623 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \
Steve French83bbfa72019-08-27 23:58:54 -0500624 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \
625 CIFS_MOUNT_RO_CACHE)
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400626
Aurelien Apteld070f9d2019-04-02 13:00:33 +0200627/**
628 * Generic VFS superblock mount flags (s_flags) to consider when
629 * trying to reuse existing superblock for a new mount
630 */
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800631#define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \
632 SB_NODEV | SB_SYNCHRONOUS)
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400633
634struct cifs_mnt_data {
635 struct cifs_sb_info *cifs_sb;
636 struct smb_vol *vol;
637 int flags;
638};
639
Pavel Shilovsky792af7b2012-03-23 14:28:02 -0400640static inline unsigned int
641get_rfc1002_length(void *buf)
642{
Jeff Laytondca1c8d2014-02-22 19:35:38 -0500643 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
Pavel Shilovsky792af7b2012-03-23 14:28:02 -0400644}
645
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400646static inline void
647inc_rfc1001_len(void *buf, int count)
648{
649 be32_add_cpu((__be32 *)buf, count);
650}
651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000653 struct list_head tcp_ses_list;
654 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500655 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700656 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500657 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Layton23db65f2012-05-15 12:20:51 -0400658 struct smb_version_operations *ops;
659 struct smb_version_values *vals;
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500660 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Laytonc359cf32007-11-16 22:22:06 +0000661 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 struct socket *ssocket;
Pavel Shilovskya9f1b852010-12-13 19:08:35 +0300663 struct sockaddr_storage dstaddr;
Ben Greear3eb9a882010-09-01 17:06:02 -0700664 struct sockaddr_storage srcaddr; /* locally bind to this IP */
Rob Landleyf1d0c992011-01-22 15:44:05 -0600665#ifdef CONFIG_NET_NS
666 struct net *net;
667#endif
Steve Frenchd38d8c72007-06-28 19:44:13 +0000668 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
670 struct list_head pending_mid_q;
Steve Frenchedf1ae42008-10-29 00:47:57 +0000671 bool noblocksnd; /* use blocking sendmsg */
672 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000673 bool tcp_nodelay;
Steve French141891f2016-09-23 00:44:16 -0500674 unsigned int credits; /* send no more requests at once */
675 unsigned int max_credits; /* can override large 32000 default at mnt */
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300676 unsigned int in_flight; /* number of requests on the wire to server */
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400677 spinlock_t req_lock; /* protect the two values above */
Jeff Layton72ca5452008-12-01 07:09:36 -0500678 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 struct task_struct *tsk;
680 char server_GUID[16];
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400681 __u16 sec_mode;
Jeff Layton38d77c52013-05-26 07:01:00 -0400682 bool sign; /* is signing enabled on this connection? */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500683 bool session_estab; /* mark when very first sess is established */
Pavel Shilovsky28ea5292012-05-23 16:18:00 +0400684 int echo_credits; /* echo reserved slots */
685 int oplock_credits; /* oplock break reserved slots */
686 bool echoes:1; /* enable echoes */
Sachin Prabhu39552ea2014-05-13 00:48:12 +0100687 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500688 u16 dialect; /* dialect index that server chose */
Pavel Shilovsky10b9b982012-03-20 12:55:09 +0300689 bool oplocks:1; /* enable oplocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 unsigned int maxReq; /* Clients should submit no more */
691 /* than maxReq distinct unanswered SMBs to the server when using */
Steve French11911b92018-05-24 02:09:20 -0500692 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 unsigned int maxBuf; /* maxBuf specifies the maximum */
694 /* message size the server can send or receive for non-raw SMBs */
Steve French7e90d702011-02-08 23:52:32 +0000695 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
696 /* when socket is setup (and during reconnect) before NegProt sent */
Steve Frencheca6acf2009-02-20 05:43:09 +0000697 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 /* message size the server can send or receive for */
699 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400700 unsigned int capabilities; /* selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000701 int timeAdj; /* Adjust for difference in server time zone in sec */
Pavel Shilovsky243d04b2012-03-23 14:28:03 -0400702 __u64 CurrentMid; /* multiplex id - rotating counter */
Shirish Pargaonkard3ba50b2010-10-27 15:20:36 -0500703 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
Steve Frencha10faeb22005-08-22 21:38:31 -0700704 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500705 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytona0f8b4f2011-01-07 11:30:28 -0500706 __u32 sequence_number; /* for signing, protected by srv_mutex */
Steve French9e1a37d2018-09-19 02:38:17 -0500707 __u32 reconnect_instance; /* incremented on each reconnect */
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500708 struct session_key session_key;
Steve French3a5ff612006-07-14 22:37:11 +0000709 unsigned long lstrp; /* when we got last response from this server */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500710 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
Jeff Laytone598d1d82013-05-26 07:00:59 -0400711#define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
712#define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
713#define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
714 char negflavor; /* NEGOTIATE response flavor */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400715 /* extended security flavors that server supports */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500716 bool sec_ntlmssp; /* supports NTLMSSP */
717 bool sec_kerberosu2u; /* supports U2U Kerberos */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400718 bool sec_kerberos; /* supports plain Kerberos */
719 bool sec_mskerberos; /* supports legacy MS Kerberos */
Jeff Layton2a37ef92011-10-19 15:29:23 -0400720 bool large_buf; /* is current buffer large? */
Long Li8339dd32017-11-07 01:54:55 -0700721 /* use SMBD connection instead of socket */
722 bool rdma;
723 /* point to the SMBD connection if RDMA is used instead of socket */
724 struct smbd_connection *smbd_conn;
Jeff Laytonc74093b2011-01-11 07:24:23 -0500725 struct delayed_work echo; /* echo ping workqueue job */
Jeff Layton2a37ef92011-10-19 15:29:23 -0400726 char *smallbuf; /* pointer to current "small" buffer */
727 char *bigbuf; /* pointer to current "big" buffer */
Ronnie Sahlberg2e964672018-04-09 18:06:26 +1000728 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */
729 unsigned int pdu_size;
Jeff Layton2a37ef92011-10-19 15:29:23 -0400730 unsigned int total_read; /* total amount of data read in this pass */
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530731#ifdef CONFIG_CIFS_FSCACHE
732 struct fscache_cookie *fscache; /* client index cache cookie */
733#endif
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500734#ifdef CONFIG_CIFS_STATS2
Steve French789e6662011-08-09 18:44:44 +0000735 atomic_t in_send; /* requests trying to send */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500736 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
Steve French433b8dd2019-03-26 13:53:21 -0500737 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */
Steve French468d6772018-08-04 05:24:34 -0500738 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */
Steve French433b8dd2019-03-26 13:53:21 -0500739 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */
740 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS];
741 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS];
Steve French468d6772018-08-04 05:24:34 -0500742#endif /* STATS2 */
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400743 unsigned int max_read;
744 unsigned int max_write;
Steve French26ea8882019-04-26 20:36:08 -0700745 __le16 compress_algorithm;
Steve French5100d8a2018-04-09 10:47:14 -0500746 __le16 cipher_type;
Aurelien Aptel8bd68c62018-02-16 19:19:29 +0100747 /* save initital negprot hash */
748 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
Steve Frenchfcef0db2018-05-19 20:45:27 -0500749 bool posix_ext_supported;
Pavel Shilovsky53e0e112016-11-04 11:50:31 -0700750 struct delayed_work reconnect; /* reconnect workqueue job */
751 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
Steve Frenchadfeb3e2015-12-18 12:31:36 -0600752 unsigned long echo_interval;
Paulo Alcantara93d5cb52018-11-14 17:13:25 -0200753
754 /*
755 * Number of targets available for reconnect. The more targets
756 * the more tasks have to wait to let the demultiplex thread
757 * reconnect.
758 */
759 int nr_targets;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760};
761
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800762struct cifs_credits {
763 unsigned int value;
764 unsigned int instance;
765};
766
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300767static inline unsigned int
768in_flight(struct TCP_Server_Info *server)
769{
770 unsigned int num;
771 spin_lock(&server->req_lock);
772 num = server->in_flight;
773 spin_unlock(&server->req_lock);
774 return num;
775}
776
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400777static inline bool
Ronnie Sahlbergb227d212019-03-08 12:58:20 +1000778has_credits(struct TCP_Server_Info *server, int *credits, int num_credits)
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300779{
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400780 int num;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300781 spin_lock(&server->req_lock);
Pavel Shilovskybc205ed2012-03-15 13:22:27 +0300782 num = *credits;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300783 spin_unlock(&server->req_lock);
Ronnie Sahlbergb227d212019-03-08 12:58:20 +1000784 return num >= num_credits;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300785}
786
Pavel Shilovsky45275782012-05-17 17:53:29 +0400787static inline void
Pavel Shilovsky34f4deb2019-01-16 11:22:29 -0800788add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits,
Pavel Shilovskya891f0f2012-05-23 16:14:34 +0400789 const int optype)
Pavel Shilovsky45275782012-05-17 17:53:29 +0400790{
Pavel Shilovsky34f4deb2019-01-16 11:22:29 -0800791 server->ops->add_credits(server, credits, optype);
Pavel Shilovsky45275782012-05-17 17:53:29 +0400792}
793
794static inline void
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800795add_credits_and_wake_if(struct TCP_Server_Info *server,
796 const struct cifs_credits *credits, const int optype)
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400797{
Pavel Shilovsky335b7b62019-01-16 11:12:41 -0800798 if (credits->value) {
799 server->ops->add_credits(server, credits, optype);
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400800 wake_up(&server->request_q);
801 }
802}
803
804static inline void
Pavel Shilovsky45275782012-05-17 17:53:29 +0400805set_credits(struct TCP_Server_Info *server, const int val)
806{
807 server->ops->set_credits(server, val);
808}
809
Pavel Shilovsky9a1c67e2019-01-23 18:15:52 -0800810static inline int
811adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits,
812 const unsigned int payload_size)
813{
814 return server->ops->adjust_credits ?
815 server->ops->adjust_credits(server, credits, payload_size) : 0;
816}
817
Sachin Prabhu9235d092014-12-09 17:37:00 +0000818static inline __le64
Tim Gardner3d378d32013-11-02 12:50:34 -0500819get_next_mid64(struct TCP_Server_Info *server)
Pavel Shilovsky88257362012-05-23 14:01:59 +0400820{
Sachin Prabhu9235d092014-12-09 17:37:00 +0000821 return cpu_to_le64(server->ops->get_next_mid(server));
Pavel Shilovsky88257362012-05-23 14:01:59 +0400822}
823
Tim Gardner3d378d32013-11-02 12:50:34 -0500824static inline __le16
825get_next_mid(struct TCP_Server_Info *server)
826{
Sachin Prabhu9235d092014-12-09 17:37:00 +0000827 __u16 mid = server->ops->get_next_mid(server);
Tim Gardner3d378d32013-11-02 12:50:34 -0500828 /*
829 * The value in the SMB header should be little endian for easy
830 * on-the-wire decoding.
831 */
832 return cpu_to_le16(mid);
833}
834
Pavel Shilovskyc781af72019-03-04 14:02:50 -0800835static inline void
836revert_current_mid(struct TCP_Server_Info *server, const unsigned int val)
837{
838 if (server->ops->revert_current_mid)
839 server->ops->revert_current_mid(server, val);
840}
841
842static inline void
843revert_current_mid_from_hdr(struct TCP_Server_Info *server,
844 const struct smb2_sync_hdr *shdr)
845{
846 unsigned int num = le16_to_cpu(shdr->CreditCharge);
847
848 return revert_current_mid(server, num > 0 ? num : 1);
849}
850
Tim Gardner3d378d32013-11-02 12:50:34 -0500851static inline __u16
852get_mid(const struct smb_hdr *smb)
853{
854 return le16_to_cpu(smb->Mid);
855}
856
857static inline bool
858compare_mid(__u16 mid, const struct smb_hdr *smb)
859{
860 return mid == le16_to_cpu(smb->Mid);
861}
862
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863/*
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700864 * When the server supports very large reads and writes via POSIX extensions,
865 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
866 * including the RFC1001 length.
867 *
868 * Note that this might make for "interesting" allocation problems during
869 * writeback however as we have to allocate an array of pointers for the
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300870 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700871 *
872 * For reads, there is a similar problem as we need to allocate an array
873 * of kvecs to handle the receive, though that should only need to be done
874 * once.
875 */
876#define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
877#define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
878
879/*
880 * When the server doesn't allow large posix writes, only allow a rsize/wsize
881 * of 2^17-1 minus the size of the call header. That allows for a read or
882 * write up to the maximum size described by RFC1002.
883 */
884#define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
885#define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
886
887/*
888 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300889 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700890 * a single wsize request with a single call.
891 */
892#define CIFS_DEFAULT_IOSIZE (1024 * 1024)
Steve French3d621232018-09-25 15:33:47 -0500893#define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700894
895/*
896 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
897 * those values when posix extensions aren't in force. In actuality here, we
898 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
899 * to be ok with the extra byte even though Windows doesn't send writes that
900 * are that large.
901 *
902 * Citation:
903 *
904 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
905 */
906#define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
907#define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
908
909/*
Rob Landleyf1d0c992011-01-22 15:44:05 -0600910 * Macros to allow the TCP_Server_Info->net field and related code to drop out
911 * when CONFIG_NET_NS isn't set.
912 */
913
914#ifdef CONFIG_NET_NS
915
916static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
917{
918 return srv->net;
919}
920
921static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
922{
923 srv->net = net;
924}
925
926#else
927
928static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
929{
930 return &init_net;
931}
932
933static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
934{
935}
936
937#endif
938
Aurelien Aptelb6f0dd52018-06-14 15:43:18 +0200939struct cifs_server_iface {
940 size_t speed;
941 unsigned int rdma_capable : 1;
942 unsigned int rss_capable : 1;
943 struct sockaddr_storage sockaddr;
944};
945
Rob Landleyf1d0c992011-01-22 15:44:05 -0600946/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 * Session structure. One of these for each uid session with a particular host
948 */
Steve French96daf2b2011-05-27 04:34:02 +0000949struct cifs_ses {
Jeff Layton14fbf502008-11-14 13:53:46 -0500950 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000951 struct list_head tcon_list;
Aurelien Aptelb327a712018-01-24 13:46:10 +0100952 struct cifs_tcon *tcon_ipc;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000953 struct mutex session_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500955 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000957 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Steve Frenchad009ac2005-04-28 22:41:05 -0700958 char *serverOS; /* name of operating system underlying server */
959 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 char *serverDomain; /* security realm of server */
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400961 __u64 Suid; /* remote smb uid */
Eric W. Biederman64ed39d2013-02-06 02:30:39 -0800962 kuid_t linux_uid; /* overriding owner of files on the mount */
963 kuid_t cred_uid; /* owner of credentials */
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400964 unsigned int capabilities;
Aurelien Aptelb327a712018-01-24 13:46:10 +0100965 char serverName[SERVER_NAME_LEN_WITH_NULL];
Steve French34c87902011-03-01 05:02:57 +0000966 char *user_name; /* must not be null except during init of sess
967 and after mount option parsing we fill it */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000968 char *domainName;
969 char *password;
Shirish Pargaonkar5d0d2882010-10-13 18:15:00 -0500970 struct session_key auth_key;
Shirish Pargaonkard3686d52010-10-28 09:53:07 -0500971 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
Jeff Layton28e11bd2013-05-26 07:01:00 -0400972 enum securityEnum sectype; /* what security flavor was specified? */
973 bool sign; /* is signing required? */
Steve French3b795212008-11-13 19:45:32 +0000974 bool need_reconnect:1; /* connection reset, uid now invalid */
Germano Percossi39566442016-12-15 12:31:18 +0530975 bool domainAuto:1;
Pavel Shilovsky5478f9b2011-12-27 16:22:00 +0400976 __u16 session_flags;
Steve French373512e2015-12-18 13:05:30 -0600977 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
978 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
979 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
Aurelien Aptel8bd68c62018-02-16 19:19:29 +0100980 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE];
Aurelien Aptelb6f0dd52018-06-14 15:43:18 +0200981
982 /*
983 * Network interfaces available on the server this session is
984 * connected to.
985 *
986 * Other channels can be opened by connecting and binding this
987 * session to interfaces from this list.
988 *
989 * iface_lock should be taken when accessing any of these fields
990 */
991 spinlock_t iface_lock;
992 struct cifs_server_iface *iface_list;
993 size_t iface_count;
994 unsigned long iface_last_update; /* jiffies */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995};
Pavel Shilovsky233839b2012-09-19 06:22:45 -0700996
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400997static inline bool
998cap_unix(struct cifs_ses *ses)
999{
1000 return ses->server->vals->cap_unix & ses->capabilities;
1001}
1002
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001003struct cached_fid {
1004 bool is_valid:1; /* Do we have a useable root fid */
Ronnie Sahlbergb0f6df72019-03-12 13:58:31 +10001005 bool file_all_info_is_valid:1;
1006
Ronnie Sahlberg9da6ec72018-07-31 08:48:22 +10001007 struct kref refcount;
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001008 struct cifs_fid *fid;
1009 struct mutex fid_mutex;
1010 struct cifs_tcon *tcon;
1011 struct work_struct lease_break;
Ronnie Sahlbergb0f6df72019-03-12 13:58:31 +10001012 struct smb2_file_all_info file_all_info;
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001013};
1014
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015/*
1016 * there is one of these for each connection to a resource on a particular
Steve Frenchd38d8c72007-06-28 19:44:13 +00001017 * session
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 */
Steve French96daf2b2011-05-27 04:34:02 +00001019struct cifs_tcon {
Jeff Laytonf1987b42008-11-15 11:12:47 -05001020 struct list_head tcon_list;
1021 int tc_count;
Pavel Shilovsky53e0e112016-11-04 11:50:31 -07001022 struct list_head rlist; /* reconnect list */
Steve Frenchfae80442018-10-19 17:14:32 -05001023 atomic_t num_local_opens; /* num of all opens including disconnected */
1024 atomic_t num_remote_opens; /* num of all network opens on server */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 struct list_head openFileList;
Steve French3afca262016-09-22 18:58:16 -05001026 spinlock_t open_file_lock; /* protects list above */
Steve French96daf2b2011-05-27 04:34:02 +00001027 struct cifs_ses *ses; /* pointer to session associated with */
Steve French254e55e2006-06-04 05:53:15 +00001028 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 char *nativeFileSystem;
Jeff Layton00e485b2008-12-05 20:41:21 -05001030 char *password; /* for share-level security */
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +04001031 __u32 tid; /* The 4 byte tree id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 __u16 Flags; /* optional support bits */
1033 enum statusEnum tidStatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 atomic_t num_smbs_sent;
Pavel Shilovsky44c58182012-05-28 14:16:31 +04001035 union {
1036 struct {
1037 atomic_t num_writes;
1038 atomic_t num_reads;
1039 atomic_t num_flushes;
1040 atomic_t num_oplock_brks;
1041 atomic_t num_opens;
1042 atomic_t num_closes;
1043 atomic_t num_deletes;
1044 atomic_t num_mkdirs;
1045 atomic_t num_posixopens;
1046 atomic_t num_posixmkdirs;
1047 atomic_t num_rmdirs;
1048 atomic_t num_renames;
1049 atomic_t num_t2renames;
1050 atomic_t num_ffirst;
1051 atomic_t num_fnext;
1052 atomic_t num_fclose;
1053 atomic_t num_hardlinks;
1054 atomic_t num_symlinks;
1055 atomic_t num_locks;
1056 atomic_t num_acl_get;
1057 atomic_t num_acl_set;
1058 } cifs_stats;
Pavel Shilovskyd60622e2012-05-28 15:19:39 +04001059 struct {
1060 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
1061 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
1062 } smb2_stats;
Pavel Shilovsky44c58182012-05-28 14:16:31 +04001063 } stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 __u64 bytes_read;
1065 __u64 bytes_written;
Steve French3afca262016-09-22 18:58:16 -05001066 spinlock_t stat_lock; /* protects the two fields above */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +00001068 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Aurelien Aptelb327a712018-01-24 13:46:10 +01001070 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */
1071 bool pipe:1; /* set if connection to pipe share */
1072 bool print:1; /* set if connection to printer share */
Steve French4b18f2a2008-04-29 00:06:05 +00001073 bool retry:1;
1074 bool nocase:1;
Steve French3d4ef9a2018-04-25 22:19:09 -05001075 bool nohandlecache:1; /* if strange server resource prob can turn off */
Steve French95b1cb92008-05-15 16:44:38 +00001076 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +00001077 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +00001078 for this mount even if server would support */
Steve Frenchb3266142018-05-20 23:41:10 -05001079 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */
Steve French84210e92008-10-23 04:42:37 +00001080 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French64cc2c62009-03-04 19:54:08 +00001081 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
Steve French3d1a3742014-08-11 21:05:25 -05001082 bool broken_sparse_sup; /* if server or share does not support sparse */
Steve French3b795212008-11-13 19:45:32 +00001083 bool need_reconnect:1; /* connection reset, tid now invalid */
Pavel Shilovsky96a988f2016-11-29 11:31:23 -08001084 bool need_reopen_files:1; /* need to reopen tcon file handles */
Steve French592fafe2015-11-03 10:08:53 -06001085 bool use_resilient:1; /* use resilient instead of durable handles */
Steve Frenchb618f002015-11-03 09:15:03 -06001086 bool use_persistent:1; /* use persistent instead of durable handles */
Steve French769ee6a2013-06-19 14:15:30 -05001087 __le32 capabilities;
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +04001088 __u32 share_flags;
1089 __u32 maximal_access;
1090 __u32 vol_serial_number;
1091 __le64 vol_create_time;
Steve French8b217fe2016-11-11 22:36:20 -06001092 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */
Steve Frenchca567eb2019-03-29 16:31:07 -05001093 __u32 handle_timeout; /* persistent and durable handle timeout in ms */
Steven Frenchaf6a12e2013-10-09 20:55:53 -05001094 __u32 ss_flags; /* sector size flags */
1095 __u32 perf_sector_size; /* best sector size for perf */
Steve Frenchde9f68df2013-11-15 11:26:24 -06001096 __u32 max_chunks;
1097 __u32 max_bytes_chunk;
1098 __u32 max_bytes_copy;
Suresh Jayaramand03382c2010-07-05 18:12:27 +05301099#ifdef CONFIG_CIFS_FSCACHE
1100 u64 resource_id; /* server resource id */
1101 struct fscache_cookie *fscache; /* cookie for share */
1102#endif
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001103 struct list_head pending_opens; /* list of incomplete opens */
Ronnie Sahlberga93864d2018-06-14 06:48:35 +10001104 struct cached_fid crfid; /* Cached root fid */
Steve Frenchc18c8422007-07-18 23:21:09 +00001105 /* BB add field for back pointer to sb struct(s)? */
Paulo Alcantara54be1f62018-11-14 16:01:21 -02001106#ifdef CONFIG_CIFS_DFS_UPCALL
1107 char *dfs_path;
1108 int remap:2;
1109 struct list_head ulist; /* cache update list */
1110#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111};
1112
1113/*
Jeff Layton7ffec372010-09-29 19:51:11 -04001114 * This is a refcounted and timestamped container for a tcon pointer. The
1115 * container holds a tcon reference. It is considered safe to free one of
1116 * these when the tl_count goes to 0. The tl_time is the time of the last
1117 * "get" on the container.
1118 */
1119struct tcon_link {
Jeff Laytonb647c352010-10-28 11:16:44 -04001120 struct rb_node tl_rbnode;
Eric W. Biederman6d4a0832013-02-06 01:48:56 -08001121 kuid_t tl_uid;
Jeff Layton9d002df2010-10-06 19:51:11 -04001122 unsigned long tl_flags;
1123#define TCON_LINK_MASTER 0
1124#define TCON_LINK_PENDING 1
1125#define TCON_LINK_IN_TREE 2
1126 unsigned long tl_time;
1127 atomic_t tl_count;
Steve French96daf2b2011-05-27 04:34:02 +00001128 struct cifs_tcon *tl_tcon;
Jeff Layton7ffec372010-09-29 19:51:11 -04001129};
1130
Jeff Layton9d002df2010-10-06 19:51:11 -04001131extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
Ronnie Sahlbergb2c96de2018-08-01 09:26:11 +10001132extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst);
Jeff Layton7ffec372010-09-29 19:51:11 -04001133
Steve French96daf2b2011-05-27 04:34:02 +00001134static inline struct cifs_tcon *
Jeff Layton7ffec372010-09-29 19:51:11 -04001135tlink_tcon(struct tcon_link *tlink)
1136{
Jeff Layton9d002df2010-10-06 19:51:11 -04001137 return tlink->tl_tcon;
Jeff Layton7ffec372010-09-29 19:51:11 -04001138}
1139
Aurelien Aptel8ddecf52018-06-04 22:29:35 +02001140static inline struct tcon_link *
1141cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb)
1142{
1143 return cifs_sb->master_tlink;
1144}
1145
Jeff Layton9d002df2010-10-06 19:51:11 -04001146extern void cifs_put_tlink(struct tcon_link *tlink);
Jeff Layton7ffec372010-09-29 19:51:11 -04001147
Jeff Layton13cfb732010-09-29 19:51:11 -04001148static inline struct tcon_link *
1149cifs_get_tlink(struct tcon_link *tlink)
1150{
Jeff Layton9d002df2010-10-06 19:51:11 -04001151 if (tlink && !IS_ERR(tlink))
1152 atomic_inc(&tlink->tl_count);
Jeff Layton13cfb732010-09-29 19:51:11 -04001153 return tlink;
1154}
1155
Jeff Layton7ffec372010-09-29 19:51:11 -04001156/* This function is always expected to succeed */
Steve French96daf2b2011-05-27 04:34:02 +00001157extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
Jeff Layton7ffec372010-09-29 19:51:11 -04001158
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001159#define CIFS_OPLOCK_NO_CHANGE 0xfe
1160
1161struct cifs_pending_open {
1162 struct list_head olist;
1163 struct tcon_link *tlink;
1164 __u8 lease_key[16];
1165 __u32 oplock;
1166};
1167
Jeff Layton7ffec372010-09-29 19:51:11 -04001168/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001169 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1170 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 */
1172struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001173 struct list_head llist; /* pointer to next cifsLockInfo */
Pavel Shilovsky85160e02011-10-22 15:33:29 +04001174 struct list_head blist; /* pointer to locks blocked on this */
1175 wait_queue_head_t block_q;
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001176 __u64 offset;
1177 __u64 length;
Pavel Shilovsky03776f42010-08-17 11:26:00 +04001178 __u32 pid;
Ronnie Sahlberg96457592018-10-04 09:24:38 +10001179 __u16 type;
1180 __u16 flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181};
1182
1183/*
1184 * One of these for each open instance of a file
1185 */
1186struct cifs_search_info {
1187 loff_t index_of_last_entry;
1188 __u16 entries_in_buffer;
1189 __u16 info_level;
1190 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +00001191 char *ntwrk_buf_start;
1192 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +00001193 char *last_entry;
Christoph Hellwigeaf35b12011-07-16 15:24:37 -04001194 const char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +00001196 bool endOfSearch:1;
1197 bool emptyDir:1;
1198 bool unicode:1;
1199 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200};
1201
Pavel Shilovsky226730b2013-07-05 12:00:30 +04001202struct cifs_open_parms {
1203 struct cifs_tcon *tcon;
1204 struct cifs_sb_info *cifs_sb;
1205 int disposition;
1206 int desired_access;
1207 int create_options;
1208 const char *path;
1209 struct cifs_fid *fid;
Steve Frenchce558b02018-05-31 19:16:54 -05001210 umode_t mode;
Pavel Shilovsky9cbc0b72013-07-09 18:40:58 +04001211 bool reconnect:1;
Pavel Shilovsky226730b2013-07-05 12:00:30 +04001212};
1213
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001214struct cifs_fid {
1215 __u16 netfid;
Pavel Shilovskyf0df7372012-09-18 16:20:26 -07001216 __u64 persistent_fid; /* persist file id for smb2 */
1217 __u64 volatile_fid; /* volatile file id for smb2 */
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -07001218 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
Steve Frenchb56eae42015-11-03 09:26:27 -06001219 __u8 create_guid[16];
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001220 struct cifs_pending_open *pending_open;
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001221 unsigned int epoch;
Steve Frenchdfe33f92018-10-30 19:50:31 -05001222#ifdef CONFIG_CIFS_DEBUG2
1223 __u64 mid;
1224#endif /* CIFS_DEBUG2 */
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001225 bool purge_cache;
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001226};
1227
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001228struct cifs_fid_locks {
1229 struct list_head llist;
1230 struct cifsFileInfo *cfile; /* fid that owns locks */
1231 struct list_head locks; /* locks held by fid above */
1232};
1233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234struct cifsFileInfo {
Steve French3afca262016-09-22 18:58:16 -05001235 /* following two lists are protected by tcon->open_file_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 struct list_head tlist; /* pointer to next fid owned by tcon */
1237 struct list_head flist; /* next fid (file instance) for this inode */
Steve French3afca262016-09-22 18:58:16 -05001238 /* lock list below protected by cifsi->lock_sem */
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001239 struct cifs_fid_locks *llist; /* brlocks held by this fid */
Eric W. Biedermanfef59fd2013-02-06 02:23:02 -08001240 kuid_t uid; /* allows finding which FileInfo structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 __u32 pid; /* process id who opened file */
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001242 struct cifs_fid fid; /* file id from remote */
Pavel Shilovskyf2cca6a2016-10-07 17:26:36 -07001243 struct list_head rlist; /* reconnect list */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 /* BB add lock scope info here if needed */ ;
1245 /* lock scope id (0 if none) */
Jeff Laytona5e18bc2010-10-11 15:07:18 -04001246 struct dentry *dentry;
Jeff Layton13cfb732010-09-29 19:51:11 -04001247 struct tcon_link *tlink;
Steve French3afca262016-09-22 18:58:16 -05001248 unsigned int f_flags;
Steve French4b18f2a2008-04-29 00:06:05 +00001249 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -04001250 bool oplock_break_cancelled:1;
Steve French3afca262016-09-22 18:58:16 -05001251 int count;
1252 spinlock_t file_info_lock; /* protects four flag/count fields above */
Steve Frencha6ce4932009-04-09 01:14:32 +00001253 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 struct cifs_search_info srch_inf;
Tejun Heo9b646972010-07-20 22:09:02 +02001255 struct work_struct oplock_break; /* work for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256};
1257
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001258struct cifs_io_parms {
1259 __u16 netfid;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001260 __u64 persistent_fid; /* persist file id for smb2 */
1261 __u64 volatile_fid; /* volatile file id for smb2 */
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001262 __u32 pid;
1263 __u64 offset;
1264 unsigned int length;
Steve French96daf2b2011-05-27 04:34:02 +00001265 struct cifs_tcon *tcon;
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001266};
1267
Pavel Shilovskyccf7f402017-04-25 11:52:29 -07001268struct cifs_aio_ctx {
1269 struct kref refcount;
1270 struct list_head list;
1271 struct mutex aio_mutex;
1272 struct completion done;
1273 struct iov_iter iter;
1274 struct kiocb *iocb;
1275 struct cifsFileInfo *cfile;
1276 struct bio_vec *bv;
Pavel Shilovskyc610c4b2017-04-25 11:52:31 -07001277 loff_t pos;
Pavel Shilovskyccf7f402017-04-25 11:52:29 -07001278 unsigned int npages;
1279 ssize_t rc;
1280 unsigned int len;
1281 unsigned int total_len;
1282 bool should_dirty;
Long Li6e6e2b82018-10-31 22:13:09 +00001283 /*
1284 * Indicates if this aio_ctx is for direct_io,
1285 * If yes, iter is a copy of the user passed iov_iter
1286 */
1287 bool direct_io;
Pavel Shilovskyccf7f402017-04-25 11:52:29 -07001288};
1289
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001290struct cifs_readdata;
1291
1292/* asynchronous read support */
1293struct cifs_readdata {
1294 struct kref refcount;
1295 struct list_head list;
1296 struct completion done;
1297 struct cifsFileInfo *cfile;
1298 struct address_space *mapping;
Pavel Shilovsky6685c5e2017-04-25 11:52:30 -07001299 struct cifs_aio_ctx *ctx;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001300 __u64 offset;
1301 unsigned int bytes;
Pavel Shilovsky34a54d62014-07-10 10:03:29 +04001302 unsigned int got_bytes;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001303 pid_t pid;
1304 int result;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001305 struct work_struct work;
Jeff Layton8321fec2012-09-19 06:22:32 -07001306 int (*read_into_pages)(struct TCP_Server_Info *server,
1307 struct cifs_readdata *rdata,
1308 unsigned int len);
Pavel Shilovskyd70b9102016-11-17 16:20:18 -08001309 int (*copy_into_pages)(struct TCP_Server_Info *server,
1310 struct cifs_readdata *rdata,
1311 struct iov_iter *iter);
Pavel Shilovsky738f9de2016-11-23 15:14:57 -08001312 struct kvec iov[2];
Long Li74dcf412017-11-22 17:38:46 -07001313#ifdef CONFIG_CIFS_SMB_DIRECT
1314 struct smbd_mr *mr;
1315#endif
Jeff Layton8321fec2012-09-19 06:22:32 -07001316 unsigned int pagesz;
Long Li57a929a2018-05-30 12:47:53 -07001317 unsigned int page_offset;
Jeff Layton8321fec2012-09-19 06:22:32 -07001318 unsigned int tailsz;
Pavel Shilovsky335b7b62019-01-16 11:12:41 -08001319 struct cifs_credits credits;
Jeff Laytonc5fab6f2012-09-19 06:22:30 -07001320 unsigned int nr_pages;
Long Lif9f5aca2018-05-30 12:47:54 -07001321 struct page **pages;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001322};
1323
Pavel Shilovsky33319142012-09-18 16:20:29 -07001324struct cifs_writedata;
1325
1326/* asynchronous write support */
1327struct cifs_writedata {
1328 struct kref refcount;
1329 struct list_head list;
1330 struct completion done;
1331 enum writeback_sync_modes sync_mode;
1332 struct work_struct work;
1333 struct cifsFileInfo *cfile;
Pavel Shilovskyc610c4b2017-04-25 11:52:31 -07001334 struct cifs_aio_ctx *ctx;
Pavel Shilovsky33319142012-09-18 16:20:29 -07001335 __u64 offset;
1336 pid_t pid;
1337 unsigned int bytes;
1338 int result;
Long Lidb223a52017-11-22 17:38:45 -07001339#ifdef CONFIG_CIFS_SMB_DIRECT
1340 struct smbd_mr *mr;
1341#endif
Jeff Laytoneddb0792012-09-18 16:20:35 -07001342 unsigned int pagesz;
Long Li57a929a2018-05-30 12:47:53 -07001343 unsigned int page_offset;
Jeff Laytoneddb0792012-09-18 16:20:35 -07001344 unsigned int tailsz;
Pavel Shilovsky335b7b62019-01-16 11:12:41 -08001345 struct cifs_credits credits;
Pavel Shilovsky33319142012-09-18 16:20:29 -07001346 unsigned int nr_pages;
Long Li8e7360f2018-05-30 12:47:56 -07001347 struct page **pages;
Pavel Shilovsky33319142012-09-18 16:20:29 -07001348};
1349
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001350/*
1351 * Take a reference on the file private data. Must be called with
Steve French3afca262016-09-22 18:58:16 -05001352 * cfile->file_info_lock held.
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001353 */
Jeff Layton764a1b12012-07-25 14:59:54 -04001354static inline void
1355cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001356{
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001357 ++cifs_file->count;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001358}
1359
Jeff Layton764a1b12012-07-25 14:59:54 -04001360struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
Aurelien Aptelb98749c2019-03-29 10:49:12 +01001361void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr);
Jeff Laytonb33879a2010-10-15 15:34:04 -04001362void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001363
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001364#define CIFS_CACHE_READ_FLG 1
1365#define CIFS_CACHE_HANDLE_FLG 2
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001366#define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001367#define CIFS_CACHE_WRITE_FLG 4
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001368#define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1369#define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001370
Steve French83bbfa72019-08-27 23:58:54 -05001371#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 +04001372#define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001373#define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1374
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375/*
1376 * One of these for each file inode
1377 */
1378
1379struct cifsInodeInfo {
Pavel Shilovskyd59dad22011-09-22 09:53:59 +04001380 bool can_cache_brlcks;
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001381 struct list_head llist; /* locks helb by this inode */
Pavel Shilovsky1b4b55a2012-09-19 06:22:44 -07001382 struct rw_semaphore lock_sem; /* protect the fields above */
Steve Frenchd38d8c72007-06-28 19:44:13 +00001383 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 struct list_head openFileList;
Ronnie Sahlberg487317c2019-06-05 10:38:38 +10001385 spinlock_t open_file_lock; /* protects openFileList */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001387 unsigned int oplock; /* oplock/lease level we have */
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001388 unsigned int epoch; /* used to track lease state changes */
Sachin Prabhuc11f1df2014-03-11 16:11:47 +00001389#define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1390#define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1391#define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
Jeff Laytonaff8d5c2014-04-30 09:31:45 -04001392#define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1393#define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
Jeff Layton4f73c7d2014-04-30 09:31:47 -04001394#define CIFS_INO_LOCK (5) /* lock bit for synchronization */
Jeff Laytonaff8d5c2014-04-30 09:31:45 -04001395 unsigned long flags;
Sachin Prabhuc11f1df2014-03-11 16:11:47 +00001396 spinlock_t writers_lock;
1397 unsigned int writers; /* Number of writers on this inode */
Jeff Laytonaae62fd2011-01-20 13:36:50 -05001398 unsigned long time; /* jiffies of last update of inode */
Jeff Layton597b0272012-03-23 14:40:56 -04001399 u64 server_eof; /* current file size on server -- protected by i_lock */
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001400 u64 uniqueid; /* server inode number */
Jeff Layton20054bd2011-01-07 11:30:27 -05001401 u64 createtime; /* creation time on server */
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -07001402 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +05301403#ifdef CONFIG_CIFS_FSCACHE
1404 struct fscache_cookie *fscache;
1405#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 struct inode vfs_inode;
1407};
1408
1409static inline struct cifsInodeInfo *
1410CIFS_I(struct inode *inode)
1411{
1412 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1413}
1414
1415static inline struct cifs_sb_info *
1416CIFS_SB(struct super_block *sb)
1417{
1418 return sb->s_fs_info;
1419}
1420
Al Viro7119e222014-10-22 00:25:12 -04001421static inline struct cifs_sb_info *
1422CIFS_FILE_SB(struct file *file)
1423{
1424 return CIFS_SB(file_inode(file)->i_sb);
1425}
1426
Steve Frenchab2f2182005-09-15 20:44:50 -07001427static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -07001428{
1429 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1430 return '/';
1431 else
1432 return '\\';
1433}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Steve Frenchf87d39d2011-05-27 03:50:55 +00001435static inline void
1436convert_delimiter(char *path, char delim)
1437{
Steve French1cc9bd62012-11-29 18:07:51 -06001438 char old_delim, *pos;
Steve Frenchf87d39d2011-05-27 03:50:55 +00001439
1440 if (delim == '/')
1441 old_delim = '\\';
1442 else
1443 old_delim = '/';
1444
Steve French1cc9bd62012-11-29 18:07:51 -06001445 pos = path;
1446 while ((pos = strchr(pos, old_delim)))
1447 *pos = delim;
Steve Frenchf87d39d2011-05-27 03:50:55 +00001448}
1449
Steve Frencha4544342005-08-24 13:59:35 -07001450#define cifs_stats_inc atomic_inc
1451
Steve French96daf2b2011-05-27 04:34:02 +00001452static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
Steve Frencha4544342005-08-24 13:59:35 -07001453 unsigned int bytes)
1454{
1455 if (bytes) {
1456 spin_lock(&tcon->stat_lock);
1457 tcon->bytes_written += bytes;
1458 spin_unlock(&tcon->stat_lock);
1459 }
1460}
1461
Steve French96daf2b2011-05-27 04:34:02 +00001462static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
Steve Frencha4544342005-08-24 13:59:35 -07001463 unsigned int bytes)
1464{
1465 spin_lock(&tcon->stat_lock);
1466 tcon->bytes_read += bytes;
1467 spin_unlock(&tcon->stat_lock);
1468}
Steve Frencha4544342005-08-24 13:59:35 -07001469
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001470
1471/*
Jeff Layton44d22d82011-10-19 15:29:49 -04001472 * This is the prototype for the mid receive function. This function is for
1473 * receiving the rest of the SMB frame, starting with the WordCount (which is
1474 * just after the MID in struct smb_hdr). Note:
1475 *
1476 * - This will be called by cifsd, with no locks held.
1477 * - The mid will still be on the pending_mid_q.
1478 * - mid->resp_buf will point to the current buffer.
1479 *
1480 * Returns zero on a successful receive, or an error. The receive state in
1481 * the TCP_Server_Info will also be updated.
1482 */
1483typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1484 struct mid_q_entry *mid);
1485
1486/*
1487 * This is the prototype for the mid callback function. This is called once the
1488 * mid has been received off of the socket. When creating one, take special
1489 * care to avoid deadlocks. Things to bear in mind:
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001490 *
Jeff Layton3c1105d2011-05-22 07:09:13 -04001491 * - it will be called by cifsd, with no locks held
1492 * - the mid will be removed from any lists
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001493 */
1494typedef void (mid_callback_t)(struct mid_q_entry *mid);
1495
Pavel Shilovsky9b7c18a2016-11-16 14:06:17 -08001496/*
1497 * This is the protopyte for mid handle function. This is called once the mid
1498 * has been recognized after decryption of the message.
1499 */
1500typedef int (mid_handle_t)(struct TCP_Server_Info *server,
1501 struct mid_q_entry *mid);
1502
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503/* one of these for every pending CIFS request to the server */
1504struct mid_q_entry {
1505 struct list_head qhead; /* mids waiting on reply from this server */
Lars Persson696e4202018-06-25 14:05:25 +02001506 struct kref refcount;
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +04001507 struct TCP_Server_Info *server; /* server corresponding to this mid */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001508 __u64 mid; /* multiplex id */
Pavel Shilovskyc781af72019-03-04 14:02:50 -08001509 __u16 credits; /* number of credits consumed by this mid */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001510 __u32 pid; /* process id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -07001512 unsigned long when_alloc; /* when mid was created */
1513#ifdef CONFIG_CIFS_STATS2
1514 unsigned long when_sent; /* time when smb send finished */
1515 unsigned long when_received; /* when demux complete (taken off wire) */
1516#endif
Jeff Layton44d22d82011-10-19 15:29:49 -04001517 mid_receive_t *receive; /* call receive callback */
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001518 mid_callback_t *callback; /* call completion callback */
Pavel Shilovsky9b7c18a2016-11-16 14:06:17 -08001519 mid_handle_t *handle; /* call handle mid callback */
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001520 void *callback_data; /* general purpose pointer for callback */
Pavel Shilovskyd4e48542012-03-23 14:28:02 -04001521 void *resp_buf; /* pointer to received SMB header */
Ronnie Sahlberge19b2bc2018-04-09 18:06:28 +10001522 unsigned int resp_buf_size;
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001523 int mid_state; /* wish this were enum but can not pass to wait_event */
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001524 unsigned int mid_flags;
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001525 __le16 command; /* smb command code */
Pavel Shilovsky8a26f0f2019-01-03 16:45:27 -08001526 unsigned int optype; /* operation type */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001527 bool large_buf:1; /* if valid response, is pointer to large buf */
Steve French4b18f2a2008-04-29 00:06:05 +00001528 bool multiRsp:1; /* multiple trans2 responses for one request */
1529 bool multiEnd:1; /* both received */
Pavel Shilovsky4326ed22016-11-17 15:24:46 -08001530 bool decrypted:1; /* decrypted entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531};
1532
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001533struct close_cancelled_open {
1534 struct cifs_fid fid;
1535 struct cifs_tcon *tcon;
1536 struct work_struct work;
1537};
1538
Steve French789e6662011-08-09 18:44:44 +00001539/* Make code in transport.c a little cleaner by moving
1540 update of optional stats into function below */
1541#ifdef CONFIG_CIFS_STATS2
1542
1543static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1544{
1545 atomic_inc(&server->in_send);
1546}
1547
1548static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1549{
1550 atomic_dec(&server->in_send);
1551}
1552
1553static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1554{
1555 atomic_inc(&server->num_waiters);
1556}
1557
1558static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1559{
1560 atomic_dec(&server->num_waiters);
1561}
1562
1563static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1564{
1565 mid->when_sent = jiffies;
1566}
1567#else
1568static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1569{
1570}
1571static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1572{
1573}
1574
1575static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1576{
1577}
1578
1579static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1580{
1581}
1582
1583static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1584{
1585}
1586#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
Steve Frenchff5dbd92005-08-24 17:10:36 -07001588/* for pending dnotify requests */
1589struct dir_notify_req {
Steve French13cd4b72010-10-07 18:46:32 +00001590 struct list_head lhead;
1591 __le16 Pid;
1592 __le16 PidHigh;
1593 __u16 Mid;
1594 __u16 Tid;
1595 __u16 Uid;
1596 __u16 netfid;
1597 __u32 filter; /* CompletionFilter (for multishot) */
1598 int multishot;
1599 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -07001600};
1601
Steve French366781c2008-01-25 10:12:41 +00001602struct dfs_info3_param {
1603 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +00001604 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +00001605 int server_type;
1606 int ref_flag;
1607 char *path_name;
1608 char *node_name;
Paulo Alcantarae7b602f2018-11-14 15:38:51 -02001609 int ttl;
Steve French366781c2008-01-25 10:12:41 +00001610};
1611
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001612/*
1613 * common struct for holding inode info when searching for or updating an
1614 * inode with new info
1615 */
1616
1617#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -04001618#define CIFS_FATTR_DELETE_PENDING 0x2
1619#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -04001620#define CIFS_FATTR_INO_COLLISION 0x8
Jim McDonough74d290d2013-09-21 10:36:10 -05001621#define CIFS_FATTR_UNKNOWN_NLINK 0x10
Steve French7ea884c2018-03-31 18:13:38 -05001622#define CIFS_FATTR_FAKE_ROOT_INO 0x20
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001623
1624struct cifs_fattr {
1625 u32 cf_flags;
1626 u32 cf_cifsattrs;
1627 u64 cf_uniqueid;
1628 u64 cf_eof;
1629 u64 cf_bytes;
Jeff Layton20054bd2011-01-07 11:30:27 -05001630 u64 cf_createtime;
Eric W. Biederman4a2c8cf2013-02-06 01:53:25 -08001631 kuid_t cf_uid;
1632 kgid_t cf_gid;
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001633 umode_t cf_mode;
1634 dev_t cf_rdev;
1635 unsigned int cf_nlink;
1636 unsigned int cf_dtype;
Arnd Bergmann95390202018-06-19 17:27:58 +02001637 struct timespec64 cf_atime;
1638 struct timespec64 cf_mtime;
1639 struct timespec64 cf_ctime;
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001640};
1641
Steve French366781c2008-01-25 10:12:41 +00001642static inline void free_dfs_info_param(struct dfs_info3_param *param)
1643{
1644 if (param) {
1645 kfree(param->path_name);
1646 kfree(param->node_name);
Steve French366781c2008-01-25 10:12:41 +00001647 }
1648}
1649
1650static inline void free_dfs_info_array(struct dfs_info3_param *param,
1651 int number_of_items)
1652{
1653 int i;
1654 if ((number_of_items == 0) || (param == NULL))
1655 return;
1656 for (i = 0; i < number_of_items; i++) {
1657 kfree(param[i].path_name);
1658 kfree(param[i].node_name);
1659 }
1660 kfree(param);
1661}
1662
Pavel Shilovsky9a663962019-01-08 11:15:28 -08001663static inline bool is_interrupt_error(int error)
1664{
1665 switch (error) {
1666 case -EINTR:
1667 case -ERESTARTSYS:
1668 case -ERESTARTNOHAND:
1669 case -ERESTARTNOINTR:
1670 return true;
1671 }
1672 return false;
1673}
1674
1675static inline bool is_retryable_error(int error)
1676{
1677 if (is_interrupt_error(error) || error == -EAGAIN)
1678 return true;
1679 return false;
1680}
1681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682#define MID_FREE 0
1683#define MID_REQUEST_ALLOCATED 1
1684#define MID_REQUEST_SUBMITTED 2
1685#define MID_RESPONSE_RECEIVED 4
1686#define MID_RETRY_NEEDED 8 /* session closed while this request out */
Jeff Layton71823ba2011-02-10 08:03:50 -05001687#define MID_RESPONSE_MALFORMED 0x10
Jeff Layton3c1105d2011-05-22 07:09:13 -04001688#define MID_SHUTDOWN 0x20
Steve Frenchec637e32005-12-12 20:53:18 -08001689
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001690/* Flags */
1691#define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
Ronnie Sahlbergddf83af2018-08-30 10:12:59 +10001692#define MID_DELETED 2 /* Mid has been dequeued/deleted */
Sachin Prabhu38bd4902017-03-03 15:41:38 -08001693
Steve Frenchec637e32005-12-12 20:53:18 -08001694/* Types of response buffer returned from SendReceive2 */
1695#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1696#define CIFS_SMALL_BUFFER 1
1697#define CIFS_LARGE_BUFFER 2
1698#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Steve French133672e2007-11-13 22:41:37 +00001700/* Type of Request to SendReceive2 */
Jeff Layton77499812011-01-11 07:24:23 -05001701#define CIFS_BLOCKING_OP 1 /* operation can block */
Ronnie Sahlberg392e1c52019-05-06 10:00:02 +10001702#define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */
Jeff Layton77499812011-01-11 07:24:23 -05001703#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
Steve French133672e2007-11-13 22:41:37 +00001704#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1705#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
Ronnie Sahlberg392e1c52019-05-06 10:00:02 +10001706#define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */
Steve French133672e2007-11-13 22:41:37 +00001707
Pavel Shilovskya891f0f2012-05-23 16:14:34 +04001708/* Type of request operation */
1709#define CIFS_ECHO_OP 0x080 /* echo request */
1710#define CIFS_OBREAK_OP 0x0100 /* oplock break request */
Pavel Shilovskyec2e4522011-12-27 16:12:43 +04001711#define CIFS_NEG_OP 0x0200 /* negotiate request */
1712#define CIFS_OP_MASK 0x0380 /* mask request type */
Pavel Shilovsky7fb89862016-10-31 13:49:30 -07001713
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +04001714#define CIFS_HAS_CREDITS 0x0400 /* already has credits */
Pavel Shilovsky7fb89862016-10-31 13:49:30 -07001715#define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */
Ronnie Sahlbergd69cb722019-05-01 12:03:41 +10001716#define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */
Pavel Shilovskya891f0f2012-05-23 16:14:34 +04001717
Steve French39798772006-05-31 22:40:51 +00001718/* Security Flags: indicate type of session setup needed */
1719#define CIFSSEC_MAY_SIGN 0x00001
1720#define CIFSSEC_MAY_NTLM 0x00002
1721#define CIFSSEC_MAY_NTLMV2 0x00004
1722#define CIFSSEC_MAY_KRB5 0x00008
1723#ifdef CONFIG_CIFS_WEAK_PW_HASH
1724#define CIFSSEC_MAY_LANMAN 0x00010
1725#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +00001726#else
1727#define CIFSSEC_MAY_LANMAN 0
1728#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +00001729#endif /* weak passwords */
1730#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +00001731#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +00001732
Steve French39798772006-05-31 22:40:51 +00001733#define CIFSSEC_MUST_SIGN 0x01001
1734/* note that only one of the following can be set so the
1735result of setting MUST flags more than once will be to
1736require use of the stronger protocol */
1737#define CIFSSEC_MUST_NTLM 0x02002
1738#define CIFSSEC_MUST_NTLMV2 0x04004
1739#define CIFSSEC_MUST_KRB5 0x08008
1740#ifdef CONFIG_CIFS_WEAK_PW_HASH
1741#define CIFSSEC_MUST_LANMAN 0x10010
1742#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001743#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -04001744#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +00001745#else
Chuck Ebbert20d17522009-09-15 01:53:21 -04001746#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +00001747#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001748#else /* do not allow weak pw hash */
Steve French88a44122012-01-18 17:13:47 -06001749#define CIFSSEC_MUST_LANMAN 0
1750#define CIFSSEC_MUST_PLNTXT 0
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001751#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +00001752#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001753#else
Steve Frenchac683922009-05-06 04:16:04 +00001754#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +00001755#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +00001756#endif /* WEAK_PW_HASH */
1757#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +00001758#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +00001759
Jeff Layton896a8fc2013-05-26 07:01:01 -04001760#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +00001761#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +00001762#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 -07001763/*
1764 *****************************************************************
1765 * All constants go here
1766 *****************************************************************
1767 */
1768
1769#define UID_HASH (16)
1770
1771/*
1772 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1773 * following to be declared.
1774 */
1775
1776/****************************************************************************
1777 * Locking notes. All updates to global variables and lists should be
1778 * protected by spinlocks or semaphores.
1779 *
1780 * Spinlocks
1781 * ---------
1782 * GlobalMid_Lock protects:
1783 * list operations on pending_mid_q and oplockQ
1784 * updates to XID counters, multiplex id and SMB sequence numbers
Steve French65525802019-03-13 18:21:38 -05001785 * list operations on global DnotifyReqList
Steve French3afca262016-09-22 18:58:16 -05001786 * tcp_ses_lock protects:
1787 * list operations on tcp and SMB session lists
1788 * tcon->open_file_lock protects the list of open files hanging off the tcon
Ronnie Sahlberg487317c2019-06-05 10:38:38 +10001789 * inode->open_file_lock protects the openFileList hanging off the inode
Steve French3afca262016-09-22 18:58:16 -05001790 * cfile->file_info_lock protects counters and fields in cifs file struct
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 * f_owner.lock protects certain per file struct operations
1792 * mapping->page_lock protects certain per page operations
1793 *
Ronnie Sahlberg487317c2019-06-05 10:38:38 +10001794 * Note that the cifs_tcon.open_file_lock should be taken before
1795 * not after the cifsInodeInfo.open_file_lock
1796 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 * Semaphores
1798 * ----------
1799 * sesSem operations on smb session
1800 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +00001801 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 *
1803 ****************************************************************************/
1804
1805#ifdef DECLARE_GLOBALS_HERE
1806#define GLOBAL_EXTERN
1807#else
1808#define GLOBAL_EXTERN extern
1809#endif
1810
Jeff Laytone7ddee92008-11-14 13:44:38 -05001811/*
1812 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +00001813 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -05001814 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +00001815 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -05001816 * by iterating over cifs_tcp_ses_list
1817 */
1818GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1819
Jeff Laytonf1987b42008-11-15 11:12:47 -05001820/*
1821 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1822 * tcp session, and the list of tcon's per smb session. It also protects
1823 * the reference counters for the server, smb session, and tcon. Finally,
1824 * changes to the tcon->tidStatus should be done while holding this lock.
Steve French3afca262016-09-22 18:58:16 -05001825 * generally the locks should be taken in order tcp_ses_lock before
1826 * tcon->open_file_lock and that before file->file_info_lock since the
1827 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
Jeff Laytonf1987b42008-11-15 11:12:47 -05001828 */
Suresh Jayaraman3f9bcca2010-10-18 23:29:37 +05301829GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +00001830
Steve French0eff0e22011-02-24 05:39:23 +00001831#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
Steve French99ee4db2007-02-27 05:35:17 +00001832/* Outstanding dir notify requests */
1833GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1834/* DirNotify response queue */
1835GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve French0eff0e22011-02-24 05:39:23 +00001836#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
Steve Frenchff5dbd92005-08-24 17:10:36 -07001837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838/*
1839 * Global transaction id (XID) information
1840 */
1841GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +00001842GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +00001844GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1845 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846/*
1847 * Global counters, updated atomically
1848 */
1849GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1850GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1851GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1852GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1853GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1854
Steve Frenchaaa9bbe2008-05-23 17:38:32 +00001855/* Various Debug counters */
Steve French4498eed52005-12-03 13:58:57 -08001856GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1857#ifdef CONFIG_CIFS_STATS2
1858GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1859GLOBAL_EXTERN atomic_t totSmBufAllocCount;
Steve French00778e22018-09-18 14:05:18 -05001860extern unsigned int slow_rsp_threshold; /* number of secs before logging */
Steve French4498eed52005-12-03 13:58:57 -08001861#endif
1862GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863GLOBAL_EXTERN atomic_t midCount;
1864
1865/* Misc globals */
Steve Frenchf92a7202018-05-24 04:11:07 -05001866extern bool enable_oplocks; /* enable or disable oplocks */
1867extern bool lookupCacheEnabled;
1868extern unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 with more secure ntlmssp2 challenge/resp */
Steve Frenchf92a7202018-05-24 04:11:07 -05001870extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1871extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1872extern unsigned int CIFSMaxBufSize; /* max size not including hdr */
1873extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1874extern unsigned int cifs_min_small; /* min size of small buf pool */
1875extern unsigned int cifs_max_pending; /* MAX requests at once to server*/
1876extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877
Shirish Pargaonkar4d79dba2011-04-27 23:34:35 -05001878GLOBAL_EXTERN struct rb_root uidtree;
1879GLOBAL_EXTERN struct rb_root gidtree;
1880GLOBAL_EXTERN spinlock_t siduidlock;
1881GLOBAL_EXTERN spinlock_t sidgidlock;
Shirish Pargaonkar21fed0d2011-08-09 14:30:48 -05001882GLOBAL_EXTERN struct rb_root siduidtree;
1883GLOBAL_EXTERN struct rb_root sidgidtree;
1884GLOBAL_EXTERN spinlock_t uidsidlock;
1885GLOBAL_EXTERN spinlock_t gidsidlock;
Shirish Pargaonkar4d79dba2011-04-27 23:34:35 -05001886
Tejun Heo9b646972010-07-20 22:09:02 +02001887void cifs_oplock_break(struct work_struct *work);
Aurelien Aptelb98749c2019-03-29 10:49:12 +01001888void cifs_queue_oplock_break(struct cifsFileInfo *cfile);
Linus Torvalds3b7433b2010-08-07 12:42:58 -07001889
Jeff Layton3bc303c2009-09-21 06:47:50 -04001890extern const struct slow_work_ops cifs_oplock_break_ops;
Jeff Laytonda472fc2012-03-23 14:40:53 -04001891extern struct workqueue_struct *cifsiod_wq;
Rabin Vincent3998e6b82017-05-03 17:54:01 +02001892extern struct workqueue_struct *cifsoplockd_wq;
Jeff Layton3d224622016-05-24 06:27:44 -04001893extern __u32 cifs_lock_secret;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +05301894
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +04001895extern mempool_t *cifs_mid_poolp;
1896
Jeff Layton23db65f2012-05-15 12:20:51 -04001897/* Operations for different SMB versions */
1898#define SMB1_VERSION_STRING "1.0"
1899extern struct smb_version_operations smb1_operations;
1900extern struct smb_version_values smb1_values;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001901#define SMB20_VERSION_STRING "2.0"
Pavel Shilovsky53ef1012013-09-05 16:11:28 +04001902extern struct smb_version_operations smb20_operations;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001903extern struct smb_version_values smb20_values;
Steve French1080ef72011-02-24 18:07:19 +00001904#define SMB21_VERSION_STRING "2.1"
1905extern struct smb_version_operations smb21_operations;
1906extern struct smb_version_values smb21_values;
Steve French9764c022017-09-17 10:41:35 -05001907#define SMBDEFAULT_VERSION_STRING "default"
1908extern struct smb_version_values smbdefault_values;
1909#define SMB3ANY_VERSION_STRING "3"
1910extern struct smb_version_values smb3any_values;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001911#define SMB30_VERSION_STRING "3.0"
Steve French38107d42012-12-08 22:08:06 -06001912extern struct smb_version_operations smb30_operations;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001913extern struct smb_version_values smb30_values;
Steve French20b6d8b2013-06-12 22:48:41 -05001914#define SMB302_VERSION_STRING "3.02"
Kenneth D'souza4a3b38a2018-11-17 10:33:30 +05301915#define ALT_SMB302_VERSION_STRING "3.0.2"
Steve French20b6d8b2013-06-12 22:48:41 -05001916/*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1917extern struct smb_version_values smb302_values;
Steve French5f7fbf72014-12-17 22:52:58 -06001918#define SMB311_VERSION_STRING "3.1.1"
Steve Frenchaab18932015-06-23 23:37:11 -05001919#define ALT_SMB311_VERSION_STRING "3.11"
1920extern struct smb_version_operations smb311_operations;
Steve French5f7fbf72014-12-17 22:52:58 -06001921extern struct smb_version_values smb311_values;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +05301922#endif /* _CIFS_GLOB_H */