new perldelta

[perl5.git] / scope.h

diff --git a/scope.h b/scope.h
index 4648d00..0b82bd1 100644 (file)
--- a/scope.h
+++ b/scope.h
@@ -1,130 +1,322 @@
-#define SAVEt_ITEM     0
-#define SAVEt_SV       1
-#define SAVEt_AV       2
-#define SAVEt_HV       3
-#define SAVEt_INT      4
-#define SAVEt_LONG     5
-#define SAVEt_I32      6
-#define SAVEt_IV       7
-#define SAVEt_SPTR     8
-#define SAVEt_APTR     9
-#define SAVEt_HPTR     10
-#define SAVEt_PPTR     11
-#define SAVEt_NSTAB    12
-#define SAVEt_SVREF    13
-#define SAVEt_GP       14
-#define SAVEt_FREESV   15
-#define SAVEt_FREEOP   16
-#define SAVEt_FREEPV   17
-#define SAVEt_CLEARSV  18
-#define SAVEt_DELETE   19
-#define SAVEt_DESTRUCTOR 20
-#define SAVEt_REGCONTEXT 21
-#define SAVEt_STACK_POS  22
-#define SAVEt_I16      23
-#define SAVEt_OP       24
-
-#define SSCHECK(need) if (savestack_ix + need > savestack_max) savestack_grow()
-#define SSPUSHINT(i) (savestack[savestack_ix++].any_i32 = (I32)(i))
-#define SSPUSHLONG(i) (savestack[savestack_ix++].any_long = (long)(i))
-#define SSPUSHIV(i) (savestack[savestack_ix++].any_iv = (IV)(i))
-#define SSPUSHPTR(p) (savestack[savestack_ix++].any_ptr = (void*)(p))
-#define SSPUSHDPTR(p) (savestack[savestack_ix++].any_dptr = (p))
-#define SSPOPINT (savestack[--savestack_ix].any_i32)
-#define SSPOPLONG (savestack[--savestack_ix].any_long)
-#define SSPOPIV (savestack[--savestack_ix].any_iv)
-#define SSPOPPTR (savestack[--savestack_ix].any_ptr)
-#define SSPOPDPTR (savestack[--savestack_ix].any_dptr)
-
-#define SAVETMPS save_int((int*)&tmps_floor), tmps_floor = tmps_ix
-#define FREETMPS if (tmps_ix > tmps_floor) free_tmps()
+/*    scope.h
+ *
+ *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
+ *    2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
+ *
+ *    You may distribute under the terms of either the GNU General Public
+ *    License or the Artistic License, as specified in the README file.
+ *
+ */
+
+#include "scope_types.h"
+
+#define SAVEf_SETMAGIC         1
+#define SAVEf_KEEPOLDELEM      2
+
+#define SAVE_TIGHT_SHIFT       6
+#define SAVE_MASK              0x3F
+
+#define save_aelem(av,idx,sptr)        save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
+#define save_helem(hv,key,sptr)        save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
+
+#ifndef SCOPE_SAVES_SIGNAL_MASK
+#define SCOPE_SAVES_SIGNAL_MASK 0
+#endif
+
+/* the maximum number of entries that might be pushed using the SS_ADD*
+ * macros */
+#define SS_MAXPUSH 4
+
+#define SSGROW(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow_cnt(need)
+#define SSCHECK(need) SSGROW(need) /* legacy */
+#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
+#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
+#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
+#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
+#define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
+#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
+#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
+#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
+
+/* SS_ADD*: newer, faster versions of the above. Don't mix the two sets of
+ * macros. These are fast because they save reduce accesses to the PL_
+ * vars and move the size check to the end. Doing the check last means
+ * that values in registers will have been pushed and no longer needed, so
+ * don't need saving around the call to grow. Also, tail-call elimination
+ * of the grow() can be done. These changes reduce the code of something
+ * like save_pushptrptr() to half its former size.
+ * Of course, doing the size check *after* pushing means we must always
+ * ensure there are SS_MAXPUSH free slots on the savestack. This is ensured by
+ * savestack_grow_cnt always allocating SS_MAXPUSH slots
+ * more than asked for, or that it sets PL_savestack_max to
+ *
+ * These are for internal core use only and are subject to change */
+
+#define dSS_ADD \
+    I32 ix = PL_savestack_ix;     \
+    ANY *ssp = &PL_savestack[ix]
+
+#define SS_ADD_END(need) \
+    assert((need) <= SS_MAXPUSH);                               \
+    ix += (need);                                               \
+    PL_savestack_ix = ix;                                       \
+    assert(ix <= PL_savestack_max + SS_MAXPUSH);                \
+    if (UNLIKELY(ix > PL_savestack_max)) savestack_grow_cnt(ix - PL_savestack_max);      \
+    assert(PL_savestack_ix <= PL_savestack_max);
+
+#define SS_ADD_INT(i)   ((ssp++)->any_i32 = (I32)(i))
+#define SS_ADD_LONG(i)  ((ssp++)->any_long = (long)(i))
+#define SS_ADD_BOOL(p)  ((ssp++)->any_bool = (p))
+#define SS_ADD_IV(i)    ((ssp++)->any_iv = (IV)(i))
+#define SS_ADD_UV(u)    ((ssp++)->any_uv = (UV)(u))
+#define SS_ADD_PTR(p)   ((ssp++)->any_ptr = (void*)(p))
+#define SS_ADD_DPTR(p)  ((ssp++)->any_dptr = (p))
+#define SS_ADD_DXPTR(p) ((ssp++)->any_dxptr = (p))
+
+#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
+#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
+#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
+#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
+#define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
+#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
+#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
+#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
+
+
+/*
+=for apidoc_section $callback
+
+=for apidoc Amn;||SAVETMPS
+Opening bracket for temporaries on a callback.  See C<L</FREETMPS>> and
+L<perlcall>.

 
 

+=for apidoc Amn;||FREETMPS
+Closing bracket for temporaries on a callback.  See C<L</SAVETMPS>> and
+L<perlcall>.
+
+=for apidoc Amn;||ENTER
+Opening bracket on a callback.  See C<L</LEAVE>> and L<perlcall>.
+
+=for apidoc Amn;||LEAVE
+Closing bracket on a callback.  See C<L</ENTER>> and L<perlcall>.
+
+=for apidoc Am;||ENTER_with_name|"name"
+
+Same as C<L</ENTER>>, but when debugging is enabled it also associates the
+given literal string with the new scope.
+
+=for apidoc Am;||LEAVE_with_name|"name"
+
+Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the
+scope has the given name. C<name> must be a literal string.
+
+=cut
+*/
+
+#define SAVETMPS Perl_savetmps(aTHX)
+
+#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
+
+#ifdef DEBUGGING
+#define ENTER                                                  \
+    STMT_START {                                               \
+        push_scope();                                          \
+        DEBUG_SCOPE("ENTER")                                   \
+    } STMT_END
+#define LEAVE                                                  \
+    STMT_START {                                               \
+        DEBUG_SCOPE("LEAVE")                                   \
+        pop_scope();                                           \
+    } STMT_END
+#define ENTER_with_name(name)                                          \
+    STMT_START {                                                       \
+        push_scope();                                                  \
+        if (PL_scopestack_name)                                                \
+            PL_scopestack_name[PL_scopestack_ix-1] = ASSERT_IS_LITERAL(name);\
+        DEBUG_SCOPE("ENTER \"" name "\"")                              \
+    } STMT_END
+#define LEAVE_with_name(name)                                          \
+    STMT_START {                                                       \
+        DEBUG_SCOPE("LEAVE \"" name "\"")                              \
+        if (PL_scopestack_name)        {                                       \
+            CLANG_DIAG_IGNORE_STMT(-Wstring-compare);                  \
+            assert(((char*)PL_scopestack_name[PL_scopestack_ix-1]      \
+                        == (char*)ASSERT_IS_LITERAL(name))              \
+                    || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name));        \
+            CLANG_DIAG_RESTORE_STMT;                                   \
+        }                                                              \
+        pop_scope();                                                   \
+    } STMT_END
+#else

 #define ENTER push_scope()
 #define LEAVE pop_scope()
 #define ENTER push_scope()
 #define LEAVE pop_scope()

