This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Expose save_pushi32ptr() and implement SAVECOPARYBASE() with it.
[perl5.git] / scope.h
diff --git a/scope.h b/scope.h
index 7170365..152566a 100644 (file)
--- a/scope.h
+++ b/scope.h
-#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_AELEM     24
-#define SAVEt_HELEM     25
-#define SAVEt_OP       26
-
-#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.
+ *
+ */
+
+#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_AELEM            24
+#define SAVEt_HELEM            25
+#define SAVEt_OP               26
+#define SAVEt_HINTS            27
+#define SAVEt_ALLOC            28
+#define SAVEt_GENERIC_SVREF    29
+#define SAVEt_DESTRUCTOR_X     30
+#define SAVEt_VPTR             31
+#define SAVEt_I8               32
+#define SAVEt_COMPPAD          33
+#define SAVEt_GENERIC_PVREF    34
+#define SAVEt_PADSV_AND_MORTALIZE      35
+#define SAVEt_MORTALIZESV      36
+#define SAVEt_SHARED_PVREF     37
+#define SAVEt_BOOL             38
+#define SAVEt_SET_SVFLAGS      39
+#define SAVEt_SAVESWITCHSTACK  40
+#define SAVEt_COP_ARYBASE      41
+#define SAVEt_RE_STATE         42
+#define SAVEt_COMPILE_WARNINGS 43
+#define SAVEt_STACK_CXPOS      44
+#define SAVEt_PARSER           45
+
+#define SAVEf_SETMAGIC         1
+
+#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
+
+#define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
+#define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
+#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 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))
+#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 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)
+
+/*
+=head1 Callback Functions
+
+=for apidoc Ams||SAVETMPS
+Opening bracket for temporaries on a callback.  See C<FREETMPS> and
+L<perlcall>.
+
+=for apidoc Ams||FREETMPS
+Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
+L<perlcall>.
+
+=for apidoc Ams||ENTER
+Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
+
+=for apidoc Ams||LEAVE
+Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
+
+=cut
+*/
+
+#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
+#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
 
 #ifdef DEBUGGING
 #define ENTER                                                  \
     STMT_START {                                               \
        push_scope();                                           \
-       DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n",      \
-                   scopestack_ix, __FILE__, __LINE__)));       \
+       DEBUG_SCOPE("ENTER")                                    \
     } STMT_END
 #define LEAVE                                                  \
     STMT_START {                                               \
-       DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n",      \
-                   scopestack_ix, __FILE__, __LINE__)));       \
+       DEBUG_SCOPE("LEAVE")                                    \
        pop_scope();                                            \
     } STMT_END
 #else
 #define ENTER push_scope()
 #define LEAVE pop_scope()
 #endif
-#define LEAVE_SCOPE(old) if (savestack_ix > old) leave_scope(old)
-
-/*
- * 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 LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
+
+#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 SAVEBOOL(b)    save_bool((bool*)&(b))
 #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 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 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 SAVESHAREDPV(s)                save_shared_pvref((char**)&(s))
+#define SAVESETSVFLAGS(sv,mask,val)    save_set_svflags(sv,mask,val)
 #define SAVEDELETE(h,k,l) \
-         save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
-#ifdef PERL_OBJECT
-#define CALLDESTRUCTOR this->*SSPOPDPTR
+         save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
 #define SAVEDESTRUCTOR(f,p) \
-         save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)),        \
-                         SOFT_CAST(void*)(p))
-#else
-#define CALLDESTRUCTOR *SSPOPDPTR
-#define SAVEDESTRUCTOR(f,p) \
-         save_destructor(SOFT_CAST(void(*)_((void*)))(FUNC_NAME_TO_PTR(f)), \
-                         SOFT_CAST(void*)(p))
-#endif
-#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 SAVESTACK_POS() \
+    STMT_START {                               \
+       SSCHECK(2);                             \
+       SSPUSHINT(PL_stack_sp - PL_stack_base); \
+       SSPUSHINT(SAVEt_STACK_POS);             \
+    } STMT_END
+
 #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
- * (*je_jump)() at that runlevel.  Always use the macros below!  They
- * manage most of the complexity for you.
- *
- * 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.
- *
- * The support for C++ try/throw causes a small loss of flexibility.
- * No longer is it possible to place the body of exception-protected
- * code in the same C function as JMPENV_PUSH &etc.  Older code that
- * does this will continue to work with set/longjmp, but cannot use
- * C++ exceptions.
- *
- * GSAR  19970327
- * JPRIT 19980613 (C++ update)
- */
+#define SAVEHINTS() \
+    STMT_START {                                       \
+       SSCHECK(4);                                     \
+       if (PL_hints & HINT_LOCALIZE_HH) {              \
+           SSPUSHPTR(GvHV(PL_hintgv));                 \
+           GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
+       }                                               \
+       if (PL_compiling.cop_hints_hash) {              \
+           HINTS_REFCNT_LOCK;                          \
+           PL_compiling.cop_hints_hash->refcounted_he_refcnt++;        \
+           HINTS_REFCNT_UNLOCK;                        \
+       }                                               \
+       SSPUSHPTR(PL_compiling.cop_hints_hash);         \
+       SSPUSHINT(PL_hints);                            \
+       SSPUSHINT(SAVEt_HINTS);                         \
+    } STMT_END
 
-#define JMP_NORMAL     0
-#define JMP_ABNORMAL   1       /* shouldn't happen */
-#define JMP_MYEXIT     2       /* exit */
-#define JMP_EXCEPTION  3       /* die */
-
-/* None of the JMPENV fields should be accessed directly.
-   Please use the macros below! */
-struct jmpenv {
-    struct jmpenv *    je_prev;
-    int                        je_stat;        /* JMP_* reason for setjmp() */
-    bool               je_mustcatch;   /* will need a new TRYBLOCK? */
-    void               (*je_jump) _((CPERLproto));
-};
-typedef struct jmpenv JMPENV;
-
-struct tryvtbl {
-    /* [0] executed before JMPENV_POP
-       [1] executed after JMPENV_POP
-           (NULL pointers are OK) */
-    char *try_context;
-    void (*try_normal    [2]) _((CPERLproto_ void*));
-    void (*try_abnormal  [2]) _((CPERLproto_ void*));
-    void (*try_exception [2]) _((CPERLproto_ void*));
-    void (*try_myexit    [2]) _((CPERLproto_ void*));
-};
-typedef struct tryvtbl TRYVTBL;
-
-typedef void (*tryblock_f) _((CPERLproto_ TRYVTBL *vtbl, void *locals));
-#define TRYBLOCK(mytry,vars) \
-       (*tryblock_function)(PERL_OBJECT_THIS_ &mytry, &vars)
-
-#ifdef OP_IN_REGISTER
-#define OP_REG_TO_MEM  opsave = op
-#define OP_MEM_TO_REG  op = opsave
-#else
-#define OP_REG_TO_MEM  NOOP
-#define OP_MEM_TO_REG  NOOP
-#endif
+#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
 
-#define JMPENV_TOPINIT(top)                    \
-STMT_START {                                   \
-    top.je_prev = NULL;                                \
-    top.je_stat = JMP_ABNORMAL;                        \
-    top.je_mustcatch = TRUE;                   \
-    top_env = &top;                            \
-} STMT_END
-
-#define JMPENV_INIT(env, jmp)                  \
-STMT_START {                                   \
-    ((JMPENV*)&env)->je_prev = top_env;                \
-    ((JMPENV*)&env)->je_stat = JMP_NORMAL;     \
-    ((JMPENV*)&env)->je_jump = jmp;            \
-    OP_REG_TO_MEM;                             \
-} STMT_END
-
-#define JMPENV_TRY(env)                                \
-STMT_START {                                   \
-    OP_MEM_TO_REG;                             \
-    ((JMPENV*)&env)->je_mustcatch = FALSE;     \
-    top_env = (JMPENV*)&env;                   \
-} STMT_END
-
-#define JMPENV_POP_JE(env)                     \
-STMT_START {                                   \
-       assert(top_env == (JMPENV*)&env);       \
-       top_env = ((JMPENV*)&env)->je_prev;     \
-} STMT_END
-
-#define JMPENV_STAT(env) ((JMPENV*)&env)->je_stat
-
-#define JMPENV_JUMP(v) \
-    STMT_START {                                               \
-       assert((v) != JMP_NORMAL);                              \
-       OP_REG_TO_MEM;                                          \
-       if (top_env->je_prev) {                                 \
-           top_env->je_stat = (v);                             \
-           (*top_env->je_jump)(PERL_OBJECT_THIS);              \
-       }                                                       \
-       if ((v) == JMP_MYEXIT)                                  \
-           PerlProc_exit(STATUS_NATIVE_EXPORT);                \
-       PerlIO_printf(PerlIO_stderr(), no_top_env);             \
-       PerlProc_exit(1);                                       \
+#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
-   
-#define CATCH_GET      (top_env->je_mustcatch)
-#define CATCH_SET(v)   (top_env->je_mustcatch = (v))
 
+#define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);
+
+/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
+   because realloc() means that the value can actually change. Possibly
+   could have done savefreesharedpvREF, but this way actually seems cleaner,
+   as it simplifies the code that does the saves, and reduces the load on the
+   save stack.  */
+#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
+
+#define SAVESTACK_CXPOS() \
+    STMT_START {                                  \
+        SSCHECK(3);                               \
+        SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
+        SSPUSHINT(cxstack_ix);                    \
+        SSPUSHINT(SAVEt_STACK_CXPOS);             \
+    } STMT_END
 
+#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
 
-/*******************************************************************
- * JMPENV_PUSH is the old depreciated API.  See perl.c for examples
- *  of the new API.
- */
+#ifdef USE_ITHREADS
+#  define SAVECOPSTASH(c)      SAVEPPTR(CopSTASHPV(c))
+#  define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
+#  define SAVECOPFILE(c)       SAVEPPTR(CopFILE(c))
+#  define SAVECOPFILE_FREE(c)  SAVESHAREDPV(CopFILE(c))
+#else
+#  define SAVECOPSTASH(c)      SAVESPTR(CopSTASH(c))
+#  define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
+#  define SAVECOPFILE(c)       SAVESPTR(CopFILEGV(c))
+#  define SAVECOPFILE_FREE(c)  SAVEGENERICSV(CopFILEGV(c))
+#endif
 
-struct setjmpenv {
-    /* move to scope.c once JMPENV_PUSH is no longer needed XXX */
-    JMPENV             je0;
-    Sigjmp_buf         je_buf;         
-};
-typedef struct setjmpenv SETJMPENV;
+#define SAVECOPLINE(c)         SAVEI32(CopLINE(c))
 
-#define dJMPENV                SETJMPENV cur_env
+/* SSNEW() temporarily allocates a specified number of bytes of data on the
+ * savestack.  It returns an integer index into the savestack, because a
+ * pointer would get broken if the savestack is moved on reallocation.
+ * SSNEWa() works like SSNEW(), but also aligns the data to the specified
+ * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
+ * alignment will be preserved therough savestack reallocation *only* if
+ * realloc returns data aligned to a size divisible by "align"!
+ *
+ * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
+ */
 
-extern void setjmp_jump();
+#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), \
+    (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
+#define SSNEWat(n,t,align)     SSNEWa((n)*sizeof(t), align)
 
-#define JMPENV_PUSH(v) \
-    STMT_START {                                       \
-       JMPENV_INIT(cur_env, setjmp_jump);              \
-       PerlProc_setjmp(cur_env.je_buf, 1);             \
-       JMPENV_TRY(cur_env);                            \
-       (v) = JMPENV_STAT(cur_env);                     \
-    } STMT_END
+#define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
+#define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
 
-#define JMPENV_POP                             \
-STMT_START {                                   \
-       assert(top_env == (JMPENV*) &cur_env);  \
-       top_env = cur_env.je0.je_prev;          \
-} STMT_END
+#define save_freesv(op)                save_pushptr((void *)(op), SAVEt_FREESV)
+#define save_mortalizesv(op)   save_pushptr((void *)(op), SAVEt_MORTALIZESV)
+#define save_freeop(op)                save_pushptr((void *)(op), SAVEt_FREEOP)
+#define save_freepv(pv)                save_pushptr((void *)(pv), SAVEt_FREEPV)
+#define save_op()              save_pushptr((void *)(PL_op), SAVEt_OP)
 
+/*
+ * Local variables:
+ * c-indentation-style: bsd
+ * c-basic-offset: 4
+ * indent-tabs-mode: t
+ * End:
+ *
+ * ex: set ts=8 sts=4 sw=4 noet:
+ */