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