intrpvar.h

   1 /*   intrpvar.h
   2  *
   3  *    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   4  *    2006, 2007, 2008 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 #include "handy.h"
  12
  13 /*
  14 =head1 Per-Interpreter Variables
  15 */
  16
  17 /* These variables are per-interpreter in threaded/multiplicity builds,
  18  * global otherwise.
  19
  20  * Don't forget to re-run regen/embed.pl to propagate changes! */
  21
  22 /* New variables must be added to the very end for binary compatibility. */
  23
  24 /* Don't forget to add your variable also to perl_clone()! (in sv.c) */
  25
  26 /* The 'I' prefix is only needed for vars that need appropriate #defines
  27  * generated when built with or without MULTIPLICITY.  It is also used
  28  * to generate the appropriate export list for win32.  If the variable
  29  * needs to be initialized, use PERLVARI.
  30  *
  31  * When building without MULTIPLICITY, these variables will be truly global.
  32  *
  33  * Important ones in the first cache line (if alignment is done right) */
  34
  35 PERLVAR(I, stack_sp,    SV **)          /* top of the stack */
  36 PERLVAR(I, op,          OP *)           /* currently executing op */
  37 PERLVAR(I, curpad,      SV **)          /* active pad (lexicals+tmps) */
  38
  39 PERLVAR(I, stack_base,  SV **)
  40 PERLVAR(I, stack_max,   SV **)
  41
  42 PERLVAR(I, savestack,   ANY *)          /* items that need to be restored when
  43                                            LEAVEing scopes we've ENTERed */
  44 PERLVAR(I, savestack_ix, I32)
  45 PERLVAR(I, savestack_max, I32)
  46
  47 PERLVAR(I, scopestack,  I32 *)          /* scopes we've ENTERed */
  48 PERLVAR(I, scopestack_ix, I32)
  49 PERLVAR(I, scopestack_max, I32)
  50
  51 PERLVAR(I, tmps_stack,  SV **)          /* mortals we've made */
  52 PERLVARI(I, tmps_ix,    SSize_t,        -1)
  53 PERLVARI(I, tmps_floor, SSize_t,        -1)
  54 PERLVAR(I, tmps_max,    SSize_t)        /* first unalloced slot in tmps stack */
  55
  56 PERLVARI(I, sub_generation, U32, 1)     /* incr to invalidate method cache */
  57
  58 PERLVAR(I, markstack,   I32 *)          /* stack_sp locations we're
  59                                            remembering */
  60 PERLVAR(I, markstack_ptr, I32 *)
  61 PERLVAR(I, markstack_max, I32 *)
  62
  63 #ifdef PERL_HASH_RANDOMIZE_KEYS
  64 #ifdef USE_PERL_PERTURB_KEYS
  65 PERLVARI(I, hash_rand_bits_enabled, U8, 1) /* used to randomize hash stuff 0 == no-random, 1 == random, 2 == determinsitic */
  66 #endif
  67 PERLVARI(I, hash_rand_bits, UV, 0)      /* used to randomize hash stuff */
  68 #endif
  69 PERLVAR(I, strtab,      HV *)           /* shared string table */
  70 /* prog counter for the currently executing OP_MULTIDEREF Used to signal
  71  * to S_find_uninit_var() where we are */
  72 PERLVAR(I, multideref_pc, UNOP_AUX_item *)
  73
  74 /* Fields used by magic variables such as $@, $/ and so on */
  75 PERLVAR(I, curpm,       PMOP *)         /* what to do \ interps in REs from */
  76 PERLVAR(I, curpm_under,        PMOP *)                /* what to do \ interps in REs from */
  77
  78 PERLVAR(I, tainting,    bool)           /* doing taint checks */
  79 PERLVARI(I, tainted,    bool, FALSE)    /* using variables controlled by $< */
  80
  81 /* PL_delaymagic is currently used for two purposes: to assure simultaneous
  82  * updates in ($<,$>) = ..., and to assure atomic update in push/unshift
  83  * @ISA, It works like this: a few places such as pp_push set the DM_DELAY
  84  * flag; then various places such as av_store() skip mg_set(ary) if this
  85  * flag is set, and various magic vtable methods set flags like
  86  * DM_ARRAY_ISA if they've seen something of that ilk. Finally when
  87  * control returns to pp_push or whatever, it sees if any of those flags
  88  * have been set, and if so finally calls mg_set().
  89  *
  90  * NB: PL_delaymagic is automatically saved and restored by JUMPENV_PUSH
  91  * / POP. This removes the need to do ENTER/SAVEI16(PL_delaymagic)/LEAVE
  92  * in hot code like pp_push.
  93  */
  94 PERLVAR(I, delaymagic,  U16)            /* ($<,$>) = ... */
  95
  96 PERLVAR(I, localizing,  U8)             /* are we processing a local() list? */
  97 PERLVAR(I, in_eval,     U8)             /* trap "fatal" errors? */
  98 PERLVAR(I, defgv,       GV *)           /* the *_ glob */
  99 /*
 100
 101 =for apidoc mn|U8|PL_dowarn
 102
 103 The C variable that roughly corresponds to Perl's C<$^W> warning variable.
 104 However, C<$^W> is treated as a boolean, whereas C<PL_dowarn> is a
 105 collection of flag bits.
 106
 107 =cut
 108 */
 109
 110 PERLVAR(I, dowarn,      U8)
 111
 112 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
 113 #  define PERL___I -1
 114 #else
 115 #  define PERL___I 1
 116 #endif
 117 PERLVARI(I, utf8cache, I8, PERL___I)    /* Is the utf8 caching code enabled? */
 118 #undef PERL___I
 119
 120
 121 /* Stashes */
 122 PERLVAR(I, defstash,    HV *)           /* main symbol table */
 123 PERLVAR(I, curstash,    HV *)           /* symbol table for current package */
 124
 125 PERLVAR(I, curcop,      COP *)
 126 PERLVAR(I, curstack,    AV *)           /* THE STACK */
 127 PERLVAR(I, curstackinfo, PERL_SI *)     /* current stack + context */
 128 PERLVAR(I, mainstack,   AV *)           /* the stack when nothing funny is
 129                                            happening */
 130
 131 /* memory management */
 132 PERLVAR(I, sv_count,    IV)             /* how many SV* are currently allocated */
 133
 134 PERLVAR(I, sv_root,     SV *)           /* storage for SVs belonging to interp */
 135 PERLVAR(I, sv_arenaroot, SV *)          /* list of areas for garbage collection */
 136
 137 /* fake PMOP that PL_curpm points to while in (?{}) so $1 et al are visible */
 138 PERLVARI(I, reg_curpm, PMOP*, NULL)
 139
 140 /* the currently active slab in a chain of slabs of regmatch states,
 141  * and the currently active state within that slab. This stack of states
 142  * is shared amongst re-entrant calls to the regex engine */
 143
 144 PERLVARI(I, regmatch_slab, regmatch_slab *,     NULL)
 145 PERLVAR(I, regmatch_state, regmatch_state *)
 146
 147 PERLVAR(I, comppad,     PAD *)          /* storage for lexically scoped temporaries */
 148
 149 /*
 150 =for apidoc Amn|SV|PL_sv_undef
 151 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
 152
 153 =for apidoc Amn|SV|PL_sv_no
 154 This is the C<false> SV.  See C<L</PL_sv_yes>>.  Always refer to this as
 155 C<&PL_sv_no>.
 156
 157 =for apidoc Amn|SV|PL_sv_yes
 158 This is the C<true> SV.  See C<L</PL_sv_no>>.  Always refer to this as
 159 C<&PL_sv_yes>.
 160
 161 =cut
 162 */
 163
 164 PERLVAR(I, sv_undef,    SV)
 165 PERLVAR(I, sv_no,       SV)
 166 PERLVAR(I, sv_yes,      SV)
 167 PERLVAR(I, padname_undef,       PADNAME)
 168 PERLVAR(I, padname_const,       PADNAME)
 169 PERLVAR(I, Sv,          SV *)           /* used to hold temporary values */
 170
 171 PERLVAR(I, parser,      yy_parser *)    /* current parser state */
 172
 173 PERLVAR(I, stashcache,  HV *)           /* Cache to speed up S_method_common */
 174
 175
 176 /*
 177 =for apidoc Amn|STRLEN|PL_na
 178
 179 A convenience variable which is typically used with C<SvPV> when one
 180 doesn't care about the length of the string.  It is usually more efficient
 181 to either declare a local variable and use that instead or to use the
 182 C<SvPV_nolen> macro.
 183
 184 =cut
 185 */
 186
 187 PERLVAR(I, na,          STRLEN)         /* for use in SvPV when length is
 188                                            Not Applicable */
 189
 190 /* stat stuff */
 191 PERLVAR(I, statcache,   Stat_t)         /* _ */
 192 PERLVAR(I, statgv,      GV *)
 193 PERLVARI(I, statname,   SV *,   NULL)
 194
 195 /*
 196 =for apidoc mn|SV*|PL_rs
 197
 198 The input record separator - C<$/> in Perl space.
 199
 200 =for apidoc mn|GV*|PL_last_in_gv
 201
 202 The GV which was last used for a filehandle input operation.  (C<< <FH> >>)
 203
 204 =for apidoc mn|GV*|PL_ofsgv
 205
 206 The glob containing the output field separator - C<*,> in Perl space.
 207
 208 =cut
 209 */
 210
 211 PERLVAR(I, rs,          SV *)           /* input record separator $/ */
 212 PERLVAR(I, last_in_gv,  GV *)           /* GV used in last <FH> */
 213 PERLVAR(I, ofsgv,       GV *)           /* GV of output field separator *, */
 214 PERLVAR(I, defoutgv,    GV *)           /* default FH for output */
 215 PERLVARI(I, chopset,    const char *, " \n-")   /* $: */
 216 PERLVAR(I, formtarget,  SV *)
 217 PERLVAR(I, bodytarget,  SV *)
 218 PERLVAR(I, toptarget,   SV *)
 219
 220
 221 PERLVAR(I, restartop,   OP *)           /* propagating an error from croak? */
 222 PERLVAR(I, restartjmpenv, JMPENV *)     /* target frame for longjmp in die */
 223
 224 PERLVAR(I, top_env,     JMPENV *)       /* ptr to current sigjmp environment */
 225 PERLVAR(I, start_env,   JMPENV)         /* empty startup sigjmp environment */
 226 PERLVARI(I, errors,     SV *,   NULL)   /* outstanding queued errors */
 227
 228 /* statics "owned" by various functions */
 229 PERLVAR(I, hv_fetch_ent_mh, HE*)        /* owned by hv_fetch_ent() */
 230
 231 PERLVAR(I, lastgotoprobe, OP*)          /* from pp_ctl.c */
 232
 233 /* sort stuff */
 234 PERLVAR(I, sortcop,     OP *)           /* user defined sort routine */
 235 PERLVAR(I, sortstash,   HV *)           /* which is in some package or other */
 236 PERLVAR(I, firstgv,     GV *)           /* $a */
 237 PERLVAR(I, secondgv,    GV *)           /* $b */
 238
 239 /* float buffer */
 240 PERLVAR(I, efloatbuf,   char *)
 241 PERLVAR(I, efloatsize,  STRLEN)
 242
 243 PERLVARI(I, dumpindent, U16,    4)      /* number of blanks per dump
 244                                            indentation level */
 245
 246 PERLVAR(I, exit_flags,  U8)             /* was exit() unexpected, etc. */
 247
 248 PERLVAR(I, utf8locale,  bool)           /* utf8 locale detected */
 249 PERLVAR(I, in_utf8_CTYPE_locale, bool)
 250 PERLVAR(I, in_utf8_COLLATE_locale, bool)
 251 #ifdef USE_LOCALE_CTYPE
 252     PERLVAR(I, warn_locale, SV *)
 253 #endif
 254
 255 PERLVARA(I, colors,6,   char *)         /* values from PERL_RE_COLORS env var */
 256
 257 /*
 258 =for apidoc Amn|peep_t|PL_peepp
 259
 260 Pointer to the per-subroutine peephole optimiser.  This is a function
 261 that gets called at the end of compilation of a Perl subroutine (or
 262 equivalently independent piece of Perl code) to perform fixups of
 263 some ops and to perform small-scale optimisations.  The function is
 264 called once for each subroutine that is compiled, and is passed, as sole
 265 parameter, a pointer to the op that is the entry point to the subroutine.
 266 It modifies the op tree in place.
 267
 268 The peephole optimiser should never be completely replaced.  Rather,
 269 add code to it by wrapping the existing optimiser.  The basic way to do
 270 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
 271 If the new code wishes to operate on ops throughout the subroutine's
 272 structure, rather than just at the top level, it is likely to be more
 273 convenient to wrap the L</PL_rpeepp> hook.
 274
 275 =cut
 276 */
 277
 278 PERLVARI(I, peepp,      peep_t, Perl_peep)
 279
 280 /*
 281 =for apidoc Amn|peep_t|PL_rpeepp
 282
 283 Pointer to the recursive peephole optimiser.  This is a function
 284 that gets called at the end of compilation of a Perl subroutine (or
 285 equivalently independent piece of Perl code) to perform fixups of some
 286 ops and to perform small-scale optimisations.  The function is called
 287 once for each chain of ops linked through their C<op_next> fields;
 288 it is recursively called to handle each side chain.  It is passed, as
 289 sole parameter, a pointer to the op that is at the head of the chain.
 290 It modifies the op tree in place.
 291
 292 The peephole optimiser should never be completely replaced.  Rather,
 293 add code to it by wrapping the existing optimiser.  The basic way to do
 294 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
 295 If the new code wishes to operate only on ops at a subroutine's top level,
 296 rather than throughout the structure, it is likely to be more convenient
 297 to wrap the L</PL_peepp> hook.
 298
 299 =cut
 300 */
 301
 302 PERLVARI(I, rpeepp,     peep_t, Perl_rpeep)
 303
 304 /*
 305 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
 306
 307 When non-C<NULL>, the function pointed by this variable will be called each time an OP is freed with the corresponding OP as the argument.
 308 This allows extensions to free any extra attribute they have locally attached to an OP.
 309 It is also assured to first fire for the parent OP and then for its kids.
 310
 311 When you replace this variable, it is considered a good practice to store the possibly previously installed hook and that you recall it inside your own.
 312
 313 =cut
 314 */
 315
 316 PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
 317
 318 PERLVARI(I, watchaddr,  char **, 0)
 319 PERLVAR(I, watchok,     char *)
 320
 321 PERLVAR(I, perldb,      U32)
 322
 323 PERLVAR(I, signals,     U32)    /* Using which pre-5.8 signals */
 324
 325 PERLVAR(I, reentrant_retint, int)       /* Integer return value from reentrant functions */
 326
 327 /* pseudo environmental stuff */
 328 PERLVAR(I, origargc,    int)
 329 PERLVAR(I, origargv,    char **)
 330 PERLVAR(I, envgv,       GV *)
 331 PERLVAR(I, incgv,       GV *)
 332 PERLVAR(I, hintgv,      GV *)
 333 PERLVAR(I, origfilename, char *)
 334 PERLVARI(I, xsubfilename, const char *, NULL)
 335 PERLVAR(I, diehook,     SV *)
 336 PERLVAR(I, warnhook,    SV *)
 337
 338 /* switches */
 339 PERLVAR(I, patchlevel,  SV *)
 340 PERLVAR(I, localpatches, const char * const *)
 341 PERLVARI(I, splitstr,   const char *, " ")
 342
 343 PERLVAR(I, minus_c,     bool)
 344 PERLVAR(I, minus_n,     bool)
 345 PERLVAR(I, minus_p,     bool)
 346 PERLVAR(I, minus_l,     bool)
 347 PERLVAR(I, minus_a,     bool)
 348 PERLVAR(I, minus_F,     bool)
 349 PERLVAR(I, doswitches,  bool)
 350 PERLVAR(I, minus_E,     bool)
 351
 352 PERLVAR(I, inplace,     char *)
 353 PERLVAR(I, e_script,    SV *)
 354
 355 PERLVAR(I, basetime,    Time_t)         /* $^T */
 356
 357 PERLVARI(I, maxsysfd,   I32,    MAXSYSFD)
 358                                         /* top fd to pass to subprocesses */
 359 PERLVAR(I, statusvalue, I32)            /* $? */
 360 #ifdef VMS
 361 PERLVAR(I, statusvalue_vms, U32)
 362 #else
 363 PERLVAR(I, statusvalue_posix, I32)
 364 #endif
 365
 366 PERLVARI(I, sig_pending, int, 0)        /* Number if highest signal pending */
 367 PERLVAR(I, psig_pend, int *)            /* per-signal "count" of pending */
 368
 369 /* shortcuts to various I/O objects */
 370 PERLVAR(I, stdingv,     GV *)           /*  *STDIN      */
 371 PERLVAR(I, stderrgv,    GV *)           /*  *STDERR     */
 372 PERLVAR(I, argvgv,      GV *)           /*  *ARGV       */
 373 PERLVAR(I, argvoutgv,   GV *)           /*  *ARGVOUT    */
 374 PERLVAR(I, argvout_stack, AV *)
 375
 376 /* shortcuts to regexp stuff */
 377 PERLVAR(I, replgv,      GV *)           /*  *^R         */
 378
 379 /* shortcuts to misc objects */
 380 PERLVAR(I, errgv,       GV *)           /*  *@          */
 381
 382 /* shortcuts to debugging objects */
 383 PERLVAR(I, DBgv,        GV *)           /*  *DB::DB     */
 384 PERLVAR(I, DBline,      GV *)           /*  *DB::line   */
 385
 386 /*
 387 =for apidoc mn|GV *|PL_DBsub
 388 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
 389 the SV which holds the name of the sub being debugged.  This is the C
 390 variable which corresponds to Perl's $DB::sub variable.  See
 391 C<L</PL_DBsingle>>.
 392
 393 =for apidoc mn|SV *|PL_DBsingle
 394 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
 395 boolean which indicates whether subs are being single-stepped.
 396 Single-stepping is automatically turned on after every step.  This is the C
 397 variable which corresponds to Perl's $DB::single variable.  See
 398 C<L</PL_DBsub>>.
 399
 400 =for apidoc mn|SV *|PL_DBtrace
 401 Trace variable used when Perl is run in debugging mode, with the B<-d>
 402 switch.  This is the C variable which corresponds to Perl's $DB::trace
 403 variable.  See C<L</PL_DBsingle>>.
 404
 405 =cut
 406 */
 407
 408 PERLVAR(I, DBsub,       GV *)           /*  *DB::sub    */
 409 PERLVAR(I, DBsingle,    SV *)           /*  $DB::single */
 410 PERLVAR(I, DBtrace,     SV *)           /*  $DB::trace  */
 411 PERLVAR(I, DBsignal,    SV *)           /*  $DB::signal */
 412 PERLVAR(I, dbargs,      AV *)           /* args to call listed by caller function */
 413
 414 PERLVARA(I, DBcontrol,    DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
 415
 416 /* symbol tables */
 417 PERLVAR(I, debstash,    HV *)           /* symbol table for perldb package */
 418 PERLVAR(I, globalstash, HV *)           /* global keyword overrides imported here */
 419 PERLVAR(I, curstname,   SV *)           /* name of current package */
 420 PERLVAR(I, beginav,     AV *)           /* names of BEGIN subroutines */
 421 PERLVAR(I, endav,       AV *)           /* names of END subroutines */
 422 PERLVAR(I, unitcheckav, AV *)           /* names of UNITCHECK subroutines */
 423 PERLVAR(I, checkav,     AV *)           /* names of CHECK subroutines */
 424 PERLVAR(I, initav,      AV *)           /* names of INIT subroutines */
 425
 426 /* subprocess state */
 427 PERLVAR(I, fdpid,       AV *)           /* keep fd-to-pid mappings for my_popen */
 428
 429 /* internal state */
 430 PERLVARI(I, op_mask,    char *, NULL)   /* masked operations for safe evals */
 431
 432 /* current interpreter roots */
 433 PERLVAR(I, main_cv,     CV *)
 434 PERLVAR(I, main_root,   OP *)
 435 PERLVAR(I, main_start,  OP *)
 436 PERLVAR(I, eval_root,   OP *)
 437 PERLVAR(I, eval_start,  OP *)
 438
 439 /* runtime control stuff */
 440 PERLVARI(I, curcopdb,   COP *,  NULL)
 441
 442 PERLVAR(I, filemode,    int)            /* so nextargv() can preserve mode */
 443 PERLVAR(I, lastfd,      int)            /* what to preserve mode on */
 444 PERLVAR(I, oldname,     char *)         /* what to preserve mode on */
 445 PERLVAR(I, Argv,        const char **)  /* stuff to free from do_aexec, vfork safe */
 446 PERLVAR(I, Cmd,         char *)         /* stuff to free from do_aexec, vfork safe */
 447 /* Elements in this array have ';' appended and are injected as a single line
 448    into the tokeniser. You can't put any (literal) newlines into any program
 449    you stuff in into this array, as the point where it's injected is expecting
 450    a single physical line. */
 451 PERLVAR(I, preambleav,  AV *)
 452 PERLVAR(I, mess_sv,     SV *)
 453 PERLVAR(I, ors_sv,      SV *)           /* output record separator $\ */
 454
 455 /* funky return mechanisms */
 456 PERLVAR(I, forkprocess, int)            /* so do_open |- can return proc# */
 457
 458 /* statics moved here for shared library purposes */
 459 PERLVARI(I, gensym,     I32,    0)      /* next symbol for getsym() to define */
 460 PERLVARI(I, cv_has_eval, bool, FALSE)   /* PL_compcv includes an entereval or similar */
 461 PERLVAR(I, taint_warn,  bool)           /* taint warns instead of dying */
 462 PERLVARI(I, laststype,  U16,    OP_STAT)
 463
 464 PERLVARI(I, laststatval, int,   -1)
 465
 466 PERLVAR(I, modcount,    I32)            /* how much op_lvalue()ification in
 467                                            assignment? */
 468
 469 /* interpreter atexit processing */
 470 PERLVARI(I, exitlistlen, I32, 0)        /* length of same */
 471 PERLVARI(I, exitlist,   PerlExitListEntry *, NULL)
 472                                         /* list of exit functions */
 473
 474 /*
 475 =for apidoc Amn|HV*|PL_modglobal
 476
 477 C<PL_modglobal> is a general purpose, interpreter global HV for use by
 478 extensions that need to keep information on a per-interpreter basis.
 479 In a pinch, it can also be used as a symbol table for extensions
 480 to share data among each other.  It is a good idea to use keys
 481 prefixed by the package name of the extension that owns the data.
 482
 483 =cut
 484 */
 485
 486 PERLVAR(I, modglobal,   HV *)           /* per-interp module data */
 487
 488 /* these used to be in global before 5.004_68 */
 489 PERLVARI(I, profiledata, U32 *, NULL)   /* table of ops, counts */
 490
 491 PERLVAR(I, compiling,   COP)            /* compiling/done executing marker */
 492
 493 PERLVAR(I, compcv,      CV *)           /* currently compiling subroutine */
 494 PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
 495 PERLVAR(I, comppad_name_fill,   PADOFFSET)/* last "introduced" variable offset */
 496 PERLVAR(I, comppad_name_floor,  PADOFFSET)/* start of vars in innermost block */
 497
 498 #ifdef HAVE_INTERP_INTERN
 499 PERLVAR(I, sys_intern,  struct interp_intern)
 500                                         /* platform internals */
 501 #endif
 502
 503 /* more statics moved here */
 504 PERLVAR(I, DBcv,        CV *)           /* from perl.c */
 505 PERLVARI(I, generation, int,    100)    /* scan sequence# for OP_AASSIGN
 506                                            compile-time common elem detection */
 507
 508 PERLVAR(I, unicode, U32)        /* Unicode features: $ENV{PERL_UNICODE} or -C */
 509
 510 PERLVARI(I, in_clean_objs,bool,    FALSE)       /* from sv.c */
 511 PERLVARI(I, in_clean_all, bool,    FALSE)       /* ptrs to freed SVs now legal */
 512 PERLVAR(I, nomemok,     bool)           /* let malloc context handle nomem */
 513 PERLVARI(I, savebegin,  bool,   FALSE)  /* save BEGINs for compiler     */
 514
 515
 516 PERLVAR(I, delaymagic_uid,      Uid_t)  /* current real user id, only for delaymagic */
 517 PERLVAR(I, delaymagic_euid,     Uid_t)  /* current effective user id, only for delaymagic */
 518 PERLVAR(I, delaymagic_gid,      Gid_t)  /* current real group id, only for delaymagic */
 519 PERLVAR(I, delaymagic_egid,     Gid_t)  /* current effective group id, only for delaymagic */
 520 PERLVARI(I, an,         U32,    0)      /* malloc sequence number */
 521
 522 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
 523 PERLVARI(I, breakable_sub_gen, U32, 0)
 524
 525 #ifdef DEBUGGING
 526     /* exercise wrap-around */
 527     #define PERL_COP_SEQMAX (U32_MAX-50)
 528 #else
 529     #define PERL_COP_SEQMAX 0
 530 #endif
 531 PERLVARI(I, cop_seqmax, U32,    PERL_COP_SEQMAX) /* statement sequence number */
 532 #undef PERL_COP_SEQMAX
 533
 534 PERLVARI(I, evalseq,    U32,    0)      /* eval sequence number */
 535 PERLVAR(I, origalen,    U32)
 536 PERLVAR(I, origenviron, char **)
 537 #ifdef PERL_USES_PL_PIDSTATUS
 538 PERLVAR(I, pidstatus,   HV *)           /* pid-to-status mappings for waitpid */
 539 #endif
 540 PERLVAR(I, osname,      char *)         /* operating system */
 541
 542 PERLVAR(I, sighandlerp, Sighandler_t)
 543
 544 PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
 545
 546 PERLVAR(I, debug,       VOL U32)        /* flags given to -D switch */
 547
 548 PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist clones */
 549
 550 PERLVARI(I, runops,     runops_proc_t, RUNOPS_DEFAULT)
 551
 552 PERLVAR(I, subname,     SV *)           /* name of current subroutine */
 553
 554 PERLVAR(I, subline,     I32)            /* line this subroutine began on */
 555 PERLVAR(I, min_intro_pending, PADOFFSET)/* start of vars to introduce */
 556
 557 PERLVAR(I, max_intro_pending, PADOFFSET)/* end of vars to introduce */
 558 PERLVAR(I, padix,       PADOFFSET)      /* lowest unused index - 1
 559                                            in current "register" pad */
 560 PERLVAR(I, constpadix,  PADOFFSET)      /* lowest unused for constants */
 561
 562 PERLVAR(I, padix_floor, PADOFFSET)      /* how low may inner block reset padix */
 563
 564 #ifdef USE_LOCALE_COLLATE
 565 PERLVAR(I, collation_name, char *)      /* Name of current collation */
 566 PERLVAR(I, collxfrm_base, Size_t)       /* Basic overhead in *xfrm() */
 567 PERLVARI(I, collxfrm_mult,Size_t, 2)    /* Expansion factor in *xfrm() */
 568 PERLVARI(I, collation_ix, U32,  0)      /* Collation generation index */
 569 PERLVARI(I, strxfrm_NUL_replacement, U8, 0)  /* Code point to replace NULs */
 570 PERLVARI(I, strxfrm_is_behaved, bool, TRUE)
 571                             /* Assume until proven otherwise that it works */
 572 PERLVARI(I, strxfrm_max_cp, U8, 0)      /* Highest collating cp in locale */
 573 PERLVARI(I, collation_standard, bool, TRUE)
 574                                         /* Assume simple collation */
 575 #endif /* USE_LOCALE_COLLATE */
 576
 577 #ifdef PERL_SAWAMPERSAND
 578 PERLVAR(I, sawampersand, U8)            /* must save all match strings */
 579 #endif
 580
 581 PERLVAR(I, unsafe,      bool)
 582 PERLVAR(I, colorset,    bool)           /* PERL_RE_COLORS env var is in use */
 583
 584 /* current phase the interpreter is in
 585    for ordering this structure to remove holes, we're assuming that this is 4
 586    bytes.  */
 587 PERLVARI(I, phase,      enum perl_phase, PERL_PHASE_CONSTRUCT)
 588
 589 PERLVARI(I, in_load_module, bool, FALSE)        /* to prevent recursions in PerlIO_find_layer */
 590
 591 /* This value may be set when embedding for full cleanup  */
 592 /* 0=none, 1=full, 2=full with checks */
 593 /* mod_perl is special, and also assigns a meaning -1 */
 594 PERLVARI(I, perl_destruct_level, signed char,   0)
 595
 596 #ifdef USE_LOCALE_NUMERIC
 597
 598 PERLVARI(I, numeric_standard, int, TRUE)
 599                                         /* Assume simple numerics */
 600 PERLVARI(I, numeric_local, bool, TRUE)
 601                                         /* Assume local numerics */
 602 PERLVAR(I, numeric_name, char *)        /* Name of current numeric locale */
 603 PERLVAR(I, numeric_radix_sv, SV *)      /* The radix separator if not '.' */
 604
 605 #endif /* !USE_LOCALE_NUMERIC */
 606
 607 /* Unicode inversion lists */
 608 PERLVAR(I, Latin1,      SV *)
 609 PERLVAR(I, UpperLatin1, SV *)   /* Code points 128 - 255 */
 610 PERLVAR(I, AboveLatin1, SV *)
 611 PERLVAR(I, InBitmap,    SV *)
 612
 613 PERLVAR(I, NonL1NonFinalFold,   SV *)
 614 PERLVAR(I, HasMultiCharFold,   SV *)
 615
 616 /* utf8 character class swashes */
 617 PERLVAR(I, utf8_mark,   SV *)
 618 PERLVAR(I, utf8_toupper, SV *)
 619 PERLVAR(I, utf8_totitle, SV *)
 620 PERLVAR(I, utf8_tolower, SV *)
 621 PERLVAR(I, utf8_tofold, SV *)
 622 PERLVAR(I, utf8_charname_begin, SV *)
 623 PERLVAR(I, utf8_charname_continue, SV *)
 624
 625 PERLVARA(I, utf8_swash_ptrs, POSIX_SWASH_COUNT, SV *)
 626 PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
 627 PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
 628 PERLVAR(I, GCB_invlist, SV *)
 629 PERLVAR(I, LB_invlist, SV *)
 630 PERLVAR(I, SB_invlist, SV *)
 631 PERLVAR(I, WB_invlist, SV *)
 632 PERLVAR(I, Assigned_invlist, SV *)
 633 PERLVAR(I, seen_deprecated_macro, HV *)
 634
 635 PERLVAR(I, last_swash_hv, HV *)
 636 PERLVAR(I, last_swash_tmps, U8 *)
 637 PERLVAR(I, last_swash_slen, STRLEN)
 638 PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8)
 639 PERLVAR(I, last_swash_klen, U8)         /* Only needs to store 0-12  */
 640
 641 #ifdef FCRYPT
 642 PERLVARI(I, cryptseen,  bool,   FALSE)  /* has fast crypt() been initialized? */
 643 #else
 644 /* One byte hole in the interpreter structure.  */
 645 #endif
 646
 647 PERLVAR(I, pad_reset_pending, bool)     /* reset pad on next attempted alloc */
 648 PERLVAR(I, srand_called, bool)
 649
 650 /* Array of signal handlers, indexed by signal number, through which the C
 651    signal handler dispatches.  */
 652 PERLVAR(I, psig_ptr,    SV **)
 653 /* Array of names of signals, indexed by signal number, for (re)use as the first
 654    argument to a signal handler.   Only one block of memory is allocated for
 655    both psig_name and psig_ptr.  */
 656 PERLVAR(I, psig_name,   SV **)
 657
 658 #if defined(PERL_IMPLICIT_SYS)
 659 PERLVAR(I, Mem,         struct IPerlMem *)
 660 PERLVAR(I, MemShared,   struct IPerlMem *)
 661 PERLVAR(I, MemParse,    struct IPerlMem *)
 662 PERLVAR(I, Env,         struct IPerlEnv *)
 663 PERLVAR(I, StdIO,       struct IPerlStdIO *)
 664 PERLVAR(I, LIO,         struct IPerlLIO *)
 665 PERLVAR(I, Dir,         struct IPerlDir *)
 666 PERLVAR(I, Sock,        struct IPerlSock *)
 667 PERLVAR(I, Proc,        struct IPerlProc *)
 668 #endif
 669
 670 PERLVAR(I, ptr_table,   PTR_TBL_t *)
 671 PERLVARI(I, beginav_save, AV *, NULL)   /* save BEGIN{}s when compiling */
 672
 673 PERLVAR(I, body_arenas, void *)         /* pointer to list of body-arenas */
 674
 675
 676 #if defined(USE_ITHREADS)
 677 PERLVAR(I, regex_pad,     SV **)        /* Shortcut into the array of
 678                                            regex_padav */
 679 PERLVAR(I, regex_padav,   AV *)         /* All regex objects, indexed via the
 680                                            values in op_pmoffset of pmop.
 681                                            Entry 0 is an SV whose PV is a
 682                                            "packed" list of IVs listing
 683                                            the now-free slots in the array */
 684 PERLVAR(I, stashpad,    HV **)          /* for CopSTASH */
 685 PERLVARI(I, stashpadmax, PADOFFSET, 64)
 686 PERLVARI(I, stashpadix, PADOFFSET, 0)
 687 #endif
 688
 689 #ifdef USE_REENTRANT_API
 690 PERLVAR(I, reentrant_buffer, REENTR *)  /* here we store the _r buffers */
 691 #endif
 692
 693 PERLVAR(I, custom_op_names, HV *)       /* Names of user defined ops */
 694 PERLVAR(I, custom_op_descs, HV *)       /* Descriptions of user defined ops */
 695
 696 #ifdef PERLIO_LAYERS
 697 PERLVARI(I, perlio,     PerlIOl *, NULL)
 698 PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
 699 PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
 700 #endif
 701
 702 PERLVAR(I, utf8_idstart, SV *)
 703 PERLVAR(I, utf8_idcont, SV *)
 704 PERLVAR(I, utf8_xidstart, SV *)
 705 PERLVAR(I, utf8_perl_idstart, SV *)
 706 PERLVAR(I, utf8_perl_idcont, SV *)
 707 PERLVAR(I, utf8_xidcont, SV *)
 708
 709 PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
 710
 711 PERLVARI(I, checkav_save, AV *, NULL)   /* save CHECK{}s when compiling */
 712 PERLVARI(I, unitcheckav_save, AV *, NULL)
 713                                         /* save UNITCHECK{}s when compiling */
 714
 715 PERLVARI(I, clocktick,  long,   0)      /* this many times() ticks in a second */
 716
 717 /* Hooks to shared SVs and locks. */
 718 PERLVARI(I, sharehook,  share_proc_t, Perl_sv_nosharing)
 719 PERLVARI(I, lockhook,   share_proc_t, Perl_sv_nosharing)
 720 #ifdef NO_MATHOMS
 721 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
 722 #else
 723 /* This reference ensures that the mathoms are linked with perl */
 724 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
 725 #endif
 726 PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
 727
 728 PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
 729
 730 /* Can shared object be destroyed */
 731 PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
 732
 733 #ifndef PERL_MICRO
 734 PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
 735 #endif
 736
 737 PERLVARI(I, isarev, HV *, NULL)         /* Reverse map of @ISA dependencies */
 738
 739 /* Register of known Method Resolution Orders.
 740    What this actually points to is an implementation detail (it may change to
 741    a structure incorporating a reference count - use mro_get_from_name to
 742    retrieve a C<struct mro_alg *>  */
 743 PERLVAR(I, registered_mros, HV *)
 744
 745 /* Compile-time block start/end hooks */
 746 PERLVAR(I, blockhooks,  AV *)
 747
 748 /* Everything that folds to a given character, for case insensitivity regex
 749  * matching */
 750 PERLVARI(I, utf8_foldclosures, HV *, NULL)
 751
 752 /* List of characters that participate in folds (except marks, etc in
 753  * multi-char folds) */
 754 PERLVARI(I, utf8_foldable, SV *, NULL)
 755
 756 PERLVAR(I, custom_ops,  HV *)           /* custom op registrations */
 757
 758 PERLVAR(I, Xpv,         XPV *)          /* (unused) held temporary value */
 759
 760 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
 761    present always, as -DDEBUGGING must be binary compatible with non.  */
 762 PERLVARI(I, scopestack_name, const char * *, NULL)
 763
 764 PERLVAR(I, debug_pad,   struct perl_debug_pad)  /* always needed because of the re extension */
 765
 766 /* Hook for File::Glob */
 767 PERLVARI(I, globhook,   globhook_t, NULL)
 768
 769 /* The last unconditional member of the interpreter structure when 5.18.0 was
 770    released. The offset of the end of this is baked into a global variable in
 771    any shared perl library which will allow a sanity test in future perl
 772    releases.  */
 773 #define PERL_LAST_5_18_0_INTERP_MEMBER  Iglobhook
 774
 775 #ifdef PERL_IMPLICIT_CONTEXT
 776 PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
 777 PERLVARI(I, my_cxt_size, int,   0)      /* size of PL_my_cxt_list */
 778 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 779 PERLVARI(I, my_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
 780 #  endif
 781 #endif
 782
 783 #if defined(PERL_IMPLICIT_CONTEXT) || defined(PERL_DEBUG_READONLY_COW)
 784 /* For use with the memory debugging code in util.c. This is used only in
 785  * DEBUGGING builds (as long as the relevant structure is defined), but
 786  * defining it in non-debug builds too means that we retain binary
 787  * compatibility between otherwise-compatible plain and debug builds. */
 788 PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
 789 #endif
 790
 791 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
 792 /* File descriptor to talk to the child which dumps scalars.  */
 793 PERLVARI(I, dumper_fd,  int,    -1)
 794 #endif
 795
 796
 797 #ifdef DEBUG_LEAKING_SCALARS
 798 PERLVARI(I, sv_serial,  U32,    0)      /* SV serial number, used in sv.c */
 799 #endif
 800
 801 PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*)    /* constant SVs with precomputed hash value */
 802
 803 #ifdef PERL_TRACE_OPS
 804 PERLVARA(I, op_exec_cnt, OP_max+2, UV)  /* Counts of executed OPs of the given type.
 805                                            If PERL_TRACE_OPS is enabled, we'll dump
 806                                            a summary count of all ops executed in the
 807                                            program at perl_destruct time. For
 808                                            profiling/debugging only. Works only if
 809                                            DEBUGGING is enabled, too. */
 810 #endif
 811
 812 PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
 813
 814 PERLVARI(I, dump_re_max_len, STRLEN, 0)
 815
 816 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
 817  * above on where there are gaps which currently will be structure padding.  */
 818
 819 /* Within a stable branch, new variables must be added to the very end, before
 820  * this comment, for binary compatibility (the offsets of the old members must
 821  *  not change).
 822  * (Don't forget to add your variable also to perl_clone()!)
 823  * XSUB.h provides wrapper functions via perlapi.h that make this
 824  * irrelevant, but not all code may be expected to #include XSUB.h.
 825  */