4 * Copyright (C) International Business Machines Corp., 2002,2005
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++;
50 if (GlobalTotalActiveXid > GlobalMaxActiveXid)
51 GlobalMaxActiveXid = GlobalTotalActiveXid; /* keep high water mark for number of simultaneous vfs ops in our filesystem */
52 if(GlobalTotalActiveXid > 65000)
53 cFYI(1,("warning: more than 65000 requests active"));
54 xid = GlobalCurrentXid++;
55 spin_unlock(&GlobalMid_Lock);
60 _FreeXid(unsigned int xid)
62 spin_lock(&GlobalMid_Lock);
63 /* if(GlobalTotalActiveXid == 0)
65 GlobalTotalActiveXid--;
66 spin_unlock(&GlobalMid_Lock);
72 struct cifsSesInfo *ret_buf;
74 ret_buf = kzalloc(sizeof (struct cifsSesInfo), GFP_KERNEL);
76 write_lock(&GlobalSMBSeslock);
77 atomic_inc(&sesInfoAllocCount);
78 ret_buf->status = CifsNew;
79 list_add(&ret_buf->cifsSessionList, &GlobalSMBSessionList);
80 init_MUTEX(&ret_buf->sesSem);
81 write_unlock(&GlobalSMBSeslock);
87 sesInfoFree(struct cifsSesInfo *buf_to_free)
89 if (buf_to_free == NULL) {
90 cFYI(1, ("Null buffer passed to sesInfoFree"));
94 write_lock(&GlobalSMBSeslock);
95 atomic_dec(&sesInfoAllocCount);
96 list_del(&buf_to_free->cifsSessionList);
97 write_unlock(&GlobalSMBSeslock);
98 kfree(buf_to_free->serverOS);
99 kfree(buf_to_free->serverDomain);
100 kfree(buf_to_free->serverNOS);
101 kfree(buf_to_free->password);
102 kfree(buf_to_free->domainName);
106 struct cifsTconInfo *
109 struct cifsTconInfo *ret_buf;
110 ret_buf = kzalloc(sizeof (struct cifsTconInfo), GFP_KERNEL);
112 write_lock(&GlobalSMBSeslock);
113 atomic_inc(&tconInfoAllocCount);
114 list_add(&ret_buf->cifsConnectionList,
115 &GlobalTreeConnectionList);
116 ret_buf->tidStatus = CifsNew;
117 INIT_LIST_HEAD(&ret_buf->openFileList);
118 init_MUTEX(&ret_buf->tconSem);
119 #ifdef CONFIG_CIFS_STATS
120 spin_lock_init(&ret_buf->stat_lock);
122 write_unlock(&GlobalSMBSeslock);
128 tconInfoFree(struct cifsTconInfo *buf_to_free)
130 if (buf_to_free == NULL) {
131 cFYI(1, ("Null buffer passed to tconInfoFree"));
134 write_lock(&GlobalSMBSeslock);
135 atomic_dec(&tconInfoAllocCount);
136 list_del(&buf_to_free->cifsConnectionList);
137 write_unlock(&GlobalSMBSeslock);
138 kfree(buf_to_free->nativeFileSystem);
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 */
152 (struct smb_hdr *) mempool_alloc(cifs_req_poolp, GFP_KERNEL | GFP_NOFS);
154 /* clear the first few header bytes */
155 /* for most paths, more is cleared in header_assemble */
157 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
158 atomic_inc(&bufAllocCount);
159 #ifdef CONFIG_CIFS_STATS2
160 atomic_inc(&totBufAllocCount);
161 #endif /* CONFIG_CIFS_STATS2 */
168 cifs_buf_release(void *buf_to_free)
171 if (buf_to_free == NULL) {
172 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
175 mempool_free(buf_to_free,cifs_req_poolp);
177 atomic_dec(&bufAllocCount);
182 cifs_small_buf_get(void)
184 struct smb_hdr *ret_buf = NULL;
186 /* We could use negotiated size instead of max_msgsize -
187 but it may be more efficient to always alloc same size
188 albeit slightly larger than necessary and maxbuffersize
189 defaults to this and can not be bigger */
191 (struct smb_hdr *) mempool_alloc(cifs_sm_req_poolp, GFP_KERNEL | GFP_NOFS);
193 /* No need to clear memory here, cleared in header assemble */
194 /* memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
195 atomic_inc(&smBufAllocCount);
196 #ifdef CONFIG_CIFS_STATS2
197 atomic_inc(&totSmBufAllocCount);
198 #endif /* CONFIG_CIFS_STATS2 */
205 cifs_small_buf_release(void *buf_to_free)
208 if (buf_to_free == NULL) {
209 cFYI(1, ("Null buffer passed to cifs_small_buf_release"));
212 mempool_free(buf_to_free,cifs_sm_req_poolp);
214 atomic_dec(&smBufAllocCount);
219 Find a free multiplex id (SMB mid). Otherwise there could be
220 mid collisions which might cause problems, demultiplexing the
221 wrong response to this request. Multiplex ids could collide if
222 one of a series requests takes much longer than the others, or
223 if a very large number of long lived requests (byte range
224 locks or FindNotify requests) are pending. No more than
225 64K-1 requests can be outstanding at one time. If no
226 mids are available, return zero. A future optimization
227 could make the combination of mids and uid the key we use
228 to demultiplex on (rather than mid alone).
229 In addition to the above check, the cifs demultiplex
230 code already used the command code as a secondary
231 check of the frame and if signing is negotiated the
232 response would be discarded if the mid were the same
233 but the signature was wrong. Since the mid is not put in the
234 pending queue until later (when it is about to be dispatched)
235 we do have to limit the number of outstanding requests
236 to somewhat less than 64K-1 although it is hard to imagine
237 so many threads being in the vfs at one time.
239 __u16 GetNextMid(struct TCP_Server_Info *server)
248 spin_lock(&GlobalMid_Lock);
249 last_mid = server->CurrentMid; /* we do not want to loop forever */
250 server->CurrentMid++;
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
258 while(server->CurrentMid != last_mid) {
259 struct list_head *tmp;
260 struct mid_q_entry *mid_entry;
263 if(server->CurrentMid == 0)
264 server->CurrentMid++;
266 list_for_each(tmp, &server->pending_mid_q) {
267 mid_entry = list_entry(tmp, struct mid_q_entry, qhead);
269 if ((mid_entry->mid == server->CurrentMid) &&
270 (mid_entry->midState == MID_REQUEST_SUBMITTED)) {
271 /* This mid is in use, try a different one */
277 mid = server->CurrentMid;
280 server->CurrentMid++;
282 spin_unlock(&GlobalMid_Lock);
286 /* NB: MID can not be set if treeCon not passed in, in that
287 case it is responsbility of caller to set the mid */
289 header_assemble(struct smb_hdr *buffer, char smb_command /* command */ ,
290 const struct cifsTconInfo *treeCon, int word_count
291 /* length of fixed section (word count) in two byte units */)
293 struct list_head* temp_item;
294 struct cifsSesInfo * ses;
295 char *temp = (char *) buffer;
297 memset(temp,0,256); /* bigger than MAX_CIFS_HDR_SIZE */
299 buffer->smb_buf_length =
300 (2 * word_count) + sizeof (struct smb_hdr) -
301 4 /* RFC 1001 length field does not count */ +
302 2 /* for bcc field itself */ ;
303 /* Note that this is the only network field that has to be converted
304 to big endian and it is done just before we send it */
306 buffer->Protocol[0] = 0xFF;
307 buffer->Protocol[1] = 'S';
308 buffer->Protocol[2] = 'M';
309 buffer->Protocol[3] = 'B';
310 buffer->Command = smb_command;
311 buffer->Flags = 0x00; /* case sensitive */
312 buffer->Flags2 = SMBFLG2_KNOWS_LONG_NAMES;
313 buffer->Pid = cpu_to_le16((__u16)current->tgid);
314 buffer->PidHigh = cpu_to_le16((__u16)(current->tgid >> 16));
315 spin_lock(&GlobalMid_Lock);
316 spin_unlock(&GlobalMid_Lock);
318 buffer->Tid = treeCon->tid;
320 if (treeCon->ses->capabilities & CAP_UNICODE)
321 buffer->Flags2 |= SMBFLG2_UNICODE;
322 if (treeCon->ses->capabilities & CAP_STATUS32) {
323 buffer->Flags2 |= SMBFLG2_ERR_STATUS;
325 /* Uid is not converted */
326 buffer->Uid = treeCon->ses->Suid;
327 buffer->Mid = GetNextMid(treeCon->ses->server);
328 if(multiuser_mount != 0) {
329 /* For the multiuser case, there are few obvious technically */
330 /* possible mechanisms to match the local linux user (uid) */
331 /* to a valid remote smb user (smb_uid): */
332 /* 1) Query Winbind (or other local pam/nss daemon */
333 /* for userid/password/logon_domain or credential */
334 /* 2) Query Winbind for uid to sid to username mapping */
335 /* and see if we have a matching password for existing*/
336 /* session for that user perhas getting password by */
337 /* adding a new pam_cifs module that stores passwords */
338 /* so that the cifs vfs can get at that for all logged*/
340 /* 3) (Which is the mechanism we have chosen) */
341 /* Search through sessions to the same server for a */
342 /* a match on the uid that was passed in on mount */
343 /* with the current processes uid (or euid?) and use */
344 /* that smb uid. If no existing smb session for */
345 /* that uid found, use the default smb session ie */
346 /* the smb session for the volume mounted which is */
347 /* the same as would be used if the multiuser mount */
348 /* flag were disabled. */
350 /* BB Add support for establishing new tCon and SMB Session */
351 /* with userid/password pairs found on the smb session */
352 /* for other target tcp/ip addresses BB */
353 if(current->fsuid != treeCon->ses->linux_uid) {
354 cFYI(1,("Multiuser mode and UID did not match tcon uid"));
355 read_lock(&GlobalSMBSeslock);
356 list_for_each(temp_item, &GlobalSMBSessionList) {
357 ses = list_entry(temp_item, struct cifsSesInfo, cifsSessionList);
358 if(ses->linux_uid == current->fsuid) {
359 if(ses->server == treeCon->ses->server) {
360 cFYI(1,("found matching uid substitute right smb_uid"));
361 buffer->Uid = ses->Suid;
364 /* BB eventually call cifs_setup_session here */
365 cFYI(1,("local UID found but smb sess with this server does not exist"));
369 read_unlock(&GlobalSMBSeslock);
373 if (treeCon->Flags & SMB_SHARE_IS_IN_DFS)
374 buffer->Flags2 |= SMBFLG2_DFS;
376 buffer->Flags |= SMBFLG_CASELESS;
377 if((treeCon->ses) && (treeCon->ses->server))
378 if(treeCon->ses->server->secMode &
379 (SECMODE_SIGN_REQUIRED | SECMODE_SIGN_ENABLED))
380 buffer->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
383 /* endian conversion of flags is now done just before sending */
384 buffer->WordCount = (char) word_count;
389 checkSMBhdr(struct smb_hdr *smb, __u16 mid)
391 /* Make sure that this really is an SMB, that it is a response,
392 and that the message ids match */
393 if ((*(__le32 *) smb->Protocol == cpu_to_le32(0x424d53ff)) &&
395 if(smb->Flags & SMBFLG_RESPONSE)
398 /* only one valid case where server sends us request */
399 if(smb->Command == SMB_COM_LOCKING_ANDX)
402 cERROR(1, ("Rcvd Request not response"));
404 } else { /* bad signature or mid */
405 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff))
407 ("Bad protocol string signature header %x",
408 *(unsigned int *) smb->Protocol));
410 cERROR(1, ("Mids do not match"));
412 cERROR(1, ("bad smb detected. The Mid=%d", smb->Mid));
417 checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length)
419 __u32 len = smb->smb_buf_length;
420 __u32 clc_len; /* calculated length */
421 cFYI(0, ("checkSMB Length: 0x%x, smb_buf_length: 0x%x", length, len));
423 if (length < 2 + sizeof (struct smb_hdr)) {
424 if ((length >= sizeof (struct smb_hdr) - 1)
425 && (smb->Status.CifsError != 0)) {
427 /* some error cases do not return wct and bcc */
429 } else if ((length == sizeof(struct smb_hdr) + 1) &&
430 (smb->WordCount == 0)) {
431 char * tmp = (char *)smb;
432 /* Need to work around a bug in two servers here */
433 /* First, check if the part of bcc they sent was zero */
434 if (tmp[sizeof(struct smb_hdr)] == 0) {
435 /* some servers return only half of bcc
436 * on simple responses (wct, bcc both zero)
437 * in particular have seen this on
438 * ulogoffX and FindClose. This leaves
439 * one byte of bcc potentially unitialized
441 /* zero rest of bcc */
442 tmp[sizeof(struct smb_hdr)+1] = 0;
445 cERROR(1,("rcvd invalid byte count (bcc)"));
447 cERROR(1, ("Length less than smb header size"));
451 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
452 cERROR(1, ("smb length greater than MaxBufSize, mid=%d",
457 if (checkSMBhdr(smb, mid))
459 clc_len = smbCalcSize_LE(smb);
461 if(4 + len != length) {
462 cERROR(1, ("Length read does not match RFC1001 length %d",len));
466 if (4 + len != clc_len) {
467 /* check if bcc wrapped around for large read responses */
468 if((len > 64 * 1024) && (len > clc_len)) {
469 /* check if lengths match mod 64K */
470 if(((4 + len) & 0xFFFF) == (clc_len & 0xFFFF))
471 return 0; /* bcc wrapped */
473 cFYI(1, ("Calculated size %d vs length %d mismatch for mid %d",
474 clc_len, 4 + len, smb->Mid));
475 /* Windows XP can return a few bytes too much, presumably
476 an illegal pad, at the end of byte range lock responses
477 so we allow for that three byte pad, as long as actual
478 received length is as long or longer than calculated length */
479 /* We have now had to extend this more, since there is a
480 case in which it needs to be bigger still to handle a
481 malformed response to transact2 findfirst from WinXP when
482 access denied is returned and thus bcc and wct are zero
483 but server says length is 0x21 bytes too long as if the server
484 forget to reset the smb rfc1001 length when it reset the
485 wct and bcc to minimum size and drop the t2 parms and data */
486 if((4+len > clc_len) && (len <= clc_len + 512))
489 cERROR(1, ("RFC1001 size %d bigger than SMB for Mid=%d",
497 is_valid_oplock_break(struct smb_hdr *buf, struct TCP_Server_Info *srv)
499 struct smb_com_lock_req * pSMB = (struct smb_com_lock_req *)buf;
500 struct list_head *tmp;
501 struct list_head *tmp1;
502 struct cifsTconInfo *tcon;
503 struct cifsFileInfo *netfile;
505 cFYI(1,("Checking for oplock break or dnotify response"));
506 if((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
507 (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
508 struct smb_com_transaction_change_notify_rsp * pSMBr =
509 (struct smb_com_transaction_change_notify_rsp *)buf;
510 struct file_notify_information * pnotify;
511 __u32 data_offset = 0;
512 if(pSMBr->ByteCount > sizeof(struct file_notify_information)) {
513 data_offset = le32_to_cpu(pSMBr->DataOffset);
515 pnotify = (struct file_notify_information *)
516 ((char *)&pSMBr->hdr.Protocol + data_offset);
517 cFYI(1,("dnotify on %s Action: 0x%x",pnotify->FileName,
518 pnotify->Action)); /* BB removeme BB */
519 /* cifs_dump_mem("Rcvd notify Data: ",buf,
520 sizeof(struct smb_hdr)+60); */
523 if(pSMBr->hdr.Status.CifsError) {
524 cFYI(1,("notify err 0x%d",pSMBr->hdr.Status.CifsError));
529 if(pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
531 if(pSMB->hdr.Flags & SMBFLG_RESPONSE) {
532 /* no sense logging error on invalid handle on oplock
533 break - harmless race between close request and oplock
534 break response is expected from time to time writing out
535 large dirty files cached on the client */
536 if ((NT_STATUS_INVALID_HANDLE) ==
537 le32_to_cpu(pSMB->hdr.Status.CifsError)) {
538 cFYI(1,("invalid handle on oplock break"));
540 } else if (ERRbadfid ==
541 le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
544 return FALSE; /* on valid oplock brk we get "request" */
547 if(pSMB->hdr.WordCount != 8)
550 cFYI(1,(" oplock type 0x%d level 0x%d",pSMB->LockType,pSMB->OplockLevel));
551 if(!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
554 /* look up tcon based on tid & uid */
555 read_lock(&GlobalSMBSeslock);
556 list_for_each(tmp, &GlobalTreeConnectionList) {
557 tcon = list_entry(tmp, struct cifsTconInfo, cifsConnectionList);
558 if ((tcon->tid == buf->Tid) && (srv == tcon->ses->server)) {
559 cifs_stats_inc(&tcon->num_oplock_brks);
560 list_for_each(tmp1,&tcon->openFileList){
561 netfile = list_entry(tmp1,struct cifsFileInfo,
563 if(pSMB->Fid == netfile->netfid) {
564 struct cifsInodeInfo *pCifsInode;
565 read_unlock(&GlobalSMBSeslock);
566 cFYI(1,("file id match, oplock break"));
568 CIFS_I(netfile->pInode);
569 pCifsInode->clientCanCacheAll = FALSE;
570 if(pSMB->OplockLevel == 0)
571 pCifsInode->clientCanCacheRead
573 pCifsInode->oplockPending = TRUE;
574 AllocOplockQEntry(netfile->pInode,
577 cFYI(1,("about to wake up oplock thd"));
579 wake_up_process(oplockThread);
583 read_unlock(&GlobalSMBSeslock);
584 cFYI(1,("No matching file for oplock break"));
588 read_unlock(&GlobalSMBSeslock);
589 cFYI(1,("Can not process oplock break for non-existent connection"));
594 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
598 unsigned char *buffer;
603 buffer = (unsigned char *) smb_buf;
604 for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
605 if (i % 8 == 0) { /* have reached the beginning of line */
606 printk(KERN_DEBUG "| ");
609 printk("%0#4x ", buffer[i]);
610 debug_line[2 * j] = ' ';
611 if (isprint(buffer[i]))
612 debug_line[1 + (2 * j)] = buffer[i];
614 debug_line[1 + (2 * j)] = '_';
616 if (i % 8 == 7) { /* reached end of line, time to print ascii */
618 printk(" | %s\n", debug_line);
623 debug_line[2 * j] = ' ';
624 debug_line[1 + (2 * j)] = ' ';
626 printk( " | %s\n", debug_line);
630 /* Windows maps these to the user defined 16 bit Unicode range since they are
631 reserved symbols (along with \ and /), otherwise illegal to store
632 in filenames in NTFS */
633 #define UNI_ASTERIK (__u16) ('*' + 0xF000)
634 #define UNI_QUESTION (__u16) ('?' + 0xF000)
635 #define UNI_COLON (__u16) (':' + 0xF000)
636 #define UNI_GRTRTHAN (__u16) ('>' + 0xF000)
637 #define UNI_LESSTHAN (__u16) ('<' + 0xF000)
638 #define UNI_PIPE (__u16) ('|' + 0xF000)
639 #define UNI_SLASH (__u16) ('\\' + 0xF000)
641 /* Convert 16 bit Unicode pathname from wire format to string in current code
642 page. Conversion may involve remapping up the seven characters that are
643 only legal in POSIX-like OS (if they are present in the string). Path
644 names are little endian 16 bit Unicode on the wire */
646 cifs_convertUCSpath(char *target, const __le16 * source, int maxlen,
647 const struct nls_table * cp)
652 for(i = 0, j = 0; i < maxlen; i++) {
653 src_char = le16_to_cpu(source[i]);
656 goto cUCS_out; /* BB check this BB */
666 /* BB We can not handle remapping slash until
667 all the calls to build_path_from_dentry
668 are modified, as they use slash as separator BB */
682 len = cp->uni2char(src_char, &target[j],
683 NLS_MAX_CHARSET_SIZE);
692 /* make sure we do not overrun callers allocated temp buffer */
693 if(j >= (2 * NAME_MAX))
701 /* Convert 16 bit Unicode pathname to wire format from string in current code
702 page. Conversion may involve remapping up the seven characters that are
703 only legal in POSIX-like OS (if they are present in the string). Path
704 names are little endian 16 bit Unicode on the wire */
706 cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
707 const struct nls_table * cp, int mapChars)
710 int len_remaining = maxlen;
715 return cifs_strtoUCS(target, source, PATH_MAX, cp);
717 for(i = 0, j = 0; i < maxlen; j++) {
718 src_char = source[i];
724 target[j] = cpu_to_le16(UNI_COLON);
727 target[j] = cpu_to_le16(UNI_ASTERIK);
730 target[j] = cpu_to_le16(UNI_QUESTION);
733 target[j] = cpu_to_le16(UNI_LESSTHAN);
736 target[j] = cpu_to_le16(UNI_GRTRTHAN);
739 target[j] = cpu_to_le16(UNI_PIPE);
741 /* BB We can not handle remapping slash until
742 all the calls to build_path_from_dentry
743 are modified, as they use slash as separator BB */
745 target[j] = cpu_to_le16(UNI_SLASH);
748 charlen = cp->char2uni(source+i,
749 len_remaining, &temp);
750 /* if no match, use question mark, which
751 at least in some cases servers as wild card */
753 target[j] = cpu_to_le16(0x003f);
756 target[j] = cpu_to_le16(temp);
757 len_remaining -= charlen;
758 /* character may take more than one byte in the
759 the source string, but will take exactly two
760 bytes in the target string */
764 i++; /* move to next char in source string */