/* Declarations for internal libc locale interfaces
- Copyright (C) 1995-2001, 2002 Free Software Foundation, Inc.
+ Copyright (C) 1995-2015 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
- License along with the GNU C Library; if not, write to the Free
- Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
- 02111-1307 USA. */
+ License along with the GNU C Library; if not, see
+ <http://www.gnu.org/licenses/>. */
#ifndef _LOCALEINFO_H
#define _LOCALEINFO_H 1
#include <intl/loadinfo.h> /* For loaded_l10nfile definition. */
/* Magic number at the beginning of a locale data file for CATEGORY. */
-#define LIMAGIC(category) ((unsigned int) (0x20000828 ^ (category)))
+#define LIMAGIC(category) \
+ (category == LC_COLLATE \
+ ? ((unsigned int) (0x20051014 ^ (category))) \
+ : category == LC_CTYPE \
+ ? ((unsigned int) (0x20090720 ^ (category))) \
+ : ((unsigned int) (0x20031115 ^ (category))))
/* Two special weight constants for the collation data. */
#define IGNORE_CHAR 2
-/* We use a special value for the usage counter in `locale_data' to
+/* We use a special value for the usage counter in `__locale_data' to
signal that this data must never be removed anymore. */
#define MAX_USAGE_COUNT (UINT_MAX - 1)
#define UNDELETABLE UINT_MAX
/* Structure describing locale data in core for a category. */
-struct locale_data
+struct __locale_data
{
const char *name;
const char *filedata; /* Region mapping the file data. */
off_t filesize; /* Size of the file (and the region). */
- int mmaped; /* If nonzero the data is mmaped. */
+ enum /* Flavor of storage used for those. */
+ {
+ ld_malloced, /* Both are malloc'd. */
+ ld_mapped, /* name is malloc'd, filedata mmap'd */
+ ld_archive /* Both point into mmap'd archive regions. */
+ } alloc;
+
+ /* This provides a slot for category-specific code to cache data computed
+ about this locale. That code can set a cleanup function to deallocate
+ the data. */
+ struct
+ {
+ void (*cleanup) (struct __locale_data *) internal_function;
+ union
+ {
+ void *data;
+ struct lc_time_data *time;
+ const struct gconv_fcts *ctype;
+ };
+ } private;
unsigned int usage_count; /* Counter for users. */
int use_translit; /* Nonzero if the mb*towv*() and wc*tomb()
functions should use transliteration. */
- const char *options; /* Extra options from the locale name,
- not used in the path to the locale data. */
unsigned int nstrings; /* Number of strings below. */
union locale_data_value
{
const uint32_t *wstr;
const char *string;
- unsigned int word;
+ unsigned int word; /* Note endian issues vs 64-bit pointers. */
}
values __flexarr; /* Items, usually pointers into `filedata'. */
};
+/* This alignment is used for 32-bit integers in locale files, both
+ those that are explicitly int32_t or uint32_t and those that are
+ wchar_t, regardless of the (possibly smaller) alignment required
+ for such integers on a particular host. */
+#define LOCFILE_ALIGN sizeof (int32_t)
+#define LOCFILE_ALIGN_MASK (LOCFILE_ALIGN - 1)
+#define LOCFILE_ALIGN_UP(x) (((x) + LOCFILE_ALIGN - 1) \
+ & ~LOCFILE_ALIGN_MASK)
+#define LOCFILE_ALIGNED_P(x) (((x) & LOCFILE_ALIGN_MASK) == 0)
+
/* We know three kinds of collation sorting rules. */
enum coll_sort_rule
{
-1 indicates that year number is higher in the past. (like B.C.) */
};
+/* Structure caching computed data about information from LC_TIME.
+ The `private.time' member of `struct __locale_data' points to this. */
+struct lc_time_data
+{
+ struct era_entry *eras;
+ size_t num_eras;
+ int era_initialized;
+
+ const char **alt_digits;
+ const wchar_t **walt_digits;
+ int alt_digits_initialized;
+ int walt_digits_initialized;
+};
+
/* LC_CTYPE specific:
Hardwired indices for standard wide character translation mappings. */
#define _ISCTYPE(c, desc) \
(((((const uint32_t *) (desc)) - 8)[(c) >> 5] >> ((c) & 0x1f)) & 1)
-extern const char *const _nl_category_names[__LC_LAST] attribute_hidden;
-extern const size_t _nl_category_name_sizes[__LC_LAST] attribute_hidden;
+/* Category name handling variables. */
+#define CATNAMEMF(line) CATNAMEMF1 (line)
+#define CATNAMEMF1(line) str##line
+extern const union catnamestr_t
+{
+ struct
+ {
+#define DEFINE_CATEGORY(category, category_name, items, a) \
+ char CATNAMEMF (__LINE__)[sizeof (category_name)];
+#include "categories.def"
+#undef DEFINE_CATEGORY
+ };
+ char str[0];
+} _nl_category_names attribute_hidden;
+extern const uint8_t _nl_category_name_idxs[__LC_LAST] attribute_hidden;
+extern const uint8_t _nl_category_name_sizes[__LC_LAST] attribute_hidden;
/* Name of the standard locales. */
extern const char _nl_C_name[] attribute_hidden;
/* The standard codeset. */
extern const char _nl_C_codeset[] attribute_hidden;
-/* Name of current locale for each individual category.
- Each is malloc'd unless it is _nl_C_name. */
-extern const char *_nl_current_names[] attribute_hidden;
+/* This is the internal locale_t object that holds the global locale
+ controlled by calls to setlocale. A thread's TSD locale pointer
+ points to this when `uselocale (LC_GLOBAL_LOCALE)' is in effect. */
+extern struct __locale_struct _nl_global_locale attribute_hidden;
+
+/* This fetches the thread-local locale_t pointer, either one set with
+ uselocale or &_nl_global_locale. */
+#define _NL_CURRENT_LOCALE (__libc_tsd_get (__locale_t, LOCALE))
+#include <bits/libc-tsd.h>
+__libc_tsd_define (extern, __locale_t, LOCALE)
+
+/* For static linking it is desireable to avoid always linking in the code
+ and data for every category when we can tell at link time that they are
+ unused. We can manage this playing some tricks with weak references.
+ But with thread-local locale settings, it becomes quite ungainly unless
+ we can use __thread variables. So only in that case do we attempt this. */
#ifndef SHARED
+# include <tls.h>
+# define NL_CURRENT_INDIRECT 1
+#endif
+
+#ifdef NL_CURRENT_INDIRECT
-/* For each category declare the variable for the current locale data. */
-/* XXX _nl_current_LC_CTYPE and _nl_current_LC_COLLATE were exported
- but where are they used? */
+/* For each category declare the thread-local variable for the current
+ locale data. This has an extra indirection so it points at the
+ __locales[CATEGORY] element in either _nl_global_locale or the current
+ locale object set by uselocale, which points at the actual data. The
+ reason for having these variables is so that references to particular
+ categories will link in the lc-CATEGORY.c module to define this symbol,
+ and we arrange that linking that module is what brings in all the code
+ associated with this category. */
#define DEFINE_CATEGORY(category, category_name, items, a) \
-extern struct locale_data *_nl_current_##category attribute_hidden;
+extern __thread struct __locale_data *const *_nl_current_##category \
+ attribute_hidden attribute_tls_model_ie;
#include "categories.def"
#undef DEFINE_CATEGORY
-extern struct locale_data * *const _nl_current[__LC_LAST] attribute_hidden;
-/* Return a pointer to the current `struct locale_data' for CATEGORY. */
-#define _NL_CURRENT_DATA(category) _nl_current_##category
-/* Hackety hack, don't talk back. */
-#define _nl_current_category (*_nl_current[category])
+/* Return a pointer to the current `struct __locale_data' for CATEGORY. */
+#define _NL_CURRENT_DATA(category) (*_nl_current_##category)
/* Extract the current CATEGORY locale's string for ITEM. */
#define _NL_CURRENT(category, item) \
- (_nl_current_##category->values[_NL_ITEM_INDEX (item)].string)
+ ((*_nl_current_##category)->values[_NL_ITEM_INDEX (item)].string)
/* Extract the current CATEGORY locale's string for ITEM. */
#define _NL_CURRENT_WSTR(category, item) \
- ((wchar_t *) _nl_current_##category->values[_NL_ITEM_INDEX (item)].wstr)
+ ((wchar_t *) (*_nl_current_##category)->values[_NL_ITEM_INDEX (item)].wstr)
/* Extract the current CATEGORY locale's word for ITEM. */
#define _NL_CURRENT_WORD(category, item) \
- (_nl_current_##category->values[_NL_ITEM_INDEX (item)].word)
+ ((uint32_t) (*_nl_current_##category)->values[_NL_ITEM_INDEX (item)].word)
/* This is used in lc-CATEGORY.c to define _nl_current_CATEGORY. */
#define _NL_CURRENT_DEFINE(category) \
- extern struct locale_data _nl_C_##category attribute_hidden; \
- struct locale_data *_nl_current_##category = &_nl_C_##category
+ __thread struct __locale_data *const *_nl_current_##category \
+ attribute_hidden = &_nl_global_locale.__locales[category]; \
+ asm (".globl " __SYMBOL_PREFIX "_nl_current_" #category "_used\n" \
+ _NL_CURRENT_DEFINE_ABS (_nl_current_##category##_used, 1));
+#ifdef HAVE_ASM_SET_DIRECTIVE
+# define _NL_CURRENT_DEFINE_ABS(sym, val) ".set " #sym ", " #val
+#else
+# define _NL_CURRENT_DEFINE_ABS(sym, val) #sym " = " #val
+#endif
#else
/* All categories are always loaded in the shared library, so there is no
point in having lots of separate symbols for linking. */
-# include <bits/libc-tsd.h>
-
-__libc_tsd_define (extern, LOCALE)
-
-extern struct __locale_struct _nl_global_locale attribute_hidden;
-
-# define _NL_CURRENT_LOCALE \
- ((__locale_t) __libc_tsd_get (LOCALE))
-
-/* Return a pointer to the current `struct locale_data' for CATEGORY. */
+/* Return a pointer to the current `struct __locale_data' for CATEGORY. */
# define _NL_CURRENT_DATA(category) \
(_NL_CURRENT_LOCALE->__locales[category])
/* Extract the current CATEGORY locale's word for ITEM. */
# define _NL_CURRENT_WORD(category, item) \
- (_NL_CURRENT_DATA (category)->values[_NL_ITEM_INDEX (item)].word)
+ ((uint32_t) _NL_CURRENT_DATA (category)->values[_NL_ITEM_INDEX (item)].word)
/* This is used in lc-CATEGORY.c to define _nl_current_CATEGORY. */
# define _NL_CURRENT_DEFINE(category) \
#endif
+/* Default search path if no LOCPATH environment variable. */
+extern const char _nl_default_locale_path[] attribute_hidden;
+
/* Load the locale data for CATEGORY from the file specified by *NAME.
- If *NAME is "", use environment variables as specified by POSIX,
- and fill in *NAME with the actual name used. The directories
- listed in LOCALE_PATH are searched for the locale files. */
-extern struct locale_data *_nl_find_locale (const char *locale_path,
- size_t locale_path_len,
- int category, const char **name);
+ If *NAME is "", use environment variables as specified by POSIX, and
+ fill in *NAME with the actual name used. If LOCALE_PATH is not null,
+ those directories are searched for the locale files. If it's null,
+ the locale archive is checked first and then _nl_default_locale_path
+ is searched for locale files. */
+extern struct __locale_data *_nl_find_locale (const char *locale_path,
+ size_t locale_path_len,
+ int category, const char **name)
+ internal_function attribute_hidden;
/* Try to load the file described by FILE. */
-extern void _nl_load_locale (struct loaded_l10nfile *file, int category);
+extern void _nl_load_locale (struct loaded_l10nfile *file, int category)
+ internal_function attribute_hidden;
/* Free all resource. */
-extern void _nl_unload_locale (struct locale_data *locale);
+extern void _nl_unload_locale (struct __locale_data *locale)
+ internal_function attribute_hidden;
/* Free the locale and give back all memory if the usage count is one. */
-extern void _nl_remove_locale (int locale, struct locale_data *data);
+extern void _nl_remove_locale (int locale, struct __locale_data *data)
+ internal_function attribute_hidden;
+
+/* Find the locale *NAMEP in the locale archive, and return the
+ internalized data structure for its CATEGORY data. If this locale has
+ already been loaded from the archive, just returns the existing data
+ structure. If successful, sets *NAMEP to point directly into the mapped
+ archive string table; that way, the next call can short-circuit strcmp. */
+extern struct __locale_data *_nl_load_locale_from_archive (int category,
+ const char **namep)
+ internal_function attribute_hidden;
+
+/* Subroutine of setlocale's __libc_subfreeres hook. */
+extern void _nl_archive_subfreeres (void) attribute_hidden;
+
+/* Subroutine of gconv-db's __libc_subfreeres hook. */
+extern void _nl_locale_subfreeres (void) attribute_hidden;
+
+/* Validate the contents of a locale file and set up the in-core
+ data structure to point into the data. This leaves the `alloc'
+ and `name' fields uninitialized, for the caller to fill in.
+ If any bogons are detected in the data, this will refuse to
+ intern it, and return a null pointer instead. */
+extern struct __locale_data *_nl_intern_locale_data (int category,
+ const void *data,
+ size_t datasize)
+ internal_function attribute_hidden;
/* Return `era' entry which corresponds to TP. Used in strftime. */
-extern struct era_entry *_nl_get_era_entry (const struct tm *tp);
+extern struct era_entry *_nl_get_era_entry (const struct tm *tp,
+ struct __locale_data *lc_time)
+ internal_function attribute_hidden;
/* Return `era' cnt'th entry . Used in strptime. */
-extern struct era_entry *_nl_select_era_entry (int cnt);
+extern struct era_entry *_nl_select_era_entry (int cnt,
+ struct __locale_data *lc_time)
+ internal_function attribute_hidden;
/* Return `alt_digit' which corresponds to NUMBER. Used in strftime. */
-extern const char *_nl_get_alt_digit (unsigned int number);
+extern const char *_nl_get_alt_digit (unsigned int number,
+ struct __locale_data *lc_time)
+ internal_function attribute_hidden;
/* Similar, but now for wide characters. */
-extern const wchar_t *_nl_get_walt_digit (unsigned int number);
+extern const wchar_t *_nl_get_walt_digit (unsigned int number,
+ struct __locale_data *lc_time)
+ internal_function attribute_hidden;
/* Parse string as alternative digit and return numeric value. */
-extern int _nl_parse_alt_digit (const char **strp);
+extern int _nl_parse_alt_digit (const char **strp,
+ struct __locale_data *lc_time)
+ internal_function attribute_hidden;
/* Postload processing. */
extern void _nl_postload_ctype (void);
-extern void _nl_postload_time (void);
+
+/* Functions used for the `private.cleanup' hook. */
+extern void _nl_cleanup_time (struct __locale_data *)
+ internal_function attribute_hidden;
#endif /* localeinfo.h */
projects / thirdparty / glibc.git / blobdiff