[CIFS] Convert remaining places in fs/cifs from
[sfrench/cifs-2.6.git] / fs / cifs / misc.c
1 /*
2  *   fs/cifs/misc.c
3  *
4  *   Copyright (C) International Business Machines  Corp., 2002,2005
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         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);
56         return xid;
57 }
58
59 void
60 _FreeXid(unsigned int xid)
61 {
62         spin_lock(&GlobalMid_Lock);
63         /* if(GlobalTotalActiveXid == 0)
64                 BUG(); */
65         GlobalTotalActiveXid--;
66         spin_unlock(&GlobalMid_Lock);
67 }
68
69 struct cifsSesInfo *
70 sesInfoAlloc(void)
71 {
72         struct cifsSesInfo *ret_buf;
73
74         ret_buf =
75             (struct cifsSesInfo *) kzalloc(sizeof (struct cifsSesInfo),
76                                            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);
105 }
106
107 struct cifsTconInfo *
108 tconInfoAlloc(void)
109 {
110         struct cifsTconInfo *ret_buf;
111         ret_buf =
112             (struct cifsTconInfo *) kzalloc(sizeof (struct cifsTconInfo),
113                                             GFP_KERNEL);
114         if (ret_buf) {
115                 write_lock(&GlobalSMBSeslock);
116                 atomic_inc(&tconInfoAllocCount);
117                 list_add(&ret_buf->cifsConnectionList,
118                          &GlobalTreeConnectionList);
119                 ret_buf->tidStatus = CifsNew;
120                 INIT_LIST_HEAD(&ret_buf->openFileList);
121                 init_MUTEX(&ret_buf->tconSem);
122 #ifdef CONFIG_CIFS_STATS
123                 spin_lock_init(&ret_buf->stat_lock);
124 #endif
125                 write_unlock(&GlobalSMBSeslock);
126         }
127         return ret_buf;
128 }
129
130 void
131 tconInfoFree(struct cifsTconInfo *buf_to_free)
132 {
133         if (buf_to_free == NULL) {
134                 cFYI(1, ("Null buffer passed to tconInfoFree"));
135                 return;
136         }
137         write_lock(&GlobalSMBSeslock);
138         atomic_dec(&tconInfoAllocCount);
139         list_del(&buf_to_free->cifsConnectionList);
140         write_unlock(&GlobalSMBSeslock);
141         kfree(buf_to_free->nativeFileSystem);
142         kfree(buf_to_free);
143 }
144
145 struct smb_hdr *
146 cifs_buf_get(void)
147 {
148         struct smb_hdr *ret_buf = NULL;
149
150 /* We could use negotiated size instead of max_msgsize - 
151    but it may be more efficient to always alloc same size 
152    albeit slightly larger than necessary and maxbuffersize 
153    defaults to this and can not be bigger */
154         ret_buf =
155             (struct smb_hdr *) mempool_alloc(cifs_req_poolp, SLAB_KERNEL | SLAB_NOFS);
156
157         /* clear the first few header bytes */
158         /* for most paths, more is cleared in header_assemble */
159         if (ret_buf) {
160                 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
161                 atomic_inc(&bufAllocCount);
162 #ifdef CONFIG_CIFS_STATS2
163                 atomic_inc(&totBufAllocCount);
164 #endif /* CONFIG_CIFS_STATS2 */
165         }
166
167         return ret_buf;
168 }
169
170 void
171 cifs_buf_release(void *buf_to_free)
172 {
173
174         if (buf_to_free == NULL) {
175                 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
176                 return;
177         }
178         mempool_free(buf_to_free,cifs_req_poolp);
179
180         atomic_dec(&bufAllocCount);
181         return;
182 }
183
184 struct smb_hdr *
185 cifs_small_buf_get(void)
186 {
187         struct smb_hdr *ret_buf = NULL;
188
189 /* We could use negotiated size instead of max_msgsize - 
190    but it may be more efficient to always alloc same size 
191    albeit slightly larger than necessary and maxbuffersize 
192    defaults to this and can not be bigger */
193         ret_buf =
194             (struct smb_hdr *) mempool_alloc(cifs_sm_req_poolp, SLAB_KERNEL | SLAB_NOFS);
195         if (ret_buf) {
196         /* No need to clear memory here, cleared in header assemble */
197         /*      memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
198                 atomic_inc(&smBufAllocCount);
199 #ifdef CONFIG_CIFS_STATS2
200                 atomic_inc(&totSmBufAllocCount);
201 #endif /* CONFIG_CIFS_STATS2 */
202
203         }
204         return ret_buf;
205 }
206
207 void
208 cifs_small_buf_release(void *buf_to_free)
209 {
210
211         if (buf_to_free == NULL) {
212                 cFYI(1, ("Null buffer passed to cifs_small_buf_release"));
213                 return;
214         }
215         mempool_free(buf_to_free,cifs_sm_req_poolp);
216
217         atomic_dec(&smBufAllocCount);
218         return;
219 }
220
221 /* 
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.
241 */
242 __u16 GetNextMid(struct TCP_Server_Info *server)
243 {
244         __u16 mid = 0;
245         __u16 last_mid;
246         int   collision;  
247
248         if(server == NULL)
249                 return mid;
250
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
260          did not time out) */
261         while(server->CurrentMid != last_mid) {
262                 struct list_head *tmp;
263                 struct mid_q_entry *mid_entry;
264
265                 collision = 0;
266                 if(server->CurrentMid == 0)
267                         server->CurrentMid++;
268
269                 list_for_each(tmp, &server->pending_mid_q) {
270                         mid_entry = list_entry(tmp, struct mid_q_entry, qhead);
271
272                         if ((mid_entry->mid == server->CurrentMid) &&
273                             (mid_entry->midState == MID_REQUEST_SUBMITTED)) {
274                                 /* This mid is in use, try a different one */
275                                 collision = 1;
276                                 break;
277                         }
278                 }
279                 if(collision == 0) {
280                         mid = server->CurrentMid;
281                         break;
282                 }
283                 server->CurrentMid++;
284         }
285         spin_unlock(&GlobalMid_Lock);
286         return mid;
287 }
288
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 */
291 void
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  */)
295 {
296         struct list_head* temp_item;
297         struct cifsSesInfo * ses;
298         char *temp = (char *) buffer;
299
300         memset(temp,0,256); /* bigger than MAX_CIFS_HDR_SIZE */
301
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 */
308
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);
320         if (treeCon) {
321                 buffer->Tid = treeCon->tid;
322                 if (treeCon->ses) {
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;
327                         }
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*/
342                 /*         on users                                           */
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.  */
352
353                 /*  BB Add support for establishing new tCon and SMB Session  */
354                 /*      with userid/password pairs found on the smb session   */ 
355                 /*      for other target tcp/ip addresses               BB    */
356                                 if(current->fsuid != treeCon->ses->linux_uid) {
357                                         cFYI(1,("Multiuser mode and UID did not match tcon uid"));
358                                         read_lock(&GlobalSMBSeslock);
359                                         list_for_each(temp_item, &GlobalSMBSessionList) {
360                                                 ses = list_entry(temp_item, struct cifsSesInfo, cifsSessionList);
361                                                 if(ses->linux_uid == current->fsuid) {
362                                                         if(ses->server == treeCon->ses->server) {
363                                                                 cFYI(1,("found matching uid substitute right smb_uid"));  
364                                                                 buffer->Uid = ses->Suid;
365                                                                 break;
366                                                         } else {
367                                                                 /* BB eventually call cifs_setup_session here */
368                                                                 cFYI(1,("local UID found but smb sess with this server does not exist"));  
369                                                         }
370                                                 }
371                                         }
372                                         read_unlock(&GlobalSMBSeslock);
373                                 }
374                         }
375                 }
376                 if (treeCon->Flags & SMB_SHARE_IS_IN_DFS)
377                         buffer->Flags2 |= SMBFLG2_DFS;
378                 if (treeCon->nocase)
379                         buffer->Flags  |= SMBFLG_CASELESS;
380                 if((treeCon->ses) && (treeCon->ses->server))
381                         if(treeCon->ses->server->secMode & 
382                           (SECMODE_SIGN_REQUIRED | SECMODE_SIGN_ENABLED))
383                                 buffer->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
384         }
385
386 /*  endian conversion of flags is now done just before sending */
387         buffer->WordCount = (char) word_count;
388         return;
389 }
390
391 int
392 checkSMBhdr(struct smb_hdr *smb, __u16 mid)
393 {
394         /* Make sure that this really is an SMB, that it is a response, 
395            and that the message ids match */
396         if ((*(__le32 *) smb->Protocol == cpu_to_le32(0x424d53ff)) && 
397                 (mid == smb->Mid)) {    
398                 if(smb->Flags & SMBFLG_RESPONSE)
399                         return 0;                    
400                 else {        
401                 /* only one valid case where server sends us request */
402                         if(smb->Command == SMB_COM_LOCKING_ANDX)
403                                 return 0;
404                         else
405                                 cERROR(1, ("Rcvd Request not response"));         
406                 }
407         } else { /* bad signature or mid */
408                 if (*(__le32 *) smb->Protocol != cpu_to_le32(0x424d53ff))
409                         cERROR(1,
410                                ("Bad protocol string signature header %x",
411                                 *(unsigned int *) smb->Protocol));
412                 if (mid != smb->Mid)
413                         cERROR(1, ("Mids do not match"));
414         }
415         cERROR(1, ("bad smb detected. The Mid=%d", smb->Mid));
416         return 1;
417 }
418
419 int
420 checkSMB(struct smb_hdr *smb, __u16 mid, int length)
421 {
422         __u32 len = smb->smb_buf_length;
423         __u32 clc_len;  /* calculated length */
424         cFYI(0,
425              ("Entering checkSMB with Length: %x, smb_buf_length: %x",
426               length, len));
427         if (((unsigned int)length < 2 + sizeof (struct smb_hdr)) ||
428             (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)) {
429                 if ((unsigned int)length < 2 + sizeof (struct smb_hdr)) {
430                         if (((unsigned int)length >= 
431                                 sizeof (struct smb_hdr) - 1)
432                             && (smb->Status.CifsError != 0)) {
433                                 smb->WordCount = 0;
434                                 return 0;       /* some error cases do not return wct and bcc */
435                         } else {
436                                 cERROR(1, ("Length less than smb header size"));
437                         }
438
439                 }
440                 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)
441                         cERROR(1,
442                                ("smb_buf_length greater than MaxBufSize"));
443                 cERROR(1,
444                        ("bad smb detected. Illegal length. mid=%d",
445                         smb->Mid));
446                 return 1;
447         }
448
449         if (checkSMBhdr(smb, mid))
450                 return 1;
451         clc_len = smbCalcSize_LE(smb);
452         if ((4 + len != clc_len)
453             || (4 + len != (unsigned int)length)) {
454                 cERROR(1, ("Calculated size 0x%x vs actual length 0x%x",
455                                 clc_len, 4 + len));
456                 cERROR(1, ("bad smb size detected for Mid=%d", smb->Mid));
457                 /* Windows XP can return a few bytes too much, presumably
458                 an illegal pad, at the end of byte range lock responses 
459                 so we allow for that three byte pad, as long as actual
460                 received length is as long or longer than calculated length */
461                 /* We have now had to extend this more, since there is a 
462                 case in which it needs to be bigger still to handle a
463                 malformed response to transact2 findfirst from WinXP when
464                 access denied is returned and thus bcc and wct are zero
465                 but server says length is 0x21 bytes too long as if the server
466                 forget to reset the smb rfc1001 length when it reset the
467                 wct and bcc to minimum size and drop the t2 parms and data */
468                 if((4+len > clc_len) && (len <= clc_len + 512))
469                         return 0;
470                 else
471                         return 1;
472         }
473         return 0;
474 }
475 int
476 is_valid_oplock_break(struct smb_hdr *buf)
477 {    
478         struct smb_com_lock_req * pSMB = (struct smb_com_lock_req *)buf;
479         struct list_head *tmp;
480         struct list_head *tmp1;
481         struct cifsTconInfo *tcon;
482         struct cifsFileInfo *netfile;
483
484         cFYI(1,("Checking for oplock break or dnotify response"));
485         if((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
486            (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
487                 struct smb_com_transaction_change_notify_rsp * pSMBr =
488                         (struct smb_com_transaction_change_notify_rsp *)buf;
489                 struct file_notify_information * pnotify;
490                 __u32 data_offset = 0;
491                 if(pSMBr->ByteCount > sizeof(struct file_notify_information)) {
492                         data_offset = le32_to_cpu(pSMBr->DataOffset);
493
494                         pnotify = (struct file_notify_information *)((char *)&pSMBr->hdr.Protocol
495                                 + data_offset);
496                         cFYI(1,("dnotify on %s with action: 0x%x",pnotify->FileName,
497                                 pnotify->Action));  /* BB removeme BB */
498                      /*   cifs_dump_mem("Received notify Data is: ",buf,sizeof(struct smb_hdr)+60); */
499                         return TRUE;
500                 }
501                 if(pSMBr->hdr.Status.CifsError) {
502                         cFYI(1,("notify err 0x%d",pSMBr->hdr.Status.CifsError));
503                         return TRUE;
504                 }
505                 return FALSE;
506         }  
507         if(pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
508                 return FALSE;
509         if(pSMB->hdr.Flags & SMBFLG_RESPONSE) {
510                 /* no sense logging error on invalid handle on oplock
511                    break - harmless race between close request and oplock
512                    break response is expected from time to time writing out
513                    large dirty files cached on the client */
514                 if ((NT_STATUS_INVALID_HANDLE) == 
515                    le32_to_cpu(pSMB->hdr.Status.CifsError)) { 
516                         cFYI(1,("invalid handle on oplock break"));
517                         return TRUE;
518                 } else if (ERRbadfid == 
519                    le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
520                         return TRUE;      
521                 } else {
522                         return FALSE; /* on valid oplock brk we get "request" */
523                 }
524         }
525         if(pSMB->hdr.WordCount != 8)
526                 return FALSE;
527
528         cFYI(1,(" oplock type 0x%d level 0x%d",pSMB->LockType,pSMB->OplockLevel));
529         if(!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
530                 return FALSE;    
531
532         /* look up tcon based on tid & uid */
533         read_lock(&GlobalSMBSeslock);
534         list_for_each(tmp, &GlobalTreeConnectionList) {
535                 tcon = list_entry(tmp, struct cifsTconInfo, cifsConnectionList);
536                 if (tcon->tid == buf->Tid) {
537                         cifs_stats_inc(&tcon->num_oplock_brks);
538                         list_for_each(tmp1,&tcon->openFileList){
539                                 netfile = list_entry(tmp1,struct cifsFileInfo,
540                                                      tlist);
541                                 if(pSMB->Fid == netfile->netfid) {
542                                         struct cifsInodeInfo *pCifsInode;
543                                         read_unlock(&GlobalSMBSeslock);
544                                         cFYI(1,("file id match, oplock break"));
545                                         pCifsInode = 
546                                                 CIFS_I(netfile->pInode);
547                                         pCifsInode->clientCanCacheAll = FALSE;
548                                         if(pSMB->OplockLevel == 0)
549                                                 pCifsInode->clientCanCacheRead
550                                                         = FALSE;
551                                         pCifsInode->oplockPending = TRUE;
552                                         AllocOplockQEntry(netfile->pInode,
553                                                           netfile->netfid,
554                                                           tcon);
555                                         cFYI(1,("about to wake up oplock thd"));
556                                         if(oplockThread)
557                                             wake_up_process(oplockThread);
558                                         return TRUE;
559                                 }
560                         }
561                         read_unlock(&GlobalSMBSeslock);
562                         cFYI(1,("No matching file for oplock break"));
563                         return TRUE;
564                 }
565         }
566         read_unlock(&GlobalSMBSeslock);
567         cFYI(1,("Can not process oplock break for non-existent connection"));
568         return TRUE;
569 }
570
571 void
572 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
573 {
574         int i, j;
575         char debug_line[17];
576         unsigned char *buffer;
577
578         if (traceSMB == 0)
579                 return;
580
581         buffer = (unsigned char *) smb_buf;
582         for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
583                 if (i % 8 == 0) {       /* have reached the beginning of line */
584                         printk(KERN_DEBUG "| ");
585                         j = 0;
586                 }
587                 printk("%0#4x ", buffer[i]);
588                 debug_line[2 * j] = ' ';
589                 if (isprint(buffer[i]))
590                         debug_line[1 + (2 * j)] = buffer[i];
591                 else
592                         debug_line[1 + (2 * j)] = '_';
593
594                 if (i % 8 == 7) { /* reached end of line, time to print ascii */
595                         debug_line[16] = 0;
596                         printk(" | %s\n", debug_line);
597                 }
598         }
599         for (; j < 8; j++) {
600                 printk("     ");
601                 debug_line[2 * j] = ' ';
602                 debug_line[1 + (2 * j)] = ' ';
603         }
604         printk( " | %s\n", debug_line);
605         return;
606 }
607
608 /* Windows maps these to the user defined 16 bit Unicode range since they are
609    reserved symbols (along with \ and /), otherwise illegal to store
610    in filenames in NTFS */
611 #define UNI_ASTERIK     (__u16) ('*' + 0xF000)
612 #define UNI_QUESTION    (__u16) ('?' + 0xF000)
613 #define UNI_COLON       (__u16) (':' + 0xF000)
614 #define UNI_GRTRTHAN    (__u16) ('>' + 0xF000)
615 #define UNI_LESSTHAN    (__u16) ('<' + 0xF000)
616 #define UNI_PIPE        (__u16) ('|' + 0xF000)
617 #define UNI_SLASH       (__u16) ('\\' + 0xF000)
618
619 /* Convert 16 bit Unicode pathname from wire format to string in current code
620    page.  Conversion may involve remapping up the seven characters that are
621    only legal in POSIX-like OS (if they are present in the string). Path
622    names are little endian 16 bit Unicode on the wire */
623 int
624 cifs_convertUCSpath(char *target, const __le16 * source, int maxlen,
625                     const struct nls_table * cp)
626 {
627         int i,j,len;
628         __u16 src_char;
629
630         for(i = 0, j = 0; i < maxlen; i++) {
631                 src_char = le16_to_cpu(source[i]);
632                 switch (src_char) {
633                         case 0:
634                                 goto cUCS_out; /* BB check this BB */
635                         case UNI_COLON:
636                                 target[j] = ':';
637                                 break;
638                         case UNI_ASTERIK:
639                                 target[j] = '*';
640                                 break;
641                         case UNI_QUESTION:
642                                 target[j] = '?';
643                                 break;
644                         /* BB We can not handle remapping slash until
645                            all the calls to build_path_from_dentry
646                            are modified, as they use slash as separator BB */
647                         /* case UNI_SLASH:
648                                 target[j] = '\\';
649                                 break;*/
650                         case UNI_PIPE:
651                                 target[j] = '|';
652                                 break;
653                         case UNI_GRTRTHAN:
654                                 target[j] = '>';
655                                 break;
656                         case UNI_LESSTHAN:
657                                 target[j] = '<';
658                                 break;
659                         default: 
660                                 len = cp->uni2char(src_char, &target[j], 
661                                                 NLS_MAX_CHARSET_SIZE);
662                                 if(len > 0) {
663                                         j += len;
664                                         continue;
665                                 } else {
666                                         target[j] = '?';
667                                 }
668                 }
669                 j++;
670                 /* make sure we do not overrun callers allocated temp buffer */
671                 if(j >= (2 * NAME_MAX))
672                         break;
673         }
674 cUCS_out:
675         target[j] = 0;
676         return j;
677 }
678
679 /* Convert 16 bit Unicode pathname to wire format from string in current code
680    page.  Conversion may involve remapping up the seven characters that are
681    only legal in POSIX-like OS (if they are present in the string). Path
682    names are little endian 16 bit Unicode on the wire */
683 int
684 cifsConvertToUCS(__le16 * target, const char *source, int maxlen, 
685                  const struct nls_table * cp, int mapChars)
686 {
687         int i,j,charlen;
688         int len_remaining = maxlen;
689         char src_char;
690         __u16 temp;
691
692         if(!mapChars) 
693                 return cifs_strtoUCS(target, source, PATH_MAX, cp);
694
695         for(i = 0, j = 0; i < maxlen; j++) {
696                 src_char = source[i];
697                 switch (src_char) {
698                         case 0:
699                                 target[j] = 0;
700                                 goto ctoUCS_out;
701                         case ':':
702                                 target[j] = cpu_to_le16(UNI_COLON);
703                                 break;
704                         case '*':
705                                 target[j] = cpu_to_le16(UNI_ASTERIK);
706                                 break;
707                         case '?':
708                                 target[j] = cpu_to_le16(UNI_QUESTION);
709                                 break;
710                         case '<':
711                                 target[j] = cpu_to_le16(UNI_LESSTHAN);
712                                 break;
713                         case '>':
714                                 target[j] = cpu_to_le16(UNI_GRTRTHAN);
715                                 break;
716                         case '|':
717                                 target[j] = cpu_to_le16(UNI_PIPE);
718                                 break;                  
719                         /* BB We can not handle remapping slash until
720                            all the calls to build_path_from_dentry
721                            are modified, as they use slash as separator BB */
722                         /* case '\\':
723                                 target[j] = cpu_to_le16(UNI_SLASH);
724                                 break;*/
725                         default:
726                                 charlen = cp->char2uni(source+i,
727                                         len_remaining, &temp);
728                                 /* if no match, use question mark, which
729                                 at least in some cases servers as wild card */
730                                 if(charlen < 1) {
731                                         target[j] = cpu_to_le16(0x003f);
732                                         charlen = 1;
733                                 } else
734                                         target[j] = cpu_to_le16(temp);
735                                 len_remaining -= charlen;
736                                 /* character may take more than one byte in the
737                                    the source string, but will take exactly two
738                                    bytes in the target string */
739                                 i+= charlen;
740                                 continue;
741                 }
742                 i++; /* move to next char in source string */
743                 len_remaining--;
744         }
745
746 ctoUCS_out:
747         return i;
748 }