]> git.ipfire.org Git - thirdparty/glibc.git/blame - iconv/loop.c
Remove NOT_IN_libc
[thirdparty/glibc.git] / iconv / loop.c
CommitLineData
8619129f 1/* Conversion loop frame work.
d4697bc9 2 Copyright (C) 1998-2014 Free Software Foundation, Inc.
8619129f
UD
3 This file is part of the GNU C Library.
4 Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
5
6 The GNU C Library is free software; you can redistribute it and/or
41bdb6e2
AJ
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
8619129f
UD
10
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2 14 Lesser General Public License for more details.
8619129f 15
41bdb6e2 16 You should have received a copy of the GNU Lesser General Public
59ba27a6
PE
17 License along with the GNU C Library; if not, see
18 <http://www.gnu.org/licenses/>. */
8619129f
UD
19
20/* This file provides a frame for the reader loop in all conversion modules.
21 The actual code must (of course) be provided in the actual module source
22 code but certain actions can be written down generically, with some
23 customization options which are these:
24
25 MIN_NEEDED_INPUT minimal number of input bytes needed for the next
26 conversion.
27 MIN_NEEDED_OUTPUT minimal number of bytes produced by the next round
28 of conversion.
29
30 MAX_NEEDED_INPUT you guess it, this is the maximal number of input
31 bytes needed. It defaults to MIN_NEEDED_INPUT
32 MAX_NEEDED_OUTPUT likewise for output bytes.
33
8619129f
UD
34 LOOPFCT name of the function created. If not specified
35 the name is `loop' but this prevents the use
36 of multiple functions in the same file.
37
8619129f
UD
38 BODY this is supposed to expand to the body of the loop.
39 The user must provide this.
28f1c862 40
382466e0 41 EXTRA_LOOP_DECLS extra arguments passed from conversion loop call.
66175fa8
UD
42
43 INIT_PARAMS code to define and initialize variables from params.
44 UPDATE_PARAMS code to store result in params.
f9ad060c
UD
45
46 ONEBYTE_BODY body of the specialized conversion function for a
47 single byte from the current character set to INTERNAL.
8619129f
UD
48*/
49
fd1b5c0f 50#include <assert.h>
b35e58e4 51#include <endian.h>
8619129f 52#include <gconv.h>
b35e58e4
UD
53#include <stdint.h>
54#include <string.h>
d64b6ad0 55#include <wchar.h>
8619129f
UD
56#include <sys/param.h> /* For MIN. */
57#define __need_size_t
58#include <stddef.h>
59
60
b35e58e4
UD
61/* We have to provide support for machines which are not able to handled
62 unaligned memory accesses. Some of the character encodings have
63 representations with a fixed width of 2 or 4 bytes. But if we cannot
64 access unaligned memory we still have to read byte-wise. */
65#undef FCTNAME2
27822ce6 66#if _STRING_ARCH_unaligned || !defined DEFINE_UNALIGNED
b35e58e4 67/* We can handle unaligned memory access. */
a784e502
UD
68# define get16(addr) *((const uint16_t *) (addr))
69# define get32(addr) *((const uint32_t *) (addr))
b35e58e4
UD
70
71/* We need no special support for writing values either. */
72# define put16(addr, val) *((uint16_t *) (addr)) = (val)
73# define put32(addr, val) *((uint32_t *) (addr)) = (val)
74
75# define FCTNAME2(name) name
76#else
77/* Distinguish between big endian and little endian. */
78# if __BYTE_ORDER == __LITTLE_ENDIAN
79# define get16(addr) \
a784e502
UD
80 (((const unsigned char *) (addr))[1] << 8 \
81 | ((const unsigned char *) (addr))[0])
b35e58e4 82# define get32(addr) \
a784e502
UD
83 (((((const unsigned char *) (addr))[3] << 8 \
84 | ((const unsigned char *) (addr))[2]) << 8 \
85 | ((const unsigned char *) (addr))[1]) << 8 \
86 | ((const unsigned char *) (addr))[0])
b35e58e4 87
cb2c5501 88# define put16(addr, val) \
b35e58e4 89 ({ uint16_t __val = (val); \
cb2c5501
UD
90 ((unsigned char *) (addr))[0] = __val; \
91 ((unsigned char *) (addr))[1] = __val >> 8; \
b35e58e4 92 (void) 0; })
cb2c5501
UD
93# define put32(addr, val) \
94 ({ uint32_t __val = (val); \
95 ((unsigned char *) (addr))[0] = __val; \
b35e58e4 96 __val >>= 8; \
cb2c5501 97 ((unsigned char *) (addr))[1] = __val; \
b35e58e4 98 __val >>= 8; \
cb2c5501 99 ((unsigned char *) (addr))[2] = __val; \
b35e58e4 100 __val >>= 8; \
cb2c5501 101 ((unsigned char *) (addr))[3] = __val; \
b35e58e4
UD
102 (void) 0; })
103# else
104# define get16(addr) \
a784e502
UD
105 (((const unsigned char *) (addr))[0] << 8 \
106 | ((const unsigned char *) (addr))[1])
b35e58e4 107# define get32(addr) \
a784e502
UD
108 (((((const unsigned char *) (addr))[0] << 8 \
109 | ((const unsigned char *) (addr))[1]) << 8 \
110 | ((const unsigned char *) (addr))[2]) << 8 \
111 | ((const unsigned char *) (addr))[3])
b35e58e4 112
cb2c5501 113# define put16(addr, val) \
b35e58e4 114 ({ uint16_t __val = (val); \
cb2c5501 115 ((unsigned char *) (addr))[1] = __val; \
f7ccf2fc 116 ((unsigned char *) (addr))[0] = __val >> 8; \
b35e58e4 117 (void) 0; })
cb2c5501
UD
118# define put32(addr, val) \
119 ({ uint32_t __val = (val); \
120 ((unsigned char *) (addr))[3] = __val; \
b35e58e4 121 __val >>= 8; \
cb2c5501 122 ((unsigned char *) (addr))[2] = __val; \
b35e58e4 123 __val >>= 8; \
cb2c5501 124 ((unsigned char *) (addr))[1] = __val; \
b35e58e4 125 __val >>= 8; \
cb2c5501 126 ((unsigned char *) (addr))[0] = __val; \
b35e58e4
UD
127 (void) 0; })
128# endif
129
130# define FCTNAME2(name) name##_unaligned
131#endif
132#define FCTNAME(name) FCTNAME2(name)
133
134
8619129f
UD
135/* We need at least one byte for the next round. */
136#ifndef MIN_NEEDED_INPUT
5aa8ff62 137# error "MIN_NEEDED_INPUT definition missing"
4a0de63b
UD
138#elif MIN_NEEDED_INPUT < 1
139# error "MIN_NEEDED_INPUT must be >= 1"
8619129f
UD
140#endif
141
142/* Let's see how many bytes we produce. */
143#ifndef MAX_NEEDED_INPUT
144# define MAX_NEEDED_INPUT MIN_NEEDED_INPUT
145#endif
146
147/* We produce at least one byte in the next round. */
148#ifndef MIN_NEEDED_OUTPUT
5aa8ff62 149# error "MIN_NEEDED_OUTPUT definition missing"
c0a0f9a3
UD
150#elif MIN_NEEDED_OUTPUT < 1
151# error "MIN_NEEDED_OUTPUT must be >= 1"
8619129f
UD
152#endif
153
154/* Let's see how many bytes we produce. */
155#ifndef MAX_NEEDED_OUTPUT
156# define MAX_NEEDED_OUTPUT MIN_NEEDED_OUTPUT
157#endif
158
159/* Default name for the function. */
160#ifndef LOOPFCT
161# define LOOPFCT loop
162#endif
163
164/* Make sure we have a loop body. */
165#ifndef BODY
166# error "Definition of BODY missing for function" LOOPFCT
167#endif
168
8619129f 169
28f1c862
UD
170/* If no arguments have to passed to the loop function define the macro
171 as empty. */
172#ifndef EXTRA_LOOP_DECLS
173# define EXTRA_LOOP_DECLS
174#endif
175
4b1b449d
UD
176/* Allow using UPDATE_PARAMS in macros where #ifdef UPDATE_PARAMS test
177 isn't possible. */
178#ifndef UPDATE_PARAMS
179# define UPDATE_PARAMS do { } while (0)
180#endif
181#ifndef REINIT_PARAMS
182# define REINIT_PARAMS do { } while (0)
183#endif
184
28f1c862 185
85830c4c
UD
186/* To make it easier for the writers of the modules, we define a macro
187 to test whether we have to ignore errors. */
b572c2da
UD
188#define ignore_errors_p() \
189 (irreversible != NULL && (flags & __GCONV_IGNORE_ERRORS))
85830c4c
UD
190
191
e438a468
UD
192/* Error handling for the FROM_LOOP direction, with ignoring of errors.
193 Note that we cannot use the do while (0) trick since `break' and
194 `continue' must reach certain points. */
195#define STANDARD_FROM_LOOP_ERR_HANDLER(Incr) \
196 { \
197 result = __GCONV_ILLEGAL_INPUT; \
198 \
199 if (! ignore_errors_p ()) \
200 break; \
201 \
202 /* We ignore the invalid input byte sequence. */ \
203 inptr += (Incr); \
204 ++*irreversible; \
205 /* But we keep result == __GCONV_ILLEGAL_INPUT, because of the constraint \
206 that "iconv -c" must give the same exitcode as "iconv". */ \
207 continue; \
208 }
209
210/* Error handling for the TO_LOOP direction, with use of transliteration/
211 transcription functions and ignoring of errors. Note that we cannot use
212 the do while (0) trick since `break' and `continue' must reach certain
213 points. */
214#define STANDARD_TO_LOOP_ERR_HANDLER(Incr) \
d6204268 215 { \
d6204268 216 result = __GCONV_ILLEGAL_INPUT; \
b572c2da
UD
217 \
218 if (irreversible == NULL) \
219 /* This means we are in call from __gconv_transliterate. In this \
220 case we are not doing any error recovery outself. */ \
221 break; \
222 \
4b1b449d
UD
223 /* If needed, flush any conversion state, so that __gconv_transliterate \
224 starts with current shift state. */ \
225 UPDATE_PARAMS; \
226 \
d6204268 227 /* First try the transliteration methods. */ \
ba7b4d29
FW
228 if ((step_data->__flags & __GCONV_TRANSLIT) != 0) \
229 result = __gconv_transliterate \
230 (step, step_data, *inptrp, \
231 &inptr, inend, &outptr, irreversible); \
4b1b449d
UD
232 \
233 REINIT_PARAMS; \
234 \
7888313d 235 /* If any of them recognized the input continue with the loop. */ \
d6204268 236 if (result != __GCONV_ILLEGAL_INPUT) \
f2a8406a 237 { \
a1ffb40e 238 if (__glibc_unlikely (result == __GCONV_FULL_OUTPUT)) \
f2a8406a
UD
239 break; \
240 \
241 continue; \
242 } \
d6204268
UD
243 \
244 /* Next see whether we have to ignore the error. If not, stop. */ \
245 if (! ignore_errors_p ()) \
246 break; \
b572c2da 247 \
d6204268
UD
248 /* When we come here it means we ignore the character. */ \
249 ++*irreversible; \
250 inptr += Incr; \
e438a468
UD
251 /* But we keep result == __GCONV_ILLEGAL_INPUT, because of the constraint \
252 that "iconv -c" must give the same exitcode as "iconv". */ \
d6204268
UD
253 continue; \
254 }
255
256
9a1f6754
UD
257/* Handling of Unicode 3.1 TAG characters. Unicode recommends
258 "If language codes are not relevant to the particular processing
e438a468
UD
259 operation, then they should be ignored." This macro is usually
260 called right before STANDARD_TO_LOOP_ERR_HANDLER (Incr). */
9a1f6754
UD
261#define UNICODE_TAG_HANDLER(Character, Incr) \
262 { \
263 /* TAG characters are those in the range U+E0000..U+E007F. */ \
264 if (((Character) >> 7) == (0xe0000 >> 7)) \
265 { \
266 inptr += Incr; \
267 continue; \
268 } \
269 }
270
271
8619129f
UD
272/* The function returns the status, as defined in gconv.h. */
273static inline int
dd9423a6 274__attribute ((always_inline))
55985355
UD
275FCTNAME (LOOPFCT) (struct __gconv_step *step,
276 struct __gconv_step_data *step_data,
277 const unsigned char **inptrp, const unsigned char *inend,
17427edd 278 unsigned char **outptrp, const unsigned char *outend,
38677ace 279 size_t *irreversible EXTRA_LOOP_DECLS)
8619129f 280{
55985355
UD
281#ifdef LOOP_NEED_STATE
282 mbstate_t *state = step_data->__statep;
283#endif
284#ifdef LOOP_NEED_FLAGS
285 int flags = step_data->__flags;
286#endif
287#ifdef LOOP_NEED_DATA
288 void *data = step->__data;
289#endif
290 int result = __GCONV_EMPTY_INPUT;
8619129f
UD
291 const unsigned char *inptr = *inptrp;
292 unsigned char *outptr = *outptrp;
8619129f 293
66175fa8
UD
294#ifdef INIT_PARAMS
295 INIT_PARAMS;
296#endif
297
55985355 298 while (inptr != inend)
8619129f 299 {
55985355 300 /* `if' cases for MIN_NEEDED_OUTPUT ==/!= 1 is made to help the
ca3c0135 301 compiler generating better code. They will be optimized away
55985355 302 since MIN_NEEDED_OUTPUT is always a constant. */
eb9dc2a2
UD
303 if (MIN_NEEDED_INPUT > 1
304 && __builtin_expect (inptr + MIN_NEEDED_INPUT > inend, 0))
305 {
306 /* We don't have enough input for another complete input
307 character. */
308 result = __GCONV_INCOMPLETE_INPUT;
309 break;
310 }
55985355
UD
311 if ((MIN_NEEDED_OUTPUT != 1
312 && __builtin_expect (outptr + MIN_NEEDED_OUTPUT > outend, 0))
313 || (MIN_NEEDED_OUTPUT == 1
314 && __builtin_expect (outptr >= outend, 0)))
315 {
316 /* Overflow in the output buffer. */
317 result = __GCONV_FULL_OUTPUT;
318 break;
319 }
55985355
UD
320
321 /* Here comes the body the user provides. It can stop with
322 RESULT set to GCONV_INCOMPLETE_INPUT (if the size of the
323 input characters vary in size), GCONV_ILLEGAL_INPUT, or
324 GCONV_FULL_OUTPUT (if the output characters vary in size). */
325 BODY
8619129f
UD
326 }
327
8619129f
UD
328 /* Update the pointers pointed to by the parameters. */
329 *inptrp = inptr;
330 *outptrp = outptr;
66175fa8 331 UPDATE_PARAMS;
8619129f
UD
332
333 return result;
334}
335
336
b02b4774
UD
337/* Include the file a second time to define the function to handle
338 unaligned access. */
27822ce6 339#if !defined DEFINE_UNALIGNED && !_STRING_ARCH_unaligned \
4a0de63b
UD
340 && MIN_NEEDED_INPUT != 1 && MAX_NEEDED_INPUT % MIN_NEEDED_INPUT == 0 \
341 && MIN_NEEDED_OUTPUT != 1 && MAX_NEEDED_OUTPUT % MIN_NEEDED_OUTPUT == 0
fd1b5c0f
UD
342# undef get16
343# undef get32
344# undef put16
345# undef put32
346# undef unaligned
347
b35e58e4
UD
348# define DEFINE_UNALIGNED
349# include "loop.c"
350# undef DEFINE_UNALIGNED
32bead5b
WN
351#else
352# if MAX_NEEDED_INPUT > 1
353# define SINGLE(fct) SINGLE2 (fct)
354# define SINGLE2(fct) fct##_single
fd1b5c0f 355static inline int
dd9423a6 356__attribute ((always_inline))
55985355
UD
357SINGLE(LOOPFCT) (struct __gconv_step *step,
358 struct __gconv_step_data *step_data,
359 const unsigned char **inptrp, const unsigned char *inend,
fd1b5c0f 360 unsigned char **outptrp, unsigned char *outend,
55985355 361 size_t *irreversible EXTRA_LOOP_DECLS)
fd1b5c0f 362{
55985355 363 mbstate_t *state = step_data->__statep;
32bead5b 364# ifdef LOOP_NEED_FLAGS
55985355 365 int flags = step_data->__flags;
32bead5b
WN
366# endif
367# ifdef LOOP_NEED_DATA
55985355 368 void *data = step->__data;
32bead5b 369# endif
fd1b5c0f
UD
370 int result = __GCONV_OK;
371 unsigned char bytebuf[MAX_NEEDED_INPUT];
372 const unsigned char *inptr = *inptrp;
373 unsigned char *outptr = *outptrp;
374 size_t inlen;
375
32bead5b 376# ifdef INIT_PARAMS
fd1b5c0f 377 INIT_PARAMS;
32bead5b 378# endif
fd1b5c0f 379
32bead5b 380# ifdef UNPACK_BYTES
fd1b5c0f 381 UNPACK_BYTES
32bead5b 382# else
fd1b5c0f 383 /* Add the bytes from the state to the input buffer. */
5e0d0300 384 assert ((state->__count & 7) <= sizeof (state->__value));
17427edd 385 for (inlen = 0; inlen < (size_t) (state->__count & 7); ++inlen)
fd1b5c0f 386 bytebuf[inlen] = state->__value.__wchb[inlen];
32bead5b 387# endif
fd1b5c0f
UD
388
389 /* Are there enough bytes in the input buffer? */
0656e90e
UD
390 if (MIN_NEEDED_INPUT > 1
391 && __builtin_expect (inptr + (MIN_NEEDED_INPUT - inlen) > inend, 0))
fd1b5c0f 392 {
fd1b5c0f 393 *inptrp = inend;
32bead5b 394# ifdef STORE_REST
1af4e298
UD
395 while (inptr < inend)
396 bytebuf[inlen++] = *inptr++;
397
fd1b5c0f
UD
398 inptr = bytebuf;
399 inptrp = &inptr;
400 inend = &bytebuf[inlen];
401
402 STORE_REST
32bead5b 403# else
fd1b5c0f
UD
404 /* We don't have enough input for another complete input
405 character. */
406 while (inptr < inend)
407 state->__value.__wchb[inlen++] = *inptr++;
32bead5b 408# endif
fd1b5c0f
UD
409
410 return __GCONV_INCOMPLETE_INPUT;
411 }
412
413 /* Enough space in output buffer. */
414 if ((MIN_NEEDED_OUTPUT != 1 && outptr + MIN_NEEDED_OUTPUT > outend)
415 || (MIN_NEEDED_OUTPUT == 1 && outptr >= outend))
416 /* Overflow in the output buffer. */
417 return __GCONV_FULL_OUTPUT;
418
419 /* Now add characters from the normal input buffer. */
420 do
421 bytebuf[inlen++] = *inptr++;
316518d6 422 while (inlen < MAX_NEEDED_INPUT && inptr < inend);
fd1b5c0f
UD
423
424 inptr = bytebuf;
316518d6 425 inend = &bytebuf[inlen];
55985355 426
fd1b5c0f
UD
427 do
428 {
429 BODY
430 }
431 while (0);
432
316518d6
UD
433 /* Now we either have produced an output character and consumed all the
434 bytes from the state and at least one more, or the character is still
435 incomplete, or we have some other error (like illegal input character,
436 no space in output buffer). */
a1ffb40e 437 if (__glibc_likely (inptr != bytebuf))
fd1b5c0f 438 {
316518d6 439 /* We found a new character. */
fd1b5c0f
UD
440 assert (inptr - bytebuf > (state->__count & 7));
441
442 *inptrp += inptr - bytebuf - (state->__count & 7);
443 *outptrp = outptr;
444
316518d6
UD
445 result = __GCONV_OK;
446
fd1b5c0f 447 /* Clear the state buffer. */
32bead5b 448# ifdef CLEAR_STATE
41f112ad 449 CLEAR_STATE;
32bead5b 450# else
fd1b5c0f 451 state->__count &= ~7;
32bead5b 452# endif
fd1b5c0f 453 }
316518d6
UD
454 else if (result == __GCONV_INCOMPLETE_INPUT)
455 {
456 /* This can only happen if we have less than MAX_NEEDED_INPUT bytes
457 available. */
458 assert (inend != &bytebuf[MAX_NEEDED_INPUT]);
459
460 *inptrp += inend - bytebuf - (state->__count & 7);
32bead5b 461# ifdef STORE_REST
316518d6
UD
462 inptrp = &inptr;
463
464 STORE_REST
32bead5b 465# else
316518d6
UD
466 /* We don't have enough input for another complete input
467 character. */
5512d89b 468 assert (inend - inptr > (state->__count & ~7));
5e0d0300 469 assert (inend - inptr <= sizeof (state->__value));
5512d89b
UD
470 state->__count = (state->__count & ~7) | (inend - inptr);
471 inlen = 0;
316518d6
UD
472 while (inptr < inend)
473 state->__value.__wchb[inlen++] = *inptr++;
32bead5b 474# endif
316518d6 475 }
fd1b5c0f
UD
476
477 return result;
478}
32bead5b
WN
479# undef SINGLE
480# undef SINGLE2
481# endif
fd1b5c0f
UD
482
483
32bead5b 484# ifdef ONEBYTE_BODY
f9ad060c
UD
485/* Define the shortcut function for btowc. */
486static wint_t
487gconv_btowc (struct __gconv_step *step, unsigned char c)
488 ONEBYTE_BODY
32bead5b
WN
489# define FROM_ONEBYTE gconv_btowc
490# endif
f9ad060c 491
32bead5b 492#endif
f9ad060c 493
8619129f
UD
494/* We remove the macro definitions so that we can include this file again
495 for the definition of another function. */
496#undef MIN_NEEDED_INPUT
497#undef MAX_NEEDED_INPUT
498#undef MIN_NEEDED_OUTPUT
499#undef MAX_NEEDED_OUTPUT
500#undef LOOPFCT
8619129f
UD
501#undef BODY
502#undef LOOPFCT
28f1c862 503#undef EXTRA_LOOP_DECLS
66175fa8
UD
504#undef INIT_PARAMS
505#undef UPDATE_PARAMS
4b1b449d 506#undef REINIT_PARAMS
f9ad060c 507#undef ONEBYTE_BODY
55985355 508#undef UNPACK_BYTES
41f112ad 509#undef CLEAR_STATE
55985355
UD
510#undef LOOP_NEED_STATE
511#undef LOOP_NEED_FLAGS
512#undef LOOP_NEED_DATA
fd1b5c0f
UD
513#undef get16
514#undef get32
515#undef put16
516#undef put32
517#undef unaligned