This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
5.9.1 suidperl
[perl5.git] / intrpvar.h
index 606a892..a477777 100644 (file)
@@ -4,14 +4,17 @@
 
 /* Don't forget to re-run embed.pl to propagate changes! */
 
+/* New variables must be added to the very end for binary compatibility.
+ * XSUB.h provides wrapper functions via perlapi.h that make this
+ * irrelevant, but not all code may be expected to #include XSUB.h. */
+
+/* Don't forget to add your variable also to perl_clone()! */
+
 /* The 'I' prefix is only needed for vars that need appropriate #defines
  * generated when built with or without MULTIPLICITY.  It is also used
  * to generate the appropriate export list for win32.
  *
- * When building without MULTIPLICITY, these variables will be truly global.
- *
- * Avoid build-specific #ifdefs here, like DEBUGGING.  That way,
- * we can keep binary compatibility of the curinterp structure */
+ * When building without MULTIPLICITY, these variables will be truly global. */
 
 /* pseudo environmental stuff */
 PERLVAR(Iorigargc,     int)
@@ -35,7 +38,19 @@ PERLVAR(Iminus_l,    bool)
 PERLVAR(Iminus_a,      bool)
 PERLVAR(Iminus_F,      bool)
 PERLVAR(Idoswitches,   bool)
-PERLVAR(Idowarn,       bool)
+
+/*
+=head1 Global Variables
+
+=for apidoc mn|bool|PL_dowarn
+
+The C variable which corresponds to Perl's $^W warning variable.
+
+=cut
+*/
+
+PERLVAR(Idowarn,       U8)
+PERLVAR(Iwidesyscalls, bool)           /* unused since 5.8.1 */
 PERLVAR(Idoextract,    bool)
 PERLVAR(Isawampersand, bool)           /* must save all match strings */
 PERLVAR(Iunsafe,       bool)
@@ -71,7 +86,7 @@ PERLVAR(Iargvout_stack,       AV *)
 
 /* shortcuts to regexp stuff */
 /* this one needs to be moved to thrdvar.h and accessed via
- * find_threadsv() when USE_THREADS */
+ * find_threadsv() when USE_5005THREADS */
 PERLVAR(Ireplgv,       GV *)
 
 /* shortcuts to misc objects */
@@ -80,6 +95,29 @@ PERLVAR(Ierrgv,              GV *)
 /* shortcuts to debugging objects */
 PERLVAR(IDBgv,         GV *)
 PERLVAR(IDBline,       GV *)
+
+/*
+=for apidoc mn|GV *|PL_DBsub
+When Perl is run in debugging mode, with the B<-d> switch, this GV contains
+the SV which holds the name of the sub being debugged.  This is the C
+variable which corresponds to Perl's $DB::sub variable.  See
+C<PL_DBsingle>.
+
+=for apidoc mn|SV *|PL_DBsingle
+When Perl is run in debugging mode, with the B<-d> switch, this SV is a
+boolean which indicates whether subs are being single-stepped.
+Single-stepping is automatically turned on after every step.  This is the C
+variable which corresponds to Perl's $DB::single variable.  See
+C<PL_DBsub>.
+
+=for apidoc mn|SV *|PL_DBtrace
+Trace variable used when Perl is run in debugging mode, with the B<-d>
+switch.  This is the C variable which corresponds to Perl's $DB::trace
+variable.  See C<PL_DBsingle>.
+
+=cut
+*/
+
 PERLVAR(IDBsub,                GV *)
 PERLVAR(IDBsingle,     SV *)
 PERLVAR(IDBtrace,      SV *)
@@ -93,7 +131,7 @@ PERLVAR(Iglobalstash,        HV *)           /* global keyword overrides imported here */
 PERLVAR(Icurstname,    SV *)           /* name of current package */
 PERLVAR(Ibeginav,      AV *)           /* names of BEGIN subroutines */
 PERLVAR(Iendav,                AV *)           /* names of END subroutines */
