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;
75 (struct cifsSesInfo *) kzalloc(sizeof (struct cifsSesInfo),
78 write_lock(&GlobalSMBSeslock);
79 atomic_inc(&sesInfoAllocCount);
80 ret_buf->status = CifsNew;
81 list_add(&ret_buf->cifsSessionList, &GlobalSMBSessionList);
82 init_MUTEX(&ret_buf->sesSem);
83 write_unlock(&GlobalSMBSeslock);
89 sesInfoFree(struct cifsSesInfo *buf_to_free)
91 if (buf_to_free == NULL) {
92 cFYI(1, ("Null buffer passed to sesInfoFree"));
96 write_lock(&GlobalSMBSeslock);
97 atomic_dec(&sesInfoAllocCount);
98 list_del(&buf_to_free->cifsSessionList);
99 write_unlock(&GlobalSMBSeslock);
100 kfree(buf_to_free->serverOS);
101 kfree(buf_to_free->serverDomain);
102 kfree(buf_to_free->serverNOS);
103 kfree(buf_to_free->password);
107 struct cifsTconInfo *
110 struct cifsTconInfo *ret_buf;
112 (struct cifsTconInfo *) kzalloc(sizeof (struct cifsTconInfo),
115 write_lock(&GlobalSMBSeslock);
116 atomic_inc(&tconInfoAllocCount);
117 list_add(&ret_buf->cifsConnectionList,
118 &GlobalTreeConnectionList);
119 ret_buf->tidStatus = CifsNew;
120 INIT_LIST_HEAD(&ret_buf->openFileList);
121 init_MUTEX(&ret_buf->tconSem);
122 #ifdef CONFIG_CIFS_STATS
123 spin_lock_init(&ret_buf->stat_lock);
125 write_unlock(&GlobalSMBSeslock);
131 tconInfoFree(struct cifsTconInfo *buf_to_free)
133 if (buf_to_free == NULL) {
134 cFYI(1, ("Null buffer passed to tconInfoFree"));
137 write_lock(&GlobalSMBSeslock);
138 atomic_dec(&tconInfoAllocCount);
139 list_del(&buf_to_free->cifsConnectionList);
140 write_unlock(&GlobalSMBSeslock);
141 kfree(buf_to_free->nativeFileSystem);
148 struct smb_hdr *ret_buf = NULL;
150 /* We could use negotiated size instead of max_msgsize -
151 but it may be more efficient to always alloc same size
152 albeit slightly larger than necessary and maxbuffersize
153 defaults to this and can not be bigger */
155 (struct smb_hdr *) mempool_alloc(cifs_req_poolp, SLAB_KERNEL | SLAB_NOFS);
157 /* clear the first few header bytes */
158 /* for most paths, more is cleared in header_assemble */
160 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
161 atomic_inc(&bufAllocCount);
162 #ifdef CONFIG_CIFS_STATS2
163 atomic_inc(&totBufAllocCount);
164 #endif /* CONFIG_CIFS_STATS2 */
171 cifs_buf_release(void *buf_to_free)
174 if (buf_to_free == NULL) {
175 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
178 mempool_free(buf_to_free,cifs_req_poolp);
180 atomic_dec(&bufAllocCount);
185 cifs_small_buf_get(void)
187 struct smb_hdr *ret_buf = NULL;
189 /* We could use negotiated size instead of max_msgsize -
190 but it may be more efficient to always alloc same size
191 albeit slightly larger than necessary and maxbuffersize
192 defaults to this and can not be bigger */
194 (struct smb_hdr *) mempool_alloc(cifs_sm_req_poolp, SLAB_KERNEL | SLAB_NOFS);
196 /* No need to clear memory here, cleared in header assemble */
197 /* memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
198 atomic_inc(&smBufAllocCount);
199 #ifdef CONFIG_CIFS_STATS2
200 atomic_inc(&totSmBufAllocCount);
201 #endif /* CONFIG_CIFS_STATS2 */
208 cifs_small_buf_release(void *buf_to_free)
211 if (buf_to_free == NULL) {
212 cFYI(1, ("Null buffer passed to cifs_small_buf_release"));
215 mempool_free(buf_to_free,cifs_sm_req_poolp);
217 atomic_dec(&smBufAllocCount);
222 Find a free multiplex id (SMB mid). Otherwise there could be
223 mid collisions which might cause problems, demultiplexing the
224 wrong response to this request. Multiplex ids could collide if
225 one of a series requests takes much longer than the others, or
226 if a very large number of long lived requests (byte range
227 locks or FindNotify requests) are pending. No more than
228 64K-1 requests can be outstanding at one time. If no
229 mids are available, return zero. A future optimization
230 could make the combination of mids and uid the key we use
231 to demultiplex on (rather than mid alone).
232 In addition to the above check, the cifs demultiplex
233 code already used the command code as a secondary
234 check of the frame and if signing is negotiated the
235 response would be discarded if the mid were the same
236 but the signature was wrong. Since the mid is not put in the
237 pending queue until later (when it is about to be dispatched)
238 we do have to limit the number of outstanding requests
239 to somewhat less than 64K-1 although it is hard to imagine
240 so many threads being in the vfs at one time.
242 __u16 GetNextMid(struct TCP_Server_Info *server)
251 spin_lock(&GlobalMid_Lock);
252 last_mid = server->CurrentMid; /* we do not want to loop forever */
253 server->CurrentMid++;
254 /* This nested loop looks more expensive than it is.
255 In practice the list of pending requests is short,
256 fewer than 50, and the mids are likely to be unique
257 on the first pass through the loop unless some request
258 takes longer than the 64 thousand requests before it
259 (and it would also have to have been a request that
261 while(server->CurrentMid != last_mid) {
262 struct list_head *tmp;
263 struct mid_q_entry *mid_entry;
266 if(server->CurrentMid == 0)
267 server->CurrentMid++;
269 list_for_each(tmp, &server->pending_mid_q) {
270 mid_entry = list_entry(tmp, struct mid_q_entry, qhead);
272 if ((mid_entry->mid == server->CurrentMid) &&
273 (mid_entry->midState == MID_REQUEST_SUBMITTED)) {
274 /* This mid is in use, try a different one */
280 mid = server->CurrentMid;
283 server->CurrentMid++;
285 spin_unlock(&GlobalMid_Lock);
289 /* NB: MID can not be set if treeCon not passed in, in that
290 case it is responsbility of caller to set the mid */
292 header_assemble(struct smb_hdr *buffer, char smb_command /* command */ ,
293 const struct cifsTconInfo *treeCon, int word_count
294 /* length of fixed section (word count) in two byte units */)
296 struct list_head* temp_item;
297 struct cifsSesInfo * ses;
298 char *temp = (char *) buffer;
300 memset(temp,0,256); /* bigger than MAX_CIFS_HDR_SIZE */
302 buffer->smb_buf_length =
303 (2 * word_count) + sizeof (struct smb_hdr) -
304 4 /* RFC 1001 length field does not count */ +
305 2 /* for bcc field itself */ ;
306 /* Note that this is the only network field that has to be converted
307 to big endian and it is done just before we send it */
309 buffer->Protocol[0] = 0xFF;
310 buffer->Protocol[1] = 'S';
311 buffer->Protocol[2] = 'M';
312 buffer->Protocol[3] = 'B';
313 buffer->Command = smb_command;
314 buffer->Flags = 0x00; /* case sensitive */
315 buffer->Flags2 = SMBFLG2_KNOWS_LONG_NAMES;
316 buffer->Pid = cpu_to_le16((__u16)current->tgid);
317 buffer->PidHigh = cpu_to_le16((__u16)(current->tgid >> 16));
318 spin_lock(&GlobalMid_Lock);
319 spin_unlock(&GlobalMid_Lock);
321 buffer->Tid = treeCon->tid;
323 if (treeCon->ses->capabilities & CAP_UNICODE)
324 buffer->Flags2 |= SMBFLG2_UNICODE;
325 if (treeCon->ses->capabilities & CAP_STATUS32) {
326 buffer->Flags2 |= SMBFLG2_ERR_STATUS;
328 /* Uid is not converted */
329 buffer->Uid = treeCon->ses->Suid;
330 buffer->Mid = GetNextMid(treeCon->ses->server);
331 if(multiuser_mount != 0) {
332 /* For the multiuser case, there are few obvious technically */
333 /* possible mechanisms to match the local linux user (uid) */
334 /* to a valid remote smb user (smb_uid): */
335 /* 1) Query Winbind (or other local pam/nss daemon */
336 /* for userid/password/logon_domain or credential */
337 /* 2) Query Winbind for uid to sid to username mapping */
338 /* and see if we have a matching password for existing*/
339 /* session for that user perhas getting password by */
340 /* adding a new pam_cifs module that stores passwords */
341 /* so that the cifs vfs can get at that for all logged*/
343 /* 3) (Which is the mechanism we have chosen) */
344 /* Search through sessions to the same server for a */
345 /* a match on the uid that was passed in on mount */
346 /* with the current processes uid (or euid?) and use */
347 /* that smb uid. If no existing smb session for */
348 /* that uid found, use the default smb session ie */
349 /* the smb session for the volume mounted which is */
350 /* the same as would be used if the multiuser mount */
351 /* flag were disabled. */
353 /* BB Add support for establishing new tCon and SMB Session */
354 /* with userid/password pairs found on the smb session */
355 /* for other target tcp/ip addresses BB */
356 if(current->fsuid != treeCon->ses->linux_uid) {
357 cFYI(1,("Multiuser mode and UID did not match tcon uid"));
358 read_lock(&GlobalSMBSeslock);
359 list_for_each(temp_item, &GlobalSMBSessionList) {
360 ses = list_entry(temp_item, struct cifsSesInfo, cifsSessionList);
361 if(ses->linux_uid == current->fsuid) {
362 if(ses->server == treeCon->ses->server) {
363 cFYI(1,("found matching uid substitute right smb_uid"));
364 buffer->Uid = ses->Suid;
367 /* BB eventually call cifs_setup_session here */
368 cFYI(1,("local UID found but smb sess with this server does not exist"));
372 read_unlock(&GlobalSMBSeslock);
376 if (treeCon->Flags & SMB_SHARE_IS_IN_DFS)
377 buffer->Flags2 |= SMBFLG2_DFS;
379 buffer->Flags |= SMBFLG_CASELESS;
380 if((treeCon->ses) && (treeCon->ses->server))
381 if(treeCon->ses->server->secMode &
382 (SECMODE_SIGN_REQUIRED | SECMODE_SIGN_ENABLED))
383 buffer->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
386 /* endian conversion of flags is now done just before sending */
387 buffer->WordCount = (char) word_count;
392 checkSMBhdr(struct smb_hdr *smb, __u16 mid)
394 /* Make sure that this really is an SMB, that it is a response,
395 and that the message ids match */
396 if ((*(__le32 *) smb->Protocol == cpu_to_le32(0x424d53ff)) &&
398 if(smb->Flags & SMBFLG_RESPONSE)
401 /* only one valid case where server sends us request */
402 if(smb->Command == SMB_COM_LOCKING_ANDX)
405 cERROR(1, ("Rcvd Request not response"));
407 } else { /* bad signature or mid */
408 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff))
410 ("Bad protocol string signature header %x",
411 *(unsigned int *) smb->Protocol));
413 cERROR(1, ("Mids do not match"));
415 cERROR(1, ("bad smb detected. The Mid=%d", smb->Mid));
420 checkSMB(struct smb_hdr *smb, __u16 mid, int length)
422 __u32 len = smb->smb_buf_length;
423 __u32 clc_len; /* calculated length */
424 cFYI(0, ("checkSMB Length: 0x%x, smb_buf_length: 0x%x", length, len));
425 if (((unsigned int)length < 2 + sizeof (struct smb_hdr)) ||
426 (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)) {
427 if ((unsigned int)length < 2 + sizeof (struct smb_hdr)) {
428 if (((unsigned int)length >=
429 sizeof (struct smb_hdr) - 1)
430 && (smb->Status.CifsError != 0)) {
432 return 0; /* some error cases do not return wct and bcc */
434 cERROR(1, ("Length less than smb header size"));
437 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)
438 cERROR(1, ("smb length greater than MaxBufSize, mid=%d",
443 if (checkSMBhdr(smb, mid))
445 clc_len = smbCalcSize_LE(smb);
447 if(4 + len != (unsigned int)length) {
448 cERROR(1, ("Length read does not match RFC1001 length %d",len));
452 if (4 + len != clc_len) {
453 /* check if bcc wrapped around for large read responses */
454 if((len > 64 * 1024) && (len > clc_len)) {
455 /* check if lengths match mod 64K */
456 if(((4 + len) & 0xFFFF) == (clc_len & 0xFFFF))
457 return 0; /* bcc wrapped */
459 cERROR(1, ("Calculated size 0x%x vs actual length 0x%x",
461 cERROR(1, ("bad smb size detected for Mid=%d", smb->Mid));
462 /* Windows XP can return a few bytes too much, presumably
463 an illegal pad, at the end of byte range lock responses
464 so we allow for that three byte pad, as long as actual
465 received length is as long or longer than calculated length */
466 /* We have now had to extend this more, since there is a
467 case in which it needs to be bigger still to handle a
468 malformed response to transact2 findfirst from WinXP when
469 access denied is returned and thus bcc and wct are zero
470 but server says length is 0x21 bytes too long as if the server
471 forget to reset the smb rfc1001 length when it reset the
472 wct and bcc to minimum size and drop the t2 parms and data */
473 if((4+len > clc_len) && (len <= clc_len + 512))
481 is_valid_oplock_break(struct smb_hdr *buf)
483 struct smb_com_lock_req * pSMB = (struct smb_com_lock_req *)buf;
484 struct list_head *tmp;
485 struct list_head *tmp1;
486 struct cifsTconInfo *tcon;
487 struct cifsFileInfo *netfile;
489 cFYI(1,("Checking for oplock break or dnotify response"));
490 if((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
491 (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
492 struct smb_com_transaction_change_notify_rsp * pSMBr =
493 (struct smb_com_transaction_change_notify_rsp *)buf;
494 struct file_notify_information * pnotify;
495 __u32 data_offset = 0;
496 if(pSMBr->ByteCount > sizeof(struct file_notify_information)) {
497 data_offset = le32_to_cpu(pSMBr->DataOffset);
499 pnotify = (struct file_notify_information *)((char *)&pSMBr->hdr.Protocol
501 cFYI(1,("dnotify on %s with action: 0x%x",pnotify->FileName,
502 pnotify->Action)); /* BB removeme BB */
503 /* cifs_dump_mem("Received notify Data is: ",buf,sizeof(struct smb_hdr)+60); */
506 if(pSMBr->hdr.Status.CifsError) {
507 cFYI(1,("notify err 0x%d",pSMBr->hdr.Status.CifsError));
512 if(pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
514 if(pSMB->hdr.Flags & SMBFLG_RESPONSE) {
515 /* no sense logging error on invalid handle on oplock
516 break - harmless race between close request and oplock
517 break response is expected from time to time writing out
518 large dirty files cached on the client */
519 if ((NT_STATUS_INVALID_HANDLE) ==
520 le32_to_cpu(pSMB->hdr.Status.CifsError)) {
521 cFYI(1,("invalid handle on oplock break"));
523 } else if (ERRbadfid ==
524 le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
527 return FALSE; /* on valid oplock brk we get "request" */
530 if(pSMB->hdr.WordCount != 8)
533 cFYI(1,(" oplock type 0x%d level 0x%d",pSMB->LockType,pSMB->OplockLevel));
534 if(!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
537 /* look up tcon based on tid & uid */
538 read_lock(&GlobalSMBSeslock);
539 list_for_each(tmp, &GlobalTreeConnectionList) {
540 tcon = list_entry(tmp, struct cifsTconInfo, cifsConnectionList);
541 if (tcon->tid == buf->Tid) {
542 cifs_stats_inc(&tcon->num_oplock_brks);
543 list_for_each(tmp1,&tcon->openFileList){
544 netfile = list_entry(tmp1,struct cifsFileInfo,
546 if(pSMB->Fid == netfile->netfid) {
547 struct cifsInodeInfo *pCifsInode;
548 read_unlock(&GlobalSMBSeslock);
549 cFYI(1,("file id match, oplock break"));
551 CIFS_I(netfile->pInode);
552 pCifsInode->clientCanCacheAll = FALSE;
553 if(pSMB->OplockLevel == 0)
554 pCifsInode->clientCanCacheRead
556 pCifsInode->oplockPending = TRUE;
557 AllocOplockQEntry(netfile->pInode,
560 cFYI(1,("about to wake up oplock thd"));
562 wake_up_process(oplockThread);
566 read_unlock(&GlobalSMBSeslock);
567 cFYI(1,("No matching file for oplock break"));
571 read_unlock(&GlobalSMBSeslock);
572 cFYI(1,("Can not process oplock break for non-existent connection"));
577 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
581 unsigned char *buffer;
586 buffer = (unsigned char *) smb_buf;
587 for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
588 if (i % 8 == 0) { /* have reached the beginning of line */
589 printk(KERN_DEBUG "| ");
592 printk("%0#4x ", buffer[i]);
593 debug_line[2 * j] = ' ';
594 if (isprint(buffer[i]))
595 debug_line[1 + (2 * j)] = buffer[i];
597 debug_line[1 + (2 * j)] = '_';
599 if (i % 8 == 7) { /* reached end of line, time to print ascii */
601 printk(" | %s\n", debug_line);
606 debug_line[2 * j] = ' ';
607 debug_line[1 + (2 * j)] = ' ';
609 printk( " | %s\n", debug_line);
613 /* Windows maps these to the user defined 16 bit Unicode range since they are
614 reserved symbols (along with \ and /), otherwise illegal to store
615 in filenames in NTFS */
616 #define UNI_ASTERIK (__u16) ('*' + 0xF000)
617 #define UNI_QUESTION (__u16) ('?' + 0xF000)
618 #define UNI_COLON (__u16) (':' + 0xF000)
619 #define UNI_GRTRTHAN (__u16) ('>' + 0xF000)
620 #define UNI_LESSTHAN (__u16) ('<' + 0xF000)
621 #define UNI_PIPE (__u16) ('|' + 0xF000)
622 #define UNI_SLASH (__u16) ('\\' + 0xF000)
624 /* Convert 16 bit Unicode pathname from wire format to string in current code
625 page. Conversion may involve remapping up the seven characters that are
626 only legal in POSIX-like OS (if they are present in the string). Path
627 names are little endian 16 bit Unicode on the wire */
629 cifs_convertUCSpath(char *target, const __le16 * source, int maxlen,
630 const struct nls_table * cp)
635 for(i = 0, j = 0; i < maxlen; i++) {
636 src_char = le16_to_cpu(source[i]);
639 goto cUCS_out; /* BB check this BB */
649 /* BB We can not handle remapping slash until
650 all the calls to build_path_from_dentry
651 are modified, as they use slash as separator BB */
665 len = cp->uni2char(src_char, &target[j],
666 NLS_MAX_CHARSET_SIZE);
675 /* make sure we do not overrun callers allocated temp buffer */
676 if(j >= (2 * NAME_MAX))
684 /* Convert 16 bit Unicode pathname to wire format from string in current code
685 page. Conversion may involve remapping up the seven characters that are
686 only legal in POSIX-like OS (if they are present in the string). Path
687 names are little endian 16 bit Unicode on the wire */
689 cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
690 const struct nls_table * cp, int mapChars)
693 int len_remaining = maxlen;
698 return cifs_strtoUCS(target, source, PATH_MAX, cp);
700 for(i = 0, j = 0; i < maxlen; j++) {
701 src_char = source[i];
707 target[j] = cpu_to_le16(UNI_COLON);
710 target[j] = cpu_to_le16(UNI_ASTERIK);
713 target[j] = cpu_to_le16(UNI_QUESTION);
716 target[j] = cpu_to_le16(UNI_LESSTHAN);
719 target[j] = cpu_to_le16(UNI_GRTRTHAN);
722 target[j] = cpu_to_le16(UNI_PIPE);
724 /* BB We can not handle remapping slash until
725 all the calls to build_path_from_dentry
726 are modified, as they use slash as separator BB */
728 target[j] = cpu_to_le16(UNI_SLASH);
731 charlen = cp->char2uni(source+i,
732 len_remaining, &temp);
733 /* if no match, use question mark, which
734 at least in some cases servers as wild card */
736 target[j] = cpu_to_le16(0x003f);
739 target[j] = cpu_to_le16(temp);
740 len_remaining -= charlen;
741 /* character may take more than one byte in the
742 the source string, but will take exactly two
743 bytes in the target string */
747 i++; /* move to next char in source string */