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