4 * Copyright (C) International Business Machines Corp., 2002,2004
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 *) kmalloc(sizeof (struct cifsSesInfo),
78 memset(ret_buf, 0, sizeof (struct cifsSesInfo));
79 write_lock(&GlobalSMBSeslock);
80 atomic_inc(&sesInfoAllocCount);
81 ret_buf->status = CifsNew;
82 list_add(&ret_buf->cifsSessionList, &GlobalSMBSessionList);
83 init_MUTEX(&ret_buf->sesSem);
84 write_unlock(&GlobalSMBSeslock);
90 sesInfoFree(struct cifsSesInfo *buf_to_free)
92 if (buf_to_free == NULL) {
93 cFYI(1, ("Null buffer passed to sesInfoFree"));
97 write_lock(&GlobalSMBSeslock);
98 atomic_dec(&sesInfoAllocCount);
99 list_del(&buf_to_free->cifsSessionList);
100 write_unlock(&GlobalSMBSeslock);
101 kfree(buf_to_free->serverOS);
102 kfree(buf_to_free->serverDomain);
103 kfree(buf_to_free->serverNOS);
104 kfree(buf_to_free->password);
108 struct cifsTconInfo *
111 struct cifsTconInfo *ret_buf;
113 (struct cifsTconInfo *) kmalloc(sizeof (struct cifsTconInfo),
116 memset(ret_buf, 0, sizeof (struct cifsTconInfo));
117 write_lock(&GlobalSMBSeslock);
118 atomic_inc(&tconInfoAllocCount);
119 list_add(&ret_buf->cifsConnectionList,
120 &GlobalTreeConnectionList);
121 ret_buf->tidStatus = CifsNew;
122 INIT_LIST_HEAD(&ret_buf->openFileList);
123 init_MUTEX(&ret_buf->tconSem);
124 #ifdef CONFIG_CIFS_STATS
125 spin_lock_init(&ret_buf->stat_lock);
127 write_unlock(&GlobalSMBSeslock);
133 tconInfoFree(struct cifsTconInfo *buf_to_free)
135 if (buf_to_free == NULL) {
136 cFYI(1, ("Null buffer passed to tconInfoFree"));
139 write_lock(&GlobalSMBSeslock);
140 atomic_dec(&tconInfoAllocCount);
141 list_del(&buf_to_free->cifsConnectionList);
142 write_unlock(&GlobalSMBSeslock);
143 kfree(buf_to_free->nativeFileSystem);
150 struct smb_hdr *ret_buf = NULL;
152 /* We could use negotiated size instead of max_msgsize -
153 but it may be more efficient to always alloc same size
154 albeit slightly larger than necessary and maxbuffersize
155 defaults to this and can not be bigger */
157 (struct smb_hdr *) mempool_alloc(cifs_req_poolp, SLAB_KERNEL | SLAB_NOFS);
159 /* clear the first few header bytes */
160 /* for most paths, more is cleared in header_assemble */
162 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
163 atomic_inc(&bufAllocCount);
170 cifs_buf_release(void *buf_to_free)
173 if (buf_to_free == NULL) {
174 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
177 mempool_free(buf_to_free,cifs_req_poolp);
179 atomic_dec(&bufAllocCount);
184 cifs_small_buf_get(void)
186 struct smb_hdr *ret_buf = NULL;
188 /* We could use negotiated size instead of max_msgsize -
189 but it may be more efficient to always alloc same size
190 albeit slightly larger than necessary and maxbuffersize
191 defaults to this and can not be bigger */
193 (struct smb_hdr *) mempool_alloc(cifs_sm_req_poolp, SLAB_KERNEL | SLAB_NOFS);
195 /* No need to clear memory here, cleared in header assemble */
196 /* memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
197 atomic_inc(&smBufAllocCount);
203 cifs_small_buf_release(void *buf_to_free)
206 if (buf_to_free == NULL) {
207 cFYI(1, ("Null buffer passed to cifs_small_buf_release"));
210 mempool_free(buf_to_free,cifs_sm_req_poolp);
212 atomic_dec(&smBufAllocCount);
217 Find a free multiplex id (SMB mid). Otherwise there could be
218 mid collisions which might cause problems, demultiplexing the
219 wrong response to this request. Multiplex ids could collide if
220 one of a series requests takes much longer than the others, or
221 if a very large number of long lived requests (byte range
222 locks or FindNotify requests) are pending. No more than
223 64K-1 requests can be outstanding at one time. If no
224 mids are available, return zero. A future optimization
225 could make the combination of mids and uid the key we use
226 to demultiplex on (rather than mid alone).
227 In addition to the above check, the cifs demultiplex
228 code already used the command code as a secondary
229 check of the frame and if signing is negotiated the
230 response would be discarded if the mid were the same
231 but the signature was wrong. Since the mid is not put in the
232 pending queue until later (when it is about to be dispatched)
233 we do have to limit the number of outstanding requests
234 to somewhat less than 64K-1 although it is hard to imagine
235 so many threads being in the vfs at one time.
237 __u16 GetNextMid(struct TCP_Server_Info *server)
246 spin_lock(&GlobalMid_Lock);
247 last_mid = server->CurrentMid; /* we do not want to loop forever */
248 server->CurrentMid++;
249 /* This nested loop looks more expensive than it is.
250 In practice the list of pending requests is short,
251 fewer than 50, and the mids are likely to be unique
252 on the first pass through the loop unless some request
253 takes longer than the 64 thousand requests before it
254 (and it would also have to have been a request that
256 while(server->CurrentMid != last_mid) {
257 struct list_head *tmp;
258 struct mid_q_entry *mid_entry;
261 if(server->CurrentMid == 0)
262 server->CurrentMid++;
264 list_for_each(tmp, &server->pending_mid_q) {
265 mid_entry = list_entry(tmp, struct mid_q_entry, qhead);
267 if ((mid_entry->mid == server->CurrentMid) &&
268 (mid_entry->midState == MID_REQUEST_SUBMITTED)) {
269 /* This mid is in use, try a different one */
275 mid = server->CurrentMid;
278 server->CurrentMid++;
280 spin_unlock(&GlobalMid_Lock);
284 /* NB: MID can not be set if treeCon not passed in, in that
285 case it is responsbility of caller to set the mid */
287 header_assemble(struct smb_hdr *buffer, char smb_command /* command */ ,
288 const struct cifsTconInfo *treeCon, int word_count
289 /* length of fixed section (word count) in two byte units */)
291 struct list_head* temp_item;
292 struct cifsSesInfo * ses;
293 char *temp = (char *) buffer;
295 memset(temp,0,MAX_CIFS_HDR_SIZE);
297 buffer->smb_buf_length =
298 (2 * word_count) + sizeof (struct smb_hdr) -
299 4 /* RFC 1001 length field does not count */ +
300 2 /* for bcc field itself */ ;
301 /* Note that this is the only network field that has to be converted
302 to big endian and it is done just before we send it */
304 buffer->Protocol[0] = 0xFF;
305 buffer->Protocol[1] = 'S';
306 buffer->Protocol[2] = 'M';
307 buffer->Protocol[3] = 'B';
308 buffer->Command = smb_command;
309 buffer->Flags = 0x00; /* case sensitive */
310 buffer->Flags2 = SMBFLG2_KNOWS_LONG_NAMES;
311 buffer->Pid = cpu_to_le16((__u16)current->tgid);
312 buffer->PidHigh = cpu_to_le16((__u16)(current->tgid >> 16));
313 spin_lock(&GlobalMid_Lock);
314 spin_unlock(&GlobalMid_Lock);
316 buffer->Tid = treeCon->tid;
318 if (treeCon->ses->capabilities & CAP_UNICODE)
319 buffer->Flags2 |= SMBFLG2_UNICODE;
320 if (treeCon->ses->capabilities & CAP_STATUS32) {
321 buffer->Flags2 |= SMBFLG2_ERR_STATUS;
323 /* Uid is not converted */
324 buffer->Uid = treeCon->ses->Suid;
325 buffer->Mid = GetNextMid(treeCon->ses->server);
326 if(multiuser_mount != 0) {
327 /* For the multiuser case, there are few obvious technically */
328 /* possible mechanisms to match the local linux user (uid) */
329 /* to a valid remote smb user (smb_uid): */
330 /* 1) Query Winbind (or other local pam/nss daemon */
331 /* for userid/password/logon_domain or credential */
332 /* 2) Query Winbind for uid to sid to username mapping */
333 /* and see if we have a matching password for existing*/
334 /* session for that user perhas getting password by */
335 /* adding a new pam_cifs module that stores passwords */
336 /* so that the cifs vfs can get at that for all logged*/
338 /* 3) (Which is the mechanism we have chosen) */
339 /* Search through sessions to the same server for a */
340 /* a match on the uid that was passed in on mount */
341 /* with the current processes uid (or euid?) and use */
342 /* that smb uid. If no existing smb session for */
343 /* that uid found, use the default smb session ie */
344 /* the smb session for the volume mounted which is */
345 /* the same as would be used if the multiuser mount */
346 /* flag were disabled. */
348 /* BB Add support for establishing new tCon and SMB Session */
349 /* with userid/password pairs found on the smb session */
350 /* for other target tcp/ip addresses BB */
351 if(current->uid != treeCon->ses->linux_uid) {
352 cFYI(1,("Multiuser mode and UID did not match tcon uid "));
353 read_lock(&GlobalSMBSeslock);
354 list_for_each(temp_item, &GlobalSMBSessionList) {
355 ses = list_entry(temp_item, struct cifsSesInfo, cifsSessionList);
356 if(ses->linux_uid == current->uid) {
357 if(ses->server == treeCon->ses->server) {
358 cFYI(1,("found matching uid substitute right smb_uid"));
359 buffer->Uid = ses->Suid;
362 /* BB eventually call cifs_setup_session here */
363 cFYI(1,("local UID found but smb sess with this server does not exist"));
367 read_unlock(&GlobalSMBSeslock);
371 if (treeCon->Flags & SMB_SHARE_IS_IN_DFS)
372 buffer->Flags2 |= SMBFLG2_DFS;
374 buffer->Flags |= SMBFLG_CASELESS;
375 if((treeCon->ses) && (treeCon->ses->server))
376 if(treeCon->ses->server->secMode &
377 (SECMODE_SIGN_REQUIRED | SECMODE_SIGN_ENABLED))
378 buffer->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
381 /* endian conversion of flags is now done just before sending */
382 buffer->WordCount = (char) word_count;
387 checkSMBhdr(struct smb_hdr *smb, __u16 mid)
389 /* Make sure that this really is an SMB, that it is a response,
390 and that the message ids match */
391 if ((*(__le32 *) smb->Protocol == cpu_to_le32(0x424d53ff)) &&
393 if(smb->Flags & SMBFLG_RESPONSE)
396 /* only one valid case where server sends us request */
397 if(smb->Command == SMB_COM_LOCKING_ANDX)
400 cERROR(1, ("Rcvd Request not response "));
402 } else { /* bad signature or mid */
403 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff))
405 ("Bad protocol string signature header %x ",
406 *(unsigned int *) smb->Protocol));
408 cERROR(1, ("Mids do not match"));
410 cERROR(1, ("bad smb detected. The Mid=%d", smb->Mid));
415 checkSMB(struct smb_hdr *smb, __u16 mid, int length)
417 __u32 len = smb->smb_buf_length;
418 __u32 clc_len; /* calculated length */
420 ("Entering checkSMB with Length: %x, smb_buf_length: %x ",
422 if (((unsigned int)length < 2 + sizeof (struct smb_hdr)) ||
423 (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)) {
424 if ((unsigned int)length < 2 + sizeof (struct smb_hdr)) {
425 if (((unsigned int)length >=
426 sizeof (struct smb_hdr) - 1)
427 && (smb->Status.CifsError != 0)) {
429 return 0; /* some error cases do not return wct and bcc */
431 cERROR(1, ("Length less than smb header size"));
435 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)
437 ("smb_buf_length greater than MaxBufSize"));
439 ("bad smb detected. Illegal length. mid=%d",
444 if (checkSMBhdr(smb, mid))
446 clc_len = smbCalcSize_LE(smb);
447 if ((4 + len != clc_len)
448 || (4 + len != (unsigned int)length)) {
449 cERROR(1, ("Calculated size 0x%x vs actual length 0x%x",
451 cERROR(1, ("bad smb size detected for Mid=%d", smb->Mid));
452 /* Windows XP can return a few bytes too much, presumably
453 an illegal pad, at the end of byte range lock responses
454 so we allow for up to eight byte pad, as long as actual
455 received length is as long or longer than calculated length */
456 if((4+len > clc_len) && (len <= clc_len + 3))
464 is_valid_oplock_break(struct smb_hdr *buf)
466 struct smb_com_lock_req * pSMB = (struct smb_com_lock_req *)buf;
467 struct list_head *tmp;
468 struct list_head *tmp1;
469 struct cifsTconInfo *tcon;
470 struct cifsFileInfo *netfile;
472 cFYI(1,("Checking for oplock break or dnotify response"));
473 if((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
474 (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
475 struct smb_com_transaction_change_notify_rsp * pSMBr =
476 (struct smb_com_transaction_change_notify_rsp *)buf;
477 struct file_notify_information * pnotify;
478 __u32 data_offset = 0;
479 if(pSMBr->ByteCount > sizeof(struct file_notify_information)) {
480 data_offset = le32_to_cpu(pSMBr->DataOffset);
482 pnotify = (struct file_notify_information *)((char *)&pSMBr->hdr.Protocol
484 cFYI(1,("dnotify on %s with action: 0x%x",pnotify->FileName,
485 pnotify->Action)); /* BB removeme BB */
486 /* cifs_dump_mem("Received notify Data is: ",buf,sizeof(struct smb_hdr)+60); */
489 if(pSMBr->hdr.Status.CifsError) {
490 cFYI(1,("notify err 0x%d",pSMBr->hdr.Status.CifsError));
495 if(pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
497 if(pSMB->hdr.Flags & SMBFLG_RESPONSE) {
498 /* no sense logging error on invalid handle on oplock
499 break - harmless race between close request and oplock
500 break response is expected from time to time writing out
501 large dirty files cached on the client */
502 if ((NT_STATUS_INVALID_HANDLE) ==
503 le32_to_cpu(pSMB->hdr.Status.CifsError)) {
504 cFYI(1,("invalid handle on oplock break"));
506 } else if (ERRbadfid ==
507 le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
510 return FALSE; /* on valid oplock brk we get "request" */
513 if(pSMB->hdr.WordCount != 8)
516 cFYI(1,(" oplock type 0x%d level 0x%d",pSMB->LockType,pSMB->OplockLevel));
517 if(!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
520 /* look up tcon based on tid & uid */
521 read_lock(&GlobalSMBSeslock);
522 list_for_each(tmp, &GlobalTreeConnectionList) {
523 tcon = list_entry(tmp, struct cifsTconInfo, cifsConnectionList);
524 if (tcon->tid == buf->Tid) {
525 cifs_stats_inc(&tcon->num_oplock_brks);
526 list_for_each(tmp1,&tcon->openFileList){
527 netfile = list_entry(tmp1,struct cifsFileInfo,
529 if(pSMB->Fid == netfile->netfid) {
530 struct cifsInodeInfo *pCifsInode;
531 read_unlock(&GlobalSMBSeslock);
532 cFYI(1,("file id match, oplock break"));
534 CIFS_I(netfile->pInode);
535 pCifsInode->clientCanCacheAll = FALSE;
536 if(pSMB->OplockLevel == 0)
537 pCifsInode->clientCanCacheRead
539 pCifsInode->oplockPending = TRUE;
540 AllocOplockQEntry(netfile->pInode,
543 cFYI(1,("about to wake up oplock thd"));
545 wake_up_process(oplockThread);
549 read_unlock(&GlobalSMBSeslock);
550 cFYI(1,("No matching file for oplock break"));
554 read_unlock(&GlobalSMBSeslock);
555 cFYI(1,("Can not process oplock break for non-existent connection"));
560 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
564 unsigned char *buffer;
569 buffer = (unsigned char *) smb_buf;
570 for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
571 if (i % 8 == 0) { /* have reached the beginning of line */
572 printk(KERN_DEBUG "| ");
575 printk("%0#4x ", buffer[i]);
576 debug_line[2 * j] = ' ';
577 if (isprint(buffer[i]))
578 debug_line[1 + (2 * j)] = buffer[i];
580 debug_line[1 + (2 * j)] = '_';
582 if (i % 8 == 7) { /* reached end of line, time to print ascii */
584 printk(" | %s\n", debug_line);
589 debug_line[2 * j] = ' ';
590 debug_line[1 + (2 * j)] = ' ';
592 printk( " | %s\n", debug_line);
596 /* Windows maps these to the user defined 16 bit Unicode range since they are
597 reserved symbols (along with \ and /), otherwise illegal to store
598 in filenames in NTFS */
599 #define UNI_ASTERIK (__u16) ('*' + 0xF000)
600 #define UNI_QUESTION (__u16) ('?' + 0xF000)
601 #define UNI_COLON (__u16) (':' + 0xF000)
602 #define UNI_GRTRTHAN (__u16) ('>' + 0xF000)
603 #define UNI_LESSTHAN (__u16) ('<' + 0xF000)
604 #define UNI_PIPE (__u16) ('|' + 0xF000)
605 #define UNI_SLASH (__u16) ('\\' + 0xF000)
607 /* Convert 16 bit Unicode pathname from wire format to string in current code
608 page. Conversion may involve remapping up the seven characters that are
609 only legal in POSIX-like OS (if they are present in the string). Path
610 names are little endian 16 bit Unicode on the wire */
612 cifs_convertUCSpath(char *target, const __le16 * source, int maxlen,
613 const struct nls_table * cp)
618 for(i = 0, j = 0; i < maxlen; i++) {
619 src_char = le16_to_cpu(source[i]);
622 goto cUCS_out; /* BB check this BB */
632 /* BB We can not handle remapping slash until
633 all the calls to build_path_from_dentry
634 are modified, as they use slash as separator BB */
648 len = cp->uni2char(src_char, &target[j],
649 NLS_MAX_CHARSET_SIZE);
658 /* make sure we do not overrun callers allocated temp buffer */
659 if(j >= (2 * NAME_MAX))
667 /* Convert 16 bit Unicode pathname to wire format from string in current code
668 page. Conversion may involve remapping up the seven characters that are
669 only legal in POSIX-like OS (if they are present in the string). Path
670 names are little endian 16 bit Unicode on the wire */
672 cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
673 const struct nls_table * cp, int mapChars)
676 int len_remaining = maxlen;
681 return cifs_strtoUCS((wchar_t *) target, source, PATH_MAX, cp);
683 for(i = 0, j = 0; i < maxlen; j++) {
684 src_char = source[i];
690 target[j] = cpu_to_le16(UNI_COLON);
693 target[j] = cpu_to_le16(UNI_ASTERIK);
696 target[j] = cpu_to_le16(UNI_QUESTION);
699 target[j] = cpu_to_le16(UNI_LESSTHAN);
702 target[j] = cpu_to_le16(UNI_GRTRTHAN);
705 target[j] = cpu_to_le16(UNI_PIPE);
707 /* BB We can not handle remapping slash until
708 all the calls to build_path_from_dentry
709 are modified, as they use slash as separator BB */
711 target[j] = cpu_to_le16(UNI_SLASH);
714 charlen = cp->char2uni(source+i,
715 len_remaining, &temp);
716 /* if no match, use question mark, which
717 at least in some cases servers as wild card */
719 target[j] = cpu_to_le16(0x003f);
722 target[j] = cpu_to_le16(temp);
723 len_remaining -= charlen;
724 /* character may take more than one byte in the
725 the source string, but will take exactly two
726 bytes in the target string */
730 i++; /* move to next char in source string */