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