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 #define SAVEt_DESTRUCTOR_X      30
  32 #define SAVEt_VPTR              31
  33 #define SAVEt_I8                32
  34
  35 #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
  36 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
  37 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
  38 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
  39 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
  40 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
  41 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
  42 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
  43 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
  44 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
  45 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
  46 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
  47 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
  48
  49 /*
  50 =for apidoc Ams||SAVETMPS
  51 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
  52 L<perlcall>.
  53
  54 =for apidoc Ams||FREETMPS
  55 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
  56 L<perlcall>.
  57
  58 =for apidoc Ams||ENTER
  59 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
  60
  61 =for apidoc Ams||LEAVE
  62 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
  63
  64 =cut
  65 */
  66
  67 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
  68 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
  69
  70 #ifdef DEBUGGING
  71 #define ENTER                                                   \
  72     STMT_START {                                                \
  73         push_scope();                                           \
  74         DEBUG_l(WITH_THR(Perl_deb(aTHX_ "ENTER scope %ld at %s:%d\n",   \
  75                     PL_scopestack_ix, __FILE__, __LINE__)));    \
  76     } STMT_END
  77 #define LEAVE                                                   \
  78     STMT_START {                                                \
  79         DEBUG_l(WITH_THR(Perl_deb(aTHX_ "LEAVE scope %ld at %s:%d\n",   \
  80                     PL_scopestack_ix, __FILE__, __LINE__)));    \
  81         pop_scope();                                            \
  82     } STMT_END
  83 #else
  84 #define ENTER push_scope()
  85 #define LEAVE pop_scope()
  86 #endif
  87 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
  88
  89 /*
  90  * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
  91  * because these are used for several kinds of pointer values
  92  */
  93 #define SAVEI8(i)       save_I8(SOFT_CAST(I8*)&(i))
  94 #define SAVEI16(i)      save_I16(SOFT_CAST(I16*)&(i))
  95 #define SAVEI32(i)      save_I32(SOFT_CAST(I32*)&(i))
  96 #define SAVEINT(i)      save_int(SOFT_CAST(int*)&(i))
  97 #define SAVEIV(i)       save_iv(SOFT_CAST(IV*)&(i))
  98 #define SAVELONG(l)     save_long(SOFT_CAST(long*)&(l))
  99 #define SAVESPTR(s)     save_sptr((SV**)&(s))
 100 #define SAVEPPTR(s)     save_pptr(SOFT_CAST(char**)&(s))
 101 #define SAVEVPTR(s)     save_vptr((void*)&(s))
 102 #define SAVEFREESV(s)   save_freesv((SV*)(s))
 103 #define SAVEFREEOP(o)   save_freeop(SOFT_CAST(OP*)(o))
 104 #define SAVEFREEPV(p)   save_freepv(SOFT_CAST(char*)(p))
 105 #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
 106 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
 107 #define SAVEDELETE(h,k,l) \
 108           save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
 109 #define SAVEDESTRUCTOR(f,p) \
 110           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), SOFT_CAST(void*)(p))
 111
 112 #define SAVEDESTRUCTOR_X(f,p) \
 113           save_destructor_x((DESTRUCTORFUNC_t)(f), SOFT_CAST(void*)(p))
 114
 115 #define SAVESTACK_POS() \
 116     STMT_START {                                \
 117         SSCHECK(2);                             \
 118         SSPUSHINT(PL_stack_sp - PL_stack_base); \
 119         SSPUSHINT(SAVEt_STACK_POS);             \
 120     } STMT_END
 121
 122 #define SAVEOP()        save_op()
 123
 124 #define SAVEHINTS() \
 125     STMT_START {                                \
 126         if (PL_hints & HINT_LOCALIZE_HH)        \
 127             save_hints();                       \
 128         else {                                  \
 129             SSCHECK(2);                         \
 130             SSPUSHINT(PL_hints);                \
 131             SSPUSHINT(SAVEt_HINTS);             \
 132         }                                       \
 133     } STMT_END
 134
 135 #ifdef USE_ITHREADS
 136 #  define SAVECOPSTASH(cop)     SAVEPPTR(CopSTASHPV(cop))
 137 #  define SAVECOPFILE(cop)      SAVEPPTR(CopFILE(cop))
 138 #else
 139 #  define SAVECOPSTASH(cop)     SAVESPTR(CopSTASH(cop))
 140 #  define SAVECOPFILE(cop)      SAVESPTR(CopFILEGV(cop))
 141 #endif
 142
 143 #define SAVECOPLINE(cop)        SAVEI16(CopLINE(cop))
 144
 145 /* SSNEW() temporarily allocates a specified number of bytes of data on the
 146  * savestack.  It returns an integer index into the savestack, because a
 147  * pointer would get broken if the savestack is moved on reallocation.
 148  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
 149  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
 150  * alignment will be preserved therough savestack reallocation *only* if
 151  * realloc returns data aligned to a size divisible by `align'!
 152  *
 153  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
 154  */
 155
 156 #define SSNEW(size)             save_alloc(size, 0)
 157 #define SSNEWa(size,align)      save_alloc(size, \
 158     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
 159
 160 #define SSPTR(off,type)         ((type) ((char*)PL_savestack + off))
 161
 162 /* A jmpenv packages the state required to perform a proper non-local jump.
 163  * Note that there is a start_env initialized when perl starts, and top_env
 164  * points to this initially, so top_env should always be non-null.
 165  *
 166  * Existence of a non-null top_env->je_prev implies it is valid to call
 167  * longjmp() at that runlevel (we make sure start_env.je_prev is always
 168  * null to ensure this).
 169  *
 170  * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
 171  * establish a local jmpenv to handle exception traps.  Care must be taken
 172  * to restore the previous value of je_mustcatch before exiting the
 173  * stack frame iff JMPENV_PUSH was not called in that stack frame.
 174  * GSAR 97-03-27
 175  */
 176
 177 struct jmpenv {
 178     struct jmpenv *     je_prev;
 179     Sigjmp_buf          je_buf;         /* only for use if !je_throw */
 180     int                 je_ret;         /* last exception thrown */
 181     bool                je_mustcatch;   /* need to call longjmp()? */
 182     void                (*je_throw)(int v); /* last for bincompat */
 183     bool                je_noset;       /* no need for setjmp() */
 184 };
 185
 186 typedef struct jmpenv JMPENV;
 187
 188 /*
 189  * Function that catches/throws, and its callback for the
 190  *  body of protected processing.
 191  */
 192 typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
 193 typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env,
 194                                              int *, protect_body_t, ...);
 195
 196 /*
 197  * How to build the first jmpenv.
 198  *
 199  * top_env needs to be non-zero. It points to an area
 200  * in which longjmp() stuff is stored, as C callstack
 201  * info there at least is thread specific this has to
 202  * be per-thread. Otherwise a 'die' in a thread gives
 203  * that thread the C stack of last thread to do an eval {}!
 204  */
 205
 206 #define JMPENV_BOOTSTRAP \
 207     STMT_START {                                \
 208         PL_start_env.je_prev = NULL;            \
 209         PL_start_env.je_throw = NULL;           \
 210         PL_start_env.je_ret = -1;               \
 211         PL_start_env.je_mustcatch = TRUE;       \
 212         PL_start_env.je_noset = 0;              \
 213         PL_top_env = &PL_start_env;             \
 214     } STMT_END
 215
 216 #ifdef OP_IN_REGISTER
 217 #define OP_REG_TO_MEM   PL_opsave = op
 218 #define OP_MEM_TO_REG   op = PL_opsave
 219 #else
 220 #define OP_REG_TO_MEM   NOOP
 221 #define OP_MEM_TO_REG   NOOP
 222 #endif
 223
 224 /*
 225  * These exception-handling macros are split up to
 226  * ease integration with C++ exceptions.
 227  *
 228  * To use C++ try+catch to catch Perl exceptions, an extension author
 229  * needs to first write an extern "C" function to throw an appropriate
 230  * exception object; typically it will be or contain an integer,
 231  * because Perl's internals use integers to track exception types:
 232  *    extern "C" { static void thrower(int i) { throw i; } }
 233  *
 234  * Then (as shown below) the author needs to use, not the simple
 235  * JMPENV_PUSH, but several of its constitutent macros, to arrange for
 236  * the Perl internals to call thrower() rather than longjmp() to
 237  * report exceptions:
 238  *
 239  *    dJMPENV;
 240  *    JMPENV_PUSH_INIT(thrower);
 241  *    try {
 242  *        ... stuff that may throw exceptions ...
 243  *    }
 244  *    catch (int why) {  // or whatever matches thrower()
 245  *        JMPENV_POST_CATCH;
 246  *        EXCEPT_SET(why);
 247  *        switch (why) {
 248  *          ... // handle various Perl exception codes
 249  *        }
 250  *    }
 251  *    JMPENV_POP;  // don't forget this!
 252  */
 253
 254 #define dJMPENV JMPENV cur_env; \
 255                 volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env)
 256
 257 #define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \
 258     STMT_START {                                        \
 259         (ce).je_throw = (THROWFUNC);                    \
 260         (ce).je_ret = -1;                               \
 261         (ce).je_mustcatch = FALSE;                      \
 262         (ce).je_prev = PL_top_env;                      \
 263         PL_top_env = &(ce);                             \
 264         OP_REG_TO_MEM;                                  \
 265     } STMT_END
 266
 267 #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC)
 268
 269 #define JMPENV_POST_CATCH_ENV(ce) \
 270     STMT_START {                                        \
 271         OP_MEM_TO_REG;                                  \
 272         PL_top_env = &(ce);                             \
 273     } STMT_END
 274
 275 #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env)
 276
 277
 278 #define JMPENV_PUSH_ENV(ce,v) \
 279     STMT_START {                                                \
 280         if (!(ce).je_noset) {                                   \
 281             JMPENV_PUSH_INIT_ENV(ce,NULL);                      \
 282             EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, 1));\
 283             (ce).je_noset = 1;                                  \
 284         }                                                       \
 285         else                                                    \
 286             EXCEPT_SET_ENV(ce,0);                               \
 287         JMPENV_POST_CATCH_ENV(ce);                              \
 288         (v) = EXCEPT_GET_ENV(ce);                               \
 289     } STMT_END
 290
 291 #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v)
 292
 293 #define JMPENV_POP_ENV(ce) \
 294     STMT_START { PL_top_env = (ce).je_prev; } STMT_END
 295
 296 #define JMPENV_POP  JMPENV_POP_ENV(*(JMPENV*)pcur_env)
 297
 298 #define JMPENV_JUMP(v) \
 299     STMT_START {                                                \
 300         OP_REG_TO_MEM;                                          \
 301         if (PL_top_env->je_prev) {                              \
 302             if (PL_top_env->je_throw)                           \
 303                 PL_top_env->je_throw(v);                        \
 304             else                                                \
 305                 PerlProc_longjmp(PL_top_env->je_buf, (v));      \
 306         }                                                       \
 307         if ((v) == 2)                                           \
 308             PerlProc_exit(STATUS_NATIVE_EXPORT);                \
 309         PerlIO_printf(Perl_error_log, "panic: top_env\n");      \
 310         PerlProc_exit(1);                                       \
 311     } STMT_END
 312
 313 #define EXCEPT_GET_ENV(ce)      ((ce).je_ret)
 314 #define EXCEPT_GET              EXCEPT_GET_ENV(*(JMPENV*)pcur_env)
 315 #define EXCEPT_SET_ENV(ce,v)    ((ce).je_ret = (v))
 316 #define EXCEPT_SET(v)           EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v)
 317
 318 #define CATCH_GET               (PL_top_env->je_mustcatch)
 319 #define CATCH_SET(v)            (PL_top_env->je_mustcatch = (v))