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