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