]>
git.ipfire.org Git - thirdparty/glibc.git/blob - iconv/gconv_db.c
1 /* Provide access to the collection of available transformation modules.
2 Copyright (C) 1997, 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>, 1997.
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.
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.
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. */
25 #include <sys/param.h>
26 #include <bits/libc-lock.h>
29 #include <gconv_int.h>
32 /* Simple data structure for alias mapping. We have two names, `from'
34 void *__gconv_alias_db
;
36 /* Array with available modules. */
37 struct gconv_module
*__gconv_modules_db
;
39 /* We modify global data. */
40 __libc_lock_define_initialized (static, lock
)
43 /* Function for searching alias. */
45 __gconv_alias_compare (const void *p1
, const void *p2
)
47 struct gconv_alias
*s1
= (struct gconv_alias
*) p1
;
48 struct gconv_alias
*s2
= (struct gconv_alias
*) p2
;
49 return strcmp (s1
->fromname
, s2
->fromname
);
53 /* To search for a derivation we create a list of intermediate steps.
54 Each element contains a pointer to the element which precedes it
55 in the derivation order. */
56 struct derivation_step
58 const char *result_set
;
59 size_t result_set_len
;
62 struct gconv_module
*code
;
63 struct derivation_step
*last
;
64 struct derivation_step
*next
;
67 #define NEW_STEP(result, hi, lo, module, last_mod) \
68 ({ struct derivation_step *newp = alloca (sizeof (struct derivation_step)); \
69 newp->result_set = result; \
70 newp->result_set_len = strlen (result); \
73 newp->code = module; \
74 newp->last = last_mod; \
79 /* If a specific transformation is used more than once we should not need
80 to start looking for it again. Instead cache each successful result. */
81 struct known_derivation
85 struct __gconv_step
*steps
;
89 /* Compare function for database of found derivations. */
91 derivation_compare (const void *p1
, const void *p2
)
93 struct known_derivation
*s1
= (struct known_derivation
*) p1
;
94 struct known_derivation
*s2
= (struct known_derivation
*) p2
;
97 result
= strcmp (s1
->from
, s2
->from
);
99 result
= strcmp (s1
->to
, s2
->to
);
103 /* The search tree for known derivations. */
104 static void *known_derivations
;
106 /* Look up whether given transformation was already requested before. */
109 derivation_lookup (const char *fromset
, const char *toset
,
110 struct __gconv_step
**handle
, size_t *nsteps
)
112 struct known_derivation key
= { fromset
, toset
, NULL
, 0 };
113 struct known_derivation
**result
;
115 result
= __tfind (&key
, &known_derivations
, derivation_compare
);
118 return __GCONV_NOCONV
;
120 *handle
= (*result
)->steps
;
121 *nsteps
= (*result
)->nsteps
;
123 /* Please note that we return GCONV_OK even if the last search for
124 this transformation was unsuccessful. */
128 /* Add new derivation to list of known ones. */
131 add_derivation (const char *fromset
, const char *toset
,
132 struct __gconv_step
*handle
, size_t nsteps
)
134 struct known_derivation
*new_deriv
;
135 size_t fromset_len
= strlen (fromset
) + 1;
136 size_t toset_len
= strlen (toset
) + 1;
138 new_deriv
= (struct known_derivation
*)
139 malloc (sizeof (struct known_derivation
) + fromset_len
+ toset_len
);
140 if (new_deriv
!= NULL
)
142 new_deriv
->from
= (char *) (new_deriv
+ 1);
143 new_deriv
->to
= memcpy (__mempcpy (new_deriv
+ 1, fromset
, fromset_len
),
146 new_deriv
->steps
= handle
;
147 new_deriv
->nsteps
= nsteps
;
149 if (__tsearch (new_deriv
, &known_derivations
, derivation_compare
)
151 /* There is some kind of memory allocation problem. */
154 /* Please note that we don't complain if the allocation failed. This
155 is not tragically but in case we use the memory debugging facilities
156 not all memory will be freed. */
160 free_derivation (void *p
)
162 struct known_derivation
*deriv
= (struct known_derivation
*) p
;
165 for (cnt
= 0; cnt
< deriv
->nsteps
; ++cnt
)
166 if (deriv
->steps
[cnt
].__end_fct
)
167 DL_CALL_FCT (deriv
->steps
[cnt
].__end_fct
, (&deriv
->steps
[cnt
]));
169 /* Free the name strings. */
170 free ((char *) deriv
->steps
[0].__from_name
);
171 free ((char *) deriv
->steps
[deriv
->nsteps
- 1].__to_name
);
173 free ((struct __gconv_step
*) deriv
->steps
);
180 gen_steps (struct derivation_step
*best
, const char *toset
,
181 const char *fromset
, struct __gconv_step
**handle
, size_t *nsteps
)
184 struct __gconv_step
*result
;
185 struct derivation_step
*current
;
186 int status
= __GCONV_NOMEM
;
188 /* First determine number of steps. */
189 for (current
= best
; current
->last
!= NULL
; current
= current
->last
)
192 result
= (struct __gconv_step
*) malloc (sizeof (struct __gconv_step
)
201 while (step_cnt
-- > 0)
203 result
[step_cnt
].__from_name
= (step_cnt
== 0
205 : current
->last
->result_set
);
206 result
[step_cnt
].__to_name
= (step_cnt
+ 1 == *nsteps
207 ? __strdup (current
->result_set
)
208 : result
[step_cnt
+ 1].__from_name
);
211 if (current
->code
->module_name
[0] == '/')
213 /* Load the module, return handle for it. */
214 struct __gconv_loaded_object
*shlib_handle
=
215 __gconv_find_shlib (current
->code
->module_name
);
217 if (shlib_handle
== NULL
)
223 result
[step_cnt
].__shlib_handle
= shlib_handle
;
224 result
[step_cnt
].__modname
= shlib_handle
->name
;
225 result
[step_cnt
].__counter
= 1;
226 result
[step_cnt
].__fct
= shlib_handle
->fct
;
227 result
[step_cnt
].__init_fct
= shlib_handle
->init_fct
;
228 result
[step_cnt
].__end_fct
= shlib_handle
->end_fct
;
232 /* It's a builtin transformation. */
233 __gconv_get_builtin_trans (current
->code
->module_name
,
236 /* Call the init function. */
237 if (result
[step_cnt
].__init_fct
!= NULL
)
239 status
= DL_CALL_FCT (result
[step_cnt
].__init_fct
,
240 (&result
[step_cnt
]));
242 if (__builtin_expect (status
, __GCONV_OK
) != __GCONV_OK
)
245 /* Make sure we unload this modules. */
251 current
= current
->last
;
254 if (__builtin_expect (failed
, 0) != 0)
256 /* Something went wrong while initializing the modules. */
257 while (++step_cnt
< *nsteps
)
259 if (result
[step_cnt
].__end_fct
!= NULL
)
260 DL_CALL_FCT (result
[step_cnt
].__end_fct
, (&result
[step_cnt
]));
262 __gconv_release_shlib (result
[step_cnt
].__shlib_handle
);
268 if (status
== __GCONV_OK
)
269 status
= __GCONV_NOCONV
;
287 increment_counter (struct __gconv_step
*steps
, size_t nsteps
)
289 /* Increment the user counter. */
291 int result
= __GCONV_OK
;
294 if (steps
[cnt
].__counter
++ == 0)
296 steps
[cnt
].__shlib_handle
=
297 __gconv_find_shlib (steps
[cnt
].__modname
);
298 if (steps
[cnt
].__shlib_handle
== NULL
)
300 /* Oops, this is the second time we use this module (after
301 unloading) and this time loading failed!? */
302 while (++cnt
< nsteps
)
303 __gconv_release_shlib (steps
[cnt
].__shlib_handle
);
304 result
= __GCONV_NOCONV
;
313 /* The main function: find a possible derivation from the `fromset' (either
314 the given name or the alias) to the `toset' (again with alias). */
317 find_derivation (const char *toset
, const char *toset_expand
,
318 const char *fromset
, const char *fromset_expand
,
319 struct __gconv_step
**handle
, size_t *nsteps
)
321 struct derivation_step
*first
, *current
, **lastp
, *solution
= NULL
;
322 int best_cost_hi
= INT_MAX
;
323 int best_cost_lo
= INT_MAX
;
326 /* There is a small chance that this derivation is meanwhile found. This
327 can happen if in `find_derivation' we look for this derivation, didn't
328 find it but at the same time another thread looked for this derivation. */
329 result
= derivation_lookup (fromset_expand
?: fromset
, toset_expand
?: toset
,
331 if (result
== __GCONV_OK
)
334 result
= increment_counter (*handle
, *nsteps
);
339 /* For now we use a simple algorithm with quadratic runtime behaviour.
340 The task is to match the `toset' with any of the available rules,
341 starting from FROMSET. */
342 if (fromset_expand
!= NULL
)
344 first
= NEW_STEP (fromset_expand
, 0, 0, NULL
, NULL
);
345 first
->next
= NEW_STEP (fromset
, 0, 0, NULL
, NULL
);
346 lastp
= &first
->next
->next
;
350 first
= NEW_STEP (fromset
, 0, 0, NULL
, NULL
);
351 lastp
= &first
->next
;
354 for (current
= first
; current
!= NULL
; current
= current
->next
)
356 /* Now match all the available module specifications against the
357 current charset name. If any of them matches check whether
358 we already have a derivation for this charset. If yes, use the
359 one with the lower costs. Otherwise add the new charset at the
362 The module database is organized in a tree form which allows
363 searching for prefixes. So we search for the first entry with a
364 matching prefix and any other matching entry can be found from
366 struct gconv_module
*node
= __gconv_modules_db
;
368 /* Maybe it is not necessary anymore to look for a solution for
369 this entry since the cost is already as high (or heigher) as
370 the cost for the best solution so far. */
371 if (current
->cost_hi
> best_cost_hi
372 || (current
->cost_hi
== best_cost_hi
373 && current
->cost_lo
>= best_cost_lo
))
378 int cmpres
= strcmp (current
->result_set
, node
->from_string
);
381 /* Walk through the list of modules with this prefix and
382 try to match the name. */
383 struct gconv_module
*runp
;
385 /* Check all the modules with this prefix. */
389 const char *result_set
= (strcmp (runp
->to_string
, "-") == 0
390 ? (toset_expand
?: toset
)
392 int cost_hi
= runp
->cost_hi
+ current
->cost_hi
;
393 int cost_lo
= runp
->cost_lo
+ current
->cost_lo
;
394 struct derivation_step
*step
;
396 /* We managed to find a derivation. First see whether
397 this is what we are looking for. */
398 if (strcmp (result_set
, toset
) == 0
399 || (toset_expand
!= NULL
400 && strcmp (result_set
, toset_expand
) == 0))
402 if (solution
== NULL
|| cost_hi
< best_cost_hi
403 || (cost_hi
== best_cost_hi
404 && cost_lo
< best_cost_lo
))
406 best_cost_hi
= cost_hi
;
407 best_cost_lo
= cost_lo
;
410 /* Append this solution to list. */
411 if (solution
== NULL
)
412 solution
= NEW_STEP (result_set
, 0, 0, runp
, current
);
415 while (solution
->next
!= NULL
)
416 solution
= solution
->next
;
418 solution
->next
= NEW_STEP (result_set
, 0, 0,
422 else if (cost_hi
< best_cost_hi
423 || (cost_hi
== best_cost_hi
424 && cost_lo
< best_cost_lo
))
426 /* Append at the end if there is no entry with
428 for (step
= first
; step
!= NULL
; step
= step
->next
)
429 if (strcmp (result_set
, step
->result_set
) == 0)
434 *lastp
= NEW_STEP (result_set
,
437 lastp
= &(*lastp
)->next
;
439 else if (step
->cost_hi
> cost_hi
440 || (step
->cost_hi
== cost_hi
441 && step
->cost_lo
> cost_lo
))
444 step
->last
= current
;
446 /* Update the cost for all steps. */
447 for (step
= first
; step
!= NULL
;
450 struct derivation_step
*back
;
452 if (step
->code
== NULL
)
453 /* This is one of the entries we started
457 step
->cost_hi
= step
->code
->cost_hi
;
458 step
->cost_lo
= step
->code
->cost_lo
;
460 for (back
= step
->last
; back
->code
!= NULL
;
463 step
->cost_hi
+= back
->code
->cost_hi
;
464 step
->cost_lo
+= back
->code
->cost_lo
;
468 for (step
= solution
; step
!= NULL
;
471 step
->cost_hi
= (step
->code
->cost_hi
472 + step
->last
->cost_hi
);
473 step
->cost_lo
= (step
->code
->cost_lo
474 + step
->last
->cost_lo
);
476 if (step
->cost_hi
< best_cost_hi
477 || (step
->cost_hi
== best_cost_hi
478 && step
->cost_lo
< best_cost_lo
))
481 best_cost_hi
= step
->cost_hi
;
482 best_cost_lo
= step
->cost_lo
;
490 while (runp
!= NULL
);
501 if (solution
!= NULL
)
502 /* We really found a way to do the transformation. Now build a data
503 structure describing the transformation steps.*/
504 result
= gen_steps (solution
, toset_expand
?: toset
,
505 fromset_expand
?: fromset
, handle
, nsteps
);
508 /* We haven't found a transformation. Clear the result values. */
513 /* Add result in any case to list of known derivations. */
514 add_derivation (fromset_expand
?: fromset
, toset_expand
?: toset
,
523 __gconv_find_transform (const char *toset
, const char *fromset
,
524 struct __gconv_step
**handle
, size_t *nsteps
,
527 __libc_once_define (static, once
);
528 const char *fromset_expand
= NULL
;
529 const char *toset_expand
= NULL
;
532 /* Ensure that the configuration data is read. */
533 __libc_once (once
, __gconv_read_conf
);
535 /* Acquire the lock. */
536 __libc_lock_lock (lock
);
538 /* If we don't have a module database return with an error. */
539 if (__gconv_modules_db
== NULL
)
541 __libc_lock_unlock (lock
);
542 return __GCONV_NOCONV
;
545 /* See whether the names are aliases. */
546 if (__gconv_alias_db
!= NULL
)
548 struct gconv_alias key
;
549 struct gconv_alias
**found
;
551 key
.fromname
= fromset
;
552 found
= __tfind (&key
, &__gconv_alias_db
, __gconv_alias_compare
);
553 fromset_expand
= found
!= NULL
? (*found
)->toname
: NULL
;
555 key
.fromname
= toset
;
556 found
= __tfind (&key
, &__gconv_alias_db
, __gconv_alias_compare
);
557 toset_expand
= found
!= NULL
? (*found
)->toname
: NULL
;
560 if (__builtin_expect (flags
& GCONV_AVOID_NOCONV
, 0)
561 /* We are not supposed to create a pseudo transformation (means
562 copying) when the input and output character set are the same. */
563 && (strcmp (toset
, fromset
) == 0
564 || (toset_expand
!= NULL
&& strcmp (toset_expand
, fromset
) == 0)
565 || (fromset_expand
!= NULL
566 && (strcmp (toset
, fromset_expand
) == 0
567 || (toset_expand
!= NULL
568 && strcmp (toset_expand
, fromset_expand
) == 0)))))
570 /* Both character sets are the same. */
571 __libc_lock_unlock (lock
);
572 return __GCONV_NOCONV
;
575 result
= find_derivation (toset
, toset_expand
, fromset
, fromset_expand
,
578 /* Release the lock. */
579 __libc_lock_unlock (lock
);
581 /* The following code is necessary since `find_derivation' will return
582 GCONV_OK even when no derivation was found but the same request
583 was processed before. I.e., negative results will also be cached. */
584 return (result
== __GCONV_OK
585 ? (*handle
== NULL
? __GCONV_NOCONV
: __GCONV_OK
)
590 /* Release the entries of the modules list. */
593 __gconv_close_transform (struct __gconv_step
*steps
, size_t nsteps
)
595 int result
= __GCONV_OK
;
598 /* Acquire the lock. */
599 __libc_lock_lock (lock
);
602 if (steps
[nsteps
].__shlib_handle
!= NULL
603 && --steps
[nsteps
].__counter
== 0)
605 result
= __gconv_release_shlib (steps
[nsteps
].__shlib_handle
);
606 if (result
!= __GCONV_OK
)
608 steps
[nsteps
].__shlib_handle
= NULL
;
611 /* Release the lock. */
612 __libc_lock_unlock (lock
);
619 /* Free the modules mentioned. */
622 free_modules_db (struct gconv_module
*node
)
624 if (node
->left
!= NULL
)
625 free_modules_db (node
->left
);
626 if (node
->right
!= NULL
)
627 free_modules_db (node
->right
);
630 struct gconv_module
*act
= node
;
632 if (act
->module_name
[0] == '/')
635 while (node
!= NULL
);
639 /* Free all resources if necessary. */
640 static void __attribute__ ((unused
))
643 if (__gconv_alias_db
!= NULL
)
644 __tdestroy (__gconv_alias_db
, free
);
646 if (__gconv_modules_db
!= NULL
)
647 free_modules_db (__gconv_modules_db
);
649 if (known_derivations
!= NULL
)
650 __tdestroy (known_derivations
, free_derivation
);
653 text_set_element (__libc_subfreeres
, free_mem
);