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