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 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(Idoextract,     bool)
 299 PERLVAR(Isawampersand,  bool)           /* must save all match strings */
 300 PERLVAR(Iunsafe,        bool)
 301 PERLVAR(Iexit_flags,    U8)             /* was exit() unexpected, etc. */
 302 PERLVAR(Isrand_called,  bool)
 303 /* Part of internal state, but makes the 16th 1 byte variable in a row.  */
 304 PERLVAR(Itainting,      bool)           /* doing taint checks */
 305 PERLVARI(Iin_load_module, bool, FALSE)  /* to prevent recursions in PerlIO_find_layer */
 306 PERLVAR(Iinplace,       char *)
 307 PERLVAR(Ie_script,      SV *)
 308
 309 /* magical thingies */
 310 PERLVAR(Ibasetime,      Time_t)         /* $^T */
 311 PERLVAR(Iformfeed,      SV *)           /* $^L */
 312
 313
 314 PERLVARI(Imaxsysfd,     I32,    MAXSYSFD)
 315                                         /* top fd to pass to subprocesses */
 316 PERLVAR(Istatusvalue,   I32)            /* $? */
 317 #ifdef VMS
 318 PERLVAR(Istatusvalue_vms,U32)
 319 #else
 320 PERLVAR(Istatusvalue_posix,I32)
 321 #endif
 322
 323 PERLVARI(Isig_pending, int,0)           /* Number if highest signal pending */
 324 PERLVAR(Ipsig_pend, int *)              /* per-signal "count" of pending */
 325
 326 /* shortcuts to various I/O objects */
 327 PERLVAR(Istdingv,       GV *)           /*  *STDIN      */
 328 PERLVAR(Istderrgv,      GV *)           /*  *STDERR     */
 329 PERLVAR(Idefgv,         GV *)
 330 PERLVAR(Iargvgv,        GV *)           /*  *ARGV       */
 331 PERLVAR(Iargvoutgv,     GV *)           /*  *ARGVOUT    */
 332 PERLVAR(Iargvout_stack, AV *)
 333
 334 /* shortcuts to regexp stuff */
 335 PERLVAR(Ireplgv,        GV *)           /*  *^R         */
 336
 337 /* shortcuts to misc objects */
 338 PERLVAR(Ierrgv,         GV *)           /*  *@          */
 339
 340 /* shortcuts to debugging objects */
 341 PERLVAR(IDBgv,          GV *)           /*  *DB::DB     */
 342 PERLVAR(IDBline,        GV *)           /*  *DB::line   */
 343
 344 /*
 345 =for apidoc mn|GV *|PL_DBsub
 346 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
 347 the SV which holds the name of the sub being debugged.  This is the C
 348 variable which corresponds to Perl's $DB::sub variable.  See
 349 C<PL_DBsingle>.
 350
 351 =for apidoc mn|SV *|PL_DBsingle
 352 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
 353 boolean which indicates whether subs are being single-stepped.
 354 Single-stepping is automatically turned on after every step.  This is the C
 355 variable which corresponds to Perl's $DB::single variable.  See
 356 C<PL_DBsub>.
 357
 358 =for apidoc mn|SV *|PL_DBtrace
 359 Trace variable used when Perl is run in debugging mode, with the B<-d>
 360 switch.  This is the C variable which corresponds to Perl's $DB::trace
 361 variable.  See C<PL_DBsingle>.
 362
 363 =cut
 364 */
 365
 366 PERLVAR(IDBsub,         GV *)           /*  *DB::sub    */
 367 PERLVAR(IDBsingle,      SV *)           /*  $DB::single */
 368 PERLVAR(IDBtrace,       SV *)           /*  $DB::trace  */
 369 PERLVAR(IDBsignal,      SV *)           /*  $DB::signal */
 370 PERLVAR(Idbargs,        AV *)           /* args to call listed by caller function */
 371
 372 /* symbol tables */
 373 PERLVAR(Idebstash,      HV *)           /* symbol table for perldb package */
 374 PERLVAR(Iglobalstash,   HV *)           /* global keyword overrides imported here */
 375 PERLVAR(Icurstname,     SV *)           /* name of current package */
 376 PERLVAR(Ibeginav,       AV *)           /* names of BEGIN subroutines */
 377 PERLVAR(Iendav,         AV *)           /* names of END subroutines */
 378 PERLVAR(Iunitcheckav,   AV *)           /* names of UNITCHECK subroutines */
 379 PERLVAR(Icheckav,       AV *)           /* names of CHECK subroutines */
 380 PERLVAR(Iinitav,        AV *)           /* names of INIT subroutines */
 381 PERLVAR(Istrtab,        HV *)           /* shared string table */
 382 PERLVARI(Isub_generation,U32,1)         /* incr to invalidate method cache */
 383
 384 /* funky return mechanisms */
 385 PERLVAR(Iforkprocess,   int)            /* so do_open |- can return proc# */
 386
 387 /* memory management */
 388 PERLVAR(Isv_count,      I32)            /* how many SV* are currently allocated */
 389 PERLVAR(Isv_objcount,   I32)            /* how many objects are currently allocated */
 390 PERLVAR(Isv_root,       SV*)            /* storage for SVs belonging to interp */
 391 PERLVAR(Isv_arenaroot,  SV*)            /* list of areas for garbage collection */
 392
 393 /* subprocess state */
 394 PERLVAR(Ifdpid,         AV *)           /* keep fd-to-pid mappings for my_popen */
 395
 396 /* internal state */
 397 PERLVARI(Iop_mask,      char *, NULL)   /* masked operations for safe evals */
 398
 399 /* current interpreter roots */
 400 PERLVAR(Imain_cv,       CV *)
 401 PERLVAR(Imain_root,     OP *)
 402 PERLVAR(Imain_start,    OP *)
 403 PERLVAR(Ieval_root,     OP *)
 404 PERLVAR(Ieval_start,    OP *)
 405
 406 /* runtime control stuff */
 407 PERLVARI(Icurcopdb,     COP *,  NULL)
 408
 409 PERLVAR(Ifilemode,      int)            /* so nextargv() can preserve mode */
 410 PERLVAR(Ilastfd,        int)            /* what to preserve mode on */
 411 PERLVAR(Ioldname,       char *)         /* what to preserve mode on */
 412 PERLVAR(IArgv,          const char **)  /* stuff to free from do_aexec, vfork safe */
 413 PERLVAR(ICmd,           char *)         /* stuff to free from do_aexec, vfork safe */
 414 /* Elements in this array have ';' appended and are injected as a single line
 415    into the tokeniser. You can't put any (literal) newlines into any program
 416    you stuff in into this array, as the point where it's injected is expecting
 417    a single physical line. */
 418 PERLVAR(Ipreambleav,    AV *)
 419 PERLVAR(Imess_sv,       SV *)
 420 PERLVAR(Iors_sv,        SV *)           /* output record separator $\ */
 421 /* statics moved here for shared library purposes */
 422 PERLVARI(Igensym,       I32,    0)      /* next symbol for getsym() to define */
 423 PERLVARI(Icv_has_eval, bool, FALSE) /* PL_compcv includes an entereval or similar */
 424 PERLVAR(Itaint_warn,    bool)      /* taint warns instead of dying */
 425 PERLVARI(Ilaststype,    U16,    OP_STAT)
 426 PERLVARI(Ilaststatval,  int,    -1)
 427
 428 /* interpreter atexit processing */
 429 PERLVARI(Iexitlistlen,  I32, 0)         /* length of same */
 430 PERLVARI(Iexitlist,     PerlExitListEntry *, NULL)
 431                                         /* list of exit functions */
 432
 433 /*
 434 =for apidoc Amn|HV*|PL_modglobal
 435
 436 C<PL_modglobal> is a general purpose, interpreter global HV for use by
 437 extensions that need to keep information on a per-interpreter basis.
 438 In a pinch, it can also be used as a symbol table for extensions
 439 to share data among each other.  It is a good idea to use keys
 440 prefixed by the package name of the extension that owns the data.
 441
 442 =cut
 443 */
 444
 445 PERLVAR(Imodglobal,     HV *)           /* per-interp module data */
 446
 447 /* these used to be in global before 5.004_68 */
 448 PERLVARI(Iprofiledata,  U32 *,  NULL)   /* table of ops, counts */
 449
 450 PERLVAR(Icompiling,     COP)            /* compiling/done executing marker */
 451
 452 PERLVAR(Icompcv,        CV *)           /* currently compiling subroutine */
 453 PERLVAR(Icomppad,       AV *)           /* storage for lexically scoped temporaries */
 454 PERLVAR(Icomppad_name,  AV *)           /* variable names for "my" variables */
 455 PERLVAR(Icomppad_name_fill,     I32)    /* last "introduced" variable offset */
 456 PERLVAR(Icomppad_name_floor,    I32)    /* start of vars in innermost block */
 457
 458 #ifdef HAVE_INTERP_INTERN
 459 PERLVAR(Isys_intern,    struct interp_intern)
 460                                         /* platform internals */
 461 #endif
 462
 463 /* more statics moved here */
 464 PERLVAR(IDBcv,          CV *)           /* from perl.c */
 465 PERLVARI(Igeneration,   int,    100)    /* from op.c */
 466
 467 PERLVARI(Iin_clean_objs,bool,    FALSE) /* from sv.c */
 468 PERLVARI(Iin_clean_all, bool,    FALSE) /* ptrs to freed SVs now legal */
 469 PERLVAR(Inomemok,       bool)           /* let malloc context handle nomem */
 470 PERLVARI(Isavebegin,     bool,  FALSE)  /* save BEGINs for compiler     */
 471
 472 PERLVAR(Iuid,           Uid_t)          /* current real user id */
 473 PERLVAR(Ieuid,          Uid_t)          /* current effective user id */
 474 PERLVAR(Igid,           Gid_t)          /* current real group id */
 475 PERLVAR(Iegid,          Gid_t)          /* current effective group id */
 476 PERLVARI(Ian,           U32,    0)      /* malloc sequence number */
 477 PERLVARI(Icop_seqmax,   U32,    0)      /* statement sequence number */
 478 PERLVARI(Ievalseq,      U32,    0)      /* eval sequence number */
 479 PERLVAR(Iorigalen,      U32)
 480 PERLVAR(Iorigenviron,   char **)
 481 #ifdef PERL_USES_PL_PIDSTATUS
 482 PERLVAR(Ipidstatus,     HV *)           /* pid-to-status mappings for waitpid */
 483 #endif
 484 PERLVAR(Iosname,        char *)         /* operating system */
 485
 486 PERLVAR(Isighandlerp,   Sighandler_t)
 487
 488 PERLVARA(Ibody_roots,   PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
 489
 490 PERLVAR(Iunicode, U32)  /* Unicode features: $ENV{PERL_UNICODE} or -C */
 491
 492 PERLVARI(Imaxo, int,    MAXO)           /* maximum number of ops */
 493
 494 PERLVARI(Irunops,       runops_proc_t,  RUNOPS_DEFAULT)
 495
 496 /*
 497 =for apidoc Amn|SV|PL_sv_undef
 498 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
 499
 500 =for apidoc Amn|SV|PL_sv_no
 501 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
 502 C<&PL_sv_no>.
 503
 504 =for apidoc Amn|SV|PL_sv_yes
 505 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
 506 C<&PL_sv_yes>.
 507
 508 =cut
 509 */
 510
 511 PERLVAR(Isv_undef,      SV)
 512 PERLVAR(Isv_no,         SV)
 513 PERLVAR(Isv_yes,        SV)
 514
 515 PERLVAR(Isubname,       SV *)           /* name of current subroutine */
 516
 517 PERLVAR(Isubline,       I32)            /* line this subroutine began on */
 518 PERLVAR(Imin_intro_pending,     I32)    /* start of vars to introduce */
 519
 520 PERLVAR(Imax_intro_pending,     I32)    /* end of vars to introduce */
 521 PERLVAR(Ipadix,         I32)            /* max used index in current "register" pad */
 522
 523 PERLVAR(Ipadix_floor,   I32)            /* how low may inner block reset padix */
 524
 525 PERLVAR(Ihints,         U32)            /* pragma-tic compile-time flags */
 526
 527 PERLVAR(Idebug,         VOL U32)        /* flags given to -D switch */
 528
 529 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
 530 PERLVARI(Ibreakable_sub_gen, U32, 0)
 531
 532 PERLVARI(Iamagic_generation,    long,   0)
 533
 534 #ifdef USE_LOCALE_COLLATE
 535 PERLVAR(Icollation_name,char *)         /* Name of current collation */
 536 PERLVAR(Icollxfrm_base, Size_t)         /* Basic overhead in *xfrm() */
 537 PERLVARI(Icollxfrm_mult,Size_t, 2)      /* Expansion factor in *xfrm() */
 538 PERLVARI(Icollation_ix, U32,    0)      /* Collation generation index */
 539 PERLVARI(Icollation_standard, bool,     TRUE)
 540                                         /* Assume simple collation */
 541 #endif /* USE_LOCALE_COLLATE */
 542
 543
 544 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
 545 #  define PERL___I -1
 546 #else
 547 #  define PERL___I 1
 548 #endif
 549 PERLVARI(Iutf8cache, I8, PERL___I)      /* Is the utf8 caching code enabled? */
 550 #undef PERL___I
 551
 552
 553 #ifdef USE_LOCALE_NUMERIC
 554
 555 PERLVARI(Inumeric_standard,     bool,   TRUE)
 556                                         /* Assume simple numerics */
 557 PERLVARI(Inumeric_local,        bool,   TRUE)
 558                                         /* Assume local numerics */
 559 PERLVAR(Inumeric_name,  char *)         /* Name of current numeric locale */
 560 #endif /* !USE_LOCALE_NUMERIC */
 561
 562 /* utf8 character classes */
 563 PERLVAR(Iutf8_alnum,    SV *)
 564 PERLVAR(Iutf8_ascii,    SV *)
 565 PERLVAR(Iutf8_alpha,    SV *)
 566 PERLVAR(Iutf8_space,    SV *)
 567 PERLVAR(Iutf8_perl_space,       SV *)
 568 PERLVAR(Iutf8_perl_word,        SV *)
 569 PERLVAR(Iutf8_posix_digit,      SV *)
 570 PERLVAR(Iutf8_cntrl,    SV *)
 571 PERLVAR(Iutf8_graph,    SV *)
 572 PERLVAR(Iutf8_digit,    SV *)
 573 PERLVAR(Iutf8_upper,    SV *)
 574 PERLVAR(Iutf8_lower,    SV *)
 575 PERLVAR(Iutf8_print,    SV *)
 576 PERLVAR(Iutf8_punct,    SV *)
 577 PERLVAR(Iutf8_xdigit,   SV *)
 578 PERLVAR(Iutf8_mark,     SV *)
 579 PERLVAR(Iutf8_X_begin,  SV *)
 580 PERLVAR(Iutf8_X_extend, SV *)
 581 PERLVAR(Iutf8_X_prepend,        SV *)
 582 PERLVAR(Iutf8_X_non_hangul,     SV *)
 583 PERLVAR(Iutf8_X_L,      SV *)
 584 PERLVAR(Iutf8_X_LV,     SV *)
 585 PERLVAR(Iutf8_X_LVT,    SV *)
 586 PERLVAR(Iutf8_X_T,      SV *)
 587 PERLVAR(Iutf8_X_V,      SV *)
 588 PERLVAR(Iutf8_X_LV_LVT_V,       SV *)
 589 PERLVAR(Iutf8_toupper,  SV *)
 590 PERLVAR(Iutf8_totitle,  SV *)
 591 PERLVAR(Iutf8_tolower,  SV *)
 592 PERLVAR(Iutf8_tofold,   SV *)
 593 PERLVAR(Ilast_swash_hv, HV *)
 594 PERLVAR(Ilast_swash_tmps,       U8 *)
 595 PERLVAR(Ilast_swash_slen,       STRLEN)
 596 PERLVARA(Ilast_swash_key,10,    U8)
 597 PERLVAR(Ilast_swash_klen,       U8)     /* Only needs to store 0-10  */
 598
 599 #ifdef FCRYPT
 600 PERLVARI(Icryptseen,    bool,   FALSE)  /* has fast crypt() been initialized? */
 601 #endif
 602
 603 PERLVAR(Ipad_reset_pending,     bool)   /* reset pad on next attempted alloc */
 604
 605 PERLVARI(Iglob_index,   int,    0)
 606
 607
 608 PERLVAR(Iparser,        yy_parser *)    /* current parser state */
 609
 610 /* Array of signal handlers, indexed by signal number, through which the C
 611    signal handler dispatches.  */
 612 PERLVAR(Ipsig_ptr, SV**)
 613 /* Array of names of signals, indexed by signal number, for (re)use as the first
 614    argument to a signal handler.   Only one block of memory is allocated for
 615    both psig_name and psig_ptr.  */
 616 PERLVAR(Ipsig_name, SV**)
 617
 618 #if defined(PERL_IMPLICIT_SYS)
 619 PERLVAR(IMem,           struct IPerlMem*)
 620 PERLVAR(IMemShared,     struct IPerlMem*)
 621 PERLVAR(IMemParse,      struct IPerlMem*)
 622 PERLVAR(IEnv,           struct IPerlEnv*)
 623 PERLVAR(IStdIO,         struct IPerlStdIO*)
 624 PERLVAR(ILIO,           struct IPerlLIO*)
 625 PERLVAR(IDir,           struct IPerlDir*)
 626 PERLVAR(ISock,          struct IPerlSock*)
 627 PERLVAR(IProc,          struct IPerlProc*)
 628 #endif
 629
 630 PERLVAR(Iptr_table,     PTR_TBL_t*)
 631 PERLVARI(Ibeginav_save, AV*, NULL)      /* save BEGIN{}s when compiling */
 632
 633 PERLVAR(Ibody_arenas, void*) /* pointer to list of body-arenas */
 634
 635
 636 #ifdef USE_LOCALE_NUMERIC
 637
 638 PERLVAR(Inumeric_radix_sv,      SV *)   /* The radix separator if not '.' */
 639
 640 #endif
 641
 642 #if defined(USE_ITHREADS)
 643 PERLVAR(Iregex_pad,     SV**)           /* Shortcut into the array of
 644                                            regex_padav */
 645 PERLVAR(Iregex_padav,   AV*)            /* All regex objects, indexed via the
 646                                            values in op_pmoffset of pmop.
 647                                            Entry 0 is an SV whose PV is a
 648                                            "packed" list of IVs listing
 649                                            the now-free slots in the array */
 650 #endif
 651
 652 #ifdef USE_REENTRANT_API
 653 PERLVAR(Ireentrant_buffer, REENTR*)     /* here we store the _r buffers */
 654 #endif
 655
 656 PERLVAR(Icustom_op_names, HV*)  /* Names of user defined ops */
 657 PERLVAR(Icustom_op_descs, HV*)  /* Descriptions of user defined ops */
 658
 659 #ifdef PERLIO_LAYERS
 660 PERLVARI(Iperlio, PerlIO *,NULL)
 661 PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
 662 PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
 663 #endif
 664
 665 PERLVARI(Iencoding,     SV*, NULL)              /* character encoding */
 666
 667 PERLVAR(Idebug_pad,     struct perl_debug_pad)  /* always needed because of the re extension */
 668
 669 PERLVAR(Iutf8_idstart,  SV *)
 670 PERLVAR(Iutf8_idcont,   SV *)
 671
 672 PERLVAR(Isort_RealCmp,  SVCOMPARE_t)
 673
 674 PERLVARI(Icheckav_save, AV*, NULL)      /* save CHECK{}s when compiling */
 675 PERLVARI(Iunitcheckav_save, AV*, NULL)  /* save UNITCHECK{}s when compiling */
 676
 677 PERLVARI(Iclocktick, long, 0)   /* this many times() ticks in a second */
 678
 679 PERLVAR(Isignals, U32)  /* Using which pre-5.8 signals */
 680
 681 PERLVAR(Ireentrant_retint, int) /* Integer return value from reentrant functions */
 682
 683 PERLVAR(Istashcache,    HV *)           /* Cache to speed up S_method_common */
 684
 685 /* Hooks to shared SVs and locks. */
 686 PERLVARI(Isharehook,    share_proc_t,   Perl_sv_nosharing)
 687 PERLVARI(Ilockhook,     share_proc_t,   Perl_sv_nosharing)
 688 #ifdef NO_MATHOMS
 689 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
 690 #else
 691 /* This reference ensures that the mathoms are linked with perl */
 692 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
 693 #endif
 694 PERLVARI(Iunlockhook,   share_proc_t,   PERL_UNLOCK_HOOK)
 695
 696 PERLVARI(Ithreadhook,   thrhook_proc_t, Perl_nothreadhook)
 697
 698 PERLVARI(Isignalhook,   despatch_signals_proc_t, Perl_despatch_signals)
 699
 700 PERLVARI(Ihash_seed, UV, 0)             /* Hash initializer */
 701
 702 PERLVARI(Irehash_seed, UV, 0)           /* 582 hash initializer */
 703
 704 PERLVARI(Iisarev, HV*, NULL) /* Reverse map of @ISA dependencies */
 705
 706 /* The last unconditional member of the interpreter structure when 5.10.0 was
 707    released. The offset of the end of this is baked into a global variable in
 708    any shared perl library which will allow a sanity test in future perl
 709    releases.  */
 710 #define PERL_LAST_5_10_0_INTERP_MEMBER  Iisarev
 711
 712 #ifdef PERL_IMPLICIT_CONTEXT
 713 PERLVARI(Imy_cxt_size, int, 0)          /* size of PL_my_cxt_list */
 714 PERLVARI(Imy_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
 715 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
 716 PERLVARI(Imy_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
 717 #  endif
 718 #endif
 719
 720 #ifdef PERL_TRACK_MEMPOOL
 721 /* For use with the memory debugging code in util.c  */
 722 PERLVAR(Imemory_debug_header, struct perl_memory_debug_header)
 723 #endif
 724
 725 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
 726 /* File descriptor to talk to the child which dumps scalars.  */
 727 PERLVARI(Idumper_fd, int, -1)
 728 #endif
 729
 730 /* Stores the PPID */
 731 #ifdef THREADS_HAVE_PIDS
 732 PERLVARI(Ippid,         IV,             0)
 733 #endif
 734
 735 #ifdef PERL_MAD
 736 PERLVARI(Imadskills,    bool, FALSE)    /* preserve all syntactic info */
 737                                         /* (MAD = Misc Attribute Decoration) */
 738 PERLVARI(Ixmlfp, PerlIO *,NULL)
 739 #endif
 740
 741 #ifdef PL_OP_SLAB_ALLOC
 742 PERLVAR(IOpPtr,I32 **)
 743 PERLVARI(IOpSpace,I32,0)
 744 PERLVAR(IOpSlab,I32 *)
 745 #endif
 746
 747 #ifdef PERL_DEBUG_READONLY_OPS
 748 PERLVARI(Islabs, I32**, NULL)   /* Array of slabs that have been allocated */
 749 PERLVARI(Islab_count, U32, 0)   /* Size of the array */
 750 #endif
 751
 752 /* Can shared object be destroyed */
 753 PERLVARI(Idestroyhook, destroyable_proc_t, Perl_sv_destroyable)
 754
 755 #ifdef DEBUG_LEAKING_SCALARS
 756 PERLVARI(Isv_serial, U32, 0) /* SV serial number, used in sv.c */
 757 #endif
 758
 759 /* Register of known Method Resolution Orders.
 760    What this actually points to is an implementation detail (it may change to
 761    a structure incorporating a reference count - use mro_get_from_name to
 762    retrieve a C<struct mro_alg *>  */
 763 PERLVAR(Iregistered_mros, HV *)
 764
 765 /* Compile-time block start/end hooks */
 766 PERLVAR(Iblockhooks, AV *)
 767
 768 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
 769  * above on where there are gaps which currently will be structure padding.  */
 770
 771 /* Within a stable branch, new variables must be added to the very end, before
 772  * this comment, for binary compatibility (the offsets of the old members must
 773  *  not change).
 774  * (Don't forget to add your variable also to perl_clone()!)
 775  * XSUB.h provides wrapper functions via perlapi.h that make this
 776  * irrelevant, but not all code may be expected to #include XSUB.h.
 777  */