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