-PERLVAR(Istopav,       AV *)           /* names of STOP subroutines */
+PERLVAR(Icheckav,      AV *)           /* names of CHECK subroutines */
 PERLVAR(Iinitav,       AV *)           /* names of INIT subroutines */
 PERLVAR(Istrtab,       HV *)           /* shared string table */
 PERLVARI(Isub_generation,U32,1)                /* incr to invalidate method cache */
@@ -131,7 +169,7 @@ PERLVAR(Ilastfd,    int)            /* what to preserve mode on */
 PERLVAR(Ioldname,      char *)         /* what to preserve mode on */
 PERLVAR(IArgv,         char **)        /* stuff to free from do_aexec, vfork safe */
 PERLVAR(ICmd,          char *)         /* stuff to free from do_aexec, vfork safe */
-PERLVAR(Igensym,       I32)            /* next symbol for getsym() to define */
+PERLVARI(Igensym,      I32,    0)      /* next symbol for getsym() to define */
 PERLVAR(Ipreambled,    bool)
 PERLVAR(Ipreambleav,   AV *)
 PERLVARI(Ilaststatval, int,    -1)
@@ -139,14 +177,26 @@ PERLVARI(Ilaststype,      I32,    OP_STAT)
 PERLVAR(Imess_sv,      SV *)
 
 /* XXX shouldn't these be per-thread? --GSAR */
-PERLVAR(Iors,          char *)         /* output record separator $\ */
-PERLVAR(Iorslen,       STRLEN)
+PERLVAR(Iors_sv,       SV *)           /* output record separator $\ */
 PERLVAR(Iofmt,         char *)         /* output format for numbers $# */
 
 /* interpreter atexit processing */
 PERLVARI(Iexitlist,    PerlExitListEntry *, NULL)
                                        /* list of exit functions */
 PERLVARI(Iexitlistlen, I32, 0)         /* length of same */
+
+/*
+=for apidoc Amn|HV*|PL_modglobal
+
+C<PL_modglobal> is a general purpose, interpreter global HV for use by
+extensions that need to keep information on a per-interpreter basis.
+In a pinch, it can also be used as a symbol table for extensions
+to share data among each other.  It is a good idea to use keys
+prefixed by the package name of the extension that owns the data.
+
+=cut
+*/
+
 PERLVAR(Imodglobal,    HV *)           /* per-interp module data */
 
 /* these used to be in global before 5.004_68 */
@@ -178,43 +228,39 @@ PERLVAR(Ilinestart,       char *)         /* beg. of most recently read line */
 PERLVAR(Ipending_ident,        char)           /* pending identifier lookup */
 PERLVAR(Isublex_info,  SUBLEXINFO)     /* from toke.c */
 
-#ifdef USE_THREADS
-PERLVAR(Ithrsv,                SV *)           /* struct perl_thread for main thread */
-PERLVARI(Ithreadnum,   U32,    0)      /* incremented each thread creation */
-PERLVAR(Istrtab_mutex, perl_mutex)     /* Mutex for string table access */
-#endif /* USE_THREADS */
-
 PERLVAR(Iuid,          Uid_t)          /* current real user id */
 PERLVAR(Ieuid,         Uid_t)          /* current effective user id */
 PERLVAR(Igid,          Gid_t)          /* current real group id */
 PERLVAR(Iegid,         Gid_t)          /* current effective group id */
 PERLVAR(Inomemok,      bool)           /* let malloc context handle nomem */
-PERLVAR(Ian,           U32)            /* malloc sequence number */
-PERLVAR(Icop_seqmax,   U32)            /* statement sequence number */
-PERLVAR(Iop_seqmax,    U16)            /* op sequence number */
-PERLVAR(Ievalseq,      U32)            /* eval sequence number */
+PERLVARI(Ian,          U32,    0)      /* malloc sequence number */
+PERLVARI(Icop_seqmax,  U32,    0)      /* statement sequence number */
+PERLVARI(Ievalseq,     U32,    0)      /* eval sequence number */
 PERLVAR(Iorigenviron,  char **)
 PERLVAR(Iorigalen,     U32)
 PERLVAR(Ipidstatus,    HV *)           /* pid-to-status mappings for waitpid */
 PERLVARI(Imaxo,        int,    MAXO)           /* maximum number of ops */
 PERLVAR(Iosname,       char *)         /* operating system */
