This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
OS2-Process/Process.pm: Fix broken pod links
[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
35PERLVAR(Istack_sp, SV **) /* top of the stack */
36#ifdef OP_IN_REGISTER
37PERLVAR(Iopsave, OP *)
38#else
39PERLVAR(Iop, OP *) /* currently executing op */
40#endif
41PERLVAR(Icurpad, SV **) /* active pad (lexicals+tmps) */
42
43PERLVAR(Istack_base, SV **)
44PERLVAR(Istack_max, SV **)
45
46PERLVAR(Iscopestack, 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. */
49PERLVARI(Iscopestack_name, const char * *, NULL)
907b3e23
DM
50PERLVAR(Iscopestack_ix, I32)
51PERLVAR(Iscopestack_max,I32)
52
53PERLVAR(Isavestack, ANY *) /* items that need to be restored when
54 LEAVEing scopes we've ENTERed */
55PERLVAR(Isavestack_ix, I32)
56PERLVAR(Isavestack_max, I32)
57
58PERLVAR(Itmps_stack, SV **) /* mortals we've made */
59PERLVARI(Itmps_ix, I32, -1)
60PERLVARI(Itmps_floor, I32, -1)
61PERLVAR(Itmps_max, I32)
3ad73efd 62PERLVAR(Imodcount, I32) /* how much op_lvalue()ification in
907b3e23
DM
63 assignment? */
64
65PERLVAR(Imarkstack, I32 *) /* stack_sp locations we're
66 remembering */
67PERLVAR(Imarkstack_ptr, I32 *)
68PERLVAR(Imarkstack_max, I32 *)
69
70PERLVAR(ISv, SV *) /* used to hold temporary values */
71PERLVAR(IXpv, XPV *) /* used to hold temporary values */
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
84PERLVAR(Ina, STRLEN) /* for use in SvPV when length is
85 Not Applicable */
86
87/* stat stuff */
88PERLVAR(Istatbuf, Stat_t)
89PERLVAR(Istatcache, Stat_t) /* _ */
90PERLVAR(Istatgv, GV *)
91PERLVARI(Istatname, SV *, NULL)
92
93#ifdef HAS_TIMES
94PERLVAR(Itimesbuf, struct tms)
95#endif
96
97/* Fields used by magic variables such as $@, $/ and so on */
98PERLVAR(Icurpm, PMOP *) /* what to do \ interps in REs from */
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
116PERLVAR(Irs, SV *) /* input record separator $/ */
117PERLVAR(Ilast_in_gv, GV *) /* GV used in last <FH> */
e23d9e2f 118PERLVAR(Iofsgv, GV *) /* GV of output field separator *, */
907b3e23
DM
119PERLVAR(Idefoutgv, GV *) /* default FH for output */
120PERLVARI(Ichopset, const char *, " \n-") /* $: */
121PERLVAR(Iformtarget, SV *)
122PERLVAR(Ibodytarget, SV *)
123PERLVAR(Itoptarget, SV *)
124
125/* Stashes */
126PERLVAR(Idefstash, HV *) /* main symbol table */
127PERLVAR(Icurstash, HV *) /* symbol table for current package */
128
129PERLVAR(Irestartop, OP *) /* propagating an error from croak? */
febb3a6d 130PERLVAR(Irestartjmpenv, JMPENV *) /* target frame for longjmp in die */
910e0671 131PERLVAR(Icurcop, COP *)
907b3e23
DM
132PERLVAR(Icurstack, AV *) /* THE STACK */
133PERLVAR(Icurstackinfo, PERL_SI *) /* current stack + context */
134PERLVAR(Imainstack, AV *) /* the stack when nothing funny is
135 happening */
136
137PERLVAR(Itop_env, JMPENV *) /* ptr to current sigjmp environment */
138PERLVAR(Istart_env, JMPENV) /* empty startup sigjmp environment */
139PERLVARI(Ierrors, SV *, NULL) /* outstanding queued errors */
140
141/* statics "owned" by various functions */
907b3e23
DM
142PERLVAR(Ihv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
143
907b3e23
DM
144PERLVAR(Ilastgotoprobe, OP*) /* from pp_ctl.c */
145
146/* sort stuff */
147PERLVAR(Isortcop, OP *) /* user defined sort routine */
148PERLVAR(Isortstash, HV *) /* which is in some package or other */
149PERLVAR(Ifirstgv, GV *) /* $a */
150PERLVAR(Isecondgv, GV *) /* $b */
151
152/* float buffer */
153PERLVAR(Iefloatbuf, char *)
154PERLVAR(Iefloatsize, STRLEN)
155
156/* regex stuff */
157
907b3e23
DM
158PERLVAR(Ireg_state, struct re_save_state)
159
160PERLVAR(Iregdummy, regnode) /* from regcomp.c */
161
162PERLVARI(Idumpindent, U16, 4) /* number of blanks per dump
163 indentation level */
164
157b3822
NC
165
166PERLVAR(Iutf8locale, bool) /* utf8 locale detected */
167PERLVARI(Irehash_seed_set, bool, FALSE) /* 582 hash initialized? */
907b3e23
DM
168
169PERLVARA(Icolors,6, char *) /* from regcomp.c */
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
ef69c8fc 192PERLVARI(Ipeepp, 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
ef69c8fc 216PERLVARI(Irpeepp, 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
799dfa8f 230PERLVARI(Iopfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 231
4185c919 232/* Space for U32 */
907b3e23
DM
233PERLVARI(Ireginterp_cnt,I32, 0) /* Whether "Regexp" was interpolated. */
234PERLVARI(Iwatchaddr, char **, 0)
235PERLVAR(Iwatchok, char *)
236
237/* the currently active slab in a chain of slabs of regmatch states,
238 * and the currently active state within that slab */
239
240PERLVARI(Iregmatch_slab, regmatch_slab *, NULL)
241PERLVAR(Iregmatch_state, regmatch_state *)
242
907b3e23 243/* Put anything new that is pointer aligned here. */
d95e864f 244
907b3e23
DM
245PERLVAR(Idelaymagic, U16) /* ($<,$>) = ... */
246PERLVAR(Ilocalizing, U8) /* are we processing a local() list? */
247PERLVAR(Icolorset, bool) /* from regcomp.c */
910e0671 248PERLVAR(Iin_eval, U8) /* trap "fatal" errors? */
907b3e23 249PERLVAR(Itainted, bool) /* using variables controlled by $< */
30b0736d 250PERLVAR(Itainting, 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
NC
254/* mod_perl is special, and also assigns a meaning -1 */
255PERLVARI(Iperl_destruct_level, signed char, 0)
d95e864f 256
30b0736d
NC
257/* current phase the interpreter is in */
258PERLVARI(Iphase, enum perl_phase, PERL_PHASE_CONSTRUCT)
259
d95e864f
NC
260PERLVAR(Iperldb, U32)
261
30b0736d
NC
262PERLVAR(Isignals, U32) /* Using which pre-5.8 signals */
263
49f531da 264/* pseudo environmental stuff */
d95e864f 265PERLVAR(Iorigargc, int)
cb68f92d
GS
266PERLVAR(Iorigargv, char **)
267PERLVAR(Ienvgv, GV *)
cb68f92d 268PERLVAR(Iincgv, GV *)
b3ac6de7 269PERLVAR(Ihintgv, GV *)
cb68f92d
GS
270PERLVAR(Iorigfilename, char *)
271PERLVAR(Idiehook, SV *)
272PERLVAR(Iwarnhook, SV *)
1d7c1841
GS
273
274/* switches */
a7cb1f99 275PERLVAR(Ipatchlevel, SV *)
1e8125c6 276PERLVAR(Iapiversion, SV *)
27da23d5 277PERLVAR(Ilocalpatches, const char * const *)
dd374669 278PERLVARI(Isplitstr, const char *, " ")
9f7da6d5
NC
279
280PERLVAR(Iminus_c, bool)
cb68f92d
GS
281PERLVAR(Iminus_n, bool)
282PERLVAR(Iminus_p, bool)
283PERLVAR(Iminus_l, bool)
284PERLVAR(Iminus_a, bool)
285PERLVAR(Iminus_F, bool)
286PERLVAR(Idoswitches, bool)
bc9b29db 287PERLVAR(Iminus_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
d41ff1b8 298PERLVAR(Idowarn, U8)
49f531da 299PERLVAR(Isawampersand, bool) /* must save all match strings */
cb68f92d 300PERLVAR(Iunsafe, bool)
9f7da6d5
NC
301PERLVAR(Iexit_flags, U8) /* was exit() unexpected, etc. */
302PERLVAR(Isrand_called, bool)
4fa7c2bf 303PERLVARI(Iin_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
30b0736d 304 /* Space for a U16 */
cb68f92d
GS
305PERLVAR(Iinplace, char *)
306PERLVAR(Ie_script, SV *)
49f531da
NIS
307
308/* magical thingies */
309PERLVAR(Ibasetime, Time_t) /* $^T */
310PERLVAR(Iformfeed, SV *) /* $^L */
d4cce5f1
NIS
311
312
cb68f92d
GS
313PERLVARI(Imaxsysfd, I32, MAXSYSFD)
314 /* top fd to pass to subprocesses */
49f531da
NIS
315PERLVAR(Istatusvalue, I32) /* $? */
316#ifdef VMS
cb68f92d 317PERLVAR(Istatusvalue_vms,U32)
e5218da5
GA
318#else
319PERLVAR(Istatusvalue_posix,I32)
49f531da
NIS
320#endif
321
157b3822
NC
322PERLVARI(Isig_pending, int,0) /* Number if highest signal pending */
323PERLVAR(Ipsig_pend, int *) /* per-signal "count" of pending */
324
49f531da 325/* shortcuts to various I/O objects */
16d811d4
DM
326PERLVAR(Istdingv, GV *) /* *STDIN */
327PERLVAR(Istderrgv, GV *) /* *STDERR */
cb68f92d 328PERLVAR(Idefgv, GV *)
16d811d4
DM
329PERLVAR(Iargvgv, GV *) /* *ARGV */
330PERLVAR(Iargvoutgv, GV *) /* *ARGVOUT */
1d7c1841 331PERLVAR(Iargvout_stack, AV *)
49f531da
NIS
332
333/* shortcuts to regexp stuff */
16d811d4 334PERLVAR(Ireplgv, GV *) /* *^R */
49f531da
NIS
335
336/* shortcuts to misc objects */
16d811d4 337PERLVAR(Ierrgv, GV *) /* *@ */
49f531da
NIS
338
339/* shortcuts to debugging objects */
16d811d4
DM
340PERLVAR(IDBgv, GV *) /* *DB::DB */
341PERLVAR(IDBline, 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
16d811d4
DM
365PERLVAR(IDBsub, GV *) /* *DB::sub */
366PERLVAR(IDBsingle, SV *) /* $DB::single */
367PERLVAR(IDBtrace, SV *) /* $DB::trace */
368PERLVAR(IDBsignal, SV *) /* $DB::signal */
49f531da
NIS
369PERLVAR(Idbargs, AV *) /* args to call listed by caller function */
370
371/* symbol tables */
49f531da
NIS
372PERLVAR(Idebstash, HV *) /* symbol table for perldb package */
373PERLVAR(Iglobalstash, HV *) /* global keyword overrides imported here */
374PERLVAR(Icurstname, SV *) /* name of current package */
375PERLVAR(Ibeginav, AV *) /* names of BEGIN subroutines */
d4cce5f1 376PERLVAR(Iendav, AV *) /* names of END subroutines */
3c10abe3 377PERLVAR(Iunitcheckav, AV *) /* names of UNITCHECK subroutines */
7d30b5c4 378PERLVAR(Icheckav, AV *) /* names of CHECK subroutines */
49f531da
NIS
379PERLVAR(Iinitav, AV *) /* names of INIT subroutines */
380PERLVAR(Istrtab, HV *) /* shared string table */
005a453c 381PERLVARI(Isub_generation,U32,1) /* incr to invalidate method cache */
49f531da 382
9f7da6d5
NC
383/* funky return mechanisms */
384PERLVAR(Iforkprocess, int) /* so do_open |- can return proc# */
385
49f531da 386/* memory management */
49f531da
NIS
387PERLVAR(Isv_count, I32) /* how many SV* are currently allocated */
388PERLVAR(Isv_objcount, I32) /* how many objects are currently allocated */
389PERLVAR(Isv_root, SV*) /* storage for SVs belonging to interp */
390PERLVAR(Isv_arenaroot, SV*) /* list of areas for garbage collection */
391
49f531da 392/* subprocess state */
d4cce5f1 393PERLVAR(Ifdpid, AV *) /* keep fd-to-pid mappings for my_popen */
49f531da
NIS
394
395/* internal state */
49f531da
NIS
396PERLVARI(Iop_mask, char *, NULL) /* masked operations for safe evals */
397
49f531da 398/* current interpreter roots */
cb68f92d
GS
399PERLVAR(Imain_cv, CV *)
400PERLVAR(Imain_root, OP *)
401PERLVAR(Imain_start, OP *)
402PERLVAR(Ieval_root, OP *)
403PERLVAR(Ieval_start, OP *)
49f531da
NIS
404
405/* runtime control stuff */
cb68f92d 406PERLVARI(Icurcopdb, COP *, NULL)
49f531da 407
49f531da
NIS
408PERLVAR(Ifilemode, int) /* so nextargv() can preserve mode */
409PERLVAR(Ilastfd, int) /* what to preserve mode on */
410PERLVAR(Ioldname, char *) /* what to preserve mode on */
360ea906 411PERLVAR(IArgv, const char **) /* stuff to free from do_aexec, vfork safe */
d4cce5f1 412PERLVAR(ICmd, 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. */
cb68f92d 417PERLVAR(Ipreambleav, AV *)
cb68f92d 418PERLVAR(Imess_sv, SV *)
7889fe52 419PERLVAR(Iors_sv, SV *) /* output record separator $\ */
71eebe1e
NC
420/* statics moved here for shared library purposes */
421PERLVARI(Igensym, I32, 0) /* next symbol for getsym() to define */
a4021b77 422PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
157b3822 423PERLVAR(Itaint_warn, bool) /* taint warns instead of dying */
d95e864f
NC
424PERLVARI(Ilaststype, U16, OP_STAT)
425PERLVARI(Ilaststatval, int, -1)
d4cce5f1 426
4b556e6c 427/* interpreter atexit processing */
d95e864f 428PERLVARI(Iexitlistlen, I32, 0) /* length of same */
cb68f92d
GS
429PERLVARI(Iexitlist, PerlExitListEntry *, NULL)
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
cb68f92d
GS
444PERLVAR(Imodglobal, HV *) /* per-interp module data */
445
446/* these used to be in global before 5.004_68 */
447PERLVARI(Iprofiledata, U32 *, NULL) /* table of ops, counts */
cb68f92d
GS
448
449PERLVAR(Icompiling, COP) /* compiling/done executing marker */
450
451PERLVAR(Icompcv, CV *) /* currently compiling subroutine */
452PERLVAR(Icomppad, AV *) /* storage for lexically scoped temporaries */
453PERLVAR(Icomppad_name, AV *) /* variable names for "my" variables */
454PERLVAR(Icomppad_name_fill, I32) /* last "introduced" variable offset */
455PERLVAR(Icomppad_name_floor, I32) /* start of vars in innermost block */
4b556e6c
JD
456
457#ifdef HAVE_INTERP_INTERN
cb68f92d
GS
458PERLVAR(Isys_intern, struct interp_intern)
459 /* platform internals */
4b556e6c
JD
460#endif
461
7fae4e64 462/* more statics moved here */
7fae4e64 463PERLVAR(IDBcv, CV *) /* from perl.c */
9f7da6d5 464PERLVARI(Igeneration, int, 100) /* from op.c */
56953603 465
cb68f92d 466PERLVARI(Iin_clean_objs,bool, FALSE) /* from sv.c */
57ef47cc 467PERLVARI(Iin_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
9f7da6d5
NC
468PERLVAR(Inomemok, bool) /* let malloc context handle nomem */
469PERLVARI(Isavebegin, bool, FALSE) /* save BEGINs for compiler */
7fae4e64 470
d8eceb89
JH
471PERLVAR(Iuid, Uid_t) /* current real user id */
472PERLVAR(Ieuid, Uid_t) /* current effective user id */
473PERLVAR(Igid, Gid_t) /* current real group id */
474PERLVAR(Iegid, Gid_t) /* current effective group id */
bf9cdc68 475PERLVARI(Ian, 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
483PERLVARI(Icop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
484#undef PERL_COP_SEQMAX
485
bf9cdc68 486PERLVARI(Ievalseq, U32, 0) /* eval sequence number */
0672f40e 487PERLVAR(Iorigalen, U32)
9f7da6d5 488PERLVAR(Iorigenviron, char **)
ca0c25f6 489#ifdef PERL_USES_PL_PIDSTATUS
0672f40e 490PERLVAR(Ipidstatus, HV *) /* pid-to-status mappings for waitpid */
ca0c25f6 491#endif
0672f40e 492PERLVAR(Iosname, char *) /* operating system */
5c728af0 493
0672f40e
GS
494PERLVAR(Isighandlerp, Sighandler_t)
495
232d1c15 496PERLVARA(Ibody_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
93e68bfb 497
ed29bbba 498PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
0672f40e 499
9f7da6d5
NC
500PERLVARI(Imaxo, int, MAXO) /* maximum number of ops */
501
ef69c8fc 502PERLVARI(Irunops, 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
0672f40e
GS
519PERLVAR(Isv_undef, SV)
520PERLVAR(Isv_no, SV)
521PERLVAR(Isv_yes, SV)
522
0672f40e
GS
523PERLVAR(Isubname, SV *) /* name of current subroutine */
524
d95e864f 525PERLVAR(Isubline, I32) /* line this subroutine began on */
0672f40e 526PERLVAR(Imin_intro_pending, I32) /* start of vars to introduce */
d95e864f 527
0672f40e
GS
528PERLVAR(Imax_intro_pending, I32) /* end of vars to introduce */
529PERLVAR(Ipadix, I32) /* max used index in current "register" pad */
d95e864f 530
0672f40e 531PERLVAR(Ipadix_floor, I32) /* how low may inner block reset padix */
0672f40e 532
1d7c1841 533PERLVAR(Ihints, U32) /* pragma-tic compile-time flags */
0672f40e
GS
534
535PERLVAR(Idebug, VOL U32) /* flags given to -D switch */
536
f0cb02e3
NC
537/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
538PERLVARI(Ibreakable_sub_gen, U32, 0)
539
bf9cdc68 540PERLVARI(Iamagic_generation, long, 0)
0672f40e
GS
541
542#ifdef USE_LOCALE_COLLATE
0672f40e 543PERLVAR(Icollation_name,char *) /* Name of current collation */
0672f40e
GS
544PERLVAR(Icollxfrm_base, Size_t) /* Basic overhead in *xfrm() */
545PERLVARI(Icollxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
9f7da6d5
NC
546PERLVARI(Icollation_ix, U32, 0) /* Collation generation index */
547PERLVARI(Icollation_standard, bool, TRUE)
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
95ca8690
DM
557PERLVARI(Iutf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
558#undef PERL___I
559
9f7da6d5 560
0672f40e
GS
561#ifdef USE_LOCALE_NUMERIC
562
0672f40e
GS
563PERLVARI(Inumeric_standard, bool, TRUE)
564 /* Assume simple numerics */
565PERLVARI(Inumeric_local, bool, TRUE)
566 /* Assume local numerics */
9f7da6d5 567PERLVAR(Inumeric_name, char *) /* Name of current numeric locale */
0672f40e
GS
568#endif /* !USE_LOCALE_NUMERIC */
569
570/* utf8 character classes */
571PERLVAR(Iutf8_alnum, SV *)
b8c5462f 572PERLVAR(Iutf8_ascii, SV *)
0672f40e
GS
573PERLVAR(Iutf8_alpha, SV *)
574PERLVAR(Iutf8_space, SV *)
d1eb3177
YO
575PERLVAR(Iutf8_perl_space, SV *)
576PERLVAR(Iutf8_perl_word, SV *)
577PERLVAR(Iutf8_posix_digit, SV *)
b8c5462f
JH
578PERLVAR(Iutf8_cntrl, SV *)
579PERLVAR(Iutf8_graph, SV *)
0672f40e
GS
580PERLVAR(Iutf8_digit, SV *)
581PERLVAR(Iutf8_upper, SV *)
582PERLVAR(Iutf8_lower, SV *)
583PERLVAR(Iutf8_print, SV *)
b8c5462f
JH
584PERLVAR(Iutf8_punct, SV *)
585PERLVAR(Iutf8_xdigit, SV *)
0672f40e 586PERLVAR(Iutf8_mark, SV *)
37e2e78e
KW
587PERLVAR(Iutf8_X_begin, SV *)
588PERLVAR(Iutf8_X_extend, SV *)
589PERLVAR(Iutf8_X_prepend, SV *)
590PERLVAR(Iutf8_X_non_hangul, SV *)
591PERLVAR(Iutf8_X_L, SV *)
592PERLVAR(Iutf8_X_LV, SV *)
593PERLVAR(Iutf8_X_LVT, SV *)
594PERLVAR(Iutf8_X_T, SV *)
595PERLVAR(Iutf8_X_V, SV *)
596PERLVAR(Iutf8_X_LV_LVT_V, SV *)
0672f40e
GS
597PERLVAR(Iutf8_toupper, SV *)
598PERLVAR(Iutf8_totitle, SV *)
599PERLVAR(Iutf8_tolower, SV *)
b4e400f9 600PERLVAR(Iutf8_tofold, SV *)
0672f40e 601PERLVAR(Ilast_swash_hv, HV *)
0672f40e
GS
602PERLVAR(Ilast_swash_tmps, U8 *)
603PERLVAR(Ilast_swash_slen, STRLEN)
9f7da6d5 604PERLVARA(Ilast_swash_key,10, U8)
d95e864f
NC
605PERLVAR(Ilast_swash_klen, U8) /* Only needs to store 0-10 */
606
607#ifdef FCRYPT
608PERLVARI(Icryptseen, bool, FALSE) /* has fast crypt() been initialized? */
609#endif
610
f0cb02e3 611PERLVAR(Ipad_reset_pending, bool) /* reset pad on next attempted alloc */
49947b44 612
d95e864f
NC
613PERLVARI(Iglob_index, int, 0)
614
0672f40e 615
5912531f 616PERLVAR(Iparser, yy_parser *) /* current parser state */
12fbd33b 617
c4a30c8c
NC
618/* Array of signal handlers, indexed by signal number, through which the C
619 signal handler dispatches. */
1d7c1841 620PERLVAR(Ipsig_ptr, SV**)
c4a30c8c 621/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
622 argument to a signal handler. Only one block of memory is allocated for
623 both psig_name and psig_ptr. */
c4a30c8c 624PERLVAR(Ipsig_name, SV**)
1d7c1841 625
c5be433b 626#if defined(PERL_IMPLICIT_SYS)
32e30700 627PERLVAR(IMem, struct IPerlMem*)
1d7c1841
GS
628PERLVAR(IMemShared, struct IPerlMem*)
629PERLVAR(IMemParse, struct IPerlMem*)
32e30700
GS
630PERLVAR(IEnv, struct IPerlEnv*)
631PERLVAR(IStdIO, struct IPerlStdIO*)
632PERLVAR(ILIO, struct IPerlLIO*)
633PERLVAR(IDir, struct IPerlDir*)
634PERLVAR(ISock, struct IPerlSock*)
635PERLVAR(IProc, struct IPerlProc*)
76e3520e 636#endif
1d7c1841 637
1d7c1841 638PERLVAR(Iptr_table, PTR_TBL_t*)
7d49f689 639PERLVARI(Ibeginav_save, AV*, NULL) /* save BEGIN{}s when compiling */
f180df80 640
fdda85ca 641PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
93e68bfb 642
d95e864f 643
a453c169
JH
644#ifdef USE_LOCALE_NUMERIC
645
646PERLVAR(Inumeric_radix_sv, SV *) /* The radix separator if not '.' */
647
648#endif
ce08f86c 649
1fcf4c12 650#if defined(USE_ITHREADS)
e6853197
NC
651PERLVAR(Iregex_pad, SV**) /* Shortcut into the array of
652 regex_padav */
653PERLVAR(Iregex_padav, AV*) /* All regex objects, indexed via the
654 values in op_pmoffset of pmop.
402d2eb1
NC
655 Entry 0 is an SV whose PV is a
656 "packed" list of IVs listing
e6853197 657 the now-free slots in the array */
1fcf4c12
AB
658#endif
659
ea68fd67
NC
660#ifdef USE_REENTRANT_API
661PERLVAR(Ireentrant_buffer, REENTR*) /* here we store the _r buffers */
f5a82810
JH
662#endif
663
53e06cf0
SC
664PERLVAR(Icustom_op_names, HV*) /* Names of user defined ops */
665PERLVAR(Icustom_op_descs, HV*) /* Descriptions of user defined ops */
19e8ce8e 666
a1ea730d 667#ifdef PERLIO_LAYERS
303f2dc3 668PERLVARI(Iperlio, PerlIOl *,NULL)
3a1ee7e8
NIS
669PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
670PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
a1ea730d
NIS
671#endif
672
a0714e2c 673PERLVARI(Iencoding, SV*, NULL) /* character encoding */
0a378802 674
128e8167 675PERLVAR(Idebug_pad, struct perl_debug_pad) /* always needed because of the re extension */
ce333219 676
82686b01
JH
677PERLVAR(Iutf8_idstart, SV *)
678PERLVAR(Iutf8_idcont, SV *)
c11ff943
KW
679PERLVAR(Iutf8_xidstart, SV *)
680PERLVAR(Iutf8_xidcont, SV *)
82686b01 681
147f47de
AB
682PERLVAR(Isort_RealCmp, SVCOMPARE_t)
683
7d49f689 684PERLVARI(Icheckav_save, AV*, NULL) /* save CHECK{}s when compiling */
3c10abe3 685PERLVARI(Iunitcheckav_save, AV*, NULL) /* save UNITCHECK{}s when compiling */
ece599bd 686
5311654c
JH
687PERLVARI(Iclocktick, long, 0) /* this many times() ticks in a second */
688
9f7da6d5
NC
689PERLVAR(Istashcache, HV *) /* Cache to speed up S_method_common */
690
15a5279a 691/* Hooks to shared SVs and locks. */
ef69c8fc
BM
692PERLVARI(Isharehook, share_proc_t, Perl_sv_nosharing)
693PERLVARI(Ilockhook, share_proc_t, Perl_sv_nosharing)
d0647d4e
NC
694#ifdef NO_MATHOMS
695# define PERL_UNLOCK_HOOK Perl_sv_nosharing
696#else
697/* This reference ensures that the mathoms are linked with perl */
698# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
699#endif
ef69c8fc 700PERLVARI(Iunlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 701
ef69c8fc 702PERLVARI(Ithreadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 703
9e08d3a4
NC
704/* Can shared object be destroyed */
705PERLVARI(Idestroyhook, destroyable_proc_t, Perl_sv_destroyable)
706
01d65469 707#ifndef PERL_MICRO
ef69c8fc 708PERLVARI(Isignalhook, despatch_signals_proc_t, Perl_despatch_signals)
01d65469 709#endif
92f022bb 710
504f80c1
JH
711PERLVARI(Ihash_seed, UV, 0) /* Hash initializer */
712
008fb0c0 713PERLVARI(Irehash_seed, UV, 0) /* 582 hash initializer */
4b5190b5 714
ba6d381e 715PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
f16dd614 716
9e08d3a4
NC
717/* Register of known Method Resolution Orders.
718 What this actually points to is an implementation detail (it may change to
719 a structure incorporating a reference count - use mro_get_from_name to
720 retrieve a C<struct mro_alg *> */
721PERLVAR(Iregistered_mros, HV *)
722
723/* Compile-time block start/end hooks */
724PERLVAR(Iblockhooks, AV *)
725
726/* Everything that folds to a given character, for case insensitivity regex
727 * matching */
728PERLVARI(Iutf8_foldclosures, HV *, NULL)
729
730/* List of characters that participate in folds (except marks, etc in
731 * multi-char folds) */
a25abddc 732PERLVARI(Iutf8_foldable, SV *, NULL)
9e08d3a4
NC
733
734PERLVAR(Icustom_ops, HV *) /* custom op registrations */
735
30b0736d
NC
736PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
737
ffee3ff6
NC
738/* The last unconditional member of the interpreter structure when 5.10.0 was
739 released. The offset of the end of this is baked into a global variable in
740 any shared perl library which will allow a sanity test in future perl
741 releases. */
30b0736d 742#define PERL_LAST_5_16_0_INTERP_MEMBER Ireentrant_retint
ffee3ff6 743
f16dd614 744#ifdef PERL_IMPLICIT_CONTEXT
4c901e72 745PERLVARI(Imy_cxt_size, int, 0) /* size of PL_my_cxt_list */
f16dd614 746PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
ba6d381e 747# ifdef PERL_GLOBAL_STRUCT_PRIVATE
53d44271 748PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
ba6d381e 749# endif
f16dd614
DM
750#endif
751
7cb608b5
NC
752#ifdef PERL_TRACK_MEMPOOL
753/* For use with the memory debugging code in util.c */
754PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
755#endif
756
ba6d381e
NC
757#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
758/* File descriptor to talk to the child which dumps scalars. */
759PERLVARI(Idumper_fd, int, -1)
760#endif
761
762/* Stores the PPID */
763#ifdef THREADS_HAVE_PIDS
764PERLVARI(Ippid, IV, 0)
765#endif
766
767#ifdef PERL_MAD
768PERLVARI(Imadskills, bool, FALSE) /* preserve all syntactic info */
769 /* (MAD = Misc Attribute Decoration) */
770PERLVARI(Ixmlfp, PerlIO *,NULL)
771#endif
772
773#ifdef PL_OP_SLAB_ALLOC
774PERLVAR(IOpPtr,I32 **)
775PERLVARI(IOpSpace,I32,0)
776PERLVAR(IOpSlab,I32 *)
777#endif
778
f1fac472
NC
779#ifdef PERL_DEBUG_READONLY_OPS
780PERLVARI(Islabs, I32**, NULL) /* Array of slabs that have been allocated */
781PERLVARI(Islab_count, U32, 0) /* Size of the array */
782#endif
783
d7a2c63c
MHM
784#ifdef DEBUG_LEAKING_SCALARS
785PERLVARI(Isv_serial, U32, 0) /* SV serial number, used in sv.c */
786#endif
787
157b3822
NC
788/* If you are adding a U8 or U16, check to see if there are 'Space' comments
789 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
790
791/* Within a stable branch, new variables must be added to the very end, before
792 * this comment, for binary compatibility (the offsets of the old members must
793 * not change).
b83cd129 794 * (Don't forget to add your variable also to perl_clone()!)
e3acbfda 795 * XSUB.h provides wrapper functions via perlapi.h that make this
b83cd129
JH
796 * irrelevant, but not all code may be expected to #include XSUB.h.
797 */