1 /* Copyright (C) 1996-2024 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, see
16 <https://www.gnu.org/licenses/>. */
24 #ifdef _POSIX_MAPPED_FILES
25 # include <sys/mman.h>
28 #include "localeinfo.h"
29 #include "../iconv/gconv_charset.h"
30 #include "../iconv/gconv_int.h"
33 #ifdef NL_CURRENT_INDIRECT
34 # define DEFINE_CATEGORY(category, category_name, items, a) \
35 extern struct __locale_data _nl_C_##category; \
36 weak_extern (_nl_C_##category)
37 # include "categories.def"
38 # undef DEFINE_CATEGORY
40 /* Array indexed by category of pointers to _nl_C_CATEGORY slots.
41 Elements are zero for categories whose data is never used. */
42 struct __locale_data
*const _nl_C
[] attribute_hidden
=
44 # define DEFINE_CATEGORY(category, category_name, items, a) \
45 [category] = &_nl_C_##category,
46 # include "categories.def"
47 # undef DEFINE_CATEGORY
50 # define _nl_C (_nl_C_locobj.__locales)
54 /* For each category we keep a list of records for the locale files
55 which are somehow addressed. */
56 struct loaded_l10nfile
*_nl_locale_file_list
[__LC_LAST
];
58 const char _nl_default_locale_path
[] attribute_hidden
= COMPLOCALEDIR
;
60 /* Checks if the name is actually present, that is, not NULL and not
63 name_present (const char *name
)
65 return name
!= NULL
&& name
[0] != '\0';
68 /* Checks that the locale name neither extremely long, nor contains a
69 ".." path component (to prevent directory traversal). */
71 valid_locale_name (const char *name
)
74 size_t namelen
= strlen (name
);
75 /* Name too long. The limit is arbitrary and prevents stack overflow
77 if (__glibc_unlikely (namelen
> 255))
79 /* Directory traversal attempt. */
80 static const char slashdot
[4] = {'/', '.', '.', '/'};
81 if (__glibc_unlikely (__memmem (name
, namelen
,
82 slashdot
, sizeof (slashdot
)) != NULL
))
84 if (namelen
== 2 && __glibc_unlikely (name
[0] == '.' && name
[1] == '.'))
87 && __glibc_unlikely (((name
[0] == '.'
90 || (name
[namelen
- 3] == '/'
91 && name
[namelen
- 2] == '.'
92 && name
[namelen
- 1] == '.'))))
94 /* If there is a slash in the name, it must start with one. */
95 if (__glibc_unlikely (memchr (name
, '/', namelen
) != NULL
) && name
[0] != '/')
100 struct __locale_data
*
101 _nl_find_locale (const char *locale_path
, size_t locale_path_len
,
102 int category
, const char **name
)
105 /* Name of the locale for this category. */
106 const char *cloc_name
= *name
;
107 const char *language
;
108 const char *modifier
;
109 const char *territory
;
111 const char *normalized_codeset
;
112 struct loaded_l10nfile
*locale_file
;
114 if (cloc_name
[0] == '\0')
116 /* The user decides which locale to use by setting environment
118 cloc_name
= getenv ("LC_ALL");
119 if (!name_present (cloc_name
))
120 cloc_name
= getenv (_nl_category_names_get (category
));
121 if (!name_present (cloc_name
))
122 cloc_name
= getenv ("LANG");
123 if (!name_present (cloc_name
))
124 cloc_name
= _nl_C_name
;
127 /* We used to fall back to the C locale if the name contains a slash
128 character '/', but we now check for directory traversal in
129 valid_locale_name, so this is no longer necessary. */
131 if (__builtin_expect (strcmp (cloc_name
, _nl_C_name
), 1) == 0
132 || __builtin_expect (strcmp (cloc_name
, _nl_POSIX_name
), 1) == 0)
134 /* We need not load anything. The needed data is contained in
135 the library itself. */
137 return _nl_C
[category
];
139 else if (!valid_locale_name (cloc_name
))
141 __set_errno (EINVAL
);
147 /* We really have to load some data. First we try the archive,
148 but only if there was no LOCPATH environment variable specified. */
149 if (__glibc_likely (locale_path
== NULL
))
151 struct __locale_data
*data
152 = _nl_load_locale_from_archive (category
, name
);
153 if (__glibc_likely (data
!= NULL
))
156 /* Nothing in the archive with the given name. Expanding it as
157 an alias and retry. */
158 cloc_name
= _nl_expand_alias (*name
);
159 if (cloc_name
!= NULL
)
161 data
= _nl_load_locale_from_archive (category
, &cloc_name
);
162 if (__builtin_expect (data
!= NULL
, 1))
166 /* Nothing in the archive. Set the default path to search below. */
167 locale_path
= _nl_default_locale_path
;
168 locale_path_len
= sizeof _nl_default_locale_path
;
171 /* We really have to load some data. First see whether the name is
172 an alias. Please note that this makes it impossible to have "C"
173 or "POSIX" as aliases. */
174 cloc_name
= _nl_expand_alias (*name
);
176 if (cloc_name
== NULL
)
177 /* It is no alias. */
180 /* Make a writable copy of the locale name. */
181 char *loc_name
= strdupa (cloc_name
);
183 /* LOCALE can consist of up to four recognized parts for the XPG syntax:
185 language[_territory[.codeset]][@modifier]
187 Beside the first all of them are allowed to be missing. If the
188 full specified locale is not found, the less specific one are
189 looked for. The various part will be stripped off according to
192 (2) normalized codeset
196 mask
= _nl_explode_name (loc_name
, &language
, &modifier
, &territory
,
197 &codeset
, &normalized_codeset
);
199 /* Memory allocate problem. */
202 /* If exactly this locale was already asked for we have an entry with
203 the complete name. */
204 locale_file
= _nl_make_l10nflist (&_nl_locale_file_list
[category
],
205 locale_path
, locale_path_len
, mask
,
206 language
, territory
, codeset
,
207 normalized_codeset
, modifier
,
208 _nl_category_names_get (category
), 0);
210 if (locale_file
== NULL
)
212 /* Find status record for addressed locale file. We have to search
213 through all directories in the locale path. */
214 locale_file
= _nl_make_l10nflist (&_nl_locale_file_list
[category
],
215 locale_path
, locale_path_len
, mask
,
216 language
, territory
, codeset
,
217 normalized_codeset
, modifier
,
218 _nl_category_names_get (category
), 1);
219 if (locale_file
== NULL
)
220 /* This means we are out of core. */
224 /* The space for normalized_codeset is dynamically allocated. Free it. */
225 if (mask
& XPG_NORM_CODESET
)
226 free ((void *) normalized_codeset
);
228 if (locale_file
->decided
== 0)
229 _nl_load_locale (locale_file
, category
);
231 if (locale_file
->data
== NULL
)
234 for (cnt
= 0; locale_file
->successor
[cnt
] != NULL
; ++cnt
)
236 if (locale_file
->successor
[cnt
]->decided
== 0)
237 _nl_load_locale (locale_file
->successor
[cnt
], category
);
238 if (locale_file
->successor
[cnt
]->data
!= NULL
)
241 /* Move the entry we found (or NULL) to the first place of
243 locale_file
->successor
[0] = locale_file
->successor
[cnt
];
244 locale_file
= locale_file
->successor
[cnt
];
246 if (locale_file
== NULL
)
248 /* If this is the second time we tried to load a failed
249 locale then the locale_file value comes from the cache
250 and we will not carry out any actual filesystem
251 operations so we must set ENOENT here. */
252 __set_errno (ENOENT
);
257 /* The LC_CTYPE category allows to check whether a locale is really
258 usable. If the locale name contains a charset name and the
259 charset name used in the locale (present in the LC_CTYPE data) is
260 not the same (after resolving aliases etc) we reject the locale
261 since using it would irritate users expecting the charset named
262 in the locale name. */
265 /* Get the codeset information from the locale file. */
266 static const int codeset_idx
[] =
268 [__LC_CTYPE
] = _NL_ITEM_INDEX (CODESET
),
269 [__LC_NUMERIC
] = _NL_ITEM_INDEX (_NL_NUMERIC_CODESET
),
270 [__LC_TIME
] = _NL_ITEM_INDEX (_NL_TIME_CODESET
),
271 [__LC_COLLATE
] = _NL_ITEM_INDEX (_NL_COLLATE_CODESET
),
272 [__LC_MONETARY
] = _NL_ITEM_INDEX (_NL_MONETARY_CODESET
),
273 [__LC_MESSAGES
] = _NL_ITEM_INDEX (_NL_MESSAGES_CODESET
),
274 [__LC_PAPER
] = _NL_ITEM_INDEX (_NL_PAPER_CODESET
),
275 [__LC_NAME
] = _NL_ITEM_INDEX (_NL_NAME_CODESET
),
276 [__LC_ADDRESS
] = _NL_ITEM_INDEX (_NL_ADDRESS_CODESET
),
277 [__LC_TELEPHONE
] = _NL_ITEM_INDEX (_NL_TELEPHONE_CODESET
),
278 [__LC_MEASUREMENT
] = _NL_ITEM_INDEX (_NL_MEASUREMENT_CODESET
),
279 [__LC_IDENTIFICATION
] = _NL_ITEM_INDEX (_NL_IDENTIFICATION_CODESET
)
281 const struct __locale_data
*data
;
282 const char *locale_codeset
;
283 char *clocale_codeset
;
286 data
= (const struct __locale_data
*) locale_file
->data
;
288 (const char *) data
->values
[codeset_idx
[category
]].string
;
289 assert (locale_codeset
!= NULL
);
290 /* Note the length of the allocated memory: +3 for up to two slashes
292 clocale_codeset
= (char *) alloca (strlen (locale_codeset
) + 3);
293 strip (clocale_codeset
, locale_codeset
);
295 ccodeset
= (char *) alloca (strlen (codeset
) + 3);
296 strip (ccodeset
, codeset
);
298 if (__gconv_compare_alias (upstr (ccodeset
, ccodeset
),
299 upstr (clocale_codeset
,
300 clocale_codeset
)) != 0)
302 /* The codesets are not identical, don't use the locale.
303 If this is the second time we tried to load a locale
304 whose codeset doesn't match then the result came from
305 the cache and must set ENOENT here. */
306 __set_errno (ENOENT
);
311 /* Determine the locale name for which loading succeeded. This
312 information comes from the file name. The form is
313 <path>/<locale>/LC_foo. We must extract the <locale> part. */
314 if (((const struct __locale_data
*) locale_file
->data
)->name
== NULL
)
318 endp
= strrchr (locale_file
->filename
, '/');
320 while (cp
[-1] != '/')
322 ((struct __locale_data
*) locale_file
->data
)->name
323 = __strndup (cp
, endp
- cp
);
326 /* Determine whether the user wants transliteration or not. */
328 && __strcasecmp_l (modifier
, "TRANSLIT", _nl_C_locobj_ptr
) == 0)
329 ((struct __locale_data
*) locale_file
->data
)->use_translit
= 1;
331 /* Increment the usage count. */
332 if (((const struct __locale_data
*) locale_file
->data
)->usage_count
334 ++((struct __locale_data
*) locale_file
->data
)->usage_count
;
336 return (struct __locale_data
*) locale_file
->data
;
340 /* Calling this function assumes the lock for handling global locale data
343 _nl_remove_locale (int locale
, struct __locale_data
*data
)
345 if (--data
->usage_count
== 0)
347 if (data
->alloc
!= ld_archive
)
349 /* First search the entry in the list of loaded files. */
350 struct loaded_l10nfile
*ptr
= _nl_locale_file_list
[locale
];
352 /* Search for the entry. It must be in the list. Otherwise it
353 is a bug and we crash badly. */
354 while ((struct __locale_data
*) ptr
->data
!= data
)
357 /* Mark the data as not available anymore. So when the data has
358 to be used again it is reloaded. */
363 /* This does the real work. */
364 _nl_unload_locale (locale
, data
);