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