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