scope.h

   1 /*    scope.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 #define SAVEt_ITEM              0
  12 #define SAVEt_SV                1
  13 #define SAVEt_AV                2
  14 #define SAVEt_HV                3
  15 #define SAVEt_INT               4
  16 #define SAVEt_LONG              5
  17 #define SAVEt_I32               6
  18 #define SAVEt_IV                7
  19 #define SAVEt_SPTR              8
  20 #define SAVEt_APTR              9
  21 #define SAVEt_HPTR              10
  22 #define SAVEt_PPTR              11
  23 #define SAVEt_NSTAB             12
  24 #define SAVEt_SVREF             13
  25 #define SAVEt_GP                14
  26 #define SAVEt_FREESV            15
  27 #define SAVEt_FREEOP            16
  28 #define SAVEt_FREEPV            17
  29 #define SAVEt_CLEARSV           18
  30 #define SAVEt_DELETE            19
  31 #define SAVEt_DESTRUCTOR        20
  32 #define SAVEt_REGCONTEXT        21
  33 #define SAVEt_STACK_POS         22
  34 #define SAVEt_I16               23
  35 #define SAVEt_AELEM             24
  36 #define SAVEt_HELEM             25
  37 #define SAVEt_OP                26
  38 #define SAVEt_HINTS             27
  39 #define SAVEt_ALLOC             28
  40 #define SAVEt_GENERIC_SVREF     29
  41 #define SAVEt_DESTRUCTOR_X      30
  42 #define SAVEt_VPTR              31
  43 #define SAVEt_I8                32
  44 #define SAVEt_COMPPAD           33
  45 #define SAVEt_GENERIC_PVREF     34
  46 #define SAVEt_PADSV             35
  47 #define SAVEt_MORTALIZESV       36
  48 #define SAVEt_SHARED_PVREF      37
  49 #define SAVEt_BOOL              38
  50
  51 #ifndef SCOPE_SAVES_SIGNAL_MASK
  52 #define SCOPE_SAVES_SIGNAL_MASK 0
  53 #endif
  54
  55 #define SSCHECK(need) if (PL_savestack_ix + need > PL_savestack_max) savestack_grow()
  56 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
  57 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
  58 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
  59 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
  60 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
  61 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
  62 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
  63 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
  64 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
  65 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
  66 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
  67 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
  68 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
  69 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
  70
  71 /*
  72 =head1 Callback Functions
  73
  74 =for apidoc Ams||SAVETMPS
  75 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
  76 L<perlcall>.
  77
  78 =for apidoc Ams||FREETMPS
  79 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
  80 L<perlcall>.
  81
  82 =for apidoc Ams||ENTER
  83 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
  84
  85 =for apidoc Ams||LEAVE
  86 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
  87
  88 =cut
  89 */
  90
  91 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
  92 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
  93
  94 #ifdef DEBUGGING
  95 #define ENTER                                                   \
  96     STMT_START {                                                \
  97         push_scope();                                           \
  98         DEBUG_l(WITH_THR(Perl_deb(aTHX_ "ENTER scope %ld at %s:%d\n",   \
  99                     PL_scopestack_ix, __FILE__, __LINE__)));    \
 100     } STMT_END
 101 #define LEAVE                                                   \
 102     STMT_START {                                                \
 103         DEBUG_l(WITH_THR(Perl_deb(aTHX_ "LEAVE scope %ld at %s:%d\n",   \
 104                     PL_scopestack_ix, __FILE__, __LINE__)));    \
 105         pop_scope();                                            \
 106     } STMT_END
 107 #else
 108 #define ENTER push_scope()
 109 #define LEAVE pop_scope()
 110 #endif
 111 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
 112
 113 /*
 114  * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
 115  * because these are used for several kinds of pointer values
 116  */
 117 #define SAVEI8(i)       save_I8(SOFT_CAST(I8*)&(i))
 118 #define SAVEI16(i)      save_I16(SOFT_CAST(I16*)&(i))
 119 #define SAVEI32(i)      save_I32(SOFT_CAST(I32*)&(i))
 120 #define SAVEINT(i)      save_int(SOFT_CAST(int*)&(i))
 121 #define SAVEIV(i)       save_iv(SOFT_CAST(IV*)&(i))
 122 #define SAVELONG(l)     save_long(SOFT_CAST(long*)&(l))
 123 #define SAVEBOOL(b)     save_bool(SOFT_CAST(bool*)&(b))
 124 #define SAVESPTR(s)     save_sptr((SV**)&(s))
 125 #define SAVEPPTR(s)     save_pptr(SOFT_CAST(char**)&(s))
 126 #define SAVEVPTR(s)     save_vptr((void*)&(s))
 127 #define SAVEPADSV(s)    save_padsv(s)
 128 #define SAVEFREESV(s)   save_freesv((SV*)(s))
 129 #define SAVEMORTALIZESV(s)      save_mortalizesv((SV*)(s))
 130 #define SAVEFREEOP(o)   save_freeop(SOFT_CAST(OP*)(o))
 131 #define SAVEFREEPV(p)   save_freepv(SOFT_CAST(char*)(p))
 132 #define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
 133 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
 134 #define SAVEGENERICPV(s)        save_generic_pvref((char**)&(s))
 135 #define SAVESHAREDPV(s)         save_shared_pvref((char**)&(s))
 136 #define SAVEDELETE(h,k,l) \
 137           save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
 138 #define SAVEDESTRUCTOR(f,p) \
 139           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), SOFT_CAST(void*)(p))
 140
 141 #define SAVEDESTRUCTOR_X(f,p) \
 142           save_destructor_x((DESTRUCTORFUNC_t)(f), SOFT_CAST(void*)(p))
 143
 144 #define SAVESTACK_POS() \
 145     STMT_START {                                \
 146         SSCHECK(2);                             \
 147         SSPUSHINT(PL_stack_sp - PL_stack_base); \
 148         SSPUSHINT(SAVEt_STACK_POS);             \
 149     } STMT_END
 150
 151 #define SAVEOP()        save_op()
 152
 153 #define SAVEHINTS() \
 154     STMT_START {                                \
 155         if (PL_hints & HINT_LOCALIZE_HH)        \
 156             save_hints();                       \
 157         else {                                  \
 158             SSCHECK(2);                         \
 159             SSPUSHINT(PL_hints);                \
 160             SSPUSHINT(SAVEt_HINTS);             \
 161         }                                       \
 162     } STMT_END
 163
 164 #define SAVECOMPPAD() \
 165     STMT_START {                                                \
 166         SSCHECK(2);                                             \
 167         SSPUSHPTR((SV*)PL_comppad);                             \
 168         SSPUSHINT(SAVEt_COMPPAD);                               \
 169     } STMT_END
 170
 171 #ifdef USE_ITHREADS
 172 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
 173 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
 174 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
 175 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
 176 #else
 177 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
 178 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
 179 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
 180 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
 181 #endif
 182
 183 #define SAVECOPLINE(c)          SAVEI16(CopLINE(c))
 184
 185 /* SSNEW() temporarily allocates a specified number of bytes of data on the
 186  * savestack.  It returns an integer index into the savestack, because a
 187  * pointer would get broken if the savestack is moved on reallocation.
 188  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
 189  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
 190  * alignment will be preserved therough savestack reallocation *only* if
 191  * realloc returns data aligned to a size divisible by `align'!
 192  *
 193  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
 194  */
 195
 196 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
 197 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
 198 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
 199     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
 200 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
 201
 202 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
 203 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
 204
 205 /* A jmpenv packages the state required to perform a proper non-local jump.
 206  * Note that there is a start_env initialized when perl starts, and top_env
 207  * points to this initially, so top_env should always be non-null.
 208  *
 209  * Existence of a non-null top_env->je_prev implies it is valid to call
 210  * longjmp() at that runlevel (we make sure start_env.je_prev is always
 211  * null to ensure this).
 212  *
 213  * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
 214  * establish a local jmpenv to handle exception traps.  Care must be taken
 215  * to restore the previous value of je_mustcatch before exiting the
 216  * stack frame iff JMPENV_PUSH was not called in that stack frame.
 217  * GSAR 97-03-27
 218  */
 219
 220 struct jmpenv {
 221     struct jmpenv *     je_prev;
 222     Sigjmp_buf          je_buf;         /* only for use if !je_throw */
 223     int                 je_ret;         /* last exception thrown */
 224     bool                je_mustcatch;   /* need to call longjmp()? */
 225 #ifdef PERL_FLEXIBLE_EXCEPTIONS
 226     void                (*je_throw)(int v); /* last for bincompat */
 227     bool                je_noset;       /* no need for setjmp() */
 228 #endif
 229 };
 230
 231 typedef struct jmpenv JMPENV;
 232
 233 #ifdef OP_IN_REGISTER
 234 #define OP_REG_TO_MEM   PL_opsave = op
 235 #define OP_MEM_TO_REG   op = PL_opsave
 236 #else
 237 #define OP_REG_TO_MEM   NOOP
 238 #define OP_MEM_TO_REG   NOOP
 239 #endif
 240
 241 /*
 242  * How to build the first jmpenv.
 243  *
 244  * top_env needs to be non-zero. It points to an area
 245  * in which longjmp() stuff is stored, as C callstack
 246  * info there at least is thread specific this has to
 247  * be per-thread. Otherwise a 'die' in a thread gives
 248  * that thread the C stack of last thread to do an eval {}!
 249  */
 250
 251 #define JMPENV_BOOTSTRAP \
 252     STMT_START {                                \
 253         Zero(&PL_start_env, 1, JMPENV);         \
 254         PL_start_env.je_ret = -1;               \
 255         PL_start_env.je_mustcatch = TRUE;       \
 256         PL_top_env = &PL_start_env;             \
 257     } STMT_END
 258
 259 #ifdef PERL_FLEXIBLE_EXCEPTIONS
 260
 261 /*
 262  * These exception-handling macros are split up to
 263  * ease integration with C++ exceptions.
 264  *
 265  * To use C++ try+catch to catch Perl exceptions, an extension author
 266  * needs to first write an extern "C" function to throw an appropriate
 267  * exception object; typically it will be or contain an integer,
 268  * because Perl's internals use integers to track exception types:
 269  *    extern "C" { static void thrower(int i) { throw i; } }
 270  *
 271  * Then (as shown below) the author needs to use, not the simple
 272  * JMPENV_PUSH, but several of its constitutent macros, to arrange for
 273  * the Perl internals to call thrower() rather than longjmp() to
 274  * report exceptions:
 275  *
 276  *    dJMPENV;
 277  *    JMPENV_PUSH_INIT(thrower);
 278  *    try {
 279  *        ... stuff that may throw exceptions ...
 280  *    }
 281  *    catch (int why) {  // or whatever matches thrower()
 282  *        JMPENV_POST_CATCH;
 283  *        EXCEPT_SET(why);
 284  *        switch (why) {
 285  *          ... // handle various Perl exception codes
 286  *        }
 287  *    }
 288  *    JMPENV_POP;  // don't forget this!
 289  */
 290
 291 /*
 292  * Function that catches/throws, and its callback for the
 293  *  body of protected processing.
 294  */
 295 typedef void *(CPERLscope(*protect_body_t)) (pTHX_ va_list);
 296 typedef void *(CPERLscope(*protect_proc_t)) (pTHX_ volatile JMPENV *pcur_env,
 297                                              int *, protect_body_t, ...);
 298
 299 #define dJMPENV JMPENV cur_env; \
 300                 volatile JMPENV *pcur_env = ((cur_env.je_noset = 0),&cur_env)
 301
 302 #define JMPENV_PUSH_INIT_ENV(ce,THROWFUNC) \
 303     STMT_START {                                        \
 304         (ce).je_throw = (THROWFUNC);                    \
 305         (ce).je_ret = -1;                               \
 306         (ce).je_mustcatch = FALSE;                      \
 307         (ce).je_prev = PL_top_env;                      \
 308         PL_top_env = &(ce);                             \
 309         OP_REG_TO_MEM;                                  \
 310     } STMT_END
 311
 312 #define JMPENV_PUSH_INIT(THROWFUNC) JMPENV_PUSH_INIT_ENV(*(JMPENV*)pcur_env,THROWFUNC)
 313
 314 #define JMPENV_POST_CATCH_ENV(ce) \
 315     STMT_START {                                        \
 316         OP_MEM_TO_REG;                                  \
 317         PL_top_env = &(ce);                             \
 318     } STMT_END
 319
 320 #define JMPENV_POST_CATCH JMPENV_POST_CATCH_ENV(*(JMPENV*)pcur_env)
 321
 322 #define JMPENV_PUSH_ENV(ce,v) \
 323     STMT_START {                                                \
 324         if (!(ce).je_noset) {                                   \
 325             DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n", \
 326                              ce, PL_top_env));                  \
 327             JMPENV_PUSH_INIT_ENV(ce,NULL);                      \
 328             EXCEPT_SET_ENV(ce,PerlProc_setjmp((ce).je_buf, SCOPE_SAVES_SIGNAL_MASK));\
 329             (ce).je_noset = 1;                                  \
 330         }                                                       \
 331         else                                                    \
 332             EXCEPT_SET_ENV(ce,0);                               \
 333         JMPENV_POST_CATCH_ENV(ce);                              \
 334         (v) = EXCEPT_GET_ENV(ce);                               \
 335     } STMT_END
 336
 337 #define JMPENV_PUSH(v) JMPENV_PUSH_ENV(*(JMPENV*)pcur_env,v)
 338
 339 #define JMPENV_POP_ENV(ce) \
 340     STMT_START {                                                \
 341         if (PL_top_env == &(ce))                                \
 342             PL_top_env = (ce).je_prev;                          \
 343     } STMT_END
 344
 345 #define JMPENV_POP  JMPENV_POP_ENV(*(JMPENV*)pcur_env)
 346
 347 #define JMPENV_JUMP(v) \
 348     STMT_START {                                                \
 349         OP_REG_TO_MEM;                                          \
 350         if (PL_top_env->je_prev) {                              \
 351             if (PL_top_env->je_throw)                           \
 352                 PL_top_env->je_throw(v);                        \
 353             else                                                \
 354                 PerlProc_longjmp(PL_top_env->je_buf, (v));      \
 355         }                                                       \
 356         if ((v) == 2)                                           \
 357             PerlProc_exit(STATUS_NATIVE_EXPORT);                \
 358         PerlIO_printf(Perl_error_log, "panic: top_env\n");      \
 359         PerlProc_exit(1);                                       \
 360     } STMT_END
 361
 362 #define EXCEPT_GET_ENV(ce)      ((ce).je_ret)
 363 #define EXCEPT_GET              EXCEPT_GET_ENV(*(JMPENV*)pcur_env)
 364 #define EXCEPT_SET_ENV(ce,v)    ((ce).je_ret = (v))
 365 #define EXCEPT_SET(v)           EXCEPT_SET_ENV(*(JMPENV*)pcur_env,v)
 366
 367 #else /* !PERL_FLEXIBLE_EXCEPTIONS */
 368
 369 #define dJMPENV         JMPENV cur_env
 370
 371 #define JMPENV_PUSH(v) \
 372     STMT_START {                                                        \
 373         DEBUG_l(Perl_deb(aTHX_ "Setting up jumplevel %p, was %p\n",     \
 374                          &cur_env, PL_top_env));                        \
 375         cur_env.je_prev = PL_top_env;                                   \
 376         OP_REG_TO_MEM;                                                  \
 377         cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, SCOPE_SAVES_SIGNAL_MASK);              \
 378         OP_MEM_TO_REG;                                                  \
 379         PL_top_env = &cur_env;                                          \
 380         cur_env.je_mustcatch = FALSE;                                   \
 381         (v) = cur_env.je_ret;                                           \
 382     } STMT_END
 383
 384 #define JMPENV_POP \
 385     STMT_START { PL_top_env = cur_env.je_prev; } STMT_END
 386
 387 #define JMPENV_JUMP(v) \
 388     STMT_START {                                                \
 389         OP_REG_TO_MEM;                                          \
 390         if (PL_top_env->je_prev)                                \
 391             PerlProc_longjmp(PL_top_env->je_buf, (v));          \
 392         if ((v) == 2)                                           \
 393             PerlProc_exit(STATUS_NATIVE_EXPORT);                \
 394         PerlIO_printf(PerlIO_stderr(), "panic: top_env\n");     \
 395         PerlProc_exit(1);                                       \
 396     } STMT_END
 397
 398 #endif /* PERL_FLEXIBLE_EXCEPTIONS */
 399
 400 #define CATCH_GET               (PL_top_env->je_mustcatch)
 401 #define CATCH_SET(v)            (PL_top_env->je_mustcatch = (v))