-PERLVARI(Ish_path,     char *, SH_PATH)/* full path of shell */
+
+/* For binary compatibility with older versions only */
+PERLVARI(Ish_path_compat,      char *, SH_PATH)/* full path of shell */
+
 PERLVAR(Isighandlerp,  Sighandler_t)
 
 PERLVAR(Ixiv_arenaroot,        XPV*)           /* list of allocated xiv areas */
-PERLVAR(Ixiv_root,     IV *)           /* free xiv list--shared by interpreters */
-PERLVAR(Ixnv_root,     NV *)           /* free xnv list--shared by interpreters */
-PERLVAR(Ixrv_root,     XRV *)          /* free xrv list--shared by interpreters */
-PERLVAR(Ixpv_root,     XPV *)          /* free xpv list--shared by interpreters */
-PERLVAR(Ixpviv_root,   XPVIV *)        /* free xpviv list--shared by interpreters */
-PERLVAR(Ixpvnv_root,   XPVNV *)        /* free xpvnv list--shared by interpreters */
-PERLVAR(Ixpvcv_root,   XPVCV *)        /* free xpvcv list--shared by interpreters */
-PERLVAR(Ixpvav_root,   XPVAV *)        /* free xpvav list--shared by interpreters */
-PERLVAR(Ixpvhv_root,   XPVHV *)        /* free xpvhv list--shared by interpreters */
-PERLVAR(Ixpvmg_root,   XPVMG *)        /* free xpvmg list--shared by interpreters */
-PERLVAR(Ixpvlv_root,   XPVLV *)        /* free xpvlv list--shared by interpreters */
-PERLVAR(Ixpvbm_root,   XPVBM *)        /* free xpvbm list--shared by interpreters */
-PERLVAR(Ihe_root,      HE *)           /* free he list--shared by interpreters */
+PERLVAR(Ixiv_root,     IV *)           /* free xiv list */
+PERLVAR(Ixnv_root,     NV *)           /* free xnv list */
+PERLVAR(Ixrv_root,     XRV *)          /* free xrv list */
+PERLVAR(Ixpv_root,     XPV *)          /* free xpv list */
+PERLVAR(Ixpviv_root,   XPVIV *)        /* free xpviv list */
+PERLVAR(Ixpvnv_root,   XPVNV *)        /* free xpvnv list */
+PERLVAR(Ixpvcv_root,   XPVCV *)        /* free xpvcv list */
+PERLVAR(Ixpvav_root,   XPVAV *)        /* free xpvav list */
+PERLVAR(Ixpvhv_root,   XPVHV *)        /* free xpvhv list */
+PERLVAR(Ixpvmg_root,   XPVMG *)        /* free xpvmg list */
+PERLVAR(Ixpvlv_root,   XPVLV *)        /* free xpvlv list */
+PERLVAR(Ixpvbm_root,   XPVBM *)        /* free xpvbm list */
+PERLVAR(Ihe_root,      HE *)           /* free he list */
 PERLVAR(Inice_chunk,   char *)         /* a nice chunk of memory to reuse */
 PERLVAR(Inice_chunk_size,      U32)    /* how nice the chunk of memory is */
 
@@ -222,13 +268,28 @@ PERLVARI(Irunops, runops_proc_t,  MEMBER_TO_FPTR(RUNOPS_DEFAULT))
 
 PERLVARA(Itokenbuf,256,        char)
 