-#define LEAVE_SCOPE(old) if (savestack_ix > old) leave_scope(old)
+#define ENTER_with_name(name) ENTER
+#define LEAVE_with_name(name) LEAVE
+#endif
+#define LEAVE_SCOPE(old) STMT_START { \
+        if (PL_savestack_ix > old) leave_scope(old); \
+    } STMT_END
+
+#define SAVEI8(i)                   save_I8((I8*)&(i))
+#define SAVEI16(i)                  save_I16((I16*)&(i))
+#define SAVEI32(i)                  save_I32((I32*)&(i))
+#define SAVEINT(i)                  save_int((int*)&(i))
+#define SAVEIV(i)                   save_iv((IV*)&(i))
+#define SAVELONG(l)                 save_long((long*)&(l))
+#define SAVESTRLEN(l)               Perl_save_strlen(aTHX_ (STRLEN*)&(l))
+#define SAVEBOOL(b)                 save_bool(&(b))
+#define SAVESPTR(s)                 save_sptr((SV**)&(s))
+#define SAVEPPTR(s)                 save_pptr((char**)&(s))
+#define SAVEVPTR(s)                 save_vptr((void*)&(s))
+#define SAVEPADSVANDMORTALIZE(s)    save_padsv_and_mortalize(s)
+#define SAVEFREESV(s)               save_freesv(MUTABLE_SV(s))
+#define SAVEFREEPADNAME(s)          save_pushptr((void *)(s), SAVEt_FREEPADNAME)
+#define SAVEMORTALIZESV(s)          save_mortalizesv(MUTABLE_SV(s))
+#define SAVEFREEOP(o)               save_freeop((OP*)(o))
+#define SAVEFREEPV(p)               save_freepv((char*)(p))
+#define SAVECLEARSV(sv)             save_clearsv((SV**)&(sv))
+#define SAVEGENERICSV(s)            save_generic_svref((SV**)&(s))
+#define SAVEGENERICPV(s)            save_generic_pvref((char**)&(s))
+#define SAVERCPV(s)                 save_rcpv((char**)&(s))
+#define SAVEFREERCPV(s)             save_freercpv(s)
+#define SAVESHAREDPV(s)             save_shared_pvref((char**)&(s))
+#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
+#define SAVEFREECOPHH(h)            save_pushptr((void *)(h), SAVEt_FREECOPHH)

 
 

