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 /* *** Update arg_counts[] in scope.c if you modify these */ 12 13 /* zero args */ 14 15 #define SAVEt_ALLOC 0 16 #define SAVEt_CLEARPADRANGE 1 17 #define SAVEt_CLEARSV 2 18 #define SAVEt_REGCONTEXT 3 19 20 /* one arg */ 21 22 #define SAVEt_TMPSFLOOR 4 23 #define SAVEt_BOOL 5 24 #define SAVEt_COMPILE_WARNINGS 6 25 #define SAVEt_COMPPAD 7 26 #define SAVEt_FREECOPHH 8 27 #define SAVEt_FREEOP 9 28 #define SAVEt_FREEPV 10 29 #define SAVEt_FREESV 11 30 #define SAVEt_I16 12 31 #define SAVEt_I32_SMALL 13 32 #define SAVEt_I8 14 33 #define SAVEt_INT_SMALL 15 34 #define SAVEt_MORTALIZESV 16 35 #define SAVEt_NSTAB 17 36 #define SAVEt_OP 18 37 #define SAVEt_PARSER 19 38 #define SAVEt_STACK_POS 20 39 #define SAVEt_READONLY_OFF 21 40 #define SAVEt_FREEPADNAME 22 41 #define SAVEt_STRLEN_SMALL 23 42 43 /* two args */ 44 45 #define SAVEt_AV 24 46 #define SAVEt_DESTRUCTOR 25 47 #define SAVEt_DESTRUCTOR_X 26 48 #define SAVEt_GENERIC_PVREF 27 49 #define SAVEt_GENERIC_SVREF 28 50 #define SAVEt_GP 29 51 #define SAVEt_GVSV 30 52 #define SAVEt_HINTS 31 53 #define SAVEt_HPTR 32 54 #define SAVEt_HV 33 55 #define SAVEt_I32 34 56 #define SAVEt_INT 35 57 #define SAVEt_ITEM 36 58 #define SAVEt_IV 37 59 #define SAVEt_LONG 38 60 #define SAVEt_PPTR 39 61 #define SAVEt_SAVESWITCHSTACK 40 62 #define SAVEt_SHARED_PVREF 41 63 #define SAVEt_SPTR 42 64 #define SAVEt_STRLEN 43 65 #define SAVEt_SV 44 66 #define SAVEt_SVREF 45 67 #define SAVEt_VPTR 46 68 #define SAVEt_ADELETE 47 69 #define SAVEt_APTR 48 70 71 /* three args */ 72 73 #define SAVEt_HELEM 49 74 #define SAVEt_PADSV_AND_MORTALIZE 50 75 #define SAVEt_SET_SVFLAGS 51 76 #define SAVEt_GVSLOT 52 77 #define SAVEt_AELEM 53 78 #define SAVEt_DELETE 54 79 #define SAVEt_HINTS_HH 55 80 81 82 #define SAVEf_SETMAGIC 1 83 #define SAVEf_KEEPOLDELEM 2 84 85 #define SAVE_TIGHT_SHIFT 6 86 #define SAVE_MASK 0x3F 87 88 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC) 89 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC) 90 91 #ifndef SCOPE_SAVES_SIGNAL_MASK 92 #define SCOPE_SAVES_SIGNAL_MASK 0 93 #endif 94 95 /* the maximum number of entries that might be pushed using the SS_ADD* 96 * macros */ 97 #define SS_MAXPUSH 4 98 99 #define SSCHECK(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow() 100 #define SSGROW(need) if (UNLIKELY(PL_savestack_ix + (I32)(need) > PL_savestack_max)) savestack_grow_cnt(need) 101 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i)) 102 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i)) 103 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p)) 104 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i)) 105 #define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u)) 106 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p)) 107 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p)) 108 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p)) 109 110 /* SS_ADD*: newer, faster versions of the above. Don't mix the two sets of 111 * macros. These are fast because they save reduce accesses to the PL_ 112 * vars and move the size check to the end. Doing the check last means 113 * that values in registers will have been pushed and no longer needed, so 114 * don't need saving around the call to grow. Also, tail-call elimination 115 * of the grow() can be done. These changes reduce the code of something 116 * like save_pushptrptr() to half its former size. 117 * Of course, doing the size check *after* pushing means we must always 118 * ensure there are SS_MAXPUSH free slots on the savestack. This ensured 119 * bt savestack_grow() and savestack_grow_cnt always allocating SS_MAXPUSH 120 * slots more than asked for, or that it sets PL_savestack_max to 121 * 122 * These are for internal core use only and are subject to change */ 123 124 #define dSS_ADD \ 125 I32 ix = PL_savestack_ix; \ 126 ANY *ssp = &PL_savestack[ix] 127 128 #define SS_ADD_END(need) \ 129 assert((need) <= SS_MAXPUSH); \ 130 ix += (need); \ 131 PL_savestack_ix = ix; \ 132 assert(ix <= PL_savestack_max + SS_MAXPUSH); \ 133 if (UNLIKELY(ix > PL_savestack_max)) savestack_grow(); \ 134 assert(PL_savestack_ix <= PL_savestack_max); 135 136 #define SS_ADD_INT(i) ((ssp++)->any_i32 = (I32)(i)) 137 #define SS_ADD_LONG(i) ((ssp++)->any_long = (long)(i)) 138 #define SS_ADD_BOOL(p) ((ssp++)->any_bool = (p)) 139 #define SS_ADD_IV(i) ((ssp++)->any_iv = (IV)(i)) 140 #define SS_ADD_UV(u) ((ssp++)->any_uv = (UV)(u)) 141 #define SS_ADD_PTR(p) ((ssp++)->any_ptr = (void*)(p)) 142 #define SS_ADD_DPTR(p) ((ssp++)->any_dptr = (p)) 143 #define SS_ADD_DXPTR(p) ((ssp++)->any_dxptr = (p)) 144 145 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32) 146 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long) 147 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool) 148 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv) 149 #define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv) 150 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr) 151 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr) 152 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr) 153 154 155 /* 156 =for apidoc_section $callback 157 158 =for apidoc Amns||SAVETMPS 159 Opening bracket for temporaries on a callback. See C<L</FREETMPS>> and 160 L<perlcall>. 161 162 =for apidoc Amns||FREETMPS 163 Closing bracket for temporaries on a callback. See C<L</SAVETMPS>> and 164 L<perlcall>. 165 166 =for apidoc Amns||ENTER 167 Opening bracket on a callback. See C<L</LEAVE>> and L<perlcall>. 168 169 =for apidoc Amns||LEAVE 170 Closing bracket on a callback. See C<L</ENTER>> and L<perlcall>. 171 172 =for apidoc Ams||ENTER_with_name|"name" 173 174 Same as C<L</ENTER>>, but when debugging is enabled it also associates the 175 given literal string with the new scope. 176 177 =for apidoc Ams||LEAVE_with_name|"name" 178 179 Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the 180 scope has the given name. C<name> must be a literal string. 181 182 =cut 183 */ 184 185 #define SAVETMPS Perl_savetmps(aTHX) 186 187 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps() 188 189 #ifdef DEBUGGING 190 #define ENTER \ 191 STMT_START { \ 192 push_scope(); \ 193 DEBUG_SCOPE("ENTER") \ 194 } STMT_END 195 #define LEAVE \ 196 STMT_START { \ 197 DEBUG_SCOPE("LEAVE") \ 198 pop_scope(); \ 199 } STMT_END 200 #define ENTER_with_name(name) \ 201 STMT_START { \ 202 push_scope(); \ 203 if (PL_scopestack_name) \ 204 PL_scopestack_name[PL_scopestack_ix-1] = name; \ 205 DEBUG_SCOPE("ENTER \"" name "\"") \ 206 } STMT_END 207 #define LEAVE_with_name(name) \ 208 STMT_START { \ 209 DEBUG_SCOPE("LEAVE \"" name "\"") \ 210 if (PL_scopestack_name) { \ 211 CLANG_DIAG_IGNORE_STMT(-Wstring-compare); \ 212 assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \ 213 == (char*)name) \ 214 || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \ 215 CLANG_DIAG_RESTORE_STMT; \ 216 } \ 217 pop_scope(); \ 218 } STMT_END 219 #else 220 #define ENTER push_scope() 221 #define LEAVE pop_scope() 222 #define ENTER_with_name(name) ENTER 223 #define LEAVE_with_name(name) LEAVE 224 #endif 225 #define LEAVE_SCOPE(old) STMT_START { \ 226 if (PL_savestack_ix > old) leave_scope(old); \ 227 } STMT_END 228 229 #define SAVEI8(i) save_I8((I8*)&(i)) 230 #define SAVEI16(i) save_I16((I16*)&(i)) 231 #define SAVEI32(i) save_I32((I32*)&(i)) 232 #define SAVEINT(i) save_int((int*)&(i)) 233 #define SAVEIV(i) save_iv((IV*)&(i)) 234 #define SAVELONG(l) save_long((long*)&(l)) 235 #define SAVESTRLEN(l) Perl_save_strlen(aTHX_ (STRLEN*)&(l)) 236 #define SAVEBOOL(b) save_bool(&(b)) 237 #define SAVESPTR(s) save_sptr((SV**)&(s)) 238 #define SAVEPPTR(s) save_pptr((char**)&(s)) 239 #define SAVEVPTR(s) save_vptr((void*)&(s)) 240 #define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s) 241 #define SAVEFREESV(s) save_freesv(MUTABLE_SV(s)) 242 #define SAVEFREEPADNAME(s) save_pushptr((void *)(s), SAVEt_FREEPADNAME) 243 #define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s)) 244 #define SAVEFREEOP(o) save_freeop((OP*)(o)) 245 #define SAVEFREEPV(p) save_freepv((char*)(p)) 246 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv)) 247 #define SAVEGENERICSV(s) save_generic_svref((SV**)&(s)) 248 #define SAVEGENERICPV(s) save_generic_pvref((char**)&(s)) 249 #define SAVESHAREDPV(s) save_shared_pvref((char**)&(s)) 250 #define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val) 251 #define SAVEFREECOPHH(h) save_pushptr((void *)(h), SAVEt_FREECOPHH) 252 253 #define SAVEDELETE(h,k,l) \ 254 save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l)) 255 #define SAVEHDELETE(h,s) \ 256 save_hdelete(MUTABLE_HV(h), (s)) 257 #define SAVEADELETE(a,k) \ 258 save_adelete(MUTABLE_AV(a), (SSize_t)(k)) 259 #define SAVEDESTRUCTOR(f,p) \ 260 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p)) 261 262 #define SAVEDESTRUCTOR_X(f,p) \ 263 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p)) 264 265 #define SAVESTACK_POS() \ 266 STMT_START { \ 267 dSS_ADD; \ 268 SS_ADD_INT(PL_stack_sp - PL_stack_base); \ 269 SS_ADD_UV(SAVEt_STACK_POS); \ 270 SS_ADD_END(2); \ 271 } STMT_END 272 273 #define SAVEOP() save_op() 274 275 #define SAVEHINTS() save_hints() 276 277 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD) 278 279 #define SAVESWITCHSTACK(f,t) \ 280 STMT_START { \ 281 save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \ 282 SWITCHSTACK((f),(t)); \ 283 PL_curstackinfo->si_stack = (t); \ 284 } STMT_END 285 286 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV", 287 because realloc() means that the value can actually change. Possibly 288 could have done savefreesharedpvREF, but this way actually seems cleaner, 289 as it simplifies the code that does the saves, and reduces the load on the 290 save stack. */ 291 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS) 292 293 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER) 294 295 #ifdef USE_ITHREADS 296 # define SAVECOPSTASH_FREE(c) SAVEIV((c)->cop_stashoff) 297 # define SAVECOPFILE(c) SAVEPPTR(CopFILE(c)) 298 # define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c)) 299 #else 300 # /* XXX not refcounted */ 301 # define SAVECOPSTASH_FREE(c) SAVESPTR(CopSTASH(c)) 302 # define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c)) 303 # define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c)) 304 #endif 305 306 #define SAVECOPLINE(c) SAVEI32(CopLINE(c)) 307 308 /* SSNEW() temporarily allocates a specified number of bytes of data on the 309 * savestack. It returns an I32 index into the savestack, because a 310 * pointer would get broken if the savestack is moved on reallocation. 311 * SSNEWa() works like SSNEW(), but also aligns the data to the specified 312 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The 313 * alignment will be preserved through savestack reallocation *only* if 314 * realloc returns data aligned to a size divisible by "align"! 315 * 316 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer. 317 */ 318 319 #define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0) 320 #define SSNEWt(n,t) SSNEW((n)*sizeof(t)) 321 #define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \ 322 (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align) 323 #define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align) 324 325 #define SSPTR(off,type) ((type) ((char*)PL_savestack + off)) 326 #define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off)) 327 328 #define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV) 329 #define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV) 330 331 # define save_freeop(op) \ 332 STMT_START { \ 333 OP * const _o = (OP *)(op); \ 334 assert(!_o->op_savefree); \ 335 _o->op_savefree = 1; \ 336 save_pushptr((void *)(_o), SAVEt_FREEOP); \ 337 } STMT_END 338 #define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV) 339 #define save_op() save_pushptr((void *)(PL_op), SAVEt_OP) 340 341 /* 342 * ex: set ts=8 sts=4 sw=4 et: 343 */ 344