summaryrefslogtreecommitdiff
path: root/pod/perllocale.pod
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2016-04-08 13:46:44 -0600
committerKarl Williamson <khw@cpan.org>2016-04-08 13:50:15 -0600
commitfc82b82ef4784a38877f35f56ee16f14934460ce (patch)
tree98332a6656f519b13fdb622f33701716965de486 /pod/perllocale.pod
parentbcc9f606509ad2fad50e16f081103451b7dc49e1 (diff)
downloadperl-fc82b82ef4784a38877f35f56ee16f14934460ce.tar.gz
Strengthen cautions about locale use with threads
This comes from our increased understanding of their perils, given ticket #127708
Diffstat (limited to 'pod/perllocale.pod')
-rw-r--r--pod/perllocale.pod20
1 files changed, 16 insertions, 4 deletions
diff --git a/pod/perllocale.pod b/pod/perllocale.pod
index 0ab6452a6a..e1f34f1e72 100644
--- a/pod/perllocale.pod
+++ b/pod/perllocale.pod
@@ -164,6 +164,15 @@ L<The setlocale function>.
=head2 The C<"use locale"> pragma
+WARNING! Do NOT use this pragma in scripts that have multiple
+L<threads|threads> active. The locale is not local to a single thread.
+Another thread may change the locale at any time, which could cause at a
+minimum that a given thread is operating in a locale it isn't expecting
+to be in. On some platforms, segfaults can also occur. The locale
+change need not be explicit; some operations cause perl to change the
+locale itself. You are vulnerable simply by having done a C<"use
+locale">.
+
By default, Perl itself (outside the L<POSIX> module)
ignores the current locale. The S<C<use locale>>
pragma tells Perl to use the current locale for some operations.
@@ -389,6 +398,13 @@ this, as described in L</Unicode and UTF-8>.
=head2 The setlocale function
+WARNING! Do NOT use this function in a L<thread|threads>. The locale
+will change in all other threads at the same time, and should your
+thread get paused by the operating system, and another started, that
+thread will not have the locale it is expecting. On some platforms,
+there can be a race leading to segfaults if two threads call this
+function nearly simultaneously.
+
You can switch locales as often as you wish at run time with the
C<POSIX::setlocale()> function:
@@ -417,10 +433,6 @@ C<POSIX::setlocale()> function:
# restore the old locale
setlocale(LC_CTYPE, $old_locale);
-This simultaneously affects all threads of the program, so it may be
-problematic to use locales in threaded applications except where there
-is a single locale applicable to all threads.
-
The first argument of C<setlocale()> gives the B<category>, the second the
B<locale>. The category tells in what aspect of data processing you
want to apply locale-specific rules. Category names are discussed in