]> git.ipfire.org Git - thirdparty/glibc.git/blobdiff - locale/setlocale.c
Update copyright dates with scripts/update-copyrights
[thirdparty/glibc.git] / locale / setlocale.c
index 08f2a034d1dba0a1132f22d6c46ec137cadb96c0..7bd27e5398e7a21139c7d52ef4d5e8a063cbc86e 100644 (file)
@@ -1,25 +1,24 @@
-/* Copyright (C) 1991, 92, 95-99, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1991-2024 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it and/or
-   modify it under the terms of the GNU Library General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 2.1 of the License, or (at your option) any later version.
 
    The GNU C Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   Library General Public License for more details.
+   Lesser General Public License for more details.
 
-   You should have received a copy of the GNU Library General Public
-   License along with the GNU C Library; see the file COPYING.LIB.  If not,
-   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, see
+   <https://www.gnu.org/licenses/>.  */
 
 #include <alloca.h>
 #include <argz.h>
 #include <errno.h>
-#include <bits/libc-lock.h>
+#include <libc-lock.h>
 #include <locale.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include "localeinfo.h"
 
-/* For each category declare two external variables (with weak references):
-     extern const struct locale_data *_nl_current_CATEGORY;
-   This points to the current locale's in-core data for CATEGORY.
-     extern const struct locale_data _nl_C_CATEGORY;
-   This contains the built-in "C"/"POSIX" locale's data for CATEGORY.
-   Both are weak references; if &_nl_current_CATEGORY is zero,
-   then nothing is using the locale data.  */
-#define DEFINE_CATEGORY(category, category_name, items, a) \
-extern struct locale_data *_nl_current_##category;                           \
-extern struct locale_data _nl_C_##category;
-#include "categories.def"
-#undef DEFINE_CATEGORY
-
-/* Array indexed by category of pointers to _nl_current_CATEGORY slots.
-   Elements are zero for categories whose data is never used.  */
-struct locale_data * *const _nl_current[] =
+#ifdef NL_CURRENT_INDIRECT
+
+/* For each category declare a special external symbol
+   _nl_current_CATEGORY_used with a weak reference.
+   This symbol will is defined in lc-CATEGORY.c and will be linked in
+   if anything uses _nl_current_CATEGORY (also defined in that module).
+   Also use a weak reference for the _nl_current_CATEGORY thread variable.  */
+
+# define DEFINE_CATEGORY(category, category_name, items, a) \
+    extern char _nl_current_##category##_used; \
+    weak_extern (_nl_current_##category##_used) \
+    weak_extern (_nl_current_##category)
+# include "categories.def"
+# undef        DEFINE_CATEGORY
+
+/* Now define a table of flags based on those special weak symbols' values.
+   _nl_current_used[CATEGORY] will be zero if _nl_current_CATEGORY is not
+   linked in.  */
+static char *const _nl_current_used[] =
   {
-#define DEFINE_CATEGORY(category, category_name, items, a) \
-    [category] = &_nl_current_##category,
-#include "categories.def"
-#undef DEFINE_CATEGORY
-    /* We need this additional element to simplify the code.  It must
-       simply be != NULL.  */
-    [LC_ALL] = (struct locale_data **) ~0ul
+# define DEFINE_CATEGORY(category, category_name, items, a) \
+    [category] = &_nl_current_##category##_used,
+# include "categories.def"
+# undef        DEFINE_CATEGORY
   };
 
-/* Array indexed by category of pointers to _nl_C_CATEGORY slots.
-   Elements are zero for categories whose data is never used.  */
-struct locale_data *const _nl_C[] =
+# define CATEGORY_USED(category)       (_nl_current_used[category] != 0)
+
+#else
+
+/* The shared library always loads all the categories,
+   and the current global settings are kept in _nl_global_locale.  */
+
+# define CATEGORY_USED(category)       (1)
+
+#endif
+
+
+/* Define an array of category names (also the environment variable names).  */
+const struct catnamestr_t _nl_category_names attribute_hidden =
   {
 #define DEFINE_CATEGORY(category, category_name, items, a) \
-    [category] = &_nl_C_##category,
+    category_name,
 #include "categories.def"
-#undef DEFINE_CATEGORY
+#undef DEFINE_CATEGORY
   };
 
-
-/* Define an array of category names (also the environment variable names),
-   indexed by integral category.  */
-const char *const _nl_category_names[] =
+const uint8_t _nl_category_name_idxs[__LC_LAST] attribute_hidden =
   {
 #define DEFINE_CATEGORY(category, category_name, items, a) \
-    [category] = category_name,
+    [category] = offsetof (struct catnamestr_t, CATNAMEMF (__LINE__)),
 #include "categories.def"
-#undef DEFINE_CATEGORY
-    [LC_ALL] = "LC_ALL"
+#undef DEFINE_CATEGORY
   };
+
 /* An array of their lengths, for convenience.  */
-const size_t _nl_category_name_sizes[] =
+const uint8_t _nl_category_name_sizes[] attribute_hidden =
   {
 #define DEFINE_CATEGORY(category, category_name, items, a) \
     [category] = sizeof (category_name) - 1,
@@ -85,11 +92,17 @@ const size_t _nl_category_name_sizes[] =
   };
 
 
+#ifdef NL_CURRENT_INDIRECT
+# define WEAK_POSTLOAD(postload) weak_extern (postload)
+#else
+# define WEAK_POSTLOAD(postload) /* Need strong refs in static linking.  */
+#endif
+
 /* Declare the postload functions used below.  */
 #undef NO_POSTLOAD
 #define NO_POSTLOAD _nl_postload_ctype /* Harmless thing known to exist.  */
 #define DEFINE_CATEGORY(category, category_name, items, postload) \
-extern void postload (void);
+extern void postload (void); WEAK_POSTLOAD (postload)
 #include "categories.def"
 #undef DEFINE_CATEGORY
 #undef NO_POSTLOAD
@@ -105,20 +118,11 @@ static void (*const _nl_category_postload[]) (void) =
   };
 
 
-/* Name of current locale for each individual category.
-   Each is malloc'd unless it is nl_C_name.  */
-static const char *_nl_current_names[] =
-  {
-#define DEFINE_CATEGORY(category, category_name, items, a) \
-    [category] = _nl_C_name,
-#include "categories.def"
-#undef DEFINE_CATEGORY
-    [LC_ALL] = _nl_C_name              /* For LC_ALL.  */
-  };
-
-
 /* Lock for protecting global data.  */
-__libc_lock_define_initialized (, __libc_setlocale_lock)
+__libc_rwlock_define_initialized (, __libc_setlocale_lock attribute_hidden)
+
+/* Defined in loadmsgcat.c.  */
+extern int _nl_msg_cat_cntr;
 
 
 /* Use this when we come along an error.  */
@@ -130,8 +134,8 @@ __libc_lock_define_initialized (, __libc_setlocale_lock)
 
 
 /* Construct a new composite name.  */
-static inline char *
-new_composite_name (int category, const char *newnames[__LC_LAST])
+static char *
+new_composite_name (int category, const char **newnames)
 {
   size_t last_len = 0;
   size_t cumlen = 0;
@@ -142,12 +146,12 @@ new_composite_name (int category, const char *newnames[__LC_LAST])
   for (i = 0; i < __LC_LAST; ++i)
     if (i != LC_ALL)
       {
-       const char *name = (category == LC_ALL ? newnames[i] :
-                           category == i ? newnames[0] :
-                           _nl_current_names[i]);
+       const char *name = (category == LC_ALL ? newnames[i]
+                           : category == i ? newnames[0]
+                           : _nl_global_locale.__names[i]);
        last_len = strlen (name);
        cumlen += _nl_category_name_sizes[i] + 1 + last_len + 1;
-       if (i > 0 && same && strcmp (name, newnames[0]) != 0)
+       if (same && name != newnames[0] && strcmp (name, newnames[0]) != 0)
          same = 0;
       }
 
@@ -171,10 +175,10 @@ new_composite_name (int category, const char *newnames[__LC_LAST])
     if (i != LC_ALL)
       {
        /* Add "CATEGORY=NAME;" to the string.  */
-       const char *name = (category == LC_ALL ? newnames[i] :
-                           category == i ? newnames[0] :
-                           _nl_current_names[i]);
-       p = __stpcpy (p, _nl_category_names[i]);
+       const char *name = (category == LC_ALL ? newnames[i]
+                           : category == i ? newnames[0]
+                           : _nl_global_locale.__names[i]);
+       p = __stpcpy (p, _nl_category_names_get (i));
        *p++ = '=';
        p = __stpcpy (p, name);
        *p++ = ';';
@@ -184,33 +188,31 @@ new_composite_name (int category, const char *newnames[__LC_LAST])
 }
 
 
-/* Put NAME in _nl_current_names.  */
-static inline void
+/* Put NAME in _nl_global_locale.__names.  */
+static void
 setname (int category, const char *name)
 {
-  if (_nl_current_names[category] == name)
+  if (_nl_global_locale.__names[category] == name)
     return;
 
-  if (category == LC_ALL && _nl_current_names[category] != _nl_C_name)
-    free ((char *) _nl_current_names[category]);
+  if (_nl_global_locale.__names[category] != _nl_C_name)
+    free ((char *) _nl_global_locale.__names[category]);
 
-  _nl_current_names[category] = name;
+  _nl_global_locale.__names[category] = name;
 }
 
-
 /* Put DATA in *_nl_current[CATEGORY].  */
-static inline void
-setdata (int category, struct locale_data *data)
+static void
+setdata (int category, struct __locale_data *data)
 {
-  if (_nl_current[category] != NULL)
+  if (CATEGORY_USED (category))
     {
-      *_nl_current[category] = data;
+      _nl_global_locale.__locales[category] = data;
       if (_nl_category_postload[category])
        (*_nl_category_postload[category]) ();
     }
 }
 
-
 char *
 setlocale (int category, const char *locale)
 {
@@ -226,27 +228,39 @@ setlocale (int category, const char *locale)
 
   /* Does user want name of current locale?  */
   if (locale == NULL)
-    return (char *) _nl_current_names[category];
+    return (char *) _nl_global_locale.__names[category];
 
-  if (strcmp (locale, _nl_current_names[category]) == 0)
-    /* Changing to the same thing.  */
-    return (char *) _nl_current_names[category];
+  /* Protect global data.  */
+  __libc_rwlock_wrlock (__libc_setlocale_lock);
+
+  if (strcmp (locale, _nl_global_locale.__names[category]) == 0)
+    {
+      /* Changing to the same thing.  */
+      __libc_rwlock_unlock (__libc_setlocale_lock);
+
+      return (char *) _nl_global_locale.__names[category];
+    }
 
   /* We perhaps really have to load some data.  So we determine the
      path in which to look for the data now.  The environment variable
      `LOCPATH' must only be used when the binary has no SUID or SGID
-     bit set.  */
+     bit set.  If using the default path, we tell _nl_find_locale
+     by passing null and it can check the canonical locale archive.  */
   locale_path = NULL;
   locale_path_len = 0;
 
   locpath_var = getenv ("LOCPATH");
   if (locpath_var != NULL && locpath_var[0] != '\0')
-    if (__argz_create_sep (locpath_var, ':',
-                          &locale_path, &locale_path_len) != 0)
-      return NULL;
-
-  if (__argz_add_sep (&locale_path, &locale_path_len, LOCALEDIR, ':') != 0)
-    return NULL;
+    {
+      if (__argz_create_sep (locpath_var, ':',
+                            &locale_path, &locale_path_len) != 0
+         || __argz_add_sep (&locale_path, &locale_path_len,
+                            _nl_default_locale_path, ':') != 0)
+       {
+         __libc_rwlock_unlock (__libc_setlocale_lock);
+         return NULL;
+       }
+    }
 
   if (category == LC_ALL)
     {
@@ -255,17 +269,25 @@ setlocale (int category, const char *locale)
         composite locale name.  This is a semi-colon separated list
         of entries of the form `CATEGORY=VALUE'.  */
       const char *newnames[__LC_LAST];
-      struct locale_data *newdata[__LC_LAST];
+      struct __locale_data *newdata[__LC_LAST];
+      /* Copy of the locale argument, for in-place splitting.  */
+      char *locale_copy = NULL;
 
       /* Set all name pointers to the argument name.  */
       for (category = 0; category < __LC_LAST; ++category)
        if (category != LC_ALL)
          newnames[category] = (char *) locale;
 
-      if (__builtin_expect (strchr (locale, ';') != NULL, 0))
+      if (__glibc_unlikely (strchr (locale, ';') != NULL))
        {
          /* This is a composite name.  Make a copy and split it up.  */
-         char *np = strdupa (locale);
+         locale_copy = __strdup (locale);
+         if (__glibc_unlikely (locale_copy == NULL))
+           {
+             __libc_rwlock_unlock (__libc_setlocale_lock);
+             return NULL;
+           }
+         char *np = locale_copy;
          char *cp;
          int cnt;
 
@@ -274,12 +296,19 @@ setlocale (int category, const char *locale)
              for (cnt = 0; cnt < __LC_LAST; ++cnt)
                if (cnt != LC_ALL
                    && (size_t) (cp - np) == _nl_category_name_sizes[cnt]
-                   && memcmp (np, _nl_category_names[cnt], cp - np) == 0)
+                   && (memcmp (np, (_nl_category_names_get (cnt)), cp - np)
+                       == 0))
                  break;
 
              if (cnt == __LC_LAST)
-               /* Bogus category name.  */
-               ERROR_RETURN;
+               {
+               error_return:
+                 __libc_rwlock_unlock (__libc_setlocale_lock);
+                 free (locale_copy);
+
+                 /* Bogus category name.  */
+                 ERROR_RETURN;
+               }
 
              /* Found the category this clause sets.  */
              newnames[cnt] = ++cp;
@@ -298,12 +327,9 @@ setlocale (int category, const char *locale)
          for (cnt = 0; cnt < __LC_LAST; ++cnt)
            if (cnt != LC_ALL && newnames[cnt] == locale)
              /* The composite name did not specify all categories.  */
-             ERROR_RETURN;
+             goto error_return;
        }
 
-      /* Protect global data.  */
-      __libc_lock_lock (__libc_setlocale_lock);
-
       /* Load the new data for each category.  */
       while (category-- > 0)
        if (category != LC_ALL)
@@ -313,12 +339,35 @@ setlocale (int category, const char *locale)
                                                 &newnames[category]);
 
            if (newdata[category] == NULL)
-             break;
+             {
+#ifdef NL_CURRENT_INDIRECT
+               if (newnames[category] == _nl_C_name)
+                 /* Null because it's the weak value of _nl_C_LC_FOO.  */
+                 continue;
+#endif
+               break;
+             }
 
-           /* We must not simply free a global locale since we have no
-              control over the usage.  So we mark it as un-deletable.  */
+           /* We must not simply free a global locale since we have
+              no control over the usage.  So we mark it as
+              un-deletable.  And yes, the 'if' is needed, the data
+              might be in read-only memory.  */
            if (newdata[category]->usage_count != UNDELETABLE)
              newdata[category]->usage_count = UNDELETABLE;
+
+           /* Make a copy of locale name.  */
+           if (newnames[category] != _nl_C_name)
+             {
+               if (strcmp (newnames[category],
+                           _nl_global_locale.__names[category]) == 0)
+                 newnames[category] = _nl_global_locale.__names[category];
+               else
+                 {
+                   newnames[category] = __strdup (newnames[category]);
+                   if (newnames[category] == NULL)
+                     break;
+                 }
+             }
          }
 
       /* Create new composite name.  */
@@ -334,25 +383,32 @@ setlocale (int category, const char *locale)
                setname (category, newnames[category]);
              }
          setname (LC_ALL, composite);
+
+         /* We successfully loaded a new locale.  Let the message catalog
+            functions know about this.  */
+         ++_nl_msg_cat_cntr;
        }
+      else
+       for (++category; category < __LC_LAST; ++category)
+         if (category != LC_ALL && newnames[category] != _nl_C_name
+             && newnames[category] != _nl_global_locale.__names[category])
+           free ((char *) newnames[category]);
 
       /* Critical section left.  */
-      __libc_lock_unlock (__libc_setlocale_lock);
+      __libc_rwlock_unlock (__libc_setlocale_lock);
 
-      /* Free the resources (the locale path variable.  */
+      /* Free the resources.  */
       free (locale_path);
+      free (locale_copy);
 
       return composite;
     }
   else
     {
-      struct locale_data *newdata = NULL;
+      struct __locale_data *newdata = NULL;
       const char *newname[1] = { locale };
 
-      /* Protect global data.  */
-      __libc_lock_lock (__libc_setlocale_lock);
-
-      if (_nl_current[category] != NULL)
+      if (CATEGORY_USED (category))
        {
          /* Only actually load the data if anything will use it.  */
          newdata = _nl_find_locale (locale_path, locale_path_len, category,
@@ -363,31 +419,46 @@ setlocale (int category, const char *locale)
          /* We must not simply free a global locale since we have no
             control over the usage.  So we mark it as un-deletable.
 
-            Note: do not remove the `if', it's necessary to copy with
+            Note: do not remove the `if', it's necessary to cope with
             the builtin locale data.  */
          if (newdata->usage_count != UNDELETABLE)
            newdata->usage_count = UNDELETABLE;
        }
 
+      /* Make a copy of locale name.  */
+      if (newname[0] != _nl_C_name)
+       {
+         newname[0] = __strdup (newname[0]);
+         if (newname[0] == NULL)
+           goto abort_single;
+       }
+
       /* Create new composite name.  */
       composite = new_composite_name (category, newname);
       if (composite == NULL)
        {
+         if (newname[0] != _nl_C_name)
+           free ((char *) newname[0]);
+
          /* Say that we don't have any data loaded.  */
        abort_single:
          newname[0] = NULL;
        }
       else
        {
-         if (_nl_current[category] != NULL)
+         if (CATEGORY_USED (category))
            setdata (category, newdata);
 
          setname (category, newname[0]);
          setname (LC_ALL, composite);
+
+         /* We successfully loaded a new locale.  Let the message catalog
+            functions know about this.  */
+         ++_nl_msg_cat_cntr;
        }
 
       /* Critical section left.  */
-      __libc_lock_unlock (__libc_setlocale_lock);
+      __libc_rwlock_unlock (__libc_setlocale_lock);
 
       /* Free the resources (the locale path variable.  */
       free (locale_path);
@@ -395,30 +466,66 @@ setlocale (int category, const char *locale)
       return (char *) newname[0];
     }
 }
+libc_hidden_def (setlocale)
+
+static void
+free_category (int category,
+              struct __locale_data *here, struct __locale_data *c_data)
+{
+  struct loaded_l10nfile *runp = _nl_locale_file_list[category];
 
+  /* If this category is already "C" don't do anything.  */
+  if (here != c_data)
+    {
+      /* We have to be prepared that sometime later we still
+        might need the locale information.  */
+      setdata (category, c_data);
+      setname (category, _nl_C_name);
+    }
+
+  while (runp != NULL)
+    {
+      struct loaded_l10nfile *curr = runp;
+      struct __locale_data *data = (struct __locale_data *) runp->data;
+
+      if (data != NULL && data != c_data)
+       _nl_unload_locale (category, data);
+      runp = runp->next;
+      free ((char *) curr->filename);
+      free (curr);
+    }
+}
 
-static void __attribute__ ((unused))
-free_mem (void)
+/* This is called from iconv/gconv_db.c's free_mem, as locales must
+   be freed before freeing gconv steps arrays.  */
+void
+_nl_locale_subfreeres (void)
 {
+#ifdef NL_CURRENT_INDIRECT
+  /* We don't use the loop because we want to have individual weak
+     symbol references here.  */
+# define DEFINE_CATEGORY(category, category_name, items, a)                  \
+  if (CATEGORY_USED (category))                                                      \
+    {                                                                        \
+      extern struct __locale_data _nl_C_##category;                          \
+      weak_extern (_nl_C_##category)                                         \
+      free_category (category, *_nl_current_##category, &_nl_C_##category);   \
+    }
+# include "categories.def"
+# undef        DEFINE_CATEGORY
+#else
   int category;
 
   for (category = 0; category < __LC_LAST; ++category)
     if (category != LC_ALL)
-      {
-       struct locale_data *here = *_nl_current[category];
-
-       /* If this category is already "C" don't do anything.  */
-       if (here == _nl_C[category])
-         continue;
-
-       /* We have to be prepared that sometime later me still might
-          need the locale information.  */
-       setdata (category, _nl_C[category]);
-       setname (category, _nl_C_name);
-
-       _nl_unload_locale (here);
-      }
+      free_category (category, _NL_CURRENT_DATA (category),
+                    _nl_C_locobj.__locales[category]);
+#endif
 
   setname (LC_ALL, _nl_C_name);
+
+  /* This frees the data structures associated with the locale archive.
+     The locales from the archive are not in the file list, so we have
+     not called _nl_unload_locale on them above.  */
+  _nl_archive_subfreeres ();
 }
-text_set_element (__libc_subfreeres, free_mem);