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