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