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