4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
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.
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.
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
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/slab.h>
23 #include <linux/ctype.h>
24 #include <linux/mempool.h>
27 #include "cifsproto.h"
28 #include "cifs_debug.h"
31 #include "cifs_unicode.h"
33 extern mempool_t
*cifs_sm_req_poolp
;
34 extern mempool_t
*cifs_req_poolp
;
36 /* The xid serves as a useful identifier for each incoming vfs request,
37 in a similar way to the mid which is useful to track each sent smb,
38 and CurrentXid can also provide a running counter (although it
39 will eventually wrap past zero) of the total vfs operations handled
40 since the cifs fs was mounted */
47 spin_lock(&GlobalMid_Lock
);
48 GlobalTotalActiveXid
++;
50 /* keep high water mark for number of simultaneous ops in filesystem */
51 if (GlobalTotalActiveXid
> GlobalMaxActiveXid
)
52 GlobalMaxActiveXid
= GlobalTotalActiveXid
;
53 if (GlobalTotalActiveXid
> 65000)
54 cFYI(1, "warning: more than 65000 requests active");
55 xid
= GlobalCurrentXid
++;
56 spin_unlock(&GlobalMid_Lock
);
61 _FreeXid(unsigned int xid
)
63 spin_lock(&GlobalMid_Lock
);
64 /* if (GlobalTotalActiveXid == 0)
66 GlobalTotalActiveXid
--;
67 spin_unlock(&GlobalMid_Lock
);
73 struct cifs_ses
*ret_buf
;
75 ret_buf
= kzalloc(sizeof(struct cifs_ses
), GFP_KERNEL
);
77 atomic_inc(&sesInfoAllocCount
);
78 ret_buf
->status
= CifsNew
;
80 INIT_LIST_HEAD(&ret_buf
->smb_ses_list
);
81 INIT_LIST_HEAD(&ret_buf
->tcon_list
);
82 mutex_init(&ret_buf
->session_mutex
);
88 sesInfoFree(struct cifs_ses
*buf_to_free
)
90 if (buf_to_free
== NULL
) {
91 cFYI(1, "Null buffer passed to sesInfoFree");
95 atomic_dec(&sesInfoAllocCount
);
96 kfree(buf_to_free
->serverOS
);
97 kfree(buf_to_free
->serverDomain
);
98 kfree(buf_to_free
->serverNOS
);
99 if (buf_to_free
->password
) {
100 memset(buf_to_free
->password
, 0, strlen(buf_to_free
->password
));
101 kfree(buf_to_free
->password
);
103 kfree(buf_to_free
->user_name
);
104 kfree(buf_to_free
->domainName
);
111 struct cifs_tcon
*ret_buf
;
112 ret_buf
= kzalloc(sizeof(struct cifs_tcon
), GFP_KERNEL
);
114 atomic_inc(&tconInfoAllocCount
);
115 ret_buf
->tidStatus
= CifsNew
;
117 INIT_LIST_HEAD(&ret_buf
->openFileList
);
118 INIT_LIST_HEAD(&ret_buf
->tcon_list
);
119 #ifdef CONFIG_CIFS_STATS
120 spin_lock_init(&ret_buf
->stat_lock
);
127 tconInfoFree(struct cifs_tcon
*buf_to_free
)
129 if (buf_to_free
== NULL
) {
130 cFYI(1, "Null buffer passed to tconInfoFree");
133 atomic_dec(&tconInfoAllocCount
);
134 kfree(buf_to_free
->nativeFileSystem
);
135 if (buf_to_free
->password
) {
136 memset(buf_to_free
->password
, 0, strlen(buf_to_free
->password
));
137 kfree(buf_to_free
->password
);
145 struct smb_hdr
*ret_buf
= NULL
;
147 /* We could use negotiated size instead of max_msgsize -
148 but it may be more efficient to always alloc same size
149 albeit slightly larger than necessary and maxbuffersize
150 defaults to this and can not be bigger */
151 ret_buf
= mempool_alloc(cifs_req_poolp
, GFP_NOFS
);
153 /* clear the first few header bytes */
154 /* for most paths, more is cleared in header_assemble */
156 memset(ret_buf
, 0, sizeof(struct smb_hdr
) + 3);
157 atomic_inc(&bufAllocCount
);
158 #ifdef CONFIG_CIFS_STATS2
159 atomic_inc(&totBufAllocCount
);
160 #endif /* CONFIG_CIFS_STATS2 */
167 cifs_buf_release(void *buf_to_free
)
169 if (buf_to_free
== NULL
) {
170 /* cFYI(1, "Null buffer passed to cifs_buf_release");*/
173 mempool_free(buf_to_free
, cifs_req_poolp
);
175 atomic_dec(&bufAllocCount
);
180 cifs_small_buf_get(void)
182 struct smb_hdr
*ret_buf
= NULL
;
184 /* We could use negotiated size instead of max_msgsize -
185 but it may be more efficient to always alloc same size
186 albeit slightly larger than necessary and maxbuffersize
187 defaults to this and can not be bigger */
188 ret_buf
= mempool_alloc(cifs_sm_req_poolp
, GFP_NOFS
);
190 /* No need to clear memory here, cleared in header assemble */
191 /* memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
192 atomic_inc(&smBufAllocCount
);
193 #ifdef CONFIG_CIFS_STATS2
194 atomic_inc(&totSmBufAllocCount
);
195 #endif /* CONFIG_CIFS_STATS2 */
202 cifs_small_buf_release(void *buf_to_free
)
205 if (buf_to_free
== NULL
) {
206 cFYI(1, "Null buffer passed to cifs_small_buf_release");
209 mempool_free(buf_to_free
, cifs_sm_req_poolp
);
211 atomic_dec(&smBufAllocCount
);
216 * Find a free multiplex id (SMB mid). Otherwise there could be
217 * mid collisions which might cause problems, demultiplexing the
218 * wrong response to this request. Multiplex ids could collide if
219 * one of a series requests takes much longer than the others, or
220 * if a very large number of long lived requests (byte range
221 * locks or FindNotify requests) are pending. No more than
222 * 64K-1 requests can be outstanding at one time. If no
223 * mids are available, return zero. A future optimization
224 * could make the combination of mids and uid the key we use
225 * to demultiplex on (rather than mid alone).
226 * In addition to the above check, the cifs demultiplex
227 * code already used the command code as a secondary
228 * check of the frame and if signing is negotiated the
229 * response would be discarded if the mid were the same
230 * but the signature was wrong. Since the mid is not put in the
231 * pending queue until later (when it is about to be dispatched)
232 * we do have to limit the number of outstanding requests
233 * to somewhat less than 64K-1 although it is hard to imagine
234 * so many threads being in the vfs at one time.
236 __u64
GetNextMid(struct TCP_Server_Info
*server
)
239 __u16 last_mid
, cur_mid
;
242 spin_lock(&GlobalMid_Lock
);
244 /* mid is 16 bit only for CIFS/SMB */
245 cur_mid
= (__u16
)((server
->CurrentMid
) & 0xffff);
246 /* we do not want to loop forever */
251 * This nested loop looks more expensive than it is.
252 * In practice the list of pending requests is short,
253 * fewer than 50, and the mids are likely to be unique
254 * on the first pass through the loop unless some request
255 * takes longer than the 64 thousand requests before it
256 * (and it would also have to have been a request that
259 while (cur_mid
!= last_mid
) {
260 struct mid_q_entry
*mid_entry
;
261 unsigned int num_mids
;
268 list_for_each_entry(mid_entry
, &server
->pending_mid_q
, qhead
) {
270 if (mid_entry
->mid
== cur_mid
&&
271 mid_entry
->mid_state
== MID_REQUEST_SUBMITTED
) {
272 /* This mid is in use, try a different one */
279 * if we have more than 32k mids in the list, then something
280 * is very wrong. Possibly a local user is trying to DoS the
281 * box by issuing long-running calls and SIGKILL'ing them. If
282 * we get to 2^16 mids then we're in big trouble as this
283 * function could loop forever.
285 * Go ahead and assign out the mid in this situation, but force
286 * an eventual reconnect to clean out the pending_mid_q.
288 if (num_mids
> 32768)
289 server
->tcpStatus
= CifsNeedReconnect
;
292 mid
= (__u64
)cur_mid
;
293 server
->CurrentMid
= mid
;
298 spin_unlock(&GlobalMid_Lock
);
302 /* NB: MID can not be set if treeCon not passed in, in that
303 case it is responsbility of caller to set the mid */
305 header_assemble(struct smb_hdr
*buffer
, char smb_command
/* command */ ,
306 const struct cifs_tcon
*treeCon
, int word_count
307 /* length of fixed section (word count) in two byte units */)
309 char *temp
= (char *) buffer
;
311 memset(temp
, 0, 256); /* bigger than MAX_CIFS_HDR_SIZE */
313 buffer
->smb_buf_length
= cpu_to_be32(
314 (2 * word_count
) + sizeof(struct smb_hdr
) -
315 4 /* RFC 1001 length field does not count */ +
316 2 /* for bcc field itself */) ;
318 buffer
->Protocol
[0] = 0xFF;
319 buffer
->Protocol
[1] = 'S';
320 buffer
->Protocol
[2] = 'M';
321 buffer
->Protocol
[3] = 'B';
322 buffer
->Command
= smb_command
;
323 buffer
->Flags
= 0x00; /* case sensitive */
324 buffer
->Flags2
= SMBFLG2_KNOWS_LONG_NAMES
;
325 buffer
->Pid
= cpu_to_le16((__u16
)current
->tgid
);
326 buffer
->PidHigh
= cpu_to_le16((__u16
)(current
->tgid
>> 16));
328 buffer
->Tid
= treeCon
->tid
;
330 if (treeCon
->ses
->capabilities
& CAP_UNICODE
)
331 buffer
->Flags2
|= SMBFLG2_UNICODE
;
332 if (treeCon
->ses
->capabilities
& CAP_STATUS32
)
333 buffer
->Flags2
|= SMBFLG2_ERR_STATUS
;
335 /* Uid is not converted */
336 buffer
->Uid
= treeCon
->ses
->Suid
;
337 buffer
->Mid
= GetNextMid(treeCon
->ses
->server
);
339 if (treeCon
->Flags
& SMB_SHARE_IS_IN_DFS
)
340 buffer
->Flags2
|= SMBFLG2_DFS
;
342 buffer
->Flags
|= SMBFLG_CASELESS
;
343 if ((treeCon
->ses
) && (treeCon
->ses
->server
))
344 if (treeCon
->ses
->server
->sec_mode
&
345 (SECMODE_SIGN_REQUIRED
| SECMODE_SIGN_ENABLED
))
346 buffer
->Flags2
|= SMBFLG2_SECURITY_SIGNATURE
;
349 /* endian conversion of flags is now done just before sending */
350 buffer
->WordCount
= (char) word_count
;
355 check_smb_hdr(struct smb_hdr
*smb
, __u16 mid
)
357 /* does it have the right SMB "signature" ? */
358 if (*(__le32
*) smb
->Protocol
!= cpu_to_le32(0x424d53ff)) {
359 cERROR(1, "Bad protocol string signature header 0x%x",
360 *(unsigned int *)smb
->Protocol
);
364 /* Make sure that message ids match */
365 if (mid
!= smb
->Mid
) {
366 cERROR(1, "Mids do not match. received=%u expected=%u",
371 /* if it's a response then accept */
372 if (smb
->Flags
& SMBFLG_RESPONSE
)
375 /* only one valid case where server sends us request */
376 if (smb
->Command
== SMB_COM_LOCKING_ANDX
)
379 cERROR(1, "Server sent request, not response. mid=%u", smb
->Mid
);
384 checkSMB(char *buf
, unsigned int total_read
)
386 struct smb_hdr
*smb
= (struct smb_hdr
*)buf
;
387 __u16 mid
= smb
->Mid
;
388 __u32 rfclen
= be32_to_cpu(smb
->smb_buf_length
);
389 __u32 clc_len
; /* calculated length */
390 cFYI(0, "checkSMB Length: 0x%x, smb_buf_length: 0x%x",
393 /* is this frame too small to even get to a BCC? */
394 if (total_read
< 2 + sizeof(struct smb_hdr
)) {
395 if ((total_read
>= sizeof(struct smb_hdr
) - 1)
396 && (smb
->Status
.CifsError
!= 0)) {
397 /* it's an error return */
399 /* some error cases do not return wct and bcc */
401 } else if ((total_read
== sizeof(struct smb_hdr
) + 1) &&
402 (smb
->WordCount
== 0)) {
403 char *tmp
= (char *)smb
;
404 /* Need to work around a bug in two servers here */
405 /* First, check if the part of bcc they sent was zero */
406 if (tmp
[sizeof(struct smb_hdr
)] == 0) {
407 /* some servers return only half of bcc
408 * on simple responses (wct, bcc both zero)
409 * in particular have seen this on
410 * ulogoffX and FindClose. This leaves
411 * one byte of bcc potentially unitialized
413 /* zero rest of bcc */
414 tmp
[sizeof(struct smb_hdr
)+1] = 0;
417 cERROR(1, "rcvd invalid byte count (bcc)");
419 cERROR(1, "Length less than smb header size");
424 /* otherwise, there is enough to get to the BCC */
425 if (check_smb_hdr(smb
, mid
))
427 clc_len
= smbCalcSize(smb
);
429 if (4 + rfclen
!= total_read
) {
430 cERROR(1, "Length read does not match RFC1001 length %d",
435 if (4 + rfclen
!= clc_len
) {
436 /* check if bcc wrapped around for large read responses */
437 if ((rfclen
> 64 * 1024) && (rfclen
> clc_len
)) {
438 /* check if lengths match mod 64K */
439 if (((4 + rfclen
) & 0xFFFF) == (clc_len
& 0xFFFF))
440 return 0; /* bcc wrapped */
442 cFYI(1, "Calculated size %u vs length %u mismatch for mid=%u",
443 clc_len
, 4 + rfclen
, smb
->Mid
);
445 if (4 + rfclen
< clc_len
) {
446 cERROR(1, "RFC1001 size %u smaller than SMB for mid=%u",
449 } else if (rfclen
> clc_len
+ 512) {
451 * Some servers (Windows XP in particular) send more
452 * data than the lengths in the SMB packet would
453 * indicate on certain calls (byte range locks and
454 * trans2 find first calls in particular). While the
455 * client can handle such a frame by ignoring the
456 * trailing data, we choose limit the amount of extra
459 cERROR(1, "RFC1001 size %u more than 512 bytes larger "
460 "than SMB for mid=%u", rfclen
, smb
->Mid
);
468 is_valid_oplock_break(char *buffer
, struct TCP_Server_Info
*srv
)
470 struct smb_hdr
*buf
= (struct smb_hdr
*)buffer
;
471 struct smb_com_lock_req
*pSMB
= (struct smb_com_lock_req
*)buf
;
472 struct list_head
*tmp
, *tmp1
, *tmp2
;
473 struct cifs_ses
*ses
;
474 struct cifs_tcon
*tcon
;
475 struct cifsInodeInfo
*pCifsInode
;
476 struct cifsFileInfo
*netfile
;
478 cFYI(1, "Checking for oplock break or dnotify response");
479 if ((pSMB
->hdr
.Command
== SMB_COM_NT_TRANSACT
) &&
480 (pSMB
->hdr
.Flags
& SMBFLG_RESPONSE
)) {
481 struct smb_com_transaction_change_notify_rsp
*pSMBr
=
482 (struct smb_com_transaction_change_notify_rsp
*)buf
;
483 struct file_notify_information
*pnotify
;
484 __u32 data_offset
= 0;
485 if (get_bcc(buf
) > sizeof(struct file_notify_information
)) {
486 data_offset
= le32_to_cpu(pSMBr
->DataOffset
);
488 pnotify
= (struct file_notify_information
*)
489 ((char *)&pSMBr
->hdr
.Protocol
+ data_offset
);
490 cFYI(1, "dnotify on %s Action: 0x%x",
491 pnotify
->FileName
, pnotify
->Action
);
492 /* cifs_dump_mem("Rcvd notify Data: ",buf,
493 sizeof(struct smb_hdr)+60); */
496 if (pSMBr
->hdr
.Status
.CifsError
) {
497 cFYI(1, "notify err 0x%d",
498 pSMBr
->hdr
.Status
.CifsError
);
503 if (pSMB
->hdr
.Command
!= SMB_COM_LOCKING_ANDX
)
505 if (pSMB
->hdr
.Flags
& SMBFLG_RESPONSE
) {
506 /* no sense logging error on invalid handle on oplock
507 break - harmless race between close request and oplock
508 break response is expected from time to time writing out
509 large dirty files cached on the client */
510 if ((NT_STATUS_INVALID_HANDLE
) ==
511 le32_to_cpu(pSMB
->hdr
.Status
.CifsError
)) {
512 cFYI(1, "invalid handle on oplock break");
514 } else if (ERRbadfid
==
515 le16_to_cpu(pSMB
->hdr
.Status
.DosError
.Error
)) {
518 return false; /* on valid oplock brk we get "request" */
521 if (pSMB
->hdr
.WordCount
!= 8)
524 cFYI(1, "oplock type 0x%d level 0x%d",
525 pSMB
->LockType
, pSMB
->OplockLevel
);
526 if (!(pSMB
->LockType
& LOCKING_ANDX_OPLOCK_RELEASE
))
529 /* look up tcon based on tid & uid */
530 spin_lock(&cifs_tcp_ses_lock
);
531 list_for_each(tmp
, &srv
->smb_ses_list
) {
532 ses
= list_entry(tmp
, struct cifs_ses
, smb_ses_list
);
533 list_for_each(tmp1
, &ses
->tcon_list
) {
534 tcon
= list_entry(tmp1
, struct cifs_tcon
, tcon_list
);
535 if (tcon
->tid
!= buf
->Tid
)
538 cifs_stats_inc(&tcon
->num_oplock_brks
);
539 spin_lock(&cifs_file_list_lock
);
540 list_for_each(tmp2
, &tcon
->openFileList
) {
541 netfile
= list_entry(tmp2
, struct cifsFileInfo
,
543 if (pSMB
->Fid
!= netfile
->netfid
)
546 cFYI(1, "file id match, oplock break");
547 pCifsInode
= CIFS_I(netfile
->dentry
->d_inode
);
549 cifs_set_oplock_level(pCifsInode
,
550 pSMB
->OplockLevel
? OPLOCK_READ
: 0);
551 queue_work(cifsiod_wq
,
552 &netfile
->oplock_break
);
553 netfile
->oplock_break_cancelled
= false;
555 spin_unlock(&cifs_file_list_lock
);
556 spin_unlock(&cifs_tcp_ses_lock
);
559 spin_unlock(&cifs_file_list_lock
);
560 spin_unlock(&cifs_tcp_ses_lock
);
561 cFYI(1, "No matching file for oplock break");
565 spin_unlock(&cifs_tcp_ses_lock
);
566 cFYI(1, "Can not process oplock break for non-existent connection");
571 dump_smb(void *buf
, int smb_buf_length
)
575 unsigned char *buffer
= buf
;
580 for (i
= 0, j
= 0; i
< smb_buf_length
; i
++, j
++) {
582 /* have reached the beginning of line */
583 printk(KERN_DEBUG
"| ");
586 printk("%0#4x ", buffer
[i
]);
587 debug_line
[2 * j
] = ' ';
588 if (isprint(buffer
[i
]))
589 debug_line
[1 + (2 * j
)] = buffer
[i
];
591 debug_line
[1 + (2 * j
)] = '_';
594 /* reached end of line, time to print ascii */
596 printk(" | %s\n", debug_line
);
601 debug_line
[2 * j
] = ' ';
602 debug_line
[1 + (2 * j
)] = ' ';
604 printk(" | %s\n", debug_line
);
609 cifs_autodisable_serverino(struct cifs_sb_info
*cifs_sb
)
611 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_SERVER_INUM
) {
612 cifs_sb
->mnt_cifs_flags
&= ~CIFS_MOUNT_SERVER_INUM
;
613 cERROR(1, "Autodisabling the use of server inode numbers on "
614 "%s. This server doesn't seem to support them "
615 "properly. Hardlinks will not be recognized on this "
616 "mount. Consider mounting with the \"noserverino\" "
617 "option to silence this message.",
618 cifs_sb_master_tcon(cifs_sb
)->treeName
);
622 void cifs_set_oplock_level(struct cifsInodeInfo
*cinode
, __u32 oplock
)
626 if (oplock
== OPLOCK_EXCLUSIVE
) {
627 cinode
->clientCanCacheAll
= true;
628 cinode
->clientCanCacheRead
= true;
629 cFYI(1, "Exclusive Oplock granted on inode %p",
631 } else if (oplock
== OPLOCK_READ
) {
632 cinode
->clientCanCacheAll
= false;
633 cinode
->clientCanCacheRead
= true;
634 cFYI(1, "Level II Oplock granted on inode %p",
637 cinode
->clientCanCacheAll
= false;
638 cinode
->clientCanCacheRead
= false;
643 backup_cred(struct cifs_sb_info
*cifs_sb
)
645 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_CIFS_BACKUPUID
) {
646 if (cifs_sb
->mnt_backupuid
== current_fsuid())
649 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_CIFS_BACKUPGID
) {
650 if (in_group_p(cifs_sb
->mnt_backupgid
))