Fix comment.
[kopensolaris-gnu/glibc.git] / iconv / loop.c
1 /* Conversion loop frame work.
2    Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
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
7    modify it under the terms of the GNU Library General Public License as
8    published by the Free Software Foundation; either version 2 of the
9    License, or (at your option) any later version.
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
14    Library General Public License for more details.
15
16    You should have received a copy of the GNU Library General Public
17    License along with the GNU C Library; see the file COPYING.LIB.  If not,
18    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19    Boston, MA 02111-1307, USA.  */
20
21 /* This file provides a frame for the reader loop in all conversion modules.
22    The actual code must (of course) be provided in the actual module source
23    code but certain actions can be written down generically, with some
24    customization options which are these:
25
26      MIN_NEEDED_INPUT   minimal number of input bytes needed for the next
27                         conversion.
28      MIN_NEEDED_OUTPUT  minimal number of bytes produced by the next round
29                         of conversion.
30
31      MAX_NEEDED_INPUT   you guess it, this is the maximal number of input
32                         bytes needed.  It defaults to MIN_NEEDED_INPUT
33      MAX_NEEDED_OUTPUT  likewise for output bytes.
34
35      LOOPFCT            name of the function created.  If not specified
36                         the name is `loop' but this prevents the use
37                         of multiple functions in the same file.
38
39      BODY               this is supposed to expand to the body of the loop.
40                         The user must provide this.
41
42      EXTRA_LOOP_DECLS   extra arguments passed from converion loop call.
43
44      INIT_PARAMS        code to define and initialize variables from params.
45      UPDATE_PARAMS      code to store result in params.
46 */
47
48 #include <assert.h>
49 #include <endian.h>
50 #include <gconv.h>
51 #include <stdint.h>
52 #include <string.h>
53 #include <wchar.h>
54 #include <sys/param.h>          /* For MIN.  */
55 #define __need_size_t
56 #include <stddef.h>
57
58
59 /* We have to provide support for machines which are not able to handled
60    unaligned memory accesses.  Some of the character encodings have
61    representations with a fixed width of 2 or 4 bytes.  But if we cannot
62    access unaligned memory we still have to read byte-wise.  */
63 #undef FCTNAME2
64 #if defined _STRING_ARCH_unaligned || !defined DEFINE_UNALIGNED
65 /* We can handle unaligned memory access.  */
66 # define get16(addr) *((uint16_t *) (addr))
67 # define get32(addr) *((uint32_t *) (addr))
68
69 /* We need no special support for writing values either.  */
70 # define put16(addr, val) *((uint16_t *) (addr)) = (val)
71 # define put32(addr, val) *((uint32_t *) (addr)) = (val)
72
73 # define FCTNAME2(name) name
74 #else
75 /* Distinguish between big endian and little endian.  */
76 # if __BYTE_ORDER == __LITTLE_ENDIAN
77 #  define get16(addr) \
78      (((__const unsigned char *) (addr))[1] << 8                              \
79       | ((__const unsigned char *) (addr))[0])
80 #  define get32(addr) \
81      (((((__const unsigned char *) (addr))[3] << 8                            \
82         | ((__const unsigned char *) (addr))[2]) << 8                         \
83        | ((__const unsigned char *) (addr))[1]) << 8                          \
84       | ((__const unsigned char *) (addr))[0])
85
86 #  define put16(addr, val) \
87      ({ uint16_t __val = (val);                                               \
88         ((unsigned char *) (addr))[0] = __val;                                \
89         ((unsigned char *) (addr))[1] = __val >> 8;                           \
90         (void) 0; })
91 #  define put32(addr, val) \
92      ({ uint32_t __val = (val);                                               \
93         ((unsigned char *) (addr))[0] = __val;                                \
94         __val >>= 8;                                                          \
95         ((unsigned char *) (addr))[1] = __val;                                \
96         __val >>= 8;                                                          \
97         ((unsigned char *) (addr))[2] = __val;                                \
98         __val >>= 8;                                                          \
99         ((unsigned char *) (addr))[3] = __val;                                \
100         (void) 0; })
101 # else
102 #  define get16(addr) \
103      (((__const unsigned char *) (addr))[0] << 8                              \
104       | ((__const unsigned char *) (addr))[1])
105 #  define get32(addr) \
106      (((((__const unsigned char *) (addr))[0] << 8                            \
107         | ((__const unsigned char *) (addr))[1]) << 8                         \
108        | ((__const unsigned char *) (addr))[2]) << 8                          \
109       | ((__const unsigned char *) (addr))[3])
110
111 #  define put16(addr, val) \
112      ({ uint16_t __val = (val);                                               \
113         ((unsigned char *) (addr))[1] = __val;                                \
114         ((unsigned char *) (addr))[2] = __val >> 8;                           \
115         (void) 0; })
116 #  define put32(addr, val) \
117      ({ uint32_t __val = (val);                                               \
118         ((unsigned char *) (addr))[3] = __val;                                \
119         __val >>= 8;                                                          \
120         ((unsigned char *) (addr))[2] = __val;                                \
121         __val >>= 8;                                                          \
122         ((unsigned char *) (addr))[1] = __val;                                \
123         __val >>= 8;                                                          \
124         ((unsigned char *) (addr))[0] = __val;                                \
125         (void) 0; })
126 # endif
127
128 # define FCTNAME2(name) name##_unaligned
129 #endif
130 #define FCTNAME(name) FCTNAME2(name)
131
132
133 /* We need at least one byte for the next round.  */
134 #ifndef MIN_NEEDED_INPUT
135 # error "MIN_NEEDED_INPUT definition missing"
136 #endif
137
138 /* Let's see how many bytes we produce.  */
139 #ifndef MAX_NEEDED_INPUT
140 # define MAX_NEEDED_INPUT       MIN_NEEDED_INPUT
141 #endif
142
143 /* We produce at least one byte in the next round.  */
144 #ifndef MIN_NEEDED_OUTPUT
145 # error "MIN_NEEDED_OUTPUT definition missing"
146 #endif
147
148 /* Let's see how many bytes we produce.  */
149 #ifndef MAX_NEEDED_OUTPUT
150 # define MAX_NEEDED_OUTPUT      MIN_NEEDED_OUTPUT
151 #endif
152
153 /* Default name for the function.  */
154 #ifndef LOOPFCT
155 # define LOOPFCT                loop
156 #endif
157
158 /* Make sure we have a loop body.  */
159 #ifndef BODY
160 # error "Definition of BODY missing for function" LOOPFCT
161 #endif
162
163
164 /* If no arguments have to passed to the loop function define the macro
165    as empty.  */
166 #ifndef EXTRA_LOOP_DECLS
167 # define EXTRA_LOOP_DECLS
168 #endif
169
170
171 /* To make it easier for the writers of the modules, we define a macro
172    to test whether we have to ignore errors.  */
173 #define ignore_errors_p() (flags & __GCONV_IGNORE_ERRORS)
174
175
176 /* The function returns the status, as defined in gconv.h.  */
177 static inline int
178 FCTNAME (LOOPFCT) (const unsigned char **inptrp, const unsigned char *inend,
179                    unsigned char **outptrp, unsigned char *outend,
180                    mbstate_t *state, int flags, void *data, size_t *converted
181                    EXTRA_LOOP_DECLS)
182 {
183   int result = __GCONV_OK;
184   const unsigned char *inptr = *inptrp;
185   unsigned char *outptr = *outptrp;
186
187   /* We run one loop where we avoid checks for underflow/overflow of the
188      buffers to speed up the conversion a bit.  */
189   size_t min_in_rounds = (inend - inptr) / MAX_NEEDED_INPUT;
190   size_t min_out_rounds = (outend - outptr) / MAX_NEEDED_OUTPUT;
191   size_t min_rounds = MIN (min_in_rounds, min_out_rounds);
192
193 #ifdef INIT_PARAMS
194   INIT_PARAMS;
195 #endif
196
197 #undef NEED_LENGTH_TEST
198 #define NEED_LENGTH_TEST        0
199   while (min_rounds-- > 0)
200     {
201       /* Here comes the body the user provides.  It can stop with RESULT
202          set to GCONV_INCOMPLETE_INPUT (if the size of the input characters
203          vary in size), GCONV_ILLEGAL_INPUT, or GCONV_FULL_OUTPUT (if the
204          output characters vary in size.  */
205       BODY
206     }
207
208   if (result == __GCONV_OK)
209     {
210 #if MIN_NEEDED_INPUT == MAX_NEEDED_INPUT \
211     && MIN_NEEDED_OUTPUT == MAX_NEEDED_OUTPUT
212       /* We don't need to start another loop since we were able to determine
213          the maximal number of characters to copy in advance.  What remains
214          to be determined is the status.  */
215       if (inptr == inend)
216         /* No more input.  */
217         result = __GCONV_EMPTY_INPUT;
218       else if ((MIN_NEEDED_OUTPUT != 1 && outptr + MIN_NEEDED_OUTPUT > outend)
219                || (MIN_NEEDED_OUTPUT == 1 && outptr >= outend))
220         /* Overflow in the output buffer.  */
221         result = __GCONV_FULL_OUTPUT;
222       else
223         /* We have something left in the input buffer.  */
224         result = __GCONV_INCOMPLETE_INPUT;
225 #else
226       result = __GCONV_EMPTY_INPUT;
227
228 # undef NEED_LENGTH_TEST
229 # define NEED_LENGTH_TEST       1
230       while (inptr != inend)
231         {
232           /* `if' cases for MIN_NEEDED_OUTPUT ==/!= 1 is made to help the
233              compiler generating better code.  It will optimized away
234              since MIN_NEEDED_OUTPUT is always a constant.  */
235           if ((MIN_NEEDED_OUTPUT != 1
236                && __builtin_expect (outptr + MIN_NEEDED_OUTPUT > outend, 0))
237               || (MIN_NEEDED_OUTPUT == 1
238                   && __builtin_expect (outptr >= outend, 0)))
239             {
240               /* Overflow in the output buffer.  */
241               result = __GCONV_FULL_OUTPUT;
242               break;
243             }
244           if (MIN_NEEDED_INPUT > 1
245               && __builtin_expect (inptr + MIN_NEEDED_INPUT > inend, 0))
246             {
247               /* We don't have enough input for another complete input
248                  character.  */
249               result = __GCONV_INCOMPLETE_INPUT;
250               break;
251             }
252
253           /* Here comes the body the user provides.  It can stop with
254              RESULT set to GCONV_INCOMPLETE_INPUT (if the size of the
255              input characters vary in size), GCONV_ILLEGAL_INPUT, or
256              GCONV_FULL_OUTPUT (if the output characters vary in size).  */
257           BODY
258         }
259 #endif  /* Input and output charset are not both fixed width.  */
260     }
261
262   /* Update the pointers pointed to by the parameters.  */
263   *inptrp = inptr;
264   *outptrp = outptr;
265 #ifdef UPDATE_PARAMS
266   UPDATE_PARAMS;
267 #endif
268
269   return result;
270 }
271
272
273 /* Include the file a second time to define the function to handle
274    unaligned access.  */
275 #if !defined DEFINE_UNALIGNED && !defined _STRING_ARCH_unaligned \
276     && MIN_NEEDED_FROM != 1 && MAX_NEEDED_FROM % MIN_NEEDED_FROM == 0 \
277     && MIN_NEEDED_TO != 1 && MAX_NEEDED_TO % MIN_NEEDED_TO == 0
278 # undef get16
279 # undef get32
280 # undef put16
281 # undef put32
282 # undef unaligned
283
284 # define DEFINE_UNALIGNED
285 # include "loop.c"
286 # undef DEFINE_UNALIGNED
287 #endif
288
289
290 #if MAX_NEEDED_INPUT > 1
291 # define SINGLE(fct) SINGLE2 (fct)
292 # define SINGLE2(fct) fct##_single
293 static inline int
294 SINGLE(LOOPFCT) (const unsigned char **inptrp, const unsigned char *inend,
295                  unsigned char **outptrp, unsigned char *outend,
296                  mbstate_t *state, int flags, void *data, size_t *converted
297                  EXTRA_LOOP_DECLS)
298 {
299   int result = __GCONV_OK;
300   unsigned char bytebuf[MAX_NEEDED_INPUT];
301   const unsigned char *inptr = *inptrp;
302   unsigned char *outptr = *outptrp;
303   size_t inlen;
304
305 #ifdef INIT_PARAMS
306   INIT_PARAMS;
307 #endif
308
309 #ifdef UNPACK_BYTES
310   UNPACK_BYTES
311 #else
312   /* Add the bytes from the state to the input buffer.  */
313   for (inlen = 0; inlen < (state->__count & 7); ++ inlen)
314     bytebuf[inlen] = state->__value.__wchb[inlen];
315 #endif
316
317   /* Are there enough bytes in the input buffer?  */
318   if (__builtin_expect (inptr + (MIN_NEEDED_INPUT - inlen) > inend, 0))
319     {
320       *inptrp = inend;
321 #ifdef STORE_REST
322       inptr = bytebuf;
323       inptrp = &inptr;
324       inend = &bytebuf[inlen];
325
326       STORE_REST
327 #else
328       /* We don't have enough input for another complete input
329          character.  */
330       while (inptr < inend)
331         state->__value.__wchb[inlen++] = *inptr++;
332 #endif
333
334       return __GCONV_INCOMPLETE_INPUT;
335     }
336
337   /* Enough space in output buffer.  */
338   if ((MIN_NEEDED_OUTPUT != 1 && outptr + MIN_NEEDED_OUTPUT > outend)
339       || (MIN_NEEDED_OUTPUT == 1 && outptr >= outend))
340     /* Overflow in the output buffer.  */
341     return __GCONV_FULL_OUTPUT;
342
343   /*  Now add characters from the normal input buffer.  */
344   do
345     bytebuf[inlen++] = *inptr++;
346   while (inlen < MAX_NEEDED_INPUT && inptr < inend);
347
348   inptr = bytebuf;
349   inend = &bytebuf[inlen];
350 #undef NEED_LENGTH_TEST
351 #define NEED_LENGTH_TEST        1
352   do
353     {
354       BODY
355     }
356   while (0);
357
358   /* Now we either have produced an output character and consumed all the
359      bytes from the state and at least one more, or the character is still
360      incomplete, or we have some other error (like illegal input character,
361      no space in output buffer).  */
362   if (__builtin_expect (inptr != bytebuf, 1))
363     {
364       /* We found a new character.  */
365       assert (inptr - bytebuf > (state->__count & 7));
366
367       *inptrp += inptr - bytebuf - (state->__count & 7);
368       *outptrp = outptr;
369
370       result = __GCONV_OK;
371
372       /* Clear the state buffer.  */
373       state->__count &= ~7;
374     }
375   else if (result == __GCONV_INCOMPLETE_INPUT)
376     {
377       /* This can only happen if we have less than MAX_NEEDED_INPUT bytes
378          available.  */
379       assert (inend != &bytebuf[MAX_NEEDED_INPUT]);
380
381       *inptrp += inend - bytebuf - (state->__count & 7);
382 #ifdef STORE_REST
383       inptrp = &inptr;
384
385       STORE_REST
386 #else
387       /* We don't have enough input for another complete input
388          character.  */
389       while (inptr < inend)
390         state->__value.__wchb[inlen++] = *inptr++;
391 #endif
392     }
393
394   return result;
395 }
396 # undef SINGLE
397 # undef SINGLE2
398 #endif
399
400
401 /* We remove the macro definitions so that we can include this file again
402    for the definition of another function.  */
403 #undef MIN_NEEDED_INPUT
404 #undef MAX_NEEDED_INPUT
405 #undef MIN_NEEDED_OUTPUT
406 #undef MAX_NEEDED_OUTPUT
407 #undef LOOPFCT
408 #undef BODY
409 #undef LOOPFCT
410 #undef EXTRA_LOOP_DECLS
411 #undef INIT_PARAMS
412 #undef UPDATE_PARAMS
413 #undef get16
414 #undef get32
415 #undef put16
416 #undef put32
417 #undef unaligned
418 #undef UNPACK_BYTES