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