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;
35 extern struct task_struct *oplockThread;
37 /* The xid serves as a useful identifier for each incoming vfs request,
38 in a similar way to the mid which is useful to track each sent smb,
39 and CurrentXid can also provide a running counter (although it
40 will eventually wrap past zero) of the total vfs operations handled
41 since the cifs fs was mounted */
48 spin_lock(&GlobalMid_Lock);
49 GlobalTotalActiveXid++;
51 /* keep high water mark for number of simultaneous ops in filesystem */
52 if (GlobalTotalActiveXid > GlobalMaxActiveXid)
53 GlobalMaxActiveXid = GlobalTotalActiveXid;
54 if (GlobalTotalActiveXid > 65000)
55 cFYI(1, ("warning: more than 65000 requests active"));
56 xid = GlobalCurrentXid++;
57 spin_unlock(&GlobalMid_Lock);
62 _FreeXid(unsigned int xid)
64 spin_lock(&GlobalMid_Lock);
65 /* if (GlobalTotalActiveXid == 0)
67 GlobalTotalActiveXid--;
68 spin_unlock(&GlobalMid_Lock);
74 struct cifsSesInfo *ret_buf;
76 ret_buf = kzalloc(sizeof(struct cifsSesInfo), GFP_KERNEL);
78 atomic_inc(&sesInfoAllocCount);
79 ret_buf->status = CifsNew;
81 INIT_LIST_HEAD(&ret_buf->smb_ses_list);
82 INIT_LIST_HEAD(&ret_buf->tcon_list);
83 init_MUTEX(&ret_buf->sesSem);
89 sesInfoFree(struct cifsSesInfo *buf_to_free)
91 if (buf_to_free == NULL) {
92 cFYI(1, ("Null buffer passed to sesInfoFree"));
96 atomic_dec(&sesInfoAllocCount);
97 kfree(buf_to_free->serverOS);
98 kfree(buf_to_free->serverDomain);
99 kfree(buf_to_free->serverNOS);
100 if (buf_to_free->password) {
101 memset(buf_to_free->password, 0, strlen(buf_to_free->password));
102 kfree(buf_to_free->password);
104 kfree(buf_to_free->domainName);
108 struct cifsTconInfo *
111 struct cifsTconInfo *ret_buf;
112 ret_buf = kzalloc(sizeof(struct cifsTconInfo), 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 cifsTconInfo *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);
141 struct smb_hdr *ret_buf = NULL;
143 /* We could use negotiated size instead of max_msgsize -
144 but it may be more efficient to always alloc same size
145 albeit slightly larger than necessary and maxbuffersize
146 defaults to this and can not be bigger */
147 ret_buf = mempool_alloc(cifs_req_poolp, GFP_NOFS);
149 /* clear the first few header bytes */
150 /* for most paths, more is cleared in header_assemble */
152 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
153 atomic_inc(&bufAllocCount);
154 #ifdef CONFIG_CIFS_STATS2
155 atomic_inc(&totBufAllocCount);
156 #endif /* CONFIG_CIFS_STATS2 */
163 cifs_buf_release(void *buf_to_free)
165 if (buf_to_free == NULL) {
166 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
169 mempool_free(buf_to_free, cifs_req_poolp);
171 atomic_dec(&bufAllocCount);
176 cifs_small_buf_get(void)
178 struct smb_hdr *ret_buf = NULL;
180 /* We could use negotiated size instead of max_msgsize -
181 but it may be more efficient to always alloc same size
182 albeit slightly larger than necessary and maxbuffersize
183 defaults to this and can not be bigger */
184 ret_buf = mempool_alloc(cifs_sm_req_poolp, GFP_NOFS);
186 /* No need to clear memory here, cleared in header assemble */
187 /* memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
188 atomic_inc(&smBufAllocCount);
189 #ifdef CONFIG_CIFS_STATS2
190 atomic_inc(&totSmBufAllocCount);
191 #endif /* CONFIG_CIFS_STATS2 */
198 cifs_small_buf_release(void *buf_to_free)
201 if (buf_to_free == NULL) {
202 cFYI(1, ("Null buffer passed to cifs_small_buf_release"));
205 mempool_free(buf_to_free, cifs_sm_req_poolp);
207 atomic_dec(&smBufAllocCount);
212 Find a free multiplex id (SMB mid). Otherwise there could be
213 mid collisions which might cause problems, demultiplexing the
214 wrong response to this request. Multiplex ids could collide if
215 one of a series requests takes much longer than the others, or
216 if a very large number of long lived requests (byte range
217 locks or FindNotify requests) are pending. No more than
218 64K-1 requests can be outstanding at one time. If no
219 mids are available, return zero. A future optimization
220 could make the combination of mids and uid the key we use
221 to demultiplex on (rather than mid alone).
222 In addition to the above check, the cifs demultiplex
223 code already used the command code as a secondary
224 check of the frame and if signing is negotiated the
225 response would be discarded if the mid were the same
226 but the signature was wrong. Since the mid is not put in the
227 pending queue until later (when it is about to be dispatched)
228 we do have to limit the number of outstanding requests
229 to somewhat less than 64K-1 although it is hard to imagine
230 so many threads being in the vfs at one time.
232 __u16 GetNextMid(struct TCP_Server_Info *server)
241 spin_lock(&GlobalMid_Lock);
242 last_mid = server->CurrentMid; /* we do not want to loop forever */
243 server->CurrentMid++;
244 /* This nested loop looks more expensive than it is.
245 In practice the list of pending requests is short,
246 fewer than 50, and the mids are likely to be unique
247 on the first pass through the loop unless some request
248 takes longer than the 64 thousand requests before it
249 (and it would also have to have been a request that
251 while (server->CurrentMid != last_mid) {
252 struct list_head *tmp;
253 struct mid_q_entry *mid_entry;
256 if (server->CurrentMid == 0)
257 server->CurrentMid++;
259 list_for_each(tmp, &server->pending_mid_q) {
260 mid_entry = list_entry(tmp, struct mid_q_entry, qhead);
262 if ((mid_entry->mid == server->CurrentMid) &&
263 (mid_entry->midState == MID_REQUEST_SUBMITTED)) {
264 /* This mid is in use, try a different one */
269 if (collision == 0) {
270 mid = server->CurrentMid;
273 server->CurrentMid++;
275 spin_unlock(&GlobalMid_Lock);
279 /* NB: MID can not be set if treeCon not passed in, in that
280 case it is responsbility of caller to set the mid */
282 header_assemble(struct smb_hdr *buffer, char smb_command /* command */ ,
283 const struct cifsTconInfo *treeCon, int word_count
284 /* length of fixed section (word count) in two byte units */)
286 struct list_head *temp_item;
287 struct cifsSesInfo *ses;
288 char *temp = (char *) buffer;
290 memset(temp, 0, 256); /* bigger than MAX_CIFS_HDR_SIZE */
292 buffer->smb_buf_length =
293 (2 * word_count) + sizeof(struct smb_hdr) -
294 4 /* RFC 1001 length field does not count */ +
295 2 /* for bcc field itself */ ;
296 /* Note that this is the only network field that has to be converted
297 to big endian and it is done just before we send it */
299 buffer->Protocol[0] = 0xFF;
300 buffer->Protocol[1] = 'S';
301 buffer->Protocol[2] = 'M';
302 buffer->Protocol[3] = 'B';
303 buffer->Command = smb_command;
304 buffer->Flags = 0x00; /* case sensitive */
305 buffer->Flags2 = SMBFLG2_KNOWS_LONG_NAMES;
306 buffer->Pid = cpu_to_le16((__u16)current->tgid);
307 buffer->PidHigh = cpu_to_le16((__u16)(current->tgid >> 16));
309 buffer->Tid = treeCon->tid;
311 if (treeCon->ses->capabilities & CAP_UNICODE)
312 buffer->Flags2 |= SMBFLG2_UNICODE;
313 if (treeCon->ses->capabilities & CAP_STATUS32)
314 buffer->Flags2 |= SMBFLG2_ERR_STATUS;
316 /* Uid is not converted */
317 buffer->Uid = treeCon->ses->Suid;
318 buffer->Mid = GetNextMid(treeCon->ses->server);
319 if (multiuser_mount != 0) {
320 /* For the multiuser case, there are few obvious technically */
321 /* possible mechanisms to match the local linux user (uid) */
322 /* to a valid remote smb user (smb_uid): */
323 /* 1) Query Winbind (or other local pam/nss daemon */
324 /* for userid/password/logon_domain or credential */
325 /* 2) Query Winbind for uid to sid to username mapping */
326 /* and see if we have a matching password for existing*/
327 /* session for that user perhas getting password by */
328 /* adding a new pam_cifs module that stores passwords */
329 /* so that the cifs vfs can get at that for all logged*/
331 /* 3) (Which is the mechanism we have chosen) */
332 /* Search through sessions to the same server for a */
333 /* a match on the uid that was passed in on mount */
334 /* with the current processes uid (or euid?) and use */
335 /* that smb uid. If no existing smb session for */
336 /* that uid found, use the default smb session ie */
337 /* the smb session for the volume mounted which is */
338 /* the same as would be used if the multiuser mount */
339 /* flag were disabled. */
341 /* BB Add support for establishing new tCon and SMB Session */
342 /* with userid/password pairs found on the smb session */
343 /* for other target tcp/ip addresses BB */
344 if (current->fsuid != treeCon->ses->linux_uid) {
345 cFYI(1, ("Multiuser mode and UID "
346 "did not match tcon uid"));
347 read_lock(&cifs_tcp_ses_lock);
348 list_for_each(temp_item, &treeCon->ses->server->smb_ses_list) {
349 ses = list_entry(temp_item, struct cifsSesInfo, smb_ses_list);
350 if (ses->linux_uid == current->fsuid) {
351 if (ses->server == treeCon->ses->server) {
352 cFYI(1, ("found matching uid substitute right smb_uid"));
353 buffer->Uid = ses->Suid;
356 /* BB eventually call cifs_setup_session here */
357 cFYI(1, ("local UID found but no smb sess with this server exists"));
361 read_unlock(&cifs_tcp_ses_lock);
365 if (treeCon->Flags & SMB_SHARE_IS_IN_DFS)
366 buffer->Flags2 |= SMBFLG2_DFS;
368 buffer->Flags |= SMBFLG_CASELESS;
369 if ((treeCon->ses) && (treeCon->ses->server))
370 if (treeCon->ses->server->secMode &
371 (SECMODE_SIGN_REQUIRED | SECMODE_SIGN_ENABLED))
372 buffer->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
375 /* endian conversion of flags is now done just before sending */
376 buffer->WordCount = (char) word_count;
381 checkSMBhdr(struct smb_hdr *smb, __u16 mid)
383 /* Make sure that this really is an SMB, that it is a response,
384 and that the message ids match */
385 if ((*(__le32 *) smb->Protocol == cpu_to_le32(0x424d53ff)) &&
387 if (smb->Flags & SMBFLG_RESPONSE)
390 /* only one valid case where server sends us request */
391 if (smb->Command == SMB_COM_LOCKING_ANDX)
394 cERROR(1, ("Received Request not response"));
396 } else { /* bad signature or mid */
397 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff))
399 ("Bad protocol string signature header %x",
400 *(unsigned int *) smb->Protocol));
402 cERROR(1, ("Mids do not match"));
404 cERROR(1, ("bad smb detected. The Mid=%d", smb->Mid));
409 checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length)
411 __u32 len = smb->smb_buf_length;
412 __u32 clc_len; /* calculated length */
413 cFYI(0, ("checkSMB Length: 0x%x, smb_buf_length: 0x%x", length, len));
415 if (length < 2 + sizeof(struct smb_hdr)) {
416 if ((length >= sizeof(struct smb_hdr) - 1)
417 && (smb->Status.CifsError != 0)) {
419 /* some error cases do not return wct and bcc */
421 } else if ((length == sizeof(struct smb_hdr) + 1) &&
422 (smb->WordCount == 0)) {
423 char *tmp = (char *)smb;
424 /* Need to work around a bug in two servers here */
425 /* First, check if the part of bcc they sent was zero */
426 if (tmp[sizeof(struct smb_hdr)] == 0) {
427 /* some servers return only half of bcc
428 * on simple responses (wct, bcc both zero)
429 * in particular have seen this on
430 * ulogoffX and FindClose. This leaves
431 * one byte of bcc potentially unitialized
433 /* zero rest of bcc */
434 tmp[sizeof(struct smb_hdr)+1] = 0;
437 cERROR(1, ("rcvd invalid byte count (bcc)"));
439 cERROR(1, ("Length less than smb header size"));
443 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
444 cERROR(1, ("smb length greater than MaxBufSize, mid=%d",
449 if (checkSMBhdr(smb, mid))
451 clc_len = smbCalcSize_LE(smb);
453 if (4 + len != length) {
454 cERROR(1, ("Length read does not match RFC1001 length %d",
459 if (4 + len != clc_len) {
460 /* check if bcc wrapped around for large read responses */
461 if ((len > 64 * 1024) && (len > clc_len)) {
462 /* check if lengths match mod 64K */
463 if (((4 + len) & 0xFFFF) == (clc_len & 0xFFFF))
464 return 0; /* bcc wrapped */
466 cFYI(1, ("Calculated size %d vs length %d mismatch for mid %d",
467 clc_len, 4 + len, smb->Mid));
468 /* Windows XP can return a few bytes too much, presumably
469 an illegal pad, at the end of byte range lock responses
470 so we allow for that three byte pad, as long as actual
471 received length is as long or longer than calculated length */
472 /* We have now had to extend this more, since there is a
473 case in which it needs to be bigger still to handle a
474 malformed response to transact2 findfirst from WinXP when
475 access denied is returned and thus bcc and wct are zero
476 but server says length is 0x21 bytes too long as if the server
477 forget to reset the smb rfc1001 length when it reset the
478 wct and bcc to minimum size and drop the t2 parms and data */
479 if ((4+len > clc_len) && (len <= clc_len + 512))
482 cERROR(1, ("RFC1001 size %d bigger than SMB for Mid=%d",
491 is_valid_oplock_break(struct smb_hdr *buf, struct TCP_Server_Info *srv)
493 struct smb_com_lock_req *pSMB = (struct smb_com_lock_req *)buf;
494 struct list_head *tmp, *tmp1, *tmp2;
495 struct cifsSesInfo *ses;
496 struct cifsTconInfo *tcon;
497 struct cifsInodeInfo *pCifsInode;
498 struct cifsFileInfo *netfile;
500 cFYI(1, ("Checking for oplock break or dnotify response"));
501 if ((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
502 (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
503 struct smb_com_transaction_change_notify_rsp *pSMBr =
504 (struct smb_com_transaction_change_notify_rsp *)buf;
505 struct file_notify_information *pnotify;
506 __u32 data_offset = 0;
507 if (pSMBr->ByteCount > sizeof(struct file_notify_information)) {
508 data_offset = le32_to_cpu(pSMBr->DataOffset);
510 pnotify = (struct file_notify_information *)
511 ((char *)&pSMBr->hdr.Protocol + data_offset);
512 cFYI(1, ("dnotify on %s Action: 0x%x",
513 pnotify->FileName, pnotify->Action));
514 /* cifs_dump_mem("Rcvd notify Data: ",buf,
515 sizeof(struct smb_hdr)+60); */
518 if (pSMBr->hdr.Status.CifsError) {
519 cFYI(1, ("notify err 0x%d",
520 pSMBr->hdr.Status.CifsError));
525 if (pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
527 if (pSMB->hdr.Flags & SMBFLG_RESPONSE) {
528 /* no sense logging error on invalid handle on oplock
529 break - harmless race between close request and oplock
530 break response is expected from time to time writing out
531 large dirty files cached on the client */
532 if ((NT_STATUS_INVALID_HANDLE) ==
533 le32_to_cpu(pSMB->hdr.Status.CifsError)) {
534 cFYI(1, ("invalid handle on oplock break"));
536 } else if (ERRbadfid ==
537 le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
540 return false; /* on valid oplock brk we get "request" */
543 if (pSMB->hdr.WordCount != 8)
546 cFYI(1, ("oplock type 0x%d level 0x%d",
547 pSMB->LockType, pSMB->OplockLevel));
548 if (!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
551 /* look up tcon based on tid & uid */
552 read_lock(&cifs_tcp_ses_lock);
553 list_for_each(tmp, &srv->smb_ses_list) {
554 ses = list_entry(tmp, struct cifsSesInfo, smb_ses_list);
555 list_for_each(tmp1, &ses->tcon_list) {
556 tcon = list_entry(tmp1, struct cifsTconInfo, tcon_list);
557 if (tcon->tid != buf->Tid)
560 cifs_stats_inc(&tcon->num_oplock_brks);
561 write_lock(&GlobalSMBSeslock);
562 list_for_each(tmp2, &tcon->openFileList) {
563 netfile = list_entry(tmp2, struct cifsFileInfo,
565 if (pSMB->Fid != netfile->netfid)
568 write_unlock(&GlobalSMBSeslock);
569 read_unlock(&cifs_tcp_ses_lock);
570 cFYI(1, ("file id match, oplock break"));
571 pCifsInode = CIFS_I(netfile->pInode);
572 pCifsInode->clientCanCacheAll = false;
573 if (pSMB->OplockLevel == 0)
574 pCifsInode->clientCanCacheRead = false;
575 pCifsInode->oplockPending = true;
576 AllocOplockQEntry(netfile->pInode,
577 netfile->netfid, tcon);
578 cFYI(1, ("about to wake up oplock thread"));
580 wake_up_process(oplockThread);
584 write_unlock(&GlobalSMBSeslock);
585 read_unlock(&cifs_tcp_ses_lock);
586 cFYI(1, ("No matching file for oplock break"));
590 read_unlock(&cifs_tcp_ses_lock);
591 cFYI(1, ("Can not process oplock break for non-existent connection"));
596 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
600 unsigned char *buffer;
605 buffer = (unsigned char *) smb_buf;
606 for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
608 /* have reached the beginning of line */
609 printk(KERN_DEBUG "| ");
612 printk("%0#4x ", buffer[i]);
613 debug_line[2 * j] = ' ';
614 if (isprint(buffer[i]))
615 debug_line[1 + (2 * j)] = buffer[i];
617 debug_line[1 + (2 * j)] = '_';
620 /* reached end of line, time to print ascii */
622 printk(" | %s\n", debug_line);
627 debug_line[2 * j] = ' ';
628 debug_line[1 + (2 * j)] = ' ';
630 printk(" | %s\n", debug_line);
634 /* Windows maps these to the user defined 16 bit Unicode range since they are
635 reserved symbols (along with \ and /), otherwise illegal to store
636 in filenames in NTFS */
637 #define UNI_ASTERIK (__u16) ('*' + 0xF000)
638 #define UNI_QUESTION (__u16) ('?' + 0xF000)
639 #define UNI_COLON (__u16) (':' + 0xF000)
640 #define UNI_GRTRTHAN (__u16) ('>' + 0xF000)
641 #define UNI_LESSTHAN (__u16) ('<' + 0xF000)
642 #define UNI_PIPE (__u16) ('|' + 0xF000)
643 #define UNI_SLASH (__u16) ('\\' + 0xF000)
645 /* Convert 16 bit Unicode pathname from wire format to string in current code
646 page. Conversion may involve remapping up the seven characters that are
647 only legal in POSIX-like OS (if they are present in the string). Path
648 names are little endian 16 bit Unicode on the wire */
650 cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
651 const struct nls_table *cp)
656 for (i = 0, j = 0; i < maxlen; i++) {
657 src_char = le16_to_cpu(source[i]);
660 goto cUCS_out; /* BB check this BB */
670 /* BB We can not handle remapping slash until
671 all the calls to build_path_from_dentry
672 are modified, as they use slash as separator BB */
686 len = cp->uni2char(src_char, &target[j],
687 NLS_MAX_CHARSET_SIZE);
696 /* make sure we do not overrun callers allocated temp buffer */
697 if (j >= (2 * NAME_MAX))
705 /* Convert 16 bit Unicode pathname to wire format from string in current code
706 page. Conversion may involve remapping up the seven characters that are
707 only legal in POSIX-like OS (if they are present in the string). Path
708 names are little endian 16 bit Unicode on the wire */
710 cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
711 const struct nls_table *cp, int mapChars)
714 int len_remaining = maxlen;
719 return cifs_strtoUCS(target, source, PATH_MAX, cp);
721 for (i = 0, j = 0; i < maxlen; j++) {
722 src_char = source[i];
728 target[j] = cpu_to_le16(UNI_COLON);
731 target[j] = cpu_to_le16(UNI_ASTERIK);
734 target[j] = cpu_to_le16(UNI_QUESTION);
737 target[j] = cpu_to_le16(UNI_LESSTHAN);
740 target[j] = cpu_to_le16(UNI_GRTRTHAN);
743 target[j] = cpu_to_le16(UNI_PIPE);
745 /* BB We can not handle remapping slash until
746 all the calls to build_path_from_dentry
747 are modified, as they use slash as separator BB */
749 target[j] = cpu_to_le16(UNI_SLASH);
752 charlen = cp->char2uni(source+i,
753 len_remaining, &temp);
754 /* if no match, use question mark, which
755 at least in some cases servers as wild card */
757 target[j] = cpu_to_le16(0x003f);
760 target[j] = cpu_to_le16(temp);
761 len_remaining -= charlen;
762 /* character may take more than one byte in the
763 the source string, but will take exactly two
764 bytes in the target string */
768 i++; /* move to next char in source string */