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