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