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 #  ifndef USE_THREAD_SAFE_LOCALE
 106 PERLVAR(G, lc_numeric_mutex, perl_mutex)   /* Mutex for switching LC_NUMERIC */
 107 #  endif
 108 #endif
 109
 110 #ifdef USE_POSIX_2008_LOCALE
 111 PERLVAR(G, C_locale_obj, locale_t)
 112 #endif
 113
 114 PERLVARI(G, watch_pvx,  char *, NULL)
 115
 116 /*
 117 =for apidoc AmnU|Perl_check_t *|PL_check
 118
 119 Array, indexed by opcode, of functions that will be called for the "check"
 120 phase of optree building during compilation of Perl code.  For most (but
 121 not all) types of op, once the op has been initially built and populated
 122 with child ops it will be filtered through the check function referenced
 123 by the appropriate element of this array.  The new op is passed in as the
 124 sole argument to the check function, and the check function returns the
 125 completed op.  The check function may (as the name suggests) check the op
 126 for validity and signal errors.  It may also initialise or modify parts of
 127 the ops, or perform more radical surgery such as adding or removing child
 128 ops, or even throw the op away and return a different op in its place.
 129
 130 This array of function pointers is a convenient place to hook into the
 131 compilation process.  An XS module can put its own custom check function
 132 in place of any of the standard ones, to influence the compilation of a
 133 particular type of op.  However, a custom check function must never fully
 134 replace a standard check function (or even a custom check function from
 135 another module).  A module modifying checking must instead B<wrap> the
 136 preexisting check function.  A custom check function must be selective
 137 about when to apply its custom behaviour.  In the usual case where
 138 it decides not to do anything special with an op, it must chain the
 139 preexisting op function.  Check functions are thus linked in a chain,
 140 with the core's base checker at the end.
 141
 142 For thread safety, modules should not write directly to this array.
 143 Instead, use the function L</wrap_op_checker>.
 144
 145 =for apidoc Amn|enum perl_phase|PL_phase
 146
 147 A value that indicates the current Perl interpreter's phase. Possible values
 148 include C<PERL_PHASE_CONSTRUCT>, C<PERL_PHASE_START>, C<PERL_PHASE_CHECK>,
 149 C<PERL_PHASE_INIT>, C<PERL_PHASE_RUN>, C<PERL_PHASE_END>, and
 150 C<PERL_PHASE_DESTRUCT>.
 151
 152 For example, the following determines whether the interpreter is in
 153 global destruction:
 154
 155     if (PL_phase == PERL_PHASE_DESTRUCT) {
 156         // we are in global destruction
 157     }
 158
 159 C<PL_phase> was introduced in Perl 5.14; in prior perls you can use
 160 C<PL_dirty> (boolean) to determine whether the interpreter is in global
 161 destruction. (Use of C<PL_dirty> is discouraged since 5.14.)
 162
 163 =cut
 164 */
 165
 166 #if defined(USE_ITHREADS)
 167 PERLVAR(G, check_mutex, perl_mutex)     /* Mutex for PL_check */
 168 #endif
 169
 170 /* allocate a unique index to every module that calls MY_CXT_INIT */
 171
 172 #ifdef MULTIPLICITY
 173 # ifdef USE_ITHREADS
 174 PERLVAR(G, my_ctx_mutex, perl_mutex)
 175 # endif
 176 PERLVARI(G, my_cxt_index, int,  0)
 177 #endif
 178
 179 /* this is currently set without MUTEX protection, so keep it a type which
 180  * can be set atomically (ie not a bit field) */
 181 PERLVARI(G, veto_cleanup, int, FALSE)   /* exit without cleanup */
 182
 183 /*
 184 =for apidoc AmnUx|Perl_keyword_plugin_t|PL_keyword_plugin
 185
 186 Function pointer, pointing at a function used to handle extended keywords.
 187 The function should be declared as
 188
 189         int keyword_plugin_function(pTHX_
 190                 char *keyword_ptr, STRLEN keyword_len,
 191                 OP **op_ptr)
 192
 193 The function is called from the tokeniser, whenever a possible keyword
 194 is seen.  C<keyword_ptr> points at the word in the parser's input
 195 buffer, and C<keyword_len> gives its length; it is not null-terminated.
 196 The function is expected to examine the word, and possibly other state
 197 such as L<%^H|perlvar/%^H>, to decide whether it wants to handle it
 198 as an extended keyword.  If it does not, the function should return
 199 C<KEYWORD_PLUGIN_DECLINE>, and the normal parser process will continue.
 200
 201 If the function wants to handle the keyword, it first must
 202 parse anything following the keyword that is part of the syntax
 203 introduced by the keyword.  See L</Lexer interface> for details.
 204
 205 When a keyword is being handled, the plugin function must build
 206 a tree of C<OP> structures, representing the code that was parsed.
 207 The root of the tree must be stored in C<*op_ptr>.  The function then
 208 returns a constant indicating the syntactic role of the construct that
 209 it has parsed: C<KEYWORD_PLUGIN_STMT> if it is a complete statement, or
 210 C<KEYWORD_PLUGIN_EXPR> if it is an expression.  Note that a statement
 211 construct cannot be used inside an expression (except via C<do BLOCK>
 212 and similar), and an expression is not a complete statement (it requires
 213 at least a terminating semicolon).
 214
 215 When a keyword is handled, the plugin function may also have
 216 (compile-time) side effects.  It may modify C<%^H>, define functions, and
 217 so on.  Typically, if side effects are the main purpose of a handler,
 218 it does not wish to generate any ops to be included in the normal
 219 compilation.  In this case it is still required to supply an op tree,
 220 but it suffices to generate a single null op.
 221
 222 That's how the C<*PL_keyword_plugin> function needs to behave overall.
 223 Conventionally, however, one does not completely replace the existing
 224 handler function.  Instead, take a copy of C<PL_keyword_plugin> before
 225 assigning your own function pointer to it.  Your handler function should
 226 look for keywords that it is interested in and handle those.  Where it
 227 is not interested, it should call the saved plugin function, passing on
 228 the arguments it received.  Thus C<PL_keyword_plugin> actually points
 229 at a chain of handler functions, all of which have an opportunity to
 230 handle keywords, and only the last function in the chain (built into
 231 the Perl core) will normally return C<KEYWORD_PLUGIN_DECLINE>.
 232
 233 For thread safety, modules should not set this variable directly.
 234 Instead, use the function L</wrap_keyword_plugin>.
 235
 236 =cut
 237 */
 238
 239 #if defined(USE_ITHREADS)
 240 PERLVAR(G, keyword_plugin_mutex, perl_mutex)   /* Mutex for PL_keyword_plugin */
 241 #endif
 242 PERLVARI(G, keyword_plugin, Perl_keyword_plugin_t, Perl_keyword_plugin_standard)
 243
 244 PERLVARI(G, op_sequence, HV *, NULL)    /* dump.c */
 245 PERLVARI(G, op_seq,     UV,     0)      /* dump.c */
 246
 247 #ifdef USE_ITHREADS
 248 PERLVAR(G, dollarzero_mutex, perl_mutex) /* Modifying $0 */
 249 #endif
 250
 251 /* Restricted hashes placeholder value.
 252    In theory, the contents are never used, only the address.
 253    In practice, &PL_sv_placeholder is returned by some APIs, and the calling
 254    code is checking SvOK().  */
 255
 256 PERLVAR(G, sv_placeholder, SV)
 257
 258 #if defined(MYMALLOC) && defined(USE_ITHREADS)
 259 PERLVAR(G, malloc_mutex, perl_mutex)    /* Mutex for malloc */
 260 #endif
 261
 262 PERLVARI(G, hash_seed_set, bool, FALSE) /* perl.c */
 263 PERLVARA(G, hash_seed_w, PERL_HASH_SEED_WORDS, PVT__PERL_HASH_WORD_TYPE) /* perl.c and hv.h */
 264 #if defined(PERL_HASH_STATE_BYTES)
 265 PERLVARA(G, hash_state_w, PERL_HASH_STATE_WORDS, PVT__PERL_HASH_WORD_TYPE) /* perl.c and hv.h */
 266 #endif
 267 #if defined(PERL_USE_SINGLE_CHAR_HASH_CACHE)
 268 PERLVARA(G, hash_chars, (1+256) * sizeof(U32), unsigned char) /* perl.c and hv.h */
 269 #endif
 270
 271 /* The path separator can vary depending on whether we're running under DCL or
 272  * a Unix shell.
 273  */
 274 #ifdef __VMS
 275 PERLVAR(G, perllib_sep, char)
 276 #endif
 277
 278 /* Definitions of user-defined \p{} properties, as the subs that define them
 279  * are only called once */
 280 PERLVARI(G, user_def_props,     HV *, NULL)
 281
 282 #if defined(USE_ITHREADS)
 283 PERLVAR(G, user_def_props_aTHX, PerlInterpreter *)  /* aTHX that user_def_props
 284                                                        was defined in */
 285 PERLVAR(G, user_prop_mutex, perl_mutex)    /* Mutex for manipulating
 286                                               PL_user_defined_properties */
 287 #endif
 288
 289 /* these record the best way to perform certain IO operations while
 290  * atomically setting FD_CLOEXEC. On the first call, a probe is done
 291  * and the result recorded for use by subsequent calls.
 292  * In theory these variables aren't thread-safe, but the worst that can
 293  * happen is that two treads will both do an initial probe
 294  */
 295 PERLVARI(G, strategy_dup,        int, 0)        /* doio.c */
 296 PERLVARI(G, strategy_dup2,       int, 0)        /* doio.c */
 297 PERLVARI(G, strategy_open,       int, 0)        /* doio.c */
 298 PERLVARI(G, strategy_open3,      int, 0)        /* doio.c */
 299 PERLVARI(G, strategy_mkstemp,    int, 0)        /* doio.c */
 300 PERLVARI(G, strategy_socket,     int, 0)        /* doio.c */
 301 PERLVARI(G, strategy_accept,     int, 0)        /* doio.c */
 302 PERLVARI(G, strategy_pipe,       int, 0)        /* doio.c */
 303 PERLVARI(G, strategy_socketpair, int, 0)        /* doio.c */
 304
 305 PERLVARI(G, my_environ, char **, NULL)
 306 PERLVARI(G, origenviron, char **, NULL)