contrib/perl5/scope.h

   1 #define SAVEt_ITEM      0
   2 #define SAVEt_SV        1
   3 #define SAVEt_AV        2
   4 #define SAVEt_HV        3
   5 #define SAVEt_INT       4
   6 #define SAVEt_LONG      5
   7 #define SAVEt_I32       6
   8 #define SAVEt_IV        7
   9 #define SAVEt_SPTR      8
  10 #define SAVEt_APTR      9
  11 #define SAVEt_HPTR      10
  12 #define SAVEt_PPTR      11
  13 #define SAVEt_NSTAB     12
  14 #define SAVEt_SVREF     13
  15 #define SAVEt_GP        14
  16 #define SAVEt_FREESV    15
  17 #define SAVEt_FREEOP    16
  18 #define SAVEt_FREEPV    17
  19 #define SAVEt_CLEARSV   18
  20 #define SAVEt_DELETE    19
  21 #define SAVEt_DESTRUCTOR 20
  22 #define SAVEt_REGCONTEXT 21
  23 #define SAVEt_STACK_POS  22
  24 #define SAVEt_I16       23
  25 #define SAVEt_AELEM     24
  26 #define SAVEt_HELEM     25
  27 #define SAVEt_OP        26
  28 #define SAVEt_HINTS     27
  29 /* #define SAVEt_ALLOC          28 */ /* defined in 5.005_5x */
  30 #define SAVEt_GENERIC_SVREF     29
  31
  32 #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
  33 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
  34 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
  35 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
  36 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
  37 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
  38 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
  39 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
  40 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
  41 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
  42 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
  43
  44 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
  45 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
  46
  47 #ifdef DEBUGGING
  48 #define ENTER                                                   \
  49     STMT_START {                                                \
  50         push_scope();                                           \
  51         DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n",      \
  52                     PL_scopestack_ix, __FILE__, __LINE__)));    \
  53     } STMT_END
  54 #define LEAVE                                                   \
  55     STMT_START {                                                \
  56         DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n",      \
  57                     PL_scopestack_ix, __FILE__, __LINE__)));    \
  58         pop_scope();                                            \
  59     } STMT_END
  60 #else
  61 #define ENTER push_scope()
  62 #define LEAVE pop_scope()
  63 #endif
  64 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
  65
  66 /*
  67  * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
  68  * because these are used for several kinds of pointer values
  69  */
  70 #define SAVEI16(i)      save_I16(SOFT_CAST(I16*)&(i))
  71 #define SAVEI32(i)      save_I32(SOFT_CAST(I32*)&(i))
  72 #define SAVEINT(i)      save_int(SOFT_CAST(int*)&(i))
  73 #define SAVEIV(i)       save_iv(SOFT_CAST(IV*)&(i))
  74 #define SAVELONG(l)     save_long(SOFT_CAST(long*)&(l))
  75 #define SAVESPTR(s)     save_sptr((SV**)&(s))
  76 #define SAVEPPTR(s)     save_pptr(SOFT_CAST(char**)&(s))
  77 #define SAVEFREESV(s)   save_freesv((SV*)(s))
  78 #define SAVEFREEOP(o)   save_freeop(SOFT_CAST(OP*)(o))
  79 #define SAVEFREEPV(p)   save_freepv(SOFT_CAST(char*)(p))
  80 #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
  81 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
  82 #define SAVEDELETE(h,k,l) \
  83           save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
  84 #ifdef PERL_OBJECT
  85 #define CALLDESTRUCTOR this->*SSPOPDPTR
  86 #define SAVEDESTRUCTOR(f,p) \
  87           save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)),        \
  88                           SOFT_CAST(void*)(p))
  89 #else
  90 #define CALLDESTRUCTOR *SSPOPDPTR
  91 #define SAVEDESTRUCTOR(f,p) \
  92           save_destructor(SOFT_CAST(void(*)_((void*)))(FUNC_NAME_TO_PTR(f)), \
  93                           SOFT_CAST(void*)(p))
  94 #endif
  95
  96 #define SAVESTACK_POS() \
  97     STMT_START {                                \
  98         SSCHECK(2);                             \
  99         SSPUSHINT(PL_stack_sp - PL_stack_base); \
 100         SSPUSHINT(SAVEt_STACK_POS);             \
 101     } STMT_END
 102
 103 #define SAVEOP()        save_op()
 104
 105 #define SAVEHINTS() \
 106     STMT_START {                                \
 107         if (PL_hints & HINT_LOCALIZE_HH)        \
 108             save_hints();                       \
 109         else {                                  \
 110             SSCHECK(2);                         \
 111             SSPUSHINT(PL_hints);                \
 112             SSPUSHINT(SAVEt_HINTS);             \
 113         }                                       \
 114     } STMT_END
 115
 116 /* A jmpenv packages the state required to perform a proper non-local jump.
 117  * Note that there is a start_env initialized when perl starts, and top_env
 118  * points to this initially, so top_env should always be non-null.
 119  *
 120  * Existence of a non-null top_env->je_prev implies it is valid to call
 121  * longjmp() at that runlevel (we make sure start_env.je_prev is always
 122  * null to ensure this).
 123  *
 124  * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
 125  * establish a local jmpenv to handle exception traps.  Care must be taken
 126  * to restore the previous value of je_mustcatch before exiting the
 127  * stack frame iff JMPENV_PUSH was not called in that stack frame.
 128  * GSAR 97-03-27
 129  */
 130
 131 struct jmpenv {
 132     struct jmpenv *     je_prev;
 133     Sigjmp_buf          je_buf;
 134     int                 je_ret;         /* return value of last setjmp() */
 135     bool                je_mustcatch;   /* longjmp()s must be caught locally */
 136 };
 137
 138 typedef struct jmpenv JMPENV;
 139
 140 #ifdef OP_IN_REGISTER
 141 #define OP_REG_TO_MEM   PL_opsave = op
 142 #define OP_MEM_TO_REG   op = PL_opsave
 143 #else
 144 #define OP_REG_TO_MEM   NOOP
 145 #define OP_MEM_TO_REG   NOOP
 146 #endif
 147
 148 #define dJMPENV         JMPENV cur_env
 149 #define JMPENV_PUSH(v) \
 150     STMT_START {                                        \
 151         cur_env.je_prev = PL_top_env;                   \
 152         OP_REG_TO_MEM;                                  \
 153         cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, 1);    \
 154         OP_MEM_TO_REG;                                  \
 155         PL_top_env = &cur_env;                          \
 156         cur_env.je_mustcatch = FALSE;                   \
 157         (v) = cur_env.je_ret;                           \
 158     } STMT_END
 159 #define JMPENV_POP \
 160     STMT_START { PL_top_env = cur_env.je_prev; } STMT_END
 161 #define JMPENV_JUMP(v) \
 162     STMT_START {                                                \
 163         OP_REG_TO_MEM;                                          \
 164         if (PL_top_env->je_prev)                                        \
 165             PerlProc_longjmp(PL_top_env->je_buf, (v));                  \
 166         if ((v) == 2)                                           \
 167             PerlProc_exit(STATUS_NATIVE_EXPORT);                                \
 168         PerlIO_printf(PerlIO_stderr(), "panic: top_env\n");     \
 169         PerlProc_exit(1);                                               \
 170     } STMT_END
 171
 172 #define CATCH_GET       (PL_top_env->je_mustcatch)
 173 #define CATCH_SET(v)    (PL_top_env->je_mustcatch = (v))
 174