X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/64b18ddce5bc88a1ffc2ea6b84d36bc3f5c9c4fe..0bd9a4dd60d8f4d8a8858b9017c1f861838b56b5:/perlvars.h

diff --git a/perlvars.h b/perlvars.h
index f8bb821..24ff324 100644
--- a/perlvars.h
+++ b/perlvars.h
@@ -10,9 +10,14 @@
 
 /*
 =head1 Global Variables
-
 These variables are global to an entire process.  They are shared between
-all interpreters and all threads in a process.
+all interpreters and all threads in a process.  Any variables not documented
+here may be changed or removed without notice, so don't use them!
+If you feel you really do need to use an unlisted variable, first send email to
+L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>.  It may be that
+someone there will point out a way to accomplish what you need without using an
+internal variable.  But if not, you should get a go-ahead to document and then
+use the variable.
 
 =cut
 */
@@ -32,7 +37,7 @@ all interpreters and all threads in a process.
 #if defined(USE_ITHREADS)
 PERLVAR(G, op_mutex,	perl_mutex)	/* Mutex for op refcounting */
 #endif
-PERLVAR(G, curinterp,	PerlInterpreter *)
+PERLVARI(G, curinterp,	PerlInterpreter *, NULL)
 					/* currently running interpreter
 					 * (initial parent interpreter under
 					 * useithreads) */
@@ -68,8 +73,13 @@ PERLVARI(G, sig_trapped, int,	0)
 /* If Perl has to ignore SIGPFE, this is its saved state.
  * See perl.h macros PERL_FPU_INIT and PERL_FPU_{PRE,POST}_EXEC. */
 PERLVAR(G, sigfpe_saved, Sighandler_t)
-PERLVARI(G, csighandlerp, Sighandler_t, Perl_csighandler)
-					/* Pointer to C-level sighandler */
+
+/* these ptrs to functions are to avoid linkage problems; see
+ * perl-5.8.0-2193-g5c1546dc48
+ */
+PERLVARI(G, csighandlerp,  Sighandler_t,  Perl_csighandler)
+PERLVARI(G, csighandler1p, Sighandler1_t, Perl_csighandler1)
+PERLVARI(G, csighandler3p, Sighandler3_t, Perl_csighandler3)
 #endif
 
 /* This is constant on most architectures, a global on OS/2 */
@@ -94,14 +104,23 @@ PERLVARI(G, mmap_page_size, IV, 0)
 
 #if defined(USE_ITHREADS)
 PERLVAR(G, hints_mutex, perl_mutex)    /* Mutex for refcounted he refcounting */
+PERLVAR(G, env_mutex, perl_mutex)      /* Mutex for accessing ENV */
+#  if ! defined(USE_THREAD_SAFE_LOCALE) || defined(TS_W32_BROKEN_LOCALECONV)
+PERLVAR(G, locale_mutex, perl_mutex)   /* Mutex for setlocale() changing */
+#  endif
+#  ifndef USE_THREAD_SAFE_LOCALE
+PERLVAR(G, lc_numeric_mutex, perl_mutex)   /* Mutex for switching LC_NUMERIC */
+#  endif
 #endif
 
-#ifdef DEBUGGING
-PERLVAR(G, watch_pvx,	char *)
+#ifdef USE_POSIX_2008_LOCALE
+PERLVAR(G, C_locale_obj, locale_t)
 #endif
 
+PERLVARI(G, watch_pvx,	char *, NULL)
+
 /*
-=for apidoc AmU|Perl_check_t *|PL_check
+=for apidoc AmnU|Perl_check_t *|PL_check
 
 Array, indexed by opcode, of functions that will be called for the "check"
 phase of optree building during compilation of Perl code.  For most (but
@@ -129,6 +148,24 @@ with the core's base checker at the end.
 For thread safety, modules should not write directly to this array.
 Instead, use the function L</wrap_op_checker>.
 
+=for apidoc Amn|enum perl_phase|PL_phase
+
+A value that indicates the current Perl interpreter's phase. Possible values
+include C<PERL_PHASE_CONSTRUCT>, C<PERL_PHASE_START>, C<PERL_PHASE_CHECK>,
+C<PERL_PHASE_INIT>, C<PERL_PHASE_RUN>, C<PERL_PHASE_END>, and
+C<PERL_PHASE_DESTRUCT>.
+
+For example, the following determines whether the interpreter is in
+global destruction:
+
+    if (PL_phase == PERL_PHASE_DESTRUCT) {
+        // we are in global destruction
+    }
+
+C<PL_phase> was introduced in Perl 5.14; in prior perls you can use
+C<PL_dirty> (boolean) to determine whether the interpreter is in global
+destruction. (Use of C<PL_dirty> is discouraged since 5.14.)
+
 =cut
 */
 
