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, Stack_off_t *) /* stack_sp locations we're
54 PERLVAR(I, markstack_ptr, Stack_off_t *)
55 PERLVAR(I, markstack_max, Stack_off_t *)
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
66 PERLVARI(I, hash_rand_bits, UV, 0) /* used to randomize hash stuff */
68 PERLVAR(I, strtab, HV *) /* shared string table */
69 /* prog counter for the currently executing OP_MULTIDEREF Used to signal
70 * to S_find_uninit_var() where we are */
71 PERLVAR(I, multideref_pc, UNOP_AUX_item *)
73 /* Fields used by magic variables such as $@, $/ and so on */
74 PERLVAR(I, curpm, PMOP *) /* what to do \ interps in REs from */
75 PERLVAR(I, curpm_under, PMOP *) /* what to do \ interps in REs from */
77 PERLVAR(I, tainting, bool) /* ? doing taint checks */
78 PERLVARI(I, tainted, bool, FALSE) /* using variables controlled by $< */
80 /* PL_delaymagic is currently used for two purposes: to assure simultaneous
81 * updates in ($<,$>) = ..., and to assure atomic update in push/unshift
82 * @ISA, It works like this: a few places such as pp_push set the DM_DELAY
83 * flag; then various places such as av_store() skip mg_set(ary) if this
84 * flag is set, and various magic vtable methods set flags like
85 * DM_ARRAY_ISA if they've seen something of that ilk. Finally when
86 * control returns to pp_push or whatever, it sees if any of those flags
87 * have been set, and if so finally calls mg_set().
89 * NB: PL_delaymagic is automatically saved and restored by JMPENV_PUSH
90 * / POP. This removes the need to do ENTER/SAVEI16(PL_delaymagic)/LEAVE
91 * in hot code like pp_push.
93 PERLVAR(I, delaymagic, U16) /* ($<,$>) = ... */
96 =for apidoc_section $warning
97 =for apidoc mn|U8|PL_dowarn
99 The C variable that roughly corresponds to Perl's C<$^W> warning variable.
100 However, C<$^W> is treated as a boolean, whereas C<PL_dowarn> is a
101 collection of flag bits.
103 On threaded perls, each thread has an independent copy of this variable;
104 each initialized at creation time with the current value of the creating
110 PERLVAR(I, dowarn, U8)
112 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
117 PERLVARI(I, utf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
121 =for apidoc_section $GV
122 =for apidoc Amn|GV *|PL_defgv
124 The GV representing C<*_>. Useful for access to C<$_>.
126 On threaded perls, each thread has an independent copy of this variable;
127 each initialized at creation time with the current value of the creating
133 PERLVAR(I, localizing, U8) /* are we processing a local() list?
134 0 = no, 1 = localizing, 2 = delocalizing */
135 PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */
136 PERLVAR(I, defgv, GV *) /* the *_ glob */
139 =for apidoc_section $GV
140 =for apidoc Amn|HV*|PL_curstash
142 The stash for the package code will be compiled into.
144 On threaded perls, each thread has an independent copy of this variable;
145 each initialized at creation time with the current value of the creating
152 PERLVAR(I, defstash, HV *) /* main symbol table */
153 PERLVAR(I, curstash, HV *) /* symbol table for current package */
156 =for apidoc_section $COP
157 =for apidoc Amn|COP*|PL_curcop
159 The currently active COP (control op) roughly representing the current
160 statement in the source.
162 On threaded perls, each thread has an independent copy of this variable;
163 each initialized at creation time with the current value of the creating
169 PERLVAR(I, curcop, COP *)
170 PERLVAR(I, curstack, AV *) /* THE STACK */
171 PERLVAR(I, curstackinfo, PERL_SI *) /* current stack + context */
172 PERLVAR(I, mainstack, AV *) /* the stack when nothing funny is
175 /* memory management */
176 PERLVAR(I, sv_count, IV) /* how many SV* are currently allocated */
178 PERLVAR(I, sv_root, SV *) /* storage for SVs belonging to interp */
179 PERLVAR(I, sv_arenaroot, SV *) /* list of areas for garbage collection */
181 /* fake PMOP that PL_curpm points to while in (?{}) so $1 et al are visible */
182 PERLVARI(I, reg_curpm, PMOP*, NULL)
184 /* the currently active slab in a chain of slabs of regmatch states,
185 * and the currently active state within that slab. This stack of states
186 * is shared amongst re-entrant calls to the regex engine */
188 PERLVARI(I, regmatch_slab, regmatch_slab *, NULL)
189 PERLVAR(I, regmatch_state, regmatch_state *)
191 PERLVAR(I, comppad, PAD *) /* storage for lexically scoped temporaries */
194 =for apidoc_section $SV
195 =for apidoc Amn|SV|PL_sv_undef
196 This is the C<undef> SV. It is readonly. Always refer to this as
199 =for apidoc Amn|SV|PL_sv_no
200 This is the C<false> SV. It is readonly. See C<L</PL_sv_yes>>. Always refer
201 to this as C<&PL_sv_no>.
203 =for apidoc Amn|SV|PL_sv_yes
204 This is the C<true> SV. It is readonly. See C<L</PL_sv_no>>. Always refer to
205 this as C<&PL_sv_yes>.
207 =for apidoc Amn|SV|PL_sv_zero
208 This readonly SV has a zero numeric value and a C<"0"> string value. It's
209 similar to C<L</PL_sv_no>> except for its string value. Can be used as a
210 cheap alternative to C<mXPUSHi(0)> for example. Always refer to this as
211 C<&PL_sv_zero>. Introduced in 5.28.
217 PERLVAR(I, sv_yes, SV)
218 PERLVAR(I, sv_undef, SV)
219 PERLVAR(I, sv_no, SV)
220 PERLVAR(I, sv_zero, SV)
222 /* store the immortals as an array to ensure they are contiguous in
223 * memory: makes SvIMMORTAL_INTERP(sv) possible */
224 PERLVARA(I, sv_immortals, 4, SV)
227 PERLVAR(I, padname_undef, PADNAME)
228 PERLVAR(I, padname_const, PADNAME)
231 =for apidoc_section $SV
232 =for apidoc Cmn||PL_Sv
234 A scratch pad SV for whatever temporary use you need. Chiefly used as a
235 fallback by macros on platforms where L<perlapi/PERL_USE_GCC_BRACE_GROUPS>> is
236 unavailable, and which would otherwise evaluate their SV parameter more than
239 B<BUT BEWARE>, if this is used in a situation where something that is using it
240 is in a call stack with something else that is using it, this variable would
241 get zapped, leading to hard-to-diagnose errors.
247 PERLVAR(I, parser, yy_parser *) /* current parser state */
249 PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */
253 =for apidoc_section $string
254 =for apidoc Amn|STRLEN|PL_na
256 A scratch pad variable in which to store a C<STRLEN> value. If would have been
257 better named something like C<PL_temp_strlen>.
259 It is is typically used with C<SvPV> when one is actually planning to discard
260 the returned length, (hence the length is "Not Applicable", which is how this
261 variable got its name).
263 B<BUT BEWARE>, if this is used in a situation where something that is using it
264 is in a call stack with something else that is using it, this variable would
265 get zapped, leading to hard-to-diagnose errors.
267 It is usually more efficient to either declare a local variable and use that
268 instead, or to use the C<SvPV_nolen> macro.
273 PERLVAR(I, na, STRLEN) /* for use in SvPV when length is
277 PERLVAR(I, statcache, Stat_t) /* _ */
278 PERLVAR(I, statgv, GV *)
279 PERLVARI(I, statname, SV *, NULL)
282 =for apidoc_section $io
283 =for apidoc mn|SV*|PL_rs
285 The input record separator - C<$/> in Perl space.
287 On threaded perls, each thread has an independent copy of this variable;
288 each initialized at creation time with the current value of the creating
291 =for apidoc_section $io
292 =for apidoc mn|GV*|PL_last_in_gv
294 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
296 On threaded perls, each thread has an independent copy of this variable;
297 each initialized at creation time with the current value of the creating
300 =for apidoc_section $io
301 =for apidoc mn|GV*|PL_ofsgv
303 The glob containing the output field separator - C<*,> in Perl space.
305 On threaded perls, each thread has an independent copy of this variable;
306 each initialized at creation time with the current value of the creating
312 PERLVAR(I, rs, SV *) /* input record separator $/ */
313 PERLVAR(I, last_in_gv, GV *) /* GV used in last <FH> */
314 PERLVAR(I, ofsgv, GV *) /* GV of output field separator *, */
315 PERLVAR(I, defoutgv, GV *) /* default FH for output */
316 PERLVARI(I, chopset, const char *, " \n-") /* $: */
317 PERLVAR(I, formtarget, SV *)
318 PERLVAR(I, bodytarget, SV *)
319 PERLVAR(I, toptarget, SV *)
322 PERLVAR(I, restartop, OP *) /* propagating an error from croak? */
323 PERLVAR(I, restartjmpenv, JMPENV *) /* target frame for longjmp in die */
325 PERLVAR(I, top_env, JMPENV *) /* ptr to current sigjmp environment */
326 PERLVAR(I, start_env, JMPENV) /* empty startup sigjmp environment */
327 PERLVARI(I, errors, SV *, NULL) /* outstanding queued errors */
329 /* statics "owned" by various functions */
330 PERLVAR(I, hv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
332 PERLVAR(I, lastgotoprobe, OP*) /* from pp_ctl.c */
335 PERLVAR(I, sortcop, OP *) /* user defined sort routine */
336 PERLVAR(I, sortstash, HV *) /* which is in some package or other */
337 PERLVAR(I, firstgv, GV *) /* $a */
338 PERLVAR(I, secondgv, GV *) /* $b */
341 PERLVAR(I, efloatbuf, char *)
342 PERLVAR(I, efloatsize, STRLEN)
344 PERLVARI(I, dumpindent, U16, 4) /* number of blanks per dump
348 =for apidoc_section $embedding
349 =for apidoc Amn|U8|PL_exit_flags
351 Contains flags controlling perl's behaviour on exit():
355 =item * C<PERL_EXIT_DESTRUCT_END>
357 If set, END blocks are executed when the interpreter is destroyed.
358 This is normally set by perl itself after the interpreter is
361 =item * C<PERL_EXIT_ABORT>
363 Call C<abort()> on exit. This is used internally by perl itself to
364 abort if exit is called while processing exit.
366 =item * C<PERL_EXIT_WARN>
370 =item * C<PERL_EXIT_EXPECTED>
372 Set by the L<perlfunc/exit> operator.
376 =for apidoc Amnh||PERL_EXIT_EXPECTED
377 =for apidoc Amnh||PERL_EXIT_ABORT
378 =for apidoc Amnh||PERL_EXIT_DESTRUCT_END
379 =for apidoc Amnh||PERL_EXIT_WARN
381 On threaded perls, each thread has an independent copy of this variable;
382 each initialized at creation time with the current value of the creating
388 PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
390 PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
392 #if defined(USE_LOCALE) && defined(USE_LOCALE_THREADS)
393 PERLVARI(I, locale_mutex_depth, int, 0) /* Emulate general semaphore */
396 #ifdef USE_LOCALE_CTYPE
397 PERLVAR(I, warn_locale, SV *)
398 PERLVARI(I, in_utf8_CTYPE_locale, bool, false)
399 PERLVARI(I, in_utf8_turkic_locale, bool, false)
402 PERLVARA(I, colors,6, char *) /* values from PERL_RE_COLORS env var */
405 =for apidoc_section $optree_construction
406 =for apidoc Amn|peep_t|PL_peepp
408 Pointer to the per-subroutine peephole optimiser. This is a function
409 that gets called at the end of compilation of a Perl subroutine (or
410 equivalently independent piece of Perl code) to perform fixups of
411 some ops and to perform small-scale optimisations. The function is
412 called once for each subroutine that is compiled, and is passed, as sole
413 parameter, a pointer to the op that is the entry point to the subroutine.
414 It modifies the op tree in place.
416 The peephole optimiser should never be completely replaced. Rather,
417 add code to it by wrapping the existing optimiser. The basic way to do
418 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
419 If the new code wishes to operate on ops throughout the subroutine's
420 structure, rather than just at the top level, it is likely to be more
421 convenient to wrap the L</PL_rpeepp> hook.
423 On threaded perls, each thread has an independent copy of this variable;
424 each initialized at creation time with the current value of the creating
430 PERLVARI(I, peepp, peep_t, Perl_peep)
433 =for apidoc_section $optree_construction
434 =for apidoc Amn|peep_t|PL_rpeepp
436 Pointer to the recursive peephole optimiser. This is a function
437 that gets called at the end of compilation of a Perl subroutine (or
438 equivalently independent piece of Perl code) to perform fixups of some
439 ops and to perform small-scale optimisations. The function is called
440 once for each chain of ops linked through their C<op_next> fields;
441 it is recursively called to handle each side chain. It is passed, as
442 sole parameter, a pointer to the op that is at the head of the chain.
443 It modifies the op tree in place.
445 The peephole optimiser should never be completely replaced. Rather,
446 add code to it by wrapping the existing optimiser. The basic way to do
447 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
448 If the new code wishes to operate only on ops at a subroutine's top level,
449 rather than throughout the structure, it is likely to be more convenient
450 to wrap the L</PL_peepp> hook.
452 On threaded perls, each thread has an independent copy of this variable;
453 each initialized at creation time with the current value of the creating
459 PERLVARI(I, rpeepp, peep_t, Perl_rpeep)
462 =for apidoc_section $optrees
463 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
465 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.
466 This allows extensions to free any extra attribute they have locally attached to an OP.
467 It is also assured to first fire for the parent OP and then for its kids.
469 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.
471 On threaded perls, each thread has an independent copy of this variable;
472 each initialized at creation time with the current value of the creating
478 PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
480 PERLVARI(I, watchaddr, char **, 0)
481 PERLVAR(I, watchok, char *)
483 PERLVAR(I, perldb, U32)
485 PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */
487 PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */
489 /* pseudo environmental stuff */
490 PERLVAR(I, origargc, int)
491 PERLVAR(I, origargv, char **)
492 PERLVAR(I, envgv, GV *)
493 PERLVAR(I, incgv, GV *)
494 PERLVAR(I, hintgv, GV *)
495 PERLVAR(I, origfilename, char *)
496 PERLVARI(I, xsubfilename, const char *, NULL)
497 PERLVAR(I, diehook, SV *)
498 PERLVAR(I, warnhook, SV *)
500 PERLVARI(I, hook__require__before, SV *,NULL)
501 PERLVARI(I, hook__require__after, SV *,NULL)
504 PERLVAR(I, patchlevel, SV *)
505 PERLVAR(I, localpatches, const char * const *)
506 PERLVARI(I, splitstr, char *, NULL)
508 PERLVAR(I, minus_c, bool)
509 PERLVAR(I, minus_n, bool)
510 PERLVAR(I, minus_p, bool)
511 PERLVAR(I, minus_l, bool)
512 PERLVAR(I, minus_a, bool)
513 PERLVAR(I, minus_F, bool)
514 PERLVAR(I, doswitches, bool)
515 PERLVAR(I, minus_E, bool)
517 PERLVAR(I, inplace, char *)
518 PERLVAR(I, e_script, SV *)
520 PERLVAR(I, basetime, Time_t) /* $^T */
522 PERLVARI(I, maxsysfd, I32, MAXSYSFD)
523 /* top fd to pass to subprocesses */
524 PERLVAR(I, statusvalue, I32) /* $? */
526 PERLVAR(I, statusvalue_vms, U32)
528 PERLVAR(I, statusvalue_posix, I32)
531 PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */
532 PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */
534 /* shortcuts to various I/O objects */
535 PERLVAR(I, stdingv, GV *) /* *STDIN */
536 PERLVAR(I, stderrgv, GV *) /* *STDERR */
537 PERLVAR(I, argvgv, GV *) /* *ARGV */
538 PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */
539 PERLVAR(I, argvout_stack, AV *)
541 /* shortcuts to regexp stuff */
542 PERLVAR(I, replgv, GV *) /* *^R */
544 /* shortcuts to misc objects */
545 PERLVAR(I, errgv, GV *) /* *@ */
547 /* shortcuts to debugging objects */
548 PERLVAR(I, DBgv, GV *) /* *DB::DB */
549 PERLVAR(I, DBline, GV *) /* *DB::line */
552 =for apidoc_section $debugging
553 =for apidoc mn|GV *|PL_DBsub
554 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
555 the SV which holds the name of the sub being debugged. This is the C
556 variable which corresponds to Perl's $DB::sub variable. See
559 On threaded perls, each thread has an independent copy of this variable;
560 each initialized at creation time with the current value of the creating
563 =for apidoc mn|SV *|PL_DBsingle
564 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
565 boolean which indicates whether subs are being single-stepped.
566 Single-stepping is automatically turned on after every step. This is the C
567 variable which corresponds to Perl's $DB::single variable. See
570 On threaded perls, each thread has an independent copy of this variable;
571 each initialized at creation time with the current value of the creating
574 =for apidoc mn|SV *|PL_DBtrace
575 Trace variable used when Perl is run in debugging mode, with the B<-d>
576 switch. This is the C variable which corresponds to Perl's $DB::trace
577 variable. See C<L</PL_DBsingle>>.
579 On threaded perls, each thread has an independent copy of this variable;
580 each initialized at creation time with the current value of the creating
586 PERLVAR(I, DBsub, GV *) /* *DB::sub */
587 PERLVAR(I, DBsingle, SV *) /* $DB::single */
588 PERLVAR(I, DBtrace, SV *) /* $DB::trace */
589 PERLVAR(I, DBsignal, SV *) /* $DB::signal */
590 PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */
592 PERLVARA(I, DBcontrol, DBVARMG_COUNT, IV) /* IV versions of $DB::single, trace, signal */
595 PERLVAR(I, debstash, HV *) /* symbol table for perldb package */
596 PERLVAR(I, globalstash, HV *) /* global keyword overrides imported here */
597 PERLVAR(I, curstname, SV *) /* name of current package */
598 PERLVAR(I, beginav, AV *) /* names of BEGIN subroutines */
599 PERLVAR(I, endav, AV *) /* names of END subroutines */
600 PERLVAR(I, unitcheckav, AV *) /* names of UNITCHECK subroutines */
601 PERLVAR(I, checkav, AV *) /* names of CHECK subroutines */
602 PERLVAR(I, initav, AV *) /* names of INIT subroutines */
604 /* subprocess state */
605 PERLVAR(I, fdpid, AV *) /* keep fd-to-pid mappings for my_popen */
608 PERLVARI(I, op_mask, char *, NULL) /* masked operations for safe evals */
610 /* current interpreter roots */
611 PERLVAR(I, main_cv, CV *)
612 PERLVAR(I, main_root, OP *)
613 PERLVAR(I, main_start, OP *)
614 PERLVAR(I, eval_root, OP *)
615 PERLVAR(I, eval_start, OP *)
617 /* runtime control stuff */
618 PERLVARI(I, curcopdb, COP *, NULL)
620 PERLVAR(I, filemode, int) /* so nextargv() can preserve mode */
621 PERLVAR(I, lastfd, int) /* what to preserve mode on */
622 PERLVAR(I, oldname, char *) /* what to preserve mode on */
623 /* Elements in this array have ';' appended and are injected as a single line
624 into the tokeniser. You can't put any (literal) newlines into any program
625 you stuff in into this array, as the point where it's injected is expecting
626 a single physical line. */
627 PERLVAR(I, preambleav, AV *)
628 PERLVAR(I, mess_sv, SV *)
629 PERLVAR(I, ors_sv, SV *) /* output record separator $\ */
631 /* funky return mechanisms */
632 PERLVAR(I, forkprocess, int) /* so do_open |- can return proc# */
634 /* statics moved here for shared library purposes */
635 PERLVARI(I, gensym, I32, 0) /* next symbol for getsym() to define */
636 PERLVARI(I, cv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
637 PERLVAR(I, taint_warn, bool) /* taint warns instead of dying */
638 PERLVARI(I, laststype, U16, OP_STAT)
640 PERLVARI(I, laststatval, int, -1)
642 PERLVAR(I, modcount, I32) /* how much op_lvalue()ification in
645 /* interpreter atexit processing */
646 PERLVARI(I, exitlistlen, I32, 0) /* length of same */
647 PERLVARI(I, exitlist, PerlExitListEntry *, NULL)
648 /* list of exit functions */
651 =for apidoc_section $HV
652 =for apidoc Amn|HV*|PL_modglobal
654 C<PL_modglobal> is a general purpose, interpreter global HV for use by
655 extensions that need to keep information on a per-interpreter basis.
656 In a pinch, it can also be used as a symbol table for extensions
657 to share data among each other. It is a good idea to use keys
658 prefixed by the package name of the extension that owns the data.
660 On threaded perls, each thread has an independent copy of this variable;
661 each initialized at creation time with the current value of the creating
667 PERLVAR(I, modglobal, HV *) /* per-interp module data */
669 /* these used to be in global before 5.004_68 */
670 PERLVARI(I, profiledata, U32 *, NULL) /* table of ops, counts */
672 PERLVAR(I, compiling, COP) /* compiling/done executing marker */
674 PERLVAR(I, compcv, CV *) /* currently compiling subroutine */
675 PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
676 PERLVAR(I, comppad_name_fill, PADOFFSET)/* last "introduced" variable offset */
677 PERLVAR(I, comppad_name_floor, PADOFFSET)/* start of vars in innermost block */
679 #ifdef HAVE_INTERP_INTERN
680 PERLVAR(I, sys_intern, struct interp_intern)
681 /* platform internals */
684 /* more statics moved here */
685 PERLVAR(I, DBcv, CV *) /* from perl.c */
686 PERLVARI(I, generation, int, 100) /* scan sequence# for OP_AASSIGN
687 compile-time common elem detection */
689 PERLVAR(I, unicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
691 PERLVARI(I, in_clean_objs,bool, FALSE) /* from sv.c */
692 PERLVARI(I, in_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
693 PERLVAR(I, nomemok, bool) /* let malloc context handle nomem */
694 PERLVARI(I, savebegin, bool, FALSE) /* save BEGINs for compiler */
697 PERLVAR(I, delaymagic_uid, Uid_t) /* current real user id, only for delaymagic */
698 PERLVAR(I, delaymagic_euid, Uid_t) /* current effective user id, only for delaymagic */
699 PERLVAR(I, delaymagic_gid, Gid_t) /* current real group id, only for delaymagic */
700 PERLVAR(I, delaymagic_egid, Gid_t) /* current effective group id, only for delaymagic */
701 PERLVARI(I, an, U32, 0) /* malloc sequence number */
703 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
704 PERLVARI(I, breakable_sub_gen, U32, 0)
707 /* exercise wrap-around */
708 #define PERL_COP_SEQMAX (U32_MAX-50)
710 #define PERL_COP_SEQMAX 0
712 PERLVARI(I, cop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
713 #undef PERL_COP_SEQMAX
715 PERLVARI(I, evalseq, U32, 0) /* eval sequence number */
716 PERLVAR(I, origalen, U32)
717 #ifdef PERL_USES_PL_PIDSTATUS
718 PERLVAR(I, pidstatus, HV *) /* pid-to-status mappings for waitpid */
720 PERLVAR(I, osname, char *) /* operating system */
722 PERLVAR(I, sighandlerp, Sighandler_t)
723 /* these two are provided only to solve library linkage issues; they
724 * should not be hooked by user code */
725 PERLVAR(I, sighandler1p, Sighandler1_t)
726 PERLVAR(I, sighandler3p, Sighandler3_t)
728 PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
730 PERLVAR(I, debug, volatile U32) /* flags given to -D switch */
732 PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist clones */
734 PERLVARI(I, runops, runops_proc_t, RUNOPS_DEFAULT)
736 PERLVAR(I, subname, SV *) /* name of current subroutine */
738 PERLVAR(I, subline, I32) /* line this subroutine began on */
739 PERLVAR(I, min_intro_pending, PADOFFSET)/* start of vars to introduce */
741 PERLVAR(I, max_intro_pending, PADOFFSET)/* end of vars to introduce */
742 PERLVAR(I, padix, PADOFFSET) /* lowest unused index - 1
743 in current "register" pad */
744 PERLVAR(I, constpadix, PADOFFSET) /* lowest unused for constants */
746 PERLVAR(I, padix_floor, PADOFFSET) /* how low may inner block reset padix */
748 #if defined(USE_POSIX_2008_LOCALE) && defined(MULTIPLICITY)
749 PERLVARI(I, cur_locale_obj, locale_t, LC_GLOBAL_LOCALE)
751 #ifdef USE_PL_CURLOCALES
753 /* Some configurations do not allow perl to query libc to find out what the
754 * locale for a given category is. On such platforms this array contains that
755 * information, indexed by the perl-defined category index.
756 * Note that this array keeps the actual locale for each category. LC_NUMERIC
757 * is almost always toggled into the C locale, and the locale it nominally is
758 * is stored as PL_numeric_name. */
759 PERLVARA(I, curlocales, LOCALE_CATEGORIES_COUNT_ + 1, const char *)
762 #ifdef USE_PL_CUR_LC_ALL
763 PERLVARI(I, cur_LC_ALL, const char *, NULL)
765 #ifdef USE_LOCALE_COLLATE
767 /* The memory needed to store the collxfrm transformation of a string with
768 * length 'x' is predicted by the linear equation mx+b; m=mult, b=base */
769 PERLVARI(I, collxfrm_mult,Size_t, 0) /* Expansion factor in *xfrm();
770 0 => unknown or bad, depending on
772 PERLVAR(I, collxfrm_base, Size_t) /* Basic overhead in *xfrm();
773 mult == 0, base == 0 => need to compute
774 mult == 0, base != 0 => ill-formed;
776 PERLVAR(I, collation_name, char *) /* Name of current collation */
777 PERLVARI(I, collation_ix, PERL_UINTMAX_T, 0) /* Collation generation index */
778 PERLVARI(I, strxfrm_NUL_replacement, U8, 0) /* Code point to replace NULs */
779 PERLVARI(I, strxfrm_is_behaved, bool, TRUE)
780 /* Assume until proven otherwise that it works */
781 PERLVARI(I, strxfrm_max_cp, U8, 0) /* Highest collating cp in locale */
782 PERLVARI(I, collation_standard, bool, TRUE)
783 /* Assume simple collation */
784 PERLVAR(I, in_utf8_COLLATE_locale, bool)
785 #endif /* USE_LOCALE_COLLATE */
787 PERLVARI(I, langinfo_buf, char *, NULL)
788 PERLVARI(I, langinfo_bufsize, Size_t, 0)
789 PERLVARI(I, setlocale_buf, char *, NULL)
790 PERLVARI(I, setlocale_bufsize, Size_t, 0)
792 #if defined(USE_LOCALE_THREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
793 PERLVARI(I, less_dicey_locale_buf, char *, NULL)
794 PERLVARI(I, less_dicey_locale_bufsize, Size_t, 0)
797 #ifdef PERL_SAWAMPERSAND
798 PERLVAR(I, sawampersand, U8) /* must save all match strings */
801 /* current phase the interpreter is in
802 for ordering this structure to remove holes, we're assuming that this is 4
804 PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
806 PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
808 PERLVARI(I, eval_begin_nest_depth, U32, 0)
810 PERLVAR(I, unsafe, bool)
811 PERLVAR(I, colorset, bool) /* PERL_RE_COLORS env var is in use */
814 =for apidoc_section $embedding
815 =for apidoc Amn|signed char|PL_perl_destruct_level
817 This value may be set when embedding for full cleanup.
827 =item * 2 or greater - full with checks.
831 If C<$ENV{PERL_DESTRUCT_LEVEL}> is set to an integer greater than the
832 value of C<PL_perl_destruct_level> its value is used instead.
834 On threaded perls, each thread has an independent copy of this variable;
835 each initialized at creation time with the current value of the creating
840 /* mod_perl is special, and also assigns a meaning -1 */
841 PERLVARI(I, perl_destruct_level, signed char, 0)
843 PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */
845 PERLVARI(I, srand_called, bool, false) /* has random_state been initialized yet? */
846 PERLVARI(I, srand_override, U32, 0) /* Should we use a deterministic sequence? */
847 PERLVARI(I, srand_override_next, U32, 0) /* Next item in the sequence */
849 PERLVARI(I, numeric_underlying, bool, TRUE)
850 /* Assume underlying locale numerics */
851 PERLVARI(I, numeric_underlying_is_standard, bool, TRUE)
853 PERLVARI(I, numeric_standard, int, TRUE) /* Assume C locale numerics */
854 PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */
855 PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator */
856 PERLVAR(I, underlying_radix_sv, SV *) /* The radix in the program's current underlying locale */
858 #ifdef USE_POSIX_2008_LOCALE
859 PERLVARI(I, scratch_locale_obj, locale_t, 0)
862 #ifdef USE_LOCALE_CTYPE
864 PERLVARI(I, ctype_name, const char *, NULL) /* Name of current ctype locale */
868 /* Array of signal handlers, indexed by signal number, through which the C
869 signal handler dispatches. */
870 PERLVAR(I, psig_ptr, SV **)
871 /* Array of names of signals, indexed by signal number, for (re)use as the first
872 argument to a signal handler. Only one block of memory is allocated for
873 both psig_name and psig_ptr. */
874 PERLVAR(I, psig_name, SV **)
876 #if defined(PERL_IMPLICIT_SYS)
877 PERLVAR(I, Mem, struct IPerlMem *)
878 PERLVAR(I, MemShared, struct IPerlMem *)
879 PERLVAR(I, MemParse, struct IPerlMem *)
880 PERLVAR(I, Env, struct IPerlEnv *)
881 PERLVAR(I, StdIO, struct IPerlStdIO *)
882 PERLVAR(I, LIO, struct IPerlLIO *)
883 PERLVAR(I, Dir, struct IPerlDir *)
884 PERLVAR(I, Sock, struct IPerlSock *)
885 PERLVAR(I, Proc, struct IPerlProc *)
888 PERLVAR(I, ptr_table, PTR_TBL_t *)
889 PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */
891 PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */
894 #if defined(USE_ITHREADS)
895 PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of
897 PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the
898 values in op_pmoffset of pmop.
899 Entry 0 is an SV whose PV is a
900 "packed" list of IVs listing
901 the now-free slots in the array */
902 PERLVAR(I, stashpad, HV **) /* for CopSTASH */
903 PERLVARI(I, stashpadmax, PADOFFSET, 64)
904 PERLVARI(I, stashpadix, PADOFFSET, 0)
907 #ifdef USE_REENTRANT_API
908 PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */
911 PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */
912 PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */
915 PERLVARI(I, perlio, PerlIOl *, NULL)
916 PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
917 PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
920 PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */
921 PERLVARI(I, unitcheckav_save, AV *, NULL)
922 /* save UNITCHECK{}s when compiling */
924 PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */
926 /* Hooks to shared SVs and locks. */
927 PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing)
928 PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing)
930 #if defined(__HP_cc) || defined(__HP_aCC)
931 #pragma diag_suppress 3215
933 GCC_DIAG_IGNORE(-Wdeprecated-declarations)
934 MSVC_DIAG_IGNORE(4996)
937 # define PERL_UNLOCK_HOOK Perl_sv_nosharing
939 /* This reference ensures that the mathoms are linked with perl */
940 # define PERL_UNLOCK_HOOK Perl_sv_nounlocking
942 PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
946 #if defined(__HP_cc) || defined(__HP_aCC)
947 #pragma diag_default 3215
950 PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
952 /* Can shared object be destroyed */
953 PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
955 PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
957 PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */
959 /* Register of known Method Resolution Orders.
960 What this actually points to is an implementation detail (it may change to
961 a structure incorporating a reference count - use mro_get_from_name to
962 retrieve a C<struct mro_alg *> */
963 PERLVAR(I, registered_mros, HV *)
965 /* Compile-time block start/end hooks */
966 PERLVAR(I, blockhooks, AV *)
968 PERLVAR(I, custom_ops, HV *) /* custom op registrations */
970 PERLVAR(I, Xpv, XPV *) /* (unused) held temporary value */
972 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
973 present always, as -DDEBUGGING must be binary compatible with non. */
974 PERLVARI(I, scopestack_name, const char **, NULL)
976 PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */
978 /* Hook for File::Glob */
979 PERLVARI(I, globhook, globhook_t, NULL)
981 #if defined(MULTIPLICITY)
982 /* The last unconditional member of the interpreter structure when 5.18.0 was
983 released. The offset of the end of this is baked into a global variable in
984 any shared perl library which will allow a sanity test in future perl
986 # define PERL_LAST_5_18_0_INTERP_MEMBER Iglobhook
990 PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
991 PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */
994 #if defined(MULTIPLICITY) || defined(PERL_DEBUG_READONLY_COW)
995 /* For use with the memory debugging code in util.c. This is used only in
996 * DEBUGGING builds (as long as the relevant structure is defined), but
997 * defining it in non-debug builds too means that we retain binary
998 * compatibility between otherwise-compatible plain and debug builds. */
999 PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
1002 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
1003 /* File descriptor to talk to the child which dumps scalars. */
1004 PERLVARI(I, dumper_fd, int, -1)
1008 #ifdef DEBUG_LEAKING_SCALARS
1009 PERLVARI(I, sv_serial, U32, 0) /* SV serial number, used in sv.c */
1012 PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*) /* constant SVs with precomputed hash value */
1014 #ifdef PERL_TRACE_OPS
1015 PERLVARA(I, op_exec_cnt, OP_max+2, UV) /* Counts of executed OPs of the given type.
1016 If PERL_TRACE_OPS is enabled, we'll dump
1017 a summary count of all ops executed in the
1018 program at perl_destruct time. Used only
1019 for profiling in DEBUGGING mode. */
1022 PERLVAR(I, random_state, PL_RANDOM_STATE_TYPE)
1024 PERLVARI(I, dump_re_max_len, STRLEN, 60)
1026 /* For internal uses of randomness, this ensures the sequence of
1027 * random numbers returned by rand() isn't modified by perl's internal
1028 * use of randomness.
1029 * This is important if the user has called srand() with a seed.
1032 PERLVAR(I, internal_random_state, PL_RANDOM_STATE_TYPE)
1034 PERLVARA(I, TR_SPECIAL_HANDLING_UTF8, UTF8_MAXBYTES, char)
1036 PERLVAR(I, AboveLatin1, SV *)
1037 PERLVAR(I, Assigned_invlist, SV *)
1038 PERLVAR(I, GCB_invlist, SV *)
1039 PERLVAR(I, HasMultiCharFold, SV *)
1040 PERLVAR(I, InMultiCharFold, SV *)
1041 PERLVAR(I, Latin1, SV *)
1042 PERLVAR(I, LB_invlist, SV *)
1043 PERLVAR(I, SB_invlist, SV *)
1044 PERLVAR(I, SCX_invlist, SV *)
1045 PERLVAR(I, UpperLatin1, SV *) /* Code points 128 - 255 */
1047 PERLVARA(I, fold_locale, 256, U8)
1049 /* List of characters that participate in any fold defined by Unicode */
1050 PERLVAR(I, in_some_fold, SV *)
1052 /* Everything that folds to a given character, for case insensitivity regex
1054 PERLVAR(I, utf8_foldclosures, SV *)
1056 PERLVAR(I, utf8_idcont, SV *)
1057 PERLVAR(I, utf8_idstart, SV *)
1058 PERLVAR(I, utf8_perl_idcont, SV *)
1059 PERLVAR(I, utf8_perl_idstart, SV *)
1060 PERLVAR(I, utf8_xidcont, SV *)
1061 PERLVAR(I, utf8_xidstart, SV *)
1062 PERLVAR(I, WB_invlist, SV *)
1063 PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
1064 PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
1065 PERLVAR(I, utf8_toupper, SV *)
1066 PERLVAR(I, utf8_totitle, SV *)
1067 PERLVAR(I, utf8_tolower, SV *)
1068 PERLVAR(I, utf8_tofold, SV *)
1069 PERLVAR(I, utf8_tosimplefold, SV *)
1070 PERLVAR(I, utf8_charname_begin, SV *)
1071 PERLVAR(I, utf8_charname_continue, SV *)
1072 PERLVAR(I, utf8_mark, SV *)
1073 PERLVARI(I, InBitmap, SV *, NULL)
1074 PERLVAR(I, CCC_non0_non230, SV *)
1075 PERLVAR(I, Private_Use, SV *)
1078 PERLVAR(I, mbrlen_ps, mbstate_t)
1081 PERLVAR(I, mbrtowc_ps, mbstate_t)
1084 PERLVAR(I, wcrtomb_ps, mbstate_t)
1087 /* Enough space for the reserved byte, 1 for a potential leading 0, then enough
1088 * for the longest representable integer plus an extra, the 3 flag characters,
1090 #define PERL_MEM_LOG_ARYLEN (1 + 1 + TYPE_DIGITS(UV) + 1 + 3 + 1)
1091 PERLVARA(I, mem_log, PERL_MEM_LOG_ARYLEN, char)
1094 /* The most recently seen `use VERSION` declaration, encoded in a single
1095 * U16 as (major << 8) | minor. We do this rather than store an entire SV
1096 * version object so we can fit the U16 into the uv of a SAVEHINTS and not
1097 * have to worry about SV refcounts during scope enter/exit. */
1098 PERLVAR(I, prevailing_version, U16)
1100 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
1101 * above on where there are gaps which currently will be structure padding. */
1103 /* Within a stable branch, new variables must be added to the very end, before
1104 * this comment, for binary compatibility (the offsets of the old members must
1106 * (Don't forget to add your variable also to perl_clone()!)