3 * Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008,
4 * 2009, 2010, 2011 by Larry Wall and others
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.
9 * This file defines the types and macros associated with the API for
10 * manipulating scratchpads, which are used by perl to store lexical
11 * variables, op targets and constants.
15 =head1 Pad Data Structures
19 /* offsets within a pad */
22 typedef U32TYPE PADOFFSET;
25 typedef U64TYPE PADOFFSET;
28 #define NOT_IN_PAD ((PADOFFSET) -1)
32 SSize_t xpadl_max; /* max index for which array has space */
33 PAD ** xpadl_alloc; /* pointer to beginning of array of AVs */
34 U32 xpadl_id; /* Semi-unique ID, shared between clones */
35 U32 xpadl_outid; /* ID of outer pad */
39 /* a value that PL_cop_seqmax is guaranteed never to be,
40 * flagging that a lexical is being introduced, or has not yet left scope
42 #define PERL_PADSEQ_INTRO U32_MAX
45 /* B.xs needs these for the benefit of B::Deparse */
46 /* Low range end is exclusive (valid from the cop seq after this one) */
47 /* High range end is inclusive (valid up to this cop seq) */
49 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
50 # define COP_SEQ_RANGE_LOW(sv) \
51 (({ const SV *const _sv_cop_seq_range_low = (const SV *) (sv); \
52 assert(SvTYPE(_sv_cop_seq_range_low) == SVt_NV \
53 || SvTYPE(_sv_cop_seq_range_low) >= SVt_PVNV); \
54 assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVAV); \
55 assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVHV); \
56 assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVCV); \
57 assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVFM); \
58 assert(!isGV_with_GP(_sv_cop_seq_range_low)); \
59 ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_low)))->xnv_u.xpad_cop_seq.xlow; \
61 # define COP_SEQ_RANGE_HIGH(sv) \
62 (({ const SV *const _sv_cop_seq_range_high = (const SV *) (sv); \
63 assert(SvTYPE(_sv_cop_seq_range_high) == SVt_NV \
64 || SvTYPE(_sv_cop_seq_range_high) >= SVt_PVNV); \
65 assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVAV); \
66 assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVHV); \
67 assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVCV); \
68 assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVFM); \
69 assert(!isGV_with_GP(_sv_cop_seq_range_high)); \
70 ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_high)))->xnv_u.xpad_cop_seq.xhigh; \
72 # define PARENT_PAD_INDEX(sv) \
73 (({ const SV *const _sv_parent_pad_index = (const SV *) (sv); \
74 assert(SvTYPE(_sv_parent_pad_index) == SVt_NV \
75 || SvTYPE(_sv_parent_pad_index) >= SVt_PVNV); \
76 assert(SvTYPE(_sv_parent_pad_index) != SVt_PVAV); \
77 assert(SvTYPE(_sv_parent_pad_index) != SVt_PVHV); \
78 assert(SvTYPE(_sv_parent_pad_index) != SVt_PVCV); \
79 assert(SvTYPE(_sv_parent_pad_index) != SVt_PVFM); \
80 assert(!isGV_with_GP(_sv_parent_pad_index)); \
81 ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_pad_index)))->xnv_u.xpad_cop_seq.xlow; \
83 # define PARENT_FAKELEX_FLAGS(sv) \
84 (({ const SV *const _sv_parent_fakelex_flags = (const SV *) (sv); \
85 assert(SvTYPE(_sv_parent_fakelex_flags) == SVt_NV \
86 || SvTYPE(_sv_parent_fakelex_flags) >= SVt_PVNV); \
87 assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVAV); \
88 assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVHV); \
89 assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVCV); \
90 assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVFM); \
91 assert(!isGV_with_GP(_sv_parent_fakelex_flags)); \
92 ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_fakelex_flags)))->xnv_u.xpad_cop_seq.xhigh; \
95 # define COP_SEQ_RANGE_LOW(sv) \
96 (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
97 # define COP_SEQ_RANGE_HIGH(sv) \
98 (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))
101 # define PARENT_PAD_INDEX(sv) \
102 (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
103 # define PARENT_FAKELEX_FLAGS(sv) \
104 (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))
107 /* Flags set in the SvIVX field of FAKE namesvs */
109 #define PAD_FAKELEX_ANON 1 /* the lex is declared in an ANON, or ... */
110 #define PAD_FAKELEX_MULTI 2 /* the lex can be instantiated multiple times */
112 /* flags for the pad_new() function */
114 #define padnew_CLONE 1 /* this pad is for a cloned CV */
115 #define padnew_SAVE 2 /* save old globals */
116 #define padnew_SAVESUB 4 /* also save extra stuff for start of sub */
118 /* values for the pad_tidy() function */
121 padtidy_SUB, /* tidy up a pad for a sub, */
122 padtidy_SUBCLONE, /* a cloned sub, */
123 padtidy_FORMAT /* or a format */
126 /* flags for pad_add_name_pvn. */
128 #define padadd_OUR 0x01 /* our declaration. */
129 #define padadd_STATE 0x02 /* state declaration. */
130 #define padadd_NO_DUP_CHECK 0x04 /* skip warning on dups. */
131 #define padadd_STALEOK 0x08 /* allow stale lexical in active
132 * sub, but only one level up */
133 #define padadd_UTF8_NAME SVf_UTF8 /* name is UTF-8 encoded. */
135 /* ASSERT_CURPAD_LEGAL and ASSERT_CURPAD_ACTIVE respectively determine
136 * whether PL_comppad and PL_curpad are consistent and whether they have
140 # define pad_peg(label)
144 # define ASSERT_CURPAD_LEGAL(label) \
146 if (PL_comppad ? (AvARRAY(PL_comppad) != PL_curpad) : (PL_curpad != 0)) \
147 Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%"UVxf"[0x%"UVxf"]",\
148 label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
151 # define ASSERT_CURPAD_ACTIVE(label) \
153 if (!PL_comppad || (AvARRAY(PL_comppad) != PL_curpad)) \
154 Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%"UVxf"[0x%"UVxf"]",\
155 label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
157 # define ASSERT_CURPAD_LEGAL(label)
158 # define ASSERT_CURPAD_ACTIVE(label)
163 /* Note: the following three macros are actually defined in scope.h, but
164 * they are documented here for completeness, since they directly or
165 * indirectly affect pads.
167 =for apidoc m|void|SAVEPADSV |PADOFFSET po
168 Save a pad slot (used to restore after an iteration)
170 XXX DAPM it would make more sense to make the arg a PADOFFSET
171 =for apidoc m|void|SAVECLEARSV |SV **svp
172 Clear the pointed to pad value on scope exit. (i.e. the runtime action of 'my')
174 =for apidoc m|void|SAVECOMPPAD
175 save PL_comppad and PL_curpad
178 =for apidoc Amx|PAD **|PADLIST_ARRAY|PADLIST padlist
179 The C array of a padlist, containing the pads. Only subscript it with
180 numbers >= 1, as the 0th entry is not guaranteed to remain usable.
182 =for apidoc Amx|SSize_t|PADLIST_MAX|PADLIST padlist
183 The index of the last pad in the padlist.
185 =for apidoc Amx|PADNAMELIST *|PADLIST_NAMES|PADLIST padlist
186 The names associated with pad entries.
188 =for apidoc Amx|PADNAME **|PADLIST_NAMESARRAY|PADLIST padlist
189 The C array of pad names.
191 =for apidoc Amx|SSize_t|PADLIST_NAMESMAX|PADLIST padlist
192 The index of the last pad name.
194 =for apidoc Amx|U32|PADLIST_REFCNT|PADLIST padlist
195 The reference count of the padlist. Currently this is always 1.
197 =for apidoc Amx|PADNAME **|PADNAMELIST_ARRAY|PADNAMELIST pnl
198 The C array of pad names.
200 =for apidoc Amx|SSize_t|PADNAMELIST_MAX|PADNAMELIST pnl
201 The index of the last pad name.
203 =for apidoc Amx|SV **|PAD_ARRAY|PAD pad
204 The C array of pad entries.
206 =for apidoc Amx|SSize_t|PAD_MAX|PAD pad
207 The index of the last pad entry.
209 =for apidoc Amx|char *|PADNAME_PV|PADNAME pn
210 The name stored in the pad name struct. This returns NULL for a target or
213 =for apidoc Amx|STRLEN|PADNAME_LEN|PADNAME pn
214 The length of the name.
216 =for apidoc Amx|bool|PADNAME_UTF8|PADNAME pn
217 Whether PADNAME_PV is in UTF8.
219 =for apidoc Amx|SV *|PADNAME_SV|PADNAME pn
220 Returns the pad name as an SV. This is currently just C<pn>. It will
221 begin returning a new mortal SV if pad names ever stop being SVs.
223 =for apidoc m|bool|PADNAME_isOUR|PADNAME pn
224 Whether this is an "our" variable.
226 =for apidoc m|HV *|PADNAME_OURSTASH
227 The stash in which this "our" variable was declared.
229 =for apidoc m|bool|PADNAME_OUTER|PADNAME pn
230 Whether this entry belongs to an outer pad.
232 =for apidoc m|HV *|PADNAME_TYPE|PADNAME pn
233 The stash associated with a typed lexical. This returns the %Foo:: hash
237 =for apidoc m|SV *|PAD_SETSV |PADOFFSET po|SV* sv
238 Set the slot at offset C<po> in the current pad to C<sv>
240 =for apidoc m|void|PAD_SV |PADOFFSET po
241 Get the value at offset C<po> in the current pad
243 =for apidoc m|SV *|PAD_SVl |PADOFFSET po
244 Lightweight and lvalue version of C<PAD_SV>.
245 Get or set the value at offset C<po> in the current pad.
246 Unlike C<PAD_SV>, does not print diagnostics with -DX.
247 For internal use only.
249 =for apidoc m|SV *|PAD_BASE_SV |PADLIST padlist|PADOFFSET po
250 Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist
252 =for apidoc m|void|PAD_SET_CUR |PADLIST padlist|I32 n
253 Set the current pad to be pad C<n> in the padlist, saving
254 the previous current pad. NB currently this macro expands to a string too
255 long for some compilers, so it's best to replace it with
258 PAD_SET_CUR_NOSAVE(padlist,n);
261 =for apidoc m|void|PAD_SET_CUR_NOSAVE |PADLIST padlist|I32 n
262 like PAD_SET_CUR, but without the save
264 =for apidoc m|void|PAD_SAVE_SETNULLPAD
265 Save the current pad then set it to null.
267 =for apidoc m|void|PAD_SAVE_LOCAL|PAD *opad|PAD *npad
268 Save the current pad to the local variable opad, then make the
269 current pad equal to npad
271 =for apidoc m|void|PAD_RESTORE_LOCAL|PAD *opad
272 Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
277 #define PADLIST_ARRAY(pl) (pl)->xpadl_alloc
278 #define PADLIST_MAX(pl) (pl)->xpadl_max
279 #define PADLIST_NAMES(pl) (*PADLIST_ARRAY(pl))
280 #define PADLIST_NAMESARRAY(pl) PADNAMELIST_ARRAY(PADLIST_NAMES(pl))
281 #define PADLIST_NAMESMAX(pl) PADNAMELIST_MAX(PADLIST_NAMES(pl))
282 #define PADLIST_REFCNT(pl) 1 /* reserved for future use */
284 #define PADNAMELIST_ARRAY(pnl) AvARRAY(pnl)
285 #define PADNAMELIST_MAX(pnl) AvFILLp(pnl)
287 #define PAD_ARRAY(pad) AvARRAY(pad)
288 #define PAD_MAX(pad) AvFILLp(pad)
290 #define PADNAME_PV(pn) (SvPOKp(pn) ? SvPVX(pn) : NULL)
291 #define PADNAME_LEN(pn) SvCUR(pn)
292 #define PADNAME_UTF8(pn) !!SvUTF8(pn)
293 #define PADNAME_SV(pn) pn
294 #define PADNAME_isOUR(pn) !!SvPAD_OUR(pn)
295 #define PADNAME_OURSTASH(pn) SvOURSTASH(pn)
296 #define PADNAME_OUTER(pn) !!SvFAKE(pn)
297 #define PADNAME_TYPE(pn) (SvPAD_TYPED(pn) ? SvSTASH(pn) : NULL)
301 # define PAD_SV(po) pad_sv(po)
302 # define PAD_SETSV(po,sv) pad_setsv(po,sv)
304 # define PAD_SV(po) (PL_curpad[po])
305 # define PAD_SETSV(po,sv) PL_curpad[po] = (sv)
308 #define PAD_SVl(po) (PL_curpad[po])
310 #define PAD_BASE_SV(padlist, po) \
311 (PADLIST_ARRAY(padlist)[1]) \
312 ? AvARRAY(MUTABLE_AV((PADLIST_ARRAY(padlist)[1])))[po] \
316 #define PAD_SET_CUR_NOSAVE(padlist,nth) \
317 PL_comppad = (PAD*) (PADLIST_ARRAY(padlist)[nth]); \
318 PL_curpad = AvARRAY(PL_comppad); \
319 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
320 "Pad 0x%"UVxf"[0x%"UVxf"] set_cur depth=%d\n", \
321 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth)));
324 #define PAD_SET_CUR(padlist,nth) \
326 PAD_SET_CUR_NOSAVE(padlist,nth);
329 #define PAD_SAVE_SETNULLPAD() SAVECOMPPAD(); \
330 PL_comppad = NULL; PL_curpad = NULL; \
331 DEBUG_Xv(PerlIO_printf(Perl_debug_log, "Pad set_null\n"));
333 #define PAD_SAVE_LOCAL(opad,npad) \
335 PL_comppad = (npad); \
336 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
337 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
338 "Pad 0x%"UVxf"[0x%"UVxf"] save_local\n", \
339 PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
341 #define PAD_RESTORE_LOCAL(opad) \
342 assert(!opad || !SvIS_FREED(opad)); \
344 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
345 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
346 "Pad 0x%"UVxf"[0x%"UVxf"] restore_local\n", \
347 PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
351 =for apidoc m|void|CX_CURPAD_SAVE|struct context
352 Save the current pad in the given context block structure.
354 =for apidoc m|SV *|CX_CURPAD_SV|struct context|PADOFFSET po
355 Access the SV at offset po in the saved current pad in the given
356 context block structure (can be used as an lvalue).
361 #define CX_CURPAD_SAVE(block) (block).oldcomppad = PL_comppad
362 #define CX_CURPAD_SV(block,po) (AvARRAY(MUTABLE_AV(((block).oldcomppad)))[po])
366 =for apidoc m|U32|PAD_COMPNAME_FLAGS|PADOFFSET po
367 Return the flags for the current compiling pad name
368 at offset C<po>. Assumes a valid slot entry.
370 =for apidoc m|char *|PAD_COMPNAME_PV|PADOFFSET po
371 Return the name of the current compiling pad name
372 at offset C<po>. Assumes a valid slot entry.
374 =for apidoc m|HV *|PAD_COMPNAME_TYPE|PADOFFSET po
375 Return the type (stash) of the current compiling pad name at offset
376 C<po>. Must be a valid name. Returns null if not typed.
378 =for apidoc m|HV *|PAD_COMPNAME_OURSTASH|PADOFFSET po
379 Return the stash associated with an C<our> variable.
380 Assumes the slot entry is a valid C<our> lexical.
382 =for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po
383 The generation number of the name at offset C<po> in the current
384 compiling pad (lvalue). Note that C<SvUVX> is hijacked for this purpose.
386 =for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen
387 Sets the generation number of the name at offset C<po> in the current
388 ling pad (lvalue) to C<gen>. Note that C<SvUV_set> is hijacked for this purpose.
394 #define PAD_COMPNAME(po) PAD_COMPNAME_SV(po)
395 #define PAD_COMPNAME_SV(po) (*av_fetch(PL_comppad_name, (po), FALSE))
396 #define PAD_COMPNAME_FLAGS(po) SvFLAGS(PAD_COMPNAME_SV(po))
397 #define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po))
398 #define PAD_COMPNAME_PV(po) SvPV_nolen(PAD_COMPNAME_SV(po))
400 #define PAD_COMPNAME_TYPE(po) pad_compname_type(po)
402 #define PAD_COMPNAME_OURSTASH(po) \
403 (SvOURSTASH(PAD_COMPNAME_SV(po)))
405 #define PAD_COMPNAME_GEN(po) ((STRLEN)SvUVX(AvARRAY(PL_comppad_name)[po]))
407 #define PAD_COMPNAME_GEN_set(po, gen) SvUV_set(AvARRAY(PL_comppad_name)[po], (UV)(gen))
411 =for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl|CLONE_PARAMS* param
412 Clone the state variables associated with running and compiling pads.
417 /* NB - we set PL_comppad to null unless it points at a value that
418 * has already been dup'ed, ie it points to part of an active padlist.
419 * Otherwise PL_comppad ends up being a leaked scalar in code like
421 * threads->create(sub { threads->create(sub {...} ) } );
422 * where the second thread dups the outer sub's comppad but not the
423 * sub's CV or padlist. */
425 #define PAD_CLONE_VARS(proto_perl, param) \
426 PL_comppad = av_dup(proto_perl->Icomppad, param); \
427 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
428 PL_comppad_name = av_dup(proto_perl->Icomppad_name, param); \
429 PL_comppad_name_fill = proto_perl->Icomppad_name_fill; \
430 PL_comppad_name_floor = proto_perl->Icomppad_name_floor; \
431 PL_min_intro_pending = proto_perl->Imin_intro_pending; \
432 PL_max_intro_pending = proto_perl->Imax_intro_pending; \
433 PL_padix = proto_perl->Ipadix; \
434 PL_padix_floor = proto_perl->Ipadix_floor; \
435 PL_pad_reset_pending = proto_perl->Ipad_reset_pending; \
436 PL_cop_seqmax = proto_perl->Icop_seqmax;
439 =for apidoc Am|PADOFFSET|pad_add_name_pvs|const char *name|U32 flags|HV *typestash|HV *ourstash
441 Exactly like L</pad_add_name_pvn>, but takes a literal string instead
442 of a string/length pair.
447 #define pad_add_name_pvs(name,flags,typestash,ourstash) \
448 Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash)
451 =for apidoc Am|PADOFFSET|pad_findmy_pvs|const char *name|U32 flags
453 Exactly like L</pad_findmy_pvn>, but takes a literal string instead
454 of a string/length pair.
459 #define pad_findmy_pvs(name,flags) \
460 Perl_pad_findmy_pvn(aTHX_ STR_WITH_LEN(name), flags)
464 * c-indentation-style: bsd
466 * indent-tabs-mode: nil
469 * ex: set ts=8 sts=4 sw=4 et: