This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
amigaos4/amigaos.c: Use memzero, not memset(0)
[perl5.git] / pad.h
... / ...
CommitLineData
1/* pad.h
2 *
3 * Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008,
4 * 2009, 2010, 2011 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 * 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.
12 */
13
14/* offsets within a pad */
15
16typedef SSize_t PADOFFSET; /* signed so that -1 is a valid value */
17#define NOT_IN_PAD ((PADOFFSET) -1)
18
19/* B.xs expects the first members of these two structs to line up
20 (xpadl_max with xpadnl_fill).
21 */
22
23struct padlist {
24 SSize_t xpadl_max; /* max index for which array has space */
25 union {
26 PAD ** xpadlarr_alloc; /* Pointer to beginning of array of AVs.
27 index 0 is a padnamelist * */
28 struct {
29 PADNAMELIST * padnl;
30 PAD * pad_1; /* this slice of PAD * array always alloced */
31 PAD * pad_2; /* maybe unalloced */
32 } * xpadlarr_dbg; /* for use with a C debugger only */
33 } xpadl_arr;
34 U32 xpadl_id; /* Semi-unique ID, shared between clones */
35 U32 xpadl_outid; /* ID of outer pad */
36};
37
38struct padnamelist {
39 SSize_t xpadnl_fill; /* max index in use */
40 PADNAME ** xpadnl_alloc; /* pointer to beginning of array */
41 SSize_t xpadnl_max; /* max index for which array has space */
42 PADOFFSET xpadnl_max_named; /* highest index with len > 0 */
43 U32 xpadnl_refcnt;
44};
45
46/* PERL_PADNAME_MINIMAL uses less memory, but on some platforms
47 PERL_PADNAME_ALIGNED may be faster, so platform-specific hints can
48 define one or the other. */
49#if defined(PERL_PADNAME_MINIMAL) && defined (PERL_PADNAME_ALIGNED)
50# error PERL_PADNAME_MINIMAL and PERL_PADNAME_ALIGNED are exclusive
51#endif
52
53#if !defined(PERL_PADNAME_MINIMAL) && !defined(PERL_PADNAME_ALIGNED)
54# define PERL_PADNAME_MINIMAL
55#endif
56
57#define _PADNAME_BASE \
58 char * xpadn_pv; \
59 HV * xpadn_ourstash; \
60 union { \
61 HV * xpadn_typestash; \
62 CV * xpadn_protocv; \
63 } xpadn_type_u; \
64 U32 xpadn_low; \
65 U32 xpadn_high; \
66 U32 xpadn_refcnt; \
67 int xpadn_gen; \
68 U8 xpadn_len; \
69 U8 xpadn_flags
70
71struct padname {
72 _PADNAME_BASE;
73};
74
75struct padname_with_str {
76#ifdef PERL_PADNAME_MINIMAL
77 _PADNAME_BASE;
78#else
79 struct padname xpadn_padname;
80#endif
81 char xpadn_str[1];
82};
83
84#undef _PADNAME_BASE
85
86#define PADNAME_FROM_PV(s) \
87 ((PADNAME *)((s) - STRUCT_OFFSET(struct padname_with_str, xpadn_str)))
88
89
90/* a value that PL_cop_seqmax is guaranteed never to be,
91 * flagging that a lexical is being introduced, or has not yet left scope
92 */
93#define PERL_PADSEQ_INTRO U32_MAX
94#define COP_SEQMAX_INC \
95 (PL_cop_seqmax++, \
96 (void)(PL_cop_seqmax == PERL_PADSEQ_INTRO && PL_cop_seqmax++))
97
98
99/* B.xs needs these for the benefit of B::Deparse */
100/* Low range end is exclusive (valid from the cop seq after this one) */
101/* High range end is inclusive (valid up to this cop seq) */
102
103#define COP_SEQ_RANGE_LOW(pn) (pn)->xpadn_low
104#define COP_SEQ_RANGE_HIGH(pn) (pn)->xpadn_high
105#define PARENT_PAD_INDEX(pn) (pn)->xpadn_low
106#define PARENT_FAKELEX_FLAGS(pn) (pn)->xpadn_high
107
108/* Flags set in the SvIVX field of FAKE namesvs */
109
110#define PAD_FAKELEX_ANON 1 /* the lex is declared in an ANON, or ... */
111#define PAD_FAKELEX_MULTI 2 /* the lex can be instantiated multiple times */
112
113/* flags for the pad_new() function */
114
115#define padnew_CLONE 1 /* this pad is for a cloned CV */
116#define padnew_SAVE 2 /* save old globals */
117#define padnew_SAVESUB 4 /* also save extra stuff for start of sub */
118
119/* values for the pad_tidy() function */
120
121typedef enum {
122 padtidy_SUB, /* tidy up a pad for a sub, */
123 padtidy_SUBCLONE, /* a cloned sub, */
124 padtidy_FORMAT /* or a format */
125} padtidy_type;
126
127/* flags for pad_add_name_pvn. */
128
129#define padadd_OUR 0x01 /* our declaration. */
130#define padadd_STATE 0x02 /* state declaration. */
131#define padadd_NO_DUP_CHECK 0x04 /* skip warning on dups. */
132#define padadd_STALEOK 0x08 /* allow stale lexical in active
133 * sub, but only one level up */
134
135/* ASSERT_CURPAD_LEGAL and ASSERT_CURPAD_ACTIVE respectively determine
136 * whether PL_comppad and PL_curpad are consistent and whether they have
137 * active values */
138
139# define pad_peg(label)
140
141#ifdef DEBUGGING
142# define ASSERT_CURPAD_LEGAL(label) \
143 pad_peg(label); \
144 if (PL_comppad ? (AvARRAY(PL_comppad) != PL_curpad) : (PL_curpad != 0)) \
145 Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%" UVxf "[0x%" UVxf "]",\
146 label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
147
148
149# define ASSERT_CURPAD_ACTIVE(label) \
150 pad_peg(label); \
151 if (!PL_comppad || (AvARRAY(PL_comppad) != PL_curpad)) \
152 Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%" UVxf "[0x%" UVxf "]",\
153 label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
154#else
155# define ASSERT_CURPAD_LEGAL(label)
156# define ASSERT_CURPAD_ACTIVE(label)
157#endif
158
159
160
161/* Note: the following three macros are actually defined in scope.h, but
162 * they are documented here for completeness, since they directly or
163 * indirectly affect pads.
164
165=for apidoc m|void|SAVEPADSV |PADOFFSET po
166Save a pad slot (used to restore after an iteration)
167
168=cut
169
170XXX DAPM it would make more sense to make the arg a PADOFFSET
171
172=for apidoc m|void|SAVECLEARSV |SV **svp
173Clear the pointed to pad value on scope exit. (i.e. the runtime action of
174C<my>)
175
176=for apidoc m|void|SAVECOMPPAD
177save C<PL_comppad> and C<PL_curpad>
178
179
180=for apidoc Amx|PAD **|PadlistARRAY|PADLIST * padlist
181The C array of a padlist, containing the pads. Only subscript it with
182numbers >= 1, as the 0th entry is not guaranteed to remain usable.
183
184=for apidoc Amx|SSize_t|PadlistMAX|PADLIST * padlist
185The index of the last allocated space in the padlist. Note that the last
186pad may be in an earlier slot. Any entries following it will be C<NULL> in
187that case.
188
189=for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST * padlist
190The names associated with pad entries.
191
192=for apidoc Amx|PADNAME **|PadlistNAMESARRAY|PADLIST * padlist
193The C array of pad names.
194
195=for apidoc Amx|SSize_t|PadlistNAMESMAX|PADLIST * padlist
196The index of the last pad name.
197
198=for apidoc Amx|U32|PadlistREFCNT|PADLIST * padlist
199The reference count of the padlist. Currently this is always 1.
200
201=for apidoc Amx|PADNAME **|PadnamelistARRAY|PADNAMELIST * pnl
202The C array of pad names.
203
204=for apidoc Amx|SSize_t|PadnamelistMAX|PADNAMELIST * pnl
205The index of the last pad name.
206
207=for apidoc Amx|SSize_t|PadnamelistREFCNT|PADNAMELIST * pnl
208The reference count of the pad name list.
209
210=for apidoc Amx|void|PadnamelistREFCNT_dec|PADNAMELIST * pnl
211Lowers the reference count of the pad name list.
212
213=for apidoc Amx|SV **|PadARRAY|PAD * pad
214The C array of pad entries.
215
216=for apidoc Amx|SSize_t|PadMAX|PAD * pad
217The index of the last pad entry.
218
219=for apidoc Amx|char *|PadnamePV|PADNAME * pn
220The name stored in the pad name struct. This returns C<NULL> for a target
221slot.
222
223=for apidoc Amx|STRLEN|PadnameLEN|PADNAME * pn
224The length of the name.
225
226=for apidoc Amx|bool|PadnameUTF8|PADNAME * pn
227Whether PadnamePV is in UTF-8. Currently, this is always true.
228
229=for apidoc Amx|SV *|PadnameSV|PADNAME * pn
230Returns the pad name as a mortal SV.
231
232=for apidoc m|bool|PadnameIsOUR|PADNAME * pn
233Whether this is an "our" variable.
234
235=for apidoc m|HV *|PadnameOURSTASH|PADNAME * pn
236The stash in which this "our" variable was declared.
237
238=for apidoc m|bool|PadnameOUTER|PADNAME * pn
239Whether this entry belongs to an outer pad. Entries for which this is true
240are often referred to as 'fake'.
241
242=for apidoc m|bool|PadnameIsSTATE|PADNAME * pn
243Whether this is a "state" variable.
244
245=for apidoc m|HV *|PadnameTYPE|PADNAME * pn
246The stash associated with a typed lexical. This returns the C<%Foo::> hash
247for C<my Foo $bar>.
248
249=for apidoc Amx|SSize_t|PadnameREFCNT|PADNAME * pn
250The reference count of the pad name.
251
252=for apidoc Amx|void|PadnameREFCNT_dec|PADNAME * pn
253Lowers the reference count of the pad name.
254
255
256=for apidoc m|SV *|PAD_SETSV |PADOFFSET po|SV* sv
257Set the slot at offset C<po> in the current pad to C<sv>
258
259=for apidoc m|SV *|PAD_SV |PADOFFSET po
260Get the value at offset C<po> in the current pad
261
262=for apidoc m|SV *|PAD_SVl |PADOFFSET po
263Lightweight and lvalue version of C<PAD_SV>.
264Get or set the value at offset C<po> in the current pad.
265Unlike C<PAD_SV>, does not print diagnostics with -DX.
266For internal use only.
267
268=for apidoc m|SV *|PAD_BASE_SV |PADLIST padlist|PADOFFSET po
269Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist
270
271=for apidoc m|void|PAD_SET_CUR |PADLIST padlist|I32 n
272Set the current pad to be pad C<n> in the padlist, saving
273the previous current pad. NB currently this macro expands to a string too
274long for some compilers, so it's best to replace it with
275
276 SAVECOMPPAD();
277 PAD_SET_CUR_NOSAVE(padlist,n);
278
279
280=for apidoc m|void|PAD_SET_CUR_NOSAVE |PADLIST padlist|I32 n
281like PAD_SET_CUR, but without the save
282
283=for apidoc m|void|PAD_SAVE_SETNULLPAD
284Save the current pad then set it to null.
285
286=for apidoc m|void|PAD_SAVE_LOCAL|PAD *opad|PAD *npad
287Save the current pad to the local variable C<opad>, then make the
288current pad equal to C<npad>
289
290=for apidoc m|void|PAD_RESTORE_LOCAL|PAD *opad
291Restore the old pad saved into the local variable C<opad> by C<PAD_SAVE_LOCAL()>
292
293=cut
294*/
295
296#define PadlistARRAY(pl) (pl)->xpadl_arr.xpadlarr_alloc
297#define PadlistMAX(pl) (pl)->xpadl_max
298#define PadlistNAMES(pl) *((PADNAMELIST **)PadlistARRAY(pl))
299#define PadlistNAMESARRAY(pl) PadnamelistARRAY(PadlistNAMES(pl))
300#define PadlistNAMESMAX(pl) PadnamelistMAX(PadlistNAMES(pl))
301#define PadlistREFCNT(pl) 1 /* reserved for future use */
302
303#define PadnamelistARRAY(pnl) (pnl)->xpadnl_alloc
304#define PadnamelistMAX(pnl) (pnl)->xpadnl_fill
305#define PadnamelistMAXNAMED(pnl) (pnl)->xpadnl_max_named
306#define PadnamelistREFCNT(pnl) (pnl)->xpadnl_refcnt
307#define PadnamelistREFCNT_dec(pnl) Perl_padnamelist_free(aTHX_ pnl)
308
309#define PadARRAY(pad) AvARRAY(pad)
310#define PadMAX(pad) AvFILLp(pad)
311
312#define PadnamePV(pn) (pn)->xpadn_pv
313#define PadnameLEN(pn) (pn)->xpadn_len
314#define PadnameUTF8(pn) 1
315#define PadnameSV(pn) \
316 newSVpvn_flags(PadnamePV(pn), PadnameLEN(pn), SVs_TEMP|SVf_UTF8)
317#define PadnameFLAGS(pn) (pn)->xpadn_flags
318#define PadnameIsOUR(pn) (!!(pn)->xpadn_ourstash)
319#define PadnameOURSTASH(pn) (pn)->xpadn_ourstash
320#define PadnameTYPE(pn) (pn)->xpadn_type_u.xpadn_typestash
321#define PadnamePROTOCV(pn) (pn)->xpadn_type_u.xpadn_protocv
322#define PadnameREFCNT(pn) (pn)->xpadn_refcnt
323#define PadnameREFCNT_dec(pn) Perl_padname_free(aTHX_ pn)
324#define PadnameOURSTASH_set(pn,s) (PadnameOURSTASH(pn) = (s))
325#define PadnameTYPE_set(pn,s) (PadnameTYPE(pn) = (s))
326#define PadnameOUTER(pn) (PadnameFLAGS(pn) & PADNAMEt_OUTER)
327#define PadnameIsSTATE(pn) (PadnameFLAGS(pn) & PADNAMEt_STATE)
328#define PadnameLVALUE(pn) (PadnameFLAGS(pn) & PADNAMEt_LVALUE)
329
330#define PadnameLVALUE_on(pn) (PadnameFLAGS(pn) |= PADNAMEt_LVALUE)
331#define PadnameIsSTATE_on(pn) (PadnameFLAGS(pn) |= PADNAMEt_STATE)
332
333#define PADNAMEt_OUTER 1 /* outer lexical var */
334#define PADNAMEt_STATE 2 /* state var */
335#define PADNAMEt_LVALUE 4 /* used as lvalue */
336#define PADNAMEt_TYPED 8 /* for B; unused by core */
337#define PADNAMEt_OUR 16 /* for B; unused by core */
338
339/* backward compatibility */
340#define SvPAD_STATE PadnameIsSTATE
341#define SvPAD_TYPED(pn) (!!PadnameTYPE(pn))
342#define SvPAD_OUR(pn) (!!PadnameOURSTASH(pn))
343#define SvPAD_STATE_on PadnameIsSTATE_on
344#define SvPAD_TYPED_on(pn) (PadnameFLAGS(pn) |= PADNAMEt_TYPED)
345#define SvPAD_OUR_on(pn) (PadnameFLAGS(pn) |= PADNAMEt_OUR)
346#define SvOURSTASH PadnameOURSTASH
347#define SvOURSTASH_set PadnameOURSTASH_set
348#define SVpad_STATE PADNAMEt_STATE
349#define SVpad_TYPED PADNAMEt_TYPED
350#define SVpad_OUR PADNAMEt_OUR
351
352#ifdef DEBUGGING
353# define PAD_SV(po) pad_sv(po)
354# define PAD_SETSV(po,sv) pad_setsv(po,sv)
355#else
356# define PAD_SV(po) (PL_curpad[po])
357# define PAD_SETSV(po,sv) PL_curpad[po] = (sv)
358#endif
359
360#define PAD_SVl(po) (PL_curpad[po])
361
362#define PAD_BASE_SV(padlist, po) \
363 (PadlistARRAY(padlist)[1]) \
364 ? AvARRAY(MUTABLE_AV((PadlistARRAY(padlist)[1])))[po] \
365 : NULL;
366
367
368#define PAD_SET_CUR_NOSAVE(padlist,nth) \
369 PL_comppad = (PAD*) (PadlistARRAY(padlist)[nth]); \
370 PL_curpad = AvARRAY(PL_comppad); \
371 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
372 "Pad 0x%" UVxf "[0x%" UVxf "] set_cur depth=%d\n", \
373 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth)));
374
375
376#define PAD_SET_CUR(padlist,nth) \
377 SAVECOMPPAD(); \
378 PAD_SET_CUR_NOSAVE(padlist,nth);
379
380
381#define PAD_SAVE_SETNULLPAD() SAVECOMPPAD(); \
382 PL_comppad = NULL; PL_curpad = NULL; \
383 DEBUG_Xv(PerlIO_printf(Perl_debug_log, "Pad set_null\n"));
384
385#define PAD_SAVE_LOCAL(opad,npad) \
386 opad = PL_comppad; \
387 PL_comppad = (npad); \
388 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
389 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
390 "Pad 0x%" UVxf "[0x%" UVxf "] save_local\n", \
391 PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
392
393#define PAD_RESTORE_LOCAL(opad) \
394 assert(!opad || !SvIS_FREED(opad)); \
395 PL_comppad = opad; \
396 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
397 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
398 "Pad 0x%" UVxf "[0x%" UVxf "] restore_local\n", \
399 PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
400
401
402/*
403=for apidoc m|void|CX_CURPAD_SAVE|struct context
404Save the current pad in the given context block structure.
405
406=for apidoc m|SV *|CX_CURPAD_SV|struct context|PADOFFSET po
407Access the SV at offset C<po> in the saved current pad in the given
408context block structure (can be used as an lvalue).
409
410=cut
411*/
412
413#define CX_CURPAD_SAVE(block) (block).oldcomppad = PL_comppad
414#define CX_CURPAD_SV(block,po) (AvARRAY(MUTABLE_AV(((block).oldcomppad)))[po])
415
416
417/*
418=for apidoc m|U32|PAD_COMPNAME_FLAGS|PADOFFSET po
419Return the flags for the current compiling pad name
420at offset C<po>. Assumes a valid slot entry.
421
422=for apidoc m|char *|PAD_COMPNAME_PV|PADOFFSET po
423Return the name of the current compiling pad name
424at offset C<po>. Assumes a valid slot entry.
425
426=for apidoc m|HV *|PAD_COMPNAME_TYPE|PADOFFSET po
427Return the type (stash) of the current compiling pad name at offset
428C<po>. Must be a valid name. Returns null if not typed.
429
430=for apidoc m|HV *|PAD_COMPNAME_OURSTASH|PADOFFSET po
431Return the stash associated with an C<our> variable.
432Assumes the slot entry is a valid C<our> lexical.
433
434=for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po
435The generation number of the name at offset C<po> in the current
436compiling pad (lvalue).
437
438=for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen
439Sets the generation number of the name at offset C<po> in the current
440ling pad (lvalue) to C<gen>.
441=cut
442
443*/
444
445#define PAD_COMPNAME(po) PAD_COMPNAME_SV(po)
446#define PAD_COMPNAME_SV(po) (PadnamelistARRAY(PL_comppad_name)[(po)])
447#define PAD_COMPNAME_FLAGS(po) PadnameFLAGS(PAD_COMPNAME(po))
448#define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po))
449#define PAD_COMPNAME_PV(po) PadnamePV(PAD_COMPNAME(po))
450
451#define PAD_COMPNAME_TYPE(po) PadnameTYPE(PAD_COMPNAME(po))
452
453#define PAD_COMPNAME_OURSTASH(po) \
454 (SvOURSTASH(PAD_COMPNAME_SV(po)))
455
456#define PAD_COMPNAME_GEN(po) \
457 ((STRLEN)PadnamelistARRAY(PL_comppad_name)[po]->xpadn_gen)
458
459#define PAD_COMPNAME_GEN_set(po, gen) \
460 (PadnamelistARRAY(PL_comppad_name)[po]->xpadn_gen = (gen))
461
462
463/*
464=for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl|CLONE_PARAMS* param
465Clone the state variables associated with running and compiling pads.
466
467=cut
468*/
469
470/* NB - we set PL_comppad to null unless it points at a value that
471 * has already been dup'ed, ie it points to part of an active padlist.
472 * Otherwise PL_comppad ends up being a leaked scalar in code like
473 * the following:
474 * threads->create(sub { threads->create(sub {...} ) } );
475 * where the second thread dups the outer sub's comppad but not the
476 * sub's CV or padlist. */
477
478#define PAD_CLONE_VARS(proto_perl, param) \
479 PL_comppad = av_dup(proto_perl->Icomppad, param); \
480 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
481 PL_comppad_name = \
482 padnamelist_dup(proto_perl->Icomppad_name, param); \
483 PL_comppad_name_fill = proto_perl->Icomppad_name_fill; \
484 PL_comppad_name_floor = proto_perl->Icomppad_name_floor; \
485 PL_min_intro_pending = proto_perl->Imin_intro_pending; \
486 PL_max_intro_pending = proto_perl->Imax_intro_pending; \
487 PL_padix = proto_perl->Ipadix; \
488 PL_padix_floor = proto_perl->Ipadix_floor; \
489 PL_pad_reset_pending = proto_perl->Ipad_reset_pending; \
490 PL_cop_seqmax = proto_perl->Icop_seqmax;
491
492/*
493=for apidoc Am|PADOFFSET|pad_add_name_pvs|"name"|U32 flags|HV *typestash|HV *ourstash
494
495Exactly like L</pad_add_name_pvn>, but takes a literal string
496instead of a string/length pair.
497
498=cut
499*/
500
501#define pad_add_name_pvs(name,flags,typestash,ourstash) \
502 Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash)
503
504/*
505=for apidoc Am|PADOFFSET|pad_findmy_pvs|"name"|U32 flags
506
507Exactly like L</pad_findmy_pvn>, but takes a literal string
508instead of a string/length pair.
509
510=cut
511*/
512
513#define pad_findmy_pvs(name,flags) \
514 Perl_pad_findmy_pvn(aTHX_ STR_WITH_LEN(name), flags)
515
516/*
517 * ex: set ts=8 sts=4 sw=4 et:
518 */