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  * XSUB.h provides wrapper functions via perlapi.h that make this
  22  * irrelevant, but not all code may be expected to #include XSUB.h. */
  23
  24 /* Don't forget to add your variable also to perl_clone()! */
  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.
  29  *
  30  * When building without MULTIPLICITY, these variables will be truly global.
  31  *
  32  * Important ones in the first cache line (if alignment is done right) */
  33
  34 PERLVAR(Istack_sp,      SV **)          /* top of the stack */
  35 #ifdef OP_IN_REGISTER
  36 PERLVAR(Iopsave,        OP *)
  37 #else
  38 PERLVAR(Iop,            OP *)           /* currently executing op */
  39 #endif
  40 PERLVAR(Icurpad,        SV **)          /* active pad (lexicals+tmps) */
  41
  42 PERLVAR(Istack_base,    SV **)
  43 PERLVAR(Istack_max,     SV **)
  44
  45 PERLVAR(Iscopestack,    I32 *)          /* scopes we've ENTERed */
  46 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
  47    present always, as -DDEUBGGING must be binary compatible with non.  */
  48 PERLVARI(Iscopestack_name, const char * *, NULL)
  49 PERLVAR(Iscopestack_ix, I32)
  50 PERLVAR(Iscopestack_max,I32)
  51
  52 PERLVAR(Isavestack,     ANY *)          /* items that need to be restored when
  53                                            LEAVEing scopes we've ENTERed */
  54 PERLVAR(Isavestack_ix,  I32)
  55 PERLVAR(Isavestack_max, I32)
  56
  57 PERLVAR(Itmps_stack,    SV **)          /* mortals we've made */
  58 PERLVARI(Itmps_ix,      I32,    -1)
  59 PERLVARI(Itmps_floor,   I32,    -1)
  60 PERLVAR(Itmps_max,      I32)
  61 PERLVAR(Imodcount,      I32)            /* how much mod()ification in
  62                                            assignment? */
  63
  64 PERLVAR(Imarkstack,     I32 *)          /* stack_sp locations we're
  65                                            remembering */
  66 PERLVAR(Imarkstack_ptr, I32 *)
  67 PERLVAR(Imarkstack_max, I32 *)
  68
  69 PERLVAR(ISv,            SV *)           /* used to hold temporary values */
  70 PERLVAR(IXpv,           XPV *)          /* used to hold temporary values */
  71
  72 /*
  73 =for apidoc Amn|STRLEN|PL_na
  74
  75 A convenience variable which is typically used with C<SvPV> when one
  76 doesn't care about the length of the string.  It is usually more efficient
  77 to either declare a local variable and use that instead or to use the
  78 C<SvPV_nolen> macro.
  79
  80 =cut
  81 */
  82
  83 PERLVAR(Ina,            STRLEN)         /* for use in SvPV when length is
  84                                            Not Applicable */
  85
  86 /* stat stuff */
  87 PERLVAR(Istatbuf,       Stat_t)
  88 PERLVAR(Istatcache,     Stat_t)         /* _ */
  89 PERLVAR(Istatgv,        GV *)
  90 PERLVARI(Istatname,     SV *,   NULL)
  91
  92 #ifdef HAS_TIMES
  93 PERLVAR(Itimesbuf,      struct tms)
  94 #endif
  95
  96 /* Fields used by magic variables such as $@, $/ and so on */
  97 PERLVAR(Icurpm,         PMOP *)         /* what to do \ interps in REs from */
  98
  99 /*
 100 =for apidoc mn|SV*|PL_rs
 101
 102 The input record separator - C<$/> in Perl space.
 103
 104 =for apidoc mn|GV*|PL_last_in_gv
 105
 106 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
 107
 108 =for apidoc mn|GV*|PL_ofsgv
 109
 110 The glob containing the output field separator - C<*,> in Perl space.
 111
 112 =cut
 113 */
 114
 115 PERLVAR(Irs,            SV *)           /* input record separator $/ */
 116 PERLVAR(Ilast_in_gv,    GV *)           /* GV used in last <FH> */
 117 PERLVAR(Iofsgv,         GV *)           /* GV of output field separator *, */
 118 PERLVAR(Idefoutgv,      GV *)           /* default FH for output */
 119 PERLVARI(Ichopset,      const char *, " \n-")   /* $: */
 120 PERLVAR(Iformtarget,    SV *)
 121 PERLVAR(Ibodytarget,    SV *)
 122 PERLVAR(Itoptarget,     SV *)
 123
 124 /* Stashes */
 125 PERLVAR(Idefstash,      HV *)           /* main symbol table */
 126 PERLVAR(Icurstash,      HV *)           /* symbol table for current package */
 127
 128 PERLVAR(Irestartop,     OP *)           /* propagating an error from croak? */
 129 PERLVAR(Irestartjmpenv, JMPENV *)       /* target frame for longjmp in die */
 130 PERLVAR(Icurcop,        COP *)
 131 PERLVAR(Icurstack,      AV *)           /* THE STACK */
 132 PERLVAR(Icurstackinfo,  PERL_SI *)      /* current stack + context */
 133 PERLVAR(Imainstack,     AV *)           /* the stack when nothing funny is
 134                                            happening */
 135
 136 PERLVAR(Itop_env,       JMPENV *)       /* ptr to current sigjmp environment */
 137 PERLVAR(Istart_env,     JMPENV)         /* empty startup sigjmp environment */
 138 PERLVARI(Ierrors,       SV *,   NULL)   /* outstanding queued errors */
 139
 140 /* statics "owned" by various functions */
 141 PERLVAR(Ihv_fetch_ent_mh, HE*)          /* owned by hv_fetch_ent() */
 142
 143 PERLVAR(Ilastgotoprobe, OP*)            /* from pp_ctl.c */
 144
 145 /* sort stuff */
 146 PERLVAR(Isortcop,       OP *)           /* user defined sort routine */
 147 PERLVAR(Isortstash,     HV *)           /* which is in some package or other */
 148 PERLVAR(Ifirstgv,       GV *)           /* $a */
 149 PERLVAR(Isecondgv,      GV *)           /* $b */
 150
 151 /* float buffer */
 152 PERLVAR(Iefloatbuf,     char *)
 153 PERLVAR(Iefloatsize,    STRLEN)
 154
 155 /* regex stuff */
 156
 157 PERLVAR(Iscreamfirst,   I32 *)
 158 PERLVAR(Iscreamnext,    I32 *)
 159 PERLVAR(Ilastscream,    SV *)
 160
 161 PERLVAR(Ireg_state,     struct re_save_state)
 162
 163 PERLVAR(Iregdummy,      regnode)        /* from regcomp.c */
 164
 165 PERLVARI(Idumpindent,   U16,    4)      /* number of blanks per dump
 166                                            indentation level */
 167
 168
 169 PERLVAR(Iutf8locale,    bool)           /* utf8 locale detected */
 170 PERLVARI(Irehash_seed_set, bool, FALSE) /* 582 hash initialized? */
 171
 172 PERLVARA(Icolors,6,     char *)         /* from regcomp.c */
 173
 174 /*
 175 =for apidoc Amn|peep_t|PL_peepp
 176
 177 Pointer to the per-subroutine peephole optimiser.  This is a function
 178 that gets called at the end of compilation of a Perl subroutine (or
 179 equivalently independent piece of Perl code) to perform fixups of
 180 some ops and to perform small-scale optimisations.  The function is
 181 called once for each subroutine that is compiled, and is passed, as sole
 182 parameter, a pointer to the op that is the entry point to the subroutine.
 183 It modifies the op tree in place.
 184
 185 The peephole optimiser should never be completely replaced.  Rather,
 186 add code to it by wrapping the existing optimiser.  The basic way to do
 187 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
 188 If the new code wishes to operate on ops throughout the subroutine's
 189 structure, rather than just at the top level, it is likely to be more
 190 convenient to wrap the L</PL_rpeepp> hook.
 191
 192 =cut
 193 */
 194
 195 PERLVARI(Ipeepp,        peep_t, Perl_peep)
 196
 197 /*
 198 =for apidoc Amn|peep_t|PL_rpeepp
 199
 200 Pointer to the recursive peephole optimiser.  This is a function
 201 that gets called at the end of compilation of a Perl subroutine (or
 202 equivalently independent piece of Perl code) to perform fixups of some
 203 ops and to perform small-scale optimisations.  The function is called
 204 once for each chain of ops linked through their C<op_next> fields;
 205 it is recursively called to handle each side chain.  It is passed, as
 206 sole parameter, a pointer to the op that is at the head of the chain.
 207 It modifies the op tree in place.
 208
 209 The peephole optimiser should never be completely replaced.  Rather,
 210 add code to it by wrapping the existing optimiser.  The basic way to do
 211 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
 212 If the new code wishes to operate only on ops at a subroutine's top level,
 213 rather than throughout the structure, it is likely to be more convenient
 214 to wrap the L</PL_peepp> hook.
 215
 216 =cut
 217 */
 218
 219 PERLVARI(Irpeepp,       peep_t, Perl_rpeep)
 220
 221 /*
 222 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
 223
 224 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.
 225 This allows extensions to free any extra attribute they have locally attached to an OP.
 226 It is also assured to first fire for the parent OP and then for its kids.
 227
 228 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.
 229
 230 =cut
 231 */
 232
 233 PERLVARI(Iopfreehook,   Perl_ophook_t, 0) /* op_free() hook */
 234
 235 PERLVARI(Imaxscream,    I32,    -1)
 236 PERLVARI(Ireginterp_cnt,I32,     0)     /* Whether "Regexp" was interpolated. */
 237 PERLVARI(Iwatchaddr,    char **, 0)
 238 PERLVAR(Iwatchok,       char *)
 239
 240 /* the currently active slab in a chain of slabs of regmatch states,
 241  * and the currently active state within that slab */
 242
 243 PERLVARI(Iregmatch_slab, regmatch_slab *,       NULL)
 244 PERLVAR(Iregmatch_state, regmatch_state *)
 245
 246 /* Put anything new that is pointer aligned here. */
 247
 248 PERLVAR(Idelaymagic,    U16)            /* ($<,$>) = ... */
 249 PERLVAR(Ilocalizing,    U8)             /* are we processing a local() list? */
 250 PERLVAR(Icolorset,      bool)           /* from regcomp.c */
 251 PERLVARI(Idirty,        bool, FALSE)    /* in the middle of tearing things
 252                                            down? */
 253 PERLVAR(Iin_eval,       U8)             /* trap "fatal" errors? */
 254 PERLVAR(Itainted,       bool)           /* using variables controlled by $< */
 255
 256 /* This value may be set when embedding for full cleanup  */
 257 /* 0=none, 1=full, 2=full with checks */
 258 /* mod_perl is special, and also assigns a meaning -1 */
 259 PERLVARI(Iperl_destruct_level,  signed char,    0)
 260
 261 PERLVAR(Iperldb,        U32)
 262
 263 /* pseudo environmental stuff */
 264 PERLVAR(Iorigargc,      int)
 265 PERLVAR(Iorigargv,      char **)
 266 PERLVAR(Ienvgv,         GV *)
 267 PERLVAR(Iincgv,         GV *)
 268 PERLVAR(Ihintgv,        GV *)
 269 PERLVAR(Iorigfilename,  char *)
 270 PERLVAR(Idiehook,       SV *)
 271 PERLVAR(Iwarnhook,      SV *)
 272
 273 /* switches */
 274 PERLVAR(Ipatchlevel,    SV *)
 275 PERLVAR(Iapiversion,    SV *)
 276 PERLVAR(Ilocalpatches,  const char * const *)
 277 PERLVARI(Isplitstr,     const char *, " ")
 278
 279 PERLVAR(Iminus_c,       bool)
 280 PERLVAR(Iminus_n,       bool)
 281 PERLVAR(Iminus_p,       bool)
 282 PERLVAR(Iminus_l,       bool)
 283 PERLVAR(Iminus_a,       bool)
 284 PERLVAR(Iminus_F,       bool)
 285 PERLVAR(Idoswitches,    bool)
 286 PERLVAR(Iminus_E,       bool)
 287
 288 /*
 289
 290 =for apidoc mn|bool|PL_dowarn
 291
 292 The C variable which corresponds to Perl's $^W warning variable.
 293
 294 =cut
 295 */
 296
 297 PERLVAR(Idowarn,        U8)
 298 PERLVAR(Isawampersand,  bool)           /* must save all match strings */
 299 PERLVAR(Iunsafe,        bool)
 300 PERLVAR(Iexit_flags,    U8)             /* was exit() unexpected, etc. */
 301 PERLVAR(Isrand_called,  bool)
 302 /* Part of internal state, but makes the 16th 1 byte variable in a row.  */
 303 PERLVAR(Itainting,      bool)           /* doing taint checks */
 304 PERLVARI(Iin_load_module, bool, FALSE)  /* to prevent recursions in PerlIO_find_layer */
 305 PERLVAR(Iinplace,       char *)
 306 PERLVAR(Ie_script,      SV *)
 307
 308 /* magical thingies */
 309 PERLVAR(Ibasetime,      Time_t)         /* $^T */
 310 PERLVAR(Iformfeed,      SV *)           /* $^L */
 311
 312
 313 PERLVARI(Imaxsysfd,     I32,    MAXSYSFD)
 314                                         /* top fd to pass to subprocesses */
 315 PERLVAR(Istatusvalue,   I32)            /* $? */
 316 #ifdef VMS
 317 PERLVAR(Istatusvalue_vms,U32)
 318 #else
 319 PERLVAR(Istatusvalue_posix,I32)
 320 #endif
 321
 322 PERLVARI(Isig_pending, int,0)           /* Number if highest signal pending */
 323 PERLVAR(Ipsig_pend, int *)              /* per-signal "count" of pending */
 324
 325 /* shortcuts to various I/O objects */
 326 PERLVAR(Istdingv,       GV *)           /*  *STDIN      */
 327 PERLVAR(Istderrgv,      GV *)           /*  *STDERR     */
 328 PERLVAR(Idefgv,         GV *)
 329 PERLVAR(Iargvgv,        GV *)           /*  *ARGV       */
 330 PERLVAR(Iargvoutgv,     GV *)           /*  *ARGVOUT    */
 331 PERLVAR(Iargvout_stack, AV *)
 332
 333 /* shortcuts to regexp stuff */
 334 PERLVAR(Ireplgv,        GV *)           /*  *^R         */
 335
 336 /* shortcuts to misc objects */
 337 PERLVAR(Ierrgv,         GV *)           /*  *@          */
 338
 339 /* shortcuts to debugging objects */
 340 PERLVAR(IDBgv,          GV *)           /*  *DB::DB     */
 341 PERLVAR(IDBline,        GV *)           /*  *DB::line   */
 342
 343 /*
 344 =for apidoc mn|GV *|PL_DBsub
 345 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
 346 the SV which holds the name of the sub being debugged.  This is the C
 347 variable which corresponds to Perl's $DB::sub variable.  See
 348 C<PL_DBsingle>.
 349
 350 =for apidoc mn|SV *|PL_DBsingle
 351 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
 352 boolean which indicates whether subs are being single-stepped.
 353 Single-stepping is automatically turned on after every step.  This is the C
 354 variable which corresponds to Perl's $DB::single variable.  See
 355 C<PL_DBsub>.
 356
 357 =for apidoc mn|SV *|PL_DBtrace
 358 Trace variable used when Perl is run in debugging mode, with the B<-d>
 359 switch.  This is the C variable which corresponds to Perl's $DB::trace
 360 variable.  See C<PL_DBsingle>.
 361
 362 =cut
 363 */
 364
 365 PERLVAR(IDBsub,         GV *)           /*  *DB::sub    */
 366 PERLVAR(IDBsingle,      SV *)           /*  $DB::single */
 367 PERLVAR(IDBtrace,       SV *)           /*  $DB::trace  */
 368 PERLVAR(IDBsignal,      SV *)           /*  $DB::signal */
 369 PERLVAR(Idbargs,        AV *)           /* args to call listed by caller function */
 370
 371 /* symbol tables */
 372 PERLVAR(Idebstash,      HV *)           /* symbol table for perldb package */
 373 PERLVAR(Iglobalstash,   HV *)           /* global keyword overrides imported here */
 374 PERLVAR(Icurstname,     SV *)           /* name of current package */
 375 PERLVAR(Ibeginav,       AV *)           /* names of BEGIN subroutines */
 376 PERLVAR(Iendav,         AV *)           /* names of END subroutines */
 377 PERLVAR(Iunitcheckav,   AV *)           /* names of UNITCHECK subroutines */
 378 PERLVAR(Icheckav,       AV *)           /* names of CHECK subroutines */
 379 PERLVAR(Iinitav,        AV *)           /* names of INIT subroutines */
 380 PERLVAR(Istrtab,        HV *)           /* shared string table */
 381 PERLVARI(Isub_generation,U32,1)         /* incr to invalidate method cache */
 382
 383 /* funky return mechanisms */
 384 PERLVAR(Iforkprocess,   int)            /* so do_open |- can return proc# */
 385
 386 /* memory management */
 387 PERLVAR(Isv_count,      I32)            /* how many SV* are currently allocated */
 388 PERLVAR(Isv_objcount,   I32)            /* how many objects are currently allocated */
 389 PERLVAR(Isv_root,       SV*)            /* storage for SVs belonging to interp */
 390 PERLVAR(Isv_arenaroot,  SV*)            /* list of areas for garbage collection */
 391
 392 /* subprocess state */
 393 PERLVAR(Ifdpid,         AV *)           /* keep fd-to-pid mappings for my_popen */
 394
 395 /* internal state */
 396 PERLVARI(Iop_mask,      char *, NULL)   /* masked operations for safe evals */
 397
 398 /* current interpreter roots */
 399 PERLVAR(Imain_cv,       CV *)
 400 PERLVAR(Imain_root,     OP *)
 401 PERLVAR(Imain_start,    OP *)
 402 PERLVAR(Ieval_root,     OP *)
 403 PERLVAR(Ieval_start,    OP *)
 404
 405 /* runtime control stuff */
 406 PERLVARI(Icurcopdb,     COP *,  NULL)
 407
 408 PERLVAR(Ifilemode,      int)            /* so nextargv() can preserve mode */
 409 PERLVAR(Ilastfd,        int)            /* what to preserve mode on */
 410 PERLVAR(Ioldname,       char *)         /* what to preserve mode on */
 411 PERLVAR(IArgv,          const char **)  /* stuff to free from do_aexec, vfork safe */
 412 PERLVAR(ICmd,           char *)         /* stuff to free from do_aexec, vfork safe */
 413 /* Elements in this array have ';' appended and are injected as a single line
 414    into the tokeniser. You can't put any (literal) newlines into any program
 415    you stuff in into this array, as the point where it's injected is expecting
 416    a single physical line. */
 417 PERLVAR(Ipreambleav,    AV *)
 418 PERLVAR(Imess_sv,       SV *)
 419 PERLVAR(Iors_sv,        SV *)           /* output record separator $\ */
 420 /* statics moved here for shared library purposes */
 421 PERLVARI(Igensym,       I32,    0)      /* next symbol for getsym() to define */
 422 PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
 423 PERLVAR(Itaint_warn,    bool)      /* taint warns instead of dying */
 424 PERLVARI(Ilaststype,    U16,    OP_STAT)
 425 PERLVARI(Ilaststatval,  int,    -1)
 426
 427 /* interpreter atexit processing */
 428 PERLVARI(Iexitlistlen,  I32, 0)         /* length of same */
 429 PERLVARI(Iexitlist,     PerlExitListEntry *, NULL)
 430                                         /* list of exit functions */
 431
 432 /*
 433 =for apidoc Amn|HV*|PL_modglobal
 434
 435 C<PL_modglobal> is a general purpose, interpreter global HV for use by
 436 extensions that need to keep information on a per-interpreter basis.
 437 In a pinch, it can also be used as a symbol table for extensions
 438 to share data among each other.  It is a good idea to use keys
 439 prefixed by the package name of the extension that owns the data.
 440
 441 =cut
 442 */
 443
 444 PERLVAR(Imodglobal,     HV *)           /* per-interp module data */
 445
 446 /* these used to be in global before 5.004_68 */
 447 PERLVARI(Iprofiledata,  U32 *,  NULL)   /* table of ops, counts */
 448
 449 PERLVAR(Icompiling,     COP)            /* compiling/done executing marker */
 450
 451 PERLVAR(Icompcv,        CV *)           /* currently compiling subroutine */
 452 PERLVAR(Icomppad,       AV *)           /* storage for lexically scoped temporaries */
 453 PERLVAR(Icomppad_name,  AV *)           /* variable names for "my" variables */
 454 PERLVAR(Icomppad_name_fill,     I32)    /* last "introduced" variable offset */
 455 PERLVAR(Icomppad_name_floor,    I32)    /* start of vars in innermost block */
 456
 457 #ifdef HAVE_INTERP_INTERN
 458 PERLVAR(Isys_intern,    struct interp_intern)
 459                                         /* platform internals */
 460 #endif
 461
 462 /* more statics moved here */
 463 PERLVAR(IDBcv,          CV *)           /* from perl.c */
 464 PERLVARI(Igeneration,   int,    100)    /* from op.c */
 465
 466 PERLVARI(Iin_clean_objs,bool,    FALSE) /* from sv.c */
 467 PERLVARI(Iin_clean_all, bool,    FALSE) /* ptrs to freed SVs now legal */
 468 PERLVAR(Inomemok,       bool)           /* let malloc context handle nomem */
 469 PERLVARI(Isavebegin,     bool,  FALSE)  /* save BEGINs for compiler     */
 470
 471 PERLVAR(Iuid,           Uid_t)          /* current real user id */
 472 PERLVAR(Ieuid,          Uid_t)          /* current effective user id */
 473 PERLVAR(Igid,           Gid_t)          /* current real group id */
 474 PERLVAR(Iegid,          Gid_t)          /* current effective group id */
 475 PERLVARI(Ian,           U32,    0)      /* malloc sequence number */
 476 PERLVARI(Icop_seqmax,   U32,    0)      /* statement sequence number */
 477 PERLVARI(Ievalseq,      U32,    0)      /* eval sequence number */
 478 PERLVAR(Iorigalen,      U32)
 479 PERLVAR(Iorigenviron,   char **)
 480 #ifdef PERL_USES_PL_PIDSTATUS
 481 PERLVAR(Ipidstatus,     HV *)           /* pid-to-status mappings for waitpid */
 482 #endif
 483 PERLVAR(Iosname,        char *)         /* operating system */
 484
 485 PERLVAR(Isighandlerp,   Sighandler_t)
 486
 487 PERLVARA(Ibody_roots,   PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
 488
 489 PERLVAR(Iunicode, U32)  /* Unicode features: $ENV{PERL_UNICODE} or -C */
 490
 491 PERLVARI(Imaxo, int,    MAXO)           /* maximum number of ops */
 492
 493 PERLVARI(Irunops,       runops_proc_t,  RUNOPS_DEFAULT)
 494
 495 /*
 496 =for apidoc Amn|SV|PL_sv_undef
 497 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
 498
 499 =for apidoc Amn|SV|PL_sv_no
 500 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
 501 C<&PL_sv_no>.
 502
 503 =for apidoc Amn|SV|PL_sv_yes
 504 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
 505 C<&PL_sv_yes>.
 506
 507 =cut
 508 */
 509
 510 PERLVAR(Isv_undef,      SV)
 511 PERLVAR(Isv_no,         SV)
 512 PERLVAR(Isv_yes,        SV)
 513
 514 PERLVAR(Isubname,       SV *)           /* name of current subroutine */
 515
 516 PERLVAR(Isubline,       I32)            /* line this subroutine began on */
 517 PERLVAR(Imin_intro_pending,     I32)    /* start of vars to introduce */
 518
 519 PERLVAR(Imax_intro_pending,     I32)    /* end of vars to introduce */
 520 PERLVAR(Ipadix,         I32)            /* max used index in current "register" pad */
 521
 522 PERLVAR(Ipadix_floor,   I32)            /* how low may inner block reset padix */
 523
 524 PERLVAR(Ihints,         U32)            /* pragma-tic compile-time flags */
 525
 526 PERLVAR(Idebug,         VOL U32)        /* flags given to -D switch */
 527
 528 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
 529 PERLVARI(Ibreakable_sub_gen, U32, 0)
 530
 531 PERLVARI(Iamagic_generation,    long,   0)
 532
 533 #ifdef USE_LOCALE_COLLATE
 534 PERLVAR(Icollation_name,char *)         /* Name of current collation */
 535 PERLVAR(Icollxfrm_base, Size_t)         /* Basic overhead in *xfrm() */
 536 PERLVARI(Icollxfrm_mult,Size_t, 2)      /* Expansion factor in *xfrm() */
 537 PERLVARI(Icollation_ix, U32,    0)      /* Collation generation index */
 538 PERLVARI(Icollation_standard, bool,     TRUE)
 539                                         /* Assume simple collation */
 540 #endif /* USE_LOCALE_COLLATE */
 541
 542
 543 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
 544 #  define PERL___I -1
 545 #else
 546 #  define PERL___I 1
 547 #endif
 548 PERLVARI(Iutf8cache, I8, PERL___I)      /* Is the utf8 caching code enabled? */
 549 #undef PERL___I
 550
 551
 552 #ifdef USE_LOCALE_NUMERIC
 553
 554 PERLVARI(Inumeric_standard,     bool,   TRUE)
 555                                         /* Assume simple numerics */
 556 PERLVARI(Inumeric_local,        bool,   TRUE)
 557                                         /* Assume local numerics */
 558 PERLVAR(Inumeric_name,  char *)         /* Name of current numeric locale */
 559 #endif /* !USE_LOCALE_NUMERIC */
 560
 561 /* utf8 character classes */
 562 PERLVAR(Iutf8_alnum,    SV *)
 563 PERLVAR(Iutf8_ascii,    SV *)
 564 PERLVAR(Iutf8_alpha,    SV *)
 565 PERLVAR(Iutf8_space,    SV *)
 566 PERLVAR(Iutf8_perl_space,       SV *)
 567 PERLVAR(Iutf8_perl_word,        SV *)
 568 PERLVAR(Iutf8_posix_digit,      SV *)
 569 PERLVAR(Iutf8_cntrl,    SV *)
 570 PERLVAR(Iutf8_graph,    SV *)
 571 PERLVAR(Iutf8_digit,    SV *)
 572 PERLVAR(Iutf8_upper,    SV *)
 573 PERLVAR(Iutf8_lower,    SV *)
 574 PERLVAR(Iutf8_print,    SV *)
 575 PERLVAR(Iutf8_punct,    SV *)
 576 PERLVAR(Iutf8_xdigit,   SV *)
 577 PERLVAR(Iutf8_mark,     SV *)
 578 PERLVAR(Iutf8_X_begin,  SV *)
 579 PERLVAR(Iutf8_X_extend, SV *)
 580 PERLVAR(Iutf8_X_prepend,        SV *)
 581 PERLVAR(Iutf8_X_non_hangul,     SV *)
 582 PERLVAR(Iutf8_X_L,      SV *)
 583 PERLVAR(Iutf8_X_LV,     SV *)
 584 PERLVAR(Iutf8_X_LVT,    SV *)
 585 PERLVAR(Iutf8_X_T,      SV *)
 586 PERLVAR(Iutf8_X_V,      SV *)
 587 PERLVAR(Iutf8_X_LV_LVT_V,       SV *)
 588 PERLVAR(Iutf8_toupper,  SV *)
 589 PERLVAR(Iutf8_totitle,  SV *)
 590 PERLVAR(Iutf8_tolower,  SV *)
 591 PERLVAR(Iutf8_tofold,   SV *)
 592 PERLVAR(Ilast_swash_hv, HV *)
 593 PERLVAR(Ilast_swash_tmps,       U8 *)
 594 PERLVAR(Ilast_swash_slen,       STRLEN)
 595 PERLVARA(Ilast_swash_key,10,    U8)
 596 PERLVAR(Ilast_swash_klen,       U8)     /* Only needs to store 0-10  */
 597
 598 #ifdef FCRYPT
 599 PERLVARI(Icryptseen,    bool,   FALSE)  /* has fast crypt() been initialized? */
 600 #endif
 601
 602 PERLVAR(Ipad_reset_pending,     bool)   /* reset pad on next attempted alloc */
 603
 604 PERLVARI(Iglob_index,   int,    0)
 605
 606
 607 PERLVAR(Iparser,        yy_parser *)    /* current parser state */
 608
 609 /* Array of signal handlers, indexed by signal number, through which the C
 610    signal handler dispatches.  */
 611 PERLVAR(Ipsig_ptr, SV**)
 612 /* Array of names of signals, indexed by signal number, for (re)use as the first
 613    argument to a signal handler.   Only one block of memory is allocated for
 614    both psig_name and psig_ptr.  */
 615 PERLVAR(Ipsig_name, SV**)
 616
 617 #if defined(PERL_IMPLICIT_SYS)
 618 PERLVAR(IMem,           struct IPerlMem*)
 619 PERLVAR(IMemShared,     struct IPerlMem*)
 620 PERLVAR(IMemParse,      struct IPerlMem*)
 621 PERLVAR(IEnv,           struct IPerlEnv*)
 622 PERLVAR(IStdIO,         struct IPerlStdIO*)
 623 PERLVAR(ILIO,           struct IPerlLIO*)
 624 PERLVAR(IDir,           struct IPerlDir*)
 625 PERLVAR(ISock,          struct IPerlSock*)
 626 PERLVAR(IProc,          struct IPerlProc*)
 627 #endif
 628
 629 PERLVAR(Iptr_table,     PTR_TBL_t*)
 630 PERLVARI(Ibeginav_save, AV*, NULL)      /* save BEGIN{}s when compiling */
 631
 632 PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
 633
 634
 635 #ifdef USE_LOCALE_NUMERIC
 636
 637 PERLVAR(Inumeric_radix_sv,      SV *)   /* The radix separator if not '.' */
 638
 639 #endif
 640
 641 #if defined(USE_ITHREADS)
 642 PERLVAR(Iregex_pad,     SV**)           /* Shortcut into the array of
 643                                            regex_padav */
 644 PERLVAR(Iregex_padav,   AV*)            /* All regex objects, indexed via the
 645                                            values in op_pmoffset of pmop.
 646                                            Entry 0 is an SV whose PV is a
 647                                            "packed" list of IVs listing
 648                                            the now-free slots in the array */
 649 #endif
 650
 651 #ifdef USE_REENTRANT_API
 652 PERLVAR(Ireentrant_buffer, REENTR*)     /* here we store the _r buffers */
 653 #endif
 654
 655 PERLVAR(Icustom_op_names, HV*)  /* Names of user defined ops */
 656 PERLVAR(Icustom_op_descs, HV*)  /* Descriptions of user defined ops */
 657
 658 #ifdef PERLIO_LAYERS
 659 PERLVARI(Iperlio, PerlIO *,NULL)
 660 PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
 661 PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
 662 #endif
 663
 664 PERLVARI(Iencoding,     SV*, NULL)              /* character encoding */
 665
 666 PERLVAR(Idebug_pad,     struct perl_debug_pad)  /* always needed because of the re extension */
 667
 668 PERLVAR(Iutf8_idstart,  SV *)
 669 PERLVAR(Iutf8_idcont,   SV *)
 670
 671 PERLVAR(Isort_RealCmp,  SVCOMPARE_t)
 672
 673 PERLVARI(Icheckav_save, AV*, NULL)      /* save CHECK{}s when compiling */
 674 PERLVARI(Iunitcheckav_save, AV*, NULL)  /* save UNITCHECK{}s when compiling */
 675
 676 PERLVARI(Iclocktick, long, 0)   /* this many times() ticks in a second */
 677
 678 PERLVAR(Isignals, U32)  /* Using which pre-5.8 signals */
 679
 680 PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
 681
 682 PERLVAR(Istashcache,    HV *)           /* Cache to speed up S_method_common */
 683
 684 /* Hooks to shared SVs and locks. */
 685 PERLVARI(Isharehook,    share_proc_t,   Perl_sv_nosharing)
 686 PERLVARI(Ilockhook,     share_proc_t,   Perl_sv_nosharing)
 687 #ifdef NO_MATHOMS
 688 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
 689 #else
 690 /* This reference ensures that the mathoms are linked with perl */
 691 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
 692 #endif
 693 PERLVARI(Iunlockhook,   share_proc_t,   PERL_UNLOCK_HOOK)
 694
 695 PERLVARI(Ithreadhook,   thrhook_proc_t, Perl_nothreadhook)
 696
 697 PERLVARI(Isignalhook,   despatch_signals_proc_t, Perl_despatch_signals)
 698
 699 PERLVARI(Ihash_seed, UV, 0)             /* Hash initializer */
 700
 701 PERLVARI(Irehash_seed, UV, 0)           /* 582 hash initializer */
 702
 703 PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
 704
 705 /* The last unconditional member of the interpreter structure when 5.10.0 was
 706    released. The offset of the end of this is baked into a global variable in
 707    any shared perl library which will allow a sanity test in future perl
 708    releases.  */
 709 #define PERL_LAST_5_10_0_INTERP_MEMBER  Iisarev
 710
 711 #ifdef PERL_IMPLICIT_CONTEXT
 712 PERLVARI(Imy_cxt_size, int, 0)          /* size of PL_my_cxt_list */
 713 PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
 714 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 715 PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
 716 #  endif
 717 #endif
 718
 719 #ifdef PERL_TRACK_MEMPOOL
 720 /* For use with the memory debugging code in util.c  */
 721 PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
 722 #endif
 723
 724 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
 725 /* File descriptor to talk to the child which dumps scalars.  */
 726 PERLVARI(Idumper_fd, int, -1)
 727 #endif
 728
 729 /* Stores the PPID */
 730 #ifdef THREADS_HAVE_PIDS
 731 PERLVARI(Ippid,         IV,             0)
 732 #endif
 733
 734 #ifdef PERL_MAD
 735 PERLVARI(Imadskills,    bool, FALSE)    /* preserve all syntactic info */
 736                                         /* (MAD = Misc Attribute Decoration) */
 737 PERLVARI(Ixmlfp, PerlIO *,NULL)
 738 #endif
 739
 740 #ifdef PL_OP_SLAB_ALLOC
 741 PERLVAR(IOpPtr,I32 **)
 742 PERLVARI(IOpSpace,I32,0)
 743 PERLVAR(IOpSlab,I32 *)
 744 #endif
 745
 746 #ifdef PERL_DEBUG_READONLY_OPS
 747 PERLVARI(Islabs, I32**, NULL)   /* Array of slabs that have been allocated */
 748 PERLVARI(Islab_count, U32, 0)   /* Size of the array */
 749 #endif
 750
 751 /* Can shared object be destroyed */
 752 PERLVARI(Idestroyhook, destroyable_proc_t, Perl_sv_destroyable)
 753
 754 #ifdef DEBUG_LEAKING_SCALARS
 755 PERLVARI(Isv_serial, U32, 0) /* SV serial number, used in sv.c */
 756 #endif
 757
 758 /* Register of known Method Resolution Orders.
 759    What this actually points to is an implementation detail (it may change to
 760    a structure incorporating a reference count - use mro_get_from_name to
 761    retrieve a C<struct mro_alg *>  */
 762 PERLVAR(Iregistered_mros, HV *)
 763
 764 /* Compile-time block start/end hooks */
 765 PERLVAR(Iblockhooks, AV *)
 766
 767 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
 768  * above on where there are gaps which currently will be structure padding.  */
 769
 770 /* Within a stable branch, new variables must be added to the very end, before
 771  * this comment, for binary compatibility (the offsets of the old members must
 772  *  not change).
 773  * (Don't forget to add your variable also to perl_clone()!)
 774  * XSUB.h provides wrapper functions via perlapi.h that make this
 775  * irrelevant, but not all code may be expected to #include XSUB.h.
 776  */