scope.h

   1 /*    scope.h
   2  *
   3  *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2004, 2005 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 #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
  56 #ifndef SCOPE_SAVES_SIGNAL_MASK
  57 #define SCOPE_SAVES_SIGNAL_MASK 0
  58 #endif
  59
  60 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
  61 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
  62 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
  63 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
  64 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
  65 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
  66 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
  67 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
  68 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
  69 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
  70 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
  71 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
  72 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
  73 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
  74 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
  75 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
  76
  77 /*
  78 =head1 Callback Functions
  79
  80 =for apidoc Ams||SAVETMPS
  81 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
  82 L<perlcall>.
  83
  84 =for apidoc Ams||FREETMPS
  85 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
  86 L<perlcall>.
  87
  88 =for apidoc Ams||ENTER
  89 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
  90
  91 =for apidoc Ams||LEAVE
  92 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
  93
  94 =cut
  95 */
  96
  97 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
  98 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
  99
 100 #ifdef DEBUGGING
 101 #define ENTER                                                   \
 102     STMT_START {                                                \
 103         push_scope();                                           \
 104         DEBUG_SCOPE("ENTER")                                    \
 105     } STMT_END
 106 #define LEAVE                                                   \
 107     STMT_START {                                                \
 108         DEBUG_SCOPE("LEAVE")                                    \
 109         pop_scope();                                            \
 110     } STMT_END
 111 #else
 112 #define ENTER push_scope()
 113 #define LEAVE pop_scope()
 114 #endif
 115 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
 116
 117 #define SAVEI8(i)       save_I8((I8*)&(i))
 118 #define SAVEI16(i)      save_I16((I16*)&(i))
 119 #define SAVEI32(i)      save_I32((I32*)&(i))
 120 #define SAVEINT(i)      save_int((int*)&(i))
 121 #define SAVEIV(i)       save_iv((IV*)&(i))
 122 #define SAVELONG(l)     save_long((long*)&(l))
 123 #define SAVEBOOL(b)     save_bool((bool*)&(b))
 124 #define SAVESPTR(s)     save_sptr((SV**)&(s))
 125 #define SAVEPPTR(s)     save_pptr((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((OP*)(o))
 131 #define SAVEFREEPV(p)   save_freepv((char*)(p))
 132 #define SAVECLEARSV(sv) save_clearsv((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 SAVESETSVFLAGS(sv,mask,val)     save_set_svflags(sv,mask,val)
 137 #define SAVEDELETE(h,k,l) \
 138           save_delete((HV*)(h), (char*)(k), (I32)(l))
 139 #define SAVEDESTRUCTOR(f,p) \
 140           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
 141
 142 #define SAVEDESTRUCTOR_X(f,p) \
 143           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
 144
 145 #define SAVESTACK_POS() \
 146     STMT_START {                                \
 147         SSCHECK(2);                             \
 148         SSPUSHINT(PL_stack_sp - PL_stack_base); \
 149         SSPUSHINT(SAVEt_STACK_POS);             \
 150     } STMT_END
 151
 152 #define SAVEOP()        save_op()
 153
 154 #define SAVEHINTS() \
 155     STMT_START {                                        \
 156         SSCHECK(4);                                     \
 157         if (PL_hints & HINT_LOCALIZE_HH) {              \
 158             SSPUSHPTR(GvHV(PL_hintgv));                 \
 159             GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
 160         }                                               \
 161         if (PL_compiling.cop_hints_hash) {              \
 162             HINTS_REFCNT_LOCK;                          \
 163             PL_compiling.cop_hints_hash->refcounted_he_refcnt++;        \
 164             HINTS_REFCNT_UNLOCK;                        \
 165         }                                               \
 166         SSPUSHPTR(PL_compiling.cop_hints_hash);         \
 167         SSPUSHINT(PL_hints);                            \
 168         SSPUSHINT(SAVEt_HINTS);                         \
 169     } STMT_END
 170
 171 #define SAVECOMPPAD() \
 172     STMT_START {                                                \
 173         SSCHECK(2);                                             \
 174         SSPUSHPTR((SV*)PL_comppad);                             \
 175         SSPUSHINT(SAVEt_COMPPAD);                               \
 176     } STMT_END
 177
 178 #define SAVESWITCHSTACK(f,t) \
 179     STMT_START {                                        \
 180         SSCHECK(3);                                     \
 181         SSPUSHPTR((SV*)(f));                            \
 182         SSPUSHPTR((SV*)(t));                            \
 183         SSPUSHINT(SAVEt_SAVESWITCHSTACK);               \
 184         SWITCHSTACK((f),(t));                           \
 185         PL_curstackinfo->si_stack = (t);                \
 186     } STMT_END
 187
 188 #define SAVECOPARYBASE(c) \
 189     STMT_START {                                        \
 190         SSCHECK(3);                                     \
 191         SSPUSHINT(CopARYBASE_get(c));                   \
 192         SSPUSHPTR(c);                                   \
 193         SSPUSHINT(SAVEt_COP_ARYBASE);                   \
 194     } STMT_END
 195
 196 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
 197    because realloc() means that the value can actually change. Possibly
 198    could have done savefreesharedpvREF, but this way actually seems cleaner,
 199    as it simplifies the code that does the saves, and reduces the load on the
 200    save stack.  */
 201 #define SAVECOMPILEWARNINGS() \
 202     STMT_START {                                        \
 203         SSCHECK(2);                                     \
 204         SSPUSHPTR(PL_compiling.cop_warnings);           \
 205         SSPUSHINT(SAVEt_COMPILE_WARNINGS);              \
 206     } STMT_END
 207
 208 #ifdef USE_ITHREADS
 209 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
 210 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
 211 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
 212 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
 213 #else
 214 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
 215 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
 216 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
 217 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
 218 #endif
 219
 220 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
 221
 222 /* SSNEW() temporarily allocates a specified number of bytes of data on the
 223  * savestack.  It returns an integer index into the savestack, because a
 224  * pointer would get broken if the savestack is moved on reallocation.
 225  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
 226  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
 227  * alignment will be preserved therough savestack reallocation *only* if
 228  * realloc returns data aligned to a size divisible by "align"!
 229  *
 230  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
 231  */
 232
 233 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
 234 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
 235 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
 236     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
 237 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
 238
 239 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
 240 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
 241