This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
intrpvar.h: Clarify comment
[perl5.git] / intrpvar.h
CommitLineData
907b3e23
DM
1/* intrpvar.h
2 *
3 * Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
1129b882 4 * 2006, 2007, 2008 by Larry Wall and others
907b3e23
DM
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
9 */
10
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
28 * to generate the appropriate export list for win32.
29 *
907b3e23
DM
30 * When building without MULTIPLICITY, these variables will be truly global.
31 *
32 * Important ones in the first cache line (if alignment is done right) */
33
34PERLVAR(Istack_sp, SV **) /* top of the stack */
35#ifdef OP_IN_REGISTER
36PERLVAR(Iopsave, OP *)
37#else
38PERLVAR(Iop, OP *) /* currently executing op */
39#endif
40PERLVAR(Icurpad, SV **) /* active pad (lexicals+tmps) */
41
42PERLVAR(Istack_base, SV **)
43PERLVAR(Istack_max, SV **)
44
45PERLVAR(Iscopestack, I32 *) /* scopes we've ENTERed */
f2b88940
NC
46/* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
47 present always, as -DDEUBGGING must be binary compatible with non. */
48PERLVARI(Iscopestack_name, const char * *, NULL)
907b3e23
DM
49PERLVAR(Iscopestack_ix, I32)
50PERLVAR(Iscopestack_max,I32)
51
52PERLVAR(Isavestack, ANY *) /* items that need to be restored when
53 LEAVEing scopes we've ENTERed */
54PERLVAR(Isavestack_ix, I32)
55PERLVAR(Isavestack_max, I32)
56
57PERLVAR(Itmps_stack, SV **) /* mortals we've made */
58PERLVARI(Itmps_ix, I32, -1)
59PERLVARI(Itmps_floor, I32, -1)
60PERLVAR(Itmps_max, I32)
3ad73efd 61PERLVAR(Imodcount, I32) /* how much op_lvalue()ification in
907b3e23
DM
62 assignment? */
63
64PERLVAR(Imarkstack, I32 *) /* stack_sp locations we're
65 remembering */
66PERLVAR(Imarkstack_ptr, I32 *)
67PERLVAR(Imarkstack_max, I32 *)
68
69PERLVAR(ISv, SV *) /* used to hold temporary values */
70PERLVAR(IXpv, XPV *) /* used to hold temporary values */
71
72/*
73=for apidoc Amn|STRLEN|PL_na
74
75A convenience variable which is typically used with C<SvPV> when one
76doesn't care about the length of the string. It is usually more efficient
77to either declare a local variable and use that instead or to use the
78C<SvPV_nolen> macro.
79
80=cut
81*/
82
83PERLVAR(Ina, STRLEN) /* for use in SvPV when length is
84 Not Applicable */
85
86/* stat stuff */
87PERLVAR(Istatbuf, Stat_t)
88PERLVAR(Istatcache, Stat_t) /* _ */
89PERLVAR(Istatgv, GV *)
90PERLVARI(Istatname, SV *, NULL)
91
92#ifdef HAS_TIMES
93PERLVAR(Itimesbuf, struct tms)
94#endif
95
96/* Fields used by magic variables such as $@, $/ and so on */
97PERLVAR(Icurpm, PMOP *) /* what to do \ interps in REs from */
98
99/*
100=for apidoc mn|SV*|PL_rs
101
102The input record separator - C<$/> in Perl space.
103
104=for apidoc mn|GV*|PL_last_in_gv
105
106The GV which was last used for a filehandle input operation. (C<< <FH> >>)
107
e23d9e2f 108=for apidoc mn|GV*|PL_ofsgv
907b3e23 109
e23d9e2f 110The glob containing the output field separator - C<*,> in Perl space.
907b3e23
DM
111
112=cut
113*/
114
115PERLVAR(Irs, SV *) /* input record separator $/ */
116PERLVAR(Ilast_in_gv, GV *) /* GV used in last <FH> */
e23d9e2f 117PERLVAR(Iofsgv, GV *) /* GV of output field separator *, */
907b3e23
DM
118PERLVAR(Idefoutgv, GV *) /* default FH for output */
119PERLVARI(Ichopset, const char *, " \n-") /* $: */
120PERLVAR(Iformtarget, SV *)
121PERLVAR(Ibodytarget, SV *)
122PERLVAR(Itoptarget, SV *)
123
124/* Stashes */
125PERLVAR(Idefstash, HV *) /* main symbol table */
126PERLVAR(Icurstash, HV *) /* symbol table for current package */
127
128PERLVAR(Irestartop, OP *) /* propagating an error from croak? */
febb3a6d 129PERLVAR(Irestartjmpenv, JMPENV *) /* target frame for longjmp in die */
910e0671 130PERLVAR(Icurcop, COP *)
907b3e23
DM
131PERLVAR(Icurstack, AV *) /* THE STACK */
132PERLVAR(Icurstackinfo, PERL_SI *) /* current stack + context */
133PERLVAR(Imainstack, AV *) /* the stack when nothing funny is
134 happening */
135
136PERLVAR(Itop_env, JMPENV *) /* ptr to current sigjmp environment */
137PERLVAR(Istart_env, JMPENV) /* empty startup sigjmp environment */
138PERLVARI(Ierrors, SV *, NULL) /* outstanding queued errors */
139
140/* statics "owned" by various functions */
907b3e23
DM
141PERLVAR(Ihv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
142
907b3e23
DM
143PERLVAR(Ilastgotoprobe, OP*) /* from pp_ctl.c */
144
145/* sort stuff */
146PERLVAR(Isortcop, OP *) /* user defined sort routine */
147PERLVAR(Isortstash, HV *) /* which is in some package or other */
148PERLVAR(Ifirstgv, GV *) /* $a */
149PERLVAR(Isecondgv, GV *) /* $b */
150
151/* float buffer */
152PERLVAR(Iefloatbuf, char *)
153PERLVAR(Iefloatsize, STRLEN)
154
155/* regex stuff */
156
157PERLVAR(Iscreamfirst, I32 *)
158PERLVAR(Iscreamnext, I32 *)
159PERLVAR(Ilastscream, SV *)
160
161PERLVAR(Ireg_state, struct re_save_state)
162
163PERLVAR(Iregdummy, regnode) /* from regcomp.c */
164
165PERLVARI(Idumpindent, U16, 4) /* number of blanks per dump
166 indentation level */
167
157b3822
NC
168
169PERLVAR(Iutf8locale, bool) /* utf8 locale detected */
170PERLVARI(Irehash_seed_set, bool, FALSE) /* 582 hash initialized? */
907b3e23
DM
171
172PERLVARA(Icolors,6, char *) /* from regcomp.c */
173
9ea12537
Z
174/*
175=for apidoc Amn|peep_t|PL_peepp
176
177Pointer to the per-subroutine peephole optimiser. This is a function
178that gets called at the end of compilation of a Perl subroutine (or
179equivalently independent piece of Perl code) to perform fixups of
180some ops and to perform small-scale optimisations. The function is
181called once for each subroutine that is compiled, and is passed, as sole
182parameter, a pointer to the op that is the entry point to the subroutine.
183It modifies the op tree in place.
184
185The peephole optimiser should never be completely replaced. Rather,
186add code to it by wrapping the existing optimiser. The basic way to do
187this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
188If the new code wishes to operate on ops throughout the subroutine's
189structure, rather than just at the top level, it is likely to be more
190convenient to wrap the L</PL_rpeepp> hook.
191
192=cut
193*/
194
ef69c8fc 195PERLVARI(Ipeepp, peep_t, Perl_peep)
9ea12537
Z
196
197/*
198=for apidoc Amn|peep_t|PL_rpeepp
199
200Pointer to the recursive peephole optimiser. This is a function
201that gets called at the end of compilation of a Perl subroutine (or
202equivalently independent piece of Perl code) to perform fixups of some
203ops and to perform small-scale optimisations. The function is called
204once for each chain of ops linked through their C<op_next> fields;
205it is recursively called to handle each side chain. It is passed, as
206sole parameter, a pointer to the op that is at the head of the chain.
207It modifies the op tree in place.
208
209The peephole optimiser should never be completely replaced. Rather,
210add code to it by wrapping the existing optimiser. The basic way to do
211this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
212If the new code wishes to operate only on ops at a subroutine's top level,
213rather than throughout the structure, it is likely to be more convenient
214to wrap the L</PL_peepp> hook.
215
216=cut
217*/
218
ef69c8fc 219PERLVARI(Irpeepp, peep_t, Perl_rpeep)
907b3e23 220
2f175318
VP
221/*
222=for apidoc Amn|Perl_ophook_t|PL_opfreehook
223
224When 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.
225This allows extensions to free any extra attribute they have locally attached to an OP.
226It is also assured to first fire for the parent OP and then for its kids.
227
228When 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.
229
230=cut
231*/
232
799dfa8f 233PERLVARI(Iopfreehook, Perl_ophook_t, 0) /* op_free() hook */
f37b8c3f 234
907b3e23
DM
235PERLVARI(Imaxscream, I32, -1)
236PERLVARI(Ireginterp_cnt,I32, 0) /* Whether "Regexp" was interpolated. */
237PERLVARI(Iwatchaddr, char **, 0)
238PERLVAR(Iwatchok, char *)
239
240/* the currently active slab in a chain of slabs of regmatch states,
241 * and the currently active state within that slab */
242
243PERLVARI(Iregmatch_slab, regmatch_slab *, NULL)
244PERLVAR(Iregmatch_state, regmatch_state *)
245
907b3e23 246/* Put anything new that is pointer aligned here. */
d95e864f 247
907b3e23
DM
248PERLVAR(Idelaymagic, U16) /* ($<,$>) = ... */
249PERLVAR(Ilocalizing, U8) /* are we processing a local() list? */
250PERLVAR(Icolorset, bool) /* from regcomp.c */
910e0671 251PERLVAR(Iin_eval, U8) /* trap "fatal" errors? */
907b3e23 252PERLVAR(Itainted, bool) /* using variables controlled by $< */
d95e864f 253
9ebf26ad
FR
254/* current phase the interpreter is in */
255PERLVARI(Iphase, enum perl_phase, PERL_PHASE_CONSTRUCT)
256
d95e864f
NC
257/* This value may be set when embedding for full cleanup */
258/* 0=none, 1=full, 2=full with checks */
801627e8
NC
259/* mod_perl is special, and also assigns a meaning -1 */
260PERLVARI(Iperl_destruct_level, signed char, 0)
d95e864f
NC
261
262PERLVAR(Iperldb, U32)
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)
07455d8f 299 /* Space for a U8 */
49f531da 300PERLVAR(Isawampersand, bool) /* must save all match strings */
cb68f92d 301PERLVAR(Iunsafe, bool)
9f7da6d5
NC
302PERLVAR(Iexit_flags, U8) /* was exit() unexpected, etc. */
303PERLVAR(Isrand_called, bool)
304/* Part of internal state, but makes the 16th 1 byte variable in a row. */
305PERLVAR(Itainting, bool) /* doing taint checks */
4fa7c2bf 306PERLVARI(Iin_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
cb68f92d
GS
307PERLVAR(Iinplace, char *)
308PERLVAR(Ie_script, SV *)
49f531da
NIS
309
310/* magical thingies */
311PERLVAR(Ibasetime, Time_t) /* $^T */
312PERLVAR(Iformfeed, SV *) /* $^L */
d4cce5f1
NIS
313
314
cb68f92d
GS
315PERLVARI(Imaxsysfd, I32, MAXSYSFD)
316 /* top fd to pass to subprocesses */
49f531da
NIS
317PERLVAR(Istatusvalue, I32) /* $? */
318#ifdef VMS
cb68f92d 319PERLVAR(Istatusvalue_vms,U32)
e5218da5
GA
320#else
321PERLVAR(Istatusvalue_posix,I32)
49f531da
NIS
322#endif
323
157b3822
NC
324PERLVARI(Isig_pending, int,0) /* Number if highest signal pending */
325PERLVAR(Ipsig_pend, int *) /* per-signal "count" of pending */
326
49f531da 327/* shortcuts to various I/O objects */
16d811d4
DM
328PERLVAR(Istdingv, GV *) /* *STDIN */
329PERLVAR(Istderrgv, GV *) /* *STDERR */
cb68f92d 330PERLVAR(Idefgv, GV *)
16d811d4
DM
331PERLVAR(Iargvgv, GV *) /* *ARGV */
332PERLVAR(Iargvoutgv, GV *) /* *ARGVOUT */
1d7c1841 333PERLVAR(Iargvout_stack, AV *)
49f531da
NIS
334
335/* shortcuts to regexp stuff */
16d811d4 336PERLVAR(Ireplgv, GV *) /* *^R */
49f531da
NIS
337
338/* shortcuts to misc objects */
16d811d4 339PERLVAR(Ierrgv, GV *) /* *@ */
49f531da
NIS
340
341/* shortcuts to debugging objects */
16d811d4
DM
342PERLVAR(IDBgv, GV *) /* *DB::DB */
343PERLVAR(IDBline, GV *) /* *DB::line */
954c1994
GS
344
345/*
2eb25c99 346=for apidoc mn|GV *|PL_DBsub
954c1994
GS
347When Perl is run in debugging mode, with the B<-d> switch, this GV contains
348the SV which holds the name of the sub being debugged. This is the C
349variable which corresponds to Perl's $DB::sub variable. See
350C<PL_DBsingle>.
351
2eb25c99 352=for apidoc mn|SV *|PL_DBsingle
954c1994 353When Perl is run in debugging mode, with the B<-d> switch, this SV is a
7889fe52 354boolean which indicates whether subs are being single-stepped.
954c1994
GS
355Single-stepping is automatically turned on after every step. This is the C
356variable which corresponds to Perl's $DB::single variable. See
357C<PL_DBsub>.
358
2eb25c99 359=for apidoc mn|SV *|PL_DBtrace
954c1994
GS
360Trace variable used when Perl is run in debugging mode, with the B<-d>
361switch. This is the C variable which corresponds to Perl's $DB::trace
362variable. See C<PL_DBsingle>.
363
364=cut
365*/
366
16d811d4
DM
367PERLVAR(IDBsub, GV *) /* *DB::sub */
368PERLVAR(IDBsingle, SV *) /* $DB::single */
369PERLVAR(IDBtrace, SV *) /* $DB::trace */
370PERLVAR(IDBsignal, SV *) /* $DB::signal */
49f531da
NIS
371PERLVAR(Idbargs, AV *) /* args to call listed by caller function */
372
373/* symbol tables */
49f531da
NIS
374PERLVAR(Idebstash, HV *) /* symbol table for perldb package */
375PERLVAR(Iglobalstash, HV *) /* global keyword overrides imported here */
376PERLVAR(Icurstname, SV *) /* name of current package */
377PERLVAR(Ibeginav, AV *) /* names of BEGIN subroutines */
d4cce5f1 378PERLVAR(Iendav, AV *) /* names of END subroutines */
3c10abe3 379PERLVAR(Iunitcheckav, AV *) /* names of UNITCHECK subroutines */
7d30b5c4 380PERLVAR(Icheckav, AV *) /* names of CHECK subroutines */
49f531da
NIS
381PERLVAR(Iinitav, AV *) /* names of INIT subroutines */
382PERLVAR(Istrtab, HV *) /* shared string table */
005a453c 383PERLVARI(Isub_generation,U32,1) /* incr to invalidate method cache */
49f531da 384
9f7da6d5
NC
385/* funky return mechanisms */
386PERLVAR(Iforkprocess, int) /* so do_open |- can return proc# */
387
49f531da 388/* memory management */
49f531da
NIS
389PERLVAR(Isv_count, I32) /* how many SV* are currently allocated */
390PERLVAR(Isv_objcount, I32) /* how many objects are currently allocated */
391PERLVAR(Isv_root, SV*) /* storage for SVs belonging to interp */
392PERLVAR(Isv_arenaroot, SV*) /* list of areas for garbage collection */
393
49f531da 394/* subprocess state */
d4cce5f1 395PERLVAR(Ifdpid, AV *) /* keep fd-to-pid mappings for my_popen */
49f531da
NIS
396
397/* internal state */
49f531da
NIS
398PERLVARI(Iop_mask, char *, NULL) /* masked operations for safe evals */
399
49f531da 400/* current interpreter roots */
cb68f92d
GS
401PERLVAR(Imain_cv, CV *)
402PERLVAR(Imain_root, OP *)
403PERLVAR(Imain_start, OP *)
404PERLVAR(Ieval_root, OP *)
405PERLVAR(Ieval_start, OP *)
49f531da
NIS
406
407/* runtime control stuff */
cb68f92d 408PERLVARI(Icurcopdb, COP *, NULL)
49f531da 409
49f531da
NIS
410PERLVAR(Ifilemode, int) /* so nextargv() can preserve mode */
411PERLVAR(Ilastfd, int) /* what to preserve mode on */
412PERLVAR(Ioldname, char *) /* what to preserve mode on */
360ea906 413PERLVAR(IArgv, const char **) /* stuff to free from do_aexec, vfork safe */
d4cce5f1 414PERLVAR(ICmd, char *) /* stuff to free from do_aexec, vfork safe */
00accf8d
NC
415/* Elements in this array have ';' appended and are injected as a single line
416 into the tokeniser. You can't put any (literal) newlines into any program
417 you stuff in into this array, as the point where it's injected is expecting
418 a single physical line. */
cb68f92d 419PERLVAR(Ipreambleav, AV *)
cb68f92d 420PERLVAR(Imess_sv, SV *)
7889fe52 421PERLVAR(Iors_sv, SV *) /* output record separator $\ */
71eebe1e
NC
422/* statics moved here for shared library purposes */
423PERLVARI(Igensym, I32, 0) /* next symbol for getsym() to define */
a4021b77 424PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
157b3822 425PERLVAR(Itaint_warn, bool) /* taint warns instead of dying */
d95e864f
NC
426PERLVARI(Ilaststype, U16, OP_STAT)
427PERLVARI(Ilaststatval, int, -1)
d4cce5f1 428
4b556e6c 429/* interpreter atexit processing */
d95e864f 430PERLVARI(Iexitlistlen, I32, 0) /* length of same */
cb68f92d
GS
431PERLVARI(Iexitlist, PerlExitListEntry *, NULL)
432 /* list of exit functions */
954c1994
GS
433
434/*
435=for apidoc Amn|HV*|PL_modglobal
436
7889fe52 437C<PL_modglobal> is a general purpose, interpreter global HV for use by
954c1994 438extensions that need to keep information on a per-interpreter basis.
7889fe52
NIS
439In a pinch, it can also be used as a symbol table for extensions
440to share data among each other. It is a good idea to use keys
954c1994
GS
441prefixed by the package name of the extension that owns the data.
442
443=cut
444*/
445
cb68f92d
GS
446PERLVAR(Imodglobal, HV *) /* per-interp module data */
447
448/* these used to be in global before 5.004_68 */
449PERLVARI(Iprofiledata, U32 *, NULL) /* table of ops, counts */
cb68f92d
GS
450
451PERLVAR(Icompiling, COP) /* compiling/done executing marker */
452
453PERLVAR(Icompcv, CV *) /* currently compiling subroutine */
454PERLVAR(Icomppad, AV *) /* storage for lexically scoped temporaries */
455PERLVAR(Icomppad_name, AV *) /* variable names for "my" variables */
456PERLVAR(Icomppad_name_fill, I32) /* last "introduced" variable offset */
457PERLVAR(Icomppad_name_floor, I32) /* start of vars in innermost block */
4b556e6c
JD
458
459#ifdef HAVE_INTERP_INTERN
cb68f92d
GS
460PERLVAR(Isys_intern, struct interp_intern)
461 /* platform internals */
4b556e6c
JD
462#endif
463
7fae4e64 464/* more statics moved here */
7fae4e64 465PERLVAR(IDBcv, CV *) /* from perl.c */
9f7da6d5 466PERLVARI(Igeneration, int, 100) /* from op.c */
56953603 467
cb68f92d 468PERLVARI(Iin_clean_objs,bool, FALSE) /* from sv.c */
57ef47cc 469PERLVARI(Iin_clean_all, bool, FALSE) /* ptrs to freed SVs now legal */
9f7da6d5
NC
470PERLVAR(Inomemok, bool) /* let malloc context handle nomem */
471PERLVARI(Isavebegin, bool, FALSE) /* save BEGINs for compiler */
7fae4e64 472
d8eceb89
JH
473PERLVAR(Iuid, Uid_t) /* current real user id */
474PERLVAR(Ieuid, Uid_t) /* current effective user id */
475PERLVAR(Igid, Gid_t) /* current real group id */
476PERLVAR(Iegid, Gid_t) /* current effective group id */
bf9cdc68
RG
477PERLVARI(Ian, U32, 0) /* malloc sequence number */
478PERLVARI(Icop_seqmax, U32, 0) /* statement sequence number */
bf9cdc68 479PERLVARI(Ievalseq, U32, 0) /* eval sequence number */
0672f40e 480PERLVAR(Iorigalen, U32)
9f7da6d5 481PERLVAR(Iorigenviron, char **)
ca0c25f6 482#ifdef PERL_USES_PL_PIDSTATUS
0672f40e 483PERLVAR(Ipidstatus, HV *) /* pid-to-status mappings for waitpid */
ca0c25f6 484#endif
0672f40e 485PERLVAR(Iosname, char *) /* operating system */
5c728af0 486
0672f40e
GS
487PERLVAR(Isighandlerp, Sighandler_t)
488
232d1c15 489PERLVARA(Ibody_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
93e68bfb 490
ed29bbba 491PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
0672f40e 492
9f7da6d5
NC
493PERLVARI(Imaxo, int, MAXO) /* maximum number of ops */
494
ef69c8fc 495PERLVARI(Irunops, runops_proc_t, RUNOPS_DEFAULT)
0672f40e 496
954c1994
GS
497/*
498=for apidoc Amn|SV|PL_sv_undef
499This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
500
501=for apidoc Amn|SV|PL_sv_no
502This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
503C<&PL_sv_no>.
504
505=for apidoc Amn|SV|PL_sv_yes
506This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
507C<&PL_sv_yes>.
508
509=cut
510*/
511
0672f40e
GS
512PERLVAR(Isv_undef, SV)
513PERLVAR(Isv_no, SV)
514PERLVAR(Isv_yes, SV)
515
0672f40e
GS
516PERLVAR(Isubname, SV *) /* name of current subroutine */
517
d95e864f 518PERLVAR(Isubline, I32) /* line this subroutine began on */
0672f40e 519PERLVAR(Imin_intro_pending, I32) /* start of vars to introduce */
d95e864f 520
0672f40e
GS
521PERLVAR(Imax_intro_pending, I32) /* end of vars to introduce */
522PERLVAR(Ipadix, I32) /* max used index in current "register" pad */
d95e864f 523
0672f40e 524PERLVAR(Ipadix_floor, I32) /* how low may inner block reset padix */
0672f40e 525
1d7c1841 526PERLVAR(Ihints, U32) /* pragma-tic compile-time flags */
0672f40e
GS
527
528PERLVAR(Idebug, VOL U32) /* flags given to -D switch */
529
f0cb02e3
NC
530/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen" */
531PERLVARI(Ibreakable_sub_gen, U32, 0)
532
bf9cdc68 533PERLVARI(Iamagic_generation, long, 0)
0672f40e
GS
534
535#ifdef USE_LOCALE_COLLATE
0672f40e 536PERLVAR(Icollation_name,char *) /* Name of current collation */
0672f40e
GS
537PERLVAR(Icollxfrm_base, Size_t) /* Basic overhead in *xfrm() */
538PERLVARI(Icollxfrm_mult,Size_t, 2) /* Expansion factor in *xfrm() */
9f7da6d5
NC
539PERLVARI(Icollation_ix, U32, 0) /* Collation generation index */
540PERLVARI(Icollation_standard, bool, TRUE)
541 /* Assume simple collation */
0672f40e
GS
542#endif /* USE_LOCALE_COLLATE */
543
9f7da6d5 544
edd11d75 545#if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
95ca8690 546# define PERL___I -1
9f7da6d5 547#else
7cd91da4 548# define PERL___I 1
9f7da6d5 549#endif
95ca8690
DM
550PERLVARI(Iutf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
551#undef PERL___I
552
9f7da6d5 553
0672f40e
GS
554#ifdef USE_LOCALE_NUMERIC
555
0672f40e
GS
556PERLVARI(Inumeric_standard, bool, TRUE)
557 /* Assume simple numerics */
558PERLVARI(Inumeric_local, bool, TRUE)
559 /* Assume local numerics */
9f7da6d5 560PERLVAR(Inumeric_name, char *) /* Name of current numeric locale */
0672f40e
GS
561#endif /* !USE_LOCALE_NUMERIC */
562
563/* utf8 character classes */
564PERLVAR(Iutf8_alnum, SV *)
b8c5462f 565PERLVAR(Iutf8_ascii, SV *)
0672f40e
GS
566PERLVAR(Iutf8_alpha, SV *)
567PERLVAR(Iutf8_space, SV *)
d1eb3177
YO
568PERLVAR(Iutf8_perl_space, SV *)
569PERLVAR(Iutf8_perl_word, SV *)
570PERLVAR(Iutf8_posix_digit, SV *)
b8c5462f
JH
571PERLVAR(Iutf8_cntrl, SV *)
572PERLVAR(Iutf8_graph, SV *)
0672f40e
GS
573PERLVAR(Iutf8_digit, SV *)
574PERLVAR(Iutf8_upper, SV *)
575PERLVAR(Iutf8_lower, SV *)
576PERLVAR(Iutf8_print, SV *)
b8c5462f
JH
577PERLVAR(Iutf8_punct, SV *)
578PERLVAR(Iutf8_xdigit, SV *)
0672f40e 579PERLVAR(Iutf8_mark, SV *)
37e2e78e
KW
580PERLVAR(Iutf8_X_begin, SV *)
581PERLVAR(Iutf8_X_extend, SV *)
582PERLVAR(Iutf8_X_prepend, SV *)
583PERLVAR(Iutf8_X_non_hangul, SV *)
584PERLVAR(Iutf8_X_L, SV *)
585PERLVAR(Iutf8_X_LV, SV *)
586PERLVAR(Iutf8_X_LVT, SV *)
587PERLVAR(Iutf8_X_T, SV *)
588PERLVAR(Iutf8_X_V, SV *)
589PERLVAR(Iutf8_X_LV_LVT_V, SV *)
0672f40e
GS
590PERLVAR(Iutf8_toupper, SV *)
591PERLVAR(Iutf8_totitle, SV *)
592PERLVAR(Iutf8_tolower, SV *)
b4e400f9 593PERLVAR(Iutf8_tofold, SV *)
0672f40e 594PERLVAR(Ilast_swash_hv, HV *)
0672f40e
GS
595PERLVAR(Ilast_swash_tmps, U8 *)
596PERLVAR(Ilast_swash_slen, STRLEN)
9f7da6d5 597PERLVARA(Ilast_swash_key,10, U8)
d95e864f
NC
598PERLVAR(Ilast_swash_klen, U8) /* Only needs to store 0-10 */
599
600#ifdef FCRYPT
601PERLVARI(Icryptseen, bool, FALSE) /* has fast crypt() been initialized? */
602#endif
603
f0cb02e3 604PERLVAR(Ipad_reset_pending, bool) /* reset pad on next attempted alloc */
49947b44 605
d95e864f
NC
606PERLVARI(Iglob_index, int, 0)
607
0672f40e 608
5912531f 609PERLVAR(Iparser, yy_parser *) /* current parser state */
12fbd33b 610
c4a30c8c
NC
611/* Array of signal handlers, indexed by signal number, through which the C
612 signal handler dispatches. */
1d7c1841 613PERLVAR(Ipsig_ptr, SV**)
c4a30c8c 614/* Array of names of signals, indexed by signal number, for (re)use as the first
d525a7b2
NC
615 argument to a signal handler. Only one block of memory is allocated for
616 both psig_name and psig_ptr. */
c4a30c8c 617PERLVAR(Ipsig_name, SV**)
1d7c1841 618
c5be433b 619#if defined(PERL_IMPLICIT_SYS)
32e30700 620PERLVAR(IMem, struct IPerlMem*)
1d7c1841
GS
621PERLVAR(IMemShared, struct IPerlMem*)
622PERLVAR(IMemParse, struct IPerlMem*)
32e30700
GS
623PERLVAR(IEnv, struct IPerlEnv*)
624PERLVAR(IStdIO, struct IPerlStdIO*)
625PERLVAR(ILIO, struct IPerlLIO*)
626PERLVAR(IDir, struct IPerlDir*)
627PERLVAR(ISock, struct IPerlSock*)
628PERLVAR(IProc, struct IPerlProc*)
76e3520e 629#endif
1d7c1841 630
1d7c1841 631PERLVAR(Iptr_table, PTR_TBL_t*)
7d49f689 632PERLVARI(Ibeginav_save, AV*, NULL) /* save BEGIN{}s when compiling */
f180df80 633
fdda85ca 634PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
93e68bfb 635
d95e864f 636
a453c169
JH
637#ifdef USE_LOCALE_NUMERIC
638
639PERLVAR(Inumeric_radix_sv, SV *) /* The radix separator if not '.' */
640
641#endif
ce08f86c 642
1fcf4c12 643#if defined(USE_ITHREADS)
e6853197
NC
644PERLVAR(Iregex_pad, SV**) /* Shortcut into the array of
645 regex_padav */
646PERLVAR(Iregex_padav, AV*) /* All regex objects, indexed via the
647 values in op_pmoffset of pmop.
402d2eb1
NC
648 Entry 0 is an SV whose PV is a
649 "packed" list of IVs listing
e6853197 650 the now-free slots in the array */
1fcf4c12
AB
651#endif
652
ea68fd67
NC
653#ifdef USE_REENTRANT_API
654PERLVAR(Ireentrant_buffer, REENTR*) /* here we store the _r buffers */
f5a82810
JH
655#endif
656
53e06cf0
SC
657PERLVAR(Icustom_op_names, HV*) /* Names of user defined ops */
658PERLVAR(Icustom_op_descs, HV*) /* Descriptions of user defined ops */
19e8ce8e 659
a1ea730d 660#ifdef PERLIO_LAYERS
303f2dc3 661PERLVARI(Iperlio, PerlIOl *,NULL)
3a1ee7e8
NIS
662PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
663PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
a1ea730d
NIS
664#endif
665
a0714e2c 666PERLVARI(Iencoding, SV*, NULL) /* character encoding */
0a378802 667
128e8167 668PERLVAR(Idebug_pad, struct perl_debug_pad) /* always needed because of the re extension */
ce333219 669
82686b01
JH
670PERLVAR(Iutf8_idstart, SV *)
671PERLVAR(Iutf8_idcont, SV *)
672
147f47de
AB
673PERLVAR(Isort_RealCmp, SVCOMPARE_t)
674
7d49f689 675PERLVARI(Icheckav_save, AV*, NULL) /* save CHECK{}s when compiling */
3c10abe3 676PERLVARI(Iunitcheckav_save, AV*, NULL) /* save UNITCHECK{}s when compiling */
ece599bd 677
5311654c
JH
678PERLVARI(Iclocktick, long, 0) /* this many times() ticks in a second */
679
4ffa73a3
JH
680PERLVAR(Isignals, U32) /* Using which pre-5.8 signals */
681
57c6e6d2
JH
682PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
683
9f7da6d5
NC
684PERLVAR(Istashcache, HV *) /* Cache to speed up S_method_common */
685
15a5279a 686/* Hooks to shared SVs and locks. */
ef69c8fc
BM
687PERLVARI(Isharehook, share_proc_t, Perl_sv_nosharing)
688PERLVARI(Ilockhook, share_proc_t, Perl_sv_nosharing)
d0647d4e
NC
689#ifdef NO_MATHOMS
690# define PERL_UNLOCK_HOOK Perl_sv_nosharing
691#else
692/* This reference ensures that the mathoms are linked with perl */
693# define PERL_UNLOCK_HOOK Perl_sv_nounlocking
694#endif
ef69c8fc 695PERLVARI(Iunlockhook, share_proc_t, PERL_UNLOCK_HOOK)
d0647d4e 696
ef69c8fc 697PERLVARI(Ithreadhook, thrhook_proc_t, Perl_nothreadhook)
15a5279a 698
ef69c8fc 699PERLVARI(Isignalhook, despatch_signals_proc_t, Perl_despatch_signals)
92f022bb 700
504f80c1
JH
701PERLVARI(Ihash_seed, UV, 0) /* Hash initializer */
702
008fb0c0 703PERLVARI(Irehash_seed, UV, 0) /* 582 hash initializer */
4b5190b5 704
ba6d381e 705PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
f16dd614 706
ffee3ff6
NC
707/* The last unconditional member of the interpreter structure when 5.10.0 was
708 released. The offset of the end of this is baked into a global variable in
709 any shared perl library which will allow a sanity test in future perl
710 releases. */
711#define PERL_LAST_5_10_0_INTERP_MEMBER Iisarev
712
f16dd614 713#ifdef PERL_IMPLICIT_CONTEXT
4c901e72 714PERLVARI(Imy_cxt_size, int, 0) /* size of PL_my_cxt_list */
f16dd614 715PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
ba6d381e 716# ifdef PERL_GLOBAL_STRUCT_PRIVATE
53d44271 717PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
ba6d381e 718# endif
f16dd614
DM
719#endif
720
7cb608b5
NC
721#ifdef PERL_TRACK_MEMPOOL
722/* For use with the memory debugging code in util.c */
723PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
724#endif
725
ba6d381e
NC
726#ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
727/* File descriptor to talk to the child which dumps scalars. */
728PERLVARI(Idumper_fd, int, -1)
729#endif
730
731/* Stores the PPID */
732#ifdef THREADS_HAVE_PIDS
733PERLVARI(Ippid, IV, 0)
734#endif
735
736#ifdef PERL_MAD
737PERLVARI(Imadskills, bool, FALSE) /* preserve all syntactic info */
738 /* (MAD = Misc Attribute Decoration) */
739PERLVARI(Ixmlfp, PerlIO *,NULL)
740#endif
741
742#ifdef PL_OP_SLAB_ALLOC
743PERLVAR(IOpPtr,I32 **)
744PERLVARI(IOpSpace,I32,0)
745PERLVAR(IOpSlab,I32 *)
746#endif
747
f1fac472
NC
748#ifdef PERL_DEBUG_READONLY_OPS
749PERLVARI(Islabs, I32**, NULL) /* Array of slabs that have been allocated */
750PERLVARI(Islab_count, U32, 0) /* Size of the array */
751#endif
752
eba16661 753/* Can shared object be destroyed */
ef69c8fc 754PERLVARI(Idestroyhook, destroyable_proc_t, Perl_sv_destroyable)
eba16661 755
d7a2c63c
MHM
756#ifdef DEBUG_LEAKING_SCALARS
757PERLVARI(Isv_serial, U32, 0) /* SV serial number, used in sv.c */
758#endif
759
a3e6e81e
NC
760/* Register of known Method Resolution Orders.
761 What this actually points to is an implementation detail (it may change to
762 a structure incorporating a reference count - use mro_get_from_name to
763 retrieve a C<struct mro_alg *> */
764PERLVAR(Iregistered_mros, HV *)
765
1930840b
BM
766/* Compile-time block start/end hooks */
767PERLVAR(Iblockhooks, AV *)
768
2726813d 769
41fc8fee
KW
770/* Everything that folds to a given character, for case insensitivity regex
771 * matching */
2726813d
KW
772PERLVARI(Iutf8_foldclosures, HV *, NULL)
773
1830b3d9
BM
774PERLVAR(Icustom_ops, HV *) /* custom op registrations */
775
157b3822
NC
776/* If you are adding a U8 or U16, check to see if there are 'Space' comments
777 * above on where there are gaps which currently will be structure padding. */
d95e864f
NC
778
779/* Within a stable branch, new variables must be added to the very end, before
780 * this comment, for binary compatibility (the offsets of the old members must
781 * not change).
b83cd129 782 * (Don't forget to add your variable also to perl_clone()!)
e3acbfda 783 * XSUB.h provides wrapper functions via perlapi.h that make this
b83cd129
JH
784 * irrelevant, but not all code may be expected to #include XSUB.h.
785 */