fs/cifs/misc.c

   1 /*
   2  *   fs/cifs/misc.c
   3  *
   4  *   Copyright (C) International Business Machines  Corp., 2002,2004
   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 *) kmalloc(sizeof (struct cifsSesInfo),
  76                                            GFP_KERNEL);
  77         if (ret_buf) {
  78                 memset(ret_buf, 0, sizeof (struct cifsSesInfo));
  79                 write_lock(&GlobalSMBSeslock);
  80                 atomic_inc(&sesInfoAllocCount);
  81                 ret_buf->status = CifsNew;
  82                 list_add(&ret_buf->cifsSessionList, &GlobalSMBSessionList);
  83                 init_MUTEX(&ret_buf->sesSem);
  84                 write_unlock(&GlobalSMBSeslock);
  85         }
  86         return ret_buf;
  87 }
  88
  89 void
  90 sesInfoFree(struct cifsSesInfo *buf_to_free)
  91 {
  92         if (buf_to_free == NULL) {
  93                 cFYI(1, ("Null buffer passed to sesInfoFree"));
  94                 return;
  95         }
  96
  97         write_lock(&GlobalSMBSeslock);
  98         atomic_dec(&sesInfoAllocCount);
  99         list_del(&buf_to_free->cifsSessionList);
 100         write_unlock(&GlobalSMBSeslock);
 101         if (buf_to_free->serverOS)
 102                 kfree(buf_to_free->serverOS);
 103         if (buf_to_free->serverDomain)
 104                 kfree(buf_to_free->serverDomain);
 105         if (buf_to_free->serverNOS)
 106                 kfree(buf_to_free->serverNOS);
 107         if (buf_to_free->password)
 108                 kfree(buf_to_free->password);
 109         kfree(buf_to_free);
 110 }
 111
 112 struct cifsTconInfo *
 113 tconInfoAlloc(void)
 114 {
 115         struct cifsTconInfo *ret_buf;
 116         ret_buf =
 117             (struct cifsTconInfo *) kmalloc(sizeof (struct cifsTconInfo),
 118                                             GFP_KERNEL);
 119         if (ret_buf) {
 120                 memset(ret_buf, 0, sizeof (struct cifsTconInfo));
 121                 write_lock(&GlobalSMBSeslock);
 122                 atomic_inc(&tconInfoAllocCount);
 123                 list_add(&ret_buf->cifsConnectionList,
 124                          &GlobalTreeConnectionList);
 125                 ret_buf->tidStatus = CifsNew;
 126                 INIT_LIST_HEAD(&ret_buf->openFileList);
 127                 init_MUTEX(&ret_buf->tconSem);
 128 #ifdef CONFIG_CIFS_STATS
 129                 spin_lock_init(&ret_buf->stat_lock);
 130 #endif
 131                 write_unlock(&GlobalSMBSeslock);
 132         }
 133         return ret_buf;
 134 }
 135
 136 void
 137 tconInfoFree(struct cifsTconInfo *buf_to_free)
 138 {
 139         if (buf_to_free == NULL) {
 140                 cFYI(1, ("Null buffer passed to tconInfoFree"));
 141                 return;
 142         }
 143         write_lock(&GlobalSMBSeslock);
 144         atomic_dec(&tconInfoAllocCount);
 145         list_del(&buf_to_free->cifsConnectionList);
 146         write_unlock(&GlobalSMBSeslock);
 147         if (buf_to_free->nativeFileSystem)
 148                 kfree(buf_to_free->nativeFileSystem);
 149         kfree(buf_to_free);
 150 }
 151
 152 struct smb_hdr *
 153 cifs_buf_get(void)
 154 {
 155         struct smb_hdr *ret_buf = NULL;
 156
 157 /* We could use negotiated size instead of max_msgsize -
 158    but it may be more efficient to always alloc same size
 159    albeit slightly larger than necessary and maxbuffersize
 160    defaults to this and can not be bigger */
 161         ret_buf =
 162             (struct smb_hdr *) mempool_alloc(cifs_req_poolp, SLAB_KERNEL | SLAB_NOFS);
 163
 164         /* clear the first few header bytes */
 165         /* for most paths, more is cleared in header_assemble */
 166         if (ret_buf) {
 167                 memset(ret_buf, 0, sizeof(struct smb_hdr) + 3);
 168                 atomic_inc(&bufAllocCount);
 169         }
 170
 171         return ret_buf;
 172 }
 173
 174 void
 175 cifs_buf_release(void *buf_to_free)
 176 {
 177
 178         if (buf_to_free == NULL) {
 179                 /* cFYI(1, ("Null buffer passed to cifs_buf_release"));*/
 180                 return;
 181         }
 182         mempool_free(buf_to_free,cifs_req_poolp);
 183
 184         atomic_dec(&bufAllocCount);
 185         return;
 186 }
 187
 188 struct smb_hdr *
 189 cifs_small_buf_get(void)
 190 {
 191         struct smb_hdr *ret_buf = NULL;
 192
 193 /* We could use negotiated size instead of max_msgsize -
 194    but it may be more efficient to always alloc same size
 195    albeit slightly larger than necessary and maxbuffersize
 196    defaults to this and can not be bigger */
 197         ret_buf =
 198             (struct smb_hdr *) mempool_alloc(cifs_sm_req_poolp, SLAB_KERNEL | SLAB_NOFS);
 199         if (ret_buf) {
 200         /* No need to clear memory here, cleared in header assemble */
 201         /*      memset(ret_buf, 0, sizeof(struct smb_hdr) + 27);*/
 202                 atomic_inc(&smBufAllocCount);
 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,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->uid != treeCon->ses->linux_uid) {
 357                                         cFYI(1,("Multiuser mode and UID did not match tcon uid "));
 358                                         read_lock(&GlobalSMBSeslock);
 359                                         list_for_each(temp_item, &GlobalSMBSessionList) {
 360                                                 ses = list_entry(temp_item, struct cifsSesInfo, cifsSessionList);
 361                                                 if(ses->linux_uid == current->uid) {
 362                                                         if(ses->server == treeCon->ses->server) {
 363                                                                 cFYI(1,("found matching uid substitute right smb_uid"));
 364                                                                 buffer->Uid = ses->Suid;
 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         cFYI(0,
 424              ("Entering checkSMB with Length: %x, smb_buf_length: %x ",
 425               length, len));
 426         if (((unsigned int)length < 2 + sizeof (struct smb_hdr)) ||
 427             (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)) {
 428                 if ((unsigned int)length < 2 + sizeof (struct smb_hdr)) {
 429                         if (((unsigned int)length >=
 430                                 sizeof (struct smb_hdr) - 1)
 431                             && (smb->Status.CifsError != 0)) {
 432                                 smb->WordCount = 0;
 433                                 return 0;       /* some error cases do not return wct and bcc */
 434                         } else {
 435                                 cERROR(1, ("Length less than smb header size"));
 436                         }
 437
 438                 }
 439                 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4)
 440                         cERROR(1,
 441                                ("smb_buf_length greater than MaxBufSize"));
 442                 cERROR(1,
 443                        ("bad smb detected. Illegal length. The mid=%d",
 444                         smb->Mid));
 445                 return 1;
 446         }
 447
 448         if (checkSMBhdr(smb, mid))
 449                 return 1;
 450
 451         if ((4 + len != smbCalcSize_LE(smb))
 452             || (4 + len != (unsigned int)length)) {
 453                 cERROR(1, ("smbCalcSize %x ", smbCalcSize_LE(smb)));
 454                 cERROR(1,
 455                        ("bad smb size detected. The Mid=%d", smb->Mid));
 456                 return 1;
 457         }
 458         return 0;
 459 }
 460 int
 461 is_valid_oplock_break(struct smb_hdr *buf)
 462 {
 463         struct smb_com_lock_req * pSMB = (struct smb_com_lock_req *)buf;
 464         struct list_head *tmp;
 465         struct list_head *tmp1;
 466         struct cifsTconInfo *tcon;
 467         struct cifsFileInfo *netfile;
 468
 469         cFYI(1,("Checking for oplock break or dnotify response"));
 470         if((pSMB->hdr.Command == SMB_COM_NT_TRANSACT) &&
 471            (pSMB->hdr.Flags & SMBFLG_RESPONSE)) {
 472                 struct smb_com_transaction_change_notify_rsp * pSMBr =
 473                         (struct smb_com_transaction_change_notify_rsp *)buf;
 474                 struct file_notify_information * pnotify;
 475                 __u32 data_offset = 0;
 476                 if(pSMBr->ByteCount > sizeof(struct file_notify_information)) {
 477                         data_offset = le32_to_cpu(pSMBr->DataOffset);
 478
 479                         pnotify = (struct file_notify_information *)((char *)&pSMBr->hdr.Protocol
 480                                 + data_offset);
 481                         cFYI(1,("dnotify on %s with action: 0x%x",pnotify->FileName,
 482                                 pnotify->Action));  /* BB removeme BB */
 483                      /*   cifs_dump_mem("Received notify Data is: ",buf,sizeof(struct smb_hdr)+60); */
 484                         return TRUE;
 485                 }
 486                 if(pSMBr->hdr.Status.CifsError) {
 487                         cFYI(1,("notify err 0x%d",pSMBr->hdr.Status.CifsError));
 488                         return TRUE;
 489                 }
 490                 return FALSE;
 491         }
 492         if(pSMB->hdr.Command != SMB_COM_LOCKING_ANDX)
 493                 return FALSE;
 494         if(pSMB->hdr.Flags & SMBFLG_RESPONSE) {
 495                 /* no sense logging error on invalid handle on oplock
 496                    break - harmless race between close request and oplock
 497                    break response is expected from time to time writing out
 498                    large dirty files cached on the client */
 499                 if ((NT_STATUS_INVALID_HANDLE) ==
 500                    le32_to_cpu(pSMB->hdr.Status.CifsError)) {
 501                         cFYI(1,("invalid handle on oplock break"));
 502                         return TRUE;
 503                 } else if (ERRbadfid ==
 504                    le16_to_cpu(pSMB->hdr.Status.DosError.Error)) {
 505                         return TRUE;
 506                 } else {
 507                         return FALSE; /* on valid oplock brk we get "request" */
 508                 }
 509         }
 510         if(pSMB->hdr.WordCount != 8)
 511                 return FALSE;
 512
 513         cFYI(1,(" oplock type 0x%d level 0x%d",pSMB->LockType,pSMB->OplockLevel));
 514         if(!(pSMB->LockType & LOCKING_ANDX_OPLOCK_RELEASE))
 515                 return FALSE;
 516
 517         /* look up tcon based on tid & uid */
 518         read_lock(&GlobalSMBSeslock);
 519         list_for_each(tmp, &GlobalTreeConnectionList) {
 520                 tcon = list_entry(tmp, struct cifsTconInfo, cifsConnectionList);
 521                 if (tcon->tid == buf->Tid) {
 522                         cifs_stats_inc(&tcon->num_oplock_brks);
 523                         list_for_each(tmp1,&tcon->openFileList){
 524                                 netfile = list_entry(tmp1,struct cifsFileInfo,
 525                                                      tlist);
 526                                 if(pSMB->Fid == netfile->netfid) {
 527                                         struct cifsInodeInfo *pCifsInode;
 528                                         read_unlock(&GlobalSMBSeslock);
 529                                         cFYI(1,("file id match, oplock break"));
 530                                         pCifsInode =
 531                                                 CIFS_I(netfile->pInode);
 532                                         pCifsInode->clientCanCacheAll = FALSE;
 533                                         if(pSMB->OplockLevel == 0)
 534                                                 pCifsInode->clientCanCacheRead
 535                                                         = FALSE;
 536                                         pCifsInode->oplockPending = TRUE;
 537                                         AllocOplockQEntry(netfile->pInode,
 538                                                           netfile->netfid,
 539                                                           tcon);
 540                                         cFYI(1,("about to wake up oplock thd"));
 541                                         if(oplockThread)
 542                                             wake_up_process(oplockThread);
 543                                         return TRUE;
 544                                 }
 545                         }
 546                         read_unlock(&GlobalSMBSeslock);
 547                         cFYI(1,("No matching file for oplock break"));
 548                         return TRUE;
 549                 }
 550         }
 551         read_unlock(&GlobalSMBSeslock);
 552         cFYI(1,("Can not process oplock break for non-existent connection"));
 553         return TRUE;
 554 }
 555
 556 void
 557 dump_smb(struct smb_hdr *smb_buf, int smb_buf_length)
 558 {
 559         int i, j;
 560         char debug_line[17];
 561         unsigned char *buffer;
 562
 563         if (traceSMB == 0)
 564                 return;
 565
 566         buffer = (unsigned char *) smb_buf;
 567         for (i = 0, j = 0; i < smb_buf_length; i++, j++) {
 568                 if (i % 8 == 0) {       /* have reached the beginning of line */
 569                         printk(KERN_DEBUG "| ");
 570                         j = 0;
 571                 }
 572                 printk("%0#4x ", buffer[i]);
 573                 debug_line[2 * j] = ' ';
 574                 if (isprint(buffer[i]))
 575                         debug_line[1 + (2 * j)] = buffer[i];
 576                 else
 577                         debug_line[1 + (2 * j)] = '_';
 578
 579                 if (i % 8 == 7) { /* reached end of line, time to print ascii */
 580                         debug_line[16] = 0;
 581                         printk(" | %s\n", debug_line);
 582                 }
 583         }
 584         for (; j < 8; j++) {
 585                 printk("     ");
 586                 debug_line[2 * j] = ' ';
 587                 debug_line[1 + (2 * j)] = ' ';
 588         }
 589         printk( " | %s\n", debug_line);
 590         return;
 591 }
 592
 593 /* Windows maps these to the user defined 16 bit Unicode range since they are
 594    reserved symbols (along with \ and /), otherwise illegal to store
 595    in filenames in NTFS */
 596 #define UNI_ASTERIK     (__u16) ('*' + 0xF000)
 597 #define UNI_QUESTION    (__u16) ('?' + 0xF000)
 598 #define UNI_COLON       (__u16) (':' + 0xF000)
 599 #define UNI_GRTRTHAN    (__u16) ('>' + 0xF000)
 600 #define UNI_LESSTHAN    (__u16) ('<' + 0xF000)
 601 #define UNI_PIPE        (__u16) ('|' + 0xF000)
 602 #define UNI_SLASH       (__u16) ('\\' + 0xF000)
 603
 604 /* Convert 16 bit Unicode pathname from wire format to string in current code
 605    page.  Conversion may involve remapping up the seven characters that are
 606    only legal in POSIX-like OS (if they are present in the string). Path
 607    names are little endian 16 bit Unicode on the wire */
 608 int
 609 cifs_convertUCSpath(char *target, const __le16 * source, int maxlen,
 610                     const struct nls_table * cp)
 611 {
 612         int i,j,len;
 613         __u16 src_char;
 614
 615         for(i = 0, j = 0; i < maxlen; i++) {
 616                 src_char = le16_to_cpu(source[i]);
 617                 switch (src_char) {
 618                         case 0:
 619                                 goto cUCS_out; /* BB check this BB */
 620                         case UNI_COLON:
 621                                 target[j] = ':';
 622                                 break;
 623                         case UNI_ASTERIK:
 624                                 target[j] = '*';
 625                                 break;
 626                         case UNI_QUESTION:
 627                                 target[j] = '?';
 628                                 break;
 629                         /* BB We can not handle remapping slash until
 630                            all the calls to build_path_from_dentry
 631                            are modified, as they use slash as separator BB */
 632                         /* case UNI_SLASH:
 633                                 target[j] = '\\';
 634                                 break;*/
 635                         case UNI_PIPE:
 636                                 target[j] = '|';
 637                                 break;
 638                         case UNI_GRTRTHAN:
 639                                 target[j] = '>';
 640                                 break;
 641                         case UNI_LESSTHAN:
 642                                 target[j] = '<';
 643                                 break;
 644                         default:
 645                                 len = cp->uni2char(src_char, &target[j],
 646                                                 NLS_MAX_CHARSET_SIZE);
 647                                 if(len > 0) {
 648                                         j += len;
 649                                         continue;
 650                                 } else {
 651                                         target[j] = '?';
 652                                 }
 653                 }
 654                 j++;
 655                 /* make sure we do not overrun callers allocated temp buffer */
 656                 if(j >= (2 * NAME_MAX))
 657                         break;
 658         }
 659 cUCS_out:
 660         target[j] = 0;
 661         return j;
 662 }
 663
 664 /* Convert 16 bit Unicode pathname to wire format from string in current code
 665    page.  Conversion may involve remapping up the seven characters that are
 666    only legal in POSIX-like OS (if they are present in the string). Path
 667    names are little endian 16 bit Unicode on the wire */
 668 int
 669 cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
 670                  const struct nls_table * cp, int mapChars)
 671 {
 672         int i,j,charlen;
 673         int len_remaining = maxlen;
 674         char src_char;
 675         __u16 temp;
 676
 677         if(!mapChars)
 678                 return cifs_strtoUCS((wchar_t *) target, source, PATH_MAX, cp);
 679
 680         for(i = 0, j = 0; i < maxlen; j++) {
 681                 src_char = source[i];
 682                 switch (src_char) {
 683                         case 0:
 684                                 target[j] = 0;
 685                                 goto ctoUCS_out;
 686                         case ':':
 687                                 target[j] = cpu_to_le16(UNI_COLON);
 688                                 break;
 689                         case '*':
 690                                 target[j] = cpu_to_le16(UNI_ASTERIK);
 691                                 break;
 692                         case '?':
 693                                 target[j] = cpu_to_le16(UNI_QUESTION);
 694                                 break;
 695                         case '<':
 696                                 target[j] = cpu_to_le16(UNI_LESSTHAN);
 697                                 break;
 698                         case '>':
 699                                 target[j] = cpu_to_le16(UNI_GRTRTHAN);
 700                                 break;
 701                         case '|':
 702                                 target[j] = cpu_to_le16(UNI_PIPE);
 703                                 break;
 704                         /* BB We can not handle remapping slash until
 705                            all the calls to build_path_from_dentry
 706                            are modified, as they use slash as separator BB */
 707                         /* case '\\':
 708                                 target[j] = cpu_to_le16(UNI_SLASH);
 709                                 break;*/
 710                         default:
 711                                 charlen = cp->char2uni(source+i,
 712                                         len_remaining, &temp);
 713                                 /* if no match, use question mark, which
 714                                 at least in some cases servers as wild card */
 715                                 if(charlen < 1) {
 716                                         target[j] = cpu_to_le16(0x003f);
 717                                         charlen = 1;
 718                                 } else
 719                                         target[j] = cpu_to_le16(temp);
 720                                 len_remaining -= charlen;
 721                                 /* character may take more than one byte in the
 722                                    the source string, but will take exactly two
 723                                    bytes in the target string */
 724                                 i+= charlen;
 725                                 continue;
 726                 }
 727                 i++; /* move to next char in source string */
 728                 len_remaining--;
 729         }
 730
 731 ctoUCS_out:
 732         return i;
 733 }