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