3 * Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 * 2006, 2007, 2008 by Larry Wall and others
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.
13 /* These variables are per-interpreter in threaded/multiplicity builds,
16 * Don't forget to re-run regen/embed.pl to propagate changes! */
18 /* New variables must be added to the very end for binary compatibility. */
20 /* DON'T FORGET to add your variable also to perl_clone()! (in sv.c) */
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.
27 * When building without MULTIPLICITY, these variables will be truly global.
29 * Important ones in the first cache line (if alignment is done right) */
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) */
35 PERLVAR(I, stack_base, SV **)
36 PERLVAR(I, stack_max, SV **)
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)
43 PERLVAR(I, scopestack, I32 *) /* scopes we've ENTERed */
44 PERLVAR(I, scopestack_ix, I32)
45 PERLVAR(I, scopestack_max, I32)
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 */
52 PERLVAR(I, markstack, I32 *) /* stack_sp locations we're
54 PERLVAR(I, markstack_ptr, I32 *)
55 PERLVAR(I, markstack_max, I32 *)
57 PERLVARI(I, sub_generation, U32, 1) /* incr to invalidate method cache */
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 */
63 PERLVARI(I, hash_rand_bits, UV, 0) /* used to randomize hash stuff */
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 *)
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 */
74 PERLVAR(I, tainting, bool) /* ? doing taint checks */
75 PERLVARI(I, tainted, bool, FALSE) /* using variables controlled by $< */
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().
86 * NB: PL_delaymagic is automatically saved and restored by JMPENV_PUSH
87 * / POP. This removes the need to do ENTER/SAVEI16(PL_delaymagic)/LEAVE
88 * in hot code like pp_push.
90 PERLVAR(I, delaymagic, U16) /* ($<,$>) = ... */
93 =for apidoc_section $warning
94 =for apidoc mn|U8|PL_dowarn
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.
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
107 PERLVAR(I, dowarn, U8)
109 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
114 PERLVARI(I, utf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
118 =for apidoc_section $GV
119 =for apidoc Amn|GV *|PL_defgv
121 The GV representing C<*_>. Useful for access to C<$_>.
123 On threaded perls, each thread has an independent copy of this variable;
124 each initialized at creation time with the current value of the creating
130 PERLVAR(I, localizing, U8) /* are we processing a local() list? */
131 PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */
132 PERLVAR(I, defgv, GV *) /* the *_ glob */
135 =for apidoc_section $GV
136 =for apidoc Amn|HV*|PL_curstash
138 The stash for the package code will be compiled into.
140 On threaded perls, each thread has an independent copy of this variable;
141 each initialized at creation time with the current value of the creating
148 PERLVAR(I, defstash, HV *) /* main symbol table */
149 PERLVAR(I, curstash, HV *) /* symbol table for current package */
152 =for apidoc_section $COP
153 =for apidoc Amn|COP*|PL_curcop
155 The currently active COP (control op) roughly representing the current
156 statement in the source.
158 On threaded perls, each thread has an independent copy of this variable;
159 each initialized at creation time with the current value of the creating
165 PERLVAR(I, curcop, COP *)
166 PERLVAR(I, curstack, AV *) /* THE STACK */
167 PERLVAR(I, curstackinfo, PERL_SI *) /* current stack + context */
168 PERLVAR(I, mainstack, AV *) /* the stack when nothing funny is
171 /* memory management */
172 PERLVAR(I, sv_count, IV) /* how many SV* are currently allocated */
174 PERLVAR(I, sv_root, SV *) /* storage for SVs belonging to interp */
175 PERLVAR(I, sv_arenaroot, SV *) /* list of areas for garbage collection */
177 /* fake PMOP that PL_curpm points to while in (?{}) so $1 et al are visible */
178 PERLVARI(I, reg_curpm, PMOP*, NULL)
180 /* the currently active slab in a chain of slabs of regmatch states,
181 * and the currently active state within that slab. This stack of states
182 * is shared amongst re-entrant calls to the regex engine */
184 PERLVARI(I, regmatch_slab, regmatch_slab *, NULL)
185 PERLVAR(I, regmatch_state, regmatch_state *)
187 PERLVAR(I, comppad, PAD *) /* storage for lexically scoped temporaries */
190 =for apidoc_section $SV
191 =for apidoc Amn|SV|PL_sv_undef
192 This is the C<undef> SV. It is readonly. Always refer to this as
195 =for apidoc Amn|SV|PL_sv_no
196 This is the C<false> SV. It is readonly. See C<L</PL_sv_yes>>. Always refer
197 to this as C<&PL_sv_no>.
199 =for apidoc Amn|SV|PL_sv_yes
200 This is the C<true> SV. It is readonly. See C<L</PL_sv_no>>. Always refer to
201 this as C<&PL_sv_yes>.
203 =for apidoc Amn|SV|PL_sv_zero
204 This readonly SV has a zero numeric value and a C<"0"> string value. It's
205 similar to C<L</PL_sv_no>> except for its string value. Can be used as a
206 cheap alternative to C<mXPUSHi(0)> for example. Always refer to this as
207 C<&PL_sv_zero>. Introduced in 5.28.
213 PERLVAR(I, sv_yes, SV)
214 PERLVAR(I, sv_undef, SV)
215 PERLVAR(I, sv_no, SV)
216 PERLVAR(I, sv_zero, SV)
218 /* store the immortals as an array to ensure they are contiguous in
219 * memory: makes SvIMMORTAL_INTERP(sv) possible */
220 PERLVARA(I, sv_immortals, 4, SV)
223 PERLVAR(I, padname_undef, PADNAME)
224 PERLVAR(I, padname_const, PADNAME)
227 =for apidoc_section $SV
228 =for apidoc Cmn||PL_Sv
230 A scratch pad SV for whatever temporary use you need. Chiefly used as a
231 fallback by macros on platforms where L<perlapi/PERL_USE_GCC_BRACE_GROUPS>> is
232 unavailable, and which would otherwise evaluate their SV parameter more than
235 B<BUT BEWARE>, if this is used in a situation where something that is using it
236 is in a call stack with something else that is using it, this variable would
237 get zapped, leading to hard-to-diagnose errors.
243 PERLVAR(I, parser, yy_parser *) /* current parser state */
245 PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */
249 =for apidoc_section $string
250 =for apidoc Amn|STRLEN|PL_na
252 A scratch pad variable in which to store a C<STRLEN> value. If would have been
253 better named something like C<PL_temp_strlen>.
255 It is is typically used with C<SvPV> when one is actually planning to discard
256 the returned length, (hence the length is "Not Applicable", which is how this
257 variable got its name).
259 B<BUT BEWARE>, if this is used in a situation where something that is using it
260 is in a call stack with something else that is using it, this variable would
261 get zapped, leading to hard-to-diagnose errors.
263 It is usually more efficient to either declare a local variable and use that
264 instead, or to use the C<SvPV_nolen> macro.
269 PERLVAR(I, na, STRLEN) /* for use in SvPV when length is
273 PERLVAR(I, statcache, Stat_t) /* _ */
274 PERLVAR(I, statgv, GV *)
275 PERLVARI(I, statname, SV *, NULL)
278 =for apidoc_section $io
279 =for apidoc mn|SV*|PL_rs
281 The input record separator - C<$/> in Perl space.
283 On threaded perls, each thread has an independent copy of this variable;
284 each initialized at creation time with the current value of the creating
287 =for apidoc_section $io
288 =for apidoc mn|GV*|PL_last_in_gv
290 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
292 On threaded perls, each thread has an independent copy of this variable;
293 each initialized at creation time with the current value of the creating
296 =for apidoc_section $io
297 =for apidoc mn|GV*|PL_ofsgv
299 The glob containing the output field separator - C<*,> in Perl space.
301 On threaded perls, each thread has an independent copy of this variable;
302 each initialized at creation time with the current value of the creating
308 PERLVAR(I, rs, SV *) /* input record separator $/ */
309 PERLVAR(I, last_in_gv, GV *) /* GV used in last <FH> */
310 PERLVAR(I, ofsgv, GV *) /* GV of output field separator *, */
311 PERLVAR(I, defoutgv, GV *) /* default FH for output */
312 PERLVARI(I, chopset, const char *, " \n-") /* $: */
313 PERLVAR(I, formtarget, SV *)
314 PERLVAR(I, bodytarget, SV *)
315 PERLVAR(I, toptarget, SV *)
318 PERLVAR(I, restartop, OP *) /* propagating an error from croak? */
319 PERLVAR(I, restartjmpenv, JMPENV *) /* target frame for longjmp in die */
321 PERLVAR(I, top_env, JMPENV *) /* ptr to current sigjmp environment */
322 PERLVAR(I, start_env, JMPENV) /* empty startup sigjmp environment */
323 PERLVARI(I, errors, SV *, NULL) /* outstanding queued errors */
325 /* statics "owned" by various functions */
326 PERLVAR(I, hv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
328 PERLVAR(I, lastgotoprobe, OP*) /* from pp_ctl.c */
331 PERLVAR(I, sortcop, OP *) /* user defined sort routine */
332 PERLVAR(I, sortstash, HV *) /* which is in some package or other */
333 PERLVAR(I, firstgv, GV *) /* $a */
334 PERLVAR(I, secondgv, GV *) /* $b */
337 PERLVAR(I, efloatbuf, char *)
338 PERLVAR(I, efloatsize, STRLEN)
340 PERLVARI(I, dumpindent, U16, 4) /* number of blanks per dump
344 =for apidoc_section $embedding
345 =for apidoc Amn|U8|PL_exit_flags
347 Contains flags controlling perl's behaviour on exit():
351 =item * C<PERL_EXIT_DESTRUCT_END>
353 If set, END blocks are executed when the interpreter is destroyed.
354 This is normally set by perl itself after the interpreter is
357 =item * C<PERL_EXIT_ABORT>
359 Call C<abort()> on exit. This is used internally by perl itself to
360 abort if exit is called while processing exit.
362 =item * C<PERL_EXIT_WARN>
366 =item * C<PERL_EXIT_EXPECTED>
368 Set by the L<perlfunc/exit> operator.
372 =for apidoc Amnh||PERL_EXIT_EXPECTED
373 =for apidoc Amnh||PERL_EXIT_ABORT
374 =for apidoc Amnh||PERL_EXIT_DESTRUCT_END
375 =for apidoc Amnh||PERL_EXIT_WARN
377 On threaded perls, each thread has an independent copy of this variable;
378 each initialized at creation time with the current value of the creating
384 PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
386 PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
387 PERLVAR(I, in_utf8_CTYPE_locale, bool)
388 PERLVAR(I, in_utf8_COLLATE_locale, bool)
389 PERLVAR(I, in_utf8_turkic_locale, bool)
390 #if defined(USE_LOCALE) && defined(USE_LOCALE_THREADS)
391 PERLVARI(I, locale_mutex_depth, int, 0) /* Emulate general semaphore */
394 #ifdef USE_LOCALE_CTYPE
395 PERLVAR(I, warn_locale, SV *)
398 PERLVARA(I, colors,6, char *) /* values from PERL_RE_COLORS env var */
401 =for apidoc_section $optree_construction
402 =for apidoc Amn|peep_t|PL_peepp
404 Pointer to the per-subroutine peephole optimiser. This is a function
405 that gets called at the end of compilation of a Perl subroutine (or
406 equivalently independent piece of Perl code) to perform fixups of
407 some ops and to perform small-scale optimisations. The function is
408 called once for each subroutine that is compiled, and is passed, as sole
409 parameter, a pointer to the op that is the entry point to the subroutine.
410 It modifies the op tree in place.
412 The peephole optimiser should never be completely replaced. Rather,
413 add code to it by wrapping the existing optimiser. The basic way to do
414 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
415 If the new code wishes to operate on ops throughout the subroutine's
416 structure, rather than just at the top level, it is likely to be more
417 convenient to wrap the L</PL_rpeepp> hook.
419 On threaded perls, each thread has an independent copy of this variable;
420 each initialized at creation time with the current value of the creating
426 PERLVARI(I, peepp, peep_t, Perl_peep)
429 =for apidoc_section $optree_construction
430 =for apidoc Amn|peep_t|PL_rpeepp
432 Pointer to the recursive peephole optimiser. This is a function
433 that gets called at the end of compilation of a Perl subroutine (or
434 equivalently independent piece of Perl code) to perform fixups of some
435 ops and to perform small-scale optimisations. The function is called
436 once for each chain of ops linked through their C<op_next> fields;
437 it is recursively called to handle each side chain. It is passed, as
438 sole parameter, a pointer to the op that is at the head of the chain.
439 It modifies the op tree in place.
441 The peephole optimiser should never be completely replaced. Rather,
442 add code to it by wrapping the existing optimiser. The basic way to do
443 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
444 If the new code wishes to operate only on ops at a subroutine's top level,
445 rather than throughout the structure, it is likely to be more convenient
446 to wrap the L</PL_peepp> hook.
448 On threaded perls, each thread has an independent copy of this variable;
449 each initialized at creation time with the current value of the creating
455 PERLVARI(I, rpeepp, peep_t, Perl_rpeep)
458 =for apidoc_section $optrees
459 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
461 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.
462 This allows extensions to free any extra attribute they have locally attached to an OP.
463 It is also assured to first fire for the parent OP and then for its kids.
465 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.
467 On threaded perls, each thread has an independent copy of this variable;
468 each initialized at creation time with the current value of the creating
474 PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
476 PERLVARI(I, watchaddr, char **, 0)
477 PERLVAR(I, watchok, char *)
479 PERLVAR(I, perldb, U32)
481 PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */
483 PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */
485 /* pseudo environmental stuff */
486 PERLVAR(I, origargc, int)
487 PERLVAR(I, origargv, char **)
488 PERLVAR(I, envgv, GV *)
489 PERLVAR(I, incgv, GV *)
490 PERLVAR(I, hintgv, GV *)
491 PERLVAR(I, origfilename, char *)
492 PERLVARI(I, xsubfilename, const char *, NULL)
493 PERLVAR(I, diehook, SV *)
494 PERLVAR(I, warnhook, SV *)
497 PERLVAR(I, patchlevel, SV *)
498 PERLVAR(I, localpatches, const char * const *)
499 PERLVARI(I, splitstr, const char *, " ")
501 PERLVAR(I, minus_c, bool)
502 PERLVAR(I, minus_n, bool)
503 PERLVAR(I, minus_p, bool)
504 PERLVAR(I, minus_l, bool)
505 PERLVAR(I, minus_a, bool)
506 PERLVAR(I, minus_F, bool)
507 PERLVAR(I, doswitches, bool)
508 PERLVAR(I, minus_E, bool)
510 PERLVAR(I, inplace, char *)
511 PERLVAR(I, e_script, SV *)
513 PERLVAR(I, basetime, Time_t) /* $^T */
515 PERLVARI(I, maxsysfd, I32, MAXSYSFD)
516 /* top fd to pass to subprocesses */
517 PERLVAR(I, statusvalue, I32) /* $? */
519 PERLVAR(I, statusvalue_vms, U32)
521 PERLVAR(I, statusvalue_posix, I32)
524 PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */
525 PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */
527 /* shortcuts to various I/O objects */
528 PERLVAR(I, stdingv, GV *) /* *STDIN */
529 PERLVAR(I, stderrgv, GV *) /* *STDERR */
530 PERLVAR(I, argvgv, GV *) /* *ARGV */
531 PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */
532 PERLVAR(I, argvout_stack, AV *)
534 /* shortcuts to regexp stuff */
535 PERLVAR(I, replgv, GV *) /* *^R */
537 /* shortcuts to misc objects */
538 PERLVAR(I, errgv, GV *) /* *@ */
540 /* shortcuts to debugging objects */
541 PERLVAR(I, DBgv, GV *) /* *DB::DB */
542 PERLVAR(I, DBline, GV *) /* *DB::line */
545 =for apidoc_section $debugging
546 =for apidoc mn|GV *|PL_DBsub
547 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
548 the SV which holds the name of the sub being debugged. This is the C
549 variable which corresponds to Perl's $DB::sub variable. See
552 On threaded perls, each thread has an independent copy of this variable;
553 each initialized at creation time with the current value of the creating
556 =for apidoc mn|SV *|PL_DBsingle
557 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
558 boolean which indicates whether subs are being single-stepped.
559 Single-stepping is automatically turned on after every step. This is the C
560 variable which corresponds to Perl's $DB::single variable. See
563 On threaded perls, each thread has an independent copy of this variable;
564 each initialized at creation time with the current value of the creating
567 =for apidoc mn|SV *|PL_DBtrace
568 Trace variable used when Perl is run in debugging mode, with the B<-d>
569 switch. This is the C variable which corresponds to Perl's $DB::trace
570 variable. See C<L</PL_DBsingle>>.
572 On threaded perls, each thread has an independent copy of this variable;
573 each initialized at creation time with the current value of the creating
579 PERLVAR(I, DBsub, GV *) /* *DB::sub */
580 PERLVAR(I, DBsingle, SV *) /* $DB::single */
581 PERLVAR(I, DBtrace, SV *) /* $DB::trace */
582 PERLVAR(I, DBsignal, SV *) /* $DB::signal */
583 PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */
585 PERLVARA(I, DBcontrol, DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
588 PERLVAR(I, debstash, HV *) /* symbol table for perldb package */
589 PERLVAR(I, globalstash, HV *) /* global keyword overrides imported here */
590 PERLVAR(I, curstname, SV *) /* name of current package */
591 PERLVAR(I, beginav, AV *) /* names of BEGIN subroutines */
592 PERLVAR(I, endav, AV *) /* names of END subroutines */
593 PERLVAR(I, unitcheckav, AV *) /* names of UNITCHECK subroutines */
594 PERLVAR(I, checkav, AV *) /* names of CHECK subroutines */
595 PERLVAR(I, initav, AV *) /* names of INIT subroutines */
597 /* subprocess state */
598 PERLVAR(I, fdpid, AV *) /* keep fd-to-pid mappings for my_popen */
601 PERLVARI(I, op_mask, char *, NULL) /* masked operations for safe evals */
603 /* current interpreter roots */
604 PERLVAR(I, main_cv, CV *)
605 PERLVAR(I, main_root, OP *)
606 PERLVAR(I, main_start, OP *)
607 PERLVAR(I, eval_root, OP *)
608 PERLVAR(I, eval_start, OP *)
610 /* runtime control stuff */
611 PERLVARI(I, curcopdb, COP *, NULL)
613 PERLVAR(I, filemode, int) /* so nextargv() can preserve mode */
614 PERLVAR(I, lastfd, int) /* what to preserve mode on */
615 PERLVAR(I, oldname, char *) /* what to preserve mode on */
616 /* Elements in this array have ';' appended and are injected as a single line
617 into the tokeniser. You can't put any (literal) newlines into any program
618 you stuff in into this array, as the point where it's injected is expecting
619 a single physical line. */
620 PERLVAR(I, preambleav, AV *)
621 PERLVAR(I, mess_sv, SV *)
622 PERLVAR(I, ors_sv, SV *) /* output record separator $\ */
624 /* funky return mechanisms */
625 PERLVAR(I, forkprocess, int) /* so do_open |- can return proc# */
627 /* statics moved here for shared library purposes */
628 PERLVARI(I, gensym, I32, 0) /* next symbol for getsym() to define */
629 PERLVARI(I, cv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
630 PERLVAR(I, taint_warn, bool) /* taint warns instead of dying */
631 PERLVARI(I, laststype, U16, OP_STAT)
633 PERLVARI(I, laststatval, int, -1)
635 PERLVAR(I, modcount, I32) /* how much op_lvalue()ification in
638 /* interpreter atexit processing */
639 PERLVARI(I, exitlistlen, I32, 0) /* length of same */
640 PERLVARI(I, exitlist, PerlExitListEntry *, NULL)
641 /* list of exit functions */
644 =for apidoc_section $HV
645 =for apidoc Amn|HV*|PL_modglobal
647 C<PL_modglobal> is a general purpose, interpreter global HV for use by
648 extensions that need to keep information on a per-interpreter basis.
649 In a pinch, it can also be used as a symbol table for extensions
650 to share data among each other. It is a good idea to use keys
651 prefixed by the package name of the extension that owns the data.
653 On threaded perls, each thread has an independent copy of this variable;
654 each initialized at creation time with the current value of the creating
660 PERLVAR(I, modglobal, HV *) /* per-interp module data */
662 /* these used to be in global before 5.004_68 */
663 PERLVARI(I, profiledata, U32 *, NULL) /* table of ops, counts */
665 PERLVAR(I, compiling, COP) /* compiling/done executing marker */
667 PERLVAR(I, compcv, CV *) /* currently compiling subroutine */
668 PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
669 PERLVAR(I, comppad_name_fill, PADOFFSET)/* last "introduced" variable offset */
670 PERLVAR(I, comppad_name_floor, PADOFFSET)/* start of vars in innermost block */
672 #ifdef HAVE_INTERP_INTERN
673 PERLVAR(I, sys_intern, struct interp_intern)
674 /* platform internals */
677 /* more statics moved here */
678 PERLVAR(I, DBcv, CV *) /* from perl.c */
679 PERLVARI(I, generation, int, 100) /* scan sequence# for OP_AASSIGN
680 compile-time common elem detection */
682 PERLVAR(I, unicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
684 PERLVARI(I, in_clean_objs,bool, FALSE) /* from sv.c */
685 PERLVARI(I, in_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
686 PERLVAR(I, nomemok, bool) /* let malloc context handle nomem */
687 PERLVARI(I, savebegin, bool, FALSE) /* save BEGINs for compiler */
690 PERLVAR(I, delaymagic_uid, Uid_t) /* current real user id, only for delaymagic */
691 PERLVAR(I, delaymagic_euid, Uid_t) /* current effective user id, only for delaymagic */
692 PERLVAR(I, delaymagic_gid, Gid_t) /* current real group id, only for delaymagic */
693 PERLVAR(I, delaymagic_egid, Gid_t) /* current effective group id, only for delaymagic */
694 PERLVARI(I, an, U32, 0) /* malloc sequence number */
696 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
697 PERLVARI(I, breakable_sub_gen, U32, 0)
700 /* exercise wrap-around */
701 #define PERL_COP_SEQMAX (U32_MAX-50)
703 #define PERL_COP_SEQMAX 0
705 PERLVARI(I, cop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
706 #undef PERL_COP_SEQMAX
708 PERLVARI(I, evalseq, U32, 0) /* eval sequence number */
709 PERLVAR(I, origalen, U32)
710 #ifdef PERL_USES_PL_PIDSTATUS
711 PERLVAR(I, pidstatus, HV *) /* pid-to-status mappings for waitpid */
713 PERLVAR(I, osname, char *) /* operating system */
715 PERLVAR(I, sighandlerp, Sighandler_t)
716 /* these two are provided only to solve library linkage issues; they
717 * should not be hooked by user code */
718 PERLVAR(I, sighandler1p, Sighandler1_t)
719 PERLVAR(I, sighandler3p, Sighandler3_t)
721 PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
723 PERLVAR(I, debug, volatile U32) /* flags given to -D switch */
725 PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist clones */
727 PERLVARI(I, runops, runops_proc_t, RUNOPS_DEFAULT)
729 PERLVAR(I, subname, SV *) /* name of current subroutine */
731 PERLVAR(I, subline, I32) /* line this subroutine began on */
732 PERLVAR(I, min_intro_pending, PADOFFSET)/* start of vars to introduce */
734 PERLVAR(I, max_intro_pending, PADOFFSET)/* end of vars to introduce */
735 PERLVAR(I, padix, PADOFFSET) /* lowest unused index - 1
736 in current "register" pad */
737 PERLVAR(I, constpadix, PADOFFSET) /* lowest unused for constants */
739 PERLVAR(I, padix_floor, PADOFFSET) /* how low may inner block reset padix */
741 #ifdef USE_PL_CURLOCALES
743 /* This is the most number of categories we've encountered so far on any
745 PERLVARA(I, curlocales, 12, const char *)
748 #ifdef USE_LOCALE_COLLATE
750 /* The emory needed to store the collxfrm transformation of a string with
751 * length 'x' is predicted by the linear equation mx+b; m=mult, b=base */
752 PERLVARI(I, collxfrm_mult,Size_t, 0) /* Expansion factor in *xfrm();
753 0 => unknown or bad, depending on
755 PERLVAR(I, collxfrm_base, Size_t) /* Basic overhead in *xfrm();
756 mult == 0, base == 0 => need to compute
757 mult == 0, base != 0 => ill-formed;
759 PERLVAR(I, collation_name, char *) /* Name of current collation */
760 PERLVARI(I, collation_ix, U32, 0) /* Collation generation index */
761 PERLVARI(I, strxfrm_NUL_replacement, U8, 0) /* Code point to replace NULs */
762 PERLVARI(I, strxfrm_is_behaved, bool, TRUE)
763 /* Assume until proven otherwise that it works */
764 PERLVARI(I, strxfrm_max_cp, U8, 0) /* Highest collating cp in locale */
765 PERLVARI(I, collation_standard, bool, TRUE)
766 /* Assume simple collation */
767 #endif /* USE_LOCALE_COLLATE */
769 PERLVARI(I, langinfo_buf, const char *, NULL)
770 PERLVARI(I, langinfo_bufsize, Size_t, 0)
771 PERLVARI(I, setlocale_buf, const char *, NULL)
772 PERLVARI(I, setlocale_bufsize, Size_t, 0)
773 PERLVARI(I, stdize_locale_buf, const char *, NULL)
774 PERLVARI(I, stdize_locale_bufsize, Size_t, 0)
776 #ifdef PERL_SAWAMPERSAND
777 PERLVAR(I, sawampersand, U8) /* must save all match strings */
780 /* current phase the interpreter is in
781 for ordering this structure to remove holes, we're assuming that this is 4
783 PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
785 PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
787 PERLVARI(I, eval_begin_nest_depth, U32, 0)
789 PERLVAR(I, unsafe, bool)
790 PERLVAR(I, colorset, bool) /* PERL_RE_COLORS env var is in use */
793 =for apidoc_section $embedding
794 =for apidoc Amn|signed char|PL_perl_destruct_level
796 This value may be set when embedding for full cleanup.
806 =item * 2 or greater - full with checks.
810 If C<$ENV{PERL_DESTRUCT_LEVEL}> is set to an integer greater than the
811 value of C<PL_perl_destruct_level> its value is used instead.
813 On threaded perls, each thread has an independent copy of this variable;
814 each initialized at creation time with the current value of the creating
819 /* mod_perl is special, and also assigns a meaning -1 */
820 PERLVARI(I, perl_destruct_level, signed char, 0)
822 PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */
824 PERLVARI(I, srand_called, bool, false) /* has random_state been initialized yet? */
825 PERLVARI(I, srand_override, U32, 0) /* Should we use a deterministic sequence? */
826 PERLVARI(I, srand_override_next, U32, 0) /* Next item in the sequence */
828 PERLVARI(I, numeric_underlying, bool, TRUE)
829 /* Assume underlying locale numerics */
830 PERLVARI(I, numeric_underlying_is_standard, bool, TRUE)
832 PERLVARI(I, numeric_standard, int, TRUE) /* Assume C locale numerics */
833 PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */
834 PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator */
835 PERLVAR(I, underlying_radix_sv, SV *) /* The radix in the program's current underlying locale */
837 #if defined(USE_LOCALE_NUMERIC) && defined(USE_POSIX_2008_LOCALE)
839 PERLVARI(I, underlying_numeric_obj, locale_t, NULL)
842 #ifdef USE_POSIX_2008_LOCALE
843 PERLVARI(I, scratch_locale_obj, locale_t, 0)
846 #ifdef USE_LOCALE_CTYPE
848 PERLVARI(I, ctype_name, const char *, NULL) /* Name of current ctype locale */
852 /* Array of signal handlers, indexed by signal number, through which the C
853 signal handler dispatches. */
854 PERLVAR(I, psig_ptr, SV **)
855 /* Array of names of signals, indexed by signal number, for (re)use as the first
856 argument to a signal handler. Only one block of memory is allocated for
857 both psig_name and psig_ptr. */
858 PERLVAR(I, psig_name, SV **)
860 #if defined(PERL_IMPLICIT_SYS)
861 PERLVAR(I, Mem, struct IPerlMem *)
862 PERLVAR(I, MemShared, struct IPerlMem *)
863 PERLVAR(I, MemParse, struct IPerlMem *)
864 PERLVAR(I, Env, struct IPerlEnv *)
865 PERLVAR(I, StdIO, struct IPerlStdIO *)
866 PERLVAR(I, LIO, struct IPerlLIO *)
867 PERLVAR(I, Dir, struct IPerlDir *)
868 PERLVAR(I, Sock, struct IPerlSock *)
869 PERLVAR(I, Proc, struct IPerlProc *)
872 PERLVAR(I, ptr_table, PTR_TBL_t *)
873 PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */
875 PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */
878 #if defined(USE_ITHREADS)
879 PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of
881 PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the
882 values in op_pmoffset of pmop.
883 Entry 0 is an SV whose PV is a
884 "packed" list of IVs listing
885 the now-free slots in the array */
886 PERLVAR(I, stashpad, HV **) /* for CopSTASH */
887 PERLVARI(I, stashpadmax, PADOFFSET, 64)
888 PERLVARI(I, stashpadix, PADOFFSET, 0)
891 #ifdef USE_REENTRANT_API
892 PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */
895 PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */
896 PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */
899 PERLVARI(I, perlio, PerlIOl *, NULL)
900 PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
901 PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
904 PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */
905 PERLVARI(I, unitcheckav_save, AV *, NULL)
906 /* save UNITCHECK{}s when compiling */
908 PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */
910 /* Hooks to shared SVs and locks. */
911 PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing)
912 PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing)
914 GCC_DIAG_IGNORE(-Wdeprecated-declarations)
916 # define PERL_UNLOCK_HOOK Perl_sv_nosharing
918 /* This reference ensures that the mathoms are linked with perl */
919 # define PERL_UNLOCK_HOOK Perl_sv_nounlocking
921 PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
925 PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
927 /* Can shared object be destroyed */
928 PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
931 PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
934 PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */
936 /* Register of known Method Resolution Orders.
937 What this actually points to is an implementation detail (it may change to
938 a structure incorporating a reference count - use mro_get_from_name to
939 retrieve a C<struct mro_alg *> */
940 PERLVAR(I, registered_mros, HV *)
942 /* Compile-time block start/end hooks */
943 PERLVAR(I, blockhooks, AV *)
945 PERLVAR(I, custom_ops, HV *) /* custom op registrations */
947 PERLVAR(I, Xpv, XPV *) /* (unused) held temporary value */
949 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
950 present always, as -DDEBUGGING must be binary compatible with non. */
951 PERLVARI(I, scopestack_name, const char **, NULL)
953 PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */
955 /* Hook for File::Glob */
956 PERLVARI(I, globhook, globhook_t, NULL)
958 #if defined(MULTIPLICITY)
959 /* The last unconditional member of the interpreter structure when 5.18.0 was
960 released. The offset of the end of this is baked into a global variable in
961 any shared perl library which will allow a sanity test in future perl
963 # define PERL_LAST_5_18_0_INTERP_MEMBER Iglobhook
967 PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
968 PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */
971 #if defined(MULTIPLICITY) || defined(PERL_DEBUG_READONLY_COW)
972 /* For use with the memory debugging code in util.c. This is used only in
973 * DEBUGGING builds (as long as the relevant structure is defined), but
974 * defining it in non-debug builds too means that we retain binary
975 * compatibility between otherwise-compatible plain and debug builds. */
976 PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
979 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
980 /* File descriptor to talk to the child which dumps scalars. */
981 PERLVARI(I, dumper_fd, int, -1)
985 #ifdef DEBUG_LEAKING_SCALARS
986 PERLVARI(I, sv_serial, U32, 0) /* SV serial number, used in sv.c */
989 PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*) /* constant SVs with precomputed hash value */
991 #ifdef PERL_TRACE_OPS
992 PERLVARA(I, op_exec_cnt, OP_max+2, UV) /* Counts of executed OPs of the given type.
993 If PERL_TRACE_OPS is enabled, we'll dump
994 a summary count of all ops executed in the
995 program at perl_destruct time. For
996 profiling/debugging only. Works only if
997 DEBUGGING is enabled, too. */
1000 PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
1002 PERLVARI(I, dump_re_max_len, STRLEN, 60)
1004 /* For internal uses of randomness, this ensures the sequence of
1005 * random numbers returned by rand() isn't modified by perl's internal
1006 * use of randomness.
1007 * This is important if the user has called srand() with a seed.
1010 PERLVAR(I, internal_random_state, PL_RANDOM_STATE_TYPE)
1012 PERLVARA(I, TR_SPECIAL_HANDLING_UTF8, UTF8_MAXBYTES, char)
1014 PERLVAR(I, AboveLatin1, SV *)
1015 PERLVAR(I, Assigned_invlist, SV *)
1016 PERLVAR(I, GCB_invlist, SV *)
1017 PERLVAR(I, HasMultiCharFold, SV *)
1018 PERLVAR(I, InMultiCharFold, SV *)
1019 PERLVAR(I, Latin1, SV *)
1020 PERLVAR(I, LB_invlist, SV *)
1021 PERLVAR(I, SB_invlist, SV *)
1022 PERLVAR(I, SCX_invlist, SV *)
1023 PERLVAR(I, UpperLatin1, SV *) /* Code points 128 - 255 */
1025 PERLVARA(I, fold_locale, 256, U8)
1027 /* List of characters that participate in any fold defined by Unicode */
1028 PERLVAR(I, in_some_fold, SV *)
1030 /* Everything that folds to a given character, for case insensitivity regex
1032 PERLVAR(I, utf8_foldclosures, SV *)
1034 PERLVAR(I, utf8_idcont, SV *)
1035 PERLVAR(I, utf8_idstart, SV *)
1036 PERLVAR(I, utf8_perl_idcont, SV *)
1037 PERLVAR(I, utf8_perl_idstart, SV *)
1038 PERLVAR(I, utf8_xidcont, SV *)
1039 PERLVAR(I, utf8_xidstart, SV *)
1040 PERLVAR(I, WB_invlist, SV *)
1041 PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
1042 PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
1043 PERLVAR(I, utf8_toupper, SV *)
1044 PERLVAR(I, utf8_totitle, SV *)
1045 PERLVAR(I, utf8_tolower, SV *)
1046 PERLVAR(I, utf8_tofold, SV *)
1047 PERLVAR(I, utf8_tosimplefold, SV *)
1048 PERLVAR(I, utf8_charname_begin, SV *)
1049 PERLVAR(I, utf8_charname_continue, SV *)
1050 PERLVAR(I, utf8_mark, SV *)
1051 PERLVARI(I, InBitmap, SV *, NULL)
1052 PERLVAR(I, CCC_non0_non230, SV *)
1053 PERLVAR(I, Private_Use, SV *)
1056 PERLVAR(I, mbrlen_ps, mbstate_t)
1059 PERLVAR(I, mbrtowc_ps, mbstate_t)
1062 PERLVAR(I, wcrtomb_ps, mbstate_t)
1065 /* Enough space for the reserved byte, 1 for a potential leading 0, then enough
1066 * for the longest representable integer plus an extra, the 3 flag characters,
1068 #define PERL_MEM_LOG_ARYLEN (1 + 1 + TYPE_DIGITS(UV) + 1 + 3 + 1)
1069 PERLVARA(I, mem_log, PERL_MEM_LOG_ARYLEN, char)
1072 /* The most recently seen `use VERSION` declaration, encoded in a single
1073 * U16 as (major << 8) | minor. We do this rather than store an entire SV
1074 * version object so we can fit the U16 into the uv of a SAVEHINTS and not
1075 * have to worry about SV refcounts during scope enter/exit. */
1076 PERLVAR(I, prevailing_version, U16)
1078 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
1079 * above on where there are gaps which currently will be structure padding. */
1081 /* Within a stable branch, new variables must be added to the very end, before
1082 * this comment, for binary compatibility (the offsets of the old members must
1084 * (Don't forget to add your variable also to perl_clone()!)