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