]>
Commit | Line | Data |
---|---|---|
929be906 | 1 | /* SPDX-License-Identifier: LGPL-2.1 */ |
1da177e4 | 2 | /* |
1da177e4 | 3 | * |
366781c1 | 4 | * Copyright (C) International Business Machines Corp., 2002,2008 |
1da177e4 | 5 | * Author(s): Steve French (sfrench@us.ibm.com) |
7ee1af76 | 6 | * Jeremy Allison (jra@samba.org) |
1da177e4 | 7 | * |
1da177e4 | 8 | */ |
abd2e44d SJ |
9 | #ifndef _CIFS_GLOB_H |
10 | #define _CIFS_GLOB_H | |
11 | ||
1da177e4 LT |
12 | #include <linux/in.h> |
13 | #include <linux/in6.h> | |
b438fcf1 | 14 | #include <linux/inet.h> |
5a0e3ad6 | 15 | #include <linux/slab.h> |
2dc7e1c0 | 16 | #include <linux/mempool.h> |
9b646972 | 17 | #include <linux/workqueue.h> |
1da177e4 | 18 | #include "cifs_fs_sb.h" |
442aa310 | 19 | #include "cifsacl.h" |
d2b91521 SP |
20 | #include <crypto/internal/hash.h> |
21 | #include <linux/scatterlist.h> | |
8c3a2b4c | 22 | #include <uapi/linux/cifs/cifs_mount.h> |
0d35e382 | 23 | #include "../smbfs_common/smb2pdu.h" |
d60622eb | 24 | #include "smb2pdu.h" |
d2b91521 | 25 | |
76ec5e33 PS |
26 | #define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */ |
27 | ||
8d8b26e5 | 28 | #define SMB_PATH_MAX 260 |
e2292430 AA |
29 | #define CIFS_PORT 445 |
30 | #define RFC1001_PORT 139 | |
31 | ||
1da177e4 LT |
32 | /* |
33 | * The sizes of various internal tables and strings | |
34 | */ | |
35 | #define MAX_UID_INFO 16 | |
36 | #define MAX_SES_INFO 2 | |
37 | #define MAX_TCON_INFO 4 | |
38 | ||
cdf1246f | 39 | #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1) |
1da177e4 LT |
40 | |
41 | #define CIFS_MIN_RCV_POOL 4 | |
42 | ||
2c0c2a08 | 43 | #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */ |
6d20e840 SJ |
44 | /* |
45 | * default attribute cache timeout (jiffies) | |
46 | */ | |
47 | #define CIFS_DEF_ACTIMEO (1 * HZ) | |
48 | ||
49 | /* | |
50 | * max attribute cache timeout (jiffies) - 2^30 | |
51 | */ | |
52 | #define CIFS_MAX_ACTIMEO (1 << 30) | |
53 | ||
ca567eb2 SF |
54 | /* |
55 | * Max persistent and resilient handle timeout (milliseconds). | |
56 | * Windows durable max was 960000 (16 minutes) | |
57 | */ | |
58 | #define SMB3_MAX_HANDLE_TIMEOUT 960000 | |
59 | ||
1da177e4 LT |
60 | /* |
61 | * MAX_REQ is the maximum number of requests that WE will send | |
10b9b98e | 62 | * on one socket concurrently. |
1da177e4 | 63 | */ |
10b9b98e | 64 | #define CIFS_MAX_REQ 32767 |
1da177e4 | 65 | |
8ecaf67a JL |
66 | #define RFC1001_NAME_LEN 15 |
67 | #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1) | |
68 | ||
b327a717 AA |
69 | /* maximum length of ip addr as a string (including ipv6 and sctp) */ |
70 | #define SERVER_NAME_LENGTH 80 | |
1da177e4 LT |
71 | #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1) |
72 | ||
adfeb3e0 SF |
73 | /* 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 | |
9094fad1 | 77 | |
506c1da4 SP |
78 | /* dns resolution interval in seconds */ |
79 | #define SMB_DNS_RESOLVE_INTERVAL_DEFAULT 600 | |
80 | ||
b24df3e3 RS |
81 | /* maximum number of PDUs in one compound */ |
82 | #define MAX_COMPOUND 5 | |
83 | ||
141891f4 SF |
84 | /* |
85 | * Default number of credits to keep available for SMB3. | |
86 | * This value is chosen somewhat arbitrarily. The Windows client | |
87 | * defaults to 128 credits, the Windows server allows clients up to | |
88 | * 512 credits (or 8K for later versions), and the NetApp server | |
89 | * does not limit clients at all. Choose a high enough default value | |
90 | * such that the client shouldn't limit performance, but allow mount | |
91 | * to override (until you approach 64K, where we limit credits to 65000 | |
92 | * to reduce possibility of seeing more server credit overflow bugs. | |
93 | */ | |
94 | #define SMB2_MAX_CREDITS_AVAILABLE 32000 | |
95 | ||
1da177e4 LT |
96 | #include "cifspdu.h" |
97 | ||
1da177e4 LT |
98 | #ifndef XATTR_DOS_ATTRIB |
99 | #define XATTR_DOS_ATTRIB "user.DOSATTRIB" | |
100 | #endif | |
101 | ||
1da177e4 LT |
102 | /* |
103 | * CIFS vfs client Status information (based on what we know.) | |
104 | */ | |
105 | ||
6c0f6218 | 106 | /* associated with each tcp and smb session */ |
1da177e4 LT |
107 | enum statusEnum { |
108 | CifsNew = 0, | |
109 | CifsGood, | |
110 | CifsExiting, | |
fd88ce93 SF |
111 | CifsNeedReconnect, |
112 | CifsNeedNegotiate | |
1da177e4 LT |
113 | }; |
114 | ||
115 | enum securityEnum { | |
515d82ff | 116 | Unspecified = 0, /* not specified */ |
1da177e4 | 117 | NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */ |
ac683924 | 118 | RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */ |
c16fefa5 | 119 | Kerberos, /* Kerberos via SPNEGO */ |
1da177e4 LT |
120 | }; |
121 | ||
5f98ca9a | 122 | struct session_key { |
b609f06a | 123 | unsigned int len; |
21e73393 | 124 | char *response; |
b609f06a SF |
125 | }; |
126 | ||
d2b91521 SP |
127 | /* crypto security descriptor definition */ |
128 | struct sdesc { | |
129 | struct shash_desc shash; | |
130 | char ctx[]; | |
131 | }; | |
132 | ||
f7c5445a | 133 | /* crypto hashing related structure/fields, not specific to a sec mech */ |
d2b91521 SP |
134 | struct cifs_secmech { |
135 | struct crypto_shash *hmacmd5; /* hmac-md5 hash function */ | |
136 | struct crypto_shash *md5; /* md5 hash function */ | |
3c1bf7e4 | 137 | struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */ |
429b46f4 | 138 | struct crypto_shash *cmacaes; /* block-cipher based MAC function */ |
5fcd7f3f | 139 | struct crypto_shash *sha512; /* sha512 hash function */ |
d2b91521 SP |
140 | struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */ |
141 | struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */ | |
3c1bf7e4 | 142 | struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */ |
429b46f4 | 143 | struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */ |
5fcd7f3f | 144 | struct sdesc *sdescsha512; /* ctxt to generate smb3.11 signing key */ |
026e93dc PS |
145 | struct crypto_aead *ccmaesencrypt; /* smb3 encryption aead */ |
146 | struct crypto_aead *ccmaesdecrypt; /* smb3 decryption aead */ | |
d2b91521 SP |
147 | }; |
148 | ||
d3686d54 | 149 | /* per smb session structure/fields */ |
d2b91521 | 150 | struct ntlmssp_auth { |
5c234aa5 | 151 | bool sesskey_per_smbsess; /* whether session key is per smb session */ |
d2b91521 SP |
152 | __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */ |
153 | __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */ | |
154 | unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */ | |
d3686d54 | 155 | char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */ |
d2b91521 SP |
156 | }; |
157 | ||
442aa310 SF |
158 | struct cifs_cred { |
159 | int uid; | |
160 | int gid; | |
161 | int mode; | |
162 | int cecount; | |
163 | struct cifs_sid osid; | |
164 | struct cifs_sid gsid; | |
165 | struct cifs_ntace *ntaces; | |
166 | struct cifs_ace *aces; | |
167 | }; | |
168 | ||
1da177e4 LT |
169 | /* |
170 | ***************************************************************** | |
171 | * Except the CIFS PDUs themselves all the | |
172 | * globally interesting structs should go here | |
173 | ***************************************************************** | |
174 | */ | |
175 | ||
bf5ea0e2 JL |
176 | /* |
177 | * A smb_rqst represents a complete request to be issued to a server. It's | |
178 | * formed by a kvec array, followed by an array of pages. Page data is assumed | |
179 | * to start at the beginning of the first page. | |
180 | */ | |
181 | struct smb_rqst { | |
182 | struct kvec *rq_iov; /* array of kvecs */ | |
183 | unsigned int rq_nvec; /* number of kvecs in array */ | |
184 | struct page **rq_pages; /* pointer to array of page ptrs */ | |
57a929a6 | 185 | unsigned int rq_offset; /* the offset to the 1st page */ |
bf5ea0e2 JL |
186 | unsigned int rq_npages; /* number pages in array */ |
187 | unsigned int rq_pagesz; /* page size to use */ | |
188 | unsigned int rq_tailsz; /* length of last page */ | |
189 | }; | |
190 | ||
121b046a JL |
191 | struct mid_q_entry; |
192 | struct TCP_Server_Info; | |
55157dfb | 193 | struct cifsFileInfo; |
082d0642 | 194 | struct cifs_ses; |
2e6e02ab | 195 | struct cifs_tcon; |
b669f33c | 196 | struct dfs_info3_param; |
1208ef1f | 197 | struct cifs_fattr; |
3fa1c6d1 | 198 | struct smb3_fs_context; |
fb1214e4 | 199 | struct cifs_fid; |
fc9c5966 | 200 | struct cifs_readdata; |
c9de5c80 | 201 | struct cifs_writedata; |
f9c6e234 | 202 | struct cifs_io_parms; |
92fc65a7 | 203 | struct cifs_search_info; |
95a3f2f3 | 204 | struct cifsInodeInfo; |
226730b4 | 205 | struct cifs_open_parms; |
335b7b62 | 206 | struct cifs_credits; |
121b046a | 207 | |
23db65f5 | 208 | struct smb_version_operations { |
fb2036d8 | 209 | int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *, |
121b046a | 210 | struct mid_q_entry *); |
55157dfb | 211 | bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *); |
082d0642 | 212 | /* setup request: allocate mid, sign message */ |
fec344e3 | 213 | struct mid_q_entry *(*setup_request)(struct cifs_ses *, |
f780bd3f AA |
214 | struct TCP_Server_Info *, |
215 | struct smb_rqst *); | |
45740847 | 216 | /* setup async request: allocate mid, sign message */ |
fec344e3 JL |
217 | struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *, |
218 | struct smb_rqst *); | |
082d0642 PS |
219 | /* check response: verify signature, map error */ |
220 | int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *, | |
221 | bool); | |
335b7b62 PS |
222 | void (*add_credits)(struct TCP_Server_Info *server, |
223 | const struct cifs_credits *credits, | |
224 | const int optype); | |
45275789 | 225 | void (*set_credits)(struct TCP_Server_Info *, const int); |
a891f0f8 PS |
226 | int * (*get_credits_field)(struct TCP_Server_Info *, const int); |
227 | unsigned int (*get_credits)(struct mid_q_entry *); | |
88257360 | 228 | __u64 (*get_next_mid)(struct TCP_Server_Info *); |
c781af7e PS |
229 | void (*revert_current_mid)(struct TCP_Server_Info *server, |
230 | const unsigned int val); | |
eb378711 PS |
231 | /* data offset from read response message */ |
232 | unsigned int (*read_data_offset)(char *); | |
74dcf418 LL |
233 | /* |
234 | * Data length from read response message | |
235 | * When in_remaining is true, the returned data length is in | |
236 | * message field DataRemaining for out-of-band data read (e.g through | |
237 | * Memory Registration RDMA write in SMBD). | |
238 | * Otherwise, the returned data length is in message field DataLength. | |
239 | */ | |
240 | unsigned int (*read_data_length)(char *, bool in_remaining); | |
eb378711 PS |
241 | /* map smb to linux error */ |
242 | int (*map_error)(char *, bool); | |
8aa26f3e PS |
243 | /* find mid corresponding to the response message */ |
244 | struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *); | |
14547f7d | 245 | void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info); |
44c58186 PS |
246 | void (*clear_stats)(struct cifs_tcon *); |
247 | void (*print_stats)(struct seq_file *m, struct cifs_tcon *); | |
769ee6a4 | 248 | void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *); |
8aa26f3e | 249 | /* verify the message */ |
373512ec | 250 | int (*check_message)(char *, unsigned int, struct TCP_Server_Info *); |
8aa26f3e | 251 | bool (*is_oplock_break)(char *, struct TCP_Server_Info *); |
04ad69c3 | 252 | int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *); |
9bd45408 PS |
253 | void (*downgrade_oplock)(struct TCP_Server_Info *server, |
254 | struct cifsInodeInfo *cinode, __u32 oplock, | |
255 | unsigned int epoch, bool *purge_cache); | |
316cf94a PS |
256 | /* process transaction2 response */ |
257 | bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *, | |
258 | char *, int); | |
286170aa PS |
259 | /* check if we need to negotiate */ |
260 | bool (*need_neg)(struct TCP_Server_Info *); | |
261 | /* negotiate to the server */ | |
262 | int (*negotiate)(const unsigned int, struct cifs_ses *); | |
24985c53 | 263 | /* set negotiated write size */ |
3fa1c6d1 | 264 | unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx); |
24985c53 | 265 | /* set negotiated read size */ |
3fa1c6d1 | 266 | unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx); |
58c45c58 PS |
267 | /* setup smb sessionn */ |
268 | int (*sess_setup)(const unsigned int, struct cifs_ses *, | |
269 | const struct nls_table *); | |
270 | /* close smb session */ | |
271 | int (*logoff)(const unsigned int, struct cifs_ses *); | |
2e6e02ab PS |
272 | /* connect to a server share */ |
273 | int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *, | |
274 | struct cifs_tcon *, const struct nls_table *); | |
275 | /* close tree connecion */ | |
276 | int (*tree_disconnect)(const unsigned int, struct cifs_tcon *); | |
b669f33c PS |
277 | /* get DFS referrals */ |
278 | int (*get_dfs_refer)(const unsigned int, struct cifs_ses *, | |
279 | const char *, struct dfs_info3_param **, | |
280 | unsigned int *, const struct nls_table *, int); | |
af4281dc | 281 | /* informational QFS call */ |
0f060936 AG |
282 | void (*qfs_tcon)(const unsigned int, struct cifs_tcon *, |
283 | struct cifs_sb_info *); | |
68889f26 PS |
284 | /* check if a path is accessible or not */ |
285 | int (*is_path_accessible)(const unsigned int, struct cifs_tcon *, | |
286 | struct cifs_sb_info *, const char *); | |
1208ef1f PS |
287 | /* query path data from the server */ |
288 | int (*query_path_info)(const unsigned int, struct cifs_tcon *, | |
289 | struct cifs_sb_info *, const char *, | |
eb85d94b | 290 | FILE_ALL_INFO *, bool *, bool *); |
4ad65044 PS |
291 | /* query file data from the server */ |
292 | int (*query_file_info)(const unsigned int, struct cifs_tcon *, | |
293 | struct cifs_fid *, FILE_ALL_INFO *); | |
2e4564b3 SF |
294 | /* query reparse tag from srv to determine which type of special file */ |
295 | int (*query_reparse_tag)(const unsigned int xid, struct cifs_tcon *tcon, | |
296 | struct cifs_sb_info *cifs_sb, const char *path, | |
297 | __u32 *reparse_tag); | |
1208ef1f PS |
298 | /* get server index number */ |
299 | int (*get_srv_inum)(const unsigned int, struct cifs_tcon *, | |
300 | struct cifs_sb_info *, const char *, | |
301 | u64 *uniqueid, FILE_ALL_INFO *); | |
d1433418 PS |
302 | /* set size by path */ |
303 | int (*set_path_size)(const unsigned int, struct cifs_tcon *, | |
304 | const char *, __u64, struct cifs_sb_info *, bool); | |
305 | /* set size by file handle */ | |
306 | int (*set_file_size)(const unsigned int, struct cifs_tcon *, | |
307 | struct cifsFileInfo *, __u64, bool); | |
6bdf6dbd PS |
308 | /* set attributes */ |
309 | int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *, | |
310 | const unsigned int); | |
64a5cfa6 SF |
311 | int (*set_compression)(const unsigned int, struct cifs_tcon *, |
312 | struct cifsFileInfo *); | |
f6d76178 PS |
313 | /* check if we can send an echo or nor */ |
314 | bool (*can_echo)(struct TCP_Server_Info *); | |
315 | /* send echo request */ | |
316 | int (*echo)(struct TCP_Server_Info *); | |
f436720e | 317 | /* create directory */ |
bea851b8 SF |
318 | int (*posix_mkdir)(const unsigned int xid, struct inode *inode, |
319 | umode_t mode, struct cifs_tcon *tcon, | |
320 | const char *full_path, | |
321 | struct cifs_sb_info *cifs_sb); | |
c3ca78e2 SF |
322 | int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode, |
323 | struct cifs_tcon *tcon, const char *name, | |
324 | struct cifs_sb_info *sb); | |
f436720e PS |
325 | /* set info on created directory */ |
326 | void (*mkdir_setinfo)(struct inode *, const char *, | |
327 | struct cifs_sb_info *, struct cifs_tcon *, | |
328 | const unsigned int); | |
f958ca5d PS |
329 | /* remove directory */ |
330 | int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *, | |
331 | struct cifs_sb_info *); | |
ed6875e0 PS |
332 | /* unlink file */ |
333 | int (*unlink)(const unsigned int, struct cifs_tcon *, const char *, | |
334 | struct cifs_sb_info *); | |
335 | /* open, rename and delete file */ | |
336 | int (*rename_pending_delete)(const char *, struct dentry *, | |
337 | const unsigned int); | |
8ceb9843 PS |
338 | /* send rename request */ |
339 | int (*rename)(const unsigned int, struct cifs_tcon *, const char *, | |
340 | const char *, struct cifs_sb_info *); | |
d6e906f1 SF |
341 | /* send create hardlink request */ |
342 | int (*create_hardlink)(const unsigned int, struct cifs_tcon *, | |
343 | const char *, const char *, | |
344 | struct cifs_sb_info *); | |
b42bf888 PS |
345 | /* query symlink target */ |
346 | int (*query_symlink)(const unsigned int, struct cifs_tcon *, | |
ebaf546a RS |
347 | struct cifs_sb_info *, const char *, |
348 | char **, bool); | |
fb1214e4 | 349 | /* open a file for non-posix mounts */ |
226730b4 PS |
350 | int (*open)(const unsigned int, struct cifs_open_parms *, |
351 | __u32 *, FILE_ALL_INFO *); | |
fb1214e4 PS |
352 | /* set fid protocol-specific info */ |
353 | void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32); | |
0ff78a22 | 354 | /* close a file */ |
760ad0ca PS |
355 | void (*close)(const unsigned int, struct cifs_tcon *, |
356 | struct cifs_fid *); | |
43f8a6a7 SF |
357 | /* close a file, returning file attributes and timestamps */ |
358 | void (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon, | |
359 | struct cifsFileInfo *pfile_info); | |
1d8c4c00 PS |
360 | /* send a flush request to the server */ |
361 | int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *); | |
fc9c5966 PS |
362 | /* async read from the server */ |
363 | int (*async_readv)(struct cifs_readdata *); | |
c9de5c80 | 364 | /* async write to the server */ |
4a5c80d7 SF |
365 | int (*async_writev)(struct cifs_writedata *, |
366 | void (*release)(struct kref *)); | |
f9c6e234 | 367 | /* sync read from the server */ |
db8b631d | 368 | int (*sync_read)(const unsigned int, struct cifs_fid *, |
f9c6e234 PS |
369 | struct cifs_io_parms *, unsigned int *, char **, |
370 | int *); | |
ba9ad725 | 371 | /* sync write to the server */ |
db8b631d | 372 | int (*sync_write)(const unsigned int, struct cifs_fid *, |
ba9ad725 PS |
373 | struct cifs_io_parms *, unsigned int *, struct kvec *, |
374 | unsigned long); | |
92fc65a7 PS |
375 | /* open dir, start readdir */ |
376 | int (*query_dir_first)(const unsigned int, struct cifs_tcon *, | |
377 | const char *, struct cifs_sb_info *, | |
378 | struct cifs_fid *, __u16, | |
379 | struct cifs_search_info *); | |
380 | /* continue readdir */ | |
381 | int (*query_dir_next)(const unsigned int, struct cifs_tcon *, | |
382 | struct cifs_fid *, | |
383 | __u16, struct cifs_search_info *srch_inf); | |
384 | /* close dir */ | |
385 | int (*close_dir)(const unsigned int, struct cifs_tcon *, | |
386 | struct cifs_fid *); | |
387 | /* calculate a size of SMB message */ | |
9ec672bd | 388 | unsigned int (*calc_smb_size)(void *buf, struct TCP_Server_Info *ptcpi); |
66265f13 PS |
389 | /* check for STATUS_PENDING and process the response if yes */ |
390 | bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server); | |
511c54a2 PS |
391 | /* check for STATUS_NETWORK_SESSION_EXPIRED */ |
392 | bool (*is_session_expired)(char *); | |
95a3f2f3 PS |
393 | /* send oplock break response */ |
394 | int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *, | |
395 | struct cifsInodeInfo *); | |
76ec5e33 PS |
396 | /* query remote filesystem */ |
397 | int (*queryfs)(const unsigned int, struct cifs_tcon *, | |
0f060936 | 398 | struct cifs_sb_info *, struct kstatfs *); |
d39a4f71 PS |
399 | /* send mandatory brlock to the server */ |
400 | int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64, | |
401 | __u64, __u32, int, int, bool); | |
402 | /* unlock range of mandatory locks */ | |
403 | int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *, | |
404 | const unsigned int); | |
405 | /* push brlocks from the cache to the server */ | |
406 | int (*push_mand_locks)(struct cifsFileInfo *); | |
b8c32dbb | 407 | /* get lease key of the inode */ |
a41a28bd | 408 | void (*get_lease_key)(struct inode *, struct cifs_fid *); |
b8c32dbb | 409 | /* set lease key of the inode */ |
a41a28bd | 410 | void (*set_lease_key)(struct inode *, struct cifs_fid *); |
b8c32dbb | 411 | /* generate new lease key */ |
a41a28bd | 412 | void (*new_lease_key)(struct cifs_fid *); |
32811d24 | 413 | int (*generate_signingkey)(struct cifs_ses *); |
eda1c54f LL |
414 | int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *, |
415 | bool allocate_crypto); | |
b3152e2c SF |
416 | int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon, |
417 | struct cifsFileInfo *src_file); | |
834170c8 SF |
418 | int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon, |
419 | struct cifsFileInfo *src_file, void __user *); | |
d26c2ddd SF |
420 | int (*notify)(const unsigned int xid, struct file *pfile, |
421 | void __user *pbuf); | |
b5be1a1c SP |
422 | int (*query_mf_symlink)(unsigned int, struct cifs_tcon *, |
423 | struct cifs_sb_info *, const unsigned char *, | |
424 | char *, unsigned int *); | |
cbb0aba6 SP |
425 | int (*create_mf_symlink)(unsigned int, struct cifs_tcon *, |
426 | struct cifs_sb_info *, const unsigned char *, | |
427 | char *, unsigned int *); | |
53ef1016 PS |
428 | /* if we can do cache read operations */ |
429 | bool (*is_read_op)(__u32); | |
430 | /* set oplock level for the inode */ | |
42873b0a PS |
431 | void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int, |
432 | bool *); | |
a41a28bd | 433 | /* create lease context buffer for CREATE request */ |
729c0c9d | 434 | char * (*create_lease_buf)(u8 *lease_key, u8 oplock); |
42873b0a | 435 | /* parse lease context buffer and return oplock/epoch info */ |
96164ab2 | 436 | __u8 (*parse_lease_buf)(void *buf, unsigned int *epoch, char *lkey); |
620d8745 | 437 | ssize_t (*copychunk_range)(const unsigned int, |
312bbc59 | 438 | struct cifsFileInfo *src_file, |
620d8745 SP |
439 | struct cifsFileInfo *target_file, |
440 | u64 src_off, u64 len, u64 dest_off); | |
02b16665 SF |
441 | int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src, |
442 | struct cifsFileInfo *target_file, u64 src_off, u64 len, | |
443 | u64 dest_off); | |
ff1c038a | 444 | int (*validate_negotiate)(const unsigned int, struct cifs_tcon *); |
666753c3 SF |
445 | ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *, |
446 | const unsigned char *, const unsigned char *, char *, | |
67b4c889 | 447 | size_t, struct cifs_sb_info *); |
666753c3 SF |
448 | int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *, |
449 | const char *, const void *, const __u16, | |
5517554e | 450 | const struct nls_table *, struct cifs_sb_info *); |
83e3bc23 | 451 | struct cifs_ntsd * (*get_acl)(struct cifs_sb_info *, struct inode *, |
3970acf7 | 452 | const char *, u32 *, u32); |
42eacf9e | 453 | struct cifs_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *, |
3970acf7 | 454 | const struct cifs_fid *, u32 *, u32); |
83e3bc23 SF |
455 | int (*set_acl)(struct cifs_ntsd *, __u32, struct inode *, const char *, |
456 | int); | |
7f6c5008 PS |
457 | /* writepages retry size */ |
458 | unsigned int (*wp_retry_size)(struct inode *); | |
cb7e9eab PS |
459 | /* get mtu credits */ |
460 | int (*wait_mtu_credits)(struct TCP_Server_Info *, unsigned int, | |
335b7b62 | 461 | unsigned int *, struct cifs_credits *); |
9a1c67e8 PS |
462 | /* adjust previously taken mtu credits to request size */ |
463 | int (*adjust_credits)(struct TCP_Server_Info *server, | |
464 | struct cifs_credits *credits, | |
465 | const unsigned int payload_size); | |
52755808 PS |
466 | /* check if we need to issue closedir */ |
467 | bool (*dir_needs_close)(struct cifsFileInfo *); | |
31742c5a SF |
468 | long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t, |
469 | loff_t); | |
7fb8986e | 470 | /* init transform request - used for encryption for now */ |
b2c96de7 RS |
471 | int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst, |
472 | struct smb_rqst *, struct smb_rqst *); | |
9bb17e09 PS |
473 | int (*is_transform_hdr)(void *buf); |
474 | int (*receive_transform)(struct TCP_Server_Info *, | |
b24df3e3 | 475 | struct mid_q_entry **, char **, int *); |
ef65aaed SP |
476 | enum securityEnum (*select_sectype)(struct TCP_Server_Info *, |
477 | enum securityEnum); | |
8ce79ec3 | 478 | int (*next_header)(char *); |
f5b05d62 RS |
479 | /* ioctl passthrough for query_info */ |
480 | int (*ioctl_query_info)(const unsigned int xid, | |
8d8b26e5 | 481 | struct cifs_tcon *tcon, |
0f060936 | 482 | struct cifs_sb_info *cifs_sb, |
8d8b26e5 | 483 | __le16 *path, int is_dir, |
f5b05d62 | 484 | unsigned long p); |
c847dccf AA |
485 | /* make unix special files (block, char, fifo, socket) */ |
486 | int (*make_node)(unsigned int xid, | |
487 | struct inode *inode, | |
488 | struct dentry *dentry, | |
489 | struct cifs_tcon *tcon, | |
55869139 | 490 | const char *full_path, |
c847dccf AA |
491 | umode_t mode, |
492 | dev_t device_number); | |
2f3ebaba RS |
493 | /* version specific fiemap implementation */ |
494 | int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *, | |
495 | struct fiemap_extent_info *, u64, u64); | |
dece44e3 RS |
496 | /* version specific llseek implementation */ |
497 | loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int); | |
8e670f77 RS |
498 | /* Check for STATUS_IO_TIMEOUT */ |
499 | bool (*is_status_io_timeout)(char *buf); | |
9e550b08 RS |
500 | /* Check for STATUS_NETWORK_NAME_DELETED */ |
501 | void (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv); | |
23db65f5 JL |
502 | }; |
503 | ||
504 | struct smb_version_values { | |
505 | char *version_string; | |
e4aa25e7 SF |
506 | __u16 protocol_id; |
507 | __u32 req_capabilities; | |
106dc538 PS |
508 | __u32 large_lock_type; |
509 | __u32 exclusive_lock_type; | |
510 | __u32 shared_lock_type; | |
511 | __u32 unlock_lock_type; | |
93012bf9 | 512 | size_t header_preamble_size; |
1887f601 PS |
513 | size_t header_size; |
514 | size_t max_header_size; | |
eb378711 | 515 | size_t read_rsp_size; |
2dc7e1c0 | 516 | __le16 lock_cmd; |
29e20f9c PS |
517 | unsigned int cap_unix; |
518 | unsigned int cap_nt_find; | |
519 | unsigned int cap_large_files; | |
50285882 JL |
520 | __u16 signing_enabled; |
521 | __u16 signing_required; | |
a41a28bd | 522 | size_t create_lease_size; |
23db65f5 JL |
523 | }; |
524 | ||
1887f601 PS |
525 | #define HEADER_SIZE(server) (server->vals->header_size) |
526 | #define MAX_HEADER_SIZE(server) (server->vals->max_header_size) | |
527 | ||
d070f9dd AA |
528 | /** |
529 | * CIFS superblock mount flags (mnt_cifs_flags) to consider when | |
530 | * trying to reuse existing superblock for a new mount | |
531 | */ | |
25c7f41e PS |
532 | #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \ |
533 | CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \ | |
534 | CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \ | |
2baa2682 | 535 | CIFS_MOUNT_MAP_SFM_CHR | \ |
25c7f41e PS |
536 | CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \ |
537 | CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \ | |
538 | CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \ | |
539 | CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \ | |
540 | CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \ | |
3d3ea8e6 | 541 | CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \ |
d070f9dd | 542 | CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \ |
6552d6a0 | 543 | CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \ |
83bbfa70 | 544 | CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \ |
41e033fe | 545 | CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE) |
25c7f41e | 546 | |
d070f9dd AA |
547 | /** |
548 | * Generic VFS superblock mount flags (s_flags) to consider when | |
549 | * trying to reuse existing superblock for a new mount | |
550 | */ | |
1751e8a6 LT |
551 | #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \ |
552 | SB_NODEV | SB_SYNCHRONOUS) | |
25c7f41e PS |
553 | |
554 | struct cifs_mnt_data { | |
555 | struct cifs_sb_info *cifs_sb; | |
3fa1c6d1 | 556 | struct smb3_fs_context *ctx; |
25c7f41e PS |
557 | int flags; |
558 | }; | |
559 | ||
792af7b0 PS |
560 | static inline unsigned int |
561 | get_rfc1002_length(void *buf) | |
562 | { | |
dca1c8d1 | 563 | return be32_to_cpu(*((__be32 *)buf)) & 0xffffff; |
792af7b0 PS |
564 | } |
565 | ||
ec2e4523 PS |
566 | static inline void |
567 | inc_rfc1001_len(void *buf, int count) | |
568 | { | |
569 | be32_add_cpu((__be32 *)buf, count); | |
570 | } | |
571 | ||
1da177e4 | 572 | struct TCP_Server_Info { |
3b795210 SF |
573 | struct list_head tcp_ses_list; |
574 | struct list_head smb_ses_list; | |
6d82c27a | 575 | __u64 conn_id; /* connection identifier (useful for debugging) */ |
e7ddee90 | 576 | int srv_count; /* reference counter */ |
a10faeb2 | 577 | /* 15 character server name + 0x20 16th byte indicating type = srv */ |
8ecaf67a | 578 | char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; |
23db65f5 JL |
579 | struct smb_version_operations *ops; |
580 | struct smb_version_values *vals; | |
01cf3082 | 581 | /* updates to tcpStatus protected by GlobalMid_Lock */ |
c3dccf48 | 582 | enum statusEnum tcpStatus; /* what we think the status is */ |
c359cf3c | 583 | char *hostname; /* hostname portion of UNC string */ |
1da177e4 | 584 | struct socket *ssocket; |
a9f1b85e | 585 | struct sockaddr_storage dstaddr; |
3eb9a889 | 586 | struct sockaddr_storage srcaddr; /* locally bind to this IP */ |
f1d0c998 RL |
587 | #ifdef CONFIG_NET_NS |
588 | struct net *net; | |
589 | #endif | |
d38d8c74 | 590 | wait_queue_head_t response_q; |
1da177e4 LT |
591 | wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/ |
592 | struct list_head pending_mid_q; | |
edf1ae40 SF |
593 | bool noblocksnd; /* use blocking sendmsg */ |
594 | bool noautotune; /* do not autotune send buf sizes */ | |
c9f1c19c | 595 | bool nosharesock; |
6a5fa236 | 596 | bool tcp_nodelay; |
141891f4 SF |
597 | unsigned int credits; /* send no more requests at once */ |
598 | unsigned int max_credits; /* can override large 32000 default at mnt */ | |
fc40f9cf | 599 | unsigned int in_flight; /* number of requests on the wire to server */ |
1b63f184 | 600 | unsigned int max_in_flight; /* max number of requests that were on wire */ |
2d86dbc9 | 601 | spinlock_t req_lock; /* protect the two values above */ |
72ca545b | 602 | struct mutex srv_mutex; |
1da177e4 LT |
603 | struct task_struct *tsk; |
604 | char server_GUID[16]; | |
286170aa | 605 | __u16 sec_mode; |
38d77c50 | 606 | bool sign; /* is signing enabled on this connection? */ |
4f5c10f1 | 607 | bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */ |
c3dccf48 | 608 | bool session_estab; /* mark when very first sess is established */ |
28ea5290 PS |
609 | int echo_credits; /* echo reserved slots */ |
610 | int oplock_credits; /* oplock break reserved slots */ | |
611 | bool echoes:1; /* enable echoes */ | |
39552ea8 | 612 | __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */ |
c3dccf48 | 613 | u16 dialect; /* dialect index that server chose */ |
10b9b98e | 614 | bool oplocks:1; /* enable oplocks */ |
1da177e4 LT |
615 | unsigned int maxReq; /* Clients should submit no more */ |
616 | /* than maxReq distinct unanswered SMBs to the server when using */ | |
11911b95 | 617 | /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */ |
1da177e4 LT |
618 | unsigned int maxBuf; /* maxBuf specifies the maximum */ |
619 | /* message size the server can send or receive for non-raw SMBs */ | |
7e90d705 SF |
620 | /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */ |
621 | /* when socket is setup (and during reconnect) before NegProt sent */ | |
eca6acf9 | 622 | unsigned int max_rw; /* maxRw specifies the maximum */ |
1da177e4 LT |
623 | /* message size the server can send or receive for */ |
624 | /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */ | |
29e20f9c | 625 | unsigned int capabilities; /* selective disabling of caps by smb sess */ |
de7ed55d | 626 | int timeAdj; /* Adjust for difference in server time zone in sec */ |
0fa757b5 | 627 | __u64 CurrentMid; /* multiplex id - rotating counter, protected by GlobalMid_Lock */ |
d3ba50b1 | 628 | char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */ |
a10faeb2 | 629 | /* 16th byte of RFC1001 workstation name is always null */ |
8ecaf67a | 630 | char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; |
a0f8b4fb | 631 | __u32 sequence_number; /* for signing, protected by srv_mutex */ |
9e1a37da | 632 | __u32 reconnect_instance; /* incremented on each reconnect */ |
5f98ca9a | 633 | struct session_key session_key; |
3a5ff61c | 634 | unsigned long lstrp; /* when we got last response from this server */ |
d2b91521 | 635 | struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */ |
e598d1d8 JL |
636 | #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */ |
637 | #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */ | |
638 | char negflavor; /* NEGOTIATE response flavor */ | |
26efa0ba | 639 | /* extended security flavors that server supports */ |
c3dccf48 JL |
640 | bool sec_ntlmssp; /* supports NTLMSSP */ |
641 | bool sec_kerberosu2u; /* supports U2U Kerberos */ | |
26efa0ba JL |
642 | bool sec_kerberos; /* supports plain Kerberos */ |
643 | bool sec_mskerberos; /* supports legacy MS Kerberos */ | |
2a37ef94 | 644 | bool large_buf; /* is current buffer large? */ |
8339dd32 LL |
645 | /* use SMBD connection instead of socket */ |
646 | bool rdma; | |
647 | /* point to the SMBD connection if RDMA is used instead of socket */ | |
648 | struct smbd_connection *smbd_conn; | |
c74093b6 | 649 | struct delayed_work echo; /* echo ping workqueue job */ |
506c1da4 | 650 | struct delayed_work resolve; /* dns resolution workqueue job */ |
2a37ef94 JL |
651 | char *smallbuf; /* pointer to current "small" buffer */ |
652 | char *bigbuf; /* pointer to current "big" buffer */ | |
2e96467d RS |
653 | /* Total size of this PDU. Only valid from cifs_demultiplex_thread */ |
654 | unsigned int pdu_size; | |
2a37ef94 | 655 | unsigned int total_read; /* total amount of data read in this pass */ |
1ae9a5a5 SF |
656 | atomic_t in_send; /* requests trying to send */ |
657 | atomic_t num_waiters; /* blocked waiting to get in sendrecv */ | |
488f1d2d SJ |
658 | #ifdef CONFIG_CIFS_FSCACHE |
659 | struct fscache_cookie *fscache; /* client index cache cookie */ | |
660 | #endif | |
c3dccf48 | 661 | #ifdef CONFIG_CIFS_STATS2 |
433b8dd7 | 662 | atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */ |
468d6779 | 663 | atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */ |
433b8dd7 SF |
664 | __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */ |
665 | __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS]; | |
666 | __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS]; | |
468d6779 | 667 | #endif /* STATS2 */ |
ec2e4523 PS |
668 | unsigned int max_read; |
669 | unsigned int max_write; | |
563317ec | 670 | unsigned int min_offload; |
26ea888f | 671 | __le16 compress_algorithm; |
53d31a3f | 672 | __u16 signing_algorithm; |
5100d8a3 | 673 | __le16 cipher_type; |
8bd68c6e AA |
674 | /* save initital negprot hash */ |
675 | __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE]; | |
53d31a3f | 676 | bool signing_negotiated; /* true if valid signing context rcvd from server */ |
fcef0db6 | 677 | bool posix_ext_supported; |
53e0e11e PS |
678 | struct delayed_work reconnect; /* reconnect workqueue job */ |
679 | struct mutex reconnect_mutex; /* prevent simultaneous reconnects */ | |
adfeb3e0 | 680 | unsigned long echo_interval; |
93d5cb51 PA |
681 | |
682 | /* | |
683 | * Number of targets available for reconnect. The more targets | |
684 | * the more tasks have to wait to let the demultiplex thread | |
685 | * reconnect. | |
686 | */ | |
687 | int nr_targets; | |
8eecd1c2 | 688 | bool noblockcnt; /* use non-blocking connect() */ |
3345bb44 | 689 | bool is_channel; /* if a session channel */ |
121d947d SC |
690 | #ifdef CONFIG_CIFS_SWN_UPCALL |
691 | bool use_swn_dstaddr; | |
692 | struct sockaddr_storage swn_dstaddr; | |
693 | #endif | |
cdc33630 PA |
694 | #ifdef CONFIG_CIFS_DFS_UPCALL |
695 | bool is_dfs_conn; /* if a dfs connection */ | |
696 | #endif | |
1da177e4 LT |
697 | }; |
698 | ||
335b7b62 PS |
699 | struct cifs_credits { |
700 | unsigned int value; | |
701 | unsigned int instance; | |
702 | }; | |
703 | ||
fc40f9cf PS |
704 | static inline unsigned int |
705 | in_flight(struct TCP_Server_Info *server) | |
706 | { | |
707 | unsigned int num; | |
708 | spin_lock(&server->req_lock); | |
709 | num = server->in_flight; | |
710 | spin_unlock(&server->req_lock); | |
711 | return num; | |
712 | } | |
713 | ||
2d86dbc9 | 714 | static inline bool |
b227d215 | 715 | has_credits(struct TCP_Server_Info *server, int *credits, int num_credits) |
fc40f9cf | 716 | { |
2d86dbc9 | 717 | int num; |
fc40f9cf | 718 | spin_lock(&server->req_lock); |
bc205ed1 | 719 | num = *credits; |
fc40f9cf | 720 | spin_unlock(&server->req_lock); |
b227d215 | 721 | return num >= num_credits; |
fc40f9cf PS |
722 | } |
723 | ||
45275789 | 724 | static inline void |
34f4deb7 | 725 | add_credits(struct TCP_Server_Info *server, const struct cifs_credits *credits, |
a891f0f8 | 726 | const int optype) |
45275789 | 727 | { |
34f4deb7 | 728 | server->ops->add_credits(server, credits, optype); |
45275789 PS |
729 | } |
730 | ||
cb7e9eab | 731 | static inline void |
335b7b62 PS |
732 | add_credits_and_wake_if(struct TCP_Server_Info *server, |
733 | const struct cifs_credits *credits, const int optype) | |
cb7e9eab | 734 | { |
335b7b62 PS |
735 | if (credits->value) { |
736 | server->ops->add_credits(server, credits, optype); | |
cb7e9eab PS |
737 | wake_up(&server->request_q); |
738 | } | |
739 | } | |
740 | ||
45275789 PS |
741 | static inline void |
742 | set_credits(struct TCP_Server_Info *server, const int val) | |
743 | { | |
744 | server->ops->set_credits(server, val); | |
745 | } | |
746 | ||
9a1c67e8 PS |
747 | static inline int |
748 | adjust_credits(struct TCP_Server_Info *server, struct cifs_credits *credits, | |
749 | const unsigned int payload_size) | |
750 | { | |
751 | return server->ops->adjust_credits ? | |
752 | server->ops->adjust_credits(server, credits, payload_size) : 0; | |
753 | } | |
754 | ||
9235d098 | 755 | static inline __le64 |
3d378d3f | 756 | get_next_mid64(struct TCP_Server_Info *server) |
88257360 | 757 | { |
9235d098 | 758 | return cpu_to_le64(server->ops->get_next_mid(server)); |
88257360 PS |
759 | } |
760 | ||
3d378d3f TG |
761 | static inline __le16 |
762 | get_next_mid(struct TCP_Server_Info *server) | |
763 | { | |
9235d098 | 764 | __u16 mid = server->ops->get_next_mid(server); |
3d378d3f TG |
765 | /* |
766 | * The value in the SMB header should be little endian for easy | |
767 | * on-the-wire decoding. | |
768 | */ | |
769 | return cpu_to_le16(mid); | |
770 | } | |
771 | ||
c781af7e PS |
772 | static inline void |
773 | revert_current_mid(struct TCP_Server_Info *server, const unsigned int val) | |
774 | { | |
775 | if (server->ops->revert_current_mid) | |
776 | server->ops->revert_current_mid(server, val); | |
777 | } | |
778 | ||
779 | static inline void | |
780 | revert_current_mid_from_hdr(struct TCP_Server_Info *server, | |
0d35e382 | 781 | const struct smb2_hdr *shdr) |
c781af7e PS |
782 | { |
783 | unsigned int num = le16_to_cpu(shdr->CreditCharge); | |
784 | ||
785 | return revert_current_mid(server, num > 0 ? num : 1); | |
786 | } | |
787 | ||
3d378d3f TG |
788 | static inline __u16 |
789 | get_mid(const struct smb_hdr *smb) | |
790 | { | |
791 | return le16_to_cpu(smb->Mid); | |
792 | } | |
793 | ||
794 | static inline bool | |
795 | compare_mid(__u16 mid, const struct smb_hdr *smb) | |
796 | { | |
797 | return mid == le16_to_cpu(smb->Mid); | |
798 | } | |
799 | ||
24985c53 PS |
800 | /* |
801 | * When the server supports very large reads and writes via POSIX extensions, | |
802 | * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not | |
803 | * including the RFC1001 length. | |
804 | * | |
805 | * Note that this might make for "interesting" allocation problems during | |
806 | * writeback however as we have to allocate an array of pointers for the | |
ea1754a0 | 807 | * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096. |
24985c53 PS |
808 | * |
809 | * For reads, there is a similar problem as we need to allocate an array | |
810 | * of kvecs to handle the receive, though that should only need to be done | |
811 | * once. | |
812 | */ | |
813 | #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4) | |
814 | #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4) | |
815 | ||
816 | /* | |
817 | * When the server doesn't allow large posix writes, only allow a rsize/wsize | |
818 | * of 2^17-1 minus the size of the call header. That allows for a read or | |
819 | * write up to the maximum size described by RFC1002. | |
820 | */ | |
821 | #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4) | |
822 | #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4) | |
823 | ||
824 | /* | |
825 | * The default wsize is 1M. find_get_pages seems to return a maximum of 256 | |
ea1754a0 | 826 | * pages in a single call. With PAGE_SIZE == 4k, this means we can fill |
24985c53 PS |
827 | * a single wsize request with a single call. |
828 | */ | |
829 | #define CIFS_DEFAULT_IOSIZE (1024 * 1024) | |
3d621230 | 830 | #define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024) |
24985c53 PS |
831 | |
832 | /* | |
833 | * Windows only supports a max of 60kb reads and 65535 byte writes. Default to | |
834 | * those values when posix extensions aren't in force. In actuality here, we | |
835 | * use 65536 to allow for a write that is a multiple of 4k. Most servers seem | |
836 | * to be ok with the extra byte even though Windows doesn't send writes that | |
837 | * are that large. | |
838 | * | |
839 | * Citation: | |
840 | * | |
cba22b1c | 841 | * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx |
24985c53 PS |
842 | */ |
843 | #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024) | |
844 | #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536) | |
845 | ||
f1d0c998 RL |
846 | /* |
847 | * Macros to allow the TCP_Server_Info->net field and related code to drop out | |
848 | * when CONFIG_NET_NS isn't set. | |
849 | */ | |
850 | ||
851 | #ifdef CONFIG_NET_NS | |
852 | ||
853 | static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) | |
854 | { | |
855 | return srv->net; | |
856 | } | |
857 | ||
858 | static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) | |
859 | { | |
860 | srv->net = net; | |
861 | } | |
862 | ||
863 | #else | |
864 | ||
865 | static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) | |
866 | { | |
867 | return &init_net; | |
868 | } | |
869 | ||
870 | static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) | |
871 | { | |
872 | } | |
873 | ||
874 | #endif | |
875 | ||
b6f0dd5d AA |
876 | struct cifs_server_iface { |
877 | size_t speed; | |
878 | unsigned int rdma_capable : 1; | |
879 | unsigned int rss_capable : 1; | |
880 | struct sockaddr_storage sockaddr; | |
881 | }; | |
882 | ||
bcc88801 AA |
883 | struct cifs_chan { |
884 | struct TCP_Server_Info *server; | |
885 | __u8 signkey[SMB3_SIGN_KEY_SIZE]; | |
886 | }; | |
887 | ||
1da177e4 LT |
888 | /* |
889 | * Session structure. One of these for each uid session with a particular host | |
890 | */ | |
96daf2b0 | 891 | struct cifs_ses { |
14fbf50d | 892 | struct list_head smb_ses_list; |
3b795210 | 893 | struct list_head tcon_list; |
b327a717 | 894 | struct cifs_tcon *tcon_ipc; |
d7b619cf | 895 | struct mutex session_mutex; |
1da177e4 | 896 | struct TCP_Server_Info *server; /* pointer to server info */ |
14fbf50d | 897 | int ses_count; /* reference counter */ |
0060a4f2 | 898 | enum statusEnum status; /* updates protected by GlobalMid_Lock */ |
750d1151 | 899 | unsigned overrideSecFlg; /* if non-zero override global sec flags */ |
ad009ac9 SF |
900 | char *serverOS; /* name of operating system underlying server */ |
901 | char *serverNOS; /* name of network operating system of server */ | |
1da177e4 | 902 | char *serverDomain; /* security realm of server */ |
286170aa | 903 | __u64 Suid; /* remote smb uid */ |
64ed39dd EB |
904 | kuid_t linux_uid; /* overriding owner of files on the mount */ |
905 | kuid_t cred_uid; /* owner of credentials */ | |
29e20f9c | 906 | unsigned int capabilities; |
b438fcf1 | 907 | char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */ |
34c87901 SF |
908 | char *user_name; /* must not be null except during init of sess |
909 | and after mount option parsing we fill it */ | |
d38d8c74 SF |
910 | char *domainName; |
911 | char *password; | |
5d0d2882 | 912 | struct session_key auth_key; |
d3686d54 | 913 | struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */ |
28e11bd8 JL |
914 | enum securityEnum sectype; /* what security flavor was specified? */ |
915 | bool sign; /* is signing required? */ | |
3b795210 | 916 | bool need_reconnect:1; /* connection reset, uid now invalid */ |
39566443 | 917 | bool domainAuto:1; |
f6a6bf7c | 918 | bool binding:1; /* are we binding the session? */ |
5478f9ba | 919 | __u16 session_flags; |
373512ec | 920 | __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE]; |
45a4546c SP |
921 | __u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE]; |
922 | __u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE]; | |
8bd68c6e | 923 | __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE]; |
b6f0dd5d | 924 | |
d70e9fa5 AA |
925 | __u8 binding_preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE]; |
926 | ||
b6f0dd5d AA |
927 | /* |
928 | * Network interfaces available on the server this session is | |
929 | * connected to. | |
930 | * | |
931 | * Other channels can be opened by connecting and binding this | |
932 | * session to interfaces from this list. | |
933 | * | |
934 | * iface_lock should be taken when accessing any of these fields | |
935 | */ | |
936 | spinlock_t iface_lock; | |
937 | struct cifs_server_iface *iface_list; | |
938 | size_t iface_count; | |
939 | unsigned long iface_last_update; /* jiffies */ | |
bcc88801 AA |
940 | |
941 | #define CIFS_MAX_CHANNELS 16 | |
942 | struct cifs_chan chans[CIFS_MAX_CHANNELS]; | |
8eec7954 | 943 | struct cifs_chan *binding_chan; |
bcc88801 AA |
944 | size_t chan_count; |
945 | size_t chan_max; | |
946 | atomic_t chan_seq; /* round robin state */ | |
1da177e4 | 947 | }; |
233839b1 | 948 | |
d70e9fa5 AA |
949 | /* |
950 | * When binding a new channel, we need to access the channel which isn't fully | |
8eec7954 | 951 | * established yet. |
d70e9fa5 AA |
952 | */ |
953 | ||
954 | static inline | |
955 | struct cifs_chan *cifs_ses_binding_channel(struct cifs_ses *ses) | |
956 | { | |
957 | if (ses->binding) | |
8eec7954 | 958 | return ses->binding_chan; |
d70e9fa5 AA |
959 | else |
960 | return NULL; | |
961 | } | |
962 | ||
8eec7954 AA |
963 | /* |
964 | * Returns the server pointer of the session. When binding a new | |
965 | * channel this returns the last channel which isn't fully established | |
966 | * yet. | |
967 | * | |
968 | * This function should be use for negprot/sess.setup codepaths. For | |
969 | * the other requests see cifs_pick_channel(). | |
970 | */ | |
f6a6bf7c AA |
971 | static inline |
972 | struct TCP_Server_Info *cifs_ses_server(struct cifs_ses *ses) | |
973 | { | |
974 | if (ses->binding) | |
8eec7954 | 975 | return ses->binding_chan->server; |
f6a6bf7c AA |
976 | else |
977 | return ses->server; | |
978 | } | |
979 | ||
29e20f9c PS |
980 | static inline bool |
981 | cap_unix(struct cifs_ses *ses) | |
982 | { | |
983 | return ses->server->vals->cap_unix & ses->capabilities; | |
984 | } | |
985 | ||
a93864d9 RS |
986 | struct cached_fid { |
987 | bool is_valid:1; /* Do we have a useable root fid */ | |
b0f6df73 | 988 | bool file_all_info_is_valid:1; |
d9191319 | 989 | bool has_lease:1; |
ed20f54a | 990 | unsigned long time; /* jiffies of when lease was taken */ |
9da6ec77 | 991 | struct kref refcount; |
a93864d9 RS |
992 | struct cifs_fid *fid; |
993 | struct mutex fid_mutex; | |
994 | struct cifs_tcon *tcon; | |
5e9c89d4 | 995 | struct dentry *dentry; |
a93864d9 | 996 | struct work_struct lease_break; |
b0f6df73 | 997 | struct smb2_file_all_info file_all_info; |
a93864d9 RS |
998 | }; |
999 | ||
1da177e4 LT |
1000 | /* |
1001 | * there is one of these for each connection to a resource on a particular | |
d38d8c74 | 1002 | * session |
1da177e4 | 1003 | */ |
96daf2b0 | 1004 | struct cifs_tcon { |
f1987b44 JL |
1005 | struct list_head tcon_list; |
1006 | int tc_count; | |
53e0e11e | 1007 | struct list_head rlist; /* reconnect list */ |
fae8044c SF |
1008 | atomic_t num_local_opens; /* num of all opens including disconnected */ |
1009 | atomic_t num_remote_opens; /* num of all network opens on server */ | |
1da177e4 | 1010 | struct list_head openFileList; |
3afca265 | 1011 | spinlock_t open_file_lock; /* protects list above */ |
96daf2b0 | 1012 | struct cifs_ses *ses; /* pointer to session associated with */ |
254e55ed | 1013 | char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */ |
1da177e4 | 1014 | char *nativeFileSystem; |
00e485b0 | 1015 | char *password; /* for share-level security */ |
faaf946a | 1016 | __u32 tid; /* The 4 byte tree id */ |
1da177e4 LT |
1017 | __u16 Flags; /* optional support bits */ |
1018 | enum statusEnum tidStatus; | |
1da177e4 | 1019 | atomic_t num_smbs_sent; |
44c58186 PS |
1020 | union { |
1021 | struct { | |
1022 | atomic_t num_writes; | |
1023 | atomic_t num_reads; | |
1024 | atomic_t num_flushes; | |
1025 | atomic_t num_oplock_brks; | |
1026 | atomic_t num_opens; | |
1027 | atomic_t num_closes; | |
1028 | atomic_t num_deletes; | |
1029 | atomic_t num_mkdirs; | |
1030 | atomic_t num_posixopens; | |
1031 | atomic_t num_posixmkdirs; | |
1032 | atomic_t num_rmdirs; | |
1033 | atomic_t num_renames; | |
1034 | atomic_t num_t2renames; | |
1035 | atomic_t num_ffirst; | |
1036 | atomic_t num_fnext; | |
1037 | atomic_t num_fclose; | |
1038 | atomic_t num_hardlinks; | |
1039 | atomic_t num_symlinks; | |
1040 | atomic_t num_locks; | |
1041 | atomic_t num_acl_get; | |
1042 | atomic_t num_acl_set; | |
1043 | } cifs_stats; | |
d60622eb PS |
1044 | struct { |
1045 | atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS]; | |
1046 | atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS]; | |
1047 | } smb2_stats; | |
44c58186 | 1048 | } stats; |
1da177e4 LT |
1049 | __u64 bytes_read; |
1050 | __u64 bytes_written; | |
3afca265 | 1051 | spinlock_t stat_lock; /* protects the two fields above */ |
1da177e4 | 1052 | FILE_SYSTEM_DEVICE_INFO fsDevInfo; |
254e55ed | 1053 | FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */ |
1da177e4 | 1054 | FILE_SYSTEM_UNIX_INFO fsUnixInfo; |
b327a717 AA |
1055 | bool ipc:1; /* set if connection to IPC$ share (always also pipe) */ |
1056 | bool pipe:1; /* set if connection to pipe share */ | |
1057 | bool print:1; /* set if connection to printer share */ | |
4b18f2a9 SF |
1058 | bool retry:1; |
1059 | bool nocase:1; | |
3d4ef9a1 | 1060 | bool nohandlecache:1; /* if strange server resource prob can turn off */ |
82e9367c | 1061 | bool nodelete:1; |
95b1cb90 | 1062 | bool seal:1; /* transport encryption for this mounted share */ |
4b18f2a9 | 1063 | bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol |
c18c842b | 1064 | for this mount even if server would support */ |
b326614e | 1065 | bool posix_extensions; /* if true SMB3.11 posix extensions enabled */ |
84210e91 | 1066 | bool local_lease:1; /* check leases (only) on local system not remote */ |
64cc2c63 | 1067 | bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */ |
3d1a3745 | 1068 | bool broken_sparse_sup; /* if server or share does not support sparse */ |
3b795210 | 1069 | bool need_reconnect:1; /* connection reset, tid now invalid */ |
96a988ff | 1070 | bool need_reopen_files:1; /* need to reopen tcon file handles */ |
592fafe6 | 1071 | bool use_resilient:1; /* use resilient instead of durable handles */ |
b618f001 | 1072 | bool use_persistent:1; /* use persistent instead of durable handles */ |
3e7a02d4 | 1073 | bool no_lease:1; /* Do not request leases on files or directories */ |
b7fd0fa0 | 1074 | bool use_witness:1; /* use witness protocol */ |
769ee6a4 | 1075 | __le32 capabilities; |
faaf946a PS |
1076 | __u32 share_flags; |
1077 | __u32 maximal_access; | |
1078 | __u32 vol_serial_number; | |
1079 | __le64 vol_create_time; | |
8b217fe7 | 1080 | __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */ |
ca567eb2 | 1081 | __u32 handle_timeout; /* persistent and durable handle timeout in ms */ |
af6a12ea SF |
1082 | __u32 ss_flags; /* sector size flags */ |
1083 | __u32 perf_sector_size; /* best sector size for perf */ | |
de9f68df SF |
1084 | __u32 max_chunks; |
1085 | __u32 max_bytes_chunk; | |
1086 | __u32 max_bytes_copy; | |
d03382ce SJ |
1087 | #ifdef CONFIG_CIFS_FSCACHE |
1088 | u64 resource_id; /* server resource id */ | |
1089 | struct fscache_cookie *fscache; /* cookie for share */ | |
1090 | #endif | |
233839b1 | 1091 | struct list_head pending_opens; /* list of incomplete opens */ |
a93864d9 | 1092 | struct cached_fid crfid; /* Cached root fid */ |
c18c842b | 1093 | /* BB add field for back pointer to sb struct(s)? */ |
54be1f6c | 1094 | #ifdef CONFIG_CIFS_DFS_UPCALL |
c870a8e7 | 1095 | char *dfs_path; /* canonical DFS path */ |
54be1f6c PA |
1096 | struct list_head ulist; /* cache update list */ |
1097 | #endif | |
1da177e4 LT |
1098 | }; |
1099 | ||
7ffec372 JL |
1100 | /* |
1101 | * This is a refcounted and timestamped container for a tcon pointer. The | |
1102 | * container holds a tcon reference. It is considered safe to free one of | |
1103 | * these when the tl_count goes to 0. The tl_time is the time of the last | |
1104 | * "get" on the container. | |
1105 | */ | |
1106 | struct tcon_link { | |
b647c35f | 1107 | struct rb_node tl_rbnode; |
6d4a0832 | 1108 | kuid_t tl_uid; |
9d002df4 JL |
1109 | unsigned long tl_flags; |
1110 | #define TCON_LINK_MASTER 0 | |
1111 | #define TCON_LINK_PENDING 1 | |
1112 | #define TCON_LINK_IN_TREE 2 | |
1113 | unsigned long tl_time; | |
1114 | atomic_t tl_count; | |
96daf2b0 | 1115 | struct cifs_tcon *tl_tcon; |
7ffec372 JL |
1116 | }; |
1117 | ||
9d002df4 | 1118 | extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb); |
b2c96de7 | 1119 | extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst); |
7ffec372 | 1120 | |
96daf2b0 | 1121 | static inline struct cifs_tcon * |
7ffec372 JL |
1122 | tlink_tcon(struct tcon_link *tlink) |
1123 | { | |
9d002df4 | 1124 | return tlink->tl_tcon; |
7ffec372 JL |
1125 | } |
1126 | ||
8ddecf5f AA |
1127 | static inline struct tcon_link * |
1128 | cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb) | |
1129 | { | |
1130 | return cifs_sb->master_tlink; | |
1131 | } | |
1132 | ||
9d002df4 | 1133 | extern void cifs_put_tlink(struct tcon_link *tlink); |
7ffec372 | 1134 | |
13cfb733 JL |
1135 | static inline struct tcon_link * |
1136 | cifs_get_tlink(struct tcon_link *tlink) | |
1137 | { | |
9d002df4 JL |
1138 | if (tlink && !IS_ERR(tlink)) |
1139 | atomic_inc(&tlink->tl_count); | |
13cfb733 JL |
1140 | return tlink; |
1141 | } | |
1142 | ||
7ffec372 | 1143 | /* This function is always expected to succeed */ |
96daf2b0 | 1144 | extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb); |
7ffec372 | 1145 | |
233839b1 PS |
1146 | #define CIFS_OPLOCK_NO_CHANGE 0xfe |
1147 | ||
1148 | struct cifs_pending_open { | |
1149 | struct list_head olist; | |
1150 | struct tcon_link *tlink; | |
1151 | __u8 lease_key[16]; | |
1152 | __u32 oplock; | |
1153 | }; | |
1154 | ||
c3f207ab RS |
1155 | struct cifs_deferred_close { |
1156 | struct list_head dlist; | |
1157 | struct tcon_link *tlink; | |
1158 | __u16 netfid; | |
1159 | __u64 persistent_fid; | |
1160 | __u64 volatile_fid; | |
1161 | }; | |
1162 | ||
1da177e4 | 1163 | /* |
7ee1af76 JA |
1164 | * This info hangs off the cifsFileInfo structure, pointed to by llist. |
1165 | * This is used to track byte stream locks on the file | |
1da177e4 LT |
1166 | */ |
1167 | struct cifsLockInfo { | |
7ee1af76 | 1168 | struct list_head llist; /* pointer to next cifsLockInfo */ |
85160e03 PS |
1169 | struct list_head blist; /* pointer to locks blocked on this */ |
1170 | wait_queue_head_t block_q; | |
7ee1af76 JA |
1171 | __u64 offset; |
1172 | __u64 length; | |
03776f45 | 1173 | __u32 pid; |
9645759c RS |
1174 | __u16 type; |
1175 | __u16 flags; | |
1da177e4 LT |
1176 | }; |
1177 | ||
1178 | /* | |
1179 | * One of these for each open instance of a file | |
1180 | */ | |
1181 | struct cifs_search_info { | |
1182 | loff_t index_of_last_entry; | |
1183 | __u16 entries_in_buffer; | |
1184 | __u16 info_level; | |
1185 | __u32 resume_key; | |
d38d8c74 SF |
1186 | char *ntwrk_buf_start; |
1187 | char *srch_entries_start; | |
0752f152 | 1188 | char *last_entry; |
eaf35b1e | 1189 | const char *presume_name; |
1da177e4 | 1190 | unsigned int resume_name_len; |
4b18f2a9 SF |
1191 | bool endOfSearch:1; |
1192 | bool emptyDir:1; | |
1193 | bool unicode:1; | |
1194 | bool smallBuf:1; /* so we know which buf_release function to call */ | |
1da177e4 LT |
1195 | }; |
1196 | ||
d0959b08 | 1197 | #define ACL_NO_MODE ((umode_t)(-1)) |
226730b4 PS |
1198 | struct cifs_open_parms { |
1199 | struct cifs_tcon *tcon; | |
1200 | struct cifs_sb_info *cifs_sb; | |
1201 | int disposition; | |
1202 | int desired_access; | |
1203 | int create_options; | |
1204 | const char *path; | |
1205 | struct cifs_fid *fid; | |
ce558b0e | 1206 | umode_t mode; |
9cbc0b73 | 1207 | bool reconnect:1; |
226730b4 PS |
1208 | }; |
1209 | ||
4b4de76e PS |
1210 | struct cifs_fid { |
1211 | __u16 netfid; | |
f0df737e PS |
1212 | __u64 persistent_fid; /* persist file id for smb2 */ |
1213 | __u64 volatile_fid; /* volatile file id for smb2 */ | |
b8c32dbb | 1214 | __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */ |
b56eae4d | 1215 | __u8 create_guid[16]; |
86f740f2 | 1216 | __u32 access; |
233839b1 | 1217 | struct cifs_pending_open *pending_open; |
42873b0a | 1218 | unsigned int epoch; |
dfe33f9a SF |
1219 | #ifdef CONFIG_CIFS_DEBUG2 |
1220 | __u64 mid; | |
1221 | #endif /* CIFS_DEBUG2 */ | |
42873b0a | 1222 | bool purge_cache; |
4b4de76e PS |
1223 | }; |
1224 | ||
f45d3416 PS |
1225 | struct cifs_fid_locks { |
1226 | struct list_head llist; | |
1227 | struct cifsFileInfo *cfile; /* fid that owns locks */ | |
1228 | struct list_head locks; /* locks held by fid above */ | |
1229 | }; | |
1230 | ||
1da177e4 | 1231 | struct cifsFileInfo { |
3afca265 | 1232 | /* following two lists are protected by tcon->open_file_lock */ |
1da177e4 LT |
1233 | struct list_head tlist; /* pointer to next fid owned by tcon */ |
1234 | struct list_head flist; /* next fid (file instance) for this inode */ | |
3afca265 | 1235 | /* lock list below protected by cifsi->lock_sem */ |
f45d3416 | 1236 | struct cifs_fid_locks *llist; /* brlocks held by this fid */ |
fef59fd7 | 1237 | kuid_t uid; /* allows finding which FileInfo structure */ |
1da177e4 | 1238 | __u32 pid; /* process id who opened file */ |
4b4de76e | 1239 | struct cifs_fid fid; /* file id from remote */ |
f2cca6a7 | 1240 | struct list_head rlist; /* reconnect list */ |
1da177e4 LT |
1241 | /* BB add lock scope info here if needed */ ; |
1242 | /* lock scope id (0 if none) */ | |
a5e18bc3 | 1243 | struct dentry *dentry; |
13cfb733 | 1244 | struct tcon_link *tlink; |
3afca265 | 1245 | unsigned int f_flags; |
4b18f2a9 | 1246 | bool invalidHandle:1; /* file closed via session abend */ |
4e8aea30 | 1247 | bool swapfile:1; |
3bc303c2 | 1248 | bool oplock_break_cancelled:1; |
9bd45408 PS |
1249 | unsigned int oplock_epoch; /* epoch from the lease break */ |
1250 | __u32 oplock_level; /* oplock/lease level from the lease break */ | |
3afca265 SF |
1251 | int count; |
1252 | spinlock_t file_info_lock; /* protects four flag/count fields above */ | |
a6ce4932 | 1253 | struct mutex fh_mutex; /* prevents reopen race after dead ses*/ |
1da177e4 | 1254 | struct cifs_search_info srch_inf; |
9b646972 | 1255 | struct work_struct oplock_break; /* work for oplock breaks */ |
32546a95 | 1256 | struct work_struct put; /* work for the final part of _put */ |
c3f207ab | 1257 | struct delayed_work deferred; |
860b69a9 | 1258 | bool deferred_close_scheduled; /* Flag to indicate close is scheduled */ |
1da177e4 LT |
1259 | }; |
1260 | ||
fa2989f4 PS |
1261 | struct cifs_io_parms { |
1262 | __u16 netfid; | |
09a4707e PS |
1263 | __u64 persistent_fid; /* persist file id for smb2 */ |
1264 | __u64 volatile_fid; /* volatile file id for smb2 */ | |
fa2989f4 PS |
1265 | __u32 pid; |
1266 | __u64 offset; | |
1267 | unsigned int length; | |
96daf2b0 | 1268 | struct cifs_tcon *tcon; |
352d96f3 | 1269 | struct TCP_Server_Info *server; |
fa2989f4 PS |
1270 | }; |
1271 | ||
ccf7f408 PS |
1272 | struct cifs_aio_ctx { |
1273 | struct kref refcount; | |
1274 | struct list_head list; | |
1275 | struct mutex aio_mutex; | |
1276 | struct completion done; | |
1277 | struct iov_iter iter; | |
1278 | struct kiocb *iocb; | |
1279 | struct cifsFileInfo *cfile; | |
1280 | struct bio_vec *bv; | |
c610c4b6 | 1281 | loff_t pos; |
ccf7f408 PS |
1282 | unsigned int npages; |
1283 | ssize_t rc; | |
1284 | unsigned int len; | |
1285 | unsigned int total_len; | |
1286 | bool should_dirty; | |
6e6e2b86 LL |
1287 | /* |
1288 | * Indicates if this aio_ctx is for direct_io, | |
1289 | * If yes, iter is a copy of the user passed iov_iter | |
1290 | */ | |
1291 | bool direct_io; | |
ccf7f408 PS |
1292 | }; |
1293 | ||
09a4707e PS |
1294 | /* asynchronous read support */ |
1295 | struct cifs_readdata { | |
1296 | struct kref refcount; | |
1297 | struct list_head list; | |
1298 | struct completion done; | |
1299 | struct cifsFileInfo *cfile; | |
1300 | struct address_space *mapping; | |
6685c5e2 | 1301 | struct cifs_aio_ctx *ctx; |
09a4707e PS |
1302 | __u64 offset; |
1303 | unsigned int bytes; | |
34a54d61 | 1304 | unsigned int got_bytes; |
09a4707e PS |
1305 | pid_t pid; |
1306 | int result; | |
09a4707e | 1307 | struct work_struct work; |
8321fec4 JL |
1308 | int (*read_into_pages)(struct TCP_Server_Info *server, |
1309 | struct cifs_readdata *rdata, | |
1310 | unsigned int len); | |
d70b9104 PS |
1311 | int (*copy_into_pages)(struct TCP_Server_Info *server, |
1312 | struct cifs_readdata *rdata, | |
1313 | struct iov_iter *iter); | |
738f9de5 | 1314 | struct kvec iov[2]; |
352d96f3 | 1315 | struct TCP_Server_Info *server; |
74dcf418 LL |
1316 | #ifdef CONFIG_CIFS_SMB_DIRECT |
1317 | struct smbd_mr *mr; | |
1318 | #endif | |
8321fec4 | 1319 | unsigned int pagesz; |
57a929a6 | 1320 | unsigned int page_offset; |
8321fec4 | 1321 | unsigned int tailsz; |
335b7b62 | 1322 | struct cifs_credits credits; |
c5fab6f4 | 1323 | unsigned int nr_pages; |
f9f5aca1 | 1324 | struct page **pages; |
09a4707e PS |
1325 | }; |
1326 | ||
33319141 PS |
1327 | /* asynchronous write support */ |
1328 | struct cifs_writedata { | |
1329 | struct kref refcount; | |
1330 | struct list_head list; | |
1331 | struct completion done; | |
1332 | enum writeback_sync_modes sync_mode; | |
1333 | struct work_struct work; | |
1334 | struct cifsFileInfo *cfile; | |
c610c4b6 | 1335 | struct cifs_aio_ctx *ctx; |
33319141 PS |
1336 | __u64 offset; |
1337 | pid_t pid; | |
1338 | unsigned int bytes; | |
1339 | int result; | |
352d96f3 | 1340 | struct TCP_Server_Info *server; |
db223a59 LL |
1341 | #ifdef CONFIG_CIFS_SMB_DIRECT |
1342 | struct smbd_mr *mr; | |
1343 | #endif | |
eddb079d | 1344 | unsigned int pagesz; |
57a929a6 | 1345 | unsigned int page_offset; |
eddb079d | 1346 | unsigned int tailsz; |
335b7b62 | 1347 | struct cifs_credits credits; |
33319141 | 1348 | unsigned int nr_pages; |
8e7360f6 | 1349 | struct page **pages; |
33319141 PS |
1350 | }; |
1351 | ||
5f6dbc9e JL |
1352 | /* |
1353 | * Take a reference on the file private data. Must be called with | |
3afca265 | 1354 | * cfile->file_info_lock held. |
5f6dbc9e | 1355 | */ |
764a1b1a JL |
1356 | static inline void |
1357 | cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file) | |
6ab409b5 | 1358 | { |
5f6dbc9e | 1359 | ++cifs_file->count; |
6ab409b5 DK |
1360 | } |
1361 | ||
764a1b1a | 1362 | struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file); |
32546a95 RS |
1363 | void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr, |
1364 | bool offload); | |
b33879aa | 1365 | void cifsFileInfo_put(struct cifsFileInfo *cifs_file); |
6ab409b5 | 1366 | |
18cceb6a PS |
1367 | #define CIFS_CACHE_READ_FLG 1 |
1368 | #define CIFS_CACHE_HANDLE_FLG 2 | |
42873b0a | 1369 | #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG) |
18cceb6a | 1370 | #define CIFS_CACHE_WRITE_FLG 4 |
42873b0a PS |
1371 | #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG) |
1372 | #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG) | |
18cceb6a | 1373 | |
83bbfa70 | 1374 | #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)) |
53ef1016 | 1375 | #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG) |
41e033fe | 1376 | #define CIFS_CACHE_WRITE(cinode) ((cinode->oplock & CIFS_CACHE_WRITE_FLG) || (CIFS_SB(cinode->vfs_inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RW_CACHE)) |
18cceb6a | 1377 | |
1da177e4 LT |
1378 | /* |
1379 | * One of these for each file inode | |
1380 | */ | |
1381 | ||
1382 | struct cifsInodeInfo { | |
d59dad2b | 1383 | bool can_cache_brlcks; |
f45d3416 | 1384 | struct list_head llist; /* locks helb by this inode */ |
d46b0da7 DW |
1385 | /* |
1386 | * NOTE: Some code paths call down_read(lock_sem) twice, so | |
a03f507d | 1387 | * we must always use cifs_down_write() instead of down_write() |
d46b0da7 DW |
1388 | * for this semaphore to avoid deadlocks. |
1389 | */ | |
1b4b55a1 | 1390 | struct rw_semaphore lock_sem; /* protect the fields above */ |
d38d8c74 | 1391 | /* BB add in lists for dirty pages i.e. write caching info for oplock */ |
1da177e4 | 1392 | struct list_head openFileList; |
487317c9 | 1393 | spinlock_t open_file_lock; /* protects openFileList */ |
1da177e4 | 1394 | __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */ |
18cceb6a | 1395 | unsigned int oplock; /* oplock/lease level we have */ |
42873b0a | 1396 | unsigned int epoch; /* used to track lease state changes */ |
c11f1df5 SP |
1397 | #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */ |
1398 | #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */ | |
9bd45408 | 1399 | #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */ |
aff8d5ca JL |
1400 | #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */ |
1401 | #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */ | |
4f73c7d3 | 1402 | #define CIFS_INO_LOCK (5) /* lock bit for synchronization */ |
c3f207ab | 1403 | #define CIFS_INO_MODIFIED_ATTR (6) /* Indicate change in mtime/ctime */ |
35866f3f | 1404 | #define CIFS_INO_CLOSE_ON_LOCK (7) /* Not to defer the close when lock is set */ |
aff8d5ca | 1405 | unsigned long flags; |
c11f1df5 SP |
1406 | spinlock_t writers_lock; |
1407 | unsigned int writers; /* Number of writers on this inode */ | |
aae62fdb | 1408 | unsigned long time; /* jiffies of last update of inode */ |
597b027f | 1409 | u64 server_eof; /* current file size on server -- protected by i_lock */ |
cc0bad75 | 1410 | u64 uniqueid; /* server inode number */ |
20054bd6 | 1411 | u64 createtime; /* creation time on server */ |
b8c32dbb | 1412 | __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */ |
9451a9a5 SJ |
1413 | #ifdef CONFIG_CIFS_FSCACHE |
1414 | struct fscache_cookie *fscache; | |
1415 | #endif | |
1da177e4 | 1416 | struct inode vfs_inode; |
c3f207ab RS |
1417 | struct list_head deferred_closes; /* list of deferred closes */ |
1418 | spinlock_t deferred_lock; /* protection on deferred list */ | |
0ab95c25 | 1419 | bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */ |
1da177e4 LT |
1420 | }; |
1421 | ||
1422 | static inline struct cifsInodeInfo * | |
1423 | CIFS_I(struct inode *inode) | |
1424 | { | |
1425 | return container_of(inode, struct cifsInodeInfo, vfs_inode); | |
1426 | } | |
1427 | ||
1428 | static inline struct cifs_sb_info * | |
1429 | CIFS_SB(struct super_block *sb) | |
1430 | { | |
1431 | return sb->s_fs_info; | |
1432 | } | |
1433 | ||
7119e220 AV |
1434 | static inline struct cifs_sb_info * |
1435 | CIFS_FILE_SB(struct file *file) | |
1436 | { | |
1437 | return CIFS_SB(file_inode(file)->i_sb); | |
1438 | } | |
1439 | ||
ab2f218f | 1440 | static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb) |
ac67055e JA |
1441 | { |
1442 | if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS) | |
1443 | return '/'; | |
1444 | else | |
1445 | return '\\'; | |
1446 | } | |
1da177e4 | 1447 | |
f87d39d9 SF |
1448 | static inline void |
1449 | convert_delimiter(char *path, char delim) | |
1450 | { | |
1cc9bd68 | 1451 | char old_delim, *pos; |
f87d39d9 SF |
1452 | |
1453 | if (delim == '/') | |
1454 | old_delim = '\\'; | |
1455 | else | |
1456 | old_delim = '/'; | |
1457 | ||
1cc9bd68 SF |
1458 | pos = path; |
1459 | while ((pos = strchr(pos, old_delim))) | |
1460 | *pos = delim; | |
f87d39d9 SF |
1461 | } |
1462 | ||
a4544347 SF |
1463 | #define cifs_stats_inc atomic_inc |
1464 | ||
96daf2b0 | 1465 | static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon, |
a4544347 SF |
1466 | unsigned int bytes) |
1467 | { | |
1468 | if (bytes) { | |
1469 | spin_lock(&tcon->stat_lock); | |
1470 | tcon->bytes_written += bytes; | |
1471 | spin_unlock(&tcon->stat_lock); | |
1472 | } | |
1473 | } | |
1474 | ||
96daf2b0 | 1475 | static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon, |
a4544347 SF |
1476 | unsigned int bytes) |
1477 | { | |
1478 | spin_lock(&tcon->stat_lock); | |
1479 | tcon->bytes_read += bytes; | |
1480 | spin_unlock(&tcon->stat_lock); | |
1481 | } | |
a4544347 | 1482 | |
2b84a36c JL |
1483 | |
1484 | /* | |
44d22d84 JL |
1485 | * This is the prototype for the mid receive function. This function is for |
1486 | * receiving the rest of the SMB frame, starting with the WordCount (which is | |
1487 | * just after the MID in struct smb_hdr). Note: | |
1488 | * | |
1489 | * - This will be called by cifsd, with no locks held. | |
1490 | * - The mid will still be on the pending_mid_q. | |
1491 | * - mid->resp_buf will point to the current buffer. | |
1492 | * | |
1493 | * Returns zero on a successful receive, or an error. The receive state in | |
1494 | * the TCP_Server_Info will also be updated. | |
1495 | */ | |
1496 | typedef int (mid_receive_t)(struct TCP_Server_Info *server, | |
1497 | struct mid_q_entry *mid); | |
1498 | ||
1499 | /* | |
1500 | * This is the prototype for the mid callback function. This is called once the | |
1501 | * mid has been received off of the socket. When creating one, take special | |
1502 | * care to avoid deadlocks. Things to bear in mind: | |
2b84a36c | 1503 | * |
3c1105df JL |
1504 | * - it will be called by cifsd, with no locks held |
1505 | * - the mid will be removed from any lists | |
2b84a36c JL |
1506 | */ |
1507 | typedef void (mid_callback_t)(struct mid_q_entry *mid); | |
1508 | ||
9b7c18a2 PS |
1509 | /* |
1510 | * This is the protopyte for mid handle function. This is called once the mid | |
1511 | * has been recognized after decryption of the message. | |
1512 | */ | |
1513 | typedef int (mid_handle_t)(struct TCP_Server_Info *server, | |
1514 | struct mid_q_entry *mid); | |
1515 | ||
1da177e4 LT |
1516 | /* one of these for every pending CIFS request to the server */ |
1517 | struct mid_q_entry { | |
1518 | struct list_head qhead; /* mids waiting on reply from this server */ | |
696e420b | 1519 | struct kref refcount; |
2dc7e1c0 | 1520 | struct TCP_Server_Info *server; /* server corresponding to this mid */ |
7c9421e1 | 1521 | __u64 mid; /* multiplex id */ |
c781af7e | 1522 | __u16 credits; /* number of credits consumed by this mid */ |
86a7964b | 1523 | __u16 credits_received; /* number of credits from the response */ |
7c9421e1 | 1524 | __u32 pid; /* process id */ |
1da177e4 | 1525 | __u32 sequence_number; /* for CIFS signing */ |
1047abc1 SF |
1526 | unsigned long when_alloc; /* when mid was created */ |
1527 | #ifdef CONFIG_CIFS_STATS2 | |
1528 | unsigned long when_sent; /* time when smb send finished */ | |
1529 | unsigned long when_received; /* when demux complete (taken off wire) */ | |
1530 | #endif | |
44d22d84 | 1531 | mid_receive_t *receive; /* call receive callback */ |
2b84a36c | 1532 | mid_callback_t *callback; /* call completion callback */ |
9b7c18a2 | 1533 | mid_handle_t *handle; /* call handle mid callback */ |
2b84a36c | 1534 | void *callback_data; /* general purpose pointer for callback */ |
f1f27ad7 | 1535 | struct task_struct *creator; |
d4e4854f | 1536 | void *resp_buf; /* pointer to received SMB header */ |
e19b2bc0 | 1537 | unsigned int resp_buf_size; |
7c9421e1 | 1538 | int mid_state; /* wish this were enum but can not pass to wait_event */ |
38bd4906 | 1539 | unsigned int mid_flags; |
7c9421e1 | 1540 | __le16 command; /* smb command code */ |
8a26f0f7 | 1541 | unsigned int optype; /* operation type */ |
7c9421e1 | 1542 | bool large_buf:1; /* if valid response, is pointer to large buf */ |
4b18f2a9 SF |
1543 | bool multiRsp:1; /* multiple trans2 responses for one request */ |
1544 | bool multiEnd:1; /* both received */ | |
4326ed2f | 1545 | bool decrypted:1; /* decrypted entry */ |
1da177e4 LT |
1546 | }; |
1547 | ||
38bd4906 SP |
1548 | struct close_cancelled_open { |
1549 | struct cifs_fid fid; | |
1550 | struct cifs_tcon *tcon; | |
1551 | struct work_struct work; | |
87bc2376 RS |
1552 | __u64 mid; |
1553 | __u16 cmd; | |
38bd4906 SP |
1554 | }; |
1555 | ||
789e6661 SF |
1556 | /* Make code in transport.c a little cleaner by moving |
1557 | update of optional stats into function below */ | |
789e6661 SF |
1558 | static inline void cifs_in_send_inc(struct TCP_Server_Info *server) |
1559 | { | |
1560 | atomic_inc(&server->in_send); | |
1561 | } | |
1562 | ||
1563 | static inline void cifs_in_send_dec(struct TCP_Server_Info *server) | |
1564 | { | |
1565 | atomic_dec(&server->in_send); | |
1566 | } | |
1567 | ||
1568 | static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server) | |
1569 | { | |
1570 | atomic_inc(&server->num_waiters); | |
1571 | } | |
1572 | ||
1573 | static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server) | |
1574 | { | |
1575 | atomic_dec(&server->num_waiters); | |
1576 | } | |
1577 | ||
1ae9a5a5 | 1578 | #ifdef CONFIG_CIFS_STATS2 |
789e6661 SF |
1579 | static inline void cifs_save_when_sent(struct mid_q_entry *mid) |
1580 | { | |
1581 | mid->when_sent = jiffies; | |
1582 | } | |
1583 | #else | |
789e6661 SF |
1584 | static inline void cifs_save_when_sent(struct mid_q_entry *mid) |
1585 | { | |
1586 | } | |
1587 | #endif | |
1da177e4 | 1588 | |
ff5dbd9e SF |
1589 | /* for pending dnotify requests */ |
1590 | struct dir_notify_req { | |
13cd4b7f SF |
1591 | struct list_head lhead; |
1592 | __le16 Pid; | |
1593 | __le16 PidHigh; | |
1594 | __u16 Mid; | |
1595 | __u16 Tid; | |
1596 | __u16 Uid; | |
1597 | __u16 netfid; | |
1598 | __u32 filter; /* CompletionFilter (for multishot) */ | |
1599 | int multishot; | |
1600 | struct file *pfile; | |
ff5dbd9e SF |
1601 | }; |
1602 | ||
366781c1 SF |
1603 | struct dfs_info3_param { |
1604 | int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/ | |
8aad018b | 1605 | int path_consumed; |
366781c1 SF |
1606 | int server_type; |
1607 | int ref_flag; | |
1608 | char *path_name; | |
1609 | char *node_name; | |
e7b602f4 | 1610 | int ttl; |
366781c1 SF |
1611 | }; |
1612 | ||
9e992755 RS |
1613 | struct file_list { |
1614 | struct list_head list; | |
1615 | struct cifsFileInfo *cfile; | |
1616 | }; | |
1617 | ||
cc0bad75 JL |
1618 | /* |
1619 | * common struct for holding inode info when searching for or updating an | |
1620 | * inode with new info | |
1621 | */ | |
1622 | ||
1623 | #define CIFS_FATTR_DFS_REFERRAL 0x1 | |
0b8f18e3 JL |
1624 | #define CIFS_FATTR_DELETE_PENDING 0x2 |
1625 | #define CIFS_FATTR_NEED_REVAL 0x4 | |
3d694380 | 1626 | #define CIFS_FATTR_INO_COLLISION 0x8 |
74d290da | 1627 | #define CIFS_FATTR_UNKNOWN_NLINK 0x10 |
7ea884c7 | 1628 | #define CIFS_FATTR_FAKE_ROOT_INO 0x20 |
cc0bad75 JL |
1629 | |
1630 | struct cifs_fattr { | |
1631 | u32 cf_flags; | |
1632 | u32 cf_cifsattrs; | |
1633 | u64 cf_uniqueid; | |
1634 | u64 cf_eof; | |
1635 | u64 cf_bytes; | |
20054bd6 | 1636 | u64 cf_createtime; |
4a2c8cf5 EB |
1637 | kuid_t cf_uid; |
1638 | kgid_t cf_gid; | |
cc0bad75 JL |
1639 | umode_t cf_mode; |
1640 | dev_t cf_rdev; | |
1641 | unsigned int cf_nlink; | |
1642 | unsigned int cf_dtype; | |
95390201 AB |
1643 | struct timespec64 cf_atime; |
1644 | struct timespec64 cf_mtime; | |
1645 | struct timespec64 cf_ctime; | |
046aca3c | 1646 | u32 cf_cifstag; |
cc0bad75 JL |
1647 | }; |
1648 | ||
366781c1 SF |
1649 | static inline void free_dfs_info_param(struct dfs_info3_param *param) |
1650 | { | |
1651 | if (param) { | |
1652 | kfree(param->path_name); | |
1653 | kfree(param->node_name); | |
366781c1 SF |
1654 | } |
1655 | } | |
1656 | ||
1657 | static inline void free_dfs_info_array(struct dfs_info3_param *param, | |
1658 | int number_of_items) | |
1659 | { | |
1660 | int i; | |
1661 | if ((number_of_items == 0) || (param == NULL)) | |
1662 | return; | |
1663 | for (i = 0; i < number_of_items; i++) { | |
1664 | kfree(param[i].path_name); | |
1665 | kfree(param[i].node_name); | |
1666 | } | |
1667 | kfree(param); | |
1668 | } | |
1669 | ||
9a66396f PS |
1670 | static inline bool is_interrupt_error(int error) |
1671 | { | |
1672 | switch (error) { | |
1673 | case -EINTR: | |
1674 | case -ERESTARTSYS: | |
1675 | case -ERESTARTNOHAND: | |
1676 | case -ERESTARTNOINTR: | |
1677 | return true; | |
1678 | } | |
1679 | return false; | |
1680 | } | |
1681 | ||
1682 | static inline bool is_retryable_error(int error) | |
1683 | { | |
1684 | if (is_interrupt_error(error) || error == -EAGAIN) | |
1685 | return true; | |
1686 | return false; | |
1687 | } | |
1688 | ||
86f740f2 AA |
1689 | |
1690 | /* cifs_get_writable_file() flags */ | |
1691 | #define FIND_WR_ANY 0 | |
1692 | #define FIND_WR_FSUID_ONLY 1 | |
1693 | #define FIND_WR_WITH_DELETE 2 | |
1694 | ||
1da177e4 LT |
1695 | #define MID_FREE 0 |
1696 | #define MID_REQUEST_ALLOCATED 1 | |
1697 | #define MID_REQUEST_SUBMITTED 2 | |
1698 | #define MID_RESPONSE_RECEIVED 4 | |
1699 | #define MID_RETRY_NEEDED 8 /* session closed while this request out */ | |
71823baf | 1700 | #define MID_RESPONSE_MALFORMED 0x10 |
3c1105df | 1701 | #define MID_SHUTDOWN 0x20 |
ec637e3f | 1702 | |
38bd4906 SP |
1703 | /* Flags */ |
1704 | #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */ | |
ddf83afb | 1705 | #define MID_DELETED 2 /* Mid has been dequeued/deleted */ |
38bd4906 | 1706 | |
ec637e3f SF |
1707 | /* Types of response buffer returned from SendReceive2 */ |
1708 | #define CIFS_NO_BUFFER 0 /* Response buffer not returned */ | |
1709 | #define CIFS_SMALL_BUFFER 1 | |
1710 | #define CIFS_LARGE_BUFFER 2 | |
1711 | #define CIFS_IOVEC 4 /* array of response buffers */ | |
1da177e4 | 1712 | |
133672ef | 1713 | /* Type of Request to SendReceive2 */ |
7749981e | 1714 | #define CIFS_BLOCKING_OP 1 /* operation can block */ |
392e1c5d | 1715 | #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */ |
7749981e | 1716 | #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */ |
133672ef SF |
1717 | #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */ |
1718 | #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */ | |
392e1c5d | 1719 | #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */ |
133672ef | 1720 | |
a891f0f8 | 1721 | /* Type of request operation */ |
04ad69c3 PA |
1722 | #define CIFS_ECHO_OP 0x080 /* echo request */ |
1723 | #define CIFS_OBREAK_OP 0x0100 /* oplock break request */ | |
1724 | #define CIFS_NEG_OP 0x0200 /* negotiate request */ | |
1725 | #define CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */ | |
0f56db83 | 1726 | /* Lower bitmask values are reserved by others below. */ |
04ad69c3 PA |
1727 | #define CIFS_SESS_OP 0x2000 /* session setup request */ |
1728 | #define CIFS_OP_MASK 0x2780 /* mask request type */ | |
7fb8986e | 1729 | |
04ad69c3 PA |
1730 | #define CIFS_HAS_CREDITS 0x0400 /* already has credits */ |
1731 | #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */ | |
1732 | #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */ | |
a891f0f8 | 1733 | |
3979877e SF |
1734 | /* Security Flags: indicate type of session setup needed */ |
1735 | #define CIFSSEC_MAY_SIGN 0x00001 | |
3979877e SF |
1736 | #define CIFSSEC_MAY_NTLMV2 0x00004 |
1737 | #define CIFSSEC_MAY_KRB5 0x00008 | |
3979877e | 1738 | #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */ |
ac683924 | 1739 | #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */ |
3979877e SF |
1740 | |
1741 | #define CIFSSEC_MUST_SIGN 0x01001 | |
1742 | /* note that only one of the following can be set so the | |
1743 | result of setting MUST flags more than once will be to | |
1744 | require use of the stronger protocol */ | |
3979877e SF |
1745 | #define CIFSSEC_MUST_NTLMV2 0x04004 |
1746 | #define CIFSSEC_MUST_KRB5 0x08008 | |
0d3a01fa | 1747 | #ifdef CONFIG_CIFS_UPCALL |
ac683924 | 1748 | #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */ |
d38d8c74 | 1749 | #else |
ac683924 | 1750 | #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */ |
016ec75f | 1751 | #endif /* UPCALL */ |
3979877e | 1752 | #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */ |
ac683924 | 1753 | #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */ |
3979877e | 1754 | |
896a8fc2 | 1755 | #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP) |
76a3c92e RS |
1756 | #define CIFSSEC_MAX (CIFSSEC_MUST_NTLMV2) |
1757 | #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP) | |
1da177e4 LT |
1758 | /* |
1759 | ***************************************************************** | |
1760 | * All constants go here | |
1761 | ***************************************************************** | |
1762 | */ | |
1763 | ||
1764 | #define UID_HASH (16) | |
1765 | ||
1766 | /* | |
1767 | * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the | |
1768 | * following to be declared. | |
1769 | */ | |
1770 | ||
1771 | /**************************************************************************** | |
1772 | * Locking notes. All updates to global variables and lists should be | |
1773 | * protected by spinlocks or semaphores. | |
1774 | * | |
1775 | * Spinlocks | |
1776 | * --------- | |
1777 | * GlobalMid_Lock protects: | |
1778 | * list operations on pending_mid_q and oplockQ | |
1779 | * updates to XID counters, multiplex id and SMB sequence numbers | |
65525802 | 1780 | * list operations on global DnotifyReqList |
01cf3082 | 1781 | * updates to ses->status and TCP_Server_Info->tcpStatus |
0fa757b5 | 1782 | * updates to server->CurrentMid |
3afca265 SF |
1783 | * tcp_ses_lock protects: |
1784 | * list operations on tcp and SMB session lists | |
1785 | * tcon->open_file_lock protects the list of open files hanging off the tcon | |
487317c9 | 1786 | * inode->open_file_lock protects the openFileList hanging off the inode |
3afca265 | 1787 | * cfile->file_info_lock protects counters and fields in cifs file struct |
1da177e4 LT |
1788 | * f_owner.lock protects certain per file struct operations |
1789 | * mapping->page_lock protects certain per page operations | |
1790 | * | |
487317c9 RS |
1791 | * Note that the cifs_tcon.open_file_lock should be taken before |
1792 | * not after the cifsInodeInfo.open_file_lock | |
1793 | * | |
1da177e4 LT |
1794 | * Semaphores |
1795 | * ---------- | |
edc9dd1e SF |
1796 | * cifsInodeInfo->lock_sem protects: |
1797 | * the list of locks held by the inode | |
1da177e4 LT |
1798 | * |
1799 | ****************************************************************************/ | |
1800 | ||
1801 | #ifdef DECLARE_GLOBALS_HERE | |
1802 | #define GLOBAL_EXTERN | |
1803 | #else | |
1804 | #define GLOBAL_EXTERN extern | |
1805 | #endif | |
1806 | ||
e7ddee90 JL |
1807 | /* |
1808 | * the list of TCP_Server_Info structures, ie each of the sockets | |
fb396016 | 1809 | * connecting our client to a distinct server (ip address), is |
e7ddee90 | 1810 | * chained together by cifs_tcp_ses_list. The list of all our SMB |
fb396016 | 1811 | * sessions (and from that the tree connections) can be found |
e7ddee90 JL |
1812 | * by iterating over cifs_tcp_ses_list |
1813 | */ | |
1814 | GLOBAL_EXTERN struct list_head cifs_tcp_ses_list; | |
1815 | ||
f1987b44 JL |
1816 | /* |
1817 | * This lock protects the cifs_tcp_ses_list, the list of smb sessions per | |
1818 | * tcp session, and the list of tcon's per smb session. It also protects | |
d92c7ce4 SF |
1819 | * the reference counters for the server, smb session, and tcon. It also |
1820 | * protects some fields in the TCP_Server_Info struct such as dstaddr. Finally, | |
f1987b44 | 1821 | * changes to the tcon->tidStatus should be done while holding this lock. |
3afca265 SF |
1822 | * generally the locks should be taken in order tcp_ses_lock before |
1823 | * tcon->open_file_lock and that before file->file_info_lock since the | |
1824 | * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file | |
f1987b44 | 1825 | */ |
3f9bcca7 | 1826 | GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock; |
ddb4cbfc | 1827 | |
1da177e4 LT |
1828 | /* |
1829 | * Global transaction id (XID) information | |
1830 | */ | |
1831 | GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */ | |
254e55ed | 1832 | GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */ |
1da177e4 | 1833 | GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */ |
254e55ed SF |
1834 | GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */ |
1835 | /* on midQ entries */ | |
1da177e4 LT |
1836 | /* |
1837 | * Global counters, updated atomically | |
1838 | */ | |
1839 | GLOBAL_EXTERN atomic_t sesInfoAllocCount; | |
1840 | GLOBAL_EXTERN atomic_t tconInfoAllocCount; | |
6d82c27a | 1841 | GLOBAL_EXTERN atomic_t tcpSesNextId; |
1da177e4 LT |
1842 | GLOBAL_EXTERN atomic_t tcpSesAllocCount; |
1843 | GLOBAL_EXTERN atomic_t tcpSesReconnectCount; | |
1844 | GLOBAL_EXTERN atomic_t tconInfoReconnectCount; | |
1845 | ||
aaa9bbe0 | 1846 | /* Various Debug counters */ |
4498eed5 SF |
1847 | GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */ |
1848 | #ifdef CONFIG_CIFS_STATS2 | |
1849 | GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */ | |
1850 | GLOBAL_EXTERN atomic_t totSmBufAllocCount; | |
00778e22 | 1851 | extern unsigned int slow_rsp_threshold; /* number of secs before logging */ |
4498eed5 SF |
1852 | #endif |
1853 | GLOBAL_EXTERN atomic_t smBufAllocCount; | |
1da177e4 LT |
1854 | GLOBAL_EXTERN atomic_t midCount; |
1855 | ||
1856 | /* Misc globals */ | |
f92a720e SF |
1857 | extern bool enable_oplocks; /* enable or disable oplocks */ |
1858 | extern bool lookupCacheEnabled; | |
1859 | extern unsigned int global_secflags; /* if on, session setup sent | |
1da177e4 | 1860 | with more secure ntlmssp2 challenge/resp */ |
f92a720e | 1861 | extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */ |
29e27923 | 1862 | extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */ |
fbfd0b46 | 1863 | extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */ |
53d31a3f | 1864 | extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */ |
f92a720e SF |
1865 | extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/ |
1866 | extern unsigned int CIFSMaxBufSize; /* max size not including hdr */ | |
1867 | extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */ | |
1868 | extern unsigned int cifs_min_small; /* min size of small buf pool */ | |
1869 | extern unsigned int cifs_max_pending; /* MAX requests at once to server*/ | |
1870 | extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */ | |
1da177e4 | 1871 | |
9b646972 | 1872 | void cifs_oplock_break(struct work_struct *work); |
b98749ca | 1873 | void cifs_queue_oplock_break(struct cifsFileInfo *cfile); |
c3f207ab | 1874 | void smb2_deferred_work_close(struct work_struct *work); |
3b7433b8 | 1875 | |
c3f207ab | 1876 | extern const struct slow_work_ops cifs_oplock_break_ops; |
da472fc8 | 1877 | extern struct workqueue_struct *cifsiod_wq; |
35cf94a3 | 1878 | extern struct workqueue_struct *decrypt_wq; |
32546a95 | 1879 | extern struct workqueue_struct *fileinfo_put_wq; |
3998e6b8 | 1880 | extern struct workqueue_struct *cifsoplockd_wq; |
c3f207ab | 1881 | extern struct workqueue_struct *deferredclose_wq; |
3d22462a | 1882 | extern __u32 cifs_lock_secret; |
abd2e44d | 1883 | |
2dc7e1c0 PS |
1884 | extern mempool_t *cifs_mid_poolp; |
1885 | ||
23db65f5 JL |
1886 | /* Operations for different SMB versions */ |
1887 | #define SMB1_VERSION_STRING "1.0" | |
1888 | extern struct smb_version_operations smb1_operations; | |
1889 | extern struct smb_version_values smb1_values; | |
e4aa25e7 | 1890 | #define SMB20_VERSION_STRING "2.0" |
53ef1016 | 1891 | extern struct smb_version_operations smb20_operations; |
e4aa25e7 | 1892 | extern struct smb_version_values smb20_values; |
1080ef75 SF |
1893 | #define SMB21_VERSION_STRING "2.1" |
1894 | extern struct smb_version_operations smb21_operations; | |
1895 | extern struct smb_version_values smb21_values; | |
9764c02f SF |
1896 | #define SMBDEFAULT_VERSION_STRING "default" |
1897 | extern struct smb_version_values smbdefault_values; | |
1898 | #define SMB3ANY_VERSION_STRING "3" | |
1899 | extern struct smb_version_values smb3any_values; | |
e4aa25e7 | 1900 | #define SMB30_VERSION_STRING "3.0" |
38107d45 | 1901 | extern struct smb_version_operations smb30_operations; |
e4aa25e7 | 1902 | extern struct smb_version_values smb30_values; |
20b6d8b4 | 1903 | #define SMB302_VERSION_STRING "3.02" |
4a3b38ae | 1904 | #define ALT_SMB302_VERSION_STRING "3.0.2" |
20b6d8b4 SF |
1905 | /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */ |
1906 | extern struct smb_version_values smb302_values; | |
5f7fbf73 | 1907 | #define SMB311_VERSION_STRING "3.1.1" |
aab1893d SF |
1908 | #define ALT_SMB311_VERSION_STRING "3.11" |
1909 | extern struct smb_version_operations smb311_operations; | |
5f7fbf73 | 1910 | extern struct smb_version_values smb311_values; |
b8f7442b | 1911 | |
0b0430c6 K |
1912 | static inline char *get_security_type_str(enum securityEnum sectype) |
1913 | { | |
1914 | switch (sectype) { | |
1915 | case RawNTLMSSP: | |
1916 | return "RawNTLMSSP"; | |
1917 | case Kerberos: | |
1918 | return "Kerberos"; | |
1919 | case NTLMv2: | |
1920 | return "NTLMv2"; | |
0b0430c6 K |
1921 | default: |
1922 | return "Unknown"; | |
1923 | } | |
1924 | } | |
1925 | ||
b8f7442b AA |
1926 | static inline bool is_smb1_server(struct TCP_Server_Info *server) |
1927 | { | |
1928 | return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0; | |
1929 | } | |
1930 | ||
e183785f PA |
1931 | static inline bool is_tcon_dfs(struct cifs_tcon *tcon) |
1932 | { | |
1933 | /* | |
1934 | * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS | |
1935 | * Subsystem Notifies That a Share Is a DFS Share. | |
1936 | * | |
1937 | * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server | |
1938 | * Application Updates a Share. | |
1939 | */ | |
1940 | if (!tcon || !tcon->ses || !tcon->ses->server) | |
1941 | return false; | |
1942 | return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS : | |
1943 | tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT); | |
1944 | } | |
1945 | ||
abd2e44d | 1946 | #endif /* _CIFS_GLOB_H */ |