-/*
- * Not using SOFT_CAST on SAVEFREESV and SAVEFREESV
- * because these are used for several kinds of pointer values
- */
-#define SAVEI16(i)     save_I16(SOFT_CAST(I16*)&(i))
-#define SAVEI32(i)     save_I32(SOFT_CAST(I32*)&(i))
-#define SAVEINT(i)     save_int(SOFT_CAST(int*)&(i))
-#define SAVEIV(i)      save_iv(SOFT_CAST(IV*)&(i))
-#define SAVELONG(l)    save_long(SOFT_CAST(long*)&(l))
-#define SAVESPTR(s)    save_sptr((SV**)&(s))
-#define SAVEPPTR(s)    save_pptr(SOFT_CAST(char**)&(s))
-#define SAVEFREESV(s)  save_freesv((SV*)(s))
-#define SAVEFREEOP(o)  save_freeop(SOFT_CAST(OP*)(o))
-#define SAVEFREEPV(p)  save_freepv(SOFT_CAST(char*)(p))
-#define SAVECLEARSV(sv)        save_clearsv(SOFT_CAST(SV**)&(sv))

 #define SAVEDELETE(h,k,l) \
 #define SAVEDELETE(h,k,l) \

-         save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
+          save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
+#define SAVEHDELETE(h,s) \
+          save_hdelete(MUTABLE_HV(h), (s))
+#define SAVEADELETE(a,k) \
+          save_adelete(MUTABLE_AV(a), (SSize_t)(k))

 #define SAVEDESTRUCTOR(f,p) \
 #define SAVEDESTRUCTOR(f,p) \

