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