+/*
+=for apidoc Amn|SV|PL_sv_undef
+This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
+
+=for apidoc Amn|SV|PL_sv_no
+This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
+C<&PL_sv_no>.
+
+=for apidoc Amn|SV|PL_sv_yes
+This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
+C<&PL_sv_yes>.
+
+=cut
+*/
+
 PERLVAR(Isv_undef,     SV)
 PERLVAR(Isv_no,                SV)
 PERLVAR(Isv_yes,       SV)
 
 #ifdef CSH
 PERLVARI(Icshname,     char *, CSH)
-PERLVAR(Icshlen,       I32)
+PERLVARI(Icshlen,      I32,    0)
 #endif
 
 PERLVAR(Ilex_state,    U32)            /* next token is determined */
@@ -280,17 +341,17 @@ PERLVAR(Ilast_lop_op,     OPCODE)         /* last list operator */
 PERLVAR(Iin_my,                I32)            /* we're compiling a "my" (or "our") declaration */
 PERLVAR(Iin_my_stash,  HV *)           /* declared class of this "my" declaration */
 #ifdef FCRYPT
-PERLVAR(Icryptseen,    bool)           /* has fast crypt() been initialized? */
+PERLVARI(Icryptseen,   bool,   FALSE)  /* has fast crypt() been initialized? */
 #endif
 
 PERLVAR(Ihints,                U32)            /* pragma-tic compile-time flags */
 
 PERLVAR(Idebug,                VOL U32)        /* flags given to -D switch */
 
-PERLVAR(Iamagic_generation,    long)
+PERLVARI(Iamagic_generation,   long,   0)
 
 #ifdef USE_LOCALE_COLLATE
-PERLVAR(Icollation_ix, U32)            /* Collation generation index */
+PERLVARI(Icollation_ix,        U32,    0)      /* Collation generation index */
 PERLVAR(Icollation_name,char *)                /* Name of current collation */
 PERLVARI(Icollation_standard, bool,    TRUE)
                                        /* Assume simple collation */
@@ -305,9 +366,9 @@ PERLVARI(Inumeric_standard, bool,   TRUE)
                                        /* Assume simple numerics */
 PERLVARI(Inumeric_local,       bool,   TRUE)
                                        /* Assume local numerics */
-PERLVAR(Inumeric_radix,                char)
-                                       /* The radix character if not '.' */
 
+PERLVAR(Inumeric_compat1,              char)
+                                       /* Used to be numeric_radix */
 #endif /* !USE_LOCALE_NUMERIC */
 
 /* utf8 character classes */
@@ -328,6 +389,7 @@ PERLVAR(Iutf8_mark, SV *)
 PERLVAR(Iutf8_toupper, SV *)
 PERLVAR(Iutf8_totitle, SV *)
 PERLVAR(Iutf8_tolower, SV *)
+PERLVAR(Iutf8_tofold,  SV *)
 PERLVAR(Ilast_swash_hv,        HV *)
 PERLVAR(Ilast_swash_klen,      U32)
 PERLVARA(Ilast_swash_key,10,   U8)
@@ -335,39 +397,14 @@ PERLVAR(Ilast_swash_tmps, U8 *)
 PERLVAR(Ilast_swash_slen,      STRLEN)
 
 /* perly.c globals */
-PERLVAR(Iyydebug,      int)
-PERLVAR(Iyynerrs,      int)
-PERLVAR(Iyyerrflag,    int)
-PERLVAR(Iyychar,       int)
-PERLVAR(Iyyval,                YYSTYPE)
-PERLVAR(Iyylval,       YYSTYPE)
-
-PERLVAR(Iglob_index,   int)
+PERLVAR(Iyycharp,      int *)
+PERLVAR(Iyylvalp,      YYSTYPE *)
+
+PERLVARI(Iglob_index,  int,    0)
 PERLVAR(Isrand_called, bool)
 PERLVARA(Iuudmap,256,  char)
 PERLVAR(Ibitcount,     char *)
 