-         save_destructor(SOFT_CAST(void(*)_((void*)))(f),SOFT_CAST(void*)(p))
-#define SAVESTACK_POS() STMT_START {   \
-    SSCHECK(2);                                \
-    SSPUSHINT(stack_sp - stack_base);  \
-    SSPUSHINT(SAVEt_STACK_POS);                \
- } STMT_END
+          save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
+
+#define SAVEDESTRUCTOR_X(f,p) \
+          save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
+
+#define MORTALSVFUNC_X(f,sv) \
+          mortal_svfunc_x((SVFUNC_t)(f), sv)
+
+#define MORTALDESTRUCTOR_SV(coderef,args) \
+          mortal_destructor_sv(coderef,args)
+
+#define SAVESTACK_POS() \
+    STMT_START {                                  \
+        dSS_ADD;                                   \
+        SS_ADD_INT(PL_stack_sp - PL_stack_base);   \
+        SS_ADD_UV(SAVEt_STACK_POS);                \
+        SS_ADD_END(2);                             \
+    } STMT_END
+

 #define SAVEOP()       save_op()
 
 #define SAVEOP()       save_op()
 

-/* A jmpenv packages the state required to perform a proper non-local jump.
- * Note that there is a start_env initialized when perl starts, and top_env
- * points to this initially, so top_env should always be non-null.
- *
- * Existence of a non-null top_env->je_prev implies it is valid to call
- * longjmp() at that runlevel (we make sure start_env.je_prev is always
- * null to ensure this).
- *
- * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
- * establish a local jmpenv to handle exception traps.  Care must be taken
- * to restore the previous value of je_mustcatch before exiting the
- * stack frame iff JMPENV_PUSH was not called in that stack frame.
- * GSAR 97-03-27
- */
+#define SAVEHINTS()    save_hints()

 
 

-struct jmpenv {
-    struct jmpenv *    je_prev;
-    Sigjmp_buf         je_buf;         
-    int                        je_ret;         /* return value of last setjmp() */
-    bool               je_mustcatch;   /* longjmp()s must be caught locally */
-};
+#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
+
+#define SAVESWITCHSTACK(f,t) \
+    STMT_START {                                       \
+        save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
+        SWITCHSTACK((f),(t));                          \
+        PL_curstackinfo->si_stack = (t);               \
+    } STMT_END
+
+/* Note these are special, we can't just use a save_pushptrptr() on them
+ * as the target might change after a fork or thread start. */
+#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
+#define SAVECURCOPWARNINGS()  save_pushptr(PL_curcop->cop_warnings, SAVEt_CURCOP_WARNINGS)

 
 

-typedef struct jmpenv JMPENV;

 
 

-#ifdef OP_IN_REGISTER
-#define OP_REG_TO_MEM  opsave = op
-#define OP_MEM_TO_REG  op = opsave
+#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
+
+#ifdef USE_ITHREADS
+#  define SAVECOPSTASH_FREE(c) SAVEIV((c)->cop_stashoff)
+#  define SAVECOPFILE_x(c)      SAVEPPTR((c)->cop_file)
+#  define SAVECOPFILE(c)                \
+    STMT_START {                        \
+        SAVECOPFILE_x(c);               \
+        CopFILE_debug((c),"SAVECOPFILE",0);   \
+    } STMT_END
+#  define SAVECOPFILE_FREE_x(c) SAVERCPV((c)->cop_file)
+#  define SAVECOPFILE_FREE(c)           \
+    STMT_START {                        \
+        SAVECOPFILE_FREE_x(c);          \
+        CopFILE_debug((c),"SAVECOPFILE_FREE",0);   \
+    } STMT_END

 #else
 #else

-#define OP_REG_TO_MEM  NOOP
-#define OP_MEM_TO_REG  NOOP
+#  /* XXX not refcounted */
+#  define SAVECOPSTASH_FREE(c) SAVESPTR(CopSTASH(c))
+#  define SAVECOPFILE(c)       SAVESPTR(CopFILEGV(c))
+#  define SAVECOPFILE_FREE(c)  SAVEGENERICSV(CopFILEGV(c))

 #endif
 
 #endif
 

