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