locale/setlocale.c

   1 /* Copyright (C) 1991, 92, 95-99, 2000, 2002 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Lesser General Public
   6    License as published by the Free Software Foundation; either
   7    version 2.1 of the License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Lesser General Public License for more details.
  13
  14    You should have received a copy of the GNU Lesser General Public
  15    License along with the GNU C Library; if not, write to the Free
  16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  17    02111-1307 USA.  */
  18
  19 #include <alloca.h>
  20 #include <argz.h>
  21 #include <errno.h>
  22 #include <bits/libc-lock.h>
  23 #include <locale.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27
  28 #include "localeinfo.h"
  29
  30 #ifdef NL_CURRENT_INDIRECT
  31
  32 /* For each category declare a special external symbol
  33    _nl_current_CATEGORY_used with a weak reference.
  34    This symbol will is defined in lc-CATEGORY.c and will be linked in
  35    if anything uses _nl_current_CATEGORY (also defined in that module).
  36    Also use a weak reference for the _nl_current_CATEGORY thread variable.  */
  37
  38 # define DEFINE_CATEGORY(category, category_name, items, a) \
  39     extern char _nl_current_##category##_used; \
  40     weak_extern (_nl_current_##category##_used) \
  41     weak_extern (_nl_current_##category)
  42 # include "categories.def"
  43 # undef DEFINE_CATEGORY
  44
  45 /* Now define a table of flags based on those special weak symbols' values.
  46    _nl_current_used[CATEGORY] will be zero if _nl_current_CATEGORY is not
  47    linked in.  */
  48 static char *const _nl_current_used[] =
  49   {
  50 # define DEFINE_CATEGORY(category, category_name, items, a) \
  51     [category] = &_nl_current_##category##_used,
  52 # include "categories.def"
  53 # undef DEFINE_CATEGORY
  54   };
  55
  56 # define CATEGORY_USED(category)        (_nl_current_used[category] != 0)
  57
  58 #else
  59
  60 /* The shared library always loads all the categories,
  61    and the current global settings are kept in _nl_global_locale.  */
  62
  63 # define CATEGORY_USED(category)        (1)
  64
  65 #endif
  66
  67
  68 /* Define an array of category names (also the environment variable names),
  69    indexed by integral category.  */
  70 const char *const _nl_category_names[] =
  71   {
  72 #define DEFINE_CATEGORY(category, category_name, items, a) \
  73     [category] = category_name,
  74 #include "categories.def"
  75 #undef  DEFINE_CATEGORY
  76     [LC_ALL] = "LC_ALL"
  77   };
  78 /* An array of their lengths, for convenience.  */
  79 const size_t _nl_category_name_sizes[] =
  80   {
  81 #define DEFINE_CATEGORY(category, category_name, items, a) \
  82     [category] = sizeof (category_name) - 1,
  83 #include "categories.def"
  84 #undef  DEFINE_CATEGORY
  85     [LC_ALL] = sizeof ("LC_ALL") - 1
  86   };
  87
  88
  89 /* Declare the postload functions used below.  */
  90 #undef  NO_POSTLOAD
  91 #define NO_POSTLOAD _nl_postload_ctype /* Harmless thing known to exist.  */
  92 #define DEFINE_CATEGORY(category, category_name, items, postload) \
  93 extern void postload (void); weak_extern (postload)
  94 #include "categories.def"
  95 #undef  DEFINE_CATEGORY
  96 #undef  NO_POSTLOAD
  97
  98 /* Define an array indexed by category of postload functions to call after
  99    loading and installing that category's data.  */
 100 static void (*const _nl_category_postload[]) (void) =
 101   {
 102 #define DEFINE_CATEGORY(category, category_name, items, postload) \
 103     [category] = postload,
 104 #include "categories.def"
 105 #undef  DEFINE_CATEGORY
 106   };
 107
 108
 109 /* Lock for protecting global data.  */
 110 __libc_lock_define_initialized (, __libc_setlocale_lock attribute_hidden)
 111
 112 /* Defined in loadmsgcat.c.  */
 113 extern int _nl_msg_cat_cntr;
 114
 115
 116 /* Use this when we come along an error.  */
 117 #define ERROR_RETURN                                                          \
 118   do {                                                                        \
 119     __set_errno (EINVAL);                                                     \
 120     return NULL;                                                              \
 121   } while (0)
 122
 123
 124 /* Construct a new composite name.  */
 125 static inline char *
 126 new_composite_name (int category, const char *newnames[__LC_LAST])
 127 {
 128   size_t last_len = 0;
 129   size_t cumlen = 0;
 130   int i;
 131   char *new, *p;
 132   int same = 1;
 133
 134   for (i = 0; i < __LC_LAST; ++i)
 135     if (i != LC_ALL)
 136       {
 137         const char *name = (category == LC_ALL ? newnames[i] :
 138                             category == i ? newnames[0] :
 139                             _nl_current_names[i]);
 140         last_len = strlen (name);
 141         cumlen += _nl_category_name_sizes[i] + 1 + last_len + 1;
 142         if (i > 0 && same && strcmp (name, newnames[0]) != 0)
 143           same = 0;
 144       }
 145
 146   if (same)
 147     {
 148       /* All the categories use the same name.  */
 149       if (strcmp (newnames[0], _nl_C_name) == 0
 150           || strcmp (newnames[0], _nl_POSIX_name) == 0)
 151         return (char *) _nl_C_name;
 152
 153       new = malloc (last_len + 1);
 154
 155       return new == NULL ? NULL : memcpy (new, newnames[0], last_len + 1);
 156     }
 157
 158   new = malloc (cumlen);
 159   if (new == NULL)
 160     return NULL;
 161   p = new;
 162   for (i = 0; i < __LC_LAST; ++i)
 163     if (i != LC_ALL)
 164       {
 165         /* Add "CATEGORY=NAME;" to the string.  */
 166         const char *name = (category == LC_ALL ? newnames[i] :
 167                             category == i ? newnames[0] :
 168                             _nl_current_names[i]);
 169         p = __stpcpy (p, _nl_category_names[i]);
 170         *p++ = '=';
 171         p = __stpcpy (p, name);
 172         *p++ = ';';
 173       }
 174   p[-1] = '\0';         /* Clobber the last ';'.  */
 175   return new;
 176 }
 177
 178
 179 /* Put NAME in _nl_current_names.  */
 180 static inline void
 181 setname (int category, const char *name)
 182 {
 183   if (_nl_current_names[category] == name)
 184     return;
 185
 186   if (_nl_current_names[category] != _nl_C_name)
 187     free ((char *) _nl_current_names[category]);
 188
 189   _nl_current_names[category] = name;
 190 }
 191
 192 /* Put DATA in *_nl_current[CATEGORY].  */
 193 static inline void
 194 setdata (int category, struct locale_data *data)
 195 {
 196   if (CATEGORY_USED (category))
 197     {
 198       _nl_global_locale.__locales[category] = data;
 199       if (_nl_category_postload[category])
 200         (*_nl_category_postload[category]) ();
 201     }
 202 }
 203
 204 char *
 205 setlocale (int category, const char *locale)
 206 {
 207   char *locale_path;
 208   size_t locale_path_len;
 209   const char *locpath_var;
 210   char *composite;
 211
 212   /* Sanity check for CATEGORY argument.  */
 213   if (__builtin_expect (category, 0) < 0
 214       || __builtin_expect (category, 0) >= __LC_LAST)
 215     ERROR_RETURN;
 216
 217   /* Does user want name of current locale?  */
 218   if (locale == NULL)
 219     return (char *) _nl_current_names[category];
 220
 221   if (strcmp (locale, _nl_current_names[category]) == 0)
 222     /* Changing to the same thing.  */
 223     return (char *) _nl_current_names[category];
 224
 225   /* We perhaps really have to load some data.  So we determine the
 226      path in which to look for the data now.  The environment variable
 227      `LOCPATH' must only be used when the binary has no SUID or SGID
 228      bit set.  If using the default path, we tell _nl_find_locale
 229      by passing null and it can check the canonical locale archive.  */
 230   locale_path = NULL;
 231   locale_path_len = 0;
 232
 233   locpath_var = getenv ("LOCPATH");
 234   if (locpath_var != NULL && locpath_var[0] != '\0')
 235     {
 236       if (__argz_create_sep (locpath_var, ':',
 237                              &locale_path, &locale_path_len) != 0)
 238         return NULL;
 239
 240       if (__argz_add_sep (&locale_path, &locale_path_len,
 241                           _nl_default_locale_path, ':') != 0)
 242         return NULL;
 243     }
 244
 245   if (category == LC_ALL)
 246     {
 247       /* The user wants to set all categories.  The desired locales
 248          for the individual categories can be selected by using a
 249          composite locale name.  This is a semi-colon separated list
 250          of entries of the form `CATEGORY=VALUE'.  */
 251       const char *newnames[__LC_LAST];
 252       struct locale_data *newdata[__LC_LAST];
 253
 254       /* Set all name pointers to the argument name.  */
 255       for (category = 0; category < __LC_LAST; ++category)
 256         if (category != LC_ALL)
 257           newnames[category] = (char *) locale;
 258
 259       if (__builtin_expect (strchr (locale, ';') != NULL, 0))
 260         {
 261           /* This is a composite name.  Make a copy and split it up.  */
 262           char *np = strdupa (locale);
 263           char *cp;
 264           int cnt;
 265
 266           while ((cp = strchr (np, '=')) != NULL)
 267             {
 268               for (cnt = 0; cnt < __LC_LAST; ++cnt)
 269                 if (cnt != LC_ALL
 270                     && (size_t) (cp - np) == _nl_category_name_sizes[cnt]
 271                     && memcmp (np, _nl_category_names[cnt], cp - np) == 0)
 272                   break;
 273
 274               if (cnt == __LC_LAST)
 275                 /* Bogus category name.  */
 276                 ERROR_RETURN;
 277
 278               /* Found the category this clause sets.  */
 279               newnames[cnt] = ++cp;
 280               cp = strchr (cp, ';');
 281               if (cp != NULL)
 282                 {
 283                   /* Examine the next clause.  */
 284                   *cp = '\0';
 285                   np = cp + 1;
 286                 }
 287               else
 288                 /* This was the last clause.  We are done.  */
 289                 break;
 290             }
 291
 292           for (cnt = 0; cnt < __LC_LAST; ++cnt)
 293             if (cnt != LC_ALL && newnames[cnt] == locale)
 294               /* The composite name did not specify all categories.  */
 295               ERROR_RETURN;
 296         }
 297
 298       /* Protect global data.  */
 299       __libc_lock_lock (__libc_setlocale_lock);
 300
 301       /* Load the new data for each category.  */
 302       while (category-- > 0)
 303         if (category != LC_ALL)
 304           {
 305             newdata[category] = _nl_find_locale (locale_path, locale_path_len,
 306                                                  category,
 307                                                  &newnames[category]);
 308
 309             if (newdata[category] == NULL)
 310               break;
 311
 312             /* We must not simply free a global locale since we have no
 313                control over the usage.  So we mark it as un-deletable.  */
 314             if (newdata[category]->usage_count != UNDELETABLE)
 315               newdata[category]->usage_count = UNDELETABLE;
 316
 317             /* Make a copy of locale name.  */
 318             if (newnames[category] != _nl_C_name)
 319               {
 320                 newnames[category] = strdup (newnames[category]);
 321                 if (newnames[category] == NULL)
 322                   break;
 323               }
 324           }
 325
 326       /* Create new composite name.  */
 327       composite = (category >= 0
 328                    ? NULL : new_composite_name (LC_ALL, newnames));
 329       if (composite != NULL)
 330         {
 331           /* Now we have loaded all the new data.  Put it in place.  */
 332           for (category = 0; category < __LC_LAST; ++category)
 333             if (category != LC_ALL)
 334               {
 335                 setdata (category, newdata[category]);
 336                 setname (category, newnames[category]);
 337               }
 338           setname (LC_ALL, composite);
 339
 340           /* We successfully loaded a new locale.  Let the message catalog
 341              functions know about this.  */
 342           ++_nl_msg_cat_cntr;
 343         }
 344       else
 345         for (++category; category < __LC_LAST; ++category)
 346           if (category != LC_ALL && newnames[category] != _nl_C_name)
 347             free ((char *) newnames[category]);
 348
 349       /* Critical section left.  */
 350       __libc_lock_unlock (__libc_setlocale_lock);
 351
 352       /* Free the resources (the locale path variable.  */
 353       free (locale_path);
 354
 355       return composite;
 356     }
 357   else
 358     {
 359       struct locale_data *newdata = NULL;
 360       const char *newname[1] = { locale };
 361
 362       /* Protect global data.  */
 363       __libc_lock_lock (__libc_setlocale_lock);
 364
 365       if (CATEGORY_USED (category))
 366         {
 367           /* Only actually load the data if anything will use it.  */
 368           newdata = _nl_find_locale (locale_path, locale_path_len, category,
 369                                      &newname[0]);
 370           if (newdata == NULL)
 371             goto abort_single;
 372
 373           /* We must not simply free a global locale since we have no
 374              control over the usage.  So we mark it as un-deletable.
 375
 376              Note: do not remove the `if', it's necessary to copy with
 377              the builtin locale data.  */
 378           if (newdata->usage_count != UNDELETABLE)
 379             newdata->usage_count = UNDELETABLE;
 380         }
 381
 382       /* Make a copy of locale name.  */
 383       if (newname[0] != _nl_C_name)
 384         {
 385           newname[0] = strdup (newname[0]);
 386           if (newname[0] == NULL)
 387             goto abort_single;
 388         }
 389
 390       /* Create new composite name.  */
 391       composite = new_composite_name (category, newname);
 392       if (composite == NULL)
 393         {
 394           if (newname[0] != _nl_C_name)
 395             free ((char *) newname[0]);
 396
 397           /* Say that we don't have any data loaded.  */
 398         abort_single:
 399           newname[0] = NULL;
 400         }
 401       else
 402         {
 403           if (CATEGORY_USED (category))
 404             setdata (category, newdata);
 405
 406           setname (category, newname[0]);
 407           setname (LC_ALL, composite);
 408
 409           /* We successfully loaded a new locale.  Let the message catalog
 410              functions know about this.  */
 411           ++_nl_msg_cat_cntr;
 412         }
 413
 414       /* Critical section left.  */
 415       __libc_lock_unlock (__libc_setlocale_lock);
 416
 417       /* Free the resources (the locale path variable.  */
 418       free (locale_path);
 419
 420       return (char *) newname[0];
 421     }
 422 }
 423 libc_hidden_def (setlocale)
 424
 425 static void
 426 free_category (int category,
 427                struct locale_data *here, struct locale_data *c_data)
 428 {
 429   struct loaded_l10nfile *runp = _nl_locale_file_list[category];
 430
 431   /* If this category is already "C" don't do anything.  */
 432   if (here != c_data)
 433     {
 434       /* We have to be prepared that sometime later we still
 435          might need the locale information.  */
 436       setdata (category, c_data);
 437       setname (category, _nl_C_name);
 438     }
 439
 440   while (runp != NULL)
 441     {
 442       struct loaded_l10nfile *curr = runp;
 443       struct locale_data *data = (struct locale_data *) runp->data;
 444
 445       if (data != NULL && data != c_data)
 446         _nl_unload_locale (data);
 447       runp = runp->next;
 448       free ((char *) curr->filename);
 449       free (curr);
 450     }
 451 }
 452
 453 static void __attribute__ ((unused))
 454 free_mem (void)
 455 {
 456 #ifdef NL_CURRENT_INDIRECT
 457   /* We don't use the loop because we want to have individual weak
 458      symbol references here.  */
 459 # define DEFINE_CATEGORY(category, category_name, items, a)                   \
 460   if (CATEGORY_USED (category))                                               \
 461     {                                                                         \
 462       extern struct locale_data _nl_C_##category;                             \
 463       weak_extern (_nl_C_##category)                                          \
 464       free_category (category, *_nl_current_##category, &_nl_C_##category);   \
 465     }
 466 # include "categories.def"
 467 # undef DEFINE_CATEGORY
 468 #else
 469   int category;
 470
 471   for (category = 0; category < __LC_LAST; ++category)
 472     if (category != LC_ALL)
 473       free_category (category, _NL_CURRENT_DATA (category),
 474                      _nl_C_locobj.__locales[category]);
 475 #endif
 476
 477   setname (LC_ALL, _nl_C_name);
 478
 479   /* This frees the data structures associated with the locale archive.
 480      The locales from the archive are not in the file list, so we have
 481      not called _nl_unload_locale on them above.  */
 482   _nl_archive_subfreeres ();
 483 }
 484 text_set_element (__libc_subfreeres, free_mem);