X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/457c538539eca0f3c596861d7d14ab0c0e9ee438..31ae3604e91b534f99f9dd92647e555601952cf2:/perlvars.h

diff --git a/perlvars.h b/perlvars.h
index 2facbeb..20c3882 100644
--- a/perlvars.h
+++ b/perlvars.h
@@ -10,6 +10,11 @@
 
 /*
 =head1 Global Variables
+
+These variables are global to an entire process.  They are shared between
+all interpreters and all threads in a process.
+
+=cut
 */
 
 /* Don't forget to re-run regen/embed.pl to propagate changes! */
@@ -24,144 +29,138 @@
  * the appropriate export list for win32. */
 
 /* global state */
-PERLVAR(Gcurinterp,	PerlInterpreter *)
+#if defined(USE_ITHREADS)
+PERLVAR(G, op_mutex,	perl_mutex)	/* Mutex for op refcounting */
+#endif
+PERLVAR(G, curinterp,	PerlInterpreter *)
 					/* currently running interpreter
 					 * (initial parent interpreter under
 					 * useithreads) */
 #if defined(USE_ITHREADS)
-PERLVAR(Gthr_key,	perl_key)	/* key to retrieve per-thread struct */
+PERLVAR(G, thr_key,	perl_key)	/* key to retrieve per-thread struct */
 #endif
 
 /* XXX does anyone even use this? */
-PERLVARI(Gdo_undump,	bool,	FALSE)	/* -u or dump seen? */
+PERLVARI(G, do_undump,	bool,	FALSE)	/* -u or dump seen? */
 
-#if defined(MYMALLOC) && defined(USE_ITHREADS)
-PERLVAR(Gmalloc_mutex,	perl_mutex)	/* Mutex for malloc */
+#ifndef PERL_USE_SAFE_PUTENV
+PERLVARI(G, use_safe_putenv, bool, TRUE)
 #endif
 
-#if defined(USE_ITHREADS)
-PERLVAR(Gop_mutex,	perl_mutex)	/* Mutex for op refcounting */
+#if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS)||defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
+PERLVARI(G, sig_handlers_initted, int, 0)
 #endif
-
-#ifdef USE_ITHREADS
-PERLVAR(Gdollarzero_mutex, perl_mutex)	/* Modifying $0 */
+#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
+PERLVARA(G, sig_ignoring, SIG_SIZE, int)
+					/* which signals we are ignoring */
+#endif
+#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
+PERLVARA(G, sig_defaulting, SIG_SIZE, int)
 #endif
 
-
-/* This is constant on most architectures, a global on OS/2 */
-#ifdef OS2
-PERLVARI(Gsh_path, char *, SH_PATH) /* full path of shell */
+/* XXX signals are process-wide anyway, so we
+ * ignore the implications of this for threading */
+#ifndef HAS_SIGACTION
+PERLVARI(G, sig_trapped, int,	0)
 #endif
 
 #ifndef PERL_MICRO
 /* 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(Gsigfpe_saved,	Sighandler_t)
+PERLVAR(G, sigfpe_saved, Sighandler_t)
+PERLVARI(G, csighandlerp, Sighandler_t, Perl_csighandler)
+					/* Pointer to C-level sighandler */
 #endif
 
-/* Restricted hashes placeholder value.
- * The contents are never used, only the address. */
-PERLVAR(Gsv_placeholder, SV)
-
-#ifndef PERL_MICRO
-PERLVARI(Gcsighandlerp,	Sighandler_t, Perl_csighandler)	/* Pointer to C-level sighandler */
-#endif
-
-#ifndef PERL_USE_SAFE_PUTENV
-PERLVARI(Guse_safe_putenv, int, 1)
+/* This is constant on most architectures, a global on OS/2 */
+#ifdef OS2
+PERLVARI(G, sh_path,	char *, SH_PATH) /* full path of shell */
 #endif
 
 #ifdef USE_PERLIO
