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 if (buf_to_free->serverOS)
102 kfree(buf_to_free->serverOS);
103 if (buf_to_free->serverDomain)
104 kfree(buf_to_free->serverDomain);
105 if (buf_to_free->serverNOS)
106 kfree(buf_to_free->serverNOS);
107 if (buf_to_free->password)
108 kfree(buf_to_free->password);
112 struct cifsTconInfo *
115 struct cifsTconInfo *ret_buf;
117 (struct cifsTconInfo *) kmalloc(sizeof (struct cifsTconInfo),
120 memset(ret_buf, 0, sizeof (struct cifsTconInfo));
121 write_lock(&GlobalSMBSeslock);
122 atomic_inc(&tconInfoAllocCount);
123 list_add(&ret_buf->cifsConnectionList,
124 &GlobalTreeConnectionList);
125 ret_buf->tidStatus = CifsNew;
126 INIT_LIST_HEAD(&ret_buf->openFileList);
127 init_MUTEX(&ret_buf->tconSem);
128 #ifdef CONFIG_CIFS_STATS
129 spin_lock_init(&ret_buf->stat_lock);
131 write_unlock(&GlobalSMBSeslock);
137 tconInfoFree(struct cifsTconInfo *buf_to_free)
139 if (buf_to_free == NULL) {
140 cFYI(1, ("Null buffer passed to tconInfoFree"));
143 write_lock(&GlobalSMBSeslock);
144 atomic_dec(&tconInfoAllocCount);
145 list_del(&buf_to_free->cifsConnectionList);
146 write_unlock(&GlobalSMBSeslock);
147 if (buf_to_free->nativeFileSystem)
148 kfree(buf_to_free->nativeFileSystem);
155 struct smb_hdr *ret_buf = NULL;
157 /* We could use negotiated size instead of max_msgsize -
158 but it may be more efficient to always alloc same size
159 albeit slightly larger than necessary and maxbuffersize
160 defaults to this and can not be bigger */
162 (struct smb_hdr *) mempool_alloc(cifs_req_poolp, SLAB_KERNEL | SLAB_NOFS);
164 /* clear the first few header bytes */
165 /* for most paths, more is cleared in header_assemble */
167 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
168 atomic_inc(&bufAllocCount);
175 cifs_buf_release(void *buf_to_free)
178 if (buf_to_free == NULL) {
179 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
182 mempool_free(buf_to_free,cifs_req_poolp);
184 atomic_dec(&bufAllocCount);
189 cifs_small_buf_get(void)
191 struct smb_hdr *ret_buf = NULL;
193 /* We could use negotiated size instead of max_msgsize -
194 but it may be more efficient to always alloc same size
195 albeit slightly larger than necessary and maxbuffersize
196 defaults to this and can not be bigger */
198 (struct smb_hdr *) mempool_alloc(cifs_sm_req_poolp, SLAB_KERNEL | SLAB_NOFS);
200 /* No need to clear memory here, cleared in header assemble */
201 /* memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
202 atomic_inc(&smBufAllocCount);
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,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->uid != 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->uid) {
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;
378 if((treeCon->ses) && (treeCon->ses->server))
379 if(treeCon->ses->server->secMode &
380 (SECMODE_SIGN_REQUIRED | SECMODE_SIGN_ENABLED))
381 buffer->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
384 /* endian conversion of flags is now done just before sending */
385 buffer->WordCount = (char) word_count;
390 checkSMBhdr(struct smb_hdr *smb, __u16 mid)
392 /* Make sure that this really is an SMB, that it is a response,
393 and that the message ids match */
394 if ((*(__le32 *) smb->Protocol == cpu_to_le32(0x424d53ff)) &&
396 if(smb->Flags & SMBFLG_RESPONSE)
399 /* only one valid case where server sends us request */
400 if(smb->Command == SMB_COM_LOCKING_ANDX)
403 cERROR(1, ("Rcvd Request not response "));
405 } else { /* bad signature or mid */
406 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff))
408 ("Bad protocol string signature header %x ",
409 *(unsigned int *) smb->Protocol));
411 cERROR(1, ("Mids do not match"));
413 cERROR(1, ("bad smb detected. The Mid=%d", smb->Mid));
418 checkSMB(struct smb_hdr *smb, __u16 mid, int length)
420 __u32 len = be32_to_cpu(smb->smb_buf_length);
422 ("Entering checkSMB with Length: %x, smb_buf_length: %x ",
424 if (((unsigned int)length < 2 + sizeof (struct smb_hdr)) ||
425 (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)) {
426 if ((unsigned int)length < 2 + sizeof (struct smb_hdr)) {
427 if (((unsigned int)length >=
428 sizeof (struct smb_hdr) - 1)
429 && (smb->Status.CifsError != 0)) {
431 return 0; /* some error cases do not return wct and bcc */
433 cERROR(1, ("Length less than smb header size"));
437 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)
439 ("smb_buf_length greater than MaxBufSize"));
441 ("bad smb detected. Illegal length. The mid=%d",
446 if (checkSMBhdr(smb, mid))
449 if ((4 + len != smbCalcSize(smb))
450 || (4 + len != (unsigned int)length)) {
453 cERROR(1, ("smbCalcSize %x ", smbCalcSize(smb)));
455 ("bad smb size detected. The Mid=%d", smb->Mid));
460 is_valid_oplock_break(struct smb_hdr *buf)
462 struct smb_com_lock_req * pSMB = (struct smb_com_lock_req *)buf;
463 struct list_head *tmp;
464 struct list_head *tmp1;
465 struct cifsTconInfo *tcon;
466 struct cifsFileInfo *netfile;
468 cFYI(1,("Checking for oplock break or dnotify response"));
469 if((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
470 (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
471 struct smb_com_transaction_change_notify_rsp * pSMBr =
472 (struct smb_com_transaction_change_notify_rsp *)buf;
473 struct file_notify_information * pnotify;
474 __u32 data_offset = 0;
475 if(pSMBr->ByteCount > sizeof(struct file_notify_information)) {
476 data_offset = le32_to_cpu(pSMBr->DataOffset);
478 pnotify = (struct file_notify_information *)((char *)&pSMBr->hdr.Protocol
480 cFYI(1,("dnotify on %s with action: 0x%x",pnotify->FileName,
481 pnotify->Action)); /* BB removeme BB */
482 /* cifs_dump_mem("Received notify Data is: ",buf,sizeof(struct smb_hdr)+60); */
485 if(pSMBr->hdr.Status.CifsError) {
486 cFYI(1,("notify err 0x%d",pSMBr->hdr.Status.CifsError));
491 if(pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
493 if(pSMB->hdr.Flags & SMBFLG_RESPONSE) {
494 /* no sense logging error on invalid handle on oplock
495 break - harmless race between close request and oplock
496 break response is expected from time to time writing out
497 large dirty files cached on the client */
498 if ((NT_STATUS_INVALID_HANDLE) ==
499 le32_to_cpu(pSMB->hdr.Status.CifsError)) {
500 cFYI(1,("invalid handle on oplock break"));
502 } else if (ERRbadfid ==
503 le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
506 return FALSE; /* on valid oplock brk we get "request" */
509 if(pSMB->hdr.WordCount != 8)
512 cFYI(1,(" oplock type 0x%d level 0x%d",pSMB->LockType,pSMB->OplockLevel));
513 if(!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
516 /* look up tcon based on tid & uid */
517 read_lock(&GlobalSMBSeslock);
518 list_for_each(tmp, &GlobalTreeConnectionList) {
519 tcon = list_entry(tmp, struct cifsTconInfo, cifsConnectionList);
520 if (tcon->tid == buf->Tid) {
521 #ifdef CONFIG_CIFS_STATS
522 atomic_inc(&tcon->num_oplock_brks);
524 list_for_each(tmp1,&tcon->openFileList){
525 netfile = list_entry(tmp1,struct cifsFileInfo,
527 if(pSMB->Fid == netfile->netfid) {
528 struct cifsInodeInfo *pCifsInode;
529 read_unlock(&GlobalSMBSeslock);
530 cFYI(1,("file id match, oplock break"));
532 CIFS_I(netfile->pInode);
533 pCifsInode->clientCanCacheAll = FALSE;
534 if(pSMB->OplockLevel == 0)
535 pCifsInode->clientCanCacheRead
537 pCifsInode->oplockPending = TRUE;
538 AllocOplockQEntry(netfile->pInode,
541 cFYI(1,("about to wake up oplock thd"));
543 wake_up_process(oplockThread);
547 read_unlock(&GlobalSMBSeslock);
548 cFYI(1,("No matching file for oplock break"));
552 read_unlock(&GlobalSMBSeslock);
553 cFYI(1,("Can not process oplock break for non-existent connection"));
558 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
562 unsigned char *buffer;
567 buffer = (unsigned char *) smb_buf;
568 for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
569 if (i % 8 == 0) { /* have reached the beginning of line */
570 printk(KERN_DEBUG "| ");
573 printk("%0#4x ", buffer[i]);
574 debug_line[2 * j] = ' ';
575 if (isprint(buffer[i]))
576 debug_line[1 + (2 * j)] = buffer[i];
578 debug_line[1 + (2 * j)] = '_';
580 if (i % 8 == 7) { /* reached end of line, time to print ascii */
582 printk(" | %s\n", debug_line);
587 debug_line[2 * j] = ' ';
588 debug_line[1 + (2 * j)] = ' ';
590 printk( " | %s\n", debug_line);
594 /* Windows maps these to the user defined 16 bit Unicode range since they are
595 reserved symbols (along with \ and /), otherwise illegal to store
596 in filenames in NTFS */
597 #define UNI_ASTERIK (__u16) ('*' + 0xF000)
598 #define UNI_QUESTION (__u16) ('?' + 0xF000)
599 #define UNI_COLON (__u16) (':' + 0xF000)
600 #define UNI_GRTRTHAN (__u16) ('>' + 0xF000)
601 #define UNI_LESSTHAN (__u16) ('<' + 0xF000)
602 #define UNI_PIPE (__u16) ('|' + 0xF000)
603 #define UNI_SLASH (__u16) ('\\' + 0xF000)
605 /* Convert 16 bit Unicode pathname from wire format to string in current code
606 page. Conversion may involve remapping up the seven characters that are
607 only legal in POSIX-like OS (if they are present in the string). Path
608 names are little endian 16 bit Unicode on the wire */
610 cifs_convertUCSpath(char *target, const __le16 * source, int maxlen,
611 const struct nls_table * cp)
616 for(i = 0, j = 0; i < maxlen; i++) {
617 src_char = le16_to_cpu(source[i]);
620 goto cUCS_out; /* BB check this BB */
630 /* BB We can not handle remapping slash until
631 all the calls to build_path_from_dentry
632 are modified, as they use slash as separator BB */
646 len = cp->uni2char(src_char, &target[j],
647 NLS_MAX_CHARSET_SIZE);
656 /* make sure we do not overrun callers allocated temp buffer */
657 if(j >= (2 * NAME_MAX))
665 /* Convert 16 bit Unicode pathname to wire format from string in current code
666 page. Conversion may involve remapping up the seven characters that are
667 only legal in POSIX-like OS (if they are present in the string). Path
668 names are little endian 16 bit Unicode on the wire */
670 cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
671 const struct nls_table * cp, int mapChars)
674 int len_remaining = maxlen;
678 return cifs_strtoUCS((wchar_t *) target, source, PATH_MAX, cp);
680 for(i = 0, j = 0; i < maxlen; j++) {
681 src_char = source[i];
687 target[j] = cpu_to_le16(UNI_COLON);
690 target[j] = cpu_to_le16(UNI_ASTERIK);
693 target[j] = cpu_to_le16(UNI_QUESTION);
696 target[j] = cpu_to_le16(UNI_LESSTHAN);
699 target[j] = cpu_to_le16(UNI_GRTRTHAN);
702 target[j] = cpu_to_le16(UNI_PIPE);
704 /* BB We can not handle remapping slash until
705 all the calls to build_path_from_dentry
706 are modified, as they use slash as separator BB */
708 target[j] = cpu_to_le16(UNI_SLASH);
711 charlen = cp->char2uni(source+i,
712 len_remaining, target+j);
713 /* if no match, use question mark, which
714 at least in some cases servers as wild card */
716 target[j] = cpu_to_le16(0x003f);
719 len_remaining -= charlen;
720 /* character may take more than one byte in the
721 the source string, but will take exactly two
722 bytes in the target string */
726 i++; /* move to next char in source string */