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