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