scope.h

   1 /*    scope.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
   4  *    2002, 2004, 2005, 2006, 2007, 2008 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_AND_MORTALIZE       35
  47 #define SAVEt_MORTALIZESV       36
  48 #define SAVEt_SHARED_PVREF      37
  49 #define SAVEt_BOOL              38
  50 #define SAVEt_SET_SVFLAGS       39
  51 #define SAVEt_SAVESWITCHSTACK   40
  52 #define SAVEt_COP_ARYBASE       41
  53 #define SAVEt_RE_STATE          42
  54 #define SAVEt_COMPILE_WARNINGS  43
  55 #define SAVEt_STACK_CXPOS       44
  56 #define SAVEt_PARSER            45
  57 #define SAVEt_ADELETE           46
  58
  59 #define SAVEf_SETMAGIC          1
  60 #define SAVEf_KEEPOLDELEM       2
  61
  62 #define SAVE_TIGHT_SHIFT        6
  63 #define SAVE_MASK               0x3F
  64
  65 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
  66 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
  67
  68 #ifndef SCOPE_SAVES_SIGNAL_MASK
  69 #define SCOPE_SAVES_SIGNAL_MASK 0
  70 #endif
  71
  72 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
  73 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
  74 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
  75 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
  76 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
  77 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
  78 #define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
  79 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
  80 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
  81 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
  82 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
  83 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
  84 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
  85 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
  86 #define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
  87 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
  88 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
  89 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
  90
  91 /*
  92 =head1 Callback Functions
  93
  94 =for apidoc Ams||SAVETMPS
  95 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
  96 L<perlcall>.
  97
  98 =for apidoc Ams||FREETMPS
  99 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
 100 L<perlcall>.
 101
 102 =for apidoc Ams||ENTER
 103 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
 104
 105 =for apidoc Ams||LEAVE
 106 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
 107
 108 =over
 109
 110 =item ENTER_with_name(name)
 111
 112 Same as C<ENTER>, but when debugging is enabled it also associates the
 113 given literal string with the new scope.
 114
 115 =item LEAVE_with_name(name)
 116
 117 Same as C<LEAVE>, but when debugging is enabled it first checks that the
 118 scope has the given name. Name must be a literal string.
 119
 120 =back
 121
 122 =cut
 123 */
 124
 125 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
 126 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
 127
 128 #ifdef DEBUGGING
 129 #define ENTER                                                   \
 130     STMT_START {                                                \
 131         push_scope();                                           \
 132         DEBUG_SCOPE("ENTER")                                    \
 133     } STMT_END
 134 #define LEAVE                                                   \
 135     STMT_START {                                                \
 136         DEBUG_SCOPE("LEAVE")                                    \
 137         pop_scope();                                            \
 138     } STMT_END
 139 #define ENTER_with_name(name)                                           \
 140     STMT_START {                                                        \
 141         push_scope();                                                   \
 142         if (PL_scopestack_name)                                         \
 143             PL_scopestack_name[PL_scopestack_ix-1] = name;              \
 144         DEBUG_SCOPE("ENTER \"" name "\"")                               \
 145     } STMT_END
 146 #define LEAVE_with_name(name)                                           \
 147     STMT_START {                                                        \
 148         DEBUG_SCOPE("LEAVE \"" name "\"")                               \
 149         if (PL_scopestack_name) {                                       \
 150             assert(((char*)PL_scopestack_name[PL_scopestack_ix-1]       \
 151                         == (char*)name)                                 \
 152                     || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name));        \
 153         }                                                               \
 154         pop_scope();                                                    \
 155     } STMT_END
 156 #else
 157 #define ENTER push_scope()
 158 #define LEAVE pop_scope()
 159 #define ENTER_with_name(name) ENTER
 160 #define LEAVE_with_name(name) LEAVE
 161 #endif
 162 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
 163
 164 #define SAVEI8(i)       save_I8((I8*)&(i))
 165 #define SAVEI16(i)      save_I16((I16*)&(i))
 166 #define SAVEI32(i)      save_I32((I32*)&(i))
 167 #define SAVEINT(i)      save_int((int*)&(i))
 168 #define SAVEIV(i)       save_iv((IV*)&(i))
 169 #define SAVELONG(l)     save_long((long*)&(l))
 170 #define SAVEBOOL(b)     save_bool(&(b))
 171 #define SAVESPTR(s)     save_sptr((SV**)&(s))
 172 #define SAVEPPTR(s)     save_pptr((char**)&(s))
 173 #define SAVEVPTR(s)     save_vptr((void*)&(s))
 174 #define SAVEPADSVANDMORTALIZE(s)        save_padsv_and_mortalize(s)
 175 #define SAVEFREESV(s)   save_freesv(MUTABLE_SV(s))
 176 #define SAVEMORTALIZESV(s)      save_mortalizesv(MUTABLE_SV(s))
 177 #define SAVEFREEOP(o)   save_freeop((OP*)(o))
 178 #define SAVEFREEPV(p)   save_freepv((char*)(p))
 179 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
 180 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
 181 #define SAVEGENERICPV(s)        save_generic_pvref((char**)&(s))
 182 #define SAVESHAREDPV(s)         save_shared_pvref((char**)&(s))
 183 #define SAVESETSVFLAGS(sv,mask,val)     save_set_svflags(sv,mask,val)
 184 #define SAVEDELETE(h,k,l) \
 185           save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
 186 #define SAVEHDELETE(h,s) \
 187           save_hdelete(MUTABLE_HV(h), (s))
 188 #define SAVEADELETE(a,k) \
 189           save_adelete(MUTABLE_AV(a), (I32)(k))
 190 #define SAVEDESTRUCTOR(f,p) \
 191           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
 192
 193 #define SAVEDESTRUCTOR_X(f,p) \
 194           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
 195
 196 #define SAVESTACK_POS() \
 197     STMT_START {                                \
 198         SSCHECK(2);                             \
 199         SSPUSHINT(PL_stack_sp - PL_stack_base); \
 200         SSPUSHUV(SAVEt_STACK_POS);              \
 201     } STMT_END
 202
 203 #define SAVEOP()        save_op()
 204
 205 #define SAVEHINTS()     save_hints()
 206
 207 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
 208
 209 #define SAVESWITCHSTACK(f,t) \
 210     STMT_START {                                        \
 211         save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
 212         SWITCHSTACK((f),(t));                           \
 213         PL_curstackinfo->si_stack = (t);                \
 214     } STMT_END
 215
 216 #define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);
 217
 218 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
 219    because realloc() means that the value can actually change. Possibly
 220    could have done savefreesharedpvREF, but this way actually seems cleaner,
 221    as it simplifies the code that does the saves, and reduces the load on the
 222    save stack.  */
 223 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
 224
 225 #define SAVESTACK_CXPOS() \
 226     STMT_START {                                  \
 227         SSCHECK(3);                               \
 228         SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
 229         SSPUSHINT(cxstack_ix);                    \
 230         SSPUSHUV(SAVEt_STACK_CXPOS);              \
 231     } STMT_END
 232
 233 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
 234
 235 #ifdef USE_ITHREADS
 236 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
 237 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
 238 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
 239 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
 240 #else
 241 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
 242 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
 243 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
 244 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
 245 #endif
 246
 247 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
 248
 249 /* SSNEW() temporarily allocates a specified number of bytes of data on the
 250  * savestack.  It returns an integer index into the savestack, because a
 251  * pointer would get broken if the savestack is moved on reallocation.
 252  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
 253  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
 254  * alignment will be preserved therough savestack reallocation *only* if
 255  * realloc returns data aligned to a size divisible by "align"!
 256  *
 257  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
 258  */
 259
 260 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
 261 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
 262 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
 263     (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
 264 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
 265
 266 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
 267 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
 268
 269 #define save_freesv(op)         save_pushptr((void *)(op), SAVEt_FREESV)
 270 #define save_mortalizesv(op)    save_pushptr((void *)(op), SAVEt_MORTALIZESV)
 271 #define save_freeop(op)         save_pushptr((void *)(op), SAVEt_FREEOP)
 272 #define save_freepv(pv)         save_pushptr((void *)(pv), SAVEt_FREEPV)
 273 #define save_op()               save_pushptr((void *)(PL_op), SAVEt_OP)
 274
 275 /*
 276  * Local variables:
 277  * c-indentation-style: bsd
 278  * c-basic-offset: 4
 279  * indent-tabs-mode: t
 280  * End:
 281  *
 282  * ex: set ts=8 sts=4 sw=4 noet:
 283  */