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