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