-#define dJMPENV                JMPENV cur_env
-#define JMPENV_PUSH(v) \
-    STMT_START {                                       \
-       cur_env.je_prev = top_env;                      \
-       OP_REG_TO_MEM;                                  \
-       cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, 1);    \
-       OP_MEM_TO_REG;                                  \
-       top_env = &cur_env;                             \
-       cur_env.je_mustcatch = FALSE;                   \
-       (v) = cur_env.je_ret;                           \
-    } STMT_END
-#define JMPENV_POP \
-    STMT_START { top_env = cur_env.je_prev; } STMT_END
-#define JMPENV_JUMP(v) \
-    STMT_START {                                               \
-       OP_REG_TO_MEM;                                          \
-       if (top_env->je_prev)                                   \
-           PerlProc_longjmp(top_env->je_buf, (v));                     \
-       if ((v) == 2)                                           \
-           PerlProc_exit(STATUS_NATIVE_EXPORT);                                \
-       PerlIO_printf(PerlIO_stderr(), "panic: top_env\n");     \
-       PerlProc_exit(1);                                               \
+#define SAVECOPLINE(c)         SAVEI32(CopLINE(c))
+
+/*
+=for apidoc_section $stack
+=for apidoc    Am|SSize_t|SSNEW  |Size_t size
+=for apidoc_item |       |SSNEWa |Size_t size|Size_t align
+=for apidoc_item |       |SSNEWat|Size_t size|type|Size_t align
+=for apidoc_item |       |SSNEWt |Size_t size|type
+
+These each temporarily allocate data on the savestack, returning an SSize_t
+index into the savestack, because a pointer would get broken if the savestack
+is moved on reallocation.  Use L</C<SSPTR>> to convert the returned index into
+a pointer.
+
+The forms differ in that plain C<SSNEW> allocates C<size> bytes;
+C<SSNEWt> and C<SSNEWat> allocate C<size> objects, each of which is type
+C<type>;
+and <SSNEWa> and C<SSNEWat> make sure to align the new data to an C<align>
+boundary.  The most useful value for the alignment is likely to be
+L</C<MEM_ALIGNBYTES>>.  The alignment will be preserved through savestack
+reallocation B<only> if realloc returns data aligned to a size divisible by
+"align"!
+
+=for apidoc   Am|type  |SSPTR |SSize_t index|type
+=for apidoc_item|type *|SSPTRt|SSize_t index|type
+
+These convert the C<index> returned by L/<C<SSNEW>> and kin into actual pointers.
+
+The difference is that C<SSPTR> casts the result to C<type>, and C<SSPTRt>
+casts it to a pointer of that C<type>.
+
+=cut
+ */
+
+#define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
+#define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
+#define SSNEWa(size,align)     Perl_save_alloc(aTHX_ (size), \
+    (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
+#define SSNEWat(n,t,align)     SSNEWa((n)*sizeof(t), align)
+
+#define SSPTR(off,type)         (assert(sizeof(off) >= sizeof(SSize_t)), (type)  ((char*)PL_savestack + off))
+#define SSPTRt(off,type)        (assert(sizeof(off) >= sizeof(SSize_t)), (type*) ((char*)PL_savestack + off))
+
+#define save_freesv(op)                save_pushptr((void *)(op), SAVEt_FREESV)
+#define save_mortalizesv(op)   save_pushptr((void *)(op), SAVEt_MORTALIZESV)
+
+# define save_freeop(op)                    \
+STMT_START {                                 \
+      OP * const _o = (OP *)(op);             \
+      assert(!_o->op_savefree);               \
+      _o->op_savefree = 1;                     \
+      save_pushptr((void *)(_o), SAVEt_FREEOP); \

     } STMT_END
     } STMT_END

-   
-#define CATCH_GET      (top_env->je_mustcatch)
-#define CATCH_SET(v)   (top_env->je_mustcatch = (v))
-   
+#define save_freepv(pv)                save_pushptr((void *)(pv), SAVEt_FREEPV)
+
+/*
+=for apidoc_section $callback
+=for apidoc save_op
+
+Implements C<SAVEOP>.
+
+=cut
+ */
+
+#define save_op()              save_pushptr((void *)(PL_op), SAVEt_OP)
+
+/*
+ * ex: set ts=8 sts=4 sw=4 et:
+ */