Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-2.6] / fs / cifs / misc.c
1 /*
2  *   fs/cifs/misc.c
3  *
4  *   Copyright (C) International Business Machines  Corp., 2002,2008
5  *   Author(s): Steve French (sfrench@us.ibm.com)
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include <linux/slab.h>
23 #include <linux/ctype.h>
24 #include <linux/mempool.h>
25 #include "cifspdu.h"
26 #include "cifsglob.h"
27 #include "cifsproto.h"
28 #include "cifs_debug.h"
29 #include "smberr.h"
30 #include "nterr.h"
31 #include "cifs_unicode.h"
32
33 extern mempool_t *cifs_sm_req_poolp;
34 extern mempool_t *cifs_req_poolp;
35 extern struct task_struct *oplockThread;
36
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 */
42
43 unsigned int
44 _GetXid(void)
45 {
46         unsigned int xid;
47
48         spin_lock(&GlobalMid_Lock);
49         GlobalTotalActiveXid++;
50
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);
58         return xid;
59 }
60
61 void
62 _FreeXid(unsigned int xid)
63 {
64         spin_lock(&GlobalMid_Lock);
65         /* if (GlobalTotalActiveXid == 0)
66                 BUG(); */
67         GlobalTotalActiveXid--;
68         spin_unlock(&GlobalMid_Lock);
69 }
70
71 struct cifsSesInfo *
72 sesInfoAlloc(void)
73 {
74         struct cifsSesInfo *ret_buf;
75
76         ret_buf = kzalloc(sizeof(struct cifsSesInfo), GFP_KERNEL);
77         if (ret_buf) {
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);
84         }
85         return ret_buf;
86 }
87
88 void
89 sesInfoFree(struct cifsSesInfo *buf_to_free)
90 {
91         if (buf_to_free == NULL) {
92                 cFYI(1, ("Null buffer passed to sesInfoFree"));
93                 return;
94         }
95
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);
104         kfree(buf_to_free->domainName);
105         kfree(buf_to_free);
106 }
107
108 struct cifsTconInfo *
109 tconInfoAlloc(void)
110 {
111         struct cifsTconInfo *ret_buf;
112         ret_buf = kzalloc(sizeof(struct cifsTconInfo), GFP_KERNEL);
113         if (ret_buf) {
114                 write_lock(&GlobalSMBSeslock);
115                 atomic_inc(&tconInfoAllocCount);
116                 list_add(&ret_buf->cifsConnectionList,
117                          &GlobalTreeConnectionList);
118                 ret_buf->tidStatus = CifsNew;
119                 INIT_LIST_HEAD(&ret_buf->openFileList);
120                 init_MUTEX(&ret_buf->tconSem);
121 #ifdef CONFIG_CIFS_STATS
122                 spin_lock_init(&ret_buf->stat_lock);
123 #endif
124                 write_unlock(&GlobalSMBSeslock);
125         }
126         return ret_buf;
127 }
128
129 void
130 tconInfoFree(struct cifsTconInfo *buf_to_free)
131 {
132         if (buf_to_free == NULL) {
133                 cFYI(1, ("Null buffer passed to tconInfoFree"));
134                 return;
135         }
136         write_lock(&GlobalSMBSeslock);
137         atomic_dec(&tconInfoAllocCount);
138         list_del(&buf_to_free->cifsConnectionList);
139         write_unlock(&GlobalSMBSeslock);
140         kfree(buf_to_free->nativeFileSystem);
141         kfree(buf_to_free);
142 }
143
144 struct smb_hdr *
145 cifs_buf_get(void)
146 {
147         struct smb_hdr *ret_buf = NULL;
148
149 /* We could use negotiated size instead of max_msgsize -
150    but it may be more efficient to always alloc same size
151    albeit slightly larger than necessary and maxbuffersize
152    defaults to this and can not be bigger */
153         ret_buf = mempool_alloc(cifs_req_poolp, GFP_NOFS);
154
155         /* clear the first few header bytes */
156         /* for most paths, more is cleared in header_assemble */
157         if (ret_buf) {
158                 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
159                 atomic_inc(&bufAllocCount);
160 #ifdef CONFIG_CIFS_STATS2
161                 atomic_inc(&totBufAllocCount);
162 #endif /* CONFIG_CIFS_STATS2 */
163         }
164
165         return ret_buf;
166 }
167
168 void
169 cifs_buf_release(void *buf_to_free)
170 {
171         if (buf_to_free == NULL) {
172                 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
173                 return;
174         }
175         mempool_free(buf_to_free, cifs_req_poolp);
176
177         atomic_dec(&bufAllocCount);
178         return;
179 }
180
181 struct smb_hdr *
182 cifs_small_buf_get(void)
183 {
184         struct smb_hdr *ret_buf = NULL;
185
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 */
190         ret_buf = mempool_alloc(cifs_sm_req_poolp, GFP_NOFS);
191         if (ret_buf) {
192         /* No need to clear memory here, cleared in header assemble */
193         /*      memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
194                 atomic_inc(&smBufAllocCount);
195 #ifdef CONFIG_CIFS_STATS2
196                 atomic_inc(&totSmBufAllocCount);
197 #endif /* CONFIG_CIFS_STATS2 */
198
199         }
200         return ret_buf;
201 }
202
203 void
204 cifs_small_buf_release(void *buf_to_free)
205 {
206
207         if (buf_to_free == NULL) {
208                 cFYI(1, ("Null buffer passed to cifs_small_buf_release"));
209                 return;
210         }
211         mempool_free(buf_to_free, cifs_sm_req_poolp);
212
213         atomic_dec(&smBufAllocCount);
214         return;
215 }
216
217 /*
218         Find a free multiplex id (SMB mid). Otherwise there could be
219         mid collisions which might cause problems, demultiplexing the
220         wrong response to this request. Multiplex ids could collide if
221         one of a series requests takes much longer than the others, or
222         if a very large number of long lived requests (byte range
223         locks or FindNotify requests) are pending.  No more than
224         64K-1 requests can be outstanding at one time.  If no
225         mids are available, return zero.  A future optimization
226         could make the combination of mids and uid the key we use
227         to demultiplex on (rather than mid alone).
228         In addition to the above check, the cifs demultiplex
229         code already used the command code as a secondary
230         check of the frame and if signing is negotiated the
231         response would be discarded if the mid were the same
232         but the signature was wrong.  Since the mid is not put in the
233         pending queue until later (when it is about to be dispatched)
234         we do have to limit the number of outstanding requests
235         to somewhat less than 64K-1 although it is hard to imagine
236         so many threads being in the vfs at one time.
237 */
238 __u16 GetNextMid(struct TCP_Server_Info *server)
239 {
240         __u16 mid = 0;
241         __u16 last_mid;
242         int   collision;
243
244         if (server == NULL)
245                 return mid;
246
247         spin_lock(&GlobalMid_Lock);
248         last_mid = server->CurrentMid; /* we do not want to loop forever */
249         server->CurrentMid++;
250         /* This nested loop looks more expensive than it is.
251         In practice the list of pending requests is short,
252         fewer than 50, and the mids are likely to be unique
253         on the first pass through the loop unless some request
254         takes longer than the 64 thousand requests before it
255         (and it would also have to have been a request that
256          did not time out) */
257         while (server->CurrentMid != last_mid) {
258                 struct list_head *tmp;
259                 struct mid_q_entry *mid_entry;
260
261                 collision = 0;
262                 if (server->CurrentMid == 0)
263                         server->CurrentMid++;
264
265                 list_for_each(tmp, &server->pending_mid_q) {
266                         mid_entry = list_entry(tmp, struct mid_q_entry, qhead);
267
268                         if ((mid_entry->mid == server->CurrentMid) &&
269                             (mid_entry->midState == MID_REQUEST_SUBMITTED)) {
270                                 /* This mid is in use, try a different one */
271                                 collision = 1;
272                                 break;
273                         }
274                 }
275                 if (collision == 0) {
276                         mid = server->CurrentMid;
277                         break;
278                 }
279                 server->CurrentMid++;
280         }
281         spin_unlock(&GlobalMid_Lock);
282         return mid;
283 }
284
285 /* NB: MID can not be set if treeCon not passed in, in that
286    case it is responsbility of caller to set the mid */
287 void
288 header_assemble(struct smb_hdr *buffer, char smb_command /* command */ ,
289                 const struct cifsTconInfo *treeCon, int word_count
290                 /* length of fixed section (word count) in two byte units  */)
291 {
292         struct list_head *temp_item;
293         struct cifsSesInfo *ses;
294         char *temp = (char *) buffer;
295
296         memset(temp, 0, 256); /* bigger than MAX_CIFS_HDR_SIZE */
297
298         buffer->smb_buf_length =
299             (2 * word_count) + sizeof(struct smb_hdr) -
300             4 /*  RFC 1001 length field does not count */  +
301             2 /* for bcc field itself */ ;
302         /* Note that this is the only network field that has to be converted
303            to big endian and it is done just before we send it */
304
305         buffer->Protocol[0] = 0xFF;
306         buffer->Protocol[1] = 'S';
307         buffer->Protocol[2] = 'M';
308         buffer->Protocol[3] = 'B';
309         buffer->Command = smb_command;
310         buffer->Flags = 0x00;   /* case sensitive */
311         buffer->Flags2 = SMBFLG2_KNOWS_LONG_NAMES;
312         buffer->Pid = cpu_to_le16((__u16)current->tgid);
313         buffer->PidHigh = cpu_to_le16((__u16)(current->tgid >> 16));
314         if (treeCon) {
315                 buffer->Tid = treeCon->tid;
316                 if (treeCon->ses) {
317                         if (treeCon->ses->capabilities & CAP_UNICODE)
318                                 buffer->Flags2 |= SMBFLG2_UNICODE;
319                         if (treeCon->ses->capabilities & CAP_STATUS32)
320                                 buffer->Flags2 |= SMBFLG2_ERR_STATUS;
321
322                         /* Uid is not converted */
323                         buffer->Uid = treeCon->ses->Suid;
324                         buffer->Mid = GetNextMid(treeCon->ses->server);
325                         if (multiuser_mount != 0) {
326                 /* For the multiuser case, there are few obvious technically  */
327                 /* possible mechanisms to match the local linux user (uid)    */
328                 /* to a valid remote smb user (smb_uid):                      */
329                 /*      1) Query Winbind (or other local pam/nss daemon       */
330                 /*        for userid/password/logon_domain or credential      */
331                 /*      2) Query Winbind for uid to sid to username mapping   */
332                 /*         and see if we have a matching password for existing*/
333                 /*         session for that user perhas getting password by   */
334                 /*         adding a new pam_cifs module that stores passwords */
335                 /*         so that the cifs vfs can get at that for all logged*/
336                 /*         on users                                           */
337                 /*      3) (Which is the mechanism we have chosen)            */
338                 /*         Search through sessions to the same server for a   */
339                 /*         a match on the uid that was passed in on mount     */
340                 /*         with the current processes uid (or euid?) and use  */
341                 /*         that smb uid.   If no existing smb session for     */
342                 /*         that uid found, use the default smb session ie     */
343                 /*         the smb session for the volume mounted which is    */
344                 /*         the same as would be used if the multiuser mount   */
345                 /*         flag were disabled.  */
346
347                 /*  BB Add support for establishing new tCon and SMB Session  */
348                 /*      with userid/password pairs found on the smb session   */
349                 /*      for other target tcp/ip addresses               BB    */
350                                 if (current->fsuid != treeCon->ses->linux_uid) {
351                                         cFYI(1, ("Multiuser mode and UID "
352                                                  "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->fsuid) {
357                                                         if (ses->server == treeCon->ses->server) {
358                                                                 cFYI(1, ("found matching uid substitute right smb_uid"));
359                                                                 buffer->Uid = ses->Suid;
360                                                                 break;
361                                                         } else {
362                                 /* BB eventually call cifs_setup_session here */
363                                                                 cFYI(1, ("local UID found but no smb sess with this server exists"));
364                                                         }
365                                                 }
366                                         }
367                                         read_unlock(&GlobalSMBSeslock);
368                                 }
369                         }
370                 }
371                 if (treeCon->Flags & SMB_SHARE_IS_IN_DFS)
372                         buffer->Flags2 |= SMBFLG2_DFS;
373                 if (treeCon->nocase)
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;
379         }
380
381 /*  endian conversion of flags is now done just before sending */
382         buffer->WordCount = (char) word_count;
383         return;
384 }
385
386 static int
387 checkSMBhdr(struct smb_hdr *smb, __u16 mid)
388 {
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)) &&
392                 (mid == smb->Mid)) {
393                 if (smb->Flags & SMBFLG_RESPONSE)
394                         return 0;
395                 else {
396                 /* only one valid case where server sends us request */
397                         if (smb->Command == SMB_COM_LOCKING_ANDX)
398                                 return 0;
399                         else
400                                 cERROR(1, ("Received Request not response"));
401                 }
402         } else { /* bad signature or mid */
403                 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff))
404                         cERROR(1,
405                                ("Bad protocol string signature header %x",
406                                 *(unsigned int *) smb->Protocol));
407                 if (mid != smb->Mid)
408                         cERROR(1, ("Mids do not match"));
409         }
410         cERROR(1, ("bad smb detected. The Mid=%d", smb->Mid));
411         return 1;
412 }
413
414 int
415 checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length)
416 {
417         __u32 len = smb->smb_buf_length;
418         __u32 clc_len;  /* calculated length */
419         cFYI(0, ("checkSMB Length: 0x%x, smb_buf_length: 0x%x", length, len));
420
421         if (length < 2 + sizeof(struct smb_hdr)) {
422                 if ((length >= sizeof(struct smb_hdr) - 1)
423                             && (smb->Status.CifsError != 0)) {
424                         smb->WordCount = 0;
425                         /* some error cases do not return wct and bcc */
426                         return 0;
427                 } else if ((length == sizeof(struct smb_hdr) + 1) &&
428                                 (smb->WordCount == 0)) {
429                         char *tmp = (char *)smb;
430                         /* Need to work around a bug in two servers here */
431                         /* First, check if the part of bcc they sent was zero */
432                         if (tmp[sizeof(struct smb_hdr)] == 0) {
433                                 /* some servers return only half of bcc
434                                  * on simple responses (wct, bcc both zero)
435                                  * in particular have seen this on
436                                  * ulogoffX and FindClose. This leaves
437                                  * one byte of bcc potentially unitialized
438                                  */
439                                 /* zero rest of bcc */
440                                 tmp[sizeof(struct smb_hdr)+1] = 0;
441                                 return 0;
442                         }
443                         cERROR(1, ("rcvd invalid byte count (bcc)"));
444                 } else {
445                         cERROR(1, ("Length less than smb header size"));
446                 }
447                 return 1;
448         }
449         if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
450                 cERROR(1, ("smb length greater than MaxBufSize, mid=%d",
451                                    smb->Mid));
452                 return 1;
453         }
454
455         if (checkSMBhdr(smb, mid))
456                 return 1;
457         clc_len = smbCalcSize_LE(smb);
458
459         if (4 + len != length) {
460                 cERROR(1, ("Length read does not match RFC1001 length %d",
461                            len));
462                 return 1;
463         }
464
465         if (4 + len != clc_len) {
466                 /* check if bcc wrapped around for large read responses */
467                 if ((len > 64 * 1024) && (len > clc_len)) {
468                         /* check if lengths match mod 64K */
469                         if (((4 + len) & 0xFFFF) == (clc_len & 0xFFFF))
470                                 return 0; /* bcc wrapped */
471                 }
472                 cFYI(1, ("Calculated size %d vs length %d mismatch for mid %d",
473                                 clc_len, 4 + len, smb->Mid));
474                 /* Windows XP can return a few bytes too much, presumably
475                 an illegal pad, at the end of byte range lock responses
476                 so we allow for that three byte pad, as long as actual
477                 received length is as long or longer than calculated length */
478                 /* We have now had to extend this more, since there is a
479                 case in which it needs to be bigger still to handle a
480                 malformed response to transact2 findfirst from WinXP when
481                 access denied is returned and thus bcc and wct are zero
482                 but server says length is 0x21 bytes too long as if the server
483                 forget to reset the smb rfc1001 length when it reset the
484                 wct and bcc to minimum size and drop the t2 parms and data */
485                 if ((4+len > clc_len) && (len <= clc_len + 512))
486                         return 0;
487                 else {
488                         cERROR(1, ("RFC1001 size %d bigger than SMB for Mid=%d",
489                                         len, smb->Mid));
490                         return 1;
491                 }
492         }
493         return 0;
494 }
495
496 bool
497 is_valid_oplock_break(struct smb_hdr *buf, struct TCP_Server_Info *srv)
498 {
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;
504
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);
514
515                         pnotify = (struct file_notify_information *)
516                                 ((char *)&pSMBr->hdr.Protocol + data_offset);
517                         cFYI(1, ("dnotify on %s Action: 0x%x",
518                                  pnotify->FileName, pnotify->Action));
519                         /*   cifs_dump_mem("Rcvd notify Data: ",buf,
520                                 sizeof(struct smb_hdr)+60); */
521                         return true;
522                 }
523                 if (pSMBr->hdr.Status.CifsError) {
524                         cFYI(1, ("notify err 0x%d",
525                                 pSMBr->hdr.Status.CifsError));
526                         return true;
527                 }
528                 return false;
529         }
530         if (pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
531                 return false;
532         if (pSMB->hdr.Flags & SMBFLG_RESPONSE) {
533                 /* no sense logging error on invalid handle on oplock
534                    break - harmless race between close request and oplock
535                    break response is expected from time to time writing out
536                    large dirty files cached on the client */
537                 if ((NT_STATUS_INVALID_HANDLE) ==
538                    le32_to_cpu(pSMB->hdr.Status.CifsError)) {
539                         cFYI(1, ("invalid handle on oplock break"));
540                         return true;
541                 } else if (ERRbadfid ==
542                    le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
543                         return true;
544                 } else {
545                         return false; /* on valid oplock brk we get "request" */
546                 }
547         }
548         if (pSMB->hdr.WordCount != 8)
549                 return false;
550
551         cFYI(1, ("oplock type 0x%d level 0x%d",
552                  pSMB->LockType, pSMB->OplockLevel));
553         if (!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
554                 return false;
555
556         /* look up tcon based on tid & uid */
557         read_lock(&GlobalSMBSeslock);
558         list_for_each(tmp, &GlobalTreeConnectionList) {
559                 tcon = list_entry(tmp, struct cifsTconInfo, cifsConnectionList);
560                 if ((tcon->tid == buf->Tid) && (srv == tcon->ses->server)) {
561                         cifs_stats_inc(&tcon->num_oplock_brks);
562                         list_for_each(tmp1, &tcon->openFileList) {
563                                 netfile = list_entry(tmp1, struct cifsFileInfo,
564                                                      tlist);
565                                 if (pSMB->Fid == netfile->netfid) {
566                                         struct cifsInodeInfo *pCifsInode;
567                                         read_unlock(&GlobalSMBSeslock);
568                                         cFYI(1,
569                                             ("file id match, oplock break"));
570                                         pCifsInode =
571                                                 CIFS_I(netfile->pInode);
572                                         pCifsInode->clientCanCacheAll = false;
573                                         if (pSMB->OplockLevel == 0)
574                                                 pCifsInode->clientCanCacheRead
575                                                         = false;
576                                         pCifsInode->oplockPending = true;
577                                         AllocOplockQEntry(netfile->pInode,
578                                                           netfile->netfid,
579                                                           tcon);
580                                         cFYI(1,
581                                             ("about to wake up oplock thread"));
582                                         if (oplockThread)
583                                             wake_up_process(oplockThread);
584                                         return true;
585                                 }
586                         }
587                         read_unlock(&GlobalSMBSeslock);
588                         cFYI(1, ("No matching file for oplock break"));
589                         return true;
590                 }
591         }
592         read_unlock(&GlobalSMBSeslock);
593         cFYI(1, ("Can not process oplock break for non-existent connection"));
594         return true;
595 }
596
597 void
598 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
599 {
600         int i, j;
601         char debug_line[17];
602         unsigned char *buffer;
603
604         if (traceSMB == 0)
605                 return;
606
607         buffer = (unsigned char *) smb_buf;
608         for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
609                 if (i % 8 == 0) {
610                         /* have reached the beginning of line */
611                         printk(KERN_DEBUG "| ");
612                         j = 0;
613                 }
614                 printk("%0#4x ", buffer[i]);
615                 debug_line[2 * j] = ' ';
616                 if (isprint(buffer[i]))
617                         debug_line[1 + (2 * j)] = buffer[i];
618                 else
619                         debug_line[1 + (2 * j)] = '_';
620
621                 if (i % 8 == 7) {
622                         /* reached end of line, time to print ascii */
623                         debug_line[16] = 0;
624                         printk(" | %s\n", debug_line);
625                 }
626         }
627         for (; j < 8; j++) {
628                 printk("     ");
629                 debug_line[2 * j] = ' ';
630                 debug_line[1 + (2 * j)] = ' ';
631         }
632         printk(" | %s\n", debug_line);
633         return;
634 }
635
636 /* Windows maps these to the user defined 16 bit Unicode range since they are
637    reserved symbols (along with \ and /), otherwise illegal to store
638    in filenames in NTFS */
639 #define UNI_ASTERIK     (__u16) ('*' + 0xF000)
640 #define UNI_QUESTION    (__u16) ('?' + 0xF000)
641 #define UNI_COLON       (__u16) (':' + 0xF000)
642 #define UNI_GRTRTHAN    (__u16) ('>' + 0xF000)
643 #define UNI_LESSTHAN    (__u16) ('<' + 0xF000)
644 #define UNI_PIPE        (__u16) ('|' + 0xF000)
645 #define UNI_SLASH       (__u16) ('\\' + 0xF000)
646
647 /* Convert 16 bit Unicode pathname from wire format to string in current code
648    page.  Conversion may involve remapping up the seven characters that are
649    only legal in POSIX-like OS (if they are present in the string). Path
650    names are little endian 16 bit Unicode on the wire */
651 int
652 cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
653                     const struct nls_table *cp)
654 {
655         int i, j, len;
656         __u16 src_char;
657
658         for (i = 0, j = 0; i < maxlen; i++) {
659                 src_char = le16_to_cpu(source[i]);
660                 switch (src_char) {
661                         case 0:
662                                 goto cUCS_out; /* BB check this BB */
663                         case UNI_COLON:
664                                 target[j] = ':';
665                                 break;
666                         case UNI_ASTERIK:
667                                 target[j] = '*';
668                                 break;
669                         case UNI_QUESTION:
670                                 target[j] = '?';
671                                 break;
672                         /* BB We can not handle remapping slash until
673                            all the calls to build_path_from_dentry
674                            are modified, as they use slash as separator BB */
675                         /* case UNI_SLASH:
676                                 target[j] = '\\';
677                                 break;*/
678                         case UNI_PIPE:
679                                 target[j] = '|';
680                                 break;
681                         case UNI_GRTRTHAN:
682                                 target[j] = '>';
683                                 break;
684                         case UNI_LESSTHAN:
685                                 target[j] = '<';
686                                 break;
687                         default:
688                                 len = cp->uni2char(src_char, &target[j],
689                                                 NLS_MAX_CHARSET_SIZE);
690                                 if (len > 0) {
691                                         j += len;
692                                         continue;
693                                 } else {
694                                         target[j] = '?';
695                                 }
696                 }
697                 j++;
698                 /* make sure we do not overrun callers allocated temp buffer */
699                 if (j >= (2 * NAME_MAX))
700                         break;
701         }
702 cUCS_out:
703         target[j] = 0;
704         return j;
705 }
706
707 /* Convert 16 bit Unicode pathname to wire format from string in current code
708    page.  Conversion may involve remapping up the seven characters that are
709    only legal in POSIX-like OS (if they are present in the string). Path
710    names are little endian 16 bit Unicode on the wire */
711 int
712 cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
713                  const struct nls_table *cp, int mapChars)
714 {
715         int i, j, charlen;
716         int len_remaining = maxlen;
717         char src_char;
718         __u16 temp;
719
720         if (!mapChars)
721                 return cifs_strtoUCS(target, source, PATH_MAX, cp);
722
723         for (i = 0, j = 0; i < maxlen; j++) {
724                 src_char = source[i];
725                 switch (src_char) {
726                         case 0:
727                                 target[j] = 0;
728                                 goto ctoUCS_out;
729                         case ':':
730                                 target[j] = cpu_to_le16(UNI_COLON);
731                                 break;
732                         case '*':
733                                 target[j] = cpu_to_le16(UNI_ASTERIK);
734                                 break;
735                         case '?':
736                                 target[j] = cpu_to_le16(UNI_QUESTION);
737                                 break;
738                         case '<':
739                                 target[j] = cpu_to_le16(UNI_LESSTHAN);
740                                 break;
741                         case '>':
742                                 target[j] = cpu_to_le16(UNI_GRTRTHAN);
743                                 break;
744                         case '|':
745                                 target[j] = cpu_to_le16(UNI_PIPE);
746                                 break;
747                         /* BB We can not handle remapping slash until
748                            all the calls to build_path_from_dentry
749                            are modified, as they use slash as separator BB */
750                         /* case '\\':
751                                 target[j] = cpu_to_le16(UNI_SLASH);
752                                 break;*/
753                         default:
754                                 charlen = cp->char2uni(source+i,
755                                         len_remaining, &temp);
756                                 /* if no match, use question mark, which
757                                 at least in some cases servers as wild card */
758                                 if (charlen < 1) {
759                                         target[j] = cpu_to_le16(0x003f);
760                                         charlen = 1;
761                                 } else
762                                         target[j] = cpu_to_le16(temp);
763                                 len_remaining -= charlen;
764                                 /* character may take more than one byte in the
765                                    the source string, but will take exactly two
766                                    bytes in the target string */
767                                 i += charlen;
768                                 continue;
769                 }
770                 i++; /* move to next char in source string */
771                 len_remaining--;
772         }
773
774 ctoUCS_out:
775         return i;
776 }