CIFS: complete PDU definitions for interface queries
[linux-2.6-block.git] / fs / cifs / misc.c
CommitLineData
1da177e4
LT
1/*
2 * fs/cifs/misc.c
3 *
ad7a2926 4 * Copyright (C) International Business Machines Corp., 2002,2008
1da177e4
LT
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 *
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published
9 * by the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
15 * the GNU Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software
fb8c4b14 19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1da177e4
LT
20 */
21
22#include <linux/slab.h>
23#include <linux/ctype.h>
24#include <linux/mempool.h>
ccf7f408 25#include <linux/vmalloc.h>
1da177e4
LT
26#include "cifspdu.h"
27#include "cifsglob.h"
28#include "cifsproto.h"
29#include "cifs_debug.h"
30#include "smberr.h"
31#include "nterr.h"
6c91d362 32#include "cifs_unicode.h"
3792c173 33#include "smb2pdu.h"
1da177e4
LT
34
35extern mempool_t *cifs_sm_req_poolp;
36extern mempool_t *cifs_req_poolp;
1da177e4 37
fb8c4b14
SF
38/* The xid serves as a useful identifier for each incoming vfs request,
39 in a similar way to the mid which is useful to track each sent smb,
40 and CurrentXid can also provide a running counter (although it
41 will eventually wrap past zero) of the total vfs operations handled
1da177e4
LT
42 since the cifs fs was mounted */
43
44unsigned int
6d5786a3 45_get_xid(void)
1da177e4
LT
46{
47 unsigned int xid;
48
49 spin_lock(&GlobalMid_Lock);
50 GlobalTotalActiveXid++;
50c2f753
SF
51
52 /* keep high water mark for number of simultaneous ops in filesystem */
1da177e4 53 if (GlobalTotalActiveXid > GlobalMaxActiveXid)
50c2f753 54 GlobalMaxActiveXid = GlobalTotalActiveXid;
790fe579 55 if (GlobalTotalActiveXid > 65000)
f96637be 56 cifs_dbg(FYI, "warning: more than 65000 requests active\n");
1da177e4
LT
57 xid = GlobalCurrentXid++;
58 spin_unlock(&GlobalMid_Lock);
59 return xid;
60}
61
62void
6d5786a3 63_free_xid(unsigned int xid)
1da177e4
LT
64{
65 spin_lock(&GlobalMid_Lock);
790fe579 66 /* if (GlobalTotalActiveXid == 0)
1da177e4
LT
67 BUG(); */
68 GlobalTotalActiveXid--;
69 spin_unlock(&GlobalMid_Lock);
70}
71
96daf2b0 72struct cifs_ses *
1da177e4
LT
73sesInfoAlloc(void)
74{
96daf2b0 75 struct cifs_ses *ret_buf;
1da177e4 76
96daf2b0 77 ret_buf = kzalloc(sizeof(struct cifs_ses), GFP_KERNEL);
1da177e4 78 if (ret_buf) {
1da177e4
LT
79 atomic_inc(&sesInfoAllocCount);
80 ret_buf->status = CifsNew;
14fbf50d
JL
81 ++ret_buf->ses_count;
82 INIT_LIST_HEAD(&ret_buf->smb_ses_list);
f1987b44 83 INIT_LIST_HEAD(&ret_buf->tcon_list);
d7b619cf 84 mutex_init(&ret_buf->session_mutex);
1da177e4
LT
85 }
86 return ret_buf;
87}
88
89void
96daf2b0 90sesInfoFree(struct cifs_ses *buf_to_free)
1da177e4
LT
91{
92 if (buf_to_free == NULL) {
f96637be 93 cifs_dbg(FYI, "Null buffer passed to sesInfoFree\n");
1da177e4
LT
94 return;
95 }
96
1da177e4 97 atomic_dec(&sesInfoAllocCount);
f99d49ad
JJ
98 kfree(buf_to_free->serverOS);
99 kfree(buf_to_free->serverDomain);
100 kfree(buf_to_free->serverNOS);
97f4b727 101 kzfree(buf_to_free->password);
8727c8a8 102 kfree(buf_to_free->user_name);
3979877e 103 kfree(buf_to_free->domainName);
97f4b727
AA
104 kzfree(buf_to_free->auth_key.response);
105 kzfree(buf_to_free);
1da177e4
LT
106}
107
96daf2b0 108struct cifs_tcon *
1da177e4
LT
109tconInfoAlloc(void)
110{
96daf2b0
SF
111 struct cifs_tcon *ret_buf;
112 ret_buf = kzalloc(sizeof(struct cifs_tcon), GFP_KERNEL);
1da177e4 113 if (ret_buf) {
1da177e4 114 atomic_inc(&tconInfoAllocCount);
1da177e4 115 ret_buf->tidStatus = CifsNew;
f1987b44 116 ++ret_buf->tc_count;
1da177e4 117 INIT_LIST_HEAD(&ret_buf->openFileList);
f1987b44 118 INIT_LIST_HEAD(&ret_buf->tcon_list);
3afca265 119 spin_lock_init(&ret_buf->open_file_lock);
a93864d9
RS
120 mutex_init(&ret_buf->crfid.fid_mutex);
121 ret_buf->crfid.fid = kzalloc(sizeof(struct cifs_fid),
122 GFP_KERNEL);
1da177e4
LT
123#ifdef CONFIG_CIFS_STATS
124 spin_lock_init(&ret_buf->stat_lock);
125#endif
1da177e4
LT
126 }
127 return ret_buf;
128}
129
130void
96daf2b0 131tconInfoFree(struct cifs_tcon *buf_to_free)
1da177e4
LT
132{
133 if (buf_to_free == NULL) {
f96637be 134 cifs_dbg(FYI, "Null buffer passed to tconInfoFree\n");
1da177e4
LT
135 return;
136 }
1da177e4 137 atomic_dec(&tconInfoAllocCount);
f99d49ad 138 kfree(buf_to_free->nativeFileSystem);
97f4b727 139 kzfree(buf_to_free->password);
a93864d9 140 kfree(buf_to_free->crfid.fid);
1da177e4
LT
141 kfree(buf_to_free);
142}
143
144struct smb_hdr *
145cifs_buf_get(void)
146{
147 struct smb_hdr *ret_buf = NULL;
3792c173
PS
148 /*
149 * SMB2 header is bigger than CIFS one - no problems to clean some
150 * more bytes for CIFS.
151 */
49f466bd 152 size_t buf_size = sizeof(struct smb2_sync_hdr);
2a38e120 153
3792c173
PS
154 /*
155 * We could use negotiated size instead of max_msgsize -
156 * but it may be more efficient to always alloc same size
157 * albeit slightly larger than necessary and maxbuffersize
158 * defaults to this and can not be bigger.
159 */
232087cb 160 ret_buf = mempool_alloc(cifs_req_poolp, GFP_NOFS);
1da177e4
LT
161
162 /* clear the first few header bytes */
163 /* for most paths, more is cleared in header_assemble */
a6f74e80
N
164 memset(ret_buf, 0, buf_size + 3);
165 atomic_inc(&bufAllocCount);
4498eed5 166#ifdef CONFIG_CIFS_STATS2
a6f74e80 167 atomic_inc(&totBufAllocCount);
4498eed5 168#endif /* CONFIG_CIFS_STATS2 */
1da177e4
LT
169
170 return ret_buf;
171}
172
173void
174cifs_buf_release(void *buf_to_free)
175{
1da177e4 176 if (buf_to_free == NULL) {
f96637be 177 /* cifs_dbg(FYI, "Null buffer passed to cifs_buf_release\n");*/
1da177e4
LT
178 return;
179 }
fb8c4b14 180 mempool_free(buf_to_free, cifs_req_poolp);
1da177e4
LT
181
182 atomic_dec(&bufAllocCount);
183 return;
184}
185
186struct smb_hdr *
187cifs_small_buf_get(void)
188{
189 struct smb_hdr *ret_buf = NULL;
190
fb8c4b14
SF
191/* We could use negotiated size instead of max_msgsize -
192 but it may be more efficient to always alloc same size
193 albeit slightly larger than necessary and maxbuffersize
1da177e4 194 defaults to this and can not be bigger */
232087cb 195 ret_buf = mempool_alloc(cifs_sm_req_poolp, GFP_NOFS);
1da177e4
LT
196 /* No need to clear memory here, cleared in header assemble */
197 /* memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
a6f74e80 198 atomic_inc(&smBufAllocCount);
4498eed5 199#ifdef CONFIG_CIFS_STATS2
a6f74e80 200 atomic_inc(&totSmBufAllocCount);
4498eed5
SF
201#endif /* CONFIG_CIFS_STATS2 */
202
1da177e4
LT
203 return ret_buf;
204}
205
206void
207cifs_small_buf_release(void *buf_to_free)
208{
209
210 if (buf_to_free == NULL) {
f96637be 211 cifs_dbg(FYI, "Null buffer passed to cifs_small_buf_release\n");
1da177e4
LT
212 return;
213 }
fb8c4b14 214 mempool_free(buf_to_free, cifs_sm_req_poolp);
1da177e4
LT
215
216 atomic_dec(&smBufAllocCount);
217 return;
218}
219
6d81ed1e
SP
220void
221free_rsp_buf(int resp_buftype, void *rsp)
222{
223 if (resp_buftype == CIFS_SMALL_BUFFER)
224 cifs_small_buf_release(rsp);
225 else if (resp_buftype == CIFS_LARGE_BUFFER)
226 cifs_buf_release(rsp);
227}
228
1982c344
SF
229/* NB: MID can not be set if treeCon not passed in, in that
230 case it is responsbility of caller to set the mid */
1da177e4
LT
231void
232header_assemble(struct smb_hdr *buffer, char smb_command /* command */ ,
96daf2b0 233 const struct cifs_tcon *treeCon, int word_count
1da177e4
LT
234 /* length of fixed section (word count) in two byte units */)
235{
1da177e4
LT
236 char *temp = (char *) buffer;
237
fb8c4b14 238 memset(temp, 0, 256); /* bigger than MAX_CIFS_HDR_SIZE */
1da177e4 239
be8e3b00 240 buffer->smb_buf_length = cpu_to_be32(
630f3f0c 241 (2 * word_count) + sizeof(struct smb_hdr) -
1da177e4 242 4 /* RFC 1001 length field does not count */ +
be8e3b00 243 2 /* for bcc field itself */) ;
1da177e4
LT
244
245 buffer->Protocol[0] = 0xFF;
246 buffer->Protocol[1] = 'S';
247 buffer->Protocol[2] = 'M';
248 buffer->Protocol[3] = 'B';
249 buffer->Command = smb_command;
250 buffer->Flags = 0x00; /* case sensitive */
251 buffer->Flags2 = SMBFLG2_KNOWS_LONG_NAMES;
252 buffer->Pid = cpu_to_le16((__u16)current->tgid);
253 buffer->PidHigh = cpu_to_le16((__u16)(current->tgid >> 16));
1da177e4
LT
254 if (treeCon) {
255 buffer->Tid = treeCon->tid;
256 if (treeCon->ses) {
257 if (treeCon->ses->capabilities & CAP_UNICODE)
258 buffer->Flags2 |= SMBFLG2_UNICODE;
ad7a2926 259 if (treeCon->ses->capabilities & CAP_STATUS32)
1da177e4 260 buffer->Flags2 |= SMBFLG2_ERR_STATUS;
ad7a2926 261
1982c344
SF
262 /* Uid is not converted */
263 buffer->Uid = treeCon->ses->Suid;
88257360 264 buffer->Mid = get_next_mid(treeCon->ses->server);
1da177e4
LT
265 }
266 if (treeCon->Flags & SMB_SHARE_IS_IN_DFS)
267 buffer->Flags2 |= SMBFLG2_DFS;
d3485d37
SF
268 if (treeCon->nocase)
269 buffer->Flags |= SMBFLG_CASELESS;
790fe579 270 if ((treeCon->ses) && (treeCon->ses->server))
38d77c50 271 if (treeCon->ses->server->sign)
1da177e4
LT
272 buffer->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
273 }
274
275/* endian conversion of flags is now done just before sending */
276 buffer->WordCount = (char) word_count;
277 return;
278}
279
2cd646a2 280static int
944d6f1a 281check_smb_hdr(struct smb_hdr *smb)
1da177e4 282{
68abaffa
JL
283 /* does it have the right SMB "signature" ? */
284 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff)) {
f96637be
JP
285 cifs_dbg(VFS, "Bad protocol string signature header 0x%x\n",
286 *(unsigned int *)smb->Protocol);
68abaffa
JL
287 return 1;
288 }
289
68abaffa
JL
290 /* if it's a response then accept */
291 if (smb->Flags & SMBFLG_RESPONSE)
292 return 0;
293
294 /* only one valid case where server sends us request */
295 if (smb->Command == SMB_COM_LOCKING_ANDX)
296 return 0;
297
3d378d3f
TG
298 cifs_dbg(VFS, "Server sent request, not response. mid=%u\n",
299 get_mid(smb));
1da177e4
LT
300 return 1;
301}
302
303int
373512ec 304checkSMB(char *buf, unsigned int total_read, struct TCP_Server_Info *server)
1da177e4 305{
d4e4854f 306 struct smb_hdr *smb = (struct smb_hdr *)buf;
376b43f4 307 __u32 rfclen = be32_to_cpu(smb->smb_buf_length);
190fdeb8 308 __u32 clc_len; /* calculated length */
f96637be
JP
309 cifs_dbg(FYI, "checkSMB Length: 0x%x, smb_buf_length: 0x%x\n",
310 total_read, rfclen);
d103e164 311
376b43f4
JL
312 /* is this frame too small to even get to a BCC? */
313 if (total_read < 2 + sizeof(struct smb_hdr)) {
314 if ((total_read >= sizeof(struct smb_hdr) - 1)
1da177e4 315 && (smb->Status.CifsError != 0)) {
376b43f4 316 /* it's an error return */
d103e164
SF
317 smb->WordCount = 0;
318 /* some error cases do not return wct and bcc */
319 return 0;
376b43f4 320 } else if ((total_read == sizeof(struct smb_hdr) + 1) &&
d103e164 321 (smb->WordCount == 0)) {
fb8c4b14 322 char *tmp = (char *)smb;
d103e164
SF
323 /* Need to work around a bug in two servers here */
324 /* First, check if the part of bcc they sent was zero */
325 if (tmp[sizeof(struct smb_hdr)] == 0) {
326 /* some servers return only half of bcc
327 * on simple responses (wct, bcc both zero)
328 * in particular have seen this on
329 * ulogoffX and FindClose. This leaves
330 * one byte of bcc potentially unitialized
331 */
332 /* zero rest of bcc */
333 tmp[sizeof(struct smb_hdr)+1] = 0;
46c79a64 334 return 0;
1da177e4 335 }
f96637be 336 cifs_dbg(VFS, "rcvd invalid byte count (bcc)\n");
d103e164 337 } else {
f96637be 338 cifs_dbg(VFS, "Length less than smb header size\n");
1da177e4 339 }
376b43f4 340 return -EIO;
1da177e4
LT
341 }
342
376b43f4 343 /* otherwise, there is enough to get to the BCC */
944d6f1a 344 if (check_smb_hdr(smb))
376b43f4 345 return -EIO;
9ec672bd 346 clc_len = smbCalcSize(smb, server);
184ed211 347
376b43f4 348 if (4 + rfclen != total_read) {
f96637be
JP
349 cifs_dbg(VFS, "Length read does not match RFC1001 length %d\n",
350 rfclen);
376b43f4 351 return -EIO;
184ed211
SF
352 }
353
376b43f4 354 if (4 + rfclen != clc_len) {
3d378d3f 355 __u16 mid = get_mid(smb);
184ed211 356 /* check if bcc wrapped around for large read responses */
376b43f4 357 if ((rfclen > 64 * 1024) && (rfclen > clc_len)) {
184ed211 358 /* check if lengths match mod 64K */
376b43f4 359 if (((4 + rfclen) & 0xFFFF) == (clc_len & 0xFFFF))
fb8c4b14 360 return 0; /* bcc wrapped */
184ed211 361 }
f96637be 362 cifs_dbg(FYI, "Calculated size %u vs length %u mismatch for mid=%u\n",
3d378d3f 363 clc_len, 4 + rfclen, mid);
6284644e 364
376b43f4 365 if (4 + rfclen < clc_len) {
f96637be 366 cifs_dbg(VFS, "RFC1001 size %u smaller than SMB for mid=%u\n",
3d378d3f 367 rfclen, mid);
376b43f4
JL
368 return -EIO;
369 } else if (rfclen > clc_len + 512) {
6284644e
JL
370 /*
371 * Some servers (Windows XP in particular) send more
372 * data than the lengths in the SMB packet would
373 * indicate on certain calls (byte range locks and
374 * trans2 find first calls in particular). While the
375 * client can handle such a frame by ignoring the
376 * trailing data, we choose limit the amount of extra
377 * data to 512 bytes.
378 */
f96637be 379 cifs_dbg(VFS, "RFC1001 size %u more than 512 bytes larger than SMB for mid=%u\n",
3d378d3f 380 rfclen, mid);
376b43f4 381 return -EIO;
46c79a64 382 }
1da177e4 383 }
20962438 384 return 0;
1da177e4 385}
4b18f2a9
SF
386
387bool
d4e4854f 388is_valid_oplock_break(char *buffer, struct TCP_Server_Info *srv)
fb8c4b14 389{
d4e4854f 390 struct smb_hdr *buf = (struct smb_hdr *)buffer;
fb8c4b14 391 struct smb_com_lock_req *pSMB = (struct smb_com_lock_req *)buf;
f1987b44 392 struct list_head *tmp, *tmp1, *tmp2;
96daf2b0
SF
393 struct cifs_ses *ses;
394 struct cifs_tcon *tcon;
f1987b44 395 struct cifsInodeInfo *pCifsInode;
1da177e4
LT
396 struct cifsFileInfo *netfile;
397
f96637be 398 cifs_dbg(FYI, "Checking for oplock break or dnotify response\n");
790fe579 399 if ((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
1da177e4 400 (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
fb8c4b14 401 struct smb_com_transaction_change_notify_rsp *pSMBr =
1da177e4 402 (struct smb_com_transaction_change_notify_rsp *)buf;
fb8c4b14 403 struct file_notify_information *pnotify;
1da177e4 404 __u32 data_offset = 0;
820a803f 405 if (get_bcc(buf) > sizeof(struct file_notify_information)) {
1da177e4
LT
406 data_offset = le32_to_cpu(pSMBr->DataOffset);
407
3979877e
SF
408 pnotify = (struct file_notify_information *)
409 ((char *)&pSMBr->hdr.Protocol + data_offset);
f96637be 410 cifs_dbg(FYI, "dnotify on %s Action: 0x%x\n",
b6b38f70 411 pnotify->FileName, pnotify->Action);
fb8c4b14 412 /* cifs_dump_mem("Rcvd notify Data: ",buf,
3979877e 413 sizeof(struct smb_hdr)+60); */
4b18f2a9 414 return true;
1da177e4 415 }
790fe579 416 if (pSMBr->hdr.Status.CifsError) {
59b04c5d 417 cifs_dbg(FYI, "notify err 0x%x\n",
f96637be 418 pSMBr->hdr.Status.CifsError);
4b18f2a9 419 return true;
1da177e4 420 }
4b18f2a9 421 return false;
fb8c4b14 422 }
790fe579 423 if (pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
4b18f2a9 424 return false;
790fe579 425 if (pSMB->hdr.Flags & SMBFLG_RESPONSE) {
1da177e4
LT
426 /* no sense logging error on invalid handle on oplock
427 break - harmless race between close request and oplock
428 break response is expected from time to time writing out
429 large dirty files cached on the client */
fb8c4b14
SF
430 if ((NT_STATUS_INVALID_HANDLE) ==
431 le32_to_cpu(pSMB->hdr.Status.CifsError)) {
f96637be 432 cifs_dbg(FYI, "invalid handle on oplock break\n");
4b18f2a9 433 return true;
fb8c4b14 434 } else if (ERRbadfid ==
1da177e4 435 le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
4b18f2a9 436 return true;
1da177e4 437 } else {
4b18f2a9 438 return false; /* on valid oplock brk we get "request" */
1da177e4
LT
439 }
440 }
790fe579 441 if (pSMB->hdr.WordCount != 8)
4b18f2a9 442 return false;
1da177e4 443
59b04c5d 444 cifs_dbg(FYI, "oplock type 0x%x level 0x%x\n",
b6b38f70 445 pSMB->LockType, pSMB->OplockLevel);
790fe579 446 if (!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
4b18f2a9 447 return false;
1da177e4
LT
448
449 /* look up tcon based on tid & uid */
3f9bcca7 450 spin_lock(&cifs_tcp_ses_lock);
f1987b44 451 list_for_each(tmp, &srv->smb_ses_list) {
96daf2b0 452 ses = list_entry(tmp, struct cifs_ses, smb_ses_list);
f1987b44 453 list_for_each(tmp1, &ses->tcon_list) {
96daf2b0 454 tcon = list_entry(tmp1, struct cifs_tcon, tcon_list);
f1987b44
JL
455 if (tcon->tid != buf->Tid)
456 continue;
457
44c58186 458 cifs_stats_inc(&tcon->stats.cifs_stats.num_oplock_brks);
3afca265 459 spin_lock(&tcon->open_file_lock);
f1987b44
JL
460 list_for_each(tmp2, &tcon->openFileList) {
461 netfile = list_entry(tmp2, struct cifsFileInfo,
57337e42 462 tlist);
4b4de76e 463 if (pSMB->Fid != netfile->fid.netfid)
f1987b44
JL
464 continue;
465
f96637be 466 cifs_dbg(FYI, "file id match, oplock break\n");
2b0143b5 467 pCifsInode = CIFS_I(d_inode(netfile->dentry));
9b646972 468
c11f1df5
SP
469 set_bit(CIFS_INODE_PENDING_OPLOCK_BREAK,
470 &pCifsInode->flags);
471
472 /*
473 * Set flag if the server downgrades the oplock
474 * to L2 else clear.
475 */
476 if (pSMB->OplockLevel)
477 set_bit(
478 CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2,
479 &pCifsInode->flags);
480 else
481 clear_bit(
482 CIFS_INODE_DOWNGRADE_OPLOCK_TO_L2,
483 &pCifsInode->flags);
484
3998e6b8 485 queue_work(cifsoplockd_wq,
ad635942 486 &netfile->oplock_break);
9b646972
TH
487 netfile->oplock_break_cancelled = false;
488
3afca265 489 spin_unlock(&tcon->open_file_lock);
3f9bcca7 490 spin_unlock(&cifs_tcp_ses_lock);
f1987b44 491 return true;
1da177e4 492 }
3afca265 493 spin_unlock(&tcon->open_file_lock);
3f9bcca7 494 spin_unlock(&cifs_tcp_ses_lock);
f96637be 495 cifs_dbg(FYI, "No matching file for oplock break\n");
4b18f2a9 496 return true;
1da177e4
LT
497 }
498 }
3f9bcca7 499 spin_unlock(&cifs_tcp_ses_lock);
f96637be 500 cifs_dbg(FYI, "Can not process oplock break for non-existent connection\n");
4b18f2a9 501 return true;
1da177e4
LT
502}
503
504void
792af7b0 505dump_smb(void *buf, int smb_buf_length)
1da177e4 506{
1da177e4
LT
507 if (traceSMB == 0)
508 return;
509
55d83e0d
AS
510 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_NONE, 8, 2, buf,
511 smb_buf_length, true);
1da177e4 512}
6a0b4824 513
ec06aedd
JL
514void
515cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb)
516{
517 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_SERVER_INUM) {
f534dc99 518 cifs_sb->mnt_cifs_flags &= ~CIFS_MOUNT_SERVER_INUM;
f96637be
JP
519 cifs_dbg(VFS, "Autodisabling the use of server inode numbers on %s. This server doesn't seem to support them properly. Hardlinks will not be recognized on this mount. Consider mounting with the \"noserverino\" option to silence this message.\n",
520 cifs_sb_master_tcon(cifs_sb)->treeName);
ec06aedd
JL
521 }
522}
e66673e3 523
c6723628 524void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock)
e66673e3 525{
c6723628 526 oplock &= 0xF;
e66673e3 527
c6723628 528 if (oplock == OPLOCK_EXCLUSIVE) {
18cceb6a 529 cinode->oplock = CIFS_CACHE_WRITE_FLG | CIFS_CACHE_READ_FLG;
f96637be
JP
530 cifs_dbg(FYI, "Exclusive Oplock granted on inode %p\n",
531 &cinode->vfs_inode);
c6723628 532 } else if (oplock == OPLOCK_READ) {
18cceb6a 533 cinode->oplock = CIFS_CACHE_READ_FLG;
f96637be
JP
534 cifs_dbg(FYI, "Level II Oplock granted on inode %p\n",
535 &cinode->vfs_inode);
18cceb6a
PS
536 } else
537 cinode->oplock = 0;
e66673e3 538}
3d3ea8e6 539
c11f1df5
SP
540/*
541 * We wait for oplock breaks to be processed before we attempt to perform
542 * writes.
543 */
544int cifs_get_writer(struct cifsInodeInfo *cinode)
545{
546 int rc;
547
548start:
549 rc = wait_on_bit(&cinode->flags, CIFS_INODE_PENDING_OPLOCK_BREAK,
74316201 550 TASK_KILLABLE);
c11f1df5
SP
551 if (rc)
552 return rc;
553
554 spin_lock(&cinode->writers_lock);
555 if (!cinode->writers)
556 set_bit(CIFS_INODE_PENDING_WRITERS, &cinode->flags);
557 cinode->writers++;
558 /* Check to see if we have started servicing an oplock break */
559 if (test_bit(CIFS_INODE_PENDING_OPLOCK_BREAK, &cinode->flags)) {
560 cinode->writers--;
561 if (cinode->writers == 0) {
562 clear_bit(CIFS_INODE_PENDING_WRITERS, &cinode->flags);
563 wake_up_bit(&cinode->flags, CIFS_INODE_PENDING_WRITERS);
564 }
565 spin_unlock(&cinode->writers_lock);
566 goto start;
567 }
568 spin_unlock(&cinode->writers_lock);
569 return 0;
570}
571
572void cifs_put_writer(struct cifsInodeInfo *cinode)
573{
574 spin_lock(&cinode->writers_lock);
575 cinode->writers--;
576 if (cinode->writers == 0) {
577 clear_bit(CIFS_INODE_PENDING_WRITERS, &cinode->flags);
578 wake_up_bit(&cinode->flags, CIFS_INODE_PENDING_WRITERS);
579 }
580 spin_unlock(&cinode->writers_lock);
581}
582
583void cifs_done_oplock_break(struct cifsInodeInfo *cinode)
584{
585 clear_bit(CIFS_INODE_PENDING_OPLOCK_BREAK, &cinode->flags);
586 wake_up_bit(&cinode->flags, CIFS_INODE_PENDING_OPLOCK_BREAK);
587}
588
3d3ea8e6
SP
589bool
590backup_cred(struct cifs_sb_info *cifs_sb)
591{
592 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_CIFS_BACKUPUID) {
1f68233c 593 if (uid_eq(cifs_sb->mnt_backupuid, current_fsuid()))
3d3ea8e6
SP
594 return true;
595 }
596 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_CIFS_BACKUPGID) {
597 if (in_group_p(cifs_sb->mnt_backupgid))
598 return true;
599 }
600
601 return false;
602}
233839b1
PS
603
604void
605cifs_del_pending_open(struct cifs_pending_open *open)
606{
3afca265 607 spin_lock(&tlink_tcon(open->tlink)->open_file_lock);
233839b1 608 list_del(&open->olist);
3afca265 609 spin_unlock(&tlink_tcon(open->tlink)->open_file_lock);
233839b1
PS
610}
611
612void
613cifs_add_pending_open_locked(struct cifs_fid *fid, struct tcon_link *tlink,
614 struct cifs_pending_open *open)
615{
233839b1 616 memcpy(open->lease_key, fid->lease_key, SMB2_LEASE_KEY_SIZE);
233839b1
PS
617 open->oplock = CIFS_OPLOCK_NO_CHANGE;
618 open->tlink = tlink;
619 fid->pending_open = open;
620 list_add_tail(&open->olist, &tlink_tcon(tlink)->pending_opens);
621}
622
623void
624cifs_add_pending_open(struct cifs_fid *fid, struct tcon_link *tlink,
625 struct cifs_pending_open *open)
626{
3afca265 627 spin_lock(&tlink_tcon(tlink)->open_file_lock);
233839b1 628 cifs_add_pending_open_locked(fid, tlink, open);
3afca265 629 spin_unlock(&tlink_tcon(open->tlink)->open_file_lock);
233839b1 630}
4ecce920
AA
631
632/* parses DFS refferal V3 structure
633 * caller is responsible for freeing target_nodes
634 * returns:
635 * - on success - 0
636 * - on failure - errno
637 */
638int
639parse_dfs_referrals(struct get_dfs_referral_rsp *rsp, u32 rsp_size,
640 unsigned int *num_of_nodes,
641 struct dfs_info3_param **target_nodes,
642 const struct nls_table *nls_codepage, int remap,
643 const char *searchName, bool is_unicode)
644{
645 int i, rc = 0;
646 char *data_end;
647 struct dfs_referral_level_3 *ref;
648
649 *num_of_nodes = le16_to_cpu(rsp->NumberOfReferrals);
650
651 if (*num_of_nodes < 1) {
652 cifs_dbg(VFS, "num_referrals: must be at least > 0, but we get num_referrals = %d\n",
653 *num_of_nodes);
654 rc = -EINVAL;
655 goto parse_DFS_referrals_exit;
656 }
657
658 ref = (struct dfs_referral_level_3 *) &(rsp->referrals);
659 if (ref->VersionNumber != cpu_to_le16(3)) {
660 cifs_dbg(VFS, "Referrals of V%d version are not supported, should be V3\n",
661 le16_to_cpu(ref->VersionNumber));
662 rc = -EINVAL;
663 goto parse_DFS_referrals_exit;
664 }
665
666 /* get the upper boundary of the resp buffer */
667 data_end = (char *)rsp + rsp_size;
668
669 cifs_dbg(FYI, "num_referrals: %d dfs flags: 0x%x ...\n",
670 *num_of_nodes, le32_to_cpu(rsp->DFSFlags));
671
672 *target_nodes = kcalloc(*num_of_nodes, sizeof(struct dfs_info3_param),
673 GFP_KERNEL);
674 if (*target_nodes == NULL) {
675 rc = -ENOMEM;
676 goto parse_DFS_referrals_exit;
677 }
678
679 /* collect necessary data from referrals */
680 for (i = 0; i < *num_of_nodes; i++) {
681 char *temp;
682 int max_len;
683 struct dfs_info3_param *node = (*target_nodes)+i;
684
685 node->flags = le32_to_cpu(rsp->DFSFlags);
686 if (is_unicode) {
687 __le16 *tmp = kmalloc(strlen(searchName)*2 + 2,
688 GFP_KERNEL);
689 if (tmp == NULL) {
690 rc = -ENOMEM;
691 goto parse_DFS_referrals_exit;
692 }
693 cifsConvertToUTF16((__le16 *) tmp, searchName,
694 PATH_MAX, nls_codepage, remap);
695 node->path_consumed = cifs_utf16_bytes(tmp,
696 le16_to_cpu(rsp->PathConsumed),
697 nls_codepage);
698 kfree(tmp);
699 } else
700 node->path_consumed = le16_to_cpu(rsp->PathConsumed);
701
702 node->server_type = le16_to_cpu(ref->ServerType);
703 node->ref_flag = le16_to_cpu(ref->ReferralEntryFlags);
704
705 /* copy DfsPath */
706 temp = (char *)ref + le16_to_cpu(ref->DfsPathOffset);
707 max_len = data_end - temp;
708 node->path_name = cifs_strndup_from_utf16(temp, max_len,
709 is_unicode, nls_codepage);
710 if (!node->path_name) {
711 rc = -ENOMEM;
712 goto parse_DFS_referrals_exit;
713 }
714
715 /* copy link target UNC */
716 temp = (char *)ref + le16_to_cpu(ref->NetworkAddressOffset);
717 max_len = data_end - temp;
718 node->node_name = cifs_strndup_from_utf16(temp, max_len,
719 is_unicode, nls_codepage);
720 if (!node->node_name) {
721 rc = -ENOMEM;
722 goto parse_DFS_referrals_exit;
723 }
724
725 ref++;
726 }
727
728parse_DFS_referrals_exit:
729 if (rc) {
730 free_dfs_info_array(*target_nodes, *num_of_nodes);
731 *target_nodes = NULL;
732 *num_of_nodes = 0;
733 }
734 return rc;
735}
ccf7f408
PS
736
737struct cifs_aio_ctx *
738cifs_aio_ctx_alloc(void)
739{
740 struct cifs_aio_ctx *ctx;
741
742 ctx = kzalloc(sizeof(struct cifs_aio_ctx), GFP_KERNEL);
743 if (!ctx)
744 return NULL;
745
746 INIT_LIST_HEAD(&ctx->list);
747 mutex_init(&ctx->aio_mutex);
748 init_completion(&ctx->done);
749 kref_init(&ctx->refcount);
750 return ctx;
751}
752
753void
754cifs_aio_ctx_release(struct kref *refcount)
755{
756 struct cifs_aio_ctx *ctx = container_of(refcount,
757 struct cifs_aio_ctx, refcount);
758
759 cifsFileInfo_put(ctx->cfile);
760 kvfree(ctx->bv);
761 kfree(ctx);
762}
763
764#define CIFS_AIO_KMALLOC_LIMIT (1024 * 1024)
765
766int
767setup_aio_ctx_iter(struct cifs_aio_ctx *ctx, struct iov_iter *iter, int rw)
768{
769 ssize_t rc;
770 unsigned int cur_npages;
771 unsigned int npages = 0;
772 unsigned int i;
773 size_t len;
774 size_t count = iov_iter_count(iter);
775 unsigned int saved_len;
776 size_t start;
777 unsigned int max_pages = iov_iter_npages(iter, INT_MAX);
778 struct page **pages = NULL;
779 struct bio_vec *bv = NULL;
780
781 if (iter->type & ITER_KVEC) {
782 memcpy(&ctx->iter, iter, sizeof(struct iov_iter));
783 ctx->len = count;
784 iov_iter_advance(iter, count);
785 return 0;
786 }
787
788 if (max_pages * sizeof(struct bio_vec) <= CIFS_AIO_KMALLOC_LIMIT)
789 bv = kmalloc_array(max_pages, sizeof(struct bio_vec),
790 GFP_KERNEL);
791
792 if (!bv) {
42bc47b3 793 bv = vmalloc(array_size(max_pages, sizeof(struct bio_vec)));
ccf7f408
PS
794 if (!bv)
795 return -ENOMEM;
796 }
797
798 if (max_pages * sizeof(struct page *) <= CIFS_AIO_KMALLOC_LIMIT)
799 pages = kmalloc_array(max_pages, sizeof(struct page *),
800 GFP_KERNEL);
801
802 if (!pages) {
42bc47b3 803 pages = vmalloc(array_size(max_pages, sizeof(struct page *)));
ecf3411a 804 if (!pages) {
ccf7f408
PS
805 kvfree(bv);
806 return -ENOMEM;
807 }
808 }
809
810 saved_len = count;
811
812 while (count && npages < max_pages) {
813 rc = iov_iter_get_pages(iter, pages, count, max_pages, &start);
814 if (rc < 0) {
815 cifs_dbg(VFS, "couldn't get user pages (rc=%zd)\n", rc);
816 break;
817 }
818
819 if (rc > count) {
820 cifs_dbg(VFS, "get pages rc=%zd more than %zu\n", rc,
821 count);
822 break;
823 }
824
825 iov_iter_advance(iter, rc);
826 count -= rc;
827 rc += start;
828 cur_npages = DIV_ROUND_UP(rc, PAGE_SIZE);
829
830 if (npages + cur_npages > max_pages) {
831 cifs_dbg(VFS, "out of vec array capacity (%u vs %u)\n",
832 npages + cur_npages, max_pages);
833 break;
834 }
835
836 for (i = 0; i < cur_npages; i++) {
837 len = rc > PAGE_SIZE ? PAGE_SIZE : rc;
838 bv[npages + i].bv_page = pages[i];
839 bv[npages + i].bv_offset = start;
840 bv[npages + i].bv_len = len - start;
841 rc -= len;
842 start = 0;
843 }
844
845 npages += cur_npages;
846 }
847
848 kvfree(pages);
849 ctx->bv = bv;
850 ctx->len = saved_len - count;
851 ctx->npages = npages;
852 iov_iter_bvec(&ctx->iter, ITER_BVEC | rw, ctx->bv, npages, ctx->len);
853 return 0;
854}
82fb82be
AA
855
856/**
857 * cifs_alloc_hash - allocate hash and hash context together
858 *
859 * The caller has to make sure @sdesc is initialized to either NULL or
860 * a valid context. Both can be freed via cifs_free_hash().
861 */
862int
863cifs_alloc_hash(const char *name,
864 struct crypto_shash **shash, struct sdesc **sdesc)
865{
866 int rc = 0;
867 size_t size;
868
869 if (*sdesc != NULL)
870 return 0;
871
872 *shash = crypto_alloc_shash(name, 0, 0);
873 if (IS_ERR(*shash)) {
874 cifs_dbg(VFS, "could not allocate crypto %s\n", name);
875 rc = PTR_ERR(*shash);
876 *shash = NULL;
877 *sdesc = NULL;
878 return rc;
879 }
880
881 size = sizeof(struct shash_desc) + crypto_shash_descsize(*shash);
882 *sdesc = kmalloc(size, GFP_KERNEL);
883 if (*sdesc == NULL) {
884 cifs_dbg(VFS, "no memory left to allocate crypto %s\n", name);
885 crypto_free_shash(*shash);
886 *shash = NULL;
887 return -ENOMEM;
888 }
889
890 (*sdesc)->shash.tfm = *shash;
891 (*sdesc)->shash.flags = 0x0;
892 return 0;
893}
894
895/**
896 * cifs_free_hash - free hash and hash context together
897 *
898 * Freeing a NULL hash or context is safe.
899 */
900void
901cifs_free_hash(struct crypto_shash **shash, struct sdesc **sdesc)
902{
903 kfree(*sdesc);
904 *sdesc = NULL;
905 if (*shash)
906 crypto_free_shash(*shash);
907 *shash = NULL;
908}
7b7f2bdf
LL
909
910/**
911 * rqst_page_get_length - obtain the length and offset for a page in smb_rqst
912 * Input: rqst - a smb_rqst, page - a page index for rqst
913 * Output: *len - the length for this page, *offset - the offset for this page
914 */
915void rqst_page_get_length(struct smb_rqst *rqst, unsigned int page,
916 unsigned int *len, unsigned int *offset)
917{
918 *len = rqst->rq_pagesz;
919 *offset = (page == 0) ? rqst->rq_offset : 0;
920
921 if (rqst->rq_npages == 1 || page == rqst->rq_npages-1)
922 *len = rqst->rq_tailsz;
923 else if (page == 0)
924 *len = rqst->rq_pagesz - rqst->rq_offset;
925}