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