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