@@ -163,7 +200,7 @@ PERLVARI(G, my_cxt_index, int,	0)
 PERLVARI(G, veto_cleanup, int, FALSE)	/* exit without cleanup */
 
 /*
-=for apidoc AmUx|Perl_keyword_plugin_t|PL_keyword_plugin
+=for apidoc AmnUx|Perl_keyword_plugin_t|PL_keyword_plugin
 
 Function pointer, pointing at a function used to handle extended keywords.
 The function should be declared as
@@ -212,12 +249,18 @@ at a chain of handler functions, all of which have an opportunity to
 handle keywords, and only the last function in the chain (built into
 the Perl core) will normally return C<KEYWORD_PLUGIN_DECLINE>.
 
+For thread safety, modules should not set this variable directly.
+Instead, use the function L</wrap_keyword_plugin>.
+
 =cut
 */
 
+#if defined(USE_ITHREADS)
+PERLVAR(G, keyword_plugin_mutex, perl_mutex)   /* Mutex for PL_keyword_plugin */
+#endif
 PERLVARI(G, keyword_plugin, Perl_keyword_plugin_t, Perl_keyword_plugin_standard)
 
-PERLVAR(G, op_sequence, HV *)		/* dump.c */
+PERLVARI(G, op_sequence, HV *, NULL)	/* dump.c */
 PERLVARI(G, op_seq,	UV,	0)	/* dump.c */
 
 #ifdef USE_ITHREADS
@@ -225,7 +268,10 @@ PERLVAR(G, dollarzero_mutex, perl_mutex) /* Modifying $0 */
 #endif
 
 /* Restricted hashes placeholder value.
- * The contents are never used, only the address. */
+   In theory, the contents are never used, only the address.
+   In practice, &PL_sv_placeholder is returned by some APIs, and the calling
+   code is checking SvOK().  */
+
 PERLVAR(G, sv_placeholder, SV)
 
 #if defined(MYMALLOC) && defined(USE_ITHREADS)
@@ -233,4 +279,58 @@ PERLVAR(G, malloc_mutex, perl_mutex)	/* Mutex for malloc */
 #endif
 
 PERLVARI(G, hash_seed_set, bool, FALSE)	/* perl.c */
-PERLVARA(G, hash_seed, PERL_HASH_SEED_BYTES, unsigned char) /* and hv.h */
+PERLVARA(G, hash_seed, PERL_HASH_SEED_BYTES, unsigned char) /* perl.c and hv.h */
+#if defined(PERL_HASH_STATE_BYTES)
+PERLVARA(G, hash_state, PERL_HASH_STATE_BYTES, unsigned char) /* perl.c and hv.h */
+#endif
+#if defined(PERL_USE_SINGLE_CHAR_HASH_CACHE)
+PERLVARA(G, hash_chars, (1+256) * sizeof(U32), unsigned char) /* perl.c and hv.h */
+#endif
+
+/* The path separator can vary depending on whether we're running under DCL or
+ * a Unix shell.
+ */
+#ifdef __VMS
+PERLVAR(G, perllib_sep, char)
+#endif
+
+/* Definitions of user-defined \p{} properties, as the subs that define them
+ * are only called once */
+PERLVARI(G, user_def_props,	HV *, NULL)
+
+#if defined(USE_ITHREADS)
+PERLVAR(G, user_def_props_aTHX, PerlInterpreter *)  /* aTHX that user_def_props
+                                                       was defined in */
+PERLVAR(G, user_prop_mutex, perl_mutex)    /* Mutex for manipulating
+                                              PL_user_defined_properties */
+#endif
+
+/* Everything that folds to a given character, for case insensitivity regex
+ * matching */
+PERLVAR(G, utf8_foldclosures, SV *)
+
+/* these record the best way to to perform certain IO operations while
+ * atomically setting FD_CLOEXEC. On the first call, a probe is done
+ * and the result recorded for use by subsequent calls.
+ * In theory these variables aren't thread-safe, but the worst that can
+ * happen is that two treads will both do an initial probe
+ */
+PERLVARI(G, strategy_dup,        int, 0)	/* doio.c */
+PERLVARI(G, strategy_dup2,       int, 0)	/* doio.c */
+PERLVARI(G, strategy_open,       int, 0)	/* doio.c */
+PERLVARI(G, strategy_open3,      int, 0)	/* doio.c */
+PERLVARI(G, strategy_mkstemp,    int, 0)	/* doio.c */
+PERLVARI(G, strategy_socket,     int, 0)	/* doio.c */
+PERLVARI(G, strategy_accept,     int, 0)	/* doio.c */
+PERLVARI(G, strategy_pipe,       int, 0)	/* doio.c */
+PERLVARI(G, strategy_socketpair, int, 0)	/* doio.c */
+
+#ifdef PERL_IMPLICIT_CONTEXT
+#  ifdef PERL_GLOBAL_STRUCT_PRIVATE
+/* per-module array of pointers to MY_CXT_KEY constants.
+ * It simulates each module having a static my_cxt_index var on builds
+ * which don't allow static vars */
+PERLVARI(G, my_cxt_keys, const char **, NULL)
+PERLVARI(G, my_cxt_keys_size, int,	0)	/* size of PL_my_cxt_keys */
+#  endif
+#endif