-PERLVARI(Gperlio_fd_refcnt, int*, 0) /* Pointer to array of fd refcounts.  */
-PERLVARI(Gperlio_fd_refcnt_size, int, 0) /* Size of the array */
-PERLVARI(Gperlio_debug_fd, int, 0) /* the fd to write perlio debug into, 0 means not set yet */
-#endif
 
-#ifdef HAS_MMAP
-PERLVARI(Gmmap_page_size, IV, 0)
-#endif
+#  if defined(USE_ITHREADS)
+PERLVAR(G, perlio_mutex, perl_mutex)    /* Mutex for perlio fd refcounts */
+#  endif
 
-#if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS)||defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
-PERLVARI(Gsig_handlers_initted, int, 0)
+PERLVARI(G, perlio_fd_refcnt, int *, 0) /* Pointer to array of fd refcounts.  */
+PERLVARI(G, perlio_fd_refcnt_size, int, 0) /* Size of the array */
+PERLVARI(G, perlio_debug_fd, int, 0)	/* the fd to write perlio debug into, 0 means not set yet */
 #endif
-#ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
-PERLVARA(Gsig_ignoring, SIG_SIZE, int)	/* which signals we are ignoring */
-#endif
-#ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
-PERLVARA(Gsig_defaulting, SIG_SIZE, int)
+
+#ifdef HAS_MMAP
+PERLVARI(G, mmap_page_size, IV, 0)
 #endif
 
-/* XXX signals are process-wide anyway, so we
- * ignore the implications of this for threading */
-#ifndef HAS_SIGACTION
-PERLVARI(Gsig_trapped, int, 0)
+#if defined(USE_ITHREADS)
+PERLVAR(G, hints_mutex, perl_mutex)    /* Mutex for refcounted he refcounting */
 #endif
 
 #ifdef DEBUGGING
-PERLVAR(Gwatch_pvx, char*)
+PERLVAR(G, watch_pvx,	char *)
 #endif
 
+/*
+=for apidoc AmU|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
+not all) types of op, once the op has been initially built and populated
+with child ops it will be filtered through the check function referenced
+by the appropriate element of this array.  The new op is passed in as the
+sole argument to the check function, and the check function returns the
+completed op.  The check function may (as the name suggests) check the op
+for validity and signal errors.  It may also initialise or modify parts of
+the ops, or perform more radical surgery such as adding or removing child
+ops, or even throw the op away and return a different op in its place.
+
+This array of function pointers is a convenient place to hook into the
+compilation process.  An XS module can put its own custom check function
+in place of any of the standard ones, to influence the compilation of a
+particular type of op.  However, a custom check function must never fully
+replace a standard check function (or even a custom check function from
+another module).  A module modifying checking must instead B<wrap> the
+preexisting check function.  A custom check function must be selective
+about when to apply its custom behaviour.  In the usual case where
+it decides not to do anything special with an op, it must chain the
+preexisting op function.  Check functions are thus linked in a chain,
+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>.
+
+=cut
+*/
+
+#if defined(USE_ITHREADS)
+PERLVAR(G, check_mutex,	perl_mutex)	/* Mutex for PL_check */
+#endif
 #ifdef PERL_GLOBAL_STRUCT 
-PERLVAR(Gppaddr, Perl_ppaddr_t*) /* or opcode.h */
-PERLVAR(Gcheck,  Perl_check_t *) /* or opcode.h */
-PERLVARA(Gfold_locale, 256, unsigned char) /* or perl.h */
+PERLVAR(G, ppaddr,	Perl_ppaddr_t *) /* or opcode.h */
+PERLVAR(G, check,	Perl_check_t *) /* or opcode.h */
+PERLVARA(G, fold_locale, 256, unsigned char) /* or perl.h */
 #endif
 
 #ifdef PERL_NEED_APPCTX
-PERLVAR(Gappctx, void*) /* the application context */
+PERLVAR(G, appctx,	void*)		/* the application context */
 #endif
 
