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
  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(Perl_deb(aTHX_ "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(Perl_deb(aTHX_ "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 #else
  87 #define CALLDESTRUCTOR (*SSPOPDPTR)
  88 #endif
  89 #define SAVEDESTRUCTOR(f,p) \
  90           save_destructor((DESTRUCTORFUNC_t)(FUNC_NAME_TO_PTR(f)),      \
  91                           SOFT_CAST(void*)(p))
  92
  93 #define SAVESTACK_POS() \
  94     STMT_START {                                \
  95         SSCHECK(2);                             \
  96         SSPUSHINT(PL_stack_sp - PL_stack_base); \
  97         SSPUSHINT(SAVEt_STACK_POS);             \
  98     } STMT_END
  99
 100 #define SAVEOP()        save_op()
 101
 102 #define SAVEHINTS() \
 103     STMT_START {                                \
 104         if (PL_hints & HINT_LOCALIZE_HH)        \
 105             save_hints();                       \
 106         else {                                  \
 107             SSCHECK(2);                         \
 108             SSPUSHINT(PL_hints);                \
 109             SSPUSHINT(SAVEt_HINTS);             \
 110         }                                       \
 111     } STMT_END
 112
 113 /* SSNEW() temporarily allocates a specified number of bytes of data on the
 114  * savestack.  It returns an integer index into the savestack, because a
 115  * pointer would get broken if the savestack is moved on reallocation.
 116  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
 117  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
 118  * alignment will be preserved therough savestack reallocation *only* if
 119  * realloc returns data aligned to a size divisible by `align'!
 120  *
 121  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
 122  */
 123
 124 #define SSNEW(size)             save_alloc(size, 0)
 125 #define SSNEWa(size,align)      save_alloc(size, \
 126     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
 127
 128 #define SSPTR(off,type)         ((type) ((char*)PL_savestack + off))
 129
 130 /* A jmpenv packages the state required to perform a proper non-local jump.
 131  * Note that there is a start_env initialized when perl starts, and top_env
 132  * points to this initially, so top_env should always be non-null.
 133  *
 134  * Existence of a non-null top_env->je_prev implies it is valid to call
 135  * longjmp() at that runlevel (we make sure start_env.je_prev is always
 136  * null to ensure this).
 137  *
 138  * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
 139  * establish a local jmpenv to handle exception traps.  Care must be taken
 140  * to restore the previous value of je_mustcatch before exiting the
 141  * stack frame iff JMPENV_PUSH was not called in that stack frame.
 142  * GSAR 97-03-27
 143  */
 144
 145 struct jmpenv {
 146     struct jmpenv *     je_prev;
 147     Sigjmp_buf          je_buf;         /* only for use if !je_throw */
 148     int                 je_ret;         /* last exception thrown */
 149     bool                je_mustcatch;   /* need to call longjmp()? */
 150     void                (*je_throw)(int v); /* last for bincompat */
 151 };
 152
 153 typedef struct jmpenv JMPENV;
 154
 155 /*
 156  * Function that catches/throws, and its callback for the
 157  *  body of protected processing.
 158  */
 159 typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
 160 typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ int *, protect_body_t, ...);
 161
 162 /*
 163  * How to build the first jmpenv.
 164  *
 165  * top_env needs to be non-zero. It points to an area
 166  * in which longjmp() stuff is stored, as C callstack
 167  * info there at least is thread specific this has to
 168  * be per-thread. Otherwise a 'die' in a thread gives
 169  * that thread the C stack of last thread to do an eval {}!
 170  */
 171
 172 #define JMPENV_BOOTSTRAP \
 173     STMT_START {                                \
 174         PL_start_env.je_prev = NULL;            \
 175         PL_start_env.je_throw = NULL;           \
 176         PL_start_env.je_ret = -1;               \
 177         PL_start_env.je_mustcatch = TRUE;       \
 178         PL_top_env = &PL_start_env;             \
 179     } STMT_END
 180
 181 #ifdef OP_IN_REGISTER
 182 #define OP_REG_TO_MEM   PL_opsave = op
 183 #define OP_MEM_TO_REG   op = PL_opsave
 184 #else
 185 #define OP_REG_TO_MEM   NOOP
 186 #define OP_MEM_TO_REG   NOOP
 187 #endif
 188
 189 /*
 190  * These exception-handling macros are split up to
 191  * ease integration with C++ exceptions.
 192  *
 193  * To use C++ try+catch to catch Perl exceptions, an extension author
 194  * needs to first write an extern "C" function to throw an appropriate
 195  * exception object; typically it will be or contain an integer,
 196  * because Perl's internals use integers to track exception types:
 197  *    extern "C" { static void thrower(int i) { throw i; } }
 198  *
 199  * Then (as shown below) the author needs to use, not the simple
 200  * JMPENV_PUSH, but several of its constitutent macros, to arrange for
 201  * the Perl internals to call thrower() rather than longjmp() to
 202  * report exceptions:
 203  *
 204  *    dJMPENV;
 205  *    JMPENV_PUSH_INIT(thrower);
 206  *    try {
 207  *        ... stuff that may throw exceptions ...
 208  *    }
 209  *    catch (int why) {  // or whatever matches thrower()
 210  *        JMPENV_POST_CATCH;
 211  *        EXCEPT_SET(why);
 212  *        switch (why) {
 213  *          ... // handle various Perl exception codes
 214  *        }
 215  *    }
 216  *    JMPENV_POP;  // don't forget this!
 217  */
 218
 219 #define dJMPENV         JMPENV cur_env
 220
 221 #define JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC) \
 222     STMT_START {                                        \
 223         cur_env.je_throw = (THROWFUNC);                 \
 224         cur_env.je_ret = -1;                            \
 225         cur_env.je_mustcatch = FALSE;                   \
 226         cur_env.je_prev = PL_top_env;                   \
 227         PL_top_env = &cur_env;                          \
 228         OP_REG_TO_MEM;                                  \
 229     } STMT_END
 230
 231 #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(cur_env,THROWFUNC)
 232
 233 #define JMPENV_POST_CATCH_ENV(cur_env) \
 234     STMT_START {                                        \
 235         OP_MEM_TO_REG;                                  \
 236         PL_top_env = &cur_env;                          \
 237     } STMT_END
 238
 239 #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(cur_env)
 240
 241
 242 #define JMPENV_PUSH_ENV(cur_env,v) \
 243     STMT_START {                                        \
 244         JMPENV_PUSH_INIT_ENV(cur_env,NULL);                             \
 245         EXCEPT_SET_ENV(cur_env,PerlProc_setjmp(cur_env.je_buf, 1));     \
 246         JMPENV_POST_CATCH_ENV(cur_env);                         \
 247         (v) = EXCEPT_GET_ENV(cur_env);                          \
 248     } STMT_END
 249
 250 #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(cur_env,v)
 251
 252 #define JMPENV_POP_ENV(cur_env) \
 253     STMT_START { PL_top_env = cur_env.je_prev; } STMT_END
 254
 255 #define JMPENV_POP  JMPENV_POP_ENV(cur_env)
 256
 257 #define JMPENV_JUMP(v) \
 258     STMT_START {                                                \
 259         OP_REG_TO_MEM;                                          \
 260         if (PL_top_env->je_prev) {                              \
 261             if (PL_top_env->je_throw)                           \
 262                 PL_top_env->je_throw(v);                        \
 263             else                                                \
 264                 PerlProc_longjmp(PL_top_env->je_buf, (v));      \
 265         }                                                       \
 266         if ((v) == 2)                                           \
 267             PerlProc_exit(STATUS_NATIVE_EXPORT);                \
 268         PerlIO_printf(PerlIO_stderr(), "panic: top_env\n");     \
 269         PerlProc_exit(1);                                       \
 270     } STMT_END
 271
 272 #define EXCEPT_GET_ENV(cur_env) (cur_env.je_ret)
 273 #define EXCEPT_GET EXCEPT_GET_ENV(cur_env)
 274 #define EXCEPT_SET_ENV(cur_env,v)       (cur_env.je_ret = (v))
 275 #define EXCEPT_SET(v) EXCEPT_SET_ENV(cur_env,v)
 276
 277 #define CATCH_GET       (PL_top_env->je_mustcatch)
 278 #define CATCH_SET(v)    (PL_top_env->je_mustcatch = (v))
 279