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