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_private.h 326193 2017-11-25 17:12:48Z pfg $ 30 */ 31 32 #ifndef __LIBC 33 #error "Userland tools should not use this private header." 34 #endif 35 36 #ifndef _XLOCALE_PRIVATE__H_ 37 #define _XLOCALE_PRIVATE__H_ 38 39 #include <xlocale.h> 40 #include <locale.h> 41 #include <stdlib.h> 42 #include <stdint.h> 43 #include <sys/types.h> 44 #include <machine/atomic.h> 45 #include "setlocale.h" 46 47 /** 48 * The XLC_ values are indexes into the components array. They are defined in 49 * the same order as the LC_ values in locale.h, but without the LC_ALL zero 50 * value. Translating from LC_X to XLC_X is done by subtracting one. 51 * 52 * Any reordering of this enum should ensure that these invariants are not 53 * violated. 54 */ 55 enum { 56 XLC_COLLATE = 0, 57 XLC_CTYPE, 58 XLC_MONETARY, 59 XLC_NUMERIC, 60 XLC_TIME, 61 XLC_MESSAGES, 62 XLC_LAST 63 }; 64 65 _Static_assert(XLC_LAST - XLC_COLLATE == 6, "XLC values should be contiguous"); 66 _Static_assert(XLC_COLLATE == LC_COLLATE - 1, 67 "XLC_COLLATE doesn't match the LC_COLLATE value."); 68 _Static_assert(XLC_CTYPE == LC_CTYPE - 1, 69 "XLC_CTYPE doesn't match the LC_CTYPE value."); 70 _Static_assert(XLC_MONETARY == LC_MONETARY - 1, 71 "XLC_MONETARY doesn't match the LC_MONETARY value."); 72 _Static_assert(XLC_NUMERIC == LC_NUMERIC - 1, 73 "XLC_NUMERIC doesn't match the LC_NUMERIC value."); 74 _Static_assert(XLC_TIME == LC_TIME - 1, 75 "XLC_TIME doesn't match the LC_TIME value."); 76 _Static_assert(XLC_MESSAGES == LC_MESSAGES - 1, 77 "XLC_MESSAGES doesn't match the LC_MESSAGES value."); 78 79 /** 80 * Header used for objects that are reference counted. Objects may optionally 81 * have a destructor associated, which is responsible for destroying the 82 * structure. Global / static versions of the structure should have no 83 * destructor set - they can then have their reference counts manipulated as 84 * normal, but will not do anything with them. 85 * 86 * The header stores a retain count - objects are assumed to have a reference 87 * count of 1 when they are created, but the retain count is 0. When the 88 * retain count is less than 0, they are freed. 89 */ 90 struct xlocale_refcounted { 91 /** Number of references to this component. */ 92 long retain_count; 93 /** Function used to destroy this component, if one is required*/ 94 void(*destructor)(void*); 95 }; 96 /** 97 * Header for a locale component. All locale components must begin with this 98 * header. 99 */ 100 struct xlocale_component { 101 struct xlocale_refcounted header; 102 /** Name of the locale used for this component. */ 103 char locale[ENCODING_LEN+1]; 104 }; 105 106 /** 107 * xlocale structure, stores per-thread locale information. 108 */ 109 struct _xlocale { 110 struct xlocale_refcounted header; 111 /** Components for the locale. */ 112 struct xlocale_component *components[XLC_LAST]; 113 /** Flag indicating if components[XLC_MONETARY] has changed since the 114 * last call to localeconv_l() with this locale. */ 115 int monetary_locale_changed; 116 /** Flag indicating whether this locale is actually using a locale for 117 * LC_MONETARY (1), or if it should use the C default instead (0). */ 118 int using_monetary_locale; 119 /** Flag indicating if components[XLC_NUMERIC] has changed since the 120 * last call to localeconv_l() with this locale. */ 121 int numeric_locale_changed; 122 /** Flag indicating whether this locale is actually using a locale for 123 * LC_NUMERIC (1), or if it should use the C default instead (0). */ 124 int using_numeric_locale; 125 /** Flag indicating whether this locale is actually using a locale for 126 * LC_TIME (1), or if it should use the C default instead (0). */ 127 int using_time_locale; 128 /** Flag indicating whether this locale is actually using a locale for 129 * LC_MESSAGES (1), or if it should use the C default instead (0). */ 130 int using_messages_locale; 131 /** The structure to be returned from localeconv_l() for this locale. */ 132 struct lconv lconv; 133 /** Persistent state used by mblen() calls. */ 134 __mbstate_t mblen; 135 /** Persistent state used by mbrlen() calls. */ 136 __mbstate_t mbrlen; 137 /** Persistent state used by mbrtoc16() calls. */ 138 __mbstate_t mbrtoc16; 139 /** Persistent state used by mbrtoc32() calls. */ 140 __mbstate_t mbrtoc32; 141 /** Persistent state used by mbrtowc() calls. */ 142 __mbstate_t mbrtowc; 143 /** Persistent state used by mbsnrtowcs() calls. */ 144 __mbstate_t mbsnrtowcs; 145 /** Persistent state used by mbsrtowcs() calls. */ 146 __mbstate_t mbsrtowcs; 147 /** Persistent state used by mbtowc() calls. */ 148 __mbstate_t mbtowc; 149 /** Persistent state used by c16rtomb() calls. */ 150 __mbstate_t c16rtomb; 151 /** Persistent state used by c32rtomb() calls. */ 152 __mbstate_t c32rtomb; 153 /** Persistent state used by wcrtomb() calls. */ 154 __mbstate_t wcrtomb; 155 /** Persistent state used by wcsnrtombs() calls. */ 156 __mbstate_t wcsnrtombs; 157 /** Persistent state used by wcsrtombs() calls. */ 158 __mbstate_t wcsrtombs; 159 /** Persistent state used by wctomb() calls. */ 160 __mbstate_t wctomb; 161 /** Buffer used by nl_langinfo_l() */ 162 char *csym; 163 }; 164 165 /** 166 * Increments the reference count of a reference-counted structure. 167 */ 168 __attribute__((unused)) static void* 169 xlocale_retain(void *val) 170 { 171 struct xlocale_refcounted *obj = val; 172 atomic_add_long(&(obj->retain_count), 1); 173 return (val); 174 } 175 /** 176 * Decrements the reference count of a reference-counted structure, freeing it 177 * if this is the last reference, calling its destructor if it has one. 178 */ 179 __attribute__((unused)) static void 180 xlocale_release(void *val) 181 { 182 struct xlocale_refcounted *obj = val; 183 long count; 184 185 count = atomic_fetchadd_long(&(obj->retain_count), -1) - 1; 186 if (count < 0 && obj->destructor != NULL) 187 obj->destructor(obj); 188 } 189 190 /** 191 * Load functions. Each takes the name of a locale and a pointer to the data 192 * to be initialised as arguments. Two special values are allowed for the 193 */ 194 extern void* __collate_load(const char*, locale_t); 195 extern void* __ctype_load(const char*, locale_t); 196 extern void* __messages_load(const char*, locale_t); 197 extern void* __monetary_load(const char*, locale_t); 198 extern void* __numeric_load(const char*, locale_t); 199 extern void* __time_load(const char*, locale_t); 200 201 extern struct _xlocale __xlocale_global_locale; 202 extern struct _xlocale __xlocale_C_locale; 203 204 /** 205 * Caches the rune table in TLS for fast access. 206 */ 207 void __set_thread_rune_locale(locale_t loc); 208 /** 209 * Flag indicating whether a per-thread locale has been set. If no per-thread 210 * locale has ever been set, then we always use the global locale. 211 */ 212 extern int __has_thread_locale; 213 #ifndef __NO_TLS 214 /** 215 * The per-thread locale. Avoids the need to use pthread lookup functions when 216 * getting the per-thread locale. 217 */ 218 extern __thread locale_t __thread_locale; 219 220 /** 221 * Returns the current locale for this thread, or the global locale if none is 222 * set. The caller does not have to free the locale. The return value from 223 * this call is not guaranteed to remain valid after the locale changes. As 224 * such, this should only be called within libc functions. 225 */ 226 static inline locale_t __get_locale(void) 227 { 228 229 if (!__has_thread_locale) { 230 return (&__xlocale_global_locale); 231 } 232 return (__thread_locale ? __thread_locale : &__xlocale_global_locale); 233 } 234 #else 235 locale_t __get_locale(void); 236 #endif 237 238 /** 239 * Two magic values are allowed for locale_t objects. NULL and -1. This 240 * function maps those to the real locales that they represent. 241 */ 242 static inline locale_t get_real_locale(locale_t locale) 243 { 244 switch ((intptr_t)locale) { 245 case 0: return (&__xlocale_C_locale); 246 case -1: return (&__xlocale_global_locale); 247 default: return (locale); 248 } 249 } 250 251 /** 252 * Replace a placeholder locale with the real global or thread-local locale_t. 253 */ 254 #define FIX_LOCALE(l) (l = get_real_locale(l)) 255 256 #endif 257