(__gconv_path_elem): Remove const.
[kopensolaris-gnu/glibc.git] / iconv / gconv_conf.c
1 /* Handle configuration data.
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.
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 #include <assert.h>
22 #include <ctype.h>
23 #include <errno.h>
24 #include <limits.h>
25 #include <search.h>
26 #include <stddef.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <unistd.h>
31 #include <sys/param.h>
32
33 #include <bits/libc-lock.h>
34 #include <gconv_int.h>
35
36
37 /* This is the default path where we look for module lists.  */
38 static const char default_gconv_path[] = GCONV_PATH;
39
40 /* The path elements, as determined by the __gconv_get_path function.
41    All path elements end in a slash.  */
42 struct path_elem *__gconv_path_elem;
43 /* Maximum length of a single path element in __gconv_path_elem.  */
44 size_t __gconv_max_path_elem_len;
45
46 /* We use the following struct if we couldn't allocate memory.  */
47 static const struct path_elem empty_path_elem;
48
49 /* Name of the file containing the module information in the directories
50    along the path.  */
51 static const char gconv_conf_filename[] = "gconv-modules";
52
53 /* Filename extension for the modules.  */
54 #ifndef MODULE_EXT
55 # define MODULE_EXT ".so"
56 #endif
57 static const char gconv_module_ext[] = MODULE_EXT;
58
59 /* We have a few builtin transformations.  */
60 static struct gconv_module builtin_modules[] =
61 {
62 #define BUILTIN_TRANSFORMATION(From, To, Cost, Name, Fct, Init, End, MinF, \
63                                MaxF, MinT, MaxT) \
64   {                                                                           \
65     from_string: From,                                                        \
66     to_string: To,                                                            \
67     cost_hi: Cost,                                                            \
68     cost_lo: INT_MAX,                                                         \
69     module_name: Name                                                         \
70   },
71 #define BUILTIN_ALIAS(From, To)
72
73 #include "gconv_builtin.h"
74 };
75
76 #undef BUILTIN_TRANSFORMATION
77 #undef BUILTIN_ALIAS
78
79 static const char *builtin_aliases[] =
80 {
81 #define BUILTIN_TRANSFORMATION(From, To, Cost, Name, Fct, Init, End, MinF, \
82                                MaxF, MinT, MaxT)
83 #define BUILTIN_ALIAS(From, To) From " " To,
84
85 #include "gconv_builtin.h"
86 };
87
88 #ifdef USE_IN_LIBIO
89 # include <libio/libioP.h>
90 # define __getdelim(line, len, c, fp) _IO_getdelim (line, len, c, fp)
91 #endif
92
93
94 /* Test whether there is already a matching module known.  */
95 static int
96 internal_function
97 detect_conflict (const char *alias)
98 {
99   struct gconv_module *node = __gconv_modules_db;
100
101   while (node != NULL)
102     {
103       int cmpres = strcmp (alias, node->from_string);
104
105       if (cmpres == 0)
106         /* We have a conflict.  */
107         return 1;
108       else if (cmpres < 0)
109         node = node->left;
110       else
111         node = node->right;
112     }
113
114   return node != NULL;
115 }
116
117
118 /* Add new alias.  */
119 static inline void
120 add_alias (char *rp, void *modules)
121 {
122   /* We now expect two more string.  The strings are normalized
123      (converted to UPPER case) and strored in the alias database.  */
124   struct gconv_alias *new_alias;
125   char *from, *to, *wp;
126
127   while (isspace (*rp))
128     ++rp;
129   from = wp = rp;
130   while (*rp != '\0' && !isspace (*rp))
131     *wp++ = toupper (*rp++);
132   if (*rp == '\0')
133     /* There is no `to' string on the line.  Ignore it.  */
134     return;
135   *wp++ = '\0';
136   to = ++rp;
137   while (isspace (*rp))
138     ++rp;
139   while (*rp != '\0' && !isspace (*rp))
140     *wp++ = toupper (*rp++);
141   if (to == wp)
142     /* No `to' string, ignore the line.  */
143     return;
144   *wp++ = '\0';
145
146   /* Test whether this alias conflicts with any available module.  */
147   if (detect_conflict (from))
148     /* It does conflict, don't add the alias.  */
149     return;
150
151   new_alias = (struct gconv_alias *)
152     malloc (sizeof (struct gconv_alias) + (wp - from));
153   if (new_alias != NULL)
154     {
155       void **inserted;
156
157       new_alias->fromname = memcpy ((char *) new_alias
158                                     + sizeof (struct gconv_alias),
159                                     from, wp - from);
160       new_alias->toname = new_alias->fromname + (to - from);
161
162       inserted = (void **) __tsearch (new_alias, &__gconv_alias_db,
163                                       __gconv_alias_compare);
164       if (inserted == NULL || *inserted != new_alias)
165         /* Something went wrong, free this entry.  */
166         free (new_alias);
167     }
168 }
169
170
171 /* Insert a data structure for a new module in the search tree.  */
172 static inline void
173 internal_function
174 insert_module (struct gconv_module *newp, int tobefreed)
175 {
176   struct gconv_module **rootp = &__gconv_modules_db;
177
178   while (*rootp != NULL)
179     {
180       struct gconv_module *root = *rootp;
181       int cmpres;
182
183       cmpres = strcmp (newp->from_string, root->from_string);
184       if (cmpres == 0)
185         {
186           /* Both strings are identical.  Insert the string at the
187              end of the `same' list if it is not already there.  */
188           while (strcmp (newp->from_string, root->from_string) != 0
189                  || strcmp (newp->to_string, root->to_string) != 0)
190             {
191               rootp = &root->same;
192               root = *rootp;
193               if (root == NULL)
194                 break;
195             }
196
197           if (root != NULL)
198             {
199               /* This is a no new conversion.  */
200               if (tobefreed)
201                 free (newp);
202               return;
203             }
204
205           break;
206         }
207       else if (cmpres < 0)
208         rootp = &root->left;
209       else
210         rootp = &root->right;
211     }
212
213   /* Plug in the new node here.  */
214   *rootp = newp;
215 }
216
217
218 /* Add new module.  */
219 static void
220 internal_function
221 add_module (char *rp, const char *directory, size_t dir_len, void **modules,
222             size_t *nmodules, int modcounter)
223 {
224   /* We expect now
225      1. `from' name
226      2. `to' name
227      3. filename of the module
228      4. an optional cost value
229   */
230   struct gconv_alias fake_alias;
231   struct gconv_module *new_module;
232   char *from, *to, *module, *wp;
233   int need_ext;
234   int cost_hi;
235
236   while (isspace (*rp))
237     ++rp;
238   from = rp;
239   while (*rp != '\0' && !isspace (*rp))
240     {
241       *rp = toupper (*rp);
242       ++rp;
243     }
244   if (*rp == '\0')
245     return;
246   *rp++ = '\0';
247   to = wp = rp;
248   while (isspace (*rp))
249     ++rp;
250   while (*rp != '\0' && !isspace (*rp))
251     *wp++ = toupper (*rp++);
252   if (*rp == '\0')
253     return;
254   *wp++ = '\0';
255   do
256     ++rp;
257   while (isspace (*rp));
258   module = wp;
259   while (*rp != '\0' && !isspace (*rp))
260     *wp++ = *rp++;
261   if (*rp == '\0')
262     {
263       /* There is no cost, use one by default.  */
264       *wp++ = '\0';
265       cost_hi = 1;
266     }
267   else
268     {
269       /* There might be a cost value.  */
270       char *endp;
271
272       *wp++ = '\0';
273       cost_hi = strtol (rp, &endp, 10);
274       if (rp == endp || cost_hi < 1)
275         /* No useful information.  */
276         cost_hi = 1;
277     }
278
279   if (module[0] == '\0')
280     /* No module name given.  */
281     return;
282   if (module[0] == '/')
283     dir_len = 0;
284
285   /* See whether we must add the ending.  */
286   need_ext = 0;
287   if (wp - module < (ptrdiff_t) sizeof (gconv_module_ext)
288       || memcmp (wp - sizeof (gconv_module_ext), gconv_module_ext,
289                  sizeof (gconv_module_ext)) != 0)
290     /* We must add the module extension.  */
291     need_ext = sizeof (gconv_module_ext) - 1;
292
293   /* See whether we have already an alias with this name defined.  */
294   fake_alias.fromname = strndupa (from, to - from);
295
296   if (__tfind (&fake_alias, &__gconv_alias_db, __gconv_alias_compare) != NULL)
297     /* This module duplicates an alias.  */
298     return;
299
300   new_module = (struct gconv_module *) calloc (1,
301                                                sizeof (struct gconv_module)
302                                                + (wp - from)
303                                                + dir_len + need_ext);
304   if (new_module != NULL)
305     {
306       char *tmp;
307
308       new_module->from_string = tmp = (char *) (new_module + 1);
309       tmp = __mempcpy (tmp, from, to - from);
310
311       new_module->to_string = tmp;
312       tmp = __mempcpy (tmp, to, module - to);
313
314       new_module->cost_hi = cost_hi;
315       new_module->cost_lo = modcounter;
316
317       new_module->module_name = tmp;
318
319       if (dir_len != 0)
320         tmp = __mempcpy (tmp, directory, dir_len);
321
322       tmp = __mempcpy (tmp, module, wp - module);
323
324       if (need_ext)
325         memcpy (tmp - 1, gconv_module_ext, sizeof (gconv_module_ext));
326
327       /* Now insert the new module data structure in our search tree.  */
328       insert_module (new_module, 1);
329     }
330 }
331
332
333 /* Read the next configuration file.  */
334 static void
335 internal_function
336 read_conf_file (const char *filename, const char *directory, size_t dir_len,
337                 void **modules, size_t *nmodules)
338 {
339   FILE *fp = fopen (filename, "r");
340   char *line = NULL;
341   size_t line_len = 0;
342   int modcounter = 0;
343
344   /* Don't complain if a file is not present or readable, simply silently
345      ignore it.  */
346   if (fp == NULL)
347     return;
348
349   /* Process the known entries of the file.  Comments start with `#' and
350      end with the end of the line.  Empty lines are ignored.  */
351   while (!feof_unlocked (fp))
352     {
353       char *rp, *endp, *word;
354       ssize_t n = __getdelim (&line, &line_len, '\n', fp);
355       if (n < 0)
356         /* An error occurred.  */
357         break;
358
359       rp = line;
360       /* Terminate the line (excluding comments or newline) by an NUL byte
361          to simplify the following code.  */
362       endp = strchr (rp, '#');
363       if (endp != NULL)
364         *endp = '\0';
365       else
366         if (rp[n - 1] == '\n')
367           rp[n - 1] = '\0';
368
369       while (isspace (*rp))
370         ++rp;
371
372       /* If this is an empty line go on with the next one.  */
373       if (rp == endp)
374         continue;
375
376       word = rp;
377       while (*rp != '\0' && !isspace (*rp))
378         ++rp;
379
380       if (rp - word == sizeof ("alias") - 1
381           && memcmp (word, "alias", sizeof ("alias") - 1) == 0)
382         add_alias (rp, *modules);
383       else if (rp - word == sizeof ("module") - 1
384                && memcmp (word, "module", sizeof ("module") - 1) == 0)
385         add_module (rp, directory, dir_len, modules, nmodules, modcounter++);
386       /* else */
387         /* Otherwise ignore the line.  */
388     }
389
390   free (line);
391
392   fclose (fp);
393 }
394
395
396 /* Determine the directories we are looking for data in.  */
397 void
398 __gconv_get_path (void)
399 {
400   struct path_elem *result;
401   __libc_lock_define_initialized (static, lock);
402
403   __libc_lock_lock (lock);
404
405   /* Make sure there wasn't a second thread doing it already.  */
406   result = (struct path_elem *) __gconv_path_elem;
407   if (result == NULL)
408     {
409       /* Determine the complete path first.  */
410       const char *user_path;
411       char *gconv_path;
412       size_t gconv_path_len;
413       char *elem;
414       char *oldp;
415       char *cp;
416       int nelems;
417       char *cwd;
418       size_t cwdlen;
419
420       user_path = getenv ("GCONV_PATH");
421       if (user_path == NULL)
422         {
423           /* No user-defined path.  Make a modifiable copy of the
424              default path.  */
425           gconv_path = strdupa (default_gconv_path);
426           gconv_path_len = sizeof (default_gconv_path);
427           cwd = NULL;
428           cwdlen = 0;
429         }
430       else
431         {
432           /* Append the default path to the user-defined path.  */
433           size_t user_len = strlen (user_path);
434
435           gconv_path_len = user_len + 1 + sizeof (default_gconv_path);
436           gconv_path = alloca (gconv_path_len);
437           __mempcpy (__mempcpy (__mempcpy (gconv_path, user_path, user_len),
438                                 ":", 1),
439                      default_gconv_path, sizeof (default_gconv_path));
440           cwd = __getcwd (NULL, 0);
441           cwdlen = strlen (cwd);
442         }
443       assert (default_gconv_path[0] == '/');
444
445       /* In a first pass we calculate the number of elements.  */
446       oldp = NULL;
447       cp = strchr (gconv_path, ':');
448       nelems = 1;
449       while (cp != NULL)
450         {
451           if (cp != oldp + 1)
452             ++nelems;
453           oldp = cp;
454           cp =  strchr (cp + 1, ':');
455         }
456
457       /* Allocate the memory for the result.  */
458       result = (struct path_elem *) malloc ((nelems + 1)
459                                             * sizeof (struct path_elem)
460                                             + gconv_path_len + nelems
461                                             + (nelems - 1) * (cwdlen + 1));
462       if (result != NULL)
463         {
464           char *strspace = (char *) &result[nelems + 1];
465           int n = 0;
466
467           /* Separate the individual parts.  */
468           __gconv_max_path_elem_len = 0;
469           elem = __strtok_r (gconv_path, ":", &gconv_path);
470           assert (elem != NULL);
471           do
472             {
473               result[n].name = strspace;
474               if (elem[0] != '/')
475                 {
476                   assert (cwd != NULL);
477                   strspace = __mempcpy (strspace, cwd, cwdlen);
478                   *strspace++ = '/';
479                 }
480               strspace = __stpcpy (strspace, elem);
481               if (strspace[-1] != '/')
482                 *strspace++ = '/';
483
484               result[n].len = strspace - result[n].name;
485               if (result[n].len > __gconv_max_path_elem_len)
486                 __gconv_max_path_elem_len = result[n].len;
487
488               *strspace++ = '\0';
489               ++n;
490             }
491           while ((elem = __strtok_r (NULL, ":", &gconv_path)) != NULL);
492
493           result[n].name = NULL;
494           result[n].len = 0;
495         }
496
497       __gconv_path_elem = result ?: &empty_path_elem;
498
499       if (cwd != NULL)
500         free (cwd);
501     }
502
503   __libc_lock_unlock (lock);
504 }
505
506
507 /* Read all configuration files found in the user-specified and the default
508    path.  */
509 void
510 __gconv_read_conf (void)
511 {
512   void *modules = NULL;
513   size_t nmodules = 0;
514   int save_errno = errno;
515   size_t cnt;
516
517   /* Find out where we have to look.  */
518   if (__gconv_path_elem == NULL)
519     __gconv_get_path ();
520
521   for (cnt = 0; __gconv_path_elem[cnt].name != NULL; ++cnt)
522     {
523       const char *elem = __gconv_path_elem[cnt].name;
524       size_t elem_len = __gconv_path_elem[cnt].len;
525       char *filename;
526
527       /* No slash needs to be inserted between elem and gconv_conf_filename;
528          elem already ends in a slash.  */
529       filename = alloca (elem_len + sizeof (gconv_conf_filename));
530       __mempcpy (__mempcpy (filename, elem, elem_len),
531                  gconv_conf_filename, sizeof (gconv_conf_filename));
532
533       /* Read the next configuration file.  */
534       read_conf_file (filename, elem, elem_len, &modules, &nmodules);
535     }
536
537   /* Add the internal modules.  */
538   for (cnt = 0; cnt < sizeof (builtin_modules) / sizeof (builtin_modules[0]);
539        ++cnt)
540     {
541       struct gconv_alias fake_alias;
542
543       fake_alias.fromname = builtin_modules[cnt].from_string;
544
545       if (__tfind (&fake_alias, &__gconv_alias_db, __gconv_alias_compare)
546           != NULL)
547         /* It'll conflict so don't add it.  */
548         continue;
549
550       insert_module (&builtin_modules[cnt], 0);
551     }
552
553   /* Add aliases for builtin conversions.  */
554   cnt = sizeof (builtin_aliases) / sizeof (builtin_aliases[0]);
555   while (cnt > 0)
556     {
557       char *copy = strdupa (builtin_aliases[--cnt]);
558       add_alias (copy, modules);
559     }
560
561   /* Restore the error number.  */
562   __set_errno (save_errno);
563 }
564
565
566
567 /* Free all resources if necessary.  */
568 static void __attribute__ ((unused))
569 free_mem (void)
570 {
571   if (__gconv_path_elem != NULL && __gconv_path_elem != &empty_path_elem)
572     free ((void *) __gconv_path_elem);
573 }
574
575 text_set_element (__libc_subfreeres, free_mem);