intrpvar.h

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