locale/loadlocale.c

   1 /* Functions to read locale data files.
   2    Copyright (C) 1996-2001, 2002 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1996.
   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 <errno.h>
  23 #include <fcntl.h>
  24 #include <locale.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28 #ifdef _POSIX_MAPPED_FILES
  29 # include <sys/mman.h>
  30 #endif
  31 #include <sys/stat.h>
  32
  33 #include "localeinfo.h"
  34
  35
  36 static const size_t _nl_category_num_items[] =
  37 {
  38 #define DEFINE_CATEGORY(category, category_name, items, a) \
  39   [category] = _NL_ITEM_INDEX (_NL_NUM_##category),
  40 #include "categories.def"
  41 #undef  DEFINE_CATEGORY
  42 };
  43
  44
  45 #define NO_PAREN(arg, rest...) arg, ##rest
  46
  47 #define DEFINE_CATEGORY(category, category_name, items, a) \
  48 static const enum value_type _nl_value_type_##category[] = { NO_PAREN items };
  49 #define DEFINE_ELEMENT(element, element_name, optstd, type, rest...) \
  50   [_NL_ITEM_INDEX (element)] = type,
  51 #include "categories.def"
  52 #undef DEFINE_CATEGORY
  53
  54 static const enum value_type *_nl_value_types[] =
  55 {
  56 #define DEFINE_CATEGORY(category, category_name, items, a) \
  57   [category] = _nl_value_type_##category,
  58 #include "categories.def"
  59 #undef DEFINE_CATEGORY
  60 };
  61
  62
  63 struct locale_data *
  64 internal_function
  65 _nl_intern_locale_data (int category, const void *data, size_t datasize)
  66 {
  67   const struct
  68     {
  69       unsigned int magic;
  70       unsigned int nstrings;
  71       unsigned int strindex[0];
  72     } *const filedata = data;
  73   struct locale_data *newdata;
  74   size_t cnt;
  75
  76   if (__builtin_expect (datasize < sizeof *filedata, 0)
  77       || __builtin_expect (filedata->magic != LIMAGIC (category), 0))
  78     {
  79       /* Bad data file.  */
  80       __set_errno (EINVAL);
  81       return NULL;
  82     }
  83
  84   if (__builtin_expect (filedata->nstrings < _nl_category_num_items[category],
  85                         0)
  86       || (__builtin_expect (sizeof *filedata
  87                             + filedata->nstrings * sizeof (unsigned int)
  88                             >= datasize, 0)))
  89     {
  90       /* Insufficient data.  */
  91       __set_errno (EINVAL);
  92       return NULL;
  93     }
  94
  95   newdata = malloc (sizeof *newdata
  96                     + filedata->nstrings * sizeof (union locale_data_value));
  97   if (newdata == NULL)
  98     return NULL;
  99
 100   newdata->filedata = (void *) filedata;
 101   newdata->filesize = datasize;
 102   newdata->private.data = NULL;
 103   newdata->private.cleanup = NULL;
 104   newdata->usage_count = 0;
 105   newdata->use_translit = 0;
 106   newdata->nstrings = filedata->nstrings;
 107   for (cnt = 0; cnt < newdata->nstrings; ++cnt)
 108     {
 109       size_t idx = filedata->strindex[cnt];
 110       if (__builtin_expect (idx > (size_t) newdata->filesize, 0))
 111         {
 112         puntdata:
 113           free (newdata);
 114           __set_errno (EINVAL);
 115           return NULL;
 116         }
 117       if (__builtin_expect (_nl_value_types[category][cnt] == word, 0))
 118         {
 119           if (idx % __alignof__ (u_int32_t) != 0)
 120             goto puntdata;
 121           newdata->values[cnt].word =
 122             *((const u_int32_t *) (newdata->filedata + idx));
 123         }
 124       else
 125         newdata->values[cnt].string = newdata->filedata + idx;
 126     }
 127
 128   return newdata;
 129 }
 130
 131 void
 132 internal_function
 133 _nl_load_locale (struct loaded_l10nfile *file, int category)
 134 {
 135   int fd;
 136   void *filedata;
 137   struct stat64 st;
 138   struct locale_data *newdata;
 139   int save_err;
 140   int alloc = ld_mapped;
 141
 142   file->decided = 1;
 143   file->data = NULL;
 144
 145   fd = __open (file->filename, O_RDONLY);
 146   if (__builtin_expect (fd, 0) < 0)
 147     /* Cannot open the file.  */
 148     return;
 149
 150   if (__builtin_expect (__fxstat64 (_STAT_VER, fd, &st), 0) < 0)
 151     {
 152     puntfd:
 153       __close (fd);
 154       return;
 155     }
 156   if (__builtin_expect (S_ISDIR (st.st_mode), 0))
 157     {
 158       /* LOCALE/LC_foo is a directory; open LOCALE/LC_foo/SYS_LC_foo
 159            instead.  */
 160       char *newp;
 161       size_t filenamelen;
 162
 163       __close (fd);
 164
 165       filenamelen = strlen (file->filename);
 166       newp = (char *) alloca (filenamelen
 167                               + 5 + _nl_category_name_sizes[category] + 1);
 168       __mempcpy (__mempcpy (__mempcpy (newp, file->filename, filenamelen),
 169                             "/SYS_", 5),
 170                  _nl_category_names[category],
 171                  _nl_category_name_sizes[category] + 1);
 172
 173       fd = __open (newp, O_RDONLY);
 174       if (__builtin_expect (fd, 0) < 0)
 175         return;
 176
 177       if (__builtin_expect (__fxstat64 (_STAT_VER, fd, &st), 0) < 0)
 178         goto puntfd;
 179     }
 180
 181   /* Map in the file's data.  */
 182   save_err = errno;
 183 #ifdef _POSIX_MAPPED_FILES
 184 # ifndef MAP_COPY
 185   /* Linux seems to lack read-only copy-on-write.  */
 186 #  define MAP_COPY MAP_PRIVATE
 187 # endif
 188 # ifndef MAP_FILE
 189   /* Some systems do not have this flag; it is superfluous.  */
 190 #  define MAP_FILE 0
 191 # endif
 192   filedata = __mmap ((caddr_t) 0, st.st_size,
 193                      PROT_READ, MAP_FILE|MAP_COPY, fd, 0);
 194   if (__builtin_expect (filedata == MAP_FAILED, 0))
 195     {
 196       if (__builtin_expect (errno, ENOSYS) == ENOSYS)
 197         {
 198 #endif  /* _POSIX_MAPPED_FILES */
 199           /* No mmap; allocate a buffer and read from the file.  */
 200           alloc = ld_malloced;
 201           filedata = malloc (st.st_size);
 202           if (filedata != NULL)
 203             {
 204               off_t to_read = st.st_size;
 205               ssize_t nread;
 206               char *p = (char *) filedata;
 207               while (to_read > 0)
 208                 {
 209                   nread = __read (fd, p, to_read);
 210                   if (__builtin_expect (nread, 1) <= 0)
 211                     {
 212                       free (filedata);
 213                       if (nread == 0)
 214                         __set_errno (EINVAL); /* Bizarreness going on.  */
 215                       goto puntfd;
 216                     }
 217                   p += nread;
 218                   to_read -= nread;
 219                 }
 220               __set_errno (save_err);
 221             }
 222 #ifdef _POSIX_MAPPED_FILES
 223         }
 224     }
 225 #endif  /* _POSIX_MAPPED_FILES */
 226
 227   /* We have mapped the data, so we no longer need the descriptor.  */
 228   __close (fd);
 229
 230   if (__builtin_expect (filedata == NULL, 0))
 231     /* We failed to map or read the data.  */
 232     return;
 233
 234   newdata = _nl_intern_locale_data (category, filedata, st.st_size);
 235   if (__builtin_expect (newdata == NULL, 0))
 236     /* Bad data.  */
 237     {
 238 #ifdef _POSIX_MAPPED_FILES
 239       if (alloc == ld_mapped)
 240         __munmap ((caddr_t) filedata, st.st_size);
 241 #endif
 242       return;
 243     }
 244
 245   /* _nl_intern_locale_data leaves us these fields to initialize.  */
 246   newdata->name = NULL; /* This will be filled if necessary in findlocale.c. */
 247   newdata->alloc = alloc;
 248
 249   file->data = newdata;
 250 }
 251
 252 void
 253 internal_function
 254 _nl_unload_locale (struct locale_data *locale)
 255 {
 256   if (locale->private.cleanup)
 257     (*locale->private.cleanup) (locale);
 258
 259   switch (__builtin_expect (locale->alloc, ld_mapped))
 260     {
 261     case ld_malloced:
 262       free ((void *) locale->filedata);
 263       break;
 264     case ld_mapped:
 265 #ifdef _POSIX_MAPPED_FILES
 266       __munmap ((caddr_t) locale->filedata, locale->filesize);
 267       break;
 268 #endif
 269     case ld_archive:            /* Nothing to do.  */
 270       break;
 271     }
 272
 273   if (__builtin_expect (locale->alloc, ld_mapped) != ld_archive)
 274     free ((char *) locale->name);
 275
 276   free (locale);
 277 }