This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add Shawn M Moore to AUTHORS
[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
158PERLVAR(Iscreamfirst, I32 *)
159PERLVAR(Iscreamnext, I32 *)
160PERLVAR(Ilastscream, SV *)
161
162PERLVAR(Ireg_state, struct re_save_state)
163
164PERLVAR(Iregdummy, regnode) /* from regcomp.c */
165
166PERLVARI(Idumpindent, U16, 4) /* number of blanks per dump
167 indentation level */
168
157b3822
NC
169
170PERLVAR(Iutf8locale, bool) /* utf8 locale detected */
171PERLVARI(Irehash_seed_set, bool, FALSE) /* 582 hash initialized? */
907b3e23
DM
172
173PERLVARA(Icolors,6, char *) /* from regcomp.c */
174
9ea12537
Z
175/*
176=for apidoc Amn|peep_t|PL_peepp
177
178Pointer to the per-subroutine peephole optimiser. This is a function
179that gets called at the end of compilation of a Perl subroutine (or
180equivalently independent piece of Perl code) to perform fixups of
181some ops and to perform small-scale optimisations. The function is
182called once for each subroutine that is compiled, and is passed, as sole
183parameter, a pointer to the op that is the entry point to the subroutine.
184It modifies the op tree in place.
185
186The peephole optimiser should never be completely replaced. Rather,
187add code to it by wrapping the existing optimiser. The basic way to do
188this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
189If the new code wishes to operate on ops throughout the subroutine's
190structure, rather than just at the top level, it is likely to be more
191convenient to wrap the L</PL_rpeepp> hook.
192
193=cut
194*/
195
ef69c8fc 196PERLVARI(Ipeepp, peep_t, Perl_peep)
9ea12537
Z
197
198/*
199=for apidoc Amn|peep_t|PL_rpeepp
200
201Pointer to the recursive peephole optimiser. This is a function
202that gets called at the end of compilation of a Perl subroutine (or
203equivalently independent piece of Perl code) to perform fixups of some
204ops and to perform small-scale optimisations. The function is called
205once for each chain of ops linked through their C<op_next> fields;
206it is recursively called to handle each side chain. It is passed, as
207sole parameter, a pointer to the op that is at the head of the chain.
208It modifies the op tree in place.
209
210The peephole optimiser should never be completely replaced. Rather,
211add code to it by wrapping the existing optimiser. The basic way to do
212this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
213If the new code wishes to operate only on ops at a subroutine's top level,
214rather than throughout the structure, it is likely to be more convenient
215to wrap the L</PL_peepp> hook.
216
217=cut
218*/
219
ef69c8fc 220PERLVARI(Irpeepp, peep_t, Perl_rpeep)
907b3e23 221
2f175318
VP
222/*
223=for apidoc Amn|Perl_ophook_t|PL_opfreehook
224
225When 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.
226This allows extensions to free any extra attribute they have locally attached to an OP.
227It is also assured to first fire for the parent OP and then for its kids.
228
229When 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.
230
231=cut
232*/
233
799dfa8f 234PERLVARI(Iopfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 235
907b3e23
DM
236PERLVARI(Imaxscream, I32, -1)
237PERLVARI(Ireginterp_cnt,I32, 0) /* Whether "Regexp" was interpolated. */
238PERLVARI(Iwatchaddr, char **, 0)
239PERLVAR(Iwatchok, char *)
240
241/* the currently active slab in a chain of slabs of regmatch states,
242 * and the currently active state within that slab */
243
244PERLVARI(Iregmatch_slab, regmatch_slab *, NULL)
245PERLVAR(Iregmatch_state, regmatch_state *)
246
907b3e23 247/* Put anything new that is pointer aligned here. */
d95e864f 248
907b3e23
DM
249PERLVAR(Idelaymagic, U16) /* ($<,$>) = ... */
250PERLVAR(Ilocalizing, U8) /* are we processing a local() list? */
251PERLVAR(Icolorset, bool) /* from regcomp.c */
910e0671 252PERLVAR(Iin_eval, U8) /* trap "fatal" errors? */
907b3e23 253PERLVAR(Itainted, bool) /* using variables controlled by $< */
30b0736d 254PERLVAR(Itainting, bool) /* doing taint checks */
9ebf26ad 255
d95e864f
NC
256/* This value may be set when embedding for full cleanup */
257/* 0=none, 1=full, 2=full with checks */
801627e8
NC
258/* mod_perl is special, and also assigns a meaning -1 */
259PERLVARI(Iperl_destruct_level, signed char, 0)
d95e864f 260
30b0736d
NC
261/* current phase the interpreter is in */
262PERLVARI(Iphase, enum perl_phase, PERL_PHASE_CONSTRUCT)
263
d95e864f
NC
264PERLVAR(Iperldb, U32)
265
30b0736d
NC
266PERLVAR(Isignals, U32) /* Using which pre-5.8 signals */
267
49f531da 268/* pseudo environmental stuff */
d95e864f 269PERLVAR(Iorigargc, int)
cb68f92d
GS
270PERLVAR(Iorigargv, char **)
271PERLVAR(Ienvgv, GV *)
cb68f92d 272PERLVAR(Iincgv, GV *)
b3ac6de7 273PERLVAR(Ihintgv, GV *)
cb68f92d
GS
274PERLVAR(Iorigfilename, char *)
275PERLVAR(Idiehook, SV *)
276PERLVAR(Iwarnhook, SV *)
1d7c1841
GS
277
278/* switches */
a7cb1f99 279PERLVAR(Ipatchlevel, SV *)
1e8125c6 280PERLVAR(Iapiversion, SV *)
27da23d5 281PERLVAR(Ilocalpatches, const char * const *)
dd374669 282PERLVARI(Isplitstr, const char *, " ")
9f7da6d5
NC
283
284PERLVAR(Iminus_c, bool)
cb68f92d
GS
285PERLVAR(Iminus_n, bool)
286PERLVAR(Iminus_p, bool)
287PERLVAR(Iminus_l, bool)
288PERLVAR(Iminus_a, bool)
289PERLVAR(Iminus_F, bool)
290PERLVAR(Idoswitches, bool)
bc9b29db 291PERLVAR(Iminus_E, bool)
954c1994
GS
292
293/*
ccfc67b7 294
2eb25c99 295=for apidoc mn|bool|PL_dowarn
954c1994
GS
296
297The C variable which corresponds to Perl's $^W warning variable.
298
299=cut
300*/
301
d41ff1b8 302PERLVAR(Idowarn, U8)
49f531da 303PERLVAR(Isawampersand, bool) /* must save all match strings */
cb68f92d 304PERLVAR(Iunsafe, bool)
9f7da6d5
NC
305PERLVAR(Iexit_flags, U8) /* was exit() unexpected, etc. */
306PERLVAR(Isrand_called, bool)
4fa7c2bf 307PERLVARI(Iin_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
30b0736d 308 /* Space for a U16 */
cb68f92d
GS
309PERLVAR(Iinplace, char *)
310PERLVAR(Ie_script, SV *)
49f531da
NIS
311
312/* magical thingies */
313PERLVAR(Ibasetime, Time_t) /* $^T */
314PERLVAR(Iformfeed, SV *) /* $^L */
d4cce5f1
NIS
315
316
cb68f92d
GS
317PERLVARI(Imaxsysfd, I32, MAXSYSFD)
318 /* top fd to pass to subprocesses */
49f531da
NIS
319PERLVAR(Istatusvalue, I32) /* $? */
320#ifdef VMS
cb68f92d 321PERLVAR(Istatusvalue_vms,U32)
e5218da5
GA
322#else
323PERLVAR(Istatusvalue_posix,I32)
49f531da
NIS
324#endif
325
157b3822
NC
326PERLVARI(Isig_pending, int,0) /* Number if highest signal pending */
327PERLVAR(Ipsig_pend, int *) /* per-signal "count" of pending */
328
49f531da 329/* shortcuts to various I/O objects */
16d811d4
DM
330PERLVAR(Istdingv, GV *) /* *STDIN */
331PERLVAR(Istderrgv, GV *) /* *STDERR */
cb68f92d 332PERLVAR(Idefgv, GV *)
16d811d4
DM
333PERLVAR(Iargvgv, GV *) /* *ARGV */
334PERLVAR(Iargvoutgv, GV *) /* *ARGVOUT */
1d7c1841 335PERLVAR(Iargvout_stack, AV *)
49f531da
NIS
336
337/* shortcuts to regexp stuff */
16d811d4 338PERLVAR(Ireplgv, GV *) /* *^R */
49f531da
NIS
339
340/* shortcuts to misc objects */
16d811d4 341PERLVAR(Ierrgv, GV *) /* *@ */
49f531da
NIS
342
343/* shortcuts to debugging objects */
16d811d4
DM
344PERLVAR(IDBgv, GV *) /* *DB::DB */
345PERLVAR(IDBline, GV *) /* *DB::line */
954c1994
GS
346
347/*
2eb25c99 348=for apidoc mn|GV *|PL_DBsub
954c1994
GS
349When Perl is run in debugging mode, with the B<-d> switch, this GV contains
350the SV which holds the name of the sub being debugged. This is the C
351variable which corresponds to Perl's $DB::sub variable. See
352C<PL_DBsingle>.
353
2eb25c99 354=for apidoc mn|SV *|PL_DBsingle
954c1994 355When Perl is run in debugging mode, with the B<-d> switch, this SV is a
7889fe52 356boolean which indicates whether subs are being single-stepped.
954c1994
GS
357Single-stepping is automatically turned on after every step. This is the C
358variable which corresponds to Perl's $DB::single variable. See
359C<PL_DBsub>.
360
2eb25c99 361=for apidoc mn|SV *|PL_DBtrace
954c1994
GS
362Trace variable used when Perl is run in debugging mode, with the B<-d>
363switch. This is the C variable which corresponds to Perl's $DB::trace
364variable. See C<PL_DBsingle>.
365
366=cut
367*/
368
16d811d4
DM
369PERLVAR(IDBsub, GV *) /* *DB::sub */
370PERLVAR(IDBsingle, SV *) /* $DB::single */
371PERLVAR(IDBtrace, SV *) /* $DB::trace */
372PERLVAR(IDBsignal, SV *) /* $DB::signal */
49f531da
NIS
373PERLVAR(Idbargs, AV *) /* args to call listed by caller function */
374
375/* symbol tables */
49f531da
NIS
376PERLVAR(Idebstash, HV *) /* symbol table for perldb package */
377PERLVAR(Iglobalstash, HV *) /* global keyword overrides imported here */
378PERLVAR(Icurstname, SV *) /* name of current package */
379PERLVAR(Ibeginav, AV *) /* names of BEGIN subroutines */
d4cce5f1 380PERLVAR(Iendav, AV *) /* names of END subroutines */
3c10abe3 381PERLVAR(Iunitcheckav, AV *) /* names of UNITCHECK subroutines */
7d30b5c4 382PERLVAR(Icheckav, AV *) /* names of CHECK subroutines */
49f531da
NIS
383PERLVAR(Iinitav, AV *) /* names of INIT subroutines */
384PERLVAR(Istrtab, HV *) /* shared string table */
005a453c 385PERLVARI(Isub_generation,U32,1) /* incr to invalidate method cache */
49f531da 386
9f7da6d5
NC
387/* funky return mechanisms */
388PERLVAR(Iforkprocess, int) /* so do_open |- can return proc# */
389
49f531da 390/* memory management */
49f531da
NIS
391PERLVAR(Isv_count, I32) /* how many SV* are currently allocated */
392PERLVAR(Isv_objcount, I32) /* how many objects are currently allocated */
393PERLVAR(Isv_root, SV*) /* storage for SVs belonging to interp */
394PERLVAR(Isv_arenaroot, SV*) /* list of areas for garbage collection */
395
49f531da 396/* subprocess state */
d4cce5f1 397PERLVAR(Ifdpid, AV *) /* keep fd-to-pid mappings for my_popen */
49f531da
NIS
398
399/* internal state */
49f531da
NIS
400PERLVARI(Iop_mask, char *, NULL) /* masked operations for safe evals */
401
49f531da 402/* current interpreter roots */
cb68f92d
GS
403PERLVAR(Imain_cv, CV *)
404PERLVAR(Imain_root, OP *)
405PERLVAR(Imain_start, OP *)
406PERLVAR(Ieval_root, OP *)
407PERLVAR(Ieval_start, OP *)
49f531da
NIS
408
409/* runtime control stuff */
cb68f92d 410PERLVARI(Icurcopdb, COP *, NULL)
49f531da 411
49f531da
NIS
412PERLVAR(Ifilemode, int) /* so nextargv() can preserve mode */
413PERLVAR(Ilastfd, int) /* what to preserve mode on */
414PERLVAR(Ioldname, char *) /* what to preserve mode on */
360ea906 415PERLVAR(IArgv, const char **) /* stuff to free from do_aexec, vfork safe */
d4cce5f1 416PERLVAR(ICmd, char *) /* stuff to free from do_aexec, vfork safe */
00accf8d
NC
417/* Elements in this array have ';' appended and are injected as a single line
418 into the tokeniser. You can't put any (literal) newlines into any program
419 you stuff in into this array, as the point where it's injected is expecting
420 a single physical line. */
cb68f92d 421PERLVAR(Ipreambleav, AV *)
cb68f92d 422PERLVAR(Imess_sv, SV *)
7889fe52 423PERLVAR(Iors_sv, SV *) /* output record separator $\ */
71eebe1e
NC
424/* statics moved here for shared library purposes */
425PERLVARI(Igensym, I32, 0) /* next symbol for getsym() to define */
a4021b77 426PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
157b3822 427PERLVAR(Itaint_warn, bool) /* taint warns instead of dying */
d95e864f
NC
428PERLVARI(Ilaststype, U16, OP_STAT)
429PERLVARI(Ilaststatval, int, -1)
d4cce5f1 430
4b556e6c 431/* interpreter atexit processing */
d95e864f 432PERLVARI(Iexitlistlen, I32, 0) /* length of same */
cb68f92d
GS
433PERLVARI(Iexitlist, PerlExitListEntry *, NULL)
434 /* list of exit functions */
954c1994
GS
435
436/*
437=for apidoc Amn|HV*|PL_modglobal
438
7889fe52 439C<PL_modglobal> is a general purpose, interpreter global HV for use by
954c1994 440extensions that need to keep information on a per-interpreter basis.
7889fe52
NIS
441In a pinch, it can also be used as a symbol table for extensions
442to share data among each other. It is a good idea to use keys
954c1994
GS
443prefixed by the package name of the extension that owns the data.
444
445=cut
446*/
447
cb68f92d
GS
448PERLVAR(Imodglobal, HV *) /* per-interp module data */
449
450/* these used to be in global before 5.004_68 */
451PERLVARI(Iprofiledata, U32 *, NULL) /* table of ops, counts */
cb68f92d
GS
452
453PERLVAR(Icompiling, COP) /* compiling/done executing marker */
454
455PERLVAR(Icompcv, CV *) /* currently compiling subroutine */
456PERLVAR(Icomppad, AV *) /* storage for lexically scoped temporaries */
457PERLVAR(Icomppad_name, AV *) /* variable names for "my" variables */
458PERLVAR(Icomppad_name_fill, I32) /* last "introduced" variable offset */
459PERLVAR(Icomppad_name_floor, I32) /* start of vars in innermost block */
4b556e6c
JD
460
461#ifdef HAVE_INTERP_INTERN
cb68f92d
GS
462PERLVAR(Isys_intern, struct interp_intern)
463 /* platform internals */
4b556e6c
JD
464#endif
465
7fae4e64 466/* more statics moved here */
7fae4e64 467PERLVAR(IDBcv, CV *) /* from perl.c */
9f7da6d5 468PERLVARI(Igeneration, int, 100) /* from op.c */
56953603 469
cb68f92d 470PERLVARI(Iin_clean_objs,bool, FALSE) /* from sv.c */
57ef47cc 471PERLVARI(Iin_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
9f7da6d5
NC
472PERLVAR(Inomemok, bool) /* let malloc context handle nomem */
473PERLVARI(Isavebegin, bool, FALSE) /* save BEGINs for compiler */
7fae4e64 474
d8eceb89
JH
475PERLVAR(Iuid, Uid_t) /* current real user id */
476PERLVAR(Ieuid, Uid_t) /* current effective user id */
477PERLVAR(Igid, Gid_t) /* current real group id */
478PERLVAR(Iegid, Gid_t) /* current effective group id */
bf9cdc68 479PERLVARI(Ian, U32, 0) /* malloc sequence number */
be2b6a89
DM
480
481#ifdef DEBUGGING
482 /* exercise wrap-around */
483 #define PERL_COP_SEQMAX (U32_MAX-50)
484#else
485 #define PERL_COP_SEQMAX 0
486#endif
487PERLVARI(Icop_seqmax, U32, PERL_COP_SEQMAX) /* statement sequence number */
488#undef PERL_COP_SEQMAX
489
bf9cdc68 490PERLVARI(Ievalseq, U32, 0) /* eval sequence number */
0672f40e 491PERLVAR(Iorigalen, U32)
9f7da6d5 492PERLVAR(Iorigenviron, char **)
ca0c25f6 493#ifdef PERL_USES_PL_PIDSTATUS
0672f40e 494PERLVAR(Ipidstatus, HV *) /* pid-to-status mappings for waitpid */
ca0c25f6 495#endif
0672f40e 496PERLVAR(Iosname, char *) /* operating system */
5c728af0 497
0672f40e
GS
498PERLVAR(Isighandlerp, Sighandler_t)
499
232d1c15 500PERLVARA(Ibody_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
93e68bfb 501
ed29bbba 502PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
0672f40e 503
9f7da6d5
NC
504PERLVARI(Imaxo, int, MAXO) /* maximum number of ops */
505
ef69c8fc 506PERLVARI(Irunops, runops_proc_t, RUNOPS_DEFAULT)
0672f40e 507
954c1994
GS
508/*
509=for apidoc Amn|SV|PL_sv_undef
510This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
511
512=for apidoc Amn|SV|PL_sv_no
513This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
514C<&PL_sv_no>.
515
516=for apidoc Amn|SV|PL_sv_yes
517This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
518C<&PL_sv_yes>.
519
520=cut
521*/
522
0672f40e
GS
523PERLVAR(Isv_undef, SV)
524PERLVAR(Isv_no, SV)
525PERLVAR(Isv_yes, SV)
526
0672f40e
GS
527PERLVAR(Isubname, SV *) /* name of current subroutine */
528
d95e864f 529PERLVAR(Isubline, I32) /* line this subroutine began on */
0672f40e 530PERLVAR(Imin_intro_pending, I32) /* start of vars to introduce */
d95e864f 531
0672f40e
GS
532PERLVAR(Imax_intro_pending, I32) /* end of vars to introduce */
533PERLVAR(Ipadix, I32) /* max used index in current "register" pad */
d95e864f 534
0672f40e 535PERLVAR(Ipadix_floor, I32) /* how low may inner block reset padix */
0672f40e 536
1d7c1841 537PERLVAR(Ihints, U32) /* pragma-tic compile-time flags */
0672f40e
GS
538
539PERLVAR(Idebug, VOL U32) /* flags given to -D switch */
540
f0cb02e3
NC
541/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
542PERLVARI(Ibreakable_sub_gen, U32, 0)
543
bf9cdc68 544PERLVARI(Iamagic_generation, long, 0)
0672f40e
GS
545
546#ifdef USE_LOCALE_COLLATE
0672f40e 547PERLVAR(Icollation_name,char *) /* Name of current collation */
0672f40e
GS
548PERLVAR(Icollxfrm_base, Size_t) /* Basic overhead in *xfrm() */
549PERLVARI(Icollxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
9f7da6d5
NC
550PERLVARI(Icollation_ix, U32, 0) /* Collation generation index */
551PERLVARI(Icollation_standard, bool, TRUE)
552 /* Assume simple collation */
0672f40e
GS
553#endif /* USE_LOCALE_COLLATE */
554
9f7da6d5 555
edd11d75 556#if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
95ca8690 557# define PERL___I -1
9f7da6d5 558#else
7cd91da4 559# define PERL___I 1
9f7da6d5 560#endif
95ca8690
DM
561PERLVARI(Iutf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
562#undef PERL___I
563
9f7da6d5 564
0672f40e
GS
565#ifdef USE_LOCALE_NUMERIC
566
0672f40e
GS
567PERLVARI(Inumeric_standard, bool, TRUE)
568 /* Assume simple numerics */
569PERLVARI(Inumeric_local, bool, TRUE)
570 /* Assume local numerics */
9f7da6d5 571PERLVAR(Inumeric_name, char *) /* Name of current numeric locale */
0672f40e
GS
572#endif /* !USE_LOCALE_NUMERIC */
573
574/* utf8 character classes */
575PERLVAR(Iutf8_alnum, SV *)
b8c5462f 576PERLVAR(Iutf8_ascii, SV *)
0672f40e
GS
577PERLVAR(Iutf8_alpha, SV *)
578PERLVAR(Iutf8_space, SV *)
d1eb3177
YO
579PERLVAR(Iutf8_perl_space, SV *)
580PERLVAR(Iutf8_perl_word, SV *)
581PERLVAR(Iutf8_posix_digit, SV *)
b8c5462f
JH
582PERLVAR(Iutf8_cntrl, SV *)
583PERLVAR(Iutf8_graph, SV *)
0672f40e
GS
584PERLVAR(Iutf8_digit, SV *)
585PERLVAR(Iutf8_upper, SV *)
586PERLVAR(Iutf8_lower, SV *)
587PERLVAR(Iutf8_print, SV *)
b8c5462f
JH
588PERLVAR(Iutf8_punct, SV *)
589PERLVAR(Iutf8_xdigit, SV *)
0672f40e 590PERLVAR(Iutf8_mark, SV *)
37e2e78e
KW
591PERLVAR(Iutf8_X_begin, SV *)
592PERLVAR(Iutf8_X_extend, SV *)
593PERLVAR(Iutf8_X_prepend, SV *)
594PERLVAR(Iutf8_X_non_hangul, SV *)
595PERLVAR(Iutf8_X_L, SV *)
596PERLVAR(Iutf8_X_LV, SV *)
597PERLVAR(Iutf8_X_LVT, SV *)
598PERLVAR(Iutf8_X_T, SV *)
599PERLVAR(Iutf8_X_V, SV *)
600PERLVAR(Iutf8_X_LV_LVT_V, SV *)
0672f40e
GS
601PERLVAR(Iutf8_toupper, SV *)
602PERLVAR(Iutf8_totitle, SV *)
603PERLVAR(Iutf8_tolower, SV *)
b4e400f9 604PERLVAR(Iutf8_tofold, SV *)
0672f40e 605PERLVAR(Ilast_swash_hv, HV *)
0672f40e
GS
606PERLVAR(Ilast_swash_tmps, U8 *)
607PERLVAR(Ilast_swash_slen, STRLEN)
9f7da6d5 608PERLVARA(Ilast_swash_key,10, U8)
d95e864f
NC
609PERLVAR(Ilast_swash_klen, U8) /* Only needs to store 0-10 */
610
611#ifdef FCRYPT
612PERLVARI(Icryptseen, bool, FALSE) /* has fast crypt() been initialized? */
613#endif
614
f0cb02e3 615PERLVAR(Ipad_reset_pending, bool) /* reset pad on next attempted alloc */
49947b44 616
d95e864f
NC
617PERLVARI(Iglob_index, int, 0)
618
0672f40e 619
5912531f 620PERLVAR(Iparser, yy_parser *) /* current parser state */
12fbd33b 621
c4a30c8c
NC
622/* Array of signal handlers, indexed by signal number, through which the C
623 signal handler dispatches. */
1d7c1841 624PERLVAR(Ipsig_ptr, SV**)
c4a30c8c 625/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
626 argument to a signal handler. Only one block of memory is allocated for
627 both psig_name and psig_ptr. */
c4a30c8c 628PERLVAR(Ipsig_name, SV**)
1d7c1841 629
c5be433b 630#if defined(PERL_IMPLICIT_SYS)
32e30700 631PERLVAR(IMem, struct IPerlMem*)
1d7c1841
GS
632PERLVAR(IMemShared, struct IPerlMem*)
633PERLVAR(IMemParse, struct IPerlMem*)
32e30700
GS
634PERLVAR(IEnv, struct IPerlEnv*)
635PERLVAR(IStdIO, struct IPerlStdIO*)
636PERLVAR(ILIO, struct IPerlLIO*)
637PERLVAR(IDir, struct IPerlDir*)
638PERLVAR(ISock, struct IPerlSock*)
639PERLVAR(IProc, struct IPerlProc*)
76e3520e 640#endif
1d7c1841 641
1d7c1841 642PERLVAR(Iptr_table, PTR_TBL_t*)
7d49f689 643PERLVARI(Ibeginav_save, AV*, NULL) /* save BEGIN{}s when compiling */
f180df80 644
fdda85ca 645PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
93e68bfb 646
d95e864f 647
a453c169
JH
648#ifdef USE_LOCALE_NUMERIC
649
650PERLVAR(Inumeric_radix_sv, SV *) /* The radix separator if not '.' */
651
652#endif
ce08f86c 653
1fcf4c12 654#if defined(USE_ITHREADS)
e6853197
NC
655PERLVAR(Iregex_pad, SV**) /* Shortcut into the array of
656 regex_padav */
657PERLVAR(Iregex_padav, AV*) /* All regex objects, indexed via the
658 values in op_pmoffset of pmop.
402d2eb1
NC
659 Entry 0 is an SV whose PV is a
660 "packed" list of IVs listing
e6853197 661 the now-free slots in the array */
1fcf4c12
AB
662#endif
663
ea68fd67
NC
664#ifdef USE_REENTRANT_API
665PERLVAR(Ireentrant_buffer, REENTR*) /* here we store the _r buffers */
f5a82810
JH
666#endif
667
53e06cf0
SC
668PERLVAR(Icustom_op_names, HV*) /* Names of user defined ops */
669PERLVAR(Icustom_op_descs, HV*) /* Descriptions of user defined ops */
19e8ce8e 670
a1ea730d 671#ifdef PERLIO_LAYERS
303f2dc3 672PERLVARI(Iperlio, PerlIOl *,NULL)
3a1ee7e8
NIS
673PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
674PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
a1ea730d
NIS
675#endif
676
a0714e2c 677PERLVARI(Iencoding, SV*, NULL) /* character encoding */
0a378802 678
128e8167 679PERLVAR(Idebug_pad, struct perl_debug_pad) /* always needed because of the re extension */
ce333219 680
82686b01
JH
681PERLVAR(Iutf8_idstart, SV *)
682PERLVAR(Iutf8_idcont, SV *)
c11ff943
KW
683PERLVAR(Iutf8_xidstart, SV *)
684PERLVAR(Iutf8_xidcont, SV *)
82686b01 685
147f47de
AB
686PERLVAR(Isort_RealCmp, SVCOMPARE_t)
687
7d49f689 688PERLVARI(Icheckav_save, AV*, NULL) /* save CHECK{}s when compiling */
3c10abe3 689PERLVARI(Iunitcheckav_save, AV*, NULL) /* save UNITCHECK{}s when compiling */
ece599bd 690
5311654c
JH
691PERLVARI(Iclocktick, long, 0) /* this many times() ticks in a second */
692
9f7da6d5
NC
693PERLVAR(Istashcache, HV *) /* Cache to speed up S_method_common */
694
15a5279a 695/* Hooks to shared SVs and locks. */
ef69c8fc
BM
696PERLVARI(Isharehook, share_proc_t, Perl_sv_nosharing)
697PERLVARI(Ilockhook, share_proc_t, Perl_sv_nosharing)
d0647d4e
NC
698#ifdef NO_MATHOMS
699# define PERL_UNLOCK_HOOK Perl_sv_nosharing
700#else
701/* This reference ensures that the mathoms are linked with perl */
702# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
703#endif
ef69c8fc 704PERLVARI(Iunlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 705
ef69c8fc 706PERLVARI(Ithreadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 707
9e08d3a4
NC
708/* Can shared object be destroyed */
709PERLVARI(Idestroyhook, destroyable_proc_t, Perl_sv_destroyable)
710
01d65469 711#ifndef PERL_MICRO
ef69c8fc 712PERLVARI(Isignalhook, despatch_signals_proc_t, Perl_despatch_signals)
01d65469 713#endif
92f022bb 714
504f80c1
JH
715PERLVARI(Ihash_seed, UV, 0) /* Hash initializer */
716
008fb0c0 717PERLVARI(Irehash_seed, UV, 0) /* 582 hash initializer */
4b5190b5 718
ba6d381e 719PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
f16dd614 720
9e08d3a4
NC
721/* Register of known Method Resolution Orders.
722 What this actually points to is an implementation detail (it may change to
723 a structure incorporating a reference count - use mro_get_from_name to
724 retrieve a C<struct mro_alg *> */
725PERLVAR(Iregistered_mros, HV *)
726
727/* Compile-time block start/end hooks */
728PERLVAR(Iblockhooks, AV *)
729
730/* Everything that folds to a given character, for case insensitivity regex
731 * matching */
732PERLVARI(Iutf8_foldclosures, HV *, NULL)
733
734/* List of characters that participate in folds (except marks, etc in
735 * multi-char folds) */
736PERLVARI(Iutf8_foldable, HV *, NULL)
737
738PERLVAR(Icustom_ops, HV *) /* custom op registrations */
739
30b0736d
NC
740PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
741
ffee3ff6
NC
742/* The last unconditional member of the interpreter structure when 5.10.0 was
743 released. The offset of the end of this is baked into a global variable in
744 any shared perl library which will allow a sanity test in future perl
745 releases. */
30b0736d 746#define PERL_LAST_5_16_0_INTERP_MEMBER Ireentrant_retint
ffee3ff6 747
f16dd614 748#ifdef PERL_IMPLICIT_CONTEXT
4c901e72 749PERLVARI(Imy_cxt_size, int, 0) /* size of PL_my_cxt_list */
f16dd614 750PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
ba6d381e 751# ifdef PERL_GLOBAL_STRUCT_PRIVATE
53d44271 752PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
ba6d381e 753# endif
f16dd614
DM
754#endif
755
7cb608b5
NC
756#ifdef PERL_TRACK_MEMPOOL
757/* For use with the memory debugging code in util.c */
758PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
759#endif
760
ba6d381e
NC
761#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
762/* File descriptor to talk to the child which dumps scalars. */
763PERLVARI(Idumper_fd, int, -1)
764#endif
765
766/* Stores the PPID */
767#ifdef THREADS_HAVE_PIDS
768PERLVARI(Ippid, IV, 0)
769#endif
770
771#ifdef PERL_MAD
772PERLVARI(Imadskills, bool, FALSE) /* preserve all syntactic info */
773 /* (MAD = Misc Attribute Decoration) */
774PERLVARI(Ixmlfp, PerlIO *,NULL)
775#endif
776
777#ifdef PL_OP_SLAB_ALLOC
778PERLVAR(IOpPtr,I32 **)
779PERLVARI(IOpSpace,I32,0)
780PERLVAR(IOpSlab,I32 *)
781#endif
782
f1fac472
NC
783#ifdef PERL_DEBUG_READONLY_OPS
784PERLVARI(Islabs, I32**, NULL) /* Array of slabs that have been allocated */
785PERLVARI(Islab_count, U32, 0) /* Size of the array */
786#endif
787
d7a2c63c
MHM
788#ifdef DEBUG_LEAKING_SCALARS
789PERLVARI(Isv_serial, U32, 0) /* SV serial number, used in sv.c */
790#endif
791
157b3822
NC
792/* If you are adding a U8 or U16, check to see if there are 'Space' comments
793 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
794
795/* Within a stable branch, new variables must be added to the very end, before
796 * this comment, for binary compatibility (the offsets of the old members must
797 * not change).
b83cd129 798 * (Don't forget to add your variable also to perl_clone()!)
e3acbfda 799 * XSUB.h provides wrapper functions via perlapi.h that make this
b83cd129
JH
800 * irrelevant, but not all code may be expected to #include XSUB.h.
801 */