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