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