lib/libc/locale/xlocale.c

   1 /*-
   2  * Copyright (c) 2011 The FreeBSD Foundation
   3  * All rights reserved.
   4  *
   5  * This software was developed by David Chisnall under sponsorship from
   6  * the FreeBSD Foundation.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD: head/lib/libc/locale/xlocale.c 303495 2016-07-29 17:18:47Z ed $
  30  */
  31
  32 #include "namespace.h"
  33 #include <errno.h>
  34 #include <pthread.h>
  35 #include <stdio.h>
  36 #include <string.h>
  37 #include <runetype.h>
  38 #include "libc_private.h"
  39 #include "xlocale_private.h"
  40 #include "un-namespace.h"
  41
  42 /**
  43  * Each locale loader declares a global component.  This is used by setlocale()
  44  * and also by xlocale with LC_GLOBAL_LOCALE..
  45  */
  46 extern struct xlocale_component __xlocale_global_collate;
  47 extern struct xlocale_component __xlocale_global_ctype;
  48 extern struct xlocale_component __xlocale_global_monetary;
  49 extern struct xlocale_component __xlocale_global_numeric;
  50 extern struct xlocale_component __xlocale_global_time;
  51 extern struct xlocale_component __xlocale_global_messages;
  52 /*
  53  * And another version for the statically-allocated C locale.  We only have
  54  * components for the parts that are expected to be sensible.
  55  */
  56 extern struct xlocale_component __xlocale_C_collate;
  57 extern struct xlocale_component __xlocale_C_ctype;
  58
  59 #ifndef __NO_TLS
  60 /*
  61  * The locale for this thread.
  62  */
  63 __thread locale_t __thread_locale;
  64 #endif
  65 /*
  66  * Flag indicating that one or more per-thread locales exist.
  67  */
  68 int __has_thread_locale;
  69 /*
  70  * Private functions in setlocale.c.
  71  */
  72 const char * __get_locale_env(int category);
  73 int __get_locale_str(int category, const char *str, char * const res);
  74 int __detect_path_locale(void);
  75
  76 struct _xlocale __xlocale_global_locale = {
  77         .header = {0},
  78         .components = {
  79                 &__xlocale_global_collate,
  80                 &__xlocale_global_ctype,
  81                 &__xlocale_global_monetary,
  82                 &__xlocale_global_numeric,
  83                 &__xlocale_global_time,
  84                 &__xlocale_global_messages
  85         },
  86         .monetary_locale_changed = 1,
  87         .using_monetary_locale = 0,
  88         .numeric_locale_changed = 1,
  89         .using_numeric_locale = 0
  90 };
  91
  92 struct _xlocale __xlocale_C_locale = {
  93         .header = {0},
  94         .components = {
  95                 &__xlocale_C_collate,
  96                 &__xlocale_C_ctype,
  97                 0, 0, 0, 0
  98         },
  99         .monetary_locale_changed = 1,
 100         .using_monetary_locale = 0,
 101         .numeric_locale_changed = 1,
 102         .using_numeric_locale = 0
 103 };
 104
 105 static void*(*constructors[])(const char*, locale_t) =
 106 {
 107         __collate_load,
 108         __ctype_load,
 109         __monetary_load,
 110         __numeric_load,
 111         __time_load,
 112         __messages_load
 113 };
 114
 115 static pthread_key_t locale_info_key;
 116 static int fake_tls;
 117 static locale_t thread_local_locale;
 118
 119 static void init_key(void)
 120 {
 121
 122         _pthread_key_create(&locale_info_key, xlocale_release);
 123         _pthread_setspecific(locale_info_key, (void*)42);
 124         if (_pthread_getspecific(locale_info_key) == (void*)42) {
 125                 _pthread_setspecific(locale_info_key, 0);
 126         } else {
 127                 fake_tls = 1;
 128         }
 129         /* At least one per-thread locale has now been set. */
 130         __has_thread_locale = 1;
 131         __detect_path_locale();
 132 }
 133
 134 static pthread_once_t once_control = PTHREAD_ONCE_INIT;
 135
 136 static locale_t
 137 get_thread_locale(void)
 138 {
 139
 140         _once(&once_control, init_key);
 141
 142         return (fake_tls ? thread_local_locale :
 143                 _pthread_getspecific(locale_info_key));
 144 }
 145
 146 #ifdef __NO_TLS
 147 locale_t
 148 __get_locale(void)
 149 {
 150         locale_t l = get_thread_locale();
 151         return (l ? l : &__xlocale_global_locale);
 152
 153 }
 154 #endif
 155
 156 static void
 157 set_thread_locale(locale_t loc)
 158 {
 159         locale_t l = (loc == LC_GLOBAL_LOCALE) ? 0 : loc;
 160
 161         _once(&once_control, init_key);
 162
 163         if (NULL != l) {
 164                 xlocale_retain((struct xlocale_refcounted*)l);
 165         }
 166         locale_t old = _pthread_getspecific(locale_info_key);
 167         if ((NULL != old) && (l != old)) {
 168                 xlocale_release((struct xlocale_refcounted*)old);
 169         }
 170         if (fake_tls) {
 171                 thread_local_locale = l;
 172         } else {
 173                 _pthread_setspecific(locale_info_key, l);
 174         }
 175 #ifndef __NO_TLS
 176         __thread_locale = l;
 177         __set_thread_rune_locale(loc);
 178 #endif
 179 }
 180
 181 /**
 182  * Clean up a locale, once its reference count reaches zero.  This function is
 183  * called by xlocale_release(), it should not be called directly.
 184  */
 185 static void
 186 destruct_locale(void *l)
 187 {
 188         locale_t loc = l;
 189
 190         for (int type=0 ; type<XLC_LAST ; type++) {
 191                 if (loc->components[type]) {
 192                         xlocale_release(loc->components[type]);
 193                 }
 194         }
 195         if (loc->csym) {
 196                 free(loc->csym);
 197         }
 198         free(l);
 199 }
 200
 201 /**
 202  * Allocates a new, uninitialised, locale.
 203  */
 204 static locale_t
 205 alloc_locale(void)
 206 {
 207         locale_t new = calloc(sizeof(struct _xlocale), 1);
 208
 209         new->header.destructor = destruct_locale;
 210         new->monetary_locale_changed = 1;
 211         new->numeric_locale_changed = 1;
 212         return (new);
 213 }
 214 static void
 215 copyflags(locale_t new, locale_t old)
 216 {
 217         new->using_monetary_locale = old->using_monetary_locale;
 218         new->using_numeric_locale = old->using_numeric_locale;
 219         new->using_time_locale = old->using_time_locale;
 220         new->using_messages_locale = old->using_messages_locale;
 221 }
 222
 223 static int dupcomponent(int type, locale_t base, locale_t new)
 224 {
 225         /* Always copy from the global locale, since it has mutable components.
 226          */
 227         struct xlocale_component *src = base->components[type];
 228
 229         if (&__xlocale_global_locale == base) {
 230                 new->components[type] = constructors[type](src->locale, new);
 231                 if (new->components[type]) {
 232                         strncpy(new->components[type]->locale, src->locale,
 233                             ENCODING_LEN);
 234                 }
 235         } else if (base->components[type]) {
 236                 new->components[type] = xlocale_retain(base->components[type]);
 237         } else {
 238                 /* If the component was NULL, return success - if base is a
 239                  * valid locale then the flag indicating that this isn't
 240                  * present should be set.  If it isn't a valid locale, then
 241                  * we're stuck anyway. */
 242                 return 1;
 243         }
 244         return (0 != new->components[type]);
 245 }
 246
 247 /*
 248  * Public interfaces.  These are the five public functions described by the
 249  * xlocale interface.
 250  */
 251
 252 locale_t newlocale(int mask, const char *locale, locale_t base)
 253 {
 254         int type;
 255         const char *realLocale = locale;
 256         const char *np, *cp;
 257         char lres[ENCODING_LEN + 1] = "";
 258         int len;
 259         int useenv = 0;
 260         int useslh = 0;
 261         int usestr = 0;
 262         int success = 1;
 263
 264         _once(&once_control, init_key);
 265
 266         locale_t new = alloc_locale();
 267         if (NULL == new) {
 268                 return (NULL);
 269         }
 270
 271         FIX_LOCALE(base);
 272         copyflags(new, base);
 273
 274         if (NULL == locale) {
 275                 realLocale = "C";
 276         } else if ('\0' == locale[0]) {
 277                 useenv = 1;
 278         } else if (strchr(locale, '/') != NULL) {
 279                 /*
 280                  * Handle system native locale string
 281                  * e.g. "C/en_US.UTF-8/C/C/lt_LT/C"
 282                  */
 283                 useslh = 1;
 284                 np = locale;
 285         } else if ('L' == locale[0] && strchr(locale, ';') != NULL) {
 286                 /*
 287                  * We are called from c++ runtime lib with LC_*; string??
 288                  */
 289                 usestr = 1;
 290         }
 291
 292         for (type=0 ; type<XLC_LAST ; type++) {
 293                 if (useslh) {
 294                         cp = strchr(np, '/');
 295                         if (cp == NULL && type == XLC_LAST - 1) {
 296                                 cp = locale + strlen(locale);
 297                         } else if (cp == NULL || type == XLC_LAST - 1) {
 298                                 errno = EINVAL;
 299                                 success = 0;
 300                                 break;
 301                         }
 302                         len = cp - np;
 303                         if (len > ENCODING_LEN || len <= 0) {
 304                                 errno = EINVAL;
 305                                 success = 0;
 306                                 break;
 307                         }
 308                         strncpy(lres, np, len);
 309                         lres[len] = '\0';
 310                         np = cp + 1;
 311                 }
 312
 313                 if (mask & 1) {
 314                         if (useenv) {
 315                                 realLocale = __get_locale_env(type + 1);
 316                         } else if (useslh) {
 317                                 realLocale = lres;
 318                         } else if (usestr) {
 319                                 __get_locale_str(type + 1, locale, lres);
 320                                 realLocale = lres;
 321                         }
 322                         new->components[type] =
 323                              constructors[type](realLocale, new);
 324                         if (new->components[type]) {
 325                                 strncpy(new->components[type]->locale,
 326                                      realLocale, ENCODING_LEN);
 327                         } else {
 328                                 success = 0;
 329                                 break;
 330                         }
 331                 } else {
 332                         if (!dupcomponent(type, base, new)) {
 333                                 success = 0;
 334                                 break;
 335                         }
 336                 }
 337                 mask >>= 1;
 338         }
 339         if (0 == success) {
 340                 xlocale_release(new);
 341                 new = NULL;
 342         }
 343
 344         return (new);
 345 }
 346
 347 locale_t duplocale(locale_t base)
 348 {
 349         locale_t new = alloc_locale();
 350         int type;
 351
 352         _once(&once_control, init_key);
 353
 354         if (NULL == new) {
 355                 return (NULL);
 356         }
 357
 358         FIX_LOCALE(base);
 359         copyflags(new, base);
 360
 361         for (type=0 ; type<XLC_LAST ; type++) {
 362                 dupcomponent(type, base, new);
 363         }
 364
 365         return (new);
 366 }
 367
 368 /*
 369  * Free a locale_t.  This is quite a poorly named function.  It actually
 370  * disclaims a reference to a locale_t, rather than freeing it.
 371  */
 372 void
 373 freelocale(locale_t loc)
 374 {
 375
 376         /*
 377          * Fail if we're passed something that isn't a locale. If we're
 378          * passed the global locale, pretend that we freed it but don't
 379          * actually do anything.
 380          */
 381         if (loc != NULL && loc != LC_GLOBAL_LOCALE &&
 382             loc != &__xlocale_global_locale)
 383                 xlocale_release(loc);
 384 }
 385
 386 /*
 387  * Returns the name of the locale for a particular component of a locale_t.
 388  */
 389 const char *querylocale(int mask, locale_t loc)
 390 {
 391         int type = ffs(mask) - 1;
 392         FIX_LOCALE(loc);
 393         if (type >= XLC_LAST)
 394                 return (NULL);
 395         if (loc->components[type])
 396                 return (loc->components[type]->locale);
 397         return ("C");
 398 }
 399
 400 /*
 401  * Installs the specified locale_t as this thread's locale.
 402  */
 403 locale_t uselocale(locale_t loc)
 404 {
 405         locale_t old = get_thread_locale();
 406         if (NULL != loc) {
 407                 set_thread_locale(loc);
 408         }
 409         return (old ? old : LC_GLOBAL_LOCALE);
 410 }
 411