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