-#ifdef USE_THREADS
-PERLVAR(Ithr_key,      perl_key)       /* For per-thread struct perl_thread* */
-PERLVAR(Isv_mutex,     perl_mutex)     /* Mutex for allocating SVs in sv.c */
-PERLVAR(Ieval_mutex,   perl_mutex)     /* Mutex for doeval */
-PERLVAR(Ieval_cond,    perl_cond)      /* Condition variable for doeval */
-PERLVAR(Ieval_owner,   struct perl_thread *)
-                                       /* Owner thread for doeval */
-PERLVAR(Inthreads,     int)            /* Number of threads currently */
-PERLVAR(Ithreads_mutex,        perl_mutex)     /* Mutex for nthreads and thread list */
-PERLVAR(Inthreads_cond,        perl_cond)      /* Condition variable for nthreads */
-PERLVAR(Isvref_mutex,  perl_mutex)     /* Mutex for SvREFCNT_{inc,dec} */
-PERLVARI(Ithreadsv_names,char *,       THREADSV_NAMES)
-#ifdef FAKE_THREADS
-PERLVAR(Icurthr,       struct perl_thread *)
-                                       /* Currently executing (fake) thread */
-#endif
-
-PERLVAR(Icred_mutex,   perl_mutex)     /* altered credentials in effect */
-
-#endif /* USE_THREADS */
-
 PERLVAR(Ipsig_ptr, SV**)
 PERLVAR(Ipsig_name, SV**)
 
@@ -386,3 +423,122 @@ PERLVAR(IProc,            struct IPerlProc*)
 #if defined(USE_ITHREADS)
 PERLVAR(Iptr_table,    PTR_TBL_t*)
 #endif
