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