intrpvar.h

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