+PERLVARI(Ibeginav_save, AV*, Nullav)   /* save BEGIN{}s when compiling */
+
+PERLVAR(Ixnv_arenaroot,        XPV*)           /* list of allocated xnv areas */
+PERLVAR(Ixrv_arenaroot,        XPV*)           /* list of allocated xrv areas */
+PERLVAR(Ixpv_arenaroot,        XPV*)           /* list of allocated xpv areas */
+PERLVAR(Ixpviv_arenaroot,XPVIV*)       /* list of allocated xpviv areas */
+PERLVAR(Ixpvnv_arenaroot,XPVNV*)       /* list of allocated xpvnv areas */
+PERLVAR(Ixpvcv_arenaroot,XPVCV*)       /* list of allocated xpvcv areas */
+PERLVAR(Ixpvav_arenaroot,XPVAV*)       /* list of allocated xpvav areas */
+PERLVAR(Ixpvhv_arenaroot,XPVHV*)       /* list of allocated xpvhv areas */
+PERLVAR(Ixpvmg_arenaroot,XPVMG*)       /* list of allocated xpvmg areas */
+PERLVAR(Ixpvlv_arenaroot,XPVLV*)       /* list of allocated xpvlv areas */
+PERLVAR(Ixpvbm_arenaroot,XPVBM*)       /* list of allocated xpvbm areas */
+PERLVAR(Ihe_arenaroot, XPV*)           /* list of allocated he areas */
+
+     /* 5.6.0 stopped here */
+
+PERLVAR(Ipsig_pend, int *)             /* per-signal "count" of pending */
+PERLVARI(Isig_pending, int,0)           /* Number if highest signal pending */
+
+#ifdef USE_LOCALE_NUMERIC
+
+PERLVAR(Inumeric_radix_sv,     SV *)   /* The radix separator if not '.' */
+
+#endif
+
+#if defined(USE_ITHREADS)
+PERLVAR(Iregex_pad,     SV**)          /* All regex objects */
+PERLVAR(Iregex_padav,   AV*)           /* All regex objects */
+
+#endif
+
+#ifdef USE_REENTRANT_API
+PERLVAR(Ireentrant_buffer, REENTR*)    /* here we store the _r buffers */
+#endif
+
+PERLVARI(Isavebegin,     bool, FALSE)  /* save BEGINs for compiler     */
+
+PERLVAR(Icustom_op_names, HV*)  /* Names of user defined ops */
+PERLVAR(Icustom_op_descs, HV*)  /* Descriptions of user defined ops */
+
+#ifdef PERLIO_LAYERS
+PERLVARI(Iperlio, PerlIO *,NULL)
+PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
+PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
+#endif
+
+PERLVARI(Iencoding,    SV*, Nullsv)            /* character encoding */
+
+PERLVAR(Idebug_pad,    struct perl_debug_pad)  /* always needed because of the re extension */
+
+PERLVAR(Itaint_warn, bool)      /* taint warns instead of dying */
+
+#ifdef PL_OP_SLAB_ALLOC
+PERLVAR(IOpPtr,I32 **)
+PERLVARI(IOpSpace,I32,0)
+PERLVAR(IOpSlab,I32 *)
+#endif
+
+PERLVAR(Iutf8locale,   bool)           /* utf8 locale detected */
+
+PERLVAR(Iutf8_idstart, SV *)
+PERLVAR(Iutf8_idcont,  SV *)
+
+PERLVAR(Isort_RealCmp,  SVCOMPARE_t)
+
+PERLVARI(Icheckav_save, AV*, Nullav)   /* save CHECK{}s when compiling */
+
+PERLVARI(Iclocktick, long, 0)  /* this many times() ticks in a second */
+
+PERLVARI(Iin_load_module, int, 0)      /* to prevent recursions in PerlIO_find_layer */
+
+PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
+
+PERLVAR(Isignals, U32) /* Using which pre-5.8 signals */
+
+PERLVAR(Istashcache,   HV *)           /* Cache to speed up S_method_common */
+
+PERLVAR(Ireentrant_retint, int)        /* Integer return value from reentrant functions */
+
+/* Hooks to shared SVs and locks. */
+PERLVARI(Isharehook,   share_proc_t,   MEMBER_TO_FPTR(Perl_sv_nosharing))
+PERLVARI(Ilockhook,    share_proc_t,   MEMBER_TO_FPTR(Perl_sv_nolocking))
+PERLVARI(Iunlockhook,  share_proc_t,   MEMBER_TO_FPTR(Perl_sv_nounlocking))
+PERLVARI(Ithreadhook,  thrhook_proc_t, MEMBER_TO_FPTR(Perl_nothreadhook))
+
+/* Force inclusion of both runops options */
+PERLVARI(Irunops_std,  runops_proc_t,  MEMBER_TO_FPTR(Perl_runops_standard))
+PERLVARI(Irunops_dbg,  runops_proc_t,  MEMBER_TO_FPTR(Perl_runops_debug))
+
+/* Stores the PPID */
+#ifdef THREADS_HAVE_PIDS
+PERLVARI(Ippid,                IV,             0)
+#endif
+
+PERLVARI(Ihash_seed, UV, 0)            /* Hash initializer */
+
+PERLVARI(Ihash_seed_set, bool, FALSE)          /* Hash initialized? */
+
+PERLVAR(IDBassertion,   SV *)
+
+PERLVARI(Icv_has_eval, I32, 0) /* PL_compcv includes an entereval or similar */
+
+PERLVARI(Irehash_seed, UV, 0)          /* 582 hash initializer */
+
+PERLVARI(Irehash_seed_set, bool, FALSE)        /* 582 hash initialized? */
+
+/* These two variables are needed to preserve 5.8.x bincompat because we can't
+   change function prototypes of two exported functions.  Probably should be
+   taken out of blead soon, and relevant prototypes changed.  */
+PERLVARI(Ifdscript, int, -1)   /* fd for script */
+PERLVARI(Isuidscript, int, -1) /* fd for suid script */
+/* New variables must be added to the very end, before this comment,
+ * for binary compatibility (the offsets of the old members must not change).
+ * (Don't forget to add your variable also to perl_clone()!)
+ * XSUB.h provides wrapper functions via perlapi.h that make this
+ * irrelevant, but not all code may be expected to #include XSUB.h.
+ */
+