-PERLVAR(Gop_sequence, HV*) /* dump.c */
-PERLVARI(Gop_seq, UV, 0) /* dump.c */
-
 #if defined(HAS_TIMES) && defined(PERL_NEED_TIMESBASE)
-PERLVAR(Gtimesbase, struct tms)
+PERLVAR(G, timesbase,	struct tms)
 #endif
 
 /* allocate a unique index to every module that calls MY_CXT_INIT */
 
 #ifdef PERL_IMPLICIT_CONTEXT
 # ifdef USE_ITHREADS
-PERLVAR(Gmy_ctx_mutex, perl_mutex)
+PERLVAR(G, my_ctx_mutex, perl_mutex)
 # endif
-PERLVARI(Gmy_cxt_index, int, 0)
-#endif
-
-#if defined(USE_ITHREADS)
-PERLVAR(Ghints_mutex, perl_mutex)    /* Mutex for refcounted he refcounting */
-#endif
-
-#if defined(USE_ITHREADS)
-PERLVAR(Gperlio_mutex, perl_mutex)    /* Mutex for perlio fd refcounts */
+PERLVARI(G, my_cxt_index, int,	0)
 #endif
 
 /* this is currently set without MUTEX protection, so keep it a type which
  * can be set atomically (ie not a bit field) */
-PERLVARI(Gveto_cleanup,	int, FALSE)	/* exit without cleanup */
-
-/* dummy variables that hold pointers to both runops functions, thus forcing
- * them *both* to get linked in (useful for Peek.xs, debugging etc) */
-
-PERLVARI(Grunops_std,	runops_proc_t,	Perl_runops_standard)
-PERLVARI(Grunops_dbg,	runops_proc_t,	Perl_runops_debug)
-
-#if defined(MULTIPLICITY)
-#  define PERL_INTERPRETER_SIZE_UPTO_MEMBER(member)			\
-    STRUCT_OFFSET(struct interpreter, member) +				\
-    sizeof(((struct interpreter*)0)->member)
-
-/* These might be useful.  */
-PERLVARI(Ginterp_size,	U16,	sizeof(struct interpreter))
-#if defined(PERL_GLOBAL_STRUCT)
-PERLVARI(Gglobal_struct_size,	U16,	sizeof(struct perl_vars))
-#endif
-
-/* This will be useful for subsequent releases, because this has to be the
-   same in your libperl as in main(), else you have a mismatch and must abort.
-*/
-PERLVARI(Ginterp_size_5_10_0, U16,
-	 PERL_INTERPRETER_SIZE_UPTO_MEMBER(PERL_LAST_5_10_0_INTERP_MEMBER))
-#endif
+PERLVARI(G, veto_cleanup, int, FALSE)	/* exit without cleanup */
 
 /*
 =for apidoc AmUx|Perl_keyword_plugin_t|PL_keyword_plugin
@@ -216,4 +215,19 @@ the Perl core) will normally return C<KEYWORD_PLUGIN_DECLINE>.
 =cut
 */
 
-PERLVARI(Gkeyword_plugin, Perl_keyword_plugin_t, Perl_keyword_plugin_standard)
+PERLVARI(G, keyword_plugin, Perl_keyword_plugin_t, Perl_keyword_plugin_standard)
+
+PERLVAR(G, op_sequence, HV *)		/* dump.c */
+PERLVARI(G, op_seq,	UV,	0)	/* dump.c */
+
+#ifdef USE_ITHREADS
+PERLVAR(G, dollarzero_mutex, perl_mutex) /* Modifying $0 */
+#endif
+
+/* Restricted hashes placeholder value.
+ * The contents are never used, only the address. */
+PERLVAR(G, sv_placeholder, SV)
+
+#if defined(MYMALLOC) && defined(USE_ITHREADS)
+PERLVAR(G, malloc_mutex, perl_mutex)	/* Mutex for malloc */
+#endif