blob: 4ed4736b5bc68e0b96d11e169a79bf5e530a8a7d [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#ifdef CONFIG_CIFS_SMB2
33#include "smb2pdu.h"
34#endif
Shirish Pargaonkard2b91522010-10-21 14:25:08 -050035
Pavel Shilovsky76ec5e32012-09-18 16:20:33 -070036#define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038/*
39 * The sizes of various internal tables and strings
40 */
41#define MAX_UID_INFO 16
42#define MAX_SES_INFO 2
43#define MAX_TCON_INFO 4
44
Scott Lovenbergcdf12462013-08-09 08:47:19 -040045#define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47#define CIFS_MIN_RCV_POOL 4
48
Shirish Pargaonkar2c0c2a02012-05-21 09:20:12 -050049#define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/*
Suresh Jayaraman6d20e842010-12-01 14:42:28 +053051 * default attribute cache timeout (jiffies)
52 */
53#define CIFS_DEF_ACTIMEO (1 * HZ)
54
55/*
56 * max attribute cache timeout (jiffies) - 2^30
57 */
58#define CIFS_MAX_ACTIMEO (1 << 30)
59
60/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 * MAX_REQ is the maximum number of requests that WE will send
Pavel Shilovsky10b9b982012-03-20 12:55:09 +030062 * on one socket concurrently.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 */
Pavel Shilovsky10b9b982012-03-20 12:55:09 +030064#define CIFS_MAX_REQ 32767
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Jeff Layton8ecaf672008-12-01 15:23:50 -050066#define RFC1001_NAME_LEN 15
67#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
68
69/* currently length of NIP6_FMT */
70#define SERVER_NAME_LENGTH 40
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
72
Steve Frenchadfeb3e2015-12-18 12:31:36 -060073/* echo interval in seconds */
74#define SMB_ECHO_INTERVAL_MIN 1
75#define SMB_ECHO_INTERVAL_MAX 600
76#define SMB_ECHO_INTERVAL_DEFAULT 60
Pavel Shilovsky9094fad2012-07-12 18:30:44 +040077
Steve French141891f2016-09-23 00:44:16 -050078/*
79 * Default number of credits to keep available for SMB3.
80 * This value is chosen somewhat arbitrarily. The Windows client
81 * defaults to 128 credits, the Windows server allows clients up to
82 * 512 credits (or 8K for later versions), and the NetApp server
83 * does not limit clients at all. Choose a high enough default value
84 * such that the client shouldn't limit performance, but allow mount
85 * to override (until you approach 64K, where we limit credits to 65000
86 * to reduce possibility of seeing more server credit overflow bugs.
87 */
88#define SMB2_MAX_CREDITS_AVAILABLE 32000
89
Linus Torvalds1da177e2005-04-16 15:20:36 -070090#include "cifspdu.h"
91
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#ifndef XATTR_DOS_ATTRIB
93#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
94#endif
95
96/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 * CIFS vfs client Status information (based on what we know.)
98 */
99
Steve French6c0f6212010-10-23 16:51:40 +0000100/* associated with each tcp and smb session */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101enum statusEnum {
102 CifsNew = 0,
103 CifsGood,
104 CifsExiting,
Steve Frenchfd88ce92011-04-12 01:01:14 +0000105 CifsNeedReconnect,
106 CifsNeedNegotiate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107};
108
109enum securityEnum {
Jeff Layton515d82f2013-05-26 07:00:58 -0400110 Unspecified = 0, /* not specified */
111 LANMAN, /* Legacy LANMAN auth */
Steve French39798772006-05-31 22:40:51 +0000112 NTLM, /* Legacy NTLM012 auth with NTLM hash */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
Steve Frenchac683922009-05-06 04:16:04 +0000114 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
Steve Frenchc16fefa2008-08-19 19:35:33 +0000115 Kerberos, /* Kerberos via SPNEGO */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
117
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500118struct session_key {
Steve Frenchb609f062007-07-09 07:55:14 +0000119 unsigned int len;
Shirish Pargaonkar21e73392010-10-21 06:42:55 -0500120 char *response;
Steve Frenchb609f062007-07-09 07:55:14 +0000121};
122
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500123/* crypto security descriptor definition */
124struct sdesc {
125 struct shash_desc shash;
126 char ctx[];
127};
128
Shirish Pargaonkarf7c54452010-10-26 18:10:24 -0500129/* crypto hashing related structure/fields, not specific to a sec mech */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500130struct cifs_secmech {
131 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
132 struct crypto_shash *md5; /* md5 hash function */
Pavel Shilovsky3c1bf7e2012-09-18 16:20:30 -0700133 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
Steve French429b46f2013-06-26 23:45:05 -0500134 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500135 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
136 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
Pavel Shilovsky3c1bf7e2012-09-18 16:20:30 -0700137 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
Steve French429b46f2013-06-26 23:45:05 -0500138 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500139};
140
Shirish Pargaonkard3686d52010-10-28 09:53:07 -0500141/* per smb session structure/fields */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500142struct ntlmssp_auth {
Shirish Pargaonkar5c234aa2013-08-29 08:35:10 -0500143 bool sesskey_per_smbsess; /* whether session key is per smb session */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500144 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
145 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
146 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
Shirish Pargaonkard3686d52010-10-28 09:53:07 -0500147 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500148};
149
Steve French442aa312007-09-24 20:25:46 +0000150struct cifs_cred {
151 int uid;
152 int gid;
153 int mode;
154 int cecount;
155 struct cifs_sid osid;
156 struct cifs_sid gsid;
157 struct cifs_ntace *ntaces;
158 struct cifs_ace *aces;
159};
160
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161/*
162 *****************************************************************
163 * Except the CIFS PDUs themselves all the
164 * globally interesting structs should go here
165 *****************************************************************
166 */
167
Jeff Laytonbf5ea0e2012-09-18 16:20:34 -0700168/*
169 * A smb_rqst represents a complete request to be issued to a server. It's
170 * formed by a kvec array, followed by an array of pages. Page data is assumed
171 * to start at the beginning of the first page.
172 */
173struct smb_rqst {
174 struct kvec *rq_iov; /* array of kvecs */
175 unsigned int rq_nvec; /* number of kvecs in array */
176 struct page **rq_pages; /* pointer to array of page ptrs */
177 unsigned int rq_npages; /* number pages in array */
178 unsigned int rq_pagesz; /* page size to use */
179 unsigned int rq_tailsz; /* length of last page */
180};
181
Jeff Layton23db65f2012-05-15 12:20:51 -0400182enum smb_version {
183 Smb_1 = 1,
Steve Frenchdd446b12012-11-28 23:21:06 -0600184 Smb_20,
Steve French1080ef72011-02-24 18:07:19 +0000185 Smb_21,
Steve Frenche4aa25e2012-10-01 12:26:22 -0500186 Smb_30,
Steve French20b6d8b2013-06-12 22:48:41 -0500187 Smb_302,
Steve French5f7fbf72014-12-17 22:52:58 -0600188#ifdef CONFIG_CIFS_SMB311
189 Smb_311,
190#endif /* SMB311 */
191 Smb_version_err
Jeff Layton23db65f2012-05-15 12:20:51 -0400192};
193
Jeff Layton121b0462012-05-15 12:21:10 -0400194struct mid_q_entry;
195struct TCP_Server_Info;
Pavel Shilovsky55157df2012-02-28 14:04:17 +0300196struct cifsFileInfo;
Pavel Shilovsky082d0642012-05-17 12:18:21 +0400197struct cifs_ses;
Pavel Shilovsky2e6e02a2012-05-25 11:11:39 +0400198struct cifs_tcon;
Pavel Shilovskyb669f332012-05-27 20:21:53 +0400199struct dfs_info3_param;
Pavel Shilovsky1208ef12012-05-27 17:34:43 +0400200struct cifs_fattr;
Pavel Shilovsky9224dfc2012-05-27 20:39:52 +0400201struct smb_vol;
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700202struct cifs_fid;
Pavel Shilovskyfc9c5962012-09-18 16:20:28 -0700203struct cifs_readdata;
Pavel Shilovskyc9de5c82012-09-18 16:20:29 -0700204struct cifs_writedata;
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700205struct cifs_io_parms;
Pavel Shilovsky92fc65a2012-09-18 16:20:32 -0700206struct cifs_search_info;
Pavel Shilovsky95a3f2f2012-09-18 16:20:33 -0700207struct cifsInodeInfo;
Pavel Shilovsky226730b2013-07-05 12:00:30 +0400208struct cifs_open_parms;
Jeff Layton121b0462012-05-15 12:21:10 -0400209
Jeff Layton23db65f2012-05-15 12:20:51 -0400210struct smb_version_operations {
Jeff Layton121b0462012-05-15 12:21:10 -0400211 int (*send_cancel)(struct TCP_Server_Info *, void *,
212 struct mid_q_entry *);
Pavel Shilovsky55157df2012-02-28 14:04:17 +0300213 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
Pavel Shilovsky082d0642012-05-17 12:18:21 +0400214 /* setup request: allocate mid, sign message */
Jeff Laytonfec344e2012-09-18 16:20:35 -0700215 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
216 struct smb_rqst *);
Pavel Shilovsky45740842012-06-01 14:26:18 +0400217 /* setup async request: allocate mid, sign message */
Jeff Laytonfec344e2012-09-18 16:20:35 -0700218 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
219 struct smb_rqst *);
Pavel Shilovsky082d0642012-05-17 12:18:21 +0400220 /* check response: verify signature, map error */
221 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
222 bool);
Pavel Shilovskya891f0f2012-05-23 16:14:34 +0400223 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
224 const int);
Pavel Shilovsky45275782012-05-17 17:53:29 +0400225 void (*set_credits)(struct TCP_Server_Info *, const int);
Pavel Shilovskya891f0f2012-05-23 16:14:34 +0400226 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
227 unsigned int (*get_credits)(struct mid_q_entry *);
Pavel Shilovsky88257362012-05-23 14:01:59 +0400228 __u64 (*get_next_mid)(struct TCP_Server_Info *);
Pavel Shilovskyeb378712012-05-17 13:02:51 +0400229 /* data offset from read response message */
230 unsigned int (*read_data_offset)(char *);
231 /* data length from read response message */
232 unsigned int (*read_data_length)(char *);
233 /* map smb to linux error */
234 int (*map_error)(char *, bool);
Pavel Shilovsky8aa26f32012-05-17 13:25:35 +0400235 /* find mid corresponding to the response message */
236 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
237 void (*dump_detail)(void *);
Pavel Shilovsky44c58182012-05-28 14:16:31 +0400238 void (*clear_stats)(struct cifs_tcon *);
239 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
Steve French769ee6a2013-06-19 14:15:30 -0500240 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
Pavel Shilovsky8aa26f32012-05-17 13:25:35 +0400241 /* verify the message */
Steve French373512e2015-12-18 13:05:30 -0600242 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *);
Pavel Shilovsky8aa26f32012-05-17 13:25:35 +0400243 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
Sachin Prabhud8fd99d2017-03-03 15:41:38 -0800244 int (*handle_cancelled_mid)(char *, struct TCP_Server_Info *);
Sachin Prabhuc11f1df2014-03-11 16:11:47 +0000245 void (*downgrade_oplock)(struct TCP_Server_Info *,
246 struct cifsInodeInfo *, bool);
Pavel Shilovsky316cf942012-05-23 14:31:03 +0400247 /* process transaction2 response */
248 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
249 char *, int);
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400250 /* check if we need to negotiate */
251 bool (*need_neg)(struct TCP_Server_Info *);
252 /* negotiate to the server */
253 int (*negotiate)(const unsigned int, struct cifs_ses *);
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700254 /* set negotiated write size */
255 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
256 /* set negotiated read size */
257 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
Pavel Shilovsky58c45c52012-05-25 10:54:49 +0400258 /* setup smb sessionn */
259 int (*sess_setup)(const unsigned int, struct cifs_ses *,
260 const struct nls_table *);
261 /* close smb session */
262 int (*logoff)(const unsigned int, struct cifs_ses *);
Pavel Shilovsky2e6e02a2012-05-25 11:11:39 +0400263 /* connect to a server share */
264 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
265 struct cifs_tcon *, const struct nls_table *);
266 /* close tree connecion */
267 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
Pavel Shilovskyb669f332012-05-27 20:21:53 +0400268 /* get DFS referrals */
269 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
270 const char *, struct dfs_info3_param **,
271 unsigned int *, const struct nls_table *, int);
Pavel Shilovskyaf4281d2012-05-27 20:48:35 +0400272 /* informational QFS call */
273 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
Pavel Shilovsky68889f22012-05-25 14:40:22 +0400274 /* check if a path is accessible or not */
275 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
276 struct cifs_sb_info *, const char *);
Pavel Shilovsky1208ef12012-05-27 17:34:43 +0400277 /* query path data from the server */
278 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
279 struct cifs_sb_info *, const char *,
Pavel Shilovskyeb85d94b2013-10-23 17:49:47 +0400280 FILE_ALL_INFO *, bool *, bool *);
Pavel Shilovsky4ad65042012-09-18 16:20:26 -0700281 /* query file data from the server */
282 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
283 struct cifs_fid *, FILE_ALL_INFO *);
Pavel Shilovsky1208ef12012-05-27 17:34:43 +0400284 /* get server index number */
285 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
286 struct cifs_sb_info *, const char *,
287 u64 *uniqueid, FILE_ALL_INFO *);
Pavel Shilovskyd1433412012-09-18 16:20:31 -0700288 /* set size by path */
289 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
290 const char *, __u64, struct cifs_sb_info *, bool);
291 /* set size by file handle */
292 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
293 struct cifsFileInfo *, __u64, bool);
Pavel Shilovsky6bdf6db2012-09-18 16:20:32 -0700294 /* set attributes */
295 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
296 const unsigned int);
Steve French64a5cfa2013-10-14 15:31:32 -0500297 int (*set_compression)(const unsigned int, struct cifs_tcon *,
298 struct cifsFileInfo *);
Pavel Shilovskyf6d76172012-05-25 14:47:16 +0400299 /* check if we can send an echo or nor */
300 bool (*can_echo)(struct TCP_Server_Info *);
301 /* send echo request */
302 int (*echo)(struct TCP_Server_Info *);
Pavel Shilovskyf4367202012-03-17 11:41:12 +0300303 /* create directory */
304 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
305 struct cifs_sb_info *);
306 /* set info on created directory */
307 void (*mkdir_setinfo)(struct inode *, const char *,
308 struct cifs_sb_info *, struct cifs_tcon *,
309 const unsigned int);
Pavel Shilovskyf958ca52012-07-10 16:14:18 +0400310 /* remove directory */
311 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
312 struct cifs_sb_info *);
Pavel Shilovskyed6875e2012-09-18 16:20:25 -0700313 /* unlink file */
314 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
315 struct cifs_sb_info *);
316 /* open, rename and delete file */
317 int (*rename_pending_delete)(const char *, struct dentry *,
318 const unsigned int);
Pavel Shilovsky8ceb9842012-09-18 16:20:30 -0700319 /* send rename request */
320 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
321 const char *, struct cifs_sb_info *);
Steve Frenchd6e906f2012-09-18 16:20:31 -0700322 /* send create hardlink request */
323 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
324 const char *, const char *,
325 struct cifs_sb_info *);
Pavel Shilovskyb42bf882013-08-14 19:25:21 +0400326 /* query symlink target */
327 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
328 const char *, char **, struct cifs_sb_info *);
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700329 /* open a file for non-posix mounts */
Pavel Shilovsky226730b2013-07-05 12:00:30 +0400330 int (*open)(const unsigned int, struct cifs_open_parms *,
331 __u32 *, FILE_ALL_INFO *);
Pavel Shilovskyfb1214e2012-09-18 16:20:26 -0700332 /* set fid protocol-specific info */
333 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
Pavel Shilovsky0ff78a22012-09-18 16:20:26 -0700334 /* close a file */
Pavel Shilovsky760ad0c2012-09-25 11:00:07 +0400335 void (*close)(const unsigned int, struct cifs_tcon *,
336 struct cifs_fid *);
Pavel Shilovsky1d8c4c02012-09-18 16:20:27 -0700337 /* send a flush request to the server */
338 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
Pavel Shilovskyfc9c5962012-09-18 16:20:28 -0700339 /* async read from the server */
340 int (*async_readv)(struct cifs_readdata *);
Pavel Shilovskyc9de5c82012-09-18 16:20:29 -0700341 /* async write to the server */
Steve French4a5c80d2014-02-07 20:45:12 -0600342 int (*async_writev)(struct cifs_writedata *,
343 void (*release)(struct kref *));
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700344 /* sync read from the server */
Steve Frenchdb8b6312014-09-22 05:13:55 -0500345 int (*sync_read)(const unsigned int, struct cifs_fid *,
Pavel Shilovskyf9c6e232012-09-18 16:20:29 -0700346 struct cifs_io_parms *, unsigned int *, char **,
347 int *);
Pavel Shilovskyba9ad7252012-09-18 16:20:30 -0700348 /* sync write to the server */
Steve Frenchdb8b6312014-09-22 05:13:55 -0500349 int (*sync_write)(const unsigned int, struct cifs_fid *,
Pavel Shilovskyba9ad7252012-09-18 16:20:30 -0700350 struct cifs_io_parms *, unsigned int *, struct kvec *,
351 unsigned long);
Pavel Shilovsky92fc65a2012-09-18 16:20:32 -0700352 /* open dir, start readdir */
353 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
354 const char *, struct cifs_sb_info *,
355 struct cifs_fid *, __u16,
356 struct cifs_search_info *);
357 /* continue readdir */
358 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
359 struct cifs_fid *,
360 __u16, struct cifs_search_info *srch_inf);
361 /* close dir */
362 int (*close_dir)(const unsigned int, struct cifs_tcon *,
363 struct cifs_fid *);
364 /* calculate a size of SMB message */
365 unsigned int (*calc_smb_size)(void *);
Pavel Shilovsky2e44b282012-09-18 16:20:33 -0700366 /* check for STATUS_PENDING and process it in a positive case */
367 bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
Pavel Shilovsky92d7d3e2017-07-08 14:32:00 -0700368 /* check for STATUS_NETWORK_SESSION_EXPIRED */
369 bool (*is_session_expired)(char *);
Pavel Shilovsky95a3f2f2012-09-18 16:20:33 -0700370 /* send oplock break response */
371 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
372 struct cifsInodeInfo *);
Pavel Shilovsky76ec5e32012-09-18 16:20:33 -0700373 /* query remote filesystem */
374 int (*queryfs)(const unsigned int, struct cifs_tcon *,
375 struct kstatfs *);
Pavel Shilovskyd39a4f72012-09-19 06:22:43 -0700376 /* send mandatory brlock to the server */
377 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
378 __u64, __u32, int, int, bool);
379 /* unlock range of mandatory locks */
380 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
381 const unsigned int);
382 /* push brlocks from the cache to the server */
383 int (*push_mand_locks)(struct cifsFileInfo *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700384 /* get lease key of the inode */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400385 void (*get_lease_key)(struct inode *, struct cifs_fid *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700386 /* set lease key of the inode */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400387 void (*set_lease_key)(struct inode *, struct cifs_fid *);
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -0700388 /* generate new lease key */
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400389 void (*new_lease_key)(struct cifs_fid *);
Shirish Pargaonkar32811d22013-08-29 08:35:11 -0500390 int (*generate_signingkey)(struct cifs_ses *);
Pavel Shilovsky53ef1012013-09-05 16:11:28 +0400391 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
Steve Frenchb3152e22015-06-24 03:17:02 -0500392 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon,
393 struct cifsFileInfo *src_file);
Steve French834170c2016-09-30 21:14:26 -0500394 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon,
395 struct cifsFileInfo *src_file, void __user *);
Sachin Prabhub5be1a12013-11-25 17:09:49 +0000396 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
397 struct cifs_sb_info *, const unsigned char *,
398 char *, unsigned int *);
Sachin Prabhucbb0aba2013-11-25 17:09:52 +0000399 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *,
400 struct cifs_sb_info *, const unsigned char *,
401 char *, unsigned int *);
Pavel Shilovsky53ef1012013-09-05 16:11:28 +0400402 /* if we can do cache read operations */
403 bool (*is_read_op)(__u32);
404 /* set oplock level for the inode */
Pavel Shilovsky42873b02013-09-05 21:30:16 +0400405 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
406 bool *);
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400407 /* create lease context buffer for CREATE request */
408 char * (*create_lease_buf)(u8 *, u8);
Pavel Shilovsky42873b02013-09-05 21:30:16 +0400409 /* parse lease context buffer and return oplock/epoch info */
410 __u8 (*parse_lease_buf)(void *, unsigned int *);
Steve French41c13582013-11-14 00:05:36 -0600411 int (*clone_range)(const unsigned int, struct cifsFileInfo *src_file,
412 struct cifsFileInfo *target_file, u64 src_off, u64 len,
413 u64 dest_off);
Steve French02b16662015-06-27 21:18:36 -0700414 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src,
415 struct cifsFileInfo *target_file, u64 src_off, u64 len,
416 u64 dest_off);
Steve Frenchff1c0382013-11-19 23:44:46 -0600417 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
Steve French666753c2014-01-26 23:53:43 -0600418 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *,
419 const unsigned char *, const unsigned char *, char *,
420 size_t, const struct nls_table *, int);
421 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *,
422 const char *, const void *, const __u16,
423 const struct nls_table *, int);
Steve French83e3bc22014-02-02 23:31:47 -0600424 struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *,
425 const char *, u32 *);
Steve French42eacf92014-02-10 14:08:16 -0600426 struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *,
427 const struct cifs_fid *, u32 *);
Steve French83e3bc22014-02-02 23:31:47 -0600428 int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *,
429 int);
Pavel Shilovsky7f6c5002014-06-22 11:03:22 +0400430 /* writepages retry size */
431 unsigned int (*wp_retry_size)(struct inode *);
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400432 /* get mtu credits */
433 int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int,
434 unsigned int *, unsigned int *);
Pavel Shilovsky52755802014-08-18 20:49:57 +0400435 /* check if we need to issue closedir */
436 bool (*dir_needs_close)(struct cifsFileInfo *);
Steve French31742c52014-08-17 08:38:47 -0500437 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t,
438 loff_t);
Jeff Layton23db65f2012-05-15 12:20:51 -0400439};
440
441struct smb_version_values {
442 char *version_string;
Steve Frenche4aa25e2012-10-01 12:26:22 -0500443 __u16 protocol_id;
444 __u32 req_capabilities;
Pavel Shilovsky106dc532012-02-28 14:23:34 +0300445 __u32 large_lock_type;
446 __u32 exclusive_lock_type;
447 __u32 shared_lock_type;
448 __u32 unlock_lock_type;
Pavel Shilovsky1887f602012-05-17 12:45:31 +0400449 size_t header_size;
450 size_t max_header_size;
Pavel Shilovskyeb378712012-05-17 13:02:51 +0400451 size_t read_rsp_size;
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +0400452 __le16 lock_cmd;
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400453 unsigned int cap_unix;
454 unsigned int cap_nt_find;
455 unsigned int cap_large_files;
Jeff Layton50285882013-06-27 12:45:00 -0400456 __u16 signing_enabled;
457 __u16 signing_required;
Pavel Shilovskya41a28b2013-09-04 13:07:41 +0400458 size_t create_lease_size;
Jeff Layton23db65f2012-05-15 12:20:51 -0400459};
460
Pavel Shilovsky1887f602012-05-17 12:45:31 +0400461#define HEADER_SIZE(server) (server->vals->header_size)
462#define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
463
Steve Frenchf87d39d2011-05-27 03:50:55 +0000464struct smb_vol {
465 char *username;
466 char *password;
467 char *domainname;
468 char *UNC;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000469 char *iocharset; /* local code page for mapping to and from Unicode */
470 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
471 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
Eric W. Biederman3da46562013-02-06 01:37:39 -0800472 kuid_t cred_uid;
473 kuid_t linux_uid;
474 kgid_t linux_gid;
475 kuid_t backupuid;
476 kgid_t backupgid;
Al Viro5206efd2011-07-26 03:22:14 -0400477 umode_t file_mode;
478 umode_t dir_mode;
Jeff Layton1e3cc572013-06-10 17:12:23 -0500479 enum securityEnum sectype; /* sectype requested via mnt opts */
480 bool sign; /* was signing requested via mnt opts? */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000481 bool retry:1;
482 bool intr:1;
483 bool setuids:1;
Steve French95932652016-09-23 01:36:34 -0500484 bool setuidfromacl:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000485 bool override_uid:1;
486 bool override_gid:1;
487 bool dynperm:1;
488 bool noperm:1;
489 bool no_psx_acl:1; /* set if posix acl support should be disabled */
490 bool cifs_acl:1;
Shirish Pargaonkar3d3ea8e2011-09-26 09:56:44 -0500491 bool backupuid_specified; /* mount option backupuid is specified */
492 bool backupgid_specified; /* mount option backupgid is specified */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000493 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
494 bool server_ino:1; /* use inode numbers from server ie UniqueId */
495 bool direct_io:1;
496 bool strict_io:1; /* strict cache behavior */
497 bool remap:1; /* set to remap seven reserved chars in filenames */
Steve French2baa2682014-09-27 02:19:01 -0500498 bool sfu_remap:1; /* remap seven reserved chars ala SFU */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000499 bool posix_paths:1; /* unset to not ask for posix pathnames. */
500 bool no_linux_ext:1;
501 bool sfu_emul:1;
502 bool nullauth:1; /* attempt to authenticate with null user */
503 bool nocase:1; /* request case insensitive filenames */
504 bool nobrl:1; /* disable sending byte range locks to srv */
505 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
506 bool seal:1; /* request transport encryption on share */
507 bool nodfs:1; /* Do not request DFS, even if available */
508 bool local_lease:1; /* check leases only on local system, not remote */
509 bool noblocksnd:1;
510 bool noautotune:1;
511 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
512 bool fsc:1; /* enable fscache */
513 bool mfsymlinks:1; /* use Minshall+French Symlinks */
514 bool multiuser:1;
Pavel Shilovskyd4ffff12011-05-26 06:02:00 +0000515 bool rwpidforward:1; /* pid forward for read/write operations */
Steve Frenchb2a30772015-09-29 21:49:28 -0500516 bool nosharesock:1;
517 bool persistent:1;
518 bool nopersistent:1;
Steve French592fafe2015-11-03 10:08:53 -0600519 bool resilient:1; /* noresilient not required since not fored for CA */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000520 unsigned int rsize;
521 unsigned int wsize;
522 bool sockopt_tcp_nodelay:1;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000523 unsigned long actimeo; /* attribute cache timeout (jiffies) */
Jeff Layton23db65f2012-05-15 12:20:51 -0400524 struct smb_version_operations *ops;
525 struct smb_version_values *vals;
Steve Frenchf87d39d2011-05-27 03:50:55 +0000526 char *prepath;
Jeff Laytonb979aaa2012-11-26 11:09:55 -0500527 struct sockaddr_storage dstaddr; /* destination address */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000528 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
529 struct nls_table *local_nls;
Steve Frenchadfeb3e2015-12-18 12:31:36 -0600530 unsigned int echo_interval; /* echo interval in secs */
Steve French141891f2016-09-23 00:44:16 -0500531 unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
Steve Frenchf87d39d2011-05-27 03:50:55 +0000532};
533
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400534#define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
535 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
536 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
Steve French2baa2682014-09-27 02:19:01 -0500537 CIFS_MOUNT_MAP_SFM_CHR | \
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400538 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
539 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
540 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
541 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
542 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
Shirish Pargaonkar3d3ea8e2011-09-26 09:56:44 -0500543 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
544 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
Pavel Shilovsky25c7f412011-05-26 23:35:47 +0400545
546#define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
547 MS_NODEV | MS_SYNCHRONOUS)
548
549struct cifs_mnt_data {
550 struct cifs_sb_info *cifs_sb;
551 struct smb_vol *vol;
552 int flags;
553};
554
Pavel Shilovsky792af7b2012-03-23 14:28:02 -0400555static inline unsigned int
556get_rfc1002_length(void *buf)
557{
Jeff Laytondca1c8d2014-02-22 19:35:38 -0500558 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
Pavel Shilovsky792af7b2012-03-23 14:28:02 -0400559}
560
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400561static inline void
562inc_rfc1001_len(void *buf, int count)
563{
564 be32_add_cpu((__be32 *)buf, count);
565}
566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000568 struct list_head tcp_ses_list;
569 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500570 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700571 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500572 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Layton23db65f2012-05-15 12:20:51 -0400573 struct smb_version_operations *ops;
574 struct smb_version_values *vals;
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500575 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Laytonc359cf32007-11-16 22:22:06 +0000576 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 struct socket *ssocket;
Pavel Shilovskya9f1b852010-12-13 19:08:35 +0300578 struct sockaddr_storage dstaddr;
Ben Greear3eb9a882010-09-01 17:06:02 -0700579 struct sockaddr_storage srcaddr; /* locally bind to this IP */
Rob Landleyf1d0c992011-01-22 15:44:05 -0600580#ifdef CONFIG_NET_NS
581 struct net *net;
582#endif
Steve Frenchd38d8c72007-06-28 19:44:13 +0000583 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
585 struct list_head pending_mid_q;
Steve Frenchedf1ae42008-10-29 00:47:57 +0000586 bool noblocksnd; /* use blocking sendmsg */
587 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000588 bool tcp_nodelay;
Steve French141891f2016-09-23 00:44:16 -0500589 unsigned int credits; /* send no more requests at once */
590 unsigned int max_credits; /* can override large 32000 default at mnt */
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300591 unsigned int in_flight; /* number of requests on the wire to server */
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400592 spinlock_t req_lock; /* protect the two values above */
Jeff Layton72ca5452008-12-01 07:09:36 -0500593 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 struct task_struct *tsk;
595 char server_GUID[16];
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400596 __u16 sec_mode;
Jeff Layton38d77c52013-05-26 07:01:00 -0400597 bool sign; /* is signing enabled on this connection? */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500598 bool session_estab; /* mark when very first sess is established */
Pavel Shilovsky28ea5292012-05-23 16:18:00 +0400599#ifdef CONFIG_CIFS_SMB2
600 int echo_credits; /* echo reserved slots */
601 int oplock_credits; /* oplock break reserved slots */
602 bool echoes:1; /* enable echoes */
Sachin Prabhu39552ea2014-05-13 00:48:12 +0100603 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */
Pavel Shilovsky28ea5292012-05-23 16:18:00 +0400604#endif
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500605 u16 dialect; /* dialect index that server chose */
Pavel Shilovsky10b9b982012-03-20 12:55:09 +0300606 bool oplocks:1; /* enable oplocks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 unsigned int maxReq; /* Clients should submit no more */
608 /* than maxReq distinct unanswered SMBs to the server when using */
609 /* multiplexed reads or writes */
610 unsigned int maxBuf; /* maxBuf specifies the maximum */
611 /* message size the server can send or receive for non-raw SMBs */
Steve French7e90d702011-02-08 23:52:32 +0000612 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
613 /* when socket is setup (and during reconnect) before NegProt sent */
Steve Frencheca6acf2009-02-20 05:43:09 +0000614 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 /* message size the server can send or receive for */
616 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400617 unsigned int capabilities; /* selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000618 int timeAdj; /* Adjust for difference in server time zone in sec */
Pavel Shilovsky243d04b2012-03-23 14:28:03 -0400619 __u64 CurrentMid; /* multiplex id - rotating counter */
Shirish Pargaonkard3ba50b2010-10-27 15:20:36 -0500620 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
Steve Frencha10faeb22005-08-22 21:38:31 -0700621 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500622 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytona0f8b4f2011-01-07 11:30:28 -0500623 __u32 sequence_number; /* for signing, protected by srv_mutex */
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500624 struct session_key session_key;
Steve French3a5ff612006-07-14 22:37:11 +0000625 unsigned long lstrp; /* when we got last response from this server */
Shirish Pargaonkard2b91522010-10-21 14:25:08 -0500626 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
Jeff Laytone598d1d82013-05-26 07:00:59 -0400627#define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
628#define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
629#define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
630 char negflavor; /* NEGOTIATE response flavor */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400631 /* extended security flavors that server supports */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500632 bool sec_ntlmssp; /* supports NTLMSSP */
633 bool sec_kerberosu2u; /* supports U2U Kerberos */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400634 bool sec_kerberos; /* supports plain Kerberos */
635 bool sec_mskerberos; /* supports legacy MS Kerberos */
Jeff Layton2a37ef92011-10-19 15:29:23 -0400636 bool large_buf; /* is current buffer large? */
Jeff Laytonc74093b2011-01-11 07:24:23 -0500637 struct delayed_work echo; /* echo ping workqueue job */
Jeff Layton2a37ef92011-10-19 15:29:23 -0400638 char *smallbuf; /* pointer to current "small" buffer */
639 char *bigbuf; /* pointer to current "big" buffer */
640 unsigned int total_read; /* total amount of data read in this pass */
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530641#ifdef CONFIG_CIFS_FSCACHE
642 struct fscache_cookie *fscache; /* client index cache cookie */
643#endif
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500644#ifdef CONFIG_CIFS_STATS2
Steve French789e6662011-08-09 18:44:44 +0000645 atomic_t in_send; /* requests trying to send */
Jeff Laytonc3dccf42011-01-20 13:36:50 -0500646 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
647#endif
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400648#ifdef CONFIG_CIFS_SMB2
649 unsigned int max_read;
650 unsigned int max_write;
Steve French373512e2015-12-18 13:05:30 -0600651 __u8 preauth_hash[512];
Pavel Shilovsky48f95262016-11-04 11:50:31 -0700652 struct delayed_work reconnect; /* reconnect workqueue job */
653 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */
Pavel Shilovskyec2e4522011-12-27 16:12:43 +0400654#endif /* CONFIG_CIFS_SMB2 */
Steve Frenchadfeb3e2015-12-18 12:31:36 -0600655 unsigned long echo_interval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656};
657
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300658static inline unsigned int
659in_flight(struct TCP_Server_Info *server)
660{
661 unsigned int num;
662 spin_lock(&server->req_lock);
663 num = server->in_flight;
664 spin_unlock(&server->req_lock);
665 return num;
666}
667
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400668static inline bool
Pavel Shilovskybc205ed2012-03-15 13:22:27 +0300669has_credits(struct TCP_Server_Info *server, int *credits)
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300670{
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400671 int num;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300672 spin_lock(&server->req_lock);
Pavel Shilovskybc205ed2012-03-15 13:22:27 +0300673 num = *credits;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300674 spin_unlock(&server->req_lock);
Pavel Shilovsky2d86dbc2012-02-06 15:59:18 +0400675 return num > 0;
Pavel Shilovskyfc40f9c2012-02-17 17:09:12 +0300676}
677
Pavel Shilovsky45275782012-05-17 17:53:29 +0400678static inline void
Pavel Shilovskya891f0f2012-05-23 16:14:34 +0400679add_credits(struct TCP_Server_Info *server, const unsigned int add,
680 const int optype)
Pavel Shilovsky45275782012-05-17 17:53:29 +0400681{
Pavel Shilovskya891f0f2012-05-23 16:14:34 +0400682 server->ops->add_credits(server, add, optype);
Pavel Shilovsky45275782012-05-17 17:53:29 +0400683}
684
685static inline void
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +0400686add_credits_and_wake_if(struct TCP_Server_Info *server, const unsigned int add,
687 const int optype)
688{
689 if (add) {
690 server->ops->add_credits(server, add, optype);
691 wake_up(&server->request_q);
692 }
693}
694
695static inline void
Pavel Shilovsky45275782012-05-17 17:53:29 +0400696set_credits(struct TCP_Server_Info *server, const int val)
697{
698 server->ops->set_credits(server, val);
699}
700
Sachin Prabhu9235d092014-12-09 17:37:00 +0000701static inline __le64
Tim Gardner3d378d32013-11-02 12:50:34 -0500702get_next_mid64(struct TCP_Server_Info *server)
Pavel Shilovsky88257362012-05-23 14:01:59 +0400703{
Sachin Prabhu9235d092014-12-09 17:37:00 +0000704 return cpu_to_le64(server->ops->get_next_mid(server));
Pavel Shilovsky88257362012-05-23 14:01:59 +0400705}
706
Tim Gardner3d378d32013-11-02 12:50:34 -0500707static inline __le16
708get_next_mid(struct TCP_Server_Info *server)
709{
Sachin Prabhu9235d092014-12-09 17:37:00 +0000710 __u16 mid = server->ops->get_next_mid(server);
Tim Gardner3d378d32013-11-02 12:50:34 -0500711 /*
712 * The value in the SMB header should be little endian for easy
713 * on-the-wire decoding.
714 */
715 return cpu_to_le16(mid);
716}
717
718static inline __u16
719get_mid(const struct smb_hdr *smb)
720{
721 return le16_to_cpu(smb->Mid);
722}
723
724static inline bool
725compare_mid(__u16 mid, const struct smb_hdr *smb)
726{
727 return mid == le16_to_cpu(smb->Mid);
728}
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730/*
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700731 * When the server supports very large reads and writes via POSIX extensions,
732 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
733 * including the RFC1001 length.
734 *
735 * Note that this might make for "interesting" allocation problems during
736 * writeback however as we have to allocate an array of pointers for the
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300737 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096.
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700738 *
739 * For reads, there is a similar problem as we need to allocate an array
740 * of kvecs to handle the receive, though that should only need to be done
741 * once.
742 */
743#define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
744#define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
745
746/*
747 * When the server doesn't allow large posix writes, only allow a rsize/wsize
748 * of 2^17-1 minus the size of the call header. That allows for a read or
749 * write up to the maximum size described by RFC1002.
750 */
751#define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
752#define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
753
754/*
755 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300756 * pages in a single call. With PAGE_SIZE == 4k, this means we can fill
Pavel Shilovsky24985c52012-09-18 16:20:28 -0700757 * a single wsize request with a single call.
758 */
759#define CIFS_DEFAULT_IOSIZE (1024 * 1024)
760
761/*
762 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
763 * those values when posix extensions aren't in force. In actuality here, we
764 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
765 * to be ok with the extra byte even though Windows doesn't send writes that
766 * are that large.
767 *
768 * Citation:
769 *
770 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
771 */
772#define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
773#define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
774
775/*
Rob Landleyf1d0c992011-01-22 15:44:05 -0600776 * Macros to allow the TCP_Server_Info->net field and related code to drop out
777 * when CONFIG_NET_NS isn't set.
778 */
779
780#ifdef CONFIG_NET_NS
781
782static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
783{
784 return srv->net;
785}
786
787static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
788{
789 srv->net = net;
790}
791
792#else
793
794static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
795{
796 return &init_net;
797}
798
799static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
800{
801}
802
803#endif
804
805/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 * Session structure. One of these for each uid session with a particular host
807 */
Steve French96daf2b2011-05-27 04:34:02 +0000808struct cifs_ses {
Jeff Layton14fbf502008-11-14 13:53:46 -0500809 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000810 struct list_head tcon_list;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000811 struct mutex session_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500813 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000815 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 __u16 ipc_tid; /* special tid for connection to IPC share */
Steve Frenchad009ac2005-04-28 22:41:05 -0700817 char *serverOS; /* name of operating system underlying server */
818 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 char *serverDomain; /* security realm of server */
Pavel Shilovsky286170a2012-05-25 10:43:58 +0400820 __u64 Suid; /* remote smb uid */
Eric W. Biederman64ed39d2013-02-06 02:30:39 -0800821 kuid_t linux_uid; /* overriding owner of files on the mount */
822 kuid_t cred_uid; /* owner of credentials */
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400823 unsigned int capabilities;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000824 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
Steve Frenchad009ac2005-04-28 22:41:05 -0700825 TCP names - will ipv6 and sctp addresses fit? */
Steve French34c87902011-03-01 05:02:57 +0000826 char *user_name; /* must not be null except during init of sess
827 and after mount option parsing we fill it */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000828 char *domainName;
829 char *password;
Shirish Pargaonkar5d0d2882010-10-13 18:15:00 -0500830 struct session_key auth_key;
Shirish Pargaonkard3686d52010-10-28 09:53:07 -0500831 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
Jeff Layton28e11bd2013-05-26 07:01:00 -0400832 enum securityEnum sectype; /* what security flavor was specified? */
833 bool sign; /* is signing required? */
Steve French3b795212008-11-13 19:45:32 +0000834 bool need_reconnect:1; /* connection reset, uid now invalid */
Pavel Shilovsky5478f9b2011-12-27 16:22:00 +0400835#ifdef CONFIG_CIFS_SMB2
836 __u16 session_flags;
Steve French373512e2015-12-18 13:05:30 -0600837 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE];
838 __u8 smb3encryptionkey[SMB3_SIGN_KEY_SIZE];
839 __u8 smb3decryptionkey[SMB3_SIGN_KEY_SIZE];
840 __u8 preauth_hash[512];
Pavel Shilovsky5478f9b2011-12-27 16:22:00 +0400841#endif /* CONFIG_CIFS_SMB2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842};
Pavel Shilovsky233839b2012-09-19 06:22:45 -0700843
Pavel Shilovsky29e20f92012-07-13 13:58:14 +0400844static inline bool
845cap_unix(struct cifs_ses *ses)
846{
847 return ses->server->vals->cap_unix & ses->capabilities;
848}
849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850/*
851 * there is one of these for each connection to a resource on a particular
Steve Frenchd38d8c72007-06-28 19:44:13 +0000852 * session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 */
Steve French96daf2b2011-05-27 04:34:02 +0000854struct cifs_tcon {
Jeff Laytonf1987b42008-11-15 11:12:47 -0500855 struct list_head tcon_list;
856 int tc_count;
Pavel Shilovsky48f95262016-11-04 11:50:31 -0700857 struct list_head rlist; /* reconnect list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 struct list_head openFileList;
Steve French3afca262016-09-22 18:58:16 -0500859 spinlock_t open_file_lock; /* protects list above */
Steve French96daf2b2011-05-27 04:34:02 +0000860 struct cifs_ses *ses; /* pointer to session associated with */
Steve French254e55e2006-06-04 05:53:15 +0000861 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 char *nativeFileSystem;
Jeff Layton00e485b2008-12-05 20:41:21 -0500863 char *password; /* for share-level security */
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +0400864 __u32 tid; /* The 4 byte tree id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 __u16 Flags; /* optional support bits */
866 enum statusEnum tidStatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867#ifdef CONFIG_CIFS_STATS
868 atomic_t num_smbs_sent;
Pavel Shilovsky44c58182012-05-28 14:16:31 +0400869 union {
870 struct {
871 atomic_t num_writes;
872 atomic_t num_reads;
873 atomic_t num_flushes;
874 atomic_t num_oplock_brks;
875 atomic_t num_opens;
876 atomic_t num_closes;
877 atomic_t num_deletes;
878 atomic_t num_mkdirs;
879 atomic_t num_posixopens;
880 atomic_t num_posixmkdirs;
881 atomic_t num_rmdirs;
882 atomic_t num_renames;
883 atomic_t num_t2renames;
884 atomic_t num_ffirst;
885 atomic_t num_fnext;
886 atomic_t num_fclose;
887 atomic_t num_hardlinks;
888 atomic_t num_symlinks;
889 atomic_t num_locks;
890 atomic_t num_acl_get;
891 atomic_t num_acl_set;
892 } cifs_stats;
Pavel Shilovskyd60622e2012-05-28 15:19:39 +0400893#ifdef CONFIG_CIFS_SMB2
894 struct {
895 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
896 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
897 } smb2_stats;
898#endif /* CONFIG_CIFS_SMB2 */
Pavel Shilovsky44c58182012-05-28 14:16:31 +0400899 } stats;
Steve Frencha5a2b482005-08-20 21:42:53 -0700900#ifdef CONFIG_CIFS_STATS2
901 unsigned long long time_writes;
902 unsigned long long time_reads;
903 unsigned long long time_opens;
904 unsigned long long time_deletes;
905 unsigned long long time_closes;
906 unsigned long long time_mkdirs;
907 unsigned long long time_rmdirs;
908 unsigned long long time_renames;
909 unsigned long long time_t2renames;
910 unsigned long long time_ffirst;
911 unsigned long long time_fnext;
912 unsigned long long time_fclose;
913#endif /* CONFIG_CIFS_STATS2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 __u64 bytes_read;
915 __u64 bytes_written;
Steve French3afca262016-09-22 18:58:16 -0500916 spinlock_t stat_lock; /* protects the two fields above */
Steve Frencha5a2b482005-08-20 21:42:53 -0700917#endif /* CONFIG_CIFS_STATS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +0000919 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Steve French4b18f2a2008-04-29 00:06:05 +0000921 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
922 bool retry:1;
923 bool nocase:1;
Steve French95b1cb92008-05-15 16:44:38 +0000924 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +0000925 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +0000926 for this mount even if server would support */
Steve French84210e92008-10-23 04:42:37 +0000927 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French64cc2c62009-03-04 19:54:08 +0000928 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
Steve French3d1a3742014-08-11 21:05:25 -0500929 bool broken_sparse_sup; /* if server or share does not support sparse */
Steve French3b795212008-11-13 19:45:32 +0000930 bool need_reconnect:1; /* connection reset, tid now invalid */
Pavel Shilovsky46890ff2016-11-29 11:31:23 -0800931 bool need_reopen_files:1; /* need to reopen tcon file handles */
Steve French592fafe2015-11-03 10:08:53 -0600932 bool use_resilient:1; /* use resilient instead of durable handles */
Steve Frenchb618f002015-11-03 09:15:03 -0600933 bool use_persistent:1; /* use persistent instead of durable handles */
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +0400934#ifdef CONFIG_CIFS_SMB2
935 bool print:1; /* set if connection to printer share */
Steve French769ee6a2013-06-19 14:15:30 -0500936 __le32 capabilities;
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +0400937 __u32 share_flags;
938 __u32 maximal_access;
939 __u32 vol_serial_number;
940 __le64 vol_create_time;
Steven Frenchaf6a12e2013-10-09 20:55:53 -0500941 __u32 ss_flags; /* sector size flags */
942 __u32 perf_sector_size; /* best sector size for perf */
Steve Frenchde9f68d2013-11-15 11:26:24 -0600943 __u32 max_chunks;
944 __u32 max_bytes_chunk;
945 __u32 max_bytes_copy;
Pavel Shilovskyfaaf9462011-12-27 16:04:00 +0400946#endif /* CONFIG_CIFS_SMB2 */
Suresh Jayaramand03382c2010-07-05 18:12:27 +0530947#ifdef CONFIG_CIFS_FSCACHE
948 u64 resource_id; /* server resource id */
949 struct fscache_cookie *fscache; /* cookie for share */
950#endif
Pavel Shilovsky233839b2012-09-19 06:22:45 -0700951 struct list_head pending_opens; /* list of incomplete opens */
Steve Frenchc18c8422007-07-18 23:21:09 +0000952 /* BB add field for back pointer to sb struct(s)? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953};
954
955/*
Jeff Layton7ffec372010-09-29 19:51:11 -0400956 * This is a refcounted and timestamped container for a tcon pointer. The
957 * container holds a tcon reference. It is considered safe to free one of
958 * these when the tl_count goes to 0. The tl_time is the time of the last
959 * "get" on the container.
960 */
961struct tcon_link {
Jeff Laytonb647c352010-10-28 11:16:44 -0400962 struct rb_node tl_rbnode;
Eric W. Biederman6d4a0832013-02-06 01:48:56 -0800963 kuid_t tl_uid;
Jeff Layton9d002df2010-10-06 19:51:11 -0400964 unsigned long tl_flags;
965#define TCON_LINK_MASTER 0
966#define TCON_LINK_PENDING 1
967#define TCON_LINK_IN_TREE 2
968 unsigned long tl_time;
969 atomic_t tl_count;
Steve French96daf2b2011-05-27 04:34:02 +0000970 struct cifs_tcon *tl_tcon;
Jeff Layton7ffec372010-09-29 19:51:11 -0400971};
972
Jeff Layton9d002df2010-10-06 19:51:11 -0400973extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
Jeff Layton7ffec372010-09-29 19:51:11 -0400974
Steve French96daf2b2011-05-27 04:34:02 +0000975static inline struct cifs_tcon *
Jeff Layton7ffec372010-09-29 19:51:11 -0400976tlink_tcon(struct tcon_link *tlink)
977{
Jeff Layton9d002df2010-10-06 19:51:11 -0400978 return tlink->tl_tcon;
Jeff Layton7ffec372010-09-29 19:51:11 -0400979}
980
Jeff Layton9d002df2010-10-06 19:51:11 -0400981extern void cifs_put_tlink(struct tcon_link *tlink);
Jeff Layton7ffec372010-09-29 19:51:11 -0400982
Jeff Layton13cfb732010-09-29 19:51:11 -0400983static inline struct tcon_link *
984cifs_get_tlink(struct tcon_link *tlink)
985{
Jeff Layton9d002df2010-10-06 19:51:11 -0400986 if (tlink && !IS_ERR(tlink))
987 atomic_inc(&tlink->tl_count);
Jeff Layton13cfb732010-09-29 19:51:11 -0400988 return tlink;
989}
990
Jeff Layton7ffec372010-09-29 19:51:11 -0400991/* This function is always expected to succeed */
Steve French96daf2b2011-05-27 04:34:02 +0000992extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
Jeff Layton7ffec372010-09-29 19:51:11 -0400993
Pavel Shilovsky233839b2012-09-19 06:22:45 -0700994#define CIFS_OPLOCK_NO_CHANGE 0xfe
995
996struct cifs_pending_open {
997 struct list_head olist;
998 struct tcon_link *tlink;
999 __u8 lease_key[16];
1000 __u32 oplock;
1001};
1002
Jeff Layton7ffec372010-09-29 19:51:11 -04001003/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001004 * This info hangs off the cifsFileInfo structure, pointed to by llist.
1005 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 */
1007struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001008 struct list_head llist; /* pointer to next cifsLockInfo */
Pavel Shilovsky85160e02011-10-22 15:33:29 +04001009 struct list_head blist; /* pointer to locks blocked on this */
1010 wait_queue_head_t block_q;
Jeremy Allison7ee1af72006-08-02 21:56:33 +00001011 __u64 offset;
1012 __u64 length;
Pavel Shilovsky03776f42010-08-17 11:26:00 +04001013 __u32 pid;
Pavel Shilovsky04a6aa82012-02-28 14:16:55 +03001014 __u32 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015};
1016
1017/*
1018 * One of these for each open instance of a file
1019 */
1020struct cifs_search_info {
1021 loff_t index_of_last_entry;
1022 __u16 entries_in_buffer;
1023 __u16 info_level;
1024 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +00001025 char *ntwrk_buf_start;
1026 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +00001027 char *last_entry;
Christoph Hellwigeaf35b12011-07-16 15:24:37 -04001028 const char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +00001030 bool endOfSearch:1;
1031 bool emptyDir:1;
1032 bool unicode:1;
1033 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034};
1035
Pavel Shilovsky226730b2013-07-05 12:00:30 +04001036struct cifs_open_parms {
1037 struct cifs_tcon *tcon;
1038 struct cifs_sb_info *cifs_sb;
1039 int disposition;
1040 int desired_access;
1041 int create_options;
1042 const char *path;
1043 struct cifs_fid *fid;
Pavel Shilovsky9cbc0b72013-07-09 18:40:58 +04001044 bool reconnect:1;
Pavel Shilovsky226730b2013-07-05 12:00:30 +04001045};
1046
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001047struct cifs_fid {
1048 __u16 netfid;
Pavel Shilovskyf0df7372012-09-18 16:20:26 -07001049#ifdef CONFIG_CIFS_SMB2
1050 __u64 persistent_fid; /* persist file id for smb2 */
1051 __u64 volatile_fid; /* volatile file id for smb2 */
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -07001052 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
Steve Frenchb56eae42015-11-03 09:26:27 -06001053 __u8 create_guid[16];
Pavel Shilovskyf0df7372012-09-18 16:20:26 -07001054#endif
Pavel Shilovsky233839b2012-09-19 06:22:45 -07001055 struct cifs_pending_open *pending_open;
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001056 unsigned int epoch;
1057 bool purge_cache;
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001058};
1059
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001060struct cifs_fid_locks {
1061 struct list_head llist;
1062 struct cifsFileInfo *cfile; /* fid that owns locks */
1063 struct list_head locks; /* locks held by fid above */
1064};
1065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066struct cifsFileInfo {
Steve French3afca262016-09-22 18:58:16 -05001067 /* following two lists are protected by tcon->open_file_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 struct list_head tlist; /* pointer to next fid owned by tcon */
1069 struct list_head flist; /* next fid (file instance) for this inode */
Steve French3afca262016-09-22 18:58:16 -05001070 /* lock list below protected by cifsi->lock_sem */
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001071 struct cifs_fid_locks *llist; /* brlocks held by this fid */
Eric W. Biedermanfef59fd2013-02-06 02:23:02 -08001072 kuid_t uid; /* allows finding which FileInfo structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 __u32 pid; /* process id who opened file */
Pavel Shilovsky4b4de762012-09-18 16:20:26 -07001074 struct cifs_fid fid; /* file id from remote */
Pavel Shilovskyf2cca6a2016-10-07 17:26:36 -07001075 struct list_head rlist; /* reconnect list */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 /* BB add lock scope info here if needed */ ;
1077 /* lock scope id (0 if none) */
Jeff Laytona5e18bc2010-10-11 15:07:18 -04001078 struct dentry *dentry;
Jeff Layton13cfb732010-09-29 19:51:11 -04001079 struct tcon_link *tlink;
Steve French3afca262016-09-22 18:58:16 -05001080 unsigned int f_flags;
Steve French4b18f2a2008-04-29 00:06:05 +00001081 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -04001082 bool oplock_break_cancelled:1;
Steve French3afca262016-09-22 18:58:16 -05001083 int count;
1084 spinlock_t file_info_lock; /* protects four flag/count fields above */
Steve Frencha6ce4932009-04-09 01:14:32 +00001085 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 struct cifs_search_info srch_inf;
Tejun Heo9b646972010-07-20 22:09:02 +02001087 struct work_struct oplock_break; /* work for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088};
1089
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001090struct cifs_io_parms {
1091 __u16 netfid;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001092#ifdef CONFIG_CIFS_SMB2
1093 __u64 persistent_fid; /* persist file id for smb2 */
1094 __u64 volatile_fid; /* volatile file id for smb2 */
1095#endif
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001096 __u32 pid;
1097 __u64 offset;
1098 unsigned int length;
Steve French96daf2b2011-05-27 04:34:02 +00001099 struct cifs_tcon *tcon;
Pavel Shilovskyfa2989f2011-05-26 10:01:59 +04001100};
1101
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001102struct cifs_readdata;
1103
1104/* asynchronous read support */
1105struct cifs_readdata {
1106 struct kref refcount;
1107 struct list_head list;
1108 struct completion done;
1109 struct cifsFileInfo *cfile;
1110 struct address_space *mapping;
1111 __u64 offset;
1112 unsigned int bytes;
Pavel Shilovsky34a54d62014-07-10 10:03:29 +04001113 unsigned int got_bytes;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001114 pid_t pid;
1115 int result;
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001116 struct work_struct work;
Jeff Layton8321fec2012-09-19 06:22:32 -07001117 int (*read_into_pages)(struct TCP_Server_Info *server,
1118 struct cifs_readdata *rdata,
1119 unsigned int len);
Jeff Layton58195752012-09-19 06:22:34 -07001120 struct kvec iov;
Jeff Layton8321fec2012-09-19 06:22:32 -07001121 unsigned int pagesz;
1122 unsigned int tailsz;
Pavel Shilovskybed9da02014-06-25 11:28:57 +04001123 unsigned int credits;
Jeff Laytonc5fab6f2012-09-19 06:22:30 -07001124 unsigned int nr_pages;
1125 struct page *pages[];
Pavel Shilovsky09a47072012-09-18 16:20:29 -07001126};
1127
Pavel Shilovsky33319142012-09-18 16:20:29 -07001128struct cifs_writedata;
1129
1130/* asynchronous write support */
1131struct cifs_writedata {
1132 struct kref refcount;
1133 struct list_head list;
1134 struct completion done;
1135 enum writeback_sync_modes sync_mode;
1136 struct work_struct work;
1137 struct cifsFileInfo *cfile;
1138 __u64 offset;
1139 pid_t pid;
1140 unsigned int bytes;
1141 int result;
Jeff Laytoneddb0792012-09-18 16:20:35 -07001142 unsigned int pagesz;
1143 unsigned int tailsz;
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +04001144 unsigned int credits;
Pavel Shilovsky33319142012-09-18 16:20:29 -07001145 unsigned int nr_pages;
Jeff Layton26c8f0d2014-02-07 11:04:04 -05001146 struct page *pages[];
Pavel Shilovsky33319142012-09-18 16:20:29 -07001147};
1148
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001149/*
1150 * Take a reference on the file private data. Must be called with
Steve French3afca262016-09-22 18:58:16 -05001151 * cfile->file_info_lock held.
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001152 */
Jeff Layton764a1b12012-07-25 14:59:54 -04001153static inline void
1154cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001155{
Jeff Layton5f6dbc92010-10-15 15:34:06 -04001156 ++cifs_file->count;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001157}
1158
Jeff Layton764a1b12012-07-25 14:59:54 -04001159struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
Jeff Laytonb33879a2010-10-15 15:34:04 -04001160void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -04001161
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001162#define CIFS_CACHE_READ_FLG 1
1163#define CIFS_CACHE_HANDLE_FLG 2
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001164#define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001165#define CIFS_CACHE_WRITE_FLG 4
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001166#define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1167#define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001168
1169#define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
Pavel Shilovsky53ef1012013-09-05 16:11:28 +04001170#define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001171#define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1172
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173/*
1174 * One of these for each file inode
1175 */
1176
1177struct cifsInodeInfo {
Pavel Shilovskyd59dad22011-09-22 09:53:59 +04001178 bool can_cache_brlcks;
Pavel Shilovskyf45d3412012-09-19 06:22:43 -07001179 struct list_head llist; /* locks helb by this inode */
Pavel Shilovsky1b4b55a2012-09-19 06:22:44 -07001180 struct rw_semaphore lock_sem; /* protect the fields above */
Steve Frenchd38d8c72007-06-28 19:44:13 +00001181 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 struct list_head openFileList;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Pavel Shilovsky18cceb62013-09-05 13:01:06 +04001184 unsigned int oplock; /* oplock/lease level we have */
Pavel Shilovsky42873b02013-09-05 21:30:16 +04001185 unsigned int epoch; /* used to track lease state changes */
Sachin Prabhuc11f1df2014-03-11 16:11:47 +00001186#define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */
1187#define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */
1188#define CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2 (2) /* Downgrade oplock to L2 */
Jeff Laytonaff8d5c2014-04-30 09:31:45 -04001189#define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */
1190#define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */
Jeff Layton4f73c7d2014-04-30 09:31:47 -04001191#define CIFS_INO_LOCK (5) /* lock bit for synchronization */
Jeff Laytonaff8d5c2014-04-30 09:31:45 -04001192 unsigned long flags;
Sachin Prabhuc11f1df2014-03-11 16:11:47 +00001193 spinlock_t writers_lock;
1194 unsigned int writers; /* Number of writers on this inode */
Jeff Laytonaae62fd2011-01-20 13:36:50 -05001195 unsigned long time; /* jiffies of last update of inode */
Jeff Layton597b0272012-03-23 14:40:56 -04001196 u64 server_eof; /* current file size on server -- protected by i_lock */
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001197 u64 uniqueid; /* server inode number */
Jeff Layton20054bd2011-01-07 11:30:27 -05001198 u64 createtime; /* creation time on server */
Pavel Shilovskyb8c32db2012-09-19 06:22:44 -07001199#ifdef CONFIG_CIFS_SMB2
1200 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1201#endif
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +05301202#ifdef CONFIG_CIFS_FSCACHE
1203 struct fscache_cookie *fscache;
1204#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 struct inode vfs_inode;
1206};
1207
1208static inline struct cifsInodeInfo *
1209CIFS_I(struct inode *inode)
1210{
1211 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1212}
1213
1214static inline struct cifs_sb_info *
1215CIFS_SB(struct super_block *sb)
1216{
1217 return sb->s_fs_info;
1218}
1219
Al Viro7119e222014-10-22 00:25:12 -04001220static inline struct cifs_sb_info *
1221CIFS_FILE_SB(struct file *file)
1222{
1223 return CIFS_SB(file_inode(file)->i_sb);
1224}
1225
Steve Frenchab2f2182005-09-15 20:44:50 -07001226static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -07001227{
1228 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1229 return '/';
1230 else
1231 return '\\';
1232}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
Steve Frenchf87d39d2011-05-27 03:50:55 +00001234static inline void
1235convert_delimiter(char *path, char delim)
1236{
Steve French1cc9bd62012-11-29 18:07:51 -06001237 char old_delim, *pos;
Steve Frenchf87d39d2011-05-27 03:50:55 +00001238
1239 if (delim == '/')
1240 old_delim = '\\';
1241 else
1242 old_delim = '/';
1243
Steve French1cc9bd62012-11-29 18:07:51 -06001244 pos = path;
1245 while ((pos = strchr(pos, old_delim)))
1246 *pos = delim;
Steve Frenchf87d39d2011-05-27 03:50:55 +00001247}
1248
Steve Frencha4544342005-08-24 13:59:35 -07001249#ifdef CONFIG_CIFS_STATS
1250#define cifs_stats_inc atomic_inc
1251
Steve French96daf2b2011-05-27 04:34:02 +00001252static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
Steve Frencha4544342005-08-24 13:59:35 -07001253 unsigned int bytes)
1254{
1255 if (bytes) {
1256 spin_lock(&tcon->stat_lock);
1257 tcon->bytes_written += bytes;
1258 spin_unlock(&tcon->stat_lock);
1259 }
1260}
1261
Steve French96daf2b2011-05-27 04:34:02 +00001262static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
Steve Frencha4544342005-08-24 13:59:35 -07001263 unsigned int bytes)
1264{
1265 spin_lock(&tcon->stat_lock);
1266 tcon->bytes_read += bytes;
1267 spin_unlock(&tcon->stat_lock);
1268}
1269#else
1270
Steve Frenchd38d8c72007-06-28 19:44:13 +00001271#define cifs_stats_inc(field) do {} while (0)
1272#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1273#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
Steve Frencha4544342005-08-24 13:59:35 -07001274
1275#endif
1276
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001277
1278/*
Jeff Layton44d22d82011-10-19 15:29:49 -04001279 * This is the prototype for the mid receive function. This function is for
1280 * receiving the rest of the SMB frame, starting with the WordCount (which is
1281 * just after the MID in struct smb_hdr). Note:
1282 *
1283 * - This will be called by cifsd, with no locks held.
1284 * - The mid will still be on the pending_mid_q.
1285 * - mid->resp_buf will point to the current buffer.
1286 *
1287 * Returns zero on a successful receive, or an error. The receive state in
1288 * the TCP_Server_Info will also be updated.
1289 */
1290typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1291 struct mid_q_entry *mid);
1292
1293/*
1294 * This is the prototype for the mid callback function. This is called once the
1295 * mid has been received off of the socket. When creating one, take special
1296 * care to avoid deadlocks. Things to bear in mind:
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001297 *
Jeff Layton3c1105d2011-05-22 07:09:13 -04001298 * - it will be called by cifsd, with no locks held
1299 * - the mid will be removed from any lists
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001300 */
1301typedef void (mid_callback_t)(struct mid_q_entry *mid);
1302
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303/* one of these for every pending CIFS request to the server */
1304struct mid_q_entry {
1305 struct list_head qhead; /* mids waiting on reply from this server */
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +04001306 struct TCP_Server_Info *server; /* server corresponding to this mid */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001307 __u64 mid; /* multiplex id */
1308 __u32 pid; /* process id */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -07001310 unsigned long when_alloc; /* when mid was created */
1311#ifdef CONFIG_CIFS_STATS2
1312 unsigned long when_sent; /* time when smb send finished */
1313 unsigned long when_received; /* when demux complete (taken off wire) */
1314#endif
Jeff Layton44d22d82011-10-19 15:29:49 -04001315 mid_receive_t *receive; /* call receive callback */
Jeff Layton2b84a36c2011-01-11 07:24:21 -05001316 mid_callback_t *callback; /* call completion callback */
1317 void *callback_data; /* general purpose pointer for callback */
Pavel Shilovskyd4e48542012-03-23 14:28:02 -04001318 void *resp_buf; /* pointer to received SMB header */
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001319 int mid_state; /* wish this were enum but can not pass to wait_event */
Sachin Prabhud8fd99d2017-03-03 15:41:38 -08001320 unsigned int mid_flags;
Pavel Shilovsky7c9421e2012-03-23 14:28:03 -04001321 __le16 command; /* smb command code */
1322 bool large_buf:1; /* if valid response, is pointer to large buf */
Steve French4b18f2a2008-04-29 00:06:05 +00001323 bool multiRsp:1; /* multiple trans2 responses for one request */
1324 bool multiEnd:1; /* both received */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325};
1326
Sachin Prabhud8fd99d2017-03-03 15:41:38 -08001327struct close_cancelled_open {
1328 struct cifs_fid fid;
1329 struct cifs_tcon *tcon;
1330 struct work_struct work;
1331};
1332
Steve French789e6662011-08-09 18:44:44 +00001333/* Make code in transport.c a little cleaner by moving
1334 update of optional stats into function below */
1335#ifdef CONFIG_CIFS_STATS2
1336
1337static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1338{
1339 atomic_inc(&server->in_send);
1340}
1341
1342static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1343{
1344 atomic_dec(&server->in_send);
1345}
1346
1347static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1348{
1349 atomic_inc(&server->num_waiters);
1350}
1351
1352static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1353{
1354 atomic_dec(&server->num_waiters);
1355}
1356
1357static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1358{
1359 mid->when_sent = jiffies;
1360}
1361#else
1362static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1363{
1364}
1365static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1366{
1367}
1368
1369static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1370{
1371}
1372
1373static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1374{
1375}
1376
1377static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1378{
1379}
1380#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381
Steve Frenchff5dbd92005-08-24 17:10:36 -07001382/* for pending dnotify requests */
1383struct dir_notify_req {
Steve French13cd4b72010-10-07 18:46:32 +00001384 struct list_head lhead;
1385 __le16 Pid;
1386 __le16 PidHigh;
1387 __u16 Mid;
1388 __u16 Tid;
1389 __u16 Uid;
1390 __u16 netfid;
1391 __u32 filter; /* CompletionFilter (for multishot) */
1392 int multishot;
1393 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -07001394};
1395
Steve French366781c2008-01-25 10:12:41 +00001396struct dfs_info3_param {
1397 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +00001398 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +00001399 int server_type;
1400 int ref_flag;
1401 char *path_name;
1402 char *node_name;
1403};
1404
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001405/*
1406 * common struct for holding inode info when searching for or updating an
1407 * inode with new info
1408 */
1409
1410#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -04001411#define CIFS_FATTR_DELETE_PENDING 0x2
1412#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -04001413#define CIFS_FATTR_INO_COLLISION 0x8
Jim McDonough74d290d2013-09-21 10:36:10 -05001414#define CIFS_FATTR_UNKNOWN_NLINK 0x10
Steve Frenchc4bc6582018-03-31 18:13:38 -05001415#define CIFS_FATTR_FAKE_ROOT_INO 0x20
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001416
1417struct cifs_fattr {
1418 u32 cf_flags;
1419 u32 cf_cifsattrs;
1420 u64 cf_uniqueid;
1421 u64 cf_eof;
1422 u64 cf_bytes;
Jeff Layton20054bd2011-01-07 11:30:27 -05001423 u64 cf_createtime;
Eric W. Biederman4a2c8cf2013-02-06 01:53:25 -08001424 kuid_t cf_uid;
1425 kgid_t cf_gid;
Jeff Laytoncc0bad72009-06-25 00:56:52 -04001426 umode_t cf_mode;
1427 dev_t cf_rdev;
1428 unsigned int cf_nlink;
1429 unsigned int cf_dtype;
1430 struct timespec cf_atime;
1431 struct timespec cf_mtime;
1432 struct timespec cf_ctime;
1433};
1434
Steve French366781c2008-01-25 10:12:41 +00001435static inline void free_dfs_info_param(struct dfs_info3_param *param)
1436{
1437 if (param) {
1438 kfree(param->path_name);
1439 kfree(param->node_name);
1440 kfree(param);
1441 }
1442}
1443
1444static inline void free_dfs_info_array(struct dfs_info3_param *param,
1445 int number_of_items)
1446{
1447 int i;
1448 if ((number_of_items == 0) || (param == NULL))
1449 return;
1450 for (i = 0; i < number_of_items; i++) {
1451 kfree(param[i].path_name);
1452 kfree(param[i].node_name);
1453 }
1454 kfree(param);
1455}
1456
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457#define MID_FREE 0
1458#define MID_REQUEST_ALLOCATED 1
1459#define MID_REQUEST_SUBMITTED 2
1460#define MID_RESPONSE_RECEIVED 4
1461#define MID_RETRY_NEEDED 8 /* session closed while this request out */
Jeff Layton71823ba2011-02-10 08:03:50 -05001462#define MID_RESPONSE_MALFORMED 0x10
Jeff Layton3c1105d2011-05-22 07:09:13 -04001463#define MID_SHUTDOWN 0x20
Steve Frenchec637e32005-12-12 20:53:18 -08001464
Sachin Prabhud8fd99d2017-03-03 15:41:38 -08001465/* Flags */
1466#define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */
1467
Steve Frenchec637e32005-12-12 20:53:18 -08001468/* Types of response buffer returned from SendReceive2 */
1469#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1470#define CIFS_SMALL_BUFFER 1
1471#define CIFS_LARGE_BUFFER 2
1472#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Steve French133672e2007-11-13 22:41:37 +00001474/* Type of Request to SendReceive2 */
Jeff Layton77499812011-01-11 07:24:23 -05001475#define CIFS_BLOCKING_OP 1 /* operation can block */
1476#define CIFS_ASYNC_OP 2 /* do not wait for response */
1477#define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
Steve French133672e2007-11-13 22:41:37 +00001478#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1479#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1480#define CIFS_NO_RESP 0x040 /* no response buffer required */
1481
Pavel Shilovskya891f0f2012-05-23 16:14:34 +04001482/* Type of request operation */
1483#define CIFS_ECHO_OP 0x080 /* echo request */
1484#define CIFS_OBREAK_OP 0x0100 /* oplock break request */
Pavel Shilovskyec2e4522011-12-27 16:12:43 +04001485#define CIFS_NEG_OP 0x0200 /* negotiate request */
1486#define CIFS_OP_MASK 0x0380 /* mask request type */
Pavel Shilovskycb7e9ea2014-06-05 19:03:27 +04001487#define CIFS_HAS_CREDITS 0x0400 /* already has credits */
Pavel Shilovskya891f0f2012-05-23 16:14:34 +04001488
Steve French39798772006-05-31 22:40:51 +00001489/* Security Flags: indicate type of session setup needed */
1490#define CIFSSEC_MAY_SIGN 0x00001
1491#define CIFSSEC_MAY_NTLM 0x00002
1492#define CIFSSEC_MAY_NTLMV2 0x00004
1493#define CIFSSEC_MAY_KRB5 0x00008
1494#ifdef CONFIG_CIFS_WEAK_PW_HASH
1495#define CIFSSEC_MAY_LANMAN 0x00010
1496#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +00001497#else
1498#define CIFSSEC_MAY_LANMAN 0
1499#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +00001500#endif /* weak passwords */
1501#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +00001502#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +00001503
Steve French39798772006-05-31 22:40:51 +00001504#define CIFSSEC_MUST_SIGN 0x01001
1505/* note that only one of the following can be set so the
1506result of setting MUST flags more than once will be to
1507require use of the stronger protocol */
1508#define CIFSSEC_MUST_NTLM 0x02002
1509#define CIFSSEC_MUST_NTLMV2 0x04004
1510#define CIFSSEC_MUST_KRB5 0x08008
1511#ifdef CONFIG_CIFS_WEAK_PW_HASH
1512#define CIFSSEC_MUST_LANMAN 0x10010
1513#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001514#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -04001515#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +00001516#else
Chuck Ebbert20d17522009-09-15 01:53:21 -04001517#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +00001518#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001519#else /* do not allow weak pw hash */
Steve French88a44122012-01-18 17:13:47 -06001520#define CIFSSEC_MUST_LANMAN 0
1521#define CIFSSEC_MUST_PLNTXT 0
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001522#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +00001523#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +00001524#else
Steve Frenchac683922009-05-06 04:16:04 +00001525#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +00001526#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +00001527#endif /* WEAK_PW_HASH */
1528#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +00001529#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +00001530
Jeff Layton896a8fc2013-05-26 07:01:01 -04001531#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +00001532#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +00001533#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 -07001534/*
1535 *****************************************************************
1536 * All constants go here
1537 *****************************************************************
1538 */
1539
1540#define UID_HASH (16)
1541
1542/*
1543 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1544 * following to be declared.
1545 */
1546
1547/****************************************************************************
1548 * Locking notes. All updates to global variables and lists should be
1549 * protected by spinlocks or semaphores.
1550 *
1551 * Spinlocks
1552 * ---------
1553 * GlobalMid_Lock protects:
1554 * list operations on pending_mid_q and oplockQ
1555 * updates to XID counters, multiplex id and SMB sequence numbers
Steve French3afca262016-09-22 18:58:16 -05001556 * tcp_ses_lock protects:
1557 * list operations on tcp and SMB session lists
1558 * tcon->open_file_lock protects the list of open files hanging off the tcon
1559 * cfile->file_info_lock protects counters and fields in cifs file struct
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 * f_owner.lock protects certain per file struct operations
1561 * mapping->page_lock protects certain per page operations
1562 *
1563 * Semaphores
1564 * ----------
1565 * sesSem operations on smb session
1566 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +00001567 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 *
1569 ****************************************************************************/
1570
1571#ifdef DECLARE_GLOBALS_HERE
1572#define GLOBAL_EXTERN
1573#else
1574#define GLOBAL_EXTERN extern
1575#endif
1576
Jeff Laytone7ddee92008-11-14 13:44:38 -05001577/*
1578 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +00001579 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -05001580 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +00001581 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -05001582 * by iterating over cifs_tcp_ses_list
1583 */
1584GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1585
Jeff Laytonf1987b42008-11-15 11:12:47 -05001586/*
1587 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1588 * tcp session, and the list of tcon's per smb session. It also protects
1589 * the reference counters for the server, smb session, and tcon. Finally,
1590 * changes to the tcon->tidStatus should be done while holding this lock.
Steve French3afca262016-09-22 18:58:16 -05001591 * generally the locks should be taken in order tcp_ses_lock before
1592 * tcon->open_file_lock and that before file->file_info_lock since the
1593 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file
Jeff Laytonf1987b42008-11-15 11:12:47 -05001594 */
Suresh Jayaraman3f9bcca2010-10-18 23:29:37 +05301595GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +00001596
Steve French0eff0e22011-02-24 05:39:23 +00001597#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
Steve French99ee4db2007-02-27 05:35:17 +00001598/* Outstanding dir notify requests */
1599GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1600/* DirNotify response queue */
1601GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve French0eff0e22011-02-24 05:39:23 +00001602#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
Steve Frenchff5dbd92005-08-24 17:10:36 -07001603
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604/*
1605 * Global transaction id (XID) information
1606 */
1607GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +00001608GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +00001610GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1611 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612/*
1613 * Global counters, updated atomically
1614 */
1615GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1616GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1617GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1618GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1619GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1620
Steve Frenchaaa9bbe2008-05-23 17:38:32 +00001621/* Various Debug counters */
Steve French4498eed52005-12-03 13:58:57 -08001622GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1623#ifdef CONFIG_CIFS_STATS2
1624GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1625GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1626#endif
1627GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628GLOBAL_EXTERN atomic_t midCount;
1629
1630/* Misc globals */
Jeff Layton5e500ed2012-05-16 07:13:17 -04001631GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
Kees Cook14042972016-03-17 14:22:54 -07001632GLOBAL_EXTERN bool lookupCacheEnabled;
Jeff Layton04912d62010-04-24 07:57:45 -04001633GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 with more secure ntlmssp2 challenge/resp */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
Kees Cook14042972016-03-17 14:22:54 -07001636GLOBAL_EXTERN bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1638GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1639GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1640GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1641
Shirish Pargaonkar21fed0d2011-08-09 14:30:48 -05001642#ifdef CONFIG_CIFS_ACL
Shirish Pargaonkar4d79dba2011-04-27 23:34:35 -05001643GLOBAL_EXTERN struct rb_root uidtree;
1644GLOBAL_EXTERN struct rb_root gidtree;
1645GLOBAL_EXTERN spinlock_t siduidlock;
1646GLOBAL_EXTERN spinlock_t sidgidlock;
Shirish Pargaonkar21fed0d2011-08-09 14:30:48 -05001647GLOBAL_EXTERN struct rb_root siduidtree;
1648GLOBAL_EXTERN struct rb_root sidgidtree;
1649GLOBAL_EXTERN spinlock_t uidsidlock;
1650GLOBAL_EXTERN spinlock_t gidsidlock;
1651#endif /* CONFIG_CIFS_ACL */
Shirish Pargaonkar4d79dba2011-04-27 23:34:35 -05001652
Tejun Heo9b646972010-07-20 22:09:02 +02001653void cifs_oplock_break(struct work_struct *work);
Linus Torvalds3b7433b2010-08-07 12:42:58 -07001654
Jeff Layton3bc303c2009-09-21 06:47:50 -04001655extern const struct slow_work_ops cifs_oplock_break_ops;
Jeff Laytonda472fc2012-03-23 14:40:53 -04001656extern struct workqueue_struct *cifsiod_wq;
Rabin Vincentf13d96b2017-05-03 17:54:01 +02001657extern struct workqueue_struct *cifsoplockd_wq;
Jeff Layton3d224622016-05-24 06:27:44 -04001658extern __u32 cifs_lock_secret;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +05301659
Pavel Shilovsky2dc7e1c2011-12-26 22:53:34 +04001660extern mempool_t *cifs_mid_poolp;
1661
Jeff Layton23db65f2012-05-15 12:20:51 -04001662/* Operations for different SMB versions */
1663#define SMB1_VERSION_STRING "1.0"
1664extern struct smb_version_operations smb1_operations;
1665extern struct smb_version_values smb1_values;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001666#define SMB20_VERSION_STRING "2.0"
Pavel Shilovsky53ef1012013-09-05 16:11:28 +04001667extern struct smb_version_operations smb20_operations;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001668extern struct smb_version_values smb20_values;
Steve French1080ef72011-02-24 18:07:19 +00001669#define SMB21_VERSION_STRING "2.1"
1670extern struct smb_version_operations smb21_operations;
1671extern struct smb_version_values smb21_values;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001672#define SMB30_VERSION_STRING "3.0"
Steve French38107d42012-12-08 22:08:06 -06001673extern struct smb_version_operations smb30_operations;
Steve Frenche4aa25e2012-10-01 12:26:22 -05001674extern struct smb_version_values smb30_values;
Steve French20b6d8b2013-06-12 22:48:41 -05001675#define SMB302_VERSION_STRING "3.02"
1676/*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1677extern struct smb_version_values smb302_values;
Steve French5f7fbf72014-12-17 22:52:58 -06001678#define SMB311_VERSION_STRING "3.1.1"
Steve Frenchaab18932015-06-23 23:37:11 -05001679#define ALT_SMB311_VERSION_STRING "3.11"
1680extern struct smb_version_operations smb311_operations;
Steve French5f7fbf72014-12-17 22:52:58 -06001681extern struct smb_version_values smb311_values;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +05301682#endif /* _CIFS_GLOB_H */