perlvars.h

   1 /*    perlvars.h
   2  *
   3  *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
   4  *    by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 /*
  12 =head1 Global Variables
  13 These variables are global to an entire process.  They are shared between
  14 all interpreters and all threads in a process.  Any variables not documented
  15 here may be changed or removed without notice, so don't use them!
  16 If you feel you really do need to use an unlisted variable, first send email to
  17 L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>.  It may be that
  18 someone there will point out a way to accomplish what you need without using an
  19 internal variable.  But if not, you should get a go-ahead to document and then
  20 use the variable.
  21
  22 =cut
  23 */
  24
  25 /* Don't forget to re-run regen/embed.pl to propagate changes! */
  26
  27 /* This file describes the "global" variables used by perl
  28  * This used to be in perl.h directly but we want to abstract out into
  29  * distinct files which are per-thread, per-interpreter or really global,
  30  * and how they're initialized.
  31  *
  32  * The 'G' prefix is only needed for vars that need appropriate #defines
  33  * generated in embed*.h.  Such symbols are also used to generate
  34  * the appropriate export list for win32. */
  35
  36 /* global state */
  37 #if defined(USE_ITHREADS)
  38 PERLVAR(G, op_mutex,    perl_mutex)     /* Mutex for op refcounting */
  39 #endif
  40 PERLVARI(G, curinterp,  PerlInterpreter *, NULL)
  41                                         /* currently running interpreter
  42                                          * (initial parent interpreter under
  43                                          * useithreads) */
  44 #if defined(USE_ITHREADS)
  45 PERLVAR(G, thr_key,     perl_key)       /* key to retrieve per-thread struct */
  46 #endif
  47
  48 /* XXX does anyone even use this? */
  49 PERLVARI(G, do_undump,  bool,   FALSE)  /* -u or dump seen? */
  50
  51 #if defined(FAKE_PERSISTENT_SIGNAL_HANDLERS)||defined(FAKE_DEFAULT_SIGNAL_HANDLERS)
  52 PERLVARI(G, sig_handlers_initted, int, 0)
  53 #endif
  54 #ifdef FAKE_PERSISTENT_SIGNAL_HANDLERS
  55 PERLVARA(G, sig_ignoring, SIG_SIZE, int)
  56                                         /* which signals we are ignoring */
  57 #endif
  58 #ifdef FAKE_DEFAULT_SIGNAL_HANDLERS
  59 PERLVARA(G, sig_defaulting, SIG_SIZE, int)
  60 #endif
  61
  62 /* XXX signals are process-wide anyway, so we
  63  * ignore the implications of this for threading */
  64 #ifndef HAS_SIGACTION
  65 PERLVARI(G, sig_trapped, int,   0)
  66 #endif
  67
  68 #ifndef PERL_MICRO
  69 /* If Perl has to ignore SIGPFE, this is its saved state.
  70  * See perl.h macros PERL_FPU_INIT and PERL_FPU_{PRE,POST}_EXEC. */
  71 PERLVAR(G, sigfpe_saved, Sighandler_t)
  72
  73 /* these ptrs to functions are to avoid linkage problems; see
  74  * perl-5.8.0-2193-g5c1546dc48
  75  */
  76 PERLVARI(G, csighandlerp,  Sighandler_t,  Perl_csighandler)
  77 PERLVARI(G, csighandler1p, Sighandler1_t, Perl_csighandler1)
  78 PERLVARI(G, csighandler3p, Sighandler3_t, Perl_csighandler3)
  79 #endif
  80
  81 /* This is constant on most architectures, a global on OS/2 */
  82 #ifdef OS2
  83 PERLVARI(G, sh_path,    char *, SH_PATH) /* full path of shell */
  84 #endif
  85
  86 #ifdef USE_PERLIO
  87
  88 #  if defined(USE_ITHREADS)
  89 PERLVAR(G, perlio_mutex, perl_mutex)    /* Mutex for perlio fd refcounts */
  90 #  endif
  91
  92 PERLVARI(G, perlio_fd_refcnt, int *, 0) /* Pointer to array of fd refcounts.  */
  93 PERLVARI(G, perlio_fd_refcnt_size, int, 0) /* Size of the array */
  94 PERLVARI(G, perlio_debug_fd, int, 0)    /* the fd to write perlio debug into, 0 means not set yet */
  95 #endif
  96
  97 #ifdef HAS_MMAP
  98 PERLVARI(G, mmap_page_size, IV, 0)
  99 #endif
 100
 101 #if defined(USE_ITHREADS)
 102 PERLVAR(G, hints_mutex, perl_mutex)    /* Mutex for refcounted he refcounting */
 103 PERLVAR(G, env_mutex, perl_RnW1_mutex_t)      /* Mutex for accessing ENV */
 104 PERLVAR(G, locale_mutex, perl_mutex)   /* Mutex related to locale handling */
 105 #endif
 106
 107 #ifdef USE_POSIX_2008_LOCALE
 108 PERLVAR(G, C_locale_obj, locale_t)
 109 #endif
 110
 111 PERLVARI(G, watch_pvx,  char *, NULL)
 112
 113 /*
 114 =for apidoc AmnU|Perl_check_t *|PL_check
 115
 116 Array, indexed by opcode, of functions that will be called for the "check"
 117 phase of optree building during compilation of Perl code.  For most (but
 118 not all) types of op, once the op has been initially built and populated
 119 with child ops it will be filtered through the check function referenced
 120 by the appropriate element of this array.  The new op is passed in as the
 121 sole argument to the check function, and the check function returns the
 122 completed op.  The check function may (as the name suggests) check the op
 123 for validity and signal errors.  It may also initialise or modify parts of
 124 the ops, or perform more radical surgery such as adding or removing child
 125 ops, or even throw the op away and return a different op in its place.
 126
 127 This array of function pointers is a convenient place to hook into the
 128 compilation process.  An XS module can put its own custom check function
 129 in place of any of the standard ones, to influence the compilation of a
 130 particular type of op.  However, a custom check function must never fully
 131 replace a standard check function (or even a custom check function from
 132 another module).  A module modifying checking must instead B<wrap> the
 133 preexisting check function.  A custom check function must be selective
 134 about when to apply its custom behaviour.  In the usual case where
 135 it decides not to do anything special with an op, it must chain the
 136 preexisting op function.  Check functions are thus linked in a chain,
 137 with the core's base checker at the end.
 138
 139 For thread safety, modules should not write directly to this array.
 140 Instead, use the function L</wrap_op_checker>.
 141
 142 =for apidoc Amn|enum perl_phase|PL_phase
 143
 144 A value that indicates the current Perl interpreter's phase. Possible values
 145 include C<PERL_PHASE_CONSTRUCT>, C<PERL_PHASE_START>, C<PERL_PHASE_CHECK>,
 146 C<PERL_PHASE_INIT>, C<PERL_PHASE_RUN>, C<PERL_PHASE_END>, and
 147 C<PERL_PHASE_DESTRUCT>.
 148
 149 For example, the following determines whether the interpreter is in
 150 global destruction:
 151
 152     if (PL_phase == PERL_PHASE_DESTRUCT) {
 153         // we are in global destruction
 154     }
 155
 156 C<PL_phase> was introduced in Perl 5.14; in prior perls you can use
 157 C<PL_dirty> (boolean) to determine whether the interpreter is in global
 158 destruction. (Use of C<PL_dirty> is discouraged since 5.14.)
 159
 160 =cut
 161 */
 162
 163 #if defined(USE_ITHREADS)
 164 PERLVAR(G, check_mutex, perl_mutex)     /* Mutex for PL_check */
 165 #endif
 166
 167 /* allocate a unique index to every module that calls MY_CXT_INIT */
 168
 169 #ifdef MULTIPLICITY
 170 # ifdef USE_ITHREADS
 171 PERLVAR(G, my_ctx_mutex, perl_mutex)
 172 # endif
 173 PERLVARI(G, my_cxt_index, int,  0)
 174 #endif
 175
 176 /* this is currently set without MUTEX protection, so keep it a type which
 177  * can be set atomically (ie not a bit field) */
 178 PERLVARI(G, veto_cleanup, int, FALSE)   /* exit without cleanup */
 179
 180 /*
 181 =for apidoc AmnUx|Perl_keyword_plugin_t|PL_keyword_plugin
 182
 183 Function pointer, pointing at a function used to handle extended keywords.
 184 The function should be declared as
 185
 186         int keyword_plugin_function(pTHX_
 187                 char *keyword_ptr, STRLEN keyword_len,
 188                 OP **op_ptr)
 189
 190 The function is called from the tokeniser, whenever a possible keyword
 191 is seen.  C<keyword_ptr> points at the word in the parser's input
 192 buffer, and C<keyword_len> gives its length; it is not null-terminated.
 193 The function is expected to examine the word, and possibly other state
 194 such as L<%^H|perlvar/%^H>, to decide whether it wants to handle it
 195 as an extended keyword.  If it does not, the function should return
 196 C<KEYWORD_PLUGIN_DECLINE>, and the normal parser process will continue.
 197
 198 If the function wants to handle the keyword, it first must
 199 parse anything following the keyword that is part of the syntax
 200 introduced by the keyword.  See L</Lexer interface> for details.
 201
 202 When a keyword is being handled, the plugin function must build
 203 a tree of C<OP> structures, representing the code that was parsed.
 204 The root of the tree must be stored in C<*op_ptr>.  The function then
 205 returns a constant indicating the syntactic role of the construct that
 206 it has parsed: C<KEYWORD_PLUGIN_STMT> if it is a complete statement, or
 207 C<KEYWORD_PLUGIN_EXPR> if it is an expression.  Note that a statement
 208 construct cannot be used inside an expression (except via C<do BLOCK>
 209 and similar), and an expression is not a complete statement (it requires
 210 at least a terminating semicolon).
 211
 212 When a keyword is handled, the plugin function may also have
 213 (compile-time) side effects.  It may modify C<%^H>, define functions, and
 214 so on.  Typically, if side effects are the main purpose of a handler,
 215 it does not wish to generate any ops to be included in the normal
 216 compilation.  In this case it is still required to supply an op tree,
 217 but it suffices to generate a single null op.
 218
 219 That's how the C<*PL_keyword_plugin> function needs to behave overall.
 220 Conventionally, however, one does not completely replace the existing
 221 handler function.  Instead, take a copy of C<PL_keyword_plugin> before
 222 assigning your own function pointer to it.  Your handler function should
 223 look for keywords that it is interested in and handle those.  Where it
 224 is not interested, it should call the saved plugin function, passing on
 225 the arguments it received.  Thus C<PL_keyword_plugin> actually points
 226 at a chain of handler functions, all of which have an opportunity to
 227 handle keywords, and only the last function in the chain (built into
 228 the Perl core) will normally return C<KEYWORD_PLUGIN_DECLINE>.
 229
 230 For thread safety, modules should not set this variable directly.
 231 Instead, use the function L</wrap_keyword_plugin>.
 232
 233 =cut
 234 */
 235
 236 #if defined(USE_ITHREADS)
 237 PERLVAR(G, keyword_plugin_mutex, perl_mutex)   /* Mutex for PL_keyword_plugin */
 238 #endif
 239 PERLVARI(G, keyword_plugin, Perl_keyword_plugin_t, Perl_keyword_plugin_standard)
 240
 241 PERLVARI(G, op_sequence, HV *, NULL)    /* dump.c */
 242 PERLVARI(G, op_seq,     UV,     0)      /* dump.c */
 243
 244 #ifdef USE_ITHREADS
 245 PERLVAR(G, dollarzero_mutex, perl_mutex) /* Modifying $0 */
 246 #endif
 247
 248 /* Restricted hashes placeholder value.
 249    In theory, the contents are never used, only the address.
 250    In practice, &PL_sv_placeholder is returned by some APIs, and the calling
 251    code is checking SvOK().  */
 252
 253 PERLVAR(G, sv_placeholder, SV)
 254
 255 #if defined(MYMALLOC) && defined(USE_ITHREADS)
 256 PERLVAR(G, malloc_mutex, perl_mutex)    /* Mutex for malloc */
 257 #endif
 258
 259 PERLVARI(G, hash_seed_set, bool, FALSE) /* perl.c */
 260 PERLVARA(G, hash_seed_w, PERL_HASH_SEED_WORDS, PVT__PERL_HASH_WORD_TYPE) /* perl.c and hv.h */
 261 #if defined(PERL_HASH_STATE_BYTES)
 262 PERLVARA(G, hash_state_w, PERL_HASH_STATE_WORDS, PVT__PERL_HASH_WORD_TYPE) /* perl.c and hv.h */
 263 #endif
 264 #if defined(PERL_USE_SINGLE_CHAR_HASH_CACHE)
 265 #define PERL_SINGLE_CHAR_HASH_CACHE_ELEMS ((1+256) * sizeof(U32))
 266 PERLVARA(G, hash_chars, PERL_SINGLE_CHAR_HASH_CACHE_ELEMS, unsigned char) /* perl.c and hv.h */
 267 #endif
 268
 269 /* The path separator can vary depending on whether we're running under DCL or
 270  * a Unix shell.
 271  */
 272 #ifdef __VMS
 273 PERLVAR(G, perllib_sep, char)
 274 #endif
 275
 276 /* Definitions of user-defined \p{} properties, as the subs that define them
 277  * are only called once */
 278 PERLVARI(G, user_def_props,     HV *, NULL)
 279
 280 #if defined(USE_ITHREADS)
 281 PERLVAR(G, user_def_props_aTHX, PerlInterpreter *)  /* aTHX that user_def_props
 282                                                        was defined in */
 283 PERLVAR(G, user_prop_mutex, perl_mutex)    /* Mutex for manipulating
 284                                               PL_user_defined_properties */
 285 #endif
 286
 287 /* these record the best way to perform certain IO operations while
 288  * atomically setting FD_CLOEXEC. On the first call, a probe is done
 289  * and the result recorded for use by subsequent calls.
 290  * In theory these variables aren't thread-safe, but the worst that can
 291  * happen is that two treads will both do an initial probe
 292  */
 293 PERLVARI(G, strategy_dup,        int, 0)        /* doio.c */
 294 PERLVARI(G, strategy_dup2,       int, 0)        /* doio.c */
 295 PERLVARI(G, strategy_open,       int, 0)        /* doio.c */
 296 PERLVARI(G, strategy_open3,      int, 0)        /* doio.c */
 297 PERLVARI(G, strategy_mkstemp,    int, 0)        /* doio.c */
 298 PERLVARI(G, strategy_socket,     int, 0)        /* doio.c */
 299 PERLVARI(G, strategy_accept,     int, 0)        /* doio.c */
 300 PERLVARI(G, strategy_pipe,       int, 0)        /* doio.c */
 301 PERLVARI(G, strategy_socketpair, int, 0)        /* doio.c */
 302
 303 PERLVARI(G, my_environ, char **, NULL)
 304 PERLVARI(G, origenviron, char **, NULL)