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