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