2 * fs/cifs/cifs_unicode.c
4 * Copyright (c) International Business Machines Corp., 2000,2009
5 * Modified by Steve French (sfrench@us.ibm.com)
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program 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 General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/slab.h>
23 #include "cifs_fs_sb.h"
24 #include "cifs_unicode.h"
25 #include "cifs_uniupr.h"
28 #include "cifs_debug.h"
30 int cifs_remap(struct cifs_sb_info
*cifs_sb
)
34 if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_MAP_SFM_CHR
)
35 map_type
= SFM_MAP_UNI_RSVD
;
36 else if (cifs_sb
->mnt_cifs_flags
& CIFS_MOUNT_MAP_SPECIAL_CHR
)
37 map_type
= SFU_MAP_UNI_RSVD
;
39 map_type
= NO_MAP_UNI_RSVD
;
44 /* Convert character using the SFU - "Services for Unix" remapping range */
46 convert_sfu_char(const __u16 src_char
, char *target
)
49 * BB: Cannot handle remapping UNI_SLASH until all the calls to
50 * build_path_from_dentry are modified, as they use slash as
78 /* Convert character using the SFM - "Services for Mac" remapping range */
80 convert_sfm_char(const __u16 src_char
, char *target
)
112 * cifs_mapchar - convert a host-endian char to proper char in codepage
113 * @target - where converted character should be copied
114 * @src_char - 2 byte host-endian source character
115 * @cp - codepage to which character should be converted
116 * @map_type - How should the 7 NTFS/SMB reserved characters be mapped to UCS2?
118 * This function handles the conversion of a single character. It is the
119 * responsibility of the caller to ensure that the target buffer is large
120 * enough to hold the result of the conversion (at least NLS_MAX_CHARSET_SIZE).
123 cifs_mapchar(char *target
, const __u16
*from
, const struct nls_table
*cp
,
131 if ((maptype
== SFM_MAP_UNI_RSVD
) && convert_sfm_char(src_char
, target
))
133 else if ((maptype
== SFU_MAP_UNI_RSVD
) &&
134 convert_sfu_char(src_char
, target
))
137 /* if character not one of seven in special remap set */
138 len
= cp
->uni2char(src_char
, target
, NLS_MAX_CHARSET_SIZE
);
145 /* convert SURROGATE_PAIR and IVS */
146 if (strcmp(cp
->charset
, "utf8"))
148 len
= utf16s_to_utf8s(from
, 3, UTF16_LITTLE_ENDIAN
, target
, 6);
160 * cifs_from_utf16 - convert utf16le string to local charset
161 * @to - destination buffer
162 * @from - source buffer
163 * @tolen - destination buffer size (in bytes)
164 * @fromlen - source buffer size (in bytes)
165 * @codepage - codepage to which characters should be converted
166 * @mapchar - should characters be remapped according to the mapchars option?
168 * Convert a little-endian utf16le string (as sent by the server) to a string
169 * in the provided codepage. The tolen and fromlen parameters are to ensure
170 * that the code doesn't walk off of the end of the buffer (which is always
171 * a danger if the alignment of the source buffer is off). The destination
172 * string is always properly null terminated and fits in the destination
173 * buffer. Returns the length of the destination string in bytes (including
176 * Note that some windows versions actually send multiword UTF-16 characters
177 * instead of straight UTF16-2. The linux nls routines however aren't able to
178 * deal with those characters properly. In the event that we get some of
179 * those characters, they won't be translated properly.
182 cifs_from_utf16(char *to
, const __le16
*from
, int tolen
, int fromlen
,
183 const struct nls_table
*codepage
, int map_type
)
185 int i
, charlen
, safelen
;
187 int nullsize
= nls_nullsize(codepage
);
188 int fromwords
= fromlen
/ 2;
189 char tmp
[NLS_MAX_CHARSET_SIZE
];
190 __u16 ftmp
[3]; /* ftmp[3] = 3array x 2bytes = 6bytes UTF-16 */
193 * because the chars can be of varying widths, we need to take care
194 * not to overflow the destination buffer when we get close to the
195 * end of it. Until we get to this offset, we don't need to check
196 * for overflow however.
198 safelen
= tolen
- (NLS_MAX_CHARSET_SIZE
+ nullsize
);
200 for (i
= 0; i
< fromwords
; i
++) {
201 ftmp
[0] = get_unaligned_le16(&from
[i
]);
204 if (i
+ 1 < fromwords
)
205 ftmp
[1] = get_unaligned_le16(&from
[i
+ 1]);
208 if (i
+ 2 < fromwords
)
209 ftmp
[2] = get_unaligned_le16(&from
[i
+ 2]);
214 * check to see if converting this character might make the
215 * conversion bleed into the null terminator
217 if (outlen
>= safelen
) {
218 charlen
= cifs_mapchar(tmp
, ftmp
, codepage
, map_type
);
219 if ((outlen
+ charlen
) > (tolen
- nullsize
))
223 /* put converted char into 'to' buffer */
224 charlen
= cifs_mapchar(&to
[outlen
], ftmp
, codepage
, map_type
);
227 /* charlen (=bytes of UTF-8 for 1 character)
228 * 4bytes UTF-8(surrogate pair) is charlen=4
229 * (4bytes UTF-16 code)
230 * 7-8bytes UTF-8(IVS) is charlen=3+4 or 4+4
231 * (2 UTF-8 pairs divided to 2 UTF-16 pairs) */
234 else if (charlen
>= 5)
239 /* properly null-terminate string */
240 for (i
= 0; i
< nullsize
; i
++)
247 * NAME: cifs_strtoUTF16()
249 * FUNCTION: Convert character string to unicode string
253 cifs_strtoUTF16(__le16
*to
, const char *from
, int len
,
254 const struct nls_table
*codepage
)
258 wchar_t wchar_to
; /* needed to quiet sparse */
260 /* special case for utf8 to handle no plane0 chars */
261 if (!strcmp(codepage
->charset
, "utf8")) {
263 * convert utf8 -> utf16, we assume we have enough space
264 * as caller should have assumed conversion does not overflow
265 * in destination len is length in wchar_t units (16bits)
267 i
= utf8s_to_utf16s(from
, len
, UTF16_LITTLE_ENDIAN
,
268 (wchar_t *) to
, len
);
270 /* if success terminate and exit */
274 * if fails fall back to UCS encoding as this
275 * function should not return negative values
276 * currently can fail only if source contains
277 * invalid encoded characters
281 for (i
= 0; len
&& *from
; i
++, from
+= charlen
, len
-= charlen
) {
282 charlen
= codepage
->char2uni(from
, len
, &wchar_to
);
284 cifs_dbg(VFS
, "strtoUTF16: char2uni of 0x%x returned %d\n",
286 /* A question mark */
290 put_unaligned_le16(wchar_to
, &to
[i
]);
294 put_unaligned_le16(0, &to
[i
]);
299 * cifs_utf16_bytes - how long will a string be after conversion?
300 * @utf16 - pointer to input string
301 * @maxbytes - don't go past this many bytes of input string
302 * @codepage - destination codepage
304 * Walk a utf16le string and return the number of bytes that the string will
305 * be after being converted to the given charset, not including any null
306 * termination required. Don't walk past maxbytes in the source buffer.
309 cifs_utf16_bytes(const __le16
*from
, int maxbytes
,
310 const struct nls_table
*codepage
)
313 int charlen
, outlen
= 0;
314 int maxwords
= maxbytes
/ 2;
315 char tmp
[NLS_MAX_CHARSET_SIZE
];
318 for (i
= 0; i
< maxwords
; i
++) {
319 ftmp
[0] = get_unaligned_le16(&from
[i
]);
322 if (i
+ 1 < maxwords
)
323 ftmp
[1] = get_unaligned_le16(&from
[i
+ 1]);
326 if (i
+ 2 < maxwords
)
327 ftmp
[2] = get_unaligned_le16(&from
[i
+ 2]);
331 charlen
= cifs_mapchar(tmp
, ftmp
, codepage
, NO_MAP_UNI_RSVD
);
339 * cifs_strndup_from_utf16 - copy a string from wire format to the local
341 * @src - source string
342 * @maxlen - don't walk past this many bytes in the source string
343 * @is_unicode - is this a unicode string?
344 * @codepage - destination codepage
346 * Take a string given by the server, convert it to the local codepage and
347 * put it in a new buffer. Returns a pointer to the new string or NULL on
351 cifs_strndup_from_utf16(const char *src
, const int maxlen
,
352 const bool is_unicode
, const struct nls_table
*codepage
)
358 len
= cifs_utf16_bytes((__le16
*) src
, maxlen
, codepage
);
359 len
+= nls_nullsize(codepage
);
360 dst
= kmalloc(len
, GFP_KERNEL
);
363 cifs_from_utf16(dst
, (__le16
*) src
, len
, maxlen
, codepage
,
366 len
= strnlen(src
, maxlen
);
368 dst
= kmalloc(len
, GFP_KERNEL
);
371 strlcpy(dst
, src
, len
);
377 static __le16
convert_to_sfu_char(char src_char
)
383 dest_char
= cpu_to_le16(UNI_COLON
);
386 dest_char
= cpu_to_le16(UNI_ASTERISK
);
389 dest_char
= cpu_to_le16(UNI_QUESTION
);
392 dest_char
= cpu_to_le16(UNI_LESSTHAN
);
395 dest_char
= cpu_to_le16(UNI_GRTRTHAN
);
398 dest_char
= cpu_to_le16(UNI_PIPE
);
407 static __le16
convert_to_sfm_char(char src_char
)
413 dest_char
= cpu_to_le16(SFM_COLON
);
416 dest_char
= cpu_to_le16(SFM_ASTERISK
);
419 dest_char
= cpu_to_le16(SFM_QUESTION
);
422 dest_char
= cpu_to_le16(SFM_LESSTHAN
);
425 dest_char
= cpu_to_le16(SFM_GRTRTHAN
);
428 dest_char
= cpu_to_le16(SFM_PIPE
);
438 * Convert 16 bit Unicode pathname to wire format from string in current code
439 * page. Conversion may involve remapping up the six characters that are
440 * only legal in POSIX-like OS (if they are present in the string). Path
441 * names are little endian 16 bit Unicode on the wire
444 cifsConvertToUTF16(__le16
*target
, const char *source
, int srclen
,
445 const struct nls_table
*cp
, int map_chars
)
452 wchar_t *wchar_to
; /* UTF-16 */
456 if (map_chars
== NO_MAP_UNI_RSVD
)
457 return cifs_strtoUTF16(target
, source
, PATH_MAX
, cp
);
459 wchar_to
= kzalloc(6, GFP_KERNEL
);
461 for (i
= 0; i
< srclen
; j
++) {
462 src_char
= source
[i
];
465 /* check if end of string */
469 /* see if we must remap this char */
470 if (map_chars
== SFU_MAP_UNI_RSVD
)
471 dst_char
= convert_to_sfu_char(src_char
);
472 else if (map_chars
== SFM_MAP_UNI_RSVD
)
473 dst_char
= convert_to_sfm_char(src_char
);
477 * FIXME: We can not handle remapping backslash (UNI_SLASH)
478 * until all the calls to build_path_from_dentry are modified,
479 * as they use backslash as separator.
482 charlen
= cp
->char2uni(source
+ i
, srclen
- i
, &tmp
);
483 dst_char
= cpu_to_le16(tmp
);
486 * if no match, use question mark, which at least in
487 * some cases serves as wild card
492 /* convert SURROGATE_PAIR */
493 if (strcmp(cp
->charset
, "utf8") || !wchar_to
)
495 if (*(source
+ i
) & 0x80) {
496 charlen
= utf8_to_utf32(source
+ i
, 6, &u
);
501 ret
= utf8s_to_utf16s(source
+ i
, charlen
,
508 dst_char
= cpu_to_le16(*wchar_to
);
510 /* 1-3bytes UTF-8 to 2bytes UTF-16 */
511 put_unaligned(dst_char
, &target
[j
]);
512 else if (charlen
== 4) {
513 /* 4bytes UTF-8(surrogate pair) to 4bytes UTF-16
514 * 7-8bytes UTF-8(IVS) divided to 2 UTF-16
515 * (charlen=3+4 or 4+4) */
516 put_unaligned(dst_char
, &target
[j
]);
517 dst_char
= cpu_to_le16(*(wchar_to
+ 1));
519 put_unaligned(dst_char
, &target
[j
]);
520 } else if (charlen
>= 5) {
521 /* 5-6bytes UTF-8 to 6bytes UTF-16 */
522 put_unaligned(dst_char
, &target
[j
]);
523 dst_char
= cpu_to_le16(*(wchar_to
+ 1));
525 put_unaligned(dst_char
, &target
[j
]);
526 dst_char
= cpu_to_le16(*(wchar_to
+ 2));
528 put_unaligned(dst_char
, &target
[j
]);
533 dst_char
= cpu_to_le16(0x003f);
539 * character may take more than one byte in the source string,
540 * but will take exactly two bytes in the target string
543 put_unaligned(dst_char
, &target
[j
]);
547 put_unaligned(0, &target
[j
]); /* Null terminate target unicode string */
552 #ifdef CONFIG_CIFS_SMB2
554 * cifs_local_to_utf16_bytes - how long will a string be after conversion?
555 * @from - pointer to input string
556 * @maxbytes - don't go past this many bytes of input string
557 * @codepage - source codepage
559 * Walk a string and return the number of bytes that the string will
560 * be after being converted to the given charset, not including any null
561 * termination required. Don't walk past maxbytes in the source buffer.
565 cifs_local_to_utf16_bytes(const char *from
, int len
,
566 const struct nls_table
*codepage
)
572 for (i
= 0; len
&& *from
; i
++, from
+= charlen
, len
-= charlen
) {
573 charlen
= codepage
->char2uni(from
, len
, &wchar_to
);
574 /* Failed conversion defaults to a question mark */
578 return 2 * i
; /* UTF16 characters are two bytes */
582 * cifs_strndup_to_utf16 - copy a string to wire format from the local codepage
583 * @src - source string
584 * @maxlen - don't walk past this many bytes in the source string
585 * @utf16_len - the length of the allocated string in bytes (including null)
586 * @cp - source codepage
587 * @remap - map special chars
589 * Take a string convert it from the local codepage to UTF16 and
590 * put it in a new buffer. Returns a pointer to the new string or NULL on
594 cifs_strndup_to_utf16(const char *src
, const int maxlen
, int *utf16_len
,
595 const struct nls_table
*cp
, int remap
)
600 len
= cifs_local_to_utf16_bytes(src
, maxlen
, cp
);
602 dst
= kmalloc(len
, GFP_KERNEL
);
607 cifsConvertToUTF16(dst
, src
, strlen(src
), cp
, remap
);
611 #endif /* CONFIG_CIFS_SMB2 */