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