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