This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlreapi: use parent in example, not base
[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 */
907b3e23 36#ifdef OP_IN_REGISTER
115ff745 37PERLVAR(I, opsave, OP *)
907b3e23 38#else
115ff745 39PERLVAR(I, op, OP *) /* currently executing op */
907b3e23 40#endif
115ff745 41PERLVAR(I, curpad, SV **) /* active pad (lexicals+tmps) */
907b3e23 42
115ff745
NC
43PERLVAR(I, stack_base, SV **)
44PERLVAR(I, stack_max, SV **)
907b3e23 45
115ff745 46PERLVAR(I, savestack, ANY *) /* items that need to be restored when
907b3e23 47 LEAVEing scopes we've ENTERed */
115ff745
NC
48PERLVAR(I, savestack_ix, I32)
49PERLVAR(I, savestack_max, I32)
50
19bc2726
DM
51PERLVAR(I, scopestack, I32 *) /* scopes we've ENTERed */
52PERLVAR(I, scopestack_ix, I32)
53PERLVAR(I, scopestack_max, I32)
54
115ff745 55PERLVAR(I, tmps_stack, SV **) /* mortals we've made */
e8eb279c
FC
56PERLVARI(I, tmps_ix, SSize_t, -1)
57PERLVARI(I, tmps_floor, SSize_t, -1)
58PERLVAR(I, tmps_max, SSize_t)
19bc2726
DM
59
60PERLVARI(I, sub_generation, U32, 1) /* incr to invalidate method cache */
907b3e23 61
115ff745 62PERLVAR(I, markstack, I32 *) /* stack_sp locations we're
907b3e23 63 remembering */
115ff745
NC
64PERLVAR(I, markstack_ptr, I32 *)
65PERLVAR(I, markstack_max, I32 *)
907b3e23 66
6a5b4183
YO
67#ifdef PERL_HASH_RANDOMIZE_KEYS
68#ifdef USE_PERL_PERTURB_KEYS
69PERLVARI(I, hash_rand_bits_enabled, U8, 1) /* used to randomize hash stuff 0 == no-random, 1 == random, 2 == determinsitic */
70#endif
0e0ab621 71PERLVARI(I, hash_rand_bits, UV, 0) /* used to randomize hash stuff */
6a5b4183 72#endif
19bc2726
DM
73PERLVAR(I, strtab, HV *) /* shared string table */
74
75/* Fields used by magic variables such as $@, $/ and so on */
76PERLVAR(I, curpm, PMOP *) /* what to do \ interps in REs from */
77
78PERLVAR(I, tainting, bool) /* doing taint checks */
79PERLVAR(I, tainted, bool) /* using variables controlled by $< */
80PERLVAR(I, delaymagic, U16) /* ($<,$>) = ... */
81PERLVAR(I, localizing, U8) /* are we processing a local() list? */
82PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */
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 */
115PERLVAR(I, sv_objcount, IV) /* DEPRECATED AND UNMAINTAINED.
116 * Will be removed in Perl 5.20.
117 * Used to be: how many objects are currently allocated. */
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)
115ff745 152PERLVAR(I, Sv, SV *) /* used to hold temporary values */
19bc2726
DM
153
154PERLVAR(I, parser, yy_parser *) /* current parser state */
155
156PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */
157
907b3e23
DM
158
159/*
160=for apidoc Amn|STRLEN|PL_na
161
162A convenience variable which is typically used with C<SvPV> when one
163doesn't care about the length of the string. It is usually more efficient
164to either declare a local variable and use that instead or to use the
165C<SvPV_nolen> macro.
166
167=cut
168*/
169
115ff745 170PERLVAR(I, na, STRLEN) /* for use in SvPV when length is
907b3e23
DM
171 Not Applicable */
172
173/* stat stuff */
115ff745
NC
174PERLVAR(I, statbuf, Stat_t)
175PERLVAR(I, statcache, Stat_t) /* _ */
176PERLVAR(I, statgv, GV *)
177PERLVARI(I, statname, SV *, NULL)
907b3e23
DM
178
179#ifdef HAS_TIMES
115ff745 180PERLVAR(I, timesbuf, struct tms)
907b3e23
DM
181#endif
182
907b3e23
DM
183/*
184=for apidoc mn|SV*|PL_rs
185
186The input record separator - C<$/> in Perl space.
187
188=for apidoc mn|GV*|PL_last_in_gv
189
190The GV which was last used for a filehandle input operation. (C<< <FH> >>)
191
e23d9e2f 192=for apidoc mn|GV*|PL_ofsgv
907b3e23 193
e23d9e2f 194The glob containing the output field separator - C<*,> in Perl space.
907b3e23
DM
195
196=cut
197*/
198
115ff745
NC
199PERLVAR(I, rs, SV *) /* input record separator $/ */
200PERLVAR(I, last_in_gv, GV *) /* GV used in last <FH> */
201PERLVAR(I, ofsgv, GV *) /* GV of output field separator *, */
202PERLVAR(I, defoutgv, GV *) /* default FH for output */
203PERLVARI(I, chopset, const char *, " \n-") /* $: */
204PERLVAR(I, formtarget, SV *)
205PERLVAR(I, bodytarget, SV *)
206PERLVAR(I, toptarget, SV *)
907b3e23 207
115ff745
NC
208
209PERLVAR(I, restartop, OP *) /* propagating an error from croak? */
210PERLVAR(I, restartjmpenv, JMPENV *) /* target frame for longjmp in die */
907b3e23 211
115ff745
NC
212PERLVAR(I, top_env, JMPENV *) /* ptr to current sigjmp environment */
213PERLVAR(I, start_env, JMPENV) /* empty startup sigjmp environment */
214PERLVARI(I, errors, SV *, NULL) /* outstanding queued errors */
907b3e23
DM
215
216/* statics "owned" by various functions */
115ff745 217PERLVAR(I, hv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
907b3e23 218
115ff745 219PERLVAR(I, lastgotoprobe, OP*) /* from pp_ctl.c */
907b3e23
DM
220
221/* sort stuff */
115ff745
NC
222PERLVAR(I, sortcop, OP *) /* user defined sort routine */
223PERLVAR(I, sortstash, HV *) /* which is in some package or other */
224PERLVAR(I, firstgv, GV *) /* $a */
225PERLVAR(I, secondgv, GV *) /* $b */
907b3e23
DM
226
227/* float buffer */
115ff745
NC
228PERLVAR(I, efloatbuf, char *)
229PERLVAR(I, efloatsize, STRLEN)
907b3e23 230
115ff745 231PERLVARI(I, dumpindent, U16, 4) /* number of blanks per dump
907b3e23
DM
232 indentation level */
233
e914d9bb 234PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
157b3822 235
115ff745 236PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
907b3e23 237
87c1d905 238PERLVARA(I, colors,6, char *) /* values from PERL_RE_COLORS env var */
907b3e23 239
9ea12537
Z
240/*
241=for apidoc Amn|peep_t|PL_peepp
242
243Pointer to the per-subroutine peephole optimiser. This is a function
244that gets called at the end of compilation of a Perl subroutine (or
245equivalently independent piece of Perl code) to perform fixups of
246some ops and to perform small-scale optimisations. The function is
247called once for each subroutine that is compiled, and is passed, as sole
248parameter, a pointer to the op that is the entry point to the subroutine.
249It modifies the op tree in place.
250
251The peephole optimiser should never be completely replaced. Rather,
252add code to it by wrapping the existing optimiser. The basic way to do
253this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
254If the new code wishes to operate on ops throughout the subroutine's
255structure, rather than just at the top level, it is likely to be more
256convenient to wrap the L</PL_rpeepp> hook.
257
258=cut
259*/
260
115ff745 261PERLVARI(I, peepp, peep_t, Perl_peep)
9ea12537
Z
262
263/*
264=for apidoc Amn|peep_t|PL_rpeepp
265
266Pointer to the recursive peephole optimiser. This is a function
267that gets called at the end of compilation of a Perl subroutine (or
268equivalently independent piece of Perl code) to perform fixups of some
269ops and to perform small-scale optimisations. The function is called
270once for each chain of ops linked through their C<op_next> fields;
271it is recursively called to handle each side chain. It is passed, as
272sole parameter, a pointer to the op that is at the head of the chain.
273It modifies the op tree in place.
274
275The peephole optimiser should never be completely replaced. Rather,
276add code to it by wrapping the existing optimiser. The basic way to do
277this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
278If the new code wishes to operate only on ops at a subroutine's top level,
279rather than throughout the structure, it is likely to be more convenient
280to wrap the L</PL_peepp> hook.
281
282=cut
283*/
284
115ff745 285PERLVARI(I, rpeepp, peep_t, Perl_rpeep)
907b3e23 286
2f175318
VP
287/*
288=for apidoc Amn|Perl_ophook_t|PL_opfreehook
289
290When 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.
291This allows extensions to free any extra attribute they have locally attached to an OP.
292It is also assured to first fire for the parent OP and then for its kids.
293
294When 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.
295
296=cut
297*/
298
115ff745 299PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 300
115ff745
NC
301PERLVARI(I, watchaddr, char **, 0)
302PERLVAR(I, watchok, char *)
907b3e23 303
115ff745 304PERLVAR(I, perldb, U32)
d95e864f 305
115ff745 306PERLVAR(I, signals, U32) /* Using which pre-5.8 signals */
30b0736d 307
79968a97
NC
308PERLVAR(I, reentrant_retint, int) /* Integer return value from reentrant functions */
309
49f531da 310/* pseudo environmental stuff */
115ff745
NC
311PERLVAR(I, origargc, int)
312PERLVAR(I, origargv, char **)
313PERLVAR(I, envgv, GV *)
314PERLVAR(I, incgv, GV *)
315PERLVAR(I, hintgv, GV *)
316PERLVAR(I, origfilename, char *)
317PERLVAR(I, diehook, SV *)
318PERLVAR(I, warnhook, SV *)
1d7c1841
GS
319
320/* switches */
115ff745
NC
321PERLVAR(I, patchlevel, SV *)
322PERLVAR(I, apiversion, SV *)
323PERLVAR(I, localpatches, const char * const *)
324PERLVARI(I, splitstr, const char *, " ")
325
326PERLVAR(I, minus_c, bool)
327PERLVAR(I, minus_n, bool)
328PERLVAR(I, minus_p, bool)
329PERLVAR(I, minus_l, bool)
330PERLVAR(I, minus_a, bool)
331PERLVAR(I, minus_F, bool)
332PERLVAR(I, doswitches, bool)
333PERLVAR(I, minus_E, bool)
954c1994 334
115ff745
NC
335PERLVAR(I, inplace, char *)
336PERLVAR(I, e_script, SV *)
49f531da 337
115ff745 338PERLVAR(I, basetime, Time_t) /* $^T */
d4cce5f1 339
115ff745 340PERLVARI(I, maxsysfd, I32, MAXSYSFD)
cb68f92d 341 /* top fd to pass to subprocesses */
115ff745 342PERLVAR(I, statusvalue, I32) /* $? */
49f531da 343#ifdef VMS
115ff745 344PERLVAR(I, statusvalue_vms, U32)
e5218da5 345#else
115ff745 346PERLVAR(I, statusvalue_posix, I32)
49f531da
NIS
347#endif
348
115ff745
NC
349PERLVARI(I, sig_pending, int, 0) /* Number if highest signal pending */
350PERLVAR(I, psig_pend, int *) /* per-signal "count" of pending */
157b3822 351
49f531da 352/* shortcuts to various I/O objects */
115ff745
NC
353PERLVAR(I, stdingv, GV *) /* *STDIN */
354PERLVAR(I, stderrgv, GV *) /* *STDERR */
355PERLVAR(I, defgv, GV *)
356PERLVAR(I, argvgv, GV *) /* *ARGV */
357PERLVAR(I, argvoutgv, GV *) /* *ARGVOUT */
358PERLVAR(I, argvout_stack, AV *)
49f531da
NIS
359
360/* shortcuts to regexp stuff */
115ff745 361PERLVAR(I, replgv, GV *) /* *^R */
49f531da
NIS
362
363/* shortcuts to misc objects */
115ff745 364PERLVAR(I, errgv, GV *) /* *@ */
49f531da
NIS
365
366/* shortcuts to debugging objects */
115ff745
NC
367PERLVAR(I, DBgv, GV *) /* *DB::DB */
368PERLVAR(I, DBline, GV *) /* *DB::line */
954c1994
GS
369
370/*
2eb25c99 371=for apidoc mn|GV *|PL_DBsub
954c1994
GS
372When Perl is run in debugging mode, with the B<-d> switch, this GV contains
373the SV which holds the name of the sub being debugged. This is the C
374variable which corresponds to Perl's $DB::sub variable. See
375C<PL_DBsingle>.
376
2eb25c99 377=for apidoc mn|SV *|PL_DBsingle
954c1994 378When Perl is run in debugging mode, with the B<-d> switch, this SV is a
7889fe52 379boolean which indicates whether subs are being single-stepped.
954c1994
GS
380Single-stepping is automatically turned on after every step. This is the C
381variable which corresponds to Perl's $DB::single variable. See
382C<PL_DBsub>.
383
2eb25c99 384=for apidoc mn|SV *|PL_DBtrace
954c1994
GS
385Trace variable used when Perl is run in debugging mode, with the B<-d>
386switch. This is the C variable which corresponds to Perl's $DB::trace
387variable. See C<PL_DBsingle>.
388
389=cut
390*/
391
115ff745
NC
392PERLVAR(I, DBsub, GV *) /* *DB::sub */
393PERLVAR(I, DBsingle, SV *) /* $DB::single */
394PERLVAR(I, DBtrace, SV *) /* $DB::trace */
395PERLVAR(I, DBsignal, SV *) /* $DB::signal */
396PERLVAR(I, dbargs, AV *) /* args to call listed by caller function */
49f531da
NIS
397
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
NC
538PERLVAR(I, max_intro_pending, I32) /* end of vars to introduce */
539PERLVAR(I, padix, I32) /* max used index in current "register" pad */
d95e864f 540
115ff745 541PERLVAR(I, padix_floor, I32) /* how low may inner block reset padix */
0672f40e 542
0672f40e 543#ifdef USE_LOCALE_COLLATE
115ff745
NC
544PERLVAR(I, collation_name, char *) /* Name of current collation */
545PERLVAR(I, collxfrm_base, Size_t) /* Basic overhead in *xfrm() */
546PERLVARI(I, collxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
547PERLVARI(I, collation_ix, U32, 0) /* Collation generation index */
548PERLVARI(I, collation_standard, bool, TRUE)
9f7da6d5 549 /* Assume simple collation */
0672f40e
GS
550#endif /* USE_LOCALE_COLLATE */
551
19bc2726
DM
552#ifdef PERL_SAWAMPERSAND
553PERLVAR(I, sawampersand, U8) /* must save all match strings */
9f7da6d5 554#endif
95ca8690 555
19bc2726 556PERLVAR(I, unsafe, bool)
87c1d905 557PERLVAR(I, colorset, bool) /* PERL_RE_COLORS env var is in use */
19bc2726 558
79968a97
NC
559/* current phase the interpreter is in
560 for ordering this structure to remove holes, we're assuming that this is 4
561 bytes. */
562PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
563
564PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
565
566/* This value may be set when embedding for full cleanup */
567/* 0=none, 1=full, 2=full with checks */
568/* mod_perl is special, and also assigns a meaning -1 */
569PERLVARI(I, perl_destruct_level, signed char, 0)
9f7da6d5 570
0672f40e
GS
571#ifdef USE_LOCALE_NUMERIC
572
115ff745 573PERLVARI(I, numeric_standard, bool, TRUE)
0672f40e 574 /* Assume simple numerics */
115ff745 575PERLVARI(I, numeric_local, bool, TRUE)
0672f40e 576 /* Assume local numerics */
115ff745
NC
577PERLVAR(I, numeric_name, char *) /* Name of current numeric locale */
578PERLVAR(I, numeric_radix_sv, SV *) /* The radix separator if not '.' */
f8115845 579
0672f40e
GS
580#endif /* !USE_LOCALE_NUMERIC */
581
a3e1f3a6
KW
582/* Unicode inversion lists */
583PERLVAR(I, ASCII, SV *)
584PERLVAR(I, Latin1, SV *)
585PERLVAR(I, AboveLatin1, SV *)
586
26faadbd 587PERLVAR(I, NonL1NonFinalFold, SV *)
9d53c457 588PERLVAR(I, HasMultiCharFold, SV *)
26faadbd 589
a3e1f3a6 590/* utf8 character class swashes */
115ff745 591PERLVAR(I, utf8_mark, SV *)
27d4fc33 592PERLVAR(I, utf8_X_regular_begin, SV *)
115ff745 593PERLVAR(I, utf8_X_extend, SV *)
115ff745
NC
594PERLVAR(I, utf8_toupper, SV *)
595PERLVAR(I, utf8_totitle, SV *)
596PERLVAR(I, utf8_tolower, SV *)
597PERLVAR(I, utf8_tofold, SV *)
bde9e88d
KW
598PERLVAR(I, utf8_charname_begin, SV *)
599PERLVAR(I, utf8_charname_continue, SV *)
30f9bdb0 600
63c61c3f 601PERLVARA(I, utf8_swash_ptrs, POSIX_SWASH_COUNT, SV *)
30f9bdb0 602PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
86f72d56 603PERLVARA(I, L1Posix_ptrs, POSIX_CC_COUNT, SV *)
cac6e0ca
KW
604PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
605
115ff745
NC
606PERLVAR(I, last_swash_hv, HV *)
607PERLVAR(I, last_swash_tmps, U8 *)
608PERLVAR(I, last_swash_slen, STRLEN)
6c2f1a55 609PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8)
45d91b83 610PERLVAR(I, last_swash_klen, U8) /* Only needs to store 0-12 */
d95e864f
NC
611
612#ifdef FCRYPT
115ff745 613PERLVARI(I, cryptseen, bool, FALSE) /* has fast crypt() been initialized? */
79968a97
NC
614#else
615/* One byte hole in the interpreter structure. */
d95e864f
NC
616#endif
617
115ff745 618PERLVAR(I, pad_reset_pending, bool) /* reset pad on next attempted alloc */
e6b4660c 619PERLVAR(I, srand_called, bool)
12fbd33b 620
c4a30c8c
NC
621/* Array of signal handlers, indexed by signal number, through which the C
622 signal handler dispatches. */
115ff745 623PERLVAR(I, psig_ptr, SV **)
c4a30c8c 624/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
625 argument to a signal handler. Only one block of memory is allocated for
626 both psig_name and psig_ptr. */
115ff745 627PERLVAR(I, psig_name, SV **)
1d7c1841 628
c5be433b 629#if defined(PERL_IMPLICIT_SYS)
115ff745
NC
630PERLVAR(I, Mem, struct IPerlMem *)
631PERLVAR(I, MemShared, struct IPerlMem *)
632PERLVAR(I, MemParse, struct IPerlMem *)
633PERLVAR(I, Env, struct IPerlEnv *)
634PERLVAR(I, StdIO, struct IPerlStdIO *)
635PERLVAR(I, LIO, struct IPerlLIO *)
636PERLVAR(I, Dir, struct IPerlDir *)
637PERLVAR(I, Sock, struct IPerlSock *)
638PERLVAR(I, Proc, struct IPerlProc *)
76e3520e 639#endif
1d7c1841 640
115ff745
NC
641PERLVAR(I, ptr_table, PTR_TBL_t *)
642PERLVARI(I, beginav_save, AV *, NULL) /* save BEGIN{}s when compiling */
f180df80 643
115ff745 644PERLVAR(I, body_arenas, void *) /* pointer to list of body-arenas */
93e68bfb 645
d95e864f 646
1fcf4c12 647#if defined(USE_ITHREADS)
115ff745 648PERLVAR(I, regex_pad, SV **) /* Shortcut into the array of
e6853197 649 regex_padav */
115ff745 650PERLVAR(I, regex_padav, AV *) /* All regex objects, indexed via the
e6853197 651 values in op_pmoffset of pmop.
402d2eb1
NC
652 Entry 0 is an SV whose PV is a
653 "packed" list of IVs listing
e6853197 654 the now-free slots in the array */
d4d03940
FC
655PERLVAR(I, stashpad, HV **) /* for CopSTASH */
656PERLVARI(I, stashpadmax, PADOFFSET, 64)
657PERLVARI(I, stashpadix, PADOFFSET, 0)
1fcf4c12
AB
658#endif
659
ea68fd67 660#ifdef USE_REENTRANT_API
115ff745 661PERLVAR(I, reentrant_buffer, REENTR *) /* here we store the _r buffers */
f5a82810
JH
662#endif
663
115ff745
NC
664PERLVAR(I, custom_op_names, HV *) /* Names of user defined ops */
665PERLVAR(I, custom_op_descs, HV *) /* Descriptions of user defined ops */
19e8ce8e 666
a1ea730d 667#ifdef PERLIO_LAYERS
115ff745
NC
668PERLVARI(I, perlio, PerlIOl *, NULL)
669PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
670PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
a1ea730d
NIS
671#endif
672
115ff745 673PERLVARI(I, encoding, SV *, NULL) /* character encoding */
0a378802 674
115ff745
NC
675PERLVAR(I, utf8_idstart, SV *)
676PERLVAR(I, utf8_idcont, SV *)
677PERLVAR(I, utf8_xidstart, SV *)
b6912c02 678PERLVAR(I, utf8_perl_idstart, SV *)
eba68aa0 679PERLVAR(I, utf8_perl_idcont, SV *)
115ff745 680PERLVAR(I, utf8_xidcont, SV *)
82686b01 681
115ff745 682PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
147f47de 683
115ff745
NC
684PERLVARI(I, checkav_save, AV *, NULL) /* save CHECK{}s when compiling */
685PERLVARI(I, unitcheckav_save, AV *, NULL)
686 /* save UNITCHECK{}s when compiling */
ece599bd 687
115ff745 688PERLVARI(I, clocktick, long, 0) /* this many times() ticks in a second */
5311654c 689
15a5279a 690/* Hooks to shared SVs and locks. */
115ff745
NC
691PERLVARI(I, sharehook, share_proc_t, Perl_sv_nosharing)
692PERLVARI(I, lockhook, share_proc_t, Perl_sv_nosharing)
d0647d4e
NC
693#ifdef NO_MATHOMS
694# define PERL_UNLOCK_HOOK Perl_sv_nosharing
695#else
696/* This reference ensures that the mathoms are linked with perl */
697# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
698#endif
115ff745 699PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 700
115ff745 701PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 702
9e08d3a4 703/* Can shared object be destroyed */
115ff745 704PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
9e08d3a4 705
01d65469 706#ifndef PERL_MICRO
115ff745 707PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
01d65469 708#endif
92f022bb 709
115ff745 710PERLVARI(I, isarev, HV *, NULL) /* Reverse map of @ISA dependencies */
f16dd614 711
9e08d3a4
NC
712/* Register of known Method Resolution Orders.
713 What this actually points to is an implementation detail (it may change to
714 a structure incorporating a reference count - use mro_get_from_name to
715 retrieve a C<struct mro_alg *> */
115ff745 716PERLVAR(I, registered_mros, HV *)
9e08d3a4
NC
717
718/* Compile-time block start/end hooks */
115ff745 719PERLVAR(I, blockhooks, AV *)
9e08d3a4
NC
720
721/* Everything that folds to a given character, for case insensitivity regex
722 * matching */
115ff745 723PERLVARI(I, utf8_foldclosures, HV *, NULL)
9e08d3a4
NC
724
725/* List of characters that participate in folds (except marks, etc in
726 * multi-char folds) */
115ff745 727PERLVARI(I, utf8_foldable, SV *, NULL)
9e08d3a4 728
115ff745 729PERLVAR(I, custom_ops, HV *) /* custom op registrations */
9e08d3a4 730
19bc2726
DM
731PERLVAR(I, Xpv, XPV *) /* (unused) held temporary value */
732
733/* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
734 present always, as -DDEBUGGING must be binary compatible with non. */
735PERLVARI(I, scopestack_name, const char * *, NULL)
736
737PERLVAR(I, debug_pad, struct perl_debug_pad) /* always needed because of the re extension */
738
d67594ff
FC
739/* Hook for File::Glob */
740PERLVARI(I, globhook, globhook_t, NULL)
741
7e8c6c4c 742/* The last unconditional member of the interpreter structure when 5.19.4 was
ffee3ff6
NC
743 released. The offset of the end of this is baked into a global variable in
744 any shared perl library which will allow a sanity test in future perl
745 releases. */
d399cf59 746#define PERL_LAST_5_18_0_INTERP_MEMBER Iglobhook
ffee3ff6 747
f16dd614 748#ifdef PERL_IMPLICIT_CONTEXT
115ff745 749PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
817b0f24 750PERLVARI(I, my_cxt_size, int, 0) /* size of PL_my_cxt_list */
ba6d381e 751# ifdef PERL_GLOBAL_STRUCT_PRIVATE
115ff745 752PERLVARI(I, my_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
ba6d381e 753# endif
f16dd614
DM
754#endif
755
7cb608b5
NC
756#ifdef PERL_TRACK_MEMPOOL
757/* For use with the memory debugging code in util.c */
115ff745 758PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
7cb608b5
NC
759#endif
760
ba6d381e
NC
761#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
762/* File descriptor to talk to the child which dumps scalars. */
115ff745 763PERLVARI(I, dumper_fd, int, -1)
ba6d381e
NC
764#endif
765
ba6d381e 766#ifdef PERL_MAD
115ff745 767PERLVARI(I, madskills, bool, FALSE) /* preserve all syntactic info */
ba6d381e 768 /* (MAD = Misc Attribute Decoration) */
115ff745 769PERLVARI(I, xmlfp, PerlIO *, NULL)
ba6d381e
NC
770#endif
771
d7a2c63c 772#ifdef DEBUG_LEAKING_SCALARS
115ff745 773PERLVARI(I, sv_serial, U32, 0) /* SV serial number, used in sv.c */
d7a2c63c
MHM
774#endif
775
a38ab475
RZ
776PERLVARA(I, sv_consts, SV_CONSTS_COUNT, SV*) /* constant SVs with precomputed hash value */
777
75d476e2
SM
778#ifdef PERL_TRACE_OPS
779PERLVARA(I, op_exec_cnt, OP_max+2, UV) /* Counts of executed OPs of the given type.
780 If PERL_TRACE_OPS is enabled, we'll dump
781 a summary count of all ops executed in the
782 program at perl_destruct time. For
783 profiling/debugging only. Works only if
784 DEBUGGING is enabled, too. */
785#endif
786
157b3822
NC
787/* If you are adding a U8 or U16, check to see if there are 'Space' comments
788 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
789
790/* Within a stable branch, new variables must be added to the very end, before
791 * this comment, for binary compatibility (the offsets of the old members must
792 * not change).
b83cd129 793 * (Don't forget to add your variable also to perl_clone()!)
e3acbfda 794 * XSUB.h provides wrapper functions via perlapi.h that make this
b83cd129
JH
795 * irrelevant, but not all code may be expected to #include XSUB.h.
796 */